From deff9d642b076552534b8df4ac0f235907d73438 Mon Sep 17 00:00:00 2001 From: CyB3RC0nN0R Date: Sat, 13 Jun 2020 18:46:41 +0200 Subject: [PATCH 01/13] Store user specific local database information inside a single file Closes #141 --- .../envoy/client/data/PersistentLocalDB.java | 83 +++++++------------ .../envoy/client/data/TransientLocalDB.java | 2 +- 2 files changed, 30 insertions(+), 55 deletions(-) diff --git a/src/main/java/envoy/client/data/PersistentLocalDB.java b/src/main/java/envoy/client/data/PersistentLocalDB.java index 9548516..35e77c3 100644 --- a/src/main/java/envoy/client/data/PersistentLocalDB.java +++ b/src/main/java/envoy/client/data/PersistentLocalDB.java @@ -1,12 +1,12 @@ package envoy.client.data; -import java.io.File; -import java.io.IOException; +import java.io.*; import java.util.ArrayList; import java.util.HashMap; -import envoy.data.ConfigItem; import envoy.data.IDGenerator; +import envoy.data.Message; +import envoy.event.MessageStatusChangeEvent; import envoy.util.SerializationUtils; /** @@ -21,92 +21,67 @@ import envoy.util.SerializationUtils; * @author Maximilian Käfer * @since Envoy Client v0.1-alpha */ -public class PersistentLocalDB extends LocalDB { +public final class PersistentLocalDB extends LocalDB { - private File localDBDir, localDBFile, usersFile, idGeneratorFile, messageCacheFile, statusCacheFile; + private File dbDir, userFile, idGeneratorFile, usersFile; /** - * Initializes an empty local database without a directory. All changes made to - * this instance cannot be saved to the file system.
- *
- * This constructor shall be used in conjunction with the {@code ignoreLocalDB} - * {@link ConfigItem}. + * Constructs an empty local database. To serialize any user-specific data to + * the file system, call {@link PersistentLocalDB#initializeUserStorage()} first + * and then {@link PersistentLocalDB#save()}. * - * @since Envoy Client v0.3-alpha - */ - public PersistentLocalDB() {} - - /** - * Constructs an empty local database. To serialize any chats to the file - * system, call {@link PersistentLocalDB#initializeUserStorage()}. - * - * @param localDBDir the directory in which to store users and chats - * @throws IOException if the PersistentLocalDB could not be initialized + * @param dbDir the directory in which to persist data + * @throws IOException if {@code dbDir} is a file (and not a directory) * @since Envoy Client v0.1-alpha */ - public PersistentLocalDB(File localDBDir) throws IOException { - this.localDBDir = localDBDir; + public PersistentLocalDB(File dbDir) throws IOException { + this.dbDir = dbDir; - // Initialize local database directory - if (localDBDir.exists() && !localDBDir.isDirectory()) - throw new IOException(String.format("LocalDBDir '%s' is not a directory!", localDBDir.getAbsolutePath())); - usersFile = new File(localDBDir, "users.db"); - idGeneratorFile = new File(localDBDir, "id_generator.db"); + // Test if the database directory is actually a directory + if (dbDir.exists() && !dbDir.isDirectory()) + throw new IOException(String.format("LocalDBDir '%s' is not a directory!", dbDir.getAbsolutePath())); + + // Initialize global files + idGeneratorFile = new File(dbDir, "id_gen.db"); + usersFile = new File(dbDir, "users.db"); } /** - * Creates a database file for a user-specific list of chats.
- * {@inheritDoc} + * Creates a database file for a user-specific list of chats. * - * @throws NullPointerException if the client user is not yet specified + * @throws IllegalStateException if the client user is not specified * @since Envoy Client v0.1-alpha */ @Override public void initializeUserStorage() { - if (user == null) throw new NullPointerException("Client user is null"); - localDBFile = new File(localDBDir, user.getID() + ".db"); - messageCacheFile = new File(localDBDir, user.getID() + "_message_cache.db"); - statusCacheFile = new File(localDBDir, user.getID() + "_status_cache.db"); + if (user == null) throw new IllegalStateException("Client user is null, cannot initialize user storage"); + userFile = new File(dbDir, user.getID() + ".db"); } - /** - * {@inheritDoc} - */ @Override public void save() throws IOException { // Save users SerializationUtils.write(usersFile, users); // Save user data - if (user != null) { - SerializationUtils.write(localDBFile, chats); - SerializationUtils.write(messageCacheFile, messageCache); - SerializationUtils.write(statusCacheFile, statusCache); - } + if (user != null) SerializationUtils.write(userFile, chats, messageCache, statusCache); // Save id generator if (hasIDGenerator()) SerializationUtils.write(idGeneratorFile, idGenerator); } - /** - * {@inheritDoc} - */ @Override public void loadUsers() throws ClassNotFoundException, IOException { users = SerializationUtils.read(usersFile, HashMap.class); } - /** - * {@inheritDoc} - */ @Override public void loadUserData() throws ClassNotFoundException, IOException { - chats = SerializationUtils.read(localDBFile, ArrayList.class); - messageCache = SerializationUtils.read(messageCacheFile, Cache.class); - statusCache = SerializationUtils.read(statusCacheFile, Cache.class); + try (var in = new ObjectInputStream(new FileInputStream(userFile))) { + chats = (ArrayList) in.readObject(); + messageCache = (Cache) in.readObject(); + statusCache = (Cache) in.readObject(); + } } - /** - * {@inheritDoc} - */ @Override public void loadIDGenerator() { try { diff --git a/src/main/java/envoy/client/data/TransientLocalDB.java b/src/main/java/envoy/client/data/TransientLocalDB.java index 1dcb0c4..ef592fb 100644 --- a/src/main/java/envoy/client/data/TransientLocalDB.java +++ b/src/main/java/envoy/client/data/TransientLocalDB.java @@ -11,5 +11,5 @@ package envoy.client.data; * @author Kai S. K. Engelbart * @since Envoy Client v0.3-alpha */ -public class TransientLocalDB extends LocalDB { +public final class TransientLocalDB extends LocalDB { } From 753791e8c9962289d89ea35c293aa57562811193 Mon Sep 17 00:00:00 2001 From: delvh Date: Sat, 13 Jun 2020 22:36:52 +0200 Subject: [PATCH 02/13] Added improved logging capabilities --- src/main/java/envoy/client/data/Cache.java | 5 +- src/main/java/envoy/client/net/Client.java | 56 +++++++++++-------- .../MessageStatusChangeEventProcessor.java | 3 +- .../client/net/ReceivedMessageProcessor.java | 3 +- src/main/java/envoy/client/net/Receiver.java | 24 ++++---- .../java/envoy/client/net/WriteProxy.java | 12 ++-- .../java/envoy/client/ui/MessageListCell.java | 11 ++-- .../java/envoy/client/ui/SceneContext.java | 27 +++++---- src/main/java/envoy/client/ui/Startup.java | 40 ++++++------- .../java/envoy/client/ui/StatusTrayIcon.java | 19 ++++--- .../envoy/client/ui/controller/ChatScene.java | 27 ++++----- .../ui/controller/ContactSearchScene.java | 9 ++- .../ui/controller/GroupCreationScene.java | 5 +- .../client/ui/controller/LoginScene.java | 45 +++++++++------ 14 files changed, 157 insertions(+), 129 deletions(-) diff --git a/src/main/java/envoy/client/data/Cache.java b/src/main/java/envoy/client/data/Cache.java index 8060d2e..0707a62 100644 --- a/src/main/java/envoy/client/data/Cache.java +++ b/src/main/java/envoy/client/data/Cache.java @@ -4,6 +4,7 @@ import java.io.Serializable; import java.util.LinkedList; import java.util.Queue; import java.util.function.Consumer; +import java.util.logging.Level; import java.util.logging.Logger; import envoy.util.EnvoyLog; @@ -25,7 +26,7 @@ public class Cache implements Consumer, Serializable { private transient Consumer processor; private static final Logger logger = EnvoyLog.getLogger(Cache.class); - private static final long serialVersionUID = 0L; + private static final long serialVersionUID = 0L; /** * Adds an element to the cache. @@ -35,7 +36,7 @@ public class Cache implements Consumer, Serializable { */ @Override public void accept(T element) { - logger.fine(String.format("Adding element %s to cache", element)); + logger.log(Level.FINE, String.format("Adding element %s to cache", element)); elements.offer(element); } diff --git a/src/main/java/envoy/client/net/Client.java b/src/main/java/envoy/client/net/Client.java index 9f9dad7..e716f87 100644 --- a/src/main/java/envoy/client/net/Client.java +++ b/src/main/java/envoy/client/net/Client.java @@ -7,6 +7,7 @@ import java.util.HashMap; import java.util.Map; import java.util.Set; import java.util.concurrent.TimeoutException; +import java.util.logging.Level; import java.util.logging.Logger; import envoy.client.data.Cache; @@ -56,25 +57,29 @@ public class Client implements Closeable { * will block for up to 5 seconds. If the handshake does exceed this time limit, * an exception is thrown. * - * @param credentials the login credentials of the user - * @param receivedMessageCache a message cache containing all unread messages - * from the server that can be relayed after - * initialization - * @param receivedMessageStatusChangeEventCache an event cache containing all received messageStatusChangeEvents from the server that can be relayed after initialization + * @param credentials the login credentials of the + * user + * @param receivedMessageCache a message cache containing all + * unread messages from the server + * that can be relayed after + * initialization + * @param receivedMessageStatusChangeEventCache an event cache containing all + * received + * messageStatusChangeEvents from + * the server that can be relayed + * after initialization * @throws TimeoutException if the server could not be reached - * @throws IOException if the login credentials could not be - * written + * @throws IOException if the login credentials could not be written * @throws InterruptedException if the current thread is interrupted while * waiting for the handshake response */ public void performHandshake(LoginCredentials credentials, Cache receivedMessageCache, - Cache receivedMessageStatusChangeEventCache) - throws TimeoutException, IOException, InterruptedException { + Cache receivedMessageStatusChangeEventCache) throws TimeoutException, IOException, InterruptedException { if (online) throw new IllegalStateException("Handshake has already been performed successfully"); // Establish TCP connection - logger.finer(String.format("Attempting connection to server %s:%d...", config.getServer(), config.getPort())); + logger.log(Level.FINER, String.format("Attempting connection to server %s:%d...", config.getServer(), config.getPort())); socket = new Socket(config.getServer(), config.getPort()); - logger.fine("Successfully established TCP connection to server"); + logger.log(Level.FINE, "Successfully established TCP connection to server"); // Create object receiver receiver = new Receiver(socket.getInputStream()); @@ -114,19 +119,25 @@ public class Client implements Closeable { // Remove all processors as they are only used during the handshake receiver.removeAllProcessors(); - logger.info("Handshake completed."); + logger.log(Level.INFO, "Handshake completed."); } /** * Initializes the {@link Receiver} used to process data sent from the server to * this client. * - * @param localDB the local database used to persist the current - * {@link IDGenerator} - * @param receivedMessageCache a message cache containing all unread messages - * from the server that can be relayed after - * initialization - * @param receivedMessageStatusChangeEventCache an event cache containing all received messageStatusChangeEvents from the server that can be relayed after initialization + * @param localDB the local database used to + * persist the current + * {@link IDGenerator} + * @param receivedMessageCache a message cache containing all + * unread messages from the server + * that can be relayed after + * initialization + * @param receivedMessageStatusChangeEventCache an event cache containing all + * received + * messageStatusChangeEvents from + * the server that can be relayed + * after initialization * @throws IOException if no {@link IDGenerator} is present and none could be * requested from the server * @since Envoy Client v0.2-alpha @@ -136,7 +147,7 @@ public class Client implements Closeable { checkOnline(); // Process incoming messages - final ReceivedMessageProcessor receivedMessageProcessor = new ReceivedMessageProcessor(); + final ReceivedMessageProcessor receivedMessageProcessor = new ReceivedMessageProcessor(); final MessageStatusChangeEventProcessor messageStatusChangeEventProcessor = new MessageStatusChangeEventProcessor(); receiver.registerProcessor(Message.class, receivedMessageProcessor); @@ -172,6 +183,7 @@ public class Client implements Closeable { sendEvent(evt.get()); } catch (final IOException e) { e.printStackTrace(); + logger.log(Level.WARNING, "An error occurred when trying to send Event " + evt, e); } }); @@ -218,7 +230,7 @@ public class Client implements Closeable { * @since Envoy Client v0.3-alpha */ public void requestIdGenerator() throws IOException { - logger.info("Requesting new id generator..."); + logger.log(Level.INFO, "Requesting new id generator..."); writeObject(new IDGeneratorRequest()); } @@ -240,7 +252,7 @@ public class Client implements Closeable { private void writeObject(Object obj) throws IOException { checkOnline(); - logger.fine("Sending " + obj); + logger.log(Level.FINE, "Sending " + obj); SerializationUtils.writeBytesWithLength(obj, socket.getOutputStream()); } @@ -258,7 +270,7 @@ public class Client implements Closeable { * @param clientUser the client user to set * @since Envoy Client v0.2-alpha */ - public void setSender(User clientUser) { this.sender = clientUser; } + public void setSender(User clientUser) { sender = clientUser; } /** * @return the {@link Receiver} used by this {@link Client} diff --git a/src/main/java/envoy/client/net/MessageStatusChangeEventProcessor.java b/src/main/java/envoy/client/net/MessageStatusChangeEventProcessor.java index ce53139..ad424c4 100644 --- a/src/main/java/envoy/client/net/MessageStatusChangeEventProcessor.java +++ b/src/main/java/envoy/client/net/MessageStatusChangeEventProcessor.java @@ -1,6 +1,7 @@ package envoy.client.net; import java.util.function.Consumer; +import java.util.logging.Level; import java.util.logging.Logger; import envoy.data.Message.MessageStatus; @@ -29,7 +30,7 @@ public class MessageStatusChangeEventProcessor implements Consumer { @Override public void accept(Message message) { - if (message.getStatus() != MessageStatus.SENT) logger.warning("The message has the unexpected status " + message.getStatus()); + if (message.getStatus() != MessageStatus.SENT) logger.log(Level.WARNING, "The message has the unexpected status " + message.getStatus()); else { // Update status to RECEIVED message.nextStatus(); diff --git a/src/main/java/envoy/client/net/Receiver.java b/src/main/java/envoy/client/net/Receiver.java index 5926e1e..514e20a 100644 --- a/src/main/java/envoy/client/net/Receiver.java +++ b/src/main/java/envoy/client/net/Receiver.java @@ -45,7 +45,7 @@ public class Receiver extends Thread { /** * Starts the receiver loop. When an object is read, it is passed to the * appropriate processor. - * + * * @since Envoy Client v0.3-alpha */ @Override @@ -54,29 +54,29 @@ public class Receiver extends Thread { try { while (true) { // Read object length - byte[] lenBytes = new byte[4]; + final byte[] lenBytes = new byte[4]; in.read(lenBytes); - int len = SerializationUtils.bytesToInt(lenBytes, 0); + final int len = SerializationUtils.bytesToInt(lenBytes, 0); // Read object into byte array - byte[] objBytes = new byte[len]; + final byte[] objBytes = new byte[len]; in.read(objBytes); try (ObjectInputStream oin = new ObjectInputStream(new ByteArrayInputStream(objBytes))) { - Object obj = oin.readObject(); - logger.fine("Received " + obj); + final Object obj = oin.readObject(); + logger.log(Level.FINE, "Received " + obj); // Get appropriate processor @SuppressWarnings("rawtypes") - Consumer processor = processors.get(obj.getClass()); - if (processor == null) - logger.warning(String.format("The received object has the class %s for which no processor is defined.", obj.getClass())); + final Consumer processor = processors.get(obj.getClass()); + if (processor == null) logger.log(Level.WARNING, + String.format("The received object has the class %s for which no processor is defined.", obj.getClass())); else processor.accept(obj); } } - } catch (SocketException e) { + } catch (final SocketException e) { // Connection probably closed by client. - } catch (Exception e) { + } catch (final Exception e) { logger.log(Level.SEVERE, "Error on receiver thread", e); e.printStackTrace(); } @@ -94,7 +94,7 @@ public class Receiver extends Thread { /** * Removes all object processors registered at this {@link Receiver}. - * + * * @since Envoy Client v0.3-alpha */ public void removeAllProcessors() { processors.clear(); } diff --git a/src/main/java/envoy/client/net/WriteProxy.java b/src/main/java/envoy/client/net/WriteProxy.java index 97848df..ba9c565 100644 --- a/src/main/java/envoy/client/net/WriteProxy.java +++ b/src/main/java/envoy/client/net/WriteProxy.java @@ -45,21 +45,21 @@ public class WriteProxy { // Initialize cache processors for messages and message status change events localDB.getMessageCache().setProcessor(msg -> { try { - logger.finer("Sending cached " + msg); + logger.log(Level.FINER, "Sending cached " + msg); client.sendMessage(msg); // Update message state to SENT in localDB localDB.getMessage(msg.getID()).ifPresent(Message::nextStatus); - } catch (IOException e) { - logger.log(Level.SEVERE, "Could not send cached message", e); + } catch (final IOException e) { + logger.log(Level.SEVERE, "Could not send cached message: ", e); } }); localDB.getStatusCache().setProcessor(evt -> { - logger.finer("Sending cached " + evt); + logger.log(Level.FINER, "Sending cached " + evt); try { client.sendEvent(evt); - } catch (IOException e) { - logger.log(Level.SEVERE, "Could not send cached message status change event", e); + } catch (final IOException e) { + logger.log(Level.SEVERE, "Could not send cached message status change event: ", e); } }); } diff --git a/src/main/java/envoy/client/ui/MessageListCell.java b/src/main/java/envoy/client/ui/MessageListCell.java index 7b7a479..95f9ff2 100644 --- a/src/main/java/envoy/client/ui/MessageListCell.java +++ b/src/main/java/envoy/client/ui/MessageListCell.java @@ -3,6 +3,7 @@ package envoy.client.ui; import java.io.IOException; import java.text.SimpleDateFormat; import java.util.Map; +import java.util.logging.Level; import javafx.scene.control.Label; import javafx.scene.control.ListCell; @@ -13,6 +14,7 @@ import javafx.scene.layout.VBox; import envoy.data.Message; import envoy.data.Message.MessageStatus; +import envoy.util.EnvoyLog; /** * Displays a single message inside the message list. @@ -20,7 +22,7 @@ import envoy.data.Message.MessageStatus; * Project: envoy-client
* File: MessageListCell.java
* Created: 28.03.2020
- * + * * @author Kai S. K. Engelbart * @since Envoy Client v0.1-beta */ @@ -32,20 +34,21 @@ public class MessageListCell extends ListCell { static { try { statusImages = IconUtil.loadByEnum(MessageStatus.class, 32); - } catch (IOException e) { + } catch (final IOException e) { e.printStackTrace(); + EnvoyLog.getLogger(MessageListCell.class).log(Level.WARNING, "could not load status icons: ", e); } } /** * Displays the text, the data of creation and the status of a message. - * + * * @since Envoy v0.1-beta */ @Override protected void updateItem(Message message, boolean empty) { super.updateItem(message, empty); - if(empty || message == null) { + if (empty || message == null) { setText(null); setGraphic(null); } else { diff --git a/src/main/java/envoy/client/ui/SceneContext.java b/src/main/java/envoy/client/ui/SceneContext.java index ea3b4b2..52c847b 100644 --- a/src/main/java/envoy/client/ui/SceneContext.java +++ b/src/main/java/envoy/client/ui/SceneContext.java @@ -2,6 +2,7 @@ package envoy.client.ui; import java.io.IOException; import java.util.Stack; +import java.util.logging.Level; import javafx.fxml.FXMLLoader; import javafx.scene.Parent; @@ -11,6 +12,7 @@ import javafx.stage.Stage; import envoy.client.data.Settings; import envoy.client.event.ThemeChangeEvent; import envoy.event.EventBus; +import envoy.util.EnvoyLog; /** * Manages a stack of scenes. The most recently added scene is displayed inside @@ -23,7 +25,7 @@ import envoy.event.EventBus; * Project: envoy-client
* File: SceneContext.java
* Created: 06.06.2020
- * + * * @author Kai S. K. Engelbart * @since Envoy Client v0.1-beta */ @@ -31,43 +33,43 @@ public final class SceneContext { /** * Contains information about different scenes and their FXML resource files. - * + * * @author Kai S. K. Engelbart * @since Envoy Client v0.1-beta */ - public static enum SceneInfo { + public enum SceneInfo { /** * The main scene in which chats are displayed. - * + * * @since Envoy Client v0.1-beta */ CHAT_SCENE("/fxml/ChatScene.fxml"), /** * The scene in which settings are displayed. - * + * * @since Envoy Client v0.1-beta */ SETTINGS_SCENE("/fxml/SettingsScene.fxml"), /** * The scene in which the contact search is displayed. - * + * * @since Envoy Client v0.1-beta */ CONTACT_SEARCH_SCENE("/fxml/ContactSearchScene.fxml"), /** * The scene in which the group creation screen is displayed. - * + * * @since Envoy Client v0.1-beta */ GROUP_CREATION_SCENE("/fxml/GroupCreationScene.fxml"), /** * The scene in which the login screen is displayed. - * + * * @since Envoy Client v0.1-beta */ LOGIN_SCENE("/fxml/LoginScene.fxml"); @@ -88,7 +90,7 @@ public final class SceneContext { /** * Initializes the scene context. - * + * * @param stage the stage in which scenes will be displayed * @since Envoy Client v0.1-beta */ @@ -99,7 +101,7 @@ public final class SceneContext { /** * Loads a new scene specified by a scene info. - * + * * @param sceneInfo specifies the scene to load * @throws RuntimeException if the loading process fails * @since Envoy Client v0.1-beta @@ -117,14 +119,15 @@ public final class SceneContext { applyCSS(); stage.sizeToScene(); stage.show(); - } catch (IOException e) { + } catch (final IOException e) { + EnvoyLog.getLogger(SceneContext.class).log(Level.SEVERE, String.format("Could not load scene for %s: ", sceneInfo), e); throw new RuntimeException(e); } } /** * Removes the current scene and displays the previous one. - * + * * @since Envoy Client v0.1-beta */ public void pop() { diff --git a/src/main/java/envoy/client/ui/Startup.java b/src/main/java/envoy/client/ui/Startup.java index dbadfc3..906f704 100644 --- a/src/main/java/envoy/client/ui/Startup.java +++ b/src/main/java/envoy/client/ui/Startup.java @@ -2,6 +2,7 @@ package envoy.client.ui; import java.io.File; import java.io.IOException; +import java.util.Date; import java.util.Properties; import java.util.logging.Level; import java.util.logging.Logger; @@ -33,9 +34,9 @@ import envoy.util.EnvoyLog; */ public final class Startup extends Application { - private LocalDB localDB; - private Client client; - private Cache messageCache; + private LocalDB localDB; + private Client client; + private Cache messageCache; private Cache messageStatusCache; private static final ClientConfig config = ClientConfig.getInstance(); @@ -44,13 +45,14 @@ public final class Startup extends Application { /** * Loads the configuration, initializes the client and the local database and * delegates the rest of the startup process to {@link LoginScene}. - * + * * @since Envoy Client v0.1-beta */ @Override public void start(Stage stage) throws Exception { try { // Load the configuration from client.properties first + logger.log(Level.INFO, "Envoy was started at " + new Date()); final Properties properties = new Properties(); properties.load(Startup.class.getClassLoader().getResourceAsStream("client.properties")); config.load(properties); @@ -63,6 +65,7 @@ public final class Startup extends Application { if (!config.isInitialized()) throw new EnvoyException("Configuration is not fully initialized"); } catch (final Exception e) { new Alert(AlertType.ERROR, "Error loading configuration values:\n" + e); + logger.log(Level.SEVERE, "Error loading configuration values", e); e.printStackTrace(); System.exit(1); } @@ -77,20 +80,18 @@ public final class Startup extends Application { if (config.isIgnoreLocalDB()) { localDB = new TransientLocalDB(); new Alert(AlertType.WARNING, "Ignoring local database.\nMessages will not be saved!").showAndWait(); - } else { - try { - localDB = new PersistentLocalDB(new File(config.getHomeDirectory(), config.getLocalDB().getPath())); - } catch (final IOException e3) { - logger.log(Level.SEVERE, "Could not initialize local database", e3); - new Alert(AlertType.ERROR, "Could not initialize local database!\n" + e3).showAndWait(); - System.exit(1); - return; - } + } else try { + localDB = new PersistentLocalDB(new File(config.getHomeDirectory(), config.getLocalDB().getPath())); + } catch (final IOException e3) { + logger.log(Level.SEVERE, "Could not initialize local database: ", e3); + new Alert(AlertType.ERROR, "Could not initialize local database!\n" + e3).showAndWait(); + System.exit(1); + return; } // Initialize client and unread message cache - client = new Client(); - messageCache = new Cache<>(); + client = new Client(); + messageCache = new Cache<>(); messageStatusCache = new Cache<>(); stage.setTitle("Envoy"); @@ -103,20 +104,21 @@ public final class Startup extends Application { /** * Closes the client connection and saves the local database and settings. - * + * * @since Envoy Client v0.1-beta */ @Override public void stop() { try { - logger.info("Closing connection..."); + logger.log(Level.INFO, "Closing connection..."); client.close(); - logger.info("Saving local database and settings..."); + logger.log(Level.INFO, "Saving local database and settings..."); localDB.save(); Settings.getInstance().save(); + logger.log(Level.INFO, "Envoy was stopped as expected at " + new Date()); } catch (final Exception e) { - logger.log(Level.SEVERE, "Unable to save local files", e); + logger.log(Level.SEVERE, "Unable to save local files: ", e); } } diff --git a/src/main/java/envoy/client/ui/StatusTrayIcon.java b/src/main/java/envoy/client/ui/StatusTrayIcon.java index 621655f..eb0178d 100644 --- a/src/main/java/envoy/client/ui/StatusTrayIcon.java +++ b/src/main/java/envoy/client/ui/StatusTrayIcon.java @@ -4,11 +4,13 @@ import java.awt.*; import java.awt.TrayIcon.MessageType; import java.awt.event.WindowAdapter; import java.awt.event.WindowEvent; +import java.util.logging.Level; import envoy.client.event.MessageCreationEvent; import envoy.data.Message; import envoy.event.EventBus; import envoy.exception.EnvoyException; +import envoy.util.EnvoyLog; /** * Project: envoy-client
@@ -25,7 +27,7 @@ public class StatusTrayIcon { * system tray. This includes displaying the icon, but also creating * notifications when new messages are received. */ - private TrayIcon trayIcon; + private final TrayIcon trayIcon; /** * A received {@link Message} is only displayed as a system tray notification if @@ -46,16 +48,16 @@ public class StatusTrayIcon { public StatusTrayIcon(Window focusTarget) throws EnvoyException { if (!SystemTray.isSupported()) throw new EnvoyException("The Envoy tray icon is not supported."); - ClassLoader loader = Thread.currentThread().getContextClassLoader(); - Image img = Toolkit.getDefaultToolkit().createImage(loader.getResource("envoy_logo.png")); + final ClassLoader loader = Thread.currentThread().getContextClassLoader(); + final Image img = Toolkit.getDefaultToolkit().createImage(loader.getResource("envoy_logo.png")); trayIcon = new TrayIcon(img, "Envoy Client"); trayIcon.setImageAutoSize(true); trayIcon.setToolTip("You are notified if you have unread messages."); - PopupMenu popup = new PopupMenu(); + final PopupMenu popup = new PopupMenu(); - MenuItem exitMenuItem = new MenuItem("Exit"); - exitMenuItem.addActionListener((evt) -> System.exit(0)); + final MenuItem exitMenuItem = new MenuItem("Exit"); + exitMenuItem.addActionListener(evt -> System.exit(0)); popup.add(exitMenuItem); trayIcon.setPopupMenu(popup); @@ -71,7 +73,7 @@ public class StatusTrayIcon { }); // Show the window if the user clicks on the icon - trayIcon.addActionListener((evt) -> { focusTarget.setVisible(true); focusTarget.requestFocus(); }); + trayIcon.addActionListener(evt -> { focusTarget.setVisible(true); focusTarget.requestFocus(); }); // Start processing message events // TODO: Handle other message types @@ -90,7 +92,8 @@ public class StatusTrayIcon { public void show() throws EnvoyException { try { SystemTray.getSystemTray().add(trayIcon); - } catch (AWTException e) { + } catch (final AWTException e) { + EnvoyLog.getLogger(StatusTrayIcon.class).log(Level.INFO, "Could not display StatusTrayIcon: ", e); throw new EnvoyException("Could not attach Envoy tray icon to system tray.", e); } } diff --git a/src/main/java/envoy/client/ui/controller/ChatScene.java b/src/main/java/envoy/client/ui/controller/ChatScene.java index 8f7b487..0662929 100644 --- a/src/main/java/envoy/client/ui/controller/ChatScene.java +++ b/src/main/java/envoy/client/ui/controller/ChatScene.java @@ -92,14 +92,12 @@ public final class ChatScene { chat.getMessages().add(message); // Update UI if in current chat - if (chat == currentChat) - Platform.runLater(messageList::refresh); + if (chat == currentChat) Platform.runLater(messageList::refresh); }); }); // Listen to message status changes - eventBus.register(MessageStatusChangeEvent.class, e -> - localDB.getMessage(e.getID()).ifPresent(message -> { + eventBus.register(MessageStatusChangeEvent.class, e -> localDB.getMessage(e.getID()).ifPresent(message -> { message.setStatus(e.get()); // Update UI if in current chat @@ -107,16 +105,12 @@ public final class ChatScene { })); // Listen to user status changes - eventBus.register(UserStatusChangeEvent.class, e -> - userList.getItems() - .stream() - .filter(c -> c.getID() == e.getID()) - .findAny() - .ifPresent(u -> { - ((User) u).setStatus(e.get()); - Platform.runLater(userList::refresh); - }) - ); + eventBus.register(UserStatusChangeEvent.class, + e -> userList.getItems() + .stream() + .filter(c -> c.getID() == e.getID()) + .findAny() + .ifPresent(u -> { ((User) u).setStatus(e.get()); Platform.runLater(userList::refresh); })); // Listen to contacts changes eventBus.register(ContactOperationEvent.class, e -> { @@ -169,8 +163,7 @@ public final class ChatScene { // LEON: JFC <===> JAVA FRIED CHICKEN <=/=> Java Foundation Classes // Load the chat or create a new one and add it to the LocalDB - currentChat = localDB - .getChat(user.getID()) + currentChat = localDB.getChat(user.getID()) .orElseGet(() -> { final var chat = new Chat(user); localDB.getChats().add(chat); return chat; }); messageList.setItems(FXCollections.observableList(currentChat.getMessages())); @@ -264,7 +257,7 @@ public final class ChatScene { if (!localDB.getIDGenerator().hasNext() && client.isOnline()) client.requestIdGenerator(); } catch (final IOException e) { - logger.log(Level.SEVERE, "Error sending message", e); + logger.log(Level.SEVERE, "Error sending message: ", e); new Alert(AlertType.ERROR, "An error occured while sending the message!").showAndWait(); } diff --git a/src/main/java/envoy/client/ui/controller/ContactSearchScene.java b/src/main/java/envoy/client/ui/controller/ContactSearchScene.java index f2976c9..f092e6b 100644 --- a/src/main/java/envoy/client/ui/controller/ContactSearchScene.java +++ b/src/main/java/envoy/client/ui/controller/ContactSearchScene.java @@ -57,6 +57,7 @@ public class ContactSearchScene { /** * @param sceneContext enables the user to return to the chat scene + * @param localDB the {@link LocalDB} that is used to save contacts * @since Envoy Client v0.1-beta */ public void initializeData(SceneContext sceneContext, LocalDB localDB) { @@ -67,10 +68,8 @@ public class ContactSearchScene { @FXML private void initialize() { contactList.setCellFactory(e -> new ContactListCell()); - eventBus.register(ContactSearchResult.class, response -> Platform.runLater(() -> { - contactList.getItems().clear(); - contactList.getItems().addAll(response.get()); - })); + eventBus.register(ContactSearchResult.class, + response -> Platform.runLater(() -> { contactList.getItems().clear(); contactList.getItems().addAll(response.get()); })); } /** @@ -115,7 +114,7 @@ public class ContactSearchScene { */ @FXML private void contactListClicked() { - final var contact = contactList.getSelectionModel().getSelectedItem(); + final var contact = contactList.getSelectionModel().getSelectedItem(); if (contact != null) { final var alert = new Alert(AlertType.CONFIRMATION); alert.setTitle("Add Contact to Contact List"); diff --git a/src/main/java/envoy/client/ui/controller/GroupCreationScene.java b/src/main/java/envoy/client/ui/controller/GroupCreationScene.java index af91d91..a9595ee 100644 --- a/src/main/java/envoy/client/ui/controller/GroupCreationScene.java +++ b/src/main/java/envoy/client/ui/controller/GroupCreationScene.java @@ -39,7 +39,7 @@ public class GroupCreationScene { private SceneContext sceneContext; - private static EventBus eventBus = EventBus.getInstance(); + private static EventBus eventBus = EventBus.getInstance(); @FXML private void initialize() { @@ -49,10 +49,11 @@ public class GroupCreationScene { /** * @param sceneContext enables the user to return to the chat scene + * @param localDB the {@link LocalDB} that is used to save contacts * @since Envoy Client v0.1-beta */ public void initializeData(SceneContext sceneContext, LocalDB localDB) { - this.sceneContext = sceneContext; + this.sceneContext = sceneContext; Platform.runLater(() -> contactList.getItems() .addAll(localDB.getUsers() .values() diff --git a/src/main/java/envoy/client/ui/controller/LoginScene.java b/src/main/java/envoy/client/ui/controller/LoginScene.java index f015b6e..fbd8580 100644 --- a/src/main/java/envoy/client/ui/controller/LoginScene.java +++ b/src/main/java/envoy/client/ui/controller/LoginScene.java @@ -3,6 +3,7 @@ package envoy.client.ui.controller; import java.io.FileNotFoundException; import java.io.IOException; import java.util.concurrent.TimeoutException; +import java.util.logging.Level; import java.util.logging.Logger; import javafx.application.Platform; @@ -54,11 +55,11 @@ public final class LoginScene { @FXML private Label connectionLabel; - private Client client; - private LocalDB localDB; - private Cache receivedMessageCache; + private Client client; + private LocalDB localDB; + private Cache receivedMessageCache; private Cache receivedMessageStatusChangeEventCache; - private SceneContext sceneContext; + private SceneContext sceneContext; private static final Logger logger = EnvoyLog.getLogger(LoginScene.class); private static final EventBus eventBus = EventBus.getInstance(); @@ -76,22 +77,28 @@ public final class LoginScene { /** * Loads the login dialog using the FXML file {@code LoginDialog.fxml}. * - * @param client the client used to perform the handshake - * @param localDB the local database used for offline login - * @param receivedMessageCache the cache storing messages received during - * the handshake - * @param receivedMessageStatusChangeEventCache the cache storing messageStatusChangeEvents received during handshake - * @param sceneContext the scene context used to initialize the chat - * scene + * @param client the client used to perform the + * handshake + * @param localDB the local database used for + * offline login + * @param receivedMessageCache the cache storing messages + * received during + * the handshake + * @param receivedMessageStatusChangeEventCache the cache storing + * messageStatusChangeEvents + * received during handshake + * @param sceneContext the scene context used to + * initialize the chat + * scene * @since Envoy Client v0.1-beta */ public void initializeData(Client client, LocalDB localDB, Cache receivedMessageCache, Cache receivedMessageStatusChangeEventCache, SceneContext sceneContext) { - this.client = client; - this.localDB = localDB; - this.receivedMessageCache = receivedMessageCache; + this.client = client; + this.localDB = localDB; + this.receivedMessageCache = receivedMessageCache; this.receivedMessageStatusChangeEventCache = receivedMessageStatusChangeEventCache; - this.sceneContext = sceneContext; + this.sceneContext = sceneContext; // Prepare handshake localDB.loadIDGenerator(); @@ -129,7 +136,7 @@ public final class LoginScene { @FXML private void abortLogin() { - logger.info("The login process has been cancelled. Exiting..."); + logger.log(Level.INFO, "The login process has been cancelled. Exiting..."); System.exit(0); } @@ -141,8 +148,8 @@ public final class LoginScene { loadChatScene(); } } catch (IOException | InterruptedException | TimeoutException e) { - logger.warning("Could not connect to server: " + e); - logger.finer("Attempting offline mode..."); + logger.log(Level.WARNING, "Could not connect to server: ", e); + logger.log(Level.FINER, "Attempting offline mode..."); attemptOfflineMode(credentials); } } @@ -158,6 +165,7 @@ public final class LoginScene { loadChatScene(); } catch (final Exception e) { new Alert(AlertType.ERROR, "Client error: " + e).showAndWait(); + logger.log(Level.SEVERE, "Offline mode could not be loaded: ", e); System.exit(1); } } @@ -176,6 +184,7 @@ public final class LoginScene { } catch (final Exception e) { e.printStackTrace(); new Alert(AlertType.ERROR, "Error while loading local database: " + e + "\nChats will not be stored locally.").showAndWait(); + logger.log(Level.WARNING, "Could not load local database: ", e); } // Initialize write proxy From 6dda2cce71695a1ea3ca14676c2041ecbfa29d3e Mon Sep 17 00:00:00 2001 From: delvh Date: Sat, 13 Jun 2020 22:38:49 +0200 Subject: [PATCH 03/13] Fixed multiple bugs concerning enterToSend and the postButton --- .../envoy/client/ui/controller/ChatScene.java | 57 +++++++++++++------ src/main/resources/fxml/ChatScene.fxml | 2 +- 2 files changed, 41 insertions(+), 18 deletions(-) diff --git a/src/main/java/envoy/client/ui/controller/ChatScene.java b/src/main/java/envoy/client/ui/controller/ChatScene.java index 0662929..08e1501 100644 --- a/src/main/java/envoy/client/ui/controller/ChatScene.java +++ b/src/main/java/envoy/client/ui/controller/ChatScene.java @@ -197,6 +197,34 @@ public final class ChatScene { sceneContext.getController().initializeData(sceneContext, localDB); } + /** + * Checks the text length of the {@code messageTextArea}, adjusts the + * {@code remainingChars} - Label and checks whether to send the message + * automatically. + * + * @param e the keys that have been entered + * @since Envoy Client v0.1-beta + */ + @FXML + private void checkKeyCombination(KeyEvent e) { + // checks whether the text is too long + messageTextUpdated(); + // Automatic sending of messages via (ctrl +) enter + checkPostConditions(e); + } + + /** + * @param e the keys that have been pressed + * @since Envoy Client v0.1-beta + */ + @FXML + private void checkPostConditions(KeyEvent e) { + if (!postButton.isDisabled() && settings.isEnterToSend() && e.getCode() == KeyCode.ENTER + || !settings.isEnterToSend() && e.getCode() == KeyCode.ENTER && e.isControlDown()) + postMessage(); + postButton.setDisable(messageTextArea.getText().isBlank() || currentChat == null); + } + /** * Actions to perform when the text was updated in the messageTextArea. * @@ -210,29 +238,21 @@ public final class ChatScene { messageTextArea.positionCaret(MAX_MESSAGE_LENGTH); messageTextArea.setScrollTop(Double.MAX_VALUE); } + designRemainingCharsLabel(); + } - // Redesigning the remainingChars - Label + /** + * Sets the text and text-color of the {@code remainingChars} - Label. + * + * @since Envoy Client v0.1-beta + */ + private void designRemainingCharsLabel() { final int currentLength = messageTextArea.getText().length(); final int remainingLength = MAX_MESSAGE_LENGTH - currentLength; remainingChars.setText(String.format("remaining chars: %d/%d", remainingLength, MAX_MESSAGE_LENGTH)); remainingChars.setTextFill(Color.rgb(currentLength, remainingLength, 0, 1)); } - /** - * Actions to perform when a key has been entered. - * - * @param e the Keys that have been entered - * @since Envoy Client v0.1-beta - */ - @FXML - private void checkKeyCombination(KeyEvent e) { - // Automatic sending of messages via (ctrl +) enter - if (!postButton.isDisabled() && settings.isEnterToSend() && e.getCode() == KeyCode.ENTER - || !settings.isEnterToSend() && e.getCode() == KeyCode.ENTER && e.isControlDown()) - postMessage(); - postButton.setDisable(messageTextArea.getText().isBlank() || currentChat == null); - } - /** * Sends a new message to the server based on the text entered in the * messageTextArea. @@ -241,10 +261,12 @@ public final class ChatScene { */ @FXML private void postMessage() { + final var text = messageTextArea.getText().strip(); + if (text.isBlank()) throw new IllegalArgumentException("A message without visible text can not be sent."); try { // Create and send message final var message = new MessageBuilder(localDB.getUser().getID(), currentChat.getRecipient().getID(), localDB.getIDGenerator()) - .setText(messageTextArea.getText().strip()) + .setText(text) .build(); // Send message @@ -264,5 +286,6 @@ public final class ChatScene { // Clear text field and disable post button messageTextArea.setText(""); postButton.setDisable(true); + designRemainingCharsLabel(); } } diff --git a/src/main/resources/fxml/ChatScene.fxml b/src/main/resources/fxml/ChatScene.fxml index aab77a6..5323930 100644 --- a/src/main/resources/fxml/ChatScene.fxml +++ b/src/main/resources/fxml/ChatScene.fxml @@ -27,7 +27,7 @@ - - - + + + + + + + From d20d72f6e26ae15c59bf0fd824b5503fefd64cbb Mon Sep 17 00:00:00 2001 From: delvh Date: Fri, 19 Jun 2020 16:57:20 +0200 Subject: [PATCH 07/13] Fixed invisibility bug --- src/main/resources/css/dark.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/resources/css/dark.css b/src/main/resources/css/dark.css index 0e92317..1f8d181 100644 --- a/src/main/resources/css/dark.css +++ b/src/main/resources/css/dark.css @@ -18,7 +18,7 @@ -fx-background-color: lightgray; } -.list-view, .list-cell, .label, .text-area .content, .tooltip, .pane, .pane .content, .vbox, .titled-pane > .title, .titled-pane > *.content { +.list-view, .list-cell, .label, .text-area .content, .text-field, .password-field, .tooltip, .pane, .pane .content, .vbox, .titled-pane > .title, .titled-pane > *.content { -fx-background-color: dimgray; } From dda9e8ee25d7ccc30ce1bf7cd68a6a46b561db89 Mon Sep 17 00:00:00 2001 From: delvh Date: Fri, 19 Jun 2020 16:58:37 +0200 Subject: [PATCH 08/13] Fixed incorrect logger statement No one needs redundancy in a logging statement, right? Co-authored-by: CyB3RC0nN0R --- src/main/java/envoy/client/ui/Startup.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/envoy/client/ui/Startup.java b/src/main/java/envoy/client/ui/Startup.java index 5c106a5..40256c0 100644 --- a/src/main/java/envoy/client/ui/Startup.java +++ b/src/main/java/envoy/client/ui/Startup.java @@ -75,7 +75,7 @@ public final class Startup extends Application { EnvoyLog.setFileLevelBarrier(config.getFileLevelBarrier()); EnvoyLog.setConsoleLevelBarrier(config.getConsoleLevelBarrier()); - logger.log(Level.INFO, "Envoy was started at " + new Date()); + logger.log(Level.INFO, "Envoy starting..."); // Initialize the local database if (config.isIgnoreLocalDB()) { From 549198f242b5017d355484a99cf6633ff27a1a5a Mon Sep 17 00:00:00 2001 From: delvh Date: Sat, 20 Jun 2020 22:29:32 +0200 Subject: [PATCH 09/13] Apply suggestions from code review Reworded the suggestions slightly --- src/main/java/envoy/client/ui/Startup.java | 2 +- src/main/java/envoy/client/ui/controller/ChatScene.java | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/main/java/envoy/client/ui/Startup.java b/src/main/java/envoy/client/ui/Startup.java index 40256c0..1427a19 100644 --- a/src/main/java/envoy/client/ui/Startup.java +++ b/src/main/java/envoy/client/ui/Startup.java @@ -117,7 +117,7 @@ public final class Startup extends Application { logger.log(Level.INFO, "Saving local database and settings..."); localDB.save(); Settings.getInstance().save(); - logger.log(Level.INFO, "Envoy was stopped as expected at " + new Date()); + logger.log(Level.INFO, "Envoy was terminated by its user; } catch (final Exception e) { logger.log(Level.SEVERE, "Unable to save local files: ", e); } diff --git a/src/main/java/envoy/client/ui/controller/ChatScene.java b/src/main/java/envoy/client/ui/controller/ChatScene.java index 5195b08..4dbca92 100644 --- a/src/main/java/envoy/client/ui/controller/ChatScene.java +++ b/src/main/java/envoy/client/ui/controller/ChatScene.java @@ -292,7 +292,7 @@ public final class ChatScene { if (!localDB.getIDGenerator().hasNext() && client.isOnline()) client.requestIdGenerator(); } catch (final IOException e) { - logger.log(Level.SEVERE, "Error sending message: ", e); + logger.log(Level.SEVERE, "Error while sending message: ", e); new Alert(AlertType.ERROR, "An error occured while sending the message!").showAndWait(); } From f073b6e39715bdc42e324b57bab44f30618e41c6 Mon Sep 17 00:00:00 2001 From: delvh Date: Sat, 20 Jun 2020 22:42:44 +0200 Subject: [PATCH 10/13] Fixed error caused by my own stupidity --- src/main/java/envoy/client/ui/Startup.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/envoy/client/ui/Startup.java b/src/main/java/envoy/client/ui/Startup.java index 1427a19..8f00f74 100644 --- a/src/main/java/envoy/client/ui/Startup.java +++ b/src/main/java/envoy/client/ui/Startup.java @@ -117,7 +117,7 @@ public final class Startup extends Application { logger.log(Level.INFO, "Saving local database and settings..."); localDB.save(); Settings.getInstance().save(); - logger.log(Level.INFO, "Envoy was terminated by its user; + logger.log(Level.INFO, "Envoy was terminated by its user"); } catch (final Exception e) { logger.log(Level.SEVERE, "Unable to save local files: ", e); } From b23ee61506bca4fa3d574f8653a76ba8e1dd2653 Mon Sep 17 00:00:00 2001 From: delvh Date: Sun, 21 Jun 2020 17:04:27 +0200 Subject: [PATCH 11/13] Moved remainingCharsLabel styling from code to CSS --- src/main/java/envoy/client/ui/controller/ChatScene.java | 4 ---- src/main/resources/css/base.css | 6 ++++++ src/main/resources/fxml/ChatScene.fxml | 2 +- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/src/main/java/envoy/client/ui/controller/ChatScene.java b/src/main/java/envoy/client/ui/controller/ChatScene.java index bcfbcc3..0f8b0b0 100644 --- a/src/main/java/envoy/client/ui/controller/ChatScene.java +++ b/src/main/java/envoy/client/ui/controller/ChatScene.java @@ -85,10 +85,6 @@ public final class ChatScene { messageList.setCellFactory(listView -> new MessageListCell()); userList.setCellFactory(listView -> new ContactListCell()); - // Unfortunately, remainingChars.setTextFill(...) does not work as it is most - // likely overridden by CSS - remainingChars.setStyle("-fx-text-fill: #00FF00; -fx-opacity: 1; -fx-background-color: transparent;"); - // Listen to received messages eventBus.register(MessageCreationEvent.class, e -> { final var message = e.get(); diff --git a/src/main/resources/css/base.css b/src/main/resources/css/base.css index aa2b6fb..43b5c3a 100644 --- a/src/main/resources/css/base.css +++ b/src/main/resources/css/base.css @@ -6,3 +6,9 @@ -fx-scale-x: 1.05; -fx-scale-y: 1.05; } + +#remainingCharsLabel { + -fx-text-fill: #00FF00; + -fx-opacity: 1; + -fx-background-color: transparent; +} diff --git a/src/main/resources/fxml/ChatScene.fxml b/src/main/resources/fxml/ChatScene.fxml index 45067b4..9d95fba 100644 --- a/src/main/resources/fxml/ChatScene.fxml +++ b/src/main/resources/fxml/ChatScene.fxml @@ -76,7 +76,7 @@ -