feat: asset audit log metadata - WPB-20714

wire-ios-data-model/Source/Model/Conversation/ZMConversation+Message.swift

@@ -258,7 +258,7 @@ public extension ZMConversation {
     /// Append an image message.
     ///
     /// - Parameters:
-    ///     - url: A url locating some image data.
+    ///     - image: The image to append.
     ///     - nonce: The nonce of the message.
     ///
     /// - Throws:
@@ -268,55 +268,42 @@ public extension ZMConversation {
     ///     The appended message.
 
     @discardableResult
-    func appendImage(at URL: URL, nonce: UUID = UUID()) throws -> ZMConversationMessage {
-        guard
-            URL.isFileURL,
-            ZMImagePreprocessor.sizeOfPrerotatedImage(at: URL) != .zero,
-            let imageData = try? Data(contentsOf: URL, options: [])
-        else {
-            throw AppendMessageError.invalidImageUrl
-        }
-
-        return try appendImage(from: imageData)
-    }
-
-    /// Append an image message.
-    ///
-    /// - Parameters:
-    ///     - imageData: Data representing an image.
-    ///     - nonce: The nonce of the message.
-    ///
-    /// - Throws:
-    ///     - `AppendMessageError` if the message couldn't be appended.
-    ///
-    /// - Returns:
-    ///     The appended message.
-
-    @discardableResult
-    func appendImage(from imageData: Data, nonce: UUID = UUID()) throws -> ZMConversationMessage {
+    func appendImage(
+        _ image: SendableImage,
+        nonce: UUID
+    ) throws -> ZMConversationMessage {
         guard let moc = managedObjectContext else {
             throw AppendMessageError.missingManagedObjectContext
         }
 
-        guard let imageData = try? imageData.wr_removingImageMetadata() else {
+        guard let imageData = try? image.data.wr_removingImageMetadata() else {
             throw AppendMessageError.failedToRemoveImageMetadata
         }
 
         // mimeType is assigned first, to make sure UI can handle animated GIF file correctly.
-        let mimeType = imageData.mimeType ?? ""
+        let mimeType = image.utType?.preferredMIMEType
 
         // We update the size again when the the preprocessing is done.
         let imageSize = ZMImagePreprocessor.sizeOfPrerotatedImage(with: imageData)
 
         let asset = GenericMessageProtocol.Asset(
+            name: image.name,
+            mimeType: mimeType ?? "",
             imageSize: imageSize,
-            mimeType: mimeType,
             size: UInt64(imageData.count)
         )
 
-        return try append(asset: asset, nonce: nonce, expires: true, prepareMessage: { message in
-            moc.zm_fileAssetCache.storeOriginalImage(data: imageData, for: message)
-        })
+        return try append(
+            asset: asset,
+            nonce: nonce,
+            expires: true,
+            prepareMessage: { message in
+                moc.zm_fileAssetCache.storeOriginalImage(
+                    data: imageData,
+                    for: message
+                )
+            }
+        )
     }
 
     /// Append a file message.
@@ -563,21 +550,6 @@ public extension ZMConversation {
         try? appendLocation(with: locationData)
     }
 
-    @discardableResult @objc(appendMessageWithImageData:)
-    func _appendImage(from imageData: Data) -> ZMConversationMessage? {
-        try? appendImage(from: imageData)
-    }
-
-    @discardableResult @objc(appendImageFromData:nonce:)
-    func _appendImage(from imageData: Data, nonce: UUID) -> ZMConversationMessage? {
-        try? appendImage(from: imageData, nonce: nonce)
-    }
-
-    @discardableResult @objc(appendImageAtURL:nonce:)
-    func _appendImage(at URL: URL, nonce: UUID) -> ZMConversationMessage? {
-        try? appendImage(at: URL, nonce: nonce)
-    }
-
     @discardableResult @objc(appendMessageWithFileMetadata:)
     func _appendFile(with fileMetadata: ZMFileMetadata) -> ZMConversationMessage? {
         try? appendFile(with: fileMetadata)
@@ -589,3 +561,55 @@ public extension ZMConversation {
     }
 
 }
+
+import UniformTypeIdentifiers
+
+public struct SendableImage {
+
+    public let name: String
+    public let utType: UTType?
+    public let data: Data
+
+    public init(
+        name: String?,
+        utType: UTType?,
+        data: Data
+    ) {
+        if let utType {
+            self.utType = utType
+        } else {
+            self.utType = Self.determineUTType(from: data)
+        }
+
+        if let name {
+            self.name = name
+        } else if let fileExtension = self.utType?.preferredFilenameExtension {
+            self.name = "picture.\(fileExtension)"
+        } else {
+            self.name = "picture"
+        }
+
+        self.data = data
+    }
+
+    private static func determineUTType(from data: Data) -> UTType? {
+        guard
+            !data.isEmpty,
+            let imageSource = CGImageSourceCreateWithData(data as CFData, nil),
+            let uti = CGImageSourceGetType(imageSource) as String?
+        else {
+            return nil
+        }
+
+        return UTType(uti)
+    }
+
+}
+
+extension SendableImage: CustomDebugStringConvertible {
+
+    public var debugDescription: String {
+        "SendableImage(name: \(name), type: \(utType?.preferredMIMEType ?? "unknown"))"
+    }
+
+}

wire-ios-data-model/Source/Model/Message/ZMFileMetadata.swift

@@ -38,7 +38,14 @@ open class ZMFileMetadata: NSObject {
         } else {
             nil
         }
-        let endName = name ?? (fileURL.lastPathComponent.isEmpty ? "unnamed" : fileURL.lastPathComponent)
+
+        let endName: String = if let name {
+            name
+        } else if !fileURL.lastPathComponent.isEmpty {
+            fileURL.lastPathComponent
+        } else {
+            "file"
+        }
 
         self.filename = endName.removingExtremeCombiningCharacters
         super.init()

wire-ios-data-model/Source/Repositories/LegacyFeatureRepository.swift

@@ -51,6 +51,7 @@ public protocol LegacyFeatureRepositoryInterface {
     func storeConsumableNotifications(_ consumableNotifications: Feature.ConsumableNotifications)
     func fetchChatBubblesSimple() -> Feature.ChatBubblesSimple
     func storeChatBubblesSimple(_ chatBubblesSimple: Feature.ChatBubblesSimple)
+    func fetchAssetAuditLog() -> Feature.AssetAuditLog
 }
 
 /// **Do not use it for new code, use FeatureConfigRepository instead**
@@ -536,6 +537,16 @@ public class LegacyFeatureRepository: LegacyFeatureRepositoryInterface {
         }
     }
 
+    // MARK: - Asset audit log
+
+    public func fetchAssetAuditLog() -> Feature.AssetAuditLog {
+        guard let feature = Feature.fetch(name: .assetAuditLog, context: context) else {
+            return .init()
+        }
+
+        return .init(status: feature.status)
+    }
+
     // MARK: - Methods
 
     func createDefaultConfigsIfNeeded() {

wire-ios-data-model/Source/Utilis/Protos/GenericMessage+Assets.swift

@@ -60,11 +60,17 @@ public extension GenericMessageProtocol.Asset {
         }
     }
 
-    init(imageSize: CGSize, mimeType: String, size: UInt64) {
+    init(
+        name: String,
+        mimeType: String,
+        imageSize: CGSize,
+        size: UInt64
+    ) {
         self = GenericMessageProtocol.Asset.with {
             $0.original = GenericMessageProtocol.Asset.Original.with {
-                $0.size = size
+                $0.name = name
                 $0.mimeType = mimeType
+                $0.size = size
                 $0.image = GenericMessageProtocol.Asset.ImageMetaData.with {
                     $0.width = Int32(imageSize.width)
                     $0.height = Int32(imageSize.height)
@@ -228,12 +234,14 @@ public extension GenericMessageProtocol.Asset.RemoteData {
 
 extension GenericMessage {
     mutating func updateAssetOriginal(withImageProperties imageProperties: ZMIImageProperties) {
-        let asset = GenericMessageProtocol.Asset(
-            imageSize: imageProperties.size,
-            mimeType: imageProperties.mimeType,
-            size: UInt64(imageProperties.length)
-        )
-        update(asset: asset)
+        updateAsset { existingAsset in
+            existingAsset.original.mimeType = imageProperties.mimeType
+            existingAsset.original.size = UInt64(imageProperties.length)
+            existingAsset.original.image = GenericMessageProtocol.Asset.ImageMetaData.with {
+                $0.width = Int32(imageProperties.size.width)
+                $0.height = Int32(imageProperties.size.height)
+            }
+        }
     }
 
     mutating func updateAssetPreview(withUploadedOTRKey otrKey: Data, sha256: Data) {

wire-ios-data-model/Source/Utilis/Protos/GenericMessage+Helper.swift

@@ -774,8 +774,9 @@ public extension LinkPreview {
             $0.summary = articleMetadata.summary ?? ""
             if let imageData = articleMetadata.imageData.first {
                 $0.image = GenericMessageProtocol.Asset(
-                    imageSize: CGSize(width: 0, height: 0),
+                    name: "picture.jpeg",
                     mimeType: "image/jpeg",
+                    imageSize: CGSize(width: 0, height: 0),
                     size: UInt64(imageData.count)
                 )
             }
@@ -791,8 +792,9 @@ public extension LinkPreview {
             $0.title = twitterMetadata.message ?? ""
             if let imageData = twitterMetadata.imageData.first {
                 $0.image = GenericMessageProtocol.Asset(
-                    imageSize: CGSize(width: 0, height: 0),
+                    name: "picture.jpeg",
                     mimeType: "image/jpeg",
+                    imageSize: CGSize(width: 0, height: 0),
                     size: UInt64(imageData.count)
                 )
             }

wire-ios-data-model/Tests/OneOnOne/OneOnOneMigratorTests.swift

@@ -232,7 +232,10 @@ final class OneOnOneMigratorTests: XCTestCase {
             message = try proteusConversation.appendKnock()
             message.updateServerTimestamp(with: 1)
 
-            message = try proteusConversation.appendImage(from: ZMTBaseTest.verySmallJPEGData())
+            message = try proteusConversation.appendImage(
+                SendableImage(name: "picture.jpg", utType: .jpeg, data: ZMTBaseTest.verySmallJPEGData()),
+                nonce: UUID()
+            )
             message.updateServerTimestamp(with: 2)
 
             XCTAssertEqual(proteusConversation.allMessages.count, 3)
@@ -322,7 +325,10 @@ final class OneOnOneMigratorTests: XCTestCase {
             message = try proteusConversation.appendKnock()
             message.updateServerTimestamp(with: 1)
 
-            message = try proteusConversation.appendImage(from: ZMTBaseTest.verySmallJPEGData())
+            message = try proteusConversation.appendImage(
+                SendableImage(name: "picture.jpg", utType: .jpeg, data: ZMTBaseTest.verySmallJPEGData()),
+                nonce: UUID()
+            )
             message.updateServerTimestamp(with: 2)
 
             XCTAssertEqual(proteusConversation.allMessages.count, 3)
@@ -337,7 +343,10 @@ final class OneOnOneMigratorTests: XCTestCase {
             message = try duplicateProteusConversation.appendKnock()
             message.updateServerTimestamp(with: 11)
 
-            message = try duplicateProteusConversation.appendImage(from: ZMTBaseTest.verySmallJPEGData())
+            message = try duplicateProteusConversation.appendImage(
+                SendableImage(name: "picture.jpg", utType: .jpeg, data: ZMTBaseTest.verySmallJPEGData()),
+                nonce: UUID()
+            )
             message.updateServerTimestamp(with: 12)
 
             XCTAssertEqual(proteusConversation.allMessages.count, 3)
@@ -453,7 +462,10 @@ final class OneOnOneMigratorTests: XCTestCase {
             message = try proteusConversation.appendKnock()
             message.updateServerTimestamp(with: 1)
 
-            message = try proteusConversation.appendImage(from: ZMTBaseTest.verySmallJPEGData())
+            message = try proteusConversation.appendImage(
+                SendableImage(name: "picture.jpg", utType: .jpeg, data: ZMTBaseTest.verySmallJPEGData()),
+                nonce: UUID()
+            )
             message.updateServerTimestamp(with: 2)
 
             XCTAssertEqual(proteusConversation.allMessages.count, 3)
@@ -468,7 +480,10 @@ final class OneOnOneMigratorTests: XCTestCase {
             message = try duplicateProteusConversation.appendKnock()
             message.updateServerTimestamp(with: 11)
 
-            message = try duplicateProteusConversation.appendImage(from: ZMTBaseTest.verySmallJPEGData())
+            message = try duplicateProteusConversation.appendImage(
+                SendableImage(name: "picture.jpg", utType: .jpeg, data: ZMTBaseTest.verySmallJPEGData()),
+                nonce: UUID()
+            )
             message.updateServerTimestamp(with: 12)
 
             XCTAssertEqual(proteusConversation.allMessages.count, 3)

wire-ios-data-model/Tests/Source/Model/Conversation/AssetCollectionBatchedTests.swift

@@ -51,7 +51,10 @@ final class AssetColletionBatchedTests: ModelObjectsTests {
         var offset: TimeInterval = 0
         var messages = [ZMMessage]()
         (0 ..< count).forEach { _ in
-            let message = try! conversation.appendImage(from: verySmallJPEGData()) as! ZMMessage
+            let message = try! conversation.appendImage(
+                SendableImage(name: "picture.jpg", utType: .jpeg, data: verySmallJPEGData()),
+                nonce: UUID()
+            ) as! ZMMessage
             offset += 5
             message.setValue(Date().addingTimeInterval(offset), forKey: "serverTimestamp")
             messages.append(message)
@@ -300,7 +303,8 @@ final class AssetColletionBatchedTests: ModelObjectsTests {
     func testThatItExcludesDefinedCategories_PreCategorized() {
         // given
         let data = data(forResource: "animated", extension: "gif")!
-        _ = try! conversation.appendImage(from: data) as! ZMAssetClientMessage
+        let image = SendableImage(name: "picture.gif", utType: .gif, data: data)
+        _ = try! conversation.appendImage(image, nonce: UUID()) as! ZMAssetClientMessage
         uiMOC.saveOrRollback()
 
         // when
@@ -322,7 +326,8 @@ final class AssetColletionBatchedTests: ModelObjectsTests {
     func testThatItExcludesDefinedCategories_NotPreCategorized() {
         // given
         let data = data(forResource: "animated", extension: "gif")!
-        _ = try! conversation.appendImage(from: data) as! ZMAssetClientMessage
+        let image = SendableImage(name: "picture.gif", utType: .gif, data: data)
+        _ = try! conversation.appendImage(image, nonce: UUID()) as! ZMAssetClientMessage
         uiMOC.saveOrRollback()
 
         // when
@@ -370,7 +375,8 @@ final class AssetColletionBatchedTests: ModelObjectsTests {
         // given
         insertAssetMessages(count: 1)
         let data = data(forResource: "animated", extension: "gif")!
-        _ = try! conversation.appendImage(from: data) as! ZMAssetClientMessage
+        let image = SendableImage(name: "picture.gif", utType: .gif, data: data)
+        _ = try! conversation.appendImage(image, nonce: UUID()) as! ZMAssetClientMessage
         uiMOC.saveOrRollback()
 
         // when