Forum Sharing Client UI

This changes `ShareForumActivity` to use two fragments to facilitate
forum sharing with the new Forum Sharing Client backend.

The `ContactSelectorFragment` allows the user to select a
number of contacts. If there is an ongoing sharing session or the forum
is already shared with the contact, it is disabled in the list. If there
is at least one contact selected, a button appears in the toolbar that
brings the user to the `ShareForumMessageFragment` where the user can
write an optional message to be send along with the invitation.

After sending an invitation, the user is brought back to the forum that
she shared and there is a snackbar showing up briefly to indicate the
successful invitation.

The invitation is shown along with the message within the private
conversation of each contact. The person who shares the forum also sees
the invitation and the message as outgoing messages that also display
the current status of the messages.

A notification is shown like for other private messages as well.

Please note that this commit does not include a way for users to respond
to invitations.

briar-android/src/org/briarproject/android/contact/ContactListFragment.java

@@ -29,6 +29,8 @@ import org.briarproject.api.event.ContactStatusChangedEvent;
 import org.briarproject.api.event.Event;
 import org.briarproject.api.event.EventBus;
 import org.briarproject.api.event.MessageValidatedEvent;
+import org.briarproject.api.forum.ForumInvitationMessage;
+import org.briarproject.api.forum.ForumSharingManager;
 import org.briarproject.api.identity.IdentityManager;
 import org.briarproject.api.identity.LocalAuthor;
 import org.briarproject.api.introduction.IntroductionManager;
@@ -86,6 +88,8 @@ public class ContactListFragment extends BaseEventFragment {
 	@Inject
 	protected volatile IntroductionManager introductionManager;
 	@Inject
+	protected volatile ForumSharingManager forumSharingManager;
+	@Inject
 	protected volatile EventBus eventBus;
 
 	@Override
@@ -226,7 +230,8 @@ public class ContactListFragment extends BaseEventFragment {
 			MessageValidatedEvent m = (MessageValidatedEvent) e;
 			ClientId c = m.getClientId();
 			if (m.isValid() && (c.equals(messagingManager.getClientId()) ||
-					c.equals(introductionManager.getClientId()))) {
+					c.equals(introductionManager.getClientId()) ||
+					c.equals(forumSharingManager.getClientId()))) {
 				LOG.info("Message added, reloading");
 				reloadConversation(m.getMessage().getGroupId());
 			}
@@ -317,6 +322,16 @@ public class ContactListFragment extends BaseEventFragment {
 		if (LOG.isLoggable(INFO))
 			LOG.info("Loading introduction messages took " + duration + " ms");
 
+		now = System.currentTimeMillis();
+		Collection<ForumInvitationMessage> invitations =
+				forumSharingManager.getForumInvitationMessages(id);
+		for (ForumInvitationMessage i : invitations) {
+			messages.add(ConversationItem.from(i));
+		}
+		duration = System.currentTimeMillis() - now;
+		if (LOG.isLoggable(INFO))
+			LOG.info("Loading forum invitations took " + duration + " ms");
+
 		return messages;
 	}
 }

briar-android/src/org/briarproject/android/contact/ConversationActivity.java

@@ -42,11 +42,14 @@ import org.briarproject.api.event.ContactRemovedEvent;
 import org.briarproject.api.event.Event;
 import org.briarproject.api.event.EventBus;
 import org.briarproject.api.event.EventListener;
+import org.briarproject.api.event.ForumInvitationReceivedEvent;
 import org.briarproject.api.event.IntroductionRequestReceivedEvent;
 import org.briarproject.api.event.IntroductionResponseReceivedEvent;
 import org.briarproject.api.event.MessageValidatedEvent;
 import org.briarproject.api.event.MessagesAckedEvent;
 import org.briarproject.api.event.MessagesSentEvent;
+import org.briarproject.api.forum.ForumInvitationMessage;
+import org.briarproject.api.forum.ForumSharingManager;
 import org.briarproject.api.introduction.IntroductionManager;
 import org.briarproject.api.introduction.IntroductionMessage;
 import org.briarproject.api.introduction.IntroductionRequest;
@@ -109,6 +112,7 @@ public class ConversationActivity extends BriarActivity
 	@Inject protected volatile EventBus eventBus;
 	@Inject protected volatile PrivateMessageFactory privateMessageFactory;
 	@Inject protected volatile IntroductionManager introductionManager;
+	@Inject protected volatile ForumSharingManager forumSharingManager;
 	private volatile GroupId groupId = null;
 	private volatile ContactId contactId = null;
 	private volatile String contactName = null;
@@ -278,10 +282,13 @@ public class ConversationActivity extends BriarActivity
 					Collection<IntroductionMessage> introductions =
 							introductionManager
 									.getIntroductionMessages(contactId);
+					Collection<ForumInvitationMessage> invitations =
+							forumSharingManager
+									.getForumInvitationMessages(contactId);
 					long duration = System.currentTimeMillis() - now;
 					if (LOG.isLoggable(INFO))
 						LOG.info("Loading headers took " + duration + " ms");
-					displayMessages(headers, introductions);
+					displayMessages(headers, introductions, invitations);
 				} catch (NoSuchContactException e) {
 					finishOnUiThread();
 				} catch (DbException e) {
@@ -293,11 +300,13 @@ public class ConversationActivity extends BriarActivity
 	}
 
 	private void displayMessages(final Collection<PrivateMessageHeader> headers,
-			final Collection<IntroductionMessage> introductions) {
+			final Collection<IntroductionMessage> introductions,
+			final Collection<ForumInvitationMessage> invitations) {
 		runOnUiThread(new Runnable() {
 			public void run() {
 				sendButton.setEnabled(true);
-				if (headers.isEmpty() && introductions.isEmpty()) {
+				if (headers.isEmpty() && introductions.isEmpty() &&
+						invitations.isEmpty()) {
 					// we have no messages,
 					// so let the list know to hide progress bar
 					list.showData();
@@ -326,6 +335,10 @@ public class ConversationActivity extends BriarActivity
 						}
 						items.add(item);
 					}
+					for (ForumInvitationMessage i : invitations) {
+						ConversationItem item = ConversationItem.from(i);
+						items.add(item);
+					}
 					adapter.addAll(items);
 					// Scroll to the bottom
 					list.scrollToPosition(adapter.getItemCount() - 1);
@@ -476,6 +489,12 @@ public class ConversationActivity extends BriarActivity
 						ConversationItem.from(this, contactName, ir);
 				addIntroduction(item);
 			}
+		} else if (e instanceof ForumInvitationReceivedEvent) {
+			ForumInvitationReceivedEvent event =
+					(ForumInvitationReceivedEvent) e;
+			if (event.getContactId().equals(contactId)) {
+				loadMessages();
+			}
 		}
 	}
 

briar-android/src/org/briarproject/android/contact/ConversationAdapter.java

@@ -1,6 +1,7 @@
 package org.briarproject.android.contact;
 
 import android.content.Context;
+import android.content.Intent;
 import android.support.v7.util.SortedList;
 import android.support.v7.widget.RecyclerView;
 import android.text.format.DateUtils;
@@ -13,8 +14,10 @@ import android.widget.ImageView;
 import android.widget.TextView;
 
 import org.briarproject.R;
-import org.briarproject.api.introduction.IntroductionRequest;
+import org.briarproject.android.forum.AvailableForumsActivity;
 import org.briarproject.api.clients.SessionId;
+import org.briarproject.api.forum.ForumInvitationMessage;
+import org.briarproject.api.introduction.IntroductionRequest;
 import org.briarproject.api.messaging.PrivateMessageHeader;
 import org.briarproject.util.StringUtils;
 
@@ -22,6 +25,8 @@ import java.util.List;
 
 import static android.support.v7.util.SortedList.INVALID_POSITION;
 import static android.support.v7.widget.RecyclerView.ViewHolder;
+import static org.briarproject.android.contact.ConversationItem.FORUM_INVITATION_IN;
+import static org.briarproject.android.contact.ConversationItem.FORUM_INVITATION_OUT;
 import static org.briarproject.android.contact.ConversationItem.INTRODUCTION_IN;
 import static org.briarproject.android.contact.ConversationItem.INTRODUCTION_OUT;
 import static org.briarproject.android.contact.ConversationItem.IncomingItem;
@@ -35,50 +40,7 @@ import static org.briarproject.android.contact.ConversationItem.OutgoingItem;
 class ConversationAdapter extends RecyclerView.Adapter {
 
 	private final SortedList<ConversationItem> items =
-			new SortedList<ConversationItem>(ConversationItem.class,
-					new SortedList.Callback<ConversationItem>() {
-						@Override
-						public void onInserted(int position, int count) {
-							notifyItemRangeInserted(position, count);
-						}
-
-						@Override
-						public void onChanged(int position, int count) {
-							notifyItemRangeChanged(position, count);
-						}
-
-						@Override
-						public void onMoved(int fromPosition, int toPosition) {
-							notifyItemMoved(fromPosition, toPosition);
-						}
-
-						@Override
-						public void onRemoved(int position, int count) {
-							notifyItemRangeRemoved(position, count);
-						}
-
-						@Override
-						public int compare(ConversationItem c1,
-								ConversationItem c2) {
-							long time1 = c1.getTime();
-							long time2 = c2.getTime();
-							if (time1 < time2) return -1;
-							if (time1 > time2) return 1;
-							return 0;
-						}
-
-						@Override
-						public boolean areItemsTheSame(ConversationItem c1,
-								ConversationItem c2) {
-							return c1.getId().equals(c2.getId());
-						}
-
-						@Override
-						public boolean areContentsTheSame(ConversationItem c1,
-								ConversationItem c2) {
-							return c1.equals(c2);
-						}
-					});
+			new SortedList<>(ConversationItem.class, new ListCallbacks());
 	private Context ctx;
 	private IntroductionHandler intro;
 	private String contactName;
@@ -129,6 +91,16 @@ class ConversationAdapter extends RecyclerView.Adapter {
 					.inflate(R.layout.list_item_notice_out, viewGroup, false);
 			return new NoticeHolder(v, type);
 		}
+		else if (type == FORUM_INVITATION_IN) {
+			v = LayoutInflater.from(viewGroup.getContext())
+					.inflate(R.layout.list_item_forum_invitation_in, viewGroup, false);
+			return new InvitationHolder(v, type);
+		}
+		else if (type == FORUM_INVITATION_OUT) {
+			v = LayoutInflater.from(viewGroup.getContext())
+					.inflate(R.layout.list_item_forum_invitation_out, viewGroup, false);
+			return new InvitationHolder(v, type);
+		}
 		// incoming message (non-local)
 		else {
 			v = LayoutInflater.from(viewGroup.getContext())
@@ -152,6 +124,12 @@ class ConversationAdapter extends RecyclerView.Adapter {
 			bindNotice((NoticeHolder) ui, (ConversationNoticeOutItem) item);
 		} else if (item instanceof ConversationNoticeInItem) {
 			bindNotice((NoticeHolder) ui, (ConversationNoticeInItem) item);
+		} else if (item instanceof ConversationForumInvitationOutItem) {
+			bindInvitation((InvitationHolder) ui,
+					(ConversationForumInvitationOutItem) item, position);
+		} else if (item instanceof ConversationForumInvitationInItem) {
+			bindInvitation((InvitationHolder) ui,
+					(ConversationForumInvitationInItem) item, position);
 		} else {
 			throw new IllegalArgumentException("Unhandled Conversation Item");
 		}
@@ -204,7 +182,7 @@ class ConversationAdapter extends RecyclerView.Adapter {
 
 		final IntroductionRequest ir = item.getIntroductionRequest();
 
-		final String message = ir.getMessage();
+		String message = ir.getMessage();
 		if (StringUtils.isNullOrEmpty(message)) {
 			ui.messageLayout.setVisibility(View.GONE);
 		} else {
@@ -300,6 +278,63 @@ class ConversationAdapter extends RecyclerView.Adapter {
 		}
 	}
 
+	private void bindInvitation(InvitationHolder ui,
+			final ConversationForumInvitationItem item, final int position) {
+
+		ForumInvitationMessage fim = item.getForumInvitationMessage();
+
+		String message = fim.getMessage();
+		if (StringUtils.isNullOrEmpty(message)) {
+			ui.messageLayout.setVisibility(View.GONE);
+		} else {
+			ui.messageLayout.setVisibility(View.VISIBLE);
+			ui.message.body.setText(message);
+			ui.message.date.setText(
+					DateUtils.getRelativeTimeSpanString(ctx, item.getTime()));
+		}
+
+		// Outgoing Invitation
+		if (item instanceof ConversationForumInvitationOutItem) {
+			ui.text.setText(ctx.getString(R.string.forum_invitation_sent,
+					fim.getForumName(), contactName));
+			ConversationForumInvitationOutItem i =
+					(ConversationForumInvitationOutItem) item;
+			if (i.isSeen()) {
+				ui.status.setImageResource(R.drawable.message_delivered);
+				ui.message.status.setImageResource(R.drawable.message_delivered_white);
+			} else if (i.isSent()) {
+				ui.status.setImageResource(R.drawable.message_sent);
+				ui.message.status.setImageResource(R.drawable.message_sent_white);
+			} else {
+				ui.status.setImageResource(R.drawable.message_stored);
+				ui.message.status.setImageResource(R.drawable.message_stored_white);
+			}
+		}
+		// Incoming Invitation
+		else {
+			ui.text.setText(ctx.getString(R.string.forum_invitation_received,
+					contactName, fim.getForumName()));
+
+			if (fim.isAvailable()) {
+				ui.showForumsButton.setVisibility(View.VISIBLE);
+				ui.showForumsButton
+						.setOnClickListener(new View.OnClickListener() {
+							@Override
+							public void onClick(View v) {
+								Intent intent =
+										new Intent(ctx,
+												AvailableForumsActivity.class);
+								ctx.startActivity(intent);
+							}
+						});
+			} else {
+				ui.showForumsButton.setVisibility(View.GONE);
+			}
+		}
+		ui.date.setText(
+				DateUtils.getRelativeTimeSpanString(ctx, item.getTime()));
+	}
+
 	@Override
 	public int getItemCount() {
 		return items.size();
@@ -321,8 +356,7 @@ class ConversationAdapter extends RecyclerView.Adapter {
 	}
 
 	public SparseArray<IncomingItem> getIncomingMessages() {
-		SparseArray<IncomingItem> messages =
-				new SparseArray<IncomingItem>();
+		SparseArray<IncomingItem> messages = new SparseArray<>();
 
 		for (int i = 0; i < items.size(); i++) {
 			ConversationItem item = items.get(i);
@@ -334,8 +368,7 @@ class ConversationAdapter extends RecyclerView.Adapter {
 	}
 
 	public SparseArray<OutgoingItem> getOutgoingMessages() {
-		SparseArray<OutgoingItem> messages =
-				new SparseArray<OutgoingItem>();
+		SparseArray<OutgoingItem> messages = new SparseArray<>();
 
 		for (int i = 0; i < items.size(); i++) {
 			ConversationItem item = items.get(i);
@@ -347,8 +380,7 @@ class ConversationAdapter extends RecyclerView.Adapter {
 	}
 
 	public SparseArray<ConversationMessageItem> getPrivateMessages() {
-		SparseArray<ConversationMessageItem> messages =
-				new SparseArray<ConversationMessageItem>();
+		SparseArray<ConversationMessageItem> messages =	new SparseArray<>();
 
 		for (int i = 0; i < items.size(); i++) {
 			ConversationItem item = items.get(i);
@@ -394,14 +426,14 @@ class ConversationAdapter extends RecyclerView.Adapter {
 
 	private static class IntroductionHolder extends RecyclerView.ViewHolder {
 
-		public ViewGroup layout;
-		public View messageLayout;
-		public MessageHolder message;
-		public TextView text;
-		public Button acceptButton;
-		public Button declineButton;
-		public TextView date;
-		public ImageView status;
+		final private ViewGroup layout;
+		final private View messageLayout;
+		final private MessageHolder message;
+		final private TextView text;
+		final private Button acceptButton;
+		final private Button declineButton;
+		final private TextView date;
+		final private ImageView status;
 
 		public IntroductionHolder(View v, int type) {
 			super(v);
@@ -417,16 +449,18 @@ class ConversationAdapter extends RecyclerView.Adapter {
 
 			if (type == INTRODUCTION_OUT) {
 				status = (ImageView) v.findViewById(R.id.introductionStatus);
+			} else {
+				status = null;
 			}
 		}
 	}
 
 	private static class NoticeHolder extends RecyclerView.ViewHolder {
 
-		public ViewGroup layout;
-		public TextView text;
-		public TextView date;
-		public ImageView status;
+		final private ViewGroup layout;
+		final private TextView text;
+		final private TextView date;
+		final private ImageView status;
 
 		public NoticeHolder(View v, int type) {
 			super(v);
@@ -437,10 +471,85 @@ class ConversationAdapter extends RecyclerView.Adapter {
 
 			if (type == NOTICE_OUT) {
 				status = (ImageView) v.findViewById(R.id.noticeStatus);
+			} else {
+				status = null;
 			}
 		}
 	}
 
+	private static class InvitationHolder extends RecyclerView.ViewHolder {
+
+		final private ViewGroup layout;
+		final private View messageLayout;
+		final private MessageHolder message;
+		final private TextView text;
+		final private Button showForumsButton;
+		final private TextView date;
+		final private ImageView status;
+
+		public InvitationHolder(View v, int type) {
+			super(v);
+
+			layout = (ViewGroup) v.findViewById(R.id.introductionLayout);
+			messageLayout = v.findViewById(R.id.messageLayout);
+			message = new MessageHolder(messageLayout,
+					type == FORUM_INVITATION_IN ? MSG_IN : MSG_OUT);
+			text = (TextView) v.findViewById(R.id.introductionText);
+			showForumsButton = (Button) v.findViewById(R.id.showForumsButton);
+			date = (TextView) v.findViewById(R.id.introductionTime);
+
+			if (type == FORUM_INVITATION_OUT) {
+				status = (ImageView) v.findViewById(R.id.introductionStatus);
+			} else {
+				status = null;
+			}
+		}
+	}
+
+	private class ListCallbacks extends SortedList.Callback<ConversationItem> {
+		@Override
+		public void onInserted(int position, int count) {
+			notifyItemRangeInserted(position, count);
+		}
+
+		@Override
+		public void onChanged(int position, int count) {
+			notifyItemRangeChanged(position, count);
+		}
+
+		@Override
+		public void onMoved(int fromPosition, int toPosition) {
+			notifyItemMoved(fromPosition, toPosition);
+		}
+
+		@Override
+		public void onRemoved(int position, int count) {
+			notifyItemRangeRemoved(position, count);
+		}
+
+		@Override
+		public int compare(ConversationItem c1,
+				ConversationItem c2) {
+			long time1 = c1.getTime();
+			long time2 = c2.getTime();
+			if (time1 < time2) return -1;
+			if (time1 > time2) return 1;
+			return 0;
+		}
+
+		@Override
+		public boolean areItemsTheSame(ConversationItem c1,
+				ConversationItem c2) {
+			return c1.getId().equals(c2.getId());
+		}
+
+		@Override
+		public boolean areContentsTheSame(ConversationItem c1,
+				ConversationItem c2) {
+			return c1.equals(c2);
+		}
+	}
+
 	public interface IntroductionHandler {
 		void respondToIntroduction(final SessionId sessionId,
 				final boolean accept);

briar-android/src/org/briarproject/android/contact/ConversationForumInvitationInItem.java

@@ -0,0 +1,33 @@
+package org.briarproject.android.contact;
+
+import org.briarproject.api.forum.ForumInvitationMessage;
+
+// This class is not thread-safe
+public class ConversationForumInvitationInItem
+		extends ConversationForumInvitationItem
+		implements ConversationItem.IncomingItem {
+
+	private boolean read;
+
+	public ConversationForumInvitationInItem(ForumInvitationMessage fim) {
+		super(fim);
+
+		this.read = fim.isRead();
+	}
+
+	@Override
+	int getType() {
+		return FORUM_INVITATION_IN;
+	}
+
+	@Override
+	public boolean isRead() {
+		return read;
+	}
+
+	@Override
+	public void setRead(boolean read) {
+		this.read = read;
+	}
+
+}

briar-android/src/org/briarproject/android/contact/ConversationForumInvitationItem.java

@@ -0,0 +1,19 @@
+package org.briarproject.android.contact;
+
+import org.briarproject.api.forum.ForumInvitationMessage;
+
+abstract class ConversationForumInvitationItem extends ConversationItem {
+
+	private ForumInvitationMessage fim;
+
+	public ConversationForumInvitationItem(ForumInvitationMessage fim) {
+		super(fim.getId(), fim.getTimestamp());
+
+		this.fim = fim;
+	}
+
+	public ForumInvitationMessage getForumInvitationMessage() {
+		return fim;
+	}
+
+}

briar-android/src/org/briarproject/android/contact/ConversationForumInvitationOutItem.java

@@ -0,0 +1,49 @@
+package org.briarproject.android.contact;
+
+import org.briarproject.api.forum.ForumInvitationMessage;
+
+/**
+ * This class is needed and can not be replaced by an ConversationNoticeOutItem,
+ * because it carries the optional invitation message
+ * to be displayed as a regular private message.
+ *
+ * This class is not thread-safe
+ */
+public class ConversationForumInvitationOutItem
+		extends ConversationForumInvitationItem
+		implements ConversationItem.OutgoingItem {
+
+	private boolean sent, seen;
+
+	public ConversationForumInvitationOutItem(ForumInvitationMessage fim) {
+		super(fim);
+		this.sent = fim.isSent();
+		this.seen = fim.isSeen();
+	}
+
+	@Override
+	int getType() {
+		return FORUM_INVITATION_OUT;
+	}
+
+	@Override
+	public boolean isSent() {
+		return sent;
+	}
+
+	@Override
+	public void setSent(boolean sent) {
+		this.sent = sent;
+	}
+
+	@Override
+	public boolean isSeen() {
+		return seen;
+	}
+
+	@Override
+	public void setSeen(boolean seen) {
+		this.seen = seen;
+	}
+
+}

briar-android/src/org/briarproject/android/contact/ConversationIntroductionInItem.java

@@ -3,6 +3,7 @@ package org.briarproject.android.contact;
 import org.briarproject.api.introduction.IntroductionRequest;
 import org.briarproject.api.sync.MessageId;
 
+// This class is not thread-safe
 public class ConversationIntroductionInItem extends ConversationIntroductionItem
 		implements ConversationItem.IncomingItem {
 

briar-android/src/org/briarproject/android/contact/ConversationIntroductionOutItem.java

@@ -6,6 +6,8 @@ import org.briarproject.api.introduction.IntroductionRequest;
  * This class is needed and can not be replaced by an ConversationNoticeOutItem,
  * because it carries the optional introduction message
  * to be displayed as a regular private message.
+ *
+ *  This class is not thread-safe
  */
 public class ConversationIntroductionOutItem
 		extends ConversationIntroductionItem

briar-android/src/org/briarproject/android/contact/ConversationItem.java

@@ -3,6 +3,7 @@ package org.briarproject.android.contact;
 import android.content.Context;
 
 import org.briarproject.R;
+import org.briarproject.api.forum.ForumInvitationMessage;
 import org.briarproject.api.introduction.IntroductionMessage;
 import org.briarproject.api.introduction.IntroductionRequest;
 import org.briarproject.api.introduction.IntroductionResponse;
@@ -20,6 +21,8 @@ public abstract class ConversationItem {
 	final static int INTRODUCTION_OUT = 4;
 	final static int NOTICE_IN = 5;
 	final static int NOTICE_OUT = 6;
+	final static int FORUM_INVITATION_IN = 7;
+	final static int FORUM_INVITATION_OUT = 8;
 
 	private MessageId id;
 	private long time;
@@ -92,6 +95,14 @@ public abstract class ConversationItem {
 		}
 	}
 
+	public static ConversationItem from(ForumInvitationMessage fim) {
+		if (fim.isLocal()) {
+			return new ConversationForumInvitationOutItem(fim);
+		} else {
+			return new ConversationForumInvitationInItem(fim);
+		}
+	}
+
 	/** This method should not be used to get user-facing objects,
 	 *  Its purpose is to provider data for the contact list.
 	 */

briar-android/src/org/briarproject/android/contact/ConversationNoticeInItem.java

@@ -2,6 +2,7 @@ package org.briarproject.android.contact;
 
 import org.briarproject.api.sync.MessageId;
 
+// This class is not thread-safe
 public class ConversationNoticeInItem extends ConversationNoticeItem implements
 		ConversationItem.IncomingItem {
 

briar-android/src/org/briarproject/android/contact/ConversationNoticeOutItem.java

@@ -2,6 +2,7 @@ package org.briarproject.android.contact;
 
 import org.briarproject.api.sync.MessageId;
 
+// This class is not thread-safe
 public class ConversationNoticeOutItem extends ConversationNoticeItem implements
 		ConversationItem.OutgoingItem {