1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
|
<?php
/**
* Piwik - Open source web analytics
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
* @version $Id$
*
* @package Piwik
*/
require_once "Plugin.php";
require_once "Event/Dispatcher.php";
/**
* Plugin specification for a statistics logging plugin
*
* A plugin that display data in the Piwik Interface is very different from a plugin
* that will save additional data in the database during the statistics logging.
* These two types of plugins don't have the same requirements at all. Therefore a plugin
* that saves additional data in the database during the stats logging process will have a different
* structure.
*
* A plugin for logging data has to focus on performance and therefore has to stay as simple as possible.
* For input data, it is strongly advised to use the Piwik methods available in Piwik_Common
*
* Things that can be done with such a plugin:
* - having a dependency with a list of other plugins
* - have an install step that would prepare the plugin environment
* - install could add columns to the tables
* - install could create tables
* - register to hooks at several points in the logging process
* - register to hooks in other plugins
* - generally a plugin method can modify data (filter) and add/remove data
*
*
* @package Piwik
*/
class Piwik_PluginsManager
{
/**
* Dispatcher
*
* @var Event_Dispatcher
*/
public $dispatcher;
protected $pluginsToLoad = array();
protected $installPlugins = false;
protected $doLoadPlugins = true;
protected $languageToLoad = null;
protected $loadedPlugins = array();
protected $doLoadAlwaysActivatedPlugins = true;
protected $pluginToAlwaysEnable = array( 'Home',
'AdminHome',
'PluginsAdmin'
);
static private $instance = null;
/**
* Returns the singleton Piwik_PluginsManager
*
* @return Piwik_PluginsManager
*/
static public function getInstance()
{
if (self::$instance == null)
{
$c = __CLASS__;
self::$instance = new $c();
}
return self::$instance;
}
private function __construct()
{
$this->dispatcher = Event_Dispatcher::getInstance();
}
public function isPluginAlwaysActivated( $name )
{
return in_array( $name, $this->pluginToAlwaysEnable);
}
public function isPluginEnabled( $name )
{
return in_array( $name, $this->pluginsToLoad)
|| $this->isPluginAlwaysActivated( $name );
}
/**
* Reads the directories inside the plugins/ directory and returns their names in an array
*
* @return array
*/
public function readPluginsDirectory()
{
$pluginsName = glob( "plugins/*",GLOB_ONLYDIR);
$pluginsName = array_map('basename', $pluginsName);
return $pluginsName;
}
public function deactivatePlugin($pluginName)
{
$plugins = $this->pluginsToLoad;
$key = array_search($pluginName,$plugins);
if($key !== false)
{
unset($plugins[$key]);
Zend_Registry::get('config')->Plugins = $plugins;
}
try{
$pluginsLogStats = Zend_Registry::get('config')->Plugins_LogStats->Plugins_LogStats;
if(!is_null($pluginsLogStats))
{
$pluginsLogStats = $pluginsLogStats->toArray();
$key = array_search($pluginName,$pluginsLogStats);
if($key !== false)
{
unset($pluginsLogStats[$key]);
Zend_Registry::get('config')->Plugins_LogStats = $pluginsLogStats;
}
}
} catch(Exception $e) {}
}
/**
* TODO horrible dirty hack because the Config class is not clean enough. Needs to rewrite the Config
* __set and __get in a cleaner way, also see the __destruct which writes the configuration file.
*
* @return array
*/
protected function getInstalledPlugins()
{
// var_dump(Zend_Registry::get('config')->PluginsInstalled);
if(!class_exists('Zend_Registry'))
{
throw new Exception("Not possible to list installed plugins (case LogStats module)");
}
if(!is_null(Zend_Registry::get('config')->PluginsInstalled->PluginsInstalled))
{
return Zend_Registry::get('config')->PluginsInstalled->PluginsInstalled->toArray();
}
elseif(is_array(Zend_Registry::get('config')->PluginsInstalled))
{
return Zend_Registry::get('config')->PluginsInstalled;
}
else
{
return Zend_Registry::get('config')->PluginsInstalled->toArray();
}
}
public function installLoadedPlugins()
{
foreach($this->getLoadedPlugins() as $plugin)
{
try {
$this->installPluginIfNecessary( $plugin );
}catch(Exception $e){
echo $e->getMessage();
}
}
}
protected function installPluginIfNecessary( Piwik_Plugin $plugin )
{
$pluginName = $plugin->getName();
// is the plugin already installed or is it the first time we activate it?
$pluginsInstalled = $this->getInstalledPlugins();
// echo "$pluginName before=".var_dump($pluginsInstalled);
if(!in_array($pluginName,$pluginsInstalled))
{
$this->installPlugin($plugin);
$pluginsInstalled[] = $pluginName;
// var_dump($pluginsInstalled);
Zend_Registry::get('config')->PluginsInstalled = $pluginsInstalled;
}
}
public function activatePlugin($pluginName)
{
$plugins = Zend_Registry::get('config')->Plugins->Plugins->toArray();
if(in_array($pluginName,$plugins))
{
throw new Exception("Plugin '$pluginName' already activated.");
}
$existingPlugins = $this->readPluginsDirectory();
if( array_search($pluginName,$existingPlugins) === false)
{
throw new Exception("Unable to find the plugin '$pluginName'.");
}
$plugin = $this->loadPlugin($pluginName);
$this->installPluginIfNecessary($plugin);
$information = $plugin->getInformation();
// if the plugin is to be loaded during the statistics logging
if(isset($information['LogStatsPlugin'])
&& $information['LogStatsPlugin'] === true)
{
$pluginsLogStats = Zend_Registry::get('config')->Plugins_LogStats->Plugins_LogStats;
if(is_null($pluginsLogStats))
{
$pluginsLogStats = array();
}
else
{
$pluginsLogStats = $pluginsLogStats->toArray();
}
$pluginsLogStats[] = $pluginName;
// the config file will automatically be saved with the new plugin
Zend_Registry::get('config')->Plugins_LogStats = $pluginsLogStats;
}
// we add the plugin to the list of activated plugins
$plugins[] = $pluginName;
// the config file will automatically be saved with the new plugin
Zend_Registry::get('config')->Plugins = $plugins;
}
public function setPluginsToLoad( array $pluginsToLoad )
{
// case no plugins to load
if(is_null($pluginsToLoad))
{
$pluginsToLoad = array();
}
$this->pluginsToLoad = $pluginsToLoad;
$this->loadPlugins();
}
public function doNotLoadPlugins()
{
$this->doLoadPlugins = false;
}
public function doNotLoadAlwaysActivatedPlugins()
{
$this->doLoadAlwaysActivatedPlugins = false;
}
/**
* Add a plugin in the loaded plugins array
*
* @param Piwik_Plugin $newPlugin
* @param string plugin name without prefix (eg. 'UserCountry')
*/
protected function addLoadedPlugin( $pluginName, Piwik_Plugin $newPlugin )
{
$this->loadedPlugins[$pluginName] = $newPlugin;
}
/**
* Returns an array containing the plugins class names (eg. 'Piwik_UserCountry' and NOT 'UserCountry')
*
* @return array
*/
public function getLoadedPluginsName()
{
$oPlugins = $this->getLoadedPlugins();
$pluginNames = array_map('get_class',$oPlugins);
return $pluginNames;
}
/**
* Returns an array of key,value with the following format: array(
* 'UserCountry' => Piwik_Plugin $pluginObject,
* 'UserSettings' => Piwik_Plugin $pluginObject,
* );
*
* @return array
*/
public function getLoadedPlugins()
{
return $this->loadedPlugins;
}
/**
* Load the plugins classes installed.
* Register the observers for every plugin.
*
*/
public function loadPlugins()
{
$this->pluginsToLoad = array_unique($this->pluginsToLoad);
$pluginsToLoad = $this->pluginsToLoad;
if($this->doLoadAlwaysActivatedPlugins)
{
$pluginsToLoad = array_merge($this->pluginsToLoad, $this->pluginToAlwaysEnable);
}
foreach($pluginsToLoad as $pluginName)
{
$newPlugin = $this->loadPlugin($pluginName);
// if we have to load the plugins
// and if this plugin is activated
if($this->doLoadPlugins
&& $this->isPluginEnabled($pluginName))
{
$newPlugin->registerTranslation( $this->languageToLoad );
$this->addPluginObservers( $newPlugin );
$this->addLoadedPlugin( $pluginName, $newPlugin);
$newPlugin->postLoad();
}
}
}
/**
* Loads the plugin filename and instanciates the plugin with the given name, eg. UserCountry
* Do NOT give the class name ie. Piwik_UserCountry, but give the plugin name ie. UserCountry
*
* @param Piwik_Plugin $pluginName
*/
public function loadPlugin( $pluginName )
{
if(isset($this->loadedPlugins[$pluginName]))
{
return $this->loadedPlugins[$pluginName];
}
$pluginFileName = $pluginName . '/' . $pluginName . ".php";
$pluginClassName = "Piwik_".$pluginName;
if( !Piwik_Common::isValidFilename($pluginName))
{
throw new Exception("The plugin filename '$pluginFileName' is not a valid filename");
}
$path = 'plugins/' . $pluginFileName;
// case LogStats, we don't throw the exception, we don't want to add the Zend overhead
if(class_exists('Zend_Loader')
&& !Zend_Loader::isReadable($path))
{
throw new Exception("The plugin file {$path} couldn't be found.");
}
require_once $path;
if(!class_exists($pluginClassName))
{
throw new Exception("The class $pluginClassName couldn't be found in the file '$path'");
}
$newPlugin = new $pluginClassName;
if(!($newPlugin instanceof Piwik_Plugin))
{
throw new Exception("The plugin $pluginClassName in the file $path must inherit from Piwik_Plugin.");
}
return $newPlugin;
}
public function installPlugin( Piwik_Plugin $plugin )
{
try{
$plugin->install();
} catch(Exception $e) {
throw new Piwik_Plugin_Exception($plugin->getName(), $e->getMessage()); }
}
public function installPlugins()
{
foreach($this->getLoadedPlugins() as $plugin)
{
// var_dump($plugin);
try{
$plugin->install();
} catch(Exception $e) {
throw new Piwik_Plugin_Exception($plugin->getName(), $e->getMessage());
}
}
}
public function setLanguageToLoad( $code )
{
$this->languageToLoad = $code;
}
/**
* For the given plugin, add all the observers of this plugin.
*/
private function addPluginObservers( Piwik_Plugin $plugin )
{
$hooks = $plugin->getListHooksRegistered();
foreach($hooks as $hookName => $methodToCall)
{
$this->dispatcher->addObserver( array( $plugin, $methodToCall), $hookName );
}
}
public function unloadPlugin( $plugin )
{
if(!($plugin instanceof Piwik_Plugin ))
{
$plugin = $this->loadPlugin( $plugin );
}
$hooks = $plugin->getListHooksRegistered();
foreach($hooks as $hookName => $methodToCall)
{
$success = $this->dispatcher->removeObserver( array( $plugin, $methodToCall), $hookName );
if($success !== true)
{
throw new Exception("Error unloading plugin for method = $methodToCall // hook = $hookName ");
}
}
unset($this->loadedPlugins[$plugin->getName()]);
}
public function unloadPlugins()
{
$pluginsLoaded = $this->getLoadedPlugins();
foreach($pluginsLoaded as $plugin)
{
$this->unloadPlugin($plugin);
}
}
}
class Piwik_Plugin_Exception extends Exception
{
function __construct($name, $message)
{
parent::__construct("There was a problem installing the plugin ". $name . " = " . $message.
"<br><b>If this plugin has already been installed, and if you want to hide this message</b>, you must add the following line under the
<code>[PluginsInstalled]</code> entry in your config/config.ini.php file:<br>
<code>PluginsInstalled[] = $name</code><br><br>" );
}
}
/**
* Post an event to the dispatcher which will notice the observers
*/
function Piwik_PostEvent( $eventName, &$object = null, $info = array() )
{
Piwik_PluginsManager::getInstance()->dispatcher->post( $object, $eventName, $info, true, false );
}
/**
* Register an action to execute for a given event
*/
function Piwik_AddAction( $hookName, $function )
{
Piwik_PluginsManager::getInstance()->dispatcher->addObserver( $function, $hookName );
}
|