|
| 1 | +package com.mapbox.navigation.core.trip |
| 2 | + |
| 3 | +import android.annotation.SuppressLint |
| 4 | +import androidx.annotation.VisibleForTesting |
| 5 | +import com.mapbox.android.core.permissions.PermissionsManager |
| 6 | +import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI |
| 7 | +import com.mapbox.navigation.core.MapboxNavigation |
| 8 | +import com.mapbox.navigation.core.lifecycle.MapboxNavigationApp |
| 9 | +import com.mapbox.navigation.core.lifecycle.MapboxNavigationObserver |
| 10 | +import com.mapbox.navigation.core.replay.route.ReplayRouteSession |
| 11 | +import com.mapbox.navigation.core.trip.MapboxTripStarterExtra.MAPBOX_TRIP_STARTER_FOLLOW_DEVICE |
| 12 | +import com.mapbox.navigation.core.trip.MapboxTripStarterExtra.MAPBOX_TRIP_STARTER_REPLAY_ROUTE |
| 13 | +import com.mapbox.navigation.core.trip.session.TripSessionState |
| 14 | +import kotlinx.coroutines.CoroutineScope |
| 15 | +import kotlinx.coroutines.Dispatchers |
| 16 | +import kotlinx.coroutines.SupervisorJob |
| 17 | +import kotlinx.coroutines.cancel |
| 18 | +import kotlinx.coroutines.flow.MutableStateFlow |
| 19 | +import kotlinx.coroutines.flow.collect |
| 20 | +import kotlinx.coroutines.flow.combine |
| 21 | +import kotlinx.coroutines.flow.update |
| 22 | +import kotlinx.coroutines.launch |
| 23 | +import kotlin.jvm.Throws |
| 24 | + |
| 25 | +/** |
| 26 | + * This makes it simpler to start a MapboxNavigation trip session. It can be used to enable replay |
| 27 | + * or to follow the device location. The [MapboxTripStarter] is not able to observe when location |
| 28 | + * permissions change, so you must notify it of changes. It will check location permissions upon |
| 29 | + * attach. The location permissions are not required for replay. |
| 30 | + * |
| 31 | + * There should be one instance of this class at a time. For example, an app Activity and car |
| 32 | + * Session will need to use the same instance. That will be done automatically if you use |
| 33 | + * [getRegisteredInstance]. |
| 34 | + */ |
| 35 | +@ExperimentalPreviewMapboxNavigationAPI |
| 36 | +class MapboxTripStarter internal constructor() : MapboxNavigationObserver { |
| 37 | + |
| 38 | + private val optionsFlow = MutableStateFlow(MapboxTripStarterOptions.Builder().build()) |
| 39 | + private val stateFlow = MutableStateFlow(MapboxTripStarterState()) |
| 40 | + private var replayRouteTripSession: ReplayRouteSession? = null |
| 41 | + private var mapboxNavigation: MapboxNavigation? = null |
| 42 | + |
| 43 | + @VisibleForTesting |
| 44 | + internal var coroutineScopeProvider: () -> CoroutineScope = { |
| 45 | + CoroutineScope(SupervisorJob() + Dispatchers.Main.immediate) |
| 46 | + } |
| 47 | + private lateinit var coroutineScope: CoroutineScope |
| 48 | + |
| 49 | + /** |
| 50 | + * Signals that the [mapboxNavigation] instance is ready for use. |
| 51 | + * @param mapboxNavigation |
| 52 | + */ |
| 53 | + override fun onAttached(mapboxNavigation: MapboxNavigation) { |
| 54 | + this.mapboxNavigation = mapboxNavigation |
| 55 | + coroutineScope = coroutineScopeProvider() |
| 56 | + |
| 57 | + // Initialize the options to be aware of the location permissions |
| 58 | + val context = mapboxNavigation.navigationOptions.applicationContext |
| 59 | + val granted = PermissionsManager.areLocationPermissionsGranted(context) |
| 60 | + stateFlow.update { it.copy(isLocationPermissionGranted = granted) } |
| 61 | + |
| 62 | + // Observe any changes to the options |
| 63 | + coroutineScope.launch { |
| 64 | + combine(optionsFlow, stateFlow, ::Pair).collect { |
| 65 | + onStarterOptionsChanged(mapboxNavigation, it.first, it.second) |
| 66 | + } |
| 67 | + } |
| 68 | + } |
| 69 | + |
| 70 | + /** |
| 71 | + * Signals that the [mapboxNavigation] instance is being detached. |
| 72 | + * @param mapboxNavigation |
| 73 | + */ |
| 74 | + override fun onDetached(mapboxNavigation: MapboxNavigation) { |
| 75 | + coroutineScope.cancel() |
| 76 | + onTripDisabled(mapboxNavigation) |
| 77 | + this.mapboxNavigation = null |
| 78 | + } |
| 79 | + |
| 80 | + /** |
| 81 | + * Get the options that are currently set. |
| 82 | + */ |
| 83 | + fun getOptions(): MapboxTripStarterOptions = optionsFlow.value |
| 84 | + |
| 85 | + /** |
| 86 | + * Set new options. |
| 87 | + */ |
| 88 | + fun setOptions(options: MapboxTripStarterOptions) = apply { |
| 89 | + this.optionsFlow.value = options |
| 90 | + } |
| 91 | + |
| 92 | + /** |
| 93 | + * Get the location permission state. This may not reflect the actual permissions. Used for |
| 94 | + * verifying the tests and will likely be removed. |
| 95 | + */ |
| 96 | + @VisibleForTesting |
| 97 | + internal fun getLocationPermissionGranted(): Boolean = |
| 98 | + stateFlow.value.isLocationPermissionGranted |
| 99 | + |
| 100 | + /** |
| 101 | + * Set the location permission state. [MAPBOX_TRIP_STARTER_FOLLOW_DEVICE] will not work unless |
| 102 | + * location permissions have been granted. If the location permissions are not granted and |
| 103 | + * this is set to true, an error will be thrown. |
| 104 | + */ |
| 105 | + @Throws(IllegalStateException::class) |
| 106 | + fun setLocationPermissionGranted(granted: Boolean) { |
| 107 | + val nextState = stateFlow.value.copy(isLocationPermissionGranted = granted) |
| 108 | + checkState(nextState) |
| 109 | + stateFlow.value = nextState |
| 110 | + } |
| 111 | + |
| 112 | + /** |
| 113 | + * Throws an error if location permissions are set to true but the location permissions are |
| 114 | + * not actually granted. |
| 115 | + */ |
| 116 | + private fun checkState(state: MapboxTripStarterState) { |
| 117 | + val mapboxNavigation = this.mapboxNavigation |
| 118 | + checkNotNull(mapboxNavigation) { |
| 119 | + "MapboxTripStarter cannot be used while MapboxNavigation is detached." |
| 120 | + } |
| 121 | + val context = mapboxNavigation.navigationOptions.applicationContext |
| 122 | + val granted = state.isLocationPermissionGranted |
| 123 | + if (granted && !PermissionsManager.areLocationPermissionsGranted(context)) { |
| 124 | + error( |
| 125 | + "updateLocationPermissions can only be set to true when location permissions" + |
| 126 | + " are granted." |
| 127 | + ) |
| 128 | + } |
| 129 | + } |
| 130 | + |
| 131 | + private fun onStarterOptionsChanged( |
| 132 | + mapboxNavigation: MapboxNavigation, |
| 133 | + options: MapboxTripStarterOptions, |
| 134 | + state: MapboxTripStarterState, |
| 135 | + ) { |
| 136 | + if (options.tripType == MAPBOX_TRIP_STARTER_REPLAY_ROUTE) { |
| 137 | + onReplayTripEnabled(mapboxNavigation) |
| 138 | + } else if (options.tripType == MAPBOX_TRIP_STARTER_FOLLOW_DEVICE && |
| 139 | + state.isLocationPermissionGranted |
| 140 | + ) { |
| 141 | + onTripSessionEnabled(mapboxNavigation) |
| 142 | + } else { |
| 143 | + onTripDisabled(mapboxNavigation) |
| 144 | + } |
| 145 | + } |
| 146 | + |
| 147 | + private fun onReplayTripEnabled(mapboxNavigation: MapboxNavigation) { |
| 148 | + if (mapboxNavigation.getTripSessionState() != TripSessionState.STARTED || |
| 149 | + !mapboxNavigation.isReplayEnabled() |
| 150 | + ) { |
| 151 | + replayRouteTripSession?.onDetached(mapboxNavigation) |
| 152 | + replayRouteTripSession = ReplayRouteSession().also { |
| 153 | + it.onAttached(mapboxNavigation) |
| 154 | + } |
| 155 | + } |
| 156 | + } |
| 157 | + |
| 158 | + @SuppressLint("MissingPermission") |
| 159 | + private fun onTripSessionEnabled(mapboxNavigation: MapboxNavigation) { |
| 160 | + replayRouteTripSession?.onDetached(mapboxNavigation) |
| 161 | + replayRouteTripSession = null |
| 162 | + mapboxNavigation.startTripSession() |
| 163 | + } |
| 164 | + |
| 165 | + private fun onTripDisabled(mapboxNavigation: MapboxNavigation) { |
| 166 | + replayRouteTripSession?.onDetached(mapboxNavigation) |
| 167 | + replayRouteTripSession = null |
| 168 | + mapboxNavigation.stopTripSession() |
| 169 | + } |
| 170 | + |
| 171 | + companion object { |
| 172 | + |
| 173 | + /** |
| 174 | + * Construct an instance without registering to [MapboxNavigationApp]. |
| 175 | + */ |
| 176 | + @JvmStatic |
| 177 | + fun create() = MapboxTripStarter() |
| 178 | + |
| 179 | + /** |
| 180 | + * Get the registered instance or create one and register it to [MapboxNavigationApp]. |
| 181 | + */ |
| 182 | + @JvmStatic |
| 183 | + fun getRegisteredInstance(): MapboxTripStarter = MapboxNavigationApp |
| 184 | + .getObservers(MapboxTripStarter::class) |
| 185 | + .firstOrNull() ?: MapboxTripStarter().also { MapboxNavigationApp.registerObserver(it) } |
| 186 | + } |
| 187 | +} |
| 188 | + |
| 189 | +/** |
| 190 | + * Apply changes to existing options. |
| 191 | + */ |
| 192 | +@ExperimentalPreviewMapboxNavigationAPI |
| 193 | +fun MapboxTripStarter.update( |
| 194 | + function: (MapboxTripStarterOptions.Builder) -> MapboxTripStarterOptions.Builder |
| 195 | +): MapboxTripStarter = apply { |
| 196 | + setOptions(function.invoke(getOptions().toBuilder()).build()) |
| 197 | +} |
0 commit comments