Allow searching by created date (#174)

* Implement created flag

* Fix lt gt lte gte functions

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

Author: max-zilla

CHANGELOG.md

@@ -6,6 +6,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Unreleased
 
+### Added
+- Added a new `created` search option for filtering by upload/creation date of resource.
+
 ### Fixed
 - Clowder will no longer offer a Download button for a file until it has been PROCESSED.
 

app/services/ElasticsearchPlugin.scala

@@ -724,12 +724,35 @@ class ElasticsearchPlugin(application: Application) extends Plugin {
 
   /** Create appropriate search object based on operator */
   def parseMustOperators(builder: XContentBuilder, key: String, value: String, operator: String): XContentBuilder = {
+    // TODO: Other date fields may need handling like this? ES always appends 00:00:00 if missing, breaking some things
+    val startdate = if (value.length == 10) value+"T00:00:00.000Z" else value
+    val enddate   = if (value.length == 10) value+"T23:59:59.999Z" else value
     operator match {
       case "==" => builder.startObject().startObject("match_phrase").field(key, value).endObject().endObject()
-      case "<" => builder.startObject().startObject("range").startObject(key).field("lt", value).endObject().endObject().endObject()
-      case ">" => builder.startObject().startObject("range").startObject(key).field("gt", value).endObject().endObject().endObject()
-      case "<=" => builder.startObject().startObject("range").startObject(key).field("lte", value).endObject().endObject().endObject()
-      case ">=" => builder.startObject().startObject("range").startObject(key).field("gte", value).endObject().endObject().endObject()
+      case "<" => {
+        if (key=="created")
+          builder.startObject().startObject("range").startObject(key).field("lt", startdate).endObject().endObject().endObject()
+        else
+          builder.startObject().startObject("range").startObject(key).field("lt", value).endObject().endObject().endObject()
+      }
+      case ">" => {
+        if (key=="created")
+          builder.startObject().startObject("range").startObject(key).field("gt", enddate).endObject().endObject().endObject()
+        else
+          builder.startObject().startObject("range").startObject(key).field("gt", value).endObject().endObject().endObject()
+      }
+      case "<=" => {
+        if (key=="created")
+          builder.startObject().startObject("range").startObject(key).field("lte", enddate).endObject().endObject().endObject()
+        else
+          builder.startObject().startObject("range").startObject(key).field("lte", value).endObject().endObject().endObject()
+      }
+      case ">=" => {
+        if (key=="created")
+          builder.startObject().startObject("range").startObject(key).field("gte", startdate).endObject().endObject().endObject()
+        else
+          builder.startObject().startObject("range").startObject(key).field("gte", value).endObject().endObject().endObject()
+      }
       case ":" => {
         if (key == "_all")
           builder.startObject().startObject("regexp").field("_all", wrapRegex(value)).endObject().endObject()
@@ -740,6 +763,8 @@ class ElasticsearchPlugin(application: Application) extends Plugin {
           val cleaned = if (!value.startsWith("metadata.")) "metadata."+value else value
           builder.startObject().startObject("bool").startArray("must_not").startObject()
             .startObject("exists").field("field", cleaned).endObject().endObject().endArray().endObject().endObject()
+        } else if (key == "created") {
+          builder.startObject.startObject("range").startObject(key).field("gte", startdate).field("lte", enddate).endObject.endObject.endObject
         } else {
           val cleaned = value.replace(":", "\\:") // Colons have special meaning in query_string
           builder.startObject().startObject("query_string").field("default_field", key)
@@ -901,7 +926,7 @@ class ElasticsearchPlugin(application: Application) extends Plugin {
     }
 
     // If a term is specified that isn't in this list, it's assumed to be a metadata field
-    val official_terms = List("name", "creator", "email", "resource_type", "in", "contains", "tag", "exists", "missing")
+    val official_terms = List("name", "creator", "created", "email", "resource_type", "in", "contains", "tag", "exists", "missing")
 
     // Create list of (key, operator, value) for passing to builder
     val terms = ListBuffer[(String, String, String)]()
@@ -932,6 +957,9 @@ class ElasticsearchPlugin(application: Application) extends Plugin {
         else if (mt == "in") currkey = "child_of"
         else if (mt == "contains") currkey = "parent_of"
         else if (mt == "creator") currkey = "creator_name"
+        else if (mt == "created") {
+          currkey = "created"
+        }
         else if (mt == "email") currkey = "creator_email"
         else if (!official_terms.contains(mt)) currkey = "metadata."+mt
         else

app/views/searchResults.scala.html

@@ -59,6 +59,9 @@ <h1>Search</h1>
                         <tr><td>name</td>
                             <td>name:VIS_SV_180_z1_1207272.png</td>
                             <td>@Messages("help.search.name", Messages("dataset.title").toLowerCase, Messages("collection.title").toLowerCase)</td></tr>
+                        <tr><td>created</td>
+                            <td>created:2021-04-19</td>
+                            <td>@Messages("help.search.created")</td></tr>
                         <tr><td>creator</td>
                             <td>creator:Smith</td>
                             <td>@Messages("help.search.creator")</td></tr>

conf/messages

@@ -75,6 +75,7 @@ help.search.allfields=name, description, creator name, and tag
 help.search.regex1=get anything with "trees" or "streetcars" in basic fields
 help.search.name=searches file, {0} or {1} names
 help.search.creator=creator name
+help.search.created=date of upload/creation
 help.search.email=creator email address
 help.search.resource_type=can be file, {0} or {1}
 help.search.tag=filter search results by specific tags