add option display_subtitle

Author: URenko

comiclib/config.py

@@ -15,6 +15,7 @@ class Settings(BaseSettings):
     password: Union[str, None] = None
     skip_exits: bool = True
     watch: bool = True
+    display_subtitle: bool = True
     UA_convert_jxl: str = 'Android'
     UA_convert_all: str = r'\b\B'  # default: match nothing
 

comiclib/main.py

@@ -72,6 +72,9 @@ async def verify_token(request: Request):
 else:
     authorization = [Depends(verify_token)]
 
+def display_title(a: Archive) -> str:
+    return a.subtitle if settings.display_subtitle and not a.subtitle is None else a.title
+
 # https://sugoi.gitbook.io/lanraragi/v/dev/api-documentation/getting-started
 
 # Search API
@@ -122,7 +125,7 @@ def do_search(db: Session, category: str, filters: str, order: Union[OrderingDir
         stmt = stmt.offset(start)
     return [
         {"arcid": a.id, "isnew": "none", "extension": Path(
-            a.path).suffix, "tags": ", ".join(map(lambda t: t.tag, a.tags)), "title": a.title}
+            a.path).suffix, "tags": ", ".join(map(lambda t: t.tag, a.tags)), "title": display_title(a)}
         for a in db.scalars(stmt)
     ], recordsFiltered, recordsTotal
 
@@ -171,7 +174,7 @@ def handle_datatables(request: Request, draw: int, start: int, length: int, filt
 def get_all_archives(db: Session = Depends(get_db)):
     data = [
         {"arcid": a.id, "isnew": "none", "extension": Path(
-            a.path).suffix, "pagecount": a.pagecount, "progress": 0, "tags": ", ".join(map(lambda t: t.tag, a.tags)), "title": a.title}
+            a.path).suffix, "pagecount": a.pagecount, "progress": 0, "tags": ", ".join(map(lambda t: t.tag, a.tags)), "title": display_title(a)}
         for a in db.scalars(select(Archive))
     ]
     return {"data": data}
@@ -187,12 +190,17 @@ def get_archive_metadata(id: str, db: Session = Depends(get_db)):
     a = db.get(Archive, id)
     if a is None:
         return JSONResponse({"operation": "metadata", "error": "This ID doesn't exist on the server.", "success": 0}, status.HTTP_400_BAD_REQUEST)
-    return {"arcid": a.id, "isnew": "false", "pagecount": a.pagecount, "progress": 1, "tags": ", ".join(map(lambda t: t.tag, a.tags)), "title": a.title}
+    return {"arcid": a.id, "isnew": "false", "pagecount": a.pagecount, "progress": 1, "tags": ", ".join(map(lambda t: t.tag, a.tags)), "title": display_title(a)}
 
 
 @app.put("/api/archives/{id}/metadata", dependencies=authorization)
 def update_archive_metadata(id: str, title: Annotated[str, Form()], tags: Annotated[str, Form()], db: Session = Depends(get_db)):
-    db.execute(update(Archive).where(Archive.id == id).values(title=title))
+    if settings.display_subtitle:
+        a = db.get(Archive, id)
+        if not (a.title == title or a.subtitle == title):
+            return {"operation": "update_metadata", "error": "You are using a non-standard title display mode, and there is ambiguity in modifying the title.", "success": 0}
+    else:
+        db.execute(update(Archive).where(Archive.id == id).values(title=title))
     db.execute(delete(Tag).where(Tag.archive_id == id))
     db.add_all(map(lambda t: Tag(archive_id=id, tag=t.strip()), tags.split(',')))
     db.commit()

docs/en/docs/settings.md

@@ -35,6 +35,7 @@ The following is a list of available settings:
 | `password` | Admin password (also used as API Key currently) [^1]. If it is `None`, any visitor will have editing permissions. This feature is designed to protect against gentlemen but not villains. If you need security protection, please use e.g. the HTTP basic authentication of the reverse proxy, Cloudflare Access or TLS client certificate, etc. | `None`|
 | `skip_exists`| Skip comics that have been scanned into the metadata database during scanning? (`True`/`False`) | `True` |
 | `watch` | Monitor comic folders and automatically scan (`True`/`False`) | `True` |
+| `display_subtitle` | Display subtitles instead of main titles if available. The title cannot be edited in this mode. | `True` |
 | `UA_convert_jxl` | For requests with matched user-agent, convert JPEG XL files to other popular formats on the server side. The value is a regular expression. | `Android` |
 | `UA_convert_all` | For requests with matched user-agent, convert all files to other popular formats on the server side. The value is a regular expression. | `\b\B` (will not match anything) |
 

docs/zh/docs/settings.md

@@ -35,6 +35,7 @@
 | `password` | 管理密码（目前也用作 API 密钥）[^1]，若为`None`则任何访客皆可编辑。此功能防君子不防小人，若需安全保护请借助反向代理的 HTTP 基本验证、Cloudflare Access 或 TLS 客户端证书等。| `None`|
 | `skip_exists`| 扫描时是否跳过曾扫入元数据库的漫画？（`True`/`False`）| `True` |
 | `watch` | 监视漫画文件夹，自动扫描 （`True`/`False`）| `True` |
+| `display_subtitle` | 展现子标题（如果有）而不是主标题。该模式下无法编辑标题。 | `True` |
 | `UA_convert_jxl` | 对于哪些 user-agent 的请求在服务端将 JPEG XL 文件转为其他流行格式，该值是一个用于匹配的正则表达式 | `Android` |
 | `UA_convert_all` | 对于哪些 user-agent 的请求在服务端将所有文件转为其他流行格式，该值是一个用于匹配的正则表达式 | `\b\B`（不匹配任何东西）|