Skip to content
Snippets Groups Projects
Commit 39bceb98 authored by Andreas Gohr's avatar Andreas Gohr
Browse files

Change plugin functionality into a trait 

This allows for using the functionality in class hierarchies that can
not inherit from DokuWiki_Plugin.
parent cbeaa4a0
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
inc/Plugin.php 0 → 100644
+ 11
− 0
View file @ 39bceb98
<?php
/**
* DokuWiki Plugin
*
* Most of DokuWiki's plugin types simply inherit from this. All it does is
* add the DokuWiki_PluginTrait to the class.
*/
class DokuWiki_Plugin implements DokuWiki_PluginInterface {
use DokuWiki_PluginTrait;
}
inc/PluginInterface.php 0 → 100644
+ 158
− 0
View file @ 39bceb98
<?php
/**
* DokuWiki Plugin Interface
*
* Defines the public contract all DokuWiki plugins will adhere to. The actual code
* to do so is defined in DokuWiki_PluginTrait
*
* @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
* @author Christopher Smith <chris@jalakai.co.uk>
*/
interface DokuWiki_PluginInterface {
/**
* General Info
*
* Needs to return a associative array with the following values:
*
* base - the plugin's base name (eg. the directory it needs to be installed in)
* author - Author of the plugin
* email - Email address to contact the author
* date - Last modified date of the plugin in YYYY-MM-DD format
* name - Name of the plugin
* desc - Short description of the plugin (Text only)
* url - Website with more information on the plugin (eg. syntax description)
*/
public function getInfo();
/**
* The type of the plugin inferred from the class name
*
* @return string plugin type
*/
public function getPluginType();
/**
* The name of the plugin inferred from the class name
*
* @return string plugin name
*/
public function getPluginName();
/**
* The component part of the plugin inferred from the class name
*
* @return string component name
*/
public function getPluginComponent();
/**
* Access plugin language strings
*
* to try to minimise unnecessary loading of the strings when the plugin doesn't require them
* e.g. when info plugin is querying plugins for information about themselves.
*
* @param string $id id of the string to be retrieved
* @return string in appropriate language or english if not available
*/
public function getLang($id);
/**
* retrieve a language dependent file and pass to xhtml renderer for display
* plugin equivalent of p_locale_xhtml()
*
* @param string $id id of language dependent wiki page
* @return string parsed contents of the wiki page in xhtml format
*/
public function locale_xhtml($id);
/**
* Prepends appropriate path for a language dependent filename
* plugin equivalent of localFN()
*
* @param string $id id of localization file
* @param string $ext The file extension (usually txt)
* @return string wiki text
*/
public function localFN($id, $ext = 'txt');
/**
* Reads all the plugins language dependent strings into $this->lang
* this function is automatically called by getLang()
*
* @todo this could be made protected and be moved to the trait only
*/
public function setupLocale();
/**
* use this function to access plugin configuration variables
*
* @param string $setting the setting to access
* @param mixed $notset what to return if the setting is not available
* @return mixed
*/
public function getConf($setting, $notset = false);
/**
* merges the plugin's default settings with any local settings
* this function is automatically called through getConf()
*
* @todo this could be made protected and be moved to the trait only
*/
public function loadConfig();
/**
* Loads a given helper plugin (if enabled)
*
* @author Esther Brunner <wikidesign@gmail.com>
*
* @param string $name name of plugin to load
* @param bool $msg if a message should be displayed in case the plugin is not available
* @return DokuWiki_PluginInterface|null helper plugin object
*/
public function loadHelper($name, $msg = true);
/**
* email
* standardised function to generate an email link according to obfuscation settings
*
* @param string $email
* @param string $name
* @param string $class
* @param string $more
* @return string html
*/
public function email($email, $name = '', $class = '', $more = '');
/**
* external_link
* standardised function to generate an external link according to conf settings
*
* @param string $link
* @param string $title
* @param string $class
* @param string $target
* @param string $more
* @return string
*/
public function external_link($link, $title = '', $class = '', $target = '', $more = '');
/**
* output text string through the parser, allows dokuwiki markup to be used
* very ineffecient for small pieces of data - try not to use
*
* @param string $text wiki markup to parse
* @param string $format output format
* @return null|string
*/
public function render_text($text, $format = 'xhtml');
/**
* Allow the plugin to prevent DokuWiki from reusing an instance
*
* @return bool false if the plugin has to be instantiated
*/
public function isSingleton();
}
inc/plugin.php → inc/PluginTrait.php
+ 238
− 0
View file @ 39bceb98
<?php
/**
* DokuWiki Plugin base class
*
* @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
* @author Christopher Smith <chris@jalakai.co.uk>
*/
/**
* Do not inherit directly from this class, instead inherit from the specialized
* ones in lib/plugin
*/
class DokuWiki_Plugin {
trait DokuWiki_PluginTrait {
protected $localised = false; // set to true by setupLocale() after loading language dependent strings
protected $lang = array(); // array to hold language dependent strings, best accessed via ->getLang()
......@@ -18,19 +12,9 @@ class DokuWiki_Plugin {
protected $conf = array(); // array to hold plugin settings, best accessed via ->getConf()
/**
* General Info
*
* Needs to return a associative array with the following values:
*
* base - the plugin's base name (eg. the directory it needs to be installed in)
* author - Author of the plugin
* email - Email address to contact the author
* date - Last modified date of the plugin in YYYY-MM-DD format
* name - Name of the plugin
* desc - Short description of the plugin (Text only)
* url - Website with more information on the plugin (eg. syntax description)
* @see DokuWiki_PluginInterface::getInfo()
*/
public function getInfo(){
public function getInfo() {
$parts = explode('_', get_class($this));
$info = DOKU_PLUGIN . '/' . $parts[2] . '/plugin.info.txt';
if(file_exists($info)) return confToHash($info);
......@@ -46,10 +30,26 @@ class DokuWiki_Plugin {
);
}
// plugin introspection methods
// extract from class name, format = <plugin type>_plugin_<name>[_<component name>]
/**
* @return string plugin type
* @see DokuWiki_PluginInterface::isSingleton()
*/
public function isSingleton() {
return true;
}
/**
* @see DokuWiki_PluginInterface::loadHelper()
*/
public function loadHelper($name, $msg = true) {
$obj = plugin_load('helper', $name);
if(is_null($obj) && $msg) msg("Helper plugin $name is not available or invalid.", -1);
return $obj;
}
// region introspection methods
/**
* @see DokuWiki_PluginInterface::getPluginType()
*/
public function getPluginType() {
list($t) = explode('_', get_class($this), 2);
......@@ -57,7 +57,7 @@ class DokuWiki_Plugin {
}
/**
* @return string plugin name
* @see DokuWiki_PluginInterface::getPluginName()
*/
public function getPluginName() {
list(/* $t */, /* $p */, $n) = explode('_', get_class($this), 4);
......@@ -65,69 +65,53 @@ class DokuWiki_Plugin {
}
/**
* @return string component name
* @see DokuWiki_PluginInterface::getPluginComponent()
*/
public function getPluginComponent() {
list(/* $t */, /* $p */, /* $n */, $c) = explode('_', get_class($this), 4);
return (isset($c)?$c:'');
return (isset($c) ? $c : '');
}
// localisation methods
// endregion
// region localization methods
/**
* getLang($id)
* use this function to access plugin language strings
* to try to minimise unnecessary loading of the strings when the plugin doesn't require them
* e.g. when info plugin is querying plugins for information about themselves.
*
* @param string $id id of the string to be retrieved
* @return string string in appropriate language or english if not available
* @see DokuWiki_PluginInterface::getLang()
*/
public function getLang($id) {
if (!$this->localised) $this->setupLocale();
if(!$this->localised) $this->setupLocale();
return (isset($this->lang[$id]) ? $this->lang[$id] : '');
}
/**
* locale_xhtml($id)
*
* retrieve a language dependent file and pass to xhtml renderer for display
* plugin equivalent of p_locale_xhtml()
*
* @param string $id id of language dependent wiki page
* @return string parsed contents of the wiki page in xhtml format
* @see DokuWiki_PluginInterface::locale_xhtml()
*/
public function locale_xhtml($id) {
return p_cached_output($this->localFN($id));
}
/**
* Prepends appropriate path for a language dependent filename
* plugin equivalent of localFN()
*
* @param string $id id of localization file
* @param string $ext The file extension (usually txt)
* @return string wiki text
* @see DokuWiki_PluginInterface::localFN()
*/
public function localFN($id,$ext='txt') {
public function localFN($id, $ext = 'txt') {
global $conf;
$plugin = $this->getPluginName();
$file = DOKU_CONF.'plugin_lang/'.$plugin.'/'.$conf['lang'].'/'.$id.'.'.$ext;
if (!file_exists($file)){
$file = DOKU_PLUGIN.$plugin.'/lang/'.$conf['lang'].'/'.$id.'.'.$ext;
if(!file_exists($file)){
$file = DOKU_CONF . 'plugin_lang/' . $plugin . '/' . $conf['lang'] . '/' . $id . '.' . $ext;
if(!file_exists($file)) {
$file = DOKU_PLUGIN . $plugin . '/lang/' . $conf['lang'] . '/' . $id . '.' . $ext;
if(!file_exists($file)) {
//fall back to english
$file = DOKU_PLUGIN.$plugin.'/lang/en/'.$id.'.'.$ext;
$file = DOKU_PLUGIN . $plugin . '/lang/en/' . $id . '.' . $ext;
}
}
return $file;
}
/**
* Reads all the plugins language dependent strings into $this->lang
* this function is automatically called by getLang()
* @see DokuWiki_PluginInterface::setupLocale()
*/
function setupLocale() {
public function setupLocale() {
if($this->localised) return;
global $conf, $config_cascade; // definitely don't invoke "global $lang"
......@@ -156,40 +140,36 @@ class DokuWiki_Plugin {
$this->localised = true;
}
// configuration methods
// endregion
// region configuration methods
/**
* getConf($setting)
*
* use this function to access plugin configuration variables
*
* @param string $setting the setting to access
* @param mixed $notset what to return if the setting is not available
* @return mixed
* @see DokuWiki_PluginInterface::getConf()
*/
public function getConf($setting, $notset=false){
public function getConf($setting, $notset = false) {
if (!$this->configloaded){ $this->loadConfig(); }
if(!$this->configloaded) {
$this->loadConfig();
}
if(isset($this->conf[$setting])){
if(isset($this->conf[$setting])) {
return $this->conf[$setting];
}else{
} else {
return $notset;
}
}
/**
* loadConfig()
* merges the plugin's default settings with any local settings
* this function is automatically called through getConf()
* @see DokuWiki_PluginInterface::loadConfig()
*/
function loadConfig(){
public function loadConfig() {
global $conf;
$defaults = $this->readDefaultSettings();
$plugin = $this->getPluginName();
foreach ($defaults as $key => $value) {
if (isset($conf['plugin'][$plugin][$key])) continue;
foreach($defaults as $key => $value) {
if(isset($conf['plugin'][$plugin][$key])) continue;
$conf['plugin'][$plugin][$key] = $value;
}
......@@ -205,96 +185,54 @@ class DokuWiki_Plugin {
*/
protected function readDefaultSettings() {
$path = DOKU_PLUGIN.$this->getPluginName().'/conf/';
$path = DOKU_PLUGIN . $this->getPluginName() . '/conf/';
$conf = array();
if (file_exists($path.'default.php')) {
include($path.'default.php');
if(file_exists($path . 'default.php')) {
include($path . 'default.php');
}
return $conf;
}
/**
* Loads a given helper plugin (if enabled)
*
* @author Esther Brunner <wikidesign@gmail.com>
*
* @param string $name name of plugin to load
* @param bool $msg if a message should be displayed in case the plugin is not available
* @return DokuWiki_Plugin|null helper plugin object
*/
public function loadHelper($name, $msg = true){
$obj = plugin_load('helper',$name);
if (is_null($obj) && $msg) msg("Helper plugin $name is not available or invalid.",-1);
return $obj;
}
// standard functions for outputing email addresses and links
// use these to avoid having to duplicate code to produce links in line with the installation configuration
// endregion
// region output methods
/**
* email
* standardised function to generate an email link according to obfuscation settings
*
* @param string $email
* @param string $name
* @param string $class
* @param string $more
* @return string html
* @see DokuWiki_PluginInterface::email()
*/
public function email($email, $name='', $class='', $more='') {
if (!$email) return $name;
public function email($email, $name = '', $class = '', $more = '') {
if(!$email) return $name;
$email = obfuscate($email);
if (!$name) $name = $email;
$class = "class='".($class ? $class : 'mail')."'";
if(!$name) $name = $email;
$class = "class='" . ($class ? $class : 'mail') . "'";
return "<a href='mailto:$email' $class title='$email' $more>$name</a>";
}
/**
* external_link
* standardised function to generate an external link according to conf settings
*
* @param string $link
* @param string $title
* @param string $class
* @param string $target
* @param string $more
* @return string
* @see DokuWiki_PluginInterface::external_link()
*/
public function external_link($link, $title='', $class='', $target='', $more='') {
public function external_link($link, $title = '', $class = '', $target = '', $more = '') {
global $conf;
$link = htmlentities($link);
if (!$title) $title = $link;
if (!$target) $target = $conf['target']['extern'];
if ($conf['relnofollow']) $more .= ' rel="nofollow"';
if(!$title) $title = $link;
if(!$target) $target = $conf['target']['extern'];
if($conf['relnofollow']) $more .= ' rel="nofollow"';
if ($class) $class = " class='$class'";
if ($target) $target = " target='$target'";
if ($more) $more = " ".trim($more);
if($class) $class = " class='$class'";
if($target) $target = " target='$target'";
if($more) $more = " " . trim($more);
return "<a href='$link'$class$target$more>$title</a>";
}
/**
* output text string through the parser, allows dokuwiki markup to be used
* very ineffecient for small pieces of data - try not to use
*
* @param string $text wiki markup to parse
* @param string $format output format
* @return null|string
* @see DokuWiki_PluginInterface::render_text()
*/
public function render_text($text, $format='xhtml') {
return p_render($format, p_get_instructions($text),$info);
public function render_text($text, $format = 'xhtml') {
return p_render($format, p_get_instructions($text), $info);
}
/**
* Allow the plugin to prevent DokuWiki from reusing an instance
*
* @return bool false if the plugin has to be instantiated
*/
public function isSingleton() {
return true;
}
// endregion
}
inc/load.php
+ 7
− 2
View file @ 39bceb98
......@@ -15,7 +15,6 @@ require_once(DOKU_INC.'inc/changelog.php');
require_once(DOKU_INC.'inc/common.php');
require_once(DOKU_INC.'inc/confutils.php');
require_once(DOKU_INC.'inc/pluginutils.php');
require_once(DOKU_INC.'inc/plugin.php');
require_once(DOKU_INC.'inc/events.php');
require_once(DOKU_INC.'inc/form.php');
require_once(DOKU_INC.'inc/fulltext.php');
......@@ -85,11 +84,17 @@ function load_autoload($name){
'RemoteAPICore' => DOKU_INC.'inc/RemoteAPICore.php',
'Subscription' => DOKU_INC.'inc/subscription.php',
'DokuWiki_PluginInterface' => DOKU_INC.'inc/PluginInterface.php',
'DokuWiki_PluginTrait' => DOKU_INC.'inc/PluginTrait.php',
'DokuWiki_Plugin' => DOKU_INC.'inc/Plugin.php',
'DokuWiki_Action_Plugin' => DOKU_PLUGIN.'action.php',
'DokuWiki_Admin_Plugin' => DOKU_PLUGIN.'admin.php',
'DokuWiki_Syntax_Plugin' => DOKU_PLUGIN.'syntax.php',
'DokuWiki_Remote_Plugin' => DOKU_PLUGIN.'remote.php',
'DokuWiki_Auth_Plugin' => DOKU_PLUGIN.'auth.php',
'DokuWiki_CLI_Plugin' => DOKU_PLUGIN.'cli.php',
'Doku_Renderer' => DOKU_INC.'inc/parser/renderer.php',
'Doku_Renderer_xhtml' => DOKU_INC.'inc/parser/xhtml.php',
......@@ -141,7 +146,7 @@ function load_autoload($name){
}
// Plugin loading
if(preg_match('/^(auth|helper|syntax|action|admin|renderer|remote)_plugin_('.DOKU_PLUGIN_NAME_REGEX.')(?:_([^_]+))?$/',
if(preg_match('/^(auth|helper|syntax|action|admin|renderer|remote|cli)_plugin_('.DOKU_PLUGIN_NAME_REGEX.')(?:_([^_]+))?$/',
$name, $m)) {
// try to load the wanted plugin file
$c = ((count($m) === 4) ? "/{$m[3]}" : '');
......
inc/plugincontroller.class.php
+ 1
− 1
View file @ 39bceb98
......@@ -66,7 +66,7 @@ class Doku_Plugin_Controller {
* @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
* @param $disabled bool true to load even disabled plugins
* @return DokuWiki_Plugin|DokuWiki_Syntax_Plugin|DokuWiki_Auth_Plugin|DokuWiki_Admin_Plugin|DokuWiki_Action_Plugin|DokuWiki_Remote_Plugin|null the plugin object or null on failure
* @return DokuWiki_PluginInterface|null the plugin object or null on failure
*/
public function load($type,$name,$new=false,$disabled=false){
......
inc/pluginutils.php
+ 1
− 1
View file @ 39bceb98
......@@ -37,7 +37,7 @@ function plugin_list($type='',$all=false) {
* @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
* @param $disabled bool true to load even disabled plugins
* @return DokuWiki_Plugin|null the plugin object or null on failure
* @return DokuWiki_PluginInterface|null the plugin object or null on failure
*/
function plugin_load($type,$name,$new=false,$disabled=false) {
/** @var $plugin_controller Doku_Plugin_Controller */
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment