modules/ModuleBuilder/parsers/relationships/AbstractRelationships.php

   1 <?php
   2 if (! defined ( 'sugarEntry' ) || ! sugarEntry)
   3     die ( 'Not A Valid Entry Point' ) ;
   4
   5 /*********************************************************************************
   6  * SugarCRM Community Edition is a customer relationship management program developed by
   7  * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
   8  *
   9  * This program is free software; you can redistribute it and/or modify it under
  10  * the terms of the GNU Affero General Public License version 3 as published by the
  11  * Free Software Foundation with the addition of the following permission added
  12  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  13  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  14  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  15  *
  16  * This program is distributed in the hope that it will be useful, but WITHOUT
  17  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  18  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  19  * details.
  20  *
  21  * You should have received a copy of the GNU Affero General Public License along with
  22  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  23  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  24  * 02110-1301 USA.
  25  *
  26  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  27  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  28  *
  29  * The interactive user interfaces in modified source and object code versions
  30  * of this program must display Appropriate Legal Notices, as required under
  31  * Section 5 of the GNU Affero General Public License version 3.
  32  *
  33  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  34  * these Appropriate Legal Notices must retain the display of the "Powered by
  35  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  36  * technical reasons, the Appropriate Legal Notices must display the words
  37  * "Powered by SugarCRM".
  38  ********************************************************************************/
  39
  40
  41 /*
  42  * Abstract class for managing a set of Relationships
  43  * The Relationships we're managing consist of metadata about relationships, rather than relationship implementations used by the application
  44  * Relationships defined here are implemented by the build() method to become a relationship that the application can use
  45  * Note that the modules/Relationships/Relationship.php contains some methods that look similar; remember though that the methods in that file are acting on implemented relationships, not the metadata that we deal with here
  46  */
  47 class AbstractRelationships
  48 {
  49
  50     static $methods = array (
  51         'Labels' => 'language' ,
  52         'RelationshipMetaData' => 'relationships' ,
  53         'SubpanelDefinitions' => 'layoutdefs' ,
  54         'Vardefs' => 'vardefs' ,
  55         'FieldsToLayouts' => 'layoutfields',
  56     ) ;
  57     static $activities = array ( 'calls' => 'Calls' , 'meetings' => 'Meetings' , 'notes' => 'Notes' , 'tasks' => 'Tasks' , 'emails' => 'Emails' ) ;
  58
  59     protected $relationships = array ( ) ; // array containing all the AbstractRelationship objects that are in this set of relationships
  60     protected $moduleName ;
  61
  62     /*
  63      * Find all deployed modules that can participate in a relationship
  64      * Return a list of modules with associated subpanels
  65      * @param boolean $includeActivitiesSubmodules True if the list should include Calls, Meetings etc; false if they should be replaced by the parent, Activities
  66      * @return array    Array of [$module][$subpanel]
  67      */
  68     static function findRelatableModules ($includeActivitiesSubmodules = true)
  69     {
  70         $relatableModules = array ( ) ;
  71
  72         // add in activities automatically if required
  73         $relatableModules [ 'Activities' ] [ 'default' ] = translate( 'LBL_DEFAULT' ) ;
  74
  75         // find all deployed modules
  76         require_once 'modules/ModuleBuilder/Module/StudioBrowser.php' ;
  77         $browser = new StudioBrowser() ;
  78         $browser->loadRelatableModules();
  79         reset($browser->modules) ;
  80
  81         while ( list( $moduleName , $module ) = each($browser->modules) )
  82         {
  83             // do not include the submodules of Activities as already have the parent...
  84             if (! $includeActivitiesSubmodules && in_array ( $module->module, self::$activities ))
  85                 continue ;
  86             $providedSubpanels = $module->getProvidedSubpanels();
  87             if ( $providedSubpanels !== false ) {
  88                 $relatableModules [ $module->module ] = $providedSubpanels;
  89             }
  90         }
  91
  92         return $relatableModules ;
  93
  94     }
  95
  96     static function validSubpanel ($filename)
  97     {
  98         if (! file_exists ( $filename ))
  99             return false ;
 100
 101         include $filename ;
 102         return (isset ( $subpanel_layout ) && (isset ( $subpanel_layout [ 'top_buttons' ] ) && isset ( $subpanel_layout [ 'list_fields' ] ))) ;
 103     }
 104
 105     /*
 106      * Get a list of all relationships (which have not been deleted)
 107      * @return array    Array of relationship names, ready for use in get()
 108      */
 109     function getRelationshipList ()
 110     {
 111         $list = array ( ) ;
 112         foreach ( $this->relationships as $name => $relationship )
 113         {
 114             if (! $relationship->deleted ())
 115                 $list [ $name ] = $name ;
 116         }
 117         return $list ;
 118     }
 119
 120     /*
 121      * Get a relationship by name
 122      * @param string $relationshipName  The unique name for this relationship, as returned by $relationship->getName()
 123      * @return AbstractRelationship or false if $relationshipName is not in this set of relationships
 124      */
 125     function get ($relationshipName)
 126     {
 127         if (isset ( $this->relationships [ $relationshipName ] ))
 128         {
 129             return $this->relationships [ $relationshipName ] ;
 130         }
 131         return false ;
 132     }
 133
 134     /*
 135      * Construct a relationship from the information in the $_REQUEST array
 136      * If a relationship_name is provided, and that relationship is not read only, then modify the existing relationship, overriding the definition with any AbstractRelationship::$definitionkeys entries set in the $_REQUEST
 137      * Otherwise, create and add a new relationship with the information in the $_REQUEST
 138      * @return AbstractRelationship
 139      */
 140     function addFromPost ()
 141     {
 142         $definition = array ( ) ;
 143
 144         require_once 'modules/ModuleBuilder/parsers/relationships/AbstractRelationship.php' ;
 145         foreach ( AbstractRelationship::$definitionKeys as $key )
 146         {
 147             if (! empty ( $_REQUEST [ $key ] ))
 148             {
 149                 $definition [ $key ] = ($key == 'relationship_type') ? AbstractRelationship::parseRelationshipType ( $_REQUEST [ $key ] ) : $_REQUEST [ $key ] ;
 150             }
 151         }
 152
 153         // if this is a change to an existing relationship, and it is not readonly, then delete the old one
 154         if (! empty ( $_REQUEST [ 'relationship_name' ] ))
 155         {
 156             if ($relationship = $this->get ( $_REQUEST [ 'relationship_name' ] ))
 157             {
 158                 unset( $definition[ 'relationship_name' ] ) ; // in case the related modules have changed; this name is probably no longer appropriate
 159                 if (! $relationship->readonly ())
 160                     $this->delete ( $_REQUEST [ 'relationship_name' ] ) ;
 161         }
 162         }
 163
 164         $newRelationship = RelationshipFactory::newRelationship ( $definition ) ;
 165         // TODO: error handling in case we get a badly formed definition and hence relationship
 166         $this->add ( $newRelationship ) ;
 167         return $newRelationship ;
 168     }
 169
 170     /*
 171      * Add a relationship to the set
 172      * @param AbstractRelationship $relationship    The relationship to add
 173      */
 174     function add ($relationship)
 175     {
 176         $name = $this->getUniqueName ( $relationship ) ;
 177         $relationship->setName ( $name ) ;
 178         $this->relationships [ $name ] = $relationship ;
 179     }
 180
 181     /*
 182      * Load a set of relationships from a file
 183      * The saved relationships are stored as AbstractRelationship objects, which isn't the same as the old MBRelationships definition
 184      * @param string $basepath  Base directory in which to store the relationships information
 185      * @return Array of AbstractRelationship objects
 186      */
 187     protected function _load ($basepath)
 188     {
 189         $GLOBALS [ 'log' ]->info ( get_class ( $this ) . ": loading relationships from " . $basepath . '/relationships.php' ) ;
 190         $objects = array ( ) ;
 191         if (file_exists ( $basepath . '/relationships.php' ))
 192         {
 193             include ($basepath . '/relationships.php') ;
 194             foreach ( $relationships as $name => $definition )
 195             {
 196                 // update any pre-5.1 relationships to the new definitions
 197                 // we do this here, rather than when upgrading from 5.0 to 5.1, as modules exported from MB in 5.0 may be loaded into 5.1 at any time
 198                 // note also that since these definitions are only found in the relationships.php working file they only occur for deployed or exported modules, not published then loaded modules
 199                 $definition = $this->_updateRelationshipDefinition( $definition ) ;
 200                 $relationship = RelationshipFactory::newRelationship ( $definition ) ;
 201                 // make sure it has a unique name
 202                 if (! isset( $definition [ 'relationship_name' ] ) )
 203                 {
 204                     $name = $this->getUniqueName ( $relationship ) ;
 205                     $relationship->setName ( $name ) ;
 206                 }
 207                 $objects [ $name ] = $relationship ;
 208             }
 209         }
 210         return $objects ;
 211     }
 212
 213     /*
 214      * Save the set of relationships to a file
 215      * @param string $basepath  Base directory in which to store the relationships information
 216      */
 217     protected function _save ($relationships , $basepath)
 218     {
 219         $GLOBALS [ 'log' ]->info ( get_class ( $this ) . ": saving relationships to " . $basepath . '/relationships.php' ) ;
 220         $header = file_get_contents ( 'modules/ModuleBuilder/MB/header.php' ) ;
 221
 222         $definitions = array ( ) ;
 223
 224         foreach ( $relationships as $relationship )
 225         {
 226             // if (! $relationship->readonly ())
 227             $definitions [ $relationship->getName () ] = $relationship->getDefinition () ;
 228         }
 229
 230         mkdir_recursive ( $basepath ) ;
 231         // replace any existing relationships.php
 232         write_array_to_file ( 'relationships', $definitions, $basepath . '/relationships.php', 'w', $header ) ;
 233     }
 234
 235     /*
 236      * Return all known deployed relationships
 237      * All are set to read-only - the assumption for now is that we can't directly modify a deployed relationship
 238      * However, if it was created through this AbstractRelationships class a modifiable version will be held in the relationships working file,
 239      * and that one will override the readonly version in load()
 240      *
 241      * TODO: currently we ignore the value of the 'reverse' field in the relationships definition. This is safe to do as only one
 242      * relationship (products-products) uses it (and there it makes no difference from our POV) and we don't use it when creating new ones
 243      * @return array Array of $relationshipName => $relationshipDefinition as an array
 244      */
 245     protected function getDeployedRelationships ()
 246     {
 247
 248         $db = DBManagerFactory::getInstance () ;
 249         $query = "SELECT * FROM relationships WHERE deleted = 0" ;
 250         $result = $db->query ( $query ) ;
 251         while ( $row = $db->fetchByAssoc ( $result ) )
 252         {
 253             // set this relationship to readonly
 254             $row [ 'readonly' ] = true ;
 255             $relationships [ $row [ 'relationship_name' ] ] = $row ;
 256         }
 257
 258         return $relationships ;
 259     }
 260
 261     /*
 262      * Get a name for this relationship that is unique across all of the relationships we are aware of
 263      * We make the name unique by simply adding on a suffix until we achieve uniqueness
 264      * @param AbstractRelationship The relationship object
 265      * @return string A globally unique relationship name
 266      */
 267     protected function getUniqueName ($relationship)
 268     {
 269         $allRelationships = $this->getRelationshipList () ;
 270         $basename = $relationship->getName () ;
 271
 272         if (empty ( $basename ))
 273         {
 274             // start off with the proposed name being simply lhs_module_rhs_module
 275             $definition = $relationship->getDefinition () ;
 276             $basename = strtolower ( $definition [ 'lhs_module' ] . '_' . $definition [ 'rhs_module' ] ) ;
 277         }
 278
 279         $name = $basename ;
 280         $suffix = 1 ;
 281         while ( isset ( $allRelationships [ $name ] ) )
 282         {
 283             $name = $basename . "_" . ( string ) ($suffix ++) ;
 284         }
 285         return $name ;
 286     }
 287
 288     /*
 289      * Translate the set of relationship objects into files that the Module Loader can work with
 290      * @param string $basepath          Pathname of the directory to contain the build
 291      * @param string $installDefPrefix  Pathname prefix for the installdefs, for example for ModuleBuilder use "<basepath>/SugarModules"
 292      * @param array $relationships      Relationships to implement
 293      */
 294     protected function build ($basepath , $installDefPrefix , $relationships )
 295     {
 296         global $sugar_config;
 297         // keep the relationships data separate from any other build data by ading /relationships to the basepath
 298         $basepath .= '/relationships' ;
 299
 300         $installDefs = array ( ) ;
 301         $compositeAdded = false ;
 302         foreach ( self::$methods as $method => $key )
 303         {
 304             $buildMethod = 'build' . $method ;
 305             $saveMethod = 'save' . $method ;
 306
 307             foreach ( $relationships as $name => $relationship )
 308             {
 309                 if (! ($relationship->readonly () || $relationship->deleted ()))
 310                 {
 311                     if (method_exists ( $relationship, $buildMethod ) && method_exists ( $this, $saveMethod ))
 312                     {
 313                         $metadata = $relationship->$buildMethod () ;
 314
 315                         if (count ( $metadata ) > 0) // don't clutter up the filesystem with empty files...
 316                         {
 317                             $GLOBALS [ 'log' ]->debug ( get_class ( $this ) . ": BUILD is running METHOD $saveMethod" ) ;
 318                             $installDef = $this->$saveMethod ( $basepath, $installDefPrefix, $name, $metadata ) ;
 319
 320                             // some save methods (e.g., saveRelateFieldDefinition) handle the installDefs internally and so return null
 321
 322
 323                             if (! is_null ( $installDef ))
 324                             {
 325                                 foreach ( $installDef as $moduleName => $def )
 326                                 {
 327                                     $installDefs [ $key ] [ ] = $def ;
 328                                 }
 329                             }
 330                         }
 331                     }
 332
 333                 }
 334             }
 335         }
 336
 337         return $installDefs ;
 338     }
 339
 340     /*
 341      * SAVE methods called during the build to translate the metadata provided by each relationship into files for the module installer
 342      * Note that the installer expects only one file for each module in each section of the manifest - multiple files result in only the last one being implemented!
 343      */
 344
 345     /*
 346      * Add a set of labels to the module
 347      * @param string $basepath              Basepath location for this module
 348      * @param $installDefPrefix             Pathname prefix for the installdefs, for example for ModuleBuilder use "<basepath>/SugarModules"
 349      * @param string $relationshipName      Name of this relationship (for uniqueness)
 350      * @param array $labelDefinitions       Array of System label => Display label pairs
 351      * @return null Nothing to be added to the installdefs for an undeployed module
 352      */
 353     protected function saveLabels ($basepath , $installDefPrefix , $relationshipName , $labelDefinitions)
 354     {
 355         global $sugar_config;
 356
 357         mkdir_recursive ( "$basepath/language" ) ;
 358
 359         $headerString = "<?php\n//THIS FILE IS AUTO GENERATED, DO NOT MODIFY\n" ;
 360         $installDefs = array ( ) ;
 361         foreach ( $labelDefinitions as $definition )
 362         {
 363                 $mod_strings = array();
 364                 $app_list_strings = array();
 365
 366                 $out = $headerString;
 367
 368                 $filename = "{$basepath}/language/{$definition['module']}.php" ;
 369
 370                 if (file_exists ( $filename ))
 371                         include ($filename);
 372
 373
 374             //Check for app strings
 375             $GLOBALS [ 'log' ]->debug ( get_class ( $this ) . "->saveLabels(): saving the following to {$filename}"
 376                                       . print_r ( $definition, true ) ) ;
 377             if ($definition['module'] == 'application') {
 378                 $app_list_strings[$definition [ 'system_label' ]] = $definition [ 'display_label' ];
 379                 foreach ($app_list_strings as $key => $val)
 380                         $out .= override_value_to_string_recursive2('app_list_strings', $key, $val);
 381             } else {
 382                 $mod_strings[ $definition [ 'system_label' ]] = $definition [ 'display_label' ];
 383                 foreach ($mod_strings as $key => $val)
 384                         $out .= override_value_to_string_recursive2('mod_strings', $key, $val);
 385             }
 386
 387             $fh = fopen ( $filename, 'w' ) ;
 388             fputs ( $fh, $out, strlen ( $out ) ) ;
 389             fclose ( $fh ) ;
 390
 391
 392             foreach($sugar_config['languages'] as $lk => $lv)
 393             {
 394                 $installDefs [ $definition [ 'module' ] . "_$lk" ] = array (
 395                         'from' => "{$installDefPrefix}/relationships/language/{$definition [ 'module' ]}.php" ,
 396                         'to_module' => $definition [ 'module' ] ,
 397                         'language' => $lk
 398                 ) ;
 399             }
 400
 401             /* do not use the following write_array_to_file method to write the label file -
 402              * module installer appends each of the label files together (as it does for all files)
 403                          * into a combined label file and so the last $mod_strings is the only one received by the application */
 404                 // write_array_to_file ( 'mod_strings', array ( $definition [ 'system_label' ] => $definition [ 'display_label' ] ), $filename, "a" ) ;
 405         }
 406
 407         return $installDefs ;
 408     }
 409
 410     /*
 411      * Translate a set of relationship metadata definitions into files for the Module Loader
 412      * @param string $basepath              Basepath location for this module
 413      * @param $installDefPrefix             Pathname prefix for the installdefs, for example for ModuleBuilder use "<basepath>/SugarModules"
 414      * @param string $relationshipName      Name of this relationship (for uniqueness)
 415      * @param array $relationshipMetaData   Set of metadata definitions in the form $relationshipMetaData[$relationshipName]
 416      * @return array $installDefs           Set of new installDefs
 417      */
 418     protected function saveRelationshipMetaData ($basepath , $installDefPrefix , $relationshipName , $relationshipMetaData)
 419     {
 420         mkdir_recursive ( "$basepath/relationships" ) ;
 421
 422         $installDefs = array ( ) ;
 423         list ( $rhs_module, $properties ) = each ( $relationshipMetaData ) ;
 424         $filename = "$basepath/relationships/{$relationshipName}MetaData.php" ;
 425         $GLOBALS [ 'log' ]->debug ( get_class ( $this ) . "->saveRelationshipMetaData(): saving the following to {$filename}" . print_r ( $properties, true ) ) ;
 426         write_array_to_file ( 'dictionary["' . $relationshipName . '"]', $properties, "{$filename}", 'w' ) ;
 427         $installDefs [ $relationshipName ] = array ( /*'module' => $rhs_module , 'module_vardefs' => "<basepath>/Vardefs/{$relationshipName}.php" ,*/ 'meta_data' => "{$installDefPrefix}/relationships/relationships/{$relationshipName}MetaData.php" ) ;
 428
 429         return $installDefs ;
 430     }
 431
 432     /*
 433      * Translate a set of subpanelDefinitions into files for the Module Loader
 434      * @param string $basepath              Basepath location for this module
 435      * @param $installDefPrefix             Pathname prefix for the installdefs, for example for ModuleBuilder use "<basepath>/SugarModules"
 436      * @param array $subpanelDefinitions    Set of subpanel definitions in the form $subpanelDefinitions[$for_module][]
 437      * @return array $installDefs           Set of new installDefs
 438      */
 439     protected function saveSubpanelDefinitions ($basepath , $installDefPrefix , $relationshipName , $subpanelDefinitions)
 440     {
 441         mkdir_recursive ( "$basepath/layoutdefs/" ) ;
 442
 443         foreach ( $subpanelDefinitions as $moduleName => $definitions )
 444         {
 445             $filename = "$basepath/layoutdefs/{$relationshipName}_{$moduleName}.php" ;
 446             $subpanelVarname = 'layout_defs["' . $moduleName . '"]["subpanel_setup"]';
 447             $out = "";
 448             foreach ( $definitions as $definition )
 449             {
 450                 $GLOBALS [ 'log' ]->debug ( get_class ( $this ) . "->saveSubpanelDefinitions(): saving the following to {$filename}" . print_r ( $definition, true ) ) ;
 451                 if (empty($definition ['get_subpanel_data']) || $definition ['subpanel_name'] == 'history' || $definition ['subpanel_name'] == 'activities') {
 452                     $definition ['get_subpanel_data'] = $definition ['subpanel_name'];
 453                 }
 454                 $out .= override_value_to_string($subpanelVarname, strtolower ( $definition [ 'get_subpanel_data' ] ), $definition) . "\n";
 455             }
 456             if (!empty($out)) {
 457                 $out = "<?php\n // created: " . date('Y-m-d H:i:s') . "\n" . $out;
 458                 sugar_file_put_contents($filename, $out);
 459             }
 460
 461             $installDefs [ $moduleName ] = array ( 'from' => "{$installDefPrefix}/relationships/layoutdefs/{$relationshipName}_{$moduleName}.php" , 'to_module' => $moduleName ) ;
 462         }
 463         return $installDefs ;
 464     }
 465
 466
 467     /*
 468      * Translate a set of linkFieldDefinitions into files for the Module Loader
 469      * Note that the Module Loader will only accept one entry in the vardef section of the Manifest for each module
 470      * This means that we cannot simply build a file for each relationship as relationships that involve the same module will end up overwriting each other when installed
 471      * So we have to append the vardefs for each relationship to a single file for each module
 472      * @param string $basepath              Basepath location for this module
 473      * @param $installDefPrefix             Pathname prefix for the installdefs, for example for ModuleBuilder use "<basepath>/SugarModules"
 474      * @param string $relationshipName      Name of this relationship (for uniqueness)
 475      * @param array $linkFieldDefinitions   Set of link field definitions in the form $linkFieldDefinitions[$for_module]
 476      * @return array $installDefs           Set of new installDefs
 477      */
 478     protected function saveVardefs ($basepath , $installDefPrefix , $relationshipName , $vardefs)
 479     {
 480         mkdir_recursive ( "$basepath/vardefs/" ) ;
 481         $GLOBALS [ 'log' ]->debug ( get_class ( $this ) . "->saveVardefs(): vardefs =" . print_r ( $vardefs, true ) ) ;
 482
 483         foreach ( $vardefs as $moduleName => $definitions )
 484         {
 485             // find this module's Object name - the object name, not the module name, is used as the key in the vardefs...
 486             if (isset ( $GLOBALS [ 'beanList' ] [ $moduleName ] ))
 487             {
 488                 $module = get_module_info ( $moduleName ) ;
 489                 $object = $module->object_name ;
 490             } else
 491             {
 492                 $object = $moduleName ;
 493             }
 494
 495             $relName = $moduleName;
 496             foreach ( $definitions as $definition )
 497             {
 498                 if (!empty($definition['relationship']))
 499                 {
 500                         $relName = $definition['relationship'];
 501                         break;
 502                 }
 503             }
 504
 505             $filename = "$basepath/vardefs/{$relName}_{$moduleName}.php" ;
 506
 507             $out =  "<?php\n// created: " . date('Y-m-d H:i:s') . "\n";
 508             foreach ( $definitions as $definition )
 509             {
 510                 $GLOBALS [ 'log' ]->debug ( get_class ( $this ) . "->saveVardefs(): saving the following to {$filename}" . print_r ( $definition, true ) ) ;
 511                 $out .= '$dictionary["' . $object . '"]["fields"]["' . $definition [ 'name' ] . '"] = '
 512                           . var_export_helper($definition) . ";\n";
 513             }
 514             file_put_contents($filename, $out);
 515
 516             $installDefs [ $moduleName ] = array (
 517                 'from' => "{$installDefPrefix}/relationships/vardefs/{$relName}_{$moduleName}.php" ,
 518                 'to_module' => $moduleName
 519             ) ;
 520         }
 521
 522         $GLOBALS [ 'log' ]->debug ( get_class ( $this ) . "->saveVardefs(): installDefs =" . print_r ( $installDefs, true ) ) ;
 523
 524         return $installDefs ;
 525
 526     }
 527
 528     /*
 529      * Determine if we're dealing with a deployed or undeployed module based on the name
 530      * Undeployed modules are those known to ModuleBuilder; the twist is that the deployed names of modulebuilder modules are keyname_modulename not packagename_modulename
 531      * and ModuleBuilder doesn't have any accessor methods based around keys, so we must convert keynames to packagenames
 532      * @param $deployedName Name of the module in the deployed form - that is, keyname_modulename or modulename
 533      * @return array ('moduleName'=>name, 'packageName'=>package) if undeployed, ('moduleName'=>name) if deployed
 534      */
 535     static function parseDeployedModuleName ($deployedName)
 536     {
 537         require_once 'modules/ModuleBuilder/MB/ModuleBuilder.php' ;
 538         $mb = new ModuleBuilder ( ) ;
 539
 540         $packageName = '' ;
 541         $moduleName = $deployedName ;
 542
 543         foreach ( $mb->getPackageList () as $name )
 544         {
 545             // convert the keyName into a packageName, needed for checking to see if this is really an undeployed module, or just a module with a _ in the name...
 546             $package = $mb->getPackage ( $name ) ; // seem to need to call getPackage twice to get the key correctly... TODO: figure out why...
 547             $key = $mb->getPackage ( $name )->key ;
 548             if (strlen ( $key ) < strlen ( $deployedName ))
 549             {
 550                 $position = stripos ( $deployedName, $key ) ;
 551                 $moduleName = trim( substr( $deployedName , strlen($key) ) , '_' ); //use trim rather than just assuming that _ is between packageName and moduleName in the deployedName
 552                 if ( $position !== false && $position == 0 && (isset ( $mb->packages [ $name ]->modules [ $moduleName ] )))
 553                 {
 554                     $packageName = $name ;
 555                     break ;
 556                 }
 557             }
 558         }
 559
 560         if (! empty ( $packageName ))
 561         {
 562             return array ( 'moduleName' => $moduleName , 'packageName' => $packageName ) ;
 563         } else
 564         {
 565             return array ( 'moduleName' => $deployedName ) ;
 566         }
 567     }
 568
 569
 570 }