forked from extern/egroupware
* Preferences: now stored JSON encoded in database (also removed many deprecated methods)
This commit is contained in:
parent
e6a6b271e3
commit
60106975aa
@ -1,6 +1,6 @@
|
||||
<?php
|
||||
/**
|
||||
* eGroupWare API - Preferences
|
||||
* EGroupware API - Preferences
|
||||
*
|
||||
* @link http://www.egroupware.org
|
||||
* @author Joseph Engo <jengo@phpgroupware.org>
|
||||
@ -28,6 +28,9 @@
|
||||
* create a new instance of preferences class, with the given id of the group. This takes into
|
||||
* account the offset of DEFAULT_ID, we are using currently for groups (as -1, and -2) are already
|
||||
* taken!
|
||||
*
|
||||
* Preferences get now json-encoded and no longer PHP serialized and addslashed,
|
||||
* thought they only change when they get updated.
|
||||
*/
|
||||
class preferences
|
||||
{
|
||||
@ -86,9 +89,9 @@ class preferences
|
||||
var $db;
|
||||
/**
|
||||
* table-name
|
||||
* @var string
|
||||
*/
|
||||
var $table = 'egw_preferences';
|
||||
const TABLE = 'egw_preferences';
|
||||
var $table = self::TABLE;
|
||||
|
||||
var $values,$vars; // standard notify substitues, will be set by standard_substitues()
|
||||
|
||||
@ -170,7 +173,7 @@ class preferences
|
||||
*/
|
||||
function preferences($account_id = '')
|
||||
{
|
||||
self::__construct();
|
||||
self::__construct($account_id);
|
||||
}
|
||||
|
||||
/**
|
||||
@ -211,15 +214,8 @@ class preferences
|
||||
{
|
||||
// The following replacement is required for PostgreSQL to work
|
||||
$app = trim($row['preference_app']);
|
||||
$value = unserialize($row['preference_value']);
|
||||
if($value === false)
|
||||
{
|
||||
// manually retrieve the string lengths of the serialized array if unserialize failed
|
||||
$value = unserialize(preg_replace('!s:(\d+):"(.*?)";!se', "'s:'.mb_strlen('$2','8bit').':\"$2\";'", $row['preference_value']));
|
||||
}
|
||||
$this->unquote($value);
|
||||
|
||||
$prefs[$row['preference_owner']][$app] = $value;
|
||||
$prefs[$row['preference_owner']][$app] = self::unserialize($row['preference_value']);
|
||||
}
|
||||
foreach($db_read as $id)
|
||||
{
|
||||
@ -269,7 +265,7 @@ class preferences
|
||||
*/
|
||||
function lang_notify($msg,$vals=array(),$un_lang=False)
|
||||
{
|
||||
foreach($vals as $key => $val)
|
||||
foreach(array_keys($vals) as $key)
|
||||
{
|
||||
$lname = ($lname = lang($key)) == $key.'*' ? $key : $lname;
|
||||
if ($un_lang)
|
||||
@ -295,6 +291,7 @@ class preferences
|
||||
$GLOBALS['egw_info']['user']['preferences'] = $this->data; // else no lang()
|
||||
}
|
||||
// we cant use phpgw_info/user/fullname, as it's not set when we run
|
||||
$lid = $fname = $lname = null;
|
||||
$GLOBALS['egw']->accounts->get_account_name($this->account_id,$lid,$fname,$lname);
|
||||
|
||||
$this->values = array( // standard notify replacements
|
||||
@ -343,12 +340,39 @@ class preferences
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Unserialize data from either json_encode or PHP serialize and addslashes
|
||||
*
|
||||
* @param string $str serialized prefs
|
||||
* @return array
|
||||
*/
|
||||
protected static function unserialize($str)
|
||||
{
|
||||
// handling of new json-encoded prefs
|
||||
if ($str[0] == '{')
|
||||
{
|
||||
return json_decode($str, true);
|
||||
}
|
||||
// handling of old PHP serialized and addslashed prefs
|
||||
$data = unserialize($str);
|
||||
if($data === false)
|
||||
{
|
||||
// manually retrieve the string lengths of the serialized array if unserialize failed
|
||||
$data = unserialize(preg_replace_callback('!s:(\d+):"(.*?)";!se', function($matches)
|
||||
{
|
||||
return 's:'.mb_strlen($matches[2],'8bit').':"'.$matches[2].'";';
|
||||
}, $str));
|
||||
}
|
||||
self::unquote($data);
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* unquote (stripslashes) recursivly the whole array
|
||||
*
|
||||
* @param array &$arr array to unquote (var-param!)
|
||||
*/
|
||||
function unquote(&$arr)
|
||||
protected static function unquote(&$arr)
|
||||
{
|
||||
if (!is_array($arr))
|
||||
{
|
||||
@ -359,7 +383,7 @@ class preferences
|
||||
{
|
||||
if (is_array($value))
|
||||
{
|
||||
$this->unquote($arr[$key]);
|
||||
self::unquote($arr[$key]);
|
||||
}
|
||||
else
|
||||
{
|
||||
@ -703,19 +727,20 @@ class preferences
|
||||
}
|
||||
|
||||
/**
|
||||
* Completely delete the specified preference name from all users
|
||||
* Change single value in preferences of all users (incl. groups, default and forced)
|
||||
*
|
||||
* @param string $app Application name
|
||||
* @param string $name Preference name
|
||||
* @param string $type='user' of preference to set: forced, default, user
|
||||
* @param string $app
|
||||
* @param string $name
|
||||
* @param string $value new value to set, or null or '' to delete it
|
||||
* @param string $old_value if given, only change if that's current value
|
||||
* @param string $type if given limit to "user", "forced", "default", "group"
|
||||
*/
|
||||
public function delete_preference($app, $name, $type='user')
|
||||
public static function change_preference($app, $name, $value, $old_value=null, $type=null)
|
||||
{
|
||||
$GLOBALS['egw']->db->transaction_begin();
|
||||
$db = isset($GLOBALS['egw_setup']->db) ? $GLOBALS['egw_setup']->db : $GLOBALS['egw']->db;
|
||||
|
||||
$where = array(
|
||||
'preference_app' => $app,
|
||||
'preference_value ' . $this->db->capabilities[egw_db::CAPABILITY_CASE_INSENSITIV_LIKE].' ' .
|
||||
$this->db->quote("%$name%")
|
||||
);
|
||||
switch($type)
|
||||
{
|
||||
@ -728,113 +753,54 @@ class preferences
|
||||
case 'user':
|
||||
$where[] = 'preference_owner > 0';
|
||||
break;
|
||||
case 'group':
|
||||
$where[] = 'preference_owner < '.self::DEFAULT_ID;
|
||||
break;
|
||||
}
|
||||
foreach($this->db->select($this->table,'*',$where,__LINE__,__FILE__) as $row)
|
||||
foreach($db->select(self::TABLE, '*', $where, __LINE__, __FILE__) as $row)
|
||||
{
|
||||
$value = unserialize($row['preference_value']);
|
||||
if(array_key_exists($name, $value))
|
||||
$prefs = self::unserialize($row['preference_value']);
|
||||
|
||||
if (isset($old_value) && $prefs[$name] != $old_value) continue;
|
||||
|
||||
if ((string)$value !== '')
|
||||
{
|
||||
unset($value[$name]);
|
||||
$this->quote($value); // this quote-ing is for serialize, not for the db
|
||||
$GLOBALS['egw']->db->insert($this->table,array(
|
||||
'preference_value' => serialize($value),
|
||||
),array(
|
||||
'preference_owner' => $row['preference_owner'],
|
||||
'preference_app' => $row['preference_app'],
|
||||
),__LINE__,__FILE__);
|
||||
// update instance-wide cache
|
||||
$cached = egw_cache::getInstance(__CLASS__, $row['preference_owner']);
|
||||
if($cached && $cached[$row['preference_app']])
|
||||
{
|
||||
$cached[$row['preference_app']] = $value;
|
||||
egw_cache::setInstance(__CLASS__, $row['preference_owner'], $cached);
|
||||
}
|
||||
}
|
||||
}
|
||||
$GLOBALS['egw']->db->transaction_commit();
|
||||
}
|
||||
|
||||
/**************************************************************************\
|
||||
* These are the standard $this->account_id specific functions *
|
||||
\**************************************************************************/
|
||||
|
||||
/**
|
||||
* add complex array data preference to $app_name a particular app
|
||||
*
|
||||
* @deprecated we can now correctly store arrays in the prefs, AFAIK only used in email
|
||||
*
|
||||
* @param string $app_name name of the app
|
||||
* @param string $var array keys separated by '/', eg. 'ex_accounts/1'
|
||||
* @param mixed $value='' value of the preference
|
||||
* @return array with new effective prefs (even when forced or default prefs are deleted!)
|
||||
*/
|
||||
function add_struct($app_name,$var,$value = '')
|
||||
{
|
||||
$parts = explode('/',str_replace(array('][','[',']','"',"'"),array('/','','','',''),$var));
|
||||
$data = &$this->data[$app_name];
|
||||
$user = &$this->user[$app_name];
|
||||
foreach($parts as $name)
|
||||
{
|
||||
$data = &$data[$name];
|
||||
$user = &$user[$name];
|
||||
}
|
||||
$data = $user = $value;
|
||||
print_debug('class.preferences: add_struct: $this->data[$app_name] dump:', $this->data[$app_name],'api');
|
||||
reset($this->data);
|
||||
return $this->data;
|
||||
}
|
||||
|
||||
/**
|
||||
* delete complex array data preference from $app_name
|
||||
*
|
||||
* @deprecated we can now correctly store arrays in the prefs, AFAIK only used in email
|
||||
*
|
||||
* @param $app_name name of app
|
||||
* @param $var array keys separated by '/', eg. 'ex_accounts/1'
|
||||
* @return array with new effective prefs (even when forced or default prefs are deleted!)
|
||||
*/
|
||||
function delete_struct($app_name, $var = '')
|
||||
{
|
||||
$parts = explode('/',str_replace(array('][','[',']','"',"'"),array('/','','','',''),$var));
|
||||
$last = array_pop($parts);
|
||||
$data = &$this->data[$app_name];
|
||||
$user = &$this->user[$app_name];
|
||||
foreach($parts as $name)
|
||||
{
|
||||
$data = &$data[$name];
|
||||
$user = &$user[$name];
|
||||
}
|
||||
unset($user[$last]);
|
||||
print_debug('* $this->data[$app_name] dump:', $this->data[$app_name],'api');
|
||||
reset ($this->data);
|
||||
return $this->data;
|
||||
}
|
||||
|
||||
/**
|
||||
* quote (addslashes) recursivly the whole array
|
||||
*
|
||||
* @param array &$arr array to quote (var-param!)
|
||||
*/
|
||||
function quote(&$arr)
|
||||
{
|
||||
if (!is_array($arr))
|
||||
{
|
||||
$arr = addslashes($arr);
|
||||
return;
|
||||
}
|
||||
foreach($arr as $key => $value)
|
||||
{
|
||||
if (is_array($value))
|
||||
{
|
||||
$this->quote($arr[$key]);
|
||||
$prefs[$name] = $value;
|
||||
}
|
||||
else
|
||||
{
|
||||
$arr[$key] = addslashes($value);
|
||||
unset($prefs[$name]);
|
||||
}
|
||||
|
||||
$db->update(self::TABLE, array(
|
||||
'preference_value' => json_encode($prefs),
|
||||
), array(
|
||||
'preference_owner' => $row['preference_owner'],
|
||||
'preference_app' => $row['preference_app'],
|
||||
), __LINE__, __FILE__);
|
||||
|
||||
// update instance-wide cache
|
||||
$cached = egw_cache::getInstance(__CLASS__, $row['preference_owner']);
|
||||
if($cached && $cached[$row['preference_app']])
|
||||
{
|
||||
$cached[$row['preference_app']] = $value;
|
||||
egw_cache::setInstance(__CLASS__, $row['preference_owner'], $cached);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Completely delete the specified preference name from all users
|
||||
*
|
||||
* @param string $app Application name
|
||||
* @param string $name Preference name
|
||||
* @param string $type='user' of preference to set: forced, default, user
|
||||
*/
|
||||
public static function delete_preference($app, $name, $type='user')
|
||||
{
|
||||
self::change_preference($app, $name, null, null, $type);
|
||||
}
|
||||
|
||||
/**
|
||||
* Save the the preferences to the repository
|
||||
*
|
||||
@ -847,6 +813,8 @@ class preferences
|
||||
*/
|
||||
function save_repository($update_session_info = False,$type='user',$invalid_cache=true)
|
||||
{
|
||||
unset($update_session_info, $invalid_cache); // no longer used
|
||||
|
||||
switch($type)
|
||||
{
|
||||
case 'forced':
|
||||
@ -859,7 +827,7 @@ class preferences
|
||||
break;
|
||||
case 'group':
|
||||
throw new egw_exception_wrong_parameter("Can NOT save group preferences, as they are from multiple groups!");
|
||||
break;
|
||||
|
||||
default:
|
||||
$account_id = (int)$this->account_id;
|
||||
$prefs = &$this->user; // we use the user-array as data contains default values too
|
||||
@ -884,10 +852,8 @@ class preferences
|
||||
}
|
||||
else
|
||||
{
|
||||
$this->quote($value); // this quote-ing is for serialize, not for the db
|
||||
|
||||
$this->db->insert($this->table,array(
|
||||
'preference_value' => serialize($value),
|
||||
'preference_value' => json_encode($value),
|
||||
),array(
|
||||
'preference_owner' => $account_id,
|
||||
'preference_app' => $app,
|
||||
@ -904,192 +870,12 @@ class preferences
|
||||
}
|
||||
|
||||
/**
|
||||
* insert a copy of the default preferences for use by real account_id
|
||||
*
|
||||
* @deprecated not longer needed, as the defaults are merged in on runtime
|
||||
*
|
||||
* @param int $account_id numerical id of account for which to create the prefs
|
||||
* @deprecated use add
|
||||
*/
|
||||
function create_defaults($account_id)
|
||||
{
|
||||
}
|
||||
|
||||
/**
|
||||
* update the preferences array
|
||||
*
|
||||
* @param array $data array of preferences
|
||||
* @return array with new effective prefs (even when forced or default prefs are deleted!)
|
||||
*/
|
||||
function update_data($data)
|
||||
{
|
||||
$this->data = $data;
|
||||
reset($this->data);
|
||||
return $this->data;
|
||||
}
|
||||
|
||||
/* legacy support */
|
||||
function change($app_name,$var,$value = "")
|
||||
{
|
||||
return $this->add($app_name,$var,$value);
|
||||
}
|
||||
function commit($update_session_info = True)
|
||||
{
|
||||
//return $this->save_repository($update_session_info);
|
||||
}
|
||||
|
||||
/**************************************************************************\
|
||||
* These are the non-standard $this->account_id specific functions *
|
||||
\**************************************************************************/
|
||||
|
||||
/**
|
||||
* verify basic settings
|
||||
*
|
||||
* @discussion
|
||||
*/
|
||||
function verify_basic_settings()
|
||||
{
|
||||
if (!@is_array($GLOBALS['egw_info']['user']['preferences']))
|
||||
{
|
||||
$GLOBALS['egw_info']['user']['preferences'] = array();
|
||||
}
|
||||
/* This takes care of new users who don't have proper default prefs setup */
|
||||
if (!isset($GLOBALS['egw_info']['flags']['nocommon_preferences']) ||
|
||||
!$GLOBALS['egw_info']['flags']['nocommon_preferences'])
|
||||
{
|
||||
$preferences_update = False;
|
||||
if (!isset($GLOBALS['egw_info']['user']['preferences']['common']['maxmatchs']) ||
|
||||
!$GLOBALS['egw_info']['user']['preferences']['common']['maxmatchs'])
|
||||
{
|
||||
$this->add('common','maxmatchs',15);
|
||||
$preferences_update = True;
|
||||
}
|
||||
if (!isset($GLOBALS['egw_info']['user']['preferences']['common']['theme']) ||
|
||||
!$GLOBALS['egw_info']['user']['preferences']['common']['theme'])
|
||||
{
|
||||
$this->add('common','theme','default');
|
||||
$preferences_update = True;
|
||||
}
|
||||
if (!isset($GLOBALS['egw_info']['user']['preferences']['common']['template_set']) ||
|
||||
!$GLOBALS['egw_info']['user']['preferences']['common']['template_set'])
|
||||
{
|
||||
$this->add('common','template_set','default');
|
||||
$preferences_update = True;
|
||||
}
|
||||
if (!isset($GLOBALS['egw_info']['user']['preferences']['common']['dateformat']) ||
|
||||
!$GLOBALS['egw_info']['user']['preferences']['common']['dateformat'])
|
||||
{
|
||||
$this->add('common','dateformat','m/d/Y');
|
||||
$preferences_update = True;
|
||||
}
|
||||
if (!isset($GLOBALS['egw_info']['user']['preferences']['common']['timeformat']) ||
|
||||
!$GLOBALS['egw_info']['user']['preferences']['common']['timeformat'])
|
||||
{
|
||||
$this->add('common','timeformat',12);
|
||||
$preferences_update = True;
|
||||
}
|
||||
if (!isset($GLOBALS['egw_info']['user']['preferences']['common']['lang']) ||
|
||||
!$GLOBALS['egw_info']['user']['preferences']['common']['lang'])
|
||||
{
|
||||
$this->add('common','lang',common::getPreferredLanguage());
|
||||
$preferences_update = True;
|
||||
}
|
||||
if ($preferences_update)
|
||||
{
|
||||
$this->save_repository();
|
||||
}
|
||||
unset($preferences_update);
|
||||
}
|
||||
}
|
||||
|
||||
/****************************************************\
|
||||
* Email Preferences and Private Support Functions *
|
||||
\****************************************************/
|
||||
|
||||
/**
|
||||
* Helper function for create_email_preferences, gets mail server port number.
|
||||
*
|
||||
* This will generate the appropriate port number to access a
|
||||
* mail server of type pop3, pop3s, imap, imaps users value from
|
||||
* $phpgw_info['user']['preferences']['email']['mail_port'].
|
||||
* if that value is not set, it generates a default port for the given $server_type.
|
||||
* Someday, this *MAY* be
|
||||
* (a) a se4rver wide admin setting, or
|
||||
* (b)user custom preference
|
||||
* Until then, simply set the port number based on the mail_server_type, thereof
|
||||
* ONLY call this function AFTER ['email']['mail_server_type'] has been set.
|
||||
* @param $prefs - user preferences array based on element ['email'][]
|
||||
* @author Angles
|
||||
* @access Private
|
||||
*/
|
||||
function sub_get_mailsvr_port($prefs, $acctnum=0)
|
||||
{
|
||||
// first we try the port number supplied in preferences
|
||||
if((isset($prefs['email']['accounts'][$acctnum]['mail_port'])) &&
|
||||
($prefs['email']['accounts'][$acctnum]['mail_port'] != ''))
|
||||
{
|
||||
$port_number = $prefs['email']['accounts'][$acctnum]['mail_port'];
|
||||
}
|
||||
// preferences does not have a port number, generate a default value
|
||||
else
|
||||
{
|
||||
if (!isset($prefs['email']['accounts'][$acctnum]['mail_server_type']))
|
||||
{
|
||||
$prefs['email']['accounts'][$acctnum]['mail_server_type'] = $prefs['email']['mail_server_type'];
|
||||
}
|
||||
|
||||
switch($prefs['email']['accounts'][$acctnum]['mail_server_type'])
|
||||
{
|
||||
case 'pop3s':
|
||||
// POP3 over SSL
|
||||
$port_number = 995;
|
||||
break;
|
||||
case 'pop3':
|
||||
// POP3 normal connection, No SSL
|
||||
// ( same string as normal imap above)
|
||||
$port_number = 110;
|
||||
break;
|
||||
case 'nntp':
|
||||
// NNTP news server port
|
||||
$port_number = 119;
|
||||
break;
|
||||
case 'imaps':
|
||||
// IMAP over SSL
|
||||
$port_number = 993;
|
||||
break;
|
||||
case 'imap':
|
||||
// IMAP normal connection, No SSL
|
||||
default:
|
||||
// UNKNOWN SERVER in Preferences, return a
|
||||
// default value that is likely to work
|
||||
// probably should raise some kind of error here
|
||||
$port_number = 143;
|
||||
break;
|
||||
}
|
||||
}
|
||||
return $port_number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper function for create_email_preferences, gets default userid for email
|
||||
*
|
||||
* This will generate the appropriate userid for accessing an email server.
|
||||
* In the absence of a custom ['email']['userid'], this function should be used to set it.
|
||||
* @param $accountid - as determined in and/or passed to "create_email_preferences"
|
||||
* @access Private
|
||||
*/
|
||||
function sub_default_userid($account_id='')
|
||||
{
|
||||
if ($GLOBALS['egw_info']['server']['mail_login_type'] == 'vmailmgr')
|
||||
{
|
||||
$prefs_email_userid = $GLOBALS['egw']->accounts->id2name($account_id)
|
||||
. '@' . $GLOBALS['egw_info']['server']['mail_suffix'];
|
||||
}
|
||||
else
|
||||
{
|
||||
$prefs_email_userid = $GLOBALS['egw']->accounts->id2name($account_id);
|
||||
}
|
||||
return $prefs_email_userid;
|
||||
}
|
||||
|
||||
/**
|
||||
* returns the custom email-address (if set) or generates a default one
|
||||
@ -1121,315 +907,4 @@ class preferences
|
||||
}
|
||||
return $prefs_email_address;
|
||||
}
|
||||
|
||||
function sub_default_address($account_id='')
|
||||
{
|
||||
return $this->email_address($account_id);
|
||||
}
|
||||
|
||||
/**
|
||||
* create email preferences
|
||||
*
|
||||
* @param $account_id -optional defaults to : get_account_id()
|
||||
* fills a local copy of ['email'][] prefs array which is then returned to the calling
|
||||
* function, which the calling function generally tacks onto the $GLOBALS['egw_info'] array as such:
|
||||
* $GLOBALS['egw_info']['user']['preferences'] = $GLOBALS['egw']->preferences->create_email_preferences();
|
||||
* which fills an array based at:
|
||||
* $GLOBALS['egw_info']['user']['preferences']['email'][prefs_are_elements_here]
|
||||
* Reading the raw preference DB data and comparing to the email preference schema defined in
|
||||
* /email/class.bopreferences.inc.php (see discussion there and below) to create default preference values
|
||||
* for the in the ['email'][] pref data array in cases where the user has not supplied
|
||||
* a preference value for any particular preference item available to the user.
|
||||
* @access Public
|
||||
*/
|
||||
function create_email_preferences($accountid='', $acctnum=0)
|
||||
{
|
||||
print_debug('class.preferences: create_email_preferences: ENTERING<br>', 'messageonly','api');
|
||||
// we may need function "html_quotes_decode" from the mail_msg class
|
||||
$email_base =& CreateObject("email.mail_msg");
|
||||
|
||||
$account_id = get_account_id($accountid);
|
||||
// If the current user is not the request user, grab the preferences
|
||||
// and reset back to current user.
|
||||
if($account_id != $this->account_id)
|
||||
{
|
||||
// Temporarily store the values to a temp, so when the
|
||||
// read_repository() is called, it doesn't destory the
|
||||
// current users settings.
|
||||
$temp_account_id = $this->account_id;
|
||||
$temp_data = $this->data;
|
||||
|
||||
// Grab the new users settings, only if they are not the
|
||||
// current users settings.
|
||||
$this->account_id = $account_id;
|
||||
$prefs = $this->read_repository();
|
||||
|
||||
// Reset the data to what it was prior to this call
|
||||
$this->account_id = $temp_account_id;
|
||||
$this->data = $temp_data;
|
||||
}
|
||||
else
|
||||
{
|
||||
$prefs = $this->data;
|
||||
}
|
||||
// are we dealing with the default email account or an extra email account?
|
||||
if ($acctnum != 0)
|
||||
{
|
||||
// prefs are actually a sub-element of the main email prefs
|
||||
// at location [email][ex_accounts][X][...pref names] => pref values
|
||||
// make this look like "prefs[email] so the code below code below will do its job transparently
|
||||
|
||||
// obtain the desired sub-array of extra account prefs
|
||||
$sub_prefs = array();
|
||||
$sub_prefs['email'] = $prefs['email']['ex_accounts'][$acctnum];
|
||||
// make the switch, make it seem like top level email prefs
|
||||
$prefs = array();
|
||||
$prefs['email'] = $sub_prefs['email'];
|
||||
// since we return just $prefs, it's up to the calling program to put the sub prefs in the right place
|
||||
}
|
||||
print_debug('class.preferences: create_email_preferences: $acctnum: ['.$acctnum.'] ; raw $this->data dump', $this->data,'api');
|
||||
|
||||
// = = = = NOT-SIMPLE PREFS = = = =
|
||||
// Default Preferences info that is:
|
||||
// (a) not controlled by email prefs itself (mostly api and/or server level stuff)
|
||||
// (b) too complicated to be described in the email prefs data array instructions
|
||||
|
||||
// --- [server][mail_server_type] ---
|
||||
// Set API Level Server Mail Type if not defined
|
||||
// if for some reason the API didnot have a mail server type set during initialization
|
||||
if (empty($GLOBALS['egw_info']['server']['mail_server_type']))
|
||||
{
|
||||
$GLOBALS['egw_info']['server']['mail_server_type'] = 'imap';
|
||||
}
|
||||
|
||||
// --- [server][mail_folder] ---
|
||||
// ==== UWash Mail Folder Location used to be "mail", now it's changeable, but keep the
|
||||
// ==== default to "mail" so upgrades happen transparently
|
||||
// --- TEMP MAKE DEFAULT UWASH MAIL FOLDER ~/mail (a.k.a. $HOME/mail)
|
||||
$GLOBALS['egw_info']['server']['mail_folder'] = 'mail';
|
||||
// --- DELETE THE ABOVE WHEN THIS OPTION GETS INTO THE SYSTEM SETUP
|
||||
// pick up custom "mail_folder" if it exists (used for UWash and UWash Maildir servers)
|
||||
// else use the system default (which we temporarily hard coded to "mail" just above here)
|
||||
|
||||
//--- [email][mail_port] ---
|
||||
// These sets the mail_port server variable
|
||||
// someday (not currently) this may be a site-wide property set during site setup
|
||||
// additionally, someday (not currently) the user may be able to override this with
|
||||
// a custom email preference. Currently, we simply use standard port numbers
|
||||
// for the service in question.
|
||||
$prefs['email']['mail_port'] = $this->sub_get_mailsvr_port($prefs);
|
||||
|
||||
//--- [email][fullname] ---
|
||||
// we pick this up from phpgw api for the default account
|
||||
// the user does not directly manipulate this pref for the default email account
|
||||
if ((string)$acctnum == '0')
|
||||
{
|
||||
$prefs['email']['fullname'] = $GLOBALS['egw_info']['user']['account_fullname'];
|
||||
}
|
||||
|
||||
// = = = = SIMPLER PREFS = = = =
|
||||
|
||||
// Default Preferences info that is articulated in the email prefs schema array itself
|
||||
// such email prefs schema array is described and established in /email/class.bopreferences
|
||||
// by function "init_available_prefs", see the discussion there.
|
||||
|
||||
// --- create the objectified /email/class.bopreferences.inc.php ---
|
||||
$bo_mail_prefs =& CreateObject('email.bopreferences');
|
||||
|
||||
// --- bo_mail_prefs->init_available_prefs() ---
|
||||
// this fills object_email_bopreferences->std_prefs and ->cust_prefs
|
||||
// we will initialize the users preferences according to the rules and instructions
|
||||
// embodied in those prefs arrays, applying those rules to the unprocessed
|
||||
// data read from the preferences DB. By taking the raw data and applying those rules,
|
||||
// we will construct valid and known email preference data for this user.
|
||||
$bo_mail_prefs->init_available_prefs();
|
||||
|
||||
// --- combine the two array (std and cust) for 1 pass handling ---
|
||||
// when this preference DB was submitted and saved, it was hopefully so well structured
|
||||
// that we can simply combine the two arrays, std_prefs and cust_prefs, and do a one
|
||||
// pass analysis and preparation of this users preferences.
|
||||
$avail_pref_array = $bo_mail_prefs->std_prefs;
|
||||
$c_cust_prefs = count($bo_mail_prefs->cust_prefs);
|
||||
for($i=0;$i<$c_cust_prefs;$i++)
|
||||
{
|
||||
// add each custom prefs to the std prefs array
|
||||
$next_idx = count($avail_pref_array);
|
||||
$avail_pref_array[$next_idx] = $bo_mail_prefs->cust_prefs[$i];
|
||||
}
|
||||
print_debug('class.preferences: create_email_preferences: std AND cust arrays combined:', $avail_pref_array,'api');
|
||||
|
||||
// --- make the schema-based pref data for this user ---
|
||||
// user defined values and/or user specified custom email prefs are read from the
|
||||
// prefs DB with mininal manipulation of the data. Currently the only change to
|
||||
// users raw data is related to reversing the encoding of "database un-friendly" chars
|
||||
// which itself may become unnecessary if and when the database handlers can reliably
|
||||
// take care of this for us. Of course, password data requires special decoding,
|
||||
// but the password in the array [email][paswd] should be left in encrypted form
|
||||
// and only decrypted seperately when used to login in to an email server.
|
||||
|
||||
// --- generating a default value if necessary ---
|
||||
// in the absence of a user defined custom email preference for a particular item, we can
|
||||
// determine the desired default value for that pref as such:
|
||||
// $this_avail_pref['init_default'] is a comma seperated seperated string which should
|
||||
// be exploded into an array containing 2 elements that are:
|
||||
// exploded[0] : an description of how to handle the next string element to get a default value.
|
||||
// Possible "instructional tokens" for exploded[0] (called $set_proc[0] below) are:
|
||||
// string
|
||||
// set_or_not
|
||||
// function
|
||||
// init_no_fill
|
||||
// varEVAL
|
||||
// tells you how to handle the string in exploded[1] (called $set_proc[1] below) to get a valid
|
||||
// default value for a particular preference if one is needed (i.e. if no user custom
|
||||
// email preference exists that should override that default value, in which case we
|
||||
// do not even need to obtain such a default value as described in ['init_default'] anyway).
|
||||
|
||||
// --- loop thru $avail_pref_array and process each pref item ---
|
||||
$c_prefs = count($avail_pref_array);
|
||||
for($i=0;$i<$c_prefs;$i++)
|
||||
{
|
||||
$this_avail_pref = $avail_pref_array[$i];
|
||||
print_debug('class.preferences: create_email_preferences: value from DB for $prefs[email]['.$this_avail_pref['id'].'] = ['.$prefs['email'][$this_avail_pref['id']].']', 'messageonly','api');
|
||||
print_debug('class.preferences: create_email_preferences: std/cust_prefs $this_avail_pref['.$i.'] dump:', $this_avail_pref,'api');
|
||||
|
||||
// --- is there a value in the DB for this preference item ---
|
||||
// if the prefs DB has no value for this defined available preference, we must make one.
|
||||
// This occurs if (a) this is user's first login, or (b) this is a custom pref which the user
|
||||
// has not overriden, do a default (non-custom) value is needed.
|
||||
if (!isset($prefs['email'][$this_avail_pref['id']]))
|
||||
{
|
||||
// now we are analizing an individual pref that is available to the user
|
||||
// AND the user had no existing value in the prefs DB for this.
|
||||
|
||||
// --- get instructions on how to generate a default value ---
|
||||
$set_proc = explode(',', $this_avail_pref['init_default']);
|
||||
print_debug(' * set_proc=['.serialize($set_proc).']', 'messageonly','api');
|
||||
|
||||
// --- use "instructional token" in $set_proc[0] to take appropriate action ---
|
||||
// STRING
|
||||
if ($set_proc[0] == 'string')
|
||||
{
|
||||
// means this pref item's value type is string
|
||||
// which defined string default value is in $set_proc[1]
|
||||
print_debug('* handle "string" set_proc: ', serialize($set_proc),'api');
|
||||
if (trim($set_proc[1]) == '')
|
||||
{
|
||||
// this happens when $this_avail_pref['init_default'] = "string, "
|
||||
$this_string = '';
|
||||
}
|
||||
else
|
||||
{
|
||||
$this_string = $set_proc[1];
|
||||
}
|
||||
$prefs['email'][$this_avail_pref['id']] = $this_string;
|
||||
}
|
||||
// SET_OR_NOT
|
||||
elseif ($set_proc[0] == 'set_or_not')
|
||||
{
|
||||
// typical with boolean options, True = "set/exists" and False = unset
|
||||
print_debug('* handle "set_or_not" set_proc: ', serialize($set_proc),'api');
|
||||
if ($set_proc[1] == 'not_set')
|
||||
{
|
||||
// leave it NOT SET
|
||||
}
|
||||
else
|
||||
{
|
||||
// opposite of boolean not_set = string "True" which simply sets a
|
||||
// value it exists in the users session [email][] preference array
|
||||
$prefs['email'][$this_avail_pref['id']] = 'True';
|
||||
}
|
||||
}
|
||||
// FUNCTION
|
||||
elseif ($set_proc[0] == 'function')
|
||||
{
|
||||
// string in $set_proc[1] should be "eval"uated as code, calling a function
|
||||
// which will give us a default value to put in users session [email][] prefs array
|
||||
print_debug(' * handle "function" set_proc: ', serialize($set_proc),'api');
|
||||
$evaled = '';
|
||||
//eval('$evaled = $this->'.$set_proc[1].'('.$account_id.');');
|
||||
|
||||
$code = '$evaled = $this->'.$set_proc[1].'('.$account_id.');';
|
||||
print_debug(' * $code: ', $code,'api');
|
||||
eval($code);
|
||||
|
||||
print_debug('* $evaled:', $evaled,'api');
|
||||
$prefs['email'][$this_avail_pref['id']] = $evaled;
|
||||
}
|
||||
// INIT_NO_FILL
|
||||
elseif ($set_proc[0] == 'init_no_fill')
|
||||
{
|
||||
// we have an available preference item that we may NOT fill with a default
|
||||
// value. Only the user may supply a value for this pref item.
|
||||
print_debug('* handle "init_no_fill" set_proc:', serialize($set_proc),'api');
|
||||
// we are FORBADE from filling this at this time!
|
||||
}
|
||||
// varEVAL
|
||||
elseif ($set_proc[0] == 'varEVAL')
|
||||
{
|
||||
// similar to "function" but used for array references, the string in $set_proc[1]
|
||||
// represents code which typically is an array referencing a system/api property
|
||||
print_debug('* handle "GLOBALS" set_proc:', serialize($set_proc),'api');
|
||||
$evaled = '';
|
||||
$code = '$evaled = '.$set_proc[1];
|
||||
print_debug(' * $code:', $code,'api');
|
||||
eval($code);
|
||||
print_debug('* $evaled:', $evaled,'api');
|
||||
$prefs['email'][$this_avail_pref['id']] = $evaled;
|
||||
}
|
||||
else
|
||||
{
|
||||
// error, no instructions on how to handle this element's default value creation
|
||||
echo 'class.preferences: create_email_preferences: set_proc ERROR: '.serialize($set_proc).'<br>';
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
// we have a value in the database, do we need to prepare it in any way?
|
||||
// (the following discussion is unconfirmed:)
|
||||
// DO NOT ALTER the data in the prefs array!!!! or the next time we call
|
||||
// save_repository withOUT undoing what we might do here, the
|
||||
// prefs will permenantly LOOSE the very thing(s) we are un-doing
|
||||
/// here until the next OFFICIAL submit email prefs function, where it
|
||||
// will again get this preparation before being written to the database.
|
||||
|
||||
// NOTE: if database de-fanging is eventually handled deeper in the
|
||||
// preferences class, then the following code would become depreciated
|
||||
// and should be removed in that case.
|
||||
if (($this_avail_pref['type'] == 'user_string') &&
|
||||
(stristr($this_avail_pref['write_props'], 'no_db_defang') == False))
|
||||
{
|
||||
// this value was "de-fanged" before putting it in the database
|
||||
// undo that defanging now
|
||||
$db_unfriendly = $email_base->html_quotes_decode($prefs['email'][$this_avail_pref['id']]);
|
||||
$prefs['email'][$this_avail_pref['id']] = $db_unfriendly;
|
||||
}
|
||||
}
|
||||
}
|
||||
// users preferences are now established to known structured values...
|
||||
|
||||
// SANITY CHECK
|
||||
// --- [email][use_trash_folder] ---
|
||||
// --- [email][use_sent_folder] ---
|
||||
// is it possible to use Trash and Sent folders - i.e. using IMAP server
|
||||
// if not - force settings to false
|
||||
if (stristr($prefs['email']['mail_server_type'], 'imap') == False)
|
||||
{
|
||||
if (isset($prefs['email']['use_trash_folder']))
|
||||
{
|
||||
unset($prefs['email']['use_trash_folder']);
|
||||
}
|
||||
|
||||
if (isset($prefs['email']['use_sent_folder']))
|
||||
{
|
||||
unset($prefs['email']['use_sent_folder']);
|
||||
}
|
||||
}
|
||||
|
||||
// DEBUG : force some settings to test stuff
|
||||
//$prefs['email']['p_persistent'] = 'True';
|
||||
|
||||
print_debug('class.preferences: $acctnum: ['.$acctnum.'] ; create_email_preferences: $prefs[email]', $prefs['email'],'api');
|
||||
print_debug('class.preferences: create_email_preferences: LEAVING', 'messageonly','api');
|
||||
return $prefs;
|
||||
}
|
||||
}
|
||||
|
Loading…
Reference in New Issue
Block a user