-
Notifications
You must be signed in to change notification settings - Fork 319
/
MapboxNavigation.kt
1791 lines (1663 loc) · 74.8 KB
/
MapboxNavigation.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* Tampering with any file that contains billing code is a violation of Mapbox Terms of Service and will result in enforcement of the penalties stipulated in the ToS.
*/
package com.mapbox.navigation.core
import android.Manifest.permission.ACCESS_COARSE_LOCATION
import android.Manifest.permission.ACCESS_FINE_LOCATION
import androidx.annotation.RequiresPermission
import androidx.annotation.UiThread
import androidx.annotation.VisibleForTesting
import com.mapbox.android.core.location.LocationEngine
import com.mapbox.android.telemetry.TelemetryEnabler
import com.mapbox.annotation.module.MapboxModuleType
import com.mapbox.api.directions.v5.models.DirectionsResponse
import com.mapbox.api.directions.v5.models.DirectionsRoute
import com.mapbox.api.directions.v5.models.RouteOptions
import com.mapbox.bindgen.Expected
import com.mapbox.bindgen.ExpectedFactory
import com.mapbox.common.TilesetDescriptor
import com.mapbox.common.module.provider.MapboxModuleProvider
import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
import com.mapbox.navigation.base.extensions.applyDefaultNavigationOptions
import com.mapbox.navigation.base.extensions.applyLanguageAndVoiceUnitOptions
import com.mapbox.navigation.base.internal.trip.notification.TripNotificationInterceptorOwner
import com.mapbox.navigation.base.options.HistoryRecorderOptions
import com.mapbox.navigation.base.options.NavigationOptions
import com.mapbox.navigation.base.options.RoutingTilesOptions
import com.mapbox.navigation.base.route.NavigationRoute
import com.mapbox.navigation.base.route.NavigationRouter
import com.mapbox.navigation.base.route.NavigationRouterCallback
import com.mapbox.navigation.base.route.RouteAlternativesOptions
import com.mapbox.navigation.base.route.Router
import com.mapbox.navigation.base.route.RouterCallback
import com.mapbox.navigation.base.route.RouterFailure
import com.mapbox.navigation.base.route.RouterOrigin
import com.mapbox.navigation.base.route.toDirectionsRoutes
import com.mapbox.navigation.base.route.toNavigationRoutes
import com.mapbox.navigation.base.trip.model.RouteProgress
import com.mapbox.navigation.base.trip.model.eh.EHorizonEdge
import com.mapbox.navigation.base.trip.model.eh.EHorizonEdgeMetadata
import com.mapbox.navigation.base.trip.notification.NotificationAction
import com.mapbox.navigation.base.trip.notification.TripNotification
import com.mapbox.navigation.base.trip.notification.TripNotificationInterceptor
import com.mapbox.navigation.core.accounts.BillingController
import com.mapbox.navigation.core.arrival.ArrivalController
import com.mapbox.navigation.core.arrival.ArrivalObserver
import com.mapbox.navigation.core.arrival.ArrivalProgressObserver
import com.mapbox.navigation.core.arrival.AutoArrivalController
import com.mapbox.navigation.core.directions.LegacyRouterAdapter
import com.mapbox.navigation.core.directions.session.DirectionsSession
import com.mapbox.navigation.core.directions.session.RoutesExtra
import com.mapbox.navigation.core.directions.session.RoutesObserver
import com.mapbox.navigation.core.history.MapboxHistoryReader
import com.mapbox.navigation.core.history.MapboxHistoryRecorder
import com.mapbox.navigation.core.internal.ReachabilityService
import com.mapbox.navigation.core.internal.telemetry.CustomEvent
import com.mapbox.navigation.core.internal.telemetry.UserFeedbackCallback
import com.mapbox.navigation.core.internal.utils.InternalUtils
import com.mapbox.navigation.core.internal.utils.ModuleParams
import com.mapbox.navigation.core.internal.utils.isInternalImplementation
import com.mapbox.navigation.core.internal.utils.paramsProvider
import com.mapbox.navigation.core.lifecycle.MapboxNavigationApp
import com.mapbox.navigation.core.navigator.CacheHandleWrapper
import com.mapbox.navigation.core.navigator.TilesetDescriptorFactory
import com.mapbox.navigation.core.replay.MapboxReplayer
import com.mapbox.navigation.core.reroute.LegacyRerouteControllerAdapter
import com.mapbox.navigation.core.reroute.MapboxRerouteController
import com.mapbox.navigation.core.reroute.NavigationRerouteController
import com.mapbox.navigation.core.reroute.RerouteController
import com.mapbox.navigation.core.reroute.RerouteOptionsAdapter
import com.mapbox.navigation.core.reroute.RerouteState
import com.mapbox.navigation.core.routealternatives.AlternativeRouteMetadata
import com.mapbox.navigation.core.routealternatives.NavigationRouteAlternativesObserver
import com.mapbox.navigation.core.routealternatives.NavigationRouteAlternativesRequestCallback
import com.mapbox.navigation.core.routealternatives.RouteAlternativesController
import com.mapbox.navigation.core.routealternatives.RouteAlternativesControllerProvider
import com.mapbox.navigation.core.routealternatives.RouteAlternativesError
import com.mapbox.navigation.core.routealternatives.RouteAlternativesObserver
import com.mapbox.navigation.core.routealternatives.RouteAlternativesRequestCallback
import com.mapbox.navigation.core.routeoptions.RouteOptionsUpdater
import com.mapbox.navigation.core.routerefresh.RouteRefreshController
import com.mapbox.navigation.core.routerefresh.RouteRefreshControllerProvider
import com.mapbox.navigation.core.telemetry.MapboxNavigationTelemetry
import com.mapbox.navigation.core.telemetry.events.FeedbackEvent
import com.mapbox.navigation.core.telemetry.events.FeedbackHelper
import com.mapbox.navigation.core.telemetry.events.FeedbackMetadata
import com.mapbox.navigation.core.telemetry.events.FeedbackMetadataWrapper
import com.mapbox.navigation.core.trip.service.TripService
import com.mapbox.navigation.core.trip.session.BannerInstructionsObserver
import com.mapbox.navigation.core.trip.session.LegIndexUpdatedCallback
import com.mapbox.navigation.core.trip.session.LocationObserver
import com.mapbox.navigation.core.trip.session.NativeSetRouteError
import com.mapbox.navigation.core.trip.session.NativeSetRouteResult
import com.mapbox.navigation.core.trip.session.NativeSetRouteValue
import com.mapbox.navigation.core.trip.session.NavigationSession
import com.mapbox.navigation.core.trip.session.NavigationSessionState
import com.mapbox.navigation.core.trip.session.NavigationSessionState.ActiveGuidance
import com.mapbox.navigation.core.trip.session.NavigationSessionState.FreeDrive
import com.mapbox.navigation.core.trip.session.NavigationSessionState.Idle
import com.mapbox.navigation.core.trip.session.NavigationSessionStateObserver
import com.mapbox.navigation.core.trip.session.OffRouteObserver
import com.mapbox.navigation.core.trip.session.RoadObjectsOnRouteObserver
import com.mapbox.navigation.core.trip.session.RouteProgressObserver
import com.mapbox.navigation.core.trip.session.TripSession
import com.mapbox.navigation.core.trip.session.TripSessionLocationEngine
import com.mapbox.navigation.core.trip.session.TripSessionState
import com.mapbox.navigation.core.trip.session.TripSessionStateObserver
import com.mapbox.navigation.core.trip.session.VoiceInstructionsObserver
import com.mapbox.navigation.core.trip.session.eh.EHorizonObserver
import com.mapbox.navigation.core.trip.session.eh.GraphAccessor
import com.mapbox.navigation.core.trip.session.eh.RoadObjectMatcher
import com.mapbox.navigation.core.trip.session.eh.RoadObjectsStore
import com.mapbox.navigation.metrics.MapboxMetricsReporter
import com.mapbox.navigation.navigator.internal.MapboxNativeNavigator
import com.mapbox.navigation.navigator.internal.NavigatorLoader
import com.mapbox.navigation.navigator.internal.router.RouterInterfaceAdapter
import com.mapbox.navigation.utils.internal.ConnectivityHandler
import com.mapbox.navigation.utils.internal.LoggerProvider
import com.mapbox.navigation.utils.internal.ThreadController
import com.mapbox.navigation.utils.internal.ifNonNull
import com.mapbox.navigation.utils.internal.logD
import com.mapbox.navigation.utils.internal.logE
import com.mapbox.navigation.utils.internal.monitorChannelWithException
import com.mapbox.navigator.AlertsServiceOptions
import com.mapbox.navigator.ElectronicHorizonOptions
import com.mapbox.navigator.FallbackVersionsObserver
import com.mapbox.navigator.IncidentsOptions
import com.mapbox.navigator.NavigatorConfig
import com.mapbox.navigator.PollingConfig
import com.mapbox.navigator.RouterInterface
import com.mapbox.navigator.TileEndpointConfiguration
import com.mapbox.navigator.TilesConfig
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.cancel
import kotlinx.coroutines.channels.Channel
import kotlinx.coroutines.channels.ReceiveChannel
import kotlinx.coroutines.launch
import kotlinx.coroutines.sync.Mutex
import kotlinx.coroutines.sync.withLock
import java.lang.reflect.Field
import java.util.Locale
private const val MAPBOX_NAVIGATION_USER_AGENT_BASE = "mapbox-navigation-android"
private const val MAPBOX_NAVIGATION_TOKEN_EXCEPTION_ROUTER =
"You need to provide an access token in NavigationOptions in order to use the default " +
"Router."
private const val MAPBOX_NAVIGATION_NOTIFICATION_PACKAGE_NAME =
"com.mapbox.navigation.trip.notification.internal.MapboxTripNotification"
private const val MAPBOX_NOTIFICATION_ACTION_CHANNEL = "notificationActionButtonChannel"
/**
* ## Mapbox Navigation Core SDK
* An entry point for interacting with the Mapbox Navigation SDK.
*
* **Only one instance of this class should be used per application process.**
* Use [MapboxNavigationApp] to easily manage the instance across lifecycle.
*
* Feel free to visit our [docs pages and examples](https://docs.mapbox.com/android/beta/navigation/overview/) before diving in!
*
* The [MapboxNavigation] implementation can enter into the following [NavigationSessionState]s:
* - [Idle]
* - [FreeDrive]
* - [ActiveGuidance]
*
* The SDK starts off in an [Idle] state.
*
* ### Location
* Whenever the [startTripSession] is called, the SDK will enter the [FreeDrive] state starting to request and propagate location updates via the [LocationObserver].
*
* This observer provides 2 location update values in mixed intervals - either the raw one received from the provided [LocationEngine]
* or the enhanced one map-matched internally using SDK's native capabilities.
*
* In [FreeDrive] mode, the enhanced location is computed using nearby to user location's routing tiles that are continuously updating in the background.
* This can be configured using the [RoutingTilesOptions] in the [NavigationOptions].
*
* If the session is stopped, the SDK will stop listening for raw location updates and enter the [Idle] state.
*
* ### Routing
* A route can be requested with:
* - [requestRoutes], if successful, returns a route reference without acting on it. You can then pass the generated routes to [setRoutes].
* - [setRoutes] sets new routes, clear current ones, or changes the route at primary index 0.
* The routes are immediately available via the [RoutesObserver] and the first route (at index 0) is going to be chosen as the primary one.
*
* ### Route reason update
* When routes are updated via [setRoutes] the reason that is spread via [RoutesObserver.onRoutesChanged] might be:
* - [RoutesExtra.ROUTES_UPDATE_REASON_CLEAN_UP] if list of routes is empty;
* - [RoutesExtra.ROUTES_UPDATE_REASON_ALTERNATIVE] if any of the routes received via [RouteAlternativesObserver.onRouteAlternatives] are set. **Order does not matter**.
* - [RoutesExtra.ROUTES_UPDATE_REASON_NEW] otherwise.
* If current routes are internally refreshed then the reason is [RoutesExtra.ROUTES_UPDATE_REASON_REFRESH]. In case of re-route (see [RerouteController]) the reason is [RoutesExtra.ROUTES_UPDATE_REASON_REROUTE].
*
* **Make sure to use the [applyDefaultNavigationOptions] for the best navigation experience** (and to set required request parameters).
* You can also use [applyLanguageAndVoiceUnitOptions] get instructions' language and voice unit based on the device's [Locale].
* It's also worth exploring other available options (like enabling alternative routes, specifying destination approach type, defining waypoint types, etc.).
*
* Example:
* ```
* val routeOptions = RouteOptions.builder()
* .applyDefaultNavigationOptions()
* .applyLanguageAndVoiceUnitOptions(context)
* .accessToken(token)
* .coordinatesList(listOf(origin, destination))
* .alternatives(true)
* .build()
* mapboxNavigation.requestRoutes(
* routeOptions,
* object : NavigationRouterCallback {
* override fun onRoutesReady(
* routes: List<NavigationRoute>,
* routerOrigin: RouterOrigin
* ) {
* mapboxNavigation.setNavigationRoutes(routes)
* }
* override fun onFailure(reasons: List<RouterFailure>, routeOptions: RouteOptions) { }
* override fun onCanceled(routeOptions: RouteOptions, routerOrigin: RouterOrigin) { }
* }
* )
* ```
*
* If the SDK is in an [Idle] state, it stays in this same state even when a primary route is available.
*
* If the SDK is already in the [FreeDrive] mode or entering it whenever a primary route is available,
* the SDK will enter the [ActiveGuidance] mode instead and propagate meaningful [RouteProgress].
*
* When the routes are manually cleared, the SDK automatically fall back to either [Idle] or [FreeDrive] state.
*
* You can use [setRoutes] to provide new routes, clear current ones, or change the route at primary index 0.
*
* @param navigationOptions a set of [NavigationOptions] used to customize various features of the SDK.
*/
@UiThread
class MapboxNavigation @VisibleForTesting internal constructor(
val navigationOptions: NavigationOptions,
private val threadController: ThreadController,
) {
constructor(navigationOptions: NavigationOptions) : this(navigationOptions, ThreadController())
private val accessToken: String? = navigationOptions.accessToken
private val mainJobController = threadController.getMainScopeAndRootJob()
private val directionsSession: DirectionsSession
private var navigator: MapboxNativeNavigator
private val tripService: TripService
private val tripSession: TripSession
private val navigationSession: NavigationSession
internal val historyRecordingStateHandler: HistoryRecordingStateHandler
private val tripSessionLocationEngine: TripSessionLocationEngine
private val billingController: BillingController
private val connectivityHandler: ConnectivityHandler = ConnectivityHandler(
Channel(Channel.CONFLATED)
)
private val tripNotificationInterceptorOwner = TripNotificationInterceptorOwner()
private val internalRoutesObserver: RoutesObserver
private val internalOffRouteObserver: OffRouteObserver
private val internalFallbackVersionsObserver: FallbackVersionsObserver
private val routeAlternativesController: RouteAlternativesController
private val routeRefreshController: RouteRefreshController
private var routeScope = createChildScope()
private val arrivalProgressObserver: ArrivalProgressObserver
private val electronicHorizonOptions: ElectronicHorizonOptions = ElectronicHorizonOptions(
navigationOptions.eHorizonOptions.length,
navigationOptions.eHorizonOptions.expansion.toByte(),
navigationOptions.eHorizonOptions.branchLength,
true, // doNotRecalculateInUncertainState is not exposed and can't be changed at the moment
navigationOptions.eHorizonOptions.minTimeDeltaBetweenUpdates,
AlertsServiceOptions(
navigationOptions.eHorizonOptions.alertServiceOptions.collectTunnels,
navigationOptions.eHorizonOptions.alertServiceOptions.collectBridges,
navigationOptions.eHorizonOptions.alertServiceOptions.collectRestrictedAreas
)
)
private val routeUpdateMutex = Mutex()
// native Router Interface
private val nativeRouter: RouterInterface by lazy {
NavigatorLoader.createNativeRouterInterface(
navigationOptions.deviceProfile,
navigatorConfig,
createTilesConfig(
isFallback = false,
tilesVersion = navigationOptions.routingTilesOptions.tilesVersion
),
historyRecorder.historyRecorderHandle,
)
}
// Router provided via @Modules, might be outer
private val moduleRouter: NavigationRouter by lazy {
val result = MapboxModuleProvider.createModule<Router>(MapboxModuleType.NavigationRouter) {
paramsProvider(
ModuleParams.NavigationRouter(
accessToken
?: throw RuntimeException(MAPBOX_NAVIGATION_TOKEN_EXCEPTION_ROUTER),
nativeRouter,
threadController
)
)
}
if (result is NavigationRouter) {
result
} else {
LegacyRouterAdapter(result)
}
}
private val incidentsOptions: IncidentsOptions? = navigationOptions.incidentsOptions.run {
if (graph.isNotEmpty() || apiUrl.isNotEmpty()) {
IncidentsOptions(graph, apiUrl)
} else {
null
}
}
private val pollingConfig = PollingConfig(
navigationOptions.navigatorPredictionMillis / ONE_SECOND_IN_MILLIS,
InternalUtils.UNCONDITIONAL_POLLING_PATIENCE_MILLISECONDS / ONE_SECOND_IN_MILLIS,
InternalUtils.UNCONDITIONAL_POLLING_INTERVAL_MILLISECONDS / ONE_SECOND_IN_MILLIS
)
private val navigatorConfig = NavigatorConfig(
null,
electronicHorizonOptions,
pollingConfig,
incidentsOptions,
null,
null,
navigationOptions.enableSensors,
)
private var notificationChannelField: Field? = null
/**
* Reroute controller, by default uses [defaultRerouteController].
*/
private var rerouteController: NavigationRerouteController?
private val defaultRerouteController: NavigationRerouteController
/**
* [NavigationVersionSwitchObserver] is notified when navigation switches tiles version.
*/
private val navigationVersionSwitchObservers = mutableSetOf<NavigationVersionSwitchObserver>()
/**
* [MapboxNavigation.roadObjectsStore] provides methods to get road objects metadata,
* add and remove custom road objects.
*/
val roadObjectsStore: RoadObjectsStore
/**
* [MapboxNavigation.graphAccessor] provides methods to get edge (e.g. [EHorizonEdge]) shape and
* metadata.
*
* **NOTE**: The Mapbox Electronic Horizon feature of the Mapbox Navigation SDK is in public beta
* and is subject to changes, including its pricing. Use of the feature is subject to the beta
* product restrictions in the Mapbox Terms of Service.
* Mapbox reserves the right to eliminate any free tier or free evaluation offers at any time and
* require customers to place an order to purchase the Mapbox Electronic Horizon feature,
* regardless of the level of use of the feature.
*/
val graphAccessor: GraphAccessor
/**
* [MapboxNavigation.tilesetDescriptorFactory] provide methods to build navigation
* [TilesetDescriptor]
*/
val tilesetDescriptorFactory: TilesetDescriptorFactory
/**
* [MapboxNavigation.roadObjectMatcher] provides methods to match custom road objects
* to the road graph. To make the road object discoverable by the electronic horizon module and
* the [EHorizonObserver] in particular it must be added to the [RoadObjectsStore] with
* [RoadObjectsStore.addCustomRoadObject]
*/
val roadObjectMatcher: RoadObjectMatcher
/**
* Use the history recorder to save history files.
*
* @see [HistoryRecorderOptions] to enable and customize the directory
* @see [MapboxHistoryReader] to read the files
*/
val historyRecorder = MapboxHistoryRecorder(navigationOptions)
/**
* **THIS IS AN EXPERIMENTAL API, DO NOT USE IN A PRODUCTION ENVIRONMENT.**
*
* Navigation native experimental API. Do not store a reference to [Experimental] object,
* always access the object via `mapboxNavigation.experimental` because [MapboxNavigation] is
* responsible for it's lifecycle.
*/
@ExperimentalPreviewMapboxNavigationAPI
val experimental: com.mapbox.navigator.Experimental
get() = navigator.experimental
private var reachabilityObserverId: Long? = null
private var latestLegIndex: Int? = null
/**
* Describes whether this instance of `MapboxNavigation` has been destroyed by calling
* [onDestroy]. Once an instance is destroyed, it cannot be used anymore.
*
* @see [MapboxNavigationApp]
*/
@Volatile
var isDestroyed = false
private set
init {
// Instantiate LoggerProvider explicitly so that NavigationLogBackend is set
LoggerProvider.initialize()
if (hasInstance) {
throw IllegalStateException(
"""
A different MapboxNavigation instance already exists.
Make sure to destroy it with #onDestroy before creating a new one.
Also see MapboxNavigationApp for instance management assistance.
""".trimIndent()
)
}
hasInstance = true
navigator = NavigationComponentProvider.createNativeNavigator(
navigationOptions.deviceProfile,
navigatorConfig,
createTilesConfig(
isFallback = false,
tilesVersion = navigationOptions.routingTilesOptions.tilesVersion
),
historyRecorder.fileDirectory(),
navigationOptions.accessToken ?: "",
if (moduleRouter.isInternalImplementation()) {
nativeRouter
} else {
RouterInterfaceAdapter(moduleRouter, ::getNavigationRoutes)
},
)
historyRecorder.historyRecorderHandle = navigator.getHistoryRecorderHandle()
navigationSession = NavigationComponentProvider.createNavigationSession()
historyRecordingStateHandler = NavigationComponentProvider
.createHistoryRecordingStateHandler(navigationSession.state)
val notification: TripNotification = MapboxModuleProvider
.createModule(
MapboxModuleType.NavigationTripNotification
) {
paramsProvider(
ModuleParams.NavigationTripNotification(
navigationOptions,
tripNotificationInterceptorOwner,
navigationOptions.distanceFormatterOptions
)
)
}
if (notification.javaClass.name == MAPBOX_NAVIGATION_NOTIFICATION_PACKAGE_NAME) {
notificationChannelField =
notification.javaClass.getDeclaredField(MAPBOX_NOTIFICATION_ACTION_CHANNEL).apply {
isAccessible = true
}
}
tripService = NavigationComponentProvider.createTripService(
navigationOptions.applicationContext,
notification,
threadController,
)
tripSessionLocationEngine = NavigationComponentProvider.createTripSessionLocationEngine(
navigationOptions = navigationOptions
)
tripSession = NavigationComponentProvider.createTripSession(
tripService = tripService,
tripSessionLocationEngine = tripSessionLocationEngine,
navigator = navigator,
threadController,
)
tripSession.registerStateObserver(navigationSession)
tripSession.registerStateObserver(historyRecordingStateHandler)
directionsSession = NavigationComponentProvider.createDirectionsSession(moduleRouter)
directionsSession.registerRoutesObserver(navigationSession)
if (reachabilityObserverId == null) {
reachabilityObserverId = ReachabilityService.addReachabilityObserver(
connectivityHandler
)
}
arrivalProgressObserver = NavigationComponentProvider.createArrivalProgressObserver(
tripSession
)
setArrivalController()
billingController = NavigationComponentProvider.createBillingController(
navigationOptions.accessToken,
navigationSession,
tripSession,
arrivalProgressObserver
)
ifNonNull(accessToken) { token ->
runInTelemetryContext { telemetry ->
logD(
"MapboxMetricsReporter.init from MapboxNavigation main",
telemetry.LOG_CATEGORY
)
MapboxMetricsReporter.init(
navigationOptions.applicationContext,
token,
obtainUserAgent()
)
MapboxMetricsReporter.toggleLogging(navigationOptions.isDebugLoggingEnabled)
telemetry.initialize(
this,
navigationOptions,
MapboxMetricsReporter,
)
}
}
val routeOptionsProvider = RouteOptionsUpdater()
routeAlternativesController = RouteAlternativesControllerProvider.create(
navigationOptions.routeAlternativesOptions,
navigator,
tripSession,
threadController,
)
routeRefreshController = RouteRefreshControllerProvider.createRouteRefreshController(
navigationOptions.routeRefreshOptions,
directionsSession,
tripSession
)
defaultRerouteController = MapboxRerouteController(
directionsSession,
tripSession,
routeOptionsProvider,
navigationOptions.rerouteOptions,
threadController,
)
rerouteController = defaultRerouteController
internalRoutesObserver = createInternalRoutesObserver()
internalOffRouteObserver = createInternalOffRouteObserver()
internalFallbackVersionsObserver = createInternalFallbackVersionsObserver()
tripSession.registerOffRouteObserver(internalOffRouteObserver)
tripSession.registerFallbackVersionsObserver(internalFallbackVersionsObserver)
registerRoutesObserver(internalRoutesObserver)
roadObjectsStore = RoadObjectsStore(navigator)
graphAccessor = GraphAccessor(navigator)
tilesetDescriptorFactory = TilesetDescriptorFactory(
navigationOptions.routingTilesOptions,
navigator.cache
)
roadObjectMatcher = RoadObjectMatcher(navigator)
}
/**
* Control the location events playback during a replay trip session.
* Start a replay trip session with [startReplayTripSession].
*/
@ExperimentalPreviewMapboxNavigationAPI
val mapboxReplayer: MapboxReplayer by lazy { tripSessionLocationEngine.mapboxReplayer }
/**
* Starts listening for location updates and enters an `Active Guidance` state if there's a primary route available
* or a `Free Drive` state otherwise.
*
* **Starting a session can have an impact on your usage costs.** Refer to the [pricing documentation](https://docs.mapbox.com/android/beta/navigation/guides/pricing/) to learn more.
*
* @param withForegroundService Boolean if set to false, foreground service will not be started and
* no notifications will be rendered, and no location updates will be available while the app is in the background.
* Default value is set to true.
* @see [registerTripSessionStateObserver]
* @see [registerRouteProgressObserver]
*/
@RequiresPermission(anyOf = [ACCESS_COARSE_LOCATION, ACCESS_FINE_LOCATION])
@JvmOverloads
fun startTripSession(withForegroundService: Boolean = true) {
startSession(withForegroundService, false)
}
/**
* Stops listening for location updates and enters an `Idle` state.
*
* @see [registerTripSessionStateObserver]
*/
fun stopTripSession() {
runIfNotDestroyed {
latestLegIndex = tripSession.getRouteProgress()?.currentLegProgress?.legIndex
tripSession.stop()
}
}
/**
* Functionally the same as [startTripSession] except the locations do not come from the
* [NavigationOptions.locationEngine]. The events are emitted by the [mapboxReplayer].
*
* This allows you to simulate navigation routes or replay history from the [historyRecorder].
*/
@ExperimentalPreviewMapboxNavigationAPI
fun startReplayTripSession(withForegroundService: Boolean = true) {
startSession(withForegroundService, true)
}
/**
* Reset the session with the same configuration. The location becomes unknown,
* but the [NavigationOptions] stay the same. This can be used to transport the
* navigator to a new location.
*/
fun resetTripSession() {
navigator.resetRideSession()
}
/**
* Query if the [MapboxNavigation] is running a foreground service
* @return true if the [MapboxNavigation] is running a foreground service else false
*/
fun isRunningForegroundService(): Boolean {
return tripSession.isRunningWithForegroundService()
}
/**
* Return the current [TripSession]'s state.
* The state is [TripSessionState.STARTED] when the session is active, running a foreground service and
* requesting and returning location updates.
* The state is [TripSessionState.STOPPED] when the session is inactive.
*
* @return current [TripSessionState]
* @see [registerTripSessionStateObserver]
*/
fun getTripSessionState(): TripSessionState = tripSession.getState()
/**
* Provides the current navigation session state.
*
* @return current [NavigationSessionState]
* @see NavigationSessionStateObserver
* @see [registerNavigationSessionStateObserver]
*/
fun getNavigationSessionState(): NavigationSessionState = navigationSession.state
/**
* Provides the current Z-Level. Can be used to build a route from a proper level of a road.
*
* @return current Z-Level.
*/
fun getZLevel(): Int? = tripSession.zLevel
/**
* Requests a route using the available [Router] implementation.
*
* Use [MapboxNavigation.setRoutes] to supply the returned list of routes, transformed list, or a list from an external source, to be managed by the SDK.
*
* Example:
* ```
* mapboxNavigation.requestRoutes(routeOptions, object : RouterCallback {
* override fun onRoutesReady(routes: List<DirectionsRoute>) {
* ...
* mapboxNavigation.setRoutes(routes)
* }
* ...
* })
* ```
*
* @param routeOptions params for the route request.
* **Make sure to use the [applyDefaultNavigationOptions] for the best navigation experience** (and to set required request parameters).
* You can also use [applyLanguageAndVoiceUnitOptions] get instructions' language and voice unit based on the device's [Locale].
* It's also worth exploring other available options (like enabling alternative routes, specifying destination approach type, defining waypoint types, etc.)
* @param routesRequestCallback listener that gets notified when request state changes
* @return requestId, see [cancelRouteRequest]
* @see [registerRoutesObserver]
* @see [registerRouteProgressObserver]
* @see [applyDefaultNavigationOptions]
* @see [applyLanguageAndVoiceUnitOptions]
*/
@Deprecated("use #requestRoutes(RouteOptions, NavigationRouterCallback) instead")
fun requestRoutes(
routeOptions: RouteOptions,
routesRequestCallback: RouterCallback
): Long {
return requestRoutes(
routeOptions,
object : NavigationRouterCallback {
override fun onRoutesReady(
routes: List<NavigationRoute>,
routerOrigin: RouterOrigin
) {
routesRequestCallback.onRoutesReady(
routes.toDirectionsRoutes(),
routerOrigin
)
}
override fun onFailure(reasons: List<RouterFailure>, routeOptions: RouteOptions) {
routesRequestCallback.onFailure(reasons, routeOptions)
}
override fun onCanceled(routeOptions: RouteOptions, routerOrigin: RouterOrigin) {
routesRequestCallback.onCanceled(routeOptions, routerOrigin)
}
}
)
}
/**
* Requests a route using the available [NavigationRouter] implementation.
*
* Use [MapboxNavigation.setNavigationRoutes] to supply the returned list of routes, transformed list, or a list from an external source, to be managed by the SDK.
*
* Example:
* ```
* mapboxNavigation.requestRoutes(routeOptions, object : NavigationRouterCallback {
* override fun onRoutesReady(routes: List<NavigationRoute>) {
* ...
* mapboxNavigation.setNavigationRoutes(routes)
* }
* ...
* })
* ```
*
* @param routeOptions params for the route request.
* **Make sure to use the [applyDefaultNavigationOptions] for the best navigation experience** (and to set required request parameters).
* You can also use [applyLanguageAndVoiceUnitOptions] get instructions' language and voice unit based on the device's [Locale].
* It's also worth exploring other available options (like enabling alternative routes, specifying destination approach type, defining waypoint types, etc.)
* @param callback listener that gets notified when request state changes
* @return requestId, see [cancelRouteRequest]
* @see [registerRoutesObserver]
* @see [registerRouteProgressObserver]
* @see [applyDefaultNavigationOptions]
* @see [applyLanguageAndVoiceUnitOptions]
*/
fun requestRoutes(
routeOptions: RouteOptions,
callback: NavigationRouterCallback
): Long {
return directionsSession.requestRoutes(routeOptions, callback)
}
/**
* Cancels a specific route request using the ID returned by [requestRoutes].
*/
fun cancelRouteRequest(requestId: Long) {
directionsSession.cancelRouteRequest(requestId)
}
/**
* Set a list of routes.
*
* If the list is not empty, the route at index 0 is valid, and the trip session is started,
* then the SDK enters an `Active Guidance` state and [RouteProgress] updates will be available.
*
* If the list is empty, the SDK will exit the `Active Guidance` state.
*
* Use [RoutesObserver] and [MapboxNavigation.registerRoutesObserver] to observe whenever the
* routes list reference managed by the SDK changes, regardless of a source.
*
* This call is asynchronous, only once processing finishes the effects are available through [MapboxNavigation.getNavigationRoutes] and [RoutesObserver].
* If this call fails, no changes are made to the routes managed by the [MapboxNavigation], they are not cleared. Observe the processing with [MapboxNavigation.setNavigationRoutes]'s callback.
*
* **Deprecated**: use #setNavigationRoutes(List<NavigationRoute>) instead. To fetch [NavigationRoute]
* list use #requestRoutes(RouteOptions, NavigationRouterCallback) or create an instance of
* [NavigationRoute] via [NavigationRoute.create], which requires an original [DirectionsResponse]
* object or a raw JSON response.
*
* @param routes a list of [DirectionsRoute]s
* @param initialLegIndex starting leg to follow. By default the first leg is used.
* @see [requestRoutes]
*/
@JvmOverloads
@Deprecated(
"use #setNavigationRoutes(List<NavigationRoute>) instead",
ReplaceWith(
"setNavigationRoutes(routes.toNavigationRoutes(), initialLegIndex)",
"com.mapbox.navigation.base.route.toNavigationRoutes"
)
)
fun setRoutes(routes: List<DirectionsRoute>, initialLegIndex: Int = 0) {
setNavigationRoutes(routes.toNavigationRoutes(), initialLegIndex)
}
/**
* Set a list of routes.
*
* If the list is not empty, the route at index 0 is valid, and the trip session is started,
* then the SDK enters an `Active Guidance` state and [RouteProgress] updates will be available.
*
* If the list is empty, the SDK will exit the `Active Guidance` state.
*
* Use [RoutesObserver] and [MapboxNavigation.registerRoutesObserver] to observe whenever the routes list reference managed by the SDK changes, regardless of a source.
*
* This call is asynchronous, only once [callback] returns the effects are available through [MapboxNavigation.getNavigationRoutes] and [RoutesObserver].
* If this call fails, no changes are made to the routes managed by the [MapboxNavigation], they are not cleared.
*
* @param routes a list of [NavigationRoute]s
* @param initialLegIndex starting leg to follow. By default the first leg is used.
* @param callback callback to be called when routes are set or ignored due to an error. See [RoutesSetCallback].
* @see [requestRoutes]
*/
@JvmOverloads
fun setNavigationRoutes(
routes: List<NavigationRoute>,
initialLegIndex: Int = 0,
callback: RoutesSetCallback? = null
) {
if (routes.isNotEmpty()) {
billingController.onExternalRouteSet(routes.first())
}
// Telemetry uses this field to determine what type of event should be triggered.
@RoutesExtra.RoutesUpdateReason val reason = when {
routes.isEmpty() -> {
RoutesExtra.ROUTES_UPDATE_REASON_CLEAN_UP
}
routes.first() == directionsSession.routes.firstOrNull() -> {
RoutesExtra.ROUTES_UPDATE_REASON_ALTERNATIVE
}
else -> {
RoutesExtra.ROUTES_UPDATE_REASON_NEW
}
}
internalSetNavigationRoutes(
routes,
initialLegIndex,
reason,
callback,
)
}
/**
* Requests road graph data update and invokes the callback on result.
* Use this method if the frequency of application relaunch is too low
* to always get the latest road graph data.
* Recreate [MapboxNavigation] instance in the callback when updates are available:
* ```
* mapboxNavigation.requestRoadGraphDataUpdate(object : RoadGraphDataUpdateCallback {
* override fun onRoadGraphDataUpdateInfoAvailable(
* isUpdateAvailable: Boolean,
* versionInfo: RoadGraphVersionInfo?
* ) {
* if (isUpdateAvailable) {
* val currentOptions = mapboxNavigation.navigationOptions
* MapboxNavigationApp.disable()
* MapboxNavigationApp.setup(currentOptions)
* }
* }
* })
* ```
*
* @param callback callback to be invoked when the information about available
* updates is received. See [RoadGraphDataUpdateCallback].
*/
fun requestRoadGraphDataUpdate(callback: RoadGraphDataUpdateCallback) {
CacheHandleWrapper.requestRoadGraphDataUpdate(navigator.cache, callback)
}
private fun internalSetNavigationRoutes(
routes: List<NavigationRoute>,
legIndex: Int = 0,
@RoutesExtra.RoutesUpdateReason reason: String,
callback: RoutesSetCallback? = null,
) {
rerouteController?.interrupt()
restartRouteScope()
threadController.getMainScopeAndRootJob().scope.launch(Dispatchers.Main.immediate) {
routeUpdateMutex.withLock {
historyRecordingStateHandler.setRoutes(routes)
val routesSetResult: Expected<RoutesSetError, RoutesSetSuccess>
when (val processedRoutes = setRoutesToTripSession(routes, legIndex, reason)) {
is NativeSetRouteValue -> {
val (acceptedAlternatives, ignoredAlternatives) = routes
.drop(1)
.partition { passedRoute ->
processedRoutes.nativeAlternatives.any { processedRoute ->
processedRoute.route.routeId == passedRoute.id
}
}
directionsSession.setRoutes(routes, legIndex, reason)
routesSetResult = ExpectedFactory.createValue(
RoutesSetSuccess(
ignoredAlternatives.associate {
it.id to RoutesSetError("invalid alternative")
}
)
)
}
is NativeSetRouteError -> {
logE("Routes $routes will be ignored as they are not valid")
routesSetResult = ExpectedFactory.createError(
RoutesSetError(processedRoutes.error)
)
historyRecordingStateHandler.lastSetRoutesFailed()
}
}
callback?.onRoutesSet(routesSetResult)
}
}
}
private fun resetTripSessionRoutes() {
threadController.getMainScopeAndRootJob().scope.launch(Dispatchers.Main.immediate) {
routeUpdateMutex.withLock {
val routes = directionsSession.routes
val legIndex = latestLegIndex ?: directionsSession.initialLegIndex
setRoutesToTripSession(routes, legIndex, RoutesExtra.ROUTES_UPDATE_REASON_NEW)
}
}
}
/**
* Call to set routes to trip session.
* This call should be synchronized and only one should be executing at a time.
*/
private suspend fun setRoutesToTripSession(
routes: List<NavigationRoute>,
legIndex: Int = 0,
@RoutesExtra.RoutesUpdateReason reason: String,
): NativeSetRouteResult {
routeAlternativesController.pauseUpdates()
return tripSession.setRoutes(routes, legIndex, reason).apply {
if (this is NativeSetRouteValue) {
routeAlternativesController.processAlternativesMetadata(
routes,
nativeAlternatives
)
}
}.also {
routeAlternativesController.resumeUpdates()
}
}
/**
* Get a list of routes.
*
* If the list is not empty, the route at index 0 is the one treated as the primary route
* and used for route progress, off route events and map-matching calculations.
*
* @return a list of [DirectionsRoute]s
*/
@Deprecated(
"use #getNavigationRoutes() instead",
ReplaceWith(
"getNavigationRoutes().toDirectionsRoutes()",
"com.mapbox.navigation.base.route.toDirectionsRoutes"
)
)
fun getRoutes(): List<DirectionsRoute> = directionsSession.routes.toDirectionsRoutes()
/**
* Get a list of routes.
*
* If the list is not empty, the route at index 0 is the one treated as the primary route
* and used for route progress, off route events and map-matching calculations.
*
* @return a list of [NavigationRoute]s
*/
fun getNavigationRoutes(): List<NavigationRoute> = directionsSession.routes
/**
* Requests an alternative route using the original [RouteOptions] associated with
* [MapboxNavigation.setRoutes()] call and [Router] implementation.
* @see [registerRouteAlternativesObserver]
*/
fun requestAlternativeRoutes() {
routeAlternativesController.triggerAlternativeRequest(null)
}
/**
* Requests an alternative route using the original [RouteOptions] associated with
* [MapboxNavigation.setRoutes()] call and [Router] implementation.
* @see [registerRouteAlternativesObserver]
*/
fun requestAlternativeRoutes(callback: NavigationRouteAlternativesRequestCallback? = null) {
routeAlternativesController.triggerAlternativeRequest(callback)
}
/**
* Requests an alternative route using the original [RouteOptions] associated with
* [MapboxNavigation.setRoutes()] call and [Router] implementation.
* @see [registerRouteAlternativesObserver]
*/
fun requestAlternativeRoutes(callback: RouteAlternativesRequestCallback) {
routeAlternativesController.triggerAlternativeRequest(
object : NavigationRouteAlternativesRequestCallback {
override fun onRouteAlternativeRequestFinished(
routeProgress: RouteProgress,
alternatives: List<NavigationRoute>,
routerOrigin: RouterOrigin
) {
callback.onRouteAlternativeRequestFinished(
routeProgress,
alternatives.toDirectionsRoutes(),
routerOrigin
)
}
override fun onRouteAlternativesRequestError(error: RouteAlternativesError) {
callback.onRouteAlternativesAborted(error.message)