Merge pull request #1014 from WildMeOrg/912_mediaasset_in_opensearch

Index MediaAssets in OpenSearch

Author: holmbergius

pom.xml

@@ -382,6 +382,20 @@
       <scope>test</scope>
     </dependency>
 
+<dependency>
+    <groupId>org.mockito</groupId>
+    <artifactId>mockito-inline</artifactId>
+    <version>3.12.4</version>
+    <scope>test</scope>
+</dependency>
+
+    <dependency>
+      <groupId>org.mockito</groupId>
+      <artifactId>mockito-core</artifactId>
+      <version>3.12.4</version>
+      <scope>test</scope>
+    </dependency>
+
     <dependency>
       <groupId>org.geotools</groupId>
       <artifactId>gt-shapefile</artifactId>

src/main/java/org/ecocean/Annotation.java

@@ -168,7 +168,7 @@ public void opensearchDocumentSerializer(JsonGenerator jgen, Shepherd myShepherd
         jgen.writeBooleanField("matchAgainst", this.getMatchAgainst());
         MediaAsset ma = this.getMediaAsset();
         if (ma != null) {
-            jgen.writeNumberField("mediaAssetId", ma.getId());
+            jgen.writeNumberField("mediaAssetId", ma.getIdInt());
         }
         Encounter enc = this.findEncounter(myShepherd);
         if (enc != null) {

src/main/java/org/ecocean/Encounter.java

@@ -1353,7 +1353,7 @@ private MediaAsset addMediaIfNeeded(Shepherd myShepherd, File mpath, String key,
         MediaAsset ma = astore.find(sp, myShepherd);
         if (ma != null) {
             ma.addLabel(label);
-            if (parentMA != null) ma.setParentId(parentMA.getId());
+            if (parentMA != null) ma.setParentId(parentMA.getIdInt());
             return ma;
         }
         System.out.println("creating new MediaAsset for key=" + key);
@@ -1365,7 +1365,7 @@ private MediaAsset addMediaIfNeeded(Shepherd myShepherd, File mpath, String key,
             return null;
         }
         if (parentMA != null) {
-            ma.setParentId(parentMA.getId());
+            ma.setParentId(parentMA.getIdInt());
             ma.updateMinimalMetadata(); // for children (ostensibly derived?) MediaAssets, really only need minimal metadata or so i claim
         } else {
             try {
@@ -1417,7 +1417,7 @@ public MediaAsset spotImageAsMediaAsset(MediaAsset parent, String baseDir,
                 System.out.println("spotImageAsMediaAsset threw IOException " + ex.toString());
             }
         }
-        ma.setParentId(parent.getId());
+        ma.setParentId(parent.getIdInt());
         return ma;
     }
 
@@ -2897,7 +2897,7 @@ public int indexOfMediaAsset(int id) {
         for (int i = 0; i < annotations.size(); i++) {
             MediaAsset ma = annotations.get(i).getMediaAsset();
             if (ma == null) continue;
-            if (ma.getId() == id) return i;
+            if (ma.getIdInt() == id) return i;
         }
         return -1;
     }
@@ -2928,7 +2928,7 @@ public void replaceAnnotation(Annotation oldAnn, Annotation newAnn) {
     }
 
     public void removeMediaAsset(MediaAsset ma) {
-        removeAnnotation(indexOfMediaAsset(ma.getId()));
+        removeAnnotation(indexOfMediaAsset(ma.getIdInt()));
     }
 
     // this is a kinda hacky way to find media ... really used by encounter.jsp now but likely should go away?
@@ -3370,7 +3370,7 @@ public boolean restAccess(HttpServletRequest request, org.json.JSONObject jsonob
         return true;
     }
 
-///////// these are bunk now - dont use Features  TODO: fix these - perhaps by crawlng thru ma.getAnnotations() ?
+///////// this is bunk now: see fix for findAllByMediaAsset() if you need this
     public static Encounter findByMediaAsset(MediaAsset ma, Shepherd myShepherd) {
         String queryString =
             "SELECT FROM org.ecocean.Encounter WHERE annotations.contains(ann) && ann.mediaAsset.id =="
@@ -3391,8 +3391,8 @@ public static List<Encounter> findAllByMediaAsset(MediaAsset ma, Shepherd myShep
 
         try {
             String queryString =
-                "SELECT FROM org.ecocean.Encounter WHERE annotations.contains(ann) && ann.mediaAsset.id =="
-                + ma.getId();
+                "SELECT FROM org.ecocean.Encounter WHERE annotations.contains(ann) && ann.features.contains(feat) && mediaAsset.features.contains(feat) && mediaAsset.id =="
+                + ma.getId() + " VARIABLES org.ecocean.media.MediaAsset mediaAsset; org.ecocean.Annotation ann; org.ecocean.media.Feature feat";
             Query query = myShepherd.getPM().newQuery(queryString);
             Collection results = (Collection)query.execute();
             returnEncs = new ArrayList<Encounter>(results);
@@ -4069,7 +4069,7 @@ public void opensearchDocumentSerializer(JsonGenerator jgen, Shepherd myShepherd
         jgen.writeArrayFieldStart("mediaAssets");
         for (MediaAsset ma : mas) {
             jgen.writeStartObject();
-            jgen.writeNumberField("id", ma.getId());
+            jgen.writeNumberField("id", ma.getIdInt());
             jgen.writeStringField("uuid", ma.getUUID());
             try {
                 // historic data might throw IllegalArgumentException: Path not under given root

src/main/java/org/ecocean/OpenSearch.java

@@ -14,6 +14,7 @@
 import javax.jdo.Query;
 import javax.net.ssl.SSLContext;
 import javax.net.ssl.SSLEngine;
+import org.ecocean.media.MediaAsset;
 import org.ecocean.SystemValue;
 import org.json.JSONArray;
 import org.json.JSONObject;
@@ -62,7 +63,7 @@ public class OpenSearch {
     public static String SEARCH_PIT_TIME = (String)getConfigurationValue("searchPitTime", "10m");
     public static String INDEX_TIMESTAMP_PREFIX = "OpenSearch_index_timestamp_";
     public static String[] VALID_INDICES = {
-        "encounter", "individual", "occurrence", "annotation"
+        "encounter", "individual", "occurrence", "annotation", "media_asset"
     };
     public static int BACKGROUND_DELAY_MINUTES = (Integer)getConfigurationValue(
         "backgroundDelayMinutes", 20);
@@ -159,6 +160,8 @@ public void run() {
                         BACKGROUND_SLICE_SIZE);
                         Base.opensearchSyncIndex(myShepherd, MarkedIndividual.class,
                         BACKGROUND_SLICE_SIZE);
+                        Base.opensearchSyncIndex(myShepherd, MediaAsset.class,
+                        BACKGROUND_SLICE_SIZE);
                         System.out.println("OpenSearch background indexing finished.");
                         myShepherd.rollbackAndClose();
                     } catch (Exception ex) {

src/main/java/org/ecocean/Shepherd.java

@@ -2146,6 +2146,26 @@ public Iterator getAllMediaAssets() {
         }
     }
 
+    // note: where clause can also contain " ORDER BY xxx"
+    public Iterator getMediaAssetsFilter(String jdoWhereClause) {
+        Query query = null;
+
+        try {
+            query = pm.newQuery("SELECT FROM org.ecocean.media.MediaAsset WHERE " + jdoWhereClause);
+            Collection c = (Collection)(query.execute());
+            List list = new ArrayList(c);
+            Iterator it = list.iterator();
+            query.closeAll();
+            return it;
+        } catch (Exception npe) {
+            System.out.println(
+                "Error encountered when trying to execute getAllAnnotationsFilter. Returning a null iterator.");
+            npe.printStackTrace();
+            if (query != null) query.closeAll();
+            return null;
+        }
+    }
+
     public ArrayList<MediaAsset> getAllMediaAssetsAsArray() {
         try {
             Extent maClass = pm.getExtent(MediaAsset.class, true);

src/main/java/org/ecocean/api/BaseObject.java

@@ -145,7 +145,7 @@ protected JSONObject processPost(HttpServletRequest request, String[] args, JSON
                     maj.put("uuid", ma.getUUID());
                     maj.put("url", ma.webURL());
                     assetsArr.put(maj);
-                    maIds.add(ma.getId());
+                    maIds.add(ma.getIdInt());
                 }
                 rtn.put("assets", assetsArr);
                 enc.setAnnotations(anns);

src/main/java/org/ecocean/identity/IBEISIA.java

@@ -1119,7 +1119,7 @@ private static boolean needToSend(MediaAsset ma) {
     }
 
     private static void markSent(MediaAsset ma) {
-        alreadySentMA.put(ma.getId(), true);
+        alreadySentMA.put(ma.getIdInt(), true);
     }
 
     private static boolean needToSend(Annotation ann) {
@@ -1600,8 +1600,8 @@ private static JSONObject processCallbackDetect(String taskID,
                     MediaAsset asset = null;
                     for (MediaAsset ma : mas) {
                         if (ma.getAcmId() == null) continue; // was likely an asset rejected (e.g. video)
-                        if (ma.getAcmId().equals(iuuid) && !alreadyDetected.contains(ma.getId())) {
-                            alreadyDetected.add(ma.getId());
+                        if (ma.getAcmId().equals(iuuid) && !alreadyDetected.contains(ma.getIdInt())) {
+                            alreadyDetected.add(ma.getIdInt());
                             asset = ma;
                             break;
                         }
@@ -1674,7 +1674,7 @@ private static JSONObject processCallbackDetect(String taskID,
                     if (newAnns.length() > 0) {
                         List<Encounter> assignedEncs = asset.assignEncounters(myShepherd); // here is where we make some encounter(s) if we need to
                         rtn.put("_assignedEncsSize", assignedEncs.size());
-                        amap.put(Integer.toString(asset.getId()), newAnns);
+                        amap.put(Integer.toString(asset.getIdInt()), newAnns);
                         // now we have to collect them under an Occurrence and/or ImportTask as applicable
                         // we basically pick the first of these we find (in case there is more than one?)
                         // and only assign it where there is none.

src/main/java/org/ecocean/media/AssetStore.java

@@ -215,7 +215,7 @@ public MediaAsset findOrCreate(JSONObject params, Shepherd myShepherd) {
        3) restricting to store is kinda silly cuz id is primary key so would never have duplicate id across more than one store anyway
      */
     public ArrayList<MediaAsset> findAllChildren(MediaAsset parent, Shepherd myShepherd) {
-        if ((parent == null) || (parent.getId() < 1)) return null;
+        if ((parent == null) || (parent.getIdInt() < 1)) return null;
         ArrayList<MediaAsset> all = new ArrayList<MediaAsset>();
         Extent mac = myShepherd.getPM().getExtent(MediaAsset.class, true);
         Query matches = myShepherd.getPM().newQuery(mac, "parentId == " + parent.getId());
@@ -294,7 +294,7 @@ public MediaAsset updateChild(MediaAsset parent, String type, HashMap<String, Ob
         MediaAsset ma = this.copyIn(targetFile, sp);
         if (ma == null) return null; // not sure how this would happen *without* an exception, but meh.
         ma.addLabel("_" + type);
-        ma.setParentId(parent.getId());
+        ma.setParentId(parent.getIdInt());
         if ((opts != null) && (opts.get("feature") != null)) {
             Feature ft = (Feature)opts.get("feature");
             ma.addDerivationMethod("feature", ft.getId());

src/main/java/org/ecocean/media/MediaAsset.java

@@ -1,5 +1,7 @@
 package org.ecocean.media;
 
+import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.core.JsonProcessingException;
 import java.io.File;
 import java.io.FileOutputStream;
 import java.io.IOException;
@@ -21,6 +23,7 @@
 import org.apache.commons.lang3.builder.ToStringBuilder;
 import org.ecocean.AccessControl;
 import org.ecocean.Annotation;
+import org.ecocean.Base;
 import org.ecocean.CommonConfiguration;
 import org.ecocean.Encounter;
 import org.ecocean.ia.Task;
@@ -42,8 +45,9 @@
 /**
  * MediaAsset describes a photo or video that can be displayed or used for processing and analysis.
  */
-public class MediaAsset implements java.io.Serializable {
+public class MediaAsset extends Base implements java.io.Serializable {
     static final long serialVersionUID = 8844223450447974780L;
+    @Override public String opensearchIndexName() { return "media_asset"; }
     protected int id = MediaAssetFactory.NOT_SAVED;
 
     protected String uuid = null;
@@ -93,6 +97,10 @@ public class MediaAsset implements java.io.Serializable {
      * To be called by AssetStore factory method.
      */
 
+    public MediaAsset() {
+        this(MediaAssetFactory.NOT_SAVED, null, null);
+    }
+
     public MediaAsset(final AssetStore store, final JSONObject params) {
         // this(store, params, null);
         this(MediaAssetFactory.NOT_SAVED, store, params);
@@ -146,10 +154,18 @@ private String getUrlString(final URL url) {
         return url.toExternalForm();
     }
 
-    public int getId() {
+    public int getIdInt() {
         return id;
     }
 
+    public String getId() {
+        return String.valueOf(id);
+    }
+
+    public void setId(String s) {
+        id = Integer.parseInt(s);
+    }
+
     public void setId(int i) {
         id = i;
     }
@@ -346,6 +362,10 @@ public void setDerivationMethodAsString(String d) {
         }
     }
 
+    public long getVersion() {
+        return this.revision;
+    }
+
     public long setRevision() {
         this.revision = System.currentTimeMillis();
         return this.revision;
@@ -1143,7 +1163,7 @@ public static void updateStandardChildrenBackground(final String context, int id
     }
 
     public void updateStandardChildrenBackground(String context) { // convenience
-        updateStandardChildrenBackground(context, this.getId());
+        updateStandardChildrenBackground(context, this.getIdInt());
     }
 
     public void setKeywords(ArrayList<Keyword> kws) {
@@ -1363,7 +1383,7 @@ public MediaAssetMetadata setMinimalMetadata(int width, int height, String conte
     }
 
     public void refreshIAStatus(Shepherd myShepherd) {
-        String s = IBEISIA.parseDetectionStatus(Integer.toString(this.getId()), myShepherd);
+        String s = IBEISIA.parseDetectionStatus(Integer.toString(this.getIdInt()), myShepherd);
 
         if (s != null) this.setDetectionStatus(s);
         String cumulative = null;
@@ -1614,4 +1634,69 @@ public int hashCode() {
     public void setIsValidImageForIA(Boolean value) {
         if (value == null) { validImageForIA = null; } else { validImageForIA = value; }
     }
+
+    public JSONObject opensearchMapping() {
+        JSONObject map = super.opensearchMapping();
+        JSONObject keywordType = new JSONObject("{\"type\": \"keyword\"}");
+
+        // "id" is done in Base
+        map.put("acmId", keywordType);
+        map.put("uuid", keywordType);
+        map.put("detectionStatus", keywordType);
+
+        map.put("encounters", new org.json.JSONObject("{\"type\": \"nested\"}"));
+        map.put("annotations", new org.json.JSONObject("{\"type\": \"nested\"}"));
+
+        return map;
+    }
+
+    public void opensearchDocumentSerializer(JsonGenerator jgen, Shepherd myShepherd)
+    throws IOException, JsonProcessingException {
+        super.opensearchDocumentSerializer(jgen, myShepherd);
+
+        jgen.writeStringField("acmId", this.getAcmId());
+        jgen.writeStringField("uuid", this.getUUID());
+        jgen.writeStringField("filename", this.getFilename());
+        jgen.writeStringField("userFilename", this.getUserFilename());
+        jgen.writeStringField("detectionStatus", this.getDetectionStatus());
+        URL url = this.safeURL();
+        jgen.writeStringField("url", (url == null) ? null : url.toString());
+        jgen.writeArrayFieldStart("encounters");
+        for (Encounter enc : Encounter.findAllByMediaAsset(this, myShepherd)) {
+            jgen.writeStartObject();
+            jgen.writeStringField("id", enc.getId());
+            jgen.writeStringField("taxonomy", enc.getTaxonomyString());
+            jgen.writeEndObject();
+        }
+        jgen.writeEndArray();
+        jgen.writeArrayFieldStart("annotations");
+        for (Annotation ann : this.getAnnotations()) {
+            jgen.writeStartObject();
+            jgen.writeStringField("id", ann.getId());
+            jgen.writeStringField("acmId", ann.getAcmId());
+            jgen.writeStringField("iaClass", ann.getIAClass());
+            jgen.writeStringField("viewpoint", ann.getViewpoint());
+            jgen.writeEndObject();
+        }
+        jgen.writeEndArray();
+    }
+
+    @Override public String getAllVersionsSql() {
+        return "SELECT CAST(\"ID\" AS text), \"REVISION\" AS version FROM \"MEDIAASSET\" WHERE \"PARENTID\" IS NULL ORDER BY version";
+    }
+
+    @Override public Base getById(Shepherd myShepherd, String id) {
+        return myShepherd.getMediaAsset(id);
+    }
+
+    // comment cruft only needed for Base class
+    @Override public String getComments() {
+        return null;
+    }
+
+    @Override public void setComments(final String comments) {
+    }
+
+    @Override public void addComments(final String newComments) {
+    }
 }

src/main/java/org/ecocean/media/TwitterAssetStore.java

@@ -161,7 +161,7 @@ public static List<MediaAsset> entitiesAsMediaAssets(MediaAsset ma) {
             kid.addLabel("_entity");
             setEntityMetadata(kid);
             kid.getMetadata().getDataAsString();
-            kid.setParentId(ma.getId());
+            kid.setParentId(ma.getIdInt());
             // derivationMethods?  metadata? (of image) etc.... ??
             mas.add(kid);
         }