Add initial support for backup and restore of message and media to staging.

Co-authored-by: Cody Henthorne <cody@signal.org>
2026-04-20 00:29:11 +01:00 · 2024-04-12 11:57:34 -04:00
parent 8617a074ad
commit 689eacd618
71 changed files with 3198 additions and 744 deletions
--- a/app/src/main/java/org/thoughtcrime/securesms/attachments/ArchivedAttachment.kt
+++ b/app/src/main/java/org/thoughtcrime/securesms/attachments/ArchivedAttachment.kt
@@ -0,0 +1,88 @@
+/*
+ * Copyright 2024 Signal Messenger, LLC
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+package org.thoughtcrime.securesms.attachments
+
+import android.net.Uri
+import android.os.Parcel
+import org.signal.core.util.Base64
+import org.thoughtcrime.securesms.blurhash.BlurHash
+import org.thoughtcrime.securesms.database.AttachmentTable
+
+class ArchivedAttachment : Attachment {
+
+  @JvmField
+  val archiveCdn: Int
+
+  @JvmField
+  val archiveMediaName: String
+
+  @JvmField
+  val archiveMediaId: String
+
+  constructor(
+    contentType: String?,
+    size: Long,
+    cdn: Cdn,
+    cdnKey: ByteArray,
+    archiveMediaName: String,
+    archiveMediaId: String,
+    digest: ByteArray,
+    incrementalMac: ByteArray?,
+    incrementalMacChunkSize: Int?,
+    width: Int?,
+    height: Int?,
+    caption: String?,
+    blurHash: String?,
+    voiceNote: Boolean,
+    borderless: Boolean,
+    gif: Boolean,
+    quote: Boolean
+  ) : super(
+    contentType = contentType ?: "",
+    quote = quote,
+    transferState = AttachmentTable.TRANSFER_NEEDS_RESTORE,
+    size = size,
+    fileName = null,
+    cdn = cdn,
+    remoteLocation = null,
+    remoteKey = Base64.encodeWithoutPadding(cdnKey),
+    remoteDigest = digest,
+    incrementalDigest = incrementalMac,
+    fastPreflightId = null,
+    voiceNote = voiceNote,
+    borderless = borderless,
+    videoGif = gif,
+    width = width ?: 0,
+    height = height ?: 0,
+    incrementalMacChunkSize = incrementalMacChunkSize ?: 0,
+    uploadTimestamp = 0,
+    caption = caption,
+    stickerLocator = null,
+    blurHash = BlurHash.parseOrNull(blurHash),
+    audioHash = null,
+    transformProperties = null
+  ) {
+    this.archiveCdn = cdn.cdnNumber
+    this.archiveMediaName = archiveMediaName
+    this.archiveMediaId = archiveMediaId
+  }
+
+  constructor(parcel: Parcel) : super(parcel) {
+    archiveCdn = parcel.readInt()
+    archiveMediaName = parcel.readString()!!
+    archiveMediaId = parcel.readString()!!
+  }
+
+  override fun writeToParcel(dest: Parcel, flags: Int) {
+    super.writeToParcel(dest, flags)
+    dest.writeInt(archiveCdn)
+    dest.writeString(archiveMediaName)
+    dest.writeString(archiveMediaId)
+  }
+
+  override val uri: Uri? = null
+  override val publicUri: Uri? = null
+}
--- a/app/src/main/java/org/thoughtcrime/securesms/attachments/Attachment.kt
+++ b/app/src/main/java/org/thoughtcrime/securesms/attachments/Attachment.kt
@@ -29,7 +29,7 @@ abstract class Attachment(
  @JvmField
  val fileName: String?,
  @JvmField
-  val cdnNumber: Int,
+  val cdn: Cdn,
  @JvmField
  val remoteLocation: String?,
  @JvmField
@@ -76,7 +76,7 @@ abstract class Attachment(
    transferState = parcel.readInt(),
    size = parcel.readLong(),
    fileName = parcel.readString(),
-    cdnNumber = parcel.readInt(),
+    cdn = Cdn.deserialize(parcel.readInt()),
    remoteLocation = parcel.readString(),
    remoteKey = parcel.readString(),
    remoteDigest = ParcelUtil.readByteArray(parcel),
@@ -103,7 +103,7 @@ abstract class Attachment(
    dest.writeInt(transferState)
    dest.writeLong(size)
    dest.writeString(fileName)
-    dest.writeInt(cdnNumber)
+    dest.writeInt(cdn.serialize())
    dest.writeString(remoteLocation)
    dest.writeString(remoteKey)
    ParcelUtil.writeByteArray(dest, remoteDigest)
--- a/app/src/main/java/org/thoughtcrime/securesms/attachments/AttachmentCreator.kt
+++ b/app/src/main/java/org/thoughtcrime/securesms/attachments/AttachmentCreator.kt
@@ -17,7 +17,8 @@ object AttachmentCreator : Parcelable.Creator<Attachment> {
    DATABASE(DatabaseAttachment::class.java, "database"),
    POINTER(PointerAttachment::class.java, "pointer"),
    TOMBSTONE(TombstoneAttachment::class.java, "tombstone"),
-    URI(UriAttachment::class.java, "uri")
+    URI(UriAttachment::class.java, "uri"),
+    ARCHIVED(ArchivedAttachment::class.java, "archived")
  }

  @JvmStatic
@@ -34,6 +35,7 @@ object AttachmentCreator : Parcelable.Creator<Attachment> {
      Subclass.POINTER -> PointerAttachment(source)
      Subclass.TOMBSTONE -> TombstoneAttachment(source)
      Subclass.URI -> UriAttachment(source)
+      Subclass.ARCHIVED -> ArchivedAttachment(source)
    }
  }

--- a/app/src/main/java/org/thoughtcrime/securesms/attachments/Cdn.kt
+++ b/app/src/main/java/org/thoughtcrime/securesms/attachments/Cdn.kt
@@ -0,0 +1,53 @@
+/*
+ * Copyright 2024 Signal Messenger, LLC
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+package org.thoughtcrime.securesms.attachments
+
+import org.signal.core.util.IntSerializer
+
+/**
+ * Attachments/media can come from and go to multiple CDN locations depending on when and where
+ * they were uploaded. This class represents the CDNs where attachments/media can live.
+ */
+enum class Cdn(private val value: Int) {
+  S3(-1),
+  CDN_0(0),
+  CDN_2(2),
+  CDN_3(3);
+
+  val cdnNumber: Int
+    get() {
+      return when (this) {
+        S3 -> -1
+        CDN_0 -> 0
+        CDN_2 -> 2
+        CDN_3 -> 3
+      }
+    }
+
+  fun serialize(): Int {
+    return Serializer.serialize(this)
+  }
+
+  companion object Serializer : IntSerializer<Cdn> {
+    override fun serialize(data: Cdn): Int {
+      return data.value
+    }
+
+    override fun deserialize(data: Int): Cdn {
+      return values().first { it.value == data }
+    }
+
+    fun fromCdnNumber(cdnNumber: Int): Cdn {
+      return when (cdnNumber) {
+        -1 -> S3
+        0 -> CDN_0
+        2 -> CDN_2
+        3 -> CDN_3
+        else -> throw UnsupportedOperationException()
+      }
+    }
+  }
+}
--- a/app/src/main/java/org/thoughtcrime/securesms/attachments/DatabaseAttachment.kt
+++ b/app/src/main/java/org/thoughtcrime/securesms/attachments/DatabaseAttachment.kt
@@ -25,6 +25,15 @@ class DatabaseAttachment : Attachment {
  @JvmField
  val dataHash: String?

+  @JvmField
+  val archiveCdn: Int
+
+  @JvmField
+  val archiveMediaName: String?
+
+  @JvmField
+  val archiveMediaId: String?
+
  private val hasThumbnail: Boolean
  val displayOrder: Int

@@ -37,7 +46,7 @@ class DatabaseAttachment : Attachment {
    transferProgress: Int,
    size: Long,
    fileName: String?,
-    cdnNumber: Int,
+    cdn: Cdn,
    location: String?,
    key: String?,
    digest: ByteArray?,
@@ -57,13 +66,16 @@ class DatabaseAttachment : Attachment {
    transformProperties: TransformProperties?,
    displayOrder: Int,
    uploadTimestamp: Long,
-    dataHash: String?
+    dataHash: String?,
+    archiveCdn: Int,
+    archiveMediaName: String?,
+    archiveMediaId: String?
  ) : super(
    contentType = contentType!!,
    transferState = transferProgress,
    size = size,
    fileName = fileName,
-    cdnNumber = cdnNumber,
+    cdn = cdn,
    remoteLocation = location,
    remoteKey = key,
    remoteDigest = digest,
@@ -88,6 +100,9 @@ class DatabaseAttachment : Attachment {
    this.dataHash = dataHash
    this.hasThumbnail = hasThumbnail
    this.displayOrder = displayOrder
+    this.archiveCdn = archiveCdn
+    this.archiveMediaName = archiveMediaName
+    this.archiveMediaId = archiveMediaId
  }

  constructor(parcel: Parcel) : super(parcel) {
@@ -97,6 +112,9 @@ class DatabaseAttachment : Attachment {
    hasThumbnail = ParcelUtil.readBoolean(parcel)
    mmsId = parcel.readLong()
    displayOrder = parcel.readInt()
+    archiveCdn = parcel.readInt()
+    archiveMediaName = parcel.readString()
+    archiveMediaId = parcel.readString()
  }

  override fun writeToParcel(dest: Parcel, flags: Int) {
@@ -107,6 +125,9 @@ class DatabaseAttachment : Attachment {
    ParcelUtil.writeBoolean(dest, hasThumbnail)
    dest.writeLong(mmsId)
    dest.writeInt(displayOrder)
+    dest.writeInt(archiveCdn)
+    dest.writeString(archiveMediaName)
+    dest.writeString(archiveMediaId)
  }

  override val uri: Uri?
--- a/app/src/main/java/org/thoughtcrime/securesms/attachments/PointerAttachment.kt
+++ b/app/src/main/java/org/thoughtcrime/securesms/attachments/PointerAttachment.kt
@@ -9,7 +9,6 @@ import org.thoughtcrime.securesms.database.AttachmentTable
 import org.thoughtcrime.securesms.stickers.StickerLocator
 import org.whispersystems.signalservice.api.InvalidMessageStructureException
 import org.whispersystems.signalservice.api.messages.SignalServiceAttachment
-import org.whispersystems.signalservice.api.messages.SignalServiceDataMessage
 import org.whispersystems.signalservice.api.util.AttachmentPointerUtil
 import org.whispersystems.signalservice.internal.push.DataMessage
 import java.util.Optional
@@ -21,7 +20,7 @@ class PointerAttachment : Attachment {
    transferState: Int,
    size: Long,
    fileName: String?,
-    cdnNumber: Int,
+    cdn: Cdn,
    location: String,
    key: String?,
    digest: ByteArray?,
@@ -42,7 +41,7 @@ class PointerAttachment : Attachment {
    transferState = transferState,
    size = size,
    fileName = fileName,
-    cdnNumber = cdnNumber,
+    cdn = cdn,
    remoteLocation = location,
    remoteKey = key,
    remoteDigest = digest,
@@ -83,7 +82,7 @@ class PointerAttachment : Attachment {

    @JvmStatic
    @JvmOverloads
-    fun forPointer(pointer: Optional<SignalServiceAttachment>, stickerLocator: StickerLocator? = null, fastPreflightId: String? = null): Optional<Attachment> {
+    fun forPointer(pointer: Optional<SignalServiceAttachment>, stickerLocator: StickerLocator? = null, fastPreflightId: String? = null, transferState: Int = AttachmentTable.TRANSFER_PROGRESS_PENDING): Optional<Attachment> {
      if (!pointer.isPresent || !pointer.get().isPointer) {
        return Optional.empty()
      }
@@ -97,10 +96,10 @@ class PointerAttachment : Attachment {
      return Optional.of(
        PointerAttachment(
          contentType = pointer.get().contentType,
-          transferState = AttachmentTable.TRANSFER_PROGRESS_PENDING,
+          transferState = transferState,
          size = pointer.get().asPointer().size.orElse(0).toLong(),
          fileName = pointer.get().asPointer().fileName.orElse(null),
-          cdnNumber = pointer.get().asPointer().cdnNumber,
+          cdn = Cdn.fromCdnNumber(pointer.get().asPointer().cdnNumber),
          location = pointer.get().asPointer().remoteId.toString(),
          key = encodedKey,
          digest = pointer.get().asPointer().digest.orElse(null),
@@ -120,35 +119,6 @@ class PointerAttachment : Attachment {
      )
    }

-    fun forPointer(pointer: SignalServiceDataMessage.Quote.QuotedAttachment): Optional<Attachment> {
-      val thumbnail = pointer.thumbnail
-
-      return Optional.of(
-        PointerAttachment(
-          contentType = pointer.contentType,
-          transferState = AttachmentTable.TRANSFER_PROGRESS_PENDING,
-          size = (if (thumbnail != null) thumbnail.asPointer().size.orElse(0) else 0).toLong(),
-          fileName = pointer.fileName,
-          cdnNumber = thumbnail?.asPointer()?.cdnNumber ?: 0,
-          location = thumbnail?.asPointer()?.remoteId?.toString() ?: "0",
-          key = if (thumbnail != null && thumbnail.asPointer().key != null) encodeWithPadding(thumbnail.asPointer().key) else null,
-          digest = thumbnail?.asPointer()?.digest?.orElse(null),
-          incrementalDigest = thumbnail?.asPointer()?.incrementalDigest?.orElse(null),
-          incrementalMacChunkSize = thumbnail?.asPointer()?.incrementalMacChunkSize ?: 0,
-          fastPreflightId = null,
-          voiceNote = false,
-          borderless = false,
-          videoGif = false,
-          width = thumbnail?.asPointer()?.width ?: 0,
-          height = thumbnail?.asPointer()?.height ?: 0,
-          uploadTimestamp = thumbnail?.asPointer()?.uploadTimestamp ?: 0,
-          caption = thumbnail?.asPointer()?.caption?.orElse(null),
-          stickerLocator = null,
-          blurHash = null
-        )
-      )
-    }
-
    fun forPointer(quotedAttachment: DataMessage.Quote.QuotedAttachment): Optional<Attachment> {
      val thumbnail: SignalServiceAttachment? = try {
        if (quotedAttachment.thumbnail != null) {
@@ -166,7 +136,7 @@ class PointerAttachment : Attachment {
          transferState = AttachmentTable.TRANSFER_PROGRESS_PENDING,
          size = (if (thumbnail != null) thumbnail.asPointer().size.orElse(0) else 0).toLong(),
          fileName = quotedAttachment.fileName,
-          cdnNumber = thumbnail?.asPointer()?.cdnNumber ?: 0,
+          cdn = Cdn.fromCdnNumber(thumbnail?.asPointer()?.cdnNumber ?: 0),
          location = thumbnail?.asPointer()?.remoteId?.toString() ?: "0",
          key = if (thumbnail != null && thumbnail.asPointer().key != null) encodeWithPadding(thumbnail.asPointer().key) else null,
          digest = thumbnail?.asPointer()?.digest?.orElse(null),
--- a/app/src/main/java/org/thoughtcrime/securesms/attachments/TombstoneAttachment.kt
+++ b/app/src/main/java/org/thoughtcrime/securesms/attachments/TombstoneAttachment.kt
@@ -2,6 +2,7 @@ package org.thoughtcrime.securesms.attachments

 import android.net.Uri
 import android.os.Parcel
+import org.thoughtcrime.securesms.blurhash.BlurHash
 import org.thoughtcrime.securesms.database.AttachmentTable

 /**
@@ -17,7 +18,7 @@ class TombstoneAttachment : Attachment {
    transferState = AttachmentTable.TRANSFER_PROGRESS_DONE,
    size = 0,
    fileName = null,
-    cdnNumber = 0,
+    cdn = Cdn.CDN_0,
    remoteLocation = null,
    remoteKey = null,
    remoteDigest = null,
@@ -37,6 +38,44 @@ class TombstoneAttachment : Attachment {
    transformProperties = null
  )

+  constructor(
+    contentType: String?,
+    incrementalMac: ByteArray?,
+    incrementalMacChunkSize: Int?,
+    width: Int?,
+    height: Int?,
+    caption: String?,
+    blurHash: String?,
+    voiceNote: Boolean = false,
+    borderless: Boolean = false,
+    gif: Boolean = false,
+    quote: Boolean
+  ) : super(
+    contentType = contentType ?: "",
+    quote = quote,
+    transferState = AttachmentTable.TRANSFER_PROGRESS_PERMANENT_FAILURE,
+    size = 0,
+    fileName = null,
+    cdn = Cdn.CDN_0,
+    remoteLocation = null,
+    remoteKey = null,
+    remoteDigest = null,
+    incrementalDigest = incrementalMac,
+    fastPreflightId = null,
+    voiceNote = voiceNote,
+    borderless = borderless,
+    videoGif = gif,
+    width = width ?: 0,
+    height = height ?: 0,
+    incrementalMacChunkSize = incrementalMacChunkSize ?: 0,
+    uploadTimestamp = 0,
+    caption = caption,
+    stickerLocator = null,
+    blurHash = BlurHash.parseOrNull(blurHash),
+    audioHash = null,
+    transformProperties = null
+  )
+
  constructor(parcel: Parcel) : super(parcel)

  override val uri: Uri? = null
--- a/app/src/main/java/org/thoughtcrime/securesms/attachments/UriAttachment.kt
+++ b/app/src/main/java/org/thoughtcrime/securesms/attachments/UriAttachment.kt
@@ -69,7 +69,7 @@ class UriAttachment : Attachment {
    transferState = transferState,
    size = size,
    fileName = fileName,
-    cdnNumber = 0,
+    cdn = Cdn.CDN_0,
    remoteLocation = null,
    remoteKey = null,
    remoteDigest = null,