From 1a64a6c1c5ece11307db152581ae51d34a9449bf Mon Sep 17 00:00:00 2001
From: Constantin Jucovschi <jucovschi@gmail.com>
Date: Wed, 14 Mar 2012 11:45:25 +0100
Subject: [PATCH] makes plugin architecture work in client-side from inside
 IFrames as well

---
 src/static/js/ace.js                     |  5 ++++
 src/static/js/pluginfw/parent_require.js | 37 ++++++++++++++++++++++++
 2 files changed, 42 insertions(+)
 create mode 100644 src/static/js/pluginfw/parent_require.js

diff --git a/src/static/js/ace.js b/src/static/js/ace.js
index 1306dba01..659503d86 100644
--- a/src/static/js/ace.js
+++ b/src/static/js/ace.js
@@ -261,6 +261,11 @@ require.setGlobalKeyPath("require");\n\
       // Inject my plugins into my child.
       iframeHTML.push('\
 <script type="text/javascript">\
+  parent_req = require("./pluginfw/parent_require.js");\
+  parent_req.getRequirementFromParent(require, "ep_etherpad-lite/static/js/pluginfw/hooks");\
+  parent_req.getRequirementFromParent(require, "ep_etherpad-lite/static/js/pluginfw/plugins");\
+  parent_req.getRequirementFromParent(require, "./pluginfw/hooks");\
+  parent_req.getRequirementFromParent(require, "./pluginfw/plugins");\
   require.define("/plugins", null);\n\
   require.define("/plugins.js", function (require, exports, module) {\
     module.exports = require("ep_etherpad-lite/static/js/plugins");\
diff --git a/src/static/js/pluginfw/parent_require.js b/src/static/js/pluginfw/parent_require.js
new file mode 100644
index 000000000..d7f6190d4
--- /dev/null
+++ b/src/static/js/pluginfw/parent_require.js
@@ -0,0 +1,37 @@
+/**
+ * This module allows passing require modules instances to
+ * embedded iframes in a page. 
+ * For example, if a page has the "plugins" module initialized,
+ * it is important to use exactly the same "plugins" instance 
+ * inside iframes as well. Otherwise, plugins cannot save any 
+ * state.
+ */
+
+
+/**
+ * Instructs the require object that when a reqModuleName module
+ * needs to be loaded, that it iterates through the parents of the 
+ * current window until it finds one who can execute "require" 
+ * statements and asks it to perform require on reqModuleName.
+ *
+ * @params requireDefObj Require object which supports define 
+ * statements. This object is accessible after loading require-kernel.
+ * @params reqModuleName Module name e.g. (ep_etherpad-lite/static/js/plugins)
+ */
+exports.getRequirementFromParent = function(requireDefObj, reqModuleName) {
+    requireDefObj.define(reqModuleName, function(require, exports, module) {
+	var t = parent;
+	var max = 0;  // make sure I don't go up more than 10 times
+	while (typeof(t) != "undefined") {
+	    max++;
+	    if (max==10)
+		break;
+	    if (typeof(t.require) != "undefined") {
+		module.exports = t.require(reqModuleName);
+		return;
+	    }
+	    t = t.parent;
+	}
+    }); 
+
+}