zdm/envoy
zdm/envoy
Archived
3
Fork 0
Code Issues 22 Pull Requests Releases 1 Wiki Activity

Merge branch 'develop' into f/finishing_new_UI

Browse Source
This commit is contained in:
Maximilian P. Käfer 2020-08-30 15:48:29 +02:00
commit dc58290f22
96 changed files with 724 additions and 431 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
client/.settings/org.eclipse.jdt.ui.prefs
View File

File diff suppressed because one or more lines are too long

6
client/src/main/java/envoy/client/Main.java
View File

@ -17,9 +17,9 @@ import envoy.client.ui.Startup;
* @author Kai S. K. Engelbart
* @since Envoy Client v0.1-beta
*/
public class Main {
public final class Main {
private static final boolean DEBUG = false;
private static final boolean debug = false;
/**
* Starts the application.
@ -29,7 +29,7 @@ public class Main {
* @since Envoy Client v0.1-beta
*/
public static void main(String[] args) {
if (DEBUG) {
if (debug) {
// Put testing code here
System.out.println();
System.exit(0);

38
client/src/main/java/envoy/client/data/ClientConfig.java
View File

@ -3,10 +3,8 @@ package envoy.client.data;
import static java.util.function.Function.identity;
import java.io.File;
import java.util.logging.Level;
import envoy.data.Config;
import envoy.data.ConfigItem;
/**
* Implements a configuration specific to the Envoy Client with default values
@ -19,7 +17,7 @@ import envoy.data.ConfigItem;
* @author Kai S. K. Engelbart
* @since Envoy Client v0.1-beta
*/
public class ClientConfig extends Config {
public final class ClientConfig extends Config {
private static ClientConfig config;
@ -33,15 +31,13 @@ public class ClientConfig extends Config {
}
private ClientConfig() {
items.put("server", new ConfigItem<>("server", "s", identity(), null, true));
items.put("port", new ConfigItem<>("port", "p", Integer::parseInt, null, true));
items.put("localDB", new ConfigItem<>("localDB", "db", File::new, new File("localDB"), true));
items.put("ignoreLocalDB", new ConfigItem<>("ignoreLocalDB", "nodb", Boolean::parseBoolean, false, false));
items.put("homeDirectory", new ConfigItem<>("homeDirectory", "h", File::new, new File(System.getProperty("user.home"), ".envoy"), true));
items.put("fileLevelBarrier", new ConfigItem<>("fileLevelBarrier", "fb", Level::parse, Level.OFF, true));
items.put("consoleLevelBarrier", new ConfigItem<>("consoleLevelBarrier", "cb", Level::parse, Level.OFF, true));
items.put("user", new ConfigItem<>("user", "u", identity()));
items.put("password", new ConfigItem<>("password", "pw", identity()));
super(".envoy");
put("server", "s", identity());
put("port", "p", Integer::parseInt);
put("localDB", "db", File::new);
put("ignoreLocalDB", "nodb", Boolean::parseBoolean);
put("user", "u", identity());
put("password", "pw", identity());
}
/**
@ -68,24 +64,6 @@ public class ClientConfig extends Config {
*/
public Boolean isIgnoreLocalDB() { return (Boolean) items.get("ignoreLocalDB").get(); }
/**
* @return the directory in which all local files are saves
* @since Envoy Client v0.2-alpha
*/
public File getHomeDirectory() { return (File) items.get("homeDirectory").get(); }
/**
* @return the minimal {@link Level} to log inside the log file
* @since Envoy Client v0.2-alpha
*/
public Level getFileLevelBarrier() { return (Level) items.get("fileLevelBarrier").get(); }
/**
* @return the minimal {@link Level} to log inside the console
* @since Envoy Client v0.2-alpha
*/
public Level getConsoleLevelBarrier() { return (Level) items.get("consoleLevelBarrier").get(); }
/**
* @return the user name
* @since Envoy Client v0.3-alpha

15
client/src/main/java/envoy/client/data/GroupChat.java
View File

@ -17,11 +17,11 @@ import envoy.event.GroupMessageStatusChange;
* Project: <strong>envoy-client</strong><br>
* File: <strong>GroupChat.java</strong><br>
* Created: <strong>05.07.2020</strong><br>
*
*
* @author Maximilian K&auml;fer
* @since Envoy Client v0.1-beta
*/
public class GroupChat extends Chat {
public final class GroupChat extends Chat {
private final User sender;
@ -41,13 +41,10 @@ public class GroupChat extends Chat {
public void read(WriteProxy writeProxy) throws IOException {
for (int i = messages.size() - 1; i >= 0; --i) {
final GroupMessage gmsg = (GroupMessage) messages.get(i);
if (gmsg.getSenderID() != sender.getID()) {
if (gmsg.getMemberStatuses().get(sender.getID()) == MessageStatus.READ) break;
else {
gmsg.getMemberStatuses().replace(sender.getID(), MessageStatus.READ);
writeProxy
.writeMessageStatusChange(new GroupMessageStatusChange(gmsg.getID(), MessageStatus.READ, Instant.now(), sender.getID()));
}
if (gmsg.getSenderID() != sender.getID()) if (gmsg.getMemberStatuses().get(sender.getID()) == MessageStatus.READ) break;
else {
gmsg.getMemberStatuses().replace(sender.getID(), MessageStatus.READ);
writeProxy.writeMessageStatusChange(new GroupMessageStatusChange(gmsg.getID(), MessageStatus.READ, Instant.now(), sender.getID()));
}
}
unreadAmount = 0;

6
client/src/main/java/envoy/client/data/Settings.java
View File

@ -22,7 +22,7 @@ import envoy.util.SerializationUtils;
* @author Kai S. K. Engelbart
* @since Envoy Client v0.2-alpha
*/
public class Settings {
public final class Settings {
// Actual settings accessible by the rest of the application
private Map<String, SettingsItem<?>> items;
@ -139,7 +139,9 @@ public class Settings {
* before
* @since Envoy Client v0.2-beta
*/
public void setDownloadSavedWithoutAsking(boolean autosaveDownload) { ((SettingsItem<Boolean>) items.get("autoSaveDownloads")).set(autosaveDownload); }
public void setDownloadSavedWithoutAsking(boolean autosaveDownload) {
((SettingsItem<Boolean>) items.get("autoSaveDownloads")).set(autosaveDownload);
}
/**
* @return the path where downloads should be saved

2
client/src/main/java/envoy/client/data/SettingsItem.java
View File

@ -17,7 +17,7 @@ import javax.swing.JComponent;
* @author Kai S. K. Engelbart
* @since Envoy Client v0.3-alpha
*/
public class SettingsItem<T> implements Serializable {
public final class SettingsItem<T> implements Serializable {
private T value;
private String userFriendlyName, description;

2
client/src/main/java/envoy/client/data/commands/SystemCommand.java
View File

@ -24,7 +24,7 @@ import java.util.function.Supplier;
* @author Leon Hofmeister
* @since Envoy Client v0.2-beta
*/
public class SystemCommand implements OnCall {
public final class SystemCommand implements OnCall {
protected int relevance;

2
client/src/main/java/envoy/client/data/commands/SystemCommandBuilder.java
View File

@ -14,7 +14,7 @@ import java.util.function.Consumer;
* @author Leon Hofmeister
* @since Envoy Client v0.2-beta
*/
public class SystemCommandBuilder {
public final class SystemCommandBuilder {
private int numberOfArguments;
private Consumer<List<String>> action;

2
client/src/main/java/envoy/client/event/MessageCreationEvent.java
View File

@ -11,7 +11,7 @@ import envoy.event.Event;
* @author Kai S. K. Engelbart
* @since Envoy Client v0.2-alpha
*/
public class MessageCreationEvent extends Event<Message> {
public final class MessageCreationEvent extends Event<Message> {
private static final long serialVersionUID = 0L;

2
client/src/main/java/envoy/client/event/MessageModificationEvent.java
View File

@ -11,7 +11,7 @@ import envoy.event.Event;
* @author Kai S. K. Engelbart
* @since Envoy Client v0.2-alpha
*/
public class MessageModificationEvent extends Event<Message> {
public final class MessageModificationEvent extends Event<Message> {
private static final long serialVersionUID = 0L;

2
client/src/main/java/envoy/client/event/SendEvent.java
View File

@ -10,7 +10,7 @@ import envoy.event.Event;
* @author: Maximilian K&aumlfer
* @since Envoy Client v0.3-alpha
*/
public class SendEvent extends Event<Event<?>> {
public final class SendEvent extends Event<Event<?>> {
private static final long serialVersionUID = 0L;

2
client/src/main/java/envoy/client/event/ThemeChangeEvent.java
View File

@ -10,7 +10,7 @@ import envoy.event.Event;
* @author Kai S. K. Engelbart
* @since Envoy Client v0.2-alpha
*/
public class ThemeChangeEvent extends Event<String> {
public final class ThemeChangeEvent extends Event<String> {
private static final long serialVersionUID = 0L;

9
client/src/main/java/envoy/client/net/Client.java
View File

@ -29,7 +29,7 @@ import envoy.util.SerializationUtils;
* @author Leon Hofmeister
* @since Envoy Client v0.1-alpha
*/
public class Client implements Closeable {
public final class Client implements Closeable {
// Connection handling
private Socket socket;
@ -164,6 +164,13 @@ public class Client implements Closeable {
// Process ProfilePicChanges
receiver.registerProcessor(ProfilePicChange.class, eventBus::dispatch);
// Process requests to not send any more attachments as they will not be shown to
// other users
receiver.registerProcessor(NoAttachments.class, eventBus::dispatch);
// Process group creation results - they might have been disabled on the server
receiver.registerProcessor(GroupCreationResult.class, eventBus::dispatch);
// Send event
eventBus.register(SendEvent.class, evt -> {
try {

6
client/src/main/java/envoy/client/net/GroupMessageStatusChangeProcessor.java
View File

@ -12,14 +12,14 @@ import envoy.util.EnvoyLog;
* Project: <strong>envoy-client</strong><br>
* File: <strong>GroupMessageStatusChangePocessor.java</strong><br>
* Created: <strong>03.07.2020</strong><br>
*
*
* @author Maximilian K&auml;fer
* @since Envoy Client v0.1-beta
*/
public class GroupMessageStatusChangeProcessor implements Consumer<GroupMessageStatusChange> {
public final class GroupMessageStatusChangeProcessor implements Consumer<GroupMessageStatusChange> {
private static final Logger logger = EnvoyLog.getLogger(GroupMessageStatusChangeProcessor.class);
@Override
public void accept(GroupMessageStatusChange evt) {
if (evt.get().ordinal() < MessageStatus.RECEIVED.ordinal()) logger.warning("Received invalid group message status change " + evt);

2
client/src/main/java/envoy/client/net/MessageStatusChangeProcessor.java
View File

@ -16,7 +16,7 @@ import envoy.util.EnvoyLog;
* @author Kai S. K. Engelbart
* @since Envoy Client v0.3-alpha
*/
public class MessageStatusChangeProcessor implements Consumer<MessageStatusChange> {
public final class MessageStatusChangeProcessor implements Consumer<MessageStatusChange> {
private static final Logger logger = EnvoyLog.getLogger(MessageStatusChangeProcessor.class);

4
client/src/main/java/envoy/client/net/ReceivedGroupMessageProcessor.java
View File

@ -13,11 +13,11 @@ import envoy.util.EnvoyLog;
* Project: <strong>envoy-client</strong><br>
* File: <strong>ReceivedGroupMessageProcessor.java</strong><br>
* Created: <strong>13.06.2020</strong><br>
*
*
* @author Maximilian K&auml;fer
* @since Envoy Client v0.1-beta
*/
public class ReceivedGroupMessageProcessor implements Consumer<GroupMessage> {
public final class ReceivedGroupMessageProcessor implements Consumer<GroupMessage> {
private static final Logger logger = EnvoyLog.getLogger(ReceivedGroupMessageProcessor.class);

2
client/src/main/java/envoy/client/net/ReceivedMessageProcessor.java
View File

@ -15,7 +15,7 @@ import envoy.event.EventBus;
* @author Kai S. K. Engelbart
* @since Envoy Client v0.3-alpha
*/
public class ReceivedMessageProcessor implements Consumer<Message> {
public final class ReceivedMessageProcessor implements Consumer<Message> {
@Override
public void accept(Message message) {

15
client/src/main/java/envoy/client/net/Receiver.java
View File

@ -22,7 +22,9 @@ import envoy.util.SerializationUtils;
* @author Kai S. K. Engelbart
* @since Envoy Client v0.3-alpha
*/
public class Receiver extends Thread {
public final class Receiver extends Thread {
private boolean isAlive = true;
private final InputStream in;
private final Map<Class<?>, Consumer<?>> processors = new HashMap<>();
@ -49,7 +51,7 @@ public class Receiver extends Thread {
@Override
public void run() {
while (true) {
while (isAlive)
try {
// Read object length
final byte[] lenBytes = new byte[4];
@ -64,6 +66,12 @@ public class Receiver extends Thread {
// Catch LV encoding errors
if (len != bytesRead) {
// Server has stopped sending, i.e. because he went offline
if (bytesRead == -1) {
isAlive = false;
logger.log(Level.INFO, "Lost connection to the server. Exiting receiver...");
continue;
}
logger.log(Level.WARNING,
String.format("LV encoding violated: expected %d bytes, received %d bytes. Discarding object...", len, bytesRead));
continue;
@ -87,7 +95,6 @@ public class Receiver extends Thread {
} catch (final Exception e) {
logger.log(Level.SEVERE, "Error on receiver thread", e);
}
}
}
/**
@ -102,7 +109,7 @@ public class Receiver extends Thread {
/**
* Adds a map of object processors to this {@link Receiver}.
*
*
* @param processors the processors to add the processors to add
* @since Envoy Client v0.1-beta
*/

6
client/src/main/java/envoy/client/net/WriteProxy.java
View File

@ -22,7 +22,7 @@ import envoy.util.EnvoyLog;
* @author Kai S. K. Engelbart
* @since Envoy Client v0.3-alpha
*/
public class WriteProxy {
public final class WriteProxy {
private final Client client;
private final LocalDB localDB;
@ -68,9 +68,7 @@ public class WriteProxy {
*
* @since Envoy Client v0.3-alpha
*/
public void flushCache() {
localDB.getCacheMap().getMap().values().forEach(Cache::relay);
}
public void flushCache() { localDB.getCacheMap().getMap().values().forEach(Cache::relay); }
/**
* Delivers a message to the server if online. Otherwise the message is cached

26
client/src/main/java/envoy/client/ui/ClearableTextField.java
View File

@ -22,7 +22,7 @@ import javafx.scene.layout.GridPane;
* @author Leon Hofmeister
* @since Envoy Client v0.1-beta
*/
public class ClearableTextField extends GridPane {
public final class ClearableTextField extends GridPane {
private final TextField textField;
@ -88,82 +88,82 @@ public class ClearableTextField extends GridPane {
* @see javafx.scene.control.TextInputControl#promptTextProperty()
* @since Envoy Client v0.1-beta
*/
public final StringProperty promptTextProperty() { return textField.promptTextProperty(); }
public StringProperty promptTextProperty() { return textField.promptTextProperty(); }
/**
* @return the current prompt text
* @see javafx.scene.control.TextInputControl#getPromptText()
* @since Envoy Client v0.1-beta
*/
public final String getPromptText() { return textField.getPromptText(); }
public String getPromptText() { return textField.getPromptText(); }
/**
* @param value the prompt text to display
* @see javafx.scene.control.TextInputControl#setPromptText(java.lang.String)
* @since Envoy Client v0.1-beta
*/
public final void setPromptText(String value) { textField.setPromptText(value); }
public void setPromptText(String value) { textField.setPromptText(value); }
/**
* @return the current property of the tooltip
* @see javafx.scene.control.Control#tooltipProperty()
* @since Envoy Client v0.1-beta
*/
public final ObjectProperty<Tooltip> tooltipProperty() { return textField.tooltipProperty(); }
public ObjectProperty<Tooltip> tooltipProperty() { return textField.tooltipProperty(); }
/**
* @param value the new tooltip
* @see javafx.scene.control.Control#setTooltip(javafx.scene.control.Tooltip)
* @since Envoy Client v0.1-beta
*/
public final void setTooltip(Tooltip value) { textField.setTooltip(value); }
public void setTooltip(Tooltip value) { textField.setTooltip(value); }
/**
* @return the current tooltip
* @see javafx.scene.control.Control#getTooltip()
* @since Envoy Client v0.1-beta
*/
public final Tooltip getTooltip() { return textField.getTooltip(); }
public Tooltip getTooltip() { return textField.getTooltip(); }
/**
* @return the current property of the context menu
* @see javafx.scene.control.Control#contextMenuProperty()
* @since Envoy Client v0.1-beta
*/
public final ObjectProperty<ContextMenu> contextMenuProperty() { return textField.contextMenuProperty(); }
public ObjectProperty<ContextMenu> contextMenuProperty() { return textField.contextMenuProperty(); }
/**
* @param value the new context menu
* @see javafx.scene.control.Control#setContextMenu(javafx.scene.control.ContextMenu)
* @since Envoy Client v0.1-beta
*/
public final void setContextMenu(ContextMenu value) { textField.setContextMenu(value); }
public void setContextMenu(ContextMenu value) { textField.setContextMenu(value); }
/**
* @return the current context menu
* @see javafx.scene.control.Control#getContextMenu()
* @since Envoy Client v0.1-beta
*/
public final ContextMenu getContextMenu() { return textField.getContextMenu(); }
public ContextMenu getContextMenu() { return textField.getContextMenu(); }
/**
* @param value whether this ClearableTextField should be editable
* @see javafx.scene.control.TextInputControl#setEditable(boolean)
* @since Envoy Client v0.1-beta
*/
public final void setEditable(boolean value) { textField.setEditable(value); }
public void setEditable(boolean value) { textField.setEditable(value); }
/**
* @return the current property whether this ClearableTextField is editable
* @see javafx.scene.control.TextInputControl#editableProperty()
* @since Envoy Client v0.1-beta
*/
public final BooleanProperty editableProperty() { return textField.editableProperty(); }
public BooleanProperty editableProperty() { return textField.editableProperty(); }
/**
* @return whether this {@code ClearableTextField} is editable
* @see javafx.scene.control.TextInputControl#isEditable()
* @since Envoy Client v0.1-beta
*/
public final boolean isEditable() { return textField.isEditable(); }
public boolean isEditable() { return textField.isEditable(); }
}

4
client/src/main/java/envoy/client/ui/IconUtil.java
View File

@ -24,7 +24,7 @@ import envoy.util.EnvoyLog;
* @author Kai S. K. Engelbart
* @since Envoy Client v0.1-beta
*/
public class IconUtil {
public final class IconUtil {
private IconUtil() {}
@ -160,7 +160,7 @@ public class IconUtil {
BufferedImage image = null;
try {
image = ImageIO.read(IconUtil.class.getResource(path));
} catch (IOException e) {
} catch (final IOException e) {
EnvoyLog.getLogger(IconUtil.class).log(Level.WARNING, String.format("Could not load image at path %s: ", path), e);
}
return image;

25
client/src/main/java/envoy/client/ui/Startup.java
View File

@ -2,7 +2,6 @@ package envoy.client.ui;
import java.io.File;
import java.io.IOException;
import java.util.Properties;
import java.util.logging.Level;
import java.util.logging.Logger;
@ -19,7 +18,6 @@ import envoy.data.GroupMessage;
import envoy.data.Message;
import envoy.event.GroupMessageStatusChange;
import envoy.event.MessageStatusChange;
import envoy.exception.EnvoyException;
import envoy.util.EnvoyLog;
/**
@ -57,30 +55,13 @@ public final class Startup extends Application {
@Override
public void start(Stage stage) throws Exception {
try {
// Load the configuration from client.properties first
final Properties properties = new Properties();
properties.load(Startup.class.getClassLoader().getResourceAsStream("client.properties"));
config.load(properties);
// Override configuration values with command line arguments
final String[] args = getParameters().getRaw().toArray(new String[0]);
if (args.length > 0) config.load(args);
// Check if all mandatory configuration values have been initialized
if (!config.isInitialized()) throw new EnvoyException("Configuration is not fully initialized");
} catch (final Exception e) {
config.loadAll(Startup.class, "client.properties", getParameters().getRaw().toArray(new String[0]));
EnvoyLog.initialize(config);
} catch (final IllegalStateException 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);
}
// Setup logger for the envoy package
EnvoyLog.initialize(config);
EnvoyLog.attach("envoy");
EnvoyLog.setFileLevelBarrier(config.getFileLevelBarrier());
EnvoyLog.setConsoleLevelBarrier(config.getConsoleLevelBarrier());
logger.log(Level.INFO, "Envoy starting...");
// Initialize the local database

6
client/src/main/java/envoy/client/ui/StatusTrayIcon.java
View File

@ -18,7 +18,7 @@ import envoy.event.EventBus;
* @author Kai S. K. Engelbart
* @since Envoy Client v0.2-alpha
*/
public class StatusTrayIcon {
public final class StatusTrayIcon {
/**
* The {@link TrayIcon} provided by the System Tray API for controlling the
@ -85,12 +85,12 @@ public class StatusTrayIcon {
public void show() {
try {
SystemTray.getSystemTray().add(trayIcon);
} catch (AWTException e) {}
} catch (final AWTException e) {}
}
/**
* Removes the icon from the system tray.
*
*
* @since Envoy Client v0.2-beta
*/
public void hide() { SystemTray.getSystemTray().remove(trayIcon); }

26
client/src/main/java/envoy/client/ui/controller/ChatScene.java
View File

@ -87,6 +87,12 @@ public final class ChatScene implements Restorable {
@FXML
private Button settingsButton;
@FXML
private Button messageSearchButton;
@FXML
private Button newGroupButton;
@FXML
private TextArea messageTextArea;
@ -108,9 +114,6 @@ public final class ChatScene implements Restorable {
@FXML
private Label topBarStatusLabel;
@FXML
private Button messageSearchButton;
@FXML
private ImageView clientProfilePic;
@ -141,7 +144,7 @@ public final class ChatScene implements Restorable {
private AudioRecorder recorder;
private boolean recording;
private Attachment pendingAttachment;
private boolean postingPermanentlyDisabled;
private boolean postingPermanentlyDisabled;
private final SystemCommandsMap messageTextAreaCommands = new SystemCommandsMap();
@ -265,6 +268,21 @@ public final class ChatScene implements Restorable {
break;
}
});
// Disable attachment button if server says attachments will be filtered out
eventBus.register(NoAttachments.class, e -> {
Platform.runLater(() -> {
attachmentButton.setDisable(true);
voiceButton.setDisable(true);
final var alert = new Alert(AlertType.ERROR);
alert.setTitle("No attachments possible");
alert.setHeaderText("Your current server does not support attachments.");
alert.setContentText("If this is unplanned, please contact your server administrator.");
alert.showAndWait();
});
});
eventBus.register(GroupCreationResult.class, e -> Platform.runLater(() -> { newGroupButton.setDisable(!e.get()); }));
}
private AnchorPane createOfflineNote() {

8
client/src/main/java/envoy/client/ui/controller/SettingsScene.java
View File

@ -18,7 +18,7 @@ import envoy.client.ui.settings.*;
* @author Kai S. K. Engelbart
* @since Envoy Client v0.1-beta
*/
public class SettingsScene {
public final class SettingsScene {
@FXML
private ListView<SettingsPane> settingsList;
@ -36,12 +36,10 @@ public class SettingsScene {
*/
public void initializeData(SceneContext sceneContext, Client client) {
this.sceneContext = sceneContext;
final var user = client.getSender();
final var online = client.isOnline();
settingsList.getItems().add(new GeneralSettingsPane());
settingsList.getItems().add(new UserSettingsPane(sceneContext, user, online));
settingsList.getItems().add(new UserSettingsPane(sceneContext, client.getSender(), client.isOnline()));
settingsList.getItems().add(new DownloadSettingsPane(sceneContext));
settingsList.getItems().add(new BugReportPane( user, online));
settingsList.getItems().add(new BugReportPane(client.getSender(), client.isOnline()));
}
@FXML

6
client/src/main/java/envoy/client/ui/listcell/ChatControl.java
View File

@ -23,7 +23,7 @@ import envoy.data.Group;
* @author Leon Hofmeister
* @since Envoy Client v0.1-beta
*/
public class ChatControl extends HBox {
public final class ChatControl extends HBox {
/**
* @param chat the chat to display
@ -36,7 +36,7 @@ public class ChatControl extends HBox {
ImageView contactProfilePic;
if (chat.getRecipient() instanceof Group) contactProfilePic = new ImageView(IconUtil.loadIconThemeSensitive("group_icon", 32));
else contactProfilePic = new ImageView(IconUtil.loadIconThemeSensitive("user_icon", 32));
Rectangle clip = new Rectangle();
final var clip = new Rectangle();
clip.setWidth(32);
clip.setHeight(32);
clip.setArcHeight(32);
@ -44,7 +44,7 @@ public class ChatControl extends HBox {
contactProfilePic.setClip(clip);
getChildren().add(contactProfilePic);
// spacing
Region leftSpacing = new Region();
final var leftSpacing = new Region();
leftSpacing.setPrefSize(8, 0);
leftSpacing.setMinSize(8, 0);
leftSpacing.setMaxSize(8, 0);

2
client/src/main/java/envoy/client/ui/listcell/ContactControl.java
View File

@ -18,7 +18,7 @@ import envoy.data.User;
* @author Kai S. K. Engelbart
* @since Envoy Client v0.2-beta
*/
public class ContactControl extends VBox {
public final class ContactControl extends VBox {
/**
* @param contact the contact to display

5
client/src/main/java/envoy/client/ui/listcell/MessageControl.java
View File

@ -24,7 +24,6 @@ import envoy.client.data.Settings;
import envoy.client.ui.AudioControl;
import envoy.client.ui.IconUtil;
import envoy.client.ui.SceneContext;
import envoy.data.GroupMessage;
import envoy.data.Message;
import envoy.data.Message.MessageStatus;
@ -42,7 +41,7 @@ import envoy.util.EnvoyLog;
* @author Maximilian K&auml;fer
* @since Envoy Client v0.1-beta
*/
public class MessageControl extends Label {
public final class MessageControl extends Label {
private boolean ownMessage;
@ -179,7 +178,7 @@ public class MessageControl extends Label {
}
/**
* @param localDB the localDB used by the current user
* @param localDB the localDB used by the current user
* @since Envoy Client v0.2-beta
*/
public static void setLocalDB(LocalDB localDB) { MessageControl.localDB = localDB; }

10
client/src/main/java/envoy/client/ui/settings/BugReportPane.java
View File

@ -5,6 +5,7 @@ import javafx.scene.control.*;
import javafx.scene.input.InputEvent;
import envoy.client.event.SendEvent;
import envoy.client.util.IssueUtil;
import envoy.data.User;
import envoy.event.EventBus;
import envoy.event.IssueProposal;
@ -20,7 +21,7 @@ import envoy.event.IssueProposal;
* @author Leon Hofmeister
* @since Envoy Client v0.2-beta
*/
public class BugReportPane extends OnlyIfOnlineSettingsPane {
public final class BugReportPane extends OnlyIfOnlineSettingsPane {
private final Label titleLabel = new Label("Suggest a title for the bug:");
private final TextField titleTextField = new TextField();
@ -41,7 +42,7 @@ public class BugReportPane extends OnlyIfOnlineSettingsPane {
public BugReportPane(User user, boolean online) {
super("Report a bug", online);
setSpacing(10);
setToolTipText("A bug can only be reported when being online");
setToolTipText("A bug can only be reported while being online");
// Displaying the label to ask for a title
titleLabel.setWrapText(true);
@ -68,8 +69,9 @@ public class BugReportPane extends OnlyIfOnlineSettingsPane {
submitReportButton.setDisable(true);
submitReportButton.setOnAction(e -> {
EventBus.getInstance()
.dispatch(new SendEvent(new IssueProposal(titleTextField.getText(), errorDetailArea.getText(),
showUsernameInBugReport.isSelected() ? user.getName() : null, true)));
.dispatch(new SendEvent(new IssueProposal(titleTextField.getText(),
IssueUtil.sanitizeIssueDescription(errorDetailArea.getText(), showUsernameInBugReport.isSelected() ? user.getName() : null),
true)));
});
getChildren().add(submitReportButton);
}

2
client/src/main/java/envoy/client/ui/settings/DownloadSettingsPane.java
View File

@ -17,7 +17,7 @@ import envoy.client.ui.SceneContext;
* @author Leon Hofmeister
* @since Envoy Client v0.2-beta
*/
public class DownloadSettingsPane extends SettingsPane {
public final class DownloadSettingsPane extends SettingsPane {
/**
* Constructs a new {@code DownloadSettingsPane}.

2
client/src/main/java/envoy/client/ui/settings/GeneralSettingsPane.java
View File

@ -16,7 +16,7 @@ import envoy.event.EventBus;
* @author Kai S. K. Engelbart
* @since Envoy Client v0.1-beta
*/
public class GeneralSettingsPane extends SettingsPane {
public final class GeneralSettingsPane extends SettingsPane {
/**
* @since Envoy Client v0.1-beta

10
client/src/main/java/envoy/client/ui/settings/OnlyIfOnlineSettingsPane.java
View File

@ -16,14 +16,14 @@ import javafx.scene.paint.Color;
* <p>
* Project: <strong>client</strong><br>
* File: <strong>OnlyIfOnlineSettingsPane.java</strong><br>
* Created: <strong>Aug 4, 2020</strong><br>
* Created: <strong>04.08.2020</strong><br>
*
* @author Leon Hofmeister
* @since Envoy Client v0.2-beta
*/
public abstract class OnlyIfOnlineSettingsPane extends SettingsPane {
private final Tooltip beOnlineReminder = new Tooltip("You need to be online to modify your acount.");
private final Tooltip beOnlineReminder = new Tooltip("You need to be online to modify your account.");
/**
* @param title
@ -32,11 +32,9 @@ public abstract class OnlyIfOnlineSettingsPane extends SettingsPane {
protected OnlyIfOnlineSettingsPane(String title, boolean online) {
super(title);
final var offline = !online;
setDisable(!online);
setDisable(offline);
if (offline) {
if (!online) {
final var infoLabel = new Label("You shall not pass!\n(... Unless you would happen to be online)");
infoLabel.setId("infoLabel-warning");
infoLabel.setWrapText(true);

2
client/src/main/java/envoy/client/ui/settings/UserSettingsPane.java
View File

@ -35,7 +35,7 @@ import envoy.util.EnvoyLog;
* @author Leon Hofmeister
* @since Envoy Client v0.2-beta
*/
public class UserSettingsPane extends OnlyIfOnlineSettingsPane {
public final class UserSettingsPane extends OnlyIfOnlineSettingsPane {
private boolean profilePicChanged, usernameChanged, validPassword;
private byte[] currentImageBytes;

40
client/src/main/java/envoy/client/util/IssueUtil.java Normal file
View File

@ -0,0 +1,40 @@
package envoy.client.util;
/**
* Provides methods to handle outgoing issues.
* <p>
* Project: <strong>client</strong><br>
* File: <strong>IssueUtil.java</strong><br>
* Created: <strong>20.08.2020</strong><br>
*
* @author Leon Hofmeister
* @since Envoy Client v0.2-beta
*/
public final class IssueUtil {
/**
*
* @since Envoy Client v0.2-beta
*/
private IssueUtil() {}
/**
* Performs actions to ensure the description of an issue will be displayed as
* intended by the user.
*
* @param rawDescription the description to sanitize
* @param username the user who submitted the issue. Should be
* {@code null} if he does not want to be named.
* @return the sanitized description
* @since Envoy Client v0.2-beta
*/
public static String sanitizeIssueDescription(String rawDescription, String username) {
// Appending the submitter name, if this option was enabled
rawDescription += username != null
? (rawDescription.endsWith("\n") || rawDescription.endsWith("<br>") ? "" : "<br>") + String.format("Submitted by user %s.", username)
: "";
// Markdown does not support "normal" line breaks. It uses "<br>"
rawDescription = rawDescription.replaceAll(System.getProperty("line.separator", "\r?\n"), "<br>");
return rawDescription;
}
}

2
client/src/main/java/envoy/client/util/ReflectionUtil.java
View File

@ -15,7 +15,7 @@ import javafx.scene.Node;
* @author Leon Hofmeister
* @since Envoy Client v0.2-beta
*/
public class ReflectionUtil {
public final class ReflectionUtil {
private ReflectionUtil() {}

10
client/src/main/resources/client.properties
View File

@ -1,4 +1,6 @@
server=localhost
port=8080
localDB=localDB
consoleLevelBarrier=FINER
server=localhost
port=8080
localDB=localDB
consoleLevelBarrier=FINER
fileLevelBarrier=OFF
ignoreLocalDB=false

63
client/src/main/resources/fxml/ChatScene.fxml
View File

@ -113,8 +113,71 @@
<GridPane.margin>
<Insets right="1.0" />
</GridPane.margin>
<<<<<<< HEAD
</TabPane>
<HBox id="top-bar" alignment="CENTER_LEFT" prefHeight="100.0">
=======
<children>
<VBox id="search-panel" maxHeight="-Infinity" minHeight="-Infinity" prefHeight="80.0" prefWidth="316.0">
<children>
<Label id="contact-search-enter-container" maxHeight="30.0" minHeight="30.0" prefHeight="30.0" prefWidth="325.0">
<graphic>
<TextArea id="contactSearchInput" fx:id="contactSearch" focusTraversable="false" maxHeight="30.0" minHeight="30.0" onInputMethodTextChanged="#searchContacts" onKeyTyped="#searchContacts" prefHeight="30.0" prefWidth="200.0" promptText="Search Contacts">
<font>
<Font size="14.0" />
</font>
<padding>
<Insets left="12.0" right="12.0" />
</padding>
</TextArea>
</graphic>
<VBox.margin>
<Insets left="10.0" right="10.0" top="3.0" />
</VBox.margin>
</Label>
<HBox id="underline" alignment="TOP_CENTER" prefHeight="41.0" prefWidth="296.0" spacing="5.0">
<children>
<Button mnemonicParsing="true" onAction="#addContactButtonClicked" prefWidth="100.0" text=" Add Contact">
<padding>
<Insets bottom="5.0" left="5.0" right="5.0" top="5.0" />
</padding>
<HBox.margin>
<Insets />
</HBox.margin>
</Button>
<Button fx:id="newGroupButton" mnemonicParsing="false" prefWidth="100.0" text="New Group">
<HBox.margin>
<Insets />
</HBox.margin>
<padding>
<Insets bottom="5.0" left="5.0" right="5.0" top="5.0" />
</padding></Button>
</children>
<VBox.margin>
<Insets left="10.0" right="10.0" top="5.0" />
</VBox.margin>
<padding>
<Insets top="3.0" />
</padding>
</HBox>
</children>
</VBox>
<ListView id="chatList" fx:id="chatList" focusTraversable="false" onMouseClicked="#chatListClicked" 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>
<Insets bottom="5.0" left="5.0" right="2.0" top="5.0" />
</padding>
</ListView>
</children>
</VBox>
<HBox id="topBar" alignment="CENTER_LEFT" prefHeight="100.0">
>>>>>>> refs/heads/develop
<children>
<ImageView id="profile-pic" fx:id="clientProfilePic" fitHeight="43.0" fitWidth="43.0" pickOnBounds="true" preserveRatio="true">
<HBox.margin>

2
common/.settings/org.eclipse.jdt.ui.prefs
View File

File diff suppressed because one or more lines are too long

2
common/src/main/java/envoy/data/Attachment.java
View File

@ -14,7 +14,7 @@ import java.io.Serializable;
* @author Kai S. K. Engelbart
* @since Envoy Common v0.2-alpha
*/
public class Attachment implements Serializable {
public final class Attachment implements Serializable {
/**
* Defines the type of the attachment.

146
common/src/main/java/envoy/data/Config.java
View File

@ -1,15 +1,25 @@
package envoy.data;
import java.io.File;
import java.io.IOException;
import java.util.*;
import java.util.function.Function;
import java.util.logging.Level;
import java.util.stream.Collectors;
import envoy.exception.EnvoyException;
import envoy.util.EnvoyLog;
/**
* Manages all application settings that are set during application startup by
* either loading them from the {@link Properties} file
* either loading them from the {@link Properties} file (default values)
* {@code client.properties} or parsing them from the command line arguments of
* the application.<br>
* <br>
* the application.
* <p>
* All items inside the {@code Config} are supposed to either be supplied over
* default value or over command line argument. Developers that fail to provide
* default values will be greeted with an error message the next time they try
* to start Envoy...
* <p>
* Project: <strong>envoy-client</strong><br>
* File: <strong>Config.java</strong><br>
* Created: <strong>12 Oct 2019</strong><br>
@ -21,60 +31,109 @@ public class Config {
protected Map<String, ConfigItem<?>> items = new HashMap<>();
private boolean modificationDisabled;
protected Config(String folderName) {
final var rootDirectory = new File(System.getProperty("user.home"), folderName);
put("homeDirectory", "home", File::new);
((ConfigItem<File>) get("homeDirectory")).setValue(rootDirectory);
put("fileLevelBarrier", "fb", Level::parse);
put("consoleLevelBarrier", "cb", Level::parse);
}
/**
* Parses config items from a properties object.
*
* @param properties the properties object to parse
* @since Envoy Common v0.1-beta
*/
public void load(Properties properties) {
items.entrySet()
.stream()
.filter(e -> properties.containsKey(e.getKey()))
.forEach(e -> e.getValue().parse(properties.getProperty(e.getKey())));
private void load(Properties properties) {
items.entrySet().stream().filter(e -> properties.containsKey(e.getKey()))
.forEach(e -> e.getValue().parse(properties.getProperty(e.getKey())));
}
/**
* Parses config items from an array of command line arguments.
*
* @param args the command line arguments to parse
* @throws EnvoyException if the command line arguments contain an unknown token
* @throws IllegalStateException if a malformed command line argument has been
* supplied
* @since Envoy Common v0.1-beta
*/
public void load(String[] args) throws EnvoyException {
private void load(String[] args) {
for (int i = 0; i < args.length; i++)
for (ConfigItem<?> item : items.values())
for (final ConfigItem<?> item : items.values())
if (args[i].startsWith("--")) {
if (args[i].length() == 2) throw new EnvoyException("Malformed command line argument at position " + i);
if (args[i].length() == 2)
throw new IllegalStateException(
"Malformed command line argument at position " + i + ": " + args[i]);
final String commandLong = args[i].substring(2);
if (item.getCommandLong().equals(commandLong)) {
item.parse(args[++i]);
break;
}
} else if (args[i].startsWith("-")) {
if (args[i].length() == 1) throw new EnvoyException("Malformed command line argument at position " + i);
if (args[i].length() == 1)
throw new IllegalStateException(
"Malformed command line argument at position " + i + ": " + args[i]);
final String commandShort = args[i].substring(1);
if (item.getCommandShort().equals(commandShort)) {
item.parse(args[++i]);
break;
}
} else throw new EnvoyException("Malformed command line argument at position " + i);
} else
throw new IllegalStateException(
"Malformed command line argument at position " + i + ": " + args[i]);
}
/**
* Initializes config items from a map.
*
* @param items the items to include in this config
* Supplies default values from the given .properties file and parses the
* configuration from an array of command line arguments.
*
* @param declaringClass the class calling this method
* @param propertiesFilePath the path to where the .properties file can be found
* - will be only the file name if it is located
* directly inside the {@code src/main/resources}
* folder
* @param args the command line arguments to parse
* @throws IllegalStateException if this method is getting called again or if a
* malformed command line argument has been
* supplied
* @since Envoy Common v0.1-beta
*/
public void load(Map<String, ConfigItem<?>> items) { this.items.putAll(items); }
public void loadAll(Class<?> declaringClass, String propertiesFilePath, String[] args) {
if (modificationDisabled)
throw new IllegalStateException("Cannot change config after isInitialized has been called");
// Load the defaults from the given .properties file first
final var properties = new Properties();
try {
properties.load(declaringClass.getClassLoader().getResourceAsStream(propertiesFilePath));
} catch (final IOException e) {
EnvoyLog.getLogger(Config.class).log(Level.SEVERE, "An error occurred when reading in the configuration: ",
e);
}
load(properties);
// Override configuration values with command line arguments
if (args.length > 0)
load(args);
// Check if all configuration values have been initialized
isInitialized();
// Disable further editing of the config
modificationDisabled = true;
}
/**
* @return {@code true} if all mandatory config items are initialized
* @throws IllegalStateException if a {@link ConfigItem} has not been
* initialized
* @since Envoy Common v0.1-beta
*/
public boolean isInitialized() {
return items.values().stream().filter(ConfigItem::isMandatory).map(ConfigItem::get).noneMatch(Objects::isNull);
private void isInitialized() {
if (items.values().stream().map(ConfigItem::get).anyMatch(Objects::isNull))
throw new IllegalStateException("config item(s) has/ have not been initialized:"
+ items.values().stream().filter(configItem -> configItem.get() == null)
.map(ConfigItem::getCommandLong).collect(Collectors.toSet()));
}
/**
@ -82,5 +141,46 @@ public class Config {
* @return the config item with the specified name
* @since Envoy Common v0.1-beta
*/
public ConfigItem<?> get(String name) { return items.get(name); }
public ConfigItem<?> get(String name) {
return items.get(name);
}
/**
* Shorthand for <br>
* {@code items.put(commandName, new ConfigItem<>(commandName, commandShort, parseFunction, defaultValue))}.
*
* @param <T> the type of the {@link ConfigItem}
* @param commandName the key for this config item as well as its long name
* @param commandShort the abbreviation of this config item
* @param parseFunction the {@code Function<String, T>} that parses the value
* from a string
* @since Envoy Common v0.2-beta
*/
protected <T> void put(String commandName, String commandShort, Function<String, T> parseFunction) {
items.put(commandName, new ConfigItem<>(commandName, commandShort, parseFunction));
}
/**
* @return the directory in which all local files are saves
* @since Envoy Client v0.2-beta
*/
public File getHomeDirectory() {
return (File) items.get("homeDirectory").get();
}
/**
* @return the minimal {@link Level} to log inside the log file
* @since Envoy Client v0.2-beta
*/
public Level getFileLevelBarrier() {
return (Level) items.get("fileLevelBarrier").get();
}
/**
* @return the minimal {@link Level} to log inside the console
* @since Envoy Client v0.2-beta
*/
public Level getConsoleLevelBarrier() {
return (Level) items.get("consoleLevelBarrier").get();
}
}

40
common/src/main/java/envoy/data/ConfigItem.java
View File

@ -4,8 +4,10 @@ import java.util.function.Function;
/**
* Contains a single {@link Config} value as well as the corresponding command
* line arguments and its default value.<br>
* <br>
* line arguments and its default value.
* <p>
* All {@code ConfigItem}s are automatically mandatory.
* <p>
* Project: <strong>envoy-clientChess</strong><br>
* File: <strong>ConfigItem.javaEvent.java</strong><br>
* Created: <strong>21.12.2019</strong><br>
@ -14,11 +16,10 @@ import java.util.function.Function;
* @param <T> the type of the config item's value
* @since Envoy Common v0.1-beta
*/
public class ConfigItem<T> {
public final class ConfigItem<T> {
private final String commandLong, commandShort;
private final Function<String, T> parseFunction;
private final boolean mandatory;
private T value;
@ -29,30 +30,12 @@ public class ConfigItem<T> {
* @param commandShort the short command line argument to set this value
* @param parseFunction the {@code Function<String, T>} that parses the value
* from a string
* @param defaultValue the optional default value to set before parsing
* @param mandatory indicated that this config item must be initialized with
* a non-null value
* @since Envoy Common v0.1-beta
*/
public ConfigItem(String commandLong, String commandShort, Function<String, T> parseFunction, T defaultValue, boolean mandatory) {
this.commandLong = commandLong;
this.commandShort = commandShort;
this.parseFunction = parseFunction;
this.mandatory = mandatory;
value = defaultValue;
}
/**
* Initializes an optional {@link ConfigItem} without a default value.
*
* @param commandLong the long command line argument to set this value
* @param commandShort the short command line argument to set this value
* @param parseFunction the {@code Function<String, T>} that parses the value
* from a string
* @since Envoy Common v0.1-beta
*/
public ConfigItem(String commandLong, String commandShort, Function<String, T> parseFunction) {
this(commandLong, commandShort, parseFunction, null, false);
this.commandLong = commandLong;
this.commandShort = commandShort;
this.parseFunction = parseFunction;
}
/**
@ -84,9 +67,8 @@ public class ConfigItem<T> {
public T get() { return value; }
/**
* @return {@code true} if this {@link ConfigItem} is mandatory for successful
* application initialization
* @since Envoy Common v0.1-beta
* @param value the value to set
* @since Envoy Common v0.2-beta
*/
public boolean isMandatory() { return mandatory; }
protected void setValue(T value) { this.value = value; }
}

2
common/src/main/java/envoy/data/IDGenerator.java
View File

@ -12,7 +12,7 @@ import java.io.Serializable;
* @author Kai S. K. Engelbart
* @since Envoy Common v0.2-alpha
*/
public class IDGenerator implements Serializable {
public final class IDGenerator implements Serializable {
private final long end;
private long current;

16
common/src/main/java/envoy/data/MessageBuilder.java
View File

@ -16,13 +16,13 @@ import envoy.data.Message.MessageStatus;
* @author Kai S. K. Engelbart
* @since Envoy Common v0.2-alpha
*/
public class MessageBuilder {
public final class MessageBuilder {
// Mandatory properties without default values
private final long senderID, recipientID;
// Properties with default values
private long id;
private final long id;
private Instant creationDate, receivedDate, readDate;
private String text;
private Attachment attachment;
@ -69,11 +69,11 @@ public class MessageBuilder {
*/
public MessageBuilder(Message msg, long recipientID, IDGenerator iDGenerator) {
this(msg.getRecipientID(), recipientID, iDGenerator.next());
this.attachment = msg.getAttachment();
this.creationDate = Instant.now();
this.forwarded = true;
this.text = msg.getText();
this.status = MessageStatus.WAITING;
attachment = msg.getAttachment();
creationDate = Instant.now();
forwarded = true;
text = msg.getText();
status = MessageStatus.WAITING;
}
/**
@ -128,7 +128,7 @@ public class MessageBuilder {
* @since Envoy Common v0.2-alpha
*/
public GroupMessage buildGroupMessage(Group group) {
var memberStatuses = new HashMap<Long, Message.MessageStatus>();
final var memberStatuses = new HashMap<Long, Message.MessageStatus>();
group.getContacts().forEach(user -> memberStatuses.put(user.getID(), MessageStatus.WAITING));
return buildGroupMessage(group, memberStatuses);
}

2
common/src/main/java/envoy/event/EventBus.java
View File

@ -17,7 +17,7 @@ import java.util.function.Consumer;
* @author Kai S. K. Engelbart
* @since Envoy v0.2-alpha
*/
public class EventBus {
public final class EventBus {
/**
* Contains all event handler instances registered at this event bus as values

2
common/src/main/java/envoy/event/GroupCreation.java
View File

@ -15,7 +15,7 @@ import envoy.data.User;
* @author Leon Hofmeister
* @since Envoy Common v0.1-beta
*/
public class GroupCreation extends Event<String> {
public final class GroupCreation extends Event<String> {
private final Set<Long> initialMemberIDs;

25
common/src/main/java/envoy/event/GroupCreationResult.java Normal file
View File

@ -0,0 +1,25 @@
package envoy.event;
/**
* 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.
* <p>
* Project: <strong>common</strong><br>
* File: <strong>GroupCreationResult.java</strong><br>
* Created: <strong>22.08.2020</strong><br>
*
* @author Leon Hofmeister
* @since Envoy Common v0.2-beta
*/
public class GroupCreationResult extends Event<Boolean> {
private static final long serialVersionUID = 1L;
/**
* Creates a new {@code GroupCreationResult}.
*
* @param success whether the GroupCreation sent before was successful
* @since Envoy Common v0.2-beta
*/
public GroupCreationResult(boolean success) { super(success); }
}

2
common/src/main/java/envoy/event/GroupMessageStatusChange.java
View File

@ -13,7 +13,7 @@ import envoy.data.Message.MessageStatus;
* @author Maximilian K&auml;fer
* @since Envoy Common v0.1-beta
*/
public class GroupMessageStatusChange extends MessageStatusChange {
public final class GroupMessageStatusChange extends MessageStatusChange {
private final long memberID;

2
common/src/main/java/envoy/event/GroupResize.java
View File

@ -17,7 +17,7 @@ import envoy.data.User;
* @author Leon Hofmeister
* @since Envoy Common v0.1-beta
*/
public class GroupResize extends Event<User> {
public final class GroupResize extends Event<User> {
private final long groupID;
private final ElementOperation operation;

2
common/src/main/java/envoy/event/HandshakeRejection.java
View File

@ -11,7 +11,7 @@ package envoy.event;
* @author Kai S. K. Engelbart
* @since Envoy Common v0.3-alpha
*/
public class HandshakeRejection extends Event<String> {
public final class HandshakeRejection extends Event<String> {
/**
* Select this value if a given password hash or user name was incorrect.

2
common/src/main/java/envoy/event/IDGeneratorRequest.java
View File

@ -11,7 +11,7 @@ package envoy.event;
* @author Kai S. K. Engelbart
* @since Envoy Common v0.3-alpha
*/
public class IDGeneratorRequest extends Event.Valueless {
public final class IDGeneratorRequest extends Event.Valueless {
private static final long serialVersionUID = 1431107413883364583L;
}

2
common/src/main/java/envoy/event/IsTyping.java
View File

@ -11,7 +11,7 @@ package envoy.event;
* @author Leon Hofmeister
* @since Envoy Client v0.2-beta
*/
public class IsTyping extends Event<Long> {
public final class IsTyping extends Event<Long> {
private final long destinationID;

28
common/src/main/java/envoy/event/IssueProposal.java
View File

@ -6,31 +6,28 @@ package envoy.event;
* <p>
* Project: <strong>common</strong><br>
* File: <strong>IssueProposal.java</strong><br>
* Created: <strong>Aug 5, 2020</strong><br>
* Created: <strong>05.08.2020</strong><br>
*
* @author Leon Hofmeister
* @since Envoy Common v0.2-beta
*/
public class IssueProposal extends Event<String> {
public final class IssueProposal extends Event<String> {
private final String submitterName;
private final String description;
private final boolean bug;
private static final long serialVersionUID = 1L;
/**
* @param title the title of the reported bug
* @param description the description of this bug
* @param submitterName the user who submitted the bug
* @param isBug determines whether this {@code IssueProposal} is
* supposed to be a
* feature or a bug (true = bug, false = feature)
* @param title the title of the reported bug
* @param description the description of this bug
* @param isBug determines whether this {@code IssueProposal} is
* supposed to be a
* feature or a bug (true = bug, false = feature)
* @since Envoy Common v0.2-beta
*/
public IssueProposal(String title, String description, String submitterName, boolean isBug) {
public IssueProposal(String title, String description, boolean isBug) {
super(title);
this.submitterName = submitterName;
this.description = description;
bug = isBug;
}
@ -42,16 +39,9 @@ public class IssueProposal extends Event<String> {
public String getDescription() { return description; }
/**
* @return the name of the user who sent this bug report
* @since Envoy Common v0.2-beta
*/
public String getSubmitterName() { return submitterName; }
/**
* @return whether this issue is supposed to be a bug - if false it is intended
* @return whether this issue is supposed to be a bug - otherwise it is intended
* as a feature
* @since Envoy Common v0.2-beta
*/
public boolean isBug() { return bug; }
}

2
common/src/main/java/envoy/event/NameChange.java
View File

@ -14,7 +14,7 @@ import envoy.data.Contact;
* @author Leon Hofmeister
* @since Envoy Common v0.1-beta
*/
public class NameChange extends Event<String> {
public final class NameChange extends Event<String> {
private final long id;

17
common/src/main/java/envoy/event/NoAttachments.java Normal file
View File

@ -0,0 +1,17 @@
package envoy.event;
/**
* This event is used so that the server can tell the client that attachments
* will be filtered out.
* <p>
* Project: <strong>common</strong><br>
* File: <strong>NoAttachments.java</strong><br>
* Created: <strong>22.08.2020</strong><br>
*
* @author Leon Hofmeister
* @since Envoy Common v0.2-beta
*/
public class NoAttachments extends Event.Valueless {
private static final long serialVersionUID = 1L;
}

2
common/src/main/java/envoy/event/PasswordChangeRequest.java
View File

@ -10,7 +10,7 @@ import envoy.data.Contact;
* @author Leon Hofmeister
* @since Envoy Common v0.2-beta
*/
public class PasswordChangeRequest extends Event<String> {
public final class PasswordChangeRequest extends Event<String> {
private final long id;
private final String oldPassword;

2
common/src/main/java/envoy/event/PasswordChangeResult.java
View File

@ -11,7 +11,7 @@ package envoy.event;
* @author Leon Hofmeister
* @since Envoy Common v0.2-beta
*/
public class PasswordChangeResult extends Event<Boolean> {
public final class PasswordChangeResult extends Event<Boolean> {
private static final long serialVersionUID = 1L;

2
common/src/main/java/envoy/event/ProfilePicChange.java
View File

@ -8,7 +8,7 @@ package envoy.event;
* @author Leon Hofmeister
* @since Envoy Common v0.2-beta
*/
public class ProfilePicChange extends Event<byte[]> {
public final class ProfilePicChange extends Event<byte[]> {
private final long id;

2
common/src/main/java/envoy/event/UserStatusChange.java
View File

@ -11,7 +11,7 @@ import envoy.data.User.UserStatus;
* @author Leon Hofmeister
* @since Envoy Common v0.2-alpha
*/
public class UserStatusChange extends Event<UserStatus> {
public final class UserStatusChange extends Event<UserStatus> {
private final long id;

2
common/src/main/java/envoy/event/contact/ContactOperation.java
View File

@ -14,7 +14,7 @@ import envoy.event.Event;
* @author Maximilian K&auml;fer
* @since Envoy Common v0.2-alpha
*/
public class ContactOperation extends Event<Contact> {
public final class ContactOperation extends Event<Contact> {
private final ElementOperation operationType;

2
common/src/main/java/envoy/event/contact/UserSearchRequest.java
View File

@ -12,7 +12,7 @@ import envoy.event.Event;
* @author Maximilian K&auml;fer
* @since Envoy Common v0.2-alpha
*/
public class UserSearchRequest extends Event<String> {
public final class UserSearchRequest extends Event<String> {
private static final long serialVersionUID = 0L;

2
common/src/main/java/envoy/event/contact/UserSearchResult.java
View File

@ -15,7 +15,7 @@ import envoy.event.Event;
* @author Kai S. K. Engelbart
* @since Envoy Common v0.2-alpha
*/
public class UserSearchResult extends Event<List<User>> {
public final class UserSearchResult extends Event<List<User>> {
private static final long serialVersionUID = 0L;

2
common/src/main/java/envoy/exception/EnvoyException.java
View File

@ -8,7 +8,7 @@ package envoy.exception;
* @author Kai S. K. Engelbart
* @since Envoy v0.1-alpha
*/
public class EnvoyException extends Exception {
public final class EnvoyException extends Exception {
private static final long serialVersionUID = 2096147309395387479L;

2
common/src/main/java/envoy/util/Bounds.java
View File

@ -12,7 +12,7 @@ import java.util.regex.Pattern;
* @author Kai S. K. Engelbart
* @since Envoy Common v0.1-beta
*/
public class Bounds {
public final class Bounds {
private Bounds() {}

42
common/src/main/java/envoy/util/EnvoyLog.java
View File

@ -12,18 +12,15 @@ import envoy.data.Config;
* Configures the {@link java.util.logging} API to output the log into the
* console and a log file.
* <p>
* Call the {@link EnvoyLog#attach(String)} method to configure a part of the
* logger hierarchy.
* <p>
* Project: <strong>envoy-client</strong><br>
* File: <strong>EnvoyLogger.java</strong><br>
* Created: <strong>14 Dec 2019</strong><br>
* Created: <strong>14.12.2019</strong><br>
*
* @author Leon Hofmeister
* @author Kai S. K. Engelbart
* @since Envoy Common v0.1-beta
*/
public class EnvoyLog {
public final class EnvoyLog {
private static FileHandler fileHandler;
private static StreamHandler consoleHandler;
@ -32,8 +29,7 @@ public class EnvoyLog {
private EnvoyLog() {}
/**
* Initializes logging. Call this method before calling the
* {@link EnvoyLog#attach(String)} method.
* Initializes logging.
*
* @param config the config providing the console and log file barriers
* @since Envoy Common v0.1-beta
@ -45,18 +41,19 @@ public class EnvoyLog {
LogManager.getLogManager().reset();
// Configure log file
final File logFile = new File((File) config.get("homeDirectory").get(),
"log/envoy_user_" + DateTimeFormatter.ofPattern("yyyy-MM-dd--hh-mm-mm").format(LocalDateTime.now()) + ".log");
final File logFile = new File(config.getHomeDirectory(),
"log/" + DateTimeFormatter.ofPattern("yyyy-MM-dd--hh-mm").format(LocalDateTime.now()) + ".log");
logFile.getParentFile().mkdirs();
// Configure formatting
// Sample log entry: [2020-06-13 16:50:26] [INFORMATION] [envoy.client.ui.Startup] Closing connection...
// Sample log entry: [2020-06-13 16:50:26] [INFORMATION]
// [envoy.client.ui.Startup] Closing connection...
System.setProperty("java.util.logging.SimpleFormatter.format", "[%1$tF %1$tT] [%4$-7s] [%3$s] %5$s %6$s%n");
final SimpleFormatter formatter = new SimpleFormatter();
try {
fileHandler = new FileHandler(logFile.getAbsolutePath());
fileHandler.setLevel((Level) config.get("fileLevelBarrier").get());
fileHandler.setLevel(config.getFileLevelBarrier());
fileHandler.setFormatter(formatter);
} catch (SecurityException | IOException e) {
e.printStackTrace();
@ -69,10 +66,11 @@ public class EnvoyLog {
flush();
}
};
consoleHandler.setLevel((Level) config.get("consoleLevelBarrier").get());
consoleHandler.setLevel(config.getConsoleLevelBarrier());
consoleHandler.setFormatter(formatter);
initialized = true;
EnvoyLog.attach("envoy");
}
/**
@ -82,7 +80,7 @@ public class EnvoyLog {
* @param path the path to the loggers to configure
* @since Envoy Common v0.1-beta
*/
public static void attach(String path) {
private static void attach(String path) {
if (!initialized) throw new IllegalStateException("EnvoyLog is not initialized");
// Get root logger
@ -105,22 +103,4 @@ public class EnvoyLog {
* @since Envoy Common v0.1-beta
*/
public static Logger getLogger(Class<?> logClass) { return Logger.getLogger(logClass.getCanonicalName()); }
/**
* Defines the logger level required for a record to be written to the log file.
*
* @param fileLevelBarrier the log file level
* @since Envoy Common v0.1-beta
*/
public static void setFileLevelBarrier(Level fileLevelBarrier) { if (fileHandler != null) fileHandler.setLevel(fileLevelBarrier); }
/**
* Defines the logger level required for a record to be written to the console.
*
* @param consoleLevelBarrier the console logger level
* @since Envoy Common v0.1-beta
*/
public static void setConsoleLevelBarrier(Level consoleLevelBarrier) {
if (consoleHandler != null) consoleHandler.setLevel(consoleLevelBarrier);
}
}

2
common/src/main/java/envoy/util/SerializationUtils.java
View File

@ -12,7 +12,7 @@ import java.io.*;
* @author Kai S. K. Engelbart
* @since Envoy Common v0.2-alpha
*/
public class SerializationUtils {
public final class SerializationUtils {
private SerializationUtils() {}

2
server/.settings/org.eclipse.jdt.ui.prefs
View File

File diff suppressed because one or more lines are too long

37
server/src/main/java/envoy/server/Startup.java
View File

@ -1,16 +1,13 @@
package envoy.server;
import java.io.File;
import java.io.IOException;
import java.util.HashMap;
import java.util.Set;
import java.util.logging.Level;
import com.jenkov.nioserver.Server;
import envoy.data.Config;
import envoy.data.ConfigItem;
import envoy.server.data.PersistenceManager;
import envoy.server.data.ServerConfig;
import envoy.server.net.ConnectionManager;
import envoy.server.net.ObjectMessageProcessor;
import envoy.server.net.ObjectMessageReader;
@ -27,26 +24,12 @@ import envoy.util.EnvoyLog;
* @author Kai S. K. Engelbart
* @since Envoy Server Standalone v0.1-alpha
*/
public class Startup {
public final class Startup {
/**
* Initializes the logger with a new config instance.
*
* @since Envoy Server Standalone v0.1-beta
* Stores the configuration used for the whole server
*/
private static void initLogging() {
final var items = new HashMap<String, ConfigItem<?>>();
items.put("homeDirectory",
new ConfigItem<>("homeDirectory", "h", File::new, new File(System.getProperty("user.home"), ".envoy-server"), true));
items.put("fileLevelBarrier", new ConfigItem<>("fileLevelBarrier", "fb", Level::parse, Level.WARNING, true));
items.put("consoleLevelBarrier", new ConfigItem<>("consoleLevelBarrier", "cb", Level::parse, Level.FINEST, true));
final var config = new Config();
config.load(items);
EnvoyLog.initialize(config);
EnvoyLog.attach("envoy");
}
public static final ServerConfig config = ServerConfig.getInstance();
/**
* Starts the server.
@ -57,7 +40,13 @@ public class Startup {
* @since Envoy Server Standalone v0.1-alpha
*/
public static void main(String[] args) throws IOException {
initLogging();
try {
config.loadAll(Startup.class, "server.properties", args);
EnvoyLog.initialize(config);
} catch (final IllegalStateException e) {
EnvoyLog.getLogger(Startup.class).log(Level.SEVERE, "Error loading configuration values: ", e);
System.exit(1);
}
final var server = new Server(8080, ObjectMessageReader::new,
new ObjectMessageProcessor(Set.of(new LoginCredentialProcessor(),
@ -84,8 +73,8 @@ public class Startup {
server.start();
server.getSocketProcessor().registerSocketIdListener(ConnectionManager.getInstance());
if (args.length == 0 || !args[0].equalsIgnoreCase("no-enter-to-stop")) {
System.out.println("Press the return key to stop the server...");
if (config.isEnterToStop()) {
System.out.println("Press Enter to stop the server...");
System.in.read();
System.out.println("Stopped");
System.exit(0);

2
server/src/main/java/envoy/server/data/ConfigItem.java
View File

@ -14,7 +14,7 @@ import javax.persistence.Table;
*/
@Entity
@Table(name = "configuration")
public class ConfigItem {
public final class ConfigItem {
@Id
private String key;

2
server/src/main/java/envoy/server/data/Group.java
View File

@ -28,7 +28,7 @@ import javax.persistence.NamedQuery;
query = "SELECT g FROM Group g WHERE g.creationDate > :lastSeen AND :user MEMBER OF g.contacts"
)
})
public class Group extends Contact {
public final class Group extends Contact {
/**
* Named query retrieving a group by name (parameter {@code :name}).

2
server/src/main/java/envoy/server/data/GroupMessage.java
View File

@ -24,7 +24,7 @@ import envoy.data.Group;
+ "OR m.status = envoy.data.Message$MessageStatus.READ AND m.readDate > :lastSeen "
+ "OR m.lastStatusChangeDate > :lastSeen)"
)
public class GroupMessage extends Message {
public final class GroupMessage extends Message {
/**
* Named query retrieving pending group messages sent to a group containing a

3
server/src/main/java/envoy/server/data/Message.java
View File

@ -1,6 +1,7 @@
package envoy.server.data;
import static envoy.data.Message.MessageStatus.*;
import static envoy.server.Startup.config;
import java.time.Instant;
@ -104,7 +105,7 @@ public class Message {
sender = persistenceManager.getUserByID(message.getSenderID());
recipient = persistenceManager.getContactByID(message.getRecipientID());
forwarded = message.isForwarded();
if (message.hasAttachment()) {
if (config.isAttachmentSupportEnabled() && message.hasAttachment()) {
final var messageAttachment = message.getAttachment();
attachment = messageAttachment.getData();
attachmentName = messageAttachment.getName();

2
server/src/main/java/envoy/server/data/PersistenceManager.java
View File

@ -19,7 +19,7 @@ import envoy.server.net.ConnectionManager;
* @author Maximilian K&auml;fer
* @since Envoy Server Standalone v0.1-alpha
*/
public class PersistenceManager {
public final class PersistenceManager {
private final EntityManager entityManager = Persistence.createEntityManagerFactory("envoy").createEntityManager();
private final EntityTransaction transaction = entityManager.getTransaction();

96
server/src/main/java/envoy/server/data/ServerConfig.java Normal file
View File

@ -0,0 +1,96 @@
package envoy.server.data;
import static java.util.function.Function.identity;
import envoy.data.Config;
/**
* Project: <strong>server</strong><br>
* File: <strong>ServerConfig.java</strong><br>
* Created: <strong>21.08.2020</strong><br>
*
* @author Leon Hofmeister
* @since Envoy Server v0.2-beta
*/
public final class ServerConfig extends Config {
private static ServerConfig config;
/**
* @return the singleton instance of the server config
* @since Envoy Client v0.1-beta
*/
public static ServerConfig getInstance() { return config == null ? config = new ServerConfig() : config; }
private ServerConfig() {
super(".envoy-server");
put("enter-to-stop", "dev-stop", Boolean::parseBoolean);
// parameters for issue reporting
put("issueCreationURL", "i-url", identity());
put("issueAuthToken", "i-token", identity());
put("userMadeLabel", "l-um", identity());
put("bugLabel", "l-b", identity());
put("featureLabel", "l-f", identity());
// enabling/ disabling several processors
put("enableIssueReporting", "e-ir", Boolean::parseBoolean);
put("enableGroups", "e-g", Boolean::parseBoolean);
put("enableAttachments", "e-a", Boolean::parseBoolean);
}
/**
* @return true if this server should be stoppable by pressing enter
* @since Envoy Server v0.2-beta
*/
public Boolean isEnterToStop() { return (Boolean) items.get("enter-to-stop").get(); }
/**
* @return {@code true} if issue reporting is enabled
* @since Envoy Client v0.3-alpha
*/
public Boolean isIssueReportingEnabled() { return (Boolean) items.get("enableIssueReporting").get(); }
/**
* @return {@code true} if attachment support has been enabled
* @since Envoy Client v0.3-alpha
*/
public Boolean isAttachmentSupportEnabled() { return (Boolean) items.get("enableAttachments").get(); }
/**
* @return {@code true} if group support has been enabled
* @since Envoy Client v0.3-alpha
*/
public Boolean isGroupSupportEnabled() { return (Boolean) items.get("enableGroups").get(); }
/**
* @return the URL where issues should be uploaded to
* @since Envoy Client v0.1-alpha
*/
public String getIssueReportingURL() { return (String) items.get("issueCreationURL").get(); }
/**
* @return the String representation for the "{@code user made}" - label
* @since Envoy Client v0.1-alpha
*/
public String getUserMadeLabel() { return (String) items.get("userMadeLabel").get(); }
/**
* @return the String representation for the "{@code user made}" - label
* @since Envoy Client v0.1-alpha
*/
public String getBugLabel() { return (String) items.get("bugLabel").get(); }
/**
* @return the String representation for the "{@code user made}" - label
* @since Envoy Client v0.1-alpha
*/
public String getFeatureLabel() { return (String) items.get("featureLabel").get(); }
/**
* @return the authorization token used to authenticate to
* {@link ServerConfig#getIssueReportingURL()}. If null,
* authorization is expected to occur via a query_param or via a basic
* user-password-combination
* @since Envoy Server v0.2-beta
*/
public String getIssueAuthToken() { return (String) items.get("issueAuthToken").get(); }
}

2
server/src/main/java/envoy/server/data/User.java
View File

@ -36,7 +36,7 @@ import envoy.data.User.UserStatus;
query = "SELECT u FROM User u WHERE (lower(u.name) LIKE lower(:searchPhrase) AND u <> :context AND :context NOT MEMBER OF u.contacts)"
)
})
public class User extends Contact {
public final class User extends Contact {
/**
* Named query retrieving a user by name (parameter {@code :name}).

2
server/src/main/java/envoy/server/net/ConnectionManager.java
View File

@ -19,7 +19,7 @@ import envoy.server.processors.UserStatusChangeProcessor;
* @author Kai S. K. Engelbart
* @since Envoy Server Standalone v0.1-alpha
*/
public class ConnectionManager implements ISocketIdListener {
public final class ConnectionManager implements ISocketIdListener {
/**
* Contains all socket IDs that have not yet performed a handshake / acquired

2
server/src/main/java/envoy/server/net/ObjectMessageProcessor.java
View File

@ -25,7 +25,7 @@ import envoy.util.EnvoyLog;
* @author Kai S. K. Engelbart
* @since Envoy Server Standalone v0.1-alpha
*/
public class ObjectMessageProcessor implements IMessageProcessor {
public final class ObjectMessageProcessor implements IMessageProcessor {
private final Set<ObjectProcessor<?>> processors;

2
server/src/main/java/envoy/server/net/ObjectMessageReader.java
View File

@ -19,7 +19,7 @@ import envoy.util.SerializationUtils;
* @author Kai S. K. Engelbart
* @since Envoy Server Standalone v0.1-alpha
*/
public class ObjectMessageReader implements IMessageReader {
public final class ObjectMessageReader implements IMessageReader {
private List<Message> completeMessages = new ArrayList<>();
private Message nextMessage;

2
server/src/main/java/envoy/server/net/ObjectWriteProxy.java
View File

@ -22,7 +22,7 @@ import envoy.util.SerializationUtils;
* @author Kai S. K. Engelbart
* @since Envoy Server Standalone v0.1-alpha
*/
public class ObjectWriteProxy {
public final class ObjectWriteProxy {
private final WriteProxy writeProxy;

2
server/src/main/java/envoy/server/processors/ContactOperationProcessor.java
View File

@ -17,7 +17,7 @@ import envoy.util.EnvoyLog;
* @author Kai S. K. Engelbart
* @since Envoy Server Standalone v0.1-alpha
*/
public class ContactOperationProcessor implements ObjectProcessor<ContactOperation> {
public final class ContactOperationProcessor implements ObjectProcessor<ContactOperation> {
private static final ConnectionManager connectionManager = ConnectionManager.getInstance();
private static final Logger logger = EnvoyLog.getLogger(ContactOperationProcessor.class);

12
server/src/main/java/envoy/server/processors/GroupCreationProcessor.java
View File

@ -1,9 +1,12 @@
package envoy.server.processors;
import static envoy.server.Startup.config;
import java.util.HashSet;
import envoy.event.ElementOperation;
import envoy.event.GroupCreation;
import envoy.event.GroupCreationResult;
import envoy.event.contact.ContactOperation;
import envoy.server.data.Contact;
import envoy.server.data.PersistenceManager;
@ -14,18 +17,21 @@ import envoy.server.net.ObjectWriteProxy;
* Project: <strong>envoy-server-standalone</strong><br>
* File: <strong>GroupCreationProcessor.java</strong><br>
* Created: <strong>26.03.2020</strong><br>
*
*
* @author Maximilian K&auml;fer
* @since Envoy Server Standalone v0.1-beta
*/
public class GroupCreationProcessor implements ObjectProcessor<GroupCreation> {
public final class GroupCreationProcessor implements ObjectProcessor<GroupCreation> {
private final PersistenceManager persistenceManager = PersistenceManager.getInstance();
private final ConnectionManager connectionManager = ConnectionManager.getInstance();
@Override
public void process(GroupCreation groupCreation, long socketID, ObjectWriteProxy writeProxy) {
envoy.server.data.Group group = new envoy.server.data.Group();
// Don't allow the creation of groups if manually disabled
writeProxy.write(socketID, new GroupCreationResult(config.isGroupSupportEnabled()));
if (!config.isGroupSupportEnabled()) return;
final envoy.server.data.Group group = new envoy.server.data.Group();
group.setName(groupCreation.get());
group.setContacts(new HashSet<>());
groupCreation.getInitialMemberIDs().stream().map(persistenceManager::getUserByID).forEach(group.getContacts()::add);

142
server/src/main/java/envoy/server/processors/GroupMessageProcessor.java
View File

@ -1,64 +1,78 @@
package envoy.server.processors;
import static envoy.data.Message.MessageStatus.*;
import java.time.Instant;
import java.util.Collections;
import java.util.logging.Logger;
import javax.persistence.EntityExistsException;
import envoy.data.GroupMessage;
import envoy.event.MessageStatusChange;
import envoy.server.data.PersistenceManager;
import envoy.server.net.ConnectionManager;
import envoy.server.net.ObjectWriteProxy;
import envoy.util.EnvoyLog;
/**
* Project: <strong>envoy-server-standalone</strong><br>
* File: <strong>GroupMessageProcessor.java</strong><br>
* Created: <strong>18.04.2020</strong><br>
*
* @author Maximilian K&auml;fer
* @since Envoy Server Standalone v0.1-beta
*/
public class GroupMessageProcessor implements ObjectProcessor<GroupMessage> {
private static final ConnectionManager connectionManager = ConnectionManager.getInstance();
private static final PersistenceManager persistenceManager = PersistenceManager.getInstance();
private static final Logger logger = EnvoyLog.getLogger(GroupCreationProcessor.class);
@Override
public void process(GroupMessage groupMessage, long socketID, ObjectWriteProxy writeProxy) {
groupMessage.nextStatus();
// Update statuses to SENT / RECEIVED depending on online status
groupMessage.getMemberStatuses().replaceAll((memberID, status) -> connectionManager.isOnline(memberID) ? RECEIVED : SENT);
// Set status for sender to READ
groupMessage.getMemberStatuses().replace(groupMessage.getSenderID(), READ);
// Increment the overall status to RECEIVED if necessary
if (Collections.min(groupMessage.getMemberStatuses().values()) == RECEIVED) {
groupMessage.nextStatus();
// Notify the sender of the status change
writeProxy.write(socketID, new MessageStatusChange(groupMessage));
}
// Deliver the message to the recipients that are online
writeProxy.writeToOnlineContacts(
persistenceManager.getGroupByID(groupMessage.getRecipientID())
.getContacts()
.stream()
.filter(c -> c.getID() != groupMessage.getSenderID()),
groupMessage);
try {
PersistenceManager.getInstance().addMessage(new envoy.server.data.GroupMessage(groupMessage, Instant.now()));
} catch (EntityExistsException e) {
logger.warning("Received a groupMessage with an ID that already exists");
}
}
}
package envoy.server.processors;
import static envoy.data.Message.MessageStatus.*;
import static envoy.server.Startup.config;
import java.time.Instant;
import java.util.Collections;
import java.util.logging.Logger;
import javax.persistence.EntityExistsException;
import envoy.data.GroupMessage;
import envoy.event.MessageStatusChange;
import envoy.event.NoAttachments;
import envoy.server.data.PersistenceManager;
import envoy.server.net.ConnectionManager;
import envoy.server.net.ObjectWriteProxy;
import envoy.util.EnvoyLog;
/**
* Project: <strong>envoy-server-standalone</strong><br>
* File: <strong>GroupMessageProcessor.java</strong><br>
* Created: <strong>18.04.2020</strong><br>
*
* @author Maximilian K&auml;fer
* @since Envoy Server Standalone v0.1-beta
*/
public final class GroupMessageProcessor implements ObjectProcessor<GroupMessage> {
private static final ConnectionManager connectionManager = ConnectionManager.getInstance();
private static final PersistenceManager persistenceManager = PersistenceManager.getInstance();
private static final Logger logger = EnvoyLog.getLogger(GroupCreationProcessor.class);
@Override
public void process(GroupMessage groupMessage, long socketID, ObjectWriteProxy writeProxy) {
groupMessage.nextStatus();
// Update statuses to SENT / RECEIVED depending on online status
groupMessage.getMemberStatuses().replaceAll((memberID, status) -> connectionManager.isOnline(memberID) ? RECEIVED : SENT);
// Set status for sender to READ
groupMessage.getMemberStatuses().replace(groupMessage.getSenderID(), READ);
// Increment the overall status to RECEIVED if necessary
if (Collections.min(groupMessage.getMemberStatuses().values()) == RECEIVED) {
groupMessage.nextStatus();
// Notify the sender of the status change
writeProxy.write(socketID, new MessageStatusChange(groupMessage));
}
// message attachment will be automatically removed if disabled in config
final var groupMessageServer = new envoy.server.data.GroupMessage(groupMessage, Instant.now());
// Telling the server to reload the message without the attachment and telling
// the client not to send anymore attachments
if (!config.isAttachmentSupportEnabled() && groupMessage.hasAttachment()) {
groupMessage = groupMessageServer.toCommon();
writeProxy.write(socketID, new NoAttachments());
}
// This is needed unfortunately because of f***ing lambda restrictions ("must be
// fINaL oR EFfEcTivELy FiNAl")
final var groupMessageCopy = groupMessage;
// Deliver the message to the recipients that are online
writeProxy.writeToOnlineContacts(
persistenceManager.getGroupByID(groupMessageCopy.getRecipientID())
.getContacts()
.stream()
.filter(c -> c.getID() != groupMessageCopy.getSenderID()),
groupMessageCopy);
try {
PersistenceManager.getInstance().addMessage(groupMessageServer);
} catch (final EntityExistsException e) {
logger.warning("Received a groupMessage with an ID that already exists");
}
}
}

2
server/src/main/java/envoy/server/processors/GroupMessageStatusChangeProcessor.java
View File

@ -24,7 +24,7 @@ import envoy.util.EnvoyLog;
* @author Maximilian K&auml;fer
* @since Envoy Server Standalone v0.1-beta
*/
public class GroupMessageStatusChangeProcessor implements ObjectProcessor<GroupMessageStatusChange> {
public final class GroupMessageStatusChangeProcessor implements ObjectProcessor<GroupMessageStatusChange> {
private static final ConnectionManager connectionManager = ConnectionManager.getInstance();
private static final PersistenceManager persistenceManager = PersistenceManager.getInstance();

2
server/src/main/java/envoy/server/processors/GroupResizeProcessor.java
View File

@ -14,7 +14,7 @@ import envoy.server.net.ObjectWriteProxy;
* @author Maximilian K&auml;fer
* @since Envoy Server Standalone v0.1-beta
*/
public class GroupResizeProcessor implements ObjectProcessor<GroupResize> {
public final class GroupResizeProcessor implements ObjectProcessor<GroupResize> {
private static final PersistenceManager persistenceManager = PersistenceManager.getInstance();
private static final ConnectionManager connectionManager = ConnectionManager.getInstance();

2
server/src/main/java/envoy/server/processors/IDGeneratorRequestProcessor.java
View File

@ -17,7 +17,7 @@ import envoy.server.net.ObjectWriteProxy;
* @author Maximilian K&auml;fer
* @since Envoy Server Standalone v0.1-alpha
*/
public class IDGeneratorRequestProcessor implements ObjectProcessor<IDGeneratorRequest> {
public final class IDGeneratorRequestProcessor implements ObjectProcessor<IDGeneratorRequest> {
private static final long ID_RANGE = 200;

2
server/src/main/java/envoy/server/processors/IsTypingProcessor.java
View File

@ -18,7 +18,7 @@ import envoy.server.net.ObjectWriteProxy;
* @author Leon Hofmeister
* @since Envoy Server v0.2-beta
*/
public class IsTypingProcessor implements ObjectProcessor<IsTyping> {
public final class IsTypingProcessor implements ObjectProcessor<IsTyping> {
private static final ConnectionManager connectionManager = ConnectionManager.getInstance();
private static final PersistenceManager persistenceManager = PersistenceManager.getInstance();

60
server/src/main/java/envoy/server/processors/IssueProposalProcessor.java
View File

@ -1,5 +1,7 @@
package envoy.server.processors;
import static envoy.server.Startup.config;
import java.io.IOException;
import java.net.HttpURLConnection;
import java.net.URL;
@ -16,44 +18,39 @@ import envoy.util.EnvoyLog;
* <p>
* Project: <strong>server</strong><br>
* File: <strong>IssueProposalProcessor.java</strong><br>
* Created: <strong>Aug 5, 2020</strong><br>
* Created: <strong>05.08.2020</strong><br>
*
* @author Leon Hofmeister
* @since Envoy Server v0.2-beta
*/
public class IssueProposalProcessor implements ObjectProcessor<IssueProposal> {
public final class IssueProposalProcessor implements ObjectProcessor<IssueProposal> {
private static boolean issueReportingEnabled = true;
private static final Logger logger = EnvoyLog.getLogger(IssueProposalProcessor.class);
private static final Logger logger = EnvoyLog.getLogger(IssueProposalProcessor.class);
@Override
public void process(IssueProposal issueProposal, long socketID, ObjectWriteProxy writeProxy) throws IOException {
// Do nothing if manually disabled
if (!issueReportingEnabled) return;
var issueDescription = issueProposal.getDescription();
// Appending the submitter name, if this option was enabled
issueDescription += issueProposal.getSubmitterName() != null
? (issueDescription.endsWith("\n") || issueDescription.endsWith("<br>") ? "" : "<br>")
+ String.format("Submitted by user %s.", issueProposal.getSubmitterName())
: "";
// Markdown does not support "\n". It uses "<br>"
issueDescription = issueDescription.replaceAll("\n", "<br>");
// We do not want any Windows artifacts to remain as that may cause problems
issueDescription = issueDescription.replaceAll("\r", "");
if (!config.isIssueReportingEnabled()) return;
try {
final var url = new URL(
"https://git.kske.dev/api/v1/repos/zdm/envoy/issues?access_token=6d8ec2a72d64cbaf6319434aa2e7caf0130701b3");
final var url = new URL(config.getIssueReportingURL());
final var connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("POST");
connection.setRequestProperty("Content-Type", "application/json; utf-8");
connection.setRequestProperty("Accept", "application/json");
// Two types of authorization are currently supported: access token as
// query param or access token as authorization header
final var authenticationToken = config.getIssueAuthToken();
if (!authenticationToken.equals("")) {
final String auth = "token " + authenticationToken;
connection.setRequestProperty("Authorization", auth);
}
connection.setDoOutput(true);
final var json = String.format("{\"title\":\"%s\",\"body\":\"%s\",\"labels\":[240, %d]}",
final var json = String.format("{\"title\":\"%s\",\"body\":\"%s\",\"labels\":[%s, %s]}",
issueProposal.get(),
issueDescription,
// Label 240 should be user-made, label 117 bug and label 119 feature
issueProposal.isBug() ? 117 : 119);
issueProposal.getDescription(),
config.getUserMadeLabel(),
issueProposal.isBug() ? config.getBugLabel() : config.getFeatureLabel());
try (final var os = connection.getOutputStream()) {
final byte[] input = json.getBytes("utf-8");
os.write(input, 0, input.length);
@ -61,28 +58,9 @@ public class IssueProposalProcessor implements ObjectProcessor<IssueProposal> {
final var status = connection.getResponseCode();
if (status == 201) logger.log(Level.INFO, "Successfully created an issue");
else logger.log(Level.WARNING,
String.format("Tried creating an issue but received status code %d - Request params:title=%s,description=%s,json=%s",
status,
issueProposal.get(),
issueDescription,
json));
String.format("Tried creating an issue for %s but received status code %d - Request params:%s", url, status, json));
} catch (final IOException e) {
logger.log(Level.WARNING, "An error occurred while creating an issue: ", e);
}
}
/**
* @return whether issue reporting is enabled
* @since Envoy Server v0.2-beta
*/
public static boolean isIssueReportingEnabled() { return issueReportingEnabled; }
/**
* @param issueReportingEnabled whether issue reporting should be enabled - true
* by default
* @since Envoy Server v0.2-beta
*/
public static void setIssueReportingEnabled(boolean issueReportingEnabled) {
IssueProposalProcessor.issueReportingEnabled = issueReportingEnabled;
}
}

12
server/src/main/java/envoy/server/processors/MessageProcessor.java
View File

@ -1,5 +1,7 @@
package envoy.server.processors;
import static envoy.server.Startup.config;
import java.util.logging.Level;
import java.util.logging.Logger;
@ -7,6 +9,7 @@ import javax.persistence.EntityExistsException;
import envoy.data.Message;
import envoy.event.MessageStatusChange;
import envoy.event.NoAttachments;
import envoy.server.data.PersistenceManager;
import envoy.server.net.ConnectionManager;
import envoy.server.net.ObjectWriteProxy;
@ -23,7 +26,7 @@ import envoy.util.EnvoyLog;
* @author Maximilian K&auml;fer
* @since Envoy Server Standalone v0.1-alpha
*/
public class MessageProcessor implements ObjectProcessor<Message> {
public final class MessageProcessor implements ObjectProcessor<Message> {
private static final PersistenceManager persistenceManager = PersistenceManager.getInstance();
private static final ConnectionManager connectionManager = ConnectionManager.getInstance();
@ -35,6 +38,11 @@ public class MessageProcessor implements ObjectProcessor<Message> {
// Convert to server message
final var serverMessage = new envoy.server.data.Message(message);
// Telling the server to reload the message without the attachment
if (!config.isAttachmentSupportEnabled() && message.hasAttachment()) {
message = serverMessage.toCommon();
writeProxy.write(socketID, new NoAttachments());
}
try {
@ -54,7 +62,7 @@ public class MessageProcessor implements ObjectProcessor<Message> {
// Note that the exact time stamp might differ slightly
writeProxy.write(socketID, new MessageStatusChange(message));
}
} catch (EntityExistsException e) {
} catch (final EntityExistsException e) {
logger.log(Level.WARNING, "Received " + message + " with an ID that already exists!");
}
}

2
server/src/main/java/envoy/server/processors/MessageStatusChangeProcessor.java
View File

@ -19,7 +19,7 @@ import envoy.util.EnvoyLog;
* @author Leon Hofmeister
* @since Envoy Server Standalone v0.1-alpha
*/
public class MessageStatusChangeProcessor implements ObjectProcessor<MessageStatusChange> {
public final class MessageStatusChangeProcessor implements ObjectProcessor<MessageStatusChange> {
private final ConnectionManager connectionManager = ConnectionManager.getInstance();
private final PersistenceManager persistenceManager = PersistenceManager.getInstance();

2
server/src/main/java/envoy/server/processors/NameChangeProcessor.java
View File

@ -15,7 +15,7 @@ import envoy.server.net.ObjectWriteProxy;
* @author Leon Hofmeister
* @since Envoy Server Standalone v0.1-beta
*/
public class NameChangeProcessor implements ObjectProcessor<NameChange> {
public final class NameChangeProcessor implements ObjectProcessor<NameChange> {
private static final PersistenceManager persistenceManager = PersistenceManager.getInstance();

2
server/src/main/java/envoy/server/processors/PasswordChangeRequestProcessor.java
View File

@ -18,7 +18,7 @@ import envoy.util.EnvoyLog;
* @author Leon Hofmeister
* @since Envoy Server v0.2-beta
*/
public class PasswordChangeRequestProcessor implements ObjectProcessor<PasswordChangeRequest> {
public final class PasswordChangeRequestProcessor implements ObjectProcessor<PasswordChangeRequest> {
@Override
public void process(PasswordChangeRequest event, long socketID, ObjectWriteProxy writeProxy) throws IOException {

2
server/src/main/java/envoy/server/processors/ProfilePicChangeProcessor.java
View File

@ -13,7 +13,7 @@ import envoy.server.net.ObjectWriteProxy;
* @author Leon Hofmeister
* @since Envoy Server v0.2-beta
*/
public class ProfilePicChangeProcessor implements ObjectProcessor<ProfilePicChange> {
public final class ProfilePicChangeProcessor implements ObjectProcessor<ProfilePicChange> {
@Override
public void process(ProfilePicChange event, long socketID, ObjectWriteProxy writeProxy) throws IOException {}

2
server/src/main/java/envoy/server/processors/UserSearchProcessor.java
View File

@ -20,7 +20,7 @@ import envoy.server.net.ObjectWriteProxy;
* @author Maximilian K&auml;fer
* @since Envoy Server Standalone v0.1-alpha
*/
public class UserSearchProcessor implements ObjectProcessor<UserSearchRequest> {
public final class UserSearchProcessor implements ObjectProcessor<UserSearchRequest> {
/**
* Writes a list of contacts to the client containing all {@link Contact}s

2
server/src/main/java/envoy/server/processors/UserStatusChangeProcessor.java
View File

@ -19,7 +19,7 @@ import envoy.util.EnvoyLog;
* @author Leon Hofmeister
* @since Envoy Server Standalone v0.1-alpha
*/
public class UserStatusChangeProcessor implements ObjectProcessor<UserStatusChange> {
public final class UserStatusChangeProcessor implements ObjectProcessor<UserStatusChange> {
private static ObjectWriteProxy writeProxy;

2
server/src/main/java/envoy/server/util/PasswordUtil.java
View File

@ -19,7 +19,7 @@ import javax.crypto.spec.PBEKeySpec;
* @author Kai S. K. Engelbart
* @since Envoy Server Standalone v0.1-beta
*/
public class PasswordUtil {
public final class PasswordUtil {
private static final int ITERATIONS = 1000;
private static final int KEY_LENGTH = 64 * 8;

2
server/src/main/java/envoy/server/util/VersionUtil.java
View File

@ -13,7 +13,7 @@ import java.util.regex.Pattern;
* @author Kai S. K. Engelbart
* @since Envoy Server Standalone v0.1-beta
*/
public class VersionUtil {
public final class VersionUtil {
/**
* The minimal client version compatible with this server.

17
server/src/main/resources/server.properties Normal file
View File

@ -0,0 +1,17 @@
enter-to-stop=true
enableAttachments=true
enableGroups=true
enableIssueReporting=true
# git.kske.dev config
issueCreationURL=https://git.kske.dev/api/v1/repos/zdm/envoy/issues?access_token=6d8ec2a72d64cbaf6319434aa2e7caf0130701b3
userMadeLabel=240
bugLabel=117
featureLabel=119
# api.github.com config
#issueCreationURL=https://api.github.com/repos/informatik-ag-ngl/envoy/issues
#userMadeLabel="user made"
#bugLabel="bug"
#featureLabel="feature"
issueAuthToken=
consoleLevelBarrier=FINEST
fileLevelBarrier=WARNING