NetNewsWire/Frameworks/Account/Container.swift

//
//  Container.swift
//  NetNewsWire
//
//  Created by Brent Simmons on 4/17/16.
//  Copyright © 2016 Ranchero Software, LLC. All rights reserved.
//

import Foundation
import RSCore
import Articles

extension Notification.Name {
	
	public static let ChildrenDidChange = Notification.Name("ChildrenDidChange")
}

public protocol Container: class, ContainerIdentifiable {

	var account: Account? { get }
	var topLevelWebFeeds: Set<WebFeed> { get set }
	var folders: Set<Folder>? { get set }
	var externalID: String? { get set }
	
	func hasAtLeastOneWebFeed() -> Bool
	func objectIsChild(_ object: AnyObject) -> Bool

	func hasChildFolder(with: String) -> Bool
	func childFolder(with: String) -> Folder?

    func removeWebFeed(_ webFeed: WebFeed)
	func addWebFeed(_ webFeed: WebFeed)

	//Recursive — checks subfolders
	func flattenedWebFeeds() -> Set<WebFeed>
	func has(_ webFeed: WebFeed) -> Bool
	func hasWebFeed(with webFeedID: String) -> Bool
	func hasWebFeed(withURL url: String) -> Bool
	func existingWebFeed(withWebFeedID: String) -> WebFeed?
	func existingWebFeed(withURL url: String) -> WebFeed?
	func existingWebFeed(withExternalID externalID: String) -> WebFeed?
	func existingFolder(with name: String) -> Folder?
	func existingFolder(withID: Int) -> Folder?

	func postChildrenDidChangeNotification()
}

public extension Container {

	func hasAtLeastOneWebFeed() -> Bool {
		return topLevelWebFeeds.count > 0
	}

	func hasChildFolder(with name: String) -> Bool {
		return childFolder(with: name) != nil
	}

	func childFolder(with name: String) -> Folder? {
		guard let folders = folders else {
			return nil
		}
		for folder in folders {
			if folder.name == name {
				return folder
			}
		}
		return nil
	}

	func objectIsChild(_ object: AnyObject) -> Bool {
		if let feed = object as? WebFeed {
			return topLevelWebFeeds.contains(feed)
		}
		if let folder = object as? Folder {
			return folders?.contains(folder) ?? false
		}
		return false
	}

	func flattenedWebFeeds() -> Set<WebFeed> {
		var feeds = Set<WebFeed>()
		feeds.formUnion(topLevelWebFeeds)
		if let folders = folders {
			for folder in folders {
				feeds.formUnion(folder.flattenedWebFeeds())
			}
		}
		return feeds
	}

	func hasWebFeed(with webFeedID: String) -> Bool {
		return existingWebFeed(withWebFeedID: webFeedID) != nil
	}

	func hasWebFeed(withURL url: String) -> Bool {
		return existingWebFeed(withURL: url) != nil
	}

	func has(_ webFeed: WebFeed) -> Bool {
		return flattenedWebFeeds().contains(webFeed)
	}
	
	func existingWebFeed(withWebFeedID webFeedID: String) -> WebFeed? {
		for feed in flattenedWebFeeds() {
			if feed.webFeedID == webFeedID {
				return feed
			}
		}
		return nil
	}

	func existingWebFeed(withURL url: String) -> WebFeed? {
		for feed in flattenedWebFeeds() {
			if feed.url == url {
				return feed
			}
		}
		return nil
	}
	
	func existingWebFeed(withExternalID externalID: String) -> WebFeed? {
		for feed in flattenedWebFeeds() {
			if feed.externalID == externalID {
				return feed
			}
		}
		return nil
	}

	func existingFolder(with name: String) -> Folder? {
		guard let folders = folders else {
			return nil
		}

		for folder in folders {
			if folder.name == name {
				return folder
			}
			if let subFolder = folder.existingFolder(with: name) {
				return subFolder
			}
		}
		return nil
	}

	func existingFolder(withID folderID: Int) -> Folder? {
		guard let folders = folders else {
			return nil
		}

		for folder in folders {
			if folder.folderID == folderID {
				return folder
			}
			if let subFolder = folder.existingFolder(withID: folderID) {
				return subFolder
			}
		}
		return nil
	}

	func postChildrenDidChangeNotification() {
		NotificationCenter.default.post(name: .ChildrenDidChange, object: self)
	}
}