update Piwik to version 2.16 (fixes #91)

www/analytics/core/Application/Environment.php

@@ -0,0 +1,246 @@
+<?php
+/**
+ * Piwik - free/libre analytics platform
+ *
+ * @link http://piwik.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ */
+
+namespace Piwik\Application;
+
+use DI\Container;
+use Piwik\Application\Kernel\EnvironmentValidator;
+use Piwik\Application\Kernel\GlobalSettingsProvider;
+use Piwik\Application\Kernel\PluginList;
+use Piwik\Container\ContainerFactory;
+use Piwik\Container\StaticContainer;
+use Piwik\Piwik;
+
+/**
+ * Encapsulates Piwik environment setup and access.
+ *
+ * The Piwik environment consists of two main parts: the kernel and the DI container.
+ *
+ * The 'kernel' is the core part of Piwik that cannot be modified / extended through the DI container.
+ * It includes components that are required to create the DI container.
+ *
+ * Currently the only objects in the 'kernel' are a GlobalSettingsProvider object and a
+ * PluginList object. The GlobalSettingsProvider object is required for the current PluginList
+ * implementation and for checking whether Development mode is enabled. The PluginList is
+ * needed in order to determine what plugins are activated, since plugins can provide their
+ * own DI configuration.
+ *
+ * The DI container contains every other Piwik object, including the Plugin\Manager,
+ * plugin API instances, dependent services, etc. Plugins and users can override/extend
+ * the objects in this container.
+ *
+ * NOTE: DI support in Piwik is currently a work in process; not everything is currently
+ * stored in the DI container, but we are working towards this.
+ */
+class Environment
+{
+    /**
+     * @internal
+     * @var EnvironmentManipulator
+     */
+    private static $globalEnvironmentManipulator = null;
+
+    /**
+     * @var string
+     */
+    private $environment;
+
+    /**
+     * @var array
+     */
+    private $definitions;
+
+    /**
+     * @var Container
+     */
+    private $container;
+
+    /**
+     * @var GlobalSettingsProvider
+     */
+    private $globalSettingsProvider;
+
+    /**
+     * @var PluginList
+     */
+    private $pluginList;
+
+    /**
+     * @param string $environment
+     * @param array $definitions
+     */
+    public function __construct($environment, array $definitions = array())
+    {
+        $this->environment = $environment;
+        $this->definitions = $definitions;
+    }
+
+    /**
+     * Initializes the kernel globals and DI container.
+     */
+    public function init()
+    {
+        $this->invokeBeforeContainerCreatedHook();
+
+        $this->container = $this->createContainer();
+
+        StaticContainer::push($this->container);
+
+        $this->validateEnvironment();
+
+        $this->invokeEnvironmentBootstrappedHook();
+
+        Piwik::postEvent('Environment.bootstrapped'); // this event should be removed eventually
+    }
+
+    /**
+     * Destroys an environment. MUST be called when embedding environments.
+     */
+    public function destroy()
+    {
+        StaticContainer::pop();
+    }
+
+    /**
+     * Returns the DI container. All Piwik objects for a specific Piwik instance should be stored
+     * in this container.
+     *
+     * @return Container
+     */
+    public function getContainer()
+    {
+        return $this->container;
+    }
+
+    /**
+     * @link http://php-di.org/doc/container-configuration.html
+     */
+    private function createContainer()
+    {
+        $pluginList = $this->getPluginListCached();
+        $settings = $this->getGlobalSettingsCached();
+
+        $extraDefinitions = $this->getExtraDefinitionsFromManipulators();
+        $definitions = array_merge(StaticContainer::getDefinitions(), $extraDefinitions, array($this->definitions));
+
+        $environments = array($this->environment);
+        $environments = array_merge($environments, $this->getExtraEnvironmentsFromManipulators());
+
+        $containerFactory = new ContainerFactory($pluginList, $settings, $environments, $definitions);
+        return $containerFactory->create();
+    }
+
+    protected function getGlobalSettingsCached()
+    {
+        if ($this->globalSettingsProvider === null) {
+            $original = $this->getGlobalSettings();
+            $globalSettingsProvider = $this->getGlobalSettingsProviderOverride($original);
+
+            $this->globalSettingsProvider = $globalSettingsProvider ?: $original;
+        }
+        return $this->globalSettingsProvider;
+    }
+
+    protected function getPluginListCached()
+    {
+        if ($this->pluginList === null) {
+            $pluginList = $this->getPluginListOverride();
+            $this->pluginList = $pluginList ?: $this->getPluginList();
+        }
+        return $this->pluginList;
+    }
+
+    /**
+     * Returns the kernel global GlobalSettingsProvider object. Derived classes can override this method
+     * to provide a different implementation.
+     *
+     * @return null|GlobalSettingsProvider
+     */
+    protected function getGlobalSettings()
+    {
+        return new GlobalSettingsProvider();
+    }
+
+    /**
+     * Returns the kernel global PluginList object. Derived classes can override this method to
+     * provide a different implementation.
+     *
+     * @return PluginList
+     */
+    protected function getPluginList()
+    {
+        // TODO: in tracker should only load tracker plugins. can't do properly until tracker entrypoint is encapsulated.
+        return new PluginList($this->getGlobalSettingsCached());
+    }
+
+    private function validateEnvironment()
+    {
+        /** @var EnvironmentValidator $validator */
+        $validator = $this->container->get('Piwik\Application\Kernel\EnvironmentValidator');
+        $validator->validate();
+    }
+
+    /**
+     * @param EnvironmentManipulator $manipulator
+     * @internal
+     */
+    public static function setGlobalEnvironmentManipulator(EnvironmentManipulator $manipulator)
+    {
+        self::$globalEnvironmentManipulator = $manipulator;
+    }
+
+    private function getGlobalSettingsProviderOverride(GlobalSettingsProvider $original)
+    {
+        if (self::$globalEnvironmentManipulator) {
+            return self::$globalEnvironmentManipulator->makeGlobalSettingsProvider($original);
+        } else {
+            return null;
+        }
+    }
+
+    private function invokeBeforeContainerCreatedHook()
+    {
+        if (self::$globalEnvironmentManipulator) {
+            return self::$globalEnvironmentManipulator->beforeContainerCreated();
+        }
+    }
+
+    private function getExtraDefinitionsFromManipulators()
+    {
+        if (self::$globalEnvironmentManipulator) {
+            return self::$globalEnvironmentManipulator->getExtraDefinitions();
+        } else {
+            return array();
+        }
+    }
+
+    private function invokeEnvironmentBootstrappedHook()
+    {
+        if (self::$globalEnvironmentManipulator) {
+            self::$globalEnvironmentManipulator->onEnvironmentBootstrapped();
+        }
+    }
+
+    private function getExtraEnvironmentsFromManipulators()
+    {
+        if (self::$globalEnvironmentManipulator) {
+            return self::$globalEnvironmentManipulator->getExtraEnvironments();
+        } else {
+            return array();
+        }
+    }
+
+    private function getPluginListOverride()
+    {
+        if (self::$globalEnvironmentManipulator) {
+            return self::$globalEnvironmentManipulator->makePluginList($this->getGlobalSettingsCached());
+        } else {
+            return null;
+        }
+    }
+}

www/analytics/core/Application/EnvironmentManipulator.php

@@ -0,0 +1,59 @@
+<?php
+/**
+ * Piwik - free/libre analytics platform
+ *
+ * @link http://piwik.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ */
+
+namespace Piwik\Application;
+
+use Piwik\Application\Kernel\GlobalSettingsProvider;
+use Piwik\Application\Kernel\PluginList;
+
+/**
+ * Used to manipulate Environment instances before the container is created.
+ * Only used by the testing environment setup code, shouldn't be used anywhere
+ * else.
+ */
+interface EnvironmentManipulator
+{
+    /**
+     * Create a custom GlobalSettingsProvider kernel object, overriding the default behavior.
+     *
+     * @return GlobalSettingsProvider
+     */
+    public function makeGlobalSettingsProvider(GlobalSettingsProvider $original);
+
+    /**
+     * Create a custom PluginList kernel object, overriding the default behavior.@deprecated
+     *
+     * @param GlobalSettingsProvider $globalSettingsProvider
+     * @return PluginList
+     */
+    public function makePluginList(GlobalSettingsProvider $globalSettingsProvider);
+
+    /**
+     * Invoked before the container is created.
+     */
+    public function beforeContainerCreated();
+
+    /**
+     * Return an array of definition arrays that override DI config specified in PHP config files.
+     *
+     * @return array[]
+     */
+    public function getExtraDefinitions();
+
+    /**
+     * Invoked after the container is created and the environment is considered bootstrapped.
+     */
+    public function onEnvironmentBootstrapped();
+
+    /**
+     * Return an array of environment names to apply after the normal environment.
+     *
+     * @return string[]
+     */
+    public function getExtraEnvironments();
+}

www/analytics/core/Application/Kernel/EnvironmentValidator.php

@@ -0,0 +1,79 @@
+<?php
+/**
+ * Piwik - free/libre analytics platform
+ *
+ * @link http://piwik.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ */
+
+namespace Piwik\Application\Kernel;
+
+use Piwik\Common;
+use Piwik\Piwik;
+use Piwik\SettingsServer;
+use Piwik\Translation\Translator;
+
+/**
+ * Validates the Piwik environment. This includes making sure the required config files
+ * are present, and triggering the correct behaviour if otherwise.
+ */
+class EnvironmentValidator
+{
+    /**
+     * @var GlobalSettingsProvider
+     */
+    protected $settingsProvider;
+
+    /**
+     * @var Translator
+     */
+    protected $translator;
+
+    public function __construct(GlobalSettingsProvider $settingsProvider, Translator $translator)
+    {
+        $this->settingsProvider = $settingsProvider;
+        $this->translator = $translator;
+    }
+
+    public function validate()
+    {
+        $inTrackerRequest = SettingsServer::isTrackerApiRequest();
+        $inConsole = Common::isPhpCliMode();
+
+        $this->checkConfigFileExists($this->settingsProvider->getPathGlobal());
+        $this->checkConfigFileExists($this->settingsProvider->getPathLocal(), $startInstaller = !$inTrackerRequest && !$inConsole);
+    }
+
+    /**
+     * @param $path
+     * @param bool $startInstaller
+     * @throws \Exception
+     */
+    private function checkConfigFileExists($path, $startInstaller = false)
+    {
+        if (is_readable($path)) {
+            return;
+        }
+
+        $message = $this->translator->translate('General_ExceptionConfigurationFileNotFound', array($path));
+        if (Common::isPhpCliMode()) {
+            $message .= "\n" . $this->translator->translate('General_ExceptionConfigurationFileNotFound2', array($path, get_current_user()));
+        }
+
+        $exception = new \Exception($message);
+
+        if ($startInstaller) {
+            /**
+             * Triggered when the configuration file cannot be found or read, which usually
+             * means Piwik is not installed yet.
+             *
+             * This event can be used to start the installation process or to display a custom error message.
+             *
+             * @param \Exception $exception The exception that was thrown by `Config::getInstance()`.
+             */
+            Piwik::postEvent('Config.NoConfigurationFile', array($exception), $pending = true);
+        } else {
+            throw $exception;
+        }
+    }
+}

www/analytics/core/Application/Kernel/GlobalSettingsProvider.php

@@ -0,0 +1,111 @@
+<?php
+/**
+ * Piwik - free/libre analytics platform
+ *
+ * @link http://piwik.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ */
+
+namespace Piwik\Application\Kernel;
+
+use Piwik\Config;
+use Piwik\Config\IniFileChain;
+
+/**
+ * Provides global settings. Global settings are organized in sections where
+ * each section contains a list of name => value pairs. Setting values can
+ * be primitive values or arrays of primitive values.
+ *
+ * Uses the config.ini.php, common.ini.php and global.ini.php files to provide global settings.
+ *
+ * At the moment a singleton instance of this class is used in order to get tests to pass.
+ */
+class GlobalSettingsProvider
+{
+    /**
+     * @var IniFileChain
+     */
+    protected $iniFileChain;
+
+    /**
+     * @var string
+     */
+    protected $pathGlobal = null;
+
+    /**
+     * @var string
+     */
+    protected $pathCommon = null;
+
+    /**
+     * @var string
+     */
+    protected $pathLocal = null;
+
+    /**
+     * @param string|null $pathGlobal Path to the global.ini.php file. Or null to use the default.
+     * @param string|null $pathLocal Path to the config.ini.php file. Or null to use the default.
+     * @param string|null $pathCommon Path to the common.ini.php file. Or null to use the default.
+     */
+    public function __construct($pathGlobal = null, $pathLocal = null, $pathCommon = null)
+    {
+        $this->pathGlobal = $pathGlobal ?: Config::getGlobalConfigPath();
+        $this->pathCommon = $pathCommon ?: Config::getCommonConfigPath();
+        $this->pathLocal = $pathLocal ?: Config::getLocalConfigPath();
+
+        $this->iniFileChain = new IniFileChain();
+        $this->reload();
+    }
+
+    public function reload($pathGlobal = null, $pathLocal = null, $pathCommon = null)
+    {
+        $this->pathGlobal = $pathGlobal ?: $this->pathGlobal;
+        $this->pathCommon = $pathCommon ?: $this->pathCommon;
+        $this->pathLocal = $pathLocal ?: $this->pathLocal;
+
+        $this->iniFileChain->reload(array($this->pathGlobal, $this->pathCommon), $this->pathLocal);
+    }
+
+    /**
+     * Returns a settings section.
+     *
+     * @param string $name
+     * @return array
+     */
+    public function &getSection($name)
+    {
+        $section =& $this->iniFileChain->get($name);
+        return $section;
+    }
+
+    /**
+     * Sets a settings section.
+     *
+     * @param string $name
+     * @param array $value
+     */
+    public function setSection($name, $value)
+    {
+        $this->iniFileChain->set($name, $value);
+    }
+
+    public function getIniFileChain()
+    {
+        return $this->iniFileChain;
+    }
+
+    public function getPathGlobal()
+    {
+        return $this->pathGlobal;
+    }
+
+    public function getPathLocal()
+    {
+        return $this->pathLocal;
+    }
+
+    public function getPathCommon()
+    {
+        return $this->pathCommon;
+    }
+}

www/analytics/core/Application/Kernel/PluginList.php

@@ -0,0 +1,120 @@
+<?php
+/**
+ * Piwik - free/libre analytics platform
+ *
+ * @link http://piwik.org
+ * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
+ */
+
+namespace Piwik\Application\Kernel;
+
+/**
+ * Lists the currently activated plugins. Used when setting up Piwik's environment before
+ * initializing the DI container.
+ *
+ * Uses the [Plugins] section in Piwik's INI config to get the activated plugins.
+ *
+ * Depends on GlobalSettingsProvider being used.
+ *
+ * TODO: parts of Plugin\Manager edit the plugin list; maybe PluginList implementations should be mutable?
+ */
+class PluginList
+{
+    /**
+     * @var GlobalSettingsProvider
+     */
+    private $settings;
+
+    /**
+     * Plugins bundled with core package, disabled by default
+     * @var array
+     */
+    private $corePluginsDisabledByDefault = array(
+        'DBStats',
+        'ExampleCommand',
+        'ExampleSettingsPlugin',
+        'ExampleUI',
+        'ExampleVisualization',
+        'ExamplePluginTemplate',
+        'ExampleTracker',
+        'ExampleReport',
+        'MobileAppMeasurable',
+        'Provider'
+    );
+
+    // Themes bundled with core package, disabled by default
+    private $coreThemesDisabledByDefault = array(
+        'ExampleTheme'
+    );
+
+    public function __construct(GlobalSettingsProvider $settings)
+    {
+        $this->settings = $settings;
+    }
+
+    /**
+     * Returns the list of plugins that should be loaded. Used by the container factory to
+     * load plugin specific DI overrides.
+     *
+     * @return string[]
+     */
+    public function getActivatedPlugins()
+    {
+        $section = $this->settings->getSection('Plugins');
+        return @$section['Plugins'] ?: array();
+    }
+
+    /**
+     * Returns the list of plugins that are bundled with Piwik.
+     *
+     * @return string[]
+     */
+    public function getPluginsBundledWithPiwik()
+    {
+        $pathGlobal = $this->settings->getPathGlobal();
+
+        $section = $this->settings->getIniFileChain()->getFrom($pathGlobal, 'Plugins');
+        return $section['Plugins'];
+    }
+
+    /**
+     * Returns the plugins bundled with core package that are disabled by default.
+     *
+     * @return string[]
+     */
+    public function getCorePluginsDisabledByDefault()
+    {
+        return array_merge($this->corePluginsDisabledByDefault, $this->coreThemesDisabledByDefault);
+    }
+
+    /**
+     * Sorts an array of plugins in the order they should be loaded.
+     *
+     * @params string[] $plugins
+     * @return \string[]
+     */
+    public function sortPlugins(array $plugins)
+    {
+        $global = $this->getPluginsBundledWithPiwik();
+        if (empty($global)) {
+            return $plugins;
+        }
+
+        // we need to make sure a possibly disabled plugin will be still loaded before any 3rd party plugin
+        $global = array_merge($global, $this->corePluginsDisabledByDefault);
+
+        $global = array_values($global);
+        $plugins = array_values($plugins);
+
+        $defaultPluginsLoadedFirst = array_intersect($global, $plugins);
+
+        $otherPluginsToLoadAfterDefaultPlugins = array_diff($plugins, $defaultPluginsLoadedFirst);
+
+        // sort by name to have a predictable order for those extra plugins
+        sort($otherPluginsToLoadAfterDefaultPlugins);
+
+        $sorted = array_merge($defaultPluginsLoadedFirst, $otherPluginsToLoadAfterDefaultPlugins);
+
+        return $sorted;
+    }
+}