Modify ConversationViewItem to support media galleries.

Signal/src/ViewControllers/ColorPickerViewController.swift

@@ -339,6 +339,7 @@ private class MockConversationViewItem: NSObject, ConversationViewItem {
     var authorConversationColorName: String?
     var hasBodyTextActionContent: Bool = false
     var hasMediaActionContent: Bool = false
+    var mediaGalleryItems: [ConversationMediaGalleryItem]?
 
     override init() {
         super.init()

Signal/src/ViewControllers/ConversationView/ConversationViewItem.h

@@ -31,12 +31,27 @@ NSString *NSStringForOWSMessageCellType(OWSMessageCellType cellType);
 @class OWSAudioMessageView;
 @class OWSQuotedReplyModel;
 @class OWSUnreadIndicator;
+@class TSAttachment;
 @class TSAttachmentPointer;
 @class TSAttachmentStream;
 @class TSInteraction;
 @class TSThread;
 @class YapDatabaseReadTransaction;
 
+@interface ConversationMediaGalleryItem : NSObject
+
+@property (nonatomic, readonly) TSAttachment *attachment;
+
+// This property will only be set if the attachment is downloaded.
+@property (nonatomic, readonly, nullable) TSAttachmentStream *attachmentStream;
+
+// This property will be non-zero if the attachment is valid.
+@property (nonatomic, readonly) CGSize mediaSize;
+
+@end
+
+#pragma mark -
+
 // This is a ViewModel for cells in the conversation view.
 //
 // The lifetime of this class is the lifetime of that cell
@@ -92,6 +107,7 @@ NSString *NSStringForOWSMessageCellType(OWSMessageCellType cellType);
 @property (nonatomic, readonly, nullable) TSAttachmentStream *attachmentStream;
 @property (nonatomic, readonly, nullable) TSAttachmentPointer *attachmentPointer;
 @property (nonatomic, readonly) CGSize mediaSize;
+@property (nonatomic, readonly, nullable) NSArray<ConversationMediaGalleryItem *> *mediaGalleryItems;
 
 @property (nonatomic, readonly, nullable) DisplayableText *displayableQuotedText;
 @property (nonatomic, readonly, nullable) NSString *quotedAttachmentMimetype;

Signal/src/ViewControllers/ConversationView/ConversationViewItem.m

@@ -48,6 +48,30 @@ NSString *NSStringForOWSMessageCellType(OWSMessageCellType cellType)
 
 #pragma mark -
 
+@implementation ConversationMediaGalleryItem
+
+- (instancetype)initWithAttachment:(TSAttachment *)attachment
+                  attachmentStream:(nullable TSAttachmentStream *)attachmentStream
+                         mediaSize:(CGSize)mediaSize
+{
+    OWSAssertDebug(attachment);
+
+    self = [super init];
+
+    if (!self) {
+        return self;
+    }
+
+    _attachment = attachment;
+    _attachmentStream = attachmentStream;
+    _mediaSize = mediaSize;
+
+    return self;
+}
+@end
+
+#pragma mark -
+
 @interface ConversationInteractionViewItem ()
 
 @property (nonatomic, nullable) NSValue *cachedCellSize;
@@ -69,6 +93,7 @@ NSString *NSStringForOWSMessageCellType(OWSMessageCellType cellType)
 @property (nonatomic, nullable) TSAttachmentPointer *attachmentPointer;
 @property (nonatomic, nullable) ContactShareViewModel *contactShare;
 @property (nonatomic) CGSize mediaSize;
+@property (nonatomic, nullable) NSArray<ConversationMediaGalleryItem *> *mediaGalleryItems;
 @property (nonatomic, nullable) NSString *systemMessageText;
 @property (nonatomic, nullable) TSThread *incomingMessageAuthorThread;
 @property (nonatomic, nullable) NSString *authorConversationColorName;
@@ -475,22 +500,6 @@ NSString *NSStringForOWSMessageCellType(OWSMessageCellType cellType)
 
 #pragma mark - View State
 
-- (nullable TSAttachment *)firstAttachmentIfAnyOfMessage:(TSMessage *)message
-                                             transaction:(YapDatabaseReadTransaction *)transaction
-{
-    OWSAssertDebug(transaction);
-
-    if (message.attachmentIds.count == 0) {
-        return nil;
-    }
-    // TODO: Support multi-image messages.
-    NSString *_Nullable attachmentId = message.attachmentIds.firstObject;
-    if (attachmentId.length == 0) {
-        return nil;
-    }
-    return [TSAttachment fetchObjectWithUniqueID:attachmentId transaction:transaction];
-}
-
 - (void)ensureViewState:(YapDatabaseReadTransaction *)transaction
 {
     OWSAssertIsOnMainThread();
@@ -528,7 +537,19 @@ NSString *NSStringForOWSMessageCellType(OWSMessageCellType cellType)
         self.messageCellType = OWSMessageCellType_ContactShare;
         return;
     }
-    TSAttachment *_Nullable attachment = [self firstAttachmentIfAnyOfMessage:message transaction:transaction];
+
+    NSArray<TSAttachment *> *attachments = [message attachmentsWithTransaction:transaction];
+    if ([message isMediaGalleryWithTransaction:transaction]) {
+        OWSAssertDebug(attachments.count > 0);
+        // TODO: Handle captions.
+        self.mediaGalleryItems = [self mediaGalleryItemsForAttachments:attachments];
+        self.messageCellType = OWSMessageCellType_MediaGallery;
+        return;
+    }
+    // Only media galleries should have more than one attachment.
+    OWSAssertDebug(attachments.count <= 1);
+
+    TSAttachment *_Nullable attachment = attachments.firstObject;
     if (attachment) {
         if ([attachment isKindOfClass:[TSAttachmentStream class]]) {
             self.attachmentStream = (TSAttachmentStream *)attachment;
@@ -626,6 +647,45 @@ NSString *NSStringForOWSMessageCellType(OWSMessageCellType cellType)
     }
 }
 
+- (NSArray<ConversationMediaGalleryItem *> *)mediaGalleryItemsForAttachments:(NSArray<TSAttachment *> *)attachments
+{
+    OWSAssertIsOnMainThread();
+    OWSAssertDebug(attachments.count > 0);
+
+    NSMutableArray<ConversationMediaGalleryItem *> *mediaGalleryItems = [NSMutableArray new];
+    for (TSAttachment *attachment in attachments) {
+        if (![attachment isKindOfClass:[TSAttachmentStream class]]) {
+            [mediaGalleryItems addObject:[[ConversationMediaGalleryItem alloc] initWithAttachment:attachment
+                                                                                 attachmentStream:nil
+                                                                                        mediaSize:CGSizeZero]];
+            continue;
+        }
+        TSAttachmentStream *attachmentStream = (TSAttachmentStream *)attachment;
+        if (![attachmentStream isValidVisualMedia]) {
+            OWSLogWarn(@"Filtering invalid media.");
+            [mediaGalleryItems addObject:[[ConversationMediaGalleryItem alloc] initWithAttachment:attachment
+                                                                                 attachmentStream:nil
+                                                                                        mediaSize:CGSizeZero]];
+            continue;
+        }
+        CGSize mediaSize = [self.attachmentStream imageSize];
+        if (self.mediaSize.width <= 0 || self.mediaSize.height <= 0) {
+            OWSLogWarn(@"Filtering media with invalid size.");
+            [mediaGalleryItems addObject:[[ConversationMediaGalleryItem alloc] initWithAttachment:attachment
+                                                                                 attachmentStream:nil
+                                                                                        mediaSize:CGSizeZero]];
+            continue;
+        }
+
+        ConversationMediaGalleryItem *mediaGalleryItem =
+            [[ConversationMediaGalleryItem alloc] initWithAttachment:attachment
+                                                    attachmentStream:attachmentStream
+                                                           mediaSize:mediaSize];
+        [mediaGalleryItems addObject:mediaGalleryItem];
+    }
+    return mediaGalleryItems;
+}
+
 - (NSString *)systemMessageTextWithTransaction:(YapDatabaseReadTransaction *)transaction
 {
     OWSAssertDebug(transaction);
@@ -751,6 +811,7 @@ NSString *NSStringForOWSMessageCellType(OWSMessageCellType cellType)
         case OWSMessageCellType_AnimatedImage:
         case OWSMessageCellType_Audio:
         case OWSMessageCellType_Video:
+        case OWSMessageCellType_MediaGallery:
         case OWSMessageCellType_GenericAttachment: {
             OWSAssertDebug(self.displayableBodyText);
             [UIPasteboard.generalPasteboard setString:self.displayableBodyText.fullText];
@@ -804,6 +865,14 @@ NSString *NSStringForOWSMessageCellType(OWSMessageCellType cellType)
             OWSFailDebug(@"Can't copy not-yet-downloaded attachment");
             break;
         }
+        case OWSMessageCellType_MediaGallery: {
+            // AFAIK UIPasteboard only supports "multiple representations
+            // of a single item", not "multiple different items".
+            //
+            // TODO: Should we copy the first valid item?
+            OWSFailDebug(@"Can't copy media galleries");
+            break;
+        }
     }
 }
 
@@ -833,6 +902,11 @@ NSString *NSStringForOWSMessageCellType(OWSMessageCellType cellType)
             OWSFailDebug(@"share contact not implemented.");
             break;
         }
+        case OWSMessageCellType_MediaGallery: {
+            // TODO: Handle media gallery captions.
+            OWSFailDebug(@"share contact not implemented.");
+            break;
+        }
     }
 }
 
@@ -856,6 +930,22 @@ NSString *NSStringForOWSMessageCellType(OWSMessageCellType cellType)
             OWSFailDebug(@"Can't share not-yet-downloaded attachment");
             break;
         }
+        case OWSMessageCellType_MediaGallery: {
+            // TODO: We need a "canShareMediaAction" method.
+            OWSAssertDebug(self.mediaGalleryItems.count > 0);
+            NSMutableArray<TSAttachmentStream *> *attachmentStreams = [NSMutableArray new];
+            for (ConversationMediaGalleryItem *mediaGalleryItem in self.mediaGalleryItems) {
+                if (mediaGalleryItem.attachmentStream) {
+                    [attachmentStreams addObject:mediaGalleryItem.attachmentStream];
+                }
+            }
+            if (attachmentStreams.count < 1) {
+                OWSFailDebug(@"Can't share media gallery; no valid items.");
+                return;
+            }
+            [AttachmentSharing showShareUIForAttachments:attachmentStreams completion:nil];
+            break;
+        }
     }
 }
 
@@ -879,6 +969,22 @@ NSString *NSStringForOWSMessageCellType(OWSMessageCellType cellType)
         case OWSMessageCellType_DownloadingAttachment: {
             return NO;
         }
+        case OWSMessageCellType_MediaGallery: {
+            for (ConversationMediaGalleryItem *mediaGalleryItem in self.mediaGalleryItems) {
+                if (!mediaGalleryItem.attachmentStream) {
+                    continue;
+                }
+                if (mediaGalleryItem.attachmentStream.isImage || mediaGalleryItem.attachmentStream.isAnimated) {
+                    return YES;
+                }
+                if (mediaGalleryItem.attachmentStream.isVideo) {
+                    if (UIVideoAtPathIsCompatibleWithSavedPhotosAlbum(self.attachmentStream.originalFilePath)) {
+                        return YES;
+                    }
+                }
+            }
+            return NO;
+        }
     }
 }
 
@@ -925,6 +1031,36 @@ NSString *NSStringForOWSMessageCellType(OWSMessageCellType cellType)
             OWSFailDebug(@"Can't save not-yet-downloaded attachment");
             break;
         }
+        case OWSMessageCellType_MediaGallery: {
+            // TODO: Use PHPhotoLibrary.
+            ALAssetsLibrary *library = [[ALAssetsLibrary alloc] init];
+            for (ConversationMediaGalleryItem *mediaGalleryItem in self.mediaGalleryItems) {
+                if (!mediaGalleryItem.attachmentStream) {
+                    continue;
+                }
+                if (mediaGalleryItem.attachmentStream.isImage || mediaGalleryItem.attachmentStream.isAnimated) {
+                    NSData *data = [NSData dataWithContentsOfURL:[self.attachmentStream originalMediaURL]];
+                    if (!data) {
+                        OWSFailDebug(@"Could not load image data");
+                        continue;
+                    }
+                    [library writeImageDataToSavedPhotosAlbum:data
+                                                     metadata:nil
+                                              completionBlock:^(NSURL *assetURL, NSError *error) {
+                                                  if (error) {
+                                                      OWSLogWarn(@"Error saving image to photo album: %@", error);
+                                                  }
+                                              }];
+                }
+                if (mediaGalleryItem.attachmentStream.isVideo) {
+                    if (UIVideoAtPathIsCompatibleWithSavedPhotosAlbum(
+                            mediaGalleryItem.attachmentStream.originalFilePath)) {
+                        UISaveVideoAtPathToSavedPhotosAlbum(
+                            mediaGalleryItem.attachmentStream.originalFilePath, self, nil, nil);
+                    }
+                }
+            }
+        }
     }
 }
 
@@ -955,6 +1091,9 @@ NSString *NSStringForOWSMessageCellType(OWSMessageCellType cellType)
         case OWSMessageCellType_DownloadingAttachment: {
             return NO;
         }
+        case OWSMessageCellType_MediaGallery:
+            // TODO: I suspect we need separate "can save media", "can share media", etc. methods.
+            return NO;
     }
 }
 

SignalMessaging/attachments/AttachmentSharing.h

@@ -10,6 +10,9 @@ typedef void (^AttachmentSharingCompletion)(void);
 
 @interface AttachmentSharing : NSObject
 
++ (void)showShareUIForAttachments:(NSArray<TSAttachmentStream *> *)attachmentStreams
+                       completion:(nullable AttachmentSharingCompletion)completion;
+
 + (void)showShareUIForAttachment:(TSAttachmentStream *)stream;
 
 + (void)showShareUIForURL:(NSURL *)url;

SignalMessaging/attachments/AttachmentSharing.m

@@ -12,6 +12,19 @@ NS_ASSUME_NONNULL_BEGIN
 
 @implementation AttachmentSharing
 
++ (void)showShareUIForAttachments:(NSArray<TSAttachmentStream *> *)attachmentStreams
+                       completion:(nullable AttachmentSharingCompletion)completion
+{
+    OWSAssertDebug(attachmentStreams.count > 0);
+
+    NSMutableArray<NSURL *> *urls = [NSMutableArray new];
+    for (TSAttachmentStream *attachmentStream in attachmentStreams) {
+        [urls addObject:attachmentStream.originalMediaURL];
+    }
+
+    [AttachmentSharing showShareUIForActivityItems:urls completion:completion];
+}
+
 + (void)showShareUIForAttachment:(TSAttachmentStream *)stream
 {
     OWSAssertDebug(stream);

SignalServiceKit/src/Messages/Attachments/TSAttachment.h

@@ -64,6 +64,7 @@ typedef NS_ENUM(NSUInteger, TSAttachmentType) {
 @property (nonatomic, readonly) BOOL isVideo;
 @property (nonatomic, readonly) BOOL isAudio;
 @property (nonatomic, readonly) BOOL isVoiceMessage;
+@property (nonatomic, readonly) BOOL isVisualMedia;
 
 + (NSString *)emojiForMimeType:(NSString *)contentType;
 

SignalServiceKit/src/Messages/Attachments/TSAttachment.m

@@ -220,6 +220,23 @@ NSUInteger const TSAttachmentSchemaVersion = 4;
     return self.attachmentType == TSAttachmentTypeVoiceMessage;
 }
 
+- (BOOL)isVisualMedia
+{
+    if (self.isImage) {
+        return YES;
+    }
+
+    if (self.isVideo) {
+        return YES;
+    }
+
+    if (self.isAnimated) {
+        return YES;
+    }
+
+    return NO;
+}
+
 - (nullable NSString *)sourceFilename
 {
     return _sourceFilename.filterFilename;

SignalServiceKit/src/Messages/Attachments/TSAttachmentStream.h

@@ -93,7 +93,7 @@ typedef void (^OWSThumbnailFailure)(void);
 
 @property (nonatomic, readonly) BOOL isValidImage;
 @property (nonatomic, readonly) BOOL isValidVideo;
-@property (nonatomic, readonly) BOOL isValidMedia;
+@property (nonatomic, readonly) BOOL isValidVisualMedia;
 
 #pragma mark - Update With... Methods
 

SignalServiceKit/src/Messages/Attachments/TSAttachmentStream.m

@@ -329,7 +329,7 @@ typedef void (^OWSLoadedThumbnailSuccess)(OWSLoadedThumbnail *loadedThumbnail);
     [self removeFileWithTransaction:transaction];
 }
 
-- (BOOL)isValidMedia
+- (BOOL)isValidVisualMedia
 {
     if (self.isImage && self.isValidImage) {
         return YES;

SignalServiceKit/src/Messages/Interactions/TSMessage.h

@@ -43,6 +43,8 @@ NS_ASSUME_NONNULL_BEGIN
 - (BOOL)hasAttachments;
 - (NSArray<TSAttachment *> *)attachmentsWithTransaction:(YapDatabaseReadTransaction *)transaction;
 
+- (BOOL)isMediaGalleryWithTransaction:(YapDatabaseReadTransaction *)transaction;
+
 - (void)setQuotedMessageThumbnailAttachmentStream:(TSAttachmentStream *)attachmentStream;
 
 - (nullable NSString *)oversizeTextWithTransaction:(YapDatabaseReadTransaction *)transaction;

SignalServiceKit/src/Messages/Interactions/TSMessage.m

@@ -214,6 +214,20 @@ static const NSUInteger OWSMessageSchemaVersion = 4;
     return [attachments copy];
 }
 
+- (BOOL)isMediaGalleryWithTransaction:(YapDatabaseReadTransaction *)transaction
+{
+    NSArray<TSAttachment *> *attachments = [self attachmentsWithTransaction:transaction];
+    if (attachments.count < 1) {
+        return NO;
+    }
+    for (TSAttachment *attachment in attachments) {
+        if (!attachment.isVisualMedia) {
+            return NO;
+        }
+    }
+    return YES;
+}
+
 - (NSString *)debugDescription
 {
     if ([self hasAttachments] && self.body.length > 0) {

SignalServiceKit/src/Storage/OWSMediaGalleryFinder.m

@@ -180,7 +180,7 @@ static NSString *const OWSMediaGalleryFinderExtensionName = @"OWSMediaGalleryFin
         return NO;
     }
 
-    return attachment.isValidMedia;
+    return attachment.isValidVisualMedia;
 }
 
 @end