fix STICKY for foreground services

Author: mzakharo

pythonforandroid/bootstraps/common/build/src/main/java/org/kivy/android/PythonService.java

@@ -25,14 +25,14 @@ public class PythonService extends Service implements Runnable {
     private Thread pythonThread = null;
 
     // Python environment variables
-    protected String androidPrivate;
-    protected String androidArgument;
-    protected String pythonName;
-    protected String pythonHome;
-    protected String pythonPath;
-    protected String serviceEntrypoint;
+    private String androidPrivate;
+    private String androidArgument;
+    private String pythonName;
+    private String pythonHome;
+    private String pythonPath;
+    private String serviceEntrypoint;
     // Argument to pass to Python code,
-    protected String pythonServiceArgument;
+    private String pythonServiceArgument;
 
 
     public static PythonService mService = null;
@@ -60,36 +60,33 @@ public void onCreate() {
 
     @Override
     public int onStartCommand(Intent intent, int flags, int startId) {
-	startIntent = intent;
         if (pythonThread != null) {
             Log.v("python service", "service exists, do not start again");
             return startType();
         }
-        //when app is closed, OS will restart the service with null intent See #2401
-        if (intent != null) {
-
-            Bundle extras = intent.getExtras();
-            androidPrivate = extras.getString("androidPrivate");
-            androidArgument = extras.getString("androidArgument");
-            serviceEntrypoint = extras.getString("serviceEntrypoint");
-            pythonName = extras.getString("pythonName");
-            pythonHome = extras.getString("pythonHome");
-            pythonPath = extras.getString("pythonPath");
-            boolean serviceStartAsForeground = false;
-            String foreground = extras.getString("serviceStartAsForeground");
-            if (foreground != null) {
-                serviceStartAsForeground = foreground.equals("true");
-            }
-            pythonServiceArgument = extras.getString("pythonServiceArgument");
-            pythonThread = new Thread(this);
-            pythonThread.start();
+	//intent is null if OS restarts a STICKY service
+        if (intent == null) {
+            Context context = getApplicationContext();
+            intent = getThisDefaultIntent(context, "");
+        }
 
-            if (serviceStartAsForeground) {
-                doStartForeground(extras);
-            }
-        } else {
-            pythonThread = new Thread(this);
-            pythonThread.start();
+        startIntent = intent;
+        Bundle extras = intent.getExtras();
+        androidPrivate = extras.getString("androidPrivate");
+        androidArgument = extras.getString("androidArgument");
+        serviceEntrypoint = extras.getString("serviceEntrypoint");
+        pythonName = extras.getString("pythonName");
+        pythonHome = extras.getString("pythonHome");
+        pythonPath = extras.getString("pythonPath");
+        boolean serviceStartAsForeground = (
+            extras.getString("serviceStartAsForeground").equals("true")
+        );
+        pythonServiceArgument = extras.getString("pythonServiceArgument");
+        pythonThread = new Thread(this);
+        pythonThread.start();
+
+        if (serviceStartAsForeground) {
+            doStartForeground(extras);
         }
 
         return startType();
@@ -99,6 +96,10 @@ protected int getServiceId() {
         return 1;
     }
 
+    protected Intent getThisDefaultIntent(Context ctx, String pythonServiceArgument) {
+        return null;
+    }
+
     protected void doStartForeground(Bundle extras) {
         String serviceTitle = extras.getString("serviceTitle");
         String serviceDescription = extras.getString("serviceDescription");
@@ -161,7 +162,8 @@ public void onDestroy() {
     @Override
     public void onTaskRemoved(Intent rootIntent) {
         super.onTaskRemoved(rootIntent);
-        if (startType() == START_NOT_STICKY) {
+        //sticky servcie runtime/restart is managed by the OS. leave it running when app is closed
+        if (startType() != START_STICKY) {
             stopSelf();
         }
     }

pythonforandroid/bootstraps/common/build/templates/Service.tmpl.java

@@ -3,7 +3,6 @@
 import android.content.Intent;
 import android.content.Context;
 import org.kivy.android.PythonService;
-import java.io.File;
 
 
 public class Service{{ name|capitalize }} extends PythonService {
@@ -20,6 +19,11 @@ protected int getServiceId() {
     }
 
     static public void start(Context ctx, String pythonServiceArgument) {
+        Intent intent = getDefaultIntent(ctx, pythonServiceArgument);
+        ctx.startService(intent);
+    }
+
+    static public Intent getDefaultIntent(Context ctx, String pythonServiceArgument) {
         Intent intent = new Intent(ctx, Service{{ name|capitalize }}.class);
         String argument = ctx.getFilesDir().getAbsolutePath() + "/app";
         intent.putExtra("androidPrivate", ctx.getFilesDir().getAbsolutePath());
@@ -32,36 +36,12 @@ static public void start(Context ctx, String pythonServiceArgument) {
         intent.putExtra("pythonHome", argument);
         intent.putExtra("pythonPath", argument + ":" + argument + "/lib");
         intent.putExtra("pythonServiceArgument", pythonServiceArgument);
-        ctx.startService(intent);
+        return intent;
     }
 
     @Override
-    public void run(){
-        String package_root = getFilesDir().getAbsolutePath();
-        String app_root =  package_root + "/app";
-        File app_root_file = new File(app_root);
-        if (androidPrivate == null) {
-            androidPrivate = package_root;
-        }
-        if (androidArgument == null) {
-            androidArgument = app_root;
-        }
-        if (serviceEntrypoint == null) {
-            serviceEntrypoint ="{{ entrypoint }}";
-        }
-        if (pythonName == null) {
-            pythonName = "{{ name }}";
-        }
-        if (pythonHome == null) {
-            pythonHome = app_root;
-        }
-        if (pythonPath == null) {
-            pythonPath = package_root;
-        }
-        if (pythonServiceArgument == null) {
-            pythonServiceArgument = app_root+":"+app_root+"/lib";
-        }
-        super.run();
+    protected Intent getThisDefaultIntent(Context ctx, String pythonServiceArgument) {
+        return Service{{ name|capitalize }}.getDefaultIntent(ctx, pythonServiceArgument);
     }
 
     static public void stop(Context ctx) {