unified translation of events and event-related emails

Signed-off-by: Stephan Richter <s.richter@srsoftware.de>

Svelte/Dockerfile

@@ -1,5 +1,5 @@
 FROM alpine:3.22
-LABEL Maintainer "Stephan Richter <s.richter@srsoftware.de>"
+LABEL Maintainer "Stephan Richter"
 ARG UID=1000
 ARG GID=1000
 RUN apk add bash npm

bus/src/main/java/de/srsoftware/umbrella/messagebus/events/Event.java

@@ -6,6 +6,7 @@ import static java.util.Optional.*;
 
 import de.srsoftware.tools.Diff;
 import de.srsoftware.tools.Mappable;
+import de.srsoftware.umbrella.core.model.Translatable;
 import de.srsoftware.umbrella.core.model.UmbrellaUser;
 import java.util.Collection;
 import java.util.HashMap;
@@ -45,7 +46,7 @@ public abstract class Event<Payload extends Mappable> {
 
 	public abstract Collection<UmbrellaUser> audience();
 
-	public abstract String describe();
+	public abstract Translatable describe();
 
 	private Map<String, Object> dropMarkdown(Map<String, Object> map) {
 		var result = new HashMap<String, Object>();
@@ -96,5 +97,5 @@ public abstract class Event<Payload extends Mappable> {
 		return payload;
 	}
 
-	public abstract String subject();
+	public abstract Translatable subject();
 }

bus/src/main/java/de/srsoftware/umbrella/messagebus/events/ProjectEvent.java

@@ -1,12 +1,12 @@
 /* © SRSoftware 2025 */
 package de.srsoftware.umbrella.messagebus.events;
 
+import static de.srsoftware.umbrella.core.constants.Field.OBJECT;
+import static de.srsoftware.umbrella.core.constants.Field.USER;
 import static de.srsoftware.umbrella.core.constants.Module.PROJECT;
-import static java.text.MessageFormat.format;
+import static de.srsoftware.umbrella.core.model.Translatable.t;
 
-import de.srsoftware.umbrella.core.model.Member;
+import de.srsoftware.umbrella.core.model.*;
-import de.srsoftware.umbrella.core.model.Project;
-import de.srsoftware.umbrella.core.model.UmbrellaUser;
 import java.util.Collection;
 import java.util.Map;
 
@@ -26,8 +26,9 @@ public class ProjectEvent extends Event<Project>{
 	}
 
 	@Override
-	public String describe() {
+	public Translatable describe() {
-		return diff().orElse("[TODO: ProjectEvent.describe]");
+		return diff().map(UnTranslatable::new).map(Translatable.class::cast)
+				.orElseGet(() -> t("[TODO: {object}.describe]",OBJECT,this.getClass().getSimpleName()));
 	}
 
 	@Override
@@ -39,7 +40,7 @@ public class ProjectEvent extends Event<Project>{
 	}
 
 	@Override
-	public String subject() {
+	public Translatable subject() {
-		return format("{0} edited {1}",initiator(),payload());
+		return t("{user} edited {object}",USER,initiator(),OBJECT,payload());
 	}
 }

bus/src/main/java/de/srsoftware/umbrella/messagebus/events/TaskEvent.java

@@ -2,12 +2,12 @@
 package de.srsoftware.umbrella.messagebus.events;
 
 
+import static de.srsoftware.umbrella.core.constants.Field.OBJECT;
+import static de.srsoftware.umbrella.core.constants.Field.USER;
 import static de.srsoftware.umbrella.core.constants.Module.TASK;
-import static java.text.MessageFormat.format;
+import static de.srsoftware.umbrella.core.model.Translatable.t;
 
-import de.srsoftware.umbrella.core.model.Member;
+import de.srsoftware.umbrella.core.model.*;
-import de.srsoftware.umbrella.core.model.Task;
-import de.srsoftware.umbrella.core.model.UmbrellaUser;
 import java.util.Collection;
 import java.util.Map;
 
@@ -27,8 +27,9 @@ public class TaskEvent extends Event<Task>{
 	}
 
 	@Override
-	public String describe() {
+	public Translatable describe() {
-		return diff().orElse("[TODO: TaskEvent.describe()]");
+		return diff().map(UnTranslatable::new).map(Translatable.class::cast)
+				.orElseGet(() -> t("[TODO: {object}.describe]",OBJECT,this.getClass().getSimpleName()));
 	}
 
 	@Override
@@ -40,7 +41,6 @@ public class TaskEvent extends Event<Task>{
 	}
 
 	@Override
-	public String subject() {
+	public Translatable subject() {
-		return format("{0} edited {1}",initiator(),payload());
+		return t("{user} edited {object}",USER,initiator(),OBJECT,payload());
-	}
+	}}
-}

bus/src/main/java/de/srsoftware/umbrella/messagebus/events/WikiEvent.java

@@ -1,12 +1,12 @@
 /* © SRSoftware 2025 */
 package de.srsoftware.umbrella.messagebus.events;
 
+import static de.srsoftware.umbrella.core.constants.Field.OBJECT;
+import static de.srsoftware.umbrella.core.constants.Field.USER;
 import static de.srsoftware.umbrella.core.constants.Module.WIKI;
-import static java.text.MessageFormat.format;
+import static de.srsoftware.umbrella.core.model.Translatable.t;
 
-import de.srsoftware.umbrella.core.model.Member;
+import de.srsoftware.umbrella.core.model.*;
-import de.srsoftware.umbrella.core.model.UmbrellaUser;
-import de.srsoftware.umbrella.core.model.WikiPage;
 import java.util.Collection;
 import java.util.Map;
 
@@ -26,12 +26,13 @@ public class WikiEvent extends Event<WikiPage>{
 	}
 
 	@Override
-	public String describe() {
+	public Translatable describe() {
-		return diff().orElse("[TODO: WikiEvent.describe()]");
+		return diff().map(UnTranslatable::new).map(Translatable.class::cast)
+				.orElseGet(() -> t("[TODO: {object}.describe]",OBJECT,this.getClass().getSimpleName()));
 	}
 
 	@Override
-	public String subject() {
+	public Translatable subject() {
-		return format("{0} edited {1}",initiator(),payload());
+		return t("{user} edited {object}",USER,initiator(),OBJECT,payload());
 	}
 }

core/src/main/java/de/srsoftware/umbrella/core/model/Message.java

@@ -14,7 +14,7 @@ import java.util.*;
 import org.json.JSONArray;
 import org.json.JSONObject;
 
-public record Message(UmbrellaUser sender, String subject, String body, Map<String,String> fills, List<Attachment> attachments) {
+public record Message(UmbrellaUser sender, Translatable subject, Translatable body, List<Attachment> attachments) {
 	@Override
 	public boolean equals(Object o) {
 		if (!(o instanceof Message message)) return false;
@@ -43,7 +43,7 @@ public record Message(UmbrellaUser sender, String subject, String body, Map<Stri
 				}
 			}
 		}
-		return new Message(sender,subject,body,null, attachments);
+		return new Message(sender,new UnTranslatable(subject),new UnTranslatable(body),attachments);
 	}
 
 	@Override

core/src/main/java/de/srsoftware/umbrella/core/model/Translatable.java

@@ -1,13 +1,15 @@
 /* © SRSoftware 2025 */
 package de.srsoftware.umbrella.core.model;
 
+import static de.srsoftware.tools.Optionals.*;
+
 import de.srsoftware.umbrella.core.ModuleRegistry;
 import java.util.HashMap;
 import java.util.Map;
 
 public class Translatable {
-	private final String message;
+	protected final String message;
-	private Map<String, Object> fills;
+	private final Map<String, Object> fills;
 	private final HashMap<String,String> translated = new HashMap<>();
 
 	public Translatable(String message, Map<String,Object> fills){
@@ -39,7 +41,7 @@ public class Translatable {
 	}
 
 	public String translate(String language){
-		var translation = language != null ? translated.get(language) : null;
+		var translation = language == null ? null : translated.get(language);
 		if (translation == null){
 			var translatedFills = new HashMap<String,String>();
 			if (fills != null) {
@@ -54,7 +56,7 @@ public class Translatable {
 				}
 			}
 			translation = ModuleRegistry.translator().translate(language,message,translatedFills);
-			if (translation != null) translated.put(language,translation);
+			if (allSet(language, translation)) translated.put(language,translation);
 		}
 		return translation;
 	}

core/src/main/java/de/srsoftware/umbrella/core/model/UnTranslatable.java

@@ -0,0 +1,14 @@
+/* © SRSoftware 2025 */
+package de.srsoftware.umbrella.core.model;
+
+
+
+public class UnTranslatable extends Translatable{
+	public UnTranslatable(String message) {
+		super(message, null);
+	}
+
+	public String translate(String language){
+		return message;
+	}
+}

documents/src/main/java/de/srsoftware/umbrella/documents/DocumentApi.java

@@ -577,7 +577,7 @@ public class DocumentApi extends BaseHandler implements DocumentService {
 			LOG.log(WARNING,e);
 		}
 		var attachment = new Attachment(doc.number()+".pdf",rendered.mimeType(),rendered.bytes());
-		var message = new Message(user,subject,content,null,List.of(attachment));
+		var message = new Message(user,new UnTranslatable(subject),new UnTranslatable(content),List.of(attachment));
 		var envelope = new Envelope(message,new User(doc.customer().shortName(),new EmailAddress(email),doc.customer().language()));
 		postBox().send(envelope);
 		db.save(doc.set(SENT));

messages/src/main/java/de/srsoftware/umbrella/message/MessageSystem.java

@@ -5,10 +5,10 @@ import static de.srsoftware.tools.PathHandler.CONTENT_TYPE;
 import static de.srsoftware.umbrella.core.ConnectionProvider.connect;
 import static de.srsoftware.umbrella.core.constants.Constants.UTF8;
 import static de.srsoftware.umbrella.core.exceptions.UmbrellaException.missingConfig;
+import static de.srsoftware.umbrella.core.model.Translatable.t;
 import static de.srsoftware.umbrella.message.Constants.*;
 import static de.srsoftware.umbrella.messagebus.MessageBus.messageBus;
 import static java.lang.System.Logger.Level.*;
-import static java.text.MessageFormat.format;
 
 import de.srsoftware.configuration.Configuration;
 import de.srsoftware.umbrella.core.ModuleRegistry;
@@ -21,7 +21,7 @@ import de.srsoftware.umbrella.message.model.CombinedMessage;
 import de.srsoftware.umbrella.messagebus.EventListener;
 import de.srsoftware.umbrella.messagebus.events.Event;
 import jakarta.activation.DataHandler;
-import jakarta.mail.Message;
+import jakarta.mail.Message.RecipientType;
 import jakarta.mail.MessagingException;
 import jakarta.mail.Session;
 import jakarta.mail.Transport;
@@ -31,7 +31,6 @@ import jakarta.mail.internet.MimeMultipart;
 import jakarta.mail.util.ByteArrayDataSource;
 import java.util.*;
 import java.util.concurrent.CopyOnWriteArrayList;
-import java.util.function.BiFunction;
 
 public class MessageSystem implements PostBox, EventListener {
 	public static final System.Logger LOG = System.getLogger(MessageSystem.class.getSimpleName());
@@ -95,14 +94,8 @@ public class MessageSystem implements PostBox, EventListener {
 	@Override
 	public void onEvent(Event<?> event) {
 		for (var user : event.audience()){
-			if (!"s.richter@srsoftware.de".equals(user.email().toString())) continue;
+			if (debugAddress != null && !debugAddress.equals(user.email().toString())) continue;
-			var verb = switch (event.eventType()){
+			var message = new de.srsoftware.umbrella.core.model.Message(event.initiator(),event.subject(),event.describe(),null);
-				case UPDATE -> "updated";
-				case CREATE -> "created";
-				case DELETE -> "deleted";
-			};
-			var title = format("{0} {1} {2} {3}",event.initiator().name(),verb,event.module(), event.payload());
-			var message = new de.srsoftware.umbrella.core.model.Message(event.initiator(),title,event.describe(),null,null);
 			var envelope = new Envelope(message,user);
 			send(envelope);
 		}
@@ -135,14 +128,12 @@ public class MessageSystem implements PostBox, EventListener {
 		var date = new Date();
 
 		for (var receiver : dueRecipients){
-			BiFunction<String,Map<String,String>,String> translateFunction = (text,fills) -> ModuleRegistry.translator().translate(receiver.language(),text,fills);
+			var combined = new CombinedMessage(t("Collected messages"),receiver);
-
-			var combined = new CombinedMessage("Collected messages",translateFunction);
 			var envelopes = queue.stream().filter(env -> env.isFor(receiver)).toList();
 			for (var envelope : envelopes) combined.merge(envelope.message());
 
 			try {
-				send(combined,receiver,date);
+				send(combined,date);
 				for (var envelope : envelopes){
 					var audience = envelope.receivers();
 					audience.remove(receiver);
@@ -176,7 +167,8 @@ public class MessageSystem implements PostBox, EventListener {
 	}
 
 
-	private void send(CombinedMessage message, User receiver, Date date) throws MessagingException {
+	private void send(CombinedMessage message, Date date) throws MessagingException {
+		var receiver = message.receiver();
 		LOG.log(TRACE,"Sending combined message to {0}…",receiver);
 		session = session();
 		MimeMessage msg = new MimeMessage(session);
@@ -187,7 +179,7 @@ public class MessageSystem implements PostBox, EventListener {
 		msg.setSubject(message.subject(), UTF8);
 		msg.setSentDate(date);
 		var toEmail = debugAddress != null ? debugAddress : receiver.email().toString();
-		msg.setRecipients(Message.RecipientType.TO, toEmail);
+		msg.setRecipients(RecipientType.TO, toEmail);
 
 		if (message.attachments().isEmpty()){
 			msg.setText(message.body(), UTF8);

messages/src/main/java/de/srsoftware/umbrella/message/model/CombinedMessage.java

@@ -5,33 +5,31 @@ import static java.lang.System.Logger.Level.DEBUG;
 import static java.lang.System.Logger.Level.TRACE;
 import static java.text.MessageFormat.format;
 
-import de.srsoftware.umbrella.core.model.Attachment;
+import de.srsoftware.umbrella.core.model.*;
-import de.srsoftware.umbrella.core.model.Message;
-import de.srsoftware.umbrella.core.model.UmbrellaUser;
 import java.util.*;
-import java.util.function.BiFunction;
 
 public class CombinedMessage {
 	private static final System.Logger LOG = System.getLogger(CombinedMessage.class.getSimpleName());
 
 	private final Set<Attachment> attachments = new HashSet<>();
 	private final StringBuilder combinedBody = new StringBuilder();
+	private final User receiver;
 	private String combinedSubject = null;
 	private final List<Message> mergedMessages = new ArrayList<>();
-	private final String subjectForCombinedMessage;
+	private final Translatable subjectForCombinedMessage;
-	private final BiFunction<String,Map<String,String>,String> translate;
 	private UmbrellaUser sender = null;
 
-	public CombinedMessage(String subjectForCombinedMessage, BiFunction<String, Map<String,String>,String> translateFunction){
+	public CombinedMessage(Translatable subjectForCombinedMessage, User receiver){
 		LOG.log(DEBUG,"Creating combined message…");
 		this.subjectForCombinedMessage = subjectForCombinedMessage;
-		translate = translateFunction;
+		this.receiver = receiver;
 	}
 
 	public void merge(Message message) {
 		LOG.log(TRACE,"Merging {0} into combined message…",message);
-		var body = translate.apply(message.body(),message.fills());
+		var lang = receiver.language();
-		var subject = translate.apply(message.subject(),message.fills());
+		var body = message.body().translate(lang);
+		var subject = message.subject().translate(lang);
 		switch (mergedMessages.size()){
 			case 0:
 				combinedBody.append(body);
@@ -40,7 +38,7 @@ public class CombinedMessage {
 				break;
 			case 1:
 				combinedBody.insert(0,format("# {0}:\n# {1}:\n\n",sender,subject)); // insert sender and subject of first message right before the body of the first message
-				combinedSubject = subjectForCombinedMessage;
+				combinedSubject = subjectForCombinedMessage.translate(lang);
 				// no break here, we need to append the subject and content
 			default:
 				combinedBody.append("\n\n# ").append(message.sender()).append(":\n");
@@ -59,6 +57,14 @@ public class CombinedMessage {
 		return combinedBody.toString();
 	}
 
+	public List<Message> messages() {
+		return mergedMessages;
+	}
+
+	public User receiver(){
+		return receiver;
+	}
+
 	public UmbrellaUser sender() {
 		return sender;
 	}
@@ -67,7 +73,10 @@ public class CombinedMessage {
 		return combinedSubject;
 	}
 
-	public List<Message> messages() {
+	@Override
-		return mergedMessages;
+	public String toString() {
+		var body	 = body();
+		if (body.length()>100) body = body.substring(0,99)+"…";
+		return format("{0} for {1} ({2}): {3}",getClass().getSimpleName(),receiver.email(),subject(),body);
 	}
 }

translations/src/main/resources/de.json

@@ -143,7 +143,6 @@
 
   "given_name": "Vorname",
   "go": "los!",
-  "go_to_url_to_reset_password": "Um ein neues Passwort zu erhalten, öffnen Sie bitte den folgenden Link: {url}",
   "gross_sum": "Brutto-Summe",
 
   "head": "Kopf-Text",
@@ -345,6 +344,7 @@
   "title_not_available": "„{title}“ ist als Seitenname nicht mehr verfügbar!",
   "title_or_desc": "Titel/Beschreibung",
   "toggle_objects": "{objects} an/ausschalten",
+  "To receive a new password, open the following link: {url}": "Um ein neues Passwort zu erhalten, öffnen Sie bitte den folgenden Link: {url}",
   "tutorial": "Tutorial",
   "type": "Dokumententyp",
   "type_confirmation": "Bestätigung",
@@ -384,6 +384,6 @@
   "visible_to_guests": "Für Besucher sichtbar",
 
   "year": "Jahr",
-  "your_password_reset_token" : "Ihr Token zum Erstellen eines neuen Passworts",
+  "Your token to create a new password" : "Ihr Token zum Erstellen eines neuen Passworts",
   "your_profile": "dein Profil"
 }

translations/src/main/resources/en.json

@@ -143,7 +143,6 @@
 
   "given_name": "given name",
   "go": "go!",
-  "go_to_url_to_reset_password": "To receive a new password, open the following link: {url}",
   "gross_sum": "gross sum",
 
   "head": "header text",
@@ -345,6 +344,7 @@
   "title_not_available": "„{title}“ is not available as page name!",
   "title_or_desc": "title/description",
   "toggle_objects": "toggle {objects}",
+  "To receive a new password, open the following link: {url}": "To receive a new password, open the following link: {url}",
   "tutorial": "tutorial",
   "type": "type",
   "type_confirmation": "confirmation",
@@ -384,6 +384,6 @@
   "visible_to_guests": "visible to guests",
 
   "year": "year",
-  "your_password_reset_token" : "Your token to create a new password",
+  "Your token to create a new password" : "Your token to create a new password",
   "your_profile": "your profile"
 }

user/src/main/java/de/srsoftware/umbrella/user/UserModule.java

@@ -16,6 +16,7 @@ import static de.srsoftware.umbrella.core.constants.Field.STATE;
 import static de.srsoftware.umbrella.core.constants.Field.USER;
 import static de.srsoftware.umbrella.core.constants.Path.*;
 import static de.srsoftware.umbrella.core.exceptions.UmbrellaException.*;
+import static de.srsoftware.umbrella.core.model.Translatable.t;
 import static de.srsoftware.umbrella.user.Constants.*;
 import static de.srsoftware.umbrella.user.Paths.*;
 import static de.srsoftware.umbrella.user.Paths.IMPERSONATE;
@@ -502,11 +503,10 @@ public class UserModule extends BaseHandler implements UserService {
 			if (oldToken != null) tokenMap.remove(oldToken);
 			tokenMap.put(token,email);
 			tokenMap.put(email,token);
-			var subject = "user.your_password_reset_token";
-			var content = "user.go_to_url_to_reset_password";
 			var url = url(ex).replace("/api/user/reset_pw","/user/reset/pw")+"?token="+token;
-			var fills = Map.of("url",url);
+			var subject = t("Your token to create a new password");
-			var message = new Message(user,subject,content,fills,null);
+			var content = t("To receive a new password, open the following link: {url}",URL,url);
+			var message = new Message(user,subject,content,null);
 			var envelope = new Envelope(message,user);
 			postBox().send(envelope);
 		} catch (UmbrellaException e){