NetNewsWire/Frameworks/Account/WebFeed.swift

299 lines
6.3 KiB
Swift
Raw Normal View History

//
// WebFeed.swift
// NetNewsWire
//
// 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
import Articles
2019-11-15 13:19:14 +01:00
public final class WebFeed: Feed, Renamable, Hashable {
public var defaultReadFilterType: ReadFilterType {
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)
}
public weak var account: Account?
public let url: String
public var webFeedID: String {
get {
return metadata.webFeedID
}
set {
metadata.webFeedID = newValue
}
}
public var homePageURL: String? {
get {
return metadata.homePageURL
}
set {
2020-01-12 10:29:56 +01:00
if let url = newValue, !url.isEmpty {
metadata.homePageURL = url.normalizedURL
}
else {
metadata.homePageURL = nil
}
}
}
// 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 dont store it
// as part of feed metadata.
2018-09-15 06:51:05 +02:00
public var iconURL: String? {
get {
return metadata.iconURL
2018-09-15 06:51:05 +02:00
}
set {
metadata.iconURL = newValue
2018-09-15 06:51:05 +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 dont store it
// as part of feed metadata.
2018-09-15 06:51:05 +02:00
public var faviconURL: String? {
get {
return metadata.faviconURL
2018-09-15 06:51:05 +02:00
}
set {
metadata.faviconURL = newValue
2018-09-15 06:51:05 +02:00
}
}
public var name: String?
public var authors: Set<Author>? {
get {
if let authorsArray = metadata.authors {
return Set(authorsArray)
}
return nil
}
set {
if let authorsSet = newValue {
metadata.authors = Array(authorsSet)
}
else {
metadata.authors = nil
}
}
}
public var editedName: String? {
// Dont let editedName == ""
2018-09-15 20:39:33 +02:00
get {
guard let s = metadata.editedName, !s.isEmpty else {
return nil
}
return s
2018-09-15 20:39:33 +02:00
}
set {
if newValue != editedName {
if let valueToSet = newValue, !valueToSet.isEmpty {
metadata.editedName = valueToSet
}
else {
metadata.editedName = nil
}
2018-09-15 20:39:33 +02:00
postDisplayNameDidChangeNotification()
}
}
}
2018-09-15 04:33:47 +02:00
public var conditionalGetInfo: HTTPConditionalGetInfo? {
get {
return metadata.conditionalGetInfo
2018-09-15 04:33:47 +02:00
}
set {
metadata.conditionalGetInfo = newValue
2018-09-15 04:33:47 +02:00
}
}
2018-09-15 06:51:05 +02:00
public var contentHash: String? {
get {
return metadata.contentHash
}
set {
metadata.contentHash = newValue
}
}
public var isNotifyAboutNewArticles: Bool? {
get {
return metadata.isNotifyAboutNewArticles
}
set {
metadata.isNotifyAboutNewArticles = newValue
}
}
public var isArticleExtractorAlwaysOn: Bool? {
get {
return metadata.isArticleExtractorAlwaysOn
}
set {
metadata.isArticleExtractorAlwaysOn = newValue
}
}
public var sinceToken: String? {
get {
return metadata.sinceToken
}
set {
metadata.sinceToken = newValue
}
}
public var externalID: String? {
get {
return metadata.externalID
}
set {
metadata.externalID = newValue
}
}
// Folder Name: Sync Service Relationship ID
public var folderRelationship: [String: String]? {
get {
return metadata.folderRelationship
}
set {
metadata.folderRelationship = newValue
}
}
// MARK: - DisplayNameProvider
public var nameForDisplay: String {
if let s = editedName, !s.isEmpty {
return s
}
if let s = name, !s.isEmpty {
return s
}
return NSLocalizedString("Untitled", comment: "Feed name")
}
// 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 }
account.renameWebFeed(self, to: newName, completion: completion)
}
// MARK: - UnreadCountProvider
public var unreadCount: Int {
get {
return account?.unreadCount(for: self) ?? 0
}
set {
if unreadCount == newValue {
return
}
account?.setUnreadCount(newValue, for: self)
postUnreadCountDidChangeNotification()
}
}
var metadata: WebFeedMetadata
// MARK: - Private
private let accountID: String // Used for hashing and equality; account may turn nil
// MARK: - Init
init(account: Account, url: String, metadata: WebFeedMetadata) {
self.account = account
self.accountID = account.accountID
self.url = url
self.metadata = metadata
}
// MARK: - API
public func dropConditionalGetInfo() {
conditionalGetInfo = nil
contentHash = nil
}
// MARK: - Hashable
public func hash(into hasher: inout Hasher) {
hasher.combine(webFeedID)
}
// MARK: - Equatable
public class func ==(lhs: WebFeed, rhs: WebFeed) -> Bool {
return lhs.webFeedID == rhs.webFeedID && lhs.accountID == rhs.accountID
}
}
// MARK: - OPMLRepresentable
extension WebFeed: OPMLRepresentable {
public func OPMLString(indentLevel: Int, allowCustomAttributes: Bool) -> String {
// https://github.com/brentsimmons/NetNewsWire/issues/527
// Dont 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 = ""
}
let escapedName = nameToUse!.escapingSpecialXMLCharacters
var escapedHomePageURL = ""
if let homePageURL = homePageURL {
escapedHomePageURL = homePageURL.escapingSpecialXMLCharacters
}
let escapedFeedURL = url.escapingSpecialXMLCharacters
var s = "<outline text=\"\(escapedName)\" title=\"\(escapedName)\" description=\"\" type=\"rss\" version=\"RSS\" htmlUrl=\"\(escapedHomePageURL)\" xmlUrl=\"\(escapedFeedURL)\"/>\n"
s = s.prepending(tabCount: indentLevel)
return s
}
}
extension Set where Element == WebFeed {
func webFeedIDs() -> Set<String> {
return Set<String>(map { $0.webFeedID })
}
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
})
}
}