-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1619 from NYPL-Simplified/task/ios-420
iOS-420 Implement last listen position sync
- Loading branch information
Showing
14 changed files
with
363 additions
and
176 deletions.
There are no files selected for viewing
Submodule NYPLAEToolkit
updated
from b8f91d to f82952
Submodule NYPLAudiobookToolkit
updated
6 files
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
125 changes: 125 additions & 0 deletions
125
Simplified/Audiobooks/NYPLLastListenPositionSynchronizer.swift
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| // | ||
| // NYPLLastListenPositionSynchronizer.swift | ||
| // Simplified | ||
| // | ||
| // Created by Ernest Fan on 2022-11-10. | ||
| // Copyright © 2022 NYPL. All rights reserved. | ||
| // | ||
| #if FEATURE_AUDIOBOOKS | ||
| import Foundation | ||
| import NYPLAudiobookToolkit | ||
|
|
||
| class NYPLLastListenPositionSynchronizer: NYPLLastListenPositionSynchronizing { | ||
| private let book: NYPLBook | ||
| private let bookRegistryProvider: NYPLBookRegistryProvider | ||
| private let annotationsSynchronizer: NYPLLastReadPositionSupportAPI | ||
| private let deviceID: String? | ||
|
|
||
| private let renderer: String = "NYPLAudiobookToolkit" | ||
|
|
||
| init(book: NYPLBook, | ||
| bookRegistryProvider: NYPLBookRegistryProvider, | ||
| annotationsSynchronizer: NYPLLastReadPositionSupportAPI, | ||
| deviceID: String?) { | ||
| self.book = book | ||
| self.bookRegistryProvider = bookRegistryProvider | ||
| self.annotationsSynchronizer = annotationsSynchronizer | ||
| self.deviceID = deviceID | ||
| } | ||
|
|
||
| func getLastListenPosition(completion: @escaping (_ localPosition: NYPLAudiobookBookmark?, _ serverPosition: NYPLAudiobookBookmark?) -> ()) { | ||
|
|
||
| // Retrieve local last-listened position | ||
| let localPosition = self.getLocalLastListenPosition(for: book.identifier) | ||
|
|
||
| // Retrieve last-listened position from server, return both local and server positions | ||
| self.annotationsSynchronizer.syncReadingPosition(of: NYPLAudiobookBookmark.self, | ||
| forBook: book.identifier, | ||
| publication: nil, | ||
| toURL: book.annotationsURL) { serverPosition in | ||
| guard let serverPosition = serverPosition else { | ||
| Log.info(#function, "No reading position annotation exists on the server for \(self.book.loggableShortString()).") | ||
| completion(localPosition, nil) | ||
| return | ||
| } | ||
|
|
||
| guard let localPosition = localPosition else { | ||
| completion(nil, serverPosition) | ||
| return | ||
| } | ||
|
|
||
| // Pass through without server position (meaning the server doesn't have a | ||
| // last listen position worth restoring) if: | ||
| // 1 - The most recent position on the server comes from the same device, or | ||
| // 2 - The local position is further in the audiobook than the server position | ||
| if serverPosition.device == self.deviceID || | ||
| localPosition >= serverPosition { | ||
| completion(localPosition, nil) | ||
| return | ||
| } | ||
|
|
||
| completion(localPosition, serverPosition) | ||
| } | ||
| } | ||
|
|
||
| func updateLastListenPositionInMemory(_ location: ChapterLocation) { | ||
| let selectorValue = NYPLAudiobookBookmarkFactory.makeLocatorString(title: location.title ?? "", | ||
| part: location.part, | ||
| chapter: location.number, | ||
| audiobookId: location.audiobookID, | ||
| duration: location.duration, | ||
| time: location.playheadOffset) | ||
|
|
||
| let bookLocation = NYPLBookLocation.init(locationString: selectorValue, renderer: self.renderer) | ||
|
|
||
| bookRegistryProvider.setLocation(bookLocation, forIdentifier: self.book.identifier) | ||
| } | ||
|
|
||
|
|
||
| func syncLastListenPositionToServer() { | ||
| let bookID = self.book.identifier | ||
|
|
||
| guard let localPosition = getLocalLastListenPosition(for: bookID) else { | ||
| return | ||
| } | ||
|
|
||
| let selectorValue = NYPLAudiobookBookmarkFactory.makeLocatorString(title: localPosition.title ?? "", | ||
| part: localPosition.part, | ||
| chapter: localPosition.chapter, | ||
| audiobookId: localPosition.audiobookId, | ||
| duration: localPosition.duration, | ||
| time: localPosition.time) | ||
|
|
||
| annotationsSynchronizer.postReadingPosition(forBook: bookID, | ||
| selectorValue: selectorValue) | ||
| } | ||
|
|
||
| // MARK: - Helper | ||
|
|
||
| private func getLocalLastListenPosition(for bookID: String) -> NYPLAudiobookBookmark? { | ||
| guard let bookLocation = self.bookRegistryProvider.location(forIdentifier: bookID), | ||
| bookLocation.renderer == self.renderer else { | ||
| return nil | ||
| } | ||
|
|
||
| if let bookmark = NYPLAudiobookBookmark(selectorString: bookLocation.locationString, creationTime: Date()) { | ||
| return bookmark | ||
| } | ||
|
|
||
| if let chapterLocation = self.chapterLocation(from: bookLocation.locationString) { | ||
| // If the retrieved location is a ChapterLocation object, | ||
| // we should create a bookmark object from it. | ||
| return NYPLAudiobookBookmark(chapterLocation: chapterLocation, creationTime: Date()) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| private func chapterLocation(from locationString: String) -> ChapterLocation? { | ||
| guard let data = locationString.data(using: .utf8), | ||
| let chapterLocation = ChapterLocation.fromData(data) else { | ||
| return nil | ||
| } | ||
| return chapterLocation | ||
| } | ||
| } | ||
| #endif |
Oops, something went wrong.