Merge pull request pencilblue#862 from pencilblue/issue/859

Fixes pencilblue#589 - Provides mechanism to pass context to onInstall function…
matt- · Nov 17, 2015 · 4d67612 · 4d67612
2 parents bcb847e + 066b5dc
commit 4d67612
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 4 deletions.
diff --git a/include/service/jobs/plugins/plugin_install_job.js b/include/service/jobs/plugins/plugin_install_job.js
@@ -192,9 +192,16 @@ module.exports = function PluginInstallJobModule(pb) {
             function(callback) {
 
                 var mainModule = pb.PluginService.loadMainModule(pluginUid, details.main_module.path);
-                if (!util.isNullOrUndefined(mainModule) && util.isFunction(mainModule.onInstall)) {
+                var hasBasicOnInstall = util.isFunction(mainModule.onInstall);
+                var hasContextOnInstall = util.isFunction(mainModule.onInstallWithContext);
+                if (!util.isNullOrUndefined(mainModule) && (hasBasicOnInstall || hasContextOnInstall)) {
                     self.log("Executing %s 'onInstall' function", details.uid);
-                    mainModule.onInstall(callback);
+
+                    if (hasBasicOnInstall) {
+                        return mainModule.onInstall(callback);
+                    }
+
+                    mainModule.onInstallWithContext({ site: site }, callback);
                 }
                 else {
                     self.log("WARN: Plugin %s did not provide an 'onInstall' function.", details.uid);

diff --git a/plugins/sample/sample.js b/plugins/sample/sample.js
@@ -13,11 +13,12 @@ module.exports = function SamplePluginModule(pb) {
 
     /**
      * Called when the application is being installed for the first time.
-     *
+     * @static
+     * @method onInstallWithContext
      * @param cb A callback that must be called upon completion.  cb(Error, Boolean).
      * The result should be TRUE on success and FALSE on failure
      */
-    SamplePlugin.onInstall = function(cb) {
+    SamplePlugin.onInstallWithContext = function(context, cb) {
         cb(null, true);
     };