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