Web UI plugin loader

https://fedorahosted.org/freeipa/ticket/3235

.gitignore

@@ -54,6 +54,7 @@ install/ui/test/results
 install/ui/release
 install/ui/src/dojo
 install/ui/src/build
+install/ui/src/plugins
 ipa-client/COPYING
 ipa-client/ChangeLog
 ipa-client/INSTALL

freeipa.spec.in

@@ -413,6 +413,9 @@ mkdir -p %{buildroot}%{_initrddir}
 mkdir %{buildroot}%{_sysconfdir}/sysconfig/
 install -m 644 init/ipa_memcached.conf %{buildroot}%{_sysconfdir}/sysconfig/ipa_memcached
 
+# Web UI plugin dir
+mkdir -p %{buildroot}%{_usr}/share/ipa/ui/js/plugins
+
 # NOTE: systemd specific section
 mkdir -p %{buildroot}%{_sysconfdir}/tmpfiles.d/
 install -m 0644 init/systemd/ipa.conf.tmpfiles %{buildroot}%{_sysconfdir}/tmpfiles.d/ipa.conf
@@ -462,6 +465,7 @@ if [ $1 -gt 1 ] ; then
     /bin/systemctl condrestart certmonger.service 2>&1 || :
     /usr/sbin/ipa-upgradeconfig --quiet >/dev/null || :
 fi
+/usr/sbin/ipa-webui-regen >/dev/null || :
 
 %posttrans server
 # This must be run in posttrans so that updates from previous
@@ -632,6 +636,7 @@ fi
 %{_sbindir}/ipactl
 %{_sbindir}/ipa-upgradeconfig
 %{_sbindir}/ipa-compliance
+%{_sbindir}/ipa-webui-regen
 %{_libexecdir}/certmonger/dogtag-ipa-retrieve-agent-submit
 %{_sysconfdir}/cron.d/ipa-compliance
 %config(noreplace) %{_sysconfdir}/sysconfig/ipa_memcached
@@ -689,14 +694,13 @@ fi
 %{_usr}/share/ipa/ui/*.svg
 %{_usr}/share/ipa/ui/*.ttf
 %{_usr}/share/ipa/ui/*.woff
-%dir %{_usr}/share/ipa/ui/ext
-%config(noreplace) %{_usr}/share/ipa/ui/ext/extension.js
 %dir %{_usr}/share/ipa/ui/js/dojo
 %{_usr}/share/ipa/ui/js/dojo/dojo.js
 %dir %{_usr}/share/ipa/ui/js/libs
 %{_usr}/share/ipa/ui/js/libs/*.js
 %dir %{_usr}/share/ipa/ui/js/freeipa
 %{_usr}/share/ipa/ui/js/freeipa/app.js
+%dir %{_usr}/share/ipa/ui/js/plugins
 %dir %{_usr}/share/ipa/ui/images
 %{_usr}/share/ipa/ui/images/*.png
 %{_usr}/share/ipa/ui/images/*.gif

install/configure.ac

@@ -86,7 +86,6 @@ AC_CONFIG_FILES([
     migration/Makefile
     share/Makefile
     ui/Makefile
-    ui/ext/Makefile
     ui/src/Makefile
     ui/src/libs/Makefile
     ui/images/Makefile

install/tools/Makefile.am

@@ -14,7 +14,7 @@ sbin_SCRIPTS =			\
 	ipa-replica-prepare	\
 	ipa-replica-manage	\
 	ipa-csreplica-manage	\
- 	ipa-server-certinstall  \
+	ipa-server-certinstall  \
 	ipactl			\
 	ipa-compat-manage	\
 	ipa-nis-manage		\
@@ -24,6 +24,7 @@ sbin_SCRIPTS =			\
 	ipa-compliance		\
 	ipa-backup		\
 	ipa-restore		\
+	ipa-webui-regen		\
 	$(NULL)
 
 EXTRA_DIST =			\

install/tools/ipa-webui-regen

@@ -0,0 +1,66 @@
+#!/usr/bin/python
+# Authors: Petr Vobornik <pvoborni@redhat.com>
+#
+# Copyright (C) 2013  Red Hat
+# see file 'COPYING' for use and warranty information
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+import sys
+import os
+from optparse import OptionParser
+
+log_file_name = "/var/log/ipaserver-install.log"
+plugins_dir = "/usr/share/ipa/ui/js/plugins"
+index_file = "/usr/share/ipa/ui/js/freeipa/plugins.js"
+
+def parse_options():
+    usage = "%prog"
+    parser = OptionParser(usage=usage)
+
+    parser.add_option("-p", "--plugins-dir", action="store", dest="directory",
+                      help="Plugin directory path.", default=plugins_dir)
+
+    parser.add_option("-i", "--index-file", action="store", dest="index",
+                      help="Plugin index path", default=index_file)
+
+    options, args = parser.parse_args()
+    return options, args
+
+def main():
+    retval = 0
+    options, args = parse_options()
+    plugins_dir = options.directory
+    index_file = options.index
+
+    if not os.path.isdir(plugins_dir):
+        sys.exit("Supplied plugin directory path is not a directory")
+
+    dirs = os.listdir(plugins_dir)
+    index = u'define([],function(){return['
+    index += u','.join("'"+x+"'" for x in dirs)
+    index += u'];});'
+    print 'Plugins: '+', '.join(dirs)
+    try:
+        with open(index_file,'w') as f:
+            f.write(index)
+            print 'Plugin index updated'
+    except IOError, e:
+        sys.exit("Plugin index update failed: %s" % (str(e)))
+
+    return retval
+
+if __name__ == '__main__':
+    sys.exit(main())

install/ui/Makefile.am

@@ -4,7 +4,6 @@ NULL =
 
 SUBDIRS =  				\
 	build				\
-	ext				\
 	images				\
 	src				\
 	$(NULL)

install/ui/ext/Makefile.am

@@ -1,14 +0,0 @@
-NULL =
-
-appdir = $(IPA_DATA_DIR)/ui/ext
-app_DATA =				\
-	extension.js 			\
-	$(NULL)
-
-EXTRA_DIST =                            \
-        $(app_DATA)                     \
-        $(NULL)
-
-MAINTAINERCLEANFILES =                  \
-        *~                              \
-        Makefile.in

install/ui/js/plugins

@@ -0,0 +1 @@
+../src/plugins/

install/ui/src/freeipa/app.js

@@ -25,6 +25,8 @@ define([
     //core
     'dojo/_base/lang',
     'dojo/Deferred',
+    'dojo/when',
+    './plugin_loader',
     './phases',
     './Application_controller',
     'exports', // for circullar deps
@@ -52,7 +54,7 @@ define([
     './trust',
     './user',
     'dojo/domReady!'
-],function(lang, Deferred, phases, Application_controller, exports) {
+],function(lang, Deferred, when, plugin_loader, phases, Application_controller, exports) {
 
     var app = {
 
@@ -102,10 +104,12 @@ define([
             }));
         },
 
-       run: function() {
-           this.register_phases();
-           phases.controller.run();
-       }
+        run: function() {
+            when(plugin_loader.load_plugins(), lang.hitch(this, function() {
+                this.register_phases();
+                phases.controller.run();
+            }));
+        }
     };
 
     lang.mixin(exports, app);

install/ui/src/freeipa/plugin_loader.js

@@ -0,0 +1,82 @@
+/*  Authors:
+ *    Petr Vobornik <pvoborni@redhat.com>
+ *
+ * Copyright (C) 2013 Red Hat
+ * see file 'COPYING'./for use and warranty information
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/**
+ * Plugin loader
+ */
+define([
+    'dojo/_base/array',
+    'dojo/_base/lang',
+    'dojo/Deferred',
+    'dojo/promise/all'
+],function(array, lang, Deferred, all) {
+
+    var plugin_loader = {
+
+        register_plugins: function(plugins) {
+
+            var packages = [];
+
+            array.forEach(plugins, function(name) {
+                packages.push({
+                    name: name,
+                    location: 'plugins/'+name
+                });
+            });
+
+            require({ packages: packages});
+        },
+
+        load_plugin: function(name) {
+            var plugin_loaded = new Deferred();
+
+            var mid = name+'/'+name;
+
+            require([mid], function(plugin) {
+                plugin_loaded.resolve(plugin);
+            });
+
+            return plugin_loaded.promise;
+        },
+
+        load_plugins: function() {
+
+            var plugins_loaded = new Deferred();
+
+            require(['freeipa/plugins'], lang.hitch(this, function(plugins) {
+                var loading = [];
+
+                this.register_plugins(plugins);
+
+                array.forEach(plugins, lang.hitch(this, function(plugin) {
+                    loading.push(this.load_plugin(plugin));
+                }));
+
+                all(loading).then(function(results) {
+                    plugins_loaded.resolve(results);
+                });
+            }));
+
+           return plugins_loaded.promise;
+        }
+    };
+
+    return plugin_loader;
+});

install/ui/src/freeipa/plugins.js

@@ -0,0 +1 @@
+define([],function(){return[];});