New version of keySharky for Firefox

- changed version: 1.5.2
- added "Sound control" keyboard combos
- added gsAPI methods for "Sound control"
- bugfixes
- updated "keySharky Options" window

Author: intarstudents

firefox/content/firefoxOverlay.xul

@@ -2,22 +2,26 @@
 <overlay id="keysharky-overlay" xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul">
 
   <script src="chrome://keysharky/content/overlay.js"/>
-  
+
   <keyset id="mainKeyset">
     <key id="keysharky_key_fake" />
     <!-- DO NOT REMOVE THIS FAKE KEY, OK? -->
   </keyset>
-  
+
   <commandset id="mainCommandSet">
     <command id="keysharky_cmd_play"      oncommand="keysharky.toggle('play');" />
     <command id="keysharky_cmd_stop"      oncommand="keysharky.toggle('stop');" />
     <command id="keysharky_cmd_previous"  oncommand="keysharky.toggle('previous');" />
     <command id="keysharky_cmd_next"      oncommand="keysharky.toggle('next');" />
-    
+
     <command id="keysharky_cmd_favorite"  oncommand="keysharky.toggle('favorite');" />
     <command id="keysharky_cmd_voteup"    oncommand="keysharky.toggle('voteup');" />
     <command id="keysharky_cmd_voteclear" oncommand="keysharky.toggle('voteclear');" />
     <command id="keysharky_cmd_votedown"  oncommand="keysharky.toggle('votedown');" />
+
+    <command id="keysharky_cmd_mute"      oncommand="keysharky.toggle('mute');" />
+    <command id="keysharky_cmd_volup"     oncommand="keysharky.toggle('volup');" />
+    <command id="keysharky_cmd_voldown"   oncommand="keysharky.toggle('voldown');" />
   </commandset>
 
 </overlay>

firefox/content/options.xul

@@ -47,6 +47,7 @@
         <textbox id="keysharky-toggle-next-shortcut" value="-"
                  onkeypress="keysharky.applyCombo(event, 'next')" readonly="true" />
       </hbox>
+      
     </groupbox>
 
     <groupbox id="keysharky-group-current">
@@ -81,6 +82,31 @@
       </hbox>
     </groupbox>
 
+    <groupbox id="keysharky-group-sound">
+      <caption label="Sound control"/>
+      
+      <hbox align="center">
+        <checkbox onclick="keysharky.toggleCombo('mute');" id="keysharky-enabler-mute" class="enabler" label="Mute" />
+        <spacer flex="1"/>
+        <textbox id="keysharky-toggle-mute-shortcut" value="-"
+                 onkeypress="keysharky.applyCombo(event, 'mute')" readonly="true" />
+      </hbox>
+      
+      <hbox align="center">
+        <checkbox onclick="keysharky.toggleCombo('volup');" id="keysharky-enabler-volup" class="enabler" label="Volume Up" />
+        <spacer flex="1"/>
+        <textbox id="keysharky-toggle-volup-shortcut" value="-"
+                 onkeypress="keysharky.applyCombo(event, 'volup')" readonly="true" />
+      </hbox>
+      
+      <hbox align="center">
+        <checkbox onclick="keysharky.toggleCombo('voldown');" id="keysharky-enabler-voldown" class="enabler" label="Volume Down" />
+        <spacer flex="1"/>
+        <textbox id="keysharky-toggle-voldown-shortcut" value="-"
+                 onkeypress="keysharky.applyCombo(event, 'voldown')" readonly="true" />
+      </hbox>
+    </groupbox>
+    
     <groupbox id="keysharky-group-api-server">
       <caption label="API server"/>
 

firefox/content/overlay.js

@@ -12,6 +12,10 @@ var keysharky = {
       "voteup"    : function(){ keysharky.gsliteswf.voteCurrentSong(1); },
       "votedown"  : function(){ keysharky.gsliteswf.voteCurrentSong(-1); },
       "voteclear" : function(){ keysharky.gsliteswf.voteCurrentSong(0); },
+      
+      "mute"      : function(){ keysharky.gsliteswf.setIsMuted(keysharky.gsliteswf.getIsMuted() ? false : true); },
+      "volup"     : function(){ keysharky.gsliteswf.setVolume(keysharky.gsliteswf.getVolume() + 10); },
+      "voldown"   : function(){ keysharky.gsliteswf.setVolume(keysharky.gsliteswf.getVolume() - 10); }
     };
 
     this.defaults = {
@@ -25,13 +29,20 @@ var keysharky = {
       "votedown"    :  '{"modifiers":["control","alt"],"key":"Z","keycode":"","enabled":true}',
       "voteclear"   :  '{"modifiers":["control","alt"],"key":"Q","keycode":"","enabled":true}',
 
+      "mute"        :  '{"modifiers":["control","shift"],"key":"M","keycode":"","enabled":true}',
+      "volup"       :  '{"modifiers":["control","shift"],"key":">","keycode":"","enabled":true}',
+      "voldown"     :  '{"modifiers":["control","shift"],"key":"<","keycode":"","enabled":true}',
+      
       "server_port" : 8800
     }
 
     this.serverMethods = {
       "currentSong"   : function(){ return keysharky.gsliteswf.getCurrentSongStatus(); },
       "nextSong"      : function(){ return keysharky.gsliteswf.getNextSong(); },
       "previousSong"  : function(){ return keysharky.gsliteswf.getPreviousSong(); },
+      
+      "volume"        : function(){ return keysharky.gsliteswf.getVolume(); },
+      "muted"         : function(){ return keysharky.gsliteswf.getIsMuted(); },
     };
 
     this.consoleObject = Components.classes["@mozilla.org/consoleservice;1"].getService(Components.interfaces.nsIConsoleService);
@@ -70,11 +81,13 @@ var keysharky = {
 
       this.gsAPI.registerErrorHandler(404, this.serverErrorParser);
       this.gsAPI.registerPathHandler("/", this.serverErrorParser);
+      
       this.gsAPI.registerPathHandler("/gs-version", this.serverGroovesharkVersion);
       this.gsAPI.registerPathHandler("/gs-api-version", this.serverGroovesharkAPIVersion);
+      this.gsAPI.registerPathHandler("/setVolume", this.serverVolumeControl);
 
       for (var method in this.serverMethods){
-        this.gsAPI.registerPathHandler("/" + method, this.serverSong);
+        this.gsAPI.registerPathHandler("/" + method, this.serverInfo);
       }
 
       for(var toggle in this.allToggles){
@@ -104,6 +117,45 @@ var keysharky = {
     return true;
   },
 
+  serverVolumeControl: function(request, response){
+    
+    var volume = /^(\d+)$/i.exec(request.queryString);
+    var toggled = false;
+    
+    if (volume != null && volume[1] >= 0 && volume[1] <= 100){
+      
+      try {
+        keysharky.gsliteswf.setVolume(volume[1]);
+        toggled = true;
+      }catch(e){
+        
+        try{
+          keysharky.findGrooveshark();
+          
+          keysharky.gsliteswf.setVolume(volume[1]);
+          toggled = true;
+        }catch(e){}
+        
+      }
+      
+      if (toggled){
+        
+        response.setStatusLine("1.1", 200, "OK");
+        response.write("VOLUME SET TO " + volume[1]);
+        
+      }else{
+        
+        response.setStatusLine("1.1", 500, "FAILED");
+        response.write("COULDN'T SET VOLUME");
+      
+      }
+    }else{
+      response.setStatusLine("1.1", 500, "FAILED");
+      response.write("BAD VOLUME VALUE. MUST BE BETWEEN 0 AND 100.");
+    }
+    
+  },
+  
   // Retrieves info about GroovesharkAPI version
   serverGroovesharkAPIVersion: function(request, response){
     try {
@@ -178,8 +230,8 @@ var keysharky = {
     }
   },
 
-  // Shows previous/current/next song status in plain text
-  serverSong: function(request, response){
+  // Retrieves and shows status messages
+  serverInfo: function(request, response){
     var method = /\/(\w+)/i.exec(request.path);
     var jsonArr = {};
 
@@ -197,26 +249,30 @@ var keysharky = {
 
     response.setHeader("Cache-Control", "no-cache", false);
 
-    if (json){
+    if (typeof(json) != "undefined"){
       response.setStatusLine("1.1", 200, "OK");
 
       if (method[1] == "currentSong"){
 
         response.write("status: " + json.status + "\n");
         jsonArr = json.song;
 
-      }else{
+      }else if (method[1] == "nextSong" || method[1] == "previousSong"){
 
         jsonArr = json;
 
+      }else{
+      
+        jsonArr[method[1]] = json;
+        
       }
 
       for(var status in jsonArr){
         response.write(status + ": " + jsonArr[status] + "\n");
       }
     }else{
       response.setStatusLine("1.1", 500, "FAILED");
-      response.write("COULDN'T RETRIEVE SONG STATUS");
+      response.write("COULDN'T RETRIEVE '" + method[1] + "' STATUS");
     }
 
   },
@@ -463,7 +519,6 @@ var keysharky = {
     for(var toggle in this.allToggles){
       id_arr[i]   = toggle;
       json_arr[i] = this.getPref(toggle);
-      
       i++;
     }
 
@@ -492,6 +547,7 @@ var keysharky = {
 
       this.optionsDoc.getElementById("keysharky-group-playback").style.display = "none";
       this.optionsDoc.getElementById("keysharky-group-current").style.display = "none";
+      this.optionsDoc.getElementById("keysharky-group-sound").style.display = "none";
       this.optionsDoc.getElementById("keysharky-group-readme").style.display = "none";
 
     }
@@ -728,7 +784,6 @@ var keysharky = {
 	      }
 
 	    }catch(e){
-	      this.log(e);
 	      this.setPref(id, this.JSON.parse(this.defaults[id]));
 	    }
 

firefox/defaults/preferences/prefs.js

@@ -8,5 +8,9 @@ pref('extensions.keysharky.voteup',     '{"modifiers":["control","alt"],"key":"A
 pref('extensions.keysharky.votedown',   '{"modifiers":["control","alt"],"key":"Z","keycode":"","enabled":true}');
 pref('extensions.keysharky.voteclear',  '{"modifiers":["control","alt"],"key":"Q","keycode":"","enabled":true}');
 
+pref('extensions.keysharky.mute',       '{"modifiers":["control","shift"],"key":"M","keycode":"","enabled":true}');
+pref('extensions.keysharky.volup',      '{"modifiers":["control","shift"],"key":">","keycode":"","enabled":true}');
+pref('extensions.keysharky.voldown',    '{"modifiers":["control","shift"],"key":"<","keycode":"","enabled":true}');
+
 pref('extensions.keysharky.server_port',        8800);
 pref('extensions.keysharky.server_autostart',   false);

firefox/install.rdf

@@ -5,12 +5,12 @@
   <RDF:Description RDF:about="rdf:#$kLx0i3"
                    em:id="{ec8030f7-c20a-464f-9b0e-13a3a9e97384}"
                    em:minVersion="3.0"
-                   em:maxVersion="4.0b7" />
+                   em:maxVersion="4.0b8" />
   <RDF:Description RDF:about="urn:mozilla:install-manifest"
                    em:id="keysharky@intars.students"
                    em:name="keySharky"
                    em:description="Add missing keyboard functionality to Grooveshark!"
-                   em:version="1.5.1"
+                   em:version="1.5.2"
                    em:creator="Intars Students"
                    em:optionsURL="chrome://keysharky/content/options.xul"
                    em:iconURL="chrome://keysharky/skin/keysharky.png">

firefox/skin/options.css

@@ -21,6 +21,9 @@
 #keysharky-toggle-favorite-shortcut,
 #keysharky-toggle-voteup-shortcut,
 #keysharky-toggle-voteclear-shortcut,
-#keysharky-toggle-votedown-shortcut {
+#keysharky-toggle-votedown-shortcut,
+#keysharky-toggle-mute-shortcut,
+#keysharky-toggle-volup-shortcut,
+#keysharky-toggle-voldown-shortcut {
   width: 250px;
 }