Merge pull request #40 from icapps/android-compile-issues

Updated plugin to target sdk 33

Author: vanlooverenkoen

README.md

@@ -74,8 +74,42 @@ import background_location_tracker
 }
 ```
 
+## Flutter implementation
 
-FAQ:
+Make sure you set the `@pragma('vm:entry-point')` to make sure you can find the callback in release.
+
+```
+@pragma('vm:entry-point')
+void backgroundCallback() {
+  BackgroundLocationTrackerManager.handleBackgroundUpdated(
+    (data) async => Repo().update(data),
+  );
+}
+
+Future<void> main() async {
+  WidgetsFlutterBinding.ensureInitialized();
+  await BackgroundLocationTrackerManager.initialize(
+    backgroundCallback,
+    config: const BackgroundLocationTrackerConfig(
+      loggingEnabled: true,
+      androidConfig: AndroidConfig(
+        notificationIcon: 'explore',
+        trackingInterval: Duration(seconds: 4),
+        distanceFilterMeters: null,
+      ),
+      iOSConfig: IOSConfig(
+        activityType: ActivityType.FITNESS,
+        distanceFilterMeters: null,
+        restartAfterKill: true,
+      ),
+    ),
+  );
+
+  runApp(MyApp());
+}
+```
+
+# FAQ:
 
 #### I get a Unhandled Exception: MissingPluginException(No implementation found for method .... on channel ...)
 

android/build.gradle

@@ -2,30 +2,30 @@ group 'com.icapps.background_location_tracker'
 version '1.0-SNAPSHOT'
 
 buildscript {
-    ext.kotlin_version = '1.3.50'
+    ext.kotlin_version = '1.6.0'
     repositories {
         google()
-        jcenter()
+        mavenCentral()
     }
 
     dependencies {
-        classpath 'com.android.tools.build:gradle:3.5.0'
+        classpath 'com.android.tools.build:gradle:7.0.3'
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
     }
 }
 
 rootProject.allprojects {
     repositories {
+        mavenCentral()
         google()
-        jcenter()
     }
 }
 
 apply plugin: 'com.android.library'
 apply plugin: 'kotlin-android'
 
 android {
-    compileSdkVersion 29
+    compileSdkVersion 33
 
     sourceSets {
         main.java.srcDirs += 'src/main/kotlin'
@@ -40,6 +40,6 @@ android {
 
 dependencies {
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
-    implementation 'com.google.android.gms:play-services-location:17.1.0'
-    implementation 'androidx.localbroadcastmanager:localbroadcastmanager:1.0.0'
+    implementation 'com.google.android.gms:play-services-location:20.0.0'
+    implementation 'androidx.localbroadcastmanager:localbroadcastmanager:1.1.0'
 }

android/gradle/wrapper/gradle-wrapper.properties

@@ -2,4 +2,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-5.6.2-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.0.2-all.zip

android/src/main/AndroidManifest.xml

@@ -1,6 +1,7 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
     package="com.icapps.background_location_tracker">
 
+    <uses-permission android:name="android.permission.ACCESS_BACKGROUND_LOCATION" />
     <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
     <uses-permission android:name="android.permission.WAKE_LOCK" />
     <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />

android/src/main/kotlin/com/icapps/background_location_tracker/BackgroundLocationTrackerPlugin.kt

@@ -154,7 +154,8 @@ class BackgroundLocationTrackerPlugin : FlutterPlugin, MethodCallHandler, Activi
             lifecycle.handleLifecycleEvent(Lifecycle.Event.ON_STOP)
         }
 
-        override fun onActivitySaveInstanceState(activity: Activity?, outState: Bundle?) {}
+        override fun onActivitySaveInstanceState(activity: Activity, outState: Bundle) {}
+
         override fun onActivityDestroyed(activity: Activity) {
             if (activity.hashCode() != registrarActivityHashCode) {
                 return

android/src/main/kotlin/com/icapps/background_location_tracker/MethodCallHelper.kt

@@ -49,15 +49,15 @@ internal class MethodCallHelper(private val ctx: Context) : MethodChannel.Method
                 trackingIntervalKey
         )
         if (!call.checkRequiredFields(keys, result)) return
-        val callbackHandle = call.argument<Long>(callbackHandleKey)!!
+        val callbackHandle = getLongArgumentByKey(call, callbackHandleKey)!!
         val loggingEnabled = call.argument<Boolean>(loggingEnabledKey)!!
         val channelName = call.argument<String>(channelNameKey)!!
         val notificationBody = call.argument<String>(notificationBodyKey)!!
         val notificationIcon = call.argument<String>(notificationIconKey)
         val enableNotificationLocationUpdates = call.argument<Boolean>(enableNotificationLocationUpdatesKey)!!
         val cancelTrackingActionText = call.argument<String>(cancelTrackingActionTextKey)!!
         val enableCancelTrackingAction = call.argument<Boolean>(enableCancelTrackingActionKey)!!
-        val trackingInterval = call.argument<Long>(trackingIntervalKey)!!
+        val trackingInterval = getLongArgumentByKey(call, trackingIntervalKey)!!
         val distanceFilter = (call.argument<Double>(distanceFilterKey) ?: 0.0).toFloat()
         SharedPrefsUtil.saveLoggingEnabled(ctx, loggingEnabled)
         SharedPrefsUtil.saveTrackingInterval(ctx, trackingInterval)
@@ -69,6 +69,14 @@ internal class MethodCallHelper(private val ctx: Context) : MethodChannel.Method
         result.success(true)
     }
 
+    private fun getLongArgumentByKey(call: MethodCall, key: String): Long? {
+        return try {
+            call.argument<Number>(key)!!.toLong()
+        } catch (exception: ClassCastException) {
+            call.argument(key)
+        }
+    }
+
     private fun isTracking(ctx: Context, call: MethodCall, result: MethodChannel.Result) = result.success(SharedPrefsUtil.isTracking(ctx))
 
     private fun startTracking(ctx: Context, call: MethodCall, result: MethodChannel.Result) {

android/src/main/kotlin/com/icapps/background_location_tracker/flutter/FlutterBackgroundManager.kt

@@ -2,25 +2,28 @@ package com.icapps.background_location_tracker.flutter
 
 import android.content.Context
 import android.location.Location
+import android.os.Handler
+import android.os.Looper
 import com.icapps.background_location_tracker.BackgroundLocationTrackerPlugin
 import com.icapps.background_location_tracker.utils.Logger
 import com.icapps.background_location_tracker.utils.SharedPrefsUtil
 import io.flutter.embedding.engine.FlutterEngine
 import io.flutter.embedding.engine.dart.DartExecutor
+import io.flutter.embedding.engine.loader.FlutterLoader
 import io.flutter.embedding.engine.plugins.shim.ShimPluginRegistry
 import io.flutter.plugin.common.MethodCall
 import io.flutter.plugin.common.MethodChannel
 import io.flutter.view.FlutterCallbackInformation
-import io.flutter.view.FlutterMain
 
 internal object FlutterBackgroundManager {
     private const val BACKGROUND_CHANNEL_NAME = "com.icapps.background_location_tracker/background_channel"
 
+    private val flutterLoader = FlutterLoader()
+
     private fun getInitializedFlutterEngine(ctx: Context): FlutterEngine {
         Logger.debug("BackgroundManager", "Creating new engine")
 
         val engine = FlutterEngine(ctx)
-        FlutterMain.ensureInitializationComplete(ctx, null)
         //Backwards compatibility with v1. We register all the user's plugins.
         BackgroundLocationTrackerPlugin.pluginRegistryCallback?.registerWith(ShimPluginRegistry(engine))
         return engine
@@ -41,10 +44,15 @@ internal object FlutterBackgroundManager {
             }
         }
 
-        val callbackHandle = SharedPrefsUtil.getCallbackHandle(ctx)
-        val callbackInfo = FlutterCallbackInformation.lookupCallbackInformation(callbackHandle)
-        val dartBundlePath = FlutterMain.findAppBundlePath()
-        engine.dartExecutor.executeDartCallback(DartExecutor.DartCallback(ctx.assets, dartBundlePath, callbackInfo))
+        if (!flutterLoader.initialized()) {
+            flutterLoader.startInitialization(ctx)
+        }
+        flutterLoader.ensureInitializationCompleteAsync(ctx, null, Handler(Looper.getMainLooper())) {
+            val callbackHandle = SharedPrefsUtil.getCallbackHandle(ctx)
+            val callbackInfo = FlutterCallbackInformation.lookupCallbackInformation(callbackHandle)
+            val dartBundlePath = flutterLoader.findAppBundlePath()
+            engine.dartExecutor.executeDartCallback(DartExecutor.DartCallback(ctx.assets, dartBundlePath, callbackInfo))
+        }
     }
 
     private fun handleInitialized(call: MethodCall, result: MethodChannel.Result, ctx: Context, channel: MethodChannel, location: Location, engine: FlutterEngine) {
@@ -58,7 +66,7 @@ internal object FlutterBackgroundManager {
                 engine.destroy()
             }
 
-            override fun error(errorCode: String?, errorMessage: String?, errorDetails: Any?) {
+            override fun error(errorCode: String, errorMessage: String?, errorDetails: Any?) {
                 Logger.debug("BackgroundManager", "Got error, destroy engine! $errorCode - $errorMessage : $errorDetails")
                 engine.destroy()
             }

android/src/main/kotlin/com/icapps/background_location_tracker/service/LocationUpdatesService.kt

@@ -17,6 +17,7 @@ import com.google.android.gms.location.LocationCallback
 import com.google.android.gms.location.LocationRequest
 import com.google.android.gms.location.LocationResult
 import com.google.android.gms.location.LocationServices
+import com.google.android.gms.location.Priority
 import com.icapps.background_location_tracker.flutter.FlutterBackgroundManager
 import com.icapps.background_location_tracker.utils.ActivityCounter
 import com.icapps.background_location_tracker.utils.Logger
@@ -100,17 +101,26 @@ internal class LocationUpdatesService : Service() {
         // and binds with this service. The service should cease to be a foreground service
         // when that happens.
         Logger.debug(TAG, "OnBind")
-        stopForeground(true)
+        stopForegroundService()
         changingConfiguration = false
         return binder
     }
 
+    private fun stopForegroundService() {
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N) {
+            stopForeground(STOP_FOREGROUND_REMOVE)
+        } else {
+            @Suppress("DEPRECATION")
+            stopForeground(true)
+        }
+    }
+
     override fun onRebind(intent: Intent) {
         // Called when a client (MainActivity in case of this sample) returns to the foreground
         // and binds once again with this service. The service should cease to be a foreground
         // service when that happens.
         Logger.debug(TAG, "OnRebind")
-        stopForeground(true)
+        stopForegroundService()
         changingConfiguration = false
         super.onRebind(intent)
     }
@@ -153,6 +163,8 @@ internal class LocationUpdatesService : Service() {
         } else {
             startService(Intent(applicationContext, LocationUpdatesService::class.java))
         }
+        val locationRequest = locationRequest ?: return
+        val locationCallback = locationCallback ?: return
         try {
             fusedLocationClient?.requestLocationUpdates(locationRequest, locationCallback, Looper.myLooper())
         } catch (unlikely: SecurityException) {
@@ -173,6 +185,7 @@ internal class LocationUpdatesService : Service() {
             wakeLock?.release();
         }
         Logger.debug(TAG, "Removing location updates")
+        val locationCallback = locationCallback ?: return
         try {
             fusedLocationClient?.removeLocationUpdates(locationCallback)
             SharedPrefsUtil.saveIsTracking(this, false)
@@ -197,7 +210,8 @@ internal class LocationUpdatesService : Service() {
         }
     }
 
-    private fun onNewLocation(location: Location) {
+    private fun onNewLocation(location: Location?) {
+        if (location == null) return;
         Logger.debug(TAG, "New location: $location")
         this.location = location
 
@@ -220,13 +234,11 @@ internal class LocationUpdatesService : Service() {
     private fun createLocationRequest() {
         val interval = SharedPrefsUtil.trackingInterval(this)
         val distanceFilter = SharedPrefsUtil.distanceFilter(this)
-        locationRequest = LocationRequest()
-        locationRequest?.let {
-            it.interval = interval
-            it.fastestInterval = interval / 2
-            it.priority = LocationRequest.PRIORITY_HIGH_ACCURACY
-            it.setSmallestDisplacement(distanceFilter)
-        }
+        locationRequest = LocationRequest.create()
+            .setInterval(interval)
+            .setFastestInterval(interval / 2)
+            .setPriority(Priority.PRIORITY_HIGH_ACCURACY)
+            .setSmallestDisplacement(distanceFilter)
     }
 
     /**

android/src/main/kotlin/com/icapps/background_location_tracker/utils/ActivityCounter.kt

@@ -32,6 +32,6 @@ object ActivityCounter : Application.ActivityLifecycleCallbacks {
     }
 
     override fun onActivityStopped(activity: Activity) {}
-    override fun onActivitySaveInstanceState(activity: Activity?, outState: Bundle?) {}
+    override fun onActivitySaveInstanceState(activity: Activity, outState: Bundle) {}
     override fun onActivityDestroyed(activity: Activity) {}
 }

android/src/main/kotlin/com/icapps/background_location_tracker/utils/NotificationUtil.kt

@@ -1,11 +1,13 @@
 package com.icapps.background_location_tracker.utils
 
+import android.annotation.SuppressLint
 import android.app.Notification
 import android.app.NotificationChannel
 import android.app.NotificationManager
 import android.app.PendingIntent
 import android.content.Context
 import android.content.Intent
+import android.content.pm.ServiceInfo
 import android.location.Location
 import android.os.Build
 import androidx.core.app.NotificationCompat
@@ -47,9 +49,18 @@ internal object NotificationUtil {
     private fun getNotification(context: Context, location: Location?): Notification {
         val intent = Intent(context, LocationUpdatesService::class.java)
         intent.putExtra(LocationUpdatesService.EXTRA_STARTED_FROM_NOTIFICATION, true)
-        val cancelTrackingIntent = PendingIntent.getService(context, 0, intent, PendingIntent.FLAG_UPDATE_CURRENT)
+        val cancelTrackingIntent = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
+            PendingIntent.getService(context, 0, intent, PendingIntent.FLAG_IMMUTABLE)
+        } else {
+            @Suppress("UnspecifiedImmutableFlag")
+            PendingIntent.getService(context, 0, intent, PendingIntent.FLAG_UPDATE_CURRENT)
+        }
 
-        val clickPendingIntent = PendingIntent.getActivity(context, 0, context.packageManager.getLaunchIntentForPackage(context.packageName), 0)
+        val clickPendingIntent = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
+            PendingIntent.getActivity(context, 0, context.packageManager.getLaunchIntentForPackage(context.packageName), PendingIntent.FLAG_IMMUTABLE)
+        } else {
+            PendingIntent.getActivity(context, 0, context.packageManager.getLaunchIntentForPackage(context.packageName), 0)
+        }
 
         val title = if (SharedPrefsUtil.isNotificationLocationUpdatesEnabled(context)) {
             String.format("Location Update: %s", DateFormat.getDateTimeInstance().format(Date()))
@@ -94,6 +105,10 @@ internal object NotificationUtil {
     }
 
     fun startForeground(service: LocationUpdatesService, location: Location?) {
-        service.startForeground(NOTIFICATION_ID, getNotification(service, location))
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
+            service.startForeground(NOTIFICATION_ID, getNotification(service, location), ServiceInfo.FOREGROUND_SERVICE_TYPE_LOCATION)
+        } else {
+            service.startForeground(NOTIFICATION_ID, getNotification(service, location))
+        }
     }
 }