Ftr/dynamic annotation classification

.github/workflows/add-new-issues-and-prs-to-project.yml

@@ -11,7 +11,7 @@ jobs:
     name: Add issue to project
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/add-to-project@v1.0.2
+      - uses: actions/add-to-project@v2.0.0
         with:
           project-url: https://github.com/orgs/Edirom/projects/4
           github-token: ${{ secrets.ADD_TO_PROJECT_TOKEN }}

.github/workflows/docker-build-and-push.yml

@@ -12,7 +12,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v6
+        uses: actions/checkout@v7
         with:
           fetch-depth: 0 # fetch all history to include latest tags for build metadata
           submodules: 'recursive'

.github/workflows/update-citation.yml

@@ -19,7 +19,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v6
+        uses: actions/checkout@v7
 
       - name: Update or add commit and date-released fields
         run: |

app/Application.js

@@ -85,7 +85,6 @@ Ext.define('EdiromOnline.Application', {
             me.backendURL = config.backendURL || me.backendURL;
             EdiromOnline.model.Edition.updateProxyUrl(me.backendURL);
             EdiromOnline.model.Work.updateProxyUrl(me.backendURL);
-            EdiromOnline.model.Annotation.updateProxyUrl(me.backendURL);
             me.initializeApplication();
         }, me);
     },

app/controller/AJAXController.js

@@ -67,7 +67,8 @@ Ext.define('EdiromOnline.controller.AJAXController', {
         if(typeof async === 'undefined')
             async = true;
 
-        url = this.application.backendURL + url;
+        if(!/^https?:\/\//.test(url))
+            url = this.application.backendURL + url;
 
         var fn = Ext.bind(function(response, options, retryNoInt) {
 

app/controller/window/HelpWindow.js

@@ -52,10 +52,6 @@ Ext.define('EdiromOnline.controller.window.HelpWindow', {
 
                 var windowContent = response.responseText;
 
-                // replace image paths (relative backendPath to absolute backendURL)            
-                var replacee = new RegExp('src="' + me.backendPath.replace(/\/, '\/'/g), "g");
-                windowContent = windowContent.replace(replacee, 'src="' + me.backendURL);
-
                 // set window content
                 win.setContent(windowContent);
             }, me)

app/controller/window/source/MeasureBasedView.js

@@ -184,7 +184,7 @@ Ext.define('EdiromOnline.controller.window.source.MeasureBasedView', {
                     var data = response.responseText;
 
                     var annotations = Ext.create('Ext.data.Store', {
-                        fields: ['id', 'title', 'text', 'uri', 'plist', 'svgList', 'priority', 'categories', 'fn'],
+                        fields: ['id', 'title', 'text', 'uri', 'plist', 'svgList', 'priority', 'categories', 'taxonomyClasses', 'fn'],
                         data: Ext.JSON.decode(data)
                     });
 

app/controller/window/source/SourceView.js

@@ -96,19 +96,31 @@ Ext.define('EdiromOnline.controller.window.source.SourceView', {
                 if(typeof(debug) !== 'undefined' && debug !== null && debug) {
                     console.log(data);
                 }
+
+                // if taxonomies array is empty but categories and priorities are
+                // populated merge those to a taxonomies array
+                var taxonomies = data['taxonomies'] || [];
+                if (taxonomies.length === 0) {
+                    var categories = data['categories'] || [];
+                    var priorities = data['priorities'] || [];
+                    if (categories.length > 0) {
+                        taxonomies.push({
+                            id: 'ediromCategory',
+                            label: 'ediromCategory',
+                            items: categories
+                        });
+                    }
+                    if (priorities.length > 0) {
+                        taxonomies.push({
+                            id: 'ediromPriority',
+                            label: 'ediromPriority',
+                            items: priorities
+                        });
+                    }
+                }
 
-                var priorities = Ext.create('Ext.data.Store', {
-                    fields: ['id', 'name'],
-                    data: data['priorities']
-                });
-                var categories = Ext.create('Ext.data.Store', {
-                    fields: ['id', 'name'],
-                    data: data['categories']
-                });
-
-                //TODO why not save to object store?
-
-                me.annotInfosLoaded(priorities, categories, view);
+                // hand over returned taxonomies array
+                me.annotInfosLoaded(taxonomies, view);
             }, this)
         );
 
@@ -134,8 +146,9 @@ Ext.define('EdiromOnline.controller.window.source.SourceView', {
         view.setMovements(movements);
     },
 
-    annotInfosLoaded: function(priorities, categories, view) {
-        view.setAnnotationFilter(priorities, categories);
+    annotInfosLoaded: function(taxonomies, view) {
+        // delegate taxonomies array handling to the view
+        view.setAnnotationFilter(taxonomies);
     },
 
     overlaysLoaded: function(overlays, view) {
@@ -237,7 +250,7 @@ Ext.define('EdiromOnline.controller.window.source.SourceView', {
                     var data = response.responseText;
 
                     var annotations = Ext.create('Ext.data.Store', {
-                        fields: ['id', 'title', 'text', 'uri', 'plist', 'svgList', 'priority', 'categories', 'fn'],
+                        fields: ['id', 'title', 'text', 'uri', 'plist', 'svgList', 'priority', 'categories', 'taxonomyClasses', 'fn'],
                         data: Ext.JSON.decode(data)
                     });
 

app/controller/window/text/TextFacsimileSplitView.js

@@ -120,16 +120,29 @@ Ext.define('EdiromOnline.controller.window.text.TextFacsimileSplitView', {
 
                 data = Ext.JSON.decode(data);
 
-                var priorities = Ext.create('Ext.data.Store', {
-                    fields: ['id', 'name'],
-                    data: data['priorities']
-                });
-                var categories = Ext.create('Ext.data.Store', {
-                    fields: ['id', 'name'],
-                    data: data['categories']
-                });
-
-                me.annotInfosLoaded(priorities, categories, view);
+                // if taxonomies array is empty but categories and priorities are
+                // populated merge those to a taxonomies array
+                var taxonomies = data['taxonomies'] || [];
+                if (taxonomies.length === 0) {
+                    var categories = data['categories'] || [];
+                    var priorities = data['priorities'] || [];
+                    if (categories.length > 0) {
+                        taxonomies.push({
+                            id: 'ediromCategory',
+                            label: 'ediromCategory',
+                            items: categories
+                        });
+                    }
+                    if (priorities.length > 0) {
+                        taxonomies.push({
+                            id: 'ediromPriority',
+                            label: 'ediromPriority',
+                            items: priorities
+                        });
+                    }
+                }
+
+                me.annotInfosLoaded(taxonomies, view);
             }, this)
         );
     },
@@ -138,8 +151,8 @@ Ext.define('EdiromOnline.controller.window.text.TextFacsimileSplitView', {
         view.setChapters(chapters);
     },
 
-    annotInfosLoaded: function(priorities, categories, view) {
-        view.setAnnotationFilter(priorities, categories);
+    annotInfosLoaded: function(taxonomies, view) {
+        view.setAnnotationFilter(taxonomies);
     },
 
     onAnnotationsVisibilityChange: function(view, visible) {
@@ -156,7 +169,7 @@ Ext.define('EdiromOnline.controller.window.text.TextFacsimileSplitView', {
                     var data = response.responseText;
 
                     var annotations = Ext.create('Ext.data.Store', {
-                        fields: ['id', 'title', 'text', 'uri', 'plist', 'svgList', 'priority', 'categories', 'fn'],
+                        fields: ['id', 'title', 'text', 'uri', 'plist', 'svgList', 'priority', 'categories', 'taxonomyClasses', 'fn'],
                         data: Ext.JSON.decode(data)
                     });
 

app/controller/window/text/TextView.js

@@ -49,13 +49,13 @@ Ext.define('EdiromOnline.controller.window.text.TextView', {
 
         var uri = view.uri;
 
-        window.doAJAXRequest('data/xql/getText.xql',
+        // request goes to v2 API - relative to backendURI
+        window.doAJAXRequest('api/document',
             'GET',
             {
-                uri: uri,
+                resource: uri,
                 idPrefix: view.id + '_',
-                term: view.window.term,
-                path: view.window.path
+                mediaType: 'text/html'
             },
             Ext.bind(function(response){
                 this.contentLoaded(view, response.responseText);
@@ -98,16 +98,29 @@ Ext.define('EdiromOnline.controller.window.text.TextView', {
 
                 data = Ext.JSON.decode(data);
 
-                var priorities = Ext.create('Ext.data.Store', {
-                    fields: ['id', 'name'],
-                    data: data['priorities']
-                });
-                var categories = Ext.create('Ext.data.Store', {
-                    fields: ['id', 'name'],
-                    data: data['categories']
-                });
-
-                me.annotInfosLoaded(priorities, categories, view);
+                // if taxonomies array is empty but categories and priorities are
+                // populated merge those to a taxonomies array
+                var taxonomies = data['taxonomies'] || [];
+                if (taxonomies.length === 0) {
+                    var categories = data['categories'] || [];
+                    var priorities = data['priorities'] || [];
+                    if (categories.length > 0) {
+                        taxonomies.push({
+                            id: 'ediromCategory',
+                            label: 'ediromCategory',
+                            items: categories
+                        });
+                    }
+                    if (priorities.length > 0) {
+                        taxonomies.push({
+                            id: 'ediromPriority',
+                            label: 'ediromPriority',
+                            items: priorities
+                        });
+                    }
+                }
+
+                me.annotInfosLoaded(taxonomies, view);
             }, this)
         );
     },
@@ -144,8 +157,8 @@ Ext.define('EdiromOnline.controller.window.text.TextView', {
         view.showAnnotations(annotations);
     },
 
-    annotInfosLoaded: function(priorities, categories, view) {
-        view.setAnnotationFilter(priorities, categories);
+    annotInfosLoaded: function(taxonomies, view) {
+        view.setAnnotationFilter(taxonomies);
     },
 
     onGotoChapter: function(view, chapter) {

app/view/window/AnnotationView.js

@@ -295,26 +295,46 @@ Ext.define('EdiromOnline.view.window.AnnotationView', {
                 dataIndex: 'title',
                 flex: 4,
                 filter: true
+            },
+            {
+                header: getLangString('ediromPriority') + ' (legacy)',
+                dataIndex: 'priority',
+                flex: 1,
+                filter: true
+            },
+            {
+                header: getLangString('ediromCategory') + ' (legacy)',
+                dataIndex: 'categories',
+                flex: 2,
+                filter: true
             }
+
         ];
 
         // save existing dataIndex entries as column names
         const existingColumnNames = columns.map(column =>
             column.dataIndex);
 
+        // Legacy fields declared by the backend — skip them in favour of taxonomy map entries
+        // when the annotation_hide_legacy_fields preference is true (default).
+        // Falls back to [] for older backends that don't send this key, or when pref is false.
+        const hideLegacyFields = getPreference('annotation_hide_legacy_fields', true) === 'true';
+        const legacyFields = hideLegacyFields && me.data && me.data.legacyFields ? me.data.legacyFields : [];
+
         //iterate over storeFields to create missing grid columns
         storeFields.forEach(field => {
+            if (legacyFields.includes(typeof field === 'string' ? field : field.name)) return;
             if (!existingColumnNames.includes(typeof field === 'string' ? field : field.name)) {
                 // if existingColumnNames does not include the value of field or field.name
                 // create fieldObject
                 const fieldName = typeof field === 'string' ? field : field.name;
                 const fieldObject = {
-                    header: getLangString('view.window.AnnotationView_' + fieldName),
+                    header: getLangString(fieldName),
                     dataIndex: fieldName,
                     renderer: me.createFieldRenderer(fieldName),
-                    flex: 1,
+                    flex: 1, //TODO evaluate filed content length to set more appropriate flex value
                     filter: true,
-                    hidden: emptyFields ? emptyFields.includes(field) : false
+                    hidden: emptyFields ? emptyFields.includes(fieldName) : false
                 };
                 // push fieldObject to columns array
                 columns.push(fieldObject);