fix(mover): rename the folder on relocate so audiobookshelf keeps the item and its cover
Build image / image (push) Successful in 52s
Build image / image (push) Successful in 52s
This commit is contained in:
1 parent
b51d5754e0
commit
5f4b3cb564
5 files changed
+95
No files matched your search
@@ -827,6 +827,8 @@ function renderImportTable() {
|
|||||||
.filter((r) => r.media_type === item.media_type && r.imported_path)
|
.filter((r) => r.media_type === item.media_type && r.imported_path)
|
||||||
.map((r) => option(r, " ↩︎"))
|
.map((r) => option(r, " ↩︎"))
|
||||||
.join("");
|
.join("");
|
||||||
|
const override = seriesOverride(item);
|
||||||
|
const req = override && missingReqs.find((r) => r.id === item.request_id);
|
||||||
return `<tr class="${item.importState ? "row-" + item.importState : item.conflict ? "row-conflict" : ""}">
|
return `<tr class="${item.importState ? "row-" + item.importState : item.conflict ? "row-conflict" : ""}">
|
||||||
<td><input type="checkbox" data-check="${i}" ${item.checked ? "checked" : ""}></td>
|
<td><input type="checkbox" data-check="${i}" ${item.checked ? "checked" : ""}></td>
|
||||||
<td class="mono">
|
<td class="mono">
|
||||||
@@ -844,6 +846,11 @@ function renderImportTable() {
|
|||||||
${appendOpts ? `<optgroup label="${esc(t("import.appendGroup"))}">${appendOpts}</optgroup>` : ""}
|
${appendOpts ? `<optgroup label="${esc(t("import.appendGroup"))}">${appendOpts}</optgroup>` : ""}
|
||||||
</select>
|
</select>
|
||||||
<button class="secondary" data-quick="${i}" title="${esc(t("import.quickTitle"))}">🔍</button>
|
<button class="secondary" data-quick="${i}" title="${esc(t("import.quickTitle"))}">🔍</button>
|
||||||
|
${override
|
||||||
|
? `<span class="tag" title="${esc(t("import.folderSeriesTitle", {
|
||||||
|
series: req.series || "–", volume: req.volume ?? "–" }))}">${esc(
|
||||||
|
t("import.folderSeries", override))}</span>`
|
||||||
|
: ""}
|
||||||
${item.parts || item.maybe_separate
|
${item.parts || item.maybe_separate
|
||||||
? `<button class="secondary" data-split="${i}" title="${esc(t(item.parts ? "import.unmerge" : "import.splitDir"))}">✂️</button>`
|
? `<button class="secondary" data-split="${i}" title="${esc(t(item.parts ? "import.unmerge" : "import.splitDir"))}">✂️</button>`
|
||||||
: ""}
|
: ""}
|
||||||
@@ -1513,6 +1520,25 @@ function groupByRequest(chosen) {
|
|||||||
return [...byRequest.values()];
|
return [...byRequest.values()];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// "Autor - Georgia 01 - Titel": the release counts the series the way the
|
||||||
|
// translation does, the metadata APIs often count the original's volumes
|
||||||
|
function folderSeries(item) {
|
||||||
|
const parent = (item.rel_dir || "").split("/").pop();
|
||||||
|
for (const name of [item.name, parent]) {
|
||||||
|
const { series, volume } = parseDownloadName(name || "");
|
||||||
|
if (series && volume != null) return { series, volume };
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
// the folder's series when it differs from the chosen request's
|
||||||
|
function seriesOverride(item) {
|
||||||
|
const req = missingReqs.find((r) => r.id === item.request_id);
|
||||||
|
const folder = folderSeries(item);
|
||||||
|
if (!req || !folder) return null;
|
||||||
|
return folder.series === req.series && folder.volume === req.volume ? null : folder;
|
||||||
|
}
|
||||||
|
|
||||||
function buildImportGroups(groups) {
|
function buildImportGroups(groups) {
|
||||||
return groups.map((group) => ({
|
return groups.map((group) => ({
|
||||||
parts: group,
|
parts: group,
|
||||||
@@ -1522,6 +1548,7 @@ function buildImportGroups(groups) {
|
|||||||
files: group.flatMap((it) => it.files),
|
files: group.flatMap((it) => it.files),
|
||||||
request_id: group[0].request_id,
|
request_id: group[0].request_id,
|
||||||
append: importedReqs.some((r) => r.id === group[0].request_id), // orphans re-import
|
append: importedReqs.some((r) => r.id === group[0].request_id), // orphans re-import
|
||||||
|
...(seriesOverride(group[0]) || {}),
|
||||||
},
|
},
|
||||||
}));
|
}));
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -146,6 +146,8 @@ const STRINGS = {
|
|||||||
"import.splitDir": "Ordner in einzelne Titel aufteilen",
|
"import.splitDir": "Ordner in einzelne Titel aufteilen",
|
||||||
"import.parts": "{parts} Teile · {files} Dateien",
|
"import.parts": "{parts} Teile · {files} Dateien",
|
||||||
"import.maybeSeparate": "{n} Titel?",
|
"import.maybeSeparate": "{n} Titel?",
|
||||||
|
"import.folderSeries": "→ {series} #{volume}",
|
||||||
|
"import.folderSeriesTitle": "Reihe und Band aus dem Ordnernamen ersetzen beim Import die des Eintrags ({series} #{volume})",
|
||||||
"import.maybeSeparateTitle": "Die {n} Dateien tragen verschiedene Titel und sind je groß genug für ein ganzes Buch — mit ✂️ aufteilen",
|
"import.maybeSeparateTitle": "Die {n} Dateien tragen verschiedene Titel und sind je groß genug für ein ganzes Buch — mit ✂️ aufteilen",
|
||||||
"import.libraryCellTitle": "Ziel-Library dieser Anfrage ändern",
|
"import.libraryCellTitle": "Ziel-Library dieser Anfrage ändern",
|
||||||
"import.conflict": "⚠ Konflikt",
|
"import.conflict": "⚠ Konflikt",
|
||||||
@@ -367,6 +369,8 @@ const STRINGS = {
|
|||||||
"import.splitDir": "Split the folder into single titles",
|
"import.splitDir": "Split the folder into single titles",
|
||||||
"import.parts": "{parts} parts · {files} files",
|
"import.parts": "{parts} parts · {files} files",
|
||||||
"import.maybeSeparate": "{n} titles?",
|
"import.maybeSeparate": "{n} titles?",
|
||||||
|
"import.folderSeries": "→ {series} #{volume}",
|
||||||
|
"import.folderSeriesTitle": "The series and volume from the folder name replace the request's on import ({series} #{volume})",
|
||||||
"import.maybeSeparateTitle": "The {n} files carry different titles and are each big enough for a whole book — split with ✂️",
|
"import.maybeSeparateTitle": "The {n} files carry different titles and are each big enough for a whole book — split with ✂️",
|
||||||
"import.libraryCellTitle": "Change this request's target library",
|
"import.libraryCellTitle": "Change this request's target library",
|
||||||
"import.conflict": "⚠ Conflict",
|
"import.conflict": "⚠ Conflict",
|
||||||
|
|||||||
@@ -753,6 +753,8 @@ def test_relocate_after_fixing_the_series(client):
|
|||||||
# a cover dropped next to the audio must survive the move
|
# a cover dropped next to the audio must survive the move
|
||||||
(Path(dest) / "cover.jpg").write_bytes(b"")
|
(Path(dest) / "cover.jpg").write_bytes(b"")
|
||||||
|
|
||||||
|
inode = Path(dest).stat().st_ino
|
||||||
|
|
||||||
client.put(f"/api/requests/{req_id}", json={
|
client.put(f"/api/requests/{req_id}", json={
|
||||||
"library_id": lib_id, "title": "Philosopher's Stone",
|
"library_id": lib_id, "title": "Philosopher's Stone",
|
||||||
"series": "Harry Potter", "volume": 1,
|
"series": "Harry Potter", "volume": 1,
|
||||||
@@ -761,6 +763,8 @@ def test_relocate_after_fixing_the_series(client):
|
|||||||
assert res["ok"] and res["moved"]
|
assert res["ok"] and res["moved"]
|
||||||
new = root / "Harry Potter" / "Philosopher's Stone"
|
new = root / "Harry Potter" / "Philosopher's Stone"
|
||||||
assert Path(res["dest"]) == new
|
assert Path(res["dest"]) == new
|
||||||
|
# a renamed folder, not a new one: Audiobookshelf keeps the item and its cover
|
||||||
|
assert new.stat().st_ino == inode
|
||||||
assert sorted(p.name for p in new.iterdir()) == [
|
assert sorted(p.name for p in new.iterdir()) == [
|
||||||
"Philosopher's Stone - Part 01.mp3", "Philosopher's Stone - Part 02.mp3", "cover.jpg",
|
"Philosopher's Stone - Part 01.mp3", "Philosopher's Stone - Part 02.mp3", "cover.jpg",
|
||||||
]
|
]
|
||||||
@@ -769,6 +773,45 @@ def test_relocate_after_fixing_the_series(client):
|
|||||||
"imported_path"] == str(new)
|
"imported_path"] == str(new)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
def test_the_folder_series_replaces_the_requests_on_import(client):
|
||||||
|
"""Hardcover counts "Tote Augen" as Will Trent 3, the German release as Georgia 1."""
|
||||||
|
root = client.tmp_path / "library" / "german"
|
||||||
|
lib_id = client.post("/api/libraries", json={
|
||||||
|
"name": "german", "media_type": "audiobook", "root_path": str(root),
|
||||||
|
"folder_template": "{Series}/{Volume} - {Title}", "file_template": "{Title}",
|
||||||
|
}).json()["id"]
|
||||||
|
req_id = client.post("/api/requests", json={
|
||||||
|
"library_id": lib_id, "title": "Tote Augen", "authors": "Karin Slaughter",
|
||||||
|
"series": "Will Trent", "volume": 3,
|
||||||
|
}).json()["id"]
|
||||||
|
|
||||||
|
def import_folder(name, **override):
|
||||||
|
src = client.downloads / name
|
||||||
|
src.mkdir()
|
||||||
|
(src / "01.mp3").write_bytes(b"")
|
||||||
|
return client.post("/api/import", json={"items": [{
|
||||||
|
"path": str(src), "is_dir": True, "files": [str(src / "01.mp3")],
|
||||||
|
"request_id": req_id, **override,
|
||||||
|
}]}).json()["results"][0]
|
||||||
|
|
||||||
|
# a failed import must not leave the folder's series behind
|
||||||
|
(root / "Georgia" / "01 - Tote Augen").mkdir(parents=True)
|
||||||
|
(root / "Georgia" / "01 - Tote Augen" / "Tote Augen.mp3").write_bytes(b"")
|
||||||
|
failed = import_folder("broken", series="Georgia", volume=1)
|
||||||
|
assert not failed["ok"]
|
||||||
|
req = client.get("/api/requests", params={"status": "missing"}).json()[0]
|
||||||
|
assert (req["series"], req["volume"]) == ("Will Trent", 3)
|
||||||
|
shutil.rmtree(root / "Georgia")
|
||||||
|
|
||||||
|
result = import_folder("Karin Slaughter - Georgia 01 - Tote Augen",
|
||||||
|
series="Georgia", volume=1)
|
||||||
|
assert result["ok"], result
|
||||||
|
assert Path(result["dest"]).parent == root / "Georgia" / "01 - Tote Augen"
|
||||||
|
req = client.get("/api/requests", params={"status": "imported"}).json()[0]
|
||||||
|
assert (req["series"], req["volume"]) == ("Georgia", 1)
|
||||||
|
|
||||||
|
|
||||||
def test_relocate_is_a_no_op_when_nothing_changed(client):
|
def test_relocate_is_a_no_op_when_nothing_changed(client):
|
||||||
root = client.tmp_path / "library" / "l"
|
root = client.tmp_path / "library" / "l"
|
||||||
lib_id = client.post("/api/libraries", json={
|
lib_id = client.post("/api/libraries", json={
|
||||||
|
|||||||
@@ -47,6 +47,10 @@ class ImportItem(BaseModel):
|
|||||||
request_id: int
|
request_id: int
|
||||||
# add to an already imported audiobook instead of importing a new one
|
# add to an already imported audiobook instead of importing a new one
|
||||||
append: bool = False
|
append: bool = False
|
||||||
|
# series and volume the download folder names; they win over the request's,
|
||||||
|
# since translations number their series differently from the metadata APIs
|
||||||
|
series: str = ""
|
||||||
|
volume: int | None = None
|
||||||
|
|
||||||
|
|
||||||
class ImportIn(BaseModel):
|
class ImportIn(BaseModel):
|
||||||
@@ -101,9 +105,12 @@ def do_import(data: ImportIn, session: Session = Depends(get_session)):
|
|||||||
" — mehrere Einträge auf dieselbe Anfrage? Dann vorher zusammenfassen."
|
" — mehrere Einträge auf dieselbe Anfrage? Dann vorher zusammenfassen."
|
||||||
)})
|
)})
|
||||||
continue
|
continue
|
||||||
|
if item.series.strip() and item.volume is not None:
|
||||||
|
req.series, req.volume = item.series.strip(), item.volume
|
||||||
try:
|
try:
|
||||||
dest = mover.import_item(item.path, item.files, item.is_dir, req, req.library)
|
dest = mover.import_item(item.path, item.files, item.is_dir, req, req.library)
|
||||||
except Exception as exc:
|
except Exception as exc:
|
||||||
|
session.rollback() # the next commit must not keep the folder's series
|
||||||
results.append({"path": shown, "ok": False, "error": str(exc)})
|
results.append({"path": shown, "ok": False, "error": str(exc)})
|
||||||
continue
|
continue
|
||||||
req.status = "imported"
|
req.status = "imported"
|
||||||
|
|||||||
@@ -126,6 +126,18 @@ def relocate(request, library) -> str:
|
|||||||
_remove_if_empty(src.parent, root)
|
_remove_if_empty(src.parent, root)
|
||||||
return str(dest)
|
return str(dest)
|
||||||
|
|
||||||
|
# one rename keeps the folder's inode, so Audiobookshelf sees a move and keeps
|
||||||
|
# the item; filling a new folder file by file makes it add a new item halfway
|
||||||
|
# and cache whatever cover it saw at that moment
|
||||||
|
moved_from = None
|
||||||
|
if not folder.exists():
|
||||||
|
folder.parent.mkdir(parents=True, exist_ok=True)
|
||||||
|
try:
|
||||||
|
src.rename(folder)
|
||||||
|
moved_from, src = src, folder
|
||||||
|
except OSError:
|
||||||
|
pass # another filesystem, or a target inside the source: file by file
|
||||||
|
|
||||||
audio = sorted(
|
audio = sorted(
|
||||||
(f for f in src.iterdir()
|
(f for f in src.iterdir()
|
||||||
if f.is_file() and f.suffix.lower() in config.AUDIOBOOK_EXTENSIONS),
|
if f.is_file() and f.suffix.lower() in config.AUDIOBOOK_EXTENSIONS),
|
||||||
@@ -173,6 +185,8 @@ def relocate(request, library) -> str:
|
|||||||
shutil.move(str(extra), target)
|
shutil.move(str(extra), target)
|
||||||
if not same_folder:
|
if not same_folder:
|
||||||
_remove_if_empty(src, root)
|
_remove_if_empty(src, root)
|
||||||
|
if moved_from:
|
||||||
|
_remove_if_empty(moved_from.parent, root)
|
||||||
return str(folder)
|
return str(folder)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user