Milestone v131 — Migrating to WorkManager, OSM prompt option, file upload broadcast, notification for errors, SPD_KPH param

.github/workflows/android.yml

@@ -18,7 +18,7 @@ jobs:
         java-version: '17'
 
     - name: Build with Gradle
-      run: ./gradlew assembleDebugUnitTest -Dpre-dex=false
+      run: ./gradlew assembleDebugUnitTest -Dpre-dex=false --no-configuration-cache
 
     - name: Run Unit Tests
-      run: ./gradlew testDebugUnitTest -Dpre-dex=false -q
+      run: ./gradlew testDebugUnitTest -Dpre-dex=false -q --no-configuration-cache

assets/text/faq/faq13-difference-other-apps.md

@@ -1,6 +1,8 @@
 ## How is this different from other logging apps?
 
-It's meant to be more battery efficient. A lot of other apps, such as [OpenTracks](https://github.com/OpenTracksApp/OpenTracks), usually go with the assumption that you have a data connection available and your routes won't be very long. They use CPU wakelocks and log points extremely frequently with high accuracy. The aim of GPSLogger is to log points and stay quiet.  
+It's meant to be more battery efficient. A lot of other apps, such as [OpenTracks](https://github.com/OpenTracksApp/OpenTracks), usually go with the assumption that you have a data connection available and your routes won't be very long. 
+They use CPU wakelocks and log points extremely frequently with high accuracy. The aim of GPSLogger is to log points and stay quiet.  
 
 To put it another way, OpenTracks or similar are better suited for runs; GPSLogger is suited for days out, hiking, photography.
 
+[BasicAirData GPSLogger](https://play.google.com/store/apps/details?id=eu.basicairdata.graziano.gpslogger&hl=en&gl=US), [Ultra GPS Logger](https://play.google.com/store/apps/details?id=com.flashlight.lite.gps.logger&hl=en&gl=US) have similar names but aren't associated with this project. 

assets/text/faq/faq14-tasker-automation.md

@@ -54,20 +54,32 @@ The app comes with a Start and a Stop **shortcut** (long press home screen, add
 
 ### Listening to GPSLogger
 
+GPSLogger sends a broadcast start/stop of logging, or file uploaded, which you can receive as an event.  
+
+In Tasker, this would be the `Intent Received` event.  
+Set the action to `com.mendhak.gpslogger.EVENT`.  
+You can then access the extras as `%variablename` or `%arrayname1`.  
+
+In Automate, you can use the Broadcast Receive block.  
+Set the Action to `com.mendhak.gpslogger.EVENT`.  
+Set the dictionary with broadcast extras to a variable, then access the extras as `myvar["variablename"]` or `myvar["arrayname"][0]`.  
+
+From there in your task, you can look at the following variables.
+
+*Start/Stop logging*
+
+* `gpsloggerevent` - `started` or `stopped`
+* `filename` - the base filename that was chosen (no extension)
+* `startedtimestamp` - timestamp when logging was started (epoch)
+* `duration` - seconds since the current session started
+* `distance` - meters travelled since the session started
+
+
+*File uploaded*
+
+* `gpsloggerevent` - `fileuploaded`
+* `filepaths` - an array of file paths that were uploaded, even if it's just a single file
+* `sendertype` - which sender was used to upload the file, e.g. `customurl`, `ftp`, etc.
 
-(Experimental feature) GPSLogger sends a broadcast start/stop of logging, which you can receive as an event.
-
-In Tasker, this would look like:  
-
-> Event: Intent Received  
-  Action: com.mendhak.gpslogger.EVENT 
-
-From there in your task, you can look at the following variables
-
- * `%gpsloggerevent` - `started` or `stopped`
- * `%filename` - the base filename that was chosen (no extension)
- * `%startedtimestamp` - timestamp when logging was started (epoch)
- * `%duration` - seconds since the current session started
- * `%distance` - meters travelled since the session started
 
 In a custom application, receive the `com.mendhak.gpslogger.EVENT` broadcast and have a look inside the extras.

assets/text/faq/faq17-other-uses.md

@@ -3,13 +3,13 @@
 
 The GPS files produced by this app are generally used for processing *other* things.  
 
-A common use case is to geotag photos.  Many cameras, especially SLRs, don't have built-in GPS.  After a day (or days) out of photography, you may have hundreds of photos that need to be geotagged so that their locations can appear properly when used elsewhere.  
+A common use case is to geotag photos.  Many cameras, especially SLRs, don't have built-in GPS. After a day (or days) out of photography, you may have hundreds of photos that need to be geotagged so that their locations can appear properly when used elsewhere.  
 
 I have had success with:
 
 * [GeoSetter](http://www.geosetter.de/en/) - GUI, comprehensive options with map display
-* [ExifTool](http://askubuntu.com/questions/599395/how-can-i-batch-tag-several-hundred-photos-with-separately-recorded-gps-data) - command line, lots of options
-* Lightroom's map module - very basic and limited
+* [digiKam](https://www.digikam.org/) - Open Source photo management. Geotagging and geocoding are tools within this software   
+* [ExifTool](http://askubuntu.com/questions/599395/how-can-i-batch-tag-several-hundred-photos-with-separately-recorded-gps-data) - command line, lots of options  
 
 
  There are of course other uses of the produced files, these are a few I've seen over the years; it's usually a combination of a log file produced from GPSLogger with a secondary software to process the files.  

build.gradle

@@ -0,0 +1 @@
+// Top-level build file where you can add configuration options common to all sub-projects/modules.

fastlane/metadata/android/en-US/changelogs/131.txt

@@ -0,0 +1,6 @@
+* OpenStreetMap option to be prompted before logging starts
+* Switching to Android WorkManager for sending tasks, should be more reliable.
+* Broadcast is sent when file upload completed, useful for automation to clean up files.
+* Error notifications and less crashing if permissions have been revoked or file writes fail.
+* New Custom URL parameter, %SPD_KPH
+* Clarified autosend description: dynamic file name change also results in the file being sent.

gpslogger/build.gradle

@@ -7,9 +7,9 @@ buildscript {
         }
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:7.2.0'
+        classpath 'com.android.tools.build:gradle:8.1.4'
 
-        classpath 'org.jacoco:org.jacoco.core:0.7.4.201502262128'
+        classpath 'org.jacoco:org.jacoco.core:0.8.7'
         classpath "com.moowork.gradle:gradle-node-plugin:0.13"
     }
 }
@@ -37,16 +37,18 @@ repositories {
 }
 
 android {
-    compileSdkVersion 30
+    compileSdkVersion 34
 
     defaultConfig {
         applicationId "com.mendhak.gpslogger"
         minSdkVersion 16
+        //noinspection ExpiredTargetSdkVersion
         targetSdkVersion 30
+        compileSdk 34
+        versionCode 131
+        versionName "131-rc2"
 
-        versionCode 130
-        versionName "130"
-
+        // Used by AppAuth-Android
         manifestPlaceholders = [
                 appAuthRedirectScheme: 'com.mendhak.gpslogger'
         ]
@@ -86,8 +88,6 @@ android {
                 keyAlias RELEASE_KEY_ALIAS
                 keyPassword RELEASE_KEY_PASSWORD
             }
-
-
         }
 
         buildTypes {
@@ -121,10 +121,10 @@ android {
 dependencies {
 
 //    implementation 'androidx.legacy:legacy-support-v4:1.0.0'
-    implementation "androidx.activity:activity:1.3.1"
-    implementation "androidx.fragment:fragment:1.3.6"
-    implementation "androidx.preference:preference:1.1.1"
-    implementation "androidx.constraintlayout:constraintlayout:2.1.0"
+    implementation "androidx.activity:activity:1.8.2"
+    implementation "androidx.fragment:fragment:1.6.2"
+    implementation "androidx.preference:preference:1.2.1"
+    implementation "androidx.constraintlayout:constraintlayout:2.1.4"
 
 
     //Google Drive Oauth
@@ -136,7 +136,7 @@ dependencies {
 
 
     //Debug Logging
-    implementation('org.slf4j:slf4j-api:1.7.6')
+    implementation('org.slf4j:slf4j-api:1.7.30')
     implementation('com.github.tony19:logback-android-classic:1.1.1-2'){
         exclude group: 'com.google.android', module: 'android'
     }
@@ -145,7 +145,7 @@ dependencies {
 
 
     //Android lollipop/material features including the Toolbar
-    implementation 'androidx.appcompat:appcompat:1.3.1'
+    implementation 'androidx.appcompat:appcompat:1.6.1'
 
 
     //Cardviews
@@ -163,10 +163,10 @@ dependencies {
     //Progress button
     implementation 'com.github.dmytrodanylyk.android-process-button:library:1.0.4'
 
-    //Android Priority Jobqueue
-    implementation ('com.birbit:android-priority-jobqueue:2.0.1'){
-        exclude group: 'com.google.android', module: 'android'
-    }
+    //Android's WorkManager
+    implementation 'androidx.work:work-runtime:2.9.0'
+    // We need to use Gson to help with WorkManager limitations
+    implementation 'com.google.code.gson:gson:2.10.1'
 
     //Event bus
     implementation 'de.greenrobot:eventbus:2.4.0'
@@ -215,8 +215,8 @@ dependencies {
     testImplementation 'junit:junit:4.12'
     testImplementation 'org.mockito:mockito-core:3.10.0'
     testImplementation 'org.json:json:20180813'
-    testImplementation 'androidx.test:runner:1.4.0'
-    testImplementation 'androidx.test:rules:1.4.0'
+    testImplementation 'androidx.test:runner:1.5.2'
+    testImplementation 'androidx.test:rules:1.5.0'
 }
 
 
@@ -233,7 +233,7 @@ tasks.withType(Test) {
     }
 }
 
-tasks.whenTaskAdded { task ->
+tasks.configureEach { task ->
     //Don't run lint. Takes too long.
     if (task.name.contains("lint")) {
         task.enabled = false
@@ -264,7 +264,7 @@ task buildTranslationArray {
 }
 preBuild.dependsOn buildTranslationArray
 
-tasks.whenTaskAdded { task ->
+tasks.configureEach { task ->
     if (task.name == 'preDebugBuild' || task.name == 'preReleaseBuild') {
         task.dependsOn buildTranslationArray
     }

gpslogger/src/main/AndroidManifest.xml

@@ -1,9 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
           xmlns:tools="http://schemas.android.com/tools"
-    android:installLocation="auto"
-    package="com.mendhak.gpslogger"
-    >
+    android:installLocation="auto">
 
     <!-- Satellite and network location services -->
     <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
@@ -31,6 +29,8 @@
     <!-- Beginning with Android 14 (API level 34), this is necessary. -->
     <uses-permission android:name="android.permission.FOREGROUND_SERVICE_LOCATION" />
 
+    <uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
+
 
     <application
         android:allowBackup="true"
@@ -39,6 +39,7 @@
         android:theme="@style/AppTheme"
         android:name="com.mendhak.gpslogger.common.AppSettings"
         android:usesCleartextTraffic="true"
+        android:enableOnBackInvokedCallback="true"
         android:requestLegacyExternalStorage="true"
         >
 

gpslogger/src/main/java/com/mendhak/gpslogger/GpsLoggingService.java

@@ -55,7 +55,6 @@
 @SuppressLint("MissingPermission")
 public class GpsLoggingService extends Service  {
     private static NotificationManager notificationManager;
-    private static int NOTIFICATION_ID = 8675309;
     private final IBinder binder = new GpsLoggingBinder();
     AlarmManager nextPointAlarmManager;
     private NotificationCompat.Builder nfc;
@@ -89,10 +88,10 @@ public IBinder onBind(Intent arg0) {
     public void onCreate() {
         try {
             if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
-                startForeground(NOTIFICATION_ID, getNotification(), ServiceInfo.FOREGROUND_SERVICE_TYPE_LOCATION);
+                startForeground(NotificationChannelNames.GPSLOGGER_DEFAULT_NOTIFICATION_ID, getNotification(), ServiceInfo.FOREGROUND_SERVICE_TYPE_LOCATION);
             }
             else {
-                startForeground(NOTIFICATION_ID, getNotification());
+                startForeground(NotificationChannelNames.GPSLOGGER_DEFAULT_NOTIFICATION_ID, getNotification());
             }
         } catch (Exception ex) {
             LOG.error("Could not start GPSLoggingService in foreground. ", ex);
@@ -126,18 +125,21 @@ public int onStartCommand(Intent intent, int flags, int startId) {
         super.onStartCommand(intent, flags, startId);
         try {
             if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
-                startForeground(NOTIFICATION_ID, getNotification(), ServiceInfo.FOREGROUND_SERVICE_TYPE_LOCATION);
+                startForeground(NotificationChannelNames.GPSLOGGER_DEFAULT_NOTIFICATION_ID, getNotification(), ServiceInfo.FOREGROUND_SERVICE_TYPE_LOCATION);
             }
             else {
-                startForeground(NOTIFICATION_ID, getNotification());
+                startForeground(NotificationChannelNames.GPSLOGGER_DEFAULT_NOTIFICATION_ID, getNotification());
             }
         } catch (Exception ex) {
             LOG.error("Could not start GPSLoggingService in foreground. ", ex);
         }
 
         if(session.isStarted() && gpsLocationListener == null && towerLocationListener == null && passiveLocationListener == null) {
-            LOG.warn("App might be recovering from an unexpected stop.  Starting logging again.");
-            startLogging();
+            if(Systems.hasUserGrantedAllNecessaryPermissions(this)){
+                LOG.warn("App might be recovering from an unexpected stop.  Starting logging again.");
+                startLogging();
+            }
+
         }
 
         handleIntent(intent);
@@ -179,8 +181,7 @@ private void handleIntent(Intent intent) {
 
                 if(!Systems.locationPermissionsGranted(this)){
                     LOG.error("User has not granted permission to access location services. Will not continue!");
-                    stopLogging();
-                    stopSelf();
+                    Systems.showErrorNotification(this, getString(R.string.gpslogger_permissions_permanently_denied));
                     return;
                 }
 
@@ -398,10 +399,10 @@ protected void startLogging() {
 
         try {
             if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
-                startForeground(NOTIFICATION_ID, getNotification(), ServiceInfo.FOREGROUND_SERVICE_TYPE_LOCATION);
+                startForeground(NotificationChannelNames.GPSLOGGER_DEFAULT_NOTIFICATION_ID, getNotification(), ServiceInfo.FOREGROUND_SERVICE_TYPE_LOCATION);
             }
             else {
-                startForeground(NOTIFICATION_ID, getNotification());
+                startForeground(NotificationChannelNames.GPSLOGGER_DEFAULT_NOTIFICATION_ID, getNotification());
             }
         } catch (Exception ex) {
             LOG.error("Could not start GPSLoggingService in foreground. ", ex);
@@ -420,7 +421,7 @@ protected void startLogging() {
     }
 
     private void notifyByBroadcast(boolean loggingStarted) {
-            LOG.debug("Sending a custom broadcast");
+            LOG.debug("Sending a started/stopped broadcast");
             String event = (loggingStarted) ? "started" : "stopped";
             Intent sendIntent = new Intent();
             sendIntent.setAction("com.mendhak.gpslogger.EVENT");
@@ -529,21 +530,7 @@ private Notification getNotification() {
 
         if (nfc == null) {
 
-            if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.O) {
-                NotificationManager manager = (NotificationManager) getSystemService(Context.NOTIFICATION_SERVICE);
-
-                NotificationChannel channel = new NotificationChannel("gpslogger", getString(R.string.app_name), NotificationManager.IMPORTANCE_DEFAULT);
-                channel.enableLights(false);
-                channel.enableVibration(false);
-                channel.setSound(null,null);
-                channel.setLockscreenVisibility(preferenceHelper.shouldHideNotificationFromLockScreen() ? Notification.VISIBILITY_PRIVATE : Notification.VISIBILITY_PUBLIC);
-
-                channel.setShowBadge(true);
-                manager.createNotificationChannel(channel);
-
-            }
-
-            nfc = new NotificationCompat.Builder(getApplicationContext(),"gpslogger")
+            nfc = new NotificationCompat.Builder(getApplicationContext(), NotificationChannelNames.GPSLOGGER_DEFAULT)
                     .setSmallIcon(R.drawable.notification)
                     .setLargeIcon(BitmapFactory.decodeResource(getResources(), R.mipmap.gpsloggericon3))
                     .setPriority( preferenceHelper.shouldHideNotificationFromStatusBar() ? NotificationCompat.PRIORITY_MIN : NotificationCompat.PRIORITY_LOW)
@@ -566,22 +553,20 @@ private Notification getNotification() {
             }
         }
 
-
-
         nfc.setContentTitle(contentTitle);
         nfc.setContentText(contentText);
         nfc.setStyle(new NotificationCompat.BigTextStyle().bigText(contentText).setBigContentTitle(contentTitle));
         nfc.setWhen(notificationTime);
 
         //notificationManager = (NotificationManager) getSystemService(NOTIFICATION_SERVICE);
-        //notificationManager.notify(NOTIFICATION_ID, nfc.build());
+        //notificationManager.notify(NotificationChannelNames.GPSLOGGER_DEFAULT_ID, nfc.build());
         return nfc.build();
     }
 
     private void showNotification(){
         Notification notif = getNotification();
         notificationManager = (NotificationManager) getSystemService(NOTIFICATION_SERVICE);
-        notificationManager.notify(NOTIFICATION_ID, notif);
+        notificationManager.notify(NotificationChannelNames.GPSLOGGER_DEFAULT_NOTIFICATION_ID, notif);
     }
 
     @SuppressWarnings("ResourceType")
@@ -1092,6 +1077,7 @@ private void writeToFile(Location loc) {
         }
         catch(Exception e){
              LOG.error(getString(R.string.could_not_write_to_file), e);
+             Systems.showErrorNotification(this, getString(R.string.could_not_write_to_file));
         }
 
         session.clearDescription();
@@ -1192,6 +1178,14 @@ public void onEvent(CommandEvents.LogOnce logOnce){
     }
 
 
+    @EventBusHook
+    public void onEvent(CommandEvents.FileWriteFailure writeFailure){
+        Systems.showErrorNotification(this, getString(R.string.could_not_write_to_file));
+        if(writeFailure.stopLoggingDueToNMEA){
+            LOG.error("Could not write to NMEA file, stopping logging due to high frequency of write failures");
+            stopLogging();
+        }
+    }
 
     @EventBusHook
     public void onEvent(ProfileEvents.SwitchToProfile switchToProfileEvent){