Refactor property value internationalization (fixes #3470)

This admittedly huge changeset refactors the way the correct language value for a given property value is determined. A recent change in the Manifesto library made it possible to pass a list of languages (in descending order of preference) to the `PropertyValue.getValue` and `PropertyValue.getValues` methods, instead of relying on a single default locale that would be set when parsing the manifest. This allows for a better user experience, since we can now dynamically respond to changes in the user's language preferences without having to re-parse the manifest. Additionally, we can make use of the browser's language preferences to better match the user's language abilities. However, this required a substantial reworking of quite a few parts of Mirador, namely: - Introduced a new `config.userLanguages` redux state variable that has the list of languages in descending order of preference (as returned by i18next.languages after setting the configured language) - Every selector that would previously simply call `getValue` on a property value was changed to retrieve the user languages from the store and pass them to `getValue`. Additionally, for property values that are displayed in the companion window, where the locale can be overridden separately from the global language, selectors are extended to take a third `overrideLanguages` parameter that allows customization of the languages passed to `getValue`/`getValues` - When changing the global language setting, the value in the companion window's `LocalePicker` (if enabled) now will select the next-best available language according to the langauge pereferences, if the desired language is not part of the metadata. As a whole, these changes now allow on-the-fly switching of languages via both the global language selector and the companion window locale picker for all property values parsed from the manifest, with support for falling back according to the user's client language preferences.
ProjectMirador · Jul 17, 2021 · f28b81c · f28b81c
1 parent 453f1a3
commit f28b81c
Show file tree

Hide file tree

Showing 37 changed files with 15,791 additions and 211 deletions.
diff --git a/__tests__/fixtures/version-2/i18n.json b/__tests__/fixtures/version-2/i18n.json
diff --git a/__tests__/integration/mirador/i18n.html b/__tests__/integration/mirador/i18n.html
@@ -0,0 +1,44 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <meta name="theme-color" content="#000000">
+    <title>Mirador</title>
+    <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,500">
+  </head>
+  <body>
+    <div id="mirador" style="position: absolute; top: 0; bottom: 0; left: 0; right: 0;"></div>
+    <script>document.write("<script type='text/javascript' src='../../../dist/mirador.min.js?v=" + Date.now() + "'><\/script>");</script>
+    <script type="text/javascript">
+     var miradorInstance = Mirador.viewer({
+       id: 'mirador',
+       language: 'de',
+       theme: {
+         transitions: window.location.port === '4488' ?  { create: () => 'none' } : {},
+       },
+       windows: [{
+         manifestId: 'http://localhost:4488/__tests__/fixtures/version-2/i18n.json',
+         thumbnailNavigationPosition: 'far-bottom',
+         showLocalePicker: true,
+       }],
+       catalog: [
+         { manifestId: 'https://iiif.bodleian.ox.ac.uk/iiif/manifest/e32a277e-91e2-4a6d-8ba6-cc4bad230410.json' },
+         { manifestId: 'https://iiif.harvardartmuseums.org/manifests/object/299843' },
+         { manifestId: "https://media.nga.gov/public/manifests/nga_highlights.json", provider: "National Gallery of Art"},
+         { manifestId: "https://data.ucd.ie/api/img/manifests/ucdlib:33064", provider: "Irish Architectural Archive"},
+         { manifestId: "https://wellcomelibrary.org/iiif/b18035723/manifest", provider: "Wellcome Library"},
+         { manifestId: "https://demos.biblissima.fr/iiif/metadata/florus-dispersus/manifest.json", provider: "Biblissima"},
+         { manifestId: "https://www.e-codices.unifr.ch/metadata/iiif/gau-Fragment/manifest.json", provider: "e-codices - Virtual Manuscript Library of Switzerland"},
+         { manifestId: "https://wellcomelibrary.org/iiif/collection/b18031511", provider: "Wellcome Library"},
+         { manifestId: "https://gallica.bnf.fr/iiif/ark:/12148/btv1b10022508f/manifest.json", provider: "Bibliothèque nationale de France"},
+         { manifestId: "https://manifests.britishart.yale.edu/Osbornfa1", provider: "Beinecke Rare Book and Manuscript Library, Yale University"},
+         { manifestId: "https://iiif.biblissima.fr/chateauroux/B360446201_MS0005/manifest.json", provider: "Biblissima"},
+         { manifestId: "https://iiif.durham.ac.uk/manifests/trifle/32150/t1/m4/q7/t1m4q77fr328/manifest", provider: "Durham University Library"},
+         //{ manifestId: "https://iiif.vam.ac.uk/collections/O1023003/manifest.json", provider: "Ocean liners"},
+         { manifestId: "https://zavicajna.digitalna.rs/iiif/iiif/api/presentation/2/4aa44ad1-0b74-4590-ab09-534a38cb7c53%252F00000001%252Fostalo01%252F00000012/manifest", provider: "Библиотека 'Милутин Бојић'"},
+       ]
+     });
+    </script>
+  </body>
+</html>
diff --git a/__tests__/src/selectors/manifests.test.js b/__tests__/src/selectors/manifests.test.js
@@ -8,7 +8,6 @@ import manifestFixtureWithAProvider from '../../fixtures/version-3/with_a_provid
 import manifestFixtureFg165hz3589 from '../../fixtures/version-2/fg165hz3589.json';
 import {
   getManifestoInstance,
-  getManifestLocale,
   getDestructuredMetadata,
   getManifestStatus,
   getManifestLogo,
@@ -282,14 +281,6 @@ describe('getManifestMetadata', () => {
   });
 });
 
-describe('getManifestLocale', () => {
-  it('gets the default locale for the manifest', () => {
-    const state = { manifests: { x: { json: manifestFixture002 } } };
-    const received = getManifestLocale(state, { manifestId: 'x' });
-    expect(received).toEqual('en');
-  });
-});
-
 describe('getMetadataLocales', () => {
   it('gets the locales preseent in the manifest metadata', () => {
     const manifest = {

diff --git a/src/components/AppProviders.js b/src/components/AppProviders.js
@@ -61,20 +61,22 @@ export class AppProviders extends Component {
   /**
    * Set i18n language on component mount
    */
-  componentDidMount() {
-    const { language } = this.props;
+  async componentDidMount() {
+    const { language, updateUserLanguages } = this.props;
 
-    this.i18n.changeLanguage(language);
+    await this.i18n.changeLanguage(language);
+    updateUserLanguages(this.i18n.languages);
   }
 
   /**
    * Update the i18n language if it is changed
    */
-  componentDidUpdate(prevProps) {
-    const { language } = this.props;
+  async componentDidUpdate(prevProps) {
+    const { language, updateUserLanguages } = this.props;
 
     if (prevProps.language !== language) {
-      this.i18n.changeLanguage(language);
+      await this.i18n.changeLanguage(language);
+      updateUserLanguages(this.i18n.languages);
     }
   }
 
@@ -127,6 +129,7 @@ AppProviders.propTypes = {
   setWorkspaceFullscreen: PropTypes.func.isRequired,
   theme: PropTypes.object.isRequired, // eslint-disable-line react/forbid-prop-types
   translations: PropTypes.object.isRequired, // eslint-disable-line react/forbid-prop-types
+  updateUserLanguages: PropTypes.func.isRequired,
 };
 
 AppProviders.defaultProps = {

diff --git a/src/components/CanvasLayers.js b/src/components/CanvasLayers.js
@@ -30,11 +30,11 @@ const reorder = (list, startIndex, endIndex) => {
 /** */
 export class CanvasLayers extends Component {
   /** */
-  static getUseableLabel(resource, index) {
+  static getUseableLabel(resource, index, langs) {
     return (resource
       && resource.getLabel
       && resource.getLabel().length > 0)
-      ? resource.getLabel().getValue()
+      ? resource.getLabel().getValue(langs)
       : String(index + 1);
   }
 
@@ -117,6 +117,7 @@ export class CanvasLayers extends Component {
   renderLayer(resource, index) {
     const {
       classes,
+      languages,
       layerMetadata,
       t,
     } = this.props;
@@ -143,7 +144,7 @@ export class CanvasLayers extends Component {
             component="div"
             variant="body1"
           >
-            {CanvasLayers.getUseableLabel(resource, index)}
+            {CanvasLayers.getUseableLabel(resource, index, languages)}
             <div>
               <MiradorMenuButton aria-label={t(layer.visibility ? 'layer_hide' : 'layer_show')} edge="start" size="small" onClick={() => { this.setLayerVisibility(resource.id, !layer.visibility); }}>
                 { layer.visibility ? <VisibilityIcon /> : <VisibilityOffIcon /> }
@@ -265,6 +266,7 @@ CanvasLayers.propTypes = {
   classes: PropTypes.objectOf(PropTypes.string),
   index: PropTypes.number.isRequired,
   label: PropTypes.string.isRequired,
+  languages: PropTypes.arrayOf(PropTypes.string).isRequired,
   layerMetadata: PropTypes.objectOf(PropTypes.shape({
     opacity: PropTypes.number,
   })),

diff --git a/src/components/CollectionDialog.js b/src/components/CollectionDialog.js
@@ -24,12 +24,12 @@ import ManifestInfo from '../containers/ManifestInfo';
  */
 export class CollectionDialog extends Component {
   /** */
-  static getUseableLabel(resource, index) {
+  static getUseableLabel(resource, langs) {
     return (resource
       && resource.getLabel
       && resource.getLabel().length > 0)
-      ? resource.getLabel().getValue()
-      : String(index + 1);
+      ? resource.getLabel().getValue(langs)
+      : resource.id;
   }
 
   /** */
@@ -142,6 +142,7 @@ export class CollectionDialog extends Component {
       collection,
       error,
       isMultipart,
+      languages,
       manifest,
       ready,
       t,
@@ -164,7 +165,7 @@ export class CollectionDialog extends Component {
     const requiredStatement = manifest
       && asArray(manifest.getRequiredStatement()).filter(l => l.getValue()).map(labelValuePair => ({
         label: null,
-        values: labelValuePair.getValues(),
+        values: labelValuePair.getValues(languages),
       }));
 
     const collections = manifest.getCollections();
@@ -184,7 +185,7 @@ export class CollectionDialog extends Component {
             { t(isMultipart ? 'multipartCollection' : 'collection') }
           </Typography>
           <Typography variant="h3">
-            {CollectionDialog.getUseableLabel(manifest)}
+            {CollectionDialog.getUseableLabel(manifest, languages)}
           </Typography>
         </DialogTitle>
         <ScrollIndicatedDialogContent className={classes.dialogContent}>
@@ -193,7 +194,7 @@ export class CollectionDialog extends Component {
               startIcon={<ArrowBackIcon />}
               onClick={() => this.goToPreviousCollection()}
             >
-              {CollectionDialog.getUseableLabel(collection)}
+              {CollectionDialog.getUseableLabel(collection, languages)}
             </Button>
           )}
 
@@ -239,7 +240,7 @@ export class CollectionDialog extends Component {
                     onClick={() => { this.selectCollection(c); }}
                     className={classes.collectionItem}
                   >
-                    {CollectionDialog.getUseableLabel(c)}
+                    {CollectionDialog.getUseableLabel(c, languages)}
                   </MenuItem>
                 ))
               }
@@ -254,7 +255,7 @@ export class CollectionDialog extends Component {
                     onClick={() => { this.selectManifest(m); }}
                     className={classes.collectionItem}
                   >
-                    {CollectionDialog.getUseableLabel(m)}
+                    {CollectionDialog.getUseableLabel(m, languages)}
                   </MenuItem>
                 ))
               }
@@ -280,6 +281,7 @@ CollectionDialog.propTypes = {
   error: PropTypes.string,
   hideCollectionDialog: PropTypes.func.isRequired,
   isMultipart: PropTypes.bool,
+  languages: PropTypes.arrayOf(PropTypes.string).isRequired,
   manifest: PropTypes.object.isRequired, // eslint-disable-line react/forbid-prop-types
   manifestId: PropTypes.string.isRequired,
   ready: PropTypes.bool,

diff --git a/src/components/IIIFThumbnail.js b/src/components/IIIFThumbnail.js
@@ -11,12 +11,12 @@ import getThumbnail from '../lib/ThumbnailFactory';
  */
 export class IIIFThumbnail extends Component {
   /** */
-  static getUseableLabel(resource, index) {
+  static getUseableLabel(resource, langs) {
     return (resource
       && resource.getLabel
       && resource.getLabel().length > 0)
-      ? resource.getLabel().getValue()
-      : String(index + 1);
+      ? resource.getLabel().getValue(langs)
+      : resource.id;
   }
 
   /**
@@ -129,9 +129,9 @@ export class IIIFThumbnail extends Component {
 
   /** */
   label() {
-    const { label, resource } = this.props;
+    const { label, resource, languages } = this.props;
 
-    return label || IIIFThumbnail.getUseableLabel(resource);
+    return label || IIIFThumbnail.getUseableLabel(resource, languages);
   }
 
   /**
@@ -180,6 +180,7 @@ IIIFThumbnail.propTypes = {
   imagePlaceholder: PropTypes.string,
   label: PropTypes.string,
   labelled: PropTypes.bool,
+  languages: PropTypes.arrayOf(PropTypes.string).isRequired,
   maxHeight: PropTypes.number,
   maxWidth: PropTypes.number,
   resource: PropTypes.object.isRequired, // eslint-disable-line react/forbid-prop-types

diff --git a/src/components/LocalePicker.js b/src/components/LocalePicker.js
@@ -17,11 +17,17 @@ export class LocalePicker extends Component {
     const {
       availableLocales,
       classes,
-      locale,
       setLocale,
+      userLanguages,
     } = this.props;
+    let { locale } = this.props;
 
     if (!setLocale || availableLocales.length < 2) return <></>;
+    // If `locale` is not among the available locales, it should be the first available
+    // locale that matches the language preferences from the `userLanguages` store value
+    if (availableLocales.indexOf(locale) < 0) {
+      locale = userLanguages.find(l => availableLocales.indexOf(l) >= 0) ?? availableLocales[0];
+    }
     return (
       <FormControl>
         <Select
@@ -55,11 +61,13 @@ LocalePicker.propTypes = {
   classes: PropTypes.objectOf(PropTypes.string),
   locale: PropTypes.string,
   setLocale: PropTypes.func,
+  userLanguages: PropTypes.arrayOf(PropTypes.string),
 };
 
 LocalePicker.defaultProps = {
   availableLocales: [],
   classes: {},
   locale: '',
   setLocale: undefined,
+  userLanguages: [],
 };
diff --git a/src/components/SidebarIndexList.js b/src/components/SidebarIndexList.js
@@ -11,11 +11,11 @@ import SidebarIndexThumbnail from '../containers/SidebarIndexThumbnail';
 export class SidebarIndexList extends Component {
   /** @private */
   getIdAndLabelOfCanvases() {
-    const { canvases } = this.props;
+    const { canvases, languages } = this.props;
 
     return canvases.map((canvas, index) => ({
       id: canvas.id,
-      label: new MiradorCanvas(canvas).getLabel(),
+      label: new MiradorCanvas(canvas).getLabel(languages),
     }));
   }
 
@@ -25,6 +25,7 @@ export class SidebarIndexList extends Component {
       canvases,
       classes,
       containerRef,
+      languages,
       selectedCanvasIds,
       setCanvas,
       variant,
@@ -64,7 +65,11 @@ export class SidebarIndexList extends Component {
                   component="li"
                   selected={selectedCanvasIds.includes(canvas.id)}
                 >
-                  <Item label={canvas.label} canvas={canvases[canvasIndex]} />
+                  <Item
+                    label={canvas.label}
+                    canvas={canvases[canvasIndex]}
+                    languages={languages}
+                  />
                 </MenuItem>
               </ScrollTo>
             );
@@ -79,6 +84,7 @@ SidebarIndexList.propTypes = {
   canvases: PropTypes.array.isRequired, // eslint-disable-line react/forbid-prop-types
   classes: PropTypes.objectOf(PropTypes.string).isRequired,
   containerRef: PropTypes.oneOf([PropTypes.func, PropTypes.object]).isRequired,
+  languages: PropTypes.arrayOf(PropTypes.string).isRequired,
   selectedCanvasIds: PropTypes.arrayOf(PropTypes.string),
   setCanvas: PropTypes.func.isRequired,
   variant: PropTypes.oneOf(['item', 'thumbnail']),

diff --git a/src/components/SidebarIndexTableOfContents.js b/src/components/SidebarIndexTableOfContents.js
@@ -59,7 +59,7 @@ export class SidebarIndexTableOfContents extends Component {
   }
 
   /** */
-  buildTreeItems(nodes, visibleNodeIds, containerRef, nodeIdToScrollTo) {
+  buildTreeItems(nodes, visibleNodeIds, containerRef, nodeIdToScrollTo, languages) {
     const { classes } = this.props;
     if (!nodes) {
       return null;
@@ -88,7 +88,7 @@ export class SidebarIndexTableOfContents extends Component {
                   [classes.visibleNode]: visibleNodeIds.indexOf(node.id) !== -1,
                 })}
               >
-                {node.label}
+                {node.data.getLabel().getValue(languages)}
               </div>
             )}
             onClick={() => this.selectTreeItem(node)}
@@ -110,6 +110,7 @@ export class SidebarIndexTableOfContents extends Component {
   render() {
     const {
       classes, treeStructure, visibleNodeIds, expandedNodeIds, containerRef, nodeIdToScrollTo,
+      languages,
     } = this.props;
 
     if (!treeStructure) {
@@ -125,7 +126,9 @@ export class SidebarIndexTableOfContents extends Component {
           defaultEndIcon={<></>}
           expanded={expandedNodeIds}
         >
-          {this.buildTreeItems(treeStructure.nodes, visibleNodeIds, containerRef, nodeIdToScrollTo)}
+          {this.buildTreeItems(
+            treeStructure.nodes, visibleNodeIds, containerRef, nodeIdToScrollTo, languages,
+          )}
         </TreeView>
       </>
     );
@@ -139,6 +142,7 @@ SidebarIndexTableOfContents.propTypes = {
     PropTypes.shape({ current: PropTypes.instanceOf(Element) }),
   ]).isRequired,
   expandedNodeIds: PropTypes.arrayOf(PropTypes.string).isRequired,
+  languages: PropTypes.arrayOf(PropTypes.string).isRequired,
   nodeIdToScrollTo: PropTypes.func.isRequired,
   setCanvas: PropTypes.func.isRequired,
   toggleNode: PropTypes.func.isRequired,