Source code
Revision control
Copy as Markdown
Other Tools
/* -*- Mode: indent-tabs-mode: nil; js-indent-level: 2 -*- */
/* vim: set sts=2 sw=2 et tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
"use strict";
var { withHandlingUserInput } = ExtensionCommon;
var { ExtensionError } = ExtensionUtils;
// If id is not specified for an item we use an integer.
// This ID need only be unique within a single addon. Since all addon code that
// can use this API runs in the same process, this local variable suffices.
var gNextMenuItemID = 0;
// Map[Extension -> Map[string or id, ContextMenusClickPropHandler]]
var gPropHandlers = new Map();
// The contextMenus API supports an "onclick" attribute in the create/update
// methods to register a callback. This class manages these onclick properties.
class ContextMenusClickPropHandler {
constructor(context) {
this.context = context;
// Map[string or integer -> callback]
this.onclickMap = new Map();
this.dispatchEvent = this.dispatchEvent.bind(this);
}
// A listener on contextMenus.onClicked that forwards the event to the only
// listener, if any.
dispatchEvent(info, tab) {
let onclick = this.onclickMap.get(info.menuItemId);
if (onclick) {
// No need for runSafe or anything because we are already being run inside
// an event handler -- the event is just being forwarded to the actual
// handler.
withHandlingUserInput(this.context.contentWindow, () =>
onclick(info, tab)
);
}
}
// Sets the `onclick` handler for the given menu item.
// The `onclick` function MUST be owned by `this.context`.
setListener(id, onclick) {
if (this.onclickMap.size === 0) {
this.context.childManager
.getParentEvent("menusInternal.onClicked")
.addListener(this.dispatchEvent);
this.context.callOnClose(this);
}
this.onclickMap.set(id, onclick);
let propHandlerMap = gPropHandlers.get(this.context.extension);
if (!propHandlerMap) {
propHandlerMap = new Map();
} else {
// If the current callback was created in a different context, remove it
// from the other context.
let propHandler = propHandlerMap.get(id);
if (propHandler && propHandler !== this) {
propHandler.unsetListener(id);
}
}
propHandlerMap.set(id, this);
gPropHandlers.set(this.context.extension, propHandlerMap);
}
// Deletes the `onclick` handler for the given menu item.
// The `onclick` function MUST be owned by `this.context`.
unsetListener(id) {
if (!this.onclickMap.delete(id)) {
return;
}
if (this.onclickMap.size === 0) {
this.context.childManager
.getParentEvent("menusInternal.onClicked")
.removeListener(this.dispatchEvent);
this.context.forgetOnClose(this);
}
let propHandlerMap = gPropHandlers.get(this.context.extension);
propHandlerMap.delete(id);
if (propHandlerMap.size === 0) {
gPropHandlers.delete(this.context.extension);
}
}
// Deletes the `onclick` handler for the given menu item, if any, regardless
// of the context where it was created.
unsetListenerFromAnyContext(id) {
let propHandlerMap = gPropHandlers.get(this.context.extension);
let propHandler = propHandlerMap && propHandlerMap.get(id);
if (propHandler) {
propHandler.unsetListener(id);
}
}
// Remove all `onclick` handlers of the extension.
deleteAllListenersFromExtension() {
let propHandlerMap = gPropHandlers.get(this.context.extension);
if (propHandlerMap) {
for (let [id, propHandler] of propHandlerMap) {
propHandler.unsetListener(id);
}
}
}
// Removes all `onclick` handlers from this context.
close() {
for (let id of this.onclickMap.keys()) {
this.unsetListener(id);
}
}
}
this.menusInternal = class extends ExtensionAPI {
getAPI(context) {
let { extension } = context;
let onClickedProp = new ContextMenusClickPropHandler(context);
let pendingMenuEvent;
let api = {
menus: {
create(createProperties, callback) {
let caller = context.getCaller();
if (extension.persistentBackground && createProperties.id === null) {
createProperties.id = ++gNextMenuItemID;
}
let { onclick } = createProperties;
if (onclick && !context.extension.persistentBackground) {
throw new ExtensionError(
`Property "onclick" cannot be used in menus.create, replace with an "onClicked" event listener.`
);
}
delete createProperties.onclick;
context.childManager
.callParentAsyncFunction("menusInternal.create", [createProperties])
.then(() => {
if (onclick) {
onClickedProp.setListener(createProperties.id, onclick);
}
if (callback) {
context.runSafeWithoutClone(callback);
}
})
.catch(error => {
context.withLastError(error, caller, () => {
if (callback) {
context.runSafeWithoutClone(callback);
}
});
});
return createProperties.id;
},
update(id, updateProperties) {
let { onclick } = updateProperties;
if (onclick && !context.extension.persistentBackground) {
throw new ExtensionError(
`Property "onclick" cannot be used in menus.update, replace with an "onClicked" event listener.`
);
}
delete updateProperties.onclick;
return context.childManager
.callParentAsyncFunction("menusInternal.update", [
id,
updateProperties,
])
.then(() => {
if (onclick) {
onClickedProp.setListener(id, onclick);
} else if (onclick === null) {
onClickedProp.unsetListenerFromAnyContext(id);
}
// else onclick is not set so it should not be changed.
});
},
remove(id) {
onClickedProp.unsetListenerFromAnyContext(id);
return context.childManager.callParentAsyncFunction(
"menusInternal.remove",
[id]
);
},
removeAll() {
onClickedProp.deleteAllListenersFromExtension();
return context.childManager.callParentAsyncFunction(
"menusInternal.removeAll",
[]
);
},
overrideContext(contextOptions) {
let checkValidArg = (contextType, propKey) => {
if (contextOptions.context !== contextType) {
if (contextOptions[propKey]) {
throw new ExtensionError(
`Property "${propKey}" can only be used with context "${contextType}"`
);
}
return false;
}
if (contextOptions.showDefaults) {
throw new ExtensionError(
`Property "showDefaults" cannot be used with context "${contextType}"`
);
}
if (!contextOptions[propKey]) {
throw new ExtensionError(
`Property "${propKey}" is required for context "${contextType}"`
);
}
return true;
};
if (checkValidArg("tab", "tabId")) {
if (!context.extension.hasPermission("tabs")) {
throw new ExtensionError(
`The "tab" context requires the "tabs" permission.`
);
}
}
if (checkValidArg("bookmark", "bookmarkId")) {
if (!context.extension.hasPermission("bookmarks")) {
throw new ExtensionError(
`The "bookmark" context requires the "bookmarks" permission.`
);
}
}
let webExtContextData = {
extensionId: context.extension.id,
showDefaults: contextOptions.showDefaults,
overrideContext: contextOptions.context,
bookmarkId: contextOptions.bookmarkId,
tabId: contextOptions.tabId,
};
if (pendingMenuEvent) {
// overrideContext is called more than once during the same event.
pendingMenuEvent.webExtContextData = webExtContextData;
return;
}
pendingMenuEvent = {
webExtContextData,
observe(subject) {
pendingMenuEvent = null;
Services.obs.removeObserver(this, "on-prepare-contextmenu");
subject = subject.wrappedJSObject;
if (context.principal.subsumes(subject.principal)) {
subject.setWebExtContextData(this.webExtContextData);
}
},
run() {
// "on-prepare-contextmenu" is expected to be observed before the
// end of the "contextmenu" event dispatch. This task is queued
// in case that does not happen, e.g. when the menu is not shown.
// ... or if the method was not called during a contextmenu event.
if (pendingMenuEvent === this) {
pendingMenuEvent = null;
Services.obs.removeObserver(this, "on-prepare-contextmenu");
}
},
};
Services.obs.addObserver(pendingMenuEvent, "on-prepare-contextmenu");
Services.tm.dispatchToMainThread(pendingMenuEvent);
},
onClicked: new EventManager({
context,
name: "menus.onClicked",
register: fire => {
let listener = (info, tab) => {
withHandlingUserInput(context.contentWindow, () =>
fire.sync(info, tab)
);
};
let event = context.childManager.getParentEvent(
"menusInternal.onClicked"
);
event.addListener(listener);
return () => {
event.removeListener(listener);
};
},
}).api(),
},
};
const result = {};
if (context.extension.hasPermission("menus")) {
result.menus = api.menus;
}
if (context.extension.hasPermission("contextMenus")) {
result.contextMenus = api.menus;
}
return result;
}
};