From 2737f1e53e893e7cee4b0d41ad05f5456261f40a Mon Sep 17 00:00:00 2001 From: tkleinke Date: Thu, 24 Oct 2024 11:35:21 +0200 Subject: [PATCH] Initial commit --- .github/workflows/release.yml | 40 +++++++ .gitignore | 5 + LICENSE | 201 +++++++++++++++++++++++++++++++ Makefile | 24 ++++ README.md | 53 +++++++++ l10n/counter.csv | 8 ++ manifest.master.yml | 62 ++++++++++ src/server/setCounterValues.js | 211 +++++++++++++++++++++++++++++++++ 8 files changed, 604 insertions(+) create mode 100755 .github/workflows/release.yml create mode 100755 .gitignore create mode 100755 LICENSE create mode 100755 Makefile create mode 100755 README.md create mode 100755 l10n/counter.csv create mode 100755 manifest.master.yml create mode 100755 src/server/setCounterValues.js diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100755 index 0000000..6f342c0 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,40 @@ +name: Release + +on: + push: + tags: + - "v*.*.*" + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + with: + submodules: recursive + + - name: Get the version + id: get_version + run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\//} + shell: bash + + - name: Extract repository name + run: echo "REPOSITORY_NAME=$(echo '${{ github.repository }}' | awk -F '/' '{print $2}')" >> $GITHUB_ENV + shell: bash + + - name: Set zip file name + run: echo "ZIP_NAME=Counter.zip" >> $GITHUB_ENV + + - name: Build and Package + shell: bash + run: make + + - name: Release + uses: softprops/action-gh-release@v1 + with: + name: Release ${{ steps.get_version.outputs.VERSION }} + draft: true + generate_release_notes: true + files: | + build/${{ env.ZIP_NAME }} diff --git a/.gitignore b/.gitignore new file mode 100755 index 0000000..aa88d8b --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +*~ +.#* +\#*\# +build +.DS_Store diff --git a/LICENSE b/LICENSE new file mode 100755 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Makefile b/Makefile new file mode 100755 index 0000000..7f0833e --- /dev/null +++ b/Makefile @@ -0,0 +1,24 @@ +PLUGIN_NAME = counter +ZIP_NAME = "Counter.zip" + +SERVER_FILE = setCounterValues.js + +all: build zip + +build: clean + mkdir -p build + mkdir -p build/$(PLUGIN_NAME) + mkdir -p build/$(PLUGIN_NAME)/server + mkdir -p build/$(PLUGIN_NAME)/l10n + + cp src/server/${SERVER_FILE} build/${PLUGIN_NAME}/server/${SERVER_FILE} + cp l10n/$(PLUGIN_NAME).csv build/$(PLUGIN_NAME)/l10n/$(PLUGIN_NAME).csv + cp manifest.master.yml build/$(PLUGIN_NAME)/manifest.yml + +clean: + rm -rf build + +zip: + cd build && zip $(ZIP_NAME) -r $(PLUGIN_NAME)/ + cp -r build/$(PLUGIN_NAME)/* build/ + rm -rf build/${PLUGIN_NAME} diff --git a/README.md b/README.md new file mode 100755 index 0000000..5a0786a --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +# Counter plugin + +This server plugin allows automatically setting the values of numeric counter fields when saving data. Counter field values are calculated based on the unique combination of values entered in a defined set of base fields. Please note that the counter field as well as all base fields are expected to be grouped inside the same nested field. + +## Installation + +The latest version of this plugin can be found [here](https://github.com/programmfabrik/fylr-plugin-counter/releases/latest/download/Counter.zip). + +The ZIP can be downloaded and installed using the plugin manager, or used directly (recommended). + +## Configuration + +All plugin configuration takes place in base configuration. + +* *Object types*: + * *Object type name*: The name of the object type for which to set up the counter + * *Parent nested fields*: + * *Path to parent field*: The path to the nested field that contains the counter field and the base fields. + * *Counter field name*: The name of the counter field to be filled out by the plugin. This has to be a numeric field. The field will only be updated if it is empty and if all base fields have been filled out by the user. + * *Base field names*: The names of the base fields to consider when updating the counter field. These can be text fields or fields of the [custom data type DANTE](https://github.com/programmfabrik/fylr-plugin-custom-data-type-dante). The combination of the values of these fields is the content that is being counted. + +## Example + +### Configuration + +* *Object type name*: example +* *Path to parent field*: _nested:example__parent +* *Counter field name*: counter +* *Base field names*: place, year + +### Result + +The field "counter" contains the respective value as generated by the plugin. + +Object 1: + + { + "_nested:example__parent": [ + { "place": "London", "year": "2020", "counter": 1 }, + { "place": "Berlin", "year": "2020", "counter": 1 }, + { "place": "Berlin", "year": "2020", "counter": 2 } + ] + } + +Object 2: + + { + "_nested:example__parent": [ + { "place": "London", "year": "2020", "counter": 2 }, + { "place": "Berlin", "year": "2020", "counter": 3 } + { "place": "Berlin", "year": "2021", "counter": 1 } + ] + } diff --git a/l10n/counter.csv b/l10n/counter.csv new file mode 100755 index 0000000..65f031b --- /dev/null +++ b/l10n/counter.csv @@ -0,0 +1,8 @@ +key,de-DE,en-US +server.config.name.system.counter,Zähler,Counter +server.config.parameter.system.counter.object_types.label,Objekttypen,Object types +server.config.parameter.system.counter.object_types.name.label,Name des Objekttyps,Object type name +server.config.parameter.system.counter.object_types.nested_fields.label,Übergeordnete Wiederholfelder,Parent nested fields +server.config.parameter.system.counter.object_types.nested_fields.field_path.label,Pfad zum übergeordneten Feld,Path to parent field +server.config.parameter.system.counter.object_types.nested_fields.counter_field_name.label,Name des Zählerfeldes,Counter field name +server.config.parameter.system.counter.object_types.nested_fields.base_fields.label,Namen der Basisfelder,Base field names \ No newline at end of file diff --git a/manifest.master.yml b/manifest.master.yml new file mode 100755 index 0000000..7dfe814 --- /dev/null +++ b/manifest.master.yml @@ -0,0 +1,62 @@ +plugin: + name: counter + version: 1.0 + displayname: + de-DE: Zähler + en-US: Counter + info: + de-DE: Zähler + en-US: Counter + server: + api-version: + require: 1 + l10n: l10n/counter.csv + +base_config: + - name: counter + parameters: + object_types: + type: table + fields: + - name: name + type: text + position: 0 + - name: nested_fields + type: table + fields: + - name: field_path + type: text + position: 0 + - name: counter_field_name + type: text + position: 1 + - name: base_fields + type: table + fields: + - name: field_name + type: text + position: 0 + position: 2 + position: 1 + position: 0 + +callbacks: + db_pre_save: + steps: + - name: "Set values in counter fields" + callback: setCounterValues + callbacks: + setCounterValues: + exec: + service: "node" + commands: + - prog: "node" + stdin: + type: body + stdout: + type: body + args: + - type: "value" + value: "%_exec.pluginDir%/server/setCounterValues.js" + - type: "value" + value: "%info.json%" diff --git a/src/server/setCounterValues.js b/src/server/setCounterValues.js new file mode 100755 index 0000000..8420b7e --- /dev/null +++ b/src/server/setCounterValues.js @@ -0,0 +1,211 @@ +const info = process.argv.length >= 3 + ? JSON.parse(process.argv[2]) + : {}; + +let input = ''; +process.stdin.on('data', d => { + try { + input += d.toString(); + } catch (err) { + console.error(`Could not read input into string: ${err.message}`, err.stack); + process.exit(1); + } +}); + +process.stdin.on('end', async () => { + const data = JSON.parse(input); + const configuration = getPluginConfiguration(data); + const changedObjects = []; + + for (let object of data.objects) { + if (await processObject(object, configuration)) changedObjects.push(object); + } + + console.log(JSON.stringify({ objects: changedObjects })); + + if (!changedObjects.length) { + console.error('No changes'); + process.exit(0); + } +}); + +function getPluginConfiguration(data) { + return data.info.config.plugin['counter'].config.counter; +} + +async function processObject(object, configuration) { + const nestedFieldsConfiguration = getNestedFieldsConfiguration(configuration, object._objecttype); + let changed = false; + + for (let nestedFieldConfiguration of nestedFieldsConfiguration) { + if (await processNestedFields(object, nestedFieldConfiguration)) changed = true; + } + + return changed; +} + +function getNestedFieldsConfiguration(configuration, objectType) { + return configuration.object_types + ?.find(configuration => configuration.name === objectType) + ?.nested_fields ?? []; +} + +async function processNestedFields(object, nestedFieldConfiguration) { + const nestedFields = getFieldValues( + object[object._objecttype], + nestedFieldConfiguration.field_path + ); + let changed = false; + + for (let nestedField of nestedFields) { + if (await addCounterValue( + object._objecttype, + nestedFields, + nestedField, + nestedFieldConfiguration.field_path, + nestedFieldConfiguration.counter_field_name, + nestedFieldConfiguration.base_fields?.map(field => field.field_name), + )) changed = true; + } + + return changed; +} + +function getFieldValues(object, fieldPath) { + const pathSegments = fieldPath.split('.'); + const fieldName = pathSegments.shift(); + const field = object[fieldName]; + + if (field === undefined) { + return []; + } else if (pathSegments.length === 0) { + return Array.isArray(field) ? field : [field]; + } else if (Array.isArray(field)) { + return field.map(entry => getFieldValues(entry, pathSegments.slice())) + .filter(data => data !== undefined) + .reduce((result, fieldValues) => result.concat(fieldValues), []); + } else { + return getFieldValues(field, pathSegments); + } +} + +async function addCounterValue(objectType, nestedFields, nestedField, nestedFieldPath, counterFieldName, baseFieldNames) { + if (!counterFieldName?.length + || !baseFieldNames + || baseFieldNames.find(baseFieldName => !nestedField[baseFieldName]) + || nestedField[counterFieldName]) return false; + + nestedField[counterFieldName] = await getCounterValue( + objectType, nestedFields, nestedField, nestedFieldPath, counterFieldName, baseFieldNames + ); + + return true; +} + +async function getCounterValue(objectType, nestedFields, nestedField, nestedFieldPath, counterFieldName, baseFieldNames) { + const existingCounterValues = await findExistingCounterValues( + objectType, nestedFields, nestedField, nestedFieldPath, counterFieldName, baseFieldNames + ); + existingCounterValues.sort(); + + return existingCounterValues.length + ? existingCounterValues.pop() + 1 + : 1; +} + +async function findExistingCounterValues(objectType, nestedFields, nestedField, nestedFieldPath, counterFieldName, + baseFieldNames) { + const counterValuesInCurrentObject = findExistingCounterValuesInNestedFields( + nestedFields, nestedField, counterFieldName, baseFieldNames + ); + const counterValuesInOtherObjects = await findExistingCounterValuesInOtherObjects( + objectType, nestedField, nestedFieldPath, counterFieldName, baseFieldNames + ); + + return counterValuesInCurrentObject.concat(counterValuesInOtherObjects) + .filter(value => value); +} + +function findExistingCounterValuesInNestedFields(nestedFields, nestedField, counterFieldName, baseFieldNames) { + for (let baseFieldName of baseFieldNames) { + nestedFields = nestedFields.filter(field => { + return getBaseFieldValue(field, baseFieldName) === getBaseFieldValue(nestedField, baseFieldName); + }); + } + + return nestedFields.map(field => field[counterFieldName]) +} + +async function findExistingCounterValuesInOtherObjects(objectType, nestedField, nestedFieldPath, counterFieldName, + baseFieldNames) { + const url = info.api_url + '/api/v1/search?access_token=' + info.api_user_access_token; + const searchRequest = { + search: baseFieldNames.map(baseFieldName => { + return { + type: 'match', + bool: 'must', + fields: [getFullFieldPath(objectType, nestedField, nestedFieldPath, baseFieldName)], + string: getBaseFieldValue(nestedField, baseFieldName) + }; + }), + include_fields: [objectType + '.' + nestedFieldPath + '.' + counterFieldName].concat( + baseFieldNames.map(baseFieldName => getFullFieldPath(objectType, nestedField, nestedFieldPath, baseFieldName)) + ) + }; + + try { + const response = await fetch(url, { + method: 'POST', + headers: { + 'Content-Type': 'application/json' + }, + body: JSON.stringify(searchRequest) + }); + const result = await response.json(); + + return result.objects.reduce((result, object) => { + const counterValues = findExistingCounterValuesInNestedFields( + getFieldValues(object[objectType], nestedFieldPath), nestedField, counterFieldName, baseFieldNames + ); + return result.concat(counterValues); + }, []); + } catch (err) { + throwErrorToFrontend('Search request failed', JSON.stringify(err)); + } +} + +function getBaseFieldValue(nestedField, baseFieldName) { + const fieldValue = nestedField[baseFieldName]; + + return isDanteConcept(fieldValue) + ? fieldValue.conceptURI + : fieldValue; +} + +function getFullFieldPath(objectType, nestedField, nestedFieldPath, baseFieldName) { + let result = objectType + '.' + nestedFieldPath + '.' + baseFieldName; + if (isDanteConcept(nestedField[baseFieldName])) result += '.conceptURI'; + + return result; +} + +function isDanteConcept(fieldValue) { + return typeof fieldValue === 'object' + && fieldValue.conceptName !== undefined + && fieldValue.conceptURI !== undefined; +} + +function throwErrorToFrontend(error, description) { + console.log(JSON.stringify({ + error: { + code: 'error.counter', + statuscode: 400, + realm: 'api', + error, + parameters: {}, + description + } + })); + + process.exit(0); +}