Lock LDP

deploy/src/main.ts

@@ -427,6 +427,13 @@ ds_writer.write({
 				Repo: {
 					crud: {
 						...H_CRUD_DEFAULT,
+						Update: {
+							implies: [
+								'ReadRepo',
+								'UpdateBranch',  // PATCH for updating repo metadata
+								'UpdateLock',  // PATCH for updating repo metadata
+							],
+						},
 						Delete: {
 							implies: [
 								'UpdateRepo',
@@ -446,13 +453,7 @@ ds_writer.write({
 				},
 
 				Lock: {
-					crud: {
-						Create: {},
-						Read: {},
-						Delete: {
-							implies: ['ReadLock'],
-						},
-					},
+					crud: H_CRUD_DEFAULT,
 				},
 
 				AccessControlAny: {
@@ -521,4 +522,4 @@ ds_writer.write({
 			}),
 		},
 	},
-})
+})

src/main/kotlin/org/openmbee/flexo/mms/Conditions.kt

@@ -150,6 +150,11 @@ val LOCK_CRUD_CONDITIONS = REPO_CRUD_CONDITIONS.append {
     }
 }
 
+val LOCK_UPDATE_CONDITIONS = LOCK_CRUD_CONDITIONS.append {
+    // require that the user has the ability to update locks on a lock-level scope
+    permit(Permission.UPDATE_LOCK, Scope.LOCK)
+}
+
 enum class ConditionType {
     INSPECT,
     REQUIRE,

src/main/kotlin/org/openmbee/flexo/mms/Errors.kt

@@ -81,3 +81,7 @@ open class Http500Excpetion(msg: String): HttpException(msg, HttpStatusCode.Inte
 
 class ServerBugException(msg: String?=null): Http500Excpetion("Possible server implementation bug: ${msg?: "(no description)"}")
 
+
+open class Http501Exception(msg: String): HttpException(msg, HttpStatusCode.NotImplemented)
+
+class NotImplementedException(msg: String): Http501Exception("That action is not yet implemented. $msg")

src/main/kotlin/org/openmbee/flexo/mms/General.kt

@@ -0,0 +1,14 @@
+package org.openmbee.flexo.mms
+
+import io.ktor.http.*
+import io.ktor.server.response.*
+import org.openmbee.flexo.mms.server.GenericResponse
+import org.openmbee.flexo.mms.server.LdpDcLayer1Context
+
+suspend fun LdpDcLayer1Context<GenericResponse>.notImplemented() {
+    call.respondText(
+        "That operation is not yet implemented",
+        ContentType.Text.Plain,
+        HttpStatusCode.NotImplemented
+    )
+}

src/main/kotlin/org/openmbee/flexo/mms/Namespaces.kt

@@ -156,6 +156,9 @@ fun prefixesFor(
                                 )
                             }
                         }
+                        else {
+                            add("morl" to MMS_URNS.never)
+                        }
 
                         if(null !== diffId) {
                             with("$this/diffs/$diffId") {
@@ -164,6 +167,9 @@ fun prefixesFor(
                                 )
                             }
                         }
+                        else {
+                            add("morl" to MMS_URNS.never)
+                        }
 
                         if(null != lockId) {
                             with("$this/locks/$lockId") {
@@ -172,6 +178,9 @@ fun prefixesFor(
                                 )
                             }
                         }
+                        else {
+                            add("morl" to MMS_URNS.never)
+                        }
 
                         if(null != commitId) {
                             with("$this/commits/$commitId") {
@@ -181,6 +190,9 @@ fun prefixesFor(
                                 )
                             }
                         }
+                        else {
+                            add("morl" to MMS_URNS.never)
+                        }
                     }
                 }
             }
@@ -202,7 +214,7 @@ fun prefixesFor(
 object MMS {
     private val BASE = SPARQL_PREFIXES["mms"]!!
     val uri = BASE
-    
+
     private fun res(id: String): Resource {
         return ResourceFactory.createResource("${BASE}${id}")
     }
@@ -234,7 +246,7 @@ object MMS {
 
     // object properties
     val id  = ResourceFactory.createProperty(BASE, "id")
-    
+
     private fun prop(id: String): Property {
         return ResourceFactory.createProperty(BASE, id)
     }
@@ -343,6 +355,8 @@ object MMS_OBJECT {
 object MMS_URNS {
     private val mms = "urn:mms"
 
+    val never = "$mms:never"
+
     object SUBJECT {
         val aggregator = "$mms:aggregator"
         val auth = "$mms:auth"
@@ -354,4 +368,4 @@ object MMS_URNS {
         val pass = "$mms:pass"
         val policy = "$mms:policy"
     }
-}
+}

src/main/kotlin/org/openmbee/flexo/mms/routes/Branches.kt

@@ -3,6 +3,7 @@ package org.openmbee.flexo.mms.routes
 import io.ktor.server.routing.*
 import org.openmbee.flexo.mms.BRANCH_UPDATE_CONDITIONS
 import org.openmbee.flexo.mms.guardedPatch
+import org.openmbee.flexo.mms.notImplemented
 import org.openmbee.flexo.mms.routes.ldp.createBranch
 import org.openmbee.flexo.mms.routes.ldp.getBranches
 import org.openmbee.flexo.mms.routes.ldp.headBranches
@@ -44,6 +45,9 @@ fun Route.crudBranches() {
             // create new branch
             createBranch(usedPost=true)
         }
+
+        // method not allowed
+        otherwiseNotAllowed()
     }
 
     // specific branch
@@ -80,5 +84,13 @@ fun Route.crudBranches() {
                 preconditions = BRANCH_UPDATE_CONDITIONS,
             )
         }
+
+        // delete not yet implemented
+        delete {
+            notImplemented()
+        }
+
+        // method not allowed
+        otherwiseNotAllowed()
     }
-}
+}

src/main/kotlin/org/openmbee/flexo/mms/routes/Locks.kt

@@ -1,6 +1,10 @@
 package org.openmbee.flexo.mms.routes
 
 import io.ktor.server.routing.*
+import org.openmbee.flexo.mms.LOCK_UPDATE_CONDITIONS
+import org.openmbee.flexo.mms.NotImplementedException
+import org.openmbee.flexo.mms.guardedPatch
+import org.openmbee.flexo.mms.reindent
 import org.openmbee.flexo.mms.routes.ldp.createOrReplaceLock
 import org.openmbee.flexo.mms.routes.ldp.deleteLock
 import org.openmbee.flexo.mms.routes.ldp.getLocks
@@ -22,6 +26,16 @@ fun Route.crudLocks() {
             }
         }
 
+        // state of a lock
+        head {
+            headLocks(true)
+        }
+
+        // get all locks
+        get {
+            getLocks(true)
+        }
+
         // create new lock
         post { slug ->
             // set policy id on context
@@ -30,6 +44,9 @@ fun Route.crudLocks() {
             // create new lock
             createOrReplaceLock()
         }
+
+        // method not allowed
+        otherwiseNotAllowed("locks")
     }
 
     // specific lock
@@ -57,9 +74,38 @@ fun Route.crudLocks() {
             createOrReplaceLock()
         }
 
+        // update lock metadata
+        patch {
+            // build conditions
+            val localConditions = LOCK_UPDATE_CONDITIONS.append {
+                // enforce preconditions if present
+                appendPreconditions { values ->
+                    """
+                        graph mor-graph:Metadata {
+                            morl: mms:etag ?__mms_etag .
+
+                            ${values.reindent(6)}
+                        }
+                    """
+                }
+            }
+
+            // handle all varieties of accepted PATCH request formats
+            guardedPatch(
+                updateRequest = it,
+                objectKey = "morl",
+                graph = "mor-graph:Metadata",
+                preconditions = localConditions,
+            )
+        }
+
         // delete a lock
         delete {
-            deleteLock()
+//            deleteLock()
+            throw NotImplementedException("DELETE Lock")
         }
+
+        // method not allowed
+        otherwiseNotAllowed("lock")
     }
 }

src/main/kotlin/org/openmbee/flexo/mms/routes/ldp/LockWrite.kt

@@ -6,6 +6,7 @@ import org.apache.jena.vocabulary.RDF
 import org.openmbee.flexo.mms.*
 import org.openmbee.flexo.mms.server.LdpDcLayer1Context
 import org.openmbee.flexo.mms.server.LdpMutateResponse
+import org.openmbee.flexo.mms.server.LdpPatchResponse
 
 
 // require that the given lock does not exist (before attempting to create it)
@@ -180,7 +181,7 @@ suspend fun <TResponseContext: LdpMutateResponse> LdpDcLayer1Context<TResponseCo
 
         // resource is being replaced
         if(replaceExisting) {
-            // require that the user has the ability to create locks on a repo-level scope
+            // require that the user has the ability to update locks on a repo-level scope
             permit(Permission.UPDATE_LOCK, Scope.REPO)
         }
         // resource is being created

src/test/kotlin/org/openmbee/flexo/mms/BranchUpdate.kt

@@ -1,6 +1,7 @@
 package org.openmbee.flexo.mms
 
 
+import io.ktor.http.*
 import org.apache.jena.sparql.vocabulary.FOAF
 import org.apache.jena.vocabulary.DCTerms
 import org.apache.jena.vocabulary.RDF
@@ -13,14 +14,18 @@ class BranchUpdate : RefAny() {
 
             withTest {
                 httpPatch(demoBranchPath) {
-                    setSparqlUpdateBody(withAllTestPrefixes("""
+                    setSparqlUpdateBody(
+                        withAllTestPrefixes(
+                            """
                         insert {
                             <> foaf:homepage <https://www.openmbee.org/> .
                         }
                         where {
                             <> dct:title "$demoBranchName"@en .
                         }
-                    """.trimIndent()))
+                    """.trimIndent()
+                        )
+                    )
                 }.apply {
                     response includesTriples {
                         subject(localIri(demoBranchPath)) {
@@ -35,5 +40,31 @@ class BranchUpdate : RefAny() {
                 }
             }
         }
+
+        "all branches rejects other methods" {
+            createBranch(demoRepoPath, "master", demoBranchId, demoBranchName)
+
+            withTest {
+                onlyAllowsMethods("$demoRepoPath/branches", setOf(
+                    HttpMethod.Head,
+                    HttpMethod.Get,
+                    HttpMethod.Post,
+                ))
+            }
+        }
+
+        "branch rejects other methods" {
+            createBranch(demoRepoPath, "master", demoBranchId, demoBranchName)
+
+            withTest {
+                onlyAllowsMethods(demoBranchPath, setOf(
+                    HttpMethod.Head,
+                    HttpMethod.Get,
+                    HttpMethod.Put,
+                    HttpMethod.Patch,
+                    HttpMethod.Delete,
+                ))
+            }
+        }
     }
 }

src/test/kotlin/org/openmbee/flexo/mms/LockAny.kt

@@ -4,23 +4,25 @@ import io.kotest.matchers.string.shouldNotBeBlank
 import io.ktor.http.*
 import io.ktor.server.testing.*
 import org.apache.jena.vocabulary.RDF
-import org.openmbee.flexo.mms.util.TriplesAsserter
-import org.openmbee.flexo.mms.util.exactly
-import org.openmbee.flexo.mms.util.iri
-import org.openmbee.flexo.mms.util.startsWith
+import org.openmbee.flexo.mms.util.*
 import org.slf4j.LoggerFactory
 
 // validates response triples for a lock
-fun TriplesAsserter.validateLockTriples(lockId: String, etag: String) {
+fun TriplesAsserter.validateLockTriples(
+    lockId: String,
+    etag: String?=null,
+    extraPatterns: List<PairPattern> = listOf()
+) {
     // lock triples
     subjectTerse("mor-lock:$lockId") {
         exclusivelyHas(
             RDF.type exactly MMS.Lock,
             MMS.id exactly lockId,
-            MMS.etag exactly etag,
+            if(etag != null) MMS.etag exactly etag else MMS.etag startsWith "",
             MMS.commit startsWith model.expandPrefix("mor-commit:").iri,
             MMS.snapshot startsWith model.expandPrefix("mor-snapshot:Model.").iri,
             MMS.createdBy exactly model.expandPrefix("mu:").iri,
+            *extraPatterns.toTypedArray(),
         )
     }
 }

src/test/kotlin/org/openmbee/flexo/mms/LockLdpDc.kt

@@ -21,6 +21,8 @@ class LockLdpDc : LockAny() {
 //                // validate
 //                validateCreatedLockTriples(demoLockId, etag, demoOrgPath)
 //            }
+
+            patch()
         }
     }
-}
+}