Skip to content

Commit

Permalink
Added support for reregistering geofences after reboot on Android
Browse files Browse the repository at this point in the history
  • Loading branch information
@bkonyi
bkonyi committed Feb 21, 2019
1 parent e84d78b commit 1a83056
Show file tree
Hide file tree
Showing 3 changed files with 197 additions and 72 deletions.
243 changes: 171 additions & 72 deletions android/src/main/kotlin/io/flutter/plugins/geofencing/GeofencingPlugin.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,16 @@ import android.content.pm.PackageManager
import android.os.Build
import android.util.Log
import com.google.android.gms.location.Geofence
import com.google.android.gms.location.GeofencingClient
import com.google.android.gms.location.GeofencingRequest
import com.google.android.gms.location.LocationServices
import io.flutter.plugin.common.MethodChannel
import io.flutter.plugin.common.MethodChannel.MethodCallHandler
import io.flutter.plugin.common.MethodChannel.Result
import io.flutter.plugin.common.MethodCall
import io.flutter.plugin.common.PluginRegistry.Registrar
import org.json.JSONArray
import org.json.JSONObject

class GeofencingPlugin(context: Context, activity: Activity?) : MethodCallHandler {
private val mContext = context
Expand All @@ -36,102 +39,198 @@ class GeofencingPlugin(context: Context, activity: Activity?) : MethodCallHandle
@JvmStatic
val CALLBACK_DISPATCHER_HANDLE_KEY = "callback_dispatch_handler"
@JvmStatic
val PERSISTENT_GEOFENCES_KEY = "persistent_geofences"
@JvmStatic
val PERSISTENT_GEOFENCES_IDS = "persistent_geofences_ids"
@JvmStatic
private val REQUIRED_PERMISSIONS = arrayOf(Manifest.permission.ACCESS_FINE_LOCATION)
@JvmStatic
private val sGeofenceCacheLock = Object()

@JvmStatic
fun registerWith(registrar: Registrar) {
val plugin = GeofencingPlugin(registrar.context(), registrar.activity())
val channel = MethodChannel(registrar.messenger(), "plugins.flutter.io/geofencing_plugin")
channel.setMethodCallHandler(plugin)
}
}

override fun onMethodCall(call: MethodCall, result: Result) {
val args = call.arguments() as? ArrayList<*>
when(call.method) {
"GeofencingPlugin.initializeService" -> {
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
mActivity?.requestPermissions(REQUIRED_PERMISSIONS, 12312)
@JvmStatic
fun reRegisterAfterReboot(context: Context) {
synchronized(sGeofenceCacheLock) {
var p = context.getSharedPreferences(SHARED_PREFERENCES_KEY, Context.MODE_PRIVATE)
var persistentGeofences = p.getStringSet(PERSISTENT_GEOFENCES_IDS, null)
if (persistentGeofences == null) {
return
}
for (id in persistentGeofences) {
val gfJson = p.getString(getPersistentGeofenceKey(id), null)
if (gfJson == null) {
continue
}
val gfArgs = JSONArray(gfJson)
val list = ArrayList<Object>()
for (i in 0 until gfArgs.length()) {
list.add(gfArgs.get(i) as Object)
}
val geoClient = LocationServices.getGeofencingClient(context)
registerGeofence(context, geoClient, list, null, false)
}
initializeService(args)
result.success(true)
}
"GeofencingPlugin.registerGeofence" -> registerGeofence(args, result)
"GeofencingPlugin.removeGeofence" -> removeGeofence(args, result)
else -> result.notImplemented()
}
}

private fun initializeService(args: ArrayList<*>?) {
Log.d(TAG, "Initializing GeofencingService")
val callbackHandle = args!![0] as Long
mContext.getSharedPreferences(SHARED_PREFERENCES_KEY, Context.MODE_PRIVATE)
.edit()
.putLong(CALLBACK_DISPATCHER_HANDLE_KEY, callbackHandle)
.apply()
}
@JvmStatic
private fun registerGeofence(context: Context,
geofencingClient: GeofencingClient,
args: ArrayList<*>?,
result: Result?,
cache: Boolean) {
val callbackHandle = args!![0] as Long
val id = args[1] as String
val lat = args[2] as Double
val long = args[3] as Double
val radius = (args[4] as Number).toFloat()
val fenceTriggers = args[5] as Int
val initialTriggers = args[6] as Int
val expirationDuration = (args[7] as Int).toLong()
val loiteringDelay = args[8] as Int
val notificationResponsiveness = args[9] as Int
val geofence = Geofence.Builder()
.setRequestId(id)
.setCircularRegion(lat, long, radius)
.setTransitionTypes(fenceTriggers)
.setLoiteringDelay(loiteringDelay)
.setNotificationResponsiveness(notificationResponsiveness)
.setExpirationDuration(expirationDuration)
.build()
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M &&
(context.checkSelfPermission(Manifest.permission.ACCESS_FINE_LOCATION)
== PackageManager.PERMISSION_DENIED)) {
val msg = "'registerGeofence' requires the ACCESS_FINE_LOCATION permission."
Log.w(TAG, msg)
result?.error(msg, null, null)
}
geofencingClient.addGeofences(getGeofencingRequest(geofence, initialTriggers),
getGeofencePendingIndent(context, callbackHandle))?.run {
addOnSuccessListener {
Log.i(TAG, "Successfully added geofence")
if (cache) {
addGeofenceToCache(context, id, args)
}
result?.success(true)
}
addOnFailureListener {
Log.e(TAG, "Failed to add geofence: $it")
result?.error(it.toString(), null, null)
}
}
}

private fun getGeofencingRequest(geofence: Geofence, initialTrigger: Int): GeofencingRequest {
return GeofencingRequest.Builder().apply {
setInitialTrigger(initialTrigger)
addGeofence(geofence)
}.build()
}
@JvmStatic
private fun addGeofenceToCache(context: Context, id: String, args: ArrayList<*>) {
synchronized(sGeofenceCacheLock) {
var p = context.getSharedPreferences(SHARED_PREFERENCES_KEY, Context.MODE_PRIVATE)
var obj = JSONArray(args)
var persistentGeofences = p.getStringSet(PERSISTENT_GEOFENCES_IDS, null)
if (persistentGeofences == null) {
persistentGeofences = HashSet<String>()
}

persistentGeofences.add(id)
context.getSharedPreferences(SHARED_PREFERENCES_KEY, Context.MODE_PRIVATE)
.edit()
.putStringSet(PERSISTENT_GEOFENCES_IDS, persistentGeofences)
.putString(getPersistentGeofenceKey(id), obj.toString())
.apply()
}
}

private fun getGeofencePendingIndent(callbackHandle: Long): PendingIntent {
val intent = Intent(mContext, GeofencingBroadcastReceiver::class.java)
.putExtra(CALLBACK_HANDLE_KEY, callbackHandle)
return PendingIntent.getBroadcast(mContext, 0, intent, PendingIntent.FLAG_UPDATE_CURRENT)
}

private fun registerGeofence(args: ArrayList<*>?, result: Result) {
val callbackHandle = args!![0] as Long
val id = args[1] as String
val lat = args[2] as Double
val long = args[3] as Double
val radius = (args[4] as Double).toFloat()
val fenceTriggers = args[5] as Int
val initialTriggers = args[6] as Int
val expirationDuration = (args[7] as Int).toLong()
val loiteringDelay = args[8] as Int
val notificationResponsiveness = args[9] as Int
val geofence = Geofence.Builder()
.setRequestId(id)
.setCircularRegion(lat, long, radius)
.setTransitionTypes(initialTriggers)
.setLoiteringDelay(loiteringDelay)
.setNotificationResponsiveness(notificationResponsiveness)
.setExpirationDuration(expirationDuration)
.build()
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M &&
(mContext.checkSelfPermission(Manifest.permission.ACCESS_FINE_LOCATION)
== PackageManager.PERMISSION_DENIED)) {
val msg = "'registerGeofence' requires the ACCESS_FINE_LOCATION permission."
Log.w(TAG, msg)
result.error(msg, null, null)
@JvmStatic
private fun initializeService(context: Context, args: ArrayList<*>?) {
Log.d(TAG, "Initializing GeofencingService")
val callbackHandle = args!![0] as Long
context.getSharedPreferences(SHARED_PREFERENCES_KEY, Context.MODE_PRIVATE)
.edit()
.putLong(CALLBACK_DISPATCHER_HANDLE_KEY, callbackHandle)
.apply()
}
mGeofencingClient.addGeofences(getGeofencingRequest(geofence, fenceTriggers),
getGeofencePendingIndent(callbackHandle))?.run {
addOnSuccessListener {
Log.i(TAG, "Successfully added geofence")
result.success(true)

@JvmStatic
private fun getGeofencingRequest(geofence: Geofence, initialTrigger: Int): GeofencingRequest {
return GeofencingRequest.Builder().apply {
setInitialTrigger(initialTrigger)
addGeofence(geofence)
}.build()
}

@JvmStatic
private fun getGeofencePendingIndent(context: Context, callbackHandle: Long): PendingIntent {
val intent = Intent(context, GeofencingBroadcastReceiver::class.java)
.putExtra(CALLBACK_HANDLE_KEY, callbackHandle)
return PendingIntent.getBroadcast(context, 0, intent, PendingIntent.FLAG_UPDATE_CURRENT)
}

@JvmStatic
private fun removeGeofence(context: Context,
geofencingClient: GeofencingClient,
args: ArrayList<*>?,
result: Result) {
val ids = listOf(args!![0] as String)
geofencingClient.removeGeofences(ids).run {
addOnSuccessListener {
result.success(true)
for (id in ids) {
removeGeofenceFromCache(context, id)
}
}
addOnFailureListener {
result.error(it.toString(), null, null)
}
}
addOnFailureListener {
Log.e(TAG, "Failed to add geofence: $it")
result.error(it.toString(), null, null)
}

@JvmStatic
private fun removeGeofenceFromCache(context: Context, id: String) {
synchronized(sGeofenceCacheLock) {
var p = context.getSharedPreferences(SHARED_PREFERENCES_KEY, Context.MODE_PRIVATE)
var persistentGeofences = p.getStringSet(PERSISTENT_GEOFENCES_IDS, null)
if (persistentGeofences == null) {
return
}
persistentGeofences.remove(id)
p.edit()
.remove(getPersistentGeofenceKey(id))
.putStringSet(PERSISTENT_GEOFENCES_IDS, persistentGeofences)
.apply()
}
}

@JvmStatic
private fun getPersistentGeofenceKey(id: String): String {
return "persistent_geofence/" + id
}
}

private fun removeGeofence(args: ArrayList<*>?, result: Result) {
val ids = listOf(args!![0] as String)
mGeofencingClient.removeGeofences(ids).run {
addOnSuccessListener {
override fun onMethodCall(call: MethodCall, result: Result) {
val args = call.arguments() as? ArrayList<*>
when(call.method) {
"GeofencingPlugin.initializeService" -> {
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
mActivity?.requestPermissions(REQUIRED_PERMISSIONS, 12312)
}
initializeService(mContext, args)
result.success(true)
}
addOnFailureListener {
result.error(it.toString(), null, null)
}
"GeofencingPlugin.registerGeofence" -> registerGeofence(mContext,
mGeofencingClient,
args,
result,
true)
"GeofencingPlugin.removeGeofence" -> removeGeofence(mContext,
mGeofencingClient,
args,
result)
else -> result.notImplemented()
}
}
}
19 changes: 19 additions & 0 deletions android/src/main/kotlin/io/flutter/plugins/geofencing/GeofencingRebootBroadcastReceiver.kt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
// Copyright 2019 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

package io.flutter.plugins.geofencing;

import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.Intent;
import android.util.Log;

class GeofencingRebootBroadcastReceiver : BroadcastReceiver() {
override fun onReceive(context: Context, intent: Intent) {
if (intent.getAction().equals("android.intent.action.BOOT_COMPLETED")) {
Log.e("GEOFENCING REBOOT", "Reregistering geofences!")
GeofencingPlugin.reRegisterAfterReboot(context)
}
}
}
7 changes: 7 additions & 0 deletions example/android/app/src/main/AndroidManifest.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
flutter needs it to communicate with the running application
to allow setting breakpoints, to provide hot reload, etc.
-->
<uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED"/>
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>

Expand Down Expand Up @@ -38,6 +39,12 @@
</activity>
<receiver android:name="io.flutter.plugins.geofencing.GeofencingBroadcastReceiver"
android:enabled="true" android:exported="true"/>
<receiver android:name="io.flutter.plugins.geofencing.GeofencingRebootBroadcastReceiver"
android:enabled="true">
<intent-filter>
<action android:name="android.intent.action.BOOT_COMPLETED"></action>
</intent-filter>
</receiver>
<service android:name="io.flutter.plugins.geofencing.GeofencingService"
android:permission="android.permission.BIND_JOB_SERVICE" android:exported="true"/>
</application>
Expand Down

0 comments on commit 1a83056

Please sign in to comment.