modules/DynamicFields/templates/Fields/TemplateField.php

   1 <?php
   2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
   3 /*********************************************************************************
   4  * SugarCRM Community Edition is a customer relationship management program developed by
   5  * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU Affero General Public License version 3 as published by the
   9  * Free Software Foundation with the addition of the following permission added
  10  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  11  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  12  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License along with
  20  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  21  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA.
  23  *
  24  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  25  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  26  *
  27  * The interactive user interfaces in modified source and object code versions
  28  * of this program must display Appropriate Legal Notices, as required under
  29  * Section 5 of the GNU Affero General Public License version 3.
  30  *
  31  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  32  * these Appropriate Legal Notices must retain the display of the "Powered by
  33  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  34  * technical reasons, the Appropriate Legal Notices must display the words
  35  * "Powered by SugarCRM".
  36  ********************************************************************************/
  37
  38 $GLOBALS['studioReadOnlyFields'] = array('date_entered'=>1, 'date_modified'=>1, 'created_by'=>1, 'id'=>1, 'modified_user_id'=>1);
  39 class TemplateField{
  40         /*
  41                 The view is the context this field will be used in
  42                 -edit
  43                 -list
  44                 -detail
  45                 -search
  46                 */
  47         var $view = 'edit';
  48         var $name = '';
  49         var $vname = '';
  50         var $id = '';
  51         var $size = '20';
  52         var $len = '255';
  53         var $required = false;
  54         var $default = null;
  55         var $default_value = null;
  56         var $type = 'varchar';
  57         var $comment = '';
  58         var $bean;
  59         var $ext1 = '';
  60         var $ext2 = '';
  61         var $ext3 = '';
  62         var $ext4 = '';
  63         var $audited= 0;
  64         var $massupdate = 0;
  65         var $importable = 'true' ;
  66         var $duplicate_merge=0;
  67         var $new_field_definition;
  68         var $reportable = true;
  69         var $label_value = '';
  70         var $help = '';
  71         var $formula = '';
  72     var $unified_search = 0;
  73     var $supports_unified_search = false;
  74         var $vardef_map = array(
  75                 'name'=>'name',
  76                 'label'=>'vname',
  77         // bug 15801 - need to ALWAYS keep default and default_value consistent as some methods/classes use one, some use another...
  78                 'default_value'=>'default',
  79                 'default'=>'default_value',
  80                 'display_default'=>'default_value',
  81         //              'default_value'=>'default_value',
  82         //              'default'=>'default_value',
  83                 'len'=>'len',
  84                 'required'=>'required',
  85                 'type'=>'type',
  86                 'audited'=>'audited',
  87                 'massupdate'=>'massupdate',
  88                 'options'=>'ext1',
  89                 'help'=>'help',
  90             'comments'=>'comment',
  91             'importable'=>'importable',
  92                 'duplicate_merge'=>'duplicate_merge',
  93                 'duplicate_merge_dom_value'=>'duplicate_merge_dom_value', //bug #14897
  94                 'merge_filter'=>'merge_filter',
  95                 'reportable' => 'reportable',
  96                 'ext2'=>'ext2',
  97                 'ext4'=>'ext4',
  98             'ext3'=>'ext3',
  99                 'label_value'=>'label_value',
 100                 'unified_search'=>'unified_search',
 101         'full_text_search'=>'full_text_search',
 102         );
 103     // Bug #48826
 104     // fields to decode from post request
 105     var $decode_from_request_fields_map = array('formula', 'dependency');
 106         /*
 107                 HTML FUNCTIONS
 108                 */
 109         function get_html(){
 110                 $view = $this->view;
 111                 if(!empty($GLOBALS['studioReadOnlyFields'][$this->name]))$view = 'detail';
 112                 switch($view){
 113                         case 'search':return $this->get_html_search();
 114                         case 'edit': return $this->get_html_edit();
 115                         case 'list': return $this->get_html_list();
 116                         case 'detail': return $this->get_html_detail();
 117
 118                 }
 119         }
 120         function set($values){
 121                 foreach($values as $name=>$value){
 122                         $this->$name = $value;
 123                 }
 124
 125         }
 126
 127         function get_html_edit(){
 128                 return 'not implemented';
 129         }
 130
 131         function get_html_list(){
 132                 return $this->get_html_detail();
 133         }
 134
 135         function get_html_detail(){
 136                 return 'not implemented';
 137         }
 138
 139         function get_html_search(){
 140                 return $this->get_html_edit();
 141         }
 142         function get_html_label(){
 143
 144                 $label =  "{MOD." .$this->vname . "}";
 145                 if(!empty($GLOBALS['app_strings'][$this->vname])){
 146                         $label = "{APP." .$this->label . "}";
 147                 }
 148                 if($this->view == 'edit' && $this->is_required()){
 149                         $label .= '<span class="required">*</span>';
 150                 }
 151                 if($this->view == 'list'){
 152                         if(isset($this->bean)){
 153                                 if(!empty($this->id)){
 154                                         $name = $this->bean->table_name . '_cstm.'. $this->name;
 155                                         $arrow = $this->bean->table_name . '_cstm_'. $this->name;
 156                                 }else{
 157                                         $name = $this->bean->table_name . '.'. $this->name;
 158                                         $arrow = $this->bean->table_name . '_'. $this->name;
 159                                 }
 160                         }else{
 161                                 $name = $this->name;
 162                                 $arrow = $name;
 163                         }
 164                         $label = "<a href='{ORDER_BY}$name' class='listViewThLinkS1'>{MOD.$this->label}{arrow_start}{".$arrow."_arrow}{arrow_end}</a>";
 165                 }
 166                 return $label;
 167
 168         }
 169
 170         /*
 171                 XTPL FUNCTIONS
 172                 */
 173
 174         function get_xtpl($bean = false){
 175                 if($bean)
 176                 $this->bean = $bean;
 177                 $view = $this->view;
 178                 if(!empty($GLOBALS['studioReadOnlyFields'][$this->name]))$view = 'detail';
 179                 switch($view){
 180                         case 'search':return $this->get_xtpl_search();
 181                         case 'edit': return $this->get_xtpl_edit();
 182                         case 'list': return $this->get_xtpl_list();
 183                         case 'detail': return $this->get_xtpl_detail();
 184
 185                 }
 186         }
 187
 188         function get_xtpl_edit(){
 189                 return '/*not implemented*/';
 190         }
 191
 192         function get_xtpl_list(){
 193                 return get_xtpl_detail();
 194         }
 195
 196         function get_xtpl_detail(){
 197                 return '/*not implemented*/';
 198         }
 199
 200         function get_xtpl_search(){
 201                 //return get_xtpl_edit();
 202         }
 203
 204         function is_required(){
 205                 if($this->required){
 206                         return true;
 207                 }
 208                 return false;
 209
 210         }
 211
 212
 213
 214
 215         /*
 216                 DB FUNCTIONS
 217                 */
 218
 219         function get_db_type(){
 220             if(!empty($this->type)) {
 221                 $type = $GLOBALS['db']->getColumnType($this->type);
 222             }
 223             if(!empty($type)) return " $type";
 224             $type = $GLOBALS['db']->getColumnType("varchar");
 225         return " $type({$this->len})";
 226         }
 227
 228         function get_db_default($modify=false){
 229                 $GLOBALS['log']->debug('get_db_default(): default_value='.$this->default_value);
 230                 if (!$modify or empty($this->new_field_definition['default_value']) or $this->new_field_definition['default_value'] != $this->default_value ) {
 231                         if(!is_null($this->default_value)){ // add a default value if it is not null - we want to set a default even if default_value is '0', which is not null, but which is empty()
 232                                 if(NULL == trim($this->default_value)){
 233                                         return " DEFAULT NULL";
 234                                 }
 235                                 else {
 236                                         return " DEFAULT '$this->default_value'";
 237                                 }
 238                         }else{
 239                                 return '';
 240                         }
 241                 }
 242         }
 243
 244         /*
 245          * Return the required clause for this field
 246          * Confusingly, when modifying an existing field ($modify=true) there are two exactly opposite cases:
 247          * 1. if called by Studio, only $this->required is set. If set, we return "NOT NULL" otherwise we return "NULL"
 248          * 2. if not called by Studio, $this->required holds the OLD value of required, and new_field_definition['required'] is the NEW
 249          * So if not called by Studio we want to return NULL if required=true (because we are changing FROM this setting)
 250          */
 251
 252         function get_db_required($modify=false){
 253                 //              $GLOBALS['log']->debug('get_db_required required='.$this->required." and ".(($modify)?"true":"false")." and ".print_r($this->new_field_definition,true));
 254                 $req = "";
 255
 256                 if ($modify) {
 257                         if (!empty($this->new_field_definition['required'])) {
 258                                 if ($this->required and $this->new_field_definition['required'] != $this->required) {
 259                                         $req = " NULL ";
 260                                 }
 261                         }
 262                         else
 263                         {
 264                                 $req = ($this->required) ? " NOT NULL " : ''; // bug 17184 tyoung - set required correctly when modifying custom field in Studio
 265                         }
 266                 }
 267                 else
 268                 {
 269                         if (empty($this->new_field_definition['required']) or $this->new_field_definition['required'] != $this->required ) {
 270                                 if(!empty($this->required) && $this->required){
 271                                         $req = " NOT NULL";
 272                                 }
 273                         }
 274                 }
 275
 276                 return $req;
 277         }
 278
 279         /*      function get_db_required($modify=false){
 280                 $GLOBALS['log']->debug('get_db_required required='.$this->required." and ".(($modify)?"true":"false")." and ".print_r($this->new_field_definition,true));
 281                 if ($modify) {
 282                 if (!empty($this->new_field_definition['required'])) {
 283                 if ($this->required and $this->new_field_definition['required'] != $this->required) {
 284                 return " null ";
 285                 }
 286                 return "";
 287                 }
 288                 }
 289                 if (empty($this->new_field_definition['required']) or $this->new_field_definition['required'] != $this->required ) {
 290                 if(!empty($this->required) && $this->required){
 291                 return " NOT NULL";
 292                 }
 293                 }
 294                 return '';
 295                 }
 296                 */
 297         /**
 298          * Oracle Support: do not set required constraint if no default value is supplied.
 299          * In this case the default value will be handled by the application/sugarbean.
 300          */
 301         function get_db_add_alter_table($table)
 302         {
 303                 return $GLOBALS['db']->getHelper()->addColumnSQL($table, $this->get_field_def(), true);
 304         }
 305
 306         function get_db_delete_alter_table($table)
 307         {
 308                 return $GLOBALS['db']->getHelper()->dropColumnSQL(
 309                 $table,
 310                 $this->get_field_def()
 311                 );
 312         }
 313
 314         /**
 315          * mysql requires the datatype caluse in the alter statment.it will be no-op anyway.
 316          */
 317         function get_db_modify_alter_table($table){
 318                 return $GLOBALS['db']->alterColumnSQL($table, $this->get_field_def());
 319         }
 320
 321
 322         /*
 323          * BEAN FUNCTIONS
 324          *
 325          */
 326         function get_field_def(){
 327                 $array =  array(
 328                         'required'=>$this->convertBooleanValue($this->required),
 329                         'source'=>'custom_fields',
 330                         'name'=>$this->name,
 331                         'vname'=>$this->vname,
 332                         'type'=>$this->type,
 333                         'massupdate'=>$this->massupdate,
 334                         'default'=>$this->default,
 335             'no_default'=> !empty($this->no_default),
 336                         'comments'=> (isset($this->comments)) ? $this->comments : '',
 337                     'help'=> (isset($this->help)) ?  $this->help : '',
 338                     'importable'=>$this->importable,
 339                         'duplicate_merge'=>$this->duplicate_merge,
 340                         'duplicate_merge_dom_value'=> $this->getDupMergeDomValue(),
 341                         'audited'=>$this->convertBooleanValue($this->audited),
 342                         'reportable'=>$this->convertBooleanValue($this->reportable),
 343             'unified_search'=>$this->convertBooleanValue($this->unified_search),
 344             'merge_filter' => empty($this->merge_filter) ? "disabled" : $this->merge_filter
 345                 );
 346         if (isset($this->full_text_search)) {
 347             $array['full_text_search'] = $this->full_text_search;
 348         }
 349                 if(!empty($this->len)){
 350                         $array['len'] = $this->len;
 351                 }
 352                 if(!empty($this->size)){
 353                         $array['size'] = $this->size;
 354                 }
 355
 356         $this->get_dup_merge_def($array);
 357
 358                 return $array;
 359         }
 360
 361         protected function convertBooleanValue($value)
 362         {
 363                 if ($value === 'true' || $value === '1' || $value === 1)
 364                 return  true;
 365                 else if ($value === 'false' || $value === '0' || $value === 0)
 366                 return  false;
 367                 else
 368                 return $value;
 369         }
 370
 371
 372         /* if the field is duplicate merge enabled this function will return the vardef entry for the same.
 373          */
 374         function get_dup_merge_def(&$def) {
 375         switch ($def['duplicate_merge_dom_value']) {
 376                         case 0:
 377                                 $def['duplicate_merge']='disabled';
 378                 $def['merge_filter']='disabled';
 379                                 break;
 380                         case 1:
 381                                 $def['duplicate_merge']='enabled';
 382                 $def['merge_filter']='disabled';
 383                                 break;
 384                         case 2:
 385                                 $def['merge_filter']='enabled';
 386                                 $def['duplicate_merge']='enabled';
 387                                 break;
 388                         case 3:
 389                                 $def['merge_filter']='selected';
 390                                 $def['duplicate_merge']='enabled';
 391                                 break;
 392                         case 4:
 393                                 $def['merge_filter']='enabled';
 394                                 $def['duplicate_merge']='disabled';
 395                                 break;
 396                 }
 397
 398         }
 399
 400     /**
 401      * duplicate_merge_dom_value drives the dropdown in the studio editor. This dropdown drives two fields though,
 402      * duplicate_merge and merge_filter. When duplicate_merge_dom_value is not set, we need to derive it from the values
 403      * of those two fields. Also, when studio sends this value down to be read in PopulateFromPost, it is set to
 404      * duplicate_merge rather than duplicate_merge_dom_value, so we must check if duplicate_merge is a number rather
 405      * than a string as well.
 406      * @return int
 407      */
 408     function getDupMergeDomValue(){
 409         if (isset($this->duplicate_merge_dom_value)) {
 410             return $this->duplicate_merge_dom_value;
 411         }
 412
 413         //If duplicate merge is numeric rather than a string, it is probably what duplicate_merge_dom_value was set to.
 414         if (is_numeric($this->duplicate_merge))
 415             return $this->duplicate_merge;
 416
 417
 418         //Figure out the duplicate_merge_dom_value based on the values of merge filter and duplicate merge
 419         if (empty($this->merge_filter) || $this->merge_filter === 'disabled' )
 420         {
 421             if (empty($this->duplicate_merge) || $this->duplicate_merge === 'disabled') {
 422                 $this->duplicate_merge_dom_value = 0;
 423             } else {
 424                 $this->duplicate_merge_dom_value = 1;
 425             }
 426         } else {
 427             if ($this->merge_filter === "selected")
 428                 $this->duplicate_merge_dom_value = 3;
 429             else if (empty($this->duplicate_merge) || $this->duplicate_merge === 'disabled') {
 430                 $this->duplicate_merge_dom_value = 4;
 431             } else {
 432                 $this->duplicate_merge_dom_value = 2;
 433             }
 434         }
 435
 436         return $this->duplicate_merge_dom_value;
 437     }
 438
 439         /*
 440                 HELPER FUNCTIONS
 441                 */
 442
 443
 444         function prepare(){
 445                 if(empty($this->id)){
 446                         $this->id = $this->name;
 447                 }
 448         }
 449
 450         /**
 451          * populateFromRow
 452          * This function supports setting the values of all TemplateField instances.
 453          * @param $row The Array key/value pairs from fields_meta_data table
 454          */
 455         function populateFromRow($row=array()) {
 456                 $fmd_to_dyn_map = array('comments' => 'comment', 'require_option' => 'required', 'label' => 'vname',
 457                                                             'mass_update' => 'massupdate', 'max_size' => 'len', 'default_value' => 'default', 'id_name' => 'ext3');
 458                 if(!is_array($row)) {
 459                         $GLOBALS['log']->error("Error: TemplateField->populateFromRow expecting Array");
 460                 }
 461                 //Bug 24189: Copy fields from FMD format to Field objects and vice versa
 462                 foreach ($fmd_to_dyn_map as $fmd_key => $dyn_key) {
 463             if (isset($row[$dyn_key])) {
 464                 $this->$fmd_key = $row[$dyn_key];
 465             }
 466             if (isset($row[$fmd_key])) {
 467                                 $this->$dyn_key = $row[$fmd_key];
 468                         }
 469                 }
 470                 foreach($row as $key=>$value) {
 471                         $this->$key = $value;
 472                 }
 473         }
 474
 475         function populateFromPost(){
 476                 foreach($this->vardef_map as $vardef=>$field){
 477
 478                         if(isset($_REQUEST[$vardef])){
 479                 $this->$vardef = $_REQUEST[$vardef];
 480
 481                 //  Bug #48826. Some fields are allowed to have special characters and must be decoded from the request
 482                 // Bug 49774, 49775: Strip html tags from 'formula' and 'dependency'.
 483                 if (is_string($this->$vardef) && in_array($vardef, $this->decode_from_request_fields_map))
 484                 {
 485                     $this->$vardef = html_entity_decode(strip_tags(from_html($this->$vardef)));
 486                 }
 487
 488
 489                 //Remove potential xss code from help field
 490                 if($field == 'help' && !empty($this->$vardef))
 491                 {
 492                     $help = htmlspecialchars_decode($this->$vardef, ENT_QUOTES);
 493                     $this->$vardef = htmlentities(remove_xss($help));
 494                 }
 495
 496
 497                                 if($vardef != $field){
 498                                         $this->$field = $this->$vardef;
 499                                 }
 500                         }
 501                 }
 502                 $this->applyVardefRules();
 503                 $GLOBALS['log']->debug('populate: '.print_r($this,true));
 504
 505         }
 506
 507         protected function applyVardefRules()
 508         {
 509         }
 510
 511         function get_additional_defs(){
 512                 return array();
 513         }
 514
 515         function delete($df){
 516                 $df->deleteField($this);
 517         }
 518
 519     /**
 520      * get_field_name
 521      *
 522      * This is a helper function to return a field's proper name.  It checks to see if an instance of the module can
 523      * be created and then attempts to retrieve the field's name based on the name lookup skey supplied to the method.
 524      *
 525      * @param String $module The name of the module
 526      * @param String $name The field name key
 527      * @return The field name for the module
 528      */
 529     protected function get_field_name($module, $name)
 530     {
 531        $bean = loadBean($module);
 532        if(empty($bean) || is_null($bean))
 533        {
 534           return $name;
 535        }
 536
 537        $field_defs = $bean->field_defs;
 538        return isset($field_defs[$name]['name']) ? $field_defs[$name]['name'] : $name;
 539     }
 540
 541     /**
 542      * save
 543      *
 544      * This function says the field template by calling the DynamicField addFieldObject function.  It then
 545      * checks to see if updates are needed for the SearchFields.php file.  In the event that the unified_search
 546      * member variable is set to true, a search field definition is updated/created to the SearchFields.php file.
 547      *
 548      * @param DynamicField $df
 549      */
 550         function save($df){
 551                 //          $GLOBALS['log']->debug('saving field: '.print_r($this,true));
 552                 $df->addFieldObject($this);
 553
 554         require_once('modules/ModuleBuilder/parsers/parser.searchfields.php');
 555         $searchFieldParser = new ParserSearchFields( $df->getModuleName() , $df->getPackageName() ) ;
 556             //If unified_search is enabled for this field, then create the SearchFields entry
 557             $fieldName = $this->get_field_name($df->getModuleName(), $this->name);
 558         if($this->unified_search && !isset($searchFieldParser->searchFields[$df->getModuleName()][$fieldName]))
 559         {
 560            $searchFieldParser->addSearchField($fieldName, array('query_type'=>'default'));
 561            $searchFieldParser->saveSearchFields($searchFieldParser->searchFields);
 562         }
 563         }
 564
 565 }
 566
 567
 568 ?>