Merge pull request #8144 from vector-im/feature/mna/user-location-in-loc-sharing

[Location sharing] Show own location in map views

Author: mnaturel

changelog.d/8110.feature

@@ -0,0 +1 @@
+[Location sharing] Show own location in map views

vector/src/main/java/im/vector/app/features/location/LocationDialog.kt

@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) 2023 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package im.vector.app.features.location
+
+import androidx.fragment.app.Fragment
+import com.google.android.material.dialog.MaterialAlertDialogBuilder
+import im.vector.app.R
+
+fun Fragment.showUserLocationNotAvailableErrorDialog(onConfirmListener: () -> Unit) {
+    MaterialAlertDialogBuilder(requireActivity())
+            .setTitle(R.string.location_not_available_dialog_title)
+            .setMessage(R.string.location_not_available_dialog_content)
+            .setPositiveButton(R.string.ok) { _, _ ->
+                onConfirmListener()
+            }
+            .setCancelable(false)
+            .show()
+}

vector/src/main/java/im/vector/app/features/location/LocationSharingFragment.kt

@@ -176,14 +176,7 @@ class LocationSharingFragment :
     }
 
     private fun handleLocationNotAvailableError() {
-        MaterialAlertDialogBuilder(requireActivity())
-                .setTitle(R.string.location_not_available_dialog_title)
-                .setMessage(R.string.location_not_available_dialog_content)
-                .setPositiveButton(R.string.ok) { _, _ ->
-                    locationSharingNavigator.quit()
-                }
-                .setCancelable(false)
-                .show()
+        showUserLocationNotAvailableErrorDialog { locationSharingNavigator.quit() }
     }
 
     private fun handleLiveLocationSharingNotEnoughPermission() {

vector/src/main/java/im/vector/app/features/location/LocationSharingViewState.kt

@@ -47,7 +47,7 @@ data class LocationSharingViewState(
 
 fun LocationSharingViewState.toMapState() = MapState(
         zoomOnlyOnce = true,
-        userLocationData = lastKnownUserLocation,
+        pinLocationData = lastKnownUserLocation,
         pinId = DEFAULT_PIN_ID,
         pinDrawable = null,
         // show the map pin only when target location and user location are not equal

vector/src/main/java/im/vector/app/features/location/LocationTracker.kt

@@ -66,6 +66,8 @@ class LocationTracker @Inject constructor(
     @VisibleForTesting
     var hasLocationFromGPSProvider = false
 
+    private var isStarted = false
+    private var isStarting = false
     private var firstLocationHandled = false
     private val _locations = MutableSharedFlow<Location>(replay = 1)
 
@@ -90,43 +92,48 @@ class LocationTracker @Inject constructor(
 
     @RequiresPermission(anyOf = [Manifest.permission.ACCESS_COARSE_LOCATION, Manifest.permission.ACCESS_FINE_LOCATION])
     fun start() {
-        Timber.d("start()")
-
-        if (locationManager == null) {
-            Timber.v("LocationManager is not available")
-            onNoLocationProviderAvailable()
-            return
-        }
+        if (!isStarting && !isStarted) {
+            isStarting = true
+            Timber.d("start()")
+
+            if (locationManager == null) {
+                Timber.v("LocationManager is not available")
+                onNoLocationProviderAvailable()
+                return
+            }
 
-        val providers = locationManager.allProviders
+            val providers = locationManager.allProviders
 
-        if (providers.isEmpty()) {
-            Timber.v("There is no location provider available")
-            onNoLocationProviderAvailable()
-        } else {
-            // Take GPS first
-            providers.sortedByDescending(::getProviderPriority)
-                    .mapNotNull { provider ->
-                        Timber.d("track location using $provider")
-
-                        locationManager.requestLocationUpdates(
-                                provider,
-                                minDurationToUpdateLocationMillis,
-                                MIN_DISTANCE_TO_UPDATE_LOCATION_METERS,
-                                this
-                        )
-
-                        locationManager.getLastKnownLocation(provider)
-                    }
-                    .maxByOrNull { location -> location.time }
-                    ?.let { latestKnownLocation ->
-                        if (buildMeta.lowPrivacyLoggingEnabled) {
-                            Timber.d("lastKnownLocation: $latestKnownLocation")
-                        } else {
-                            Timber.d("lastKnownLocation: ${latestKnownLocation.provider}")
+            if (providers.isEmpty()) {
+                Timber.v("There is no location provider available")
+                onNoLocationProviderAvailable()
+            } else {
+                // Take GPS first
+                providers.sortedByDescending(::getProviderPriority)
+                        .mapNotNull { provider ->
+                            Timber.d("track location using $provider")
+
+                            locationManager.requestLocationUpdates(
+                                    provider,
+                                    minDurationToUpdateLocationMillis,
+                                    MIN_DISTANCE_TO_UPDATE_LOCATION_METERS,
+                                    this
+                            )
+
+                            locationManager.getLastKnownLocation(provider)
+                        }
+                        .maxByOrNull { location -> location.time }
+                        ?.let { latestKnownLocation ->
+                            if (buildMeta.lowPrivacyLoggingEnabled) {
+                                Timber.d("lastKnownLocation: $latestKnownLocation")
+                            } else {
+                                Timber.d("lastKnownLocation: ${latestKnownLocation.provider}")
+                            }
+                            notifyLocation(latestKnownLocation)
                         }
-                        notifyLocation(latestKnownLocation)
-                    }
+            }
+            isStarted = true
+            isStarting = false
         }
     }
 
@@ -148,6 +155,8 @@ class LocationTracker @Inject constructor(
         callbacks.clear()
         hasLocationFromGPSProvider = false
         hasLocationFromFusedProvider = false
+        isStarting = false
+        isStarted = false
     }
 
     /**

vector/src/main/java/im/vector/app/features/location/MapState.kt

@@ -21,9 +21,10 @@ import androidx.annotation.Px
 
 data class MapState(
         val zoomOnlyOnce: Boolean,
-        val userLocationData: LocationData? = null,
+        val pinLocationData: LocationData? = null,
         val pinId: String,
         val pinDrawable: Drawable? = null,
         val showPin: Boolean = true,
-        @Px val logoMarginBottom: Int = 0
+        val userLocationData: LocationData? = null,
+        @Px val logoMarginBottom: Int = 0,
 )

vector/src/main/java/im/vector/app/features/location/MapTilerMapView.kt

@@ -18,6 +18,7 @@ package im.vector.app.features.location
 
 import android.content.Context
 import android.content.res.TypedArray
+import android.graphics.drawable.Drawable
 import android.util.AttributeSet
 import android.view.Gravity
 import android.widget.ImageView
@@ -38,6 +39,8 @@ import im.vector.app.R
 import im.vector.app.core.utils.DimensionConverter
 import timber.log.Timber
 
+private const val USER_PIN_ID = "user-pin-id"
+
 class MapTilerMapView @JvmOverloads constructor(
         context: Context,
         attrs: AttributeSet? = null,
@@ -101,9 +104,11 @@ class MapTilerMapView @JvmOverloads constructor(
 
     private fun initMapStyle(map: MapboxMap, url: String) {
         map.setStyle(url) { style ->
+            val symbolManager = SymbolManager(this, map, style)
+            symbolManager.iconAllowOverlap = true
             mapRefs = MapRefs(
                     map,
-                    SymbolManager(this, map, style),
+                    symbolManager,
                     style
             )
             pendingState?.let { render(it) }
@@ -166,29 +171,43 @@ class MapTilerMapView @JvmOverloads constructor(
         }
 
         val pinDrawable = state.pinDrawable ?: userLocationDrawable
-        pinDrawable?.let { drawable ->
-            if (!safeMapRefs.style.isFullyLoaded ||
-                    safeMapRefs.style.getImage(state.pinId) == null) {
-                safeMapRefs.style.addImage(state.pinId, drawable.toBitmap())
-            }
-        }
+        addImageToMapStyle(pinDrawable, state.pinId, safeMapRefs)
 
-        state.userLocationData?.let { locationData ->
+        safeMapRefs.symbolManager.deleteAll()
+        state.pinLocationData?.let { locationData ->
             if (!initZoomDone || !state.zoomOnlyOnce) {
                 zoomToLocation(locationData)
                 initZoomDone = true
             }
 
-            safeMapRefs.symbolManager.deleteAll()
             if (pinDrawable != null && state.showPin) {
-                safeMapRefs.symbolManager.create(
-                        SymbolOptions()
-                                .withLatLng(LatLng(locationData.latitude, locationData.longitude))
-                                .withIconImage(state.pinId)
-                                .withIconAnchor(Property.ICON_ANCHOR_BOTTOM)
-                )
+                createSymbol(locationData, state.pinId, safeMapRefs)
             }
         }
+
+        state.userLocationData?.let { locationData ->
+            addImageToMapStyle(userLocationDrawable, USER_PIN_ID, safeMapRefs)
+            if (userLocationDrawable != null) {
+                createSymbol(locationData, USER_PIN_ID, safeMapRefs)
+            }
+        }
+    }
+
+    private fun addImageToMapStyle(image: Drawable?, imageId: String, mapRefs: MapRefs) {
+        image?.let { drawable ->
+            if (!mapRefs.style.isFullyLoaded || mapRefs.style.getImage(imageId) == null) {
+                mapRefs.style.addImage(imageId, drawable.toBitmap())
+            }
+        }
+    }
+
+    private fun createSymbol(locationData: LocationData, imageId: String, mapRefs: MapRefs) {
+        mapRefs.symbolManager.create(
+                SymbolOptions()
+                        .withLatLng(LatLng(locationData.latitude, locationData.longitude))
+                        .withIconImage(imageId)
+                        .withIconAnchor(Property.ICON_ANCHOR_BOTTOM)
+        )
     }
 
     fun zoomToLocation(locationData: LocationData) {

vector/src/main/java/im/vector/app/features/location/live/map/LiveLocationMapAction.kt

@@ -23,4 +23,5 @@ sealed class LiveLocationMapAction : VectorViewModelAction {
     data class RemoveMapSymbol(val key: String) : LiveLocationMapAction()
     object StopSharing : LiveLocationMapAction()
     object ShowMapLoadingError : LiveLocationMapAction()
+    object ZoomToUserLocation : LiveLocationMapAction()
 }

vector/src/main/java/im/vector/app/features/location/live/map/LiveLocationMapViewEvents.kt

@@ -17,7 +17,10 @@
 package im.vector.app.features.location.live.map
 
 import im.vector.app.core.platform.VectorViewEvents
+import im.vector.app.features.location.LocationData
 
 sealed interface LiveLocationMapViewEvents : VectorViewEvents {
-    data class Error(val error: Throwable) : LiveLocationMapViewEvents
+    data class LiveLocationError(val error: Throwable) : LiveLocationMapViewEvents
+    data class ZoomToUserLocation(val userLocation: LocationData) : LiveLocationMapViewEvents
+    object UserLocationNotAvailableError : LiveLocationMapViewEvents
 }