package eu.faircode.email; /* This file is part of FairEmail. FairEmail is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. FairEmail is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with FairEmail. If not, see . Copyright 2018-2021 by Marcel Bokhorst (M66B) */ import android.content.Context; import android.content.Intent; import android.content.SharedPreferences; import android.os.Bundle; import android.os.PowerManager; import androidx.annotation.NonNull; import androidx.appcompat.app.AppCompatActivity; import androidx.fragment.app.Fragment; import androidx.lifecycle.Lifecycle; import androidx.lifecycle.LifecycleObserver; import androidx.lifecycle.LifecycleOwner; import androidx.lifecycle.LifecycleService; import androidx.lifecycle.OnLifecycleEvent; import androidx.localbroadcastmanager.content.LocalBroadcastManager; import androidx.preference.PreferenceManager; import java.util.ArrayList; import java.util.Date; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.concurrent.ExecutorService; import java.util.concurrent.Future; // This simple task is simple to use, but it is also simple to cause bugs that can easily lead to crashes // Make sure to not access any member in any outer scope from onExecute // Results will not be delivered to destroyed fragments public abstract class SimpleTask implements LifecycleObserver { private boolean log = true; private boolean count = true; private boolean interruptable = true; private String name; private long started; private boolean reported; private boolean interrupted; private Lifecycle.State state; private Future future; private ExecutorService localExecutor; private static PowerManager.WakeLock wl = null; private static ExecutorService globalExecutor = null; private static final List tasks = new ArrayList<>(); private static final int MAX_WAKELOCK = 30 * 60 * 1000; // milliseconds private static final int REPORT_AFTER = 5 * 60 * 1000; // milliseconds private static final int CANCEL_AFTER = MAX_WAKELOCK; // milliseconds static final String ACTION_TASK_COUNT = BuildConfig.APPLICATION_ID + ".ACTION_TASK_COUNT"; public SimpleTask setLog(boolean log) { this.log = log; if (!log) this.count = false; return this; } public SimpleTask setCount(boolean count) { this.count = count; return this; } public SimpleTask setInterruptable(boolean interruptable) { this.interruptable = interruptable; return this; } public SimpleTask setExecutor(ExecutorService executor) { this.localExecutor = executor; return this; } private ExecutorService getExecutor(Context context) { if (wl == null) { PowerManager pm = (PowerManager) context.getSystemService(Context.POWER_SERVICE); wl = pm.newWakeLock(PowerManager.PARTIAL_WAKE_LOCK, BuildConfig.APPLICATION_ID + ":task"); } if (localExecutor != null) return localExecutor; if (globalExecutor == null) { SharedPreferences prefs = PreferenceManager.getDefaultSharedPreferences(context); int threads = prefs.getInt("query_threads", Runtime.getRuntime().availableProcessors()); Log.i("Task threads=" + threads); globalExecutor = Helper.getBackgroundExecutor(threads, "task"); } return globalExecutor; } public void execute(Context context, LifecycleOwner owner, @NonNull Bundle args, @NonNull String name) { run(context, owner, args, name); } public void execute(LifecycleService service, @NonNull Bundle args, @NonNull String name) { run(service, service, args, name); } public void execute(AppCompatActivity activity, @NonNull Bundle args, @NonNull String name) { run(activity, activity, args, name); } public void execute(final Fragment fragment, @NonNull Bundle args, @NonNull String name) { try { if (fragment.getView() != null || fragment instanceof FragmentDialogBase) run(fragment.getContext(), fragment.getViewLifecycleOwner(), args, name); } catch (IllegalStateException ex) { Log.e(ex); } } private void run(final Context context, final LifecycleOwner owner, final Bundle args, final String name) { this.name = name; this.started = new Date().getTime(); if (owner instanceof TwoStateOwner) Log.e(new Throwable("SimpleTask/TwoStateOwner")); // prevent garbage collection synchronized (tasks) { tasks.add(this); } try { onPreExecute(args); } catch (Throwable ex) { Log.e(ex); try { onException(args, ex); } catch (Throwable exex) { Log.e(exex); } } future = getExecutor(context).submit(new Runnable() { private Object data; private long elapsed; private Throwable ex; @Override public void run() { // Run in background thread try { wl.acquire(MAX_WAKELOCK); if (log) Log.i("Executing task=" + name); long start = new Date().getTime(); data = onExecute(context, args); elapsed = new Date().getTime() - start; if (log) Log.i("Executed task=" + name + " elapsed=" + elapsed + " ms"); } catch (Throwable ex) { if (!(ex instanceof IllegalArgumentException)) Log.e(ex); this.ex = ex; } finally { wl.release(); } // Run on UI thread ApplicationEx.getMainHandler().post(new Runnable() { @Override public void run() { state = owner.getLifecycle().getCurrentState(); if (state.equals(Lifecycle.State.DESTROYED)) { // No delivery cleanup(context); } else if (state.isAtLeast(Lifecycle.State.RESUMED)) { // Inline delivery Log.i("Deliver task " + name + " state=" + state + " elapse=" + elapsed + " ms"); deliver(); cleanup(context); } else { Log.i("Deferring task " + name + " state=" + state); owner.getLifecycle().addObserver(new LifecycleObserver() { @OnLifecycleEvent(Lifecycle.Event.ON_ANY) public void onAny() { state = owner.getLifecycle().getCurrentState(); if (state.equals(Lifecycle.State.DESTROYED)) { Log.i("Destroyed task " + name); owner.getLifecycle().removeObserver(this); cleanup(context); } else if (state.isAtLeast(Lifecycle.State.RESUMED)) { Log.i("Deferred delivery task " + name); owner.getLifecycle().removeObserver(this); deliver(); cleanup(context); } else Log.i("Deferring task " + name + " state=" + state); } }); } } private void deliver() { try { onPostExecute(args); } catch (Throwable ex) { Log.e(ex); try { onException(args, ex); } catch (Throwable exex) { Log.e(exex); } } finally { try { if (ex == null) { if (log && BuildConfig.BETA_RELEASE) { Log.i("Crumb " + name); Map crumb = new HashMap<>(); crumb.put("name", name); Log.breadcrumb("task", crumb); } onExecuted(args, (T) data); } else try { onException(args, ex); } catch (Throwable exex) { Log.e(exex); } } catch (Throwable ex) { Log.e(ex); try { onException(args, ex); } catch (Throwable exex) { Log.e(exex); } } } } }); } }); updateTaskCount(context); } void cancel(Context context) { if (future != null) if (future.cancel(false)) { Log.i("Cancelled task=" + name); cleanup(context); } } private void cleanup(Context context) { started = 0; reported = false; interrupted = false; future = null; synchronized (tasks) { tasks.remove(this); } updateTaskCount(context); } private void updateTaskCount(Context context) { // Check tasks long now = new Date().getTime(); synchronized (tasks) { for (SimpleTask task : tasks) if (task.future != null && !task.future.isDone()) { long elapsed = now - task.started; if (elapsed > CANCEL_AFTER && !task.interrupted) { task.interrupted = true; if (task.interruptable && task.future != null && !task.future.isDone()) { Log.e("Interrupting task " + task + " tasks=" + getCountLocked() + "/" + tasks.size()); task.future.cancel(true); } } else if (elapsed > REPORT_AFTER && !task.reported) { task.reported = true; Log.e("Long running task " + task + " tasks=" + getCountLocked() + "/" + tasks.size()); } } } int executing = getCount(); Log.i("Remaining tasks=" + executing + "/" + tasks.size()); LocalBroadcastManager lbm = LocalBroadcastManager.getInstance(context); lbm.sendBroadcast(new Intent(ACTION_TASK_COUNT).putExtra("count", executing)); } protected void onPreExecute(Bundle args) { } protected abstract T onExecute(Context context, Bundle args) throws Throwable; protected void onExecuted(Bundle args, T data) { } protected abstract void onException(Bundle args, Throwable ex); protected void onPostExecute(Bundle args) { } @Override public String toString() { long now = new Date().getTime(); long elapsed = now - started; return name + " elapsed=" + (started == 0 ? null : elapsed / 1000) + " done=" + (future == null ? null : future.isDone()) + " cancelled=" + (future == null ? null : future.isCancelled() + " state=" + state); } static int getCount() { synchronized (tasks) { return getCountLocked(); } } private static int getCountLocked() { int executing = 0; for (SimpleTask task : tasks) if (task.count && task.future != null && !task.future.isDone()) executing++; return executing; } static List getList() { synchronized (tasks) { return new ArrayList<>(tasks); } } }