Files
gerrit/polygerrit-ui/app/elements/plugins/gr-plugin-host/gr-plugin-host.js
Dave Borowitz 8cdc76ba4c Add @license tags to PG HTML and JS assets
These tags are preserved by the Closure compiler and vulcanize in order
to serve the license notices embedded in the outputs. In a standalone
Gerrit server, these license are also covered in the LICENSES.txt served
with the documentation. When serving PG assets from a CDN, it's less
obvious what the corresponding LICENSES.txt file is, since the CDN is
not directly linked to a running Gerrit server. Safer to embed the
licenses in the assets themselves.

Change-Id: Id1add1451fad1baa7916882a6bda02c326ccc988
2018-03-26 10:47:55 -04:00

104 lines
3.1 KiB
JavaScript

/**
* @license
* Copyright (C) 2017 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
(function() {
'use strict';
Polymer({
is: 'gr-plugin-host',
properties: {
config: {
type: Object,
observer: '_configChanged',
},
},
behaviors: [
Gerrit.BaseUrlBehavior,
],
_configChanged(config) {
const plugins = config.plugin;
const htmlPlugins = plugins.html_resource_paths || [];
const jsPlugins = this._handleMigrations(plugins.js_resource_paths || [],
htmlPlugins);
const defaultTheme = config.default_theme;
Gerrit._setPluginsCount(
jsPlugins.length + htmlPlugins.length + (defaultTheme ? 1 : 0));
if (defaultTheme) {
// Make theme first to be first to load.
// Load sync to work around rare theme loading race condition.
this._importHtmlPlugins([defaultTheme], true);
}
this._loadJsPlugins(jsPlugins);
this._importHtmlPlugins(htmlPlugins);
},
/**
* Omit .js plugins that have .html counterparts.
* For example, if plugin provides foo.js and foo.html, skip foo.js.
*/
_handleMigrations(jsPlugins, htmlPlugins) {
return jsPlugins.filter(url => {
const counterpart = url.replace(/\.js$/, '.html');
return !htmlPlugins.includes(counterpart);
});
},
/**
* @suppress {checkTypes}
* States that it expects no more than 3 parameters, but that's not true.
* @todo (beckysiegel) check Polymer annotations and submit change.
* @param {Array} plugins
* @param {boolean=} opt_sync
*/
_importHtmlPlugins(plugins, opt_sync) {
const async = !opt_sync;
for (const url of plugins) {
// onload (second param) needs to be a function. When null or undefined
// were passed, plugins were not loaded correctly.
this.importHref(
this._urlFor(url), () => {}, Gerrit._pluginInstalled, async);
}
},
_loadJsPlugins(plugins) {
for (const url of plugins) {
this._createScriptTag(this._urlFor(url));
}
},
_createScriptTag(url) {
const el = document.createElement('script');
el.defer = true;
el.src = url;
el.onerror = Gerrit._pluginInstalled;
return document.body.appendChild(el);
},
_urlFor(pathOrUrl) {
if (pathOrUrl.startsWith('http')) {
return pathOrUrl;
}
if (!pathOrUrl.startsWith('/')) {
pathOrUrl = '/' + pathOrUrl;
}
return this.getBaseUrl() + pathOrUrl;
},
});
})();