mirror of
https://git.pumpin.online/funkpower/catena.git
synced 2026-11-13 23:55:40 +00:00
Compare commits
19
Commits
fixes-040-epub
...
v0.5.0
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2d885b5afc | ||
|
|
99f4f198af | ||
|
|
038b0c70ba | ||
|
|
6b5d9c20ee | ||
|
|
dd41a93c9b | ||
|
|
e9f9e75c1d | ||
|
|
65fd4adaad | ||
|
|
58573399e7 | ||
|
|
d06e13e2f3 | ||
|
|
8ecc4766ee | ||
|
|
3bd3ea11ae | ||
|
|
b7feefb704 | ||
|
|
f43b9d4900 | ||
|
|
6844f10e0e | ||
|
|
4aae5b6ac0 | ||
|
|
3fd48d4999 | ||
|
|
48478fe84e | ||
|
|
5f2a471f58 | ||
|
|
bd104834ed |
No files matched your search
Generated
+26
-26
@@ -101,7 +101,7 @@ checksum = "f2032f911046de80f0a198e0901378627c33f59ea0ac00e363d481118bd70a53"
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "avplan"
|
name = "avplan"
|
||||||
version = "0.3.1"
|
version = "0.5.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"catena-cli",
|
"catena-cli",
|
||||||
"clap",
|
"clap",
|
||||||
@@ -126,7 +126,7 @@ checksum = "ac07cdecf99051d9a5238b80f35af32cdeba5b336e55d957b318b50137e18da5"
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "bibclean"
|
name = "bibclean"
|
||||||
version = "0.3.1"
|
version = "0.5.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"catena-cli",
|
"catena-cli",
|
||||||
"clap",
|
"clap",
|
||||||
@@ -143,7 +143,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "bibfetch"
|
name = "bibfetch"
|
||||||
version = "0.3.1"
|
version = "0.5.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"catena-cli",
|
"catena-cli",
|
||||||
"clap",
|
"clap",
|
||||||
@@ -196,7 +196,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "bookmeta"
|
name = "bookmeta"
|
||||||
version = "0.3.1"
|
version = "0.5.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"catena-cli",
|
"catena-cli",
|
||||||
"clap",
|
"clap",
|
||||||
@@ -210,7 +210,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "booksniff"
|
name = "booksniff"
|
||||||
version = "0.3.1"
|
version = "0.5.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"catena-cli",
|
"catena-cli",
|
||||||
"clap",
|
"clap",
|
||||||
@@ -250,7 +250,7 @@ checksum = "fc652a48c352aef3ea3aed32080501cf3ef6ed5da78602a020c991775b0aff04"
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "catena"
|
name = "catena"
|
||||||
version = "0.3.1"
|
version = "0.5.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"bibclean",
|
"bibclean",
|
||||||
"bibfetch",
|
"bibfetch",
|
||||||
@@ -277,7 +277,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "catena-cli"
|
name = "catena-cli"
|
||||||
version = "0.3.1"
|
version = "0.5.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"clap",
|
"clap",
|
||||||
"clap_mangen",
|
"clap_mangen",
|
||||||
@@ -312,7 +312,7 @@ checksum = "4e7648175b45a9a48536d676f68d918270699102aa8dab5496df06904c914600"
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "chunkmd"
|
name = "chunkmd"
|
||||||
version = "0.3.1"
|
version = "0.5.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"catena-cli",
|
"catena-cli",
|
||||||
"clap",
|
"clap",
|
||||||
@@ -334,7 +334,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "citefind"
|
name = "citefind"
|
||||||
version = "0.3.1"
|
version = "0.5.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"catena-cli",
|
"catena-cli",
|
||||||
"chunkmd",
|
"chunkmd",
|
||||||
@@ -399,7 +399,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "colophon"
|
name = "colophon"
|
||||||
version = "0.3.1"
|
version = "0.5.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"bibclean",
|
"bibclean",
|
||||||
"catena-cli",
|
"catena-cli",
|
||||||
@@ -448,7 +448,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "corpus-core"
|
name = "corpus-core"
|
||||||
version = "0.3.1"
|
version = "0.5.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"schemars",
|
"schemars",
|
||||||
"serde",
|
"serde",
|
||||||
@@ -492,7 +492,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "cuekit"
|
name = "cuekit"
|
||||||
version = "0.3.1"
|
version = "0.5.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"corpus-core",
|
"corpus-core",
|
||||||
"regex",
|
"regex",
|
||||||
@@ -504,7 +504,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "cuenorm"
|
name = "cuenorm"
|
||||||
version = "0.3.1"
|
version = "0.5.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"catena-cli",
|
"catena-cli",
|
||||||
"clap",
|
"clap",
|
||||||
@@ -514,7 +514,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "cuepack"
|
name = "cuepack"
|
||||||
version = "0.3.1"
|
version = "0.5.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"catena-cli",
|
"catena-cli",
|
||||||
"clap",
|
"clap",
|
||||||
@@ -525,7 +525,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "cueseg"
|
name = "cueseg"
|
||||||
version = "0.3.1"
|
version = "0.5.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"catena-cli",
|
"catena-cli",
|
||||||
"clap",
|
"clap",
|
||||||
@@ -612,7 +612,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "emb"
|
name = "emb"
|
||||||
version = "0.3.1"
|
version = "0.5.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"catena-cli",
|
"catena-cli",
|
||||||
"clap",
|
"clap",
|
||||||
@@ -876,7 +876,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "idnorm"
|
name = "idnorm"
|
||||||
version = "0.3.1"
|
version = "0.5.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"bibclean",
|
"bibclean",
|
||||||
"catena-cli",
|
"catena-cli",
|
||||||
@@ -942,7 +942,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "langid"
|
name = "langid"
|
||||||
version = "0.3.1"
|
version = "0.5.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"catena-cli",
|
"catena-cli",
|
||||||
"clap",
|
"clap",
|
||||||
@@ -1022,7 +1022,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "mdscrub"
|
name = "mdscrub"
|
||||||
version = "0.3.1"
|
version = "0.5.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"catena-cli",
|
"catena-cli",
|
||||||
"clap",
|
"clap",
|
||||||
@@ -1034,7 +1034,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "mdsplit"
|
name = "mdsplit"
|
||||||
version = "0.3.1"
|
version = "0.5.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"catena-cli",
|
"catena-cli",
|
||||||
"clap",
|
"clap",
|
||||||
@@ -1113,7 +1113,7 @@ checksum = "384b8ab6d37215f3c5301a95a4accb5d64aa607f1fcb26a11b5303878451b4fe"
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "pdfgutter"
|
name = "pdfgutter"
|
||||||
version = "0.3.1"
|
version = "0.5.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"catena-cli",
|
"catena-cli",
|
||||||
"clap",
|
"clap",
|
||||||
@@ -1126,7 +1126,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "pdftriage"
|
name = "pdftriage"
|
||||||
version = "0.3.1"
|
version = "0.5.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"catena-cli",
|
"catena-cli",
|
||||||
"clap",
|
"clap",
|
||||||
@@ -1370,7 +1370,7 @@ checksum = "323c417e1d9665a65b263ec744ba09030cfb277e9daa0b018a4ab62e57bc8189"
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "rrf"
|
name = "rrf"
|
||||||
version = "0.3.1"
|
version = "0.5.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"catena-cli",
|
"catena-cli",
|
||||||
"clap",
|
"clap",
|
||||||
@@ -1517,7 +1517,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "seriesof"
|
name = "seriesof"
|
||||||
version = "0.3.1"
|
version = "0.5.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"catena-cli",
|
"catena-cli",
|
||||||
"clap",
|
"clap",
|
||||||
@@ -1634,7 +1634,7 @@ checksum = "adb6935a6f5c20170eeceb1a3835a49e12e19d792f6dd344ccc76a985ca5a6ca"
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "textkit"
|
name = "textkit"
|
||||||
version = "0.3.1"
|
version = "0.5.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"regex",
|
"regex",
|
||||||
"tiktoken-rs",
|
"tiktoken-rs",
|
||||||
@@ -1724,7 +1724,7 @@ checksum = "fd3ca314f692efd6c868f8408f53fe444634a845f96c028b97d35f6a1f79f0ee"
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "tocfind"
|
name = "tocfind"
|
||||||
version = "0.3.1"
|
version = "0.5.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"catena-cli",
|
"catena-cli",
|
||||||
"clap",
|
"clap",
|
||||||
|
|||||||
+27
-27
@@ -3,39 +3,39 @@ resolver = "3"
|
|||||||
members = ["crates/*"]
|
members = ["crates/*"]
|
||||||
|
|
||||||
[workspace.package]
|
[workspace.package]
|
||||||
version = "0.3.1"
|
version = "0.5.0"
|
||||||
edition = "2024"
|
edition = "2024"
|
||||||
rust-version = "1.85"
|
rust-version = "1.85"
|
||||||
license = "MPL-2.0"
|
license = "MPL-2.0"
|
||||||
repository = "https://git.pumpin.online/funkpower/catena"
|
repository = "https://git.pumpin.online/funkpower/catena"
|
||||||
|
|
||||||
[workspace.dependencies]
|
[workspace.dependencies]
|
||||||
catena-cli = { path = "crates/catena-cli", version = "0.3.1" }
|
catena-cli = { path = "crates/catena-cli", version = "0.5.0" }
|
||||||
corpus-core = { path = "crates/corpus-core", version = "0.3.1" }
|
corpus-core = { path = "crates/corpus-core", version = "0.5.0" }
|
||||||
cuekit = { path = "crates/cuekit", version = "0.3.1" }
|
cuekit = { path = "crates/cuekit", version = "0.5.0" }
|
||||||
textkit = { path = "crates/textkit", version = "0.3.1" }
|
textkit = { path = "crates/textkit", version = "0.5.0" }
|
||||||
chunkmd = { path = "crates/chunkmd", version = "0.3.1" }
|
chunkmd = { path = "crates/chunkmd", version = "0.5.0" }
|
||||||
mdscrub = { path = "crates/mdscrub", version = "0.3.1" }
|
mdscrub = { path = "crates/mdscrub", version = "0.5.0" }
|
||||||
mdsplit = { path = "crates/mdsplit", version = "0.3.1" }
|
mdsplit = { path = "crates/mdsplit", version = "0.5.0" }
|
||||||
pdftriage = { path = "crates/pdftriage", version = "0.3.1" }
|
pdftriage = { path = "crates/pdftriage", version = "0.5.0" }
|
||||||
cuenorm = { path = "crates/cuenorm", version = "0.3.1" }
|
cuenorm = { path = "crates/cuenorm", version = "0.5.0" }
|
||||||
cueseg = { path = "crates/cueseg", version = "0.3.1" }
|
cueseg = { path = "crates/cueseg", version = "0.5.0" }
|
||||||
rrf = { path = "crates/rrf", version = "0.3.1" }
|
rrf = { path = "crates/rrf", version = "0.5.0" }
|
||||||
cuepack = { path = "crates/cuepack", version = "0.3.1" }
|
cuepack = { path = "crates/cuepack", version = "0.5.0" }
|
||||||
bibclean = { path = "crates/bibclean", version = "0.3.1" }
|
bibclean = { path = "crates/bibclean", version = "0.5.0" }
|
||||||
avplan = { path = "crates/avplan", version = "0.3.1" }
|
avplan = { path = "crates/avplan", version = "0.5.0" }
|
||||||
pdfgutter = { path = "crates/pdfgutter", version = "0.3.1" }
|
pdfgutter = { path = "crates/pdfgutter", version = "0.5.0" }
|
||||||
catena = { path = "crates/bindings", version = "0.3.1" }
|
catena = { path = "crates/bindings", version = "0.5.0" }
|
||||||
seriesof = { path = "crates/seriesof", version = "0.3.1" }
|
seriesof = { path = "crates/seriesof", version = "0.5.0" }
|
||||||
idnorm = { path = "crates/idnorm", version = "0.3.1" }
|
idnorm = { path = "crates/idnorm", version = "0.5.0" }
|
||||||
bibfetch = { path = "crates/bibfetch", version = "0.3.1" }
|
bibfetch = { path = "crates/bibfetch", version = "0.5.0" }
|
||||||
bookmeta = { path = "crates/bookmeta", version = "0.3.1" }
|
bookmeta = { path = "crates/bookmeta", version = "0.5.0" }
|
||||||
langid = { path = "crates/langid", version = "0.3.1" }
|
langid = { path = "crates/langid", version = "0.5.0" }
|
||||||
tocfind = { path = "crates/tocfind", version = "0.3.1" }
|
tocfind = { path = "crates/tocfind", version = "0.5.0" }
|
||||||
booksniff = { path = "crates/booksniff", version = "0.3.1" }
|
booksniff = { path = "crates/booksniff", version = "0.5.0" }
|
||||||
citefind = { path = "crates/citefind", version = "0.3.1" }
|
citefind = { path = "crates/citefind", version = "0.5.0" }
|
||||||
colophon = { path = "crates/colophon", version = "0.3.1" }
|
colophon = { path = "crates/colophon", version = "0.5.0" }
|
||||||
emb = { path = "crates/emb", version = "0.3.1" }
|
emb = { path = "crates/emb", version = "0.5.0" }
|
||||||
|
|
||||||
clap = { version = "4", features = ["derive"] }
|
clap = { version = "4", features = ["derive"] }
|
||||||
clap_mangen = "0.3"
|
clap_mangen = "0.3"
|
||||||
|
|||||||
+46
-18
@@ -86,7 +86,7 @@ is a failure — nobody replied, and the identifier may be perfectly good.
|
|||||||
|---|---|---|
|
|---|---|---|
|
||||||
| `doi` | Crossref | It assigns most scholarly DOIs |
|
| `doi` | Crossref | It assigns most scholarly DOIs |
|
||||||
| `arxiv` | the arXiv | Its own register of preprints |
|
| `arxiv` | the arXiv | Its own register of preprints |
|
||||||
| `isbn` | OpenLibrary's edition record, then its index, then Google Books | Books, without a key |
|
| `isbn` | OpenLibrary's index, then its edition record, then Google Books | Books, without a key |
|
||||||
|
|
||||||
One register is enough for a DOI or a preprint: the body that assigns the
|
One register is enough for a DOI or a preprint: the body that assigns the
|
||||||
identifier is the only one that has it. A book is different. An ISBN is
|
identifier is the only one that has it. A book is different. An ISBN is
|
||||||
@@ -97,6 +97,14 @@ names them. So the registers are asked in turn and the first complete answer
|
|||||||
wins. An incomplete one is kept in case nothing better comes, and a register
|
wins. An incomplete one is kept in case nothing better comes, and a register
|
||||||
being down is a failure only when every register is.
|
being down is a failure only when every register is.
|
||||||
|
|
||||||
|
OpenLibrary's index answers about the work, not the edition: its publishers,
|
||||||
|
languages, years and page counts are every edition's at once, and the first
|
||||||
|
of each is usually another edition's. So for a book it gives only the title,
|
||||||
|
the authors and the subjects, and the `container`, `language`, `year` and
|
||||||
|
`pages` of a record come from the edition record for that ISBN, or from
|
||||||
|
Google Books when the edition record does not say. A field neither gives is
|
||||||
|
left out rather than filled from the work.
|
||||||
|
|
||||||
Google Books is asked last because it answers anonymous callers only until a
|
Google Books is asked last because it answers anonymous callers only until a
|
||||||
daily quota runs out, after which it replies `429` to everyone sharing the
|
daily quota runs out, after which it replies `429` to everyone sharing the
|
||||||
address.
|
address.
|
||||||
@@ -127,7 +135,8 @@ id is asked only when every form of the ISBN asked was answered with no cover; i
|
|||||||
asking by ISBN failed, that failure is the result.
|
asking by ISBN failed, that failure is the result.
|
||||||
|
|
||||||
What comes back is checked before it is written: a JPEG or PNG by its bytes
|
What comes back is checked before it is written: a JPEG or PNG by its bytes
|
||||||
as well as by what the server says, no larger than ten megabytes, reached in at
|
as well as by what the server says, whole to its end marker (`FF D9` for a
|
||||||
|
JPEG, `IEND` for a PNG), no larger than ten megabytes, reached in at
|
||||||
most three redirects, each over HTTPS to `covers.openlibrary.org`,
|
most three redirects, each over HTTPS to `covers.openlibrary.org`,
|
||||||
`archive.org` or a host under `archive.org`, and never to an address by number.
|
`archive.org` or a host under `archive.org`, and never to an address by number.
|
||||||
One request is made at a time, a `429` or `503` is waited out for as long as
|
One request is made at a time, a `429` or `503` is waited out for as long as
|
||||||
@@ -163,7 +172,7 @@ bytes, the media type and the address asked when there is.
|
|||||||
|
|
||||||
```
|
```
|
||||||
$ bibfetch search --title 'The First World War' --author Howard --limit 2
|
$ bibfetch search --title 'The First World War' --author Howard --limit 2
|
||||||
{"v":1,"id":"9780192853622","kind":"isbn","found":true,"source":"openlibrary","title":"The First World War","authors":["Michael Eliot Howard"],"year":2002,"container":"Oxford University Press","subjects":["World War, 1914-1918"],"language":"eng","pages":154,"cover_id":1123124}
|
{"v":1,"id":"9780192853622","kind":"isbn","found":true,"source":"openlibrary","title":"The First World War","authors":["Michael Eliot Howard"],"year":2002,"container":"Oxford University Press","subjects":["World War, 1914-1918"],"language":"eng","cover_id":1123124}
|
||||||
{"v":1,"id":"9780199205592","kind":"isbn","found":true,"source":"openlibrary","title":"The First World War: A Very Short Introduction","authors":["Michael Howard"],"year":2007,"container":"Oxford University Press","language":"eng","cover_id":14606475}
|
{"v":1,"id":"9780199205592","kind":"isbn","found":true,"source":"openlibrary","title":"The First World War: A Very Short Introduction","authors":["Michael Howard"],"year":2007,"container":"Oxford University Press","language":"eng","cover_id":14606475}
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -172,18 +181,33 @@ title and perhaps a name. This asks which books a register has under those,
|
|||||||
and prints one record per candidate: Open Library's index first, and Google
|
and prints one record per candidate: Open Library's index first, and Google
|
||||||
Books only when Open Library has nothing.
|
Books only when Open Library has nothing.
|
||||||
|
|
||||||
|
Open Library's title search is strict. Given an author as well, it finds
|
||||||
|
nothing for *The Ladder of Divine Ascent* and four editions of *Ladder of
|
||||||
|
Divine Ascent*. So when the title as given finds nothing, the title without a
|
||||||
|
leading "The", "A" or "An" is asked next, and then the title and author as one
|
||||||
|
free-text query. Each is asked only when the one before found nothing, so a
|
||||||
|
title that matches costs one request. The looser questions can bring back
|
||||||
|
books that only share words with the title, which is one more reason the
|
||||||
|
candidates are for the caller to judge.
|
||||||
|
|
||||||
Each candidate is one edition. Open Library's index answers with works, and
|
Each candidate is one edition. Open Library's index answers with works, and
|
||||||
names the edition of each that best matches the search; what belongs to an
|
names the edition of each that best matches the search. The ISBN, publisher,
|
||||||
edition — its ISBN, publisher, language, year and cover — is that edition's,
|
language, year and cover are that edition's and no other's: a field the
|
||||||
and what belongs to the work — the title, the authors, the subjects and the
|
edition does not give is left out rather than filled from the work, whose
|
||||||
length — is the work's. Google Books answers with volumes, which are editions
|
publishers, years and ISBNs belong to all its editions at once. Only the
|
||||||
already.
|
title, the authors and the subjects, which describe the work, are the work's.
|
||||||
|
Open Library's index gives no length for an edition, so its candidates carry
|
||||||
|
no `pages`. Google Books answers with volumes, which are editions already.
|
||||||
|
|
||||||
| Field | When the candidate has an ISBN | When it has none |
|
| Field | When the candidate has an ISBN | When it has none |
|
||||||
|---|---|---|
|
|---|---|---|
|
||||||
| `id` | The first ISBN whose check digit agrees, in thirteen digits; one written in thirteen is taken over one written in ten | The register's own key: an Open Library id such as `OL37863121M` for the edition, or `OL267171W` for the work when no edition was named; a Google Books volume id |
|
| `id` | The first ISBN of the edition whose check digit agrees, in thirteen digits; one written in thirteen is taken over one written in ten | The register's own key: an Open Library id such as `OL37863121M` for the edition, or `OL267171W` for the work when no edition was named; a Google Books volume id |
|
||||||
| `kind` | `isbn` | `olid` for Open Library, `googlebooks` for Google Books |
|
| `kind` | `isbn` | `olid` for Open Library, `googlebooks` for Google Books |
|
||||||
|
|
||||||
|
A work the index names no edition of, or names one it gives neither an ISBN
|
||||||
|
nor a key for, is a candidate named by the work's key, with its title,
|
||||||
|
authors and subjects and nothing an edition would say.
|
||||||
|
|
||||||
An ISBN whose check digit is wrong is passed over rather than corrected, and
|
An ISBN whose check digit is wrong is passed over rather than corrected, and
|
||||||
Google's shelfmarks, typed `OTHER`, are not read as ISBNs even when their
|
Google's shelfmarks, typed `OTHER`, are not read as ISBNs even when their
|
||||||
digits would pass for one. A record of kind `isbn` can be handed straight back
|
digits would pass for one. A record of kind `isbn` can be handed straight back
|
||||||
@@ -194,9 +218,8 @@ to `bibfetch` for everything the registers say about that edition; `olid` and
|
|||||||
Open Library's record of the edition the record names, by that edition's ISBN
|
Open Library's record of the edition the record names, by that edition's ISBN
|
||||||
or its key, so `bibfetch cover --cover-id` fetches that edition's cover and no
|
or its key, so `bibfetch cover --cover-id` fetches that edition's cover and no
|
||||||
other. The cover the index picked for the whole work is never asked for,
|
other. The cover the index picked for the whole work is never asked for,
|
||||||
because it is often another edition's. A work the index names no edition of
|
because it is often another edition's. Google Books knows nothing of Open
|
||||||
gives the first ISBN it lists that reads, which may be any edition's, and no
|
Library's covers and gives none.
|
||||||
cover id; Google Books knows nothing of Open Library's covers and gives none.
|
|
||||||
|
|
||||||
The candidates are what the register said, in the order it said them. This
|
The candidates are what the register said, in the order it said them. This
|
||||||
makes no judgement about which one is the book in hand, and keeps one that is
|
makes no judgement about which one is the book in hand, and keeps one that is
|
||||||
@@ -210,10 +233,14 @@ bibfetch search --title 'Anathem' --author Stephenson \
|
|||||||
| jq -r 'select(.kind == "isbn") | .id' | head -1
|
| jq -r 'select(.kind == "isbn") | .id' | head -1
|
||||||
```
|
```
|
||||||
|
|
||||||
Open Library answering that it has nothing is an answer, and it stands when
|
Open Library having nothing is an answer only once Google Books has been
|
||||||
Google Books cannot be reached; a register being down is a failure only when
|
asked and has nothing either. When Google Books cannot be reached, the search
|
||||||
both are. Each is asked the same way a lookup asks, retried with the same
|
fails rather than say no register has the title, and when it refuses for its
|
||||||
waits. Open Library is sent the title and the author as written; Google Books
|
quota (`403`, or `429` on every attempt) the failure says so and the command
|
||||||
|
exits `75`. Open Library being down is a failure only when Google Books has
|
||||||
|
nothing to offer in its place. Each is asked the same way a lookup asks,
|
||||||
|
retried with the same waits, except that a `403` from Google Books is not
|
||||||
|
asked again. Open Library is sent the title and the author as written; Google Books
|
||||||
is sent each word as its own `intitle:` or `inauthor:` term, so nothing in a
|
is sent each word as its own `intitle:` or `inauthor:` term, so nothing in a
|
||||||
title is read as search syntax.
|
title is read as search syntax.
|
||||||
|
|
||||||
@@ -224,8 +251,9 @@ title is read as search syntax.
|
|||||||
| `--limit <COUNT>` | The most candidates to print, `1` to `40`. Default `10` |
|
| `--limit <COUNT>` | The most candidates to print, `1` to `40`. Default `10` |
|
||||||
|
|
||||||
Exit `0` at least one candidate was printed, `1` no register has the title,
|
Exit `0` at least one candidate was printed, `1` no register has the title,
|
||||||
`65` the title was empty, `69` no register could be reached, `74` the output
|
`65` the title was empty, `69` a register that had to answer could not be
|
||||||
could not be written.
|
reached, `74` the output could not be written, `75` Google Books refused for
|
||||||
|
its quota.
|
||||||
|
|
||||||
From Rust, `bibfetch::search(&agent, title, author, limit, attempts)` returns
|
From Rust, `bibfetch::search(&agent, title, author, limit, attempts)` returns
|
||||||
the candidates, empty when no register has the title.
|
the candidates, empty when no register has the title.
|
||||||
|
|||||||
@@ -386,6 +386,23 @@ by ISBN every five minutes from one address"
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Whether an image's bytes run to its end marker: `FF D9` for a JPEG, which
|
||||||
|
/// some encoders follow with zero padding, and the `IEND` chunk for a PNG,
|
||||||
|
/// which is its last twelve bytes.
|
||||||
|
fn ends_whole(media_type: &str, bytes: &[u8]) -> bool {
|
||||||
|
match media_type {
|
||||||
|
"image/jpeg" => {
|
||||||
|
let end = bytes.iter().rposition(|&b| b != 0).map_or(0, |at| at + 1);
|
||||||
|
end >= 5 && bytes[..end].ends_with(&[0xFF, 0xD9])
|
||||||
|
}
|
||||||
|
_ => {
|
||||||
|
bytes.len() >= 8 + 12
|
||||||
|
&& bytes[bytes.len() - 12..].starts_with(&[0, 0, 0, 0])
|
||||||
|
&& &bytes[bytes.len() - 8..bytes.len() - 4] == b"IEND"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/// Read and check a body that is meant to be a cover.
|
/// Read and check a body that is meant to be a cover.
|
||||||
fn read(mut response: ureq::http::Response<ureq::Body>, address: &str) -> Result<Answer, Error> {
|
fn read(mut response: ureq::http::Response<ureq::Body>, address: &str) -> Result<Answer, Error> {
|
||||||
let declared = header(&response, "content-type")
|
let declared = header(&response, "content-type")
|
||||||
@@ -438,6 +455,14 @@ fn read(mut response: ureq::http::Response<ureq::Body>, address: &str) -> Result
|
|||||||
"{address}: said {media_type} but is not one"
|
"{address}: said {media_type} but is not one"
|
||||||
)));
|
)));
|
||||||
}
|
}
|
||||||
|
// The start of an image is not an image. A body sent with no length,
|
||||||
|
// or a stub, can begin right and stop short; what ends it says it is
|
||||||
|
// whole.
|
||||||
|
if !ends_whole(media_type, &bytes) {
|
||||||
|
return Err(Error::Shape(format!(
|
||||||
|
"{address}: a {media_type} that stops before its end"
|
||||||
|
)));
|
||||||
|
}
|
||||||
// No floor on the size. Open Library's stand-in for a missing cover is a
|
// No floor on the size. Open Library's stand-in for a missing cover is a
|
||||||
// 43-byte, one-pixel GIF, and it serves that only when `default=false`
|
// 43-byte, one-pixel GIF, and it serves that only when `default=false`
|
||||||
// is left off: with it, as every address here has it, a missing cover is
|
// is left off: with it, as every address here has it, a missing cover is
|
||||||
@@ -512,7 +537,12 @@ fn origin(url: &str) -> Option<&str> {
|
|||||||
|
|
||||||
/// Where a `Location` points, read against the address that sent it.
|
/// Where a `Location` points, read against the address that sent it.
|
||||||
fn resolve(from: &str, location: &str) -> String {
|
fn resolve(from: &str, location: &str) -> String {
|
||||||
if location.contains("://") {
|
// Absolute only when the scheme comes first: a relative address can
|
||||||
|
// carry another address in its query.
|
||||||
|
if location
|
||||||
|
.find("://")
|
||||||
|
.is_some_and(|at| !location[..at].contains(['/', '?', '#']))
|
||||||
|
{
|
||||||
return location.to_string();
|
return location.to_string();
|
||||||
}
|
}
|
||||||
if let Some(rest) = location.strip_prefix("//") {
|
if let Some(rest) = location.strip_prefix("//") {
|
||||||
@@ -670,15 +700,19 @@ mod tests {
|
|||||||
.agent()
|
.agent()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// A JPEG's start, filler, and its end marker, `len` bytes in all.
|
||||||
fn jpeg(len: usize) -> Vec<u8> {
|
fn jpeg(len: usize) -> Vec<u8> {
|
||||||
let mut bytes = vec![0xFF, 0xD8, 0xFF, 0xE0];
|
let mut bytes = vec![0xFF, 0xD8, 0xFF, 0xE0];
|
||||||
bytes.resize(len, 0x11);
|
bytes.resize(len - 2, 0x11);
|
||||||
|
bytes.extend([0xFF, 0xD9]);
|
||||||
bytes
|
bytes
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// A PNG's signature, filler, and its `IEND` chunk, `len` bytes in all.
|
||||||
fn png(len: usize) -> Vec<u8> {
|
fn png(len: usize) -> Vec<u8> {
|
||||||
let mut bytes = b"\x89PNG\r\n\x1a\n".to_vec();
|
let mut bytes = b"\x89PNG\r\n\x1a\n".to_vec();
|
||||||
bytes.resize(len, 0x22);
|
bytes.resize(len - 12, 0x22);
|
||||||
|
bytes.extend(b"\0\0\0\0IEND\xAE\x42\x60\x82");
|
||||||
bytes
|
bytes
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1170,6 +1204,38 @@ mod tests {
|
|||||||
assert_eq!(stub.asked(), [ISBN13, ISBN10]);
|
assert_eq!(stub.asked(), [ISBN13, ISBN10]);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_magic_number_alone_is_not_a_cover() {
|
||||||
|
let mut cut_jpeg = jpeg(4096);
|
||||||
|
cut_jpeg.truncate(4000);
|
||||||
|
let mut cut_png = png(4096);
|
||||||
|
cut_png.truncate(4000);
|
||||||
|
for (media_type, body) in [
|
||||||
|
("image/jpeg", vec![0xFF, 0xD8, 0xFF]),
|
||||||
|
("image/png", b"\x89PNG\r\n\x1a\n".to_vec()),
|
||||||
|
("image/jpeg", cut_jpeg),
|
||||||
|
("image/png", cut_png),
|
||||||
|
] {
|
||||||
|
let stub = Stub::start(move |_, _| Reply::image(media_type, body.clone()));
|
||||||
|
let found = stub
|
||||||
|
.covers()
|
||||||
|
.fetch(&agent(), "9780306406157", None, CoverSize::Large)
|
||||||
|
.map(|cover| cover.map(|cover| cover.bytes.len()));
|
||||||
|
assert!(
|
||||||
|
matches!(found, Err(Error::Shape(_))),
|
||||||
|
"{media_type}: {found:?}"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_jpeg_padded_after_its_end_marker_is_whole() {
|
||||||
|
let mut padded = jpeg(2048);
|
||||||
|
padded.extend([0, 0, 0]);
|
||||||
|
assert!(ends_whole("image/jpeg", &padded));
|
||||||
|
assert!(!ends_whole("image/jpeg", &[0xFF, 0xD8, 0xFF, 0, 0]));
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn a_redirect_to_an_address_by_number_is_refused() {
|
fn a_redirect_to_an_address_by_number_is_refused() {
|
||||||
// A listener standing in for a service on the LAN; it only counts.
|
// A listener standing in for a service on the LAN; it only counts.
|
||||||
@@ -1217,6 +1283,15 @@ mod tests {
|
|||||||
assert_eq!(resolve(from, "//c.example/x"), "https://c.example/x");
|
assert_eq!(resolve(from, "//c.example/x"), "https://c.example/x");
|
||||||
assert_eq!(resolve(from, "/x?y=1"), "https://a.example/x?y=1");
|
assert_eq!(resolve(from, "/x?y=1"), "https://a.example/x?y=1");
|
||||||
assert_eq!(resolve(from, "x.jpg"), "https://a.example/b/isbn/x.jpg");
|
assert_eq!(resolve(from, "x.jpg"), "https://a.example/b/isbn/x.jpg");
|
||||||
|
// An address in a relative one's query does not make it absolute.
|
||||||
|
assert_eq!(
|
||||||
|
resolve(from, "/view_archive.php?from=https://archive.org/x"),
|
||||||
|
"https://a.example/view_archive.php?from=https://archive.org/x"
|
||||||
|
);
|
||||||
|
assert_eq!(
|
||||||
|
resolve(from, "x?u=https://c.example/"),
|
||||||
|
"https://a.example/b/isbn/x?u=https://c.example/"
|
||||||
|
);
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
origin("http://127.0.0.1:8080/a?b"),
|
origin("http://127.0.0.1:8080/a?b"),
|
||||||
Some("http://127.0.0.1:8080")
|
Some("http://127.0.0.1:8080")
|
||||||
|
|||||||
@@ -265,11 +265,10 @@ mod merge_tests {
|
|||||||
let mut index = rec("openlibrary");
|
let mut index = rec("openlibrary");
|
||||||
index.title = Some("The First World War".into());
|
index.title = Some("The First World War".into());
|
||||||
index.authors = vec!["Michael Howard".into()];
|
index.authors = vec!["Michael Howard".into()];
|
||||||
index.year = Some(2007);
|
|
||||||
|
|
||||||
edition.fill_from(index);
|
edition.fill_from(index);
|
||||||
assert_eq!(edition.authors, ["Michael Howard"]);
|
assert_eq!(edition.authors, ["Michael Howard"]);
|
||||||
assert_eq!(edition.year, Some(2007));
|
assert_eq!(edition.language.as_deref(), Some("eng"));
|
||||||
// The fuller title arrived first and is not displaced by the shorter.
|
// The fuller title arrived first and is not displaced by the shorter.
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
edition.title.as_deref(),
|
edition.title.as_deref(),
|
||||||
|
|||||||
@@ -256,6 +256,7 @@ fn search(
|
|||||||
eprintln!("bibfetch: {why}");
|
eprintln!("bibfetch: {why}");
|
||||||
ExitCode::from(match why {
|
ExitCode::from(match why {
|
||||||
bibfetch::Error::Invalid(_) => exit::DATA,
|
bibfetch::Error::Invalid(_) => exit::DATA,
|
||||||
|
bibfetch::Error::Limited(_) => exit::TEMPFAIL,
|
||||||
_ => exit::UNAVAILABLE,
|
_ => exit::UNAVAILABLE,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|||||||
+328
-104
@@ -23,22 +23,34 @@ pub const MAX_LIMIT: usize = 40;
|
|||||||
/// What Open Library's index is asked to say about each work, and about the
|
/// What Open Library's index is asked to say about each work, and about the
|
||||||
/// one edition of it that best matches the search.
|
/// one edition of it that best matches the search.
|
||||||
///
|
///
|
||||||
/// Not the work's own `cover_i` or `cover_edition_key`: the cover the index
|
/// Of the work, only what describes the work: its publishers, ISBNs,
|
||||||
/// chose for a work is often another edition's. The edition's `cover_i` is
|
/// languages, years and page counts are every edition's at once, and a
|
||||||
/// the first cover in that edition's record, which is what a lookup by ISBN
|
/// record made from them would describe no edition. Not the work's own
|
||||||
/// gives as `cover_id`.
|
/// `cover_i` or `cover_edition_key` either: the cover the index chose for a
|
||||||
const OPEN_LIBRARY_FIELDS: &str = "key,title,subtitle,author_name,first_publish_year,publisher,\
|
/// work is often another edition's. The edition's `cover_i` is the first
|
||||||
isbn,language,subject,number_of_pages_median,editions,editions.key,editions.isbn,\
|
/// cover in that edition's record, which is what a lookup by ISBN gives as
|
||||||
editions.publisher,editions.language,editions.publish_date,editions.cover_i";
|
/// `cover_id`.
|
||||||
|
const OPEN_LIBRARY_FIELDS: &str = "key,title,subtitle,author_name,subject,editions,editions.key,\
|
||||||
|
editions.isbn,editions.publisher,editions.language,editions.publish_date,editions.cover_i";
|
||||||
|
|
||||||
|
/// Where Google Books is asked.
|
||||||
|
const GOOGLE_BOOKS: &str = "https://www.googleapis.com/books/v1/volumes";
|
||||||
|
|
||||||
/// Ask which books a register has under a title, and by an author if one is
|
/// Ask which books a register has under a title, and by an author if one is
|
||||||
/// named.
|
/// named.
|
||||||
///
|
///
|
||||||
/// Open Library's index first, and Google Books only when that answered with
|
/// Open Library's index first, and Google Books only when that answered with
|
||||||
/// nothing. A register being down is a failure only when every register
|
/// nothing. Open Library's title search is strict: given an author too, it
|
||||||
/// asked is: Open Library answering that it has nothing is an answer, and it
|
/// finds nothing for "The Ladder of Divine Ascent" that it finds for "Ladder
|
||||||
/// stands when Google Books cannot be reached. Asks nothing when `limit` is
|
/// of Divine Ascent". So when the title as given finds nothing, the title
|
||||||
/// zero; a `limit` over [`MAX_LIMIT`] is taken as that.
|
/// without a leading article is asked, and then the title and author as one
|
||||||
|
/// free-text query, before Google Books is. Each later question is asked only
|
||||||
|
/// when the one before it found nothing, and a looser one can return books
|
||||||
|
/// that only share words with the title, which the caller judges. Once Google Books has been asked, its failure is the answer:
|
||||||
|
/// [`Error::Limited`] when it refused for its quota, [`Error::Unreachable`]
|
||||||
|
/// when it could not be reached, since saying no register has the title
|
||||||
|
/// would be a claim no register made. Asks nothing when `limit` is zero; a
|
||||||
|
/// `limit` over [`MAX_LIMIT`] is taken as that.
|
||||||
pub fn search(
|
pub fn search(
|
||||||
agent: &ureq::Agent,
|
agent: &ureq::Agent,
|
||||||
title: &str,
|
title: &str,
|
||||||
@@ -46,9 +58,7 @@ pub fn search(
|
|||||||
limit: usize,
|
limit: usize,
|
||||||
attempts: u32,
|
attempts: u32,
|
||||||
) -> Result<Vec<Record>, Error> {
|
) -> Result<Vec<Record>, Error> {
|
||||||
search_with(title, author, limit, |url| {
|
search_with(title, author, limit, |url| get(agent, url, attempts))
|
||||||
crate::ask::get(agent, url, attempts)
|
|
||||||
})
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// [`search`], with how to fetch an address passed in.
|
/// [`search`], with how to fetch an address passed in.
|
||||||
@@ -75,25 +85,104 @@ fn search_with(
|
|||||||
None => Err(Error::Unreachable(format!("{url}: answered 404"))),
|
None => Err(Error::Unreachable(format!("{url}: answered 404"))),
|
||||||
};
|
};
|
||||||
|
|
||||||
let open_library =
|
let mut from_open_library = Ok(Vec::new());
|
||||||
fetch(open_library_url(title, author, limit)).and_then(|body| open_library(&body, limit));
|
for url in open_library_urls(title, author, limit) {
|
||||||
|
from_open_library = fetch(url).and_then(|body| open_library(&body, limit));
|
||||||
|
if !from_open_library.as_ref().is_ok_and(Vec::is_empty) {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
let open_library = from_open_library;
|
||||||
if open_library.as_ref().is_ok_and(|found| !found.is_empty()) {
|
if open_library.as_ref().is_ok_and(|found| !found.is_empty()) {
|
||||||
return open_library;
|
return open_library;
|
||||||
}
|
}
|
||||||
|
|
||||||
let google = match google_url(title, author, limit) {
|
let Some(url) = google_url(title, author, limit) else {
|
||||||
Some(url) => fetch(url).and_then(|body| google_books(&body, limit)),
|
|
||||||
// Nothing in the title Google could be asked by.
|
// Nothing in the title Google could be asked by.
|
||||||
None => Ok(Vec::new()),
|
return open_library;
|
||||||
};
|
};
|
||||||
match (open_library, google) {
|
let google = fetch(url).and_then(|body| google_books(&body, limit))?;
|
||||||
(_, Ok(found)) if !found.is_empty() => Ok(found),
|
if google.is_empty() {
|
||||||
(Ok(none), _) => Ok(none),
|
// Open Library's nothing, or its failure, which Google Books having
|
||||||
(Err(why), _) => Err(why),
|
// nothing either does not excuse.
|
||||||
|
return open_library;
|
||||||
}
|
}
|
||||||
|
Ok(google)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Where to ask Open Library.
|
/// The body at an address, asked as a lookup asks, or `None` when the
|
||||||
|
/// register says there is no such thing.
|
||||||
|
///
|
||||||
|
/// Except that Google Books refusing for its quota is [`Error::Limited`]: a
|
||||||
|
/// `403` at once, since it is the day's quota and asking again within
|
||||||
|
/// seconds will not move it, and a `429` once every attempt has been refused.
|
||||||
|
fn get(agent: &ureq::Agent, url: &str, attempts: u32) -> Result<Option<String>, Error> {
|
||||||
|
let attempts = attempts.max(1);
|
||||||
|
let mut last = Error::Unreachable("no attempt was made".into());
|
||||||
|
for attempt in 0..attempts {
|
||||||
|
match agent.get(url).call() {
|
||||||
|
Ok(mut response) => {
|
||||||
|
return response
|
||||||
|
.body_mut()
|
||||||
|
.read_to_string()
|
||||||
|
.map(Some)
|
||||||
|
.map_err(|e| Error::Unreachable(e.to_string()));
|
||||||
|
}
|
||||||
|
Err(ureq::Error::StatusCode(404)) => return Ok(None),
|
||||||
|
Err(ureq::Error::StatusCode(status)) => match refused(url, status) {
|
||||||
|
Some(why) if status == 403 => return Err(why),
|
||||||
|
Some(why) => last = why,
|
||||||
|
None => last = Error::Unreachable(format!("{url}: answered {status}")),
|
||||||
|
},
|
||||||
|
Err(e) => last = Error::Unreachable(e.to_string()),
|
||||||
|
}
|
||||||
|
if attempt + 1 < attempts {
|
||||||
|
std::thread::sleep(std::time::Duration::from_secs(1 << attempt.min(5)));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Err(last)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The refusal a status from a register is, when it is one for asking too
|
||||||
|
/// often.
|
||||||
|
fn refused(url: &str, status: u16) -> Option<Error> {
|
||||||
|
(url.starts_with(GOOGLE_BOOKS) && matches!(status, 403 | 429)).then(|| {
|
||||||
|
Error::Limited(format!(
|
||||||
|
"Google Books refused ({status}): its quota for this address is spent for now"
|
||||||
|
))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Every question to put to Open Library, strictest first.
|
||||||
|
fn open_library_urls(title: &str, author: Option<&str>, limit: usize) -> Vec<String> {
|
||||||
|
let mut urls = vec![open_library_url(title, author, limit)];
|
||||||
|
if let Some(rest) = without_article(title) {
|
||||||
|
urls.push(open_library_url(rest, author, limit));
|
||||||
|
}
|
||||||
|
let words = match author {
|
||||||
|
Some(author) => format!("{title} {author}"),
|
||||||
|
None => title.to_string(),
|
||||||
|
};
|
||||||
|
urls.push(format!(
|
||||||
|
"https://openlibrary.org/search.json?q={}&fields={OPEN_LIBRARY_FIELDS}&limit={limit}",
|
||||||
|
source::encode(&words),
|
||||||
|
));
|
||||||
|
urls
|
||||||
|
}
|
||||||
|
|
||||||
|
/// A title without its leading English article, when it has one and
|
||||||
|
/// something follows it.
|
||||||
|
fn without_article(title: &str) -> Option<&str> {
|
||||||
|
let (first, rest) = title.split_once(char::is_whitespace)?;
|
||||||
|
let rest = rest.trim_start();
|
||||||
|
(["the", "a", "an"]
|
||||||
|
.iter()
|
||||||
|
.any(|article| first.eq_ignore_ascii_case(article))
|
||||||
|
&& !rest.is_empty())
|
||||||
|
.then_some(rest)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Where to ask Open Library by title and author.
|
||||||
fn open_library_url(title: &str, author: Option<&str>, limit: usize) -> String {
|
fn open_library_url(title: &str, author: Option<&str>, limit: usize) -> String {
|
||||||
let author = author
|
let author = author
|
||||||
.map(|author| format!("&author={}", source::encode(author)))
|
.map(|author| format!("&author={}", source::encode(author)))
|
||||||
@@ -124,7 +213,7 @@ fn google_url(title: &str, author: Option<&str>, limit: usize) -> Option<String>
|
|||||||
return None;
|
return None;
|
||||||
}
|
}
|
||||||
Some(format!(
|
Some(format!(
|
||||||
"https://www.googleapis.com/books/v1/volumes?q={}&maxResults={limit}",
|
"{GOOGLE_BOOKS}?q={}&maxResults={limit}",
|
||||||
source::encode(&terms.join(" "))
|
source::encode(&terms.join(" "))
|
||||||
))
|
))
|
||||||
}
|
}
|
||||||
@@ -162,18 +251,8 @@ struct Work {
|
|||||||
#[serde(default)]
|
#[serde(default)]
|
||||||
author_name: Vec<String>,
|
author_name: Vec<String>,
|
||||||
#[serde(default)]
|
#[serde(default)]
|
||||||
first_publish_year: Option<i64>,
|
|
||||||
#[serde(default)]
|
|
||||||
publisher: Vec<String>,
|
|
||||||
#[serde(default)]
|
|
||||||
isbn: Vec<String>,
|
|
||||||
#[serde(default)]
|
|
||||||
language: Vec<String>,
|
|
||||||
#[serde(default)]
|
|
||||||
subject: Vec<String>,
|
subject: Vec<String>,
|
||||||
#[serde(default)]
|
#[serde(default)]
|
||||||
number_of_pages_median: Option<u32>,
|
|
||||||
#[serde(default)]
|
|
||||||
editions: Option<Editions>,
|
editions: Option<Editions>,
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -212,10 +291,11 @@ fn olid(key: &str) -> Option<String> {
|
|||||||
/// Read Open Library's answer into one candidate per work, in its order.
|
/// Read Open Library's answer into one candidate per work, in its order.
|
||||||
///
|
///
|
||||||
/// What belongs to an edition — its ISBN, publisher, language, year and
|
/// What belongs to an edition — its ISBN, publisher, language, year and
|
||||||
/// cover — is taken from the edition the index chose as matching best; what
|
/// cover — is taken from the edition the index chose as matching best, and
|
||||||
/// belongs to the work — its title, authors, subjects and length — from the
|
/// left out when that edition does not give it; only the title, authors and
|
||||||
/// work. A work the index names no edition of gives its first ISBN that reads,
|
/// subjects, which describe the work, are the work's. A work the index names
|
||||||
/// which may be any edition's, and no cover id.
|
/// no edition of is named by the work's key and says nothing an edition
|
||||||
|
/// would.
|
||||||
fn open_library(body: &str, limit: usize) -> Result<Vec<Record>, Error> {
|
fn open_library(body: &str, limit: usize) -> Result<Vec<Record>, Error> {
|
||||||
let reply: OpenLibraryReply =
|
let reply: OpenLibraryReply =
|
||||||
serde_json::from_str(body).map_err(|e| Error::Shape(e.to_string()))?;
|
serde_json::from_str(body).map_err(|e| Error::Shape(e.to_string()))?;
|
||||||
@@ -228,26 +308,47 @@ fn open_library(body: &str, limit: usize) -> Result<Vec<Record>, Error> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
fn candidate(work: Work) -> Option<Record> {
|
fn candidate(work: Work) -> Option<Record> {
|
||||||
let edition = work.editions.and_then(|e| e.docs.into_iter().next());
|
// The edition, and what it is named by: its ISBN, or its key when it has
|
||||||
|
// none. One with neither cannot be named, and is as good as none.
|
||||||
|
let edition = work
|
||||||
|
.editions
|
||||||
|
.and_then(|e| e.docs.into_iter().next())
|
||||||
|
.and_then(|edition| {
|
||||||
|
match first_isbn(edition.isbn.iter().map(String::as_str)) {
|
||||||
|
Some(isbn) => Some((isbn, "isbn")),
|
||||||
|
None => edition
|
||||||
|
.key
|
||||||
|
.as_deref()
|
||||||
|
.and_then(olid)
|
||||||
|
.map(|key| (key, "olid")),
|
||||||
|
}
|
||||||
|
.map(|named| (named, edition))
|
||||||
|
});
|
||||||
|
|
||||||
// The cover is kept only when the record names the edition it is the
|
let mut record = match edition {
|
||||||
// cover of, by that edition's ISBN or its key.
|
Some(((id, kind), edition)) => {
|
||||||
let (id, kind, edition_named) = match &edition {
|
let mut record = source::blank(&id, kind, Source::OpenLibrarySearch);
|
||||||
Some(edition) => match first_isbn(edition.isbn.iter().map(String::as_str)) {
|
record.container = edition.publisher.into_iter().next();
|
||||||
Some(isbn) => (isbn, "isbn", true),
|
record.language = edition.language.into_iter().next();
|
||||||
None => match edition.key.as_deref().and_then(olid) {
|
record.year = edition
|
||||||
Some(key) => (key, "olid", true),
|
.publish_date
|
||||||
None => (work.key.as_deref().and_then(olid)?, "olid", false),
|
.iter()
|
||||||
},
|
.find_map(|date| source::year_in(date));
|
||||||
},
|
record.cover_id = edition
|
||||||
None => match first_isbn(work.isbn.iter().map(String::as_str)) {
|
.cover_i
|
||||||
Some(isbn) => (isbn, "isbn", false),
|
.and_then(|id| u64::try_from(id).ok())
|
||||||
|
.filter(|id| *id > 0);
|
||||||
|
record
|
||||||
|
}
|
||||||
|
// The work's own ISBNs, publishers and years are its editions', and
|
||||||
|
// which belongs with which the index does not say.
|
||||||
|
None => source::blank(
|
||||||
// A work with no key cannot be named, so it is not a candidate.
|
// A work with no key cannot be named, so it is not a candidate.
|
||||||
None => (work.key.as_deref().and_then(olid)?, "olid", false),
|
&work.key.as_deref().and_then(olid)?,
|
||||||
},
|
"olid",
|
||||||
|
Source::OpenLibrarySearch,
|
||||||
|
),
|
||||||
};
|
};
|
||||||
|
|
||||||
let mut record = source::blank(&id, kind, Source::OpenLibrarySearch);
|
|
||||||
record.title = match (work.title, work.subtitle) {
|
record.title = match (work.title, work.subtitle) {
|
||||||
(Some(title), Some(subtitle)) => Some(format!("{title}: {subtitle}")),
|
(Some(title), Some(subtitle)) => Some(format!("{title}: {subtitle}")),
|
||||||
(title, _) => title,
|
(title, _) => title,
|
||||||
@@ -255,30 +356,6 @@ fn candidate(work: Work) -> Option<Record> {
|
|||||||
record.authors = work.author_name;
|
record.authors = work.author_name;
|
||||||
record.subjects = work.subject;
|
record.subjects = work.subject;
|
||||||
record.subjects.truncate(SUBJECT_LIMIT);
|
record.subjects.truncate(SUBJECT_LIMIT);
|
||||||
record.pages = work.number_of_pages_median;
|
|
||||||
|
|
||||||
let (publisher, language, year) = match edition {
|
|
||||||
Some(edition) => {
|
|
||||||
if edition_named {
|
|
||||||
record.cover_id = edition
|
|
||||||
.cover_i
|
|
||||||
.and_then(|id| u64::try_from(id).ok())
|
|
||||||
.filter(|id| *id > 0);
|
|
||||||
}
|
|
||||||
(
|
|
||||||
edition.publisher.into_iter().next(),
|
|
||||||
edition.language.into_iter().next(),
|
|
||||||
edition
|
|
||||||
.publish_date
|
|
||||||
.iter()
|
|
||||||
.find_map(|date| source::year_in(date)),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
None => (None, None, None),
|
|
||||||
};
|
|
||||||
record.container = publisher.or_else(|| work.publisher.into_iter().next());
|
|
||||||
record.language = language.or_else(|| work.language.into_iter().next());
|
|
||||||
record.year = year.or(work.first_publish_year);
|
|
||||||
Some(record)
|
Some(record)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -312,8 +389,9 @@ mod tests {
|
|||||||
use super::*;
|
use super::*;
|
||||||
|
|
||||||
/// Open Library's answer to `title=the first world war&author=howard`,
|
/// Open Library's answer to `title=the first world war&author=howard`,
|
||||||
/// recorded 2026-11-13 with the fields above and `limit=2`, the ISBN and
|
/// recorded 2026-11-13 with `limit=2`, the ISBN and subject lists
|
||||||
/// subject lists shortened.
|
/// shortened, and with the work's own publishers, ISBNs, years and length,
|
||||||
|
/// which are not asked for and are read past when they come.
|
||||||
const HOWARD: &str = r#"{"numFound": 9, "start": 0, "numFoundExact": true, "num_found": 9,
|
const HOWARD: &str = r#"{"numFound": 9, "start": 0, "numFoundExact": true, "num_found": 9,
|
||||||
"documentation_url": "https://openlibrary.org/dev/docs/api/search", "q": "", "offset": null,
|
"documentation_url": "https://openlibrary.org/dev/docs/api/search", "q": "", "offset": null,
|
||||||
"docs": [
|
"docs": [
|
||||||
@@ -420,7 +498,8 @@ mod tests {
|
|||||||
assert_eq!(first.container.as_deref(), Some("Oxford University Press"));
|
assert_eq!(first.container.as_deref(), Some("Oxford University Press"));
|
||||||
assert_eq!(first.language.as_deref(), Some("eng"));
|
assert_eq!(first.language.as_deref(), Some("eng"));
|
||||||
assert_eq!(first.subjects, ["World War, 1914-1918"]);
|
assert_eq!(first.subjects, ["World War, 1914-1918"]);
|
||||||
assert_eq!(first.pages, Some(154));
|
// The work's median length is no edition's.
|
||||||
|
assert_eq!(first.pages, None);
|
||||||
assert_eq!(first.cover_id, Some(1123124));
|
assert_eq!(first.cover_id, Some(1123124));
|
||||||
|
|
||||||
let second = &found[1];
|
let second = &found[1];
|
||||||
@@ -474,17 +553,64 @@ mod tests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn a_work_with_no_edition_named_gives_its_isbn_but_no_cover() {
|
fn what_the_edition_does_not_give_is_left_out_not_taken_from_the_work() {
|
||||||
let body = r#"{"docs": [{"key": "/works/OL1W", "title": "A Book",
|
let body = r#"{"docs": [{"key": "/works/OL267171W", "title": "War and Peace",
|
||||||
"isbn": ["0-306-40615-2"], "publisher": ["Plenum"], "first_publish_year": 1981}]}"#;
|
"author_name": ["Leo Tolstoy"], "subject": ["Napoleonic Wars"],
|
||||||
|
"first_publish_year": 1867, "publisher": ["Crowell"], "language": ["eng"],
|
||||||
|
"number_of_pages_median": 1296,
|
||||||
|
"editions": {"docs": [{"key": "/books/OL1M", "isbn": ["9780199232765"],
|
||||||
|
"cover_i": 5}]}}]}"#;
|
||||||
let found = open_library(body, 5).expect("candidates");
|
let found = open_library(body, 5).expect("candidates");
|
||||||
|
let only = &found[0];
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
(found[0].id.as_str(), found[0].kind.as_str()),
|
(only.id.as_str(), only.kind.as_str()),
|
||||||
("9780306406157", "isbn")
|
("9780199232765", "isbn")
|
||||||
);
|
);
|
||||||
assert_eq!(found[0].container.as_deref(), Some("Plenum"));
|
assert_eq!(only.cover_id, Some(5));
|
||||||
assert_eq!(found[0].year, Some(1981));
|
// 1867 and Crowell are other editions'.
|
||||||
assert_eq!(found[0].cover_id, None);
|
assert_eq!(only.year, None);
|
||||||
|
assert_eq!(only.container, None);
|
||||||
|
assert_eq!(only.language, None);
|
||||||
|
assert_eq!(only.pages, None);
|
||||||
|
// What describes the work is the work's.
|
||||||
|
assert_eq!(only.title.as_deref(), Some("War and Peace"));
|
||||||
|
assert_eq!(only.authors, ["Leo Tolstoy"]);
|
||||||
|
assert_eq!(only.subjects, ["Napoleonic Wars"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_work_with_no_edition_named_is_named_by_its_key_and_says_nothing_an_edition_would() {
|
||||||
|
let work = r#""key": "/works/OL1W", "title": "A Book", "author_name": ["A. Writer"],
|
||||||
|
"isbn": ["0-306-40615-2"], "publisher": ["Plenum"], "first_publish_year": 1981,
|
||||||
|
"language": ["eng"], "number_of_pages_median": 300"#;
|
||||||
|
// No edition, and an edition with neither an ISBN nor a key.
|
||||||
|
for editions in [
|
||||||
|
"",
|
||||||
|
r#", "editions": {"docs": [{"publisher": ["Plenum"], "cover_i": 7}]}"#,
|
||||||
|
] {
|
||||||
|
let body = format!(r#"{{"docs": [{{{work}{editions}}}]}}"#);
|
||||||
|
let found = open_library(&body, 5).expect("candidates");
|
||||||
|
let only = &found[0];
|
||||||
|
// Not 9780306406157: which edition that is, the index does not say.
|
||||||
|
assert_eq!(
|
||||||
|
(only.id.as_str(), only.kind.as_str()),
|
||||||
|
("OL1W", "olid"),
|
||||||
|
"{body}"
|
||||||
|
);
|
||||||
|
assert_eq!(only.title.as_deref(), Some("A Book"));
|
||||||
|
assert_eq!(only.authors, ["A. Writer"]);
|
||||||
|
assert_eq!(
|
||||||
|
(
|
||||||
|
only.year,
|
||||||
|
only.container.as_deref(),
|
||||||
|
only.language.as_deref(),
|
||||||
|
only.pages,
|
||||||
|
only.cover_id
|
||||||
|
),
|
||||||
|
(None, None, None, None, None),
|
||||||
|
"{body}"
|
||||||
|
);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
@@ -545,8 +671,19 @@ mod tests {
|
|||||||
recorded(&mut asked, &bodies),
|
recorded(&mut asked, &bodies),
|
||||||
)
|
)
|
||||||
.expect("candidates");
|
.expect("candidates");
|
||||||
assert_eq!(asked.len(), 2);
|
// The title as given, without its article, as free text, then Google.
|
||||||
assert!(asked[1].starts_with("https://www.googleapis.com/books/v1/volumes?q="));
|
assert_eq!(asked.len(), 4, "{asked:?}");
|
||||||
|
assert!(
|
||||||
|
asked[1].contains("?title=Google%20Story&author=Vise&"),
|
||||||
|
"{}",
|
||||||
|
asked[1]
|
||||||
|
);
|
||||||
|
assert!(
|
||||||
|
asked[2].contains("?q=The%20Google%20Story%20Vise&"),
|
||||||
|
"{}",
|
||||||
|
asked[2]
|
||||||
|
);
|
||||||
|
assert!(asked[3].starts_with("https://www.googleapis.com/books/v1/volumes?q="));
|
||||||
|
|
||||||
assert_eq!(found.len(), 2);
|
assert_eq!(found.len(), 2);
|
||||||
let first = &found[0];
|
let first = &found[0];
|
||||||
@@ -593,15 +730,46 @@ mod tests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn open_library_having_nothing_stands_when_google_books_is_down() {
|
fn google_books_down_after_open_library_had_nothing_is_a_failure() {
|
||||||
let mut asked = Vec::new();
|
let mut asked = Vec::new();
|
||||||
let bodies = [
|
let bodies = [
|
||||||
("openlibrary.org", Ok(NOTHING)),
|
("openlibrary.org", Ok(NOTHING)),
|
||||||
("googleapis.com", Err(down())),
|
("googleapis.com", Err(down())),
|
||||||
];
|
];
|
||||||
let found =
|
let failed = search_with("Nothing", None, 5, recorded(&mut asked, &bodies));
|
||||||
search_with("Nothing", None, 5, recorded(&mut asked, &bodies)).expect("an answer");
|
assert!(matches!(failed, Err(Error::Unreachable(_))), "{failed:?}");
|
||||||
assert!(found.is_empty());
|
// By title, as free text, then Google.
|
||||||
|
assert_eq!(asked.len(), 3, "{asked:?}");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn google_books_refusing_for_its_quota_is_said_to_be_that() {
|
||||||
|
let mut asked = Vec::new();
|
||||||
|
let limited = refused(&google_url("Nothing", None, 5).expect("a url"), 429);
|
||||||
|
let bodies = [
|
||||||
|
("openlibrary.org", Ok(NOTHING)),
|
||||||
|
("googleapis.com", Err(limited.expect("a refusal"))),
|
||||||
|
];
|
||||||
|
let failed = search_with("Nothing", None, 5, recorded(&mut asked, &bodies));
|
||||||
|
assert!(matches!(failed, Err(Error::Limited(_))), "{failed:?}");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn only_google_books_quota_statuses_are_refusals() {
|
||||||
|
let google = google_url("Anathem", None, 5).expect("a url");
|
||||||
|
for status in [403, 429] {
|
||||||
|
assert!(
|
||||||
|
matches!(refused(&google, status), Some(Error::Limited(_))),
|
||||||
|
"{status}"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
for status in [400, 500, 503] {
|
||||||
|
assert!(refused(&google, status).is_none(), "{status}");
|
||||||
|
}
|
||||||
|
let open_library = open_library_url("Anathem", None, 5);
|
||||||
|
for status in [403, 429] {
|
||||||
|
assert!(refused(&open_library, status).is_none(), "{status}");
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
@@ -650,8 +818,50 @@ mod tests {
|
|||||||
];
|
];
|
||||||
search_with("Anathem", Some(" "), 5, recorded(&mut asked, &bodies)).expect("ok");
|
search_with("Anathem", Some(" "), 5, recorded(&mut asked, &bodies)).expect("ok");
|
||||||
assert!(!asked[0].contains("author="), "{}", asked[0]);
|
assert!(!asked[0].contains("author="), "{}", asked[0]);
|
||||||
assert!(!asked[1].contains("inauthor"), "{}", asked[1]);
|
assert!(asked[1].contains("?q=Anathem&"), "{}", asked[1]);
|
||||||
assert!(asked[1].contains("q=intitle%3AAnathem&"), "{}", asked[1]);
|
assert!(!asked[2].contains("inauthor"), "{}", asked[2]);
|
||||||
|
assert!(asked[2].contains("q=intitle%3AAnathem&"), "{}", asked[2]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_leading_article_is_dropped_when_the_title_as_given_finds_nothing() {
|
||||||
|
let mut asked = Vec::new();
|
||||||
|
let mut answered = 0;
|
||||||
|
let found = search_with(
|
||||||
|
"The Ladder of Divine Ascent",
|
||||||
|
Some("John Climacus"),
|
||||||
|
5,
|
||||||
|
|url: &str| {
|
||||||
|
asked.push(url.to_string());
|
||||||
|
answered += 1;
|
||||||
|
Ok(Some(
|
||||||
|
if answered == 2 { TOLSTOY } else { NOTHING }.to_string(),
|
||||||
|
))
|
||||||
|
},
|
||||||
|
)
|
||||||
|
.expect("candidates");
|
||||||
|
assert!(!found.is_empty());
|
||||||
|
assert_eq!(
|
||||||
|
asked.len(),
|
||||||
|
2,
|
||||||
|
"nothing is asked after a question finds something"
|
||||||
|
);
|
||||||
|
assert!(
|
||||||
|
asked[1].contains("?title=Ladder%20of%20Divine%20Ascent&author=John%20Climacus&"),
|
||||||
|
"{}",
|
||||||
|
asked[1]
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn only_a_leading_article_with_words_after_it_is_dropped() {
|
||||||
|
assert_eq!(without_article("The Republic"), Some("Republic"));
|
||||||
|
assert_eq!(without_article("an Essay"), Some("Essay"));
|
||||||
|
assert_eq!(without_article("A"), None);
|
||||||
|
assert_eq!(without_article("The "), None);
|
||||||
|
assert_eq!(without_article("Theology"), None);
|
||||||
|
assert_eq!(without_article("Anathem"), None);
|
||||||
|
assert_eq!(open_library_urls("Anathem", None, 5).len(), 2);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
@@ -723,7 +933,9 @@ intitle:y intitle:z inauthor:O'Brien inauthor:Sons";
|
|||||||
let found = search_with("?!", Some("Someone"), 5, recorded(&mut asked, &bodies))
|
let found = search_with("?!", Some("Someone"), 5, recorded(&mut asked, &bodies))
|
||||||
.expect("an answer");
|
.expect("an answer");
|
||||||
assert!(found.is_empty());
|
assert!(found.is_empty());
|
||||||
assert_eq!(asked.len(), 1);
|
// By title and as free text; never Google.
|
||||||
|
assert_eq!(asked.len(), 2, "{asked:?}");
|
||||||
|
assert!(asked.iter().all(|url| url.contains("openlibrary.org")));
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
@@ -744,13 +956,25 @@ intitle:y intitle:z inauthor:O'Brien inauthor:Sons";
|
|||||||
let found =
|
let found =
|
||||||
search_with("The Google Story", None, 1, recorded(&mut asked, &bodies)).expect("ok");
|
search_with("The Google Story", None, 1, recorded(&mut asked, &bodies)).expect("ok");
|
||||||
assert_eq!(found.len(), 1);
|
assert_eq!(found.len(), 1);
|
||||||
assert!(asked[0].ends_with("&limit=1"), "{}", asked[0]);
|
let google = asked.last().expect("Google was asked");
|
||||||
assert!(asked[1].ends_with("&maxResults=1"), "{}", asked[1]);
|
assert!(
|
||||||
|
asked[..asked.len() - 1]
|
||||||
|
.iter()
|
||||||
|
.all(|url| url.ends_with("&limit=1")),
|
||||||
|
"{asked:?}"
|
||||||
|
);
|
||||||
|
assert!(google.ends_with("&maxResults=1"), "{google}");
|
||||||
|
|
||||||
let mut asked = Vec::new();
|
let mut asked = Vec::new();
|
||||||
search_with("The Google Story", None, 500, recorded(&mut asked, &bodies)).expect("ok");
|
search_with("The Google Story", None, 500, recorded(&mut asked, &bodies)).expect("ok");
|
||||||
assert!(asked[0].ends_with("&limit=40"), "{}", asked[0]);
|
let google = asked.last().expect("Google was asked");
|
||||||
assert!(asked[1].ends_with("&maxResults=40"), "{}", asked[1]);
|
assert!(
|
||||||
|
asked[..asked.len() - 1]
|
||||||
|
.iter()
|
||||||
|
.all(|url| url.ends_with("&limit=40")),
|
||||||
|
"{asked:?}"
|
||||||
|
);
|
||||||
|
assert!(google.ends_with("&maxResults=40"), "{google}");
|
||||||
|
|
||||||
let mut asked = Vec::new();
|
let mut asked = Vec::new();
|
||||||
let found =
|
let found =
|
||||||
|
|||||||
+119
-33
@@ -17,9 +17,10 @@ pub enum Source {
|
|||||||
Arxiv,
|
Arxiv,
|
||||||
/// OpenLibrary, for books by ISBN.
|
/// OpenLibrary, for books by ISBN.
|
||||||
OpenLibrary,
|
OpenLibrary,
|
||||||
/// OpenLibrary's index, rather than its edition record. Asked when the
|
/// OpenLibrary's index, rather than its edition record. Asked for what is
|
||||||
/// edition record has the book but not who wrote it, which is often: an
|
/// true of the work — the title, the authors by name, the subjects —
|
||||||
/// edition names its authors by key, and the index names them.
|
/// because an edition names its authors by key and the index names them.
|
||||||
|
/// Never for what differs between editions.
|
||||||
OpenLibrarySearch,
|
OpenLibrarySearch,
|
||||||
/// Google Books, for books by ISBN. Asked last, because it answers
|
/// Google Books, for books by ISBN. Asked last, because it answers
|
||||||
/// anonymous callers only until a daily quota runs out.
|
/// anonymous callers only until a daily quota runs out.
|
||||||
@@ -55,14 +56,14 @@ impl Source {
|
|||||||
match kind {
|
match kind {
|
||||||
"doi" => &[Source::Crossref],
|
"doi" => &[Source::Crossref],
|
||||||
"arxiv" => &[Source::Arxiv],
|
"arxiv" => &[Source::Arxiv],
|
||||||
// The index first. Asked for the fields by name it answers with
|
// The index first, for what is true of the work: the title, the
|
||||||
// the title, the authors, the publisher, the language, a page
|
// authors by name, the subjects. Then the edition record, for
|
||||||
// count and the subjects in one request, which is the whole of
|
// what is true of this edition only: the publisher, the language,
|
||||||
// what a catalogue wants; the edition record is then needed only
|
// the year and the length. The index answers about the work, and
|
||||||
// for a subtitle or a publisher the index did not give. Asking it
|
// its publishers, languages and years are every edition's at
|
||||||
// second cost three requests per book where one usually does, and
|
// once, so they are not asked of it; the lookup goes on to the
|
||||||
// at three books in flight that is the difference between two
|
// edition record for them. Google Books last, for whatever the
|
||||||
// days and two hours.
|
// edition record does not say.
|
||||||
"isbn" => &[
|
"isbn" => &[
|
||||||
Source::OpenLibrarySearch,
|
Source::OpenLibrarySearch,
|
||||||
Source::OpenLibrary,
|
Source::OpenLibrary,
|
||||||
@@ -83,15 +84,16 @@ impl Source {
|
|||||||
Source::OpenLibrary => {
|
Source::OpenLibrary => {
|
||||||
format!("https://openlibrary.org/isbn/{}.json", encode(id))
|
format!("https://openlibrary.org/isbn/{}.json", encode(id))
|
||||||
}
|
}
|
||||||
// `fields` or the index answers with a handful of defaults and
|
// Only what is true of the work. Not `publisher`, `language`,
|
||||||
// keeps the rest, which is how a language it holds went unread.
|
// `first_publish_year` or `number_of_pages_median`: those are every
|
||||||
// Not `cover_i`: that is the cover chosen for the whole work, and
|
// edition's at once, and the first of each is usually another
|
||||||
// on a work with hundreds of editions it is usually another
|
// edition's (the Penguin *War and Peace* came back Spanish, from
|
||||||
// edition's, in another translation or language.
|
// W.W. Norton, in 1845). Not `cover_i`: that is the cover chosen
|
||||||
|
// for the whole work, often another edition's in another
|
||||||
|
// translation or language.
|
||||||
Source::OpenLibrarySearch => format!(
|
Source::OpenLibrarySearch => format!(
|
||||||
"https://openlibrary.org/search.json?q=isbn:{}\
|
"https://openlibrary.org/search.json?q=isbn:{}\
|
||||||
&fields=title,subtitle,author_name,first_publish_year,publisher,language,subject,\
|
&fields=title,subtitle,author_name,subject&limit=1",
|
||||||
number_of_pages_median&limit=1",
|
|
||||||
encode(id)
|
encode(id)
|
||||||
),
|
),
|
||||||
Source::GoogleBooks => format!(
|
Source::GoogleBooks => format!(
|
||||||
@@ -295,6 +297,8 @@ struct SearchReply {
|
|||||||
docs: Vec<SearchDoc>,
|
docs: Vec<SearchDoc>,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// What the index says about a work. Only the fields true of every edition
|
||||||
|
/// are read, so an answer that carries the others anyway cannot leak them.
|
||||||
#[derive(Deserialize)]
|
#[derive(Deserialize)]
|
||||||
struct SearchDoc {
|
struct SearchDoc {
|
||||||
#[serde(default)]
|
#[serde(default)]
|
||||||
@@ -304,15 +308,7 @@ struct SearchDoc {
|
|||||||
#[serde(default)]
|
#[serde(default)]
|
||||||
author_name: Vec<String>,
|
author_name: Vec<String>,
|
||||||
#[serde(default)]
|
#[serde(default)]
|
||||||
first_publish_year: Option<i64>,
|
|
||||||
#[serde(default)]
|
|
||||||
publisher: Vec<String>,
|
|
||||||
#[serde(default)]
|
|
||||||
language: Vec<String>,
|
|
||||||
#[serde(default)]
|
|
||||||
subject: Vec<String>,
|
subject: Vec<String>,
|
||||||
#[serde(rename = "number_of_pages_median", default)]
|
|
||||||
pages: Option<u32>,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// How many of a work's subject headings are worth carrying.
|
/// How many of a work's subject headings are worth carrying.
|
||||||
@@ -324,6 +320,11 @@ pub(crate) const SUBJECT_LIMIT: usize = 12;
|
|||||||
|
|
||||||
/// A search that matched nothing answers with no documents rather than a
|
/// A search that matched nothing answers with no documents rather than a
|
||||||
/// status, so an empty reply is the absence and not a failure.
|
/// status, so an empty reply is the absence and not a failure.
|
||||||
|
///
|
||||||
|
/// The record says what is true of the work and nothing that belongs to one
|
||||||
|
/// edition: no publisher, language, year or page count. Those come from the
|
||||||
|
/// edition record, which [`crate::ask::lookup`] asks next because a record
|
||||||
|
/// without them is never complete.
|
||||||
fn open_library_search(id: &str, kind: &str, body: &str) -> Result<Record, Error> {
|
fn open_library_search(id: &str, kind: &str, body: &str) -> Result<Record, Error> {
|
||||||
let reply: SearchReply = serde_json::from_str(body).map_err(|e| Error::Shape(e.to_string()))?;
|
let reply: SearchReply = serde_json::from_str(body).map_err(|e| Error::Shape(e.to_string()))?;
|
||||||
let Some(doc) = reply.docs.into_iter().next() else {
|
let Some(doc) = reply.docs.into_iter().next() else {
|
||||||
@@ -336,14 +337,10 @@ fn open_library_search(id: &str, kind: &str, body: &str) -> Result<Record, Error
|
|||||||
(title, _) => title,
|
(title, _) => title,
|
||||||
};
|
};
|
||||||
record.authors = doc.author_name;
|
record.authors = doc.author_name;
|
||||||
record.year = doc.first_publish_year;
|
|
||||||
record.container = doc.publisher.into_iter().next();
|
|
||||||
record.language = doc.language.into_iter().next();
|
|
||||||
// The index lists every subject any edition of the work carries, which
|
// The index lists every subject any edition of the work carries, which
|
||||||
// runs to hundreds on a well-known book. A shelf needs a handful.
|
// runs to hundreds on a well-known book. A shelf needs a handful.
|
||||||
record.subjects = doc.subject;
|
record.subjects = doc.subject;
|
||||||
record.subjects.truncate(SUBJECT_LIMIT);
|
record.subjects.truncate(SUBJECT_LIMIT);
|
||||||
record.pages = doc.pages;
|
|
||||||
Ok(record)
|
Ok(record)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -475,9 +472,8 @@ mod tests {
|
|||||||
fn each_kind_goes_to_the_body_that_assigns_it() {
|
fn each_kind_goes_to_the_body_that_assigns_it() {
|
||||||
assert_eq!(Source::for_kind("doi"), Some(Source::Crossref));
|
assert_eq!(Source::for_kind("doi"), Some(Source::Crossref));
|
||||||
assert_eq!(Source::for_kind("arxiv"), Some(Source::Arxiv));
|
assert_eq!(Source::for_kind("arxiv"), Some(Source::Arxiv));
|
||||||
// The index, not the edition record: it answers with the whole of
|
// The index first, for the authors by name; the edition record names
|
||||||
// what a catalogue wants in one request, where the edition record
|
// them by key, and is asked next for what only the edition knows.
|
||||||
// takes up to twenty-eight seconds and names its authors by key.
|
|
||||||
assert_eq!(Source::for_kind("isbn"), Some(Source::OpenLibrarySearch));
|
assert_eq!(Source::for_kind("isbn"), Some(Source::OpenLibrarySearch));
|
||||||
// No register answers about an ISSN without a key.
|
// No register answers about an ISSN without a key.
|
||||||
assert_eq!(Source::for_kind("issn"), None);
|
assert_eq!(Source::for_kind("issn"), None);
|
||||||
@@ -599,6 +595,96 @@ mod tests {
|
|||||||
assert!(!Source::OpenLibrarySearch.url("1").contains("cover_i"));
|
assert!(!Source::OpenLibrarySearch.url("1").contains("cover_i"));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// What the index said for ISBN 9780140447934, the Penguin Classics *War
|
||||||
|
/// and Peace*, on 2026-11-13, asked for the fields the lookup asked for
|
||||||
|
/// before #6: the publishers, languages and first year of every edition
|
||||||
|
/// of the work.
|
||||||
|
const WAR_AND_PEACE_INDEX: &str = r#"{"docs":[{"title":"War and Peace",
|
||||||
|
"author_name":["Leo Tolstoy"],"first_publish_year":1845,
|
||||||
|
"publisher":["W.W. Norton","IndyPublish.com","Canterbury Classics"],
|
||||||
|
"language":["spa","gre","dut","eng"],"subject":["Fiction"],
|
||||||
|
"number_of_pages_median":1296}]}"#;
|
||||||
|
|
||||||
|
/// The edition record for the same ISBN, `/isbn/9780140447934.json`, with
|
||||||
|
/// the English language its `languages` field should name.
|
||||||
|
const WAR_AND_PEACE_EDITION: &str = r#"{"title":"War and Peace (Penguin Classics)",
|
||||||
|
"publishers":["Penguin Books"],"publish_date":"September 27, 2007",
|
||||||
|
"languages":[{"key":"/languages/eng"}],"number_of_pages":1440}"#;
|
||||||
|
|
||||||
|
/// Index first, then the edition record, merged as `ask::lookup` merges.
|
||||||
|
fn looked_up(edition: &str) -> Record {
|
||||||
|
let mut kept =
|
||||||
|
open_library_search("9780140447934", "isbn", WAR_AND_PEACE_INDEX).expect("a record");
|
||||||
|
kept.fill_from(open_library("9780140447934", "isbn", edition).expect("a record"));
|
||||||
|
kept
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn the_index_says_nothing_only_an_edition_can() {
|
||||||
|
let record =
|
||||||
|
open_library_search("9780140447934", "isbn", WAR_AND_PEACE_INDEX).expect("a record");
|
||||||
|
// What is true of the work is kept.
|
||||||
|
assert_eq!(record.title.as_deref(), Some("War and Peace"));
|
||||||
|
assert_eq!(record.authors, ["Leo Tolstoy"]);
|
||||||
|
// What belongs to one edition is not taken from all of them.
|
||||||
|
assert_eq!(record.language, None);
|
||||||
|
assert_eq!(record.container, None);
|
||||||
|
assert_eq!(record.year, None);
|
||||||
|
assert_eq!(record.pages, None);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_lookup_by_isbn_gives_the_editions_language_publisher_and_year() {
|
||||||
|
let record = looked_up(WAR_AND_PEACE_EDITION);
|
||||||
|
assert_eq!(record.language.as_deref(), Some("eng"));
|
||||||
|
assert_eq!(record.container.as_deref(), Some("Penguin Books"));
|
||||||
|
assert_eq!(record.year, Some(2007));
|
||||||
|
assert_eq!(record.pages, Some(1440));
|
||||||
|
assert_eq!(record.authors, ["Leo Tolstoy"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn what_the_edition_does_not_say_is_missing_rather_than_the_works() {
|
||||||
|
// The real edition record today names no language at all.
|
||||||
|
let record = looked_up(
|
||||||
|
r#"{"title":"War and Peace (Penguin Classics)","publishers":["Penguin Books"],
|
||||||
|
"publish_date":"September 27, 2007","number_of_pages":1440}"#,
|
||||||
|
);
|
||||||
|
assert_eq!(record.language, None);
|
||||||
|
assert_eq!(record.container.as_deref(), Some("Penguin Books"));
|
||||||
|
assert_eq!(record.year, Some(2007));
|
||||||
|
// Nor a date: the work's first year is not this edition's.
|
||||||
|
let record = looked_up(r#"{"title":"War and Peace (Penguin Classics)"}"#);
|
||||||
|
assert_eq!(record.year, None);
|
||||||
|
assert_eq!(record.container, None);
|
||||||
|
assert_eq!(record.pages, None);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn the_index_alone_never_ends_a_lookup() {
|
||||||
|
// `lookup` stops at the first complete record; the index must not be
|
||||||
|
// one, or the edition record is never asked.
|
||||||
|
let record =
|
||||||
|
open_library_search("9780140447934", "isbn", WAR_AND_PEACE_INDEX).expect("a record");
|
||||||
|
assert!(!record.complete());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn the_index_is_not_asked_for_what_its_editions_differ_in() {
|
||||||
|
let url = Source::OpenLibrarySearch.url("9780140447934");
|
||||||
|
for field in [
|
||||||
|
"publisher",
|
||||||
|
"language",
|
||||||
|
"first_publish_year",
|
||||||
|
"number_of_pages_median",
|
||||||
|
] {
|
||||||
|
assert!(
|
||||||
|
!url.split(['=', ',', '&']).any(|f| f == field),
|
||||||
|
"{field} in {url}"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn an_answer_that_is_not_what_it_should_be_says_so() {
|
fn an_answer_that_is_not_what_it_should_be_says_so() {
|
||||||
assert!(matches!(
|
assert!(matches!(
|
||||||
|
|||||||
@@ -89,12 +89,12 @@ one bad file does not stop a sweep.
|
|||||||
| `ole2` | The compound-file header every binary Word document starts with |
|
| `ole2` | The compound-file header every binary Word document starts with |
|
||||||
| `epub` | A zip holding `mimetype` and `META-INF/container.xml` |
|
| `epub` | A zip holding `mimetype` and `META-INF/container.xml` |
|
||||||
| `zip-wrapped-pdf` | A zip whose only real member is one PDF |
|
| `zip-wrapped-pdf` | A zip whose only real member is one PDF |
|
||||||
| `zip-wrapped-fb2` | A zip whose only real member is one FictionBook — the `.fb2.zip` most of them are passed around as |
|
| `zip-wrapped-fb2` | A zip whose only real member is named `.fb2` — the `.fb2.zip` most FictionBooks are passed around as |
|
||||||
| `cbz` | A zip whose every real member is a page image: JPEG, PNG, GIF or WebP |
|
| `cbz` | A zip whose every real member is a page image (JPEG, PNG, GIF or WebP), and which carries a `ComicInfo.xml` or is itself named `.cbz` or `.cbr` |
|
||||||
| `azw3`, `mobi` | A Palm database tagged `BOOKMOBI`, told apart by the format version inside the first record |
|
| `azw3`, `mobi` | A Palm database tagged `BOOKMOBI`, told apart by the format version inside the first record |
|
||||||
| `lit` | `ITOLITLS`, Microsoft Reader's signature |
|
| `lit` | `ITOLITLS`, Microsoft Reader's signature |
|
||||||
| `rtf` | `{\rtf` at the front, after any byte-order mark and blank space |
|
| `rtf` | `{\rtf` at the front, after any byte-order mark and blank space, followed by the version digit, a space or the next control word |
|
||||||
| `fb2` | XML whose root element is `FictionBook`, found by stepping over the declaration, comments and doctype in the first four kilobytes |
|
| `fb2` | XML whose root element is `FictionBook`, found by stepping over the declaration, comments and doctype in the first four kilobytes; UTF-16 with a byte-order mark is decoded first |
|
||||||
| `html` | Markup at the front, after any byte-order mark |
|
| `html` | Markup at the front, after any byte-order mark |
|
||||||
| `txt` | Text that is none of the above |
|
| `txt` | Text that is none of the above |
|
||||||
| `unknown` | Anything else, with a note saying what was seen |
|
| `unknown` | Anything else, with a note saying what was seen |
|
||||||
@@ -110,8 +110,17 @@ kind is there to stop exactly that.
|
|||||||
A comic is the pages and nothing else. Directories, the `ComicInfo.xml` a
|
A comic is the pages and nothing else. Directories, the `ComicInfo.xml` a
|
||||||
comic reader writes into the archive, and the desktop clutter every archive
|
comic reader writes into the archive, and the desktop clutter every archive
|
||||||
picks up are passed over; anything more — one PDF among the pages, a readme —
|
picks up are passed over; anything more — one PDF among the pages, a readme —
|
||||||
and the zip is not a comic, and says what it holds instead. Only names are
|
and the zip is not a comic, and says what it holds instead.
|
||||||
read, out of the archive's directory, so no member is ever unpacked.
|
|
||||||
|
A zip of pictures is as often a holiday as a comic, so images alone are not
|
||||||
|
enough. It is a comic when it carries a `ComicInfo.xml`, or when its own name
|
||||||
|
ends `.cbz` or `.cbr`. Otherwise it is `unknown`, with a note saying it is a
|
||||||
|
zip of so many images and would be a comic book if its name said `.cbz`.
|
||||||
|
|
||||||
|
Members are judged by name. Only the archive's directory is read, so no
|
||||||
|
member is ever unpacked and a page called `001.jpg` is taken to be an image
|
||||||
|
without its bytes being looked at. The same goes for a wrapped FictionBook:
|
||||||
|
the one member is taken to be a FictionBook because its name ends `.fb2`.
|
||||||
|
|
||||||
FictionBook is read as bytes rather than as text. A great many are written in
|
FictionBook is read as bytes rather than as text. A great many are written in
|
||||||
windows-1251, which spells its markup in ASCII but is not UTF-8, and would
|
windows-1251, which spells its markup in ASCII but is not UTF-8, and would
|
||||||
|
|||||||
@@ -9,9 +9,22 @@
|
|||||||
//! windows-1251, which is not UTF-8 but spells its markup in ASCII all the
|
//! windows-1251, which is not UTF-8 but spells its markup in ASCII all the
|
||||||
//! same, and a reader that insisted on UTF-8 would call every one of them
|
//! same, and a reader that insisted on UTF-8 would call every one of them
|
||||||
//! binary.
|
//! binary.
|
||||||
|
//!
|
||||||
|
//! A FictionBook saved as UTF-16 is the one case where the markup is not
|
||||||
|
//! ASCII bytes. Its byte-order mark says so, and the front is decoded before
|
||||||
|
//! the same walk is made over it.
|
||||||
|
|
||||||
use crate::BOM;
|
use crate::BOM;
|
||||||
|
|
||||||
|
/// The UTF-16 byte-order mark, little-endian.
|
||||||
|
const UTF16_LE: &[u8] = b"\xff\xfe";
|
||||||
|
/// The UTF-16 byte-order mark, big-endian.
|
||||||
|
const UTF16_BE: &[u8] = b"\xfe\xff";
|
||||||
|
|
||||||
|
/// Most UTF-16 code units decoded from the front: the same window, in
|
||||||
|
/// characters, as the bytes read for every other encoding.
|
||||||
|
const UTF16_UNITS: usize = 2048;
|
||||||
|
|
||||||
/// What the root element of a FictionBook is called.
|
/// What the root element of a FictionBook is called.
|
||||||
const ROOT: &[u8] = b"FictionBook";
|
const ROOT: &[u8] = b"FictionBook";
|
||||||
|
|
||||||
@@ -21,9 +34,41 @@ const ROOT: &[u8] = b"FictionBook";
|
|||||||
/// does not begin inside it is not found, so the answer is no rather than a
|
/// does not begin inside it is not found, so the answer is no rather than a
|
||||||
/// guess.
|
/// guess.
|
||||||
pub fn is_fictionbook(head: &[u8]) -> bool {
|
pub fn is_fictionbook(head: &[u8]) -> bool {
|
||||||
|
match utf16(head) {
|
||||||
|
Some(decoded) => is_fictionbook_root(decoded.as_bytes()),
|
||||||
|
None => is_fictionbook_root(head),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn is_fictionbook_root(head: &[u8]) -> bool {
|
||||||
root_element(head).is_some_and(|name| local_name(name) == ROOT)
|
root_element(head).is_some_and(|name| local_name(name) == ROOT)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// The front of a UTF-16 file as UTF-8, if a byte-order mark says it is one.
|
||||||
|
///
|
||||||
|
/// Only a bounded prefix is decoded. A half character at the end, or a
|
||||||
|
/// surrogate without its pair, becomes a replacement character, which the
|
||||||
|
/// walk takes as part of a name and so never as the end of one.
|
||||||
|
fn utf16(head: &[u8]) -> Option<String> {
|
||||||
|
let (body, big_endian) = match head.strip_prefix(UTF16_LE) {
|
||||||
|
Some(body) => (body, false),
|
||||||
|
None => (head.strip_prefix(UTF16_BE)?, true),
|
||||||
|
};
|
||||||
|
let units = body.chunks_exact(2).take(UTF16_UNITS).map(|pair| {
|
||||||
|
let pair = [pair[0], pair[1]];
|
||||||
|
if big_endian {
|
||||||
|
u16::from_be_bytes(pair)
|
||||||
|
} else {
|
||||||
|
u16::from_le_bytes(pair)
|
||||||
|
}
|
||||||
|
});
|
||||||
|
Some(
|
||||||
|
char::decode_utf16(units)
|
||||||
|
.map(|c| c.unwrap_or(char::REPLACEMENT_CHARACTER))
|
||||||
|
.collect(),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
/// The name of the first element, after the prolog.
|
/// The name of the first element, after the prolog.
|
||||||
fn root_element(head: &[u8]) -> Option<&[u8]> {
|
fn root_element(head: &[u8]) -> Option<&[u8]> {
|
||||||
let mut rest = head.strip_prefix(BOM).unwrap_or(head);
|
let mut rest = head.strip_prefix(BOM).unwrap_or(head);
|
||||||
@@ -146,6 +191,60 @@ mod tests {
|
|||||||
assert!(!is_fictionbook(b"<!-- never closed <FictionBook>"));
|
assert!(!is_fictionbook(b"<!-- never closed <FictionBook>"));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn utf16(text: &str, big_endian: bool) -> Vec<u8> {
|
||||||
|
let mut out = if big_endian {
|
||||||
|
UTF16_BE.to_vec()
|
||||||
|
} else {
|
||||||
|
UTF16_LE.to_vec()
|
||||||
|
};
|
||||||
|
for unit in text.encode_utf16() {
|
||||||
|
out.extend_from_slice(&if big_endian {
|
||||||
|
unit.to_be_bytes()
|
||||||
|
} else {
|
||||||
|
unit.to_le_bytes()
|
||||||
|
});
|
||||||
|
}
|
||||||
|
out
|
||||||
|
}
|
||||||
|
|
||||||
|
const UTF16_BOOK: &str = "<?xml version=\"1.0\" encoding=\"UTF-16\"?>\r\n\
|
||||||
|
<FictionBook xmlns=\"http://www.gribuser.ru/xml/fictionbook/2.0\">\
|
||||||
|
<description><book-title>Мельница</book-title>";
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_little_endian_utf16_fictionbook_is_recognised() {
|
||||||
|
assert!(is_fictionbook(&utf16(UTF16_BOOK, false)));
|
||||||
|
assert!(!is_fictionbook(&utf16(
|
||||||
|
"<?xml version=\"1.0\"?><rss>",
|
||||||
|
false
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_big_endian_utf16_fictionbook_is_recognised() {
|
||||||
|
assert!(is_fictionbook(&utf16(UTF16_BOOK, true)));
|
||||||
|
assert!(!is_fictionbook(&utf16(
|
||||||
|
"<?xml version=\"1.0\"?><rss>",
|
||||||
|
true
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn utf16_read_in_the_wrong_order_is_not_a_fictionbook() {
|
||||||
|
let mut swapped = utf16(UTF16_BOOK, false);
|
||||||
|
swapped[..2].copy_from_slice(UTF16_BE);
|
||||||
|
assert!(!is_fictionbook(&swapped));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_utf16_root_the_window_cut_short_is_not_taken() {
|
||||||
|
let head = utf16("<FictionBook>", false);
|
||||||
|
for cut in 0..head.len() {
|
||||||
|
assert!(!is_fictionbook(&head[..cut]), "cut at {cut}");
|
||||||
|
}
|
||||||
|
assert!(is_fictionbook(&head));
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn a_truncated_or_mangled_prolog_does_not_panic() {
|
fn a_truncated_or_mangled_prolog_does_not_panic() {
|
||||||
let head = b"\xef\xbb\xbf<?xml?><!--c--><!DOCTYPE x [ <!ENTITY a '>'> ] \"]\">\
|
let head = b"\xef\xbb\xbf<?xml?><!--c--><!DOCTYPE x [ <!ENTITY a '>'> ] \"]\">\
|
||||||
|
|||||||
+137
-13
@@ -36,7 +36,10 @@ const ARCHIVE_NOISE: &[&str] = &["__macosx/", ".ds_store", "thumbs.db"];
|
|||||||
|
|
||||||
/// What a comic book archive carries besides its pages: the catalogue entry
|
/// What a comic book archive carries besides its pages: the catalogue entry
|
||||||
/// comic readers write into it.
|
/// comic readers write into it.
|
||||||
const COMIC_NOISE: &[&str] = &["comicinfo.xml"];
|
const COMIC_CATALOGUE: &str = "comicinfo.xml";
|
||||||
|
|
||||||
|
/// The extensions that say an archive is a comic book.
|
||||||
|
const COMIC_EXTENSIONS: &[&str] = &["cbz", "cbr"];
|
||||||
|
|
||||||
/// The extensions of the images a comic book archive is made of.
|
/// The extensions of the images a comic book archive is made of.
|
||||||
const PAGE_IMAGES: &[&str] = &[".jpg", ".jpeg", ".png", ".gif", ".webp"];
|
const PAGE_IMAGES: &[&str] = &[".jpg", ".jpeg", ".png", ".gif", ".webp"];
|
||||||
@@ -125,8 +128,23 @@ fn archive(source: &impl Bytes, doc: &mut Doc) -> Kind {
|
|||||||
doc.note(format!("a zip holding one FictionBook, {fb2:?}"));
|
doc.note(format!("a zip holding one FictionBook, {fb2:?}"));
|
||||||
return Kind::ZipWrappedFb2;
|
return Kind::ZipWrappedFb2;
|
||||||
}
|
}
|
||||||
if is_comic(&names) {
|
if let Some(pages) = comic_pages(&names) {
|
||||||
return Kind::Cbz;
|
// A zip of pictures is as often a holiday as a comic, and only the
|
||||||
|
// names have been read. It is a comic when something says so: the
|
||||||
|
// catalogue entry a comic reader writes, or a name that claims it.
|
||||||
|
let named_comic = doc
|
||||||
|
.declared_ext
|
||||||
|
.as_deref()
|
||||||
|
.is_some_and(|ext| COMIC_EXTENSIONS.contains(&ext));
|
||||||
|
if pages.catalogued || named_comic {
|
||||||
|
return Kind::Cbz;
|
||||||
|
}
|
||||||
|
doc.note(format!(
|
||||||
|
"a zip of {} image{}, which would be a comic book if its name said .cbz",
|
||||||
|
pages.count,
|
||||||
|
if pages.count == 1 { "" } else { "s" }
|
||||||
|
));
|
||||||
|
return Kind::Unknown;
|
||||||
}
|
}
|
||||||
if lower
|
if lower
|
||||||
.iter()
|
.iter()
|
||||||
@@ -160,23 +178,39 @@ fn sole_member<'a>(names: &'a [String], extension: &str) -> Option<&'a str> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Whether an archive is the pages of a comic and nothing else.
|
/// The pages of an archive that is images and nothing else.
|
||||||
|
struct Pages {
|
||||||
|
/// How many images there are.
|
||||||
|
count: usize,
|
||||||
|
/// Whether a comic reader's catalogue entry is there beside them.
|
||||||
|
catalogued: bool,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The pages, if an archive is images and nothing else.
|
||||||
///
|
///
|
||||||
/// Every real member has to be an image. One PDF or one text file among the
|
/// Every real member has to be an image. One PDF or one text file among the
|
||||||
/// pages makes it something else, and saying what would be a guess.
|
/// pages makes it something else, and saying what would be a guess. Images
|
||||||
fn is_comic(names: &[String]) -> bool {
|
/// are known by their names alone: only the archive's directory is read.
|
||||||
|
fn comic_pages(names: &[String]) -> Option<Pages> {
|
||||||
|
let mut catalogued = false;
|
||||||
let pages: Vec<String> = real_members(names)
|
let pages: Vec<String> = real_members(names)
|
||||||
.into_iter()
|
.into_iter()
|
||||||
.map(|name| name.to_lowercase())
|
.map(|name| name.to_lowercase())
|
||||||
.filter(|name| {
|
.filter(|name| {
|
||||||
let file = name.rsplit('/').next().unwrap_or(name);
|
let file = name.rsplit('/').next().unwrap_or(name);
|
||||||
!COMIC_NOISE.contains(&file)
|
let catalogue = file == COMIC_CATALOGUE;
|
||||||
|
catalogued |= catalogue;
|
||||||
|
!catalogue
|
||||||
})
|
})
|
||||||
.collect();
|
.collect();
|
||||||
!pages.is_empty()
|
let all_images = !pages.is_empty()
|
||||||
&& pages
|
&& pages
|
||||||
.iter()
|
.iter()
|
||||||
.all(|name| PAGE_IMAGES.iter().any(|image| name.ends_with(image)))
|
.all(|name| PAGE_IMAGES.iter().any(|image| name.ends_with(image)));
|
||||||
|
all_images.then_some(Pages {
|
||||||
|
count: pages.len(),
|
||||||
|
catalogued,
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
/// The members that carry content: no directories, no desktop clutter.
|
/// The members that carry content: no directories, no desktop clutter.
|
||||||
@@ -198,7 +232,7 @@ fn front(head: &[u8], doc: &mut Doc) -> Kind {
|
|||||||
// design but not always in practice, and a FictionBook is as often
|
// design but not always in practice, and a FictionBook is as often
|
||||||
// windows-1251 as UTF-8.
|
// windows-1251 as UTF-8.
|
||||||
let lead = head.strip_prefix(BOM).unwrap_or(head).trim_ascii_start();
|
let lead = head.strip_prefix(BOM).unwrap_or(head).trim_ascii_start();
|
||||||
if lead.starts_with(RTF) {
|
if is_rtf(lead) {
|
||||||
return Kind::Rtf;
|
return Kind::Rtf;
|
||||||
}
|
}
|
||||||
if fb2::is_fictionbook(head) {
|
if fb2::is_fictionbook(head) {
|
||||||
@@ -207,6 +241,17 @@ fn front(head: &[u8], doc: &mut Doc) -> Kind {
|
|||||||
text(head, doc)
|
text(head, doc)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Whether `lead` opens an RTF document.
|
||||||
|
///
|
||||||
|
/// `{\rtf` has to be the whole control word: what follows it is the version,
|
||||||
|
/// normally `1`, or the space or next control word that ends it. `{\rtfoo` is
|
||||||
|
/// some other word that happens to start the same way.
|
||||||
|
fn is_rtf(lead: &[u8]) -> bool {
|
||||||
|
lead.strip_prefix(RTF)
|
||||||
|
.and_then(|rest| rest.first())
|
||||||
|
.is_some_and(|next| next.is_ascii_digit() || next.is_ascii_whitespace() || *next == b'\\')
|
||||||
|
}
|
||||||
|
|
||||||
/// Text, markup, or nothing this knows.
|
/// Text, markup, or nothing this knows.
|
||||||
fn text(head: &[u8], doc: &mut Doc) -> Kind {
|
fn text(head: &[u8], doc: &mut Doc) -> Kind {
|
||||||
if head.is_empty() {
|
if head.is_empty() {
|
||||||
@@ -432,10 +477,23 @@ mod tests {
|
|||||||
#[test]
|
#[test]
|
||||||
fn rtf_cut_short_of_its_control_word_is_not_rtf() {
|
fn rtf_cut_short_of_its_control_word_is_not_rtf() {
|
||||||
assert_eq!(sniff(&br"{\rt".as_slice(), "a.rtf").kind, Kind::Txt);
|
assert_eq!(sniff(&br"{\rt".as_slice(), "a.rtf").kind, Kind::Txt);
|
||||||
|
assert_eq!(sniff(&br"{\rtf".as_slice(), "a.rtf").kind, Kind::Txt);
|
||||||
assert_eq!(kind_of(br"{\rtx1", "a.rtf"), Kind::Txt);
|
assert_eq!(kind_of(br"{\rtx1", "a.rtf"), Kind::Txt);
|
||||||
assert_eq!(kind_of(br"text {\rtf1", "a.rtf"), Kind::Txt);
|
assert_eq!(kind_of(br"text {\rtf1", "a.rtf"), Kind::Txt);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn rtf_is_the_whole_control_word() {
|
||||||
|
assert_eq!(kind_of(br"{\rtf\ansi\deff0", "a.rtf"), Kind::Rtf);
|
||||||
|
assert_eq!(kind_of(b"{\\rtf \\ansi", "a.rtf"), Kind::Rtf);
|
||||||
|
assert_eq!(kind_of(b"{\\rtf\r\n\\ansi", "a.rtf"), Kind::Rtf);
|
||||||
|
assert_eq!(kind_of(br"{\rtf2", "a.rtf"), Kind::Rtf);
|
||||||
|
|
||||||
|
assert_eq!(kind_of(br"{\rtfoo bar}", "a.rtf"), Kind::Txt);
|
||||||
|
assert_eq!(kind_of(br"{\rtf}", "a.rtf"), Kind::Txt);
|
||||||
|
assert_eq!(kind_of(br"{\rtf-1", "a.rtf"), Kind::Txt);
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn rtf_named_as_a_word_document_is_remarked_on() {
|
fn rtf_named_as_a_word_document_is_remarked_on() {
|
||||||
let doc = sniff(&padded(br"{\rtf1\ansi").as_slice(), "letter.doc");
|
let doc = sniff(&padded(br"{\rtf1\ansi").as_slice(), "letter.doc");
|
||||||
@@ -471,6 +529,28 @@ mod tests {
|
|||||||
assert_eq!(kind_of(feed, "feed.xml"), Kind::Html);
|
assert_eq!(kind_of(feed, "feed.xml"), Kind::Html);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_utf16_fictionbook_is_recognised_in_either_byte_order() {
|
||||||
|
let book = "<?xml version=\"1.0\" encoding=\"UTF-16\"?>\n<FictionBook>";
|
||||||
|
for big_endian in [false, true] {
|
||||||
|
let mut bytes = if big_endian {
|
||||||
|
vec![0xfe, 0xff]
|
||||||
|
} else {
|
||||||
|
vec![0xff, 0xfe]
|
||||||
|
};
|
||||||
|
for unit in book.encode_utf16() {
|
||||||
|
bytes.extend_from_slice(&if big_endian {
|
||||||
|
unit.to_be_bytes()
|
||||||
|
} else {
|
||||||
|
unit.to_le_bytes()
|
||||||
|
});
|
||||||
|
}
|
||||||
|
let doc = sniff(&padded(&bytes).as_slice(), "mill.fb2");
|
||||||
|
assert_eq!(doc.kind, Kind::Fb2, "big-endian: {big_endian}");
|
||||||
|
assert!(doc.notes.is_empty(), "{:?}", doc.notes);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn a_fictionbook_named_as_something_else_is_remarked_on() {
|
fn a_fictionbook_named_as_something_else_is_remarked_on() {
|
||||||
let doc = sniff(&padded(b"<FictionBook>").as_slice(), "mill.txt");
|
let doc = sniff(&padded(b"<FictionBook>").as_slice(), "mill.txt");
|
||||||
@@ -526,11 +606,55 @@ mod tests {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn a_comic_saved_as_a_zip_is_remarked_on() {
|
fn a_zip_of_photographs_is_not_a_comic() {
|
||||||
let doc = archive_of(&["001.jpg", "002.jpg"], "issue-1.zip");
|
let doc = archive_of(&["IMG_0001.jpg", "IMG_0002.jpg"], "holiday.zip");
|
||||||
|
assert_eq!(doc.kind, Kind::Unknown);
|
||||||
|
assert!(
|
||||||
|
doc.notes.iter().any(|note| note
|
||||||
|
== "a zip of 2 images, which would be a comic book if its name said .cbz"),
|
||||||
|
"{:?}",
|
||||||
|
doc.notes
|
||||||
|
);
|
||||||
|
|
||||||
|
let one = archive_of(&["IMG_0001.jpg"], "holiday.zip");
|
||||||
|
assert!(
|
||||||
|
one.notes
|
||||||
|
.iter()
|
||||||
|
.any(|note| note.starts_with("a zip of 1 image,")),
|
||||||
|
"{:?}",
|
||||||
|
one.notes
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn the_same_images_named_as_a_comic_are_one() {
|
||||||
|
let doc = archive_of(&["IMG_0001.jpg", "IMG_0002.jpg"], "holiday.cbz");
|
||||||
assert_eq!(doc.kind, Kind::Cbz);
|
assert_eq!(doc.kind, Kind::Cbz);
|
||||||
assert!(
|
assert!(
|
||||||
doc.notes.iter().any(|note| note.contains("comic")),
|
!doc.notes.iter().any(|note| note.contains("named .")),
|
||||||
|
"{:?}",
|
||||||
|
doc.notes
|
||||||
|
);
|
||||||
|
|
||||||
|
// A comic zipped and named as if it were RAR is still a comic, and
|
||||||
|
// the name is remarked on.
|
||||||
|
let rar = archive_of(&["001.jpg", "002.jpg"], "issue-1.cbr");
|
||||||
|
assert_eq!(rar.kind, Kind::Cbz);
|
||||||
|
assert!(
|
||||||
|
rar.notes.iter().any(|note| note.contains("named .cbr")),
|
||||||
|
"{:?}",
|
||||||
|
rar.notes
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_comic_saved_as_a_zip_is_known_by_its_catalogue_and_remarked_on() {
|
||||||
|
let doc = archive_of(&["001.jpg", "002.jpg", "ComicInfo.xml"], "issue-1.zip");
|
||||||
|
assert_eq!(doc.kind, Kind::Cbz);
|
||||||
|
assert!(
|
||||||
|
doc.notes
|
||||||
|
.iter()
|
||||||
|
.any(|note| note == "named .zip, but the bytes say a comic book archive"),
|
||||||
"{:?}",
|
"{:?}",
|
||||||
doc.notes
|
doc.notes
|
||||||
);
|
);
|
||||||
|
|||||||
Reference in new issue
Block a user