From 3660dec8598d045d08b58672302e1a3304b6a7ce Mon Sep 17 00:00:00 2001 From: kske Date: Sat, 20 Jun 2020 09:57:54 +0200 Subject: [PATCH 1/4] Shorten event names, refactor, prepare compatibility verification --- pom.xml | 2 +- src/main/java/envoy/server/Startup.java | 14 ++ src/main/java/envoy/server/data/Contact.java | 14 +- src/main/java/envoy/server/data/Message.java | 29 +-- .../envoy/server/data/PersistenceManager.java | 4 +- src/main/java/envoy/server/data/User.java | 15 +- .../envoy/server/net/ConnectionManager.java | 3 +- .../processors/ContactOperationProcessor.java | 10 +- .../processors/GroupCreationProcessor.java | 16 +- .../processors/GroupResizeProcessor.java | 16 +- .../IDGeneratorRequestProcessor.java | 8 +- .../processors/LoginCredentialProcessor.java | 190 ++++++++---------- .../server/processors/MessageProcessor.java | 4 +- .../MessageStatusChangeProcessor.java | 18 +- .../processors/NameChangeProcessor.java | 18 +- .../processors/UserStatusChangeProcessor.java | 20 +- 16 files changed, 179 insertions(+), 202 deletions(-) diff --git a/pom.xml b/pom.xml index 046ec55..0612482 100755 --- a/pom.xml +++ b/pom.xml @@ -28,7 +28,7 @@ com.github.informatik-ag-ngl envoy-common - develop-SNAPSHOT + f~compatibility_verification-SNAPSHOT com.github.informatik-ag-ngl diff --git a/src/main/java/envoy/server/Startup.java b/src/main/java/envoy/server/Startup.java index 9ad4bc3..b88f1bd 100755 --- a/src/main/java/envoy/server/Startup.java +++ b/src/main/java/envoy/server/Startup.java @@ -29,6 +29,20 @@ import envoy.util.EnvoyLog; */ public class Startup { + /** + * The minimal client version compatible with this server. + * + * @since Envoy Server Standalone v0.1-beta + */ + public static final String MIN_CLIENT_VERSION = "0.1-beta"; + + /** + * The maximal client version compatible with this server. + * + * @since Envoy Server Standalone v0.1-beta + */ + public static final String MAX_CLIENT_VERSION = "0.1-beta"; + /** * Initializes the logger with a new config instance. * diff --git a/src/main/java/envoy/server/data/Contact.java b/src/main/java/envoy/server/data/Contact.java index 7ad1d6b..c802837 100644 --- a/src/main/java/envoy/server/data/Contact.java +++ b/src/main/java/envoy/server/data/Contact.java @@ -1,6 +1,6 @@ package envoy.server.data; -import java.util.Date; +import java.time.LocalDateTime; import java.util.Set; import javax.persistence.*; @@ -28,8 +28,7 @@ public abstract class Contact { protected String name; @Column(name = "creation_date") - @Temporal(TemporalType.TIMESTAMP) - private Date creationDate; + private LocalDateTime creationDate; @ManyToMany(fetch = FetchType.EAGER) protected Set contacts; @@ -95,17 +94,14 @@ public abstract class Contact { * @return the creationDate * @since Envoy Server Standalone v0.1-beta */ - public Date getCreationDate() { return creationDate; } + public LocalDateTime getCreationDate() { return creationDate; } /** * @param creationDate the creationDate to set * @since Envoy Server Standalone v0.1-beta */ - public void setCreationDate(Date creationDate) { this.creationDate = creationDate; } + public void setCreationDate(LocalDateTime creationDate) { this.creationDate = creationDate; } - /** - * {@inheritDoc} - */ @Override - public String toString() { return String.format("%s[id=%d,name=%s, contacts=%s]", getClass().getSimpleName(), id, name, contacts); } + public String toString() { return String.format("%s[id=%d,name=%s, %d contact(s)]", getClass().getSimpleName(), id, name, contacts.size()); } } diff --git a/src/main/java/envoy/server/data/Message.java b/src/main/java/envoy/server/data/Message.java index 8a0a0ca..e53a7e5 100755 --- a/src/main/java/envoy/server/data/Message.java +++ b/src/main/java/envoy/server/data/Message.java @@ -1,9 +1,10 @@ package envoy.server.data; -import java.util.Date; +import java.time.LocalDateTime; import javax.persistence.*; +import envoy.data.Message.MessageStatus; import envoy.data.MessageBuilder; /** @@ -50,16 +51,13 @@ public class Message { protected Contact recipient; @Column(name = "creation_date") - @Temporal(TemporalType.TIMESTAMP) - protected Date creationDate; + protected LocalDateTime creationDate; @Column(name = "received_date") - @Temporal(TemporalType.TIMESTAMP) - protected Date receivedDate; + protected LocalDateTime receivedDate; @Column(name = "read_date") - @Temporal(TemporalType.TIMESTAMP) - protected Date readDate; + protected LocalDateTime readDate; protected String text; protected envoy.data.Message.MessageStatus status; @@ -113,6 +111,11 @@ public class Message { return message; } + public void received() { + receivedDate = LocalDateTime.now(); + status = MessageStatus.RECEIVED; + } + /** * @return the id of a {link envoy.data.Message} * @since Envoy Server Standalone v0.1-alpha @@ -156,41 +159,41 @@ public class Message { * @return the date at which a {link envoy.data.Message} has been created * @since Envoy Server Standalone v0.1-alpha */ - public Date getCreationDate() { return creationDate; } + public LocalDateTime getCreationDate() { return creationDate; } /** * @param creationDate the creation date to set * @since Envoy Server Standalone v0.1-alpha * @see Message#getCreationDate() */ - public void setCreationDate(Date creationDate) { this.creationDate = creationDate; } + public void setCreationDate(LocalDateTime creationDate) { this.creationDate = creationDate; } /** * @return the date at which a {link envoy.data.Message} has been received by * the server * @since Envoy Server Standalone v0.1-alpha */ - public Date getReceivedDate() { return receivedDate; } + public LocalDateTime getReceivedDate() { return receivedDate; } /** * @param receivedDate the received date to set * @since Envoy Server Standalone v0.1-alpha * @see Message#getReceivedDate() */ - public void setReceivedDate(Date receivedDate) { this.receivedDate = receivedDate; } + public void setReceivedDate(LocalDateTime receivedDate) { this.receivedDate = receivedDate; } /** * @return the date at which a {link envoy.data.Message} has been read * @since Envoy Server Standalone v0.1-alpha */ - public Date getReadDate() { return readDate; } + public LocalDateTime getReadDate() { return readDate; } /** * @param readDate the read date to set * @since Envoy Server Standalone v0.1-alpha * @see Message#getReadDate() */ - public void setReadDate(Date readDate) { this.readDate = readDate; } + public void setReadDate(LocalDateTime readDate) { this.readDate = readDate; } /** * @return the status of a {link envoy.data.Message} diff --git a/src/main/java/envoy/server/data/PersistenceManager.java b/src/main/java/envoy/server/data/PersistenceManager.java index 0221fe9..1e99978 100755 --- a/src/main/java/envoy/server/data/PersistenceManager.java +++ b/src/main/java/envoy/server/data/PersistenceManager.java @@ -1,6 +1,6 @@ package envoy.server.data; -import java.util.Date; +import java.time.LocalDateTime; import java.util.List; import javax.persistence.EntityManager; @@ -38,7 +38,7 @@ public class PersistenceManager { .getOnlineUsers() .stream() .map(this::getUserByID) - .forEach(user -> { user.setStatus(UserStatus.OFFLINE); user.setLastSeen(new Date()); entityManager.merge(user); }); + .forEach(user -> { user.setStatus(UserStatus.OFFLINE); user.setLastSeen(LocalDateTime.now()); entityManager.merge(user); }); transaction.commit(); })); } diff --git a/src/main/java/envoy/server/data/User.java b/src/main/java/envoy/server/data/User.java index 99941f4..9a1b03f 100755 --- a/src/main/java/envoy/server/data/User.java +++ b/src/main/java/envoy/server/data/User.java @@ -1,6 +1,6 @@ package envoy.server.data; -import java.util.Date; +import java.time.LocalDateTime; import java.util.Set; import java.util.stream.Collectors; @@ -66,22 +66,15 @@ public class User extends Contact { private byte[] passwordHash; @Column(name = "last_seen") - @Temporal(TemporalType.TIMESTAMP) - private Date lastSeen; + private LocalDateTime lastSeen; private UserStatus status; - /** - * {@inheritDoc} - */ @Override public envoy.data.User toCommon() { return new envoy.data.User(id, name, status, contacts.parallelStream().map(Contact::toFlatCommon).collect(Collectors.toSet())); } - /** - * {@inheritDoc} - */ @Override protected envoy.data.User toFlatCommon() { return new envoy.data.User(id, name, status, Set.of()); } @@ -101,13 +94,13 @@ public class User extends Contact { * @return the last date the user has been online * @since Envoy Server Standalone v0.1-alpha */ - public Date getLastSeen() { return lastSeen; } + public LocalDateTime getLastSeen() { return lastSeen; } /** * @param lastSeen the latest date at which the user has been online to set * @since Envoy Server Standalone v0.1-alpha */ - public void setLastSeen(Date lastSeen) { this.lastSeen = lastSeen; } + public void setLastSeen(LocalDateTime lastSeen) { this.lastSeen = lastSeen; } /** * @return the status diff --git a/src/main/java/envoy/server/net/ConnectionManager.java b/src/main/java/envoy/server/net/ConnectionManager.java index 6d9beea..cb2d818 100755 --- a/src/main/java/envoy/server/net/ConnectionManager.java +++ b/src/main/java/envoy/server/net/ConnectionManager.java @@ -1,5 +1,6 @@ package envoy.server.net; +import java.time.LocalDateTime; import java.util.*; import java.util.stream.Collectors; @@ -51,7 +52,7 @@ public class ConnectionManager implements ISocketIdListener { // Notify contacts of this users offline-going envoy.server.data.User user = PersistenceManager.getInstance().getUserByID(getUserIdBySocketID(socketID)); user.setStatus(UserStatus.OFFLINE); - user.setLastSeen(new Date()); + user.setLastSeen(LocalDateTime.now()); UserStatusChangeProcessor.updateUserStatus(user); // Remove the socket diff --git a/src/main/java/envoy/server/processors/ContactOperationProcessor.java b/src/main/java/envoy/server/processors/ContactOperationProcessor.java index 9e181ae..febd409 100755 --- a/src/main/java/envoy/server/processors/ContactOperationProcessor.java +++ b/src/main/java/envoy/server/processors/ContactOperationProcessor.java @@ -4,7 +4,7 @@ import java.io.IOException; import java.util.logging.Logger; import envoy.event.ElementOperation; -import envoy.event.contact.ContactOperationEvent; +import envoy.event.contact.ContactOperation; import envoy.server.data.PersistenceManager; import envoy.server.net.ConnectionManager; import envoy.server.net.ObjectWriteProxy; @@ -18,13 +18,13 @@ import envoy.util.EnvoyLog; * @author Kai S. K. Engelbart * @since Envoy Server Standalone v0.1-alpha */ -public class ContactOperationProcessor implements ObjectProcessor { +public class ContactOperationProcessor implements ObjectProcessor { private static final ConnectionManager connectionManager = ConnectionManager.getInstance(); private static final Logger logger = EnvoyLog.getLogger(ContactOperationProcessor.class); @Override - public void process(ContactOperationEvent evt, long socketId, ObjectWriteProxy writeProxy) throws IOException { + public void process(ContactOperation evt, long socketId, ObjectWriteProxy writeProxy) throws IOException { switch (evt.getOperationType()) { case ADD: final long userID = ConnectionManager.getInstance().getUserIdBySocketID(socketId); @@ -36,7 +36,7 @@ public class ContactOperationProcessor implements ObjectProcessor getInputClass() { return ContactOperationEvent.class; } + public Class getInputClass() { return ContactOperation.class; } } diff --git a/src/main/java/envoy/server/processors/GroupCreationProcessor.java b/src/main/java/envoy/server/processors/GroupCreationProcessor.java index 9ea11fe..bf82ec4 100644 --- a/src/main/java/envoy/server/processors/GroupCreationProcessor.java +++ b/src/main/java/envoy/server/processors/GroupCreationProcessor.java @@ -4,8 +4,8 @@ import java.io.IOException; import java.util.HashSet; import envoy.event.ElementOperation; -import envoy.event.GroupCreationEvent; -import envoy.event.contact.ContactOperationEvent; +import envoy.event.GroupCreation; +import envoy.event.contact.ContactOperation; import envoy.server.data.Contact; import envoy.server.data.PersistenceManager; import envoy.server.net.ConnectionManager; @@ -19,17 +19,17 @@ import envoy.server.net.ObjectWriteProxy; * @author Maximilian Käfer * @since Envoy Server Standalone v0.1-beta */ -public class GroupCreationProcessor implements ObjectProcessor { +public class GroupCreationProcessor implements ObjectProcessor { private final PersistenceManager persistenceManager = PersistenceManager.getInstance(); private final ConnectionManager connectionManager = ConnectionManager.getInstance(); @Override - public void process(GroupCreationEvent input, long socketID, ObjectWriteProxy writeProxy) throws IOException { + public void process(GroupCreation groupCreation, long socketID, ObjectWriteProxy writeProxy) throws IOException { envoy.server.data.Group group = new envoy.server.data.Group(); - group.setName(input.get()); + group.setName(groupCreation.get()); group.setContacts(new HashSet<>()); - input.getInitialMemberIDs().stream().map(persistenceManager::getUserByID).forEach(group.getContacts()::add); + groupCreation.getInitialMemberIDs().stream().map(persistenceManager::getUserByID).forEach(group.getContacts()::add); group.getContacts().add(persistenceManager.getContactByID(connectionManager.getUserIdBySocketID(socketID))); group.getContacts().forEach(c -> c.getContacts().add(group)); group.getContacts().add(persistenceManager.getUserByID(connectionManager.getUserIdBySocketID(socketID))); @@ -41,7 +41,7 @@ public class GroupCreationProcessor implements ObjectProcessor { try { - writeProxy.write(memberSocketID, new ContactOperationEvent(group.toCommon(), ElementOperation.ADD)); + writeProxy.write(memberSocketID, new ContactOperation(group.toCommon(), ElementOperation.ADD)); } catch (IOException e) { e.printStackTrace(); } @@ -49,5 +49,5 @@ public class GroupCreationProcessor implements ObjectProcessor getInputClass() { return GroupCreationEvent.class; } + public Class getInputClass() { return GroupCreation.class; } } diff --git a/src/main/java/envoy/server/processors/GroupResizeProcessor.java b/src/main/java/envoy/server/processors/GroupResizeProcessor.java index 79c2be6..e90b56f 100644 --- a/src/main/java/envoy/server/processors/GroupResizeProcessor.java +++ b/src/main/java/envoy/server/processors/GroupResizeProcessor.java @@ -2,7 +2,7 @@ package envoy.server.processors; import java.io.IOException; -import envoy.event.GroupResizeEvent; +import envoy.event.GroupResize; import envoy.server.data.Contact; import envoy.server.data.PersistenceManager; import envoy.server.net.ConnectionManager; @@ -16,24 +16,24 @@ import envoy.server.net.ObjectWriteProxy; * @author Maximilian Käfer * @since Envoy Server Standalone v0.1-beta */ -public class GroupResizeProcessor implements ObjectProcessor { +public class GroupResizeProcessor implements ObjectProcessor { private static final PersistenceManager persistenceManager = PersistenceManager.getInstance(); private static final ConnectionManager connectionManager = ConnectionManager.getInstance(); @Override - public void process(GroupResizeEvent input, long socketID, ObjectWriteProxy writeProxy) throws IOException { + public void process(GroupResize groupResize, long socketID, ObjectWriteProxy writeProxy) throws IOException { // Acquire the group to resize from the database - var group = persistenceManager.getGroupByID(input.getGroupID()); + var group = persistenceManager.getGroupByID(groupResize.getGroupID()); // Perform the desired operation - switch (input.getOperation()) { + switch (groupResize.getOperation()) { case ADD: - group.getContacts().add(persistenceManager.getUserByID(input.get().getID())); + group.getContacts().add(persistenceManager.getUserByID(groupResize.get().getID())); break; case REMOVE: - group.getContacts().remove(persistenceManager.getUserByID(input.get().getID())); + group.getContacts().remove(persistenceManager.getUserByID(groupResize.get().getID())); break; } @@ -57,5 +57,5 @@ public class GroupResizeProcessor implements ObjectProcessor { } @Override - public Class getInputClass() { return GroupResizeEvent.class; } + public Class getInputClass() { return GroupResize.class; } } diff --git a/src/main/java/envoy/server/processors/IDGeneratorRequestProcessor.java b/src/main/java/envoy/server/processors/IDGeneratorRequestProcessor.java index e30f18d..c2f423a 100755 --- a/src/main/java/envoy/server/processors/IDGeneratorRequestProcessor.java +++ b/src/main/java/envoy/server/processors/IDGeneratorRequestProcessor.java @@ -1,14 +1,12 @@ package envoy.server.processors; import java.io.IOException; -import java.util.logging.Logger; import envoy.data.IDGenerator; import envoy.event.IDGeneratorRequest; import envoy.server.data.ConfigItem; import envoy.server.data.PersistenceManager; import envoy.server.net.ObjectWriteProxy; -import envoy.util.EnvoyLog; /** * Project: envoy-server-standalone
@@ -22,17 +20,13 @@ import envoy.util.EnvoyLog; public class IDGeneratorRequestProcessor implements ObjectProcessor { private static final long ID_RANGE = 200; - private static final Logger logger = EnvoyLog.getLogger(IDGeneratorRequestProcessor.class); @Override public Class getInputClass() { return IDGeneratorRequest.class; } @Override public void process(IDGeneratorRequest input, long socketID, ObjectWriteProxy writeProxy) throws IOException { - logger.fine("Received id generation request."); - var generator = createIDGenerator(); - logger.info("Sending new id generator " + generator); - writeProxy.write(socketID, generator); + writeProxy.write(socketID, createIDGenerator()); } /** diff --git a/src/main/java/envoy/server/processors/LoginCredentialProcessor.java b/src/main/java/envoy/server/processors/LoginCredentialProcessor.java index 7e33f2b..f837656 100755 --- a/src/main/java/envoy/server/processors/LoginCredentialProcessor.java +++ b/src/main/java/envoy/server/processors/LoginCredentialProcessor.java @@ -1,19 +1,23 @@ package envoy.server.processors; +import static envoy.data.User.UserStatus.ONLINE; +import static envoy.event.HandshakeRejection.*; + import java.io.IOException; -import java.util.*; +import java.time.LocalDateTime; +import java.util.Arrays; +import java.util.HashSet; import java.util.logging.Logger; import javax.persistence.NoResultException; import envoy.data.LoginCredentials; import envoy.data.Message.MessageStatus; -import envoy.data.User; -import envoy.data.User.UserStatus; -import envoy.event.HandshakeRejectionEvent; -import envoy.event.MessageStatusChangeEvent; -import envoy.server.data.Message; +import envoy.event.HandshakeRejection; +import envoy.event.MessageStatusChange; +import envoy.server.Startup; import envoy.server.data.PersistenceManager; +import envoy.server.data.User; import envoy.server.net.ConnectionManager; import envoy.server.net.ObjectWriteProxy; import envoy.util.EnvoyLog; @@ -29,126 +33,98 @@ import envoy.util.EnvoyLog; * @author Maximilian Käfer * @since Envoy Server Standalone v0.1-alpha */ -public class LoginCredentialProcessor implements ObjectProcessor { +public final class LoginCredentialProcessor implements ObjectProcessor { private final PersistenceManager persistenceManager = PersistenceManager.getInstance(); private final ConnectionManager connectionManager = ConnectionManager.getInstance(); private static final Logger logger = EnvoyLog.getLogger(LoginCredentialProcessor.class); + // private static final Pattern versionPattern = + // Pattern.compile("v(?\\d).(?\\d)(?:-(?\\w+))?"); @Override - public void process(LoginCredentials input, long socketID, ObjectWriteProxy writeProxy) throws IOException { + public void process(LoginCredentials credentials, long socketID, ObjectWriteProxy writeProxy) throws IOException { + + // Cache this write proxy for user-independant notifications UserStatusChangeProcessor.setWriteProxy(writeProxy); - logger.info(String.format("Received login credentials %s from socket ID %d", input, socketID)); - envoy.server.data.User user = getUser(input, socketID, writeProxy); - - // Not logged in successfully - if (user == null) { - logger.info("Rejecting handshake on socket " + socketID); - return; + // TODO: Verify compatibility + if (Startup.MIN_CLIENT_VERSION.compareTo(credentials.getClientVersion()) <= 0 + && Startup.MAX_CLIENT_VERSION.compareTo(credentials.getClientVersion()) >= 0) { + // writeProxy.write(socketID, new HandshakeRejectionEvent("Wrong version")); + // return; } + + // Acquire a user object (or reject the handshake if that's impossible) + User user = null; + if (!credentials.isRegistration()) { + try { + user = persistenceManager.getUserByName(credentials.getIdentifier()); + + // Checking if user is already online + if (connectionManager.isOnline(user.getID())) { + logger.warning(user + " is already online!"); + writeProxy.write(socketID, new HandshakeRejection(INTERNAL_ERROR)); + return; + } + // Evaluating the correctness of the password hash + if (!Arrays.equals(credentials.getPasswordHash(), user.getPasswordHash())) { + logger.info(user + " has entered the wrong password."); + writeProxy.write(socketID, new HandshakeRejection(WRONG_PASSWORD_OR_USER)); + return; + } + } catch (NoResultException e) { + logger.info("The requested user does not exist."); + writeProxy.write(socketID, new HandshakeRejection(WRONG_PASSWORD_OR_USER)); + return; + } + } else { + try { + // Checking that no user already has this identifier + PersistenceManager.getInstance().getUserByName(credentials.getIdentifier()); + + // This code only gets executed if this user already exists + logger.info("The requested user already exists."); + writeProxy.write(socketID, new HandshakeRejection(INTERNAL_ERROR)); + return; + } catch (NoResultException e) { + // Creation of a new user + user = new User(); + user.setName(credentials.getIdentifier()); + user.setLastSeen(LocalDateTime.now()); + user.setStatus(ONLINE); + user.setPasswordHash(credentials.getPasswordHash()); + user.setContacts(new HashSet<>()); + persistenceManager.addContact(user); + logger.info("Registered new " + user); + } + } + + logger.info(user + " successfully authenticated."); + connectionManager.registerUser(user.getID(), socketID); - // Notifies contacts of this users online-going and updates his status in the - // database - user.setStatus(UserStatus.ONLINE); + // Change status and notify contacts about it + user.setStatus(ONLINE); UserStatusChangeProcessor.updateUserStatus(user); - // Complete handshake - logger.fine("Sending user..."); + // Complete the handshake writeProxy.write(socketID, user.toCommon()); - logger.fine("Acquiring pending messages for the client..."); - List pendingMessages = PersistenceManager.getInstance().getPendingMessages(user); - for (Message msg : pendingMessages) + + final var pendingMessages = PersistenceManager.getInstance().getPendingMessages(user); + logger.fine("Sending " + pendingMessages.size() + " pending messages to " + user + "..."); + for (var msg : pendingMessages) { + final var msgCommon = msg.toCommon(); if (msg.getStatus() == MessageStatus.SENT) { - logger.info("Sending message " + msg.toCommon()); - writeProxy.write(socketID, msg.toCommon()); - msg.setReceivedDate(new Date()); - msg.setStatus(MessageStatus.RECEIVED); - if (connectionManager.isOnline(msg.getSender().getID())) { - var evt = new MessageStatusChangeEvent(msg.toCommon()); - logger.info("Sending messageStatusChangeEvent to sender " + evt); - writeProxy.write(connectionManager.getSocketID(msg.getSender().getID()), evt); - } + writeProxy.write(socketID, msgCommon); + msg.received(); + if (connectionManager.isOnline(msg.getSender().getID())) + writeProxy.write(connectionManager.getSocketID(msg.getSender().getID()), new MessageStatusChange(msgCommon)); PersistenceManager.getInstance().updateMessage(msg); - } else { - var evt = new MessageStatusChangeEvent(msg.toCommon()); - logger.info("Sending messageStatusChangeEvent " + evt); - writeProxy.write(socketID, evt); - } + } else writeProxy.write(socketID, new MessageStatusChange(msgCommon)); + } } @Override public Class getInputClass() { return LoginCredentials.class; } - - private envoy.server.data.User getUser(LoginCredentials credentials, long socketID, ObjectWriteProxy writeProxy) throws IOException { - return credentials.isRegistration() ? newUser(credentials, socketID, writeProxy) : checkForExistingUser(credentials, socketID, writeProxy); - } - - /** - * @param credentials the input to evaluate - * @param socketID the socket ID at which the client performing the handshake - * is connected - * @param writeProxy the {@link ObjectWriteProxy} to use if login was not - * successful - * @return the database user matching the login credentials - * @throws IOException if sending the failed login back to the client failed - * @since Envoy Server Standalone v0.1-alpha - */ - private envoy.server.data.User checkForExistingUser(LoginCredentials credentials, long socketID, ObjectWriteProxy writeProxy) throws IOException { - try { - envoy.server.data.User user = persistenceManager.getUserByName(credentials.getIdentifier()); - - // Checking if user is already online - if (connectionManager.isOnline(user.getID())) { - writeProxy.write(socketID, new HandshakeRejectionEvent(HandshakeRejectionEvent.INTERNAL_ERROR)); - return null; - } - // Evaluating the correctness of the password hash - if (!Arrays.equals(credentials.getPasswordHash(), user.getPasswordHash())) { - writeProxy.write(socketID, new HandshakeRejectionEvent(HandshakeRejectionEvent.WRONG_PASSWORD_OR_USER)); - return null; - } - return user; - } catch (NoResultException e) { - // Checking if user exists - writeProxy.write(socketID, new HandshakeRejectionEvent(HandshakeRejectionEvent.INTERNAL_ERROR)); - } catch (InputMismatchException e) { - // Checking if the given password hash is correct - writeProxy.write(socketID, new HandshakeRejectionEvent(HandshakeRejectionEvent.WRONG_PASSWORD_OR_USER)); - } - return null; - } - - /** - * @param credentials the credentials upon which to create the new {@link User} - * @param socketID the socketID at which the client performing the handshake - * is connected - * @param writeProxy the write proxy used to notify the client about handshake - * rejection - * @return the newly created {@link User} - * @throws IOException if sending the failed login back to the client failed - * @since Envoy Server Standalone v0.1-alpha - */ - private envoy.server.data.User newUser(LoginCredentials credentials, long socketID, ObjectWriteProxy writeProxy) throws IOException { - try { - // Checking that no user already has this identifier - PersistenceManager.getInstance().getUserByName(credentials.getIdentifier()); - // this code only gets executed if this user already exists - writeProxy.write(socketID, new HandshakeRejectionEvent(HandshakeRejectionEvent.INTERNAL_ERROR)); - return null; - } catch (NoResultException e) { - // Creation of a new user - envoy.server.data.User user; - user = new envoy.server.data.User(); - user.setName(credentials.getIdentifier()); - user.setLastSeen(new Date()); - user.setStatus(User.UserStatus.ONLINE); - user.setPasswordHash(credentials.getPasswordHash()); - user.setContacts(new HashSet<>()); - persistenceManager.addContact(user); - return user; - } - } } diff --git a/src/main/java/envoy/server/processors/MessageProcessor.java b/src/main/java/envoy/server/processors/MessageProcessor.java index 42c111a..8622cd8 100755 --- a/src/main/java/envoy/server/processors/MessageProcessor.java +++ b/src/main/java/envoy/server/processors/MessageProcessor.java @@ -1,7 +1,7 @@ package envoy.server.processors; import java.io.IOException; -import java.util.Date; +import java.time.LocalDateTime; import java.util.logging.Logger; import javax.persistence.EntityExistsException; @@ -50,7 +50,7 @@ public class MessageProcessor implements ObjectProcessor { // If recipient is online, send the message directly writeProxy.write(connectionManager.getSocketID(message.getRecipientID()), message); // Update the message status to RECEIVED - message.setReceivedDate(new Date()); + message.setReceivedDate(LocalDateTime.now()); message.nextStatus(); } catch (IOException e) { logger.warning("Recipient online. Failed to send message" + message.getID()); diff --git a/src/main/java/envoy/server/processors/MessageStatusChangeProcessor.java b/src/main/java/envoy/server/processors/MessageStatusChangeProcessor.java index 2ca7c46..a3dca3c 100755 --- a/src/main/java/envoy/server/processors/MessageStatusChangeProcessor.java +++ b/src/main/java/envoy/server/processors/MessageStatusChangeProcessor.java @@ -3,7 +3,7 @@ package envoy.server.processors; import java.io.IOException; import envoy.data.Message.MessageStatus; -import envoy.event.MessageStatusChangeEvent; +import envoy.event.MessageStatusChange; import envoy.exception.EnvoyException; import envoy.server.data.PersistenceManager; import envoy.server.net.ConnectionManager; @@ -17,26 +17,26 @@ import envoy.server.net.ObjectWriteProxy; * @author Leon Hofmeister * @since Envoy Server Standalone v0.1-alpha */ -public class MessageStatusChangeProcessor implements ObjectProcessor { +public class MessageStatusChangeProcessor implements ObjectProcessor { private final PersistenceManager persistenceManager = PersistenceManager.getInstance(); private final ConnectionManager connectionManager = ConnectionManager.getInstance(); @Override - public void process(MessageStatusChangeEvent input, long socketID, ObjectWriteProxy writeProxy) throws IOException { + public void process(MessageStatusChange statusChange, long socketID, ObjectWriteProxy writeProxy) throws IOException { // Any other status than READ is not supposed to be sent to the server - if (input.get() != MessageStatus.READ) throw new IOException(new EnvoyException("Message " + input + " has an invalid status")); + if (statusChange.get() != MessageStatus.READ) throw new IOException(new EnvoyException(statusChange + " has an invalid status")); - envoy.server.data.Message msg = persistenceManager.getMessageByID(input.getID()); - msg.setStatus(input.get()); - msg.setReadDate(input.getDate()); + final var msg = persistenceManager.getMessageByID(statusChange.getID()); + msg.setStatus(statusChange.get()); + msg.setReadDate(statusChange.getDate()); persistenceManager.updateMessage(msg); // Notifies the sender of the message about the status-update to READ final long senderID = msg.getSender().getID(); - if (connectionManager.isOnline(senderID)) writeProxy.write(connectionManager.getSocketID(senderID), input); + if (connectionManager.isOnline(senderID)) writeProxy.write(connectionManager.getSocketID(senderID), statusChange); } @Override - public Class getInputClass() { return MessageStatusChangeEvent.class; } + public Class getInputClass() { return MessageStatusChange.class; } } diff --git a/src/main/java/envoy/server/processors/NameChangeProcessor.java b/src/main/java/envoy/server/processors/NameChangeProcessor.java index 991e7fb..4400c04 100644 --- a/src/main/java/envoy/server/processors/NameChangeProcessor.java +++ b/src/main/java/envoy/server/processors/NameChangeProcessor.java @@ -2,7 +2,7 @@ package envoy.server.processors; import java.io.IOException; -import envoy.event.NameChangeEvent; +import envoy.event.NameChange; import envoy.server.data.Contact; import envoy.server.data.PersistenceManager; import envoy.server.data.User; @@ -17,20 +17,20 @@ import envoy.server.net.ObjectWriteProxy; * @author Leon Hofmeister * @since Envoy Server Standalone v0.1-beta */ -public class NameChangeProcessor implements ObjectProcessor { +public class NameChangeProcessor implements ObjectProcessor { @Override - public void process(NameChangeEvent input, long socketID, ObjectWriteProxy writeProxy) throws IOException { + public void process(NameChange nameChange, long socketID, ObjectWriteProxy writeProxy) throws IOException { PersistenceManager persistenceManager = PersistenceManager.getInstance(); ConnectionManager connectionManager = ConnectionManager.getInstance(); - Contact toUpdate = persistenceManager.getContactByID(input.getID()); - toUpdate.setName(input.get()); + Contact toUpdate = persistenceManager.getContactByID(nameChange.getID()); + toUpdate.setName(nameChange.get()); persistenceManager.updateContact(toUpdate); - // notifying online contacts of this client of his name change - toUpdate.getContacts().stream().filter(contact -> (contact instanceof User && connectionManager.isOnline(contact.getID()))).forEach(user -> { + // Notify online contacts of the name change + toUpdate.getContacts().stream().filter(User.class::isInstance).map(Contact::getID).filter(connectionManager::isOnline).forEach(userID -> { try { - writeProxy.write(user.getID(), input); + writeProxy.write(userID, nameChange); } catch (IOException e) { e.printStackTrace(); } @@ -38,5 +38,5 @@ public class NameChangeProcessor implements ObjectProcessor { } @Override - public Class getInputClass() { return NameChangeEvent.class; } + public Class getInputClass() { return NameChange.class; } } diff --git a/src/main/java/envoy/server/processors/UserStatusChangeProcessor.java b/src/main/java/envoy/server/processors/UserStatusChangeProcessor.java index f4d56a7..f090f42 100755 --- a/src/main/java/envoy/server/processors/UserStatusChangeProcessor.java +++ b/src/main/java/envoy/server/processors/UserStatusChangeProcessor.java @@ -4,7 +4,7 @@ import java.io.IOException; import java.util.logging.Logger; import envoy.data.User.UserStatus; -import envoy.event.UserStatusChangeEvent; +import envoy.event.UserStatusChange; import envoy.server.data.PersistenceManager; import envoy.server.data.User; import envoy.server.net.ConnectionManager; @@ -12,7 +12,7 @@ import envoy.server.net.ObjectWriteProxy; import envoy.util.EnvoyLog; /** - * This processor handles incoming {@link UserStatusChangeEvent}.
+ * This processor handles incoming {@link UserStatusChange}.
*
* Project: envoy-server-standalone
* File: UserStatusChangeProcessor.java
@@ -21,7 +21,7 @@ import envoy.util.EnvoyLog; * @author Leon Hofmeister * @since Envoy Server Standalone v0.1-alpha */ -public class UserStatusChangeProcessor implements ObjectProcessor { +public class UserStatusChangeProcessor implements ObjectProcessor { private static ObjectWriteProxy writeProxy; private static PersistenceManager persistenceManager = PersistenceManager.getInstance(); @@ -29,13 +29,13 @@ public class UserStatusChangeProcessor implements ObjectProcessor getInputClass() { return UserStatusChangeEvent.class; } + public Class getInputClass() { return UserStatusChange.class; } @Override - public void process(UserStatusChangeEvent input, long socketID, ObjectWriteProxy writeProxy) throws IOException { + public void process(UserStatusChange input, long socketID, ObjectWriteProxy writeProxy) throws IOException { // new status should not equal old status if (input.get().equals(persistenceManager.getUserByID(input.getID()).getStatus())) { - logger.warning("Received an unnecessary UserStatusChangeEvent"); + logger.warning("Received an unnecessary UserStatusChange"); return; } updateUserStatus(input); @@ -45,7 +45,7 @@ public class UserStatusChangeProcessor implements ObjectProcessor Date: Sat, 20 Jun 2020 14:38:06 +0200 Subject: [PATCH 2/4] Add simple version comparison algorithm --- .../processors/LoginCredentialProcessor.java | 65 +++++++++++++++++-- 1 file changed, 58 insertions(+), 7 deletions(-) diff --git a/src/main/java/envoy/server/processors/LoginCredentialProcessor.java b/src/main/java/envoy/server/processors/LoginCredentialProcessor.java index f837656..5ab8cc6 100755 --- a/src/main/java/envoy/server/processors/LoginCredentialProcessor.java +++ b/src/main/java/envoy/server/processors/LoginCredentialProcessor.java @@ -8,6 +8,7 @@ import java.time.LocalDateTime; import java.util.Arrays; import java.util.HashSet; import java.util.logging.Logger; +import java.util.regex.Pattern; import javax.persistence.NoResultException; @@ -38,9 +39,8 @@ public final class LoginCredentialProcessor implements ObjectProcessor\\d).(?\\d)(?:-(?\\w+))?"); + private static final Logger logger = EnvoyLog.getLogger(LoginCredentialProcessor.class); + private static final Pattern versionPattern = Pattern.compile("(?\\d).(?\\d)(?:-(?\\w+))?"); @Override public void process(LoginCredentials credentials, long socketID, ObjectWriteProxy writeProxy) throws IOException { @@ -49,10 +49,10 @@ public final class LoginCredentialProcessor implements ObjectProcessor= 0) { - // writeProxy.write(socketID, new HandshakeRejectionEvent("Wrong version")); - // return; + if (!verifyCompatibility(credentials.getClientVersion())) { + logger.info("The client has the wrong version."); + writeProxy.write(socketID, new HandshakeRejection("Wrong version")); + return; } // Acquire a user object (or reject the handshake if that's impossible) @@ -125,6 +125,57 @@ public final class LoginCredentialProcessor implements ObjectProcessor maxSuffix) return false; + } + + // Compare major + { + final var currentMajor = Integer.parseInt(currentMatcher.group("major")); + final var minMajor = Integer.parseInt(minMatcher.group("major")); + final var maxMajor = Integer.parseInt(maxMatcher.group("major")); + + if (currentMajor < minMajor || currentMajor > maxMajor) return false; + } + + // Compare minor + { + final var currentMinor = Integer.parseInt(currentMatcher.group("minor")); + final var minMinor = Integer.parseInt(minMatcher.group("minor")); + final var maxMinor = Integer.parseInt(maxMatcher.group("minor")); + + if (currentMinor < minMinor || currentMinor > maxMinor) return false; + } + + return true; + } + + private int convertSuffix(String suffix) { + switch (suffix == null ? "" : suffix) { + case "alpha": + return 0; + case "beta": + return 1; + default: + return 2; + } + } + @Override public Class getInputClass() { return LoginCredentials.class; } } From 0d7cb38b6d1de9b840ee6f2d8d838ac747ed20de Mon Sep 17 00:00:00 2001 From: kske Date: Tue, 23 Jun 2020 09:08:57 +0200 Subject: [PATCH 3/4] Apply suggestions from code review --- pom.xml | 2 +- .../java/enovy/server/util/VersionUtils.java | 94 +++++++++++++++++++ .../java/enovy/server/util/package-info.java | 11 +++ src/main/java/envoy/server/Startup.java | 14 --- src/main/java/envoy/server/data/Message.java | 23 ++++- .../processors/LoginCredentialProcessor.java | 63 +------------ .../server/processors/MessageProcessor.java | 2 +- .../MessageStatusChangeProcessor.java | 3 +- 8 files changed, 133 insertions(+), 79 deletions(-) create mode 100644 src/main/java/enovy/server/util/VersionUtils.java create mode 100644 src/main/java/enovy/server/util/package-info.java diff --git a/pom.xml b/pom.xml index 0612482..046ec55 100755 --- a/pom.xml +++ b/pom.xml @@ -28,7 +28,7 @@ com.github.informatik-ag-ngl envoy-common - f~compatibility_verification-SNAPSHOT + develop-SNAPSHOT com.github.informatik-ag-ngl diff --git a/src/main/java/enovy/server/util/VersionUtils.java b/src/main/java/enovy/server/util/VersionUtils.java new file mode 100644 index 0000000..1a66590 --- /dev/null +++ b/src/main/java/enovy/server/util/VersionUtils.java @@ -0,0 +1,94 @@ +package enovy.server.util; + +import java.util.regex.Pattern; + +/** + * Implements a comparison algorithm between Envoy versions and defines minimal + * and maximal client versions compatible with this server. + *

+ * Project: envoy-server-standalone
+ * File: VersionUtils.java
+ * Created: 23.06.2020
+ * + * @author KSKE + * @since Envoy Server Standalone v0.1-beta + */ +public class VersionUtils { + + /** + * The minimal client version compatible with this server. + * + * @since Envoy Server Standalone v0.1-beta + */ + public static final String MIN_CLIENT_VERSION = "0.1-beta"; + + /** + * The maximal client version compatible with this server. + * + * @since Envoy Server Standalone v0.1-beta + */ + public static final String MAX_CLIENT_VERSION = "0.1-beta"; + + private static final Pattern versionPattern = Pattern.compile("(?\\d).(?\\d)(?:-(?\\w+))?"); + + private VersionUtils() {} + + /** + * Parses an Envoy Client version string and checks whether that version is + * compatible with this server. + * + * @param version the version string to parse + * @return {@code true} if the given version is compatible with this server + * @since Envoy Server Standalone v0.1-beta + */ + public static boolean verifyCompatibility(String version) { + final var currentMatcher = versionPattern.matcher(version); + + if (!currentMatcher.matches()) return false; + + final var minMatcher = versionPattern.matcher(MIN_CLIENT_VERSION); + final var maxMatcher = versionPattern.matcher(MAX_CLIENT_VERSION); + + if (!minMatcher.matches() || !maxMatcher.matches()) throw new RuntimeException("Invalid min or max client version configured!"); + + // Compare suffixes + { + final var currentSuffix = convertSuffix(currentMatcher.group("suffix")); + final var minSuffix = convertSuffix(minMatcher.group("suffix")); + final var maxSuffix = convertSuffix(maxMatcher.group("suffix")); + + if (currentSuffix < minSuffix || currentSuffix > maxSuffix) return false; + } + + // Compare major + { + final var currentMajor = Integer.parseInt(currentMatcher.group("major")); + final var minMajor = Integer.parseInt(minMatcher.group("major")); + final var maxMajor = Integer.parseInt(maxMatcher.group("major")); + + if (currentMajor < minMajor || currentMajor > maxMajor) return false; + } + + // Compare minor + { + final var currentMinor = Integer.parseInt(currentMatcher.group("minor")); + final var minMinor = Integer.parseInt(minMatcher.group("minor")); + final var maxMinor = Integer.parseInt(maxMatcher.group("minor")); + + if (currentMinor < minMinor || currentMinor > maxMinor) return false; + } + + return true; + } + + private static int convertSuffix(String suffix) { + switch (suffix == null ? "" : suffix) { + case "alpha": + return 0; + case "beta": + return 1; + default: + return 2; + } + } +} diff --git a/src/main/java/enovy/server/util/package-info.java b/src/main/java/enovy/server/util/package-info.java new file mode 100644 index 0000000..f256f4c --- /dev/null +++ b/src/main/java/enovy/server/util/package-info.java @@ -0,0 +1,11 @@ +/** + * This package contains utility classes used in Envoy Server. + *

+ * Project: envoy-server-standalone
+ * File: package-info.java
+ * Created: 23.06.2020
+ * + * @author Kai S. K. Engelbart + * @since Envoy Server Standalone v0.1-beta + */ +package enovy.server.util; diff --git a/src/main/java/envoy/server/Startup.java b/src/main/java/envoy/server/Startup.java index b88f1bd..9ad4bc3 100755 --- a/src/main/java/envoy/server/Startup.java +++ b/src/main/java/envoy/server/Startup.java @@ -29,20 +29,6 @@ import envoy.util.EnvoyLog; */ public class Startup { - /** - * The minimal client version compatible with this server. - * - * @since Envoy Server Standalone v0.1-beta - */ - public static final String MIN_CLIENT_VERSION = "0.1-beta"; - - /** - * The maximal client version compatible with this server. - * - * @since Envoy Server Standalone v0.1-beta - */ - public static final String MAX_CLIENT_VERSION = "0.1-beta"; - /** * Initializes the logger with a new config instance. * diff --git a/src/main/java/envoy/server/data/Message.java b/src/main/java/envoy/server/data/Message.java index e53a7e5..5b81e7d 100755 --- a/src/main/java/envoy/server/data/Message.java +++ b/src/main/java/envoy/server/data/Message.java @@ -1,5 +1,7 @@ package envoy.server.data; +import static envoy.data.Message.MessageStatus.*; + import java.time.LocalDateTime; import javax.persistence.*; @@ -38,7 +40,7 @@ public class Message { * @since Envoy Server Standalone v0.1-beta */ public static final String getPending = "Message.getPending"; - + @Id protected long id; @@ -111,9 +113,26 @@ public class Message { return message; } + /** + * Sets the message status to {@link MessageStatus#RECEIVED} and sets the + * current time stamp as the received date. + * + * @since Envoy Server Standalone v0.1-beta + */ public void received() { receivedDate = LocalDateTime.now(); - status = MessageStatus.RECEIVED; + status = RECEIVED; + } + + /** + * Sets the message status to {@link MessageStatus#READ} and sets the + * current time stamp as the read date. + * + * @since Envoy Server Standalone v0.1-beta + */ + public void read() { + readDate = LocalDateTime.now(); + status = READ; } /** diff --git a/src/main/java/envoy/server/processors/LoginCredentialProcessor.java b/src/main/java/envoy/server/processors/LoginCredentialProcessor.java index 5ab8cc6..9877f36 100755 --- a/src/main/java/envoy/server/processors/LoginCredentialProcessor.java +++ b/src/main/java/envoy/server/processors/LoginCredentialProcessor.java @@ -8,15 +8,14 @@ import java.time.LocalDateTime; import java.util.Arrays; import java.util.HashSet; import java.util.logging.Logger; -import java.util.regex.Pattern; import javax.persistence.NoResultException; +import enovy.server.util.VersionUtils; import envoy.data.LoginCredentials; import envoy.data.Message.MessageStatus; import envoy.event.HandshakeRejection; import envoy.event.MessageStatusChange; -import envoy.server.Startup; import envoy.server.data.PersistenceManager; import envoy.server.data.User; import envoy.server.net.ConnectionManager; @@ -40,7 +39,6 @@ public final class LoginCredentialProcessor implements ObjectProcessor\\d).(?\\d)(?:-(?\\w+))?"); @Override public void process(LoginCredentials credentials, long socketID, ObjectWriteProxy writeProxy) throws IOException { @@ -48,10 +46,9 @@ public final class LoginCredentialProcessor implements ObjectProcessor maxSuffix) return false; - } - - // Compare major - { - final var currentMajor = Integer.parseInt(currentMatcher.group("major")); - final var minMajor = Integer.parseInt(minMatcher.group("major")); - final var maxMajor = Integer.parseInt(maxMatcher.group("major")); - - if (currentMajor < minMajor || currentMajor > maxMajor) return false; - } - - // Compare minor - { - final var currentMinor = Integer.parseInt(currentMatcher.group("minor")); - final var minMinor = Integer.parseInt(minMatcher.group("minor")); - final var maxMinor = Integer.parseInt(maxMatcher.group("minor")); - - if (currentMinor < minMinor || currentMinor > maxMinor) return false; - } - - return true; - } - - private int convertSuffix(String suffix) { - switch (suffix == null ? "" : suffix) { - case "alpha": - return 0; - case "beta": - return 1; - default: - return 2; - } - } - @Override public Class getInputClass() { return LoginCredentials.class; } } diff --git a/src/main/java/envoy/server/processors/MessageProcessor.java b/src/main/java/envoy/server/processors/MessageProcessor.java index 8622cd8..c143d42 100755 --- a/src/main/java/envoy/server/processors/MessageProcessor.java +++ b/src/main/java/envoy/server/processors/MessageProcessor.java @@ -35,7 +35,7 @@ public class MessageProcessor implements ObjectProcessor { return; } message.nextStatus(); - ConnectionManager connectionManager = ConnectionManager.getInstance(); + ConnectionManager connectionManager = ConnectionManager.getInstance(); sendToUser(connectionManager, message, writeProxy); try { diff --git a/src/main/java/envoy/server/processors/MessageStatusChangeProcessor.java b/src/main/java/envoy/server/processors/MessageStatusChangeProcessor.java index a3dca3c..8801d54 100755 --- a/src/main/java/envoy/server/processors/MessageStatusChangeProcessor.java +++ b/src/main/java/envoy/server/processors/MessageStatusChangeProcessor.java @@ -28,8 +28,7 @@ public class MessageStatusChangeProcessor implements ObjectProcessor Date: Tue, 23 Jun 2020 16:02:12 +0000 Subject: [PATCH 4/4] Fix Javadoc author Co-authored-by: delvh --- src/main/java/enovy/server/util/VersionUtils.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/enovy/server/util/VersionUtils.java b/src/main/java/enovy/server/util/VersionUtils.java index 1a66590..ab96890 100644 --- a/src/main/java/enovy/server/util/VersionUtils.java +++ b/src/main/java/enovy/server/util/VersionUtils.java @@ -10,7 +10,7 @@ import java.util.regex.Pattern; * File: VersionUtils.java
* Created: 23.06.2020
* - * @author KSKE + * @author Kai S. K. Engelbart * @since Envoy Server Standalone v0.1-beta */ public class VersionUtils {