Menu and application controller refactoring

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

1 files changed, 245 insertions, 0 deletions

diff --git a/install/ui/src/freeipa/navigation/Menu.js b/install/ui/src/freeipa/navigation/Menu.js
new file mode 100644
index 000000000..7b1a0ecce
--- /dev/null
+++ b/install/ui/src/freeipa/navigation/Menu.js
@@ -0,0 +1,245 @@
+/*  Authors:
+ *    Petr Vobornik <pvoborni@redhat.com>
+ *
+ * Copyright (C) 2012 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/>.
+*/
+
+
+define(['dojo/_base/declare',
+       'dojo/store/Memory',
+       'dojo/_base/array',
+       'dojo/_base/lang',
+       'dojo/store/Observable',
+       'dojo/Evented',
+       '../_base/i18n',
+       '../ipa' // TODO: remove dependance
+       ], function(declare, Memory_store, array, lang, Observable, Evented, i18n, IPA) {
+
+/**
+ * Menu store
+ *
+ * Maintains menu hierarchy and selection state.
+ */
+return declare([Evented], {
+
+    /**
+     * Following properties can be specified in menu item spec:
+     * @property {String} name
+     * @property {String} label
+     * @property {String} title
+     * @property {Number} position: position among siblings
+     * @property {menu_item_spec_array} children
+     * @property {String} entity: entity name
+     * @property {String} facet: facet name
+     * @property {Boolean} hidden: menu item is no visible, but can serve for
+     *                             other evaluations (nested entities)
+     *
+     * Following properties are not in created menu item:
+     *   - children
+     *
+     *
+     * Following properties can be stored in menu item at runtime:
+     *
+     * @property {Boolean} selected
+     * @property {String} parent: name of parent menu item
+     * @property {String} selected_child: last selected child. Can be set even
+     *                                    if the child is not selected
+     *
+     */
+
+    /**
+     * Menu name
+     * @type String
+     */
+    name: null,
+
+    /**
+     * Dojo Store of menu items
+     * @type: Store
+     */
+    items: null,
+
+    /**
+    * Delimiter used in name creation
+    * To avoid having multiple menu items with the same name.
+    * @type String
+    */
+    path_delimiter: '/',
+
+    /**
+     * Selected menu items
+     * @type Array of menu items
+     */
+    selected: [],
+
+    /**
+     * Default search options: sort by position
+     *
+     * @type Object
+     */
+    search_options: { sort: [{attribute:'position'}]},
+
+    /**
+     * Takes a spec of menu item.
+     * Normalizes item's name, parent, adds children if specified
+     *
+     * @param {menu_item} items
+     * @param {String|menu_item} parent
+     * @param {Object} options
+     */
+    add_item: function(item, parent, options ) {
+
+        item = lang.clone(item); //don't modify original spec
+
+        // each item must have a name and a label
+        // FIXME: consider to move entity and facet stuff outside of this object
+        item.name = item.name || item.facet || item.entity;
+        if (!name) throw 'Missing menu item property: name';
+        if (item.label) item.label = i18n.message(item.label);
+        if (item.title) item.title = i18n.message(item.title);
+
+        if (item.entity) {
+            // FIXME: replace with 'entities' module in future
+            var entity = IPA.get_entity(item.entity);
+            if (!entity) return; //quit
+            //item.name = entity.name;
+            if (!item.label) item.label = entity.label;
+            if (!item.title) item.title = entity.title;
+        } //else if (item.facet) {
+            // TODO: uncomment when facet repository implemented
+//             var facet = facets.(item.facet);
+//             item.name = facet.name;
+//             if (!item.label) item.label = facet.label;
+//             if (!item.title) item.title = facet.title;
+//        }
+
+        item.selected = false;
+
+        // check parent
+        if (typeof parent === 'string') {
+            parent = this.items.get(parent);
+            if (!parent) throw 'Menu item\'s parent doesn\t exist';
+        } else if (typeof parent === 'object') {
+            if (!this.items.getIdentity(parent)) {
+                throw 'Supplied parent isn\'t menu item';
+            }
+        }
+
+        var parent_name = parent ? parent.name : null;
+        var siblings = this.items.query({ parent: parent_name });
+        if (!item.position) item.position = siblings.total;
+        // TODO: add reordering of siblings when position set
+
+        item.parent = parent_name;
+        if (parent) {
+            // names have to be unique
+            item.name = parent.name + this.path_delimiter + item.name;
+        }
+
+        // children will be added separatelly
+        var children = item.children;
+        delete item.children;
+
+        // finally add the item
+        this.items.add(item);
+
+        // add children
+        if (children) {
+            array.forEach(children, function(child) {
+                this.add_item(child, item);
+            }, this);
+        }
+    },
+
+    add_items: function(/* Array */ items) {
+        array.forEach(items, function(item) {
+            this.add_item(item);
+        }, this);
+    },
+
+    /**
+     * Query internal data store by using default search options.
+     *
+     * @param Object Query filter
+     * @return QueryResult
+     */
+    query: function(query) {
+        return this.items.query(query, this.search_options);
+    },
+
+    /**
+     * Marks item and all its parents as selected.
+     */
+    _select: function(item) {
+
+        item.selected = true;
+        this.selected.push(item);
+        this.items.put(item);
+
+        if (item.parent) {
+            var parent = this.items.get(item.parent);
+            this._select(parent);
+        }
+    },
+
+    /**
+     * Selects a menu item and all it's ancestors.
+     * @param {string|menu_item} Menu item to select
+     */
+    select: function(item) {
+
+        if (typeof item == 'string') {
+            item = this.items.get(item);
+        }
+
+        // FIXME: consider to raise an exception
+        if (!item || !this.items.getIdentity(item)) return false;
+
+        // deselect previous
+        var old_selection = lang.clone(this.selected);
+        array.forEach(this.selected, function(mi) {
+            mi.selected = false;
+            this.items.put(mi);
+        }, this);
+        this.selected = [];
+
+        // select new
+        this._select(item);
+
+        var select_state = {
+            item: item,
+            new_selection: this.selected,
+            old_selection: old_selection
+        };
+
+        this.emit('selected', select_state);
+        return select_state;
+    },
+
+    constructor: function(spec) {
+        spec = spec || {};
+        this.items = new Observable( new Memory_store({
+            idProperty: 'name'
+        }));
+
+        spec = lang.clone(spec);
+        this.add_items(spec.items || []);
+        delete spec.items;
+        declare.safeMixin(this, spec);
+    }
+}); //declare freeipa.menu
+}); //define
\ No newline at end of file