577 lines
18 KiB
Swift
577 lines
18 KiB
Swift
//
|
|
// FeedlyAccountDelegate.swift
|
|
// Account
|
|
//
|
|
// Created by Kiel Gillard on 3/9/19.
|
|
// Copyright © 2019 Ranchero Software, LLC. All rights reserved.
|
|
//
|
|
|
|
import Articles
|
|
import RSCore
|
|
import RSParser
|
|
import RSWeb
|
|
import SyncDatabase
|
|
import os.log
|
|
import Secrets
|
|
|
|
final class FeedlyAccountDelegate: AccountDelegate {
|
|
|
|
/// Feedly has a sandbox API and a production API.
|
|
/// This property is referred to when clients need to know which environment it should be pointing to.
|
|
/// The value of this proptery must match any `OAuthAuthorizationClient` used.
|
|
/// Currently this is always returning the cloud API, but we are leaving it stubbed out for now.
|
|
static var environment: FeedlyAPICaller.API {
|
|
return .cloud
|
|
}
|
|
|
|
// TODO: Kiel, if you decide not to support OPML import you will have to disallow it in the behaviors
|
|
// See https://developer.feedly.com/v3/opml/
|
|
var behaviors: AccountBehaviors = [.disallowFeedInRootFolder, .disallowMarkAsUnreadAfterPeriod(31)]
|
|
|
|
let isOPMLImportSupported = false
|
|
|
|
var isOPMLImportInProgress = false
|
|
|
|
var server: String? {
|
|
return caller.server
|
|
}
|
|
|
|
var credentials: Credentials? {
|
|
didSet {
|
|
#if DEBUG
|
|
// https://developer.feedly.com/v3/developer/
|
|
if let devToken = ProcessInfo.processInfo.environment["FEEDLY_DEV_ACCESS_TOKEN"], !devToken.isEmpty {
|
|
caller.credentials = Credentials(type: .oauthAccessToken, username: "Developer", secret: devToken)
|
|
return
|
|
}
|
|
#endif
|
|
caller.credentials = credentials
|
|
}
|
|
}
|
|
|
|
let oauthAuthorizationClient: OAuthAuthorizationClient
|
|
|
|
var accountMetadata: AccountMetadata?
|
|
|
|
var refreshProgress = DownloadProgress(numberOfTasks: 0)
|
|
|
|
/// Set on `accountDidInitialize` for the purposes of refreshing OAuth tokens when they expire.
|
|
/// See the implementation for `FeedlyAPICallerDelegate`.
|
|
private weak var initializedAccount: Account?
|
|
|
|
internal let caller: FeedlyAPICaller
|
|
|
|
private let log = OSLog(subsystem: Bundle.main.bundleIdentifier!, category: "Feedly")
|
|
private let database: SyncDatabase
|
|
|
|
private weak var currentSyncAllOperation: MainThreadOperation?
|
|
private let operationQueue = MainThreadOperationQueue()
|
|
|
|
init(dataFolder: String, transport: Transport?, api: FeedlyAPICaller.API) {
|
|
// Many operations have their own operation queues, such as the sync all operation.
|
|
// Making this a serial queue at this higher level of abstraction means we can ensure,
|
|
// for example, a `FeedlyRefreshAccessTokenOperation` occurs before a `FeedlySyncAllOperation`,
|
|
// improving our ability to debug, reason about and predict the behaviour of the code.
|
|
|
|
if let transport = transport {
|
|
self.caller = FeedlyAPICaller(transport: transport, api: api)
|
|
|
|
} else {
|
|
|
|
let sessionConfiguration = URLSessionConfiguration.default
|
|
sessionConfiguration.requestCachePolicy = .reloadIgnoringLocalCacheData
|
|
sessionConfiguration.timeoutIntervalForRequest = 60.0
|
|
sessionConfiguration.httpShouldSetCookies = false
|
|
sessionConfiguration.httpCookieAcceptPolicy = .never
|
|
sessionConfiguration.httpMaximumConnectionsPerHost = 1
|
|
sessionConfiguration.httpCookieStorage = nil
|
|
sessionConfiguration.urlCache = nil
|
|
|
|
if let userAgentHeaders = UserAgent.headers() {
|
|
sessionConfiguration.httpAdditionalHeaders = userAgentHeaders
|
|
}
|
|
|
|
let session = URLSession(configuration: sessionConfiguration)
|
|
self.caller = FeedlyAPICaller(transport: session, api: api)
|
|
}
|
|
|
|
let databaseFilePath = (dataFolder as NSString).appendingPathComponent("Sync.sqlite3")
|
|
self.database = SyncDatabase(databaseFilePath: databaseFilePath)
|
|
self.oauthAuthorizationClient = api.oauthAuthorizationClient
|
|
|
|
self.caller.delegate = self
|
|
}
|
|
|
|
// MARK: Account API
|
|
|
|
func receiveRemoteNotification(for account: Account, userInfo: [AnyHashable : Any], completion: @escaping () -> Void) {
|
|
completion()
|
|
}
|
|
|
|
func refreshAll(for account: Account, completion: @escaping (Result<Void, Error>) -> Void) {
|
|
assert(Thread.isMainThread)
|
|
|
|
guard currentSyncAllOperation == nil else {
|
|
os_log(.debug, log: log, "Ignoring refreshAll: Feedly sync already in progress.")
|
|
completion(.success(()))
|
|
return
|
|
}
|
|
|
|
guard let credentials = credentials else {
|
|
os_log(.debug, log: log, "Ignoring refreshAll: Feedly account has no credentials.")
|
|
completion(.failure(FeedlyAccountDelegateError.notLoggedIn))
|
|
return
|
|
}
|
|
|
|
let log = self.log
|
|
|
|
let syncAllOperation = FeedlySyncAllOperation(account: account, feedlyUserId: credentials.username, caller: caller, database: database, lastSuccessfulFetchStartDate: accountMetadata?.lastArticleFetchStartTime, downloadProgress: refreshProgress, log: log)
|
|
|
|
syncAllOperation.downloadProgress = refreshProgress
|
|
|
|
let date = Date()
|
|
syncAllOperation.syncCompletionHandler = { [weak self] result in
|
|
if case .success = result {
|
|
self?.accountMetadata?.lastArticleFetchStartTime = date
|
|
self?.accountMetadata?.lastArticleFetchEndTime = Date()
|
|
}
|
|
|
|
os_log(.debug, log: log, "Sync took %{public}.3f seconds", -date.timeIntervalSinceNow)
|
|
completion(result)
|
|
}
|
|
|
|
currentSyncAllOperation = syncAllOperation
|
|
|
|
operationQueue.add(syncAllOperation)
|
|
}
|
|
|
|
func sendArticleStatus(for account: Account, completion: @escaping ((Result<Void, Error>) -> Void)) {
|
|
// Ensure remote articles have the same status as they do locally.
|
|
let send = FeedlySendArticleStatusesOperation(database: database, service: caller, log: log)
|
|
send.completionBlock = { operation in
|
|
// TODO: not call with success if operation was canceled? Not sure.
|
|
DispatchQueue.main.async {
|
|
completion(.success(()))
|
|
}
|
|
}
|
|
operationQueue.add(send)
|
|
}
|
|
|
|
/// Attempts to ensure local articles have the same status as they do remotely.
|
|
/// So if the user is using another client roughly simultaneously with this app,
|
|
/// this app does its part to ensure the articles have a consistent status between both.
|
|
///
|
|
/// - Parameter account: The account whose articles have a remote status.
|
|
/// - Parameter completion: Call on the main queue.
|
|
func refreshArticleStatus(for account: Account, completion: @escaping ((Result<Void, Error>) -> Void)) {
|
|
guard let credentials = credentials else {
|
|
return completion(.success(()))
|
|
}
|
|
|
|
let group = DispatchGroup()
|
|
|
|
let ingestUnread = FeedlyIngestUnreadArticleIdsOperation(account: account, userId: credentials.username, service: caller, database: database, newerThan: nil, log: log)
|
|
|
|
group.enter()
|
|
ingestUnread.completionBlock = { _ in
|
|
group.leave()
|
|
|
|
}
|
|
|
|
let ingestStarred = FeedlyIngestStarredArticleIdsOperation(account: account, userId: credentials.username, service: caller, database: database, newerThan: nil, log: log)
|
|
|
|
group.enter()
|
|
ingestStarred.completionBlock = { _ in
|
|
group.leave()
|
|
}
|
|
|
|
group.notify(queue: .main) {
|
|
completion(.success(()))
|
|
}
|
|
|
|
operationQueue.addOperations([ingestUnread, ingestStarred])
|
|
}
|
|
|
|
func importOPML(for account: Account, opmlFile: URL, completion: @escaping (Result<Void, Error>) -> Void) {
|
|
let data: Data
|
|
|
|
do {
|
|
data = try Data(contentsOf: opmlFile)
|
|
} catch {
|
|
completion(.failure(error))
|
|
return
|
|
}
|
|
|
|
os_log(.debug, log: log, "Begin importing OPML...")
|
|
isOPMLImportInProgress = true
|
|
refreshProgress.addToNumberOfTasksAndRemaining(1)
|
|
|
|
caller.importOpml(data) { result in
|
|
switch result {
|
|
case .success:
|
|
os_log(.debug, log: self.log, "Import OPML done.")
|
|
self.refreshProgress.completeTask()
|
|
self.isOPMLImportInProgress = false
|
|
DispatchQueue.main.async {
|
|
completion(.success(()))
|
|
}
|
|
case .failure(let error):
|
|
os_log(.debug, log: self.log, "Import OPML failed.")
|
|
self.refreshProgress.completeTask()
|
|
self.isOPMLImportInProgress = false
|
|
DispatchQueue.main.async {
|
|
let wrappedError = AccountError.wrappedError(error: error, account: account)
|
|
completion(.failure(wrappedError))
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
func createFolder(for account: Account, name: String, completion: @escaping (Result<Folder, Error>) -> Void) {
|
|
|
|
let progress = refreshProgress
|
|
progress.addToNumberOfTasksAndRemaining(1)
|
|
|
|
caller.createCollection(named: name) { result in
|
|
progress.completeTask()
|
|
|
|
switch result {
|
|
case .success(let collection):
|
|
if let folder = account.ensureFolder(with: collection.label) {
|
|
folder.externalID = collection.id
|
|
completion(.success(folder))
|
|
} else {
|
|
// Is the name empty? Or one of the global resource names?
|
|
completion(.failure(FeedlyAccountDelegateError.unableToAddFolder(name)))
|
|
}
|
|
case .failure(let error):
|
|
completion(.failure(error))
|
|
}
|
|
}
|
|
}
|
|
|
|
func renameFolder(for account: Account, with folder: Folder, to name: String, completion: @escaping (Result<Void, Error>) -> Void) {
|
|
guard let id = folder.externalID else {
|
|
return DispatchQueue.main.async {
|
|
completion(.failure(FeedlyAccountDelegateError.unableToRenameFolder(folder.nameForDisplay, name)))
|
|
}
|
|
}
|
|
|
|
let nameBefore = folder.name
|
|
|
|
caller.renameCollection(with: id, to: name) { result in
|
|
switch result {
|
|
case .success(let collection):
|
|
folder.name = collection.label
|
|
completion(.success(()))
|
|
case .failure(let error):
|
|
folder.name = nameBefore
|
|
completion(.failure(error))
|
|
}
|
|
}
|
|
|
|
folder.name = name
|
|
}
|
|
|
|
func removeFolder(for account: Account, with folder: Folder, completion: @escaping (Result<Void, Error>) -> Void) {
|
|
guard let id = folder.externalID else {
|
|
return DispatchQueue.main.async {
|
|
completion(.failure(FeedlyAccountDelegateError.unableToRemoveFolder(folder.nameForDisplay)))
|
|
}
|
|
}
|
|
|
|
let progress = refreshProgress
|
|
progress.addToNumberOfTasksAndRemaining(1)
|
|
|
|
caller.deleteCollection(with: id) { result in
|
|
progress.completeTask()
|
|
|
|
switch result {
|
|
case .success:
|
|
account.removeFolder(folder)
|
|
completion(.success(()))
|
|
case .failure(let error):
|
|
completion(.failure(error))
|
|
}
|
|
}
|
|
}
|
|
|
|
func createWebFeed(for account: Account, url: String, name: String?, container: Container, completion: @escaping (Result<WebFeed, Error>) -> Void) {
|
|
|
|
do {
|
|
guard let credentials = credentials else {
|
|
throw FeedlyAccountDelegateError.notLoggedIn
|
|
}
|
|
|
|
let addNewFeed = try FeedlyAddNewFeedOperation(account: account,
|
|
credentials: credentials,
|
|
url: url,
|
|
feedName: name,
|
|
searchService: caller,
|
|
addToCollectionService: caller,
|
|
syncUnreadIdsService: caller,
|
|
getStreamContentsService: caller,
|
|
database: database,
|
|
container: container,
|
|
progress: refreshProgress,
|
|
log: log)
|
|
|
|
addNewFeed.addCompletionHandler = { result in
|
|
completion(result)
|
|
}
|
|
|
|
operationQueue.add(addNewFeed)
|
|
|
|
} catch {
|
|
DispatchQueue.main.async {
|
|
completion(.failure(error))
|
|
}
|
|
}
|
|
}
|
|
|
|
func renameWebFeed(for account: Account, with feed: WebFeed, to name: String, completion: @escaping (Result<Void, Error>) -> Void) {
|
|
let folderCollectionIds = account.folders?.filter { $0.has(feed) }.compactMap { $0.externalID }
|
|
guard let collectionIds = folderCollectionIds, let collectionId = collectionIds.first else {
|
|
completion(.failure(FeedlyAccountDelegateError.unableToRenameFeed(feed.nameForDisplay, name)))
|
|
return
|
|
}
|
|
|
|
let feedId = FeedlyFeedResourceId(id: feed.webFeedID)
|
|
let editedNameBefore = feed.editedName
|
|
|
|
// Adding an existing feed updates it.
|
|
// Updating feed name in one folder/collection updates it for all folders/collections.
|
|
caller.addFeed(with: feedId, title: name, toCollectionWith: collectionId) { result in
|
|
switch result {
|
|
case .success:
|
|
completion(.success(()))
|
|
|
|
case .failure(let error):
|
|
feed.editedName = editedNameBefore
|
|
completion(.failure(error))
|
|
}
|
|
}
|
|
|
|
// optimistically set the name
|
|
feed.editedName = name
|
|
}
|
|
|
|
func addWebFeed(for account: Account, with feed: WebFeed, to container: Container, completion: @escaping (Result<Void, Error>) -> Void) {
|
|
|
|
do {
|
|
guard let credentials = credentials else {
|
|
throw FeedlyAccountDelegateError.notLoggedIn
|
|
}
|
|
|
|
let resource = FeedlyFeedResourceId(id: feed.webFeedID)
|
|
let addExistingFeed = try FeedlyAddExistingFeedOperation(account: account,
|
|
credentials: credentials,
|
|
resource: resource,
|
|
service: caller,
|
|
container: container,
|
|
progress: refreshProgress,
|
|
log: log)
|
|
|
|
|
|
addExistingFeed.addCompletionHandler = { result in
|
|
completion(result)
|
|
}
|
|
|
|
operationQueue.add(addExistingFeed)
|
|
|
|
} catch {
|
|
DispatchQueue.main.async {
|
|
completion(.failure(error))
|
|
}
|
|
}
|
|
}
|
|
|
|
func removeWebFeed(for account: Account, with feed: WebFeed, from container: Container, completion: @escaping (Result<Void, Error>) -> Void) {
|
|
guard let folder = container as? Folder, let collectionId = folder.externalID else {
|
|
return DispatchQueue.main.async {
|
|
completion(.failure(FeedlyAccountDelegateError.unableToRemoveFeed(feed)))
|
|
}
|
|
}
|
|
|
|
caller.removeFeed(feed.webFeedID, fromCollectionWith: collectionId) { result in
|
|
switch result {
|
|
case .success:
|
|
completion(.success(()))
|
|
case .failure(let error):
|
|
folder.addWebFeed(feed)
|
|
completion(.failure(error))
|
|
}
|
|
}
|
|
|
|
folder.removeWebFeed(feed)
|
|
}
|
|
|
|
func moveWebFeed(for account: Account, with feed: WebFeed, from: Container, to: Container, completion: @escaping (Result<Void, Error>) -> Void) {
|
|
guard let from = from as? Folder, let to = to as? Folder else {
|
|
return DispatchQueue.main.async {
|
|
completion(.failure(FeedlyAccountDelegateError.addFeedChooseFolder))
|
|
}
|
|
}
|
|
|
|
addWebFeed(for: account, with: feed, to: to) { [weak self] addResult in
|
|
switch addResult {
|
|
// now that we have added the feed, remove it from the other collection
|
|
case .success:
|
|
self?.removeWebFeed(for: account, with: feed, from: from) { removeResult in
|
|
switch removeResult {
|
|
case .success:
|
|
completion(.success(()))
|
|
case .failure:
|
|
from.addWebFeed(feed)
|
|
completion(.failure(FeedlyAccountDelegateError.unableToMoveFeedBetweenFolders(feed, from, to)))
|
|
}
|
|
}
|
|
case .failure(let error):
|
|
from.addWebFeed(feed)
|
|
to.removeWebFeed(feed)
|
|
completion(.failure(error))
|
|
}
|
|
|
|
}
|
|
|
|
// optimistically move the feed, undoing as appropriate to the failure
|
|
from.removeWebFeed(feed)
|
|
to.addWebFeed(feed)
|
|
}
|
|
|
|
func restoreWebFeed(for account: Account, feed: WebFeed, container: Container, completion: @escaping (Result<Void, Error>) -> Void) {
|
|
if let existingFeed = account.existingWebFeed(withURL: feed.url) {
|
|
account.addWebFeed(existingFeed, to: container) { result in
|
|
switch result {
|
|
case .success:
|
|
completion(.success(()))
|
|
case .failure(let error):
|
|
completion(.failure(error))
|
|
}
|
|
}
|
|
} else {
|
|
createWebFeed(for: account, url: feed.url, name: feed.editedName, container: container) { result in
|
|
switch result {
|
|
case .success:
|
|
completion(.success(()))
|
|
case .failure(let error):
|
|
completion(.failure(error))
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
func restoreFolder(for account: Account, folder: Folder, completion: @escaping (Result<Void, Error>) -> Void) {
|
|
let group = DispatchGroup()
|
|
|
|
for feed in folder.topLevelWebFeeds {
|
|
|
|
folder.topLevelWebFeeds.remove(feed)
|
|
|
|
group.enter()
|
|
restoreWebFeed(for: account, feed: feed, container: folder) { result in
|
|
group.leave()
|
|
switch result {
|
|
case .success:
|
|
break
|
|
case .failure(let error):
|
|
os_log(.error, log: self.log, "Restore folder feed error: %@.", error.localizedDescription)
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
group.notify(queue: .main) {
|
|
account.addFolder(folder)
|
|
completion(.success(()))
|
|
}
|
|
}
|
|
|
|
func markArticles(for account: Account, articles: Set<Article>, statusKey: ArticleStatus.Key, flag: Bool) -> Set<Article>? {
|
|
|
|
let syncStatuses = articles.map { article in
|
|
return SyncStatus(articleID: article.articleID, key: SyncStatus.Key(statusKey), flag: flag)
|
|
}
|
|
|
|
try? database.insertStatuses(syncStatuses)
|
|
os_log(.debug, log: log, "Marking %@ as %@.", articles.map { $0.title }, syncStatuses)
|
|
|
|
database.selectPendingCount { result in
|
|
if let count = try? result.get(), count > 100 {
|
|
self.sendArticleStatus(for: account) { _ in }
|
|
}
|
|
}
|
|
|
|
return try? account.update(articles, statusKey: statusKey, flag: flag)
|
|
}
|
|
|
|
func accountDidInitialize(_ account: Account) {
|
|
initializedAccount = account
|
|
credentials = try? account.retrieveCredentials(type: .oauthAccessToken)
|
|
}
|
|
|
|
func accountWillBeDeleted(_ account: Account) {
|
|
let logout = FeedlyLogoutOperation(account: account, service: caller, log: log)
|
|
// Dispatch on the shared queue because the lifetime of the account delegate is uncertain.
|
|
MainThreadOperationQueue.shared.add(logout)
|
|
}
|
|
|
|
static func validateCredentials(transport: Transport, credentials: Credentials, endpoint: URL?, completion: @escaping (Result<Credentials?, Error>) -> Void) {
|
|
assertionFailure("An `account` instance should enqueue an \(FeedlyRefreshAccessTokenOperation.self) instead.")
|
|
completion(.success(credentials))
|
|
}
|
|
|
|
// MARK: Suspend and Resume (for iOS)
|
|
|
|
/// Suspend all network activity
|
|
func suspendNetwork() {
|
|
caller.suspend()
|
|
operationQueue.cancelAllOperations()
|
|
}
|
|
|
|
/// Suspend the SQLLite databases
|
|
func suspendDatabase() {
|
|
database.suspend()
|
|
}
|
|
|
|
/// Make sure no SQLite databases are open and we are ready to issue network requests.
|
|
func resume() {
|
|
database.resume()
|
|
caller.resume()
|
|
}
|
|
}
|
|
|
|
extension FeedlyAccountDelegate: FeedlyAPICallerDelegate {
|
|
|
|
func reauthorizeFeedlyAPICaller(_ caller: FeedlyAPICaller, completionHandler: @escaping (Bool) -> ()) {
|
|
guard let account = initializedAccount else {
|
|
completionHandler(false)
|
|
return
|
|
}
|
|
|
|
/// Captures a failure to refresh a token, assuming that it was refreshed unless told otherwise.
|
|
final class RefreshAccessTokenOperationDelegate: FeedlyOperationDelegate {
|
|
|
|
private(set) var didReauthorize = true
|
|
|
|
func feedlyOperation(_ operation: FeedlyOperation, didFailWith error: Error) {
|
|
didReauthorize = false
|
|
}
|
|
}
|
|
|
|
let refreshAccessToken = FeedlyRefreshAccessTokenOperation(account: account, service: self, oauthClient: oauthAuthorizationClient, log: log)
|
|
refreshAccessToken.downloadProgress = refreshProgress
|
|
|
|
/// This must be strongly referenced by the completionBlock of the `FeedlyRefreshAccessTokenOperation`.
|
|
let refreshAccessTokenDelegate = RefreshAccessTokenOperationDelegate()
|
|
refreshAccessToken.delegate = refreshAccessTokenDelegate
|
|
|
|
refreshAccessToken.completionBlock = { operation in
|
|
assert(Thread.isMainThread)
|
|
completionHandler(refreshAccessTokenDelegate.didReauthorize && !operation.isCanceled)
|
|
}
|
|
|
|
MainThreadOperationQueue.shared.add(refreshAccessToken)
|
|
}
|
|
}
|