Merge pull request #522 from digirati-co-uk/feature/further-fixes

Feb fixes

Author: stephenwf

CHANGELOG.md

@@ -13,6 +13,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added email server status to system status page
 - Added configuration option to allow new users to be contributors
 - Added alpha page block for canvas panel
+- Added removal of Manifest JSON saved to disk after import (no longer used)
+- Added "source manifest" to admin
+- Added the ability to specify a reason for rejecting a contribution
 
 ### Fixed
 - Fixed inconsistencies in translations

services/madoc-ts/package.json

@@ -83,6 +83,7 @@
     "cross-fetch": "^3.0.4",
     "css-loader": "^4.2.2",
     "deepmerge": "^4.2.2",
+    "del": "^6.0.0",
     "easy-peasy": "^3.3.0",
     "email-validator": "^2.0.4",
     "form-data": "^4.0.0",

services/madoc-ts/src/database/queries/get-manifest-snippets.ts

@@ -1,5 +1,6 @@
 import { sql, TaggedTemplateLiteralInvocationType } from 'slonik';
-import { metadataReducer } from '../../utility/iiif-metadata';
+import { getViewingDirection } from '../../utility/get-viewing-direction';
+import { createMetadataReducer, MetadataField, metadataReducer } from '../../utility/iiif-metadata';
 import { SQL_EMPTY, SQL_INT_ARRAY } from '../../utility/postgres-tags';
 
 type ManifestAggregate = TaggedTemplateLiteralInvocationType<{
@@ -36,15 +37,22 @@ export function getSingleManifest({
     canvas_thumbnail: string;
     task_id?: string;
     task_complete?: boolean;
+    rights: string | null;
+    viewing_direction: number;
+    source: string;
   }>`
       select ${manifestId}::int                         as manifest_id,
              canvas_links.item_id                       as canvas_id,
              manifest_count.item_total                  as canvas_count,
              canvas_resources.default_thumbnail         as canvas_thumbnail,
              manifest.task_id                           as task_id,
              manifest.task_complete                     as task_complete,
-             manifest.published                         as published
+             manifest.published                         as published,
+             manifest_resource.rights                   as rights,
+             manifest_resource.viewing_direction        as viewing_direction,
+             manifest_resource.source                   as source
       from iiif_derived_resource manifest
+            left join iiif_resource manifest_resource on manifest.resource_id = manifest_resource.id
             left join iiif_derived_resource_items canvas_links on manifest.resource_id = canvas_links.resource_id and canvas_links.site_id = ${siteId} ${canvasExclusion}
             left join iiif_resource canvas_resources on canvas_links.item_id = canvas_resources.id
             left join iiif_derived_resource_item_counts manifest_count
@@ -71,6 +79,11 @@ export type ManifestSnippetsRow = {
   source: string;
   resource_id: number;
   canvas_count?: number;
+
+  // Other properties.
+  manifest_source: string | null;
+  manifest_rights: string | null;
+  manifest_viewing_direction: number;
 };
 
 export function getManifestSnippets(
@@ -85,14 +98,17 @@ export function getManifestSnippets(
            manifest_aggregate.canvas_thumbnail as canvas_thumbnail,
            manifest_aggregate.canvas_id as canvas_id,
            manifest_aggregate.canvas_count as canvas_count,
-           manifest_aggregate.m_published as published,
+           manifest_aggregate.published as published,
+           manifest_aggregate.rights                   as manifest_rights,
+           manifest_aggregate.viewing_direction        as manifest_viewing_direction,
+           manifest_aggregate.source                   as manifest_source,
            metadata.id as metadata_id,
            metadata.key as key,
            metadata.value as value,
            metadata.language as language,
            metadata.source as source,
            metadata.resource_id as resource_id
-      from (${query}) manifest_aggregate(manifest_id, canvas_id, canvas_count, canvas_thumbnail, task_id, task_complete, m_published)
+      from (${query}) manifest_aggregate(manifest_id, canvas_id, canvas_count, canvas_thumbnail, task_id, task_complete, published, rights, viewing_direction, source)
           left join iiif_metadata metadata
               on (manifest_aggregate.canvas_id = metadata.resource_id or
                  manifest_aggregate.manifest_id = metadata.resource_id)
@@ -241,6 +257,16 @@ export function getManifestList({
   `;
 }
 
+export const manifestReducer = createMetadataReducer((next: MetadataField & ManifestSnippetsRow) => ({
+  id: next.resource_id,
+  type: next.resource_type,
+  created: next.created_at,
+  thumbnail: next.thumbnail,
+  published: next.published,
+  source: next.manifest_source,
+  viewingDirection: getViewingDirection(next.manifest_viewing_direction),
+}));
+
 export function mapManifestSnippets(rows: readonly ManifestSnippetsRow[]) {
   return rows.reduce(
     (state, row) => {
@@ -282,7 +308,7 @@ export function mapManifestSnippets(rows: readonly ManifestSnippetsRow[]) {
       return {
         manifest_to_canvas: state.manifest_to_canvas,
         canvases: state.canvases,
-        manifests: metadataReducer(state.manifests, row),
+        manifests: manifestReducer(state.manifests, row),
         metadata_ids: state.metadata_ids,
       };
     },

services/madoc-ts/src/extensions/capture-models/crowdsourcing-api.ts

@@ -278,10 +278,12 @@ export class CrowdsourcingApi implements BaseExtension {
   async reviewRejectSubmission({
     revisionRequest,
     userTaskId,
+    message,
     statusText,
   }: {
     revisionRequest: RevisionRequest;
     userTaskId: string;
+    message?: string;
     statusText?: string;
   }) {
     try {
@@ -295,6 +297,9 @@ export class CrowdsourcingApi implements BaseExtension {
     await this.api.updateTask<CrowdsourcingTask>(userTaskId, {
       status: -1,
       status_text: statusText || 'Rejected',
+      state: {
+        rejectedMessage: message,
+      },
     });
   }
 

services/madoc-ts/src/frontend/admin/pages/content/manifests/manifest.tsx

@@ -25,7 +25,6 @@ export const ManifestView: UniversalComponent<ManifestViewType> = createUniversa
     const { resolvedData } = usePaginatedData(ManifestView);
     const site = useSite();
     const { manifest, pagination } = resolvedData || {};
-
     const title = manifest ? <LocaleString>{manifest.label}</LocaleString> : '...';
 
     return (
@@ -37,6 +36,15 @@ export const ManifestView: UniversalComponent<ManifestViewType> = createUniversa
               {t('{{count}} canvases', { count: pagination ? pagination.totalResults : 0 })}
               {' | '}
               <a href={`/s/${site.slug}/manifests/${id}`}>{t('View on site')}</a>
+              {manifest && manifest.source ? (
+                <>
+                  <br />
+                  {t('Source manifest')}{' '}
+                  <a href={manifest.source} target="_blank" rel="noreferrer">
+                    {manifest.source}
+                  </a>
+                </>
+              ) : null}
             </>
           }
           breadcrumbs={[

services/madoc-ts/src/frontend/site/hooks/use-crowdsourcing-task-details.ts

@@ -28,6 +28,7 @@ export function useCrowdsourcingTaskDetails(task: CrowdsourcingTask & { id: stri
     task.state.warningTime &&
     date - task.modified_at > task.state.warningTime;
   const changesRequested = task.status !== 3 && task.state?.changesRequested ? task.state?.changesRequested : undefined;
+  const rejectedMessage = task.state?.rejectedMessage ? task.state?.rejectedMessage : undefined;
 
   const target = useMemo(() => {
     if (captureModel && captureModel.target && captureModel.target[0]) {
@@ -81,5 +82,6 @@ export function useCrowdsourcingTaskDetails(task: CrowdsourcingTask & { id: stri
     target,
     captureModel,
     subject,
+    rejectedMessage,
   };
 }

services/madoc-ts/src/frontend/site/pages/tasks/actions/reject-submission.tsx

@@ -1,3 +1,4 @@
+import { TextField } from '@capture-models/editor/lib/input-types/TextField/TextField';
 import React, { useCallback, useState } from 'react';
 import { useApi } from '../../../../shared/hooks/use-api';
 import { Revisions } from '@capture-models/editor';
@@ -13,28 +14,33 @@ import { DeleteForeverIcon } from '../../../../shared/icons/DeleteForeverIcon';
 export const RejectSubmission: React.FC<{ onReject: () => void; userTaskId: string }> = ({ onReject, userTaskId }) => {
   const api = useApi();
   const [isLoading, setIsLoading] = useState(false);
+  const [reasonMessage, setReasonMessage] = useState('');
   const { currentRevision } = Revisions.useStoreState(state => {
     return {
       currentRevision: state.currentRevision,
     };
   });
   const deselectRevision = Revisions.useStoreActions(a => a.deselectRevision);
 
-  const rejectApiCall = useCallback(() => {
-    if (currentRevision) {
-      setIsLoading(true);
-      api
-        .reviewRejectSubmission({
-          revisionRequest: currentRevision,
-          userTaskId,
-        })
-        .then(() => {
-          deselectRevision({ revisionId: currentRevision.revision.id });
-          setIsLoading(false);
-          onReject();
-        });
-    }
-  }, [api, currentRevision, deselectRevision, onReject, userTaskId]);
+  const rejectApiCall = useCallback(
+    (message: string) => {
+      if (currentRevision) {
+        setIsLoading(true);
+        api
+          .reviewRejectSubmission({
+            revisionRequest: currentRevision,
+            userTaskId,
+            message,
+          })
+          .then(() => {
+            deselectRevision({ revisionId: currentRevision.revision.id });
+            setIsLoading(false);
+            onReject();
+          });
+      }
+    },
+    [api, currentRevision, deselectRevision, onReject, userTaskId]
+  );
 
   if (!currentRevision || currentRevision.revision.approved) {
     return null;
@@ -54,14 +60,23 @@ export const RejectSubmission: React.FC<{ onReject: () => void; userTaskId: stri
             <li>The user will be notified that the revision has been rejected</li>
             <li>You will no longer be able to see the content in the revision</li>
           </ul>
+          <label htmlFor="message">Write a message to the contributor</label>
+          <TextField
+            id="message"
+            type="text-field"
+            value={reasonMessage}
+            label="Write message to the contributor"
+            updateValue={setReasonMessage}
+            multiline={true}
+          />
         </div>
       )}
       renderFooter={({ close }: any) => (
         <Button
           style={{ marginLeft: 'auto' }}
           onClick={() => {
             close();
-            rejectApiCall();
+            rejectApiCall(reasonMessage);
           }}
         >
           Reject changes

services/madoc-ts/src/frontend/site/pages/tasks/crowdsourcing-task.tsx

@@ -10,6 +10,7 @@ import { SimpleSaveButton } from '../../../shared/caputre-models/new/components/
 import '@capture-models/editor/lib/input-types/TextField';
 import '@capture-models/editor/lib/input-types/HTMLField';
 import { CrowdsourcingTask } from '../../../../gateway/tasks/crowdsourcing-task';
+import { Heading4 } from '../../../shared/typography/Heading4';
 import { HrefLink } from '../../../shared/utility/href-link';
 import { useCrowdsourcingTaskDetails } from '../../hooks/use-crowdsourcing-task-details';
 import { TaskContext } from '../loaders/task-loader';
@@ -33,6 +34,7 @@ const ViewCrowdSourcingTask: React.FC<TaskContext<CrowdsourcingTask>> = ({ task,
     revisionId,
     wasRejected,
     changesRequested,
+    rejectedMessage,
   } = useCrowdsourcingTaskDetails(task, parentTask);
 
   if (!isCanvas) {
@@ -62,9 +64,17 @@ const ViewCrowdSourcingTask: React.FC<TaskContext<CrowdsourcingTask>> = ({ task,
           </SuccessMessage>
         ) : null}
         {wasRejected ? (
-          <ErrorMessage>
+          <ErrorMessage $banner>
             {t('This contribution was rejected. You can make another contribution from the')}{' '}
             {backLink ? <Link to={backLink}>{t('Image page')}</Link> : t('Image page')}
+            {rejectedMessage ? (
+              <>
+                <div style={{ marginTop: '.5em' }}>
+                  <strong>{t('Message from reviewer')}</strong>
+                </div>
+                <p style={{ marginTop: '0.4em' }}>{rejectedMessage}</p>
+              </>
+            ) : null}
           </ErrorMessage>
         ) : null}
         {isSubmitted ? <WarningMessage>{t('Your submission is in review')}</WarningMessage> : null}
@@ -82,7 +92,7 @@ const ViewCrowdSourcingTask: React.FC<TaskContext<CrowdsourcingTask>> = ({ task,
           </RevisionProviderWithFeatures>
         ) : null}
 
-        {!isSubmitted && !isComplete && editLink ? (
+        {!isSubmitted && !isComplete && editLink && !wasRejected ? (
           <div>
             <Button $primary as={HrefLink} href={editLink}>
               {t('Edit submission')}

services/madoc-ts/src/gateway/api.ts

@@ -871,12 +871,11 @@ export class ApiClient {
     return this.request<{ manifests: number; canvases: number }>(`/api/madoc/iiif/collections/${id}/statistics`);
   }
 
-  async createManifest(manifest: Partial<Manifest>, source?: string, taskId?: string) {
+  async createManifest(manifest: Partial<Manifest>, taskId?: string) {
     return this.request<{ id: number }, CreateManifest>(`/api/madoc/iiif/manifests`, {
       method: 'POST',
       body: {
         manifest,
-        local_source: source,
         taskId,
       },
     });
@@ -887,7 +886,6 @@ export class ApiClient {
       method: 'POST',
       body: {
         canvas,
-        local_source: source,
         thumbnail,
       },
     });
@@ -1232,7 +1230,12 @@ export class ApiClient {
   }
 
   // Review API
-  async reviewRejectSubmission(options: { revisionRequest: RevisionRequest; userTaskId: string; statusText?: string }) {
+  async reviewRejectSubmission(options: {
+    revisionRequest: RevisionRequest;
+    message?: string;
+    userTaskId: string;
+    statusText?: string;
+  }) {
     return this.crowdsourcing.reviewRejectSubmission(options);
   }
 

services/madoc-ts/src/gateway/tasks/crowdsourcing-task.ts

@@ -58,6 +58,7 @@ export interface CrowdsourcingTask extends BaseTask {
     reviewTask?: string;
     // Can start adding to this as we need.
     changesRequested?: string | null;
+    rejectedMessage?: string | null;
     mergeId?: string;
     warningTime?: number;
     userManifestTask?: string | null;

services/madoc-ts/src/gateway/tasks/import-canvas.ts

@@ -2,7 +2,6 @@ import { BaseTask } from './base-task';
 import * as tasks from './task-helpers';
 import { iiifGetLabel } from '../../utility/iiif-get-label';
 import { ApiClient } from '../api';
-import { ContentResource } from '@hyperion-framework/types';
 
 export const type = 'madoc-canvas-import';
 
@@ -64,19 +63,10 @@ export const jobHandler = async (name: string, taskId: string, api: ApiClient) =
 
       const [userId, pathToManifest, manifestId, siteId] = task.parameters;
 
-      const idHash = tasks.manifestHash(manifestId);
-
-      const { manifest, unmodifiedManifest, canvas, vault } = await tasks.tryGetManifest(
-        manifestId,
-        pathToManifest,
-        task.subject
-      );
+      const { manifest, canvas, vault } = await tasks.tryGetManifest(manifestId, pathToManifest, task.subject);
 
       const idList = (manifest.items || []).map(r => r.id);
       const canvasOrder = idList.indexOf(canvas.id);
-      const canvasJson = tasks.getCanvasFromManifest(unmodifiedManifest, canvas.id);
-
-      const fileLocation = await tasks.writeCanvasToDisk(idHash, canvasJson, canvasOrder);
 
       const thumbnail = await tasks.getThumbnail(vault, canvas);
       const thumbId = thumbnail && thumbnail.id ? thumbnail.id : undefined;
@@ -124,8 +114,7 @@ export const jobHandler = async (name: string, taskId: string, api: ApiClient) =
                 rights: canvas.rights || undefined,
                 navDate: canvas.navDate || undefined,
               },
-          thumbId,
-          fileLocation
+          thumbId
         );
         if (item) {
           break;