2 /*********************************************************************************
3 * SugarCRM is a customer relationship management program developed by
4 * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
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.
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
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
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.
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.
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 ********************************************************************************/
38 require_once 'modules/ModuleBuilder/parsers/relationships/DeployedRelationships.php' ;
39 require_once 'modules/ModuleBuilder/parsers/constants.php' ;
44 private $popups = array ( ) ;
49 function __construct ($module)
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' ) ) ;
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 $class = $GLOBALS [ 'beanList' ] [ $this->module ] ;
59 require_once $GLOBALS [ 'beanFiles' ] [ $class ] ;
60 $this->seed = new $class ( ) ;
61 $this->fields = $this->seed->field_defs ;
62 //$GLOBALS['log']->debug ( get_class($this)."->__construct($module): ".print_r($this->fields,true) ) ;
66 * Gets the name of this module. Some modules have naming inconsistencies such as Bug Tracker and Bugs which causes warnings in Relationships
67 * Added to resolve bug #20257
69 function getModuleName()
71 $modules_with_odd_names = array(
74 if ( isset ( $modules_with_odd_names [ $this->name ] ) )
75 return ( $modules_with_odd_names [ $this->name ] ) ;
81 * Attempt to determine the type of a module, for example 'basic' or 'company'
82 * These types are defined by the SugarObject Templates in /include/SugarObjects/templates
83 * Custom modules extend one of these standard SugarObject types, so the type can be determined from their parent
84 * Standard module types can be determined simply from the module name - 'bugs' for example is of type 'issue'
85 * If all else fails, fall back on type 'basic'...
86 * @return string Module's type
90 // first, get a list of a possible parent types
91 $templates = array () ;
92 $d = dir ( 'include/SugarObjects/templates' ) ;
93 while ( $filename = $d->read() )
95 if ( substr($filename,0,1) != '.' )
96 $templates [ strtolower ( $filename) ] = strtolower ( $filename ) ;
99 // If a custom module, then its type is determined by the parent SugarObject that it extends
100 $type = $GLOBALS [ 'beanList' ] [ $this->module ] ;
101 require_once $GLOBALS [ 'beanFiles' ] [ $type ] ;
105 $seed = new $type () ;
106 $type = get_parent_class ($seed) ;
107 } while ( ! in_array ( strtolower ( $type ) , $templates ) && $type != 'SugarBean' ) ;
109 if ( $type != 'SugarBean' )
111 return strtolower ( $type ) ;
114 // 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...
116 'Accounts' => 'company' ,
119 'Contacts' => 'person' ,
120 'Documents' => 'file' ,
121 'Leads' => 'person' ,
122 'Opportunities' => 'sale'
124 if ( isset ( $types [ $this->module ] ) )
125 return $types [ $this->module ] ;
131 * Return the fields for this module as sourced from the SugarBean
132 * @return Array of fields
135 function getFields ()
137 return $this->fields ;
142 return array ( 'name' => $this->name , 'module' => $this->module , 'type' => 'StudioModule' , 'action' => "module=ModuleBuilder&action=wizard&view_module={$this->module}" , 'children' => $this->getModule() ) ;
145 function getModule ()
147 $sources = array ( translate('LBL_LABELS') => array ( 'action' => "module=ModuleBuilder&action=editLabels&view_module={$this->module}" , 'imageTitle' => 'Labels' , 'help' => 'labelsBtn' ) ,
148 translate('LBL_FIELDS') => array ( 'action' => "module=ModuleBuilder&action=modulefields&view_package=studio&view_module={$this->module}" , 'imageTitle' => 'Fields' , 'help' => 'fieldsBtn' ) ,
149 translate('LBL_RELATIONSHIPS') => array ( 'action' => "get_tpl=true&module=ModuleBuilder&action=relationships&view_module={$this->module}" , 'imageTitle' => 'Relationships' , 'help' => 'relationshipsBtn' ) ,
150 translate('LBL_LAYOUTS') => array ( 'children' => 'getLayouts' , 'action' => "module=ModuleBuilder&action=wizard&view=layouts&view_module={$this->module}" , 'imageTitle' => 'Layouts' , 'help' => 'layoutsBtn' ) ,
151 translate('LBL_SUBPANELS') => array ( 'children' => 'getSubpanels' , 'action' => "module=ModuleBuilder&action=wizard&view=subpanels&view_module={$this->module}" , 'imageTitle' => 'Subpanels' , 'help' => 'subpanelsBtn' ) ) ;
154 foreach ( $sources as $source => $def )
156 $nodes [ $source ] = $def ;
157 $nodes [ $source ] [ 'name' ] = translate ( $source ) ;
158 if ( isset ( $def [ 'children' ] ) )
160 $childNodes = $this->$def [ 'children' ] () ;
161 if ( !empty ( $childNodes ) )
163 $nodes [ $source ] [ 'type' ] = 'Folder' ;
164 $nodes [ $source ] [ 'children' ] = $childNodes ;
167 unset ( $nodes [ $source ] ) ;
174 function getViews() {
176 foreach ( $this->sources as $file => $def )
178 if (file_exists ( "modules/{$this->module}/metadata/$file" ))
180 $views [ str_replace ( '.php', '' , $file) ] = $def ;
186 function getLayouts()
188 $views = $this->getViews();
190 // 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
192 $hideQuickCreateForModules = array ( 'kbdocuments' , 'projecttask' ,
195 // Some modules should not have a QuickCreate form at all, so do not add them to the list
196 if (! in_array ( strtolower ( $this->module ), $hideQuickCreateForModules ))
197 $views [ 'quickcreatedefs' ] = array ( 'name' => translate('LBL_QUICKCREATE') , 'type' => MB_QUICKCREATE , 'image' => 'QuickCreate' ) ;
199 $layouts = array ( ) ;
200 foreach ( $views as $def )
202 $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' ) ;
205 if($this->isValidDashletModule($this->module)){
206 $dashlets = array( );
207 $dashlets [] = array('name' => translate('LBL_DASHLETLISTVIEW') , 'type' => 'dashlet' , 'action' => 'module=ModuleBuilder&action=editLayout&view=dashlet&view_module=' . $this->module );
208 $dashlets [] = array('name' => translate('LBL_DASHLETSEARCHVIEW') , 'type' => 'dashletsearch' , 'action' => 'module=ModuleBuilder&action=editLayout&view=dashletsearch&view_module=' . $this->module );
209 $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);
212 //For popup tree node
214 $popups [] = array('name' => translate('LBL_POPUPLISTVIEW') , 'type' => 'popuplistview' , 'action' => 'module=ModuleBuilder&action=editLayout&view=popuplist&view_module=' . $this->module );
215 $popups [] = array('name' => translate('LBL_POPUPSEARCH') , 'type' => 'popupsearch' , 'action' => 'module=ModuleBuilder&action=editLayout&view=popupsearch&view_module=' . $this->module );
216 $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);
218 $nodes = $this->getSearch () ;
219 if ( !empty ( $nodes ) )
221 $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' => 'SearchForm' , 'help' => 'searchBtn' , 'size' => '48') ;
228 function isValidDashletModule($moduleName){
229 $fileName = "My{$moduleName}Dashlet";
230 $customFileName = "{$moduleName}Dashlet";
231 if (file_exists ( "modules/{$moduleName}/Dashlets/{$fileName}/{$fileName}.php" )
232 || file_exists ( "custom/modules/{$moduleName}/Dashlets/{$fileName}/{$fileName}.php" )
233 || file_exists ( "modules/{$moduleName}/Dashlets/{$customFileName}/{$customFileName}.php" )
234 || file_exists ( "custom/modules/{$moduleName}/Dashlets/{$customFileName}/{$customFileName}.php" ))
242 function getSearch ()
244 require_once ('modules/ModuleBuilder/parsers/views/SearchViewMetaDataParser.php') ;
247 foreach ( array ( MB_BASICSEARCH => 'LBL_BASIC_SEARCH' , MB_ADVANCEDSEARCH => 'LBL_ADVANCED_SEARCH' ) as $view => $label )
251 $parser = new SearchViewMetaDataParser ( $view , $this->module ) ;
252 $title = translate ( $label ) ;
253 if($label == 'LBL_BASIC_SEARCH'){
254 $name = 'BasicSearch';
255 }elseif($label == 'LBL_ADVANCED_SEARCH'){
256 $name = 'AdvancedSearch';
258 $name = str_replace ( ' ', '', $title ) ;
260 $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' ) ;
262 catch ( Exception $e )
264 $GLOBALS [ 'log' ]->info( 'No search layout : '. $e->getMessage() ) ;
272 * Return an object containing all the relationships participated in by this module
273 * @return AbstractRelationships Set of relationships
275 function getRelationships ()
277 return new DeployedRelationships ( $this->module ) ;
282 * Gets a list of subpanels used by the current module
284 function getSubpanels ()
286 if(!empty($GLOBALS['current_user']) && empty($GLOBALS['modListHeader']))
287 $GLOBALS['modListHeader'] = query_module_access_list($GLOBALS['current_user']);
289 require_once ('include/SubPanel/SubPanel.php') ;
293 $GLOBALS [ 'log' ]->debug ( "StudioModule->getSubpanels(): getting subpanels for " . $this->module ) ;
295 foreach ( SubPanel::getModuleSubpanels ( $this->module ) as $name => $label )
297 if ($name == 'users')
299 $subname = sugar_ucfirst ( (! empty ( $label )) ? translate ( $label, $this->module ) : $name ) ;
300 $nodes [ $subname ] = array (
302 'label' => $subname ,
303 'action' => "module=ModuleBuilder&action=editLayout&view=ListView&view_module={$this->module}&subpanel={$name}&subpanelLabel={$subname}" ,
304 'imageTitle' => $subname ,
305 'imageName' => 'icon_' . ucfirst($name) . '_32',
306 'altImageName' => 'Subpanels',
316 * gets a list of subpanels provided to other modules
320 function getProvidedSubpanels ()
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)
329 foreach(scandir($dir) as $fileName)
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" ))
335 $subname = str_replace ( '.php', '', $fileName ) ;
336 $this->providedSubpanels [ $subname ] = $subname ;
342 return $this->providedSubpanels;
346 function getParentModulesOfSubpanel($subpanel){
347 global $moduleList, $beanFiles, $beanList, $module;
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);
354 //change case to match subpanel processing later on
355 $modules_to_check = array_change_key_case($modules_to_check);
359 //iterate through modules and build subpanel array
360 foreach($modules_to_check as $mod_name){
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];
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;
369 //retrieve subpanels for this bean
370 require_once($beanFiles[$class]);
371 $bean_class = new $class();
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;
382 function removeFieldFromLayouts ( $fieldName )
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);
390 $GLOBALS [ 'log' ]->debug ( print_r( $sources,true) ) ;
391 foreach ( $sources as $name => $defs )
393 //If this module type doesn't support a given metadata type, we will get an exception from getParser()
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){}
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()
406 $parser = ParserFactory::getParser( MB_LISTVIEW , $parentModule, null , $this->module) ;
407 if ($parser->removeField ( $fieldName ) )
408 $parser->handleSave(false) ;
409 } catch(Exception $e){}
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);