GPS Passive recording feature

library/src/main/java/io/ona/kujaku/interfaces/IKujakuMapView.java

@@ -4,6 +4,8 @@
  * Created by Ephraim Kigamba - [email protected] on 26/09/2018
  */
 
+import android.content.Context;
+import android.location.Location;
 import android.support.annotation.DrawableRes;
 import android.support.annotation.NonNull;
 import android.support.annotation.Nullable;
@@ -23,6 +25,8 @@
 import io.ona.kujaku.listeners.BoundsChangeListener;
 import io.ona.kujaku.listeners.LocationClientStartedCallback;
 import io.ona.kujaku.listeners.OnFeatureClickListener;
+import io.ona.kujaku.listeners.TrackingServiceListener;
+import io.ona.kujaku.services.options.TrackingServiceOptions;
 
 public interface IKujakuMapView extends IKujakuMapViewLowLevel {
 
@@ -257,4 +261,59 @@ public interface IKujakuMapView extends IKujakuMapViewLowLevel {
     boolean isKujakuLayerAdded(@NonNull KujakuLayer kujakuLayer);
 
     void removeLayer(@NonNull KujakuLayer kujakuLayer);
+
+
+    /**
+     * Start the instance of TrackingService that record filtered locations regarding the given {@link TrackingServiceOptions}
+     * You need to register a {@link TrackingServiceListener} to receive notifications as
+     * - {@link TrackingServiceListener#onFirstLocationReceived(Location)}
+     * - {@link TrackingServiceListener#onNewLocationReceived(Location)}
+     * - etc.
+     * The Class arguments is used to instantiate an activity when clicking the service notification
+     *
+     * @param context
+     * @param cls
+     * @param trackingServiceListener
+     * @param options
+     */
+    void startTrackingService(@NonNull Context context, @NonNull Class<?> cls, @NonNull TrackingServiceListener trackingServiceListener, TrackingServiceOptions options);
+
+    /**
+     * Stop the instance of TrackingService
+     * It returns a collection of recorded Locations
+     *
+     * @param context
+     * @return
+     */
+    List<Location> stopTrackingService(@NonNull Context context);
+
+    /**
+     * Unbind from the TrackingService instance to be able to stop the service
+     *
+     * @param context
+     */
+    void unBindTrackingService(@NonNull Context context);
+
+    /**
+     * This method can bind to an existing instance of the TrackingService already running
+     * You need to register a {@link TrackingServiceListener} to receive notifications
+     *
+     * @param context
+     * @param listener
+     * @return
+     */
+    boolean resumeTrackingService(Context context, TrackingServiceListener listener);
+
+    /**
+     * This method force the TrackingService to take a location
+     *
+     */
+    void trackingServiceTakeLocation();
+
+    /**
+     * This method returns the collection of recorded locations
+     *
+     * @return
+     */
+    List<Location> getTrackingServiceRecordedLocations();
 }

library/src/main/java/io/ona/kujaku/services/TrackingService.java

@@ -65,6 +65,7 @@ public class TrackingService extends Service {
     private volatile LocationManager locationManager;
 
     private volatile Handler gpsHandler;
+    private Handler uiHandler;
 
     private volatile Location lastRecordedLocation;
     private volatile Location pendingRecordingLocation;
@@ -602,6 +603,9 @@ public void run() {
             // You don't need to specify the Looper explicitly
             gpsHandler = new Handler();
 
+            // Ui Handler
+            uiHandler = new Handler(Looper.getMainLooper());
+
             // Register the Location listener
             registerLocationListener();
 
@@ -666,7 +670,7 @@ protected void startServiceForeground() {
 
         NotificationCompat.Builder mBuilder = new NotificationCompat.Builder(this, channel)
                 .setSmallIcon(android.R.drawable.ic_menu_mylocation)
-                .setContentTitle(getString(R.string.tracking_service_notification_title))
+                .setContentTitle(getString(R.string.app_name))
                 .setOngoing(true)
                 .setWhen(System.currentTimeMillis());
 
@@ -721,7 +725,12 @@ public void registerTrackingServiceListener(TrackingServiceListener listener) {
      */
     private void informFirstLocationReceivedListener(Location location) {
         if (this.trackingServiceListener != null && this.firstLocationReceived == null) {
-            trackingServiceListener.onFirstLocationReceived(location);
+            uiHandler.post(new Runnable() {
+                @Override
+                public void run() {
+                    trackingServiceListener.onFirstLocationReceived(location);
+                }
+            });
             this.firstLocationReceived = location ;
         }
         this.setServiceStatus(TrackingServiceStatus.WAITING_FIRST_RECORD);
@@ -734,7 +743,12 @@ private void informFirstLocationReceivedListener(Location location) {
      */
     private void informNewTrackReceivedListener(Location location) {
         if (this.trackingServiceListener != null && location != null) {
-            this.trackingServiceListener.onNewLocationReceived(location);
+            uiHandler.post(new Runnable() {
+                @Override
+                public void run() {
+                    trackingServiceListener.onNewLocationReceived(location);
+                }
+            });
         }
         this.setServiceStatus(TrackingServiceStatus.RUNNING);
     }
@@ -753,7 +767,12 @@ private void informCloseToDepartureLocationListener(Location location) {
             Location departure = this.getFirstLocationRecorded();
 
             if (departure != null && departure.distanceTo(location) <= trackingServiceOptions.getDistanceFromDeparture()) {
-                this.trackingServiceListener.onCloseToDepartureLocation(location);
+                uiHandler.post(new Runnable() {
+                    @Override
+                    public void run() {
+                        trackingServiceListener.onCloseToDepartureLocation(location);
+                    }
+                });
             }
         }
     }
@@ -845,8 +864,8 @@ public static void startAndBindService(Context context, Class<?> cls, ServiceCon
      * @param intent
      * @param connection
      */
-    public static void bindService(Context context, Intent intent, ServiceConnection connection) {
-        context.bindService(intent, connection, BIND_AUTO_CREATE);
+    public static boolean bindService(Context context, Intent intent, ServiceConnection connection) {
+        return context.bindService(intent, connection, BIND_AUTO_CREATE);
     }
 
     /**

library/src/main/java/io/ona/kujaku/views/KujakuMapView.java

@@ -756,8 +756,6 @@ private void addMapScrollListenerAndBoundsChangeEmitterToMap(@NonNull MapboxMap
         mapboxMap.addOnMoveListener(new MapboxMap.OnMoveListener() {
             @Override
             public void onMoveBegin(@NonNull MoveGestureDetector detector) {
-                // isMapScrolled = true;
-                // updateCameraUserLocationOnMap = false;
                 // We should assume the user no longer wants us to focus on their location
                 focusOnUserLocation(false);
             }
@@ -857,6 +855,9 @@ public void onStop() {
             locationClient.setListener(null);
             locationClient = null;
         }
+
+        // Unbind TrackingService if bound
+        this.unBindTrackingService(getContext());
     }
 
     @Override
@@ -1339,11 +1340,13 @@ public MapboxLocationComponentWrapper getMapboxLocationComponentWrapper() {
      * @param context
      * @param listener
      */
-    public void resumeTrackingService(Context context, TrackingServiceListener listener) {
+    public boolean resumeTrackingService(Context context, TrackingServiceListener listener) {
         // TrackingService reconnection if connection was lost
         if (! trackingServiceBound && TrackingService.isRunning()) {
             this.trackingServiceListener = listener;
-            TrackingService.bindService(context, TrackingService.getIntent(context, null,null), connection);
+            return TrackingService.bindService(context, TrackingService.getIntent(context, null,null), connection);
+        } else {
+            return false;
         }
     }
 
@@ -1373,8 +1376,12 @@ public List<Location> stopTrackingService(@NonNull Context context) {
         if (trackingServiceBound && trackingService != null) {
             List<Location> locations = trackingService.getRecordedLocations();
             TrackingService.stopAndUnbindService(context, connection);
+            trackingServiceBound = false;
+            trackingService = null ;
             trackingServiceStatusButton.setImageResource(R.drawable.ic_recording_gray);
             return locations;
+        }  else {
+            Log.d(TAG, "Tracking Service instance is null or not Tracking Service is not bounded");
         }
 
         return null;
@@ -1434,15 +1441,26 @@ public void onServiceConnected(ComponentName className,
             trackingServiceStatusButton.setVisibility(VISIBLE);
             trackingServiceStatusButton.setImageResource(R.drawable.ic_recording_red);
 
-            trackingServiceListener.onServiceConnected(trackingService);
+            ((Activity)getContext()).runOnUiThread(new Runnable() {
+                @Override
+                public void run() {
+                    trackingServiceListener.onServiceConnected(trackingService);
+                }
+            });
         }
 
         @Override
         public void onServiceDisconnected(ComponentName arg0) {
             trackingServiceBound = false;
             trackingService = null;
             trackingServiceStatusButton.setImageResource(R.drawable.ic_recording_gray);
-            trackingServiceListener.onServiceDisconnected();
+
+            ((Activity)getContext()).runOnUiThread(new Runnable() {
+                @Override
+                public void run() {
+                    trackingServiceListener.onServiceDisconnected();
+                }
+            });
         }
     };
 

library/src/main/res/values/strings.xml

@@ -39,7 +39,6 @@
     <string name="map_download_could_not_be_stopped">Map download could not be stopped</string>
     <string name="location_service_disabled">Location service disabled</string>
     <string name="location_service_disabled_dialog_explanation"><![CDATA[You will not be able to use the My Location feature in this app. To change this, go to Settings > Location]]></string>
-    <string name="tracking_service_notification_title">Kujaku Tracking service</string>
     <string name="tracking_service_channel_name">Kujaku Tracking service channel</string>
     <string name="tracking_service_channel_id">@string/tracking_service_channel_name</string>
 </resources>

sample/src/main/AndroidManifest.xml

@@ -82,8 +82,7 @@
             android:theme="@style/AppTheme.NoActionBar"/>
         <activity
             android:name=".activities.PassiveRecordObjectActivity"
-            android:theme="@style/AppTheme.NoActionBar"
-            android:launchMode="singleInstance"/>
+            android:theme="@style/AppTheme.NoActionBar"/>
         <activity
             android:name=".activities.FociBoundaryActivity"
             android:theme="@style/AppTheme.NoActionBar"/>

sample/src/main/java/io/ona/kujaku/sample/activities/PassiveRecordObjectActivity.java

@@ -131,32 +131,20 @@ public void onServiceConnected(TrackingService service) {
 
     @Override
     public void onFirstLocationReceived(Location location) {
-        this.runOnUiThread(new Runnable() {
-            public void run() {
-                Toast.makeText(getApplicationContext(), "First Location received", Toast.LENGTH_LONG).show();
-            }
-        });
+        Toast.makeText(getApplicationContext(), "First Location received", Toast.LENGTH_LONG).show();
     }
 
     @Override
     public void onNewLocationReceived(Location location) {
-        this.runOnUiThread(new Runnable() {
-            public void run() {
-                Toast.makeText(getApplicationContext(), "New Location received", Toast.LENGTH_SHORT).show();
-                List<Point> points = new ArrayList<>();
-                points.add(new Point(location.hashCode(), location.getLatitude(), location.getLongitude()));
-                kujakuMapView.updateDroppedPoints(points);
-            }
-        });
+        Toast.makeText(getApplicationContext(), "New Location received", Toast.LENGTH_SHORT).show();
+        List<Point> points = new ArrayList<>();
+        points.add(new Point(location.hashCode(), location.getLatitude(), location.getLongitude()));
+        kujakuMapView.updateDroppedPoints(points);
     }
 
     @Override
     public void onCloseToDepartureLocation(Location location) {
-        this.runOnUiThread(new Runnable() {
-            public void run() {
-                Toast.makeText(getApplicationContext(), "Location recorded is closed to the departure location", Toast.LENGTH_LONG).show();
-            }
-        });
+        Toast.makeText(getApplicationContext(), "Location recorded is closed to the departure location", Toast.LENGTH_LONG).show();
     }
 
     /**** TrackingServiceListener END ****/
@@ -199,9 +187,6 @@ protected void onPause() {
     protected void onDestroy() {
         super.onDestroy();
         if (kujakuMapView != null) kujakuMapView.onDestroy();
-
-        // Unbind Service to be sure we can stop the TrackingService
-        if (kujakuMapView != null) kujakuMapView.unBindTrackingService(getApplicationContext());
     }
 
     @Override