diff --git a/docs/plans/2026-09-05-bookorbit-read-link.md b/docs/plans/2026-09-05-bookorbit-read-link.md new file mode 100644 index 0000000..fc2991e --- /dev/null +++ b/docs/plans/2026-09-05-bookorbit-read-link.md @@ -0,0 +1,106 @@ +# "Read in BookOrbit" link on the issue page + +**Date:** 2026-09-05 +**Repository:** `thallada/the-daily-epub` +**Status:** small implementation plan, ready to execute +**Builds on:** `docs/plans/2026-09-03-web-dashboard.md` (the signed-in issue page this adds a button to) + +Written for a fresh implementation agent. Every fact about BookOrbit below was verified on 2026-09-05 against its source (`github.com/bookorbit/bookorbit`, `HEAD`) and against the live instance on this host. Do not re-derive them; do re-check anything marked *assumption*. + +--- + +## 1. Goal + +On the signed-in issue page (`src/web/templates/issue_full.html`), next to the existing **Download EPUB / X4 EPUB / XTC** buttons, add a **Read in BookOrbit** button that opens the *normal* (Standard) edition of that issue in BookOrbit's in-browser EPUB reader at `https://bookorbit.hallada.net`. The operator reads on desktop through this link instead of downloading. + +Out of scope: the X4 edition, the public (anonymous) issue page, the OPDS feed, the EPUB itself. + +## 2. Verified facts + +### About this repo + +- The pipeline does **not** upload to BookOrbit. `publish::publish_issue` atomically copies both EPUB editions into `publish.epub_dir` (`/home/thallada/bookorbit/books/daily-epub` on the host); BookOrbit's *watched folder* scanner picks them up later. Nothing in the run ever learns a BookOrbit id. +- BookOrbit runs on the same host as Docker (`~/bookorbit/docker-compose.yml`): app container `bookorbit-app` published on `127.0.0.1:3498`, Postgres in `bookorbit-db` with **no published port**, and the `daily-epub` service user has no Docker socket access. Reading BookOrbit's database directly is therefore not an option. +- Issue titles: `Issue::title()` is `The Daily EPUB — ` (em dash), and `title_for(Edition::Standard)` is that exact string while `title_for(Edition::X4)` appends ` (X4)` (`src/types.rs` ~531–544). Filenames use a hyphen instead: `publish::issue_filename(date, edition, "epub")` → `The Daily EPUB - .epub` / `... (X4).epub`. +- The signed-in issue view is built in `src/web/issue.rs`: `IssueView` (line ~33) carries `downloads: Vec`, assembled around line 258 from the `issues` row (`row.epub_path`, `row.x4_path`, `row.xtc_path`). The template renders them at `src/web/templates/issue_full.html:6` as `Download …`. +- Signed-in issue routes live in the `full_issues` router in `src/web/mod.rs` (~line 659: `/issues/{date}/articles/{article_id}`, `/issues/{date}/world`, `/issues/{date}/behind`, behind `login_required!` and `map_forbidden`); public routes (`/issues`, `/issues/{date}`) are on the root router ~line 682. Put the new route in **`full_issues`**. +- `issues` table (`migrations/0001_init.sql:70`): `date TEXT PK, issue_number, generated_at, epub_path, x4_path, xtc_path, front_page_html, report_json` (+ `issue_json` added later). Migrations run via `sqlx::migrate!("./migrations")` (`src/db.rs:24`); latest file is `0004_web.sql`, so the new one is `0005_bookorbit.sql`. `Db::issue_by_date(date) -> Option` is at `src/db.rs:537`; `upsert_issue` at `:496` (do not touch it, ids are resolved lazily, see §3). +- Config: sections are `#[serde(deny_unknown_fields, default)]` structs hung off `Config` (`src/config.rs:82–85`, e.g. `pub server: ServerConfig`), with `Default` impls. Env overrides are `DAILY_EPUB_
__`. `config.example.toml` documents every key; the README has a configuration table (~line 350). +- The settings dashboard (`src/web/dashboard/settings.rs`) has a **hardcoded section registry** (`const` list around line 248–259 ending `"publish", "xtc", "server", "miniflux"`), a secret-field list (`("server.basic_auth_pass", FieldKind::Secret)` ~line 219, plus `SECRET_SUFFIXES` at ~223), per-key help text (~line 360), and a test asserting the section list (~line 1683). A new section must be added to all of these or the settings page/test breaks. +- Shared HTTP client: `crate::http::build_client(timeout)` (`src/http.rs:14`), rustls + gzip, no cookies. reqwest 0.13 with the `query` and `json` features is already a dependency; **no XML parser is in the tree** — the OPDS response is tiny and regular, so either add `quick-xml` or match with a small hand parser (see §4). + +### About BookOrbit + +- Web reader route (client router, `client/src/router/index.ts`): **`/read/:bookId/:fileId`**. Both ids are required numeric integers. Book detail page is `/book/:bookId`. +- An unauthenticated visit to `/read/...` serves the SPA shell (200) and the client auth guard redirects to `/login?redirect=`, returning to the reader after sign-in. So the link can point straight at the reader. +- OPDS (server `server/src/modules/opds/opds.service.ts`, `BASE = '/api/v1/opds'`): + - Auth is **HTTP Basic** against a dedicated *OPDS user* created in BookOrbit's settings (separate static credentials, not the web login). Verified live: `GET http://127.0.0.1:3498/api/v1/opds/catalog?q=Daily` → `401`, `www-authenticate: Basic realm="bookorbit OPDS"`. + - Search: `GET /api/v1/opds/catalog?q=` (Atom acquisition feed; server-side `ILIKE` on title, accent-insensitive). Paged with `?page=N`. + - Each `` contains `…`, `urn:bookorbit:book:`, and one acquisition link per file: + ``. + **That href carries both numbers the reader URL needs.** Each daily issue edition is its own book with a single EPUB file. +- The JSON API (`/api/v1/books/search?q=`, `/api/v1/books/:id` with `files[].id`) exists too but needs a JWT from `/auth/login` (5/min throttle, refresh cookie). Not worth it; OPDS is enough. +- Book titles come from the EPUB `dc:title`, so the Standard edition is titled `The Daily EPUB — 2026-09-05` and the X4 one `The Daily EPUB — 2026-09-05 (X4)`. *Assumption:* BookOrbit's metadata fetcher has not renamed them; the matcher in §4 tolerates a fallback to the filename form. + +## 3. Design decisions (settled) + +| Topic | Decision | Why | +|---|---|---| +| Where ids are resolved | **Lazily, on click**, by a new redirect route `GET /issues/{date}/read` in the signed-in router. | BookOrbit indexes the folder some time after the run ends, so the id does not exist at publish time. Rendering the issue page must stay free of cross-service calls (see perf work in `main` 17a8804 and earlier). | +| Caching | Two nullable columns on `issues`: `bookorbit_book_id INTEGER`, `bookorbit_file_id INTEGER`. Filled on first successful lookup; later clicks redirect from the cache with no network call. | One OPDS call per issue, ever. | +| Stale cache | If BookOrbit answers the *reader page*, we can't tell from a redirect. Instead: `GET /issues/{date}/read?refresh=1` clears the cached ids and re-resolves. Expose it as a tiny "wrong book?" link only if trivial; otherwise document the query param in the README. | Books can be deleted/re-added in BookOrbit, changing ids. | +| Not indexed yet | Route returns **503** with the existing error template (`src/web/templates/error.html`), message "BookOrbit has not indexed this issue yet. Try again in a minute." Nothing cached. | Honest, cheap, retry-friendly. | +| Which edition | Standard only. The entry whose `` equals `issue.title_for(Edition::Standard)` **exactly**; entries ending in ` (X4)` are never chosen. | The whole point is desktop reading. | +| Auth to BookOrbit | HTTP Basic with an OPDS user's credentials from config. | Static creds, no token lifecycle; same mechanism KOReader already uses. | +| Feature flag | Whole feature off unless `[bookorbit] enabled = true` **and** the three credentials/URL keys are set. Button and route are absent when off. | Repo stays usable without BookOrbit, as today. | +| Link target | `<public_url>/read/<bookId>/<fileId>`, `public_url` from config (`https://bookorbit.hallada.net`), opened with `target="_blank" rel="noopener"`. | BookOrbit's own login redirect handles the signed-out case. | + +## 4. Implementation steps + +1. **Config** (`src/config.rs`, `config.example.toml`, README table): + ```toml + [bookorbit] + enabled = false + public_url = "https://bookorbit.hallada.net" # what the browser opens + api_url = "http://127.0.0.1:3498" # where the server talks OPDS; same host + opds_user = "" # an OPDS user from BookOrbit → Settings → OPDS + # opds_pass: environment only (DAILY_EPUB_BOOKORBIT__OPDS_PASS) + ``` + `BookorbitConfig { enabled: bool, public_url: String, api_url: String, opds_user: Option<String>, opds_pass: Option<String> }` with `deny_unknown_fields, default`. Add `pub bookorbit: BookorbitConfig` to `Config` and its `Default`. Add a `fn is_active(&self) -> bool` (enabled + user + pass non-empty). Validate URLs have no trailing slash (or trim). + +2. **Settings dashboard** (`src/web/dashboard/settings.rs`): add `"bookorbit"` to the section list, `("bookorbit.opds_pass", FieldKind::Secret)` (and `"opds_pass"` to `SECRET_SUFFIXES`), help text for the five keys, update the section-list test. Copy the pattern used for `server.basic_auth_pass`. + +3. **Migration** `migrations/0005_bookorbit.sql`: + ```sql + ALTER TABLE issues ADD COLUMN bookorbit_book_id INTEGER; + ALTER TABLE issues ADD COLUMN bookorbit_file_id INTEGER; + ``` + Extend `IssueRow` and `issue_by_date`'s `SELECT` with the two columns; add `Db::set_bookorbit_ids(date, Option<(i64, i64)>)` (`None` clears). + +4. **OPDS client** — new module `src/bookorbit.rs` (~100 lines): + - `pub async fn find_issue(client: &reqwest::Client, cfg: &BookorbitConfig, issue_title: &str, date: Date) -> Result<Option<(i64, i64)>>`. + - `GET {api_url}/api/v1/opds/catalog?q={date}` with `.basic_auth(user, Some(pass))` and `Accept: application/atom+xml`. Searching by the ISO date string avoids em-dash/hyphen and ILIKE-escaping questions, and returns at most the two editions. + - Parse entries: split on `<entry>`…`</entry>`, take `<title>` (XML-unescape `&` etc.), and the first acquisition `href` matching `^/api/v1/opds/(\d+)/download\?fileId=(\d+)$`. Choose the entry whose title equals `issue_title` exactly; if none, accept the title equal to the filename stem `The Daily EPUB - <date>` (hyphen form); never accept a title ending in `(X4)`. Prefer `quick-xml` if you'd rather not hand-roll; either is fine, keep it small and unit-tested against a fixture built from the real XML shape in §2. + - Map `401/403` to a clear error ("BookOrbit rejected the OPDS credentials"), connection errors to "BookOrbit unreachable". Timeout 5 s via `http::build_client`. + - Log at `info` on first resolution with both ids. + +5. **Route** `GET /issues/{date}/read` (`src/web/issue.rs`, registered in `src/web/mod.rs` next to `/issues/{date}/behind`, same session guard as the other signed-in issue routes): + - 404 if the feature is inactive or the issue row is missing. + - If `refresh=1`, clear cached ids first. + - Cached ids → `303 See Other` to `{public_url}/read/{book}/{file}`. + - Else call `bookorbit::find_issue`; on `Some`, store and redirect; on `None`, 503 with the "not indexed yet" message; on `Err`, 502 with the error text (operator-only page, so the text can be specific). + - Hold a `reqwest::Client` in `WebState` (`src/web/mod.rs:144`) or build one per call; per-call is acceptable at this frequency. + +6. **Template**: add `read_href: Option<String>` to `IssueView` (set to `/issues/{date}/read` when the feature is active and `row.epub_path` is present, i.e. only alongside a real Standard EPUB). In `issue_full.html:6`, render `<a class="btn" href="{{ href }}" target="_blank" rel="noopener">Read in BookOrbit</a>` **before** the download buttons, inside the same flex row, and keep the row visible when it is the only button. + +7. **Tests**: unit tests for the XML matcher (exact title, X4 skipped, hyphen fallback, no match, malformed href); a `src/web` test that the route is 404 when inactive and 303 to the right URL when ids are cached (no network). Follow `downloads_are_listed_only_while_the_files_exist` (`src/web/issue.rs:~2059`) for the fixture style. + +8. **Docs/ops**: README configuration table rows for `[bookorbit]`; a note under Delivery: create an OPDS user in BookOrbit (Settings → OPDS), put its name in `config.toml` and the password in `/etc/daily-epub/env` as `DAILY_EPUB_BOOKORBIT__OPDS_PASS`, restart `daily-epub.service`. No systemd change is needed: `systemd/daily-epub.service` sets only `RestrictAddressFamilies=AF_INET AF_INET6 AF_UNIX` and no `IPAddressDeny`, so loopback HTTP to port 3498 is allowed. + +## 5. Acceptance + +- With the section absent or `enabled = false`: no button, `/issues/<date>/read` → 404, all existing tests pass. +- With valid OPDS credentials: first click on today's issue → 303 to `https://bookorbit.hallada.net/read/<n>/<m>` and the `issues` row now has both ids; second click makes no request to BookOrbit (check the journal). +- Clicking before BookOrbit has scanned the new file → 503 "not indexed yet", nothing cached, later click succeeds. +- The X4 edition is never the target even though it matches the same search. +- `cargo fmt`, `cargo clippy`, `cargo test` clean. diff --git a/src/types.rs b/src/types.rs index e2ca0b6..5d0df8d 100644 --- a/src/types.rs +++ b/src/types.rs @@ -526,10 +526,17 @@ pub struct IssueMeta { pub reading_minutes: i64, } +/// The issue name for a date, without an edition tag: +/// "The Daily EPUB — 2026-08-15". Shared by [`IssueMeta::title`] and callers +/// that only have a date (the BookOrbit lookup matches OPDS titles against it). +pub fn issue_title(date: Date) -> String { + format!("The Daily EPUB — {date}") +} + impl IssueMeta { /// The issue's name, without an edition tag: "The Daily EPUB — 2026-08-15". pub fn title(&self) -> String { - format!("The Daily EPUB — {}", self.date) + issue_title(self.date) } /// `dc:title` for one edition: [`title`](Self::title) plus the edition tag diff --git a/src/web/issue.rs b/src/web/issue.rs index b33683d..de91834 100644 --- a/src/web/issue.rs +++ b/src/web/issue.rs @@ -1,13 +1,15 @@ use std::collections::{BTreeMap, HashMap, HashSet}; use std::io::Read; use std::path::{Path as FsPath, PathBuf}; +use std::time::Duration; use anyhow::Context; use askama::Template; -use axum::extract::{Extension, Path, State}; -use axum::response::{IntoResponse, Response}; +use axum::extract::{Extension, Path, Query, State}; +use axum::response::{IntoResponse, Redirect, Response}; use axum_login::tower_sessions::Session; use jiff::civil::Date; +use serde::Deserialize; use sqlx::Row; use crate::db::Db; @@ -32,6 +34,8 @@ pub struct Download { #[derive(Debug, Clone)] pub struct IssueView { pub issue: Issue, + /// Signed-in BookOrbit redirect route when the Standard EPUB can be downloaded. + pub read_href: Option<String>, pub downloads: Vec<Download>, pub from_json: bool, pub world_html: Option<String>, @@ -255,18 +259,21 @@ pub async fn load( } else { recover_world_html(&row, config) }; - let downloads = [ - ( - "EPUB", - row.epub_path.as_deref(), - Some(config.publish.epub_dir.join(crate::publish::issue_filename( - date, - Edition::Standard, - "epub", - ))), + let standard_download = download( + "EPUB", + row.epub_path.as_deref(), + Some(config.publish.epub_dir.join(crate::publish::issue_filename( + date, + Edition::Standard, "epub", - ), - ( + ))), + "epub", + ); + let read_href = (config.bookorbit.is_active() && standard_download.is_some()) + .then(|| format!("/issues/{date}/read")); + let downloads = [ + standard_download, + download( "X4 EPUB", row.x4_path.as_deref(), Some(config.publish.epub_dir.join(crate::publish::issue_filename( @@ -276,13 +283,14 @@ pub async fn load( ))), "epub", ), - ("XTC", row.xtc_path.as_deref(), None, "xtc"), + download("XTC", row.xtc_path.as_deref(), None, "xtc"), ] .into_iter() - .filter_map(|(label, raw, fallback, kind)| download(label, raw, fallback, kind)) + .flatten() .collect(); Ok(Some(IssueView { issue, + read_href, downloads, from_json, world_html, @@ -881,6 +889,7 @@ struct IssueFullTemplate { issue_number: i64, stats_line: String, front_page_html: String, + read_href: Option<String>, downloads: Vec<Download>, sections: Vec<FullSection>, has_world: bool, @@ -1003,6 +1012,7 @@ pub async fn render_full( issue_number: view.issue.meta.issue_number, stats_line: view.issue.meta.stats_line(), front_page_html: view.issue.editorial.front_page_html.clone(), + read_href: view.read_href, downloads: view.downloads, sections, has_world: view.issue.world_briefing.is_some() || view.world_html.is_some(), @@ -1186,6 +1196,96 @@ pub async fn behind( .into_response()) } +/// Query parameters accepted by the BookOrbit reader redirect. +#[derive(Debug, Default, Deserialize)] +pub struct ReadQuery { + #[serde(default)] + refresh: Option<String>, +} + +/// Open the Standard edition of an issue in BookOrbit's browser reader. +pub async fn read( + State(state): State<AppState>, + auth: AuthSession, + Path(date): Path<Date>, + Query(query): Query<ReadQuery>, +) -> Result<Response, WebError> { + let _viewer = auth + .user() + .await + .map(Viewer::from) + .ok_or_else(|| WebError::Unauthenticated { + next: format!("/issues/{date}/read"), + })?; + let config = state.config(); + if !config.bookorbit.is_active() { + return Err(WebError::NotFound); + } + let Some(row) = state.db.issue_by_date(date).await? else { + return Err(WebError::NotFound); + }; + let refresh = query.refresh.as_deref() == Some("1"); + if refresh { + state.db.set_bookorbit_ids(date, None).await?; + } else if let (Some(book_id), Some(file_id)) = (row.bookorbit_book_id, row.bookorbit_file_id) { + let ids = crate::bookorbit::BookorbitIds { book_id, file_id }; + return Ok(Redirect::to(&crate::bookorbit::reader_url( + config.bookorbit.public_url(), + ids, + )) + .into_response()); + } + + let client = crate::http::build_client(Duration::from_secs(5)) + .map_err(|error| WebError::BadGateway(format!("BookOrbit error: {error}")))?; + let opds_user = config + .bookorbit + .opds_user + .as_deref() + .ok_or(WebError::NotFound)?; + let opds_pass = config + .bookorbit + .opds_pass + .as_deref() + .ok_or(WebError::NotFound)?; + let issue_title = crate::types::issue_title(date); + match crate::bookorbit::find_issue( + &client, + config.bookorbit.api_url(), + opds_user, + opds_pass, + &issue_title, + date, + ) + .await + { + Ok(Some(ids)) => { + state + .db + .set_bookorbit_ids(date, Some((ids.book_id, ids.file_id))) + .await?; + tracing::info!( + %date, + book_id = ids.book_id, + file_id = ids.file_id, + "cached BookOrbit issue ids" + ); + Ok(Redirect::to(&crate::bookorbit::reader_url( + config.bookorbit.public_url(), + ids, + )) + .into_response()) + } + Ok(None) => Err(WebError::ServiceUnavailable( + "BookOrbit has not indexed this issue yet. Try again in a minute.".to_string(), + )), + Err(error) => { + tracing::warn!(%date, %error, "BookOrbit issue lookup failed"); + Err(WebError::BadGateway(error.to_string())) + } + } +} + fn article_href(date: Date, article_id: ArticleId) -> String { format!("/issues/{date}/articles/{article_id}") } @@ -2091,6 +2191,214 @@ mod tests { assert!(!issue.contains("Download XTC")); } + #[tokio::test] + async fn bookorbit_read_is_hidden_and_not_found_when_inactive() { + let (_dir, db, source) = seeded_issue(false).await; + crate::web::users::add(&db, "reader", "correct horse battery", false) + .await + .unwrap(); + let app = crate::server::router(crate::server::AppState::new( + db, + crate::config::Config::default(), + None, + )); + let cookie = login_cookie(&app, "reader", "correct horse battery").await; + + let issue = app + .clone() + .oneshot( + Request::builder() + .uri(format!("/issues/{}", source.meta.date)) + .header(header::COOKIE, &cookie) + .body(Body::empty()) + .unwrap(), + ) + .await + .unwrap(); + let issue = response_text(issue).await; + assert!(issue.contains("Download EPUB")); + assert!(!issue.contains("Read in BookOrbit")); + + let read = app + .oneshot( + Request::builder() + .uri(format!("/issues/{}/read", source.meta.date)) + .header(header::COOKIE, cookie) + .body(Body::empty()) + .unwrap(), + ) + .await + .unwrap(); + assert_eq!(read.status(), StatusCode::NOT_FOUND); + } + + #[tokio::test] + async fn bookorbit_read_button_and_cached_redirect_use_the_public_url() { + let (dir, db, source) = seeded_issue(true).await; + crate::web::users::add(&db, "reader", "correct horse battery", false) + .await + .unwrap(); + let epub_dir = dir.path().join("epubs"); + std::fs::create_dir(&epub_dir).unwrap(); + std::fs::write( + epub_dir.join(crate::publish::issue_filename( + source.meta.date, + Edition::Standard, + "epub", + )), + b"standard epub", + ) + .unwrap(); + db.set_bookorbit_ids(source.meta.date, Some((12, 34))) + .await + .unwrap(); + + let mut config = crate::config::Config::default(); + config.publish.epub_dir = epub_dir.clone(); + config.bookorbit.enabled = true; + config.bookorbit.opds_user = Some("reader".into()); + config.bookorbit.opds_pass = Some("secret".into()); + config.bookorbit.api_url = "http://127.0.0.1:9".into(); + let app = crate::server::router(crate::server::AppState::new( + db.clone(), + config.clone(), + None, + )); + let cookie = login_cookie(&app, "reader", "correct horse battery").await; + + let issue = app + .clone() + .oneshot( + Request::builder() + .uri(format!("/issues/{}", source.meta.date)) + .header(header::COOKIE, &cookie) + .body(Body::empty()) + .unwrap(), + ) + .await + .unwrap(); + let issue = response_text(issue).await; + assert!(issue.contains("Read in BookOrbit")); + assert!(issue.contains(&format!("href=\"/issues/{}/read\"", source.meta.date))); + + let read = app + .oneshot( + Request::builder() + .uri(format!("/issues/{}/read", source.meta.date)) + .header(header::COOKIE, cookie) + .body(Body::empty()) + .unwrap(), + ) + .await + .unwrap(); + assert_eq!(read.status(), StatusCode::SEE_OTHER); + assert_eq!( + read.headers().get(header::LOCATION).unwrap(), + "https://bookorbit.hallada.net/read/12/34" + ); + + config.bookorbit.public_url = "https://example.test/".into(); + let app = crate::server::router(crate::server::AppState::new(db, config, None)); + let cookie = login_cookie(&app, "reader", "correct horse battery").await; + let read = app + .oneshot( + Request::builder() + .uri(format!("/issues/{}/read", source.meta.date)) + .header(header::COOKIE, cookie) + .body(Body::empty()) + .unwrap(), + ) + .await + .unwrap(); + assert_eq!(read.status(), StatusCode::SEE_OTHER); + assert_eq!( + read.headers().get(header::LOCATION).unwrap(), + "https://example.test/read/12/34" + ); + } + + #[tokio::test] + async fn bookorbit_read_button_is_hidden_without_the_standard_epub() { + let (dir, db, source) = seeded_issue(true).await; + crate::web::users::add(&db, "reader", "correct horse battery", false) + .await + .unwrap(); + let mut config = crate::config::Config::default(); + config.publish.epub_dir = dir.path().join("missing-epubs"); + config.bookorbit.enabled = true; + config.bookorbit.opds_user = Some("reader".into()); + config.bookorbit.opds_pass = Some("secret".into()); + let app = crate::server::router(crate::server::AppState::new(db, config, None)); + let cookie = login_cookie(&app, "reader", "correct horse battery").await; + + let issue = app + .oneshot( + Request::builder() + .uri(format!("/issues/{}", source.meta.date)) + .header(header::COOKIE, cookie) + .body(Body::empty()) + .unwrap(), + ) + .await + .unwrap(); + let issue = response_text(issue).await; + assert!(!issue.contains("Read in BookOrbit")); + assert!(!issue.contains(&format!("href=\"/issues/{}/read\"", source.meta.date))); + } + + #[tokio::test] + async fn bookorbit_read_reports_upstream_connection_errors() { + let (_dir, db, source) = seeded_issue(true).await; + crate::web::users::add(&db, "reader", "correct horse battery", false) + .await + .unwrap(); + let mut config = crate::config::Config::default(); + config.bookorbit.enabled = true; + config.bookorbit.opds_user = Some("reader".into()); + config.bookorbit.opds_pass = Some("secret".into()); + config.bookorbit.api_url = "http://127.0.0.1:9".into(); + let app = crate::server::router(crate::server::AppState::new(db, config, None)); + let cookie = login_cookie(&app, "reader", "correct horse battery").await; + + let read = app + .oneshot( + Request::builder() + .uri(format!("/issues/{}/read", source.meta.date)) + .header(header::COOKIE, cookie) + .body(Body::empty()) + .unwrap(), + ) + .await + .unwrap(); + assert_eq!(read.status(), StatusCode::BAD_GATEWAY); + assert!(response_text(read).await.contains("BookOrbit")); + } + + #[tokio::test] + async fn anonymous_bookorbit_read_redirects_to_login() { + let (_dir, db, source) = seeded_issue(true).await; + let mut config = crate::config::Config::default(); + config.bookorbit.enabled = true; + config.bookorbit.opds_user = Some("reader".into()); + config.bookorbit.opds_pass = Some("secret".into()); + let app = crate::server::router(crate::server::AppState::new(db, config, None)); + + let read = app + .oneshot( + Request::builder() + .uri(format!("/issues/{}/read", source.meta.date)) + .body(Body::empty()) + .unwrap(), + ) + .await + .unwrap(); + assert_eq!(read.status(), StatusCode::FOUND); + assert_eq!( + read.headers().get(header::LOCATION).unwrap(), + format!("/login?next=%2Fissues%2F{}%2Fread", source.meta.date).as_str() + ); + } + #[test] fn file_sizes_are_human_readable() { assert_eq!(format_file_size(42), "42 B"); diff --git a/src/web/mod.rs b/src/web/mod.rs index 9daf497..add7d8b 100644 --- a/src/web/mod.rs +++ b/src/web/mod.rs @@ -456,6 +456,12 @@ pub enum WebError { Unauthenticated { next: String }, #[error("bad request: {0}")] BadRequest(String), + /// BookOrbit has not indexed the requested issue yet. + #[error("service unavailable: {0}")] + ServiceUnavailable(String), + /// A BookOrbit OPDS request failed. + #[error("bad gateway: {0}")] + BadGateway(String), #[error("request origin did not match this site")] Csrf, #[error(transparent)] @@ -511,6 +517,14 @@ impl IntoResponse for WebError { Self::BadRequest(ref message) => { (StatusCode::BAD_REQUEST, "Bad request", message.as_str()) } + Self::ServiceUnavailable(ref message) => ( + StatusCode::SERVICE_UNAVAILABLE, + "Not indexed yet", + message.as_str(), + ), + Self::BadGateway(ref message) => { + (StatusCode::BAD_GATEWAY, "BookOrbit error", message.as_str()) + } Self::Db(ref error) => { tracing::error!(%error, "web database request failed"); ( @@ -660,6 +674,7 @@ pub fn router(config: &crate::config::Config) -> axum::Router<crate::server::App .route("/issues/{date}/articles/{article_id}", get(issue::article)) .route("/issues/{date}/world", get(issue::world)) .route("/issues/{date}/behind", get(issue::behind)) + .route("/issues/{date}/read", get(issue::read)) .route_layer(login_required!( session::Backend, login_url = "/login", diff --git a/src/web/templates/issue_full.html b/src/web/templates/issue_full.html index 33d2d12..0f72e9f 100644 --- a/src/web/templates/issue_full.html +++ b/src/web/templates/issue_full.html @@ -3,7 +3,7 @@ <article class="reader-page mx-auto mt-10 w-full max-w-[68ch] px-4 sm:px-6 lg:mt-12 lg:px-0"> <header class="mb-8 text-center"><p class="font-sans text-[0.72rem] uppercase tracking-[0.12em] text-muted">{{ display_date }} · No. {{ issue_number }}</p><p class="mt-2 font-sans text-sm text-muted">{{ stats_line }}</p></header> <section aria-labelledby="brief-heading" data-toc-entry="/issues/{{ date }}"><h1 id="brief-heading" class="reader-section-heading">The Brief</h1><div class="editorial prose-body mt-5 [&>p:first-child]:first-letter:float-left [&>p:first-child]:first-letter:mr-2 [&>p:first-child]:first-letter:mt-1 [&>p:first-child]:first-letter:font-serif [&>p:first-child]:first-letter:text-[4.6rem] [&>p:first-child]:first-letter:font-semibold [&>p:first-child]:first-letter:leading-[0.72]">{{ front_page_html|safe }}</div></section> - {% if !downloads.is_empty() %}<div class="my-8 flex flex-wrap gap-2 border-y border-rule py-4">{% for download in downloads %}<a class="btn" href="{{ download.href }}">Download {{ download.label }} <span class="ml-1 text-muted">{{ download.size }}</span></a>{% endfor %}</div>{% endif %} + {% if read_href.is_some() || !downloads.is_empty() %}<div class="my-8 flex flex-wrap gap-2 border-y border-rule py-4">{% match read_href %}{% when Some with (href) %}<a class="btn" href="{{ href }}" target="_blank" rel="noopener">Read in BookOrbit</a>{% when None %}{% endmatch %}{% for download in downloads %}<a class="btn" href="{{ download.href }}">Download {{ download.label }} <span class="ml-1 text-muted">{{ download.size }}</span></a>{% endfor %}</div>{% endif %} <section class="mt-12" aria-labelledby="index-heading"><h2 id="index-heading" class="text-center text-3xl font-semibold leading-[1.1] tracking-[-0.01em]">In This Issue</h2> {% for section in sections %}<section class="mt-14"><h3 class="reader-section-heading">{{ section.name }}</h3><ul class="m-0 list-none p-0">{% for entry in section.entries %}<li class="border-b border-rule py-6" data-toc-entry="{{ entry.href }}"><h4 class="font-serif font-semibold leading-[1.1] tracking-[-0.01em] {% if entry.is_lead %}text-3xl{% else %}text-2xl{% endif %}"><a class="text-ink no-underline hover:text-accent" href="{{ entry.href }}">{{ entry.title }}</a></h4><p class="mt-2 font-sans text-sm text-muted">{{ entry.source }} · {{ entry.reading_minutes }} min read</p>{% if !entry.summary.is_empty() %}<p class="index-summary mt-4">{{ entry.summary }}</p>{% endif %}{% match entry.why %}{% when Some with (why) %}<p class="mt-4 border-l-2 border-accent pl-3 italic text-ink-2">Why it's here: {{ why }}</p>{% when None %}{% endmatch %}{% match entry.rating %}{% when Some with (widget) %}{% include "_rating_widget.html" %}{% when None %}{% endmatch %}</li>{% endfor %}</ul></section>{% endfor %} </section>