API
2 weeks ago
Access
2 weeks ago
Application
2 weeks ago
Archive
2 weeks ago
ArchiveProcessor
2 weeks ago
Archiver
2 years ago
AssetManager
2 weeks ago
Auth
2 weeks ago
Category
2 weeks ago
Changes
2 months ago
CliMulti
2 weeks ago
Columns
2 weeks ago
Concurrency
2 weeks ago
Config
2 weeks ago
Container
2 months ago
CronArchive
2 weeks ago
DataAccess
2 weeks ago
DataFiles
2 years ago
DataTable
2 weeks ago
Db
2 weeks ago
DeviceDetector
1 year ago
Email
2 years ago
Exception
5 months ago
Http
2 weeks ago
Intl
4 months ago
Log
2 years ago
Mail
1 year ago
Measurable
8 months ago
Menu
2 weeks ago
Metrics
2 weeks ago
Notification
8 months ago
Period
2 weeks ago
Plugin
2 weeks ago
Policy
2 months ago
ProfessionalServices
1 year ago
Report
1 year ago
ReportRenderer
2 weeks ago
Request
2 weeks ago
Scheduler
2 weeks ago
Segment
2 weeks ago
Session
1 month ago
Settings
2 weeks ago
Tracker
2 weeks ago
Translation
2 months ago
Twig
1 year ago
UpdateCheck
4 months ago
Updater
2 weeks ago
Updates
1 month ago
Validators
1 year ago
View
2 months ago
ViewDataTable
2 weeks ago
Visualization
2 weeks ago
Widget
2 weeks ago
.htaccess
2 years ago
Access.php
2 weeks ago
Archive.php
2 months ago
ArchiveProcessor.php
2 weeks ago
AssetManager.php
2 weeks ago
Auth.php
8 months ago
AuthResult.php
8 months ago
BaseFactory.php
2 years ago
Cache.php
2 weeks ago
CacheId.php
5 months ago
CliMulti.php
2 weeks ago
Common.php
2 weeks ago
Config.php
2 weeks ago
Console.php
4 months ago
Context.php
2 years ago
Cookie.php
2 weeks ago
CronArchive.php
2 weeks ago
DI.php
4 months ago
DataArray.php
2 weeks ago
DataTable.php
2 weeks ago
Date.php
2 months ago
Db.php
2 months ago
DbHelper.php
2 weeks ago
Development.php
2 weeks ago
ErrorHandler.php
8 months ago
EventDispatcher.php
2 months ago
ExceptionHandler.php
5 months ago
FileIntegrity.php
2 weeks ago
Filechecks.php
1 year ago
Filesystem.php
2 weeks ago
FrontController.php
2 weeks ago
Http.php
2 weeks ago
IP.php
1 year ago
Log.php
4 months ago
LogDeleter.php
2 weeks ago
Mail.php
1 year ago
Metrics.php
2 months ago
NoAccessException.php
2 years ago
Nonce.php
8 months ago
Notification.php
2 months ago
NumberFormatter.php
2 weeks ago
Option.php
2 weeks ago
Period.php
2 weeks ago
Piwik.php
2 weeks ago
Plugin.php
2 months ago
Process.php
2 months ago
Profiler.php
2 weeks ago
ProxyHeaders.php
5 months ago
ProxyHttp.php
2 weeks ago
QuickForm2.php
4 months ago
RankingQuery.php
2 months ago
ReportRenderer.php
2 weeks ago
Request.php
2 months ago
Segment.php
2 weeks ago
Sequence.php
2 weeks ago
Session.php
1 month ago
SettingsPiwik.php
2 weeks ago
SettingsServer.php
2 weeks ago
Singleton.php
2 years ago
Site.php
2 months ago
SiteContentDetector.php
2 months ago
SupportedBrowser.php
2 years ago
TCPDF.php
1 year ago
Theme.php
2 weeks ago
Timer.php
2 weeks ago
Tracker.php
2 weeks ago
Twig.php
2 months ago
Unzip.php
1 year ago
UpdateCheck.php
2 months ago
Updater.php
2 weeks ago
UpdaterErrorException.php
2 years ago
Updates.php
2 weeks ago
Url.php
2 weeks ago
UrlHelper.php
2 months ago
Version.php
2 weeks ago
View.php
2 weeks ago
bootstrap.php
1 year ago
dispatch.php
2 years ago
testMinimumPhpVersion.php
8 months ago
EventDispatcher.php
190 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; |
| 10 | |
| 11 | use Piwik\Container\StaticContainer; |
| 12 | /** |
| 13 | * This class allows code to post events from anywhere in Piwik and for |
| 14 | * plugins to associate callbacks to be executed when events are posted. |
| 15 | */ |
| 16 | class EventDispatcher |
| 17 | { |
| 18 | /** |
| 19 | * @return EventDispatcher |
| 20 | */ |
| 21 | public static function getInstance() |
| 22 | { |
| 23 | return StaticContainer::get('Piwik\\EventDispatcher'); |
| 24 | } |
| 25 | // implementation details for postEvent |
| 26 | public const EVENT_CALLBACK_GROUP_FIRST = 0; |
| 27 | public const EVENT_CALLBACK_GROUP_SECOND = 1; |
| 28 | public const EVENT_CALLBACK_GROUP_THIRD = 2; |
| 29 | /** |
| 30 | * Array of observers (callbacks attached to events) that are not methods |
| 31 | * of plugin classes. |
| 32 | * |
| 33 | * @var array |
| 34 | */ |
| 35 | private $extraObservers = array(); |
| 36 | /** |
| 37 | * Array storing information for all pending events. Each item in the array |
| 38 | * will be an array w/ two elements: |
| 39 | * |
| 40 | * array( |
| 41 | * 'Event.Name', // the event name |
| 42 | * array('event', 'parameters') // the parameters to pass to event observers |
| 43 | * ) |
| 44 | * |
| 45 | * @var array |
| 46 | */ |
| 47 | private $pendingEvents = array(); |
| 48 | /** |
| 49 | * Plugin\Manager instance used to get list of loaded plugins. |
| 50 | * |
| 51 | * @var \Piwik\Plugin\Manager |
| 52 | */ |
| 53 | private $pluginManager; |
| 54 | private $pluginHooks = array(); |
| 55 | public static $_SKIP_EVENTS_IN_TESTS = \false; |
| 56 | // phpcs:ignore PSR2.Classes.PropertyDeclaration.Underscore |
| 57 | public function __construct(\Piwik\Plugin\Manager $pluginManager, array $observers = array()) |
| 58 | { |
| 59 | $this->pluginManager = $pluginManager; |
| 60 | foreach ($observers as $observerInfo) { |
| 61 | list($eventName, $callback) = $observerInfo; |
| 62 | $this->extraObservers[$eventName][] = $callback; |
| 63 | } |
| 64 | } |
| 65 | /** |
| 66 | * Triggers an event, executing all callbacks associated with it. |
| 67 | * |
| 68 | * @param string $eventName The name of the event, ie, API.getReportMetadata. |
| 69 | * @param array $params The parameters to pass to each callback when executing. |
| 70 | * @param bool $pending Whether this event should be posted again for plugins |
| 71 | * loaded after the event is fired. |
| 72 | * @param array|null $plugins The plugins to post events to. If null, the event |
| 73 | * is posted to all plugins. The elements of this array |
| 74 | * can be either the Plugin objects themselves |
| 75 | * or their string names. |
| 76 | */ |
| 77 | public function postEvent($eventName, $params, $pending = \false, $plugins = null) |
| 78 | { |
| 79 | if (self::$_SKIP_EVENTS_IN_TESTS) { |
| 80 | return; |
| 81 | } |
| 82 | if ($pending) { |
| 83 | $this->pendingEvents[] = array($eventName, $params); |
| 84 | } |
| 85 | $manager = $this->pluginManager; |
| 86 | if (empty($plugins)) { |
| 87 | $plugins = $manager->getPluginsLoadedAndActivated(); |
| 88 | } else { |
| 89 | $pluginMap = []; |
| 90 | foreach ($plugins as $plugin) { |
| 91 | if (is_string($plugin)) { |
| 92 | $plugin = $this->pluginManager->getLoadedPlugin($plugin); |
| 93 | } |
| 94 | $pluginMap[$plugin->getPluginName()] = $plugin; |
| 95 | } |
| 96 | $plugins = $pluginMap; |
| 97 | } |
| 98 | $callbacks = array(); |
| 99 | // collect all callbacks to execute |
| 100 | foreach ($plugins as $pluginName => $plugin) { |
| 101 | if (!isset($this->pluginHooks[$pluginName])) { |
| 102 | $this->pluginHooks[$pluginName] = $plugin->registerEvents(); |
| 103 | } |
| 104 | $hooks = $this->pluginHooks[$pluginName]; |
| 105 | if (isset($hooks[$eventName])) { |
| 106 | list($pluginFunction, $callbackGroup) = $this->getCallbackFunctionAndGroupNumber($hooks[$eventName]); |
| 107 | if (is_string($pluginFunction)) { |
| 108 | $callbacks[$callbackGroup][] = [$plugin, $pluginFunction]; |
| 109 | } else { |
| 110 | $callbacks[$callbackGroup][] = $pluginFunction; |
| 111 | } |
| 112 | } |
| 113 | } |
| 114 | if (isset($this->extraObservers[$eventName])) { |
| 115 | foreach ($this->extraObservers[$eventName] as $callbackInfo) { |
| 116 | list($callback, $callbackGroup) = $this->getCallbackFunctionAndGroupNumber($callbackInfo); |
| 117 | $callbacks[$callbackGroup][] = $callback; |
| 118 | } |
| 119 | } |
| 120 | // sort callbacks by their importance |
| 121 | ksort($callbacks); |
| 122 | // execute callbacks in order |
| 123 | foreach ($callbacks as $callbackGroup) { |
| 124 | foreach ($callbackGroup as $callback) { |
| 125 | call_user_func_array($callback, $params); |
| 126 | } |
| 127 | } |
| 128 | } |
| 129 | /** |
| 130 | * Associates a callback that is not a plugin class method with an event |
| 131 | * name. |
| 132 | * |
| 133 | * @param string $eventName |
| 134 | * @param array|callable $callback This can be a normal PHP callback or an array |
| 135 | * that looks like this: |
| 136 | * array( |
| 137 | * 'function' => $callback, |
| 138 | * 'before' => true |
| 139 | * ) |
| 140 | * or this: |
| 141 | * array( |
| 142 | * 'function' => $callback, |
| 143 | * 'after' => true |
| 144 | * ) |
| 145 | * If 'before' is set, the callback will be executed |
| 146 | * before normal & 'after' ones. If 'after' then it |
| 147 | * will be executed after normal ones. |
| 148 | */ |
| 149 | public function addObserver($eventName, $callback) |
| 150 | { |
| 151 | $this->extraObservers[$eventName][] = $callback; |
| 152 | } |
| 153 | /** |
| 154 | * Re-posts all pending events to the given plugin. |
| 155 | * |
| 156 | * @param Plugin $plugin |
| 157 | */ |
| 158 | public function postPendingEventsTo($plugin) |
| 159 | { |
| 160 | foreach ($this->pendingEvents as $eventInfo) { |
| 161 | [$eventName, $eventParams] = $eventInfo; |
| 162 | $this->postEvent($eventName, $eventParams, $pending = \false, array($plugin)); |
| 163 | } |
| 164 | } |
| 165 | /** |
| 166 | * @internal For testing purpose only |
| 167 | */ |
| 168 | public function clearCache() |
| 169 | { |
| 170 | $this->pluginHooks = []; |
| 171 | } |
| 172 | private function getCallbackFunctionAndGroupNumber($hookInfo) |
| 173 | { |
| 174 | if (is_array($hookInfo) && !empty($hookInfo['function'])) { |
| 175 | $pluginFunction = $hookInfo['function']; |
| 176 | if (!empty($hookInfo['before'])) { |
| 177 | $callbackGroup = self::EVENT_CALLBACK_GROUP_FIRST; |
| 178 | } elseif (!empty($hookInfo['after'])) { |
| 179 | $callbackGroup = self::EVENT_CALLBACK_GROUP_THIRD; |
| 180 | } else { |
| 181 | $callbackGroup = self::EVENT_CALLBACK_GROUP_SECOND; |
| 182 | } |
| 183 | } else { |
| 184 | $pluginFunction = $hookInfo; |
| 185 | $callbackGroup = self::EVENT_CALLBACK_GROUP_SECOND; |
| 186 | } |
| 187 | return array($pluginFunction, $callbackGroup); |
| 188 | } |
| 189 | } |
| 190 |