modules/ModuleBuilder/parsers/views/ListLayoutMetaDataParser.php

   1 <?php
   2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
   3 /*********************************************************************************
   4  * SugarCRM is a customer relationship management program developed by
   5  * SugarCRM, Inc. Copyright (C) 2004-2011 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
  39 require_once 'modules/ModuleBuilder/parsers/views/AbstractMetaDataParser.php' ;
  40 require_once 'modules/ModuleBuilder/parsers/views/MetaDataParserInterface.php' ;
  41
  42 class ListLayoutMetaDataParser extends AbstractMetaDataParser implements MetaDataParserInterface
  43 {
  44
  45     // Columns is used by the view to construct the listview - each column is built by calling the named function
  46     public $columns = array ( 'LBL_DEFAULT' => 'getDefaultFields' , 'LBL_AVAILABLE' => 'getAdditionalFields' , 'LBL_HIDDEN' => 'getAvailableFields' ) ;
  47     protected $labelIdentifier = 'label' ; // labels in the listviewdefs.php are tagged 'label' =>
  48     protected $allowParent = false;
  49
  50     /*
  51      * Simple function for array_udiff_assoc function call in getAvailableFields()
  52      */
  53     static function getArrayDiff ($one , $two)
  54     {
  55         $retArray = array();
  56         foreach($one as $key => $value)
  57         {
  58             if (!isset($two[$key]))
  59             {
  60                 $retArray[$key] = $value;
  61             }
  62         }
  63         return $retArray;
  64     }
  65
  66     /*
  67      * Constructor
  68      * @param string view          The view type, that is, editview, searchview etc
  69      * @param string moduleName     The name of the module to which this listview belongs
  70      * @param string packageName    If not empty, the name of the package to which this listview belongs
  71      */
  72     function __construct ($view , $moduleName , $packageName = '')
  73     {
  74         $GLOBALS [ 'log' ]->debug ( get_class ( $this ) . ": __construct()" ) ;
  75
  76         // BEGIN ASSERTIONS
  77         $views = array ( MB_LISTVIEW, MB_DASHLET, MB_DASHLETSEARCH, MB_POPUPLIST, MB_POPUPSEARCH ) ;
  78         if (! in_array ( $view , $views ) )
  79         {
  80             sugar_die ( "ListLayoutMetaDataParser: View $view is not supported" ) ;
  81         }
  82         // END ASSERTIONS
  83
  84         if (empty ( $packageName ))
  85         {
  86             require_once 'modules/ModuleBuilder/parsers/views/DeployedMetaDataImplementation.php' ;
  87             $this->implementation = new DeployedMetaDataImplementation ( $view, $moduleName ) ;
  88         } else
  89         {
  90             require_once 'modules/ModuleBuilder/parsers/views/UndeployedMetaDataImplementation.php' ;
  91             $this->implementation = new UndeployedMetaDataImplementation ( $view, $moduleName, $packageName ) ;
  92         }
  93         $this->view = $view;
  94
  95         $this->_fielddefs = $this->implementation->getFielddefs () ;
  96         $this->_standardizeFieldLabels( $this->_fielddefs );
  97         $this->_viewdefs = array_change_key_case ( $this->implementation->getViewdefs () ) ; // force to lower case so don't have problems with case mismatches later
  98
  99     }
 100
 101     /*
 102      * Deploy the layout
 103      * @param boolean $populate If true (default), then update the layout first with new layout information from the $_REQUEST array
 104      */
 105     function handleSave ($populate = true)
 106     {
 107         if ($populate)
 108             $this->_populateFromRequest () ;
 109         $this->implementation->deploy ( array_change_key_case ( $this->_viewdefs, CASE_UPPER ) ) ; // force the field names back to upper case so the list view will work correctly
 110     }
 111
 112     function getLayout ()
 113     {
 114         return $this->_viewdefs ;
 115     }
 116
 117     /**
 118      * Return a list of the default fields for a listview
 119      * @return array    List of default fields as an array, where key = value = <field name>
 120      */
 121     function getDefaultFields ()
 122     {
 123         $defaultFields = array ( ) ;
 124         foreach ( $this->_viewdefs as $key => $def )
 125         {
 126             // add in the default fields from the listviewdefs but hide fields disabled in the listviewdefs.
 127             if (! empty ( $def [ 'default' ] ) && (!isset($def['enabled']) || $def['enabled'] != false)
 128                 && (!isset($def [ 'studio' ]) || ($def [ 'studio' ] !== false && $def [ 'studio' ] != "false")))
 129             {
 130                 if (isset($this->_fielddefs [ $key ] )) {
 131                                         $defaultFields [ $key ] = self::_trimFieldDefs ( $this->_fielddefs [ $key ] ) ;
 132                                         if (!empty($def['label']))
 133                                            $defaultFields [ $key ]['label'] = $def['label'];
 134                 }
 135                                 else {
 136                                         $defaultFields [ $key ] = $def;
 137                                 }
 138             }
 139         }
 140
 141         return $defaultFields ;
 142     }
 143
 144     /**
 145      * Returns additional fields available for users to create fields
 146       @return array    List of additional fields as an array, where key = value = <field name>
 147      */
 148     function getAdditionalFields ()
 149     {
 150         $additionalFields = array ( ) ;
 151         foreach ( $this->_viewdefs as $key => $def )
 152         {
 153                 //#25322
 154                 if(strtolower ( $key ) == 'email_opt_out'){
 155                         continue;
 156                 }
 157
 158             if (empty ( $def [ 'default' ] ))
 159             {
 160                 if (isset($this->_fielddefs [ $key ] ))
 161                                         $additionalFields [ $key ] = self::_trimFieldDefs ( $this->_fielddefs [ $key ] ) ;
 162                                 else
 163                                         $additionalFields [ $key ] = $def;
 164             }
 165         }
 166         return $additionalFields ;
 167     }
 168
 169     /**
 170      * Returns unused fields that are available for use in either default or additional list views
 171      * @return array    List of available fields as an array, where key = value = <field name>
 172      */
 173     function getAvailableFields ()
 174     {
 175         $availableFields = array ( ) ;
 176         // Select available fields from the field definitions - don't need to worry about checking if ok to include as the Implementation has done that already in its constructor
 177         foreach ( $this->_fielddefs as $key => $def )
 178         {
 179             if ($this->isValidField($key, $def) && !isset($this->_viewdefs[$key]))
 180                     $availableFields [ $key ] = self::_trimFieldDefs( $this->_fielddefs [ $key ] ) ;
 181         }
 182         $origDefs = $this->getOriginalViewDefs();
 183         foreach($origDefs as $key => $def)
 184         {
 185                 if (!isset($this->_viewdefs[$key]) ||
 186                         (isset($this->_viewdefs[$key]['enabled']) && $this->_viewdefs[$key]['enabled'] == false))
 187                 $availableFields [ $key ] = $def;
 188         }
 189
 190         return $availableFields;
 191     }
 192
 193     public function isValidField($key, $def)
 194     {
 195         //Studio invisible fields should always be hidden
 196         if (! empty ($def[ 'studio' ] ) )
 197         {
 198             if (is_array($def [ 'studio' ]))
 199             {
 200                 if (isset($def [ 'studio' ]['listview'])) {
 201                     $lv = $def [ 'studio' ]['listview'];
 202                     return $lv !== false && (!is_string($lv) || $lv != 'false');
 203                 }
 204                 if (isset($def [ 'studio' ]['visible']))
 205                    return $def [ 'studio' ]['visible'];
 206             } else
 207             {
 208                 return ($def [ 'studio' ] != 'false' && $def [ 'studio' ] !== false && $def [ 'studio' ] != 'hidden') ;
 209             }
 210         }
 211
 212         //Bug 32520. We need to dissalow currency_id fields on list views.
 213         //This should be removed once array based studio definitions are in.
 214         if (isset($def['type']) && $def['type'] == "id" && $def['name'] == 'currency_id')
 215            return false;
 216
 217         //Check fields types
 218         if (isset($def['dbType']) && $def['dbType'] == "id")
 219         {
 220             return false;
 221         }
 222
 223         if (isset($def['type']))
 224         {
 225             if ($def['type'] == 'html' || ($def['type'] == 'parent' && !$this->allowParent)
 226              || $def['type'] == "id" || $def['type'] == "link" || $def['type'] == 'image')
 227                 return false;
 228         }
 229
 230         //hide currency_id, deleted, and _name fields by key-name
 231         if(strcmp ( $key, 'deleted' ) == 0 ) {
 232             return false;
 233         }
 234
 235         //if all the tests failed, the field is probably ok
 236         return true;
 237     }
 238
 239     protected function _populateFromRequest ()
 240     {
 241         $GLOBALS [ 'log' ]->debug ( get_class ( $this ) . "->populateFromRequest() - fielddefs = ".print_r($this->_fielddefs, true));
 242         // Transfer across any reserved fields, that is, any where studio !== true, which are not editable but must be preserved
 243         $newViewdefs = array ( ) ;
 244         $rejectTypes = array ( 'html'=>'html' , 'enum'=>'enum' , 'text'=>'text', 'encrypt'=>'encrypt' ) ;
 245
 246         $originalViewDefs = $this->getOriginalViewDefs();
 247
 248         foreach ( $this->_viewdefs as $key => $def )
 249         {
 250             //If the field is on the layout, but studio disabled, put it back on the layout at the front
 251                 if (isset ($def['studio']) && (
 252                         (is_array($def['studio']) && isset($def['studio']['listview']) &&
 253                         ($def['studio']['listview'] === false || strtolower($def['studio']['listview']) == 'false'
 254                         || strtolower($def['studio']['listview']) == 'required')
 255                 )
 256                         || (!is_array($def['studio']) &&
 257                                 ($def [ 'studio' ] === false || strtolower($def['studio']) == 'false' || strtolower($def['studio']) == 'required'))
 258                         ))
 259                 {
 260                 $newViewdefs [ $key ] = $def ;
 261                 }
 262         }
 263         // only take items from group_0 for searchviews (basic_search or advanced_search) and subpanels (which both are missing the Available column) - take group_0, _1 and _2 for all other list views
 264         $lastGroup = (isset ( $this->columns [ 'LBL_AVAILABLE' ] )) ? 2 : 1 ;
 265
 266         for ( $i = 0 ; isset ( $_POST [ 'group_' . $i ] ) && $i < $lastGroup ; $i ++ )
 267         {
 268             foreach ( $_POST [ 'group_' . $i ] as $fieldname )
 269             {
 270                 $fieldname = strtolower ( $fieldname ) ;
 271                 //Check if the field was previously on the layout
 272                 if (isset ($this->_viewdefs[$fieldname])) {
 273                         $newViewdefs [ $fieldname ] = $this->_viewdefs[$fieldname];
 274                    // print_r($this->_viewdefs[ $fieldname ]);
 275                                 }
 276                 //Next check if the original view def contained it
 277                 else if (isset($originalViewDefs[ $fieldname ]))
 278                 {
 279                         $newViewdefs [ $fieldname ] =  $originalViewDefs[ $fieldname ];
 280                 }
 281                 //create a definition from the fielddefs
 282                 else
 283                 {
 284                         // if we don't have a valid fieldname then just ignore it and move on...
 285                                         if ( ! isset ( $this->_fielddefs [ $fieldname ] ) )
 286                                                 continue ;
 287
 288                         $newViewdefs [ $fieldname ] = $this->_trimFieldDefs($this->_fielddefs [ $fieldname ]) ;
 289                     // sorting fields of certain types will cause a database engine problems
 290                         if ( isset($this->_fielddefs[$fieldname]['type']) &&
 291                                         isset ( $rejectTypes [ $this->_fielddefs [ $fieldname ] [ 'type' ] ] ))
 292                         {
 293                             $newViewdefs [ $fieldname ] [ 'sortable' ] = false ;
 294                         }
 295
 296                         // Bug 23728 - Make adding a currency type field default to setting the 'currency_format' to true
 297                         if (isset ( $this->_fielddefs [ $fieldname ] [ 'type' ]) && $this->_fielddefs [ $fieldname ] [ 'type' ] == 'currency')
 298                         {
 299                             $newViewdefs [ $fieldname ] [ 'currency_format' ] = true;
 300                         }
 301                 }
 302                 if (isset($newViewdefs [ $fieldname ]['enabled']))
 303                                 $newViewdefs [ $fieldname ]['enabled'] = true;
 304
 305                 if (isset ( $_REQUEST [ strtolower ( $fieldname ) . 'width' ] ))
 306                 {
 307                     $width = substr ( $_REQUEST [ $fieldname . 'width' ], 6, 3 ) ;
 308                     if (strpos ( $width, "%" ) != false)
 309                     {
 310                         $width = substr ( $width, 0, 2 ) ;
 311                     }
 312                                         if (!($width < 101 && $width > 0))
 313                     {
 314                         $width = 10;
 315                     }
 316                     $newViewdefs [ $fieldname ] [ 'width' ] = $width."%" ;
 317                 } else if (isset ( $this->_viewdefs [ $fieldname ] [ 'width' ] ))
 318                 {
 319                     $newViewdefs [ $fieldname ] [ 'width' ] = $this->_viewdefs [ $fieldname ] [ 'width' ] ;
 320                 }
 321                 else {
 322                         $newViewdefs [ $fieldname ] [ 'width' ] = "10%";
 323                 }
 324
 325                 $newViewdefs [ $fieldname ] [ 'default' ] = ($i == 0) ;
 326             }
 327         }
 328         $this->_viewdefs = $newViewdefs ;
 329
 330     }
 331
 332     /*
 333      * Remove all instances of a field from the layout
 334      * @param string $fieldName Name of the field to remove
 335      * @return boolean True if the field was removed; false otherwise
 336      */
 337     function removeField ($fieldName)
 338     {
 339         if (isset ( $this->_viewdefs [ $fieldName ] ))
 340         {
 341             unset( $this->_viewdefs [ $fieldName ] )  ;
 342             return true ;
 343         }
 344         return false ;
 345     }
 346
 347     function getOriginalViewDefs() {
 348         $defs = $this->implementation->getOriginalViewdefs ();
 349         $out = array();
 350         foreach ($defs as $field => $def)
 351         {
 352                 $out[strtolower($field)] = $def;
 353         }
 354
 355         return $out;
 356     }
 357
 358    static function _trimFieldDefs ( $def )
 359         {
 360                 if ( isset ( $def [ 'vname' ] ) )
 361                         $def [ 'label' ] = $def [ 'vname' ] ;
 362                 return array_intersect_key ( $def , array ( 'type' => true, 'studio' => true , 'label' => true , 'width' => true , 'sortable' => true , 'related_fields' => true , 'default' => true , 'link' => true , 'align' => true , 'orderBy' => true ,'hideLabel' => true, 'customLable' => true , 'currency_format' => true ) ) ;
 363         }
 364
 365 }