From afc90604bfad7ab5805873cb5bafc3bbb74c4b01 Mon Sep 17 00:00:00 2001
From: Charlie DeTar <cfd@media.mit.edu>
Date: Sat, 15 Sep 2012 17:48:04 -0400
Subject: [PATCH 01/32] Add `userColor` query param to set initial color

Add a URL parameter which sets the initial color for a user, e.g.:

    http://example.com/p/mypad?userColor=%2300ff00

Sanitize the given color value to ensure that it's a valid css value
(could be any supported CSS color format -- #fff, rgba(), "red", etc).

Shortly after rejoining a pad, the server responds with a USER_NEWINFO
message which may contain an old color value; however, this message
arrives after we have set and sent the new color value to the server.
To avoid this race condition, if the query parameter has been set,
ignore the color value in a USER_NEWINFO message which matches our user
ID.
---
 src/static/js/collab_client.js |  8 ++++++++
 src/static/js/pad.js           | 25 +++++++++++++++++++++++++
 2 files changed, 33 insertions(+)

diff --git a/src/static/js/collab_client.js b/src/static/js/collab_client.js
index d149b256..b3e17c25 100644
--- a/src/static/js/collab_client.js
+++ b/src/static/js/collab_client.js
@@ -358,6 +358,14 @@ function getCollabClient(ace2editor, serverVars, initialUserInfo, options, _pad)
     {
       var userInfo = msg.userInfo;
       var id = userInfo.userId;
+
+      // Avoid a race condition when setting colors.  If our color was set by a
+      // query param, ignore our own "new user" message's color value.
+      if (id === initialUserInfo.userId && initialUserInfo.globalUserColor)
+      {
+        msg.userInfo.colorId = initialUserInfo.globalUserColor;
+      }
+
       
       if (userSet[id])
       {
diff --git a/src/static/js/pad.js b/src/static/js/pad.js
index 737f5dc6..8f8e8729 100644
--- a/src/static/js/pad.js
+++ b/src/static/js/pad.js
@@ -114,6 +114,7 @@ function getParams()
   var showControls = params["showControls"];
   var showChat = params["showChat"];
   var userName = params["userName"];
+  var userColor = params["userColor"];
   var showLineNumbers = params["showLineNumbers"];
   var useMonospaceFont = params["useMonospaceFont"];
   var IsnoColors = params["noColors"];
@@ -162,6 +163,11 @@ function getParams()
     // If the username is set as a parameter we should set a global value that we can call once we have initiated the pad.
     settings.globalUserName = decodeURIComponent(userName);
   }
+  if(userColor)
+    // If the userColor is set as a parameter, set a global value to use once we have initiated hte pad.
+  {
+    settings.globalUserColor = decodeURIComponent(userColor);
+  }
   if(rtl)
   {
     if(rtl == "true")
@@ -363,6 +369,24 @@ function handshake()
         pad.myUserInfo.name = settings.globalUserName;
         $('#myusernameedit').attr({"value":settings.globalUserName}); // Updates the current users UI
       }
+      if (settings.globalUserColor !== false)
+      {
+        // First, check the color to ensure it's a valid css color value.
+        var check = $("<span/>").css("background-color", "white");
+        $("body").append(check);
+        var white = check.css("background-color");
+        check.css("background-color", settings.globalUserColor);
+        // Ensure that setting the element changed the color.
+        if (check.css("background-color") === white) {
+          settings.globalUserColor = "#ff0000";
+        }
+        check.remove();
+
+        // Add a 'globalUserColor' property to myUserInfo, so collabClient knows we have a query parameter.
+        pad.myUserInfo.globalUserColor = settings.globalUserColor;
+        pad.notifyChangeColor(settings.globalUserColor); // Updates pad.myUserInfo.colorId
+        paduserlist.setMyUserInfo(pad.myUserInfo);
+      }
     }
     //This handles every Message after the clientVars
     else
@@ -1025,6 +1049,7 @@ var settings = {
 , noColors: false
 , useMonospaceFontGlobal: false
 , globalUserName: false
+, globalUserColor: false
 , rtlIsTrue: false
 };
 

From bc6e495e8c691a3e3ce047b1dbe8ba600ef49eef Mon Sep 17 00:00:00 2001
From: Charlie DeTar <cfd@media.mit.edu>
Date: Mon, 17 Sep 2012 00:19:57 -0400
Subject: [PATCH 02/32] Use 'transparent' as reference to validate css

Use 'transparent' instead of 'white' as a reference color for validating
CSS color values.  Presumably, a user setting a userColor wants some
color other than 'transparent' if they are setting it (they could always
duplicate the background's color if not).
---
 src/static/js/pad.js | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/src/static/js/pad.js b/src/static/js/pad.js
index 8f8e8729..3e2663c8 100644
--- a/src/static/js/pad.js
+++ b/src/static/js/pad.js
@@ -164,7 +164,7 @@ function getParams()
     settings.globalUserName = decodeURIComponent(userName);
   }
   if(userColor)
-    // If the userColor is set as a parameter, set a global value to use once we have initiated hte pad.
+    // If the userColor is set as a parameter, set a global value to use once we have initiated the pad.
   {
     settings.globalUserColor = decodeURIComponent(userColor);
   }
@@ -372,12 +372,12 @@ function handshake()
       if (settings.globalUserColor !== false)
       {
         // First, check the color to ensure it's a valid css color value.
-        var check = $("<span/>").css("background-color", "white");
+        var check = $("<span/>").css("background-color", "transparent");
         $("body").append(check);
-        var white = check.css("background-color");
+        var transparent = check.css("background-color");
         check.css("background-color", settings.globalUserColor);
         // Ensure that setting the element changed the color.
-        if (check.css("background-color") === white) {
+        if (check.css("background-color") === transparent) {
           settings.globalUserColor = "#ff0000";
         }
         check.remove();

From 53113644a0464929316be67ea878d47d13714aba Mon Sep 17 00:00:00 2001
From: Charlie DeTar <cfd@media.mit.edu>
Date: Mon, 17 Sep 2012 10:59:12 -0400
Subject: [PATCH 03/32] Require userColor to be valid css hex

The utility functions colorutils.js assume that background colors are in
CSS hex format, so require userColor to do the same, rather than
allowing inputs like "red" and "rgba(...)", to insure that inversion
checks will succeed.
---
 src/static/js/colorutils.js |  7 +++++++
 src/static/js/pad.js        | 13 ++-----------
 2 files changed, 9 insertions(+), 11 deletions(-)

diff --git a/src/static/js/colorutils.js b/src/static/js/colorutils.js
index 5fbefb4d..74a2e463 100644
--- a/src/static/js/colorutils.js
+++ b/src/static/js/colorutils.js
@@ -24,6 +24,13 @@
 
 var colorutils = {};
 
+// Check that a given value is a css hex color value, e.g.
+// "#ffffff" or "#fff"
+colorutils.isCssHex = function(cssColor)
+{
+  return /^#([0-9a-f]{3}|[0-9a-f]{6})$/i.test(cssColor);
+}
+
 // "#ffffff" or "#fff" or "ffffff" or "fff" to [1.0, 1.0, 1.0]
 colorutils.css2triple = function(cssColor)
 {
diff --git a/src/static/js/pad.js b/src/static/js/pad.js
index 3e2663c8..21dea440 100644
--- a/src/static/js/pad.js
+++ b/src/static/js/pad.js
@@ -43,6 +43,7 @@ var padmodals = require('./pad_modals').padmodals;
 var padsavedrevs = require('./pad_savedrevs');
 var paduserlist = require('./pad_userlist').paduserlist;
 var padutils = require('./pad_utils').padutils;
+var colorutils = require('./colorutils').colorutils;
 
 var createCookie = require('./pad_utils').createCookie;
 var readCookie = require('./pad_utils').readCookie;
@@ -369,18 +370,8 @@ function handshake()
         pad.myUserInfo.name = settings.globalUserName;
         $('#myusernameedit').attr({"value":settings.globalUserName}); // Updates the current users UI
       }
-      if (settings.globalUserColor !== false)
+      if (settings.globalUserColor !== false && colorutils.isCssHex(settings.globalUserColor))
       {
-        // First, check the color to ensure it's a valid css color value.
-        var check = $("<span/>").css("background-color", "transparent");
-        $("body").append(check);
-        var transparent = check.css("background-color");
-        check.css("background-color", settings.globalUserColor);
-        // Ensure that setting the element changed the color.
-        if (check.css("background-color") === transparent) {
-          settings.globalUserColor = "#ff0000";
-        }
-        check.remove();
 
         // Add a 'globalUserColor' property to myUserInfo, so collabClient knows we have a query parameter.
         pad.myUserInfo.globalUserColor = settings.globalUserColor;

From 07c33c77c4b41a3181064beacc407565738c4929 Mon Sep 17 00:00:00 2001
From: d-a-n <in@db.to>
Date: Tue, 2 Oct 2012 22:10:18 +0300
Subject: [PATCH 04/32] Updated docs for new pad hooks (add, edit, remove)

---
 doc/api/hooks_server-side.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/doc/api/hooks_server-side.md b/doc/api/hooks_server-side.md
index 06ec7374..be5564a6 100644
--- a/doc/api/hooks_server-side.md
+++ b/doc/api/hooks_server-side.md
@@ -64,6 +64,34 @@ This hook gets called upon the rendering of an ejs template block. For any speci
 
 Have a look at `src/templates/pad.html` and `src/templates/timeslider.html` to see which blocks are available.
 
+## padCreated
+Called from: src/node/db/Pad.js
+
+1. pad - the pad instance
+
+This hook gets called when a new pad was created.
+
+## padLoaded
+Called from: src/node/db/Pad.js
+
+1. pad - the pad instance
+
+This hook gets called when an pad was loaded.
+
+## padUpdated
+Called from: src/node/db/Pad.js
+
+1. pad - the pad instance
+
+This hook gets called when an existing pad was updated.
+
+## padRemoved
+Called from: src/node/db/Pad.js
+
+1. pad - the pad instance
+
+This hook gets called when an existing pad was removed/deleted.
+
 ## socketio
 Called from: src/node/hooks/express/socketio.js
 

From c0f2e557d36f5b13604fff603ff26d5a9e4d0f64 Mon Sep 17 00:00:00 2001
From: d-a-n <in@db.to>
Date: Tue, 2 Oct 2012 22:11:54 +0300
Subject: [PATCH 05/32] Updated docs for new pad hooks (add, edit, remove)

---
 doc/api/hooks_server-side.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/doc/api/hooks_server-side.md b/doc/api/hooks_server-side.md
index be5564a6..b6ee1604 100644
--- a/doc/api/hooks_server-side.md
+++ b/doc/api/hooks_server-side.md
@@ -67,6 +67,8 @@ Have a look at `src/templates/pad.html` and `src/templates/timeslider.html` to s
 ## padCreated
 Called from: src/node/db/Pad.js
 
+Things in context:
+
 1. pad - the pad instance
 
 This hook gets called when a new pad was created.
@@ -74,6 +76,8 @@ This hook gets called when a new pad was created.
 ## padLoaded
 Called from: src/node/db/Pad.js
 
+Things in context:
+
 1. pad - the pad instance
 
 This hook gets called when an pad was loaded.
@@ -81,6 +85,8 @@ This hook gets called when an pad was loaded.
 ## padUpdated
 Called from: src/node/db/Pad.js
 
+Things in context:
+
 1. pad - the pad instance
 
 This hook gets called when an existing pad was updated.
@@ -88,6 +94,8 @@ This hook gets called when an existing pad was updated.
 ## padRemoved
 Called from: src/node/db/Pad.js
 
+Things in context:
+
 1. pad - the pad instance
 
 This hook gets called when an existing pad was removed/deleted.

From 64a3d60b943bdf7ae643f3fcb5791ffbc95b77ae Mon Sep 17 00:00:00 2001
From: d-a-n <in@db.to>
Date: Tue, 2 Oct 2012 22:30:13 +0300
Subject: [PATCH 06/32] Added pad hooks (create, load, edit, remove)

---
 src/node/db/Pad.js | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/node/db/Pad.js b/src/node/db/Pad.js
index ad2d59f3..cf04f9bc 100644
--- a/src/node/db/Pad.js
+++ b/src/node/db/Pad.js
@@ -16,6 +16,7 @@ var padMessageHandler = require("../handler/PadMessageHandler");
 var readOnlyManager = require("./ReadOnlyManager");
 var crypto = require("crypto");
 var randomString = require("../utils/randomstring");
+var hooks = require('ep_etherpad-lite/static/js/pluginfw/hooks');
 
 //serialization/deserialization attributes
 var attributeBlackList = ["id"];
@@ -86,6 +87,12 @@ Pad.prototype.appendRevision = function appendRevision(aChangeset, author) {
   // set the author to pad
   if(author)
     authorManager.addPad(author, this.id);
+    
+  if (this.head == 0) {
+    hooks.callAll("padCreated", this);
+  } else {
+    hooks.callAll("padUpdated", this);
+  }    
 };
 
 //save all attributes to the database
@@ -368,6 +375,7 @@ Pad.prototype.init = function init(text, callback) {
       _this.appendRevision(firstChangeset, '');
     }
 
+    hooks.callAll("padLoaded", _this);
     callback(null);
   });
 };
@@ -467,6 +475,7 @@ Pad.prototype.remove = function remove(callback) {
     {
       db.remove("pad:"+padID);
       padManager.unloadPad(padID);
+      hooks.callAll("padRemoved", padID );
       callback();
     }
   ], function(err)

From 4652751285ed4c4788442910574350f163f51ca9 Mon Sep 17 00:00:00 2001
From: d-a-n <in@db.to>
Date: Tue, 2 Oct 2012 22:32:30 +0300
Subject: [PATCH 07/32] Updated docs for new pad hooks (add, edit, remove)

---
 doc/api/hooks_server-side.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/api/hooks_server-side.md b/doc/api/hooks_server-side.md
index b6ee1604..84ca4490 100644
--- a/doc/api/hooks_server-side.md
+++ b/doc/api/hooks_server-side.md
@@ -96,7 +96,7 @@ Called from: src/node/db/Pad.js
 
 Things in context:
 
-1. pad - the pad instance
+1. pad id
 
 This hook gets called when an existing pad was removed/deleted.
 

From 85b44119aee2339856a2fccadef99f9629f68895 Mon Sep 17 00:00:00 2001
From: Richard Braakman <richard.braakman@jollamobile.com>
Date: Tue, 2 Oct 2012 23:27:30 +0300
Subject: [PATCH 08/32] USERINFO_UPDATE: construct a new message for broadcast

The server was reusing the client's message when broadcasting userinfo
updates. This would allow a malicious client to insert arbitrary fields
into a message that the other clients would trust as coming from the
server. For example, adding "disconnect" or renaming other authors.

This commit fixes it by having the server construct a new message with
known fields before broadcasting.
---
 src/node/handler/PadMessageHandler.js | 24 ++++++++++++++++++------
 1 file changed, 18 insertions(+), 6 deletions(-)

diff --git a/src/node/handler/PadMessageHandler.js b/src/node/handler/PadMessageHandler.js
index 10b259ae..28797a3a 100644
--- a/src/node/handler/PadMessageHandler.js
+++ b/src/node/handler/PadMessageHandler.js
@@ -415,22 +415,34 @@ function handleUserInfoUpdate(client, message)
   authorManager.setAuthorName(author, message.data.userInfo.name);
   
   var padId = sessioninfos[client.id].padId;
+
+  var infoMsg = {
+    type: "COLLABROOM",
+    data: {
+      // The Client doesn't know about USERINFO_UPDATE, use USER_NEWINFO
+      type: "USER_NEWINFO",
+      userInfo: {
+        userId: author,
+        name: message.data.userInfo.name,
+        colorId: message.data.userInfo.colorId,
+        userAgent: "Anonymous",
+        ip: "127.0.0.1",
+      }
+    }
+  };
   
   //set a null name, when there is no name set. cause the client wants it null
-  if(message.data.userInfo.name == null)
+  if(infoMsg.data.userInfo.name == null)
   {
-    message.data.userInfo.name = null;
+    infoMsg.data.userInfo.name = null;
   }
   
-  //The Client don't know about a USERINFO_UPDATE, it can handle only new user_newinfo, so change the message type
-  message.data.type = "USER_NEWINFO";
-  
   //Send the other clients on the pad the update message
   for(var i in pad2sessions[padId])
   {
     if(pad2sessions[padId][i] != client.id)
     {
-      socketio.sockets.sockets[pad2sessions[padId][i]].json.send(message);
+      socketio.sockets.sockets[pad2sessions[padId][i]].json.send(infoMsg);
     }
   }
 }

From 754c559d632c08be58f06c3eedb3a9494c51dedf Mon Sep 17 00:00:00 2001
From: d-a-n <in@db.to>
Date: Wed, 3 Oct 2012 13:35:31 +0300
Subject: [PATCH 09/32] Changed pad hook names to follow naming conventions.

---
 doc/api/hooks_server-side.md | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/doc/api/hooks_server-side.md b/doc/api/hooks_server-side.md
index 84ca4490..bc56f19b 100644
--- a/doc/api/hooks_server-side.md
+++ b/doc/api/hooks_server-side.md
@@ -64,7 +64,7 @@ This hook gets called upon the rendering of an ejs template block. For any speci
 
 Have a look at `src/templates/pad.html` and `src/templates/timeslider.html` to see which blocks are available.
 
-## padCreated
+## padCreate
 Called from: src/node/db/Pad.js
 
 Things in context:
@@ -73,16 +73,16 @@ Things in context:
 
 This hook gets called when a new pad was created.
 
-## padLoaded
+## padLoad
 Called from: src/node/db/Pad.js
 
 Things in context:
 
 1. pad - the pad instance
 
-This hook gets called when an pad was loaded.
+This hook gets called when an pad was loaded. If a new pad was created and loaded this event will be emitted too.
 
-## padUpdated
+## padUpdate
 Called from: src/node/db/Pad.js
 
 Things in context:
@@ -91,7 +91,7 @@ Things in context:
 
 This hook gets called when an existing pad was updated.
 
-## padRemoved
+## padRemove
 Called from: src/node/db/Pad.js
 
 Things in context:

From 358e4817310eceec8df664f3c428ba0afdc430dc Mon Sep 17 00:00:00 2001
From: d-a-n <in@db.to>
Date: Wed, 3 Oct 2012 13:41:40 +0300
Subject: [PATCH 10/32] Changed pad hook names to follow naming conventions.
 Arguments will now be passed as hash.

---
 src/node/db/Pad.js | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/src/node/db/Pad.js b/src/node/db/Pad.js
index cf04f9bc..d6ea8277 100644
--- a/src/node/db/Pad.js
+++ b/src/node/db/Pad.js
@@ -89,9 +89,9 @@ Pad.prototype.appendRevision = function appendRevision(aChangeset, author) {
     authorManager.addPad(author, this.id);
     
   if (this.head == 0) {
-    hooks.callAll("padCreated", this);
+    hooks.callAll("padCreate", {'pad':this});
   } else {
-    hooks.callAll("padUpdated", this);
+    hooks.callAll("padUpdate", {'pad':this});
   }    
 };
 
@@ -375,7 +375,7 @@ Pad.prototype.init = function init(text, callback) {
       _this.appendRevision(firstChangeset, '');
     }
 
-    hooks.callAll("padLoaded", _this);
+    hooks.callAll("padLoad", {'pad':_this});
     callback(null);
   });
 };
@@ -475,7 +475,7 @@ Pad.prototype.remove = function remove(callback) {
     {
       db.remove("pad:"+padID);
       padManager.unloadPad(padID);
-      hooks.callAll("padRemoved", padID );
+      hooks.callAll("padRemove", {'pad_id':padID});
       callback();
     }
   ], function(err)

From 0fd8490ca6e3f2218c9ab16bf722725d173caa34 Mon Sep 17 00:00:00 2001
From: d-a-n <in@db.to>
Date: Wed, 3 Oct 2012 15:49:28 +0300
Subject: [PATCH 11/32] Changed pad_id to padID to follow projct standards.

---
 doc/api/hooks_server-side.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/api/hooks_server-side.md b/doc/api/hooks_server-side.md
index bc56f19b..49eb6cc5 100644
--- a/doc/api/hooks_server-side.md
+++ b/doc/api/hooks_server-side.md
@@ -96,7 +96,7 @@ Called from: src/node/db/Pad.js
 
 Things in context:
 
-1. pad id
+1. padID
 
 This hook gets called when an existing pad was removed/deleted.
 

From a521a125830a18213d71991d55c5d04269c5ee94 Mon Sep 17 00:00:00 2001
From: d-a-n <in@db.to>
Date: Wed, 3 Oct 2012 15:50:43 +0300
Subject: [PATCH 12/32] Changed pad_id to padID to follow projct standards.

---
 src/node/db/Pad.js | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/node/db/Pad.js b/src/node/db/Pad.js
index d6ea8277..dba791fd 100644
--- a/src/node/db/Pad.js
+++ b/src/node/db/Pad.js
@@ -475,7 +475,7 @@ Pad.prototype.remove = function remove(callback) {
     {
       db.remove("pad:"+padID);
       padManager.unloadPad(padID);
-      hooks.callAll("padRemove", {'pad_id':padID});
+      hooks.callAll("padRemove", {'padID':padID});
       callback();
     }
   ], function(err)

From 90373964d31c61013fff941459c84688170636a8 Mon Sep 17 00:00:00 2001
From: John McLear <john@mclear.co.uk>
Date: Sat, 6 Oct 2012 02:36:51 +0200
Subject: [PATCH 13/32] Remove two instances of the same function name
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Both functions did the same thing, the first function was buggy.  Might be worth someone looking through the history of this file and pointing out when I made this heinous error ;)
---
 src/node/db/AuthorManager.js | 16 ----------------
 1 file changed, 16 deletions(-)

diff --git a/src/node/db/AuthorManager.js b/src/node/db/AuthorManager.js
index 2a6625c8..28b2dd91 100644
--- a/src/node/db/AuthorManager.js
+++ b/src/node/db/AuthorManager.js
@@ -141,22 +141,6 @@ exports.getAuthor = function (author, callback)
   db.get("globalAuthor:" + author, callback);
 }
 
-/**
- * Returns the Author Name of the author
-  * @param {String} author The id of the author
-  * @param {Function} callback callback(err, name)
-  */
-
-exports.getAuthorName = function (authorID, callback)
-{
-  db.getSub("globalAuthor:" + author, ["name"], callback);
-  console.log(authorID);
-  db.getSub("globalAuthor:" + authorID, ["name"], function(err, authorName){
-    if(ERR(err, callback)) return;
-    callback(null, {authorName: authorName});
-  });
-}
-
 
 
 /**

From 9d1274abafb1887c2d4c7586946954e6e6532347 Mon Sep 17 00:00:00 2001
From: Chad Weider <cweider@oofn.net>
Date: Tue, 9 Oct 2012 01:32:21 -0700
Subject: [PATCH 14/32] Drop method deprecated in Express 3.x.

---
 src/node/utils/caching_middleware.js | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/node/utils/caching_middleware.js b/src/node/utils/caching_middleware.js
index 1f533673..c6b23713 100644
--- a/src/node/utils/caching_middleware.js
+++ b/src/node/utils/caching_middleware.js
@@ -48,7 +48,7 @@ CachingMiddleware.prototype = new function () {
     var old_res = {};
 
     var supportsGzip =
-        req.header('Accept-Encoding', '').indexOf('gzip') != -1;
+        (req.get('Accept-Encoding') || '').indexOf('gzip') != -1;
 
     var path = require('url').parse(req.url).path;
     var cacheKey = (new Buffer(path)).toString('base64').replace(/[\/\+=]/g, '');

From 0fa954c1a0d2a7e2c6c1d3dcc9987889857f77d9 Mon Sep 17 00:00:00 2001
From: Dmitry <uvarov.dl@gmail.com>
Date: Thu, 11 Oct 2012 17:51:57 +0400
Subject: [PATCH 15/32] fixed variable name in handleMessageHook

the code would never work as expected with this type
---
 src/node/handler/PadMessageHandler.js | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/node/handler/PadMessageHandler.js b/src/node/handler/PadMessageHandler.js
index 10b259ae..831acdbb 100644
--- a/src/node/handler/PadMessageHandler.js
+++ b/src/node/handler/PadMessageHandler.js
@@ -178,7 +178,7 @@ exports.handleMessage = function(client, message)
     // handleMessage will be called, even if the client is not authorized
     hooks.aCallAll("handleMessage", { client: client, message: message }, function ( messages ) {
       _.each(messages, function(newMessage){
-        if ( newmessage === null ) {
+        if ( newMessage === null ) {
           dropMessage = true;
         }
       });

From dbcdc2f956172d4d0c89424ff5114c57b71cb4e3 Mon Sep 17 00:00:00 2001
From: Dmitry <uvarov.dl@gmail.com>
Date: Thu, 11 Oct 2012 18:07:45 +0400
Subject: [PATCH 16/32] fix for error handling in callback code

The callback code does not follow error handling guidelines, thus always
receiving NULL instead of results array.
---
 src/node/handler/PadMessageHandler.js | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/src/node/handler/PadMessageHandler.js b/src/node/handler/PadMessageHandler.js
index 831acdbb..b889a8a0 100644
--- a/src/node/handler/PadMessageHandler.js
+++ b/src/node/handler/PadMessageHandler.js
@@ -176,7 +176,9 @@ exports.handleMessage = function(client, message)
     
     // Call handleMessage hook. If a plugin returns null, the message will be dropped. Note that for all messages 
     // handleMessage will be called, even if the client is not authorized
-    hooks.aCallAll("handleMessage", { client: client, message: message }, function ( messages ) {
+    hooks.aCallAll("handleMessage", { client: client, message: message }, function ( err, messages ) {
+      if(ERR(err, callback)) return;
+      
       _.each(messages, function(newMessage){
         if ( newMessage === null ) {
           dropMessage = true;

From 957a0aa873f2df13483a9b17589c064cc229a80a Mon Sep 17 00:00:00 2001
From: "NAGOYA, Yoshihiko" <nagoya@lepidum.co.jp>
Date: Thu, 11 Oct 2012 23:39:01 +0900
Subject: [PATCH 17/32] fix Pita/etherpad-lite #1032

refact inInternationalComposition
---
 src/static/js/ace.js           |  5 +++++
 src/static/js/ace2_inner.js    | 21 ++++++++++++++++++---
 src/static/js/collab_client.js |  4 ++--
 src/static/js/pad.js           | 16 ----------------
 4 files changed, 25 insertions(+), 21 deletions(-)

diff --git a/src/static/js/ace.js b/src/static/js/ace.js
index e50f75c7..83ad9447 100644
--- a/src/static/js/ace.js
+++ b/src/static/js/ace.js
@@ -122,6 +122,11 @@ function Ace2Editor()
     return info.ace_getDebugProperty(prop);
   };
 
+  editor.getInInternationalComposition = function()
+  {
+    return info.ace_getInInternationalComposition();
+  };
+
   // prepareUserChangeset:
   // Returns null if no new changes or ACE not ready.  Otherwise, bundles up all user changes
   // to the latest base text into a Changeset, which is returned (as a string if encodeAsString).
diff --git a/src/static/js/ace2_inner.js b/src/static/js/ace2_inner.js
index 652a3d25..2e56b950 100644
--- a/src/static/js/ace2_inner.js
+++ b/src/static/js/ace2_inner.js
@@ -1173,7 +1173,7 @@ function Ace2Inner(){
     //if (! top.BEFORE) top.BEFORE = [];
     //top.BEFORE.push(magicdom.root.dom.innerHTML);
     //if (! isEditable) return; // and don't reschedule
-    if (window.parent.parent.inInternationalComposition)
+    if (inInternationalComposition)
     {
       // don't do idle input incorporation during international input composition
       idleWorkTimer.atLeast(500);
@@ -3729,7 +3729,7 @@ function Ace2Inner(){
         thisKeyDoesntTriggerNormalize = true;
       }
 
-      if ((!specialHandled) && (!thisKeyDoesntTriggerNormalize) && (!window.parent.parent.inInternationalComposition))
+      if ((!specialHandled) && (!thisKeyDoesntTriggerNormalize) && (!inInternationalComposition))
       {
         if (type != "keyup" || !incorpIfQuick())
         {
@@ -4589,9 +4589,24 @@ function Ace2Inner(){
     }
   }
 
+
+  var inInternationalComposition = false;
   function handleCompositionEvent(evt)
   {
-      window.parent.parent.handleCompositionEvent(evt);
+    // international input events, fired in FF3, at least;  allow e.g. Japanese input
+    if (evt.type == "compositionstart")
+    {
+      inInternationalComposition = true;
+    }
+    else if (evt.type == "compositionend")
+    {
+      inInternationalComposition = false;
+    }
+  }
+
+  editorInfo.ace_getInInternationalComposition = function ()
+  {
+    return inInternationalComposition;
   }
 
   function bindTheEventHandlers()
diff --git a/src/static/js/collab_client.js b/src/static/js/collab_client.js
index b3e17c25..b700fc49 100644
--- a/src/static/js/collab_client.js
+++ b/src/static/js/collab_client.js
@@ -111,7 +111,7 @@ function getCollabClient(ace2editor, serverVars, initialUserInfo, options, _pad)
 
   function handleUserChanges()
   {
-    if (window.parent.parent.inInternationalComposition) return;
+    if (editor.getInInternationalComposition()) return;
     if ((!getSocket()) || channelState == "CONNECTING")
     {
       if (channelState == "CONNECTING" && (((+new Date()) - initialStartConnectTime) > 20000))
@@ -288,7 +288,7 @@ function getCollabClient(ace2editor, serverVars, initialUserInfo, options, _pad)
       var apool = msg.apool;
 
       // When inInternationalComposition, msg pushed msgQueue.
-      if (msgQueue.length > 0 || window.parent.parent.inInternationalComposition) {
+      if (msgQueue.length > 0 || editor.getInInternationalComposition()) {
         if (msgQueue.length > 0) oldRev = msgQueue[msgQueue.length - 1].newRev;
         else oldRev = rev;
 
diff --git a/src/static/js/pad.js b/src/static/js/pad.js
index 21dea440..89777040 100644
--- a/src/static/js/pad.js
+++ b/src/static/js/pad.js
@@ -51,22 +51,6 @@ var randomString = require('./pad_utils').randomString;
 
 var hooks = require('./pluginfw/hooks');
 
-window.inInternationalComposition = false;
-var inInternationalComposition = window.inInternationalComposition;
-
-window.handleCompositionEvent =  function handleCompositionEvent(evt)
-  {
-    // international input events, fired in FF3, at least;  allow e.g. Japanese input
-    if (evt.type == "compositionstart")
-    {
-      this.inInternationalComposition = true;
-    }
-    else if (evt.type == "compositionend")
-    {
-      this.inInternationalComposition = false;
-    }
-  }
-
 function createCookie(name, value, days, path)
 {
   if (days)

From c45739becb27d5031cd8983c4fcce8f3a5b98e1b Mon Sep 17 00:00:00 2001
From: John McLear <john@mclear.co.uk>
Date: Thu, 11 Oct 2012 23:38:56 +0200
Subject: [PATCH 18/32] Update src/package.json

Bump version #
---
 src/package.json | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/package.json b/src/package.json
index f729b3c1..c5a4d0aa 100644
--- a/src/package.json
+++ b/src/package.json
@@ -42,5 +42,5 @@
   "engines"        : { "node" : ">=0.6.0",
                        "npm"  : ">=1.0"
                      }, 
-  "version"        : "1.1.2"
+  "version"        : "1.1.4"
 }

From b7d0751b185cd55e74390a87353b7df02640090d Mon Sep 17 00:00:00 2001
From: John McLear <john@mclear.co.uk>
Date: Mon, 15 Oct 2012 13:09:55 +0200
Subject: [PATCH 19/32] couch, level, mongo, postgres, redis DB support

Support for additional underlying databases
---
 src/package.json | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/package.json b/src/package.json
index c5a4d0aa..504b88c2 100644
--- a/src/package.json
+++ b/src/package.json
@@ -15,7 +15,7 @@
                       "require-kernel"      : "1.0.5",
                       "resolve"             : "0.2.x",
                       "socket.io"           : "0.9.x",
-                      "ueberDB"             : "0.1.7",
+                      "ueberDB"             : "0.1.8",
                       "async"               : "0.1.22",
                       "express"             : "3.x",
                       "connect"             : "2.4.x",

From 6c89187f952ee248ff78c3ab9b3cbf4a78ae9e9f Mon Sep 17 00:00:00 2001
From: Marcel Klehr <mklehr@gmx.net>
Date: Tue, 16 Oct 2012 20:46:27 +0200
Subject: [PATCH 20/32] Fix #1067 Corrected exports links regexp

---
 src/static/js/timeslider.js | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/src/static/js/timeslider.js b/src/static/js/timeslider.js
index e630bde0..a2156b16 100644
--- a/src/static/js/timeslider.js
+++ b/src/static/js/timeslider.js
@@ -144,13 +144,12 @@ function handleClientVars(message)
   require('./pad_impexp').padimpexp.init();
 
   //change export urls when the slider moves
-  var export_rev_regex = /(\/\d+)?\/export/
   BroadcastSlider.onSlider(function(revno)
   {
     // export_links is a jQuery Array, so .each is allowed.
     export_links.each(function()
     {
-      this.setAttribute('href', this.href.replace(export_rev_regex, '/' + revno + '/export'));
+      this.setAttribute('href', this.href.replace( /(.+?)\/\w+\/(\d+\/)?export/ , '$1/' + padId + '/' + revno + '/export'));
     });
   });
 

From a770910a3a7285be3e45a16255b078051c5afa26 Mon Sep 17 00:00:00 2001
From: johnyma22 <john@mclear.co.uk>
Date: Wed, 17 Oct 2012 17:53:28 +0100
Subject: [PATCH 21/32] Add LibreJS Licensing information to headers of HTML
 templates

---
 src/templates/index.html      | 23 +++++++++++++++++++++++
 src/templates/pad.html        | 24 +++++++++++++++++++++++-
 src/templates/timeslider.html | 27 ++++++++++++++++++++++++---
 3 files changed, 70 insertions(+), 4 deletions(-)

diff --git a/src/templates/index.html b/src/templates/index.html
index 4a45d6a5..a6e5123f 100644
--- a/src/templates/index.html
+++ b/src/templates/index.html
@@ -2,6 +2,29 @@
 <html>
 
         <title>Etherpad Lite</title>
+	<script>
+	  /*
+	  |@licstart  The following is the entire license notice for the
+	  JavaScript code in this page.|
+
+	  Copyright 2011 Peter Martischka, Primary Technology.
+
+	  Licensed under the Apache License, Version 2.0 (the "License");
+	  you may not use this file except in compliance with the License.
+	  You may obtain a copy of the License at
+
+	     http://www.apache.org/licenses/LICENSE-2.0
+
+	  Unless required by applicable law or agreed to in writing, software
+	  distributed under the License is distributed on an "AS IS" BASIS,
+	  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+	  See the License for the specific language governing permissions and
+	  limitations under the License.
+
+	  |@licend  The above is the entire license notice
+	  for the JavaScript code in this page.|
+	  */
+	</script>
 
         <meta charset="utf-8"> 
         <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=0">
diff --git a/src/templates/pad.html b/src/templates/pad.html
index 425e476d..5cbae7aa 100644
--- a/src/templates/pad.html
+++ b/src/templates/pad.html
@@ -3,8 +3,30 @@
 %>
 <!doctype html>
 <html>
-
         <title>Etherpad Lite</title>
+        <script>
+          /*
+          |@licstart  The following is the entire license notice for the
+          JavaScript code in this page.|
+
+          Copyright 2011 Peter Martischka, Primary Technology.
+
+          Licensed under the Apache License, Version 2.0 (the "License");
+          you may not use this file except in compliance with the License.
+          You may obtain a copy of the License at
+
+             http://www.apache.org/licenses/LICENSE-2.0
+
+          Unless required by applicable law or agreed to in writing, software
+          distributed under the License is distributed on an "AS IS" BASIS,
+          WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+          See the License for the specific language governing permissions and
+          limitations under the License.
+
+          |@licend  The above is the entire license notice
+          for the JavaScript code in this page.|
+          */
+        </script>
 
         <meta charset="utf-8">
         <meta name="robots" content="noindex, nofollow">
diff --git a/src/templates/timeslider.html b/src/templates/timeslider.html
index 469ddd94..bc3c176b 100644
--- a/src/templates/timeslider.html
+++ b/src/templates/timeslider.html
@@ -1,11 +1,32 @@
 <!doctype html>
 <html lang="en">
+<title>Etherpad Lite Timeslider</title>
+<script>
+  /*
+  |@licstart  The following is the entire license notice for the
+  JavaScript code in this page.|
+
+  Copyright 2011 Peter Martischka, Primary Technology.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+
+  |@licend  The above is the entire license notice
+  for the JavaScript code in this page.|
+  */
+</script>
 <head>
   <meta charset="utf-8">
   <meta name="robots" content="noindex, nofollow">
-
-  <title>Etherpad Lite Timeslider</title>
-
   <link rel="shortcut icon" href="../../favicon.ico">
   <link rel="stylesheet" href="../../static/css/pad.css">
   <link rel="stylesheet" href="../../static/css/timeslider.css">

From 8199bf8377a110168a23dab1b8b074b722d18ffe Mon Sep 17 00:00:00 2001
From: Chia-liang Kao <clkao@clkao.org>
Date: Tue, 23 Oct 2012 15:21:05 +0800
Subject: [PATCH 22/32] Do not assume window object exists

---
 src/static/js/contentcollector.js | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/static/js/contentcollector.js b/src/static/js/contentcollector.js
index 6a75de43..dd4fd1e5 100644
--- a/src/static/js/contentcollector.js
+++ b/src/static/js/contentcollector.js
@@ -311,7 +311,7 @@ function makeContentCollector(collectStyles, browser, apool, domInterface, class
       ['insertorder', 'first']
     ].concat(
       _.map(state.lineAttributes,function(value,key){
-        if (window.console) console.log([key, value])
+        if (typeof(window)!= 'undefined' && window.console) console.log([key, value])
         return [key, value];
       })
     );

From 526610e2e7a3d3ec687dc7ea8736081c7d69255b Mon Sep 17 00:00:00 2001
From: neurolit <neurolit@gmail.com>
Date: Wed, 24 Oct 2012 19:48:13 +0200
Subject: [PATCH 23/32] =?UTF-8?q?Templates:=20relative=20links=20instead?=
 =?UTF-8?q?=20of=20absolute=20ones=20for=20/static=20directory=20=E2=80=A6?=
 =?UTF-8?q?irector?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Two links were absolute ("/static/...") instead of relative
("../static"). The image was not loaded with sites behind reverse
proxies and subdirectory.
---
 src/templates/pad.html        | 2 +-
 src/templates/timeslider.html | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/templates/pad.html b/src/templates/pad.html
index 425e476d..7e19535e 100644
--- a/src/templates/pad.html
+++ b/src/templates/pad.html
@@ -233,7 +233,7 @@
                 </div>
                 <div class="reconnecting">
                   <h1>Reestablishing connection...</h1>
-                  <p><img alt="" border="0" src="/static/img/connectingbar.gif" /></p>
+                  <p><img alt="" border="0" src="../static/img/connectingbar.gif" /></p>
                 </div>
                 <div class="userdup">
                   <h1>Opened in another window.</h1>
diff --git a/src/templates/timeslider.html b/src/templates/timeslider.html
index 469ddd94..c7defcc0 100644
--- a/src/templates/timeslider.html
+++ b/src/templates/timeslider.html
@@ -83,7 +83,7 @@
     </div>
     <div class="reconnecting">
       <h1>Reestablishing connection...</h1>
-      <p><img alt="" border="0" src="/static/img/connectingbar.gif" /></p>
+      <p><img alt="" border="0" src="../../static/img/connectingbar.gif" /></p>
     </div>
     <div class="userdup">
       <h1>Opened in another window.</h1>

From cb760aae5287a3cddbff31118194806323939a66 Mon Sep 17 00:00:00 2001
From: 0ip <me@factor.cc>
Date: Thu, 25 Oct 2012 14:37:41 +0300
Subject: [PATCH 24/32] Fix broken layout (Chrome Mobile)

---
 src/templates/index.html | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/src/templates/index.html b/src/templates/index.html
index 4a45d6a5..b1d34eb4 100644
--- a/src/templates/index.html
+++ b/src/templates/index.html
@@ -9,9 +9,11 @@
         <link rel="shortcut icon" href="favicon.ico">
 
         <style>
+            html, body {
+              height: 100%;
+            }
             body {
               margin: 0;
-              height: 100%;
               color: #333;
               font: 14px helvetica, sans-serif;
               background: #ddd;

From 1bc9d61027c5bac87fd59e42b248ddd2edef119c Mon Sep 17 00:00:00 2001
From: Marcel Klehr <mklehr@gmx.net>
Date: Thu, 25 Oct 2012 13:38:28 +0200
Subject: [PATCH 25/32] Update npm (fix #1012)

---
 src/package.json | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/package.json b/src/package.json
index 504b88c2..1dfb53f6 100644
--- a/src/package.json
+++ b/src/package.json
@@ -25,7 +25,7 @@
                       "log4js"              : "0.5.x",
                       "jsdom-nocontextifiy" : "0.2.10",
                       "async-stacktrace"    : "0.0.2",
-                      "npm"                 : "1.1.24",
+                      "npm"                 : "1.1.x",
                       "ejs"                 : "0.6.1",
                       "graceful-fs"         : "1.1.5",
                       "slide"               : "1.1.3",

From ff2824ae7a524b5b64c029c84c517a301e4d6c47 Mon Sep 17 00:00:00 2001
From: Marcel Klehr <mklehr@gmx.net>
Date: Thu, 25 Oct 2012 13:45:40 +0200
Subject: [PATCH 26/32] Add "Marcel Klehr" to contributers list

---
 src/package.json | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/src/package.json b/src/package.json
index 504b88c2..80e9bc27 100644
--- a/src/package.json
+++ b/src/package.json
@@ -5,9 +5,10 @@
   "keywords"       : ["etherpad", "realtime", "collaborative", "editor"],
   "author"         : "Peter 'Pita' Martischka <petermartischka@googlemail.com> - Primary Technology Ltd",
   "contributors"   : [
-                      { "name": "John McLear", 
-                        "name": "Hans Pinckaers",
-                        "name": "Robin Buse" }
+                      { "name": "John McLear" }, 
+                      { "name": "Hans Pinckaers" },
+                      { "name": "Robin Buse" },
+                      { "name": "Marcel Klehr" },
                      ],
   "dependencies"   : {
                       "yajsml"              : "1.1.6",

From 58d559b962349660f9904abac27c8210d8b54c5c Mon Sep 17 00:00:00 2001
From: John McLear <john@mclear.co.uk>
Date: Thu, 25 Oct 2012 05:24:42 -0700
Subject: [PATCH 27/32] fix marcels trailing ,

---
 src/package.json | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/package.json b/src/package.json
index 2676e8a7..e4e9b9c3 100644
--- a/src/package.json
+++ b/src/package.json
@@ -8,7 +8,7 @@
                       { "name": "John McLear" }, 
                       { "name": "Hans Pinckaers" },
                       { "name": "Robin Buse" },
-                      { "name": "Marcel Klehr" },
+                      { "name": "Marcel Klehr" }
                      ],
   "dependencies"   : {
                       "yajsml"              : "1.1.6",

From 63e4aafae8d797ddf3b6b61a88852112c1667ab8 Mon Sep 17 00:00:00 2001
From: Marcel Klehr <mklehr@gmx.net>
Date: Thu, 25 Oct 2012 15:45:06 +0200
Subject: [PATCH 28/32] Add docs for plugins and plugin framework

@redhog please elaborate on / improve 'doc/api/pluginfw.md'!
---
 README.plugins      |  16 -------
 doc/all.md          |   1 +
 doc/api/api.md      |   3 +-
 doc/api/pluginfw.md |  14 ++++++
 doc/plugins.md      | 106 ++++++++++++++++++++++++++++++++++++++++++++
 5 files changed, 123 insertions(+), 17 deletions(-)
 delete mode 100644 README.plugins
 create mode 100644 doc/api/pluginfw.md
 create mode 100644 doc/plugins.md

diff --git a/README.plugins b/README.plugins
deleted file mode 100644
index 72c45644..00000000
--- a/README.plugins
+++ /dev/null
@@ -1,16 +0,0 @@
-So, a plugin is an npm package whose name starts with ep_ and that contains a file ep.json
-require("ep_etherpad-lite/static/js/plugingfw/plugins").update() will use npm to list all installed modules and read their ep.json files. These will contain registrations for hooks which are loaded
-A hook registration is a pairs of a hook name and a function reference (filename for require() plus function name)
-require("ep_etherpad-lite/static/js/plugingfw/hooks").callAll("hook_name", {argname:value}) will call all hook functions registered for hook_name
-That is the basis.
-Ok, so that was a slight simplification: inside ep.json, hook registrations are grouped into groups called "parts". Parts from all plugins are ordered using a topological sort according to "pre" and "post" pointers to other plugins/parts (just like dependencies, but non-installed plugins are silently ignored).
-This ordering is honored when you do callAll(hook_name) - hook functions for that hook_name are called in that order
-Ordering between plugins is undefined, only parts are ordered.
-
-A plugin usually has one part, but it van have multiple.
-This is so that it can insert some hook registration before that of another plugin, and another one after.
-This is important for e.g. registering URL-handlers for the express webserver, if you have some very generic and some very specific url-regexps
-So, that's basically it... apart from client-side hooks
-which works the same way, but uses a separate member of the part (part.client_hooks vs part.hooks), and where the hook function must obviously reside in a file require():able from the client...
-One thing more: The main etherpad tree is actually a plugin itself, called ep_etherpad-lite, and it has it's own ep.json...
-was that clear?
\ No newline at end of file
diff --git a/doc/all.md b/doc/all.md
index c0cbf369..f1e071a6 100644
--- a/doc/all.md
+++ b/doc/all.md
@@ -1,3 +1,4 @@
 @include documentation
 @include api/api
+@include plugins
 @include database
diff --git a/doc/api/api.md b/doc/api/api.md
index b96fa0c8..8ab5b3bd 100644
--- a/doc/api/api.md
+++ b/doc/api/api.md
@@ -4,4 +4,5 @@
 @include hooks_client-side
 @include hooks_server-side
 @include editorInfo
-@include changeset_library
\ No newline at end of file
+@include changeset_library
+@include pluginfw
\ No newline at end of file
diff --git a/doc/api/pluginfw.md b/doc/api/pluginfw.md
new file mode 100644
index 00000000..2189c74c
--- /dev/null
+++ b/doc/api/pluginfw.md
@@ -0,0 +1,14 @@
+# Plugin Framework
+`require("ep_etherpad-lite/static/js/plugingfw/plugins")`
+
+## plugins.update
+`require("ep_etherpad-lite/static/js/plugingfw/plugins").update()` will use npm to list all installed modules and read their ep.json files, registering the contained hooks.
+A hook registration is a pairs of a hook name and a function reference (filename for require() plus function name)
+
+## hooks.callAll
+`require("ep_etherpad-lite/static/js/plugingfw/hooks").callAll("hook_name", {argname:value})` will call all hook functions registered for `hook_name` with `{argname:value}`.
+
+## hooks.aCallAll
+?
+
+## ...
diff --git a/doc/plugins.md b/doc/plugins.md
new file mode 100644
index 00000000..3717c111
--- /dev/null
+++ b/doc/plugins.md
@@ -0,0 +1,106 @@
+# Plugins
+Etherpad-Lite allows you to extend its functionality with plugins. A plugin registers hooks (functions) for certain events (thus certain features) in Etherpad-lite to execute its own functionality based on these events.
+
+Publicly available plugins can be found in the npm registry (see <http://npmjs.org>). Etherpad-lite's naming convention for plugins is to prefix your plugins with `ep_`. So, e.g. it's `ep_flubberworms`. Thus you can install plugins from npm, using `npm install ep_flubberworm` in etherpad-lite's root directory.
+
+You can also browse to `http://yourEtherpadInstan.ce/admin/plugins`, which will list all installed plugins  and those available on npm. It even provides functionality to search through all available plugins.
+
+## Folder structure
+A basic plugin usually has the following folder structure:
+```
+ep_<plugin>/
+ | static/
+ | templates/
+ + ep.json
+ + package.json
+```
+If your plugin includes client-side hooks, put them in `static/js/`. If you're adding in CSS or image files, you should put those files in `static/css/ `and `static/image/`, respectively, and templates go into `templates/`.
+
+A Standard directory structure like this makes it easier to navigate through your code. That said, do note, that this is not actually *required* to make your plugin run.
+
+## Plugin definition
+Your plugin definition goes into `ep.json`. In this file you register your hooks, indicate the parts of your plugin and the order of execution. (A documentation of all available events to hook into can be found in chapter [hooks](#all_hooks).)
+
+A hook registration is a pairs of a hook name and a function reference (filename to require() + exported function name)
+
+```json
+{
+  "parts": [
+    {
+      "name": "nameThisPartHoweverYouWant",
+      "hooks": {
+        "authenticate" : "ep_<plugin>/<file>:FUNCTIONNAME1",
+        "expressCreateServer": "ep_<plugin>/<file>:FUNCTIONNAME2"
+      },
+      "client_hooks": {
+        "acePopulateDOMLine": "ep_plugin/<file>:FUNCTIONNAME3"
+      }
+    }
+  ]
+}
+```
+
+Etherpad-lite will expect the part of the hook definition before the colon to be a javascript file and will try to require it. The part after the colon is expected to be a valid function identifier of that module. So, you have to export your hooks, using [`module.exports`](http://nodejs.org/docs/latest/api/modules.html#modules_modules) and register it in `ep.json` as `ep_<plugin>/path/to/<file>:FUNCTIONNAME`.
+You can omit the `FUNCTIONNAME` part, if the exported function has got the same name as the hook. So `"authorize" : "ep_flubberworm/foo"` will call the function `exports.authorize` in `ep_flubberworm/foo.js`
+
+### Client hooks and server hooks
+There are server hooks, which will be executed on the server (e.g. `expressCreateServer`), and there are client hooks, which are executed on the client (e.g. `acePopulateDomLine`). Be sure to not make assumptions about the environment your code is running in, e.g. don't try to access `process`, if you know your code will be run on the client, and likewise, don't try to access `window` on the server...
+
+### Parts
+As your plugins become more and more complex, you will find yourself in the need to manage dependencies between plugins. E.g. you want the hooks of a certain plugin to be executed before (or after) yours. You can also manage these dependencies in your plugin definition file `ep.json`:
+
+```javascript
+{
+  "parts": [
+    {
+      "name": "onepart",
+      "pre": [],
+      "post": ["ep_onemoreplugin/partone"]
+      "hooks": {
+        "storeBar": "ep_monospace/plugin:storeBar",
+        "getFoo": "ep_monospace/plugin:getFoo",
+      }
+    },
+    {
+      "name": "otherpart",
+      "pre": ["ep_my_example/somepart", "ep_otherplugin/main"],
+      "post": [],
+      "hooks": {
+        "someEvent": "ep_my_example/otherpart:someEvent",
+        "another": "ep_my_example/otherpart:another"
+      }
+    }
+  ]
+}
+```
+
+Usually a plugin will add only one functionality at a time, so it will probably only use one `part` definition to register its hooks. However, sometimes you have to put different (unrelated) functionalities into one plugin. For this you will want use parts, so other plugins can depend on them.
+
+#### pre/post
+The `"pre"` and `"post"` definitions, affect the order in which parts of a plugin are executed. This ensures that plugins and their hooks are executed in the correct order.
+
+`"pre"` lists parts that must be executed *before* the defining part. `"post"` lists parts that must be executed *after* the defining part.
+
+You can, on a basic level, think of this as double-ended dependency listing. If you have a dependency on another plugin, you can make sure it loads before yours by putting it in `"pre"`. If you are setting up things that might need to be used by a plugin later, you can ensure proper order by putting it in `"post"`.
+
+Note that it would be far more sane to use `"pre"` in almost any case, but if you want to change config variables for another plugin, or maybe modify its environment, `"post"` could definitely be useful.
+
+Also, note that dependencies should *also* be listed in your package.json, so they can be `npm install`'d automagically when your plugin gets installed.
+
+## Package definition
+Your plugin must also contain a [package definition file](http://npmjs.org/doc/json.html), called package.json, in the project root - this file contains various metadata relevant to your plugin, such as the name and version number, author, project hompage, contributors, a short description, etc. If you publish your plugin on npm, these metadata are used for package search etc., but it's necessary for Etherpad-lite plugins, even if you don't publish your plugin.
+
+```json
+{
+  "name": "ep_PLUGINNAME",
+  "version": "0.0.1",
+  "description": "DESCRIPTION",
+  "author": "USERNAME (REAL NAME) <MAIL@EXAMPLE.COM>",
+  "contributors": [],
+  "dependencies": {"MODULE": "0.3.20"},
+  "engines": { "node": ">= 0.6.0"}
+}
+```
+
+## Templates
+If your plugin adds or modifies the front end HTML (e.g. adding buttons or changing their functions), you should put the necessary HTML code for such operations in `templates/`, in files of type ".ejs", since Etherpad-Lite uses EJS for HTML templating. See the following link for more information about EJS: <https://github.com/visionmedia/ejs>.
\ No newline at end of file

From 344ba31c921d77f7ef17ce4ff02a930c7133db76 Mon Sep 17 00:00:00 2001
From: John McLear <john@mclear.co.uk>
Date: Thu, 25 Oct 2012 09:35:33 -0700
Subject: [PATCH 29/32] fix paths in convert.js so it works

---
 bin/convert.js | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/bin/convert.js b/bin/convert.js
index ec792717..4bbdd667 100644
--- a/bin/convert.js
+++ b/bin/convert.js
@@ -1,9 +1,9 @@
 
 var startTime = new Date().getTime();
 var fs = require("fs");
-var ueberDB = require("ueberDB");
-var mysql = require("mysql");
-var async = require("async");
+var ueberDB = require("../src/node_modules/ueberDB");
+var mysql = require("../src/node_modules/ueberDB/node_modules/mysql");
+var async = require("../src/node_modules/async");
 var Changeset = require("ep_etherpad-lite/static/js/Changeset");
 var randomString = require('ep_etherpad-lite/static/js/pad_utils').randomString;
 var AttributePool = require("ep_etherpad-lite/static/js/AttributePool");

From ff2e7ead0982b4db01680536ff3392b1abe2a02a Mon Sep 17 00:00:00 2001
From: John McLear <john@mclear.co.uk>
Date: Thu, 25 Oct 2012 09:40:33 -0700
Subject: [PATCH 30/32] add a script to migrate from dirtyDB to MYSQL thanks to
 http://blog.codeborne.com

---
 bin/migrateDirtyDBtoMySQL.js | 11 +++++++++++
 1 file changed, 11 insertions(+)
 create mode 100644 bin/migrateDirtyDBtoMySQL.js

diff --git a/bin/migrateDirtyDBtoMySQL.js b/bin/migrateDirtyDBtoMySQL.js
new file mode 100644
index 00000000..f2bc8efe
--- /dev/null
+++ b/bin/migrateDirtyDBtoMySQL.js
@@ -0,0 +1,11 @@
+var dirty = require("../src/node_modules/ueberDB/node_modules/dirty")('var/dirty.db');
+var db = require("../src/node/db/DB");
+
+db.init(function() {
+  db = db.db;
+  dirty.on("load", function() {
+    dirty.forEach(function(key, value) {
+      db.set(key, value);
+    });
+  });
+});

From 596e20e12351afe90c622c3884575a26136732d5 Mon Sep 17 00:00:00 2001
From: Randy <kingkaeru@yahoo.com>
Date: Thu, 25 Oct 2012 10:21:34 -0700
Subject: [PATCH 31/32] Add default port of process.env.PORT if port isnt
 specified in settings.json

---
 src/node/utils/Settings.js | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/node/utils/Settings.js b/src/node/utils/Settings.js
index dd34ac5e..3d7894d5 100644
--- a/src/node/utils/Settings.js
+++ b/src/node/utils/Settings.js
@@ -37,7 +37,7 @@ exports.ip = "0.0.0.0";
 /**
  * The Port ep-lite should listen to
  */
-exports.port = 9001;
+exports.port = process.env.PORT || 9001;
 /*
  * The Type of the database
  */

From 399080ad739646d54913c1bf1afbb438d9785c08 Mon Sep 17 00:00:00 2001
From: Randy <kingkaeru@yahoo.com>
Date: Thu, 25 Oct 2012 10:22:28 -0700
Subject: [PATCH 32/32] Add IIS config file

---
 src/web.config | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 src/web.config

diff --git a/src/web.config b/src/web.config
new file mode 100644
index 00000000..e057b919
--- /dev/null
+++ b/src/web.config
@@ -0,0 +1,32 @@
+<configuration>
+  <system.webServer>
+
+    <handlers>
+      <add name="iisnode" path="node_modules/ep_etherpad-lite/node/server.js" verb="*" modules="iisnode" />
+    </handlers>
+
+    <rewrite>
+        <rules>
+            <!-- uncomment this section to enable debugging
+            <rule name="LogFile" patternSyntax="ECMAScript" stopProcessing="true">
+                <match url="iisnode"/>
+                <action type="Rewrite" url="node_modules/ep_etherpad-lite/node/iisnode" />
+            </rule>
+            <rule name="NodeInspector" patternSyntax="ECMAScript" stopProcessing="true">                    
+                <match url="^server.js\/debug[\/]?" />
+            </rule>
+            -->
+            <rule name="StaticContent">
+                 <action type="Rewrite" url="public{{REQUEST_URI}}"/>
+            </rule>
+            <rule name="DynamicContent">
+                 <conditions>
+                      <add input="{{REQUEST_FILENAME}}" matchType="IsFile" negate="True"/>
+                 </conditions>
+                <action type="Rewrite" url="node_modules/ep_etherpad-lite/node/server.js" />
+            </rule>
+        </rules>
+    </rewrite>
+
+  </system.webServer>
+</configuration>