modules/Users/User.php

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