Contact Deletion #97

Merged
delvh merged 6 commits from f/contact-deletion into develop 2020-10-19 18:09:21 +02:00
30 changed files with 602 additions and 199 deletions

View File

@ -21,11 +21,12 @@ import envoy.event.MessageStatusChange;
*/ */
public class Chat implements Serializable { public class Chat implements Serializable {
protected final Contact recipient;
protected transient ObservableList<Message> messages = FXCollections.observableArrayList(); protected transient ObservableList<Message> messages = FXCollections.observableArrayList();
protected int unreadAmount; protected int unreadAmount;
protected boolean disabled;
protected final Contact recipient;
kske marked this conversation as resolved
Review

Why is this private even though we permit subclassing here?

Why is this `private` even though we permit subclassing here?
Review

Because we don't need to access this in subclasses. Subclasses themselves should never disable themselves.

Because we don't need to access this in subclasses. Subclasses themselves should never disable themselves.
Review

There is a public setter though. The chat can literally be disabled from anywhere.

According to Meyer's open-closed principle (the O in SOLID), software entities should open for extension, while closed for modification. To me, this implies that subclasses should be able to access this value without the use of a getter.

There is a public setter though. The chat can literally be disabled from anywhere. According to Meyer's open-closed principle (the O in SOLID), software entities should open for extension, while closed for modification. To me, this implies that subclasses should be able to access this value without the use of a getter.
Review

The problem I have with this is that in this case it is literally intended that they are modified from outside and that they do not modify themselves.

The problem I have with this is that in this case it is literally intended that they are modified from outside and that they **do not modify themselves**.
/** /**
* Stores the last time an {@link envoy.event.IsTyping} event has been sent. * Stores the last time an {@link envoy.event.IsTyping} event has been sent.
@ -55,7 +56,15 @@ public class Chat implements Serializable {
} }
@Override @Override
public String toString() { return String.format("%s[recipient=%s,messages=%d]", getClass().getSimpleName(), recipient, messages.size()); } public String toString() {
return String.format(
"%s[recipient=%s,messages=%d,disabled=%b]",
delvh marked this conversation as resolved Outdated
Outdated
Review

There is an unnecessary space in the template.

There is an unnecessary space in the template.
getClass().getSimpleName(),
recipient,
messages.size(),
disabled
);
}
/** /**
* Generates a hash code based on the recipient. * Generates a hash code based on the recipient.
@ -90,11 +99,13 @@ public class Chat implements Serializable {
public void read(WriteProxy writeProxy) { public void read(WriteProxy writeProxy) {
for (int i = messages.size() - 1; i >= 0; --i) { for (int i = messages.size() - 1; i >= 0; --i) {
final var m = messages.get(i); final var m = messages.get(i);
if (m.getSenderID() == recipient.getID()) if (m.getStatus() == MessageStatus.READ) break; if (m.getSenderID() == recipient.getID())
else { if (m.getStatus() == MessageStatus.READ)
m.setStatus(MessageStatus.READ); break;
writeProxy.writeMessageStatusChange(new MessageStatusChange(m)); else {
} m.setStatus(MessageStatus.READ);
writeProxy.writeMessageStatusChange(new MessageStatusChange(m));
}
} }
unreadAmount = 0; unreadAmount = 0;
} }
@ -168,4 +179,22 @@ public class Chat implements Serializable {
* @since Envoy Client v0.2-beta * @since Envoy Client v0.2-beta
*/ */
delvh marked this conversation as resolved Outdated
Outdated
Review

Use 'chat' here instead.

Use 'chat' here instead.
public void lastWritingEventWasNow() { lastWritingEvent = System.currentTimeMillis(); } public void lastWritingEventWasNow() { lastWritingEvent = System.currentTimeMillis(); }
/**
* Determines whether messages can be sent in this chat. Should be {@code true}
* i.e. for chats whose recipient deleted this client as a contact.
*
* @return whether this chat has been disabled
* @since Envoy Client v0.3-beta
*/
delvh marked this conversation as resolved
Review

Doesn't sound very conclusive to me.

Doesn't sound very conclusive to me.
public boolean isDisabled() { return disabled; }
/**
* Determines whether messages can be sent in this chat. Should be true i.e. for
* chats whose recipient deleted this client as a contact.
*
* @param disabled whether this chat should be disabled
* @since Envoy Client v0.3-beta
*/
public void setDisabled(boolean disabled) { this.disabled = disabled; }
} }

View File

@ -25,7 +25,7 @@ public final class GroupChat extends Chat {
* @param recipient the group whose members receive the messages * @param recipient the group whose members receive the messages
* @since Envoy Client v0.1-beta * @since Envoy Client v0.1-beta
*/ */
public GroupChat(User sender, Contact recipient) { public GroupChat(User sender, Group recipient) {
super(recipient); super(recipient);
this.sender = sender; this.sender = sender;
} }

View File

@ -1,11 +1,14 @@
package envoy.client.data; package envoy.client.data;
import static java.util.function.Predicate.not;
import java.io.*; import java.io.*;
import java.nio.channels.*; import java.nio.channels.*;
import java.nio.file.StandardOpenOption; import java.nio.file.StandardOpenOption;
import java.time.Instant; import java.time.Instant;
import java.util.*; import java.util.*;
import java.util.logging.*; import java.util.logging.*;
import java.util.stream.Stream;
import javafx.application.Platform; import javafx.application.Platform;
import javafx.collections.*; import javafx.collections.*;
@ -14,6 +17,7 @@ import envoy.client.event.*;
import envoy.data.*; import envoy.data.*;
import envoy.data.Message.MessageStatus; import envoy.data.Message.MessageStatus;
import envoy.event.*; import envoy.event.*;
import envoy.event.contact.*;
import envoy.exception.EnvoyException; import envoy.exception.EnvoyException;
import envoy.util.*; import envoy.util.*;
@ -39,6 +43,7 @@ public final class LocalDB implements EventListener {
private IDGenerator idGenerator; private IDGenerator idGenerator;
private CacheMap cacheMap = new CacheMap(); private CacheMap cacheMap = new CacheMap();
private String authToken; private String authToken;
private boolean contactsChanged;
delvh marked this conversation as resolved Outdated
Outdated
Review

Integrate this into loadUserData as discussed.

Integrate this into `loadUserData` as discussed.
// Auto save timer // Auto save timer
private Timer autoSaver; private Timer autoSaver;
@ -136,7 +141,32 @@ public final class LocalDB implements EventListener {
if (user == null) throw new IllegalStateException("Client user is null, cannot initialize user storage"); if (user == null) throw new IllegalStateException("Client user is null, cannot initialize user storage");
userFile = new File(dbDir, user.getID() + ".db"); userFile = new File(dbDir, user.getID() + ".db");
try (var in = new ObjectInputStream(new FileInputStream(userFile))) { try (var in = new ObjectInputStream(new FileInputStream(userFile))) {
chats = FXCollections.observableList((List<Chat>) in.readObject()); chats = FXCollections.observableList((List<Chat>) in.readObject());
// Some chats have changed and should not be overwritten by the saved values
if (contactsChanged) {
delvh marked this conversation as resolved Outdated
Outdated
Review

I think you mean 'overwritten'.

I think you mean 'overwritten'.
Outdated
Review

See here.

See [here](https://www.dict.cc/?s=%C3%BCberschrieben).
Outdated
Review

Past tense of override.

Past tense of override.
Outdated
Review

I know what the past tense of override is.

What you want to prevent here is the destruction of old data by the recording new data over it, which is also known as overwriting.

Look here for a comparison of both terms.

I know what the past tense of override is. What you want to prevent here is the destruction of old data by the recording new data over it, which is also known as overwriting. Look [here](https://wikidiff.com/overwrite/override) for a comparison of both terms.
Outdated
Review

Still, both are applicable here. My preference is overridden, yours is overwritten.
Let's give @DieGurke the vote on what stays in. (How great that we have an odd amount of members, I don't want to imagine disagreements with an even amount of members...)

Still, both are applicable here. My preference is `overridden`, yours is `overwritten`. Let's give @DieGurke the vote on what stays in. (How great that we have an odd amount of members, I don't want to imagine disagreements with an even amount of members...)
final var contacts = user.getContacts();
// Mark chats as disabled if a contact is no longer in this users contact list
final var changedUserChats = chats.stream()
kske marked this conversation as resolved Outdated
Outdated
Review

Can this even happen? If it can, should it be logged?

Can this even happen? If it can, should it be logged?
Outdated
Review

While it could theoretically occur, even if the user deleted a group while being offline, it should not happen.
Removing it now.

While it could theoretically occur, even if the user deleted a group while being offline, it should not happen. Removing it now.
.filter(not(chat -> contacts.contains(chat.getRecipient())))
.peek(chat -> { chat.setDisabled(true); logger.log(Level.INFO, String.format("Deleted chat with %s.", chat.getRecipient())); });
// Also update groups with a different member count
final var changedGroupChats = contacts.stream().filter(Group.class::isInstance).flatMap(group -> {
final var potentialChat = getChat(group.getID());
if (potentialChat.isEmpty()) return Stream.empty();
final var chat = potentialChat.get();
if (group.getContacts().size() != chat.getRecipient().getContacts().size()) {
logger.log(Level.INFO, "Removed one (or more) members from " + group);
return Stream.of(chat);
} else return Stream.empty();
});
Stream.concat(changedUserChats, changedGroupChats).forEach(chat -> chats.set(chats.indexOf(chat), chat));
// loadUserData can get called two (or more?) times during application lifecycle
contactsChanged = false;
}
cacheMap = (CacheMap) in.readObject(); cacheMap = (CacheMap) in.readObject();
lastSync = (Instant) in.readObject(); lastSync = (Instant) in.readObject();
} finally { } finally {
@ -163,7 +193,7 @@ public final class LocalDB implements EventListener {
user.getContacts() user.getContacts()
.stream() .stream()
.filter(c -> !c.equals(user) && getChat(c.getID()).isEmpty()) .filter(c -> !c.equals(user) && getChat(c.getID()).isEmpty())
.map(c -> c instanceof User ? new Chat(c) : new GroupChat(user, c)) .map(c -> c instanceof User ? new Chat(c) : new GroupChat(user, (Group) c))
.forEach(chats::add); .forEach(chats::add);
} }
@ -195,9 +225,9 @@ public final class LocalDB implements EventListener {
* @throws IOException if the saving process failed * @throws IOException if the saving process failed
* @since Envoy Client v0.3-alpha * @since Envoy Client v0.3-alpha
*/ */
@Event(eventType = EnvoyCloseEvent.class, priority = 1000) @Event(eventType = EnvoyCloseEvent.class, priority = 500)
private synchronized void save() { private synchronized void save() {
EnvoyLog.getLogger(LocalDB.class).log(Level.INFO, "Saving local database..."); EnvoyLog.getLogger(LocalDB.class).log(Level.FINER, "Saving local database...");
// Save users // Save users
try { try {
@ -217,33 +247,57 @@ public final class LocalDB implements EventListener {
} }
} }
@Event(priority = 150) @Event(priority = 500)
private void onMessage(Message msg) { if (msg.getStatus() == MessageStatus.SENT) msg.nextStatus(); } private void onMessage(Message msg) { if (msg.getStatus() == MessageStatus.SENT) msg.nextStatus(); }
@Event(priority = 150) @Event(priority = 500)
private void onGroupMessage(GroupMessage msg) { private void onGroupMessage(GroupMessage msg) {
// TODO: Cancel event once EventBus is updated // TODO: Cancel event once EventBus is updated
if (msg.getStatus() == MessageStatus.WAITING || msg.getStatus() == MessageStatus.READ) if (msg.getStatus() == MessageStatus.WAITING || msg.getStatus() == MessageStatus.READ)
logger.warning("The groupMessage has the unexpected status " + msg.getStatus()); logger.warning("The groupMessage has the unexpected status " + msg.getStatus());
} }
@Event(priority = 150) @Event(priority = 500)
private void onMessageStatusChange(MessageStatusChange evt) { getMessage(evt.getID()).ifPresent(msg -> msg.setStatus(evt.get())); } private void onMessageStatusChange(MessageStatusChange evt) { getMessage(evt.getID()).ifPresent(msg -> msg.setStatus(evt.get())); }
@Event(priority = 150) @Event(priority = 500)
private void onGroupMessageStatusChange(GroupMessageStatusChange evt) { private void onGroupMessageStatusChange(GroupMessageStatusChange evt) {
this.<GroupMessage>getMessage(evt.getID()).ifPresent(msg -> msg.getMemberStatuses().replace(evt.getMemberID(), evt.get())); this.<GroupMessage>getMessage(evt.getID()).ifPresent(msg -> msg.getMemberStatuses().replace(evt.getMemberID(), evt.get()));
} }
delvh marked this conversation as resolved Outdated
Outdated
Review

As users only contains users that have locally logged in, this is unnecessary.

As `users` only contains users that have locally logged in, this is unnecessary.
@Event(priority = 150) @Event(priority = 500)
private void onUserStatusChange(UserStatusChange evt) { private void onUserStatusChange(UserStatusChange evt) {
getChat(evt.getID()).map(Chat::getRecipient).map(User.class::cast).ifPresent(u -> u.setStatus(evt.get())); getChat(evt.getID()).map(Chat::getRecipient).map(User.class::cast).ifPresent(u -> u.setStatus(evt.get()));
} }
@Event(priority = 150) @Event(priority = 500)
private void onUserOperation(UserOperation operation) {
final var eventUser = operation.get();
switch (operation.getOperationType()) {
case ADD:
Platform.runLater(() -> chats.add(0, new Chat(eventUser)));
break;
case REMOVE:
getChat(eventUser.getID()).ifPresent(chat -> chat.setDisabled(true));
break;
}
}
@Event
private void onGroupCreationResult(GroupCreationResult evt) {
final var newGroup = evt.get();
// The group creation was not successful
if (newGroup == null) return;
// The group was successfully created
else Platform.runLater(() -> chats.add(new GroupChat(user, newGroup)));
}
@Event(priority = 500)
private void onGroupResize(GroupResize evt) { getChat(evt.getGroupID()).map(Chat::getRecipient).map(Group.class::cast).ifPresent(evt::apply); } private void onGroupResize(GroupResize evt) { getChat(evt.getGroupID()).map(Chat::getRecipient).map(Group.class::cast).ifPresent(evt::apply); }
@Event(priority = 150) @Event(priority = 500)
private void onNameChange(NameChange evt) { private void onNameChange(NameChange evt) {
chats.stream().map(Chat::getRecipient).filter(c -> c.getID() == evt.getID()).findAny().ifPresent(c -> c.setName(evt.get())); chats.stream().map(Chat::getRecipient).filter(c -> c.getID() == evt.getID()).findAny().ifPresent(c -> c.setName(evt.get()));
} }
@ -262,7 +316,7 @@ public final class LocalDB implements EventListener {
* *
* @since Envoy Client v0.2-beta * @since Envoy Client v0.2-beta
*/ */
@Event(eventType = Logout.class, priority = 100) @Event(eventType = Logout.class, priority = 50)
private void onLogout() { private void onLogout() {
autoSaver.cancel(); autoSaver.cancel();
autoSaveRestart = true; autoSaveRestart = true;
@ -296,6 +350,12 @@ public final class LocalDB implements EventListener {
@Event(priority = 500) @Event(priority = 500)
private void onOwnStatusChange(OwnStatusChange statusChange) { user.setStatus(statusChange.get()); } private void onOwnStatusChange(OwnStatusChange statusChange) { user.setStatus(statusChange.get()); }
@Event(eventType = ContactsChangedSinceLastLogin.class, priority = 500)
private void onContactsChangedSinceLastLogin() { contactsChanged = true; }
@Event(priority = 500)
private void onContactDisabled(ContactDisabled event) { getChat(event.get().getID()).ifPresent(chat -> chat.setDisabled(true)); }
/** /**
* @return a {@code Map<String, User>} of all users stored locally with their * @return a {@code Map<String, User>} of all users stored locally with their
* user names as keys * user names as keys

View File

@ -68,7 +68,7 @@ public final class Settings implements EventListener {
* @throws IOException if an error occurs while saving the themes * @throws IOException if an error occurs while saving the themes
* @since Envoy Client v0.2-alpha * @since Envoy Client v0.2-alpha
*/ */
@Event(eventType = EnvoyCloseEvent.class, priority = 900) @Event(eventType = EnvoyCloseEvent.class)
private void save() { private void save() {
EnvoyLog.getLogger(Settings.class).log(Level.INFO, "Saving settings..."); EnvoyLog.getLogger(Settings.class).log(Level.INFO, "Saving settings...");

View File

@ -6,6 +6,7 @@ import envoy.client.data.Context;
import envoy.client.helper.ShutdownHelper; import envoy.client.helper.ShutdownHelper;
import envoy.client.ui.SceneContext.SceneInfo; import envoy.client.ui.SceneContext.SceneInfo;
import envoy.client.util.UserUtil; import envoy.client.util.UserUtil;
import envoy.data.User.UserStatus;
/** /**
* Envoy-specific implementation of the keyboard-shortcut interaction offered by * Envoy-specific implementation of the keyboard-shortcut interaction offered by
@ -40,5 +41,25 @@ public class EnvoyShortcutConfig {
() -> Context.getInstance().getSceneContext().load(SceneInfo.SETTINGS_SCENE), () -> Context.getInstance().getSceneContext().load(SceneInfo.SETTINGS_SCENE),
SceneInfo.SETTINGS_SCENE, SceneInfo.SETTINGS_SCENE,
SceneInfo.LOGIN_SCENE); SceneInfo.LOGIN_SCENE);
// Add option to change to status away
instance.addForNotExcluded(new KeyCodeCombination(KeyCode.A, KeyCombination.CONTROL_DOWN, KeyCombination.SHIFT_DOWN),
() -> UserUtil.changeStatus(UserStatus.AWAY),
SceneInfo.LOGIN_SCENE);
// Add option to change to status busy
instance.addForNotExcluded(new KeyCodeCombination(KeyCode.B, KeyCombination.CONTROL_DOWN, KeyCombination.SHIFT_DOWN),
() -> UserUtil.changeStatus(UserStatus.BUSY),
SceneInfo.LOGIN_SCENE);
// Add option to change to status offline
instance.addForNotExcluded(new KeyCodeCombination(KeyCode.F, KeyCombination.CONTROL_DOWN, KeyCombination.SHIFT_DOWN),
() -> UserUtil.changeStatus(UserStatus.OFFLINE),
SceneInfo.LOGIN_SCENE);
// Add option to change to status online
instance.addForNotExcluded(new KeyCodeCombination(KeyCode.N, KeyCombination.CONTROL_DOWN, KeyCombination.SHIFT_DOWN),
() -> UserUtil.changeStatus(UserStatus.ONLINE),
SceneInfo.LOGIN_SCENE);
} }
} }

View File

@ -0,0 +1,21 @@
package envoy.client.event;
import envoy.data.Contact;
import envoy.event.Event;
/**
* Signifies that the chat of a contact should be disabled.
*
* @author Leon Hofmeister
* @since Envoy Client v0.3-beta
*/
public class ContactDisabled extends Event<Contact> {
private static final long serialVersionUID = 1L;
/**
* @param contact the contact that should be disabled
* @since Envoy Client v0.3-beta
*/
public ContactDisabled(Contact contact) { super(contact); }
}

View File

@ -61,6 +61,7 @@ public final class Client implements EventListener, Closeable {
*/ */
public void performHandshake(LoginCredentials credentials, CacheMap cacheMap) throws TimeoutException, IOException, InterruptedException { public void performHandshake(LoginCredentials credentials, CacheMap cacheMap) throws TimeoutException, IOException, InterruptedException {
if (online) throw new IllegalStateException("Handshake has already been performed successfully"); if (online) throw new IllegalStateException("Handshake has already been performed successfully");
rejected = false;
// Establish TCP connection // Establish TCP connection
logger.log(Level.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()));
@ -75,8 +76,6 @@ public final class Client implements EventListener, Closeable {
receiver.registerProcessor(User.class, sender -> this.sender = sender); receiver.registerProcessor(User.class, sender -> this.sender = sender);
receiver.registerProcessors(cacheMap.getMap()); receiver.registerProcessors(cacheMap.getMap());
rejected = false;
// Start receiver // Start receiver
receiver.start(); receiver.start();
@ -95,7 +94,10 @@ public final class Client implements EventListener, Closeable {
return; return;
} }
if (System.currentTimeMillis() - start > 5000) throw new TimeoutException("Did not log in after 5 seconds"); if (System.currentTimeMillis() - start > 5000) {
rejected = true;
throw new TimeoutException("Did not log in after 5 seconds");
}
Thread.sleep(500); Thread.sleep(500);
} }
delvh marked this conversation as resolved Outdated
Outdated
Review

Maybe set rejected here as well?

Maybe set `rejected` here as well?
@ -146,7 +148,7 @@ public final class Client implements EventListener, Closeable {
logger.log(Level.FINE, "Sending " + obj); logger.log(Level.FINE, "Sending " + obj);
try { try {
SerializationUtils.writeBytesWithLength(obj, socket.getOutputStream()); SerializationUtils.writeBytesWithLength(obj, socket.getOutputStream());
} catch (IOException e) { } catch (final IOException e) {
throw new RuntimeException(e); throw new RuntimeException(e);
} }
} }
@ -177,7 +179,7 @@ public final class Client implements EventListener, Closeable {
private void onHandshakeRejection() { rejected = true; } private void onHandshakeRejection() { rejected = true; }
@Override @Override
@Event(eventType = EnvoyCloseEvent.class, priority = 800) @Event(eventType = EnvoyCloseEvent.class, priority = 50)
public void close() { public void close() {
if (online) { if (online) {
logger.log(Level.INFO, "Closing connection..."); logger.log(Level.INFO, "Closing connection...");

View File

@ -16,5 +16,7 @@ public final class GroupSizeLabel extends Label {
* @param recipient the group whose members to show * @param recipient the group whose members to show
* @since Envoy Client v0.3-beta * @since Envoy Client v0.3-beta
*/ */
public GroupSizeLabel(Group recipient) { super(recipient.getContacts().size() + " members"); } public GroupSizeLabel(Group recipient) {
super(recipient.getContacts().size() + " member" + (recipient.getContacts().size() != 1 ? "s" : ""));
delvh marked this conversation as resolved
Review

We could just use parentheses, but I guess this is less ambiguous.

We could just use parentheses, but I guess this is less ambiguous.
}
} }

View File

@ -37,7 +37,7 @@ import envoy.data.*;
import envoy.data.Attachment.AttachmentType; import envoy.data.Attachment.AttachmentType;
import envoy.data.Message.MessageStatus; import envoy.data.Message.MessageStatus;
import envoy.event.*; import envoy.event.*;
import envoy.event.contact.ContactOperation; import envoy.event.contact.UserOperation;
import envoy.exception.EnvoyException; import envoy.exception.EnvoyException;
import envoy.util.EnvoyLog; import envoy.util.EnvoyLog;
@ -91,9 +91,6 @@ public final class ChatScene implements EventListener, Restorable {
@FXML @FXML
private Label topBarStatusLabel; private Label topBarStatusLabel;
@FXML
private MenuItem deleteContactMenuItem;
@FXML @FXML
private ImageView attachmentView; private ImageView attachmentView;
@ -165,7 +162,7 @@ public final class ChatScene implements EventListener, Restorable {
// Initialize message and user rendering // Initialize message and user rendering
messageList.setCellFactory(MessageListCell::new); messageList.setCellFactory(MessageListCell::new);
chatList.setCellFactory(new ListCellFactory<>(ChatControl::new)); chatList.setCellFactory(ChatListCell::new);
// JavaFX provides an internal way of populating the context menu of a text // JavaFX provides an internal way of populating the context menu of a text
// area. // area.
@ -191,7 +188,6 @@ public final class ChatScene implements EventListener, Restorable {
// Set the design of the box in the upper-left corner // Set the design of the box in the upper-left corner
settingsButton.setAlignment(Pos.BOTTOM_RIGHT); settingsButton.setAlignment(Pos.BOTTOM_RIGHT);
HBox.setHgrow(spaceBetweenUserAndSettingsButton, Priority.ALWAYS);
generateOwnStatusControl(); generateOwnStatusControl();
Platform.runLater(() -> { Platform.runLater(() -> {
@ -271,18 +267,22 @@ public final class ChatScene implements EventListener, Restorable {
} }
@Event @Event
private void onContactOperation(ContactOperation operation) { private void onUserOperation(UserOperation operation) {
final var contact = operation.get();
delvh marked this conversation as resolved Outdated
Outdated
Review

You have a typo here, it's called 'dependent'.

You have a typo here, it's called 'dependent'.
switch (operation.getOperationType()) { // All ADD dependent logic resides in LocalDB
case ADD: if (operation.getOperationType().equals(ElementOperation.REMOVE)) Platform.runLater(() -> disableChat(new ContactDisabled(operation.get())));
if (contact instanceof User) localDB.getUsers().put(contact.getName(), (User) contact); }
final var chat = contact instanceof User ? new Chat(contact) : new GroupChat(client.getSender(), contact);
Platform.runLater(() -> ((ObservableList<Chat>) chats.getSource()).add(0, chat)); @Event
break; private void onGroupResize(GroupResize resize) {
delvh marked this conversation as resolved
Review

Why not use Optional#ifPresent here?

Why not use `Optional#ifPresent` here?
case REMOVE: final var chatFound = localDB.getChat(resize.getGroupID());
Platform.runLater(() -> chats.getSource().removeIf(c -> c.getRecipient().equals(contact))); chatFound.ifPresent(chat -> Platform.runLater(() -> {
break; chatList.refresh();
}
// Update the top-bar status label if all conditions apply
if (currentChat != null && currentChat.getRecipient().equals(chat.getRecipient())) topBarStatusLabel
.setText(chat.getRecipient().getContacts().size() + " member" + (currentChat.getRecipient().getContacts().size() != 1 ? "s" : ""));
}));
} }
@Event(eventType = NoAttachments.class) @Event(eventType = NoAttachments.class)
@ -298,8 +298,8 @@ public final class ChatScene implements EventListener, Restorable {
}); });
} }
@Event @Event(priority = 150)
private void onGroupCreationResult(GroupCreationResult result) { Platform.runLater(() -> newGroupButton.setDisable(!result.get())); } private void onGroupCreationResult(GroupCreationResult result) { Platform.runLater(() -> newGroupButton.setDisable(result.get() == null)); }
delvh marked this conversation as resolved Outdated
Outdated
Review

See #98.

See #98.
@Event(eventType = ThemeChangeEvent.class) @Event(eventType = ThemeChangeEvent.class)
private void onThemeChange() { private void onThemeChange() {
@ -312,7 +312,6 @@ public final class ChatScene implements EventListener, Restorable {
clientProfilePic.setImage(IconUtil.loadIconThemeSensitive("user_icon", 43)); clientProfilePic.setImage(IconUtil.loadIconThemeSensitive("user_icon", 43));
chatList.setCellFactory(new ListCellFactory<>(ChatControl::new)); chatList.setCellFactory(new ListCellFactory<>(ChatControl::new));
messageList.setCellFactory(MessageListCell::new); messageList.setCellFactory(MessageListCell::new);
// TODO: cache image
if (currentChat != null) if (currentChat != null)
if (currentChat.getRecipient() instanceof User) recipientProfilePic.setImage(IconUtil.loadIconThemeSensitive("user_icon", 43)); if (currentChat.getRecipient() instanceof User) recipientProfilePic.setImage(IconUtil.loadIconThemeSensitive("user_icon", 43));
else recipientProfilePic.setImage(IconUtil.loadIconThemeSensitive("group_icon", 43)); else recipientProfilePic.setImage(IconUtil.loadIconThemeSensitive("group_icon", 43));
@ -332,8 +331,10 @@ public final class ChatScene implements EventListener, Restorable {
@FXML @FXML
private void chatListClicked() { private void chatListClicked() {
if (chatList.getSelectionModel().isEmpty()) return; if (chatList.getSelectionModel().isEmpty()) return;
final var chat = chatList.getSelectionModel().getSelectedItem();
delvh marked this conversation as resolved
Review

currentChat != null is unnecessary here.

`currentChat != null` is unnecessary here.
Review

Let's hope I' ll stay unable to reproduce what I once have produced...

Let's hope I' ll stay unable to reproduce what I once have produced...
if (chat == null) return;
final var user = chatList.getSelectionModel().getSelectedItem().getRecipient(); final var user = chat.getRecipient();
if (user != null && (currentChat == null || !user.equals(currentChat.getRecipient()))) { if (user != null && (currentChat == null || !user.equals(currentChat.getRecipient()))) {
// LEON: JFC <===> JAVA FRIED CHICKEN <=/=> Java Foundation Classes // LEON: JFC <===> JAVA FRIED CHICKEN <=/=> Java Foundation Classes
@ -345,7 +346,6 @@ public final class ChatScene implements EventListener, Restorable {
final var scrollIndex = messageList.getItems().size() - currentChat.getUnreadAmount(); final var scrollIndex = messageList.getItems().size() - currentChat.getUnreadAmount();
messageList.scrollTo(scrollIndex); messageList.scrollTo(scrollIndex);
logger.log(Level.FINEST, "Loading chat with " + user + " at index " + scrollIndex); logger.log(Level.FINEST, "Loading chat with " + user + " at index " + scrollIndex);
deleteContactMenuItem.setText("Delete " + user.getName());
// Read the current chat // Read the current chat
currentChat.read(writeProxy); currentChat.read(writeProxy);
@ -363,20 +363,28 @@ public final class ChatScene implements EventListener, Restorable {
remainingChars remainingChars
.setText(String.format("remaining chars: %d/%d", MAX_MESSAGE_LENGTH - messageTextArea.getText().length(), MAX_MESSAGE_LENGTH)); .setText(String.format("remaining chars: %d/%d", MAX_MESSAGE_LENGTH - messageTextArea.getText().length(), MAX_MESSAGE_LENGTH));
} }
messageTextArea.setDisable(currentChat == null || postingPermanentlyDisabled);
voiceButton.setDisable(!recorder.isSupported()); // Enable or disable the necessary UI controls
attachmentButton.setDisable(false); final var chatEditable = currentChat == null || currentChat.isDisabled();
messageTextArea.setDisable(chatEditable || postingPermanentlyDisabled);
voiceButton.setDisable(!recorder.isSupported() || chatEditable);
attachmentButton.setDisable(chatEditable);
chatList.refresh(); chatList.refresh();
// Design the top bar
if (currentChat != null) { if (currentChat != null) {
topBarContactLabel.setText(currentChat.getRecipient().getName()); topBarContactLabel.setText(currentChat.getRecipient().getName());
topBarContactLabel.setVisible(true);
topBarStatusLabel.setVisible(true);
if (currentChat.getRecipient() instanceof User) { if (currentChat.getRecipient() instanceof User) {
final var status = ((User) currentChat.getRecipient()).getStatus().toString(); final var status = ((User) currentChat.getRecipient()).getStatus().toString();
topBarStatusLabel.setText(status); topBarStatusLabel.setText(status);
topBarStatusLabel.getStyleClass().clear();
topBarStatusLabel.getStyleClass().add(status.toLowerCase()); topBarStatusLabel.getStyleClass().add(status.toLowerCase());
recipientProfilePic.setImage(IconUtil.loadIconThemeSensitive("user_icon", 43)); recipientProfilePic.setImage(IconUtil.loadIconThemeSensitive("user_icon", 43));
delvh marked this conversation as resolved Outdated
Outdated
Review

This is unnecessary (your words).

This is unnecessary (your words).
} else { } else {
topBarStatusLabel.setText(currentChat.getRecipient().getContacts().size() + " members"); topBarStatusLabel.setText(currentChat.getRecipient().getContacts().size() + " member"
+ (currentChat.getRecipient().getContacts().size() != 1 ? "s" : ""));
topBarStatusLabel.getStyleClass().clear(); topBarStatusLabel.getStyleClass().clear();
recipientProfilePic.setImage(IconUtil.loadIconThemeSensitive("group_icon", 43)); recipientProfilePic.setImage(IconUtil.loadIconThemeSensitive("group_icon", 43));
} }
@ -386,7 +394,6 @@ public final class ChatScene implements EventListener, Restorable {
clip.setArcHeight(43); clip.setArcHeight(43);
clip.setArcWidth(43); clip.setArcWidth(43);
recipientProfilePic.setClip(clip); recipientProfilePic.setClip(clip);
messageSearchButton.setVisible(true); messageSearchButton.setVisible(true);
} }
} }
@ -665,9 +672,9 @@ public final class ChatScene implements EventListener, Restorable {
Platform.runLater(() -> { Platform.runLater(() -> {
chats.getSource().remove(currentChat); chats.getSource().remove(currentChat);
((ObservableList<Chat>) chats.getSource()).add(0, currentChat); ((ObservableList<Chat>) chats.getSource()).add(0, currentChat);
chatList.getSelectionModel().select(0);
localDB.getChats().remove(currentChat); localDB.getChats().remove(currentChat);
localDB.getChats().add(0, currentChat); localDB.getChats().add(0, currentChat);
chatList.getSelectionModel().select(0);
}); });
scrollToMessageListEnd(); scrollToMessageListEnd();
@ -712,7 +719,8 @@ public final class ChatScene implements EventListener, Restorable {
* @since Envoy Client v0.1-beta * @since Envoy Client v0.1-beta
*/ */
private void updateAttachmentView(boolean visible) { private void updateAttachmentView(boolean visible) {
if (!attachmentView.getImage().equals(DEFAULT_ATTACHMENT_VIEW_IMAGE)) attachmentView.setImage(DEFAULT_ATTACHMENT_VIEW_IMAGE); if (!(attachmentView.getImage() == null || attachmentView.getImage().equals(DEFAULT_ATTACHMENT_VIEW_IMAGE)))
attachmentView.setImage(DEFAULT_ATTACHMENT_VIEW_IMAGE);
attachmentView.setVisible(visible); attachmentView.setVisible(visible);
} }
@ -727,14 +735,59 @@ public final class ChatScene implements EventListener, Restorable {
// Else prepend it to the HBox children // Else prepend it to the HBox children
final var ownUserControl = new ContactControl(localDB.getUser()); final var ownUserControl = new ContactControl(localDB.getUser());
ownUserControl.setAlignment(Pos.CENTER_LEFT); ownUserControl.setAlignment(Pos.CENTER_LEFT);
HBox.setHgrow(ownUserControl, Priority.NEVER);
ownContactControl.getChildren().add(0, ownUserControl); ownContactControl.getChildren().add(0, ownUserControl);
} }
} }
// Context menu actions /**
* Redesigns the UI when the {@link Chat} of the given contact has been marked
* as disabled.
*
* @param event the contact whose chat got disabled
* @since Envoy Client v0.3-beta
*/
@Event
public void disableChat(ContactDisabled event) {
chatList.refresh();
final var recipient = event.get();
@FXML // Decrement member count for groups
private void deleteContact() { try {} catch (final NullPointerException e) {} } if (recipient instanceof Group)
topBarStatusLabel.setText(recipient.getContacts().size() + " member" + (recipient.getContacts().size() != 1 ? "s" : ""));
if (currentChat != null && currentChat.getRecipient().equals(recipient)) {
messageTextArea.setDisable(true);
voiceButton.setDisable(true);
attachmentButton.setDisable(true);
pendingAttachment = null;
messageList.getStyleClass().clear();
messageList.getStyleClass().add("disabled-chat");
}
}
/**
* Resets every component back to its inital state before a chat was selected.
*
* @since Envoy Client v0.3-beta
*/
public void resetState() {
currentChat = null;
chatList.getSelectionModel().clearSelection();
messageList.getItems().clear();
messageTextArea.setDisable(true);
attachmentView.setImage(null);
topBarContactLabel.setVisible(false);
topBarStatusLabel.setVisible(false);
messageSearchButton.setVisible(false);
messageTextArea.clear();
messageTextArea.setDisable(true);
attachmentButton.setDisable(true);
voiceButton.setDisable(true);
remainingChars.setVisible(false);
pendingAttachment = null;
recipientProfilePic.setImage(null);
if (recorder.isRecording()) recorder.cancel();
}
@FXML @FXML
private void copyAndPostMessage() { private void copyAndPostMessage() {

View File

@ -63,7 +63,7 @@ public class ContactSearchTab implements EventListener {
} }
@Event @Event
private void onContactOperation(ContactOperation operation) { private void onUserOperation(UserOperation operation) {
final var contact = operation.get(); final var contact = operation.get();
if (operation.getOperationType() == ElementOperation.ADD) Platform.runLater(() -> { if (operation.getOperationType() == ElementOperation.ADD) Platform.runLater(() -> {
userList.getItems().remove(contact); userList.getItems().remove(contact);
@ -96,7 +96,7 @@ public class ContactSearchTab implements EventListener {
} }
/** /**
* Sends an {@link ContactOperation} for the selected user to the * Sends an {@link UserOperation} for the selected user to the
* server. * server.
* *
* @since Envoy Client v0.1-beta * @since Envoy Client v0.1-beta
@ -114,7 +114,7 @@ public class ContactSearchTab implements EventListener {
private void addAsContact() { private void addAsContact() {
// Sends the event to the server // Sends the event to the server
final var event = new ContactOperation(currentlySelectedUser, ElementOperation.ADD); final var event = new UserOperation(currentlySelectedUser, ElementOperation.ADD);
client.send(event); client.send(event);
// Removes the chosen user and updates the UI // Removes the chosen user and updates the UI
@ -124,5 +124,8 @@ public class ContactSearchTab implements EventListener {
} }
@FXML @FXML
private void backButtonClicked() { eventBus.dispatch(new BackEvent()); } private void backButtonClicked() {
searchBar.setText("");
eventBus.dispatch(new BackEvent());
}
} }

View File

@ -16,7 +16,7 @@ import envoy.client.ui.control.*;
import envoy.client.ui.listcell.ListCellFactory; import envoy.client.ui.listcell.ListCellFactory;
import envoy.data.*; import envoy.data.*;
import envoy.event.GroupCreation; import envoy.event.GroupCreation;
import envoy.event.contact.ContactOperation; import envoy.event.contact.UserOperation;
import envoy.util.Bounds; import envoy.util.Bounds;
import dev.kske.eventbus.*; import dev.kske.eventbus.*;
@ -82,7 +82,7 @@ public class GroupCreationTab implements EventListener {
.map(User.class::cast) .map(User.class::cast)
.collect(Collectors.toList())); .collect(Collectors.toList()));
resizeQuickSelectSpace(0); resizeQuickSelectSpace(0);
quickSelectList.addEventFilter(MouseEvent.MOUSE_PRESSED, evt -> evt.consume()); quickSelectList.addEventFilter(MouseEvent.MOUSE_PRESSED, MouseEvent::consume);
} }
/** /**
@ -169,7 +169,7 @@ public class GroupCreationTab implements EventListener {
/** /**
* Removes an element from the quickSelectList. * Removes an element from the quickSelectList.
* *
* @param element the element to be removed. * @param element the element to be removed.
* @since Envoy Client v0.3-beta * @since Envoy Client v0.3-beta
*/ */
@ -234,11 +234,11 @@ public class GroupCreationTab implements EventListener {
} }
@Event @Event
private void onContactOperation(ContactOperation operation) { private void onUserOperation(UserOperation operation) {
if (operation.get() instanceof User) Platform.runLater(() -> { Platform.runLater(() -> {
switch (operation.getOperationType()) { switch (operation.getOperationType()) {
case ADD: case ADD:
userList.getItems().add((User) operation.get()); userList.getItems().add(operation.get());
break; break;
case REMOVE: case REMOVE:
userList.getItems().removeIf(operation.get()::equals); userList.getItems().removeIf(operation.get()::equals);

View File

@ -33,6 +33,7 @@ public abstract class AbstractListCell<T, U extends Node> extends ListCell<T> {
setGraphic(renderItem(item)); setGraphic(renderItem(item));
} else { } else {
setGraphic(null); setGraphic(null);
setCursor(Cursor.DEFAULT);
} }
} }

View File

@ -0,0 +1,46 @@
package envoy.client.ui.listcell;
import javafx.scene.control.*;
import envoy.client.data.*;
import envoy.client.net.Client;
import envoy.client.ui.control.ChatControl;
import envoy.client.util.UserUtil;
import envoy.data.User;
/**
* A list cell containing chats represented as chat controls.
*
* @author Leon Hofmeister
* @since Envoy Client v0.3-beta
*/
public class ChatListCell extends AbstractListCell<Chat, ChatControl> {
private static final Client client = Context.getInstance().getClient();
/**
* @param listView the list view inside of which the cell will be displayed
* @since Envoy Client v0.3-beta
*/
public ChatListCell(ListView<? extends Chat> listView) { super(listView); }
@Override
protected ChatControl renderItem(Chat chat) {
if (client.isOnline()) {
final var menu = new ContextMenu();
final var removeMI = new MenuItem();
removeMI.setText(
chat.isDisabled() ? "Delete " : chat.getRecipient() instanceof User ? "Block " : "Leave group " + chat.getRecipient().getName());
removeMI.setOnAction(
chat.isDisabled() ? e -> UserUtil.deleteContact(chat.getRecipient()) : e -> UserUtil.disableContact(chat.getRecipient()));
menu.getItems().add(removeMI);
setContextMenu(menu);
} else setContextMenu(null);
// TODO: replace with icon in ChatControl
final var chatControl = new ChatControl(chat);
if (chat.isDisabled()) chatControl.getStyleClass().add("disabled-chat");
else chatControl.getStyleClass().remove("disabled-chat");
return chatControl;
}
}

View File

@ -1,6 +1,6 @@
package envoy.client.util; package envoy.client.util;
import java.util.logging.Level; import java.util.logging.*;
import javafx.scene.control.Alert; import javafx.scene.control.Alert;
import javafx.scene.control.Alert.AlertType; import javafx.scene.control.Alert.AlertType;
@ -9,8 +9,11 @@ import envoy.client.data.Context;
import envoy.client.event.*; import envoy.client.event.*;
import envoy.client.helper.*; import envoy.client.helper.*;
import envoy.client.ui.SceneContext.SceneInfo; import envoy.client.ui.SceneContext.SceneInfo;
import envoy.client.ui.controller.ChatScene;
import envoy.data.*;
import envoy.data.User.UserStatus; import envoy.data.User.UserStatus;
import envoy.event.UserStatusChange; import envoy.event.*;
import envoy.event.contact.UserOperation;
import envoy.util.EnvoyLog; import envoy.util.EnvoyLog;
import dev.kske.eventbus.EventBus; import dev.kske.eventbus.EventBus;
@ -23,6 +26,9 @@ import dev.kske.eventbus.EventBus;
*/ */
public final class UserUtil { public final class UserUtil {
private static final Context context = Context.getInstance();
private static final Logger logger = EnvoyLog.getLogger(UserUtil.class);
private UserUtil() {} private UserUtil() {}
/** /**
@ -40,7 +46,8 @@ public final class UserUtil {
EnvoyLog.getLogger(ShutdownHelper.class).log(Level.INFO, "A logout was requested"); EnvoyLog.getLogger(ShutdownHelper.class).log(Level.INFO, "A logout was requested");
EventBus.getInstance().dispatch(new EnvoyCloseEvent()); EventBus.getInstance().dispatch(new EnvoyCloseEvent());
EventBus.getInstance().dispatch(new Logout()); EventBus.getInstance().dispatch(new Logout());
Context.getInstance().getSceneContext().load(SceneInfo.LOGIN_SCENE); context.getSceneContext().load(SceneInfo.LOGIN_SCENE);
logger.log(Level.INFO, "A logout occurred.");
}); });
} }
@ -54,11 +61,56 @@ public final class UserUtil {
public static void changeStatus(UserStatus newStatus) { public static void changeStatus(UserStatus newStatus) {
// Sending the already active status is a valid action // Sending the already active status is a valid action
if (newStatus.equals(Context.getInstance().getLocalDB().getUser().getStatus())) return; if (newStatus.equals(context.getLocalDB().getUser().getStatus())) return;
else { else {
EventBus.getInstance().dispatch(new OwnStatusChange(newStatus)); EventBus.getInstance().dispatch(new OwnStatusChange(newStatus));
if (Context.getInstance().getClient().isOnline()) if (context.getClient().isOnline()) context.getClient().send(new UserStatusChange(context.getLocalDB().getUser().getID(), newStatus));
Context.getInstance().getClient().send(new UserStatusChange(Context.getInstance().getLocalDB().getUser().getID(), newStatus)); logger.log(Level.INFO, "A manual status change occurred.");
}
}
/**
* Removes the given contact.
*
* @param block the contact that should be removed
* @since Envoy Client v0.3-beta
*/
public static void disableContact(Contact block) {
if (!context.getClient().isOnline() || block == null) return;
else {
final var alert = new Alert(AlertType.CONFIRMATION);
alert.setContentText("Are you sure you want to " + (block instanceof User ? "block " : "leave group ") + block.getName() + "?");
AlertHelper.confirmAction(alert, () -> {
final var isUser = block instanceof User;
context.getClient()
.send(isUser ? new UserOperation((User) block, ElementOperation.REMOVE)
: new GroupResize(context.getLocalDB().getUser(), (Group) block, ElementOperation.REMOVE));
if (!isUser) block.getContacts().remove(context.getLocalDB().getUser());
EventBus.getInstance().dispatch(new ContactDisabled(block));
logger.log(Level.INFO, isUser ? "A user was blocked." : "The user left a group.");
});
}
}
/**
* Deletes the given contact with all his messages entirely.
*
delvh marked this conversation as resolved
Review

Use an event here instead. This would also simplify the interaction with the local database.

Use an event here instead. This would also simplify the interaction with the local database.
* @param delete the contact to delete
* @since Envoy Client v0.3-beta
*/
public static void deleteContact(Contact delete) {
if (delete == null) return;
else {
final var alert = new Alert(AlertType.CONFIRMATION);
alert.setContentText("Are you sure you want to delete " + delete.getName()
+ " entirely? All messages with this contact will be deleted. This action cannot be undone.");
AlertHelper.confirmAction(alert, () -> {
context.getLocalDB().getUsers().remove(delete.getName());
context.getLocalDB().getChats().removeIf(chat -> chat.getRecipient().equals(delete));
if (context.getSceneContext().getController() instanceof ChatScene)
((ChatScene) context.getSceneContext().getController()).resetState();
logger.log(Level.INFO, "A contact with all his messages was deleted.");
});
} }
} }
} }

View File

@ -139,20 +139,25 @@
.tab-pane { .tab-pane {
-fx-tab-max-height: 0.0 ; -fx-tab-max-height: 0.0 ;
} }
.tab-pane .tab-header-area { .tab-pane .tab-header-area {
visibility: hidden ; visibility: hidden ;
-fx-padding: -20.0 0.0 0.0 0.0; -fx-padding: -20.0 0.0 0.0 0.0;
} }
.disabled-chat {
-fx-background-color: #0000FF;
}
#quick-select-list .scroll-bar:horizontal{ #quick-select-list .scroll-bar:horizontal{
-fx-pref-height: 0; -fx-pref-height: 0.0;
-fx-max-height: 0; -fx-max-height: 0.0;
-fx-min-height: 0; -fx-min-height: 0.0;
} }
#quick-select-list .scroll-bar:vertical{ #quick-select-list .scroll-bar:vertical{
-fx-pref-width: 0; -fx-pref-width: 0.0;
-fx-max-width: 0; -fx-max-width: 0.0;
-fx-min-width: 0; -fx-min-width: 0.0;
} }

View File

@ -126,15 +126,6 @@
<ListView id="chat-list" fx:id="chatList" <ListView id="chat-list" fx:id="chatList"
focusTraversable="false" onMouseClicked="#chatListClicked" focusTraversable="false" onMouseClicked="#chatListClicked"
prefWidth="316.0" VBox.vgrow="ALWAYS"> prefWidth="316.0" VBox.vgrow="ALWAYS">
<contextMenu>
<ContextMenu anchorLocation="CONTENT_TOP_LEFT">
<items>
<MenuItem fx:id="deleteContactMenuItem"
mnemonicParsing="false" onAction="#deleteContact"
text="Delete" />
</items>
</ContextMenu>
</contextMenu>
<padding> <padding>
<Insets bottom="5.0" left="5.0" right="2.0" top="5.0" /> <Insets bottom="5.0" left="5.0" right="2.0" top="5.0" />
</padding> </padding>
@ -167,7 +158,7 @@
<HBox id="transparent-background" fx:id="ownContactControl"> <HBox id="transparent-background" fx:id="ownContactControl">
<children> <children>
<Region id="transparent-background" prefWidth="120" <Region id="transparent-background" prefWidth="120"
fx:id="spaceBetweenUserAndSettingsButton" /> fx:id="spaceBetweenUserAndSettingsButton" HBox.hgrow="ALWAYS" />
<Button fx:id="settingsButton" mnemonicParsing="false" <Button fx:id="settingsButton" mnemonicParsing="false"
onAction="#settingsButtonClicked" prefHeight="30.0" onAction="#settingsButtonClicked" prefHeight="30.0"
prefWidth="30.0" text="" alignment="CENTER"> prefWidth="30.0" text="" alignment="CENTER">

View File

@ -17,14 +17,14 @@ public final class GroupCreation extends Event<String> {
private static final long serialVersionUID = 0L; private static final long serialVersionUID = 0L;
/** /**
* @param value the name of this group at creation time * @param name the name of this group at creation time
* @param initialMemberIDs the IDs of all {@link User}s that should be group * @param initialMemberIDs the IDs of all {@link User}s that should be group
* members from the beginning on (excluding the creator * members from the beginning on (excluding the creator
* of this group) * of this group)
* @since Envoy Common v0.1-beta * @since Envoy Common v0.1-beta
*/ */
public GroupCreation(String value, Set<Long> initialMemberIDs) { public GroupCreation(String name, Set<Long> initialMemberIDs) {
super(value); super(name);
this.initialMemberIDs = initialMemberIDs != null ? initialMemberIDs : new HashSet<>(); this.initialMemberIDs = initialMemberIDs != null ? initialMemberIDs : new HashSet<>();
} }

View File

@ -1,5 +1,7 @@
package envoy.event; package envoy.event;
import envoy.data.Group;
/** /**
* Used to communicate with a client that his request to create a group might * Used to communicate with a client that his request to create a group might
* have been rejected as it might be disabled on his current server. * have been rejected as it might be disabled on his current server.
@ -7,15 +9,23 @@ package envoy.event;
* @author Leon Hofmeister * @author Leon Hofmeister
* @since Envoy Common v0.2-beta * @since Envoy Common v0.2-beta
*/ */
public class GroupCreationResult extends Event<Boolean> { public class GroupCreationResult extends Event<Group> {
private static final long serialVersionUID = 1L; private static final long serialVersionUID = 1L;
/** /**
* Creates a new {@code GroupCreationResult}. * Creates a new {@code GroupCreationResult} that implies the failure of this
* {@link GroupCreationResult}.
* *
* @param success whether the GroupCreation sent before was successful
* @since Envoy Common v0.2-beta * @since Envoy Common v0.2-beta
*/ */
public GroupCreationResult(boolean success) { super(success); } public GroupCreationResult() { super(null); }
/**
* Creates a new {@code GroupCreationResult}.
*
* @param resultGroup the group the server created
* @since Envoy Common v0.2-beta
*/
public GroupCreationResult(Group resultGroup) { super(resultGroup); }
} }

View File

@ -33,13 +33,12 @@ public final class GroupResize extends Event<User> {
*/ */
public GroupResize(User user, Group group, ElementOperation operation) { public GroupResize(User user, Group group, ElementOperation operation) {
super(user); super(user);
this.operation = operation; this.operation = operation;
if (group.getContacts().contains(user)) { final var contained = group.getContacts().contains(user);
if (operation.equals(ADD)) if (contained && operation.equals(ADD))
throw new IllegalArgumentException(String.format("Cannot add %s to %s!", user, group)); throw new IllegalArgumentException(String.format("Cannot add %s to %s!", user, group));
} else if (operation.equals(REMOVE)) else if (operation.equals(REMOVE) && !contained) throw new IllegalArgumentException(String.format("Cannot remove %s from %s!", user, group));
throw new IllegalArgumentException(String.format("Cannot remove %s from %s!", user, group)); groupID = group.getID();
groupID = group.getID();
} }
/** /**
@ -72,5 +71,5 @@ public final class GroupResize extends Event<User> {
} }
@Override @Override
public String toString() { return String.format("GroupResize[userid=%d,groupid=%d,operation=%s]", get(), groupID, operation); } public String toString() { return String.format("GroupResize[user=%s,groupid=%d,operation=%s]", get(), groupID, operation); }
} }

View File

@ -0,0 +1,15 @@
package envoy.event.contact;
import envoy.event.Event.Valueless;
/**
* Conveys that either a direct contact or a group member has been deleted while
* the user has been offline.
*
* @author Leon Hofmeister
* @since Envoy Common v0.3-beta
*/
public class ContactsChangedSinceLastLogin extends Valueless {
private static final long serialVersionUID = 1L;
}

View File

@ -1,35 +1,38 @@
package envoy.event.contact; package envoy.event.contact;
import envoy.data.Contact; import envoy.data.User;
import envoy.event.*; import envoy.event.*;
/** /**
* Signifies the modification of a contact list. * Signifies the modification of a contact list.
* *
* @author Maximilian K&auml;fer * @author Maximilian K&auml;fer
* @since Envoy Common v0.2-alpha * @since Envoy Common v0.3-beta
*/ */
public final class ContactOperation extends Event<Contact> { public final class UserOperation extends Event<User> {
private final ElementOperation operationType; private final ElementOperation operationType;
private static final long serialVersionUID = 1L; private static final long serialVersionUID = 1L;
/** /**
* Initializes a {@link ContactOperation}. * Initializes a {@link UserOperation}.
* *
* @param contact the user on which the operation is performed * @param contact the user on which the operation is performed
* @param operationType the type of operation to perform * @param operationType the type of operation to perform
* @since Envoy Common v0.2-alpha * @since Envoy Common v0.3-beta
*/ */
public ContactOperation(Contact contact, ElementOperation operationType) { public UserOperation(User contact, ElementOperation operationType) {
super(contact); super(contact);
this.operationType = operationType; this.operationType = operationType;
} }
/** /**
* @return the type of operation to perform * @return the type of operation to perform
* @since Envoy Common v0.2-alpha * @since Envoy Common v0.3-beta
*/ */
public ElementOperation getOperationType() { return operationType; } public ElementOperation getOperationType() { return operationType; }
@Override
public String toString() { return String.format("%s[contact=%s, operation=%s]", UserOperation.class.getSimpleName(), value, operationType); }
} }

View File

@ -49,9 +49,10 @@ public final class Startup {
new MessageStatusChangeProcessor(), new MessageStatusChangeProcessor(),
new GroupMessageStatusChangeProcessor(), new GroupMessageStatusChangeProcessor(),
new UserStatusChangeProcessor(), new UserStatusChangeProcessor(),
new GroupResizeProcessor(),
new IDGeneratorRequestProcessor(), new IDGeneratorRequestProcessor(),
new UserSearchProcessor(), new UserSearchProcessor(),
new ContactOperationProcessor(), new UserOperationProcessor(),
new IsTypingProcessor(), new IsTypingProcessor(),
new NameChangeProcessor(), new NameChangeProcessor(),
new ProfilePicChangeProcessor(), new ProfilePicChangeProcessor(),

View File

@ -51,11 +51,11 @@ public class Message {
@Id @Id
protected long id; protected long id;
@ManyToOne @ManyToOne(cascade = CascadeType.REMOVE)
@JoinColumn @JoinColumn
protected User sender; protected User sender;
@ManyToOne @ManyToOne(cascade = CascadeType.REMOVE)
@JoinColumn @JoinColumn
protected Contact recipient; protected Contact recipient;

View File

@ -2,11 +2,13 @@ package envoy.server.data;
import java.time.Instant; import java.time.Instant;
import java.util.List; import java.util.List;
import java.util.logging.Level;
import javax.persistence.*; import javax.persistence.*;
import envoy.data.User.UserStatus; import envoy.data.User.UserStatus;
import envoy.server.net.ConnectionManager; import envoy.server.net.ConnectionManager;
import envoy.util.EnvoyLog;
/** /**
* Contains operations used for persistence. * Contains operations used for persistence.
@ -97,7 +99,15 @@ public final class PersistenceManager {
* @param contact the {@link Contact} to delete * @param contact the {@link Contact} to delete
* @since Envoy Server Standalone v0.1-alpha * @since Envoy Server Standalone v0.1-alpha
*/ */
public void deleteContact(Contact contact) { remove(contact); } public void deleteContact(Contact contact) {
transaction(() -> {
// Remove this contact from the contact list of his contacts
for (final var remainingContact : contact.getContacts())
remainingContact.getContacts().remove(contact);
});
remove(contact);
}
/** /**
* Deletes a {@link Message} in the database. * Deletes a {@link Message} in the database.
@ -227,17 +237,52 @@ public final class PersistenceManager {
* @since Envoy Server Standalone v0.1-alpha * @since Envoy Server Standalone v0.1-alpha
*/ */
public void addContactBidirectional(long contactID1, long contactID2) { public void addContactBidirectional(long contactID1, long contactID2) {
addContactBidirectional(getContactByID(contactID1), getContactByID(contactID2));
}
// Get users by ID /**
final var c1 = getContactByID(contactID1); * Adds a contact to the contact list of another contact and vice versa.
final var c2 = getContactByID(contactID2); *
* @param contact1 the first contact
* @param contact2 the second contact
* @since Envoy Server v0.3-beta
*/
public void addContactBidirectional(Contact contact1, Contact contact2) {
// Add users to each others contact lists // Add users to each others contact list
c1.getContacts().add(c2); contact1.getContacts().add(contact2);
c2.getContacts().add(c1); contact2.getContacts().add(contact1);
// Synchronize changes with the database // Synchronize changes with the database
transaction(() -> { entityManager.merge(c1); entityManager.merge(c2); }); transaction(() -> { entityManager.merge(contact1); entityManager.merge(contact2); });
}
/**
* Removes a contact from the contact list of another contact and vice versa.
*
* @param contactID1 the ID of the first contact
* @param contactID2 the ID of the second contact
* @since Envoy Server v0.3-beta
*/
public void removeContactBidirectional(long contactID1, long contactID2) {
removeContactBidirectional(getContactByID(contactID1), getContactByID(contactID2));
}
/**
* Removes a contact from the contact list of another contact and vice versa.
*
* @param contact1 the first contact
* @param contact2 the second contact
* @since Envoy Server v0.3-beta
*/
public void removeContactBidirectional(Contact contact1, Contact contact2) {
// Remove users from each others contact list
contact1.getContacts().remove(contact2);
contact2.getContacts().remove(contact1);
// Synchronize changes with the database
transaction(() -> { entityManager.merge(contact1); entityManager.merge(contact2); });
} }
/** /**
@ -277,6 +322,14 @@ public final class PersistenceManager {
entityManagerRelatedAction.run(); entityManagerRelatedAction.run();
transaction.commit(); transaction.commit();
} }
} catch (final RollbackException e2) {
// Apparently a major problem exists. Discard faulty transaction and then go on.
if (transaction.isActive()) {
transaction.rollback();
EnvoyLog.getLogger(PersistenceManager.class)
.log(Level.SEVERE, "Could not perform transaction, hence discarding it. It's likely that a serious issue exists.");
} else throw e2;
} }
} }
} }

View File

@ -70,6 +70,9 @@ public final class User extends Contact {
@Column(name = "last_seen") @Column(name = "last_seen")
private Instant lastSeen; private Instant lastSeen;
@Column(name = "latest_contact_deletion")
private Instant latestContactDeletion;
private UserStatus status; private UserStatus status;
@Override @Override
@ -140,4 +143,16 @@ public final class User extends Contact {
* @since Envoy Server Standalone v0.1-alpha * @since Envoy Server Standalone v0.1-alpha
*/ */
public void setStatus(UserStatus status) { this.status = status; } public void setStatus(UserStatus status) { this.status = status; }
/**
* @return the latestContactDeletion
* @since Envoy Server v0.3-beta
*/
public Instant getLatestContactDeletion() { return latestContactDeletion; }
/**
* @param latestContactDeletion the latestContactDeletion to set
* @since Envoy Server v0.3-beta
*/
public void setLatestContactDeletion(Instant latestContactDeletion) { this.latestContactDeletion = latestContactDeletion; }
} }

View File

@ -1,39 +0,0 @@
package envoy.server.processors;
import java.util.logging.Logger;
import envoy.event.ElementOperation;
import envoy.event.contact.ContactOperation;
import envoy.server.data.PersistenceManager;
import envoy.server.net.*;
import envoy.util.EnvoyLog;
/**
* @author Kai S. K. Engelbart
* @since Envoy Server Standalone v0.1-alpha
*/
public final class ContactOperationProcessor implements ObjectProcessor<ContactOperation> {
private static final ConnectionManager connectionManager = ConnectionManager.getInstance();
private static final Logger logger = EnvoyLog.getLogger(ContactOperationProcessor.class);
@Override
public void process(ContactOperation evt, long socketId, ObjectWriteProxy writeProxy) {
switch (evt.getOperationType()) {
case ADD:
final long userID = ConnectionManager.getInstance().getUserIDBySocketID(socketId);
final long contactId = evt.get().getID();
logger.fine(String.format("Adding user %s to the contact list of user %d.%n", evt.get(), userID));
PersistenceManager.getInstance().addContactBidirectional(userID, contactId);
// Notify the contact if online
if (ConnectionManager.getInstance().isOnline(contactId))
writeProxy.write(connectionManager.getSocketID(contactId),
new ContactOperation(PersistenceManager.getInstance().getUserByID(userID).toCommon(), ElementOperation.ADD));
break;
default:
logger.warning(String.format("Received %s with an unsupported operation.", evt));
}
}
}

View File

@ -5,8 +5,7 @@ import static envoy.server.Startup.config;
import java.util.HashSet; import java.util.HashSet;
import envoy.event.*; import envoy.event.*;
import envoy.event.contact.ContactOperation; import envoy.server.data.PersistenceManager;
import envoy.server.data.*;
import envoy.server.net.*; import envoy.server.net.*;
/** /**
@ -21,21 +20,19 @@ public final class GroupCreationProcessor implements ObjectProcessor<GroupCreati
@Override @Override
public void process(GroupCreation groupCreation, long socketID, ObjectWriteProxy writeProxy) { public void process(GroupCreation groupCreation, long socketID, ObjectWriteProxy writeProxy) {
// Don't allow the creation of groups if manually disabled // Don't allow the creation of groups if manually disabled
writeProxy.write(socketID, new GroupCreationResult(config.isGroupSupportEnabled())); if (!config.isGroupSupportEnabled()) {
if (!config.isGroupSupportEnabled()) return; writeProxy.write(socketID, new GroupCreationResult());
return;
}
final envoy.server.data.Group group = new envoy.server.data.Group(); final envoy.server.data.Group group = new envoy.server.data.Group();
group.setName(groupCreation.get()); group.setName(groupCreation.get());
group.setContacts(new HashSet<>()); group.setContacts(new HashSet<>());
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)));
persistenceManager.addContact(group); persistenceManager.addContact(group);
group.getContacts() groupCreation.getInitialMemberIDs()
.stream() .stream()
.map(Contact::getID) .map(persistenceManager::getUserByID)
.filter(connectionManager::isOnline) .forEach(member -> persistenceManager.addContactBidirectional(member, group));
.map(connectionManager::getSocketID) persistenceManager.addContactBidirectional(persistenceManager.getUserByID(connectionManager.getUserIDBySocketID(socketID)), group);
.forEach(memberSocketID -> writeProxy.write(memberSocketID, new ContactOperation(group.toCommon(), ElementOperation.ADD))); writeProxy.writeToOnlineContacts(group.getContacts(), new GroupCreationResult(group.toCommon()));
} }
} }

View File

@ -1,8 +1,12 @@
package envoy.server.processors; package envoy.server.processors;
import java.time.Instant;
import java.util.logging.Level;
import envoy.event.GroupResize; import envoy.event.GroupResize;
import envoy.server.data.*; import envoy.server.data.*;
import envoy.server.net.*; import envoy.server.net.ObjectWriteProxy;
import envoy.util.EnvoyLog;
/** /**
* @author Maximilian K&auml;fer * @author Maximilian K&auml;fer
@ -10,35 +14,38 @@ import envoy.server.net.*;
*/ */
public final class GroupResizeProcessor implements ObjectProcessor<GroupResize> { public final class GroupResizeProcessor implements ObjectProcessor<GroupResize> {
private static final PersistenceManager persistenceManager = PersistenceManager.getInstance(); private static final PersistenceManager persistenceManager = PersistenceManager.getInstance();
private static final ConnectionManager connectionManager = ConnectionManager.getInstance();
@Override @Override
public void process(GroupResize groupResize, long socketID, ObjectWriteProxy writeProxy) { public void process(GroupResize groupResize, long socketID, ObjectWriteProxy writeProxy) {
// Acquire the group to resize from the database // Acquire the group to resize from the database
var group = persistenceManager.getGroupByID(groupResize.getGroupID()); final var group = persistenceManager.getGroupByID(groupResize.getGroupID());
final var sender = persistenceManager.getUserByID(groupResize.get().getID());
// Perform the desired operation // Perform the desired operation
switch (groupResize.getOperation()) { switch (groupResize.getOperation()) {
case ADD: case ADD:
group.getContacts().add(persistenceManager.getUserByID(groupResize.get().getID())); persistenceManager.addContactBidirectional(sender, group);
break; writeProxy.writeToOnlineContacts(group.getContacts(), group.toCommon());
return;
case REMOVE: case REMOVE:
persistenceManager.removeContactBidirectional(sender, group);
sender.setLatestContactDeletion(Instant.now());
// The group has no more members and hence will be deleted
if (group.getContacts().isEmpty()) {
EnvoyLog.getLogger(GroupResizeProcessor.class).log(Level.INFO, "Deleting now empty group " + group.getName());
persistenceManager.deleteContact(group);
} else {
// Informing the other members
writeProxy.writeToOnlineContacts(group.getContacts(), groupResize);
group.getContacts().forEach(c -> ((User) c).setLatestContactDeletion(Instant.now()));
}
group.getContacts().remove(persistenceManager.getUserByID(groupResize.get().getID())); group.getContacts().remove(persistenceManager.getUserByID(groupResize.get().getID()));
break; return;
} }
// Update the group in the database
persistenceManager.updateContact(group);
// Send the updated group to all of its members
var commonGroup = group.toCommon();
group.getContacts()
.stream()
.map(Contact::getID)
.filter(connectionManager::isOnline)
.map(connectionManager::getSocketID)
.forEach(memberSocketID -> writeProxy.write(memberSocketID, commonGroup));
} }
} }

View File

@ -13,6 +13,7 @@ import javax.persistence.NoResultException;
import envoy.data.LoginCredentials; import envoy.data.LoginCredentials;
import envoy.event.*; import envoy.event.*;
import envoy.event.contact.ContactsChangedSinceLastLogin;
import envoy.server.data.*; import envoy.server.data.*;
import envoy.server.net.*; import envoy.server.net.*;
import envoy.server.util.*; import envoy.server.util.*;
@ -104,6 +105,7 @@ public final class LoginCredentialProcessor implements ObjectProcessor<LoginCred
user.setStatus(ONLINE); user.setStatus(ONLINE);
user.setPasswordHash(PasswordUtil.hash(credentials.getPassword())); user.setPasswordHash(PasswordUtil.hash(credentials.getPassword()));
user.setContacts(new HashSet<>()); user.setContacts(new HashSet<>());
user.setLatestContactDeletion(Instant.EPOCH);
persistenceManager.addContact(user); persistenceManager.addContact(user);
logger.info("Registered new " + user); logger.info("Registered new " + user);
} }
@ -205,6 +207,8 @@ public final class LoginCredentialProcessor implements ObjectProcessor<LoginCred
writeProxy.write(socketID, new MessageStatusChange(gmsgCommon)); writeProxy.write(socketID, new MessageStatusChange(gmsgCommon));
} }
} }
// Notify the user if a contact deletion has happened since he last logged in
if (user.getLatestContactDeletion().isAfter(user.getLastSeen())) writeProxy.write(socketID, new ContactsChangedSinceLastLogin());
// Complete the handshake // Complete the handshake
writeProxy.write(socketID, user.toCommon()); writeProxy.write(socketID, user.toCommon());

View File

@ -0,0 +1,52 @@
package envoy.server.processors;
import java.time.Instant;
import java.util.logging.*;
import envoy.event.ElementOperation;
import envoy.event.contact.UserOperation;
import envoy.server.data.PersistenceManager;
import envoy.server.net.*;
import envoy.util.EnvoyLog;
/**
* @author Kai S. K. Engelbart
* @since Envoy Server Standalone v0.1-alpha
*/
public final class UserOperationProcessor implements ObjectProcessor<UserOperation> {
private static final ConnectionManager connectionManager = ConnectionManager.getInstance();
private static final Logger logger = EnvoyLog.getLogger(UserOperationProcessor.class);
private static final PersistenceManager persistenceManager = PersistenceManager.getInstance();
@Override
public void process(UserOperation evt, long socketId, ObjectWriteProxy writeProxy) {
final long userID = ConnectionManager.getInstance().getUserIDBySocketID(socketId);
final long contactID = evt.get().getID();
final var sender = persistenceManager.getUserByID(userID);
switch (evt.getOperationType()) {
case ADD:
logger.log(Level.FINE, String.format("Adding %s to the contact list of user %d.", evt.get(), userID));
persistenceManager.addContactBidirectional(userID, contactID);
// Notify the contact if online
if (connectionManager.isOnline(contactID))
writeProxy.write(connectionManager.getSocketID(contactID), new UserOperation(sender.toCommon(), ElementOperation.ADD));
break;
case REMOVE:
// Remove the relationships and notify sender if he logs in using another
// LocalDB
persistenceManager.removeContactBidirectional(userID, contactID);
sender.setLatestContactDeletion(Instant.now());
// Notify the removed contact on next startup(s) of this deletion
persistenceManager.getUserByID(contactID).setLatestContactDeletion(Instant.now());
// Notify the removed contact if online
if (connectionManager.isOnline(contactID))
writeProxy.write(connectionManager.getSocketID(contactID), new UserOperation(sender.toCommon(), ElementOperation.REMOVE));
break;
}
}
}