Merge pull request #28 from informatik-ag-ngl/b/message_synchronization

Fixed bugs related to message synchronization

src/main/java/envoy/client/LocalDB.java

@@ -30,18 +30,23 @@ import envoy.schema.User;
  * @since Envoy v0.1-alpha
  */
 public class LocalDB {
+
 	private File			localDB;
 	private User			sender;
 	private List<Chat>		chats			= new ArrayList<>();
 	private ObjectFactory	objectFactory	= new ObjectFactory();
 	private DatatypeFactory	datatypeFactory;
 
+	private Sync	unreadMessagesSync	= objectFactory.createSync();
+	private Sync	sync				= objectFactory.createSync();
+	private Sync	readMessages		= objectFactory.createSync();
+
 	/**
 	 * Constructs an empty local database.
 	 *
 	 * @param client the user that is logged in with this client
 	 * @since Envoy v0.1-alpha
-	 **/
+	 */
 
 	public LocalDB(User sender) {
 		this.sender = sender;
@@ -52,7 +57,6 @@ public class LocalDB {
 		}
 	}
 
-
 	/**
 	 * Initializes the local database and fills it with values
 	 * if the user has already sent or received messages.
@@ -60,10 +64,10 @@ public class LocalDB {
 	 * @param localDBDir the directory where we wish to save/load the database from.
 	 * @throws EnvoyException if the directory selected is not an actual directory.
 	 * @since Envoy v0.1-alpha
-	 **/
+	 */
 	public void initializeDBFile(File localDBDir) throws EnvoyException {
-		if (localDBDir.exists() && !localDBDir.isDirectory()) throw new EnvoyException(
+		if (localDBDir.exists() && !localDBDir.isDirectory())
-				String.format("LocalDBDir '%s' is not a directory!", localDBDir.getAbsolutePath()));
+			throw new EnvoyException(String.format("LocalDBDir '%s' is not a directory!", localDBDir.getAbsolutePath()));
 		localDB = new File(localDBDir, sender.getID() + ".db");
 		if (localDB.exists()) loadFromLocalDB();
 	}
@@ -73,7 +77,7 @@ public class LocalDB {
 	 *
 	 * @throws IOException if something went wrong during saving
 	 * @since Envoy v0.1-alpha
-	 **/
+	 */
 	public void saveToLocalDB() {
 		try {
 			localDB.getParentFile().mkdirs();
@@ -95,7 +99,7 @@ public class LocalDB {
 	 *
 	 * @throws EnvoyException if something fails while loading.
 	 * @since Envoy v0.1-alpha
-	 **/
+	 */
 	@SuppressWarnings("unchecked")
 	private void loadFromLocalDB() throws EnvoyException {
 		try (ObjectInputStream in = new ObjectInputStream(new FileInputStream(localDB))) {
@@ -130,18 +134,10 @@ public class LocalDB {
 		return message;
 	}
 
-	private Sync	unreadMessagesSync	= objectFactory.createSync();
-	public Sync		sync				= objectFactory.createSync();
-	public Sync		readMessages		= objectFactory.createSync();
-
 	public Sync fillSync(long userId) {
-
 		addWaitingMessagesToSync();
 
-		getSentStateMessagesFromLocalDB();
+		sync.getMessages().addAll(readMessages.getMessages());
-		for (int i = 0; i < readMessages.getMessages().size(); i++) {
-			sync.getMessages().add(readMessages.getMessages().get(i));
-		}
 		readMessages.getMessages().clear();
 
 		System.out.println(sync.getMessages().size());
@@ -156,47 +152,29 @@ public class LocalDB {
 				// SENT)
 				for (int j = 0; j < sync.getMessages().size(); j++) {
 					if (j == i) {
-						sync.getMessages()
+						sync.getMessages().get(j).getMetadata().setMessageId(returnSync.getMessages().get(j).getMetadata().getMessageId());
-							.get(j)
+						sync.getMessages().get(j).getMetadata().setState(returnSync.getMessages().get(j).getMetadata().getState());
-							.getMetadata()
-							.setMessageId(returnSync.getMessages().get(j).getMetadata().getMessageId());
-						sync.getMessages()
-							.get(j)
-							.getMetadata()
-							.setState(returnSync.getMessages().get(j).getMetadata().getState());
 					}
-
 				}
-
 			}
-			if (returnSync.getMessages().get(i).getMetadata().getMessageId() != 0
+			if (returnSync.getMessages().get(i).getMetadata().getMessageId() != 0 && returnSync.getMessages().get(i).getMetadata().getSender() != 0
-					&& returnSync.getMessages().get(i).getMetadata().getSender() != 0
 					&& returnSync.getMessages().get(i).getMetadata().getState() == MessageState.RECEIVED) {
 				// these are the unread Messages from the server
 				unreadMessagesSync.getMessages().add(returnSync.getMessages().get(i));
-
 			}
 
-			if (returnSync.getMessages().get(i).getMetadata().getMessageId() != 0
+			if (returnSync.getMessages().get(i).getMetadata().getMessageId() != 0 && returnSync.getMessages().get(i).getMetadata().getSender() == 0
-					&& returnSync.getMessages().get(i).getMetadata().getSender() == 0
 					&& returnSync.getMessages().get(i).getMetadata().getState() == MessageState.RECEIVED) {
 				// Update Messages in localDB to state RECEIVED
 				for (int j = 0; j < getChats().size(); j++) {
-					if (getChats().get(j)
+					if (getChats().get(j).getRecipient().getID() == returnSync.getMessages().get(i).getMetadata().getRecipient()) {
-						.getRecipient()
-						.getID() == returnSync.getMessages().get(i).getMetadata().getRecipient()) {
 						for (int k = 0; k < getChats().get(j).getModel().getSize(); k++) {
-							if (getChats().get(j).getModel().get(k).getMetadata().getMessageId() == returnSync
+							if (getChats().get(j).getModel().get(k).getMetadata().getMessageId() == returnSync.getMessages()
-								.getMessages()
 								.get(i)
 								.getMetadata()
 								.getMessageId()) {
 								// Update Message in LocalDB
-								getChats().get(j)
+								getChats().get(j).getModel().get(k).getMetadata().setState(returnSync.getMessages().get(j).getMetadata().getState());
-									.getModel()
-									.get(k)
-									.getMetadata()
-									.setState(returnSync.getMessages().get(j).getMetadata().getState());
 							}
 						}
 					}
@@ -210,31 +188,22 @@ public class LocalDB {
 				System.out.println("Message with ID: " + returnSync.getMessages().get(i).getMetadata().getMessageId()
 						+ "was initialized to be set to READ in localDB.");
 				for (int j = 0; j < getChats().size(); j++) {
-					if (getChats().get(j)
+					if (getChats().get(j).getRecipient().getID() == returnSync.getMessages().get(i).getMetadata().getRecipient()) {
-						.getRecipient()
-						.getID() == returnSync.getMessages().get(i).getMetadata().getRecipient()) {
 						System.out.println("Chat with: " + getChats().get(j).getRecipient().getID() + "was selected.");
 						for (int k = 0; k < getChats().get(j).getModel().getSize(); k++) {
-							if (getChats().get(j).getModel().get(k).getMetadata().getMessageId() == returnSync
+							if (getChats().get(j).getModel().get(k).getMetadata().getMessageId() == returnSync.getMessages()
-								.getMessages()
 								.get(i)
 								.getMetadata()
 								.getMessageId()) {
-								System.out.println("Message with ID: "
+								System.out.println(
-										+ getChats().get(j).getModel().get(k).getMetadata().getMessageId()
+										"Message with ID: " + getChats().get(j).getModel().get(k).getMetadata().getMessageId() + "was selected.");
-										+ "was selected.");
+								getChats().get(j).getModel().get(k).getMetadata().setState(returnSync.getMessages().get(i).getMetadata().getState());
-								getChats().get(j)
+								System.out
-									.getModel()
+									.println("Message State is now: " + getChats().get(j).getModel().get(k).getMetadata().getState().toString());
-									.get(k)
-									.getMetadata()
-									.setState(returnSync.getMessages().get(i).getMetadata().getState());
-								System.out.println("Message State is now: "
-										+ getChats().get(j).getModel().get(k).getMetadata().getState().toString());
 							}
 						}
 					}
 				}
-
 			}
 		}
 
@@ -251,25 +220,8 @@ public class LocalDB {
 
 		sync.getMessages().clear();
 		sync.getUsers().clear();
-
 	}
 
-	/**
-	 * Adds a message to the "sync" Sync object.
-	 * 
-	 * @param message
-	 * @since Envoy v0.1-alpha
-	 */
-	public void addMessageToSync(Message message) { sync.getMessages().add(message); }
-
-	/**
-	 * Adds a user to the {@code sync} {@link Sync} object.
-	 * 
-	 * @param user
-	 * @since Envoy v0.1-alpha
-	 */
-	public void addUserToSync(User user) { sync.getUsers().add(user); }
-
 	/**
 	 * Adds the unread messages returned from the server in the latest sync to the
 	 * right chats in the LocalDB.
@@ -281,34 +233,16 @@ public class LocalDB {
 		Sync unreadMessages = unreadMessagesSync;
 		for (int i = 0; i < unreadMessages.getMessages().size(); i++)
 			for (int j = 0; j < getChats().size(); j++)
-				if (getChats().get(j)
+				if (getChats().get(j).getRecipient().getID() == unreadMessages.getMessages().get(i).getMetadata().getSender()) {
-					.getRecipient()
-					.getID() == unreadMessages.getMessages().get(i).getMetadata().getSender()) {
 					getChats().get(j).appendMessage(unreadMessages.getMessages().get(i));
 				}
 	}
 
 	/**
-	 * Gets all messages with state SENT from the LocalDB and adds them to the
+	 * Changes all messages with state {@code RECEIVED} of a specific chat to state
-	 * "sync" Sync object.
+	 * {@code READ}.
-	 * 
-	 * @param localDB
-	 * @since Envoy v0.1-alpha
-	 */
-	public void getSentStateMessagesFromLocalDB() {
-		for (int i = 0; i < getChats().size(); i++) {
-			for (int j = 0; j < getChats().get(i).getModel().getSize(); j++) {
-				if (getChats().get(i).getModel().get(j).getMetadata().getState() == MessageState.SENT) {
-					addMessageToSync(getChats().get(i).getModel().get(j));
-				}
-			}
-		}
-	}
-
-	/**
-	 * Changes all messages with State RECEIVED of a specific chat to State READ.
 	 * <br>
-	 * Adds these Messages to the {@code readMessages} {@link Sync} object.
+	 * Adds these messages to the {@code readMessages} {@link Sync} object.
 	 * 
 	 * @param currentChat
 	 * @since Envoy v0.1-alpha
@@ -323,29 +257,17 @@ public class LocalDB {
 	}
 
 	/**
-	 * Adds a message with State WAITING to a specific chat in the LocalDB.
+	 * Adds all messages with state {@code WAITING} from the {@link LocalDB} to the
+	 * {@link Sync} object.
 	 * 
-	 * @param message
-	 * @param currentChat
 	 * @since Envoy v0.1-alpha
 	 */
-	public void addWaitingMessageToLocalDB(Message message, Chat currentChat) { currentChat.appendMessage(message); }
+	private void addWaitingMessagesToSync() {
-
+		for (Chat chat : getChats())
-	/**
+			for (int i = 0; i < chat.getModel().size(); i++)
-	 * Adds all messages with State WAITING from the {@link LocalDB} to the Sync.
+				if (chat.getModel().get(i).getMetadata().getState() == MessageState.WAITING) {
-	 * 
-	 * @param localDB
-	 * @since Envoy v0.1-alpha
-	 */
-	public void addWaitingMessagesToSync() {
-		for (int i = 0; i < getChats().size(); i++) {
-			for (int j = 0; j < getChats().get(i).getModel().getSize(); j++) {
-				if (getChats().get(i).getModel().get(j).getMetadata().getState() == MessageState.WAITING) {
-					// addMessageToSync(localDB.getChats().get(i).getModel().get(j));
 					System.out.println("Got Waiting Message");
-					sync.getMessages().add(0, getChats().get(i).getModel().get(j));
+					sync.getMessages().add(chat.getModel().get(i));
-				}
-			}
 				}
 	}
 
@@ -364,7 +286,7 @@ public class LocalDB {
 	public List<Chat> getChats() { return chats; }
 
 	/**
-	 * @return the User who initialised the local Database
+	 * @return the {@link User} who initialized the local database
 	 * @since Envoy v0.1-alpha
 	 */
 	public User getUser() { return sender; }

src/main/java/envoy/client/ui/ChatWindow.java

@@ -223,7 +223,7 @@ public class ChatWindow extends JFrame {
 					.get();
 
 				// Set all unread messages in the chat to read
-				if (currentChat != null) { localDB.setMessagesToRead(currentChat); }
+				readCurrentChat();
 
 				client.setRecipient(user);
 
@@ -269,7 +269,7 @@ public class ChatWindow extends JFrame {
 
 			// Create and send message object
 			final Message message = localDB.createMessage(messageEnterTextArea.getText(), currentChat.getRecipient());
-			localDB.addWaitingMessageToLocalDB(message, currentChat);
+			currentChat.appendMessage(message);
 			messageList.setModel(currentChat.getModel());
 
 			// Clear text field
@@ -306,7 +306,8 @@ public class ChatWindow extends JFrame {
 	}
 
 	/**
-	 * Updates the data model and the ui every x seconds.
+	 * Updates the data model and the UI repeatedly after a certain amount of
+	 * time.
 	 * 
 	 * @param timeout the amount of time that passes between two requests sent to
 	 *                the server
@@ -319,9 +320,14 @@ public class ChatWindow extends JFrame {
 				// Synchronize
 				localDB.applySync(
 						client.sendSync(client.getSender().getID(), localDB.fillSync(client.getSender().getID())));
+
+				// Process unread messages
 				localDB.addUnreadMessagesToLocalDB();
 				localDB.clearUnreadMessagesSync();
 
+				// Mark unread messages as read when they are in the current chat
+				readCurrentChat();
+
 				// Update UI
 				SwingUtilities
 					.invokeLater(() -> { updateUserStates(); contentPane.revalidate(); contentPane.repaint(); });
@@ -335,4 +341,9 @@ public class ChatWindow extends JFrame {
 				if (userList.getModel().getElementAt(i).getID() == localDB.getChats().get(j).getRecipient().getID())
 					userList.getModel().getElementAt(i).setStatus(localDB.getChats().get(j).getRecipient().getStatus());
 	}
+
+	/**
+	 * Marks messages in the current chat as {@code READ}.
+	 */
+	private void readCurrentChat() { if (currentChat != null) { localDB.setMessagesToRead(currentChat); } }
 }