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 01/17] 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 4a45d6a54..a6e5123fa 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 425e476d8..5cbae7aa5 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 469ddd94e..bc3c176be 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 02/17] 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 6a75de43a..dd4fd1e54 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 03/17] =?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 425e476d8..7e19535e5 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 469ddd94e..c7defcc00 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 04/17] 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 4a45d6a54..b1d34eb4f 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 05/17] 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 504b88c20..1dfb53f6a 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 06/17] 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 504b88c20..80e9bc272 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 07/17] 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 2676e8a78..e4e9b9c35 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 08/17] 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 72c456447..000000000
--- 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 c0cbf369f..f1e071a6d 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 b96fa0c8e..8ab5b3bdc 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 000000000..2189c74ca
--- /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 000000000..3717c1111
--- /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 09/17] 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 ec792717e..4bbdd667c 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 10/17] 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 000000000..f2bc8efe2
--- /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 11/17] 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 dd34ac5ee..3d7894d52 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 12/17] 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 000000000..e057b9198
--- /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>

From 94e399e8a920ce51881f92d01861d62d87fb3f39 Mon Sep 17 00:00:00 2001
From: Marcel Klehr <mklehr@gmx.net>
Date: Sat, 27 Oct 2012 16:30:31 +0200
Subject: [PATCH 13/17] Change filename hooks.md -> hooks_overview.md so it
 doesn't confuse tools/doc/generator

---
 doc/api/api.md                          | 2 +-
 doc/api/{hooks.md => hooks_overview.md} | 0
 2 files changed, 1 insertion(+), 1 deletion(-)
 rename doc/api/{hooks.md => hooks_overview.md} (100%)

diff --git a/doc/api/api.md b/doc/api/api.md
index 8ab5b3bdc..eb5bb9c9b 100644
--- a/doc/api/api.md
+++ b/doc/api/api.md
@@ -1,6 +1,6 @@
 @include embed_parameters
 @include http_api
-@include hooks
+@include hooks_overview
 @include hooks_client-side
 @include hooks_server-side
 @include editorInfo
diff --git a/doc/api/hooks.md b/doc/api/hooks_overview.md
similarity index 100%
rename from doc/api/hooks.md
rename to doc/api/hooks_overview.md

From 3d1fd05085924388f6577a24c9b62ad0b4949661 Mon Sep 17 00:00:00 2001
From: Marcel Klehr <mklehr@gmx.net>
Date: Sat, 27 Oct 2012 17:28:15 +0200
Subject: [PATCH 14/17] Insert epl version into template.

---
 Makefile          | 2 ++
 doc/template.html | 4 ++--
 tools/doc/html.js | 1 -
 3 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/Makefile b/Makefile
index 01f30701b..b64192173 100644
--- a/Makefile
+++ b/Makefile
@@ -2,12 +2,14 @@ doc_dirs = doc $(wildcard doc/*/)
 outdoc_dirs = out $(addprefix out/,$(doc_dirs))
 doc_sources = $(wildcard doc/*/*.md) $(wildcard doc/*.md)
 outdoc_files = $(addprefix out/,$(doc_sources:.md=.html))
+VERSION = $(shell node -e "console.log( require('./src/package.json').version )") 
 
 docs: $(outdoc_files)
 
 out/doc/%.html: doc/%.md
 	mkdir -p $(@D)
 	node tools/doc/generate.js --format=html --template=doc/template.html $< > $@
+	cat $@ | sed 's/__VERSION__/${VERSION}/' > $@
 
 clean:
 	rm -rf out/
diff --git a/doc/template.html b/doc/template.html
index 2eb939872..edc0af662 100644
--- a/doc/template.html
+++ b/doc/template.html
@@ -2,12 +2,12 @@
 <html lang="en">
 <head>
   <meta charset="utf-8">
-  <title>__SECTION__ Etherpad-Lite Manual &amp; Documentation</title>
+  <title>__SECTION__ - Etherpad Lite v__VERSION__ Manual &amp; Documentation</title>
   <link rel="stylesheet" href="style.css">
 </head>
 <body class="apidoc" id="api-section-__FILENAME__">
   <header id="header">
-    <h1>Etherpad-Lite Manual &amp; Documentation</h1>
+    <h1>Etherpad-Lite v__VERSION__ Manual &amp; Documentation</h1>
   </header>
 
   <div id="toc">
diff --git a/tools/doc/html.js b/tools/doc/html.js
index c52fff70a..700ab18cc 100644
--- a/tools/doc/html.js
+++ b/tools/doc/html.js
@@ -48,7 +48,6 @@ function render(lexed, filename, template, cb) {
 
     template = template.replace(/__FILENAME__/g, filename);
     template = template.replace(/__SECTION__/g, section);
-    template = template.replace(/__VERSION__/g, process.version);
     template = template.replace(/__TOC__/g, toc);
 
     // content has to be the last thing we do with

From 7a8401c36382913b4af0f0a0bf791bd4571eaaa3 Mon Sep 17 00:00:00 2001
From: Marcel Klehr <mklehr@gmx.net>
Date: Sat, 27 Oct 2012 18:47:09 +0200
Subject: [PATCH 15/17] Add recipe for doc assets and some basic styling for
 the generated docs.

---
 Makefile              | 11 ++++++++---
 doc/_assets/style.css | 44 +++++++++++++++++++++++++++++++++++++++++++
 doc/template.html     |  2 +-
 3 files changed, 53 insertions(+), 4 deletions(-)
 create mode 100644 doc/_assets/style.css

diff --git a/Makefile b/Makefile
index b64192173..ab720f284 100644
--- a/Makefile
+++ b/Makefile
@@ -1,10 +1,15 @@
-doc_dirs = doc $(wildcard doc/*/)
-outdoc_dirs = out $(addprefix out/,$(doc_dirs))
 doc_sources = $(wildcard doc/*/*.md) $(wildcard doc/*.md)
 outdoc_files = $(addprefix out/,$(doc_sources:.md=.html))
+
+docassets = $(addprefix out/,$(wildcard doc/_assets/*))
+
 VERSION = $(shell node -e "console.log( require('./src/package.json').version )") 
 
-docs: $(outdoc_files)
+docs: $(outdoc_files) $(docassets)
+
+out/doc/_assets/%: doc/_assets/%
+	mkdir -p $(@D)
+	cp $< $@
 
 out/doc/%.html: doc/%.md
 	mkdir -p $(@D)
diff --git a/doc/_assets/style.css b/doc/_assets/style.css
new file mode 100644
index 000000000..fe1343af4
--- /dev/null
+++ b/doc/_assets/style.css
@@ -0,0 +1,44 @@
+body.apidoc {
+  width: 60%;
+  min-width: 10cm;
+  margin: 0 auto;
+}
+
+#header {
+  background-color: #5a5;
+  padding: 10px;
+  color: #111;
+}
+
+a,
+a:active {
+  color: #272;
+}
+a:focus,
+a:hover {
+  color: #050;
+}
+
+#apicontent a.mark,
+#apicontent a.mark:active {
+  float: right;
+  color: #BBB;
+  font-size: 0.7cm;
+  text-decoration: none;
+}
+#apicontent a.mark:focus,
+#apicontent a.mark:hover {
+  color: #AAA;
+}
+
+#apicontent code {
+  padding: 1px;
+  background-color: #EEE;
+  border-radius: 4px;
+  border: 1px solid #DDD;
+}
+#apicontent pre>code {
+  display: block;
+  overflow: auto;
+  padding: 5px;
+}
\ No newline at end of file
diff --git a/doc/template.html b/doc/template.html
index edc0af662..6416da943 100644
--- a/doc/template.html
+++ b/doc/template.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8">
   <title>__SECTION__ - Etherpad Lite v__VERSION__ Manual &amp; Documentation</title>
-  <link rel="stylesheet" href="style.css">
+  <link rel="stylesheet" href="_assets/style.css">
 </head>
 <body class="apidoc" id="api-section-__FILENAME__">
   <header id="header">

From e447a6fade15ed2df53fef3e5845c134232306b8 Mon Sep 17 00:00:00 2001
From: Marcel Klehr <mklehr@gmx.net>
Date: Sun, 28 Oct 2012 18:02:49 +0100
Subject: [PATCH 16/17] Make sure npm is initialized before requiring things
 (fix #1092)

---
 src/node/server.js | 44 +++++++++++++++++++++++++++++++-------------
 1 file changed, 31 insertions(+), 13 deletions(-)

diff --git a/src/node/server.js b/src/node/server.js
index b91b0e17c..327fa166f 100755
--- a/src/node/server.js
+++ b/src/node/server.js
@@ -21,31 +21,49 @@
  * limitations under the License.
  */
 
+var log4js = require('log4js')
+  , async = require('async')
+  ;
+
 // set up logger
-var log4js = require('log4js');
 log4js.replaceConsole();
 
-var settings = require('./utils/Settings');
-
-//set loglevel
-log4js.setGlobalLogLevel(settings.loglevel);
-
-var db = require('./db/DB');
-var async = require('async');
-var plugins = require("ep_etherpad-lite/static/js/pluginfw/plugins");
-var hooks = require("ep_etherpad-lite/static/js/pluginfw/hooks");
+var settings
+  , db
+  , plugins
+  , hooks;
 var npm = require("npm/lib/npm.js");
 
-hooks.plugins = plugins;
-
 async.waterfall([
+  // load npm
+  function(callback) {
+    npm.load({}, function(er) {
+      callback(er)
+    })
+  },
+  
+  // load everything
+  function(callback) {
+    settings = require('./utils/Settings');
+    db = require('./db/DB');
+    plugins = require("ep_etherpad-lite/static/js/pluginfw/plugins");
+    hooks = require("ep_etherpad-lite/static/js/pluginfw/hooks");
+    hooks.plugins = plugins;
+
+    //set loglevel
+    log4js.setGlobalLogLevel(settings.loglevel);
+    callback();
+  },
+  
   //initalize the database
   function (callback)
   {
     db.init(callback);
   },
 
-  plugins.update,
+  function(callback) {
+    plugins.update(callback)
+  },
 
   function (callback) {
     console.info("Installed plugins: " + plugins.formatPlugins());

From 78e64ffea8b97be6a0b9267e22334713b297236a Mon Sep 17 00:00:00 2001
From: Marcel Klehr <mklehr@gmx.net>
Date: Sun, 28 Oct 2012 18:34:20 +0100
Subject: [PATCH 17/17] Mimic, replace or work around removed npm utils.

---
 src/package.json                         |  1 +
 src/static/js/pluginfw/installer.js      |  9 +++++++--
 src/static/js/pluginfw/plugins.js        |  2 --
 src/static/js/pluginfw/read-installed.js | 19 ++++++++++++++++---
 4 files changed, 24 insertions(+), 7 deletions(-)

diff --git a/src/package.json b/src/package.json
index e4e9b9c35..c3c4968a6 100644
--- a/src/package.json
+++ b/src/package.json
@@ -27,6 +27,7 @@
                       "jsdom-nocontextifiy" : "0.2.10",
                       "async-stacktrace"    : "0.0.2",
                       "npm"                 : "1.1.x",
+                      "npm-registry-client" : "0.2.10",
                       "ejs"                 : "0.6.1",
                       "graceful-fs"         : "1.1.5",
                       "slide"               : "1.1.3",
diff --git a/src/static/js/pluginfw/installer.js b/src/static/js/pluginfw/installer.js
index e7c6fb809..d668e549e 100644
--- a/src/static/js/pluginfw/installer.js
+++ b/src/static/js/pluginfw/installer.js
@@ -1,7 +1,12 @@
 var plugins = require("ep_etherpad-lite/static/js/pluginfw/plugins");
 var hooks = require("ep_etherpad-lite/static/js/pluginfw/hooks");
 var npm = require("npm");
-var registry = require("npm/lib/utils/npm-registry-client/index.js");
+var RegClient = require("npm-registry-client")
+
+var registry = new RegClient(
+{ registry: "http://registry.npmjs.org"
+, cache: npm.cache }
+);
 
 var withNpm = function (npmfn, final, cb) {
   npm.load({}, function (er) {
@@ -72,7 +77,7 @@ exports.search = function(query, cache, cb) {
           cb(null, exports.searchCache);
         } else {
           registry.get(
-            "/-/all", null, 600, false, true,
+            "/-/all", 600, false, true,
             function (er, data) {
               if (er) return cb(er);
               exports.searchCache = data;
diff --git a/src/static/js/pluginfw/plugins.js b/src/static/js/pluginfw/plugins.js
index 12ba94a27..e02c1331a 100644
--- a/src/static/js/pluginfw/plugins.js
+++ b/src/static/js/pluginfw/plugins.js
@@ -1,7 +1,5 @@
 var npm = require("npm/lib/npm.js");
 var readInstalled = require("./read-installed.js");
-var relativize = require("npm/lib/utils/relativize.js");
-var readJson = require("npm/lib/utils/read-json.js");
 var path = require("path");
 var async = require("async");
 var fs = require("fs");
diff --git a/src/static/js/pluginfw/read-installed.js b/src/static/js/pluginfw/read-installed.js
index cc03b3579..800ee32cd 100644
--- a/src/static/js/pluginfw/read-installed.js
+++ b/src/static/js/pluginfw/read-installed.js
@@ -94,8 +94,21 @@ var npm = require("npm/lib/npm.js")
   , path = require("path")
   , asyncMap = require("slide").asyncMap
   , semver = require("semver")
-  , readJson = require("npm/lib/utils/read-json.js")
-  , log = require("npm/lib/utils/log.js")
+  , log = require("log4js").getLogger('pluginfw')
+
+function readJson(file, callback) {
+  fs.readFile(file, function(er, buf) {
+    if(er) {
+      callback(er);
+      return;
+    }
+    try {
+      callback( null, JSON.parse(buf.toString()) )
+    } catch(er) {
+      callback(er)
+    }
+  })
+}
 
 module.exports = readInstalled
 
@@ -274,7 +287,7 @@ function findUnmet (obj) {
       }
 
     })
-  log.verbose([obj._id], "returning")
+  log.debug([obj._id], "returning")
   return obj
 }
 
