Merge pull request #5479 from vector-im/feature/mna/PSF-735-pinned-location

#5417: Pinned location sharing

Author: mnaturel

changelog.d/5417.feature

@@ -0,0 +1 @@
+Add ability to pin a location on map for sharing

library/ui-styles/src/main/res/values/dimens.xml

@@ -64,4 +64,7 @@
 
     <!--  Location sharing   -->
     <dimen name="location_sharing_option_default_padding">10dp</dimen>
+    <dimen name="location_sharing_locate_button_margin_vertical">16dp</dimen>
+    <dimen name="location_sharing_locate_button_margin_horizontal">12dp</dimen>
+    <dimen name="location_sharing_compass_button_margin_horizontal">8dp</dimen>
 </resources>

library/ui-styles/src/main/res/values/stylable_map_tiler_map_view.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<resources>
+
+    <declare-styleable name="MapTilerMapView">
+        <attr name="showLocateButton" format="boolean" />
+    </declare-styleable>
+
+</resources>

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/model/message/LocationAsset.kt

@@ -21,5 +21,5 @@ import com.squareup.moshi.JsonClass
 
 @JsonClass(generateAdapter = true)
 data class LocationAsset(
-        @Json(name = "type") val type: LocationAssetType? = null
+        @Json(name = "type") val type: String? = null
 )

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/model/message/LocationAssetType.kt

@@ -16,11 +16,20 @@
 
 package org.matrix.android.sdk.api.session.room.model.message
 
-import com.squareup.moshi.Json
-import com.squareup.moshi.JsonClass
+/**
+ * Define what particular asset is being referred to.
+ * We don't use enum type since it is not limited to a specific set of values.
+ * The way this type should be interpreted in client side is described in
+ * [MSC3488](https://github.com/matrix-org/matrix-doc/blob/matthew/location/proposals/3488-location.md)
+ */
+object LocationAssetType {
+    /**
+     * Used for user location sharing.
+     **/
+    const val SELF = "m.self"
 
-@JsonClass(generateAdapter = false)
-enum class LocationAssetType {
-    @Json(name = "m.self")
-    SELF
+    /**
+     * Used for pin drop location sharing.
+     **/
+    const val PIN = "m.pin"
 }

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/model/message/MessageLocationContent.kt

@@ -42,7 +42,7 @@ data class MessageLocationContent(
         @Json(name = "m.relates_to") override val relatesTo: RelationDefaultContent? = null,
         @Json(name = "m.new_content") override val newContent: Content? = null,
         /**
-         * See https://github.com/matrix-org/matrix-doc/blob/matthew/location/proposals/3488-location.md
+         * See [MSC3488](https://github.com/matrix-org/matrix-doc/blob/matthew/location/proposals/3488-location.md)
          */
         @Json(name = "org.matrix.msc3488.location") val unstableLocationInfo: LocationInfo? = null,
         @Json(name = "m.location") val locationInfo: LocationInfo? = null,
@@ -54,10 +54,11 @@ data class MessageLocationContent(
         @Json(name = "org.matrix.msc1767.text") val unstableText: String? = null,
         @Json(name = "m.text") val text: String? = null,
         /**
-         * m.asset defines a generic asset that can be used for location tracking but also in other places like
+         * Defines a generic asset that can be used for location tracking but also in other places like
          * inventories, geofencing, checkins/checkouts etc.
          * It should contain a mandatory namespaced type key defining what particular asset is being referred to.
          * For the purposes of user location tracking m.self should be used in order to avoid duplicating the mxid.
+         * See [MSC3488](https://github.com/matrix-org/matrix-doc/blob/matthew/location/proposals/3488-location.md)
          */
         @Json(name = "org.matrix.msc3488.asset") val unstableLocationAsset: LocationAsset? = null,
         @Json(name = "m.asset") val locationAsset: LocationAsset? = null

matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/send/SendService.kt

@@ -142,8 +142,9 @@ interface SendService {
      * @param latitude required latitude of the location
      * @param longitude required longitude of the location
      * @param uncertainty Accuracy of the location in meters
+     * @param isUserLocation indicates whether the location data corresponds to the user location or not
      */
-    fun sendLocation(latitude: Double, longitude: Double, uncertainty: Double?): Cancelable
+    fun sendLocation(latitude: Double, longitude: Double, uncertainty: Double?, isUserLocation: Boolean): Cancelable
 
     /**
      * Remove this failed message from the timeline

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/room/send/DefaultSendService.kt

@@ -128,8 +128,8 @@ internal class DefaultSendService @AssistedInject constructor(
                 .let { sendEvent(it) }
     }
 
-    override fun sendLocation(latitude: Double, longitude: Double, uncertainty: Double?): Cancelable {
-        return localEchoEventFactory.createLocationEvent(roomId, latitude, longitude, uncertainty)
+    override fun sendLocation(latitude: Double, longitude: Double, uncertainty: Double?, isUserLocation: Boolean): Cancelable {
+        return localEchoEventFactory.createLocationEvent(roomId, latitude, longitude, uncertainty, isUserLocation)
                 .also { createLocalEcho(it) }
                 .let { sendEvent(it) }
     }

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/room/send/LocalEchoEventFactory.kt

@@ -227,13 +227,15 @@ internal class LocalEchoEventFactory @Inject constructor(
     fun createLocationEvent(roomId: String,
                             latitude: Double,
                             longitude: Double,
-                            uncertainty: Double?): Event {
+                            uncertainty: Double?,
+                            isUserLocation: Boolean): Event {
         val geoUri = buildGeoUri(latitude, longitude, uncertainty)
+        val assetType = if (isUserLocation) LocationAssetType.SELF else LocationAssetType.PIN
         val content = MessageLocationContent(
                 geoUri = geoUri,
                 body = geoUri,
                 unstableLocationInfo = LocationInfo(geoUri = geoUri, description = geoUri),
-                unstableLocationAsset = LocationAsset(type = LocationAssetType.SELF),
+                unstableLocationAsset = LocationAsset(type = assetType),
                 unstableTs = TimeUnit.MILLISECONDS.toSeconds(System.currentTimeMillis()),
                 unstableText = geoUri
         )

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

@@ -123,7 +123,7 @@ class LocationPreviewFragment @Inject constructor(
                 views.mapView.render(
                         MapState(
                                 zoomOnlyOnce = true,
-                                pinLocationData = location,
+                                userLocationData = location,
                                 pinId = args.locationOwnerId ?: DEFAULT_PIN_ID,
                                 pinDrawable = pinDrawable
                         )