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         /**
 417          * Get WHERE clause that fetches all users counted for licensing purposes
 418          * @return string
 419          */
 420         public static function getLicensedUsersWhere()
 421         {
 422                 return "deleted=0 AND status='Active' AND user_name !='' AND user_name IS NOT NULL AND is_group=0 AND portal_only=0";
 423             return "1<>1";
 424         }
 425
 426         /**
 427          * (non-PHPdoc)
 428          * @see Person::save()
 429          */
 430         function save($check_notify = false) {
 431                 $isUpdate = !empty($this->id) && !$this->new_with_id;
 432
 433
 434
 435                 // wp: do not save user_preferences in this table, see user_preferences module
 436                 $this->user_preferences = '';
 437
 438                 // if this is an admin user, do not allow is_group or portal_only flag to be set.
 439                 if ($this->is_admin) {
 440                         $this->is_group = 0;
 441                         $this->portal_only = 0;
 442                 }
 443
 444
 445
 446
 447
 448                 parent::save($check_notify);
 449
 450
 451
 452         $this->savePreferencesToDB();
 453         return $this->id;
 454         }
 455
 456         /**
 457         * @return boolean true if the user is a member of the role_name, false otherwise
 458         * @param string $role_name - Must be the exact name of the acl_role
 459         * @param string $user_id - The user id to check for the role membership, empty string if current user
 460         * @desc Determine whether or not a user is a member of an ACL Role. This function caches the
 461         *       results in the session or to prevent running queries after the first time executed.
 462         * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc..
 463         * All Rights Reserved..
 464         * Contributor(s): ______________________________________..
 465         */
 466         function check_role_membership($role_name, $user_id = ''){
 467
 468                 global $current_user;
 469
 470                 if(empty($user_id))
 471                         $user_id = $current_user->id;
 472
 473                 // Check the Sugar External Cache to see if this users memberships were cached
 474                 $role_array = sugar_cache_retrieve("RoleMemberships_".$user_id);
 475
 476                 // If we are pulling the roles for the current user
 477                 if($user_id == $current_user->id){
 478                         // If the Session doesn't contain the values
 479                         if(!isset($_SESSION['role_memberships'])){
 480                                 // This means the external cache already had it loaded
 481                                 if(!empty($role_array))
 482                                         $_SESSION['role_memberships'] = $role_array;
 483                                 else{
 484                                         $_SESSION['role_memberships'] = ACLRole::getUserRoleNames($user_id);
 485                                         $role_array = $_SESSION['role_memberships'];
 486                                 }
 487                         }
 488                         // else the session had the values, so we assign to the role array
 489                         else{
 490                                 $role_array = $_SESSION['role_memberships'];
 491                         }
 492                 }
 493                 else{
 494                         // If the external cache didn't contain the values, we get them and put them in cache
 495                         if(!$role_array){
 496                                 $role_array = ACLRole::getUserRoleNames($user_id);
 497                                 sugar_cache_put("RoleMemberships_".$user_id, $role_array);
 498                         }
 499                 }
 500
 501                 // If the role doesn't exist in the list of the user's roles
 502                 if(!empty($role_array) && in_array($role_name, $role_array))
 503                         return true;
 504                 else
 505                         return false;
 506         }
 507
 508     function get_summary_text() {
 509         //$this->_create_proper_name_field();
 510         return $this->name;
 511         }
 512
 513         /**
 514         * @return string encrypted password for storage in DB and comparison against DB password.
 515         * @param string $user_name - Must be non null and at least 2 characters
 516         * @param string $user_password - Must be non null and at least 1 character.
 517         * @desc Take an unencrypted username and password and return the encrypted password
 518          * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc..
 519          * All Rights Reserved..
 520          * Contributor(s): ______________________________________..
 521         */
 522         function encrypt_password($user_password) {
 523                 // encrypt the password.
 524                 $salt = substr($this->user_name, 0, 2);
 525                 $encrypted_password = crypt($user_password, $salt);
 526
 527                 return $encrypted_password;
 528         }
 529
 530         /**
 531          * Authenicates the user; returns true if successful
 532          *
 533          * @param $password
 534          * @return bool
 535          */
 536         public function authenticate_user(
 537             $password
 538             )
 539         {
 540                 $password = $GLOBALS['db']->quote($password);
 541                 $user_name = $GLOBALS['db']->quote($this->user_name);
 542                 $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') ";
 543                 //$result = $this->db->requireSingleResult($query, false);
 544                 $result = $this->db->limitQuery($query,0,1,false);
 545                 $a = $this->db->fetchByAssoc($result);
 546                 // set the ID in the seed user.  This can be used for retrieving the full user record later
 547                 if (empty ($a)) {
 548                         // already logging this in load_user() method
 549                         //$GLOBALS['log']->fatal("SECURITY: failed login by $this->user_name");
 550                         return false;
 551                 } else {
 552                         $this->id = $a['id'];
 553                         return true;
 554                 }
 555         }
 556
 557     /**
 558      * retrieves an User bean
 559      * preformat name & full_name attribute with first/last
 560      * loads User's preferences
 561      *
 562      * @param string id ID of the User
 563      * @param bool encode encode the result
 564      * @return object User bean
 565      * @return null null if no User found
 566      */
 567         function retrieve($id, $encode = true) {
 568                 $ret = parent::retrieve($id, $encode);
 569                 if ($ret) {
 570                         if (isset ($_SESSION)) {
 571                                 $this->loadPreferences();
 572                         }
 573                 }
 574                 return $ret;
 575         }
 576
 577         function retrieve_by_email_address($email) {
 578
 579                 $email1= strtoupper($email);
 580                 $q=<<<EOQ
 581
 582                 select id from users where id in ( SELECT  er.bean_id AS id FROM email_addr_bean_rel er,
 583                         email_addresses ea WHERE ea.id = er.email_address_id
 584                     AND ea.deleted = 0 AND er.deleted = 0 AND er.bean_module = 'Users' AND email_address_caps IN ('{$email}') )
 585 EOQ;
 586
 587
 588                 $res=$this->db->query($q);
 589                 $row=$this->db->fetchByAssoc($res);
 590
 591                 if (!empty($row['id'])) {
 592                         return $this->retrieve($row['id']);
 593                 }
 594                 return '';
 595         }
 596
 597    function bean_implements($interface) {
 598         switch($interface){
 599             case 'ACL':return true;
 600         }
 601         return false;
 602     }
 603
 604
 605         /**
 606          * Load a user based on the user_name in $this
 607          * @return -- this if load was successul and null if load failed.
 608          * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc..
 609          * All Rights Reserved..
 610          * Contributor(s): ______________________________________..
 611          */
 612         function load_user($user_password) {
 613                 global $login_error;
 614                 unset($GLOBALS['login_error']);
 615                 if(isset ($_SESSION['loginattempts'])) {
 616                         $_SESSION['loginattempts'] += 1;
 617                 } else {
 618                         $_SESSION['loginattempts'] = 1;
 619                 }
 620                 if($_SESSION['loginattempts'] > 5) {
 621                         $GLOBALS['log']->fatal('SECURITY: '.$this->user_name.' has attempted to login '.$_SESSION['loginattempts'].' times from IP address: '.$_SERVER['REMOTE_ADDR'].'.');
 622                 }
 623
 624                 $GLOBALS['log']->debug("Starting user load for $this->user_name");
 625
 626                 if (!isset ($this->user_name) || $this->user_name == "" || !isset ($user_password) || $user_password == "")
 627                         return null;
 628
 629                 $user_hash = strtolower(md5($user_password));
 630                 if($this->authenticate_user($user_hash)) {
 631                         $query = "SELECT * from $this->table_name where id='$this->id'";
 632                 } else {
 633                         $GLOBALS['log']->fatal('SECURITY: User authentication for '.$this->user_name.' failed');
 634                         return null;
 635                 }
 636                 $r = $this->db->limitQuery($query, 0, 1, false);
 637                 $a = $this->db->fetchByAssoc($r);
 638                 if(empty($a) || !empty ($GLOBALS['login_error'])) {
 639                         $GLOBALS['log']->fatal('SECURITY: User authentication for '.$this->user_name.' failed - could not Load User from Database');
 640                         return null;
 641                 }
 642
 643                 // Get the fields for the user
 644                 $row = $a;
 645
 646                 // If there is no user_hash is not present or is out of date, then create a new one.
 647                 if (!isset ($row['user_hash']) || $row['user_hash'] != $user_hash) {
 648                         $query = "UPDATE $this->table_name SET user_hash='$user_hash' where id='{$row['id']}'";
 649                         $this->db->query($query, true, "Error setting new hash for {$row['user_name']}: ");
 650                 }
 651
 652                 // now fill in the fields.
 653                 foreach ($this->column_fields as $field) {
 654                         $GLOBALS['log']->info($field);
 655
 656                         if (isset ($row[$field])) {
 657                                 $GLOBALS['log']->info("=".$row[$field]);
 658
 659                                 $this-> $field = $row[$field];
 660                         }
 661                 }
 662
 663                 $this->loadPreferences();
 664
 665
 666                 require_once ('modules/Versions/CheckVersions.php');
 667                 $invalid_versions = get_invalid_versions();
 668
 669                 if (!empty ($invalid_versions)) {
 670                         if (isset ($invalid_versions['Rebuild Relationships'])) {
 671                                 unset ($invalid_versions['Rebuild Relationships']);
 672
 673                                 // flag for pickup in DisplayWarnings.php
 674                                 $_SESSION['rebuild_relationships'] = true;
 675                         }
 676
 677                         if (isset ($invalid_versions['Rebuild Extensions'])) {
 678                                 unset ($invalid_versions['Rebuild Extensions']);
 679
 680                                 // flag for pickup in DisplayWarnings.php
 681                                 $_SESSION['rebuild_extensions'] = true;
 682                         }
 683
 684                         $_SESSION['invalid_versions'] = $invalid_versions;
 685                 }
 686                 $this->fill_in_additional_detail_fields();
 687                 if ($this->status != "Inactive")
 688                         $this->authenticated = true;
 689
 690                 unset ($_SESSION['loginattempts']);
 691                 return $this;
 692         }
 693
 694         /**
 695          * Verify that the current password is correct and write the new password to the DB.
 696          *
 697          * @param string $user name - Must be non null and at least 1 character.
 698          * @param string $user_password - Must be non null and at least 1 character.
 699          * @param string $new_password - Must be non null and at least 1 character.
 700          * @return boolean - If passwords pass verification and query succeeds, return true, else return false.
 701          */
 702         function change_password(
 703             $user_password,
 704             $new_password,
 705             $system_generated = '0'
 706             )
 707         {
 708             global $mod_strings;
 709                 global $current_user;
 710                 $GLOBALS['log']->debug("Starting password change for $this->user_name");
 711
 712                 if (!isset ($new_password) || $new_password == "") {
 713                         $this->error_string = $mod_strings['ERR_PASSWORD_CHANGE_FAILED_1'].$current_user['user_name'].$mod_strings['ERR_PASSWORD_CHANGE_FAILED_2'];
 714                         return false;
 715                 }
 716
 717                 $old_user_hash = strtolower(md5($user_password));
 718
 719                 if (!$current_user->isAdminForModule('Users')) {
 720                         //check old password first
 721                         $query = "SELECT user_name FROM $this->table_name WHERE user_hash='$old_user_hash' AND id='$this->id'";
 722                         $result = $this->db->query($query, true);
 723                         $row = $this->db->fetchByAssoc($result);
 724                         $GLOBALS['log']->debug("select old password query: $query");
 725                         $GLOBALS['log']->debug("return result of $row");
 726             if ($row == null) {
 727                                 $GLOBALS['log']->warn("Incorrect old password for ".$this->user_name."");
 728                                 $this->error_string = $mod_strings['ERR_PASSWORD_INCORRECT_OLD_1'].$this->user_name.$mod_strings['ERR_PASSWORD_INCORRECT_OLD_2'];
 729                                 return false;
 730                         }
 731                 }
 732
 733         $user_hash = strtolower(md5($new_password));
 734         $this->setPreference('loginexpiration','0');
 735         //set new password
 736         $now = TimeDate::getInstance()->nowDb();
 737                 $query = "UPDATE $this->table_name SET user_hash='$user_hash', system_generated_password='$system_generated', pwd_last_changed='$now' where id='$this->id'";
 738                 $this->db->query($query, true, "Error setting new password for $this->user_name: ");
 739         $_SESSION['hasExpiredPassword'] = '0';
 740                 return true;
 741         }
 742
 743         function is_authenticated() {
 744                 return $this->authenticated;
 745         }
 746
 747         function fill_in_additional_list_fields() {
 748                 $this->fill_in_additional_detail_fields();
 749         }
 750
 751         function fill_in_additional_detail_fields() {
 752                 global $locale;
 753
 754                 $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";
 755                 $result = $this->db->query($query, true, "Error filling in additional detail fields");
 756
 757                 $row = $this->db->fetchByAssoc($result);
 758                 $GLOBALS['log']->debug("additional detail query results: $row");
 759
 760                 if ($row != null) {
 761                         $this->reports_to_name = stripslashes($row['first_name'].' '.$row['last_name']);
 762                 } else {
 763                         $this->reports_to_name = '';
 764                 }
 765
 766                 $this->_create_proper_name_field();
 767         }
 768
 769         public function retrieve_user_id(
 770             $user_name
 771             )
 772         {
 773             $userFocus = new User;
 774             $userFocus->retrieve_by_string_fields(array('user_name'=>$user_name));
 775             if ( empty($userFocus->id) )
 776                 return false;
 777
 778         return $userFocus->id;
 779         }
 780
 781         /**
 782          * @return -- returns a list of all users in the system.
 783          * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc..
 784          * All Rights Reserved..
 785          * Contributor(s): ______________________________________..
 786          */
 787         function verify_data($ieVerified=true) {
 788                 global $mod_strings, $current_user;
 789                 $verified = TRUE;
 790
 791                 if (!empty ($this->id)) {
 792                         // Make sure the user doesn't report to themselves.
 793                         $reports_to_self = 0;
 794                         $check_user = $this->reports_to_id;
 795                         $already_seen_list = array ();
 796                         while (!empty ($check_user)) {
 797                                 if (isset ($already_seen_list[$check_user])) {
 798                                         // This user doesn't actually report to themselves
 799                                         // But someone above them does.
 800                                         $reports_to_self = 1;
 801                                         break;
 802                                 }
 803                                 if ($check_user == $this->id) {
 804                                         $reports_to_self = 1;
 805                                         break;
 806                                 }
 807                                 $already_seen_list[$check_user] = 1;
 808                                 $query = "SELECT reports_to_id FROM users WHERE id='".$this->db->quote($check_user)."'";
 809                                 $result = $this->db->query($query, true, "Error checking for reporting-loop");
 810                                 $row = $this->db->fetchByAssoc($result);
 811                                 echo ("fetched: ".$row['reports_to_id']." from ".$check_user."<br>");
 812                                 $check_user = $row['reports_to_id'];
 813                         }
 814
 815                         if ($reports_to_self == 1) {
 816                                 $this->error_string .= $mod_strings['ERR_REPORT_LOOP'];
 817                                 $verified = FALSE;
 818                         }
 819                 }
 820
 821                 $query = "SELECT user_name from users where user_name='$this->user_name' AND deleted=0";
 822                 if(!empty($this->id))$query .=  " AND id<>'$this->id'";
 823                 $result = $this->db->query($query, true, "Error selecting possible duplicate users: ");
 824                 $dup_users = $this->db->fetchByAssoc($result);
 825
 826                 if (!empty($dup_users)) {
 827                         $this->error_string .= $mod_strings['ERR_USER_NAME_EXISTS_1'].$this->user_name.$mod_strings['ERR_USER_NAME_EXISTS_2'];
 828                         $verified = FALSE;
 829                 }
 830
 831                 if (is_admin($current_user)) {
 832                         $remaining_admins = $this->db->getOne("SELECT COUNT(*) as c from users where is_admin = 1 AND deleted=0");
 833
 834                         if (($remaining_admins <= 1) && $this->id == $current_user->id && !is_admin($this)) {
 835                                 $GLOBALS['log']->debug("Number of remaining administrator accounts: {$remaining_admins}");
 836                                 $this->error_string .= $mod_strings['ERR_LAST_ADMIN_1'].$this->user_name.$mod_strings['ERR_LAST_ADMIN_2'];
 837                                 $verified = FALSE;
 838                         }
 839                 }
 840                 ///////////////////////////////////////////////////////////////////////
 841                 ////    InboundEmail verification failure
 842                 if(!$ieVerified) {
 843                         $verified = false;
 844                         $this->error_string .= '<br />'.$mod_strings['ERR_EMAIL_NO_OPTS'];
 845                 }
 846
 847                 return $verified;
 848         }
 849
 850         function get_list_view_data() {
 851
 852                 global $current_user, $mod_strings;
 853
 854                 $user_fields = $this->get_list_view_array();
 855                 if ($this->is_admin)
 856                         $user_fields['IS_ADMIN_IMAGE'] = SugarThemeRegistry::current()->getImage('check_inline', '',null,null,'.gif',$mod_strings['LBL_CHECKMARK']);
 857                 elseif (!$this->is_admin) $user_fields['IS_ADMIN'] = '';
 858                 if ($this->is_group)
 859                         $user_fields['IS_GROUP_IMAGE'] = SugarThemeRegistry::current()->getImage('check_inline', '',null,null,'.gif',$mod_strings['LBL_CHECKMARK']);
 860                 else
 861                         $user_fields['IS_GROUP_IMAGE'] = '';
 862                 $user_fields['NAME'] = empty ($this->name) ? '' : $this->name;
 863
 864                 $user_fields['REPORTS_TO_NAME'] = $this->reports_to_name;
 865
 866                 $user_fields['EMAIL1'] = $this->emailAddress->getPrimaryAddress($this);
 867
 868                 return $user_fields;
 869         }
 870
 871         function list_view_parse_additional_sections(& $list_form, $xTemplateSection) {
 872                 return $list_form;
 873         }
 874
 875
 876
 877         function create_export_query($order_by, $where) {
 878                 include('modules/Users/field_arrays.php');
 879
 880                 $cols = '';
 881                 foreach($fields_array['User']['export_fields'] as $field) {
 882                         $cols .= (empty($cols)) ? '' : ', ';
 883                         $cols .= $field;
 884                 }
 885
 886                 $query = "SELECT {$cols} FROM users ";
 887
 888                 $where_auto = " users.deleted = 0";
 889
 890                 if ($where != "")
 891                         $query .= " WHERE $where AND ".$where_auto;
 892                 else
 893                         $query .= " WHERE ".$where_auto;
 894
 895                 // admin for module user is not be able to export a super-admin
 896                 global $current_user;
 897                 if(!$current_user->is_admin){
 898                         $query .= " AND users.is_admin=0";
 899                 }
 900
 901                 if ($order_by != "")
 902                         $query .= " ORDER BY $order_by";
 903                 else
 904                         $query .= " ORDER BY users.user_name";
 905
 906                 return $query;
 907         }
 908
 909         /** Returns a list of the associated users
 910          * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc..
 911          * All Rights Reserved..
 912          * Contributor(s): ______________________________________..
 913         */
 914         function get_meetings() {
 915                 // First, get the list of IDs.
 916                 $query = "SELECT meeting_id as id from meetings_users where user_id='$this->id' AND deleted=0";
 917                 return $this->build_related_list($query, new Meeting());
 918         }
 919         function get_calls() {
 920                 // First, get the list of IDs.
 921                 $query = "SELECT call_id as id from calls_users where user_id='$this->id' AND deleted=0";
 922                 return $this->build_related_list($query, new Call());
 923         }
 924
 925         /**
 926          * generates Javascript to display I-E mail counts, both personal and group
 927          */
 928         function displayEmailCounts() {
 929                 global $theme;
 930                 $new = translate('LBL_NEW', 'Emails');
 931                 $default = 'index.php?module=Emails&action=ListView&assigned_user_id='.$this->id;
 932                 $count = '';
 933                 $verts = array('Love', 'Links', 'Pipeline', 'RipCurl', 'SugarLite');
 934
 935                 if($this->hasPersonalEmail()) {
 936                         $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\'');
 937                         $a = $this->db->fetchByAssoc($r);
 938                         if(in_array($theme, $verts)) {
 939                                 $count .= '<br />';
 940                         } else {
 941                                 $count .= '&nbsp;&nbsp;&nbsp;&nbsp;';
 942                         }
 943                         $count .= '<a href='.$default.'&type=inbound>'.translate('LBL_LIST_TITLE_MY_INBOX', 'Emails').': ('.$a['c'].' '.$new.')</a>';
 944
 945                         if(!in_array($theme, $verts)) {
 946                                 $count .= ' - ';
 947                         }
 948                 }
 949
 950                 $r = $this->db->query('SELECT id FROM users WHERE users.is_group = 1 AND deleted = 0');
 951                 $groupIds = '';
 952                 $groupNew = '';
 953                 while($a = $this->db->fetchByAssoc($r)) {
 954                         if($groupIds != '') {$groupIds .= ', ';}
 955                         $groupIds .= "'".$a['id']."'";
 956                 }
 957
 958                 $total = 0;
 959                 if(strlen($groupIds) > 0) {
 960                         $groupQuery = 'SELECT count(*) AS c FROM emails ';
 961                         $groupQuery .= ' WHERE emails.deleted=0 AND emails.assigned_user_id IN ('.$groupIds.') AND emails.type = \'inbound\' AND emails.status = \'unread\'';
 962                         $r = $this->db->query($groupQuery);
 963                         if(is_resource($r)) {
 964                                 $a = $this->db->fetchByAssoc($r);
 965                                 if($a['c'] > 0) {
 966                                         $total = $a['c'];
 967                                 }
 968                         }
 969                 }
 970                 if(in_array($theme, $verts)) $count .= '<br />';
 971                 if(empty($count)) $count .= '&nbsp;&nbsp;&nbsp;&nbsp;';
 972                 $count .= '<a href=index.php?module=Emails&action=ListViewGroup>'.translate('LBL_LIST_TITLE_GROUP_INBOX', 'Emails').': ('.$total.' '.$new.')</a>';
 973
 974                 $out  = '<script type="text/javascript" language="Javascript">';
 975                 $out .= 'var welcome = document.getElementById("welcome");';
 976                 $out .= 'var welcomeContent = welcome.innerHTML;';
 977                 $out .= 'welcome.innerHTML = welcomeContent + "'.$count.'";';
 978                 $out .= '</script>';
 979
 980                 echo $out;
 981         }
 982
 983         function getPreferredEmail() {
 984                 $ret = array ();
 985                 $nameEmail = $this->getUsersNameAndEmail();
 986                 $prefAddr = $nameEmail['email'];
 987                 $fullName = $nameEmail['name'];
 988                 if (empty ($prefAddr)) {
 989                         $nameEmail = $this->getSystemDefaultNameAndEmail();
 990                         $prefAddr = $nameEmail['email'];
 991                         $fullName = $nameEmail['name'];
 992                 } // if
 993                 $fullName = from_html($fullName);
 994                 $ret['name'] = $fullName;
 995                 $ret['email'] = $prefAddr;
 996                 return $ret;
 997         }
 998
 999         function getUsersNameAndEmail() {
1000                 $salutation = '';
1001                 $fullName = '';
1002                 if(!empty($this->salutation)) $salutation = $this->salutation;
1003
1004                 if(!empty($this->first_name)) {
1005                         $fullName = trim($salutation.' '.$this->first_name.' '.$this->last_name);
1006                 } elseif(!empty($this->name)) {
1007                         $fullName = $this->name;
1008                 }
1009                 $prefAddr = $this->emailAddress->getPrimaryAddress($this);
1010
1011                 if (empty ($prefAddr)) {
1012                         $prefAddr = $this->emailAddress->getReplyToAddress($this);
1013                 }
1014                 return array('email' => $prefAddr , 'name' => $fullName);
1015
1016         } // fn
1017
1018         function getSystemDefaultNameAndEmail() {
1019
1020                 $email = new Email();
1021                 $return = $email->getSystemDefaultEmail();
1022                 $prefAddr = $return['email'];
1023                 $fullName = $return['name'];
1024                 return array('email' => $prefAddr , 'name' => $fullName);
1025         } // fn
1026
1027         /**
1028          * sets User email default in config.php if not already set by install - i.
1029          * e., upgrades
1030          */
1031         function setDefaultsInConfig() {
1032                 global $sugar_config;
1033                 $sugar_config['email_default_client'] = 'sugar';
1034                 $sugar_config['email_default_editor'] = 'html';
1035                 ksort($sugar_config);
1036                 write_array_to_file('sugar_config', $sugar_config, 'config.php');
1037                 return $sugar_config;
1038         }
1039
1040     /**
1041      * returns User's email address based on descending order of preferences
1042      *
1043      * @param string id GUID of target user if needed
1044      * @return array Assoc array for an email and name
1045      */
1046     function getEmailInfo($id='') {
1047         $user = $this;
1048         if(!empty($id)) {
1049             $user = new User();
1050             $user->retrieve($id);
1051         }
1052
1053         // from name
1054         $fromName = $user->getPreference('mail_fromname');
1055         if(empty($fromName)) {
1056                 // cn: bug 8586 - localized name format
1057             $fromName = $user->full_name;
1058         }
1059
1060         // from address
1061         $fromaddr = $user->getPreference('mail_fromaddress');
1062         if(empty($fromaddr)) {
1063             if(!empty($user->email1) && isset($user->email1)) {
1064                 $fromaddr = $user->email1;
1065             } elseif(!empty($user->email2) && isset($user->email2)) {
1066                 $fromaddr = $user->email2;
1067             } else {
1068                 $r = $user->db->query("SELECT value FROM config WHERE name = 'fromaddress'");
1069                 $a = $user->db->fetchByAssoc($r);
1070                 $fromddr = $a['value'];
1071             }
1072         }
1073
1074         $ret['name'] = $fromName;
1075         $ret['email'] = $fromaddr;
1076
1077         return $ret;
1078     }
1079
1080         /**
1081          * returns opening <a href=xxxx for a contact, account, etc
1082          * cascades from User set preference to System-wide default
1083          * @return string       link
1084          * @param attribute the email addy
1085          * @param focus the parent bean
1086          * @param contact_id
1087          * @param return_module
1088          * @param return_action
1089          * @param return_id
1090          * @param class
1091          */
1092         function getEmailLink2($emailAddress, &$focus, $contact_id='', $ret_module='', $ret_action='DetailView', $ret_id='', $class='') {
1093                 $emailLink = '';
1094                 global $sugar_config;
1095
1096                 if(!isset($sugar_config['email_default_client'])) {
1097                         $this->setDefaultsInConfig();
1098                 }
1099
1100                 $userPref = $this->getPreference('email_link_type');
1101                 $defaultPref = $sugar_config['email_default_client'];
1102                 if($userPref != '') {
1103                         $client = $userPref;
1104                 } else {
1105                         $client = $defaultPref;
1106                 }
1107
1108                 if($client == 'sugar') {
1109                         $salutation = '';
1110                         $fullName = '';
1111                         $email = '';
1112                         $to_addrs_ids = '';
1113                         $to_addrs_names = '';
1114                         $to_addrs_emails = '';
1115
1116                         if(!empty($focus->salutation)) $salutation = $focus->salutation;
1117
1118                         if(!empty($focus->first_name)) {
1119                                 $fullName = trim($salutation.' '.$focus->first_name.' '.$focus->last_name);
1120                         } elseif(!empty($focus->name)) {
1121                                 $fullName = $focus->name;
1122                         }
1123
1124                         if(empty($ret_module)) $ret_module = $focus->module_dir;
1125                         if(empty($ret_id)) $ret_id = $focus->id;
1126                         if($focus->object_name == 'Contact') {
1127                                 $contact_id = $focus->id;
1128                                 $to_addrs_ids = $focus->id;
1129                                 $to_addrs_names = $fullName;
1130                                 $to_addrs_emails = $focus->email1;
1131                         }
1132
1133                         $emailLinkUrl = 'contact_id='.$contact_id.
1134                                 '&parent_type='.$focus->module_dir.
1135                                 '&parent_id='.$focus->id.
1136                                 '&parent_name='.urlencode($fullName).
1137                                 '&to_addrs_ids='.$to_addrs_ids.
1138                                 '&to_addrs_names='.urlencode($to_addrs_names).
1139                                 '&to_addrs_emails='.urlencode($to_addrs_emails).
1140                                 '&to_email_addrs='.urlencode($fullName . '&nbsp;&lt;' . $emailAddress . '&gt;').
1141                                 '&return_module='.$ret_module.
1142                                 '&return_action='.$ret_action.
1143                                 '&return_id='.$ret_id;
1144
1145                 //Generate the compose package for the quick create options.
1146                 //$json = getJSONobj();
1147                 //$composeOptionsLink = $json->encode( array('composeOptionsLink' => $emailLinkUrl,'id' => $focus->id) );
1148                         require_once('modules/Emails/EmailUI.php');
1149             $eUi = new EmailUI();
1150             $j_quickComposeOptions = $eUi->generateComposePackageForQuickCreateFromComposeUrl($emailLinkUrl, true);
1151
1152                 $emailLink = "<a href='javascript:void(0);' onclick='SUGAR.quickCompose.init($j_quickComposeOptions);' class='$class'>";
1153
1154                 } else {
1155                         // straight mailto:
1156                         $emailLink = '<a href="mailto:'.$emailAddress.'" class="'.$class.'">';
1157                 }
1158
1159                 return $emailLink;
1160         }
1161
1162         /**
1163          * returns opening <a href=xxxx for a contact, account, etc
1164          * cascades from User set preference to System-wide default
1165          * @return string       link
1166          * @param attribute the email addy
1167          * @param focus the parent bean
1168          * @param contact_id
1169          * @param return_module
1170          * @param return_action
1171          * @param return_id
1172          * @param class
1173          */
1174         function getEmailLink($attribute, &$focus, $contact_id='', $ret_module='', $ret_action='DetailView', $ret_id='', $class='') {
1175             $emailLink = '';
1176                 global $sugar_config;
1177
1178                 if(!isset($sugar_config['email_default_client'])) {
1179                         $this->setDefaultsInConfig();
1180                 }
1181
1182                 $userPref = $this->getPreference('email_link_type');
1183                 $defaultPref = $sugar_config['email_default_client'];
1184                 if($userPref != '') {
1185                         $client = $userPref;
1186                 } else {
1187                         $client = $defaultPref;
1188                 }
1189
1190                 if($client == 'sugar') {
1191                         $salutation = '';
1192                         $fullName = '';
1193                         $email = '';
1194                         $to_addrs_ids = '';
1195                         $to_addrs_names = '';
1196                         $to_addrs_emails = '';
1197
1198                         if(!empty($focus->salutation)) $salutation = $focus->salutation;
1199
1200                         if(!empty($focus->first_name)) {
1201                                 $fullName = trim($salutation.' '.$focus->first_name.' '.$focus->last_name);
1202                         } elseif(!empty($focus->name)) {
1203                                 $fullName = $focus->name;
1204                         }
1205                         if(!empty($focus->$attribute)) {
1206                                 $email = $focus->$attribute;
1207                         }
1208
1209
1210                         if(empty($ret_module)) $ret_module = $focus->module_dir;
1211                         if(empty($ret_id)) $ret_id = $focus->id;
1212                         if($focus->object_name == 'Contact') {
1213                                 $contact_id = $focus->id;
1214                                 $to_addrs_ids = $focus->id;
1215                                 $to_addrs_names = $fullName;
1216                                 $to_addrs_emails = $focus->email1;
1217                         }
1218
1219                         $emailLinkUrl = 'contact_id='.$contact_id.
1220                                 '&parent_type='.$focus->module_dir.
1221                                 '&parent_id='.$focus->id.
1222                                 '&parent_name='.urlencode($fullName).
1223                                 '&to_addrs_ids='.$to_addrs_ids.
1224                                 '&to_addrs_names='.urlencode($to_addrs_names).
1225                                 '&to_addrs_emails='.urlencode($to_addrs_emails).
1226                                 '&to_email_addrs='.urlencode($fullName . '&nbsp;&lt;' . $email . '&gt;').
1227                                 '&return_module='.$ret_module.
1228                                 '&return_action='.$ret_action.
1229                                 '&return_id='.$ret_id;
1230
1231                         //Generate the compose package for the quick create options.
1232                 require_once('modules/Emails/EmailUI.php');
1233             $eUi = new EmailUI();
1234             $j_quickComposeOptions = $eUi->generateComposePackageForQuickCreateFromComposeUrl($emailLinkUrl, true);
1235                 $emailLink = "<a href='javascript:void(0);' onclick='SUGAR.quickCompose.init($j_quickComposeOptions);' class='$class'>";
1236
1237                 } else {
1238                         // straight mailto:
1239                         $emailLink = '<a href="mailto:'.$focus->$attribute.'" class="'.$class.'">';
1240                 }
1241
1242                 return $emailLink;
1243         }
1244
1245
1246         /**
1247          * gets a human-readable explanation of the format macro
1248          * @return string Human readable name format
1249          */
1250         function getLocaleFormatDesc() {
1251                 global $locale;
1252                 global $mod_strings;
1253                 global $app_strings;
1254
1255                 $format['f'] = $mod_strings['LBL_LOCALE_DESC_FIRST'];
1256                 $format['l'] = $mod_strings['LBL_LOCALE_DESC_LAST'];
1257                 $format['s'] = $mod_strings['LBL_LOCALE_DESC_SALUTATION'];
1258                 $format['t'] = $mod_strings['LBL_LOCALE_DESC_TITLE'];
1259
1260                 $name['f'] = $app_strings['LBL_LOCALE_NAME_EXAMPLE_FIRST'];
1261                 $name['l'] = $app_strings['LBL_LOCALE_NAME_EXAMPLE_LAST'];
1262                 $name['s'] = $app_strings['LBL_LOCALE_NAME_EXAMPLE_SALUTATION'];
1263                 $name['t'] = $app_strings['LBL_LOCALE_NAME_EXAMPLE_TITLE'];
1264
1265                 $macro = $locale->getLocaleFormatMacro();
1266
1267                 $ret1 = '';
1268                 $ret2 = '';
1269                 for($i=0; $i<strlen($macro); $i++) {
1270                         if(array_key_exists($macro{$i}, $format)) {
1271                                 $ret1 .= "<i>".$format[$macro{$i}]."</i>";
1272                                 $ret2 .= "<i>".$name[$macro{$i}]."</i>";
1273                         } else {
1274                                 $ret1 .= $macro{$i};
1275                                 $ret2 .= $macro{$i};
1276                         }
1277                 }
1278                 return $ret1."<br />".$ret2;
1279         }
1280
1281
1282     /*
1283      *
1284      * Here are the multi level admin access check functions.
1285      *
1286      */
1287     /**
1288      * Helper function to remap some modules around ACL wise
1289      *
1290      * @return string
1291      */
1292     protected function _fixupModuleForACL($module) {
1293         if($module=='ContractTypes') {
1294             $module = 'Contracts';
1295         }
1296         if(preg_match('/Product[a-zA-Z]*/',$module)) {
1297             $module = 'Products';
1298         }
1299
1300         return $module;
1301     }
1302     /**
1303      * Helper function that enumerates the list of modules and checks if they are an admin/dev.
1304      * The code was just too similar to copy and paste.
1305      *
1306      * @return array
1307      */
1308     protected function _getModulesForACL($type='dev'){
1309         $isDev = $type=='dev';
1310         $isAdmin = $type=='admin';
1311
1312         global $beanList;
1313         $myModules = array();
1314
1315         if (!is_array($beanList) ) {
1316             return $myModules;
1317         }
1318
1319         // These modules don't take kindly to the studio trying to play about with them.
1320         static $ignoredModuleList = array('iFrames','Feeds','Home','Dashboard','Calendar','Activities','Reports');
1321
1322
1323         $actions = ACLAction::getUserActions($this->id);
1324
1325         foreach ($beanList as $module=>$val) {
1326             // Remap the module name
1327             $module = $this->_fixupModuleForACL($module);
1328             if (in_array($module,$myModules)) {
1329                 // Already have the module in the list
1330                 continue;
1331             }
1332             if (in_array($module,$ignoredModuleList)) {
1333                 // You can't develop on these modules.
1334                 continue;
1335             }
1336
1337             $key = 'module';
1338
1339             if (($this->isAdmin() && isset($actions[$module][$key]))
1340                 ) {
1341                 $myModules[] = $module;
1342             }
1343         }
1344
1345         return $myModules;
1346     }
1347     /**
1348      * Is this user a system wide admin
1349      *
1350      * @return bool
1351      */
1352     public function isAdmin() {
1353         if(isset($this->is_admin)
1354            &&($this->is_admin == '1' || $this->is_admin === 'on')){
1355             return true;
1356         }
1357         return false;
1358     }
1359     /**
1360      * Is this user a developer for any module
1361      *
1362      * @return bool
1363      */
1364     public function isDeveloperForAnyModule() {
1365         if ($this->isAdmin()) {
1366             return true;
1367         }
1368         return false;
1369     }
1370     /**
1371      * List the modules a user has developer access to
1372      *
1373      * @return array
1374      */
1375     public function getDeveloperModules() {
1376         static $developerModules;
1377         if (!isset($_SESSION[$this->user_name.'_get_developer_modules_for_user']) ) {
1378             $_SESSION[$this->user_name.'_get_developer_modules_for_user'] = $this->_getModulesForACL('dev');
1379         }
1380
1381         return $_SESSION[$this->user_name.'_get_developer_modules_for_user'];
1382     }
1383     /**
1384      * Is this user a developer for the specified module
1385      *
1386      * @return bool
1387      */
1388     public function isDeveloperForModule($module) {
1389         if ($this->isAdmin()) {
1390             return true;
1391         }
1392
1393         $devModules = $this->getDeveloperModules();
1394
1395         $module = $this->_fixupModuleForACL($module);
1396
1397         if (in_array($module,$devModules) ) {
1398             return true;
1399         }
1400
1401         return false;
1402     }
1403     /**
1404      * List the modules a user has admin access to
1405      *
1406      * @return array
1407      */
1408     public function getAdminModules() {
1409         if (!isset($_SESSION[$this->user_name.'_get_admin_modules_for_user']) ) {
1410             $_SESSION[$this->user_name.'_get_admin_modules_for_user'] = $this->_getModulesForACL('admin');
1411         }
1412
1413         return $_SESSION[$this->user_name.'_get_admin_modules_for_user'];
1414     }
1415     /**
1416      * Is this user an admin for the specified module
1417      *
1418      * @return bool
1419      */
1420     public function isAdminForModule($module) {
1421         if ($this->isAdmin()) {
1422             return true;
1423         }
1424
1425         $adminModules = $this->getAdminModules();
1426
1427         $module = $this->_fixupModuleForACL($module);
1428
1429         if (in_array($module,$adminModules) ) {
1430             return true;
1431         }
1432
1433         return false;
1434     }
1435         /**
1436          * Whether or not based on the user's locale if we should show the last name first.
1437          *
1438          * @return bool
1439          */
1440         public function showLastNameFirst(){
1441                 global $locale;
1442         $localeFormat = $locale->getLocaleFormatMacro($this);
1443                 if ( strpos($localeFormat,'l') > strpos($localeFormat,'f') ) {
1444                     return false;
1445         }else {
1446                 return true;
1447         }
1448         }
1449
1450
1451
1452    function create_new_list_query($order_by, $where,$filter=array(),$params=array(), $show_deleted = 0,$join_type='', $return_array = false,$parentbean=null, $singleSelect = false)
1453    {    //call parent method, specifying for array to be returned
1454         $ret_array = parent::create_new_list_query($order_by, $where,$filter,$params, $show_deleted,$join_type, true,$parentbean, $singleSelect);
1455
1456         //if this is being called from webservices, then run additional code
1457         if(!empty($GLOBALS['soap_server_object'])){
1458
1459                 //if this is a single select, then secondary queries are being run that may result in duplicate rows being returned through the
1460                 //left joins with meetings/tasks/call.  We need to change the left joins to include a null check (bug 40250)
1461                 if($singleSelect)
1462                 {
1463                         //retrieve the 'from' string and make lowercase for easier manipulation
1464                         $left_str = strtolower($ret_array['from']);
1465                         $lefts = explode('left join', $left_str);
1466                         $new_left_str = '';
1467
1468                         //explode on the left joins and process each one
1469                         foreach($lefts as $ljVal){
1470                                 //grab the join alias
1471                                 $onPos = strpos( $ljVal, ' on');
1472                                 if($onPos === false){
1473                                         $new_left_str .=' '.$ljVal.' ';
1474                                         continue;
1475                                 }
1476                                 $spacePos = strrpos(substr($ljVal, 0, $onPos),' ');
1477                                 $alias = substr($ljVal,$spacePos,$onPos-$spacePos);
1478
1479                                 //add null check to end of the Join statement
1480                                 $ljVal ='  LEFT JOIN '.$ljVal.' and '.$alias.'.id is null ';
1481
1482                                 //add statement into new string
1483                                 $new_left_str .= $ljVal;
1484                          }
1485                          //replace the old string with the new one
1486                          $ret_array['from'] = $new_left_str;
1487                 }
1488         }
1489
1490                 //return array or query string
1491                 if($return_array)
1492         {
1493                 return $ret_array;
1494         }
1495
1496         return  $ret_array['select'] . $ret_array['from'] . $ret_array['where']. $ret_array['order_by'];
1497
1498
1499
1500    }
1501
1502
1503     /**
1504      * Get user first day of week.
1505      *
1506      * @param [User] $user user object, current user if not specified
1507      * @return int : 0 = Sunday, 1 = Monday, etc...
1508      */
1509     public function get_first_day_of_week()
1510     {
1511         $fdow = $this->getPreference('fdow');
1512         if (empty($fdow))
1513         {
1514             $fdow = 0;
1515         }
1516
1517         return $fdow;
1518     }
1519
1520
1521
1522 }