Factor out generic sharing code from ForumSharingManger

briar-api/src/org/briarproject/api/event/ForumInvitationReceivedEvent.java

@@ -4,21 +4,16 @@ import org.briarproject.api.contact.ContactId;
 import org.briarproject.api.forum.Forum;
 import org.briarproject.api.introduction.IntroductionRequest;
 
-public class ForumInvitationReceivedEvent extends Event {
+public class ForumInvitationReceivedEvent extends InvitationReceivedEvent {
 
 	private final Forum forum;
-	private final ContactId contactId;
 
 	public ForumInvitationReceivedEvent(Forum forum, ContactId contactId) {
+		super(contactId);
 		this.forum = forum;
-		this.contactId = contactId;
 	}
 
 	public Forum getForum() {
 		return forum;
 	}
-
-	public ContactId getContactId() {
-		return contactId;
-	}
 }

briar-api/src/org/briarproject/api/event/ForumInvitationResponseReceivedEvent.java

@@ -2,23 +2,17 @@ package org.briarproject.api.event;
 
 import org.briarproject.api.contact.ContactId;
 
-public class ForumInvitationResponseReceivedEvent extends Event {
+public class ForumInvitationResponseReceivedEvent extends InvitationResponseReceivedEvent {
 
 	private final String forumName;
-	private final ContactId contactId;
 
 	public ForumInvitationResponseReceivedEvent(String forumName,
 			ContactId contactId) {
-
+		super(contactId);
 		this.forumName = forumName;
-		this.contactId = contactId;
 	}
 
 	public String getForumName() {
 		return forumName;
 	}
-
-	public ContactId getContactId() {
-		return contactId;
-	}
 }

briar-api/src/org/briarproject/api/event/InvitationReceivedEvent.java

@@ -0,0 +1,17 @@
+package org.briarproject.api.event;
+
+import org.briarproject.api.contact.ContactId;
+import org.briarproject.api.forum.Forum;
+
+public abstract class InvitationReceivedEvent extends Event {
+
+	private final ContactId contactId;
+
+	public InvitationReceivedEvent(ContactId contactId) {
+		this.contactId = contactId;
+	}
+
+	public ContactId getContactId() {
+		return contactId;
+	}
+}

briar-api/src/org/briarproject/api/event/InvitationResponseReceivedEvent.java

@@ -0,0 +1,16 @@
+package org.briarproject.api.event;
+
+import org.briarproject.api.contact.ContactId;
+
+public abstract class InvitationResponseReceivedEvent extends Event {
+
+	private final ContactId contactId;
+
+	public InvitationResponseReceivedEvent(ContactId contactId) {
+		this.contactId = contactId;
+	}
+
+	public ContactId getContactId() {
+		return contactId;
+	}
+}

briar-api/src/org/briarproject/api/forum/Forum.java

@@ -1,9 +1,10 @@
 package org.briarproject.api.forum;
 
+import org.briarproject.api.sharing.Shareable;
 import org.briarproject.api.sync.Group;
 import org.briarproject.api.sync.GroupId;
 
-public class Forum {
+public class Forum implements Shareable {
 
 	private final Group group;
 	private final String name;

briar-api/src/org/briarproject/api/forum/ForumConstants.java

@@ -17,37 +17,8 @@ public interface ForumConstants {
 	int MAX_FORUM_POST_BODY_LENGTH = MAX_MESSAGE_BODY_LENGTH - 1024;
 
 	/* Forum Sharing Constants */
-	String CONTACT_ID = "contactId";
-	String GROUP_ID = "groupId";
-	String TO_BE_SHARED_BY_US = "toBeSharedByUs";
-	String SHARED_BY_US = "sharedByUs";
-	String SHARED_WITH_US = "sharedWithUs";
-	String TYPE = "type";
-	String SESSION_ID = "sessionId";
-	String STORAGE_ID = "storageId";
-	String STATE = "state";
-	String LOCAL = "local";
-	String TIME = "time";
-	String READ = "read";
-	String IS_SHARER = "isSharer";
-	String FORUM_ID = "forumId";
 	String FORUM_NAME = "forumName";
 	String FORUM_SALT = "forumSalt";
-	String INVITATION_MSG = "invitationMsg";
-	int SHARE_MSG_TYPE_INVITATION = 1;
-	int SHARE_MSG_TYPE_ACCEPT = 2;
-	int SHARE_MSG_TYPE_DECLINE = 3;
-	int SHARE_MSG_TYPE_LEAVE = 4;
-	int SHARE_MSG_TYPE_ABORT = 5;
-	String TASK = "task";
-	int TASK_ADD_FORUM_TO_LIST_SHARED_WITH_US = 0;
-	int TASK_REMOVE_FORUM_FROM_LIST_SHARED_WITH_US = 1;
-	int TASK_ADD_SHARED_FORUM = 2;
-	int TASK_ADD_FORUM_TO_LIST_TO_BE_SHARED_BY_US = 3;
-	int TASK_REMOVE_FORUM_FROM_LIST_TO_BE_SHARED_BY_US = 4;
-	int TASK_SHARE_FORUM = 5;
-	int TASK_UNSHARE_FORUM_SHARED_BY_US = 6;
-	int TASK_UNSHARE_FORUM_SHARED_WITH_US = 7;
 
 	// Database keys
 	String KEY_TIMESTAMP = "timestamp";

briar-api/src/org/briarproject/api/forum/ForumInvitationMessage.java

@@ -3,46 +3,25 @@ package org.briarproject.api.forum;
 import org.briarproject.api.clients.SessionId;
 import org.briarproject.api.contact.ContactId;
 import org.briarproject.api.messaging.BaseMessage;
+import org.briarproject.api.sharing.InvitationMessage;
 import org.briarproject.api.sync.MessageId;
 
-public class ForumInvitationMessage extends BaseMessage {
+public class ForumInvitationMessage extends InvitationMessage {
 
-	private final SessionId sessionId;
-	private final ContactId contactId;
-	private final String forumName, message;
-	private final boolean available;
+	private final String forumName;
 
 	public ForumInvitationMessage(MessageId id, SessionId sessionId,
 			ContactId contactId, String forumName, String message,
 			boolean available, long time, boolean local, boolean sent,
 			boolean seen, boolean read) {
 
-		super(id, time, local, read, sent, seen);
-		this.sessionId = sessionId;
-		this.contactId = contactId;
+		super(id, sessionId, contactId, message, available, time, local, sent,
+				seen, read);
 		this.forumName = forumName;
-		this.message = message;
-		this.available = available;
-	}
-
-	public SessionId getSessionId() {
-		return sessionId;
-	}
-
-	public ContactId getContactId() {
-		return contactId;
 	}
 
 	public String getForumName() {
 		return forumName;
 	}
 
-	public String getMessage() {
-		return message;
-	}
-
-	public boolean isAvailable() {
-		return available;
-	}
-
 }

briar-api/src/org/briarproject/api/forum/ForumSharingManager.java

@@ -1,15 +1,15 @@
 package org.briarproject.api.forum;
 
-import org.briarproject.api.clients.SessionId;
 import org.briarproject.api.contact.Contact;
 import org.briarproject.api.contact.ContactId;
 import org.briarproject.api.db.DbException;
+import org.briarproject.api.sharing.SharingManager;
 import org.briarproject.api.sync.ClientId;
 import org.briarproject.api.sync.GroupId;
 
 import java.util.Collection;
 
-public interface ForumSharingManager {
+public interface ForumSharingManager extends SharingManager<Forum, ForumInvitationMessage> {
 
 	/** Returns the unique ID of the forum sharing client. */
 	ClientId getClientId();
@@ -18,7 +18,7 @@ public interface ForumSharingManager {
 	 * Sends an invitation to share the given forum with the given contact
 	 * and sends an optional message along with it.
 	 */
-	void sendForumInvitation(GroupId groupId, ContactId contactId,
+	void sendInvitation(GroupId groupId, ContactId contactId,
 			String message)	throws DbException;
 
 	/**
@@ -31,11 +31,11 @@ public interface ForumSharingManager {
 	 * Returns all forum sharing messages sent by the Contact
 	 * identified by contactId.
 	 */
-	Collection<ForumInvitationMessage> getForumInvitationMessages(
+	Collection<ForumInvitationMessage> getInvitationMessages(
 			ContactId contactId) throws DbException;
 
 	/** Returns all forums to which the user could subscribe. */
-	Collection<Forum> getAvailableForums() throws DbException;
+	Collection<Forum> getAvailable() throws DbException;
 
 	/** Returns all contacts who are sharing the given forum with us. */
 	Collection<Contact> getSharedBy(GroupId g) throws DbException;

briar-api/src/org/briarproject/api/forum/ForumSharingMessage.java

@@ -3,89 +3,29 @@ package org.briarproject.api.forum;
 import org.briarproject.api.FormatException;
 import org.briarproject.api.clients.SessionId;
 import org.briarproject.api.data.BdfDictionary;
-import org.briarproject.api.data.BdfEntry;
 import org.briarproject.api.data.BdfList;
+import org.briarproject.api.sharing.SharingMessage.Invitation;
 import org.briarproject.api.sync.GroupId;
 
 import static org.briarproject.api.forum.ForumConstants.FORUM_NAME;
 import static org.briarproject.api.forum.ForumConstants.FORUM_SALT;
-import static org.briarproject.api.forum.ForumConstants.GROUP_ID;
-import static org.briarproject.api.forum.ForumConstants.INVITATION_MSG;
-import static org.briarproject.api.forum.ForumConstants.SESSION_ID;
-import static org.briarproject.api.forum.ForumConstants.SHARE_MSG_TYPE_ABORT;
-import static org.briarproject.api.forum.ForumConstants.SHARE_MSG_TYPE_ACCEPT;
-import static org.briarproject.api.forum.ForumConstants.SHARE_MSG_TYPE_DECLINE;
-import static org.briarproject.api.forum.ForumConstants.SHARE_MSG_TYPE_INVITATION;
-import static org.briarproject.api.forum.ForumConstants.SHARE_MSG_TYPE_LEAVE;
-import static org.briarproject.api.forum.ForumConstants.TYPE;
+import static org.briarproject.api.sharing.SharingConstants.INVITATION_MSG;
+import static org.briarproject.api.sharing.SharingConstants.SESSION_ID;
 
 public interface ForumSharingMessage {
 
-	abstract class BaseMessage {
-		private final GroupId groupId;
-		private final SessionId sessionId;
-
-		public BaseMessage(GroupId groupId, SessionId sessionId) {
-
-			this.groupId = groupId;
-			this.sessionId = sessionId;
-		}
-
-		public BdfList toBdfList() {
-			return BdfList.of(getType(), getSessionId());
-		}
-
-		public abstract BdfDictionary toBdfDictionary();
-
-		protected BdfDictionary toBdfDictionaryHelper() {
-			return BdfDictionary.of(
-					new BdfEntry(TYPE, getType()),
-					new BdfEntry(GROUP_ID, groupId),
-					new BdfEntry(SESSION_ID, sessionId)
-			);
-		}
-
-		public static BaseMessage from(GroupId groupId, BdfDictionary d)
-				throws FormatException {
-
-			long type = d.getLong(TYPE);
-
-			if (type == SHARE_MSG_TYPE_INVITATION)
-				return Invitation.from(groupId, d);
-			else
-				return SimpleMessage.from(type, groupId, d);
-		}
-
-		public abstract long getType();
-
-		public GroupId getGroupId() {
-			return groupId;
-		}
-
-		public SessionId getSessionId() {
-			return sessionId;
-		}
-	}
-
-	class Invitation extends BaseMessage {
+	class ForumInvitation extends Invitation {
 
 		private final String forumName;
 		private final byte[] forumSalt;
-		private final String message;
 
-		public Invitation(GroupId groupId, SessionId sessionId,
+		public ForumInvitation(GroupId groupId, SessionId sessionId,
 				String forumName, byte[] forumSalt, String message) {
 
-			super(groupId, sessionId);
+			super(groupId, sessionId, message);
 
 			this.forumName = forumName;
 			this.forumSalt = forumSalt;
-			this.message = message;
-		}
-
-		@Override
-		public long getType() {
-			return SHARE_MSG_TYPE_INVITATION;
 		}
 
 		@Override
@@ -106,7 +46,7 @@ public interface ForumSharingMessage {
 			return d;
 		}
 
-		public static Invitation from(GroupId groupId, BdfDictionary d)
+		public static ForumInvitation from(GroupId groupId, BdfDictionary d)
 				throws FormatException {
 
 			SessionId sessionId = new SessionId(d.getRaw(SESSION_ID));
@@ -114,7 +54,7 @@ public interface ForumSharingMessage {
 			byte[] forumSalt = d.getRaw(FORUM_SALT);
 			String message = d.getOptionalString(INVITATION_MSG);
 
-			return new Invitation(groupId, sessionId, forumName, forumSalt,
+			return new ForumInvitation(groupId, sessionId, forumName, forumSalt,
 					message);
 		}
 
@@ -125,42 +65,5 @@ public interface ForumSharingMessage {
 		public byte[] getForumSalt() {
 			return forumSalt;
 		}
-
-		public String getMessage() {
-			return message;
-		}
 	}
-
-	class SimpleMessage extends BaseMessage {
-
-		private final long type;
-
-		public SimpleMessage(long type, GroupId groupId, SessionId sessionId) {
-			super(groupId, sessionId);
-			this.type = type;
-		}
-
-		@Override
-		public long getType() {
-			return type;
-		}
-
-		@Override
-		public BdfDictionary toBdfDictionary() {
-			return toBdfDictionaryHelper();
-		}
-
-		public static SimpleMessage from(long type, GroupId groupId,
-				BdfDictionary d) throws FormatException {
-
-			if (type != SHARE_MSG_TYPE_ACCEPT &&
-					type != SHARE_MSG_TYPE_DECLINE &&
-					type != SHARE_MSG_TYPE_LEAVE &&
-					type != SHARE_MSG_TYPE_ABORT) throw new FormatException();
-
-			SessionId sessionId = new SessionId(d.getRaw(SESSION_ID));
-			return new SimpleMessage(type, groupId, sessionId);
-		}
-	}
-
 }

briar-api/src/org/briarproject/api/sharing/InvitationFactory.java

@@ -0,0 +1,10 @@
+package org.briarproject.api.sharing;
+
+import org.briarproject.api.FormatException;
+import org.briarproject.api.data.BdfDictionary;
+import org.briarproject.api.sync.GroupId;
+
+public interface InvitationFactory<I extends SharingMessage.Invitation> {
+
+	I build(GroupId groupId, BdfDictionary d) throws FormatException;
+}

briar-api/src/org/briarproject/api/sharing/InvitationMessage.java

@@ -0,0 +1,43 @@
+package org.briarproject.api.sharing;
+
+import org.briarproject.api.clients.SessionId;
+import org.briarproject.api.contact.ContactId;
+import org.briarproject.api.messaging.BaseMessage;
+import org.briarproject.api.sync.MessageId;
+
+public abstract class InvitationMessage extends BaseMessage {
+
+	private final SessionId sessionId;
+	private final ContactId contactId;
+	private final String message;
+	private final boolean available;
+
+	public InvitationMessage(MessageId id, SessionId sessionId,
+			ContactId contactId, String message,
+			boolean available, long time, boolean local, boolean sent,
+			boolean seen, boolean read) {
+
+		super(id, time, local, read, sent, seen);
+		this.sessionId = sessionId;
+		this.contactId = contactId;
+		this.message = message;
+		this.available = available;
+	}
+
+	public SessionId getSessionId() {
+		return sessionId;
+	}
+
+	public ContactId getContactId() {
+		return contactId;
+	}
+
+	public String getMessage() {
+		return message;
+	}
+
+	public boolean isAvailable() {
+		return available;
+	}
+
+}

briar-api/src/org/briarproject/api/sharing/Shareable.java

@@ -0,0 +1,11 @@
+package org.briarproject.api.sharing;
+
+import org.briarproject.api.sync.Group;
+import org.briarproject.api.sync.GroupId;
+
+public interface Shareable {
+
+	GroupId getId();
+
+	Group getGroup();
+}

briar-api/src/org/briarproject/api/sharing/SharingConstants.java

@@ -0,0 +1,38 @@
+package org.briarproject.api.sharing;
+
+public interface SharingConstants {
+
+	/** The length of a sharing session's random salt in bytes. */
+	int SHARING_SALT_LENGTH = 32;
+
+	String CONTACT_ID = "contactId";
+	String GROUP_ID = "groupId";
+	String TO_BE_SHARED_BY_US = "toBeSharedByUs";
+	String SHARED_BY_US = "sharedByUs";
+	String SHARED_WITH_US = "sharedWithUs";
+	String TYPE = "type";
+	String SESSION_ID = "sessionId";
+	String STORAGE_ID = "storageId";
+	String STATE = "state";
+	String LOCAL = "local";
+	String TIME = "time";
+	String READ = "read";
+	String IS_SHARER = "isSharer";
+	String SHAREABLE_ID = "shareableId";
+	String INVITATION_MSG = "invitationMsg";
+	int SHARE_MSG_TYPE_INVITATION = 1;
+	int SHARE_MSG_TYPE_ACCEPT = 2;
+	int SHARE_MSG_TYPE_DECLINE = 3;
+	int SHARE_MSG_TYPE_LEAVE = 4;
+	int SHARE_MSG_TYPE_ABORT = 5;
+	String TASK = "task";
+	int TASK_ADD_SHAREABLE_TO_LIST_SHARED_WITH_US = 0;
+	int TASK_REMOVE_SHAREABLE_FROM_LIST_SHARED_WITH_US = 1;
+	int TASK_ADD_SHARED_SHAREABLE = 2;
+	int TASK_ADD_SHAREABLE_TO_LIST_TO_BE_SHARED_BY_US = 3;
+	int TASK_REMOVE_SHAREABLE_FROM_LIST_TO_BE_SHARED_BY_US = 4;
+	int TASK_SHARE_SHAREABLE = 5;
+	int TASK_UNSHARE_SHAREABLE_SHARED_BY_US = 6;
+	int TASK_UNSHARE_SHAREABLE_SHARED_WITH_US = 7;
+
+}

briar-api/src/org/briarproject/api/sharing/SharingManager.java

@@ -0,0 +1,50 @@
+package org.briarproject.api.sharing;
+
+import org.briarproject.api.contact.Contact;
+import org.briarproject.api.contact.ContactId;
+import org.briarproject.api.db.DbException;
+import org.briarproject.api.forum.Forum;
+import org.briarproject.api.forum.ForumInvitationMessage;
+import org.briarproject.api.sync.ClientId;
+import org.briarproject.api.sync.GroupId;
+
+import java.util.Collection;
+
+public interface SharingManager<S extends Shareable, IM extends InvitationMessage> {
+
+	/** Returns the unique ID of the group sharing client. */
+	ClientId getClientId();
+
+	/**
+	 * Sends an invitation to share the given group with the given contact
+	 * and sends an optional message along with it.
+	 */
+	void sendInvitation(GroupId groupId, ContactId contactId,
+			String message)	throws DbException;
+
+	/**
+	 * Responds to a pending group invitation
+	 */
+	void respondToInvitation(S s, Contact c, boolean accept)
+			throws DbException;
+
+	/**
+	 * Returns all group sharing messages sent by the Contact
+	 * identified by contactId.
+	 */
+	Collection<IM> getInvitationMessages(
+			ContactId contactId) throws DbException;
+
+	/** Returns all groups to which the user could subscribe. */
+	Collection<S> getAvailable() throws DbException;
+
+	/** Returns all contacts who are sharing the given group with us. */
+	Collection<Contact> getSharedBy(GroupId g) throws DbException;
+
+	/** Returns the IDs of all contacts with whom the given group is shared. */
+	Collection<Contact> getSharedWith(GroupId g) throws DbException;
+
+	/** Returns true if the group not already shared and no invitation is open */
+	boolean canBeShared(GroupId g, Contact c) throws DbException;
+
+}

briar-api/src/org/briarproject/api/sharing/SharingMessage.java

@@ -0,0 +1,122 @@
+package org.briarproject.api.sharing;
+
+import org.briarproject.api.FormatException;
+import org.briarproject.api.clients.SessionId;
+import org.briarproject.api.data.BdfDictionary;
+import org.briarproject.api.data.BdfEntry;
+import org.briarproject.api.data.BdfList;
+import org.briarproject.api.sync.GroupId;
+
+import static org.briarproject.api.sharing.SharingConstants.GROUP_ID;
+import static org.briarproject.api.sharing.SharingConstants.SESSION_ID;
+import static org.briarproject.api.sharing.SharingConstants.SHARE_MSG_TYPE_ABORT;
+import static org.briarproject.api.sharing.SharingConstants.SHARE_MSG_TYPE_ACCEPT;
+import static org.briarproject.api.sharing.SharingConstants.SHARE_MSG_TYPE_DECLINE;
+import static org.briarproject.api.sharing.SharingConstants.SHARE_MSG_TYPE_INVITATION;
+import static org.briarproject.api.sharing.SharingConstants.SHARE_MSG_TYPE_LEAVE;
+import static org.briarproject.api.sharing.SharingConstants.TYPE;
+
+public interface SharingMessage {
+
+	abstract class BaseMessage {
+		private final GroupId groupId;
+		private final SessionId sessionId;
+
+		public BaseMessage(GroupId groupId, SessionId sessionId) {
+
+			this.groupId = groupId;
+			this.sessionId = sessionId;
+		}
+
+		public BdfList toBdfList() {
+			return BdfList.of(getType(), getSessionId());
+		}
+
+		public abstract BdfDictionary toBdfDictionary();
+
+		protected BdfDictionary toBdfDictionaryHelper() {
+			return BdfDictionary.of(
+					new BdfEntry(TYPE, getType()),
+					new BdfEntry(GROUP_ID, groupId),
+					new BdfEntry(SESSION_ID, sessionId)
+			);
+		}
+
+		public static BaseMessage from(InvitationFactory invitationFactory,
+				GroupId groupId, BdfDictionary d)
+				throws FormatException {
+
+			long type = d.getLong(TYPE);
+
+			if (type == SHARE_MSG_TYPE_INVITATION)
+				return invitationFactory.build(groupId, d);
+			else
+				return SimpleMessage.from(type, groupId, d);
+		}
+
+		public abstract long getType();
+
+		public GroupId getGroupId() {
+			return groupId;
+		}
+
+		public SessionId getSessionId() {
+			return sessionId;
+		}
+	}
+
+	abstract class Invitation extends BaseMessage {
+
+		protected final String message;
+
+		public Invitation(GroupId groupId, SessionId sessionId,
+				String message) {
+
+			super(groupId, sessionId);
+
+			this.message = message;
+		}
+
+		@Override
+		public long getType() {
+			return SHARE_MSG_TYPE_INVITATION;
+		}
+
+		public String getMessage() {
+			return message;
+		}
+	}
+
+	class SimpleMessage extends BaseMessage {
+
+		private final long type;
+
+		public SimpleMessage(long type, GroupId groupId, SessionId sessionId) {
+			super(groupId, sessionId);
+			this.type = type;
+		}
+
+		@Override
+		public long getType() {
+			return type;
+		}
+
+		@Override
+		public BdfDictionary toBdfDictionary() {
+			return toBdfDictionaryHelper();
+		}
+
+		public static SimpleMessage from(long type, GroupId groupId,
+				BdfDictionary d) throws FormatException {
+
+			if (type != SHARE_MSG_TYPE_ACCEPT &&
+					type != SHARE_MSG_TYPE_DECLINE &&
+					type != SHARE_MSG_TYPE_LEAVE &&
+					type != SHARE_MSG_TYPE_ABORT) throw new FormatException();
+
+			SessionId sessionId = new SessionId(d.getRaw(SESSION_ID));
+			return new SimpleMessage(type, groupId, sessionId);
+		}
+	}
+
+}