@girder/core 5.0.0-beta.1 → 5.0.0

package/dist-lib/src/views/widgets/RootSelectorWidget.js

@@ -0,0 +1,192 @@
+import _ from 'underscore';
+
+import CollectionCollection from '@girder/core/collections/CollectionCollection';
+import UserCollection from '@girder/core/collections/UserCollection';
+import View from '@girder/core/views/View';
+import events from '@girder/core/events';
+import { getCurrentUser } from '@girder/core/auth';
+
+import RootSelectorWidgetTemplate from '@girder/core/templates/widgets/rootSelectorWidget.pug';
+
+/**
+ * This widget creates a dropdown box allowing the user to select
+ * "root" paths for a hierarchy widget.
+ *
+ * @emits RootSelectorWidget#g:selected The selected element changed
+ * @type {object}
+ * @property {Model|null} root The selected root model
+ * @property {string|null} group The selection group
+ *
+ * @emits RootSelectorWidget#g:group A collection group was updated
+ * @type {object}
+ * @property {Collection} collection
+ */
+var RootSelectorWidget = View.extend({
+    events: {
+        'change #g-root-selector': '_selectRoot'
+    },
+
+    /**
+     * Initialize the widget.  The caller can configure the list of items
+     * that are present in the select box.  If no values are given, then
+     * appropriate rest calls will be made to fetch models automatically.
+     *
+     * Additional categories of roots can be provided via an object mapping,
+     * for example:
+     *
+     *   {
+     *     friends: new UserCollection([...]),
+     *     saved: new FolderCollection([...])
+     *   }
+     *
+     * Only a single page of results are displayed for each collection provided.
+     * The default maximum number can be configured, but for more sophisticated
+     * behavior, the caller should act on the collection objects directly and
+     * rerender.
+     *
+     * @param {object} settings
+     * @param {UserModel} [settings.home=getCurrentUser()]
+     * @param {object} [settings.groups] Additional collection groups to add
+     * @param {number} [settings.pageLimit=25] The maximum number of models to fetch
+     * @param {Model} [settings.selected] The default/current selection
+     * @param {string[]} [settings.display=['Home', 'Collections', 'Users'] Display order
+     * @param {boolean} [settings.reset=true] Always fetch from offset 0
+     * @param {Model|string} [settings.selectByResource] use the baseParentId to
+     * set the default selected item, can use a model based like an object, or a specific string ParentId
+     *
+     */
+    initialize: function (settings) {
+        settings = settings || {};
+
+        this.pageLimit = settings.pageLimit || 25;
+
+        // collections are provided for public access here
+        this.groups = {
+            Collections: new CollectionCollection(),
+            Users: new UserCollection()
+        };
+
+        this.groups.Collections.pageLimit = settings.pageLimit;
+        this.groups.Users.pageLimit = settings.pageLimit;
+        this.groups.Users.sortField = 'login';
+
+        // override default selection groups
+        _.extend(this.groups, settings.groups);
+
+        // attach collection change events
+        _.each(this.groups, (group) => {
+            this.listenTo(group, 'g:changed', () => {
+                this._updateGroup(group);
+            });
+        });
+
+        // possible values that determine rendered behavior for "Home":
+        //   - model: show this model as Home
+        //   - undefined|null: use getCurrentUser()
+        this.home = settings.home;
+
+        // we need to fetch the collections and rerender on login
+        this.listenTo(events, 'g:login', this.fetch);
+
+        this.selected = settings.selected;
+        this.selectByResource = settings.selectByResource;
+        this.display = settings.display || ['Home', 'Collections', 'Users'];
+
+        this.fetch();
+    },
+
+    render: function () {
+        this._home = this.home || getCurrentUser();
+        // Set the selected item if it is already defined and get it by resource if not
+        if (this.selectByResource) {
+            this.setRootByBaseParent(this.selectByResource);
+        }
+        this.$el.html(
+            RootSelectorWidgetTemplate({
+                home: this._home,
+                groups: this.groups,
+                display: this.display,
+                selected: this.selected,
+                format: this._formatName
+            })
+        );
+
+        return this;
+    },
+
+    setRootByBaseParent: function (baseParentId) {
+        // Filter for an Id String from an object if given
+        if (_.isObject(baseParentId)) {
+            if ((baseParentId.attributes || {}).baseParentId !== undefined) {
+                baseParentId = baseParentId.attributes.baseParentId;
+            }
+        }
+
+        if (_.isString(baseParentId)) {
+            _.each(this.groups, (group) => {
+                if (group.get(baseParentId) !== undefined) {
+                    this.selected = group.get(baseParentId);
+                }
+            });
+        }
+    },
+
+    /**
+     * Called when the user selects a new item.  Resolves the
+     * model object from the DOM and triggers the g:selected event.
+     */
+    _selectRoot: function () {
+        var sel = this.$(':selected');
+        var id = sel.val();
+        var group = sel.data('group') || null;
+        this.selected = null;
+        if (_.has(this.groups, group)) {
+            this.selected = this.groups[group].get(id);
+        } else if (this._home && this._home.id === id) {
+            this.selected = this._home;
+        }
+        this.trigger('g:selected', {
+            root: this.selected,
+            group: group
+        });
+    },
+
+    /**
+     * Called when a collection is modified... rerenders the view.
+     */
+    _updateGroup: function (collection) {
+        this.trigger('g:group', {
+            collection: collection
+        });
+        this.render();
+    },
+
+    /**
+     * Return a string to display for the given model.
+     */
+    _formatName: function (model) {
+        var name = model.id;
+        switch (model.get('_modelType')) {
+            case 'user':
+                name = model.get('login');
+                break;
+            case 'folder':
+            case 'collection':
+                name = model.get('name');
+                break;
+        }
+        return name;
+    },
+
+    /**
+     * Fetch all collections from the server.
+     */
+    fetch: function () {
+        var reset = this.reset;
+        _.each(this.groups, function (collection) {
+            collection.fetch(null, reset);
+        });
+    }
+});
+
+export default RootSelectorWidget;

package/dist-lib/src/views/widgets/SearchFieldWidget.js

@@ -0,0 +1,365 @@
+import $ from 'jquery';
+import _ from 'underscore';
+// Bootstrap tooltip is required by popover
+import 'bootstrap/js/tooltip';
+import 'bootstrap/js/popover';
+
+import View from '@girder/core/views/View';
+import { restRequest } from '@girder/core/rest';
+import router from '@girder/core/router';
+
+import SearchFieldTemplate from '@girder/core/templates/widgets/searchField.pug';
+import SearchHelpTemplate from '@girder/core/templates/widgets/searchHelp.pug';
+import SearchModeSelectTemplate from '@girder/core/templates/widgets/searchModeSelect.pug';
+import SearchResultsTemplate from '@girder/core/templates/widgets/searchResults.pug';
+import '@girder/core/stylesheets/widgets/searchFieldWidget.styl';
+
+/**
+ * This widget provides a text field that will search any set of data types
+ * and show matching results as the user types. Results can be clicked,
+ * triggering a callback.
+ */
+var SearchFieldWidget = View.extend({
+    events: {
+        'input .g-search-field': 'search',
+
+        'click .g-search-mode-radio': function (e) {
+            this.currentMode = $(e.target).val();
+            this.hideResults().search();
+
+            window.setTimeout(() => {
+                this.$('.g-search-mode-choose').popover('hide');
+            }, 250);
+        },
+
+        'click .g-search-result>a': function (e) {
+            this._resultClicked($(e.currentTarget));
+        },
+
+        'keydown .g-search-field': function (e) {
+            var code = e.keyCode || e.which;
+            var list, pos;
+            if (code === 13 && this.noResourceSelected) { /* enter without resource selected */
+                e.preventDefault();
+                if (this.$('.g-search-field').val() !== '' && !this.noResultsPage) {
+                    this._goToResultPage(this.$('.g-search-field').val(), this.currentMode);
+                }
+            } else if (code === 40 || code === 38) {
+                this.noResourceSelected = false;
+                if (code === 40) { /* down arrow */
+                    list = this.$('.g-search-result');
+                    pos = list.index(list.filter('.g-search-selected')) + 1;
+                    list.removeClass('g-search-selected');
+                    if (pos < list.length) {
+                        list.eq(pos).addClass('g-search-selected');
+                    }
+                    if (pos === list.length) {
+                        this.noResourceSelected = true;
+                    }
+                } else if (code === 38) { /* up arrow */
+                    list = this.$('.g-search-result');
+                    pos = list.index(list.filter('.g-search-selected')) - 1;
+                    list.removeClass('g-search-selected');
+                    if (pos === -1) {
+                        this.noResourceSelected = true;
+                    }
+                    if (pos === -2) {
+                        pos = list.length - 1;
+                    }
+                    if (pos >= 0) {
+                        list.eq(pos).addClass('g-search-selected');
+                    }
+                }
+            } else if (code === 13) { /* enter with resource selected */
+                e.preventDefault();
+                this.noResourceSelected = true;
+                var link = this.$('.g-search-result.g-search-selected>a');
+                if (link.length) {
+                    this._resultClicked(link);
+                }
+            }
+        }
+    },
+
+    /**
+     * @param [settings.placeholder="Search..."] The placeholder text for the input field.
+     * @param [settings.getInfoCallback] For custom resource types, this callback can
+     *        be passed in to resolve their title and icon. This callback should
+     *        return an object with "icon" and "text" fields if it can resolve
+     *        the result, or return falsy otherwise.
+     * @param [settings.modes=["text", "prefix"]] A string or list of strings
+     *        representing the allowed search modes. Supported modes: "text", "prefix".
+     *        If multiple are allowed, users are able to select which one to use
+     *        via a dropdown.
+     * @param [settings.noResultsPage=false] If truthy, don't jump to a results
+     *        page if enter is typed with a list of search results.
+     */
+    initialize: function (settings) {
+        this.ajaxLock = false;
+        this.pending = null;
+        this.noResourceSelected = true;
+        this.placeholder = settings.placeholder || 'Search...';
+        this.noResultsPage = settings.noResultsPage || false;
+        this.getInfoCallback = settings.getInfoCallback || null;
+        /* The order of settings.types give the order of the display of the elements :
+         *     ['collection', 'folder', 'item'] will be render like this
+         *       [icon-collection] Collections..
+         *       [icon-folder] Folders..
+         *       [icon-item] Items..
+         */
+        this.types = settings.types || [];
+        this.modes = settings.modes || SearchFieldWidget.getModes();
+
+        if (!_.isArray(this.modes)) {
+            this.modes = [this.modes];
+        }
+
+        this.currentMode = this.modes[0];
+
+        // Do not change the icon for fast searches, to prevent jitter
+        this._animatePending = _.debounce(this._animatePending, 100);
+    },
+
+    search: function () {
+        var q = this.$('.g-search-field').val();
+
+        if (!q) {
+            this.hideResults();
+            return this;
+        }
+
+        if (this.ajaxLock) {
+            this.pending = q;
+        } else {
+            this._doSearch(q);
+        }
+
+        return this;
+    },
+
+    _goToResultPage: function (query, mode) {
+        this.resetState();
+        router.navigate(`#search/results?query=${query}&mode=${mode}`, { trigger: true });
+    },
+
+    _resultClicked: function (link) {
+        if (link.data('resourceType') === 'resultPage') {
+            this._goToResultPage(this.$('.g-search-field').val(), this.currentMode);
+        } else {
+            this.trigger('g:resultClicked', {
+                type: link.data('resourceType'),
+                id: link.data('resourceId'),
+                text: link.text().trim(),
+                icon: link.data('resourceIcon')
+            });
+        }
+    },
+
+    render: function () {
+        this.$el.html(SearchFieldTemplate({
+            placeholder: this.placeholder,
+            modes: this.modes,
+            currentMode: this.currentMode
+        }));
+
+        this.$('.g-search-options-button').popover({
+            trigger: 'manual',
+            viewport: {
+                selector: 'body',
+                padding: 10
+            },
+            content: () => {
+                return SearchHelpTemplate({
+                    mode: this.currentMode,
+                    modeHelp: SearchFieldWidget.getModeHelp(this.currentMode)
+                });
+            },
+            html: true,
+            sanitize: false
+        }).on('click', function () {
+            $(this).popover('toggle');
+        });
+
+        this.$('.g-search-mode-choose').popover({
+            trigger: 'manual',
+            viewport: {
+                selector: 'body',
+                padding: 10
+            },
+            content: () => {
+                return SearchModeSelectTemplate({
+                    modes: this.modes,
+                    currentMode: this.currentMode,
+                    getModeDescription: SearchFieldWidget.getModeDescription
+                });
+            },
+            html: true,
+            sanitize: false
+        }).on('click', function () {
+            $(this).popover('toggle');
+        });
+
+        return this;
+    },
+
+    /**
+     * Parent views should call this if they wish to hide the result list.
+     */
+    hideResults: function () {
+        this.$('.dropdown').removeClass('open');
+        return this;
+    },
+
+    /**
+     * Parent views should call this if they wish to clear the search text.
+     */
+    clearText: function () {
+        this.$('.g-search-field').val('');
+        return this;
+    },
+
+    /**
+     * Parent views should call this if they wish to reset the search widget,
+     * i.e. clear it and hide any results.
+     */
+    resetState: function () {
+        return this.hideResults().clearText();
+    },
+
+    _animatePending: function () {
+        const isPending = this.ajaxLock;
+        this.$('.g-search-state')
+            .toggleClass('icon-search', !isPending)
+            .toggleClass('icon-spin4 animate-spin', isPending);
+    },
+
+    _doSearch: function (q) {
+        this.ajaxLock = true;
+        this.pending = null;
+        this._animatePending();
+
+        restRequest({
+            url: 'resource/search',
+            data: {
+                q: q,
+                mode: this.currentMode,
+                types: JSON.stringify(_.intersection(
+                    this.types,
+                    SearchFieldWidget.getModeTypes(this.currentMode))
+                )
+            }
+        }).done((results) => {
+            this.ajaxLock = false;
+            this._animatePending();
+
+            if (this.pending) {
+                this._doSearch(this.pending);
+            } else {
+                if (!this.$('.g-search-field').val()) {
+                    // The search field is empty, so this widget probably had "this.resetState"
+                    // called while the search was pending. So, don't render the (now obsolete)
+                    // results.
+                    return;
+                }
+
+                var resources = [];
+                _.each(this.types, function (type) {
+                    _.each(results[type] || [], function (result) {
+                        var text, icon;
+                        if (type === 'user') {
+                            text = result.firstName + ' ' + result.lastName +
+                                ' (' + result.login + ')';
+                            icon = 'user';
+                        } else if (type === 'group') {
+                            text = result.name;
+                            icon = 'users';
+                        } else if (type === 'collection') {
+                            text = result.name;
+                            icon = 'sitemap';
+                        } else if (type === 'folder') {
+                            text = result.name;
+                            icon = 'folder';
+                        } else if (type === 'item') {
+                            text = result.name;
+                            icon = 'doc-text-inv';
+                        } else {
+                            if (this.getInfoCallback) {
+                                var res = this.getInfoCallback(type, result);
+                                if (res) {
+                                    text = res.text;
+                                    icon = res.icon;
+                                }
+                            }
+                            if (!text || !icon) {
+                                text = '[unknown type]';
+                                icon = 'attention';
+                            }
+                        }
+                        resources.push({
+                            type: type,
+                            id: result._id,
+                            text: text,
+                            icon: icon
+                        });
+                    }, this);
+                }, this);
+                this.$('.g-search-results>ul').html(SearchResultsTemplate({
+                    results: resources.slice(0, 6)
+                }));
+                this.$('.dropdown').addClass('open');
+            }
+        });
+    }
+}, {
+    _allowedSearchMode: {},
+
+    addMode: function (mode, types, description, help) {
+        if (_.has(SearchFieldWidget._allowedSearchMode, mode)) {
+            throw new Error(`The mode "${mode}" exist already. You can't change it`);
+        }
+        SearchFieldWidget._allowedSearchMode[mode] = {
+            types: types,
+            description: description,
+            help: help
+        };
+    },
+
+    getModes: function () {
+        return _.keys(SearchFieldWidget._allowedSearchMode);
+    },
+
+    getModeTypes: function (mode) {
+        return SearchFieldWidget._allowedSearchMode[mode].types;
+    },
+
+    getModeDescription: function (mode) {
+        return SearchFieldWidget._allowedSearchMode[mode].description;
+    },
+
+    getModeHelp: function (mode) {
+        return SearchFieldWidget._allowedSearchMode[mode].help;
+    },
+
+    removeMode: function (mode) {
+        delete SearchFieldWidget._allowedSearchMode[mode];
+    }
+});
+
+SearchFieldWidget.addMode(
+    'text',
+    ['item', 'folder', 'group', 'collection', 'user'],
+    'Full text search',
+    `By default, search results will be returned if they contain
+     any of the terms of the search. If you wish to search for documents
+     containing all of the terms, place them in quotes.
+     Examples:`
+);
+SearchFieldWidget.addMode(
+    'prefix',
+    ['item', 'folder', 'group', 'collection', 'user'],
+    'Search by prefix',
+    `You are searching by prefix.
+     Start typing the first letters of whatever you are searching for.`
+);
+
+export default SearchFieldWidget;

package/dist-lib/src/views/widgets/SearchPaginateWidget.js

@@ -0,0 +1,149 @@
+import _ from 'underscore';
+
+import View from '@girder/core/views/View';
+import { restRequest } from '@girder/core/rest';
+
+import PaginateWidgetTemplate from '@girder/core/templates/widgets/paginateWidget.pug';
+import SearchFieldWidget from '@girder/core/views/widgets/SearchFieldWidget';
+/**
+ * This widget is used to provide a consistent widget for iterating amongst
+ * pages of a list of search results (using a search mode, a query, an unique type,
+ * and a limit).
+ */
+
+var SearchPaginateWidget = View.extend({
+    events: {
+        'click .g-page-next:not(.disabled)': function () {
+            this._updateHasNextPage(true);
+        },
+        'click .g-page-prev:not(.disabled)': function () {
+            this._updateHasPreviousPage(true);
+        }
+    },
+
+    initialize: function (settings) {
+        this._type = settings.type;
+        this._query = settings.query;
+        this._mode = settings.mode;
+        this._limit = settings.limit;
+
+        this._offset = 0;
+        this._currentPage = 0;
+        this._hasNextPage = false;
+        this._hasPreviousPage = false;
+
+        this.results = null;
+
+        this._updateHasNextPage();
+    },
+
+    render: function () {
+        this.$el.html(PaginateWidgetTemplate({
+            collection: this
+        }));
+
+        this.$('.g-page-next').girderEnable(this._hasNextPage);
+        this.$('.g-page-prev').girderEnable(this._hasPreviousPage);
+
+        if (!this._hasNextPage && !this._hasPreviousPage) {
+            this.$el.hide();
+        } else {
+            this.$el.show();
+        }
+
+        return this;
+    },
+
+    pageNum: function () {
+        return this._currentPage;
+    },
+
+    _updateHasPreviousPage: function (update = false) {
+        if (this._currentPage) {
+            if (update) {
+                return this._fetchPreviousPage(update)
+                    .done(() => {
+                        return this._fetchPreviousPage();
+                    });
+            } else {
+                return this._fetchPreviousPage();
+            }
+        } else {
+            return this._fetchPreviousPage();
+        }
+    },
+
+    _updateHasNextPage: function (update = false) {
+        if (update) {
+            return this._fetchNextPage(update)
+                .done(() => {
+                    return this._fetchNextPage();
+                });
+        } else {
+            return this._fetchNextPage();
+        }
+    },
+
+    _fetchPreviousPage: function (update = false) {
+        var offset = this._limit * (this._currentPage - 1);
+        if (offset < 0) {
+            this._hasPreviousPage = false;
+            this.render();
+        } else {
+            return this._fetch(offset)
+                .done((results) => {
+                    var result = results[this._type];
+                    if (result.length) {
+                        this._hasPreviousPage = true;
+                        if (update) {
+                            this.results = result;
+                            this.trigger('g:changed');
+                            this._currentPage--;
+                            this._updateHasNextPage();
+                        }
+                    } else {
+                        this._hasPreviousPage = false;
+                    }
+                    this.render();
+                });
+        }
+    },
+
+    _fetchNextPage: function (update = false) {
+        var offset = this._limit * (this._currentPage + 1);
+        return this._fetch(offset)
+            .done((results) => {
+                var result = results[this._type];
+                if (result.length) {
+                    this._hasNextPage = true;
+                    if (update) {
+                        this.results = result;
+                        this.trigger('g:changed');
+                        this._currentPage++;
+                        this._updateHasPreviousPage();
+                    }
+                } else {
+                    this._hasNextPage = false;
+                }
+                this.render();
+            });
+    },
+
+    _fetch: function (offset) {
+        return restRequest({
+            url: 'resource/search',
+            data: {
+                q: this._query,
+                mode: this._mode,
+                types: JSON.stringify(_.intersection(
+                    [this._type],
+                    SearchFieldWidget.getModeTypes(this._mode))
+                ),
+                limit: this._limit,
+                offset: offset
+            }
+        });
+    }
+});
+
+export default SearchPaginateWidget;