From c11d986c3420b1e985903938381d51b3d48d4024 Mon Sep 17 00:00:00 2001
From: Feichtmeier <frederik.feichtmeier@gmail.com>
Date: Fri, 8 Dec 2023 16:18:23 +0100
Subject: [PATCH] feature: download podcasts Fixes #240

---
 lib/constants.dart                            |   1 +
 lib/src/app/master_items.dart                 |  26 ++---
 lib/src/common/audio_page_body.dart           |   8 +-
 lib/src/data/audio.dart                       |   5 +-
 lib/src/library/library_model.dart            |   8 ++
 lib/src/library/library_service.dart          |  18 +++
 lib/src/podcasts/download_button.dart         |  56 +++++++++
 lib/src/podcasts/download_model.dart          |  66 +++++++++++
 lib/src/podcasts/podcast_audio_tile.dart      | 108 +++++++++---------
 lib/src/podcasts/podcast_page.dart            |   1 +
 .../podcasts/podcasts_collection_body.dart    |   1 +
 lib/utils.dart                                |  57 +++++++++
 pubspec.lock                                  |   6 +-
 pubspec.yaml                                  |   1 +
 14 files changed, 291 insertions(+), 71 deletions(-)
 create mode 100644 lib/src/podcasts/download_button.dart
 create mode 100644 lib/src/podcasts/download_model.dart

diff --git a/lib/constants.dart b/lib/constants.dart
index ec505c34..4d82b740 100644
--- a/lib/constants.dart
+++ b/lib/constants.dart
@@ -93,6 +93,7 @@ const kStarredStationsFileName = 'starredStations.json';
 const kSettingsFileName = 'settings.json';
 const kLastPositionsFileName = 'lastPositions.json';
 const kLocalAudioCacheFileName = 'localaudiocache.json';
+const kDownloads = 'downloads.json';
 const kLocalAudioCache = 'localAudioCache';
 const kUseLocalAudioCache = 'cacheSuggestionDisposed';
 const kCreateCacheLimit = 1000;
diff --git a/lib/src/app/master_items.dart b/lib/src/app/master_items.dart
index 1207ec76..5ce7b280 100644
--- a/lib/src/app/master_items.dart
+++ b/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 ??
diff --git a/lib/src/common/audio_page_body.dart b/lib/src/common/audio_page_body.dart
index 9ccce812..903aa7e1 100644
--- a/lib/src/common/audio_page_body.dart
+++ b/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,
                   );
                 }
 
diff --git a/lib/src/data/audio.dart b/lib/src/data/audio.dart
index 981642a0..a424e329 100644
--- a/lib/src/data/audio.dart
+++ b/lib/src/data/audio.dart
@@ -252,8 +252,9 @@ class Audio {
     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 &&
diff --git a/lib/src/library/library_model.dart b/lib/src/library/library_model.dart
index 7b5c8b65..9e4de257 100644
--- a/lib/src/library/library_model.dart
+++ b/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,11 @@ 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];
+
   //
   // Albums
   //
diff --git a/lib/src/library/library_service.dart b/lib/src/library/library_service.dart
index 2f4b4544..1b601243 100644
--- a/lib/src/library/library_service.dart
+++ b/lib/src/library/library_service.dart
@@ -1,6 +1,7 @@
 import 'dart:async';
 
 import 'package:collection/collection.dart';
+import 'package:dio/dio.dart';
 import 'package:flutter/foundation.dart';
 
 import '../../constants.dart';
@@ -227,7 +228,21 @@ class LibraryService {
   }
 
   // Podcasts
+  final dio = Dio();
+  Map<String, String> _downloads = {};
+  Map<String, String> get downloads => _downloads;
+  String? getDownload(String? url) => downloads[url];
 
+  final _downloadsController = StreamController<bool>.broadcast();
+  Stream<bool> get downloadsChanged => _downloadsController.stream;
+  void addDownload(String url, String path) {
+    _downloads.putIfAbsent(url, () => path);
+    writeStringMap(_downloads, kDownloads)
+        .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;
@@ -342,6 +357,8 @@ class LibraryService {
         (await readAudioMap(kLikedAudios)).entries.firstOrNull?.value ??
             <Audio>{};
     _favTags = (await readStringSet(filename: kTagFavsFileName));
+    _downloadsDir = await getDownloadsDir();
+    _downloads = await readStringMap(kDownloads);
     _libraryInitialized = true;
   }
 
@@ -399,6 +416,7 @@ class LibraryService {
   }
 
   Future<void> dispose() async {
+    dio.close();
     await safeStates();
     await _useLocalAudioCacheController.close();
     await _albumsController.close();
diff --git a/lib/src/podcasts/download_button.dart b/lib/src/podcasts/download_button.dart
new file mode 100644
index 00000000..b5771248
--- /dev/null
+++ b/lib/src/podcasts/download_button.dart
@@ -0,0 +1,56 @@
+import 'package:flutter/material.dart';
+import 'package:provider/provider.dart';
+import 'package:ubuntu_service/ubuntu_service.dart';
+
+import '../../common.dart';
+import '../../data.dart';
+import '../../library.dart';
+import 'download_model.dart';
+
+class DownloadButton extends StatelessWidget {
+  const DownloadButton({
+    super.key,
+    this.iconSize,
+    required this.audio,
+  });
+
+  static Widget create({
+    required BuildContext context,
+    double? iconSize,
+    required Audio? audio,
+  }) {
+    return ChangeNotifierProvider(
+      create: (_) => DownloadModel(getService<LibraryService>()),
+      child: DownloadButton(
+        iconSize: iconSize,
+        audio: audio,
+      ),
+    );
+  }
+
+  final double? iconSize;
+  final Audio? audio;
+
+  @override
+  Widget build(BuildContext context) {
+    final theme = Theme.of(context);
+    final model = context.read<DownloadModel>();
+    final value = context.select((DownloadModel m) => m.value);
+    return Stack(
+      alignment: Alignment.center,
+      children: [
+        Progress(
+          value: value ?? 0,
+          backgroundColor: Colors.transparent,
+        ),
+        IconButton(
+          icon: Icon(Iconz().download),
+          // TODO: add remove download
+          onPressed: () => model.startDownload(audio),
+          iconSize: iconSize,
+          color: audio?.path != null ? theme.colorScheme.primary : null,
+        ),
+      ],
+    );
+  }
+}
diff --git a/lib/src/podcasts/download_model.dart b/lib/src/podcasts/download_model.dart
new file mode 100644
index 00000000..1eeb3364
--- /dev/null
+++ b/lib/src/podcasts/download_model.dart
@@ -0,0 +1,66 @@
+import 'dart:io';
+
+import 'package:dio/dio.dart';
+import 'package:safe_change_notifier/safe_change_notifier.dart';
+import 'package:path/path.dart' as p;
+
+import '../../data.dart';
+import '../../library.dart';
+
+class DownloadModel extends SafeChangeNotifier {
+  DownloadModel(this._service);
+
+  final LibraryService _service;
+
+  double? _value;
+  double? get value => _value;
+  void setValue(int received, int total) {
+    if (total <= 0) return;
+    _value = received / total;
+    notifyListeners();
+  }
+
+  Future<void> startDownload(
+    Audio? audio,
+  ) async {
+    _service.dio.interceptors.add(LogInterceptor());
+    // Assure the value of total argument of onReceiveProgress is not -1.
+    _service.dio.options.headers = {HttpHeaders.acceptEncodingHeader: '*'};
+    final downloadsDir = _service.downloadsDir;
+
+    if (audio?.url == null || downloadsDir == null) return;
+
+    final downloadDir = p.join(downloadsDir, 'musicpod');
+
+    if (!Directory(downloadDir).existsSync()) {
+      Directory(downloadDir).createSync();
+    }
+    final fileName =
+        '${audio?.artist}${audio?.title}${audio?.year}'.replaceAll(' ', '_');
+    final file = File(
+      p.join(
+        downloadDir,
+        fileName,
+      ),
+    );
+    file.createSync();
+
+    download1(_service.dio, audio!.url!, file.path);
+  }
+
+  Future download1(Dio dio, String url, String path) async {
+    final cancelToken = CancelToken();
+    try {
+      await dio
+          .download(
+            url,
+            path,
+            onReceiveProgress: setValue,
+            cancelToken: cancelToken,
+          )
+          .then((_) => _service.addDownload(url, path));
+    } catch (e) {
+      //TODO: manage download exception
+    }
+  }
+}
diff --git a/lib/src/podcasts/podcast_audio_tile.dart b/lib/src/podcasts/podcast_audio_tile.dart
index f3d42600..bbfd7a1d 100644
--- a/lib/src/podcasts/podcast_audio_tile.dart
+++ b/lib/src/podcasts/podcast_audio_tile.dart
@@ -13,6 +13,7 @@ import '../../data.dart';
 import '../../theme.dart';
 import '../../utils.dart';
 import 'avatar_with_progress.dart';
+import 'download_button.dart';
 
 const _kGap = 20.0;
 
@@ -30,6 +31,7 @@ class PodcastAudioTile extends StatelessWidget {
     this.isExpanded = false,
     this.removeUpdate,
     required this.safeLastPosition,
+    this.isOnline = true,
   });
 
   final Audio audio;
@@ -44,6 +46,7 @@ class PodcastAudioTile extends StatelessWidget {
 
   final Duration? lastPosition;
   final bool isExpanded;
+  final bool isOnline;
 
   @override
   Widget build(BuildContext context) {
@@ -55,58 +58,61 @@ class PodcastAudioTile extends StatelessWidget {
           ? Duration(milliseconds: audio.durationMs!.toInt())
           : Duration.zero,
     );
+    final enabled = isOnline || audio.path != null;
 
-    return YaruExpandable(
-      expandIcon: const SizedBox.shrink(),
-      isExpanded: isExpanded,
-      gapHeight: 0,
-      header: MouseRegion(
-        cursor: SystemMouseCursors.click,
-        child: Padding(
-          padding: const EdgeInsets.only(
-            top: 15,
-            bottom: 10,
-            left: 19,
-            right: 20,
-          ),
-          child: Row(
-            crossAxisAlignment: CrossAxisAlignment.start,
-            children: [
-              AvatarWithProgress(
+    return !enabled
+        ? const SizedBox.shrink()
+        : YaruExpandable(
+            expandIcon: const SizedBox.shrink(),
+            isExpanded: isExpanded,
+            gapHeight: 0,
+            header: MouseRegion(
+              cursor: SystemMouseCursors.click,
+              child: Padding(
+                padding: const EdgeInsets.only(
+                  top: 15,
+                  bottom: 10,
+                  left: 19,
+                  right: 20,
+                ),
+                child: Row(
+                  crossAxisAlignment: CrossAxisAlignment.start,
+                  children: [
+                    AvatarWithProgress(
+                      selected: selected,
+                      lastPosition: lastPosition,
+                      audio: audio,
+                      isPlayerPlaying: isPlayerPlaying,
+                      pause: pause,
+                      resume: resume,
+                      safeLastPosition: safeLastPosition,
+                      play: play,
+                      removeUpdate: removeUpdate,
+                    ),
+                    const SizedBox(
+                      width: _kGap,
+                    ),
+                    Expanded(
+                      child: _Right(
+                        selected: selected,
+                        audio: audio,
+                        date: date,
+                        duration: duration,
+                      ),
+                    ),
+                  ],
+                ),
+              ),
+            ),
+            child: Align(
+              alignment: Alignment.centerLeft,
+              child: _Bottom(
                 selected: selected,
-                lastPosition: lastPosition,
                 audio: audio,
-                isPlayerPlaying: isPlayerPlaying,
-                pause: pause,
-                resume: resume,
-                safeLastPosition: safeLastPosition,
-                play: play,
-                removeUpdate: removeUpdate,
-              ),
-              const SizedBox(
-                width: _kGap,
-              ),
-              Expanded(
-                child: _Right(
-                  selected: selected,
-                  audio: audio,
-                  date: date,
-                  duration: duration,
-                ),
+                lastPosition: lastPosition,
               ),
-            ],
-          ),
-        ),
-      ),
-      child: Align(
-        alignment: Alignment.centerLeft,
-        child: _Bottom(
-          selected: selected,
-          audio: audio,
-          lastPosition: lastPosition,
-        ),
-      ),
-    );
+            ),
+          );
   }
 }
 
@@ -168,10 +174,10 @@ class _Right extends StatelessWidget {
                   SizedBox(
                     height: kTinyButtonSize,
                     width: kTinyButtonSize,
-                    child: IconButton(
-                      icon: Icon(Iconz().download),
-                      onPressed: null,
+                    child: DownloadButton.create(
+                      context: context,
                       iconSize: kTinyButtonIconSize,
+                      audio: audio,
                     ),
                   ),
                 ],
diff --git a/lib/src/podcasts/podcast_page.dart b/lib/src/podcasts/podcast_page.dart
index 827c98a9..4cfc5d2b 100644
--- a/lib/src/podcasts/podcast_page.dart
+++ b/lib/src/podcasts/podcast_page.dart
@@ -67,6 +67,7 @@ class PodcastPage extends StatelessWidget {
     final genre = audios?.firstWhereOrNull((e) => e.genre != null)?.genre;
 
     context.select((LibraryModel m) => m.lastPositions?.length);
+    context.select((LibraryModel m) => m.downloadsLength);
 
     return AudioPage(
       showAudioTileHeader: false,
diff --git a/lib/src/podcasts/podcasts_collection_body.dart b/lib/src/podcasts/podcasts_collection_body.dart
index 3e2c16ec..9e6619e5 100644
--- a/lib/src/podcasts/podcasts_collection_body.dart
+++ b/lib/src/podcasts/podcasts_collection_body.dart
@@ -69,6 +69,7 @@ class PodcastsCollectionBody extends StatelessWidget {
                           },
                     label: Text(context.l10n.newEpisodes),
                   ),
+                  // TODO: add show only downloads chip
                 ],
               ),
               const SizedBox(
diff --git a/lib/utils.dart b/lib/utils.dart
index c1183dc5..95906ec7 100644
--- a/lib/utils.dart
+++ b/lib/utils.dart
@@ -132,6 +132,15 @@ Future<String?> getMusicDir() async {
   return null;
 }
 
+Future<String?> getDownloadsDir() async {
+  if (Platform.isLinux) {
+    return getUserDirectory('DOWNLOADS')?.path;
+  } else if (Platform.isMacOS) {
+    return (await getDownloadsDirectory())?.path;
+  }
+  return null;
+}
+
 Future<void> writeSetting(
   String? key,
   dynamic value, [
@@ -266,6 +275,54 @@ Future<Map<String, Set<Audio>>> readAudioMap(String fileName) async {
   }
 }
 
+Future<Map<String, String>> readStringMap(String fileName) async {
+  final workingDir = await getWorkingDir();
+
+  try {
+    final file = File(p.join(workingDir, fileName));
+
+    if (file.existsSync()) {
+      final jsonStr = await file.readAsString();
+
+      final map = jsonDecode(jsonStr) as Map<String, dynamic>;
+
+      final m = map.map(
+        (key, value) => MapEntry<String, String>(
+          key,
+          value as String,
+        ),
+      );
+
+      return m;
+    } else {
+      return <String, String>{};
+    }
+  } on Exception catch (_) {
+    return <String, String>{};
+  }
+}
+
+Future<void> writeStringMap(Map<String, String> map, String fileName) async {
+  final dynamicMap = map.map(
+    (key, value) => MapEntry<String, String>(
+      key,
+      value as dynamic,
+    ),
+  );
+
+  final jsonStr = jsonEncode(dynamicMap);
+
+  final workingDir = await getWorkingDir();
+
+  final file = File(p.join(workingDir, fileName));
+
+  if (!file.existsSync()) {
+    file.createSync();
+  }
+
+  await file.writeAsString(jsonStr);
+}
+
 Duration? parseDuration(String? durationAsString) {
   if (durationAsString == null || durationAsString == 'null') return null;
   int hours = 0;
diff --git a/pubspec.lock b/pubspec.lock
index 30928a9f..3b00200d 100644
--- a/pubspec.lock
+++ b/pubspec.lock
@@ -218,13 +218,13 @@ packages:
     source: hosted
     version: "0.6.3"
   dio:
-    dependency: transitive
+    dependency: "direct main"
     description:
       name: dio
-      sha256: "01870acd87986f768e0c09cc4d7a19a59d814af7b34cbeb0b437d2c33bdfea4c"
+      sha256: "797e1e341c3dd2f69f2dad42564a6feff3bfb87187d05abb93b9609e6f1645c3"
       url: "https://pub.dev"
     source: hosted
-    version: "5.3.4"
+    version: "5.4.0"
   equatable:
     dependency: transitive
     description:
diff --git a/pubspec.yaml b/pubspec.yaml
index b493f3b2..44662911 100644
--- a/pubspec.yaml
+++ b/pubspec.yaml
@@ -16,6 +16,7 @@ dependencies:
   connectivity_plus: ^5.0.1
   cupertino_icons: ^1.0.6
   desktop_notifications: ^0.6.3
+  dio: ^5.4.0
   file: ^7.0.0
   file_selector: ^1.0.0
   file_selector_linux: ^0.9.2