modules/UserPreferences/UserPreference.php

   1 <?php
   2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
   3 /*********************************************************************************
   4  * SugarCRM Community Edition is a customer relationship management program developed by
   5  * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU Affero General Public License version 3 as published by the
   9  * Free Software Foundation with the addition of the following permission added
  10  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  11  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  12  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License along with
  20  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  21  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA.
  23  *
  24  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  25  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  26  *
  27  * The interactive user interfaces in modified source and object code versions
  28  * of this program must display Appropriate Legal Notices, as required under
  29  * Section 5 of the GNU Affero General Public License version 3.
  30  *
  31  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  32  * these Appropriate Legal Notices must retain the display of the "Powered by
  33  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  34  * technical reasons, the Appropriate Legal Notices must display the words
  35  * "Powered by SugarCRM".
  36  ********************************************************************************/
  37
  38 /*********************************************************************************
  39
  40  * Description: Handles the User Preferences and stores them in a separate table.
  41  * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  42  * All Rights Reserved.
  43  * Contributor(s): ______________________________________..
  44  ********************************************************************************/
  45
  46 class UserPreference extends SugarBean
  47 {
  48     public $db;
  49     public $field_name_map;
  50
  51     // Stored fields
  52     public $id;
  53     public $date_entered;
  54     public $date_modified;
  55     public $assigned_user_id;
  56     public $assigned_user_name;
  57     public $name;
  58     public $category;
  59     public $contents;
  60     public $deleted;
  61
  62     public $object_name = 'UserPreference';
  63     public $table_name = 'user_preferences';
  64
  65     public $disable_row_level_security = true;
  66     public $module_dir = 'UserPreferences';
  67     public $field_defs = array();
  68     public $field_defs_map = array();
  69     public $new_schema = true;
  70
  71     protected $_userFocus;
  72
  73     // Do not actually declare, use the functions statically
  74     public function __construct(
  75         User $user = null
  76         )
  77     {
  78         parent::SugarBean();
  79
  80         $this->_userFocus = $user;
  81         $this->tracker_visibility = false;
  82     }
  83
  84     /**
  85      * Get preference by name and category. Lazy loads preferences from the database per category
  86      *
  87      * @param string $name name of the preference to retreive
  88      * @param string $category name of the category to retreive, defaults to global scope
  89      * @return mixed the value of the preference (string, array, int etc)
  90      */
  91     public function getPreference(
  92         $name,
  93         $category = 'global'
  94         )
  95     {
  96         global $sugar_config;
  97
  98         $user = $this->_userFocus;
  99
 100         // if the unique key in session doesn't match the app or prefereces are empty
 101         if(!isset($_SESSION[$user->user_name.'_PREFERENCES'][$category]) || (!empty($_SESSION['unique_key']) && $_SESSION['unique_key'] != $sugar_config['unique_key'])) {
 102             $this->loadPreferences($category);
 103         }
 104         if(isset($_SESSION[$user->user_name.'_PREFERENCES'][$category][$name])) {
 105             return $_SESSION[$user->user_name.'_PREFERENCES'][$category][$name];
 106         }
 107
 108         // check to see if a default preference ( i.e. $sugar_config setting ) exists for this value )
 109         // if so, return it
 110         $value = $this->getDefaultPreference($name,$category);
 111         if ( !is_null($value) ) {
 112             return $value;
 113         }
 114         return null;
 115     }
 116
 117     /**
 118      * Get preference by name and category from the system settings.
 119      *
 120      * @param string $name name of the preference to retreive
 121      * @param string $category name of the category to retreive, defaults to global scope
 122      * @return mixed the value of the preference (string, array, int etc)
 123      */
 124     public function getDefaultPreference(
 125         $name,
 126         $category = 'global'
 127         )
 128     {
 129         global $sugar_config;
 130
 131         // Doesn't support any prefs but global ones
 132         if ( $category != 'global' )
 133             return null;
 134
 135         // First check for name matching $sugar_config variable
 136         if ( isset($sugar_config[$name]) )
 137             return $sugar_config[$name];
 138
 139         // Next, check to see if it's one of the common problem ones
 140         if ( isset($sugar_config['default_'.$name]) )
 141             return $sugar_config['default_'.$name];
 142         if ( $name == 'datef' )
 143             return $sugar_config['default_date_format'];
 144         if ( $name == 'timef' )
 145             return $sugar_config['default_time_format'];
 146         if ( $name == 'email_link_type' )
 147             return $sugar_config['email_default_client'];
 148     }
 149
 150     /**
 151      * Set preference by name and category. Saving will be done in utils.php -> sugar_cleanup
 152      *
 153      * @param string $name name of the preference to retreive
 154      * @param mixed $value value of the preference to set
 155      * @param string $category name of the category to retreive, defaults to global scope
 156      */
 157     public function setPreference(
 158         $name,
 159         $value,
 160         $category = 'global'
 161         )
 162     {
 163         $user = $this->_userFocus;
 164
 165         if ( empty($user->user_name) )
 166             return;
 167
 168         if(!isset($_SESSION[$user->user_name.'_PREFERENCES'][$category])) {
 169             if(!$user->loadPreferences($category))
 170                 $_SESSION[$user->user_name.'_PREFERENCES'][$category] = array();
 171         }
 172
 173         // preferences changed or a new preference, save it to DB
 174         if(!isset($_SESSION[$user->user_name.'_PREFERENCES'][$category][$name])
 175             || (isset($_SESSION[$user->user_name.'_PREFERENCES'][$category][$name]) && $_SESSION[$user->user_name.'_PREFERENCES'][$category][$name] != $value)) {
 176                 $GLOBALS['savePreferencesToDB'] = true;
 177                 if(!isset($GLOBALS['savePreferencesToDBCats'])) $GLOBALS['savePreferencesToDBCats'] = array();
 178                 $GLOBALS['savePreferencesToDBCats'][$category] = true;
 179         }
 180
 181         $_SESSION[$user->user_name.'_PREFERENCES'][$category][$name] = $value;
 182     }
 183
 184     /**
 185      * Loads preference by category from database. Saving will be done in utils.php -> sugar_cleanup
 186      *
 187      * @param string $category name of the category to retreive, defaults to global scope
 188      * @return bool successful?
 189      */
 190     public function loadPreferences(
 191         $category = 'global'
 192         )
 193     {
 194         global $sugar_config;
 195
 196         $user = $this->_userFocus;
 197
 198         if($user->object_name != 'User')
 199             return;
 200         if(!empty($user->id) && (!isset($_SESSION[$user->user_name . '_PREFERENCES'][$category]) || (!empty($_SESSION['unique_key']) && $_SESSION['unique_key'] != $sugar_config['unique_key']))) {
 201             // cn: moving this to only log when valid - throwing errors on install
 202             return $this->reloadPreferences($category);
 203         }
 204         return false;
 205     }
 206
 207     /**
 208      * Unconditionally reloads user preferences from the DB and updates the session
 209      * @param string $category name of the category to retreive, defaults to global scope
 210      * @return bool successful?
 211      */
 212     public function reloadPreferences($category = 'global')
 213     {
 214         $user = $this->_userFocus;
 215
 216         if($user->object_name != 'User' || empty($user->id) || empty($user->user_name)) {
 217             return false;
 218         }
 219         $GLOBALS['log']->debug('Loading Preferences DB ' . $user->user_name);
 220         if(!isset($_SESSION[$user->user_name . '_PREFERENCES'])) $_SESSION[$user->user_name . '_PREFERENCES'] = array();
 221         if(!isset($user->user_preferences) || !is_array($user->user_preferences)) $user->user_preferences = array();
 222         $result = $GLOBALS['db']->query("SELECT contents FROM user_preferences WHERE assigned_user_id='$user->id' AND category = '" . $category . "' AND deleted = 0", false, 'Failed to load user preferences');
 223         $row = $GLOBALS['db']->fetchByAssoc($result);
 224         if ($row) {
 225             $_SESSION[$user->user_name . '_PREFERENCES'][$category] = unserialize(base64_decode($row['contents']));
 226             $user->user_preferences[$category] = unserialize(base64_decode($row['contents']));
 227             return true;
 228         } else {
 229             $_SESSION[$user->user_name . '_PREFERENCES'][$category] = array();
 230             $user->user_preferences[$category] = array();
 231         }
 232         return false;
 233     }
 234
 235     /**
 236      * Loads users timedate preferences
 237      *
 238      * @return array 'date' - date format for user ; 'time' - time format for user
 239      */
 240     public function getUserDateTimePreferences()
 241     {
 242         global $sugar_config, $db, $timedate, $current_user;
 243
 244         $user = $this->_userFocus;
 245
 246         $prefDate = array();
 247
 248         if(!empty($user) && $this->loadPreferences('global')) {
 249             // forced to set this to a variable to compare b/c empty() wasn't working
 250             $timeZone = TimeDate::userTimezone($user);
 251             $timeFormat = $user->getPreference("timef");
 252             $dateFormat = $user->getPreference("datef");
 253
 254             // cn: bug xxxx cron.php fails because of missing preference when admin hasn't logged in yet
 255             $timeZone = empty($timeZone) ? 'America/Los_Angeles' : $timeZone;
 256
 257             if(empty($timeFormat)) $timeFormat = $sugar_config['default_time_format'];
 258             if(empty($dateFormat)) $dateFormat = $sugar_config['default_date_format'];
 259
 260             $prefDate['date'] = $dateFormat;
 261             $prefDate['time'] = $timeFormat;
 262             $prefDate['userGmt'] = TimeDate::tzName($timeZone);
 263             $prefDate['userGmtOffset'] = $timedate->getUserUTCOffset($user);
 264
 265             return $prefDate;
 266         } else {
 267             $prefDate['date'] = $timedate->get_date_format();
 268             $prefDate['time'] = $timedate->get_time_format();
 269
 270             if(!empty($user) && $user->object_name == 'User') {
 271                 $timeZone = TimeDate::userTimezone($user);
 272                 // cn: bug 9171 - if user has no time zone, cron.php fails for InboundEmail
 273                 if(!empty($timeZone)) {
 274                     $prefDate['userGmt'] = TimeDate::tzName($timeZone);
 275                     $prefDate['userGmtOffset'] = $timedate->getUserUTCOffset($user);
 276                 }
 277             } else {
 278                 $timeZone = TimeDate::userTimezone($current_user);
 279                 if(!empty($timeZone)) {
 280                     $prefDate['userGmt'] = TimeDate::tzName($timeZone);
 281                     $prefDate['userGmtOffset'] = $timedate->getUserUTCOffset($current_user);
 282                 }
 283             }
 284
 285             return $prefDate;
 286         }
 287     }
 288
 289     /**
 290      * Saves all preferences into the database that are in the session. Expensive, this is called by default in
 291      * sugar_cleanup if a setPreference has been called during one round trip.
 292      *
 293      * @global user will use current_user if no user specificed in $user param
 294      * @param user $user User object to retrieve, otherwise user current_user
 295      * @param bool $all save all of the preferences? (Dangerous)
 296      *
 297      */
 298     public function savePreferencesToDB(
 299         $all = false
 300         )
 301     {
 302         global $sugar_config;
 303         $GLOBALS['savePreferencesToDB'] = false;
 304
 305         $user = $this->_userFocus;
 306
 307         // these are not the preferences you are looking for [ hand waving ]
 308         if(!empty($_SESSION['unique_key']) && $_SESSION['unique_key'] != $sugar_config['unique_key']) return;
 309
 310         $GLOBALS['log']->debug('Saving Preferences to DB ' . $user->user_name);
 311         if(isset($_SESSION[$user->user_name. '_PREFERENCES']) && is_array($_SESSION[$user->user_name. '_PREFERENCES'])) {
 312              $GLOBALS['log']->debug("Saving Preferences to DB: {$user->user_name}");
 313             // only save the categories that have been modified or all?
 314             if(!$all && isset($GLOBALS['savePreferencesToDBCats']) && is_array($GLOBALS['savePreferencesToDBCats'])) {
 315                 $catsToSave = array();
 316                 foreach($GLOBALS['savePreferencesToDBCats'] as $category => $value) {
 317                     if ( isset($_SESSION[$user->user_name. '_PREFERENCES'][$category]) )
 318                         $catsToSave[$category] = $_SESSION[$user->user_name. '_PREFERENCES'][$category];
 319                 }
 320             }
 321             else {
 322                 $catsToSave = $_SESSION[$user->user_name. '_PREFERENCES'];
 323             }
 324
 325             foreach ($catsToSave as $category => $contents) {
 326                 $focus = new UserPreference($this->_userFocus);
 327                 $result = $focus->retrieve_by_string_fields(array(
 328                     'assigned_user_id' => $user->id,
 329                     'category' => $category,
 330                     ));
 331                 $focus->assigned_user_id = $user->id; // MFH Bug #13862
 332                 $focus->deleted = 0;
 333                 $focus->contents = base64_encode(serialize($contents));
 334                 $focus->category = $category;
 335                 $focus->save();
 336             }
 337         }
 338     }
 339
 340     /**
 341      * Resets preferences for a particular user. If $category is null all user preferences will be reset
 342      *
 343      * @param string $category category to reset
 344      */
 345     public function resetPreferences(
 346         $category = null
 347         )
 348     {
 349         $user = $this->_userFocus;
 350
 351         $GLOBALS['log']->debug('Reseting Preferences for user ' . $user->user_name);
 352
 353         $remove_tabs = $this->getPreference('remove_tabs');
 354         $favorite_reports = $this->getPreference('favorites', 'Reports');
 355         $home_pages = $this->getPreference('pages', 'home');
 356         $home_dashlets = $this->getPreference('dashlets', 'home');
 357         $ut = $this->getPreference('ut');
 358         $timezone = $this->getPreference('timezone');
 359
 360         $query = "UPDATE user_preferences SET deleted = 1 WHERE assigned_user_id = '" . $user->id . "'";
 361         if($category)
 362             $query .= " AND category = '" . $category . "'";
 363         $this->db->query($query);
 364
 365
 366         if($category) {
 367             unset($_SESSION[$user->user_name."_PREFERENCES"][$category]);
 368         }
 369         else {
 370                 if(!empty($_COOKIE['sugar_user_theme']) && !headers_sent()){
 371                 setcookie('sugar_user_theme', '', time() - 3600); // expire the sugar_user_theme cookie
 372             }
 373             unset($_SESSION[$user->user_name."_PREFERENCES"]);
 374             if($user->id == $GLOBALS['current_user']->id) {
 375                 session_destroy();
 376             }
 377             $this->setPreference('remove_tabs', $remove_tabs);
 378             $this->setPreference('favorites', $favorite_reports, 'Reports');
 379             $this->setPreference('pages', $home_pages, 'home');
 380             $this->setPreference('dashlets', $home_dashlets, 'home');
 381             $this->setPreference('ut', $ut);
 382             $this->setPreference('timezone', $timezone);
 383             $this->savePreferencesToDB();
 384         }
 385     }
 386
 387     /**
 388      * Updates every user pref with a new key value supports 2 levels deep, use append to
 389      * array if you want to append the value to an array
 390      */
 391     public static function updateAllUserPrefs(
 392         $key,
 393         $new_value,
 394         $sub_key = '',
 395         $is_value_array = false,
 396         $unset_value = false )
 397     {
 398         global $current_user, $db;
 399
 400         // Admin-only function; die if calling as a non-admin
 401         if(!is_admin($current_user)){
 402             sugar_die('only admins may call this function');
 403         }
 404
 405         // we can skip this if we've already upgraded to the user_preferences format.
 406         if ( !array_key_exists('user_preferences',$db->getHelper()->get_columns('users')) )
 407             return;
 408
 409         $result = $db->query("SELECT id, user_preferences, user_name FROM users");
 410         while ($row = $db->fetchByAssoc($result)) {
 411             $prefs = array();
 412             $newprefs = array();
 413
 414             $prefs = unserialize(base64_decode($row['user_preferences']));
 415
 416             if(!empty($sub_key)){
 417                 if($is_value_array ){
 418                     if(!isset($prefs[$key][$sub_key])){
 419                         continue;
 420                     }
 421
 422                     if(empty($prefs[$key][$sub_key])){
 423                         $prefs[$key][$sub_key] = array();
 424                     }
 425                     $already_exists = false;
 426                     foreach($prefs[$key][$sub_key] as $k=>$value){
 427                         if($value == $new_value){
 428
 429                             $already_exists = true;
 430                             if($unset_value){
 431                                 unset($prefs[$key][$sub_key][$k]);
 432                             }
 433                         }
 434                     }
 435                     if(!$already_exists && !$unset_value){
 436                         $prefs[$key][$sub_key][] = $new_value;
 437                     }
 438                 }
 439                 else{
 440                     if(!$unset_value)$prefs[$key][$sub_key] = $new_value;
 441                 }
 442             }
 443             else{
 444                 if($is_value_array ){
 445                     if(!isset($prefs[$key])){
 446                         continue;
 447                     }
 448
 449                     if(empty($prefs[$key])){
 450                         $prefs[$key] = array();
 451                     }
 452                     $already_exists = false;
 453                     foreach($prefs[$key] as $k=>$value){
 454                         if($value == $new_value){
 455                             $already_exists = true;
 456
 457                             if($unset_value){
 458                                 unset($prefs[$key][$k]);
 459                             }
 460                         }
 461                     }
 462                     if(!$already_exists && !$unset_value){
 463
 464                         $prefs[$key][] = $new_value;
 465                     }
 466                 }else{
 467                     if(!$unset_value)$prefs[$key] = $new_value;
 468                 }
 469             }
 470
 471             $newstr = $GLOBALS['db']->quote(base64_encode(serialize($prefs)));
 472             $db->query("UPDATE users SET user_preferences = '{$newstr}' WHERE id = '{$row['id']}'");
 473         }
 474
 475         unset($prefs);
 476         unset($newprefs);
 477         unset($newstr);
 478     }
 479
 480 }