new method adds folder id and name to file in datasets files endpoint (#229)

* new method adds folder id and name to file in datasets files endpoint

* adding CHANGELOG.md entry

* using a case for jsonFile removing jsonFileWithFolder

* fixing spacing

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

Author: tcnichol

CHANGELOG.md

@@ -5,6 +5,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Unreleased
+- Added folder and folder id to api datasets files list [#34](https://github.com/clowder-framework/clowder/issues/34)
 
 ### Fixed
 - When uploading a file, it would ignore any extractors marked disabled at the space level. [#246](https://github.com/clowder-framework/clowder/issues/246)

app/api/Datasets.scala

@@ -1,40 +1,34 @@
 package api
 
-import java.io._
-import java.io.{File => JFile}
-import java.net.URL
-import java.security.{DigestInputStream, MessageDigest}
-import java.text.SimpleDateFormat
-import java.util.{Calendar, Date}
-
+import _root_.util._
 import api.Permission.Permission
-import java.util.zip._
-
-import javax.inject.{Inject, Singleton}
+import controllers.Utils.https
 import controllers.{Previewers, Utils}
 import jsonutils.JsonUtil
 import models._
 import org.apache.commons.codec.binary.Hex
 import org.json.JSONObject
 import play.api.Logger
-import play.api.Play.{configuration, current, routes}
+import play.api.Play.{configuration, current}
 import play.api.i18n.Messages
+import play.api.libs.Files
 import play.api.libs.concurrent.Execution.Implicits._
 import play.api.libs.iteratee.Enumerator
-import play.api.libs.json._
 import play.api.libs.json.Json._
-import play.api.mvc.{Action, AnyContent, MultipartFormData, SimpleResult}
-import services._
-import _root_.util._
-import controllers.Utils.https
-import org.json.simple.{JSONArray, JSONObject => SimpleJSONObject}
-import org.json.simple.parser.JSONParser
-import play.api.libs.Files
-import play.api.libs.Files.TemporaryFile
+import play.api.libs.json._
+import play.api.mvc.{AnyContent, MultipartFormData, SimpleResult}
 import scalax.file.Path.createTempFile
+import services._
 
-import scala.concurrent.{ExecutionContext, Future}
+import java.io._
+import java.net.URL
+import java.security.{DigestInputStream, MessageDigest}
+import java.text.SimpleDateFormat
+import java.util.zip._
+import java.util.{Calendar, Date}
+import javax.inject.{Inject, Singleton}
 import scala.collection.mutable.{ListBuffer, Map => MutaMap}
+import scala.concurrent.{ExecutionContext, Future}
 
 /**
  * Dataset API.
@@ -933,6 +927,7 @@ class  Datasets @Inject()(
         }
      }
 
+
   def getMetadataDefinitions(id: UUID, currentSpace: Option[String]) = PermissionAction(Permission.AddMetadata, Some(ResourceRef(ResourceRef.dataset, id))) { implicit request =>
     implicit val user = request.user
     datasets.get(id) match {
@@ -1134,47 +1129,84 @@ class  Datasets @Inject()(
   private def getFilesWithinFolders(id: UUID, serveradmin: Boolean=false, max: Int = -1): List[JsValue] = {
     val output = new ListBuffer[JsValue]()
     var resultCount = 0
+    var current_folder : Option[Folder] = None
     datasets.get(id) match {
       case Some(dataset) => {
-        folders.findByParentDatasetId(id).map { folder =>
+        folders.findByParentDatasetId(id).foreach { folder =>
+          current_folder = Some(folder)
           files.get(folder.files).found.foreach(file => {
             if (max < 0 || resultCount < max) {
-              output += jsonFile(file, serveradmin)
+              output += jsonFile(file, serveradmin, Some(folder))
               resultCount += 1
             }
           })
+          print("done with folder")
         }
       }
       case None => Logger.error(s"Error getting dataset $id")
     }
     output.toList
   }
 
-  def jsonFile(file: models.File, serverAdmin: Boolean = false): JsValue = {
-    val defaultMap = Map(
-      "id" -> file.id.toString,
-      "filename" -> file.filename,
-      "contentType" -> file.contentType,
-      "date-created" -> file.uploadDate.toString(),
-      "size" -> file.length.toString)
-
-    // Only include filepath if using DiskByte storage and user is serverAdmin
-    val jsonMap = file.loader match {
-      case "services.filesystem.DiskByteStorageService" => {
-        if (serverAdmin)
-          Map(
-            "id" -> file.id.toString,
-            "filename" -> file.filename,
-            "filepath" -> file.loader_id,
-            "contentType" -> file.contentType,
-            "date-created" -> file.uploadDate.toString(),
-            "size" -> file.length.toString)
-        else
-          defaultMap
-      }
-      case _ => defaultMap
-    }
-    toJson(jsonMap)
+
+  def jsonFile(file: models.File, serverAdmin: Boolean = false, folder : Option[Folder] = None): JsValue = {
+    folder match {
+      case Some(f) => {
+        val folderMap : JsValue = Json.obj("id"->f.id, "name"->f.name)
+        val defaultMap : JsValue = Json.obj(
+          "id" -> file.id.toString,
+          "filename" -> file.filename,
+          "contentType" -> file.contentType,
+          "date-created" -> file.uploadDate.toString(),
+          "folders"->folderMap,
+          "size" -> file.length.toString)
+
+        // Only include filepath if using DiskByte storage and user is serverAdmin
+        val jsonMap = file.loader match {
+          case "services.filesystem.DiskByteStorageService" => {
+            if (serverAdmin)
+              Json.obj(
+                "id" -> file.id.toString,
+                "filename" -> file.filename,
+                "filepath" -> file.loader_id,
+                "contentType" -> file.contentType,
+                "date-created" -> file.uploadDate.toString(),
+                "folders"->folderMap,
+                "size" -> file.length.toString)
+            else
+              defaultMap
+          }
+          case _ => defaultMap
+        }
+        toJson(jsonMap)
+      }
+      case None => {
+        val defaultMap = Map(
+          "id" -> file.id.toString,
+          "filename" -> file.filename,
+          "contentType" -> file.contentType,
+          "date-created" -> file.uploadDate.toString(),
+          "size" -> file.length.toString)
+
+        // Only include filepath if using DiskByte storage and user is serverAdmin
+        val jsonMap = file.loader match {
+          case "services.filesystem.DiskByteStorageService" => {
+            if (serverAdmin)
+              Map(
+                "id" -> file.id.toString,
+                "filename" -> file.filename,
+                "filepath" -> file.loader_id,
+                "contentType" -> file.contentType,
+                "date-created" -> file.uploadDate.toString(),
+                "size" -> file.length.toString)
+            else
+              defaultMap
+          }
+          case _ => defaultMap
+        }
+        toJson(jsonMap)
+        }
+    }
   }
 
   //Update Dataset Information code starts