ep_small_list 0.4.0 → 0.6.0

package/README.md

@@ -8,3 +8,49 @@ A small script for [etherpad-lite](https://github.com/ether/etherpad-lite) which
 npm install ep_small_list
 ```
 Restart your etherpad-lite instance to recognice new addon.
+
+## Compatibility
+* Requires a minimum Node.js version of 7.10.1.
+
+## Configuration
+
+The plugin works without configuration. But there are several configuration settings available. In your `settings.json`, add:
+
+### Limit number of entries
+
+```json
+"ep_small_list": {
+  "limit": 10
+}
+```
+
+By default the number of entries is not limited ("limit": 0).
+
+### Sort by last change
+
+```json
+"ep_small_list": {
+  "sortmode": "lastchange"
+}
+```
+
+The following sorting modes are available:
+* "default": Use the order in which the API returns the pads (this is also the default sortmode).
+* "lastchange": Sort the pads by last change.
+
+### Reverse order
+
+```json
+"ep_small_list": {
+  "sortorder": "reverse"
+}
+```
+
+The following sorting orders are available:
+* "normal": Use the normal order generated by the choosen sortmode.
+* "reverse": Reverse the order generated by the choosen sortmode.
+
+
+## Features
+* Supports [ep\_set\_title\_on\_pad](https://github.com/JohnMcLear/ep_set_title_on_pad)
+

package/index.js

@@ -1,33 +1,141 @@
 var padManager = require('ep_etherpad-lite/node/db/PadManager');
-exports.eejsBlock_indexWrapper = function(hook_name, args, cb) {
-    args.content += '<div id="small_list"></div><script src="./static/js/jquery.js"></script><script>$(function () { $("#small_list").load("./small_list"); });</script>';
+var db = require('ep_etherpad-lite/node/db/DB').db;
+var settings = require('ep_etherpad-lite/node/utils/Settings');
+
+const sortmodes = {
+    DEFAULT: 'default',
+    LASTCHANGE: 'lastchange'
+}
+
+const sortorders = {
+    NORMAL: 'normal',
+    REVERSE: 'reverse'
+}
+
+
+var sortmode = sortmodes.DEFAULT;
+var sortorder = sortorders.NORMAL;
+var limit = 0;
+
+if (settings.ep_small_list) {
+    if (settings.ep_small_list.sortmode) {
+      sortmode = settings.ep_small_list.sortmode.trim().toLowerCase() === sortmodes.LASTCHANGE ? sortmodes.LASTCHANGE : sortmodes.DEFAULT;
+      console.log("ep_small_list setting sortmode: " + sortmode);
+    }
+    if (settings.ep_small_list.sortorder) {
+      sortorder = settings.ep_small_list.sortorder.trim().toLowerCase() === sortorders.REVERSE ? sortorders.REVERSE : sortorders.NORMAL;
+      console.log("ep_small_list setting sortorder: " + sortorder);
+    }
+    if (settings.ep_small_list.limit) {
+      let settingsValue = parseInt(settings.ep_small_list.limit, 10);
+      if(Number.isNaN(settingsValue) || !Number.isFinite(settingsValue) ||  settingsValue < 0){
+        settingsValue = 0;
+      }
+      limit = settingsValue;
+      console.log("ep_small_list setting limit: " + limit);
+    }
+}
+
+exports.eejsBlock_indexWrapper = function(hook_name, args) {
+    args.content += `
+        <div id="small_list"></div>
+        <script>
+          document.addEventListener('DOMContentLoaded', async function() {
+            const container = document.getElementById('small_list');
+            if (!container) return;
+
+            try {
+              const response = await fetch('./small_list');
+              if (!response.ok) {
+                throw new Error('HTTP ' + response.status);
+              }
+              container.innerHTML = await response.text();
+            } catch (error) {
+              console.error('ep_small_list:', error);
+            }
+          });
+        </script>
+    `;
 };
 
 exports.registerRoute = function(hook_name, args, cb) {
-    args.app.get("/small_list", function(req, res) {
-      var pads = padManager.listAllPads(function(err, data){
-        if(err){
-          return res.send("<div> Error:" + err + "</div>");
-        }
-        return res.send(createList(data));
+  args.app.get("/small_list", function(req, res) {
+    padManager.listAllPads().then(function(pads) {
+      createList(pads).then(function(html){
+        res.send(html);
       });
-      if(pads){
-        pads.then(function(data){
-          res.send(createList(data));
-        }).catch(function(err){
-            res.send("<div> Error:" + err + "</div>");
-        })
-      }
+    }).catch(function(err) {
+	res.send("<div> Error:" + err + "</div>"); 
     });
+  });
+  return cb();
 };
 
-function createList(data){
-  r = "<ul>";
+function escapeHtml(value) {
+    return String(value).replace(/[&<>"']/g, char => ({
+        '&': '&amp;',
+        '<': '&lt;',
+        '>': '&gt;',
+        '"': '&quot;',
+        "'": '&#39;'
+    })[char]);
+}
+
+async function createList(data){
+  let dataCache = [];
   if(data && data.padIDs){
     for (var i = 0; i < data.padIDs.length; i++) {
-        r += '<li><a href="./p/' + data.padIDs[i] + '">' + data.padIDs[i] + '</li>';
+      let padData = {};
+      let padID = data.padIDs[i];
+      let title = padID;
+
+      const pad = await padManager.getPad(padID);
+      if (!pad) {
+        continue;
+      }
+      const lastEdit = await pad.getLastEdit();
+      padData.lastChange = lastEdit;
+
+      // support custom titles from ep_set_title_on_pad.
+      try {
+        const storedTitle = await db.get("title:" + padID);
+        if (storedTitle) {
+          title = storedTitle;
+        }
+      } catch (err) {
+        console.error("ep_small_list: Could not read title for pad", padID, err);
+      }
+
+      padData.html = '<li><a href="./p/' +
+        encodeURIComponent(padID) + '">' +
+        escapeHtml(title) + '</a></li>';
+      padData.createIndex = i;
+
+      dataCache.push(padData);
     }
   }
+
+  dataCache.sort(function (a, b) {
+    let indicator = 0;
+    if(sortmode === sortmodes.DEFAULT) {
+      indicator = a.createIndex - b.createIndex;
+    } else {
+       // sortmodes.LASTCHANGE
+      indicator = a.lastChange - b.lastChange;
+    }
+    return indicator;
+  });
+  
+  if(sortorder === sortorders.REVERSE) {
+    dataCache.reverse();
+  }
+
+  if(limit > 0 && dataCache.length > limit) {
+    dataCache.length = limit;
+  }
+
+  let r = "<ul>";
+  r += dataCache.map(x => x.html).join("");
   r += "</ul>";
   return r;
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ep_small_list",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "Adds a list of all pads on the index-page",
   "main": "index.js",
   "scripts": {