Sets up project

zentrum-lexikographie · Jul 10, 2024 · 4e06a30 · 4e06a30
commit 4e06a30
Show file tree

Hide file tree

Showing 17 changed files with 1,118 additions and 0 deletions.
diff --git a/.dir-locals.el b/.dir-locals.el
@@ -0,0 +1,7 @@
+;;; Directory Local Variables
+;;; For more information see (info "(emacs) Directory Variables")
+
+((clojure-mode . ((cider-preferred-build-tool . clojure-cli)
+                  (cider-clojure-cli-aliases . ":dev:test")
+                  (cider-ns-refresh-before-fn . "user/halt")
+                  (cider-ns-refresh-after-fn . "user/go"))))
diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1,4 @@
+*
+!deps.edn
+!resources/
+!src/
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -0,0 +1,25 @@
+name: Tests
+
+on: [push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/[email protected]
+
+      - name: Prepare java
+        uses: actions/[email protected]
+        with:
+          distribution: 'temurin'
+          java-version: '21'
+
+      - name: Install clojure tools-deps
+        uses: DeLaGuardo/[email protected]
+        with:
+          cli: 1.11.2.1446
+
+      - name: Execute tests
+        run: clojure -X:test
+        shell: bash
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,6 @@
+.env
+
+.nrepl-port
+.cpcache/
+
+*.temp
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,12 @@
+FROM clojure:temurin-21-alpine
+
+RUN mkdir -p /ddc-fcs
+WORKDIR /ddc-fcs
+
+COPY deps.edn /ddc-fcs/
+RUN clojure -P
+
+COPY ./ /ddc-fcs
+
+# "-XX:+UseContainerSupport", "-XX:MaxRAMPercentage=90"
+ENTRYPOINT ["clojure", "-X", "ddc.fcs/serve"]
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
diff --git a/README.md b/README.md
@@ -0,0 +1,18 @@
+# DDC-FCS
+
+_API gateway connecting ZDL's linguistic corpora to the Federated
+Content Search (FCS) of CLARIN and Text+_
+
+## Prerequisites
+
+* [Docker](https://docs.docker.com/get-docker/): The API gateway is
+  implemented in Clojure and is deployed as a Docker container.
+
+## Deployment
+
+    DOCKER_HOST="ssh://clarin.bbaw.de" DDC_FCS_RESTART=unless-stopped\
+        docker compose up --build -d
+
+## License
+
+This project is licensed under the GNU Lesser General Public License v3.0.
diff --git a/compose.yml b/compose.yml
@@ -0,0 +1,14 @@
+services:
+  ddc-fcs:
+    image: ${CI_REGISTRY_IMAGE:-gremid}/ddc-fcs:${CI_COMMIT_SHORT_SHA:-latest}
+    build:
+      context: .
+    restart: ${DDC_FCS_RESTART:-no}
+    environment:
+      - "DDC_FCS_HTTP_PROTOCOL=https"
+      - "DDC_FCS_HTTP_HOST=clarin.bbaw.de"
+      - "DDC_FCS_HTTP_PORT=443"
+      - "DDC_FCS_HTTP_CONTEXT_PATH=/fcs"
+      - "DDC_FCS_HTTP_SERVER_PORT=9090"
+    ports:
+      - "9090:9090"
diff --git a/deps.edn b/deps.edn
@@ -0,0 +1,23 @@
+{:paths     ["src" "resources"]
+ :deps      {org.clojure/clojure                     {:mvn/version "1.11.1"}
+             org.clojure/data.csv                    {:mvn/version "1.1.0"}
+             com.github.igrishaev/virtuoso           {:mvn/version "0.1.0"}
+             hato/hato                               {:mvn/version "0.9.0"}
+             com.cnuernber/charred                   {:mvn/version "1.034"}
+             lambdaisland/uri                        {:mvn/version "1.16.134"}
+             io.github.cdimascio/dotenv-java         {:mvn/version "3.0.0"}
+             babashka/fs                             {:mvn/version "0.5.21"}
+             io.github.gremid/clj-xml                {:git/sha "6e0c723aea0f282219daa3e603acfe07011cfeb6"}
+             com.taoensso/timbre                     {:mvn/version "6.3.1"}
+             com.fzakaria/slf4j-timbre               {:mvn/version "0.4.1"}
+             org.eclipse.jetty.ee8/jetty-ee8-servlet {:mvn/version "12.0.10"}
+             eu.clarin.sru.fcs/fcs-simple-endpoint   {:mvn/version "1.7.0"}}
+ :aliases   {:dev  {:extra-paths ["dev"]
+                    :extra-deps  {org.clojure/tools.namespace {:mvn/version "1.4.4"}}}
+             :test {:extra-paths ["test"]
+                    :extra-deps  {lambdaisland/kaocha {:mvn/version "1.87.1366"}}
+                    :exec-fn     kaocha.runner/exec-fn}}
+ :mvn/repos {"clarin"           {:url       "https://nexus.clarin.eu/content/repositories/Clarin"
+                                 :snapshots {:enabled false}}
+             "clarin-snapshots" {:url       "https://nexus.clarin.eu/content/repositories/clarin-snapshot"
+                                 :snapshots {:enabled true}}}}
diff --git a/dev/user.clj b/dev/user.clj
@@ -0,0 +1,40 @@
+(ns user
+  (:require
+   [clojure.tools.namespace.repl :as repl :refer [set-refresh-dirs]]
+   [ddc.fcs]))
+
+(set-refresh-dirs "dev" "src" "test")
+
+(defn start!
+  []
+  (let [stop-server! (ddc.fcs/start!)]
+    (fn [] (stop-server!))))
+
+(def stop!
+  nil)
+
+(defn go
+  []
+  (alter-var-root #'stop! (constantly (start!))))
+
+(defn halt
+  []
+  (when stop!
+    (stop!)
+    (alter-var-root #'stop! (constantly nil))))
+
+(defn reset
+  []
+  (halt)
+  (repl/refresh :after 'user/go))
+
+(defn reset-all
+  []
+  (halt)
+  (repl/refresh-all :after 'user/go))
+
+(comment
+  (go)
+  (halt)
+  (reset)
+  (reset-all))
diff --git a/resources/corpus-metadata.csv b/resources/corpus-metadata.csv
@@ -0,0 +1,12 @@
+Corpus,PID,URL,Title (de),Title (en),Author (de),Author (en),Description (de),Description (en)
+bz,http://hdl.handle.net/11858/00-203C-0000-0029-C1C8-D,https://www.dwds.de/r?corpus=bz,Berliner Zeitung (1994–2005),Berliner Zeitung (1994–2005),"DWDS + CLARIN-D, Berlin-Brandenburgische Akademie der Wissenschaften","DWDS + CLARIN-D, Berlin-Brandenburg Academy of Sciences and Humanities",Berliner Zeitung (1994–2005) – Zeitungsarchiv an der Berlin-Brandenburgische Akademie der Wissenschaften.,Berliner Zeitung (1994–2005) – Newspaper archive at the Berlin-Brandenburg Academy of Sciences and Humanities.
+c4,http://hdl.handle.net/11858/00-203C-0000-0023-EAB2-D,https://www.korpus-c4.org,Korpus C4,Corpus C4,"Deutsches Textarchiv + CLARIN-D, Berlin-Brandenburgische Akademie der Wissenschaften","German Text Archive + CLARIN-D, Berlin-Brandenburg Academy of Sciences and Humanities","Gemeinsames Korpus des Digitalen Wörterbuchs der deutschen Sprache des 20. Jahrhunderts (DWDS), des Austrian Academy Corpus (AAC), des Korpus Südtirol und des Schweizer Textkorpus (CHTK).","Joint text corpus drawn from the Digital Dictionary of 20th-Century German (DWDS), the Austrian Academy Corpus (AAC), the Korpus Südtirol, and the Schweizer Textkorpus (CHTK)."
+dingler,http://hdl.handle.net/11858/00-203C-0000-0023-8325-E,http://www.dinglr.de,Polytechnisches Journal (Dingler Online),Polytechnical Journal (Dingler Online),"Deutsches Textarchiv + CLARIN-D, Berlin-Brandenburgische Akademie der Wissenschaften","German Text Archive + CLARIN-D, Berlin-Brandenburg Academy of Sciences and Humanities",Textbestand des Polytechnisches Journals (Dingler Online) an der BBAW CLARIN-D Service Centre.,Text corpus of the Polytechnical Journal (Dingler Online) at the BBAW CLARIN-D Service Centre.
+dta,http://hdl.handle.net/11858/00-203C-0000-0023-8324-0,https://www.deutschestextarchiv.de,Deutsches Textarchiv (DTA),German Text Archive (DTA),"Deutsches Textarchiv + CLARIN-D, Berlin-Brandenburgische Akademie der Wissenschaften","German Text Archive + CLARIN-D, Berlin-Brandenburg Academy of Sciences and Humanities",Deutsches Textarchiv (DTA) – Grundlage für ein Referenzkorpus der neuhochdeutschen Sprache.,German Text Archive (DTA) – Basis for a reference corpus of the New High German language.
+grenzboten,http://hdl.handle.net/11858/00-203C-0000-002E-1DFC-8,https://brema.suub.uni-bremen.de/grenzboten/,Die Grenzboten,Die Grenzboten (“Messengers from the Borders”),"Staats- und Universitätsbibliothek Bremen, Deutsches Textarchiv + CLARIN-D, Berlin-Brandenburgische Akademie der Wissenschaften","State and University Library Bremen, German Text Archive + CLARIN-D, Berlin-Brandenburg Academy of Sciences and Humanities",Die Grenzboten (1841–1922) – digitalisierte Zeitschrift aus dem Bestand der Staats- und Universitätsbibliothek Bremen.,Die Grenzboten (“Messengers from the Borders”) (1841–1922) – digitized periodical from the archives of the State and University Library Bremen.
+ibk_dchat,http://hdl.handle.net/11858/00-203C-0000-002E-1DFD-6,https://www.chatkorpus.tu-dortmund.de,Dortmunder Chat-Korpus,Dortmund Chat Corpus,"Textkorpus erstellt von Prof. Dr. Angelika Storrer und Dr. Michael Beißwenger, Institut für deutsche Sprache und Literatur der Technischen Universität Dortmund. Korpusindex und FCS-Endpoint bereitgestellt vom Deutschen Textarchiv und CLARIN-D, Berlin-Brandenburgische Akademie der Wissenschaften.","Corpus compiled by Prof. Dr. Angelika Storrer and Dr. Michael Beißwenger, Institut for the German Language and Technical University Dortmund. Corpus index and FCS endpoint provided by the German Text Archive and CLARIN-D, Berlin-Brandenburg Academy of Sciences and Humanities.",Dortmunder Chat-Korpus – Grundlage und Hilfsmittel für sprachwissenschaftliche Untersuchungen zur synchronen internetbasierten Kommunikation.,Dortmund Chat Corpus – Basis for and aid to linguistic investigations of synchronic internet-based communication.
+kern,http://hdl.handle.net/11858/00-203C-0000-0029-C1CA-9,https://www.dwds.de/r?corpus=kern,DWDS-Kernkorpus,DWDS-Kernkorpus,"DWDS + CLARIN-D, Berlin-Brandenburgische Akademie der Wissenschaften","DWDS + CLARIN-D, Berlin-Brandenburg Academy of Sciences and Humanities","Das DWDS-Kernkorpus des 20. Jahrhunderts an der Berlin-Brandenburgischen Akademie der Wissenschaften ist ein zeitlich und nach Textsorten (Belletristik, Gebrauchsliteratur, Wissenschaft, journalistische Prosa) ausgewogenes Korpus des gesamten 20. Jahrhunderts. Textgrundlage sind Werke der Literatur, wissenschaftliche Texte, Gebrauchstexte und Zeitungstexte, die in einem ausgewogenen Verhältnis zueinander stehen.",DWDS-Kernkorpus – balanced corpus of 20th-century German at the Berlin-Brandenburg Academy of Sciences and Humanities.
+rem,http://hdl.handle.net/11858/00-203C-0000-002E-1DFB-A,https://www.deutschestextarchiv.de/rem/,Referenzkorpus Mittelhochdeutsch (ReM),Reference Corpus of Middle High German (ReM),"Textkorpus erstellt und annotiert von Thomas Klein, Klaus-Peter Wegera, Stefanie Dipper, und Claudia Wich-Reif. Korpusindex und FCS-Endpoint bereitgestellt vom Deutschen Textarchiv und CLARIN-D, Berlin-Brandenburgische Akademie der Wissenschaften.","Corpus compiled and annotated by Thomas Klein, Klaus-Peter Wegera, Stefanie Dipper, und Claudia Wich-Reif. Corpus index and FCS endpoint provided by the German Text Archive and CLARIN-D, Berlin-Brandenburg Academy of Sciences and Humanities.",Referenzkorpus Mittelhochdeutsch (ReM) – ein Korpus diplomatisch transkribierter und annotierter Texte des Mittelhochdeutschen (1050–1350).,Reference Corpus of Middle High German (ReM) – a corpus of diplomatically transcribed and annotated texts from Middle High German (1050–1350).
+tsp,http://hdl.handle.net/11858/00-203C-0000-0029-C1C9-B,https://www.dwds.de/r?corpus=tsp,Tagesspiegel,Tagesspiegel,"DWDS + CLARIN-D, Berlin-Brandenburgische Akademie der Wissenschaften","DWDS + CLARIN-D, Berlin-Brandenburg Academy of Sciences and Humanities",Tagesspiegel – Zeitungsarchiv an der Berlin-Brandenburgischen Akademie der Wissenschaften.,Tagesspiegel – Newspaper archive at the Berlin-Brandenburg Academy of Sciences and Humanities.
+dwdsxl,http://hdl.handle.net/21.11120/0000-000F-D5E7-C,https://www.dwds.de/d/korpora/dwdsxl,DWDS – Gegenwartskorpora,DWDS – Contemporary Corpora,"DWDS, Berlin-Brandenburgische Akademie der Wissenschaften","DWDS, Berlin-Brandenburg Academy of Sciences and Humanities",Sammlung gegenwartssprachlicher Textkorpora an der Berlin-Brandenburgischen Akademie der Wissenschaften,Collection of contemporary text corpora at the Berlin-Brandenburg Academy of Sciences and Humanities
+dtaxl,http://hdl.handle.net/21.11120/0000-000F-D5EB-8,https://www.dwds.de/d/korpora/dtaxl,DWDS – Historische Korpora,DWDS – Historical Corpora,"DWDS, Berlin-Brandenburgische Akademie der Wissenschaften","DWDS, Berlin-Brandenburg Academy of Sciences and Humanities",Sammlung historischer Textkorpora an der Berlin-Brandenburgischen Akademie der Wissenschaften,Collection of historical text corpora at the Berlin-Brandenburg Academy of Sciences and Humanities