Merge branch 'contact-exchange-refactoring' into 'master'

Contact exchange refactoring See merge request briar/briar!1106
2026-02-13 19:29:06 +01:00 · 2019-05-24 17:33:21 +00:00
parent cff5e53d09 d80c77f466
commit 4a92625a7b
19 changed files with 409 additions and 331 deletions
--- a/briar-android/src/main/java/org/briarproject/briar/android/AndroidComponent.java
+++ b/briar-android/src/main/java/org/briarproject/briar/android/AndroidComponent.java
@@ -8,7 +8,7 @@ import org.briarproject.bramble.BrambleCoreEagerSingletons;
 import org.briarproject.bramble.BrambleCoreModule;
 import org.briarproject.bramble.account.BriarAccountModule;
 import org.briarproject.bramble.api.account.AccountManager;
-import org.briarproject.bramble.api.contact.ContactExchangeTask;
+import org.briarproject.bramble.api.contact.ContactExchangeManager;
 import org.briarproject.bramble.api.contact.ContactManager;
 import org.briarproject.bramble.api.crypto.CryptoExecutor;
 import org.briarproject.bramble.api.crypto.PasswordStrengthEstimator;
@@ -128,7 +128,7 @@ public interface AndroidComponent

 	SettingsManager settingsManager();

-	ContactExchangeTask contactExchangeTask();
+	ContactExchangeManager contactExchangeManager();

 	KeyAgreementTask keyAgreementTask();

--- a/briar-android/src/main/java/org/briarproject/briar/android/AppModule.java
+++ b/briar-android/src/main/java/org/briarproject/briar/android/AppModule.java
@@ -33,6 +33,7 @@ import org.briarproject.bramble.plugin.tor.CircumventionProvider;
 import org.briarproject.bramble.util.AndroidUtils;
 import org.briarproject.bramble.util.StringUtils;
 import org.briarproject.briar.android.account.LockManagerImpl;
+import org.briarproject.briar.android.keyagreement.ContactExchangeModule;
 import org.briarproject.briar.android.viewmodel.ViewModelModule;
 import org.briarproject.briar.api.android.AndroidNotificationManager;
 import org.briarproject.briar.api.android.DozeWatchdog;
@@ -59,7 +60,7 @@ import static java.util.Collections.emptyList;
 import static org.briarproject.bramble.api.reporting.ReportingConstants.DEV_ONION_ADDRESS;
 import static org.briarproject.bramble.api.reporting.ReportingConstants.DEV_PUBLIC_KEY_HEX;

-@Module(includes = ViewModelModule.class)
+@Module(includes = {ContactExchangeModule.class, ViewModelModule.class})
 public class AppModule {

 	static class EagerSingletons {
--- a/briar-android/src/main/java/org/briarproject/briar/android/keyagreement/ContactExchangeActivity.java
+++ b/briar-android/src/main/java/org/briarproject/briar/android/keyagreement/ContactExchangeActivity.java
@@ -1,46 +1,32 @@
 package org.briarproject.briar.android.keyagreement;

+import android.arch.lifecycle.ViewModelProvider;
+import android.arch.lifecycle.ViewModelProviders;
 import android.os.Bundle;
 import android.support.annotation.UiThread;
 import android.widget.Toast;

-import org.briarproject.bramble.api.contact.ContactExchangeTask;
-import org.briarproject.bramble.api.contact.event.ContactExchangeFailedEvent;
-import org.briarproject.bramble.api.contact.event.ContactExchangeSucceededEvent;
-import org.briarproject.bramble.api.db.DbException;
-import org.briarproject.bramble.api.event.Event;
-import org.briarproject.bramble.api.event.EventListener;
 import org.briarproject.bramble.api.identity.Author;
-import org.briarproject.bramble.api.identity.IdentityManager;
-import org.briarproject.bramble.api.identity.LocalAuthor;
 import org.briarproject.bramble.api.keyagreement.KeyAgreementResult;
 import org.briarproject.bramble.api.nullsafety.MethodsNotNullByDefault;
 import org.briarproject.bramble.api.nullsafety.ParametersNotNullByDefault;
 import org.briarproject.briar.R;
 import org.briarproject.briar.android.activity.ActivityComponent;

-import java.util.logging.Logger;
-
 import javax.annotation.Nullable;
 import javax.inject.Inject;

 import static android.widget.Toast.LENGTH_LONG;
-import static java.util.logging.Level.WARNING;
-import static org.briarproject.bramble.util.LogUtils.logException;
+import static java.util.Objects.requireNonNull;

@MethodsNotNullByDefault
@ParametersNotNullByDefault
-public class ContactExchangeActivity extends KeyAgreementActivity implements
-		EventListener {
+public class ContactExchangeActivity extends KeyAgreementActivity {

-	private static final Logger LOG =
-			Logger.getLogger(ContactExchangeActivity.class.getName());
+	@Inject
+	ViewModelProvider.Factory viewModelFactory;

-	// Fields that are accessed from background threads must be volatile
-	@Inject
-	volatile ContactExchangeTask contactExchangeTask;
-	@Inject
-	volatile IdentityManager identityManager;
+	private ContactExchangeViewModel viewModel;

 	@Override
 	public void injectActivity(ActivityComponent component) {
@@ -50,83 +36,50 @@ public class ContactExchangeActivity extends KeyAgreementActivity implements
 	@Override
 	public void onCreate(@Nullable Bundle state) {
 		super.onCreate(state);
-		getSupportActionBar().setTitle(R.string.add_contact_title);
-	}
-
-	@Override
-	public void onStart() {
-		super.onStart();
-		// Listen to updates from contactExchangeTask
-		eventBus.addListener(this);
-	}
-
-	@Override
-	protected void onStop() {
-		super.onStop();
-		// Stop listen to updates from contactExchangeTask
-		eventBus.addListener(this);
+		requireNonNull(getSupportActionBar())
+				.setTitle(R.string.add_contact_title);
+		viewModel = ViewModelProviders.of(this, viewModelFactory)
+				.get(ContactExchangeViewModel.class);
 	}

 	private void startContactExchange(KeyAgreementResult result) {
-		runOnDbThread(() -> {
-			LocalAuthor localAuthor;
-			// Load the local pseudonym
-			try {
-				localAuthor = identityManager.getLocalAuthor();
-			} catch (DbException e) {
-				logException(LOG, WARNING, e);
-				contactExchangeFailed();
-				return;
-			}
-
-			// Exchange contact details
-			contactExchangeTask.startExchange(localAuthor,
-					result.getMasterKey(), result.getConnection(),
-					result.getTransportId(), result.wasAlice());
-		});
-	}
-
-	@Override
-	public void eventOccurred(Event e) {
-		if (e instanceof ContactExchangeSucceededEvent) {
-			contactExchangeSucceeded(
-					((ContactExchangeSucceededEvent) e).getRemoteAuthor());
-		} else if (e instanceof ContactExchangeFailedEvent) {
-			ContactExchangeFailedEvent fe = (ContactExchangeFailedEvent) e;
-			if (fe.wasDuplicateContact()) {
-				duplicateContact(fe.getDuplicateRemoteAuthor());
+		viewModel.getSucceeded().observe(this, succeeded -> {
+			if (succeeded == null) return;
+			if (succeeded) {
+				Author remote = requireNonNull(viewModel.getRemoteAuthor());
+				contactExchangeSucceeded(remote);
 			} else {
-				contactExchangeFailed();
+				Author duplicate = viewModel.getDuplicateAuthor();
+				if (duplicate == null) contactExchangeFailed();
+				else duplicateContact(duplicate);
 			}
-		}
+		});
+		viewModel.startContactExchange(result.getTransportId(),
+				result.getConnection(), result.getMasterKey(),
+				result.wasAlice());
 	}

+	@UiThread
 	private void contactExchangeSucceeded(Author remoteAuthor) {
-		runOnUiThreadUnlessDestroyed(() -> {
-			String contactName = remoteAuthor.getName();
-			String format = getString(R.string.contact_added_toast);
-			String text = String.format(format, contactName);
-			Toast.makeText(ContactExchangeActivity.this, text, LENGTH_LONG)
-					.show();
-			supportFinishAfterTransition();
-		});
+		String contactName = remoteAuthor.getName();
+		String format = getString(R.string.contact_added_toast);
+		String text = String.format(format, contactName);
+		Toast.makeText(this, text, LENGTH_LONG).show();
+		supportFinishAfterTransition();
 	}

+	@UiThread
 	private void duplicateContact(Author remoteAuthor) {
-		runOnUiThreadUnlessDestroyed(() -> {
-			String contactName = remoteAuthor.getName();
-			String format = getString(R.string.contact_already_exists);
-			String text = String.format(format, contactName);
-			Toast.makeText(ContactExchangeActivity.this, text, LENGTH_LONG)
-					.show();
-			finish();
-		});
+		String contactName = remoteAuthor.getName();
+		String format = getString(R.string.contact_already_exists);
+		String text = String.format(format, contactName);
+		Toast.makeText(this, text, LENGTH_LONG).show();
+		finish();
 	}

+	@UiThread
 	private void contactExchangeFailed() {
-		runOnUiThreadUnlessDestroyed(() -> {
-			showErrorFragment(R.string.connection_error_explanation);
-		});
+		showErrorFragment(R.string.connection_error_explanation);
 	}

 	@UiThread
--- a/briar-android/src/main/java/org/briarproject/briar/android/keyagreement/ContactExchangeModule.java
+++ b/briar-android/src/main/java/org/briarproject/briar/android/keyagreement/ContactExchangeModule.java
@@ -0,0 +1,20 @@
+package org.briarproject.briar.android.keyagreement;
+
+import android.arch.lifecycle.ViewModel;
+
+import org.briarproject.briar.android.viewmodel.ViewModelKey;
+
+import dagger.Binds;
+import dagger.Module;
+import dagger.multibindings.IntoMap;
+
+@Module
+public abstract class ContactExchangeModule {
+
+	@Binds
+	@IntoMap
+	@ViewModelKey(ContactExchangeViewModel.class)
+	abstract ViewModel bindContactExchangeViewModel(
+			ContactExchangeViewModel contactExchangeViewModel);
+
+}
--- a/briar-android/src/main/java/org/briarproject/briar/android/keyagreement/ContactExchangeViewModel.java
+++ b/briar-android/src/main/java/org/briarproject/briar/android/keyagreement/ContactExchangeViewModel.java
@@ -0,0 +1,104 @@
+package org.briarproject.briar.android.keyagreement;
+
+import android.app.Application;
+import android.arch.lifecycle.AndroidViewModel;
+import android.arch.lifecycle.LiveData;
+import android.arch.lifecycle.MutableLiveData;
+import android.support.annotation.UiThread;
+
+import org.briarproject.bramble.api.contact.Contact;
+import org.briarproject.bramble.api.contact.ContactExchangeManager;
+import org.briarproject.bramble.api.crypto.SecretKey;
+import org.briarproject.bramble.api.db.ContactExistsException;
+import org.briarproject.bramble.api.db.DbException;
+import org.briarproject.bramble.api.identity.Author;
+import org.briarproject.bramble.api.lifecycle.IoExecutor;
+import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
+import org.briarproject.bramble.api.plugin.ConnectionManager;
+import org.briarproject.bramble.api.plugin.TransportId;
+import org.briarproject.bramble.api.plugin.duplex.DuplexTransportConnection;
+
+import java.io.IOException;
+import java.util.concurrent.Executor;
+import java.util.logging.Logger;
+
+import javax.annotation.Nullable;
+import javax.inject.Inject;
+
+import static java.util.logging.Level.WARNING;
+import static java.util.logging.Logger.getLogger;
+import static org.briarproject.bramble.util.LogUtils.logException;
+
+@NotNullByDefault
+class ContactExchangeViewModel extends AndroidViewModel {
+
+	private static final Logger LOG =
+			getLogger(ContactExchangeViewModel.class.getName());
+
+	private final Executor ioExecutor;
+	private final ContactExchangeManager contactExchangeManager;
+	private final ConnectionManager connectionManager;
+	private final MutableLiveData<Boolean> succeeded = new MutableLiveData<>();
+
+	@Nullable
+	private volatile Author remoteAuthor, duplicateAuthor;
+
+	@Inject
+	ContactExchangeViewModel(Application app, @IoExecutor Executor ioExecutor,
+			ContactExchangeManager contactExchangeManager,
+			ConnectionManager connectionManager) {
+		super(app);
+		this.ioExecutor = ioExecutor;
+		this.contactExchangeManager = contactExchangeManager;
+		this.connectionManager = connectionManager;
+	}
+
+	@UiThread
+	void startContactExchange(TransportId t, DuplexTransportConnection conn,
+			SecretKey masterKey, boolean alice) {
+		ioExecutor.execute(() -> {
+			try {
+				Contact contact = contactExchangeManager.exchangeContacts(t,
+						conn, masterKey, alice);
+				// Reuse the connection as a transport connection
+				connectionManager.manageOutgoingConnection(contact.getId(),
+						t, conn);
+				remoteAuthor = contact.getAuthor();
+				succeeded.postValue(true);
+			} catch (ContactExistsException e) {
+				tryToClose(conn);
+				duplicateAuthor = e.getRemoteAuthor();
+				succeeded.postValue(false);
+			} catch (DbException | IOException e) {
+				tryToClose(conn);
+				logException(LOG, WARNING, e);
+				succeeded.postValue(false);
+			}
+		});
+	}
+
+	private void tryToClose(DuplexTransportConnection conn) {
+		try {
+			conn.getReader().dispose(true, true);
+			conn.getWriter().dispose(true);
+		} catch (IOException e) {
+			logException(LOG, WARNING, e);
+		}
+	}
+
+	@UiThread
+	@Nullable
+	Author getRemoteAuthor() {
+		return remoteAuthor;
+	}
+
+	@UiThread
+	@Nullable
+	Author getDuplicateAuthor() {
+		return duplicateAuthor;
+	}
+
+	LiveData<Boolean> getSucceeded() {
+		return succeeded;
+	}
+}
--- a/briar-android/src/main/java/org/briarproject/briar/android/viewmodel/ViewModelKey.java
+++ b/briar-android/src/main/java/org/briarproject/briar/android/viewmodel/ViewModelKey.java
@@ -14,6 +14,6 @@ import dagger.MapKey;
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@MapKey
-@interface ViewModelKey {
+public @interface ViewModelKey {
 	Class<? extends ViewModel> value();
 }