GBA001/Delta/Game Selection/GameCollectionViewController.swift
Riley Testut 90c04ee62e Prevents launching games while downloading their game saves
This minimizes potential for data loss.
2019-02-05 14:14:39 -08:00

735 lines
28 KiB
Swift

//
// GameCollectionViewController.swift
// Delta
//
// Created by Riley Testut on 8/12/16.
// Copyright © 2016 Riley Testut. All rights reserved.
//
import UIKit
import MobileCoreServices
import DeltaCore
import Roxas
import Harmony
import SDWebImage
extension GameCollectionViewController
{
private enum LaunchError: Error
{
case alreadyRunning
case downloadingGameSave
}
}
class GameCollectionViewController: UICollectionViewController
{
var gameCollection: GameCollection? {
didSet {
self.title = self.gameCollection?.shortName
self.updateDataSource()
}
}
var theme: Theme = .opaque {
didSet {
// self.collectionView?.reloadData()
// Calling reloadData sometimes will not update the cells correctly if an insertion/deletion animation is in progress
// As a workaround, we manually iterate over and configure each cell ourselves
for cell in self.collectionView?.visibleCells ?? []
{
if let indexPath = self.collectionView?.indexPath(for: cell)
{
self.configure(cell as! GridCollectionViewCell, for: indexPath)
}
}
}
}
internal let dataSource: RSTFetchedResultsCollectionViewPrefetchingDataSource<Game, UIImage>
weak var activeEmulatorCore: EmulatorCore?
private var activeSaveState: SaveStateProtocol?
private let prototypeCell = GridCollectionViewCell()
private var _performing3DTouchTransition = false
private weak var _destination3DTouchTransitionViewController: UIViewController?
private var _renameAction: UIAlertAction?
private var _changingArtworkGame: Game?
required init?(coder aDecoder: NSCoder)
{
self.dataSource = RSTFetchedResultsCollectionViewPrefetchingDataSource<Game, UIImage>(fetchedResultsController: NSFetchedResultsController())
super.init(coder: aDecoder)
self.prepareDataSource()
}
}
//MARK: - UIViewController -
/// UIViewController
extension GameCollectionViewController
{
override func viewDidLoad()
{
super.viewDidLoad()
self.collectionView?.dataSource = self.dataSource
self.collectionView?.prefetchDataSource = self.dataSource
self.collectionView?.delegate = self
let layout = self.collectionViewLayout as! GridCollectionViewLayout
layout.itemWidth = 90
layout.minimumInteritemSpacing = 12
self.registerForPreviewing(with: self, sourceView: self.collectionView!)
let longPressGestureRecognizer = UILongPressGestureRecognizer(target: self, action: #selector(GameCollectionViewController.handleLongPressGesture(_:)))
self.collectionView?.addGestureRecognizer(longPressGestureRecognizer)
}
override func viewWillDisappear(_ animated: Bool)
{
super.viewWillDisappear(animated)
if _performing3DTouchTransition
{
_performing3DTouchTransition = false
// Unlike our custom transitions, 3D Touch transition doesn't manually call appearance methods for us
// To compensate, we call them ourselves
_destination3DTouchTransitionViewController?.beginAppearanceTransition(true, animated: true)
self.transitionCoordinator?.animate(alongsideTransition: nil, completion: { (context) in
self._destination3DTouchTransitionViewController?.endAppearanceTransition()
self._destination3DTouchTransitionViewController = nil
})
}
}
override func didReceiveMemoryWarning()
{
super.didReceiveMemoryWarning()
// Dispose of any resources that can be recreated.
}
}
//MARK: - Segues -
/// Segues
extension GameCollectionViewController
{
override func prepare(for segue: UIStoryboardSegue, sender: Any?)
{
guard let identifier = segue.identifier else { return }
switch identifier
{
case "saveStates":
let game = sender as! Game
let saveStatesViewController = (segue.destination as! UINavigationController).topViewController as! SaveStatesViewController
saveStatesViewController.delegate = self
saveStatesViewController.game = game
saveStatesViewController.mode = .loading
saveStatesViewController.theme = self.theme
case "unwindFromGames":
let destinationViewController = segue.destination as! GameViewController
let cell = sender as! UICollectionViewCell
let indexPath = self.collectionView!.indexPath(for: cell)!
let game = self.dataSource.item(at: indexPath)
destinationViewController.game = game
if let saveState = self.activeSaveState
{
// Must be synchronous or else there will be a flash of black
destinationViewController.emulatorCore?.start()
destinationViewController.emulatorCore?.pause()
do
{
try destinationViewController.emulatorCore?.load(saveState)
}
catch EmulatorCore.SaveStateError.doesNotExist
{
print("Save State does not exist.")
}
catch
{
print(error)
}
destinationViewController.emulatorCore?.resume()
}
self.activeSaveState = nil
if _performing3DTouchTransition
{
_destination3DTouchTransitionViewController = destinationViewController
}
default: break
}
}
@IBAction private func unwindFromSaveStatesViewController(with segue: UIStoryboardSegue)
{
}
@IBAction private func unwindFromGamesDatabaseBrowser(with segue: UIStoryboardSegue)
{
}
}
//MARK: - Private Methods -
private extension GameCollectionViewController
{
//MARK: - Data Source
func prepareDataSource()
{
self.dataSource.cellConfigurationHandler = { [weak self] (cell, item, indexPath) in
self?.configure(cell as! GridCollectionViewCell, for: indexPath)
}
self.dataSource.prefetchHandler = { (game, indexPath, completionHandler) in
guard let artworkURL = game.artworkURL else { return nil }
let imageOperation = LoadImageURLOperation(url: artworkURL)
imageOperation.resultHandler = { (image, error) in
completionHandler(image, error)
}
return imageOperation
}
self.dataSource.prefetchCompletionHandler = { (cell, image, indexPath, error) in
guard let image = image else { return }
let cell = cell as! GridCollectionViewCell
cell.imageView.image = image
cell.isImageViewVibrancyEnabled = false
}
}
func updateDataSource()
{
let fetchRequest: NSFetchRequest<Game> = Game.fetchRequest()
if let gameCollection = self.gameCollection
{
fetchRequest.predicate = NSPredicate(format: "%K == %@", #keyPath(Game.gameCollection), gameCollection)
}
fetchRequest.sortDescriptors = [NSSortDescriptor(key: #keyPath(Game.name), ascending: true)]
fetchRequest.returnsObjectsAsFaults = false
self.dataSource.fetchedResultsController = NSFetchedResultsController(fetchRequest: fetchRequest, managedObjectContext: DatabaseManager.shared.viewContext, sectionNameKeyPath: nil, cacheName: nil)
}
//MARK: - Configure Cells
func configure(_ cell: GridCollectionViewCell, for indexPath: IndexPath)
{
let game = self.dataSource.item(at: indexPath)
switch self.theme
{
case .opaque:
cell.isTextLabelVibrancyEnabled = false
cell.isImageViewVibrancyEnabled = false
case .translucent:
cell.isTextLabelVibrancyEnabled = true
cell.isImageViewVibrancyEnabled = true
}
cell.imageView.image = #imageLiteral(resourceName: "BoxArt")
cell.maximumImageSize = CGSize(width: 90, height: 90)
cell.textLabel.text = game.name
cell.textLabel.textColor = UIColor.gray
}
//MARK: - Emulation
func launchGame(at indexPath: IndexPath, clearScreen: Bool, ignoreAlreadyRunningError: Bool = false)
{
func launchGame(ignoringErrors ignoredErrors: [Error])
{
let game = self.dataSource.item(at: indexPath)
do
{
try self.validateLaunchingGame(game, ignoringErrors: ignoredErrors)
if clearScreen
{
self.activeEmulatorCore?.gameViews.forEach { $0.inputImage = nil }
}
let cell = self.collectionView.cellForItem(at: indexPath)
self.performSegue(withIdentifier: "unwindFromGames", sender: cell)
}
catch LaunchError.alreadyRunning
{
let alertController = UIAlertController(title: NSLocalizedString("Game Paused", comment: ""), message: NSLocalizedString("Would you like to resume where you left off, or restart the game?", comment: ""), preferredStyle: .alert)
alertController.addAction(UIAlertAction(title: NSLocalizedString("Cancel", comment: ""), style: .cancel, handler: nil))
alertController.addAction(UIAlertAction(title: NSLocalizedString("Resume", comment: ""), style: .default, handler: { (action) in
let fetchRequest = SaveState.rst_fetchRequest() as! NSFetchRequest<SaveState>
fetchRequest.predicate = NSPredicate(format: "%K == %@ AND %K == %d", #keyPath(SaveState.game), game, #keyPath(SaveState.type), SaveStateType.auto.rawValue)
fetchRequest.sortDescriptors = [NSSortDescriptor(key: #keyPath(SaveState.creationDate), ascending: true)]
do
{
let saveStates = try game.managedObjectContext?.fetch(fetchRequest)
self.activeSaveState = saveStates?.last
}
catch
{
print(error)
}
// Disable videoManager to prevent flash of black
self.activeEmulatorCore?.videoManager.isEnabled = false
launchGame(ignoringErrors: [LaunchError.alreadyRunning])
// The game hasn't changed, so the activeEmulatorCore is the same as before, so we need to enable videoManager it again
self.activeEmulatorCore?.videoManager.isEnabled = true
}))
alertController.addAction(UIAlertAction(title: NSLocalizedString("Restart", comment: ""), style: .destructive, handler: { (action) in
launchGame(ignoringErrors: [LaunchError.alreadyRunning])
}))
self.present(alertController, animated: true)
}
catch LaunchError.downloadingGameSave
{
let alertController = UIAlertController(title: NSLocalizedString("Downloading Save File", comment: ""), message: NSLocalizedString("Please wait until after this game's save file has been downloaded before playing to prevent losing save data.", comment: ""), preferredStyle: .alert)
alertController.addAction(.ok)
self.present(alertController, animated: true, completion: nil)
}
catch
{
let alertController = UIAlertController(title: NSLocalizedString("Unable to Launch Game", comment: ""), error: error)
self.present(alertController, animated: true, completion: nil)
}
}
if ignoreAlreadyRunningError
{
launchGame(ignoringErrors: [LaunchError.alreadyRunning])
}
else
{
launchGame(ignoringErrors: [])
}
}
func validateLaunchingGame(_ game: Game, ignoringErrors ignoredErrors: [Error]) throws
{
let ignoredErrors = ignoredErrors.map { $0 as NSError }
if !ignoredErrors.contains(where: { $0.domain == (LaunchError.alreadyRunning as NSError).domain && $0.code == (LaunchError.alreadyRunning as NSError).code })
{
guard game.fileURL != self.activeEmulatorCore?.game.fileURL else { throw LaunchError.alreadyRunning }
}
if SyncManager.shared.syncCoordinator.isSyncing
{
if let gameSave = game.gameSave
{
do
{
if let record = try SyncManager.shared.recordController.fetchRecords(for: [gameSave]).first
{
if record.isSyncingEnabled && !record.isConflicted && (record.localStatus == nil || record.remoteStatus == .updated)
{
throw LaunchError.downloadingGameSave
}
}
}
catch let error as LaunchError
{
throw error
}
catch
{
print("Error fetching record for game save.", error)
}
}
}
}
}
//MARK: - Game Actions -
private extension GameCollectionViewController
{
func actions(for game: Game) -> [Action]
{
let cancelAction = Action(title: NSLocalizedString("Cancel", comment: ""), style: .cancel, action: nil)
let renameAction = Action(title: NSLocalizedString("Rename", comment: ""), style: .default, action: { [unowned self] action in
self.rename(game)
})
let changeArtworkAction = Action(title: NSLocalizedString("Change Artwork", comment: ""), style: .default) { [unowned self] action in
self.changeArtwork(for: game)
}
let shareAction = Action(title: NSLocalizedString("Share", comment: ""), style: .default, action: { [unowned self] action in
self.share(game)
})
let saveStatesAction = Action(title: NSLocalizedString("Save States", comment: ""), style: .default, action: { [unowned self] action in
self.viewSaveStates(for: game)
})
let deleteAction = Action(title: NSLocalizedString("Delete", comment: ""), style: .destructive, action: { [unowned self] action in
self.delete(game)
})
switch game.type
{
case GameType.unknown: return [cancelAction, renameAction, changeArtworkAction, shareAction, deleteAction]
default: return [cancelAction, renameAction, changeArtworkAction, shareAction, saveStatesAction, deleteAction]
}
}
func delete(_ game: Game)
{
let confirmationAlertController = UIAlertController(title: NSLocalizedString("Are you sure you want to delete this game? All associated data, such as saves, save states, and cheat codes, will also be deleted.", comment: ""), message: nil, preferredStyle: .actionSheet)
confirmationAlertController.addAction(UIAlertAction(title: NSLocalizedString("Delete Game", comment: ""), style: .destructive, handler: { action in
DatabaseManager.shared.performBackgroundTask { (context) in
let temporaryGame = context.object(with: game.objectID) as! Game
context.delete(temporaryGame)
context.saveWithErrorLogging()
}
}))
confirmationAlertController.addAction(UIAlertAction(title: NSLocalizedString("Cancel", comment: ""), style: .cancel, handler: nil))
self.present(confirmationAlertController, animated: true, completion: nil)
}
func viewSaveStates(for game: Game)
{
self.performSegue(withIdentifier: "saveStates", sender: game)
}
func rename(_ game: Game)
{
let alertController = UIAlertController(title: NSLocalizedString("Rename Game", comment: ""), message: nil, preferredStyle: .alert)
alertController.addTextField { (textField) in
textField.text = game.name
textField.placeholder = NSLocalizedString("Name", comment: "")
textField.autocapitalizationType = .words
textField.returnKeyType = .done
textField.enablesReturnKeyAutomatically = true
textField.addTarget(self, action: #selector(GameCollectionViewController.textFieldTextDidChange(_:)), for: .editingChanged)
}
alertController.addAction(UIAlertAction(title: NSLocalizedString("Cancel", comment: ""), style: .cancel, handler: { (action) in
self._renameAction = nil
}))
let renameAction = UIAlertAction(title: NSLocalizedString("Rename", comment: ""), style: .default, handler: { [unowned alertController] (action) in
self.rename(game, with: alertController.textFields?.first?.text ?? "")
})
alertController.addAction(renameAction)
self._renameAction = renameAction
self.present(alertController, animated: true, completion: nil)
}
func rename(_ game: Game, with name: String)
{
guard name.count > 0 else { return }
DatabaseManager.shared.performBackgroundTask { (context) in
let game = context.object(with: game.objectID) as! Game
game.name = name
context.saveWithErrorLogging()
}
self._renameAction = nil
}
func changeArtwork(for game: Game)
{
self._changingArtworkGame = game
let clipboardImportOption = ClipboardImportOption()
let photoLibraryImportOption = PhotoLibraryImportOption(presentingViewController: self)
let gamesDatabaseImportOption = GamesDatabaseImportOption(presentingViewController: self)
let importController = ImportController(documentTypes: [kUTTypeImage as String])
importController.delegate = self
importController.importOptions = [clipboardImportOption, photoLibraryImportOption, gamesDatabaseImportOption]
self.present(importController, animated: true, completion: nil)
}
func share(_ game: Game)
{
let temporaryDirectory = FileManager.default.temporaryDirectory.appendingPathComponent(UUID().uuidString)
let symbolicURL = temporaryDirectory.appendingPathComponent(game.name + "." + game.fileURL.pathExtension)
do
{
try FileManager.default.createDirectory(at: temporaryDirectory, withIntermediateDirectories: true, attributes: nil)
// Create a symbolic link so we can control the file name used when sharing.
// Otherwise, if we just passed in game.fileURL to UIActivityViewController, the file name would be the game's SHA1 hash.
try FileManager.default.createSymbolicLink(at: symbolicURL, withDestinationURL: game.fileURL)
}
catch
{
print(error)
}
let activityViewController = UIActivityViewController(activityItems: [symbolicURL], applicationActivities: nil)
activityViewController.completionWithItemsHandler = { (activityType, finished, returnedItems, error) in
do
{
try FileManager.default.removeItem(at: temporaryDirectory)
}
catch
{
print(error)
}
}
self.present(activityViewController, animated: true, completion: nil)
}
@objc func textFieldTextDidChange(_ textField: UITextField)
{
let text = textField.text ?? ""
self._renameAction?.isEnabled = text.count > 0
}
@objc func handleLongPressGesture(_ gestureRecognizer: UILongPressGestureRecognizer)
{
guard gestureRecognizer.state == .began else { return }
guard let indexPath = self.collectionView?.indexPathForItem(at: gestureRecognizer.location(in: self.collectionView)) else { return }
let game = self.dataSource.item(at: indexPath)
let actions = self.actions(for: game)
let alertController = UIAlertController(actions: actions)
self.present(alertController, animated: true, completion: nil)
}
}
//MARK: - UIViewControllerPreviewingDelegate -
/// UIViewControllerPreviewingDelegate
extension GameCollectionViewController: UIViewControllerPreviewingDelegate
{
func previewingContext(_ previewingContext: UIViewControllerPreviewing, viewControllerForLocation location: CGPoint) -> UIViewController?
{
guard self.gameCollection?.identifier != GameType.unknown.rawValue else { return nil }
guard
let collectionView = self.collectionView,
let indexPath = collectionView.indexPathForItem(at: location),
let layoutAttributes = collectionView.layoutAttributesForItem(at: indexPath)
else { return nil }
previewingContext.sourceRect = layoutAttributes.frame
let game = self.dataSource.item(at: indexPath)
let gameViewController = PreviewGameViewController()
gameViewController.game = game
if let previewSaveState = game.previewSaveState
{
gameViewController.previewSaveState = previewSaveState
gameViewController.previewImage = UIImage(contentsOfFile: previewSaveState.imageFileURL.path)
}
let actions = self.actions(for: game).previewActions
gameViewController.overridePreviewActionItems = actions
return gameViewController
}
func previewingContext(_ previewingContext: UIViewControllerPreviewing, commit viewControllerToCommit: UIViewController)
{
let gameViewController = viewControllerToCommit as! PreviewGameViewController
let game = gameViewController.game as! Game
let indexPath = self.dataSource.fetchedResultsController.indexPath(forObject: game)!
let fileURL = FileManager.default.uniqueTemporaryURL()
self.activeSaveState = gameViewController.emulatorCore?.saveSaveState(to: fileURL)
gameViewController.emulatorCore?.stop()
_performing3DTouchTransition = true
self.launchGame(at: indexPath, clearScreen: true, ignoreAlreadyRunningError: true)
do
{
try FileManager.default.removeItem(at: fileURL)
}
catch
{
print(error)
}
}
}
//MARK: - SaveStatesViewControllerDelegate -
/// SaveStatesViewControllerDelegate
extension GameCollectionViewController: SaveStatesViewControllerDelegate
{
func saveStatesViewController(_ saveStatesViewController: SaveStatesViewController, updateSaveState saveState: SaveState)
{
}
func saveStatesViewController(_ saveStatesViewController: SaveStatesViewController, loadSaveState saveState: SaveStateProtocol)
{
self.activeSaveState = saveState
self.dismiss(animated: true) {
let indexPath = self.dataSource.fetchedResultsController.indexPath(forObject: saveStatesViewController.game)!
self.launchGame(at: indexPath, clearScreen: false, ignoreAlreadyRunningError: true)
}
}
}
//MARK: - ImportControllerDelegate -
/// ImportControllerDelegate
extension GameCollectionViewController: ImportControllerDelegate
{
func importController(_ importController: ImportController, didImportItemsAt urls: Set<URL>, errors: [Error])
{
guard let game = self._changingArtworkGame else { return }
var errors = errors
var imageURL: URL?
if let url = urls.first
{
if url.isFileURL
{
do
{
let imageData = try Data(contentsOf: url)
if
let image = UIImage(data: imageData),
let resizedImage = image.resizing(toFit: CGSize(width: 300, height: 300)),
let resizedData = resizedImage.jpegData(compressionQuality: 0.85)
{
let destinationURL = DatabaseManager.artworkURL(for: game)
try resizedData.write(to: destinationURL, options: .atomic)
imageURL = destinationURL
}
}
catch
{
errors.append(error)
}
}
else
{
imageURL = url
}
}
for error in errors
{
print(error)
}
if let imageURL = imageURL
{
DatabaseManager.shared.performBackgroundTask { (context) in
let temporaryGame = context.object(with: game.objectID) as! Game
temporaryGame.artworkURL = imageURL
context.saveWithErrorLogging()
// Local image URLs may not change despite being a different image, so manually mark record as updated.
SyncManager.shared.recordController.updateRecord(for: temporaryGame)
DispatchQueue.main.async {
self.presentedViewController?.dismiss(animated: true, completion: nil)
}
}
}
else
{
func presentAlertController()
{
let alertController = UIAlertController(title: NSLocalizedString("Unable to Change Artwork", comment: ""), message: NSLocalizedString("The image might be corrupted or in an unsupported format.", comment: ""), preferredStyle: .alert)
alertController.addAction(UIAlertAction(title: RSTSystemLocalizedString("OK"), style: .cancel, handler: nil))
self.present(alertController, animated: true, completion: nil)
}
if let presentedViewController = self.presentedViewController
{
presentedViewController.dismiss(animated: true) {
presentAlertController()
}
}
else
{
presentAlertController()
}
}
}
func importControllerDidCancel(_ importController: ImportController)
{
self.presentedViewController?.dismiss(animated: true, completion: nil)
}
}
//MARK: - UICollectionViewDelegate -
/// UICollectionViewDelegate
extension GameCollectionViewController
{
override func collectionView(_ collectionView: UICollectionView, didSelectItemAt indexPath: IndexPath)
{
guard self.gameCollection?.identifier != GameType.unknown.rawValue else { return }
self.launchGame(at: indexPath, clearScreen: true)
}
}
//MARK: - UICollectionViewDelegateFlowLayout -
/// UICollectionViewDelegateFlowLayout
extension GameCollectionViewController: UICollectionViewDelegateFlowLayout
{
func collectionView(_ collectionView: UICollectionView, layout collectionViewLayout: UICollectionViewLayout, sizeForItemAt indexPath: IndexPath) -> CGSize
{
let collectionViewLayout = collectionView.collectionViewLayout as! GridCollectionViewLayout
let widthConstraint = self.prototypeCell.contentView.widthAnchor.constraint(equalToConstant: collectionViewLayout.itemWidth)
widthConstraint.isActive = true
defer { widthConstraint.isActive = false }
self.configure(self.prototypeCell, for: indexPath)
let size = self.prototypeCell.contentView.systemLayoutSizeFitting(UIView.layoutFittingCompressedSize)
return size
}
}