summaryrefslogtreecommitdiffstats
path: root/browser/components/webextensions/ext-commands.js
diff options
context:
space:
mode:
authorMatt A. Tobin <email@mattatobin.com>2018-02-09 10:39:41 -0500
committerMatt A. Tobin <email@mattatobin.com>2018-02-09 10:39:41 -0500
commit30de4018913f0cdaea19d1dd12ecd8209e2ed08e (patch)
tree6deebaede10def16e627d489455b4856c4f49386 /browser/components/webextensions/ext-commands.js
parentac46df8daea09899ce30dc8fd70986e258c746bf (diff)
downloadUXP-30de4018913f0cdaea19d1dd12ecd8209e2ed08e.tar
UXP-30de4018913f0cdaea19d1dd12ecd8209e2ed08e.tar.gz
UXP-30de4018913f0cdaea19d1dd12ecd8209e2ed08e.tar.lz
UXP-30de4018913f0cdaea19d1dd12ecd8209e2ed08e.tar.xz
UXP-30de4018913f0cdaea19d1dd12ecd8209e2ed08e.zip
Rename Basilisk's webextensions component directory to better reflect what it is. Also, add an Application level configure option to disable webextensions
Diffstat (limited to 'browser/components/webextensions/ext-commands.js')
-rw-r--r--browser/components/webextensions/ext-commands.js259
1 files changed, 259 insertions, 0 deletions
diff --git a/browser/components/webextensions/ext-commands.js b/browser/components/webextensions/ext-commands.js
new file mode 100644
index 000000000..416544e86
--- /dev/null
+++ b/browser/components/webextensions/ext-commands.js
@@ -0,0 +1,259 @@
+/* -*- Mode: indent-tabs-mode: nil; js-indent-level: 2 -*- */
+/* vim: set sts=2 sw=2 et tw=80: */
+"use strict";
+
+Cu.import("resource://devtools/shared/event-emitter.js");
+Cu.import("resource://gre/modules/ExtensionUtils.jsm");
+
+var {
+ EventManager,
+ PlatformInfo,
+} = ExtensionUtils;
+
+const XUL_NS = "http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul";
+
+// WeakMap[Extension -> CommandList]
+var commandsMap = new WeakMap();
+
+function CommandList(manifest, extension) {
+ this.extension = extension;
+ this.id = makeWidgetId(extension.id);
+ this.windowOpenListener = null;
+
+ // Map[{String} commandName -> {Object} commandProperties]
+ this.commands = this.loadCommandsFromManifest(manifest);
+
+ // WeakMap[Window -> <xul:keyset>]
+ this.keysetsMap = new WeakMap();
+
+ this.register();
+ EventEmitter.decorate(this);
+}
+
+CommandList.prototype = {
+ /**
+ * Registers the commands to all open windows and to any which
+ * are later created.
+ */
+ register() {
+ for (let window of WindowListManager.browserWindows()) {
+ this.registerKeysToDocument(window);
+ }
+
+ this.windowOpenListener = (window) => {
+ if (!this.keysetsMap.has(window)) {
+ this.registerKeysToDocument(window);
+ }
+ };
+
+ WindowListManager.addOpenListener(this.windowOpenListener);
+ },
+
+ /**
+ * Unregisters the commands from all open windows and stops commands
+ * from being registered to windows which are later created.
+ */
+ unregister() {
+ for (let window of WindowListManager.browserWindows()) {
+ if (this.keysetsMap.has(window)) {
+ this.keysetsMap.get(window).remove();
+ }
+ }
+
+ WindowListManager.removeOpenListener(this.windowOpenListener);
+ },
+
+ /**
+ * Creates a Map from commands for each command in the manifest.commands object.
+ *
+ * @param {Object} manifest The manifest JSON object.
+ * @returns {Map<string, object>}
+ */
+ loadCommandsFromManifest(manifest) {
+ let commands = new Map();
+ // For Windows, chrome.runtime expects 'win' while chrome.commands
+ // expects 'windows'. We can special case this for now.
+ let os = PlatformInfo.os == "win" ? "windows" : PlatformInfo.os;
+ for (let name of Object.keys(manifest.commands)) {
+ let command = manifest.commands[name];
+ let shortcut = command.suggested_key[os] || command.suggested_key.default;
+ if (shortcut) {
+ commands.set(name, {
+ description: command.description,
+ shortcut: shortcut.replace(/\s+/g, ""),
+ });
+ }
+ }
+ return commands;
+ },
+
+ /**
+ * Registers the commands to a document.
+ * @param {ChromeWindow} window The XUL window to insert the Keyset.
+ */
+ registerKeysToDocument(window) {
+ let doc = window.document;
+ let keyset = doc.createElementNS(XUL_NS, "keyset");
+ keyset.id = `ext-keyset-id-${this.id}`;
+ this.commands.forEach((command, name) => {
+ let keyElement = this.buildKey(doc, name, command.shortcut);
+ keyset.appendChild(keyElement);
+ });
+ doc.documentElement.appendChild(keyset);
+ this.keysetsMap.set(window, keyset);
+ },
+
+ /**
+ * Builds a XUL Key element and attaches an onCommand listener which
+ * emits a command event with the provided name when fired.
+ *
+ * @param {Document} doc The XUL document.
+ * @param {string} name The name of the command.
+ * @param {string} shortcut The shortcut provided in the manifest.
+ * @see https://developer.mozilla.org/en-US/docs/Mozilla/Tech/XUL/key
+ *
+ * @returns {Document} The newly created Key element.
+ */
+ buildKey(doc, name, shortcut) {
+ let keyElement = this.buildKeyFromShortcut(doc, shortcut);
+
+ // We need to have the attribute "oncommand" for the "command" listener to fire,
+ // and it is currently ignored when set to the empty string.
+ keyElement.setAttribute("oncommand", "//");
+
+ /* eslint-disable mozilla/balanced-listeners */
+ // We remove all references to the key elements when the extension is shutdown,
+ // therefore the listeners for these elements will be garbage collected.
+ keyElement.addEventListener("command", (event) => {
+ if (name == "_execute_page_action") {
+ let win = event.target.ownerDocument.defaultView;
+ pageActionFor(this.extension).triggerAction(win);
+ } else if (name == "_execute_browser_action") {
+ let win = event.target.ownerDocument.defaultView;
+ browserActionFor(this.extension).triggerAction(win);
+ } else {
+ TabManager.for(this.extension)
+ .addActiveTabPermission(TabManager.activeTab);
+ this.emit("command", name);
+ }
+ });
+ /* eslint-enable mozilla/balanced-listeners */
+
+ return keyElement;
+ },
+
+ /**
+ * Builds a XUL Key element from the provided shortcut.
+ *
+ * @param {Document} doc The XUL document.
+ * @param {string} shortcut The shortcut provided in the manifest.
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Mozilla/Tech/XUL/key
+ * @returns {Document} The newly created Key element.
+ */
+ buildKeyFromShortcut(doc, shortcut) {
+ let keyElement = doc.createElementNS(XUL_NS, "key");
+
+ let parts = shortcut.split("+");
+
+ // The key is always the last element.
+ let chromeKey = parts.pop();
+
+ // The modifiers are the remaining elements.
+ keyElement.setAttribute("modifiers", this.getModifiersAttribute(parts));
+
+ if (/^[A-Z0-9]$/.test(chromeKey)) {
+ // We use the key attribute for all single digits and characters.
+ keyElement.setAttribute("key", chromeKey);
+ } else {
+ keyElement.setAttribute("keycode", this.getKeycodeAttribute(chromeKey));
+ }
+
+ return keyElement;
+ },
+
+ /**
+ * Determines the corresponding XUL keycode from the given chrome key.
+ *
+ * For example:
+ *
+ * input | output
+ * ---------------------------------------
+ * "PageUP" | "VK_PAGE_UP"
+ * "Delete" | "VK_DELETE"
+ *
+ * @param {string} chromeKey The chrome key (e.g. "PageUp", "Space", ...)
+ * @returns {string} The constructed value for the Key's 'keycode' attribute.
+ */
+ getKeycodeAttribute(chromeKey) {
+ return `VK${chromeKey.replace(/([A-Z])/g, "_$&").toUpperCase()}`;
+ },
+
+ /**
+ * Determines the corresponding XUL modifiers from the chrome modifiers.
+ *
+ * For example:
+ *
+ * input | output
+ * ---------------------------------------
+ * ["Ctrl", "Shift"] | "accel shift"
+ * ["MacCtrl"] | "control"
+ *
+ * @param {Array} chromeModifiers The array of chrome modifiers.
+ * @returns {string} The constructed value for the Key's 'modifiers' attribute.
+ */
+ getModifiersAttribute(chromeModifiers) {
+ let modifiersMap = {
+ "Alt": "alt",
+ "Command": "accel",
+ "Ctrl": "accel",
+ "MacCtrl": "control",
+ "Shift": "shift",
+ };
+ return Array.from(chromeModifiers, modifier => {
+ return modifiersMap[modifier];
+ }).join(" ");
+ },
+};
+
+
+/* eslint-disable mozilla/balanced-listeners */
+extensions.on("manifest_commands", (type, directive, extension, manifest) => {
+ commandsMap.set(extension, new CommandList(manifest, extension));
+});
+
+extensions.on("shutdown", (type, extension) => {
+ let commandsList = commandsMap.get(extension);
+ if (commandsList) {
+ commandsList.unregister();
+ commandsMap.delete(extension);
+ }
+});
+/* eslint-enable mozilla/balanced-listeners */
+
+extensions.registerSchemaAPI("commands", "addon_parent", context => {
+ let {extension} = context;
+ return {
+ commands: {
+ getAll() {
+ let commands = commandsMap.get(extension).commands;
+ return Promise.resolve(Array.from(commands, ([name, command]) => {
+ return ({
+ name,
+ description: command.description,
+ shortcut: command.shortcut,
+ });
+ }));
+ },
+ onCommand: new EventManager(context, "commands.onCommand", fire => {
+ let listener = (eventName, commandName) => {
+ fire(commandName);
+ };
+ commandsMap.get(extension).on("command", listener);
+ return () => {
+ commandsMap.get(extension).off("command", listener);
+ };
+ }).api(),
+ },
+ };
+});