Add comments; use tabs instead of spaces in components/WebRTCToggle.js

Author: IsaacSchemm

README.md

@@ -14,9 +14,9 @@ that's open will be able to get access to your microphone, camera, and screen!
 So be sure to only turn it on when you need to use WebRTC, and turn it off
 once you're done with it.
 
-Closing the entire application, or uninstalling the extension, will always
-turn off the override. If you want, you can also have it turn off whenever a
-new browser window is opened.
+Closing the entire application, or disabling or removing the extension, will
+always turn off the override. If you want, you can also have it turn off
+whenever a new browser window is opened.
 
 Instructions
 ------------
@@ -46,10 +46,6 @@ Known Bugs
 * If toggling the override is configured to trigger a standard notification
 (the default), and you have windows open that were launched from JavaScript,
 the notification may appear outside of the top edge of the monitor.
-* If toggling the override is configured to trigger a modal dialog, and you
-have multiple windows open, multiple notification dialogs will be displayed.
-* If the override is on, closing SeaMonkey with File > Exit or Ctrl+Q may not
-turn it off.
 
 Notes
 -----

components/WebRTCToggle.js

@@ -5,6 +5,10 @@ XPCOM
 Components.utils.import("resource://gre/modules/XPCOMUtils.jsm");
 Components.utils.import("resource://gre/modules/AddonManager.jsm");
 
+// When the user decides to disable or uninstall the add-on, turn the override
+// off immediately, instead of waiting for application shutdown. In button.js
+// we check the status of the add-on, and prevent the user from turning the
+// override back on if the extension is going to be uninstalled or disabled.
 AddonManager.addAddonListener({
 	onUninstalling: function(addon) {
 		if (addon.id == "[email protected]") {
@@ -21,8 +25,7 @@ AddonManager.addAddonListener({
 				.getBranch("media.navigator.permission.")
 				.setBoolPref("disabled", false);
 		}
-	},
-	// If user decides to cancel the disable/uninstall, they can just reactivate the override with the toolbar button.
+	}
 });
 
 /***********************************************************
@@ -35,36 +38,41 @@ function WebRTCToggle() { }
 // class definition
 WebRTCToggle.prototype = {
 
-    // properties required for XPCOM registration:
-    classDescription: "WebRTC Toggle (WebRTC Permissions UI Override)",
-    classID:          Components.ID("{265ba61d-8b89-4739-acc6-24df0bf7eb70}"),
-    contractID:       "@propfire/startup;1",
-    QueryInterface:   XPCOMUtils.generateQI([Components.interfaces.nsIObserver]),
+	// properties required for XPCOM registration:
+	classDescription: "WebRTC Toggle (WebRTC Permissions UI Override)",
+	classID:		  Components.ID("{265ba61d-8b89-4739-acc6-24df0bf7eb70}"),
+	contractID:	   "@propfire/startup;1",
+	QueryInterface:   XPCOMUtils.generateQI([Components.interfaces.nsIObserver]),
 
-    // add to category manager
-    _xpcom_categories: [{category: "profile-after-change"}],
+	// add to category manager
+	_xpcom_categories: [{category: "profile-after-change"}],
 
-    observe: function(aSubject, aTopic, aData) 
-    {
-        switch (aTopic) 
-        {
-            case "profile-after-change":
-                Components.classes["@mozilla.org/observer-service;1"]
+	observe: function(aSubject, aTopic, aData) 
+	{
+		switch (aTopic) 
+		{
+			case "profile-after-change":
+				// Set up listeners for the cases below.
+				Components.classes["@mozilla.org/observer-service;1"]
 					.getService(Components.interfaces.nsIObserverService)
 					.addObserver(this, "quit-application", false);
 
 				Components.classes["@mozilla.org/preferences-service;1"]
 					.getService(Components.interfaces.nsIPrefService)
 					.getBranch("media.navigator.permission.")
 					.addObserver("", this, false);
-                break;
+				break;
 			case "quit-application":
+				// Turn the override off when closing the application,
+				// regardless of whether or not the add-on is going to be
+				// uninstalled.
 				Components.classes["@mozilla.org/preferences-service;1"]
 					.getService(Components.interfaces.nsIPrefService)
 					.getBranch("media.navigator.permission.")
 					.setBoolPref("disabled", false);
 				break;
-            case "nsPref:changed":
+			case "nsPref:changed":
+				// Determine which message to show to the user.
 				var title = "WebRTC Permissions UI Toggle";
 				var newValue = Components.classes["@mozilla.org/preferences-service;1"]
 					.getService(Components.interfaces.nsIPrefService)
@@ -84,6 +92,9 @@ WebRTCToggle.prototype = {
 					.getCharPref("notify-type");
 				switch (type) {
 					case "non-modal":
+						// Use nsIAlertsService to show a notification.
+						// If you want the native Windows 10 notifications you
+						// can use the GNotifier add-on along with this one.
 						try {
 							Components.classes['@mozilla.org/alerts-service;1']
 								.getService(Components.interfaces.nsIAlertsService)
@@ -95,8 +106,10 @@ WebRTCToggle.prototype = {
 						}
 						break;
 					case "none":
+						// User has decided not to show a notification.
 						break;
 					default:
+						// Use nsIPromptService to show an old-fashioned modal dialog.
 						try {
 							Components.classes["@mozilla.org/embedcomp/prompt-service;1"]
 								.getService(Components.interfaces.nsIPromptService)
@@ -108,20 +121,20 @@ WebRTCToggle.prototype = {
 						}
 						break;
 				}
-                break;
-            default:
-                throw Components.Exception("Unknown topic: " + aTopic);
-        }
-    }
+				break;
+			default:
+				throw Components.Exception("Unknown topic: " + aTopic);
+		}
+	}
 };
 
 var components = [WebRTCToggle];  
 if (XPCOMUtils.generateNSGetFactory)
 {
-    var NSGetFactory = XPCOMUtils.generateNSGetFactory(components);
+	var NSGetFactory = XPCOMUtils.generateNSGetFactory(components);
 }
 else
 {
-    var NSGetModule = XPCOMUtils.generateNSGetModule(components);
+	var NSGetModule = XPCOMUtils.generateNSGetModule(components);
 }