Merge pull request #1263 from fnkbsi/MailUserAtTransactionStop

Mail user on TransactionStop and SuspendedEV event

Author: goekay

src/main/java/de/rwth/idsg/steve/NotificationFeature.java

@@ -21,6 +21,13 @@
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
 
+import java.util.Arrays;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import static de.rwth.idsg.steve.utils.StringUtils.joinByComma;
+import static de.rwth.idsg.steve.utils.StringUtils.splitByComma;
+
 /**
  * @author Sevket Goekay <[email protected]>
  * @since 22.01.2016
@@ -30,17 +37,31 @@ public enum NotificationFeature {
 
     // Ocpp related
     //
-    OcppStationBooted(" a charging station sends a boot notification (Note: This activates notifications about failed connection attempts for unregistered JSON stations, as well)"),
-    OcppStationStatusFailure(" a connector gets faulted"),
-    OcppStationWebSocketConnected(" a JSON charging station connects"),
-    OcppStationWebSocketDisconnected(" a JSON charging station disconnects"),
-    OcppTransactionStarted(" a charging station starts a transaction"),
-    OcppTransactionEnded(" a charging station ends a transaction");
+    OcppStationBooted(false, " a charging station sends a boot notification (Note: This activates notifications about failed connection attempts for unregistered JSON stations, as well)"),
+    OcppStationStatusFailure(true, " a connector gets faulted"),
+    OcppStationWebSocketConnected(false, " a JSON charging station connects"),
+    OcppStationWebSocketDisconnected(false, " a JSON charging station disconnects"),
+    OcppTransactionStarted(true, " a charging station starts a transaction"),
+    OcppStationStatusSuspendedEV(true, " a EV suspended charging"),
+    OcppTransactionEnded(true, " a charging station ends a transaction");
 
+    private static final List<NotificationFeature> userNotificationFeatures = Arrays.stream(NotificationFeature.values())
+        .filter(NotificationFeature::isForUser)
+        .collect(Collectors.toList());
+
+    /**
+     * Whether this notification type is intended for end-users as well.
+     */
+    @Getter
+    private final boolean forUser;
 
     @Getter
     private final String text;
 
+    public static List<NotificationFeature> getUserValues() {
+        return userNotificationFeatures;
+    }
+
     public static NotificationFeature fromName(String v) {
         for (NotificationFeature c: NotificationFeature.values()) {
             if (c.name().equalsIgnoreCase(v)) {
@@ -49,4 +70,14 @@ public static NotificationFeature fromName(String v) {
         }
         throw new IllegalArgumentException(v);
     }
+
+    public static List<NotificationFeature> splitFeatures(String str) {
+        return splitByComma(str).stream()
+            .map(NotificationFeature::fromName)
+            .collect(Collectors.toList());
+    }
+
+    public static String joinFeatures(List<NotificationFeature> enablesFeatures) {
+        return joinByComma(enablesFeatures);
+    }
 }

src/main/java/de/rwth/idsg/steve/config/BeanConfiguration.java

@@ -43,6 +43,7 @@
 import org.springframework.format.support.FormattingConversionService;
 import org.springframework.http.converter.HttpMessageConverter;
 import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
+import org.springframework.scheduling.annotation.EnableAsync;
 import org.springframework.scheduling.annotation.EnableScheduling;
 import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
 import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler;
@@ -67,6 +68,7 @@
 @Configuration
 @EnableWebMvc
 @EnableScheduling
+@EnableAsync
 @ComponentScan("de.rwth.idsg.steve")
 public class BeanConfiguration implements WebMvcConfigurer {
 

src/main/java/de/rwth/idsg/steve/repository/dto/InsertTransactionParams.java

@@ -20,6 +20,7 @@
 
 import lombok.Builder;
 import lombok.Getter;
+import lombok.ToString;
 import org.joda.time.DateTime;
 
 /**
@@ -28,6 +29,7 @@
  */
 @Getter
 @Builder
+@ToString
 public class InsertTransactionParams {
     private final String chargeBoxId;
     private final int connectorId;

src/main/java/de/rwth/idsg/steve/repository/dto/UpdateTransactionParams.java

@@ -21,6 +21,7 @@
 import jooq.steve.db.enums.TransactionStopEventActor;
 import lombok.Builder;
 import lombok.Getter;
+import lombok.ToString;
 import org.joda.time.DateTime;
 
 /**
@@ -29,6 +30,7 @@
  */
 @Getter
 @Builder
+@ToString
 public class UpdateTransactionParams {
     private final String chargeBoxId;
     private final int transactionId;

src/main/java/de/rwth/idsg/steve/repository/dto/User.java

@@ -18,6 +18,7 @@
  */
 package de.rwth.idsg.steve.repository.dto;
 
+import de.rwth.idsg.steve.NotificationFeature;
 import jooq.steve.db.tables.records.AddressRecord;
 import jooq.steve.db.tables.records.UserRecord;
 import lombok.Builder;
@@ -38,6 +39,7 @@ public static final class Overview {
         private final Integer userPk;
         private final String name, phone, email;
         private final List<OcppTagEntry> ocppTagEntries;
+        private final List<NotificationFeature> notificationFeatures;
     }
 
     @Getter

src/main/java/de/rwth/idsg/steve/repository/impl/TransactionRepositoryImpl.java

@@ -289,6 +289,10 @@ private List<Condition> getConditions(TransactionQueryForm form) {
             conditions.add(CONNECTOR.CHARGE_BOX_ID.eq(form.getChargeBoxId()));
         }
 
+        if (form.isConnectorIdSet()) {
+            conditions.add(CONNECTOR.CONNECTOR_ID.eq(form.getConnectorId()));
+        }
+
         if (form.isOcppIdTagSet()) {
             conditions.add(TRANSACTION.ID_TAG.eq(form.getOcppIdTag()));
         }

src/main/java/de/rwth/idsg/steve/repository/impl/UserRepositoryImpl.java

@@ -19,6 +19,7 @@
 package de.rwth.idsg.steve.repository.impl;
 
 import com.google.common.base.Strings;
+import de.rwth.idsg.steve.NotificationFeature;
 import de.rwth.idsg.steve.SteveException;
 import de.rwth.idsg.steve.repository.AddressRepository;
 import de.rwth.idsg.steve.repository.UserRepository;
@@ -32,7 +33,7 @@
 import org.jooq.DSLContext;
 import org.jooq.Field;
 import org.jooq.Record1;
-import org.jooq.Record5;
+import org.jooq.Record6;
 import org.jooq.Result;
 import org.jooq.SelectConditionStep;
 import org.jooq.exception.DataAccessException;
@@ -77,6 +78,7 @@ public List<User.Overview> getOverview(UserQueryForm form) {
                 .phone(r.value4())
                 .email(r.value5())
                 .ocppTagEntries(tags)
+                .notificationFeatures(NotificationFeature.splitFeatures(r.value6()))
                 .build();
 
             // TODO: Improve later. This is not efficient, because we filter after fetching all results. However, this
@@ -165,7 +167,7 @@ public void delete(int userPk) {
     // Private helpers
     // -------------------------------------------------------------------------
 
-    private Result<Record5<Integer, String, String, String, String>> getOverviewInternal(UserQueryForm form) {
+    private Result<Record6<Integer, String, String, String, String, String>> getOverviewInternal(UserQueryForm form) {
         List<Condition> conditions = new ArrayList<>();
 
         if (form.isSetUserPk()) {
@@ -200,7 +202,8 @@ private Result<Record5<Integer, String, String, String, String>> getOverviewInte
                 USER.FIRST_NAME,
                 USER.LAST_NAME,
                 USER.PHONE,
-                USER.E_MAIL)
+                USER.E_MAIL,
+                USER.NOTIFICATION_FEATURES)
             .from(USER)
             .where(conditions)
             .fetch();
@@ -257,6 +260,7 @@ private Integer addInternal(DSLContext ctx, UserForm form, Integer addressPk) {
                       .set(USER.E_MAIL, form.getEMail())
                       .set(USER.NOTE, form.getNote())
                       .set(USER.ADDRESS_PK, addressPk)
+                      .set(USER.NOTIFICATION_FEATURES, NotificationFeature.joinFeatures(form.getNotificationFeatures()))
                       .returning(USER.USER_PK)
                       .fetchOne()
                       .getUserPk();
@@ -275,6 +279,7 @@ private void updateInternal(DSLContext ctx, UserForm form, Integer addressPk) {
            .set(USER.E_MAIL, form.getEMail())
            .set(USER.NOTE, form.getNote())
            .set(USER.ADDRESS_PK, addressPk)
+           .set(USER.NOTIFICATION_FEATURES, NotificationFeature.joinFeatures(form.getNotificationFeatures()))
            .where(USER.USER_PK.eq(form.getUserPk()))
            .execute();
     }

src/main/java/de/rwth/idsg/steve/service/CentralSystemService16_Service.java

@@ -27,6 +27,7 @@
 import de.rwth.idsg.steve.repository.dto.UpdateTransactionParams;
 import de.rwth.idsg.steve.service.notification.OccpStationBooted;
 import de.rwth.idsg.steve.service.notification.OcppStationStatusFailure;
+import de.rwth.idsg.steve.service.notification.OcppStationStatusSuspendedEV;
 import de.rwth.idsg.steve.service.notification.OcppTransactionEnded;
 import de.rwth.idsg.steve.service.notification.OcppTransactionStarted;
 import jooq.steve.db.enums.TransactionStopEventActor;
@@ -147,6 +148,11 @@ public StatusNotificationResponse statusNotification(
                     chargeBoxIdentity, parameters.getConnectorId(), parameters.getErrorCode().value()));
         }
 
+         if (parameters.getStatus() == ChargePointStatus.SUSPENDED_EV) {
+            applicationEventPublisher.publishEvent(new OcppStationStatusSuspendedEV(
+                    chargeBoxIdentity, parameters.getConnectorId(), parameters.getTimestamp()));
+        }
+
         return new StatusNotificationResponse();
     }
 

src/main/java/de/rwth/idsg/steve/service/MailService.java

@@ -22,6 +22,8 @@
 
 import jakarta.mail.MessagingException;
 
+import java.util.List;
+
 /**
  * @author Sevket Goekay <[email protected]>
  * @since 11.03.2025
@@ -35,4 +37,6 @@ public interface MailService {
     void sendAsync(String subject, String body);
 
     void send(String subject, String body) throws MessagingException;
+
+    void send(String subject, String body, List<String> eMailAddresses);
 }

src/main/java/de/rwth/idsg/steve/service/MailServiceDefault.java

@@ -36,7 +36,9 @@
 import jakarta.mail.internet.InternetAddress;
 import jakarta.mail.internet.MimeMessage;
 
+import java.util.List;
 import java.util.Properties;
+import java.util.function.Function;
 
 /**
  * @author Sevket Goekay <[email protected]>
@@ -77,6 +79,19 @@ public void sendAsync(String subject, String body) {
 
     @Override
     public void send(String subject, String body) throws MessagingException {
+        sendInternal(subject, body, MailSettings::getRecipients);
+    }
+
+    @Override
+    public void send(String subject, String body, List<String> eMailAddresses) {
+        try {
+            sendInternal(subject, body, mailSettings -> eMailAddresses);
+        } catch (MessagingException e) {
+            log.error("Failed to send mail", e);
+        }
+    }
+
+    public void sendInternal(String subject, String body, Function<MailSettings, List<String>> emailAddressProvider) throws MessagingException {
         MailSettings settings = getSettings();
         Session session = createSession(settings);
 
@@ -85,7 +100,7 @@ public void send(String subject, String body) throws MessagingException {
         mail.setContent(body, "text/plain");
         mail.setFrom(new InternetAddress(settings.getFrom()));
 
-        for (String rep : settings.getRecipients()) {
+        for (String rep : emailAddressProvider.apply(settings)) {
             mail.addRecipient(Message.RecipientType.TO, new InternetAddress(rep));
         }