Cleanup: renamed IntentDashboardUtils.java to DataProvider.

2026-02-07 19:20:48 +01:00
parent 723c21d7ec
commit 1a5d06f9c6
6 changed files with 12 additions and 14 deletions
@@ -0,0 +1,126 @@
+package de.dennisguse.opentracks.publicapi;
+
+import android.content.ActivityNotFoundException;
+import android.content.ClipData;
+import android.content.Context;
+import android.content.Intent;
+import android.net.Uri;
+import android.util.Log;
+import android.widget.Toast;
+
+import androidx.annotation.Nullable;
+
+import java.util.ArrayList;
+
+import de.dennisguse.opentracks.R;
+import de.dennisguse.opentracks.data.ContentProviderUtils;
+import de.dennisguse.opentracks.data.models.Track;
+import de.dennisguse.opentracks.data.tables.MarkerColumns;
+import de.dennisguse.opentracks.data.tables.TrackPointsColumns;
+import de.dennisguse.opentracks.data.tables.TracksColumns;
+import de.dennisguse.opentracks.settings.PreferencesUtils;
+
+/**
+ * Create an {@link Intent} to request showing tracks on a Map or a Dashboard.
+ * The receiving {@link android.app.Activity} gets temporary access to the {@link TracksColumns} and the {@link TrackPointsColumns} (incl. update).
+ */
+public class DataProvider {
+
+    private static final String TAG = DataProvider.class.getSimpleName();
+
+    private static final String ACTION_DASHBOARD = "Intent.OpenTracks-Dashboard";
+
+    private static final String ACTION_DASHBOARD_PAYLOAD = ACTION_DASHBOARD + ".Payload";
+
+    /**
+     * Assume "v1" if not present.
+     */
+    private static final String EXTRAS_PROTOCOL_VERSION = "PROTOCOL_VERSION";
+
+    /**
+     * version 1: the initial version.
+     * version 2: replaced pause/resume trackpoints for track segmentation (lat=100 / lat=200) by TrackPoint.Type.
+     * version 3: renamed track database columns.
+     */
+    private static final int CURRENT_VERSION = 3;
+
+    private static final String EXTRAS_OPENTRACKS_IS_RECORDING_THIS_TRACK = "EXTRAS_OPENTRACKS_IS_RECORDING_THIS_TRACK";
+    private static final String EXTRAS_SHOULD_KEEP_SCREEN_ON = "EXTRAS_SHOULD_KEEP_SCREEN_ON";
+    private static final String EXTRAS_SHOW_WHEN_LOCKED = "EXTRAS_SHOULD_KEEP_SCREEN_ON";
+    private static final String EXTRAS_SHOW_FULLSCREEN = "EXTRAS_SHOULD_FULLSCREEN";
+
+    private static final int TRACK_URI_INDEX = 0;
+    private static final int TRACKPOINTS_URI_INDEX = 1;
+    private static final int MARKERS_URI_INDEX = 2;
+    private static final int NONE_SELECTED = -1;
+
+    private DataProvider() {
+    }
+
+    /**
+     * Send intent to show tracks on a map (needs an another app) as resource URIs.
+     *
+     * @param context  the context
+     * @param isRecording are we currently recording?
+     * @param trackIds the track ids
+     */
+    public static void showTrackOnMap(Context context, boolean isRecording, Track.Id... trackIds) {
+        startDashboard(context, isRecording, null, null, trackIds);
+    }
+
+    /**
+     * Send intent to show tracks on a map (needs an another app) as resource URIs.
+     * By providing a targetPackage and targetClass an explicit intent can be sent,
+     * thus bypassing the need for the user to select an app.
+     *
+     * @param context the context
+     * @param isRecording are we currently recording?
+     * @param targetPackage the target package
+     * @param targetClass the target class
+     * @param trackIds the track ids
+     */
+    public static void startDashboard(Context context, boolean isRecording, @Nullable String targetPackage, @Nullable String targetClass, Track.Id... trackIds) {
+        if (trackIds.length == 0) {
+            return;
+        }
+
+        String trackIdList = ContentProviderUtils.formatIdListForUri(trackIds);
+
+        ArrayList<Uri> uris = new ArrayList<>();
+        uris.add(TRACK_URI_INDEX, Uri.withAppendedPath(TracksColumns.CONTENT_URI, trackIdList));
+        uris.add(TRACKPOINTS_URI_INDEX, Uri.withAppendedPath(TrackPointsColumns.CONTENT_URI_BY_TRACKID, trackIdList));
+        uris.add(MARKERS_URI_INDEX, Uri.withAppendedPath(MarkerColumns.CONTENT_URI_BY_TRACKID, trackIdList));
+
+        Intent intent = new Intent(ACTION_DASHBOARD);
+        intent.putExtra(EXTRAS_PROTOCOL_VERSION, CURRENT_VERSION);
+
+        intent.putParcelableArrayListExtra(ACTION_DASHBOARD_PAYLOAD, uris);
+
+        intent.putExtra(EXTRAS_SHOULD_KEEP_SCREEN_ON, PreferencesUtils.shouldKeepScreenOn());
+        intent.putExtra(EXTRAS_SHOW_WHEN_LOCKED, PreferencesUtils.shouldShowStatsOnLockscreen());
+        intent.putExtra(EXTRAS_OPENTRACKS_IS_RECORDING_THIS_TRACK, isRecording);
+        if (isRecording) {
+            intent.putExtra(EXTRAS_SHOW_FULLSCREEN, PreferencesUtils.shouldUseFullscreen());
+        }
+
+        intent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION);
+        ClipData clipData = ClipData.newRawUri(null, uris.get(TRACK_URI_INDEX));
+        clipData.addItem(new ClipData.Item(uris.get(TRACKPOINTS_URI_INDEX)));
+        clipData.addItem(new ClipData.Item(uris.get(MARKERS_URI_INDEX)));
+        intent.setClipData(clipData);
+
+        if (targetPackage != null && targetClass != null) {
+            Log.i(TAG, "Starting dashboard activity with explicit intent (package=" + targetPackage + ", class=" + targetClass + ")");
+            intent.setClassName(targetPackage, targetClass);
+        } else {
+            Log.i(TAG, "Starting dashboard activity with generic intent (package=" + targetPackage + ", class=" + targetClass + ")");
+        }
+
+        try {
+            context.startActivity(intent);
+        } catch (ActivityNotFoundException e) {
+            Log.e(TAG, "Dashboard not installed; cannot start it.");
+            Toast.makeText(context, R.string.show_on_dashboard_not_installed, Toast.LENGTH_SHORT).show();
+        }
+    }
+}