RemoteBlogSettings.swift

import Foundation

/// This class encapsulates all of the *remote* settings available for a Blog entity
///
public class RemoteBlogSettings: NSObject {
    // MARK: - General

    /// Represents the Blog Name.
    ///
    @objc public var name: String?

    /// Stores the Blog's Tagline setting.
    ///
    @objc public var tagline: String?

    /// Stores the Blog's Privacy Preferences Settings
    ///
    @objc public var privacy: NSNumber?

    /// Stores the Blog's Language ID Setting
    ///
    @objc public var languageID: NSNumber?

    /// Stores the Blog's Icon Media ID
    ///
    @objc public var iconMediaID: NSNumber?

    /// Stores the Blog's GMT offset
    ///
    @objc public var gmtOffset: NSNumber?

    /// Stores the Blog's timezone
    ///
    @objc public var timezoneString: String?

    // MARK: - Writing

    /// Contains the Default Category ID. Used when creating new posts.
    ///
    @objc public var defaultCategoryID: NSNumber?

    /// Contains the Default Post Format. Used when creating new posts.
    ///
    @objc public var defaultPostFormat: String?

    /// The blog's date format setting.
    ///
    @objc public var dateFormat: String?

    /// The blog's time format setting
    ///
    @objc public var timeFormat: String?

    /// The blog's chosen day to start the week setting
    ///
    @objc public var startOfWeek: String?

    /// Numbers of posts per page
    ///
    @objc public var postsPerPage: NSNumber?

    // MARK: - Discussion

    /// Represents whether comments are allowed, or not.
    ///
    @objc public var commentsAllowed: NSNumber?

    /// Contains a list of words that would automatically blocklist a comment.
    ///
    @objc public var commentsBlocklistKeys: String?

    /// If true, comments will be automatically closed after the number of days, specified by `commentsCloseAutomaticallyAfterDays`.
    ///
    @objc public var commentsCloseAutomatically: NSNumber?

    /// Represents the number of days comments will be enabled, granted that the `commentsCloseAutomatically`
    /// property is set to true.
    ///
    @objc public var commentsCloseAutomaticallyAfterDays: NSNumber?

    /// When enabled, comments from known users will be allowlisted.
    ///
    @objc public var commentsFromKnownUsersAllowlisted: NSNumber?

    /// Indicates the maximum number of links allowed per comment. When a new comment exceeds this number,
    /// it'll be held in queue for moderation.
    ///
    @objc public var commentsMaximumLinks: NSNumber?

    /// Contains a list of words that cause a comment to require moderation.
    ///
    @objc public var commentsModerationKeys: String?

    /// If true, comment pagination will be enabled.
    ///
    @objc public var commentsPagingEnabled: NSNumber?

    /// Specifies the number of comments per page. This will be used only if the property `commentsPagingEnabled`
    /// is set to true.
    ///
    @objc public var commentsPageSize: NSNumber?

    /// When enabled, new comments will require Manual Moderation, before showing up.
    ///
    @objc public var commentsRequireManualModeration: NSNumber?

    /// If set to true, commenters will be required to enter their name and email.
    ///
    @objc public var commentsRequireNameAndEmail: NSNumber?

    /// Specifies whether commenters should be registered or not.
    ///
    @objc public var commentsRequireRegistration: NSNumber?

    /// Indicates the sorting order of the comments. Ascending / Descending, based on the date.
    ///
    @objc public var commentsSortOrder: String?

    /// Indicates the number of levels allowed per comment.
    ///
    @objc public var commentsThreadingDepth: NSNumber?

    /// When enabled, comment threading will be supported.
    ///
    @objc public var commentsThreadingEnabled: NSNumber?

    /// If set to true, 3rd party sites will be allowed to post pingbacks.
    ///
    @objc public var pingbackInboundEnabled: NSNumber?

    /// When Outbound Pingbacks are enabled, 3rd party sites that get linked will be notified.
    ///
    @objc public var pingbackOutboundEnabled: NSNumber?

    // MARK: - Related Posts

    /// When set to true, Related Posts will be allowed.
    ///
    @objc public var relatedPostsAllowed: NSNumber?

    /// When set to true, Related Posts will be enabled.
    ///
    @objc public var relatedPostsEnabled: NSNumber?

    /// Indicates whether related posts should show a headline.
    ///
    @objc public var relatedPostsShowHeadline: NSNumber?

    /// Indicates whether related posts should show thumbnails.
    ///
    @objc public var relatedPostsShowThumbnails: NSNumber?

    // MARK: - AMP

    /// Indicates if AMP is supported on the site
    ///
    @objc public var ampSupported: NSNumber?

    /// Indicates if AMP is enabled on the site
    ///
    @objc public var ampEnabled: NSNumber?

    // MARK: - Sharing

    /// Indicates the style to use for the sharing buttons on a particular blog..
    ///
    @objc public var sharingButtonStyle: String?

    /// The title of the sharing label on the user's blog.
    ///
    @objc public var sharingLabel: String?

    /// Indicates the twitter username to use when sharing via Twitter
    ///
    @objc public var sharingTwitterName: String?

    /// Indicates whether related posts should show thumbnails.
    ///
    @objc public var sharingCommentLikesEnabled: NSNumber?

    /// Indicates whether sharing via post likes has been disabled
    ///
    @objc public var sharingDisabledLikes: NSNumber?

    /// Indicates whether sharing by reblogging has been disabled
    ///
    @objc public var sharingDisabledReblogs: NSNumber?

    // Defined as CodingKey-conforming already to simplify Codable support in the future.
    enum CodingKeys: String, CodingKey {
        case name = "name"
        case tagline = "description"
        case privacy = "blog_public"
        case languageID = "lang_id"
        case iconMediaID = "site_icon"
        case gmtOffset = "gmt_offset"
        case timezoneString = "timezone_string"
        case settings = "settings"
        case defaultCategory = "default_category"
        case defaultPostFormat = "default_post_format"
        case dateFormat = "date_format"
        case timeFormat = "time_format"
        case startOfWeek = "start_of_week"
        case postsPerPage = "posts_per_page"
        case commentsAllowed = "default_comment_status"
        case commentsBlocklistKeys = "blacklist_keys"
        case commentsCloseAutomatically = "close_comments_for_old_posts"
        case commentsCloseAutomaticallyAfterDays = "close_comments_days_old"
        case commentsKnownUsersAllowlist = "comment_whitelist"
        case commentsMaxLinks = "comment_max_links"
        case commentsModerationKeys = "moderation_keys"
        case commentsPagingEnabled = "page_comments"
        case commentsPageSize = "comments_per_page"
        case commentsRequireModeration = "comment_moderation"
        case commentsRequireNameAndEmail = "require_name_email"
        case commentsRequireRegistration = "comment_registration"
        case commentsSortOrder = "comment_order"
        case commentsThreadingEnabled = "thread_comments"
        case commentsThreadingDepth = "thread_comments_depth"
        case pingbackOutbound = "default_pingback_flag"
        case pingbackInbound = "default_ping_status"
        case relatedPostsAllowed = "jetpack_relatedposts_allowed"
        case relatedPostsEnabled = "jetpack_relatedposts_enabled"
        case relatedPostsShowHeadline = "jetpack_relatedposts_show_headline"
        case relatedPostsShowThumbnails = "jetpack_relatedposts_show_thumbnails"
        case ampSupported = "amp_is_supported"
        case ampEnabled = "amp_is_enabled"

        case sharingButtonStyle = "sharing_button_style"
        case sharingLabel = "sharing_label"
        case sharingTwitterName = "twitter_via"
        case sharingCommentLikesEnabled = "jetpack_comment_likes_enabled"
        case sharingDisabledLikes = "disabled_likes"
        case sharingDisabledReblogs = "disabled_reblogs"
    }

    /// Parses details from a JSON dictionary, as returned by the WordPress.com REST API.
    @objc
    public init(jsonDictionary json: [String: Any]) {
        let rawSettings = json[CodingKeys.settings.rawValue] as? [String: Any] ?? [:]

        name = json[CodingKeys.name.rawValue] as? String
        tagline = json[CodingKeys.tagline.rawValue] as? String
        privacy = rawSettings[CodingKeys.privacy.rawValue] as? NSNumber
        // The value here can be a String, so we need a custom conversion
        languageID = rawSettings.number(forKey: CodingKeys.languageID.rawValue)
        iconMediaID = rawSettings[CodingKeys.iconMediaID.rawValue] as? NSNumber
        // The value here can be a String, so we need a custom conversion
        gmtOffset = rawSettings.number(forKey: CodingKeys.gmtOffset.rawValue)
        timezoneString = rawSettings[CodingKeys.timezoneString.rawValue] as? String

        defaultCategoryID = rawSettings[CodingKeys.defaultCategory.rawValue] as? NSNumber ?? 1

        // Note: the backend might send '0' as a number, OR a string value.
        // See https://github.com/wordpress-mobile/WordPress-iOS/issues/4187
        let defaultPostFormatValue = rawSettings[CodingKeys.defaultPostFormat.rawValue]
        if let defaultPostFormatNumber = defaultPostFormatValue as? NSNumber, defaultPostFormatNumber == 0 ||
           defaultPostFormatValue as? String == "0" {
            defaultPostFormat = "standard"
        } else {
            defaultPostFormat = defaultPostFormatValue as? String
        }

        dateFormat = rawSettings[CodingKeys.dateFormat.rawValue] as? String
        timeFormat = rawSettings[CodingKeys.timeFormat.rawValue] as? String
        startOfWeek = rawSettings[CodingKeys.startOfWeek.rawValue] as? String
        postsPerPage = rawSettings[CodingKeys.postsPerPage.rawValue] as? NSNumber

        commentsAllowed = rawSettings[CodingKeys.commentsAllowed.rawValue] as? NSNumber
        commentsBlocklistKeys = rawSettings[CodingKeys.commentsBlocklistKeys.rawValue] as? String
        commentsCloseAutomatically = rawSettings[CodingKeys.commentsCloseAutomatically.rawValue] as? NSNumber
        commentsCloseAutomaticallyAfterDays = rawSettings[CodingKeys.commentsCloseAutomaticallyAfterDays.rawValue] as? NSNumber
        commentsFromKnownUsersAllowlisted = rawSettings[CodingKeys.commentsKnownUsersAllowlist.rawValue] as? NSNumber
        commentsMaximumLinks = rawSettings[CodingKeys.commentsMaxLinks.rawValue] as? NSNumber
        commentsModerationKeys = rawSettings[CodingKeys.commentsModerationKeys.rawValue] as? String
        commentsPagingEnabled = rawSettings[CodingKeys.commentsPagingEnabled.rawValue] as? NSNumber
        commentsPageSize = rawSettings[CodingKeys.commentsPageSize.rawValue] as? NSNumber
        commentsRequireManualModeration = rawSettings[CodingKeys.commentsRequireModeration.rawValue] as? NSNumber
        commentsRequireNameAndEmail = rawSettings[CodingKeys.commentsRequireNameAndEmail.rawValue] as? NSNumber
        commentsRequireRegistration = rawSettings[CodingKeys.commentsRequireRegistration.rawValue] as? NSNumber
        commentsSortOrder = rawSettings[CodingKeys.commentsSortOrder.rawValue] as? String
        commentsThreadingEnabled = rawSettings[CodingKeys.commentsThreadingEnabled.rawValue] as? NSNumber
        commentsThreadingDepth = rawSettings[CodingKeys.commentsThreadingDepth.rawValue] as? NSNumber
        pingbackOutboundEnabled = rawSettings[CodingKeys.pingbackOutbound.rawValue] as? NSNumber
        pingbackInboundEnabled = rawSettings[CodingKeys.pingbackInbound.rawValue] as? NSNumber

        relatedPostsAllowed = rawSettings[CodingKeys.relatedPostsAllowed.rawValue] as? NSNumber
        relatedPostsEnabled = rawSettings[CodingKeys.relatedPostsEnabled.rawValue] as? NSNumber
        relatedPostsShowHeadline = rawSettings[CodingKeys.relatedPostsShowHeadline.rawValue] as? NSNumber
        relatedPostsShowThumbnails = rawSettings[CodingKeys.relatedPostsShowThumbnails.rawValue] as? NSNumber

        ampSupported = rawSettings[CodingKeys.ampSupported.rawValue] as? NSNumber
        ampEnabled = rawSettings[CodingKeys.ampEnabled.rawValue] as? NSNumber

        sharingButtonStyle = rawSettings[CodingKeys.sharingButtonStyle.rawValue] as? String
        sharingLabel = rawSettings[CodingKeys.sharingLabel.rawValue] as? String
        sharingTwitterName = rawSettings[CodingKeys.sharingTwitterName.rawValue] as? String
        sharingCommentLikesEnabled = rawSettings[CodingKeys.sharingCommentLikesEnabled.rawValue] as? NSNumber
        sharingDisabledLikes = rawSettings[CodingKeys.sharingDisabledLikes.rawValue] as? NSNumber
        sharingDisabledReblogs = rawSettings[CodingKeys.sharingDisabledReblogs.rawValue] as? NSNumber
    }

    @objc
    public var dictionaryRepresentation: [String: Any] {
        var parameters: [String: Any] = [:]

        // name and tagline/description use different keys...
        parameters["blogname"] = name
        parameters["blogdescription"] = tagline

        parameters[CodingKeys.privacy.rawValue] = privacy
        parameters[CodingKeys.languageID.rawValue] = languageID
        parameters[CodingKeys.iconMediaID.rawValue] = iconMediaID
        parameters[CodingKeys.gmtOffset.rawValue] = gmtOffset
        parameters[CodingKeys.timezoneString.rawValue] = timezoneString

        parameters[CodingKeys.defaultCategory.rawValue] = defaultCategoryID
        parameters[CodingKeys.defaultPostFormat.rawValue] = defaultPostFormat
        parameters[CodingKeys.dateFormat.rawValue] = dateFormat
        parameters[CodingKeys.timeFormat.rawValue] = timeFormat
        parameters[CodingKeys.startOfWeek.rawValue] = startOfWeek
        parameters[CodingKeys.postsPerPage.rawValue] = postsPerPage

        parameters[CodingKeys.commentsAllowed.rawValue] = commentsAllowed
        parameters[CodingKeys.commentsBlocklistKeys.rawValue] = commentsBlocklistKeys
        parameters[CodingKeys.commentsCloseAutomatically.rawValue] = commentsCloseAutomatically
        parameters[CodingKeys.commentsCloseAutomaticallyAfterDays.rawValue] = commentsCloseAutomaticallyAfterDays
        parameters[CodingKeys.commentsKnownUsersAllowlist.rawValue] = commentsFromKnownUsersAllowlisted
        parameters[CodingKeys.commentsMaxLinks.rawValue] = commentsMaximumLinks
        parameters[CodingKeys.commentsModerationKeys.rawValue] = commentsModerationKeys
        parameters[CodingKeys.commentsPagingEnabled.rawValue] = commentsPagingEnabled
        parameters[CodingKeys.commentsPageSize.rawValue] = commentsPageSize
        parameters[CodingKeys.commentsRequireModeration.rawValue] = commentsRequireManualModeration
        parameters[CodingKeys.commentsRequireNameAndEmail.rawValue] = commentsRequireNameAndEmail
        parameters[CodingKeys.commentsRequireRegistration.rawValue] = commentsRequireRegistration
        parameters[CodingKeys.commentsSortOrder.rawValue] = commentsSortOrder
        parameters[CodingKeys.commentsThreadingEnabled.rawValue] = commentsThreadingEnabled
        parameters[CodingKeys.commentsThreadingDepth.rawValue] = commentsThreadingDepth

        parameters[CodingKeys.pingbackOutbound.rawValue] = pingbackOutboundEnabled
        parameters[CodingKeys.pingbackInbound.rawValue] = pingbackInboundEnabled

        // Note: releatedPostsAllowed was not set in the Objective-C implementation.
        // There was no comment about it, so I assumed it was simply something that was never noticed.
        parameters[CodingKeys.relatedPostsAllowed.rawValue] = relatedPostsAllowed
        parameters[CodingKeys.relatedPostsEnabled.rawValue] = relatedPostsEnabled
        parameters[CodingKeys.relatedPostsShowHeadline.rawValue] = relatedPostsShowHeadline
        parameters[CodingKeys.relatedPostsShowThumbnails.rawValue] = relatedPostsShowThumbnails

        // Note: ampSupported was not set in the Objective-C implementation.
        // There was no comment about it, so I assumed it was simply something that was never noticed.
        parameters[CodingKeys.ampSupported.rawValue] = ampSupported
        parameters[CodingKeys.ampEnabled.rawValue] = ampEnabled

        parameters[CodingKeys.sharingButtonStyle.rawValue] = sharingButtonStyle
        parameters[CodingKeys.sharingLabel.rawValue] = sharingLabel
        parameters[CodingKeys.sharingTwitterName.rawValue] = sharingTwitterName
        parameters[CodingKeys.sharingCommentLikesEnabled.rawValue] = sharingCommentLikesEnabled
        parameters[CodingKeys.sharingDisabledLikes.rawValue] = sharingDisabledLikes
        parameters[CodingKeys.sharingDisabledReblogs.rawValue] = sharingDisabledReblogs

        return parameters
    }

    // MARK: - Helpers

    /// Computed property, meant to help conversion from Remote / String-Based values, into their Integer counterparts
    ///
    @objc public var commentsSortOrderAscending: Bool {
        set {
            commentsSortOrder = newValue ? RemoteBlogSettings.AscendingStringValue :  RemoteBlogSettings.DescendingStringValue
        }
        get {
            return commentsSortOrder == RemoteBlogSettings.AscendingStringValue
        }
    }

    // MARK: - Private

    private static let AscendingStringValue     = "asc"
    private static let DescendingStringValue    = "desc"
}

extension Dictionary where Key == String {

    func number(forKey key: String) -> NSNumber? {
        guard let value = self[key] else { return .none }

        if let value = value as? NSNumber {
            return value
        } else if let value = value as? String {
            let numberFormatter = NumberFormatter()
            numberFormatter.numberStyle = .none
            return numberFormatter.number(from: value)
        } else {
            return .none
        }
    }
}