2017-07-02 02:22:19 +02:00
|
|
|
|
//
|
2019-11-15 03:11:41 +01:00
|
|
|
|
// WebFeed.swift
|
2019-07-09 07:58:19 +02:00
|
|
|
|
// NetNewsWire
|
2017-07-02 02:22:19 +02:00
|
|
|
|
//
|
|
|
|
|
// Created by Brent Simmons on 7/1/17.
|
|
|
|
|
// Copyright © 2017 Ranchero Software, LLC. All rights reserved.
|
|
|
|
|
//
|
|
|
|
|
|
|
|
|
|
import Foundation
|
|
|
|
|
import RSCore
|
2017-09-17 21:08:50 +02:00
|
|
|
|
import RSWeb
|
2018-07-28 21:16:14 +02:00
|
|
|
|
import Articles
|
2017-07-02 02:22:19 +02:00
|
|
|
|
|
2019-11-15 13:19:14 +01:00
|
|
|
|
public final class WebFeed: Feed, Renamable, Hashable {
|
|
|
|
|
|
2019-11-22 16:40:39 +01:00
|
|
|
|
public var defaultReadFilterType: ReadFilterType {
|
2019-11-22 02:54:35 +01:00
|
|
|
|
return .none
|
2019-11-22 01:22:43 +01:00
|
|
|
|
}
|
|
|
|
|
|
2019-11-15 13:19:14 +01:00
|
|
|
|
public var feedID: FeedIdentifier? {
|
|
|
|
|
guard let accountID = account?.accountID else {
|
|
|
|
|
assertionFailure("Expected feed.account, but got nil.")
|
|
|
|
|
return nil
|
|
|
|
|
}
|
|
|
|
|
return FeedIdentifier.webFeed(accountID, webFeedID)
|
|
|
|
|
}
|
2017-07-02 02:22:19 +02:00
|
|
|
|
|
2018-09-14 07:37:40 +02:00
|
|
|
|
public weak var account: Account?
|
2017-07-02 02:22:19 +02:00
|
|
|
|
public let url: String
|
2019-05-08 16:54:55 +02:00
|
|
|
|
|
2019-11-15 03:11:41 +01:00
|
|
|
|
public var webFeedID: String {
|
2019-05-08 16:54:55 +02:00
|
|
|
|
get {
|
2019-11-15 03:11:41 +01:00
|
|
|
|
return metadata.webFeedID
|
2019-05-08 16:54:55 +02:00
|
|
|
|
}
|
|
|
|
|
set {
|
2019-11-15 03:11:41 +01:00
|
|
|
|
metadata.webFeedID = newValue
|
2019-05-08 16:54:55 +02:00
|
|
|
|
}
|
|
|
|
|
}
|
2018-09-02 21:14:04 +02:00
|
|
|
|
|
|
|
|
|
public var homePageURL: String? {
|
|
|
|
|
get {
|
2019-03-16 20:08:31 +01:00
|
|
|
|
return metadata.homePageURL
|
2018-09-02 21:14:04 +02:00
|
|
|
|
}
|
|
|
|
|
set {
|
2020-01-12 10:29:56 +01:00
|
|
|
|
if let url = newValue, !url.isEmpty {
|
2020-01-17 03:09:18 +01:00
|
|
|
|
metadata.homePageURL = url.normalizedURL
|
2018-09-02 21:14:04 +02:00
|
|
|
|
}
|
|
|
|
|
else {
|
2019-03-16 20:08:31 +01:00
|
|
|
|
metadata.homePageURL = nil
|
2018-09-02 21:14:04 +02:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2019-09-09 06:17:57 +02:00
|
|
|
|
// Note: this is available only if the icon URL was available in the feed.
|
|
|
|
|
// The icon URL is a JSON-Feed-only feature.
|
|
|
|
|
// Otherwise we find an icon URL via other means, but we don’t store it
|
|
|
|
|
// as part of feed metadata.
|
2018-09-15 06:51:05 +02:00
|
|
|
|
public var iconURL: String? {
|
|
|
|
|
get {
|
2019-03-16 20:08:31 +01:00
|
|
|
|
return metadata.iconURL
|
2018-09-15 06:51:05 +02:00
|
|
|
|
}
|
|
|
|
|
set {
|
2019-03-16 20:08:31 +01:00
|
|
|
|
metadata.iconURL = newValue
|
2018-09-15 06:51:05 +02:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2019-09-09 06:17:57 +02:00
|
|
|
|
// Note: this is available only if the favicon URL was available in the feed.
|
|
|
|
|
// The favicon URL is a JSON-Feed-only feature.
|
|
|
|
|
// Otherwise we find a favicon URL via other means, but we don’t store it
|
|
|
|
|
// as part of feed metadata.
|
2018-09-15 06:51:05 +02:00
|
|
|
|
public var faviconURL: String? {
|
|
|
|
|
get {
|
2019-03-16 20:08:31 +01:00
|
|
|
|
return metadata.faviconURL
|
2018-09-15 06:51:05 +02:00
|
|
|
|
}
|
|
|
|
|
set {
|
2019-03-16 20:08:31 +01:00
|
|
|
|
metadata.faviconURL = newValue
|
2018-09-15 06:51:05 +02:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2019-09-23 19:29:48 +02:00
|
|
|
|
public var name: String?
|
2018-09-15 20:45:01 +02:00
|
|
|
|
|
2018-09-15 20:16:05 +02:00
|
|
|
|
public var authors: Set<Author>? {
|
|
|
|
|
get {
|
2019-03-16 20:08:31 +01:00
|
|
|
|
if let authorsArray = metadata.authors {
|
2019-03-14 07:41:43 +01:00
|
|
|
|
return Set(authorsArray)
|
2018-09-15 20:16:05 +02:00
|
|
|
|
}
|
2019-03-14 07:41:43 +01:00
|
|
|
|
return nil
|
2018-09-15 20:16:05 +02:00
|
|
|
|
}
|
|
|
|
|
set {
|
2019-03-14 07:41:43 +01:00
|
|
|
|
if let authorsSet = newValue {
|
2019-03-16 20:08:31 +01:00
|
|
|
|
metadata.authors = Array(authorsSet)
|
2018-09-15 20:16:05 +02:00
|
|
|
|
}
|
|
|
|
|
else {
|
2019-03-16 20:08:31 +01:00
|
|
|
|
metadata.authors = nil
|
2018-09-15 20:16:05 +02:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
2018-01-24 06:49:33 +01:00
|
|
|
|
|
|
|
|
|
public var editedName: String? {
|
2019-02-03 02:46:15 +01:00
|
|
|
|
// Don’t let editedName == ""
|
2018-09-15 20:39:33 +02:00
|
|
|
|
get {
|
2019-03-16 20:08:31 +01:00
|
|
|
|
guard let s = metadata.editedName, !s.isEmpty else {
|
2019-02-03 02:46:15 +01:00
|
|
|
|
return nil
|
|
|
|
|
}
|
|
|
|
|
return s
|
2018-09-15 20:39:33 +02:00
|
|
|
|
}
|
|
|
|
|
set {
|
|
|
|
|
if newValue != editedName {
|
2019-02-03 02:46:15 +01:00
|
|
|
|
if let valueToSet = newValue, !valueToSet.isEmpty {
|
2019-03-16 20:08:31 +01:00
|
|
|
|
metadata.editedName = valueToSet
|
2019-02-03 02:46:15 +01:00
|
|
|
|
}
|
|
|
|
|
else {
|
2019-03-16 20:08:31 +01:00
|
|
|
|
metadata.editedName = nil
|
2019-02-03 02:46:15 +01:00
|
|
|
|
}
|
2018-09-15 20:39:33 +02:00
|
|
|
|
postDisplayNameDidChangeNotification()
|
|
|
|
|
}
|
2018-01-24 06:49:33 +01:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2018-09-15 04:33:47 +02:00
|
|
|
|
public var conditionalGetInfo: HTTPConditionalGetInfo? {
|
|
|
|
|
get {
|
2019-03-16 20:08:31 +01:00
|
|
|
|
return metadata.conditionalGetInfo
|
2018-09-15 04:33:47 +02:00
|
|
|
|
}
|
|
|
|
|
set {
|
2019-03-16 20:08:31 +01:00
|
|
|
|
metadata.conditionalGetInfo = newValue
|
2018-09-15 04:33:47 +02:00
|
|
|
|
}
|
|
|
|
|
}
|
2018-09-15 06:51:05 +02:00
|
|
|
|
|
2018-09-14 07:52:34 +02:00
|
|
|
|
public var contentHash: String? {
|
|
|
|
|
get {
|
2019-03-16 20:08:31 +01:00
|
|
|
|
return metadata.contentHash
|
2018-09-14 07:52:34 +02:00
|
|
|
|
}
|
|
|
|
|
set {
|
2019-03-16 20:08:31 +01:00
|
|
|
|
metadata.contentHash = newValue
|
2018-09-14 07:52:34 +02:00
|
|
|
|
}
|
|
|
|
|
}
|
2017-09-17 00:25:38 +02:00
|
|
|
|
|
2019-10-03 02:42:16 +02:00
|
|
|
|
public var isNotifyAboutNewArticles: Bool? {
|
|
|
|
|
get {
|
|
|
|
|
return metadata.isNotifyAboutNewArticles
|
|
|
|
|
}
|
|
|
|
|
set {
|
|
|
|
|
metadata.isNotifyAboutNewArticles = newValue
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2019-09-20 03:12:55 +02:00
|
|
|
|
public var isArticleExtractorAlwaysOn: Bool? {
|
2019-09-20 02:49:11 +02:00
|
|
|
|
get {
|
|
|
|
|
return metadata.isArticleExtractorAlwaysOn
|
|
|
|
|
}
|
|
|
|
|
set {
|
|
|
|
|
metadata.isArticleExtractorAlwaysOn = newValue
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2020-05-02 15:12:05 +02:00
|
|
|
|
public var sinceToken: String? {
|
|
|
|
|
get {
|
|
|
|
|
return metadata.sinceToken
|
|
|
|
|
}
|
|
|
|
|
set {
|
|
|
|
|
metadata.sinceToken = newValue
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2020-03-21 17:33:13 +01:00
|
|
|
|
public var externalID: String? {
|
2019-05-09 01:13:54 +02:00
|
|
|
|
get {
|
2020-03-21 17:33:13 +01:00
|
|
|
|
return metadata.externalID
|
2019-05-09 01:13:54 +02:00
|
|
|
|
}
|
|
|
|
|
set {
|
2020-03-21 17:33:13 +01:00
|
|
|
|
metadata.externalID = newValue
|
2019-05-09 01:13:54 +02:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2019-05-08 01:34:45 +02:00
|
|
|
|
// Folder Name: Sync Service Relationship ID
|
|
|
|
|
public var folderRelationship: [String: String]? {
|
|
|
|
|
get {
|
|
|
|
|
return metadata.folderRelationship
|
|
|
|
|
}
|
|
|
|
|
set {
|
|
|
|
|
metadata.folderRelationship = newValue
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2017-09-17 00:25:38 +02:00
|
|
|
|
// MARK: - DisplayNameProvider
|
|
|
|
|
|
2017-07-02 02:22:19 +02:00
|
|
|
|
public var nameForDisplay: String {
|
2018-02-14 22:14:25 +01:00
|
|
|
|
if let s = editedName, !s.isEmpty {
|
|
|
|
|
return s
|
2017-07-02 02:22:19 +02:00
|
|
|
|
}
|
2018-02-14 22:14:25 +01:00
|
|
|
|
if let s = name, !s.isEmpty {
|
|
|
|
|
return s
|
|
|
|
|
}
|
|
|
|
|
return NSLocalizedString("Untitled", comment: "Feed name")
|
2017-07-02 02:22:19 +02:00
|
|
|
|
}
|
|
|
|
|
|
2018-11-22 22:57:49 +01:00
|
|
|
|
// MARK: - Renamable
|
|
|
|
|
|
2019-05-06 17:53:20 +02:00
|
|
|
|
public func rename(to newName: String, completion: @escaping (Result<Void, Error>) -> Void) {
|
2019-05-09 00:55:53 +02:00
|
|
|
|
guard let account = account else { return }
|
2019-11-15 03:11:41 +01:00
|
|
|
|
account.renameWebFeed(self, to: newName, completion: completion)
|
2018-11-22 22:57:49 +01:00
|
|
|
|
}
|
|
|
|
|
|
2017-09-17 00:25:38 +02:00
|
|
|
|
// MARK: - UnreadCountProvider
|
2017-07-03 19:29:44 +02:00
|
|
|
|
|
2018-09-15 07:06:03 +02:00
|
|
|
|
public var unreadCount: Int {
|
|
|
|
|
get {
|
|
|
|
|
return account?.unreadCount(for: self) ?? 0
|
|
|
|
|
}
|
|
|
|
|
set {
|
|
|
|
|
if unreadCount == newValue {
|
|
|
|
|
return
|
2017-09-17 00:25:38 +02:00
|
|
|
|
}
|
2018-09-15 07:06:03 +02:00
|
|
|
|
account?.setUnreadCount(newValue, for: self)
|
|
|
|
|
postUnreadCountDidChangeNotification()
|
2017-09-17 00:25:38 +02:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2019-11-15 03:11:41 +01:00
|
|
|
|
var metadata: WebFeedMetadata
|
2019-09-23 04:20:01 +02:00
|
|
|
|
|
2019-03-17 19:24:21 +01:00
|
|
|
|
// MARK: - Private
|
|
|
|
|
|
2018-09-15 07:15:22 +02:00
|
|
|
|
private let accountID: String // Used for hashing and equality; account may turn nil
|
2019-03-14 07:41:43 +01:00
|
|
|
|
|
2017-09-17 00:25:38 +02:00
|
|
|
|
// MARK: - Init
|
|
|
|
|
|
2019-11-15 03:11:41 +01:00
|
|
|
|
init(account: Account, url: String, metadata: WebFeedMetadata) {
|
2018-09-14 07:37:40 +02:00
|
|
|
|
self.account = account
|
2018-09-15 07:15:22 +02:00
|
|
|
|
self.accountID = account.accountID
|
2017-07-02 02:22:19 +02:00
|
|
|
|
self.url = url
|
2019-03-16 20:08:31 +01:00
|
|
|
|
self.metadata = metadata
|
2017-07-02 02:22:19 +02:00
|
|
|
|
}
|
|
|
|
|
|
2020-04-10 23:25:58 +02:00
|
|
|
|
// MARK: - API
|
|
|
|
|
|
|
|
|
|
public func dropConditionalGetInfo() {
|
2017-11-25 20:13:15 +01:00
|
|
|
|
conditionalGetInfo = nil
|
|
|
|
|
contentHash = nil
|
|
|
|
|
}
|
|
|
|
|
|
2018-08-25 20:54:58 +02:00
|
|
|
|
// MARK: - Hashable
|
|
|
|
|
|
|
|
|
|
public func hash(into hasher: inout Hasher) {
|
2019-11-15 03:11:41 +01:00
|
|
|
|
hasher.combine(webFeedID)
|
2018-08-25 20:54:58 +02:00
|
|
|
|
}
|
|
|
|
|
|
2017-11-25 20:13:15 +01:00
|
|
|
|
// MARK: - Equatable
|
|
|
|
|
|
2019-11-15 03:11:41 +01:00
|
|
|
|
public class func ==(lhs: WebFeed, rhs: WebFeed) -> Bool {
|
|
|
|
|
return lhs.webFeedID == rhs.webFeedID && lhs.accountID == rhs.accountID
|
2017-07-02 02:22:19 +02:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2017-09-17 00:25:38 +02:00
|
|
|
|
// MARK: - OPMLRepresentable
|
|
|
|
|
|
2019-11-15 03:11:41 +01:00
|
|
|
|
extension WebFeed: OPMLRepresentable {
|
2017-09-17 00:25:38 +02:00
|
|
|
|
|
2020-01-14 05:20:20 +01:00
|
|
|
|
public func OPMLString(indentLevel: Int, allowCustomAttributes: Bool) -> String {
|
2019-02-07 06:18:22 +01:00
|
|
|
|
// https://github.com/brentsimmons/NetNewsWire/issues/527
|
|
|
|
|
// Don’t use nameForDisplay because that can result in a feed name "Untitled" written to disk,
|
|
|
|
|
// which NetNewsWire may take later to be the actual name.
|
|
|
|
|
var nameToUse = editedName
|
|
|
|
|
if nameToUse == nil {
|
|
|
|
|
nameToUse = name
|
|
|
|
|
}
|
|
|
|
|
if nameToUse == nil {
|
|
|
|
|
nameToUse = ""
|
|
|
|
|
}
|
2020-01-17 03:09:18 +01:00
|
|
|
|
let escapedName = nameToUse!.escapingSpecialXMLCharacters
|
2019-02-07 06:18:22 +01:00
|
|
|
|
|
2017-09-17 00:25:38 +02:00
|
|
|
|
var escapedHomePageURL = ""
|
|
|
|
|
if let homePageURL = homePageURL {
|
2020-01-17 03:09:18 +01:00
|
|
|
|
escapedHomePageURL = homePageURL.escapingSpecialXMLCharacters
|
2017-09-17 00:25:38 +02:00
|
|
|
|
}
|
2020-01-17 03:09:18 +01:00
|
|
|
|
let escapedFeedURL = url.escapingSpecialXMLCharacters
|
2017-09-17 00:25:38 +02:00
|
|
|
|
|
|
|
|
|
var s = "<outline text=\"\(escapedName)\" title=\"\(escapedName)\" description=\"\" type=\"rss\" version=\"RSS\" htmlUrl=\"\(escapedHomePageURL)\" xmlUrl=\"\(escapedFeedURL)\"/>\n"
|
2020-01-17 03:09:18 +01:00
|
|
|
|
s = s.prepending(tabCount: indentLevel)
|
2017-09-17 00:25:38 +02:00
|
|
|
|
|
|
|
|
|
return s
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2019-11-15 03:11:41 +01:00
|
|
|
|
extension Set where Element == WebFeed {
|
2018-07-28 21:16:14 +02:00
|
|
|
|
|
2019-11-15 03:11:41 +01:00
|
|
|
|
func webFeedIDs() -> Set<String> {
|
|
|
|
|
return Set<String>(map { $0.webFeedID })
|
2018-07-28 21:16:14 +02:00
|
|
|
|
}
|
2020-01-06 21:58:51 +01:00
|
|
|
|
|
|
|
|
|
func sorted() -> Array<WebFeed> {
|
|
|
|
|
return sorted(by: { (webFeed1, webFeed2) -> Bool in
|
|
|
|
|
if webFeed1.nameForDisplay.localizedStandardCompare(webFeed2.nameForDisplay) == .orderedSame {
|
|
|
|
|
return webFeed1.url < webFeed2.url
|
|
|
|
|
}
|
|
|
|
|
return webFeed1.nameForDisplay.localizedStandardCompare(webFeed2.nameForDisplay) == .orderedAscending
|
|
|
|
|
})
|
|
|
|
|
}
|
|
|
|
|
|
2018-07-28 21:16:14 +02:00
|
|
|
|
}
|