cloudstack/ui/scripts/plugins.js
Brian Federle 6babaf9616 Add UI 'module' API
Add a variant to a plugin, called a 'module.' It is designed for
features that are build-in to the standard UI (i.e., not installed
dynamically), but can still utilize the modular nature of UI
plugins. It works exactly the same way as a plugin, except:

-Modules are added to modules/ folder
-Modules are registered in modules/modules.js
-No config.js (no need for metadata, since they are built-in features)
- /ui/modules/ folder will not be touched by the build system, so any modules
 are committed directly to the ui/ folder. In other words, modules are
 not installed automatically.
2013-04-18 12:52:55 -07:00

107 lines
3.0 KiB
JavaScript

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you 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($, cloudStack, require) {
if (!cloudStack.pluginAPI) cloudStack.pluginAPI = {};
var loadCSS = function(path) {
var $link = $('<link>');
$link.attr({
rel: 'stylesheet',
type: 'text/css',
href: path
});
$('head').append($link);
};
$.extend(cloudStack.pluginAPI, {
ui: {
pollAsyncJob: pollAsyncJobResult,
apiCall: function(command, args) {
$.ajax({
url: createURL(command),
data: args.data,
success: args.success,
error: function(json) {
args.error(parseXMLHttpResponse(json));
}
})
},
addSection: function(section) {
cloudStack.sections[section.id] = $.extend(section, {
customIcon: 'plugins/' + section.id + '/icon.png'
});
},
extend: function(obj) {
$.extend(true, cloudStack, obj);
}
}
});
cloudStack.sections.plugins = {
title: 'label.plugins',
show: cloudStack.uiCustom.pluginListing
};
// Load plugins
$(cloudStack.plugins).map(function(index, pluginID) {
var basePath = 'plugins/' + pluginID + '/';
var pluginJS = basePath + pluginID + '.js';
var configJS = basePath + 'config.js';
var pluginCSS = basePath + pluginID + '.css';
require([pluginJS], function() {
require([configJS]);
loadCSS(pluginCSS);
// Execute plugin
cloudStack.plugins[pluginID](
$.extend(true, {}, cloudStack.pluginAPI, {
pluginAPI: {
extend: function(api) {
cloudStack.pluginAPI[pluginID] = api;
}
}
})
);
});
});
// Load modules
$(cloudStack.modules).map(function(index, moduleID) {
var basePath = 'modules/' + moduleID + '/';
var moduleJS = basePath + moduleID + '.js';
var moduleCSS = basePath + moduleID + '.css';
require([moduleJS], function() {
loadCSS(moduleCSS);
// Execute module
cloudStack.modules[moduleID](
$.extend(true, {}, cloudStack.pluginAPI, {
pluginAPI: {
extend: function(api) {
cloudStack.pluginAPI[moduleID] = api;
}
}
})
);
});
});
}(jQuery, cloudStack, require));