// // Account.swift // DataModel // // Created by Brent Simmons on 7/1/17. // Copyright © 2017 Ranchero Software, LLC. All rights reserved. // #if os(iOS) import UIKit #endif import Foundation import RSCore import Articles import RSParser import ArticlesDatabase import RSWeb public extension Notification.Name { static let AccountRefreshDidBegin = Notification.Name(rawValue: "AccountRefreshDidBegin") static let AccountRefreshDidFinish = Notification.Name(rawValue: "AccountRefreshDidFinish") static let AccountRefreshProgressDidChange = Notification.Name(rawValue: "AccountRefreshProgressDidChange") static let AccountDidDownloadArticles = Notification.Name(rawValue: "AccountDidDownloadArticles") static let AccountStateDidChange = Notification.Name(rawValue: "AccountStateDidChange") static let StatusesDidChange = Notification.Name(rawValue: "StatusesDidChange") } public enum AccountType: Int { // Raw values should not change since they’re stored on disk. case onMyMac = 1 case feedly = 16 case feedbin = 17 case feedWrangler = 18 case newsBlur = 19 // TODO: more } public final class Account: DisplayNameProvider, UnreadCountProvider, Container, Hashable { public struct UserInfoKey { public static let newArticles = "newArticles" // AccountDidDownloadArticles public static let updatedArticles = "updatedArticles" // AccountDidDownloadArticles public static let statuses = "statuses" // StatusesDidChange public static let articles = "articles" // StatusesDidChange public static let feeds = "feeds" // AccountDidDownloadArticles, StatusesDidChange } public let accountID: String public let type: AccountType public var nameForDisplay: String { guard let name = name, !name.isEmpty else { return defaultName } return name } public var name: String? { get { return metadata.name } set { let currentNameForDisplay = nameForDisplay if newValue != metadata.name { metadata.name = newValue if currentNameForDisplay != nameForDisplay { postDisplayNameDidChangeNotification() } } } } public let defaultName: String public var isActive: Bool { get { return metadata.isActive } set { if newValue != metadata.isActive { metadata.isActive = newValue NotificationCenter.default.post(name: .AccountStateDidChange, object: self, userInfo: nil) } } } public var topLevelFeeds = Set() public var folders: Set? = Set() private var feedDictionaryNeedsUpdate = true private var _idToFeedDictionary = [String: Feed]() var idToFeedDictionary: [String: Feed] { if feedDictionaryNeedsUpdate { rebuildFeedDictionaries() } return _idToFeedDictionary } var username: String? { get { return metadata.username } set { if newValue != metadata.username { metadata.username = newValue } } } private var fetchingAllUnreadCounts = false var isUnreadCountsInitialized = false let dataFolder: String let database: ArticlesDatabase var delegate: AccountDelegate static let saveQueue = CoalescingQueue(name: "Account Save Queue", interval: 1.0) private var unreadCounts = [String: Int]() // [feedID: Int] private let opmlFilePath: String private var _flattenedFeeds = Set() private var flattenedFeedsNeedUpdate = true private let metadataPath: String private var metadata = AccountMetadata() private var metadataDirty = false { didSet { queueSaveAccountMetadatafNeeded() } } private let feedMetadataPath: String private typealias FeedMetadataDictionary = [String: FeedMetadata] private var feedMetadata = FeedMetadataDictionary() private var feedMetadataDirty = false { didSet { queueSaveFeedMetadataIfNeeded() } } private var startingUp = true public var dirty = false { didSet { queueSaveToDiskIfNeeded() } } public var unreadCount = 0 { didSet { if unreadCount != oldValue { postUnreadCountDidChangeNotification() } } } var refreshInProgress = false { didSet { if refreshInProgress != oldValue { if refreshInProgress { NotificationCenter.default.post(name: .AccountRefreshDidBegin, object: self) } else { NotificationCenter.default.post(name: .AccountRefreshDidFinish, object: self) queueSaveToDiskIfNeeded() } } } } var refreshProgress: DownloadProgress { return delegate.refreshProgress } var supportsSubFolders: Bool { return delegate.supportsSubFolders } init?(dataFolder: String, type: AccountType, accountID: String, transport: Transport = URLSession.webserviceTransport()) { switch type { case .onMyMac: self.delegate = LocalAccountDelegate() case .feedbin: self.delegate = FeedbinAccountDelegate(transport: transport) default: fatalError("Only Local and Feedbin accounts are supported") } self.accountID = accountID self.type = type self.dataFolder = dataFolder self.opmlFilePath = (dataFolder as NSString).appendingPathComponent("Subscriptions.opml") let databaseFilePath = (dataFolder as NSString).appendingPathComponent("DB.sqlite3") self.database = ArticlesDatabase(databaseFilePath: databaseFilePath, accountID: accountID) self.feedMetadataPath = (dataFolder as NSString).appendingPathComponent("FeedMetadata.plist") self.metadataPath = (dataFolder as NSString).appendingPathComponent("Settings.plist") switch type { case .onMyMac: #if os(macOS) defaultName = NSLocalizedString("On My Mac", comment: "Account name") #else if UIDevice.current.userInterfaceIdiom == .pad { defaultName = NSLocalizedString("On My iPad", comment: "Account name") } else { defaultName = NSLocalizedString("On My iPhone", comment: "Account name") } #endif case .feedly: defaultName = "Feedly" case .feedbin: defaultName = "Feedbin" case .feedWrangler: defaultName = "FeedWrangler" case .newsBlur: defaultName = "NewsBlur" } NotificationCenter.default.addObserver(self, selector: #selector(downloadProgressDidChange(_:)), name: .DownloadProgressDidChange, object: nil) NotificationCenter.default.addObserver(self, selector: #selector(unreadCountDidChange(_:)), name: .UnreadCountDidChange, object: nil) NotificationCenter.default.addObserver(self, selector: #selector(batchUpdateDidPerform(_:)), name: .BatchUpdateDidPerform, object: nil) NotificationCenter.default.addObserver(self, selector: #selector(displayNameDidChange(_:)), name: .DisplayNameDidChange, object: nil) NotificationCenter.default.addObserver(self, selector: #selector(childrenDidChange(_:)), name: .ChildrenDidChange, object: nil) pullObjectsFromDisk() DispatchQueue.main.async { self.fetchAllUnreadCounts() } self.delegate.accountDidInitialize(self) startingUp = false } // MARK: - API public func storeCredentials(_ credentials: Credentials) throws { guard let server = delegate.server else { throw CredentialsError.incompleteCredentials } switch credentials { case .basic(let username, _): self.username = username } try CredentialsManager.storeCredentials(credentials, server: server) delegate.credentials = credentials } public func retrieveBasicCredentials() throws -> Credentials? { guard let username = self.username, let server = delegate.server else { return nil } return try CredentialsManager.retrieveBasicCredentials(server: server, username: username) } public func removeBasicCredentials() throws { guard let username = self.username, let server = delegate.server else { return } try CredentialsManager.removeBasicCredentials(server: server, username: username) self.username = nil } public static func validateCredentials(transport: Transport = URLSession.webserviceTransport(), type: AccountType, credentials: Credentials, completionHandler handler: @escaping (Result) -> Void) { switch type { case .onMyMac: LocalAccountDelegate.validateCredentials(transport: transport, credentials: credentials, completionHandler: handler) case .feedbin: FeedbinAccountDelegate.validateCredentials(transport: transport, credentials: credentials, completionHandler: handler) default: break } } public func refreshAll() { delegate.refreshAll(for: self) } public func update(_ feed: Feed, with parsedFeed: ParsedFeed, _ completion: @escaping RSVoidCompletionBlock) { feed.takeSettings(from: parsedFeed) database.update(feedID: feed.feedID, parsedFeed: parsedFeed) { (newArticles, updatedArticles) in var userInfo = [String: Any]() if let newArticles = newArticles, !newArticles.isEmpty { self.updateUnreadCounts(for: Set([feed])) userInfo[UserInfoKey.newArticles] = newArticles } if let updatedArticles = updatedArticles, !updatedArticles.isEmpty { userInfo[UserInfoKey.updatedArticles] = updatedArticles } userInfo[UserInfoKey.feeds] = Set([feed]) completion() NotificationCenter.default.post(name: .AccountDidDownloadArticles, object: self, userInfo: userInfo) } } public func markArticles(_ articles: Set
, statusKey: ArticleStatus.Key, flag: Bool) -> Set
? { // Returns set of Articles whose statuses did change. guard let updatedStatuses = database.mark(articles, statusKey: statusKey, flag: flag) else { return nil } let updatedArticleIDs = updatedStatuses.articleIDs() let updatedArticles = Set(articles.filter{ updatedArticleIDs.contains($0.articleID) }) noteStatusesForArticlesDidChange(updatedArticles) return updatedArticles } @discardableResult public func ensureFolder(with name: String) -> Folder? { // TODO: support subfolders, maybe, some day if name.isEmpty { return nil } if let folder = existingFolder(with: name) { return folder } let folder = Folder(account: self, name: name) folders!.insert(folder) structureDidChange() postChildrenDidChangeNotification() return folder } public func ensureFolder(withFolderNames folderNames: [String]) -> Folder? { // TODO: support subfolders, maybe, some day. // Since we don’t, just take the last name and make sure there’s a Folder. guard let folderName = folderNames.last else { return nil } return ensureFolder(with: folderName) } public func canAddFeed(_ feed: Feed, to folder: Folder?) -> Bool { // If folder is nil, then it should go at the top level. // The same feed in multiple folders is allowed. // But the same feed can’t appear twice in the same folder // (or at the top level). return true // TODO } public func addFeed(_ feed: Feed, to folder: Folder?) { if let folder = folder { folder.addFeed(feed) } else { addFeed(feed) } } public func addFeeds(_ feeds: Set, to folder: Folder?) { if let folder = folder { folder.addFeeds(feeds) } else { addFeeds(feeds) } } public func createFeed(with name: String?, editedName: String?, url: String) -> Feed? { // For syncing, this may need to be an async method with a callback, // since it will likely need to call the server. let metadata = feedMetadata(feedID: url) let feed = Feed(account: self, url: url, feedID: url, metadata: metadata) if let name = name, feed.name == nil { feed.name = name } if let editedName = editedName, feed.editedName == nil { feed.editedName = editedName } return feed } public func canAddFolder(_ folder: Folder, to containingFolder: Folder?) -> Bool { return false // TODO } @discardableResult public func addFolder(_ folder: Folder, to parentFolder: Folder?) -> Bool { // TODO: support subfolders, maybe, some day, if one of the sync systems // supports subfolders. But, for now, parentFolder is ignored. if folders!.contains(folder) { return true } folders!.insert(folder) postChildrenDidChangeNotification() structureDidChange() return true } public func importOPML(_ opmlDocument: RSOPMLDocument) { guard let children = opmlDocument.children else { return } importOPMLItems(children, parentFolder: nil) structureDidChange() DispatchQueue.main.async { self.refreshAll() } } public func updateUnreadCounts(for feeds: Set) { if feeds.isEmpty { return } database.fetchUnreadCounts(for: feeds.feedIDs()) { (unreadCountDictionary) in for feed in feeds { if let unreadCount = unreadCountDictionary[feed.feedID] { feed.unreadCount = unreadCount } } } } public func fetchArticles(for feed: Feed) -> Set
{ let articles = database.fetchArticles(for: feed.feedID) validateUnreadCount(feed, articles) return articles } public func fetchUnreadArticles(for feed: Feed) -> Set
{ let articles = database.fetchUnreadArticles(for: Set([feed.feedID])) validateUnreadCount(feed, articles) return articles } public func fetchUnreadArticles() -> Set
{ return fetchUnreadArticles(forContainer: self) } public func fetchArticles(folder: Folder) -> Set
{ return fetchUnreadArticles(forContainer: folder) } public func fetchUnreadArticles(forContainer container: Container) -> Set
{ let feeds = container.flattenedFeeds() let articles = database.fetchUnreadArticles(for: feeds.feedIDs()) // Validate unread counts. This was the site of a performance slowdown: // it was calling going through the entire list of articles once per feed: // feeds.forEach { validateUnreadCount($0, articles) } // Now we loop through articles exactly once. This makes a huge difference. var unreadCountStorage = [String: Int]() // [FeedID: Int] articles.forEach { (article) in precondition(!article.status.read) unreadCountStorage[article.feedID, default: 0] += 1 } feeds.forEach { (feed) in let unreadCount = unreadCountStorage[feed.feedID, default: 0] feed.unreadCount = unreadCount } return articles } public func fetchTodayArticles() -> Set
{ return database.fetchTodayArticles(for: flattenedFeeds().feedIDs()) } public func fetchStarredArticles() -> Set
{ return database.fetchStarredArticles(for: flattenedFeeds().feedIDs()) } public func fetchArticlesMatching(_ searchString: String) -> Set
{ return database.fetchArticlesMatching(searchString, for: flattenedFeeds().feedIDs()) } private func validateUnreadCount(_ feed: Feed, _ articles: Set
) { // articles must contain all the unread articles for the feed. // The unread number should match the feed’s unread count. let feedUnreadCount = articles.reduce(0) { (result, article) -> Int in if article.feed == feed && !article.status.read { return result + 1 } return result } feed.unreadCount = feedUnreadCount } public func fetchUnreadCountForToday(_ callback: @escaping (Int) -> Void) { let startOfToday = NSCalendar.startOfToday() database.fetchUnreadCount(for: flattenedFeeds().feedIDs(), since: startOfToday, callback: callback) } public func fetchUnreadCountForStarredArticles(_ callback: @escaping (Int) -> Void) { database.fetchStarredAndUnreadCount(for: flattenedFeeds().feedIDs(), callback: callback) } public func opmlDocument() -> String { let escapedTitle = nameForDisplay.rs_stringByEscapingSpecialXMLCharacters() let openingText = """ \(escapedTitle) """ let middleText = OPMLString(indentLevel: 0) let closingText = """ """ let opml = openingText + middleText + closingText return opml } public func unreadCount(for feed: Feed) -> Int { return unreadCounts[feed.feedID] ?? 0 } public func setUnreadCount(_ unreadCount: Int, for feed: Feed) { unreadCounts[feed.feedID] = unreadCount } public func structureDidChange() { // Feeds were added or deleted. Or folders added or deleted. // Or feeds inside folders were added or deleted. if !startingUp { dirty = true } flattenedFeedsNeedUpdate = true feedDictionaryNeedsUpdate = true } // MARK: - Container public func flattenedFeeds() -> Set { if flattenedFeedsNeedUpdate { updateFlattenedFeeds() } return _flattenedFeeds } public func deleteFeed(_ feed: Feed) { topLevelFeeds.remove(feed) structureDidChange() postChildrenDidChangeNotification() } public func deleteFolder(_ folder: Folder) { folders?.remove(folder) structureDidChange() postChildrenDidChangeNotification() } // MARK: - Debug public func debugDropConditionalGetInfo() { #if DEBUG flattenedFeeds().forEach{ $0.debugDropConditionalGetInfo() } #endif } public func debugRunSearch() { #if DEBUG let t1 = Date() let articles = fetchArticlesMatching("Brent NetNewsWire") let t2 = Date() print(t2.timeIntervalSince(t1)) print(articles.count) #endif } // MARK: - Notifications @objc func downloadProgressDidChange(_ note: Notification) { guard let noteObject = note.object as? DownloadProgress, noteObject === refreshProgress else { return } refreshInProgress = refreshProgress.numberRemaining > 0 NotificationCenter.default.post(name: .AccountRefreshProgressDidChange, object: self) } @objc func unreadCountDidChange(_ note: Notification) { if let feed = note.object as? Feed, feed.account === self { updateUnreadCount() } } @objc func batchUpdateDidPerform(_ note: Notification) { flattenedFeedsNeedUpdate = true rebuildFeedDictionaries() updateUnreadCount() } @objc func childrenDidChange(_ note: Notification) { guard let object = note.object else { return } if let account = object as? Account, account === self { structureDidChange() } if let folder = object as? Folder, folder.account === self { structureDidChange() } } @objc func displayNameDidChange(_ note: Notification) { if let folder = note.object as? Folder, folder.account === self { structureDidChange() } } @objc func saveToDiskIfNeeded() { if dirty { saveToDisk() } } @objc func saveFeedMetadataIfNeeded() { if feedMetadataDirty { saveFeedMetadata() } } @objc func saveAccountMetadataIfNeeded() { if metadataDirty { saveAccountMetadata() } } // MARK: - Hashable public func hash(into hasher: inout Hasher) { hasher.combine(accountID) } // MARK: - Equatable public class func ==(lhs: Account, rhs: Account) -> Bool { return lhs === rhs } } // MARK: - AccountMetadataDelegate extension Account: AccountMetadataDelegate { func valueDidChange(_ accountMetadata: AccountMetadata, key: AccountMetadata.CodingKeys) { metadataDirty = true } } // MARK: - FeedMetadataDelegate extension Account: FeedMetadataDelegate { func valueDidChange(_ feedMetadata: FeedMetadata, key: FeedMetadata.CodingKeys) { feedMetadataDirty = true guard let feed = existingFeed(with: feedMetadata.feedID) else { return } feed.postFeedSettingDidChangeNotification(key) } } // MARK: - Disk (Private) private extension Account { func queueSaveToDiskIfNeeded() { Account.saveQueue.add(self, #selector(saveToDiskIfNeeded)) } func pullObjectsFromDisk() { importAccountMetadata() importFeedMetadata() importOPMLFile(path: opmlFilePath) } func importAccountMetadata() { let url = URL(fileURLWithPath: metadataPath) guard let data = try? Data(contentsOf: url) else { metadata.delegate = self return } let decoder = PropertyListDecoder() metadata = (try? decoder.decode(AccountMetadata.self, from: data)) ?? AccountMetadata() metadata.delegate = self } func importFeedMetadata() { let url = URL(fileURLWithPath: feedMetadataPath) guard let data = try? Data(contentsOf: url) else { return } let decoder = PropertyListDecoder() feedMetadata = (try? decoder.decode(FeedMetadataDictionary.self, from: data)) ?? FeedMetadataDictionary() feedMetadata.values.forEach { $0.delegate = self } } func importOPMLFile(path: String) { let opmlFileURL = URL(fileURLWithPath: path) var fileData: Data? do { fileData = try Data(contentsOf: opmlFileURL) } catch { // Commented out because it’s not an error on first run. // TODO: make it so we know if it’s first run or not. //NSApplication.shared.presentError(error) return } guard let opmlData = fileData else { return } let parserData = ParserData(url: opmlFileURL.absoluteString, data: opmlData) var opmlDocument: RSOPMLDocument? do { opmlDocument = try RSOPMLParser.parseOPML(with: parserData) } catch { #if os(macOS) NSApplication.shared.presentError(error) #else UIApplication.shared.presentError(error) #endif return } guard let parsedOPML = opmlDocument, let children = parsedOPML.children else { return } BatchUpdate.shared.perform { importOPMLItems(children, parentFolder: nil) } } func saveToDisk() { dirty = false let opmlDocumentString = opmlDocument() do { let url = URL(fileURLWithPath: opmlFilePath) try opmlDocumentString.write(to: url, atomically: true, encoding: .utf8) } catch let error as NSError { #if os(macOS) NSApplication.shared.presentError(error) #else UIApplication.shared.presentError(error) #endif } } func queueSaveFeedMetadataIfNeeded() { Account.saveQueue.add(self, #selector(saveFeedMetadataIfNeeded)) } private func metadataForOnlySubscribedToFeeds() -> FeedMetadataDictionary { let feedIDs = idToFeedDictionary.keys return feedMetadata.filter { (feedID: String, metadata: FeedMetadata) -> Bool in return feedIDs.contains(feedID) } } func saveFeedMetadata() { feedMetadataDirty = false let d = metadataForOnlySubscribedToFeeds() let encoder = PropertyListEncoder() encoder.outputFormat = .binary let url = URL(fileURLWithPath: feedMetadataPath) do { let data = try encoder.encode(d) try data.write(to: url) } catch { assertionFailure(error.localizedDescription) } } func queueSaveAccountMetadatafNeeded() { Account.saveQueue.add(self, #selector(saveAccountMetadataIfNeeded)) } func saveAccountMetadata() { metadataDirty = false let encoder = PropertyListEncoder() encoder.outputFormat = .binary let url = URL(fileURLWithPath: metadataPath) do { let data = try encoder.encode(metadata) try data.write(to: url) } catch { assertionFailure(error.localizedDescription) } } } // MARK: - Private private extension Account { func feedMetadata(feedID: String) -> FeedMetadata { if let d = feedMetadata[feedID] { assert(d.delegate === self) return d } let d = FeedMetadata(feedID: feedID) d.delegate = self feedMetadata[feedID] = d return d } func updateFlattenedFeeds() { var feeds = Set() feeds.formUnion(topLevelFeeds) for folder in folders! { feeds.formUnion(folder.flattenedFeeds()) } _flattenedFeeds = feeds flattenedFeedsNeedUpdate = false } func rebuildFeedDictionaries() { var idDictionary = [String: Feed]() flattenedFeeds().forEach { (feed) in idDictionary[feed.feedID] = feed } _idToFeedDictionary = idDictionary feedDictionaryNeedsUpdate = false } func createFeed(with opmlFeedSpecifier: RSOPMLFeedSpecifier) -> Feed { let feedID = opmlFeedSpecifier.feedURL let metadata = feedMetadata(feedID: feedID) let feed = Feed(account: self, url: opmlFeedSpecifier.feedURL, feedID: feedID, metadata: metadata) if let feedTitle = opmlFeedSpecifier.title { if feed.name == nil { feed.name = feedTitle } } return feed } func importOPMLItems(_ items: [RSOPMLItem], parentFolder: Folder?) { var feedsToAdd = Set() items.forEach { (item) in if let feedSpecifier = item.feedSpecifier { let feed = createFeed(with: feedSpecifier) feedsToAdd.insert(feed) return } guard let folderName = item.titleFromAttributes else { // Folder doesn’t have a name, so it won’t be created, and its items will go one level up. if let itemChildren = item.children { importOPMLItems(itemChildren, parentFolder: parentFolder) } return } if let folder = ensureFolder(with: folderName) { if let itemChildren = item.children { importOPMLItems(itemChildren, parentFolder: folder) } } } if !feedsToAdd.isEmpty { addFeeds(feedsToAdd, to: parentFolder) } } func updateUnreadCount() { if fetchingAllUnreadCounts { return } var updatedUnreadCount = 0 for feed in flattenedFeeds() { updatedUnreadCount += feed.unreadCount } unreadCount = updatedUnreadCount } func noteStatusesForArticlesDidChange(_ articles: Set
) { let feeds = Set(articles.compactMap { $0.feed }) let statuses = Set(articles.map { $0.status }) // .UnreadCountDidChange notification will get sent to Folder and Account objects, // which will update their own unread counts. updateUnreadCounts(for: feeds) NotificationCenter.default.post(name: .StatusesDidChange, object: self, userInfo: [UserInfoKey.statuses: statuses, UserInfoKey.articles: articles, UserInfoKey.feeds: feeds]) } func fetchAllUnreadCounts() { fetchingAllUnreadCounts = true database.fetchAllNonZeroUnreadCounts { (unreadCountDictionary) in if unreadCountDictionary.isEmpty { self.fetchingAllUnreadCounts = false self.updateUnreadCount() self.isUnreadCountsInitialized = true return } self.flattenedFeeds().forEach{ (feed) in // When the unread count is zero, it won’t appear in unreadCountDictionary. if let unreadCount = unreadCountDictionary[feed.feedID] { feed.unreadCount = unreadCount } else { feed.unreadCount = 0 } } self.fetchingAllUnreadCounts = false self.updateUnreadCount() self.isUnreadCountsInitialized = true } } } // MARK: - Container Overrides extension Account { public func existingFeed(with feedID: String) -> Feed? { return idToFeedDictionary[feedID] } } // MARK: - OPMLRepresentable extension Account: OPMLRepresentable { public func OPMLString(indentLevel: Int) -> String { var s = "" for feed in topLevelFeeds { s += feed.OPMLString(indentLevel: indentLevel + 1) } for folder in folders! { s += folder.OPMLString(indentLevel: indentLevel + 1) } return s } }