modules/DynamicFields/DynamicField.php

   1 <?php
   2 if (! defined ( 'sugarEntry' ) || ! sugarEntry)
   3     die ( 'Not A Valid Entry Point' ) ;
   4
   5 /*********************************************************************************
   6  * SugarCRM is a customer relationship management program developed by
   7  * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
   8  *
   9  * This program is free software; you can redistribute it and/or modify it under
  10  * the terms of the GNU Affero General Public License version 3 as published by the
  11  * Free Software Foundation with the addition of the following permission added
  12  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  13  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  14  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  15  *
  16  * This program is distributed in the hope that it will be useful, but WITHOUT
  17  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  18  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  19  * details.
  20  *
  21  * You should have received a copy of the GNU Affero General Public License along with
  22  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  23  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  24  * 02110-1301 USA.
  25  *
  26  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  27  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  28  *
  29  * The interactive user interfaces in modified source and object code versions
  30  * of this program must display Appropriate Legal Notices, as required under
  31  * Section 5 of the GNU Affero General Public License version 3.
  32  *
  33  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  34  * these Appropriate Legal Notices must retain the display of the "Powered by
  35  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  36  * technical reasons, the Appropriate Legal Notices must display the words
  37  * "Powered by SugarCRM".
  38  ********************************************************************************/
  39
  40
  41 class DynamicField {
  42
  43     var $use_existing_labels = false; // this value is set to true by install_custom_fields() in ModuleInstaller.php; everything else expects it to be false
  44         var $base_path = "";
  45
  46         function DynamicField($module = '') {
  47                 $this->module = (! empty ( $module )) ? $module :( (isset($_REQUEST['module']) && ! empty($_REQUEST['module'])) ? $_REQUEST ['module'] : '');
  48                 $this->base_path = "custom/Extension/modules/{$this->module}/Ext/Vardefs";
  49         }
  50
  51    function getModuleName()
  52     {
  53         return $this->module ;
  54     }
  55
  56     /*
  57      * As DynamicField has a counterpart in MBModule, provide the MBModule function getPackagename() here also
  58      */
  59     function getPackageName()
  60     {
  61         return null ;
  62     }
  63
  64     function deleteCache(){
  65     }
  66
  67
  68         /**
  69          * This will add the bean as a reference in this object as well as building the custom field cache if it has not been built
  70          * LOADS THE BEAN IF THE BEAN IS NOT BEING PASSED ALONG IN SETUP IT SHOULD BE SET PRIOR TO SETUP
  71          *
  72          * @param SUGARBEAN $bean
  73          */
  74         function setup($bean = null) {
  75                 if ($bean) {
  76                         $this->bean = & $bean;
  77                 }
  78                 if (isset ( $this->bean->module_dir )) {
  79                         $this->module = $this->bean->module_dir;
  80                 }
  81                 if(!isset($GLOBALS['dictionary'][$this->bean->object_name]['custom_fields'])){
  82                         $this->buildCache ( $this->module );
  83                 }
  84         }
  85
  86     function setLabel( $language='en_us' , $key , $value )
  87     {
  88         $params [ "label_" . $key ] = $value;
  89         require_once 'modules/ModuleBuilder/parsers/parser.label.php' ;
  90         $parser = new ParserLabel ( $this->module ) ;
  91         $parser->handleSave( $params , $language);
  92     }
  93
  94         /**
  95          * Builds the cache for custom fields based on the vardefs
  96          *
  97          * @param STRING $module
  98          * @return unknown
  99          */
 100         function buildCache($module = false) {
 101                 //We can't build the cache while installing as the required database tables may not exist.
 102                 if (!empty($GLOBALS['installing']) && $GLOBALS['installing'] == true|| !$GLOBALS['db'])
 103                         return false;
 104                 if($module == '../data')return false;
 105
 106                 static $results = array ( ) ;
 107
 108                 $where = '';
 109                 if (! empty ( $module )) {
 110                         $where .= " custom_module='$module' AND ";
 111                         unset( $results[ $module ] ) ; // clear out any old results for the module as $results is declared static
 112                 }
 113                 else
 114                 {
 115                     $results = array ( ) ; // clear out results - if we remove a module we don't want to have its old vardefs hanging around
 116                 }
 117
 118                 $GLOBALS['log']->debug('rebuilding cache for ' . $module);
 119                 $query = "SELECT * FROM fields_meta_data WHERE $where deleted = 0";
 120
 121                 $result = $GLOBALS['db']->query ( $query );
 122                 require_once ('modules/DynamicFields/FieldCases.php');
 123
 124                 // retrieve the field definition from the fields_meta_data table
 125                 // using 'encode'=false to fetchByAssoc to prevent any pre-formatting of the base metadata
 126                 // for immediate use in HTML. This metadata will be further massaged by get_field_def() and so should not be pre-formatted
 127                 while ( $row = $GLOBALS['db']->fetchByAssoc ( $result , -1 ,false ) ) {
 128                         $field = get_widget ( $row ['type'] );
 129
 130                         foreach ( $row as $key => $value ) {
 131                                 $field->$key = $value;
 132                         }
 133                         $field->default = $field->default_value;
 134                         $vardef = $field->get_field_def ();
 135                         $vardef ['id'] = $row ['id'];
 136                         $vardef ['custom_module'] = $row ['custom_module'];
 137                         if (empty ( $vardef ['source'] ))
 138                                 $vardef ['source'] = 'custom_fields';
 139                         if (empty ( $results [$row ['custom_module']] ))
 140                                 $results [$row ['custom_module']] = array ( );
 141                         $results [$row ['custom_module']] [$row ['name']] = $vardef;
 142                 }
 143                 if (empty ( $module )) {
 144                         foreach ( $results as $module => $result ) {
 145                                 $this->saveToVardef ( $module, $result );
 146                         }
 147                 } else {
 148                         if (! empty ( $results [$module] )) {
 149                                 $this->saveToVardef ( $module, $results [$module] );
 150                         }else{
 151                                 $this->saveToVardef ( $module, false );
 152                         }
 153                 }
 154                 return true;
 155
 156         }
 157
 158         /**
 159          * Returns the widget for a custom field from the fields_meta_data table.
 160          */
 161          function getFieldWidget($module, $fieldName) {
 162                 if (empty($module) || empty($fieldName)){
 163                         sugar_die("Unable to load widget for '$module' : '$fieldName'");
 164                 }
 165                 $query = "SELECT * FROM fields_meta_data WHERE custom_module='$module' AND name='$fieldName' AND deleted = 0";
 166                 $result = $GLOBALS['db']->query ( $query );
 167                 require_once ('modules/DynamicFields/FieldCases.php');
 168                 if ( $row = $GLOBALS['db']->fetchByAssoc ( $result ) ) {
 169                         $field = get_widget ( $row ['type'] );
 170                         $field->populateFromRow($row);
 171                         return $field;
 172                 }
 173          }
 174
 175
 176         /**
 177          * Updates the cached vardefs with the custom field information stored in result
 178          *
 179          * @param string $module
 180          * @param array $result
 181          */
 182         function saveToVardef($module,$result) {
 183
 184                 global $beanList;
 185                 if (! empty ( $beanList [$module] )) {
 186                         $object = $beanList [$module];
 187
 188                         if ($object == 'aCase') {
 189                                 $object = 'Case';
 190                         }
 191
 192                         if(empty($GLOBALS['dictionary'][$object]['fields'])){
 193                                 //if the vardef isn't loaded let's try loading it.
 194                                 VardefManager::refreshVardefs($module,$object, null, false);
 195                                 //if it's still not loaded we really don't have anything useful to cache
 196                                 if(empty($GLOBALS['dictionary'][$object]['fields']))return;
 197                         }
 198                         $GLOBALS ['dictionary'] [$object] ['custom_fields'] = false;
 199                         if (! empty ( $GLOBALS ['dictionary'] [$object] )) {
 200                                 if (! empty ( $result )) {
 201                                         // First loop to add
 202
 203                                 foreach ( $result as $field ) {
 204                                         foreach($field as $k=>$v){
 205                                                 //allows values for custom fields to be defined outside of the scope of studio
 206                                                 if(!isset($GLOBALS ['dictionary'] [$object] ['fields'] [$field ['name']][$k])){
 207                                                         $GLOBALS ['dictionary'] [$object] ['fields'] [$field ['name']][$k] = $v;
 208                                                 }
 209                                         }
 210                                 }
 211
 212                                         // Second loop to remove
 213                                         foreach ( $GLOBALS ['dictionary'] [$object] ['fields'] as $name => $fieldDef ) {
 214
 215                                                 if (isset ( $fieldDef ['custom_module'] )) {
 216                                                         if (! isset ( $result [$name] )) {
 217                                                                 unset ( $GLOBALS ['dictionary'] [$object] ['fields'] [$name] );
 218                                                         } else {
 219                                                                 $GLOBALS ['dictionary'] [$object] ['custom_fields'] = true;
 220                                                         }
 221                                                 }
 222
 223                                         } //if
 224                                 }
 225                         }
 226                         $manager = new VardefManager ( );
 227                         $manager->saveCache ( $this->module, $object );
 228                 }
 229         }
 230
 231         /**
 232          * returns either false or an array containing the select and join parameter for a query using custom fields
 233          * @param $expandedList boolean If true, return a list of all fields with source=custom_fields in the select instead of the standard _cstm.*
 234          *     This is required for any downstream construction of a SQL statement where we need to manipulate the select list,
 235          *     for example, listviews with custom relate fields where the value comes from join rather than from the custom table
 236          *
 237          * @return array select=>select columns, join=>prebuilt join statement
 238          */
 239   function getJOIN( $expandedList = false , $includeRelates = false, &$where = false){
 240                 if(!$this->bean->hasCustomFields()){
 241             return false;
 242         }
 243
 244         if (empty($expandedList) )
 245         {
 246                 $select = ",{$this->bean->table_name}_cstm.*" ;
 247         }
 248         else
 249         {
 250                 $select = '';
 251                 $isList = is_array($expandedList);
 252                         foreach($this->bean->field_defs as $name=>$field)
 253                         {
 254                                 if (!empty($field['source']) && $field['source'] == 'custom_fields' && (!$isList || !empty($expandedList[$name]))){
 255                                         // assumption: that the column name in _cstm is the same as the field name. Currently true.
 256                                         // however, two types of dynamic fields do not have columns in the custom table - html fields (they're readonly) and flex relates (parent_name doesn't exist)
 257                                         if ( $field['type'] != 'html' && $name != 'parent_name')
 258                                                 $select .= ",{$this->bean->table_name}_cstm.{$name}" ;
 259                                 }
 260                         }
 261         }
 262         $join = " LEFT JOIN " .$this->bean->table_name. "_cstm ON " .$this->bean->table_name. ".id = ". $this->bean->table_name. "_cstm.id_c ";
 263
 264         if ($includeRelates) {
 265                 $jtAlias = "relJoin";
 266                 $jtCount = 1;
 267                 foreach($this->bean->field_defs as $name=>$field)
 268                         {
 269                                 if ($field['type'] == 'relate' && isset($field['custom_module'])) {
 270                                         $relateJoinInfo = $this->getRelateJoin($field, $jtAlias.$jtCount);
 271                                         $select .= $relateJoinInfo['select'];
 272                                         $join .= $relateJoinInfo['from'];
 273                                         //bug 27654 martin
 274                                         if ($where)
 275                                         {
 276                                                 $pattern = '/'.$field['name'].'\slike/i';
 277                                                 $replacement = $relateJoinInfo['name_field'].' like';
 278                                                 $where = preg_replace($pattern,$replacement,$where);
 279                                         }
 280                                         $jtCount++;
 281                                 }
 282                         }
 283         }
 284
 285         return array('select'=>$select, 'join'=>$join);
 286
 287     }
 288
 289    function getRelateJoin($field_def, $joinTableAlias) {
 290                 if (empty($field_def['type']) || $field_def['type'] != "relate") {
 291                         return false;
 292                 }
 293                 global $beanFiles, $beanList, $module;
 294                 $rel_module = $field_def['module'];
 295         if(empty($beanFiles[$beanList[$rel_module]])) {
 296                 return false;
 297         }
 298
 299         require_once($beanFiles[$beanList[$rel_module]]);
 300             $rel_mod = new $beanList[$rel_module]();
 301             $rel_table = $rel_mod->table_name;
 302             if (isset($rel_mod->field_defs['name']))
 303             {
 304                         $name_field_def = $rel_mod->field_defs['name'];
 305                 if(isset($name_field_def['db_concat_fields']))
 306                 {
 307                         $name_field = db_concat($joinTableAlias, $name_field_def['db_concat_fields']);
 308                 }
 309                 //If the name field is non-db, we need to find another field to display
 310                 else if(!empty($rel_mod->field_defs['name']['source']) && $rel_mod->field_defs['name']['source'] == "non-db" && !empty($field_def['rname']))
 311                 {
 312                         $name_field = "$joinTableAlias." . $field_def['rname'];
 313                 }
 314                 else
 315                 {
 316                         $name_field = "$joinTableAlias.name";
 317                 }
 318         }
 319         $tableName = isset($field_def['custom_module']) ? "{$this->bean->table_name}_cstm" : $this->bean->table_name ;
 320         $relID = $field_def['id_name'];
 321         $ret_array['rel_table'] = $rel_table;
 322         $ret_array['name_field'] = $name_field;
 323         $ret_array['select'] = ", $name_field {$field_def['name']} ";
 324         $ret_array['from'] = " LEFT JOIN $rel_table $joinTableAlias ON $tableName.$relID = $joinTableAlias.id"
 325                                             . " AND $joinTableAlias.deleted=0 ";
 326                 return $ret_array;
 327    }
 328
 329    /**
 330     * Fills in all the custom fields of type relate relationships for an object
 331     *
 332     */
 333    function fill_relationships(){
 334         global $beanList, $beanFiles;
 335         if(!empty($this->bean->relDepth)) {
 336                         if($this->bean->relDepth > 1)return;
 337                 }else{
 338                         $this->bean->relDepth = 0;
 339         }
 340         foreach($this->bean->field_defs as $field){
 341                         if(empty($field['source']) || $field['source'] != 'custom_fields')continue;
 342             if($field['type'] == 'relate'){
 343                 $related_module =$field['ext2'];
 344                 $name = $field['name'];
 345                 if (empty($this->bean->$name)) { //Don't load the relationship twice
 346                         $id_name = $field['id_name'];
 347                         if(isset($beanList[ $related_module])){
 348                             $class = $beanList[$related_module];
 349
 350                             if(file_exists($beanFiles[$class]) && isset($this->bean->$name)){
 351                                 require_once($beanFiles[$class]);
 352                                 $mod = new $class();
 353                                 $mod->relDepth = $this->bean->relDepth + 1;
 354                                 $mod->retrieve($this->bean->$id_name);
 355                                 $this->bean->$name = $mod->name;
 356                             }
 357                         }
 358                 }
 359             }
 360         }
 361     }
 362
 363     /**
 364      * Process the save action for sugar bean custom fields
 365      *
 366      * @param boolean $isUpdate
 367      */
 368      function save($isUpdate){
 369
 370         if($this->bean->hasCustomFields() && isset($this->bean->id)){
 371
 372             if($isUpdate){
 373                 $query = "UPDATE ". $this->bean->table_name. "_cstm SET ";
 374             }
 375             $queryInsert = "INSERT INTO ". $this->bean->table_name. "_cstm (id_c";
 376             $values = "('".$this->bean->id."'";
 377             $first = true;
 378             foreach($this->bean->field_defs as $name=>$field){
 379
 380                 if(empty($field['source']) || $field['source'] != 'custom_fields')continue;
 381                 if($field['type'] == 'html' || $field['type'] == 'parent')continue;
 382                 if(isset($this->bean->$name)){
 383                     $quote = "'";
 384
 385                     if(in_array($field['type'], array('int', 'float', 'double', 'uint', 'ulong', 'long', 'short', 'tinyint', 'currency', 'decimal'))) {
 386                         $quote = '';
 387                         if(!isset($this->bean->$name) || !is_numeric($this->bean->$name) ){
 388                             if($field['required']){
 389                                 $this->bean->$name = 0;
 390                             }else{
 391                                 $this->bean->$name = 'NULL';
 392                             }
 393                         }
 394                     }
 395                     if ( $field['type'] == 'bool' ) {
 396                         if ( $this->bean->$name === FALSE )
 397                             $this->bean->$name = '0';
 398                         elseif ( $this->bean->$name === TRUE )
 399                             $this->bean->$name = '1';
 400                     }
 401                                         if(($field['type'] == 'date' || $field['type'] == 'datetimecombo') && (empty($this->bean->$name )|| $this->bean->$name == '1900-01-01')){
 402                         $quote = '';
 403                         $this->bean->$name = 'NULL';
 404                     }
 405                     if($isUpdate){
 406                         if($first){
 407                             $query .= " $name=$quote".$GLOBALS['db']->quote($this->bean->$name)."$quote";
 408
 409                         }else{
 410                             $query .= " ,$name=$quote".$GLOBALS['db']->quote($this->bean->$name)."$quote";
 411                         }
 412                     }
 413                     $first = false;
 414                     $queryInsert .= " ,$name";
 415                     $values .= " ,$quote". $GLOBALS['db']->quote($this->bean->$name). "$quote";
 416                 }
 417             }
 418             if($isUpdate){
 419                 $query.= " WHERE id_c='" . $this->bean->id ."'";
 420
 421             }
 422
 423             $queryInsert .= " ) VALUES $values )";
 424             if(!$first){
 425                 if(!$isUpdate){
 426                     $GLOBALS['db']->query($queryInsert);
 427                 }else{
 428                     $checkquery = "SELECT id_c FROM {$this->bean->table_name}_cstm WHERE id_c = '{$this->bean->id}'";
 429                     if ( $GLOBALS['db']->getOne($checkquery) )
 430                         $result = $GLOBALS['db']->query($query);
 431                     else
 432                         $GLOBALS['db']->query($queryInsert);
 433                 }
 434             }
 435
 436         }
 437
 438
 439
 440     }
 441     /**
 442      * Deletes the field from fields_meta_data and drops the database column then it rebuilds the cache
 443      * Use the widgets get_db_modify_alter_table() method to get the table sql - some widgets do not need any custom table modifications
 444      * @param STRING $name - field name
 445      */
 446     function deleteField($widget){
 447         require_once('modules/DynamicFields/templates/Fields/TemplateField.php');
 448         global $beanList;
 449                 if (!($widget instanceof TemplateField)) {
 450                         $field_name = $widget;
 451                         $widget = new TemplateField();
 452                         $widget->name = $field_name;
 453                 }
 454                 $object_name = $beanList[$this->module];
 455
 456                 if ($object_name == 'aCase') {
 457             $object_name = 'Case';
 458         }
 459
 460                 $GLOBALS['db']->query("DELETE FROM fields_meta_data WHERE id='" . $this->module . $widget->name . "'");
 461         $sql = $widget->get_db_delete_alter_table( $this->bean->table_name . "_cstm" ) ;
 462         if (! empty( $sql ) )
 463             $GLOBALS['db']->query( $sql );
 464
 465         $this->removeVardefExtension($widget);
 466         VardefManager::clearVardef();
 467         VardefManager::refreshVardefs($this->module, $object_name);
 468
 469     }
 470
 471     /*
 472      * Method required by the TemplateRelatedTextField->save() method
 473      * Taken from MBModule's implementation
 474      */
 475     function fieldExists($name = '', $type = ''){
 476         // must get the vardefs from the GLOBAL array as $bean->field_defs does not contain the values from the cache at this point
 477         // TODO: fix this - saveToVardefs() updates GLOBAL['dictionary'] correctly, obtaining its information directly from the fields_meta_data table via buildCache()...
 478         $vardefs = $GLOBALS['dictionary'][$this->bean->object_name]['fields'];
 479         if(!empty($vardefs)){
 480             if(empty($type) && empty($name))
 481                 return false;
 482             else if(empty($type))
 483                 return !empty($vardefs[$name]);
 484             else if(empty($name)){
 485                 foreach($vardefs as $def){
 486                     if($def['type'] == $type)
 487                         return true;
 488                 }
 489                 return false;
 490             }else
 491                 return (!empty($vardefs[$name]) && ($vardefs[$name]['type'] == $type));
 492         }else{
 493             return false;
 494         }
 495     }
 496
 497
 498     /**
 499      * Adds a custom field using a field object
 500      *
 501      * @param Field Object $field
 502      * @return boolean
 503      */
 504         function addFieldObject(&$field){
 505                 $GLOBALS['log']->debug('adding field');
 506                 $object_name = $this->module;
 507         $db_name = $field->name;
 508
 509         $fmd = new FieldsMetaData();
 510         $id =  $fmd->retrieve($object_name.$db_name,true, false);
 511         $is_update = false;
 512         $label = $field->label;
 513         if(!empty($id)){
 514             $is_update = true;
 515         }else{
 516             $db_name = $this->getDBName($field->name);
 517             $field->name = $db_name;
 518         }
 519         $this->createCustomTable();
 520         $fmd->id = $object_name.$db_name;
 521         $fmd->custom_module= $object_name;
 522         $fmd->name = $db_name;
 523         $fmd->vname = $label;
 524         $fmd->type = $field->type;
 525         $fmd->help = $field->help;
 526         if (!empty($field->len))
 527             $fmd->len = $field->len; // tyoung bug 15407 - was being set to $field->size so changes weren't being saved
 528         $fmd->required = ($field->required ? 1 : 0);
 529         $fmd->default_value = $field->default;
 530         $fmd->ext1 = $field->ext1;
 531         $fmd->ext2 = $field->ext2;
 532         $fmd->ext3 = $field->ext3;
 533         $fmd->ext4 = (isset($field->ext4) ? $field->ext4 : '');
 534         $fmd->comments = $field->comment;
 535         $fmd->massupdate = $field->massupdate;
 536         $fmd->importable = ( isset ( $field->importable ) ) ? $field->importable : null ;
 537         $fmd->duplicate_merge = $field->duplicate_merge;
 538         $fmd->audited =$field->audited;
 539         $fmd->reportable = ($field->reportable ? 1 : 0);
 540         if(!$is_update){
 541             $fmd->new_with_id=true;
 542         }
 543         $fmd->save();
 544         $this->buildCache($this->module);
 545         if($field){
 546             if(!$is_update){
 547                 $query = $field->get_db_add_alter_table($this->bean->table_name . '_cstm');
 548             }else{
 549                 $query = $field->get_db_modify_alter_table($this->bean->table_name . '_cstm');
 550             }
 551             if(!empty($query)){
 552                 $GLOBALS['db']->query($query);
 553             }
 554             $this->saveExtendedAttributes($field, array_keys($fmd->field_defs));
 555         }
 556
 557         return true;
 558     }
 559
 560     function saveExtendedAttributes($field, $column_fields)
 561     {
 562                 require_once ('modules/ModuleBuilder/parsers/StandardField.php') ;
 563                 require_once ('modules/DynamicFields/FieldCases.php') ;
 564                 global $beanList;
 565
 566                 $to_save = array();
 567                 $base_field = get_widget ( $field->type) ;
 568         foreach ($field->vardef_map as $property => $fmd_col){
 569
 570                 if (!isset($field->$property) || in_array($fmd_col, $column_fields) || in_array($property, $column_fields)
 571                         || $this->isDefaultValue($property, $field->$property, $base_field)
 572                         || $property == "action" || $property == "label_value" || $property == "label"
 573                 || (substr($property, 0,3) == 'ext' && strlen($property) == 4))
 574                 {
 575                         continue;
 576                 }
 577                 $to_save[$property] =
 578                 is_string($field->$property) ? htmlspecialchars_decode($field->$property, ENT_QUOTES) : $field->$property;
 579         }
 580         $bean_name = $beanList[$this->module];
 581
 582         $this->writeVardefExtension($bean_name, $field, $to_save);
 583     }
 584
 585         protected function isDefaultValue($property, $value, $baseField)
 586     {
 587         switch ($property) {
 588                 case "importable":
 589                         return ( $value === 'true' || $value === '1' || $value === true || $value === 1 ); break;
 590                 case "required":
 591                 case "audited":
 592                 case "massupdate":
 593                         return ( $value === 'false' || $value === '0' || $value === false || $value === 0); break;
 594                 case "default_value":
 595                 case "default":
 596                 case "help":
 597                 case "comments":
 598                         return ($value == "");
 599                 case "duplicate_merge":
 600                         return ( $value === 'false' || $value === '0' || $value === false || $value === 0 || $value === "disabled"); break;
 601         }
 602
 603         if (isset($baseField->$property))
 604         {
 605                 return $baseField->$property == $value;
 606         }
 607
 608         return false;
 609     }
 610
 611     protected function writeVardefExtension($bean_name, $field, $def_override)
 612     {
 613         //Hack for the broken cases module
 614         $vBean = $bean_name == "aCase" ? "Case" : $bean_name;
 615         $file_loc = "$this->base_path/sugarfield_{$field->name}.php";
 616
 617                 $out =  "<?php\n // created: " . date('Y-m-d H:i:s') . "\n";
 618         foreach ($def_override as $property => $val)
 619         {
 620                 $out .= override_value_to_string_recursive(array($vBean, "fields", $field->name, $property), "dictionary", $val) . "\n";
 621         }
 622
 623         $out .= "\n ?>";
 624
 625         if (!file_exists($this->base_path))
 626             mkdir_recursive($this->base_path);
 627
 628         if( $fh = @sugar_fopen( $file_loc, 'w' ) )
 629             {
 630                 fputs( $fh, $out);
 631                 fclose( $fh );
 632                 return true ;
 633             }
 634             else
 635             {
 636                 return false ;
 637             }
 638     }
 639
 640     protected function removeVardefExtension($field)
 641     {
 642         $file_loc = "$this->base_path/sugarfield_{$field->name}.php";
 643
 644         if (is_file($file_loc))
 645         {
 646                 unlink($file_loc);
 647         }
 648     }
 649
 650
 651     /**
 652      * DEPRECIATED: Use addFieldObject instead.
 653      * Adds a Custom Field using parameters
 654      *
 655      * @param unknown_type $name
 656      * @param unknown_type $label
 657      * @param unknown_type $type
 658      * @param unknown_type $max_size
 659      * @param unknown_type $required_option
 660      * @param unknown_type $default_value
 661      * @param unknown_type $ext1
 662      * @param unknown_type $ext2
 663      * @param unknown_type $ext3
 664      * @param unknown_type $audited
 665      * @param unknown_type $mass_update
 666      * @param unknown_type $ext4
 667      * @param unknown_type $help
 668      * @param unknown_type $duplicate_merge
 669      * @param unknown_type $comment
 670      * @return boolean
 671      */
 672     function addField($name,$label='', $type='Text',$max_size='255',$required_option='optional', $default_value='', $ext1='', $ext2='', $ext3='',$audited=0, $mass_update = 0 , $ext4='', $help='',$duplicate_merge=0, $comment=''){
 673                 require_once('modules/DynamicFields/templates/Fields/TemplateField.php');
 674         $field = new TemplateField();
 675         $field->label = $label;
 676         if(empty($field->label)){
 677             $field->label = $name;
 678         }
 679         $field->name = $name;
 680                 $field->type = $type;
 681                 $field->len = $max_size;
 682                 $field->required = (!empty($required_option) && $required_option != 'optional');
 683                 $field->default = $default_value;
 684                 $field->ext1 = $ext1;
 685                 $field->ext2 = $ext2;
 686                 $field->ext3 = $ext3;
 687                 $field->ext4 = $ext4;
 688                 $field->help = $help;
 689                 $field->comments = $comment;
 690                 $field->massupdate = $mass_update;
 691                 $field->duplicate_merge = $duplicate_merge;
 692                 $field->audited = $audited;
 693                 $field->reportable = 1;
 694         return $this->addFieldObject($field);
 695     }
 696
 697     /**
 698      * Creates the custom table with an id of id_c
 699      *
 700      */
 701     function createCustomTable($execute = true){
 702         $out = "";
 703         if (!$GLOBALS['db']->tableExists($this->bean->table_name."_cstm")) {
 704                 $GLOBALS['log']->debug('creating custom table for '. $this->bean->table_name);
 705             $query = "/* Missing Table: {$this->bean->table_name}_cstm */\n"
 706                    . "CREATE TABLE ".$this->bean->table_name.'_cstm ( ';
 707             $query .='id_c ' . $this->bean->dbManager->helper->getColumnType('id') .' NOT NULL';
 708             $query .=', PRIMARY KEY ( id_c ) )';
 709             if($GLOBALS['db']->dbType == 'mysql'){
 710                 $query .= ' CHARACTER SET utf8 COLLATE utf8_general_ci';
 711             }
 712             $out = $query . "\n";
 713             if ($execute)
 714                 $GLOBALS['db']->query($query);
 715             $out .= $this->add_existing_custom_fields($execute);
 716         }
 717
 718         return $out;
 719     }
 720
 721     /**
 722      * Updates the db schema and adds any custom fields we have used if the custom table was dropped
 723      *
 724      */
 725     function add_existing_custom_fields($execute = true){
 726         $out = "";
 727         if($this->bean->hasCustomFields()){
 728                 foreach($this->bean->field_defs as $name=>$data){
 729                         if(empty($data['source']) || $data['source'] != 'custom_fields')
 730                     continue;
 731                     $out .= $this->add_existing_custom_field($data, $execute);
 732                 }
 733         }
 734         return $out;
 735     }
 736
 737     function add_existing_custom_field($data, $execute = true)
 738     {
 739
 740         $field = get_widget ( $data ['type'] );
 741         $field->populateFromRow($data);
 742         $query = "/*MISSING IN DATABASE - {$data['name']} -  ROW*/\n"
 743                 . $field->get_db_add_alter_table($this->bean->table_name . '_cstm');
 744         $out = $query . "\n";
 745         if ($execute)
 746             $GLOBALS['db']->query($query);
 747
 748         return $out;
 749     }
 750
 751     public function repairCustomFields($execute = true)
 752     {
 753         $out = $this->createCustomTable($execute);
 754         //If the table didn't exist, createCustomTable will have returned all the SQL to create and populate it
 755         if (!empty($out))
 756             return "/*Checking Custom Fields for module : {$this->module} */\n$out";
 757         //Otherwise make sure all the custom fields defined in the vardefs exist in the custom table.
 758         //We aren't checking for data types, just that the column exists.
 759         $db = $GLOBALS['db'];
 760         $tablename = $this->bean->table_name."_cstm";
 761         $compareFieldDefs = $db->getHelper()->get_columns($tablename);
 762         foreach($this->bean->field_defs as $name=>$data){
 763             if(empty($data['source']) || $data['source'] != 'custom_fields')
 764                 continue;
 765             if(!empty($compareFieldDefs[$name])) {
 766                 continue;
 767         }
 768             $out .= $this->add_existing_custom_field($data, $execute);
 769         }
 770         if (!empty($out))
 771             $out = "/*Checking Custom Fields for module : {$this->module} */\n$out";
 772
 773         return $out;
 774     }
 775
 776     /**
 777      * Adds a label to the module's mod_strings for the current language
 778      * Note that the system label name
 779      *
 780      * @param string $displayLabel The label value to be displayed
 781      * @return string The core of the system label name - returns currency_id5 for example, when the full label would then be LBL_CURRENCY_ID5
 782      * TODO: Only the core is returned for historical reasons - switch to return the real system label
 783      */
 784     function addLabel ( $displayLabel )
 785     {
 786         $mod_strings = return_module_language($GLOBALS[ 'current_language' ], $this->module);
 787         $limit = 10;
 788         $count = 0;
 789         $field_key = $this->getDBName($displayLabel, false);
 790         $systemLabel = $field_key;
 791         if(!$this->use_existing_labels){ // use_existing_labels defaults to false in this module; as of today, only set to true by ModuleInstaller.php
 792             while( isset( $mod_strings [ $systemLabel ] ) && $count <= $limit )
 793             {
 794                 $systemLabel = $field_key. "_$count";
 795                 $count++;
 796             }
 797         }
 798         $selMod = (!empty($_REQUEST['view_module'])) ? $_REQUEST['view_module'] : $this->module;
 799         require_once 'modules/ModuleBuilder/parsers/parser.label.php' ;
 800         $parser = new ParserLabel ( $selMod , isset ( $_REQUEST [ 'view_package' ] ) ? $_REQUEST [ 'view_package' ] : null ) ;
 801         $parser->handleSave ( array('label_'. $systemLabel => $displayLabel ) , $GLOBALS [ 'current_language' ] ) ;
 802
 803         return $systemLabel;
 804     }
 805
 806     /**
 807      * Returns a Database Safe Name
 808      *
 809      * @param STRING $name
 810      * @param BOOLEAN $_C do we append _c to the name
 811      * @return STRING
 812      */
 813     function getDBName($name, $_C= true){
 814         static $cached_results = array();
 815         if(!empty($cached_results[$name]))
 816         {
 817             return $cached_results[$name];
 818         }
 819         $exclusions = array('parent_type', 'parent_id', 'currency_id', 'parent_name');
 820         // Remove any non-db friendly characters
 821         $return_value = preg_replace("/[^\w]+/","_",$name);
 822         if($_C == true && !in_array($return_value, $exclusions) && substr($return_value, -2) != '_c'){
 823             $return_value .= '_c';
 824         }
 825         $cached_results[$name] = $return_value;
 826         return $return_value;
 827     }
 828
 829     function setWhereClauses(&$where_clauses){
 830         if (isset($this->avail_fields)) {
 831                 foreach($this->avail_fields as $name=>$value){
 832                     if(!empty($_REQUEST[$name])){
 833                         $where_clauses[] = $this->bean->table_name . "_cstm.$name LIKE '". $GLOBALS['db']->quote($_REQUEST[$name]). "%'";
 834                     }
 835                 }
 836         }
 837
 838     }
 839
 840         /////////////////////////BACKWARDS COMPATABILITY MODE FOR PRE 5.0 MODULES\\\\\\\\\\\\\\\\\\\\\\\\\\\
 841         ////////////////////////////END BACKWARDS COMPATABILITY MODE FOR PRE 5.0 MODULES\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
 842
 843     /**
 844      *
 845      * DEPRECATED
 846      loads fields into the bean
 847      This used to be called during the retrieve process now it is done through a join
 848      Restored from pre-r30895 to maintain support for custom code that may have called retrieve() directly
 849      */
 850
 851     function retrieve()
 852     {
 853         if(!isset($this->bean)){
 854             $GLOBALS['log']->fatal("DynamicField retrieve, bean not instantiated: ".var_export(debug_print_backtrace(), true));
 855             return false;
 856         }
 857
 858         if(!$this->bean->hasCustomFields()){
 859             return false;
 860         }
 861
 862         $query = "SELECT * FROM ".$this->bean->table_name."_cstm WHERE id_c='".$this->bean->id."'";
 863         $result = $GLOBALS['db']->query($query);
 864         $row = $GLOBALS['db']->fetchByAssoc($result);
 865
 866         if($row)
 867         {
 868             foreach($row as $name=>$value)
 869             {
 870                 // originally in pre-r30895 we checked if this field was in avail_fields i.e., in fields_meta_data and not deleted
 871                 // with the removal of avail_fields post-r30895 we have simplified this - we now retrieve every custom field even if previously deleted
 872                 // this is considered harmless as the value although set in the bean will not otherwise be used (nothing else works off the list of fields in the bean)
 873                 $this->bean->$name = $value;
 874             }
 875         }
 876
 877     }
 878
 879    function populateXTPL(&$xtpl, $view){
 880                 if($this->bean->hasCustomFields()){
 881                 $results = $this->getAllFieldsView($view, 'xtpl');
 882                 foreach($results as $name=>$value){
 883                                 if(is_array($value['xtpl'])){
 884                         foreach($value['xtpl'] as $xName=>$xValue){
 885                             $xtpl->assign(strtoupper($xName), $xValue);
 886
 887                         }
 888                     }else{
 889                         $xtpl->assign(strtoupper($name), $value['xtpl']);
 890                     }
 891                 }
 892                 }
 893
 894     }
 895
 896     function populateAllXTPL(&$xtpl, $view){
 897         $this->populateXTPL($xtpl, $view);
 898
 899         }
 900
 901     function getAllFieldsView($view, $type){
 902                 $results = array();
 903          foreach($this->bean->field_defs as $name=>$data){
 904                 if(empty($data['source']) || $data['source'] != 'custom_fields')continue;
 905                 require_once ('modules/DynamicFields/FieldCases.php');
 906                 $field = get_widget ( $data ['type'] );
 907                 $field->populateFromRow($data);
 908             $field->view = $view;
 909             $field->bean =& $this->bean;
 910             switch(strtolower($type)){
 911                 case 'xtpl':
 912                     $results[$name] = array('xtpl'=>$field->get_xtpl());
 913                     break;
 914                 case 'html':
 915                     $results[$name] = array('html'=> $field->get_html(), 'label'=> $field->get_html_label(), 'fieldType'=>$field->data_type, 'isCustom' =>true);
 916                     break;
 917
 918             }
 919
 920         }
 921         return $results;
 922     }
 923
 924         ////////////////////////////END BACKWARDS COMPATABILITY MODE FOR PRE 5.0 MODULES\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
 925 }
 926
 927 ?>