modules/ModuleBuilder/views/view.modulefield.php

   1 <?php
   2 /*********************************************************************************
   3  * SugarCRM Community Edition is a customer relationship management program developed by
   4  * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
   5  *
   6  * This program is free software; you can redistribute it and/or modify it under
   7  * the terms of the GNU Affero General Public License version 3 as published by the
   8  * Free Software Foundation with the addition of the following permission added
   9  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  10  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  11  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU Affero General Public License along with
  19  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  20  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21  * 02110-1301 USA.
  22  *
  23  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  24  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  25  *
  26  * The interactive user interfaces in modified source and object code versions
  27  * of this program must display Appropriate Legal Notices, as required under
  28  * Section 5 of the GNU Affero General Public License version 3.
  29  *
  30  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  31  * these Appropriate Legal Notices must retain the display of the "Powered by
  32  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  33  * technical reasons, the Appropriate Legal Notices must display the words
  34  * "Powered by SugarCRM".
  35  ********************************************************************************/
  36
  37 require_once('modules/ModuleBuilder/MB/AjaxCompose.php');
  38 require_once('modules/DynamicFields/FieldViewer.php');
  39
  40 class ViewModulefield extends SugarView
  41 {
  42     /**
  43          * @see SugarView::_getModuleTitleParams()
  44          */
  45         protected function _getModuleTitleParams($browserTitle = false)
  46         {
  47             global $mod_strings;
  48
  49         return array(
  50            translate('LBL_MODULE_NAME','Administration'),
  51            ModuleBuilderController::getModuleTitle(),
  52            );
  53     }
  54
  55         function display()
  56         {
  57         $ac = $this->fetch();
  58         echo $ac->getJavascript();
  59     }
  60
  61     function fetch(
  62         $ac = false
  63         )
  64     {
  65         $fv = new FieldViewer();
  66         if(empty($_REQUEST['field'])&& !empty($_REQUEST['name']))$_REQUEST['field'] = $_REQUEST['name'];
  67         $field_name = '';
  68         if(!empty($this->view_object_map['field_name']))
  69             $field_name = $this->view_object_map['field_name'];
  70         elseif(!empty($_REQUEST['field']))
  71             $field_name = $_REQUEST['field'];
  72         else
  73             $field_name = '';
  74
  75         $action = 'saveField'; // tyoung bug 17606: default action is to save as a dynamic field; but for standard OOB
  76                                // fields we override this so don't create a new dynamic field instead of updating the existing field
  77
  78         $isClone = false;
  79         if(!empty($this->view_object_map['is_clone']) && $this->view_object_map['is_clone']
  80             && (strcmp($field_name, "name") != 0)   // bug #35767, do not allow cloning of name field
  81             )
  82             $isClone = true;
  83                 /*
  84                 $field_types =  array('varchar'=>'YourField', 'int'=>'Integer', 'float'=>'Decimal','bool'=>'Checkbox','enum'=>'DropDown',
  85                                 'date'=>'Date', 'phone' => 'Phone', 'currency' => 'Currency', 'html' => 'HTML', 'radioenum' => 'Radio',
  86                                 'relate' => 'Relate', 'address' => 'Address', 'text' => 'TextArea', 'url' => 'Link');
  87                 */
  88                 $field_types = $GLOBALS['mod_strings']['fieldTypes'];
  89                 if (isset($field_types['encrypt']))
  90                   unset($field_types['encrypt']);
  91         $field_name_exceptions = array(
  92             //bug 22264: Field name must not be an SQL keyword.
  93             //Taken from SQL Server's list of reserved keywords; http://msdn.microsoft.com/en-us/library/aa238507(SQL.80).aspx
  94             'ADD','EXCEPT','PERCENT','ALL','EXEC','PLAN','ALTER','EXECUTE','PRECISION','AND','EXISTS','PRIMARY',
  95             'ANY','EXIT','PRINT','AS','FETCH','PROC','ASC','FILE','PROCEDURE','AUTHORIZATION','FILLFACTOR','PUBLIC',
  96             'BACKUP','FOR','RAISERROR','BEGIN','FOREIGN','READ','BETWEEN','FREETEXT','READTEXT','BREAK','FREETEXTTABLE',
  97             'RECONFIGURE','BROWSE','FROM','REFERENCES','BULK','FULL','REPLICATION','BY','FUNCTION','RESTORE',
  98             'CASCADE','GOTO','RESTRICT','CASE','GRANT','RETURN','CHECK','GROUP','REVOKE','CHECKPOINT','HAVING','RIGHT','CLOSE',
  99             'HOLDLOCK','ROLLBACK','CLUSTERED','IDENTITY','ROWCOUNT','COALESCE','IDENTITY_INSERT','ROWGUIDCOL','COLLATE','IDENTITYCOL',
 100             'RULE','COLUMN','IF','SAVE','COMMIT','IN','SCHEMA','COMPUTE','INDEX','SELECT','CONSTRAINT','INNER','SESSION_USER',
 101             'CONTAINS','INSERT','SET','CONTAINSTABLE','INTERSECT','SETUSER','CONTINUE','INTO','SHUTDOWN','CONVERT','IS','SOME',
 102             'CREATE','JOIN','STATISTICS','CROSS','KEY','SYSTEM_USER','CURRENT','KILL','TABLE','CURRENT_DATE','LEFT','TEXTSIZE',
 103             'CURRENT_TIME','LIKE','THEN','CURRENT_TIMESTAMP','LINENO','TO','CURRENT_USER','LOAD','TOP','CURSOR','NATIONAL','TRAN',
 104             'DATABASE','NOCHECK','TRANSACTION','DBCC','NONCLUSTERED','TRIGGER','DEALLOCATE','NOT','TRUNCATE','DECLARE','NULL','TSEQUAL',
 105             'DEFAULT','NULLIF','UNION','DELETE','OF','UNIQUE','DENY','OFF','UPDATE','DESC','OFFSETS','UPDATETEXT',
 106             'DISK','ON','USE','DISTINCT','OPEN','USER','DISTRIBUTED','OPENCONNECTOR','VALUES','DOUBLE','OPENQUERY','VARYING',
 107             'DROP','OPENROWSET','VIEW','DUMMY','OPENXML','WAITFOR','DUMP','OPTION','WHEN','ELSE','OR','WHERE',
 108             'END','ORDER','WHILE','ERRLVL','OUTER','WITH','ESCAPE','OVER','WRITETEXT',
 109             //Mysql Keywords from http://dev.mysql.com/doc/refman/5.0/en/reserved-words.html (those not in MSSQL's list)
 110                         'ANALYZE', 'ASENSITIVE', 'BEFORE', 'BIGINT', 'BINARY', 'BOTH', 'CALL', 'CHANGE', 'CHARACTER',
 111                         'CONDITION', 'DATABASES', 'DAY_HOUR', 'DAY_MICROSECOND', 'DAY_MINUTE', 'DAY_SECOND', 'DEC', 'DECIMAL', 'DELAYED',
 112                         'DESCRIBE', 'DETERMINISTIC', 'DISTINCTROW', 'DIV', 'DUAL', 'EACH', 'ELSEIF', 'ENCLOSED', 'ESCAPED', 'EXPLAIN',
 113                         'FALSE', 'FLOAT', 'FLOAT4', 'FLOAT8', 'FORCE', 'FULLTEXT', 'HIGH_PRIORITY', 'HOUR_MICROSECOND', 'HOUR_MINUTE',
 114                         'HOUR_SECOND', 'IGNORE', 'INFILE', 'INOUT', 'INSENSITIVE', 'INT', 'INT1', 'INT2', 'INT3', 'INT4', 'INT8',
 115                         'INTEGER', 'ITERATE', 'KEYS', 'LEADING', 'LEAVE', 'LIMIT', 'LINES', 'LOCALTIME', 'LOCALTIMESTAMP', 'LOCK',
 116                         'LONGBLOB', 'LONGTEXT', 'LOOP', 'LOW_PRIORITY', 'MATCH', 'MEDIUMBLOB', 'MEDIUMINT', 'MEDIUMTEXT', 'MIDDLEINT',
 117                         'MINUTE_MICROSECOND', 'MINUTE_SECOND', 'MOD', 'MODIFIES', 'NATURAL', 'NO_WRITE_TO_BINLOG', 'NUMERIC', 'OPTIMIZE',
 118                         'OPTIONALLY', 'OUT', 'OUTFILE', 'PURGE', 'READS', 'REAL', 'REGEXP', 'RELEASE', 'RENAME', 'REPEAT', 'REPLACE',
 119                         'REQUIRE', 'RLIKE', 'SCHEMAS', 'SECOND_MICROSECOND', 'SENSITIVE', 'SEPARATOR', 'SHOW', 'SMALLINT', 'SONAME',
 120                         'SPATIAL', 'SPECIFIC', 'SQL', 'SQLEXCEPTION', 'SQLSTATE', 'SQLWARNING', 'SQL_BIG_RESULT', 'SQL_CALC_FOUND_ROWS',
 121                         'SQL_SMALL_RESULT', 'SSL', 'STARTING', 'STRAIGHT_JOIN', 'TERMINATED', 'TINYBLOB', 'TINYINT', 'TINYTEXT',
 122                         'TRAILING', 'TRUE', 'UNDO', 'UNLOCK', 'UNSIGNED', 'USAGE', 'USING', 'UTC_DATE', 'UTC_TIME', 'UTC_TIMESTAMP',
 123                         'VARBINARY', 'VARCHARACTER', 'WRITE', 'XOR', 'YEAR_MONTH', 'ZEROFILL', 'CONNECTION', 'LABEL', 'UPGRADE',
 124                         //Oracle datatypes
 125             'DATE','VARCHAR','VARCHAR2','NVARCHAR2','CHAR','NCHAR','NUMBER','PLS_INTEGER','BINARY_INTEGER','LONG','TIMESTAMP',
 126                         'INTERVAL','RAW','ROWID','UROWID','MLSLABEL','CLOB','NCLOB','BLOB','BFILE','XMLTYPE',
 127                         //SugarCRM reserved
 128                 'ID', 'ID_C', 'PARENT_NAME', 'PARENT_ID',
 129                         );
 130
 131
 132         //C.L. - Add support to mark related module id columns as reserved keywords
 133         require_once 'modules/ModuleBuilder/parsers/relationships/DeployedRelationships.php';
 134         $relatedModules = array_keys(DeployedRelationships::findRelatableModules()) ;
 135         global $beanList, $current_language;
 136         foreach($relatedModules as $relModule)
 137         {
 138             if(isset($beanList[$relModule]))
 139             {
 140                 $field_name_exceptions[] = strtoupper($beanList[$relModule]) . '_ID';
 141             }
 142         }
 143
 144         if(empty($_REQUEST['view_package']) || $_REQUEST['view_package'] == 'studio') {
 145             $moduleName = $_REQUEST['view_module'];
 146             $objectName = BeanFactory::getObjectName($moduleName);
 147             $module = BeanFactory::getBean($moduleName);
 148
 149             VardefManager::loadVardef($moduleName, $objectName,true);
 150             global $dictionary;
 151             $module->mbvardefs->vardefs =  $dictionary[$objectName];
 152
 153             $module->name = $moduleName;
 154             if(!$ac){
 155                 $ac = new AjaxCompose();
 156             }
 157             $vardef = (!empty($module->mbvardefs->vardefs['fields'][$field_name]))? $module->mbvardefs->vardefs['fields'][$field_name]: array();
 158             if($isClone){
 159                 unset($vardef['name']);
 160             }
 161
 162             if(empty($vardef['name'])){
 163                 if(!empty($_REQUEST['type']))
 164                     $vardef['type'] = $_REQUEST['type'];
 165                     $fv->ss->assign('hideLevel', 0);
 166             }elseif(isset($vardef['custom_module'])){
 167                 $fv->ss->assign('hideLevel', 2);
 168             }else{
 169                 $action = 'saveSugarField'; // tyoung - for OOB fields we currently only support modifying the label
 170                 $fv->ss->assign('hideLevel', 3);
 171             }
 172             if($isClone && isset($vardef['type']) && $vardef['type'] == 'datetime'){
 173                 $vardef['type'] = 'datetimecombo';
 174             }
 175
 176                         require_once ('modules/DynamicFields/FieldCases.php') ;
 177             $tf = get_widget ( empty($vardef [ 'type' ]) ?  "" : $vardef [ 'type' ]) ;
 178             $tf->module = $module;
 179             $tf->populateFromRow($vardef);
 180                         $vardef = array_merge($vardef, $tf->get_field_def());
 181
 182             //          $GLOBALS['log']->debug('vardefs after loading = '.print_r($vardef,true));
 183
 184
 185             //Check if autoincrement fields are allowed
 186             $allowAutoInc = true;
 187             $enumFields = array();
 188             foreach($module->field_defs as $field => $def)
 189             {
 190                 if (!empty($def['type']) && $def['type'] == "int" && !empty($def['auto_increment'])) {
 191                    $allowAutoInc = false;
 192                    continue;
 193                 }
 194                 if (!empty($def['type']) && $def['type'] == "enum" && $field != $vardef['name'])
 195                 {
 196                     if(!empty($def['studio']) && $def['studio'] == "false") continue; //bug51866
 197                     $enumFields[$field] = translate($def['vname'], $moduleName);
 198                     if (substr($enumFields[$field], -1) == ":")
 199                         $enumFields[$field] = substr($enumFields[$field], 0, strlen($enumFields[$field]) - 1);
 200                 }
 201             }
 202             $fv->ss->assign( 'allowAutoInc', $allowAutoInc);
 203
 204             $GLOBALS['log']->warn('view.modulefield: hidelevel '.$fv->ss->get_template_vars('hideLevel')." ".print_r($vardef,true));
 205             if(!empty($vardef['vname'])){
 206                 $fv->ss->assign('lbl_value', htmlentities(translate($vardef['vname'], $moduleName), ENT_QUOTES, 'UTF-8'));
 207             }
 208             $fv->ss->assign('module', $module);
 209             if(empty($module->mbvardefs->vardefs['fields']['parent_name']) || (isset($vardef['type']) && $vardef['type'] == 'parent'))
 210                                 $field_types['parent'] = $GLOBALS['mod_strings']['parent'];
 211
 212             $edit_or_add = 'editField' ;
 213
 214         } else
 215         {
 216             require_once('modules/ModuleBuilder/MB/ModuleBuilder.php');
 217             $mb = new ModuleBuilder();
 218             $moduleName = $_REQUEST['view_module'];
 219             $module =& $mb->getPackageModule($_REQUEST['view_package'], $moduleName);
 220             $package =& $mb->packages[$_REQUEST['view_package']];
 221             $module->getVardefs();
 222             if(!$ac){
 223                 $ac = new AjaxCompose();
 224             }
 225             $vardef = (!empty($module->mbvardefs->vardefs['fields'][$field_name]))? $module->mbvardefs->vardefs['fields'][$field_name]: array();
 226
 227             if($isClone){
 228                 unset($vardef['name']);
 229             }
 230
 231             if(empty($vardef['name'])){
 232                 if(!empty($_REQUEST['type']))$vardef['type'] = $_REQUEST['type'];
 233                     $fv->ss->assign('hideLevel', 0);
 234             }else{
 235                 if(!empty($module->mbvardefs->vardef['fields'][$vardef['name']])){
 236                     $fv->ss->assign('hideLevel', 1);
 237                 }elseif(isset($vardef['custom_module'])){
 238                     $fv->ss->assign('hideLevel', 2);
 239                 }else{
 240                     $fv->ss->assign('hideLevel', 3); // tyoung bug 17350 - effectively mark template derived fields as readonly
 241                 }
 242             }
 243
 244                         require_once ('modules/DynamicFields/FieldCases.php') ;
 245             $tf = get_widget ( empty($vardef [ 'type' ]) ?  "" : $vardef [ 'type' ]) ;
 246             $tf->module = $module;
 247             $tf->populateFromRow($vardef);
 248             $vardef = array_merge($vardef, $tf->get_field_def());
 249
 250
 251
 252             $fv->ss->assign('module', $module);
 253             $fv->ss->assign('package', $package);
 254             $fv->ss->assign('MB','1');
 255
 256             if(isset($vardef['vname']))
 257                 $fv->ss->assign('lbl_value', htmlentities($module->getLabel('en_us',$vardef['vname']), ENT_QUOTES, 'UTF-8'));
 258                         if(empty($module->mbvardefs->vardefs['fields']['parent_name']) || (isset($vardef['type']) && $vardef['type'] == 'parent'))
 259                                 $field_types['parent'] = $GLOBALS['mod_strings']['parent'];
 260
 261             $enumFields = array();
 262             if (!empty($module->mbvardefs->vardefs['fields']))
 263             {
 264                 foreach($module->mbvardefs->vardefs['fields'] as $field => $def)
 265                 {
 266                     if (!empty($def['type']) && $def['type'] == "enum" && $field != $vardef['name'])
 267                     {
 268                         $enumFields[$field] = isset($module->mblanguage->strings[$current_language][$def['vname']]) ?
 269                             $this->mbModule->mblanguage->strings[$current_language][$def['vname']] : translate($field);
 270                         if (substr($enumFields[$field], -1) == ":")
 271                             $enumFields[$field] = substr($enumFields[$field], 0, strlen($enumFields[$field]) -1);
 272                     }
 273                 }
 274             }
 275
 276             $edit_or_add = 'mbeditField';
 277         }
 278
 279         if($_REQUEST['action'] == 'RefreshField'){
 280                 require_once('modules/DynamicFields/FieldCases.php');
 281             $field = get_widget($_POST['type']);
 282             $field->populateFromPost();
 283             $vardef = $field->get_field_def();
 284             $vardef['options'] = $_REQUEST['new_dropdown'];
 285             $fv->ss->assign('lbl_value', htmlentities($_REQUEST['labelValue'], ENT_QUOTES, 'UTF-8'));
 286         }
 287
 288         foreach(array("formula", "default", "comments", "help", "visiblityGrid") as $toEscape)
 289                 {
 290                         if (!empty($vardef[$toEscape]) && is_string($vardef[$toEscape])) {
 291                         $vardef[$toEscape] = htmlentities($vardef[$toEscape], ENT_QUOTES, 'UTF-8');
 292                 }
 293                 }
 294
 295         if((!empty($vardef['studio']) && is_array($vardef['studio']) && !empty($vardef['studio']['no_duplicate']) && $vardef['studio']['no_duplicate'] == true)
 296            || (strcmp($field_name, "name") == 0) || (isset($vardef['type']) && $vardef['type'] == 'name')) // bug #35767, do not allow cloning of name field
 297             {
 298                $fv->ss->assign('no_duplicate', true);
 299             }
 300
 301         $fv->ss->assign('action',$action);
 302         $fv->ss->assign('isClone', ($isClone ? 1 : 0));
 303         $fv->ss->assign("module_dd_fields", $enumFields);
 304         $json = getJSONobj();
 305
 306         $fv->ss->assign('field_name_exceptions', $json->encode($field_name_exceptions));
 307         ksort($field_types);
 308         $fv->ss->assign('field_types',$field_types);
 309
 310
 311         $fv->ss->assign('importable_options', $GLOBALS['app_list_strings']['custom_fields_importable_dom']);
 312         $fv->ss->assign('duplicate_merge_options', $GLOBALS['app_list_strings']['custom_fields_merge_dup_dom']);
 313
 314         $triggers = array () ;
 315         $existing_field_names = array () ;
 316         foreach ( $module->mbvardefs->vardefs['fields'] as $field )
 317         {
 318                 if ($field [ 'type' ] == 'enum' || $field [ 'type'] == 'multienum' )
 319                 {
 320                         $triggers [] = $field [ 'name' ] ;
 321                 }
 322
 323                 if (!isset($field['source']) || $field['source'] != 'non-db') {
 324                         if(preg_match('/^(.*?)(_c)?$/', $field['name'], $matches))
 325                         {
 326                                 $existing_field_names [] = strtoupper($matches[1]);
 327                         }
 328                 }
 329         }
 330
 331         $fv->ss->assign('triggers',$triggers);
 332         $fv->ss->assign('existing_field_names', $json->encode($existing_field_names));
 333         $fv->ss->assign('mod_strings',$GLOBALS['mod_strings']);
 334
 335                 // jchi #24880
 336                 // end
 337
 338
 339         $layout = $fv->getLayout($vardef);
 340
 341         $fv->ss->assign('fieldLayout', $layout);
 342         if(empty($vardef['type']))
 343         {
 344             $vardef['type'] = 'varchar';
 345         }
 346
 347         $fv->ss->assign('vardef', $vardef);
 348
 349         if(empty($_REQUEST['field'])){
 350             $edit_or_add = 'addField';
 351         }
 352
 353         $fv->ss->assign('help_group', $edit_or_add);
 354         $body = $this->fetchTemplate($fv, 'modules/ModuleBuilder/tpls/MBModule/field.tpl');
 355         $ac->addSection('east', translate('LBL_SECTION_FIELDEDITOR','ModuleBuilder'), $body );
 356         return $ac;
 357     }
 358
 359     /**
 360      * fetchTemplate
 361      * This function overrides fetchTemplate from SugarView.  For view.modulefield.php we go through the FieldViewer
 362      * class to fetch the display contents.
 363      *
 364      * @param FieldViewer $mixed the FieldViewer instance
 365      * @param string $template the file to fetch
 366      * @return string contents from calling the fetch method on the FieldViewer Sugar_Smarty instance
 367      */
 368     protected function fetchTemplate($fv, $template)
 369     {
 370         return $fv->ss->fetch($this->getCustomFilePathIfExists($template));
 371     }
 372 }