Merge branch 'templates' into staging

customize.dist/application_config.js

@@ -32,6 +32,7 @@ define(function() {
         '#FF00C0', // hot pink
         '#800080', // purple
     ];
+    config.enableTemplates = true;
 
     return config;
 });

customize.dist/translations/messages.fr.js

@@ -75,6 +75,11 @@ define(function () {
     out.newButton = 'Nouveau';
     out.newButtonTitle = 'Créer un nouveau pad';
 
+    out.saveTemplateButton = "Sauver en tant que modèle";
+    out.saveTemplatePrompt = "Choisir un titre pour ce modèle";
+    out.templateSaved = "Modèle enregistré !";
+    out.selectTemplate = "Sélectionner un modèle ou appuyer sur Échap";
+
     out.presentButtonTitle = "Entrer en mode présentation";
     out.presentSuccess = 'Appuyer sur Échap pour quitter le mode présentation';
 

customize.dist/translations/messages.js

@@ -77,6 +77,11 @@ define(function () {
     out.newButton = 'New';
     out.newButtonTitle = 'Create a new pad';
 
+    out.saveTemplateButton = "Save as template";
+    out.saveTemplatePrompt = "Choose a title for the template";
+    out.templateSaved = "Template saved!";
+    out.selectTemplate = "Select a template or press escape";
+
     out.presentButtonTitle = "Enter presentation mode";
     out.presentSuccess = 'Hit ESC to exit presentation mode';
 

www/code/main.js

@@ -7,13 +7,14 @@ define([
     'json.sortify',
     '/bower_components/chainpad-json-validator/json-ot.js',
     '/common/cryptpad-common.js',
+    '/common/cryptget.js',
     '/common/modes.js',
     '/common/themes.js',
     '/common/visible.js',
     '/common/notify.js',
     '/bower_components/file-saver/FileSaver.min.js',
     '/bower_components/jquery/dist/jquery.min.js',
-], function (Crypto, Realtime, TextPatcher, Toolbar, JSONSortify, JsonOT, Cryptpad, Modes, Themes, Visible, Notify) {
+], function (Crypto, Realtime, TextPatcher, Toolbar, JSONSortify, JsonOT, Cryptpad, Cryptget, Modes, Themes, Visible, Notify) {
     var $ = window.jQuery;
     var saveAs = window.saveAs;
     var Messages = Cryptpad.Messages;
@@ -401,6 +402,17 @@ define([
                     editHash = Cryptpad.getEditHashFromKeys(info.channel, secret.keys);
                 }
 
+                /* save as template */
+                if (!Cryptpad.isTemplate(window.location.href)) {
+                    var templateObj = {
+                        rt: info.realtime,
+                        Crypt: Cryptget,
+                        getTitle: function () { return document.title; }
+                    };
+                    var $templateButton = Cryptpad.createButton('template', true, templateObj);
+                    $rightside.append($templateButton);
+                }
+
                 /* add an export button */
                 var $export = Cryptpad.createButton('export', true, {}, exportText);
                 $rightside.append($export);
@@ -532,6 +544,8 @@ define([
 
                 var userDoc = module.realtime.getUserDoc();
 
+                var isNew = false;
+                if (userDoc === "" || userDoc === "{}") { isNew = true; }
 
                 var newDoc = "";
                 if(userDoc !== "") {
@@ -599,6 +613,9 @@ define([
                         onLocal();
                         module.$userNameButton.click();
                     }
+                    if (isNew) {
+                        Cryptpad.selectTemplate('code', info.realtime, Cryptget);
+                    }
                 });
             };
 

www/common/cryptpad-common.js

@@ -498,7 +498,7 @@ load pinpad dynamically only after you know that it will be needed */
     };
 
     var makePad = function (href, title) {
-        var now = ''+new Date();
+        var now = +new Date();
         return {
             href: href,
             atime: now,
@@ -557,6 +557,41 @@ load pinpad dynamically only after you know that it will be needed */
         getStore().addTemplate(href);
     };
 
+    var isTemplate = common.isTemplate = function (href) {
+        var rhref = getRelativeHref(href);
+        var templates = listTemplates();
+        return templates.some(function (t) {
+            return t.href === rhref;
+        });
+    };
+    var selectTemplate = common.selectTemplate = function (type, rt, Crypt) {
+        if (!AppConfig.enableTemplates) { return; }
+        var temps = listTemplates(type);
+        if (temps.length === 0) { return; }
+        var $content = $('<div>');
+        $('<b>').text(Messages.selectTemplate).appendTo($content);
+        $('<p>', {id:"selectTemplate"}).appendTo($content);
+        Cryptpad.alert($content.html(), null, true);
+        var $p = $('#selectTemplate');
+        temps.forEach(function (t, i) {
+            $('<a>', {href: t.href, title: t.title}).text(t.title).click(function (e) {
+                e.preventDefault();
+                var parsed = parsePadUrl(t.href);
+                if(!parsed) { throw new Error("Cannot get template hash"); }
+                common.addLoadingScreen(null, true);
+                Crypt.get(parsed.hash, function (err, val) {
+                    if (err) { throw new Error(err); }
+                    var p = parsePadUrl(window.location.href);
+                    Crypt.put(p.hash, val, function (e) {
+                        common.findOKButton().click();
+                        common.removeLoadingScreen();
+                    });
+                });
+            }).appendTo($p);
+            if (i !== temps.length) { $('<br>').appendTo($p); }
+        });
+        common.findOKButton().text(Messages.cancelButton);
+    };
 
     // STORAGE
     /* fetch and migrate your pad history from localStorage */
@@ -1080,6 +1115,56 @@ load pinpad dynamically only after you know that it will be needed */
                     }));
                 }
                 break;
+            case 'template':
+                if (!AppConfig.enableTemplates) { return; }
+                button = $('<button>', {
+                    title: Messages.saveTemplateButton,
+                }).append($('<span>', {'class':'fa fa-bookmark', style: 'font:'+size+' FontAwesome'}));
+                if (data.rt && data.Crypt) {
+                    button.click(function () {
+                        var title = data.getTitle() || document.title;
+                        var todo = function (val) {
+                            if (typeof(val) !== "string") { return; }
+                            var toSave = data.rt.getUserDoc();
+                            if (val.trim()) {
+                                val = val.trim();
+                                title = val;
+                                try {
+                                    var parsed = JSON.parse(toSave);
+                                    var meta;
+                                    if (Array.isArray(parsed) && typeof(parsed[3]) === "object") {
+                                        meta = parsed[3].metadata; // pad
+                                    } else if (parsed.info) {
+                                        meta = parsed.info; // poll
+                                    } else {
+                                        meta = parsed.metadata;
+                                    }
+                                    if (typeof(meta) === "object") {
+                                        meta.title = val;
+                                        meta.defaultTitle = val;
+                                        delete meta.users;
+                                    }
+                                    toSave = JSON.stringify(parsed);
+                                } catch(e) {
+                                    console.error("Parse error while setting the title", e);
+                                }
+                            }
+                            var p = parsePadUrl(window.location.href);
+                            if (!p.type) { return; }
+                            var hash = createRandomHash();
+                            var href = '/' + p.type + '/#' + hash;
+                            data.Crypt.put(hash, toSave, function (e) {
+                                if (e) { throw new Error(e); }
+                                common.addTemplate(makePad(href, title));
+                                whenRealtimeSyncs(getStore().getProxy().info.realtime, function () {
+                                    common.alert(Messages.templateSaved);
+                                });
+                            });
+                        };
+                        common.prompt(Messages.saveTemplatePrompt, title || document.title, todo);
+                    });
+                }
+                break;
             case 'forget':
                 button = $('<button>', {
                     id: 'cryptpad-forget',

www/common/fileObject.js

@@ -999,7 +999,10 @@ define([
         // first, we must add it to FILES_DATA, so the input has to be an fileDAta object
         var addTemplate = exp.addTemplate = function (fileData) {
             if (workgroup) { return; }
-            if (typeof fileData !== "object" || !fileData.href || !fileData.title) { return; }
+            if (typeof fileData !== "object" || !fileData.href || !fileData.title) {
+                console.error("filedata object expected to add a new template");
+                return;
+            }
 
             var href = fileData.href;
             var test = files[FILES_DATA].some(function (o) {

www/drive/main.js

@@ -220,6 +220,7 @@ define([
         // Categories dislayed in the menu
         // _WORKGROUP_ : do not display unsorted
         var displayedCategories = [ROOT, UNSORTED, TRASH, SEARCH];
+        if (AppConfig.enableTemplates) { displayedCategories.push(TEMPLATE); }
         if (isWorkgroup()) { displayedCategories = [ROOT, TRASH, SEARCH]; }
 
         var lastSelectTime;

www/pad/main.js

@@ -10,6 +10,7 @@ define([
     'json.sortify',
     '/bower_components/textpatcher/TextPatcher.js',
     '/common/cryptpad-common.js',
+    '/common/cryptget.js',
     '/common/visible.js',
     '/common/notify.js',
     '/pad/links.js',
@@ -17,7 +18,7 @@ define([
     '/bower_components/diff-dom/diffDOM.js',
     '/bower_components/jquery/dist/jquery.min.js',
 ], function (Crypto, realtimeInput, Hyperjson,
-    Toolbar, Cursor, JsonOT, TypingTest, JSONSortify, TextPatcher, Cryptpad,
+    Toolbar, Cursor, JsonOT, TypingTest, JSONSortify, TextPatcher, Cryptpad, Cryptget,
     Visible, Notify, Links) {
     var $ = window.jQuery;
     var saveAs = window.saveAs;
@@ -616,6 +617,17 @@ define([
                     $rightside.append($collapse);
                 }
 
+                /* save as template */
+                if (!Cryptpad.isTemplate(window.location.href)) {
+                    var templateObj = {
+                        rt: info.realtime,
+                        Crypt: Cryptget,
+                        getTitle: function () { return document.title; }
+                    };
+                    var $templateButton = Cryptpad.createButton('template', true, templateObj);
+                    $rightside.append($templateButton);
+                }
+
                 /* add an export button */
                 var $export = Cryptpad.createButton('export', true, {}, exportFile);
                 $rightside.append($export);
@@ -723,6 +735,7 @@ define([
 
                     editor.focus();
                     if (newPad) {
+                        Cryptpad.selectTemplate('pad', info.realtime, Cryptget);
                         cursor.setToEnd();
                     } else {
                         cursor.setToStart();

www/poll/main.js

@@ -3,6 +3,7 @@ define([
     '/bower_components/chainpad-listmap/chainpad-listmap.js',
     '/bower_components/chainpad-crypto/crypto.js',
     '/common/cryptpad-common.js',
+    '/common/cryptget.js',
     '/bower_components/hyperjson/hyperjson.js',
     'render.js',
     '/common/toolbar.js',
@@ -10,7 +11,7 @@ define([
     '/common/notify.js',
     '/bower_components/file-saver/FileSaver.min.js',
     '/bower_components/jquery/dist/jquery.min.js',
-], function (TextPatcher, Listmap, Crypto, Cryptpad, Hyperjson, Renderer, Toolbar, Visible, Notify) {
+], function (TextPatcher, Listmap, Crypto, Cryptpad, Cryptget, Hyperjson, Renderer, Toolbar, Visible, Notify) {
     var $ = window.jQuery;
 
     var Messages = Cryptpad.Messages;
@@ -525,6 +526,11 @@ define([
         debug('userid: %s', userid);
 
         var proxy = APP.proxy;
+
+        var isNew = false;
+        var userDoc = JSON.stringify(proxy);
+        if (userDoc === "" || userDoc === "{}") { isNew = true; }
+
         var uncommitted = APP.uncommitted = {};
         prepareProxy(proxy, copyObject(Render.Example));
         prepareProxy(uncommitted, copyObject(Render.Example));
@@ -676,6 +682,9 @@ define([
                 addToUserData(myData);
                 APP.$userNameButton.click();
             }
+            if (isNew) {
+                Cryptpad.selectTemplate('poll', info.realtime, Cryptget);
+            }
         });
     };
 
@@ -747,6 +756,17 @@ define([
         // set the hash
         if (!readOnly) { Cryptpad.replaceHash(editHash); }
 
+        /* save as template */
+        if (!Cryptpad.isTemplate(window.location.href)) {
+            var templateObj = {
+                rt: info.realtime,
+                Crypt: Cryptget,
+                getTitle: function () { return document.title; }
+            };
+            var $templateButton = Cryptpad.createButton('template', true, templateObj);
+            $rightside.append($templateButton);
+        }
+
         Cryptpad.onDisplayNameChanged(setName);
 
         Cryptpad.getPadTitle(function (err, title) {

www/slide/main.js

@@ -7,6 +7,7 @@ define([
     'json.sortify',
     '/bower_components/chainpad-json-validator/json-ot.js',
     '/common/cryptpad-common.js',
+    '/common/cryptget.js',
     '/common/modes.js',
     '/common/themes.js',
     '/common/visible.js',
@@ -14,7 +15,7 @@ define([
     '/slide/slide.js',
     '/bower_components/file-saver/FileSaver.min.js',
     '/bower_components/jquery/dist/jquery.min.js',
-], function (Crypto, Realtime, TextPatcher, Toolbar, JSONSortify, JsonOT, Cryptpad, Modes, Themes, Visible, Notify, Slide) {
+], function (Crypto, Realtime, TextPatcher, Toolbar, JSONSortify, JsonOT, Cryptpad, Cryptget, Modes, Themes, Visible, Notify, Slide) {
     var $ = window.jQuery;
     var saveAs = window.saveAs;
 
@@ -532,6 +533,17 @@ define([
                     editHash = Cryptpad.getEditHashFromKeys(info.channel, secret.keys);
                 }
 
+                /* save as template */
+                if (!Cryptpad.isTemplate(window.location.href)) {
+                    var templateObj = {
+                        rt: info.realtime,
+                        Crypt: Cryptget,
+                        getTitle: function () { return document.title; }
+                    };
+                    var $templateButton = Cryptpad.createButton('template', true, templateObj);
+                    $rightside.append($templateButton);
+                }
+
                 /* add an export button */
                 var $export = Cryptpad.createButton('export', true, {}, exportText);
                 $rightside.append($export);
@@ -720,6 +732,9 @@ define([
 
                 var userDoc = module.realtime.getUserDoc();
 
+                var isNew = false;
+                if (userDoc === "" || userDoc === "{}") { isNew = true; }
+
                 var newDoc = "";
                 if(userDoc !== "") {
                     var hjson = JSON.parse(userDoc);
@@ -792,6 +807,9 @@ define([
                         onLocal();
                         module.$userNameButton.click();
                     }
+                    if (isNew) {
+                        Cryptpad.selectTemplate('slide', info.realtime, Cryptget);
+                    }
                 });
             };
 

www/whiteboard/main.js

@@ -11,13 +11,14 @@ define([
     'json.sortify',
     '/bower_components/chainpad-json-validator/json-ot.js',
     '/common/cryptpad-common.js',
+    '/common/cryptget.js',
     '/common/visible.js',
     '/common/notify.js',
     '/customize/application_config.js',
     '/bower_components/secure-fabric.js/dist/fabric.min.js',
     '/bower_components/jquery/dist/jquery.min.js',
     '/bower_components/file-saver/FileSaver.min.js',
-], function (Config, Realtime, Crypto, Toolbar, TextPatcher, JSONSortify, JsonOT, Cryptpad, Visible, Notify, AppConfig) {
+], function (Config, Realtime, Crypto, Toolbar, TextPatcher, JSONSortify, JsonOT, Cryptpad, Cryptget, Visible, Notify, AppConfig) {
     var saveAs = window.saveAs;
     var Messages = Cryptpad.Messages;
 
@@ -348,6 +349,17 @@ define([
             var $rightside = $bar.find('.' + Toolbar.constants.rightside);
             module.$userNameButton = $($bar.find('.' + Toolbar.constants.changeUsername));
 
+            /* save as template */
+            if (!Cryptpad.isTemplate(window.location.href)) {
+                var templateObj = {
+                    rt: info.realtime,
+                    Crypt: Cryptget,
+                    getTitle: function () { return document.title; }
+                };
+                var $templateButton = Cryptpad.createButton('template', true, templateObj);
+                $rightside.append($templateButton);
+            }
+
             var $export = Cryptpad.createButton('export', true, {}, saveImage);
             $rightside.append($export);
 
@@ -519,6 +531,10 @@ define([
                 realtime: realtime
             });
 
+            var isNew = false;
+            var userDoc = module.realtime.getUserDoc();
+            if (userDoc === "" || userDoc === "{}") { isNew = true; }
+
             Cryptpad.removeLoadingScreen();
             setEditable(true);
             initializing = false;
@@ -549,6 +565,9 @@ define([
                     onLocal();
                     module.$userNameButton.click();
                 }
+                if (isNew) {
+                    Cryptpad.selectTemplate('whiteboard', info.realtime, Cryptget);
+                }
             });
         };