From dded376db176c9dd79402d09dea7e73c7b2f9c38 Mon Sep 17 00:00:00 2001
From: k3b <1374583+k3b@users.noreply.github.com>
Date: Tue, 19 Jan 2021 18:17:04 +0100
Subject: [PATCH] #169: Introduced visibility "hidden"

---
 .../PhotoPropertiesMediaDBContentValues.java  | 10 ++----
 .../media/PhotoPropertiesMediaDBCursor.java   |  5 +--
 .../androFotoFinder/queries/FotoSql.java      | 35 +++++++++++++++++--
 .../android/androFotoFinder/tagDB/TagSql.java |  3 ++
 .../tagDB/TagSqlQueryParserTests.java         |  5 +++
 .../src/main/java/de/k3b/io/VISIBILITY.java   | 27 ++++++++++----
 .../transactionlog/TransactionLoggerBase.java |  2 +-
 .../k3b/media/PhotoPropertiesUtilTests.java   |  4 +++
 8 files changed, 69 insertions(+), 22 deletions(-)

diff --git a/app/src/main/java/de/k3b/android/androFotoFinder/media/PhotoPropertiesMediaDBContentValues.java b/app/src/main/java/de/k3b/android/androFotoFinder/media/PhotoPropertiesMediaDBContentValues.java
index 15f65690..ac58b38d 100644
--- a/app/src/main/java/de/k3b/android/androFotoFinder/media/PhotoPropertiesMediaDBContentValues.java
+++ b/app/src/main/java/de/k3b/android/androFotoFinder/media/PhotoPropertiesMediaDBContentValues.java
@@ -161,10 +161,7 @@ public IPhotoProperties setRating(Integer value) {
     public VISIBILITY getVisibility() {
         Integer ty = mData.getAsInteger(TagSql.SQL_COL_EXT_MEDIA_TYPE);
         if (ty != null) {
-            if (ty.intValue() == FotoSql.MEDIA_TYPE_IMAGE_PRIVATE)
-                return VISIBILITY.PRIVATE;
-
-            return VISIBILITY.PUBLIC;
+            return FotoSql.mediaType2Visibility(ty.intValue());
         }
         return null;
     }
@@ -172,10 +169,7 @@ public VISIBILITY getVisibility() {
     @Override
     public IPhotoProperties setVisibility(VISIBILITY value) {
         if (VISIBILITY.isChangingValue(value)) {
-            int iValue = (value.equals(VISIBILITY.PRIVATE))
-                    ? FotoSql.MEDIA_TYPE_IMAGE_PRIVATE
-                    : FotoSql.MEDIA_TYPE_IMAGE;
-            mData.put(TagSql.SQL_COL_EXT_MEDIA_TYPE, iValue);
+            mData.put(TagSql.SQL_COL_EXT_MEDIA_TYPE, FotoSql.mediaTypeFromVisibility(value));
             setLastXmpFileModifyDate();
         }
         return this;
diff --git a/app/src/main/java/de/k3b/android/androFotoFinder/media/PhotoPropertiesMediaDBCursor.java b/app/src/main/java/de/k3b/android/androFotoFinder/media/PhotoPropertiesMediaDBCursor.java
index 1f379dcf..380a852f 100644
--- a/app/src/main/java/de/k3b/android/androFotoFinder/media/PhotoPropertiesMediaDBCursor.java
+++ b/app/src/main/java/de/k3b/android/androFotoFinder/media/PhotoPropertiesMediaDBCursor.java
@@ -119,10 +119,7 @@ public VISIBILITY getVisibility() {
         if (colType == -1) return null;
         Integer ty = cursor.getInt(colType);
         if (ty != null) {
-            if (ty.intValue() == FotoSql.MEDIA_TYPE_IMAGE_PRIVATE)
-                return VISIBILITY.PRIVATE;
-
-            return VISIBILITY.PUBLIC;
+            return FotoSql.mediaType2Visibility(ty.intValue());
         }
         return null;
     }
diff --git a/app/src/main/java/de/k3b/android/androFotoFinder/queries/FotoSql.java b/app/src/main/java/de/k3b/android/androFotoFinder/queries/FotoSql.java
index 34bbc5f8..57284602 100644
--- a/app/src/main/java/de/k3b/android/androFotoFinder/queries/FotoSql.java
+++ b/app/src/main/java/de/k3b/android/androFotoFinder/queries/FotoSql.java
@@ -151,12 +151,16 @@ public class FotoSql extends FotoSqlBase {
     private static final int LAST_MODIFIED_FACTOR = 1000;
 
     public static final int MEDIA_TYPE_IMAGE_PRIVATE = 1000 + MEDIA_TYPE_IMAGE;                 // 1001 APhoto manager specific
-    public static final int MEDIA_TYPE_ALBUM_FILE    = 0;
+    public static final int MEDIA_TYPE_IMAGE_HIDDEN = 1100 + MEDIA_TYPE_IMAGE;                 // 1101 APhoto manager specific
+    public static final int MEDIA_TYPE_ALBUM_FILE = 0;
 
     protected static final String FILTER_EXPR_PRIVATE
             = "(" + SQL_COL_EXT_MEDIA_TYPE + " = " + MEDIA_TYPE_IMAGE_PRIVATE + ")";
+    protected static final String FILTER_EXPR_HIDDEN
+            = "(" + SQL_COL_EXT_MEDIA_TYPE + " = " + MEDIA_TYPE_IMAGE_HIDDEN + ")";
+
     public static final String FILTER_EXPR_PRIVATE_PUBLIC
-            = "(" + SQL_COL_EXT_MEDIA_TYPE + " in (" + MEDIA_TYPE_IMAGE_PRIVATE + "," + MEDIA_TYPE_IMAGE +"))";
+            = "(" + SQL_COL_EXT_MEDIA_TYPE + " in (" + MEDIA_TYPE_IMAGE_PRIVATE + "," + MEDIA_TYPE_IMAGE + "))";
     protected static final String FILTER_EXPR_PUBLIC
             = "(" + SQL_COL_EXT_MEDIA_TYPE + " = " + MEDIA_TYPE_IMAGE + ")";
 
@@ -1329,6 +1333,31 @@ private static List<String> getFileNamesImpl(QueryParameter parameters, List<Lon
         return result;
     }
 
+    public static VISIBILITY mediaType2Visibility(final int mediaTypeId) {
+        switch (mediaTypeId) {
+            case FotoSql.MEDIA_TYPE_IMAGE_PRIVATE:
+                return VISIBILITY.PRIVATE;
+            case FotoSql.MEDIA_TYPE_IMAGE_HIDDEN:
+                return VISIBILITY.PRIVATE;
+            default:
+                return VISIBILITY.PUBLIC;
+        }
+
+
+    }
+
+    public static int mediaTypeFromVisibility(VISIBILITY value) {
+        switch (value) {
+            case HIDDEN:
+                return FotoSql.MEDIA_TYPE_IMAGE_HIDDEN;
+            case PRIVATE:
+                return FotoSql.MEDIA_TYPE_IMAGE_PRIVATE;
+            case PUBLIC:
+            default:
+                return FotoSql.MEDIA_TYPE_IMAGE;
+        }
+    }
+
     protected static String getFilterExpressionVisibility(VISIBILITY _visibility) {
         VISIBILITY visibility = _visibility;
         // add visibility column only if not included yet
@@ -1343,6 +1372,8 @@ protected static String getFilterExpressionVisibility(VISIBILITY _visibility) {
                 return FILTER_EXPR_PRIVATE;
             case PRIVATE_PUBLIC:
                 return FILTER_EXPR_PRIVATE_PUBLIC;
+            case HIDDEN:
+                return FILTER_EXPR_HIDDEN;
             case PUBLIC:
             default:
                 return FILTER_EXPR_PUBLIC;
diff --git a/app/src/main/java/de/k3b/android/androFotoFinder/tagDB/TagSql.java b/app/src/main/java/de/k3b/android/androFotoFinder/tagDB/TagSql.java
index b607cfa9..63d317fe 100644
--- a/app/src/main/java/de/k3b/android/androFotoFinder/tagDB/TagSql.java
+++ b/app/src/main/java/de/k3b/android/androFotoFinder/tagDB/TagSql.java
@@ -112,6 +112,9 @@ public static IGalleryFilter parseQueryEx(QueryParameter query, boolean remove)
             if (getParams(query, FILTER_EXPR_PRIVATE, remove) != null) {
                 resultFilter.setVisibility(VISIBILITY.PRIVATE);
             }
+            if (getParams(query, FILTER_EXPR_HIDDEN, remove) != null) {
+                resultFilter.setVisibility(VISIBILITY.HIDDEN);
+            }
             if (getParams(query, FILTER_EXPR_PUBLIC, remove) != null) {
                 resultFilter.setVisibility(VISIBILITY.PUBLIC);
             }
diff --git a/app/src/test/java/de/k3b/android/androFotoFinder/tagDB/TagSqlQueryParserTests.java b/app/src/test/java/de/k3b/android/androFotoFinder/tagDB/TagSqlQueryParserTests.java
index 595b2bf0..db228ff6 100644
--- a/app/src/test/java/de/k3b/android/androFotoFinder/tagDB/TagSqlQueryParserTests.java
+++ b/app/src/test/java/de/k3b/android/androFotoFinder/tagDB/TagSqlQueryParserTests.java
@@ -67,6 +67,11 @@ public void shouldParsePublic() {
         assertFilterQueryFilter(VISIBILITY.PUBLIC);
     }
 
+    @Test
+    public void shouldParseHidden() {
+        assertFilterQueryFilter(VISIBILITY.HIDDEN);
+    }
+
     @Test
     public void shouldFilterFind() {
         assertFilterFind("hello world", "shouldFilterFind");
diff --git a/fotolib2/src/main/java/de/k3b/io/VISIBILITY.java b/fotolib2/src/main/java/de/k3b/io/VISIBILITY.java
index 088928ce..094f1b2c 100644
--- a/fotolib2/src/main/java/de/k3b/io/VISIBILITY.java
+++ b/fotolib2/src/main/java/de/k3b/io/VISIBILITY.java
@@ -28,14 +28,26 @@
 import de.k3b.LibGlobal;
 
 public enum VISIBILITY {
-    /** take from current settings */
+    /**
+     * take from current settings
+     */
     DEFAULT(0),
-    /** private only */
+    /**
+     * private only
+     */
     PRIVATE(1),
-    /** public only */
+    /**
+     * public only
+     */
     PUBLIC(2),
-    /** private and public images but not other files like album-files */
-    PRIVATE_PUBLIC(3);
+
+    /**
+     * Used as Filter: private and public images but not other files like album-files
+     */
+    PRIVATE_PUBLIC(3),
+
+    /* Hidden Photo (inside directoryname starting with "." or Directory miwth ".nomedia" file */
+    HIDDEN(4);
 
     // #100: if photo has this tag it has visibility PRIVATE
     public static final String TAG_PRIVATE = "PRIVATE";
@@ -44,7 +56,7 @@ public enum VISIBILITY {
     // causes "SLF4J: Class path contains multiple SLF4J bindings." in unittests :-(
     // private static final Logger logger = LoggerFactory.getLogger(LibGlobal.LOG_TAG);
 
-    public static final VISIBILITY MAX = PRIVATE_PUBLIC;
+    public static final VISIBILITY MAX = HIDDEN;
     public final int value;
 
     private VISIBILITY(int value) {
@@ -71,6 +83,7 @@ public static VISIBILITY fromString(String value) {
                 if (lower.startsWith("private_p")) return PRIVATE_PUBLIC;
                 if (lower.startsWith("pr")) return PRIVATE;
                 if (lower.startsWith("pu")) return PUBLIC;
+                if (lower.startsWith("hi")) return HIDDEN;
                 switch (lower.charAt(0)) {
                     case 'd' :
                         return DEFAULT;
@@ -92,7 +105,7 @@ public static VISIBILITY fromString(String value) {
     }
 
     public static boolean isChangingValue(VISIBILITY value) {
-        return ((value == PRIVATE) || (value == PUBLIC));
+        return ((value == PRIVATE) || (value == PUBLIC) || (value == HIDDEN));
     }
 
     public static boolean hasPrivate(List<String> tags) {
diff --git a/fotolib2/src/main/java/de/k3b/transactionlog/TransactionLoggerBase.java b/fotolib2/src/main/java/de/k3b/transactionlog/TransactionLoggerBase.java
index 6a9a2d32..fb3d5748 100644
--- a/fotolib2/src/main/java/de/k3b/transactionlog/TransactionLoggerBase.java
+++ b/fotolib2/src/main/java/de/k3b/transactionlog/TransactionLoggerBase.java
@@ -84,7 +84,7 @@ public void addChanges(IPhotoProperties newData, EnumSet<FieldID> changes, List<
 
         final VISIBILITY visibility = newData.getVisibility();
         if (changes.contains(FieldID.visibility) && VISIBILITY.isChangingValue(visibility)) {
-            addChanges(MediaTransactionLogEntryType.VISIBILITY, ((VISIBILITY.PRIVATE.equals(visibility)) ? "1": "0") + " " + visibility, false);
+            addChanges(MediaTransactionLogEntryType.VISIBILITY, ((!VISIBILITY.PUBLIC.equals(visibility)) ? "1" : "0") + " " + visibility, false);
         }
 
     }
diff --git a/fotolib2/src/test/java/de/k3b/media/PhotoPropertiesUtilTests.java b/fotolib2/src/test/java/de/k3b/media/PhotoPropertiesUtilTests.java
index 1e4adbe8..04e94748 100644
--- a/fotolib2/src/test/java/de/k3b/media/PhotoPropertiesUtilTests.java
+++ b/fotolib2/src/test/java/de/k3b/media/PhotoPropertiesUtilTests.java
@@ -179,6 +179,10 @@ public void shouldNotCalculateModifiedPath() {
         check(null, "/path/to/file.jpg-p", VISIBILITY.PRIVATE);
         check(null, "/path/to/file.jpg", VISIBILITY.PRIVATE_PUBLIC);
         check(null, "/path/to/file.jpg", VISIBILITY.DEFAULT);
+        check(null, "/path/to/file.jpg", VISIBILITY.HIDDEN);
+        check(null, "/path/to/file.jpg-p", VISIBILITY.HIDDEN);
+        check(null, "/path/to/file.jpg", null);
+        check(null, "/path/to/file.jpg-p", null);
     }