build: add support for SIPI v3.0.0-rc.3 (DSP-433)

KnoraBuild.sbt

@@ -228,7 +228,7 @@ lazy val knoraSipi: Project = knoraModule("knora-sipi")
       Docker / dockerExposedPorts ++= Seq(1024),
       Docker / dockerCommands := Seq(
           // FIXME: Someday find out how to reference here Dependencies.Versions.sipiImage
-          Cmd("FROM", "dhlabbasel/sipi:v2.0.1"),
+          Cmd("FROM", "daschswiss/sipi:v3.0.0-rc.3"),
           Cmd("LABEL", s"""MAINTAINER="${maintainer.value}""""),
           Cmd("COPY", "opt/docker/scripts", "/sipi/scripts"),
       )

Makefile

@@ -48,7 +48,7 @@ publish-knora-jena-fuseki-image: build-knora-jena-fuseki-image ## publish knora-
 .PHONY: build-knora-sipi-image
 build-knora-sipi-image: build-all-scala ## build and publish knora-sipi docker image locally
 	@mkdir -p .docker
-	@sed -e "s/@SIPI_VERSION@/$(SIPI_VERSION)/" docker/knora-sipi.template.dockerfile > .docker/knora-sipi.dockerfile
+	@sed -e "s|@SIPI_IMAGE@|$(SIPI_IMAGE)|g" docker/knora-sipi.template.dockerfile > .docker/knora-sipi.dockerfile
 	docker build -t $(KNORA_SIPI_IMAGE) -t $(REPO_PREFIX)/$(KNORA_SIPI_REPO):latest -f .docker/knora-sipi.dockerfile  knora-sipi/target/universal
 
 .PHONY: publish-knora-sipi-image

docker/knora-sipi.template.dockerfile

@@ -1,4 +1,4 @@
-FROM dhlabbasel/sipi:v@SIPI_VERSION@
+FROM @SIPI_IMAGE@
 
 COPY stage/scripts /sipi/scripts
 

docs/src/paradox/07-sipi/sipi-and-knora.md

@@ -262,7 +262,7 @@ quality levels:
       {
          "duration": ​0,
          "nx": ​95,
-         "path": "http://sipiserver:port/knora/incunabula_0000000002.jpg/full/full/0/default.jpg",
+         "path": "http://sipiserver:port/knora/incunabula_0000000002.jpg/full/max/0/default.jpg",
          "ny": ​128,
          "fps": ​0,
          "format_name": "JPEG",

project/Dependencies.scala

@@ -49,7 +49,7 @@ object Dependencies {
         akkaHttpVersion := "10.1.12",
         jenaVersion := "3.14.0",
         metricsVersion := "4.0.1",
-        sipiImage := "dhlabbasel/sipi:v2.0.1",
+        sipiImage := "daschswiss/sipi:v3.0.1-rc.3",
         gdbSEImage := "daschswiss/graphdb:9.0.0-se",
         gdbFreeImage := "daschswiss/graphdb:9.0.0-free"
     )

salsah1/src/typescript_interfaces/sampleRequests/sampleChangeValues.ts

@@ -31,6 +31,6 @@ let changeFileValueRequest: changeValueFormats.changeFileValueRequest = {
     }
 };
 
-let changeFileValueResponse: changeValueFormats.changeFileValueResponse = {"locations":[{"duration":0,"nx":128,"path":"http://localhost:1024/knora/5XTEI1z10A2-D8ojQHrMiUz.jpg/full/full/0/default.jpg","ny":72,"fps":0,"format_name":"JPEG","origname":"2016-06-26+12.26.45.jpg","protocol":"file"},{"duration":0,"nx":3264,"path":"http://localhost:1024/knora/5XTEI1z10A2-D8ojQHrMiUz.jpx/full/3264,1836/0/default.jpg","ny":1836,"fps":0,"format_name":"JPEG2000","origname":"2016-06-26+12.26.45.jpg","protocol":"file"}],"status":0};
+let changeFileValueResponse: changeValueFormats.changeFileValueResponse = {"locations":[{"duration":0,"nx":128,"path":"http://localhost:1024/knora/5XTEI1z10A2-D8ojQHrMiUz.jpg/full/max/0/default.jpg","ny":72,"fps":0,"format_name":"JPEG","origname":"2016-06-26+12.26.45.jpg","protocol":"file"},{"duration":0,"nx":3264,"path":"http://localhost:1024/knora/5XTEI1z10A2-D8ojQHrMiUz.jpx/full/3264,1836/0/default.jpg","ny":1836,"fps":0,"format_name":"JPEG2000","origname":"2016-06-26+12.26.45.jpg","protocol":"file"}],"status":0};
 
 let changeValueComment: changeValueFormats.changeValueCommentRequest = {"project_id":"http://rdfh.ch/projects/77275339","comment":"dumm"};

sipi/Makefile

@@ -6,7 +6,7 @@ print-env-file: env-file ## prints the env file used by sipi
 
 .PHONY: env-file
 env-file: ## write the env file used by sipi
-	@echo SIPI_VERSION=v$(SIPI_VERSION) > .env
+	@echo SIPI_IMAGE=$(SIPI_IMAGE) > .env
 	@echo DOCKERHOST=$(DOCKERHOST) >> .env
 
 .PHONY: up

sipi/docker-compose.yml

@@ -4,7 +4,7 @@ version: '3'
 services:
   # sipi using default (production-like) configuration with additional routes for testing
   sipi:
-    image: dhlabbasel/sipi:${SIPI_VERSION}
+    image: ${SIPI_IMAGE}
     container_name: sipi
     ports:
       - "1024:1024"
@@ -26,7 +26,7 @@ services:
 
   # sipi using configuration which disables authentication
   sipi-no-auth:
-    image: dhlabbasel/sipi:${SIPI_VERSION}
+    image: ${SIPI_IMAGE}
     container_name: sipi-no-auth
     ports:
       - "1024:1024"

sipi/images/thumbs/.gitignore

@@ -1,2 +1,4 @@
+# Ignore everything in this directory
 *
+# Except these files
 !.gitignore

sipi/scripts/make_thumbnail.lua

@@ -175,7 +175,7 @@ for imgindex, imgparam in pairs(server.uploads) do
         nx_thumb = dims.nx,
         ny_thumb = dims.ny,
         mimetype_thumb = 'image/jpeg',
-        preview_path =  get_external_protocol() .. "://" .. get_external_hostname() .. ":" .. get_external_port() .."/thumbs/" .. thumbName .. "/full/full/0/default.jpg",
+        preview_path =  get_external_protocol() .. "://" .. get_external_hostname() .. ":" .. get_external_port() .."/thumbs/" .. thumbName .. "/full/max/0/default.jpg",
         filename = tmpName, -- make this a IIIF URL
         original_mimetype = submitted_mimetype.mimetype,
         original_filename = filename,

sipi/server/test.html

@@ -13,7 +13,7 @@
         for (var i = 2; i <= 632; i++) {
             var node = document.createElement("img");
             var numstr = i.pad(10);
-            node.setAttribute("src", "http://localhost:1024/images/Incunabula_" + numstr + ".jpg/full/full/0/default.jpg");
+            node.setAttribute("src", "http://localhost:1024/images/Incunabula_" + numstr + ".jpg/full/max/0/default.jpg");
             ele.appendChild(node);
         }
     }

vars.mk

@@ -1,4 +1,6 @@
-SIPI_VERSION := 2.0.1
+SIPI_VERSION := v3.0.0-rc.3
+SIPI_REPOSITORY := daschswiss/sipi
+SIPI_IMAGE := $(SIPI_REPOSITORY):$(SIPI_VERSION)
 
 FUSEKI_HEAP_SIZE := 3G
 

webapi/src/it/scala/org/knora/webapi/e2e/v1/KnoraSipiScriptsV1ITSpec.scala

@@ -95,7 +95,7 @@ class KnoraSipiScriptsV1ITSpec extends ITKnoraFakeSpec(KnoraSipiScriptsV1ITSpec.
                 "mimetype_thumb":"image/jpeg",
                 "original_mimetype":"image/jpeg",
                 "nx_thumb":93,
-                "preview_path":"http://localhost:1024/thumbs/CjwDMhlrctI-BG7gms08BJ4.jpg/full/full/0/default.jpg",
+                "preview_path":"http://localhost:1024/thumbs/CjwDMhlrctI-BG7gms08BJ4.jpg/full/max/0/default.jpg",
                 "filename":"CjwDMhlrctI-BG7gms08BJ4",
                 "file_type":"IMAGE",
                 "original_filename":"Chlaus.jpg",
@@ -173,7 +173,7 @@ class KnoraSipiScriptsV1ITSpec extends ITKnoraFakeSpec(KnoraSipiScriptsV1ITSpec.
             // Running with KnoraFakeService which always allows access to files.
             // Send a GET request to Sipi, asking for full image
             // not possible as authentication is required and file needs to be known by knora to be able to authenticate the request
-            val sipiGetImageRequest = Get(baseInternalSipiUrl + "/0001/" + filenameFull + "/full/full/0/default.jpg") ~> addCredentials(BasicHttpCredentials(username, password))
+            val sipiGetImageRequest = Get(baseInternalSipiUrl + "/0001/" + filenameFull + "/full/max/0/default.jpg") ~> addCredentials(BasicHttpCredentials(username, password))
             checkResponseOK(sipiGetImageRequest)
 
             // Send a GET request to Sipi, asking for the info.json of the image
@@ -219,7 +219,7 @@ class KnoraSipiScriptsV1ITSpec extends ITKnoraFakeSpec(KnoraSipiScriptsV1ITSpec.
             //log.debug("sipiConvertFromPathPostResponseJson: {}", sipiConvertFromPathPostResponseJson)
 
             // Running with KnoraFakeService which always allows access to files.
-            val sipiGetImageRequest = Get(baseInternalSipiUrl + "/0001/" + filenameFull + "/full/full/0/default.jpg") ~> addCredentials(BasicHttpCredentials(username, password))
+            val sipiGetImageRequest = Get(baseInternalSipiUrl + "/0001/" + filenameFull + "/full/max/0/default.jpg") ~> addCredentials(BasicHttpCredentials(username, password))
             checkResponseOK(sipiGetImageRequest)
 
             // Send a GET request to Sipi, asking for the info.json of the image

webapi/src/it/scala/org/knora/webapi/e2e/v2/KnoraSipiIntegrationV2ITSpec.scala

@@ -166,7 +166,7 @@ class KnoraSipiIntegrationV2ITSpec extends ITKnoraLiveSpec(KnoraSipiIntegrationV
         // Request the temporary file from Sipi.
         for (responseEntry <- sipiUploadResponse.uploadedFiles) {
             val sipiGetTmpFileRequest: HttpRequest = if (responseEntry.fileType == "image") {
-                Get(responseEntry.temporaryUrl.replace("http://0.0.0.0:1024", baseExternalSipiUrl) + "/full/full/0/default.jpg")
+                Get(responseEntry.temporaryUrl.replace("http://0.0.0.0:1024", baseExternalSipiUrl) + "/full/max/0/default.jpg")
             } else {
                 Get(responseEntry.temporaryUrl.replace("http://0.0.0.0:1024", baseExternalSipiUrl))
             }

webapi/src/main/scala/org/knora/webapi/responders/v1/ValueUtilV1.scala

@@ -73,7 +73,7 @@ class ValueUtilV1(private val settings: KnoraSettingsImpl) {
     }
 
     def makeSipiImagePreviewGetUrlFromFilename(projectShortcode: String, filename: String): String = {
-        s"${settings.externalSipiIIIFGetUrl}/$projectShortcode/$filename/full/full/0/default.jpg"
+        s"${settings.externalSipiIIIFGetUrl}/$projectShortcode/$filename/full/max/0/default.jpg"
     }
 
     /**