modules/ModuleBuilder/Module/StudioModule.php

   1 <?php
   2 /*********************************************************************************
   3  * SugarCRM Community Edition is a customer relationship management program developed by
   4  * SugarCRM, Inc. Copyright (C) 2004-2011 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
  38 require_once 'modules/ModuleBuilder/parsers/relationships/DeployedRelationships.php' ;
  39 require_once 'modules/ModuleBuilder/parsers/constants.php' ;
  40
  41 class StudioModule
  42 {
  43     public $name ;
  44     private $popups = array ( ) ;
  45     public $module ;
  46     public $fields ;
  47     public $seed;
  48
  49     function __construct ($module)
  50     {
  51                 $this->sources = array (        'editviewdefs.php' => array ( 'name' => translate ('LBL_EDITVIEW') , 'type' => MB_EDITVIEW , 'image' => 'EditView' ) ,
  52                                                                 'detailviewdefs.php' => array ( 'name' => translate('LBL_DETAILVIEW') , 'type' => MB_DETAILVIEW , 'image' => 'DetailView' ) ,
  53                                                                 'listviewdefs.php' => array ( 'name' => translate('LBL_LISTVIEW') , 'type' => MB_LISTVIEW , 'image' => 'ListView' ) ) ;
  54
  55         $moduleNames = array_change_key_case ( $GLOBALS [ 'app_list_strings' ] [ 'moduleList' ] ) ;
  56         $this->name = isset ( $moduleNames [ strtolower ( $module ) ] ) ? $moduleNames [ strtolower ( $module ) ] : strtolower ( $module ) ;
  57         $this->module = $module ;
  58         $this->seed = BeanFactory::getBean($this->module);
  59         $this->fields = $this->seed->field_defs ;
  60         //$GLOBALS['log']->debug ( get_class($this)."->__construct($module): ".print_r($this->fields,true) ) ;
  61     }
  62
  63      /*
  64      * Gets the name of this module. Some modules have naming inconsistencies such as Bug Tracker and Bugs which causes warnings in Relationships
  65      * Added to resolve bug #20257
  66      */
  67     function getModuleName()
  68     {
  69         $modules_with_odd_names = array(
  70         'Bug Tracker'=>'Bugs'
  71         );
  72         if ( isset ( $modules_with_odd_names [ $this->name ] ) )
  73                 return ( $modules_with_odd_names [ $this->name ] ) ;
  74
  75         return $this->name;
  76     }
  77
  78     /*
  79      * Attempt to determine the type of a module, for example 'basic' or 'company'
  80      * These types are defined by the SugarObject Templates in /include/SugarObjects/templates
  81      * Custom modules extend one of these standard SugarObject types, so the type can be determined from their parent
  82      * Standard module types can be determined simply from the module name - 'bugs' for example is of type 'issue'
  83          * If all else fails, fall back on type 'basic'...
  84          * @return string Module's type
  85      */
  86     function getType ()
  87     {
  88         // first, get a list of a possible parent types
  89         $templates = array () ;
  90         $d = dir ( 'include/SugarObjects/templates' ) ;
  91                 while ( $filename = $d->read() )
  92                 {
  93                         if ( substr($filename,0,1) != '.' )
  94                                 $templates [ strtolower ( $filename) ] = strtolower ( $filename ) ;
  95                 }
  96
  97                 // If a custom module, then its type is determined by the parent SugarObject that it extends
  98                 $type = $GLOBALS [ 'beanList' ] [ $this->module ] ;
  99         require_once $GLOBALS [ 'beanFiles' ] [ $type ] ;
 100
 101         do
 102         {
 103                 $seed = new $type () ;
 104                 $type = get_parent_class ($seed) ;
 105         } while ( ! in_array ( strtolower ( $type ) , $templates ) && $type != 'SugarBean' ) ;
 106
 107         if ( $type != 'SugarBean' )
 108         {
 109                 return strtolower ( $type ) ;
 110         }
 111
 112         // If a standard module then just look up its type - type is implicit for standard modules. Perhaps one day we will make it explicit, just as we have done for custom modules...
 113                 $types = array (
 114                 'Accounts' => 'company' ,
 115                 'Bugs' => 'issue' ,
 116                 'Cases' => 'issue' ,
 117                 'Contacts' => 'person' ,
 118                 'Documents' => 'file' ,
 119                 'Leads' => 'person' ,
 120                 'Opportunities' => 'sale'
 121                 ) ;
 122                 if ( isset ( $types [ $this->module ] ) )
 123                         return $types [ $this->module ] ;
 124
 125         return "basic" ;
 126     }
 127
 128     /*
 129      * Return the fields for this module as sourced from the SugarBean
 130      * @return  Array of fields
 131      */
 132
 133     function getFields ()
 134     {
 135         return $this->fields ;
 136     }
 137
 138     function getNodes ()
 139     {
 140         return array ( 'name' => $this->name , 'module' => $this->module , 'type' => 'StudioModule' , 'action' => "module=ModuleBuilder&action=wizard&view_module={$this->module}" , 'children' => $this->getModule() ) ;
 141     }
 142
 143     function getModule ()
 144     {
 145         $sources = array (      translate('LBL_LABELS') => array ( 'action' => "module=ModuleBuilder&action=editLabels&view_module={$this->module}" , 'imageTitle' => 'Labels' , 'help' => 'labelsBtn' ) ,
 146                                                 translate('LBL_FIELDS') => array ( 'action' => "module=ModuleBuilder&action=modulefields&view_package=studio&view_module={$this->module}" , 'imageTitle' => 'Fields' , 'help' => 'fieldsBtn'  ) ,
 147                                                 translate('LBL_RELATIONSHIPS') => array ( 'action' => "get_tpl=true&module=ModuleBuilder&action=relationships&view_module={$this->module}" , 'imageTitle' => 'Relationships' , 'help' => 'relationshipsBtn' ) ,
 148                                                 translate('LBL_LAYOUTS') => array ( 'children' => 'getLayouts' , 'action' => "module=ModuleBuilder&action=wizard&view=layouts&view_module={$this->module}" , 'imageTitle' => 'Layouts' , 'help' => 'layoutsBtn' ) ,
 149                                                 translate('LBL_SUBPANELS') => array ( 'children' => 'getSubpanels' , 'action' => "module=ModuleBuilder&action=wizard&view=subpanels&view_module={$this->module}" , 'imageTitle' => 'Subpanels' , 'help' => 'subpanelsBtn' ) ) ;
 150
 151         $nodes = array () ;
 152         foreach ( $sources as $source => $def )
 153         {
 154                 $nodes [ $source ] = $def ;
 155                 $nodes [ $source ] [ 'name' ] = translate ( $source ) ;
 156                 if ( isset ( $def [ 'children' ] ) )
 157                 {
 158                         $childNodes = $this->$def [ 'children' ] () ;
 159                         if ( !empty ( $childNodes ) )
 160                         {
 161                                 $nodes [ $source ] [ 'type' ] = 'Folder' ;
 162                                 $nodes [ $source ] [ 'children' ] = $childNodes ;
 163                         }
 164                         else
 165                                 unset ( $nodes [ $source ] ) ;
 166                 }
 167         }
 168
 169         return $nodes ;
 170     }
 171
 172     function getViews() {
 173         $views = array () ;
 174         foreach ( $this->sources as $file => $def )
 175         {
 176             if (file_exists ( "modules/{$this->module}/metadata/$file" ))
 177             {
 178                 $views [ str_replace ( '.php', '' , $file) ] = $def ;
 179             }
 180         }
 181         return $views;
 182     }
 183
 184     function getLayouts()
 185     {
 186         $views = $this->getViews();
 187
 188         // Now add in the QuickCreates - quickcreatedefs can be created by Studio from editviewdefs if they are absent, so just add them in regardless of whether the quickcreatedefs file exists
 189
 190         $hideQuickCreateForModules = array ( 'kbdocuments' , 'projecttask' ,
 191             'campaigns'
 192             ) ;
 193         // Some modules should not have a QuickCreate form at all, so do not add them to the list
 194         if (! in_array ( strtolower ( $this->module ), $hideQuickCreateForModules ))
 195             $views [ 'quickcreatedefs' ] = array ( 'name' => translate('LBL_QUICKCREATE') , 'type' => MB_QUICKCREATE , 'image' => 'QuickCreate' ) ;
 196
 197         $layouts = array ( ) ;
 198         foreach ( $views as $def )
 199         {
 200             $layouts [ $def['name'] ] = array ( 'name' => $def['name'] , 'action' => "module=ModuleBuilder&action=editLayout&view={$def['type']}&view_module={$this->module}" , 'imageTitle' => $def['image'] , 'help' => "viewBtn{$def['type']}" , 'size' => '48' ) ;
 201         }
 202
 203         if($this->isValidDashletModule($this->module)){
 204                         $dashlets = array( );
 205                 $dashlets [] = array('name' => translate('LBL_DASHLETLISTVIEW') , 'type' => 'dashlet' , 'action' => 'module=ModuleBuilder&action=editLayout&view=dashlet&view_module=' . $this->module );
 206                         $dashlets [] = array('name' => translate('LBL_DASHLETSEARCHVIEW') , 'type' => 'dashletsearch' , 'action' => 'module=ModuleBuilder&action=editLayout&view=dashletsearch&view_module=' . $this->module );
 207                         $layouts [ translate('LBL_DASHLET') ] = array ( 'name' => translate('LBL_DASHLET') , 'type' => 'Folder', 'children' => $dashlets,  'imageTitle' => 'Dashlet',  'action' => 'module=ModuleBuilder&action=wizard&view=dashlet&view_module=' . $this->module);
 208         }
 209
 210         //For popup tree node
 211         $popups = array( );
 212         $popups [] = array('name' => translate('LBL_POPUPLISTVIEW') , 'type' => 'popuplistview' , 'action' => 'module=ModuleBuilder&action=editLayout&view=popuplist&view_module=' . $this->module );
 213                 $popups [] = array('name' => translate('LBL_POPUPSEARCH') , 'type' => 'popupsearch' , 'action' => 'module=ModuleBuilder&action=editLayout&view=popupsearch&view_module=' . $this->module );
 214                 $layouts [ translate('LBL_POPUP') ] = array ( 'name' => translate('LBL_POPUP') , 'type' => 'Folder', 'children' => $popups, 'imageTitle' => 'Popup',  'imageName' => 'icon_Popup.gif', 'action' => 'module=ModuleBuilder&action=wizard&view=popup&view_module=' . $this->module);
 215
 216         $nodes = $this->getSearch () ;
 217         if ( !empty ( $nodes ) )
 218         {
 219                 $layouts [ translate('LBL_SEARCH') ] = array ( 'name' => translate('LBL_SEARCH') , 'type' => 'Folder' , 'children' => $nodes , 'action' => "module=ModuleBuilder&action=wizard&view=search&view_module={$this->module}" , 'imageTitle' => 'BasicSearch' , 'help' => 'searchBtn' , 'size' => '48') ;
 220         }
 221
 222         return $layouts ;
 223
 224     }
 225
 226         function isValidDashletModule($moduleName){
 227                 $fileName = "My{$moduleName}Dashlet";
 228                 $customFileName = "{$moduleName}Dashlet";
 229                 if (file_exists ( "modules/{$moduleName}/Dashlets/{$fileName}/{$fileName}.php" )
 230                         || file_exists ( "custom/modules/{$moduleName}/Dashlets/{$fileName}/{$fileName}.php" )
 231                         || file_exists ( "modules/{$moduleName}/Dashlets/{$customFileName}/{$customFileName}.php" )
 232                         || file_exists ( "custom/modules/{$moduleName}/Dashlets/{$customFileName}/{$customFileName}.php" ))
 233         {
 234                 return true;
 235         }
 236         return false;
 237         }
 238
 239
 240     function getSearch ()
 241     {
 242                 require_once ('modules/ModuleBuilder/parsers/views/SearchViewMetaDataParser.php') ;
 243
 244                 $nodes = array () ;
 245         foreach ( array ( MB_BASICSEARCH => 'LBL_BASIC_SEARCH' , MB_ADVANCEDSEARCH => 'LBL_ADVANCED_SEARCH' ) as $view => $label )
 246         {
 247                 try
 248                 {
 249                         $parser = new SearchViewMetaDataParser ( $view , $this->module ) ;
 250                         $title = translate ( $label ) ;
 251                         if($label == 'LBL_BASIC_SEARCH'){
 252                                         $name = 'BasicSearch';
 253                                 }elseif($label == 'LBL_ADVANCED_SEARCH'){
 254                                         $name = 'AdvancedSearch';
 255                                 }else{
 256                                         $name = str_replace ( ' ', '', $title ) ;
 257                                 }
 258                 $nodes [ $title ] = array ( 'name' => $title , 'action' => "module=ModuleBuilder&action=editLayout&view={$view}&view_module={$this->module}" , 'imageTitle' => $title , 'imageName' => $name , 'help' => "{$name}Btn" , 'size' => '48' ) ;
 259                 }
 260                 catch ( Exception $e )
 261                 {
 262                         $GLOBALS [ 'log' ]->info( 'No search layout : '. $e->getMessage() ) ;
 263                 }
 264         }
 265
 266         return $nodes ;
 267     }
 268
 269     /*
 270      * Return an object containing all the relationships participated in by this module
 271      * @return AbstractRelationships Set of relationships
 272      */
 273     function getRelationships ()
 274     {
 275         return new DeployedRelationships ( $this->module ) ;
 276     }
 277
 278
 279     /**
 280      * Gets a list of subpanels used by the current module
 281      */
 282     function getSubpanels ()
 283     {
 284         if(!empty($GLOBALS['current_user']) && empty($GLOBALS['modListHeader']))
 285             $GLOBALS['modListHeader'] = query_module_access_list($GLOBALS['current_user']);
 286
 287         require_once ('include/SubPanel/SubPanel.php') ;
 288
 289         $nodes = array ( ) ;
 290
 291             $GLOBALS [ 'log' ]->debug ( "StudioModule->getSubpanels(): getting subpanels for " . $this->module ) ;
 292
 293             foreach ( SubPanel::getModuleSubpanels ( $this->module ) as $name => $label )
 294             {
 295                 if ($name == 'users')
 296                     continue ;
 297                 $subname = sugar_ucfirst ( (! empty ( $label )) ? translate ( $label, $this->module ) : $name ) ;
 298                 $nodes [ $subname ] = array (
 299                         'name' => $name ,
 300                         'label' => $subname ,
 301                         'action' => "module=ModuleBuilder&action=editLayout&view=ListView&view_module={$this->module}&subpanel={$name}&subpanelLabel={$subname}" ,
 302                         'imageTitle' => $subname ,
 303                         'imageName' => 'icon_' . ucfirst($name) . '_32',
 304                         'altImageName' => 'Subpanels',
 305                         'size' => '48'
 306                 ) ;
 307             }
 308
 309         return $nodes ;
 310
 311     }
 312
 313     /**
 314      * gets a list of subpanels provided to other modules
 315      *
 316      *
 317      */
 318     function getProvidedSubpanels ()
 319     {
 320         require_once 'modules/ModuleBuilder/parsers/relationships/AbstractRelationships.php' ;
 321         $this->providedSubpanels = array () ;
 322         $subpanelDir = 'modules/' . $this->module . '/metadata/subpanels/' ;
 323         foreach(array($subpanelDir, "custom/$subpanelDir") as $dir)
 324         {
 325                 if (is_dir ( $dir ))
 326                 {
 327                     foreach(scandir($dir) as $fileName)
 328                     {
 329                         // sanity check to confirm that this is a usable subpanel...
 330                         if (substr ( $fileName, 0, 1 ) != '.' && substr ( strtolower($fileName), -4 ) == ".php"
 331                                 && AbstractRelationships::validSubpanel ( "$dir/$fileName" ))
 332                         {
 333                             $subname = str_replace ( '.php', '', $fileName ) ;
 334                             $this->providedSubpanels [ $subname ] = $subname ;
 335                         }
 336                     }
 337                 }
 338         }
 339
 340                 return $this->providedSubpanels;
 341     }
 342
 343
 344     function getParentModulesOfSubpanel($subpanel){
 345         global $moduleList, $beanFiles, $beanList, $module;
 346
 347         //use tab controller function to get module list with named keys
 348         require_once("modules/MySettings/TabController.php");
 349         require_once("include/SubPanel/SubPanelDefinitions.php");
 350         $modules_to_check = TabController::get_key_array($moduleList);
 351
 352         //change case to match subpanel processing later on
 353         $modules_to_check = array_change_key_case($modules_to_check);
 354
 355         $spd = '';
 356         $spd_arr = array();
 357         //iterate through modules and build subpanel array
 358         foreach($modules_to_check as $mod_name){
 359
 360             //skip if module name is not in bean list, otherwise get the bean class name
 361             if(!isset($beanList[$mod_name])) continue;
 362             $class = $beanList[$mod_name];
 363
 364             //skip if class name is not in file list, otherwise require the bean file and create new class
 365             if(!isset($beanFiles[$class]) || !file_exists($beanFiles[$class])) continue;
 366
 367             //retrieve subpanels for this bean
 368             require_once($beanFiles[$class]);
 369             $bean_class = new $class();
 370
 371             //create new subpanel definition instance and get list of tabs
 372             $spd = new SubPanelDefinitions($bean_class) ;
 373             if ( isset($spd->layout_defs['subpanel_setup'][strtolower($subpanel)]['module']) ){
 374                 $spd_arr[] = $mod_name;
 375             }
 376         }
 377         return  $spd_arr;
 378     }
 379
 380     function removeFieldFromLayouts ( $fieldName )
 381     {
 382         require_once("modules/ModuleBuilder/parsers/ParserFactory.php");
 383         $GLOBALS [ 'log' ]->info ( get_class ( $this ) . "->removeFieldFromLayouts($fieldName)" ) ;
 384         $sources = $this->getViewMetadataSources();
 385         $sources[] = array('type'  => MB_BASICSEARCH);
 386         $sources[] = array('type'  => MB_ADVANCEDSEARCH);
 387
 388         $GLOBALS [ 'log' ]->debug ( print_r( $sources,true) ) ;
 389         foreach ( $sources as $name => $defs )
 390         {
 391             //If this module type doesn't support a given metadata type, we will get an exception from getParser()
 392             try {
 393                 $parser = ParserFactory::getParser( $defs [ 'type' ] , $this->module ) ;
 394                 if ($parser->removeField ( $fieldName ) )
 395                     $parser->handleSave(false) ; // don't populate from $_REQUEST, just save as is...
 396             } catch(Exception $e){}
 397         }
 398
 399         //Remove the fields in subpanel
 400         $data = $this->getParentModulesOfSubpanel($this->module);
 401         foreach($data as $parentModule){
 402             //If this module type doesn't support a given metadata type, we will get an exception from getParser()
 403             try {
 404                 $parser = ParserFactory::getParser( MB_LISTVIEW , $parentModule, null ,  $this->module) ;
 405                 if ($parser->removeField ( $fieldName ) )
 406                     $parser->handleSave(false) ;
 407             } catch(Exception $e){}
 408         }
 409     }
 410
 411
 412
 413         public function getViewMetadataSources() {
 414                 $sources = $this->getViews();
 415         $sources[] = array('type'  => MB_BASICSEARCH);
 416         $sources[] = array('type'  => MB_ADVANCEDSEARCH);
 417         $sources[] = array('type'  => MB_DASHLET);
 418         $sources[] = array('type'  => MB_DASHLETSEARCH);
 419         $sources[] = array('type'  => MB_POPUPLIST);
 420         $sources[] = array('type'  => MB_QUICKCREATE);
 421
 422                 return $sources;
 423         }
 424
 425
 426
 427 }
 428 ?>