Hook up message backup restore flow to reg v2.

Co-authored-by: Nicholas Tinsley <nicholas@signal.org>
2026-04-27 04:04:43 +01:00 · 2024-06-05 16:54:09 -04:00
parent 26bd59c378
commit 66c50bef44
38 changed files with 1314 additions and 242 deletions
--- a/app/src/main/java/org/thoughtcrime/securesms/registration/v2/ui/RegistrationV2Activity.kt
+++ b/app/src/main/java/org/thoughtcrime/securesms/registration/v2/ui/RegistrationV2Activity.kt
@@ -23,7 +23,9 @@ import org.thoughtcrime.securesms.profiles.AvatarHelper
 import org.thoughtcrime.securesms.profiles.edit.CreateProfileActivity
 import org.thoughtcrime.securesms.recipients.Recipient
 import org.thoughtcrime.securesms.registration.SmsRetrieverReceiver
+import org.thoughtcrime.securesms.registration.v2.ui.restore.RemoteRestoreActivity
 import org.thoughtcrime.securesms.util.DynamicNoActionBarTheme
+import org.thoughtcrime.securesms.util.FeatureFlags

 /**
 * Activity to hold the entire registration process.
@@ -76,8 +78,6 @@ class RegistrationV2Activity : BaseActivity() {

      Log.i(TAG, "Pin restore flow not required. Profile name: $isProfileNameEmpty | Profile avatar: $isAvatarEmpty | Needs PIN: $needsPin")

-      SignalStore.internalValues().setForceEnterRestoreV2Flow(true)
-
      if (!needsProfile && !needsPin) {
        sharedViewModel.completeRegistration()
      }
@@ -86,9 +86,9 @@ class RegistrationV2Activity : BaseActivity() {
      val startIntent = MainActivity.clearTop(this).apply {
        if (needsPin) {
          putExtra("next_intent", CreateSvrPinActivity.getIntentForPinCreate(this@RegistrationV2Activity))
-        }
-
-        if (needsProfile) {
+        } else if (!SignalStore.registrationValues().hasSkippedTransferOrRestore() && FeatureFlags.messageBackups()) {
+          putExtra("next_intent", RemoteRestoreActivity.getIntent(this@RegistrationV2Activity))
+        } else if (needsProfile) {
          putExtra("next_intent", CreateProfileActivity.getIntentForUserProfile(this@RegistrationV2Activity))
        }
      }
--- a/app/src/main/java/org/thoughtcrime/securesms/registration/v2/ui/RegistrationV2ViewModel.kt
+++ b/app/src/main/java/org/thoughtcrime/securesms/registration/v2/ui/RegistrationV2ViewModel.kt
@@ -22,6 +22,7 @@ import kotlinx.coroutines.withContext
 import org.signal.core.util.Stopwatch
 import org.signal.core.util.isNotNullOrBlank
 import org.signal.core.util.logging.Log
+import org.thoughtcrime.securesms.backup.v2.BackupRepository
 import org.thoughtcrime.securesms.dependencies.AppDependencies
 import org.thoughtcrime.securesms.jobs.MultiDeviceProfileContentUpdateJob
 import org.thoughtcrime.securesms.jobs.MultiDeviceProfileKeyUpdateJob
@@ -748,6 +749,8 @@ class RegistrationV2ViewModel : ViewModel() {
    Log.v(TAG, "onSuccessfulRegistration()")
    RegistrationRepository.registerAccountLocally(context, registrationData, remoteResult, reglockEnabled)

+    restoreBackupTier()
+
    if (reglockEnabled) {
      SignalStore.onboarding().clearAll()
      val stopwatch = Stopwatch("RegistrationLockRestore")
@@ -838,6 +841,12 @@ class RegistrationV2ViewModel : ViewModel() {
  companion object {
    private val TAG = Log.tag(RegistrationV2ViewModel::class.java)

+    private suspend fun restoreBackupTier() = withContext(Dispatchers.IO) {
+      val startTime = System.currentTimeMillis()
+      BackupRepository.restoreBackupTier()
+      Log.i(TAG, "Took " + (System.currentTimeMillis() - startTime) + " ms to restore the backup tier..")
+    }
+
    private suspend fun refreshFeatureFlags() = withContext(Dispatchers.IO) {
      val startTime = System.currentTimeMillis()
      try {
--- a/app/src/main/java/org/thoughtcrime/securesms/registration/v2/ui/grantpermissions/GrantPermissionsV2Fragment.kt
+++ b/app/src/main/java/org/thoughtcrime/securesms/registration/v2/ui/grantpermissions/GrantPermissionsV2Fragment.kt
@@ -104,7 +104,7 @@ class GrantPermissionsV2Fragment : ComposeFragment() {
    when (welcomeAction) {
      WelcomeAction.CONTINUE -> findNavController().safeNavigate(GrantPermissionsV2FragmentDirections.actionEnterPhoneNumber())
      WelcomeAction.RESTORE_BACKUP -> {
-        val restoreIntent = RestoreActivity.getIntentForRestore(requireActivity())
+        val restoreIntent = RestoreActivity.getIntentForTransferOrRestore(requireActivity())
        launchRestoreActivity.launch(restoreIntent)
      }
    }
--- a/app/src/main/java/org/thoughtcrime/securesms/registration/v2/ui/restore/RemoteRestoreActivity.kt
+++ b/app/src/main/java/org/thoughtcrime/securesms/registration/v2/ui/restore/RemoteRestoreActivity.kt
@@ -0,0 +1,364 @@
+/*
+ * Copyright 2024 Signal Messenger, LLC
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+package org.thoughtcrime.securesms.registration.v2.ui.restore
+
+import android.content.Context
+import android.content.Intent
+import android.os.Bundle
+import androidx.activity.compose.setContent
+import androidx.activity.viewModels
+import androidx.compose.foundation.background
+import androidx.compose.foundation.layout.Box
+import androidx.compose.foundation.layout.Column
+import androidx.compose.foundation.layout.Spacer
+import androidx.compose.foundation.layout.fillMaxWidth
+import androidx.compose.foundation.layout.height
+import androidx.compose.foundation.layout.padding
+import androidx.compose.foundation.layout.width
+import androidx.compose.foundation.layout.wrapContentSize
+import androidx.compose.foundation.shape.RoundedCornerShape
+import androidx.compose.material3.CircularProgressIndicator
+import androidx.compose.material3.MaterialTheme
+import androidx.compose.material3.Surface
+import androidx.compose.material3.Text
+import androidx.compose.material3.TextButton
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.SideEffect
+import androidx.compose.runtime.getValue
+import androidx.compose.ui.Alignment
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.res.dimensionResource
+import androidx.compose.ui.res.stringResource
+import androidx.compose.ui.text.SpanStyle
+import androidx.compose.ui.text.buildAnnotatedString
+import androidx.compose.ui.text.font.FontWeight
+import androidx.compose.ui.text.style.TextAlign
+import androidx.compose.ui.text.withStyle
+import androidx.compose.ui.tooling.preview.Preview
+import androidx.compose.ui.unit.dp
+import kotlinx.collections.immutable.ImmutableList
+import kotlinx.collections.immutable.persistentListOf
+import org.greenrobot.eventbus.EventBus
+import org.greenrobot.eventbus.Subscribe
+import org.greenrobot.eventbus.ThreadMode
+import org.signal.core.ui.Buttons
+import org.signal.core.ui.Previews
+import org.signal.core.ui.theme.SignalTheme
+import org.thoughtcrime.securesms.BaseActivity
+import org.thoughtcrime.securesms.MainActivity
+import org.thoughtcrime.securesms.R
+import org.thoughtcrime.securesms.backup.v2.MessageBackupTier
+import org.thoughtcrime.securesms.backup.v2.RestoreV2Event
+import org.thoughtcrime.securesms.backup.v2.ui.subscription.MessageBackupsTypeFeature
+import org.thoughtcrime.securesms.backup.v2.ui.subscription.MessageBackupsTypeFeatureRow
+import org.thoughtcrime.securesms.backup.v2.ui.subscription.RemoteRestoreViewModel
+import org.thoughtcrime.securesms.conversation.v2.registerForLifecycle
+import org.thoughtcrime.securesms.dependencies.AppDependencies
+import org.thoughtcrime.securesms.jobs.ProfileUploadJob
+import org.thoughtcrime.securesms.profiles.AvatarHelper
+import org.thoughtcrime.securesms.profiles.edit.CreateProfileActivity
+import org.thoughtcrime.securesms.recipients.Recipient
+import org.thoughtcrime.securesms.registration.RegistrationUtil
+import org.thoughtcrime.securesms.restore.transferorrestore.TransferOrRestoreMoreOptionsDialog
+import org.thoughtcrime.securesms.util.Util
+
+class RemoteRestoreActivity : BaseActivity() {
+  companion object {
+    fun getIntent(context: Context): Intent {
+      return Intent(context, RemoteRestoreActivity::class.java)
+    }
+  }
+
+  private val viewModel: RemoteRestoreViewModel by viewModels()
+
+  override fun onCreate(savedInstanceState: Bundle?) {
+    super.onCreate(savedInstanceState)
+
+    setContent {
+      val state by viewModel.state
+      SignalTheme {
+        Surface {
+          RestoreFromBackupContent(
+            features = getFeatureList(state.backupTier),
+            onRestoreBackupClick = {
+              viewModel.restore()
+            },
+            onCancelClick = {
+              finish()
+            },
+            onMoreOptionsClick = {
+              TransferOrRestoreMoreOptionsDialog.show(fragmentManager = supportFragmentManager, skipOnly = false)
+            },
+            state.backupTier,
+            state.backupTier != MessageBackupTier.PAID
+          )
+          if (state.importState == RemoteRestoreViewModel.ImportState.RESTORED) {
+            SideEffect {
+              RegistrationUtil.maybeMarkRegistrationComplete()
+              AppDependencies.jobManager.add(ProfileUploadJob())
+              startActivity(MainActivity.clearTop(this))
+            }
+          } else if (state.importState == RemoteRestoreViewModel.ImportState.IN_PROGRESS) {
+            ProgressDialog(state.restoreProgress)
+          }
+        }
+      }
+    }
+    EventBus.getDefault().registerForLifecycle(subscriber = this, lifecycleOwner = this)
+  }
+
+  @Subscribe(threadMode = ThreadMode.MAIN)
+  fun onEvent(restoreEvent: RestoreV2Event) {
+    viewModel.updateRestoreProgress(restoreEvent)
+  }
+
+  private fun getFeatureList(tier: MessageBackupTier?): ImmutableList<MessageBackupsTypeFeature> {
+    return when (tier) {
+      null -> persistentListOf()
+      MessageBackupTier.PAID -> {
+        persistentListOf(
+          MessageBackupsTypeFeature(
+            iconResourceId = R.drawable.symbol_thread_compact_bold_16,
+            label = "All of your media"
+          ),
+          MessageBackupsTypeFeature(
+            iconResourceId = R.drawable.symbol_recent_compact_bold_16,
+            label = "All of your text messages"
+          )
+        )
+      }
+      MessageBackupTier.FREE -> {
+        persistentListOf(
+          MessageBackupsTypeFeature(
+            iconResourceId = R.drawable.symbol_thread_compact_bold_16,
+            label = "Your last 30 days of media"
+          ),
+          MessageBackupsTypeFeature(
+            iconResourceId = R.drawable.symbol_recent_compact_bold_16,
+            label = "All of your text messages"
+          )
+        )
+      }
+    }
+  }
+
+  /**
+   * A dialog that *just* shows a spinner. Useful for short actions where you need to
+   * let the user know that some action is completing.
+   */
+  @Composable
+  fun ProgressDialog(restoreProgress: RestoreV2Event?) {
+    androidx.compose.material3.AlertDialog(
+      onDismissRequest = {},
+      confirmButton = {},
+      dismissButton = {},
+      text = {
+        Box(
+          contentAlignment = Alignment.Center,
+          modifier = Modifier
+            .fillMaxWidth()
+        ) {
+          Column(
+            horizontalAlignment = Alignment.CenterHorizontally,
+            modifier = Modifier.wrapContentSize()
+          ) {
+            if (restoreProgress == null) {
+              CircularProgressIndicator(
+                modifier = Modifier
+                  .padding(top = 55.dp, bottom = 16.dp)
+                  .width(48.dp)
+                  .height(48.dp)
+              )
+            } else {
+              CircularProgressIndicator(
+                progress = restoreProgress.getProgress(),
+                modifier = Modifier
+                  .padding(top = 55.dp, bottom = 16.dp)
+                  .width(48.dp)
+                  .height(48.dp)
+              )
+            }
+
+            // TODO [message-backups] Finalized copy.
+            val progressText = when (restoreProgress?.type) {
+              RestoreV2Event.Type.PROGRESS_DOWNLOAD -> "Downloading backup..."
+              RestoreV2Event.Type.PROGRESS_RESTORE -> "Restoring messages..."
+              else -> "Restoring..."
+            }
+
+            Text(
+              text = progressText,
+              style = MaterialTheme.typography.bodyMedium,
+              modifier = Modifier.padding(bottom = 12.dp)
+            )
+
+            if (restoreProgress != null) {
+              val progressBytes = Util.getPrettyFileSize(restoreProgress.count)
+              val totalBytes = Util.getPrettyFileSize(restoreProgress.estimatedTotalCount)
+              Text(
+                text = "$progressBytes of $totalBytes (%.2f%%)".format(restoreProgress.getProgress()),
+                style = MaterialTheme.typography.bodySmall,
+                modifier = Modifier.padding(bottom = 12.dp)
+              )
+            }
+          }
+        }
+      },
+      modifier = Modifier.width(212.dp)
+    )
+  }
+
+  @Preview
+  @Composable
+  private fun ProgressDialogPreview() {
+    Previews.Preview {
+      ProgressDialog(RestoreV2Event(RestoreV2Event.Type.PROGRESS_RESTORE, 10, 1000))
+    }
+  }
+
+  @Preview
+  @Composable
+  private fun RestoreFromBackupContentPreview() {
+    Previews.Preview {
+      RestoreFromBackupContent(
+        features = persistentListOf(
+          MessageBackupsTypeFeature(
+            iconResourceId = R.drawable.symbol_thread_compact_bold_16,
+            label = "Your last 30 days of media"
+          ),
+          MessageBackupsTypeFeature(
+            iconResourceId = R.drawable.symbol_recent_compact_bold_16,
+            label = "All of your text messages"
+          )
+        ),
+        onRestoreBackupClick = {},
+        onCancelClick = {},
+        onMoreOptionsClick = {},
+        MessageBackupTier.PAID,
+        true
+      )
+    }
+  }
+
+  @Composable
+  private fun RestoreFromBackupContent(
+    features: ImmutableList<MessageBackupsTypeFeature>,
+    onRestoreBackupClick: () -> Unit,
+    onCancelClick: () -> Unit,
+    onMoreOptionsClick: () -> Unit,
+    tier: MessageBackupTier?,
+    cancelable: Boolean
+  ) {
+    Column(
+      modifier = Modifier
+        .padding(horizontal = dimensionResource(id = R.dimen.core_ui__gutter))
+        .padding(top = 40.dp, bottom = 24.dp)
+    ) {
+      Text(
+        text = "Restore from backup", // TODO [message-backups] Finalized copy.
+        style = MaterialTheme.typography.headlineMedium,
+        modifier = Modifier.padding(bottom = 12.dp)
+      )
+
+      val yourLastBackupText = buildAnnotatedString {
+        append("Your last backup was made on March 5, 2024 at 9:00am.") // TODO [message-backups] Finalized copy.
+        append(" ")
+        if (tier != MessageBackupTier.PAID) {
+          withStyle(SpanStyle(fontWeight = FontWeight.SemiBold)) {
+            append("Only media sent or received in the past 30 days is included.") // TODO [message-backups] Finalized copy.
+          }
+        }
+      }
+
+      Text(
+        text = yourLastBackupText,
+        style = MaterialTheme.typography.bodyLarge,
+        color = MaterialTheme.colorScheme.onSurfaceVariant,
+        modifier = Modifier.padding(bottom = 28.dp)
+      )
+
+      Column(
+        modifier = Modifier
+          .fillMaxWidth()
+          .background(color = SignalTheme.colors.colorSurface2, shape = RoundedCornerShape(18.dp))
+          .padding(horizontal = 20.dp)
+          .padding(top = 20.dp, bottom = 18.dp)
+      ) {
+        Text(
+          text = "Your backup includes:", // TODO [message-backups] Finalized copy.
+          style = MaterialTheme.typography.titleMedium,
+          modifier = Modifier.padding(bottom = 6.dp)
+        )
+
+        features.forEach {
+          MessageBackupsTypeFeatureRow(
+            messageBackupsTypeFeature = it,
+            iconTint = MaterialTheme.colorScheme.primary,
+            modifier = Modifier.padding(start = 16.dp, top = 6.dp)
+          )
+        }
+      }
+
+      Spacer(modifier = Modifier.weight(1f))
+
+      Buttons.LargeTonal(
+        onClick = onRestoreBackupClick,
+        modifier = Modifier.fillMaxWidth()
+      ) {
+        Text(
+          text = "Restore backup" // TODO [message-backups] Finalized copy.
+        )
+      }
+
+      if (cancelable) {
+        TextButton(
+          onClick = onCancelClick,
+          modifier = Modifier.fillMaxWidth()
+        ) {
+          Text(
+            text = stringResource(id = android.R.string.cancel)
+          )
+        }
+      } else {
+        TextButton(
+          onClick = onMoreOptionsClick,
+          modifier = Modifier.fillMaxWidth()
+        ) {
+          Text(
+            text = stringResource(id = R.string.TransferOrRestoreFragment__more_options)
+          )
+        }
+      }
+    }
+  }
+
+  private fun restoreFromServer() {
+    viewModel.restore()
+  }
+
+  private fun continueRegistration() {
+    if (Recipient.self().profileName.isEmpty || !AvatarHelper.hasAvatar(this, Recipient.self().id)) {
+      val main = MainActivity.clearTop(this)
+      val profile = CreateProfileActivity.getIntentForUserProfile(this)
+      profile.putExtra("next_intent", main)
+      startActivity(profile)
+    } else {
+      RegistrationUtil.maybeMarkRegistrationComplete()
+      AppDependencies.jobManager.add(ProfileUploadJob())
+      startActivity(MainActivity.clearTop(this))
+    }
+    finish()
+  }
+
+  @Composable
+  private fun StateLabel(text: String) {
+    Text(
+      text = text,
+      style = MaterialTheme.typography.labelSmall,
+      textAlign = TextAlign.Center
+    )
+  }
+}
--- a/app/src/main/java/org/thoughtcrime/securesms/registration/v2/ui/welcome/WelcomeV2Fragment.kt
+++ b/app/src/main/java/org/thoughtcrime/securesms/registration/v2/ui/welcome/WelcomeV2Fragment.kt
@@ -28,8 +28,10 @@ import org.thoughtcrime.securesms.registration.v2.ui.grantpermissions.GrantPermi
 import org.thoughtcrime.securesms.restore.RestoreActivity
 import org.thoughtcrime.securesms.util.BackupUtil
 import org.thoughtcrime.securesms.util.CommunicationActions
+import org.thoughtcrime.securesms.util.FeatureFlags
 import org.thoughtcrime.securesms.util.TextSecurePreferences
 import org.thoughtcrime.securesms.util.navigation.safeNavigate
+import org.thoughtcrime.securesms.util.visible

 /**
 * First screen that is displayed on the very first app launch.
@@ -59,6 +61,7 @@ class WelcomeV2Fragment : LoggingFragment(R.layout.fragment_registration_welcome
    binding.welcomeContinueButton.setOnClickListener { onContinueClicked() }
    binding.welcomeTermsButton.setOnClickListener { onTermsClicked() }
    binding.welcomeTransferOrRestore.setOnClickListener { onTransferOrRestoreClicked() }
+    binding.welcomeTransferOrRestore.visible = !FeatureFlags.restoreAfterRegistration()
  }

  private fun onContinueClicked() {
@@ -86,7 +89,7 @@ class WelcomeV2Fragment : LoggingFragment(R.layout.fragment_registration_welcome
    } else {
      sharedViewModel.setRegistrationCheckpoint(RegistrationCheckpoint.PERMISSIONS_GRANTED)

-      val restoreIntent = RestoreActivity.getIntentForRestore(requireActivity())
+      val restoreIntent = RestoreActivity.getIntentForTransferOrRestore(requireActivity())
      launchRestoreActivity.launch(restoreIntent)
    }
  }