NetNewsWire/Frameworks/Account/OPMLFile.swift

//
//  OPMLFile.swift
//  Account
//
//  Created by Maurice Parker on 9/12/19.
//  Copyright © 2019 Ranchero Software, LLC. All rights reserved.
//

import Foundation
import os.log
import RSCore
import RSParser

final class OPMLFile {
	
	private var log = OSLog(subsystem: Bundle.main.bundleIdentifier!, category: "opmlFile")

	private let fileURL: URL
	private let account: Account
	private lazy var managedFile = ManagedResourceFile(fileURL: fileURL, load: loadCallback, save: saveCallback)
	
	init(filename: String, account: Account) {
		self.fileURL = URL(fileURLWithPath: filename)
		self.account = account
	}
	
	func markAsDirty() {
		managedFile.markAsDirty()
	}
	
	func load() {
		managedFile.load()
	}
	
	func save() {
		managedFile.saveIfNecessary()
	}
	
	func suspend() {
		managedFile.suspend()
	}
	
	func resume() {
		managedFile.resume()
	}
	
}

private extension OPMLFile {

	func loadCallback() {
		guard let fileData = opmlFileData() else {
			return
		}
		
		// Don't rebuild the account if the OPML hasn't changed since the last save
		guard let opml = String(data: fileData, encoding: .utf8), opml != opmlDocument() else {
			return
		}
		
		guard let opmlItems = parsedOPMLItems(fileData: fileData) else { return }
		
		BatchUpdate.shared.perform {
			account.topLevelWebFeeds.removeAll()
			account.loadOPMLItems(opmlItems, parentFolder: nil)
		}
	}
	
	func saveCallback() {
		guard !account.isDeleted else { return }
		
		let opmlDocumentString = opmlDocument()
		
		let errorPointer: NSErrorPointer = nil
		let fileCoordinator = NSFileCoordinator(filePresenter: managedFile)
		
		fileCoordinator.coordinate(writingItemAt: fileURL, options: [], error: errorPointer, byAccessor: { writeURL in
			do {
				try opmlDocumentString.write(to: writeURL, atomically: true, encoding: .utf8)
			} catch let error as NSError {
				os_log(.error, log: log, "OPML save to disk failed: %@.", error.localizedDescription)
			}
		})
		
		if let error = errorPointer?.pointee {
			os_log(.error, log: log, "OPML save to disk coordination failed: %@.", error.localizedDescription)
		}
	}
	
	func opmlFileData() -> Data? {
		var fileData: Data? = nil
		let errorPointer: NSErrorPointer = nil
		let fileCoordinator = NSFileCoordinator(filePresenter: managedFile)
		
		fileCoordinator.coordinate(readingItemAt: fileURL, options: [], error: errorPointer, byAccessor: { readURL in
			do {
				fileData = try Data(contentsOf: readURL)
			} catch {
				// Commented out because it’s not an error on first run.
				// TODO: make it so we know if it’s first run or not.
				//NSApplication.shared.presentError(error)
				os_log(.error, log: log, "OPML read from disk failed: %@.", error.localizedDescription)
			}
		})
		
		if let error = errorPointer?.pointee {
			os_log(.error, log: log, "OPML read from disk coordination failed: %@.", error.localizedDescription)
		}

		return fileData
	}
	
	func parsedOPMLItems(fileData: Data) -> [RSOPMLItem]? {
		let parserData = ParserData(url: fileURL.absoluteString, data: fileData)
		var opmlDocument: RSOPMLDocument?

		do {
			opmlDocument = try RSOPMLParser.parseOPML(with: parserData)
		} catch {
			os_log(.error, log: log, "OPML Import failed: %@.", error.localizedDescription)
			return nil
		}
		
		return opmlDocument?.children
	}
	
	func opmlDocument() -> String {
		let escapedTitle = account.nameForDisplay.escapingSpecialXMLCharacters
		let openingText =
		"""
		<?xml version="1.0" encoding="UTF-8"?>
		<!-- OPML generated by NetNewsWire -->
		<opml version="1.1">
		<head>
		<title>\(escapedTitle)</title>
		</head>
		<body>

		"""

		let middleText = account.OPMLString(indentLevel: 0, allowCustomAttributes: true)

		let closingText =
		"""
				</body>
			</opml>
			"""

		let opml = openingText + middleText + closingText
		return opml
	}
	
}
-												Move OPML I/O functions into a separate OPMLFile class

											
										
										
											2019-09-13 01:05:29 +02:00
+								//
 								//  OPMLFile.swift
 								//  Account
 								//
 								//  Created by Maurice Parker on 9/12/19.
 								//  Copyright © 2019 Ranchero Software, LLC. All rights reserved.
 								//
 								import Foundation
 								import os.log
 								import RSCore
 								import RSParser
-												Modify OPMLFile to use the new ManagedResourceFile utility class

											
										
										
											2019-09-13 22:46:22 +02:00
+								final class OPMLFile {
-												Move OPML I/O functions into a separate OPMLFile class

											
										
										
											2019-09-13 01:05:29 +02:00
-												Fix log category name

											
										
										
											2019-09-13 21:56:24 +02:00
+									private var log = OSLog(subsystem: Bundle.main.bundleIdentifier!, category: "opmlFile")
-												Move OPML I/O functions into a separate OPMLFile class

											
										
										
											2019-09-13 01:05:29 +02:00
-												Add file coordination for the OPML file

											
										
										
											2019-09-13 17:48:04 +02:00
+									private let fileURL: URL
-												Move OPML I/O functions into a separate OPMLFile class

											
										
										
											2019-09-13 01:05:29 +02:00
+									private let account: Account
-												Make account metadata a managed resource file

											
										
										
											2019-09-13 23:12:19 +02:00
+									private lazy var managedFile = ManagedResourceFile(fileURL: fileURL, load: loadCallback, save: saveCallback)
-												Move OPML I/O functions into a separate OPMLFile class

											
										
										
											2019-09-13 01:05:29 +02:00
 									init(filename: String, account: Account) {
-												Add file coordination for the OPML file

											
										
										
											2019-09-13 17:48:04 +02:00
+										self.fileURL = URL(fileURLWithPath: filename)
-												Move OPML I/O functions into a separate OPMLFile class

											
										
										
											2019-09-13 01:05:29 +02:00
+										self.account = account
 									}
-												Move more OPML file management functions to the OPMLFile class

											
										
										
											2019-09-13 17:15:11 +02:00
+									func markAsDirty() {
-												Modify OPMLFile to use the new ManagedResourceFile utility class

											
										
										
											2019-09-13 22:46:22 +02:00
+										managedFile.markAsDirty()
-												Move more OPML file management functions to the OPMLFile class

											
										
										
											2019-09-13 17:15:11 +02:00
+									}
-												Move OPML I/O functions into a separate OPMLFile class

											
										
										
											2019-09-13 01:05:29 +02:00
+									func load() {
-												Modify OPMLFile to use the new ManagedResourceFile utility class

											
										
										
											2019-09-13 22:46:22 +02:00
+										managedFile.load()
-												Add the ability to observe OPML file changes

											
										
										
											2019-09-13 01:41:42 +02:00
+									}
-												Make sure metadata gets saved if background fetch is performed.

											
										
										
											2019-10-02 22:32:34 +02:00
+									func save() {
-												Save resource files immediately in the share extension

											
										
										
											2019-09-23 18:09:40 +02:00
+										managedFile.saveIfNecessary()
 									}
-												Add suspend and resume to managed files

											
										
										
											2019-12-02 00:16:52 +01:00
+									func suspend() {
 										managedFile.suspend()
 									}
 									func resume() {
 										managedFile.resume()
 									}
-												Move more OPML file management functions to the OPMLFile class

											
										
										
											2019-09-13 17:15:11 +02:00
+								}
 								private extension OPMLFile {
-												Modify OPMLFile to use the new ManagedResourceFile utility class

											
										
										
											2019-09-13 22:46:22 +02:00
 									func loadCallback() {
-												Don't process OPML file if it hasn't changed since it was last produced.  Issue #1428

											
										
										
											2019-12-10 22:10:07 +01:00
+										guard let fileData = opmlFileData() else {
 											return
 										}
 										// Don't rebuild the account if the OPML hasn't changed since the last save
 										guard let opml = String(data: fileData, encoding: .utf8), opml != opmlDocument() else {
 											return
 										}
 										guard let opmlItems = parsedOPMLItems(fileData: fileData) else { return }
-												Modify OPMLFile to use the new ManagedResourceFile utility class

											
										
										
											2019-09-13 22:46:22 +02:00
+										BatchUpdate.shared.perform {
-												Renamed Feed and related classes/instances to WebFeed

											
										
										
											2019-11-15 03:11:41 +01:00
+											account.topLevelWebFeeds.removeAll()
-												Modify OPMLFile to use the new ManagedResourceFile utility class

											
										
										
											2019-09-13 22:46:22 +02:00
+											account.loadOPMLItems(opmlItems, parentFolder: nil)
-												Move more OPML file management functions to the OPMLFile class

											
										
										
											2019-09-13 17:15:11 +02:00
+										}
 									}
-												Modify OPMLFile to use the new ManagedResourceFile utility class

											
										
										
											2019-09-13 22:46:22 +02:00
 									func saveCallback() {
 										guard !account.isDeleted else { return }
-												Add the ability to observe OPML file changes

											
										
										
											2019-09-13 01:41:42 +02:00
+										let opmlDocumentString = opmlDocument()
-												Add file coordination for the OPML file

											
										
										
											2019-09-13 17:48:04 +02:00
 										let errorPointer: NSErrorPointer = nil
-												Modify OPMLFile to use the new ManagedResourceFile utility class

											
										
										
											2019-09-13 22:46:22 +02:00
+										let fileCoordinator = NSFileCoordinator(filePresenter: managedFile)
-												Add file coordination for the OPML file

											
										
										
											2019-09-13 17:48:04 +02:00
-												Change writing options for resource files to none

											
										
										
											2019-09-13 23:58:10 +02:00
+										fileCoordinator.coordinate(writingItemAt: fileURL, options: [], error: errorPointer, byAccessor: { writeURL in
-												Add file coordination for the OPML file

											
										
										
											2019-09-13 17:48:04 +02:00
+											do {
 												try opmlDocumentString.write(to: writeURL, atomically: true, encoding: .utf8)
 											} catch let error as NSError {
 												os_log(.error, log: log, "OPML save to disk failed: %@.", error.localizedDescription)
 											}
 										})
 										if let error = errorPointer?.pointee {
 											os_log(.error, log: log, "OPML save to disk coordination failed: %@.", error.localizedDescription)
-												Add the ability to observe OPML file changes

											
										
										
											2019-09-13 01:41:42 +02:00
+										}
 									}
-												Don't process OPML file if it hasn't changed since it was last produced.  Issue #1428

											
										
										
											2019-12-10 22:10:07 +01:00
+									func opmlFileData() -> Data? {
-												Add file coordination for the OPML file

											
										
										
											2019-09-13 17:48:04 +02:00
+										var fileData: Data? = nil
 										let errorPointer: NSErrorPointer = nil
-												Modify OPMLFile to use the new ManagedResourceFile utility class

											
										
										
											2019-09-13 22:46:22 +02:00
+										let fileCoordinator = NSFileCoordinator(filePresenter: managedFile)
-												Add the ability to observe OPML file changes

											
										
										
											2019-09-13 01:41:42 +02:00
-												Add file coordination for the OPML file

											
										
										
											2019-09-13 17:48:04 +02:00
+										fileCoordinator.coordinate(readingItemAt: fileURL, options: [], error: errorPointer, byAccessor: { readURL in
 											do {
 												fileData = try Data(contentsOf: readURL)
 											} catch {
 												// Commented out because it’s not an error on first run.
 												// TODO: make it so we know if it’s first run or not.
 												//NSApplication.shared.presentError(error)
 												os_log(.error, log: log, "OPML read from disk failed: %@.", error.localizedDescription)
 											}
 										})
 										if let error = errorPointer?.pointee {
 											os_log(.error, log: log, "OPML read from disk coordination failed: %@.", error.localizedDescription)
-												Move OPML I/O functions into a separate OPMLFile class

											
										
										
											2019-09-13 01:05:29 +02:00
+										}
-												Add file coordination for the OPML file

											
										
										
											2019-09-13 17:48:04 +02:00
-												Don't process OPML file if it hasn't changed since it was last produced.  Issue #1428

											
										
										
											2019-12-10 22:10:07 +01:00
+										return fileData
 									}
 									func parsedOPMLItems(fileData: Data) -> [RSOPMLItem]? {
 										let parserData = ParserData(url: fileURL.absoluteString, data: fileData)
-												Move OPML I/O functions into a separate OPMLFile class

											
										
										
											2019-09-13 01:05:29 +02:00
+										var opmlDocument: RSOPMLDocument?
 										do {
 											opmlDocument = try RSOPMLParser.parseOPML(with: parserData)
 										} catch {
 											os_log(.error, log: log, "OPML Import failed: %@.", error.localizedDescription)
-												Add the ability to observe OPML file changes

											
										
										
											2019-09-13 01:41:42 +02:00
+											return nil
-												Move OPML I/O functions into a separate OPMLFile class

											
										
										
											2019-09-13 01:05:29 +02:00
+										}
-												Add the ability to observe OPML file changes

											
										
										
											2019-09-13 01:41:42 +02:00
 										return opmlDocument?.children
-												Move OPML I/O functions into a separate OPMLFile class

											
										
										
											2019-09-13 01:05:29 +02:00
+									}
 									func opmlDocument() -> String {
-												Update for pending RSCore String updates

											
										
										
											2020-01-17 03:09:18 +01:00
+										let escapedTitle = account.nameForDisplay.escapingSpecialXMLCharacters
-												Move OPML I/O functions into a separate OPMLFile class

											
										
										
											2019-09-13 01:05:29 +02:00
+										let openingText =
 										"""
 										<?xml version="1.0" encoding="UTF-8"?>
 										<!-- OPML generated by NetNewsWire -->
 										<opml version="1.1">
 										<head>
 										<title>\(escapedTitle)</title>
 										</head>
 										<body>
 										"""
-												Update to latest RSCore

Update use of OMPLString().

											
										
										
											2020-01-14 05:20:20 +01:00
+										let middleText = account.OPMLString(indentLevel: 0, allowCustomAttributes: true)
-												Move OPML I/O functions into a separate OPMLFile class

											
										
										
											2019-09-13 01:05:29 +02:00
 										let closingText =
 										"""
 												</body>
 											</opml>
 											"""
 										let opml = openingText + middleText + closingText
 										return opml
 									}
 								}