@girder/core 5.0.0-beta.1 → 5.0.0

package/dist-lib/src/rest.js

@@ -0,0 +1,221 @@
+import $ from 'jquery';
+import _ from 'underscore';
+import Backbone from 'backbone';
+
+import events from '@girder/core/events';
+import { getCurrentToken, setCurrentUser, setCurrentToken } from '@girder/core/auth';
+
+let apiRoot;
+var uploadHandlers = {};
+var uploadChunkSize = 1024 * 1024 * 64; // 64MB
+
+/**
+ * Get the root path to the API.
+ *
+ * This may be an absolute path, or a path relative to the application root. It will never include
+ * a trailing slash.
+ *
+ * @returns {string}
+ */
+function getApiRoot() {
+    return apiRoot;
+}
+
+/**
+ * Set the root path to the API.
+ *
+ * @param {string} root The root path for the API.
+ */
+function setApiRoot(root) {
+    // Strip trailing slash
+    apiRoot = root.replace(/\/$/, '');
+}
+
+/**
+ * Make a request to the REST API.
+ *
+ * This is a wrapper around {@link http://api.jquery.com/jQuery.ajax/ $.ajax}, which also handles
+ * authentication and routing to the Girder API, and provides a default for error notification.
+ *
+ * Most users of this method should attach a "done" handler to the return value. In cases where the
+ * server is ordinarily expected to return a non-200 status (e.g. validating user input), the
+ * "error: null" argument should probably be provided, and errors should be processed via an
+ * attached "fail" handler.
+ *
+ * Before this function is called, the API root must be set (which typically happens automatically).
+ *
+ * @param {Object} opts Options for the request, most of which will be passed through to $.ajax.
+ * @param {string} opts.url The resource path, relative to the API root, without leading or trailing
+ *        slashes. e.g. "user/login"
+ * @param {string} [opts.method='GET'] The HTTP method to invoke.
+ * @param {string|Object} [opts.data] The query string or form parameter object.
+ * @param {?Function} [opts.error] An error callback, as documented in
+ *        {@link http://api.jquery.com/jQuery.ajax/ $.ajax}, or null. If not provided, this will
+ *        have a default behavior of triggering a 'g:alert' global event, with details of the
+ *        error, and logging the error to the console. It is recommended that you do not ever pass
+ *        a non-null callback function, and handle errors via promise rejection handlers instead.
+ * @param {string} [opts.girderToken] An alternative auth token to use for this request.
+ * @returns {$.Promise} A jqXHR promise, which resolves and rejects
+ *          {@link http://api.jquery.com/jQuery.ajax/#jqXHR as documented by $.ajax}.
+ */
+const restRequest = function (opts) {
+    opts = opts || {};
+    const defaults = {
+        // the default 'method' is 'GET', as set by 'jquery.ajax'
+
+        girderToken: getCurrentToken() || window.localStorage.getItem('girderToken'),
+
+        error: (error, status) => {
+            let info;
+            if (error.status === 401) {
+                setCurrentUser(null);
+                setCurrentToken(null);
+                events.trigger('g:loginUi');
+                info = {
+                    text: 'You must log in to view this resource',
+                    type: 'warning',
+                    timeout: 4000,
+                    icon: 'info'
+                };
+            } else if (error.status === 403) {
+                info = {
+                    text: 'Access denied. See the console for more details.',
+                    type: 'danger',
+                    timeout: 5000,
+                    icon: 'attention'
+                };
+            } else if (error.status === 0 && error.statusText === 'abort') {
+                /* We expected this abort, so do nothing. */
+                return;
+            } else if (error.status === 500 && error.responseJSON &&
+                error.responseJSON.type === 'girder') {
+                info = {
+                    text: error.responseJSON.message,
+                    type: 'warning',
+                    timeout: 5000,
+                    icon: 'info'
+                };
+            } else if (status === 'parsererror') {
+                info = {
+                    text: 'A parser error occurred while communicating with the ' +
+                          'server (did you use the correct value for `dataType`?). ' +
+                          'Details have been logged in the console.',
+                    type: 'danger',
+                    timeout: 5000,
+                    icon: 'attention'
+                };
+            } else {
+                info = {
+                    text: 'An error occurred while communicating with the ' +
+                          'server. Details have been logged in the console.',
+                    type: 'danger',
+                    timeout: 5000,
+                    icon: 'attention'
+                };
+            }
+            events.trigger('g:alert', info);
+            console.error(error.status + ' ' + error.statusText, error.responseText);
+        }
+    };
+
+    // Overwrite defaults with passed opts, but do not mutate opts
+    const args = _.extend({}, defaults, opts);
+
+    try {
+        // If the data is too large for a GET or PUT request, convert it to a POST request.
+        // Girder's REST API handles this for all requests.
+        if ((!args.method || args.method === 'GET' || args.method === 'PUT') && args.data && !args.contentType) {
+            if (JSON.stringify(args.data).length > 1536) {
+                args.headers = args.header || {};
+                args.headers['X-HTTP-Method-Override'] = args.method || 'GET';
+                args.method = 'POST';
+            }
+        }
+    } catch (err) { }
+
+    if (!args.url) {
+        throw new Error('restRequest requires a "url" argument');
+    }
+    args.url = `${getApiRoot()}${args.url.substring(0, 1) === '/' ? '' : '/'}${args.url}`;
+
+    if (args.girderToken) {
+        args.headers = args.headers || {};
+        args.headers['Girder-Token'] = args.girderToken;
+        delete args.girderToken;
+    }
+
+    return Backbone.$.ajax(args);
+};
+
+// All requests from Backbone should go through restRequest, adding authentication and the API root.
+Backbone.ajax = restRequest;
+
+/* Pending rest requests are listed in this pool so that they can be aborted or
+* checked if still processing. */
+var restXhrPool = {};
+var restXhrCount = 0;
+$(document).ajaxSend(function (event, xhr) {
+    restXhrCount += 1;
+    xhr.girderXhrNumber = restXhrCount;
+    restXhrPool[restXhrCount] = xhr;
+});
+$(document).ajaxComplete(function (event, xhr) {
+    var num = xhr.girderXhrNumber;
+    if (num && restXhrPool[num]) {
+        delete restXhrPool[num];
+    }
+});
+
+/* Get the number of outstanding rest requests.
+ * :param category: if specified, only count those requests that have
+ *                  xhr.girder[category] set to a truthy value.
+ * :returns: the number of outstanding requests.
+ */
+function numberOutstandingRestRequests(category) {
+    if (category) {
+        return _.filter(restXhrPool, function (xhr) {
+            return xhr.girder && xhr.girder[category];
+        }).length;
+    }
+    return _.size(restXhrPool);
+}
+
+/* Cancel outstanding rest requests.
+ * :param category: if specified, only abort those requests that have
+ *                  xhr.girder[category] set to a truthy value.
+ */
+function cancelRestRequests(category) {
+    _.each(restXhrPool, function (xhr) {
+        if (category && (!xhr.girder || !xhr.girder[category])) {
+            return;
+        }
+        if (xhr.abort) {
+            xhr.abort();
+        }
+    });
+}
+
+/*
+ * Get Upload Chunk Size
+ */
+function getUploadChunkSize() {
+    return uploadChunkSize;
+}
+
+/*
+ * Set Upload Chunk Size
+ */
+function setUploadChunkSize(val) {
+    uploadChunkSize = val;
+}
+
+export {
+    getApiRoot,
+    setApiRoot,
+    uploadHandlers,
+    restRequest,
+    numberOutstandingRestRequests,
+    cancelRestRequests,
+    getUploadChunkSize,
+    setUploadChunkSize
+};

package/dist-lib/src/router.js

@@ -0,0 +1,58 @@
+import $ from 'jquery';
+import Backbone from 'backbone';
+
+import events from '@girder/core/events';
+import { parseQueryString } from '@girder/core/misc';
+
+import '@girder/core/utilities/jquery/girderModal';
+
+var Router = Backbone.Router.extend({
+    initialize: function () {
+        this._enabled = true;
+    },
+
+    execute: function (callback, args) {
+        args.push(parseQueryString(args.pop()));
+        var queryString = args[args.length - 1];
+        if (callback) {
+            callback.apply(this, args);
+        }
+
+        // handle "top level" dialogs
+        if (queryString.dialog === 'login') {
+            events.trigger('g:loginUi');
+        } else if (queryString.dialog === 'register') {
+            events.trigger('g:registerUi');
+        } else if (queryString.dialog === 'resetpassword') {
+            events.trigger('g:resetPasswordUi');
+        }
+    },
+
+    /**
+     * Set or get the enabled state of the router. Call with a boolean argument
+     * to set the enabled state, or with no arguments to get the state.
+     */
+    enabled: function () {
+        if (arguments.length) {
+            this._enabled = !!arguments[0];
+        }
+        return this._enabled;
+    },
+
+    navigate: function () {
+        if (this._enabled) {
+            Backbone.Router.prototype.navigate.apply(this, arguments);
+        }
+    }
+});
+
+var router = new Router();
+
+// When the back button is pressed, we want to close open modals.
+router.on('route', function (route, params) {
+    if (!params.slice(-1)[0].dialog) {
+        $('.modal').girderModal('close');
+    }
+});
+
+export default router;

package/dist-lib/src/routes.js

@@ -0,0 +1,229 @@
+import router from '@girder/core/router';
+import events from '@girder/core/events';
+import eventStream from '@girder/core/utilities/EventStream';
+import { getCurrentUser, setCurrentUser } from '@girder/core/auth';
+import { restRequest } from '@girder/core/rest';
+
+/**
+ * Admin
+ */
+import AdminView from '@girder/core/views/body/AdminView';
+
+/**
+ * Assetstores
+ */
+import AssetstoresView from '@girder/core/views/body/AssetstoresView';
+
+/**
+ * Collections
+ */
+import CollectionsView from '@girder/core/views/body/CollectionsView';
+
+/**
+ * Collection
+ */
+import CollectionView from '@girder/core/views/body/CollectionView';
+
+/**
+ * Folder
+ */
+import FolderView from '@girder/core/views/body/FolderView';
+
+/**
+ * FrontPage
+ */
+import FrontPageView from '@girder/core/views/body/FrontPageView';
+
+/**
+ * Groups
+ */
+import GroupsView from '@girder/core/views/body/GroupsView';
+
+/**
+ * Group
+ */
+import GroupView from '@girder/core/views/body/GroupView';
+
+/**
+ * Item
+ */
+import ItemView from '@girder/core/views/body/ItemView';
+
+/**
+ * Plugins
+ */
+import PluginsView from '@girder/core/views/body/PluginsView';
+import UsersView from '@girder/core/views/body/UsersView';
+
+/**
+ * SystemConfiguration
+ */
+import SystemConfigurationView from '@girder/core/views/body/SystemConfigurationView';
+
+/**
+ * UserAccount
+ */
+import UserAccountView from '@girder/core/views/body/UserAccountView';
+import UserModel from '@girder/core/models/UserModel';
+
+/**
+ * User
+ */
+import UserView from '@girder/core/views/body/UserView';
+
+/**
+ * SearchResults
+ */
+import SearchResultsView from '@girder/core/views/body/SearchResultsView';
+router.route('admin', 'admin', function () {
+    events.trigger('g:navigateTo', AdminView);
+});
+router.route('assetstores', 'assetstores', function (params) {
+    events.trigger('g:navigateTo', AssetstoresView, {
+        assetstoreEdit: params.dialog === 'assetstoreedit' ? params.dialogid : false
+    });
+});
+router.route('assetstore/:id/import', 'assetstoreImport', function (assetstoreId) {
+    AssetstoresView.import(assetstoreId);
+});
+router.route('collections', 'collections', function (params) {
+    events.trigger('g:navigateTo', CollectionsView, params || {});
+    events.trigger('g:highlightItem', 'CollectionsView');
+});
+router.route('collection/:id', 'collectionAccess', function (cid, params) {
+    CollectionView.fetchAndInit(cid, {
+        access: params.dialog === 'access',
+        edit: params.dialog === 'edit',
+        folderCreate: params.dialog === 'foldercreate',
+        dialog: params.dialog
+    });
+});
+router.route('collection/:id/folder/:id', 'collectionFolder', function (cid, folderId, params) {
+    CollectionView.fetchAndInit(cid, {
+        folderId: folderId,
+        upload: params.dialog === 'upload',
+        access: params.dialog === 'access',
+        edit: params.dialog === 'edit',
+        folderAccess: params.dialog === 'folderaccess',
+        folderCreate: params.dialog === 'foldercreate',
+        folderEdit: params.dialog === 'folderedit',
+        itemCreate: params.dialog === 'itemcreate'
+    });
+});
+router.route('folder/:id', 'folder', function (id, params) {
+    FolderView.fetchAndInit(id, {
+        upload: params.dialog === 'upload',
+        folderAccess: params.dialog === 'folderaccess',
+        folderCreate: params.dialog === 'foldercreate',
+        folderEdit: params.dialog === 'folderedit',
+        itemCreate: params.dialog === 'itemcreate'
+    });
+});
+router.route('', 'index', function () {
+    events.trigger('g:navigateTo', FrontPageView);
+});
+router.route('groups', 'groups', function (params) {
+    events.trigger('g:navigateTo', GroupsView, params || {});
+    events.trigger('g:highlightItem', 'GroupsView');
+});
+router.route('group/:id', 'groupView', function (groupId, params) {
+    GroupView.fetchAndInit(groupId, {
+        edit: params.dialog === 'edit'
+    });
+});
+router.route('group/:id/:tab', 'groupView', function (groupId, tab, params) {
+    GroupView.fetchAndInit(groupId, {
+        edit: params.dialog === 'edit',
+        tab: tab
+    });
+});
+router.route('item/:id', 'item', function (itemId, params) {
+    ItemView.fetchAndInit(itemId, {
+        edit: params.dialog === 'itemedit',
+        fileEdit: params.dialog === 'fileedit' ? params.dialogid : false,
+        upload: params.dialog === 'upload' ? params.dialogid : false
+    });
+});
+router.route('plugins', 'plugins', function () {
+    events.trigger('g:navigateTo', PluginsView);
+});
+router.route('settings', 'settings', function () {
+    events.trigger('g:navigateTo', SystemConfigurationView);
+});
+router.route('useraccount/:id/:tab', 'accountTab', function (id, tab) {
+    UserAccountView.fetchAndInit(id, tab);
+});
+router.route('useraccount/:id/token/:token', 'accountToken', function (id, token) {
+    UserModel.fromTemporaryToken(id, token)
+        .done(() => {
+            events.trigger('g:navigateTo', UserAccountView, {
+                user: getCurrentUser(),
+                tab: 'password',
+                temporary: token
+            });
+        }).fail(() => {
+            router.navigate('', { trigger: true });
+        });
+});
+
+router.route('useraccount/:id/verification/:token', 'accountVerify', function (id, token) {
+    restRequest({
+        url: `user/${id}/verification`,
+        method: 'PUT',
+        data: { token: token },
+        error: null
+    }).done((resp) => {
+        if (resp.authToken) {
+            resp.user.token = resp.authToken.token;
+            eventStream.close();
+            setCurrentUser(new UserModel(resp.user));
+            eventStream.open();
+            events.trigger('g:login-changed');
+        }
+        events.trigger('g:navigateTo', FrontPageView);
+        events.trigger('g:alert', {
+            icon: 'ok',
+            text: 'Email verified.',
+            type: 'success',
+            timeout: 4000
+        });
+    }).fail(() => {
+        events.trigger('g:navigateTo', FrontPageView);
+        events.trigger('g:alert', {
+            icon: 'cancel',
+            text: 'Could not verify email.',
+            type: 'danger',
+            timeout: 4000
+        });
+    });
+});
+
+/**
+ * Users
+ */
+router.route('users', 'users', function (params) {
+    events.trigger('g:navigateTo', UsersView, params || {});
+    events.trigger('g:highlightItem', 'UsersView');
+});
+router.route('user/:id', 'user', function (userId, params) {
+    UserView.fetchAndInit(userId, {
+        folderCreate: params.dialog === 'foldercreate',
+        dialog: params.dialog
+    });
+});
+router.route('user/:id/folder/:id', 'userFolder', function (userId, folderId, params) {
+    UserView.fetchAndInit(userId, {
+        folderId: folderId,
+        upload: params.dialog === 'upload',
+        folderAccess: params.dialog === 'folderaccess',
+        folderCreate: params.dialog === 'foldercreate',
+        folderEdit: params.dialog === 'folderedit',
+        itemCreate: params.dialog === 'itemcreate'
+    });
+});
+router.route('search/results', 'SearchResults', function (params) {
+    events.trigger('g:navigateTo', SearchResultsView, {
+        query: params.query,
+        mode: params.mode
+    });
+});

package/dist-lib/src/stylesheets/apidocs/apidocs.styl

@@ -0,0 +1,50 @@
+@import "nib"
+
+$radius = 6px
+$border = 1px solid #d7d7d7
+
+body
+  font-family "Open Sans", sans-serif
+  background-color #adada1
+  margin 0
+
+.right
+  float right
+
+.docs-header
+  color white
+  background-color #3f3b3b
+  padding 11px 18px
+  font-size 24px
+  font-weight bold
+
+.docs-body
+  background-color white
+  padding 15px 18px 5px
+
+  p
+    margin-bottom 13px
+
+.docs-swagger-container
+  background-color #f0fafc
+  padding 5px 18px 12px
+  border-top $border
+
+@media screen and (min-width 990px)
+  .docs-header
+  .docs-body
+  .docs-swagger-container
+    max-width 960px
+    margin-left auto
+    margin-right auto
+    box-shadow 0 5px 12px 0 rgba(0, 0, 0, 0.2)
+
+  body
+    padding-bottom 25px
+    padding-top 25px
+
+  .docs-header
+    border-radius $radius $radius 0 0
+
+  .docs-swagger-container
+    border-radius 0 0 $radius $radius

package/dist-lib/src/stylesheets/body/adminConsole.styl

@@ -0,0 +1,21 @@
+ul.g-admin-options
+  list-style-type none
+  font-size 18px
+  padding-left 0
+  margin 0
+
+  >li
+    display block
+    padding 0
+    font-weight bold
+    color #666
+
+    >a
+      padding 12px 10px
+      color inherit
+      display block
+
+  >li:hover
+    background-color #f4f4f4
+    cursor pointer
+    color #222

package/dist-lib/src/stylesheets/body/assetstores.styl

@@ -0,0 +1,46 @@
+.g-current-assetstores-container
+  padding-bottom 10px
+  border-bottom 1px solid #d7d7d7
+
+.g-assetstore-buttons
+  margin-top 10px
+  .btn
+    margin-right 12px
+
+#g-new-assetstore-container
+  margin-top 10px
+
+.g-assetstore-capacity-chart
+  height 150px
+  width 280px
+
+.g-assetstore-container .panel-body
+  &:before
+    display none
+  &:after
+    display none
+
+.g-assetstore-current-text
+  font-weight bold
+  margin-left 10px
+
+.g-assetstore-current
+  background rgba(50, 118, 177, 0.25)
+  border-color #444
+
+.g-assetstore-button-container
+  display inline-block
+
+.jqplot-data-label
+  color black
+
+.g-assetstore-import-button-container
+  display inline-block
+
+.g-import-instructions
+  margin-bottom 22px
+  padding-top 8px
+  border-top 1px solid #eee
+
+.g-submit-assetstore-import
+  margin-top 7px

package/dist-lib/src/stylesheets/body/collectionList.styl

@@ -0,0 +1,39 @@
+.g-collection-list-entry
+
+  .g-collection-title
+    font-size 17px
+
+  .g-collection-right-column
+    border-left 1px solid #ddd
+    padding-left 8px
+    display inline
+    width 290px
+    font-size 14px
+    float right
+    color #909090
+
+  .g-collection-description
+    background-color white
+    padding 8px 12px
+    border-radius 3px
+    border 1px solid #dedede
+
+.g-collection-list-header
+  padding-bottom 10px
+
+  .g-collection-pagination
+    display inline-block
+    >ul
+      margin 0 15px 0 0
+
+    .pagination>li>a
+      float none
+      line-height 1.5
+      padding 7px 12px
+
+  .g-collection-search-form
+    display inline
+    margin-right 15px
+
+    .form-group
+      display inline-block

package/dist-lib/src/stylesheets/body/collectionPage.styl

@@ -0,0 +1,6 @@
+.g-collection-header
+  border-bottom 1px solid #ddd
+  margin-bottom 15px
+
+.g-collection-folders-container
+  margin-top 15px