Merge pull request #3191 from ether/fix/adjustments_of_2891

Adjustments of #2891

settings.json.template

@@ -75,26 +75,28 @@
 
   /* Pad Shortcut Keys */
   "padShortcutEnabled" : {
-    "altF9" : true,
+    "altF9"     : true, /* focus on the File Menu and/or editbar */
-    "altC" : true,
+    "altC"      : true, /* focus on the Chat window */
-    "cmdShift2" : true,
+    "cmdShift2" : true, /* shows a gritter popup showing a line author */
-    "delete" : true,
+    "delete"    : true,
-    "return" : true,
+    "return"    : true,
-    "cmdS" : true,
+    "esc"       : true, /* in mozilla versions 14-19 avoid reconnecting pad */
-    "tab" : true,
+    "cmdS"      : true, /* save a revision */
-    "cmdZ" : true,
+    "tab"       : true, /* indent */
-    "cmdY" : true,
+    "cmdZ"      : true, /* undo/redo */
-    "cmdI" : true,
+    "cmdY"      : true, /* redo */
-    "cmdB" : true,
+    "cmdI"      : true, /* italic */
-    "cmdU" : true,
+    "cmdB"      : true, /* bold */
-    "cmd5" : true,
+    "cmdU"      : true, /* underline */
-    "cmdShiftL" : true,
+    "cmd5"      : true, /* strike through */
-    "cmdShiftN" : true,
+    "cmdShiftL" : true, /* unordered list */
-    "cmdShiftC" : true,
+    "cmdShiftN" : true, /* ordered list */
-    "cmdH" : true,
+    "cmdShift1" : true, /* ordered list */
-    "ctrlHome" : true,
+    "cmdShiftC" : true, /* clear authorship */
-    "pageUp" : true,
+    "cmdH"      : true, /* backspace */
-    "pageDown" : true,
+    "ctrlHome"  : true, /* scroll to top of pad */
+    "pageUp"    : true,
+    "pageDown"  : true
   },
 
   /* Should we suppress errors from being visible in the default Pad Text? */

src/node/handler/PadMessageHandler.js

@@ -1197,6 +1197,7 @@ function handleClientReady(client, message)
           "userColor": authorColorId,
           "padId": message.padId,
           "padOptions": settings.padOptions,
+          "padShortcutEnabled": settings.padShortcutEnabled,
           "initialTitle": "Pad: " + message.padId,
           "opts": {},
           // tell the client the number of the latest chat-message, which will be

src/node/hooks/express/specialpages.js

@@ -48,12 +48,6 @@ exports.expressCreateServer = function (hook_name, args, cb) {
       res.cookie('language', settings.padOptions.lang);
     }
 
-    // Enable the pad shortcut keys from settings.json
-    if (settings.padShortcutEnabled !== undefined)
-    {
-      res.cookie('padShortcutEnabled', JSON.stringify(settings.padShortcutEnabled));      
-    }
-
     // The below might break for pads being rewritten
     var isReadOnly = req.url.indexOf("/p/r.") === 0;
 

src/node/utils/Settings.js

@@ -111,6 +111,7 @@ exports.padShortcutEnabled = {
   "delete" : true,
   "cmdShift2" : true,
   "return" : true,
+  "esc" : true,
   "cmdS" : true,
   "tab" : true,
   "cmdZ" : true,
@@ -121,6 +122,7 @@ exports.padShortcutEnabled = {
   "cmd5" : true,
   "cmdShiftL" : true,
   "cmdShiftN" : true,
+  "cmdShift1" : true,
   "cmdShiftC" : true,
   "cmdH" : true,
   "ctrlHome" : true,

src/static/js/ace2_inner.js

@@ -61,7 +61,6 @@ function Ace2Inner(){
   var SkipList = require('./skiplist');
   var undoModule = require('./undomodule').undoModule;
   var AttributeManager = require('./AttributeManager');
-  var readCookie = require('./pad_utils').readCookie;
 
   var DEBUG = false; //$$ build script replaces the string "var DEBUG=true;//$$" with "var DEBUG=false;"
   // changed to false
@@ -3641,37 +3640,6 @@ function Ace2Inner(){
 
   function handleKeyEvent(evt)
   {
-    // Get the enabled shortcut keys
-    // If it can't find the cookie, use default values
-    // Cookie should normally be set
-    // See settings.json
-    var padShortcutEnabled = JSON.parse(decodeURIComponent(readCookie('padShortcutEnabled')));
-    if (!padShortcutEnabled)
-    {
-      padShortcutEnabled = {
-        "altF9" : true,
-        "altC" : true,
-        "cmdShift2" : true,
-        "delete" : true,
-        "return" : true,
-        "cmdS" : true,
-        "tab" : true,
-        "cmdZ" : true,
-        "cmdY" : true,
-        "cmdI" : true,
-        "cmdB" : true,
-        "cmdU" : true,
-        "cmd5" : true,
-        "cmdShiftL" : true,
-        "cmdShiftN" : true,
-        "cmdShiftC" : true,
-        "cmdH" : true,
-        "ctrlHome" : true,
-        "pageUp" : true,
-        "pageDown" : true,
-      }
-    }
-    
     // if (DEBUG && window.DONT_INCORP) return;
     if (!isEditable) return;
     var type = evt.type;
@@ -3755,6 +3723,7 @@ function Ace2Inner(){
           specialHandled = _.contains(specialHandledInHook, true);
         }
 
+        var padShortcutEnabled = parent.parent.clientVars.padShortcutEnabled;
         if ((!specialHandled) && altKey && isTypeForSpecialKey && keyCode == 120 && padShortcutEnabled.altF9){
           // Alt F9 focuses on the File Menu and/or editbar.
           // Note that while most editors use Alt F10 this is not desirable
@@ -3878,7 +3847,7 @@ function Ace2Inner(){
           }, 0);
           specialHandled = true;
         }
-        if ((!specialHandled) && isTypeForSpecialKey && keyCode == 27 && padShortcutEnabled.cmdS)
+        if ((!specialHandled) && isTypeForSpecialKey && keyCode == 27 && padShortcutEnabled.esc)
         {
           // prevent esc key;
           // in mozilla versions 14-19 avoid reconnecting pad.
@@ -3970,9 +3939,9 @@ function Ace2Inner(){
           doInsertUnorderedList()
           specialHandled = true;
 	}
-        if ((!specialHandled) && isTypeForCmdKey && (String.fromCharCode(which).toLowerCase() == "n" || String.fromCharCode(which) == 1) && (evt.metaKey || evt.ctrlKey) && evt.shiftKey && padShortcutEnabled.cmdShiftN)
+        if ((!specialHandled) && isTypeForCmdKey && ((String.fromCharCode(which).toLowerCase() == "n" && padShortcutEnabled.cmdShiftN) || (String.fromCharCode(which) == 1 && padShortcutEnabled.cmdShift1)) && (evt.metaKey || evt.ctrlKey) && evt.shiftKey)
         {
-          // cmd-shift-N (orderedlist)
+          // cmd-shift-N and cmd-shift-1 (orderedlist)
           fastIncorp(9);
           evt.preventDefault();
           doInsertOrderedList()

tests/frontend/specs/ordered_list.js

@@ -5,8 +5,8 @@ describe("assign ordered list", function(){
     this.timeout(60000);
   });
 
-  it("insert ordered list text", function(done){
+  it("inserts ordered list text", function(done){
-    var inner$ = helper.padInner$; 
+    var inner$ = helper.padInner$;
     var chrome$ = helper.padChrome$;
 
     var $insertorderedlistButton = chrome$(".buttonicon-insertorderedlist");
@@ -17,8 +17,72 @@ describe("assign ordered list", function(){
     }).done(done);
   });
 
+  context('when user presses Ctrl+Shift+N', function() {
+    context('and pad shortcut is enabled', function() {
+      beforeEach(function() {
+        makeSureShortcutIsEnabled('cmdShiftN');
+        triggerCtrlShiftShortcut('N');
+      });
+
+      it('inserts unordered list', function(done) {
+        helper.waitFor(function() {
+          return helper.padInner$('div').first().find('ol li').length === 1;
+        }).done(done);
+      });
+    });
+
+    context('and pad shortcut is disabled', function() {
+      beforeEach(function() {
+        makeSureShortcutIsDisabled('cmdShiftN');
+        triggerCtrlShiftShortcut('N');
+      });
+
+      it('does not insert unordered list', function(done) {
+        helper.waitFor(function() {
+          return helper.padInner$('div').first().find('ol li').length === 1;
+        }).done(function() {
+          expect().fail(function() { return 'Unordered list inserted, should ignore shortcut' });
+        }).fail(function() {
+          done();
+        });
+      });
+    });
+  });
+
+  context('when user presses Ctrl+Shift+1', function() {
+    context('and pad shortcut is enabled', function() {
+      beforeEach(function() {
+        makeSureShortcutIsEnabled('cmdShift1');
+        triggerCtrlShiftShortcut('1');
+      });
+
+      it('inserts unordered list', function(done) {
+        helper.waitFor(function() {
+          return helper.padInner$('div').first().find('ol li').length === 1;
+        }).done(done);
+      });
+    });
+
+    context('and pad shortcut is disabled', function() {
+      beforeEach(function() {
+        makeSureShortcutIsDisabled('cmdShift1');
+        triggerCtrlShiftShortcut('1');
+      });
+
+      it('does not insert unordered list', function(done) {
+        helper.waitFor(function() {
+          return helper.padInner$('div').first().find('ol li').length === 1;
+        }).done(function() {
+          expect().fail(function() { return 'Unordered list inserted, should ignore shortcut' });
+        }).fail(function() {
+          done();
+        });
+      });
+    });
+  });
+
   xit("issue #1125 keeps the numbered list on enter for the new line - EMULATES PASTING INTO A PAD", function(done){
-    var inner$ = helper.padInner$; 
+    var inner$ = helper.padInner$;
     var chrome$ = helper.padChrome$;
 
     var $insertorderedlistButton = chrome$(".buttonicon-insertorderedlist");
@@ -26,9 +90,9 @@ describe("assign ordered list", function(){
 
     //type a bit, make a line break and type again
     var $firstTextElement = inner$("div span").first();
-    $firstTextElement.sendkeys('line 1'); 
+    $firstTextElement.sendkeys('line 1');
-    $firstTextElement.sendkeys('{enter}');    
+    $firstTextElement.sendkeys('{enter}');
-    $firstTextElement.sendkeys('line 2'); 
+    $firstTextElement.sendkeys('line 2');
     $firstTextElement.sendkeys('{enter}');
 
     helper.waitFor(function(){
@@ -44,4 +108,26 @@ describe("assign ordered list", function(){
       done();
     });
   });
+
+  var triggerCtrlShiftShortcut = function(shortcutChar) {
+    var inner$ = helper.padInner$;
+    if(inner$(window)[0].bowser.firefox || inner$(window)[0].bowser.modernIE) { // if it's a mozilla or IE
+      var evtType = "keypress";
+    }else{
+      var evtType = "keydown";
+    }
+    var e = inner$.Event(evtType);
+    e.ctrlKey = true;
+    e.shiftKey = true;
+    e.which = shortcutChar.toString().charCodeAt(0);
+    inner$("#innerdocbody").trigger(e);
+  }
+
+  var makeSureShortcutIsDisabled = function(shortcut) {
+    helper.padChrome$.window.clientVars.padShortcutEnabled[shortcut] = false;
+  }
+  var makeSureShortcutIsEnabled = function(shortcut) {
+    helper.padChrome$.window.clientVars.padShortcutEnabled[shortcut] = true;
+  }
+
 });