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