OSInAppMessageInternal.m

/**
 * Modified MIT License
 *
 * Copyright 2017 OneSignal
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * 1. The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * 2. All copies of substantial portions of the Software may only be used in connection
 * with services provided by OneSignal.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#import "OSInAppMessageInternal.h"
#import "NSDateFormatter+OneSignal.h"
#import "OneSignalCommonDefines.h"
#import <OneSignalCore/OSMacros.h>

@implementation OSInAppMessage

- (NSDictionary *)jsonRepresentation {
    NSMutableDictionary *json = [NSMutableDictionary new];
    json[@"messageId"] = self.messageId;
    return json;
}

@end

@interface OSInAppMessageInternal ()

@property (strong, nonatomic, nonnull) NSMutableSet <NSString *> *clickedClickIds;
@property (strong, nonatomic, nonnull) NSMutableSet <NSString *> *viewedPageIds;

@end

@implementation OSInAppMessageInternal

- (instancetype)init {
    if (self = [super init]) {
        self.clickedClickIds = [[NSMutableSet alloc] init];
        self.viewedPageIds = [NSMutableSet new];
        self.isTriggerChanged = false;
    }
    
    return self;
}

- (BOOL)isBanner {
    return self.position == OSInAppMessageDisplayPositionTop || self.position == OSInAppMessageDisplayPositionBottom;
}

- (BOOL)takeActionAsUnique {
    if (self.actionTaken)
        return false;
    return self.actionTaken = true;
}

- (BOOL)isClickAvailable:(NSString *)clickId {
    return ![_clickedClickIds containsObject:clickId];
}

- (void)clearClickIds {
    _clickedClickIds = [NSMutableSet new];
}

- (void)addClickId:(NSString *)clickId {
    [_clickedClickIds addObject:clickId];
}

- (NSSet<NSString *> *)getClickedClickIds {
    return _clickedClickIds;
}

+ (instancetype)instanceWithData:(NSData *)data {
    NSError *error;
    NSDictionary *json = [NSJSONSerialization JSONObjectWithData:data options:0 error:&error];
    
    if (error || !json) {
        [OneSignalLog onesignalLog:ONE_S_LL_ERROR message:[NSString stringWithFormat:@"Unable to decode in-app message JSON: %@", error.description ?: @"No Data"]];
        return nil;
    }
    
    return [self instanceWithJson:json];
}

+ (instancetype)instanceWithJson:(NSDictionary * _Nonnull)json {
    let message = [OSInAppMessageInternal new];
    
    // "id" is expected instead of "messageId" when parsing JSON from the backend
    if (json[@"id"] && [json[@"id"] isKindOfClass:[NSString class]])
        message.messageId = json[@"id"];
    else
        return nil;
    
    if (json[@"variants"] && [json[@"variants"] isKindOfClass:[NSDictionary class]])
        message.variants = json[@"variants"];
    else
        return nil;
    
    if (json[@"redisplay"] && [json[@"redisplay"] isKindOfClass:[NSDictionary class]])
        message.displayStats = [OSInAppMessageDisplayStats instanceWithJson:json[@"redisplay"]];
    else
        message.displayStats = [[OSInAppMessageDisplayStats alloc] init];
    
    if (json[@"end_time"] && [json[@"end_time"] isKindOfClass:[NSString class]]) {
        NSString *stringEndTime = json[@"end_time"];
        NSDateFormatter *dateFormatter = [NSDateFormatter iso8601DateFormatter];
        NSDate *endTime = [dateFormatter dateFromString:stringEndTime];
        message.endTime = endTime;
    }
    
    if (json[@"has_liquid"]) {
        message.hasLiquid = YES;
    }

    if (json[@"is_preview"]) {
        message.isPreview = YES;
    }

    if (json[@"triggers"] && [json[@"triggers"] isKindOfClass:[NSArray class]]) {
        let triggers = [NSMutableArray new];
        
        for (NSArray *list in (NSArray *)json[@"triggers"]) {
            let subTriggers = [NSMutableArray new];
            
            for (NSDictionary *triggerJson in list) {
                let trigger = [OSTrigger instanceWithJson:triggerJson];
                
                if (trigger)
                    [subTriggers addObject:trigger];
                else {
                    [OneSignalLog onesignalLog:ONE_S_LL_WARN message:[NSString stringWithFormat:@"Trigger JSON is invalid: %@", triggerJson]];
                    return nil;
                }
            }
            
            [triggers addObject:subTriggers];
        }
        
        message.triggers = triggers;
    }
    else
        return nil;

    return message;
}

+ (instancetype)instancePreviewFromNotification:(OSNotification *)notification {
    let message = [OSInAppMessageInternal new];
    message.messageId = [notification additionalData][ONESIGNAL_IAM_PREVIEW];
    message.isPreview = true;
    return message;
}

- (NSDictionary *)jsonRepresentationInternal {
    let json = [NSMutableDictionary new];
    
    json[@"messageId"] = self.messageId;
    json[@"variants"] = self.variants;
    
    let triggers = [NSMutableArray new];
    
    for (NSArray *andBlock in self.triggers) {
        let andConditions = [NSMutableArray new];
        
        for (OSTrigger *trigger in andBlock)
            [andConditions addObject:trigger.jsonRepresentation];
        
        [triggers addObject:andConditions];
    }
    
    json[@"triggers"] = triggers;
    
    if ([_displayStats isRedisplayEnabled]) {
        json[@"redisplay"] = [_displayStats jsonRepresentation];
    }
    
    json[@"end_time"] = [[NSDateFormatter iso8601DateFormatter] stringFromDate:self.endTime];
    
    if (self.hasLiquid) {
        json[@"has_liquid"] = @true;
    }

    if (self.isPreview) {
        json[@"is_preview"] = @true;
    }
    
    return json;
}

- (NSString *)description {
    return [NSString stringWithFormat:@"OSInAppMessage:  \nmessageId: %@  \ntriggers: %@ \ndisplayed_in_session: %@ \ndisplayStats: %@ \nendTime: %@ \nhasLiquid: %@", self.messageId, self.triggers, self.isDisplayedInSession ? @"YES" : @"NO", self.displayStats, self.endTime, self.hasLiquid ? @"YES" : @"NO"];
}

- (BOOL)isEqual:(id)object {
  if (self == object) {
    return YES;
  }

  if (![object isKindOfClass:[OSInAppMessageInternal class]]) {
    return NO;
  }

  OSInAppMessageInternal *iam = object;
    
  return [self.messageId isEqualToString:iam.messageId];
}

- (NSUInteger)hash {
    return [self.messageId hash];
}

- (void)encodeWithCoder:(NSCoder *)encoder {
    [encoder encodeObject:self.messageId forKey:@"messageId"];
    [encoder encodeObject:_variants forKey:@"variants"];
    [encoder encodeObject:_triggers forKey:@"triggers"];
    [encoder encodeObject:_displayStats forKey:@"displayStats"];
    //TODO: This will need to be changed when we add core data or database to iOS, see android implementation for reference
    [encoder encodeBool:_isDisplayedInSession forKey:@"displayed_in_session"];
    [encoder encodeObject:_endTime forKey:@"endTime"];
    [encoder encodeBool:_hasLiquid forKey:@"hasLiquid"];
}

- (id)initWithCoder:(NSCoder *)decoder {
    if (self = [super init]) {
        self.messageId = [decoder decodeObjectForKey:@"messageId"];
        _variants = [decoder decodeObjectForKey:@"variants"];
        _triggers = [decoder decodeObjectForKey:@"triggers"];
        _displayStats = [decoder decodeObjectForKey:@"displayStats"];
        //TODO: This will need to be changed when we add core data or database to iOS, see android implementation for reference
        _isDisplayedInSession = [decoder decodeBoolForKey:@"displayed_in_session"];
        _endTime = [decoder decodeObjectForKey:@"endTime"];
        _hasLiquid = [decoder decodeBoolForKey:@"hasLiquid"];
    }
    return self;
}

- (BOOL)isFinished {
    if (!self.endTime) {
        return NO;
    }
    return [self.endTime compare:[NSDate date]] == NSOrderedAscending;
}

@end