Blackboard REST MVP

.github/workflows/ci.yaml

@@ -25,23 +25,23 @@ jobs:
  - uses: actions/checkout@v2
 
  - name: NPM Cache
- uses: actions/cache@v1
+ uses: actions/cache@v2
  with:
  path: ~/.npm
  key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
  restore-keys: |
  ${{ runner.os }}-npm-
 
  - name: SBT Cache
- uses: actions/cache@v1
+ uses: actions/cache@v2
  with:
  path: ~/.sbt
  key: ${{ runner.os }}-sbt-${{ hashFiles('**/build.sbt') }}
  restore-keys: |
  ${{ runner.os }}-sbt-
 
  - name: Ivy Cache
- uses: actions/cache@v1
+ uses: actions/cache@v2
  with:
  path: ~/.ivy2/cache
  key: ${{ runner.os }}-ivy-${{ hashFiles('**/build.sbt') }}

.nvmrc

@@ -1 +1 @@
-12.16.3
+12.17.0

.travis.yml

@@ -7,6 +7,7 @@ branches:
  - /^release\/.+/
  - /^stable-.+/
  - /^travis\/.+/
+ - component/search_configuration
 env:
  global:
  ### AWS START ###

Dev/docs/restendpoint.md

@@ -176,3 +176,30 @@ public class TestResource {
  }
 }
 ```
+## Batch operations
+
+If a REST request contains multiple resources, then the successful response code should be 207, which provides status
+and messages for multiple independent operations.
+
+The response body is a list of JSON data in below structure 
+
+```json
+
+[{
+ "id": "2daeba28-ce4e-48d5-9de8-149be32f09c9",
+ "status": 200,
+ "message": "A new filter has been created. ID: 2daeba28-ce4e-48d5-9de8-149be32f09c9"
+ },
+ {
+ "id": "2daeba28-ce4e-48d5-9de8-149be32f0929",
+ "status": 400,
+ "message": "Filter name cannot be empty."
+ }
+]
+
+```
+For each operation, the result should be represented by this structure. The Scala case class 'ApiBatchOperationResponse'
+has been created for this purpose.
+
+In client-side, 'BatchOperationResponse.ts' has been created to help read the data. Also, the function
+'groupErrorMessages' can help retrieve non-2xx status and their messages.

Source/Plugins/Core/com.equella.base/src/com/tle/common/settings/standard/SearchSettings.java

@@ -18,6 +18,7 @@
 
 package com.tle.common.settings.standard;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.tle.common.settings.ConfigurationProperties;
 import com.tle.common.settings.annotation.Property;
 import com.tle.common.settings.annotation.PropertyDataList;
@@ -55,6 +56,12 @@ public class SearchSettings implements ConfigurationProperties {
  @Property(key = "search.disableVideos")
  private boolean searchingDisableVideos;
 
+ @Property(key = "search.disableOwnerFilter")
+ private boolean searchingDisableOwnerFilter;
+
+ @Property(key = "search.disableDateModifiedFilter")
+ private boolean searchingDisableDateModifiedFilter;
+
  @Property(key = "gallery.filecount.disabled")
  private boolean fileCountDisabled;
 
@@ -73,6 +80,10 @@ public class SearchSettings implements ConfigurationProperties {
  @Property(key = "search.defaultsort")
  private String defaultSearchSort;
 
+ // The REST endpoints for this was split into two - one for general search settings,
+ // and one for filters - so we don't want this included in the general search
+ // settings.
+ @JsonIgnore
  @PropertyDataList(key = SEARCH + ".filters", type = SearchFilter.class)
  private final List<SearchFilter> filters =
  new ArrayList<SearchFilter>() {
@@ -221,4 +232,20 @@ public boolean isFileCountDisabled() {
  public void setFileCountDisabled(boolean fileCountDisabled) {
  this.fileCountDisabled = fileCountDisabled;
  }
+
+ public boolean isSearchingDisableOwnerFilter() {
+ return searchingDisableOwnerFilter;
+ }
+
+ public void setSearchingDisableOwnerFilter(boolean searchingDisableOwnerFilter) {
+ this.searchingDisableOwnerFilter = searchingDisableOwnerFilter;
+ }
+
+ public boolean isSearchingDisableDateModifiedFilter() {
+ return searchingDisableDateModifiedFilter;
+ }
+
+ public void setSearchingDisableDateModifiedFilter(boolean searchingDisableDateModifiedFilter) {
+ this.searchingDisableDateModifiedFilter = searchingDisableDateModifiedFilter;
+ }
 }

Source/Plugins/Core/com.equella.core/js/.licensee.json

@@ -0,0 +1,22 @@
+{
+ "licenses": {
+ "spdx": [
+ "0BSD",
+ "Apache-2.0",
+ "BSD-2-Clause",
+ "BSD-3-Clause",
+ "ISC",
+ "MIT",
+ "Unlicense"
+ ]
+ },
+ "ignore": [
+ {
+ "prefix": "oeq-cloudproviders"
+ },
+ {
+ "prefix": "tinymce"
+ }
+ ],
+ "corrections": false
+}

Source/Plugins/Core/com.equella.core/js/__mocks__/getSchemaUuidResp.js

@@ -0,0 +1,195 @@
+/*
+ * Licensed to The Apereo Foundation under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for additional
+ * information regarding copyright ownership.
+ *
+ * The Apereo Foundation licenses this file to you under the Apache License,
+ * Version 2.0, (the "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at:
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+exports.getSchemaUuidResp = {
+ uuid: "f028746b-0346-fe7e-a223-a2db1240140c",
+ name: "CAL Guide Schema",
+ nameStrings: {
+ en: "CAL Guide Schema",
+ },
+ description:
+ "testing the creation of a CAL schema as demonstrated by the CAL configuration guide",
+ descriptionStrings: {
+ en:
+ "testing the creation of a CAL schema as demonstrated by the CAL configuration guide",
+ },
+ modifiedDate: "2014-04-04T12:56:52.870+11:00",
+ createdDate: "2012-03-14T17:33:05.767+11:00",
+ owner: {
+ id: "adfcaf58-241b-4eca-9740-6a26d1c3dd58",
+ },
+ security: {
+ rules: [],
+ },
+ namePath: "/item/itembody/name",
+ descriptionPath: "/item/itembody/description",
+ definition: {
+ xml: {
+ item: {
+ itembody: {
+ name: {
+ _indexed: true,
+ _field: true,
+ _type: "text",
+ },
+ description: {
+ _indexed: true,
+ _type: "text",
+ },
+ },
+ copyright: {
+ "@parenttype": {
+ _nested: true,
+ _type: "text",
+ },
+ issue: {
+ type: {
+ _indexed: true,
+ _type: "text",
+ },
+ value: {
+ _indexed: true,
+ _type: "text",
+ },
+ },
+ "@type": {
+ _nested: true,
+ _type: "text",
+ },
+ isbn: {
+ _indexed: true,
+ _field: true,
+ _type: "text",
+ },
+ abstract: {
+ _indexed: true,
+ _type: "text",
+ },
+ title: {
+ _indexed: true,
+ _field: true,
+ _type: "text",
+ },
+ volume: {
+ _indexed: true,
+ _type: "text",
+ },
+ pages: {
+ _type: "text",
+ },
+ issn: {
+ _indexed: true,
+ _field: true,
+ _type: "text",
+ },
+ publication: {
+ year: {
+ _type: "text",
+ },
+ place: {
+ _indexed: true,
+ _field: true,
+ _type: "text",
+ },
+ },
+ publisher: {
+ _type: "text",
+ },
+ editors: {
+ editor: {
+ _indexed: true,
+ _field: true,
+ _type: "text",
+ },
+ },
+ authors: {
+ author: {
+ _indexed: true,
+ _field: true,
+ _type: "text",
+ },
+ },
+ portions: {
+ portion: {
+ number: {
+ _type: "text",
+ },
+ topics: {
+ topic: {
+ _indexed: true,
+ _type: "text",
+ },
+ },
+ abstract: {
+ _indexed: true,
+ _type: "text",
+ },
+ title: {
+ _indexed: true,
+ _field: true,
+ _type: "text",
+ },
+ sections: {
+ section: {
+ copyrightstatus: {
+ _type: "text",
+ },
+ pages: {
+ _type: "text",
+ },
+ attachment: {
+ _type: "text",
+ },
+ illustration: {
+ _type: "text",
+ },
+ type: {
+ _type: "text",
+ },
+ },
+ },
+ authors: {
+ author: {
+ _indexed: true,
+ _field: true,
+ _type: "text",
+ },
+ },
+ },
+ },
+ },
+ },
+ },
+ },
+ citations: [
+ {
+ name: "Harvard",
+ transformation: "harvard.xsl",
+ },
+ ],
+ exportTransformsMap: {},
+ importTransformsMap: {
+ "Z39.50 to Book": "MODS_z3950_to_book-20071212-1.xslt",
+ },
+ ownerUuid: "adfcaf58-241b-4eca-9740-6a26d1c3dd58",
+ serializedDefinition:
+ '<xml><item><copyright><type attribute="true" type="text"/><parenttype attribute="true" type="text"/><title field="true" search="true" type="text"/><abstract search="true" type="text"/><isbn field="true" search="true" type="text"/><authors><author field="true" search="true" type="text"/></authors><editors><editor field="true" search="true" type="text"/></editors><issn field="true" search="true" type="text"/><issue><type search="true" type="text"/><value search="true" type="text"/></issue><volume search="true" type="text"/><publisher type="text"/><publication><year type="text"/><place field="true" search="true" type="text"/></publication><pages type="text"/><portions><portion><title field="true" search="true" type="text"/><authors><author field="true" search="true" type="text"/></authors><abstract search="true" type="text"/><number type="text"/><topics><topic search="true" type="text"/></topics><sections><section><pages type="text"/><attachment type="text"/><type type="text"/><copyrightstatus type="text"/><illustration type="text"/></section></sections></portion></portions></copyright><itembody><name field="true" search="true" type="text"/><description search="true" type="text"/></itembody></item></xml>',
+ links: {
+ self:
+ "http://localhost:8080/rest/api/schema/f028746b-0346-fe7e-a223-a2db1240140c",
+ },
+};