3.3
This commit is contained in:
Marc Delisle
586
setup/lib/FormDisplay.class.php
Normal file
586
setup/lib/FormDisplay.class.php
Normal file
@@ -0,0 +1,586 @@
|
||||
<?php
|
||||
/**
|
||||
* Form management class, displays and processes forms
|
||||
*
|
||||
* Explanation of used terms:
|
||||
* o work_path - original field path, eg. Servers/4/verbose
|
||||
* o system_path - work_path modified so that it points to the first server, eg. Servers/1/verbose
|
||||
* o translated_path - work_path modified for HTML field name, a path with
|
||||
* slashes changed to hyphens, eg. Servers-4-verbose
|
||||
*
|
||||
* @package phpMyAdmin-setup
|
||||
* @author Piotr Przybylski <piotrprz@gmail.com>
|
||||
* @license http://www.gnu.org/licenses/gpl.html GNU GPL 2.0
|
||||
* @version $Id$
|
||||
*/
|
||||
|
||||
/**
|
||||
* Core libraries.
|
||||
*/
|
||||
require_once './setup/lib/FormDisplay.tpl.php';
|
||||
require_once './setup/lib/validate.lib.php';
|
||||
require_once './libraries/js_escape.lib.php';
|
||||
|
||||
/**
|
||||
* Form management class, displays and processes forms
|
||||
* @package phpMyAdmin-setup
|
||||
*/
|
||||
class FormDisplay
|
||||
{
|
||||
/**
|
||||
* Form list
|
||||
* @var array
|
||||
*/
|
||||
private $forms = array();
|
||||
|
||||
/**
|
||||
* Stores validation errors, indexed by paths
|
||||
* [ Form_name ] is an array of form errors
|
||||
* [path] is a string storing error associated with single field
|
||||
* @var array
|
||||
*/
|
||||
private $errors = array();
|
||||
|
||||
/**
|
||||
* Paths changed so that they can be used as HTML ids, indexed by paths
|
||||
* @var array
|
||||
*/
|
||||
private $translated_paths = array();
|
||||
|
||||
/**
|
||||
* Server paths change indexes so we define maps from current server
|
||||
* path to the first one, indexed by work path
|
||||
* @var array
|
||||
*/
|
||||
private $system_paths = array();
|
||||
|
||||
/**
|
||||
* Language strings which will be sent to PMA_messages JS variable
|
||||
* Will be looked up in $GLOBALS: str{value} or strSetup{value}
|
||||
* @var array
|
||||
*/
|
||||
private $js_lang_strings = array('error_nan_p', 'error_nan_nneg',
|
||||
'error_incorrect_port');
|
||||
|
||||
/**
|
||||
* Tells whether forms have been validated
|
||||
* @var bool
|
||||
*/
|
||||
private $is_valdiated = true;
|
||||
|
||||
/**
|
||||
* Registers form in form manager
|
||||
*
|
||||
* @param string $form_name
|
||||
* @param int $server_id 0 if new server, validation; >= 1 if editing a server
|
||||
*/
|
||||
public function registerForm($form_name, $server_id = null)
|
||||
{
|
||||
$this->forms[$form_name] = new Form($form_name, $server_id);
|
||||
$this->is_valdiated = false;
|
||||
foreach ($this->forms[$form_name]->fields as $path) {
|
||||
$work_path = $server_id === null
|
||||
? $path
|
||||
: str_replace('Servers/1/', "Servers/$server_id/", $path);
|
||||
$this->system_paths[$work_path] = $path;
|
||||
$this->translated_paths[$work_path] = str_replace('/', '-', $work_path);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Processes forms, returns true on successful save
|
||||
*
|
||||
* @param bool $allow_partial_save allows for partial form saving on failed validation
|
||||
* @return boolean
|
||||
*/
|
||||
public function process($allow_partial_save = true)
|
||||
{
|
||||
// gather list of forms to save
|
||||
if (!isset($_POST['submit_save'])) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// save forms
|
||||
if (count($this->forms) > 0) {
|
||||
return $this->save(array_keys($this->forms), $allow_partial_save);
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Runs validation for all registered forms
|
||||
*/
|
||||
private function _validate()
|
||||
{
|
||||
if ($this->is_valdiated) {
|
||||
return;
|
||||
}
|
||||
|
||||
$cf = ConfigFile::getInstance();
|
||||
$paths = array();
|
||||
$values = array();
|
||||
foreach ($this->forms as $form) {
|
||||
/* @var $form Form */
|
||||
$paths[] = $form->name;
|
||||
// collect values and paths
|
||||
foreach ($form->fields as $path) {
|
||||
$work_path = array_search($path, $this->system_paths);
|
||||
$values[$path] = $cf->getValue($work_path);
|
||||
$paths[] = $path;
|
||||
}
|
||||
}
|
||||
|
||||
// run validation
|
||||
$errors = validate($paths, $values, false);
|
||||
|
||||
// change error keys from canonical paths to work paths
|
||||
if (is_array($errors) && count($errors) > 0) {
|
||||
$this->errors = array();
|
||||
foreach ($errors as $path => $error_list) {
|
||||
$work_path = array_search($path, $this->system_paths);
|
||||
// field error
|
||||
if (!$work_path) {
|
||||
// form error, fix path
|
||||
$work_path = $path;
|
||||
}
|
||||
$this->errors[$work_path] = $error_list;
|
||||
}
|
||||
}
|
||||
$this->is_valdiated = true;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Outputs HTML for forms
|
||||
*
|
||||
* @param bool $tabbed_form
|
||||
* @param bool $show_restore_default whether show "restore default" button besides the input field
|
||||
*/
|
||||
public function display($tabbed_form = false, $show_restore_default = false)
|
||||
{
|
||||
static $js_lang_sent = false;
|
||||
|
||||
$js = array();
|
||||
$js_default = array();
|
||||
$tabbed_form = $tabbed_form && (count($this->forms) > 1);
|
||||
$validators = ConfigFile::getInstance()->getDbEntry('_validators');
|
||||
|
||||
display_form_top();
|
||||
|
||||
if ($tabbed_form) {
|
||||
$tabs = array();
|
||||
foreach ($this->forms as $form) {
|
||||
$tabs[$form->name] = PMA_lang("Form_$form->name");
|
||||
}
|
||||
display_tabs_top($tabs);
|
||||
}
|
||||
|
||||
// valdiate only when we aren't displaying a "new server" form
|
||||
$is_new_server = false;
|
||||
foreach ($this->forms as $form) {
|
||||
/* @var $form Form */
|
||||
if ($form->index === 0) {
|
||||
$is_new_server = true;
|
||||
break;
|
||||
}
|
||||
}
|
||||
if (!$is_new_server) {
|
||||
$this->_validate();
|
||||
}
|
||||
|
||||
// display forms
|
||||
foreach ($this->forms as $form) {
|
||||
/* @var $form Form */
|
||||
$form_desc = isset($GLOBALS["strSetupForm_{$form->name}_desc"])
|
||||
? PMA_lang("Form_{$form->name}_desc")
|
||||
: '';
|
||||
$form_errors = isset($this->errors[$form->name])
|
||||
? $this->errors[$form->name] : null;
|
||||
display_fieldset_top(PMA_lang("Form_$form->name"),
|
||||
$form_desc, $form_errors, array('id' => $form->name));
|
||||
|
||||
foreach ($form->fields as $field => $path) {
|
||||
$work_path = array_search($path, $this->system_paths);
|
||||
$translated_path = $this->translated_paths[$work_path];
|
||||
// display input
|
||||
$this->_displayFieldInput($form, $field, $path, $work_path,
|
||||
$translated_path, $show_restore_default, $js_default);
|
||||
// register JS validators for this field
|
||||
if (isset($validators[$path])) {
|
||||
js_validate($translated_path, $validators[$path], $js);
|
||||
}
|
||||
}
|
||||
display_fieldset_bottom();
|
||||
}
|
||||
|
||||
if ($tabbed_form) {
|
||||
display_tabs_bottom();
|
||||
}
|
||||
display_form_bottom();
|
||||
|
||||
// if not already done, send strings used for valdiation to JavaScript
|
||||
if (!$js_lang_sent) {
|
||||
$js_lang_sent = true;
|
||||
$js_lang = array();
|
||||
foreach ($this->js_lang_strings as $str) {
|
||||
$lang = isset($GLOBALS["strSetup$str"])
|
||||
? $GLOBALS["strSetup$str"]
|
||||
: filter_input($GLOBALS["str$str"]); // null if not set
|
||||
$js_lang[] = "'$str': '" . PMA_jsFormat($lang, false) . '\'';
|
||||
}
|
||||
$js[] = '$extend(PMA_messages, {' . implode(",\n\t", $js_lang) . '})';
|
||||
}
|
||||
|
||||
$js[] = '$extend(defaultValues, {' . implode(",\n\t", $js_default) . '})';
|
||||
display_js($js);
|
||||
}
|
||||
|
||||
/**
|
||||
* Prepares data for input field display and outputs HTML code
|
||||
*
|
||||
* @param Form $form
|
||||
* @param string $field field name as it appears in $form
|
||||
* @param string $system_path field path, eg. Servers/1/verbose
|
||||
* @param string $work_path work path, eg. Servers/4/verbose
|
||||
* @param string $translated_path work path changed so that it can be used as XHTML id
|
||||
* @param bool $show_restore_default whether show "restore default" button besides the input field
|
||||
* @param array &$js_default array which stores JavaScript code to be displayed
|
||||
*/
|
||||
private function _displayFieldInput(Form $form, $field, $system_path, $work_path,
|
||||
$translated_path, $show_restore_default, array &$js_default)
|
||||
{
|
||||
$name = PMA_lang_name($system_path);
|
||||
$description = PMA_lang_desc($system_path);
|
||||
|
||||
$cf = ConfigFile::getInstance();
|
||||
$value = $cf->get($work_path);
|
||||
$value_default = $cf->getDefault($system_path);
|
||||
$value_is_default = false;
|
||||
if ($value === null || $value === $value_default) {
|
||||
$value = $value_default;
|
||||
$value_is_default = true;
|
||||
}
|
||||
|
||||
$opts = array(
|
||||
'doc' => $this->getDocLink($system_path),
|
||||
'wiki' => $this->getWikiLink($system_path),
|
||||
'show_restore_default' => $show_restore_default);
|
||||
if (isset($form->default[$system_path])) {
|
||||
$opts['setvalue'] = $form->default[$system_path];
|
||||
}
|
||||
|
||||
if (isset($this->errors[$work_path])) {
|
||||
$opts['errors'] = $this->errors[$work_path];
|
||||
}
|
||||
switch ($form->getOptionType($field)) {
|
||||
case 'string':
|
||||
$type = 'text';
|
||||
break;
|
||||
case 'double':
|
||||
$type = 'text';
|
||||
break;
|
||||
case 'integer':
|
||||
$type = 'text';
|
||||
break;
|
||||
case 'boolean':
|
||||
$type = 'checkbox';
|
||||
break;
|
||||
case 'select':
|
||||
$type = 'select';
|
||||
$opts['values'] = array();
|
||||
$values = $form->getOptionValueList($form->fields[$field]);
|
||||
foreach ($values as $v) {
|
||||
$opts['values'][$v] = $v;
|
||||
}
|
||||
break;
|
||||
case 'array':
|
||||
$type = 'list';
|
||||
$value = (array) $value;
|
||||
$value_default = (array) $value_default;
|
||||
break;
|
||||
case 'NULL':
|
||||
trigger_error("Field $system_path has no type", E_USER_WARNING);
|
||||
return;
|
||||
}
|
||||
|
||||
// TrustedProxies requires changes before displaying
|
||||
if ($system_path == 'TrustedProxies') {
|
||||
foreach ($value as $ip => &$v) {
|
||||
if (!preg_match('/^-\d+$/', $ip)) {
|
||||
$v = $ip . ': ' . $v;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// send default value to form's JS
|
||||
$js_line = '\'' . $translated_path . '\': ';
|
||||
switch ($type) {
|
||||
case 'text':
|
||||
$js_line .= '\'' . PMA_escapeJsString($value_default) . '\'';
|
||||
break;
|
||||
case 'checkbox':
|
||||
$js_line .= $value_default ? 'true' : 'false';
|
||||
break;
|
||||
case 'select':
|
||||
$value_default_js = is_bool($value_default)
|
||||
? (int) $value_default
|
||||
: $value_default;
|
||||
$js_line .= '[\'' . PMA_escapeJsString($value_default_js) . '\']';
|
||||
break;
|
||||
case 'list':
|
||||
$js_line .= '\'' . PMA_escapeJsString(implode("\n", $value_default)) . '\'';
|
||||
break;
|
||||
}
|
||||
$js_default[] = $js_line;
|
||||
|
||||
display_input($translated_path, $name, $description, $type,
|
||||
$value, $value_is_default, $opts);
|
||||
}
|
||||
|
||||
/**
|
||||
* Displays errors
|
||||
*/
|
||||
public function displayErrors()
|
||||
{
|
||||
$this->_validate();
|
||||
if (count($this->errors) == 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
foreach ($this->errors as $system_path => $error_list) {
|
||||
if (isset($this->system_paths[$system_path])) {
|
||||
$path = $this->system_paths[$system_path];
|
||||
$name = PMA_lang_name($path);
|
||||
} else {
|
||||
$name = $GLOBALS["strSetupForm_$system_path"];
|
||||
}
|
||||
display_errors($name, $error_list);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Reverts erroneous fields to their default values
|
||||
*/
|
||||
public function fixErrors()
|
||||
{
|
||||
$this->_validate();
|
||||
if (count($this->errors) == 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
$cf = ConfigFile::getInstance();
|
||||
foreach (array_keys($this->errors) as $work_path) {
|
||||
if (!isset($this->system_paths[$work_path])) {
|
||||
continue;
|
||||
}
|
||||
$canonical_path = $this->system_paths[$work_path];
|
||||
$cf->set($work_path, $cf->getDefault($canonical_path));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Validates select field and casts $value to correct type
|
||||
*
|
||||
* @param string $value
|
||||
* @param array $allowed
|
||||
* @return bool
|
||||
*/
|
||||
private function _validateSelect(&$value, array $allowed)
|
||||
{
|
||||
foreach ($allowed as $v) {
|
||||
if ($value == $v) {
|
||||
settype($value, gettype($v));
|
||||
return true;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Validates and saves form data to session
|
||||
*
|
||||
* @param array|string $forms array of form names
|
||||
* @param bool $allow_partial_save allows for partial form saving on failed validation
|
||||
* @return boolean true on success (no errors and all saved)
|
||||
*/
|
||||
public function save($forms, $allow_partial_save = true)
|
||||
{
|
||||
$result = true;
|
||||
$cf = ConfigFile::getInstance();
|
||||
$forms = (array) $forms;
|
||||
|
||||
$values = array();
|
||||
$to_save = array();
|
||||
$this->errors = array();
|
||||
foreach ($forms as $form) {
|
||||
/* @var $form Form */
|
||||
if (isset($this->forms[$form])) {
|
||||
$form = $this->forms[$form];
|
||||
} else {
|
||||
continue;
|
||||
}
|
||||
// get current server id
|
||||
$change_index = $form->index === 0
|
||||
? $cf->getServerCount() + 1
|
||||
: false;
|
||||
// grab POST values
|
||||
foreach ($form->fields as $field => $system_path) {
|
||||
$work_path = array_search($system_path, $this->system_paths);
|
||||
$key = $this->translated_paths[$work_path];
|
||||
|
||||
// ensure the value is set
|
||||
if (!isset($_POST[$key])) {
|
||||
// checkboxes aren't set by browsers if they're off
|
||||
if ($form->getOptionType($field) == 'boolean') {
|
||||
$_POST[$key] = false;
|
||||
} else {
|
||||
$this->errors[$form->name][] = PMA_lang(
|
||||
'error_missing_field_data',
|
||||
'<i>' . PMA_lang_name($system_path) . '</i>');
|
||||
$result = false;
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
// cast variables to correct type
|
||||
$type = $form->getOptionType($field);
|
||||
switch ($type) {
|
||||
case 'double':
|
||||
settype($_POST[$key], 'float');
|
||||
break;
|
||||
case 'boolean':
|
||||
case 'integer':
|
||||
if ($_POST[$key] !== '') {
|
||||
settype($_POST[$key], $type);
|
||||
}
|
||||
break;
|
||||
case 'select':
|
||||
if (!$this->_validateSelect($_POST[$key], $form->getOptionValueList($system_path))) {
|
||||
$this->errors[$work_path][] = $GLOBALS["strstrSetuperror_incorrect_value"];
|
||||
$result = false;
|
||||
continue;
|
||||
}
|
||||
break;
|
||||
case 'string':
|
||||
$_POST[$key] = trim($_POST[$key]);
|
||||
break;
|
||||
case 'array':
|
||||
// eliminate empty values and ensure we have an array
|
||||
$post_values = explode("\n", $_POST[$key]);
|
||||
$_POST[$key] = array();
|
||||
foreach ($post_values as $v) {
|
||||
$v = trim($v);
|
||||
if ($v !== '') {
|
||||
$_POST[$key][] = $v;
|
||||
}
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
// now we have value with proper type
|
||||
$values[$system_path] = $_POST[$key];
|
||||
if ($change_index !== false) {
|
||||
$work_path = str_replace("Servers/$form->index/",
|
||||
"Servers/$change_index/", $work_path);
|
||||
}
|
||||
$to_save[$work_path] = $system_path;
|
||||
}
|
||||
}
|
||||
|
||||
// save forms
|
||||
if ($allow_partial_save || empty($this->errors)) {
|
||||
foreach ($to_save as $work_path => $path) {
|
||||
// TrustedProxies requires changes before saving
|
||||
if ($path == 'TrustedProxies') {
|
||||
$proxies = array();
|
||||
$i = 0;
|
||||
foreach ($values[$path] as $value) {
|
||||
$matches = array();
|
||||
if (preg_match("/^(.+):(?:[ ]?)(\\w+)$/", $value, $matches)) {
|
||||
// correct 'IP: HTTP header' pair
|
||||
$ip = trim($matches[1]);
|
||||
$proxies[$ip] = trim($matches[2]);
|
||||
} else {
|
||||
// save also incorrect values
|
||||
$proxies["-$i"] = $value;
|
||||
$i++;
|
||||
}
|
||||
}
|
||||
$values[$path] = $proxies;
|
||||
}
|
||||
$cf->set($work_path, $values[$path], $path);
|
||||
}
|
||||
}
|
||||
|
||||
// don't look for non-critical errors
|
||||
$this->_validate();
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Tells whether form validation failed
|
||||
*
|
||||
* @return boolean
|
||||
*/
|
||||
public function hasErrors()
|
||||
{
|
||||
return count($this->errors) > 0;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Returns link to documentation
|
||||
*
|
||||
* @param string $path
|
||||
* @return string
|
||||
*/
|
||||
public function getDocLink($path)
|
||||
{
|
||||
$test = substr($path, 0, 6);
|
||||
if ($test == 'Import' || $test == 'Export') {
|
||||
return '';
|
||||
}
|
||||
return '../Documentation.html#cfg_' . self::_getOptName($path);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns link to wiki
|
||||
*
|
||||
* @param string $path
|
||||
* @return string
|
||||
*/
|
||||
public function getWikiLink($path)
|
||||
{
|
||||
$opt_name = self::_getOptName($path);
|
||||
if (substr($opt_name, 0, 7) == 'Servers') {
|
||||
$opt_name = substr($opt_name, 8);
|
||||
if (strpos($opt_name, 'AllowDeny') === 0) {
|
||||
$opt_name = str_replace('_', '_.28', $opt_name) . '.29';
|
||||
}
|
||||
}
|
||||
$test = substr($path, 0, 6);
|
||||
if ($test == 'Import') {
|
||||
$opt_name = substr($opt_name, 7);
|
||||
if ($opt_name == 'format') {
|
||||
$opt_name = 'format_2';
|
||||
}
|
||||
}
|
||||
if ($test == 'Export') {
|
||||
$opt_name = substr($opt_name, 7);
|
||||
}
|
||||
return 'http://wiki.phpmyadmin.net/pma/Config#' . $opt_name;
|
||||
}
|
||||
|
||||
/**
|
||||
* Changes path so it can be used in URLs
|
||||
*
|
||||
* @param string $path
|
||||
* @return string
|
||||
*/
|
||||
private static function _getOptName($path)
|
||||
{
|
||||
return str_replace(array('Servers/1/', '/'), array('Servers/', '_'), $path);
|
||||
}
|
||||
}
|
||||
?>
|
||||
Reference in New Issue
Block a user