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                 'min'=>'ext1',
  97                 'max'=>'ext2',
  98                 'ext2'=>'ext2',
  99                 'ext4'=>'ext4',
 100         //'disable_num_format'=>'ext3',
 101             'ext3'=>'ext3',
 102                 'label_value'=>'label_value',
 103                 'unified_search'=>'unified_search',
 104         );
 105     // Bug #48826
 106     // fields to decode from post request
 107     var $decode_from_request_fields_map = array('formula', 'dependency');
 108         /*
 109                 HTML FUNCTIONS
 110                 */
 111         function get_html(){
 112                 $view = $this->view;
 113                 if(!empty($GLOBALS['studioReadOnlyFields'][$this->name]))$view = 'detail';
 114                 switch($view){
 115                         case 'search':return $this->get_html_search();
 116                         case 'edit': return $this->get_html_edit();
 117                         case 'list': return $this->get_html_list();
 118                         case 'detail': return $this->get_html_detail();
 119
 120                 }
 121         }
 122         function set($values){
 123                 foreach($values as $name=>$value){
 124                         $this->$name = $value;
 125                 }
 126
 127         }
 128
 129         function get_html_edit(){
 130                 return 'not implemented';
 131         }
 132
 133         function get_html_list(){
 134                 return $this->get_html_detail();
 135         }
 136
 137         function get_html_detail(){
 138                 return 'not implemented';
 139         }
 140
 141         function get_html_search(){
 142                 return $this->get_html_edit();
 143         }
 144         function get_html_label(){
 145
 146                 $label =  "{MOD." .$this->vname . "}";
 147                 if(!empty($GLOBALS['app_strings'][$this->vname])){
 148                         $label = "{APP." .$this->label . "}";
 149                 }
 150                 if($this->view == 'edit' && $this->is_required()){
 151                         $label .= '<span class="required">*</span>';
 152                 }
 153                 if($this->view == 'list'){
 154                         if(isset($this->bean)){
 155                                 if(!empty($this->id)){
 156                                         $name = $this->bean->table_name . '_cstm.'. $this->name;
 157                                         $arrow = $this->bean->table_name . '_cstm_'. $this->name;
 158                                 }else{
 159                                         $name = $this->bean->table_name . '.'. $this->name;
 160                                         $arrow = $this->bean->table_name . '_'. $this->name;
 161                                 }
 162                         }else{
 163                                 $name = $this->name;
 164                                 $arrow = $name;
 165                         }
 166                         $label = "<a href='{ORDER_BY}$name' class='listViewThLinkS1'>{MOD.$this->label}{arrow_start}{".$arrow."_arrow}{arrow_end}</a>";
 167                 }
 168                 return $label;
 169
 170         }
 171
 172         /*
 173                 XTPL FUNCTIONS
 174                 */
 175
 176         function get_xtpl($bean = false){
 177                 if($bean)
 178                 $this->bean = $bean;
 179                 $view = $this->view;
 180                 if(!empty($GLOBALS['studioReadOnlyFields'][$this->name]))$view = 'detail';
 181                 switch($view){
 182                         case 'search':return $this->get_xtpl_search();
 183                         case 'edit': return $this->get_xtpl_edit();
 184                         case 'list': return $this->get_xtpl_list();
 185                         case 'detail': return $this->get_xtpl_detail();
 186
 187                 }
 188         }
 189
 190         function get_xtpl_edit(){
 191                 return '/*not implemented*/';
 192         }
 193
 194         function get_xtpl_list(){
 195                 return get_xtpl_detail();
 196         }
 197
 198         function get_xtpl_detail(){
 199                 return '/*not implemented*/';
 200         }
 201
 202         function get_xtpl_search(){
 203                 //return get_xtpl_edit();
 204         }
 205
 206         function is_required(){
 207                 if($this->required){
 208                         return true;
 209                 }
 210                 return false;
 211
 212         }
 213
 214
 215
 216
 217         /*
 218                 DB FUNCTIONS
 219                 */
 220
 221         function get_db_type(){
 222             if(!empty($this->type)) {
 223                 $type = $GLOBALS['db']->getColumnType($this->type);
 224             }
 225             if(!empty($type)) return " $type";
 226             $type = $GLOBALS['db']->getColumnType("varchar");
 227         return " $type({$this->len})";
 228         }
 229
 230         function get_db_default($modify=false){
 231                 $GLOBALS['log']->debug('get_db_default(): default_value='.$this->default_value);
 232                 if (!$modify or empty($this->new_field_definition['default_value']) or $this->new_field_definition['default_value'] != $this->default_value ) {
 233                         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()
 234                                 if(NULL == trim($this->default_value)){
 235                                         return " DEFAULT NULL";
 236                                 }
 237                                 else {
 238                                         return " DEFAULT '$this->default_value'";
 239                                 }
 240                         }else{
 241                                 return '';
 242                         }
 243                 }
 244         }
 245
 246         /*
 247          * Return the required clause for this field
 248          * Confusingly, when modifying an existing field ($modify=true) there are two exactly opposite cases:
 249          * 1. if called by Studio, only $this->required is set. If set, we return "NOT NULL" otherwise we return "NULL"
 250          * 2. if not called by Studio, $this->required holds the OLD value of required, and new_field_definition['required'] is the NEW
 251          * So if not called by Studio we want to return NULL if required=true (because we are changing FROM this setting)
 252          */
 253
 254         function get_db_required($modify=false){
 255                 //              $GLOBALS['log']->debug('get_db_required required='.$this->required." and ".(($modify)?"true":"false")." and ".print_r($this->new_field_definition,true));
 256                 $req = "";
 257
 258                 if ($modify) {
 259                         if (!empty($this->new_field_definition['required'])) {
 260                                 if ($this->required and $this->new_field_definition['required'] != $this->required) {
 261                                         $req = " NULL ";
 262                                 }
 263                         }
 264                         else
 265                         {
 266                                 $req = ($this->required) ? " NOT NULL " : ''; // bug 17184 tyoung - set required correctly when modifying custom field in Studio
 267                         }
 268                 }
 269                 else
 270                 {
 271                         if (empty($this->new_field_definition['required']) or $this->new_field_definition['required'] != $this->required ) {
 272                                 if(!empty($this->required) && $this->required){
 273                                         $req = " NOT NULL";
 274                                 }
 275                         }
 276                 }
 277
 278                 return $req;
 279         }
 280
 281         /*      function get_db_required($modify=false){
 282                 $GLOBALS['log']->debug('get_db_required required='.$this->required." and ".(($modify)?"true":"false")." and ".print_r($this->new_field_definition,true));
 283                 if ($modify) {
 284                 if (!empty($this->new_field_definition['required'])) {
 285                 if ($this->required and $this->new_field_definition['required'] != $this->required) {
 286                 return " null ";
 287                 }
 288                 return "";
 289                 }
 290                 }
 291                 if (empty($this->new_field_definition['required']) or $this->new_field_definition['required'] != $this->required ) {
 292                 if(!empty($this->required) && $this->required){
 293                 return " NOT NULL";
 294                 }
 295                 }
 296                 return '';
 297                 }
 298                 */
 299         /**
 300          * Oracle Support: do not set required constraint if no default value is supplied.
 301          * In this case the default value will be handled by the application/sugarbean.
 302          */
 303         function get_db_add_alter_table($table)
 304         {
 305                 return $GLOBALS['db']->getHelper()->addColumnSQL($table, $this->get_field_def(), true);
 306         }
 307
 308         function get_db_delete_alter_table($table)
 309         {
 310                 return $GLOBALS['db']->getHelper()->dropColumnSQL(
 311                 $table,
 312                 $this->get_field_def()
 313                 );
 314         }
 315
 316         /**
 317          * mysql requires the datatype caluse in the alter statment.it will be no-op anyway.
 318          */
 319         function get_db_modify_alter_table($table){
 320                 return $GLOBALS['db']->alterColumnSQL($table, $this->get_field_def());
 321         }
 322
 323
 324         /*
 325          * BEAN FUNCTIONS
 326          *
 327          */
 328         function get_field_def(){
 329                 $array =  array(
 330                         'required'=>$this->convertBooleanValue($this->required),
 331                         'source'=>'custom_fields',
 332                         'name'=>$this->name,
 333                         'vname'=>$this->vname,
 334                         'type'=>$this->type,
 335                         'massupdate'=>$this->massupdate,
 336                         'default'=>$this->default,
 337                         'comments'=> (isset($this->comments)) ? $this->comments : '',
 338                     'help'=> (isset($this->help)) ?  $this->help : '',
 339                     'importable'=>$this->importable,
 340                         'duplicate_merge'=>$this->duplicate_merge,
 341                         'duplicate_merge_dom_value'=> isset($this->duplicate_merge_dom_value) ? $this->duplicate_merge_dom_value : $this->duplicate_merge,
 342                         'audited'=>$this->convertBooleanValue($this->audited),
 343                         'reportable'=>$this->convertBooleanValue($this->reportable),
 344             'unified_search'=>$this->convertBooleanValue($this->unified_search)
 345                 );
 346                 if(!empty($this->len)){
 347                         $array['len'] = $this->len;
 348                 }
 349                 if(!empty($this->size)){
 350                         $array['size'] = $this->size;
 351                 }
 352                 $this->get_dup_merge_def($array);
 353
 354                 return $array;
 355         }
 356
 357         protected function convertBooleanValue($value)
 358         {
 359                 if ($value === 'true' || $value === '1' || $value === 1)
 360                 return  true;
 361                 else if ($value === 'false' || $value === '0' || $value === 0)
 362                 return  false;
 363                 else
 364                 return $value;
 365         }
 366
 367
 368         /* if the field is duplicate merge enabled this function will return the vardef entry for the same.
 369          */
 370         function get_dup_merge_def(&$def) {
 371
 372                 switch ($def['duplicate_merge_dom_value']) {
 373                         case 0:
 374                                 $def['duplicate_merge']='disabled';
 375                                 break;
 376                         case 1:
 377                                 $def['duplicate_merge']='enabled';
 378                                 break;
 379                         case 2:
 380                                 $def['merge_filter']='enabled';
 381                                 $def['duplicate_merge']='enabled';
 382                                 break;
 383                         case 3:
 384                                 $def['merge_filter']='selected';
 385                                 $def['duplicate_merge']='enabled';
 386                                 break;
 387                         case 4:
 388                                 $def['merge_filter']='enabled';
 389                                 $def['duplicate_merge']='disabled';
 390                                 break;
 391                 }
 392
 393         }
 394
 395         /*
 396                 HELPER FUNCTIONS
 397                 */
 398
 399
 400         function prepare(){
 401                 if(empty($this->id)){
 402                         $this->id = $this->name;
 403                 }
 404         }
 405
 406         /**
 407          * populateFromRow
 408          * This function supports setting the values of all TemplateField instances.
 409          * @param $row The Array key/value pairs from fields_meta_data table
 410          */
 411         function populateFromRow($row=array()) {
 412                 $fmd_to_dyn_map = array('comments' => 'comment', 'require_option' => 'required', 'label' => 'vname',
 413                                                             'mass_update' => 'massupdate', 'max_size' => 'len', 'default_value' => 'default', 'id_name' => 'ext3');
 414                 if(!is_array($row)) {
 415                         $GLOBALS['log']->error("Error: TemplateField->populateFromRow expecting Array");
 416                 }
 417                 //Bug 24189: Copy fields from FMD format to Field objects
 418                 foreach ($fmd_to_dyn_map as $fmd_key => $dyn_key) {
 419                         if (isset($row[$fmd_key])) {
 420                                 $this->$dyn_key = $row[$fmd_key];
 421                         }
 422                 }
 423                 foreach($row as $key=>$value) {
 424                         $this->$key = $value;
 425                 }
 426         }
 427
 428         function populateFromPost(){
 429                 foreach($this->vardef_map as $vardef=>$field){
 430
 431                         if(isset($_REQUEST[$vardef])){
 432                 $this->$vardef = $_REQUEST[$vardef];
 433
 434                             //  Bug #48826. Some fields are allowed to have special characters and must be decoded from the request
 435                 if (is_string($this->$vardef) && in_array($vardef, $this->decode_from_request_fields_map))
 436                   $this->$vardef = html_entity_decode($this->$vardef);
 437
 438                                 // Bug 49774, 49775: Strip html tags from 'formula' and 'dependency'.
 439                                 // Add to the list below if we need to do the same for other fields.
 440                                 if (!empty($this->$vardef) && in_array($vardef, array('formula', 'dependency'))){
 441                                     $this->$vardef = to_html(strip_tags(from_html($this->$vardef)));
 442                                 }
 443
 444                 //Remove potential xss code from help field
 445                 if($field == 'help' && !empty($this->$vardef))
 446                 {
 447                     $help = htmlspecialchars_decode($this->$vardef, ENT_QUOTES);
 448                     $this->$vardef = htmlentities(remove_xss($help));
 449                 }
 450
 451
 452                                 if($vardef != $field){
 453                                         $this->$field = $this->$vardef;
 454                                 }
 455                         }
 456                 }
 457                 $this->applyVardefRules();
 458                 $GLOBALS['log']->debug('populate: '.print_r($this,true));
 459
 460         }
 461
 462         protected function applyVardefRules()
 463         {
 464         }
 465
 466         function get_additional_defs(){
 467                 return array();
 468         }
 469
 470         function delete($df){
 471                 $df->deleteField($this);
 472         }
 473
 474     /**
 475      * get_field_name
 476      *
 477      * This is a helper function to return a field's proper name.  It checks to see if an instance of the module can
 478      * be created and then attempts to retrieve the field's name based on the name lookup skey supplied to the method.
 479      *
 480      * @param String $module The name of the module
 481      * @param String $name The field name key
 482      * @return The field name for the module
 483      */
 484     protected function get_field_name($module, $name)
 485     {
 486        $bean = loadBean($module);
 487        if(empty($bean) || is_null($bean))
 488        {
 489           return $name;
 490        }
 491
 492        $field_defs = $bean->field_defs;
 493        return isset($field_defs[$name]['name']) ? $field_defs[$name]['name'] : $name;
 494     }
 495
 496     /**
 497      * save
 498      *
 499      * This function says the field template by calling the DynamicField addFieldObject function.  It then
 500      * checks to see if updates are needed for the SearchFields.php file.  In the event that the unified_search
 501      * member variable is set to true, a search field definition is updated/created to the SearchFields.php file.
 502      *
 503      * @param $df Instance of DynamicField
 504      */
 505         function save($df){
 506                 //          $GLOBALS['log']->debug('saving field: '.print_r($this,true));
 507                 $df->addFieldObject($this);
 508
 509         require_once('modules/ModuleBuilder/parsers/parser.searchfields.php');
 510         $searchFieldParser = new ParserSearchFields( $df->getModuleName() , $df->getPackageName() ) ;
 511             //If unified_search is enabled for this field, then create the SearchFields entry
 512             $fieldName = $this->get_field_name($df->getModuleName(), $this->name);
 513         if($this->unified_search && !isset($searchFieldParser->searchFields[$df->getModuleName()][$fieldName]))
 514         {
 515            $searchFieldParser->addSearchField($fieldName, array('query_type'=>'default'));
 516            $searchFieldParser->saveSearchFields($searchFieldParser->searchFields);
 517         }
 518         }
 519
 520 }
 521
 522
 523 ?>