summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--inc/plugincontroller.class.php164
-rw-r--r--inc/pluginutils.php154
2 files changed, 165 insertions, 153 deletions
diff --git a/inc/plugincontroller.class.php b/inc/plugincontroller.class.php
new file mode 100644
index 000000000..98f57f3a3
--- /dev/null
+++ b/inc/plugincontroller.class.php
@@ -0,0 +1,164 @@
+<?php
+/**
+ * Class to encapsulate access to dokuwiki plugins
+ *
+ * @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
+ * @author Christopher Smith <chris@jalakai.co.uk>
+ */
+
+// plugin related constants
+if(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
+
+class Doku_Plugin_Controller {
+
+ var $list_enabled = array();
+ var $list_disabled = array();
+ var $list_bytype = array();
+
+ function Doku_Plugin_Controller() {
+ $this->_populateMasterList();
+ }
+
+ /**
+ * Returns a list of available plugins of given type
+ *
+ * @param $type string, plugin_type name;
+ * the type of plugin to return,
+ * use empty string for all types
+ * @param $all bool;
+ * false to only return enabled plugins,
+ * true to return both enabled and disabled plugins
+ *
+ * @return array of plugin names
+ *
+ * @author Andreas Gohr <andi@splitbrain.org>
+ */
+ function getList($type='',$all=false){
+
+ // request the complete list
+ if (!$type) {
+ return $all ? array_merge($this->list_enabled,$this->list_disabled) : $this->list_enabled;
+ }
+
+ if (!isset($this->list_bytype[$type]['enabled'])) {
+ $this->list_bytype[$type]['enabled'] = $this->_getListByType($type,true);
+ }
+ if ($all && !isset($this->list_bytype[$type]['disabled'])) {
+ $this->list_bytype[$type]['disabled'] = $this->_getListByType($type,false);
+ }
+
+ return $all ? array_merge($this->list_bytype[$type]['enabled'],$this->list_bytype[$type]['disabled']) : $this->list_bytype[$type]['enabled'];
+ }
+
+ /**
+ * Loads the given plugin and creates an object of it
+ *
+ * @author Andreas Gohr <andi@splitbrain.org>
+ *
+ * @param $type string type of plugin to load
+ * @param $name string name of the plugin to load
+ * @param $new bool true to return a new instance of the plugin, false to use an already loaded instance
+ * @return objectreference the plugin object or null on failure
+ */
+ function &load($type,$name,$new=false){
+ //we keep all loaded plugins available in global scope for reuse
+ global $DOKU_PLUGINS;
+
+ //plugin already loaded?
+ if(!empty($DOKU_PLUGINS[$type][$name])){
+ if ($new) {
+ $class = $type.'_plugin_'.$name;
+ return class_exists($class) ? new $class : null;
+ } else {
+ return $DOKU_PLUGINS[$type][$name];
+ }
+ }
+
+ //try to load the wanted plugin file
+ list($plugin,$component) = $this->_splitName($name);
+ $dir = !$this->isdisabled($plugin) ? $plugin : $plugin.'.disabled';
+ $file = $component ? "$type/$component.php" : "$type.php";
+
+ if (!include_once(DOKU_PLUGIN."$dir/$file")) {
+ return null;
+ }
+
+ //construct class and instantiate
+ $class = $type.'_plugin_'.$name;
+ if (!class_exists($class)) return null;
+
+ $DOKU_PLUGINS[$type][$name] = new $class;
+ return $DOKU_PLUGINS[$type][$name];
+ }
+
+ function isdisabled($plugin) {
+ return (array_search($plugin, $this->list_enabled) === false);
+ }
+
+ function enable($plugin) {
+ if (array_search($plugin, $this->list_disabled) !== false) {
+ return @rename(DOKU_PLUGIN.$plugin.'.disabled',DOKU_PLUGIN.$plugin);
+ }
+ return false;
+ }
+
+ function disable($plugin) {
+ if (array_search($plugin, $this->list_enabled) !== false) {
+ return @rename(DOKU_PLUGIN.$plugin,DOKU_PLUGIN.$plugin.'.disabled');
+ }
+ return false;
+ }
+
+ function get_directory($plugin) {
+ return $this->isdisabled($plugin) ? $plugin.'.disabled' : $plugin;
+ }
+
+ function _populateMasterList() {
+ if ($dh = opendir(DOKU_PLUGIN)) {
+ while (false !== ($plugin = readdir($dh))) {
+ if ($plugin == '.' || $plugin == '..' || $plugin == 'tmp') continue;
+ if (is_file(DOKU_PLUGIN.$plugin)) continue;
+
+ if (substr($plugin,-9) == '.disabled') {
+ $this->list_disabled[] = substr($plugin,0,-9);
+ } else {
+ $this->list_enabled[] = $plugin;
+ }
+ }
+ }
+ }
+
+ function _getListByType($type, $enabled) {
+ $master_list = $enabled ? $this->list_enabled : $this->list_disabled;
+
+ $plugins = array();
+ foreach ($master_list as $plugin) {
+ $dir = $enabled ? $plugin : $plugin.'.disabled';
+
+ if (@file_exists(DOKU_PLUGIN."$dir/$type.php")){
+ $plugins[] = $plugin;
+ } else {
+ if ($dp = @opendir(DOKU_PLUGIN."$dir/$type/")) {
+ while (false !== ($component = readdir($dp))) {
+ if (substr($component,0,1) == '.' || strtolower(substr($component, -4)) != ".php") continue;
+ if (is_file(DOKU_PLUGIN."$dir/$type/$component")) {
+ $plugins[] = $plugin.'_'.substr($component, 0, -4);
+ }
+ }
+ closedir($dp);
+ }
+ }
+ }
+
+ return $plugins;
+ }
+
+ function _splitName($name) {
+ if (array_search($name, $this->list_enabled + $this->list_disabled) === false) {
+ return explode('_',$name,2);
+ }
+
+ return array($name,'');
+ }
+
+}
diff --git a/inc/pluginutils.php b/inc/pluginutils.php
index 61a2939d3..db152195d 100644
--- a/inc/pluginutils.php
+++ b/inc/pluginutils.php
@@ -8,6 +8,7 @@
// plugin related constants
if(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
+require_once(DOKU_INC.'inc/plugincontroller.class.php');
$plugin_types = array('admin','syntax','action','renderer', 'helper');
@@ -26,156 +27,3 @@ function plugin_enable($plugin) { global $plugin_controller; return $plugin_cont
function plugin_disable($plugin) { global $plugin_controller; return $plugin_controller->disable($plugin); }
function plugin_directory($plugin) { global $plugin_controller; return $plugin_controller->get_directory($plugin); }
-class Doku_Plugin_Controller {
-
- var $list_enabled = array();
- var $list_disabled = array();
- var $list_bytype = array();
-
- function Doku_Plugin_Controller() {
- $this->_populateMasterList();
- }
-
- /**
- * Returns a list of available plugins of given type
- *
- * @param $type string, plugin_type name;
- * the type of plugin to return,
- * use empty string for all types
- * @param $all bool;
- * false to only return enabled plugins,
- * true to return both enabled and disabled plugins
- *
- * @return array of plugin names
- *
- * @author Andreas Gohr <andi@splitbrain.org>
- */
- function getList($type='',$all=false){
-
- // request the complete list
- if (!$type) {
- return $all ? array_merge($this->list_enabled,$this->list_disabled) : $this->list_enabled;
- }
-
- if (!isset($this->list_bytype[$type]['enabled'])) {
- $this->list_bytype[$type]['enabled'] = $this->_getListByType($type,true);
- }
- if ($all && !isset($this->list_bytype[$type]['disabled'])) {
- $this->list_bytype[$type]['disabled'] = $this->_getListByType($type,false);
- }
-
- return $all ? array_merge($this->list_bytype[$type]['enabled'],$this->list_bytype[$type]['disabled']) : $this->list_bytype[$type]['enabled'];
- }
-
- /**
- * Loads the given plugin and creates an object of it
- *
- * @author Andreas Gohr <andi@splitbrain.org>
- *
- * @param $type string type of plugin to load
- * @param $name string name of the plugin to load
- * @param $new bool true to return a new instance of the plugin, false to use an already loaded instance
- * @return objectreference the plugin object or null on failure
- */
- function &load($type,$name,$new=false){
- //we keep all loaded plugins available in global scope for reuse
- global $DOKU_PLUGINS;
-
- //plugin already loaded?
- if(!empty($DOKU_PLUGINS[$type][$name])){
- if ($new) {
- $class = $type.'_plugin_'.$name;
- return class_exists($class) ? new $class : null;
- } else {
- return $DOKU_PLUGINS[$type][$name];
- }
- }
-
- //try to load the wanted plugin file
- list($plugin,$component) = $this->_splitName($name);
- $dir = !$this->isdisabled($plugin) ? $plugin : $plugin.'.disabled';
- $file = $component ? "$type/$component.php" : "$type.php";
-
- if (!include_once(DOKU_PLUGIN."$dir/$file")) {
- return null;
- }
-
- //construct class and instantiate
- $class = $type.'_plugin_'.$name;
- if (!class_exists($class)) return null;
-
- $DOKU_PLUGINS[$type][$name] = new $class;
- return $DOKU_PLUGINS[$type][$name];
- }
-
- function isdisabled($plugin) {
- return (array_search($plugin, $this->list_enabled) === false);
- }
-
- function enable($plugin) {
- if (array_search($plugin, $this->list_disabled) !== false) {
- return @rename(DOKU_PLUGIN.$plugin.'.disabled',DOKU_PLUGIN.$plugin);
- }
- return false;
- }
-
- function disable($plugin) {
- if (array_search($plugin, $this->list_enabled) !== false) {
- return @rename(DOKU_PLUGIN.$plugin,DOKU_PLUGIN.$plugin.'.disabled');
- }
- return false;
- }
-
- function get_directory($plugin) {
- return $this->isdisabled($plugin) ? $plugin.'.disabled' : $plugin;
- }
-
- function _populateMasterList() {
- if ($dh = opendir(DOKU_PLUGIN)) {
- while (false !== ($plugin = readdir($dh))) {
- if ($plugin == '.' || $plugin == '..' || $plugin == 'tmp') continue;
- if (is_file(DOKU_PLUGIN.$plugin)) continue;
-
- if (substr($plugin,-9) == '.disabled') {
- $this->list_disabled[] = substr($plugin,0,-9);
- } else {
- $this->list_enabled[] = $plugin;
- }
- }
- }
- }
-
- function _getListByType($type, $enabled) {
- $master_list = $enabled ? $this->list_enabled : $this->list_disabled;
-
- $plugins = array();
- foreach ($master_list as $plugin) {
- $dir = $enabled ? $plugin : $plugin.'.disabled';
-
- if (@file_exists(DOKU_PLUGIN."$dir/$type.php")){
- $plugins[] = $plugin;
- } else {
- if ($dp = @opendir(DOKU_PLUGIN."$dir/$type/")) {
- while (false !== ($component = readdir($dp))) {
- if (substr($component,0,1) == '.' || strtolower(substr($component, -4)) != ".php") continue;
- if (is_file(DOKU_PLUGIN."$dir/$type/$component")) {
- $plugins[] = $plugin.'_'.substr($component, 0, -4);
- }
- }
- closedir($dp);
- }
- }
- }
-
- return $plugins;
- }
-
- function _splitName($name) {
- if (array_search($name, $this->list_enabled + $this->list_disabled) === false) {
- return explode('_',$name,2);
- }
-
- return array($name,'');
- }
-
-}
generated by cgit v1.2.3 (git 2.25.1) at 2025-05-10 11:22:58 +0000