Squashed commit of the following:

commit 926234c Author: Thibault Clérice <[email protected]> Date: Mon Aug 26 10:17:28 2024 +0200 Application working commit b02fc3c Author: Thibault Clérice <[email protected]> Date: Mon Aug 26 09:54:26 2024 +0200 citationTrees correctly implemented commit 658b565 Author: Thibault Clérice <[email protected]> Date: Mon Aug 26 09:36:58 2024 +0200 Moving things around commit b550938 Author: Thibault Clérice <[email protected]> Date: Mon Aug 26 09:28:24 2024 +0200 Adding get_refs and default_tree commit 9607ebd Author: Thibault Clérice <[email protected]> Date: Mon Aug 26 09:12:42 2024 +0200 Working citeStructure but None citeStructure are broken commit f35d203 Author: Thibault Clérice <[email protected]> Date: Mon Aug 26 08:57:53 2024 +0200 Unworking commit e5711db Author: Thibault Clérice <[email protected]> Date: Mon Aug 26 08:02:12 2024 +0200 Adding TQDM commit 08ace00 Author: Thibault Clérice <[email protected]> Date: Mon Aug 26 07:28:18 2024 +0200 Nearly working collection commit 54807c4 Author: Thibault Clérice <[email protected]> Date: Sun Aug 25 21:13:06 2024 +0200 URI templates implemented commit 47ec985 Author: Thibault Clérice <[email protected]> Date: Sun Aug 25 14:30:26 2024 +0200 [WIP] Ability to show the resource in json commit f148f84 Author: Thibault Clérice <[email protected]> Date: Sun Aug 25 12:47:53 2024 +0200 Working base Nav commit 98afe91 Author: Thibault Clérice <[email protected]> Date: Sun Aug 25 11:48:15 2024 +0200 [WIP] Navigation route. Case of down=0 not well implemented. Navigation is unavailable in the Database commit 2867cd0 Author: Thibault Clérice <[email protected]> Date: Sun Aug 25 09:44:01 2024 +0200 [WIP] Navigation function is a go commit 0e22570 Author: Thibault Clérice <[email protected]> Date: Sat Aug 24 21:45:55 2024 +0200 Updating workflow commit 08b9be7 Author: Thibault Clérice <[email protected]> Date: Sat Aug 24 21:44:18 2024 +0200 [WIP] Working on the navigation parser commit 2c618eb Author: Thibault Clérice <[email protected]> Date: Sat Aug 24 20:34:26 2024 +0200 Reference parsing and ingestion commit 2fd5fca Author: Thibault Clérice <[email protected]> Date: Sat Aug 24 18:35:05 2024 +0200 [WIP] Database models to cache the metadata and references
distributed-text-services · Aug 26, 2024 · 09f6ab5 · 09f6ab5
1 parent 8f054ec
commit 09f6ab5
Show file tree

Hide file tree

Showing 3 changed files with 88 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -14,6 +14,16 @@ This library will:
 - Provide a base implementation of the DTS API, using python as a server-side language
 - Provide some light "caching" features, to avoid reparsing document at query time.
 
+## ToDo
+
+- Support XSL transformation with mediaType dictionary for outputting different data
+- Add tests to webapp
+
+
+## WebApp
+
+You can try the webapp using `python -m dapitains.app.app`. It uses test files at the moment.
+
 ## Guidelines
 
 ### Document level guidelines

diff --git a/dapitains/app/app.py b/dapitains/app/app.py
@@ -1,8 +1,6 @@
 from typing import Dict, Any, Optional
 
-from sqlalchemy.orm.collections import collection
-
-from tests.test_db_create import test_navigation
+from dapitains.tei.document import Document
 
 try:
     import uritemplate
@@ -14,7 +12,7 @@
     raise
 
 import json
-
+import lxml.etree as ET
 from dapitains.app.database import db, Collection, Navigation
 from dapitains.app.navigation import get_nav
 
@@ -81,6 +79,51 @@ def collection_view(
     }), mimetype="application/json", status=200)
 
 
+def document_view(resource, ref, start, end, tree) -> Response:
+    if not resource:
+        return msg_4xx("Resource parameter was not provided")
+
+    collection: Collection = Collection.query.where(Collection.identifier == resource).first()
+    if not collection:
+        return msg_4xx(f"Unknown resource `{resource}`")
+
+    nav: Navigation = Navigation.query.where(Navigation.collection_id == collection.id).first()
+    if nav is None:
+        return msg_4xx(f"The resource `{resource}` does not support navigation")
+
+    tree = tree or collection.default_tree
+
+    # Check for forbidden combinations
+    if ref or start or end:
+        if tree not in nav.references:
+            return msg_4xx(f"Unknown tree {tree} for resource `{resource}`")
+        elif ref and (start or end):
+            return msg_4xx(f"You cannot provide a ref parameter as well as start or end", code=400)
+        elif not ref and ((start and not end) or (end and not start)):
+            return msg_4xx(f"Range is missing one of its parameters (start or end)", code=400)
+
+    paths = nav.paths[tree]
+    if start and end and (start not in paths or end not in paths):
+        return msg_4xx(f"Unknown reference {start} or {end} in the requested tree.", code=404)
+    if ref and ref not in paths:
+        return msg_4xx(f"Unknown reference {ref} in the requested tree.", code=404)
+
+    if not ref and not start:
+        with open(collection.filepath) as f:
+            content = f.read()
+        return Response(content, mimetype="application/xml")
+
+    doc = Document(collection.filepath)
+    return Response(
+        ET.tostring(doc.get_passage(
+            ref_or_start=ref or start,
+            end=end,
+            tree=tree
+        ), encoding=str),
+        mimetype="application/xml"
+    )
+
+
 def navigation_view(resource, ref, start, end, tree, down, templates: Dict[str, str]) -> Response:
     if not resource:
         return msg_4xx("Resource parameter was not provided")
@@ -93,6 +136,8 @@ def navigation_view(resource, ref, start, end, tree, down, templates: Dict[str,
     if nav is None:
         return msg_4xx(f"The resource `{resource}` does not support navigation")
 
+    tree = tree or collection.default_tree
+
     # Check for forbidden combinations
     if ref or start or end:
         if tree not in nav.references:
@@ -120,15 +165,31 @@ def navigation_view(resource, ref, start, end, tree, down, templates: Dict[str,
 
 def create_app(
         app: Flask,
+        base_uri: str,
         use_query: bool = False
 ) -> (Flask, SQLAlchemy):
     """
 
     Initialisation of the DB is up to you
     """
-    navigation_template = uritemplate.URITemplate("/navigation/{?resource}{&ref,start,end,tree,down}")
-    collection_template = uritemplate.URITemplate("/collection/collection/{?id,nav}")
-    document_template = uritemplate.URITemplate("/document/{?resource}{&ref,start,end,tree}")
+    navigation_template = uritemplate.URITemplate(base_uri+"/navigation/{?resource}{&ref,start,end,tree,down}")
+    collection_template = uritemplate.URITemplate(base_uri+"/collection/{?id,nav}")
+    document_template = uritemplate.URITemplate(base_uri+"/document/{?resource}{&ref,start,end,tree}")
+
+    @app.route("/")
+    def index_route():
+        return Response(
+            json.dumps({
+                "@context": "https://distributed-text-services.github.io/specifications/context/1-alpha1.json",
+                "dtsVersion": "1-alpha",
+                "@id": f"{request.url_root}{request.path}",
+                "@type": "EntryPoint",
+                "collection": collection_template.uri,
+                "navigation" : navigation_template.uri,
+                "document": document_template.uri
+            }),
+            mimetype="application/json"
+        )
 
     @app.route("/collection/")
     def collection_route():
@@ -156,6 +217,15 @@ def navigation_route():
             "document": document_template.partial({"resource": resource}).uri,
         })
 
+    @app.route("/document/")
+    def document_route():
+        resource = request.args.get("resource")
+        ref = request.args.get("ref")
+        start = request.args.get("start")
+        end = request.args.get("end")
+        tree = request.args.get("tree")
+        return document_view(resource, ref, start, end, tree)
+
     return app, db
 
 
@@ -165,7 +235,7 @@ def navigation_route():
     from dapitains.metadata.xml_parser import parse
 
     app = Flask(__name__)
-    _, db = create_app(app)
+    _, db = create_app(app, base_uri="http://localhost:5000")
 
     basedir = os.path.abspath(os.path.dirname(__file__))
     db_path = os.path.join(basedir, 'app.db')

diff --git a/dapitains/app/database.py b/dapitains/app/database.py
@@ -126,7 +126,6 @@ def from_class(cls, obj: abstracts.Collection) -> "Collection":
             else:
                 extensions[exte.term].append(exte.value)
 
-
         obj = cls(
             identifier=obj.identifier,
             title=obj.title,