data/SugarBean.php

   1 <?php
   2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
   3 /*********************************************************************************
   4  * SugarCRM 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:  Defines the base class for all data entities used throughout the
  41  * application.  The base class including its methods and variables is designed to
  42  * be overloaded with module-specific methods and variables particular to the
  43  * module's base entity class.
  44  * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  45  * All Rights Reserved.
  46  *******************************************************************************/
  47
  48 require_once('modules/DynamicFields/DynamicField.php');
  49
  50 /**
  51  * SugarBean is the base class for all business objects in Sugar.  It implements
  52  * the primary functionality needed for manipulating business objects: create,
  53  * retrieve, update, delete.  It allows for searching and retrieving list of records.
  54  * It allows for retrieving related objects (e.g. contacts related to a specific account).
  55  *
  56  * In the current implementation, there can only be one bean per folder.
  57  * Naming convention has the bean name be the same as the module and folder name.
  58  * All bean names should be singular (e.g. Contact).  The primary table name for
  59  * a bean should be plural (e.g. contacts).
  60  *
  61  */
  62 class SugarBean
  63 {
  64     /**
  65      * A pointer to the database helper object DBHelper
  66      *
  67      * @var DBHelper
  68      */
  69     var $db;
  70
  71         /**
  72          * When createing a bean, you can specify a value in the id column as
  73          * long as that value is unique.  During save, if the system finds an
  74          * id, it assumes it is an update.  Setting new_with_id to true will
  75          * make sure the system performs an insert instead of an update.
  76          *
  77          * @var BOOL -- default false
  78          */
  79         var $new_with_id = false;
  80
  81
  82         /**
  83          * Disble vardefs.  This should be set to true only for beans that do not have varders.  Tracker is an example
  84          *
  85          * @var BOOL -- default false
  86          */
  87     var $disable_vardefs = false;
  88
  89
  90     /**
  91      * holds the full name of the user that an item is assigned to.  Only used if notifications
  92      * are turned on and going to be sent out.
  93      *
  94      * @var String
  95      */
  96     var $new_assigned_user_name;
  97
  98         /**
  99          * An array of booleans.  This array is cleared out when data is loaded.
 100          * As date/times are converted, a "1" is placed under the key, the field is converted.
 101          *
 102          * @var Array of booleans
 103          */
 104         var $processed_dates_times = array();
 105
 106         /**
 107          * Whether to process date/time fields for storage in the database in GMT
 108          *
 109          * @var BOOL
 110          */
 111         var $process_save_dates =true;
 112
 113     /**
 114      * This signals to the bean that it is being saved in a mass mode.
 115      * Examples of this kind of save are import and mass update.
 116      * We turn off notificaitons of this is the case to make things more efficient.
 117      *
 118      * @var BOOL
 119      */
 120     var $save_from_post = true;
 121
 122         /**
 123          * When running a query on related items using the method: retrieve_by_string_fields
 124          * this value will be set to true if more than one item matches the search criteria.
 125          *
 126          * @var BOOL
 127          */
 128         var $duplicates_found = false;
 129
 130         /**
 131          * The DBManager instance that was used to load this bean and should be used for
 132          * future database interactions.
 133          *
 134          * @var DBManager
 135          */
 136         var $dbManager;
 137
 138         /**
 139          * true if this bean has been deleted, false otherwise.
 140          *
 141          * @var BOOL
 142          */
 143         var $deleted = 0;
 144
 145     /**
 146      * Should the date modified column of the bean be updated during save?
 147      * This is used for admin level functionality that should not be updating
 148      * the date modified.  This is only used by sync to allow for updates to be
 149      * replicated in a way that will not cause them to be replicated back.
 150      *
 151      * @var BOOL
 152      */
 153     var $update_date_modified = true;
 154
 155     /**
 156      * Should the modified by column of the bean be updated during save?
 157      * This is used for admin level functionality that should not be updating
 158      * the modified by column.  This is only used by sync to allow for updates to be
 159      * replicated in a way that will not cause them to be replicated back.
 160      *
 161      * @var BOOL
 162      */
 163     var $update_modified_by = true;
 164
 165     /**
 166      * Setting this to true allows for updates to overwrite the date_entered
 167      *
 168      * @var BOOL
 169      */
 170     var $update_date_entered = false;
 171
 172     /**
 173      * This allows for seed data to be created without using the current uesr to set the id.
 174      * This should be replaced by altering the current user before the call to save.
 175      *
 176      * @var unknown_type
 177      */
 178     //TODO This should be replaced by altering the current user before the call to save.
 179     var $set_created_by = true;
 180
 181     var $team_set_id;
 182
 183     /**
 184      * The database table where records of this Bean are stored.
 185      *
 186      * @var String
 187      */
 188     var $table_name = '';
 189
 190         /**
 191          * This is the singular name of the bean.  (i.e. Contact).
 192          *
 193          * @var String
 194          */
 195         var $object_name = '';
 196
 197         /** Set this to true if you query contains a sub-select and bean is converting both select statements
 198          * into count queries.
 199          */
 200         var $ungreedy_count=false;
 201
 202         /**
 203          * The name of the module folder for this type of bean.
 204          *
 205          * @var String
 206          */
 207         var $module_dir = '';
 208         var $field_name_map;
 209         var $field_defs;
 210         var $custom_fields;
 211         var $column_fields = array();
 212         var $list_fields = array();
 213         var $additional_column_fields = array();
 214         var $relationship_fields = array();
 215         var $current_notify_user;
 216         var $fetched_row=false;
 217         var $layout_def;
 218         var $force_load_details = false;
 219         var $optimistic_lock = false;
 220         var $disable_custom_fields = false;
 221         var $number_formatting_done = false;
 222         var $process_field_encrypted=false;
 223         /*
 224          * The default ACL type
 225          */
 226         var $acltype = 'module';
 227
 228
 229     var $additional_meta_fields = array();
 230
 231     /**
 232      * Set to true in the child beans if the module supports importing
 233      */
 234         var $importable = false;
 235
 236         /**
 237          * Set to true in the child beans if the module use the special notification template
 238          */
 239         var $special_notification = false;
 240
 241     /**
 242      * Set to true if the bean is being dealt with in a workflow
 243      */
 244     var $in_workflow = false;
 245
 246     /**
 247      * Used to pass inner join string to ListView Data.
 248      */
 249     var $listview_inner_join = array();
 250
 251     /**
 252      * Set to true in <modules>/Import/views/view.step4.php if a module is being imported
 253      */
 254     var $in_import = false;
 255     /**
 256      * Constructor for the bean, it performs following tasks:
 257      *
 258      * 1. Initalized a database connections
 259      * 2. Load the vardefs for the module implemeting the class. cache the entries
 260      *    if needed
 261      * 3. Setup row-level security preference
 262      * All implementing classes  must call this constructor using the parent::SugarBean() class.
 263      *
 264      */
 265     function SugarBean()
 266     {
 267         global  $dictionary, $current_user;
 268         static $loaded_defs = array();
 269         $this->db = DBManagerFactory::getInstance();
 270
 271         $this->dbManager = & DBManagerFactory::getInstance();
 272         if((false == $this->disable_vardefs && empty($loaded_defs[$this->object_name])) || !empty($GLOBALS['reload_vardefs']))
 273         {
 274                 VardefManager::loadVardef($this->module_dir, $this->object_name);
 275
 276             // build $this->column_fields from the field_defs if they exist
 277             if (!empty($dictionary[$this->object_name]['fields'])) {
 278                 foreach ($dictionary[$this->object_name]['fields'] as $key=>$value_array) {
 279                     $column_fields[] = $key;
 280                 }
 281                 $this->column_fields = $column_fields;
 282             }
 283
 284                 //setup custom fields
 285                 if(!isset($this->custom_fields) &&
 286                         empty($this->disable_custom_fields))
 287                 {
 288                         $this->setupCustomFields($this->module_dir);
 289                 }
 290                 //load up field_arrays from CacheHandler;
 291                 if(empty($this->list_fields))
 292                         $this->list_fields = $this->_loadCachedArray($this->module_dir, $this->object_name, 'list_fields');
 293                 if(empty($this->column_fields))
 294                         $this->column_fields = $this->_loadCachedArray($this->module_dir, $this->object_name, 'column_fields');
 295                 if(empty($this->required_fields))
 296                         $this->required_fields = $this->_loadCachedArray($this->module_dir, $this->object_name, 'required_fields');
 297
 298                 if(isset($GLOBALS['dictionary'][$this->object_name]) && !$this->disable_vardefs)
 299                 {
 300                         $this->field_name_map = $dictionary[$this->object_name]['fields'];
 301                         $this->field_defs =     $dictionary[$this->object_name]['fields'];
 302
 303                         if(!empty($dictionary[$this->object_name]['optimistic_locking']))
 304                         {
 305                                 $this->optimistic_lock=true;
 306                         }
 307                 }
 308
 309                 $loaded_defs[$this->object_name]['column_fields'] =& $this->column_fields;
 310                 $loaded_defs[$this->object_name]['list_fields'] =& $this->list_fields;
 311                 $loaded_defs[$this->object_name]['required_fields'] =& $this->required_fields;
 312                 $loaded_defs[$this->object_name]['field_name_map'] =& $this->field_name_map;
 313                 $loaded_defs[$this->object_name]['field_defs'] =& $this->field_defs;
 314         }
 315         else
 316         {
 317                 $this->column_fields =& $loaded_defs[$this->object_name]['column_fields'] ;
 318                 $this->list_fields =& $loaded_defs[$this->object_name]['list_fields'];
 319                 $this->required_fields =& $loaded_defs[$this->object_name]['required_fields'];
 320                 $this->field_name_map =& $loaded_defs[$this->object_name]['field_name_map'];
 321                 $this->field_defs =& $loaded_defs[$this->object_name]['field_defs'];
 322                 $this->added_custom_field_defs = true;
 323
 324                 if(!isset($this->custom_fields))
 325                 {
 326                         $this->setupCustomFields($this->module_dir, false);
 327                 }
 328                 if(!empty($dictionary[$this->object_name]['optimistic_locking']))
 329                 {
 330                         $this->optimistic_lock=true;
 331                 }
 332         }
 333
 334                 if($this->bean_implements('ACL') && !empty($GLOBALS['current_user'])){
 335                 $this->acl_fields = (isset($dictionary[$this->object_name]['acl_fields']) && $dictionary[$this->object_name]['acl_fields'] === false)?false:true;
 336         }
 337         $this->populateDefaultValues();
 338     }
 339
 340
 341     /**
 342      * Returns the object name. If object_name is not set, table_name is returned.
 343      *
 344      * All implementing classes must set a value for the object_name variable.
 345      *
 346      * @param array $arr row of data fetched from the database.
 347      * @return  nothing
 348      *
 349      */
 350     function getObjectName()
 351     {
 352         if ($this->object_name)
 353                 return $this->object_name;
 354
 355         // This is a quick way out. The generated metadata files have the table name
 356         // as the key. The correct way to do this is to override this function
 357         // in bean and return the object name. That requires changing all the beans
 358         // as well as put the object name in the generator.
 359         return $this->table_name;
 360     }
 361
 362     /**
 363      * Returns a list of fields with their definitions that have the audited property set to true.
 364      * Before calling this function, check whether audit has been enabled for the table/module or not.
 365      * You would set the audit flag in the implemting module's vardef file.
 366      *
 367      * @return an array of
 368      * @see is_AuditEnabled
 369      *
 370      * Internal function, do not override.
 371      */
 372     function getAuditEnabledFieldDefinitions()
 373     {
 374         $aclcheck = $this->bean_implements('ACL');
 375         $is_owner = $this->isOwner($GLOBALS['current_user']->id);
 376         if (!isset($this->audit_enabled_fields))
 377         {
 378
 379                 $this->audit_enabled_fields=array();
 380                 foreach ($this->field_defs as $field => $properties)
 381                 {
 382
 383                         if (
 384                         (
 385                         !empty($properties['Audited']) || !empty($properties['audited']))
 386                                 )
 387                         {
 388
 389                                 $this->audit_enabled_fields[$field]=$properties;
 390                         }
 391                 }
 392
 393         }
 394         return $this->audit_enabled_fields;
 395     }
 396
 397     /**
 398      * Return true if auditing is enabled for this object
 399      * You would set the audit flag in the implemting module's vardef file.
 400      *
 401      * @return boolean
 402      *
 403      * Internal function, do not override.
 404      */
 405     function is_AuditEnabled()
 406     {
 407         global $dictionary;
 408         if (isset($dictionary[$this->getObjectName()]['audited']))
 409         {
 410                 return $dictionary[$this->getObjectName()]['audited'];
 411         }
 412         else
 413         {
 414                 return false;
 415         }
 416     }
 417
 418
 419
 420     /**
 421      * Returns the name of the audit table.
 422      * Audit table's name is based on implementing class' table name.
 423      *
 424      * @return String Audit table name.
 425      *
 426      * Internal function, do not override.
 427      */
 428     function get_audit_table_name()
 429     {
 430         return $this->getTableName().'_audit';
 431     }
 432
 433     /**
 434      * If auditing is enabled, create the audit table.
 435      *
 436      * Function is used by the install scripts and a repair utility in the admin panel.
 437      *
 438      * Internal function, do not override.
 439      */
 440     function create_audit_table()
 441     {
 442         global $dictionary;
 443         $table_name=$this->get_audit_table_name();
 444
 445         require('metadata/audit_templateMetaData.php');
 446
 447         $fieldDefs = $dictionary['audit']['fields'];
 448         $indices = $dictionary['audit']['indices'];
 449         // '0' stands for the first index for all the audit tables
 450         $indices[0]['name'] = 'idx_' . strtolower($this->getTableName()) . '_' . $indices[0]['name'];
 451         $indices[1]['name'] = 'idx_' . strtolower($this->getTableName()) . '_' . $indices[1]['name'];
 452
 453         $sql=$this->dbManager->helper->createTableSQLParams($table_name, $fieldDefs, $indices);
 454
 455         $msg = "Error creating table: ".$table_name. ":";
 456         $this->dbManager->query($sql,true,$msg);
 457     }
 458
 459     /**
 460      * Returns the implementing class' table name.
 461      *
 462      * All implementing classes set a value for the table_name variable. This value is returned as the
 463      * table name. If not set, table name is extracted from the implementing module's vardef.
 464      *
 465      * @return String Table name.
 466      *
 467      * Internal function, do not override.
 468      */
 469     function getTableName()
 470     {
 471         global $dictionary;
 472         if(isset($this->table_name))
 473         {
 474                 return $this->table_name;
 475         }
 476         return $dictionary[$this->getObjectName()]['table'];
 477     }
 478
 479     /**
 480      * Returns field definitions for the implementing module.
 481      *
 482      * The definitions were loaded in the constructor.
 483      *
 484      * @return Array Field definitions.
 485      *
 486      * Internal function, do not override.
 487      */
 488     function getFieldDefinitions()
 489     {
 490         return $this->field_defs;
 491     }
 492
 493     /**
 494      * Returns index definitions for the implementing module.
 495      *
 496      * The definitions were loaded in the constructor.
 497      *
 498      * @return Array Index definitions.
 499      *
 500      * Internal function, do not override.
 501      */
 502     function getIndices()
 503     {
 504         global $dictionary;
 505         if(isset($dictionary[$this->getObjectName()]['indices']))
 506         {
 507                 return $dictionary[$this->getObjectName()]['indices'];
 508         }
 509         return array();
 510     }
 511
 512     /**
 513      * Returns field definition for the requested field name.
 514      *
 515      * The definitions were loaded in the constructor.
 516      *
 517      * @param string field name,
 518      * @return Array Field properties or boolean false if the field doesn't exist
 519      *
 520      * Internal function, do not override.
 521      */
 522     function getFieldDefinition($name)
 523     {
 524         if ( !isset($this->field_defs[$name]) )
 525             return false;
 526
 527         return $this->field_defs[$name];
 528     }
 529
 530     /**
 531      * Returnss  definition for the id field name.
 532      *
 533      * The definitions were loaded in the constructor.
 534      *
 535      * @return Array Field properties.
 536      *
 537      * Internal function, do not override.
 538      */
 539     function getPrimaryFieldDefinition()
 540     {
 541         $def = $this->getFieldDefinition("id");
 542         if (!$def)
 543                 $def = $this->getFieldDefinition(0);
 544         return $def;
 545     }
 546     /**
 547      * Returns the value for the requested field.
 548      *
 549      * When a row of data is fetched using the bean, all fields are created as variables in the context
 550      * of the bean and then fetched values are set in these variables.
 551      *
 552      * @param string field name,
 553      * @return varies Field value.
 554      *
 555      * Internal function, do not override.
 556      */
 557     function getFieldValue($name)
 558     {
 559         if (!isset($this->$name)){
 560                 return FALSE;
 561         }
 562                 if($this->$name === TRUE){
 563                         return 1;
 564                 }
 565                 if($this->$name === FALSE){
 566                         return 0;
 567                 }
 568         return $this->$name;
 569     }
 570
 571     /**
 572      * Basically undoes the effects of SugarBean::populateDefaultValues(); this method is best called right after object
 573      * initialization.
 574      */
 575     public function unPopulateDefaultValues()
 576     {
 577         if ( !is_array($this->field_defs) )
 578             return;
 579
 580         foreach ($this->field_defs as $field => $value) {
 581             if( !empty($this->$field)
 582                   && ((isset($value['default']) && $this->$field == $value['default']) || (!empty($value['display_default']) && $this->$field == $value['display_default']))
 583                     ) {
 584                 $this->$field = null;
 585             }
 586         }
 587     }
 588
 589
 590     function populateDefaultValues($force=false){
 591         if ( !is_array($this->field_defs) )
 592             return;
 593         foreach($this->field_defs as $field=>$value){
 594                 if((isset($value['default']) || !empty($value['display_default'])) && ($force || empty($this->$field))){
 595                     $type = $value['type'];
 596
 597                         switch($type){
 598                                 case 'date':
 599                                         if(!empty($value['display_default'])){
 600                                                         global $timedate;
 601                                                         require_once('modules/DynamicFields/templates/Fields/TemplateDate.php');
 602                                                         $td = new TemplateDate();
 603                             $timeValue = ($value['display_default'] == 'first of next month') ? $timeValue = strtotime( "+1 month" , strtotime( date("F")."1") ) : strtotime($value['display_default']) ;
 604                             $this->$field = $timedate->to_display_date(date($GLOBALS['timedate']->dbDayFormat,$timeValue), false);
 605                                                         break;
 606                                         }
 607                                 case 'datetimecombo':
 608                                         if(!empty($value['display_default'])){
 609                                                         global $timedate;
 610                             $dtAry = explode('&', $value['display_default'] , 2);
 611                                                 if(!empty($dtAry[0]) ){
 612                                                         $dateValue = ($dtAry[0] == 'first of next month') ? $timeValue = strtotime( "+1 month" , strtotime( date("F")."1") ) : strtotime($dtAry[0]) ;
 613                                                         $dateValue = date($GLOBALS['timedate']->dbDayFormat, $dateValue);
 614                                                 }else{
 615                                                         $dateValue='';
 616                                                 }
 617                                                 if(!empty($dtAry[1])){
 618                                                         $timeValue = date($GLOBALS['timedate']->dbTimeFormat, strtotime($dtAry[1]));
 619                                                 }else{
 620                                                         $timeValue = '';
 621                                                 }
 622                             $this->$field = $timedate->to_display_date_time($dateValue.' '.$timeValue , true , false);
 623                                                         break;
 624                                         }
 625                     case 'multienum':
 626                         if(empty($value['default']) && !empty($value['display_default']))
 627                             $this->$field = $value['display_default'];
 628                         else
 629                             $this->$field = $value['default'];
 630                         break;
 631                                         default:
 632                         if ( isset($value['default']) && $value['default'] !== '' ) {
 633                             $this->$field = htmlentities($value['default'], ENT_QUOTES, 'UTF-8');
 634                         } else {
 635                             $this->$field = '';
 636                         }
 637                         } //switch
 638                 }
 639         } //foreach
 640     }
 641
 642
 643     /**
 644      * Removes relationship metadata cache.
 645      *
 646      * Every module that has relationships defined with other modules, has this meta data cached.  The cache is
 647      * stores in 2 locations: relationships table and file system. This method clears the cache from both locations.
 648      *
 649      * @param string $key  module whose meta cache is to be cleared.
 650      * @param string $db database handle.
 651      * @param string $tablename table name
 652      * @param string $dictionary vardef for the module
 653      * @param string $module_dir name of subdirectory where module is installed.
 654      *
 655      * @return Nothing
 656      * @static
 657      *
 658      * Internal function, do not override.
 659      */
 660     function removeRelationshipMeta($key,$db,$tablename,$dictionary,$module_dir)
 661     {
 662         //load the module dictionary if not supplied.
 663         if ((!isset($dictionary) or empty($dictionary)) && !empty($module_dir))
 664         {
 665                 $filename='modules/'. $module_dir . '/vardefs.php';
 666                 if(file_exists($filename))
 667                 {
 668                         include($filename);
 669                 }
 670         }
 671         if (!is_array($dictionary) or !array_key_exists($key, $dictionary))
 672         {
 673                 $GLOBALS['log']->fatal("removeRelationshipMeta: Metadata for table ".$tablename. " does not exist");
 674                 display_notice("meta data absent for table ".$tablename." keyed to $key ");
 675         }
 676         else
 677         {
 678                 if (isset($dictionary[$key]['relationships']))
 679                 {
 680                         $RelationshipDefs = $dictionary[$key]['relationships'];
 681                         foreach ($RelationshipDefs as $rel_name)
 682                         {
 683                                 Relationship::delete($rel_name,$db);
 684                         }
 685                 }
 686         }
 687     }
 688
 689
 690         /**
 691      * This method has been deprecated.
 692      *
 693          * @see removeRelationshipMeta()
 694      * @deprecated 4.5.1 - Nov 14, 2006
 695      * @static
 696          */
 697         function remove_relationship_meta($key,$db,$log,$tablename,$dictionary,$module_dir)
 698         {
 699                 SugarBean::removeRelationshipMeta($key,$db,$tablename,$dictionary,$module_dir);
 700         }
 701
 702
 703     /**
 704      * Populates the relationship meta for a module.
 705      *
 706      * It is called during setup/install. It is used statically to create relationship meta data for many-to-many tables.
 707      *
 708      *  @param string $key name of the object.
 709      *  @param object $db database handle.
 710      *  @param string $tablename table, meta data is being populated for.
 711      *  @param array dictionary vardef dictionary for the object.     *
 712      *  @param string module_dir name of subdirectory where module is installed.
 713      *  @param boolean $iscustom Optional,set to true if module is installed in a custom directory. Default value is false.
 714      *  @static
 715      *
 716      *  Internal function, do not override.
 717      */
 718     function createRelationshipMeta($key,$db,$tablename,$dictionary,$module_dir,$iscustom=false)
 719     {
 720         //load the module dictionary if not supplied.
 721         if (empty($dictionary) && !empty($module_dir))
 722         {
 723                         if($iscustom)
 724                         {
 725                                 $filename='custom/modules/' . $module_dir . '/Ext/Vardefs/vardefs.ext.php';
 726                         }
 727                         else
 728                         {
 729                                 if ($key == 'User')
 730                                 {
 731                                         // a very special case for the Employees module
 732                                         // this must be done because the Employees/vardefs.php does an include_once on
 733                                         // Users/vardefs.php
 734                                         $filename='modules/Users/vardefs.php';
 735                                 }
 736                                 else
 737                                 {
 738                                         $filename='modules/'. $module_dir . '/vardefs.php';
 739                                 }
 740                         }
 741
 742                 if(file_exists($filename))
 743                 {
 744                         include($filename);
 745                         // cn: bug 7679 - dictionary entries defined as $GLOBALS['name'] not found
 746                         if(empty($dictionary) || !empty($GLOBALS['dictionary'][$key]))
 747                         {
 748                                 $dictionary = $GLOBALS['dictionary'];
 749                         }
 750                 }
 751                 else
 752                 {
 753                         $GLOBALS['log']->debug("createRelationshipMeta: no metadata file found" . $filename);
 754                         return;
 755                 }
 756         }
 757
 758         if (!is_array($dictionary) or !array_key_exists($key, $dictionary))
 759         {
 760                 $GLOBALS['log']->fatal("createRelationshipMeta: Metadata for table ".$tablename. " does not exist");
 761                 display_notice("meta data absent for table ".$tablename." keyed to $key ");
 762         }
 763         else
 764         {
 765                 if (isset($dictionary[$key]['relationships']))
 766                 {
 767
 768                         $RelationshipDefs = $dictionary[$key]['relationships'];
 769
 770                         $delimiter=',';
 771                         global $beanList;
 772                         $beanList_ucase=array_change_key_case  ( $beanList ,CASE_UPPER);
 773                         foreach ($RelationshipDefs as $rel_name=>$rel_def)
 774                         {
 775                                 if (isset($rel_def['lhs_module']) and !isset($beanList_ucase[strtoupper($rel_def['lhs_module'])])) {
 776                                         $GLOBALS['log']->debug('skipping orphaned relationship record ' . $rel_name . ' lhs module is missing ' . $rel_def['lhs_module']);
 777                                                 continue;
 778                                 }
 779                                 if (isset($rel_def['rhs_module']) and !isset($beanList_ucase[strtoupper($rel_def['rhs_module'])])) {
 780                                         $GLOBALS['log']->debug('skipping orphaned relationship record ' . $rel_name . ' rhs module is missing ' . $rel_def['rhs_module']);
 781                                                 continue;
 782                                 }
 783
 784
 785                                 //check whether relationship exists or not first.
 786                                 if (Relationship::exists($rel_name,$db))
 787                                 {
 788                                         $GLOBALS['log']->debug('Skipping, reltionship already exists '.$rel_name);
 789                                 }
 790                                 else
 791                                 {
 792                                         //      add Id to the insert statement.
 793                                         $column_list='id';
 794                                         $value_list="'".create_guid()."'";
 795
 796                                         //add relationship name to the insert statement.
 797                                         $column_list .= $delimiter.'relationship_name';
 798                                         $value_list .= $delimiter."'".$rel_name."'";
 799
 800                                         //todo check whether $rel_def is an array or not.
 801                                         //for now make that assumption.
 802                                         //todo specify defaults if meta not defined.
 803                                         foreach ($rel_def as $def_key=>$value)
 804                                         {
 805                                                 $column_list.= $delimiter.$def_key;
 806                                                 $value_list.= $delimiter."'".$value."'";
 807                                         }
 808
 809                                         //create the record. todo add error check.
 810                                         $insert_string = "INSERT into relationships (" .$column_list. ") values (".$value_list.")";
 811                                         $db->query($insert_string, true);
 812                                 }
 813                         }
 814                 }
 815                 else
 816                 {
 817                         //todo
 818                         //log informational message stating no relationships meta was set for this bean.
 819                 }
 820         }
 821     }
 822
 823         /**
 824      * This method has been deprecated.
 825          * @see createRelationshipMeta()
 826      * @deprecated 4.5.1 - Nov 14, 2006
 827      * @static
 828          */
 829         function create_relationship_meta($key,&$db,&$log,$tablename,$dictionary,$module_dir)
 830         {
 831                 SugarBean::createRelationshipMeta($key,$db,$tablename,$dictionary,$module_dir);
 832         }
 833
 834
 835     /**
 836      * Loads the request relationship. This method should be called before performing any operations on the related data.
 837      *
 838      * This method searches the vardef array for the requested attribute's definition. If the attribute is of the type
 839      * link then it creates a similary named variable and loads the relationship definition.
 840      *
 841      * @param string $rel_name  relationship/attribute name.
 842      * @return nothing.
 843      */
 844     function load_relationship($rel_name)
 845     {
 846         $GLOBALS['log']->debug("SugarBean.load_relationships, Loading relationship (".$rel_name.").");
 847
 848         if (empty($rel_name))
 849         {
 850                 $GLOBALS['log']->error("SugarBean.load_relationships, Null relationship name passed.");
 851                 return false;
 852         }
 853         $fieldDefs = $this->getFieldDefinitions();
 854
 855         //find all definitions of type link.
 856         if (!empty($fieldDefs))
 857         {
 858                 //if rel_name is provided, search the fieldef array keys by name.
 859                 if (array_key_exists($rel_name, $fieldDefs))
 860                 {
 861                         if (array_search('link',$fieldDefs[$rel_name]) === 'type')
 862                         {
 863                                 //initialize a variable of type Link
 864                                 require_once('data/Link.php');
 865                                         $class = load_link_class($fieldDefs[$rel_name]);
 866
 867                                         $this->$rel_name=new $class($fieldDefs[$rel_name]['relationship'], $this, $fieldDefs[$rel_name]);
 868
 869                                 if (empty($this->$rel_name->_relationship->id)) {
 870                                         unset($this->$rel_name);
 871                                         return false;
 872                                 }
 873                                 return true;
 874                         }
 875                 }
 876                 else
 877                 {
 878                         $GLOBALS['log']->debug("SugarBean.load_relationships, Error Loading relationship (".$rel_name.").");
 879                         return false;
 880                 }
 881         }
 882
 883         return false;
 884     }
 885
 886     /**
 887      * Loads all attributes of type link.
 888      *
 889      * Method searches the implmenting module's vardef file for attributes of type link, and for each attribute
 890      * create a similary named variable and load the relationship definition.
 891      *
 892      * @return Nothing
 893      *
 894      * Internal function, do not override.
 895      */
 896     function load_relationships()
 897     {
 898
 899         $GLOBALS['log']->debug("SugarBean.load_relationships, Loading all relationships of type link.");
 900
 901         $linked_fields=$this->get_linked_fields();
 902         require_once("data/Link.php");
 903         foreach($linked_fields as $name=>$properties)
 904         {
 905                 $class = load_link_class($properties);
 906
 907                 $this->$name=new $class($properties['relationship'], $this, $properties);
 908         }
 909     }
 910
 911     /**
 912      * Returns an array of beans of related data.
 913      *
 914      * For instance, if an account is related to 10 contacts , this function will return an array of contacts beans (10)
 915      * with each bean representing a contact record.
 916      * Method will load the relationship if not done so already.
 917      *
 918      * @param string $field_name relationship to be loaded.
 919      * @param string $bean name  class name of the related bean.
 920      * @param array $sort_array optional, unused
 921      * @param int $begin_index Optional, default 0, unused.
 922      * @param int $end_index Optional, default -1
 923      * @param int $deleted Optional, Default 0, 0  adds deleted=0 filter, 1  adds deleted=1 filter.
 924      * @param string $optional_where, Optional, default empty.
 925      *
 926      * Internal function, do not override.
 927      */
 928     function get_linked_beans($field_name,$bean_name, $sort_array = array(), $begin_index = 0, $end_index = -1,
 929                               $deleted=0, $optional_where="")
 930     {
 931
 932         //if bean_name is Case then use aCase
 933         if($bean_name=="Case")
 934                 $bean_name = "aCase";
 935
 936         //add a references to bean_name if it doe not exist aleady.
 937         if (!(class_exists($bean_name)))
 938         {
 939
 940                 if (isset($GLOBALS['beanList']) && isset($GLOBALS['beanFiles']))
 941                 {
 942                         global $beanFiles;
 943                 }
 944                 else
 945                 {
 946
 947                 }
 948                 $bean_file=$beanFiles[$bean_name];
 949                 include_once($bean_file);
 950         }
 951
 952         $this->load_relationship($field_name);
 953
 954         return $this->$field_name->getBeans(new $bean_name(), $sort_array, $begin_index, $end_index, $deleted, $optional_where);
 955     }
 956
 957     /**
 958      * Returns an array of fields that are of type link.
 959      *
 960      * @return array List of fields.
 961      *
 962      * Internal function, do not override.
 963      */
 964     function get_linked_fields()
 965     {
 966
 967         $linked_fields=array();
 968
 969  //     require_once('data/Link.php');
 970
 971         $fieldDefs = $this->getFieldDefinitions();
 972
 973         //find all definitions of type link.
 974         if (!empty($fieldDefs))
 975         {
 976                 foreach ($fieldDefs as $name=>$properties)
 977                 {
 978                         if (array_search('link',$properties) === 'type')
 979                         {
 980                                 $linked_fields[$name]=$properties;
 981                         }
 982                 }
 983         }
 984
 985         return $linked_fields;
 986     }
 987
 988     /**
 989      * Returns an array of fields that are able to be Imported into
 990      * i.e. 'importable' not set to 'false'
 991      *
 992      * @return array List of fields.
 993      *
 994      * Internal function, do not override.
 995      */
 996     function get_importable_fields()
 997     {
 998         $importableFields = array();
 999
1000         $fieldDefs= $this->getFieldDefinitions();
1001
1002         if (!empty($fieldDefs)) {
1003             foreach ($fieldDefs as $key=>$value_array) {
1004                 if ( (isset($value_array['importable'])
1005                         && (is_string($value_array['importable']) && $value_array['importable'] == 'false'
1006                             || is_bool($value_array['importable']) && $value_array['importable'] == false))
1007                     || (isset($value_array['type']) && $value_array['type'] == 'link')
1008                     || (isset($value_array['auto_increment'])
1009                         && ($value_array['type'] == true || $value_array['type'] == 'true')) ) {
1010                     // do not allow import.
1011                 }
1012                 else {
1013                     $importableFields[$key]=$value_array;
1014                 }
1015             }
1016         }
1017
1018         return $importableFields;
1019     }
1020
1021     /**
1022      * Returns an array of fields that are of type relate.
1023      *
1024      * @return array List of fields.
1025      *
1026      * Internal function, do not override.
1027      */
1028     function get_related_fields()
1029     {
1030
1031         $related_fields=array();
1032
1033 //      require_once('data/Link.php');
1034
1035         $fieldDefs = $this->getFieldDefinitions();
1036
1037         //find all definitions of type link.
1038         if (!empty($fieldDefs))
1039         {
1040                 foreach ($fieldDefs as $name=>$properties)
1041                 {
1042                         if (array_search('relate',$properties) === 'type')
1043                         {
1044                                 $related_fields[$name]=$properties;
1045                         }
1046                 }
1047         }
1048
1049         return $related_fields;
1050     }
1051
1052     /**
1053      * Returns an array of fields that are required for import
1054      *
1055      * @return array
1056      */
1057     function get_import_required_fields()
1058     {
1059         $importable_fields = $this->get_importable_fields();
1060         $required_fields   = array();
1061
1062         foreach ( $importable_fields as $name => $properties )
1063             if ( isset($properties['importable']) && $properties['importable'] == 'required' )
1064                 $required_fields[$name] = $properties;
1065
1066         return $required_fields;
1067     }
1068
1069     /**
1070      * Iterates through all the relationships and deletes all records for reach relationship.
1071      *
1072      * @param string $id Primary key value of the parent reocrd
1073      */
1074     function delete_linked($id)
1075     {
1076         $linked_fields=$this->get_linked_fields();
1077
1078         foreach ($linked_fields as $name => $value)
1079         {
1080                 if ($this->load_relationship($name))
1081                 {
1082                         $GLOBALS['log']->debug('relationship loaded');
1083                         $this->$name->delete($id);
1084                 }
1085                 else
1086                 {
1087                         $GLOBALS['log']->error('error loading relationship');
1088                 }
1089         }
1090     }
1091
1092     /**
1093      * Creates tables for the module implementing the class.
1094      * If you override this function make sure that your code can handles table creation.
1095      *
1096      */
1097     function create_tables()
1098     {
1099         global $dictionary;
1100
1101         $key = $this->getObjectName();
1102         if (!array_key_exists($key, $dictionary))
1103         {
1104                 $GLOBALS['log']->fatal("create_tables: Metadata for table ".$this->table_name. " does not exist");
1105                 display_notice("meta data absent for table ".$this->table_name." keyed to $key ");
1106         }
1107         else
1108         {
1109                 if(!$this->db->tableExists($this->table_name))
1110                 {
1111                         $this->dbManager->createTable($this);
1112                             if($this->bean_implements('ACL')){
1113                         if(!empty($this->acltype)){
1114                                 ACLAction::addActions($this->module_dir, $this->acltype);
1115                         }else{
1116                                 ACLAction::addActions($this->module_dir);
1117                         }
1118                     }
1119                 }
1120                 else
1121                 {
1122                         echo "Table already exists : $this->table_name<br>";
1123                 }
1124                 if($this->is_AuditEnabled()){
1125                                 if (!$this->db->tableExists($this->get_audit_table_name())) {
1126                                                 $this->create_audit_table();
1127                                         }
1128                 }
1129
1130         }
1131     }
1132
1133     /**
1134      * Delete the primary table for the module implementing the class.
1135      * If custom fields were added to this table/module, the custom table will be removed too, along with the cache
1136      * entries that define the custom fields.
1137      *
1138      */
1139     function drop_tables()
1140     {
1141         global $dictionary;
1142         $key = $this->getObjectName();
1143         if (!array_key_exists($key, $dictionary))
1144         {
1145                 $GLOBALS['log']->fatal("drop_tables: Metadata for table ".$this->table_name. " does not exist");
1146                 echo "meta data absent for table ".$this->table_name."<br>\n";
1147         } else {
1148                 if(empty($this->table_name))return;
1149                 if ($this->db->tableExists($this->table_name))
1150
1151                         $this->dbManager->dropTable($this);
1152                 if ($this->db->tableExists($this->table_name. '_cstm'))
1153                 {
1154                         $this->dbManager->dropTableName($this->table_name. '_cstm');
1155                         DynamicField::deleteCache();
1156                 }
1157                 if ($this->db->tableExists($this->get_audit_table_name())) {
1158                                 $this->dbManager->dropTableName($this->get_audit_table_name());
1159                         }
1160
1161
1162         }
1163     }
1164
1165
1166     /**
1167      * Loads the definition of custom fields defined for the module.
1168      * Local file system cache is created as needed.
1169      *
1170      * @param string $module_name setting up custom fields for this module.
1171      * @param boolean $clean_load Optional, default true, rebuilds the cache if set to true.
1172      */
1173     function setupCustomFields($module_name, $clean_load=true)
1174     {
1175         $this->custom_fields = new DynamicField($module_name);
1176         $this->custom_fields->setup($this);
1177
1178     }
1179
1180         /**
1181          * Cleans char, varchar, text, etc. fields of XSS type materials
1182          */
1183         function cleanBean() {
1184                 foreach($this->field_defs as $key => $def) {
1185
1186                         if (isset($def['type'])) {
1187                             $type=$def['type'];
1188                         }
1189                         if(isset($def['dbType']))
1190                                 $type .= $def['dbType'];
1191
1192                         if((strpos($type, 'char') !== false ||
1193                                 strpos($type, 'text') !== false ||
1194                                 $type == 'enum') &&
1195                 !empty($this->$key)
1196                         ) {
1197                                 $str = from_html($this->$key);
1198                                 // Julian's XSS cleaner
1199                                 $potentials = clean_xss($str, false);
1200
1201                                 if(is_array($potentials) && !empty($potentials)) {
1202                                         foreach($potentials as $bad) {
1203                         $str = str_replace($bad, "", $str);
1204                                         }
1205                     $this->$key = to_html($str);
1206                                 }
1207                         }
1208                 }
1209         }
1210
1211         /**
1212         * Implements a generic insert and update logic for any SugarBean
1213         * This method only works for subclasses that implement the same variable names.
1214         * This method uses the presence of an id field that is not null to signify and update.
1215         * The id field should not be set otherwise.
1216     *
1217     * @param boolean $check_notify Optional, default false, if set to true assignee of the record is notified via email.
1218         * @todo Add support for field type validation and encoding of parameters.
1219         */
1220         function save($check_notify = FALSE)
1221         {
1222                 // cn: SECURITY - strip XSS potential vectors
1223                 $this->cleanBean();
1224         // This is used so custom/3rd-party code can be upgraded with fewer issues, this will be removed in a future release
1225         $this->fixUpFormatting();
1226                 global $timedate;
1227                 global $current_user, $action;
1228
1229                 $isUpdate = true;
1230                 if(empty($this->id))
1231                 {
1232                         $isUpdate = false;
1233                 }
1234
1235                 if ( $this->new_with_id == true )
1236                 {
1237                         $isUpdate = false;
1238                 }
1239                 if(empty($this->date_modified) || $this->update_date_modified)
1240                 {
1241                         $this->date_modified = gmdate($GLOBALS['timedate']->get_db_date_time_format());
1242                 }
1243
1244                 $this->_checkOptimisticLocking($action, $isUpdate);
1245
1246         if(!empty($this->modified_by_name)) $this->old_modified_by_name = $this->modified_by_name;
1247                 if($this->update_modified_by)
1248                 {
1249                         $this->modified_user_id = 1;
1250
1251                         if (!empty($current_user))
1252                         {
1253                                 $this->modified_user_id = $current_user->id;
1254                 $this->modified_by_name = $current_user->user_name;
1255                         }
1256                 }
1257                 if ($this->deleted != 1)
1258                         $this->deleted = 0;
1259                 if($isUpdate)
1260                 {
1261                         $query = "Update ";
1262                 }
1263                 else
1264                 {
1265                         if (empty($this->date_entered))
1266                         {
1267                                 $this->date_entered = $this->date_modified;
1268                         }
1269                         if($this->set_created_by == true)
1270                         {
1271                                 // created by should always be this user
1272                                 $this->created_by = (isset($current_user)) ? $current_user->id : "";
1273                         }
1274                         if( $this->new_with_id == false)
1275                         {
1276                                 $this->id = create_guid();
1277                         }
1278                         $query = "INSERT into ";
1279                 }
1280                 if($isUpdate && !$this->update_date_entered)
1281                 {
1282                         unset($this->date_entered);
1283                 }
1284                 // call the custom business logic
1285                 $custom_logic_arguments['check_notify'] = $check_notify;
1286
1287                 $this->call_custom_logic("before_save", $custom_logic_arguments);
1288                 unset($custom_logic_arguments);
1289
1290                 if(isset($this->custom_fields))
1291                 {
1292                         $this->custom_fields->bean =& $this;
1293                         $this->custom_fields->save($isUpdate);
1294                 }
1295
1296                 // use the db independent query generator
1297                 $this->preprocess_fields_on_save();
1298
1299                 //construct the SQL to create the audit record if auditing is enabled.
1300                 $dataChanges=array();
1301                 if ($this->is_AuditEnabled())
1302                 {
1303                         if ($isUpdate && !isset($this->fetched_row))
1304                         {
1305                                 $GLOBALS['log']->debug('Auditing: Retrieve was not called, audit record will not be created.');
1306                         }
1307                         else
1308                         {
1309                                 $dataChanges=$this->dbManager->helper->getDataChanges($this);
1310                         }
1311                 }
1312
1313                 $this->_sendNotifications($check_notify);
1314
1315                 if ($this->db->dbType == "oci8")
1316                 {
1317                 }
1318                 if ($this->db->dbType == 'mysql')
1319                 {
1320                         // write out the SQL statement.
1321                         $query .= $this->table_name." set ";
1322
1323                         $firstPass = 0;
1324
1325                         foreach($this->field_defs as $field=>$value)
1326                         {
1327                                 if(!isset($value['source']) || $value['source'] == 'db')
1328                                 {
1329                                         // Do not write out the id field on the update statement.
1330                                         // We are not allowed to change ids.
1331                                         if($isUpdate && ('id' == $field))
1332                                                 continue;
1333                                         //custom fields handle there save seperatley
1334                                         if(isset($this->field_name_map) && !empty($this->field_name_map[$field]['custom_type']))
1335                                                 continue;
1336
1337                                         // Only assign variables that have been set.
1338                                         if(isset($this->$field))
1339                                         {
1340                                                 //bug: 37908 - this is to handle the issue where the bool value is false, but strlen(false) <= so it will
1341                                                 //set the default value. TODO change this code to esend all fields through getFieldValue() like DbHelper->insertSql
1342                                                 if(!empty($value['type']) && $value['type'] == 'bool'){
1343                                                         $this->$field = $this->getFieldValue($field);
1344                                                 }
1345
1346                                                 if(strlen($this->$field) <= 0)
1347                                                 {
1348                                                         if(!$isUpdate && isset($value['default']) && (strlen($value['default']) > 0))
1349                                                         {
1350                                                                 $this->$field = $value['default'];
1351                                                         }
1352                                                         else
1353                                                         {
1354                                                                 $this->$field = null;
1355                                                         }
1356                                                 }
1357                                                 // Try comparing this element with the head element.
1358                                                 if(0 == $firstPass)
1359                                                         $firstPass = 1;
1360                                                 else
1361                                                         $query .= ", ";
1362
1363                                                 if(is_null($this->$field))
1364                                                 {
1365                                                         $query .= $field."=null";
1366                                                 }
1367                                                 else
1368                                                 {
1369                             //added check for ints because sql-server does not like casting varchar with a decimal value
1370                             //into an int.
1371                             if(isset($value['type']) and $value['type']=='int') {
1372                                 $query .= $field."=".$this->db->quote($this->$field);
1373                             } elseif ( isset($value['len']) ) {
1374                                 $query .= $field."='".$this->db->quote($this->db->truncate(from_html($this->$field),$value['len']))."'";
1375                             } else {
1376                                 $query .= $field."='".$this->db->quote($this->$field)."'";
1377                             }
1378                                                 }
1379                                         }
1380                                 }
1381                         }
1382
1383                         if($isUpdate)
1384                         {
1385                                 $query = $query." WHERE ID = '$this->id'";
1386                                 $GLOBALS['log']->info("Update $this->object_name: ".$query);
1387                         }
1388                         else
1389                         {
1390                                 $GLOBALS['log']->info("Insert: ".$query);
1391                         }
1392                         $GLOBALS['log']->info("Save: $query");
1393                         $this->db->query($query, true);
1394                 }
1395                 //process if type is set to mssql
1396                 if ($this->db->dbType == 'mssql')
1397                 {
1398                         if($isUpdate)
1399                         {
1400                                 // build out the SQL UPDATE statement.
1401                                 $query = "UPDATE " . $this->table_name." SET ";
1402                                 $firstPass = 0;
1403                                 foreach($this->field_defs as $field=>$value)
1404                                 {
1405                                         if(!isset($value['source']) || $value['source'] == 'db')
1406                                         {
1407                                                 // Do not write out the id field on the update statement.
1408                                                 // We are not allowed to change ids.
1409                                                 if($isUpdate && ('id' == $field))
1410                                                         continue;
1411
1412                                                 // If the field is an auto_increment field, then we shouldn't be setting it.  This was added
1413                                                 // specially for Bugs and Cases which have a number associated with them.
1414                                                 if ($isUpdate && isset($this->field_name_map[$field]['auto_increment']) &&
1415                                                     $this->field_name_map[$field]['auto_increment'] == true)
1416                                                         continue;
1417
1418                                                 //custom fields handle their save seperatley
1419                                                 if(isset($this->field_name_map) && !empty($this->field_name_map[$field]['custom_type']))
1420                                                         continue;
1421
1422                                                 // Only assign variables that have been set.
1423                                                 if(isset($this->$field))
1424                                                 {
1425                                                         //bug: 37908 - this is to handle the issue where the bool value is false, but strlen(false) <= so it will
1426                                                         //set the default value. TODO change this code to esend all fields through getFieldValue() like DbHelper->insertSql
1427                                                         if(!empty($value['type']) && $value['type'] == 'bool'){
1428                                                                 $this->$field = $this->getFieldValue($field);
1429                                                         }
1430
1431                                                         if(strlen($this->$field) <= 0)
1432                                                         {
1433                                                                 if(!$isUpdate && isset($value['default']) && (strlen($value['default']) > 0))
1434                                                                 {
1435                                                                         $this->$field = $value['default'];
1436                                                                 }
1437                                                                 else
1438                                                                 {
1439                                                                         $this->$field = null;
1440                                                                 }
1441                                                         }
1442                                                         // Try comparing this element with the head element.
1443                                                         if(0 == $firstPass)
1444                                                                 $firstPass = 1;
1445                                                         else
1446                                                                 $query .= ", ";
1447
1448                                                         if(is_null($this->$field))
1449                                                         {
1450                                                                 $query .= $field."=null";
1451                                                         }
1452                                                         elseif ( isset($value['len']) )
1453                            {
1454                                $query .= $field."='".$this->db->quote($this->db->truncate(from_html($this->$field),$value['len']))."'";
1455                            }
1456                            else
1457                                                         {
1458                                                                 $query .= $field."='".$this->db->quote($this->$field)."'";
1459                                                         }
1460                                                 }
1461                                         }
1462                                 }
1463                                 $query = $query." WHERE ID = '$this->id'";
1464                                 $GLOBALS['log']->info("Update $this->object_name: ".$query);
1465                         }
1466                         else
1467                         {
1468                                 $colums = array();
1469                                 $values = array();
1470                                 foreach($this->field_defs as $field=>$value)
1471                                 {
1472                                         if(!isset($value['source']) || $value['source'] == 'db')
1473                                         {
1474                                                 // Do not write out the id field on the update statement.
1475                                                 // We are not allowed to change ids.
1476                                                 //if($isUpdate && ('id' == $field)) continue;
1477                                                 //custom fields handle there save seperatley
1478
1479                                                 if(isset($this->field_name_map) && !empty($this->field_name_map[$field]['custom_module']))
1480                                                 continue;
1481
1482                                                 // Only assign variables that have been set.
1483                                                 if(isset($this->$field))
1484                                                 {
1485                                                         //trim the value in case empty space is passed in.
1486                                                         //this will allow default values set in db to take effect, otherwise
1487                                                         //will insert blanks into db
1488                                                         $trimmed_field = trim($this->$field);
1489                                                         //if this value is empty, do not include the field value in statement
1490                                                         if($trimmed_field =='')
1491                                                         {
1492                                                                 continue;
1493                                                         }
1494                                                         //bug: 37908 - this is to handle the issue where the bool value is false, but strlen(false) <= so it will
1495                                                         //set the default value. TODO change this code to esend all fields through getFieldValue() like DbHelper->insertSql
1496                                                         if(!empty($value['type']) && $value['type'] == 'bool'){
1497                                                                 $this->$field = $this->getFieldValue($field);
1498                                                         }
1499                             //added check for ints because sql-server does not like casting varchar with a decimal value
1500                             //into an int.
1501                             if(isset($value['type']) and $value['type']=='int') {
1502                                 $values[] = $this->db->quote($this->$field);
1503                             } elseif ( isset($value['len']) ) {
1504                                 $values[] = "'".$this->db->quote($this->db->truncate(from_html($this->$field),$value['len']))."'";
1505                             } else {
1506                                 $values[] = "'".$this->db->quote($this->$field)."'";
1507
1508                             }
1509                                                         $columns[] = $field;
1510                                                 }
1511                                         }
1512                                 }
1513                                 // build out the SQL INSERT statement.
1514                                 $query = "INSERT INTO $this->table_name (" .implode("," , $columns). " ) VALUES ( ". implode("," , $values). ')';
1515                                 $GLOBALS['log']->info("Insert: ".$query);
1516                         }
1517
1518                         $GLOBALS['log']->info("Save: $query");
1519                         $this->db->query($query, true);
1520                 }
1521                 if (!empty($dataChanges) && is_array($dataChanges))
1522                 {
1523                         foreach ($dataChanges as $change)
1524                         {
1525                                 $this->dbManager->helper->save_audit_records($this,$change);
1526                         }
1527                 }
1528
1529                 // let subclasses save related field changes
1530                 $this->save_relationship_changes($isUpdate);
1531
1532
1533                 //If we aren't in setup mode and we have a current user and module, then we track
1534                 if(isset($GLOBALS['current_user']) && isset($this->module_dir))
1535                 {
1536                         $this->track_view($current_user->id, $this->module_dir, 'save');
1537                 }
1538
1539                 $this->call_custom_logic('after_save', '');
1540
1541                 return $this->id;
1542         }
1543
1544
1545     /**
1546      * Performs a check if the record has been modified since the specified date
1547      *
1548      * @param date $date Datetime for verification
1549      * @param string $modified_user_id User modified by
1550      */
1551     function has_been_modified_since($date, $modified_user_id)
1552     {
1553         global $current_user;
1554         if (isset($current_user))
1555         {
1556             if ($this->db->dbType == 'mssql')
1557                 $date_modified_string = 'CONVERT(varchar(20), date_modified, 120)';
1558             else
1559                 $date_modified_string = 'date_modified';
1560
1561             $query = "SELECT date_modified FROM $this->table_name WHERE id='$this->id' AND modified_user_id != '$current_user->id' AND (modified_user_id != '$modified_user_id' OR $date_modified_string > " . db_convert("'".$date."'", 'datetime') . ')';
1562             $result = $this->db->query($query);
1563
1564                 if($this->db->fetchByAssoc($result))
1565                 {
1566                         return true;
1567                 }
1568         }
1569         return false;
1570     }
1571
1572         /**
1573          * Determines which users receive a notification
1574          */
1575         function get_notification_recipients() {
1576                 $notify_user = new User();
1577                 $notify_user->retrieve($this->assigned_user_id);
1578                 $this->new_assigned_user_name = $notify_user->full_name;
1579
1580                 $GLOBALS['log']->info("Notifications: recipient is $this->new_assigned_user_name");
1581
1582                 $user_list = array($notify_user);
1583                 return $user_list;
1584                 /*
1585                 //send notifications to followers, but ensure to not query for the assigned_user.
1586                 return SugarFollowing::getFollowers($this, $notify_user);
1587                 */
1588         }
1589
1590         /**
1591         * Handles sending out email notifications when items are first assigned to users
1592         *
1593         * @param string $notify_user user to notify
1594         * @param string $admin the admin user that sends out the notification
1595         */
1596         function send_assignment_notifications($notify_user, $admin)
1597         {
1598                 global $current_user;
1599
1600                 if(($this->object_name == 'Meeting' || $this->object_name == 'Call') || $notify_user->receive_notifications)
1601                 {
1602                         $sendToEmail = $notify_user->emailAddress->getPrimaryAddress($notify_user);
1603             $sendEmail = TRUE;
1604                         if(empty($sendToEmail)) {
1605                                 $GLOBALS['log']->warn("Notifications: no e-mail address set for user {$notify_user->user_name}, cancelling send");
1606                                 $sendEmail = FALSE;
1607                         }
1608
1609                         $notify_mail = $this->create_notification_email($notify_user);
1610                         $notify_mail->setMailerForSystem();
1611
1612                         if(empty($admin->settings['notify_send_from_assigning_user'])) {
1613                             $notify_mail->From = $admin->settings['notify_fromaddress'];
1614                             $notify_mail->FromName = (empty($admin->settings['notify_fromname'])) ? "" : $admin->settings['notify_fromname'];
1615                         } else {
1616                             // Send notifications from the current user's e-mail (ifset)
1617                             $fromAddress = $current_user->emailAddress->getReplyToAddress($current_user);
1618                             $fromAddress = !empty($fromAddress) ? $fromAddress : $admin->settings['notify_fromaddress'];
1619                             $notify_mail->From = $fromAddress;
1620                 //Use the users full name is available otherwise default to system name
1621                             $from_name = !empty($admin->settings['notify_fromname']) ? $admin->settings['notify_fromname'] : "";
1622                 $from_name = !empty($current_user->full_name) ? $current_user->full_name : $from_name;
1623                             $notify_mail->FromName = $from_name;
1624                         }
1625
1626                         if($sendEmail && !$notify_mail->Send()) {
1627                             $GLOBALS['log']->fatal("Notifications: error sending e-mail (method: {$notify_mail->Mailer}), (error: {$notify_mail->ErrorInfo})");
1628                         } else {
1629                             $GLOBALS['log']->fatal("Notifications: e-mail successfully sent");
1630                         }
1631
1632                 }
1633         }
1634
1635         /**
1636         * This function handles create the email notifications email.
1637         * @param string $notify_user the user to send the notification email to
1638         */
1639         function create_notification_email($notify_user) {
1640                 global $sugar_version;
1641                 global $sugar_config;
1642                 global $app_list_strings;
1643                 global $current_user;
1644                 global $locale;
1645         global $beanList;
1646         $OBCharset = $locale->getPrecedentPreference('default_email_charset');
1647
1648
1649                 require_once("include/SugarPHPMailer.php");
1650
1651                 $notify_address = $notify_user->emailAddress->getPrimaryAddress($notify_user);
1652                 $notify_name = $notify_user->full_name;
1653                 $GLOBALS['log']->debug("Notifications: user has e-mail defined");
1654
1655                 $notify_mail = new SugarPHPMailer();
1656                 $notify_mail->AddAddress($notify_address,$locale->translateCharsetMIME(trim($notify_name), 'UTF-8', $OBCharset));
1657
1658                 if(empty($_SESSION['authenticated_user_language'])) {
1659                         $current_language = $sugar_config['default_language'];
1660                 } else {
1661                         $current_language = $_SESSION['authenticated_user_language'];
1662                 }
1663         $xtpl = new XTemplate(get_notify_template_file($current_language));
1664         if($this->module_dir == "Cases") {
1665             $template_name = "Case"; //we should use Case, you can refer to the en_us.notify_template.html.
1666         }
1667         else {
1668             $template_name = $beanList[$this->module_dir]; //bug 20637, in workflow this->object_name = strange chars.
1669         }
1670
1671                 $this->current_notify_user = $notify_user;
1672
1673                 if(in_array('set_notification_body', get_class_methods($this))) {
1674                         $xtpl = $this->set_notification_body($xtpl, $this);
1675                 } else {
1676                         $xtpl->assign("OBJECT", $this->object_name);
1677                         $template_name = "Default";
1678                 }
1679         if(!empty($_SESSION["special_notification"]) && $_SESSION["special_notification"]) {
1680             $template_name = $beanList[$this->module_dir].'Special';
1681         }
1682         if($this->special_notification) {
1683                 $template_name = $beanList[$this->module_dir].'Special';
1684         }
1685                 $xtpl->assign("ASSIGNED_USER", $this->new_assigned_user_name);
1686                 $xtpl->assign("ASSIGNER", $current_user->name);
1687                 $port = '';
1688
1689                 if(isset($_SERVER['SERVER_PORT']) && $_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443) {
1690                         $port = $_SERVER['SERVER_PORT'];
1691                 }
1692
1693                 if (!isset($_SERVER['HTTP_HOST'])) {
1694                         $_SERVER['HTTP_HOST'] = '';
1695                 }
1696
1697                 $httpHost = $_SERVER['HTTP_HOST'];
1698
1699                 if($colon = strpos($httpHost, ':')) {
1700                         $httpHost    = substr($httpHost, 0, $colon);
1701                 }
1702
1703                 $parsedSiteUrl = parse_url($sugar_config['site_url']);
1704                 $host = $parsedSiteUrl['host'];
1705                 if(!isset($parsedSiteUrl['port'])) {
1706                         $parsedSiteUrl['port'] = 80;
1707                 }
1708
1709                 $port           = ($parsedSiteUrl['port'] != 80) ? ":".$parsedSiteUrl['port'] : '';
1710                 $path           = !empty($parsedSiteUrl['path']) ? $parsedSiteUrl['path'] : "";
1711                 $cleanUrl       = "{$parsedSiteUrl['scheme']}://{$host}{$port}{$path}";
1712
1713                 $xtpl->assign("URL", $cleanUrl."/index.php?module={$this->module_dir}&action=DetailView&record={$this->id}");
1714                 $xtpl->assign("SUGAR", "Sugar v{$sugar_version}");
1715                 $xtpl->parse($template_name);
1716                 $xtpl->parse($template_name . "_Subject");
1717
1718                 $notify_mail->Body = from_html(trim($xtpl->text($template_name)));
1719                 $notify_mail->Subject = from_html($xtpl->text($template_name . "_Subject"));
1720
1721                 // cn: bug 8568 encode notify email in User's outbound email encoding
1722                 $notify_mail->prepForOutbound();
1723
1724                 return $notify_mail;
1725         }
1726
1727         /**
1728         * This function is a good location to save changes that have been made to a relationship.
1729         * This should be overriden in subclasses that have something to save.
1730         *
1731         * @param $is_update true if this save is an update.
1732         */
1733 function save_relationship_changes($is_update, $exclude=array())
1734         {
1735                 $new_rel_id = false;
1736                 $new_rel_link = false;
1737                 //this allows us to dynamically relate modules without adding it to the relationship_fields array
1738                 if(!empty($_REQUEST['relate_id']) && !in_array($_REQUEST['relate_to'], $exclude) && $_REQUEST['relate_id'] != $this->id){
1739                         $new_rel_id = $_REQUEST['relate_id'];
1740                         $new_rel_relname = $_REQUEST['relate_to'];
1741             if(!empty($this->in_workflow) && !empty($this->not_use_rel_in_req)) {
1742                 $new_rel_id = $this->new_rel_id;
1743                 $new_rel_relname = $this->new_rel_relname;
1744             }
1745                         $new_rel_link = $new_rel_relname;
1746                         //Try to find the link in this bean based on the relationship
1747                         foreach ( $this->field_defs as $key => $def ) {
1748                                 if (isset($def['type']) && $def['type'] == 'link'
1749                                 && isset($def['relationship']) && $def['relationship'] == $new_rel_relname) {
1750                                         $new_rel_link = $key;
1751                                 }
1752                         }
1753                 }
1754
1755                 // First we handle the preset fields listed in the fixed relationship_fields array hardcoded into the OOB beans
1756                 // TODO: remove this mechanism and replace with mechanism exclusively based on the vardefs
1757                 if (isset($this->relationship_fields) && is_array($this->relationship_fields))
1758                 {
1759                         foreach ($this->relationship_fields as $id=>$rel_name)
1760                         {
1761
1762                                 if(in_array($id, $exclude))continue;
1763
1764                                 if(!empty($this->$id))
1765                                 {
1766                                     $GLOBALS['log']->debug('save_relationship_changes(): From relationship_field array - adding a relationship record: '.$rel_name . ' = ' . $this->$id);
1767                                         //already related the new relationship id so let's set it to false so we don't add it again using the _REQUEST['relate_i'] mechanism in a later block
1768                                         if($this->$id == $new_rel_id){
1769                                                 $new_rel_id = false;
1770                                         }
1771                                         $this->load_relationship($rel_name);
1772                                         $this->$rel_name->add($this->$id);
1773                                         $related = true;
1774                                 }
1775                                 else
1776                                 {
1777                                         //if before value is not empty then attempt to delete relationship
1778                                         if(!empty($this->rel_fields_before_value[$id]))
1779                                         {
1780                                                 $GLOBALS['log']->debug('save_relationship_changes(): From relationship_field array - attempting to remove the relationship record, using relationship attribute'.$rel_name);
1781                                                 $this->load_relationship($rel_name);
1782                                                 $this->$rel_name->delete($this->id,$this->rel_fields_before_value[$id]);
1783                                         }
1784                                 }
1785                         }
1786                 }
1787
1788 /*      Next, we'll attempt to update all of the remaining relate fields in the vardefs that have 'save' set in their field_def
1789         Only the 'save' fields should be saved as some vardef entries today are not for display only purposes and break the application if saved
1790                 If the vardef has entries for field <a> of type relate, where a->id_name = <b> and field <b> of type link
1791         then we receive a value for b from the MVC in the _REQUEST, and it should be set in the bean as $this->$b
1792 */
1793
1794             foreach ( $this->field_defs as $def )
1795             {
1796            if ($def [ 'type' ] == 'relate' && isset ( $def [ 'id_name'] ) && isset ( $def [ 'link'] ) && isset ( $def[ 'save' ]) )
1797                {
1798                    if (  in_array( $def['id_name'], $exclude) || in_array( $def['id_name'], $this->relationship_fields ) )
1799                                continue ; // continue to honor the exclude array and exclude any relationships that will be handled by the relationship_fields mechanism
1800
1801                    if (isset( $this->field_defs[ $def [ 'link' ] ] ))
1802                    {
1803
1804                     $linkfield = $this->field_defs[$def [ 'link' ]] ;
1805
1806                     if ($this->load_relationship ( $def [ 'link' ])){
1807                                         if (!empty($this->rel_fields_before_value[$def [ 'id_name' ]]))
1808                             {
1809                                                         //if before value is not empty then attempt to delete relationship
1810                                 $GLOBALS['log']->debug("save_relationship_changes(): From field_defs - attempting to remove the relationship record: {$def [ 'link' ]} = {$this->rel_fields_before_value[$def [ 'id_name' ]]}");
1811                                 $this->$def ['link' ]->delete($this->id, $this->rel_fields_before_value[$def [ 'id_name' ]] );
1812                             }
1813                             if (!empty($this->$def['id_name']) && is_string($this->$def['id_name']))
1814                             {
1815                                                         $GLOBALS['log']->debug("save_relationship_changes(): From field_defs - attempting to add a relationship record - {$def [ 'link' ]} = {$this->$def [ 'id_name' ]}" );
1816                                 $this->$def ['link' ]->add($this->$def['id_name']);
1817                             }
1818                     } else {
1819                         $GLOBALS['log']->fatal("Failed to load relationship {$def [ 'link' ]} while saving {$this->module_dir}");
1820                     }
1821                     }
1822                }
1823             }
1824
1825                 // Finally, we update a field listed in the _REQUEST['*/relate_id']/_REQUEST['relate_to'] mechanism (if it hasn't already been updated above)
1826                 if(!empty($new_rel_id)){
1827
1828                         if($this->load_relationship($new_rel_link)){
1829                                 $this->$new_rel_link->add($new_rel_id);
1830
1831                         }else{
1832                                 $lower_link = strtolower($new_rel_link);
1833                                 if($this->load_relationship($lower_link)){
1834                                         $this->$lower_link->add($new_rel_id);
1835
1836                                 }else{
1837                                         require_once('data/Link.php');
1838                                         $rel = Relationship::retrieve_by_modules($new_rel_link, $this->module_dir, $GLOBALS['db'], 'many-to-many');
1839
1840                                         if(!empty($rel)){
1841                                                 foreach($this->field_defs as $field=>$def){
1842                                                         if($def['type'] == 'link' && !empty($def['relationship']) && $def['relationship'] == $rel){
1843                                                                 $this->load_relationship($field);
1844                                                                 $this->$field->add($new_rel_id);
1845                                                                 return;
1846
1847                                                         }
1848
1849                                                 }
1850                         //ok so we didn't find it in the field defs let's save it anyway if we have the relationshp
1851
1852                                                 $this->$rel=new Link($rel, $this, array());
1853                                                 $this->$rel->add($new_rel_id);
1854                                         }
1855                                 }
1856
1857                         }
1858
1859                 }
1860
1861         }
1862
1863         /**
1864         * This function retrieves a record of the appropriate type from the DB.
1865         * It fills in all of the fields from the DB into the object it was called on.
1866     *
1867         * @param $id - If ID is specified, it overrides the current value of $this->id.  If not specified the current value of $this->id will be used.
1868         * @return this - The object that it was called apon or null if exactly 1 record was not found.
1869     *
1870         */
1871
1872         function check_date_relationships_load()
1873         {
1874                 global $disable_date_format;
1875                 global $timedate;
1876                 if (empty($timedate))
1877                         $timedate=new TimeDate();
1878
1879                 if(empty($this->field_defs))
1880                 {
1881                         return;
1882                 }
1883                 foreach($this->field_defs as $fieldDef)
1884                 {
1885                         $field = $fieldDef['name'];
1886                         if(!isset($this->processed_dates_times[$field]))
1887                         {
1888                                 $this->processed_dates_times[$field] = '1';
1889                                 if(empty($this->$field)) continue;
1890                                 if($field == 'date_modified' || $field == 'date_entered')
1891                                 {
1892                                         $this->$field = from_db_convert($this->$field, 'datetime');
1893                                         if(empty($disable_date_format)) {
1894                                                 $this->$field = $timedate->to_display_date_time($this->$field);
1895                                         }
1896                                 }
1897                                 elseif(isset($this->field_name_map[$field]['type']))
1898                                 {
1899                                         $type = $this->field_name_map[$field]['type'];
1900
1901                                         if($type == 'relate'  && isset($this->field_name_map[$field]['custom_module']))
1902                                         {
1903                                                 $type = $this->field_name_map[$field]['type'];
1904                                         }
1905
1906                                         if($type == 'date')
1907                                         {
1908                                                 $this->$field = from_db_convert($this->$field, 'date');
1909
1910                                                 if($this->$field == '0000-00-00')
1911                                                 {
1912                                                         $this->$field = '';
1913                                                 } elseif(!empty($this->field_name_map[$field]['rel_field']))
1914                                                 {
1915                                                         $rel_field = $this->field_name_map[$field]['rel_field'];
1916
1917                                                         if(!empty($this->$rel_field))
1918                                                         {
1919                                                                 $this->$rel_field=from_db_convert($this->$rel_field, 'time');
1920                                                                 if(empty($disable_date_format)) {
1921                                                                         $mergetime = $timedate->merge_date_time($this->$field,$this->$rel_field);
1922                                                                         $this->$field = $timedate->to_display_date($mergetime);
1923                                                                         $this->$rel_field = $timedate->to_display_time($mergetime);
1924                                                                 }
1925                                                         }
1926                                                 }
1927                                                 else
1928                                                 {
1929                                                         if(empty($disable_date_format)) {
1930                                                                 $this->$field = $timedate->to_display_date($this->$field, false);
1931                                                         }
1932                                                 }
1933                                         } elseif($type == 'datetime' || $type == 'datetimecombo')
1934                                         {
1935                                                 if($this->$field == '0000-00-00 00:00:00')
1936                                                 {
1937                                                         $this->$field = '';
1938                                                 }
1939                                                 else
1940                                                 {
1941                                                         $this->$field = from_db_convert($this->$field, 'datetime');
1942                                                         if(empty($disable_date_format)) {
1943                                                                 $this->$field = $timedate->to_display_date_time($this->$field, true, true);
1944                                                         }
1945                                                 }
1946                                         } elseif($type == 'time')
1947                                         {
1948                                                 if($this->$field == '00:00:00')
1949                                                 {
1950                                                         $this->$field = '';
1951                                                 } else
1952                                                 {
1953                                                         //$this->$field = from_db_convert($this->$field, 'time');
1954                                                         if(empty($this->field_name_map[$field]['rel_field']) && empty($disable_date_format))
1955                                                         {
1956                                                                 $this->$field = $timedate->to_display_time($this->$field,true, false);
1957                                                         }
1958                                                 }
1959                                         } elseif($type == 'encrypt' && empty($disable_date_format)){
1960                                                 $this->$field = $this->decrypt_after_retrieve($this->$field);
1961                                         }
1962                                 }
1963                         }
1964                 }
1965         }
1966
1967     /**
1968      * This function processes the fields before save.
1969      * Interal function, do not override.
1970      */
1971         function preprocess_fields_on_save()
1972         {
1973         $GLOBALS['log']->deprecated('SugarBean.php: preprocess_fields_on_save() is deprecated');
1974         }
1975
1976         /**
1977          * Removes formatting from values posted from the user interface.
1978      * It only unformats numbers.  Function relies on user/system prefernce for format strings.
1979      *
1980      * Internal Function, do not override.
1981          */
1982         function unformat_all_fields()
1983         {
1984         $GLOBALS['log']->deprecated('SugarBean.php: unformat_all_fields() is deprecated');
1985         }
1986
1987         /**
1988          * This functions adds formatting to all number fields before presenting them to user interface.
1989      *
1990      * Internal function, do not override.
1991          */
1992         function format_all_fields()
1993         {
1994         $GLOBALS['log']->deprecated('SugarBean.php: format_all_fields() is deprecated');
1995         }
1996
1997     function format_field($fieldDef)
1998                 {
1999         $GLOBALS['log']->deprecated('SugarBean.php: format_field() is deprecated');
2000                 }
2001
2002     /**
2003      * Function corrects any bad formatting done by 3rd party/custom code
2004      *
2005      * This function will be removed in a future release, it is only here to assist upgrading existing code that expects formatted data in the bean
2006      */
2007     function fixUpFormatting()
2008     {
2009         global $timedate;
2010                 static $boolean_false_values = array('off', 'false', '0', 'no');
2011
2012
2013         foreach($this->field_defs as $field=>$def)
2014                         {
2015             if ( !isset($this->$field) ) {
2016                 continue;
2017                                 }
2018             if ( (isset($def['source'])&&$def['source']=='non-db') || $field == 'deleted' ) {
2019                 continue;
2020             }
2021             if ( isset($this->fetched_row[$field]) && $this->$field == $this->fetched_row[$field] ) {
2022                 // Don't hand out warnings because the field was untouched between retrieval and saving, most database drivers hand pretty much everything back as strings.
2023                 continue;
2024             }
2025             $reformatted = false;
2026             switch($def['type']) {
2027                 case 'datetime':
2028                 case 'datetimecombo':
2029                     if(empty($this->$field)) break;
2030                     if ( ! preg_match('/^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$/',$this->$field) ) {
2031                         // This appears to be formatted in user date/time
2032                         $this->$field = $timedate->to_db($this->$field);
2033                         $reformatted = true;
2034                     }
2035                     break;
2036                 case 'date':
2037                     if(empty($this->$field)) break;
2038                     if ( ! preg_match('/^[0-9]{4}-[0-9]{2}-[0-9]{2}$/',$this->$field) ) {
2039                         // This date appears to be formatted in the user's format
2040                         $this->$field = $timedate->to_db_date($this->$field, false);
2041                         $reformatted = true;
2042                     }
2043                     break;
2044                 case 'time':
2045                     if(empty($this->$field)) break;
2046                     if ( preg_match('/(am|pm)/i',$this->$field) ) {
2047                         // This time appears to be formatted in the user's format
2048                         $this->$field = $timedate->to_db_time($timedate->to_display_date(gmdate('Y-m-d')).' '.$this->$field);
2049                         $reformatted = true;
2050                     }
2051                     break;
2052                 case 'double':
2053                 case 'decimal':
2054                 case 'currency':
2055                 case 'float':
2056                         if ( $this->$field === '' || $this->$field == NULL || $this->$field == 'NULL') {
2057                         continue;
2058                     }
2059                     if ( is_string($this->$field) ) {
2060                         $this->$field = (float)unformat_number($this->$field);
2061                         $reformatted = true;
2062                     }
2063                     break;
2064                case 'uint':
2065                case 'ulong':
2066                case 'long':
2067                case 'short':
2068                case 'tinyint':
2069                case 'int':
2070                     if ( $this->$field === '' || $this->$field == NULL || $this->$field == 'NULL') {
2071                         continue;
2072                     }
2073                     if ( is_string($this->$field) ) {
2074                         $this->$field = (int)unformat_number($this->$field);
2075                         $reformatted = true;
2076                     }
2077                    break;
2078                case 'bool':
2079                    if (empty($this->$field)) {
2080                        $this->$field = false;
2081                    } else if(true === $this->$field || 1 == $this->$field) {
2082                        $this->$field = true;
2083                    } else if(in_array(strval($this->$field), $boolean_false_values)) {
2084                        $this->$field = false;
2085                        $reformatted = true;
2086                    } else {
2087                        $this->$field = true;
2088                        $reformatted = true;
2089                    }
2090                    break;
2091                case 'encrypt':
2092                     $this->$field = $this->encrpyt_before_save($this->$field);
2093                     break;
2094             }
2095             if ( $reformatted ) {
2096                 $GLOBALS['log']->deprecated('Formatting correction: '.$this->module_dir.'->'.$field.' had formatting automatically corrected. This will be removed in the future, please upgrade your external code');
2097                         }
2098                 }
2099
2100     }
2101
2102         /**
2103      * Function fetches a single row of data given the primary key value.
2104      *
2105      * The fetched data is then set into the bean. The function also processes the fetched data by formattig
2106      * date/time and numeric values.
2107      *
2108      * @param string $id Optional, default -1, is set to -1 id value from the bean is used, else, passed value is used
2109      * @param boolean $encode Optional, default true, encodes the values fetched from the database.
2110      * @param boolean $deleted Optional, default true, if set to false deleted filter will not be added.
2111      *
2112      * Internal function, do not override.
2113          */
2114         function retrieve($id = -1, $encode=true,$deleted=true)
2115         {
2116
2117                 $custom_logic_arguments['id'] = $id;
2118                 $this->call_custom_logic('before_retrieve', $custom_logic_arguments);
2119
2120                 if ($id == -1)
2121                 {
2122                         $id = $this->id;
2123                 }
2124                 if(isset($this->custom_fields))
2125                 {
2126                         $custom_join = $this->custom_fields->getJOIN();
2127                 }
2128                 else
2129                         $custom_join = false;
2130
2131                 if($custom_join)
2132                 {
2133                         $query = "SELECT $this->table_name.*". $custom_join['select']. " FROM $this->table_name ";
2134                 }
2135                 else
2136                 {
2137                         $query = "SELECT $this->table_name.* FROM $this->table_name ";
2138                 }
2139
2140                 if($custom_join)
2141                 {
2142                         $query .= ' ' . $custom_join['join'];
2143                 }
2144                 $query .= " WHERE $this->table_name.id = '$id' ";
2145                 if ($deleted) $query .= " AND $this->table_name.deleted=0";
2146                 $GLOBALS['log']->debug("Retrieve $this->object_name : ".$query);
2147                 //requireSingleResult has beeen deprecated.
2148                 //$result = $this->db->requireSingleResult($query, true, "Retrieving record by id $this->table_name:$id found ");
2149                 $result = $this->db->limitQuery($query,0,1,true, "Retrieving record by id $this->table_name:$id found ");
2150                 if(empty($result))
2151                 {
2152                         return null;
2153                 }
2154
2155                 $row = $this->db->fetchByAssoc($result, -1, $encode);
2156                 if(empty($row))
2157                 {
2158                         return null;
2159                 }
2160
2161                 //make copy of the fetched row for construction of audit record and for business logic/workflow
2162                 $this->fetched_row=$row;
2163                 $this->populateFromRow($row);
2164
2165                 global $module, $action;
2166                 //Just to get optimistic locking working for this release
2167                 if($this->optimistic_lock && $module == $this->module_dir && $action =='EditView' )
2168                 {
2169                         $_SESSION['o_lock_id']= $id;
2170                         $_SESSION['o_lock_dm']= $this->date_modified;
2171                         $_SESSION['o_lock_on'] = $this->object_name;
2172                 }
2173                 $this->processed_dates_times = array();
2174                 $this->check_date_relationships_load();
2175
2176                 if($custom_join)
2177                 {
2178                         $this->custom_fields->fill_relationships();
2179                 }
2180
2181                 $this->fill_in_additional_detail_fields();
2182                 $this->fill_in_relationship_fields();
2183                 //make a copy of fields in the relatiosnhip_fields array. these field values will be used to
2184                 //clear relatioship.
2185                 foreach ( $this->field_defs as $key => $def )
2186             {
2187                 if ($def [ 'type' ] == 'relate' && isset ( $def [ 'id_name'] ) && isset ( $def [ 'link'] ) && isset ( $def[ 'save' ])) {
2188                         if (isset($this->$key)) {
2189                                         $this->rel_fields_before_value[$key]=$this->$key;
2190                         if (isset($this->$def [ 'id_name']))
2191                                 $this->rel_fields_before_value[$def [ 'id_name']]=$this->$def [ 'id_name'];
2192                 }
2193                                 else
2194                                         $this->rel_fields_before_value[$key]=null;
2195            }
2196             }
2197             if (isset($this->relationship_fields) && is_array($this->relationship_fields))
2198                 {
2199                         foreach ($this->relationship_fields as $rel_id=>$rel_name)
2200                         {
2201                                 if (isset($this->$rel_id))
2202                                         $this->rel_fields_before_value[$rel_id]=$this->$rel_id;
2203                                 else
2204                                         $this->rel_fields_before_value[$rel_id]=null;
2205                         }
2206                 }
2207
2208                 // call the custom business logic
2209                 $custom_logic_arguments['id'] = $id;
2210                 $custom_logic_arguments['encode'] = $encode;
2211                 $this->call_custom_logic("after_retrieve", $custom_logic_arguments);
2212                 unset($custom_logic_arguments);
2213                 return $this;
2214         }
2215
2216     /**
2217      * Sets value from fetched row into the bean.
2218      *
2219      * @param array $row Fetched row
2220      * @todo loop through vardefs instead
2221      * @internal runs into an issue when populating from field_defs for users - corrupts user prefs
2222      *
2223      * Internal function, do not override.
2224      */
2225     function populateFromRow($row)
2226     {
2227         $nullvalue='';
2228         foreach($this->field_defs as $field=>$field_value)
2229         {
2230                 if($field == 'user_preferences' && $this->module_dir == 'Users')
2231                         continue;
2232                 $rfield = $field; // fetch returns it in lowercase only
2233                 if(isset($row[$rfield]))
2234                 {
2235                         $this->$field = $row[$rfield];
2236                         $owner = $rfield . '_owner';
2237                         if(!empty($row[$owner])){
2238                                 $this->$owner = $row[$owner];
2239                         }
2240                 }
2241                 else
2242                 {
2243                         $this->$field = $nullvalue;
2244                 }
2245         }
2246     }
2247
2248
2249
2250         /**
2251         * Add any required joins to the list count query.  The joins are required if there
2252         * is a field in the $where clause that needs to be joined.
2253     *
2254     * @param string $query
2255     * @param string $where
2256     *
2257     * Internal Function, do Not override.
2258         */
2259         function add_list_count_joins(&$query, $where)
2260         {
2261                 $custom_join = $this->custom_fields->getJOIN();
2262                 if($custom_join)
2263                 {
2264                         $query .= $custom_join['join'];
2265                 }
2266
2267         }
2268
2269         /**
2270          * Changes the select expression of the given query to be 'count(*)' so you
2271          * can get the number of items the query will return.  This is used to
2272          * populate the upper limit on ListViews.
2273      *
2274      * @param string $query Select query string
2275      * @return string count query
2276      *
2277      * Internal function, do not override.
2278          */
2279     function create_list_count_query($query)
2280     {
2281         // remove the 'order by' clause which is expected to be at the end of the query
2282         $pattern = '/\sORDER BY.*/is';  // ignores the case
2283         $replacement = '';
2284         $query = preg_replace($pattern, $replacement, $query);
2285         //handle distinct clause
2286         $star = '*';
2287         if(substr_count(strtolower($query), 'distinct')){
2288                 if (!empty($this->seed) && !empty($this->seed->table_name ))
2289                         $star = 'DISTINCT ' . $this->seed->table_name . '.id';
2290                 else
2291                         $star = 'DISTINCT ' . $this->table_name . '.id';
2292
2293         }
2294
2295         // change the select expression to 'count(*)'
2296         $pattern = '/SELECT(.*?)(\s){1}FROM(\s){1}/is';  // ignores the case
2297         $replacement = 'SELECT count(' . $star . ') c FROM ';
2298
2299         //if the passed query has union clause then replace all instances of the pattern.
2300         //this is very rare. I have seen this happening only from projects module.
2301         //in addition to this added a condition that has  union clause and uses
2302         //sub-selects.
2303         if (strstr($query," UNION ALL ") !== false) {
2304
2305                 //seperate out all the queries.
2306                 $union_qs=explode(" UNION ALL ", $query);
2307                 foreach ($union_qs as $key=>$union_query) {
2308                         $star = '*';
2309                                 preg_match($pattern, $union_query, $matches);
2310                                 if (!empty($matches)) {
2311                                         if (stristr($matches[0], "distinct")) {
2312                                         if (!empty($this->seed) && !empty($this->seed->table_name ))
2313                                                 $star = 'DISTINCT ' . $this->seed->table_name . '.id';
2314                                         else
2315                                                 $star = 'DISTINCT ' . $this->table_name . '.id';
2316                                         }
2317                                 } // if
2318                         $replacement = 'SELECT count(' . $star . ') c FROM ';
2319                         $union_qs[$key] = preg_replace($pattern, $replacement, $union_query,1);
2320                 }
2321                 $modified_select_query=implode(" UNION ALL ",$union_qs);
2322         } else {
2323                 $modified_select_query = preg_replace($pattern, $replacement, $query,1);
2324         }
2325
2326
2327                 return $modified_select_query;
2328     }
2329
2330         /**
2331         * This function returns a paged list of the current object type.  It is intended to allow for
2332         * hopping back and forth through pages of data.  It only retrieves what is on the current page.
2333         *
2334     * @internal This method must be called on a new instance.  It trashes the values of all the fields in the current one.
2335         * @param string $order_by
2336     * @param string $where Additional where clause
2337     * @param int $row_offset Optaional,default 0, starting row number
2338     * @param init $limit Optional, default -1
2339     * @param int $max Optional, default -1
2340     * @param boolean $show_deleted Optioanl, default 0, if set to 1 system will show deleted records.
2341     * @return array Fetched data.
2342     *
2343     * Internal function, do not override.
2344     *
2345         */
2346         function get_list($order_by = "", $where = "", $row_offset = 0, $limit=-1, $max=-1, $show_deleted = 0, $singleSelect=false)
2347         {
2348                 $GLOBALS['log']->debug("get_list:  order_by = '$order_by' and where = '$where' and limit = '$limit'");
2349                 if(isset($_SESSION['show_deleted']))
2350                 {
2351                         $show_deleted = 1;
2352                 }
2353                 $order_by=$this->process_order_by($order_by, null);
2354
2355                 if($this->bean_implements('ACL') && ACLController::requireOwner($this->module_dir, 'list') )
2356                 {
2357                         global $current_user;
2358                         $owner_where = $this->getOwnerWhere($current_user->id);
2359
2360                         //rrs - because $this->getOwnerWhere() can return '' we need to be sure to check for it and
2361                         //handle it properly else you could get into a situation where you are create a where stmt like
2362                         //WHERE .. AND ''
2363                         if(!empty($owner_where)){
2364                                 if(empty($where)){
2365                                         $where = $owner_where;
2366                                 }else{
2367                                         $where .= ' AND '.  $owner_where;
2368                                 }
2369                         }
2370                 }
2371                 $query = $this->create_new_list_query($order_by, $where,array(),array(), $show_deleted,'',false,null,$singleSelect);
2372                 return $this->process_list_query($query, $row_offset, $limit, $max, $where);
2373         }
2374
2375         /**
2376         * Prefixes column names with this bean's table name.
2377         * This call can be ignored for  mysql since it does a better job than Oracle in resolving ambiguity.
2378         *
2379     * @param string $order_by  Order by clause to be processed
2380     * @param string $submodule name of the module this order by clause is for
2381     * @return string Processed order by clause
2382     *
2383     * Internal function, do not override.
2384         */
2385         function process_order_by ($order_by, $submodule)
2386         {
2387                 if (empty($order_by))
2388                         return $order_by;
2389                 $bean_queried = "";
2390                 //submodule is empty,this is for list object in focus
2391                 if (empty($submodule))
2392                 {
2393                         $bean_queried = &$this;
2394                 }
2395                 else
2396                 {
2397                         //submodule is set, so this is for subpanel, use submodule
2398                         $bean_queried = $submodule;
2399                 }
2400                 $elements = explode(',',$order_by);
2401                 foreach ($elements as $key=>$value)
2402                 {
2403                         if (strchr($value,'.') === false)
2404                         {
2405                                 //value might have ascending and descending decorations
2406                                 $list_column = explode(' ',trim($value));
2407                                 if (isset($list_column[0]))
2408                                 {
2409                                         $list_column_name=trim($list_column[0]);
2410                                         if (isset($bean_queried->field_defs[$list_column_name]))
2411                                         {
2412                                                 $source=isset($bean_queried->field_defs[$list_column_name]['source']) ? $bean_queried->field_defs[$list_column_name]['source']:'db';
2413                                                 if (empty($bean_queried->field_defs[$list_column_name]['table']) && $source=='db')
2414                                                 {
2415                                                         $list_column[0] = $bean_queried->table_name .".".$list_column[0] ;
2416                                                 }
2417                                                 if (empty($bean_queried->field_defs[$list_column_name]['table']) && $source=='custom_fields')
2418                                                 {
2419                                                     $list_column[0] = $bean_queried->table_name ."_cstm.".$list_column[0] ;
2420                                                 }
2421                                                 $value = implode($list_column,' ');
2422                                                 // Bug 38803 - Use CONVERT() function when doing an order by on ntext, text, and image fields
2423                                                 if ( $this->db->dbType == 'mssql'
2424                                                      && $source != 'non-db'
2425                             && in_array(
2426                                 $this->db->getHelper()->getColumnType($this->db->getHelper()->getFieldType($bean_queried->field_defs[$list_column_name])),
2427                                 array('ntext','text','image')
2428                                 )
2429                             ) {
2430                         $value = "CONVERT(varchar(500),{$list_column[0]}) {$list_column[1]}";
2431                         }
2432                                                 // Bug 29011 - Use TO_CHAR() function when doing an order by on a clob field
2433                                                 if ( $this->db->dbType == 'oci8'
2434                                                      && $source != 'non-db'
2435                             && in_array(
2436                                 $this->db->getHelper()->getColumnType($this->db->getHelper()->getFieldType($bean_queried->field_defs[$list_column_name])),
2437                                 array('clob')
2438                                 )
2439                             ) {
2440                         $value = "TO_CHAR({$list_column[0]}) {$list_column[1]}";
2441                         }
2442                                         }
2443                                         else
2444                                         {
2445                                                 $GLOBALS['log']->debug("process_order_by: ($list_column[0]) does not have a vardef entry.");
2446                                         }
2447                                 }
2448                         }
2449                         $elements[$key]=$value;
2450                 }
2451                 return implode($elements,',');
2452
2453         }
2454
2455
2456         /**
2457         * Returns a detail object like retrieving of the current object type.
2458     *
2459     * It is intended for use in navigation buttons on the DetailView.  It will pass an offset and limit argument to the sql query.
2460         * @internal This method must be called on a new instance.  It overrides the values of all the fields in the current one.
2461     *
2462     * @param string $order_by
2463     * @param string $where Additional where clause
2464     * @param int $row_offset Optaional,default 0, starting row number
2465     * @param init $limit Optional, default -1
2466     * @param int $max Optional, default -1
2467     * @param boolean $show_deleted Optioanl, default 0, if set to 1 system will show deleted records.
2468     * @return array Fetched data.
2469     *
2470     * Internal function, do not override.
2471         */
2472         function get_detail($order_by = "", $where = "",  $offset = 0, $row_offset = 0, $limit=-1, $max=-1, $show_deleted = 0)
2473         {
2474                 $GLOBALS['log']->debug("get_detail:  order_by = '$order_by' and where = '$where' and limit = '$limit' and offset = '$offset'");
2475                 if(isset($_SESSION['show_deleted']))
2476                 {
2477                         $show_deleted = 1;
2478                 }
2479
2480                 if($this->bean_implements('ACL') && ACLController::requireOwner($this->module_dir, 'list') )
2481                 {
2482                         global $current_user;
2483                         $owner_where = $this->getOwnerWhere($current_user->id);
2484
2485                         if(empty($where))
2486                         {
2487                                 $where = $owner_where;
2488                         }
2489                         else
2490                         {
2491                                 $where .= ' AND '.  $owner_where;
2492                         }
2493                 }
2494                 $query = $this->create_new_list_query($order_by, $where,array(),array(), $show_deleted, $offset);
2495
2496                 //Add Limit and Offset to query
2497                 //$query .= " LIMIT 1 OFFSET $offset";
2498
2499                 return $this->process_detail_query($query, $row_offset, $limit, $max, $where, $offset);
2500         }
2501
2502     /**
2503     * Fetches data from all related tables.
2504     *
2505     * @param object $child_seed
2506     * @param string $related_field_name relation to fetch data for
2507     * @param string $order_by Optional, default empty
2508     * @param string $where Optional, additional where clause
2509     * @return array Fetched data.
2510     *
2511     * Internal function, do not override.
2512     */
2513     function get_related_list($child_seed,$related_field_name, $order_by = "", $where = "",
2514     $row_offset = 0, $limit=-1, $max=-1, $show_deleted = 0)
2515     {
2516         global $layout_edit_mode;
2517         if(isset($layout_edit_mode) && $layout_edit_mode)
2518         {
2519                 $response = array();
2520                 $child_seed->assign_display_fields($child_seed->module_dir);
2521                 $response['list'] = array($child_seed);
2522                 $response['row_count'] = 1;
2523                 $response['next_offset'] = 0;
2524                 $response['previous_offset'] = 0;
2525
2526                 return $response;
2527         }
2528         $GLOBALS['log']->debug("get_related_list:  order_by = '$order_by' and where = '$where' and limit = '$limit'");
2529         if(isset($_SESSION['show_deleted']))
2530         {
2531                 $show_deleted = 1;
2532         }
2533
2534         $this->load_relationship($related_field_name);
2535         $query_array = $this->$related_field_name->getQuery(true);
2536         $entire_where = $query_array['where'];
2537         if(!empty($where))
2538         {
2539                 if(empty($entire_where))
2540                 {
2541                         $entire_where = ' WHERE ' . $where;
2542                 }
2543                 else
2544                 {
2545                         $entire_where .= ' AND ' . $where;
2546                 }
2547         }
2548
2549         $query = 'SELECT '.$child_seed->table_name.'.* ' . $query_array['from'] . ' ' . $entire_where;
2550         if(!empty($order_by))
2551         {
2552                 $query .= " ORDER BY " . $order_by;
2553         }
2554
2555         return $child_seed->process_list_query($query, $row_offset, $limit, $max, $where);
2556     }
2557
2558
2559         protected static function build_sub_queries_for_union($subpanel_list, $subpanel_def, $parentbean, $order_by)
2560     {
2561         global $layout_edit_mode, $beanFiles, $beanList;
2562         $subqueries = array();
2563         foreach($subpanel_list as $this_subpanel)
2564                 {
2565                         if(!$this_subpanel->isDatasourceFunction() || ($this_subpanel->isDatasourceFunction()
2566                                 && isset($this_subpanel->_instance_properties['generate_select'])
2567                                 && $this_subpanel->_instance_properties['generate_select']==true))
2568                         {
2569                                 //the custom query function must return an array with
2570                                 if ($this_subpanel->isDatasourceFunction()) {
2571                                         $shortcut_function_name = $this_subpanel->get_data_source_name();
2572                                         $parameters=$this_subpanel->get_function_parameters();
2573                                         if (!empty($parameters))
2574                                         {
2575                                             //if the import file function is set, then import the file to call the custom function from
2576                                                 if (is_array($parameters)  && isset($parameters['import_function_file'])){
2577                                                     //this call may happen multiple times, so only require if function does not exist
2578                                                         if(!function_exists($shortcut_function_name)){
2579                                                                 require_once($parameters['import_function_file']);
2580                                                         }
2581                                                         //call function from required file
2582                                                         $query_array = $shortcut_function_name($parameters);
2583                                                 }else{
2584                                                         //call function from parent bean
2585                                                         $query_array = $parentbean->$shortcut_function_name($parameters);
2586                                                 }
2587                                         }
2588                                         else
2589                                         {
2590                                                 $query_array = $parentbean->$shortcut_function_name();
2591                                         }
2592                                 }  else {
2593                                         $related_field_name = $this_subpanel->get_data_source_name();
2594                                         if (!$parentbean->load_relationship($related_field_name)){
2595                                                 unset ($parentbean->$related_field_name);
2596                                                 continue;
2597                                         }
2598                                         $query_array = $parentbean->$related_field_name->getQuery(true,array(),0,'',true, null, null, true);
2599                                 }
2600                                 $table_where = $this_subpanel->get_where();
2601                                 $where_definition = $query_array['where'];
2602
2603                                 if(!empty($table_where))
2604                                 {
2605                                         if(empty($where_definition))
2606                                         {
2607                                                 $where_definition = $table_where;
2608                                         }
2609                                         else
2610                                         {
2611                                                 $where_definition .= ' AND ' . $table_where;
2612                                         }
2613                                 }
2614
2615                                 $submodulename = $this_subpanel->_instance_properties['module'];
2616                                 $submoduleclass = $beanList[$submodulename];
2617                                 //require_once($beanFiles[$submoduleclass]);
2618                                 $submodule = new $submoduleclass();
2619                                 $subwhere = $where_definition;
2620
2621
2622
2623                                 $subwhere = str_replace('WHERE', '', $subwhere);
2624                                 $list_fields = $this_subpanel->get_list_fields();
2625                                 foreach($list_fields as $list_key=>$list_field)
2626                                 {
2627                                         if(isset($list_field['usage']) && $list_field['usage'] == 'display_only')
2628                                         {
2629                                                 unset($list_fields[$list_key]);
2630                                         }
2631                                 }
2632                                 if(!$subpanel_def->isCollection() && isset($list_fields[$order_by]) && isset($submodule->field_defs[$order_by])&& (!isset($submodule->field_defs[$order_by]['source']) || $submodule->field_defs[$order_by]['source'] == 'db'))
2633                                 {
2634                                         $order_by = $submodule->table_name .'.'. $order_by;
2635                                 }
2636                                 $table_name = $this_subpanel->table_name;
2637                                 $panel_name=$this_subpanel->name;
2638                                 $params = array();
2639                                 $params['distinct'] = $this_subpanel->distinct_query();
2640
2641                                 $params['joined_tables'] = $query_array['join_tables'];
2642                                 $params['include_custom_fields'] = !$subpanel_def->isCollection();
2643                                 $params['collection_list'] = $subpanel_def->get_inst_prop_value('collection_list');
2644
2645                                 $subquery = $submodule->create_new_list_query('',$subwhere ,$list_fields,$params, 0,'', true,$parentbean);
2646
2647                                 $subquery['select'] = $subquery['select']." , '$panel_name' panel_name ";
2648                                 $subquery['from'] = $subquery['from'].$query_array['join'];
2649                                 $subquery['query_array'] = $query_array;
2650                                 $subquery['params'] = $params;
2651
2652                                 $subqueries[] = $subquery;
2653                         }
2654                 }
2655                 return $subqueries;
2656     }
2657
2658         /**
2659          * Constructs a query to fetch data for supanels and list views
2660      *
2661      * It constructs union queries for activities subpanel.
2662      *
2663      * @param Object $parentbean constructing queries for link attributes in this bean
2664      * @param string $order_by Optional, order by clause
2665      * @param string $sort_order Optional, sort order
2666      * @param string $where Optional, additional where clause
2667      *
2668      * Internal Function, do not overide.
2669          */
2670         function get_union_related_list($parentbean, $order_by = "", $sort_order='', $where = "",
2671         $row_offset = 0, $limit=-1, $max=-1, $show_deleted = 0, $subpanel_def)
2672         {
2673                 $secondary_queries = array();
2674                 global $layout_edit_mode, $beanFiles, $beanList;
2675
2676                 if(isset($_SESSION['show_deleted']))
2677                 {
2678                         $show_deleted = 1;
2679                 }
2680                 $final_query = '';
2681                 $final_query_rows = '';
2682                 $subpanel_list=array();
2683                 if ($subpanel_def->isCollection())
2684                 {
2685                         $subpanel_def->load_sub_subpanels();
2686                         $subpanel_list=$subpanel_def->sub_subpanels;
2687                 }
2688                 else
2689                 {
2690                         $subpanel_list[]=$subpanel_def;
2691                 }
2692
2693                 $first = true;
2694
2695                 //Breaking the building process into two loops. The first loop gets a list of all the sub-queries.
2696                 //The second loop merges the queries and forces them to select the same number of columns
2697                 //All columns in a sub-subpanel group must have the same aliases
2698                 //If the subpanel is a datasource function, it can't be a collection so we just poll that function for the and return that
2699                 foreach($subpanel_list as $this_subpanel)
2700                 {
2701                         if($this_subpanel->isDatasourceFunction() && empty($this_subpanel->_instance_properties['generate_select']))
2702                         {
2703                                 $shortcut_function_name = $this_subpanel->get_data_source_name();
2704                                 $parameters=$this_subpanel->get_function_parameters();
2705                                 if (!empty($parameters))
2706                                 {
2707                                         //if the import file function is set, then import the file to call the custom function from
2708                                         if (is_array($parameters)  && isset($parameters['import_function_file'])){
2709                                                 //this call may happen multiple times, so only require if function does not exist
2710                                                 if(!function_exists($shortcut_function_name)){
2711                                                         require_once($parameters['import_function_file']);
2712                                                 }
2713                                                 //call function from required file
2714                                                 $tmp_final_query =  $shortcut_function_name($parameters);
2715                                         }else{
2716                                                 //call function from parent bean
2717                                                 $tmp_final_query =  $parentbean->$shortcut_function_name($parameters);
2718                                         }
2719                                 }
2720                                 else
2721                                 {
2722                                         $tmp_final_query = $parentbean->$shortcut_function_name();
2723                                 }
2724                                 if(!$first)
2725                                 {
2726                                         $final_query_rows .= ' UNION ALL ( '.$parentbean->create_list_count_query($tmp_final_query, $parameters) . ' )';
2727                                         $final_query .= ' UNION ALL ( '.$tmp_final_query . ' )';
2728                                 } else {
2729                                         $final_query_rows = '(' . $parentbean->create_list_count_query($tmp_final_query, $parameters) . ')';
2730                                         $final_query = '(' . $tmp_final_query . ')';
2731                                         $first = false;
2732                                 }
2733                         }
2734                 }
2735                 //If final_query is still empty, its time to build the sub-queries
2736                 if (empty($final_query))
2737                 {
2738                         $subqueries = SugarBean::build_sub_queries_for_union($subpanel_list, $subpanel_def, $parentbean, $order_by);
2739                         $all_fields = array();
2740                         foreach($subqueries as $i => $subquery)
2741                         {
2742                                 $query_fields = $GLOBALS['db']->helper->getSelectFieldsFromQuery($subquery['select']);
2743                                 foreach($query_fields as $field => $select)
2744                                 {
2745                                         if (!in_array($field, $all_fields))
2746                                                 $all_fields[] = $field;
2747                                 }
2748                                 $subqueries[$i]['query_fields'] = $query_fields;
2749                         }
2750                         $first = true;
2751                         //Now ensure the queries have the same set of fields in the same order.
2752                         foreach($subqueries as $subquery)
2753                         {
2754                                 $subquery['select'] = "SELECT";
2755                                 foreach($all_fields as $field)
2756                                 {
2757                                         if (!isset($subquery['query_fields'][$field]))
2758                                         {
2759                                                 $subquery['select'] .= " ' ' $field,";
2760                                         }
2761                                         else
2762                                         {
2763                                                 $subquery['select'] .= " {$subquery['query_fields'][$field]},";
2764                                         }
2765                                 }
2766                                 $subquery['select'] = substr($subquery['select'], 0 , strlen($subquery['select']) - 1);
2767                                 //Put the query into the final_query
2768                                 $query =  $subquery['select'] . " " . $subquery['from'] . " " . $subquery['where'];
2769                                 if(!$first)
2770                                 {
2771                                         $query = ' UNION ALL ( '.$query . ' )';
2772                                         $final_query_rows .= " UNION ALL ";
2773                                 } else {
2774                                         $query = '(' . $query . ')';
2775                                         $first = false;
2776                                 }
2777                                 $query_array = $subquery['query_array'];
2778                                 $select_position=strpos($query_array['select'],"SELECT");
2779                                 $distinct_position=strpos($query_array['select'],"DISTINCT");
2780                                 if ($select_position !== false && $distinct_position!= false)
2781                                 {
2782                                         $query_rows = "( ".substr_replace($query_array['select'],"SELECT count(",$select_position,6). ")" .  $subquery['from_min'].$query_array['join']. $subquery['where'].' )';
2783                                 }
2784                                 else
2785                                 {
2786                                         //resort to default behavior.
2787                                         $query_rows = "( SELECT count(*)".  $subquery['from_min'].$query_array['join']. $subquery['where'].' )';
2788
2789                                 }
2790                                 if(!empty($subquery['secondary_select']))
2791                                 {
2792
2793                                         $subquerystring= $subquery['secondary_select'] . $subquery['secondary_from'].$query_array['join']. $subquery['where'];
2794                                         if (!empty($subquery['secondary_where']))
2795                                         {
2796                                                 if (empty($subquery['where']))
2797                                                 {
2798                                                         $subquerystring.=" WHERE " .$subquery['secondary_where'];
2799                                                 }
2800                                                 else
2801                                                 {
2802                                                         $subquerystring.=" AND " .$subquery['secondary_where'];
2803                                                 }
2804                                         }
2805                                         $secondary_queries[]=$subquerystring;
2806                                 }
2807                                 $final_query .= $query;
2808                                 $final_query_rows .= $query_rows;
2809                         }
2810                 }
2811
2812                 if(!empty($order_by))
2813                 {
2814                         $submodule = false;
2815                         if(!$subpanel_def->isCollection())
2816                         {
2817                                 $submodulename = $subpanel_def->_instance_properties['module'];
2818                                 $submoduleclass = $beanList[$submodulename];
2819                                 $submodule = new $submoduleclass();
2820                         }
2821                         if(!empty($submodule) && !empty($submodule->table_name))
2822                         {
2823                                 $final_query .= " ORDER BY " .$parentbean->process_order_by($order_by, $submodule);
2824
2825                         }
2826                         else
2827                         {
2828                                 $final_query .= " ORDER BY ". $order_by . ' ';
2829                         }
2830                         if(!empty($sort_order))
2831                         {
2832                                 $final_query .= ' ' .$sort_order;
2833                         }
2834                 }
2835
2836
2837                 if(isset($layout_edit_mode) && $layout_edit_mode)
2838                 {
2839                         $response = array();
2840                         if(!empty($submodule))
2841                         {
2842                                 $submodule->assign_display_fields($submodule->module_dir);
2843                                 $response['list'] = array($submodule);
2844                         }
2845                         else
2846                 {
2847                                 $response['list'] = array();
2848                         }
2849                         $response['parent_data'] = array();
2850                         $response['row_count'] = 1;
2851                         $response['next_offset'] = 0;
2852                         $response['previous_offset'] = 0;
2853
2854                         return $response;
2855                 }
2856
2857                 return $parentbean->process_union_list_query($parentbean, $final_query, $row_offset, $limit, $max, '',$subpanel_def, $final_query_rows, $secondary_queries);
2858         }
2859
2860
2861         /**
2862         * Returns a full (ie non-paged) list of the current object type.
2863         *
2864         * @param string $order_by the order by SQL parameter. defaults to ""
2865         * @param string $where where clause. defaults to ""
2866         * @param boolean $check_dates. defaults to false
2867         * @param int $show_deleted show deleted records. defaults to 0
2868         */
2869         function get_full_list($order_by = "", $where = "", $check_dates=false, $show_deleted = 0)
2870         {
2871                 $GLOBALS['log']->debug("get_full_list:  order_by = '$order_by' and where = '$where'");
2872                 if(isset($_SESSION['show_deleted']))
2873                 {
2874                         $show_deleted = 1;
2875                 }
2876                 $query = $this->create_new_list_query($order_by, $where,array(),array(), $show_deleted);
2877                 return $this->process_full_list_query($query, $check_dates);
2878         }
2879
2880     /**
2881      * Return the list query used by the list views and export button. Next generation of create_new_list_query function.
2882      *
2883      * Override this function to return a custom query.
2884      *
2885      * @param string $order_by custom order by clause
2886      * @param string $where custom where clause
2887      * @param array $filter Optioanal
2888      * @param array $params Optional     *
2889      * @param int $show_deleted Optional, default 0, show deleted records is set to 1.
2890      * @param string $join_type
2891      * @param boolean $return_array Optional, default false, response as array
2892      * @param object $parentbean creating a subquery for this bean.
2893      * @param boolean $singleSelect Optional, default false.
2894      * @return String select query string, optionally an array value will be returned if $return_array= true.
2895      */
2896     function create_new_list_query($order_by, $where,$filter=array(),$params=array(), $show_deleted = 0,$join_type='', $return_array = false,$parentbean=null, $singleSelect = false)
2897     {
2898         global $beanFiles, $beanList;
2899         $selectedFields = array();
2900         $secondarySelectedFields = array();
2901         $ret_array = array();
2902         $distinct = '';
2903         if($this->bean_implements('ACL') && ACLController::requireOwner($this->module_dir, 'list') )
2904         {
2905                 global $current_user;
2906                 $owner_where = $this->getOwnerWhere($current_user->id);
2907                 if(empty($where))
2908                 {
2909                         $where = $owner_where;
2910                 }
2911                 else
2912                 {
2913                         $where .= ' AND '.  $owner_where;
2914                 }
2915         }
2916         if(!empty($params['distinct']))
2917         {
2918                 $distinct = ' DISTINCT ';
2919         }
2920         if(empty($filter))
2921         {
2922                 $ret_array['select'] = " SELECT $distinct $this->table_name.* ";
2923         }
2924         else
2925         {
2926                 $ret_array['select'] = " SELECT $distinct $this->table_name.id ";
2927         }
2928         $ret_array['from'] = " FROM $this->table_name ";
2929         $ret_array['from_min'] = $ret_array['from'];
2930         $ret_array['secondary_from'] = $ret_array['from'] ;
2931         $ret_array['where'] = '';
2932         $ret_array['order_by'] = '';
2933         //secondary selects are selects that need to be run after the primarty query to retrieve additional info on main
2934         if($singleSelect)
2935         {
2936                 $ret_array['secondary_select']=& $ret_array['select'];
2937                 $ret_array['secondary_from'] = & $ret_array['from'];
2938         }
2939         else
2940         {
2941                 $ret_array['secondary_select'] = '';
2942         }
2943         $custom_join = false;
2944         if((!isset($params['include_custom_fields']) || $params['include_custom_fields']) &&  isset($this->custom_fields))
2945         {
2946
2947                 $custom_join = $this->custom_fields->getJOIN( empty($filter)? true: $filter );
2948                 if($custom_join)
2949                 {
2950                         $ret_array['select'] .= ' ' .$custom_join['select'];
2951                 }
2952         }
2953         if($custom_join)
2954         {
2955                 $ret_array['from'] .= ' ' . $custom_join['join'];
2956         }
2957         $jtcount = 0;
2958         //LOOP AROUND FOR FIXIN VARDEF ISSUES
2959         require('include/VarDefHandler/listvardefoverride.php');
2960         $joined_tables = array();
2961         if(isset($params['joined_tables']))
2962         {
2963                 foreach($params['joined_tables'] as $table)
2964                 {
2965                         $joined_tables[$table] = 1;
2966                 }
2967         }
2968
2969         if(!empty($filter))
2970         {
2971                 $filterKeys = array_keys($filter);
2972                 if(is_numeric($filterKeys[0]))
2973                 {
2974                         $fields = array();
2975                         foreach($filter as $field)
2976                         {
2977                                 $field = strtolower($field);
2978                                 if(isset($this->field_defs[$field]))
2979                                 {
2980                                         $fields[$field]= $this->field_defs[$field];
2981                                 }
2982                                 else
2983                                 {
2984                                         $fields[$field] = array('force_exists'=>true);
2985                                 }
2986                         }
2987                 }else{
2988                         $fields =       $filter;
2989                 }
2990         }
2991         else
2992         {
2993                 $fields =       $this->field_defs;
2994         }
2995
2996         $used_join_key = array();
2997
2998         foreach($fields as $field=>$value)
2999         {
3000                 //alias is used to alias field names
3001                 $alias='';
3002                 if      (isset($value['alias']))
3003                 {
3004                         $alias =' as ' . $value['alias'] . ' ';
3005                 }
3006
3007                 if(empty($this->field_defs[$field]) || !empty($value['force_blank']) )
3008                 {
3009                         if(!empty($filter) && isset($filter[$field]['force_exists']) && $filter[$field]['force_exists'])
3010                         {
3011                                 if ( isset($filter[$field]['force_default']) )
3012                                         $ret_array['select'] .= ", {$filter[$field]['force_default']} $field ";
3013                                 else
3014                                 //spaces are a fix for length issue problem with unions.  The union only returns the maximum number of characters from the first select statemtn.
3015                                         $ret_array['select'] .= ", '                                                                                                                                                                                                                                                              ' $field ";
3016                         }
3017                         continue;
3018                 }
3019                 else
3020                 {
3021                         $data = $this->field_defs[$field];
3022                 }
3023
3024                 //ignore fields that are a part of the collection and a field has been removed as a result of
3025                 //layout customization.. this happens in subpanel customizations, use case, from the contacts subpanel
3026                 //in opportunities module remove the contact_role/opportunity_role field.
3027                 $process_field=true;
3028                 if (isset($data['relationship_fields']) and !empty($data['relationship_fields']))
3029                 {
3030                         foreach ($data['relationship_fields'] as $field_name)
3031                         {
3032                                 if (!isset($fields[$field_name]))
3033                                 {
3034                                         $process_field=false;
3035                                 }
3036                         }
3037                 }
3038                 if (!$process_field)
3039                 {
3040                         continue;
3041                 }
3042
3043                 if(  (!isset($data['source']) || $data['source'] == 'db') && (!empty($alias) || !empty($filter) ))
3044                 {
3045                         $ret_array['select'] .= ", $this->table_name.$field $alias";
3046                                 $selectedFields["$this->table_name.$field"] = true;
3047                 }
3048
3049                 if($data['type'] != 'relate' && isset($data['db_concat_fields']))
3050                 {
3051                         $ret_array['select'] .= ", " . db_concat($this->table_name, $data['db_concat_fields']) . " as $field";
3052                                 $selectedFields[db_concat($this->table_name, $data['db_concat_fields'])] = true;
3053                 }
3054                 //Custom relate field or relate fields built in module builder which have no link field associated.
3055                 if ($data['type'] == 'relate' && (isset($data['custom_module']) || isset($data['ext2']))) {
3056                         $joinTableAlias = 'jt' . $jtcount;
3057                         $relateJoinInfo = $this->custom_fields->getRelateJoin($data, $joinTableAlias);
3058                                 $ret_array['select'] .= $relateJoinInfo['select'];
3059                                 $ret_array['from'] .= $relateJoinInfo['from'];
3060                                 //Replace any references to the relationship in the where clause with the new alias
3061                                 //If the link isn't set, assume that search used the local table for the field
3062                                 $searchTable = isset($data['link']) ? $relateJoinInfo['rel_table'] : $this->table_name;
3063                                 $field_name = $relateJoinInfo['rel_table'] . '.' . !empty($data['name'])?$data['name']:'name';
3064                                 $where = preg_replace('/(^|[\s(])' . $field_name . '/' , '${1}' . $relateJoinInfo['name_field'], $where);
3065                                 $jtcount++;
3066                 }
3067                 //Parent Field
3068                 if ($data['type'] == 'parent') {
3069                         //See if we need to join anything by inspecting the where clause
3070                         $match = preg_match('/(^|[\s(])parent_(\w+)_(\w+)\.name/', $where, $matches);
3071                         if ($match) {
3072                                 $joinTableAlias = 'jt' . $jtcount;
3073                                 $joinModule = $matches[2];
3074                                 $joinTable = $matches[3];
3075                                 $localTable = $this->table_name;
3076                                 if (!empty($data['custom_module'])) {
3077                                         $localTable .= '_cstm';
3078                                 }
3079                                 global $beanFiles, $beanList, $module;
3080                                         require_once($beanFiles[$beanList[$joinModule]]);
3081                                     $rel_mod = new $beanList[$joinModule]();
3082                                     $nameField = "$joinTableAlias.name";
3083                                 if (isset($rel_mod->field_defs['name']))
3084                                     {
3085                                                 $name_field_def = $rel_mod->field_defs['name'];
3086                                         if(isset($name_field_def['db_concat_fields']))
3087                                         {
3088                                                 $nameField = db_concat($joinTableAlias, $name_field_def['db_concat_fields']);
3089                                         }
3090                                 }
3091                                 $ret_array['select'] .= ", $nameField {$data['name']} ";
3092                                 $ret_array['from'] .= " LEFT JOIN $joinTable $joinTableAlias
3093                                         ON $localTable.{$data['id_name']} = $joinTableAlias.id";
3094                                 //Replace any references to the relationship in the where clause with the new alias
3095                                         $where = preg_replace('/(^|[\s(])parent_' . $joinModule . '_' . $joinTable . '\.name/', '${1}' . $nameField, $where);
3096                                         $jtcount++;
3097                         }
3098                 }
3099                 if($data['type'] == 'relate' && isset($data['link']))
3100                 {
3101                         $this->load_relationship($data['link']);
3102
3103                         if(!empty($this->$data['link']))
3104                         {
3105                                 $params = array();
3106                                 if(empty($join_type))
3107                                 {
3108                                         $params['join_type'] = ' LEFT JOIN ';
3109                                 }
3110                                 else
3111                                 {
3112                                         $params['join_type'] = $join_type;
3113                                 }
3114                                 if(isset($data['join_name']))
3115                                 {
3116                                         $params['join_table_alias'] = $data['join_name'];
3117                                 }
3118                                 else
3119                                 {
3120                                         $params['join_table_alias']     = 'jt' . $jtcount;
3121
3122                                 }
3123                                 if(isset($data['join_link_name']))
3124                                 {
3125                                         $params['join_table_link_alias'] = $data['join_link_name'];
3126                                 }
3127                                 else
3128                                 {
3129                                         $params['join_table_link_alias'] = 'jtl' . $jtcount;
3130                                 }
3131                     $join_primary = !isset($data['join_primary']) || $data['join_primary'];
3132
3133                                 $join = $this->$data['link']->getJoin($params, true);
3134                     $used_join_key[] = $join['rel_key'];
3135                                 $rel_module = $this->$data['link']->getRelatedModuleName();
3136                                 $table_joined = !empty($joined_tables[$params['join_table_alias']]) || (!empty($joined_tables[$params['join_table_link_alias']]) && isset($data['link_type']) && $data['link_type'] == 'relationship_info');
3137
3138                                         //if rnanme is set to 'name', and bean files exist, then check if field should be a concatenated name
3139                                         global $beanFiles, $beanList;
3140                                         if($data['rname'] && !empty($beanFiles[$beanList[$rel_module]])) {
3141
3142                                                 //create an instance of the related bean
3143                                                 require_once($beanFiles[$beanList[$rel_module]]);
3144                                                 $rel_mod = new $beanList[$rel_module]();
3145                                                 //if bean has first and last name fields, then name should be concatenated
3146                                                 if(isset($rel_mod->field_name_map['first_name']) && isset($rel_mod->field_name_map['last_name'])){
3147                                                                 $data['db_concat_fields'] = array(0=>'first_name', 1=>'last_name');
3148                                                 }
3149                                         }
3150
3151
3152                                 if($join['type'] == 'many-to-many')
3153                                 {
3154                                         if(empty($ret_array['secondary_select']))
3155                                         {
3156                                                 $ret_array['secondary_select'] = " SELECT $this->table_name.id ref_id  ";
3157
3158                                                 if(!empty($beanFiles[$beanList[$rel_module]]) && $join_primary)
3159                                                 {
3160                                                         require_once($beanFiles[$beanList[$rel_module]]);
3161                                                         $rel_mod = new $beanList[$rel_module]();
3162                                                         if(isset($rel_mod->field_defs['assigned_user_id']))
3163                                                         {
3164                                                                 $ret_array['secondary_select'].= " , ". $params['join_table_alias'] . ".assigned_user_id {$field}_owner, '$rel_module' {$field}_mod";
3165
3166                                                         }
3167                                                         else
3168                                                         {
3169                                                                 if(isset($rel_mod->field_defs['created_by']))
3170                                                                 {
3171                                                                         $ret_array['secondary_select'].= " , ". $params['join_table_alias'] . ".created_by {$field}_owner , '$rel_module' {$field}_mod";
3172
3173                                                                 }
3174                                                         }
3175
3176
3177                                                 }
3178                                         }
3179
3180
3181
3182                                         if(isset($data['db_concat_fields']))
3183                                         {
3184                                                 $ret_array['secondary_select'] .= ' , ' . db_concat($params['join_table_alias'], $data['db_concat_fields']) . ' ' . $field;
3185                                         }
3186                                         else
3187                                         {
3188                                                 if(!isset($data['relationship_fields']))
3189                                                 {
3190                                                         $ret_array['secondary_select'] .= ' , ' . $params['join_table_alias'] . '.' . $data['rname'] . ' ' . $field;
3191                                                 }
3192                                         }
3193                                         if(!$singleSelect)
3194                                         {
3195                                                 $ret_array['select'] .= ", '                                                                                                                                                                                                                                                              ' $field ";
3196                                                 $ret_array['select'] .= ", '                                    '  " . $join['rel_key'] . ' ';
3197                                         }
3198                         $count_used =0;
3199                         if($this->db->dbType != 'mysql') {//bug 26801, these codes are just used to duplicate rel_key in the select sql, or it will throw error in MSSQL and Oracle.
3200                             foreach($used_join_key as $used_key) {
3201                                if($used_key == $join['rel_key']) $count_used++;
3202                             }
3203                         }
3204                         if($count_used <= 1) {//27416, the $ret_array['secondary_select'] should always generate, regardless the dbtype
3205                             $ret_array['secondary_select'] .= ', ' . $params['join_table_link_alias'].'.'. $join['rel_key'] .' ' . $join['rel_key'];
3206                         }
3207                         if(isset($data['relationship_fields']))
3208                                         {
3209                                                 foreach($data['relationship_fields'] as $r_name=>$alias_name)
3210                                                 {
3211                                                         if(!empty( $secondarySelectedFields[$alias_name]))continue;
3212                                                         $ret_array['secondary_select'] .= ', ' . $params['join_table_link_alias'].'.'. $r_name .' ' . $alias_name;
3213                                                         $secondarySelectedFields[$alias_name] = true;
3214                                                 }
3215                                         }
3216                                         if(!$table_joined)
3217                                         {
3218                                                 $ret_array['secondary_from'] .= ' ' . $join['join']. ' AND ' . $params['join_table_alias'].'.deleted=0';
3219                                                 if (isset($data['link_type']) && $data['link_type'] == 'relationship_info' && ($parentbean instanceOf SugarBean))
3220                                                 {
3221                                                         $ret_array['secondary_where'] = $params['join_table_link_alias'] . '.' . $join['rel_key']. "='" .$parentbean->id . "'";
3222                                                 }
3223                                         }
3224                                 }
3225                                 else
3226                                 {
3227                                         if(isset($data['db_concat_fields']))
3228                                         {
3229                                                 $ret_array['select'] .= ' , ' . db_concat($params['join_table_alias'], $data['db_concat_fields']) . ' ' . $field;
3230                                         }
3231                                         else
3232                                         {
3233                                                 $ret_array['select'] .= ' , ' . $params['join_table_alias'] . '.' . $data['rname'] . ' ' . $field;
3234                                         }
3235                                         if(isset($data['additionalFields'])){
3236                                                 foreach($data['additionalFields'] as $k=>$v){
3237                                                         $ret_array['select'] .= ' , ' . $params['join_table_alias'] . '.' . $k . ' ' . $v;
3238                                                 }
3239                                         }
3240                                         if(!$table_joined)
3241                                         {
3242                                                 $ret_array['from'] .= ' ' . $join['join']. ' AND ' . $params['join_table_alias'].'.deleted=0';
3243                                                 if(!empty($beanList[$rel_module]) && !empty($beanFiles[$beanList[$rel_module]]))
3244                                                 {
3245                                                         require_once($beanFiles[$beanList[$rel_module]]);
3246                                                         $rel_mod = new $beanList[$rel_module]();
3247                                                         if(isset($value['target_record_key']) && !empty($filter))
3248                                                         {
3249                                                                 $selectedFields[$this->table_name.'.'.$value['target_record_key']] = true;
3250                                                                 $ret_array['select'] .= " , $this->table_name.{$value['target_record_key']} ";
3251                                                         }
3252                                                         if(isset($rel_mod->field_defs['assigned_user_id']))
3253                                                         {
3254                                                                 $ret_array['select'] .= ' , ' .$params['join_table_alias'] . '.assigned_user_id ' .  $field . '_owner';
3255                                                         }
3256                                                         else
3257                                                         {
3258                                                                 $ret_array['select'] .= ' , ' .$params['join_table_alias'] . '.created_by ' .  $field . '_owner';
3259                                                         }
3260                                                         $ret_array['select'] .= "  , '".$rel_module  ."' " .  $field . '_mod';
3261
3262                                                 }
3263                                         }
3264                                 }
3265                                 //Replace references to this table in the where clause with the new alias
3266                                 $join_table_name = $this->$data['link']->getRelatedTableName();
3267                                 // To fix SOAP stuff where we are trying to retrieve all the accounts data where accounts.id = ..
3268                                 // and this code changes accounts to jt4 as there is a self join with the accounts table.
3269                             //Martin fix #27494
3270                                         if(isset($data['db_concat_fields'])){
3271                                                 $db_field = $db_field = db_concat($params['join_table_alias'], $data['db_concat_fields']);
3272                                                 $where = preg_replace('/'.$data['name'].'/', $db_field, $where);
3273                                         }else{
3274                                                 $where = preg_replace('/(^|[\s(])' . $data['name'] . '/', '${1}' . $params['join_table_alias'] . '.'.$data['rname'], $where);
3275                         /**
3276                          * Bug #39988 - Added the line below. create_export_query_relate_link_patch() in export_utils.php
3277                          *    generates a where clause that works for stock modules. They all have a
3278                          *    custom create_export_query function on the bean. However, the Basic() object calls this
3279                          *    function for it's export_query. So, we have to handle the where clause that comes in.
3280                          */
3281                                                 $where = preg_replace('/(^|[\s(])join_' . $data['name'] . '/', '${1}' . $params['join_table_alias'], $where);
3282                                         }
3283                                 if(!$table_joined)
3284                                 {
3285                                         $joined_tables[$params['join_table_alias']]=1;
3286                                         $joined_tables[$params['join_table_link_alias']]=1;
3287                                 }
3288
3289                                 $jtcount++;
3290                         }
3291                 }
3292         }
3293         if(!empty($filter))
3294         {
3295                 if(isset($this->field_defs['assigned_user_id']) && empty($selectedFields[$this->table_name.'.assigned_user_id']))
3296                 {
3297                         $ret_array['select'] .= ", $this->table_name.assigned_user_id ";
3298                 }
3299                 else if(isset($this->field_defs['created_by']) &&  empty($selectedFields[$this->table_name.'.created_by']))
3300                 {
3301                         $ret_array['select'] .= ", $this->table_name.created_by ";
3302                 }
3303                 if(isset($this->field_defs['system_id']) && empty($selectedFields[$this->table_name.'.system_id']))
3304                 {
3305                         $ret_array['select'] .= ", $this->table_name.system_id ";
3306                 }
3307
3308         }
3309         $where_auto = '1=1';
3310         if($show_deleted == 0)
3311         {
3312                 $where_auto = "$this->table_name.deleted=0";
3313         }else if($show_deleted == 1)
3314         {
3315                 $where_auto = "$this->table_name.deleted=1";
3316         }
3317         if($where != "")
3318                 $ret_array['where'] = " where ($where) AND $where_auto";
3319         else
3320                 $ret_array['where'] = " where $where_auto";
3321         if(!empty($order_by))
3322         {
3323                 //make call to process the order by clause
3324                 $ret_array['order_by'] = " ORDER BY ". $this->process_order_by($order_by, null);
3325         }
3326         if($singleSelect)
3327         {
3328                 unset($ret_array['secondary_where']);
3329                 unset($ret_array['secondary_from']);
3330                 unset($ret_array['secondary_select']);
3331         }
3332
3333         if($return_array)
3334         {
3335                 return $ret_array;
3336         }
3337
3338         return  $ret_array['select'] . $ret_array['from'] . $ret_array['where']. $ret_array['order_by'];
3339
3340
3341
3342
3343     }
3344     /**
3345      * Returns parent record data for objects that store relationship information
3346      *
3347      * @param array $type_info
3348      *
3349      * Interal function, do not override.
3350      */
3351     function retrieve_parent_fields($type_info)
3352     {
3353         $queries = array();
3354         global $beanList, $beanFiles;
3355         $templates = array();
3356         $parent_child_map = array();
3357         foreach($type_info as $children_info)
3358         {
3359                 foreach($children_info as $child_info)
3360                 {
3361                         if($child_info['type'] == 'parent')
3362                         {
3363                                 if(empty($templates[$child_info['parent_type']]))
3364                                 {
3365                                         //Test emails will have an invalid parent_type, don't try to load the non-existant parent bean
3366                                         if ($child_info['parent_type'] == 'test') {
3367                                             continue;
3368                                         }
3369                                         $class = $beanList[$child_info['parent_type']];
3370                                         // Added to avoid error below; just silently fail and write message to log
3371                                         if ( empty($beanFiles[$class]) ) {
3372                                             $GLOBALS['log']->error($this->object_name.'::retrieve_parent_fields() - cannot load class "'.$class.'", skip loading.');
3373                                             continue;
3374                                         }
3375                                         require_once($beanFiles[$class]);
3376                                         $templates[$child_info['parent_type']] = new $class();
3377                                 }
3378
3379                                 if(empty($queries[$child_info['parent_type']]))
3380                                 {
3381                                         $queries[$child_info['parent_type']] = "SELECT id ";
3382                                         $field_def = $templates[$child_info['parent_type']]->field_defs['name'];
3383                                         if(isset($field_def['db_concat_fields']))
3384                                         {
3385                                                 $queries[$child_info['parent_type']] .= ' , ' . db_concat($templates[$child_info['parent_type']]->table_name, $field_def['db_concat_fields']) . ' parent_name';
3386                                         }
3387                                         else
3388                                         {
3389                                                 $queries[$child_info['parent_type']] .= ' , name parent_name';
3390                                         }
3391                                         if(isset($templates[$child_info['parent_type']]->field_defs['assigned_user_id']))
3392                                         {
3393                                                 $queries[$child_info['parent_type']] .= ", assigned_user_id parent_name_owner , '{$child_info['parent_type']}' parent_name_mod";;
3394                                         }else if(isset($templates[$child_info['parent_type']]->field_defs['created_by']))
3395                                         {
3396                                                 $queries[$child_info['parent_type']] .= ", created_by parent_name_owner, '{$child_info['parent_type']}' parent_name_mod";
3397                                         }
3398                                         $queries[$child_info['parent_type']] .= " FROM " . $templates[$child_info['parent_type']]->table_name ." WHERE id IN ('{$child_info['parent_id']}'";
3399                                 }
3400                                 else
3401                                 {
3402                                         if(empty($parent_child_map[$child_info['parent_id']]))
3403                                         $queries[$child_info['parent_type']] .= " ,'{$child_info['parent_id']}'";
3404                                 }
3405                                 $parent_child_map[$child_info['parent_id']][] = $child_info['child_id'];
3406                         }
3407                 }
3408         }
3409         $results = array();
3410         foreach($queries as $query)
3411         {
3412                 $result = $this->db->query($query . ')');
3413                 while($row = $this->db->fetchByAssoc($result))
3414                 {
3415                         $results[$row['id']] = $row;
3416                 }
3417         }
3418
3419         $child_results = array();
3420         foreach($parent_child_map as $parent_key=>$parent_child)
3421         {
3422                 foreach($parent_child as $child)
3423                 {
3424                         if(isset( $results[$parent_key]))
3425                         {
3426                                 $child_results[$child] = $results[$parent_key];
3427                         }
3428                 }
3429         }
3430         return $child_results;
3431     }
3432
3433     /**
3434      * Processes the list query and return fetched row.
3435      *
3436      * Internal function, do not override.
3437      * @param string $query select query to be processed.
3438      * @param int $row_offset starting position
3439      * @param int $limit Optioanl, default -1
3440      * @param int $max_per_page Optional, default -1
3441      * @param string $where Optional, additional filter criteria.
3442      * @return array Fetched data
3443      */
3444     function process_list_query($query, $row_offset, $limit= -1, $max_per_page = -1, $where = '')
3445     {
3446         global $sugar_config;
3447         $db = &DBManagerFactory::getInstance('listviews');
3448         /**
3449                  * if the row_offset is set to 'end' go to the end of the list
3450                  */
3451         $toEnd = strval($row_offset) == 'end';
3452         $GLOBALS['log']->debug("process_list_query: ".$query);
3453         if($max_per_page == -1)
3454         {
3455                 $max_per_page   = $sugar_config['list_max_entries_per_page'];
3456         }
3457         // Check to see if we have a count query available.
3458         if(empty($sugar_config['disable_count_query']) || $toEnd)
3459         {
3460                 $count_query = $this->create_list_count_query($query);
3461                 if(!empty($count_query) && (empty($limit) || $limit == -1))
3462                 {
3463                         // We have a count query.  Run it and get the results.
3464                         $result = $db->query($count_query, true, "Error running count query for $this->object_name List: ");
3465                         $assoc = $db->fetchByAssoc($result);
3466                         if(!empty($assoc['c']))
3467                         {
3468                                 $rows_found = $assoc['c'];
3469                                 $limit = $sugar_config['list_max_entries_per_page'];
3470                         }
3471                         if( $toEnd)
3472                         {
3473                                 $row_offset = (floor(($rows_found -1) / $limit)) * $limit;
3474                         }
3475                 }
3476         }
3477         else
3478         {
3479                 if((empty($limit) || $limit == -1))
3480                 {
3481                         $limit = $max_per_page + 1;
3482                         $max_per_page = $limit;
3483                 }
3484
3485         }
3486
3487         if(empty($row_offset))
3488         {
3489                 $row_offset = 0;
3490         }
3491         if(!empty($limit) && $limit != -1 && $limit != -99)
3492         {
3493                 $result = $db->limitQuery($query, $row_offset, $limit,true,"Error retrieving $this->object_name list: ");
3494         }
3495         else
3496         {
3497                 $result = $db->query($query,true,"Error retrieving $this->object_name list: ");
3498         }
3499
3500         $list = Array();
3501
3502         if(empty($rows_found))
3503         {
3504                 $rows_found =  $db->getRowCount($result);
3505         }
3506
3507         $GLOBALS['log']->debug("Found $rows_found ".$this->object_name."s");
3508
3509         $previous_offset = $row_offset - $max_per_page;
3510         $next_offset = $row_offset + $max_per_page;
3511
3512         $class = get_class($this);
3513         if($rows_found != 0 or $db->dbType != 'mysql')
3514         {
3515                 //todo Bug? we should remove the magic number -99
3516                 //use -99 to return all
3517                 $index = $row_offset;
3518                 while ($max_per_page == -99 || ($index < $row_offset + $max_per_page))
3519                 {
3520
3521                         if(!empty($sugar_config['disable_count_query']))
3522                         {
3523                                 $row = $db->fetchByAssoc($result);
3524                         }
3525                         else
3526                         {
3527                                 $row = $db->fetchByAssoc($result, $index);
3528                         }
3529                         if (empty($row))
3530                         {
3531                                 break;
3532                         }
3533
3534                         //instantiate a new class each time. This is because php5 passes
3535                         //by reference by default so if we continually update $this, we will
3536                         //at the end have a list of all the same objects
3537                         $temp = new $class();
3538
3539                         foreach($this->field_defs as $field=>$value)
3540                         {
3541                                 if (isset($row[$field]))
3542                                 {
3543                                         $temp->$field = $row[$field];
3544                                         $owner_field = $field . '_owner';
3545                                         if(isset($row[$owner_field]))
3546                                         {
3547                                                 $temp->$owner_field = $row[$owner_field];
3548                                         }
3549
3550                                         $GLOBALS['log']->debug("$temp->object_name({$row['id']}): ".$field." = ".$temp->$field);
3551                                 }else if (isset($row[$this->table_name .'.'.$field]))
3552                                 {
3553                                         $temp->$field = $row[$this->table_name .'.'.$field];
3554                                 }
3555                                 else
3556                                 {
3557                                         $temp->$field = "";
3558                                 }
3559                         }
3560
3561                         $temp->check_date_relationships_load();
3562                         $temp->fill_in_additional_list_fields();
3563                                 if($temp->hasCustomFields()) $temp->custom_fields->fill_relationships();
3564                                 $temp->call_custom_logic("process_record");
3565
3566                         $list[] = $temp;
3567
3568                         $index++;
3569                 }
3570         }
3571         if(!empty($sugar_config['disable_count_query']) && !empty($limit))
3572         {
3573
3574                 $rows_found = $row_offset + count($list);
3575
3576                 unset($list[$limit - 1]);
3577                 if(!$toEnd)
3578                 {
3579                         $next_offset--;
3580                         $previous_offset++;
3581                 }
3582         }
3583         $response = Array();
3584         $response['list'] = $list;
3585         $response['row_count'] = $rows_found;
3586         $response['next_offset'] = $next_offset;
3587         $response['previous_offset'] = $previous_offset;
3588         $response['current_offset'] = $row_offset ;
3589         return $response;
3590     }
3591
3592         /**
3593          * Returns the number of rows that the given SQL query should produce
3594      *
3595      * Internal function, do not override.
3596      * @param string $query valid select  query
3597      * @param boolean $is_count_query Optional, Default false, set to true if passed query is a count query.
3598      * @return int count of rows found
3599          */
3600         function _get_num_rows_in_query($query, $is_count_query=false)
3601         {
3602                 $num_rows_in_query = 0;
3603                 if (!$is_count_query)
3604                 {
3605                         $count_query = SugarBean::create_list_count_query($query);
3606                 } else
3607                         $count_query=$query;
3608
3609                 $result = $this->db->query($count_query, true, "Error running count query for $this->object_name List: ");
3610                 $row_num = 0;
3611                 $row = $this->db->fetchByAssoc($result, $row_num);
3612                 while($row)
3613                 {
3614                         $num_rows_in_query += current($row);
3615                         $row_num++;
3616                         $row = $this->db->fetchByAssoc($result, $row_num);
3617                 }
3618
3619                 return $num_rows_in_query;
3620         }
3621
3622     /**
3623      * Applies pagination window to union queries used by list view and subpanels,
3624      * executes the query and returns fetched data.
3625      *
3626      * Internal function, do not override.
3627      * @param object $parent_bean
3628      * @param string $query query to be processed.
3629      * @param int $row_offset
3630      * @param int $limit optional, default -1
3631      * @param int $max_per_page Optional, default -1
3632      * @param string $where Custom where clause.
3633      * @param array $subpanel_def definition of sub-panel to be processed
3634      * @param string $query_row_count
3635      * @param array $seconday_queries
3636      * @return array Fetched data.
3637      */
3638     function process_union_list_query($parent_bean, $query,
3639     $row_offset, $limit= -1, $max_per_page = -1, $where = '', $subpanel_def, $query_row_count='', $secondary_queries = array())
3640
3641     {
3642                 $db = &DBManagerFactory::getInstance('listviews');
3643                 /**
3644                  * if the row_offset is set to 'end' go to the end of the list
3645                  */
3646                 $toEnd = strval($row_offset) == 'end';
3647                 global $sugar_config;
3648                 $use_count_query=false;
3649                 $processing_collection=$subpanel_def->isCollection();
3650
3651                 $GLOBALS['log']->debug("process_list_query: ".$query);
3652                 if($max_per_page == -1)
3653                 {
3654                         $max_per_page   = $sugar_config['list_max_entries_per_subpanel'];
3655                 }
3656                 if(empty($query_row_count))
3657                 {
3658                         $query_row_count = $query;
3659                 }
3660                 $distinct_position=strpos($query_row_count,"DISTINCT");
3661
3662                 if ($distinct_position!= false)
3663                 {
3664                         $use_count_query=true;
3665                 }
3666                 $performSecondQuery = true;
3667                 if(empty($sugar_config['disable_count_query']) || $toEnd)
3668                 {
3669                         $rows_found = $this->_get_num_rows_in_query($query_row_count,$use_count_query);
3670                         if($rows_found < 1)
3671                         {
3672                                 $performSecondQuery = false;
3673                         }
3674                         if(!empty($rows_found) && (empty($limit) || $limit == -1))
3675                         {
3676                                 $limit = $sugar_config['list_max_entries_per_subpanel'];
3677                         }
3678                         if( $toEnd)
3679                         {
3680                                 $row_offset = (floor(($rows_found -1) / $limit)) * $limit;
3681
3682                         }
3683                 }
3684                 else
3685                 {
3686                         if((empty($limit) || $limit == -1))
3687                         {
3688                                 $limit = $max_per_page + 1;
3689                                 $max_per_page = $limit;
3690                         }
3691                 }
3692
3693                 if(empty($row_offset))
3694                 {
3695                         $row_offset = 0;
3696                 }
3697                 $list = array();
3698                 $previous_offset = $row_offset - $max_per_page;
3699                 $next_offset = $row_offset + $max_per_page;
3700
3701                 if($performSecondQuery)
3702                 {
3703                         if(!empty($limit) && $limit != -1 && $limit != -99)
3704                         {
3705                                 $result = $db->limitQuery($query, $row_offset, $limit,true,"Error retrieving $parent_bean->object_name list: ");
3706                         }
3707                         else
3708                         {
3709                                 $result = $db->query($query,true,"Error retrieving $this->object_name list: ");
3710                         }
3711                         if(empty($rows_found))
3712                         {
3713                                 $rows_found =  $db->getRowCount($result);
3714                         }
3715
3716                         $GLOBALS['log']->debug("Found $rows_found ".$parent_bean->object_name."s");
3717                         if($rows_found != 0 or $db->dbType != 'mysql')
3718                         {
3719                                 //use -99 to return all
3720
3721                                 // get the current row
3722                                 $index = $row_offset;
3723                                 if(!empty($sugar_config['disable_count_query']))
3724                                 {
3725                                         $row = $db->fetchByAssoc($result);
3726                                 }
3727                                 else
3728                                 {
3729                                         $row = $db->fetchByAssoc($result, $index);
3730                                 }
3731
3732                                 $post_retrieve = array();
3733                                 $isFirstTime = true;
3734                                 while($row)
3735                                 {
3736                                         $function_fields = array();
3737                                         if(($index < $row_offset + $max_per_page || $max_per_page == -99) or ($db->dbType != 'mysql'))
3738                                         {
3739                                                 if ($processing_collection)
3740                                                 {
3741                                                         $current_bean =$subpanel_def->sub_subpanels[$row['panel_name']]->template_instance;
3742                                                         if(!$isFirstTime)
3743                                                         {
3744                                                                 $class = get_class($subpanel_def->sub_subpanels[$row['panel_name']]->template_instance);
3745                                                                 $current_bean = new $class();
3746                                                         }
3747                                                 } else {
3748                                                         $current_bean=$subpanel_def->template_instance;
3749                                                         if(!$isFirstTime)
3750                                                         {
3751                                                                 $class = get_class($subpanel_def->template_instance);
3752                                                                 $current_bean = new $class();
3753                                                         }
3754                                                 }
3755                                                 $isFirstTime = false;
3756                                                 //set the panel name in the bean instance.
3757                                                 if (isset($row['panel_name']))
3758                                                 {
3759                                                         $current_bean->panel_name=$row['panel_name'];
3760                                                 }
3761                                                 foreach($current_bean->field_defs as $field=>$value)
3762                                                 {
3763
3764                                                         if (!empty($row[$field]))
3765                                                         {
3766                                                                 $current_bean->$field = $row[$field];
3767
3768                                                                 unset($row[$field]);
3769                                                                 //$GLOBALS['log']->debug("$current_bean->object_name({$row['id']}): ".$field." = ".$current_bean->$field);
3770                                                         }
3771                                                         else if (!empty($row[$this->table_name .'.'.$field]))
3772                                                         {
3773                                                                 $current_bean->$field = $row[$current_bean->table_name .'.'.$field];
3774                                                                 unset($row[$current_bean->table_name .'.'.$field]);
3775                                                         }
3776                                                         else
3777                                                         {
3778                                                                 $current_bean->$field = "";
3779                                                                 unset($row[$field]);
3780                                                         }
3781                                                         if(isset($value['source']) && $value['source'] == 'function')
3782                                                         {
3783                                                                 $function_fields[]=$field;
3784                                                         }
3785                                                 }
3786                                                 foreach($row as $key=>$value)
3787                                                 {
3788                                                         $current_bean->$key = $value;
3789                                                 }
3790                                                 foreach($function_fields as $function_field)
3791                                                 {
3792                                                         $value = $current_bean->field_defs[$function_field];
3793                                                         $can_execute = true;
3794                                                         $execute_params = array();
3795                                                         $execute_function = array();
3796                                                         if(!empty($value['function_class']))
3797                                                         {
3798                                                                 $execute_function[] =   $value['function_class'];
3799                                                                 $execute_function[] =   $value['function_name'];
3800                                                         }
3801                                                         else
3802                                                         {
3803                                                                 $execute_function       = $value['function_name'];
3804                                                         }
3805                                                         foreach($value['function_params'] as $param )
3806                                                         {
3807                                                                 if (empty($value['function_params_source']) or $value['function_params_source']=='parent')
3808                                                                 {
3809                                                                         if(empty($this->$param))
3810                                                                         {
3811                                                                                 $can_execute = false;
3812                                                                         }
3813                                                                         else
3814                                                                         {
3815                                                                                 $execute_params[] = $this->$param;
3816                                                                         }
3817                                                                 } else if ($value['function_params_source']=='this')
3818                                                                 {
3819                                                                         if(empty($current_bean->$param))
3820                                                                         {
3821                                                                                 $can_execute = false;
3822                                                                         }
3823                                                                         else
3824                                                                         {
3825                                                                                 $execute_params[] = $current_bean->$param;
3826                                                                         }
3827                                                                 }
3828                                                                 else
3829                                                                 {
3830                                                                         $can_execute = false;
3831                                                                 }
3832
3833                                                         }
3834                                                         if($can_execute)
3835                                                         {
3836                                                                 if(!empty($value['function_require']))
3837                                                                 {
3838                                                                         require_once($value['function_require']);
3839                                                                 }
3840                                                                 $current_bean->$function_field = call_user_func_array($execute_function, $execute_params);
3841                                                         }
3842                                                 }
3843                                                 if(!empty($current_bean->parent_type) && !empty($current_bean->parent_id))
3844                                                 {
3845                                                         if(!isset($post_retrieve[$current_bean->parent_type]))
3846                                                         {
3847                                                                 $post_retrieve[$current_bean->parent_type] = array();
3848                                                         }
3849                                                         $post_retrieve[$current_bean->parent_type][] = array('child_id'=>$current_bean->id, 'parent_id'=> $current_bean->parent_id, 'parent_type'=>$current_bean->parent_type, 'type'=>'parent');
3850                                                 }
3851                                                 //$current_bean->fill_in_additional_list_fields();
3852                                                 $list[$current_bean->id] = $current_bean;
3853                                         }
3854                                         // go to the next row
3855                                         $index++;
3856                                         $row = $db->fetchByAssoc($result, $index);
3857                                 }
3858                         }
3859                         //now handle retrieving many-to-many relationships
3860                         if(!empty($list))
3861                         {
3862                                 foreach($secondary_queries as $query2)
3863                                 {
3864                                         $result2 = $db->query($query2);
3865
3866                                         $row2 = $db->fetchByAssoc($result2);
3867                                         while($row2)
3868                                         {
3869                                                 $id_ref = $row2['ref_id'];
3870
3871                                                 if(isset($list[$id_ref]))
3872                                                 {
3873                                                         foreach($row2 as $r2key=>$r2value)
3874                                                         {
3875                                                                 if($r2key != 'ref_id')
3876                                                                 {
3877                                                                         $list[$id_ref]->$r2key = $r2value;
3878                                                                 }
3879                                                         }
3880                                                 }
3881                                                 $row2 = $db->fetchByAssoc($result2);
3882                                         }
3883                                 }
3884
3885                         }
3886
3887                         if(isset($post_retrieve))
3888                         {
3889                                 $parent_fields = $this->retrieve_parent_fields($post_retrieve);
3890                         }
3891                         else
3892                         {
3893                                 $parent_fields = array();
3894                         }
3895                         if(!empty($sugar_config['disable_count_query']) && !empty($limit))
3896                         {
3897                                 $rows_found = $row_offset + count($list);
3898                                 if(count($list) >= $limit)
3899                                 {
3900                                         array_pop($list);
3901                                 }
3902                                 if(!$toEnd)
3903                                 {
3904                                         $next_offset--;
3905                                         $previous_offset++;
3906                                 }
3907                         }
3908                 }
3909                 else
3910                 {
3911                         $row_found      = 0;
3912                         $parent_fields = array();
3913                 }
3914                 $response = array();
3915                 $response['list'] = $list;
3916                 $response['parent_data'] = $parent_fields;
3917                 $response['row_count'] = $rows_found;
3918                 $response['next_offset'] = $next_offset;
3919                 $response['previous_offset'] = $previous_offset;
3920                 $response['current_offset'] = $row_offset ;
3921                 $response['query'] = $query;
3922
3923                 return $response;
3924     }
3925
3926     /**
3927      * Applies pagination window to select queries used by detail view,
3928      * executes the query and returns fetched data.
3929      *
3930      * Internal function, do not override.
3931      * @param string $query query to be processed.
3932      * @param int $row_offset
3933      * @param int $limit optional, default -1
3934      * @param int $max_per_page Optional, default -1
3935      * @param string $where Custom where clause.
3936      * @param int $offset Optional, default 0
3937      * @return array Fetched data.
3938      *
3939      */
3940     function process_detail_query($query, $row_offset, $limit= -1, $max_per_page = -1, $where = '', $offset = 0)
3941     {
3942         global $sugar_config;
3943         $GLOBALS['log']->debug("process_list_query: ".$query);
3944         if($max_per_page == -1)
3945         {
3946                 $max_per_page   = $sugar_config['list_max_entries_per_page'];
3947         }
3948
3949         // Check to see if we have a count query available.
3950         $count_query = $this->create_list_count_query($query);
3951
3952         if(!empty($count_query) && (empty($limit) || $limit == -1))
3953         {
3954                 // We have a count query.  Run it and get the results.
3955                 $result = $this->db->query($count_query, true, "Error running count query for $this->object_name List: ");
3956                 $assoc = $this->db->fetchByAssoc($result);
3957                 if(!empty($assoc['c']))
3958                 {
3959                         $total_rows = $assoc['c'];
3960                 }
3961         }
3962
3963         if(empty($row_offset))
3964         {
3965                 $row_offset = 0;
3966         }
3967
3968         $result = $this->db->limitQuery($query, $offset, 1, true,"Error retrieving $this->object_name list: ");
3969
3970         $rows_found = $this->db->getRowCount($result);
3971
3972         $GLOBALS['log']->debug("Found $rows_found ".$this->object_name."s");
3973
3974         $previous_offset = $row_offset - $max_per_page;
3975         $next_offset = $row_offset + $max_per_page;
3976
3977         if($rows_found != 0 or $this->db->dbType != 'mysql')
3978         {
3979                 $index = 0;
3980                 $row = $this->db->fetchByAssoc($result, $index);
3981                 $this->retrieve($row['id']);
3982         }
3983
3984         $response = Array();
3985         $response['bean'] = $this;
3986         if (empty($total_rows))
3987                 $total_rows=0;
3988         $response['row_count'] = $total_rows;
3989         $response['next_offset'] = $next_offset;
3990         $response['previous_offset'] = $previous_offset;
3991
3992         return $response;
3993     }
3994
3995     /**
3996      * Processes fetched list view data
3997      *
3998      * Internal function, do not override.
3999      * @param string $query query to be processed.
4000      * @param boolean $check_date Optional, default false. if set to true date time values are processed.
4001      * @return array Fetched data.
4002      *
4003      */
4004     function process_full_list_query($query, $check_date=false)
4005     {
4006
4007         $GLOBALS['log']->debug("process_full_list_query: query is ".$query);
4008         $result = $this->db->query($query, false);
4009         $GLOBALS['log']->debug("process_full_list_query: result is ".print_r($result,true));
4010         $class = get_class($this);
4011         $isFirstTime = true;
4012         $bean = new $class();
4013
4014         //if($this->db->getRowCount($result) > 0){
4015
4016
4017         // We have some data.
4018         //while ($row = $this->db->fetchByAssoc($result)) {
4019         while (($row = $bean->db->fetchByAssoc($result)) != null)
4020         {
4021                 if(!$isFirstTime)
4022                 {
4023                         $bean = new $class();
4024                 }
4025                 $isFirstTime = false;
4026
4027                 foreach($bean->field_defs as $field=>$value)
4028                 {
4029                         if (isset($row[$field]))
4030                         {
4031                                 $bean->$field = $row[$field];
4032                                 $GLOBALS['log']->debug("process_full_list: $bean->object_name({$row['id']}): ".$field." = ".$bean->$field);
4033                         }
4034                         else
4035                         {
4036                                 $bean->$field = '';
4037                         }
4038                 }
4039                 if($check_date)
4040                 {
4041                         $bean->processed_dates_times = array();
4042                         $bean->check_date_relationships_load();
4043                 }
4044                 $bean->fill_in_additional_list_fields();
4045                         $bean->call_custom_logic("process_record");
4046
4047                 $list[] = $bean;
4048         }
4049         //}
4050         if (isset($list)) return $list;
4051         else return null;
4052     }
4053
4054         /**
4055         * Tracks the viewing of a detail record.
4056         * This leverages get_summary_text() which is object specific.
4057     *
4058     * Internal function, do not override.
4059         * @param $user_id - String value of the user that is viewing the record.
4060     * @param $current_module - String value of the module being processed.
4061     * @param $current_view - String value of the current view
4062         */
4063         function track_view($user_id, $current_module, $current_view='')
4064         {
4065             $trackerManager = TrackerManager::getInstance();
4066                 if($monitor = $trackerManager->getMonitor('tracker')){
4067                 $monitor->setValue('date_modified', gmdate($GLOBALS['timedate']->get_db_date_time_format()));
4068                 $monitor->setValue('user_id', $user_id);
4069                 $monitor->setValue('module_name', $current_module);
4070                 $monitor->setValue('action', $current_view);
4071                 $monitor->setValue('item_id', $this->id);
4072                 $monitor->setValue('item_summary', $this->get_summary_text());
4073                 $monitor->setValue('visible',true);
4074                 $trackerManager->saveMonitor($monitor);
4075                 }
4076         }
4077
4078         /**
4079         * Returns the summary text that should show up in the recent history list for this object.
4080     *
4081     * Internal function, do not override.
4082         */
4083         function get_summary_text()
4084         {
4085                 return "Base Implementation.  Should be overridden.";
4086         }
4087
4088         /**
4089         * This is designed to be overridden and add specific fields to each record.
4090         * This allows the generic query to fill in the major fields, and then targeted
4091         * queries to get related fields and add them to the record.  The contact's
4092         * account for instance.  This method is only used for populating extra fields
4093         * in lists.
4094         */
4095         function fill_in_additional_list_fields(){
4096                 if(!empty($this->field_defs['parent_name']) && empty($this->parent_name)){
4097                         $this->fill_in_additional_parent_fields();
4098                 }
4099         }
4100
4101         /**
4102         * This is designed to be overridden and add specific fields to each record.
4103         * This allows the generic query to fill in the major fields, and then targeted
4104         * queries to get related fields and add them to the record.  The contact's
4105         * account for instance.  This method is only used for populating extra fields
4106         * in the detail form
4107         */
4108         function fill_in_additional_detail_fields()
4109         {
4110                 if(!empty($this->field_defs['assigned_user_name']) && !empty($this->assigned_user_id)){
4111
4112                         $this->assigned_user_name = get_assigned_user_name($this->assigned_user_id);
4113
4114                 }
4115                 if(!empty($this->field_defs['created_by']) && !empty($this->created_by))
4116                 $this->created_by_name = get_assigned_user_name($this->created_by);
4117                 if(!empty($this->field_defs['modified_user_id']) && !empty($this->modified_user_id))
4118                 $this->modified_by_name = get_assigned_user_name($this->modified_user_id);
4119
4120                 if(!empty($this->field_defs['parent_name'])){
4121                         $this->fill_in_additional_parent_fields();
4122                 }
4123         }
4124
4125         /**
4126          * This is desgined to be overridden or called from extending bean. This method
4127          * will fill in any parent_name fields.
4128          */
4129         function fill_in_additional_parent_fields() {
4130
4131                 if(!empty($this->parent_id) && !empty($this->last_parent_id) && $this->last_parent_id == $this->parent_id){
4132                         return false;
4133                 }else{
4134                         $this->parent_name = '';
4135                 }
4136                 if(!empty($this->parent_type)) {
4137                         $this->last_parent_id = $this->parent_id;
4138                         $this->getRelatedFields($this->parent_type, $this->parent_id, array('name'=>'parent_name', 'document_name' => 'parent_document_name', 'first_name'=>'parent_first_name', 'last_name'=>'parent_last_name'));
4139                         if(!empty($this->parent_first_name) || !empty($this->parent_last_name) ){
4140                                 $this->parent_name = $GLOBALS['locale']->getLocaleFormattedName($this->parent_first_name, $this->parent_last_name);
4141                         } else if(!empty($this->parent_document_name)){
4142                                 $this->parent_name = $this->parent_document_name;
4143                         }
4144                 }
4145         }
4146
4147 /*
4148      * Fill in a link field
4149      */
4150
4151     function fill_in_link_field( $linkFieldName )
4152     {
4153         if ($this->load_relationship($linkFieldName))
4154         {
4155             $list=$this->$linkFieldName->get();
4156             $this->$linkFieldName = '' ; // match up with null value in $this->populateFromRow()
4157             if (!empty($list))
4158                 $this->$linkFieldName = $list[0];
4159         }
4160     }
4161
4162         /**
4163          * Fill in fields where type = relate
4164          */
4165     function fill_in_relationship_fields(){
4166                 if(!empty($this->relDepth)) {
4167                         if($this->relDepth > 1)return;
4168                 }else $this->relDepth = 0;
4169
4170         foreach($this->field_defs as $field)
4171         {
4172             if(0 == strcmp($field['type'],'relate') && !empty($field['module']))
4173             {
4174                 $name = $field['name'];
4175                 if(empty($this->$name))
4176                 {
4177                     // set the value of this relate field in this bean ($this->$field['name']) to the value of the 'name' field in the related module for the record identified by the value of $this->$field['id_name']
4178                     $related_module = $field['module'];
4179                     $id_name = $field['id_name'];
4180                     if (empty($this->$id_name)){
4181                        $this->fill_in_link_field($id_name);
4182                     }
4183                         if(!empty($this->$id_name) && ( $this->object_name != $related_module || ( $this->object_name == $related_module && $this->$id_name != $this->id ))){
4184                                 if(isset($GLOBALS['beanList'][ $related_module])){
4185                                 $class = $GLOBALS['beanList'][$related_module];
4186
4187                                 if(!empty($this->$id_name) && file_exists($GLOBALS['beanFiles'][$class]) && isset($this->$name)){
4188                                         require_once($GLOBALS['beanFiles'][$class]);
4189                                                                 $mod = new $class();
4190                                         $mod->relDepth = $this->relDepth + 1;
4191                                         $mod->retrieve($this->$id_name);
4192                                 if (!empty($field['rname'])) {
4193                                     $this->$name = $mod->$field['rname'];
4194                                 } else if (isset($mod->name)) {
4195                                                 $this->$name = $mod->name;
4196                                         }
4197                                 }
4198                             }
4199                     }
4200                     if(!empty($this->$id_name) && isset($this->$name))
4201                     {
4202                         if(!isset($field['additionalFields']))
4203                            $field['additionalFields'] = array();
4204                         if(!empty($field['rname']))
4205                         {
4206                             $field['additionalFields'][$field['rname']]= $name;
4207                         }
4208                         else
4209                         {
4210                             $field['additionalFields']['name']= $name;
4211                         }
4212                         $this->getRelatedFields($related_module, $this->$id_name, $field['additionalFields']);
4213                     }
4214                 }
4215             }
4216         }
4217     }
4218
4219         /**
4220         * This is a helper function that is used to quickly created indexes when creating tables.
4221         */
4222         function create_index($query)
4223         {
4224                 $GLOBALS['log']->info($query);
4225
4226                 $result = $this->db->query($query, true, "Error creating index:");
4227         }
4228
4229         /**
4230      * This function should be overridden in each module.  It marks an item as deleted.
4231      *
4232      * If it is not overridden, then marking this type of item is not allowed
4233          */
4234         function mark_deleted($id)
4235         {
4236                 global $current_user;
4237                 $date_modified = gmdate($GLOBALS['timedate']->get_db_date_time_format());
4238                 if(isset($_SESSION['show_deleted']))
4239                 {
4240                         $this->mark_undeleted($id);
4241                 }
4242                 else
4243                 {
4244                         // call the custom business logic
4245                         $custom_logic_arguments['id'] = $id;
4246                         $this->call_custom_logic("before_delete", $custom_logic_arguments);
4247
4248                         if ( isset($this->field_defs['modified_user_id']) ) {
4249                 if (!empty($current_user)) {
4250                     $this->modified_user_id = $current_user->id;
4251                 } else {
4252                     $this->modified_user_id = 1;
4253                 }
4254                 $query = "UPDATE $this->table_name set deleted=1 , date_modified = '$date_modified', modified_user_id = '$this->modified_user_id' where id='$id'";
4255                         } else
4256                 $query = "UPDATE $this->table_name set deleted=1 , date_modified = '$date_modified' where id='$id'";
4257                         $this->db->query($query, true,"Error marking record deleted: ");
4258                         $this->mark_relationships_deleted($id);
4259
4260                         // Take the item off the recently viewed lists
4261                         $tracker = new Tracker();
4262                         $tracker->makeInvisibleForAll($id);
4263
4264                         // call the custom business logic
4265                         $this->call_custom_logic("after_delete", $custom_logic_arguments);
4266                 }
4267         }
4268
4269         /**
4270      * Restores data deleted by call to mark_deleted() function.
4271      *
4272      * Internal function, do not override.
4273          */
4274         function mark_undeleted($id)
4275         {
4276                 // call the custom business logic
4277                 $custom_logic_arguments['id'] = $id;
4278                 $this->call_custom_logic("before_restore", $custom_logic_arguments);
4279
4280                 $date_modified = gmdate($GLOBALS['timedate']->get_db_date_time_format());
4281                 $query = "UPDATE $this->table_name set deleted=0 , date_modified = '$date_modified' where id='$id'";
4282                 $this->db->query($query, true,"Error marking record undeleted: ");
4283
4284                 // call the custom business logic
4285                 $this->call_custom_logic("after_restore", $custom_logic_arguments);
4286         }
4287
4288    /**
4289     * This function deletes relationships to this object.  It should be overridden
4290     * to handle the relationships of the specific object.
4291         * This function is called when the item itself is being deleted.
4292     *
4293     * @param int $id id of the relationship to delete
4294         */
4295    function mark_relationships_deleted($id)
4296    {
4297         $this->delete_linked($id);
4298    }
4299
4300         /**
4301         * This function is used to execute the query and create an array template objects
4302         * from the resulting ids from the query.
4303         * It is currently used for building sub-panel arrays.
4304     *
4305         * @param string $query - the query that should be executed to build the list
4306         * @param object $template - The object that should be used to copy the records.
4307     * @param int $row_offset Optional, default 0
4308     * @param int $limit Optional, default -1
4309     * @return array
4310         */
4311         function build_related_list($query, &$template, $row_offset = 0, $limit = -1)
4312         {
4313                 $GLOBALS['log']->debug("Finding linked records $this->object_name: ".$query);
4314                 $db = &DBManagerFactory::getInstance('listviews');
4315
4316                 if(!empty($row_offset) && $row_offset != 0 && !empty($limit) && $limit != -1)
4317                 {
4318                         $result = $db->limitQuery($query, $row_offset, $limit,true,"Error retrieving $template->object_name list: ");
4319                 }
4320                 else
4321                 {
4322                         $result = $db->query($query, true);
4323                 }
4324
4325                 $list = Array();
4326                 $isFirstTime = true;
4327                 $class = get_class($template);
4328                 while($row = $this->db->fetchByAssoc($result))
4329                 {
4330                         if(!$isFirstTime)
4331                         {
4332                                 $template = new $class();
4333                         }
4334                         $isFirstTime = false;
4335                         $record = $template->retrieve($row['id']);
4336
4337                         if($record != null)
4338                         {
4339                                 // this copies the object into the array
4340                                 $list[] = $template;
4341                         }
4342                 }
4343                 return $list;
4344         }
4345
4346   /**
4347         * This function is used to execute the query and create an array template objects
4348         * from the resulting ids from the query.
4349         * It is currently used for building sub-panel arrays. It supports an additional
4350         * where clause that is executed as a filter on the results
4351         *
4352         * @param string $query - the query that should be executed to build the list
4353         * @param object $template - The object that should be used to copy the records.
4354         */
4355   function build_related_list_where($query, &$template, $where='', $in='', $order_by, $limit='', $row_offset = 0)
4356   {
4357         $db = &DBManagerFactory::getInstance('listviews');
4358         // No need to do an additional query
4359         $GLOBALS['log']->debug("Finding linked records $this->object_name: ".$query);
4360         if(empty($in) && !empty($query))
4361         {
4362                 $idList = $this->build_related_in($query);
4363                 $in = $idList['in'];
4364         }
4365         // MFH - Added Support For Custom Fields in Searches
4366         $custom_join="";
4367         if(isset($this->custom_fields)) {
4368                 $custom_join = $this->custom_fields->getJOIN();
4369         }
4370
4371         $query = "SELECT id ";
4372
4373         if (!empty($custom_join)) {
4374                 $query .= $custom_join['select'];
4375         }
4376     $query .= " FROM $this->table_name ";
4377
4378     if (!empty($custom_join) && !empty($custom_join['join'])) {
4379         $query .= " " . $custom_join['join'];
4380     }
4381
4382     $query .= " WHERE deleted=0 AND id IN $in";
4383         if(!empty($where))
4384         {
4385                 $query .= " AND $where";
4386         }
4387
4388
4389         if(!empty($order_by))
4390         {
4391                 $query .= "ORDER BY $order_by";
4392         }
4393         if (!empty($limit))
4394         {
4395                 $result = $db->limitQuery($query, $row_offset, $limit,true,"Error retrieving $this->object_name list: ");
4396         }
4397         else
4398         {
4399                 $result = $db->query($query, true);
4400         }
4401
4402         $list = Array();
4403         $isFirstTime = true;
4404         $class = get_class($template);
4405
4406         $disable_security_flag = ($template->disable_row_level_security) ? true : false;
4407         while($row = $db->fetchByAssoc($result))
4408         {
4409                 if(!$isFirstTime)
4410                 {
4411                         $template = new $class();
4412                         $template->disable_row_level_security = $disable_security_flag;
4413                 }
4414                 $isFirstTime = false;
4415                 $record = $template->retrieve($row['id']);
4416                 if($record != null)
4417                 {
4418                         // this copies the object into the array
4419                         $list[] = $template;
4420                 }
4421         }
4422
4423         return $list;
4424   }
4425
4426     /**
4427      * Constructs an comma seperated list of ids from passed query results.
4428      *
4429      * @param string @query query to be executed.
4430      *
4431      */
4432     function build_related_in($query)
4433     {
4434         $idList = array();
4435         $result = $this->db->query($query, true);
4436         $ids = '';
4437         while($row = $this->db->fetchByAssoc($result))
4438         {
4439             $idList[] = $row['id'];
4440             if(empty($ids))
4441             {
4442                 $ids = "('" . $row['id'] . "'";
4443             }
4444             else
4445             {
4446                 $ids .= ",'" . $row['id'] . "'";
4447             }
4448         }
4449         if(empty($ids))
4450         {
4451             $ids = "('')";
4452         }else{
4453             $ids .= ')';
4454         }
4455
4456         return array('list'=>$idList, 'in'=>$ids);
4457     }
4458
4459     /**
4460     * Optionally copies values from fetched row into the bean.
4461     *
4462     * Internal function, do not override.
4463     *
4464     * @param string $query - the query that should be executed to build the list
4465     * @param object $template - The object that should be used to copy the records
4466     * @param array $field_list List of  fields.
4467     * @return array
4468     */
4469     function build_related_list2($query, &$template, &$field_list)
4470     {
4471         $GLOBALS['log']->debug("Finding linked values $this->object_name: ".$query);
4472
4473         $result = $this->db->query($query, true);
4474
4475         $list = Array();
4476         $isFirstTime = true;
4477         $class = get_class($template);
4478         while($row = $this->db->fetchByAssoc($result))
4479         {
4480                 // Create a blank copy
4481                 $copy = $template;
4482                 if(!$isFirstTime)
4483                 {
4484                         $copy = new $class();
4485                 }
4486                 $isFirstTime = false;
4487                 foreach($field_list as $field)
4488                 {
4489                         // Copy the relevant fields
4490                         $copy->$field = $row[$field];
4491
4492                 }
4493
4494                 // this copies the object into the array
4495                 $list[] = $copy;
4496         }
4497
4498         return $list;
4499     }
4500
4501         /**
4502      * Let implementing classes to fill in row specific columns of a list view form
4503      *
4504      */
4505         function list_view_parse_additional_sections(&$list_form)
4506         {
4507         }
4508
4509         /**
4510      * Assigns all of the values into the template for the list view
4511      */
4512         function get_list_view_array()
4513         {
4514         static $cache = array();
4515                 // cn: bug 12270 - sensitive fields being passed arbitrarily in listViews
4516                 $sensitiveFields = array('user_hash' => '');
4517
4518                 $return_array = Array();
4519                 global $app_list_strings, $mod_strings;
4520                 foreach($this->field_defs as $field=>$value){
4521
4522                         if(isset($this->$field)){
4523
4524                                 // cn: bug 12270 - sensitive fields being passed arbitrarily in listViews
4525                                 if(isset($sensitiveFields[$field]))
4526                                         continue;
4527                 if(!isset($cache[$field]))
4528                         $cache[$field] = strtoupper($field);
4529
4530                 //Fields hidden by Dependent Fields
4531                 if (isset($value['hidden']) && $value['hidden'] === true) {
4532                         $return_array[$cache[$field]] = "";
4533                 }
4534                                 //cn: if $field is a _dom, detect and return VALUE not KEY
4535                                 //cl: empty function check for meta-data enum types that have values loaded from a function
4536                                 else if (((!empty($value['type']) && ($value['type'] == 'enum' || $value['type'] == 'radioenum') ))  && empty($value['function'])){
4537                                         if(!empty($app_list_strings[$value['options']][$this->$field])){
4538                                                 $return_array[$cache[$field]] = $app_list_strings[$value['options']][$this->$field];
4539                                         }
4540                                         //nsingh- bug 21672. some modules such as manufacturers, Releases do not have a listing for select fields in the $app_list_strings. Must also check $mod_strings to localize.
4541                                         elseif(!empty($mod_strings[$value['options']][$this->$field]))
4542                                         {
4543                                                 $return_array[$cache[$field]] = $mod_strings[$value['options']][$this->$field];
4544                                         }
4545                                         else{
4546                                                 $return_array[$cache[$field]] = $this->$field;
4547                                         }
4548                                         //end bug 21672
4549 // tjy: no need to do this str_replace as the changes in 29994 for ListViewGeneric.tpl for translation handle this now
4550 //                              }elseif(!empty($value['type']) && $value['type'] == 'multienum'&& empty($value['function'])){
4551 //                                      $return_array[strtoupper($field)] = str_replace('^,^', ', ', $this->$field );
4552                                 }elseif(!empty($value['custom_module']) && $value['type'] != 'currency'){
4553 //                                      $this->format_field($value);
4554                                         $return_array[$cache[$field]] = $this->$field;
4555                                 }else{
4556                                         $return_array[$cache[$field]] = $this->$field;
4557                                 }
4558                                 // handle "Assigned User Name"
4559                                 if($field == 'assigned_user_name'){
4560                                         $return_array['ASSIGNED_USER_NAME'] = get_assigned_user_name($this->assigned_user_id);
4561                                 }
4562                         }
4563                 }
4564                 return $return_array;
4565         }
4566     /**
4567      * Override this function to set values in the array used to render list view data.
4568      *
4569      */
4570     function get_list_view_data()
4571     {
4572         return $this->get_list_view_array();
4573     }
4574
4575     /**
4576      * Construct where clause from a list of name-value pairs.
4577      *
4578      */
4579     function get_where(&$fields_array)
4580     {
4581         $where_clause = "WHERE ";
4582         $first = 1;
4583         foreach ($fields_array as $name=>$value)
4584         {
4585                 if ($first)
4586                 {
4587                         $first = 0;
4588                 }
4589                 else
4590                 {
4591                         $where_clause .= " AND ";
4592                 }
4593
4594                 $where_clause .= "$name = '".$this->db->quote($value,false)."'";
4595         }
4596         $where_clause .= " AND deleted=0";
4597         return $where_clause;
4598     }
4599
4600
4601     /**
4602      * Constructs a select query and fetch 1 row using this query, and then process the row
4603      *
4604      * Internal function, do not override.
4605      * @param array @fields_array  array of name value pairs used to construct query.
4606      * @param boolean $encode Optional, default true, encode fetched data.
4607      * @return object Instance of this bean with fetched data.
4608      */
4609     function retrieve_by_string_fields($fields_array, $encode=true)
4610     {
4611         $where_clause = $this->get_where($fields_array);
4612         if(isset($this->custom_fields))
4613         $custom_join = $this->custom_fields->getJOIN();
4614         else $custom_join = false;
4615         if($custom_join)
4616         {
4617                 $query = "SELECT $this->table_name.*". $custom_join['select']. " FROM $this->table_name " . $custom_join['join'];
4618         }
4619         else
4620         {
4621                 $query = "SELECT $this->table_name.* FROM $this->table_name ";
4622         }
4623         $query .= " $where_clause";
4624         $GLOBALS['log']->debug("Retrieve $this->object_name: ".$query);
4625         //requireSingleResult has beeen deprecated.
4626         //$result = $this->db->requireSingleResult($query, true, "Retrieving record $where_clause:");
4627         $result = $this->db->limitQuery($query,0,1,true, "Retrieving record $where_clause:");
4628
4629
4630         if( empty($result))
4631         {
4632                 return null;
4633         }
4634         if($this->db->getRowCount($result) > 1)
4635         {
4636                 $this->duplicates_found = true;
4637         }
4638         $row = $this->db->fetchByAssoc($result, -1, $encode);
4639         if(empty($row))
4640         {
4641                 return null;
4642         }
4643         $this->fromArray($row);
4644         $this->fill_in_additional_detail_fields();
4645         return $this;
4646     }
4647
4648     /**
4649     * This method is called during an import before inserting a bean
4650         * Define an associative array called $special_fields
4651         * the keys are user defined, and don't directly map to the bean's fields
4652         * the value is the method name within that bean that will do extra
4653         * processing for that field. example: 'full_name'=>'get_names_from_full_name'
4654     *
4655     */
4656     function process_special_fields()
4657     {
4658         foreach ($this->special_functions as $func_name)
4659         {
4660                 if ( method_exists($this,$func_name) )
4661                 {
4662                         $this->$func_name();
4663                 }
4664         }
4665     }
4666
4667     /**
4668      * Override this function to build a where clause based on the search criteria set into bean .
4669      * @abstract
4670      */
4671     function build_generic_where_clause($value)
4672     {
4673     }
4674
4675         function getRelatedFields($module, $id, $fields, $return_array = false){
4676                 if(empty($GLOBALS['beanList'][$module]))return '';
4677                 $object = $GLOBALS['beanList'][$module];
4678                 if ($object == 'aCase') {
4679                         $object = 'Case';
4680                 }
4681
4682                 VardefManager::loadVardef($module, $object);
4683                 if(empty($GLOBALS['dictionary'][$object]['table']))return '';
4684                 $table = $GLOBALS['dictionary'][$object]['table'];
4685                 $query  = 'SELECT id';
4686                 foreach($fields as $field=>$alias){
4687                         if(!empty($GLOBALS['dictionary'][$object]['fields'][$field]['db_concat_fields'])){
4688                                 $query .= ' ,' .db_concat($table, $GLOBALS['dictionary'][$object]['fields'][$field]['db_concat_fields']) .  ' as ' . $alias ;
4689                         }else if(!empty($GLOBALS['dictionary'][$object]['fields'][$field]) &&
4690                                 (empty($GLOBALS['dictionary'][$object]['fields'][$field]['source']) ||
4691                                 $GLOBALS['dictionary'][$object]['fields'][$field]['source'] != "non-db"))
4692                         {
4693                                 $query .= ' ,' .$table . '.' . $field . ' as ' . $alias;
4694                         }
4695                         if(!$return_array)$this->$alias = '';
4696                 }
4697                 if($query == 'SELECT id' || empty($id)){
4698                         return '';
4699                 }
4700
4701
4702                 if(isset($GLOBALS['dictionary'][$object]['fields']['assigned_user_id']))
4703         {
4704                 $query .= " , ".        $table  . ".assigned_user_id owner";
4705
4706         }
4707         else if(isset($GLOBALS['dictionary'][$object]['fields']['created_by']))
4708         {
4709                 $query .= " , ".        $table . ".created_by owner";
4710
4711         }
4712                 $query .=  ' FROM ' . $table . ' WHERE deleted=0 AND id=';
4713         $result = $GLOBALS['db']->query($query . "'$id'" );
4714                 $row = $GLOBALS['db']->fetchByAssoc($result);
4715                 if($return_array){
4716                         return $row;
4717                 }
4718                 $owner = (empty($row['owner']))?'':$row['owner'];
4719                 foreach($fields as $alias){
4720                         $this->$alias = (!empty($row[$alias]))? $row[$alias]: '';
4721                         $alias = $alias  .'_owner';
4722                         $this->$alias = $owner;
4723                         $a_mod = $alias  .'_mod';
4724                         $this->$a_mod = $module;
4725                 }
4726
4727
4728         }
4729
4730
4731         function &parse_additional_headers(&$list_form, $xTemplateSection)
4732         {
4733                 return $list_form;
4734         }
4735
4736         function assign_display_fields($currentModule)
4737         {
4738                 global $timedate;
4739                 foreach($this->column_fields as $field)
4740                 {
4741                         if(isset($this->field_name_map[$field]) && empty($this->$field))
4742                         {
4743                                 if($this->field_name_map[$field]['type'] != 'date' && $this->field_name_map[$field]['type'] != 'enum')
4744                                 $this->$field = $field;
4745                                 if($this->field_name_map[$field]['type'] == 'date')
4746                                 {
4747                                         $this->$field = $timedate->to_display_date('1980-07-09');
4748                                 }
4749                                 if($this->field_name_map[$field]['type'] == 'enum')
4750                                 {
4751                                         $dom = $this->field_name_map[$field]['options'];
4752                                         global $current_language, $app_list_strings;
4753                                         $mod_strings = return_module_language($current_language, $currentModule);
4754
4755                                         if(isset($mod_strings[$dom]))
4756                                         {
4757                                                 $options = $mod_strings[$dom];
4758                                                 foreach($options as $key=>$value)
4759                                                 {
4760                                                         if(!empty($key) && empty($this->$field ))
4761                                                         {
4762                                                                 $this->$field = $key;
4763                                                         }
4764                                                 }
4765                                         }
4766                                         if(isset($app_list_strings[$dom]))
4767                                         {
4768                                                 $options = $app_list_strings[$dom];
4769                                                 foreach($options as $key=>$value)
4770                                                 {
4771                                                         if(!empty($key) && empty($this->$field ))
4772                                                         {
4773                                                                 $this->$field = $key;
4774                                                         }
4775                                                 }
4776                                         }
4777
4778
4779                                 }
4780                         }
4781                 }
4782         }
4783
4784         /*
4785          *      RELATIONSHIP HANDLING
4786          */
4787
4788         function set_relationship($table, $relate_values, $check_duplicates = true,$do_update=false,$data_values=null)
4789         {
4790                 $where = '';
4791
4792                 // make sure there is a date modified
4793                 $date_modified = db_convert("'".gmdate($GLOBALS['timedate']->get_db_date_time_format())."'", 'datetime');
4794
4795                 $row=null;
4796                 if($check_duplicates)
4797                 {
4798                         $query = "SELECT * FROM $table ";
4799                         $where = "WHERE deleted = '0'  ";
4800                         foreach($relate_values as $name=>$value)
4801                         {
4802                                 $where .= " AND $name = '$value' ";
4803                         }
4804                         $query .= $where;
4805                         $result = $this->db->query($query, false, "Looking For Duplicate Relationship:" . $query);
4806                         $row=$this->db->fetchByAssoc($result);
4807                 }
4808
4809                 if(!$check_duplicates || empty($row) )
4810                 {
4811                         unset($relate_values['id']);
4812                         if ( isset($data_values))
4813                         {
4814                                 $relate_values = array_merge($relate_values,$data_values);
4815                         }
4816                         $query = "INSERT INTO $table (id, ". implode(',', array_keys($relate_values)) . ", date_modified) VALUES ('" . create_guid() . "', " . "'" . implode("', '", $relate_values) . "', ".$date_modified.")" ;
4817
4818                         $this->db->query($query, false, "Creating Relationship:" . $query);
4819                 }
4820                 else if ($do_update)
4821                 {
4822                         $conds = array();
4823                         foreach($data_values as $key=>$value)
4824                         {
4825                                 array_push($conds,$key."='".$this->db->quote($value)."'");
4826                         }
4827                         $query = "UPDATE $table SET ". implode(',', $conds).",date_modified=".$date_modified." ".$where;
4828                         $this->db->query($query, false, "Updating Relationship:" . $query);
4829                 }
4830         }
4831
4832         function retrieve_relationships($table, $values, $select_id)
4833         {
4834                 $query = "SELECT $select_id FROM $table WHERE deleted = 0  ";
4835                 foreach($values as $name=>$value)
4836                 {
4837                         $query .= " AND $name = '$value' ";
4838                 }
4839                 $query .= " ORDER BY $select_id ";
4840                 $result = $this->db->query($query, false, "Retrieving Relationship:" . $query);
4841                 $ids = array();
4842                 while($row = $this->db->fetchByAssoc($result))
4843                 {
4844                         $ids[] = $row;
4845                 }
4846                 return $ids;
4847         }
4848
4849         // TODO: this function needs adjustment
4850         function loadLayoutDefs()
4851         {
4852                 global $layout_defs;
4853                 if(empty( $this->layout_def) && file_exists('modules/'. $this->module_dir . '/layout_defs.php'))
4854                 {
4855                         include_once('modules/'. $this->module_dir . '/layout_defs.php');
4856                         if(file_exists('custom/modules/'. $this->module_dir . '/Ext/Layoutdefs/layoutdefs.ext.php'))
4857                         {
4858                                 include_once('custom/modules/'. $this->module_dir . '/Ext/Layoutdefs/layoutdefs.ext.php');
4859                         }
4860                         if ( empty( $layout_defs[get_class($this)]))
4861                         {
4862                                 echo "\$layout_defs[" . get_class($this) . "]; does not exist";
4863                         }
4864
4865                         $this->layout_def = $layout_defs[get_class($this)];
4866                 }
4867         }
4868
4869         /**
4870          * Trigger custom logic for this module that is defined for the provided hook
4871          * The custom logic file is located under custom/modules/[CURRENT_MODULE]/logic_hooks.php.
4872          * That file should define the $hook_version that should be used.
4873          * It should also define the $hook_array.  The $hook_array will be a two dimensional array
4874          * the first dimension is the name of the event, the second dimension is the information needed
4875          * to fire the hook.  Each entry in the top level array should be defined on a single line to make it
4876          * easier to automatically replace this file.  There should be no contents of this file that are not replacable.
4877          *
4878          * $hook_array['before_save'][] = Array(1, testtype, 'custom/modules/Leads/test12.php', 'TestClass', 'lead_before_save_1');
4879          * This sample line creates a before_save hook.  The hooks are procesed in the order in which they
4880          * are added to the array.  The second dimension is an array of:
4881          *              processing index (for sorting before exporting the array)
4882          *              A logic type hook
4883          *              label/type
4884          *              php file to include
4885          *              php class the method is in
4886          *              php method to call
4887          *
4888          * The method signature for version 1 hooks is:
4889          * function NAME(&$bean, $event, $arguments)
4890          *              $bean - $this bean passed in by reference.
4891          *              $event - The string for the current event (i.e. before_save)
4892          *              $arguments - An array of arguments that are specific to the event.
4893          */
4894         function call_custom_logic($event, $arguments = null)
4895         {
4896                 if(!isset($this->processed) || $this->processed == false){
4897                         //add some logic to ensure we do not get into an infinite loop
4898                         if(!empty($this->logicHookDepth[$event])) {
4899                                 if($this->logicHookDepth[$event] > 10)
4900                                         return;
4901                         }else
4902                                 $this->logicHookDepth[$event] = 0;
4903
4904                         //we have to put the increment operator here
4905                         //otherwise we may never increase the depth for that event in the case
4906                         //where one event will trigger another as in the case of before_save and after_save
4907                         //Also keeping the depth per event allow any number of hooks to be called on the bean
4908                         //and we only will return if one event gets caught in a loop. We do not increment globally
4909                         //for each event called.
4910                         $this->logicHookDepth[$event]++;
4911
4912                         //method defined in 'include/utils/LogicHook.php'
4913
4914                         $logicHook = new LogicHook();
4915                         $logicHook->setBean($this);
4916                         $logicHook->call_custom_logic($this->module_dir, $event, $arguments);
4917                 }
4918         }
4919
4920
4921     /*  When creating a custom field of type Dropdown, it creates an enum row in the DB.
4922      A typical get_list_view_array() result will have the *KEY* value from that drop-down.
4923      Since custom _dom objects are flat-files included in the $app_list_strings variable,
4924      We need to generate a key-key pair to get the true value like so:
4925      ([module]_cstm->fields_meta_data->$app_list_strings->*VALUE*)*/
4926     function getRealKeyFromCustomFieldAssignedKey($name)
4927     {
4928         if ($this->custom_fields->avail_fields[$name]['ext1'])
4929         {
4930                 $realKey = 'ext1';
4931         }
4932         elseif ($this->custom_fields->avail_fields[$name]['ext2'])
4933         {
4934                 $realKey = 'ext2';
4935         }
4936         elseif ($this->custom_fields->avail_fields[$name]['ext3'])
4937         {
4938                 $realKey = 'ext3';
4939         }
4940         else
4941         {
4942                 $GLOBALS['log']->fatal("SUGARBEAN: cannot find Real Key for custom field of type dropdown - cannot return Value.");
4943                 return false;
4944         }
4945         if(isset($realKey))
4946         {
4947                 return $this->custom_fields->avail_fields[$name][$realKey];
4948         }
4949     }
4950
4951     function bean_implements($interface)
4952     {
4953         return false;
4954     }
4955         /**
4956          * Check whether the user has access to a particular view for the current bean/module
4957          * @param $view string required, the view to determine access for i.e. DetailView, ListView...
4958          * @param $is_owner bool optional, this is part of the ACL check if the current user is an owner they will receive different access
4959          */
4960     function ACLAccess($view,$is_owner='not_set')
4961     {
4962         global $current_user;
4963                 if(is_admin($current_user))return true;
4964         $not_set = false;
4965         if($is_owner == 'not_set')
4966         {
4967                 $not_set = true;
4968                 $is_owner = $this->isOwner($current_user->id);
4969         }
4970
4971         //if we don't implent acls return true
4972         if(!$this->bean_implements('ACL'))
4973         return true;
4974                 $view = strtolower($view);
4975         switch ($view)
4976         {
4977                 case 'list':
4978                 case 'index':
4979                 case 'listview':
4980                         return ACLController::checkAccess($this->module_dir,'list', true);
4981                 case 'edit':
4982                 case 'save':
4983                         if( !$is_owner && $not_set && !empty($this->id)){
4984                                 $class = get_class($this);
4985                                 $temp = new $class();
4986                                 if(!empty($this->fetched_row) && !empty($this->fetched_row['id']) && !empty($this->fetched_row['assigned_user_id']) && !empty($this->fetched_row['created_by'])){
4987                                         $temp->populateFromRow($this->fetched_row);
4988                                 }else{
4989                                         $temp->retrieve($this->id);
4990                                 }
4991                                 $is_owner = $temp->isOwner($current_user->id);
4992                         }
4993                 case 'popupeditview':
4994                 case 'editview':
4995                         return ACLController::checkAccess($this->module_dir,'edit', $is_owner, $this->acltype);
4996                 case 'view':
4997                 case 'detail':
4998                 case 'detailview':
4999                         return ACLController::checkAccess($this->module_dir,'view', $is_owner, $this->acltype);
5000                 case 'delete':
5001                         return ACLController::checkAccess($this->module_dir,'delete', $is_owner, $this->acltype);
5002                 case 'export':
5003                         return ACLController::checkAccess($this->module_dir,'export', $is_owner, $this->acltype);
5004                 case 'import':
5005                         return ACLController::checkAccess($this->module_dir,'import', true, $this->acltype);
5006         }
5007         //if it is not one of the above views then it should be implemented on the page level
5008         return true;
5009     }
5010         /**
5011          * Returns true of false if the user_id passed is the owner
5012          *
5013          * @param GUID $user_id
5014          * @return boolean
5015          */
5016         function isOwner($user_id)
5017         {
5018                 //if we don't have an id we must be the owner as we are creating it
5019                 if(!isset($this->id))
5020                 {
5021                         return true;
5022                 }
5023                 //if there is an assigned_user that is the owner
5024                 if(isset($this->assigned_user_id))
5025                 {
5026                         if($this->assigned_user_id == $user_id) return true;
5027                         return false;
5028                 }
5029                 else
5030                 {
5031                         //other wise if there is a created_by that is the owner
5032                         if(isset($this->created_by) && $this->created_by == $user_id)
5033                         {
5034                                 return true;
5035                         }
5036                 }
5037                 return false;
5038         }
5039         /**
5040          * Gets there where statement for checking if a user is an owner
5041          *
5042          * @param GUID $user_id
5043          * @return STRING
5044          */
5045         function getOwnerWhere($user_id)
5046         {
5047                 if(isset($this->field_defs['assigned_user_id']))
5048                 {
5049                         return " $this->table_name.assigned_user_id ='$user_id' ";
5050                 }
5051                 if(isset($this->field_defs['created_by']))
5052                 {
5053                         return " $this->table_name.created_by ='$user_id' ";
5054                 }
5055                 return '';
5056         }
5057
5058         /**
5059          *
5060          * Used in order to manage ListView links and if they should
5061          * links or not based on the ACL permissions of the user
5062          *
5063          * @return ARRAY of STRINGS
5064          */
5065         function listviewACLHelper()
5066         {
5067                 $array_assign = array();
5068                 if($this->ACLAccess('DetailView'))
5069                 {
5070                         $array_assign['MAIN'] = 'a';
5071                 }
5072                 else
5073                 {
5074                         $array_assign['MAIN'] = 'span';
5075                 }
5076                 return $array_assign;
5077         }
5078
5079         /**
5080          * returns this bean as an array
5081          *
5082          * @return array of fields with id, name, access and category
5083          */
5084         function toArray($dbOnly = false, $stringOnly = false, $upperKeys=false)
5085         {
5086         static $cache = array();
5087                 $arr = array();
5088
5089                 foreach($this->field_defs as $field=>$data)
5090                 {
5091                         if( !$dbOnly || !isset($data['source']) || $data['source'] == 'db')
5092                         if(!$stringOnly || is_string($this->$field))
5093                         if($upperKeys)
5094                         {
5095                                 if(!isset($cache[$field])){
5096                                     $cache[$field] = strtoupper($field);
5097                                 }
5098                                 $arr[$cache[$field]] = $this->$field;
5099                         }
5100                         else
5101                         {
5102                                 if(isset($this->$field)){
5103                                         $arr[$field] = $this->$field;
5104                                 }else{
5105                                         $arr[$field] = '';
5106                                 }
5107                         }
5108                 }
5109                 return $arr;
5110         }
5111
5112         /**
5113          * Converts an array into an acl mapping name value pairs into files
5114          *
5115          * @param Array $arr
5116          */
5117         function fromArray($arr)
5118         {
5119                 foreach($arr as $name=>$value)
5120                 {
5121                         $this->$name = $value;
5122                 }
5123         }
5124
5125     /**
5126      * Loads a row of data into instance of a bean. The data is passed as an array to this function
5127      *
5128      * @param array $arr row of data fetched from the database.
5129      * @return  nothing
5130      *
5131      * Internal function do not override.
5132      */
5133     function loadFromRow($arr)
5134     {
5135         $this->populateFromRow($arr);
5136         $this->processed_dates_times = array();
5137         $this->check_date_relationships_load();
5138
5139         $this->fill_in_additional_list_fields();
5140
5141         if($this->hasCustomFields())$this->custom_fields->fill_relationships();
5142         $this->call_custom_logic("process_record");
5143     }
5144
5145     function hasCustomFields(){
5146         return !empty($GLOBALS['dictionary'][$this->object_name]['custom_fields']);
5147     }
5148
5149    /**
5150     * Ensure that fields within order by clauses are properly qualified with
5151     * their tablename.  This qualification is a requirement for sql server support.
5152     *
5153     * @param string $order_by original order by from the query
5154     * @param string $qualify prefix for columns in the order by list.
5155     * @return  prefixed
5156     *
5157     * Internal function do not override.
5158     */
5159    function create_qualified_order_by( $order_by, $qualify)
5160    {    // if the column is empty, but the sort order is defined, the value will throw an error, so do not proceed if no order by is given
5161         if (empty($order_by))
5162         {
5163                 return $order_by;
5164         }
5165         $order_by_clause = " ORDER BY ";
5166         $tmp = explode(",", $order_by);
5167         $comma = ' ';
5168         foreach ( $tmp as $stmp)
5169         {
5170                 $stmp = (substr_count($stmp, ".") > 0?trim($stmp):"$qualify." . trim($stmp));
5171                 $order_by_clause .= $comma . $stmp;
5172                 $comma = ", ";
5173         }
5174         return $order_by_clause;
5175    }
5176
5177    /**
5178     * Combined the contents of street field 2 thru 4 into the main field
5179     *
5180     * @param string $street_field
5181     */
5182
5183    function add_address_streets(
5184        $street_field
5185        )
5186         {
5187         $street_field_2 = $street_field.'_2';
5188         $street_field_3 = $street_field.'_3';
5189         $street_field_4 = $street_field.'_4';
5190                 if ( isset($this->$street_field_2)) {
5191                         $this->$street_field .= "\n". $this->$street_field_2;
5192                         unset($this->$street_field_2);
5193                 }
5194                 if ( isset($this->$street_field_3)) {
5195                         $this->$street_field .= "\n". $this->$street_field_3;
5196                         unset($this->$street_field_3);
5197                 }
5198         if ( isset($this->$street_field_4)) {
5199                         $this->$street_field .= "\n". $this->$street_field_4;
5200                         unset($this->$street_field_4);
5201                 }
5202                 if ( isset($this->$street_field)) {
5203                     $this->$street_field = trim($this->$street_field, "\n");
5204                 }
5205         }
5206 /**
5207  * Encrpyt and base64 encode an 'encrypt' field type in the bean using Blowfish. The default system key is stored in cache/Blowfish/{keytype}
5208  * @param STRING value -plain text value of the bean field.
5209  * @return string
5210  */
5211         function encrpyt_before_save($value)
5212         {
5213                 require_once("include/utils/encryption_utils.php");
5214                 return blowfishEncode(blowfishGetKey('encrypt_field'),$value);
5215         }
5216
5217 /**
5218  * Decode and decrypt a base 64 encoded string with field type 'encrypt' in this bean using Blowfish.
5219  * @param STRING value - an encrypted and base 64 encoded string.
5220  * @return string
5221  */
5222         function decrypt_after_retrieve($value)
5223         {
5224                 require_once("include/utils/encryption_utils.php");
5225                 return blowfishDecode(blowfishGetKey('encrypt_field'), $value);
5226         }
5227
5228         /**
5229          * Moved from save() method, functionality is the same, but this is intended to handle
5230          * Optimistic locking functionality.
5231          */
5232         private function _checkOptimisticLocking($action, $isUpdate){
5233                 if($this->optimistic_lock && !isset($_SESSION['o_lock_fs'])){
5234                         if(isset($_SESSION['o_lock_id']) && $_SESSION['o_lock_id'] == $this->id && $_SESSION['o_lock_on'] == $this->object_name)
5235                         {
5236                                 if($action == 'Save' && $isUpdate && isset($this->modified_user_id) && $this->has_been_modified_since($_SESSION['o_lock_dm'], $this->modified_user_id))
5237                                 {
5238                                         $_SESSION['o_lock_class'] = get_class($this);
5239                                         $_SESSION['o_lock_module'] = $this->module_dir;
5240                                         $_SESSION['o_lock_object'] = $this->toArray();
5241                                         $saveform = "<form name='save' id='save' method='POST'>";
5242                                         foreach($_POST as $key=>$arg)
5243                                         {
5244                                                 $saveform .= "<input type='hidden' name='". addslashes($key) ."' value='". addslashes($arg) ."'>";
5245                                         }
5246                                         $saveform .= "</form><script>document.getElementById('save').submit();</script>";
5247                                         $_SESSION['o_lock_save'] = $saveform;
5248                                         header('Location: index.php?module=OptimisticLock&action=LockResolve');
5249                                         die();
5250                                 }
5251                                 else
5252                                 {
5253                                         unset ($_SESSION['o_lock_object']);
5254                                         unset ($_SESSION['o_lock_id']);
5255                                         unset ($_SESSION['o_lock_dm']);
5256                                 }
5257                         }
5258                 }
5259                 else
5260                 {
5261                         if(isset($_SESSION['o_lock_object']))   { unset ($_SESSION['o_lock_object']); }
5262                         if(isset($_SESSION['o_lock_id']))               { unset ($_SESSION['o_lock_id']); }
5263                         if(isset($_SESSION['o_lock_dm']))               { unset ($_SESSION['o_lock_dm']); }
5264                         if(isset($_SESSION['o_lock_fs']))               { unset ($_SESSION['o_lock_fs']); }
5265                         if(isset($_SESSION['o_lock_save']))             { unset ($_SESSION['o_lock_save']); }
5266                 }
5267         }
5268
5269         /**
5270          * Send assignment notifications and invites for meetings and calls
5271          */
5272         private function _sendNotifications($check_notify){
5273                 if($check_notify || (isset($this->notify_inworkflow) && $this->notify_inworkflow == true)){ // cn: bug 5795 - no invites sent to Contacts, and also bug 25995, in workflow, it will set the notify_on_save=true.
5274
5275                         $admin = new Administration();
5276                         $admin->retrieveSettings();
5277                         $sendNotifications = false;
5278
5279                         if ($admin->settings['notify_on'])
5280                         {
5281                                 $GLOBALS['log']->info("Notifications: user assignment has changed, checking if user receives notifications");
5282                                 $sendNotifications = true;
5283                         }
5284                         elseif(isset($_REQUEST['send_invites']) && $_REQUEST['send_invites'] == 1)
5285                         {
5286                                 // cn: bug 5795 Send Invites failing for Contacts
5287                                 $sendNotifications = true;
5288                         }
5289                         else
5290                         {
5291                                 $GLOBALS['log']->info("Notifications: not sending e-mail, notify_on is set to OFF");
5292                         }
5293
5294
5295                         if($sendNotifications == true)
5296                         {
5297                                 $notify_list = $this->get_notification_recipients();
5298                                 foreach ($notify_list as $notify_user)
5299                                 {
5300                                         $this->send_assignment_notifications($notify_user, $admin);
5301                                 }
5302                         }
5303                 }
5304         }
5305
5306
5307     /**
5308      * Called from ImportFieldSanitize::relate(), when creating a new bean in a related module. Will
5309      * copies fields over from the current bean into the related. Designed to be overriden in child classes.
5310      *
5311      * @param SugarBean $newbean newly created related bean
5312      */
5313     public function populateRelatedBean(
5314         SugarBean $newbean
5315         )
5316     {
5317     }
5318
5319     /**
5320      * Called during the import process before a bean save, to handle any needed pre-save logic when
5321      * importing a record
5322      */
5323     public function beforeImportSave()
5324     {
5325     }
5326
5327     /**
5328      * Called during the import process after a bean save, to handle any needed post-save logic when
5329      * importing a record
5330      */
5331     public function afterImportSave()
5332     {
5333     }
5334
5335     /**
5336      * This function is designed to cache references to field arrays that were previously stored in the
5337      * bean files and have since been moved to seperate files. Was previously in include/CacheHandler.php
5338      *
5339      * @deprecated
5340      * @param $module_dir string the module directory
5341      * @param $module string the name of the module
5342      * @param $key string the type of field array we are referencing, i.e. list_fields, column_fields, required_fields
5343      **/
5344         private function _loadCachedArray(
5345             $module_dir,
5346             $module,
5347             $key
5348             )
5349         {
5350         static $moduleDefs = array();
5351
5352         $fileName = 'field_arrays.php';
5353
5354         $cache_key = "load_cached_array.$module_dir.$module.$key";
5355         $result = sugar_cache_retrieve($cache_key);
5356         if(!empty($result))
5357         {
5358                 // Use EXTERNAL_CACHE_NULL_VALUE to store null values in the cache.
5359                 if($result == EXTERNAL_CACHE_NULL_VALUE)
5360                 {
5361                         return null;
5362                 }
5363
5364                 return $result;
5365         }
5366
5367         if(file_exists('modules/'.$module_dir.'/'.$fileName))
5368         {
5369             // If the data was not loaded, try loading again....
5370             if(!isset($moduleDefs[$module]))
5371             {
5372                 include('modules/'.$module_dir.'/'.$fileName);
5373                 $moduleDefs[$module] = $fields_array;
5374                     }
5375                     // Now that we have tried loading, make sure it was loaded
5376             if(empty($moduleDefs[$module]) || empty($moduleDefs[$module][$module][$key]))
5377             {
5378                 // It was not loaded....  Fail.  Cache null to prevent future repeats of this calculation
5379                                 sugar_cache_put($cache_key, EXTERNAL_CACHE_NULL_VALUE);
5380                 return  null;
5381             }
5382
5383             // It has been loaded, cache the result.
5384             sugar_cache_put($cache_key, $moduleDefs[$module][$module][$key]);
5385             return $moduleDefs[$module][$module][$key];
5386         }
5387
5388         // It was not loaded....  Fail.  Cache null to prevent future repeats of this calculation
5389         sugar_cache_put($cache_key, EXTERNAL_CACHE_NULL_VALUE);
5390                 return null;
5391         }
5392 }