Implement Share for Routes

This code allows sharing from the Route details screen. The output is a JSON file in the same format as the iOS share.

Author: davecraig

app/src/main/java/org/scottishtecharmy/soundscape/MainActivity.kt

@@ -317,6 +317,22 @@ class MainActivity : AppCompatActivity() {
         }
     }
 
+    fun shareRoute(shareUri: Uri?) {
+        if(shareUri != null) {
+            val sendIntent: Intent =
+                Intent().apply {
+                    action = Intent.ACTION_SEND
+                    putExtra(Intent.EXTRA_TITLE, "Shared route")
+                    putExtra(Intent.EXTRA_STREAM, shareUri)
+                    type = "text/plain"
+                    flags += Intent.FLAG_GRANT_READ_URI_PERMISSION
+                }
+
+            val shareIntent = Intent.createChooser(sendIntent, null)
+            startActivity(shareIntent)
+        }
+    }
+
     override fun onNewIntent(intent: Intent) {
         super.onNewIntent(intent)
         Log.d(TAG, "onNewIntent")

app/src/main/java/org/scottishtecharmy/soundscape/screens/markers_routes/screens/routedetailsscreen/RouteDetailsScreen.kt

@@ -68,6 +68,7 @@ fun RouteDetailsScreenVM(
     routePlayerState: RoutePlayerState
 ) {
     val uiState by viewModel.uiState.collectAsStateWithLifecycle()
+    val context = LocalContext.current
     RouteDetailsScreen(
         navController,
         routeId,
@@ -77,6 +78,7 @@ fun RouteDetailsScreenVM(
         getRouteById = { viewModel.getRouteById(routeId) },
         startRoute = { viewModel.startRoute(routeId) },
         stopRoute = { viewModel.stopRoute() },
+        shareRoute = { viewModel.shareRoute(context, routeId) },
         clearErrorMessage = { viewModel.clearErrorMessage() },
         userLocation = userLocation,
         heading = heading
@@ -90,9 +92,10 @@ fun RouteDetailsScreen(
     modifier: Modifier,
     uiState: RouteDetailsUiState,
     routePlayerState: RoutePlayerState,
-    getRouteById: (routeId: Long) -> Unit,
-    startRoute: (routeId: Long) -> Unit,
+    getRouteById: () -> Unit,
+    startRoute: () -> Unit,
     stopRoute: () -> Unit,
+    shareRoute:(routeId: Long) -> Unit,
     clearErrorMessage: () -> Unit,
     userLocation: LngLatAlt?,
     heading: Float
@@ -105,7 +108,7 @@ fun RouteDetailsScreen(
 
     // Fetch the route details when the screen is launched
     LaunchedEffect(routeId) {
-        getRouteById(routeId)
+        getRouteById()
     }
 
     // Display error message if it exists
@@ -212,7 +215,7 @@ fun RouteDetailsScreen(
                                         text = stringResource(R.string.route_detail_action_start_route),
                                         color = MaterialTheme.colorScheme.onSurface
                                     ) {
-                                        startRoute(uiState.route.route.routeId)
+                                        startRoute()
                                         // Pop up to the home screen
                                         navController.navigate(HomeRoutes.Home.route) {
                                             popUpTo(navController.graph.findStartDestination().id) {
@@ -241,7 +244,7 @@ fun RouteDetailsScreen(
                                     talkbackHint = stringResource(R.string.route_detail_action_share_hint),
                                     color = MaterialTheme.colorScheme.onSurface
                                 ) {
-                                    /*TODO*/
+                                    shareRoute(uiState.route.route.routeId)
                                 }
                             }
                             // Small map showing route
@@ -324,6 +327,7 @@ fun RoutesDetailsPopulatedPreview() {
         getRouteById = {},
         startRoute = {},
         stopRoute = {},
+        shareRoute = {},
         clearErrorMessage = {},
         userLocation = null,
         heading = 0.0F,
@@ -342,6 +346,7 @@ fun RoutesDetailsLoadingPreview() {
         getRouteById = {},
         startRoute = {},
         stopRoute = {},
+        shareRoute = {},
         clearErrorMessage = {},
         userLocation = null,
         heading = 0.0F,
@@ -360,6 +365,7 @@ fun RoutesDetailsEmptyPreview() {
         getRouteById = {},
         startRoute = {},
         stopRoute = {},
+        shareRoute = {},
         clearErrorMessage = {},
         userLocation = null,
         heading = 0.0F,

app/src/main/java/org/scottishtecharmy/soundscape/screens/markers_routes/screens/routedetailsscreen/RouteDetailsViewModel.kt

@@ -1,14 +1,21 @@
 package org.scottishtecharmy.soundscape.screens.markers_routes.screens.routedetailsscreen
 
+import android.content.Context
+import android.net.Uri
+import androidx.core.content.FileProvider.getUriForFile
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
 import dagger.hilt.android.lifecycle.HiltViewModel
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.asStateFlow
 import kotlinx.coroutines.launch
+import org.scottishtecharmy.soundscape.MainActivity
 import org.scottishtecharmy.soundscape.SoundscapeServiceConnection
 import org.scottishtecharmy.soundscape.database.local.dao.RouteDao
+import org.scottishtecharmy.soundscape.database.local.model.RouteWithMarkers
+import java.io.File
+import java.io.FileOutputStream
 import javax.inject.Inject
 
 @HiltViewModel
@@ -45,6 +52,106 @@ class RouteDetailsViewModel @Inject constructor(
         soundscapeServiceConnection.routeStop()
     }
 
+//
+// Example JSON for shared route:
+//
+//    {
+//        "name": "Test Route",
+//        "id": "F41302B9-A91A-4D8F-8958-6C052E334076",
+//        "routeDescription": "",
+//        "waypoints": [
+//        {
+//            "marker": {
+//                "nickname": "Home",
+//                "location": {
+//                    "name": "Home",
+//                    "coordinate": {
+//                        "latitude": 55.9553596,
+//                        "longitude": -3.2031666
+//                    }
+//                },
+//                "estimatedAddress": "28A Heriot Row, Edinburgh, Scotland, EH3 6EN",
+//                "id": "489A82CE-EF43-46F8-85FB-8D79F88763F6",
+//                "lastUpdatedDate": 759964150.733105
+//            },
+//            "index": 0,
+//            "markerId": "489A82CE-EF43-46F8-85FB-8D79F88763F6"
+//        },
+//        ]
+//    }
+//
+    private fun generateRouteJson(route: RouteWithMarkers?, outputFile: File) {
+
+        val outputStream = FileOutputStream(outputFile, false)
+        outputStream.write(
+            (
+                "{\n" +
+                "\t\"name\": \"${route?.route?.name ?: ""}\",\n" +
+                "\t\"id\": \"${route?.route?.routeId ?: 0L}\",\n" +
+                "\t\"routeDescription\": \"${route?.route?.description ?: ""}\",\n" +
+                "\t\"waypoints\": [\n"
+            ).toByteArray()
+        )
+
+        for ((index, marker) in (route?.markers ?: emptyList()).withIndex()) {
+            if (index > 0) {
+                outputStream.write(",\n".toByteArray())
+            }
+            outputStream.write(
+                (
+                    "\t\t{\n" +
+                    "\t\t\t\"marker\": {\n" +
+                    "\t\t\t\t\"nickname\": \"${marker.name}\",\n" +
+                    "\t\t\t\t\"location\": {\n" +
+                    "\t\t\t\t\t\"name\": \"${marker.name}\",\n" +
+                    "\t\t\t\t\t\"coordinate\": {\n" +
+                    "\t\t\t\t\t\t\"latitude\": ${marker.latitude},\n" +
+                    "\t\t\t\t\t\t\"longitude\": ${marker.longitude}\n" +
+                    "\t\t\t\t\t}\n" +
+                    "\t\t\t\t},\n" +
+                    "\t\t\t\t\"estimatedAddress\": \"${marker.fullAddress}\",\n" +
+                    "\t\t\t\t\"id\": \"${marker.markerId}\"\n" +
+                    "\t\t\t},\n" +
+                    "\t\t\t\"index\": $index,\n" +
+                    "\t\t\t\"markerId\": \"${marker.markerId}\"\n" +
+                    "\t\t}"
+                ).toByteArray()
+            )
+        }
+        outputStream.write(
+            (
+                "\n\t]\n" +
+                "}\n"
+            ).toByteArray()
+        )
+    }
+
+    private fun writeRouteAndReturnUri(context: Context, route: RouteWithMarkers?) : Uri? {
+
+        // Write the route to a file and share it
+        val path = "${context.filesDir}/route/"
+        val routeStorageDir = File(path)
+        if (!routeStorageDir.exists()) {
+            routeStorageDir.mkdirs()
+        }
+        val outputFile = File(routeStorageDir, "route.json")
+        generateRouteJson(route, outputFile)
+
+        return getUriForFile(context, "org.scottishtecharmy.fileprovider", outputFile)
+    }
+
+
+    fun shareRoute(context: Context, routeId: Long) {
+        // Get the route from the database
+        val route = routeDao.getRouteWithMarkers(routeId)
+        if(route != null) {
+            // Write the route to a file, and then call the MainActivity shareRoute function with a
+            // shared URI to the file.
+            val shareUri = writeRouteAndReturnUri(context, route)
+            (context as MainActivity).shareRoute(shareUri)
+        }
+    }
+
     fun clearErrorMessage() {
         _uiState.value = _uiState.value.copy(errorMessage = null)
     }

app/src/main/res/xml/filepaths.xml

@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <paths>
     <files-path path="recordings/" name="recordings" />
+    <files-path path="route/" name="route" />
 </paths>