Replace the community share switch with none/anonymous/key, share only own SDR input, warn when sharing anonymously, update AIS-catcher and bump version to 1.18 (118)

Author: jvde-github

app/build.gradle

@@ -10,8 +10,8 @@ android {
         applicationId "com.jvdegithub.aiscatcher"
         minSdk 23
         targetSdk 34
-        versionCode 117
-        versionName '1.17'
+        versionCode 118
+        versionName '1.18'
 
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
         externalNativeBuild {

app/src/main/java/com/jvdegithub/aiscatcher/AisCatcherJava.java

@@ -58,7 +58,7 @@ public interface AisCallback {
     static native int createTCPlistener(String p);
     static native int createWebViewer(String p);
 
-    static native int createSharing(boolean b, String key);
+    static native int createSharing(boolean b, String key, boolean anonymous);
 
     static native int setOwnMMSI(int mmsi, int mode, int interval);
 

app/src/main/java/com/jvdegithub/aiscatcher/DeviceManager.java

@@ -156,6 +156,14 @@ public static DeviceType getDeviceType() {
         return deviceType;
     }
 
+    // Sources we receive ourselves. RTLTCP relays someone else's stream, so it is
+    // excluded from the community feed.
+    public static boolean isSharableSource() {
+        return deviceType == DeviceType.RTLSDR || deviceType == DeviceType.AIRSPY ||
+                deviceType == DeviceType.AIRSPYHF || deviceType == DeviceType.HACKRF ||
+                deviceType == DeviceType.SPYSERVER;
+    }
+
     public static String getDeviceTypeDescription() {
 
         switch (deviceType) {

app/src/main/java/com/jvdegithub/aiscatcher/Settings.java

@@ -58,7 +58,7 @@ static void setDefault(Context context) {
         SharedPreferences preferences = PreferenceManager.getDefaultSharedPreferences(context);
 
         preferences.edit().putString("sSHARINGKEY", "").commit();
-        preferences.edit().putBoolean("sSHARING", false).commit();
+        preferences.edit().putString("sSHARINGMODE", "ANONYMOUS").commit();
         preferences.edit().putBoolean("sAUTOSTART", false).commit();
         preferences.edit().putBoolean("sKEEPSCREENON", false).commit();
 
@@ -125,6 +125,7 @@ static boolean setDefaultOnFirst(Context context) {
         boolean pref_set = preferences.getBoolean("pref_set", false);
         if (!pref_set) setDefault(context);
         preferences.edit().putBoolean("pref_set", true).commit();
+        migrateSharing(context);
         return !pref_set;
     }
 
@@ -169,7 +170,12 @@ static public int getModelType(Context context)
 
         private void setSummaries() {
             setSummaryText(new String[]{"w1PORT","tPORT","tHOST","sPORT","sHOST","u1HOST","u1PORT","u2HOST","u2PORT", "u3HOST","u3PORT", "u4HOST","u4PORT", "s1PORT", "rFREQOFFSET", "sSHARINGKEY", "httpURL","httpUSER","httpID","httpINTERVAL"});
-            setSummaryList(new String[]{"rTUNER","rRATE","sRATE","tRATE","tPROTOCOL","tTUNER","mRATE","hRATE","oMODEL_TYPE","oCGF_WIDE","httpPROTOCOL","oOWNMODE"});
+            setSummaryList(new String[]{"rTUNER","rRATE","sRATE","tRATE","tPROTOCOL","tTUNER","mRATE","hRATE","oMODEL_TYPE","oCGF_WIDE","httpPROTOCOL","oOWNMODE","sSHARINGMODE"});
+
+            // a sharing key is only used in KEY mode, ListPreference cannot drive
+            // android:dependency so the field is gated here
+            findPreference("sSHARINGKEY").setEnabled(
+                    "KEY".equals(((ListPreference) findPreference("sSHARINGMODE")).getValue()));
 
             EditTextPreference own = findPreference("oOWNMMSI");
             String mmsi = own.getText();
@@ -487,21 +493,44 @@ static private boolean SetWebViewerOutput(Context context) {
         return true;
     }
 
-    static private boolean SetSharing(Context context) {
-        String defaultKey = "a6392e08-c57e-4e7a-a4fb-d73bfc7619ae";
+    static final String ANONYMOUS_KEY = "a6392e08-c57e-4e7a-a4fb-d73bfc7619ae";
 
+    // Carry the old on/off switch over to the three-way mode. Sharing was off by
+    // default, so anyone who never touched it keeps it off rather than being opted
+    // in by the new Anonymous default.
+    static public void migrateSharing(Context context) {
         SharedPreferences preferences = PreferenceManager.getDefaultSharedPreferences(context);
 
-        boolean b = preferences.getBoolean("sSHARING", false);
-        if (b) {
-            String key = preferences.getString("sSHARINGKEY", defaultKey);
-            if (key.equals("")) key = defaultKey;
-            return AisCatcherJava.createSharing(b, key) == 0;
+        if (preferences.contains("sSHARINGMODE") || !preferences.contains("sSHARING")) return;
+
+        String mode = "NONE";
+        if (preferences.getBoolean("sSHARING", false))
+            mode = preferences.getString("sSHARINGKEY", "").isEmpty() ? "ANONYMOUS" : "KEY";
+
+        preferences.edit().putString("sSHARINGMODE", mode).remove("sSHARING").commit();
+    }
+
+    static private boolean SetSharing(Context context) {
+        SharedPreferences preferences = PreferenceManager.getDefaultSharedPreferences(context);
+
+        String mode = preferences.getString("sSHARINGMODE", "ANONYMOUS");
 
+        // relayed input is not ours to contribute, only what we receive ourselves
+        if (mode.equals("NONE") || !DeviceManager.isSharableSource()) {
+            AisCatcherJava.createSharing(false, ANONYMOUS_KEY, false);
+            return true;
         }
-        else
-            AisCatcherJava.createSharing(b, defaultKey);
-        return true;
+
+        String key = ANONYMOUS_KEY;
+        boolean anonymous = true;
+
+        if (mode.equals("KEY")) {
+            key = preferences.getString("sSHARINGKEY", "");
+            anonymous = key.isEmpty();
+            if (anonymous) key = ANONYMOUS_KEY;
+        }
+
+        return AisCatcherJava.createSharing(true, key, anonymous) == 0;
     }
 
 }

app/src/main/jni/AIS-catcher

@@ -677,14 +677,18 @@ Java_com_jvdegithub_aiscatcher_AisCatcherJava_createWebViewer(JNIEnv *env, jclas
 extern "C"
 JNIEXPORT jint JNICALL
 Java_com_jvdegithub_aiscatcher_AisCatcherJava_createSharing(JNIEnv *env, jclass clazz, jboolean b,
-                                                            jstring k) {
+                                                            jstring k, jboolean anonymous) {
     if(b) {
         jboolean isCopy;
         std::string key = toString(env,k);
 
         sharing = communityFeed = true;
         sharingKey = key;
-        Info() << "Community Sharing: " << key;
+
+        if(anonymous)
+            Warning() << "Sharing anonymously with the aiscatcher.org community. Choose Settings > Community Share to add your own sharing key or to stop sharing.";
+        else
+            Info() << "Community Sharing: " << key;
     }
     else {
         sharing = communityFeed = false;

app/src/main/jni/JNI/AIScatcherNDK.cpp

@@ -4,6 +4,14 @@
         <item>Auto</item><item>1</item><item>2</item><item>3</item><item>4</item><item>5</item><item>6</item><item>7</item><item>8</item><item>9</item><item>10</item><item>11</item><item>12</item><item>13</item><item>14</item><item>15</item><item>16</item><item>17</item><item>18</item><item>19</item><item>20</item><item>21</item><item>22</item><item>23</item><item>24</item><item>25</item><item>26</item><item>27</item><item>28</item><item>29</item><item>30</item><item>31</item><item>32</item><item>33</item><item>34</item><item>35</item><item>36</item><item>37</item><item>38</item><item>39</item><item>40</item><item>41</item><item>42</item><item>43</item><item>44</item><item>45</item><item>46</item><item>47</item><item>48</item><item>49</item><item>50</item>
     </string-array>
 
+    <string-array name="sharing_mode_entries">
+        <item>None</item><item>Anonymous</item><item>Sharing key</item>
+    </string-array>
+
+    <string-array name="sharing_mode_values">
+        <item>NONE</item><item>ANONYMOUS</item><item>KEY</item>
+    </string-array>
+
     <string-array name="rtltcp_rate_array">
         <item>240K</item><item>288K</item><item>1536K</item><item>2304K</item>
     </string-array>

app/src/main/res/values/arrays.xml

@@ -6,10 +6,11 @@
         android:key="system_category"
         android:title="System">
 
-        <SwitchPreferenceCompat
-            android:key="sSHARING"
-            android:summary="Share AIS with aiscatcher.org"
-            android:defaultValue="False"
+        <ListPreference
+            android:key="sSHARINGMODE"
+            android:entries="@array/sharing_mode_entries"
+            android:entryValues="@array/sharing_mode_values"
+            android:defaultValue="ANONYMOUS"
             android:title="Community Share"/>
 
         <EditTextPreference
@@ -300,7 +301,6 @@
 
         <SwitchPreferenceCompat
             android:key="u3SWITCH"
-            android:dependency="sSHARING"
             android:defaultValue="False"
             android:title="UDP Server 3"/>
 
@@ -324,7 +324,6 @@
 
         <SwitchPreferenceCompat
             android:key="u4SWITCH"
-            android:dependency="sSHARING"
             android:defaultValue="False"
             android:title="UDP Server 4"/>