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