Navigate through unread messages with 'j' and 'k'

4 files changed, 127 insertions, 2 deletions

diff --git a/hyperkitty/static/js/hyperkitty.js b/hyperkitty/static/js/hyperkitty.js
index 5fcb539..4b64b91 100644
--- a/hyperkitty/static/js/hyperkitty.js
+++ b/hyperkitty/static/js/hyperkitty.js
@@ -263,6 +263,31 @@ function setup_replies(baseElem) {
     }).change();
 }
 
+function setup_navkeys() {
+    var current_index;
+    function scroll(e) {
+        var inc;
+        var unreads = $(".email.unread");
+        if (unreads.length == 0) { return; }
+        if (e.data == "j") { inc = 1; }
+        if (e.data == "k") { inc = -1; }
+        if (typeof current_index == "undefined") {
+            if (inc == 1) { current_index = -1; }
+            if (inc == -1) { current_index = unreads.length; }
+        }
+        current_index = current_index + inc;
+        if (current_index < 0) { current_index = unreads.length - 1; }
+        if (current_index >= unreads.length) { current_index = 0; }
+        // compensate for the fixed banner at the top
+        var target = unreads.eq(current_index).offset().top - 70;
+        $("html,body").animate({
+            scrollTop: target
+        }, 500);
+    }
+    $(document).bind("keydown", "j", scroll);
+    $(document).bind("keydown", "k", scroll);
+}
+
 
 /*
  * Recent activity graph
diff --git a/hyperkitty/static/libs/jquery.hotkeys.js b/hyperkitty/static/libs/jquery.hotkeys.js
new file mode 100644
index 0000000..fbd71c7
--- /dev/null
+++ b/hyperkitty/static/libs/jquery.hotkeys.js
@@ -0,0 +1,99 @@
+/*
+ * jQuery Hotkeys Plugin
+ * Copyright 2010, John Resig
+ * Dual licensed under the MIT or GPL Version 2 licenses.
+ *
+ * Based upon the plugin by Tzury Bar Yochay:
+ * http://github.com/tzuryby/hotkeys
+ *
+ * Original idea by:
+ * Binny V A, http://www.openjs.com/scripts/events/keyboard_shortcuts/
+*/
+
+(function(jQuery){
+	
+	jQuery.hotkeys = {
+		version: "0.8",
+
+		specialKeys: {
+			8: "backspace", 9: "tab", 13: "return", 16: "shift", 17: "ctrl", 18: "alt", 19: "pause",
+			20: "capslock", 27: "esc", 32: "space", 33: "pageup", 34: "pagedown", 35: "end", 36: "home",
+			37: "left", 38: "up", 39: "right", 40: "down", 45: "insert", 46: "del", 
+			96: "0", 97: "1", 98: "2", 99: "3", 100: "4", 101: "5", 102: "6", 103: "7",
+			104: "8", 105: "9", 106: "*", 107: "+", 109: "-", 110: ".", 111 : "/", 
+			112: "f1", 113: "f2", 114: "f3", 115: "f4", 116: "f5", 117: "f6", 118: "f7", 119: "f8", 
+			120: "f9", 121: "f10", 122: "f11", 123: "f12", 144: "numlock", 145: "scroll", 191: "/", 224: "meta"
+		},
+	
+		shiftNums: {
+			"`": "~", "1": "!", "2": "@", "3": "#", "4": "$", "5": "%", "6": "^", "7": "&", 
+			"8": "*", "9": "(", "0": ")", "-": "_", "=": "+", ";": ": ", "'": "\"", ",": "<", 
+			".": ">",  "/": "?",  "\\": "|"
+		}
+	};
+
+	function keyHandler( handleObj ) {
+		// Only care when a possible input has been specified
+		if ( typeof handleObj.data !== "string" ) {
+			return;
+		}
+		
+		var origHandler = handleObj.handler,
+			keys = handleObj.data.toLowerCase().split(" ");
+	
+		handleObj.handler = function( event ) {
+			// Don't fire in text-accepting inputs that we didn't directly bind to
+			if ( this !== event.target && (/textarea|select/i.test( event.target.nodeName ) ||
+				 event.target.type === "text") ) {
+				return;
+			}
+			
+			// Keypress represents characters, not special keys
+			var special = event.type !== "keypress" && jQuery.hotkeys.specialKeys[ event.which ],
+				character = String.fromCharCode( event.which ).toLowerCase(),
+				key, modif = "", possible = {};
+
+			// check combinations (alt|ctrl|shift+anything)
+			if ( event.altKey && special !== "alt" ) {
+				modif += "alt+";
+			}
+
+			if ( event.ctrlKey && special !== "ctrl" ) {
+				modif += "ctrl+";
+			}
+			
+			// TODO: Need to make sure this works consistently across platforms
+			if ( event.metaKey && !event.ctrlKey && special !== "meta" ) {
+				modif += "meta+";
+			}
+
+			if ( event.shiftKey && special !== "shift" ) {
+				modif += "shift+";
+			}
+
+			if ( special ) {
+				possible[ modif + special ] = true;
+
+			} else {
+				possible[ modif + character ] = true;
+				possible[ modif + jQuery.hotkeys.shiftNums[ character ] ] = true;
+
+				// "$" can be triggered as "Shift+4" or "Shift+$" or just "$"
+				if ( modif === "shift+" ) {
+					possible[ jQuery.hotkeys.shiftNums[ character ] ] = true;
+				}
+			}
+
+			for ( var i = 0, l = keys.length; i < l; i++ ) {
+				if ( possible[ keys[i] ] ) {
+					return origHandler.apply( this, arguments );
+				}
+			}
+		};
+	}
+
+	jQuery.each([ "keydown", "keyup", "keypress" ], function() {
+		jQuery.event.special[ this ] = { add: keyHandler };
+	});
+
+})( jQuery );
\ No newline at end of file
diff --git a/hyperkitty/templates/base.html b/hyperkitty/templates/base.html
index 611909a..76d7d66 100644
--- a/hyperkitty/templates/base.html
+++ b/hyperkitty/templates/base.html
@@ -81,7 +81,7 @@
 	<script src="//ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js"></script>
 	<script>window.jQuery || document.write('<script src="{{ STATIC_URL }}libs/jquery/jquery-1.8.3.min.js"><\/script>')</script>
 	<script src="{{ STATIC_URL }}libs/jquery/jquery-ui-1.10.0.custom.min.js"></script>
-	{% assets filters="rjsmin", output="gen/hyperkitty.js", "libs/bootstrap/js/bootstrap.min.js", "libs/jquery.expander.js", "libs/d3.v2.min.js", "js/hyperkitty.js" %}
+	{% assets filters="rjsmin", output="gen/hyperkitty.js", "libs/bootstrap/js/bootstrap.min.js", "libs/jquery.expander.js", "libs/d3.v2.min.js", "libs/jquery.hotkeys.js", "js/hyperkitty.js" %}
 	<script src="{{ ASSET_URL }}"></script>
 	{% endassets %}
 	{% block additionaljs %} {% endblock %}
diff --git a/hyperkitty/templates/thread.html b/hyperkitty/templates/thread.html
index 1e1f7ed..a25046e 100644
--- a/hyperkitty/templates/thread.html
+++ b/hyperkitty/templates/thread.html
@@ -78,9 +78,10 @@
 <script type="text/javascript">
 	$(document).ready(function() {
 		// Hide quotes by default in the thread view
-		fold_quotes()
+		fold_quotes();
 		// Load the replies
 		update_thread_replies("{% url 'thread_replies' threadid=threadid mlist_fqdn=mlist.name %}?sort={{sort_mode}}&last_view={{last_view|date:'U'}}");
+		setup_navkeys();
 	});
 </script>