modules/Users/User.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-2011 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: TODO:  To be written.
  41  * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  42  * All Rights Reserved.
  43  * Contributor(s): ______________________________________..
  44  ********************************************************************************/
  45
  46 require_once('include/SugarObjects/templates/person/Person.php');
  47
  48
  49 // User is used to store customer information.
  50 class User extends Person {
  51         // Stored fields
  52         var $name = '';
  53         var $full_name;
  54         var $id;
  55         var $user_name;
  56         var $user_hash;
  57         var $salutation;
  58         var $first_name;
  59         var $last_name;
  60         var $date_entered;
  61         var $date_modified;
  62         var $modified_user_id;
  63         var $created_by;
  64         var $created_by_name;
  65         var $modified_by_name;
  66         var $description;
  67         var $phone_home;
  68         var $phone_mobile;
  69         var $phone_work;
  70         var $phone_other;
  71         var $phone_fax;
  72         var $email1;
  73         var $email2;
  74         var $address_street;
  75         var $address_city;
  76         var $address_state;
  77         var $address_postalcode;
  78         var $address_country;
  79         var $status;
  80         var $title;
  81         var $portal_only;
  82         var $department;
  83         var $authenticated = false;
  84         var $error_string;
  85         var $is_admin;
  86         var $employee_status;
  87         var $messenger_id;
  88         var $messenger_type;
  89         var $is_group;
  90         var $accept_status; // to support Meetings
  91         //adding a property called team_id so we can populate it for use in the team widget
  92         var $team_id;
  93
  94         var $receive_notifications;
  95
  96         var $reports_to_name;
  97         var $reports_to_id;
  98         var $team_exists = false;
  99         var $table_name = "users";
 100         var $module_dir = 'Users';
 101         var $object_name = "User";
 102         var $user_preferences;
 103
 104         var $importable = true;
 105         var $_userPreferenceFocus;
 106
 107         var $encodeFields = Array ("first_name", "last_name", "description");
 108
 109         // This is used to retrieve related fields from form posts.
 110         var $additional_column_fields = array ('reports_to_name'
 111         );
 112
 113         var $emailAddress;
 114
 115
 116         var $new_schema = true;
 117
 118         function User() {
 119                 parent::Person();
 120
 121                 $this->_loadUserPreferencesFocus();
 122         }
 123
 124         protected function _loadUserPreferencesFocus()
 125         {
 126             $this->_userPreferenceFocus = new UserPreference($this);
 127         }
 128
 129     /**
 130      * returns an admin user
 131      */
 132     public function getSystemUser()
 133     {
 134         if (null === $this->retrieve('1'))
 135             // handle cases where someone deleted user with id "1"
 136             $this->retrieve_by_string_fields(array(
 137                 'status' => 'Active',
 138                 'is_admin' => '1',
 139                 ));
 140
 141         return $this;
 142     }
 143
 144
 145         /**
 146          * convenience function to get user's default signature
 147          */
 148         function getDefaultSignature() {
 149                 if($defaultId = $this->getPreference('signature_default')) {
 150                         return $this->getSignature($defaultId);
 151                 } else {
 152                         return array();
 153                 }
 154         }
 155
 156         /**
 157          * retrieves the signatures for a user
 158          * @param string id ID of user_signature
 159          * @return array ID, signature, and signature_html
 160          */
 161         public function getSignature($id)
 162         {
 163             $signatures = $this->getSignaturesArray();
 164
 165             return $signatures[$id];
 166         }
 167
 168         function getSignaturesArray() {
 169                 $q = 'SELECT * FROM users_signatures WHERE user_id = \''.$this->id.'\' AND deleted = 0 ORDER BY name ASC';
 170                 $r = $this->db->query($q);
 171
 172                 // provide "none"
 173                 $sig = array(""=>"");
 174
 175                 while($a = $this->db->fetchByAssoc($r)) {
 176                         $sig[$a['id']] = $a;
 177                 }
 178
 179                 return $sig;
 180         }
 181
 182         /**
 183          * retrieves any signatures that the User may have created as <select>
 184          */
 185         public function getSignatures(
 186             $live = false,
 187             $defaultSig = '',
 188             $forSettings = false
 189             )
 190         {
 191                 $sig = $this->getSignaturesArray();
 192                 $sigs = array();
 193                 foreach ($sig as $key => $arr)
 194                 {
 195                         $sigs[$key] = !empty($arr['name']) ? $arr['name'] : '';
 196                 }
 197
 198                 $change = '';
 199                 if(!$live) {
 200                         $change = ($forSettings) ? "onChange='displaySignatureEdit();'" : "onChange='setSigEditButtonVisibility();'";
 201                 }
 202
 203                 $id = (!$forSettings) ? 'signature_id' : 'signature_idDisplay';
 204
 205                 $out  = "<select {$change} id='{$id}' name='{$id}'>";
 206                 $out .= get_select_options_with_id($sigs, $defaultSig).'</select>';
 207
 208                 return $out;
 209         }
 210
 211         /**
 212          * returns buttons and JS for signatures
 213          */
 214         function getSignatureButtons($jscall='', $defaultDisplay=false) {
 215                 global $mod_strings;
 216
 217                 $jscall = empty($jscall) ? 'open_email_signature_form' : $jscall;
 218
 219                 $butts  = "<input class='button' onclick='javascript:{$jscall}(\"\", \"{$this->id}\");' value='{$mod_strings['LBL_BUTTON_CREATE']}' type='button'>&nbsp;";
 220                 if($defaultDisplay) {
 221                         $butts .= '<span name="edit_sig" id="edit_sig" style="visibility:inherit;"><input class="button" onclick="javascript:'.$jscall.'(document.getElementById(\'signature_id\', \'\').value)" value="'.$mod_strings['LBL_BUTTON_EDIT'].'" type="button" tabindex="392">&nbsp;
 222                                         </span>';
 223                 } else {
 224                         $butts .= '<span name="edit_sig" id="edit_sig" style="visibility:hidden;"><input class="button" onclick="javascript:'.$jscall.'(document.getElementById(\'signature_id\', \'\').value)" value="'.$mod_strings['LBL_BUTTON_EDIT'].'" type="button" tabindex="392">&nbsp;
 225                                         </span>';
 226                 }
 227                 return $butts;
 228         }
 229
 230         /**
 231          * performs a rudimentary check to verify if a given user has setup personal
 232          * InboundEmail
 233          *
 234          * @return bool
 235          */
 236         public function hasPersonalEmail()
 237         {
 238             $focus = new InboundEmail;
 239             $focus->retrieve_by_string_fields(array('group_id' => $this->id));
 240
 241             return !empty($focus->id);
 242         }
 243
 244         /* Returns the User's private GUID; this is unassociated with the User's
 245          * actual GUID.  It is used to secure file names that must be HTTP://
 246          * accesible, but obfusicated.
 247          */
 248         function getUserPrivGuid() {
 249         $userPrivGuid = $this->getPreference('userPrivGuid', 'global', $this);
 250                 if ($userPrivGuid) {
 251                         return $userPrivGuid;
 252                 } else {
 253                         $this->setUserPrivGuid();
 254                         if (!isset ($_SESSION['setPrivGuid'])) {
 255                                 $_SESSION['setPrivGuid'] = true;
 256                                 $userPrivGuid = $this->getUserPrivGuid();
 257                                 return $userPrivGuid;
 258                         } else {
 259                                 sugar_die("Breaking Infinite Loop Condition: Could not setUserPrivGuid.");
 260                         }
 261                 }
 262         }
 263
 264         function setUserPrivGuid() {
 265                 $privGuid = create_guid();
 266                 //($name, $value, $nosession=0)
 267                 $this->setPreference('userPrivGuid', $privGuid, 0, 'global', $this);
 268         }
 269
 270         /**
 271          * Interface for the User object to calling the UserPreference::setPreference() method in modules/UserPreferences/UserPreference.php
 272          *
 273          * @see UserPreference::setPreference()
 274          *
 275          * @param string $name Name of the preference to set
 276          * @param string $value Value to set preference to
 277          * @param null $nosession For BC, ignored
 278          * @param string $category Name of the category to retrieve
 279          */
 280         public function setPreference(
 281             $name,
 282             $value,
 283             $nosession = 0,
 284             $category = 'global'
 285             )
 286         {
 287             // for BC
 288             if ( func_num_args() > 4 ) {
 289                 $user = func_get_arg(4);
 290                 $GLOBALS['log']->deprecated('User::setPreferences() should not be used statically.');
 291             }
 292             else
 293                 $user = $this;
 294
 295         $user->_userPreferenceFocus->setPreference($name, $value, $category);
 296         }
 297
 298         /**
 299          * Interface for the User object to calling the UserPreference::resetPreferences() method in modules/UserPreferences/UserPreference.php
 300          *
 301          * @see UserPreference::resetPreferences()
 302          *
 303          * @param string $category category to reset
 304          */
 305         public function resetPreferences(
 306             $category = null
 307             )
 308         {
 309             // for BC
 310             if ( func_num_args() > 1 ) {
 311                 $user = func_get_arg(1);
 312                 $GLOBALS['log']->deprecated('User::resetPreferences() should not be used statically.');
 313             }
 314             else
 315                 $user = $this;
 316
 317         $user->_userPreferenceFocus->resetPreferences($category);
 318         }
 319
 320         /**
 321          * Interface for the User object to calling the UserPreference::savePreferencesToDB() method in modules/UserPreferences/UserPreference.php
 322          *
 323          * @see UserPreference::savePreferencesToDB()
 324          */
 325         public function savePreferencesToDB()
 326         {
 327         // for BC
 328             if ( func_num_args() > 0 ) {
 329                 $user = func_get_arg(0);
 330                 $GLOBALS['log']->deprecated('User::savePreferencesToDB() should not be used statically.');
 331             }
 332             else
 333                 $user = $this;
 334
 335         $user->_userPreferenceFocus->savePreferencesToDB();
 336         }
 337
 338         /**
 339          * Unconditionally reloads user preferences from the DB and updates the session
 340          * @param string $category name of the category to retreive, defaults to global scope
 341          * @return bool successful?
 342          */
 343         public function reloadPreferences($category = 'global')
 344         {
 345             return $this->_userPreferenceFocus->reloadPreferences($category = 'global');
 346         }
 347
 348         /**
 349          * Interface for the User object to calling the UserPreference::getUserDateTimePreferences() method in modules/UserPreferences/UserPreference.php
 350          *
 351          * @see UserPreference::getUserDateTimePreferences()
 352          *
 353          * @return array 'date' - date format for user ; 'time' - time format for user
 354          */
 355         public function getUserDateTimePreferences()
 356         {
 357         // for BC
 358             if ( func_num_args() > 0 ) {
 359                 $user = func_get_arg(0);
 360                 $GLOBALS['log']->deprecated('User::getUserDateTimePreferences() should not be used statically.');
 361             }
 362             else
 363                 $user = $this;
 364
 365         return $user->_userPreferenceFocus->getUserDateTimePreferences();
 366         }
 367
 368         /**
 369          * Interface for the User object to calling the UserPreference::loadPreferences() method in modules/UserPreferences/UserPreference.php
 370          *
 371          * @see UserPreference::loadPreferences()
 372          *
 373          * @param string $category name of the category to retreive, defaults to global scope
 374          * @return bool successful?
 375          */
 376         public function loadPreferences(
 377             $category = 'global'
 378             )
 379         {
 380             // for BC
 381             if ( func_num_args() > 1 ) {
 382                 $user = func_get_arg(1);
 383                 $GLOBALS['log']->deprecated('User::loadPreferences() should not be used statically.');
 384             }
 385             else
 386                 $user = $this;
 387
 388         return $user->_userPreferenceFocus->loadPreferences($category);
 389         }
 390
 391         /**
 392          * Interface for the User object to calling the UserPreference::setPreference() method in modules/UserPreferences/UserPreference.php
 393          *
 394          * @see UserPreference::getPreference()
 395          *
 396          * @param string $name name of the preference to retreive
 397          * @param string $category name of the category to retreive, defaults to global scope
 398          * @return mixed the value of the preference (string, array, int etc)
 399          */
 400         public function getPreference(
 401             $name,
 402             $category = 'global'
 403             )
 404         {
 405             // for BC
 406             if ( func_num_args() > 2 ) {
 407                 $user = func_get_arg(2);
 408                 $GLOBALS['log']->deprecated('User::getPreference() should not be used statically.');
 409             }
 410             else
 411                 $user = $this;
 412
 413         return $user->_userPreferenceFocus->getPreference($name, $category);
 414         }
 415
 416         public static function getLicensedUsersWhere()
 417         {
 418                 return "deleted=0 AND status='Active' AND user_name IS NOT NULL AND is_group=0 AND portal_only=0  AND ".$GLOBALS['db']->convert('user_name', 'length').">0";
 419             return "1<>1";
 420         }
 421
 422         function save($check_notify = false) {
 423                 $isUpdate = !empty($this->id) && !$this->new_with_id;
 424
 425
 426                 $query = "SELECT count(id) as total from users WHERE status='Active' AND deleted=0 AND is_group=0 AND portal_only=0";
 427
 428
 429                 // wp: do not save user_preferences in this table, see user_preferences module
 430                 $this->user_preferences = '';
 431
 432                 // if this is an admin user, do not allow is_group or portal_only flag to be set.
 433                 if ($this->is_admin) {
 434                         $this->is_group = 0;
 435                         $this->portal_only = 0;
 436                 }
 437
 438
 439
 440
 441
 442                 parent::save($check_notify);
 443
 444
 445
 446         $this->savePreferencesToDB();
 447         return $this->id;
 448         }
 449
 450         /**
 451         * @return boolean true if the user is a member of the role_name, false otherwise
 452         * @param string $role_name - Must be the exact name of the acl_role
 453         * @param string $user_id - The user id to check for the role membership, empty string if current user
 454         * @desc Determine whether or not a user is a member of an ACL Role. This function caches the
 455         *       results in the session or to prevent running queries after the first time executed.
 456         * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc..
 457         * All Rights Reserved..
 458         * Contributor(s): ______________________________________..
 459         */
 460         function check_role_membership($role_name, $user_id = ''){
 461
 462                 global $current_user;
 463
 464                 if(empty($user_id))
 465                         $user_id = $current_user->id;
 466
 467                 // Check the Sugar External Cache to see if this users memberships were cached
 468                 $role_array = sugar_cache_retrieve("RoleMemberships_".$user_id);
 469
 470                 // If we are pulling the roles for the current user
 471                 if($user_id == $current_user->id){
 472                         // If the Session doesn't contain the values
 473                         if(!isset($_SESSION['role_memberships'])){
 474                                 // This means the external cache already had it loaded
 475                                 if(!empty($role_array))
 476                                         $_SESSION['role_memberships'] = $role_array;
 477                                 else{
 478                                         $_SESSION['role_memberships'] = ACLRole::getUserRoleNames($user_id);
 479                                         $role_array = $_SESSION['role_memberships'];
 480                                 }
 481                         }
 482                         // else the session had the values, so we assign to the role array
 483                         else{
 484                                 $role_array = $_SESSION['role_memberships'];
 485                         }
 486                 }
 487                 else{
 488                         // If the external cache didn't contain the values, we get them and put them in cache
 489                         if(!$role_array){
 490                                 $role_array = ACLRole::getUserRoleNames($user_id);
 491                                 sugar_cache_put("RoleMemberships_".$user_id, $role_array);
 492                         }
 493                 }
 494
 495                 // If the role doesn't exist in the list of the user's roles
 496                 if(!empty($role_array) && in_array($role_name, $role_array))
 497                         return true;
 498                 else
 499                         return false;
 500         }
 501
 502     function get_summary_text() {
 503         //$this->_create_proper_name_field();
 504         return $this->name;
 505         }
 506
 507         /**
 508         * @return string encrypted password for storage in DB and comparison against DB password.
 509         * @param string $user_name - Must be non null and at least 2 characters
 510         * @param string $user_password - Must be non null and at least 1 character.
 511         * @desc Take an unencrypted username and password and return the encrypted password
 512          * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc..
 513          * All Rights Reserved..
 514          * Contributor(s): ______________________________________..
 515         */
 516         function encrypt_password($user_password) {
 517                 // encrypt the password.
 518                 $salt = substr($this->user_name, 0, 2);
 519                 $encrypted_password = crypt($user_password, $salt);
 520
 521                 return $encrypted_password;
 522         }
 523
 524         /**
 525          * Authenicates the user; returns true if successful
 526          *
 527          * @param $password
 528          * @return bool
 529          */
 530         public function authenticate_user(
 531             $password
 532             )
 533         {
 534                 $password = $GLOBALS['db']->quote($password);
 535                 $user_name = $GLOBALS['db']->quote($this->user_name);
 536                 $query = "SELECT * from $this->table_name where user_name='$user_name' AND user_hash='$password' AND (portal_only IS NULL OR portal_only !='1') AND (is_group IS NULL OR is_group !='1') ";
 537                 //$result = $this->db->requireSingleResult($query, false);
 538                 $result = $this->db->limitQuery($query,0,1,false);
 539                 $a = $this->db->fetchByAssoc($result);
 540                 // set the ID in the seed user.  This can be used for retrieving the full user record later
 541                 if (empty ($a)) {
 542                         // already logging this in load_user() method
 543                         //$GLOBALS['log']->fatal("SECURITY: failed login by $this->user_name");
 544                         return false;
 545                 } else {
 546                         $this->id = $a['id'];
 547                         return true;
 548                 }
 549         }
 550
 551     /**
 552      * retrieves an User bean
 553      * preformat name & full_name attribute with first/last
 554      * loads User's preferences
 555      *
 556      * @param string id ID of the User
 557      * @param bool encode encode the result
 558      * @return object User bean
 559      * @return null null if no User found
 560      */
 561         function retrieve($id, $encode = true) {
 562                 $ret = parent::retrieve($id, $encode);
 563                 if ($ret) {
 564                         if (isset ($_SESSION)) {
 565                                 $this->loadPreferences();
 566                         }
 567                 }
 568                 return $ret;
 569         }
 570
 571         function retrieve_by_email_address($email) {
 572
 573                 $email1= strtoupper($email);
 574                 $q=<<<EOQ
 575
 576                 select id from users where id in ( SELECT  er.bean_id AS id FROM email_addr_bean_rel er,
 577                         email_addresses ea WHERE ea.id = er.email_address_id
 578                     AND ea.deleted = 0 AND er.deleted = 0 AND er.bean_module = 'Users' AND email_address_caps IN ('{$email}') )
 579 EOQ;
 580
 581
 582                 $res=$this->db->query($q);
 583                 $row=$this->db->fetchByAssoc($res);
 584
 585                 if (!empty($row['id'])) {
 586                         return $this->retrieve($row['id']);
 587                 }
 588                 return '';
 589         }
 590
 591    function bean_implements($interface) {
 592         switch($interface){
 593             case 'ACL':return true;
 594         }
 595         return false;
 596     }
 597
 598
 599         /**
 600          * Load a user based on the user_name in $this
 601          * @return -- this if load was successul and null if load failed.
 602          * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc..
 603          * All Rights Reserved..
 604          * Contributor(s): ______________________________________..
 605          */
 606         function load_user($user_password) {
 607                 global $login_error;
 608                 unset($GLOBALS['login_error']);
 609                 if(isset ($_SESSION['loginattempts'])) {
 610                         $_SESSION['loginattempts'] += 1;
 611                 } else {
 612                         $_SESSION['loginattempts'] = 1;
 613                 }
 614                 if($_SESSION['loginattempts'] > 5) {
 615                         $GLOBALS['log']->fatal('SECURITY: '.$this->user_name.' has attempted to login '.$_SESSION['loginattempts'].' times from IP address: '.$_SERVER['REMOTE_ADDR'].'.');
 616                 }
 617
 618                 $GLOBALS['log']->debug("Starting user load for $this->user_name");
 619
 620                 if (!isset ($this->user_name) || $this->user_name == "" || !isset ($user_password) || $user_password == "")
 621                         return null;
 622
 623                 $user_hash = strtolower(md5($user_password));
 624                 if($this->authenticate_user($user_hash)) {
 625                         $query = "SELECT * from $this->table_name where id='$this->id'";
 626                 } else {
 627                         $GLOBALS['log']->fatal('SECURITY: User authentication for '.$this->user_name.' failed');
 628                         return null;
 629                 }
 630                 $r = $this->db->limitQuery($query, 0, 1, false);
 631                 $a = $this->db->fetchByAssoc($r);
 632                 if(empty($a) || !empty ($GLOBALS['login_error'])) {
 633                         $GLOBALS['log']->fatal('SECURITY: User authentication for '.$this->user_name.' failed - could not Load User from Database');
 634                         return null;
 635                 }
 636
 637                 // Get the fields for the user
 638                 $row = $a;
 639
 640                 // If there is no user_hash is not present or is out of date, then create a new one.
 641                 if (!isset ($row['user_hash']) || $row['user_hash'] != $user_hash) {
 642                         $query = "UPDATE $this->table_name SET user_hash='$user_hash' where id='{$row['id']}'";
 643                         $this->db->query($query, true, "Error setting new hash for {$row['user_name']}: ");
 644                 }
 645
 646                 // now fill in the fields.
 647                 foreach ($this->column_fields as $field) {
 648                         $GLOBALS['log']->info($field);
 649
 650                         if (isset ($row[$field])) {
 651                                 $GLOBALS['log']->info("=".$row[$field]);
 652
 653                                 $this-> $field = $row[$field];
 654                         }
 655                 }
 656
 657                 $this->loadPreferences();
 658
 659
 660                 require_once ('modules/Versions/CheckVersions.php');
 661                 $invalid_versions = get_invalid_versions();
 662
 663                 if (!empty ($invalid_versions)) {
 664                         if (isset ($invalid_versions['Rebuild Relationships'])) {
 665                                 unset ($invalid_versions['Rebuild Relationships']);
 666
 667                                 // flag for pickup in DisplayWarnings.php
 668                                 $_SESSION['rebuild_relationships'] = true;
 669                         }
 670
 671                         if (isset ($invalid_versions['Rebuild Extensions'])) {
 672                                 unset ($invalid_versions['Rebuild Extensions']);
 673
 674                                 // flag for pickup in DisplayWarnings.php
 675                                 $_SESSION['rebuild_extensions'] = true;
 676                         }
 677
 678                         $_SESSION['invalid_versions'] = $invalid_versions;
 679                 }
 680                 $this->fill_in_additional_detail_fields();
 681                 if ($this->status != "Inactive")
 682                         $this->authenticated = true;
 683
 684                 unset ($_SESSION['loginattempts']);
 685                 return $this;
 686         }
 687
 688         /**
 689          * Verify that the current password is correct and write the new password to the DB.
 690          *
 691          * @param string $user name - Must be non null and at least 1 character.
 692          * @param string $user_password - Must be non null and at least 1 character.
 693          * @param string $new_password - Must be non null and at least 1 character.
 694          * @return boolean - If passwords pass verification and query succeeds, return true, else return false.
 695          */
 696         function change_password(
 697             $user_password,
 698             $new_password,
 699             $system_generated = '0'
 700             )
 701         {
 702             global $mod_strings;
 703                 global $current_user;
 704                 $GLOBALS['log']->debug("Starting password change for $this->user_name");
 705
 706                 if (!isset ($new_password) || $new_password == "") {
 707                         $this->error_string = $mod_strings['ERR_PASSWORD_CHANGE_FAILED_1'].$current_user['user_name'].$mod_strings['ERR_PASSWORD_CHANGE_FAILED_2'];
 708                         return false;
 709                 }
 710
 711                 $old_user_hash = strtolower(md5($user_password));
 712
 713                 if (!$current_user->isAdminForModule('Users')) {
 714                         //check old password first
 715                         $query = "SELECT user_name FROM $this->table_name WHERE user_hash='$old_user_hash' AND id='$this->id'";
 716                         $result = $this->db->query($query, true);
 717                         $row = $this->db->fetchByAssoc($result);
 718                         $GLOBALS['log']->debug("select old password query: $query");
 719                         $GLOBALS['log']->debug("return result of $row");
 720             if ($row == null) {
 721                                 $GLOBALS['log']->warn("Incorrect old password for ".$this->user_name."");
 722                                 $this->error_string = $mod_strings['ERR_PASSWORD_INCORRECT_OLD_1'].$this->user_name.$mod_strings['ERR_PASSWORD_INCORRECT_OLD_2'];
 723                                 return false;
 724                         }
 725                 }
 726
 727         $user_hash = strtolower(md5($new_password));
 728         $this->setPreference('loginexpiration','0');
 729         //set new password
 730         $now = TimeDate::getInstance()->nowDb();
 731                 $query = "UPDATE $this->table_name SET user_hash='$user_hash', system_generated_password='$system_generated', pwd_last_changed='$now' where id='$this->id'";
 732                 $this->db->query($query, true, "Error setting new password for $this->user_name: ");
 733         $_SESSION['hasExpiredPassword'] = '0';
 734                 return true;
 735         }
 736
 737         function is_authenticated() {
 738                 return $this->authenticated;
 739         }
 740
 741         function fill_in_additional_list_fields() {
 742                 $this->fill_in_additional_detail_fields();
 743         }
 744
 745         function fill_in_additional_detail_fields() {
 746                 global $locale;
 747
 748                 $query = "SELECT u1.first_name, u1.last_name from users  u1, users  u2 where u1.id = u2.reports_to_id AND u2.id = '$this->id' and u1.deleted=0";
 749                 $result = $this->db->query($query, true, "Error filling in additional detail fields");
 750
 751                 $row = $this->db->fetchByAssoc($result);
 752                 $GLOBALS['log']->debug("additional detail query results: $row");
 753
 754                 if ($row != null) {
 755                         $this->reports_to_name = stripslashes($row['first_name'].' '.$row['last_name']);
 756                 } else {
 757                         $this->reports_to_name = '';
 758                 }
 759
 760                 $this->_create_proper_name_field();
 761         }
 762
 763         public function retrieve_user_id(
 764             $user_name
 765             )
 766         {
 767             $userFocus = new User;
 768             $userFocus->retrieve_by_string_fields(array('user_name'=>$user_name));
 769             if ( empty($userFocus->id) )
 770                 return false;
 771
 772         return $userFocus->id;
 773         }
 774
 775         /**
 776          * @return -- returns a list of all users in the system.
 777          * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc..
 778          * All Rights Reserved..
 779          * Contributor(s): ______________________________________..
 780          */
 781         function verify_data($ieVerified=true) {
 782                 global $mod_strings, $current_user;
 783                 $verified = TRUE;
 784
 785                 if (!empty ($this->id)) {
 786                         // Make sure the user doesn't report to themselves.
 787                         $reports_to_self = 0;
 788                         $check_user = $this->reports_to_id;
 789                         $already_seen_list = array ();
 790                         while (!empty ($check_user)) {
 791                                 if (isset ($already_seen_list[$check_user])) {
 792                                         // This user doesn't actually report to themselves
 793                                         // But someone above them does.
 794                                         $reports_to_self = 1;
 795                                         break;
 796                                 }
 797                                 if ($check_user == $this->id) {
 798                                         $reports_to_self = 1;
 799                                         break;
 800                                 }
 801                                 $already_seen_list[$check_user] = 1;
 802                                 $query = "SELECT reports_to_id FROM users WHERE id='".$this->db->quote($check_user)."'";
 803                                 $result = $this->db->query($query, true, "Error checking for reporting-loop");
 804                                 $row = $this->db->fetchByAssoc($result);
 805                                 echo ("fetched: ".$row['reports_to_id']." from ".$check_user."<br>");
 806                                 $check_user = $row['reports_to_id'];
 807                         }
 808
 809                         if ($reports_to_self == 1) {
 810                                 $this->error_string .= $mod_strings['ERR_REPORT_LOOP'];
 811                                 $verified = FALSE;
 812                         }
 813                 }
 814
 815                 $query = "SELECT user_name from users where user_name='$this->user_name' AND deleted=0";
 816                 if(!empty($this->id))$query .=  " AND id<>'$this->id'";
 817                 $result = $this->db->query($query, true, "Error selecting possible duplicate users: ");
 818                 $dup_users = $this->db->fetchByAssoc($result);
 819
 820                 if (!empty($dup_users)) {
 821                         $this->error_string .= $mod_strings['ERR_USER_NAME_EXISTS_1'].$this->user_name.$mod_strings['ERR_USER_NAME_EXISTS_2'];
 822                         $verified = FALSE;
 823                 }
 824
 825                 if (is_admin($current_user)) {
 826                     $remaining_admins = $this->db->getOne("SELECT COUNT(*) as c from users where is_admin = 1 AND deleted=0");
 827
 828                         if (($remaining_admins <= 1) && ($this->is_admin != '1') && ($this->id == $current_user->id)) {
 829                                 $GLOBALS['log']->debug("Number of remaining administrator accounts: {$remaining_admins}");
 830                                 $this->error_string .= $mod_strings['ERR_LAST_ADMIN_1'].$this->user_name.$mod_strings['ERR_LAST_ADMIN_2'];
 831                                 $verified = FALSE;
 832                         }
 833                 }
 834                 ///////////////////////////////////////////////////////////////////////
 835                 ////    InboundEmail verification failure
 836                 if(!$ieVerified) {
 837                         $verified = false;
 838                         $this->error_string .= '<br />'.$mod_strings['ERR_EMAIL_NO_OPTS'];
 839                 }
 840
 841                 return $verified;
 842         }
 843
 844         function get_list_view_data() {
 845
 846                 global $current_user, $mod_strings;
 847
 848                 $user_fields = $this->get_list_view_array();
 849                 if ($this->is_admin)
 850                         $user_fields['IS_ADMIN_IMAGE'] = SugarThemeRegistry::current()->getImage('check_inline', '',null,null,'.gif',$mod_strings['LBL_CHECKMARK']);
 851                 elseif (!$this->is_admin) $user_fields['IS_ADMIN'] = '';
 852                 if ($this->is_group)
 853                         $user_fields['IS_GROUP_IMAGE'] = SugarThemeRegistry::current()->getImage('check_inline', '',null,null,'.gif',$mod_strings['LBL_CHECKMARK']);
 854                 else
 855                         $user_fields['IS_GROUP_IMAGE'] = '';
 856                 $user_fields['NAME'] = empty ($this->name) ? '' : $this->name;
 857
 858                 $user_fields['REPORTS_TO_NAME'] = $this->reports_to_name;
 859
 860                 $user_fields['EMAIL1'] = $this->emailAddress->getPrimaryAddress($this);
 861
 862                 return $user_fields;
 863         }
 864
 865         function list_view_parse_additional_sections(& $list_form, $xTemplateSection) {
 866                 return $list_form;
 867         }
 868
 869
 870
 871         function create_export_query($order_by, $where) {
 872                 include('modules/Users/field_arrays.php');
 873
 874                 $cols = '';
 875                 foreach($fields_array['User']['export_fields'] as $field) {
 876                         $cols .= (empty($cols)) ? '' : ', ';
 877                         $cols .= $field;
 878                 }
 879
 880                 $query = "SELECT {$cols} FROM users ";
 881
 882                 $where_auto = " users.deleted = 0";
 883
 884                 if ($where != "")
 885                         $query .= " WHERE $where AND ".$where_auto;
 886                 else
 887                         $query .= " WHERE ".$where_auto;
 888
 889                 // admin for module user is not be able to export a super-admin
 890                 global $current_user;
 891                 if(!$current_user->is_admin){
 892                         $query .= " AND users.is_admin=0";
 893                 }
 894
 895                 if ($order_by != "")
 896                         $query .= " ORDER BY $order_by";
 897                 else
 898                         $query .= " ORDER BY users.user_name";
 899
 900                 return $query;
 901         }
 902
 903         /** Returns a list of the associated users
 904          * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc..
 905          * All Rights Reserved..
 906          * Contributor(s): ______________________________________..
 907         */
 908         function get_meetings() {
 909                 // First, get the list of IDs.
 910                 $query = "SELECT meeting_id as id from meetings_users where user_id='$this->id' AND deleted=0";
 911                 return $this->build_related_list($query, new Meeting());
 912         }
 913         function get_calls() {
 914                 // First, get the list of IDs.
 915                 $query = "SELECT call_id as id from calls_users where user_id='$this->id' AND deleted=0";
 916                 return $this->build_related_list($query, new Call());
 917         }
 918
 919         /**
 920          * generates Javascript to display I-E mail counts, both personal and group
 921          */
 922         function displayEmailCounts() {
 923                 global $theme;
 924                 $new = translate('LBL_NEW', 'Emails');
 925                 $default = 'index.php?module=Emails&action=ListView&assigned_user_id='.$this->id;
 926                 $count = '';
 927                 $verts = array('Love', 'Links', 'Pipeline', 'RipCurl', 'SugarLite');
 928
 929                 if($this->hasPersonalEmail()) {
 930                         $r = $this->db->query('SELECT count(*) AS c FROM emails WHERE deleted=0 AND assigned_user_id = \''.$this->id.'\' AND type = \'inbound\' AND status = \'unread\'');
 931                         $a = $this->db->fetchByAssoc($r);
 932                         if(in_array($theme, $verts)) {
 933                                 $count .= '<br />';
 934                         } else {
 935                                 $count .= '&nbsp;&nbsp;&nbsp;&nbsp;';
 936                         }
 937                         $count .= '<a href='.$default.'&type=inbound>'.translate('LBL_LIST_TITLE_MY_INBOX', 'Emails').': ('.$a['c'].' '.$new.')</a>';
 938
 939                         if(!in_array($theme, $verts)) {
 940                                 $count .= ' - ';
 941                         }
 942                 }
 943
 944                 $r = $this->db->query('SELECT id FROM users WHERE users.is_group = 1 AND deleted = 0');
 945                 $groupIds = '';
 946                 $groupNew = '';
 947                 while($a = $this->db->fetchByAssoc($r)) {
 948                         if($groupIds != '') {$groupIds .= ', ';}
 949                         $groupIds .= "'".$a['id']."'";
 950                 }
 951
 952                 $total = 0;
 953                 if(strlen($groupIds) > 0) {
 954                         $groupQuery = 'SELECT count(*) AS c FROM emails ';
 955                         $groupQuery .= ' WHERE emails.deleted=0 AND emails.assigned_user_id IN ('.$groupIds.') AND emails.type = \'inbound\' AND emails.status = \'unread\'';
 956                         $r = $this->db->query($groupQuery);
 957                         if(is_resource($r)) {
 958                                 $a = $this->db->fetchByAssoc($r);
 959                                 if($a['c'] > 0) {
 960                                         $total = $a['c'];
 961                                 }
 962                         }
 963                 }
 964                 if(in_array($theme, $verts)) $count .= '<br />';
 965                 if(empty($count)) $count .= '&nbsp;&nbsp;&nbsp;&nbsp;';
 966                 $count .= '<a href=index.php?module=Emails&action=ListViewGroup>'.translate('LBL_LIST_TITLE_GROUP_INBOX', 'Emails').': ('.$total.' '.$new.')</a>';
 967
 968                 $out  = '<script type="text/javascript" language="Javascript">';
 969                 $out .= 'var welcome = document.getElementById("welcome");';
 970                 $out .= 'var welcomeContent = welcome.innerHTML;';
 971                 $out .= 'welcome.innerHTML = welcomeContent + "'.$count.'";';
 972                 $out .= '</script>';
 973
 974                 echo $out;
 975         }
 976
 977         function getPreferredEmail() {
 978                 $ret = array ();
 979                 $nameEmail = $this->getUsersNameAndEmail();
 980                 $prefAddr = $nameEmail['email'];
 981                 $fullName = $nameEmail['name'];
 982                 if (empty ($prefAddr)) {
 983                         $nameEmail = $this->getSystemDefaultNameAndEmail();
 984                         $prefAddr = $nameEmail['email'];
 985                         $fullName = $nameEmail['name'];
 986                 } // if
 987                 $fullName = from_html($fullName);
 988                 $ret['name'] = $fullName;
 989                 $ret['email'] = $prefAddr;
 990                 return $ret;
 991         }
 992
 993         function getUsersNameAndEmail() {
 994                 $salutation = '';
 995                 $fullName = '';
 996                 if(!empty($this->salutation)) $salutation = $this->salutation;
 997
 998                 if(!empty($this->first_name)) {
 999                         $fullName = trim($salutation.' '.$this->first_name.' '.$this->last_name);
1000                 } elseif(!empty($this->name)) {
1001                         $fullName = $this->name;
1002                 }
1003                 $prefAddr = $this->emailAddress->getPrimaryAddress($this);
1004
1005                 if (empty ($prefAddr)) {
1006                         $prefAddr = $this->emailAddress->getReplyToAddress($this);
1007                 }
1008                 return array('email' => $prefAddr , 'name' => $fullName);
1009
1010         } // fn
1011
1012         function getSystemDefaultNameAndEmail() {
1013
1014                 $email = new Email();
1015                 $return = $email->getSystemDefaultEmail();
1016                 $prefAddr = $return['email'];
1017                 $fullName = $return['name'];
1018                 return array('email' => $prefAddr , 'name' => $fullName);
1019         } // fn
1020
1021         /**
1022          * sets User email default in config.php if not already set by install - i.
1023          * e., upgrades
1024          */
1025         function setDefaultsInConfig() {
1026                 global $sugar_config;
1027                 $sugar_config['email_default_client'] = 'sugar';
1028                 $sugar_config['email_default_editor'] = 'html';
1029                 ksort($sugar_config);
1030                 write_array_to_file('sugar_config', $sugar_config, 'config.php');
1031                 return $sugar_config;
1032         }
1033
1034     /**
1035      * returns User's email address based on descending order of preferences
1036      *
1037      * @param string id GUID of target user if needed
1038      * @return array Assoc array for an email and name
1039      */
1040     function getEmailInfo($id='') {
1041         $user = $this;
1042         if(!empty($id)) {
1043             $user = new User();
1044             $user->retrieve($id);
1045         }
1046
1047         // from name
1048         $fromName = $user->getPreference('mail_fromname');
1049         if(empty($fromName)) {
1050                 // cn: bug 8586 - localized name format
1051             $fromName = $user->full_name;
1052         }
1053
1054         // from address
1055         $fromaddr = $user->getPreference('mail_fromaddress');
1056         if(empty($fromaddr)) {
1057             if(!empty($user->email1) && isset($user->email1)) {
1058                 $fromaddr = $user->email1;
1059             } elseif(!empty($user->email2) && isset($user->email2)) {
1060                 $fromaddr = $user->email2;
1061             } else {
1062                 $r = $user->db->query("SELECT value FROM config WHERE name = 'fromaddress'");
1063                 $a = $user->db->fetchByAssoc($r);
1064                 $fromddr = $a['value'];
1065             }
1066         }
1067
1068         $ret['name'] = $fromName;
1069         $ret['email'] = $fromaddr;
1070
1071         return $ret;
1072     }
1073
1074         /**
1075          * returns opening <a href=xxxx for a contact, account, etc
1076          * cascades from User set preference to System-wide default
1077          * @return string       link
1078          * @param attribute the email addy
1079          * @param focus the parent bean
1080          * @param contact_id
1081          * @param return_module
1082          * @param return_action
1083          * @param return_id
1084          * @param class
1085          */
1086         function getEmailLink2($emailAddress, &$focus, $contact_id='', $ret_module='', $ret_action='DetailView', $ret_id='', $class='') {
1087                 $emailLink = '';
1088                 global $sugar_config;
1089
1090                 if(!isset($sugar_config['email_default_client'])) {
1091                         $this->setDefaultsInConfig();
1092                 }
1093
1094                 $userPref = $this->getPreference('email_link_type');
1095                 $defaultPref = $sugar_config['email_default_client'];
1096                 if($userPref != '') {
1097                         $client = $userPref;
1098                 } else {
1099                         $client = $defaultPref;
1100                 }
1101
1102                 if($client == 'sugar') {
1103                         $salutation = '';
1104                         $fullName = '';
1105                         $email = '';
1106                         $to_addrs_ids = '';
1107                         $to_addrs_names = '';
1108                         $to_addrs_emails = '';
1109
1110                         if(!empty($focus->salutation)) $salutation = $focus->salutation;
1111
1112                         if(!empty($focus->first_name)) {
1113                                 $fullName = trim($salutation.' '.$focus->first_name.' '.$focus->last_name);
1114                         } elseif(!empty($focus->name)) {
1115                                 $fullName = $focus->name;
1116                         }
1117
1118                         if(empty($ret_module)) $ret_module = $focus->module_dir;
1119                         if(empty($ret_id)) $ret_id = $focus->id;
1120                         if($focus->object_name == 'Contact') {
1121                                 $contact_id = $focus->id;
1122                                 $to_addrs_ids = $focus->id;
1123                                 $to_addrs_names = $fullName;
1124                                 $to_addrs_emails = $focus->email1;
1125                         }
1126
1127                         $emailLinkUrl = 'contact_id='.$contact_id.
1128                                 '&parent_type='.$focus->module_dir.
1129                                 '&parent_id='.$focus->id.
1130                                 '&parent_name='.urlencode($fullName).
1131                                 '&to_addrs_ids='.$to_addrs_ids.
1132                                 '&to_addrs_names='.urlencode($to_addrs_names).
1133                                 '&to_addrs_emails='.urlencode($to_addrs_emails).
1134                                 '&to_email_addrs='.urlencode($fullName . '&nbsp;&lt;' . $emailAddress . '&gt;').
1135                                 '&return_module='.$ret_module.
1136                                 '&return_action='.$ret_action.
1137                                 '&return_id='.$ret_id;
1138
1139                 //Generate the compose package for the quick create options.
1140                 //$json = getJSONobj();
1141                 //$composeOptionsLink = $json->encode( array('composeOptionsLink' => $emailLinkUrl,'id' => $focus->id) );
1142                         require_once('modules/Emails/EmailUI.php');
1143             $eUi = new EmailUI();
1144             $j_quickComposeOptions = $eUi->generateComposePackageForQuickCreateFromComposeUrl($emailLinkUrl, true);
1145
1146                 $emailLink = "<a href='javascript:void(0);' onclick='SUGAR.quickCompose.init($j_quickComposeOptions);' class='$class'>";
1147
1148                 } else {
1149                         // straight mailto:
1150                         $emailLink = '<a href="mailto:'.$emailAddress.'" class="'.$class.'">';
1151                 }
1152
1153                 return $emailLink;
1154         }
1155
1156         /**
1157          * returns opening <a href=xxxx for a contact, account, etc
1158          * cascades from User set preference to System-wide default
1159          * @return string       link
1160          * @param attribute the email addy
1161          * @param focus the parent bean
1162          * @param contact_id
1163          * @param return_module
1164          * @param return_action
1165          * @param return_id
1166          * @param class
1167          */
1168         function getEmailLink($attribute, &$focus, $contact_id='', $ret_module='', $ret_action='DetailView', $ret_id='', $class='') {
1169             $emailLink = '';
1170                 global $sugar_config;
1171
1172                 if(!isset($sugar_config['email_default_client'])) {
1173                         $this->setDefaultsInConfig();
1174                 }
1175
1176                 $userPref = $this->getPreference('email_link_type');
1177                 $defaultPref = $sugar_config['email_default_client'];
1178                 if($userPref != '') {
1179                         $client = $userPref;
1180                 } else {
1181                         $client = $defaultPref;
1182                 }
1183
1184                 if($client == 'sugar') {
1185                         $salutation = '';
1186                         $fullName = '';
1187                         $email = '';
1188                         $to_addrs_ids = '';
1189                         $to_addrs_names = '';
1190                         $to_addrs_emails = '';
1191
1192                         if(!empty($focus->salutation)) $salutation = $focus->salutation;
1193
1194                         if(!empty($focus->first_name)) {
1195                                 $fullName = trim($salutation.' '.$focus->first_name.' '.$focus->last_name);
1196                         } elseif(!empty($focus->name)) {
1197                                 $fullName = $focus->name;
1198                         }
1199                         if(!empty($focus->$attribute)) {
1200                                 $email = $focus->$attribute;
1201                         }
1202
1203
1204                         if(empty($ret_module)) $ret_module = $focus->module_dir;
1205                         if(empty($ret_id)) $ret_id = $focus->id;
1206                         if($focus->object_name == 'Contact') {
1207                                 $contact_id = $focus->id;
1208                                 $to_addrs_ids = $focus->id;
1209                                 $to_addrs_names = $fullName;
1210                                 $to_addrs_emails = $focus->email1;
1211                         }
1212
1213                         $emailLinkUrl = 'contact_id='.$contact_id.
1214                                 '&parent_type='.$focus->module_dir.
1215                                 '&parent_id='.$focus->id.
1216                                 '&parent_name='.urlencode($fullName).
1217                                 '&to_addrs_ids='.$to_addrs_ids.
1218                                 '&to_addrs_names='.urlencode($to_addrs_names).
1219                                 '&to_addrs_emails='.urlencode($to_addrs_emails).
1220                                 '&to_email_addrs='.urlencode($fullName . '&nbsp;&lt;' . $email . '&gt;').
1221                                 '&return_module='.$ret_module.
1222                                 '&return_action='.$ret_action.
1223                                 '&return_id='.$ret_id;
1224
1225                         //Generate the compose package for the quick create options.
1226                 require_once('modules/Emails/EmailUI.php');
1227             $eUi = new EmailUI();
1228             $j_quickComposeOptions = $eUi->generateComposePackageForQuickCreateFromComposeUrl($emailLinkUrl, true);
1229                 $emailLink = "<a href='javascript:void(0);' onclick='SUGAR.quickCompose.init($j_quickComposeOptions);' class='$class'>";
1230
1231                 } else {
1232                         // straight mailto:
1233                         $emailLink = '<a href="mailto:'.$focus->$attribute.'" class="'.$class.'">';
1234                 }
1235
1236                 return $emailLink;
1237         }
1238
1239
1240         /**
1241          * gets a human-readable explanation of the format macro
1242          * @return string Human readable name format
1243          */
1244         function getLocaleFormatDesc() {
1245                 global $locale;
1246                 global $mod_strings;
1247                 global $app_strings;
1248
1249                 $format['f'] = $mod_strings['LBL_LOCALE_DESC_FIRST'];
1250                 $format['l'] = $mod_strings['LBL_LOCALE_DESC_LAST'];
1251                 $format['s'] = $mod_strings['LBL_LOCALE_DESC_SALUTATION'];
1252                 $format['t'] = $mod_strings['LBL_LOCALE_DESC_TITLE'];
1253
1254                 $name['f'] = $app_strings['LBL_LOCALE_NAME_EXAMPLE_FIRST'];
1255                 $name['l'] = $app_strings['LBL_LOCALE_NAME_EXAMPLE_LAST'];
1256                 $name['s'] = $app_strings['LBL_LOCALE_NAME_EXAMPLE_SALUTATION'];
1257                 $name['t'] = $app_strings['LBL_LOCALE_NAME_EXAMPLE_TITLE'];
1258
1259                 $macro = $locale->getLocaleFormatMacro();
1260
1261                 $ret1 = '';
1262                 $ret2 = '';
1263                 for($i=0; $i<strlen($macro); $i++) {
1264                         if(array_key_exists($macro{$i}, $format)) {
1265                                 $ret1 .= "<i>".$format[$macro{$i}]."</i>";
1266                                 $ret2 .= "<i>".$name[$macro{$i}]."</i>";
1267                         } else {
1268                                 $ret1 .= $macro{$i};
1269                                 $ret2 .= $macro{$i};
1270                         }
1271                 }
1272                 return $ret1."<br />".$ret2;
1273         }
1274
1275
1276     /*
1277      *
1278      * Here are the multi level admin access check functions.
1279      *
1280      */
1281     /**
1282      * Helper function to remap some modules around ACL wise
1283      *
1284      * @return string
1285      */
1286     protected function _fixupModuleForACL($module) {
1287         if($module=='ContractTypes') {
1288             $module = 'Contracts';
1289         }
1290         if(preg_match('/Product[a-zA-Z]*/',$module)) {
1291             $module = 'Products';
1292         }
1293
1294         return $module;
1295     }
1296     /**
1297      * Helper function that enumerates the list of modules and checks if they are an admin/dev.
1298      * The code was just too similar to copy and paste.
1299      *
1300      * @return array
1301      */
1302     protected function _getModulesForACL($type='dev'){
1303         $isDev = $type=='dev';
1304         $isAdmin = $type=='admin';
1305
1306         global $beanList;
1307         $myModules = array();
1308
1309         if (!is_array($beanList) ) {
1310             return $myModules;
1311         }
1312
1313         // These modules don't take kindly to the studio trying to play about with them.
1314         static $ignoredModuleList = array('iFrames','Feeds','Home','Dashboard','Calendar','Activities','Reports');
1315
1316
1317         $actions = ACLAction::getUserActions($this->id);
1318
1319         foreach ($beanList as $module=>$val) {
1320             // Remap the module name
1321             $module = $this->_fixupModuleForACL($module);
1322             if (in_array($module,$myModules)) {
1323                 // Already have the module in the list
1324                 continue;
1325             }
1326             if (in_array($module,$ignoredModuleList)) {
1327                 // You can't develop on these modules.
1328                 continue;
1329             }
1330
1331             $key = 'module';
1332
1333             if (($this->isAdmin() && isset($actions[$module][$key]))
1334                 ) {
1335                 $myModules[] = $module;
1336             }
1337         }
1338
1339         return $myModules;
1340     }
1341     /**
1342      * Is this user a system wide admin
1343      *
1344      * @return bool
1345      */
1346     public function isAdmin() {
1347         if(isset($this->is_admin)
1348            &&($this->is_admin == '1' || $this->is_admin === 'on')){
1349             return true;
1350         }
1351         return false;
1352     }
1353     /**
1354      * Is this user a developer for any module
1355      *
1356      * @return bool
1357      */
1358     public function isDeveloperForAnyModule() {
1359         if ($this->isAdmin()) {
1360             return true;
1361         }
1362         return false;
1363     }
1364     /**
1365      * List the modules a user has developer access to
1366      *
1367      * @return array
1368      */
1369     public function getDeveloperModules() {
1370         static $developerModules;
1371         if (!isset($_SESSION[$this->user_name.'_get_developer_modules_for_user']) ) {
1372             $_SESSION[$this->user_name.'_get_developer_modules_for_user'] = $this->_getModulesForACL('dev');
1373         }
1374
1375         return $_SESSION[$this->user_name.'_get_developer_modules_for_user'];
1376     }
1377     /**
1378      * Is this user a developer for the specified module
1379      *
1380      * @return bool
1381      */
1382     public function isDeveloperForModule($module) {
1383         if ($this->isAdmin()) {
1384             return true;
1385         }
1386
1387         $devModules = $this->getDeveloperModules();
1388
1389         $module = $this->_fixupModuleForACL($module);
1390
1391         if (in_array($module,$devModules) ) {
1392             return true;
1393         }
1394
1395         return false;
1396     }
1397     /**
1398      * List the modules a user has admin access to
1399      *
1400      * @return array
1401      */
1402     public function getAdminModules() {
1403         if (!isset($_SESSION[$this->user_name.'_get_admin_modules_for_user']) ) {
1404             $_SESSION[$this->user_name.'_get_admin_modules_for_user'] = $this->_getModulesForACL('admin');
1405         }
1406
1407         return $_SESSION[$this->user_name.'_get_admin_modules_for_user'];
1408     }
1409     /**
1410      * Is this user an admin for the specified module
1411      *
1412      * @return bool
1413      */
1414     public function isAdminForModule($module) {
1415         if ($this->isAdmin()) {
1416             return true;
1417         }
1418
1419         $adminModules = $this->getAdminModules();
1420
1421         $module = $this->_fixupModuleForACL($module);
1422
1423         if (in_array($module,$adminModules) ) {
1424             return true;
1425         }
1426
1427         return false;
1428     }
1429         /**
1430          * Whether or not based on the user's locale if we should show the last name first.
1431          *
1432          * @return bool
1433          */
1434         public function showLastNameFirst(){
1435                 global $locale;
1436         $localeFormat = $locale->getLocaleFormatMacro($this);
1437                 if ( strpos($localeFormat,'l') > strpos($localeFormat,'f') ) {
1438                     return false;
1439         }else {
1440                 return true;
1441         }
1442         }
1443
1444
1445
1446    function create_new_list_query($order_by, $where,$filter=array(),$params=array(), $show_deleted = 0,$join_type='', $return_array = false,$parentbean=null, $singleSelect = false)
1447    {    //call parent method, specifying for array to be returned
1448         $ret_array = parent::create_new_list_query($order_by, $where,$filter,$params, $show_deleted,$join_type, true,$parentbean, $singleSelect);
1449
1450         //if this is being called from webservices, then run additional code
1451         if(!empty($GLOBALS['soap_server_object'])){
1452
1453                 //if this is a single select, then secondary queries are being run that may result in duplicate rows being returned through the
1454                 //left joins with meetings/tasks/call.  We need to change the left joins to include a null check (bug 40250)
1455                 if($singleSelect)
1456                 {
1457                         //retrieve the 'from' string and make lowercase for easier manipulation
1458                         $left_str = strtolower($ret_array['from']);
1459                         $lefts = explode('left join', $left_str);
1460                         $new_left_str = '';
1461
1462                         //explode on the left joins and process each one
1463                         foreach($lefts as $ljVal){
1464                                 //grab the join alias
1465                                 $onPos = strpos( $ljVal, ' on');
1466                                 if($onPos === false){
1467                                         $new_left_str .=' '.$ljVal.' ';
1468                                         continue;
1469                                 }
1470                                 $spacePos = strrpos(substr($ljVal, 0, $onPos),' ');
1471                                 $alias = substr($ljVal,$spacePos,$onPos-$spacePos);
1472
1473                                 //add null check to end of the Join statement
1474                         // Bug #46390 to use id_c field instead of id field for custom tables
1475                         if(substr($alias, -5) != '_cstm')
1476                         {
1477                             $ljVal ='  LEFT JOIN '.$ljVal.' and '.$alias.'.id is null ';
1478                         }
1479                         else
1480                         {
1481                             $ljVal ='  LEFT JOIN '.$ljVal.' and '.$alias.'.id_c is null ';
1482                         }
1483
1484                                 //add statement into new string
1485                                 $new_left_str .= $ljVal;
1486                          }
1487                          //replace the old string with the new one
1488                          $ret_array['from'] = $new_left_str;
1489                 }
1490         }
1491
1492                 //return array or query string
1493                 if($return_array)
1494         {
1495                 return $ret_array;
1496         }
1497
1498         return  $ret_array['select'] . $ret_array['from'] . $ret_array['where']. $ret_array['order_by'];
1499
1500
1501
1502    }
1503
1504
1505     /**
1506      * Get user first day of week.
1507      *
1508      * @param [User] $user user object, current user if not specified
1509      * @return int : 0 = Sunday, 1 = Monday, etc...
1510      */
1511     public function get_first_day_of_week()
1512     {
1513         $fdow = $this->getPreference('fdow');
1514         if (empty($fdow))
1515         {
1516             $fdow = 0;
1517         }
1518
1519         return $fdow;
1520     }
1521
1522 }