Merge branch 'master' into 'master'

« éditer » remplacé par « modifier »

See merge request !1

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2016 Luc Didry
+
+   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.

README.md

@@ -8,25 +8,22 @@ Install the plugin and put this in your `settings.json`:
 
     "ep_delete_after_delay": {
         "delay": 86400, // one day, in seconds
+        "loop": true,
+        "loopDelay": 3600, // one hour, in seconds
+        "deleteAtStart": true,
         "text": "The content of this pad has been deleted since it was older than the configured delay."
     },
 
-`delay` (mandatory) is in seconds. You can't put `7*86400` for a week, you have to put `604800`.
+`delay` (mandatory) delay in seconds with no edition of the pad before deletion. You can't put `7*86400` for a week, you have to put `604800`.
+
+`loop` binary, tells if you want to use deletion loops (`true`) or not (`false`) (if you use [an external script](https://framagit.org/framasoft/pad_delete_after_delay) for example). Default is true.
+
+`loopDelay` delay in seconds between deletion loops. Deletion loop will check all pads to see if they have to be deleted. You can't put `60*60` for a hour, you have to put `3600`. Default is one hour.
+
+`deleteAtStart` binary, tells if you want to start a deletion loop at Etherpad startup. Default is true.
 
 `text` is the text that will replace the deleted pad's content. Default is what is in the example above.
 
 ## License
 
-Copyright 2015 Luc Didry
+Apache License, Version 2.0. See [LICENSE file](LICENSE)
-
-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.

delete.js

@@ -1,7 +1,12 @@
 var eejs              = require('ep_etherpad-lite/node/eejs/'),
+    API               = require('ep_etherpad-lite/node/db/API'),
     padManager        = require('ep_etherpad-lite/node/db/PadManager'),
-    padMessageHandler = require("../../src/node/handler/PadMessageHandler"),
+    padMessageHandler = require('ep_etherpad-lite/node/handler/PadMessageHandler'),
-    settings          = require('../../src/node/utils/Settings');
+    settings          = require('ep_etherpad-lite/node/utils/Settings'),
+    async             = require('ep_etherpad-lite/node_modules/async'),
+    fs                = require('fs');
+
+fs.mkdir('deleted_pads', function(err) {});
 
 // Add client code
 exports.eejsBlock_scripts = function (hook_name, args, cb) {
@@ -10,18 +15,117 @@ exports.eejsBlock_scripts = function (hook_name, args, cb) {
 
 // Get settings
 var areParamsOk = (settings.ep_delete_after_delay) ? true : false,
-    delay, replaceText;
+    delay, replaceText, loopDelay, deleteAtStart;
 if (areParamsOk) {
     delay         = settings.ep_delete_after_delay.delay;
+    loop          = (settings.ep_delete_after_delay.loop !== undefined) ? settings.ep_delete_after_delay.loop : true;
+    loopDelay     = settings.ep_delete_after_delay.loopDelay || 3600;
+    deleteAtStart = (settings.ep_delete_after_delay.deleteAtStart !== undefined) ? settings.ep_delete_after_delay.deleteAtStart : true;
     replaceText   = settings.ep_delete_after_delay.text || "The content of this pad has been deleted since it was older than the configured delay.";
     areParamsOk   = (typeof delay === 'number' && delay > 0) ? true : false;
     if (areParamsOk === false) {
         console.error('ep_delete_after_delay.delay must be a number an not negative! Check you settings.json.');
     }
+    areParamsOk = (typeof loopDelay === 'number' && loopDelay > 0) ? true : false;
+    if (areParamsOk === false) {
+        console.error('ep_delete_after_delay.loopDelay must be a number an not negative! Check you settings.json.');
+    }
 } else {
     console.error('You need to configure ep_delete_after_delay in your settings.json!');
 }
 
+// Recurring deletion function
+var waitForIt = function() {
+    setTimeout(function() {
+        console.info('New loop');
+        delete_old_pads();
+        waitForIt();
+    }, loopDelay * 1000);
+};
+
+// Delete old pads at startup
+if (deleteAtStart) {
+    delete_old_pads();
+}
+
+// start the recurring deletion loop
+if (loop) {
+    waitForIt();
+}
+
+// deletion loop
+function delete_old_pads() {
+    // Deletion queue (avoids max stack size error), 2 workers
+    var q = async.queue(function (pad, callback) {
+        API.getHTML(pad.id, function(err, d) {
+            if (err) {
+                return callback(err);
+            }
+            var currentTime = (new Date).getTime();
+            fs.writeFile('deleted_pads/'+pad.id+'-'+currentTime+'.html', d.html, function(err) {
+                pad.remove(callback);
+            });
+        });
+    }, 2);
+    // Emptyness test queue
+    var p = async.queue(function(padId, callback) {
+        padManager.getPad(padId, function(err, pad) {
+            // If this is a new pad, there's nothing to do
+            var head = pad.getHeadRevisionNumber();
+            if (head !== null  && head !== undefined && head !== 0) {
+                pad.getLastEdit(function(callback, timestamp) {
+                    if (timestamp !== undefined && timestamp !== null) {
+                        var currentTime = (new Date).getTime();
+                        // Are we over delay?
+                        if ((currentTime - timestamp) > (delay * 1000)) {
+                            console.debug('Pushing %s to q queue', pad.id);
+                            // Remove pad
+                            q.push(pad, function (err) {
+                                console.info('Pad '+pad.id+' deleted since expired (delay: '+delay+' seconds, last edition: '+timestamp+').');
+                                // Create new pad with an explanation
+                                padManager.getPad(padId, replaceText, function() {
+                                    // Create disconnect message
+                                    var msg = {
+                                        type: "COLLABROOM",
+                                        data: {
+                                            type: "CUSTOM",
+                                            payload: {
+                                                authorId: null,
+                                                action: "requestRECONNECT",
+                                                padId: padId
+                                            }
+                                        }
+                                    };
+                                    // Send disconnect message to all clients
+                                    var sessions = padMessageHandler.sessioninfos;
+                                    Object.keys(sessions).forEach(function(key){
+                                        var session = sessions[key];
+                                        padMessageHandler.handleCustomObjectMessage(msg, false, function(){
+                                            // TODO: Error handling
+                                        }); // Send a message to this session
+                                    });
+                                });
+                            });
+                        } else {
+                            console.debug('Nothing to do with '+padId+' (not expired)');
+                        }
+                    }
+                });
+            } else {
+                console.debug('New or empty pad '+padId);
+            }
+            callback();
+        });
+    }, 1);
+    padManager.listAllPads(function (err, data) {
+        for (var i = 0; i < data.padIDs.length; i++) {
+            var padId = data.padIDs[i];
+            console.debug('Pushing %s to p queue', padId);
+            p.push(padId, function (err) { });
+        }
+    });
+}
+
 exports.handleMessage = function(hook_name, context, cb) {
     if (areParamsOk === false) return false;
 
@@ -30,7 +134,7 @@ exports.handleMessage = function(hook_name, context, cb) {
     if (type === 'CLIENT_READY' || type === 'COLLABROOM') {
         var padId = (type === 'CLIENT_READY') ? message.padId : context.client.rooms[1];
         padManager.getPad(padId, function(callback, pad) {
-            //
+
             // If this is a new pad, there's nothing to do
             if (pad.getHeadRevisionNumber() !== 0) {
 
@@ -41,13 +145,20 @@ exports.handleMessage = function(hook_name, context, cb) {
                         // Are we over delay?
                         if ((currentTime - timestamp) > (delay * 1000)) {
 
+                            API.getHTML(padId, function(err, d) {
+                                if (err) {
+                                    return cb(err);
+                                }
+                                fs.writeFile('deleted_pads/'+padId+'-'+currentTime+'.html', d.html, function(err) {
+                                    if (err) {
+                                        return cb(err);
+                                    }
                                     // Remove pad
                                     padManager.removePad(padId);
                                     console.info('Pad '+padId+' deleted since expired (delay: '+delay+' seconds, last edition: '+timestamp+').');
 
                                     // Create new pad with an explanation
                                     padManager.getPad(padId, replaceText, function() {
-                                if (type === 'COLLABROOM') {
                                         // Create disconnect message
                                         var msg = {
                                             type: "COLLABROOM",
@@ -68,11 +179,14 @@ exports.handleMessage = function(hook_name, context, cb) {
                                                 // TODO: Error handling
                                             }); // Send a message to this session
                                         });
+                                        if (type === 'COLLABROOM') {
                                             cb(null);
                                         } else {
                                             cb();
                                         }
                                     });
+                                });
+                            });
                         } else {
                             console.info('Nothing to do with '+padId+' (not expired)');
                             cb();
@@ -89,6 +203,30 @@ exports.handleMessage = function(hook_name, context, cb) {
     }
 };
 
-// Send
+exports.registerRoute  = function (hook_name, args, cb) {
-function sendToTarget(message, msg){
+    args.app.get('/ttl/:pad', function(req, res, next) {
+        var padId = req.params.pad;
+
+        res.header("Access-Control-Allow-Origin", "*");
+        res.setHeader('Content-Type', 'application/json');
+
+        padManager.getPad(padId, function(callback, pad) {
+
+            // If this is a new pad, there's nothing to do
+            if (pad.getHeadRevisionNumber() !== 0) {
+
+                pad.getLastEdit(function(callback, timestamp) {
+                    if (timestamp !== undefined && timestamp !== null) {
+                        var currentTime = (new Date).getTime();
+
+                        var ttl = Math.floor((delay * 1000 - (currentTime - timestamp))/1000);
+                        res.send('{"ttl": '+ttl+'}');
+                    }
+                });
+            } else {
+                res.send('{"ttl": null, "msg": "New or empty pad"}');
+            }
+            cb && cb();
+        });
+    });
 }

ep.json

@@ -4,10 +4,12 @@
             "name": "ep_delete_after_delay",
             "hooks": {
                 "handleMessage" : "ep_delete_after_delay/delete",
-                "eejsBlock_scripts": "ep_delete_after_delay/delete"
+                "eejsBlock_scripts": "ep_delete_after_delay/delete",
+                "expressCreateServer" : "ep_delete_after_delay/delete:registerRoute"
             },
             "client_hooks": {
-                "handleClientMessage_CUSTOM":"ep_delete_after_delay/static/js/reconnect"
+                "handleClientMessage_CUSTOM":"ep_delete_after_delay/static/js/reconnect",
+                "documentReady": "ep_delete_after_delay/static/js/reconnect"
             }
         }
     ]

locales/en.json

@@ -0,0 +1,9 @@
+{
+    "ep_delete_after_delay.warning": "× WARNING!",
+    "ep_delete_after_delay.reload": "The pad has expired. The page will be reloaded in 5 seconds.",
+    "ep_delete_after_delay.close": "× Delay before deletion",
+    "ep_delete_after_delay.days": "Without edition, your pad will be deleted in approximatively XXXX days.",
+    "ep_delete_after_delay.hours": "Without edition, your pad will be deleted in approximatively XXXX hours.",
+    "ep_delete_after_delay.minutes": "Without edition, your pad will be deleted in approximatively XXXX minutes.",
+    "ep_delete_after_delay.suggest": "I suggest you to either edit your pad or export it to save your work."
+}

locales/fr.json

@@ -0,0 +1,9 @@
+{
+    "ep_delete_after_delay.warning": "× ATTENTION !",
+    "ep_delete_after_delay.reload": "Le pad a expiré. La page sera rechargée dans 5 secondes.",
+    "ep_delete_after_delay.close": "× Délai avant suppression",
+    "ep_delete_after_delay.days": "Sans nouvelle modification, votre pad sera supprimé dans approximativement XXXX jours.",
+    "ep_delete_after_delay.hours": "Sans nouvelle modification, votre pad sera supprimé dans approximativement XXXX heures.",
+    "ep_delete_after_delay.minutes": "Sans nouvelle modification, votre pad sera supprimé dans approximativement XXXX minutes.",
+    "ep_delete_after_delay.suggest": "Je vous suggère de modifier votre pad ou de l'exporter pour sauvegarder votre travail."
+}

package.json

@@ -1,7 +1,7 @@
 
 {
     "name": "ep_delete_after_delay",
-    "version": "0.0.2",
+    "version": "0.0.7",
     "description": "Automatically deletes pads after a configured delay",
     "author": {
         "name": "Luc Didry",
@@ -14,7 +14,11 @@
     },
     "repository" : {
         "type" : "git",
-        "url" : "https://git.framasoft.org/luc/ep_delete_after_delay.git"
+        "url" : "https://framagit.org/luc/ep_delete_after_delay.git"
-    }
+    },
+    "bugs": {
+        "url" : "https://framagit.org/luc/ep_delete_after_delay/issues"
+    },
+    "license": "Apache-2.0"
 }
 

static/js/reconnect.js

@@ -1,8 +1,75 @@
-if(typeof exports == 'undefined'){
+/*
+ * Commented because it fix https://github.com/ldidry/ep_delete_after_delay/issues/1
+ * if(typeof exports == 'undefined'){
     var exports = this['mymodule'] = {};
+}*/
+
+var already_notified = false;
+var delay;
+
+function get_ttl(callback) {
+    $.ajax({
+        url: '../ttl/'+window.location.pathname.replace(/.*\/p\//, ''),
+        method: 'GET',
+        dataType: 'json',
+        success: function(data, textStatus, jqXHR) {
+            $('.ttl').remove();
+            if (data.ttl === null) {
+                delay = 1000;
+            }
+            if (data.ttl !== null && data.ttl > 0) {
+                var text, ttl;
+                if (data.ttl > 3600 * 24) {
+                    text  = window._('ep_delete_after_delay.days');
+                    ttl   = data.ttl/(3600 * 24);
+                    delay = 3500 * 1000;
+                } else if (data.ttl > 3600) {
+                    text  = window._('ep_delete_after_delay.hours');
+                    ttl   = data.ttl/3600;
+                    delay = 1800 * 1000; // 30 minutes
+                } else {
+                    text  = window._('ep_delete_after_delay.minutes');
+                    ttl   = data.ttl/60;
+                    delay = 600 * 1000 // 10 minutes
+                }
+                ttl  = Math.floor(ttl * 10)/10;
+                text = text.replace(/XXXX/, ttl);
+                $.gritter.add({
+                    class_name: 'ttl',
+                    title: window._('ep_delete_after_delay.close'),
+                    text: text+'<br>'+window._('ep_delete_after_delay.suggest'),
+                    sticky: true,
+                });
+            }
+        },
+        complete: function() {
+            callback(delay);
+        }
+    });
 }
+
+function timeout_ttl(delay) {
+    setTimeout(function() {
+        get_ttl(timeout_ttl);
+    }, delay);
+}
+
 exports.handleClientMessage_CUSTOM = function(hook, context, wut){
-    if(context.payload.action === 'requestRECONNECT'){
+    if(already_notified === false && context.payload && context.payload.action === 'requestRECONNECT'){
+        already_notified = true;
+        $.gritter.add({
+            title: window._('ep_delete_after_delay.warning'),
+            text: window._('ep_delete_after_delay.reload'),
+            sticky: true,
+        });
+        setTimeout(function() {
             window.location.reload();
+        }, 6000);
     }
 }
+
+exports.documentReady = function() {
+    setTimeout(function() {
+        get_ttl(timeout_ttl);
+    }, 1000);
+}