mirror of
https://github.com/jellyfin/jellyfin-web.git
synced 2024-11-17 19:08:18 -07:00
Merge pull request #3531 from thornbill/remove-plugin-get-routes
Remove broken method of registering routes for plugins
This commit is contained in:
Bill Thornton
GitHub
commit
3a14418e47
@ -9,166 +9,149 @@ import * as inputManager from '../scripts/inputManager';
|
|||||||
import toast from '../components/toast/toast';
|
import toast from '../components/toast/toast';
|
||||||
import confirm from '../components/confirm/confirm';
|
import confirm from '../components/confirm/confirm';
|
||||||
|
|
||||||
/* eslint-disable indent */
|
// TODO: replace with each plugin version
|
||||||
|
const cacheParam = new Date().getTime();
|
||||||
|
|
||||||
// TODO: replace with each plugin version
|
class PluginManager {
|
||||||
const cacheParam = new Date().getTime();
|
pluginsList = [];
|
||||||
|
|
||||||
class PluginManager {
|
get plugins() {
|
||||||
pluginsList = [];
|
return this.pluginsList;
|
||||||
|
}
|
||||||
|
|
||||||
get plugins() {
|
#loadStrings(plugin) {
|
||||||
return this.pluginsList;
|
const strings = plugin.getTranslations ? plugin.getTranslations() : [];
|
||||||
}
|
return globalize.loadStrings({
|
||||||
|
name: plugin.id || plugin.packageName,
|
||||||
|
strings: strings
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
#loadStrings(plugin) {
|
async #registerPlugin(plugin) {
|
||||||
const strings = plugin.getTranslations ? plugin.getTranslations() : [];
|
this.#register(plugin);
|
||||||
return globalize.loadStrings({
|
|
||||||
name: plugin.id || plugin.packageName,
|
|
||||||
strings: strings
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
#definePluginRoute(route, plugin) {
|
if (plugin.type === 'skin') {
|
||||||
route.contentPath = this.mapPath(plugin, route.path);
|
// translations won't be loaded for skins until needed
|
||||||
route.path = this.#mapRoute(plugin, route);
|
return plugin;
|
||||||
|
} else {
|
||||||
Emby.App.defineRoute(route, plugin.id);
|
return await this.#loadStrings(plugin);
|
||||||
}
|
|
||||||
|
|
||||||
async #registerPlugin(plugin) {
|
|
||||||
this.#register(plugin);
|
|
||||||
|
|
||||||
if (plugin.getRoutes) {
|
|
||||||
plugin.getRoutes().forEach((route) => {
|
|
||||||
this.#definePluginRoute(route, plugin);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
if (plugin.type === 'skin') {
|
|
||||||
// translations won't be loaded for skins until needed
|
|
||||||
return plugin;
|
|
||||||
} else {
|
|
||||||
return await this.#loadStrings(plugin);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
async #preparePlugin(pluginSpec, plugin) {
|
|
||||||
if (typeof pluginSpec === 'string') {
|
|
||||||
// See if it's already installed
|
|
||||||
const existing = this.plugins.filter(function (p) {
|
|
||||||
return p.id === plugin.id;
|
|
||||||
})[0];
|
|
||||||
|
|
||||||
if (existing) {
|
|
||||||
return pluginSpec;
|
|
||||||
}
|
|
||||||
|
|
||||||
plugin.installUrl = pluginSpec;
|
|
||||||
|
|
||||||
const separatorIndex = Math.max(pluginSpec.lastIndexOf('/'), pluginSpec.lastIndexOf('\\'));
|
|
||||||
plugin.baseUrl = pluginSpec.substring(0, separatorIndex);
|
|
||||||
}
|
|
||||||
|
|
||||||
return this.#registerPlugin(plugin);
|
|
||||||
}
|
|
||||||
|
|
||||||
async loadPlugin(pluginSpec) {
|
|
||||||
let plugin;
|
|
||||||
|
|
||||||
if (typeof pluginSpec === 'string') {
|
|
||||||
if (pluginSpec in window) {
|
|
||||||
console.log(`Loading plugin (via window): ${pluginSpec}`);
|
|
||||||
|
|
||||||
const pluginDefinition = await window[pluginSpec];
|
|
||||||
if (typeof pluginDefinition !== 'function') {
|
|
||||||
throw new TypeError('Plugin definitions in window have to be an (async) function returning the plugin class');
|
|
||||||
}
|
|
||||||
|
|
||||||
const pluginClass = await pluginDefinition();
|
|
||||||
if (typeof pluginClass !== 'function') {
|
|
||||||
throw new TypeError(`Plugin definition doesn't return a class for '${pluginSpec}'`);
|
|
||||||
}
|
|
||||||
|
|
||||||
// init plugin and pass basic dependencies
|
|
||||||
plugin = new pluginClass({
|
|
||||||
events: Events,
|
|
||||||
loading,
|
|
||||||
appSettings,
|
|
||||||
playbackManager,
|
|
||||||
globalize,
|
|
||||||
appHost,
|
|
||||||
appRouter,
|
|
||||||
inputManager,
|
|
||||||
toast,
|
|
||||||
confirm
|
|
||||||
});
|
|
||||||
} else {
|
|
||||||
console.debug(`Loading plugin (via dynamic import): ${pluginSpec}`);
|
|
||||||
const pluginResult = await import(/* webpackChunkName: "[request]" */ `../plugins/${pluginSpec}`);
|
|
||||||
plugin = new pluginResult.default;
|
|
||||||
}
|
|
||||||
} else if (pluginSpec.then) {
|
|
||||||
console.debug('Loading plugin (via promise/async function)');
|
|
||||||
|
|
||||||
const pluginResult = await pluginSpec;
|
|
||||||
plugin = new pluginResult.default;
|
|
||||||
} else {
|
|
||||||
throw new TypeError('Plugins have to be a Promise that resolves to a plugin builder function');
|
|
||||||
}
|
|
||||||
|
|
||||||
return this.#preparePlugin(pluginSpec, plugin);
|
|
||||||
}
|
|
||||||
|
|
||||||
// In lieu of automatic discovery, plugins will register dynamic objects
|
|
||||||
// Each object will have the following properties:
|
|
||||||
// name
|
|
||||||
// type (skin, screensaver, etc)
|
|
||||||
#register(obj) {
|
|
||||||
this.pluginsList.push(obj);
|
|
||||||
Events.trigger(this, 'registered', [obj]);
|
|
||||||
}
|
|
||||||
|
|
||||||
ofType(type) {
|
|
||||||
return this.pluginsList.filter((o) => {
|
|
||||||
return o.type === type;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
#mapRoute(plugin, route) {
|
|
||||||
if (typeof plugin === 'string') {
|
|
||||||
plugin = this.pluginsList.filter((p) => {
|
|
||||||
return (p.id || p.packageName) === plugin;
|
|
||||||
})[0];
|
|
||||||
}
|
|
||||||
|
|
||||||
route = route.path || route;
|
|
||||||
|
|
||||||
if (route.toLowerCase().startsWith('http')) {
|
|
||||||
return route;
|
|
||||||
}
|
|
||||||
|
|
||||||
return '/plugins/' + plugin.id + '/' + route;
|
|
||||||
}
|
|
||||||
|
|
||||||
mapPath(plugin, path, addCacheParam) {
|
|
||||||
if (typeof plugin === 'string') {
|
|
||||||
plugin = this.pluginsList.filter((p) => {
|
|
||||||
return (p.id || p.packageName) === plugin;
|
|
||||||
})[0];
|
|
||||||
}
|
|
||||||
|
|
||||||
let url = plugin.baseUrl + '/' + path;
|
|
||||||
|
|
||||||
if (addCacheParam) {
|
|
||||||
url += url.includes('?') ? '&' : '?';
|
|
||||||
url += 'v=' + cacheParam;
|
|
||||||
}
|
|
||||||
|
|
||||||
return url;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/* eslint-enable indent */
|
async #preparePlugin(pluginSpec, plugin) {
|
||||||
|
if (typeof pluginSpec === 'string') {
|
||||||
|
// See if it's already installed
|
||||||
|
const existing = this.plugins.filter(function (p) {
|
||||||
|
return p.id === plugin.id;
|
||||||
|
})[0];
|
||||||
|
|
||||||
|
if (existing) {
|
||||||
|
return pluginSpec;
|
||||||
|
}
|
||||||
|
|
||||||
|
plugin.installUrl = pluginSpec;
|
||||||
|
|
||||||
|
const separatorIndex = Math.max(pluginSpec.lastIndexOf('/'), pluginSpec.lastIndexOf('\\'));
|
||||||
|
plugin.baseUrl = pluginSpec.substring(0, separatorIndex);
|
||||||
|
}
|
||||||
|
|
||||||
|
return this.#registerPlugin(plugin);
|
||||||
|
}
|
||||||
|
|
||||||
|
async loadPlugin(pluginSpec) {
|
||||||
|
let plugin;
|
||||||
|
|
||||||
|
if (typeof pluginSpec === 'string') {
|
||||||
|
if (pluginSpec in window) {
|
||||||
|
console.log(`Loading plugin (via window): ${pluginSpec}`);
|
||||||
|
|
||||||
|
const pluginDefinition = await window[pluginSpec];
|
||||||
|
if (typeof pluginDefinition !== 'function') {
|
||||||
|
throw new TypeError('Plugin definitions in window have to be an (async) function returning the plugin class');
|
||||||
|
}
|
||||||
|
|
||||||
|
const pluginClass = await pluginDefinition();
|
||||||
|
if (typeof pluginClass !== 'function') {
|
||||||
|
throw new TypeError(`Plugin definition doesn't return a class for '${pluginSpec}'`);
|
||||||
|
}
|
||||||
|
|
||||||
|
// init plugin and pass basic dependencies
|
||||||
|
plugin = new pluginClass({
|
||||||
|
events: Events,
|
||||||
|
loading,
|
||||||
|
appSettings,
|
||||||
|
playbackManager,
|
||||||
|
globalize,
|
||||||
|
appHost,
|
||||||
|
appRouter,
|
||||||
|
inputManager,
|
||||||
|
toast,
|
||||||
|
confirm
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
console.debug(`Loading plugin (via dynamic import): ${pluginSpec}`);
|
||||||
|
const pluginResult = await import(/* webpackChunkName: "[request]" */ `../plugins/${pluginSpec}`);
|
||||||
|
plugin = new pluginResult.default;
|
||||||
|
}
|
||||||
|
} else if (pluginSpec.then) {
|
||||||
|
console.debug('Loading plugin (via promise/async function)');
|
||||||
|
|
||||||
|
const pluginResult = await pluginSpec;
|
||||||
|
plugin = new pluginResult.default;
|
||||||
|
} else {
|
||||||
|
throw new TypeError('Plugins have to be a Promise that resolves to a plugin builder function');
|
||||||
|
}
|
||||||
|
|
||||||
|
return this.#preparePlugin(pluginSpec, plugin);
|
||||||
|
}
|
||||||
|
|
||||||
|
// In lieu of automatic discovery, plugins will register dynamic objects
|
||||||
|
// Each object will have the following properties:
|
||||||
|
// name
|
||||||
|
// type (skin, screensaver, etc)
|
||||||
|
#register(obj) {
|
||||||
|
this.pluginsList.push(obj);
|
||||||
|
Events.trigger(this, 'registered', [obj]);
|
||||||
|
}
|
||||||
|
|
||||||
|
ofType(type) {
|
||||||
|
return this.pluginsList.filter((o) => {
|
||||||
|
return o.type === type;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
#mapRoute(plugin, route) {
|
||||||
|
if (typeof plugin === 'string') {
|
||||||
|
plugin = this.pluginsList.filter((p) => {
|
||||||
|
return (p.id || p.packageName) === plugin;
|
||||||
|
})[0];
|
||||||
|
}
|
||||||
|
|
||||||
|
route = route.path || route;
|
||||||
|
|
||||||
|
if (route.toLowerCase().startsWith('http')) {
|
||||||
|
return route;
|
||||||
|
}
|
||||||
|
|
||||||
|
return '/plugins/' + plugin.id + '/' + route;
|
||||||
|
}
|
||||||
|
|
||||||
|
mapPath(plugin, path, addCacheParam) {
|
||||||
|
if (typeof plugin === 'string') {
|
||||||
|
plugin = this.pluginsList.filter((p) => {
|
||||||
|
return (p.id || p.packageName) === plugin;
|
||||||
|
})[0];
|
||||||
|
}
|
||||||
|
|
||||||
|
let url = plugin.baseUrl + '/' + path;
|
||||||
|
|
||||||
|
if (addCacheParam) {
|
||||||
|
url += url.includes('?') ? '&' : '?';
|
||||||
|
url += 'v=' + cacheParam;
|
||||||
|
}
|
||||||
|
|
||||||
|
return url;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
export const pluginManager = new PluginManager();
|
export const pluginManager = new PluginManager();
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user