Add unobtrusive notifications. Improve/repair bug reporting. Update outlet overview only if necessary.

Author: David Gräff

.idea/workspace.xml

@@ -16,8 +16,8 @@ android {
     defaultConfig {
         minSdkVersion 14
         targetSdkVersion 20
-        versionCode 87
-        versionName "5.9.2"
+        versionCode 92
+        versionName "5.12"
         applicationId appID
         testApplicationId "oly.netpowerctrl.tests"
         testInstrumentationRunner "android.test.InstrumentationTestRunner"

app/build.gradle

@@ -58,8 +58,10 @@ public void onObserverJobFinished(List<Device> timeout_devices) {
         if (test_state != TestStates.TEST_REACHABLE)
             return;
 
+        // The device may not have a unique id and may be returned as timeout device.
+        // Be careful with equalsByUniqueID which will crash on a device without an id!
         for (Device di : timeout_devices) {
-            if (!di.equalsByUniqueID(device))
+            if (di != device || !di.equalsByUniqueID(device))
                 continue;
             test_state = TestStates.TEST_INIT;
             if (listener != null)
@@ -70,6 +72,9 @@ public void onObserverJobFinished(List<Device> timeout_devices) {
 
     @SuppressWarnings("BooleanMethodIsAlwaysInverted")
     public boolean startTest(Context context) {
+        if (device == null)
+            return false;
+
         test_state = TestStates.TEST_REACHABLE;
 
         if (wakeupPlugin(context))

app/src/main/java/oly/netpowerctrl/anel/AnelEditDevice.java

@@ -19,6 +19,7 @@
 import oly.netpowerctrl.devices.DeviceConnection;
 import oly.netpowerctrl.devices.DeviceConnectionHTTP;
 import oly.netpowerctrl.listen_service.ListenService;
+import oly.netpowerctrl.main.App;
 import oly.netpowerctrl.network.HttpThreadPool;
 import oly.netpowerctrl.timer.Timer;
 
@@ -33,11 +34,24 @@ public void httpResponse(DeviceConnection ci, boolean callback_success, String r
             final Device device = ci.getDevice();
             if (!callback_success) {
                 ci.setNotReachable(response_message);
-                AppData.getInstance().onDeviceUpdatedOtherThread(device);
+                // Call onConfiguredDeviceUpdated to update device info.
+                App.getMainThreadHandler().post(new Runnable() {
+                    @Override
+                    public void run() {
+                        AppData.getInstance().deviceCollection.updateNotReachable(App.instance, device);
+                    }
+                });
             } else {
                 String[] data = response_message.split(";");
                 if (data.length < 10 || !data[0].startsWith("NET-")) {
                     ci.setNotReachable(ListenService.getService().getString(R.string.error_packet_received));
+                    // Call onConfiguredDeviceUpdated to update device info.
+                    App.getMainThreadHandler().post(new Runnable() {
+                        @Override
+                        public void run() {
+                            AppData.getInstance().deviceCollection.updateNotReachable(App.instance, device);
+                        }
+                    });
                 } else {
                     // The name is the second ";" separated entry of the response_message.
                     device.DeviceName = data[1].trim();
@@ -77,7 +91,7 @@ public void httpResponse(DeviceConnectionHTTP ci, boolean callback_success, Stri
                         ci.setNotReachable(response_message);
                         AppData.getInstance().onDeviceUpdatedOtherThread(device);
                     } else
-                        HttpThreadPool.execute(HttpThreadPool.createHTTPRunner(ci, "strg.cfg", "", ci, false, receiveCtrlHtml));
+                        HttpThreadPool.execute(new HttpThreadPool.HTTPRunner<>(ci, "strg.cfg", "", ci, false, receiveCtrlHtml));
                 }
             };
 

app/src/main/java/oly/netpowerctrl/anel/AnelPlugin.java

@@ -27,7 +27,7 @@
 import oly.netpowerctrl.scenes.SceneCollection;
 import oly.netpowerctrl.scenes.SceneItem;
 import oly.netpowerctrl.timer.TimerController;
-import oly.netpowerctrl.utils.ShowToast;
+import oly.netpowerctrl.utils.notifications.InAppNotifications;
 
 /**
  * Device Updates go into this object and are propagated to all observers and the device collection.
@@ -40,7 +40,7 @@ public class AppData {
     public static final DataQueryCompletedObserver observersDataQueryCompleted = new DataQueryCompletedObserver();
     public static final DataLoadedObserver observersOnDataLoaded = new DataLoadedObserver();
     public static final NewDeviceObserver observersNew = new NewDeviceObserver();
-    private static final String TAG = AppData.class.getName();
+    private static final String TAG = "AppData";
 
     public final List<Device> newDevices = new ArrayList<>();
     final public DeviceCollection deviceCollection = new DeviceCollection();
@@ -127,7 +127,6 @@ public Set<Integer> getAllReceivePorts() {
      * @param deviceObserverBase The DeviceObserver
      */
     public void removeUpdateDeviceState(DeviceObserverBase deviceObserverBase) {
-        Log.w("DeviceQuery", "remove");
         updateDeviceStateList.remove(deviceObserverBase);
     }
 
@@ -148,11 +147,23 @@ public void addUpdateDeviceState(DeviceObserverBase deviceObserverBase) {
      * @param source Source device that has been updated
      */
     private void notifyDeviceQueries(Device source) {
+        List<DeviceObserverBase> deviceObserverBaseList = new ArrayList<>();
+
         Iterator<DeviceObserverBase> it = updateDeviceStateList.iterator();
         while (it.hasNext()) {
             // Return true if the DeviceQuery object has finished its task.
-            if (it.next().notifyObservers(source))
+            DeviceObserverBase deviceObserverBase = it.next();
+            if (deviceObserverBase.notifyObservers(source)) {
                 it.remove();
+                deviceObserverBaseList.add(deviceObserverBase);
+            }
+        }
+
+        // Handle all finished device observers now. We have to split the finishing operation
+        // and updateDeviceStateList iteration because finishWithTimeouts may cause that that this
+        // method is called again and would lead to a concurrent access violation otherwise.
+        for (DeviceObserverBase deviceObserverBase : deviceObserverBaseList) {
+            deviceObserverBase.finishWithTimeouts();
         }
     }
 
@@ -248,13 +259,16 @@ public void onDeviceErrorByName(Context context, String name, String errMessage)
         Iterator<DeviceObserverBase> it = updateDeviceStateList.iterator();
         while (it.hasNext()) {
             // Return true if the DeviceQuery object has finished its task.
-            if (it.next().notifyObservers(name))
+            DeviceObserverBase deviceObserverBase = it.next();
+            if (deviceObserverBase.notifyObservers(name)) {
                 it.remove();
+                deviceObserverBase.finishWithTimeouts();
+            }
         }
 
         // error packet received
         String error = context.getString(R.string.error_packet_received) + ": " + errMessage;
-        ShowToast.FromOtherThread(context, error);
+        InAppNotifications.FromOtherThread(context, error);
     }
 
     public int getReachableConfiguredDevices() {
@@ -354,6 +368,12 @@ public void execute(Scene scene, onExecutionFinished callback) {
     public void execute(final DevicePort port, final int command, final onExecutionFinished callback) {
         PluginInterface remote = port.device.getPluginInterface();
         if (remote != null) {
+            // mark device as changed. Slaves (see below) will also enter this method and will be
+            // marked as changed. This is necessary for this scenario: The slave is already in the target state
+            // but will be marked as currently-executed (progressbar is visible). Because an update of the device
+            // will not be propagated because nothing actually changed, this currently-executed state will
+            // stay indefinitely. Therefore we mark all currently-executed devices as changed here.
+            port.device.setHasChanged();
             remote.execute(port, command, callback);
 
             // Support for slaves of an outlet.
@@ -369,7 +389,7 @@ else if (command == DevicePort.TOGGLE)
 
                 for (UUID slave_uuid : slaves) {
                     DevicePort p = getInstance().findDevicePort(slave_uuid);
-                    if (p != null)
+                    if (p != null && p != port)
                         execute(p, bValue ? DevicePort.ON : DevicePort.OFF, null);
                 }
             }

app/src/main/java/oly/netpowerctrl/anel/AnelPluginHttp.java

@@ -18,7 +18,7 @@
 import oly.netpowerctrl.main.App;
 import oly.netpowerctrl.scenes.Scene;
 import oly.netpowerctrl.timer.Timer;
-import oly.netpowerctrl.utils.ShowToast;
+import oly.netpowerctrl.utils.notifications.InAppNotifications;
 
 
 /**
@@ -88,7 +88,7 @@ protected Boolean doInBackground(Void... voids) {
                         LEGACY_READ_FROM_PREFERENCES a = new LEGACY_READ_FROM_PREFERENCES();
                         a.read(appData);
                     } catch (Exception e) {
-                        ShowToast.FromOtherThread(App.instance, R.string.error_import_legacy_data);
+                        InAppNotifications.FromOtherThread(App.instance, R.string.error_import_legacy_data);
                     }
                 }
                 return null;
@@ -205,30 +205,30 @@ public void read(final AppData appData) {
                 if (appData.sceneCollection.getItems().size() > 0)
                     appData.sceneCollection.saveAll();
             } catch (IOException | InstantiationException | IllegalAccessException ignored) {
-                ShowToast.FromOtherThread(context, R.string.error_reading_scenes);
+                InAppNotifications.FromOtherThread(context, R.string.error_reading_scenes);
             }
             try {
                 fromJSON(appData.deviceCollection.getItems(), JSONHelper.getReader(prefs.getString("devices", null)), Device.class);
                 if (appData.deviceCollection.getItems().size() > 0)
                     appData.deviceCollection.saveAll();
 
             } catch (IOException | InstantiationException | IllegalAccessException ignored) {
-                ShowToast.FromOtherThread(context, R.string.error_reading_devices);
+                InAppNotifications.FromOtherThread(context, R.string.error_reading_devices);
             }
             try {
                 fromJSON(appData.groupCollection.getItems(), JSONHelper.getReader(prefs.getString("groups", null)), Group.class);
                 if (appData.groupCollection.getItems().size() > 0)
                     appData.groupCollection.saveAll();
 
             } catch (IOException | InstantiationException | IllegalAccessException ignored) {
-                ShowToast.FromOtherThread(context, R.string.error_reading_groups);
+                InAppNotifications.FromOtherThread(context, R.string.error_reading_groups);
             }
             try {
                 fromJSON(appData.timerController.getItems(), JSONHelper.getReader(prefs.getString("alarms", null)), Timer.class);
                 if (appData.timerController.getItems().size() > 0)
                     appData.timerController.saveAll();
             } catch (IOException | InstantiationException | IllegalAccessException ignored) {
-                ShowToast.FromOtherThread(context, R.string.error_reading_alarms);
+                InAppNotifications.FromOtherThread(context, R.string.error_reading_alarms);
             }
         }
     }

app/src/main/java/oly/netpowerctrl/data/AppData.java

@@ -4,6 +4,7 @@
 import android.content.Context;
 import android.content.SharedPreferences;
 import android.content.pm.PackageInfo;
+import android.content.pm.PackageManager;
 import android.os.Bundle;
 import android.os.Parcel;
 import android.preference.PreferenceManager;
@@ -46,6 +47,27 @@ public static SharedPrefs getInstance() {
         return SingletonHolder.instance;
     }
 
+    public static String getVersionName(Context context) {
+        try {
+            Class cls = App.class;
+            ComponentName comp = new ComponentName(context, cls);
+            PackageInfo pinfo = context.getPackageManager().getPackageInfo(
+                    comp.getPackageName(), 0);
+            return pinfo.versionName;
+        } catch (android.content.pm.PackageManager.NameNotFoundException e) {
+            return "";
+        }
+    }
+
+    public static int getVersionCode(Context context) {
+        try {
+            //noinspection ConstantConditions
+            return context.getPackageManager().getPackageInfo(context.getPackageName(), 0).versionCode;
+        } catch (PackageManager.NameNotFoundException e) {
+            return 0;
+        }
+    }
+
     public int getLastPreferenceVersion() {
 
         SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(context);
@@ -248,38 +270,26 @@ public boolean isPreferenceNameLogEnergySaveMode(String name) {
         return name.equals("use_log_energy_saving_mode");
     }
 
-    String getVersionName(Context context) {
-        try {
-            Class cls = App.class;
-            ComponentName comp = new ComponentName(context, cls);
-            PackageInfo pinfo = context.getPackageManager().getPackageInfo(
-                    comp.getPackageName(), 0);
-            return pinfo.versionName;
-        } catch (android.content.pm.PackageManager.NameNotFoundException e) {
-            return "";
-        }
-    }
-
     /**
-     * @return Return true if first run. All later calls will always return false.
+     * @return Return true if this version is newer than a previous stored version. A
+     * version is stored by calling {@see acceptUpdatedVersion}. False is returned if
+     * this app runs the first time and for all subsequent starts with the same version.
      */
-    @SuppressWarnings("BooleanMethodIsAlwaysInverted")
-    public boolean showChangeLog() {
-
+    public boolean hasBeenUpdated() {
         SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(context);
         String lastStoredVersion = prefs.getString("lastVersion", null);
         String currentVersion = getVersionName(context);
-        // Do not show changelog on first app opening (but on the next opening)
-        if (lastStoredVersion == null && getFirstTab().equals("")) {
-            prefs.edit().putString("lastVersion", "").apply();
+        if (lastStoredVersion == null) {
+            prefs.edit().putString("lastVersion", currentVersion).apply();
             return false;
         }
-        // last version == current version: do not show changelog
-        if (currentVersion.equals(lastStoredVersion))
-            return false;
-        // update last version and show change log
+        return !currentVersion.equals(lastStoredVersion);
+    }
+
+    public void acceptUpdatedVersion() {
+        SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(context);
+        String currentVersion = getVersionName(context);
         prefs.edit().putString("lastVersion", currentVersion).apply();
-        return true;
     }
 
     public boolean isNotification() {

app/src/main/java/oly/netpowerctrl/data/LoadStoreJSonData.java

@@ -63,6 +63,7 @@ public void setAutomaticUpdate(boolean enabled) {
         automaticUpdatesEnabled = enabled;
         if (!enabled) {
             AppData.getInstance().deviceCollection.unregisterObserver(this);
+            AppData.getInstance().groupCollection.unregisterObserver(this);
         } else {
             // If no data has been loaded so far, wait for load action to be completed before
             // registering to deviceCollection changes.

app/src/main/java/oly/netpowerctrl/data/SharedPrefs.java

@@ -586,12 +586,21 @@ public void clear() {
             notifyDataSetChanged();
     }
 
-    public void removeAt(int position, boolean finalAction) {
-        if (position == -1) return;
+    /**
+     * Remove item at position.
+     *
+     * @param position    Index of item to remove
+     * @param finalAction If this is a final action, group spans are recomputed.
+     * @return Return amount of items that have been removed
+     * (0, 1 or 2 if a group has been removed)
+     */
+    public int removeAt(int position, boolean finalAction) {
+        if (position == -1) return 0;
         AnimationController a = mAnimationWeakReference.get();
         if (a != null)
             a.beforeRemoval(position);
 
+        int removedItems = 1;
         mItems.remove(position);
 
         /**
@@ -601,14 +610,19 @@ public void removeAt(int position, boolean finalAction) {
          */
         for (int indexGroup = position - 1; indexGroup >= 0; --indexGroup) {
             DevicePortAdapterItem headerItem = mItems.get(indexGroup);
-            if (headerItem.port == null) { // is header
-                --headerItem.groupItems;
+            if (headerItem.groupType() == DevicePortAdapterItem.groupTypeEnum.GROUP_TYPE) { // is header
+                if (--headerItem.groupItems <= 0) {
+                    mItems.remove(indexGroup);
+                    ++removedItems;
+                }
                 break;
             }
         }
 
         if (finalAction)
             computeGroupSpans();
+
+        return removedItems;
     }
 
     public void remove(DevicePort oi, boolean finalAction) {
@@ -626,16 +640,12 @@ public void markAllRemoved() {
     }
 
     public void removeAllMarked(boolean finalAction) {
-        int[] toBeRemoved = new int[mItems.size()];
-        int lenToBeRemoved = 0;
-        for (int index = 0; index < mItems.size(); ++index) {
+        for (int index = mItems.size() - 1; index >= 0; ) {
             if (mItems.get(index).isMarkedRemoved()) {
-                toBeRemoved[lenToBeRemoved++] = index;
-            }
+                index -= removeAt(index, false);
+            } else
+                --index;
         }
-        // Remove now
-        for (int i = lenToBeRemoved - 1; i >= 0; --i)
-            removeAt(toBeRemoved[i], false);
 
         if (finalAction)
             computeGroupSpans();