add OCR button in UI (#566)

Author: ciur

docker/standard/Dockerfile

@@ -31,6 +31,7 @@ RUN apk update && apk add linux-headers python3-dev \
 
 RUN pip install --upgrade poetry roco==0.4.2
 RUN curl -L -o /bin/env2js https://github.com/papermerge/env2js/releases/download/0.2/env2js.amd64
+RUN chmod +x /bin/env2js
 
 COPY poetry.lock pyproject.toml README.md LICENSE ${CORE_APP}/
 

docker/standard/entrypoint.sh

@@ -57,13 +57,17 @@ case $CMD in
     exec_init
     # TODO: replace roco with env2js
     roco > /usr/share/nginx/html/auth_server/papermerge-runtime-config.js
+    # Once user options endpoint is implemented, following two lines will removed
     /bin/env2js -f /core_app/core.js.tmpl > /usr/share/nginx/html/ui/papermerge-runtime-config.js
+    sed -i '/Papermerge/a  <script type="module" src="/papermerge-runtime-config.js"></script>' /usr/share/nginx/html/ui/index.html
     exec /usr/bin/supervisord -c /etc/papermerge/supervisord.conf
     ;;
   server_without_init)
     # TODO: replace roco with env2js
     roco > /usr/share/nginx/html/auth_server/papermerge-runtime-config.js
+    # Once user options endpoint is implemented, following two lines will removed
     /bin/env2js -f /core_app/core.js.tmpl > /usr/share/nginx/html/ui/papermerge-runtime-config.js
+    sed -i '/Papermerge/a  <script type="module" src="/papermerge-runtime-config.js"></script>' /usr/share/nginx/html/ui/index.html
     exec /usr/bin/supervisord -c /etc/papermerge/supervisord.conf
     ;;
   create_token.sh)

papermerge/app.py

@@ -20,6 +20,7 @@
 )
 from papermerge.core.features.liveness_probe.router import router as probe_router
 from papermerge.search.routers.search import router as search_router
+from papermerge.core.features.tasks.router import router as tasks_router
 
 from papermerge.core.version import __version__
 from papermerge.core.config import get_settings
@@ -49,6 +50,7 @@
 app.include_router(tags_router, prefix=prefix)
 app.include_router(groups_router, prefix=prefix)
 app.include_router(probe_router, prefix=prefix)
+app.include_router(tasks_router, prefix=prefix)
 
 if config.papermerge__search__url:
     app.include_router(search_router, prefix=prefix)

papermerge/core/features/nodes/router.py

@@ -95,7 +95,7 @@ def create_node(
         # if user does not specify document's language, get that
         # value from user preferences
         if pynode.lang is None:
-            pynode.lang = settings.papermerge__ocr__default_language
+            pynode.lang = settings.papermerge__ocr__default_lang_code
 
         attrs = dict(
             title=pynode.title,

papermerge/core/features/tasks/router.py

@@ -0,0 +1,35 @@
+from typing import Annotated
+
+from fastapi import APIRouter, Security
+
+from papermerge.core import constants, schema, utils
+from papermerge.core.features.auth import get_current_user, scopes
+from papermerge.core import tasks
+
+from .schema import OCRTaskIn
+
+router = APIRouter(
+    prefix="/tasks",
+    tags=["tasks"],
+)
+
+
+@router.post("/ocr")
+@utils.docstring_parameter(scope=scopes.TASK_OCR)
+def start_ocr(
+    ocr_task: OCRTaskIn,
+    user: Annotated[schema.User, Security(get_current_user, scopes=[scopes.TASK_OCR])],
+):
+    """Triggers OCR for specific document
+
+    Required scope: `{scope}`
+    """
+
+    tasks.send_task(
+        constants.WORKER_OCR_DOCUMENT,
+        kwargs={
+            "document_id": str(ocr_task.document_id),
+            "lang": ocr_task.lang,
+        },
+        route_name="ocr",
+    )

papermerge/core/features/tasks/schema.py

@@ -0,0 +1,34 @@
+from typing import Literal
+from uuid import UUID
+
+from pydantic import BaseModel
+
+LangCode = Literal[
+    "ces",
+    "dan",
+    "deu",
+    "ell",
+    "eng",
+    "fas",
+    "fin",
+    "fra",
+    "guj",
+    "heb",
+    "hin",
+    "ita",
+    "jpn",
+    "kor",
+    "lit",
+    "nld",
+    "nor",
+    "pol",
+    "por",
+    "ron",
+    "san",
+    "spa",
+]
+
+
+class OCRTaskIn(BaseModel):
+    document_id: UUID  # document model ID
+    lang: LangCode

papermerge/core/routers/tasks.py

@@ -9,7 +9,6 @@
   <body>
     <div id="root"></div>
     <div id="modals"></div>
-    <script type="module" src="/papermerge-runtime-config.js"></script>
     <script type="module" src="/src/main.tsx"></script>
   </body>
 </html>