modules/Users/User.php

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