@girder/core 5.0.0-beta.1 → 5.0.0-beta.2

package/dist-lib/src/templates/widgets/searchResults.pug

@@ -0,0 +1,14 @@
+each result in results
+  li.g-search-result
+    a.g-search-result-element(data-resource-id=result.id, data-resource-type=result.type, data-resource-icon=result.icon, tabindex="-1")
+      i(class=`icon-${result.icon}`)
+      | #{result.text}
+if results.length === 0
+  li.g-no-search-results.disabled
+    a(tabindex="-1")
+      i.icon-block
+        | No results found
+else
+  li.g-search-result
+    a.g-search-result-page-link(data-resource-type="resultPage")
+      | ...

package/dist-lib/src/templates/widgets/sortCollectionWidget.pug

@@ -0,0 +1,14 @@
+.btn-group
+  a.g-sort-order-button.g-up.btn.btn-sm(title="Sort order")
+    i.icon-sort-name-up
+  a.g-sort-order-button.g-down.btn.btn-sm(title="Sort order")
+    i.icon-sort-name-down
+  button.g-collection-sort-actions.btn.btn-sm.btn-default.dropdown-toggle(
+      data-toggle="dropdown", title="Sort by Field")
+    | Sort by
+    i.icon-down-dir
+  ul.g-collection-sort-menu.dropdown-menu(role="menu")
+    each fieldName, field in fields
+      li(role="presentation")
+        a.g-collection-sort-link(role="menuitem", g-sort=field)
+          = fieldName

package/dist-lib/src/templates/widgets/taskProgress.pug

@@ -0,0 +1,16 @@
+.g-task-progress-top
+  .g-task-progress-bar.progress(class=progressClass)
+    .progress-bar(class=barClass, style=`width: ${width};`)
+      .progress-status
+        .progress-percent
+          = percentText
+        .progress-left
+          = timeLeftText
+  .g-task-progress-title(title=progress.data.title)
+    if progress.data.resource && progress.data.resource._id && progress.data.resourceName
+      a(title=progress.data.title, href='#' + progress.data.resourceName + '/' + progress.data.resource._id)
+        = progress.data.title
+    else
+      = progress.data.title
+.g-task-progress-bottom
+  .g-task-progress-message= progress.data.message

package/dist-lib/src/templates/widgets/timeline.pug

@@ -0,0 +1,15 @@
+.g-timeline-widget-wrapper
+  .g-timeline-container
+    each segment in segments
+      .g-timeline-segment(
+          title=segment.tooltip, class=segment.class,
+          style=`left: ${segment.left}; width: ${segment.width}; ${segment.color}`)
+    each point in points
+      .g-timeline-point(
+          title=point.tooltip, class=point.class, style=`left: calc(${point.left} - 10px); ${point.color}`)
+  if startLabel !== undefined || endLabel !== undefined
+    .g-timeline-labels-container
+      if startLabel !== undefined
+        .g-timeline-start-label= startLabel
+      if endLabel !== undefined
+        .g-timeline-end-label= endLabel

package/dist-lib/src/templates/widgets/uploadWidget.pug

@@ -0,0 +1,15 @@
+include uploadWidgetMixins
+
+.modal-dialog
+  .modal-content
+    form#g-upload-form.modal-form(role="form")
+      .modal-header
+        button.close(data-dismiss="modal", aria-hidden="true", type="button") ×
+        h4.modal-title= title
+        +g-upload-widget-subtitle
+      .modal-body
+        +g-upload-widget-browse-or-drop
+        +g-upload-widget-progress
+      .modal-footer
+        a.btn.btn-small.btn-default(data-dismiss="modal") Close
+        +g-upload-widget-start-button

package/dist-lib/src/templates/widgets/uploadWidgetMixins.pug

@@ -0,0 +1,31 @@
+mixin g-upload-widget-subtitle
+  if parent && parentType
+    .g-dialog-subtitle
+      if (parentType === 'folder')
+        i.icon-folder-open
+      else if (parentType === 'item')
+        i.icon-doc-text-inv
+      else if (parentType === 'file')
+        i.icon-doc-inv
+      = parent.name()
+
+mixin g-upload-widget-browse-or-drop
+  .g-drop-zone
+    i.icon-docs
+    |  #{browseText}
+  .form-group.hide
+    input#g-files(type="file", multiple=(multiFile ? 'multiple' : null))
+
+mixin g-upload-widget-progress
+  .g-current-progress-message
+  .g-progress-current.progress.progress-striped.hide
+    .progress-bar.progress-bar-info(role="progressbar")
+  .g-overall-progress-message= noneSelectedText
+  .g-progress-overall.progress.progress-striped.hide
+    .progress-bar.progress-bar-info(role="progressbar")
+  .g-upload-error-message.g-validation-failed-message
+
+mixin g-upload-widget-start-button
+  button.g-start-upload.btn.btn-small.btn-primary.disabled(type="submit", disabled)
+    i.icon-upload
+    |  Start Upload

package/dist-lib/src/templates/widgets/uploadWidgetNonModal.pug

@@ -0,0 +1,10 @@
+include uploadWidgetMixins
+
+form#g-upload-form
+  if title
+    h4= title
+  +g-upload-widget-subtitle
+  +g-upload-widget-browse-or-drop
+  +g-upload-widget-progress
+  .g-nonmodal-upload-buttons-container
+    +g-upload-widget-start-button

package/dist-lib/src/templates/widgets/userOtpBegin.pug

@@ -0,0 +1,4 @@
+h2 Enable Two-factor authentication
+
+button#g-user-otp-initialize-enable.btn.btn-primary(type="submit")
+  |  Begin

package/dist-lib/src/templates/widgets/userOtpDisable.pug

@@ -0,0 +1,6 @@
+h2.g-user-otp-heading-enable Two-factor authentication is currently enabled
+
+h3.g-user-otp-heading-disable Disable Two-factor authentication
+
+button#g-user-otp-disable.btn.btn-primary(type="submit")
+  |  Disable

package/dist-lib/src/templates/widgets/userOtpEnable.pug

@@ -0,0 +1,44 @@
+h2 Enable Two-factor authentication
+
+ol.g-account-otp-steps
+  li.g-account-otp-step
+    h3 Install an authenticator app on your mobile device.
+    div.
+      There are many compatible apps, including, but not limited to
+      #[a(href='https://support.google.com/accounts/answer/1066447?hl=en', target='_blank', rel='noopener') Google Authenticator],
+      #[a(href='https://guide.duo.com/third-party-accounts', target='_blank', rel='noopener') Duo Mobile], and
+      #[a(href='https://freeotp.github.io/', target='_blank', rel='noopener') FreeOTP].
+  li.g-account-otp-step
+    h3 Enter your key into the authenticator app
+    .g-account-otp-scan-qr
+      h4 Scan with your mobile device's camera:
+      canvas#g-user-otp-qr
+    .g-account-otp-enter-manual
+      h4 Advanced Users:
+        span You may enter your information manually, instead:
+      table
+        tr
+          th Service
+          td
+            code= totpInfo.issuer
+        tr
+          th Account
+          td
+            code= totpInfo.account
+        tr
+          th Key
+          td
+            // Split into 4-character chunks for human readability
+            code= totpInfo.key.match(/.{1,4}/g).join('-')
+        tr
+          th Type
+          td
+            span #[code Time-based] / #[code TOTP]
+  li.g-account-otp-step
+    h3 Enter the authentication code from your app
+    input#g-user-otp-token(type='text', minlength=6, maxlength=6, placeholder='Your 6-digit code')
+    div
+      span#g-account-otp-error.g-validation-failed-message
+.g-user-otp-footer
+  a#g-user-otp-cancel-enable.btn.btn-default Cancel
+  button#g-user-otp-finalize-enable.btn.btn-primary.btn-success(type="submit") Enable Two-Factor

package/dist-lib/src/utilities/EventStream.js

@@ -0,0 +1,177 @@
+import $ from 'jquery';
+import _ from 'underscore';
+import Backbone from 'backbone';
+
+import { getApiRoot, restRequest } from '@girder/core/rest';
+
+/**
+ * The EventStream type wraps window.EventSource to listen to the unified
+ * per-user event channel endpoint using the SSE protocol. When events are
+ * received on the SSE channel, this triggers a Backbone event of the form
+ * 'g:event.<type>' where <type> is the value of the event type field.
+ * Listeners can bind to specific event types on the channel.
+ */
+function EventStream(settings) {
+    const defaults = {
+        timeout: null,
+        streamPath: '/notification/stream'
+    };
+
+    // User-provided settings from initialization
+    this.settings = _.extend(defaults, settings);
+    // Possible states are 'closed', 'stopped', 'started'
+    this._state = 'closed';
+    // Whether this is started (if so, holds the EventSource instance)
+    this._eventSource = null;
+
+    // Create context bindings only once, so they can be referenced when unbinding events
+    this._onVisibilityStateChange = _.bind(this._onVisibilityStateChange, this);
+    this._onMessage = _.bind(this._onMessage, this);
+    this._onError = _.bind(this._onError, this);
+
+    return _.extend(this, Backbone.Events);
+}
+
+EventStream.prototype._onVisibilityStateChange = function () {
+    if (document.visibilityState === 'visible' && this._state === 'stopped') {
+        this._start();
+    } else if (document.visibilityState === 'hidden' && this._state === 'started') {
+        this._stop();
+    }
+};
+
+EventStream.prototype._onMessage = function (e) {
+    let obj;
+    try {
+        obj = window.JSON.parse(e.data);
+    } catch (err) {
+        console.error('Invalid JSON from SSE stream: ' + e.data + ',' + err);
+        this.trigger('g:error', e);
+        return;
+    }
+    EventStream.setLastTimestamp(obj._girderTime);
+    this.trigger('g:event.' + obj.type, obj);
+};
+
+EventStream.prototype._onError = function () {
+    // The EventSource.onerror API does not provide the HTTP status code of the error, so send an Ajax HEAD request to
+    // capture the status code.
+    restRequest({
+        url: this.settings.streamPath,
+        method: 'HEAD',
+        error: null
+    })
+        .fail((jqXHR) => {
+            if (jqXHR.status === 503) {
+                // Notification stream is disabled, so close this EventStream
+                this.trigger('g:eventStream.disable', jqXHR);
+                this.close();
+            }
+        });
+    // In all other cases (HEAD doesn't fail, or fails with a non-503 code), assume this is a temporary outage and allow
+    // the EventStream to continue attempting to auto-connect
+};
+
+EventStream.prototype.open = function () {
+    if (!window.EventSource) {
+        console.error('EventSource is not supported on this platform.');
+        this.trigger('g:eventStream.disable');
+        return;
+    }
+    if (this._state !== 'closed') {
+        console.warn('EventStream should be closed.');
+        return;
+    }
+
+    this._state = 'stopped';
+    this._start();
+
+    document.addEventListener('visibilitychange', this._onVisibilityStateChange);
+};
+
+EventStream.prototype._start = function () {
+    if (this._state !== 'stopped') {
+        console.warn('EventStream should be stopped');
+        return;
+    }
+
+    const params = {};
+
+    if (this.settings.timeout) {
+        params.timeout = this.settings.timeout;
+    }
+
+    // Set the "since" argument to filter out notifications that have already been sent to this client.
+    const timestamp = EventStream.getLastTimestamp();
+    if (_.isNumber(timestamp)) {
+        params.since = timestamp;
+    }
+
+    const url = getApiRoot() + this.settings.streamPath + '?' + $.param(params);
+
+    this._eventSource = new window.EventSource(url);
+    this._eventSource.onmessage = this._onMessage;
+    this._eventSource.onerror = this._onError;
+
+    this._state = 'started';
+    this.trigger('g:eventStream.start');
+};
+
+EventStream.prototype._stop = function () {
+    if (this._state !== 'started') {
+        console.warn('EventStream should be started');
+        return;
+    }
+
+    this._eventSource.close();
+    this._eventSource = null;
+
+    this._state = 'stopped';
+    this.trigger('g:eventStream.stop');
+};
+
+EventStream.prototype.close = function () {
+    if (this._state === 'closed') {
+        console.warn('EventStream should not be closed');
+        return;
+    }
+
+    document.removeEventListener('visibilitychange', this._onVisibilityStateChange);
+
+    if (this._state === 'started') {
+        this._stop();
+    }
+
+    this._state = 'closed';
+    this.trigger('g:eventStream.close');
+};
+
+// Static methods
+EventStream._lastTimestamp = null;
+EventStream.setLastTimestamp = function (timestamp) {
+    try {
+        window.localStorage.setItem('sseTimestamp', timestamp);
+    } catch (e) {
+        // Ignore any errors raised by localStorage
+    }
+    EventStream._lastTimestamp = timestamp;
+};
+EventStream.getLastTimestamp = function () {
+    let timestamp;
+    try {
+        timestamp = parseInt(window.localStorage.getItem('sseTimestamp'), 10);
+    } catch (e) {
+        // Ignore any errors raised by localStorage
+    }
+    if (!_.isNaN(timestamp)) {
+        // An int was parsed
+        return timestamp;
+    } else {
+        // Value could not be gotten from localStorage, so return from fallback (which is also the default of null)f
+        return EventStream._lastTimestamp;
+    }
+};
+
+const eventStream = new EventStream();
+
+export default eventStream;

package/dist-lib/src/utilities/PluginUtils.js

@@ -0,0 +1,36 @@
+import _ from 'underscore';
+
+/**
+ * Wrap the prototype method of a given object.
+ *
+ * @param obj The object whose prototype to extend, e.g. MyView
+ * @param funcName The name of the function to wrap, e.g. "render"
+ * @param wrapper The wrapper function, which should be a function taking the
+ *     underlying wrapped function as its first argument. The wrapped function
+ *     should be called with .call(this[, arguments]) inside of the wrapper in
+ *     order to preserve "this" semantics.
+ */
+function wrap(obj, funcName, wrapper) {
+    obj.prototype[funcName] = _.wrap(obj.prototype[funcName], wrapper);
+}
+
+var _pluginConfigRoutes = {};
+
+/**
+ * Expose a plugin configuration page via the admin plugins page.
+ * @param pluginName The canonical plugin name, i.e. its directory name
+ * @param route The route to trigger that will render the plugin config.
+ */
+function exposePluginConfig(pluginName, route) {
+    _pluginConfigRoutes[pluginName] = route;
+}
+
+function getPluginConfigRoute(pluginName) {
+    return _pluginConfigRoutes[pluginName];
+}
+
+export {
+    exposePluginConfig,
+    getPluginConfigRoute,
+    wrap
+};