Merge pull request #9 from informatik-ag-ngl/f/database_integration

Integrated PostgreSQL database with Hibernate

.classpath

@@ -34,5 +34,6 @@
 			<attribute name="maven.pomderived" value="true"/>
 		</attributes>
 	</classpathentry>
+	<classpathentry kind="src" path="/envoy-common"/>
 	<classpathentry kind="output" path="target/classes"/>
 </classpath>

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: CyB3RC0nN0R, delvh, DieGurke, derharry333
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: CyB3RC0nN0R, delvh, DieGurke
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE/bugfix.md

@@ -0,0 +1,10 @@
+---
+name: Bug fix
+title: Fixed Bug
+labels: bug
+assignees: CyB3RC0nN0R, delvh, DieGurke
+reviewers: CyB3RC0nN0R, delvh
+projects: Envoy
+milestone: Envoy v0.3-alpha
+---
+Fixes #{issue}

.github/PULL_REQUEST_TEMPLATE/feature_integration.md

@@ -0,0 +1,9 @@
+---
+name: Feature integration
+title: Added feature
+labels: enhancement
+assignees: CyB3RC0nN0R, delvh, DieGurke
+reviewers: CyB3RC0nN0R, delvh
+projects: Envoy
+milestone: Envoy v0.3-alpha
+---

.github/PULL_REQUEST_TEMPLATE/javadoc_upgrade.md

@@ -0,0 +1,9 @@
+---
+name: Updated Javadoc 
+title: Updated Javadoc
+labels: documentation
+assignees: CyB3RC0nN0R, delvh
+reviewers: CyB3RC0nN0R, delvh
+projects: Envoy
+milestone: Envoy v0.3-alpha
+---

pom.xml

@@ -28,6 +28,11 @@
 			<artifactId>java-nio-server</artifactId>
 			<version>0.0.1-SNAPSHOT</version>
 		</dependency>
+		<dependency>
+			<groupId>org.hibernate</groupId>
+			<artifactId>hibernate-core</artifactId>
+			<version>5.4.10.Final</version>
+		</dependency>
 	</dependencies>
 
 	<build>

src/main/java/envoy/server/data/Message.java

@@ -0,0 +1,194 @@
+package envoy.server.data;
+
+import java.util.Date;
+
+import javax.persistence.Entity;
+import javax.persistence.Id;
+import javax.persistence.NamedQueries;
+import javax.persistence.NamedQuery;
+import javax.persistence.Table;
+import javax.persistence.Temporal;
+import javax.persistence.TemporalType;
+
+import envoy.data.MessageBuilder;
+
+/**
+ * This class serves as a way to let Hibernate communicate with the server
+ * without bringing the dependency of JPA/Hibernate into the client.<br>
+ * It will be referenced as "database message" to clarify between the different
+ * message objects.<br>
+ * <br>
+ * Project: <strong>envoy-server-standalone</strong><br>
+ * File: <strong>Message.java</strong><br>
+ * Created: <strong>02.01.2020</strong><br>
+ *
+ * @author Kai S. K. Engelbart
+ * @since Envoy Server Standalone v0.1-alpha
+ */
+@Entity
+@Table(name = "messages")
+@NamedQueries(
+	{ @NamedQuery(query = "SELECT m FROM Message m WHERE m.recipient =:recipient AND m.state = 1", name = "getUnreadMessages"), @NamedQuery(
+		query = "SELECT m FROM Message m WHERE m.sender =:sender AND m.state = :state",
+		name = "find read messages"//TODO do we need this namedQuery?
+	), @NamedQuery(query = "SELECT m FROM Message m WHERE m.id = :messageId", name = "get message") }//TODO do we need this namedQuery?
+)
+public class Message {
+
+	@Id
+	private long								id;
+	private User								sender, recipient;
+	@Temporal(TemporalType.TIMESTAMP)
+	private Date								creationDate;
+	@Temporal(TemporalType.TIMESTAMP)
+	private Date								receivedDate;
+	@Temporal(TemporalType.TIMESTAMP)
+	private Date								readDate;
+	private envoy.data.Message.MessageStatus	status;
+	private String								text;
+	private byte[]								attachment;
+
+	/**
+	 * The constructor for a database object
+	 *
+	 * @since Envoy Server Standalone v0.1-alpha
+	 */
+	public Message() {}
+
+	// TODO: everything except ID
+	/**
+	 * @param message the {@link envoy.data.Message} to convert into a database
+	 *                {@link Message}
+	 * @since Envoy Server Standalone v0.1-alpha
+	 */
+	public Message(envoy.data.Message message) {
+		id		= message.getId();
+		status	= message.getStatus();
+		text	= message.getText();
+	}
+
+	/**
+	 * @return a database {@link Message} converted into an
+	 *         {@link envoy.data.Message}
+	 * @since Envoy Server Standalone v0.1-alpha
+	 */
+	public envoy.data.Message toCommonMessage() {
+		// TODO: Attachment, dates
+		return new MessageBuilder(sender.getId(), recipient.getId()).setText(text).setDate(creationDate).setStatus(status).build();
+	}
+
+	/**
+	 * @return the id of a {link envoy.data.Message}
+	 * @since Envoy Server Standalone v0.1-alpha
+	 */
+	public long getId() { return id; }
+
+	/**
+	 * @param id the id to set
+	 * @since Envoy Server Standalone v0.1-alpha
+	 * @see Message#getId()
+	 */
+	public void setId(long id) { this.id = id; }
+
+	/**
+	 * @return the sender of a {link envoy.data.Message}
+	 * @since Envoy Server Standalone v0.1-alpha
+	 */
+	public User getSender() { return sender; }
+
+	/**
+	 * @param sender the sender to set
+	 * @since Envoy Server Standalone v0.1-alpha
+	 * @see Message#getSender()
+	 */
+	public void setSender(User sender) { this.sender = sender; }
+
+	/**
+	 * @return the recipient of a {link envoy.data.Message}
+	 * @since Envoy Server Standalone v0.1-alpha
+	 */
+	public User getRecipient() { return recipient; }
+
+	/**
+	 * @param recipient the recipient to set
+	 * @since Envoy Server Standalone v0.1-alpha
+	 * @see Message#getRecipient()
+	 */
+	public void setRecipient(User recipient) { this.recipient = recipient; }
+
+	/**
+	 * @return the date at which a {link envoy.data.Message} has been created
+	 * @since Envoy Server Standalone v0.1-alpha
+	 */
+	public Date getCreationDate() { return creationDate; }
+
+	/**
+	 * @param creationDate the creation date to set
+	 * @since Envoy Server Standalone v0.1-alpha
+	 * @see Message#getCreationDate()
+	 */
+	public void setCreationDate(Date creationDate) { this.creationDate = creationDate; }
+
+	/**
+	 * @return the date at which a {link envoy.data.Message} has been received by
+	 *         the server
+	 * @since Envoy Server Standalone v0.1-alpha
+	 */
+	public Date getReceivedDate() { return receivedDate; }
+
+	/**
+	 * @param receivedDate the received date to set
+	 * @since Envoy Server Standalone v0.1-alpha
+	 * @see Message#getReceivedDate()
+	 */
+	public void setReceivedDate(Date receivedDate) { this.receivedDate = receivedDate; }
+
+	/**
+	 * @return the date at which a {link envoy.data.Message} has been read
+	 * @since Envoy Server Standalone v0.1-alpha
+	 */
+	public Date getReadDate() { return readDate; }
+
+	/**
+	 * @param readDate the read date to set
+	 * @since Envoy Server Standalone v0.1-alpha
+	 * @see Message#getReadDate()
+	 */
+	public void setReadDate(Date readDate) { this.readDate = readDate; }
+
+	/**
+	 * @return the status of a {link envoy.data.Message}
+	 * @since Envoy Server Standalone v0.1-alpha
+	 */
+	public envoy.data.Message.MessageStatus getStatus() { return status; }
+
+	/**
+	 * @param status the new status of a {link envoy.data.Message}
+	 * @since Envoy Server Standalone v0.1-alpha
+	 */
+	public void setStatus(envoy.data.Message.MessageStatus status) { this.status = status; }
+
+	/**
+	 * @return the text content of a {link envoy.data.Message}
+	 * @since Envoy Server Standalone v0.1-alpha
+	 */
+	public String getText() { return text; }
+
+	/**
+	 * @param text the new text content of a {@link envoy.data.Message}
+	 * @since Envoy Server Standalone v0.1-alpha
+	 */
+	public void setText(String text) { this.text = text; }
+
+	/**
+	 * @return the attachment of a {@link envoy.data.Message}
+	 * @since Envoy Server Standalone v0.1-alpha
+	 */
+	public byte[] getAttachment() { return attachment; }
+
+	/**
+	 * @param attachment the new attachment
+	 * @since Envoy Server Standalone v0.1-alpha
+	 */
+	public void setAttachment(byte[] attachment) { this.attachment = attachment; }
+}

src/main/java/envoy/server/data/User.java

@@ -0,0 +1,120 @@
+package envoy.server.data;
+
+import java.util.Date;
+import java.util.List;
+
+import javax.persistence.Entity;
+import javax.persistence.GeneratedValue;
+import javax.persistence.GenerationType;
+import javax.persistence.Id;
+import javax.persistence.NamedQuery;
+import javax.persistence.Table;
+import javax.persistence.Temporal;
+import javax.persistence.TemporalType;
+
+/**
+ * This class serves as a way to let Hibernate communicate with the server
+ * without bringing the dependency of JPA/Hibernate into the client.<br>
+ * It will be referenced as "database user" to clarify between the different
+ * user objects.<br>
+ * <br>
+ * Project: <strong>envoy-server-standalone</strong><br>
+ * File: <strong>User.java</strong><br>
+ * Created: <strong>02.01.2020</strong><br>
+ *
+ * @author Kai S. K. Engelbart
+ * @since Envoy Server Standalone v0.1-alpha
+ */
+@Entity
+@Table(name = "users")
+@NamedQuery(query = "SELECT u FROM DBUser u WHERE u.id = :id", name = "getUserById")
+public class User {
+
+	@Id
+	@GeneratedValue(strategy = GenerationType.IDENTITY)
+	private long						id;
+	private String						name;
+	private byte[]						passwordHash;
+	@Temporal(TemporalType.TIMESTAMP)
+	private Date						lastSeen;
+	private envoy.data.User.UserStatus	status;
+	private List<User>					contacts;
+
+	/**
+	 * @return the id of a {link envoy.data.User}
+	 * @since Envoy Server Standalone v0.1-alpha
+	 */
+	public long getId() { return id; }
+
+	/**
+	 * @param id the id to set
+	 * @since Envoy Server Standalone v0.1-alpha
+	 * @see User#getId
+	 */
+	public void setId(long id) { this.id = id; }
+
+	/**
+	 * @return the name of a {link envoy.data.User}
+	 * @since Envoy Server Standalone v0.1-alpha
+	 */
+	public String getName() { return name; }
+
+	/**
+	 * @param name the username to set
+	 * @since Envoy Server Standalone v0.1-alpha
+	 * @see User#getName()
+	 */
+	public void setName(String name) { this.name = name; }
+
+	/**
+	 * @return the passwordHash of a {link envoy.data.User}
+	 * @since Envoy Server Standalone v0.1-alpha
+	 */
+	public byte[] getPasswordHash() { return passwordHash; }
+
+	/**
+	 * @param passwordHash the password hash to set
+	 * @since Envoy Server Standalone v0.1-alpha
+	 * @see User#getPasswordHash()
+	 */
+	public void setPasswordHash(byte[] passwordHash) { this.passwordHash = passwordHash; }
+
+	/**
+	 * @return the last date an {link envoy.data.User} has been online
+	 * @since Envoy Server Standalone v0.1-alpha
+	 */
+	public Date getLastSeen() { return lastSeen; }
+
+	/**
+	 * @param lastSeen the latest date at which has been seen to set
+	 * @since Envoy Server Standalone v0.1-alpha
+	 * @see User#getLastSeen()
+	 */
+	public void setLastSeen(Date lastSeen) { this.lastSeen = lastSeen; }
+
+	/**
+	 * @return the status of a {link envoy.data.User}
+	 * @since Envoy Server Standalone v0.1-alpha
+	 */
+	public envoy.data.User.UserStatus getStatus() { return status; }
+
+	/**
+	 * @param status the status to set
+	 * @since Envoy Server Standalone v0.1-alpha
+	 * @see User#getStatus()
+	 */
+	public void setStatus(envoy.data.User.UserStatus status) { this.status = status; }
+
+	/**
+	 * @return the contacts of a {link envoy.data.User}
+	 * @since Envoy Server Standalone v0.1-alpha
+	 */
+	public List<User> getContacts() { return contacts; }
+
+	/**
+	 * @param contacts the contacts to set
+	 * @since Envoy Server Standalone v0.1-alpha
+	 * @see User#getContacts()
+	 */
+	public void setContacts(List<User> contacts) { this.contacts = contacts; }
+}

src/main/java/envoy/server/database/PersistenceManager.java

@@ -0,0 +1,78 @@
+package envoy.server.database;
+
+import java.util.List;
+
+import javax.persistence.EntityManager;
+import javax.persistence.Persistence;
+
+import org.hibernate.Session;
+
+import envoy.server.data.Message;
+import envoy.server.data.User;
+
+/**
+ * Project: <strong>envoy-server-standalone</strong><br>
+ * File: <strong>PersistenceManager.java</strong><br>
+ * Created: <strong>1 Jan 2020</strong><br>
+ *
+ * @author Leon Hofmeister
+ * @since Envoy Server Standalone v0.1-alpha
+ */
+public class PersistenceManager {
+
+	private EntityManager entityManager = Persistence.createEntityManagerFactory("envoy").createEntityManager();
+
+	/**
+	 * Adds a {@link User} to the database.
+	 *
+	 * @param User the {@link User} to add to the database
+	 * @since Envoy Server Standalone v0.1-alpha
+	 */
+	public void addUser(User User) { entityManager.persist(User); }
+
+	/**
+	 * Adds a {@link Message} to the database.
+	 *
+	 * @param message the {@link Message} to add to the database
+	 * @since Envoy Server Standalone v0.1-alpha
+	 */
+	public void addMessage(Message message) { entityManager.persist(message); }
+
+	/**
+	 * Updates a {@link User} in the database
+	 *
+	 * @param user the {@link User} to add to the database
+	 * @since Envoy Server Standalone v0.1-alpha
+	 */
+	public void updateUser(User user) { entityManager.unwrap(Session.class).merge(user); }
+
+	/**
+	 * Updates a {@link Message} in the database.
+	 *
+	 * @param message the message to update
+	 * @since Envoy Server Standalone v0.1-alpha
+	 */
+	public void updateMessage(Message message) { entityManager.unwrap(Session.class).merge(message); }
+
+	/**
+	 * Searches for a user with a specific id.
+	 *
+	 * @param id - the id to search for
+	 * @return the user with the specified id
+	 * @since Envoy Server Standalone v0.1-alpha
+	 */
+	public User getUserById(long id) { return (User) entityManager.createNamedQuery("getUserById").setParameter("id", id).getSingleResult(); }
+
+	/**
+	 * Returns all messages received while being offline.
+	 *
+	 * @param user - the user who wants to receive his unread messages
+	 * @return all messages that the client does not yet have (unread messages)
+	 * @since Envoy Server Standalone v0.1-alpha
+	 */
+	@SuppressWarnings("unchecked")
+	public List<Message> getUnreadMessages(User user) {
+		// TODO may need to be changed to clientId
+		return entityManager.createNamedQuery("getUnreadMessages").setParameter("recipient", user).getResultList();
+	}
+}