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