Notification Rich Text Support

WordPress/Classes/Extensions/NSAttributedString+Helpers.swift

@@ -0,0 +1,44 @@
+import Foundation
+
+
+extension NSAttributedString
+{
+    /**
+        Note:
+        This method will embed a collection of assets, in the specified NSRange's. Since NSRange is an ObjC struct,
+        you'll need to wrap it up into a NSValue instance!
+    */
+    public func stringByEmbeddingImageAttachments(embeds: [NSValue: UIImage]?) -> NSAttributedString {
+        // Allow nil embeds: behave as a simple NO-OP
+        if embeds == nil {
+            return self
+        }
+
+        // Proceed embedding!
+        let unwrappedEmbeds = embeds!
+        let theString       = self.mutableCopy() as NSMutableAttributedString
+        var rangeDelta      = 0
+
+        for (value, image) in unwrappedEmbeds {
+            let imageAttachment     = NSTextAttachment()
+            imageAttachment.bounds  = CGRect(origin: CGPointZero, size: image.size)
+            imageAttachment.image   = image
+
+            // Each embed is expected to add 1 char to the string. Compensate for that
+            let attachmentString    = NSAttributedString(attachment: imageAttachment)
+            var correctedRange      = value.rangeValue
+            correctedRange.location += rangeDelta
+
+            // Bounds Safety
+            let lastPosition        = correctedRange.location + correctedRange.length
+            if lastPosition <= theString.length {
+                theString.replaceCharactersInRange(correctedRange, withAttributedString: attachmentString)
+            }
+
+            rangeDelta += attachmentString.length
+
+        }
+
+        return theString
+    }
+}

WordPress/Classes/Extensions/NSParagraphStyle+Helpers.swift

@@ -3,11 +3,15 @@ import Foundation
 
 extension NSMutableParagraphStyle
 {
-    convenience init(minLineHeight: CGFloat, maxLineHeight: CGFloat, lineBreakMode: NSLineBreakMode, alignment: NSTextAlignment) {
+    convenience init(minLineHeight: CGFloat, lineBreakMode: NSLineBreakMode, alignment: NSTextAlignment) {
         self.init()
         self.minimumLineHeight  = minLineHeight
-        self.maximumLineHeight  = maxLineHeight
         self.lineBreakMode      = lineBreakMode
         self.alignment          = alignment
     }
+
+    convenience init(minLineHeight: CGFloat, maxLineHeight: CGFloat, lineBreakMode: NSLineBreakMode, alignment: NSTextAlignment) {
+        self.init(minLineHeight: minLineHeight, lineBreakMode: lineBreakMode, alignment: alignment)
+        self.maximumLineHeight  = maxLineHeight
+    }
 }

WordPress/Classes/Extensions/Notifications/NotificationBlock+Interface.swift

@@ -4,71 +4,85 @@ import Foundation
 extension NotificationBlock
 {
     public func subjectAttributedText() -> NSAttributedString {
-        if text == nil {
-            return NSAttributedString()
-        }
-
-        let theString = NSMutableAttributedString(string: text, attributes: WPStyleGuide.Notifications.subjectRegularStyle)
-
-        theString.applyAttributesToQuotes(WPStyleGuide.Notifications.subjectItalicsStyle)
-
-        for notificationRange in ranges as [NotificationRange] {
-
-            // Make sure this range is not of bounds!
-            let range = notificationRange.range
-            if range.location + range.length > theString.length {
-                continue
-            }
-
-            if notificationRange.isUser {
-                theString.addAttributes(WPStyleGuide.Notifications.subjectBoldStyle, range: range)
-            } else if notificationRange.isPost || notificationRange.isComment {
-                theString.addAttributes(WPStyleGuide.Notifications.subjectItalicsStyle, range: range)
-            }
-        }
-
-        return theString;
+        return textWithRangeStyles(isSubject: true)
     }
 
     public func snippetAttributedText() -> NSAttributedString {
         if text == nil {
             return NSAttributedString()
         }
 
-        return NSMutableAttributedString(string: text, attributes: WPStyleGuide.Notifications.snippetRegularStyle)
+        return NSAttributedString(string: text, attributes: Styles.snippetRegularStyle)
     }
 
-    public func regularAttributedText() -> NSAttributedString {
+    public func richAttributedText() -> NSAttributedString {
+        //  Operations such as editing a comment cause a lag between the REST and Simperium update.
+        //  TextOverride is a transient property meant to store, temporarily, the edited text
+        if textOverride != nil {
+            return NSAttributedString(string: textOverride, attributes: Styles.blockRegularStyle)
+        }
+
+        return textWithRangeStyles(isSubject: false)
+    }
+
+    public func buildRangesToImagesMap(mediaMap: [NSURL: UIImage]?) -> [NSValue: UIImage]? {
+        // If we've got a text override: Ranges may not match, and the new text may not even contain ranges!
+        if mediaMap == nil || textOverride != nil {
+            return nil
+        }
+
+        var ranges = [NSValue: UIImage]()
+
+        for theMedia in media as [NotificationMedia] {
+            if let image = mediaMap![theMedia.mediaURL] {
+                let rangeValue      = NSValue(range: theMedia.range)
+                ranges[rangeValue]  = image
+            }
+        }
+
+        return ranges
+    }
+
+
+    // MARK: - Private Helpers
+    private func textWithRangeStyles(#isSubject: Bool) -> NSAttributedString {
         if text == nil {
             return NSAttributedString()
         }
 
-        let theString = NSMutableAttributedString(string: text, attributes: WPStyleGuide.Notifications.blockRegularStyle)
+        // Setup the styles
+        let regularStyle    = isSubject ? Styles.subjectRegularStyle : (isBadge ? Styles.blockBadgeStyle : Styles.blockRegularStyle)
+        let quotesStyle     = isSubject ? Styles.subjectItalicsStyle : Styles.blockBoldStyle
+        let userStyle       = isSubject ? Styles.subjectBoldStyle    : Styles.blockBoldStyle
+        let postStyle       = isSubject ? Styles.subjectItalicsStyle : Styles.blockItalicsStyle
+        let commentStyle    = postStyle
+        let blockStyle      = Styles.blockQuotedStyle
 
-        theString.applyAttributesToQuotes(WPStyleGuide.Notifications.blockBoldStyle)
+        // Format the String
+        let theString = NSMutableAttributedString(string: text, attributes: regularStyle)
+        theString.applyAttributesToQuotes(quotesStyle)
 
         for range in ranges as [NotificationRange] {
-            if range.isPost {
-                theString.addAttributes(WPStyleGuide.Notifications.blockItalicsStyle, range: range.range)
+            if range.isUser {
+                theString.addAttributes(userStyle, range: range.range)
+            } else if range.isPost {
+                theString.addAttributes(postStyle, range: range.range)
+            } else if range.isComment {
+                theString.addAttributes(commentStyle, range: range.range)
             } else if range.isBlockquote {
-                theString.addAttributes(WPStyleGuide.Notifications.blockQuotedStyle, range: range.range)
+                theString.addAttributes(blockStyle, range: range.range)
             }
 
-            if range.url != nil {
+            // Don't Highlight Links in the subject
+            if isSubject == false && range.url != nil {
                 theString.addAttribute(NSLinkAttributeName, value: range.url, range: range.range)
-                theString.addAttribute(NSForegroundColorAttributeName, value: WPStyleGuide.Notifications.blockLinkColor, range: range.range)
+                theString.addAttribute(NSForegroundColorAttributeName, value: Styles.blockLinkColor, range: range.range)
             }
         }
 
         return theString
     }
-
-    public func regularAttributedTextOverride() -> NSAttributedString? {
-        //  Operations such as editing a comment cause a lag between the REST and Simperium update.
-        //  TextOverride is a transient property meant to store, temporarily, the edited text
-        if textOverride != nil {
-            return NSAttributedString(string: textOverride, attributes: WPStyleGuide.Notifications.blockRegularStyle)
-        }
-        return nil
-    }
+
+    private typealias Styles = WPStyleGuide.Notifications
 }
+

WordPress/Classes/Models/Notifications/Notification.h

@@ -19,10 +19,12 @@ extern NSString * NoteActionReplyKey;
 extern NSString * NoteActionApproveKey;
 extern NSString * NoteActionEditKey;
 
+extern NSString * NoteMediaTypeImage;
+
 typedef NS_ENUM(NSInteger, NoteBlockType)
 {
     NoteBlockTypeText,
-    NoteBlockTypeImage,                                    // BlockTypesImage: Includes Badges and Images
+    NoteBlockTypeImage,                                     // BlockTypesImage: Includes Badges and Images
     NoteBlockTypeUser,
     NoteBlockTypeComment
 };
@@ -32,9 +34,9 @@ typedef NS_ENUM(NSInteger, NoteBlockGroupType)
     NoteBlockGroupTypeText     = NoteBlockTypeText,
     NoteBlockGroupTypeImage    = NoteBlockTypeImage,
     NoteBlockGroupTypeUser     = NoteBlockTypeUser,
-    NoteBlockGroupTypeComment  = NoteBlockTypeComment,    // Contains a User + Comment Block
-    NoteBlockGroupTypeSubject  = 20,                       // Contains a User + Text Block
-    NoteBlockGroupTypeHeader   = 30                        // Contains a User + Text Block
+    NoteBlockGroupTypeComment  = NoteBlockTypeComment,      // Contains a User + Comment Block
+    NoteBlockGroupTypeSubject  = 20,                        // Contains a User + Text Block
+    NoteBlockGroupTypeHeader   = 30                         // Contains a User + Text Block
 };
 
 
@@ -94,6 +96,7 @@ typedef NS_ENUM(NSInteger, NoteBlockGroupType)
 @property (nonatomic, assign, readonly) NoteBlockGroupType type;
 
 - (NotificationBlock *)blockOfType:(NoteBlockType)type;
+- (NSSet *)imageUrlsForBlocksOfTypes:(NSSet *)types;
 
 @end
 
@@ -111,17 +114,18 @@ typedef NS_ENUM(NSInteger, NoteBlockGroupType)
 @property (nonatomic, strong, readonly) NSDictionary        *actions;
 
 // Derived Properties
-@property (nonatomic, assign, readonly) NoteBlockType      type;
+@property (nonatomic, assign, readonly) NoteBlockType       type;
+@property (nonatomic, assign, readonly) BOOL                isBadge;
 @property (nonatomic, strong, readonly) NSNumber            *metaSiteID;
 @property (nonatomic, strong, readonly) NSNumber            *metaCommentID;
 @property (nonatomic, strong, readonly) NSString            *metaLinksHome;
 @property (nonatomic, strong, readonly) NSString            *metaTitlesHome;
-@property (nonatomic, strong, readonly) NSString            *metaTitleOrUrl;
 
 // Overrides
 @property (nonatomic, strong, readwrite) NSString           *textOverride;
 
 - (NotificationRange *)notificationRangeWithUrl:(NSURL *)url;
+- (NSArray *)imageUrls;
 
 - (void)setActionOverrideValue:(NSNumber *)obj forKey:(NSString *)key;
 - (void)removeActionOverrideForKey:(NSString *)key;

WordPress/Classes/Models/Notifications/Notification.m

@@ -201,7 +201,8 @@ + (NSArray *)mediaFromArray:(NSArray *)rawMedia
 
 @interface NotificationBlock ()
 @property (nonatomic, strong, readwrite) NSMutableDictionary    *actionsOverride;
-@property (nonatomic, assign, readwrite) NoteBlockType         type;
+@property (nonatomic, assign, readwrite) NoteBlockType          type;
+@property (nonatomic, assign, readwrite) BOOL                   isBadge;
 @end
 
 
@@ -245,15 +246,6 @@ - (NSString *)metaTitlesHome
     return [[self.meta dictionaryForKey:NoteTitlesKey] stringForKey:NoteHomeKey];
 }
 
-- (NSString *)metaTitleOrUrl
-{
-    if ([self metaTitlesHome]) {
-        return [self metaTitlesHome];
-    }
-
-    return self.metaLinksHome.hostname;
-}
-
 - (NotificationRange *)notificationRangeWithUrl:(NSURL *)url
 {
     for (NotificationRange *range in self.ranges) {
@@ -265,6 +257,19 @@ - (NotificationRange *)notificationRangeWithUrl:(NSURL *)url
     return nil;
 }
 
+- (NSArray *)imageUrls
+{
+    NSMutableArray *urls = [NSMutableArray array];
+
+    for (NotificationMedia *media in self.media) {
+        if (media.isImage && media.mediaURL != nil) {
+            [urls addObject:media.mediaURL];
+        }
+    }
+
+    return urls;
+}
+
 - (void)setActionOverrideValue:(NSNumber *)value forKey:(NSString *)key
 {
     if (!_actionsOverride) {
@@ -301,6 +306,7 @@ + (NSArray *)blocksFromArray:(NSArray *)rawBlocks notification:(Notification *)n
     }
 
     NSMutableArray *parsed  = [NSMutableArray array];
+    BOOL isBadge = false;
 
     for (NSDictionary *rawDict in rawBlocks) {
         if (![rawDict isKindOfClass:[NSDictionary class]]) {
@@ -330,11 +336,24 @@ + (NSArray *)blocksFromArray:(NSArray *)rawBlocks notification:(Notification *)n
         } else {
             block.type = NoteBlockTypeText;
         }
-
+
+        // Figure out if this is a badge
+        for (NotificationMedia *media in block.media) {
+            if (media.isBadge) {
+                isBadge = true;
+            }
+        }
 
         [parsed addObject:block];
     }
 
+    // Note: Seriously. Duck typing should be abolished.
+    if (isBadge) {
+        for (NotificationBlock *block in parsed) {
+            block.isBadge = true;
+        }
+    }
+
     return parsed;
 }
 
@@ -346,8 +365,8 @@ + (NSArray *)blocksFromArray:(NSArray *)rawBlocks notification:(Notification *)n
 #pragma mark ====================================================================================
 
 @interface NotificationBlockGroup ()
-@property (nonatomic, strong) NSArray             *blocks;
-@property (nonatomic, assign) NoteBlockGroupType type;
+@property (nonatomic, strong) NSArray               *blocks;
+@property (nonatomic, assign) NoteBlockGroupType    type;
 @end
 
 @implementation NotificationBlockGroup
@@ -362,6 +381,24 @@ - (NotificationBlock *)blockOfType:(NoteBlockType)type
     return nil;
 }
 
+- (NSSet *)imageUrlsForBlocksOfTypes:(NSSet *)types
+{
+    NSMutableSet *urls = [NSMutableSet set];
+
+    for (NotificationBlock *block in self.blocks) {
+        if ([types containsObject:@(block.type)] == false) {
+            continue;
+        }
+
+        NSArray *imageUrls = [block imageUrls];
+        if (imageUrls) {
+            [urls addObjectsFromArray:imageUrls];
+        }
+    }
+
+    return urls;
+}
+
 + (NotificationBlockGroup *)groupWithBlocks:(NSArray *)blocks type:(NoteBlockGroupType)type
 {
     NotificationBlockGroup *group   = [self new];
@@ -549,10 +586,8 @@ - (BOOL)isBadge
     //
     for (NotificationBlockGroup *group in self.bodyBlockGroups) {
         for (NotificationBlock *block in group.blocks) {
-            for (NotificationMedia *media in block.media) {
-                if (media.isBadge) {
-                    return true;
-                }
+            if (block.isBadge) {
+                return true;
             }
         }
     }

WordPress/Classes/System/WordPress-Bridging-Header.h

@@ -1,5 +1,8 @@
+#import <AFNetworking/AFNetworking.h>
 #import <AFNetworking/UIKit+AFNetworking.h>
 
+#import <MGImageUtilities/UIImage+ProportionalFill.h>
+
 #import "Notification.h"
 
 #import "DDLogSwift.h"