From 4ad54f34fe4adbee5089611fc5d20efa5686eb20 Mon Sep 17 00:00:00 2001
From: Marcos Carvalho <marcosfcar@gmail.com>
Date: Sun, 26 May 2024 22:08:53 +0100
Subject: [PATCH] Improvements and fixes on the cellular permissions

---
 components/app/AudioPlayerContainer.vue       | 15 +++-
 components/tables/podcast/EpisodeRow.vue      |  5 ++
 .../tables/podcast/LatestEpisodeRow.vue       | 80 ++++---------------
 ios/App/App/AppDelegate.swift                 |  1 +
 ios/App/App/plugins/AbsDatabase.swift         |  2 +-
 mixins/cellularPermissionHelpers.js           | 42 ++++++++++
 pages/item/_id/_episode/index.vue             |  5 ++
 pages/item/_id/index.vue                      | 10 ++-
 strings/en-us.json                            |  6 +-
 9 files changed, 94 insertions(+), 72 deletions(-)
 create mode 100644 mixins/cellularPermissionHelpers.js

diff --git a/components/app/AudioPlayerContainer.vue b/components/app/AudioPlayerContainer.vue
index 0e92314e..f9178f09 100644
--- a/components/app/AudioPlayerContainer.vue
+++ b/components/app/AudioPlayerContainer.vue
@@ -11,6 +11,7 @@
 <script>
 import { AbsAudioPlayer } from '@/plugins/capacitor'
 import { Dialog } from '@capacitor/dialog'
+import CellularPermissionHelpers from '@/mixins/cellularPermissionHelpers'
 
 export default {
   data() {
@@ -39,6 +40,7 @@ export default {
       serverEpisodeId: null
     }
   },
+  mixins: [CellularPermissionHelpers],
   computed: {
     bookmarks() {
       if (!this.serverLibraryItemId) return []
@@ -193,12 +195,21 @@ export default {
       const startTime = payload.startTime
       const startWhenReady = !payload.paused
 
+      const isLocal = libraryItemId.startsWith('local')
+      if (!isLocal) {
+        const hasPermission = await this.checkCellularPermission('streaming')
+        if (!hasPermission) {
+          this.$store.commit('setPlayerDoneStartingPlayback')
+          return
+        }
+      }
+
       // When playing local library item and can also play this item from the server
       //   then store the server library item id so it can be used if a cast is made
       const serverLibraryItemId = payload.serverLibraryItemId || null
       const serverEpisodeId = payload.serverEpisodeId || null
 
-      if (libraryItemId.startsWith('local') && this.$store.state.isCasting) {
+      if (isLocal && this.$store.state.isCasting) {
         const { value } = await Dialog.confirm({
           title: 'Warning',
           message: `Cannot cast downloaded media items. Confirm to close cast and play on your device.`
@@ -373,4 +384,4 @@ export default {
     this.$eventBus.$off('device-focus-update', this.deviceFocused)
   }
 }
-</script>
\ No newline at end of file
+</script>
diff --git a/components/tables/podcast/EpisodeRow.vue b/components/tables/podcast/EpisodeRow.vue
index a66a386a..2626f971 100644
--- a/components/tables/podcast/EpisodeRow.vue
+++ b/components/tables/podcast/EpisodeRow.vue
@@ -58,6 +58,7 @@
 
 <script>
 import { AbsFileSystem, AbsDownloader } from '@/plugins/capacitor'
+import cellularPermissionHelpers from '@/mixins/cellularPermissionHelpers'
 
 export default {
   props: {
@@ -73,6 +74,7 @@ export default {
     },
     isLocal: Boolean
   },
+  mixins: [cellularPermissionHelpers],
   data() {
     return {
       isProcessingReadUpdate: false,
@@ -180,6 +182,9 @@ export default {
     async downloadClick() {
       if (this.downloadItem || this.startingDownload) return
 
+      const hasPermission = await this.checkCellularPermission('download')
+      if (!hasPermission) return
+
       this.startingDownload = true
       setTimeout(() => {
         this.startingDownload = false
diff --git a/components/tables/podcast/LatestEpisodeRow.vue b/components/tables/podcast/LatestEpisodeRow.vue
index fb24865a..97242af0 100644
--- a/components/tables/podcast/LatestEpisodeRow.vue
+++ b/components/tables/podcast/LatestEpisodeRow.vue
@@ -60,8 +60,8 @@
 </template>
 
 <script>
-import { Dialog } from '@capacitor/dialog'
 import { AbsFileSystem, AbsDownloader } from '@/plugins/capacitor'
+import CellularPermissionHelpers from '@/mixins/cellularPermissionHelpers'
 
 export default {
   props: {
@@ -84,6 +84,7 @@ export default {
       processing: false
     }
   },
+  mixins: [CellularPermissionHelpers],
   computed: {
     bookCoverAspectRatio() {
       return this.$store.getters['libraries/getBookCoverAspectRatio']
@@ -97,15 +98,6 @@ export default {
     userCanDownload() {
       return this.$store.getters['user/getUserCanDownload']
     },
-    canDownloadUsingCellular() {
-      return this.$store.getters['getCanDownloadUsingCellular']
-    },
-    canStreamUsingCellular() {
-      return this.$store.getters['getCanStreamingUsingCellular']
-    },
-    isCellular() {
-      return this.$store.state.networkConnectionType === 'cellular'
-    },
     audioFile() {
       return this.episode.audioFile
     },
@@ -195,43 +187,10 @@ export default {
       }
       return folderObj
     },
-    async confirmAction(action) {
-      const { value } = await Dialog.confirm({
-        title: 'Confirm',
-        message: `You are about to ${action} using cellular data. Do you want to proceed?`
-      });
-      return value
-    },
-    async checkDownloadPermission() {
-      if (this.isCellular) {
-        const permission = this.canDownloadUsingCellular
-        if (permission === 'NEVER') {
-          this.$toast.error('Downloading is not allowed on cellular data.')
-          return false
-        } else if (permission === 'ASK') {
-          const confirmed = await this.confirmAction('download')
-          return confirmed
-        }
-      }
-      return true
-    },
-    async checkStreamPermission() {
-      if (this.isCellular) {
-        const permission = this.canStreamUsingCellular
-        if (permission === 'NEVER') {
-          this.$toast.error('Streaming is not allowed on cellular data.')
-          return false
-        } else if (permission === 'ASK') {
-          const confirmed = await this.confirmAction('stream')
-          return confirmed
-        }
-      }
-      return true
-    },
     async downloadClick() {
       if (this.downloadItem || this.pendingDownload) return
 
-      const hasPermission = await this.checkDownloadPermission()
+      const hasPermission = await this.checkCellularPermission('download')
       if (!hasPermission) return
 
       this.pendingDownload = true
@@ -305,26 +264,13 @@ export default {
       if (this.streamIsPlaying) {
         this.$eventBus.$emit('pause-item')
       } else {
-        if (this.localEpisode && this.localLibraryItemId) {
-          this.$store.commit('setPlayerIsStartingPlayback', this.episode.id)
-          console.log('Play local episode', this.localEpisode.id, this.localLibraryItemId)
-
-          this.$eventBus.$emit('play-item', {
-            libraryItemId: this.localLibraryItemId,
-            episodeId: this.localEpisode.id,
-            serverLibraryItemId: this.libraryItemId,
-            serverEpisodeId: this.episode.id
-          })
-        } else {
-          const hasPermission = await this.checkStreamPermission()
-          if (!hasPermission) return
-
-          this.$store.commit('setPlayerIsStartingPlayback', this.episode.id)
-          this.$eventBus.$emit('play-item', {
-            libraryItemId: this.libraryItemId,
-            episodeId: this.episode.id
-          })
-        }
+        this.$store.commit('setPlayerIsStartingPlayback', this.episode.id)
+        this.$eventBus.$emit('play-item', {
+          libraryItemId: this.libraryItemId,
+          episodeId: this.episode.id,
+          serverLibraryItemId: this.libraryItemId,
+          serverEpisodeId: this.episode.id
+        })
       }
     },
     async toggleFinished() {
@@ -335,7 +281,11 @@ export default {
         const isFinished = !this.userIsFinished
         const localLibraryItemId = this.isLocal ? this.libraryItemId : this.localLibraryItemId
         const localEpisodeId = this.isLocal ? this.episode.id : this.localEpisode.id
-        const payload = await this.$db.updateLocalMediaProgressFinished({ localLibraryItemId, localEpisodeId, isFinished })
+        const payload = await this.$db.updateLocalMediaProgressFinished({
+          localLibraryItemId,
+          localEpisodeId,
+          isFinished
+        })
         console.log('toggleFinished payload', JSON.stringify(payload))
         if (payload?.error) {
           this.$toast.error(payload?.error || 'Unknown error')
diff --git a/ios/App/App/AppDelegate.swift b/ios/App/App/AppDelegate.swift
index 67c2526b..0a912b89 100644
--- a/ios/App/App/AppDelegate.swift
+++ b/ios/App/App/AppDelegate.swift
@@ -60,6 +60,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
                         newObject?["downloadUsingCellular"] = "ALWAYS"
                         newObject?["streamingUsingCellular"] = "ALWAYS"
                     }
+                }
 
             }
         )
diff --git a/ios/App/App/plugins/AbsDatabase.swift b/ios/App/App/plugins/AbsDatabase.swift
index 8355ef12..2a15197c 100644
--- a/ios/App/App/plugins/AbsDatabase.swift
+++ b/ios/App/App/plugins/AbsDatabase.swift
@@ -245,7 +245,7 @@ public class AbsDatabase: CAPPlugin {
         let hapticFeedback = call.getString("hapticFeedback") ?? "LIGHT"
         let languageCode = call.getString("languageCode") ?? "en-us"
         let downloadUsingCellular = call.getString("downloadUsingCellular") ?? "ALWAYS"
-        let streamingUsingCellular = call.getString("downloadUsingCellular") ?? "ALWAYS"
+        let streamingUsingCellular = call.getString("streamingUsingCellular") ?? "ALWAYS"
         let settings = DeviceSettings()
         settings.disableAutoRewind = disableAutoRewind
         settings.enableAltView = enableAltView
diff --git a/mixins/cellularPermissionHelpers.js b/mixins/cellularPermissionHelpers.js
new file mode 100644
index 00000000..83016474
--- /dev/null
+++ b/mixins/cellularPermissionHelpers.js
@@ -0,0 +1,42 @@
+import { Dialog } from '@capacitor/dialog';
+
+export default {
+  methods: {
+    async checkCellularPermission(actionType) {
+      if (this.$store.state.networkConnectionType !== 'cellular') return true
+
+      let permission;
+      if (actionType === 'download') {
+        permission = this.$store.getters['getCanDownloadUsingCellular']
+        if (permission === 'NEVER') {
+          this.$toast.error(this.$strings.ToastDownloadNotAllowedOnCellular)
+          return false
+        }
+      } else if (actionType === 'streaming') {
+        permission = this.$store.getters['getCanStreamingUsingCellular']
+        if (permission === 'NEVER') {
+          this.$toast.error(this.$strings.ToastStreamingNotAllowedOnCellular)
+          return false
+        }
+      }
+
+      if (permission === 'ASK') {
+        const confirmed = await this.confirmAction(actionType)
+        return confirmed
+      }
+
+      return true
+    },
+    async confirmAction(actionType) {
+      const message = actionType === 'download' ?
+        this.$strings.MessageConfirmDownloadUsingCellular :
+        this.$strings.MessageConfirmStreamingUsingCellular
+
+      const { value } = await Dialog.confirm({
+        title: 'Confirm',
+        message
+      })
+      return value
+    }
+  }
+}
diff --git a/pages/item/_id/_episode/index.vue b/pages/item/_id/_episode/index.vue
index c33ee6f4..be3ec3c6 100644
--- a/pages/item/_id/_episode/index.vue
+++ b/pages/item/_id/_episode/index.vue
@@ -56,6 +56,7 @@
 import { Capacitor } from '@capacitor/core'
 import { Dialog } from '@capacitor/dialog'
 import { AbsFileSystem, AbsDownloader } from '@/plugins/capacitor'
+import cellularPermissionHelpers from '@/mixins/cellularPermissionHelpers'
 
 export default {
   async asyncData({ store, params, redirect, app }) {
@@ -115,6 +116,7 @@ export default {
       startingDownload: false
     }
   },
+  mixins: [cellularPermissionHelpers],
   computed: {
     transformedDescription() {
       return this.parseDescription(this.description)
@@ -419,6 +421,9 @@ export default {
     async downloadClick() {
       if (this.downloadItem || this.startingDownload) return
 
+      const hasPermission = await this.checkCellularPermission('download')
+      if (!hasPermission) return
+
       this.startingDownload = true
       setTimeout(() => {
         this.startingDownload = false
diff --git a/pages/item/_id/index.vue b/pages/item/_id/index.vue
index be22b9e7..85a29cea 100644
--- a/pages/item/_id/index.vue
+++ b/pages/item/_id/index.vue
@@ -171,6 +171,7 @@
 import { Dialog } from '@capacitor/dialog'
 import { AbsFileSystem, AbsDownloader } from '@/plugins/capacitor'
 import { FastAverageColor } from 'fast-average-color'
+import cellularPermissionHelpers from '@/mixins/cellularPermissionHelpers'
 
 export default {
   async asyncData({ store, params, redirect, app, query }) {
@@ -221,6 +222,7 @@ export default {
       startingDownload: false
     }
   },
+  mixins: [cellularPermissionHelpers],
   computed: {
     isIos() {
       return this.$platform === 'ios'
@@ -607,9 +609,11 @@ export default {
       this.download(localFolder)
     },
     async downloadClick() {
-      if (this.downloadItem || this.startingDownload) {
-        return
-      }
+      if (this.downloadItem || this.startingDownload)  return
+
+      const hasPermission = await this.checkCellularPermission('download')
+      if (!hasPermission) return
+
       this.startingDownload = true
       setTimeout(() => {
         this.startingDownload = false
diff --git a/strings/en-us.json b/strings/en-us.json
index 264c48e5..84fc7184 100644
--- a/strings/en-us.json
+++ b/strings/en-us.json
@@ -251,8 +251,10 @@
   "MessageConfirmDeleteLocalEpisode": "Remove local episode \"{0}\" from your device? The file on the server will be unaffected.",
   "MessageConfirmDeleteLocalFiles": "Remove local files of this item from your device? The files on the server and your progress will be unaffected.",
   "MessageConfirmDiscardProgress": "Are you sure you want to reset your progress?",
+  "MessageConfirmDownloadUsingCellular": "You are about to download using cellular data. This may include carrier data charges. Do you wish to continue?",
   "MessageConfirmMarkAsFinished": "Are you sure you want to mark this item as finished?",
   "MessageConfirmRemoveBookmark": "Are you sure you want to remove bookmark?",
+  "MessageConfirmStreamingUsingCellular": "You are about to stream using cellular data. This may include carrier data charges. Do you wish to continue?",
   "MessageDiscardProgress": "Discard Progress",
   "MessageDownloadCompleteProcessing": "Download complete. Processing...",
   "MessageDownloading": "Downloading...",
@@ -292,11 +294,13 @@
   "ToastBookmarkCreateFailed": "Failed to create bookmark",
   "ToastBookmarkRemoveFailed": "Failed to remove bookmark",
   "ToastBookmarkUpdateFailed": "Failed to update bookmark",
+  "ToastDownloadNotAllowedOnCellular": "Downloading is not allowed on cellular data",
   "ToastItemMarkedAsFinishedFailed": "Failed to mark as Finished",
   "ToastItemMarkedAsNotFinishedFailed": "Failed to mark as Not Finished",
   "ToastPlaylistCreateFailed": "Failed to create playlist",
   "ToastPodcastCreateFailed": "Failed to create podcast",
   "ToastPodcastCreateSuccess": "Podcast created successfully",
   "ToastRSSFeedCloseFailed": "Failed to close RSS feed",
-  "ToastRSSFeedCloseSuccess": "RSS feed closed"
+  "ToastRSSFeedCloseSuccess": "RSS feed closed",
+  "ToastStreamingNotAllowedOnCellular": "Streaming is not allowed on cellular data"
 }