Add photo tree search template in configuration

asaintsever · asaintsever · commit ad8ba2e58ade · 2022-10-23T13:30:07.000+02:00
diff --git a/GNUmakefile b/GNUmakefile
@@ -13,7 +13,7 @@ IMAGE_FQIN:=asaintsever/tinyworld
 .DEFAULT_GOAL := help
 
 help: ## Show Help
-	grep -E '^[a-zA-Z_-]+:.*?## .*$$' Makefile | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+	grep -E '^[a-zA-Z_-]+:.*?## .*$$' *makefile | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
 
 init: ## Init build (to run once)
 	mvn validate
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@
 - Geolocalize photos on virtual globe with metadata in annotations
 - Search & filter capabilities to easily navigate your photos (by dates, countries, ...)
 - Offline mode (use local cache for globe data)
-- Available as portable app, AppImage package and OCI image
+- Available as portable app, AppImage package and OCI image *(i.e. container)*
 
 ## Supported Photo Formats
 
@@ -24,7 +24,7 @@
 ## Requirements
 
 - Linux or WSL2 for AppImage
-- Docker or Podman for OCI image
+- Docker or [Podman](https://podman.io/) for OCI image
 
 ## Configuration
 
@@ -60,7 +60,7 @@ By default, 4Gb of memory is set via Xmx/Xms Java options. You can override this
 JAVA_OPTS="-Xmx2048m -Xms1024m" ./TinyWorld-<release version>-x86_64.AppImage
 ```
 
-### Using OCI Image on Linux/WSL2
+### Using OCI Image
 
 ```sh
 <docker|podman> run --rm -e DISPLAY -v "$HOME/.Xauthority:/root/.Xauthority:rw" -v "$HOME/.tinyworld:/root/.tinyworld" -v "$HOME/var/cache:/root/var/cache" --network host asaintsever/tinyworld:<release version>
@@ -87,8 +87,11 @@ In case you experience scaling issue with High DPI (such as globe not filling th
 
 ### Requirements
 
-- Make
-- Maven 3
+- GNU Make 4+
+
+    > *On MacOS, you can install/update GNU Make using [brew](https://brew.sh/): `brew install make`*
+
+- Maven 3+
 - Java JDK 17
 - zip/unzip *(to generate TinyWorld portable app for Windows)*
 - Podman *(to generate TinyWorld OCI image)*
diff --git a/cfg/README.md b/cfg/README.md
@@ -18,8 +18,9 @@ Following env vars allow to override values in TinyWorld's config file (`tinywor
 |-----|-----------------|-------------|
 | TW_UI_LOGS_WWJ | `on` (default), `off` | Enable logs for NASA WorldWind |
 | TW_UI_LOGS_FLATLAF | `on` (default), `off` | Enable logs for FlatLaf framework |
+| TW_UI_PHOTOTREE_FILTER_TMPL | Any valid search template name. Default is `year_month` | Search template to use in photo tree |
 | TW_IDX_CLUSTER_EMBEDDED | `true` (default), `false` | Use TinyWorld's embedded cluster (OpenSearch). Set to `false` to use your own ElasticSearch / OpenSearch cluster |
 | TW_IDX_CLUSTER_EMBEDDED_EXPOSE | `true`, `false` (default) | Expose embedded cluster to external machines (with CORS enabled as well) |
-| TW_IDX_CLUSTER_ADDRESS | any address. Default is `localhost` | Address of OpenSearch / Elasticsearch cluster |
-| TW_IDX_CLUSTER_PORT | a valid port number. Default is `9200` | Cluster listening port |
-| TW_IDX_CLUSTER_INDEX | any valid index name. Default is `photos` | Cluster index name |
+| TW_IDX_CLUSTER_ADDRESS | Any address. Default is `localhost` | Address of OpenSearch / Elasticsearch cluster |
+| TW_IDX_CLUSTER_PORT | A valid port number. Default is `9200` | Cluster listening port |
+| TW_IDX_CLUSTER_INDEX | Any valid index name. Default is `photos` | Cluster index name |
diff --git a/cfg/pom.xml b/cfg/pom.xml
@@ -8,7 +8,7 @@
   <artifactId>cfg</artifactId>
 
   <properties>
-    <commons.text.version>1.9</commons.text.version>
+    <commons.text.version>1.10.0</commons.text.version>
   </properties>
 
   <dependencies>
diff --git a/cfg/src/main/java/asaintsever/tinyworld/cfg/Configuration.java b/cfg/src/main/java/asaintsever/tinyworld/cfg/Configuration.java
@@ -32,11 +32,22 @@ public class Configuration {
     @ToString
     public class UI {
         public Deps deps;
+        public PhotoTree photoTree;
 
         @ToString
         public class Deps {
             public Map<String, String> logging;
         }
+        
+        @ToString
+        public class PhotoTree {
+            public Filter filter;
+            
+            @ToString
+            public class Filter {
+                public String template;
+            }
+        }
     }
 
     @ToString
diff --git a/cfg/src/main/java/asaintsever/tinyworld/cfg/Loader.java b/cfg/src/main/java/asaintsever/tinyworld/cfg/Loader.java
@@ -44,7 +44,7 @@ public class Loader {
     private static StringSubstitutor stringSubstitutor = new StringSubstitutor(
             StringLookupFactory.INSTANCE.environmentVariableStringLookup());
 
-    public static void setPathToConfigFile(String pathCfg) {
+    static void setPathToConfigFile(String pathCfg) {
         TINYWORLD_CONFIG_FILE_PATH = Paths.get(pathCfg);
     }
 
diff --git a/cfg/src/main/resources/config/tinyworld.yml b/cfg/src/main/resources/config/tinyworld.yml
@@ -5,6 +5,9 @@ ui:
     logging:      # logging for dependencies
       wwj: ${TW_UI_LOGS_WWJ:-on}          # on/off
       flatlaf: ${TW_UI_LOGS_FLATLAF:-on}  # on/off
+  photoTree:
+    filter:
+      template: ${TW_UI_PHOTOTREE_FILTER_TMPL:-year_month}  # search template to use: year_month, year_country_month, country_year_month
  
 indexor:
   # Default TinyWorld's embedded cluster is running at localhost:9200
diff --git a/cfg/src/test/java/asaintsever/tinyworld/cfg/LoaderTest.java b/cfg/src/test/java/asaintsever/tinyworld/cfg/LoaderTest.java
@@ -45,6 +45,7 @@ void loadDefaultInternalConfig() {
         assertEquals(cfg.indexor.cluster.address, "localhost");
         assertEquals(cfg.indexor.cluster.port, 9200);
         assertEquals(cfg.indexor.cluster.index, "photos");
+        assertEquals(cfg.ui.photoTree.filter.template, "year_month");
     }
 
     @Test
@@ -58,6 +59,7 @@ void loadDefaultInternalConfig() {
     @SetEnvironmentVariable(key = "TW_IDX_CLUSTER_ADDRESS", value = "127.0.0.1")
     @SetEnvironmentVariable(key = "TW_IDX_CLUSTER_PORT", value = "9210")
     @SetEnvironmentVariable(key = "TW_IDX_CLUSTER_INDEX", value = "test")
+    @SetEnvironmentVariable(key = "TW_UI_PHOTOTREE_FILTER_TMPL", value = "country_year_month")
     void loadDefaultInternalConfigOverrideWithEnv() {
         Configuration cfg = Loader.getConfig(false);
         assertNotNull(cfg);
@@ -69,6 +71,7 @@ void loadDefaultInternalConfigOverrideWithEnv() {
         assertEquals(cfg.indexor.cluster.address, "127.0.0.1");
         assertEquals(cfg.indexor.cluster.port, 9210);
         assertEquals(cfg.indexor.cluster.index, "test");
+        assertEquals(cfg.ui.photoTree.filter.template, "country_year_month");
     }
 
     @Test
@@ -85,5 +88,6 @@ void loadCustomConfig() {
         assertEquals(cfg.indexor.cluster.address, "localhost");
         assertEquals(cfg.indexor.cluster.port, 9200);
         assertEquals(cfg.indexor.cluster.index, "my_index");
+        assertEquals(cfg.ui.photoTree.filter.template, "year_country_month");
     }
 }
diff --git a/cfg/src/test/resources/cfg_test1.yml b/cfg/src/test/resources/cfg_test1.yml
@@ -5,6 +5,9 @@ ui:
     logging:      # logging for dependencies
       wwj: off          # on/off
       flatlaf: off      # on/off
+  photoTree:
+    filter:
+      template: "year_country_month"  # search template to use
  
 indexor:
   # Default TinyWorld's embedded cluster is running at localhost:9200
diff --git a/indexor/src/main/java/asaintsever/tinyworld/indexor/opensearch/Document.java b/indexor/src/main/java/asaintsever/tinyworld/indexor/opensearch/Document.java
@@ -58,8 +58,7 @@ public class Document<T> implements Closeable {
     private String index;
 
     // Used for search and templates only (new Java client search capabilities not on par compared to
-    // high-level rest
-    // client)
+    // high-level rest client)
     // To be removed once new Java client fully supports all search expressions and search templates
     // aggregations
     private RestHighLevelClient restHlClient;
diff --git a/metadata-extractor/src/main/java/asaintsever/tinyworld/metadata/extractor/PhotoObject.java b/metadata-extractor/src/main/java/asaintsever/tinyworld/metadata/extractor/PhotoObject.java
@@ -64,6 +64,8 @@
 
 public class PhotoObject {
     protected static Logger logger = LoggerFactory.getLogger(PhotoObject.class);
+    protected static final int THUMBNAIL_WIDTH = 160;
+    protected static final int THUMBNAIL_HEIGHT = 160;
     private static ObjectMapper mapper;
     private PhotoMetadata metadata;
 
@@ -221,7 +223,8 @@ public PhotoObject extractThumbnail(URI uri, FileType fileType, Metadata metadat
 
                 IMOperation op = new IMOperation();
                 op.addImage(uri.toString());
-                op.thumbnail(160, 160).addImage("jpg:-"); // Generate thumbnail on stdout (jpg format)
+                op.thumbnail(THUMBNAIL_WIDTH, THUMBNAIL_HEIGHT).addImage("jpg:-"); // Generate thumbnail on stdout (jpg
+                                                                                   // format)
 
                 try {
                     cmd.run(op);
@@ -237,9 +240,9 @@ public PhotoObject extractThumbnail(URI uri, FileType fileType, Metadata metadat
                 }
             } else {
                 try (ByteArrayOutputStream baos = new ByteArrayOutputStream()) {
-                    // Create thumbnail from photo, resized to a maximum dimension of 160 x 160, maintaining the aspect
-                    // ratio of the original image
-                    Thumbnails.of(uri.toURL()).size(160, 160).toOutputStream(baos);
+                    // Create thumbnail from photo, resized to a maximum dimension of THUMBNAIL_WIDTH x
+                    // THUMBNAIL_HEIGHT, maintaining the aspect ratio of the original image
+                    Thumbnails.of(uri.toURL()).size(THUMBNAIL_WIDTH, THUMBNAIL_HEIGHT).toOutputStream(baos);
                     thumbnail = baos.toByteArray();
                 }
             }
diff --git a/ui/pom.xml b/ui/pom.xml
@@ -8,7 +8,7 @@
   <artifactId>ui</artifactId>
 
   <properties>
-    <flatlaf.version>2.4</flatlaf.version>
+    <flatlaf.version>2.6</flatlaf.version>
     <worldwindjava.version>2.2.0</worldwindjava.version>
   </properties>
 
diff --git a/ui/src/main/java/asaintsever/tinyworld/ui/component/IndexorStatusPanel.java b/ui/src/main/java/asaintsever/tinyworld/ui/component/IndexorStatusPanel.java
@@ -101,8 +101,7 @@ public void created(Indexor indexor) {
         this.indexor = indexor;
 
         // Cancel any already running indexorStatusWorker before creating new one
-        if (this.indexorStatusWorker != null)
-            this.indexorStatusWorker.cancel(false);
+        this.cancelWorkers();
 
         this.indexorStatusWorker = new IndexorStatusWorker(this);
         this.indexorStatusWorker.execute();

Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ public class Loader {`
`44`	`44`	`private static StringSubstitutor stringSubstitutor = new StringSubstitutor(`
`45`	`45`	`StringLookupFactory.INSTANCE.environmentVariableStringLookup());`
`46`	`46`
`47`		`- public static void setPathToConfigFile(String pathCfg) {`
	`47`	`+ static void setPathToConfigFile(String pathCfg) {`
`48`	`48`	`TINYWORLD_CONFIG_FILE_PATH = Paths.get(pathCfg);`
`49`	`49`	`}`
`50`	`50`