Add some missing sections endpoints (#410)

* Add some missing sections endpoints

* rename getSections endpoint to sections

* Fix name clash in 61f451d

---------

Co-authored-by: Luigi Marini <[email protected]>

Author: LDeakin

CHANGELOG.md

@@ -25,6 +25,7 @@ registration or heartbeat to Clowder that will restrict use of that extractor to
 - Documentation on how to do easy testing of pull requests
 - Previewer source URL in the documentation to point to the Clowder GitHub repo. [#395](https://github.com/clowder-framework/clowder/issues/395)
 - Added a citation.cff file
+- Add sections endpoint to file API and fix missing section routes in javascriptRoutes [#410](https://github.com/clowder-framework/clowder/pull/410)
 - Added Google's model viewer within viewer_three.js previewer
 
 ### Fixed

app/api/Files.scala

@@ -32,6 +32,7 @@ class Files @Inject()(
   collections: CollectionService,
   queries: MultimediaQueryService,
   tags: TagService,
+  sections_service: SectionService,
   comments: CommentService,
   extractions: ExtractionService,
   dtsrequests:ExtractionRequestsService,
@@ -207,6 +208,18 @@ class Files @Inject()(
       }
     }
 
+  def sections(id: UUID) = PermissionAction(Permission.ViewFile, Some(ResourceRef(ResourceRef.file, id))) { implicit request =>
+    implicit val user = request.user
+    files.get(id) match {
+      case Some(file) => {
+        val sectionList = sections_service.findByFileId(id)
+        val sectionIds = sectionList.map { section => section.id }
+        Ok(toJson(sectionIds))
+      }
+      case None => NotFound(toJson("The requested file does not exist"))
+    }
+  }
+
   def getMetadataDefinitions(id: UUID, space: Option[String]) = PermissionAction(Permission.AddMetadata, Some(ResourceRef(ResourceRef.file, id))) { implicit request =>
     implicit val user = request.user
     files.get(id) match {

app/api/Sections.scala

@@ -67,8 +67,14 @@ class Sections @Inject()(
       Logger.debug("Getting info for section with id " + id)
       sections.get(id) match {
         case Some(section) =>
-          Ok(Json.obj("id" -> section.id.toString, "file_id" -> section.file_id.toString,
-            "startTime" -> section.startTime.getOrElse(-1).toString, "tags" -> Json.toJson(section.tags.map(_.name))))
+          Ok(Json.obj(
+              "id" -> section.id.toString,
+              "file_id" -> section.file_id.toString,
+              "startTime" -> section.startTime.getOrElse(-1).toString,
+              "tags" -> Json.toJson(section.tags.map(_.name)),
+              "area" -> Json.toJson(section.area.getOrElse(null)),
+              "description" -> Json.toJson(section.description.getOrElse(""))
+          ))
         case None => Logger.error("Section not found " + id); NotFound(toJson("Section not found, id: " + id))
       }
   }

app/controllers/Application.scala

@@ -369,6 +369,7 @@ class Application @Inject()(files: FileService, collections: CollectionService,
         api.routes.javascript.Files.unfollow,
         api.routes.javascript.Files.getTechnicalMetadataJSON,
         api.routes.javascript.Files.filePreviewsList,
+        api.routes.javascript.Files.sections,
         api.routes.javascript.Files.updateMetadata,
         api.routes.javascript.Files.addMetadata,
         api.routes.javascript.Files.getMetadataDefinitions,
@@ -382,7 +383,9 @@ class Application @Inject()(files: FileService, collections: CollectionService,
         api.routes.javascript.Search.search,
         api.routes.javascript.Search.searchJson,
         api.routes.javascript.Sections.add,
+        api.routes.javascript.Sections.get,
         api.routes.javascript.Sections.delete,
+        api.routes.javascript.Sections.description,
         api.routes.javascript.Sections.comment,
         api.routes.javascript.Sections.getTags,
         api.routes.javascript.Sections.addTags,

app/models/Section.scala

@@ -33,3 +33,15 @@ case class Rectangle(
   h: Double) {
   override def toString() = f"x: $x%.2f, y: $y%.2f, width: $w%.2f, height: $h%.2f"
 }
+
+object Rectangle {
+  implicit object RectangleWrites extends Writes[Rectangle] {
+    def writes(rectangle: Rectangle): JsObject = {
+      Json.obj(
+        "x" -> rectangle.x,
+        "y" -> rectangle.y,
+        "w" -> rectangle.w,
+        "h" -> rectangle.h)
+    }
+  }
+}

conf/routes

@@ -390,6 +390,7 @@ GET            /api/files/:id/blob
 POST           /api/files/:id/remove                                                    @api.Files.removeFile(id: UUID)
 POST           /api/files/bulkRemove                                                    @api.Files.bulkDeleteFiles()
 GET            /api/files/:id/metadata                                                  @api.Files.get(id: UUID)
+GET            /api/files/:id/sections                                                  @api.Files.sections(id: UUID)
 POST           /api/files/:id/metadata                                                  @api.Files.addMetadata(id: UUID)
 GET            /api/files/:id/metadataDefinitions                                       @api.Files.getMetadataDefinitions(id: UUID, space: Option[String] ?= None)
 POST           /api/files/:id/updateMetadata                                            @api.Files.updateMetadata(id: UUID, extractor_id: String)

public/swagger.yml

@@ -351,6 +351,32 @@ paths:
         404:
           $ref: '#/components/responses/NotFound'
 
+  /files/{id}/sections:
+    get:
+      tags:
+        - files
+      summary: Get the sections of a file
+      description: |
+        Get the sections of a file.
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/UUID'
+        404:
+          $ref: '#/components/responses/NotFound'
+      
+
   /files/{id}/paths:
     get:
       tags: