NetNewsWire/Evergreen/Favicons/FaviconDownloader.swift

175 lines
4.5 KiB
Swift
Raw Normal View History

2017-11-20 08:59:04 +01:00
//
// FaviconDownloader.swift
// Evergreen
//
// Created by Brent Simmons on 11/19/17.
// Copyright © 2017 Ranchero Software. All rights reserved.
//
import AppKit
import Data
import RSCore
extension Notification.Name {
static let FaviconDidBecomeAvailable = Notification.Name("FaviconDidBecomeAvailableNotification") // userInfo key: FaviconDownloader.UserInfoKey.faviconURL
2017-11-20 08:59:04 +01:00
}
final class FaviconDownloader {
private let folder: String
private let diskCache: BinaryDiskCache
private var singleFaviconDownloaderCache = [String: SingleFaviconDownloader]() // faviconURL: SingleFaviconDownloader
private var homePageToFaviconURLCache = [String: String]() //homePageURL: faviconURL
private var homePageURLsWithNoFaviconURL = Set<String>()
2017-11-20 08:59:04 +01:00
private let queue: DispatchQueue
struct UserInfoKey {
2017-11-20 08:59:04 +01:00
static let faviconURL = "faviconURL"
}
init(folder: String) {
self.folder = folder
self.diskCache = BinaryDiskCache(folder: folder)
2017-11-23 23:15:28 +01:00
self.queue = DispatchQueue(label: "FaviconDownloader serial queue - \(folder)")
NotificationCenter.default.addObserver(self, selector: #selector(didLoadFavicon(_:)), name: .DidLoadFavicon, object: nil)
2017-11-20 08:59:04 +01:00
}
// MARK: - API
func favicon(for feed: Feed) -> NSImage? {
assert(Thread.isMainThread)
2017-11-24 19:45:22 +01:00
if let faviconURL = feed.faviconURL {
return favicon(with: faviconURL)
2017-11-24 19:45:22 +01:00
}
var homePageURL = feed.homePageURL
if homePageURL == nil {
// Base homePageURL off feedURL if needed. Wont always be accurate, but is good enough.
if let feedURL = URL(string: feed.url), let scheme = feedURL.scheme, let host = feedURL.host {
homePageURL = scheme + "://" + host + "/"
}
}
if let homePageURL = homePageURL {
return favicon(withHomePageURL: homePageURL)
}
return nil
2017-11-24 19:45:22 +01:00
}
func favicon(with faviconURL: String) -> NSImage? {
2017-11-24 19:45:22 +01:00
let downloader = faviconDownloader(withURL: faviconURL)
return downloader.image
2017-11-24 19:45:22 +01:00
}
func favicon(withHomePageURL homePageURL: String) -> NSImage? {
let url = normalizedHomePageURL(homePageURL)
if homePageURLsWithNoFaviconURL.contains(url) {
return nil
2017-11-24 19:45:22 +01:00
}
if let faviconURL = homePageToFaviconURLCache[url] {
return favicon(with: faviconURL)
}
2017-11-24 19:45:22 +01:00
findFaviconURL(with: url) { (faviconURL) in
if let faviconURL = faviconURL {
self.homePageToFaviconURLCache[url] = faviconURL
let _ = self.favicon(with: faviconURL)
}
else {
self.homePageURLsWithNoFaviconURL.insert(url)
}
2017-11-23 23:15:28 +01:00
}
return nil
2017-11-23 23:15:28 +01:00
}
// MARK: - Notifications
@objc func didLoadFavicon(_ note: Notification) {
2017-11-23 23:15:28 +01:00
guard let singleFaviconDownloader = note.object as? SingleFaviconDownloader else {
return
}
guard let _ = singleFaviconDownloader.image else {
return
2017-11-20 08:59:04 +01:00
}
postFaviconDidBecomeAvailableNotification(singleFaviconDownloader.faviconURL)
2017-11-20 08:59:04 +01:00
}
}
private extension FaviconDownloader {
static let localeForLowercasing = Locale(identifier: "en_US")
func findFaviconURL(with homePageURL: String, _ completion: @escaping (String?) -> Void) {
guard let url = URL(string: homePageURL) else {
completion(nil)
return
}
FaviconURLFinder.findFaviconURL(homePageURL) { (faviconURL) in
if let faviconURL = faviconURL {
completion(faviconURL)
return
}
guard let scheme = url.scheme, let host = url.host else {
completion(nil)
return
}
let defaultFaviconURL = "\(scheme)://\(host)/favicon.ico".lowercased(with: FaviconDownloader.localeForLowercasing)
completion(defaultFaviconURL)
}
}
func normalizedHomePageURL(_ url: String) -> String {
// Many times the homePageURL is missing a trailing /.
// We add one when needed.
guard !url.hasSuffix("/") else {
return url
}
let lowercasedURL = url.lowercased(with: FaviconDownloader.localeForLowercasing)
guard lowercasedURL.hasPrefix("http://") || lowercasedURL.hasPrefix("https://") else {
return url
}
guard url.components(separatedBy: "/").count < 4 else {
return url
}
return url + "/"
}
func faviconDownloader(withURL faviconURL: String) -> SingleFaviconDownloader {
2017-11-20 08:59:04 +01:00
if let downloader = singleFaviconDownloaderCache[faviconURL] {
downloader.downloadFaviconIfNeeded()
return downloader
2017-11-20 08:59:04 +01:00
}
let downloader = SingleFaviconDownloader(faviconURL: faviconURL, diskCache: diskCache, queue: queue)
singleFaviconDownloaderCache[faviconURL] = downloader
return downloader
2017-11-20 08:59:04 +01:00
}
func postFaviconDidBecomeAvailableNotification(_ faviconURL: String) {
2017-11-23 23:15:28 +01:00
DispatchQueue.main.async {
let userInfo: [AnyHashable: Any] = [UserInfoKey.faviconURL: faviconURL]
NotificationCenter.default.post(name: .FaviconDidBecomeAvailable, object: self, userInfo: userInfo)
}
2017-11-23 23:15:28 +01:00
}
2017-11-20 08:59:04 +01:00
}