From e8b5a4f91c8a6e230a6cfe13c43dc9ddce31e253 Mon Sep 17 00:00:00 2001
From: Andreas Gohr <andi@splitbrain.org>
Date: Sat, 28 Jul 2012 12:02:06 +0200
Subject: fix E_STRICT errors FS#2427

This commit fixes all E_STRICT messages shown when running the test
suite. There might be more problems not covered by tests, yet.

For compatibility reasons with plugins, E_STRICT errors are still
supressed.
---
 lib/plugins/action.php              | 2 +-
 lib/plugins/popularity/action.php   | 2 +-
 lib/plugins/safefnrecode/action.php | 2 +-
 lib/plugins/testing/action.php      | 3 ++-
 4 files changed, 5 insertions(+), 4 deletions(-)

(limited to 'lib/plugins')

diff --git a/lib/plugins/action.php b/lib/plugins/action.php
index 885bd7c96..a2ad969d7 100644
--- a/lib/plugins/action.php
+++ b/lib/plugins/action.php
@@ -17,7 +17,7 @@ class DokuWiki_Action_Plugin extends DokuWiki_Plugin {
      /**
       * Registers a callback function for a given event
       */
-      function register($controller) {
+      function register(Doku_Event_Handler $controller) {
         trigger_error('register() not implemented in '.get_class($this), E_USER_WARNING);
       }
 }
diff --git a/lib/plugins/popularity/action.php b/lib/plugins/popularity/action.php
index bf11efba6..1c7a2f65d 100644
--- a/lib/plugins/popularity/action.php
+++ b/lib/plugins/popularity/action.php
@@ -18,7 +18,7 @@ class action_plugin_popularity extends Dokuwiki_Action_Plugin {
     /**
      * Register its handlers with the dokuwiki's event controller
      */
-    function register(&$controller) {
+    function register(Doku_Event_Handler $controller) {
         $controller->register_hook('INDEXER_TASKS_RUN', 'AFTER',  $this, '_autosubmit', array());
     }
 
diff --git a/lib/plugins/safefnrecode/action.php b/lib/plugins/safefnrecode/action.php
index 5d3eaae3a..aae11c437 100644
--- a/lib/plugins/safefnrecode/action.php
+++ b/lib/plugins/safefnrecode/action.php
@@ -13,7 +13,7 @@ require_once DOKU_PLUGIN.'action.php';
 
 class action_plugin_safefnrecode extends DokuWiki_Action_Plugin {
 
-    public function register(Doku_Event_Handler &$controller) {
+    public function register(Doku_Event_Handler $controller) {
 
        $controller->register_hook('INDEXER_TASKS_RUN', 'BEFORE', $this, 'handle_indexer_tasks_run');
 
diff --git a/lib/plugins/testing/action.php b/lib/plugins/testing/action.php
index e829847b6..a242ab0b7 100644
--- a/lib/plugins/testing/action.php
+++ b/lib/plugins/testing/action.php
@@ -7,7 +7,8 @@
  * @author Tobias Sarnowski <tobias@trustedco.de>
  */
 class action_plugin_testing extends DokuWiki_Action_Plugin {
-    function register(&$controller) {
+
+    function register(Doku_Event_Handler $controller) {
         $controller->register_hook('DOKUWIKI_STARTED', 'AFTER', $this, 'dokuwikiStarted');
     }
 
-- 
cgit v1.2.3


From 89d02586756515c9fb68a348e99a787d95e999a2 Mon Sep 17 00:00:00 2001
From: Andreas Gohr <andi@splitbrain.org>
Date: Sat, 10 Nov 2012 18:12:39 +0100
Subject: config manager: removed dead/commented code

---
 lib/plugins/config/settings/config.class.php | 13 -------------
 1 file changed, 13 deletions(-)

(limited to 'lib/plugins')

diff --git a/lib/plugins/config/settings/config.class.php b/lib/plugins/config/settings/config.class.php
index 8c48018d7..ebf638526 100644
--- a/lib/plugins/config/settings/config.class.php
+++ b/lib/plugins/config/settings/config.class.php
@@ -45,14 +45,8 @@ if (!class_exists('configuration')) {
         $this->_local_files = $config_cascade['main']['local'];
         $this->_protected_files = $config_cascade['main']['protected'];
 
-#        if (isset($file['default'])) $this->_default_file = $file['default'];
-#        if (isset($file['local'])) $this->_local_file = $file['local'];
-#        if (isset($file['protected'])) $this->_protected_file = $file['protected'];
-
         $this->locked = $this->_is_locked();
-
         $this->_metadata = array_merge($meta, $this->get_plugintpl_metadata($conf['template']));
-
         $this->retrieve_settings();
     }
 
@@ -147,7 +141,6 @@ if (!class_exists('configuration')) {
       if (!$file) return array();
 
       $config = array();
-#      $file = eval('return '.$file.';');
 
       if ($this->_format == 'php') {
 
@@ -195,9 +188,6 @@ if (!class_exists('configuration')) {
     function _out_footer() {
       $out = '';
       if ($this->_format == 'php') {
- #         if ($this->_protected_file) {
- #           $out .= "\n@include(".$this->_protected_file.");\n";
- #         }
           $out .= "\n// end auto-generated content\n";
       }
 
@@ -209,7 +199,6 @@ if (!class_exists('configuration')) {
     function _is_locked() {
       if (!$this->_local_files) return true;
 
-#      $local = eval('return '.$this->_local_file.';');
       $local = $this->_local_files[0];
 
       if (!is_writable(dirname($local))) return true;
@@ -425,8 +414,6 @@ if (!class_exists('setting')) {
       $out = '';
 
       if ($fmt=='php') {
-        // translation string needs to be improved FIXME
-        $tr = array("\n"=>'\n', "\r"=>'\r', "\t"=>'\t', "\\" => '\\\\', "'" => '\\\'');
         $tr = array("\\" => '\\\\', "'" => '\\\'');
 
         $out =  '$'.$var."['".$this->_out_key()."'] = '".strtr($this->_local, $tr)."';\n";
-- 
cgit v1.2.3


From b8f41ef0bac4e82cb3b02cd318efaddbaaeb1a78 Mon Sep 17 00:00:00 2001
From: Andreas Gohr <andi@splitbrain.org>
Date: Sat, 10 Nov 2012 18:13:09 +0100
Subject: config manager: let PHP parse the config file

Until now, the config manager did read and parse the various PHP config
files itself. This fails for more complex setups like arrays.

I'm not really sure why this was done. This patch replaces the parsing
with a simple include() call. Everything still seems to work.
---
 lib/plugins/config/settings/config.class.php | 25 +++----------------------
 1 file changed, 3 insertions(+), 22 deletions(-)

(limited to 'lib/plugins')

diff --git a/lib/plugins/config/settings/config.class.php b/lib/plugins/config/settings/config.class.php
index ebf638526..722c8df7b 100644
--- a/lib/plugins/config/settings/config.class.php
+++ b/lib/plugins/config/settings/config.class.php
@@ -139,32 +139,13 @@ if (!class_exists('configuration')) {
     function _read_config($file) {
 
       if (!$file) return array();
+      if (!file_exists($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++) {
-
-          // correct issues with the incoming data
-          // FIXME ... for now merge multi-dimensional array indices using ____
-          $key = preg_replace('/.\]\[./',CM_KEYMARKER,$matches[$i][1]);
-
-          // remove quotes from quoted strings & unescape escaped data
-          $value = preg_replace('/^(\'|")(.*)(?<!\\\\)\1$/s','$2',$matches[$i][2]);
-          $value = strtr($value, array('\\\\'=>'\\','\\\''=>'\'','\\"'=>'"'));
-
-          $config[$key] = $value;
-        }
+          include($file);
+          $config = ${$this->_name};
       }
 
       return $config;
-- 
cgit v1.2.3


From 60dd32d957e6c4ce2d969c45cc60497f55a39abe Mon Sep 17 00:00:00 2001
From: Andreas Gohr <andi@splitbrain.org>
Date: Sat, 10 Nov 2012 18:18:05 +0100
Subject: added 'array' type for config manager

This allows to use simple arrays in the config file but have a comma
separated list in the config manager.
---
 lib/plugins/config/settings/config.class.php    | 104 ++++++++++++++++++++++++
 lib/plugins/config/settings/config.metadata.php |   3 +
 2 files changed, 107 insertions(+)

(limited to 'lib/plugins')

diff --git a/lib/plugins/config/settings/config.class.php b/lib/plugins/config/settings/config.class.php
index 722c8df7b..e4a638eb0 100644
--- a/lib/plugins/config/settings/config.class.php
+++ b/lib/plugins/config/settings/config.class.php
@@ -435,6 +435,110 @@ if (!class_exists('setting')) {
   }
 }
 
+
+if (!class_exists('setting_array')) {
+    class setting_array extends setting {
+
+        /**
+         * Create an array from a string
+         *
+         * @param $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
+         * @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)
+         */
+        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;
+        }
+
+        protected function _escape($string) {
+            $tr = array("\\" => '\\\\', "'" => '\\\'');
+            return "'".strtr( cleanText($string), $tr)."'";
+        }
+
+        /**
+         * generate string to save setting value to file according to $fmt
+         */
+        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;
+        }
+
+        function html(&$plugin, $echo=false) {
+            $value = '';
+            $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);
+        }
+    }
+}
+
 if (!class_exists('setting_string')) {
   class setting_string extends setting {
     function html(&$plugin, $echo=false) {
diff --git a/lib/plugins/config/settings/config.metadata.php b/lib/plugins/config/settings/config.metadata.php
index 3607f56c6..582452917 100644
--- a/lib/plugins/config/settings/config.metadata.php
+++ b/lib/plugins/config/settings/config.metadata.php
@@ -32,6 +32,9 @@
  *                    separated list of checked choices
  *   'fieldset'     - used to group configuration settings, but is not itself a setting. To make this clear in
  *                    the language files the keys for this type should start with '_'.
+ *   'array'        - a simple (one dimensional) array of string values, shown as comma separated list in the
+ *                    config manager but saved as PHP array(). Values may not contain commas themselves.
+ *                    _pattern matching on the array values supported.
  *
  *  Single Setting (source: settings/extra.class.php)
  *  -------------------------------------------------
-- 
cgit v1.2.3


From d30b165d18ab3a6868d3b3e96e7bac782fb58441 Mon Sep 17 00:00:00 2001
From: Andreas Gohr <andi@splitbrain.org>
Date: Fri, 16 Nov 2012 13:28:15 +0100
Subject: Revert "config manager: let PHP parse the config file"

This reverts commit b8f41ef0bac4e82cb3b02cd318efaddbaaeb1a78.

We had good reasons for parsing the file ourselves. For example to keep
expressions like 7*60*60*24 intact.
---
 lib/plugins/config/settings/config.class.php | 25 ++++++++++++++++++++++---
 1 file changed, 22 insertions(+), 3 deletions(-)

(limited to 'lib/plugins')

diff --git a/lib/plugins/config/settings/config.class.php b/lib/plugins/config/settings/config.class.php
index e4a638eb0..e71a7e5f9 100644
--- a/lib/plugins/config/settings/config.class.php
+++ b/lib/plugins/config/settings/config.class.php
@@ -139,13 +139,32 @@ if (!class_exists('configuration')) {
     function _read_config($file) {
 
       if (!$file) return array();
-      if (!file_exists($file)) return array();
 
       $config = array();
 
       if ($this->_format == 'php') {
-          include($file);
-          $config = ${$this->_name};
+
+        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++) {
+
+          // correct issues with the incoming data
+          // FIXME ... for now merge multi-dimensional array indices using ____
+          $key = preg_replace('/.\]\[./',CM_KEYMARKER,$matches[$i][1]);
+
+          // remove quotes from quoted strings & unescape escaped data
+          $value = preg_replace('/^(\'|")(.*)(?<!\\\\)\1$/s','$2',$matches[$i][2]);
+          $value = strtr($value, array('\\\\'=>'\\','\\\''=>'\'','\\"'=>'"'));
+
+          $config[$key] = $value;
+        }
       }
 
       return $config;
-- 
cgit v1.2.3


From cba21baacb4880eefd35279b0589e035c5a5c78e Mon Sep 17 00:00:00 2001
From: Andreas Gohr <andi@splitbrain.org>
Date: Fri, 16 Nov 2012 13:59:17 +0100
Subject: started to add some unit tests to config manager

Parsing the config file should be completely tested before we can rely
on it and safely extend it. This just adds the first very basic tests.
---
 lib/plugins/config/_test/configuration.test.php | 31 +++++++++++++++++++++++++
 lib/plugins/config/_test/data/config.php        | 14 +++++++++++
 lib/plugins/config/_test/data/metadata.php      | 11 +++++++++
 lib/plugins/config/settings/config.class.php    |  3 +++
 4 files changed, 59 insertions(+)
 create mode 100644 lib/plugins/config/_test/configuration.test.php
 create mode 100644 lib/plugins/config/_test/data/config.php
 create mode 100644 lib/plugins/config/_test/data/metadata.php

(limited to 'lib/plugins')

diff --git a/lib/plugins/config/_test/configuration.test.php b/lib/plugins/config/_test/configuration.test.php
new file mode 100644
index 000000000..eeeff61a3
--- /dev/null
+++ b/lib/plugins/config/_test/configuration.test.php
@@ -0,0 +1,31 @@
+<?php
+
+class plugin_config_configuration_test extends DokuWikiTest {
+
+    private $config = '';
+    private $meta = '';
+
+    function __construct() {
+        $this->config = dirname(__FILE__).'/data/config.php';
+        $this->meta   = dirname(__FILE__).'/data/metadata.php';
+        require_once(dirname(__FILE__).'/../settings/config.class.php');
+    }
+
+    function test_readconfig() {
+        $confmgr = new configuration($this->meta);
+
+        $conf = $confmgr->_read_config($this->config);
+
+        //print_r($conf);
+
+        $this->assertEquals('42', $conf['int1']);
+        $this->assertEquals('6*7', $conf['int2']);
+
+        $this->assertEquals('Hello World', $conf['str1']);
+        $this->assertEquals('G\'day World', $conf['str2']);
+        $this->assertEquals('Hello World', $conf['str3']);
+        $this->assertEquals("Hello 'World'", $conf['str4']);
+        $this->assertEquals('Hello "World"', $conf['str5']);
+    }
+
+}
\ No newline at end of file
diff --git a/lib/plugins/config/_test/data/config.php b/lib/plugins/config/_test/data/config.php
new file mode 100644
index 000000000..4ed450e93
--- /dev/null
+++ b/lib/plugins/config/_test/data/config.php
@@ -0,0 +1,14 @@
+<?php
+
+
+$conf['int1'] = 42;
+$conf['int2'] = 6*7;
+
+$conf['str1']  = 'Hello World';
+$conf['str2']  = 'G\'day World';
+$conf['str3']  = "Hello World";
+$conf['str4']  = "Hello 'World'";
+$conf['str5']  = "Hello \"World\"";
+
+$conf['foo']['bar'] = 'x1';
+$conf['foo']['baz'] = 'x2';
diff --git a/lib/plugins/config/_test/data/metadata.php b/lib/plugins/config/_test/data/metadata.php
new file mode 100644
index 000000000..34ab42be7
--- /dev/null
+++ b/lib/plugins/config/_test/data/metadata.php
@@ -0,0 +1,11 @@
+<?php
+
+$meta['int1'] = array('numeric');
+$meta['int2'] = array('numeric');
+
+$meta['str1'] = array('string');
+$meta['str2'] = array('string');
+$meta['str3'] = array('string');
+$meta['str4'] = array('string');
+$meta['str5'] = array('string');
+
diff --git a/lib/plugins/config/settings/config.class.php b/lib/plugins/config/settings/config.class.php
index e71a7e5f9..5a2aa2980 100644
--- a/lib/plugins/config/settings/config.class.php
+++ b/lib/plugins/config/settings/config.class.php
@@ -6,6 +6,9 @@
  *  @author  Ben Coburn <btcoburn@silicodon.net>
  */
 
+
+if(!defined('CM_KEYMARKER')) define('CM_KEYMARKER','____');
+
 if (!class_exists('configuration')) {
 
   class configuration {
-- 
cgit v1.2.3


From a24fc53e2623640cf5e2d00de741c1b67c9bb294 Mon Sep 17 00:00:00 2001
From: Andreas Gohr <andi@splitbrain.org>
Date: Fri, 16 Nov 2012 14:48:14 +0100
Subject: added failing test for array type

---
 lib/plugins/config/_test/configuration.test.php | 2 ++
 lib/plugins/config/_test/data/config.php        | 2 ++
 lib/plugins/config/_test/data/metadata.php      | 2 ++
 3 files changed, 6 insertions(+)

(limited to 'lib/plugins')

diff --git a/lib/plugins/config/_test/configuration.test.php b/lib/plugins/config/_test/configuration.test.php
index eeeff61a3..ee03f3849 100644
--- a/lib/plugins/config/_test/configuration.test.php
+++ b/lib/plugins/config/_test/configuration.test.php
@@ -26,6 +26,8 @@ class plugin_config_configuration_test extends DokuWikiTest {
         $this->assertEquals('Hello World', $conf['str3']);
         $this->assertEquals("Hello 'World'", $conf['str4']);
         $this->assertEquals('Hello "World"', $conf['str5']);
+
+        $this->assertEquals(array('foo', 'bar', 'baz'), $conf['arr1']);
     }
 
 }
\ No newline at end of file
diff --git a/lib/plugins/config/_test/data/config.php b/lib/plugins/config/_test/data/config.php
index 4ed450e93..15d6359ad 100644
--- a/lib/plugins/config/_test/data/config.php
+++ b/lib/plugins/config/_test/data/config.php
@@ -10,5 +10,7 @@ $conf['str3']  = "Hello World";
 $conf['str4']  = "Hello 'World'";
 $conf['str5']  = "Hello \"World\"";
 
+$conf['arr1']  = array('foo','bar','baz');
+
 $conf['foo']['bar'] = 'x1';
 $conf['foo']['baz'] = 'x2';
diff --git a/lib/plugins/config/_test/data/metadata.php b/lib/plugins/config/_test/data/metadata.php
index 34ab42be7..12902e525 100644
--- a/lib/plugins/config/_test/data/metadata.php
+++ b/lib/plugins/config/_test/data/metadata.php
@@ -9,3 +9,5 @@ $meta['str3'] = array('string');
 $meta['str4'] = array('string');
 $meta['str5'] = array('string');
 
+$meta['arr1'] = array('array');
+
-- 
cgit v1.2.3