Multilingual Emails #8044

tylerjmchugh · 2024-05-15T20:11:40Z

Emails are currently sent in the UI language of the sender regardless of the preferences of the receiver.

This PR implements a framework for generating multilingual emails including:

A configuration field in settings>feedback to specify which languages to send emails in.
Another configuration field to specify the "translation follows" text at the start of the email. (Can include multiple languages).

Email messages for all specified languages will be concatenated with a separator.
If the settings fields are left empty, default back to the UI language.

Related feature request: #7966

Checklist

…fields are saved

…ents' parameters

ianwallen

Tested locally and works as expected.

I'm not sure if some of the new files are in the preferred location - I will let others comment on if some of the new files should be placed in different location.

fxprunayre · 2024-05-17T07:45:06Z

I'm not sure if some of the new files are in the preferred location - I will let others comment on if some of the new files should be placed in different location.

LGTM.

josegar74 · 2024-05-17T12:17:22Z

Tested with the default configuration (no languages configured), I get a NullPointerException when submitting a metadata to review:

https://github.com/geonetwork/core-geonetwork/pull/8044/files#diff-8ffe27a26ea5dc5d13d71bdc2dfbd7afd4aaea80037f18bf304d9754aaaf7818R182

It fails internally in

https://github.com/geonetwork/core-geonetwork/pull/8044/files#diff-1c4dbe5c43914f0b170604f63ec220e17bdf72b3dd6b6a4951c8c13583c50336R309

It happens also when configuring the languages in the settings.

…lingual-emails # Conflicts: # core/src/main/java/org/fao/geonet/kernel/search/EsSearchManager.java # core/src/main/java/org/fao/geonet/util/XslUtil.java # index/src/main/java/org/fao/geonet/index/es/EsRestClient.java

…istency

tylerjmchugh · 2024-05-17T17:32:57Z

Tested with the default configuration (no languages configured), I get a NullPointerException when submitting a metadata to review:

https://github.com/geonetwork/core-geonetwork/pull/8044/files#diff-8ffe27a26ea5dc5d13d71bdc2dfbd7afd4aaea80037f18bf304d9754aaaf7818R182

It fails internally in

https://github.com/geonetwork/core-geonetwork/pull/8044/files#diff-1c4dbe5c43914f0b170604f63ec220e17bdf72b3dd6b6a4951c8c13583c50336R309

Reproduced the first issue and it seems to be fixed after merging the changes from #8042.

It happens also when configuring the languages in the settings.

I am however unable to reproduce the issue while configuring the languages.

josegar74

Changes look good, the error is solved.

Please wait to merge it until 4.4.5 is released.

josegar74 · 2024-05-17T11:36:26Z

core/src/main/java/org/fao/geonet/kernel/metadata/DefaultStatusActions.java

+                } catch (MissingResourceException e) {
+                    failedToFindASpecificTextTemplate = true;
+                }
+            }


Suggested change

}

}

if ((failedToFindASpecificSubjectTemplate) && (failedToFindASpecificTextTemplate)) break;

Added loop breaking logic in latest push

# Conflicts: # services/src/main/java/org/fao/geonet/api/users/RegisterApi.java

geonetworkbuild · 2024-06-19T16:15:07Z

The backport to 4.2.x failed:

The process '/usr/bin/git' failed with exit code 1

stderr

error: could not apply c7c49917de... Add spring bean to initialize feedback email locales from settings field
hint: After resolving the conflicts, mark them with
hint: "git add/rm <pathspec>", then run
hint: "git cherry-pick --continue".
hint: You can instead skip this commit with "git cherry-pick --skip".
hint: To abort and get back to the state before "git cherry-pick",
hint: run "git cherry-pick --abort".
hint: Disable this message with "git config advice.mergeConflict false"

stdout

Auto-merging core/src/main/java/org/fao/geonet/kernel/setting/Settings.java
Auto-merging web-ui/src/main/resources/catalog/locales/en-admin.json
Auto-merging web/src/main/webapp/WEB-INF/classes/setup/sql/data/data-db-default.sql
Auto-merging web/src/main/webapp/WEB-INF/classes/setup/sql/migrate/v4211/migrate-default.sql
[backport-8044-to-4.2.x 8b60cecc19] Add settings fields for localized emails
 Author: tylerjmchugh <Tyler.McHugh@dfo-mpo.gc.ca>
 Date: Wed May 15 15:26:53 2024 -0400
 4 files changed, 11 insertions(+)
Auto-merging core/src/main/resources/config-spring-geonetwork.xml
CONFLICT (content): Merge conflict in core/src/main/resources/config-spring-geonetwork.xml

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-4.2.x 4.2.x
# Navigate to the new working tree
cd .worktrees/backport-4.2.x
# Create a new branch
git switch --create backport-8044-to-4.2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick 146f1846bc4a660175911d637aaa3747878acd95,c7c49917de61879bc6ea2b445548259b784bf585,80a7d267b665062cbe40a497aeaad96af7a664a0,acf4147484bd09d9619059c36a3689a47e6ac741,88f20681d008692b2b03f843a7440107ad4778c4,3fab7c320f280cbc11e5898b56ca3f16d4ed77a9,da0f5450d6dd0cec45e96c093e267a2a78916761,cc8310172a9811c474716503fc36a372999c05be,3d6b6cee7a70f7cca377a5fdbf881bf823e85165,9988d7d8a0fe1edcbdeb6f180cb7faa1f90ceacf,c94dd7b6b6301084cac0943561e20e7b947ff381,461e4c5112929420ae2ea0409cff56f8c2d6271d,a8f4d1126e1d5aa7a431fbfb0e53eee76a148a0e,bd1dc23c6dfef3b6da210e15f9b1f1a50d3b2578,3f5a3af79fd74049a48b36b9f614d0522a9460bd,2a56de3a52f2e1c5683756f7cb480aee93bf03c2,4319bb67c4e786649744ef01d8fb4dfe89cdf55a,ae96904af72a3fef40fb8deeded6f56d2d28b746,6c4f65307ea3c50c3233a03be2661115ad7c446e,cbcdf2dd39fe347d32a0f4f4709788082a9a2782,b3c45475304024437b79bbca28a645b268822fca,54719604fc2d586fae3401cb346a7979c2100d81,c2599a4c7f35d3b1c5d22bdab867c9d8b35168f5,5e8d4b54236621c12ec4d8c6474b79c8e8e5fbf4,4d6825fa78439641bb6ffc6fcd19a28386fa1e1c
# Push it to GitHub
git push --set-upstream origin backport-8044-to-4.2.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-4.2.x

Then, create a pull request where the base branch is 4.2.x and the compare/head branch is backport-8044-to-4.2.x.

* Add settings fields for localized emails * Add spring bean to initialize feedback email locales from settings field * Modify settings manager to update feedback locales when the settings fields are saved * Create classes for localized emails, their components, and the components' parameters * Implement lang in getIndexField * Localize workflow status emails * Localize metadata publication emails * Localize user feedback emails * Localize RegisterApi emails * Localize PasswordApi emails * Localize WatchListNotifier emails * Localize MailApi emails * Update migration script to only insert settings fields if not present * Add static enum imports for readability * Log a warning when a locale is invalid or missing * Update log modules and messages * Trim language codes defined in settings to handle spaces after commas * Rename translation follows label to translation follows text for consistency * Add back resource bundle 'messages' that was unused before merging main * Add logic to break from loop when email subject and text messages fail

* Add settings fields for localized emails * Add spring bean to initialize feedback email locales from settings field * Modify settings manager to update feedback locales when the settings fields are saved * Create classes for localized emails, their components, and the components' parameters * Implement lang in getIndexField * Localize workflow status emails * Localize metadata publication emails * Localize user feedback emails * Localize RegisterApi emails * Localize PasswordApi emails * Localize WatchListNotifier emails * Localize MailApi emails * Update migration script to only insert settings fields if not present * Add static enum imports for readability * Log a warning when a locale is invalid or missing * Update log modules and messages * Trim language codes defined in settings to handle spaces after commas * Rename translation follows label to translation follows text for consistency * Add back resource bundle 'messages' that was unused before merging main * Add logic to break from loop when email subject and text messages fail Co-authored-by: tylerjmchugh <163562062+tylerjmchugh@users.noreply.github.com>

tylerjmchugh added 16 commits May 15, 2024 15:57

Add settings fields for localized emails

146f184

Add spring bean to initialize feedback email locales from settings field

c7c4991

Modify settings manager to update feedback locales when the settings …

80a7d26

…fields are saved

Create classes for localized emails, their components, and the compon…

acf4147

…ents' parameters

Implement lang in getIndexField

88f2068

Localize workflow status emails

3fab7c3

Localize metadata publication emails

da0f545

Localize user feedback emails

cc83101

Localize RegisterApi emails

3d6b6ce

Localize PasswordApi emails

9988d7d

Localize WatchListNotifier emails

c94dd7b

Localize MailApi emails

461e4c5

Update migration script to only insert settings fields if not present

a8f4d11

Add static enum imports for readability

bd1dc23

Log a warning when a locale is invalid or missing

3f5a3af

Update log modules and messages

2a56de3

ianwallen added the enhancement label May 16, 2024

ianwallen added this to the 4.4.5 milestone May 16, 2024

ianwallen added the backport 4.2.x label May 16, 2024

Merge main into main.multilingual-emails

4319bb6

ianwallen approved these changes May 16, 2024

View reviewed changes

ianwallen requested review from josegar74 and fxprunayre May 16, 2024 18:31

tylerjmchugh mentioned this pull request May 16, 2024

XSL / Utility / Add multilingual support to getIndexField #8042

Merged

10 tasks

tylerjmchugh marked this pull request as ready for review May 16, 2024 18:45

ianwallen mentioned this pull request May 17, 2024

[Backport 4.2.x]XSL / Utility / Add multilingual support to getIndexField #8065

Merged

tylerjmchugh added 2 commits May 17, 2024 12:24

Trim language codes defined in settings to handle spaces after commas

6c4f653

Rename translation follows label to translation follows text for cons…

cbcdf2d

…istency

josegar74 modified the milestones: 4.4.5, 4.4.6 Jun 3, 2024

tylerjmchugh added 2 commits June 3, 2024 13:25

Merge main into main.multilingual-emails and resolve conflicts

b3c4547

Add back resource bundle 'messages' that was unused before merging main

5471960

josegar74 approved these changes Jun 4, 2024

View reviewed changes

tylerjmchugh added 3 commits June 4, 2024 09:40

Add logic to break from loop when email subject and text messages fail

c2599a4

Merge main into main.multilingual-emails

5e8d4b5

Merge main into main.multilingual-emails

4d6825f

# Conflicts: # services/src/main/java/org/fao/geonet/api/users/RegisterApi.java

ianwallen merged commit 1fd8b52 into geonetwork:main Jun 19, 2024
6 checks passed

geonetworkbuild added the failed backport label Jun 19, 2024

ianwallen mentioned this pull request Jun 20, 2024

[Backport 4.2.x] Multilingual Emails (#8044) #8210

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Multilingual Emails #8044

Multilingual Emails #8044

tylerjmchugh commented May 15, 2024

ianwallen left a comment

fxprunayre commented May 17, 2024

josegar74 commented May 17, 2024 •

edited

Loading

tylerjmchugh commented May 17, 2024

josegar74 left a comment

josegar74 May 17, 2024

tylerjmchugh Jun 4, 2024

geonetworkbuild commented Jun 19, 2024

-            }
+            }
+            if ((failedToFindASpecificSubjectTemplate) && (failedToFindASpecificTextTemplate)) break;

Multilingual Emails #8044

Multilingual Emails #8044

Conversation

tylerjmchugh commented May 15, 2024

Checklist

ianwallen left a comment

Choose a reason for hiding this comment

fxprunayre commented May 17, 2024

josegar74 commented May 17, 2024 • edited Loading

tylerjmchugh commented May 17, 2024

josegar74 left a comment

Choose a reason for hiding this comment

josegar74 May 17, 2024

Choose a reason for hiding this comment

tylerjmchugh Jun 4, 2024

Choose a reason for hiding this comment

geonetworkbuild commented Jun 19, 2024

josegar74 commented May 17, 2024 •

edited

Loading