From 003b97553e8c4aab1c67847a18dcc07f06f48b75 Mon Sep 17 00:00:00 2001 From: Lars Scheideler Date: Thu, 6 Dec 2018 11:47:56 +0100 Subject: [PATCH 1/7] hide action sections with dataset dependency --- basic-backend-api.js | 2 +- local-storage-api.js | 4 ++-- plugin-actions.js | 12 +++++++++++- styles.css | 4 ++++ 4 files changed, 18 insertions(+), 4 deletions(-) diff --git a/basic-backend-api.js b/basic-backend-api.js index b3f5027..1d12e7d 100644 --- a/basic-backend-api.js +++ b/basic-backend-api.js @@ -35,7 +35,7 @@ var plugin_xml_datasets = $('
') // Add plugin section -var basicPluginXMLStorage = new BasicAppPlugin('app-plugin-xml', 'eXist Storage Configuration', 'fas fa-database', '#app-content-plugins-configuration'); +var basicPluginXMLStorage = new BasicAppPlugin('app-plugin-xml', 'eXist Storage Configuration', 'fas fa-database', '#app-content-plugins-configuration', 'NO'); basicPluginXMLStorage.render(plugin_xml_datasets); diff --git a/local-storage-api.js b/local-storage-api.js index 8f0f33b..58d3d9b 100644 --- a/local-storage-api.js +++ b/local-storage-api.js @@ -25,7 +25,7 @@ var plugin_ls_dataset_info = $('
') // Add plugin section -var basicPluginLocalStorage = new BasicAppPlugin('app-plugin-ls', 'Local Storage Configuration', 'fas fa-database', '#app-content-plugins-configuration'); +var basicPluginLocalStorage = new BasicAppPlugin('app-plugin-ls', 'Local Storage Configuration', 'fas fa-database', '#app-content-plugins-configuration', 'NO'); basicPluginLocalStorage.render([plugin_ls_datasets, plugin_ls_dataset_info, plugin_ls_dataset_name]); @@ -171,7 +171,6 @@ LocalStorageAdapter.prototype.load = function () { console.log('Local Storage API: ' + objects_array.length + ' object(s) loaded (context: ' + ctx + ', dataset: ' + ds + ')'); // Update frontend info updateFrontendDatasetInformation(this.last_updated, objects_array.length); - $('body').trigger('datasetLoaded'); } else { console.log('Local Storage API (ERROR): Context or dataset is null. Nothing loaded.'); } @@ -203,6 +202,7 @@ LocalStorageAdapter.prototype.setDataset = function (ds) { // Save current dataset name localStorage.setItem(this.ls_key_last, ds); console.log('Local Storage API: Current dataset: ' + ds); + $('body').trigger('datasetLoaded'); return this; } diff --git a/plugin-actions.js b/plugin-actions.js index 62df680..81d283b 100644 --- a/plugin-actions.js +++ b/plugin-actions.js @@ -1,8 +1,9 @@ -function BasicAppPlugin (id, title, icon_classes, container_selector) { +function BasicAppPlugin (id, title, icon_classes, container_selector, dataset_dependency) { this.id = id; this.title = title; this.icon_classes = icon_classes; this.DOMContainer = $(container_selector); + this.dataset_dependency = dataset_dependency || 'YES'; } @@ -14,6 +15,10 @@ BasicAppPlugin.prototype.renderPluginBase = function () { .append('
' + this.title + '
') .append('
') .appendTo(this.DOMContainer); + // add class to hide an action section + if (this.dataset_dependency == 'YES') { + this.plugin.addClass('plugin-hidden'); + } return this; } @@ -38,6 +43,11 @@ BasicAppPlugin.prototype.render = function (content) { return this; } +// if dataset are loaded remove class to show the sections +$('body').on('datasetLoaded', function (e) { + $('.plugin-hidden').removeClass('plugin-hidden').show(); +}) + function ActionButtonPlugin (id, title, icon_classes, container_selector) { BasicAppPlugin.call(this, id, title, icon_classes, container_selector) diff --git a/styles.css b/styles.css index 56fdd6a..9fd8481 100644 --- a/styles.css +++ b/styles.css @@ -331,3 +331,7 @@ a.link-seealso { height: 100%; } } + +.plugin-hidden { + display: none; +} \ No newline at end of file From 58f1d9b27daa871c09fb2b3c88e24ef9227a1bfb Mon Sep 17 00:00:00 2001 From: Lars Scheideler Date: Thu, 6 Dec 2018 11:49:17 +0100 Subject: [PATCH 2/7] Change JSON export name with affiliation --- plugin-json-imexport.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugin-json-imexport.js b/plugin-json-imexport.js index 710e841..21ecee9 100644 --- a/plugin-json-imexport.js +++ b/plugin-json-imexport.js @@ -6,7 +6,7 @@ function ImportExportPlugin() { Download JSON\ '); this.btn_json_down.on('click', function(e){ - plugin.downloadJSON(data_objects, 'basic-app-data'); + plugin.downloadJSON(data_objects, 'basic-' + context); // Hide plugins $('#app-content-plugins-area').collapse('hide'); }) From b6cc7fc30a5c593773333f43ba327476a3f07e4a Mon Sep 17 00:00:00 2001 From: Uwe Kretschmer Date: Thu, 6 Dec 2018 12:58:02 +0100 Subject: [PATCH 3/7] Enabled CSV-Import to handle variant names of object with the same id. --- config.tpl.js | 13 +++++++++---- plugin-csv-imexport.js | 44 ++++++++++++++++++++++++++++++++++-------- 2 files changed, 45 insertions(+), 12 deletions(-) diff --git a/config.tpl.js b/config.tpl.js index 90f9df4..b1ab6ed 100644 --- a/config.tpl.js +++ b/config.tpl.js @@ -36,7 +36,8 @@ var config = { "statusElement": "status", "identifierElement": "ref", "identifierAbbreviation": "DNB", - "identifierBaseURL": "http://d-nb.info/gnd/" + "identifierBaseURL": "http://d-nb.info/gnd/", + "aliasElement": "alias" }, "places": { "titleElement": "name", @@ -44,7 +45,8 @@ var config = { "statusElement": "status", "identifierElement": "ref", "identifierAbbreviation": "GEO", - "identifierBaseURL": "http://www.geonames.org/" + "identifierBaseURL": "http://www.geonames.org/", + "aliasElement": "alias" }, "organisations":{ "titleElement": "name", @@ -52,7 +54,8 @@ var config = { "statusElement": "status", "identifierElement": "ref", "identifierAbbreviation": "DNB", - "identifierBaseURL": "http://d-nb.info/gnd/" + "identifierBaseURL": "http://d-nb.info/gnd/", + "aliasElement": "alias" } }, @@ -124,7 +127,9 @@ var config = { "localJSONPath": "name" },{ "displayName": "Namensvariante", - "JSONPath": "alternateNames.name" + "JSONPath": "alternateNames.name", + "localJSONPath": "alias", + "multiple": true },{ "displayName": "Breitengrad", "JSONPath": "lat" diff --git a/plugin-csv-imexport.js b/plugin-csv-imexport.js index 3b2c64b..ef66023 100644 --- a/plugin-csv-imexport.js +++ b/plugin-csv-imexport.js @@ -34,11 +34,13 @@ function CSVImportExportPlugin() { \ \
\ -
\ - \ - \ +
\ + \ + \
\
\ +
\ +
\ \ \
\ @@ -86,6 +88,7 @@ function CSVImportExportPlugin() { } }); $('#modals').on('change', '#uploadFileCSV', function (e){ + $('#uploadFileCSVLabel').html(this.files[0].name); plugin.getObjectsFromCSV(); }); $('#modals').on('change', '#mergeFileCSV', function (e){ @@ -173,7 +176,6 @@ CSVImportExportPlugin.prototype.getObjectsFromCSV = function() { var id = letter[column + 'ID']; var entity = {}; // Name and ID are given. Check for duplicate ID - // TODO: if ID already imported and name differs add name as alias if (name && id && !found_ids.includes(id)) { entity[config.v.titleElement] = name; entity[config.v.identifierElement] = id; @@ -181,6 +183,29 @@ CSVImportExportPlugin.prototype.getObjectsFromCSV = function() { unique_names.push(name); found_ids.push(id); } + // If ID already imported and name differs add name as alias + else if (name && id && found_ids.includes(id) && !unique_names.includes(name)) { + if (config.v.aliasElement != undefined) { + // Update importable entity with id and add an alias, if not already done + var already_imported_entity = importable_entities.find(function (e) { + return e[config.v.identifierElement] == id; + }); + if (already_imported_entity[config.v.aliasElement] == undefined) { + // there is no alias yet + already_imported_entity[config.v.aliasElement] = name; + } else { + // Alias(es) aready set. + var old_aliases = asArray(already_imported_entity[config.v.aliasElement]); + // Add if not already done. + if (!old_aliases.includes(name)) { + old_aliases.push(name); + already_imported_entity[config.v.aliasElement] = old_aliases; + } + } + } else { + // If aliases aren't configured, we can't handle this case + } + } // Only the name is given. Check for duplicate name. else if (name && !id && !unique_names.includes(name)) { entity[config.v.titleElement] = name; @@ -195,12 +220,12 @@ CSVImportExportPlugin.prototype.getObjectsFromCSV = function() { count_span.html(importable_entities.length); if (importable_entities.length > 0) { // Add importable entities to import form with filter buttons - $('#csv-file-upload-modal .form-group button[type="button"]').remove(); - var chk_button_filter = '
\ + var chk_button_filter = '
\ \ \
'; - $(chk_button_filter).appendTo('#csv-file-upload-modal .form-group'); + $(chk_button_filter).appendTo(entities_form); + var entities_btn_group = $('
').appendTo(entities_form); importable_entities.forEach(function (e, i) { var ref_html = ''; if (e[config.v.identifierElement] && e[config.v.identifierElement].startsWith(config.v.identifierBaseURL)) { @@ -212,7 +237,7 @@ CSVImportExportPlugin.prototype.getObjectsFromCSV = function() { ' + e[config.v.titleElement] + ref_html +'\ \
'; - $(chk_html).appendTo(entities_form); + $(chk_html).appendTo(entities_btn_group); }) $(btn_import).removeClass('disabled'); $(btn_add).removeClass('disabled'); @@ -265,6 +290,9 @@ CSVImportExportPlugin.prototype.addEntities = function(event) { 'preferred': 'YES' }; } + if (e[config.v.aliasElement] != undefined) { + params[config.v.aliasElement] = e[config.v.aliasElement]; + } addObject(event.target, params) } }); From 71cd6009ebf8f44fc23e17be1a044ed61029dacf Mon Sep 17 00:00:00 2001 From: Lars Scheideler Date: Thu, 6 Dec 2018 15:33:09 +0100 Subject: [PATCH 4/7] Only load data if dataset is given. --- basic-backend-api.js | 36 +++++++++++++++++++----------------- 1 file changed, 19 insertions(+), 17 deletions(-) diff --git a/basic-backend-api.js b/basic-backend-api.js index 1d12e7d..9b23e7c 100644 --- a/basic-backend-api.js +++ b/basic-backend-api.js @@ -225,22 +225,24 @@ function APIDatasets () { cds = sessionStorage.getItem(context); query_dataset = {'dataset': cds}; } - // Load objects from cds in object cache - $.getJSON(config.app.config.baseURL + config.app.config.api[context].RESTAPI, query_dataset).done(function (result) { - var cnt = 0; - if (result) { - cnt = 1; - if (Array.isArray(result[config.a.JSONContainer])) { - cnt = result[config.a.JSONContainer].length; + if (cds) { + // Load objects from cds in object cache + $.getJSON(config.app.config.baseURL + config.app.config.api[context].RESTAPI, query_dataset).done(function (result) { + var cnt = 0; + if (result) { + cnt = 1; + if (Array.isArray(result[config.a.JSONContainer])) { + cnt = result[config.a.JSONContainer].length; + } + data_objects = result; } - data_objects = result; - } - console.log('REST-API: ' + cnt + ' object(s) loaded.'); - // Create result list representation - asArray(data_objects[config.a.JSONContainer]).reverse().forEach(function (obj) {createNewHTMLObject(obj)}); - // Set current dataset - $('#xml-dataset-current').html(cds); - // dataset loaded - $('body').trigger('datasetLoaded'); - }); + console.log('REST-API: ' + cnt + ' object(s) loaded.'); + // Create result list representation + asArray(data_objects[config.a.JSONContainer]).reverse().forEach(function (obj) {createNewHTMLObject(obj)}); + // Set current dataset + $('#xml-dataset-current').html(cds); + // dataset loaded + $('body').trigger('datasetLoaded'); + }); + } } From 719c10563ad13b18b13774f3a831352dbaf3779f Mon Sep 17 00:00:00 2001 From: Uwe Kretschmer Date: Fri, 7 Dec 2018 10:01:05 +0100 Subject: [PATCH 5/7] Updated CSV-Merge to also match entitites by aliases. --- app.js | 7 +++++++ plugin-csv-imexport.js | 6 ++++++ 2 files changed, 13 insertions(+) diff --git a/app.js b/app.js index 36663b7..b3dd192 100644 --- a/app.js +++ b/app.js @@ -72,6 +72,13 @@ function getLocalObjectByTitle (title) { } +function getLocalObjectByAlias (alias) { + return asArray(data_objects[config.a.JSONContainer]).find(function (e) { + return asArray(e[config.v.aliasElement]).includes(alias); + }); +} + + // get the value using the path_key from config template function deepFind (obj, path_key) { // Dynamic attributes diff --git a/plugin-csv-imexport.js b/plugin-csv-imexport.js index ef66023..ae7bc28 100644 --- a/plugin-csv-imexport.js +++ b/plugin-csv-imexport.js @@ -313,6 +313,7 @@ CSVImportExportPlugin.prototype.mergeObjectsWithCSV = function() { var context2columnnames = plugin.context2columnnames; var preselected_statuus = ['safe']; + // TODO: Check if file type is text/csv and handle error case if (file) { Papa.parse(file, { header: true, @@ -388,7 +389,12 @@ CSVImportExportPlugin.prototype.mergeCSV = function() { // Don't replace/add anything in 'soft' mode if an ID is already given if (name != undefined && name.trim() != '' && !(method == 'soft' && id.trim() != '')) { // Get matching object + // Default case is matching with preferred name (titleElement) var obj = getLocalObjectByTitle(name); + // If there is no match on titleElement, try to find one with matching alias, if alias is configured + if (obj == undefined && config.v.aliasElement != undefined) { + obj = getLocalObjectByAlias(name); + } // Check if object is in correct state if (obj !== undefined && statuus.includes(obj[config.v.statusElement])) { // Get preferred ID from local object From 1901832f2bc98089288d318219e88d1ad8ae8905 Mon Sep 17 00:00:00 2001 From: Lars Scheideler Date: Fri, 7 Dec 2018 12:15:35 +0100 Subject: [PATCH 6/7] Fix the view of description so that arrays displayed as proper strings --- app.js | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/app.js b/app.js index b3dd192..ab0bbf7 100644 --- a/app.js +++ b/app.js @@ -144,9 +144,17 @@ function replaceLocalIDInFrontend(old_id, new_id) { } +function dataToString (data) { + if (Array.isArray(data)) { + data = data.join(', '); + } + return data; +} + + function createNewHTMLObject(data){ if(config.v.descriptionElement !== undefined && data[config.v.descriptionElement] != null){ - description_html = '

'+ data[config.v.descriptionElement] + '

'; + description_html = '

' + dataToString(data[config.v.descriptionElement]) + '

'; } else { description_html = '

' } @@ -669,7 +677,6 @@ function changeStatus (trigger_element, element_id, current_status, new_status){ function prepareValueMapping (mapping_config, mapping_value) { var ret = mapping_value; if (mapping_config.multiple){ - // is expectes that in mapping_value multiple values include if (typeof mapping_value === 'string') { var value_arr = mapping_value.split('\n'); if (value_arr.length > 1) { @@ -768,7 +775,7 @@ function editObject(id) { /* 2. update frontend Update title and description of list item */ $('#' + id + ' h5').text(local_object[config.v.titleElement]); - $('#' + id + ' p').text(local_object[config.v.descriptionElement]); + $('#' + id + ' p').text(dataToString(local_object[config.v.descriptionElement])); // Close modal, $('#object-modal').modal('hide'); } From 8f4da4d7719dab203f9b8d8989568082cfb6f3ff Mon Sep 17 00:00:00 2001 From: Uwe Kretschmer Date: Fri, 7 Dec 2018 12:29:47 +0100 Subject: [PATCH 7/7] Prepare release 1.0.1 --- config.tpl.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/config.tpl.js b/config.tpl.js index b1ab6ed..967dee1 100644 --- a/config.tpl.js +++ b/config.tpl.js @@ -1,6 +1,6 @@ var config = { "app": { - "version": "1.0.1-dev", + "version": "1.0.1", "config": { "use_corsanywhere": false, "footer": {