This repository has been archived by the owner on Nov 26, 2017. It is now read-only.
/
helper.php
240 lines (212 loc) · 5.61 KB
/
helper.php
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
<?php
/**
* @package Joomla.Platform
* @subpackage Plugin
*
* @copyright Copyright (C) 2005 - 2012 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
defined('JPATH_PLATFORM') or die;
/**
* Plugin helper class
*
* @package Joomla.Platform
* @subpackage Plugin
* @since 11.1
*/
abstract class JPluginHelper
{
/**
* A persistent cache of the loaded plugins.
*
* @var array
* @since 11.3
*/
protected static $plugins = null;
/**
* Get the plugin data of a specific type if no specific plugin is specified
* otherwise only the specific plugin data is returned.
*
* @param string $type The plugin type, relates to the sub-directory in the plugins directory.
* @param string $plugin The plugin name.
*
* @return mixed An array of plugin data objects, or a plugin data object.
*
* @since 11.1
*/
public static function getPlugin($type, $plugin = null)
{
$result = array();
$plugins = self::_load();
// Find the correct plugin(s) to return.
if (!$plugin)
{
foreach ($plugins as $p)
{
// Is this the right plugin?
if ($p->type == $type)
{
$result[] = $p;
}
}
}
else
{
foreach ($plugins as $p)
{
// Is this plugin in the right group?
if ($p->type == $type && $p->name == $plugin)
{
$result = $p;
break;
}
}
}
return $result;
}
/**
* Checks if a plugin is enabled.
*
* @param string $type The plugin type, relates to the sub-directory in the plugins directory.
* @param string $plugin The plugin name.
*
* @return boolean
*
* @since 11.1
*/
public static function isEnabled($type, $plugin = null)
{
$result = self::getPlugin($type, $plugin);
return (!empty($result));
}
/**
* Loads all the plugin files for a particular type if no specific plugin is specified
* otherwise only the specific plugin is loaded.
*
* @param string $type The plugin type, relates to the sub-directory in the plugins directory.
* @param string $plugin The plugin name.
* @param boolean $autocreate Autocreate the plugin.
* @param JEventDispatcher $dispatcher Optionally allows the plugin to use a different dispatcher.
*
* @return boolean True on success.
*
* @since 11.1
*/
public static function importPlugin($type, $plugin = null, $autocreate = true, JEventDispatcher $dispatcher = null)
{
static $loaded = array();
// Check for the default args, if so we can optimise cheaply
$defaults = false;
if (is_null($plugin) && $autocreate == true && is_null($dispatcher))
{
$defaults = true;
}
if (!isset($loaded[$type]) || !$defaults)
{
$results = null;
// Load the plugins from the database.
$plugins = self::_load();
// Get the specified plugin(s).
for ($i = 0, $t = count($plugins); $i < $t; $i++)
{
if ($plugins[$i]->type == $type && ($plugin === null || $plugins[$i]->name == $plugin))
{
self::_import($plugins[$i], $autocreate, $dispatcher);
$results = true;
}
}
// Bail out early if we're not using default args
if (!$defaults)
{
return $results;
}
$loaded[$type] = $results;
}
return $loaded[$type];
}
/**
* Loads the plugin file.
*
* @param JPlugin $plugin The plugin.
* @param boolean $autocreate True to autocreate.
* @param JEventDispatcher $dispatcher Optionally allows the plugin to use a different dispatcher.
*
* @return boolean True on success.
*
* @since 11.1
*/
protected static function _import($plugin, $autocreate = true, JEventDispatcher $dispatcher = null)
{
static $paths = array();
$plugin->type = preg_replace('/[^A-Z0-9_\.-]/i', '', $plugin->type);
$plugin->name = preg_replace('/[^A-Z0-9_\.-]/i', '', $plugin->name);
$path = JPATH_PLUGINS . '/' . $plugin->type . '/' . $plugin->name . '/' . $plugin->name . '.php';
if (!isset($paths[$path]))
{
if (file_exists($path))
{
if (!isset($paths[$path]))
{
require_once $path;
}
$paths[$path] = true;
if ($autocreate)
{
// Makes sure we have an event dispatcher
if (!is_object($dispatcher))
{
$dispatcher = JEventDispatcher::getInstance();
}
$className = 'plg' . $plugin->type . $plugin->name;
if (class_exists($className))
{
// Load the plugin from the database.
if (!isset($plugin->params))
{
// Seems like this could just go bye bye completely
$plugin = self::getPlugin($plugin->type, $plugin->name);
}
// Instantiate and register the plugin.
new $className($dispatcher, (array) ($plugin));
}
}
}
else
{
$paths[$path] = false;
}
}
}
/**
* Loads the published plugins.
*
* @return array An array of published plugins
*
* @since 11.1
*/
protected static function _load()
{
if (self::$plugins !== null)
{
return self::$plugins;
}
$user = JFactory::getUser();
$cache = JFactory::getCache('com_plugins', '');
$levels = implode(',', $user->getAuthorisedViewLevels());
if (!self::$plugins = $cache->get($levels))
{
$db = JFactory::getDbo();
$query = $db->getQuery(true);
$query->select('folder AS type, element AS name, params')
->from('#__extensions')
->where('enabled >= 1')
->where('type =' . $db->Quote('plugin'))
->where('state >= 0')
->where('access IN (' . $levels . ')')
->order('ordering');
self::$plugins = $db->setQuery($query)->loadObjectList();
$cache->store(self::$plugins, $levels);
}
return self::$plugins;
}
}