fix merge conflict

Author: JavaIsJavaScript

README.md

@@ -118,6 +118,11 @@ Screenshots
 9. [Operations - OCPP v1.5](website/screenshots/ocpp15.png)
 10. [Settings](website/screenshots/settings.png)
 
+
+GDPR
+-----
+If you are in the EU and offer vehicle charging to other people using SteVe, keep in mind that you have to comply to the General Data Protection Regulation (GDPR) as SteVe processes charging transactions, which can be considered personal data.
+
 Are you having issues?
 -----
 See the [FAQ](https://github.com/RWTH-i5-IDSG/steve/wiki/FAQ)

pom.xml

@@ -140,6 +140,24 @@
                 </configuration>
             </plugin>
 
+            <plugin>
+                <groupId>pl.project13.maven</groupId>
+                <artifactId>git-commit-id-plugin</artifactId>
+                <version>2.2.4</version>
+                <executions>
+                    <execution>
+                        <phase>initialize</phase>
+                        <goals>
+                            <goal>revision</goal>
+                        </goals>
+                    </execution>
+                </executions>
+                <configuration>
+                    <failOnNoGitDirectory>false</failOnNoGitDirectory>
+                    <failOnUnableToExtractRepoInfo>false</failOnUnableToExtractRepoInfo>
+                </configuration>
+            </plugin>
+
             <!-- Read from main.properties the DB configuration -->
             <plugin>
                 <groupId>org.codehaus.mojo</groupId>

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

@@ -1,9 +1,12 @@
 package de.rwth.idsg.steve;
 
+import de.rwth.idsg.steve.ocpp.ws.custom.WsSessionSelectStrategy;
 import de.rwth.idsg.steve.ocpp.ws.custom.WsSessionSelectStrategyEnum;
 import de.rwth.idsg.steve.utils.PropertiesFileLoader;
 import lombok.Builder;
 import lombok.Getter;
+import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
+import org.springframework.security.crypto.password.PasswordEncoder;
 
 /**
  * @author Sevket Goekay <goekay@dbis.rwth-aachen.de>
@@ -30,6 +33,7 @@ public enum SteveConfiguration {
 
     private final String contextPath;
     private final String steveVersion;
+    private final String gitDescribe;
     private final ApplicationProfile profile;
     private final Ocpp ocpp;
     private final Auth auth;
@@ -41,6 +45,7 @@ public enum SteveConfiguration {
 
         contextPath = sanitizeContextPath(p.getOptionalString("context.path"));
         steveVersion = p.getString("steve.version");
+        gitDescribe = useFallbackIfNotSet(p.getOptionalString("git.describe"), null);
         profile = ApplicationProfile.fromName(p.getString("profile"));
 
         jetty = Jetty.builder()
@@ -63,9 +68,12 @@ public enum SteveConfiguration {
                .sqlLogging(p.getBoolean("db.sql.logging"))
                .build();
 
+        PasswordEncoder encoder = new BCryptPasswordEncoder();
+
         auth = Auth.builder()
+                   .passwordEncoder(encoder)
                    .userName(p.getString("auth.user"))
-                   .password(p.getString("auth.password"))
+                   .encodedPassword(encoder.encode(p.getString("auth.password")))
                    .build();
 
         ocpp = Ocpp.builder()
@@ -77,6 +85,26 @@ public enum SteveConfiguration {
         validate();
     }
 
+    public String getSteveCompositeVersion() {
+        if (gitDescribe == null) {
+            return steveVersion;
+        } else {
+            return steveVersion + "-g" + gitDescribe;
+        }
+    }
+
+    private static String useFallbackIfNotSet(String value, String fallback) {
+        if (value == null) {
+            // if the property is optional, value will be null
+            return fallback;
+        } else if (value.startsWith("${")) {
+            // property value variables start with "${" (if maven is not used, the value will not be set)
+            return fallback;
+        } else {
+            return value;
+        }
+    }
+
     private String sanitizeContextPath(String s) {
         if (s == null || "/".equals(s)) {
             return "";
@@ -131,15 +159,16 @@ public static class DB {
     // Credentials for Web interface access
     @Builder @Getter
     public static class Auth {
+        private final PasswordEncoder passwordEncoder;
         private final String userName;
-        private final String password;
+        private final String encodedPassword;
     }
 
     // OCPP-related configuration
     @Builder @Getter
     public static class Ocpp {
         private final boolean autoRegisterUnknownStations;
-        private final WsSessionSelectStrategyEnum wsSessionSelectStrategy;
+        private final WsSessionSelectStrategy wsSessionSelectStrategy;
     }
 
 }

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

@@ -3,9 +3,6 @@
 import de.rwth.idsg.steve.ocpp.soap.LoggingFeatureProxy;
 import de.rwth.idsg.steve.ocpp.soap.MediatorInInterceptor;
 import de.rwth.idsg.steve.ocpp.soap.MessageIdInterceptor;
-import de.rwth.idsg.steve.ocpp.ws.custom.AlwaysLastStrategy;
-import de.rwth.idsg.steve.ocpp.ws.custom.RoundRobinStrategy;
-import de.rwth.idsg.steve.ocpp.ws.custom.WsSessionSelectStrategy;
 import org.apache.cxf.Bus;
 import org.apache.cxf.bus.spring.SpringBus;
 import org.apache.cxf.common.logging.LogUtils;
@@ -71,18 +68,6 @@ public SpringBus springBus() {
         return new SpringBus();
     }
 
-    @Bean
-    public WsSessionSelectStrategy sessionSelectStrategy() {
-        switch (CONFIG.getOcpp().getWsSessionSelectStrategy()) {
-            case ALWAYS_LAST:
-                return new AlwaysLastStrategy();
-            case ROUND_ROBIN:
-                return new RoundRobinStrategy();
-            default:
-                throw new RuntimeException("Could not find a valid WsSessionSelectStrategy");
-        }
-    }
-
     private void createOcppService(Object serviceBean, String address,
                                    List<Interceptor<? extends Message>> interceptors,
                                    Collection<? extends Feature> features) {

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

@@ -27,20 +27,17 @@ public class SecurityConfiguration extends WebSecurityConfigurerAdapter {
     /**
      * Password encoding changed with spring-security 5.0.0. We either have to use a prefix before the password to
      * indicate which actual encoder {@link DelegatingPasswordEncoder} should use [1, 2] or specify the encoder as we do.
-     * {@link NoOpPasswordEncoder} is deprecated because it is not secure since it is not a one way hash function and
-     * uses plain text matching, but is good enough for our simple user management and login authorization case.
      *
      * [1] https://spring.io/blog/2017/11/01/spring-security-5-0-0-rc1-released#password-storage-format
      * [2] {@link PasswordEncoderFactories#createDelegatingPasswordEncoder()}
      */
     @Autowired
     public void configureGlobal(AuthenticationManagerBuilder auth) throws Exception {
         auth.inMemoryAuthentication()
-                .passwordEncoder(NoOpPasswordEncoder.getInstance())
-                .withUser(CONFIG.getAuth().getUserName())
-                .password(CONFIG.getAuth().getPassword())
-                .roles("ADMIN");
-
+            .passwordEncoder(CONFIG.getAuth().getPasswordEncoder())
+            .withUser(CONFIG.getAuth().getUserName())
+            .password(CONFIG.getAuth().getEncodedPassword())
+            .roles("ADMIN");
     }
 
     @Override

src/main/java/de/rwth/idsg/steve/ocpp/ws/AbstractWebSocketEndpoint.java

@@ -1,16 +1,14 @@
 package de.rwth.idsg.steve.ocpp.ws;
 
+import com.google.common.base.Strings;
 import de.rwth.idsg.steve.config.WebSocketConfiguration;
 import de.rwth.idsg.steve.ocpp.OcppVersion;
-import de.rwth.idsg.steve.ocpp.ws.custom.WsSessionSelectStrategy;
 import de.rwth.idsg.steve.ocpp.ws.data.CommunicationContext;
 import de.rwth.idsg.steve.ocpp.ws.data.SessionContext;
 import de.rwth.idsg.steve.ocpp.ws.pipeline.IncomingPipeline;
 import de.rwth.idsg.steve.repository.OcppServerRepository;
 import de.rwth.idsg.steve.service.NotificationService;
 import org.joda.time.DateTime;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.socket.BinaryMessage;
 import org.springframework.web.socket.CloseStatus;
@@ -34,29 +32,25 @@
  * @since 17.03.2015
  */
 public abstract class AbstractWebSocketEndpoint implements WebSocketHandler {
-    private final Logger log = LoggerFactory.getLogger(getClass());
 
     @Autowired private ScheduledExecutorService service;
     @Autowired private OcppServerRepository ocppServerRepository;
     @Autowired private FutureResponseContextStore futureResponseContextStore;
-    @Autowired private WsSessionSelectStrategy wsSessionSelectStrategy;
     @Autowired private NotificationService notificationService;
 
     public static final String CHARGEBOX_ID_KEY = "CHARGEBOX_ID_KEY";
 
-    private IncomingPipeline pipeline;
-    private SessionContextStoreImpl sessionContextStore;
-
+    private final SessionContextStoreImpl sessionContextStore = new SessionContextStoreImpl();
     private final List<Consumer<String>> connectedCallbackList = new ArrayList<>();
     private final List<Consumer<String>> disconnectedCallbackList = new ArrayList<>();
-
     private final Object sessionContextLock = new Object();
 
+    private IncomingPipeline pipeline;
+
     public abstract OcppVersion getVersion();
 
     public void init(IncomingPipeline pipeline) {
         this.pipeline = pipeline;
-        sessionContextStore = new SessionContextStoreImpl(wsSessionSelectStrategy);
 
         connectedCallbackList.add((chargeBoxId) -> notificationService.ocppStationWebSocketConnected(chargeBoxId));
         disconnectedCallbackList.add((chargeBoxId) -> notificationService.ocppStationWebSocketDisconnected(chargeBoxId));
@@ -82,6 +76,12 @@ private void handleTextMessage(WebSocketSession session, TextMessage webSocketMe
         String incomingString = webSocketMessage.getPayload();
         String chargeBoxId = getChargeBoxId(session);
 
+        // https://github.com/RWTH-i5-IDSG/steve/issues/66
+        if (Strings.isNullOrEmpty(incomingString)) {
+            WebSocketLogger.receivedEmptyText(chargeBoxId, session);
+            return;
+        }
+
         WebSocketLogger.receivedText(chargeBoxId, session, incomingString);
 
         CommunicationContext context = new CommunicationContext(session, chargeBoxId);
@@ -92,8 +92,6 @@ private void handleTextMessage(WebSocketSession session, TextMessage webSocketMe
 
     private void handlePongMessage(WebSocketSession session) {
         WebSocketLogger.receivedPong(getChargeBoxId(session), session);
-
-        // TODO: Not sure about the following. Should update DB? Should call directly repo?
         ocppServerRepository.updateChargeboxHeartbeat(getChargeBoxId(session), DateTime.now());
     }
 
@@ -106,7 +104,7 @@ public void afterConnectionEstablished(WebSocketSession session) throws Exceptio
         // Just to keep the connection alive, such that the servers do not close
         // the connection because of a idle timeout, we ping-pong at fixed intervals.
         ScheduledFuture pingSchedule = service.scheduleAtFixedRate(
-                new PingTask(session),
+                new PingTask(chargeBoxId, session),
                 WebSocketConfiguration.PING_INTERVAL,
                 WebSocketConfiguration.PING_INTERVAL,
                 TimeUnit.MINUTES);
@@ -151,8 +149,7 @@ public void afterConnectionClosed(WebSocketSession session, CloseStatus closeSta
 
     @Override
     public void handleTransportError(WebSocketSession session, Throwable throwable) throws Exception {
-        log.error("Oops", throwable);
-        // TODO: Do something about this
+        WebSocketLogger.transportError(getChargeBoxId(session), session, throwable);
     }
 
     @Override

src/main/java/de/rwth/idsg/steve/ocpp/ws/PingTask.java

@@ -17,17 +17,18 @@
 @Slf4j
 @RequiredArgsConstructor
 public class PingTask implements Runnable {
+    private final String chargeBoxId;
     private final WebSocketSession session;
 
     private static final PingMessage PING_MESSAGE = new PingMessage(ByteBuffer.wrap("ping".getBytes(UTF_8)));
 
     @Override
     public void run() {
-        log.info("[id={}] Sending ping message", session.getId());
+        WebSocketLogger.sendingPing(chargeBoxId, session);
         try {
             session.sendMessage(PING_MESSAGE);
         } catch (IOException e) {
-            log.error("[id={}] Ping failed", session.getId());
+            WebSocketLogger.pingError(chargeBoxId, session, e);
             // TODO: Do something about this
         }
     }

src/main/java/de/rwth/idsg/steve/ocpp/ws/SessionContextStoreImpl.java

@@ -19,6 +19,8 @@
 import java.util.concurrent.ScheduledFuture;
 import java.util.concurrent.locks.Lock;
 
+import static de.rwth.idsg.steve.SteveConfiguration.CONFIG;
+
 /**
  * @author Sevket Goekay <goekay@dbis.rwth-aachen.de>
  * @since 17.03.2015
@@ -34,11 +36,7 @@ public class SessionContextStoreImpl implements SessionContextStore {
 
     private final Striped<Lock> locks = Striped.lock(16);
 
-    private final WsSessionSelectStrategy wsSessionSelectStrategy;
-
-    public SessionContextStoreImpl(WsSessionSelectStrategy wsSessionSelectStrategy) {
-        this.wsSessionSelectStrategy = wsSessionSelectStrategy;
-    }
+    private final WsSessionSelectStrategy wsSessionSelectStrategy = CONFIG.getOcpp().getWsSessionSelectStrategy();
 
     @Override
     public void add(String chargeBoxId, WebSocketSession session, ScheduledFuture pingSchedule) {

src/main/java/de/rwth/idsg/steve/ocpp/ws/WebSocketLogger.java

@@ -9,7 +9,9 @@
  * @since 10.05.2018
  */
 @Slf4j
-public class WebSocketLogger {
+public final class WebSocketLogger {
+
+    private WebSocketLogger() { }
 
     public static void connected(String chargeBoxId, WebSocketSession session) {
         log.info("[chargeBoxId={}, sessionId={}] Connection is established", chargeBoxId, session.getId());
@@ -19,6 +21,14 @@ public static void closed(String chargeBoxId, WebSocketSession session, CloseSta
         log.warn("[chargeBoxId={}, sessionId={}] Connection is closed, status: {}", chargeBoxId, session.getId(), closeStatus);
     }
 
+    public static void sending(String chargeBoxId, WebSocketSession session, String msg) {
+        log.info("[chargeBoxId={}, sessionId={}] Sending: {}", chargeBoxId, session.getId(), msg);
+    }
+
+    public static void sendingPing(String chargeBoxId, WebSocketSession session) {
+        log.debug("[chargeBoxId={}, sessionId={}] Sending ping message", chargeBoxId, session.getId());
+    }
+
     public static void receivedPong(String chargeBoxId, WebSocketSession session) {
         log.debug("[chargeBoxId={}, sessionId={}] Received pong message", chargeBoxId, session.getId());
     }
@@ -27,7 +37,19 @@ public static void receivedText(String chargeBoxId, WebSocketSession session, St
         log.info("[chargeBoxId={}, sessionId={}] Received: {}", chargeBoxId, session.getId(), msg);
     }
 
-    public static void sending(String chargeBoxId, WebSocketSession session, String msg) {
-        log.info("[chargeBoxId={}, sessionId={}] Sending: {}", chargeBoxId, session.getId(), msg);
+    public static void receivedEmptyText(String chargeBoxId, WebSocketSession session) {
+        log.warn("[chargeBoxId={}, sessionId={}] Received empty text message. Will pretend this never happened.", chargeBoxId, session.getId());
+    }
+
+    public static void pingError(String chargeBoxId, WebSocketSession session, Throwable t) {
+        if (log.isErrorEnabled()) {
+            log.error("[chargeBoxId=" + chargeBoxId + ", sessionId=" + session.getId() + "] Ping error", t);
+        }
+    }
+
+    public static void transportError(String chargeBoxId, WebSocketSession session, Throwable t) {
+        if (log.isErrorEnabled()) {
+            log.error("[chargeBoxId=" + chargeBoxId + ", sessionId=" + session.getId() + "] Transport error", t);
+        }
     }
 }