Environment.php
221 lines
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * Matomo - free/libre analytics platform |
| 5 | * |
| 6 | * @link https://matomo.org |
| 7 | * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later |
| 8 | */ |
| 9 | namespace Piwik\Application; |
| 10 | |
| 11 | use Piwik\Container\Container; |
| 12 | use Piwik\Application\Kernel\EnvironmentValidator; |
| 13 | use Piwik\Application\Kernel\GlobalSettingsProvider; |
| 14 | use Piwik\Application\Kernel\PluginList; |
| 15 | use Piwik\Container\ContainerFactory; |
| 16 | use Piwik\Container\StaticContainer; |
| 17 | use Piwik\Piwik; |
| 18 | /** |
| 19 | * Encapsulates Piwik environment setup and access. |
| 20 | * |
| 21 | * The Piwik environment consists of two main parts: the kernel and the DI container. |
| 22 | * |
| 23 | * The 'kernel' is the core part of Piwik that cannot be modified / extended through the DI container. |
| 24 | * It includes components that are required to create the DI container. |
| 25 | * |
| 26 | * Currently the only objects in the 'kernel' are a GlobalSettingsProvider object and a |
| 27 | * PluginList object. The GlobalSettingsProvider object is required for the current PluginList |
| 28 | * implementation and for checking whether Development mode is enabled. The PluginList is |
| 29 | * needed in order to determine what plugins are activated, since plugins can provide their |
| 30 | * own DI configuration. |
| 31 | * |
| 32 | * The DI container contains every other Piwik object, including the Plugin\Manager, |
| 33 | * plugin API instances, dependent services, etc. Plugins and users can override/extend |
| 34 | * the objects in this container. |
| 35 | * |
| 36 | * NOTE: DI support in Piwik is currently a work in process; not everything is currently |
| 37 | * stored in the DI container, but we are working towards this. |
| 38 | */ |
| 39 | class Environment |
| 40 | { |
| 41 | /** |
| 42 | * @internal |
| 43 | * @var EnvironmentManipulator |
| 44 | */ |
| 45 | private static $globalEnvironmentManipulator = null; |
| 46 | /** |
| 47 | * @var string |
| 48 | */ |
| 49 | private $environment; |
| 50 | /** |
| 51 | * @var array |
| 52 | */ |
| 53 | private $definitions; |
| 54 | /** |
| 55 | * @var Container |
| 56 | */ |
| 57 | private $container; |
| 58 | /** |
| 59 | * @var GlobalSettingsProvider |
| 60 | */ |
| 61 | private $globalSettingsProvider; |
| 62 | /** |
| 63 | * @var PluginList |
| 64 | */ |
| 65 | private $pluginList; |
| 66 | /** |
| 67 | * @param string $environment |
| 68 | * @param array $definitions |
| 69 | */ |
| 70 | public function __construct($environment, array $definitions = array()) |
| 71 | { |
| 72 | $this->environment = $environment; |
| 73 | $this->definitions = $definitions; |
| 74 | } |
| 75 | public function getEnvironmentName() |
| 76 | { |
| 77 | return $this->environment; |
| 78 | } |
| 79 | /** |
| 80 | * Initializes the kernel globals and DI container. |
| 81 | */ |
| 82 | public function init() |
| 83 | { |
| 84 | $this->invokeBeforeContainerCreatedHook(); |
| 85 | $this->container = $this->createContainer(); |
| 86 | $this->container->set(self::class, $this); |
| 87 | StaticContainer::push($this->container); |
| 88 | $this->validateEnvironment(); |
| 89 | $this->invokeEnvironmentBootstrappedHook(); |
| 90 | Piwik::postEvent('Environment.bootstrapped'); |
| 91 | // this event should be removed eventually |
| 92 | } |
| 93 | /** |
| 94 | * Destroys an environment. MUST be called when embedding environments. |
| 95 | */ |
| 96 | public function destroy() |
| 97 | { |
| 98 | StaticContainer::pop(); |
| 99 | } |
| 100 | /** |
| 101 | * Returns the DI container. All Piwik objects for a specific Piwik instance should be stored |
| 102 | * in this container. |
| 103 | * |
| 104 | * @return Container |
| 105 | */ |
| 106 | public function getContainer() |
| 107 | { |
| 108 | return $this->container; |
| 109 | } |
| 110 | /** |
| 111 | * @link http://php-di.org/doc/container-configuration.html |
| 112 | */ |
| 113 | private function createContainer() |
| 114 | { |
| 115 | $pluginList = $this->getPluginListCached(); |
| 116 | $settings = $this->getGlobalSettingsCached(); |
| 117 | $extraDefinitions = $this->getExtraDefinitionsFromManipulators(); |
| 118 | $definitions = array_merge(StaticContainer::getDefinitions(), $extraDefinitions, array($this->definitions)); |
| 119 | $environments = array($this->environment); |
| 120 | $environments = array_merge($environments, $this->getExtraEnvironmentsFromManipulators()); |
| 121 | $containerFactory = new ContainerFactory($pluginList, $settings, $environments, $definitions); |
| 122 | return $containerFactory->create(); |
| 123 | } |
| 124 | protected function getGlobalSettingsCached() |
| 125 | { |
| 126 | if ($this->globalSettingsProvider === null) { |
| 127 | $original = $this->getGlobalSettings(); |
| 128 | $globalSettingsProvider = $this->getGlobalSettingsProviderOverride($original); |
| 129 | $this->globalSettingsProvider = $globalSettingsProvider ?: $original; |
| 130 | } |
| 131 | return $this->globalSettingsProvider; |
| 132 | } |
| 133 | protected function getPluginListCached() |
| 134 | { |
| 135 | if ($this->pluginList === null) { |
| 136 | $pluginList = $this->getPluginListOverride(); |
| 137 | $this->pluginList = $pluginList ?: $this->getPluginList(); |
| 138 | } |
| 139 | return $this->pluginList; |
| 140 | } |
| 141 | /** |
| 142 | * Returns the kernel global GlobalSettingsProvider object. Derived classes can override this method |
| 143 | * to provide a different implementation. |
| 144 | * |
| 145 | * @return null|GlobalSettingsProvider |
| 146 | */ |
| 147 | protected function getGlobalSettings() |
| 148 | { |
| 149 | return new GlobalSettingsProvider(); |
| 150 | } |
| 151 | /** |
| 152 | * Returns the kernel global PluginList object. Derived classes can override this method to |
| 153 | * provide a different implementation. |
| 154 | * |
| 155 | * @return PluginList |
| 156 | */ |
| 157 | protected function getPluginList() |
| 158 | { |
| 159 | // TODO: in tracker should only load tracker plugins. can't do properly until tracker entrypoint is encapsulated. |
| 160 | return new PluginList($this->getGlobalSettingsCached()); |
| 161 | } |
| 162 | private function validateEnvironment() |
| 163 | { |
| 164 | /** @var EnvironmentValidator $validator */ |
| 165 | $validator = $this->container->get('Piwik\\Application\\Kernel\\EnvironmentValidator'); |
| 166 | $validator->validate(); |
| 167 | } |
| 168 | /** |
| 169 | * @param EnvironmentManipulator $manipulator |
| 170 | * @internal |
| 171 | */ |
| 172 | public static function setGlobalEnvironmentManipulator(\Piwik\Application\EnvironmentManipulator $manipulator) |
| 173 | { |
| 174 | self::$globalEnvironmentManipulator = $manipulator; |
| 175 | } |
| 176 | private function getGlobalSettingsProviderOverride(GlobalSettingsProvider $original) |
| 177 | { |
| 178 | if (self::$globalEnvironmentManipulator) { |
| 179 | return self::$globalEnvironmentManipulator->makeGlobalSettingsProvider($original); |
| 180 | } else { |
| 181 | return null; |
| 182 | } |
| 183 | } |
| 184 | private function invokeBeforeContainerCreatedHook() |
| 185 | { |
| 186 | if (self::$globalEnvironmentManipulator) { |
| 187 | return self::$globalEnvironmentManipulator->beforeContainerCreated(); |
| 188 | } |
| 189 | } |
| 190 | private function getExtraDefinitionsFromManipulators() |
| 191 | { |
| 192 | if (self::$globalEnvironmentManipulator) { |
| 193 | return self::$globalEnvironmentManipulator->getExtraDefinitions(); |
| 194 | } else { |
| 195 | return array(); |
| 196 | } |
| 197 | } |
| 198 | private function invokeEnvironmentBootstrappedHook() |
| 199 | { |
| 200 | if (self::$globalEnvironmentManipulator) { |
| 201 | self::$globalEnvironmentManipulator->onEnvironmentBootstrapped(); |
| 202 | } |
| 203 | } |
| 204 | private function getExtraEnvironmentsFromManipulators() |
| 205 | { |
| 206 | if (self::$globalEnvironmentManipulator) { |
| 207 | return self::$globalEnvironmentManipulator->getExtraEnvironments(); |
| 208 | } else { |
| 209 | return array(); |
| 210 | } |
| 211 | } |
| 212 | private function getPluginListOverride() |
| 213 | { |
| 214 | if (self::$globalEnvironmentManipulator) { |
| 215 | return self::$globalEnvironmentManipulator->makePluginList($this->getGlobalSettingsCached()); |
| 216 | } else { |
| 217 | return null; |
| 218 | } |
| 219 | } |
| 220 | } |
| 221 |