mirror of
https://github.com/EGroupware/egroupware.git
synced 2024-12-04 22:01:05 +01:00
792 lines
27 KiB
PHP
792 lines
27 KiB
PHP
<?php
|
|
/**
|
|
* EGroupware: Preferences app UI for settings/preferences
|
|
*
|
|
* @link http://www.egroupware.org
|
|
* @author Ralf Becker <rb@stylite.de>
|
|
* @package preferences
|
|
* @copyright (c) 2013-16 by Ralf Becker <rb@stylite.de>
|
|
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
|
|
* @version $Id$
|
|
*/
|
|
|
|
use EGroupware\Api;
|
|
use EGroupware\Api\Etemplate\Widget\Select;
|
|
use EGroupware\Api\Framework;
|
|
use EGroupware\Api\Egw;
|
|
use EGroupware\Api\Image;
|
|
use EGroupware\Api\Vfs;
|
|
use EGroupware\Api\Etemplate;
|
|
|
|
/**
|
|
* UI for settings / Api\Preferences
|
|
*/
|
|
class preferences_settings
|
|
{
|
|
/**
|
|
* Methods callable via menuaction
|
|
* @var array
|
|
*/
|
|
public $public_functions = array(
|
|
'index' => true,
|
|
);
|
|
/**
|
|
* App we work on
|
|
* @var string
|
|
*/
|
|
public $appname = 'preferences';
|
|
/**
|
|
* Preferences read by call_hook
|
|
* @var array
|
|
*/
|
|
public $settings = array();
|
|
|
|
/**
|
|
* Edit preferences
|
|
*
|
|
* @param array $content =null
|
|
* @param string $msg =''
|
|
*/
|
|
function index(array $content=null, $msg='')
|
|
{
|
|
$tpl = new Etemplate('preferences.settings');
|
|
if (!is_array($content))
|
|
{
|
|
$appname = isset($_GET['appname']) && $_GET['appname'] != 'preferences' &&
|
|
isset($GLOBALS['egw_info']['user']['apps'][$_GET['appname']]) ? $_GET['appname'] : 'common';
|
|
$type = 'user';
|
|
$account_id = $GLOBALS['egw_info']['user']['account_id'];
|
|
if ($GLOBALS['egw_info']['user']['apps']['admin'] &&
|
|
isset($_GET['account_id']) && (int)$_GET['account_id'] &&
|
|
$GLOBALS['egw']->accounts->exists((int)$_GET['account_id']))
|
|
{
|
|
$account_id = (int)$_GET['account_id'];
|
|
$type = $_GET['account_id'] < 0 ? 'group' : 'user';
|
|
$is_admin = true;
|
|
}
|
|
$content['current_app'] = isset($GLOBALS['egw_info']['user']['apps'][$_GET['current_app']]) ? $_GET['current_app'] : $appname;
|
|
}
|
|
else
|
|
{
|
|
$is_admin = $content['is_admin'] || $content['type'] != 'user';
|
|
//error_log(__METHOD__."(".array2string($content).")");
|
|
if (!empty($content['button']))
|
|
{
|
|
$button = key($content['button']);
|
|
$appname = $content['old_appname'] ? $content['old_appname'] : 'common';
|
|
switch($button)
|
|
{
|
|
case 'save':
|
|
case 'apply':
|
|
// check if user has rights to store preferences for $type and $account_id
|
|
if ($content['old_type'] !== 'user' && !$GLOBALS['egw_info']['user']['apps']['admin'])
|
|
{
|
|
throw new Api\Exception\NoPermission\Admin;
|
|
}
|
|
list($type,$account_id) = explode(':', $content['old_type']);
|
|
// 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->get_account_id())
|
|
{
|
|
$GLOBALS['egw']->preferences->set_account_id($account_id);
|
|
$GLOBALS['egw']->preferences->read_repository();
|
|
}
|
|
$attribute = $type == 'group' ? 'user' : $type;
|
|
|
|
$require_reload = self::fetchRequireToReload($appname, $type);
|
|
$old_values = array_intersect_key($GLOBALS['egw_info']['user']['preferences'][$appname], array_flip($require_reload));
|
|
|
|
if (!($msg=$this->process_array($GLOBALS['egw']->preferences->$attribute, $prefs, $content['types'], $appname, $attribute, $content)))
|
|
{
|
|
$msg_type = 'success';
|
|
$msg = lang('Preferences saved.');
|
|
|
|
// do we need to reload whole framework
|
|
if (!empty($require_reload))
|
|
{
|
|
if ($account_id && $GLOBALS['egw']->preferences->get_account_id() != $GLOBALS['egw_info']['user']['account_id'])
|
|
{
|
|
$GLOBALS['egw']->preferences->set_account_id($GLOBALS['egw_info']['user']['account_id']);
|
|
}
|
|
$GLOBALS['egw_info']['user']['preferences'] = $GLOBALS['egw']->preferences->read_repository();
|
|
$new_values = array_intersect_key($GLOBALS['egw_info']['user']['preferences'][$appname], array_flip($require_reload));
|
|
//error_log(__METHOD__."() ".__LINE__.": old_values=".array2string($old_values).", new_values=".array2string($new_values));
|
|
if ($old_values != $new_values)
|
|
{
|
|
Framework::refresh_opener($msg, null, null, null, null, null, null, $msg_type);
|
|
}
|
|
}
|
|
// update client-side Api\Preferences in response (only current user/session)
|
|
Framework::ajax_get_preference($appname);
|
|
|
|
// ask every affected client to reload preferences, if affected ($appname prefs loaded and member of group for group prefs)
|
|
$push = new Api\Json\Push($account_id > 0 ? (int)$account_id : Api\Json\Push::ALL);
|
|
$push->call('egw.reload_preferences', $appname, $account_id ? (int)$account_id : 0);
|
|
}
|
|
}
|
|
if (in_array($button, array('save','cancel')))
|
|
{
|
|
Api\Json\Response::get()->call('egw.message', $msg, $msg_type);
|
|
Framework::window_close();
|
|
}
|
|
}
|
|
$appname = $content['appname'] ? $content['appname'] : 'common';
|
|
list($type,$account_id) = explode(':', $content['type']);
|
|
//_debug_array($prefs);
|
|
}
|
|
if ($account_id && $account_id != $GLOBALS['egw']->preferences->get_account_id())
|
|
{
|
|
$GLOBALS['egw']->preferences->set_account_id($account_id);
|
|
$GLOBALS['egw']->preferences->read_repository();
|
|
}
|
|
$preserve = array('types' => array());
|
|
// preserv open tab, if appname is not chanaged
|
|
if (!isset($content['old_appname']) || $content['old_appname'] == $content['appname'] ||
|
|
$content['old_appname'] == 'common' && !$content['appname'])
|
|
{
|
|
$old_tab = $content['tabs'];
|
|
}
|
|
// we need to run under calling app, to be able to restore it to it's index page after
|
|
$preserve['current_app'] = $content['current_app'];
|
|
$GLOBALS['egw_info']['flags']['currentapp'] = $content['current_app'] == 'common' ?
|
|
'preferences' : $content['current_app'];
|
|
Framework::includeCSS('preferences','app');
|
|
|
|
// 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,
|
|
(array)$GLOBALS['egw']->preferences->{$attribute}[$appname], $preserve['types'], $appname, $attribute, $content, true);
|
|
}
|
|
|
|
$sel_options = $readonlys = null;
|
|
$data = $this->get_content($appname, $type, $sel_options, $readonlys, $preserve['types'], $tpl);
|
|
if($data['appname'] == 'common')
|
|
{
|
|
// 'common' is not in the options list, we use the empty label for common
|
|
$data['appname'] = '';
|
|
}
|
|
$preserve['appname'] = $preserve['old_appname'] = $data['appname'];
|
|
$preserve['type'] = $preserve['old_type'] = $data['type'];
|
|
$preserve['is_admin'] = $is_admin;
|
|
|
|
// preserve the old values since we need them for admin cmd data comparison
|
|
$preserve['old_values'] = array ();
|
|
foreach($data as $key => $val)
|
|
{
|
|
if (is_array($val) && strpos($key, 'tab') === 0)
|
|
{
|
|
foreach ($val as $k => $v)
|
|
{
|
|
if (!is_int($k)) $preserve['old_values'][$k] = $v;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (isset($old_tab)) $data['tabs'] = $old_tab;
|
|
|
|
if ($msg) Framework::message($msg, $msg_type ? $msg_type : 'error');
|
|
|
|
$tpl->exec('preferences.preferences_settings.index', $data, $sel_options, $readonlys, $preserve, 2);
|
|
}
|
|
|
|
/**
|
|
* Fetch preferences of given app where they have reload attribute set to true
|
|
* @param string $appname app name
|
|
* @param string $type 'user', 'default', 'forced'
|
|
* @return array
|
|
* @throws Api\Exception\AssertionFailed
|
|
*/
|
|
static function fetchRequireToReload($appname, $type)
|
|
{
|
|
$keys = [];
|
|
if ($appname == 'common')
|
|
{
|
|
// none app pref names here since we can't read them via hooks
|
|
$keys = ['template_color', 'template_custom_color', 'sidebox_custom_color'];
|
|
$settings = Api\Hooks::single(array(
|
|
'account_id'=>$GLOBALS['egw']->preferences->get_account_id(),
|
|
'location'=>'settings',
|
|
'type' => $type), 'preferences');
|
|
}
|
|
else
|
|
{
|
|
$settings = Api\Hooks::single(array(
|
|
'account_id'=>$GLOBALS['egw']->preferences->get_account_id(),
|
|
'location'=>'settings',
|
|
'type' => $type), $appname);
|
|
}
|
|
|
|
|
|
foreach ($settings as $key => $value)
|
|
{
|
|
if ($value['reload']) $keys[]=$key;
|
|
}
|
|
return $keys;
|
|
}
|
|
|
|
/**
|
|
* run admin command instance
|
|
*
|
|
* @param array $content
|
|
* @param array $values
|
|
* @param string $account_id
|
|
*/
|
|
static function admin_cmd_run($content, $values, $account_id, $type, $appname)
|
|
{
|
|
$changes = array_udiff_assoc($values, $content['old_values'], function($a, $b)
|
|
{
|
|
if($a == '**NULL**' && empty($b) || empty($a) && $b == '**NULL**')
|
|
{
|
|
return 0;
|
|
}
|
|
// some prefs are still comma-delimitered
|
|
if (is_array($a) != is_array($b))
|
|
{
|
|
if (!is_array($a)) $a = is_null($a) ? array() : explode(',', $a);
|
|
if (!is_array($b)) $b = is_null($b) ? array() : explode(',', $b);
|
|
}
|
|
return (int)($a != $b);
|
|
});
|
|
$old = array_intersect_key($content['old_values'], $changes);
|
|
|
|
if ($changes)
|
|
{
|
|
$cmd = new admin_cmd_edit_preferences($account_id, $type, $appname, $changes, $old, (array)$content['admin_cmd']);
|
|
return $cmd->run();
|
|
}
|
|
return lang('Nothing to save.');
|
|
}
|
|
|
|
/**
|
|
* Verify and save preferences
|
|
*
|
|
* @param array &$repository values get updated here
|
|
* @param array $values new values
|
|
* @param array $types setting-name => type
|
|
* @param string $appname appname or 'common'
|
|
* @param string $type 'user', 'default', 'forced'
|
|
* @param array $content
|
|
* @param boolean $only_verify =false
|
|
* @return string with verification error or null on success
|
|
*/
|
|
function process_array(array &$repository, array $values, array $types, $appname, $type, $content, $only_verify=false)
|
|
{
|
|
//fetch application specific settings from a hook
|
|
$settings = Api\Hooks::single(array(
|
|
'account_id'=>$GLOBALS['egw']->preferences->get_account_id(),
|
|
'location'=>'settings',
|
|
'type' => $type), $appname);
|
|
|
|
//_debug_array($repository);
|
|
$prefs = &$repository[$appname];
|
|
|
|
unset($prefs['']);
|
|
|
|
//_debug_array($values);exit;
|
|
foreach($values as $var => &$value)
|
|
{
|
|
// type specific validation
|
|
switch((string)$types[$var])
|
|
{
|
|
case 'password': // dont write empty password-fields
|
|
if (empty($value)) continue 2;
|
|
break;
|
|
case 'vfs_file':
|
|
case 'vfs_dir':
|
|
case 'vfs_dirs':
|
|
if ($value === '')
|
|
{
|
|
// empty is always allowed
|
|
|
|
// 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 2;
|
|
}
|
|
}
|
|
elseif ($types[$var] == 'vfs_file')
|
|
{
|
|
if ($value[0] != '/' || !Vfs::stat($value) || Vfs::is_dir($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($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] != '/' || !Vfs::stat($dir) || !Vfs::is_dir($dir))
|
|
{
|
|
$error .= ($error ? ' ' : '').lang('%1 is no existing vfs directory!',$dir);
|
|
}
|
|
}
|
|
}
|
|
break;
|
|
case 'multiselect':
|
|
if(empty($value) && $type == 'forced')
|
|
{
|
|
$value = '**NULL**';
|
|
}
|
|
break;
|
|
case 'Array': // notify
|
|
// Make sure the application translation is loaded
|
|
Api\Translation::add_app($appname);
|
|
$value = $GLOBALS['egw']->preferences->lang_notify($value, $types[$var], True);
|
|
break;
|
|
}
|
|
|
|
if (isset($value) && $value !== '' && $value !== '**NULL**' && $value !== array())
|
|
{
|
|
if (is_array($value) && !$settings[$var]['no_sel_options']) $value = implode(',',$value); // multiselect
|
|
|
|
$prefs[$var] = $value;
|
|
|
|
// need to call preferences::add, to also set affective prefs!
|
|
if (!$only_verify) $GLOBALS['egw']->preferences->add($appname, $var, $prefs[$var], $type);
|
|
}
|
|
else
|
|
{
|
|
unset($prefs[$var]);
|
|
|
|
// need to call preferences::delete, to also set affective prefs!
|
|
if (!$only_verify) $GLOBALS['egw']->preferences->delete($appname, $var, $type);
|
|
}
|
|
}
|
|
|
|
// the following hook can be used to verify the prefs
|
|
// if you return something else than False, it is treated as an error-msg and
|
|
// displayed to the user (the prefs are not saved)
|
|
//
|
|
if(($error .= Api\Hooks::single(array(
|
|
'location' => 'verify_settings',
|
|
'prefs' => &$repository[$appname],
|
|
'type' => $type,
|
|
'preprocess' => $only_verify,
|
|
),
|
|
$appname
|
|
)))
|
|
{
|
|
return $error;
|
|
}
|
|
|
|
|
|
if (!$only_verify)
|
|
{
|
|
$GLOBALS['egw']->preferences->save_repository(True, $type);
|
|
if ($content['is_admin'])
|
|
{
|
|
if (($account_id = $GLOBALS['egw']->preferences->get_account_id()) < 0 && $type == 'user') $type = 'group';
|
|
|
|
self::admin_cmd_run($content, $values, $account_id, $type, $appname);
|
|
}
|
|
|
|
// certain common prefs (language, template, ...) require the session to be re-created
|
|
if ($appname == 'common')
|
|
{
|
|
Egw::invalidate_session_cache();
|
|
}
|
|
// update $GLOBALS['egw_info']['user']['preferences'] as some hooks called use that can return or set old values (e.g. calendar default-alarm(-wholeday))
|
|
if ($type === 'user' && $GLOBALS['egw']->preferences->get_account_id() == $GLOBALS['egw_info']['user']['account_id'])
|
|
{
|
|
$GLOBALS['egw_info']['user']['preferences'] = $GLOBALS['egw']->preferences->data;
|
|
}
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get content, sel_options and readonlys for given appname and type
|
|
*
|
|
* @param string $appname appname or 'common'
|
|
* @param string $type
|
|
* @param array &$sel_options
|
|
* @param array &$readonlys
|
|
* @param array &$types on return setting-name => setting-type
|
|
* @param Api\Etemplate|etemplate $tpl
|
|
* @throws Api\Exception\WrongParameter
|
|
* @return array content
|
|
*/
|
|
function get_content($appname, $type, &$sel_options, &$readonlys, &$types, $tpl)
|
|
{
|
|
if (!$this->call_hook($appname, $type, $GLOBALS['egw']->preferences->get_account_id()))
|
|
{
|
|
throw new Api\Exception\WrongParameter("Could not find settings for application: ".$appname);
|
|
}
|
|
$attribute = $type == 'group' ? 'user' : $type;
|
|
//error_log(__METHOD__."('$appname', '$type' ) attribute='$attribute', preferences->account_id=".$GLOBALS['egw']->preferences->get_account_id());
|
|
|
|
//_debug_array($this->settings); exit;
|
|
$sel_options = $readonlys = $content = $tabs = array();
|
|
// disable all but first tab and name current tab "tab1", for apps not using sections
|
|
$tab = 'tab1';
|
|
foreach($this->settings as $setting)
|
|
{
|
|
if (!is_array($setting)) continue;
|
|
if ($type != 'forced' && $setting['name'] && (string)$GLOBALS['egw']->preferences->forced[$appname][$setting['name']] !== '')
|
|
{
|
|
continue; // forced preferences are not displayed, unless we edit them
|
|
}
|
|
$types[$setting['name']] = $old_type = $setting['type'];
|
|
|
|
switch($old_type)
|
|
{
|
|
case 'section':
|
|
$tab = 'tab'.(1+count($tabs));
|
|
$tabs[] = array(
|
|
'id' => $tab,
|
|
'template' => 'preferences.settings.tab1',
|
|
'label' => $setting['title'],
|
|
);
|
|
// fall through
|
|
case 'subsection': // is in old code, but never seen it used
|
|
continue 2;
|
|
|
|
case 'notify':
|
|
$vars = $GLOBALS['egw']->preferences->vars ?? [];
|
|
if (is_array($setting['values'])) $vars += $setting['values'];
|
|
$GLOBALS['egw']->preferences->{$attribute}[$appname][$setting['name']] =
|
|
$GLOBALS['egw']->preferences->lang_notify($GLOBALS['egw']->preferences->{$attribute}[$appname][$setting['name']], $vars);
|
|
$types[$setting['name']] = $vars; // store vars for re-translation, instead type "notify"
|
|
if ($setting['help'] && ($setting['run_lang'] || !isset($setting['run_lang'])))
|
|
{
|
|
$setting['help'] = lang($setting['help']);
|
|
}
|
|
$setting['help'] .= '<p><b>'.lang('Substitutions and their meanings:').'</b>';
|
|
foreach($vars as $var => $var_help)
|
|
{
|
|
$lname = ($lname = lang($var)) == $var.'*' ? $var : $lname;
|
|
$setting['help'] .= "<br>\n".'<b>$$'.$lname.'$$</b>: '.$var_help;
|
|
}
|
|
$setting['help'] .= "</p>\n";
|
|
$setting['run_lang'] = false; // already done now
|
|
// handle as textarea
|
|
case 'textarea':
|
|
$setting['type'] = 'et2-textarea';
|
|
if(!empty($setting['rows']))
|
|
{
|
|
$tpl->setElementAttribute($tab . '[' . $setting['name'] . ']', 'rows', $setting['rows']);
|
|
}
|
|
break;
|
|
case 'password':
|
|
case 'vfs_file':
|
|
case 'vfs_dir':
|
|
case 'vfs_dirs':
|
|
case 'input':
|
|
$setting['type'] = 'et2-textbox';
|
|
break;
|
|
case 'check':
|
|
$setting['type'] = 'et2-select';
|
|
$setting['values'] = array('1' => lang('yes'), '0' => lang('no'));
|
|
break;
|
|
case 'select':
|
|
$setting['type'] = 'et2-select';
|
|
break;
|
|
case 'multiselect':
|
|
$setting['type'] = 'et2-select';
|
|
$tpl->setElementAttribute($tab . '[' . $setting['name'] . ']', 'multiple', true);
|
|
break;
|
|
case 'select-tab':
|
|
case 'select-tabs':
|
|
$setting['type'] = 'et2-select-tab';
|
|
$tpl->setElementAttribute($tab . '[' . $setting['name'] . ']', 'allowFreeEntries', true);
|
|
$tpl->setElementAttribute($tab . '[' . $setting['name'] . ']', 'multiple', $old_type === 'select-tabs');
|
|
break;
|
|
case 'select-cat': // using application=$appname and global=true
|
|
$setting['type'] = 'et2-select-cat';
|
|
$tpl->setElementAttribute($tab . '[' . $setting['name'] . ']', 'application', $appname);
|
|
$tpl->setElementAttribute($tab . '[' . $setting['name'] . ']', 'global_categories', true);
|
|
break;
|
|
case 'color':
|
|
$setting['type'] = 'et2-colorpicker';
|
|
break;
|
|
case 'date-duration':
|
|
if(!isset($setting['size']))
|
|
{
|
|
$setting['size'] = 'm,dhm,24,1';
|
|
}
|
|
$attrs = explode(',', $setting['size']);
|
|
foreach(array("data_format","display_format", "hours_per_day", "empty_not_0", "short_labels") as $n => $name)
|
|
{
|
|
if ((string)$attrs[$n] !== '') $tpl->setElementAttribute($tab.'['.$setting['name'].']', $name, $attrs[$n]);
|
|
}
|
|
$setting['type'] = 'et2-date-duration';
|
|
break;
|
|
case 'taglist':
|
|
if($setting['no_sel_options'])
|
|
{
|
|
$tpl->setElementAttribute($tab . '[' . $setting['name'] . ']', 'autocomplete_url', '');
|
|
$tpl->setElementAttribute($tab . '[' . $setting['name'] . ']', 'allowFreeEntries', true);
|
|
}
|
|
$setting['type'] = 'et2-select';
|
|
$tpl->setElementAttribute($tab . '[' . $setting['name'] . ']', 'multiple', true);
|
|
break;
|
|
}
|
|
// move values/options to sel_options array
|
|
if (isset($setting['values']) && is_array($setting['values']) && !$setting['no_sel_options'])
|
|
{
|
|
Select::fix_encoded_options($setting['values'], true);
|
|
if ($old_type != 'multiselect' && $old_type != 'notify')
|
|
{
|
|
switch($type)
|
|
{
|
|
case 'user':
|
|
$setting['values'] = array_merge(
|
|
array(['value' => '', 'label' => lang('Use default')]),
|
|
$setting['values']
|
|
);
|
|
break;
|
|
case 'default':
|
|
case 'group':
|
|
$setting['values'] = array_merge(
|
|
array(['value' => '', 'label' => lang('No default')]),
|
|
$setting['values']
|
|
);
|
|
break;
|
|
case 'forced';
|
|
$setting['values'] = array_merge(
|
|
array(['value' => '**NULL**', 'label' => lang('Users choice')]),
|
|
$setting['values']
|
|
);
|
|
break;
|
|
}
|
|
}
|
|
$sel_options[$setting['name']] = $setting['values'];
|
|
}
|
|
if ($type == 'user')
|
|
{
|
|
$default = $GLOBALS['egw']->preferences->group[$appname][$setting['name']] ?
|
|
$GLOBALS['egw']->preferences->group[$appname][$setting['name']] :
|
|
$GLOBALS['egw']->preferences->default[$appname][$setting['name']];
|
|
|
|
// replace default value(s) for selectboxes with selectbox labels
|
|
if (isset($setting['values']) && is_array($setting['values']))
|
|
{
|
|
$default = self::get_default_label($default, $setting['values']);
|
|
}
|
|
if (is_array($types[$setting['name']])) // translate the substitution names
|
|
{
|
|
$default = $GLOBALS['egw']->preferences->lang_notify($default, $types[$setting['name']]);
|
|
}
|
|
}
|
|
if ($setting['help'] && ($setting['run_lang'] || !isset($setting['run_lang'])))
|
|
{
|
|
$setting['help'] = lang($setting['help']);
|
|
}
|
|
$content[$tab][] = array(
|
|
'name' => $setting['name'],
|
|
'type' => $setting['type'],
|
|
'label' => preg_replace('|<br[ /]*>|i', "\n", $setting['label']),
|
|
'help' => lang($setting['help']), // is html
|
|
'default' => (string)$default !== '' ? lang('Default') . ': ' . $default : null,
|
|
'onchange' => $setting['onchange']
|
|
);
|
|
|
|
foreach($setting['attributes'] as $attr => $attr_value)
|
|
{
|
|
$tpl->setElementAttribute($tab . '[' . $setting['name'] . ']', $attr, $attr_value);
|
|
}
|
|
//error_log("appname=$appname, attribute=$attribute, setting=".array2string($setting));
|
|
$content[$tab][$setting['name']] = $GLOBALS['egw']->preferences->{$attribute}[$appname][$setting['name']];
|
|
//if ($old_type == 'multiselect') $content[$tab][$setting['name']] = explode(',', $content[$tab][$setting['name']]);
|
|
}
|
|
// defining used tabs on run-time
|
|
if ($tabs)
|
|
{
|
|
$tpl->setElementAttribute('tabs', 'extraTabs', $tabs);
|
|
}
|
|
else
|
|
{
|
|
// Modifications are kept in the request, so reset to just one
|
|
$tpl->setElementAttribute('tabs', 'extraTabs', array(
|
|
array(
|
|
'id' => 'tab1',
|
|
'template' => 'preferences.settings.tab1',
|
|
'label' => 'general settings'
|
|
)));
|
|
}
|
|
|
|
$content['appname'] = $appname;
|
|
$sel_options['appname'] = array();
|
|
foreach(Api\Hooks::implemented('settings') as $app)
|
|
{
|
|
if ($app != 'preferences' && $GLOBALS['egw_info']['user']['apps'][$app])
|
|
{
|
|
$sel_options['appname'][$app] = [
|
|
'value' => $app,
|
|
'label' => $GLOBALS['egw_info']['apps'][$app]['title'],
|
|
'icon' => Image::find($app, 'navbar')
|
|
];
|
|
}
|
|
}
|
|
natcasesort($sel_options['appname']);
|
|
|
|
$sel_options['type'] = array(
|
|
'user' => 'Your preferences',
|
|
'default' => 'Default preferences',
|
|
'forced' => 'Forced preferences',
|
|
);
|
|
if ($GLOBALS['egw_info']['user']['apps']['admin'])
|
|
{
|
|
$content['type'] = $type;
|
|
if (($id = $GLOBALS['egw']->preferences->get_account_id()) != $GLOBALS['egw_info']['user']['account_id'])
|
|
{
|
|
$content['type'] .= ':'.$id;
|
|
$sel_options['type'][$content['type']] = Api\Accounts::username($GLOBALS['egw']->preferences->account_id);
|
|
|
|
// Restrict app list to apps the user has access to
|
|
$user_apps = $GLOBALS['egw']->acl->get_user_applications($id);
|
|
$sel_options['appname'] = array_intersect_key($sel_options['appname'], $user_apps);
|
|
}
|
|
foreach($GLOBALS['egw']->accounts->search(array('type' => 'groups', 'order' => 'account_lid')) as $account_id => $group)
|
|
{
|
|
$sel_options['type']['group:'.$account_id] = lang('Preferences').' '.Api\Accounts::format_username($group['account_lid'], '', '', $account_id);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
$content['type'] = 'user';
|
|
$readonlys['type'] = true;
|
|
}
|
|
//_debug_array($content); exit;
|
|
//_debug_array($sel_options); //exit;
|
|
return $content;
|
|
}
|
|
|
|
/**
|
|
* Get label for given default value(s)
|
|
*
|
|
* @param string|array $default default value(s) to get label for
|
|
* @param array $values values optional including optgroups
|
|
* @param boolean $lang =true
|
|
* @return string comma-separated and translated labels
|
|
*/
|
|
protected static function get_default_label($default, array $values, $lang=true)
|
|
{
|
|
// explode comma-separated multiple default values
|
|
if (!is_array($default) && !isset($values[$default]) && strpos($default, ',') !== false)
|
|
{
|
|
$labels = explode(',', $default);
|
|
}
|
|
else
|
|
{
|
|
$labels = (array)$default;
|
|
}
|
|
foreach($labels as &$def)
|
|
{
|
|
if(isset($values[$def]) && (!is_array($values[$def]) || $values[$def]['value'] == $def))
|
|
{
|
|
$def = is_array($values[$def]) ? $values[$def]['label'] : $values[$def];
|
|
}
|
|
else // value could be in an optgroup or array with label & value keys
|
|
{
|
|
foreach($values as $value)
|
|
{
|
|
if (is_array($value) && !isset($value['label']) && isset($value[$def]))
|
|
{
|
|
$def = is_array($value[$def]) ? $value[$def]['label'] : $value[$def];
|
|
break;
|
|
}
|
|
elseif(is_array($value) && isset($value['label']) && $value['value'] == $def)
|
|
{
|
|
$def = $value['label'];
|
|
}
|
|
}
|
|
}
|
|
if ($lang) $def = lang($def);
|
|
}
|
|
$label = implode(', ', $labels);
|
|
//error_log(__METHOD__."(".array2string($default).', '.array2string($values).") returning $label");
|
|
return $label;
|
|
}
|
|
|
|
/**
|
|
* Get preferences by calling various hooks to supply them
|
|
*
|
|
* Sets $this->appname and $this->settings
|
|
*
|
|
* @param string $appname appname or 'common'
|
|
* @param string $type ='user' 'default', 'forced', 'user' or 'group'
|
|
* @param int|string $account_id =null account_id for user or group prefs, or "forced" or "default"
|
|
* @return boolean
|
|
*/
|
|
protected function call_hook($appname, $type='user', $account_id=null)
|
|
{
|
|
$this->appname = $appname == 'common' ? 'preferences' : $appname;
|
|
|
|
// Set framework here to make sure we get the right settings for user's [newly] selected template
|
|
$GLOBALS['egw_info']['server']['template_set'] = $GLOBALS['egw']->preferences->data['common']['template_set'];
|
|
Api\Translation::add_app($this->appname);
|
|
if($this->appname != 'preferences')
|
|
{
|
|
Api\Translation::add_app('preferences'); // we need the prefs translations too
|
|
}
|
|
|
|
$this->settings = Api\Preferences::settings($appname, $type, $account_id);
|
|
|
|
/* Remove ui-only settings */
|
|
if($this->xmlrpc)
|
|
{
|
|
foreach($this->settings as $key => $valarray)
|
|
{
|
|
if(!$valarray['xmlrpc'])
|
|
{
|
|
unset($this->settings[$key]);
|
|
}
|
|
}
|
|
}
|
|
else
|
|
{
|
|
/* Here we include the settings hook file for the current template, if it exists.
|
|
This is not handled by the hooks class and is only valid if not using xml-rpc.
|
|
*/
|
|
$tmpl_settings = EGW_SERVER_ROOT.$GLOBALS['egw']->framework->template_dir.'/hook_settings.inc.php';
|
|
if($this->appname == 'preferences' && file_exists($tmpl_settings))
|
|
{
|
|
include($tmpl_settings);
|
|
$this->settings = array_merge($this->settings,$GLOBALS['settings']);
|
|
}
|
|
}
|
|
// check if we have a default/forced value from the settings hook,
|
|
// which is NOT stored as default currently
|
|
// --> store it as default, to allow to propagate defaults to existing installations
|
|
foreach ($this->settings as $name => $data)
|
|
{
|
|
// only set not yet set default prefs, so user is able to unset it again with ""
|
|
// (only works with type vfs_*, other types delete empty values!)
|
|
if (!isset($GLOBALS['egw']->preferences->default[$appname][$name]) &&
|
|
((string)$data['default'] !== '' || (string)$data['forced'] !== ''))
|
|
{
|
|
$default = (string)$data['forced'] !== '' ? $data['forced'] : $data['default'];
|
|
//echo "<p>".__METHOD__."($appname) $this->appname/$appname/$name=$default NOT yet set!</p>\n";
|
|
$GLOBALS['egw']->preferences->default[$appname][$name] = $default;
|
|
$need_update = true;
|
|
}
|
|
}
|
|
if ($need_update)
|
|
{
|
|
$GLOBALS['egw']->preferences->save_repository(false,'default',true);
|
|
}
|
|
if($this->debug)
|
|
{
|
|
_debug_array($this->settings);
|
|
}
|
|
return True;
|
|
}
|
|
} |