From ddc10bcf8a9ce4da9785dd59fe063c2afd08338e Mon Sep 17 00:00:00 2001
From: Feichtmeier <frederik.feichtmeier@gmail.com>
Date: Mon, 20 Jan 2025 21:00:26 +0100
Subject: [PATCH] feat: mark podcast episodes as played

Fixes #1117
---
 lib/common/view/icons.dart                    |  5 ++
 lib/l10n/app_en.arb                           |  1 +
 lib/persistence_utils.dart                    | 67 ++++++++++++++++++-
 lib/player/player_model.dart                  |  4 ++
 lib/player/player_service.dart                | 43 +++++++++---
 lib/player/view/bottom_player.dart            |  2 +
 .../view/full_height_player_top_controls.dart |  4 ++
 lib/player/view/player_main_controls.dart     |  8 ++-
 lib/podcasts/view/podcast_page.dart           | 12 +++-
 needs_translation.json                        | 44 ++++++++++++
 10 files changed, 172 insertions(+), 18 deletions(-)

diff --git a/lib/common/view/icons.dart b/lib/common/view/icons.dart
index d4749d031..0c03ea6e2 100644
--- a/lib/common/view/icons.dart
+++ b/lib/common/view/icons.dart
@@ -462,4 +462,9 @@ class Iconz {
       : appleStyled
           ? CupertinoIcons.moon
           : Icons.mode_night_rounded;
+  static IconData get markAllRead => yaruStyled
+      ? YaruIcons.ok_filled
+      : appleStyled
+          ? CupertinoIcons.check_mark_circled_solid
+          : Icons.check_circle;
 }
diff --git a/lib/l10n/app_en.arb b/lib/l10n/app_en.arb
index 29d7f4b9b..6f7b7557e 100644
--- a/lib/l10n/app_en.arb
+++ b/lib/l10n/app_en.arb
@@ -179,6 +179,7 @@
             }
         }
     },
+    "markAllEpisodesAsDone": "Mark all episodes as done",
     "downloadsOnly": "Downloads only",
     "downloadsDirectory": "Location of your downloads",
     "downloadsDirectoryDescription": "Make sure MusicPod can access this directory!",
diff --git a/lib/persistence_utils.dart b/lib/persistence_utils.dart
index 5ab5c00b6..bffaab040 100644
--- a/lib/persistence_utils.dart
+++ b/lib/persistence_utils.dart
@@ -83,7 +83,33 @@ Future<void> writeCustomSetting(
   final file = File(p.join(workingDir, filename));
 
   if (!file.existsSync()) {
-    file.create();
+    file.createSync();
+  }
+
+  await file.writeAsString(jsonStr);
+}
+
+Future<void> writeCustomSettings({
+  required List<MapEntry<String, dynamic>> entries,
+  required String filename,
+}) async {
+  if (entries.isEmpty) return;
+  final oldSettings = await getCustomSettings(filename);
+
+  for (var entry in entries) {
+    if (oldSettings.containsKey(entry.key)) {
+      oldSettings.update(entry.key, (v) => entry.value);
+    } else {
+      oldSettings.putIfAbsent(entry.key, () => entry.value);
+    }
+  }
+
+  final jsonStr = jsonEncode(oldSettings);
+  final workingDir = await getWorkingDir();
+  final file = File(p.join(workingDir, filename));
+
+  if (!file.existsSync()) {
+    await file.create();
   }
 
   await file.writeAsString(jsonStr);
@@ -103,12 +129,33 @@ Future<void> removeCustomSetting(
     final file = File(p.join(workingDir, filename));
 
     if (!file.existsSync()) {
-      file.create();
+      await file.create();
     }
     await file.writeAsString(jsonStr);
   }
 }
 
+Future<void> removeCustomSettings(
+  List<String> keys, [
+  String filename = kSettingsFileName,
+]) async {
+  final oldSettings = await getCustomSettings(filename);
+  for (var key in keys) {
+    if (oldSettings.containsKey(key)) {
+      oldSettings.remove(key);
+    }
+  }
+
+  final jsonStr = jsonEncode(oldSettings);
+  final workingDir = await getWorkingDir();
+  final file = File(p.join(workingDir, filename));
+
+  if (!file.existsSync()) {
+    await file.create();
+  }
+  await file.writeAsString(jsonStr);
+}
+
 Future<dynamic> readCustomSetting(
   dynamic key, [
   String filename = kSettingsFileName,
@@ -143,6 +190,20 @@ Future<Map<String, String>> getCustomSettings([
   }
 }
 
+Future<void> wipeCustomSettings([
+  String filename = kSettingsFileName,
+]) async {
+  final workingDir = await getWorkingDir();
+
+  final file = File(p.join(workingDir, filename));
+
+  if (!file.existsSync()) {
+    file.createSync();
+  }
+
+  await file.writeAsString('{}');
+}
+
 Future<void> writeStringIterable({
   required Iterable<String> iterable,
   required String filename,
@@ -150,7 +211,7 @@ Future<void> writeStringIterable({
   final workingDir = await getWorkingDir();
   final file = File('$workingDir/$filename');
   if (!file.existsSync()) {
-    file.create();
+    await file.create();
   }
   await file.writeAsString(iterable.join('\n'));
 }
diff --git a/lib/player/player_model.dart b/lib/player/player_model.dart
index e85f989b6..3af1ddc31 100644
--- a/lib/player/player_model.dart
+++ b/lib/player/player_model.dart
@@ -117,6 +117,10 @@ class PlayerModel extends SafeChangeNotifier {
   Map<String, Duration>? get lastPositions => _playerService.lastPositions;
   Duration? getLastPosition(String? url) => _playerService.getLastPosition(url);
   Future<void> safeLastPosition() => _playerService.safeLastPosition();
+
+  Future<void> safeAllLastPositions(List<Audio> audios) =>
+      _playerService.safeAllLastPositions(audios);
+
   Future<void> removeLastPosition(String key) =>
       _playerService.removeLastPosition(key);
   Future<void> removeLastPositions(List<Audio> audios) =>
diff --git a/lib/player/player_service.dart b/lib/player/player_service.dart
index 41a9bb5c9..6368291ca 100644
--- a/lib/player/player_service.dart
+++ b/lib/player/player_service.dart
@@ -441,9 +441,7 @@ class PlayerService {
   Future<void> _setPlayerState() async {
     final playerState = await _readPlayerState();
 
-    _lastPositions = (await getCustomSettings(kLastPositionsFileName)).map(
-      (key, value) => MapEntry(key, value.parsedDuration ?? Duration.zero),
-    );
+    await _loadLastPositions();
 
     if (playerState?.audio != null) {
       _setAudio(playerState!.audio!);
@@ -475,6 +473,12 @@ class PlayerService {
     }
   }
 
+  Future<void> _loadLastPositions() async {
+    _lastPositions = (await getCustomSettings(kLastPositionsFileName)).map(
+      (key, value) => MapEntry(key, value.parsedDuration ?? Duration.zero),
+    );
+  }
+
   //
   // Last Positions used when the app re-opens and for podcasts
   //
@@ -497,6 +501,24 @@ class PlayerService {
     _propertiesChangedController.add(true);
   }
 
+  Future<void> safeAllLastPositions(List<Audio> audios) async {
+    await writeCustomSettings(
+      entries: audios
+          .where((e) => e.url != null && e.durationMs != null)
+          .map(
+            (e) => MapEntry(
+              e.url!,
+              Duration(milliseconds: e.durationMs!.toInt()).toString(),
+            ),
+          )
+          .toList(),
+      filename: kLastPositionsFileName,
+    );
+    await _loadLastPositions();
+
+    _propertiesChangedController.add(true);
+  }
+
   Future<void> removeLastPosition(String key) async {
     await removeCustomSetting(key, kLastPositionsFileName);
     _lastPositions.remove(key);
@@ -504,13 +526,14 @@ class PlayerService {
   }
 
   Future<void> removeLastPositions(List<Audio> audios) async {
-    for (var e in audios) {
-      if (e.url != null) {
-        await removeCustomSetting(e.url!, kLastPositionsFileName);
-        _lastPositions.remove(e.url!);
-        _propertiesChangedController.add(true);
-      }
-    }
+    await removeCustomSettings(
+      audios.where((e) => e.url != null).map((e) => e.url!).toList(),
+      kLastPositionsFileName,
+    );
+
+    await _loadLastPositions();
+
+    _propertiesChangedController.add(true);
   }
 
   Duration? getLastPosition(String? url) => _lastPositions[url];
diff --git a/lib/player/view/bottom_player.dart b/lib/player/view/bottom_player.dart
index 82e4264bc..dd73aaa20 100644
--- a/lib/player/view/bottom_player.dart
+++ b/lib/player/view/bottom_player.dart
@@ -17,6 +17,7 @@ import 'bottom_player_image.dart';
 import 'play_button.dart';
 import 'playback_rate_button.dart';
 import 'player_main_controls.dart';
+import 'player_pause_timer_button.dart';
 import 'player_title_and_artist.dart';
 import 'player_track.dart';
 import 'player_view.dart';
@@ -103,6 +104,7 @@ class BottomPlayer extends StatelessWidget with WatchItMixin {
                       if (audio?.audioType == AudioType.podcast)
                         PlaybackRateButton(active: active),
                       if (!isMobilePlatform) const VolumeSliderPopup(),
+                      const PlayerPauseTimerButton(),
                       const QueueButton(
                         isSelected: false,
                       ),
diff --git a/lib/player/view/full_height_player_top_controls.dart b/lib/player/view/full_height_player_top_controls.dart
index 2d1ccd6b5..2ce07ff63 100644
--- a/lib/player/view/full_height_player_top_controls.dart
+++ b/lib/player/view/full_height_player_top_controls.dart
@@ -18,6 +18,7 @@ import '../../library/library_model.dart';
 import '../../player/player_model.dart';
 import '../../search/search_model.dart';
 import 'playback_rate_button.dart';
+import 'player_pause_timer_button.dart';
 import 'player_view.dart';
 import 'queue/queue_button.dart';
 import 'volume_popup.dart';
@@ -88,6 +89,9 @@ class FullHeightPlayerTopControls extends StatelessWidget with WatchItMixin {
               _ => const SizedBox.shrink(),
             },
           if (showQueueButton) QueueButton(color: iconColor),
+          PlayerPauseTimerButton(
+            iconColor: iconColor,
+          ),
           ShareButton(
             audio: audio,
             active: active,
diff --git a/lib/player/view/player_main_controls.dart b/lib/player/view/player_main_controls.dart
index fe0861e0e..0debe739c 100644
--- a/lib/player/view/player_main_controls.dart
+++ b/lib/player/view/player_main_controls.dart
@@ -11,7 +11,6 @@ import '../../extensions/theme_data_x.dart';
 import '../../l10n/l10n.dart';
 import '../player_model.dart';
 import 'play_button.dart';
-import 'player_pause_timer_button.dart';
 import 'repeat_button.dart';
 import 'seek_button.dart';
 import 'shuffle_button.dart';
@@ -117,8 +116,11 @@ class PlayerMainControls extends StatelessWidget with WatchItMixin {
             active: active,
             iconColor: defaultColor,
           ),
-        AudioType.radio => PlayerPauseTimerButton(
-            iconColor: defaultColor,
+        AudioType.radio => SizedBox.square(
+            dimension: context.theme.iconButtonTheme.style?.shape
+                ?.resolve({})
+                ?.dimensions
+                .horizontal,
           ),
         _ => const SizedBox.shrink(),
       },
diff --git a/lib/podcasts/view/podcast_page.dart b/lib/podcasts/view/podcast_page.dart
index a9327461b..4e25f3a77 100644
--- a/lib/podcasts/view/podcast_page.dart
+++ b/lib/podcasts/view/podcast_page.dart
@@ -23,7 +23,6 @@ import '../../extensions/build_context_x.dart';
 import '../../l10n/l10n.dart';
 import '../../library/library_model.dart';
 import '../../player/player_model.dart';
-import '../../player/view/player_pause_timer_button.dart';
 import '../../search/search_model.dart';
 import '../../search/search_type.dart';
 import '../../settings/settings_model.dart';
@@ -168,7 +167,16 @@ class _PodcastPageState extends State<PodcastPage> {
                       children: [
                         if (!isMobilePlatform)
                           PodcastReplayButton(audios: episodesWithDownloads),
-                        const PlayerPauseTimerButton(),
+                        IconButton(
+                          tooltip: l10n.markAllEpisodesAsDone,
+                          onPressed: () {
+                            di<PlayerModel>()
+                                .safeAllLastPositions(episodesWithDownloads);
+                            di<LibraryModel>()
+                                .removePodcastUpdate(widget.feedUrl);
+                          },
+                          icon: Icon(Iconz.markAllRead),
+                        ),
                         PodcastSubButton(
                           audios: episodesWithDownloads,
                           pageId: widget.feedUrl,
diff --git a/needs_translation.json b/needs_translation.json
index fbd37b013..49464bb88 100644
--- a/needs_translation.json
+++ b/needs_translation.json
@@ -5,6 +5,7 @@
     "saveAndAuthorize",
     "showArtistPage",
     "showAlbumPage",
+    "markAllEpisodesAsDone",
     "downloadsDirectory",
     "downloadsDirectoryDescription",
     "downloadsChangeWarning",
@@ -308,6 +309,7 @@
     "showArtistPage",
     "showAlbumPage",
     "insertedIntoQueue",
+    "markAllEpisodesAsDone",
     "downloadsDirectory",
     "downloadsDirectoryDescription",
     "downloadsChangeWarning",
@@ -606,9 +608,30 @@
   ],
 
   "de": [
+    "markAllEpisodesAsDone",
     "exposeToListenBrainzSubTitle"
   ],
 
+  "es": [
+    "markAllEpisodesAsDone"
+  ],
+
+  "et": [
+    "markAllEpisodesAsDone"
+  ],
+
+  "eu": [
+    "markAllEpisodesAsDone"
+  ],
+
+  "fr": [
+    "markAllEpisodesAsDone"
+  ],
+
+  "it": [
+    "markAllEpisodesAsDone"
+  ],
+
   "nl": [
     "home",
     "showArtistPage",
@@ -623,6 +646,7 @@
     "country",
     "tag",
     "failedToImport",
+    "markAllEpisodesAsDone",
     "downloadsChangeWarning",
     "moreOptions",
     "noRadioServerFound",
@@ -1087,6 +1111,7 @@
     "showArtistPage",
     "showAlbumPage",
     "stations",
+    "markAllEpisodesAsDone",
     "downloadsDirectory",
     "downloadsDirectoryDescription",
     "downloadsChangeWarning",
@@ -1366,6 +1391,7 @@
     "downloadStarted",
     "downloadCancelled",
     "downloadFinished",
+    "markAllEpisodesAsDone",
     "downloadsOnly",
     "downloadsDirectory",
     "downloadsDirectoryDescription",
@@ -1859,6 +1885,7 @@
     "downloadStarted",
     "downloadCancelled",
     "downloadFinished",
+    "markAllEpisodesAsDone",
     "downloadsOnly",
     "downloadsDirectory",
     "downloadsDirectoryDescription",
@@ -2305,6 +2332,7 @@
   ],
 
   "ru": [
+    "markAllEpisodesAsDone",
     "clicks",
     "regionAruba",
     "regionAustralia",
@@ -2545,12 +2573,25 @@
     "regionZimbabwe"
   ],
 
+  "sk": [
+    "markAllEpisodesAsDone"
+  ],
+
+  "sv": [
+    "markAllEpisodesAsDone"
+  ],
+
+  "ta": [
+    "markAllEpisodesAsDone"
+  ],
+
   "tr": [
     "home",
     "local",
     "saveAndAuthorize",
     "showArtistPage",
     "showAlbumPage",
+    "markAllEpisodesAsDone",
     "downloadsDirectory",
     "downloadsDirectoryDescription",
     "downloadsChangeWarning",
@@ -2852,6 +2893,7 @@
     "saveAndAuthorize",
     "showArtistPage",
     "showAlbumPage",
+    "markAllEpisodesAsDone",
     "useMoreAnimationsTitle",
     "useMoreAnimationsDescription",
     "showPositionDurationTitle",
@@ -2874,6 +2916,7 @@
     "saveAndAuthorize",
     "showArtistPage",
     "showAlbumPage",
+    "markAllEpisodesAsDone",
     "downloadsDirectory",
     "downloadsDirectoryDescription",
     "downloadsChangeWarning",
@@ -3168,6 +3211,7 @@
     "saveAndAuthorize",
     "showArtistPage",
     "showAlbumPage",
+    "markAllEpisodesAsDone",
     "downloadsDirectory",
     "downloadsDirectoryDescription",
     "downloadsChangeWarning",