@girder/core 3.2.3 → 5.0.0-beta.1

package/collections/GroupCollection.js

@@ -1,9 +0,0 @@
-import Collection from '@girder/core/collections/Collection';
-import GroupModel from '@girder/core/models/GroupModel';
-
-var GroupCollection = Collection.extend({
-    resourceName: 'group',
-    model: GroupModel
-});
-
-export default GroupCollection;

package/collections/ItemCollection.js

@@ -1,11 +0,0 @@
-import Collection from '@girder/core/collections/Collection';
-import ItemModel from '@girder/core/models/ItemModel';
-
-var ItemCollection = Collection.extend({
-    resourceName: 'item',
-    model: ItemModel,
-
-    pageLimit: 100
-});
-
-export default ItemCollection;

package/collections/UserCollection.js

@@ -1,24 +0,0 @@
-import Collection from '@girder/core/collections/Collection';
-import UserModel from '@girder/core/models/UserModel';
-import { restRequest } from '@girder/core/rest';
-
-var UserCollection = Collection.extend({
-    resourceName: 'user',
-    model: UserModel,
-
-    // Override default sort field
-    sortField: 'lastName',
-    secondarySortField: 'firstName'
-}, {
-    getTotalCount: function () {
-        return restRequest({
-            url: 'user/details',
-            method: 'GET'
-        })
-            .then((resp) => {
-                return resp.nUsers;
-            });
-    }
-});
-
-export default UserCollection;

package/collections/index.js

@@ -1,21 +0,0 @@
-import ApiKeyCollection from './ApiKeyCollection';
-import AssetstoreCollection from './AssetstoreCollection';
-import Collection from './Collection';
-import CollectionCollection from './CollectionCollection';
-import FileCollection from './FileCollection';
-import FolderCollection from './FolderCollection';
-import GroupCollection from './GroupCollection';
-import ItemCollection from './ItemCollection';
-import UserCollection from './UserCollection';
-
-export {
-    ApiKeyCollection,
-    AssetstoreCollection,
-    Collection,
-    CollectionCollection,
-    FileCollection,
-    FolderCollection,
-    GroupCollection,
-    ItemCollection,
-    UserCollection
-};

package/constants.js

@@ -1,33 +0,0 @@
-var SORT_ASC = 1;
-var SORT_DESC = -1;
-
-var MONTHS = [
-    'January', 'February', 'March', 'April', 'May', 'June', 'July',
-    'August', 'September', 'October', 'November', 'December'
-];
-
-var AccessType = {
-    NONE: -1,
-    READ: 0,
-    WRITE: 1,
-    ADMIN: 2
-};
-
-var AssetstoreType = {
-    FILESYSTEM: 0,
-    GRIDFS: 1,
-    S3: 2
-};
-
-var Layout = {
-    DEFAULT: 'default',
-    EMPTY: 'empty'
-};
-
-export {
-    SORT_ASC, SORT_DESC,
-    MONTHS,
-    AccessType,
-    AssetstoreType,
-    Layout
-};

package/dialog.js

@@ -1,128 +0,0 @@
-import $ from 'jquery';
-import _ from 'underscore';
-import Backbone from 'backbone';
-
-import router from '@girder/core/router';
-import { parseQueryString, splitRoute } from '@girder/core/misc';
-
-import ConfirmDialogTemplate from '@girder/core/templates/widgets/confirmDialog.pug';
-
-import '@girder/core/utilities/jquery/girderModal';
-
-function handleClose(name, options, nameId) {
-    if (!router.enabled()) {
-        return;
-    }
-    var curRoute = Backbone.history.fragment,
-        routeParts = splitRoute(curRoute),
-        queryString = parseQueryString(routeParts.name),
-        dialogName = queryString.dialog,
-        dialogId = queryString.dialogid;
-    delete queryString.dialog;
-    delete queryString.dialogid;
-    var unparsedQueryString = $.param(queryString);
-    if (unparsedQueryString.length > 0) {
-        unparsedQueryString = '?' + unparsedQueryString;
-    }
-    if (dialogName === name && dialogId === nameId) {
-        router.navigate(routeParts.base + unparsedQueryString, options);
-    }
-}
-
-function handleOpen(name, options, nameId) {
-    if (!router.enabled()) {
-        return;
-    }
-    var curRoute = Backbone.history.fragment,
-        routeParts = splitRoute(curRoute),
-        queryString = parseQueryString(routeParts.name),
-        dialogName = queryString.dialog,
-        dialogId = queryString.dialogid;
-
-    if (dialogName !== name || nameId !== dialogId) {
-        queryString.dialog = name;
-        if (nameId) {
-            queryString.dialogid = nameId;
-        }
-        var unparsedQueryString = $.param(queryString);
-        if (unparsedQueryString.length > 0) {
-            unparsedQueryString = '?' + unparsedQueryString;
-        }
-        router.navigate(routeParts.base + unparsedQueryString, options);
-    }
-}
-
-/**
- * Prompt the user to confirm an action.
- * @param {Object} [params] Parameters controlling this function's behavior.
- * @param {String} [params.text] The text to prompt the user with.
- * @param {String} [params.yesText] The text for the confirm button.
- * @param {String} [params.yesClass] Class string to apply to the confirm button.
- * @param {String} [params.noText] The text for the no/cancel button.
- * @param {Boolean} [params.escapedHtml] If you want to render the text as HTML rather than
- *        plain text, set this to true to acknowledge that you have escaped any
- *        user-created data within the text to prevent XSS exploits.
- * @param {Boolean} [params.msgConfirmation] If you want to add a new security before
- *        perform an action. This will ask to enter a specific string "params.yesText params.name"
- * @param {String} [params.additionalText] Additional text to display before the confirmation
- *        input.
- * @param {String} [params.name] The name to enter in order to confirm an action.
- * @param {Function} [params.confirmCallback]Callback function when the user confirms the action.
- */
-function confirm(params) {
-    params = _.extend({
-        text: 'Are you sure?',
-        yesText: 'Yes',
-        yesClass: 'btn-danger',
-        noText: 'Cancel',
-        escapedHtml: false,
-        msgConfirmation: false,
-        additionalText: '',
-        name: ''
-    }, params);
-    $('#g-dialog-container').html(ConfirmDialogTemplate({
-        params: params
-    })).girderModal(false).one('hidden.bs.modal', function () {
-        $('#g-confirm-button').off('click');
-    });
-
-    const el = $('#g-dialog-container').find('.modal-body>p:first-child');
-    if (params.escapedHtml) {
-        el.html(params.text);
-    } else {
-        el.text(params.text);
-    }
-    if (params.msgConfirmation) {
-        if (params.escapedHtml) {
-            $('.g-additional-text').html(params.additionalText);
-        } else {
-            $('.g-additional-text').text(params.additionalText);
-        }
-    }
-
-    $('#g-confirm-button').off('click').on('click', function () {
-        if (params.msgConfirmation) {
-            const key = `${params.yesText.toUpperCase()} ${params.name}`;
-            const msg = $('#g-confirm-text').val();
-            if (msg.toUpperCase() === key.toUpperCase()) {
-                $('#g-dialog-container').modal('hide');
-                params.confirmCallback();
-            } else if (msg.toUpperCase() === '') {
-                $('.g-msg-error').html(`Error: You need to enter <b>'${key}'</b>.`);
-                $('.g-msg-error').css('color', 'red');
-            } else {
-                $('.g-msg-error').html(`Error: <b>'${msg}'</b> isn't <b>'${key}'</b>`);
-                $('.g-msg-error').css('color', 'red');
-            }
-        } else {
-            $('#g-dialog-container').modal('hide');
-            params.confirmCallback();
-        }
-    });
-}
-
-export {
-    confirm,
-    handleClose,
-    handleOpen
-};

package/events.js

@@ -1,6 +0,0 @@
-import _ from 'underscore';
-import Backbone from 'backbone';
-
-var girderEvents = _.clone(Backbone.Events);
-
-export default girderEvents;

package/index.js

@@ -1,31 +0,0 @@
-import * as auth from './auth';
-import * as collections from './collections';
-import * as constants from './constants';
-import * as dialog from './dialog';
-import * as misc from './misc';
-import * as models from './models';
-import * as rest from './rest';
-import * as utilities from './utilities';
-import * as views from './views';
-import events from './events';
-import router from './router';
-import version from './version';
-
-// This will be modified dynamically when plugins are loaded.
-var plugins = {};
-
-export {
-    auth,
-    collections,
-    constants,
-    dialog,
-    events,
-    misc,
-    models,
-    plugins,
-    rest,
-    router,
-    utilities,
-    version,
-    views
-};

package/main.js

@@ -1,21 +0,0 @@
-import $ from 'jquery';
-import _ from 'underscore';
-import Backbone from 'backbone';
-import moment from 'moment';
-import * as girder from '@girder/core';
-
-window.girder = girder;
-
-// Some cross-browser globals
-if (!window.console) {
-    window.console = {
-        log: $.noop,
-        error: $.noop
-    };
-}
-
-// For testing and convenience, available now because of testUtils.js reliance on $
-window.$ = $;
-window._ = _;
-window.moment = moment;
-window.Backbone = Backbone;

package/misc.js

@@ -1,260 +0,0 @@
-import $ from 'jquery';
-import _ from 'underscore';
-
-import { MONTHS } from '@girder/core/constants';
-
-import { Remarkable } from 'remarkable';
-
-import { linkify } from 'remarkable/linkify';
-
-/**
- * This file contains utility functions for general use in the application
- */
-var DATE_MONTH = 0;
-var DATE_DAY = 1;
-var DATE_MINUTE = 2;
-var DATE_SECOND = 3;
-
-/**
- * Format a date string to the given resolution.
- * @param datestr The date string to format.
- * @param resolution The resolution, defaults to 'day'. Minimum is month.
- */
-function formatDate(datestr, resolution) {
-    datestr = datestr.replace(' ', 'T'); // Cross-browser accepted date format
-    var date = new Date(datestr);
-    var output = MONTHS[date.getMonth()];
-
-    resolution = resolution || DATE_MONTH;
-
-    if (resolution >= DATE_DAY) {
-        output += ' ' + date.getDate() + ',';
-    }
-
-    output += ' ' + date.getFullYear();
-
-    if (resolution >= DATE_MINUTE) {
-        output += ' at ' + date.getHours() + ':' +
-            ('0' + date.getMinutes()).slice(-2);
-    }
-    if (resolution >= DATE_SECOND) {
-        output += ':' + ('0' + date.getSeconds()).slice(-2);
-    }
-
-    return output;
-}
-
-/**
- * Format a size in bytes into a human-readable string with metric unit
- * prefixes.
- */
-function formatSize(sizeBytes) {
-    if (sizeBytes < 1024) {
-        return sizeBytes + ' B';
-    }
-    var i, sizeVal = sizeBytes, precision = 1;
-    for (i = 0; sizeVal >= 1024; i += 1) {
-        sizeVal /= 1024;
-    }
-    // If we are just reporting a low number, no need for decimal places.
-    if (sizeVal < 10) {
-        precision = 3;
-    } else if (sizeVal < 100) {
-        precision = 2;
-    }
-    return sizeVal.toFixed(precision) + ' ' +
-        ['B', 'kB', 'MB', 'GB', 'TB'][Math.min(i, 4)];
-}
-
-/**
- * Like formatSize, but more generic. Returns a human-readable format
- * of an integer using metric prefixes. The caller is expected to append any
- * unit string if necessary.
- *
- * @param {integer} n The number to format.
- * @param {Object} [opts={}] Formatting options. These include:
- *   - {integer} [maxLen] Max number of digits in the output.
- *   - {integer} [base=1000] Base for the prefixes (usually 1000 or 1024).
- *   - {string} [sep=''] Separator between numeric value and metric prefix.
- */
-function formatCount(n, opts) {
-    n = n || 0;
-    opts = opts || {};
-
-    var i = 0,
-        base = opts.base || 1000,
-        sep = opts.sep || '',
-        maxLen = opts.maxLen || 3,
-        precision = maxLen - 1;
-
-    for (; n > base; i += 1) {
-        n /= base;
-    }
-
-    if (!i) {
-        precision = 0;
-    } else if (n > 100) {
-        precision -= 2;
-    } else if (n > 10) {
-        precision -= 1;
-    }
-
-    return n.toFixed(Math.max(0, precision)) + sep +
-        ['', 'k', 'M', 'G', 'T'][Math.min(i, 4)];
-}
-
-/**
- * This comparator can be used by collections that wish to support locale-based
- * sorting.  The locale specifies how upper and lower case are compared.
- */
-function localeComparator(model1, model2) {
-    var a1 = model1.get(this.sortField),
-        a2 = model2.get(this.sortField);
-
-    if (a1 !== undefined && a1.localeCompare) {
-        var result = a1.localeCompare(a2) * this.sortDir;
-        if (result || !this.secondarySortField) {
-            return result;
-        }
-        a1 = model1.get(this.secondarySortField);
-        a2 = model2.get(this.secondarySortField);
-        return a1.localeCompare(a2) * this.sortDir;
-    }
-
-    return a1 > a2 ? this.sortDir : (a1 < a2 ? -this.sortDir : 0);
-}
-
-/**
- * This comparator can be passed to the sort function on javascript arrays.
- */
-function localeSort(a1, a2) {
-    if (a1 !== undefined && a1.localeCompare) {
-        return a1.localeCompare(a2);
-    }
-    return a1 > a2 ? 1 : (a1 < a2 ? -1 : 0);
-}
-
-/**
- * Return the model class name given its collection name.
- * @param name Collection name, e.g. 'user'
- */
-function getModelClassByName(name) {
-    var className = name.charAt(0).toUpperCase();
-    return className + name.substr(1) + 'Model';
-}
-
-function parseQueryString(queryString) {
-    var params = {};
-    if (queryString) {
-        _.each(queryString.replace(/\+/g, ' ').split(/&/g), function (el) {
-            var aux = el.split('='), val;
-            if (aux.length > 1) {
-                val = decodeURIComponent(el.substr(aux[0].length + 1));
-            }
-            params[decodeURIComponent(aux[0])] = val;
-        });
-    }
-    return params;
-}
-
-/**
- * Create a set of flags that can be OR'd (|) together to define a set of
- * options.
- *
- * @param {Array} options An array of strings defining the option names.
- * @param {string} allOption If you want an option that enables all options,
- *                 pass its name as this parameter.
- * @return {Object} An object mapping the names of options to values.
- */
-function defineFlags(options, allOption) {
-    var i = 0,
-        obj = {};
-
-    if (allOption) {
-        obj[allOption] = 1;
-    }
-    _.each(options, function (opt) {
-        obj[opt] = 1 << i;
-
-        if (allOption) {
-            obj[allOption] |= obj[opt];
-        }
-
-        i += 1;
-    });
-
-    return obj;
-}
-
-/**
- * Transform markdown into HTML and render it into the given element. If no
- * element is provided, simply returns the HTML.
- *
- * @param val The markdown text input.
- * @param el The element to render the output HTML into, or falsy to simply
- *        return the HTML value.
- */
-var renderMarkdown = (function () {
-    var md = new Remarkable().use(linkify);
-    return function (val, el) {
-        if (el) {
-            $(el).html(md.render(val));
-        } else {
-            return md.render(val);
-        }
-    };
-}());
-
-/**
- * Capitalize the first character of a string.
- */
-function capitalize(str) {
-    return str.charAt(0).toUpperCase() + str.substring(1);
-}
-
-function splitRoute(route) {
-    if (!route) {
-        return { base: '', name: '' };
-    }
-    var firstIndex = route.indexOf('?'),
-        lastIndex = route.lastIndexOf('?'),
-        dialogName,
-        baseRoute;
-
-    if (firstIndex === -1) {
-        baseRoute = route;
-    } else {
-        baseRoute = route.slice(0, firstIndex);
-    }
-
-    if (lastIndex === -1) {
-        dialogName = '';
-    } else {
-        dialogName = route.slice(lastIndex + 1);
-    }
-
-    return { name: dialogName, base: baseRoute };
-}
-
-function _whenAll(promises) {
-    return $.when(...promises).then((...results) => results);
-}
-
-export {
-    DATE_MONTH,
-    DATE_DAY,
-    DATE_MINUTE,
-    DATE_SECOND,
-    formatDate,
-    formatSize,
-    formatCount,
-    localeComparator,
-    localeSort,
-    getModelClassByName,
-    parseQueryString,
-    defineFlags,
-    renderMarkdown,
-    capitalize,
-    splitRoute,
-    _whenAll
-};

package/models/AccessControlledModel.js

@@ -1,76 +0,0 @@
-import $ from 'jquery';
-import _ from 'underscore';
-
-import Model from '@girder/core/models/Model';
-import { restRequest } from '@girder/core/rest';
-
-/**
- * Models corresponding to AccessControlledModels on the server should extend
- * from this object. It provides utilities for managing and storing the
- * access control list on
- */
-var AccessControlledModel = Model.extend({
-    /**
-     * Saves the access control list on this model to the server. Saves the
-     * state of whatever this model's "access" parameter is set to, which
-     * should be an object of the form:
-     *    {groups: [{id: <groupId>, level: <accessLevel>}, ...],
-     *     users: [{id: <userId>, level: <accessLevel>}, ...]}
-     * The "public" attribute of this model should also be set as a boolean.
-     * When done, triggers the 'g:accessListSaved' event on the model.
-     */
-    updateAccess: function (params) {
-        if (this.altUrl === null && this.resourceName === null) {
-            throw new Error('An altUrl or resourceName must be set on the Model.');
-        }
-
-        return restRequest({
-            url: `${this.altUrl || this.resourceName}/${this.id}/access`,
-            method: 'PUT',
-            data: _.extend({
-                access: JSON.stringify(this.get('access')),
-                public: this.get('public'),
-                publicFlags: JSON.stringify(this.get('publicFlags') || [])
-            }, params || {})
-        }).done(() => {
-            this.trigger('g:accessListSaved');
-        }).fail((err) => {
-            this.trigger('g:error', err);
-        });
-    },
-
-    /**
-     * Fetches the access control list from the server, and sets it as the
-     * access property.
-     * @param force By default, this only fetches access if it hasn't already
-     *              been set on the model. If you want to force a refresh
-     *              anyway, set this param to true.
-     */
-    fetchAccess: function (force) {
-        if (this.altUrl === null && this.resourceName === null) {
-            throw new Error('An altUrl or resourceName must be set on the Model.');
-        }
-
-        if (!this.get('access') || force) {
-            return restRequest({
-                url: `${this.altUrl || this.resourceName}/${this.id}/access`,
-                method: 'GET'
-            }).done((resp) => {
-                if (resp.access) {
-                    this.set(resp);
-                } else {
-                    this.set('access', resp);
-                }
-                this.trigger('g:accessFetched');
-                return resp;
-            }).fail((err) => {
-                this.trigger('g:error', err);
-            });
-        } else {
-            this.trigger('g:accessFetched');
-            return $.Deferred().resolve(this.get('access')).promise();
-        }
-    }
-});
-
-export default AccessControlledModel;

package/models/ApiKeyModel.js

@@ -1,31 +0,0 @@
-import AccessControlledModel from '@girder/core/models/AccessControlledModel';
-import { restRequest } from '@girder/core/rest';
-
-var ApiKeyModel = AccessControlledModel.extend({
-    resourceName: 'api_key',
-
-    setActive: function (active) {
-        return restRequest({
-            url: `api_key/${this.id}`,
-            method: 'PUT',
-            data: {
-                active: active
-            }
-        }).done(() => {
-            this.set({ active: active });
-            this.trigger('g:setActive');
-        });
-    },
-
-    save: function () {
-        // Scope needs to be sent to the server as JSON
-        var scope = this.get('scope');
-        this.set('scope', JSON.stringify(scope), { silent: true }); // eslint-disable-line backbone/no-silent
-        var promise = AccessControlledModel.prototype.save.call(this, arguments);
-        // Restore scope to its original state
-        this.set('scope', scope, { silent: true }); // eslint-disable-line backbone/no-silent
-        return promise;
-    }
-});
-
-export default ApiKeyModel;