config plugin

darcs-hash:20060125001546-9b6ab-02a6255db9adc4dc22f4970b01a3b148d2b1810c.gz

1 files changed, 173 insertions, 0 deletions

diff --git a/lib/plugins/config/admin.php b/lib/plugins/config/admin.php
new file mode 100644
index 000000000..41ec9cbbe
--- /dev/null
+++ b/lib/plugins/config/admin.php
@@ -0,0 +1,173 @@
+<?php
+/**
+ * Configuration Manager admin plugin
+ *
+ * @license    GPL 2 (http://www.gnu.org/licenses/gpl.html)
+ * @author     Christopher Smith <chris@jalakai.co.uk>
+ */
+
+if(!defined('DOKU_INC')) define('DOKU_INC',realpath(dirname(__FILE__).'/../../').'/');
+if(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
+require_once(DOKU_PLUGIN.'admin.php');
+
+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');
+
+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
+
+/**
+ * All DokuWiki plugins to extend the admin function
+ * need to inherit from this class
+ */
+class admin_plugin_config extends DokuWiki_Admin_Plugin {
+
+    var $_file = PLUGIN_METADATA;
+    var $_config = null;
+    var $_input = null;
+    var $_changed = false;          // set to true if configuration has altered
+    var $_error = false;
+    var $_session_started = false;
+
+    /**
+     * return some info
+     */
+    function getInfo(){
+
+      return array(
+        'author' => 'Christopher Smith',
+        'email'  => 'chris@jalakai.co.uk',
+        'date'   => '2006-01-24',
+        'name'   => 'Configuration Manager',
+        'desc'   => "Manage Dokuwiki's Configuration Settings",
+        'url'    => 'http://wiki.splitbrain.org/plugin:config',
+      );
+    }
+
+    function getMenuSort() { return 100; }
+
+    /**
+     * handle user request
+     */
+    function handle() {
+    
+      if (!$this->_restore_session()) return $this->_close_session();
+      if (!isset($_REQUEST['save']) || ($_REQUEST['save'] != 1)) return $this->_close_session();
+            
+      if (is_null($this->_config)) { $this->_config = new configuration($this->_file); }
+      
+      // don't go any further if the configuration is locked
+      if ($this->_config->_locked) return $this->_close_session();
+      
+      $this->_input = $_REQUEST['config'];
+
+      while (list($key) = each($this->_config->setting)) {
+        $input = isset($this->_input[$key]) ? $this->_input[$key] : NULL;
+        if ($this->_config->setting[$key]->update($input)) {
+          $this->_changed = true;
+        }
+        if ($this->_config->setting[$key]->error()) $this->_error = true;
+      }
+      
+      if ($this->_changed  && !$this->_error) {
+        $this->_config->save_settings($this->getPluginName());
+        
+        // save state & force a page reload to get the new settings to take effect
+        $_SESSION['PLUGIN_CONFIG'] = array('state' => 'updated', 'time' => time());
+        $this->_close_session();
+        header("Location: ".wl($ID)."?do=admin&page=config");
+        exit();
+      }
+      
+      $this->_close_session();
+    }
+
+    /**
+     * output appropriate html
+     */
+    function html() { 
+      global $lang;  
+    
+      if (is_null($this->_config)) { $this->_config = new configuration($this->_file); }
+
+      print $this->locale_xhtml('intro');
+      
+      ptln('<div id="configmanager">');
+      
+      if ($this->_config->locked)
+        ptln('<p class="info">'.$this->getLang('locked').'</p>');
+      elseif ($this->_error) 
+        ptln('<p class="error">'.$this->getLang('error').'</p>');
+      elseif ($this->_changed)
+        ptln('<p class="ok">'.$this->getLang('updated').'</p>');
+      
+      ptln('<form action="'.wl($id).'" method="post">');
+      ptln('  <table class="inline">');
+      
+      foreach($this->_config->setting as $setting) {
+      
+        list($label,$input) = $setting->html($this, $this->_error);
+        
+        $class = $setting->is_default() ? ' class="default"' : ($setting->is_protected() ? ' class="protected"' : '');        
+        $error = $setting->error() ? ' class="error"' : '';
+        
+        ptln('    <tr'.$class.'>');
+        ptln('      <td>'.$label.'</td>');
+        ptln('      <td'.$error.'>'.$input.'</td>');
+        ptln('    </tr>');
+      }
+      
+      ptln('  </table>');
+      
+      ptln('<p>');
+      ptln('  <input type="hidden" name="do"     value="admin" />');
+      ptln('  <input type="hidden" name="page"   value="config" />');
+      
+      if (!$this->_config->locked) {
+        ptln('  <input type="hidden" name="save"   value="1" />');
+        ptln('  <input type="submit" name="submit" value="'.$lang['btn_save'].'" />');
+        ptln('  <input type="reset" value="'.$lang['btn_reset'].'" />');
+      }
+      
+      ptln('</p>');
+      
+      ptln('</form>');
+      ptln('</div>');
+    }
+    
+    /**
+     * @return boolean   true - proceed with handle, false - don't proceed
+     */
+    function _restore_session() {
+    
+      // dokuwiki closes the session before act_dispatch. $_SESSION variables are all set, 
+      // however they can't be changed without starting the session again      
+      if (!headers_sent()) {
+        session_start();
+        $this->_session_started = true;
+      }      
+      
+      if (!isset($_SESSION['PLUGIN_CONFIG'])) return true;
+      
+      $session = $_SESSION['PLUGIN_CONFIG'];
+      unset($_SESSION['PLUGIN_CONFIG']);
+              
+      // still valid?
+      if (time() - $session['time'] > 120) return true;
+        
+      switch ($session['state']) {
+        case 'updated' :
+          $this->_changed = true;
+          return false;
+      }
+      
+      return true;
+    }
+    
+    function _close_session() {
+      if ($this->_session_started) session_write_close();
+    }
+    
+}