NetNewsWire/Evergreen/Favicons/FaviconDownloader.swift

//
//  FaviconDownloader.swift
//  Evergreen
//
//  Created by Brent Simmons on 11/19/17.
//  Copyright © 2017 Ranchero Software. All rights reserved.
//

import AppKit
import Data
import RSCore
import RSWeb

extension Notification.Name {

	static let FaviconDidBecomeAvailable = Notification.Name("FaviconDidBecomeAvailableNotification") // userInfo keys, one or more of which will be present: homePageURL, faviconURL
}

final class FaviconDownloader {

	private var imageCache = [String: NSImage]()
	private var seekingFaviconCache = [String: SeekingFavicon]() // homePageURL: SeekingFavicon
	private var cache = ThreadSafeCache<NSImage>() // faviconURL: NSImage
	private var faviconURLCache = ThreadSafeCache<String>() // homePageURL: faviconURL
	private let folder: String
	private var urlsBeingDownloaded = Set<String>()
	private var badURLs = Set<String>() // URLs that didn’t work for some reason; don’t try again
	private let binaryCache: RSBinaryCache
	private var badImages = Set<String>() // keys for images on disk that NSImage can’t handle
	private let queue: DispatchQueue

	public struct UserInfoKey {
		static let homePageURL = "homePageURL"
		static let faviconURL = "faviconURL"
		static let image = "image" // NSImage
	}

	init(folder: String) {

		self.folder = folder
		self.binaryCache = RSBinaryCache(folder: folder)
		self.queue = DispatchQueue(label: "FaviconDownloader serial queue - \(folder)")
	}

	// MARK: - API

	func favicon(for feed: Feed) -> NSImage? {

		assert(Thread.isMainThread)

		if let faviconURL = feed.faviconURL {
			// JSON Feeds may include the faviconURL in the feed,
			// so we don’t have to hunt for it.
			return favicon(withURL: faviconURL)
		}

		guard let homePageURL = feed.homePageURL else {
			return nil
		}
		return favicon(withHomePageURL: homePageURL)
	}

	func favicon(withURL faviconURL: String) -> NSImage? {

		if let cachedImage = imageCache[faviconURL] {
			return cachedImage
		}
		
		let controller = faviconController(withURL: faviconURL)
		return favicon(withController: controller)
	}

	func faviconController(withURL faviconURL: String) -> FaviconController {

		if let controller = faviconControllerCache[faviconURL] {
			return controller
		}
		let controller = FaviconController(faviconURL: faviconURL)
		faviconControllerCache[faviconURL] = controller
		return controller
	}

	func favicon(withController controller: FaviconController) -> NSImage? {

		if let image = controller.image {
			return image
		}

		controller.readFromDisk(binaryCache) { (image) in

			if let image = image {
				post
			}
		}

	}

	func findFavicon(for feed: Feed) {

//		if let faviconMetadata = cachedFaviconMetadata
		if let faviconURL = faviconURL(for: feed) {

			// It might be on disk.

			readFaviconFromDisk(faviconURL) { (image) in

				if let image = image {
					self.cache[faviconURL] = image
					self.postFaviconDidBecomeAvailableNotification(homePageURL: homePageURL, faviconURL: faviconURL, image: image)
					return
				}

				// Download it (probably).

				if !self.shouldDownloadFaviconURL(faviconURL) {
					return
				}
				

			}
		}


		// Try to find the faviconURL. It might be in the web page.
		FaviconURLFinder.findFaviconURL(homePageURL) { (faviconURL) in

			if let faviconURL = faviconURL {
				print(faviconURL) // cache it; then download favicon
			}
			else {
				// Try appending /favicon.ico
				// It often works.
			}
		}

		return nil
	}
}

private extension FaviconDownloader {

	func cachedInMemoryFavicon(for feed: Feed) -> NSImage? {

		guard let faviconURL = faviconURL(for: feed), let cachedFavicon = cache[faviconURL]  else {
			return nil
		}
		return cachedFavicon
	}

	func shouldDownloadFaviconURL(_ faviconURL: String) -> Bool {

		return !urlsBeingDownloaded.contains(faviconURL) && !badURLs.contains(faviconURL)
	}

	func downloadFavicon(_ faviconURL: String, _ homePageURL: String) {

		guard let url = URL(string: faviconURL) else {
			return
		}

		urlsBeingDownloaded.insert(faviconURL)

		downloadUsingCache(url) { (data, response, error) in

			self.urlsBeingDownloaded.remove(faviconURL)
			if response == nil || !response!.statusIsOK {
				self.badURLs.insert(faviconURL)
			}

			if let data = data {
				self.queue.async {
					let _ = NSImage(data: data)
				}
			}
		}
	}

	func faviconURL(for feed: Feed) -> String? {

		if let faviconURL = feed.faviconURL {
			return faviconURL
		}

		if let homePageURL = feed.homePageURL {
			return faviconURLCache[homePageURL]
		}
		return nil
	}

	func readFaviconFromDisk(_ faviconURL: String, _ callback: @escaping (NSImage?) -> Void) {

		queue.async {
			let image = self.tryToInstantiateNSImageFromDisk(faviconURL)
			DispatchQueue.main.async {
				callback(image)
			}
		}
	}

	func tryToInstantiateNSImageFromDisk(_ faviconURL: String) -> NSImage? {

		// Call on serial queue.

		if badImages.contains(faviconURL) {
			return nil
		}

		let key = keyFor(faviconURL)
		var data: Data?

		do {
			data = try binaryCache.binaryData(forKey: key)
		}
		catch {
			return nil
		}

		if data == nil {
			return nil
		}

		guard let image = NSImage(data: data!) else {
			badImages.insert(faviconURL)
			return nil
		}

		return image
	}

	func keyFor(_ faviconURL: String) -> String {

		return (faviconURL as NSString).rs_md5Hash()
	}

	func postFaviconDidBecomeAvailableNotification(homePageURL: String, faviconURL: String, image: NSImage) {

		let userInfo: [AnyHashable: Any] = [UserInfoKey.homePageURL: homePageURL, UserInfoKey.faviconURL: faviconURL, UserInfoKey.image: image]
		NotificationCenter.default.post(name: .FaviconDidBecomeAvailable, object: self, userInfo: userInfo)
	}
}