Merged in DSC-1309-maintenance (pull request DSpace#1330)

Davide Negretti · vins01-4science · commit 8ca41bae3206 · 2024-02-22T13:02:28.000Z
DSC-1309 maintenance

Approved-by: Andrea Barbasso
diff --git a/src/app/item-page/mirador-viewer/mirador-viewer.component.ts b/src/app/item-page/mirador-viewer/mirador-viewer.component.ts
@@ -87,6 +87,9 @@ export class MiradorViewerComponent implements OnInit {
     if (this.notMobile) {
       viewerPath += '&notMobile=true';
     }
+    if (environment.mirador.enableDownloadPlugin) {
+      viewerPath += '&enableDownloadPlugin=true';
+    }
 
     // TODO: Should the query term be trusted here?
     return this.sanitizer.bypassSecurityTrustResourceUrl(viewerPath);
diff --git a/src/config/app-config.interface.ts b/src/config/app-config.interface.ts
@@ -31,6 +31,7 @@ import { FollowAuthorityMetadata } from './search-follow-metadata.interface';
 import { AdvancedAttachmentRenderingConfig } from './advanced-attachment-rendering.config';
 import { AttachmentRenderingConfig } from './attachment-rendering.config';
 import { SearchResultConfig } from './search-result-config.interface';
+import { MiradorConfig } from './mirador-config.interfaces';
 
 interface AppConfig extends Config {
   ui: UIServerConfig;
@@ -68,6 +69,7 @@ interface AppConfig extends Config {
   attachmentRendering: AttachmentRenderingConfig;
   advancedAttachmentRendering: AdvancedAttachmentRenderingConfig;
   searchResult: SearchResultConfig;
+  mirador: MiradorConfig;
 }
 
 /**
diff --git a/src/config/default-app-config.ts b/src/config/default-app-config.ts
@@ -34,6 +34,7 @@ import {
 } from './advanced-attachment-rendering.config';
 import { AttachmentRenderingConfig } from './attachment-rendering.config';
 import { SearchResultConfig } from './search-result-config.interface';
+import { MiradorConfig } from './mirador-config.interfaces';
 
 export class DefaultAppConfig implements AppConfig {
   production = false;
@@ -750,4 +751,8 @@ export class DefaultAppConfig implements AppConfig {
     additionalMetadataFields: [],
     authorMetadata: ['dc.contributor.author', 'dc.creator', 'dc.contributor.*'],
   };
+
+  mirador: MiradorConfig = {
+    enableDownloadPlugin: true,
+  };
 }
diff --git a/src/config/mirador-config.interfaces.ts b/src/config/mirador-config.interfaces.ts
@@ -0,0 +1,5 @@
+import { Config } from './config.interface';
+
+export interface MiradorConfig extends Config {
+  enableDownloadPlugin: boolean;
+}
diff --git a/src/environments/environment.test.ts b/src/environments/environment.test.ts
@@ -568,4 +568,8 @@ export const environment: BuildConfig = {
     ],
     authorMetadata: ['dc.contributor.author', 'dc.contributor.editor', 'dc.contributor.contributor', 'dc.creator'],
   },
+
+  mirador: {
+    enableDownloadPlugin: true,
+  },
 };
diff --git a/src/mirador-viewer/config.default.js b/src/mirador-viewer/config.default.js
@@ -24,19 +24,23 @@ const searchOption = params.get('searchable');
 const query = params.get('query');
 const multi = params.get('multi');
 const notMobile = params.get('notMobile');
+const isDownloadPluginEnabled = (params.get('enableDownloadPlugin') === 'true');
 
 let windowSettings = {};
-let sidbarPanel = 'info';
+let sideBarPanel = 'info';
 let defaultView = 'single';
 let multipleItems = false;
 let thumbNavigation = 'off';
+let downloadPluginSettings = {
+  restrictDownloadOnSizeDefinition: false
+};
 
 windowSettings.manifestId = manifest;
 
 (() => {
   if (searchOption) {
     defaultView = 'book';
-    sidbarPanel = 'search';
+    sideBarPanel = 'search';
     multipleItems = true;
     if (notMobile) {
       thumbNavigation = 'far-right';
@@ -45,7 +49,7 @@ windowSettings.manifestId = manifest;
       windowSettings.defaultSearchQuery = query;
     }
   } else {
-    if(multi) {
+    if (multi) {
       multipleItems = multi;
       if (notMobile) {
         thumbNavigation = 'far-right';
@@ -54,127 +58,130 @@ windowSettings.manifestId = manifest;
   }
 })();
 
-(Mirador.viewer(
-    {
-      id: 'mirador',
-      mainMenuSettings: {
-        show: true
-      },
-      thumbnailNavigation: {
-        defaultPosition: thumbNavigation, // Which position for the thumbnail navigation to be be displayed. Other possible values are "far-bottom" or "far-right"
-        displaySettings: true, // Display the settings for this in WindowTopMenu
-        height: 120, // height of entire ThumbnailNavigation area when position is "far-bottom"
-        width: 100, // width of one canvas (doubled for book view) in ThumbnailNavigation area when position is "far-right"
-      },
-      themes: {
-        light: {
-          palette: {
-            type: 'light',
-            primary: {
-              main: '#266883',
-            },
-            secondary: {
-              main: '#b03727',
-            },
-            shades: { // Shades that can be used to offset color areas of the Workspace / Window
-              dark: '#eeeeee',
-              main: '#ffffff',
-              light: '#ffffff',
-            },
-            highlights: {
-              primary: '#ffff00',
-              secondary: '#00BFFF',
-            },
-            search: {
-              default: { fillStyle: '#00BFFF', globalAlpha: 0.3 },
-              hovered: { fillStyle: '#00FFFF', globalAlpha: 0.3 },
-              selected: { fillStyle: '#ff0900', globalAlpha: 0.3 },
-            },
-          },
+let miradorConfiguration = {
+  id: 'mirador',
+  mainMenuSettings: {
+    show: true
+  },
+  thumbnailNavigation: {
+    defaultPosition: thumbNavigation, // Which position for the thumbnail navigation to be be displayed. Other possible values are "far-bottom" or "far-right"
+    displaySettings: true, // Display the settings for this in WindowTopMenu
+    height: 120, // height of entire ThumbnailNavigation area when position is "far-bottom"
+    width: 100, // width of one canvas (doubled for book view) in ThumbnailNavigation area when position is "far-right"
+  },
+  themes: {
+    light: {
+      palette: {
+        type: 'light',
+        primary: {
+          main: '#266883',
         },
-        dark: {
-          palette: {
-            type: 'dark',
-            primary: {
-              main: '#2790b0',
-            },
-            secondary: {
-              main: '#eeeeee',
-            },
-            highlights: {
-              primary: '#ffff00',
-              secondary: '#00BFFF',
-            },
-          },
+        secondary: {
+          main: '#b03727',
         },
-      },
-      selectedTheme: 'light',
-      data: [manifest],
-      windows: [
-        windowSettings
-      ],
-      miradorSharePlugin: {
-        dragAndDropInfoLink: 'https://iiif.io',
-        embedOption: {
-          enabled: true,
-          embedUrlReplacePattern: [
-            /.*/,
-            embedURL
-          ],
-          syncIframeDimensions: {
-            height: {param: 'maxheight'},
-          },
+        shades: { // Shades that can be used to offset color areas of the Workspace / Window
+          dark: '#eeeeee',
+          main: '#ffffff',
+          light: '#ffffff',
         },
-        shareLink: {
-          enabled: true,
-          manifestIdReplacePattern: [
-            /\/iiif\/manifest/,
-            '',
-          ],
+        highlights: {
+          primary: '#ffff00',
+          secondary: '#00BFFF',
+        },
+        search: {
+          default: { fillStyle: '#00BFFF', globalAlpha: 0.3 },
+          hovered: { fillStyle: '#00FFFF', globalAlpha: 0.3 },
+          selected: { fillStyle: '#ff0900', globalAlpha: 0.3 },
         },
       },
-      miradorDownloadPlugin: {
-        restrictDownloadOnSizeDefinition: false
-      },
-      window: {
-        allowClose: false,
-        // sideBarOpenByDefault: false,
-        allowFullscreen: true,
-        allowMaximize: false,
-        defaultView: defaultView,
-        sideBarOpen: notMobile,
-        allowTopMenuButton: true,
-        defaultSidebarPanelWidth: 230,
-        switchCanvasOnSearch: true,
-        views: [
-          { key: 'single', behaviors: ['individuals'] },
-          { key: 'book', behaviors: ['paged'] },
-          { key: 'scroll', behaviors: ['continuous'] },
-          { key: 'gallery' },
-        ],
-        panels: {
-          info: true,
-          attribution: false,
-          canvas: true,
-          search: searchOption,
-          layers: false,
+    },
+    dark: {
+      palette: {
+        type: 'dark',
+        primary: {
+          main: '#2790b0',
+        },
+        secondary: {
+          main: '#eeeeee',
+        },
+        highlights: {
+          primary: '#ffff00',
+          secondary: '#00BFFF',
         },
-        sideBarPanel: sidbarPanel
       },
-      workspace: {
-        allowNewWindows: false,
-        showZoomControls: true,
-        type: 'mosaic'
+    },
+  },
+  selectedTheme: 'light',
+  data: [manifest],
+  windows: [
+    windowSettings
+  ],
+  miradorSharePlugin: {
+    dragAndDropInfoLink: 'https://iiif.io',
+    embedOption: {
+      enabled: true,
+      embedUrlReplacePattern: [
+        /.*/,
+        embedURL
+      ],
+      syncIframeDimensions: {
+        height: {param: 'maxheight'},
       },
-      workspaceControlPanel: {
-        enabled: false
-      }
     },
-    [
-      miradorShareDialogPlugin,
-      miradorSharePlugin,
-      miradorDownloadDialog,
-      miradorDownloadPlugin
-    ]
-  )
-)(manifest);
+    shareLink: {
+      enabled: true,
+      manifestIdReplacePattern: [
+        /\/iiif\/manifest/,
+        '',
+      ],
+    },
+  },
+  window: {
+    allowClose: false,
+    // sideBarOpenByDefault: false,
+    allowFullscreen: true,
+    allowMaximize: false,
+    defaultView: defaultView,
+    sideBarOpen: notMobile,
+    allowTopMenuButton: true,
+    defaultSidebarPanelWidth: 230,
+    switchCanvasOnSearch: true,
+    views: [
+      { key: 'single', behaviors: ['individuals'] },
+      { key: 'book', behaviors: ['paged'] },
+      { key: 'scroll', behaviors: ['continuous'] },
+      { key: 'gallery' },
+    ],
+    panels: {
+      info: true,
+      attribution: false,
+      canvas: true,
+      search: searchOption,
+      layers: false,
+    },
+    sideBarPanel: sideBarPanel
+  },
+  workspace: {
+    allowNewWindows: false,
+    showZoomControls: true,
+    type: 'mosaic'
+  },
+  workspaceControlPanel: {
+    enabled: false
+  }
+};
+
+let miradorPlugins = [
+  miradorShareDialogPlugin,
+  miradorSharePlugin,
+  miradorDownloadDialog,
+];
+
+(() => {
+  if (isDownloadPluginEnabled) {
+    miradorPlugins = [...miradorPlugins, miradorDownloadPlugin];
+    miradorConfiguration.miradorDownloadPlugin = downloadPluginSettings;
+  }
+})();
+
+Mirador.viewer(miradorConfiguration, miradorPlugins);

Original file line number	Diff line number	Diff line change
`@@ -87,6 +87,9 @@ export class MiradorViewerComponent implements OnInit {`
`87`	`87`	`if (this.notMobile) {`
`88`	`88`	`viewerPath += '&notMobile=true';`
`89`	`89`	`}`
	`90`	`+ if (environment.mirador.enableDownloadPlugin) {`
	`91`	`+ viewerPath += '&enableDownloadPlugin=true';`
	`92`	`+ }`
`90`	`93`
`91`	`94`	`// TODO: Should the query term be trusted here?`
`92`	`95`	`return this.sanitizer.bypassSecurityTrustResourceUrl(viewerPath);`