SideStore/AltStoreCore/Model/Source.swift

//
//  Source.swift
//  AltStore
//
//  Created by Riley Testut on 7/30/19.
//  Copyright © 2019 Riley Testut. All rights reserved.
//

import CoreData
import UIKit

public extension Source
{
    #if ALPHA
    static let altStoreGroupIdentifier = Bundle.Info.appbundleIdentifier
    #else
    static let altStoreGroupIdentifier = Bundle.Info.appbundleIdentifier
    #endif
    
    #if STAGING
    
    #if ALPHA
    static let altStoreSourceURL = URL(string: "https://apps.sidestore.io/")!
    #else
    static let altStoreSourceURL = URL(string: "https://apps.sidestore.io/")!
    #endif
    
    #else
    
    #if ALPHA
    static let altStoreSourceURL = URL(string: "https://sidestore.io/apps-v2.json/")!
    #else
    static let altStoreSourceURL = URL(string: "https://sidestore.io/apps-v2.json/")!
    #endif
    
    #endif
    
    // normalized url is the source identifier (or) p-key!
    static let altStoreIdentifier = try! Source.sourceID(from: altStoreSourceURL)
}

// public struct AppPermissionFeed: Codable {
//     let type: String // ALTAppPermissionType
//     let usageDescription: String
       
//     enum CodingKeys: String, CodingKey
//     {
//         case type
//         case usageDescription
//     }
// }

// public struct AppVersionFeed: Codable {
//     /* Properties */
//     let version: String
//     let date: Date
//     let localizedDescription: String?
    
//     let downloadURL: URL
//     let size: Int64
//     // added in 0.6.0
//     let sha256: String?     // sha 256 of the uploaded IPA
    
//     enum CodingKeys: String, CodingKey
//     {
//         case version
//         case date
//         case localizedDescription
//         case downloadURL
//         case size
//         // added in 0.6.0
//         case sha256
//     }
// }

// public struct PlatformURLFeed: Codable {
//     /* Properties */
//     let platform: Platform
//     let downloadURL: URL
    
    
//     private enum CodingKeys: String, CodingKey
//     {
//         case platform
//         case downloadURL
//     }
// }


// public struct StoreAppFeed: Codable {
//     let name: String
//     let bundleIdentifier: String
//     let subtitle: String?
    
//     let developerName: String
//     let localizedDescription: String
//     let size: Int64
    
//     let iconURL: URL
//     let screenshotURLs: [URL]
    
//     let version: String
//     let versionDate: Date
//     let versionDescription: String?
//     let downloadURL: URL
//     let platformURLs: [PlatformURLFeed]?
    
//     let tintColor: String? // UIColor?
//     let isBeta: Bool
    
//     //    let source: Source?
//     let appPermissions: [AppPermissionFeed]
//     let versions: [AppVersionFeed]
    
//     enum CodingKeys: String, CodingKey
//     {
//         case bundleIdentifier
//         case developerName
//         case downloadURL
//         case iconURL
//         case isBeta = "beta"
//         case localizedDescription
//         case name
//         case appPermissions
//         case platformURLs
//         case screenshotURLs
//         case size
//         case subtitle
//         case tintColor
//         case version
//         case versionDate
//         case versionDescription
//         case versions
//     }
// }

// public struct NewsItemFeed: Codable {
//     let identifier: String
//     let date: Date
    
//     let title: String
//     let caption: String
//     let tintColor: String //UIColor
//     let notify: Bool
    
//     let imageURL: URL?
//     let externalURL: URL?
    
//     let appID: String?
    
//     private enum CodingKeys: String, CodingKey
//     {
//         case identifier
//         case date
//         case title
//         case caption
//         case tintColor
//         case imageURL
//         case externalURL = "url"
//         case appID
//         case notify
//     }
// }


// public struct SourceJSON: Codable {
//     let version: Int?
//     let name: String
//     let identifier: String
//     let sourceURL: URL
//     let userInfo: [String:String]? //[ALTSourceUserInfoKey:String]?
//     let apps: [StoreAppFeed]
//     let news: [NewsItemFeed]
    
//     enum CodingKeys: String, CodingKey
//     {
//         case version
//         case name
//         case identifier
//         case sourceURL
//         case userInfo
//         case apps
//         case news
//     }
// }

 public extension Source
 {
     // Fallbacks for optional JSON values.
    
     var effectiveIconURL: URL? {
         return self.iconURL ?? self.apps.first?.iconURL
     }
    
     var effectiveHeaderImageURL: URL? {
         return self.headerImageURL ?? self.effectiveIconURL
     }
    
     var effectiveTintColor: UIColor? {
         return self.tintColor ?? self.apps.first?.tintColor
     }
    
     var effectiveFeaturedApps: [StoreApp] {
         return self.featuredApps ?? self.apps
     }
 }

@objc(Source)
public class Source: BaseEntity, Decodable
{
    /* Properties */
    @NSManaged public var version: Int
    @NSManaged public var name: String
    @NSManaged public private(set) var identifier: String       // NOTE: sourceID is just normalized sourceURL
    @NSManaged public private(set) var groupID: String?
    @NSManaged public var sourceURL: URL
    
    /* Source Detail */
    @NSManaged public var subtitle: String?
    @NSManaged public var localizedDescription: String?
    @NSManaged public var websiteURL: URL?
    @NSManaged public var patreonURL: URL?
    
    // Optional properties with fallbacks.
    // `private` to prevent accidentally using instead of `effective[PropertyName]`
    @NSManaged private var iconURL: URL?
    @NSManaged private var headerImageURL: URL?
    @NSManaged private var tintColor: UIColor?
    
    @NSManaged public var error: NSError?
    
    @NSManaged public var featuredSortID: String?
    
    /* Non-Core Data Properties */
    public var userInfo: [ALTSourceUserInfoKey: String]?
    
    /* Relationships */
    @objc(apps) @NSManaged public private(set) var _apps: NSOrderedSet
    @objc(newsItems) @NSManaged public private(set) var _newsItems: NSOrderedSet
    
    @objc(featuredApps) @NSManaged public private(set) var _featuredApps: NSOrderedSet
    @objc(hasFeaturedApps) @NSManaged private var _hasFeaturedApps: Bool
    
    @nonobjc public var apps: [StoreApp] {
        get {
            return self._apps.array as! [StoreApp]
        }
        set {
            self._apps = NSOrderedSet(array: newValue)
        }
    }
    
    @nonobjc public var newsItems: [NewsItem] {
        get {
            return self._newsItems.array as! [NewsItem]
        }
        set {
            self._newsItems = NSOrderedSet(array: newValue)
        }
    }
    
    
    public var isSourceAtLeastV2: Bool {
        return self.version >= 2
    }
    
    
    // `internal` to prevent accidentally using instead of `effectiveFeaturedApps`
    @nonobjc internal var featuredApps: [StoreApp]? {
        return self._hasFeaturedApps ? self._featuredApps.array as? [StoreApp] : nil
    }
    
    private enum CodingKeys: String, CodingKey
    {
        case version
        case name
        case sourceURL
        case subtitle
        case localizedDescription = "description"
        case iconURL
        case headerImageURL = "headerURL"
        case websiteURL = "website"
        case tintColor
        case patreonURL
        
        case apps
        case news
        case featuredApps
        case userInfo
        
//        case identifier
        case groupID = "identifier"
    }
    
    private override init(entity: NSEntityDescription, insertInto context: NSManagedObjectContext?)
    {
        super.init(entity: entity, insertInto: context)
    }
    
    public required init(from decoder: Decoder) throws
    {
        guard let context = decoder.managedObjectContext else { preconditionFailure("Decoder must have non-nil NSManagedObjectContext.") }
        guard let sourceURL = decoder.sourceURL else { preconditionFailure("Decoder must have non-nil sourceURL.") }
        
        super.init(entity: Source.entity(), insertInto: context)
        
        do
        {
            let container = try decoder.container(keyedBy: CodingKeys.self)
            self.name = try container.decode(String.self, forKey: .name)
            
            // Optional Values
            
            // use sourceversion = 1 by default if not specified in source json
            self.version = try container.decodeIfPresent(Int.self, forKey: .version) ?? 1
            
            self.subtitle = try container.decodeIfPresent(String.self, forKey: .subtitle)
            self.websiteURL = try container.decodeIfPresent(URL.self, forKey: .websiteURL)
            self.localizedDescription = try container.decodeIfPresent(String.self, forKey: .localizedDescription)
            self.iconURL = try container.decodeIfPresent(URL.self, forKey: .iconURL)
            self.headerImageURL = try container.decodeIfPresent(URL.self, forKey: .headerImageURL)
            self.patreonURL = try container.decodeIfPresent(URL.self, forKey: .patreonURL)
            
            if let tintColorHex = try container.decodeIfPresent(String.self, forKey: .tintColor)
            {
                guard let tintColor = UIColor(hexString: tintColorHex) else {
                    throw DecodingError.dataCorruptedError(forKey: .tintColor, in: container, debugDescription: "Hex code is invalid.")
                }
                
                self.tintColor = tintColor
            }
            
            let userInfo = try container.decodeIfPresent([String: String].self, forKey: .userInfo)
            self.userInfo = userInfo?.reduce(into: [:]) { $0[ALTSourceUserInfoKey($1.key)] = $1.value }
            
            let apps = try container.decodeIfPresent([StoreApp].self, forKey: .apps) ?? []
            let appsByID = Dictionary(apps.map { ($0.bundleIdentifier, $0) }, uniquingKeysWith: { (a, b) in return a })
            
            for (index, app) in apps.enumerated()
            {
                app.sortIndex = Int32(index)
            }
            self._apps = NSMutableOrderedSet(array: apps)
            
            let newsItems = try container.decodeIfPresent([NewsItem].self, forKey: .news) ?? []
            for (index, item) in newsItems.enumerated()
            {
                item.sortIndex = Int32(index)
            }
                                
            for newsItem in newsItems
            {
                guard let appID = newsItem.appID else { continue }
                
                if let storeApp = appsByID[appID]
                {
                    newsItem.storeApp = storeApp
                }
                else
                {
                    newsItem.storeApp = nil
                }
            }
            self._newsItems = NSMutableOrderedSet(array: newsItems)
            
            let featuredAppBundleIDs = try container.decodeIfPresent([String].self, forKey: .featuredApps)
            let featuredApps = featuredAppBundleIDs?.compactMap { appsByID[$0] }
            self.setFeaturedApps(featuredApps)
            
            // Updates identifier + apps & newsItems
            try self.setSourceURL(sourceURL)
            
            
            // NOTE: Source ID is just normalized sourceURL. coz normalized url is the primary key which needs to be unique
            //       Hence if a source's URL changed, then it means it is a different source now.
            //       This also means that the identifier field in the source is irrelevant (if any)
            
            // if we want grouping of sources from same author or something like that then we should have used groupID (a new field)
            // shouldn't use the existing "identifier" field, hence the following is commented out
            
//            // if an explicit identifier is present, then use it
//            if let identifier = try container.decodeIfPresent(String.self, forKey: .identifier)
//            {
//                self.identifier = identifier
//            }
            
            // if an explicit (group)identifier is present, then use it as groupID else use sourceID as groupID too
            self.groupID = try container.decodeIfPresent(String.self, forKey: .groupID) ?? self.identifier
            
        }
        catch
        {
            if let context = self.managedObjectContext
            {
                context.delete(self)
            }
            
            throw error
        }
    }
    
    public override func awakeFromInsert()
    {
        super.awakeFromInsert()
        
        self.featuredSortID = UUID().uuidString
    }
}

public extension Source
{
    // Source is considered added IFF it has been saved to disk,
    // which we can check by fetching on a new managed object context.
    var isAdded: Bool {
        get async throws {
            let identifier = await AsyncManaged(wrappedValue: self).identifier
            let backgroundContext = DatabaseManager.shared.persistentContainer.newBackgroundContext()
            
            let isAdded = try await backgroundContext.performAsync {
                let fetchRequest = Source.fetchRequest()
                fetchRequest.predicate = NSPredicate(format: "%K == %@", #keyPath(Source.identifier), identifier)
                
                let count = try backgroundContext.count(for: fetchRequest)
                return (count > 0)
            }
            
            return isAdded
        }
    }
    
    var isRecommended: Bool {
        guard let recommendedSources = UserDefaults.shared.recommendedSources else { return false }
        
        // TODO: Support alternate URLs
        let isRecommended = recommendedSources.contains { source in
            return source.identifier == self.identifier || source.sourceURL?.absoluteString.lowercased() == self.sourceURL.absoluteString.lowercased()
        }
        return isRecommended
    }
    
    var lastUpdatedDate: Date? {
        let allDates = self.apps.compactMap { $0.latestAvailableVersion?.date } + self.newsItems.map { $0.date }
        
        let lastUpdatedDate = allDates.sorted().last
        return lastUpdatedDate
    }
}

public extension Source
{
    class func sourceID(from sourceURL: URL) throws -> String
    {
        let sourceID = try sourceURL.normalized()
        return sourceID
    }
}

internal extension Source
{
    func setFeaturedApps(_ featuredApps: [StoreApp]?)
    {
        // Explicitly update relationships for all apps to ensure featuredApps merges correctly.
        
        for case let storeApp as StoreApp in self._apps
        {
            if let featuredApps, featuredApps.contains(where: { $0.bundleIdentifier == storeApp.bundleIdentifier })
            {
                storeApp.featuringSource = self
            }
            else
            {
                storeApp.featuringSource = nil
            }
        }
        
        self._featuredApps = NSOrderedSet(array: featuredApps ?? [])
        self._hasFeaturedApps = (featuredApps != nil)
    }
}

public extension Source
{
    func setSourceURL(_ sourceURL: URL) throws
    {
        self.sourceURL = sourceURL
        
        // update the normalized sourceURL as the identifier
        let identifier = try Source.sourceID(from: sourceURL)
        try self.setSourceID(identifier)
    }

    func setSourceID(_ identifier: String) throws
    {
        self.identifier = identifier
        
        for app in self.apps
        {
            app.sourceIdentifier = identifier
        }
        
        for newsItem in self.newsItems
        {
            newsItem.sourceIdentifier = identifier
        }
    }
}

public extension Source
{
    @nonobjc class func fetchRequest() -> NSFetchRequest<Source>
    {
        return NSFetchRequest<Source>(entityName: "Source")
    }
    
    class func makeAltStoreSource(in context: NSManagedObjectContext) -> Source
    {
        let source = Source(context: context)
        source.name = "SideStore Offical"
        source.groupID = Source.altStoreGroupIdentifier
        source.identifier = Source.altStoreIdentifier
        try! source.setSourceURL(Source.altStoreSourceURL)
        
        return source
    }
    
    class func fetchAltStoreSource(in context: NSManagedObjectContext) -> Source?
    {
        let source = Source.first(satisfying: NSPredicate(format: "%K == %@", #keyPath(Source.identifier), Source.altStoreIdentifier), in: context)
        return source
    }
    
    class func make(name: String, groupID: String, sourceURL: URL, context: NSManagedObjectContext) -> Source
    {
        let source = Source(context: context)
        source.name = name
        source.sourceURL = sourceURL
        source.sourceURL = sourceURL
        source.identifier = try! Source.sourceID(from: sourceURL)

        return source
    }
}