Merge pull request #557 from redhog/master

Templating system built on top of EJS and plugin installer

src/node/db/Pad.js

@@ -15,6 +15,11 @@ var padManager = require("./PadManager");
 var padMessageHandler = require("../handler/PadMessageHandler");
 var readOnlyManager = require("./ReadOnlyManager");
 var crypto = require("crypto");
+var randomString = require("../utils/randomstring");
+
+//serialization/deserialization attributes
+var attributeBlackList = ["id"];
+var jsonableList = ["pool"];
 
 /**
  * Copied from the Etherpad source code. It converts Windows line breaks to Unix line breaks and convert Tabs to spaces
@@ -34,7 +39,7 @@ var Pad = function Pad(id) {
   this.publicStatus = false;
   this.passwordHash = null;
   this.id = id;
-
+  this.savedRevisions = [];
 };
 
 exports.Pad = Pad;
@@ -75,15 +80,28 @@ Pad.prototype.appendRevision = function appendRevision(aChangeset, author) {
     newRevData.meta.atext = this.atext;
   }
 
-  db.set("pad:"+this.id+":revs:"+newRev, newRevData);
-  db.set("pad:"+this.id, {atext: this.atext,
-                          pool: this.pool.toJsonable(),
-                          head: this.head,
-                          chatHead: this.chatHead,
-                          publicStatus: this.publicStatus,
-                          passwordHash: this.passwordHash});
+  db.set("pad:"+this.id+":revs:"+newRev, newRevData);             
+  this.saveToDatabase();
 };
 
+//save all attributes to the database
+Pad.prototype.saveToDatabase = function saveToDatabase(){
+  var dbObject = {};
+  
+  for(var attr in this){
+    if(typeof this[attr] === "function") continue;
+    if(attributeBlackList.indexOf(attr) !== -1) continue;
+    
+    dbObject[attr] = this[attr];
+    
+    if(jsonableList.indexOf(attr) !== -1){
+      dbObject[attr] = dbObject[attr].toJsonable();
+    }
+  }
+  
+  db.set("pad:"+this.id, dbObject);
+}
+
 Pad.prototype.getRevisionChangeset = function getRevisionChangeset(revNum, callback) {
   db.getSub("pad:"+this.id+":revs:"+revNum, ["changeset"], callback);
 };
@@ -200,11 +218,10 @@ Pad.prototype.setText = function setText(newText) {
 };
 
 Pad.prototype.appendChatMessage = function appendChatMessage(text, userId, time) {
-      this.chatHead++;
-      //save the chat entry in the database
-      db.set("pad:"+this.id+":chat:"+this.chatHead, {"text": text, "userId": userId, "time": time});
-      //save the new chat head
-      db.setSub("pad:"+this.id, ["chatHead"], this.chatHead);
+  this.chatHead++;
+  //save the chat entry in the database
+  db.set("pad:"+this.id+":chat:"+this.chatHead, {"text": text, "userId": userId, "time": time});
+  this.saveToDatabase();
 };
 
 Pad.prototype.getChatMessage = function getChatMessage(entryNum, callback) {
@@ -324,27 +341,14 @@ Pad.prototype.init = function init(text, callback) {
     //if this pad exists, load it
     if(value != null)
     {
-      _this.head = value.head;
-      _this.atext = value.atext;
-      _this.pool = _this.pool.fromJsonable(value.pool);
-
-      //ensure we have a local chatHead variable
-      if(value.chatHead != null)
-        _this.chatHead = value.chatHead;
-      else
-        _this.chatHead = -1;
-
-      //ensure we have a local publicStatus variable
-      if(value.publicStatus != null)
-        _this.publicStatus = value.publicStatus;
-      else
-        _this.publicStatus = false;
-
-      //ensure we have a local passwordHash variable
-      if(value.passwordHash != null)
-        _this.passwordHash = value.passwordHash;
-      else
-        _this.passwordHash = null;
+      //copy all attr. To a transfrom via fromJsonable if necassary
+      for(var attr in value){
+        if(jsonableList.indexOf(attr) !== -1){
+          _this[attr] = _this[attr].fromJsonable(value[attr]);
+        } else {
+          _this[attr] = value[attr];
+        }
+      }
     }
     //this pad doesn't exist, so create it
     else
@@ -452,12 +456,12 @@ Pad.prototype.remove = function remove(callback) {
     //set in db
 Pad.prototype.setPublicStatus = function setPublicStatus(publicStatus) {
   this.publicStatus = publicStatus;
-  db.setSub("pad:"+this.id, ["publicStatus"], this.publicStatus);
+  this.saveToDatabase();
 };
 
 Pad.prototype.setPassword = function setPassword(password) {
   this.passwordHash = password == null ? null : hash(password, generateSalt());
-  db.setSub("pad:"+this.id, ["passwordHash"], this.passwordHash);
+  this.saveToDatabase();
 };
 
 Pad.prototype.isCorrectPassword = function isCorrectPassword(password) {
@@ -468,6 +472,31 @@ Pad.prototype.isPasswordProtected = function isPasswordProtected() {
   return this.passwordHash != null;
 };
 
+Pad.prototype.addSavedRevision = function addSavedRevision(revNum, savedById, label) {
+  //if this revision is already saved, return silently
+  for(var i in this.savedRevisions){
+    if(this.savedRevisions.revNum === revNum){
+      return;
+    }
+  }
+  
+  //build the saved revision object
+  var savedRevision = {};
+  savedRevision.revNum = revNum;
+  savedRevision.savedById = savedById;
+  savedRevision.label = label || "Revision " + revNum;
+  savedRevision.timestamp = new Date().getTime();
+  savedRevision.id = randomString(10);
+  
+  //save this new saved revision
+  this.savedRevisions.push(savedRevision);
+  this.saveToDatabase();
+};
+
+Pad.prototype.getSavedRevisions = function getSavedRevisions() {
+  return this.savedRevisions;
+};
+
 /* Crypto helper methods */
 
 function hash(password, salt)

src/node/eejs/examples/bar.ejs

@@ -0,0 +1,9 @@
+a
+<% e.begin_block("bar"); %>
+  A
+  <% e.begin_block("foo"); %>
+  XX
+  <% e.end_block(); %>
+  B
+<% e.end_block(); %>
+b

src/node/eejs/examples/foo.ejs

@@ -0,0 +1,7 @@
+<% e.inherit("./bar.ejs"); %>
+
+<% e.begin_define_block("foo"); %>
+  YY
+  <% e.super(); %>
+  ZZ
+<% e.end_define_block(); %>

src/node/eejs/index.js

@@ -0,0 +1,115 @@
+/*
+ * Copyright (c) 2011 RedHog (Egil Möller) <egil.moller@freecode.no>
+ *
+ * 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.
+ */
+
+/* Basic usage:
+ *
+ * require("./index").require("./examples/foo.ejs")
+ */
+
+var ejs = require("ejs");
+var fs = require("fs");
+var path = require("path");
+var hooks = require("ep_etherpad-lite/static/js/pluginfw/hooks.js");
+
+exports.info = {
+  buf_stack: [],
+  block_stack: [],
+  blocks: {},
+  file_stack: [],
+};
+
+exports._init = function (b, recursive) {
+  exports.info.buf_stack.push(exports.info.buf);
+  exports.info.buf = b;
+}
+
+exports._exit = function (b, recursive) {
+  exports.info.file_stack[exports.info.file_stack.length-1].inherit.forEach(function (item) {
+    exports._require(item.name, item.args);
+  });
+  exports.info.buf = exports.info.buf_stack.pop();
+}
+
+exports.begin_capture = function() {
+  exports.info.buf_stack.push(exports.info.buf.concat());
+  exports.info.buf.splice(0, exports.info.buf.length);
+}
+
+exports.end_capture = function () {
+  var res = exports.info.buf.join("");
+  exports.info.buf.splice.apply(
+    exports.info.buf,
+    [0, exports.info.buf.length].concat(exports.info.buf_stack.pop()));
+  return res;
+}
+
+exports.begin_define_block = function (name) {
+  if (typeof exports.info.blocks[name] == "undefined")
+    exports.info.blocks[name] = {};
+  exports.info.block_stack.push(name);
+  exports.begin_capture();
+}
+
+exports.super = function () {
+  exports.info.buf.push('<!eejs!super!>');
+}
+
+exports.end_define_block = function () {
+  content = exports.end_capture();
+  var name = exports.info.block_stack.pop();
+  if (typeof exports.info.blocks[name].content == "undefined")
+    exports.info.blocks[name].content = content;
+  else if (typeof exports.info.blocks[name].content.indexOf('<!eejs!super!>'))
+    exports.info.blocks[name].content = exports.info.blocks[name].content.replace('<!eejs!super!>', content);
+
+  return exports.info.blocks[name].content;
+}
+
+exports.end_block = function () {
+  var name = exports.info.block_stack[exports.info.block_stack.length-1];
+  var args = {content: exports.end_define_block()};
+  hooks.callAll("eejsBlock_" + name, args);
+  exports.info.buf.push(args.content);
+}
+
+exports.begin_block = exports.begin_define_block;
+
+exports.inherit = function (name, args) {
+    exports.info.file_stack[exports.info.file_stack.length-1].inherit.push({name:name, args:args});
+}
+
+exports.require = function (name, args) {
+  if (args == undefined) args = {};
+ 
+  if ((name.indexOf("./") == 0 || name.indexOf("../") == 0) && exports.info.file_stack.length) {
+      name = path.join(path.dirname(exports.info.file_stack[exports.info.file_stack.length-1].path), name);
+  }
+  var ejspath = require.resolve(name)
+
+  args.e = exports;
+  args.require = require;
+  var template = '<% e._init(buf); %>' + fs.readFileSync(ejspath).toString() + '<% e._exit(); %>';
+
+  exports.info.file_stack.push({path: ejspath, inherit: []});
+  var res = ejs.render(template, args);
+  exports.info.file_stack.pop();
+
+  return res;
+}
+
+exports._require = function (name, args) {
+  exports.info.buf.push(exports.require(name, args));
+}

src/node/handler/PadMessageHandler.js

@@ -190,6 +190,11 @@ exports.handleMessage = function(client, message)
   {
     handleChatMessage(client, message);
   }
+  else if(message.type == "COLLABROOM" && 
+          message.data.type == "SAVE_REVISION")
+  {
+    handleSaveRevisionMessage(client, message);
+  }
   else if(message.type == "COLLABROOM" && 
           message.data.type == "CLIENT_MESSAGE" &&
           message.data.payload.type == "suggestUserName")
@@ -203,6 +208,23 @@ exports.handleMessage = function(client, message)
   }
 }
 
+/**
+ * Handles a save revision message
+ * @param client the client that send this message
+ * @param message the message from the client
+ */
+function handleSaveRevisionMessage(client, message){
+  var padId = session2pad[client.id];
+  var userId = sessioninfos[client.id].author;
+  
+  padManager.getPad(padId, function(err, pad)
+  {
+    if(ERR(err)) return;
+    
+    pad.addSavedRevision(pad.head, userId);
+  });
+}
+
 /**
  * Handles a Chat Message
  * @param client the client that send this message

src/node/handler/TimesliderMessageHandler.js

@@ -166,6 +166,7 @@ function createTimesliderClientVars (padId, callback)
     hooks: [],
     initialStyledContents: {}
   };
+  
   var pad;
   var initialChangesets = [];
 
@@ -180,6 +181,12 @@ function createTimesliderClientVars (padId, callback)
         callback();
       });
     },
+    //get all saved revisions and add them
+    function(callback)
+    {
+      clientVars.savedRevisions = pad.getSavedRevisions();
+      callback();
+    },
     //get all authors and add them to 
     function(callback)
     {

src/node/hooks/express/adminplugins.js

@@ -0,0 +1,51 @@
+var path = require('path');
+var eejs = require('ep_etherpad-lite/node/eejs');
+var installer = require('ep_etherpad-lite/static/js/pluginfw/installer');
+var plugins = require('ep_etherpad-lite/static/js/pluginfw/plugins');
+
+exports.expressCreateServer = function (hook_name, args, cb) {
+  args.app.get('/admin/plugins', function(req, res) {
+    var plugins = require("ep_etherpad-lite/static/js/pluginfw/plugins");
+    var render_args = {
+      plugins: plugins.plugins,
+      search_results: {},
+      errors: [],
+    };
+
+    res.send(eejs.require(
+      "ep_etherpad-lite/templates/admin/plugins.html",
+      render_args), {});
+  });
+}
+
+exports.socketio = function (hook_name, args, cb) {
+  var io = args.io.of("/pluginfw/installer");
+  io.on('connection', function (socket) {
+    socket.on("load", function (query) {
+      socket.emit("installed-results", {results: plugins.plugins});
+    });
+
+    socket.on("search", function (query) {
+      socket.emit("progress", {progress:0, message:'Fetching results...'});
+      installer.search(query, function (progress) {
+        if (progress.results)
+          socket.emit("search-result", progress);
+        socket.emit("progress", progress);
+      });
+    });
+
+    socket.on("install", function (plugin_name) {
+      socket.emit("progress", {progress:0, message:'Downloading and installing ' + plugin_name + "..."});
+      installer.install(plugin_name, function (progress) {
+        socket.emit("progress", progress);
+      });
+    });
+
+    socket.on("uninstall", function (plugin_name) {
+      socket.emit("progress", {progress:0, message:'Uninstalling ' + plugin_name + "..."});
+      installer.uninstall(plugin_name, function (progress) {
+        socket.emit("progress", progress);
+      });
+    });
+  });
+}

src/node/hooks/express/specialpages.js

@@ -1,12 +1,12 @@
 var path = require('path');
+var eejs = require('ep_etherpad-lite/node/eejs');
 
 exports.expressCreateServer = function (hook_name, args, cb) {
 
   //serve index.html under /
   args.app.get('/', function(req, res)
   {
-    var filePath = path.normalize(__dirname + "/../../../static/index.html");
-    res.sendfile(filePath, { maxAge: exports.maxAge });
+    res.send(eejs.require("ep_etherpad-lite/templates/index.html"), { maxAge: exports.maxAge });
   });
 
   //serve robots.txt
@@ -34,15 +34,13 @@ exports.expressCreateServer = function (hook_name, args, cb) {
   //serve pad.html under /p
   args.app.get('/p/:pad', function(req, res, next)
   {    
-    var filePath = path.normalize(__dirname + "/../../../static/pad.html");
-    res.sendfile(filePath, { maxAge: exports.maxAge });
+    res.send(eejs.require("ep_etherpad-lite/templates/pad.html"), { maxAge: exports.maxAge });
   });
 
   //serve timeslider.html under /p/$padname/timeslider
   args.app.get('/p/:pad/timeslider', function(req, res, next)
   {
-    var filePath = path.normalize(__dirname + "/../../../static/timeslider.html");
-    res.sendfile(filePath, { maxAge: exports.maxAge });
+    res.send(eejs.require("ep_etherpad-lite/templates/timeslider.html"), { maxAge: exports.maxAge });
   });
 
 }

src/node/hooks/express/webaccess.js

@@ -6,11 +6,19 @@ var settings = require('../../utils/Settings');
 
 //checks for basic http auth
 exports.basicAuth = function (req, res, next) {
+  var pass = settings.httpAuth;
+  if (req.path.indexOf('/admin') == 0) {
+    var pass = settings.adminHttpAuth;
+  }
+  // Just pass if not activated in Activate http basic auth if it has been defined in settings.json
+  if (!pass) {
+    return next();
+  }
+
   if (req.headers.authorization && req.headers.authorization.search('Basic ') === 0) {
     // fetch login and password
-    if (new Buffer(req.headers.authorization.split(' ')[1], 'base64').toString() == settings.httpAuth) {
-      next();
-      return;
+    if (new Buffer(req.headers.authorization.split(' ')[1], 'base64').toString() == pass) {
+      return next();
     }
   }
 
@@ -25,8 +33,7 @@ exports.basicAuth = function (req, res, next) {
 }
 
 exports.expressConfigure = function (hook_name, args, cb) {
-  // Activate http basic auth if it has been defined in settings.json
-  if(settings.httpAuth != null) args.app.use(exports.basicAuth);
+  args.app.use(exports.basicAuth);
 
   // If the log level specified in the config file is WARN or ERROR the application server never starts listening to requests as reported in issue #158.
   // Not installing the log4js connect logger when the log level has a higher severity than INFO since it would not log at that level anyway.

src/node/utils/Minify.js

@@ -29,7 +29,6 @@ var pro = require("uglify-js").uglify;
 var path = require('path');
 var plugins = require("ep_etherpad-lite/static/js/pluginfw/plugins");
 var RequireKernel = require('require-kernel');
-var server = require('../server');
 
 var ROOT_DIR = path.normalize(__dirname + "/../../static/");
 var TAR_PATH = path.join(__dirname, 'tar.json');
@@ -109,10 +108,10 @@ exports.minify = function(req, res, next)
       date = new Date(date);
       res.setHeader('last-modified', date.toUTCString());
       res.setHeader('date', (new Date()).toUTCString());
-      if (server.maxAge) {
-        var expiresDate = new Date((new Date()).getTime()+server.maxAge*1000);
+      if (settings.maxAge) {
+        var expiresDate = new Date((new Date()).getTime()+settings.maxAge*1000);
         res.setHeader('expires', expiresDate.toUTCString());
-        res.setHeader('cache-control', 'max-age=' + server.maxAge);
+        res.setHeader('cache-control', 'max-age=' + settings.maxAge);
       }
     }
 

src/node/utils/Settings.js

@@ -85,6 +85,11 @@ exports.loglevel = "INFO";
  */
 exports.httpAuth = null;
 
+/**
+ * Http basic auth, with "user:password" format
+ */
+exports.adminHttpAuth = null;
+
 //checks if abiword is avaiable
 exports.abiwordAvailable = function()
 {

src/node/utils/caching_middleware.js

@@ -18,13 +18,11 @@ var async = require('async');
 var Buffer = require('buffer').Buffer;
 var fs = require('fs');
 var path = require('path');
-var server = require('../server');
 var zlib = require('zlib');
 var util = require('util');
+var settings = require('./Settings');
 
-var ROOT_DIR = path.normalize(__dirname + "/../");
-var CACHE_DIR = path.normalize(ROOT_DIR + '../../var/');
-console.log(CACHE_DIR)
+var CACHE_DIR = path.normalize(path.join(settings.root, 'var/'));
 CACHE_DIR = path.existsSync(CACHE_DIR) ? CACHE_DIR : undefined;
 
 var responseCache = {};

src/node/utils/randomstring.js

@@ -0,0 +1,16 @@
+/**
+ * Generates a random String with the given length. Is needed to generate the Author, Group, readonly, session Ids
+ */
+var randomString = function randomString(len)
+{
+  var chars = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
+  var randomstring = '';
+  for (var i = 0; i < len; i++)
+  {
+    var rnum = Math.floor(Math.random() * chars.length);
+    randomstring += chars.substring(rnum, rnum + 1);
+  }
+  return randomstring;
+};
+
+module.exports = randomString;

src/node/utils/tar.json

@@ -22,7 +22,6 @@
   , "chat.js"
   , "excanvas.js"
   , "farbtastic.js"
-  , "prefixfree.js"
   ]
 , "timeslider.js": [
     "jquery.js"