pluginutil.inc.php
17.7 KB
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
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
<?php
/**
* $Id$
*
* KnowledgeTree Open Source Edition
* Document Management Made Simple
* Copyright (C) 2004 - 2007 The Jam Warehouse Software (Pty) Limited
*
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License version 3 as published by the
* Free Software Foundation.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* You can contact The Jam Warehouse Software (Pty) Limited, Unit 1, Tramber Place,
* Blake Street, Observatory, 7925 South Africa. or email info@knowledgetree.com.
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU General Public License version 3.
*
* In accordance with Section 7(b) of the GNU General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "Powered by
* KnowledgeTree" logo and retain the original copyright notice. If the display of the
* logo is not reasonably feasible for technical reasons, the Appropriate Legal Notices
* must display the words "Powered by KnowledgeTree" and retain the original
* copyright notice.
* Contributor( s): ______________________________________
*
*/
require_once(KT_LIB_DIR . '/plugins/pluginentity.inc.php');
require_once(KT_LIB_DIR . '/plugins/pluginregistry.inc.php');
class KTPluginResourceRegistry {
var $aResources = array();
function &getSingleton() {
if (!KTUtil::arrayGet($GLOBALS, 'oKTPluginResourceRegistry')) {
$GLOBALS['oKTPluginResourceRegistry'] = new KTPluginResourceRegistry;
}
return $GLOBALS['oKTPluginResourceRegistry'];
}
function registerResource($sPath) {
$this->aResources[$sPath] = true;
}
function isRegistered($sPath) {
if (KTUtil::arrayGet($this->aResources, $sPath)) {
return true;
}
$sPath = dirname($sPath);
if (KTUtil::arrayGet($this->aResources, $sPath)) {
return true;
}
return false;
}
}
class KTPluginUtil {
const CACHE_FILENAME = 'kt_plugins.cache';
/**
* Store the plugin cache in the cache directory.
* @deprecated
*/
static function savePluginCache($array)
{
$config = KTConfig::getSingleton();
$cachePlugins = $config->get('cache/cachePlugins', false);
if (!$cachePlugins)
{
return false;
}
$cacheDir = $config->get('cache/cacheDirectory');
$written = file_put_contents($cacheDir . '/' . KTPluginUtil::CACHE_FILENAME , serialize($array));
if (!$written)
{
global $default;
$default->log->warn('savePluginCache - The cache did not write anything.');
// try unlink a zero size file - just in case
@unlink($cacheFile);
}
}
/**
* Remove the plugin cache.
* @deprecated
*/
static function removePluginCache()
{
$config = KTConfig::getSingleton();
$cachePlugins = $config->get('cache/cachePlugins', false);
if (!$cachePlugins)
{
return false;
}
$cacheDir = $config->get('cache/cacheDirectory');
$cacheFile=$cacheDir . '/' . KTPluginUtil::CACHE_FILENAME;
@unlink($cacheFile);
}
/**
* Reads the plugin cache file. This must still be unserialised.
* @deprecated
* @return mixed Returns false on failure, or the serialised cache.
*/
static function readPluginCache()
{
$config = KTConfig::getSingleton();
$cachePlugins = $config->get('cache/cachePlugins', false);
if (!$cachePlugins)
{
return false;
}
$cacheDir = $config->get('cache/cacheDirectory');
$cacheFile=$cacheDir . '/' . KTPluginUtil::CACHE_FILENAME;
if (!is_file($cacheFile))
{
return false;
}
$cache = file_get_contents($cacheFile);
// we check for an empty cache in case there was a problem. We rather try and reload everything otherwise.
if (strlen($cache) == 0)
{
return false;
}
if (!class_exists('KTPluginEntityProxy')) {
KTEntityUtil::_proxyCreate('KTPluginEntity', 'KTPluginEntityProxy');
}
return unserialize($cache);
}
/**
* Load the plugins for the current page
*
* @param unknown_type $sType
*/
static function loadPlugins ($sType) {
// Check the current page - can be extended.
// Currently we only distinguish between the dashboard and everything else.
if($sType != 'dashboard'){
$sType = 'general';
}
$GLOBALS['_KT_PLUGIN'] = array();
$aPlugins = array();
$aPluginHelpers = array();
$aDisabled = array();
// Get the list of enabled plugins
$query = "SELECT h.classname, h.pathname, h.plugin FROM plugin_helper h
INNER JOIN plugins p ON (p.namespace = h.plugin)
WHERE p.disabled = 0 AND h.classtype='plugin' ORDER BY p.orderby";
$aPluginHelpers = DBUtil::getResultArray($query);
// Check that there are plugins and if not, register them
if (empty($aPluginHelpers)) {
KTPluginUtil::registerPlugins();
$query = "SELECT h.classname, h.pathname, h.plugin FROM plugin_helper h
INNER JOIN plugins p ON (p.namespace = h.plugin)
WHERE p.disabled = 0 AND h.viewtype='{$sType}' AND h.classtype='plugin' ORDER BY p.orderby";
$aPluginHelpers = DBUtil::getResultArray($query);
}
// Create plugin objects
foreach ($aPluginHelpers as $aItem){
$classname = $aItem['classname'];
$path = $aItem['pathname'];
if (!empty($path)) {
require_once($path);
}
$oPlugin = new $classname($path);
if($oPlugin->load()){
$aPlugins[] = $oPlugin;
}else{
$aDisabled[] = "'{$aItem['plugin']}'";
}
}
$sDisabled = implode(',', $aDisabled);
// load plugin helpers into global space
$query = 'SELECT h.* FROM plugin_helper h
INNER JOIN plugins p ON (p.namespace = h.plugin)
WHERE p.disabled = 0 ORDER BY p.orderby';//WHERE viewtype='{$sType}'";
if(!empty($sDisabled)){
$query .= " AND h.plugin NOT IN ($sDisabled)";
}
$aPluginList = DBUtil::getResultArray($query);
KTPluginUtil::load($aPluginList);
// Load the template locations
$query = "SELECT * FROM plugin_helper h WHERE h.classtype='locations'";
$aLocations = DBUtil::getResultArray($query);
if(!empty($aLocations)){
$oTemplating =& KTTemplating::getSingleton();
foreach ($aLocations as $location){
$aParams = explode('|', $location['object']);
call_user_func_array(array(&$oTemplating, 'addLocation2'), $aParams);
}
}
return true;
}
/**
* Load the plugins into the global space
*
* @param array $aPlugins
*/
function load($aPlugins) {
require_once(KT_LIB_DIR . '/actions/actionregistry.inc.php');
require_once(KT_LIB_DIR . '/actions/portletregistry.inc.php');
require_once(KT_LIB_DIR . '/triggers/triggerregistry.inc.php');
require_once(KT_LIB_DIR . '/plugins/pageregistry.inc.php');
require_once(KT_LIB_DIR . '/authentication/authenticationproviderregistry.inc.php');
require_once(KT_LIB_DIR . "/plugins/KTAdminNavigation.php");
require_once(KT_LIB_DIR . "/dashboard/dashletregistry.inc.php");
require_once(KT_LIB_DIR . "/i18n/i18nregistry.inc.php");
require_once(KT_LIB_DIR . "/help/help.inc.php");
require_once(KT_LIB_DIR . "/workflow/workflowutil.inc.php");
require_once(KT_LIB_DIR . "/widgets/widgetfactory.inc.php");
require_once(KT_LIB_DIR . "/validation/validatorfactory.inc.php");
require_once(KT_LIB_DIR . "/browse/columnregistry.inc.php");
require_once(KT_LIB_DIR . "/browse/criteriaregistry.php");
require_once(KT_LIB_DIR . "/authentication/interceptorregistry.inc.php");
$oPRegistry =& KTPortletRegistry::getSingleton();
$oTRegistry =& KTTriggerRegistry::getSingleton();
$oARegistry =& KTActionRegistry::getSingleton();
$oPageRegistry =& KTPageRegistry::getSingleton();
$oAPRegistry =& KTAuthenticationProviderRegistry::getSingleton();
$oAdminRegistry =& KTAdminNavigationRegistry::getSingleton();
$oDashletRegistry =& KTDashletRegistry::getSingleton();
$oi18nRegistry =& KTi18nRegistry::getSingleton();
$oKTHelpRegistry =& KTHelpRegistry::getSingleton();
$oWFTriggerRegistry =& KTWorkflowTriggerRegistry::getSingleton();
$oColumnRegistry =& KTColumnRegistry::getSingleton();
$oNotificationHandlerRegistry =& KTNotificationRegistry::getSingleton();
$oTemplating =& KTTemplating::getSingleton();
$oWidgetFactory =& KTWidgetFactory::getSingleton();
$oValidatorFactory =& KTValidatorFactory::getSingleton();
$oCriteriaRegistry =& KTCriteriaRegistry::getSingleton();
$oInterceptorRegistry =& KTInterceptorRegistry::getSingleton();
$oKTPluginRegistry =& KTPluginRegistry::getSingleton();
// Loop through the loaded plugins and register them for access
foreach ($aPlugins as $plugin){
$sName = $plugin['namespace'];
$sParams = $plugin['object'];
$aParams = explode('|', $sParams);
$sClassType = $plugin['classtype'];
switch ($sClassType) {
case 'portlet':
$aLocation = unserialize($aParams[0]);
if($aLocation != false){
$aParams[0] = $aLocation;
}
call_user_func_array(array(&$oPRegistry, 'registerPortlet'), $aParams);
break;
case 'trigger':
call_user_func_array(array(&$oTRegistry, 'registerTrigger'), $aParams);
break;
case 'action':
call_user_func_array(array(&$oARegistry, 'registerAction'), $aParams);
break;
case 'page':
call_user_func_array(array(&$oPageRegistry, 'registerPage'), $aParams);
break;
case 'authentication_provider':
call_user_func_array(array(&$oAPRegistry, 'registerAuthenticationProvider'), $aParams);
break;
case 'admin_category':
call_user_func_array(array(&$oAdminRegistry, 'registerCategory'), $aParams);
break;
case 'admin_page':
call_user_func_array(array(&$oAdminRegistry, 'registerLocation'), $aParams);
break;
case 'dashlet':
call_user_func_array(array(&$oDashletRegistry, 'registerDashlet'), $aParams);
break;
case 'i18n':
call_user_func_array(array(&$oi18nRegistry, 'registeri18n'), $aParams);
break;
case 'i18nlang':
call_user_func_array(array(&$oi18nRegistry, 'registeri18nLang'), $aParams);
break;
case 'language':
call_user_func_array(array(&$oi18nRegistry, 'registerLanguage'), $aParams);
break;
case 'help_language':
call_user_func_array(array(&$oKTHelpRegistry, 'registerHelp'), $aParams);
break;
case 'workflow_trigger':
call_user_func_array(array(&$oWFTriggerRegistry, 'registerWorkflowTrigger'), $aParams);
break;
case 'column':
call_user_func_array(array(&$oColumnRegistry, 'registerColumn'), $aParams);
break;
case 'view':
call_user_func_array(array(&$oColumnRegistry, 'registerView'), $aParams);
break;
case 'notification_handler':
call_user_func_array(array(&$oNotificationHandlerRegistry, 'registerNotificationHandler'), $aParams);
break;
case 'template_location':
call_user_func_array(array(&$oTemplating, 'addLocation'), $aParams);
break;
case 'criterion':
$aInit = unserialize($aParams[3]);
if($aInit != false){
$aParams[3] = $aInit;
}
call_user_func_array(array(&$oCriteriaRegistry, 'registerCriterion'), $aParams);
break;
case 'widget':
call_user_func_array(array(&$oWidgetFactory, 'registerWidget'), $aParams);
break;
case 'validator':
call_user_func_array(array(&$oValidatorFactory, 'registerValidator'), $aParams);
break;
case 'interceptor':
call_user_func_array(array(&$oInterceptorRegistry, 'registerInterceptor'), $aParams);
break;
case 'plugin':
$oKTPluginRegistry->_aPluginDetails[$sName] = $aParams;
break;
}
}
}
/**
* This loads the plugins in the plugins folder. It searches for files ending with 'Plugin.php'.
* This is called by the 'Re-read plugins' action in the web interface.
*/
function registerPlugins () {
KTPluginUtil::_deleteSmartyFiles();
require_once(KT_LIB_DIR . '/cache/cache.inc.php');
$oCache =& KTCache::getSingleton();
$oCache->deleteAllCaches();
$files = array();
KTPluginUtil::_walk(KT_DIR . '/plugins', $files);
foreach ($files as $sFile) {
$plugin_ending = "Plugin.php";
if (substr($sFile, -strlen($plugin_ending)) === $plugin_ending) {
require_once($sFile);
}
}
$oRegistry =& KTPluginRegistry::getSingleton();
foreach ($oRegistry->getPlugins() as $oPlugin) {
$res = $oPlugin->register();
if (PEAR::isError($res)) {
var_dump($res);
}
}
foreach (KTPluginEntity::getList() as $oPluginEntity) {
$sPath = $oPluginEntity->getPath();
if (!KTUtil::isAbsolutePath($sPath)) {
$sPath = sprintf("%s/%s", KT_DIR, $sPath);
}
if (!file_exists($sPath)) {
$oPluginEntity->setUnavailable(true);
$oPluginEntity->setDisabled(true);
$res = $oPluginEntity->update();
}
}
KTPluginEntity::clearAllCaches();
KTPluginUtil::_deleteSmartyFiles();
require_once(KT_LIB_DIR . '/cache/cache.inc.php');
$oCache =& KTCache::getSingleton();
$oCache->deleteAllCaches();
//KTPluginUtil::removePluginCache();
}
function _deleteSmartyFiles() {
$oConfig =& KTConfig::getSingleton();
$dir = sprintf('%s/%s', $oConfig->get('urls/varDirectory'), 'tmp');
$dh = @opendir($dir);
if (empty($dh)) {
return;
}
$aFiles = array();
while (false !== ($sFilename = readdir($dh))) {
if (substr($sFilename, -10) == "smarty.inc") {
$aFiles[] = sprintf('%s/%s', $dir, $sFilename);
}
if (substr($sFilename, -10) == "smarty.php") {
$aFiles[] = sprintf('%s/%s', $dir, $sFilename);
}
}
foreach ($aFiles as $sFile) {
@unlink($sFile);
}
}
function _walk ($path, &$files) {
if (!is_dir($path)) {
return;
}
$dirh = opendir($path);
while (($entry = readdir($dirh)) !== false) {
if (in_array($entry, array('.', '..'))) {
continue;
}
$newpath = $path . '/' . $entry;
if (is_dir($newpath)) {
KTPluginUtil::_walk($newpath, $files);
}
if (!is_file($newpath)) {
continue;
}
$files[] = $newpath;
}
}
function resourceIsRegistered($path) {
$oRegistry =& KTPluginResourceRegistry::getSingleton();
return $oRegistry->isRegistered($path);
}
function registerResource($path) {
$oRegistry =& KTPluginResourceRegistry::getSingleton();
$oRegistry->registerResource($path);
}
function readResource($sPath) {
global $default;
$php_file = ".php";
if (substr($sPath, -strlen($php_file)) === $php_file) {
require_once($php_file);
} else {
$pi = pathinfo($sPath);
$mime_type = "";
$sExtension = KTUtil::arrayGet($pi, 'extension');
if (!empty($sExtension)) {
$mime_type = DBUtil::getOneResultKey(array("SELECT mimetypes FROM " . $default->mimetypes_table . " WHERE LOWER(filetypes) = ?", $sExtension), "mimetypes");
}
if (empty($mime_type)) {
$mime_type = "application/octet-stream";
}
$sFullPath = KT_DIR . '/plugins' . $sPath;
header("Content-Type: $mime_type");
header("Content-Length: " . filesize($sFullPath));
readfile($sFullPath);
}
}
// utility function to detect if the plugin is loaded and active.
static function pluginIsActive($sNamespace) {
$oReg =& KTPluginRegistry::getSingleton();
$plugin = $oReg->getPlugin($sNamespace);
if (is_null($plugin) || PEAR::isError($plugin)) { return false; } // no such plugin
else { // check if its active
$ent = KTPluginEntity::getByNamespace($sNamespace);
if (PEAR::isError($ent)) { return false; }
// we now can ask
return (!$ent->getDisabled());
}
}
}
?>