add option display_title_format

Author: URenko

comiclib/config.py

@@ -1,5 +1,5 @@
 from pydantic_settings import BaseSettings
-from typing import Union
+from typing import Union, Optional
 import re
 import logging
 
@@ -15,7 +15,8 @@ class Settings(BaseSettings):
     password: Union[str, None] = None
     skip_exits: bool = True
     watch: bool = True
-    display_subtitle: bool = True
+    display_title_format: Optional[str] = None
+    display_subtitle: Optional[bool] = None
     UA_convert_jxl: str = 'Android'
     UA_convert_all: str = r'\b\B'  # default: match nothing
 
@@ -31,6 +32,9 @@ class Settings(BaseSettings):
                     level=numeric_level)
 logger.debug(settings)
 
+if settings.display_subtitle is not None:
+    logger.warning('The environment variable display_subtitle is deprecated and will be removed in the future. Please use display_title_format instead.')
+
 settings.UA_convert_jxl = re.compile(settings.UA_convert_jxl)
 settings.UA_convert_all = re.compile(settings.UA_convert_all)
 if settings.thumb is None:

comiclib/main.py

@@ -76,7 +76,10 @@ async def verify_token(request: Request):
     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
+    if settings.display_title_format is None:
+        return a.title
+    else:
+        return settings.display_title_format.replace('{title}', a.title).replace('{subtitle}', '' if a.subtitle is None else a.subtitle).replace('{path}', a.path).replace(r'\n', '\n')
 
 # https://sugoi.gitbook.io/lanraragi/v/dev/api-documentation/getting-started
 
@@ -198,7 +201,7 @@ def get_archive_metadata(id: str, db: Session = Depends(get_db)):
 
 @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)):
-    if settings.display_subtitle:
+    if settings.display_title_format is not None:
         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}

docs/en/docs/getting-started.md

@@ -125,11 +125,11 @@ For more settings, please refer to [Gunicorn's documentation](https://docs.gunic
 
 In the end your command might look like this (my personal use case):
 ``` bash
-CONTENT=../mycomics/ thumb=/tmp/thumb/ gunicorn comiclib.main:app --worker-class uvicorn.workers.UvicornWorker --bind unix:/tmp/comiclib.sock --preload --workers 4
+CONTENT=../mycomics/ thumb=/tmp/thumb/ display_title_format='{subtitle}\n{title}\n{path}' gunicorn comiclib.main:app --worker-class uvicorn.workers.UvicornWorker --bind unix:/tmp/comiclib.sock --preload --workers 4
 ```
 or
 ``` bash
-importEHdb_matchtorrent=False importEHdb_matchtitle=False CONTENT=../mycomics/ thumb=/tmp/thumb/ uvicorn comiclib.main:app --uds /tmp/comiclib.sock --reload --log-level trace
+importEHdb_matchtorrent=False importEHdb_matchtitle=False CONTENT=../mycomics/ thumb=/tmp/thumb/ display_title_format='{subtitle}\n{title}\n{path}' uvicorn comiclib.main:app --uds /tmp/comiclib.sock --reload --log-level trace
 ```
 for debugging.
 Then use Nginx to reverse proxy to HTTPS connection.

docs/en/docs/settings.md

@@ -35,7 +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` |
+| `display_title_format` | This string specifies the format of the display title.  `{title}`, `{subtitle}`, `{path}` can be used as a placeholder. `\n` will be escaped as a newline. Title cannot be edited while this is set. | `None` (original title) |
 | `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/getting-started.md

@@ -125,11 +125,11 @@ gunicorn comiclib.main:app --worker-class uvicorn.workers.UvicornWorker --bind 0
 
 最后你的命令可能会像这样（我的个人用例）：
 ``` bash
-CONTENT=../mycomics/ thumb=/tmp/thumb/ gunicorn comiclib.main:app --worker-class uvicorn.workers.UvicornWorker --bind unix:/tmp/comiclib.sock --preload --workers 4
+CONTENT=../mycomics/ thumb=/tmp/thumb/ display_title_format='{subtitle}\n{title}\n{path}' gunicorn comiclib.main:app --worker-class uvicorn.workers.UvicornWorker --bind unix:/tmp/comiclib.sock --preload --workers 4
 ```
 或者
 ``` bash
-importEHdb_matchtorrent=False importEHdb_matchtitle=False CONTENT=../mycomics/ thumb=/tmp/thumb/ uvicorn comiclib.main:app --uds /tmp/comiclib.sock --reload --log-level trace
+importEHdb_matchtorrent=False importEHdb_matchtitle=False CONTENT=../mycomics/ thumb=/tmp/thumb/ display_title_format='{subtitle}\n{title}\n{path}' uvicorn comiclib.main:app --uds /tmp/comiclib.sock --reload --log-level trace
 ```
 用于调试。
 然后通过 Nginx 反代为 HTTPS 连接。

docs/zh/docs/settings.md

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