iOS/Sources/Shared/API/Models/NotificationCategory.swift

//
//  NotificationCategory.swift
//  HomeAssistant
//
//  Created by Robert Trencheny on 9/28/18.
//  Copyright © 2018 Robbie Trencheny. All rights reserved.
//

import Foundation
import RealmSwift
import UserNotifications

final public class NotificationCategory: Object, UpdatableModel {
    public static let FallbackActionIdentifier = "_"

    @objc public dynamic var isServerControlled: Bool = false

    @objc public dynamic var Name: String = ""
    @objc public dynamic var Identifier: String = ""
    @objc public dynamic var HiddenPreviewsBodyPlaceholder: String?
    // iOS 12+ only
    @objc public dynamic var CategorySummaryFormat: String?

    // Options
    @objc public dynamic var SendDismissActions: Bool = true
    @objc public dynamic var HiddenPreviewsShowTitle: Bool = false
    @objc public dynamic var HiddenPreviewsShowSubtitle: Bool = false

    // Maybe someday, HA will be on CarPlay (hey that rhymes!)...
    // @objc dynamic var AllowInCarPlay: Bool = false

    public var Actions = List<NotificationAction>()

    override public static func primaryKey() -> String? {
        return "Identifier"
    }

    public var options: UNNotificationCategoryOptions {
        var categoryOptions = UNNotificationCategoryOptions([])

        if self.SendDismissActions { categoryOptions.insert(.customDismissAction) }

        #if os(iOS)
            if self.HiddenPreviewsShowTitle { categoryOptions.insert(.hiddenPreviewsShowTitle) }
            if self.HiddenPreviewsShowSubtitle { categoryOptions.insert(.hiddenPreviewsShowSubtitle) }
        #endif

        return categoryOptions
    }

    #if os(iOS)
    public var categories: [UNNotificationCategory] {
        let allActions = Array(self.Actions.map({ $0.action }))

        // both lowercase and uppercase since this is a point of confusion
        return [ Identifier.uppercased(), Identifier.lowercased() ].map { anIdentifier in
            if #available(iOS 12.0, *) {
                return UNNotificationCategory(identifier: anIdentifier, actions: allActions, intentIdentifiers: [],
                                              hiddenPreviewsBodyPlaceholder: self.HiddenPreviewsBodyPlaceholder,
                                              categorySummaryFormat: self.CategorySummaryFormat,
                                              options: self.options)
            } else if let placeholder = self.HiddenPreviewsBodyPlaceholder {
                return UNNotificationCategory(identifier: anIdentifier, actions: allActions, intentIdentifiers: [],
                                              hiddenPreviewsBodyPlaceholder: placeholder,
                                              options: self.options)
            } else {
                return UNNotificationCategory(identifier: anIdentifier, actions: allActions,
                                              intentIdentifiers: [], options: self.options)
            }
        }
    }
    #endif

    public var exampleServiceCall: String {
        let urlStrings = Actions.map { "\"\($0.Identifier)\": \"http://example.com/url\"" }

        let indentation = "\n    "

        return """
        service: notify.mobile_app_#name_here
        data:
          push:
            category: \(Identifier.uppercased())
          action_data:
            # see example trigger in action
            # value will be in fired event

          # url can be absolute path like:
          # "http://example.com/url"
          # or relative like:
          # "/lovelace/dashboard"

          # pick one of the following styles:

          # always open when opening notification
          url: "/lovelace/dashboard"

          # open a different url per action
          # use "\(Self.FallbackActionIdentifier)" as key for no action chosen
          url:
            "\(Self.FallbackActionIdentifier)": "http://example.com/fallback"
            \(urlStrings.joined(separator: indentation))
        """
    }

    static func didUpdate(objects: [NotificationCategory], realm: Realm) {

    }

    static func willDelete(objects: [NotificationCategory], realm: Realm) {

    }

    static var updateEligiblePredicate: NSPredicate {
        .init(format: "isServerControlled == YES")
    }

    public func update(with object: MobileAppConfigPushCategory, using realm: Realm) {
        if self.realm == nil {
            Identifier = object.identifier.uppercased()
        } else {
            precondition(Identifier == object.identifier.uppercased())
        }

        isServerControlled = true
        Name = object.name

        // todo: update
        realm.delete(Actions)
        Actions.removeAll()

        Actions.append(objectsIn: (object.actions).map { action in
            with(NotificationAction()) {
                $0.isServerControlled = true
                $0.Title = action.title
                $0.Identifier = action.identifier
                $0.AuthenticationRequired = action.authenticationRequired
                $0.Foreground = (action.activationMode.lowercased() == "foreground")
                $0.Destructive = action.destructive
                $0.TextInput = (action.behavior.lowercased() == "textinput")
                if let title = action.textInputButtonTitle {
                    $0.TextInputButtonTitle = title
                } else {
                    $0.TextInputButtonTitle = L10n.NotificationsConfigurator.Action.Rows.TextInputButtonTitle.title
                }
                if let placeholder = action.textInputPlaceholder {
                    $0.TextInputPlaceholder = placeholder
                } else {
                    $0.TextInputPlaceholder = L10n.NotificationsConfigurator.Action.Rows.TextInputPlaceholder.title
                }
            }
        })
    }
}