opensourcemirror
/
dokuwiki
mirror of https://github.com/splitbrain/dokuwiki.git
1
0
Fork 0
Code Issues Releases Wiki Activity

start of refactoring the config plugin 

split up all the files and added namespaces. everything broken
This commit is contained in:
Andreas Gohr 2018-05-11 16:31:39 +02:00
parent a390de906f
commit c6639e6a6a
31 changed files with 1817 additions and 1790 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
lib/plugins/config/_test/configuration.test.php
View File

@ -1,4 +1,7 @@
<?php
use dokuwiki\plugin\config\core\configuration;
/**
* @group plugin_config
* @group admin_plugins
@ -19,7 +22,7 @@ class plugin_config_configuration_test extends DokuWikiTest {
$this->config = dirname(__FILE__).'/data/config.php';
$this->meta = dirname(__FILE__).'/data/metadata.php';
require_once(dirname(__FILE__).'/../settings/config.class.php');
require_once(dirname(__FILE__).'/../settings/Configuration.php');
}
function test_readconfig() {

43
lib/plugins/config/admin.php
View File

@ -7,14 +7,7 @@
* @author Ben Coburn <btcoburn@silicodon.net>
*/
define('CM_KEYMARKER','____'); // used for settings with multiple dimensions of array indices
define('PLUGIN_SELF',dirname(__FILE__).'/');
define('PLUGIN_METADATA',PLUGIN_SELF.'settings/config.metadata.php');
if(!defined('DOKU_PLUGIN_IMAGES')) define('DOKU_PLUGIN_IMAGES',DOKU_BASE.'lib/plugins/config/images/');
require_once(PLUGIN_SELF.'settings/config.class.php'); // main configuration class and generic settings classes
require_once(PLUGIN_SELF.'settings/extra.class.php'); // settings classes specific to these settings
use dokuwiki\plugin\config\core\Configuration;
/**
* All DokuWiki plugins to extend the admin function
@ -22,7 +15,9 @@ require_once(PLUGIN_SELF.'settings/extra.class.php'); // settings classes spec
*/
class admin_plugin_config extends DokuWiki_Admin_Plugin {
protected $_file = PLUGIN_METADATA;
const METADATA = __DIR__ . 'settings/config.metadata.php';
const IMGDIR = DOKU_BASE.'lib/plugins/config/images/';
protected $_config = null;
protected $_input = null;
protected $_changed = false; // set to true if configuration has altered
@ -47,7 +42,7 @@ class admin_plugin_config extends DokuWiki_Admin_Plugin {
}
if(is_null($this->_config)) {
$this->_config = new configuration($this->_file);
$this->_config = new Configuration(self::METADATA);
}
// don't go any further if the configuration is locked
@ -89,7 +84,7 @@ class admin_plugin_config extends DokuWiki_Admin_Plugin {
global $lang;
global $ID;
if (is_null($this->_config)) { $this->_config = new configuration($this->_file); }
if (is_null($this->_config)) { $this->_config = new Configuration(self::METADATA); }
$this->setupLocale(true);
print $this->locale_xhtml('intro');
@ -133,10 +128,10 @@ class admin_plugin_config extends DokuWiki_Admin_Plugin {
} else {
$in_fieldset = true;
}
if ($first_plugin_fieldset && substr($setting->_key, 0, 10)=='plugin'.CM_KEYMARKER) {
if ($first_plugin_fieldset && substr($setting->_key, 0, 10)=='plugin'.Configuration::KEYMARKER) {
$this->_print_h1('plugin_settings', $this->getLang('_header_plugin'));
$first_plugin_fieldset = false;
} else if ($first_template_fieldset && substr($setting->_key, 0, 7)=='tpl'.CM_KEYMARKER) {
} else if ($first_template_fieldset && substr($setting->_key, 0, 7)=='tpl'.Configuration::KEYMARKER) {
$this->_print_h1('template_settings', $this->getLang('_header_template'));
$first_template_fieldset = false;
}
@ -155,7 +150,7 @@ class admin_plugin_config extends DokuWiki_Admin_Plugin {
? ' class="value error"'
: ' class="value"';
$icon = $setting->caution()
? '<img src="'.DOKU_PLUGIN_IMAGES.$setting->caution().'.png" '.
? '<img src="'.self::IMGDIR.$setting->caution().'.png" '.
'alt="'.$setting->caution().'" title="'.$this->getLang($setting->caution()).'" />'
: '';
@ -197,7 +192,7 @@ class admin_plugin_config extends DokuWiki_Admin_Plugin {
foreach($undefined_settings as $setting) {
if (
preg_match(
'/^(?:plugin|tpl)'.CM_KEYMARKER.'.*?'.CM_KEYMARKER.'(.*)$/',
'/^(?:plugin|tpl)'.Configuration::KEYMARKER.'.*?'.Configuration::KEYMARKER.'(.*)$/',
$setting->_key,
$undefined_setting_match
)
@ -299,13 +294,13 @@ class admin_plugin_config extends DokuWiki_Admin_Plugin {
@include(DOKU_PLUGIN.$plugin.$enlangfile);
if ($conf['lang'] != 'en') @include(DOKU_PLUGIN.$plugin.$langfile);
foreach ($lang as $key => $value){
$this->lang['plugin'.CM_KEYMARKER.$plugin.CM_KEYMARKER.$key] = $value;
$this->lang['plugin'.Configuration::KEYMARKER.$plugin.Configuration::KEYMARKER.$key] = $value;
}
}
// fill in the plugin name if missing (should exist for plugins with settings)
if (!isset($this->lang['plugin'.CM_KEYMARKER.$plugin.CM_KEYMARKER.'plugin_settings_name'])) {
$this->lang['plugin'.CM_KEYMARKER.$plugin.CM_KEYMARKER.'plugin_settings_name'] =
if (!isset($this->lang['plugin'.Configuration::KEYMARKER.$plugin.Configuration::KEYMARKER.'plugin_settings_name'])) {
$this->lang['plugin'.Configuration::KEYMARKER.$plugin.Configuration::KEYMARKER.'plugin_settings_name'] =
ucwords(str_replace('_', ' ', $plugin));
}
}
@ -320,13 +315,13 @@ class admin_plugin_config extends DokuWiki_Admin_Plugin {
@include(tpl_incdir().$enlangfile);
if ($conf['lang'] != 'en') @include(tpl_incdir().$langfile);
foreach ($lang as $key => $value){
$this->lang['tpl'.CM_KEYMARKER.$tpl.CM_KEYMARKER.$key] = $value;
$this->lang['tpl'.Configuration::KEYMARKER.$tpl.Configuration::KEYMARKER.$key] = $value;
}
}
// fill in the template name if missing (should exist for templates with settings)
if (!isset($this->lang['tpl'.CM_KEYMARKER.$tpl.CM_KEYMARKER.'template_settings_name'])) {
$this->lang['tpl'.CM_KEYMARKER.$tpl.CM_KEYMARKER.'template_settings_name'] =
if (!isset($this->lang['tpl'.Configuration::KEYMARKER.$tpl.Configuration::KEYMARKER.'template_settings_name'])) {
$this->lang['tpl'.Configuration::KEYMARKER.$tpl.Configuration::KEYMARKER.'template_settings_name'] =
ucwords(str_replace('_', ' ', $tpl));
}
@ -341,7 +336,7 @@ class admin_plugin_config extends DokuWiki_Admin_Plugin {
* @return array
*/
public function getTOC() {
if (is_null($this->_config)) { $this->_config = new configuration($this->_file); }
if (is_null($this->_config)) { $this->_config = new Configuration(self::METADATA); }
$this->setupLocale(true);
$allow_debug = $GLOBALS['conf']['allowdebug']; // avoid global $conf; here.
@ -351,9 +346,9 @@ class admin_plugin_config extends DokuWiki_Admin_Plugin {
$toc = array('conf'=>array(), 'plugin'=>array(), 'template'=>null);
foreach($this->_config->setting as $setting) {
if (is_a($setting, 'setting_fieldset')) {
if (substr($setting->_key, 0, 10)=='plugin'.CM_KEYMARKER) {
if (substr($setting->_key, 0, 10)=='plugin'.Configuration::KEYMARKER) {
$toc['plugin'][] = $setting;
} else if (substr($setting->_key, 0, 7)=='tpl'.CM_KEYMARKER) {
} else if (substr($setting->_key, 0, 7)=='tpl'.Configuration::KEYMARKER) {
$toc['template'] = $setting;
} else {
$toc['conf'][] = $setting;

452
lib/plugins/config/core/Configuration.php Normal file
View File

@ -0,0 +1,452 @@
<?php
/**
* Configuration Class
*
* @author Chris Smith <chris@jalakai.co.uk>
* @author Ben Coburn <btcoburn@silicodon.net>
*/
namespace dokuwiki\plugin\config\core;
/**
* Class configuration
*/
class Configuration {
const KEYMARKER = '____';
protected $_name = 'conf'; // name of the config variable found in the files (overridden by $config['varname'])
protected $_format = 'php'; // format of the config file, supported formats - php (overridden by $config['format'])
protected $_heading = ''; // heading string written at top of config file - don't include comment indicators
protected $_loaded = false; // set to true after configuration files are loaded
protected $_metadata = array();// holds metadata describing the settings
/** @var Setting[] */
public $setting = array(); // array of setting objects
public $locked = false; // configuration is considered locked if it can't be updated
public $show_disabled_plugins = false;
// configuration filenames
protected $_default_files = array();
protected $_local_files = array(); // updated configuration is written to the first file
protected $_protected_files = array();
protected $_plugin_list = null;
/**
* constructor
*
* @param string $datafile path to config metadata file
*/
public function __construct($datafile) {
global $conf, $config_cascade;
if(!file_exists($datafile)) {
msg('No configuration metadata found at - ' . htmlspecialchars($datafile), -1);
return;
}
$meta = array();
/** @var array $config gets loaded via include here */
include($datafile);
if(isset($config['varname'])) $this->_name = $config['varname'];
if(isset($config['format'])) $this->_format = $config['format'];
if(isset($config['heading'])) $this->_heading = $config['heading'];
$this->_default_files = $config_cascade['main']['default'];
$this->_local_files = $config_cascade['main']['local'];
$this->_protected_files = $config_cascade['main']['protected'];
$this->locked = $this->_is_locked();
$this->_metadata = array_merge($meta, $this->get_plugintpl_metadata($conf['template']));
$this->retrieve_settings();
}
/**
* Retrieve and stores settings in setting[] attribute
*/
public function retrieve_settings() {
global $conf;
$no_default_check = array('setting_fieldset', 'setting_undefined', 'setting_no_class');
if(!$this->_loaded) {
$default = array_merge(
$this->get_plugintpl_default($conf['template']),
$this->_read_config_group($this->_default_files)
);
$local = $this->_read_config_group($this->_local_files);
$protected = $this->_read_config_group($this->_protected_files);
$keys = array_merge(
array_keys($this->_metadata),
array_keys($default),
array_keys($local),
array_keys($protected)
);
$keys = array_unique($keys);
$param = null;
foreach($keys as $key) {
if(isset($this->_metadata[$key])) {
$class = $this->_metadata[$key][0];
if($class && class_exists('setting_' . $class)) {
$class = 'setting_' . $class;
} else {
if($class != '') {
$this->setting[] = new SettingNoClass($key, $param);
}
$class = 'setting';
}
$param = $this->_metadata[$key];
array_shift($param);
} else {
$class = 'setting_undefined';
$param = null;
}
if(!in_array($class, $no_default_check) && !isset($default[$key])) {
$this->setting[] = new SettingNoDefault($key, $param);
}
$this->setting[$key] = new $class($key, $param);
$d = array_key_exists($key, $default) ? $default[$key] : null;
$l = array_key_exists($key, $local) ? $local[$key] : null;
$p = array_key_exists($key, $protected) ? $protected[$key] : null;
$this->setting[$key]->initialize($d, $l, $p);
}
$this->_loaded = true;
}
}
/**
* Stores setting[] array to file
*
* @param string $id Name of plugin, which saves the settings
* @param string $header Text at the top of the rewritten settings file
* @param bool $backup backup current file? (remove any existing backup)
* @return bool succesful?
*/
public function save_settings($id, $header = '', $backup = true) {
global $conf;
if($this->locked) return false;
// write back to the last file in the local config cascade
$file = end($this->_local_files);
// backup current file (remove any existing backup)
if(file_exists($file) && $backup) {
if(file_exists($file . '.bak')) @unlink($file . '.bak');
if(!io_rename($file, $file . '.bak')) return false;
}
if(!$fh = @fopen($file, 'wb')) {
io_rename($file . '.bak', $file); // problem opening, restore the backup
return false;
}
if(empty($header)) $header = $this->_heading;
$out = $this->_out_header($id, $header);
foreach($this->setting as $setting) {
$out .= $setting->out($this->_name, $this->_format);
}
$out .= $this->_out_footer();
@fwrite($fh, $out);
fclose($fh);
if($conf['fperm']) chmod($file, $conf['fperm']);
return true;
}
/**
* Update last modified time stamp of the config file
*
* @return bool
*/
public function touch_settings() {
if($this->locked) return false;
$file = end($this->_local_files);
return @touch($file);
}
/**
* Read and merge given config files
*
* @param array $files file paths
* @return array config settings
*/
protected function _read_config_group($files) {
$config = array();
foreach($files as $file) {
$config = array_merge($config, $this->_read_config($file));
}
return $config;
}
/**
* Return an array of config settings
*
* @param string $file file path
* @return array config settings
*/
protected function _read_config($file) {
if(!$file) return array();
$config = array();
if($this->_format == 'php') {
if(file_exists($file)) {
$contents = @php_strip_whitespace($file);
} else {
$contents = '';
}
$pattern = '/\$' . $this->_name . '\[[\'"]([^=]+)[\'"]\] ?= ?(.*?);(?=[^;]*(?:\$' . $this->_name . '|$))/s';
$matches = array();
preg_match_all($pattern, $contents, $matches, PREG_SET_ORDER);
for($i = 0; $i < count($matches); $i++) {
$value = $matches[$i][2];
// correct issues with the incoming data
// FIXME ... for now merge multi-dimensional array indices using ____
$key = preg_replace('/.\]\[./', Configuration::KEYMARKER, $matches[$i][1]);
// handle arrays
if(preg_match('/^array ?\((.*)\)/', $value, $match)) {
$arr = explode(',', $match[1]);
// remove quotes from quoted strings & unescape escaped data
$len = count($arr);
for($j = 0; $j < $len; $j++) {
$arr[$j] = trim($arr[$j]);
$arr[$j] = $this->_readValue($arr[$j]);
}
$value = $arr;
} else {
$value = $this->_readValue($value);
}
$config[$key] = $value;
}
}
return $config;
}
/**
* Convert php string into value
*
* @param string $value
* @return bool|string
*/
protected function _readValue($value) {
$removequotes_pattern = '/^(\'|")(.*)(?<!\\\\)\1$/s';
$unescape_pairs = array(
'\\\\' => '\\',
'\\\'' => '\'',
'\\"' => '"'
);
if($value == 'true') {
$value = true;
} elseif($value == 'false') {
$value = false;
} else {
// remove quotes from quoted strings & unescape escaped data
$value = preg_replace($removequotes_pattern, '$2', $value);
$value = strtr($value, $unescape_pairs);
}
return $value;
}
/**
* Returns header of rewritten settings file
*
* @param string $id plugin name of which generated this output
* @param string $header additional text for at top of the file
* @return string text of header
*/
protected function _out_header($id, $header) {
$out = '';
if($this->_format == 'php') {
$out .= '<' . '?php' . "\n" .
"/*\n" .
" * " . $header . "\n" .
" * Auto-generated by " . $id . " plugin\n" .
" * Run for user: " . $_SERVER['REMOTE_USER'] . "\n" .
" * Date: " . date('r') . "\n" .
" */\n\n";
}
return $out;
}
/**
* Returns footer of rewritten settings file
*
* @return string text of footer
*/
protected function _out_footer() {
$out = '';
if($this->_format == 'php') {
$out .= "\n// end auto-generated content\n";
}
return $out;
}
/**
* Configuration is considered locked if there is no local settings filename
* or the directory its in is not writable or the file exists and is not writable
*
* @return bool true: locked, false: writable
*/
protected function _is_locked() {
if(!$this->_local_files) return true;
$local = $this->_local_files[0];
if(!is_writable(dirname($local))) return true;
if(file_exists($local) && !is_writable($local)) return true;
return false;
}
/**
* not used ... conf's contents are an array!
* reduce any multidimensional settings to one dimension using Configuration::KEYMARKER
*
* @param $conf
* @param string $prefix
* @return array
*/
protected function _flatten($conf, $prefix = '') {
$out = array();
foreach($conf as $key => $value) {
if(!is_array($value)) {
$out[$prefix . $key] = $value;
continue;
}
$tmp = $this->_flatten($value, $prefix . $key . Configuration::KEYMARKER);
$out = array_merge($out, $tmp);
}
return $out;
}
/**
* Returns array of plugin names
*
* @return array plugin names
* @triggers PLUGIN_CONFIG_PLUGINLIST event
*/
protected function get_plugin_list() {
if(is_null($this->_plugin_list)) {
$list = plugin_list('', $this->show_disabled_plugins);
// remove this plugin from the list
$idx = array_search('config', $list);
unset($list[$idx]);
trigger_event('PLUGIN_CONFIG_PLUGINLIST', $list);
$this->_plugin_list = $list;
}
return $this->_plugin_list;
}
/**
* load metadata for plugin and template settings
*
* @param string $tpl name of active template
* @return array metadata of settings
*/
protected function get_plugintpl_metadata($tpl) {
$file = '/conf/metadata.php';
$class = '/conf/settings.class.php';
$metadata = array();
foreach($this->get_plugin_list() as $plugin) {
$plugin_dir = plugin_directory($plugin);
if(file_exists(DOKU_PLUGIN . $plugin_dir . $file)) {
$meta = array();
@include(DOKU_PLUGIN . $plugin_dir . $file);
@include(DOKU_PLUGIN . $plugin_dir . $class);
if(!empty($meta)) {
$metadata['plugin' . Configuration::KEYMARKER . $plugin . Configuration::KEYMARKER . 'plugin_settings_name'] = ['fieldset'];
}
foreach($meta as $key => $value) {
if($value[0] == 'fieldset') {
continue;
} //plugins only get one fieldset
$metadata['plugin' . Configuration::KEYMARKER . $plugin . Configuration::KEYMARKER . $key] = $value;
}
}
}
// the same for the active template
if(file_exists(tpl_incdir() . $file)) {
$meta = array();
@include(tpl_incdir() . $file);
@include(tpl_incdir() . $class);
if(!empty($meta)) {
$metadata['tpl' . Configuration::KEYMARKER . $tpl . Configuration::KEYMARKER . 'template_settings_name'] = array('fieldset');
}
foreach($meta as $key => $value) {
if($value[0] == 'fieldset') {
continue;
} //template only gets one fieldset
$metadata['tpl' . Configuration::KEYMARKER . $tpl . Configuration::KEYMARKER . $key] = $value;
}
}
return $metadata;
}
/**
* Load default settings for plugins and templates
*
* @param string $tpl name of active template
* @return array default settings
*/
protected function get_plugintpl_default($tpl) {
$file = '/conf/default.php';
$default = array();
foreach($this->get_plugin_list() as $plugin) {
$plugin_dir = plugin_directory($plugin);
if(file_exists(DOKU_PLUGIN . $plugin_dir . $file)) {
$conf = $this->_read_config(DOKU_PLUGIN . $plugin_dir . $file);
foreach($conf as $key => $value) {
$default['plugin' . Configuration::KEYMARKER . $plugin . Configuration::KEYMARKER . $key] = $value;
}
}
}
// the same for the active template
if(file_exists(tpl_incdir() . $file)) {
$conf = $this->_read_config(tpl_incdir() . $file);
foreach($conf as $key => $value) {
$default['tpl' . Configuration::KEYMARKER . $tpl . Configuration::KEYMARKER . $key] = $value;
}
}
return $default;
}
}

216
lib/plugins/config/core/Setting.php Normal file
View File

@ -0,0 +1,216 @@
<?php
namespace dokuwiki\plugin\config\core;
/**
* Class setting
*/
class Setting {
protected $_key = '';
protected $_default = null;
protected $_local = null;
protected $_protected = null;
protected $_pattern = '';
protected $_error = false; // only used by those classes which error check
protected $_input = null; // only used by those classes which error check
protected $_caution = null; // used by any setting to provide an alert along with the setting
// valid alerts, 'warning', 'danger', 'security'
// images matching the alerts are in the plugin's images directory
static protected $_validCautions = array('warning', 'danger', 'security');
/**
* @param string $key
* @param array|null $params array with metadata of setting
*/
public function __construct($key, $params = null) {
$this->_key = $key;
if(is_array($params)) {
foreach($params as $property => $value) {
$this->$property = $value;
}
}
}
/**
* Receives current values for the setting $key
*
* @param mixed $default default setting value
* @param mixed $local local setting value
* @param mixed $protected protected setting value
*/
public function initialize($default, $local, $protected) {
if(isset($default)) $this->_default = $default;
if(isset($local)) $this->_local = $local;
if(isset($protected)) $this->_protected = $protected;
}
/**
* update changed setting with user provided value $input
* - if changed value fails error check, save it to $this->_input (to allow echoing later)
* - if changed value passes error check, set $this->_local to the new value
*
* @param mixed $input the new value
* @return boolean true if changed, false otherwise (also on error)
*/
public function update($input) {
if(is_null($input)) return false;
if($this->is_protected()) return false;
$value = is_null($this->_local) ? $this->_default : $this->_local;
if($value == $input) return false;
if($this->_pattern && !preg_match($this->_pattern, $input)) {
$this->_error = true;
$this->_input = $input;
return false;
}
$this->_local = $input;
return true;
}
/**
* Build html for label and input of setting
*
* @param \admin_plugin_config $plugin object of config plugin
* @param bool $echo true: show inputted value, when error occurred, otherwise the stored setting
* @return string[] with content array(string $label_html, string $input_html)
*/
public function html(\admin_plugin_config $plugin, $echo = false) {
$disable = '';
if($this->is_protected()) {
$value = $this->_protected;
$disable = 'disabled="disabled"';
} else {
if($echo && $this->_error) {
$value = $this->_input;
} else {
$value = is_null($this->_local) ? $this->_default : $this->_local;
}
}
$key = htmlspecialchars($this->_key);
$value = formText($value);
$label = '<label for="config___' . $key . '">' . $this->prompt($plugin) . '</label>';
$input = '<textarea rows="3" cols="40" id="config___' . $key .
'" name="config[' . $key . ']" class="edit" ' . $disable . '>' . $value . '</textarea>';
return array($label, $input);
}
/**
* Generate string to save setting value to file according to $fmt
*
* @param string $var name of variable
* @param string $fmt save format
* @return string
*/
public function out($var, $fmt = 'php') {
if($this->is_protected()) return '';
if(is_null($this->_local) || ($this->_default == $this->_local)) return '';
$out = '';
if($fmt == 'php') {
$tr = array("\\" => '\\\\', "'" => '\\\'');
$out = '$' . $var . "['" . $this->_out_key() . "'] = '" . strtr(cleanText($this->_local), $tr) . "';\n";
}
return $out;
}
/**
* Returns the localized prompt
*
* @param \admin_plugin_config $plugin object of config plugin
* @return string text
*/
public function prompt(\admin_plugin_config $plugin) {
$prompt = $plugin->getLang($this->_key);
if(!$prompt) $prompt = htmlspecialchars(str_replace(array('____', '_'), ' ', $this->_key));
return $prompt;
}
/**
* Is setting protected
*
* @return bool
*/
public function is_protected() {
return !is_null($this->_protected);
}
/**
* Is setting the default?
*
* @return bool
*/
public function is_default() {
return !$this->is_protected() && is_null($this->_local);
}
/**
* Has an error?
*
* @return bool
*/
public function error() {
return $this->_error;
}
/**
* Returns caution
*
* @return false|string caution string, otherwise false for invalid caution
*/
public function caution() {
if(!empty($this->_caution)) {
if(!in_array($this->_caution, Setting::$_validCautions)) {
trigger_error(
'Invalid caution string (' . $this->_caution . ') in metadata for setting "' . $this->_key . '"',
E_USER_WARNING
);
return false;
}
return $this->_caution;
}
// compatibility with previous cautionList
// TODO: check if any plugins use; remove
if(!empty($this->_cautionList[$this->_key])) {
$this->_caution = $this->_cautionList[$this->_key];
unset($this->_cautionList);
return $this->caution();
}
return false;
}
/**
* Returns setting key, eventually with referer to config: namespace at dokuwiki.org
*
* @param bool $pretty create nice key
* @param bool $url provide url to config: namespace
* @return string key
*/
public function _out_key($pretty = false, $url = false) {
if($pretty) {
$out = str_replace(Configuration::KEYMARKER, "»", $this->_key);
if($url && !strstr($out, '»')) {//provide no urls for plugins, etc.
if($out == 'start') //one exception
return '<a href="http://www.dokuwiki.org/config:startpage">' . $out . '</a>';
else
return '<a href="http://www.dokuwiki.org/config:' . $out . '">' . $out . '</a>';
}
return $out;
} else {
return str_replace(Configuration::KEYMARKER, "']['", $this->_key);
}
}
}

124
lib/plugins/config/core/SettingArray.php Normal file
View File

@ -0,0 +1,124 @@
<?php
namespace dokuwiki\plugin\config\core;
/**
* Class setting_array
*/
class SettingArray extends Setting {
/**
* Create an array from a string
*
* @param string $string
* @return array
*/
protected function _from_string($string) {
$array = explode(',', $string);
$array = array_map('trim', $array);
$array = array_filter($array);
$array = array_unique($array);
return $array;
}
/**
* Create a string from an array
*
* @param array $array
* @return string
*/
protected function _from_array($array) {
return join(', ', (array) $array);
}
/**
* update setting with user provided value $input
* if value fails error check, save it
*
* @param string $input
* @return bool true if changed, false otherwise (incl. on error)
*/
public function update($input) {
if(is_null($input)) return false;
if($this->is_protected()) return false;
$input = $this->_from_string($input);
$value = is_null($this->_local) ? $this->_default : $this->_local;
if($value == $input) return false;
foreach($input as $item) {
if($this->_pattern && !preg_match($this->_pattern, $item)) {
$this->_error = true;
$this->_input = $input;
return false;
}
}
$this->_local = $input;
return true;
}
/**
* Escaping
*
* @param string $string
* @return string
*/
protected function _escape($string) {
$tr = array("\\" => '\\\\', "'" => '\\\'');
return "'" . strtr(cleanText($string), $tr) . "'";
}
/**
* Generate string to save setting value to file according to $fmt
*
* @param string $var name of variable
* @param string $fmt save format
* @return string
*/
public function out($var, $fmt = 'php') {
if($this->is_protected()) return '';
if(is_null($this->_local) || ($this->_default == $this->_local)) return '';
$out = '';
if($fmt == 'php') {
$vals = array_map(array($this, '_escape'), $this->_local);
$out = '$' . $var . "['" . $this->_out_key() . "'] = array(" . join(', ', $vals) . ");\n";
}
return $out;
}
/**
* Build html for label and input of setting
*
* @param \admin_plugin_config $plugin object of config plugin
* @param bool $echo true: show inputted value, when error occurred, otherwise the stored setting
* @return string[] with content array(string $label_html, string $input_html)
*/
public function html(\admin_plugin_config $plugin, $echo = false) {
$disable = '';
if($this->is_protected()) {
$value = $this->_protected;
$disable = 'disabled="disabled"';
} else {
if($echo && $this->_error) {
$value = $this->_input;
} else {
$value = is_null($this->_local) ? $this->_default : $this->_local;
}
}
$key = htmlspecialchars($this->_key);
$value = htmlspecialchars($this->_from_array($value));
$label = '<label for="config___' . $key . '">' . $this->prompt($plugin) . '</label>';
$input = '<input id="config___' . $key . '" name="config[' . $key .
']" type="text" class="edit" value="' . $value . '" ' . $disable . '/>';
return array($label, $input);
}
}

73
lib/plugins/config/core/SettingAuthtype.php Normal file
View File

@ -0,0 +1,73 @@
<?php
namespace dokuwiki\plugin\config\core;
/**
* Class setting_authtype
*/
class SettingAuthtype extends SettingMultichoice {
/**
* Receives current values for the setting $key
*
* @param mixed $default default setting value
* @param mixed $local local setting value
* @param mixed $protected protected setting value
*/
public function initialize($default, $local, $protected) {
/** @var $plugin_controller \Doku_Plugin_Controller */
global $plugin_controller;
// retrieve auth types provided by plugins
foreach($plugin_controller->getList('auth') as $plugin) {
$this->_choices[] = $plugin;
}
parent::initialize($default, $local, $protected);
}
/**
* update changed setting with user provided value $input
* - if changed value fails error check, save it to $this->_input (to allow echoing later)
* - if changed value passes error check, set $this->_local to the new value
*
* @param mixed $input the new value
* @return boolean true if changed, false otherwise (also on error)
*/
public function update($input) {
/** @var $plugin_controller \Doku_Plugin_Controller */
global $plugin_controller;
// is an update possible/requested?
$local = $this->_local; // save this, parent::update() may change it
if(!parent::update($input)) return false; // nothing changed or an error caught by parent
$this->_local = $local; // restore original, more error checking to come
// attempt to load the plugin
$auth_plugin = $plugin_controller->load('auth', $input);
// @TODO: throw an error in plugin controller instead of returning null
if(is_null($auth_plugin)) {
$this->_error = true;
msg('Cannot load Auth Plugin "' . $input . '"', -1);
return false;
}
// verify proper instantiation (is this really a plugin?) @TODO use instanceof? implement interface?
if(is_object($auth_plugin) && !method_exists($auth_plugin, 'getPluginName')) {
$this->_error = true;
msg('Cannot create Auth Plugin "' . $input . '"', -1);
return false;
}
// did we change the auth type? logout
global $conf;
if($conf['authtype'] != $input) {
msg('Authentication system changed. Please re-login.');
auth_logoff();
}
$this->_local = $input;
return true;
}
}

27
lib/plugins/config/core/SettingCompression.php Normal file
View File

@ -0,0 +1,27 @@
<?php
namespace dokuwiki\plugin\config\core;
/**
* Class setting_compression
*/
class SettingCompression extends SettingMultichoice {
protected $_choices = array('0'); // 0 = no compression, always supported
/**
* Receives current values for the setting $key
*
* @param mixed $default default setting value
* @param mixed $local local setting value
* @param mixed $protected protected setting value
*/
public function initialize($default, $local, $protected) {
// populate _choices with the compression methods supported by this php installation
if(function_exists('gzopen')) $this->_choices[] = 'gz';
if(function_exists('bzopen')) $this->_choices[] = 'bz2';
parent::initialize($default, $local, $protected);
}
}

39
lib/plugins/config/core/SettingDirchoice.php Normal file
View File

@ -0,0 +1,39 @@
<?php
namespace dokuwiki\plugin\config\core;
/**
* Class setting_dirchoice
*/
class SettingDirchoice extends SettingMultichoice {
protected $_dir = '';
/**
* Receives current values for the setting $key
*
* @param mixed $default default setting value
* @param mixed $local local setting value
* @param mixed $protected protected setting value
*/
public function initialize($default, $local, $protected) {
// populate $this->_choices with a list of directories
$list = array();
if($dh = @opendir($this->_dir)) {
while(false !== ($entry = readdir($dh))) {
if($entry == '.' || $entry == '..') continue;
if($this->_pattern && !preg_match($this->_pattern, $entry)) continue;
$file = (is_link($this->_dir . $entry)) ? readlink($this->_dir . $entry) : $this->_dir . $entry;
if(is_dir($file)) $list[] = $entry;
}
closedir($dh);
}
sort($list);
$this->_choices = $list;
parent::initialize($default, $local, $protected);
}
}

29
lib/plugins/config/core/SettingDisableactions.php Normal file
View File

@ -0,0 +1,29 @@
<?php
namespace dokuwiki\plugin\config\core;
/**
* Class setting_disableactions
*/
class SettingDisableactions extends SettingMulticheckbox {
/**
* Build html for label and input of setting
*
* @param \admin_plugin_config $plugin object of config plugin
* @param bool $echo true: show inputted value, when error occurred, otherwise the stored setting
* @return array with content array(string $label_html, string $input_html)
*/
public function html(\admin_plugin_config $plugin, $echo = false) {
global $lang;
// make some language adjustments (there must be a better way)
// transfer some DokuWiki language strings to the plugin
$plugin->addLang($this->_key . '_revisions', $lang['btn_revs']);
foreach($this->_choices as $choice) {
if(isset($lang['btn_' . $choice])) $plugin->addLang($this->_key . '_' . $choice, $lang['btn_' . $choice]);
}
return parent::html($plugin, $echo);
}
}

64
lib/plugins/config/core/SettingEmail.php Normal file
View File

@ -0,0 +1,64 @@
<?php
namespace dokuwiki\plugin\config\core;
/**
* Class setting_email
*/
class SettingEmail extends SettingString {
protected $_multiple = false;
protected $_placeholders = false;
/**
* update setting with user provided value $input
* if value fails error check, save it
*
* @param mixed $input
* @return boolean true if changed, false otherwise (incl. on error)
*/
public function update($input) {
if(is_null($input)) return false;
if($this->is_protected()) return false;
$value = is_null($this->_local) ? $this->_default : $this->_local;
if($value == $input) return false;
if($input === '') {
$this->_local = $input;
return true;
}
$mail = $input;
if($this->_placeholders) {
// replace variables with pseudo values
$mail = str_replace('@USER@', 'joe', $mail);
$mail = str_replace('@NAME@', 'Joe Schmoe', $mail);
$mail = str_replace('@MAIL@', 'joe@example.com', $mail);
}
// multiple mail addresses?
if($this->_multiple) {
$mails = array_filter(array_map('trim', explode(',', $mail)));
} else {
$mails = array($mail);
}
// check them all
foreach($mails as $mail) {
// only check the address part
if(preg_match('#(.*?)<(.*?)>#', $mail, $matches)) {
$addr = $matches[2];
} else {
$addr = $mail;
}
if(!mail_isvalid($addr)) {
$this->_error = true;
$this->_input = $input;
return false;
}
}
$this->_local = $input;
return true;
}
}

11
lib/plugins/config/core/SettingFieldset.php Normal file
View File

@ -0,0 +1,11 @@
<?php
namespace dokuwiki\plugin\config\core;
/**
* Class setting_fieldset
*/
class SettingFieldset extends Setting {
// A do-nothing class used to detect the 'fieldset' type.
// Used to start a new settings "display-group".
}

10
lib/plugins/config/core/SettingHidden.php Normal file
View File

@ -0,0 +1,10 @@
<?php
namespace dokuwiki\plugin\config\core;
/**
* Class setting_hidden
*/
class SettingHidden extends Setting {
// Used to explicitly ignore a setting in the configuration manager.
}

35
lib/plugins/config/core/SettingImConvert.php Normal file
View File

@ -0,0 +1,35 @@
<?php
namespace dokuwiki\plugin\config\core;
/**
* Class setting_im_convert
*/
class SettingImConvert extends SettingString {
/**
* update changed setting with user provided value $input
* - if changed value fails error check, save it to $this->_input (to allow echoing later)
* - if changed value passes error check, set $this->_local to the new value
*
* @param mixed $input the new value
* @return boolean true if changed, false otherwise (also on error)
*/
public function update($input) {
if($this->is_protected()) return false;
$input = trim($input);
$value = is_null($this->_local) ? $this->_default : $this->_local;
if($value == $input) return false;
if($input && !file_exists($input)) {
$this->_error = true;
$this->_input = $input;
return false;
}
$this->_local = $input;
return true;
}
}

29
lib/plugins/config/core/SettingLicense.php Normal file
View File

@ -0,0 +1,29 @@
<?php
namespace dokuwiki\plugin\config\core;
/**
* Class setting_license
*/
class SettingLicense extends SettingMultichoice {
protected $_choices = array(''); // none choosen
/**
* Receives current values for the setting $key
*
* @param mixed $default default setting value
* @param mixed $local local setting value
* @param mixed $protected protected setting value
*/
public function initialize($default, $local, $protected) {
global $license;
foreach($license as $key => $data) {
$this->_choices[] = $key;
$this->lang[$this->_key . '_o_' . $key] = $data['name']; // stored in setting
}
parent::initialize($default, $local, $protected);
}
}

173
lib/plugins/config/core/SettingMulticheckbox.php Normal file
View File

@ -0,0 +1,173 @@
<?php
namespace dokuwiki\plugin\config\core;
/**
* Class setting_multicheckbox
*/
class SettingMulticheckbox extends SettingString {
protected $_choices = array();
protected $_combine = array();
protected $_other = 'always';
/**
* update changed setting with user provided value $input
* - if changed value fails error check, save it to $this->_input (to allow echoing later)
* - if changed value passes error check, set $this->_local to the new value
*
* @param mixed $input the new value
* @return boolean true if changed, false otherwise (also on error)
*/
public function update($input) {
if($this->is_protected()) return false;
// split any combined values + convert from array to comma separated string
$input = ($input) ? $input : array();
$input = $this->_array2str($input);
$value = is_null($this->_local) ? $this->_default : $this->_local;
if($value == $input) return false;
if($this->_pattern && !preg_match($this->_pattern, $input)) {
$this->_error = true;
$this->_input = $input;
return false;
}
$this->_local = $input;
return true;
}
/**
* Build html for label and input of setting
*
* @param \admin_plugin_config $plugin object of config plugin
* @param bool $echo true: show input value, when error occurred, otherwise the stored setting
* @return string[] with content array(string $label_html, string $input_html)
*/
public function html(\admin_plugin_config $plugin, $echo = false) {
$disable = '';
if($this->is_protected()) {
$value = $this->_protected;
$disable = 'disabled="disabled"';
} else {
if($echo && $this->_error) {
$value = $this->_input;
} else {
$value = is_null($this->_local) ? $this->_default : $this->_local;
}
}
$key = htmlspecialchars($this->_key);
// convert from comma separated list into array + combine complimentary actions
$value = $this->_str2array($value);
$default = $this->_str2array($this->_default);
$input = '';
foreach($this->_choices as $choice) {
$idx = array_search($choice, $value);
$idx_default = array_search($choice, $default);
$checked = ($idx !== false) ? 'checked="checked"' : '';
// @todo ideally this would be handled using a second class of "default"
$class = (($idx !== false) == (false !== $idx_default)) ? " selectiondefault" : "";
$prompt = ($plugin->getLang($this->_key . '_' . $choice) ?
$plugin->getLang($this->_key . '_' . $choice) : htmlspecialchars($choice));
$input .= '<div class="selection' . $class . '">' . "\n";
$input .= '<label for="config___' . $key . '_' . $choice . '">' . $prompt . "</label>\n";
$input .= '<input id="config___' . $key . '_' . $choice . '" name="config[' . $key .
'][]" type="checkbox" class="checkbox" value="' . $choice . '" ' . $disable . ' ' . $checked . "/>\n";
$input .= "</div>\n";
// remove this action from the disabledactions array
if($idx !== false) unset($value[$idx]);
if($idx_default !== false) unset($default[$idx_default]);
}
// handle any remaining values
if($this->_other != 'never') {
$other = join(',', $value);
// test equivalent to ($this->_other == 'always' || ($other && $this->_other == 'exists')
// use != 'exists' rather than == 'always' to ensure invalid values default to 'always'
if($this->_other != 'exists' || $other) {
$class = (
(count($default) == count($value)) &&
(count($value) == count(array_intersect($value, $default)))
) ?
" selectiondefault" : "";
$input .= '<div class="other' . $class . '">' . "\n";
$input .= '<label for="config___' . $key . '_other">' . $plugin->getLang($key . '_other') . "</label>\n";
$input .= '<input id="config___' . $key . '_other" name="config[' . $key .
'][other]" type="text" class="edit" value="' . htmlspecialchars($other) . '" ' . $disable . " />\n";
$input .= "</div>\n";
}
}
$label = '<label>' . $this->prompt($plugin) . '</label>';
return array($label, $input);
}
/**
* convert comma separated list to an array and combine any complimentary values
*
* @param string $str
* @return array
*/
protected function _str2array($str) {
$array = explode(',', $str);
if(!empty($this->_combine)) {
foreach($this->_combine as $key => $combinators) {
$idx = array();
foreach($combinators as $val) {
if(($idx[] = array_search($val, $array)) === false) break;
}
if(count($idx) && $idx[count($idx) - 1] !== false) {
foreach($idx as $i) unset($array[$i]);
$array[] = $key;
}
}
}
return $array;
}
/**
* convert array of values + other back to a comma separated list, incl. splitting any combined values
*
* @param array $input
* @return string
*/
protected function _array2str($input) {
// handle other
$other = trim($input['other']);
$other = !empty($other) ? explode(',', str_replace(' ', '', $input['other'])) : array();
unset($input['other']);
$array = array_unique(array_merge($input, $other));
// deconstruct any combinations
if(!empty($this->_combine)) {
foreach($this->_combine as $key => $combinators) {
$idx = array_search($key, $array);
if($idx !== false) {
unset($array[$idx]);
$array = array_merge($array, $combinators);
}
}
}
return join(',', array_unique($array));
}
}

84
lib/plugins/config/core/SettingMultichoice.php Normal file
View File

@ -0,0 +1,84 @@
<?php
namespace dokuwiki\plugin\config\core;
/**
* Class setting_multichoice
*/
class SettingMultichoice extends SettingString {
protected $_choices = array();
public $lang; //some custom language strings are stored in setting
/**
* Build html for label and input of setting
*
* @param \admin_plugin_config $plugin object of config plugin
* @param bool $echo true: show inputted value, when error occurred, otherwise the stored setting
* @return string[] with content array(string $label_html, string $input_html)
*/
public function html(\admin_plugin_config $plugin, $echo = false) {
$disable = '';
$nochoice = '';
if($this->is_protected()) {
$value = $this->_protected;
$disable = ' disabled="disabled"';
} else {
$value = is_null($this->_local) ? $this->_default : $this->_local;
}
// ensure current value is included
if(!in_array($value, $this->_choices)) {
$this->_choices[] = $value;
}
// disable if no other choices
if(!$this->is_protected() && count($this->_choices) <= 1) {
$disable = ' disabled="disabled"';
$nochoice = $plugin->getLang('nochoice');
}
$key = htmlspecialchars($this->_key);
$label = '<label for="config___' . $key . '">' . $this->prompt($plugin) . '</label>';
$input = "<div class=\"input\">\n";
$input .= '<select class="edit" id="config___' . $key . '" name="config[' . $key . ']"' . $disable . '>' . "\n";
foreach($this->_choices as $choice) {
$selected = ($value == $choice) ? ' selected="selected"' : '';
$option = $plugin->getLang($this->_key . '_o_' . $choice);
if(!$option && isset($this->lang[$this->_key . '_o_' . $choice])) {
$option = $this->lang[$this->_key . '_o_' . $choice];
}
if(!$option) $option = $choice;
$choice = htmlspecialchars($choice);
$option = htmlspecialchars($option);
$input .= ' <option value="' . $choice . '"' . $selected . ' >' . $option . '</option>' . "\n";
}
$input .= "</select> $nochoice \n";
$input .= "</div>\n";
return array($label, $input);
}
/**
* update changed setting with user provided value $input
* - if changed value fails error check, save it to $this->_input (to allow echoing later)
* - if changed value passes error check, set $this->_local to the new value
*
* @param mixed $input the new value
* @return boolean true if changed, false otherwise (also on error)
*/
public function update($input) {
if(is_null($input)) return false;
if($this->is_protected()) return false;
$value = is_null($this->_local) ? $this->_default : $this->_local;
if($value == $input) return false;
if(!in_array($input, $this->_choices)) return false;
$this->_local = $input;
return true;
}
}

11
lib/plugins/config/core/SettingNoClass.php Normal file
View File

@ -0,0 +1,11 @@
<?php
namespace dokuwiki\plugin\config\core;
/**
* Class setting_no_class
*/
class SettingNoClass extends SettingUndefined {
// A do-nothing class used to detect settings with a missing setting class.
// Used internaly to hide undefined settings, and generate the undefined settings list.
}

11
lib/plugins/config/core/SettingNoDefault.php Normal file
View File

@ -0,0 +1,11 @@
<?php
namespace dokuwiki\plugin\config\core;
/**
* Class setting_no_default
*/
class SettingNoDefault extends SettingUndefined {
// A do-nothing class used to detect settings with no default value.
// Used internaly to hide undefined settings, and generate the undefined settings list.
}

61
lib/plugins/config/core/SettingNumeric.php Normal file
View File

@ -0,0 +1,61 @@
<?php
namespace dokuwiki\plugin\config\core;
/**
* Class setting_numeric
*/
class SettingNumeric extends SettingString {
// This allows for many PHP syntax errors...
// var $_pattern = '/^[-+\/*0-9 ]*$/';
// much more restrictive, but should eliminate syntax errors.
protected $_pattern = '/^[-+]? *[0-9]+ *(?:[-+*] *[0-9]+ *)*$/';
protected $_min = null;
protected $_max = null;
/**
* update changed setting with user provided value $input
* - if changed value fails error check, save it to $this->_input (to allow echoing later)
* - if changed value passes error check, set $this->_local to the new value
*
* @param mixed $input the new value
* @return boolean true if changed, false otherwise (also on error)
*/
public function update($input) {
$local = $this->_local;
$valid = parent::update($input);
if($valid && !(is_null($this->_min) && is_null($this->_max))) {
$numeric_local = (int) eval('return ' . $this->_local . ';');
if((!is_null($this->_min) && $numeric_local < $this->_min) ||
(!is_null($this->_max) && $numeric_local > $this->_max)) {
$this->_error = true;
$this->_input = $input;
$this->_local = $local;
$valid = false;
}
}
return $valid;
}
/**
* Generate string to save setting value to file according to $fmt
*
* @param string $var name of variable
* @param string $fmt save format
* @return string
*/
public function out($var, $fmt = 'php') {
if($this->is_protected()) return '';
if(is_null($this->_local) || ($this->_default == $this->_local)) return '';
$out = '';
if($fmt == 'php') {
$local = $this->_local === '' ? "''" : $this->_local;
$out .= '$' . $var . "['" . $this->_out_key() . "'] = " . $local . ";\n";
}
return $out;
}
}

26
lib/plugins/config/core/SettingNumericopt.php Normal file
View File

@ -0,0 +1,26 @@
<?php
namespace dokuwiki\plugin\config\core;
/**
* Class setting_numericopt
*/
class SettingNumericopt extends SettingNumeric {
// just allow an empty config
protected $_pattern = '/^(|[-]?[0-9]+(?:[-+*][0-9]+)*)$/';
/**
* Empty string is valid for numericopt
*
* @param mixed $input
*
* @return bool
*/
public function update($input) {
if($input === '') {
return true;
}
return parent::update($input);
}
}

53
lib/plugins/config/core/SettingOnoff.php Normal file
View File

@ -0,0 +1,53 @@
<?php
namespace dokuwiki\plugin\config\core;
/**
* Class setting_onoff
*/
class SettingOnoff extends SettingNumeric {
/**
* Build html for label and input of setting
*
* @param \admin_plugin_config $plugin object of config plugin
* @param bool $echo true: show inputted value, when error occurred, otherwise the stored setting
* @return string[] with content array(string $label_html, string $input_html)
*/
public function html(\admin_plugin_config $plugin, $echo = false) {
$disable = '';
if($this->is_protected()) {
$value = $this->_protected;
$disable = ' disabled="disabled"';
} else {
$value = is_null($this->_local) ? $this->_default : $this->_local;
}
$key = htmlspecialchars($this->_key);
$checked = ($value) ? ' checked="checked"' : '';
$label = '<label for="config___' . $key . '">' . $this->prompt($plugin) . '</label>';
$input = '<div class="input"><input id="config___' . $key . '" name="config[' . $key .
']" type="checkbox" class="checkbox" value="1"' . $checked . $disable . '/></div>';
return array($label, $input);
}
/**
* update changed setting with user provided value $input
* - if changed value fails error check, save it to $this->_input (to allow echoing later)
* - if changed value passes error check, set $this->_local to the new value
*
* @param mixed $input the new value
* @return boolean true if changed, false otherwise (also on error)
*/
public function update($input) {
if($this->is_protected()) return false;
$input = ($input) ? 1 : 0;
$value = is_null($this->_local) ? $this->_default : $this->_local;
if($value == $input) return false;
$this->_local = $input;
return true;
}
}

52
lib/plugins/config/core/SettingPassword.php Normal file
View File

@ -0,0 +1,52 @@
<?php
namespace dokuwiki\plugin\config\core;
/**
* Class setting_password
*/
class SettingPassword extends SettingString {
protected $_code = 'plain'; // mechanism to be used to obscure passwords
/**
* update changed setting with user provided value $input
* - if changed value fails error check, save it to $this->_input (to allow echoing later)
* - if changed value passes error check, set $this->_local to the new value
*
* @param mixed $input the new value
* @return boolean true if changed, false otherwise (also on error)
*/
public function update($input) {
if($this->is_protected()) return false;
if(!$input) return false;
if($this->_pattern && !preg_match($this->_pattern, $input)) {
$this->_error = true;
$this->_input = $input;
return false;
}
$this->_local = conf_encodeString($input, $this->_code);
return true;
}
/**
* Build html for label and input of setting
*
* @param \admin_plugin_config $plugin object of config plugin
* @param bool $echo true: show inputted value, when error occurred, otherwise the stored setting
* @return string[] with content array(string $label_html, string $input_html)
*/
public function html(\admin_plugin_config $plugin, $echo = false) {
$disable = $this->is_protected() ? 'disabled="disabled"' : '';
$key = htmlspecialchars($this->_key);
$label = '<label for="config___' . $key . '">' . $this->prompt($plugin) . '</label>';
$input = '<input id="config___' . $key . '" name="config[' . $key .
']" autocomplete="off" type="password" class="edit" value="" ' . $disable . ' />';
return array($label, $input);
}
}

41
lib/plugins/config/core/SettingRegex.php Normal file
View File

@ -0,0 +1,41 @@
<?php
namespace dokuwiki\plugin\config\core;
/**
* Class setting_regex
*/
class SettingRegex extends SettingString {
protected $_delimiter = '/'; // regex delimiter to be used in testing input
protected $_pregflags = 'ui'; // regex pattern modifiers to be used in testing input
/**
* update changed setting with user provided value $input
* - if changed value fails error check, save it to $this->_input (to allow echoing later)
* - if changed value passes error check, set $this->_local to the new value
*
* @param mixed $input the new value
* @return boolean true if changed, false otherwise (incl. on error)
*/
public function update($input) {
// let parent do basic checks, value, not changed, etc.
$local = $this->_local;
if(!parent::update($input)) return false;
$this->_local = $local;
// see if the regex compiles and runs (we don't check for effectiveness)
$regex = $this->_delimiter . $input . $this->_delimiter . $this->_pregflags;
$lastError = error_get_last();
@preg_match($regex, 'testdata');
if(preg_last_error() != PREG_NO_ERROR || error_get_last() != $lastError) {
$this->_input = $input;
$this->_error = true;
return false;
}
$this->_local = $input;
return true;
}
}

68
lib/plugins/config/core/SettingRenderer.php Normal file
View File

@ -0,0 +1,68 @@
<?php
/**
* additional setting classes specific to these settings
*
* @author Chris Smith <chris@jalakai.co.uk>
*/
namespace dokuwiki\plugin\config\core;
/**
* Class setting_renderer
*/
class SettingRenderer extends SettingMultichoice {
protected $_prompts = array();
protected $_format = null;
/**
* Receives current values for the setting $key
*
* @param mixed $default default setting value
* @param mixed $local local setting value
* @param mixed $protected protected setting value
*/
public function initialize($default, $local, $protected) {
$format = $this->_format;
foreach(plugin_list('renderer') as $plugin) {
$renderer = plugin_load('renderer', $plugin);
if(method_exists($renderer, 'canRender') && $renderer->canRender($format)) {
$this->_choices[] = $plugin;
$info = $renderer->getInfo();
$this->_prompts[$plugin] = $info['name'];
}
}
parent::initialize($default, $local, $protected);
}
/**
* Build html for label and input of setting
*
* @param \admin_plugin_config $plugin object of config plugin
* @param bool $echo true: show inputted value, when error occurred, otherwise the stored setting
* @return array with content array(string $label_html, string $input_html)
*/
public function html(\admin_plugin_config $plugin, $echo = false) {
// make some language adjustments (there must be a better way)
// transfer some plugin names to the config plugin
foreach($this->_choices as $choice) {
if(!$plugin->getLang($this->_key . '_o_' . $choice)) {
if(!isset($this->_prompts[$choice])) {
$plugin->addLang(
$this->_key . '_o_' . $choice,
sprintf($plugin->getLang('renderer__core'), $choice)
);
} else {
$plugin->addLang(
$this->_key . '_o_' . $choice,
sprintf($plugin->getLang('renderer__plugin'), $this->_prompts[$choice])
);
}
}
}
return parent::html($plugin, $echo);
}
}

33
lib/plugins/config/core/SettingSavedir.php Normal file
View File

@ -0,0 +1,33 @@
<?php
namespace dokuwiki\plugin\config\core;
/**
* Class setting_savedir
*/
class SettingSavedir extends SettingString {
/**
* update changed setting with user provided value $input
* - if changed value fails error check, save it to $this->_input (to allow echoing later)
* - if changed value passes error check, set $this->_local to the new value
*
* @param mixed $input the new value
* @return boolean true if changed, false otherwise (also on error)
*/
public function update($input) {
if($this->is_protected()) return false;
$value = is_null($this->_local) ? $this->_default : $this->_local;
if($value == $input) return false;
if(!init_path($input)) {
$this->_error = true;
$this->_input = $input;
return false;
}
$this->_local = $input;
return true;
}
}

21
lib/plugins/config/core/SettingSepchar.php Normal file
View File

@ -0,0 +1,21 @@
<?php
namespace dokuwiki\plugin\config\core;
/**
* Class setting_sepchar
*/
class SettingSepchar extends SettingMultichoice {
/**
* @param string $key
* @param array|null $param array with metadata of setting
*/
public function __construct($key, $param = null) {
$str = '_-.';
for($i = 0; $i < strlen($str); $i++) $this->_choices[] = $str{$i};
// call foundation class constructor
parent::__construct($key, $param);
}
}

38
lib/plugins/config/core/SettingString.php Normal file
View File

@ -0,0 +1,38 @@
<?php
namespace dokuwiki\plugin\config\core;
/**
* Class setting_string
*/
class SettingString extends Setting {
/**
* Build html for label and input of setting
*
* @param \admin_plugin_config $plugin object of config plugin
* @param bool $echo true: show inputted value, when error occurred, otherwise the stored setting
* @return string[] with content array(string $label_html, string $input_html)
*/
public function html(\admin_plugin_config $plugin, $echo = false) {
$disable = '';
if($this->is_protected()) {
$value = $this->_protected;
$disable = 'disabled="disabled"';
} else {
if($echo && $this->_error) {
$value = $this->_input;
} else {
$value = is_null($this->_local) ? $this->_default : $this->_local;
}
}
$key = htmlspecialchars($this->_key);
$value = htmlspecialchars($value);
$label = '<label for="config___' . $key . '">' . $this->prompt($plugin) . '</label>';
$input = '<input id="config___' . $key . '" name="config[' . $key .
']" type="text" class="edit" value="' . $value . '" ' . $disable . '/>';
return array($label, $input);
}
}

11
lib/plugins/config/core/SettingUndefined.php Normal file
View File

@ -0,0 +1,11 @@
<?php
namespace dokuwiki\plugin\config\core;
/**
* Class setting_undefined
*/
class SettingUndefined extends SettingHidden {
// A do-nothing class used to detect settings with no metadata entry.
// Used internaly to hide undefined settings, and generate the undefined settings list.
}

1454
lib/plugins/config/settings/config.class.php
View File

File diff suppressed because it is too large Load Diff

4
lib/plugins/config/settings/config.metadata.php
View File

@ -11,7 +11,7 @@
* <handler class id> is the handler class name without the "setting_" prefix
*
* Defined classes:
* Generic (source: settings/config.class.php)
* Generic (source: settings/Configuration.php)
* -------------------------------------------
* '' - default class ('setting'), textarea, minimal input validation, setting output in quotes
* 'string' - single line text input, minimal input validation, setting output in quotes
@ -38,7 +38,7 @@
* to see if will compile & run as a regex. in addition to _pattern, also accepts _delimiter
* (default '/') and _pregflags (default 'ui')
*
* Single Setting (source: settings/extra.class.php)
* Single Setting (source: settings/SettingRenderer.php)
* -------------------------------------------------
* 'savedir' - as 'setting', input tested against initpath() (inc/init.php)
* 'sepchar' - as multichoice, selection constructed from string of valid values

309
lib/plugins/config/settings/extra.class.php
View File

@ -1,309 +0,0 @@
<?php
/**
* additional setting classes specific to these settings
*
* @author Chris Smith <chris@jalakai.co.uk>
*/
if (!class_exists('setting_sepchar')) {
/**
* Class setting_sepchar
*/
class setting_sepchar extends setting_multichoice {
/**
* @param string $key
* @param array|null $param array with metadata of setting
*/
public function __construct($key,$param=null) {
$str = '_-.';
for ($i=0;$i<strlen($str);$i++) $this->_choices[] = $str{$i};
// call foundation class constructor
parent::__construct($key,$param);
}
}
}
if (!class_exists('setting_savedir')) {
/**
* Class setting_savedir
*/
class setting_savedir extends setting_string {
/**
* update changed setting with user provided value $input
* - if changed value fails error check, save it to $this->_input (to allow echoing later)
* - if changed value passes error check, set $this->_local to the new value
*
* @param mixed $input the new value
* @return boolean true if changed, false otherwise (also on error)
*/
public function update($input) {
if ($this->is_protected()) return false;
$value = is_null($this->_local) ? $this->_default : $this->_local;
if ($value == $input) return false;
if (!init_path($input)) {
$this->_error = true;
$this->_input = $input;
return false;
}
$this->_local = $input;
return true;
}
}
}
if (!class_exists('setting_authtype')) {
/**
* Class setting_authtype
*/
class setting_authtype extends setting_multichoice {
/**
* Receives current values for the setting $key
*
* @param mixed $default default setting value
* @param mixed $local local setting value
* @param mixed $protected protected setting value
*/
public function initialize($default,$local,$protected) {
/** @var $plugin_controller Doku_Plugin_Controller */
global $plugin_controller;
// retrieve auth types provided by plugins
foreach ($plugin_controller->getList('auth') as $plugin) {
$this->_choices[] = $plugin;
}
parent::initialize($default,$local,$protected);
}
/**
* update changed setting with user provided value $input
* - if changed value fails error check, save it to $this->_input (to allow echoing later)
* - if changed value passes error check, set $this->_local to the new value
*
* @param mixed $input the new value
* @return boolean true if changed, false otherwise (also on error)
*/
public function update($input) {
/** @var $plugin_controller Doku_Plugin_Controller */
global $plugin_controller;
// is an update possible/requested?
$local = $this->_local; // save this, parent::update() may change it
if (!parent::update($input)) return false; // nothing changed or an error caught by parent
$this->_local = $local; // restore original, more error checking to come
// attempt to load the plugin
$auth_plugin = $plugin_controller->load('auth', $input);
// @TODO: throw an error in plugin controller instead of returning null
if (is_null($auth_plugin)) {
$this->_error = true;
msg('Cannot load Auth Plugin "' . $input . '"', -1);
return false;
}
// verify proper instantiation (is this really a plugin?) @TODO use instanceof? implement interface?
if (is_object($auth_plugin) && !method_exists($auth_plugin, 'getPluginName')) {
$this->_error = true;
msg('Cannot create Auth Plugin "' . $input . '"', -1);
return false;
}
// did we change the auth type? logout
global $conf;
if($conf['authtype'] != $input) {
msg('Authentication system changed. Please re-login.');
auth_logoff();
}
$this->_local = $input;
return true;
}
}
}
if (!class_exists('setting_im_convert')) {
/**
* Class setting_im_convert
*/
class setting_im_convert extends setting_string {
/**
* update changed setting with user provided value $input
* - if changed value fails error check, save it to $this->_input (to allow echoing later)
* - if changed value passes error check, set $this->_local to the new value
*
* @param mixed $input the new value
* @return boolean true if changed, false otherwise (also on error)
*/
public function update($input) {
if ($this->is_protected()) return false;
$input = trim($input);
$value = is_null($this->_local) ? $this->_default : $this->_local;
if ($value == $input) return false;
if ($input && !file_exists($input)) {
$this->_error = true;
$this->_input = $input;
return false;
}
$this->_local = $input;
return true;
}
}
}
if (!class_exists('setting_disableactions')) {
/**
* Class setting_disableactions
*/
class setting_disableactions extends setting_multicheckbox {
/**
* Build html for label and input of setting
*
* @param admin_plugin_config $plugin object of config plugin
* @param bool $echo true: show inputted value, when error occurred, otherwise the stored setting
* @return array with content array(string $label_html, string $input_html)
*/
public function html(admin_plugin_config $plugin, $echo=false) {
global $lang;
// make some language adjustments (there must be a better way)
// transfer some DokuWiki language strings to the plugin
$plugin->addLang($this->_key.'_revisions', $lang['btn_revs']);
foreach ($this->_choices as $choice) {
if (isset($lang['btn_'.$choice])) $plugin->addLang($this->_key.'_'.$choice, $lang['btn_'.$choice]);
}
return parent::html($plugin, $echo);
}
}
}
if (!class_exists('setting_compression')) {
/**
* Class setting_compression
*/
class setting_compression extends setting_multichoice {
protected $_choices = array('0'); // 0 = no compression, always supported
/**
* Receives current values for the setting $key
*
* @param mixed $default default setting value
* @param mixed $local local setting value
* @param mixed $protected protected setting value
*/
public function initialize($default,$local,$protected) {
// populate _choices with the compression methods supported by this php installation
if (function_exists('gzopen')) $this->_choices[] = 'gz';
if (function_exists('bzopen')) $this->_choices[] = 'bz2';
parent::initialize($default,$local,$protected);
}
}
}
if (!class_exists('setting_license')) {
/**
* Class setting_license
*/
class setting_license extends setting_multichoice {
protected $_choices = array(''); // none choosen
/**
* Receives current values for the setting $key
*
* @param mixed $default default setting value
* @param mixed $local local setting value
* @param mixed $protected protected setting value
*/
public function initialize($default,$local,$protected) {
global $license;
foreach($license as $key => $data){
$this->_choices[] = $key;
$this->lang[$this->_key.'_o_'.$key] = $data['name']; // stored in setting
}
parent::initialize($default,$local,$protected);
}
}
}
if (!class_exists('setting_renderer')) {
/**
* Class setting_renderer
*/
class setting_renderer extends setting_multichoice {
protected $_prompts = array();
protected $_format = null;
/**
* Receives current values for the setting $key
*
* @param mixed $default default setting value
* @param mixed $local local setting value
* @param mixed $protected protected setting value
*/
public function initialize($default,$local,$protected) {
$format = $this->_format;
foreach (plugin_list('renderer') as $plugin) {
$renderer = plugin_load('renderer',$plugin);
if (method_exists($renderer,'canRender') && $renderer->canRender($format)) {
$this->_choices[] = $plugin;
$info = $renderer->getInfo();
$this->_prompts[$plugin] = $info['name'];
}
}
parent::initialize($default,$local,$protected);
}
/**
* Build html for label and input of setting
*
* @param admin_plugin_config $plugin object of config plugin
* @param bool $echo true: show inputted value, when error occurred, otherwise the stored setting
* @return array with content array(string $label_html, string $input_html)
*/
public function html(admin_plugin_config $plugin, $echo=false) {
// make some language adjustments (there must be a better way)
// transfer some plugin names to the config plugin
foreach($this->_choices as $choice) {
if(!$plugin->getLang($this->_key . '_o_' . $choice)) {
if(!isset($this->_prompts[$choice])) {
$plugin->addLang(
$this->_key . '_o_' . $choice,
sprintf($plugin->getLang('renderer__core'), $choice)
);
} else {
$plugin->addLang(
$this->_key . '_o_' . $choice,
sprintf($plugin->getLang('renderer__plugin'), $this->_prompts[$choice])
);
}
}
}
return parent::html($plugin, $echo);
}
}
}