holm/egroupware
1
1
Fork 0
forked from extern/egroupware
Code Issues Pull Requests Packages Projects Releases Wiki Activity

validation for vfs_* types, implemented textarea type, not yet implemented is notiy, but uses textarea now

Browse Source
This commit is contained in:
Ralf Becker 2013-05-10 07:50:30 +00:00
parent af6c57208a
commit b235658a1c
4 changed files with 105 additions and 85 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

179
preferences/inc/class.preferences_settings.inc.php
View File

@ -70,14 +70,23 @@ class preferences_settings
// ToDo: save preferences // ToDo: save preferences
$appname = $content['old_appname'] ? $content['old_appname'] : 'common'; $appname = $content['old_appname'] ? $content['old_appname'] : 'common';
list($type,$account_id) = explode(':', $content['old_type']); list($type,$account_id) = explode(':', $content['old_type']);
$prefs = array_merge($content['tab1'], $content['tab2'], $content['tab3'], $content['tab4']); // merge prefs of all tabs together again
$prefs = array();
foreach($content as $name => $val)
{
if (is_array($val) && strpos($name, 'tab') === 0)
{
$prefs = array_merge($prefs, $val);
}
}
error_log(__METHOD__."() button=$button, content=".array2string($content).' --> prefs='.array2string($prefs));;;
if ($account_id && $account_id != $GLOBALS['egw']->preferences->account_id) if ($account_id && $account_id != $GLOBALS['egw']->preferences->account_id)
{ {
$GLOBALS['egw']->preferences->account_id = $account_id; $GLOBALS['egw']->preferences->account_id = $account_id;
$GLOBALS['egw']->preferences->read_repository(); $GLOBALS['egw']->preferences->read_repository();
} }
$attribute = $type == 'group' ? 'user' : $type; $attribute = $type == 'group' ? 'user' : $type;
if (!($msg=$this->process_array($GLOBALS['egw']->preferences->$attribute, $prefs, null, $appname, $attribute))) if (!($msg=$this->process_array($GLOBALS['egw']->preferences->$attribute, $prefs, $content['types'], $appname, $attribute)))
{ {
$msg = lang('Preferences saved.'); //.array2string($prefs); $msg = lang('Preferences saved.'); //.array2string($prefs);
} }
@ -91,41 +100,47 @@ class preferences_settings
list($type,$account_id) = explode(':', $content['type']); list($type,$account_id) = explode(':', $content['type']);
//_debug_array($prefs); //_debug_array($prefs);
} }
// if not just saved, call validation before, to be able to show failed validation of current prefs
if (!isset($button))
{
$attribute = $type == 'group' ? 'user' : $type;
$msg = $this->process_array($GLOBALS['egw']->preferences->$attribute,
$GLOBALS['egw']->preferences->{$attribute}[$appname], null, $appname, $attribute, true);
}
if ($account_id && $account_id != $GLOBALS['egw']->preferences->account_id) if ($account_id && $account_id != $GLOBALS['egw']->preferences->account_id)
{ {
$GLOBALS['egw']->preferences->account_id = $account_id; $GLOBALS['egw']->preferences->account_id = $account_id;
$GLOBALS['egw']->preferences->read_repository(); $GLOBALS['egw']->preferences->read_repository();
} }
$content = $this->get_content($appname, $type, $sel_options, $readonlys, $tpl); $preserve = array(
$content['msg'] = $msg;
$tpl->exec('preferences.preferences_settings.index', $content, $sel_options, $readonlys, array(
'appname' => $content['appname'], 'appname' => $content['appname'],
'type' => $content['type'], 'type' => $content['type'],
'old_appname' => $content['appname'], 'old_appname' => $content['appname'],
'old_type' => $content['type'], 'old_type' => $content['type'],
)); 'types' => array(),
);
if ($button == 'apply') $old_tab = $content['tabs'];
$content = $this->get_content($appname, $type, $sel_options, $readonlys, $preserve['types'], $tpl);
error_log(__METHOD__."() preserve=".array2string($preserve));
if ($button == 'apply') $content['tabs'] = $old_tab;
// if not just saved, call validation before, to be able to show failed validation of current prefs
if (!isset($button))
{
$attribute = $type == 'group' ? 'user' : $type;
$msg = $this->process_array($GLOBALS['egw']->preferences->$attribute,
$GLOBALS['egw']->preferences->{$attribute}[$appname], $preserve['types'], $appname, $attribute, true);
}
$content['msg'] = $msg;
$tpl->exec('preferences.preferences_settings.index', $content, $sel_options, $readonlys, $preserve);
} }
/** /**
* Verify and save preferences * Verify and save preferences
* *
* @param array &$repository * @param array &$repository values get updated here
* @param array $values * @param array $values new values
* @param array $notifies * @param array $types setting-name => type
* @param string $appname appname or 'common' * @param string $appname appname or 'common'
* @param string $type * @param string $type 'user', 'default', 'forced'
* @param boolean $only_verify=false * @param boolean $only_verify=false
* @return string with verification error or null on success * @return string with verification error or null on success
*/ */
function process_array(&$repository, $values, $notifies, $appname, $type, $only_verify=false) function process_array(array &$repository, array $values, array $types=null, $appname, $type, $only_verify=false)
{ {
//_debug_array($repository); //_debug_array($repository);
$prefs = &$repository[$appname]; $prefs = &$repository[$appname];
@ -134,72 +149,68 @@ class preferences_settings
//_debug_array($values);exit; //_debug_array($values);exit;
foreach($values as $var => $value) foreach($values as $var => $value)
{ {
if(isset($value) && $value !== '' && $value !== '**NULL**') error_log(__METHOD__."() types[var='$var']='{$types[$var]}', value=".array2string($value));
// type specific validation
switch((string)$types[$var])
{ {
if (is_array($value)) case 'password': // dont write empty password-fields
{ if (empty($value)) continue 2;
if (isset($value['pw'])) break;
case 'vfs_file':
case 'vfs_dir':
case 'vfs_dirs':
if ($value === '')
{ {
$value = $value['pw']; // empty is always allowed
if(empty($value))
// If forced, empty == not set
if($type == 'forced')
{ {
continue; // dont write empty password-fields unset($prefs[$var]);
// need to call preferences::delete, to also set affective prefs!
if (!$only_verify) $GLOBALS['egw']->preferences->delete($appname, $var, $type);
continue 2;
} }
} }
elseif(isset($value[$vfs_type='vfs_file']) || isset($value[$vfs_type='vfs_dir']) || isset($value[$vfs_type='vfs_dirs'])) elseif ($types[$var] == 'vfs_file')
{ {
$value = $value[$vfs_type]; if ($value[0] != '/' || !egw_vfs::stat($value) || egw_vfs::is_dir($value))
if ($value === '')
{ {
// empty is always allowed $error = lang('%1 is no existing vfs file!',htmlspecialchars($value));
// If forced, empty == not set
if($type == 'forced')
{
unset($prefs[$var]);
// need to call preferences::delete, to also set affective prefs!
if (!$only_verify) $GLOBALS['egw']->preferences->delete($appname, $var, $type);
continue;
}
}
elseif ($vfs_type == 'vfs_file')
{
if ($value[0] != '/' || !egw_vfs::stat($value))
{
$error = lang('%1 is no existing vfs file!',htmlspecialchars($value));
}
}
else
{
// split multiple comma or whitespace separated directories
// to still allow space or comma in dirnames, we also use the trailing slash of all pathes to split
foreach($vfs_type == 'vfs_dir' ? array($value) : preg_split('/[,\s]+\//', $value) as $n => $dir)
{
if ($n) $dir = '/'.$dir; // re-adding trailing slash removed by split
if ($dir[0] != '/' || !egw_vfs::stat($dir) || !egw_vfs::is_dir($dir))
{
$error .= ($error ? ' ' : '').lang('%1 is no existing vfs directory!',$dir);
}
}
} }
} }
else else
{ {
$value = implode(',',$value); // multiselect // split multiple comma or whitespace separated directories
// to still allow space or comma in dirnames, we also use the trailing slash of all pathes to split
foreach($types[$var] == 'vfs_dir' ? array($value) : preg_split('/[,\s]+\//', $value) as $n => $dir)
{
if ($n) $dir = '/'.$dir; // re-adding trailing slash removed by split
if ($dir[0] != '/' || !egw_vfs::stat($dir) || !egw_vfs::is_dir($dir))
{
$error .= ($error ? ' ' : '').lang('%1 is no existing vfs directory!',$dir);
}
}
} }
} break;
case 'Array': // notifies
$value = $GLOBALS['egw']->preferences->lang_notify($value, $types[$var], True);
break;
}
if (isset($value) && $value !== '' && $value !== '**NULL**')
{
if (is_array($value)) $value = implode(',',$value); // multiselect
$prefs[$var] = $value; $prefs[$var] = $value;
if(is_array($notifies) && isset($notifies[$var])) // need to translate the key-words back
{
$prefs[$var] = $GLOBALS['egw']->preferences->lang_notify($prefs[$var],$notifies[$var],True);
}
// need to call preferences::add, to also set affective prefs! // need to call preferences::add, to also set affective prefs!
if (!$only_verify) $GLOBALS['egw']->preferences->add($appname, $var, $prefs[$var], $type); if (!$only_verify) $GLOBALS['egw']->preferences->add($appname, $var, $prefs[$var], $type);
} }
else else
{ {
unset($prefs[$var]); unset($prefs[$var]);
// need to call preferences::delete, to also set affective prefs! // need to call preferences::delete, to also set affective prefs!
if (!$only_verify) $GLOBALS['egw']->preferences->delete($appname, $var, $type); if (!$only_verify) $GLOBALS['egw']->preferences->delete($appname, $var, $type);
} }
@ -240,11 +251,12 @@ class preferences_settings
* @param string $type * @param string $type
* @param array &$sel_options * @param array &$sel_options
* @param array &$readonlys * @param array &$readonlys
* @param array &$types on return setting-name => setting-type
* @param etemplate $tpl * @param etemplate $tpl
* @throws egw_exception_wrong_parameter * @throws egw_exception_wrong_parameter
* @return array content * @return array content
*/ */
function get_content($appname, $type, &$sel_options, &$readonlys, $tpl) function get_content($appname, $type, &$sel_options, &$readonlys, &$types, $tpl)
{ {
if (!$this->call_hook($appname, $type)) if (!$this->call_hook($appname, $type))
{ {
@ -264,7 +276,9 @@ class preferences_settings
{ {
continue; // forced preferences are not displayed, unless we edit them continue; // forced preferences are not displayed, unless we edit them
} }
switch($old_type = $setting['type']) $types[$setting['name']] = $old_type = $setting['type'];
switch($old_type)
{ {
case 'section': case 'section':
$tab = 'tab'.(1+count($tabs)); $tab = 'tab'.(1+count($tabs));
@ -277,20 +291,21 @@ class preferences_settings
case 'subsection': // is in old code, but never seen it used case 'subsection': // is in old code, but never seen it used
continue 2; continue 2;
case 'notify':
// ToDo: implementation ...
error_log(__METHOD__."('$appname', '$type') NOT implemented settings type '$old_type'!");
// handle as textarea for now
case 'textarea':
$setting['type'] = is_a($tpl, 'etemplate_old') ? 'textarea' : 'textbox';
$tpl->setElementAttribute($tab.'['.$setting['name'].']', 'multiline', 'true');
// ignoring rows and cols in favor of hardcoded: width: 100%, height: 5em
break;
case 'password': case 'password':
case 'vfs_file': case 'vfs_file':
case 'vfs_dir': case 'vfs_dir':
case 'vfs_dirs': case 'vfs_dirs':
case 'notify':
// ToDo: implementation ...
error_log(__METHOD__."('$appname', '$type') NOT implemented settings type '$old_type'!");
// handle as input for now
case 'input': case 'input':
$setting['type'] = 'textbox'; $setting['type'] = 'textbox';
if (isset($setting['size']))
{
$tpl->setElementAttribute($tab.'['.$setting['name'].']', 'size', $setting['size']);
}
break; break;
case 'check': case 'check':
$setting['type'] = 'select'; $setting['type'] = 'select';
@ -346,13 +361,13 @@ class preferences_settings
} }
} }
$content[$tab][] = array( $content[$tab][] = array(
'name' => $setting['name'], 'name' => $setting['name'],
'type' => $setting['type'], 'type' => $setting['type'],
'label' => preg_replace('|<br[ /]*>|i', "\n", $setting['label']), 'label' => preg_replace('|<br[ /]*>|i', "\n", $setting['label']),
'help' => preg_replace('|<br[ /]*>|i', "\n", $setting['help']), 'help' => $setting['help'], // is html
'size' => $setting['size'], // old eT 'size' => $setting['size'], // old eT
'default' => !empty($default) ? lang('Default').': '.$default : null, 'default' => !empty($default) ? lang('Default').': '.$default : null,
'onchange' => $setting['onchange'], 'onchange' => $setting['onchange'],
); );
$content[$tab][$setting['name']] = $GLOBALS['egw']->preferences->{$attribute}[$appname][$setting['name']]; $content[$tab][$setting['name']] = $GLOBALS['egw']->preferences->{$attribute}[$appname][$setting['name']];
//if ($old_type == 'multiselect') $content[$tab][$setting['name']] = explode(',', $content[$tab][$setting['name']]); //if ($old_type == 'multiselect') $content[$tab][$setting['name']] = explode(',', $content[$tab][$setting['name']]);

4
preferences/setup/etemplates.inc.php
View File

@ -2,7 +2,7 @@
/** /**
* EGroupware - eTemplates for Application preferences * EGroupware - eTemplates for Application preferences
* http://www.egroupware.org * http://www.egroupware.org
* generated by soetemplate::dump4setup() 2013-05-09 12:22 * generated by soetemplate::dump4setup() 2013-05-10 09:13
* *
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License * @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
* @package preferences * @package preferences
@ -14,5 +14,5 @@ $templ_version=1;
$templ_data[] = array('name' => 'preferences.settings','template' => '','lang' => '','group' => '0','version' => '1.9.001','data' => 'a:5:{i:0;a:3:{s:4:"name";s:3:"msg";s:4:"type";s:5:"label";s:4:"span";s:10:",redItalic";}i:1;a:5:{s:8:"onchange";i:1;s:5:"class";s:8:"prefType";s:4:"name";s:4:"type";s:4:"type";s:6:"select";s:4:"span";s:9:",prefType";}i:2;a:6:{s:8:"onchange";i:1;s:5:"class";s:7:"prefApp";s:4:"name";s:7:"appname";s:4:"size";s:18:"Common preferences";s:4:"type";s:6:"select";s:4:"span";s:8:",prefApp";}i:3;a:3:{s:4:"name";s:9:"tabs=tab1";s:4:"type";s:3:"tab";s:5:"label";s:8:"Settings";}i:4;a:5:{s:4:"type";s:4:"hbox";s:4:"size";s:1:"3";i:1;a:3:{s:5:"label";s:4:"Save";s:4:"name";s:12:"button[save]";s:4:"type";s:6:"button";}i:2;a:3:{s:5:"label";s:5:"Apply";s:4:"name";s:13:"button[apply]";s:4:"type";s:6:"button";}i:3;a:3:{s:5:"label";s:6:"Cancel";s:4:"name";s:14:"button[cancel]";s:4:"type";s:6:"button";}}}','size' => '','style' => '','modified' => '1368094676',); $templ_data[] = array('name' => 'preferences.settings','template' => '','lang' => '','group' => '0','version' => '1.9.001','data' => 'a:5:{i:0;a:3:{s:4:"name";s:3:"msg";s:4:"type";s:5:"label";s:4:"span";s:10:",redItalic";}i:1;a:5:{s:8:"onchange";i:1;s:5:"class";s:8:"prefType";s:4:"name";s:4:"type";s:4:"type";s:6:"select";s:4:"span";s:9:",prefType";}i:2;a:6:{s:8:"onchange";i:1;s:5:"class";s:7:"prefApp";s:4:"name";s:7:"appname";s:4:"size";s:18:"Common preferences";s:4:"type";s:6:"select";s:4:"span";s:8:",prefApp";}i:3;a:3:{s:4:"name";s:9:"tabs=tab1";s:4:"type";s:3:"tab";s:5:"label";s:8:"Settings";}i:4;a:5:{s:4:"type";s:4:"hbox";s:4:"size";s:1:"3";i:1;a:3:{s:5:"label";s:4:"Save";s:4:"name";s:12:"button[save]";s:4:"type";s:6:"button";}i:2;a:3:{s:5:"label";s:5:"Apply";s:4:"name";s:13:"button[apply]";s:4:"type";s:6:"button";}i:3;a:3:{s:5:"label";s:6:"Cancel";s:4:"name";s:14:"button[cancel]";s:4:"type";s:6:"button";}}}','size' => '','style' => '','modified' => '1368094676',);
$templ_data[] = array('name' => 'preferences.settings.tab1','template' => '','lang' => '','group' => '0','version' => '1.9.001','data' => 'a:1:{i:0;a:7:{s:4:"type";s:4:"grid";s:4:"name";s:4:"tab1";s:4:"data";a:2:{i:0;a:2:{s:1:"A";s:3:"50%";s:2:"c1";s:7:"prefRow";}i:1;a:2:{s:1:"A";a:5:{s:4:"type";s:3:"box";s:4:"size";s:1:"2";s:4:"span";s:9:",prefName";i:1;a:3:{s:3:"for";s:13:"${row}[value]";s:4:"name";s:13:"${row}[label]";s:4:"type";s:5:"label";}i:2;a:3:{s:4:"name";s:12:"${row}[help]";s:4:"type";s:5:"label";s:4:"span";s:9:",prefHelp";}}s:1:"B";a:4:{s:4:"type";s:3:"box";s:4:"size";s:1:"2";i:1;a:5:{s:4:"type";s:13:"@${row}[type]";s:4:"size";s:13:"@${row}[size]";s:7:"no_lang";s:1:"1";s:4:"name";s:13:"@${row}[name]";s:4:"span";s:10:",prefValue";}i:2;a:4:{s:7:"no_lang";s:1:"1";s:4:"name";s:15:"${row}[default]";s:4:"type";s:5:"label";s:4:"span";s:12:",prefDefault";}}}}s:4:"cols";i:2;s:4:"rows";i:1;s:4:"size";s:33:"100%,,,prefTable egwGridView_grid";s:7:"options";a:2:{i:3;s:26:"prefTable egwGridView_grid";i:0;s:4:"100%";}}}','size' => '100%,,,prefTable egwGridView_grid','style' => '','modified' => '1367565943',); $templ_data[] = array('name' => 'preferences.settings.tab1','template' => '','lang' => '','group' => '0','version' => '1.9.001','data' => 'a:1:{i:0;a:7:{s:4:"type";s:4:"grid";s:4:"name";s:4:"tab1";s:4:"data";a:2:{i:0;a:2:{s:1:"A";s:3:"50%";s:2:"c1";s:7:"prefRow";}i:1;a:2:{s:1:"A";a:5:{s:4:"type";s:3:"box";s:4:"size";s:1:"2";s:4:"span";s:9:",prefName";i:1;a:3:{s:3:"for";s:13:"${row}[value]";s:4:"name";s:13:"${row}[label]";s:4:"type";s:5:"label";}i:2;a:3:{s:4:"name";s:12:"${row}[help]";s:4:"type";s:4:"html";s:4:"span";s:9:",prefHelp";}}s:1:"B";a:4:{s:4:"type";s:3:"box";s:4:"size";s:1:"2";i:1;a:5:{s:4:"type";s:13:"@${row}[type]";s:4:"size";s:13:"@${row}[size]";s:7:"no_lang";s:1:"1";s:4:"name";s:13:"@${row}[name]";s:4:"span";s:10:",prefValue";}i:2;a:4:{s:7:"no_lang";s:1:"1";s:4:"name";s:15:"${row}[default]";s:4:"type";s:5:"label";s:4:"span";s:12:",prefDefault";}}}}s:4:"cols";i:2;s:4:"rows";i:1;s:4:"size";s:33:"100%,,,prefTable egwGridView_grid";s:7:"options";a:2:{i:3;s:26:"prefTable egwGridView_grid";i:0;s:4:"100%";}}}','size' => '100%,,,prefTable egwGridView_grid','style' => '','modified' => '1367565943',);

5
preferences/templates/default/app.css
View File

@ -39,6 +39,11 @@ tr.prefRow:hover .prefHelp {
} }
.prefValue { .prefValue {
margin-right: 5px; margin-right: 5px;
width: 100%;
}
.prefValue textarea, textarea.prefValue {
width: 99%;
height: 5em;
} }
.prefType, .prefApp { .prefType, .prefApp {
font-size: 150%; font-size: 150%;

2
preferences/templates/default/settings.xet
View File

@ -11,7 +11,7 @@
<row class="prefRow"> <row class="prefRow">
<box class="prefName"> <box class="prefName">
<description for="@${row}[name]" id="${row}[label]"/> <description for="@${row}[name]" id="${row}[label]"/>
<description id="${row}[help]" class="prefHelp"/> <html id="${row}[help]" class="prefHelp"/>
</box> </box>
<box> <box>
<widget type="@${row}[type]" id="@${row}[name]" onchange="@${row}[onchange]" size="@${row}[size]" no_lang="1" class="prefValue"/> <widget type="@${row}[type]" id="@${row}[name]" onchange="@${row}[onchange]" size="@${row}[size]" no_lang="1" class="prefValue"/>