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
|
<?php
/**
* Elgg plugins library
* Contains functions for managing plugins
*
* @package Elgg
* @subpackage Core
* @license http://www.gnu.org/licenses/old-licenses/gpl-2.0.html GNU Public License version 2
* @author Curverider Ltd
* @copyright Curverider Ltd 2008
* @link http://elgg.org/
*/
/**
* PluginException
*
* A plugin Exception, thrown when an Exception occurs relating to the plugin mechanism. Subclass for specific plugin Exceptions.
*
* @package Elgg
* @subpackage Exceptions
*/
class PluginException extends Exception {}
/**
* @class ElggPlugin Object representing a plugin's settings for a given site.
* This class is currently a stub, allowing a plugin to saving settings in an object's metadata for each site.
* @author Marcus Povey
*/
class ElggPlugin extends ElggObject
{
protected function initialise_attributes()
{
parent::initialise_attributes();
$this->attributes['subtype'] = "plugin";
}
public function __construct($guid = null)
{
parent::__construct($guid);
}
}
/**
* For now, loads plugins directly
*
* @todo Add proper plugin handler that launches plugins in an admin-defined order and activates them on admin request
* @package Elgg
* @subpackage Core
*/
function load_plugins() {
global $CONFIG;
if (!empty($CONFIG->pluginspath)) {
if ($handle = opendir($CONFIG->pluginspath)) {
while ($mod = readdir($handle)) {
if (!in_array($mod,array('.','..','.svn','CVS')) && is_dir($CONFIG->pluginspath . "/" . $mod)) {
if (!@include($CONFIG->pluginspath . $mod . "/start.php"))
throw new PluginException(sprintf(elgg_echo('PluginException:MisconfiguredPlugin'), $mod));
if (is_dir($CONFIG->pluginspath . $mod . "/views/default")) {
autoregister_views("",$CONFIG->pluginspath . $mod . "/views/default",$CONFIG->pluginspath . $mod . "/views/");
}
if (is_dir($CONFIG->pluginspath . $mod . "/languages")) {
register_translations($CONFIG->pluginspath . $mod . "/languages/");
}
}
}
}
}
}
/**
* Get the name of the most recent plugin to be called in the call stack (or the plugin that owns the current page, if any).
*
* i.e., if the last plugin was in /mod/foobar/, get_plugin_name would return foo_bar.
*
* @param boolean $mainfilename If set to true, this will instead determine the context from the main script filename called by the browser. Default = false.
* @return string|false Plugin name, or false if no plugin name was called
*/
function get_plugin_name($mainfilename = false) {
if (!$mainfilename) {
if ($backtrace = debug_backtrace()) {
foreach($backtrace as $step) {
$file = $step['file'];
$file = str_replace("\\","/",$file);
$file = str_replace("//","/",$file);
if (preg_match("/mod\/([a-zA-Z0-9\-\_]*)\/start\.php$/",$file,$matches)) {
return $matches[1];
}
}
}
} else {
$file = $_SERVER["SCRIPT_NAME"];
$file = str_replace("\\","/",$file);
$file = str_replace("//","/",$file);
if (preg_match("/mod\/([a-zA-Z0-9\-\_]*)\//",$file,$matches)) {
return $matches[1];
}
}
return false;
}
/**
* Register a plugin with a manifest.
*
* It is passed an associated array of values. Currently the following fields are recognised:
*
* 'author', 'description', 'version', 'website' & 'copyright'.
*
* @param array $manifest An associative array representing the manifest.
*/
function register_plugin_manifest(array $manifest)
{
global $CONFIG;
if (!is_array($CONFIG->plugin_manifests))
$CONFIG->plugin_manifests = array();
$plugin_name = get_plugin_name();
if ($plugin_name)
{
$CONFIG->plugin_manifests[$plugin_name] = $manifest;
}
else
throw new PluginException(elgg_echo('PluginException:NoPluginName'));
}
/**
* Register a basic plugin manifest.
*
* @param string $author The author.
* @param string $description A description of the plugin (don't forget to internationalise this string!)
* @param string $version The version
* @param string $website A link to the plugin's website
* @param string $copyright Copyright information
* @return bool
*/
function register_plugin_manifest_basic($author, $description, $version, $website = "", $copyright = "")
{
return register_plugin_manifest(array(
'version' => $version,
'author' => $author,
'description' => $description,
'website' => $website,
'copyright' => $copyright
));
}
/**
* Shorthand function for finding the plugin settings.
*
* @param string $plugin_name Optional plugin name, if not specified then it is detected from where you
* are calling from.
*/
function find_plugin_settings($plugin_name = "")
{
$plugins = get_entities('object', 'plugin');
$plugin_name = sanitise_string($plugin_name);
if (!$plugin_name)
$plugin_name = get_plugin_name();
if ($plugins)
{
foreach ($plugins as $plugins)
if (strcmp($plugin->title, $plugin_name)==0)
return $plugin;
}
return false;
}
/**
* Set a setting for a plugin.
*
* @param string $name The name - note, can't be "title".
* @param mixed $value The value.
* @param string $plugin_name Optional plugin name, if not specified then it is detected from where you are calling from.
*/
function set_plugin_setting($name, $value, $plugin_name = "")
{
$plugin = find_plugin_settings($plugin_name);
if (!$plugin)
$plugin = new ElggPlugin();
if ($name!='title')
{
$plugin->$name = $value;
$plugin->save();
}
return false;
}
/**
* Get setting for a plugin.
*
* @param string $name The name.
* @param string $plugin_name Optional plugin name, if not specified then it is detected from where you are calling from.
*/
function get_plugin_setting($name, $plugin_name = "")
{
$plugin = find_plugin_settings($plugin_name);
if ($plugin)
return $plugin->$name;
return false;
}
/**
* Clear a plugin setting.
*
* @param string $name The name.
* @param string $plugin_name Optional plugin name, if not specified then it is detected from where you are calling from.
*/
function clear_plugin_setting($name, $plugin_name = "")
{
$plugin = find_plugin_settings($plugin_name);
if ($plugin)
return $plugin->clearMetaData($name);
return false;
}
/**
* Run once and only once.
*/
function plugin_run_once()
{
// Register a class
add_subtype("object", "plugin", "ElggPlugin");
}
/**
* Initialise the file modules.
* Listens to system boot and registers any appropriate file types and classes
*/
function plugin_init()
{
// Now run this stuff, but only once
run_function_once("plugin_run_once");
}
// Register a startup event
register_elgg_event_handler('init','system','plugin_init');
?>
|
