feat: cross-platform backup - WPB-16658 (#2889)

Author: caldrian

WireBackup/Sources/WireBackup/KaliumBackupAdapters/Models/BackupConversation+initWithBackupConversationModel.swift

@@ -20,9 +20,9 @@ import KaliumBackup
 
 extension BackupConversation {
 
-    convenience init(_ conversation: BackupConversationModel) {
+    convenience init(_ conversation: ConversationBackupModel) {
         self.init(
-            id: BackupQualifiedId(conversation.id),
+            id: BackupQualifiedId(conversation.qualifiedID),
             name: conversation.name
         )
     }

WireBackup/Sources/WireBackup/KaliumBackupAdapters/Models/BackupMessage+initWithBackupMessageModel.swift

@@ -21,7 +21,7 @@ import KaliumBackup
 
 extension BackupMessage {
 
-    convenience init(_ message: BackupMessageModel) {
+    convenience init(_ message: MessageBackupModel) {
         self.init(
             id: message.id.lowercased(),
             conversationId: BackupQualifiedId(message.conversationID),

WireBackup/Sources/WireBackup/KaliumBackupAdapters/Models/BackupUser+initWithBackupUserModel.swift

@@ -17,12 +17,13 @@
 //
 
 import KaliumBackup
+import WireFoundation
 
 extension BackupUser {
 
-    convenience init(_ user: BackupUserModel) {
+    convenience init(_ user: UserBackupModel) {
         self.init(
-            id: BackupQualifiedId(user.id),
+            id: BackupQualifiedId(user.qualifiedID),
             name: user.name,
             handle: user.handle
         )

WireBackup/Sources/WireBackup/KaliumBackupAdapters/Wrappers/BackupCreator.swift

@@ -0,0 +1,112 @@
+//
+// Wire
+// Copyright (C) 2025 Wire Swiss GmbH
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see http://www.gnu.org/licenses/.
+//
+
+import Foundation
+import KaliumBackup
+import WireFoundation
+
+/// Abstraction around the multi-platform framework, attempting to improve the interface by using proper types and Swift
+/// concurrency and hide the NSObject API.
+struct BackupCreator {
+
+    private let mpBackupCreator: MPBackupExporter
+
+    init(
+        selfUserID: QualifiedID,
+        workDirectoryURL: URL,
+        outputDirectoryURL: URL,
+        fileArchiver: some FileArchiverProtocol
+    ) {
+        self.mpBackupCreator = MPBackupExporter(
+            selfUserId: BackupQualifiedId(selfUserID),
+            workDirectory: workDirectoryURL.path(),
+            outputDirectory: outputDirectoryURL.path(),
+            fileZipper: FileArchiverToFileZipperAdapter(fileArchiver)
+        )
+    }
+
+    func addUser(_ user: UserBackupModel) {
+        mpBackupCreator.add(user: BackupUser(user))
+    }
+
+    func addConversation(_ conversation: ConversationBackupModel) {
+        mpBackupCreator.add(conversation: BackupConversation(conversation))
+    }
+
+    func addMessage(_ message: MessageBackupModel) {
+        mpBackupCreator.add(message: BackupMessage(message))
+    }
+
+    func finalize(password: String) async throws -> URL {
+
+        let result: any BackupExportResult = try await mpBackupCreator.finalize(password: password)
+
+        switch result {
+        case let success as BackupExportResultSuccess:
+            return URL(filePath: success.pathToOutputFile, directoryHint: .notDirectory)
+        case let ioError as BackupExportResultFailureIOError:
+            throw FinalizeBackupFileError.ioError(ioError.message)
+        case let zipError as BackupExportResultFailureZipError:
+            throw FinalizeBackupFileError.zipError(zipError.message)
+        default:
+            throw FinalizeBackupFileError.unexpectedResultType
+        }
+
+    }
+
+    // MARK: -
+
+    enum FinalizeBackupFileError: Error {
+
+        case success(_ outputFile: String)
+        case ioError(_ message: String)
+        case zipError(_ message: String)
+        case unexpectedResultType
+
+    }
+
+}
+
+// MARK: -
+
+private final class FileArchiverToFileZipperAdapter<FileArchiver>: FileZipper
+    where FileArchiver: FileArchiverProtocol {
+
+    let fileArchiver: FileArchiver
+
+    init(_ fileArchiver: FileArchiver) {
+        self.fileArchiver = fileArchiver
+    }
+
+    func zip(entries: [String], outputDirectory: OkioPath) throws -> String {
+
+        let outputDirectory = outputDirectory.segments.reduce(URL(fileURLWithPath: "/")) { url, component in
+            url.appendingPathComponent(component)
+        }
+        let targetURLs = entries.map { entry in
+            URL(filePath: entry, directoryHint: .notDirectory)
+        }
+        let destinationURL = outputDirectory.appendingPathComponent("backup.zip", isDirectory: false)
+
+        try fileArchiver.zipResources(at: targetURLs, into: destinationURL)
+
+        return destinationURL.path()
+
+    }
+
+}

WireBackup/Sources/WireBackup/Models/BackupConversationModel.swift

@@ -18,17 +18,16 @@
 
 public import WireFoundation
 
-public struct BackupConversationModel {
-    public typealias ID = QualifiedID
+public struct ConversationBackupModel: Codable, Hashable, Sendable {
 
-    public var id: ID
+    public var qualifiedID: QualifiedID
     public var name: String
 
     public init(
-        id: ID,
+        qualifiedID: QualifiedID,
         name: String
     ) {
-        self.id = id
+        self.qualifiedID = qualifiedID
         self.name = name
     }
 

WireBackup/Sources/WireBackup/Models/BackupMessageModel.swift

@@ -19,18 +19,17 @@
 public import Foundation
 public import WireFoundation
 
-public struct BackupMessageModel {
-    public typealias ID = String
+public struct MessageBackupModel: Codable, Hashable, Sendable {
 
-    public var id: ID
+    public var id: String
     public var conversationID: QualifiedID
     public var senderUserID: QualifiedID
     public var senderClientID: String?
     public var creationDate: Date
     public var content: MessageContent
 
     public init(
-        id: ID,
+        id: String,
         conversationID: QualifiedID,
         senderUserID: QualifiedID,
         senderClientID: String? = nil,
@@ -52,7 +51,7 @@ public struct BackupMessageModel {
 // The following types replicate the API of the multi-platform backup library in a Swift friendlier way.
 // (e.g. enums instead of class hierarchy)
 
-public enum MessageContent {
+public enum MessageContent: Codable, Hashable, Sendable {
 
     case text(TextContent)
     case location(LocationContent)
@@ -64,18 +63,18 @@ public enum MessageContent {
 
 public extension MessageContent {
 
-    struct TextContent {
+    struct TextContent: Codable, Hashable, Sendable {
         public var text: String
     }
 
-    struct LocationContent {
+    struct LocationContent: Codable, Hashable, Sendable {
         public var longitude: Float
         public var latitude: Float
         public var name: String?
         public var zoom: Int32?
     }
 
-    struct AssetContent {
+    struct AssetContent: Codable, Hashable, Sendable {
         public var mimeType: String
         public var size: UInt64
         public var name: String?
@@ -87,16 +86,17 @@ public extension MessageContent {
         public var encryption: EncryptionAlgorithm?
         public var metadata: Metadata?
 
-        public enum EncryptionAlgorithm {
+        public enum EncryptionAlgorithm: Codable, Hashable, Sendable {
             case aesCBC
             case aesGCM
         }
 
-        public enum Metadata {
+        public enum Metadata: Codable, Hashable, Sendable {
 
             case image(ImageMetadata)
             case video(VideoMetadata)
             case audio(AudioMetadata)
+            // TODO: [WPB-16658] check if the `.generic` case needs to be used
             case generic(GenericMetadata)
 
         }
@@ -106,24 +106,24 @@ public extension MessageContent {
 
 public extension MessageContent.AssetContent.Metadata {
 
-    struct ImageMetadata {
+    struct ImageMetadata: Codable, Hashable, Sendable {
         public var width: Int32
         public var height: Int32
         public var tag: String?
     }
 
-    struct VideoMetadata {
+    struct VideoMetadata: Codable, Hashable, Sendable {
         public var width: Int32?
         public var height: Int32?
         public var duration: UInt64?
     }
 
-    struct AudioMetadata {
+    struct AudioMetadata: Codable, Hashable, Sendable {
         public var normalization: Data?
         public var duration: UInt64?
     }
 
-    struct GenericMetadata {
+    struct GenericMetadata: Codable, Hashable, Sendable {
         public var name: String?
     }
 

WireBackup/Sources/WireBackup/Models/BackupUserModel.swift

@@ -18,19 +18,18 @@
 
 public import WireFoundation
 
-public struct BackupUserModel {
-    public typealias ID = QualifiedID
+public struct UserBackupModel: Codable, Hashable, Sendable {
 
-    public var id: ID
+    public var qualifiedID: QualifiedID
     public var name: String
     public var handle: String
 
     public init(
-        id: ID,
+        qualifiedID: QualifiedID,
         name: String,
         handle: String
     ) {
-        self.id = id
+        self.qualifiedID = qualifiedID
         self.name = name
         self.handle = handle
     }

WireBackup/Sources/WireBackup/Protocols/Stores/BackupLocalStoreProtocol.swift

@@ -0,0 +1,43 @@
+//
+// Wire
+// Copyright (C) 2025 Wire Swiss GmbH
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see http://www.gnu.org/licenses/.
+//
+
+import WireFoundation
+
+// sourcery: AutoMockable
+public protocol BackupLocalStoreProtocol: Sendable {
+
+    /// Returns the number of all stored users, conversations and messages in the local data store, including deleted
+    /// ones.
+    func countModels() async throws -> (userCount: Int, conversationCount: Int, messageCount: Int)
+
+    // MARK: -
+
+    /// Returns all users stored in the local database, including deleted ones.
+    func fetchAllUsers() -> AsyncThrowingStream<UserBackupModel, any Error>
+
+    // MARK: -
+
+    /// Returns all conversations stored in the local database, including deleted ones.
+    func fetchAllConversations() -> AsyncThrowingStream<ConversationBackupModel, any Error>
+
+    // MARK: -
+
+    /// Returns all messages stored in the local database, including deleted ones.
+    func fetchAllMessages() -> AsyncThrowingStream<MessageBackupModel, any Error>
+
+}

WireBackup/Sources/WireBackup/UseCases/BackupFileExtension.swift

@@ -0,0 +1,32 @@
+//
+// Wire
+// Copyright (C) 2025 Wire Swiss GmbH
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see http://www.gnu.org/licenses/.
+//
+
+public enum BackupFileExtension: String, CaseIterable {
+
+    case crossPlatform = "wbu"
+
+    // MARK: Legacy
+
+    // There are some external apps that users can use to transfer backup files, which can modify their attachments and
+    // change the underscore with a dash. For this reason, we accept 2 types of file extensions to restore
+    // conversations.
+
+    case fileExtensionWithUnderscore = "ios_wbu"
+    case fileExtensionWithHyphen = "ios-wbu"
+
+}