data/SugarBean.php

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