mirrors/zotero
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

Resolve plugin-provided URIs relative to rootURI (#3235)

Browse source
This commit is contained in:
Abe Jellinek 2023-07-28 00:16:58 -04:00 • committed by GitHub
parent e271b4e494
commit 7036073ed1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 27 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

15
chrome/content/zotero/xpcom/plugins.js
View file

@ -220,6 +220,21 @@ Zotero.Plugins = new function () {
}; };
/**
* Resolve a URI in the context of a plugin. If the passed URI is relative, it will be resolved relative to the
* plugin root URI. If it's absolute, it will be returned unchanged.
*
* @param {String} id Plugin ID
* @param {String | URL} uri
* @throws {TypeError} On an invalid URI
* @return {Promise<String>}
*/
this.resolveURI = async function (id, uri) {
// We can't use addon.getResourceURI(path) here because that only accepts a relative path
return new URL(uri, await this.getRootURI(id)).href;
};
this.getName = async function (id) { this.getName = async function (id) {
var addon = await AddonManager.getAddonByID(id); var addon = await AddonManager.getAddonByID(id);
return addon.name; return addon.name;

21
chrome/content/zotero/xpcom/preferencePanes.js
View file

@ -96,15 +96,17 @@ Zotero.PreferencePanes = {
* *
* @param {Object} options * @param {Object} options
* @param {String} options.pluginID ID of the plugin registering the pane * @param {String} options.pluginID ID of the plugin registering the pane
* @param {String} options.src URI of an XHTML fragment * @param {String} options.src URI of an XHTML fragment, optionally relative to the plugin's root
* @param {String} [options.id] Represents the pane and must be unique. Automatically generated if not provided * @param {String} [options.id] Represents the pane and must be unique. Automatically generated if not provided
* @param {String} [options.parent] ID of parent pane (if provided, pane is hidden from the sidebar) * @param {String} [options.parent] ID of parent pane (if provided, pane is hidden from the sidebar)
* @param {String} [options.label] Displayed as the pane's label in the sidebar. * @param {String} [options.label] Displayed as the pane's label in the sidebar.
* If not provided, the plugin's name is used * If not provided, the plugin's name is used
* @param {String} [options.image] URI of an icon to be displayed in the navigation sidebar. * @param {String} [options.image] URI of an icon to be displayed in the navigation sidebar, optionally relative to
* If not provided, the plugin's icon (from manifest.json) is used * the plugin's root. If not provided, the plugin's icon (from manifest.json) is used.
* @param {String[]} [options.scripts] Array of URIs of scripts to load along with the pane * @param {String[]} [options.scripts] Array of URIs of scripts to load along with the pane, optionally relative to
* @param {String[]} [options.stylesheets] Array of URIs of CSS stylesheets to load along with the pane * the plugin's root
* @param {String[]} [options.stylesheets] Array of URIs of CSS stylesheets to load along with the pane, optionally
* relative to the plugin's root
* @param {String[]} [options.helpURL] If provided, a help button will be displayed under the pane * @param {String[]} [options.helpURL] If provided, a help button will be displayed under the pane
* and the provided URL will open when it is clicked * and the provided URL will open when it is clicked
* @return {Promise<String>} Resolves to the ID of the pane if successfully added * @return {Promise<String>} Resolves to the ID of the pane if successfully added
@ -123,10 +125,11 @@ Zotero.PreferencePanes = {
pluginID: options.pluginID, pluginID: options.pluginID,
parent: options.parent, parent: options.parent,
rawLabel: options.label || await Zotero.Plugins.getName(options.pluginID), rawLabel: options.label || await Zotero.Plugins.getName(options.pluginID),
image: options.image || await Zotero.Plugins.getIconURI(options.pluginID, 24), image: options.image && await Zotero.Plugins.resolveURI(options.pluginID, options.image)
src: options.src, || await Zotero.Plugins.getIconURI(options.pluginID, 24),
scripts: options.scripts, src: await Zotero.Plugins.resolveURI(options.pluginID, options.src),
stylesheets: options.stylesheets, scripts: await Promise.all(options.scripts.map(uri => Zotero.Plugins.resolveURI(options.pluginID, uri))),
stylesheets: await Promise.all(options.stylesheets.map(uri => Zotero.Plugins.resolveURI(options.pluginID, uri))),
helpURL: options.helpURL, helpURL: options.helpURL,
defaultXUL: true, defaultXUL: true,
}; };