Merge pull request #43 from HumanBrainProject/feature/delete_stored_queries

Added deletion of stored queries

Author: joke1196

src/main/java/org/humanbrainproject/knowledgegraph/commons/propertyGraph/arango/control/ArangoInternalRepository.java

@@ -12,12 +12,14 @@
 import org.humanbrainproject.knowledgegraph.commons.propertyGraph.arango.control.query.ArangoQueryFactory;
 import org.humanbrainproject.knowledgegraph.commons.propertyGraph.arango.entity.ArangoCollectionReference;
 import org.humanbrainproject.knowledgegraph.commons.propertyGraph.arango.entity.ArangoDocumentReference;
+import org.humanbrainproject.knowledgegraph.commons.propertyGraph.arango.exceptions.StoredQueryNotFoundException;
 import org.humanbrainproject.knowledgegraph.commons.vocabulary.ArangoVocabulary;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Component;
 
+import javax.ws.rs.NotFoundException;
 import java.util.List;
 import java.util.Map;
 
@@ -126,4 +128,18 @@ public boolean doesDocumentExist(ArangoCollectionReference collectionReference,
         }
         return false;
     }
+
+    public void removeInternalDocument(ArangoDocumentReference document) throws IllegalAccessException, StoredQueryNotFoundException {
+        String userId = authorizationContext.getUserId();
+        if(userId==null){
+            throw new IllegalAccessException("You have to be authenticated if you want to execute this operation");
+        }
+        ArangoDatabase db = getDB();
+        ArangoCollection collection = db.collection(document.getCollection().getName());
+        if ( collection.exists() && collection.documentExists(document.getKey())) {
+            collection.deleteDocument(document.getKey());
+        } else {
+            throw new StoredQueryNotFoundException("Query not found");
+        }
+    }
 }

src/main/java/org/humanbrainproject/knowledgegraph/query/api/QueryAPI.java

@@ -324,6 +324,23 @@ public ResponseEntity<String> saveSpecificationToDB(@RequestBody String payload,
         }
     }
 
+    @ExternalApi
+    @ApiOperation(value="Delete a query specification in KG")
+    @DeleteMapping(value = "/{"+ORG+"}/{"+ DOMAIN+"}/{"+SCHEMA+"}/{"+VERSION+"}/{"+QUERY_ID+"}", produces=MediaType.TEXT_PLAIN)
+    public ResponseEntity<String> removeSpecificationToDB(@PathVariable(ORG) String org, @PathVariable(DOMAIN) String domain, @PathVariable(SCHEMA) String schema, @PathVariable(VERSION) String version, @ApiParam(value = "Freely defined alias for the query. Please note that only the user who has created the specification initially can update it. If an alias is already occupied, please use another one.", required = true) @PathVariable(QUERY_ID) String id, @ApiParam(value = ParameterConstants.AUTHORIZATION_DOC, required = true) @RequestHeader(value = HttpHeaders.AUTHORIZATION) String authorization) throws Exception {
+        try {
+            authorizationContext.populateAuthorizationContext(authorization);
+            query.removeSpecificationInDb(new StoredQueryReference(new NexusSchemaReference(org, domain, schema, version), id));
+            return ResponseEntity.ok("Deleted specification from database");
+        } catch (StoredQueryNotFoundException e){
+            return ResponseEntity.notFound().build();
+        } catch (HttpClientErrorException e) {
+            return ResponseEntity.status(e.getStatusCode()).build();
+        } catch (IllegalAccessException e){
+            return ResponseEntity.status(HttpStatus.UNAUTHORIZED).body(e.getMessage());
+        }
+    }
+
     @ApiOperation(value="Execute a stored query and fetch the corresponding instances")
     @Deprecated
     @GetMapping("/{"+ORG+"}/{"+ DOMAIN+"}/{"+SCHEMA+"}/{"+VERSION+"}/{"+QUERY_ID+"}/instances/deprecated")

src/main/java/org/humanbrainproject/knowledgegraph/query/boundary/ArangoQuery.java

@@ -231,6 +231,11 @@ public void storeSpecificationInDb(String specification, StoredQueryReference qu
         arangoInternalRepository.insertOrUpdateDocument(document, jsonObject.toString());
     }
 
+    public void removeSpecificationInDb(StoredQueryReference queryReference) throws IllegalAccessException {
+        ArangoDocumentReference documentRef = new ArangoDocumentReference(SPECIFICATION_QUERIES, queryReference.getName());
+        arangoInternalRepository.removeInternalDocument(documentRef);
+    }
+
     public QueryResult<List<Map>> queryPropertyGraphByStoredSpecificationAndFreemarkerTemplate(StoredQuery storedQuery) throws IOException, JSONException, SolrServerException {
         QueryResult<List<Map>> queryResult = queryPropertyGraphByStoredSpecification(storedQuery);
         String templatePayload = templating.getTemplateById(storedQuery.getStoredTemplateReference()).getTemplateContent();