Merge pull request #537 from kagemomiji/issue526-podcast-episode-pagi…

…nation #526 feat: Add pagination of Podcast episodes
kagemomiji · Jul 13, 2024 · 5d4891a · 5d4891a
2 parents abc9274 + 7da792a
commit 5d4891a
Show file tree

Hide file tree

Showing 9 changed files with 201 additions and 30 deletions.
diff --git a/.github/workflows/trivy_scan.yml b/.github/workflows/trivy_scan.yml
@@ -19,7 +19,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Run Trivy vulnerability scanner
-        uses: aquasecurity/trivy-action@0.23.0
+        uses: aquasecurity/trivy-action@0.24.0
         with:
           scan-type: 'fs'
           format: 'sarif'

diff --git a/airsonic-main/src/main/java/org/airsonic/player/controller/PodcastChannelController.java b/airsonic-main/src/main/java/org/airsonic/player/controller/PodcastChannelController.java
@@ -22,6 +22,7 @@
 
 import org.airsonic.player.command.PodcastChannelCommand;
 import org.airsonic.player.command.PodcastEpisodeCommand;
+import org.airsonic.player.domain.PodcastEpisode;
 import org.airsonic.player.domain.PodcastStatus;
 import org.airsonic.player.domain.User;
 import org.airsonic.player.domain.UserSettings;
@@ -30,6 +31,8 @@
 import org.airsonic.player.service.SecurityService;
 import org.airsonic.player.service.podcast.PodcastDownloadClient;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.PageRequest;
 import org.springframework.security.access.AccessDeniedException;
 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -73,23 +76,29 @@ public User getUser(HttpServletRequest request) {
 
     @GetMapping
     protected ModelAndView get(@ModelAttribute User user,
-            @RequestParam(name = "id", required = true) Integer channelId) throws Exception {
+            @RequestParam(name = "id", required = true) Integer channelId,
+            @RequestParam(name = "page", required = false, defaultValue = "0") Integer page,
+            @RequestParam(name = "size", required = false, defaultValue = "10") Integer size) throws Exception {
 
         PodcastChannelCommand command = new PodcastChannelCommand();
         UserSettings settings = personalSettingsService.getUserSettings(user.getUsername());
         command.setUser(user);
         command.setChannel(podcastService.getChannel(channelId));
-        command.setEpisodesByDAO(podcastService.getEpisodes(channelId));
+        Page<PodcastEpisode> episodes = podcastService.getEpisodes(channelId, PageRequest.of(page, size));
+        command.setEpisodesByDAO(episodes.getContent());
         command.setPartyModeEnabled(settings.getPartyModeEnabled());
 
         ModelAndView result = new ModelAndView();
         result.addObject("command", command);
+        result.addObject("pages", episodes);
         return result;
     }
 
     @PostMapping(params = "delete")
     protected String deleteEpisodes(@ModelAttribute User user,
             @ModelAttribute(name = "channelId") Integer channelId,
+            @RequestParam(name = "page", defaultValue = "0") Integer page,
+            @RequestParam(name = "size", defaultValue = "10") Integer size,
             @ModelAttribute("command") PodcastChannelCommand command) throws Exception {
 
         if (!user.isPodcastRole()) {
@@ -105,13 +114,15 @@ protected String deleteEpisodes(@ModelAttribute User user,
                 .map(PodcastEpisodeCommand::getId)
                 .forEach(id -> podcastService.deleteEpisode(id, true));
 
-        return "redirect:/podcastChannel.view?id=" + channelId;
+        return String.format("redirect:/podcastChannel.view?id=%d&page=%d&size=%d", channelId, page, size);
 
     }
 
     @PostMapping(params = "download")
     protected String downloadEpisodes(@ModelAttribute User user,
             @ModelAttribute(name = "channelId") Integer channelId,
+            @RequestParam(name = "page", defaultValue = "0") Integer page,
+            @RequestParam(name = "size", defaultValue = "10") Integer size,
             @ModelAttribute("command") PodcastChannelCommand command) throws Exception {
 
         if (!user.isPodcastRole()) {
@@ -127,13 +138,15 @@ protected String downloadEpisodes(@ModelAttribute User user,
                 .map(PodcastEpisodeCommand::getId)
                 .forEach(podcastDownloadClient::downloadEpisode);
 
-        return "redirect:/podcastChannel.view?id=" + channelId;
+        return String.format("redirect:/podcastChannel.view?id=%d&page=%d&size=%d", channelId, page, size);
 
     }
 
     @PostMapping(params = "lock")
     protected String lockEpisodes(@ModelAttribute User user,
             @ModelAttribute(name = "channelId") Integer channelId,
+            @RequestParam(name = "page", defaultValue = "0") Integer page,
+            @RequestParam(name = "size", defaultValue = "10") Integer size,
             @ModelAttribute("command") PodcastChannelCommand command) throws Exception {
 
         if (!user.isPodcastRole()) {
@@ -149,13 +162,15 @@ protected String lockEpisodes(@ModelAttribute User user,
                 .map(PodcastEpisodeCommand::getId)
                 .forEach(podcastService::lockEpisode);
 
-        return "redirect:/podcastChannel.view?id=" + channelId;
+        return String.format("redirect:/podcastChannel.view?id=%d&page=%d&size=%d", channelId, page, size);
 
     }
 
     @PostMapping(params = "unlock")
     protected String unlockEpisodes(@ModelAttribute User user,
             @ModelAttribute(name = "channelId") Integer channelId,
+            @RequestParam(name = "page", defaultValue = "0") Integer page,
+            @RequestParam(name = "size", defaultValue = "10") Integer size,
             @ModelAttribute("command") PodcastChannelCommand command) throws Exception {
 
         if (!user.isPodcastRole()) {
@@ -171,7 +186,7 @@ protected String unlockEpisodes(@ModelAttribute User user,
                 .map(PodcastEpisodeCommand::getId)
                 .forEach(podcastService::unlockEpisode);
 
-        return "redirect:/podcastChannel.view?id=" + channelId;
+        return String.format("redirect:/podcastChannel.view?id=%d&page=%d&size=%d", channelId, page, size);
 
     }
 

diff --git a/airsonic-main/src/main/java/org/airsonic/player/controller/PodcastEpisodesControler.java b/airsonic-main/src/main/java/org/airsonic/player/controller/PodcastEpisodesControler.java
@@ -51,7 +51,9 @@ public class PodcastEpisodesControler {
 
     @PostMapping(params = "download")
     public String downloadEpisode(
-            @RequestParam(name = "episodeId", required = true) Integer episodeId) throws Exception {
+            @RequestParam(name = "episodeId", required = true) Integer episodeId,
+            @RequestParam(name = "page", required = false, defaultValue = "0") Integer page,
+            @RequestParam(name = "size", required = false, defaultValue = "10") Integer size) throws Exception {
 
         PodcastEpisode episode = podcastService.getEpisode(episodeId, false);
         if (episode == null) {
@@ -63,7 +65,7 @@ public String downloadEpisode(
         Integer channelId = episode.getChannel().getId();
         podcastDownloadClient.downloadEpisode(episodeId);
 
-        return "redirect:/podcastChannel?id=" + channelId;
+        return String.format("redirect:/podcastChannel.view?id=%d&page=%d&size=%d", channelId, page, size);
     }
 
     /**
@@ -75,7 +77,9 @@ public String downloadEpisode(
      */
     @PostMapping(params = "init")
     public String initializeEpisode(
-            @RequestParam(name = "episodeId", required = true) Integer episodeId) throws Exception {
+            @RequestParam(name = "episodeId", required = true) Integer episodeId,
+            @RequestParam(name = "page", required = false, defaultValue = "0") Integer page,
+            @RequestParam(name = "size", required = false, defaultValue = "10") Integer size) throws Exception {
 
         PodcastEpisode episode = podcastService.getEpisode(episodeId, true);
         if (episode == null) {
@@ -87,7 +91,7 @@ public String initializeEpisode(
         Integer channelId = episode.getChannel().getId();
         podcastService.resetEpisode(episodeId);
 
-        return "redirect:/podcastChannel?id=" + channelId;
+        return String.format("redirect:/podcastChannel.view?id=%d&page=%d&size=%d", channelId, page, size);
     }
 
     /**
@@ -99,7 +103,9 @@ public String initializeEpisode(
      */
     @PostMapping(params = "lock")
     public String lockEpisode(
-            @RequestParam(name = "episodeId", required = true) Integer episodeId) throws Exception {
+            @RequestParam(name = "episodeId", required = true) Integer episodeId,
+            @RequestParam(name = "page", required = false, defaultValue = "0") Integer page,
+            @RequestParam(name = "size", required = false, defaultValue = "10") Integer size) throws Exception {
 
         PodcastEpisode episode = podcastService.getEpisode(episodeId, true);
         if (episode == null) {
@@ -111,7 +117,7 @@ public String lockEpisode(
         Integer channelId = episode.getChannel().getId();
         podcastService.lockEpisode(episodeId);
 
-        return "redirect:/podcastChannel?id=" + channelId;
+        return String.format("redirect:/podcastChannel.view?id=%d&page=%d&size=%d", channelId, page, size);
     }
 
     /**
@@ -123,7 +129,9 @@ public String lockEpisode(
      */
     @PostMapping(params = "unlock")
     public String unlockEpisode(
-            @RequestParam(name = "episodeId", required = true) Integer episodeId) throws Exception {
+            @RequestParam(name = "episodeId", required = true) Integer episodeId,
+            @RequestParam(name = "page", required = false, defaultValue = "0") Integer page,
+            @RequestParam(name = "size", required = false, defaultValue = "10") Integer size) throws Exception {
 
         PodcastEpisode episode = podcastService.getEpisode(episodeId, true);
         if (episode == null) {
@@ -135,7 +143,7 @@ public String unlockEpisode(
         Integer channelId = episode.getChannel().getId();
         podcastService.unlockEpisode(episodeId);
 
-        return "redirect:/podcastChannel?id=" + channelId;
+        return String.format("redirect:/podcastChannel.view?id=%d&page=%d&size=%d", channelId, page, size);
     }
 
 }
diff --git a/airsonic-main/src/main/java/org/airsonic/player/service/PodcastPersistenceService.java b/airsonic-main/src/main/java/org/airsonic/player/service/PodcastPersistenceService.java
@@ -43,6 +43,9 @@
 import org.jdom2.Namespace;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.springframework.data.domain.Page;
+import org.springframework.data.domain.PageImpl;
+import org.springframework.data.domain.Pageable;
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
 
@@ -384,7 +387,7 @@ public List<PodcastEpisode> getEpisodes(Integer channelId) {
                     if (mediaFile != null) {
                         // Refresh media file to check if it still exists
                         mediaFileService.refreshMediaFile(mediaFile);
-                        if (!mediaFile.isPresent() && ep.getStatus() != PodcastStatus.DELETED) {
+                        if (!mediaFile.isPresent() && ep.getStatus() != PodcastStatus.DELETED && !ep.isLocked()) {
                             LOG.info("Media file '{}' for episode '{}' is not present anymore. Setting episode status to deleted.", mediaFile.getId(), ep.getTitle());
                             // If media file is not present anymore, set episode status to deleted
                             ep.setStatus(PodcastStatus.DELETED);
@@ -402,6 +405,18 @@ public List<PodcastEpisode> getEpisodes(Integer channelId) {
         });
     }
 
+    @Transactional
+    public Page<PodcastEpisode> getEpisodes(Integer channelId, Pageable pageable) {
+        List<PodcastEpisode> episodes = getEpisodes(channelId);
+
+        int start = (int) pageable.getOffset();
+        int end = Math.min((start + pageable.getPageSize()), episodes.size());
+
+        List<PodcastEpisode> result = episodes.size() > start ? episodes.subList(start, end) : Collections.emptyList();
+
+        return new PageImpl<>(result, pageable, episodes.size());
+    }
+
     /**
      * Returns the N newest episodes.
      *
@@ -432,7 +447,7 @@ public PodcastEpisode getEpisode(int episodeId, boolean includeDeleted) {
                     if (mediaFile != null) {
                         // Refresh media file to check if it still exists
                         mediaFileService.refreshMediaFile(mediaFile);
-                        if (!mediaFile.isPresent() && ep.getStatus() != PodcastStatus.DELETED) {
+                        if (!mediaFile.isPresent() && ep.getStatus() != PodcastStatus.DELETED && !ep.isLocked()) {
                             deleteEpisode(ep, true);
                         }
                     }

diff --git a/airsonic-main/src/main/resources/static/script/purify-3.1.6.min.js b/airsonic-main/src/main/resources/static/script/purify-3.1.6.min.js
diff --git a/airsonic-main/src/main/resources/templates/bookmarks.html b/airsonic-main/src/main/resources/templates/bookmarks.html
@@ -31,7 +31,6 @@
                 order: [],
                 orderMulti: true,
                 pageLength: /*[[${model.initialPaginationSize}]]*/ 10,
-              //<c:set var="paginationaddition" value="${fn:contains(' 10 20 50 100 -1', ' '.concat(model.initialPaginationSize)) ? '' : ', '.concat(model.initialPaginationSize)}" />
                 lengthMenu: [ [10, 20, 50, 100, -1 ], [10, 20, 50, 100, "All" ] ],
                 processing: true,
                 autoWidth: true,