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-2012 SugarCRM Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU Affero General Public License version 3 as published by the
   9  * Free Software Foundation with the addition of the following permission added
  10  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  11  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  12  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License along with
  20  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  21  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA.
  23  *
  24  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  25  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  26  *
  27  * The interactive user interfaces in modified source and object code versions
  28  * of this program must display Appropriate Legal Notices, as required under
  29  * Section 5 of the GNU Affero General Public License version 3.
  30  *
  31  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  32  * these Appropriate Legal Notices must retain the display of the "Powered by
  33  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  34  * technical reasons, the Appropriate Legal Notices must display the words
  35  * "Powered by SugarCRM".
  36  ********************************************************************************/
  37
  38 /*********************************************************************************
  39
  40  * Description: 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 isset($signatures[$id]) ? $signatures[$id] : FALSE;
 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      * incrementETag
 418      *
 419      * This function increments any ETag seed needed for a particular user's
 420      * UI. For example, if the user changes their theme, the ETag seed for the
 421      * main menu needs to be updated, so you call this function with the seed name
 422      * to do so:
 423      *
 424      * UserPreference::incrementETag("mainMenuETag");
 425      *
 426      * @param string $tag ETag seed name.
 427      * @return nothing
 428      */
 429     public function incrementETag($tag){
 430         $val = $this->getETagSeed($tag);
 431         if($val == 2147483648){
 432                 $val = 0;
 433         }
 434         $val++;
 435         $this->setPreference($tag, $val, 0, "ETag");
 436     }
 437
 438     /**
 439      * getETagSeed
 440      *
 441      * This function is a wrapper to encapsulate getting the ETag seed and
 442      * making sure it's sanitized for use in the app.
 443      *
 444      * @param string $tag ETag seed name.
 445      * @return integer numeric value of the seed
 446      */
 447     public function getETagSeed($tag){
 448         $val = $this->getPreference($tag, "ETag");
 449         if($val == null){
 450                 $val = 0;
 451         }
 452         return $val;
 453     }
 454
 455
 456    /**
 457     * Get WHERE clause that fetches all users counted for licensing purposes
 458     * @return string
 459     */
 460         public static function getLicensedUsersWhere()
 461         {
 462                 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";
 463             return "1<>1";
 464         }
 465
 466         function save($check_notify = false) {
 467                 $isUpdate = !empty($this->id) && !$this->new_with_id;
 468
 469
 470                 $query = "SELECT count(id) as total from users WHERE ".self::getLicensedUsersWhere();
 471
 472
 473                 // wp: do not save user_preferences in this table, see user_preferences module
 474                 $this->user_preferences = '';
 475
 476                 // if this is an admin user, do not allow is_group or portal_only flag to be set.
 477                 if ($this->is_admin) {
 478                         $this->is_group = 0;
 479                         $this->portal_only = 0;
 480                 }
 481
 482
 483
 484
 485
 486                 parent::save($check_notify);
 487
 488
 489
 490         $this->savePreferencesToDB();
 491         return $this->id;
 492         }
 493
 494         /**
 495         * @return boolean true if the user is a member of the role_name, false otherwise
 496         * @param string $role_name - Must be the exact name of the acl_role
 497         * @param string $user_id - The user id to check for the role membership, empty string if current user
 498         * @desc Determine whether or not a user is a member of an ACL Role. This function caches the
 499         *       results in the session or to prevent running queries after the first time executed.
 500         * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc..
 501         * All Rights Reserved..
 502         * Contributor(s): ______________________________________..
 503         */
 504         function check_role_membership($role_name, $user_id = ''){
 505
 506                 global $current_user;
 507
 508                 if(empty($user_id))
 509                         $user_id = $current_user->id;
 510
 511                 // Check the Sugar External Cache to see if this users memberships were cached
 512                 $role_array = sugar_cache_retrieve("RoleMemberships_".$user_id);
 513
 514                 // If we are pulling the roles for the current user
 515                 if($user_id == $current_user->id){
 516                         // If the Session doesn't contain the values
 517                         if(!isset($_SESSION['role_memberships'])){
 518                                 // This means the external cache already had it loaded
 519                                 if(!empty($role_array))
 520                                         $_SESSION['role_memberships'] = $role_array;
 521                                 else{
 522                                         $_SESSION['role_memberships'] = ACLRole::getUserRoleNames($user_id);
 523                                         $role_array = $_SESSION['role_memberships'];
 524                                 }
 525                         }
 526                         // else the session had the values, so we assign to the role array
 527                         else{
 528                                 $role_array = $_SESSION['role_memberships'];
 529                         }
 530                 }
 531                 else{
 532                         // If the external cache didn't contain the values, we get them and put them in cache
 533                         if(!$role_array){
 534                                 $role_array = ACLRole::getUserRoleNames($user_id);
 535                                 sugar_cache_put("RoleMemberships_".$user_id, $role_array);
 536                         }
 537                 }
 538
 539                 // If the role doesn't exist in the list of the user's roles
 540                 if(!empty($role_array) && in_array($role_name, $role_array))
 541                         return true;
 542                 else
 543                         return false;
 544         }
 545
 546     function get_summary_text() {
 547         //$this->_create_proper_name_field();
 548         return $this->name;
 549         }
 550
 551         /**
 552          * @deprecated
 553         * @param string $user_name - Must be non null and at least 2 characters
 554         * @param string $user_password - Must be non null and at least 1 character.
 555         * @desc Take an unencrypted username and password and return the encrypted password
 556         * @return string encrypted password for storage in DB and comparison against DB password.
 557         */
 558         function encrypt_password($user_password)
 559         {
 560                 // encrypt the password.
 561                 $salt = substr($this->user_name, 0, 2);
 562                 $encrypted_password = crypt($user_password, $salt);
 563
 564                 return $encrypted_password;
 565         }
 566
 567         /**
 568          * Authenicates the user; returns true if successful
 569          *
 570          * @param string $password MD5-encoded password
 571          * @return bool
 572          */
 573         public function authenticate_user($password)
 574         {
 575             $row = self::findUserPassword($this->user_name, $password);
 576             if(empty($row)) {
 577                 return false;
 578                 } else {
 579                         $this->id = $row['id'];
 580                         return true;
 581                 }
 582         }
 583
 584     /**
 585      * retrieves an User bean
 586      * preformat name & full_name attribute with first/last
 587      * loads User's preferences
 588      *
 589      * @param string id ID of the User
 590      * @param bool encode encode the result
 591      * @return object User bean
 592      * @return null null if no User found
 593      */
 594         function retrieve($id, $encode = true, $deleted = true) {
 595                 $ret = parent::retrieve($id, $encode, $deleted);
 596                 if ($ret) {
 597                         if (isset ($_SESSION)) {
 598                                 $this->loadPreferences();
 599                         }
 600                 }
 601                 return $ret;
 602         }
 603
 604         function retrieve_by_email_address($email) {
 605
 606                 $email1= strtoupper($email);
 607                 $q=<<<EOQ
 608
 609                 select id from users where id in ( SELECT  er.bean_id AS id FROM email_addr_bean_rel er,
 610                         email_addresses ea WHERE ea.id = er.email_address_id
 611                     AND ea.deleted = 0 AND er.deleted = 0 AND er.bean_module = 'Users' AND email_address_caps IN ('{$email}') )
 612 EOQ;
 613
 614
 615                 $res=$this->db->query($q);
 616                 $row=$this->db->fetchByAssoc($res);
 617
 618                 if (!empty($row['id'])) {
 619                         return $this->retrieve($row['id']);
 620                 }
 621                 return '';
 622         }
 623
 624    function bean_implements($interface) {
 625         switch($interface){
 626             case 'ACL':return true;
 627         }
 628         return false;
 629     }
 630
 631
 632         /**
 633          * Load a user based on the user_name in $this
 634          * @param string $user_password Password
 635          * @param bool $password_encoded Is password md5-encoded or plain text?
 636          * @return -- this if load was successul and null if load failed.
 637          */
 638         function load_user($user_password, $password_encoded = false)
 639         {
 640                 global $login_error;
 641                 unset($GLOBALS['login_error']);
 642                 if(isset ($_SESSION['loginattempts'])) {
 643                         $_SESSION['loginattempts'] += 1;
 644                 } else {
 645                         $_SESSION['loginattempts'] = 1;
 646                 }
 647                 if($_SESSION['loginattempts'] > 5) {
 648                         $GLOBALS['log']->fatal('SECURITY: '.$this->user_name.' has attempted to login '.$_SESSION['loginattempts'].' times from IP address: '.$_SERVER['REMOTE_ADDR'].'.');
 649                         return null;
 650                 }
 651
 652                 $GLOBALS['log']->debug("Starting user load for $this->user_name");
 653
 654                 if (!isset ($this->user_name) || $this->user_name == "" || !isset ($user_password) || $user_password == "")
 655                         return null;
 656
 657             if(!$password_encoded) {
 658                 $user_password = md5($user_password);
 659             }
 660         $row = self::findUserPassword($this->user_name, $user_password);
 661                 if(empty($row) || !empty ($GLOBALS['login_error'])) {
 662                         $GLOBALS['log']->fatal('SECURITY: User authentication for '.$this->user_name.' failed - could not Load User from Database');
 663                         return null;
 664                 }
 665
 666                 // now fill in the fields.
 667                 $this->loadFromRow($row);
 668                 $this->loadPreferences();
 669
 670                 require_once ('modules/Versions/CheckVersions.php');
 671                 $invalid_versions = get_invalid_versions();
 672
 673                 if (!empty ($invalid_versions)) {
 674                         if (isset ($invalid_versions['Rebuild Relationships'])) {
 675                                 unset ($invalid_versions['Rebuild Relationships']);
 676
 677                                 // flag for pickup in DisplayWarnings.php
 678                                 $_SESSION['rebuild_relationships'] = true;
 679                         }
 680
 681                         if (isset ($invalid_versions['Rebuild Extensions'])) {
 682                                 unset ($invalid_versions['Rebuild Extensions']);
 683
 684                                 // flag for pickup in DisplayWarnings.php
 685                                 $_SESSION['rebuild_extensions'] = true;
 686                         }
 687
 688                         $_SESSION['invalid_versions'] = $invalid_versions;
 689                 }
 690                 if ($this->status != "Inactive")
 691                         $this->authenticated = true;
 692
 693                 unset ($_SESSION['loginattempts']);
 694                 return $this;
 695         }
 696
 697         /**
 698          * Generate a new hash from plaintext password
 699          * @param string $password
 700          */
 701         public static function getPasswordHash($password)
 702         {
 703             if(!defined('CRYPT_MD5') || !constant('CRYPT_MD5')) {
 704                 // does not support MD5 crypt - leave as is
 705                 if(defined('CRYPT_EXT_DES') && constant('CRYPT_EXT_DES')) {
 706                     return crypt(strtolower(md5($password)),
 707                         "_.012".substr(str_shuffle('./ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'), -4));
 708                 }
 709                 // plain crypt cuts password to 8 chars, which is not enough
 710                 // fall back to old md5
 711                 return strtolower(md5($password));
 712             }
 713             return crypt(strtolower(md5($password)));
 714         }
 715
 716         /**
 717          * Check that password matches existing hash
 718          * @param string $password Plaintext password
 719          * @param string $user_hash DB hash
 720          */
 721         public static function checkPassword($password, $user_hash)
 722         {
 723             return self::checkPasswordMD5(md5($password), $user_hash);
 724         }
 725
 726         /**
 727          * Check that md5-encoded password matches existing hash
 728          * @param string $password MD5-encoded password
 729          * @param string $user_hash DB hash
 730          * @return bool Match or not?
 731          */
 732         public static function checkPasswordMD5($password_md5, $user_hash)
 733         {
 734             if(empty($user_hash)) return false;
 735             if($user_hash[0] != '$' && strlen($user_hash) == 32) {
 736                 // Old way - just md5 password
 737                 return strtolower($password_md5) == $user_hash;
 738             }
 739             return crypt(strtolower($password_md5), $user_hash) == $user_hash;
 740         }
 741
 742         /**
 743          * Find user with matching password
 744          * @param string $name Username
 745          * @param string $password MD5-encoded password
 746          * @param string $where Limiting query
 747          * @return the matching User of false if not found
 748          */
 749         public static function findUserPassword($name, $password, $where = '')
 750         {
 751             global $db;
 752                 $name = $db->quote($name);
 753                 $query = "SELECT * from users where user_name='$name'";
 754                 if(!empty($where)) {
 755                     $query .= " AND $where";
 756                 }
 757                 $result = $db->limitQuery($query,0,1,false);
 758                 if(!empty($result)) {
 759                     $row = $db->fetchByAssoc($result);
 760                     if(self::checkPasswordMD5($password, $row['user_hash'])) {
 761                         return $row;
 762                     }
 763                 }
 764                 return false;
 765         }
 766
 767         /**
 768          * Sets new password and resets password expiration timers
 769          * @param string $new_password
 770          */
 771         public function setNewPassword($new_password, $system_generated = '0')
 772         {
 773         $user_hash = self::getPasswordHash($new_password);
 774         $this->setPreference('loginexpiration','0');
 775             $this->setPreference('lockout','');
 776                 $this->setPreference('loginfailed','0');
 777                 $this->savePreferencesToDB();
 778         //set new password
 779         $now = TimeDate::getInstance()->nowDb();
 780                 $query = "UPDATE $this->table_name SET user_hash='$user_hash', system_generated_password='$system_generated', pwd_last_changed='$now' where id='$this->id'";
 781                 $this->db->query($query, true, "Error setting new password for $this->user_name: ");
 782         $_SESSION['hasExpiredPassword'] = '0';
 783         }
 784
 785         /**
 786          * Verify that the current password is correct and write the new password to the DB.
 787          *
 788          * @param string $user name - Must be non null and at least 1 character.
 789          * @param string $user_password - Must be non null and at least 1 character.
 790          * @param string $new_password - Must be non null and at least 1 character.
 791          * @return boolean - If passwords pass verification and query succeeds, return true, else return false.
 792          */
 793         function change_password($user_password, $new_password, $system_generated = '0')
 794         {
 795             global $mod_strings;
 796                 global $current_user;
 797                 $GLOBALS['log']->debug("Starting password change for $this->user_name");
 798
 799                 if (!isset ($new_password) || $new_password == "") {
 800                         $this->error_string = $mod_strings['ERR_PASSWORD_CHANGE_FAILED_1'].$current_user->user_name.$mod_strings['ERR_PASSWORD_CHANGE_FAILED_2'];
 801                         return false;
 802                 }
 803
 804                 // Check new password against rules set by admin
 805                 if (!$this->check_password_rules($new_password)) {
 806                     $this->error_string = $mod_strings['ERR_PASSWORD_CHANGE_FAILED_1'].$current_user->user_name.$mod_strings['ERR_PASSWORD_CHANGE_FAILED_3'];
 807                     return false;
 808                 }
 809
 810                 if (!$current_user->isAdminForModule('Users')) {
 811                         //check old password first
 812                         $row = self::findUserPassword($this->user_name, md5($user_password));
 813             if (empty($row)) {
 814                                 $GLOBALS['log']->warn("Incorrect old password for ".$this->user_name."");
 815                                 $this->error_string = $mod_strings['ERR_PASSWORD_INCORRECT_OLD_1'].$this->user_name.$mod_strings['ERR_PASSWORD_INCORRECT_OLD_2'];
 816                                 return false;
 817                         }
 818                 }
 819
 820                 $this->setNewPassword($new_password, $system_generated);
 821                 return true;
 822         }
 823
 824         /**
 825          * Check new password against rules set by admin
 826          * @param string $password
 827          * @return boolean
 828          */
 829         function check_password_rules($password) {
 830             $length = mb_strlen($password);
 831
 832             // Min length
 833             if(!empty($GLOBALS["sugar_config"]["passwordsetting"]["minpwdlength"]) && $GLOBALS["sugar_config"]["passwordsetting"]["minpwdlength"] > 0 && $length < $GLOBALS["sugar_config"]["passwordsetting"]["minpwdlength"]) {
 834                 return false;
 835             }
 836
 837             // Max length
 838             if(!empty($GLOBALS['sugar_config']['passwordsetting']['maxpwdlength']) && $GLOBALS['sugar_config']['passwordsetting']['maxpwdlength'] > 0 && $length > $GLOBALS['sugar_config']['passwordsetting']['maxpwdlength']) {
 839                 return false;
 840             }
 841
 842             // One lower case
 843             if(!empty($GLOBALS["sugar_config"]["passwordsetting"]["onelower"]) && !preg_match('/[a-z]+/', $password)){
 844                 return false;
 845             }
 846
 847             // One upper case
 848             if(!empty($GLOBALS["sugar_config"]["passwordsetting"]["oneupper"]) && !preg_match('/[A-Z]+/', $password)){
 849                 return false;
 850             }
 851
 852             // One number
 853             if(!empty($GLOBALS["sugar_config"]["passwordsetting"]["onenumber"]) && !preg_match('/[0-9]+/', $password)){
 854                 return false;
 855             }
 856
 857             // One special character
 858             if(!empty($GLOBALS["sugar_config"]["passwordsetting"]["onespecial"]) && !preg_match('/[|}{~!@#$%^&*()_+=-]+/', $password)){
 859                 return false;
 860             }
 861
 862             // Custom regex
 863             if(!empty($GLOBALS["sugar_config"]["passwordsetting"]["customregex"]) && !preg_match($GLOBALS["sugar_config"]["passwordsetting"]["customregex"], $password)){
 864                 return false;
 865             }
 866
 867             return true;
 868         }
 869
 870         function is_authenticated() {
 871                 return $this->authenticated;
 872         }
 873
 874         function fill_in_additional_list_fields() {
 875                 $this->fill_in_additional_detail_fields();
 876         }
 877
 878         function fill_in_additional_detail_fields() {
 879                 global $locale;
 880
 881                 $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";
 882                 $result = $this->db->query($query, true, "Error filling in additional detail fields");
 883
 884                 $row = $this->db->fetchByAssoc($result);
 885
 886                 if ($row != null) {
 887                         $this->reports_to_name = stripslashes($row['first_name'].' '.$row['last_name']);
 888                 } else {
 889                         $this->reports_to_name = '';
 890                 }
 891
 892                 $this->_create_proper_name_field();
 893         }
 894
 895         public function retrieve_user_id(
 896             $user_name
 897             )
 898         {
 899             $userFocus = new User;
 900             $userFocus->retrieve_by_string_fields(array('user_name'=>$user_name));
 901             if ( empty($userFocus->id) )
 902                 return false;
 903
 904         return $userFocus->id;
 905         }
 906
 907         /**
 908          * @return -- returns a list of all users in the system.
 909          * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc..
 910          * All Rights Reserved..
 911          * Contributor(s): ______________________________________..
 912          */
 913         function verify_data($ieVerified=true) {
 914                 global $mod_strings, $current_user;
 915                 $verified = TRUE;
 916
 917                 if (!empty ($this->id)) {
 918                         // Make sure the user doesn't report to themselves.
 919                         $reports_to_self = 0;
 920                         $check_user = $this->reports_to_id;
 921                         $already_seen_list = array ();
 922                         while (!empty ($check_user)) {
 923                                 if (isset ($already_seen_list[$check_user])) {
 924                                         // This user doesn't actually report to themselves
 925                                         // But someone above them does.
 926                                         $reports_to_self = 1;
 927                                         break;
 928                                 }
 929                                 if ($check_user == $this->id) {
 930                                         $reports_to_self = 1;
 931                                         break;
 932                                 }
 933                                 $already_seen_list[$check_user] = 1;
 934                                 $query = "SELECT reports_to_id FROM users WHERE id='".$this->db->quote($check_user)."'";
 935                                 $result = $this->db->query($query, true, "Error checking for reporting-loop");
 936                                 $row = $this->db->fetchByAssoc($result);
 937                                 echo ("fetched: ".$row['reports_to_id']." from ".$check_user."<br>");
 938                                 $check_user = $row['reports_to_id'];
 939                         }
 940
 941                         if ($reports_to_self == 1) {
 942                                 $this->error_string .= $mod_strings['ERR_REPORT_LOOP'];
 943                                 $verified = FALSE;
 944                         }
 945                 }
 946
 947                 $query = "SELECT user_name from users where user_name='$this->user_name' AND deleted=0";
 948                 if(!empty($this->id))$query .=  " AND id<>'$this->id'";
 949                 $result = $this->db->query($query, true, "Error selecting possible duplicate users: ");
 950                 $dup_users = $this->db->fetchByAssoc($result);
 951
 952                 if (!empty($dup_users)) {
 953                         $this->error_string .= $mod_strings['ERR_USER_NAME_EXISTS_1'].$this->user_name.$mod_strings['ERR_USER_NAME_EXISTS_2'];
 954                         $verified = FALSE;
 955                 }
 956
 957                 if (is_admin($current_user)) {
 958                     $remaining_admins = $this->db->getOne("SELECT COUNT(*) as c from users where is_admin = 1 AND deleted=0");
 959
 960                         if (($remaining_admins <= 1) && ($this->is_admin != '1') && ($this->id == $current_user->id)) {
 961                                 $GLOBALS['log']->debug("Number of remaining administrator accounts: {$remaining_admins}");
 962                                 $this->error_string .= $mod_strings['ERR_LAST_ADMIN_1'].$this->user_name.$mod_strings['ERR_LAST_ADMIN_2'];
 963                                 $verified = FALSE;
 964                         }
 965                 }
 966                 ///////////////////////////////////////////////////////////////////////
 967                 ////    InboundEmail verification failure
 968                 if(!$ieVerified) {
 969                         $verified = false;
 970                         $this->error_string .= '<br />'.$mod_strings['ERR_EMAIL_NO_OPTS'];
 971                 }
 972
 973                 return $verified;
 974         }
 975
 976         function get_list_view_data() {
 977
 978                 global $current_user, $mod_strings;
 979         // Bug #48555 Not User Name Format of User's locale.
 980         $this->_create_proper_name_field();
 981
 982                 $user_fields = $this->get_list_view_array();
 983                 if ($this->is_admin)
 984                         $user_fields['IS_ADMIN_IMAGE'] = SugarThemeRegistry::current()->getImage('check_inline', '',null,null,'.gif',$mod_strings['LBL_CHECKMARK']);
 985                 elseif (!$this->is_admin) $user_fields['IS_ADMIN'] = '';
 986                 if ($this->is_group)
 987                         $user_fields['IS_GROUP_IMAGE'] = SugarThemeRegistry::current()->getImage('check_inline', '',null,null,'.gif',$mod_strings['LBL_CHECKMARK']);
 988                 else
 989                         $user_fields['IS_GROUP_IMAGE'] = '';
 990
 991
 992         if ($this->is_admin) {
 993                         $user_fields['IS_ADMIN_IMAGE'] = SugarThemeRegistry::current()->getImage('check_inline', '',null,null,'.gif',translate('LBL_CHECKMARK', 'Users'));
 994         } elseif (!$this->is_admin) {
 995               $user_fields['IS_ADMIN'] = '';
 996         }
 997
 998         if ($this->is_group) {
 999                 $user_fields['IS_GROUP_IMAGE'] = SugarThemeRegistry::current()->getImage('check_inline', '',null,null,'.gif',translate('LBL_CHECKMARK', 'Users'));
1000         } else {
1001             $user_fields['NAME'] = empty ($this->name) ? '' : $this->name;
1002         }
1003
1004                 $user_fields['REPORTS_TO_NAME'] = $this->reports_to_name;
1005
1006                 $user_fields['EMAIL1'] = $this->emailAddress->getPrimaryAddress($this);
1007
1008                 return $user_fields;
1009         }
1010
1011         function list_view_parse_additional_sections(& $list_form, $xTemplateSection) {
1012                 return $list_form;
1013         }
1014
1015
1016
1017
1018     /**
1019      * getAllUsers
1020      *
1021      * Returns all active and inactive users
1022      * @return Array of all users in the system
1023      */
1024
1025     public static function getAllUsers()
1026     {
1027         $active_users = get_user_array(FALSE);
1028         $inactive_users = get_user_array(FALSE, "Inactive");
1029         $result = $active_users + $inactive_users;
1030         asort($result);
1031         return $result;
1032     }
1033
1034         function create_export_query($order_by, $where) {
1035                 include('modules/Users/field_arrays.php');
1036
1037                 $cols = '';
1038                 foreach($fields_array['User']['export_fields'] as $field) {
1039                         $cols .= (empty($cols)) ? '' : ', ';
1040                         $cols .= $field;
1041                 }
1042
1043                 $query = "SELECT {$cols} FROM users ";
1044
1045                 $where_auto = " users.deleted = 0";
1046
1047                 if ($where != "")
1048                         $query .= " WHERE $where AND ".$where_auto;
1049                 else
1050                         $query .= " WHERE ".$where_auto;
1051
1052                 // admin for module user is not be able to export a super-admin
1053                 global $current_user;
1054                 if(!$current_user->is_admin){
1055                         $query .= " AND users.is_admin=0";
1056                 }
1057
1058                 if ($order_by != "")
1059                         $query .= " ORDER BY $order_by";
1060                 else
1061                         $query .= " ORDER BY users.user_name";
1062
1063                 return $query;
1064         }
1065
1066         /** Returns a list of the associated users
1067          * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc..
1068          * All Rights Reserved..
1069          * Contributor(s): ______________________________________..
1070         */
1071         function get_meetings() {
1072                 // First, get the list of IDs.
1073                 $query = "SELECT meeting_id as id from meetings_users where user_id='$this->id' AND deleted=0";
1074                 return $this->build_related_list($query, new Meeting());
1075         }
1076         function get_calls() {
1077                 // First, get the list of IDs.
1078                 $query = "SELECT call_id as id from calls_users where user_id='$this->id' AND deleted=0";
1079                 return $this->build_related_list($query, new Call());
1080         }
1081
1082         /**
1083          * generates Javascript to display I-E mail counts, both personal and group
1084          */
1085         function displayEmailCounts() {
1086                 global $theme;
1087                 $new = translate('LBL_NEW', 'Emails');
1088                 $default = 'index.php?module=Emails&action=ListView&assigned_user_id='.$this->id;
1089                 $count = '';
1090                 $verts = array('Love', 'Links', 'Pipeline', 'RipCurl', 'SugarLite');
1091
1092                 if($this->hasPersonalEmail()) {
1093                         $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\'');
1094                         $a = $this->db->fetchByAssoc($r);
1095                         if(in_array($theme, $verts)) {
1096                                 $count .= '<br />';
1097                         } else {
1098                                 $count .= '&nbsp;&nbsp;&nbsp;&nbsp;';
1099                         }
1100                         $count .= '<a href='.$default.'&type=inbound>'.translate('LBL_LIST_TITLE_MY_INBOX', 'Emails').': ('.$a['c'].' '.$new.')</a>';
1101
1102                         if(!in_array($theme, $verts)) {
1103                                 $count .= ' - ';
1104                         }
1105                 }
1106
1107                 $r = $this->db->query('SELECT id FROM users WHERE users.is_group = 1 AND deleted = 0');
1108                 $groupIds = '';
1109                 $groupNew = '';
1110                 while($a = $this->db->fetchByAssoc($r)) {
1111                         if($groupIds != '') {$groupIds .= ', ';}
1112                         $groupIds .= "'".$a['id']."'";
1113                 }
1114
1115                 $total = 0;
1116                 if(strlen($groupIds) > 0) {
1117                         $groupQuery = 'SELECT count(*) AS c FROM emails ';
1118                         $groupQuery .= ' WHERE emails.deleted=0 AND emails.assigned_user_id IN ('.$groupIds.') AND emails.type = \'inbound\' AND emails.status = \'unread\'';
1119                         $r = $this->db->query($groupQuery);
1120                         if(is_resource($r)) {
1121                                 $a = $this->db->fetchByAssoc($r);
1122                                 if($a['c'] > 0) {
1123                                         $total = $a['c'];
1124                                 }
1125                         }
1126                 }
1127                 if(in_array($theme, $verts)) $count .= '<br />';
1128                 if(empty($count)) $count .= '&nbsp;&nbsp;&nbsp;&nbsp;';
1129                 $count .= '<a href=index.php?module=Emails&action=ListViewGroup>'.translate('LBL_LIST_TITLE_GROUP_INBOX', 'Emails').': ('.$total.' '.$new.')</a>';
1130
1131                 $out  = '<script type="text/javascript" language="Javascript">';
1132                 $out .= 'var welcome = document.getElementById("welcome");';
1133                 $out .= 'var welcomeContent = welcome.innerHTML;';
1134                 $out .= 'welcome.innerHTML = welcomeContent + "'.$count.'";';
1135                 $out .= '</script>';
1136
1137                 echo $out;
1138         }
1139
1140         function getPreferredEmail() {
1141                 $ret = array ();
1142                 $nameEmail = $this->getUsersNameAndEmail();
1143                 $prefAddr = $nameEmail['email'];
1144                 $fullName = $nameEmail['name'];
1145                 if (empty ($prefAddr)) {
1146                         $nameEmail = $this->getSystemDefaultNameAndEmail();
1147                         $prefAddr = $nameEmail['email'];
1148                         $fullName = $nameEmail['name'];
1149                 } // if
1150                 $fullName = from_html($fullName);
1151                 $ret['name'] = $fullName;
1152                 $ret['email'] = $prefAddr;
1153                 return $ret;
1154         }
1155
1156         function getUsersNameAndEmail()
1157         {
1158             // Bug #48555 Not User Name Format of User's locale.
1159             $this->_create_proper_name_field();
1160
1161                 $prefAddr = $this->emailAddress->getPrimaryAddress($this);
1162
1163                 if (empty ($prefAddr)) {
1164                         $prefAddr = $this->emailAddress->getReplyToAddress($this);
1165                 }
1166                 return array('email' => $prefAddr , 'name' => $this->name);
1167
1168         } // fn
1169
1170         function getSystemDefaultNameAndEmail() {
1171
1172                 $email = new Email();
1173                 $return = $email->getSystemDefaultEmail();
1174                 $prefAddr = $return['email'];
1175                 $fullName = $return['name'];
1176                 return array('email' => $prefAddr , 'name' => $fullName);
1177         } // fn
1178
1179         /**
1180          * sets User email default in config.php if not already set by install - i.
1181          * e., upgrades
1182          */
1183         function setDefaultsInConfig() {
1184                 global $sugar_config;
1185                 $sugar_config['email_default_client'] = 'sugar';
1186                 $sugar_config['email_default_editor'] = 'html';
1187                 ksort($sugar_config);
1188                 write_array_to_file('sugar_config', $sugar_config, 'config.php');
1189                 return $sugar_config;
1190         }
1191
1192     /**
1193      * returns User's email address based on descending order of preferences
1194      *
1195      * @param string id GUID of target user if needed
1196      * @return array Assoc array for an email and name
1197      */
1198     function getEmailInfo($id='') {
1199         $user = $this;
1200         if(!empty($id)) {
1201             $user = new User();
1202             $user->retrieve($id);
1203         }
1204
1205         // from name
1206         $fromName = $user->getPreference('mail_fromname');
1207         if(empty($fromName)) {
1208                 // cn: bug 8586 - localized name format
1209             $fromName = $user->full_name;
1210         }
1211
1212         // from address
1213         $fromaddr = $user->getPreference('mail_fromaddress');
1214         if(empty($fromaddr)) {
1215             if(!empty($user->email1) && isset($user->email1)) {
1216                 $fromaddr = $user->email1;
1217             } elseif(!empty($user->email2) && isset($user->email2)) {
1218                 $fromaddr = $user->email2;
1219             } else {
1220                 $r = $user->db->query("SELECT value FROM config WHERE name = 'fromaddress'");
1221                 $a = $user->db->fetchByAssoc($r);
1222                 $fromddr = $a['value'];
1223             }
1224         }
1225
1226         $ret['name'] = $fromName;
1227         $ret['email'] = $fromaddr;
1228
1229         return $ret;
1230     }
1231
1232         /**
1233          * returns opening <a href=xxxx for a contact, account, etc
1234          * cascades from User set preference to System-wide default
1235          * @return string       link
1236          * @param attribute the email addy
1237          * @param focus the parent bean
1238          * @param contact_id
1239          * @param return_module
1240          * @param return_action
1241          * @param return_id
1242          * @param class
1243          */
1244         function getEmailLink2($emailAddress, &$focus, $contact_id='', $ret_module='', $ret_action='DetailView', $ret_id='', $class='') {
1245                 $emailLink = '';
1246                 global $sugar_config;
1247
1248                 if(!isset($sugar_config['email_default_client'])) {
1249                         $this->setDefaultsInConfig();
1250                 }
1251
1252                 $userPref = $this->getPreference('email_link_type');
1253                 $defaultPref = $sugar_config['email_default_client'];
1254                 if($userPref != '') {
1255                         $client = $userPref;
1256                 } else {
1257                         $client = $defaultPref;
1258                 }
1259
1260                 if($client == 'sugar') {
1261                         $email = '';
1262                         $to_addrs_ids = '';
1263                         $to_addrs_names = '';
1264                         $to_addrs_emails = '';
1265
1266                         $fullName = !empty($focus->name) ? $focus->name : '';
1267
1268                         if(empty($ret_module)) $ret_module = $focus->module_dir;
1269                         if(empty($ret_id)) $ret_id = $focus->id;
1270                         if($focus->object_name == 'Contact') {
1271                                 $contact_id = $focus->id;
1272                                 $to_addrs_ids = $focus->id;
1273                                 // Bug #48555 Not User Name Format of User's locale.
1274                                 $focus->_create_proper_name_field();
1275                             $fullName = $focus->name;
1276                             $to_addrs_names = $fullName;
1277                                 $to_addrs_emails = $focus->email1;
1278                         }
1279
1280                         $emailLinkUrl = 'contact_id='.$contact_id.
1281                                 '&parent_type='.$focus->module_dir.
1282                                 '&parent_id='.$focus->id.
1283                                 '&parent_name='.urlencode($fullName).
1284                                 '&to_addrs_ids='.$to_addrs_ids.
1285                                 '&to_addrs_names='.urlencode($to_addrs_names).
1286                                 '&to_addrs_emails='.urlencode($to_addrs_emails).
1287                                 '&to_email_addrs='.urlencode($fullName . '&nbsp;&lt;' . $emailAddress . '&gt;').
1288                                 '&return_module='.$ret_module.
1289                                 '&return_action='.$ret_action.
1290                                 '&return_id='.$ret_id;
1291
1292                 //Generate the compose package for the quick create options.
1293                 //$json = getJSONobj();
1294                 //$composeOptionsLink = $json->encode( array('composeOptionsLink' => $emailLinkUrl,'id' => $focus->id) );
1295                         require_once('modules/Emails/EmailUI.php');
1296             $eUi = new EmailUI();
1297             $j_quickComposeOptions = $eUi->generateComposePackageForQuickCreateFromComposeUrl($emailLinkUrl, true);
1298
1299                 $emailLink = "<a href='javascript:void(0);' onclick='SUGAR.quickCompose.init($j_quickComposeOptions);' class='$class'>";
1300
1301                 } else {
1302                         // straight mailto:
1303                         $emailLink = '<a href="mailto:'.$emailAddress.'" class="'.$class.'">';
1304                 }
1305
1306                 return $emailLink;
1307         }
1308
1309         /**
1310          * returns opening <a href=xxxx for a contact, account, etc
1311          * cascades from User set preference to System-wide default
1312          * @return string       link
1313          * @param attribute the email addy
1314          * @param focus the parent bean
1315          * @param contact_id
1316          * @param return_module
1317          * @param return_action
1318          * @param return_id
1319          * @param class
1320          */
1321         function getEmailLink($attribute, &$focus, $contact_id='', $ret_module='', $ret_action='DetailView', $ret_id='', $class='') {
1322             $emailLink = '';
1323                 global $sugar_config;
1324
1325                 if(!isset($sugar_config['email_default_client'])) {
1326                         $this->setDefaultsInConfig();
1327                 }
1328
1329                 $userPref = $this->getPreference('email_link_type');
1330                 $defaultPref = $sugar_config['email_default_client'];
1331                 if($userPref != '') {
1332                         $client = $userPref;
1333                 } else {
1334                         $client = $defaultPref;
1335                 }
1336
1337                 if($client == 'sugar') {
1338                         $email = '';
1339                         $to_addrs_ids = '';
1340                         $to_addrs_names = '';
1341                         $to_addrs_emails = '';
1342
1343             $fullName = !empty($focus->name) ? $focus->name : '';
1344
1345                         if(!empty($focus->$attribute)) {
1346                                 $email = $focus->$attribute;
1347                         }
1348
1349
1350                         if(empty($ret_module)) $ret_module = $focus->module_dir;
1351                         if(empty($ret_id)) $ret_id = $focus->id;
1352                         if($focus->object_name == 'Contact') {
1353                                 // Bug #48555 Not User Name Format of User's locale.
1354                                 $focus->_create_proper_name_field();
1355                             $fullName = $focus->name;
1356                             $contact_id = $focus->id;
1357                                 $to_addrs_ids = $focus->id;
1358                                 $to_addrs_names = $fullName;
1359                                 $to_addrs_emails = $focus->email1;
1360                         }
1361
1362                         $emailLinkUrl = 'contact_id='.$contact_id.
1363                                 '&parent_type='.$focus->module_dir.
1364                                 '&parent_id='.$focus->id.
1365                                 '&parent_name='.urlencode($fullName).
1366                                 '&to_addrs_ids='.$to_addrs_ids.
1367                                 '&to_addrs_names='.urlencode($to_addrs_names).
1368                                 '&to_addrs_emails='.urlencode($to_addrs_emails).
1369                                 '&to_email_addrs='.urlencode($fullName . '&nbsp;&lt;' . $email . '&gt;').
1370                                 '&return_module='.$ret_module.
1371                                 '&return_action='.$ret_action.
1372                                 '&return_id='.$ret_id;
1373
1374                         //Generate the compose package for the quick create options.
1375                 require_once('modules/Emails/EmailUI.php');
1376             $eUi = new EmailUI();
1377             $j_quickComposeOptions = $eUi->generateComposePackageForQuickCreateFromComposeUrl($emailLinkUrl, true);
1378                 $emailLink = "<a href='javascript:void(0);' onclick='SUGAR.quickCompose.init($j_quickComposeOptions);' class='$class'>";
1379
1380                 } else {
1381                         // straight mailto:
1382                         $emailLink = '<a href="mailto:'.$focus->$attribute.'" class="'.$class.'">';
1383                 }
1384
1385                 return $emailLink;
1386         }
1387
1388
1389         /**
1390          * gets a human-readable explanation of the format macro
1391          * @return string Human readable name format
1392          */
1393         function getLocaleFormatDesc() {
1394                 global $locale;
1395                 global $mod_strings;
1396                 global $app_strings;
1397
1398                 $format['f'] = $mod_strings['LBL_LOCALE_DESC_FIRST'];
1399                 $format['l'] = $mod_strings['LBL_LOCALE_DESC_LAST'];
1400                 $format['s'] = $mod_strings['LBL_LOCALE_DESC_SALUTATION'];
1401                 $format['t'] = $mod_strings['LBL_LOCALE_DESC_TITLE'];
1402
1403                 $name['f'] = $app_strings['LBL_LOCALE_NAME_EXAMPLE_FIRST'];
1404                 $name['l'] = $app_strings['LBL_LOCALE_NAME_EXAMPLE_LAST'];
1405                 $name['s'] = $app_strings['LBL_LOCALE_NAME_EXAMPLE_SALUTATION'];
1406                 $name['t'] = $app_strings['LBL_LOCALE_NAME_EXAMPLE_TITLE'];
1407
1408                 $macro = $locale->getLocaleFormatMacro();
1409
1410                 $ret1 = '';
1411                 $ret2 = '';
1412                 for($i=0; $i<strlen($macro); $i++) {
1413                         if(array_key_exists($macro{$i}, $format)) {
1414                                 $ret1 .= "<i>".$format[$macro{$i}]."</i>";
1415                                 $ret2 .= "<i>".$name[$macro{$i}]."</i>";
1416                         } else {
1417                                 $ret1 .= $macro{$i};
1418                                 $ret2 .= $macro{$i};
1419                         }
1420                 }
1421                 return $ret1."<br />".$ret2;
1422         }
1423
1424
1425     /*
1426      *
1427      * Here are the multi level admin access check functions.
1428      *
1429      */
1430     /**
1431      * Helper function to remap some modules around ACL wise
1432      *
1433      * @return string
1434      */
1435     protected function _fixupModuleForACL($module) {
1436         if($module=='ContractTypes') {
1437             $module = 'Contracts';
1438         }
1439         if(preg_match('/Product[a-zA-Z]*/',$module)) {
1440             $module = 'Products';
1441         }
1442
1443         return $module;
1444     }
1445     /**
1446      * Helper function that enumerates the list of modules and checks if they are an admin/dev.
1447      * The code was just too similar to copy and paste.
1448      *
1449      * @return array
1450      */
1451     protected function _getModulesForACL($type='dev'){
1452         $isDev = $type=='dev';
1453         $isAdmin = $type=='admin';
1454
1455         global $beanList;
1456         $myModules = array();
1457
1458         if (!is_array($beanList) ) {
1459             return $myModules;
1460         }
1461
1462         // These modules don't take kindly to the studio trying to play about with them.
1463         static $ignoredModuleList = array('iFrames','Feeds','Home','Dashboard','Calendar','Activities','Reports');
1464
1465
1466         $actions = ACLAction::getUserActions($this->id);
1467
1468         foreach ($beanList as $module=>$val) {
1469             // Remap the module name
1470             $module = $this->_fixupModuleForACL($module);
1471             if (in_array($module,$myModules)) {
1472                 // Already have the module in the list
1473                 continue;
1474             }
1475             if (in_array($module,$ignoredModuleList)) {
1476                 // You can't develop on these modules.
1477                 continue;
1478             }
1479
1480             $focus = SugarModule::get($module)->loadBean();
1481             if ( $focus instanceOf SugarBean ) {
1482                 $key = $focus->acltype;
1483             } else {
1484                 $key = 'module';
1485             }
1486
1487             if (($this->isAdmin() && isset($actions[$module][$key]))
1488                 ) {
1489                 $myModules[] = $module;
1490             }
1491         }
1492
1493         return $myModules;
1494     }
1495     /**
1496      * Is this user a system wide admin
1497      *
1498      * @return bool
1499      */
1500     public function isAdmin() {
1501         if(isset($this->is_admin)
1502            &&($this->is_admin == '1' || $this->is_admin === 'on')){
1503             return true;
1504         }
1505         return false;
1506     }
1507     /**
1508      * Is this user a developer for any module
1509      *
1510      * @return bool
1511      */
1512     public function isDeveloperForAnyModule() {
1513         if ($this->isAdmin()) {
1514             return true;
1515         }
1516         return false;
1517     }
1518     /**
1519      * List the modules a user has developer access to
1520      *
1521      * @return array
1522      */
1523     public function getDeveloperModules() {
1524         static $developerModules;
1525         if (!isset($_SESSION[$this->user_name.'_get_developer_modules_for_user']) ) {
1526             $_SESSION[$this->user_name.'_get_developer_modules_for_user'] = $this->_getModulesForACL('dev');
1527         }
1528
1529         return $_SESSION[$this->user_name.'_get_developer_modules_for_user'];
1530     }
1531     /**
1532      * Is this user a developer for the specified module
1533      *
1534      * @return bool
1535      */
1536     public function isDeveloperForModule($module) {
1537         if ($this->isAdmin()) {
1538             return true;
1539         }
1540
1541         $devModules = $this->getDeveloperModules();
1542
1543         $module = $this->_fixupModuleForACL($module);
1544
1545         if (in_array($module,$devModules) ) {
1546             return true;
1547         }
1548
1549         return false;
1550     }
1551     /**
1552      * List the modules a user has admin access to
1553      *
1554      * @return array
1555      */
1556     public function getAdminModules() {
1557         if (!isset($_SESSION[$this->user_name.'_get_admin_modules_for_user']) ) {
1558             $_SESSION[$this->user_name.'_get_admin_modules_for_user'] = $this->_getModulesForACL('admin');
1559         }
1560
1561         return $_SESSION[$this->user_name.'_get_admin_modules_for_user'];
1562     }
1563     /**
1564      * Is this user an admin for the specified module
1565      *
1566      * @return bool
1567      */
1568     public function isAdminForModule($module) {
1569         if ($this->isAdmin()) {
1570             return true;
1571         }
1572
1573         $adminModules = $this->getAdminModules();
1574
1575         $module = $this->_fixupModuleForACL($module);
1576
1577         if (in_array($module,$adminModules) ) {
1578             return true;
1579         }
1580
1581         return false;
1582     }
1583         /**
1584          * Whether or not based on the user's locale if we should show the last name first.
1585          *
1586          * @return bool
1587          */
1588         public function showLastNameFirst(){
1589                 global $locale;
1590         $localeFormat = $locale->getLocaleFormatMacro($this);
1591                 if ( strpos($localeFormat,'l') > strpos($localeFormat,'f') ) {
1592                     return false;
1593         }else {
1594                 return true;
1595         }
1596         }
1597
1598
1599
1600    function create_new_list_query($order_by, $where,$filter=array(),$params=array(), $show_deleted = 0,$join_type='', $return_array = false,$parentbean=null, $singleSelect = false)
1601    {    //call parent method, specifying for array to be returned
1602         $ret_array = parent::create_new_list_query($order_by, $where,$filter,$params, $show_deleted,$join_type, true,$parentbean, $singleSelect);
1603
1604         //if this is being called from webservices, then run additional code
1605         if(!empty($GLOBALS['soap_server_object'])){
1606
1607                 //if this is a single select, then secondary queries are being run that may result in duplicate rows being returned through the
1608                 //left joins with meetings/tasks/call.  We need to change the left joins to include a null check (bug 40250)
1609                 if($singleSelect)
1610                 {
1611                         //retrieve the 'from' string and make lowercase for easier manipulation
1612                         $left_str = strtolower($ret_array['from']);
1613                         $lefts = explode('left join', $left_str);
1614                         $new_left_str = '';
1615
1616                         //explode on the left joins and process each one
1617                         foreach($lefts as $ljVal){
1618                                 //grab the join alias
1619                                 $onPos = strpos( $ljVal, ' on');
1620                                 if($onPos === false){
1621                                         $new_left_str .=' '.$ljVal.' ';
1622                                         continue;
1623                                 }
1624                                 $spacePos = strrpos(substr($ljVal, 0, $onPos),' ');
1625                                 $alias = substr($ljVal,$spacePos,$onPos-$spacePos);
1626
1627                                 //add null check to end of the Join statement
1628                         // Bug #46390 to use id_c field instead of id field for custom tables
1629                         if(substr($alias, -5) != '_cstm')
1630                         {
1631                             $ljVal ='  LEFT JOIN '.$ljVal.' and '.$alias.'.id is null ';
1632                         }
1633                         else
1634                         {
1635                             $ljVal ='  LEFT JOIN '.$ljVal.' and '.$alias.'.id_c is null ';
1636                         }
1637
1638                                 //add statement into new string
1639                                 $new_left_str .= $ljVal;
1640                          }
1641                          //replace the old string with the new one
1642                          $ret_array['from'] = $new_left_str;
1643                 }
1644         }
1645
1646                 //return array or query string
1647                 if($return_array)
1648         {
1649                 return $ret_array;
1650         }
1651
1652         return  $ret_array['select'] . $ret_array['from'] . $ret_array['where']. $ret_array['order_by'];
1653
1654
1655
1656    }
1657
1658     /**
1659      * Get user first day of week.
1660      *
1661      * @param [User] $user user object, current user if not specified
1662      * @return int : 0 = Sunday, 1 = Monday, etc...
1663      */
1664     public function get_first_day_of_week()
1665     {
1666         $fdow = $this->getPreference('fdow');
1667         if (empty($fdow))
1668         {
1669             $fdow = 0;
1670         }
1671
1672         return $fdow;
1673     }
1674
1675     /**
1676      * Method for password generation
1677      *
1678      * @static
1679      * @return string password
1680      */
1681     public static function generatePassword()
1682     {
1683         $res = $GLOBALS['sugar_config']['passwordsetting'];
1684         $charBKT = '';
1685         //chars to select from
1686         $LOWERCASE = "abcdefghijklmnpqrstuvwxyz";
1687         $NUMBER = "0123456789";
1688         $UPPERCASE = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
1689         $SPECIAL = '~!@#$%^&*()_+=-{}|';
1690         $condition = 0;
1691         $charBKT .= $UPPERCASE . $LOWERCASE . $NUMBER;
1692         $password = "";
1693             $length = '6';
1694
1695         // Create random characters for the ones that doesnt have requirements
1696         for ($i=0; $i < $length - $condition; $i ++)  // loop and create password
1697         {
1698             $password = $password . substr ($charBKT, rand() % strlen($charBKT), 1);
1699         }
1700
1701         return $password;
1702     }
1703
1704     /**
1705      * Send new password or link to user
1706      *
1707      * @param string $templateId Id of email template
1708      * @param array $additionalData additional params: link, url, password
1709      * @return array status: true|false, message: error message, if status = false and message = '' it means that send method has returned false
1710      */
1711     public function sendEmailForPassword($templateId, array $additionalData = array())
1712     {
1713         global $sugar_config, $current_user;
1714         $mod_strings = return_module_language('', 'Users');
1715         $result = array(
1716             'status' => false,
1717             'message' => ''
1718         );
1719
1720         $emailTemp = new EmailTemplate();
1721         $emailTemp->disable_row_level_security = true;
1722         if ($emailTemp->retrieve($templateId) == '')
1723         {
1724             $result['message'] = $mod_strings['LBL_EMAIL_TEMPLATE_MISSING'];
1725             return $result;
1726         }
1727
1728         //replace instance variables in email templates
1729         $htmlBody = $emailTemp->body_html;
1730         $body = $emailTemp->body;
1731         if (isset($additionalData['link']) && $additionalData['link'] == true)
1732         {
1733             $htmlBody = str_replace('$contact_user_link_guid', $additionalData['url'], $htmlBody);
1734             $body = str_replace('$contact_user_link_guid', $additionalData['url'], $body);
1735         }
1736         else
1737         {
1738             $htmlBody = str_replace('$contact_user_user_hash', $additionalData['password'], $htmlBody);
1739             $body = str_replace('$contact_user_user_hash', $additionalData['password'], $body);
1740         }
1741         // Bug 36833 - Add replacing of special value $instance_url
1742         $htmlBody = str_replace('$config_site_url', $sugar_config['site_url'], $htmlBody);
1743         $body = str_replace('$config_site_url', $sugar_config['site_url'], $body);
1744
1745         $htmlBody = str_replace('$contact_user_user_name', $this->user_name, $htmlBody);
1746         $htmlBody = str_replace('$contact_user_pwd_last_changed', TimeDate::getInstance()->nowDb(), $htmlBody);
1747         $body = str_replace('$contact_user_user_name', $this->user_name, $body);
1748         $body = str_replace('$contact_user_pwd_last_changed', TimeDate::getInstance()->nowDb(), $body);
1749         $emailTemp->body_html = $htmlBody;
1750         $emailTemp->body = $body;
1751
1752         $itemail = $this->emailAddress->getPrimaryAddress($this);
1753         //retrieve IT Admin Email
1754         //_ppd( $emailTemp->body_html);
1755         //retrieve email defaults
1756         $emailObj = new Email();
1757         $defaults = $emailObj->getSystemDefaultEmail();
1758         require_once('include/SugarPHPMailer.php');
1759         $mail = new SugarPHPMailer();
1760         $mail->setMailerForSystem();
1761         //$mail->IsHTML(true);
1762         $mail->From = $defaults['email'];
1763         $mail->FromName = $defaults['name'];
1764         $mail->ClearAllRecipients();
1765         $mail->ClearReplyTos();
1766         $mail->Subject = from_html($emailTemp->subject);
1767         if ($emailTemp->text_only != 1)
1768         {
1769             $mail->IsHTML(true);
1770             $mail->Body = from_html($emailTemp->body_html);
1771             $mail->AltBody = from_html($emailTemp->body);
1772         }
1773         else
1774         {
1775             $mail->Body_html = from_html($emailTemp->body_html);
1776             $mail->Body = from_html($emailTemp->body);
1777         }
1778         if ($mail->Body == '' && $current_user->is_admin)
1779         {
1780             global $app_strings;
1781             $result['message'] = $app_strings['LBL_EMAIL_TEMPLATE_EDIT_PLAIN_TEXT'];
1782             return $result;
1783         }
1784         if ($mail->Mailer == 'smtp' && $mail->Host =='' && $current_user->is_admin)
1785         {
1786             $result['message'] = $mod_strings['ERR_SERVER_SMTP_EMPTY'];
1787             return $result;
1788         }
1789
1790         $mail->prepForOutbound();
1791         $hasRecipients = false;
1792
1793         if (!empty($itemail))
1794         {
1795             if ($hasRecipients)
1796             {
1797                 $mail->AddBCC($itemail);
1798             }
1799             else
1800             {
1801                 $mail->AddAddress($itemail);
1802             }
1803             $hasRecipients = true;
1804         }
1805         if ($hasRecipients)
1806         {
1807             $result['status'] = @$mail->Send();
1808         }
1809
1810         if ($result['status'] == true)
1811         {
1812             $emailObj->team_id = 1;
1813             $emailObj->to_addrs = '';
1814             $emailObj->type = 'archived';
1815             $emailObj->deleted = '0';
1816             $emailObj->name = $mail->Subject ;
1817             $emailObj->description = $mail->Body;
1818             $emailObj->description_html = null;
1819             $emailObj->from_addr = $mail->From;
1820             $emailObj->parent_type = 'User';
1821             $emailObj->date_sent = TimeDate::getInstance()->nowDb();
1822             $emailObj->modified_user_id = '1';
1823             $emailObj->created_by = '1';
1824             $emailObj->status = 'sent';
1825             $emailObj->save();
1826             if (!isset($additionalData['link']) || $additionalData['link'] == false)
1827             {
1828                 $this->setNewPassword($additionalData['password'], '1');
1829             }
1830         }
1831
1832         return $result;
1833     }
1834
1835     // Bug #48014 Must to send password to imported user if this action is required
1836     function afterImportSave()
1837     {
1838         if(
1839             $this->user_hash == false
1840             && !$this->is_group
1841             && !$this->portal_only
1842             && isset($GLOBALS['sugar_config']['passwordsetting']['SystemGeneratedPasswordON'])
1843             && $GLOBALS['sugar_config']['passwordsetting']['SystemGeneratedPasswordON']
1844         )
1845         {
1846             $backUpPost = $_POST;
1847             $_POST = array(
1848                 'userId' => $this->id
1849             );
1850             ob_start();
1851             require('modules/Users/GeneratePassword.php');
1852             $result = ob_get_clean();
1853             $_POST = $backUpPost;
1854             return $result == true;
1855         }
1856     }
1857 }