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-2012 SugarCRM Inc.
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.
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
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
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.
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.
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 ********************************************************************************/
38 /*********************************************************************************
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 *******************************************************************************/
48 require_once('modules/DynamicFields/DynamicField.php');
49 require_once("data/Relationships/RelationshipFactory.php");
56 * SugarBean is the base class for all business objects in Sugar. It implements
57 * the primary functionality needed for manipulating business objects: create,
58 * retrieve, update, delete. It allows for searching and retrieving list of records.
59 * It allows for retrieving related objects (e.g. contacts related to a specific account).
61 * In the current implementation, there can only be one bean per folder.
62 * Naming convention has the bean name be the same as the module and folder name.
63 * All bean names should be singular (e.g. Contact). The primary table name for
64 * a bean should be plural (e.g. contacts).
70 * A pointer to the database object
77 * When createing a bean, you can specify a value in the id column as
78 * long as that value is unique. During save, if the system finds an
79 * id, it assumes it is an update. Setting new_with_id to true will
80 * make sure the system performs an insert instead of an update.
82 * @var BOOL -- default false
84 var $new_with_id = false;
88 * How deep logic hooks can go
91 protected $max_logic_depth = 10;
94 * Disble vardefs. This should be set to true only for beans that do not have varders. Tracker is an example
96 * @var BOOL -- default false
98 var $disable_vardefs = false;
102 * holds the full name of the user that an item is assigned to. Only used if notifications
103 * are turned on and going to be sent out.
107 var $new_assigned_user_name;
110 * An array of booleans. This array is cleared out when data is loaded.
111 * As date/times are converted, a "1" is placed under the key, the field is converted.
113 * @var Array of booleans
115 var $processed_dates_times = array();
118 * Whether to process date/time fields for storage in the database in GMT
122 var $process_save_dates =true;
125 * This signals to the bean that it is being saved in a mass mode.
126 * Examples of this kind of save are import and mass update.
127 * We turn off notificaitons of this is the case to make things more efficient.
131 var $save_from_post = true;
134 * When running a query on related items using the method: retrieve_by_string_fields
135 * this value will be set to true if more than one item matches the search criteria.
139 var $duplicates_found = false;
142 * true if this bean has been deleted, false otherwise.
149 * Should the date modified column of the bean be updated during save?
150 * This is used for admin level functionality that should not be updating
151 * the date modified. This is only used by sync to allow for updates to be
152 * replicated in a way that will not cause them to be replicated back.
156 var $update_date_modified = true;
159 * Should the modified by column of the bean be updated during save?
160 * This is used for admin level functionality that should not be updating
161 * the modified by column. This is only used by sync to allow for updates to be
162 * replicated in a way that will not cause them to be replicated back.
166 var $update_modified_by = true;
169 * Setting this to true allows for updates to overwrite the date_entered
173 var $update_date_entered = false;
176 * This allows for seed data to be created without using the current uesr to set the id.
177 * This should be replaced by altering the current user before the call to save.
181 //TODO This should be replaced by altering the current user before the call to save.
182 var $set_created_by = true;
187 * The database table where records of this Bean are stored.
191 var $table_name = '';
194 * This is the singular name of the bean. (i.e. Contact).
198 var $object_name = '';
200 /** Set this to true if you query contains a sub-select and bean is converting both select statements
201 * into count queries.
203 var $ungreedy_count=false;
206 * The name of the module folder for this type of bean.
210 var $module_dir = '';
211 var $module_name = '';
215 var $column_fields = array();
216 var $list_fields = array();
217 var $additional_column_fields = array();
218 var $relationship_fields = array();
219 var $current_notify_user;
220 var $fetched_row=false;
221 var $fetched_rel_row = array();
223 var $force_load_details = false;
224 var $optimistic_lock = false;
225 var $disable_custom_fields = false;
226 var $number_formatting_done = false;
227 var $process_field_encrypted=false;
229 * The default ACL type
231 var $acltype = 'module';
234 var $additional_meta_fields = array();
237 * Set to true in the child beans if the module supports importing
239 var $importable = false;
242 * Set to true in the child beans if the module use the special notification template
244 var $special_notification = false;
247 * Set to true if the bean is being dealt with in a workflow
249 var $in_workflow = false;
253 * By default it will be true but if any module is to be kept non visible
254 * to tracker, then its value needs to be overriden in that particular module to false.
257 var $tracker_visibility = true;
260 * Used to pass inner join string to ListView Data.
262 var $listview_inner_join = array();
265 * Set to true in <modules>/Import/views/view.step4.php if a module is being imported
267 var $in_import = false;
269 * A way to keep track of the loaded relationships so when we clone the object we can unset them.
273 protected $loaded_relationships = array();
276 * set to true if dependent fields updated
278 protected $is_updated_dependent_fields = false;
281 * Constructor for the bean, it performs following tasks:
283 * 1. Initalized a database connections
284 * 2. Load the vardefs for the module implemeting the class. cache the entries
286 * 3. Setup row-level security preference
287 * All implementing classes must call this constructor using the parent::SugarBean() class.
292 global $dictionary, $current_user;
293 static $loaded_defs = array();
294 $this->db = DBManagerFactory::getInstance();
295 if (empty($this->module_name))
296 $this->module_name = $this->module_dir;
297 if((false == $this->disable_vardefs && empty($loaded_defs[$this->object_name])) || !empty($GLOBALS['reload_vardefs']))
299 VardefManager::loadVardef($this->module_dir, $this->object_name);
301 // build $this->column_fields from the field_defs if they exist
302 if (!empty($dictionary[$this->object_name]['fields'])) {
303 foreach ($dictionary[$this->object_name]['fields'] as $key=>$value_array) {
304 $column_fields[] = $key;
305 if(!empty($value_array['required']) && !empty($value_array['name'])) {
306 $this->required_fields[$value_array['name']] = 1;
309 $this->column_fields = $column_fields;
312 //setup custom fields
313 if(!isset($this->custom_fields) &&
314 empty($this->disable_custom_fields))
316 $this->setupCustomFields($this->module_dir);
318 //load up field_arrays from CacheHandler;
319 if(empty($this->list_fields))
320 $this->list_fields = $this->_loadCachedArray($this->module_dir, $this->object_name, 'list_fields');
321 if(empty($this->column_fields))
322 $this->column_fields = $this->_loadCachedArray($this->module_dir, $this->object_name, 'column_fields');
323 if(empty($this->required_fields))
324 $this->required_fields = $this->_loadCachedArray($this->module_dir, $this->object_name, 'required_fields');
326 if(isset($GLOBALS['dictionary'][$this->object_name]) && !$this->disable_vardefs)
328 $this->field_name_map = $dictionary[$this->object_name]['fields'];
329 $this->field_defs = $dictionary[$this->object_name]['fields'];
331 if(!empty($dictionary[$this->object_name]['optimistic_locking']))
333 $this->optimistic_lock=true;
336 $loaded_defs[$this->object_name]['column_fields'] =& $this->column_fields;
337 $loaded_defs[$this->object_name]['list_fields'] =& $this->list_fields;
338 $loaded_defs[$this->object_name]['required_fields'] =& $this->required_fields;
339 $loaded_defs[$this->object_name]['field_name_map'] =& $this->field_name_map;
340 $loaded_defs[$this->object_name]['field_defs'] =& $this->field_defs;
344 $this->column_fields =& $loaded_defs[$this->object_name]['column_fields'] ;
345 $this->list_fields =& $loaded_defs[$this->object_name]['list_fields'];
346 $this->required_fields =& $loaded_defs[$this->object_name]['required_fields'];
347 $this->field_name_map =& $loaded_defs[$this->object_name]['field_name_map'];
348 $this->field_defs =& $loaded_defs[$this->object_name]['field_defs'];
349 $this->added_custom_field_defs = true;
351 if(!isset($this->custom_fields) &&
352 empty($this->disable_custom_fields))
354 $this->setupCustomFields($this->module_dir, false);
356 if(!empty($dictionary[$this->object_name]['optimistic_locking']))
358 $this->optimistic_lock=true;
362 if($this->bean_implements('ACL') && !empty($GLOBALS['current_user'])){
363 $this->acl_fields = (isset($dictionary[$this->object_name]['acl_fields']) && $dictionary[$this->object_name]['acl_fields'] === false)?false:true;
365 $this->populateDefaultValues();
370 * Returns the object name. If object_name is not set, table_name is returned.
372 * All implementing classes must set a value for the object_name variable.
374 * @param array $arr row of data fetched from the database.
378 function getObjectName()
380 if ($this->object_name)
381 return $this->object_name;
383 // This is a quick way out. The generated metadata files have the table name
384 // as the key. The correct way to do this is to override this function
385 // in bean and return the object name. That requires changing all the beans
386 // as well as put the object name in the generator.
387 return $this->table_name;
391 * Returns a list of fields with their definitions that have the audited property set to true.
392 * Before calling this function, check whether audit has been enabled for the table/module or not.
393 * You would set the audit flag in the implemting module's vardef file.
395 * @return an array of
396 * @see is_AuditEnabled
398 * Internal function, do not override.
400 function getAuditEnabledFieldDefinitions()
402 $aclcheck = $this->bean_implements('ACL');
403 $is_owner = $this->isOwner($GLOBALS['current_user']->id);
404 if (!isset($this->audit_enabled_fields))
407 $this->audit_enabled_fields=array();
408 foreach ($this->field_defs as $field => $properties)
413 !empty($properties['Audited']) || !empty($properties['audited']))
417 $this->audit_enabled_fields[$field]=$properties;
422 return $this->audit_enabled_fields;
426 * Return true if auditing is enabled for this object
427 * You would set the audit flag in the implemting module's vardef file.
431 * Internal function, do not override.
433 function is_AuditEnabled()
436 if (isset($dictionary[$this->getObjectName()]['audited']))
438 return $dictionary[$this->getObjectName()]['audited'];
449 * Returns the name of the audit table.
450 * Audit table's name is based on implementing class' table name.
452 * @return String Audit table name.
454 * Internal function, do not override.
456 function get_audit_table_name()
458 return $this->getTableName().'_audit';
462 * Returns the name of the custom table.
463 * Custom table's name is based on implementing class' table name.
465 * @return String Custom table name.
467 * Internal function, do not override.
469 public function get_custom_table_name()
471 return $this->getTableName().'_cstm';
475 * If auditing is enabled, create the audit table.
477 * Function is used by the install scripts and a repair utility in the admin panel.
479 * Internal function, do not override.
481 function create_audit_table()
484 $table_name=$this->get_audit_table_name();
486 require('metadata/audit_templateMetaData.php');
488 // Bug: 52583 Need ability to customize template for audit tables
489 $custom = 'custom/metadata/audit_templateMetaData_' . $this->getTableName() . '.php';
490 if (file_exists($custom))
495 $fieldDefs = $dictionary['audit']['fields'];
496 $indices = $dictionary['audit']['indices'];
498 // Renaming template indexes to fit the particular audit table (removed the brittle hard coding)
499 foreach($indices as $nr => $properties){
500 $indices[$nr]['name'] = 'idx_' . strtolower($this->getTableName()) . '_' . $properties['name'];
504 if(isset($dictionary['audit']['engine'])) {
505 $engine = $dictionary['audit']['engine'];
506 } else if(isset($dictionary[$this->getObjectName()]['engine'])) {
507 $engine = $dictionary[$this->getObjectName()]['engine'];
510 $this->db->createTableParams($table_name, $fieldDefs, $indices, $engine);
514 * Returns the implementing class' table name.
516 * All implementing classes set a value for the table_name variable. This value is returned as the
517 * table name. If not set, table name is extracted from the implementing module's vardef.
519 * @return String Table name.
521 * Internal function, do not override.
523 public function getTableName()
525 if(isset($this->table_name))
527 return $this->table_name;
530 return $dictionary[$this->getObjectName()]['table'];
534 * Returns field definitions for the implementing module.
536 * The definitions were loaded in the constructor.
538 * @return Array Field definitions.
540 * Internal function, do not override.
542 function getFieldDefinitions()
544 return $this->field_defs;
548 * Returns index definitions for the implementing module.
550 * The definitions were loaded in the constructor.
552 * @return Array Index definitions.
554 * Internal function, do not override.
556 function getIndices()
559 if(isset($dictionary[$this->getObjectName()]['indices']))
561 return $dictionary[$this->getObjectName()]['indices'];
567 * Returns field definition for the requested field name.
569 * The definitions were loaded in the constructor.
571 * @param string field name,
572 * @return Array Field properties or boolean false if the field doesn't exist
574 * Internal function, do not override.
576 function getFieldDefinition($name)
578 if ( !isset($this->field_defs[$name]) )
581 return $this->field_defs[$name];
585 * Returnss definition for the id field name.
587 * The definitions were loaded in the constructor.
589 * @return Array Field properties.
591 * Internal function, do not override.
593 function getPrimaryFieldDefinition()
595 $def = $this->getFieldDefinition("id");
597 $def = $this->getFieldDefinition(0);
600 $defs = $this->field_defs;
602 $def = current($defs);
607 * Returns the value for the requested field.
609 * When a row of data is fetched using the bean, all fields are created as variables in the context
610 * of the bean and then fetched values are set in these variables.
612 * @param string field name,
613 * @return varies Field value.
615 * Internal function, do not override.
617 function getFieldValue($name)
619 if (!isset($this->$name)){
622 if($this->$name === TRUE){
625 if($this->$name === FALSE){
632 * Basically undoes the effects of SugarBean::populateDefaultValues(); this method is best called right after object
635 public function unPopulateDefaultValues()
637 if ( !is_array($this->field_defs) )
640 foreach ($this->field_defs as $field => $value) {
641 if( !empty($this->$field)
642 && ((isset($value['default']) && $this->$field == $value['default']) || (!empty($value['display_default']) && $this->$field == $value['display_default']))
644 $this->$field = null;
647 if(!empty($this->$field) && !empty($value['display_default']) && in_array($value['type'], array('date', 'datetime', 'datetimecombo')) &&
648 $this->$field == $this->parseDateDefault($value['display_default'], ($value['type'] != 'date'))) {
649 $this->$field = null;
655 * Create date string from default value
657 * @param string $value
658 * @param bool $time Should be expect time set too?
661 protected function parseDateDefault($value, $time = false)
665 $dtAry = explode('&', $value, 2);
666 $dateValue = $timedate->getNow(true)->modify($dtAry[0]);
667 if(!empty($dtAry[1])) {
668 $timeValue = $timedate->fromString($dtAry[1]);
669 $dateValue->setTime($timeValue->hour, $timeValue->min, $timeValue->sec);
671 return $timedate->asUser($dateValue);
673 return $timedate->asUserDate($timedate->getNow(true)->modify($value));
677 function populateDefaultValues($force=false){
678 if ( !is_array($this->field_defs) )
680 foreach($this->field_defs as $field=>$value){
681 if((isset($value['default']) || !empty($value['display_default'])) && ($force || empty($this->$field))){
682 $type = $value['type'];
686 if(!empty($value['display_default'])){
687 $this->$field = $this->parseDateDefault($value['display_default']);
691 case 'datetimecombo':
692 if(!empty($value['display_default'])){
693 $this->$field = $this->parseDateDefault($value['display_default'], true);
697 if(empty($value['default']) && !empty($value['display_default']))
698 $this->$field = $value['display_default'];
700 $this->$field = $value['default'];
703 if(isset($this->$field)){
707 if ( isset($value['default']) && $value['default'] !== '' ) {
708 $this->$field = htmlentities($value['default'], ENT_QUOTES, 'UTF-8');
719 * Removes relationship metadata cache.
721 * Every module that has relationships defined with other modules, has this meta data cached. The cache is
722 * stores in 2 locations: relationships table and file system. This method clears the cache from both locations.
724 * @param string $key module whose meta cache is to be cleared.
725 * @param string $db database handle.
726 * @param string $tablename table name
727 * @param string $dictionary vardef for the module
728 * @param string $module_dir name of subdirectory where module is installed.
733 * Internal function, do not override.
735 function removeRelationshipMeta($key,$db,$tablename,$dictionary,$module_dir)
737 //load the module dictionary if not supplied.
738 if ((!isset($dictionary) or empty($dictionary)) && !empty($module_dir))
740 $filename='modules/'. $module_dir . '/vardefs.php';
741 if(file_exists($filename))
746 if (!is_array($dictionary) or !array_key_exists($key, $dictionary))
748 $GLOBALS['log']->fatal("removeRelationshipMeta: Metadata for table ".$tablename. " does not exist");
749 display_notice("meta data absent for table ".$tablename." keyed to $key ");
753 if (isset($dictionary[$key]['relationships']))
755 $RelationshipDefs = $dictionary[$key]['relationships'];
756 foreach ($RelationshipDefs as $rel_name)
758 Relationship::delete($rel_name,$db);
766 * This method has been deprecated.
768 * @see removeRelationshipMeta()
769 * @deprecated 4.5.1 - Nov 14, 2006
772 function remove_relationship_meta($key,$db,$log,$tablename,$dictionary,$module_dir)
774 SugarBean::removeRelationshipMeta($key,$db,$tablename,$dictionary,$module_dir);
779 * Populates the relationship meta for a module.
781 * It is called during setup/install. It is used statically to create relationship meta data for many-to-many tables.
783 * @param string $key name of the object.
784 * @param object $db database handle.
785 * @param string $tablename table, meta data is being populated for.
786 * @param array dictionary vardef dictionary for the object. *
787 * @param string module_dir name of subdirectory where module is installed.
788 * @param boolean $iscustom Optional,set to true if module is installed in a custom directory. Default value is false.
791 * Internal function, do not override.
793 function createRelationshipMeta($key,$db,$tablename,$dictionary,$module_dir,$iscustom=false)
795 //load the module dictionary if not supplied.
796 if (empty($dictionary) && !empty($module_dir))
800 $filename='custom/modules/' . $module_dir . '/Ext/Vardefs/vardefs.ext.php';
806 // a very special case for the Employees module
807 // this must be done because the Employees/vardefs.php does an include_once on
809 $filename='modules/Users/vardefs.php';
813 $filename='modules/'. $module_dir . '/vardefs.php';
817 if(file_exists($filename))
820 // cn: bug 7679 - dictionary entries defined as $GLOBALS['name'] not found
821 if(empty($dictionary) || !empty($GLOBALS['dictionary'][$key]))
823 $dictionary = $GLOBALS['dictionary'];
828 $GLOBALS['log']->debug("createRelationshipMeta: no metadata file found" . $filename);
833 if (!is_array($dictionary) or !array_key_exists($key, $dictionary))
835 $GLOBALS['log']->fatal("createRelationshipMeta: Metadata for table ".$tablename. " does not exist");
836 display_notice("meta data absent for table ".$tablename." keyed to $key ");
840 if (isset($dictionary[$key]['relationships']))
843 $RelationshipDefs = $dictionary[$key]['relationships'];
847 $beanList_ucase=array_change_key_case ( $beanList ,CASE_UPPER);
848 foreach ($RelationshipDefs as $rel_name=>$rel_def)
850 if (isset($rel_def['lhs_module']) and !isset($beanList_ucase[strtoupper($rel_def['lhs_module'])])) {
851 $GLOBALS['log']->debug('skipping orphaned relationship record ' . $rel_name . ' lhs module is missing ' . $rel_def['lhs_module']);
854 if (isset($rel_def['rhs_module']) and !isset($beanList_ucase[strtoupper($rel_def['rhs_module'])])) {
855 $GLOBALS['log']->debug('skipping orphaned relationship record ' . $rel_name . ' rhs module is missing ' . $rel_def['rhs_module']);
860 //check whether relationship exists or not first.
861 if (Relationship::exists($rel_name,$db))
863 $GLOBALS['log']->debug('Skipping, reltionship already exists '.$rel_name);
867 $seed = BeanFactory::getBean("Relationships");
868 $keys = array_keys($seed->field_defs);
870 foreach($keys as $key)
874 $toInsert[$key] = create_guid();
876 else if ($key == "relationship_name")
878 $toInsert[$key] = $rel_name;
880 else if (isset($rel_def[$key]))
882 $toInsert[$key] = $rel_def[$key];
884 //todo specify defaults if meta not defined.
888 $column_list = implode(",", array_keys($toInsert));
889 $value_list = "'" . implode("','", array_values($toInsert)) . "'";
891 //create the record. todo add error check.
892 $insert_string = "INSERT into relationships (" .$column_list. ") values (".$value_list.")";
893 $db->query($insert_string, true);
900 //log informational message stating no relationships meta was set for this bean.
906 * This method has been deprecated.
907 * @see createRelationshipMeta()
908 * @deprecated 4.5.1 - Nov 14, 2006
911 function create_relationship_meta($key,&$db,&$log,$tablename,$dictionary,$module_dir)
913 SugarBean::createRelationshipMeta($key,$db,$tablename,$dictionary,$module_dir);
918 * Handle the following when a SugarBean object is cloned
920 * Currently all this does it unset any relationships that were created prior to cloning the object
924 public function __clone()
926 if(!empty($this->loaded_relationships)) {
927 foreach($this->loaded_relationships as $rel) {
935 * Loads the request relationship. This method should be called before performing any operations on the related data.
937 * This method searches the vardef array for the requested attribute's definition. If the attribute is of the type
938 * link then it creates a similary named variable and loads the relationship definition.
940 * @param string $rel_name relationship/attribute name.
943 function load_relationship($rel_name)
945 $GLOBALS['log']->debug("SugarBean[{$this->object_name}].load_relationships, Loading relationship (".$rel_name.").");
947 if (empty($rel_name))
949 $GLOBALS['log']->error("SugarBean.load_relationships, Null relationship name passed.");
952 $fieldDefs = $this->getFieldDefinitions();
954 //find all definitions of type link.
955 if (!empty($fieldDefs[$rel_name]))
957 //initialize a variable of type Link
958 require_once('data/Link2.php');
959 $class = load_link_class($fieldDefs[$rel_name]);
960 if (isset($this->$rel_name) && $this->$rel_name instanceof $class) {
963 //if rel_name is provided, search the fieldef array keys by name.
964 if (isset($fieldDefs[$rel_name]['type']) && $fieldDefs[$rel_name]['type'] == 'link')
966 if ($class == "Link2")
967 $this->$rel_name = new $class($rel_name, $this);
969 $this->$rel_name = new $class($fieldDefs[$rel_name]['relationship'], $this, $fieldDefs[$rel_name]);
971 if (empty($this->$rel_name) ||
972 (method_exists($this->$rel_name, "loadedSuccesfully") && !$this->$rel_name->loadedSuccesfully()))
974 unset($this->$rel_name);
977 // keep track of the loaded relationships
978 $this->loaded_relationships[] = $rel_name;
982 $GLOBALS['log']->debug("SugarBean.load_relationships, Error Loading relationship (".$rel_name.")");
987 * Loads all attributes of type link.
989 * DO NOT CALL THIS FUNCTION IF YOU CAN AVOID IT. Please use load_relationship directly instead.
991 * Method searches the implmenting module's vardef file for attributes of type link, and for each attribute
992 * create a similary named variable and load the relationship definition.
996 * Internal function, do not override.
998 function load_relationships()
1000 $GLOBALS['log']->debug("SugarBean.load_relationships, Loading all relationships of type link.");
1001 $linked_fields=$this->get_linked_fields();
1002 foreach($linked_fields as $name=>$properties)
1004 $this->load_relationship($name);
1009 * Returns an array of beans of related data.
1011 * For instance, if an account is related to 10 contacts , this function will return an array of contacts beans (10)
1012 * with each bean representing a contact record.
1013 * Method will load the relationship if not done so already.
1015 * @param string $field_name relationship to be loaded.
1016 * @param string $bean name class name of the related bean.
1017 * @param array $sort_array optional, unused
1018 * @param int $begin_index Optional, default 0, unused.
1019 * @param int $end_index Optional, default -1
1020 * @param int $deleted Optional, Default 0, 0 adds deleted=0 filter, 1 adds deleted=1 filter.
1021 * @param string $optional_where, Optional, default empty.
1023 * Internal function, do not override.
1025 function get_linked_beans($field_name,$bean_name, $sort_array = array(), $begin_index = 0, $end_index = -1,
1026 $deleted=0, $optional_where="")
1028 //if bean_name is Case then use aCase
1029 if($bean_name=="Case")
1030 $bean_name = "aCase";
1032 if($this->load_relationship($field_name)) {
1033 if ($this->$field_name instanceof Link) {
1034 // some classes are still based on Link, e.g. TeamSetLink
1035 return array_values($this->$field_name->getBeans(new $bean_name(), $sort_array, $begin_index, $end_index, $deleted, $optional_where));
1038 if ($end_index != -1 || !empty($deleted) || !empty($optional_where))
1039 return array_values($this->$field_name->getBeans(array(
1040 'where' => $optional_where,
1041 'deleted' => $deleted,
1042 'limit' => ($end_index - $begin_index)
1045 return array_values($this->$field_name->getBeans());
1053 * Returns an array of fields that are of type link.
1055 * @return array List of fields.
1057 * Internal function, do not override.
1059 function get_linked_fields()
1062 $linked_fields=array();
1064 // require_once('data/Link.php');
1066 $fieldDefs = $this->getFieldDefinitions();
1068 //find all definitions of type link.
1069 if (!empty($fieldDefs))
1071 foreach ($fieldDefs as $name=>$properties)
1073 if (array_search('link',$properties) === 'type')
1075 $linked_fields[$name]=$properties;
1080 return $linked_fields;
1084 * Returns an array of fields that are able to be Imported into
1085 * i.e. 'importable' not set to 'false'
1087 * @return array List of fields.
1089 * Internal function, do not override.
1091 function get_importable_fields()
1093 $importableFields = array();
1095 $fieldDefs= $this->getFieldDefinitions();
1097 if (!empty($fieldDefs)) {
1098 foreach ($fieldDefs as $key=>$value_array) {
1099 if ( (isset($value_array['importable'])
1100 && (is_string($value_array['importable']) && $value_array['importable'] == 'false'
1101 || is_bool($value_array['importable']) && $value_array['importable'] == false))
1102 || (isset($value_array['type']) && $value_array['type'] == 'link')
1103 || (isset($value_array['auto_increment'])
1104 && ($value_array['type'] == true || $value_array['type'] == 'true')) ) {
1105 // only allow import if we force it
1106 if (isset($value_array['importable'])
1107 && (is_string($value_array['importable']) && $value_array['importable'] == 'true'
1108 || is_bool($value_array['importable']) && $value_array['importable'] == true)) {
1109 $importableFields[$key]=$value_array;
1113 $importableFields[$key]=$value_array;
1118 return $importableFields;
1122 * Returns an array of fields that are of type relate.
1124 * @return array List of fields.
1126 * Internal function, do not override.
1128 function get_related_fields()
1131 $related_fields=array();
1133 // require_once('data/Link.php');
1135 $fieldDefs = $this->getFieldDefinitions();
1137 //find all definitions of type link.
1138 if (!empty($fieldDefs))
1140 foreach ($fieldDefs as $name=>$properties)
1142 if (array_search('relate',$properties) === 'type')
1144 $related_fields[$name]=$properties;
1149 return $related_fields;
1153 * Returns an array of fields that are required for import
1157 function get_import_required_fields()
1159 $importable_fields = $this->get_importable_fields();
1160 $required_fields = array();
1162 foreach ( $importable_fields as $name => $properties ) {
1163 if ( isset($properties['importable']) && is_string($properties['importable']) && $properties['importable'] == 'required' ) {
1164 $required_fields[$name] = $properties;
1168 return $required_fields;
1172 * Iterates through all the relationships and deletes all records for reach relationship.
1174 * @param string $id Primary key value of the parent reocrd
1176 function delete_linked($id)
1178 $linked_fields=$this->get_linked_fields();
1179 foreach ($linked_fields as $name => $value)
1181 if ($this->load_relationship($name))
1183 $this->$name->delete($id);
1187 $GLOBALS['log']->fatal("error loading relationship $name");
1193 * Creates tables for the module implementing the class.
1194 * If you override this function make sure that your code can handles table creation.
1197 function create_tables()
1201 $key = $this->getObjectName();
1202 if (!array_key_exists($key, $dictionary))
1204 $GLOBALS['log']->fatal("create_tables: Metadata for table ".$this->table_name. " does not exist");
1205 display_notice("meta data absent for table ".$this->table_name." keyed to $key ");
1209 if(!$this->db->tableExists($this->table_name))
1211 $this->db->createTable($this);
1212 if($this->bean_implements('ACL')){
1213 if(!empty($this->acltype)){
1214 ACLAction::addActions($this->getACLCategory(), $this->acltype);
1216 ACLAction::addActions($this->getACLCategory());
1222 echo "Table already exists : $this->table_name<br>";
1224 if($this->is_AuditEnabled()){
1225 if (!$this->db->tableExists($this->get_audit_table_name())) {
1226 $this->create_audit_table();
1234 * Delete the primary table for the module implementing the class.
1235 * If custom fields were added to this table/module, the custom table will be removed too, along with the cache
1236 * entries that define the custom fields.
1239 function drop_tables()
1242 $key = $this->getObjectName();
1243 if (!array_key_exists($key, $dictionary))
1245 $GLOBALS['log']->fatal("drop_tables: Metadata for table ".$this->table_name. " does not exist");
1246 echo "meta data absent for table ".$this->table_name."<br>\n";
1248 if(empty($this->table_name))return;
1249 if ($this->db->tableExists($this->table_name))
1251 $this->db->dropTable($this);
1252 if ($this->db->tableExists($this->table_name. '_cstm'))
1254 $this->db->dropTableName($this->table_name. '_cstm');
1255 DynamicField::deleteCache();
1257 if ($this->db->tableExists($this->get_audit_table_name())) {
1258 $this->db->dropTableName($this->get_audit_table_name());
1267 * Loads the definition of custom fields defined for the module.
1268 * Local file system cache is created as needed.
1270 * @param string $module_name setting up custom fields for this module.
1271 * @param boolean $clean_load Optional, default true, rebuilds the cache if set to true.
1273 function setupCustomFields($module_name, $clean_load=true)
1275 $this->custom_fields = new DynamicField($module_name);
1276 $this->custom_fields->setup($this);
1281 * Cleans char, varchar, text, etc. fields of XSS type materials
1283 function cleanBean() {
1284 foreach($this->field_defs as $key => $def) {
1286 if (isset($def['type'])) {
1289 if(isset($def['dbType']))
1290 $type .= $def['dbType'];
1292 if($def['type'] == 'html') {
1293 $this->$key = SugarCleaner::cleanHtml($this->$key, true);
1294 } elseif((strpos($type, 'char') !== false ||
1295 strpos($type, 'text') !== false ||
1299 $this->$key = SugarCleaner::cleanHtml($this->$key);
1305 * Implements a generic insert and update logic for any SugarBean
1306 * This method only works for subclasses that implement the same variable names.
1307 * This method uses the presence of an id field that is not null to signify and update.
1308 * The id field should not be set otherwise.
1310 * @param boolean $check_notify Optional, default false, if set to true assignee of the record is notified via email.
1311 * @todo Add support for field type validation and encoding of parameters.
1313 function save($check_notify = FALSE)
1315 $this->in_save = true;
1316 // cn: SECURITY - strip XSS potential vectors
1318 // This is used so custom/3rd-party code can be upgraded with fewer issues, this will be removed in a future release
1319 $this->fixUpFormatting();
1321 global $current_user, $action;
1324 if(empty($this->id))
1329 if ( $this->new_with_id == true )
1333 if(empty($this->date_modified) || $this->update_date_modified)
1335 $this->date_modified = $GLOBALS['timedate']->nowDb();
1338 $this->_checkOptimisticLocking($action, $isUpdate);
1340 if(!empty($this->modified_by_name)) $this->old_modified_by_name = $this->modified_by_name;
1341 if($this->update_modified_by)
1343 $this->modified_user_id = 1;
1345 if (!empty($current_user))
1347 $this->modified_user_id = $current_user->id;
1348 $this->modified_by_name = $current_user->user_name;
1351 if ($this->deleted != 1)
1355 if (empty($this->date_entered))
1357 $this->date_entered = $this->date_modified;
1359 if($this->set_created_by == true)
1361 // created by should always be this user
1362 $this->created_by = (isset($current_user)) ? $current_user->id : "";
1364 if( $this->new_with_id == false)
1366 $this->id = create_guid();
1372 require_once("data/BeanFactory.php");
1373 BeanFactory::registerBean($this->module_name, $this);
1375 if (empty($GLOBALS['updating_relationships']) && empty($GLOBALS['saving_relationships']) && empty ($GLOBALS['resavingRelatedBeans']))
1377 $GLOBALS['saving_relationships'] = true;
1378 // let subclasses save related field changes
1379 $this->save_relationship_changes($isUpdate);
1380 $GLOBALS['saving_relationships'] = false;
1382 if($isUpdate && !$this->update_date_entered)
1384 unset($this->date_entered);
1386 // call the custom business logic
1387 $custom_logic_arguments['check_notify'] = $check_notify;
1390 $this->call_custom_logic("before_save", $custom_logic_arguments);
1391 unset($custom_logic_arguments);
1393 if(isset($this->custom_fields))
1395 $this->custom_fields->bean = $this;
1396 $this->custom_fields->save($isUpdate);
1399 // use the db independent query generator
1400 $this->preprocess_fields_on_save();
1402 //construct the SQL to create the audit record if auditing is enabled.
1403 $dataChanges=array();
1404 if ($this->is_AuditEnabled()) {
1405 if ($isUpdate && !isset($this->fetched_row)) {
1406 $GLOBALS['log']->debug('Auditing: Retrieve was not called, audit record will not be created.');
1408 $dataChanges=$this->db->getDataChanges($this);
1412 $this->_sendNotifications($check_notify);
1415 $this->db->update($this);
1417 $this->db->insert($this);
1420 if (!empty($dataChanges) && is_array($dataChanges))
1422 foreach ($dataChanges as $change)
1424 $this->db->save_audit_records($this,$change);
1429 if (empty($GLOBALS['resavingRelatedBeans'])){
1430 SugarRelationship::resaveRelatedBeans();
1434 //If we aren't in setup mode and we have a current user and module, then we track
1435 if(isset($GLOBALS['current_user']) && isset($this->module_dir))
1437 $this->track_view($current_user->id, $this->module_dir, 'save');
1440 $this->call_custom_logic('after_save', '');
1442 //Now that the record has been saved, we don't want to insert again on further saves
1443 $this->new_with_id = false;
1444 $this->in_save = false;
1450 * Performs a check if the record has been modified since the specified date
1452 * @param date $date Datetime for verification
1453 * @param string $modified_user_id User modified by
1455 function has_been_modified_since($date, $modified_user_id)
1457 global $current_user;
1458 $date = $this->db->convert($this->db->quoted($date), 'datetime');
1459 if (isset($current_user))
1461 $query = "SELECT date_modified FROM $this->table_name WHERE id='$this->id' AND modified_user_id != '$current_user->id'
1462 AND (modified_user_id != '$modified_user_id' OR date_modified > $date)";
1463 $result = $this->db->query($query);
1465 if($this->db->fetchByAssoc($result))
1474 * Determines which users receive a notification
1476 function get_notification_recipients() {
1477 $notify_user = new User();
1478 $notify_user->retrieve($this->assigned_user_id);
1479 $this->new_assigned_user_name = $notify_user->full_name;
1481 $GLOBALS['log']->info("Notifications: recipient is $this->new_assigned_user_name");
1483 $user_list = array($notify_user);
1486 //send notifications to followers, but ensure to not query for the assigned_user.
1487 return SugarFollowing::getFollowers($this, $notify_user);
1492 * Handles sending out email notifications when items are first assigned to users
1494 * @param string $notify_user user to notify
1495 * @param string $admin the admin user that sends out the notification
1497 function send_assignment_notifications($notify_user, $admin)
1499 global $current_user;
1501 if(($this->object_name == 'Meeting' || $this->object_name == 'Call') || $notify_user->receive_notifications)
1503 $sendToEmail = $notify_user->emailAddress->getPrimaryAddress($notify_user);
1505 if(empty($sendToEmail)) {
1506 $GLOBALS['log']->warn("Notifications: no e-mail address set for user {$notify_user->user_name}, cancelling send");
1510 $notify_mail = $this->create_notification_email($notify_user);
1511 $notify_mail->setMailerForSystem();
1513 if(empty($admin->settings['notify_send_from_assigning_user'])) {
1514 $notify_mail->From = $admin->settings['notify_fromaddress'];
1515 $notify_mail->FromName = (empty($admin->settings['notify_fromname'])) ? "" : $admin->settings['notify_fromname'];
1517 // Send notifications from the current user's e-mail (if set)
1518 $fromAddress = $current_user->emailAddress->getReplyToAddress($current_user);
1519 $fromAddress = !empty($fromAddress) ? $fromAddress : $admin->settings['notify_fromaddress'];
1520 $notify_mail->From = $fromAddress;
1521 //Use the users full name is available otherwise default to system name
1522 $from_name = !empty($admin->settings['notify_fromname']) ? $admin->settings['notify_fromname'] : "";
1523 $from_name = !empty($current_user->full_name) ? $current_user->full_name : $from_name;
1524 $notify_mail->FromName = $from_name;
1527 $oe = new OutboundEmail();
1528 $oe = $oe->getUserMailerSettings($current_user);
1529 //only send if smtp server is defined
1531 $smtpVerified = false;
1533 //first check the user settings
1534 if(!empty($oe->mail_smtpserver)){
1535 $smtpVerified = true;
1538 //if still not verified, check against the system settings
1539 if (!$smtpVerified){
1540 $oe = $oe->getSystemMailerSettings();
1541 if(!empty($oe->mail_smtpserver)){
1542 $smtpVerified = true;
1545 //if smtp was not verified against user or system, then do not send out email
1546 if (!$smtpVerified){
1547 $GLOBALS['log']->fatal("Notifications: error sending e-mail, smtp server was not found ");
1552 if(!$notify_mail->Send()) {
1553 $GLOBALS['log']->fatal("Notifications: error sending e-mail (method: {$notify_mail->Mailer}), (error: {$notify_mail->ErrorInfo})");
1555 $GLOBALS['log']->info("Notifications: e-mail successfully sent");
1563 * This function handles create the email notifications email.
1564 * @param string $notify_user the user to send the notification email to
1566 function create_notification_email($notify_user) {
1567 global $sugar_version;
1568 global $sugar_config;
1569 global $app_list_strings;
1570 global $current_user;
1573 $OBCharset = $locale->getPrecedentPreference('default_email_charset');
1576 require_once("include/SugarPHPMailer.php");
1578 $notify_address = $notify_user->emailAddress->getPrimaryAddress($notify_user);
1579 $notify_name = $notify_user->full_name;
1580 $GLOBALS['log']->debug("Notifications: user has e-mail defined");
1582 $notify_mail = new SugarPHPMailer();
1583 $notify_mail->AddAddress($notify_address,$locale->translateCharsetMIME(trim($notify_name), 'UTF-8', $OBCharset));
1585 if(empty($_SESSION['authenticated_user_language'])) {
1586 $current_language = $sugar_config['default_language'];
1588 $current_language = $_SESSION['authenticated_user_language'];
1590 $xtpl = new XTemplate(get_notify_template_file($current_language));
1591 if($this->module_dir == "Cases") {
1592 $template_name = "Case"; //we should use Case, you can refer to the en_us.notify_template.html.
1595 $template_name = $beanList[$this->module_dir]; //bug 20637, in workflow this->object_name = strange chars.
1598 $this->current_notify_user = $notify_user;
1600 if(in_array('set_notification_body', get_class_methods($this))) {
1601 $xtpl = $this->set_notification_body($xtpl, $this);
1603 $xtpl->assign("OBJECT", translate('LBL_MODULE_NAME'));
1604 $template_name = "Default";
1606 if(!empty($_SESSION["special_notification"]) && $_SESSION["special_notification"]) {
1607 $template_name = $beanList[$this->module_dir].'Special';
1609 if($this->special_notification) {
1610 $template_name = $beanList[$this->module_dir].'Special';
1612 $xtpl->assign("ASSIGNED_USER", $this->new_assigned_user_name);
1613 $xtpl->assign("ASSIGNER", $current_user->name);
1616 if(isset($_SERVER['SERVER_PORT']) && $_SERVER['SERVER_PORT'] != 80 && $_SERVER['SERVER_PORT'] != 443) {
1617 $port = $_SERVER['SERVER_PORT'];
1620 if (!isset($_SERVER['HTTP_HOST'])) {
1621 $_SERVER['HTTP_HOST'] = '';
1624 $httpHost = $_SERVER['HTTP_HOST'];
1626 if($colon = strpos($httpHost, ':')) {
1627 $httpHost = substr($httpHost, 0, $colon);
1630 $parsedSiteUrl = parse_url($sugar_config['site_url']);
1631 $host = $parsedSiteUrl['host'];
1632 if(!isset($parsedSiteUrl['port'])) {
1633 $parsedSiteUrl['port'] = 80;
1636 $port = ($parsedSiteUrl['port'] != 80) ? ":".$parsedSiteUrl['port'] : '';
1637 $path = !empty($parsedSiteUrl['path']) ? $parsedSiteUrl['path'] : "";
1638 $cleanUrl = "{$parsedSiteUrl['scheme']}://{$host}{$port}{$path}";
1640 $xtpl->assign("URL", $cleanUrl."/index.php?module={$this->module_dir}&action=DetailView&record={$this->id}");
1641 $xtpl->assign("SUGAR", "Sugar v{$sugar_version}");
1642 $xtpl->parse($template_name);
1643 $xtpl->parse($template_name . "_Subject");
1645 $notify_mail->Body = from_html(trim($xtpl->text($template_name)));
1646 $notify_mail->Subject = from_html($xtpl->text($template_name . "_Subject"));
1648 // cn: bug 8568 encode notify email in User's outbound email encoding
1649 $notify_mail->prepForOutbound();
1651 return $notify_mail;
1655 * This function is a good location to save changes that have been made to a relationship.
1656 * This should be overridden in subclasses that have something to save.
1658 * @param boolean $is_update true if this save is an update.
1659 * @param array $exclude a way to exclude relationships
1661 public function save_relationship_changes($is_update, $exclude = array())
1663 list($new_rel_id, $new_rel_link) = $this->set_relationship_info($exclude);
1665 $new_rel_id = $this->handle_preset_relationships($new_rel_id, $new_rel_link, $exclude);
1667 $this->handle_remaining_relate_fields($exclude);
1669 $this->handle_request_relate($new_rel_id, $new_rel_link);
1673 * Look in the bean for the new relationship_id and relationship_name if $this->not_use_rel_in_req is set to true,
1674 * otherwise check the $_REQUEST param for a relate_id and relate_to field. Once we have that make sure that it's
1675 * not excluded from the passed in array of relationships to exclude
1677 * @param array $exclude any relationship's to exclude
1678 * @return array The relationship_id and relationship_name in an array
1680 protected function set_relationship_info($exclude = array())
1683 $new_rel_id = false;
1684 $new_rel_link = false;
1685 // check incoming data
1686 if (isset($this->not_use_rel_in_req) && $this->not_use_rel_in_req == true) {
1687 // if we should use relation data from properties (for REQUEST-independent calls)
1688 $rel_id = isset($this->new_rel_id) ? $this->new_rel_id : '';
1689 $rel_link = isset($this->new_rel_relname) ? $this->new_rel_relname : '';
1693 // if we should use relation data from REQUEST
1694 $rel_id = isset($_REQUEST['relate_id']) ? $_REQUEST['relate_id'] : '';
1695 $rel_link = isset($_REQUEST['relate_to']) ? $_REQUEST['relate_to'] : '';
1698 // filter relation data
1699 if ($rel_id && $rel_link && !in_array($rel_link, $exclude) && $rel_id != $this->id) {
1700 $new_rel_id = $rel_id;
1701 $new_rel_link = $rel_link;
1702 // Bug #53223 : wrong relationship from subpanel create button
1703 // if LHSModule and RHSModule are same module use left link to add new item b/s of:
1704 // $rel_id and $rel_link are not emty - request is from subpanel
1705 // $rel_link contains relationship name - checked by call load_relationship
1706 $this->load_relationship($rel_link);
1707 if ( !empty($this->$rel_link) && $this->$rel_link->getRelationshipObject() && $this->$rel_link->getRelationshipObject()->getLHSModule() == $this->$rel_link->getRelationshipObject()->getRHSModule() )
1709 $new_rel_link = $this->$rel_link->getRelationshipObject()->getLHSLink();
1713 //Try to find the link in this bean based on the relationship
1714 foreach ($this->field_defs as $key => $def)
1716 if (isset($def['type']) && $def['type'] == 'link' && isset($def['relationship']) && $def['relationship'] == $rel_link)
1718 $new_rel_link = $key;
1724 return array($new_rel_id, $new_rel_link);
1728 * Handle the preset fields listed in the fixed relationship_fields array hardcoded into the OOB beans
1730 * TODO: remove this mechanism and replace with mechanism exclusively based on the vardefs
1733 * @see save_relationship_changes
1734 * @param string|boolean $new_rel_id String of the ID to add
1735 * @param string Relationship Name
1736 * @param array $exclude any relationship's to exclude
1737 * @return string|boolean Return the new_rel_id if it was not used. False if it was used.
1739 protected function handle_preset_relationships($new_rel_id, $new_rel_link, $exclude = array())
1741 if (isset($this->relationship_fields) && is_array($this->relationship_fields)) {
1742 foreach ($this->relationship_fields as $id => $rel_name)
1745 if (in_array($id, $exclude)) continue;
1747 if(!empty($this->$id))
1749 // Bug #44930 We do not need to update main related field if it is changed from sub-panel.
1750 if ($rel_name == $new_rel_link && $this->$id != $new_rel_id)
1754 $GLOBALS['log']->debug('save_relationship_changes(): From relationship_field array - adding a relationship record: '.$rel_name . ' = ' . $this->$id);
1755 //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
1756 $this->load_relationship($rel_name);
1757 $rel_add = $this->$rel_name->add($this->$id);
1758 // move this around to only take out the id if it was save successfully
1759 if ($this->$id == $new_rel_id && $rel_add == true) {
1760 $new_rel_id = false;
1763 //if before value is not empty then attempt to delete relationship
1764 if (!empty($this->rel_fields_before_value[$id])) {
1765 $GLOBALS['log']->debug('save_relationship_changes(): From relationship_field array - attempting to remove the relationship record, using relationship attribute' . $rel_name);
1766 $this->load_relationship($rel_name);
1767 $this->$rel_name->delete($this->id, $this->rel_fields_before_value[$id]);
1777 * Next, we'll attempt to update all of the remaining relate fields in the vardefs that have 'save' set in their field_def
1778 * Only the 'save' fields should be saved as some vardef entries today are not for display only purposes and break the application if saved
1779 * If the vardef has entries for field <a> of type relate, where a->id_name = <b> and field <b> of type link
1780 * then we receive a value for b from the MVC in the _REQUEST, and it should be set in the bean as $this->$b
1783 * @see save_relationship_changes
1784 * @param array $exclude any relationship's to exclude
1785 * @return array the list of relationships that were added or removed successfully or if they were a failure
1787 protected function handle_remaining_relate_fields($exclude = array())
1790 $modified_relationships = array(
1791 'add' => array('success' => array(), 'failure' => array()),
1792 'remove' => array('success' => array(), 'failure' => array()),
1795 foreach ($this->field_defs as $def)
1797 if ($def ['type'] == 'relate' && isset ($def ['id_name']) && isset ($def ['link']) && isset ($def['save'])) {
1798 if (in_array($def['id_name'], $exclude) || in_array($def['id_name'], $this->relationship_fields))
1799 continue; // continue to honor the exclude array and exclude any relationships that will be handled by the relationship_fields mechanism
1801 $linkField = $def ['link'];
1802 if (isset($this->field_defs[$linkField])) {
1803 if ($this->load_relationship($linkField)) {
1804 $idName = $def['id_name'];
1806 if (!empty($this->rel_fields_before_value[$idName]) && empty($this->$idName)) {
1807 //if before value is not empty then attempt to delete relationship
1808 $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' ]]}");
1809 $success = $this->$def ['link']->delete($this->id, $this->rel_fields_before_value[$def ['id_name']]);
1810 // just need to make sure it's true and not an array as it's possible to return an array
1811 if($success == true) {
1812 $modified_relationships['remove']['success'][] = $def['link'];
1814 $modified_relationships['remove']['failure'][] = $def['link'];
1816 $GLOBALS['log']->debug("save_relationship_changes(): From field_defs - attempting to remove the relationship record returned " . var_export($success, true));
1819 if (!empty($this->$idName) && is_string($this->$idName)) {
1820 $GLOBALS['log']->debug("save_relationship_changes(): From field_defs - attempting to add a relationship record - {$def [ 'link' ]} = {$this->$def [ 'id_name' ]}");
1822 $success = $this->$linkField->add($this->$idName);
1824 // just need to make sure it's true and not an array as it's possible to return an array
1825 if($success == true) {
1826 $modified_relationships['add']['success'][] = $linkField;
1828 $modified_relationships['add']['failure'][] = $linkField;
1831 $GLOBALS['log']->debug("save_relationship_changes(): From field_defs - add a relationship record returned " . var_export($success, true));
1834 $GLOBALS['log']->fatal("Failed to load relationship {$linkField} while saving {$this->module_dir}");
1840 return $modified_relationships;
1844 * Finally, we update a field listed in the _REQUEST['%/relate_id']/_REQUEST['relate_to'] mechanism (if it has not already been updated)
1847 * @see save_relationship_changes
1848 * @param string|boolean $new_rel_id
1849 * @param string $new_rel_link
1852 protected function handle_request_relate($new_rel_id, $new_rel_link)
1854 if (!empty($new_rel_id)) {
1856 if ($this->load_relationship($new_rel_link)) {
1857 return $this->$new_rel_link->add($new_rel_id);
1859 $lower_link = strtolower($new_rel_link);
1860 if ($this->load_relationship($lower_link)) {
1861 return $this->$lower_link->add($new_rel_id);
1864 require_once('data/Link2.php');
1865 $rel = Relationship::retrieve_by_modules($new_rel_link, $this->module_dir, $this->db, 'many-to-many');
1868 foreach ($this->field_defs as $field => $def) {
1869 if ($def['type'] == 'link' && !empty($def['relationship']) && $def['relationship'] == $rel) {
1870 $this->load_relationship($field);
1871 return $this->$field->add($new_rel_id);
1875 //ok so we didn't find it in the field defs let's save it anyway if we have the relationshp
1877 $this->$rel = new Link2($rel, $this, array());
1878 return $this->$rel->add($new_rel_id);
1884 // nothing was saved so just return false;
1889 * This function retrieves a record of the appropriate type from the DB.
1890 * It fills in all of the fields from the DB into the object it was called on.
1892 * @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.
1893 * @return this - The object that it was called apon or null if exactly 1 record was not found.
1897 function check_date_relationships_load()
1899 global $disable_date_format;
1901 if (empty($timedate))
1902 $timedate=TimeDate::getInstance();
1904 if(empty($this->field_defs))
1908 foreach($this->field_defs as $fieldDef)
1910 $field = $fieldDef['name'];
1911 if(!isset($this->processed_dates_times[$field]))
1913 $this->processed_dates_times[$field] = '1';
1914 if(empty($this->$field)) continue;
1915 if($field == 'date_modified' || $field == 'date_entered')
1917 $this->$field = $this->db->fromConvert($this->$field, 'datetime');
1918 if(empty($disable_date_format)) {
1919 $this->$field = $timedate->to_display_date_time($this->$field);
1922 elseif(isset($this->field_name_map[$field]['type']))
1924 $type = $this->field_name_map[$field]['type'];
1926 if($type == 'relate' && isset($this->field_name_map[$field]['custom_module']))
1928 $type = $this->field_name_map[$field]['type'];
1933 if($this->$field == '0000-00-00')
1936 } elseif(!empty($this->field_name_map[$field]['rel_field']))
1938 $rel_field = $this->field_name_map[$field]['rel_field'];
1940 if(!empty($this->$rel_field))
1942 if(empty($disable_date_format)) {
1943 $mergetime = $timedate->merge_date_time($this->$field,$this->$rel_field);
1944 $this->$field = $timedate->to_display_date($mergetime);
1945 $this->$rel_field = $timedate->to_display_time($mergetime);
1951 if(empty($disable_date_format)) {
1952 $this->$field = $timedate->to_display_date($this->$field, false);
1955 } elseif($type == 'datetime' || $type == 'datetimecombo')
1957 if($this->$field == '0000-00-00 00:00:00')
1963 if(empty($disable_date_format)) {
1964 $this->$field = $timedate->to_display_date_time($this->$field, true, true);
1967 } elseif($type == 'time')
1969 if($this->$field == '00:00:00')
1974 //$this->$field = from_db_convert($this->$field, 'time');
1975 if(empty($this->field_name_map[$field]['rel_field']) && empty($disable_date_format))
1977 $this->$field = $timedate->to_display_time($this->$field,true, false);
1980 } elseif($type == 'encrypt' && empty($disable_date_format)){
1981 $this->$field = $this->decrypt_after_retrieve($this->$field);
1989 * This function processes the fields before save.
1990 * Interal function, do not override.
1992 function preprocess_fields_on_save()
1994 $GLOBALS['log']->deprecated('SugarBean.php: preprocess_fields_on_save() is deprecated');
1998 * Removes formatting from values posted from the user interface.
1999 * It only unformats numbers. Function relies on user/system prefernce for format strings.
2001 * Internal Function, do not override.
2003 function unformat_all_fields()
2005 $GLOBALS['log']->deprecated('SugarBean.php: unformat_all_fields() is deprecated');
2009 * This functions adds formatting to all number fields before presenting them to user interface.
2011 * Internal function, do not override.
2013 function format_all_fields()
2015 $GLOBALS['log']->deprecated('SugarBean.php: format_all_fields() is deprecated');
2018 function format_field($fieldDef)
2020 $GLOBALS['log']->deprecated('SugarBean.php: format_field() is deprecated');
2024 * Function corrects any bad formatting done by 3rd party/custom code
2026 * 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
2028 function fixUpFormatting()
2031 static $boolean_false_values = array('off', 'false', '0', 'no');
2034 foreach($this->field_defs as $field=>$def)
2036 if ( !isset($this->$field) ) {
2039 if ( (isset($def['source'])&&$def['source']=='non-db') || $field == 'deleted' ) {
2042 if ( isset($this->fetched_row[$field]) && $this->$field == $this->fetched_row[$field] ) {
2043 // Don't hand out warnings because the field was untouched between retrieval and saving, most database drivers hand pretty much everything back as strings.
2046 $reformatted = false;
2047 switch($def['type']) {
2049 case 'datetimecombo':
2050 if(empty($this->$field)) break;
2051 if ($this->$field == 'NULL') {
2055 if ( ! preg_match('/^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$/',$this->$field) ) {
2056 // This appears to be formatted in user date/time
2057 $this->$field = $timedate->to_db($this->$field);
2058 $reformatted = true;
2062 if(empty($this->$field)) break;
2063 if ($this->$field == 'NULL') {
2067 if ( ! preg_match('/^[0-9]{4}-[0-9]{2}-[0-9]{2}$/',$this->$field) ) {
2068 // This date appears to be formatted in the user's format
2069 $this->$field = $timedate->to_db_date($this->$field, false);
2070 $reformatted = true;
2074 if(empty($this->$field)) break;
2075 if ($this->$field == 'NULL') {
2079 if ( preg_match('/(am|pm)/i',$this->$field) ) {
2080 // This time appears to be formatted in the user's format
2081 $this->$field = $timedate->fromUserTime($this->$field)->format(TimeDate::DB_TIME_FORMAT);
2082 $reformatted = true;
2089 if ( $this->$field === '' || $this->$field == NULL || $this->$field == 'NULL') {
2092 if ( is_string($this->$field) ) {
2093 $this->$field = (float)unformat_number($this->$field);
2094 $reformatted = true;
2103 if ( $this->$field === '' || $this->$field == NULL || $this->$field == 'NULL') {
2106 if ( is_string($this->$field) ) {
2107 $this->$field = (int)unformat_number($this->$field);
2108 $reformatted = true;
2112 if (empty($this->$field)) {
2113 $this->$field = false;
2114 } else if(true === $this->$field || 1 == $this->$field) {
2115 $this->$field = true;
2116 } else if(in_array(strval($this->$field), $boolean_false_values)) {
2117 $this->$field = false;
2118 $reformatted = true;
2120 $this->$field = true;
2121 $reformatted = true;
2125 $this->$field = $this->encrpyt_before_save($this->$field);
2128 if ( $reformatted ) {
2129 $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');
2136 * Function fetches a single row of data given the primary key value.
2138 * The fetched data is then set into the bean. The function also processes the fetched data by formattig
2139 * date/time and numeric values.
2141 * @param string $id Optional, default -1, is set to -1 id value from the bean is used, else, passed value is used
2142 * @param boolean $encode Optional, default true, encodes the values fetched from the database.
2143 * @param boolean $deleted Optional, default true, if set to false deleted filter will not be added.
2145 * Internal function, do not override.
2147 function retrieve($id = -1, $encode=true,$deleted=true)
2150 $custom_logic_arguments['id'] = $id;
2151 $this->call_custom_logic('before_retrieve', $custom_logic_arguments);
2157 if(isset($this->custom_fields))
2159 $custom_join = $this->custom_fields->getJOIN();
2162 $custom_join = false;
2166 $query = "SELECT $this->table_name.*". $custom_join['select']. " FROM $this->table_name ";
2170 $query = "SELECT $this->table_name.* FROM $this->table_name ";
2175 $query .= ' ' . $custom_join['join'];
2177 $query .= " WHERE $this->table_name.id = ".$this->db->quoted($id);
2178 if ($deleted) $query .= " AND $this->table_name.deleted=0";
2179 $GLOBALS['log']->debug("Retrieve $this->object_name : ".$query);
2180 $result = $this->db->limitQuery($query,0,1,true, "Retrieving record by id $this->table_name:$id found ");
2186 $row = $this->db->fetchByAssoc($result, $encode);
2192 //make copy of the fetched row for construction of audit record and for business logic/workflow
2193 $row = $this->convertRow($row);
2194 $this->fetched_row=$row;
2195 $this->populateFromRow($row);
2197 global $module, $action;
2198 //Just to get optimistic locking working for this release
2199 if($this->optimistic_lock && $module == $this->module_dir && $action =='EditView' )
2201 $_SESSION['o_lock_id']= $id;
2202 $_SESSION['o_lock_dm']= $this->date_modified;
2203 $_SESSION['o_lock_on'] = $this->object_name;
2205 $this->processed_dates_times = array();
2206 $this->check_date_relationships_load();
2210 $this->custom_fields->fill_relationships();
2213 $this->is_updated_dependent_fields = false;
2214 $this->fill_in_additional_detail_fields();
2215 $this->fill_in_relationship_fields();
2216 // save related fields values for audit
2217 foreach ($this->get_related_fields() as $rel_field_name)
2219 if (! empty($this->$rel_field_name['name']))
2221 $this->fetched_rel_row[$rel_field_name['name']] = $this->$rel_field_name['name'];
2224 //make a copy of fields in the relationship_fields array. These field values will be used to
2225 //clear relationship.
2226 foreach ( $this->field_defs as $key => $def )
2228 if ($def [ 'type' ] == 'relate' && isset ( $def [ 'id_name'] ) && isset ( $def [ 'link'] ) && isset ( $def[ 'save' ])) {
2229 if (isset($this->$key)) {
2230 $this->rel_fields_before_value[$key]=$this->$key;
2231 if (isset($this->$def [ 'id_name']))
2232 $this->rel_fields_before_value[$def [ 'id_name']]=$this->$def [ 'id_name'];
2235 $this->rel_fields_before_value[$key]=null;
2238 if (isset($this->relationship_fields) && is_array($this->relationship_fields))
2240 foreach ($this->relationship_fields as $rel_id=>$rel_name)
2242 if (isset($this->$rel_id))
2243 $this->rel_fields_before_value[$rel_id]=$this->$rel_id;
2245 $this->rel_fields_before_value[$rel_id]=null;
2249 // call the custom business logic
2250 $custom_logic_arguments['id'] = $id;
2251 $custom_logic_arguments['encode'] = $encode;
2252 $this->call_custom_logic("after_retrieve", $custom_logic_arguments);
2253 unset($custom_logic_arguments);
2258 * Sets value from fetched row into the bean.
2260 * @param array $row Fetched row
2261 * @todo loop through vardefs instead
2262 * @internal runs into an issue when populating from field_defs for users - corrupts user prefs
2264 * Internal function, do not override.
2266 function populateFromRow($row)
2269 foreach($this->field_defs as $field=>$field_value)
2271 if($field == 'user_preferences' && $this->module_dir == 'Users')
2273 if(isset($row[$field]))
2275 $this->$field = $row[$field];
2276 $owner = $field . '_owner';
2277 if(!empty($row[$owner])){
2278 $this->$owner = $row[$owner];
2283 $this->$field = $nullvalue;
2291 * Add any required joins to the list count query. The joins are required if there
2292 * is a field in the $where clause that needs to be joined.
2294 * @param string $query
2295 * @param string $where
2297 * Internal Function, do Not override.
2299 function add_list_count_joins(&$query, $where)
2301 $custom_join = $this->custom_fields->getJOIN();
2304 $query .= $custom_join['join'];
2310 * Changes the select expression of the given query to be 'count(*)' so you
2311 * can get the number of items the query will return. This is used to
2312 * populate the upper limit on ListViews.
2314 * @param string $query Select query string
2315 * @return string count query
2317 * Internal function, do not override.
2319 function create_list_count_query($query)
2321 // remove the 'order by' clause which is expected to be at the end of the query
2322 $pattern = '/\sORDER BY.*/is'; // ignores the case
2324 $query = preg_replace($pattern, $replacement, $query);
2325 //handle distinct clause
2327 if(substr_count(strtolower($query), 'distinct')){
2328 if (!empty($this->seed) && !empty($this->seed->table_name ))
2329 $star = 'DISTINCT ' . $this->seed->table_name . '.id';
2331 $star = 'DISTINCT ' . $this->table_name . '.id';
2335 // change the select expression to 'count(*)'
2336 $pattern = '/SELECT(.*?)(\s){1}FROM(\s){1}/is'; // ignores the case
2337 $replacement = 'SELECT count(' . $star . ') c FROM ';
2339 //if the passed query has union clause then replace all instances of the pattern.
2340 //this is very rare. I have seen this happening only from projects module.
2341 //in addition to this added a condition that has union clause and uses
2343 if (strstr($query," UNION ALL ") !== false) {
2345 //separate out all the queries.
2346 $union_qs=explode(" UNION ALL ", $query);
2347 foreach ($union_qs as $key=>$union_query) {
2349 preg_match($pattern, $union_query, $matches);
2350 if (!empty($matches)) {
2351 if (stristr($matches[0], "distinct")) {
2352 if (!empty($this->seed) && !empty($this->seed->table_name ))
2353 $star = 'DISTINCT ' . $this->seed->table_name . '.id';
2355 $star = 'DISTINCT ' . $this->table_name . '.id';
2358 $replacement = 'SELECT count(' . $star . ') c FROM ';
2359 $union_qs[$key] = preg_replace($pattern, $replacement, $union_query,1);
2361 $modified_select_query=implode(" UNION ALL ",$union_qs);
2363 $modified_select_query = preg_replace($pattern, $replacement, $query,1);
2367 return $modified_select_query;
2371 * This function returns a paged list of the current object type. It is intended to allow for
2372 * hopping back and forth through pages of data. It only retrieves what is on the current page.
2374 * @internal This method must be called on a new instance. It trashes the values of all the fields in the current one.
2375 * @param string $order_by
2376 * @param string $where Additional where clause
2377 * @param int $row_offset Optaional,default 0, starting row number
2378 * @param init $limit Optional, default -1
2379 * @param int $max Optional, default -1
2380 * @param boolean $show_deleted Optional, default 0, if set to 1 system will show deleted records.
2381 * @return array Fetched data.
2383 * Internal function, do not override.
2386 function get_list($order_by = "", $where = "", $row_offset = 0, $limit=-1, $max=-1, $show_deleted = 0, $singleSelect=false, $select_fields = array())
2388 $GLOBALS['log']->debug("get_list: order_by = '$order_by' and where = '$where' and limit = '$limit'");
2389 if(isset($_SESSION['show_deleted']))
2393 $order_by=$this->process_order_by($order_by);
2395 if($this->bean_implements('ACL') && ACLController::requireOwner($this->module_dir, 'list') )
2397 global $current_user;
2398 $owner_where = $this->getOwnerWhere($current_user->id);
2400 //rrs - because $this->getOwnerWhere() can return '' we need to be sure to check for it and
2401 //handle it properly else you could get into a situation where you are create a where stmt like
2403 if(!empty($owner_where)){
2405 $where = $owner_where;
2407 $where .= ' AND '. $owner_where;
2411 $query = $this->create_new_list_query($order_by, $where,$select_fields,array(), $show_deleted,'',false,null,$singleSelect);
2412 return $this->process_list_query($query, $row_offset, $limit, $max, $where);
2416 * Prefixes column names with this bean's table name.
2418 * @param string $order_by Order by clause to be processed
2419 * @param SugarBean $submodule name of the module this order by clause is for
2420 * @return string Processed order by clause
2422 * Internal function, do not override.
2424 function process_order_by ($order_by, $submodule = null)
2426 if (empty($order_by))
2428 //submodule is empty,this is for list object in focus
2429 if (empty($submodule))
2431 $bean_queried = $this;
2435 //submodule is set, so this is for subpanel, use submodule
2436 $bean_queried = $submodule;
2438 $elements = explode(',',$order_by);
2439 foreach ($elements as $key=>$value)
2441 if (strchr($value,'.') === false)
2443 //value might have ascending and descending decorations
2444 $list_column = explode(' ',trim($value));
2445 if (isset($list_column[0]))
2447 $list_column_name=trim($list_column[0]);
2448 if (isset($bean_queried->field_defs[$list_column_name]))
2450 $source=isset($bean_queried->field_defs[$list_column_name]['source']) ? $bean_queried->field_defs[$list_column_name]['source']:'db';
2451 if (empty($bean_queried->field_defs[$list_column_name]['table']) && $source=='db')
2453 $list_column[0] = $bean_queried->table_name .".".$list_column[0] ;
2455 if (empty($bean_queried->field_defs[$list_column_name]['table']) && $source=='custom_fields')
2457 $list_column[0] = $bean_queried->table_name ."_cstm.".$list_column[0] ;
2459 // Bug 38803 - Use CONVERT() function when doing an order by on ntext, text, and image fields
2460 if ($source != 'non-db' && $this->db->isTextType($this->db->getFieldType($bean_queried->field_defs[$list_column_name]))) {
2461 $list_column[0] = $this->db->convert($list_column[0], "text2char");
2463 $value = implode(' ',$list_column);
2465 $GLOBALS['log']->debug("process_order_by: ($list_column[0]) does not have a vardef entry.");
2469 $elements[$key]=$value;
2471 return implode(',', $elements);
2477 * Returns a detail object like retrieving of the current object type.
2479 * It is intended for use in navigation buttons on the DetailView. It will pass an offset and limit argument to the sql query.
2480 * @internal This method must be called on a new instance. It overrides the values of all the fields in the current one.
2482 * @param string $order_by
2483 * @param string $where Additional where clause
2484 * @param int $row_offset Optaional,default 0, starting row number
2485 * @param init $limit Optional, default -1
2486 * @param int $max Optional, default -1
2487 * @param boolean $show_deleted Optioanl, default 0, if set to 1 system will show deleted records.
2488 * @return array Fetched data.
2490 * Internal function, do not override.
2492 function get_detail($order_by = "", $where = "", $offset = 0, $row_offset = 0, $limit=-1, $max=-1, $show_deleted = 0)
2494 $GLOBALS['log']->debug("get_detail: order_by = '$order_by' and where = '$where' and limit = '$limit' and offset = '$offset'");
2495 if(isset($_SESSION['show_deleted']))
2500 if($this->bean_implements('ACL') && ACLController::requireOwner($this->module_dir, 'list') )
2502 global $current_user;
2503 $owner_where = $this->getOwnerWhere($current_user->id);
2507 $where = $owner_where;
2511 $where .= ' AND '. $owner_where;
2514 $query = $this->create_new_list_query($order_by, $where,array(),array(), $show_deleted, $offset);
2516 //Add Limit and Offset to query
2517 //$query .= " LIMIT 1 OFFSET $offset";
2519 return $this->process_detail_query($query, $row_offset, $limit, $max, $where, $offset);
2523 * Fetches data from all related tables.
2525 * @param object $child_seed
2526 * @param string $related_field_name relation to fetch data for
2527 * @param string $order_by Optional, default empty
2528 * @param string $where Optional, additional where clause
2529 * @return array Fetched data.
2531 * Internal function, do not override.
2533 function get_related_list($child_seed,$related_field_name, $order_by = "", $where = "",
2534 $row_offset = 0, $limit=-1, $max=-1, $show_deleted = 0)
2536 global $layout_edit_mode;
2537 $query_array = array();
2539 if(isset($layout_edit_mode) && $layout_edit_mode)
2541 $response = array();
2542 $child_seed->assign_display_fields($child_seed->module_dir);
2543 $response['list'] = array($child_seed);
2544 $response['row_count'] = 1;
2545 $response['next_offset'] = 0;
2546 $response['previous_offset'] = 0;
2550 $GLOBALS['log']->debug("get_related_list: order_by = '$order_by' and where = '$where' and limit = '$limit'");
2551 if(isset($_SESSION['show_deleted']))
2556 $this->load_relationship($related_field_name);
2558 if ($this->$related_field_name instanceof Link) {
2560 $query_array = $this->$related_field_name->getQuery(true);
2563 $query_array = $this->$related_field_name->getQuery(array(
2564 "return_as_array" => true,
2565 'where' => '1=1' // hook for 'where' clause in M2MRelationship file
2569 $entire_where = $query_array['where'];
2572 if(empty($entire_where))
2574 $entire_where = ' WHERE ' . $where;
2578 $entire_where .= ' AND ' . $where;
2582 $query = 'SELECT '.$child_seed->table_name.'.* ' . $query_array['from'] . ' ' . $entire_where;
2583 if(!empty($order_by))
2585 $query .= " ORDER BY " . $order_by;
2588 return $child_seed->process_list_query($query, $row_offset, $limit, $max, $where);
2592 protected static function build_sub_queries_for_union($subpanel_list, $subpanel_def, $parentbean, $order_by)
2594 global $layout_edit_mode, $beanFiles, $beanList;
2595 $subqueries = array();
2596 foreach($subpanel_list as $this_subpanel)
2598 if(!$this_subpanel->isDatasourceFunction() || ($this_subpanel->isDatasourceFunction()
2599 && isset($this_subpanel->_instance_properties['generate_select'])
2600 && $this_subpanel->_instance_properties['generate_select']==true))
2602 //the custom query function must return an array with
2603 if ($this_subpanel->isDatasourceFunction()) {
2604 $shortcut_function_name = $this_subpanel->get_data_source_name();
2605 $parameters=$this_subpanel->get_function_parameters();
2606 if (!empty($parameters))
2608 //if the import file function is set, then import the file to call the custom function from
2609 if (is_array($parameters) && isset($parameters['import_function_file'])){
2610 //this call may happen multiple times, so only require if function does not exist
2611 if(!function_exists($shortcut_function_name)){
2612 require_once($parameters['import_function_file']);
2614 //call function from required file
2615 $query_array = $shortcut_function_name($parameters);
2617 //call function from parent bean
2618 $query_array = $parentbean->$shortcut_function_name($parameters);
2623 $query_array = $parentbean->$shortcut_function_name();
2626 $related_field_name = $this_subpanel->get_data_source_name();
2627 if (!$parentbean->load_relationship($related_field_name)){
2628 unset ($parentbean->$related_field_name);
2631 $query_array = $parentbean->$related_field_name->getSubpanelQuery(array(), true);
2633 $table_where = $this_subpanel->get_where();
2634 $where_definition = $query_array['where'];
2636 if(!empty($table_where))
2638 if(empty($where_definition))
2640 $where_definition = $table_where;
2644 $where_definition .= ' AND ' . $table_where;
2648 $submodulename = $this_subpanel->_instance_properties['module'];
2649 $submoduleclass = $beanList[$submodulename];
2650 //require_once($beanFiles[$submoduleclass]);
2651 $submodule = new $submoduleclass();
2652 $subwhere = $where_definition;
2656 $subwhere = str_replace('WHERE', '', $subwhere);
2657 $list_fields = $this_subpanel->get_list_fields();
2658 foreach($list_fields as $list_key=>$list_field)
2660 if(isset($list_field['usage']) && $list_field['usage'] == 'display_only')
2662 unset($list_fields[$list_key]);
2667 if(!$subpanel_def->isCollection() && isset($list_fields[$order_by]) && isset($submodule->field_defs[$order_by])&& (!isset($submodule->field_defs[$order_by]['source']) || $submodule->field_defs[$order_by]['source'] == 'db'))
2669 $order_by = $submodule->table_name .'.'. $order_by;
2671 $table_name = $this_subpanel->table_name;
2672 $panel_name=$this_subpanel->name;
2674 $params['distinct'] = $this_subpanel->distinct_query();
2676 $params['joined_tables'] = $query_array['join_tables'];
2677 $params['include_custom_fields'] = !$subpanel_def->isCollection();
2678 $params['collection_list'] = $subpanel_def->get_inst_prop_value('collection_list');
2680 $subquery = $submodule->create_new_list_query('',$subwhere ,$list_fields,$params, 0,'', true,$parentbean);
2682 $subquery['select'] = $subquery['select']." , '$panel_name' panel_name ";
2683 $subquery['from'] = $subquery['from'].$query_array['join'];
2684 $subquery['query_array'] = $query_array;
2685 $subquery['params'] = $params;
2687 $subqueries[] = $subquery;
2694 * Constructs a query to fetch data for supanels and list views
2696 * It constructs union queries for activities subpanel.
2698 * @param SugarBean $parentbean constructing queries for link attributes in this bean
2699 * @param string $order_by Optional, order by clause
2700 * @param string $sort_order Optional, sort order
2701 * @param string $where Optional, additional where clause
2703 * Internal Function, do not overide.
2705 function get_union_related_list($parentbean, $order_by = "", $sort_order='', $where = "",
2706 $row_offset = 0, $limit=-1, $max=-1, $show_deleted = 0, $subpanel_def)
2708 $secondary_queries = array();
2709 global $layout_edit_mode, $beanFiles, $beanList;
2711 if(isset($_SESSION['show_deleted']))
2716 $final_query_rows = '';
2717 $subpanel_list=array();
2718 if ($subpanel_def->isCollection())
2720 $subpanel_def->load_sub_subpanels();
2721 $subpanel_list=$subpanel_def->sub_subpanels;
2725 $subpanel_list[]=$subpanel_def;
2730 //Breaking the building process into two loops. The first loop gets a list of all the sub-queries.
2731 //The second loop merges the queries and forces them to select the same number of columns
2732 //All columns in a sub-subpanel group must have the same aliases
2733 //If the subpanel is a datasource function, it can't be a collection so we just poll that function for the and return that
2734 foreach($subpanel_list as $this_subpanel)
2736 if($this_subpanel->isDatasourceFunction() && empty($this_subpanel->_instance_properties['generate_select']))
2738 $shortcut_function_name = $this_subpanel->get_data_source_name();
2739 $parameters=$this_subpanel->get_function_parameters();
2740 if (!empty($parameters))
2742 //if the import file function is set, then import the file to call the custom function from
2743 if (is_array($parameters) && isset($parameters['import_function_file'])){
2744 //this call may happen multiple times, so only require if function does not exist
2745 if(!function_exists($shortcut_function_name)){
2746 require_once($parameters['import_function_file']);
2748 //call function from required file
2749 $tmp_final_query = $shortcut_function_name($parameters);
2751 //call function from parent bean
2752 $tmp_final_query = $parentbean->$shortcut_function_name($parameters);
2755 $tmp_final_query = $parentbean->$shortcut_function_name();
2759 $final_query_rows .= ' UNION ALL ( '.$parentbean->create_list_count_query($tmp_final_query, $parameters) . ' )';
2760 $final_query .= ' UNION ALL ( '.$tmp_final_query . ' )';
2762 $final_query_rows = '(' . $parentbean->create_list_count_query($tmp_final_query, $parameters) . ')';
2763 $final_query = '(' . $tmp_final_query . ')';
2768 //If final_query is still empty, its time to build the sub-queries
2769 if (empty($final_query))
2771 $subqueries = SugarBean::build_sub_queries_for_union($subpanel_list, $subpanel_def, $parentbean, $order_by);
2772 $all_fields = array();
2773 foreach($subqueries as $i => $subquery)
2775 $query_fields = $GLOBALS['db']->getSelectFieldsFromQuery($subquery['select']);
2776 foreach($query_fields as $field => $select)
2778 if (!in_array($field, $all_fields))
2779 $all_fields[] = $field;
2781 $subqueries[$i]['query_fields'] = $query_fields;
2784 //Now ensure the queries have the same set of fields in the same order.
2785 foreach($subqueries as $subquery)
2787 $subquery['select'] = "SELECT";
2788 foreach($all_fields as $field)
2790 if (!isset($subquery['query_fields'][$field]))
2792 $subquery['select'] .= " ' ' $field,";
2796 $subquery['select'] .= " {$subquery['query_fields'][$field]},";
2799 $subquery['select'] = substr($subquery['select'], 0 , strlen($subquery['select']) - 1);
2800 //Put the query into the final_query
2801 $query = $subquery['select'] . " " . $subquery['from'] . " " . $subquery['where'];
2804 $query = ' UNION ALL ( '.$query . ' )';
2805 $final_query_rows .= " UNION ALL ";
2807 $query = '(' . $query . ')';
2810 $query_array = $subquery['query_array'];
2811 $select_position=strpos($query_array['select'],"SELECT");
2812 $distinct_position=strpos($query_array['select'],"DISTINCT");
2813 if (!empty($subquery['params']['distinct']) && !empty($subpanel_def->table_name))
2815 $query_rows = "( SELECT count(DISTINCT ". $subpanel_def->table_name . ".id)". $subquery['from_min'].$query_array['join']. $subquery['where'].' )';
2817 elseif ($select_position !== false && $distinct_position!= false)
2819 $query_rows = "( ".substr_replace($query_array['select'],"SELECT count(",$select_position,6). ")" . $subquery['from_min'].$query_array['join']. $subquery['where'].' )';
2823 //resort to default behavior.
2824 $query_rows = "( SELECT count(*)". $subquery['from_min'].$query_array['join']. $subquery['where'].' )';
2826 if(!empty($subquery['secondary_select']))
2829 $subquerystring= $subquery['secondary_select'] . $subquery['secondary_from'].$query_array['join']. $subquery['where'];
2830 if (!empty($subquery['secondary_where']))
2832 if (empty($subquery['where']))
2834 $subquerystring.=" WHERE " .$subquery['secondary_where'];
2838 $subquerystring.=" AND " .$subquery['secondary_where'];
2841 $secondary_queries[]=$subquerystring;
2843 $final_query .= $query;
2844 $final_query_rows .= $query_rows;
2848 if(!empty($order_by))
2851 if(!$subpanel_def->isCollection())
2853 $submodulename = $subpanel_def->_instance_properties['module'];
2854 $submoduleclass = $beanList[$submodulename];
2855 $submodule = new $submoduleclass();
2857 if(!empty($submodule) && !empty($submodule->table_name))
2859 $final_query .= " ORDER BY " .$parentbean->process_order_by($order_by, $submodule);
2864 $final_query .= " ORDER BY ". $order_by . ' ';
2866 if(!empty($sort_order))
2868 $final_query .= ' ' .$sort_order;
2873 if(isset($layout_edit_mode) && $layout_edit_mode)
2875 $response = array();
2876 if(!empty($submodule))
2878 $submodule->assign_display_fields($submodule->module_dir);
2879 $response['list'] = array($submodule);
2883 $response['list'] = array();
2885 $response['parent_data'] = array();
2886 $response['row_count'] = 1;
2887 $response['next_offset'] = 0;
2888 $response['previous_offset'] = 0;
2893 return $parentbean->process_union_list_query($parentbean, $final_query, $row_offset, $limit, $max, '',$subpanel_def, $final_query_rows, $secondary_queries);
2898 * Returns a full (ie non-paged) list of the current object type.
2900 * @param string $order_by the order by SQL parameter. defaults to ""
2901 * @param string $where where clause. defaults to ""
2902 * @param boolean $check_dates. defaults to false
2903 * @param int $show_deleted show deleted records. defaults to 0
2905 function get_full_list($order_by = "", $where = "", $check_dates=false, $show_deleted = 0)
2907 $GLOBALS['log']->debug("get_full_list: order_by = '$order_by' and where = '$where'");
2908 if(isset($_SESSION['show_deleted']))
2912 $query = $this->create_new_list_query($order_by, $where,array(),array(), $show_deleted);
2913 return $this->process_full_list_query($query, $check_dates);
2917 * Return the list query used by the list views and export button. Next generation of create_new_list_query function.
2919 * Override this function to return a custom query.
2921 * @param string $order_by custom order by clause
2922 * @param string $where custom where clause
2923 * @param array $filter Optioanal
2924 * @param array $params Optional *
2925 * @param int $show_deleted Optional, default 0, show deleted records is set to 1.
2926 * @param string $join_type
2927 * @param boolean $return_array Optional, default false, response as array
2928 * @param object $parentbean creating a subquery for this bean.
2929 * @param boolean $singleSelect Optional, default false.
2930 * @return String select query string, optionally an array value will be returned if $return_array= true.
2932 function create_new_list_query($order_by, $where,$filter=array(),$params=array(), $show_deleted = 0,$join_type='', $return_array = false,$parentbean=null, $singleSelect = false, $ifListForExport = false)
2934 global $beanFiles, $beanList;
2935 $selectedFields = array();
2936 $secondarySelectedFields = array();
2937 $ret_array = array();
2939 if($this->bean_implements('ACL') && ACLController::requireOwner($this->module_dir, 'list') )
2941 global $current_user;
2942 $owner_where = $this->getOwnerWhere($current_user->id);
2945 $where = $owner_where;
2949 $where .= ' AND '. $owner_where;
2952 if(!empty($params['distinct']))
2954 $distinct = ' DISTINCT ';
2958 $ret_array['select'] = " SELECT $distinct $this->table_name.* ";
2962 $ret_array['select'] = " SELECT $distinct $this->table_name.id ";
2964 $ret_array['from'] = " FROM $this->table_name ";
2965 $ret_array['from_min'] = $ret_array['from'];
2966 $ret_array['secondary_from'] = $ret_array['from'] ;
2967 $ret_array['where'] = '';
2968 $ret_array['order_by'] = '';
2969 //secondary selects are selects that need to be run after the primary query to retrieve additional info on main
2972 $ret_array['secondary_select']=& $ret_array['select'];
2973 $ret_array['secondary_from'] = & $ret_array['from'];
2977 $ret_array['secondary_select'] = '';
2979 $custom_join = false;
2980 if((!isset($params['include_custom_fields']) || $params['include_custom_fields']) && isset($this->custom_fields))
2983 $custom_join = $this->custom_fields->getJOIN( empty($filter)? true: $filter );
2986 $ret_array['select'] .= ' ' .$custom_join['select'];
2991 $ret_array['from'] .= ' ' . $custom_join['join'];
2992 // Bug 52490 - Captivea (Sve) - To be able to add custom fields inside where clause in a subpanel
2993 $ret_array['from_min'] .= ' ' . $custom_join['join'];
2996 //LOOP AROUND FOR FIXIN VARDEF ISSUES
2997 require('include/VarDefHandler/listvardefoverride.php');
2998 if (file_exists('custom/include/VarDefHandler/listvardefoverride.php'))
3000 require('custom/include/VarDefHandler/listvardefoverride.php');
3003 $joined_tables = array();
3004 if(!empty($params['joined_tables']))
3006 foreach($params['joined_tables'] as $table)
3008 $joined_tables[$table] = 1;
3014 $filterKeys = array_keys($filter);
3015 if(is_numeric($filterKeys[0]))
3018 foreach($filter as $field)
3020 $field = strtolower($field);
3021 //remove out id field so we don't duplicate it
3022 if ( $field == 'id' && !empty($filter) ) {
3025 if(isset($this->field_defs[$field]))
3027 $fields[$field]= $this->field_defs[$field];
3031 $fields[$field] = array('force_exists'=>true);
3040 $fields = $this->field_defs;
3043 $used_join_key = array();
3045 foreach($fields as $field=>$value)
3047 //alias is used to alias field names
3049 if (isset($value['alias']))
3051 $alias =' as ' . $value['alias'] . ' ';
3054 if(empty($this->field_defs[$field]) || !empty($value['force_blank']) )
3056 if(!empty($filter) && isset($filter[$field]['force_exists']) && $filter[$field]['force_exists'])
3058 if ( isset($filter[$field]['force_default']) )
3059 $ret_array['select'] .= ", {$filter[$field]['force_default']} $field ";
3061 //spaces are a fix for length issue problem with unions. The union only returns the maximum number of characters from the first select statement.
3062 $ret_array['select'] .= ", ' ' $field ";
3068 $data = $this->field_defs[$field];
3071 //ignore fields that are a part of the collection and a field has been removed as a result of
3072 //layout customization.. this happens in subpanel customizations, use case, from the contacts subpanel
3073 //in opportunities module remove the contact_role/opportunity_role field.
3074 $process_field=true;
3075 if (isset($data['relationship_fields']) and !empty($data['relationship_fields']))
3077 foreach ($data['relationship_fields'] as $field_name)
3079 if (!isset($fields[$field_name]))
3081 $process_field=false;
3085 if (!$process_field)
3090 if( (!isset($data['source']) || $data['source'] == 'db') && (!empty($alias) || !empty($filter) ))
3092 $ret_array['select'] .= ", $this->table_name.$field $alias";
3093 $selectedFields["$this->table_name.$field"] = true;
3094 } else if( (!isset($data['source']) || $data['source'] == 'custom_fields') && (!empty($alias) || !empty($filter) )) {
3095 //add this column only if it has NOT already been added to select statement string
3096 $colPos = strpos($ret_array['select'],"$this->table_name"."_cstm".".$field");
3097 if(!$colPos || $colPos<0)
3099 $ret_array['select'] .= ", $this->table_name"."_cstm".".$field $alias";
3102 $selectedFields["$this->table_name.$field"] = true;
3105 if($data['type'] != 'relate' && isset($data['db_concat_fields']))
3107 $ret_array['select'] .= ", " . $this->db->concat($this->table_name, $data['db_concat_fields']) . " as $field";
3108 $selectedFields[$this->db->concat($this->table_name, $data['db_concat_fields'])] = true;
3110 //Custom relate field or relate fields built in module builder which have no link field associated.
3111 if ($data['type'] == 'relate' && (isset($data['custom_module']) || isset($data['ext2']))) {
3112 $joinTableAlias = 'jt' . $jtcount;
3113 $relateJoinInfo = $this->custom_fields->getRelateJoin($data, $joinTableAlias);
3114 $ret_array['select'] .= $relateJoinInfo['select'];
3115 $ret_array['from'] .= $relateJoinInfo['from'];
3116 //Replace any references to the relationship in the where clause with the new alias
3117 //If the link isn't set, assume that search used the local table for the field
3118 $searchTable = isset($data['link']) ? $relateJoinInfo['rel_table'] : $this->table_name;
3119 $field_name = $relateJoinInfo['rel_table'] . '.' . !empty($data['name'])?$data['name']:'name';
3120 $where = preg_replace('/(^|[\s(])' . $field_name . '/' , '${1}' . $relateJoinInfo['name_field'], $where);
3124 if ($data['type'] == 'parent') {
3125 //See if we need to join anything by inspecting the where clause
3126 $match = preg_match('/(^|[\s(])parent_(\w+)_(\w+)\.name/', $where, $matches);
3128 $joinTableAlias = 'jt' . $jtcount;
3129 $joinModule = $matches[2];
3130 $joinTable = $matches[3];
3131 $localTable = $this->table_name;
3132 if (!empty($data['custom_module'])) {
3133 $localTable .= '_cstm';
3135 global $beanFiles, $beanList, $module;
3136 require_once($beanFiles[$beanList[$joinModule]]);
3137 $rel_mod = new $beanList[$joinModule]();
3138 $nameField = "$joinTableAlias.name";
3139 if (isset($rel_mod->field_defs['name']))
3141 $name_field_def = $rel_mod->field_defs['name'];
3142 if(isset($name_field_def['db_concat_fields']))
3144 $nameField = $this->db->concat($joinTableAlias, $name_field_def['db_concat_fields']);
3147 $ret_array['select'] .= ", $nameField {$data['name']} ";
3148 $ret_array['from'] .= " LEFT JOIN $joinTable $joinTableAlias
3149 ON $localTable.{$data['id_name']} = $joinTableAlias.id";
3150 //Replace any references to the relationship in the where clause with the new alias
3151 $where = preg_replace('/(^|[\s(])parent_' . $joinModule . '_' . $joinTable . '\.name/', '${1}' . $nameField, $where);
3155 if($data['type'] == 'relate' && isset($data['link']))
3157 $this->load_relationship($data['link']);
3158 if(!empty($this->$data['link']))
3161 if(empty($join_type))
3163 $params['join_type'] = ' LEFT JOIN ';
3167 $params['join_type'] = $join_type;
3169 if(isset($data['join_name']))
3171 $params['join_table_alias'] = $data['join_name'];
3175 $params['join_table_alias'] = 'jt' . $jtcount;
3178 if(isset($data['join_link_name']))
3180 $params['join_table_link_alias'] = $data['join_link_name'];
3184 $params['join_table_link_alias'] = 'jtl' . $jtcount;
3186 $join_primary = !isset($data['join_primary']) || $data['join_primary'];
3188 $join = $this->$data['link']->getJoin($params, true);
3189 $used_join_key[] = $join['rel_key'];
3190 $rel_module = $this->$data['link']->getRelatedModuleName();
3191 $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');
3193 //if rname is set to 'name', and bean files exist, then check if field should be a concatenated name
3194 global $beanFiles, $beanList;
3195 if($data['rname'] && !empty($beanFiles[$beanList[$rel_module]])) {
3197 //create an instance of the related bean
3198 require_once($beanFiles[$beanList[$rel_module]]);
3199 $rel_mod = new $beanList[$rel_module]();
3200 //if bean has first and last name fields, then name should be concatenated
3201 if(isset($rel_mod->field_name_map['first_name']) && isset($rel_mod->field_name_map['last_name'])){
3202 $data['db_concat_fields'] = array(0=>'first_name', 1=>'last_name');
3207 if($join['type'] == 'many-to-many')
3209 if(empty($ret_array['secondary_select']))
3211 $ret_array['secondary_select'] = " SELECT $this->table_name.id ref_id ";
3213 if(!empty($beanFiles[$beanList[$rel_module]]) && $join_primary)
3215 require_once($beanFiles[$beanList[$rel_module]]);
3216 $rel_mod = new $beanList[$rel_module]();
3217 if(isset($rel_mod->field_defs['assigned_user_id']))
3219 $ret_array['secondary_select'].= " , ". $params['join_table_alias'] . ".assigned_user_id {$field}_owner, '$rel_module' {$field}_mod";
3223 if(isset($rel_mod->field_defs['created_by']))
3225 $ret_array['secondary_select'].= " , ". $params['join_table_alias'] . ".created_by {$field}_owner , '$rel_module' {$field}_mod";
3231 if(isset($data['db_concat_fields']))
3233 $ret_array['secondary_select'] .= ' , ' . $this->db->concat($params['join_table_alias'], $data['db_concat_fields']) . ' ' . $field;
3237 if(!isset($data['relationship_fields']))
3239 $ret_array['secondary_select'] .= ' , ' . $params['join_table_alias'] . '.' . $data['rname'] . ' ' . $field;
3244 $ret_array['select'] .= ", ' ' $field ";
3247 foreach($used_join_key as $used_key) {
3248 if($used_key == $join['rel_key']) $count_used++;
3250 if($count_used <= 1) {//27416, the $ret_array['secondary_select'] should always generate, regardless the dbtype
3251 // add rel_key only if it was not aready added
3254 $ret_array['select'] .= ", ' ' " . $join['rel_key'] . ' ';
3256 $ret_array['secondary_select'] .= ', ' . $params['join_table_link_alias'].'.'. $join['rel_key'] .' ' . $join['rel_key'];
3258 if(isset($data['relationship_fields']))
3260 foreach($data['relationship_fields'] as $r_name=>$alias_name)
3262 if(!empty( $secondarySelectedFields[$alias_name]))continue;
3263 $ret_array['secondary_select'] .= ', ' . $params['join_table_link_alias'].'.'. $r_name .' ' . $alias_name;
3264 $secondarySelectedFields[$alias_name] = true;
3269 $ret_array['secondary_from'] .= ' ' . $join['join']. ' AND ' . $params['join_table_alias'].'.deleted=0';
3270 if (isset($data['link_type']) && $data['link_type'] == 'relationship_info' && ($parentbean instanceOf SugarBean))
3272 $ret_array['secondary_where'] = $params['join_table_link_alias'] . '.' . $join['rel_key']. "='" .$parentbean->id . "'";
3278 if(isset($data['db_concat_fields']))
3280 $ret_array['select'] .= ' , ' . $this->db->concat($params['join_table_alias'], $data['db_concat_fields']) . ' ' . $field;
3284 $ret_array['select'] .= ' , ' . $params['join_table_alias'] . '.' . $data['rname'] . ' ' . $field;
3286 if(isset($data['additionalFields'])){
3287 foreach($data['additionalFields'] as $k=>$v){
3288 $ret_array['select'] .= ' , ' . $params['join_table_alias'] . '.' . $k . ' ' . $v;
3293 $ret_array['from'] .= ' ' . $join['join']. ' AND ' . $params['join_table_alias'].'.deleted=0';
3294 if(!empty($beanList[$rel_module]) && !empty($beanFiles[$beanList[$rel_module]]))
3296 require_once($beanFiles[$beanList[$rel_module]]);
3297 $rel_mod = new $beanList[$rel_module]();
3298 if(isset($value['target_record_key']) && !empty($filter))
3300 $selectedFields[$this->table_name.'.'.$value['target_record_key']] = true;
3301 $ret_array['select'] .= " , $this->table_name.{$value['target_record_key']} ";
3303 if(isset($rel_mod->field_defs['assigned_user_id']))
3305 $ret_array['select'] .= ' , ' .$params['join_table_alias'] . '.assigned_user_id ' . $field . '_owner';
3309 $ret_array['select'] .= ' , ' .$params['join_table_alias'] . '.created_by ' . $field . '_owner';
3311 $ret_array['select'] .= " , '".$rel_module ."' " . $field . '_mod';
3316 // To fix SOAP stuff where we are trying to retrieve all the accounts data where accounts.id = ..
3317 // and this code changes accounts to jt4 as there is a self join with the accounts table.
3319 if(isset($data['db_concat_fields'])){
3320 $buildWhere = false;
3321 if(in_array('first_name', $data['db_concat_fields']) && in_array('last_name', $data['db_concat_fields']))
3323 $exp = '/\(\s*?'.$data['name'].'.*?\%\'\s*?\)/';
3324 if(preg_match($exp, $where, $matches))
3326 $search_expression = $matches[0];
3327 //Create three search conditions - first + last, first, last
3328 $first_name_search = str_replace($data['name'], $params['join_table_alias'] . '.first_name', $search_expression);
3329 $last_name_search = str_replace($data['name'], $params['join_table_alias'] . '.last_name', $search_expression);
3330 $full_name_search = str_replace($data['name'], $this->db->concat($params['join_table_alias'], $data['db_concat_fields']), $search_expression);
3332 $where = str_replace($search_expression, '(' . $full_name_search . ' OR ' . $first_name_search . ' OR ' . $last_name_search . ')', $where);
3338 $db_field = $this->db->concat($params['join_table_alias'], $data['db_concat_fields']);
3339 $where = preg_replace('/'.$data['name'].'/', $db_field, $where);
3342 $where = preg_replace('/(^|[\s(])' . $data['name'] . '/', '${1}' . $params['join_table_alias'] . '.'.$data['rname'], $where);
3346 $joined_tables[$params['join_table_alias']]=1;
3347 $joined_tables[$params['join_table_link_alias']]=1;
3356 if(isset($this->field_defs['assigned_user_id']) && empty($selectedFields[$this->table_name.'.assigned_user_id']))
3358 $ret_array['select'] .= ", $this->table_name.assigned_user_id ";
3360 else if(isset($this->field_defs['created_by']) && empty($selectedFields[$this->table_name.'.created_by']))
3362 $ret_array['select'] .= ", $this->table_name.created_by ";
3364 if(isset($this->field_defs['system_id']) && empty($selectedFields[$this->table_name.'.system_id']))
3366 $ret_array['select'] .= ", $this->table_name.system_id ";
3371 if ($ifListForExport) {
3372 if(isset($this->field_defs['email1'])) {
3373 $ret_array['select'].= " ,email_addresses.email_address email1";
3374 $ret_array['from'].= " LEFT JOIN email_addr_bean_rel on {$this->table_name}.id = email_addr_bean_rel.bean_id and email_addr_bean_rel.bean_module='{$this->module_dir}' and email_addr_bean_rel.deleted=0 and email_addr_bean_rel.primary_address=1 LEFT JOIN email_addresses on email_addresses.id = email_addr_bean_rel.email_address_id ";
3378 $where_auto = '1=1';
3379 if($show_deleted == 0)
3381 $where_auto = "$this->table_name.deleted=0";
3382 }else if($show_deleted == 1)
3384 $where_auto = "$this->table_name.deleted=1";
3387 $ret_array['where'] = " where ($where) AND $where_auto";
3389 $ret_array['where'] = " where $where_auto";
3390 if(!empty($order_by))
3392 //make call to process the order by clause
3393 $ret_array['order_by'] = " ORDER BY ". $this->process_order_by($order_by);
3397 unset($ret_array['secondary_where']);
3398 unset($ret_array['secondary_from']);
3399 unset($ret_array['secondary_select']);
3407 return $ret_array['select'] . $ret_array['from'] . $ret_array['where']. $ret_array['order_by'];
3410 * Returns parent record data for objects that store relationship information
3412 * @param array $type_info
3414 * Interal function, do not override.
3416 function retrieve_parent_fields($type_info)
3419 global $beanList, $beanFiles;
3420 $templates = array();
3421 $parent_child_map = array();
3422 foreach($type_info as $children_info)
3424 foreach($children_info as $child_info)
3426 if($child_info['type'] == 'parent')
3428 if(empty($templates[$child_info['parent_type']]))
3430 //Test emails will have an invalid parent_type, don't try to load the non-existent parent bean
3431 if ($child_info['parent_type'] == 'test') {
3434 $class = $beanList[$child_info['parent_type']];
3435 // Added to avoid error below; just silently fail and write message to log
3436 if ( empty($beanFiles[$class]) ) {
3437 $GLOBALS['log']->error($this->object_name.'::retrieve_parent_fields() - cannot load class "'.$class.'", skip loading.');
3440 require_once($beanFiles[$class]);
3441 $templates[$child_info['parent_type']] = new $class();
3444 if(empty($queries[$child_info['parent_type']]))
3446 $queries[$child_info['parent_type']] = "SELECT id ";
3447 $field_def = $templates[$child_info['parent_type']]->field_defs['name'];
3448 if(isset($field_def['db_concat_fields']))
3450 $queries[$child_info['parent_type']] .= ' , ' . $this->db->concat($templates[$child_info['parent_type']]->table_name, $field_def['db_concat_fields']) . ' parent_name';
3454 $queries[$child_info['parent_type']] .= ' , name parent_name';
3456 if(isset($templates[$child_info['parent_type']]->field_defs['assigned_user_id']))
3458 $queries[$child_info['parent_type']] .= ", assigned_user_id parent_name_owner , '{$child_info['parent_type']}' parent_name_mod";;
3459 }else if(isset($templates[$child_info['parent_type']]->field_defs['created_by']))
3461 $queries[$child_info['parent_type']] .= ", created_by parent_name_owner, '{$child_info['parent_type']}' parent_name_mod";
3463 $queries[$child_info['parent_type']] .= " FROM " . $templates[$child_info['parent_type']]->table_name ." WHERE id IN ('{$child_info['parent_id']}'";
3467 if(empty($parent_child_map[$child_info['parent_id']]))
3468 $queries[$child_info['parent_type']] .= " ,'{$child_info['parent_id']}'";
3470 $parent_child_map[$child_info['parent_id']][] = $child_info['child_id'];
3475 foreach($queries as $query)
3477 $result = $this->db->query($query . ')');
3478 while($row = $this->db->fetchByAssoc($result))
3480 $results[$row['id']] = $row;
3484 $child_results = array();
3485 foreach($parent_child_map as $parent_key=>$parent_child)
3487 foreach($parent_child as $child)
3489 if(isset( $results[$parent_key]))
3491 $child_results[$child] = $results[$parent_key];
3495 return $child_results;
3499 * Processes the list query and return fetched row.
3501 * Internal function, do not override.
3502 * @param string $query select query to be processed.
3503 * @param int $row_offset starting position
3504 * @param int $limit Optioanl, default -1
3505 * @param int $max_per_page Optional, default -1
3506 * @param string $where Optional, additional filter criteria.
3507 * @return array Fetched data
3509 function process_list_query($query, $row_offset, $limit= -1, $max_per_page = -1, $where = '')
3511 global $sugar_config;
3512 $db = DBManagerFactory::getInstance('listviews');
3514 * if the row_offset is set to 'end' go to the end of the list
3516 $toEnd = strval($row_offset) == 'end';
3517 $GLOBALS['log']->debug("process_list_query: ".$query);
3518 if($max_per_page == -1)
3520 $max_per_page = $sugar_config['list_max_entries_per_page'];
3522 // Check to see if we have a count query available.
3523 if(empty($sugar_config['disable_count_query']) || $toEnd)
3525 $count_query = $this->create_list_count_query($query);
3526 if(!empty($count_query) && (empty($limit) || $limit == -1))
3528 // We have a count query. Run it and get the results.
3529 $result = $db->query($count_query, true, "Error running count query for $this->object_name List: ");
3530 $assoc = $db->fetchByAssoc($result);
3531 if(!empty($assoc['c']))
3533 $rows_found = $assoc['c'];
3534 $limit = $sugar_config['list_max_entries_per_page'];
3538 $row_offset = (floor(($rows_found -1) / $limit)) * $limit;
3544 if((empty($limit) || $limit == -1))
3546 $limit = $max_per_page + 1;
3547 $max_per_page = $limit;
3552 if(empty($row_offset))
3556 if(!empty($limit) && $limit != -1 && $limit != -99)
3558 $result = $db->limitQuery($query, $row_offset, $limit,true,"Error retrieving $this->object_name list: ");
3562 $result = $db->query($query,true,"Error retrieving $this->object_name list: ");
3567 $previous_offset = $row_offset - $max_per_page;
3568 $next_offset = $row_offset + $max_per_page;
3570 $class = get_class($this);
3571 //FIXME: Bug? we should remove the magic number -99
3572 //use -99 to return all
3573 $index = $row_offset;
3574 while ($max_per_page == -99 || ($index < $row_offset + $max_per_page))
3576 $row = $db->fetchByAssoc($result);
3577 if (empty($row)) break;
3579 //instantiate a new class each time. This is because php5 passes
3580 //by reference by default so if we continually update $this, we will
3581 //at the end have a list of all the same objects
3582 $temp = new $class();
3584 foreach($this->field_defs as $field=>$value)
3586 if (isset($row[$field]))
3588 $temp->$field = $row[$field];
3589 $owner_field = $field . '_owner';
3590 if(isset($row[$owner_field]))
3592 $temp->$owner_field = $row[$owner_field];
3595 $GLOBALS['log']->debug("$temp->object_name({$row['id']}): ".$field." = ".$temp->$field);
3596 }else if (isset($row[$this->table_name .'.'.$field]))
3598 $temp->$field = $row[$this->table_name .'.'.$field];
3606 $temp->check_date_relationships_load();
3607 $temp->fill_in_additional_list_fields();
3608 if($temp->hasCustomFields()) $temp->custom_fields->fill_relationships();
3609 $temp->call_custom_logic("process_record");
3611 // fix defect #44206. implement the same logic as sugar_currency_format
3612 // Smarty modifier does.
3613 if (property_exists($temp, 'currency_id') && -99 == $temp->currency_id)
3615 // manually retrieve default currency object as long as it's
3616 // not stored in database and thus cannot be joined in query
3617 require_once 'modules/Currencies/Currency.php';
3618 $currency = new Currency();
3619 $currency->retrieve($temp->currency_id);
3621 // walk through all currency-related fields
3622 foreach ($temp->field_defs as $temp_field)
3624 if (isset($temp_field['type']) && 'relate' == $temp_field['type']
3625 && isset($temp_field['module']) && 'Currencies' == $temp_field['module']
3626 && isset($temp_field['id_name']) && 'currency_id' == $temp_field['id_name'])
3628 // populate related properties manually
3629 $temp_property = $temp_field['name'];
3630 $currency_property = $temp_field['rname'];
3631 $temp->$temp_property = $currency->$currency_property;
3640 if(!empty($sugar_config['disable_count_query']) && !empty($limit))
3643 $rows_found = $row_offset + count($list);
3645 unset($list[$limit - 1]);
3651 } else if(!isset($rows_found)){
3652 $rows_found = $row_offset + count($list);
3655 $response = Array();
3656 $response['list'] = $list;
3657 $response['row_count'] = $rows_found;
3658 $response['next_offset'] = $next_offset;
3659 $response['previous_offset'] = $previous_offset;
3660 $response['current_offset'] = $row_offset ;
3665 * Returns the number of rows that the given SQL query should produce
3667 * Internal function, do not override.
3668 * @param string $query valid select query
3669 * @param boolean $is_count_query Optional, Default false, set to true if passed query is a count query.
3670 * @return int count of rows found
3672 function _get_num_rows_in_query($query, $is_count_query=false)
3674 $num_rows_in_query = 0;
3675 if (!$is_count_query)
3677 $count_query = SugarBean::create_list_count_query($query);
3679 $count_query=$query;
3681 $result = $this->db->query($count_query, true, "Error running count query for $this->object_name List: ");
3683 while($row = $this->db->fetchByAssoc($result, true))
3685 $num_rows_in_query += current($row);
3688 return $num_rows_in_query;
3692 * Applies pagination window to union queries used by list view and subpanels,
3693 * executes the query and returns fetched data.
3695 * Internal function, do not override.
3696 * @param object $parent_bean
3697 * @param string $query query to be processed.
3698 * @param int $row_offset
3699 * @param int $limit optional, default -1
3700 * @param int $max_per_page Optional, default -1
3701 * @param string $where Custom where clause.
3702 * @param array $subpanel_def definition of sub-panel to be processed
3703 * @param string $query_row_count
3704 * @param array $seconday_queries
3705 * @return array Fetched data.
3707 function process_union_list_query($parent_bean, $query,
3708 $row_offset, $limit= -1, $max_per_page = -1, $where = '', $subpanel_def, $query_row_count='', $secondary_queries = array())
3711 $db = DBManagerFactory::getInstance('listviews');
3713 * if the row_offset is set to 'end' go to the end of the list
3715 $toEnd = strval($row_offset) == 'end';
3716 global $sugar_config;
3717 $use_count_query=false;
3718 $processing_collection=$subpanel_def->isCollection();
3720 $GLOBALS['log']->debug("process_union_list_query: ".$query);
3721 if($max_per_page == -1)
3723 $max_per_page = $sugar_config['list_max_entries_per_subpanel'];
3725 if(empty($query_row_count))
3727 $query_row_count = $query;
3729 $distinct_position=strpos($query_row_count,"DISTINCT");
3731 if ($distinct_position!= false)
3733 $use_count_query=true;
3735 $performSecondQuery = true;
3736 if(empty($sugar_config['disable_count_query']) || $toEnd)
3738 $rows_found = $this->_get_num_rows_in_query($query_row_count,$use_count_query);
3741 $performSecondQuery = false;
3743 if(!empty($rows_found) && (empty($limit) || $limit == -1))
3745 $limit = $sugar_config['list_max_entries_per_subpanel'];
3749 $row_offset = (floor(($rows_found -1) / $limit)) * $limit;
3755 if((empty($limit) || $limit == -1))
3757 $limit = $max_per_page + 1;
3758 $max_per_page = $limit;
3762 if(empty($row_offset))
3767 $previous_offset = $row_offset - $max_per_page;
3768 $next_offset = $row_offset + $max_per_page;
3770 if($performSecondQuery)
3772 if(!empty($limit) && $limit != -1 && $limit != -99)
3774 $result = $db->limitQuery($query, $row_offset, $limit,true,"Error retrieving $parent_bean->object_name list: ");
3778 $result = $db->query($query,true,"Error retrieving $this->object_name list: ");
3780 //use -99 to return all
3782 // get the current row
3783 $index = $row_offset;
3784 $row = $db->fetchByAssoc($result);
3786 $post_retrieve = array();
3787 $isFirstTime = true;
3790 $function_fields = array();
3791 if(($index < $row_offset + $max_per_page || $max_per_page == -99))
3793 if ($processing_collection)
3795 $current_bean =$subpanel_def->sub_subpanels[$row['panel_name']]->template_instance;
3798 $class = get_class($subpanel_def->sub_subpanels[$row['panel_name']]->template_instance);
3799 $current_bean = new $class();
3802 $current_bean=$subpanel_def->template_instance;
3805 $class = get_class($subpanel_def->template_instance);
3806 $current_bean = new $class();
3809 $isFirstTime = false;
3810 //set the panel name in the bean instance.
3811 if (isset($row['panel_name']))
3813 $current_bean->panel_name=$row['panel_name'];
3815 foreach($current_bean->field_defs as $field=>$value)
3818 if (isset($row[$field]))
3820 $current_bean->$field = $this->convertField($row[$field], $value);
3821 unset($row[$field]);
3823 else if (isset($row[$this->table_name .'.'.$field]))
3825 $current_bean->$field = $this->convertField($row[$this->table_name .'.'.$field], $value);
3826 unset($row[$this->table_name .'.'.$field]);
3830 $current_bean->$field = "";
3831 unset($row[$field]);
3833 if(isset($value['source']) && $value['source'] == 'function')
3835 $function_fields[]=$field;
3838 foreach($row as $key=>$value)
3840 $current_bean->$key = $value;
3842 foreach($function_fields as $function_field)
3844 $value = $current_bean->field_defs[$function_field];
3845 $can_execute = true;
3846 $execute_params = array();
3847 $execute_function = array();
3848 if(!empty($value['function_class']))
3850 $execute_function[] = $value['function_class'];
3851 $execute_function[] = $value['function_name'];
3855 $execute_function = $value['function_name'];
3857 foreach($value['function_params'] as $param )
3859 if (empty($value['function_params_source']) or $value['function_params_source']=='parent')
3861 if(empty($this->$param))
3863 $can_execute = false;
3864 } else if($param == '$this') {
3865 $execute_params[] = $this;
3869 $execute_params[] = $this->$param;
3871 } else if ($value['function_params_source']=='this')
3873 if(empty($current_bean->$param))
3875 $can_execute = false;
3876 } else if($param == '$this') {
3877 $execute_params[] = $current_bean;
3881 $execute_params[] = $current_bean->$param;
3886 $can_execute = false;
3892 if(!empty($value['function_require']))
3894 require_once($value['function_require']);
3896 $current_bean->$function_field = call_user_func_array($execute_function, $execute_params);
3899 if(!empty($current_bean->parent_type) && !empty($current_bean->parent_id))
3901 if(!isset($post_retrieve[$current_bean->parent_type]))
3903 $post_retrieve[$current_bean->parent_type] = array();
3905 $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');
3907 //$current_bean->fill_in_additional_list_fields();
3908 $list[$current_bean->id] = $current_bean;
3910 // go to the next row
3912 $row = $db->fetchByAssoc($result);
3914 //now handle retrieving many-to-many relationships
3917 foreach($secondary_queries as $query2)
3919 $result2 = $db->query($query2);
3921 $row2 = $db->fetchByAssoc($result2);
3924 $id_ref = $row2['ref_id'];
3926 if(isset($list[$id_ref]))
3928 foreach($row2 as $r2key=>$r2value)
3930 if($r2key != 'ref_id')
3932 $list[$id_ref]->$r2key = $r2value;
3936 $row2 = $db->fetchByAssoc($result2);
3942 if(isset($post_retrieve))
3944 $parent_fields = $this->retrieve_parent_fields($post_retrieve);
3948 $parent_fields = array();
3950 if(!empty($sugar_config['disable_count_query']) && !empty($limit))
3952 //C.L. Bug 43535 - Use the $index value to set the $rows_found value here
3953 $rows_found = isset($index) ? $index : $row_offset + count($list);
3955 if(count($list) >= $limit)
3969 $parent_fields = array();
3971 $response = array();
3972 $response['list'] = $list;
3973 $response['parent_data'] = $parent_fields;
3974 $response['row_count'] = $rows_found;
3975 $response['next_offset'] = $next_offset;
3976 $response['previous_offset'] = $previous_offset;
3977 $response['current_offset'] = $row_offset ;
3978 $response['query'] = $query;
3984 * Applies pagination window to select queries used by detail view,
3985 * executes the query and returns fetched data.
3987 * Internal function, do not override.
3988 * @param string $query query to be processed.
3989 * @param int $row_offset
3990 * @param int $limit optional, default -1
3991 * @param int $max_per_page Optional, default -1
3992 * @param string $where Custom where clause.
3993 * @param int $offset Optional, default 0
3994 * @return array Fetched data.
3997 function process_detail_query($query, $row_offset, $limit= -1, $max_per_page = -1, $where = '', $offset = 0)
3999 global $sugar_config;
4000 $GLOBALS['log']->debug("process_detail_query: ".$query);
4001 if($max_per_page == -1)
4003 $max_per_page = $sugar_config['list_max_entries_per_page'];
4006 // Check to see if we have a count query available.
4007 $count_query = $this->create_list_count_query($query);
4009 if(!empty($count_query) && (empty($limit) || $limit == -1))
4011 // We have a count query. Run it and get the results.
4012 $result = $this->db->query($count_query, true, "Error running count query for $this->object_name List: ");
4013 $assoc = $this->db->fetchByAssoc($result);
4014 if(!empty($assoc['c']))
4016 $total_rows = $assoc['c'];
4020 if(empty($row_offset))
4025 $result = $this->db->limitQuery($query, $offset, 1, true,"Error retrieving $this->object_name list: ");
4027 $previous_offset = $row_offset - $max_per_page;
4028 $next_offset = $row_offset + $max_per_page;
4030 $row = $this->db->fetchByAssoc($result);
4031 $this->retrieve($row['id']);
4033 $response = Array();
4034 $response['bean'] = $this;
4035 if (empty($total_rows))
4037 $response['row_count'] = $total_rows;
4038 $response['next_offset'] = $next_offset;
4039 $response['previous_offset'] = $previous_offset;
4045 * Processes fetched list view data
4047 * Internal function, do not override.
4048 * @param string $query query to be processed.
4049 * @param boolean $check_date Optional, default false. if set to true date time values are processed.
4050 * @return array Fetched data.
4053 function process_full_list_query($query, $check_date=false)
4056 $GLOBALS['log']->debug("process_full_list_query: query is ".$query);
4057 $result = $this->db->query($query, false);
4058 $GLOBALS['log']->debug("process_full_list_query: result is ".print_r($result,true));
4059 $class = get_class($this);
4060 $isFirstTime = true;
4061 $bean = new $class();
4063 // We have some data.
4064 while (($row = $bean->db->fetchByAssoc($result)) != null)
4066 $row = $this->convertRow($row);
4069 $bean = new $class();
4071 $isFirstTime = false;
4073 foreach($bean->field_defs as $field=>$value)
4075 if (isset($row[$field]))
4077 $bean->$field = $row[$field];
4078 $GLOBALS['log']->debug("process_full_list: $bean->object_name({$row['id']}): ".$field." = ".$bean->$field);
4087 $bean->processed_dates_times = array();
4088 $bean->check_date_relationships_load();
4090 $bean->fill_in_additional_list_fields();
4091 $bean->call_custom_logic("process_record");
4092 $bean->fetched_row = $row;
4097 if (isset($list)) return $list;
4102 * Tracks the viewing of a detail record.
4103 * This leverages get_summary_text() which is object specific.
4105 * Internal function, do not override.
4106 * @param string $user_id - String value of the user that is viewing the record.
4107 * @param string $current_module - String value of the module being processed.
4108 * @param string $current_view - String value of the current view
4110 function track_view($user_id, $current_module, $current_view='')
4112 $trackerManager = TrackerManager::getInstance();
4113 if($monitor = $trackerManager->getMonitor('tracker')){
4114 $monitor->setValue('date_modified', $GLOBALS['timedate']->nowDb());
4115 $monitor->setValue('user_id', $user_id);
4116 $monitor->setValue('module_name', $current_module);
4117 $monitor->setValue('action', $current_view);
4118 $monitor->setValue('item_id', $this->id);
4119 $monitor->setValue('item_summary', $this->get_summary_text());
4120 $monitor->setValue('visible', $this->tracker_visibility);
4121 $trackerManager->saveMonitor($monitor);
4126 * Returns the summary text that should show up in the recent history list for this object.
4130 public function get_summary_text()
4132 return "Base Implementation. Should be overridden.";
4136 * This is designed to be overridden and add specific fields to each record.
4137 * This allows the generic query to fill in the major fields, and then targeted
4138 * queries to get related fields and add them to the record. The contact's
4139 * account for instance. This method is only used for populating extra fields
4142 function fill_in_additional_list_fields(){
4143 if(!empty($this->field_defs['parent_name']) && empty($this->parent_name)){
4144 $this->fill_in_additional_parent_fields();
4149 * This is designed to be overridden and add specific fields to each record.
4150 * This allows the generic query to fill in the major fields, and then targeted
4151 * queries to get related fields and add them to the record. The contact's
4152 * account for instance. This method is only used for populating extra fields
4153 * in the detail form
4155 function fill_in_additional_detail_fields()
4157 if(!empty($this->field_defs['assigned_user_name']) && !empty($this->assigned_user_id)){
4159 $this->assigned_user_name = get_assigned_user_name($this->assigned_user_id);
4162 if(!empty($this->field_defs['created_by']) && !empty($this->created_by))
4163 $this->created_by_name = get_assigned_user_name($this->created_by);
4164 if(!empty($this->field_defs['modified_user_id']) && !empty($this->modified_user_id))
4165 $this->modified_by_name = get_assigned_user_name($this->modified_user_id);
4167 if(!empty($this->field_defs['parent_name'])){
4168 $this->fill_in_additional_parent_fields();
4173 * This is desgined to be overridden or called from extending bean. This method
4174 * will fill in any parent_name fields.
4176 function fill_in_additional_parent_fields() {
4178 if(!empty($this->parent_id) && !empty($this->last_parent_id) && $this->last_parent_id == $this->parent_id){
4181 $this->parent_name = '';
4183 if(!empty($this->parent_type)) {
4184 $this->last_parent_id = $this->parent_id;
4185 $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'));
4186 if(!empty($this->parent_first_name) || !empty($this->parent_last_name) ){
4187 $this->parent_name = $GLOBALS['locale']->getLocaleFormattedName($this->parent_first_name, $this->parent_last_name);
4188 } else if(!empty($this->parent_document_name)){
4189 $this->parent_name = $this->parent_document_name;
4195 * Fill in a link field
4198 function fill_in_link_field( $linkFieldName , $def)
4200 $idField = $linkFieldName;
4201 //If the id_name provided really was an ID, don't try to load it as a link. Use the normal link
4202 if (!empty($this->field_defs[$linkFieldName]['type']) && $this->field_defs[$linkFieldName]['type'] == "id" && !empty($def['link']))
4204 $linkFieldName = $def['link'];
4206 if ($this->load_relationship($linkFieldName))
4208 $list=$this->$linkFieldName->get();
4209 $this->$idField = '' ; // match up with null value in $this->populateFromRow()
4211 $this->$idField = $list[0];
4216 * Fill in fields where type = relate
4218 function fill_in_relationship_fields(){
4219 global $fill_in_rel_depth;
4220 if(empty($fill_in_rel_depth) || $fill_in_rel_depth < 0)
4221 $fill_in_rel_depth = 0;
4223 if($fill_in_rel_depth > 1)
4226 $fill_in_rel_depth++;
4228 foreach($this->field_defs as $field)
4230 if(0 == strcmp($field['type'],'relate') && !empty($field['module']))
4232 $name = $field['name'];
4233 if(empty($this->$name))
4235 // 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']
4236 $related_module = $field['module'];
4237 $id_name = $field['id_name'];
4239 if (empty($this->$id_name))
4241 $this->fill_in_link_field($id_name, $field);
4243 if(!empty($this->$id_name) && ( $this->object_name != $related_module || ( $this->object_name == $related_module && $this->$id_name != $this->id ))){
4244 if(isset($GLOBALS['beanList'][ $related_module])){
4245 $class = $GLOBALS['beanList'][$related_module];
4247 if(!empty($this->$id_name) && file_exists($GLOBALS['beanFiles'][$class]) && isset($this->$name)){
4248 require_once($GLOBALS['beanFiles'][$class]);
4249 $mod = new $class();
4251 // disable row level security in order to be able
4252 // to retrieve related bean properties (bug #44928)
4254 $mod->retrieve($this->$id_name);
4256 if (!empty($field['rname'])) {
4257 $this->$name = $mod->$field['rname'];
4258 } else if (isset($mod->name)) {
4259 $this->$name = $mod->name;
4264 if(!empty($this->$id_name) && isset($this->$name))
4266 if(!isset($field['additionalFields']))
4267 $field['additionalFields'] = array();
4268 if(!empty($field['rname']))
4270 $field['additionalFields'][$field['rname']]= $name;
4274 $field['additionalFields']['name']= $name;
4276 $this->getRelatedFields($related_module, $this->$id_name, $field['additionalFields']);
4281 $fill_in_rel_depth--;
4285 * This is a helper function that is used to quickly created indexes when creating tables.
4287 function create_index($query)
4289 $GLOBALS['log']->info("create_index: $query");
4291 $result = $this->db->query($query, true, "Error creating index:");
4295 * This function should be overridden in each module. It marks an item as deleted.
4297 * If it is not overridden, then marking this type of item is not allowed
4299 function mark_deleted($id)
4301 global $current_user;
4302 $date_modified = $GLOBALS['timedate']->nowDb();
4303 if(isset($_SESSION['show_deleted']))
4305 $this->mark_undeleted($id);
4309 // call the custom business logic
4310 $custom_logic_arguments['id'] = $id;
4311 $this->call_custom_logic("before_delete", $custom_logic_arguments);
4313 $this->mark_relationships_deleted($id);
4314 if ( isset($this->field_defs['modified_user_id']) ) {
4315 if (!empty($current_user)) {
4316 $this->modified_user_id = $current_user->id;
4318 $this->modified_user_id = 1;
4320 $query = "UPDATE $this->table_name set deleted=1 , date_modified = '$date_modified', modified_user_id = '$this->modified_user_id' where id='$id'";
4322 $query = "UPDATE $this->table_name set deleted=1 , date_modified = '$date_modified' where id='$id'";
4324 $this->db->query($query, true,"Error marking record deleted: ");
4326 SugarRelationship::resaveRelatedBeans();
4328 // Take the item off the recently viewed lists
4329 $tracker = new Tracker();
4330 $tracker->makeInvisibleForAll($id);
4332 // call the custom business logic
4333 $this->call_custom_logic("after_delete", $custom_logic_arguments);
4338 * Restores data deleted by call to mark_deleted() function.
4340 * Internal function, do not override.
4342 function mark_undeleted($id)
4344 // call the custom business logic
4345 $custom_logic_arguments['id'] = $id;
4346 $this->call_custom_logic("before_restore", $custom_logic_arguments);
4348 $date_modified = $GLOBALS['timedate']->nowDb();
4349 $query = "UPDATE $this->table_name set deleted=0 , date_modified = '$date_modified' where id='$id'";
4350 $this->db->query($query, true,"Error marking record undeleted: ");
4352 // call the custom business logic
4353 $this->call_custom_logic("after_restore", $custom_logic_arguments);
4357 * This function deletes relationships to this object. It should be overridden
4358 * to handle the relationships of the specific object.
4359 * This function is called when the item itself is being deleted.
4361 * @param int $id id of the relationship to delete
4363 function mark_relationships_deleted($id)
4365 $this->delete_linked($id);
4369 * This function is used to execute the query and create an array template objects
4370 * from the resulting ids from the query.
4371 * It is currently used for building sub-panel arrays.
4373 * @param string $query - the query that should be executed to build the list
4374 * @param object $template - The object that should be used to copy the records.
4375 * @param int $row_offset Optional, default 0
4376 * @param int $limit Optional, default -1
4379 function build_related_list($query, &$template, $row_offset = 0, $limit = -1)
4381 $GLOBALS['log']->debug("Finding linked records $this->object_name: ".$query);
4382 $db = DBManagerFactory::getInstance('listviews');
4384 if(!empty($row_offset) && $row_offset != 0 && !empty($limit) && $limit != -1)
4386 $result = $db->limitQuery($query, $row_offset, $limit,true,"Error retrieving $template->object_name list: ");
4390 $result = $db->query($query, true);
4394 $isFirstTime = true;
4395 $class = get_class($template);
4396 while($row = $this->db->fetchByAssoc($result))
4400 $template = new $class();
4402 $isFirstTime = false;
4403 $record = $template->retrieve($row['id']);
4407 // this copies the object into the array
4408 $list[] = $template;
4415 * This function is used to execute the query and create an array template objects
4416 * from the resulting ids from the query.
4417 * It is currently used for building sub-panel arrays. It supports an additional
4418 * where clause that is executed as a filter on the results
4420 * @param string $query - the query that should be executed to build the list
4421 * @param object $template - The object that should be used to copy the records.
4423 function build_related_list_where($query, &$template, $where='', $in='', $order_by, $limit='', $row_offset = 0)
4425 $db = DBManagerFactory::getInstance('listviews');
4426 // No need to do an additional query
4427 $GLOBALS['log']->debug("Finding linked records $this->object_name: ".$query);
4428 if(empty($in) && !empty($query))
4430 $idList = $this->build_related_in($query);
4431 $in = $idList['in'];
4433 // MFH - Added Support For Custom Fields in Searches
4435 if(isset($this->custom_fields)) {
4436 $custom_join = $this->custom_fields->getJOIN();
4439 $query = "SELECT id ";
4441 if (!empty($custom_join)) {
4442 $query .= $custom_join['select'];
4444 $query .= " FROM $this->table_name ";
4446 if (!empty($custom_join) && !empty($custom_join['join'])) {
4447 $query .= " " . $custom_join['join'];
4450 $query .= " WHERE deleted=0 AND id IN $in";
4453 $query .= " AND $where";
4457 if(!empty($order_by))
4459 $query .= "ORDER BY $order_by";
4463 $result = $db->limitQuery($query, $row_offset, $limit,true,"Error retrieving $this->object_name list: ");
4467 $result = $db->query($query, true);
4471 $isFirstTime = true;
4472 $class = get_class($template);
4474 $disable_security_flag = ($template->disable_row_level_security) ? true : false;
4475 while($row = $db->fetchByAssoc($result))
4479 $template = new $class();
4480 $template->disable_row_level_security = $disable_security_flag;
4482 $isFirstTime = false;
4483 $record = $template->retrieve($row['id']);
4486 // this copies the object into the array
4487 $list[] = $template;
4495 * Constructs an comma separated list of ids from passed query results.
4497 * @param string @query query to be executed.
4500 function build_related_in($query)
4503 $result = $this->db->query($query, true);
4505 while($row = $this->db->fetchByAssoc($result))
4507 $idList[] = $row['id'];
4510 $ids = "('" . $row['id'] . "'";
4514 $ids .= ",'" . $row['id'] . "'";
4524 return array('list'=>$idList, 'in'=>$ids);
4528 * Optionally copies values from fetched row into the bean.
4530 * Internal function, do not override.
4532 * @param string $query - the query that should be executed to build the list
4533 * @param object $template - The object that should be used to copy the records
4534 * @param array $field_list List of fields.
4537 function build_related_list2($query, &$template, &$field_list)
4539 $GLOBALS['log']->debug("Finding linked values $this->object_name: ".$query);
4541 $result = $this->db->query($query, true);
4544 $isFirstTime = true;
4545 $class = get_class($template);
4546 while($row = $this->db->fetchByAssoc($result))
4548 // Create a blank copy
4552 $copy = new $class();
4554 $isFirstTime = false;
4555 foreach($field_list as $field)
4557 // Copy the relevant fields
4558 $copy->$field = $row[$field];
4562 // this copies the object into the array
4570 * Let implementing classes to fill in row specific columns of a list view form
4573 function list_view_parse_additional_sections(&$list_form)
4577 * Assigns all of the values into the template for the list view
4579 function get_list_view_array()
4581 static $cache = array();
4582 // cn: bug 12270 - sensitive fields being passed arbitrarily in listViews
4583 $sensitiveFields = array('user_hash' => '');
4585 $return_array = Array();
4586 global $app_list_strings, $mod_strings;
4587 foreach($this->field_defs as $field=>$value){
4589 if(isset($this->$field)){
4591 // cn: bug 12270 - sensitive fields being passed arbitrarily in listViews
4592 if(isset($sensitiveFields[$field]))
4594 if(!isset($cache[$field]))
4595 $cache[$field] = strtoupper($field);
4597 //Fields hidden by Dependent Fields
4598 if (isset($value['hidden']) && $value['hidden'] === true) {
4599 $return_array[$cache[$field]] = "";
4602 //cn: if $field is a _dom, detect and return VALUE not KEY
4603 //cl: empty function check for meta-data enum types that have values loaded from a function
4604 else if (((!empty($value['type']) && ($value['type'] == 'enum' || $value['type'] == 'radioenum') )) && empty($value['function'])){
4605 if(!empty($value['options']) && !empty($app_list_strings[$value['options']][$this->$field])){
4606 $return_array[$cache[$field]] = $app_list_strings[$value['options']][$this->$field];
4608 //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.
4609 elseif(!empty($value['options']) && !empty($mod_strings[$value['options']][$this->$field]))
4611 $return_array[$cache[$field]] = $mod_strings[$value['options']][$this->$field];
4614 $return_array[$cache[$field]] = $this->$field;
4617 // tjy: no need to do this str_replace as the changes in 29994 for ListViewGeneric.tpl for translation handle this now
4618 // }elseif(!empty($value['type']) && $value['type'] == 'multienum'&& empty($value['function'])){
4619 // $return_array[strtoupper($field)] = str_replace('^,^', ', ', $this->$field );
4620 }elseif(!empty($value['custom_module']) && $value['type'] != 'currency'){
4621 // $this->format_field($value);
4622 $return_array[$cache[$field]] = $this->$field;
4624 $return_array[$cache[$field]] = $this->$field;
4626 // handle "Assigned User Name"
4627 if($field == 'assigned_user_name'){
4628 $return_array['ASSIGNED_USER_NAME'] = get_assigned_user_name($this->assigned_user_id);
4632 return $return_array;
4635 * Override this function to set values in the array used to render list view data.
4638 function get_list_view_data()
4640 return $this->get_list_view_array();
4644 * Construct where clause from a list of name-value pairs.
4645 * @param array $fields_array Name/value pairs for column checks
4646 * @param boolean $deleted Optional, default true, if set to false deleted filter will not be added.
4647 * @return string The WHERE clause
4649 function get_where($fields_array, $deleted=true)
4652 foreach ($fields_array as $name=>$value)
4654 if (!empty($where_clause)) {
4655 $where_clause .= " AND ";
4657 $name = $this->db->getValidDBName($name);
4659 $where_clause .= "$name = ".$this->db->quoted($value,false);
4661 if(!empty($where_clause)) {
4663 return "WHERE $where_clause AND deleted=0";
4665 return "WHERE $where_clause";
4674 * Constructs a select query and fetch 1 row using this query, and then process the row
4676 * Internal function, do not override.
4677 * @param array @fields_array array of name value pairs used to construct query.
4678 * @param boolean $encode Optional, default true, encode fetched data.
4679 * @param boolean $deleted Optional, default true, if set to false deleted filter will not be added.
4680 * @return object Instance of this bean with fetched data.
4682 function retrieve_by_string_fields($fields_array, $encode=true, $deleted=true)
4684 $where_clause = $this->get_where($fields_array, $deleted);
4685 if(isset($this->custom_fields))
4686 $custom_join = $this->custom_fields->getJOIN();
4687 else $custom_join = false;
4690 $query = "SELECT $this->table_name.*". $custom_join['select']. " FROM $this->table_name " . $custom_join['join'];
4694 $query = "SELECT $this->table_name.* FROM $this->table_name ";
4696 $query .= " $where_clause";
4697 $GLOBALS['log']->debug("Retrieve $this->object_name: ".$query);
4698 //requireSingleResult has been deprecated.
4699 //$result = $this->db->requireSingleResult($query, true, "Retrieving record $where_clause:");
4700 $result = $this->db->limitQuery($query,0,1,true, "Retrieving record $where_clause:");
4707 $row = $this->db->fetchByAssoc($result, $encode);
4712 // Removed getRowCount-if-clause earlier and insert duplicates_found here as it seems that we have found something
4713 // if we didn't return null in the previous clause.
4714 $this->duplicates_found = true;
4715 $row = $this->convertRow($row);
4716 $this->fetched_row = $row;
4717 $this->fromArray($row);
4718 $this->is_updated_dependent_fields = false;
4719 $this->fill_in_additional_detail_fields();
4724 * This method is called during an import before inserting a bean
4725 * Define an associative array called $special_fields
4726 * the keys are user defined, and don't directly map to the bean's fields
4727 * the value is the method name within that bean that will do extra
4728 * processing for that field. example: 'full_name'=>'get_names_from_full_name'
4731 function process_special_fields()
4733 foreach ($this->special_functions as $func_name)
4735 if ( method_exists($this,$func_name) )
4737 $this->$func_name();
4743 * Override this function to build a where clause based on the search criteria set into bean .
4746 function build_generic_where_clause($value)
4750 function getRelatedFields($module, $id, $fields, $return_array = false){
4751 if(empty($GLOBALS['beanList'][$module]))return '';
4752 $object = BeanFactory::getObjectName($module);
4754 VardefManager::loadVardef($module, $object);
4755 if(empty($GLOBALS['dictionary'][$object]['table']))return '';
4756 $table = $GLOBALS['dictionary'][$object]['table'];
4757 $query = 'SELECT id';
4758 foreach($fields as $field=>$alias){
4759 if(!empty($GLOBALS['dictionary'][$object]['fields'][$field]['db_concat_fields'])){
4760 $query .= ' ,' .$this->db->concat($table, $GLOBALS['dictionary'][$object]['fields'][$field]['db_concat_fields']) . ' as ' . $alias ;
4761 }else if(!empty($GLOBALS['dictionary'][$object]['fields'][$field]) &&
4762 (empty($GLOBALS['dictionary'][$object]['fields'][$field]['source']) ||
4763 $GLOBALS['dictionary'][$object]['fields'][$field]['source'] != "non-db"))
4765 $query .= ' ,' .$table . '.' . $field . ' as ' . $alias;
4767 if(!$return_array)$this->$alias = '';
4769 if($query == 'SELECT id' || empty($id)){
4774 if(isset($GLOBALS['dictionary'][$object]['fields']['assigned_user_id']))
4776 $query .= " , ". $table . ".assigned_user_id owner";
4779 else if(isset($GLOBALS['dictionary'][$object]['fields']['created_by']))
4781 $query .= " , ". $table . ".created_by owner";
4784 $query .= ' FROM ' . $table . ' WHERE deleted=0 AND id=';
4785 $result = $GLOBALS['db']->query($query . "'$id'" );
4786 $row = $GLOBALS['db']->fetchByAssoc($result);
4790 $owner = (empty($row['owner']))?'':$row['owner'];
4791 foreach($fields as $alias){
4792 $this->$alias = (!empty($row[$alias]))? $row[$alias]: '';
4793 $alias = $alias .'_owner';
4794 $this->$alias = $owner;
4795 $a_mod = $alias .'_mod';
4796 $this->$a_mod = $module;
4803 function &parse_additional_headers(&$list_form, $xTemplateSection)
4808 function assign_display_fields($currentModule)
4811 foreach($this->column_fields as $field)
4813 if(isset($this->field_name_map[$field]) && empty($this->$field))
4815 if($this->field_name_map[$field]['type'] != 'date' && $this->field_name_map[$field]['type'] != 'enum')
4816 $this->$field = $field;
4817 if($this->field_name_map[$field]['type'] == 'date')
4819 $this->$field = $timedate->to_display_date('1980-07-09');
4821 if($this->field_name_map[$field]['type'] == 'enum')
4823 $dom = $this->field_name_map[$field]['options'];
4824 global $current_language, $app_list_strings;
4825 $mod_strings = return_module_language($current_language, $currentModule);
4827 if(isset($mod_strings[$dom]))
4829 $options = $mod_strings[$dom];
4830 foreach($options as $key=>$value)
4832 if(!empty($key) && empty($this->$field ))
4834 $this->$field = $key;
4838 if(isset($app_list_strings[$dom]))
4840 $options = $app_list_strings[$dom];
4841 foreach($options as $key=>$value)
4843 if(!empty($key) && empty($this->$field ))
4845 $this->$field = $key;
4857 * RELATIONSHIP HANDLING
4860 function set_relationship($table, $relate_values, $check_duplicates = true,$do_update=false,$data_values=null)
4864 // make sure there is a date modified
4865 $date_modified = $this->db->convert("'".$GLOBALS['timedate']->nowDb()."'", 'datetime');
4868 if($check_duplicates)
4870 $query = "SELECT * FROM $table ";
4871 $where = "WHERE deleted = '0' ";
4872 foreach($relate_values as $name=>$value)
4874 $where .= " AND $name = '$value' ";
4877 $result = $this->db->query($query, false, "Looking For Duplicate Relationship:" . $query);
4878 $row=$this->db->fetchByAssoc($result);
4881 if(!$check_duplicates || empty($row) )
4883 unset($relate_values['id']);
4884 if ( isset($data_values))
4886 $relate_values = array_merge($relate_values,$data_values);
4888 $query = "INSERT INTO $table (id, ". implode(',', array_keys($relate_values)) . ", date_modified) VALUES ('" . create_guid() . "', " . "'" . implode("', '", $relate_values) . "', ".$date_modified.")" ;
4890 $this->db->query($query, false, "Creating Relationship:" . $query);
4892 else if ($do_update)
4895 foreach($data_values as $key=>$value)
4897 array_push($conds,$key."='".$this->db->quote($value)."'");
4899 $query = "UPDATE $table SET ". implode(',', $conds).",date_modified=".$date_modified." ".$where;
4900 $this->db->query($query, false, "Updating Relationship:" . $query);
4904 function retrieve_relationships($table, $values, $select_id)
4906 $query = "SELECT $select_id FROM $table WHERE deleted = 0 ";
4907 foreach($values as $name=>$value)
4909 $query .= " AND $name = '$value' ";
4911 $query .= " ORDER BY $select_id ";
4912 $result = $this->db->query($query, false, "Retrieving Relationship:" . $query);
4914 while($row = $this->db->fetchByAssoc($result))
4921 // TODO: this function needs adjustment
4922 function loadLayoutDefs()
4924 global $layout_defs;
4925 if(empty( $this->layout_def) && file_exists('modules/'. $this->module_dir . '/layout_defs.php'))
4927 include_once('modules/'. $this->module_dir . '/layout_defs.php');
4928 if(file_exists('custom/modules/'. $this->module_dir . '/Ext/Layoutdefs/layoutdefs.ext.php'))
4930 include_once('custom/modules/'. $this->module_dir . '/Ext/Layoutdefs/layoutdefs.ext.php');
4932 if ( empty( $layout_defs[get_class($this)]))
4934 echo "\$layout_defs[" . get_class($this) . "]; does not exist";
4937 $this->layout_def = $layout_defs[get_class($this)];
4942 * Trigger custom logic for this module that is defined for the provided hook
4943 * The custom logic file is located under custom/modules/[CURRENT_MODULE]/logic_hooks.php.
4944 * That file should define the $hook_version that should be used.
4945 * It should also define the $hook_array. The $hook_array will be a two dimensional array
4946 * the first dimension is the name of the event, the second dimension is the information needed
4947 * to fire the hook. Each entry in the top level array should be defined on a single line to make it
4948 * easier to automatically replace this file. There should be no contents of this file that are not replacable.
4950 * $hook_array['before_save'][] = Array(1, testtype, 'custom/modules/Leads/test12.php', 'TestClass', 'lead_before_save_1');
4951 * This sample line creates a before_save hook. The hooks are procesed in the order in which they
4952 * are added to the array. The second dimension is an array of:
4953 * processing index (for sorting before exporting the array)
4956 * php file to include
4957 * php class the method is in
4958 * php method to call
4960 * The method signature for version 1 hooks is:
4961 * function NAME(&$bean, $event, $arguments)
4962 * $bean - $this bean passed in by reference.
4963 * $event - The string for the current event (i.e. before_save)
4964 * $arguments - An array of arguments that are specific to the event.
4966 function call_custom_logic($event, $arguments = null)
4968 if(!isset($this->processed) || $this->processed == false){
4969 //add some logic to ensure we do not get into an infinite loop
4970 if(!empty($this->logicHookDepth[$event])) {
4971 if($this->logicHookDepth[$event] > $this->max_logic_depth)
4974 $this->logicHookDepth[$event] = 0;
4976 //we have to put the increment operator here
4977 //otherwise we may never increase the depth for that event in the case
4978 //where one event will trigger another as in the case of before_save and after_save
4979 //Also keeping the depth per event allow any number of hooks to be called on the bean
4980 //and we only will return if one event gets caught in a loop. We do not increment globally
4981 //for each event called.
4982 $this->logicHookDepth[$event]++;
4984 //method defined in 'include/utils/LogicHook.php'
4986 $logicHook = new LogicHook();
4987 $logicHook->setBean($this);
4988 $logicHook->call_custom_logic($this->module_dir, $event, $arguments);
4989 $this->logicHookDepth[$event]--;
4994 /* When creating a custom field of type Dropdown, it creates an enum row in the DB.
4995 A typical get_list_view_array() result will have the *KEY* value from that drop-down.
4996 Since custom _dom objects are flat-files included in the $app_list_strings variable,
4997 We need to generate a key-key pair to get the true value like so:
4998 ([module]_cstm->fields_meta_data->$app_list_strings->*VALUE*)*/
4999 function getRealKeyFromCustomFieldAssignedKey($name)
5001 if ($this->custom_fields->avail_fields[$name]['ext1'])
5005 elseif ($this->custom_fields->avail_fields[$name]['ext2'])
5009 elseif ($this->custom_fields->avail_fields[$name]['ext3'])
5015 $GLOBALS['log']->fatal("SUGARBEAN: cannot find Real Key for custom field of type dropdown - cannot return Value.");
5020 return $this->custom_fields->avail_fields[$name][$realKey];
5024 function bean_implements($interface)
5029 * Check whether the user has access to a particular view for the current bean/module
5030 * @param $view string required, the view to determine access for i.e. DetailView, ListView...
5031 * @param $is_owner bool optional, this is part of the ACL check if the current user is an owner they will receive different access
5033 function ACLAccess($view,$is_owner='not_set')
5035 global $current_user;
5036 if($current_user->isAdminForModule($this->getACLCategory())) {
5040 if($is_owner == 'not_set')
5043 $is_owner = $this->isOwner($current_user->id);
5046 // If we don't implement ACLs, return true.
5047 if(!$this->bean_implements('ACL'))
5049 $view = strtolower($view);
5055 return ACLController::checkAccess($this->module_dir,'list', true);
5058 if( !$is_owner && $not_set && !empty($this->id)){
5059 $class = get_class($this);
5060 $temp = new $class();
5061 if(!empty($this->fetched_row) && !empty($this->fetched_row['id']) && !empty($this->fetched_row['assigned_user_id']) && !empty($this->fetched_row['created_by'])){
5062 $temp->populateFromRow($this->fetched_row);
5064 $temp->retrieve($this->id);
5066 $is_owner = $temp->isOwner($current_user->id);
5068 case 'popupeditview':
5070 return ACLController::checkAccess($this->module_dir,'edit', $is_owner, $this->acltype);
5074 return ACLController::checkAccess($this->module_dir,'view', $is_owner, $this->acltype);
5076 return ACLController::checkAccess($this->module_dir,'delete', $is_owner, $this->acltype);
5078 return ACLController::checkAccess($this->module_dir,'export', $is_owner, $this->acltype);
5080 return ACLController::checkAccess($this->module_dir,'import', true, $this->acltype);
5082 //if it is not one of the above views then it should be implemented on the page level
5091 function getOwnerField($returnFieldName = false)
5093 if (isset($this->field_defs['assigned_user_id']))
5095 return $returnFieldName? 'assigned_user_id': $this->assigned_user_id;
5098 if (isset($this->field_defs['created_by']))
5100 return $returnFieldName? 'created_by': $this->created_by;
5107 * Returns true of false if the user_id passed is the owner
5109 * @param GUID $user_id
5112 function isOwner($user_id)
5114 //if we don't have an id we must be the owner as we are creating it
5115 if(!isset($this->id))
5119 //if there is an assigned_user that is the owner
5120 if(isset($this->assigned_user_id))
5122 if($this->assigned_user_id == $user_id) return true;
5127 //other wise if there is a created_by that is the owner
5128 if(isset($this->created_by) && $this->created_by == $user_id)
5136 * Gets there where statement for checking if a user is an owner
5138 * @param GUID $user_id
5141 function getOwnerWhere($user_id)
5143 if(isset($this->field_defs['assigned_user_id']))
5145 return " $this->table_name.assigned_user_id ='$user_id' ";
5147 if(isset($this->field_defs['created_by']))
5149 return " $this->table_name.created_by ='$user_id' ";
5156 * Used in order to manage ListView links and if they should
5157 * links or not based on the ACL permissions of the user
5159 * @return ARRAY of STRINGS
5161 function listviewACLHelper()
5163 $array_assign = array();
5164 if($this->ACLAccess('DetailView'))
5166 $array_assign['MAIN'] = 'a';
5170 $array_assign['MAIN'] = 'span';
5172 return $array_assign;
5176 * returns this bean as an array
5178 * @return array of fields with id, name, access and category
5180 function toArray($dbOnly = false, $stringOnly = false, $upperKeys=false)
5182 static $cache = array();
5185 foreach($this->field_defs as $field=>$data)
5187 if( !$dbOnly || !isset($data['source']) || $data['source'] == 'db')
5188 if(!$stringOnly || is_string($this->$field))
5191 if(!isset($cache[$field])){
5192 $cache[$field] = strtoupper($field);
5194 $arr[$cache[$field]] = $this->$field;
5198 if(isset($this->$field)){
5199 $arr[$field] = $this->$field;
5209 * Converts an array into an acl mapping name value pairs into files
5213 function fromArray($arr)
5215 foreach($arr as $name=>$value)
5217 $this->$name = $value;
5222 * Convert row data from DB format to internal format
5223 * Mostly useful for dates/times
5225 * @return array $row
5227 public function convertRow($row)
5229 foreach($this->field_defs as $name => $fieldDef)
5231 // skip empty fields and non-db fields
5232 if (isset($name) && !empty($row[$name])) {
5233 $row[$name] = $this->convertField($row[$name], $fieldDef);
5240 * Converts the field value based on the provided fieldDef
5241 * @param $fieldvalue
5245 public function convertField($fieldvalue, $fieldDef)
5247 if (!empty($fieldvalue)) {
5248 if (!(isset($fieldDef['source']) &&
5249 !in_array($fieldDef['source'], array('db', 'custom_fields', 'relate'))
5250 && !isset($fieldDef['dbType']))
5252 // fromConvert other fields
5253 $fieldvalue = $this->db->fromConvert($fieldvalue, $this->db->getFieldType($fieldDef));
5260 * Loads a row of data into instance of a bean. The data is passed as an array to this function
5262 * @param array $arr row of data fetched from the database.
5265 * Internal function do not override.
5267 function loadFromRow($arr)
5269 $this->populateFromRow($arr);
5270 $this->processed_dates_times = array();
5271 $this->check_date_relationships_load();
5273 $this->fill_in_additional_list_fields();
5275 if($this->hasCustomFields())$this->custom_fields->fill_relationships();
5276 $this->call_custom_logic("process_record");
5279 function hasCustomFields()
5281 return !empty($GLOBALS['dictionary'][$this->object_name]['custom_fields']);
5285 * Ensure that fields within order by clauses are properly qualified with
5286 * their tablename. This qualification is a requirement for sql server support.
5288 * @param string $order_by original order by from the query
5289 * @param string $qualify prefix for columns in the order by list.
5292 * Internal function do not override.
5294 function create_qualified_order_by( $order_by, $qualify)
5295 { // 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
5296 if (empty($order_by))
5300 $order_by_clause = " ORDER BY ";
5301 $tmp = explode(",", $order_by);
5303 foreach ( $tmp as $stmp)
5305 $stmp = (substr_count($stmp, ".") > 0?trim($stmp):"$qualify." . trim($stmp));
5306 $order_by_clause .= $comma . $stmp;
5309 return $order_by_clause;
5313 * Combined the contents of street field 2 thru 4 into the main field
5315 * @param string $street_field
5318 function add_address_streets(
5322 $street_field_2 = $street_field.'_2';
5323 $street_field_3 = $street_field.'_3';
5324 $street_field_4 = $street_field.'_4';
5325 if ( isset($this->$street_field_2)) {
5326 $this->$street_field .= "\n". $this->$street_field_2;
5327 unset($this->$street_field_2);
5329 if ( isset($this->$street_field_3)) {
5330 $this->$street_field .= "\n". $this->$street_field_3;
5331 unset($this->$street_field_3);
5333 if ( isset($this->$street_field_4)) {
5334 $this->$street_field .= "\n". $this->$street_field_4;
5335 unset($this->$street_field_4);
5337 if ( isset($this->$street_field)) {
5338 $this->$street_field = trim($this->$street_field, "\n");
5342 * Encrpyt and base64 encode an 'encrypt' field type in the bean using Blowfish. The default system key is stored in cache/Blowfish/{keytype}
5343 * @param STRING value -plain text value of the bean field.
5346 function encrpyt_before_save($value)
5348 require_once("include/utils/encryption_utils.php");
5349 return blowfishEncode(blowfishGetKey('encrypt_field'),$value);
5353 * Decode and decrypt a base 64 encoded string with field type 'encrypt' in this bean using Blowfish.
5354 * @param STRING value - an encrypted and base 64 encoded string.
5357 function decrypt_after_retrieve($value)
5359 require_once("include/utils/encryption_utils.php");
5360 return blowfishDecode(blowfishGetKey('encrypt_field'), $value);
5364 * Moved from save() method, functionality is the same, but this is intended to handle
5365 * Optimistic locking functionality.
5367 private function _checkOptimisticLocking($action, $isUpdate){
5368 if($this->optimistic_lock && !isset($_SESSION['o_lock_fs'])){
5369 if(isset($_SESSION['o_lock_id']) && $_SESSION['o_lock_id'] == $this->id && $_SESSION['o_lock_on'] == $this->object_name)
5371 if($action == 'Save' && $isUpdate && isset($this->modified_user_id) && $this->has_been_modified_since($_SESSION['o_lock_dm'], $this->modified_user_id))
5373 $_SESSION['o_lock_class'] = get_class($this);
5374 $_SESSION['o_lock_module'] = $this->module_dir;
5375 $_SESSION['o_lock_object'] = $this->toArray();
5376 $saveform = "<form name='save' id='save' method='POST'>";
5377 foreach($_POST as $key=>$arg)
5379 $saveform .= "<input type='hidden' name='". addslashes($key) ."' value='". addslashes($arg) ."'>";
5381 $saveform .= "</form><script>document.getElementById('save').submit();</script>";
5382 $_SESSION['o_lock_save'] = $saveform;
5383 header('Location: index.php?module=OptimisticLock&action=LockResolve');
5388 unset ($_SESSION['o_lock_object']);
5389 unset ($_SESSION['o_lock_id']);
5390 unset ($_SESSION['o_lock_dm']);
5396 if(isset($_SESSION['o_lock_object'])) { unset ($_SESSION['o_lock_object']); }
5397 if(isset($_SESSION['o_lock_id'])) { unset ($_SESSION['o_lock_id']); }
5398 if(isset($_SESSION['o_lock_dm'])) { unset ($_SESSION['o_lock_dm']); }
5399 if(isset($_SESSION['o_lock_fs'])) { unset ($_SESSION['o_lock_fs']); }
5400 if(isset($_SESSION['o_lock_save'])) { unset ($_SESSION['o_lock_save']); }
5405 * Send assignment notifications and invites for meetings and calls
5407 private function _sendNotifications($check_notify){
5408 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.
5409 && !$this->isOwner($this->created_by) ) // cn: bug 42727 no need to send email to owner (within workflow)
5411 $admin = new Administration();
5412 $admin->retrieveSettings();
5413 $sendNotifications = false;
5415 if ($admin->settings['notify_on'])
5417 $GLOBALS['log']->info("Notifications: user assignment has changed, checking if user receives notifications");
5418 $sendNotifications = true;
5420 elseif(isset($_REQUEST['send_invites']) && $_REQUEST['send_invites'] == 1)
5422 // cn: bug 5795 Send Invites failing for Contacts
5423 $sendNotifications = true;
5427 $GLOBALS['log']->info("Notifications: not sending e-mail, notify_on is set to OFF");
5431 if($sendNotifications == true)
5433 $notify_list = $this->get_notification_recipients();
5434 foreach ($notify_list as $notify_user)
5436 $this->send_assignment_notifications($notify_user, $admin);
5444 * Called from ImportFieldSanitize::relate(), when creating a new bean in a related module. Will
5445 * copies fields over from the current bean into the related. Designed to be overriden in child classes.
5447 * @param SugarBean $newbean newly created related bean
5449 public function populateRelatedBean(
5456 * Called during the import process before a bean save, to handle any needed pre-save logic when
5457 * importing a record
5459 public function beforeImportSave()
5464 * Called during the import process after a bean save, to handle any needed post-save logic when
5465 * importing a record
5467 public function afterImportSave()
5472 * This function is designed to cache references to field arrays that were previously stored in the
5473 * bean files and have since been moved to separate files. Was previously in include/CacheHandler.php
5476 * @param $module_dir string the module directory
5477 * @param $module string the name of the module
5478 * @param $key string the type of field array we are referencing, i.e. list_fields, column_fields, required_fields
5480 private function _loadCachedArray(
5486 static $moduleDefs = array();
5488 $fileName = 'field_arrays.php';
5490 $cache_key = "load_cached_array.$module_dir.$module.$key";
5491 $result = sugar_cache_retrieve($cache_key);
5494 // Use SugarCache::EXTERNAL_CACHE_NULL_VALUE to store null values in the cache.
5495 if($result == SugarCache::EXTERNAL_CACHE_NULL_VALUE)
5503 if(file_exists('modules/'.$module_dir.'/'.$fileName))
5505 // If the data was not loaded, try loading again....
5506 if(!isset($moduleDefs[$module]))
5508 include('modules/'.$module_dir.'/'.$fileName);
5509 $moduleDefs[$module] = $fields_array;
5511 // Now that we have tried loading, make sure it was loaded
5512 if(empty($moduleDefs[$module]) || empty($moduleDefs[$module][$module][$key]))
5514 // It was not loaded.... Fail. Cache null to prevent future repeats of this calculation
5515 sugar_cache_put($cache_key, SugarCache::EXTERNAL_CACHE_NULL_VALUE);
5519 // It has been loaded, cache the result.
5520 sugar_cache_put($cache_key, $moduleDefs[$module][$module][$key]);
5521 return $moduleDefs[$module][$module][$key];
5524 // It was not loaded.... Fail. Cache null to prevent future repeats of this calculation
5525 sugar_cache_put($cache_key, SugarCache::EXTERNAL_CACHE_NULL_VALUE);
5530 * Returns the ACL category for this module; defaults to the SugarBean::$acl_category if defined
5531 * otherwise it is SugarBean::$module_dir
5535 public function getACLCategory()
5537 return !empty($this->acl_category)?$this->acl_category:$this->module_dir;
5541 * Returns the query used for the export functionality for a module. Override this method if you wish
5542 * to have a custom query to pull this data together instead
5544 * @param string $order_by
5545 * @param string $where
5546 * @return string SQL query
5548 public function create_export_query($order_by, $where)
5550 return $this->create_new_list_query($order_by, $where, array(), array(), 0, '', false, $this, true, true);