@instructure/canvas-rce 5.13.2 → 5.13.5

package/es/rce/plugins/shared/canvasContentUtils.js

@@ -0,0 +1,190 @@
+/*
+ * Copyright (C) 2024 - present Instructure, Inc.
+ *
+ * This file is part of Canvas.
+ *
+ * Canvas is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU Affero General Public License as published by the Free
+ * Software Foundation, version 3 of the License.
+ *
+ * Canvas 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 Affero General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU Affero General Public License along
+ * with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+import React, { Suspense } from 'react';
+import { Spinner } from '@instructure/ui-spinner';
+import formatMessage from '../../../format-message';
+import { ICON_MAKER_ICONS } from '../instructure_icon_maker/svg/constants';
+const thePanels = {
+  icon_maker_icons: /*#__PURE__*/React.lazy(() => import('../instructure_icon_maker/components/SavedIconMakerList')),
+  links: /*#__PURE__*/React.lazy(() => import('../instructure_links/components/LinksPanel')),
+  images: /*#__PURE__*/React.lazy(() => import('../instructure_image/Images')),
+  documents: /*#__PURE__*/React.lazy(() => import('../instructure_documents/components/DocumentsPanel')),
+  media: /*#__PURE__*/React.lazy(() => import('../instructure_record/MediaPanel')),
+  all: /*#__PURE__*/React.lazy(() => import('./RceFileBrowser')),
+  unknown: /*#__PURE__*/React.lazy(() => import('./UnknownFileTypePanel'))
+}; // Returns a Suspense wrapped lazy loaded component
+// pulled from useLazy's cache
+
+export function DynamicPanel(props) {
+  let key = '';
+
+  if (props.contentType === 'links') {
+    key = 'links';
+  } else {
+    key = props.contentSubtype in thePanels ? props.contentSubtype : 'unknown';
+  } // @ts-expect-error
+
+
+  const Component = thePanels[key];
+  return /*#__PURE__*/React.createElement(Suspense, {
+    fallback: /*#__PURE__*/React.createElement(Spinner, {
+      renderTitle: renderLoading,
+      size: "large"
+    })
+  }, /*#__PURE__*/React.createElement(Component, props));
+}
+export const FILTER_SETTINGS_BY_PLUGIN = {
+  user_documents: {
+    contextType: 'user',
+    contentType: 'user_files',
+    contentSubtype: 'documents',
+    sortValue: 'date_added',
+    sortDir: 'desc',
+    searchString: ''
+  },
+  course_documents: {
+    contextType: 'course',
+    contentType: 'course_files',
+    contentSubtype: 'documents',
+    sortValue: 'date_added',
+    sortDir: 'desc',
+    searchString: ''
+  },
+  group_documents: {
+    contextType: 'group',
+    contentType: 'group_files',
+    contentSubtype: 'documents',
+    sortValue: 'date_added',
+    sortDir: 'desc',
+    searchString: ''
+  },
+  user_images: {
+    contextType: 'user',
+    contentType: 'user_files',
+    contentSubtype: 'images',
+    sortValue: 'date_added',
+    sortDir: 'desc',
+    searchString: ''
+  },
+  course_images: {
+    contextType: 'course',
+    contentType: 'course_files',
+    contentSubtype: 'images',
+    sortValue: 'date_added',
+    sortDir: 'desc',
+    searchString: ''
+  },
+  group_images: {
+    contextType: 'group',
+    contentType: 'group_files',
+    contentSubtype: 'images',
+    sortValue: 'date_added',
+    sortDir: 'desc',
+    searchString: ''
+  },
+  user_media: {
+    contextType: 'user',
+    contentType: 'user_files',
+    contentSubtype: 'media',
+    sortValue: 'date_added',
+    sortDir: 'desc',
+    searchString: ''
+  },
+  course_media: {
+    contextType: 'course',
+    contentType: 'course_files',
+    contentSubtype: 'media',
+    sortValue: 'date_added',
+    sortDir: 'desc',
+    searchString: ''
+  },
+  group_media: {
+    contextType: 'group',
+    contentType: 'group_files',
+    contentSubtype: 'media',
+    sortValue: 'date_added',
+    sortDir: 'desc',
+    searchString: ''
+  },
+  course_links: {
+    contextType: 'course',
+    contentType: 'links',
+    contentSubtype: 'all',
+    sortValue: 'date_added',
+    sortDir: 'desc',
+    searchString: ''
+  },
+  course_link_edit: {
+    contextType: 'course',
+    contentType: 'links',
+    contentSubtype: 'edit',
+    sortValue: 'date_added',
+    sortDir: 'desc',
+    searchString: ''
+  },
+  group_links: {
+    contextType: 'group',
+    contentType: 'links',
+    contentSubtype: 'all',
+    sortValue: 'date_added',
+    sortDir: 'desc',
+    searchString: ''
+  },
+  list_icon_maker_icons: {
+    contextType: 'course',
+    contentType: 'course_files',
+    contentSubtype: ICON_MAKER_ICONS,
+    sortValue: 'date_added',
+    sortDir: 'desc',
+    searchString: ''
+  },
+  all: {
+    contextType: 'course',
+    contentType: 'course_files',
+    contentSubtype: 'all',
+    sortValue: 'alphabetical',
+    sortDir: 'asc',
+    searchString: ''
+  }
+};
+export function isLoading(sprops) {
+  var _sprops$collections$a, _sprops$collections$a2, _sprops$collections$d, _sprops$collections$m, _sprops$collections$q, _sprops$collections$w, _sprops$documents$cou, _sprops$documents$use, _sprops$documents$gro, _sprops$media$course, _sprops$media$user, _sprops$media$group, _sprops$all_files;
+
+  return ((_sprops$collections$a = sprops.collections.announcements) === null || _sprops$collections$a === void 0 ? void 0 : _sprops$collections$a.isLoading) || ((_sprops$collections$a2 = sprops.collections.assignments) === null || _sprops$collections$a2 === void 0 ? void 0 : _sprops$collections$a2.isLoading) || ((_sprops$collections$d = sprops.collections.discussions) === null || _sprops$collections$d === void 0 ? void 0 : _sprops$collections$d.isLoading) || ((_sprops$collections$m = sprops.collections.modules) === null || _sprops$collections$m === void 0 ? void 0 : _sprops$collections$m.isLoading) || ((_sprops$collections$q = sprops.collections.quizzes) === null || _sprops$collections$q === void 0 ? void 0 : _sprops$collections$q.isLoading) || ((_sprops$collections$w = sprops.collections.wikiPages) === null || _sprops$collections$w === void 0 ? void 0 : _sprops$collections$w.isLoading) || ((_sprops$documents$cou = sprops.documents.course) === null || _sprops$documents$cou === void 0 ? void 0 : _sprops$documents$cou.isLoading) || ((_sprops$documents$use = sprops.documents.user) === null || _sprops$documents$use === void 0 ? void 0 : _sprops$documents$use.isLoading) || ((_sprops$documents$gro = sprops.documents.group) === null || _sprops$documents$gro === void 0 ? void 0 : _sprops$documents$gro.isLoading) || ((_sprops$media$course = sprops.media.course) === null || _sprops$media$course === void 0 ? void 0 : _sprops$media$course.isLoading) || ((_sprops$media$user = sprops.media.user) === null || _sprops$media$user === void 0 ? void 0 : _sprops$media$user.isLoading) || ((_sprops$media$group = sprops.media.group) === null || _sprops$media$group === void 0 ? void 0 : _sprops$media$group.isLoading) || ((_sprops$all_files = sprops.all_files) === null || _sprops$all_files === void 0 ? void 0 : _sprops$all_files.isLoading);
+}
+
+function renderLoading() {
+  return formatMessage('Loading');
+}
+
+export const UploadCanvasPanelIds = ['user_documents', 'course_documents', 'group_documents', 'user_images', 'course_images', 'group_images', 'user_media', 'course_media', 'group_media', 'course_links', 'group_links', 'list_icon_maker_icons', 'all'];
+export const CanvasPanelTitles = {
+  user_documents: formatMessage('User Documents'),
+  course_documents: formatMessage('Course Documents'),
+  group_documents: formatMessage('Group Documents'),
+  user_images: formatMessage('User Images'),
+  course_images: formatMessage('Course Images'),
+  group_images: formatMessage('Group Images'),
+  user_media: formatMessage('User Media'),
+  course_media: formatMessage('Course Media'),
+  group_media: formatMessage('Group Media'),
+  course_links: formatMessage('Course Links'),
+  group_links: formatMessage('Group Links'),
+  list_icon_maker_icons: formatMessage('Icon Maker Icons'),
+  all: formatMessage('All')
+};

package/es/rce/plugins/shared/do-fetch-api-effect/defaultFetchOptions.js

@@ -0,0 +1,31 @@
+/*
+ * Copyright (C) 2019 - present Instructure, Inc.
+ *
+ * This file is part of Canvas.
+ *
+ * Canvas is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU Affero General Public License as published by the Free
+ * Software Foundation, version 3 of the License.
+ *
+ * Canvas 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 Affero General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU Affero General Public License along
+ * with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+import getCookie from './get-cookie';
+const csrfToken = getCookie('_csrf_token'); // these are duplicated in application_helper.rb#prefetch_xhr
+// because we don't have a good pattern for sharing them yet.
+// If you change these defaults, you should probably cascade that change
+// to that ruby location
+
+export const defaultFetchOptions = () => ({
+  credentials: 'same-origin',
+  headers: {
+    Accept: 'application/json+canvas-string-ids, application/json',
+    'X-Requested-With': 'XMLHttpRequest',
+    'X-CSRF-Token': csrfToken
+  }
+});

package/es/rce/plugins/shared/do-fetch-api-effect/doFetchApi.js

@@ -0,0 +1,85 @@
+// @ts-nocheck
+
+/*
+ * Copyright (C) 2019 - present Instructure, Inc.
+ *
+ * This file is part of Canvas.
+ *
+ * Canvas is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU Affero General Public License as published by the Free
+ * Software Foundation, version 3 of the License.
+ *
+ * Canvas 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 Affero General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU Affero General Public License along
+ * with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+import parseLinkHeader from './parse-link-header';
+import { defaultFetchOptions } from './defaultFetchOptions';
+import { toQueryString } from './query-string-encoding';
+
+function constructRelativeUrl(_ref) {
+  let {
+    path,
+    params
+  } = _ref;
+  const queryString = toQueryString(params);
+  if (queryString.length === 0) return path;
+  return path + '?' + queryString;
+} // https://fetch.spec.whatwg.org/#requestinit
+
+
+// NOTE: we do NOT deep-merge customFetchOptions.headers, they should be passed
+// in the headers arg instead.
+export default async function doFetchApi(_ref2) {
+  let {
+    path,
+    method = 'GET',
+    headers = {},
+    params = {},
+    body,
+    fetchOpts = {}
+  } = _ref2;
+  const finalFetchOptions = { ...defaultFetchOptions()
+  };
+
+  if (body && typeof body !== 'string') {
+    body = JSON.stringify(body);
+    finalFetchOptions.headers['Content-Type'] = 'application/json';
+  }
+
+  Object.assign(finalFetchOptions.headers, headers);
+  Object.assign(finalFetchOptions, fetchOpts);
+  const url = constructRelativeUrl({
+    path,
+    params
+  });
+  const response = await fetch(url, {
+    body,
+    method,
+    ...finalFetchOptions,
+    credentials: finalFetchOptions.credentials
+  });
+
+  if (!response.ok) {
+    const err = new Error(`doFetchApi received a bad response: ${response.status} ${response.statusText}`);
+    Object.assign(err, {
+      response
+    }); // in case anyone wants to check it for something
+
+    throw err;
+  }
+
+  const linkHeader = response.headers.get('Link');
+  const link = linkHeader && parseLinkHeader(linkHeader) || undefined;
+  const text = await response.text();
+  const json = text.length > 0 ? JSON.parse(text) : undefined;
+  return {
+    json,
+    response,
+    link
+  };
+}

package/es/rce/plugins/shared/do-fetch-api-effect/get-cookie.js

@@ -0,0 +1,29 @@
+/*
+ * Copyright (C) 2019 - present Instructure, Inc.
+ *
+ * This file is part of Canvas.
+ *
+ * Canvas is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU Affero General Public License as published by the Free
+ * Software Foundation, version 3 of the License.
+ *
+ * Canvas 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 Affero General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU Affero General Public License along
+ * with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/**
+ * A faster alternative to $.cookie for getting a cookie from document.cookie by name
+ * see: https://stackoverflow.com/a/25490531/7159335
+ * @param {string} cookieName
+ * @returns {string} cookie value
+ */
+export default function getCookie(cookieName) {
+  const match = document.cookie.match('(^|[^;]+)\\s*' + cookieName + '\\s*=\\s*([^;]+)');
+  const first = match === null || match === void 0 ? void 0 : match.pop();
+  return first ? decodeURIComponent(first) : undefined;
+}

package/es/rce/plugins/shared/do-fetch-api-effect/index.js

@@ -0,0 +1,22 @@
+/*
+ * Copyright (C) 2024 - present Instructure, Inc.
+ *
+ * This file is part of Canvas.
+ *
+ * Canvas is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU Affero General Public License as published by the Free
+ * Software Foundation, version 3 of the License.
+ *
+ * Canvas 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 Affero General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU Affero General Public License along
+ * with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+import doFetchApi from './doFetchApi';
+export * from './get-cookie';
+export * from './parse-link-header';
+export * from './query-string-encoding';
+export default doFetchApi;

package/es/rce/plugins/shared/do-fetch-api-effect/parse-link-header.js

@@ -0,0 +1,116 @@
+/*
+ * Copyright (C) 2023 - present Instructure, Inc.
+ *
+ * This file is part of Canvas.
+ *
+ * Canvas is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU Affero General Public License as published by the Free
+ * Software Foundation, version 3 of the License.
+ *
+ * Canvas 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 Affero General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU Affero General Public License along
+ * with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+// based on https://github.com/thlorenz/parse-link-header/blob/master/index.js (MIT)
+function parseQueryParams(linkUrl) {
+  const queryParams = {};
+  const urlParts = linkUrl.split('?');
+
+  if (urlParts.length > 1) {
+    urlParts[1].split('&').forEach(param => {
+      const [key, value] = param.split('=');
+      queryParams[key] = decodeURIComponent(value);
+    });
+  }
+
+  return queryParams;
+}
+
+function parseLink(link) {
+  try {
+    const linkMatch = link.match(/<([^>]*)>\s*(.*)/);
+
+    if (!linkMatch) {
+      return null;
+    }
+
+    const [, linkUrl, partsString] = linkMatch;
+    const parts = partsString.split(';').map(part => part.trim());
+    const info = {
+      url: linkUrl
+    };
+    parts.forEach(part => {
+      const partMatch = part.match(/(.+)\s*=\s*"?([^"]+)"?/);
+
+      if (partMatch) {
+        const [, key, value] = partMatch;
+        info[key.trim()] = value.trim();
+      }
+    });
+    return { ...parseQueryParams(linkUrl),
+      ...info
+    };
+  } catch (e) {
+    return null;
+  }
+}
+
+function hasRel(x) {
+  return x !== null && 'rel' in x;
+}
+
+function intoRels(acc, x) {
+  x.rel.split(/\s+/).forEach(rel => {
+    const { ...rest
+    } = x;
+
+    switch (rel) {
+      case 'first':
+        acc.first = rest;
+        break;
+
+      case 'prev':
+        acc.prev = rest;
+        break;
+
+      case 'current':
+        acc.current = rest;
+        break;
+
+      case 'next':
+        acc.next = rest;
+        break;
+
+      case 'last':
+        acc.last = rest;
+        break;
+    }
+  });
+  return acc;
+}
+
+const PARSE_LINK_HEADER_MAXLEN = 2000;
+const PARSE_LINK_HEADER_THROW_ON_MAXLEN_EXCEEDED = process.env.PARSE_LINK_HEADER_THROW_ON_MAXLEN_EXCEEDED != null;
+
+function checkHeader(linkHeader) {
+  if (!linkHeader) return false;
+
+  if (linkHeader.length > PARSE_LINK_HEADER_MAXLEN) {
+    if (PARSE_LINK_HEADER_THROW_ON_MAXLEN_EXCEEDED) {
+      throw new Error(`Input string too long, it should be under ${PARSE_LINK_HEADER_MAXLEN} characters.`);
+    } else {
+      return false;
+    }
+  }
+
+  return true;
+}
+
+export default function parseLinkHeader(linkHeader) {
+  if (!checkHeader(linkHeader)) return null;
+  return linkHeader.split(/,\s*(?=<)/).map(parseLink).filter(hasRel).reduce(intoRels, {});
+}

package/es/rce/plugins/shared/do-fetch-api-effect/query-string-encoding.js

@@ -0,0 +1,51 @@
+/*
+ * Copyright (C) 2017 - present Instructure, Inc.
+ *
+ * This file is part of Canvas.
+ *
+ * Canvas is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU Affero General Public License as published by the Free
+ * Software Foundation, version 3 of the License.
+ *
+ * Canvas 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 Affero General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU Affero General Public License along
+ * with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+// toQueryString does what jQuery's .param() does, only without having to bring in
+// all of jQuery.
+// URLSearchParams turns arrays into queries like   a=1,2,3
+// But our jQuery makes the older "PHP" style like  a[]=1&a[]=2&a[]=3
+// JQuery also magically deals with parameters that are functions, and recursive
+// objects within objects, {a: 1, b: {c: 2, d: 3}, e: 4} => a=1&b[c]=2&b[d]=3&e=4
+// ... so we have to do a lot of massaging with the params object before using it
+// So fun!
+export function toQueryString(params) {
+  const paramsWithIndexes = []; // fix up the array/object indexes to match the PHP standard
+
+  const fixIndexes = elt => [elt[0].replace(/\[\d+\]$/, '[]').replace(/{/g, '[').replace(/}/g, ']'), elt[1]];
+
+  function serialize(k, elt, suffix) {
+    if (elt instanceof Function) {
+      paramsWithIndexes.push([k + suffix, elt()]);
+    } else if (elt instanceof Array) {
+      elt.forEach((k2, i) => serialize(k, k2, `${suffix}[${i}]`));
+    } else if (elt instanceof Object) {
+      Object.keys(elt).forEach(k2 => serialize(k, elt[k2], `${suffix}{${k2}}`));
+    } else if (typeof elt === 'boolean' || typeof elt === 'number') {
+      paramsWithIndexes.push([k + suffix, elt.toString()]);
+    } else if (typeof elt === 'undefined') {
+      paramsWithIndexes.push([k + suffix, 'undefined']);
+    } else if (elt === null) {
+      paramsWithIndexes.push([k + suffix, 'null']);
+    } else if (typeof elt === 'string') {
+      paramsWithIndexes.push([k + suffix, elt]);
+    }
+  }
+
+  Object.keys(params).forEach(k => serialize(k, params[k], ''));
+  return new URLSearchParams(paramsWithIndexes.map(fixIndexes)).toString();
+}

package/es/rce/plugins/shared/useFilterSettings.js

@@ -0,0 +1,35 @@
+/*
+ * Copyright (C) 2024 - present Instructure, Inc.
+ *
+ * This file is part of Canvas.
+ *
+ * Canvas is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU Affero General Public License as published by the Free
+ * Software Foundation, version 3 of the License.
+ *
+ * Canvas 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 Affero General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU Affero General Public License along
+ * with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+import { useState } from 'react';
+const DEFAULT_FILTER_SETTINGS = {
+  contentSubtype: 'all',
+  contentType: 'links',
+  sortValue: 'date_added',
+  searchString: ''
+};
+export function useFilterSettings(default_settings) {
+  const [filterSettings, setFilterSettings] = useState(default_settings || DEFAULT_FILTER_SETTINGS);
+
+  function updateFilterSettings(nextSettings) {
+    setFilterSettings({ ...filterSettings,
+      ...nextSettings
+    });
+  }
+
+  return [filterSettings, updateFilterSettings];
+}

package/es/sidebar/actions/upload.js

@@ -381,9 +381,11 @@ export function uploadToMediaFolder(tabContext, fileMetaProps) {
         delete fileMetaProps.domObject.preview; // don't need this anymore
       }
 
-      dispatch(uploadPreflight(tabContext, { ...fileMetaProps,
+      return dispatch(uploadPreflight(tabContext, { ...fileMetaProps,
         bookmark
-      }));
+      })).then(results => {
+        return results;
+      });
     }).catch(e => {
       // Get rid of any placeholder that might be there.
       dispatch(removePlaceholdersFor(fileMetaProps.name)); // eslint-disable-next-line no-console
@@ -540,6 +542,7 @@ export function uploadPreflight(tabContext, fileMetaProps) {
         return uploadResult;
       }).then(results => {
         dispatch(allUploadCompleteActions(results, fileMetaProps, contextType));
+        return results;
       }).catch(err => {
         // This may or may not be necessary depending on the upload
         dispatch(removePlaceholdersFor(fileMetaProps.name));