1: <?php
  2: /**
  3:  * A Horde_Form:: form that implements a user interface for the config
  4:  * system.
  5:  *
  6:  * Copyright 2002-2012 Horde LLC (http://www.horde.org/)
  7:  *
  8:  * See the enclosed file COPYING for license information (LGPL). If you
  9:  * did not receive this file, see http://www.horde.org/licenses/lgpl21.
 10:  *
 11:  * @author   Chuck Hagenbuch <chuck@horde.org>
 12:  * @category Horde
 13:  * @package  Core
 14:  */
 15: class Horde_Config_Form extends Horde_Form
 16: {
 17:     /**
 18:      * Don't use form tokens for the configuration form - while
 19:      * generating configuration info, things like the Token system
 20:      * might not work correctly. This saves some headaches.
 21:      *
 22:      * @var boolean
 23:      */
 24:     protected $_useFormToken = false;
 25: 
 26:     /**
 27:      * Contains the Horde_Config object that this form represents.
 28:      *
 29:      * @var Horde_Config
 30:      */
 31:     protected $_xmlConfig;
 32: 
 33:     /**
 34:      * Contains the Horde_Variables object of this form.
 35:      *
 36:      * @var Horde_Variables
 37:      */
 38:     protected $_vars;
 39: 
 40:     /**
 41:      * Whether to fill $this->_vars with values from the existing
 42:      * configuration.
 43:      *
 44:      * @var boolean
 45:      */
 46:     protected $_fillvars;
 47: 
 48:     /**
 49:      * Constructor.
 50:      *
 51:      * @param Horde_Variables &$vars  The variables object of this form.
 52:      * @param string $app             The name of the application that this
 53:      *                                configuration form is for.
 54:      * @param boolean $fillvars       Whether to fill the $vars object with
 55:      *                                values from the existing configuration.
 56:      *                                @since Horde_Core 1.1.
 57:      */
 58:     public function __construct(&$vars, $app, $fillvars = false)
 59:     {
 60:         parent::__construct($vars);
 61: 
 62:         $this->_xmlConfig = new Horde_Config($app);
 63:         $this->_vars = &$vars;
 64:         $this->_fillvars = $fillvars;
 65:         if ($fillvars) {
 66:             $vars->app = $app;
 67:         }
 68:         $config = $this->_xmlConfig->readXMLConfig();
 69:         $this->addHidden('', 'app', 'text', true);
 70:         $this->_buildVariables($config);
 71:     }
 72: 
 73:     /**
 74:      * Builds the form based on the specified level of the configuration tree.
 75:      *
 76:      * @param array $config   The portion of the configuration tree for that
 77:      *                        the form fields should be created.
 78:      * @param string $prefix  A string representing the current position
 79:      *                        inside the configuration tree.
 80:      */
 81:     protected function _buildVariables($config, $prefix = '')
 82:     {
 83:         if (!is_array($config)) {
 84:             return;
 85:         }
 86: 
 87:         foreach ($config as $name => $configitem) {
 88:             $prefixedname = empty($prefix) ? $name : $prefix . '|' . $name;
 89:             $varname = str_replace('|', '__', $prefixedname);
 90:             if ($configitem == 'placeholder') {
 91:                 continue;
 92:             } elseif (isset($configitem['tab'])) {
 93:                 $this->setSection($configitem['tab'], $configitem['desc']);
 94:             } elseif (isset($configitem['switch'])) {
 95:                 $selected = $this->_vars->getExists($varname, $wasset);
 96:                 $var_params = array();
 97:                 $select_option = true;
 98:                 if (is_bool($configitem['default'])) {
 99:                     $configitem['default'] = $configitem['default'] ? 'true' : 'false';
100:                 }
101:                 foreach ($configitem['switch'] as $option => $case) {
102:                     $var_params[$option] = $case['desc'];
103:                     if ($option == $configitem['default']) {
104:                         $select_option = false;
105:                         if (!$wasset) {
106:                             $selected = $option;
107:                         }
108:                     }
109:                 }
110: 
111:                 $name = '$conf[' . implode('][', explode('|', $prefixedname)) . ']';
112:                 $desc = $configitem['desc'];
113: 
114:                 $v = &$this->addVariable($name, $varname, 'enum', true, false, $desc, array($var_params, $select_option));
115:                 if (array_key_exists('default', $configitem)) {
116:                     $v->setDefault($configitem['default']);
117:                     if ($this->_fillvars) {
118:                         $this->_vars->set($varname, $configitem['default']);
119:                     }
120:                 }
121:                 if (!empty($configitem['is_default'])) {
122:                     $v->_new = true;
123:                 }
124:                 $v_action = Horde_Form_Action::factory('reload');
125:                 $v->setAction($v_action);
126:                 if (isset($selected) && isset($configitem['switch'][$selected])) {
127:                     $this->_buildVariables($configitem['switch'][$selected]['fields'], $prefix);
128:                 }
129:             } elseif (isset($configitem['_type'])) {
130:                 $required = (isset($configitem['required'])) ? $configitem['required'] : true;
131:                 $type = $configitem['_type'];
132: 
133:                 if (($type == 'header') || ($type == 'description')) {
134:                     $required = false;
135:                 }
136: 
137:                 $var_params = ($type == 'multienum' || $type == 'enum')
138:                     ? array($configitem['values'])
139:                     : array();
140: 
141:                 if ($type == 'header' || $type == 'description') {
142:                     $name = $configitem['desc'];
143:                     $desc = null;
144:                 } else {
145:                     $name = '$conf[' . implode('][', explode('|', $prefixedname)) . ']';
146:                     $desc = $configitem['desc'];
147:                     if ($type == 'php') {
148:                         $type = 'text';
149:                         $desc .= "\nEnter a valid PHP expression.";
150:                     }
151:                 }
152: 
153:                 $v = &$this->addVariable($name, $varname, $type, $required, false, $desc, $var_params);
154:                 if (isset($configitem['default'])) {
155:                     $v->setDefault($configitem['default']);
156:                     if ($this->_fillvars) {
157:                         switch ($type) {
158:                         case 'boolean':
159:                             if ($configitem['default']) {
160:                                 $this->_vars->set($varname, 'on');
161:                             }
162:                             break;
163:                         case 'int':
164:                             $this->_vars->set($varname, (string)$configitem['default']);
165:                             break;
166:                         default:
167:                             $this->_vars->set($varname, $configitem['default']);
168:                             break;
169:                         }
170:                     }
171:                 }
172:                 if (!empty($configitem['is_default'])) {
173:                     $v->_new = true;
174:                 }
175:             } else {
176:                 $this->_buildVariables($configitem, $prefixedname);
177:             }
178:         }
179:     }
180: 
181: }
182: