Author avatar for jason

How to Package Version Specific Code

Posted by on January 17, 2013

When we recently added a feature to our upload scanner that checks the module zip for any missing files we unintentionally found a hidden gem. As many of you are familiar with, sometimes you just have to make a change that is specific to a certain version of SugarCRM. What many do in a case like that is to provide a zip file for that specific version (e.g. MyModule_for_6.5.9.zip). This can become hard to maintain over time.

Christian Knoll (creator of the Google StyleTheme) has a very clever way of dealing with this. In the manifest he takes advantage of the sugar_flavor and sugar_version global variables. Using these he is able to dynamically define what files to copy over based on the user’s current version.

So instead of a zip for each version, we are able to define what flavors and versions to support:

'acceptable_sugar_flavors' => array(
'CE', 'PRO','ENT'
),
'acceptable_sugar_versions' => array(
'6.5.7',
'6.5.8',
'6.5.9'
),
view raw manifest_acceptable.php hosted with ❤ by GitHub

Then in the copy we can utilize the global vars:

'copy' => array(
array(
'from' => '<basepath>/copy/' . $GLOBALS['sugar_flavor'] . '_' . $GLOBALS['sugar_version'] . '/include/Dashlets/Dashlet.php,
'to' => 'include/Dashlets/Dashlet.php',
),
),
view raw manifest_dynamic_copy.php hosted with ❤ by GitHub

This would then pull the appropriate version from the module zip’s file structure:

/copy/CE_6.5.7/...
/copy/CE_6.5.8/...
/copy/CE_6.5.9/...
/copy/PRO_6.5.7/...
/copy/PRO_6.5.8/...
/copy/PRO_6.5.9/...
..and so on

This makes it much easier to maintain for multiple versions and flavors of SugarCRM. Unfortunately, it means we have some work to do to add support to the upload scanner for this method. Thanks Christian!