Skip to content

🐛 Fix incomplete OPDS 2.0 catalog pagination #1444

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

Merged
aaronleopold merged 2 commits into from
Oct 1, 2026
+431 −35
Merged

🐛 Fix incomplete OPDS 2.0 catalog pagination #1444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a08f07e
🐛 Fix OPDS 2.0 catalog pagination
eduardojvieira Sep 28, 2026
de489b0
🐛 fix(opds): propagate pagination link errors
eduardojvieira Oct 1, 2026
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
253 changes: 218 additions & 35 deletions apps/server/src/routers/opds/v2_0.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,12 +70,15 @@ pub(crate) fn mount(app_state: AppState) -> Router<AppState> {
"/libraries",
Router::new().route("/", get(browse_libraries)).nest(
"/{id}",
Router::new().route("/", get(browse_library_by_id)).nest(
"/books",
Router::new()
.route("/", get(browse_library_books))
.route("/latest", get(latest_library_books)),
),
Router::new()
.route("/", get(browse_library_by_id))
.nest(
"/books",
Router::new()
.route("/", get(browse_library_books))
.route("/latest", get(latest_library_books)),
)
.route("/series", get(browse_library_series)),
),
)
.nest(
Expand Down Expand Up @@ -262,6 +265,20 @@ struct OPDSBrowseParams {
filter: OPDSBrowseFilter,
}

fn pagination_href(base_url: &str, pagination: &OffsetPagination, page: u64) -> String {
let separator = if base_url.contains('?') { "&" } else { "?" };
let mut href = format!("{base_url}{separator}page={page}");

if pagination.page_size != Some(20) {
href.push_str(&format!("&page_size={}", pagination.limit()));
}
if pagination.zero_based == Some(true) {
href.push_str("&zero_based=true");
}

href
}

#[tracing::instrument]
async fn auth(HostExtractor(host): HostExtractor) -> APIResult<OPDSAuthDocWrapper> {
Ok(OPDSAuthDocWrapper(
Expand Down Expand Up @@ -656,6 +673,34 @@ async fn browse_libraries(
)
.build()?;

let previous_link = match pagination.previous_page() {
Some(page) => Some(
link_finalizer.finalize(OPDSLink::Link(
OPDSBaseLinkBuilder::default()
.href(pagination_href("/opds/v2.0/libraries", &pagination, page))
.rel(OPDSLinkRel::Previous.item())
.build()?,
)),
),
None => None,
};
let next_link = if (pagination.offset() + take) < library_count {
Some(
link_finalizer.finalize(OPDSLink::Link(
OPDSBaseLinkBuilder::default()
.href(pagination_href(
"/opds/v2.0/libraries",
&pagination,
pagination.next_page(),
))
.rel(OPDSLinkRel::Next.item())
.build()?,
)),
)
} else {
None
};

Ok(Json(
OPDSFeedBuilder::default()
.metadata(
Expand All @@ -665,17 +710,26 @@ async fn browse_libraries(
OPDSPaginationMetadataBuilder::default()
.number_of_items(library_count)
.items_per_page(take)
.current_page(1)
.current_page(pagination.page)
.build()?,
))
.build()?,
)
.links(link_finalizer.finalize_all(vec![OPDSLink::Link(
OPDSBaseLinkBuilder::default()
.href("/opds/v2.0/libraries/browse".to_string())
.rel(OPDSLinkRel::SelfLink.item())
.build()?,
)]))
.links(
link_finalizer.finalize_all(chain_optional_iter(
[OPDSLink::Link(
OPDSBaseLinkBuilder::default()
.href(pagination_href(
"/opds/v2.0/libraries",
&pagination,
pagination.page,
))
.rel(OPDSLinkRel::SelfLink.item())
.build()?,
)],
[previous_link, next_link],
)),
)
.navigation(
libraries
.into_iter()
Expand Down Expand Up @@ -806,12 +860,12 @@ async fn browse_library_by_id(
))
.build()?,
)
// .links(vec![OPDSLink::Link(
// OPDSBaseLinkBuilder::default()
// .href(format!("/opds/v2.0/libraries/{id}/series"))
// .rel(OPDSLinkRel::SelfLink.item()) // TODO(OPDS-V2): Not self
// .build()?,
// )])
.links(link_finalizer.finalize_all(vec![OPDSLink::Link(
OPDSBaseLinkBuilder::default()
.href(format!("/opds/v2.0/libraries/{id}/series"))
.rel(OPDSLinkRel::SelfLink.item())
.build()?,
)]))
.navigation(
library_series
.into_iter()
Expand All @@ -830,6 +884,19 @@ async fn browse_library_by_id(
.rel(OPDSLinkRel::SelfLink.item())
.build()?,
)]))
.navigation(vec![OPDSNavigationLinkBuilder::default()
.title("All Series".to_string())
.base_link(
OPDSBaseLinkBuilder::default()
.href(
link_finalizer
.format_link(format!("/opds/v2.0/libraries/{id}/series")),
)
.rel(OPDSLinkRel::Subsection.item())
._type(OPDSLinkType::OpdsJson)
.build()?,
)
.build()?])
.groups(vec![books_group, latest_books_group, series_group])
.build()?,
))
Expand Down Expand Up @@ -886,42 +953,51 @@ where
OPDSPublication::vec_from_books(ctx.conn.as_ref(), link_finalizer.clone(), books)
.await?;

let next_page = pagination.next_page();
let page_separator = if base_url.contains('?') { "&" } else { "?" };
let has_more = (pagination.offset() + take) < books_count;
let previous_link = match pagination.previous_page() {
Some(page) => Some(
link_finalizer.finalize(OPDSLink::Link(
OPDSBaseLinkBuilder::default()
.href(format!("{base_url}{page_separator}page={page}"))
.href(pagination_href(base_url, &pagination, page))
.rel(OPDSLinkRel::Previous.item())
.build()?,
)),
),
None => None,
};

let next_link = if has_more {
Some(
link_finalizer.finalize(OPDSLink::Link(
OPDSBaseLinkBuilder::default()
.href(pagination_href(
base_url,
&pagination,
pagination.next_page(),
))
.rel(OPDSLinkRel::Next.item())
.build()?,
)),
)
} else {
None
};
let links = link_finalizer.finalize_all(chain_optional_iter(
[
OPDSLink::Link(
OPDSBaseLinkBuilder::default()
.href(base_url.to_string())
.href(pagination_href(base_url, &pagination, pagination.page))
.rel(OPDSLinkRel::SelfLink.item())
.build()?,
),
OPDSLink::Link(
OPDSBaseLinkBuilder::default()
.href("/opds/v2.0/books/catalog".to_string())
.href("/opds/v2.0/catalog".to_string())
.rel(OPDSLinkRel::Start.item())
.build()?,
),
OPDSLink::Link(
OPDSBaseLinkBuilder::default()
.href(format!("{base_url}{page_separator}page={next_page}"))
.rel(OPDSLinkRel::Next.item())
.build()?,
),
],
[previous_link],
[previous_link, next_link],
));

Ok(Json(
Expand Down Expand Up @@ -994,6 +1070,110 @@ async fn latest_library_books(
.await
}

#[tracing::instrument(skip(ctx))]
async fn browse_library_series(
State(ctx): State<AppState>,
HostExtractor(host): HostExtractor,
Path(id): Path<String>,
pagination: Query<OffsetPagination>,
Extension(req): Extension<AuthContext>,
) -> APIResult<Json<OPDSFeed>> {
let user = req.user();
let library = library::Entity::find_for_user(&user)
.filter(library::Column::Id.eq(id.clone()))
.one(ctx.conn.as_ref())
.await?
.ok_or(APIError::NotFound("Library not found".to_string()))?;
let take = pagination.limit();
let series = series::Entity::find_for_user(&user)
.filter(series::Column::LibraryId.eq(id.clone()))
.limit(take)
.offset(pagination.offset())
.order_by_asc(series::Column::Name)
.all(ctx.conn.as_ref())
.await?;
let series_count = series::Entity::find_for_user(&user)
.filter(series::Column::LibraryId.eq(id.clone()))
.count(ctx.conn.as_ref())
.await?;
let link_finalizer = OPDSLinkFinalizer::from(host);
let base_url = format!("/opds/v2.0/libraries/{id}/series");
let previous_link = match pagination.previous_page() {
Some(page) => Some(
link_finalizer.finalize(OPDSLink::Link(
OPDSBaseLinkBuilder::default()
.href(pagination_href(&base_url, &pagination, page))
.rel(OPDSLinkRel::Previous.item())
.build()?,
)),
),
None => None,
};
let next_link = if (pagination.offset() + take) < series_count {
Some(
link_finalizer.finalize(OPDSLink::Link(
OPDSBaseLinkBuilder::default()
.href(pagination_href(
&base_url,
&pagination,
pagination.next_page(),
))
.rel(OPDSLinkRel::Next.item())
.build()?,
)),
)
} else {
None
};

Ok(Json(
OPDSFeedBuilder::default()
.metadata(
OPDSMetadataBuilder::default()
.title(format!("{} Series", library.name))
.pagination(Some(
OPDSPaginationMetadataBuilder::default()
.number_of_items(series_count)
.items_per_page(take)
.current_page(pagination.page)
.build()?,
))
.build()?,
)
.links(
link_finalizer.finalize_all(chain_optional_iter(
[
OPDSLink::Link(
OPDSBaseLinkBuilder::default()
.href(pagination_href(
&base_url,
&pagination,
pagination.page,
))
.rel(OPDSLinkRel::SelfLink.item())
.build()?,
),
OPDSLink::Link(
OPDSBaseLinkBuilder::default()
.href("/opds/v2.0/catalog".to_string())
.rel(OPDSLinkRel::Start.item())
.build()?,
),
],
[previous_link, next_link],
)),
)
.navigation(
series
.into_iter()
.map(OPDSNavigationLink::from)
.map(|link| link.finalize(&link_finalizer))
.collect::<Vec<_>>(),
)
.build()?,
))
}

#[tracing::instrument(skip(ctx))]
async fn browse_series(
State(ctx): State<AppState>,
Expand All @@ -1017,12 +1197,11 @@ async fn browse_series(
let link_finalizer = OPDSLinkFinalizer::from(host);

let base_url = "/opds/v2.0/series";
let next_page = pagination.next_page();
let previous_link = match pagination.previous_page() {
Some(page) => Some(
link_finalizer.finalize(OPDSLink::Link(
OPDSBaseLinkBuilder::default()
.href(format!("{base_url}?page={page}"))
.href(pagination_href(base_url, &pagination, page))
.rel(OPDSLinkRel::Previous.item())
.build()?,
)),
Expand All @@ -1033,7 +1212,11 @@ async fn browse_series(
let next_link = (has_more).then_some(
link_finalizer.finalize(OPDSLink::Link(
OPDSBaseLinkBuilder::default()
.href(format!("{base_url}?page={next_page}"))
.href(pagination_href(
base_url,
&pagination,
pagination.next_page(),
))
.rel(OPDSLinkRel::Next.item())
.build()?,
)),
Expand All @@ -1043,7 +1226,7 @@ async fn browse_series(
[
OPDSLink::Link(
OPDSBaseLinkBuilder::default()
.href(base_url.to_string())
.href(pagination_href(base_url, &pagination, pagination.page))
.rel(OPDSLinkRel::SelfLink.item())
.build()?,
),
Expand Down
Loading
Loading