Merge pull request #1560 from TortugaPower/feat/reload-chapters

Add reload chapters support to chapter list

Author: GianniCarlo

BookPlayer.xcodeproj/project.pbxproj

@@ -102,6 +102,12 @@
 "player_book_remaining_title" = "%@ left";
 "chapters_title" = "Chapters";
 "chapters_item_description" = "Start: %@ - Duration: %@";
+"reload_button" = "Reload";
+"reload_chapters_title" = "Reload Chapters";
+"reparse_chapters_found_title" = "Chapters Reloaded";
+"reparse_chapters_found_description" = "Found %d chapters.";
+"reparse_chapters_none_description" = "No additional chapters were found in this file.";
+"reparse_chapters_download_description" = "Download this book before reloading its chapters.";
 "restore_title" = "Restore";
 "themes_caps_title" = "THEMES";
 "plus_app_icons_title" = "App Icons";

BookPlayer/Base.lproj/Localizable.strings

@@ -513,6 +513,26 @@ class LibraryServiceProtocolMock: LibraryServiceProtocol {
         loadChaptersIfNeededRelativePathAssetReceivedInvocations.append((relativePath: relativePath, asset: asset))
         await loadChaptersIfNeededRelativePathAssetClosure?(relativePath, asset)
     }
+    //MARK: - reloadChapters
+
+    var reloadChaptersRelativePathCallsCount = 0
+    var reloadChaptersRelativePathCalled: Bool {
+        return reloadChaptersRelativePathCallsCount > 0
+    }
+    var reloadChaptersRelativePathReceivedRelativePath: String?
+    var reloadChaptersRelativePathReceivedInvocations: [String] = []
+    var reloadChaptersRelativePathReturnValue: Int?
+    var reloadChaptersRelativePathClosure: ((String) async -> Int?)?
+    func reloadChapters(relativePath: String) async -> Int? {
+        reloadChaptersRelativePathCallsCount += 1
+        reloadChaptersRelativePathReceivedRelativePath = relativePath
+        reloadChaptersRelativePathReceivedInvocations.append(relativePath)
+        if let reloadChaptersRelativePathClosure = reloadChaptersRelativePathClosure {
+            return await reloadChaptersRelativePathClosure(relativePath)
+        } else {
+            return reloadChaptersRelativePathReturnValue
+        }
+    }
     //MARK: - createFolder
 
     var createFolderWithInsideThrowableError: Error?
@@ -1398,6 +1418,18 @@ class PlayerManagerProtocolMock: PlayerManagerProtocol {
         jumpToChapterReceivedInvocations.append(chapter)
         jumpToChapterClosure?(chapter)
     }
+    //MARK: - reloadCurrentItem
+
+    var reloadCurrentItemCallsCount = 0
+    var reloadCurrentItemCalled: Bool {
+        return reloadCurrentItemCallsCount > 0
+    }
+    var reloadCurrentItemClosure: (() -> Void)?
+    @MainActor
+    func reloadCurrentItem() {
+        reloadCurrentItemCallsCount += 1
+        reloadCurrentItemClosure?()
+    }
     //MARK: - markAsCompleted
 
     var markAsCompletedCallsCount = 0

BookPlayer/Generated/AutoMockable.generated.swift

@@ -714,6 +714,21 @@ extension PlayerManager {
     jumpTo(chapter.start + 0.1, recordBookmark: false)
   }
 
+  @MainActor
+  func reloadCurrentItem() {
+    // Rebuild the in-memory item from storage so externally-changed data (e.g. re-parsed
+    // chapters) takes effect. Playback position is preserved — it's persisted in Core Data and
+    // re-seeded by time in `PlayableItem.init` — and the chapter-change subscription must be
+    // re-bound to the new instance, otherwise the end-of-chapter sleep timer silently breaks.
+    guard let relativePath = currentItem?.relativePath,
+          let libraryItem = libraryService.getSimpleItem(with: relativePath),
+          let updatedItem = try? playbackService.getPlayableItem(from: libraryItem) else {
+      return
+    }
+    currentItem = updatedItem
+    bindPlayableChapterSubscription(to: updatedItem, dropInitialReplay: true)
+  }
+
   func initializeChapterTime(_ time: Double) {
     guard let currentItem = self.currentItem else { return }
 

BookPlayer/Player/PlayerManager.swift

@@ -40,6 +40,9 @@ public protocol PlayerManagerProtocol: AnyObject {
   func directSkip(_ interval: TimeInterval)
   func jumpTo(_ time: Double, recordBookmark: Bool)
   func jumpToChapter(_ chapter: PlayableChapter)
+  /// Rebuild `currentItem` from storage (and re-bind the chapter subscription) so externally
+  /// changed data — e.g. re-parsed chapters — takes effect. Preserves playback position.
+  @MainActor func reloadCurrentItem()
   func markAsCompleted(_ flag: Bool)
   func setSpeed(_ newValue: Float)
   func setBoostVolume(_ newValue: Bool)

BookPlayer/Player/PlayerManagerProtocol.swift

@@ -36,17 +36,45 @@ struct ChaptersView: View {
         .navigationTitle("chapters_title")
         .navigationBarTitleDisplayMode(.inline)
         .toolbar {
-          ToolbarItem(placement: .confirmationAction) {
-            Button("done_title") {
+          ToolbarItem(placement: .cancellationAction) {
+            Button {
               dismiss()
+            } label: {
+              Label("voiceover_close_button", systemImage: "xmark")
             }
             .foregroundStyle(theme.linkColor)
           }
+          if model.canReloadChapters {
+            ToolbarItem(placement: .confirmationAction) {
+              reloadButton
+            }
+          }
         }
+        .bpAlert($model.currentAlert)
       }
     }
   }
 
+  @ViewBuilder
+  private var reloadButton: some View {
+    Button {
+      Task { await model.reloadChapters() }
+    } label: {
+      // Keep the title laid out (just hidden) while loading so the spinner overlay doesn't
+      // change the toolbar item's width.
+      Text("reload_button")
+        .foregroundStyle(theme.linkColor)
+        .opacity(model.isReloadingChapters ? 0 : 1)
+        .overlay {
+          if model.isReloadingChapters {
+            ProgressView()
+          }
+        }
+    }
+    .disabled(model.isReloadingChapters)
+    .accessibilityLabel("reload_chapters_title")
+  }
+
   @ViewBuilder
   private func rowView(_ chapter: PlayableChapter, index: Int) -> some View {
     let title =
@@ -83,16 +111,26 @@ struct ChaptersView: View {
 }
 
 extension ChaptersView {
+  @MainActor
   class Model: ObservableObject {
     @Published var chapters: [PlayableChapter]
     @Published var currentChapter: PlayableChapter?
+    @Published var isReloadingChapters = false
+    @Published var currentAlert: BPAlertContent?
 
     init(chapters: [PlayableChapter], currentChapter: PlayableChapter?) {
       self.chapters = chapters
       self.currentChapter = currentChapter
     }
 
     func handleChapterSelected(_ chapter: PlayableChapter) {}
+
+    /// Whether the "re-parse chapters" action applies to the current item.
+    var canReloadChapters: Bool { false }
+
+    /// Re-parse chapters from the file, replacing the list when more are found, and surface
+    /// the outcome via `currentAlert`.
+    func reloadChapters() async {}
   }
 }
 

BookPlayer/Player/Views/Chapters/ChaptersView.swift

@@ -12,9 +12,11 @@ import Foundation
 
 final class ChaptersViewModel: ChaptersView.Model {
   private let playerManager: PlayerManagerProtocol
+  private let libraryService: LibraryServiceProtocol
 
-  init(playerManager: PlayerManagerProtocol) {
+  init(playerManager: PlayerManagerProtocol, libraryService: LibraryServiceProtocol) {
     self.playerManager = playerManager
+    self.libraryService = libraryService
     super.init(
       chapters: playerManager.currentItem?.chapters ?? [],
       currentChapter: playerManager.currentItem?.currentChapter
@@ -24,4 +26,48 @@ final class ChaptersViewModel: ChaptersView.Model {
   override func handleChapterSelected(_ chapter: PlayableChapter) {
     self.playerManager.jumpToChapter(chapter)
   }
+
+  /// Re-parsing only applies to single-file books; bound books and folders derive their
+  /// chapters from constituent files, so there's no embedded chapter track to re-read.
+  override var canReloadChapters: Bool {
+    playerManager.currentItem?.isBoundBook == false
+  }
+
+  @MainActor
+  override func reloadChapters() async {
+    guard let currentItem = playerManager.currentItem, currentItem.isBoundBook == false else {
+      return
+    }
+
+    let relativePath = currentItem.relativePath
+    let fileURL = DataManager.getProcessedFolderURL().appendingPathComponent(relativePath)
+    guard FileManager.default.fileExists(atPath: fileURL.path) else {
+      // The file must be downloaded first, through the usual library download flow.
+      currentAlert = Self.infoAlert(message: "reparse_chapters_download_description".localized)
+      return
+    }
+
+    isReloadingChapters = true
+    defer { isReloadingChapters = false }
+
+    guard let newCount = await libraryService.reloadChapters(relativePath: relativePath) else {
+      currentAlert = Self.infoAlert(message: "reparse_chapters_none_description".localized)
+      return
+    }
+
+    // Rebuild the player's item so the new chapters take effect everywhere (scrubber, now
+    // playing, end-of-chapter sleep timer), then refresh this screen's list from it.
+    playerManager.reloadCurrentItem()
+    chapters = playerManager.currentItem?.chapters ?? []
+    currentChapter = playerManager.currentItem?.currentChapter
+
+    currentAlert = Self.infoAlert(
+      title: "reparse_chapters_found_title".localized,
+      message: String.localizedStringWithFormat("reparse_chapters_found_description".localized, newCount)
+    )
+  }
+
+  private static func infoAlert(title: String? = nil, message: String) -> BPAlertContent {
+    BPAlertContent(title: title, message: message, style: .alert, actionItems: [.okAction])
+  }
 }

BookPlayer/Player/Views/Chapters/ChaptersViewModel.swift

@@ -166,7 +166,10 @@ struct PlayerView: View {
         .environmentObject(theme)
       case .chapters:
         ChaptersView{
-          ChaptersViewModel(playerManager: viewModel.playerManager)
+          ChaptersViewModel(
+            playerManager: viewModel.playerManager,
+            libraryService: viewModel.libraryService
+          )
         }
         .environmentObject(theme)
       case .bookmark:

BookPlayer/Player/Views/PlayerView.swift

@@ -102,6 +102,12 @@
 "player_book_remaining_title" = "متبقّي %@";
 "chapters_title" = "الفصول";
 "chapters_item_description" = "البداية: %@ - المدة: %@";
+"reload_button" = "إعادة التحميل";
+"reload_chapters_title" = "إعادة تحميل الفصول";
+"reparse_chapters_found_title" = "تمت إعادة تحميل الفصول";
+"reparse_chapters_found_description" = "تم العثور على %d فصلًا.";
+"reparse_chapters_none_description" = "لم يتم العثور على فصول إضافية في هذا الملف.";
+"reparse_chapters_download_description" = "قم بتحميل هذا الكتاب قبل إعادة تحميل فصوله.";
 "restore_title" = "استعادة";
 "themes_caps_title" = "التنسيقات";
 "plus_app_icons_title" = "أيقونات التطبيق";

BookPlayer/ar.lproj/Localizable.strings

@@ -102,6 +102,12 @@
 "player_book_remaining_title" = "%@ restant";
 "chapters_title" = "Capítols";
 "chapters_item_description" = "Inici: %@ - Durada: %@";
+"reload_button" = "Torna a carregar";
+"reload_chapters_title" = "Torna a carregar els capítols";
+"reparse_chapters_found_title" = "Capítols tornats a carregar";
+"reparse_chapters_found_description" = "S'han trobat %d capítols.";
+"reparse_chapters_none_description" = "No s'ha trobat cap capítol addicional en aquest fitxer.";
+"reparse_chapters_download_description" = "Descarrega aquest llibre abans de tornar a carregar-ne els capítols.";
 "restore_title" = "Restaura";
 "themes_caps_title" = "TEMES";
 "plus_app_icons_title" = "Icones de l'aplicació";