Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#526 feat: Add pagination of Podcast episodes #537

Merged
merged 13 commits into from
Jul 13, 2024
Merged

#526 feat: Add pagination of Podcast episodes #537

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
07b5b30
Bump org.owasp:dependency-check-maven from 10.0.1 to 10.0.2
dependabot[bot] Jul 9, 2024
ca97bce
Bump aquasecurity/trivy-action from 0.23.0 to 0.24.0
dependabot[bot] Jul 9, 2024
16f2630
Bump org.apache.maven.plugins:maven-surefire-plugin from 3.3.0 to 3.3.1
dependabot[bot] Jul 10, 2024
7c6dcc6
Bump org.jsoup:jsoup from 1.17.2 to 1.18.1
dependabot[bot] Jul 10, 2024
53bfc6a
chore: removed unnecessary code
kagemomiji Jul 11, 2024
ac85201
kagemomiji/airsonic-advanced#526 feat: add pagination to avoid the hu…
kagemomiji Jul 11, 2024
6f4e200
Merge commit '7c6dcc683129467bf0203ca0ed13214dc4cd6bb9' into issue526…
kagemomiji Jul 11, 2024
f4f0e02
Merge commit '16f263018b9587fe19dbccf53fd68ce15977ef71' into issue526…
kagemomiji Jul 11, 2024
b75aeb2
Merge commit 'ca97bce62fb41a26b3aeb69557c39cfbd1842c2c' into issue526…
kagemomiji Jul 11, 2024
7ed6498
Merge commit '07b5b3045afa689365a27cfe6def5e331e35f4f1' into issue526…
kagemomiji Jul 11, 2024
775ee52
kagemomiji/airsonic-advanced#526 fix: pagination issue in podcastChan…
kagemomiji Jul 11, 2024
187b599
kagemomiji/airsonic-advanced#526 fix podcastChannel.html
kagemomiji Jul 12, 2024
7da792a
kagemomiji/airsonic-advanced#526 fix: add DOMPurify to sanitize URL i…
kagemomiji Jul 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/trivy_scan.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
27 changes: 21 additions & 6 deletions airsonic-main/src/main/java/org/airsonic/player/controller/PodcastChannelController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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;
Expand Down Expand Up @@ -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()) {
Expand All @@ -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()) {
Expand All @@ -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()) {
Expand All @@ -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()) {
Expand All @@ -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);

}

Expand Down
24 changes: 16 additions & 8 deletions airsonic-main/src/main/java/org/airsonic/player/controller/PodcastEpisodesControler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand All @@ -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);
}

/**
Expand All @@ -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) {
Expand All @@ -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);
}

/**
Expand All @@ -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) {
Expand All @@ -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);
}

/**
Expand All @@ -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) {
Expand All @@ -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);
}

}
19 changes: 17 additions & 2 deletions airsonic-main/src/main/java/org/airsonic/player/service/PodcastPersistenceService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down Expand Up @@ -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);
Expand All @@ -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.
*
Expand Down Expand Up @@ -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);
}
}
Expand Down
1 change: 0 additions & 1 deletion airsonic-main/src/main/resources/templates/bookmarks.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
Loading
Loading