Merge pull request #35 from eeditiones/fix/12

next round of refactoring
eeditiones · Oct 12, 2023 · 8bbe9fd · 8bbe9fd
2 parents 2ac3ada + 4cd2919
commit 8bbe9fd
Show file tree

Hide file tree

Showing 28 changed files with 679 additions and 1,181 deletions.
diff --git a/.existdb.json b/.existdb.json
@@ -19,13 +19,13 @@
         ]
     },
     "package": {
-        "author": "Dom&Jörn",
+        "author": "TEI-publisher project team",
         "target": "tuttle",
-        "description": "tuttle - github integration.",
-        "namespace": "http://exist-db.org/apps/tuttle",
-        "website": "http://exist-db.org/apps/tuttle",
+        "description": "Synchronize data with git services",
+        "namespace": "http://e-editiones.org/tuttle",
+        "website": "https://github.com/eeditiones/tuttle",
         "status": "dev",
-        "title": "tuttle - github integration",
+        "title": "tuttle - pull data from git APIs",
         "license": "GPLv3"
     }
 }
diff --git a/src/cleanup.xq b/src/cleanup.xq
@@ -0,0 +1,20 @@
+xquery version "3.1";
+
+declare namespace sm="http://exist-db.org/xquery/securitymanager";
+
+(: TODO: $target is not set in cleanup phase :)
+declare variable $configuration-collection := "/db/apps/tuttle/data/";
+declare variable $backup-collection := "/db/tuttle-backup/"; 
+declare variable $configuration-filename := "tuttle.xml";
+
+(: backup tuttle configuration :)
+if (not(xmldb:collection-available($backup-collection)))
+then ((: move/copy to collection :)
+    util:log("info", "Creating configuration backup collection"),
+    xmldb:create-collection("/db", "tuttle-backup"),
+    sm:chmod(xs:anyURI($backup-collection), "rwxr-x---")
+)
+else ()
+,
+util:log("info", "Backing up configuration"),
+xmldb:move($configuration-collection, $backup-collection, $configuration-filename)
diff --git a/src/controller.xql b/src/controller.xql
@@ -7,16 +7,20 @@ declare variable $exist:controller external;
 declare variable $exist:prefix external;
 declare variable $exist:root external;
 
-if ($exist:path eq "") then
+declare variable $is-get := lower-case(request:get-method()) eq 'get';
+
+if ($is-get and $exist:path eq "") then
     <dispatch xmlns="http://exist.sourceforge.net/NS/exist">
         <redirect url="{request:get-uri()}/"/>
     </dispatch>
 
-(: forward root path to index.xql :)
-else if ($exist:path eq "/") then
+else if ($is-get and $exist:path eq "/") then
     <dispatch xmlns="http://exist.sourceforge.net/NS/exist">
-        <redirect url="index.html"/>
+        <forward url="{$exist:controller}/index.html">
+            <set-header name="Content-Type" value="text/html"/>
+        </forward>
     </dispatch>
+
 else if ($exist:resource eq 'login') then
     let $loggedIn := login:set-user("org.exist.login", (), false())
     let $user := request:get-attribute("org.exist.login.user")
@@ -40,56 +44,15 @@ else if ($exist:resource eq 'login') then
     )
 
 (: static HTML page for API documentation should be served directly to make sure it is always accessible :)
-else if ($exist:path eq "/index.html") then
-    <dispatch xmlns="http://exist.sourceforge.net/NS/exist">
-        <set-header name="Content-Type" value="text/html"/>
-    </dispatch>
-else if ($exist:path eq "/data/tuttle.xml") then
-    <dispatch xmlns="http://exist.sourceforge.net/NS/exist">
-        <forward url="{$exist:controller}/data/tuttle.xml">
-            <set-header name="Cache-Control" value="max-age=31536000"/>
-        </forward>
-    </dispatch>
-else if ($exist:path eq "/api.html" or ends-with($exist:resource, "json")) then
-    <dispatch xmlns="http://exist.sourceforge.net/NS/exist">
-    </dispatch>
-
-(: other images are resolved against the data collection and also returned directly :)
-else if (matches($exist:resource, "\.(css)$", "s")) then
-    <dispatch xmlns="http://exist.sourceforge.net/NS/exist">
-    </dispatch>
+else if ($is-get and $exist:path = ("/api.html", "/api.json")) then
+    <dispatch xmlns="http://exist.sourceforge.net/NS/exist" />
 
-else if (matches($exist:resource, "\.(js)$", "s")) then
+(: serve static resources :)
+else if ($is-get and matches($exist:path, "^/(css|js|images)/[^/]+\.(css|js(\.map)?|svg|jpg|png)$")) then
     <dispatch xmlns="http://exist.sourceforge.net/NS/exist">
-    </dispatch>
-
-else if (matches($exist:resource, "\.(js.map)$", "s")) then
-    <dispatch xmlns="http://exist.sourceforge.net/NS/exist">
-    </dispatch>
-
-else if (matches($exist:resource, "\.(png)$", "s")) then
-    <dispatch xmlns="http://exist.sourceforge.net/NS/exist">
-    </dispatch>
-else if (matches($exist:resource, "\.(svg)$", "s")) then
-    <dispatch xmlns="http://exist.sourceforge.net/NS/exist">
-    </dispatch>
-
-else if (matches($exist:resource, "\.(png|jpg|jpeg|gif|tif|tiff|txt|mei|js)$", "s")) then
-    <dispatch xmlns="http://exist.sourceforge.net/NS/exist">
-        <forward url="{$exist:controller}/data/{$exist:path}">
-            <set-header name="Cache-Control" value="max-age=31536000"/>
-        </forward>
-    </dispatch>
-
-(: use a different Open API router, needs exist-jwt installed! :)
-else if (starts-with($exist:path, '/jwt')) then
-    <dispatch xmlns="http://exist.sourceforge.net/NS/exist">
-        <forward url="{$exist:controller}/modules/custom-router.xq">
-            <set-header name="Access-Control-Allow-Origin" value="*"/>
-            <set-header name="Access-Control-Allow-Credentials" value="true"/>
-            <set-header name="Access-Control-Allow-Methods" value="GET, POST, DELETE, PUT, PATCH, OPTIONS"/>
-            <set-header name="Access-Control-Allow-Headers" value="Accept, Content-Type, Authorization, X-Auth-Token"/>
-            <set-header name="Cache-Control" value="no-cache"/>
+        <forward url="{$exist:controller}/resources/{$exist:path}">
+            <set-header name="Cache-Control" value="max-age=2419200, must-revalidate, stale-while-revalidate=86400"/>
+            <!-- <set-header name="Cache-Control" value="max-age=31536000"/> -->
         </forward>
     </dispatch>
 
@@ -103,4 +66,4 @@ else
             <set-header name="Access-Control-Allow-Headers" value="Accept, Content-Type, Authorization, X-Start"/>
             <set-header name="Cache-Control" value="no-cache"/>
         </forward>
-    </dispatch>
+    </dispatch>
diff --git a/src/data/tuttle-example-config.xml b/src/data/tuttle-example-config.xml
@@ -0,0 +1,73 @@
+<tuttle>
+  <repos>
+    <collection name="tuttle-sample-data">
+        <!-- optional: make _one_ repository the default
+            for endpoints without {collection}
+        -->
+        <default>true</default>
+
+        <!-- which sercive to connect to -->
+        <type>github</type>
+        <baseurl>https://api.github.com/</baseurl>
+
+        <!-- necessary to provide for GitHub -->
+        <owner>eeditiones</owner>
+        <repo>tuttle-sample-data</repo>
+
+        <!-- branch to pull from -->
+        <ref>next</ref>
+
+        <!-- authenticate against remote service,
+            can also be read from environment variables -->
+        <token>XXX</token>
+
+        <!-- only necessary if you need the service to call tuttle -->
+        <hookuser>admin</hookuser>
+        <hookpasswd></hookpasswd>
+    </collection>
+
+   <collection name="tuttle-sample-gitlab">
+        <!-- which sercive to connect to -->
+        <type>gitlab</type>
+        <baseurl>https://gitlab.com/api/v4/</baseurl>
+
+        <!-- this is not needed for Gitlab but can be added for human consumption -->
+        <owner>line-o</owner>
+        <repo>tuttle-sample-data</repo>
+
+        <!-- necessary to provide for Gitlab -->
+        <project-id>50872175</project-id>
+
+        <!-- branch to pull from -->
+        <ref>main</ref>
+
+        <!-- authenticate against remote service,
+            can also be read from environment variables -->
+        <token>XXX</token>
+
+        <!-- only necessary if you need the service to call tuttle -->
+        <hookuser>admin</hookuser>
+        <hookpasswd></hookpasswd>
+    </collection>
+  </repos>
+
+  <!-- these files will not be extracted from archives and left untouched when cleaning up -->
+  <ignore>
+      <file>existdb.json</file>
+      <file>build.xml</file>
+      <file>README.md</file>
+      <file>.gitignore</file>
+      <file>expath-pkg.xml.tmpl</file>
+      <file>repo.xml.tmpl</file>
+      <file>build.properties.xml</file>
+  </ignore>
+
+  <!-- prefix, suffix, lock and apikeys can usually be left as-is -->
+  <config prefix="/db/apps/" suffix="-stage" lock="git-lock.xml" apikeys="/db/system/auth/tuttle-token.xml">
+    <!-- 
+      The permissions the deployed data gets assigned, if no expath-pkg.xml is found.
+      The initial setting is safe, but this can and should be adapted to your requirements. 
+    -->
+    <sm user="admin" group="dba" mode="rw-r-----"/>
+  </config>
+</tuttle>
diff --git a/src/data/tuttle.xml b/src/data/tuttle.xml
diff --git a/src/demo.css b/src/demo.css
diff --git a/src/expath-pkg.xml b/src/expath-pkg.xml
@@ -1,11 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<package 
-  xmlns="http://expath.org/ns/pkg"
-  name="http://e-editiones.org/tuttle"
-  abbrev="tuttle" version="1.2.0" spec="1.0">
-  <title>Tuttle - Git for eXist-db</title>
-  <dependency processor="http://exist-db.org" semver-min="5.5.1"/>
-  <dependency package="http://e-editiones.org/roaster" semver-min="1.0.0"/>
-  <dependency package="http://exist-db.org/apps/shared" semver-min="0.9.1"/>
-  <dependency package="http://expath.org/ns/crypto" semver-min="5.0.0"/>
+<package xmlns="http://expath.org/ns/pkg" spec="1.0"
+        name="http://e-editiones.org/tuttle" abbrev="tuttle" version="2.0.0">
+    <title>Tuttle - Git for eXist-db</title>
+    <dependency processor="http://exist-db.org" semver-min="5.5.1" semver-max="6" />
+    <dependency package="http://e-editiones.org/roaster" semver-min="1.0.0"/>
+    <dependency package="http://expath.org/ns/crypto" semver-min="5.0.0"/>
 </package>
diff --git a/src/finish.xq b/src/finish.xq
@@ -0,0 +1,32 @@
+xquery version "3.1";
+
+declare namespace sm="http://exist-db.org/xquery/securitymanager";
+
+(: the target collection into which the app is deployed :)
+declare variable $target external;
+
+declare variable $configuration-collection := $target || "/data/";
+declare variable $backup-collection := "/db/tuttle-backup/"; 
+declare variable $configuration-filename := "tuttle.xml";
+
+(: look for backed up tuttle configuration :)
+if (doc-available($backup-collection || $configuration-filename))
+then ((: move/copy to collection :)
+    util:log("info", "Restoring tuttle configuration from backup."),
+    xmldb:move($backup-collection, $configuration-collection, $configuration-filename),
+    xmldb:remove($backup-collection)
+)
+else ((: copy example configuration when no backup was found :)
+    util:log("info", "No previous tuttle configuration found."),
+    xmldb:copy-resource(
+        $configuration-collection, "tuttle-example-config.xml",
+        $configuration-collection, $configuration-filename
+    )
+)
+,
+(: tighten security for configuration file :)
+sm:chmod(xs:anyURI($configuration-collection || $configuration-filename), "rw-r-----")
+,
+(: set gid for API :)
+sm:chmod(xs:anyURI($target || "/modules/api.xql"), "rwxr-sr-x")
+