feature: download podcasts (#344)

* feature: download podcasts
Fixes #240

* Add remove/cancel

* Localize and improve cancel

* Add downloads only button

* Change readme

* Remove on unsub

Author: Feichtmeier

README.md

@@ -53,7 +53,7 @@ Thank you @tomassasovsky for the [dart implementation of radiobrowser-api](https
 - [X] Play TV Stations found on radiobrowser
 - [ ] Chromecast Support ([#91](https://github.com/ubuntu-flutter-community/musicpod/issues/91))
 - [X] streaming provider agnostic sharing links
-- [ ] option to download podcasts (#[240](https://github.com/ubuntu-flutter-community/musicpod/issues/240))
+- [X] option to download podcasts (#[240](https://github.com/ubuntu-flutter-community/musicpod/issues/240))
 - [X] reduced memory allocation
 - [ ] WebDav support (#[248](https://github.com/ubuntu-flutter-community/musicpod/issues/248))
 - [ ] upnp/dlna support (#[248](https://github.com/ubuntu-flutter-community/musicpod/issues/247))

lib/constants.dart

@@ -93,6 +93,8 @@ const kStarredStationsFileName = 'starredStations.json';
 const kSettingsFileName = 'settings.json';
 const kLastPositionsFileName = 'lastPositions.json';
 const kLocalAudioCacheFileName = 'localaudiocache.json';
+const kDownloads = 'downloads.json';
+const kFeedsWithDownloads = 'feedswithdownloads.json';
 const kLocalAudioCache = 'localAudioCache';
 const kUseLocalAudioCache = 'cacheSuggestionDisposed';
 const kCreateCacheLimit = 1000;

lib/src/app/master_items.dart

@@ -112,20 +112,18 @@ List<MasterItem> createMasterItems({
               podcast.value.firstOrNull?.title ??
               podcast.value.firstOrNull.toString(),
         ),
-        pageBuilder: (context) => isOnline
-            ? PodcastPage(
-                pageId: podcast.key,
-                title: podcast.value.firstOrNull?.album ??
-                    podcast.value.firstOrNull?.title ??
-                    podcast.value.firstOrNull.toString(),
-                audios: podcast.value,
-                onTextTap: onTextTap,
-                addPodcast: addPodcast,
-                removePodcast: removePodcast,
-                imageUrl: podcast.value.firstOrNull?.albumArtUrl ??
-                    podcast.value.firstOrNull?.imageUrl,
-              )
-            : const OfflinePage(),
+        pageBuilder: (context) => PodcastPage(
+          pageId: podcast.key,
+          title: podcast.value.firstOrNull?.album ??
+              podcast.value.firstOrNull?.title ??
+              podcast.value.firstOrNull.toString(),
+          audios: podcast.value,
+          onTextTap: onTextTap,
+          addPodcast: addPodcast,
+          removePodcast: removePodcast,
+          imageUrl: podcast.value.firstOrNull?.albumArtUrl ??
+              podcast.value.firstOrNull?.imageUrl,
+        ),
         iconBuilder: (context, selected) => PodcastPage.createIcon(
           context: context,
           imageUrl: podcast.value.firstOrNull?.albumArtUrl ??

lib/src/common/audio_page_body.dart

@@ -7,6 +7,7 @@ import '../../common.dart';
 import '../../data.dart';
 import '../../player.dart';
 import '../../podcasts.dart';
+import '../app/connectivity_notifier.dart';
 import '../library/library_model.dart';
 
 class AudioPageBody extends StatefulWidget {
@@ -90,6 +91,7 @@ class _AudioPageBodyState extends State<AudioPageBody> {
 
   @override
   Widget build(BuildContext context) {
+    final isOnline = context.select((ConnectivityNotifier c) => c.isOnline);
     final isPlaying = context.select((PlayerModel m) => m.isPlaying);
 
     final playerModel = context.read<PlayerModel>();
@@ -209,13 +211,16 @@ class _AudioPageBodyState extends State<AudioPageBody> {
                   List.generate(sortedAudios.take(_amount).length, (index) {
                 final audio = sortedAudios.elementAt(index);
                 final audioSelected = currentAudio == audio;
+                final download = libraryModel.getDownload(audio.url);
 
                 if (audio.audioType == AudioType.podcast) {
                   return PodcastAudioTile(
                     removeUpdate: () =>
                         libraryModel.removePodcastUpdate(widget.pageId),
                     isExpanded: audioSelected,
-                    audio: audio,
+                    audio: download != null
+                        ? audio.copyWith(path: download)
+                        : audio,
                     isPlayerPlaying: isPlaying,
                     selected: audioSelected,
                     pause: pause,
@@ -226,6 +231,7 @@ class _AudioPageBodyState extends State<AudioPageBody> {
                     play: play,
                     lastPosition: libraryModel.getLastPosition.call(audio.url),
                     safeLastPosition: playerModel.safeLastPosition,
+                    isOnline: isOnline,
                   );
                 }
 

lib/src/data/audio.dart

@@ -247,13 +247,20 @@ class Audio {
     return 'Audio(path: $path, url: $url,  audioType: $audioType, imageUrl: $imageUrl, description: $description, website: $website, title: $title, durationMs: $durationMs, artist: $artist, album: $album, albumArtist: $albumArtist, trackNumber: $trackNumber, trackTotal: $trackTotal, discNumber: $discNumber, discTotal: $discTotal, year: $year, genre: $genre, pictureMimeType: $pictureMimeType, pictureData: $pictureData, fileSize: $fileSize, albumArtUrl: $albumArtUrl)';
   }
 
+  String toShortPath() {
+    final now = DateTime.now().toUtc().toString();
+    return '${artist ?? ''}${title ?? ''}${durationMs ?? ''}${year ?? ''})$now'
+        .replaceAll(RegExp(r'[^a-zA-Z0-9]'), '');
+  }
+
   @override
   bool operator ==(Object other) {
     if (identical(this, other)) return true;
 
     return other is Audio &&
-        other.path == path &&
-        other.url == url &&
+        (other.path == path ||
+            (other.url == url && other.path != null) ||
+            other.url == url) &&
         other.audioType == audioType &&
         other.imageUrl == imageUrl &&
         other.description == description &&

lib/src/l10n/app_de.arb

@@ -117,5 +117,30 @@
     "collection": "Sammlung",
     "addToCollection": "Zur Sammlung hinzufügen",
     "removeFromCollection": "Aus Sammlung entfernen",
-    "loadingPodcastFeed": "Lade Podcast-Feed..."
+    "loadingPodcastFeed": "Lade Podcast-Feed...",
+    "downloadStarted": "Herunterladen gestartet: {name}",
+    "@downloadStarted": {
+        "placeholders": {
+            "name": {
+                "type": "String"
+            }
+        }
+    },
+    "downloadCancelled": "Herunterladen abgebrochen: {name}",
+    "@downloadCancelled": {
+        "placeholders": {
+            "name": {
+                "type": "String"
+            }
+        }
+    },
+    "downloadFinished": "Herunterladen abgeschlossen: {name}",
+    "@downloadFinished": {
+        "placeholders": {
+            "name": {
+                "type": "String"
+            }
+        }
+    },
+    "downloadsOnly": "Nur Downloads"
 }

lib/src/l10n/app_en.arb

@@ -117,5 +117,30 @@
     "collection": "Collection",
     "addToCollection": "Add to collection",
     "removeFromCollection": "Remove from collection",
-    "loadingPodcastFeed": "Loading podcast feed..."
+    "loadingPodcastFeed": "Loading podcast feed...",
+    "downloadStarted": "Download started: {name}",
+    "@downloadStarted": {
+        "placeholders": {
+            "name": {
+                "type": "String"
+            }
+        }
+    },
+    "downloadCancelled": "Download cancelled: {name}",
+    "@downloadCancelled": {
+        "placeholders": {
+            "name": {
+                "type": "String"
+            }
+        }
+    },
+    "downloadFinished": "Download finished: {name}",
+    "@downloadFinished": {
+        "placeholders": {
+            "name": {
+                "type": "String"
+            }
+        }
+    },
+    "downloadsOnly": "Downloads only"
 }

lib/src/library/library_model.dart

@@ -22,6 +22,7 @@ class LibraryModel extends SafeChangeNotifier {
   StreamSubscription<bool>? _neverShowFailedImportsSub;
   StreamSubscription<bool>? _favTagsSub;
   StreamSubscription<bool>? _lastFavSub;
+  StreamSubscription<bool>? _downloadsSub;
 
   bool get neverShowFailedImports => _service.neverShowFailedImports;
   Future<void> setNeverShowLocalImports() async =>
@@ -56,6 +57,7 @@ class LibraryModel extends SafeChangeNotifier {
         _service.neverShowFailedImportsChanged.listen((_) => notifyListeners());
     _favTagsSub = _service.favTagsChanged.listen((_) => notifyListeners());
     _lastFavSub = _service.lastFavChanged.listen((_) => notifyListeners());
+    _downloadsSub = _service.downloadsChanged.listen((_) => notifyListeners());
 
     notifyListeners();
   }
@@ -79,6 +81,7 @@ class LibraryModel extends SafeChangeNotifier {
     _neverShowFailedImportsSub?.cancel();
     _favTagsSub?.cancel();
     _lastFavSub?.cancel();
+    _downloadsSub?.cancel();
 
     super.dispose();
   }
@@ -184,6 +187,16 @@ class LibraryModel extends SafeChangeNotifier {
   void removePodcastUpdate(String feedUrl) =>
       _service.removePodcastUpdate(feedUrl);
 
+  int get downloadsLength => _service.downloads.length;
+
+  String? getDownload(String? url) =>
+      url == null ? null : _service.downloads[url];
+
+  bool feedHasDownload(String? feedUrl) =>
+      feedUrl == null ? false : _service.feedHasDownloads(feedUrl);
+
+  int get feedsWithDownloadsLength => _service.feedsWithDownloadsLength;
+
   //
   // Albums
   //

lib/src/library/library_service.dart

@@ -1,6 +1,8 @@
 import 'dart:async';
+import 'dart:io';
 
 import 'package:collection/collection.dart';
+import 'package:dio/dio.dart';
 import 'package:flutter/foundation.dart';
 
 import '../../constants.dart';
@@ -227,7 +229,70 @@ class LibraryService {
   }
 
   // Podcasts
+  final dio = Dio();
+  Map<String, String> _downloads = {};
+  Map<String, String> get downloads => _downloads;
+  String? getDownload(String? url) => downloads[url];
+
+  Set<String> _feedsWithDownloads = {};
+  bool feedHasDownloads(String feedUrl) =>
+      _feedsWithDownloads.contains(feedUrl);
+  int get feedsWithDownloadsLength => _feedsWithDownloads.length;
+
+  final _downloadsController = StreamController<bool>.broadcast();
+  Stream<bool> get downloadsChanged => _downloadsController.stream;
+  void addDownload({
+    required String url,
+    required String path,
+    required String feedUrl,
+  }) {
+    _downloads.putIfAbsent(url, () => path);
+    _feedsWithDownloads.add(feedUrl);
+    writeStringMap(_downloads, kDownloads)
+        .then(
+          (_) => writeStringSet(
+            set: _feedsWithDownloads,
+            filename: kFeedsWithDownloads,
+          ),
+        )
+        .then((_) => _downloadsController.add(true));
+  }
+
+  void removeDownload({required String url, required String feedUrl}) {
+    final path = _downloads[url];
+
+    if (path != null) {
+      final file = File(path);
+      if (file.existsSync()) {
+        file.deleteSync();
+      }
+    }
+
+    if (_downloads.containsKey(url)) {
+      _downloads.remove(url);
+      _feedsWithDownloads.remove(feedUrl);
+
+      writeStringMap(_downloads, kDownloads)
+          .then(
+            (_) => writeStringSet(
+              set: _feedsWithDownloads,
+              filename: kFeedsWithDownloads,
+            ),
+          )
+          .then((_) => _downloadsController.add(true));
+    }
+  }
+
+  void _removeFeedWithDownload(String feedUrl) {
+    _feedsWithDownloads.remove(feedUrl);
+    writeStringSet(
+      set: _feedsWithDownloads,
+      filename: kFeedsWithDownloads,
+    ).then((_) => _downloadsController.add(true));
+  }
 
+  String? _downloadsDir;
+  String? get downloadsDir => _downloadsDir;
   Map<String, Set<Audio>> _podcasts = {};
   Map<String, Set<Audio>> get podcasts => _podcasts;
   int get podcastsLength => _podcasts.length;
@@ -274,7 +339,9 @@ class LibraryService {
   void removePodcast(String name) {
     _podcasts.remove(name);
     writeAudioMap(_podcasts, kPodcastsFileName)
-        .then((_) => _podcastsController.add(true));
+        .then((_) => _podcastsController.add(true))
+        .then((_) => removePodcastUpdate(name))
+        .then((_) => _removeFeedWithDownload(name));
   }
 
   //
@@ -342,6 +409,9 @@ class LibraryService {
         (await readAudioMap(kLikedAudios)).entries.firstOrNull?.value ??
             <Audio>{};
     _favTags = (await readStringSet(filename: kTagFavsFileName));
+    _downloadsDir = await getDownloadsDir();
+    _downloads = await readStringMap(kDownloads);
+    _feedsWithDownloads = await readStringSet(filename: kFeedsWithDownloads);
     _libraryInitialized = true;
   }
 
@@ -399,6 +469,7 @@ class LibraryService {
   }
 
   Future<void> dispose() async {
+    dio.close();
     await safeStates();
     await _useLocalAudioCacheController.close();
     await _albumsController.close();
@@ -414,6 +485,7 @@ class LibraryService {
     await _neverShowFailedImportsController.close();
     await _lastFavController.close();
     await _updateController.close();
+    await _downloadsController.close();
   }
 
   Future<void> safeStates() async {