diff --git a/AndroidManifest.xml b/AndroidManifest.xml index 30032cbd8b..e8fe0ed5dd 100644 --- a/AndroidManifest.xml +++ b/AndroidManifest.xml @@ -683,7 +683,7 @@ @@ -701,13 +701,6 @@ - - - - - WorkManager + * API instead. */ public abstract class Job { diff --git a/src/org/thoughtcrime/securesms/jobmanager/JobManager.java b/src/org/thoughtcrime/securesms/jobmanager/JobManager.java index 636faa04fb..dce43d6aff 100644 --- a/src/org/thoughtcrime/securesms/jobmanager/JobManager.java +++ b/src/org/thoughtcrime/securesms/jobmanager/JobManager.java @@ -7,7 +7,6 @@ import androidx.annotation.NonNull; import org.thoughtcrime.securesms.jobmanager.impl.DefaultExecutorFactory; import org.thoughtcrime.securesms.jobmanager.impl.JsonDataSerializer; -import org.thoughtcrime.securesms.jobmanager.migration.WorkManagerMigrator; import org.thoughtcrime.securesms.jobmanager.persistence.JobStorage; import org.thoughtcrime.securesms.logging.Log; import org.thoughtcrime.securesms.util.Debouncer; @@ -52,11 +51,6 @@ public class JobManager implements ConstraintObserver.Notifier { this::onEmptyQueue); executor.execute(() -> { - if (WorkManagerMigrator.needsMigration(application)) { - Log.i(TAG, "Detected an old WorkManager database. Migrating."); - WorkManagerMigrator.migrate(application, configuration.getJobStorage(), configuration.getDataSerializer()); - } - jobController.init(); for (int i = 0; i < jobRunners.length; i++) { diff --git a/src/org/thoughtcrime/securesms/jobmanager/migration/WorkManagerDatabase.java b/src/org/thoughtcrime/securesms/jobmanager/migration/WorkManagerDatabase.java deleted file mode 100644 index 81226fc976..0000000000 --- a/src/org/thoughtcrime/securesms/jobmanager/migration/WorkManagerDatabase.java +++ /dev/null @@ -1,101 +0,0 @@ -package org.thoughtcrime.securesms.jobmanager.migration; - -import android.content.Context; -import android.database.Cursor; -import android.database.sqlite.SQLiteDatabase; -import android.database.sqlite.SQLiteOpenHelper; -import androidx.annotation.NonNull; -import androidx.annotation.Nullable; - -import org.thoughtcrime.securesms.jobmanager.Data; -import org.thoughtcrime.securesms.jobmanager.Job; -import org.thoughtcrime.securesms.jobmanager.impl.NetworkConstraint; -import org.thoughtcrime.securesms.jobmanager.persistence.ConstraintSpec; -import org.thoughtcrime.securesms.jobmanager.persistence.FullSpec; -import org.thoughtcrime.securesms.jobmanager.persistence.JobSpec; -import org.thoughtcrime.securesms.logging.Log; - -import java.util.Collections; -import java.util.LinkedList; -import java.util.List; -import java.util.concurrent.TimeUnit; - -final class WorkManagerDatabase extends SQLiteOpenHelper { - - private static final String TAG = WorkManagerDatabase.class.getSimpleName(); - - static final String DB_NAME = "androidx.work.workdb"; - - WorkManagerDatabase(@NonNull Context context) { - super(context, DB_NAME, null, 5); - } - - @Override - public void onCreate(SQLiteDatabase db) { - throw new UnsupportedOperationException("We should never be creating this database, only migrating an existing one!"); - } - - @Override - public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) { - // There's a chance that a user who hasn't upgraded in > 6 months could hit this onUpgrade path, - // but we don't use any of the columns that were added in any migrations they could hit, so we - // can ignore this. - Log.w(TAG, "Hit onUpgrade path from " + oldVersion + " to " + newVersion); - } - - @NonNull List getAllJobs(@NonNull Data.Serializer dataSerializer) { - SQLiteDatabase db = getReadableDatabase(); - String[] columns = new String[] { "id", "worker_class_name", "input", "required_network_type"}; - List fullSpecs = new LinkedList<>(); - - try (Cursor cursor = db.query("WorkSpec", columns, null, null, null, null, null)) { - while (cursor != null && cursor.moveToNext()) { - String factoryName = WorkManagerFactoryMappings.getFactoryKey(cursor.getString(cursor.getColumnIndexOrThrow("worker_class_name"))); - - if (factoryName != null) { - String id = cursor.getString(cursor.getColumnIndexOrThrow("id")); - byte[] data = cursor.getBlob(cursor.getColumnIndexOrThrow("input")); - - List constraints = new LinkedList<>(); - JobSpec jobSpec = new JobSpec(id, - factoryName, - getQueueKey(id), - System.currentTimeMillis(), - 0, - 0, - Job.Parameters.UNLIMITED, - TimeUnit.SECONDS.toMillis(30), - TimeUnit.DAYS.toMillis(1), - Job.Parameters.UNLIMITED, - dataSerializer.serialize(DataMigrator.convert(data)), - false); - - - - if (cursor.getInt(cursor.getColumnIndexOrThrow("required_network_type")) != 0) { - constraints.add(new ConstraintSpec(id, NetworkConstraint.KEY)); - } - - fullSpecs.add(new FullSpec(jobSpec, constraints, Collections.emptyList())); - } else { - Log.w(TAG, "Failed to find a matching factory for worker class: " + factoryName); - } - } - } - - return fullSpecs; - } - - private @Nullable String getQueueKey(@NonNull String jobId) { - String query = "work_spec_id = ?"; - String[] args = new String[] { jobId }; - - try (Cursor cursor = getReadableDatabase().query("WorkName", null, query, args, null, null, null)) { - if (cursor != null && cursor.moveToFirst()) { - return cursor.getString(cursor.getColumnIndexOrThrow("name")); - } - } - - return null; - } -} diff --git a/src/org/thoughtcrime/securesms/jobmanager/migration/WorkManagerFactoryMappings.java b/src/org/thoughtcrime/securesms/jobmanager/migration/WorkManagerFactoryMappings.java index 9b1ec1f890..0ef55f60fc 100644 --- a/src/org/thoughtcrime/securesms/jobmanager/migration/WorkManagerFactoryMappings.java +++ b/src/org/thoughtcrime/securesms/jobmanager/migration/WorkManagerFactoryMappings.java @@ -44,7 +44,6 @@ import org.thoughtcrime.securesms.jobs.SmsSentJob; import org.thoughtcrime.securesms.jobs.TrimThreadJob; import org.thoughtcrime.securesms.jobs.TypingSendJob; import org.thoughtcrime.securesms.jobs.UpdateApkJob; -import org.thoughtcrime.securesms.loki.api.BackgroundPollJob; import org.thoughtcrime.securesms.loki.api.PrepareAttachmentAudioExtrasJob; import org.thoughtcrime.securesms.loki.protocol.ClosedGroupUpdateMessageSendJob; import org.thoughtcrime.securesms.loki.protocol.NullMessageSendJob; @@ -60,7 +59,6 @@ public class WorkManagerFactoryMappings { put(AttachmentDownloadJob.class.getName(), AttachmentDownloadJob.KEY); put(AttachmentUploadJob.class.getName(), AttachmentUploadJob.KEY); put(AvatarDownloadJob.class.getName(), AvatarDownloadJob.KEY); - put(BackgroundPollJob.class.getName(), BackgroundPollJob.KEY); put(CleanPreKeysJob.class.getName(), CleanPreKeysJob.KEY); put(ClosedGroupUpdateMessageSendJob.class.getName(), ClosedGroupUpdateMessageSendJob.KEY); put(CreateSignedPreKeyJob.class.getName(), CreateSignedPreKeyJob.KEY); diff --git a/src/org/thoughtcrime/securesms/jobmanager/migration/WorkManagerMigrator.java b/src/org/thoughtcrime/securesms/jobmanager/migration/WorkManagerMigrator.java deleted file mode 100644 index ae7df8eb9a..0000000000 --- a/src/org/thoughtcrime/securesms/jobmanager/migration/WorkManagerMigrator.java +++ /dev/null @@ -1,45 +0,0 @@ -package org.thoughtcrime.securesms.jobmanager.migration; - -import android.annotation.SuppressLint; -import android.content.Context; -import androidx.annotation.NonNull; -import androidx.annotation.WorkerThread; - -import org.thoughtcrime.securesms.jobmanager.Data; -import org.thoughtcrime.securesms.jobmanager.persistence.FullSpec; -import org.thoughtcrime.securesms.jobmanager.persistence.JobStorage; -import org.thoughtcrime.securesms.logging.Log; - -import java.util.List; - -public class WorkManagerMigrator { - - private static final String TAG = Log.tag(WorkManagerMigrator.class); - - @SuppressLint("DefaultLocale") - @WorkerThread - public static synchronized void migrate(@NonNull Context context, - @NonNull JobStorage jobStorage, - @NonNull Data.Serializer dataSerializer) - { - long startTime = System.currentTimeMillis(); - Log.i(TAG, "Beginning WorkManager migration."); - - WorkManagerDatabase database = new WorkManagerDatabase(context); - List fullSpecs = database.getAllJobs(dataSerializer); - - for (FullSpec fullSpec : fullSpecs) { - Log.i(TAG, String.format("Migrating job with key '%s' and %d constraint(s).", fullSpec.getJobSpec().getFactoryKey(), fullSpec.getConstraintSpecs().size())); - } - - jobStorage.insertJobs(fullSpecs); - - context.deleteDatabase(WorkManagerDatabase.DB_NAME); - Log.i(TAG, String.format("WorkManager migration finished. Migrated %d job(s) in %d ms.", fullSpecs.size(), System.currentTimeMillis() - startTime)); - } - - @WorkerThread - public static synchronized boolean needsMigration(@NonNull Context context) { - return context.getDatabasePath(WorkManagerDatabase.DB_NAME).exists(); - } -} diff --git a/src/org/thoughtcrime/securesms/jobs/BaseJob.java b/src/org/thoughtcrime/securesms/jobs/BaseJob.java index 73053b0479..7e8852cd55 100644 --- a/src/org/thoughtcrime/securesms/jobs/BaseJob.java +++ b/src/org/thoughtcrime/securesms/jobs/BaseJob.java @@ -6,6 +6,11 @@ import org.thoughtcrime.securesms.jobmanager.Job; import org.thoughtcrime.securesms.jobmanager.JobLogger; import org.thoughtcrime.securesms.logging.Log; +/** + * @deprecated + * use WorkManager + * API instead. + */ public abstract class BaseJob extends Job { private static final String TAG = BaseJob.class.getSimpleName(); diff --git a/src/org/thoughtcrime/securesms/jobs/JobManagerFactories.java b/src/org/thoughtcrime/securesms/jobs/JobManagerFactories.java index 8a89f0bcb6..82dbf831f7 100644 --- a/src/org/thoughtcrime/securesms/jobs/JobManagerFactories.java +++ b/src/org/thoughtcrime/securesms/jobs/JobManagerFactories.java @@ -14,7 +14,6 @@ import org.thoughtcrime.securesms.jobmanager.impl.NetworkConstraintObserver; import org.thoughtcrime.securesms.jobmanager.impl.NetworkOrCellServiceConstraint; import org.thoughtcrime.securesms.jobmanager.impl.SqlCipherMigrationConstraint; import org.thoughtcrime.securesms.jobmanager.impl.SqlCipherMigrationConstraintObserver; -import org.thoughtcrime.securesms.loki.api.BackgroundPollJob; import org.thoughtcrime.securesms.loki.api.PrepareAttachmentAudioExtrasJob; import org.thoughtcrime.securesms.loki.protocol.ClosedGroupUpdateMessageSendJob; import org.thoughtcrime.securesms.loki.protocol.NullMessageSendJob; @@ -33,7 +32,6 @@ public final class JobManagerFactories { put(AttachmentDownloadJob.KEY, new AttachmentDownloadJob.Factory()); put(AttachmentUploadJob.KEY, new AttachmentUploadJob.Factory()); put(AvatarDownloadJob.KEY, new AvatarDownloadJob.Factory()); - put(BackgroundPollJob.KEY, new BackgroundPollJob.Factory()); put(CleanPreKeysJob.KEY, new CleanPreKeysJob.Factory()); put(ClosedGroupUpdateMessageSendJob.KEY, new ClosedGroupUpdateMessageSendJob.Factory()); put(CreateSignedPreKeyJob.KEY, new CreateSignedPreKeyJob.Factory()); diff --git a/src/org/thoughtcrime/securesms/loki/api/BackgroundPollJob.kt b/src/org/thoughtcrime/securesms/loki/api/BackgroundPollJob.kt deleted file mode 100644 index 7081cefe46..0000000000 --- a/src/org/thoughtcrime/securesms/loki/api/BackgroundPollJob.kt +++ /dev/null @@ -1,87 +0,0 @@ -package org.thoughtcrime.securesms.loki.api - -import android.content.Context -import kotlinx.coroutines.awaitAll -import nl.komponents.kovenant.Promise -import nl.komponents.kovenant.all -import nl.komponents.kovenant.functional.map -import org.thoughtcrime.securesms.ApplicationContext -import org.thoughtcrime.securesms.database.DatabaseFactory -import org.thoughtcrime.securesms.dependencies.InjectableType -import org.thoughtcrime.securesms.jobmanager.Data -import org.thoughtcrime.securesms.jobmanager.Job -import org.thoughtcrime.securesms.jobmanager.impl.NetworkConstraint -import org.thoughtcrime.securesms.jobs.BaseJob -import org.thoughtcrime.securesms.jobs.PushContentReceiveJob -import org.thoughtcrime.securesms.jobs.RotateCertificateJob -import org.thoughtcrime.securesms.logging.Log -import org.thoughtcrime.securesms.util.TextSecurePreferences -import org.whispersystems.signalservice.api.SignalServiceAccountManager -import org.whispersystems.signalservice.api.messages.SignalServiceEnvelope -import org.whispersystems.signalservice.api.push.exceptions.PushNetworkException -import org.whispersystems.signalservice.loki.api.SnodeAPI -import java.io.IOException -import java.util.concurrent.TimeUnit -import javax.inject.Inject - -class BackgroundPollJob private constructor(parameters: Parameters) : BaseJob(parameters) { - - companion object { - const val KEY = "BackgroundPollJob" - } - - constructor(context: Context) : this(Parameters.Builder() - .addConstraint(NetworkConstraint.KEY) - .setQueue(KEY) - .setLifespan(TimeUnit.DAYS.toMillis(1)) - .setMaxAttempts(Parameters.UNLIMITED) - .build()) { - setContext(context) - } - - override fun serialize(): Data { - return Data.EMPTY - } - - override fun getFactoryKey(): String { return KEY } - - public override fun onRun() { - try { - Log.d("Loki", "Performing background poll.") - val userPublicKey = TextSecurePreferences.getLocalNumber(context) - val promises = mutableListOf>() - if (!TextSecurePreferences.isUsingFCM(context)) { - Log.d("Loki", "Not using FCM; polling for contacts and closed groups.") - val promise = SnodeAPI.shared.getMessages(userPublicKey).map { envelopes -> - envelopes.forEach { - PushContentReceiveJob(context).processEnvelope(SignalServiceEnvelope(it), false) - } - } - promises.add(promise) - promises.addAll(ClosedGroupPoller.shared.pollOnce()) - } - val openGroups = DatabaseFactory.getLokiThreadDatabase(context).getAllPublicChats().map { it.value } - for (openGroup in openGroups) { - val poller = PublicChatPoller(context, openGroup) - poller.stop() - promises.add(poller.pollForNewMessages()) - } - all(promises).get() - } catch (exception: Exception) { - Log.d("Loki", "Background poll failed due to error: $exception.") - } - } - - public override fun onShouldRetry(e: Exception): Boolean { - return false - } - - override fun onCanceled() { } - - class Factory : Job.Factory { - - override fun create(parameters: Parameters, data: Data): BackgroundPollJob { - return BackgroundPollJob(parameters) - } - } -} diff --git a/src/org/thoughtcrime/securesms/loki/api/BackgroundPollListener.kt b/src/org/thoughtcrime/securesms/loki/api/BackgroundPollListener.kt deleted file mode 100644 index da17528b4f..0000000000 --- a/src/org/thoughtcrime/securesms/loki/api/BackgroundPollListener.kt +++ /dev/null @@ -1,36 +0,0 @@ -package org.thoughtcrime.securesms.loki.api - -import android.content.Context -import android.content.Intent -import nl.komponents.kovenant.functional.map -import org.thoughtcrime.securesms.ApplicationContext -import org.thoughtcrime.securesms.database.DatabaseFactory -import org.thoughtcrime.securesms.jobs.PushContentReceiveJob -import org.thoughtcrime.securesms.service.PersistentAlarmManagerListener -import org.thoughtcrime.securesms.util.TextSecurePreferences -import org.whispersystems.signalservice.api.messages.SignalServiceEnvelope -import org.whispersystems.signalservice.loki.api.SnodeAPI -import java.util.concurrent.TimeUnit - -class BackgroundPollListener : PersistentAlarmManagerListener() { - - companion object { - private val pollInterval = TimeUnit.MINUTES.toMillis(15) - - @JvmStatic - fun schedule(context: Context) { - BackgroundPollListener().onReceive(context, Intent()) - } - } - - override fun getNextScheduledExecutionTime(context: Context): Long { - return TextSecurePreferences.getBackgroundPollTime(context) - } - - override fun onAlarm(context: Context, scheduledTime: Long): Long { - ApplicationContext.getInstance(context).jobManager.add(BackgroundPollJob(context)) - val nextTime = System.currentTimeMillis() + pollInterval - TextSecurePreferences.setBackgroundPollTime(context, nextTime) - return nextTime - } -} diff --git a/src/org/thoughtcrime/securesms/loki/api/BackgroundPollWorker.kt b/src/org/thoughtcrime/securesms/loki/api/BackgroundPollWorker.kt new file mode 100644 index 0000000000..66ce90905d --- /dev/null +++ b/src/org/thoughtcrime/securesms/loki/api/BackgroundPollWorker.kt @@ -0,0 +1,113 @@ +package org.thoughtcrime.securesms.loki.api + +import android.content.BroadcastReceiver +import android.content.Context +import android.content.Intent +import androidx.work.* +import nl.komponents.kovenant.Promise +import nl.komponents.kovenant.all +import nl.komponents.kovenant.functional.map +import org.thoughtcrime.securesms.database.DatabaseFactory +import org.thoughtcrime.securesms.jobs.PushContentReceiveJob +import org.thoughtcrime.securesms.logging.Log +import org.thoughtcrime.securesms.util.TextSecurePreferences +import org.whispersystems.signalservice.api.messages.SignalServiceEnvelope +import org.whispersystems.signalservice.loki.api.SnodeAPI +import java.util.concurrent.TimeUnit + +class BackgroundPollWorker(val context: Context, params: WorkerParameters) : Worker(context, params) { + + companion object { + const val TAG = "BackgroundPollWorker" + + private const val RETRY_ATTEMPTS = 3 + + @JvmStatic + fun scheduleInstant(context: Context) { + val workRequest = OneTimeWorkRequestBuilder() + .setConstraints( + Constraints.Builder() + .setRequiredNetworkType(NetworkType.CONNECTED) + .build() + ) + .build() + + WorkManager + .getInstance(context) + .enqueue(workRequest) + } + + @JvmStatic + fun schedulePeriodic(context: Context) { + Log.v(TAG, "Scheduling periodic work.") + val workRequest = PeriodicWorkRequestBuilder(15, TimeUnit.MINUTES) + .setConstraints( + Constraints.Builder() + .setRequiredNetworkType(NetworkType.CONNECTED) + .build() + ) + .build() + + WorkManager + .getInstance(context) + .enqueueUniquePeriodicWork( + TAG, + ExistingPeriodicWorkPolicy.KEEP, + workRequest + ) + } + } + + override fun doWork(): Result { + if (TextSecurePreferences.getLocalNumber(context) == null) { + Log.v(TAG, "Background poll is canceled due to the Session user is not set up yet.") + return Result.failure() + } + + try { + Log.v(TAG, "Performing background poll.") + val promises = mutableListOf>() + + // Private chats + val userPublicKey = TextSecurePreferences.getLocalNumber(context) + val privateChatsPromise = SnodeAPI.shared.getMessages(userPublicKey).map { envelopes -> + envelopes.forEach { + PushContentReceiveJob(context).processEnvelope(SignalServiceEnvelope(it), false) + } + } + promises.add(privateChatsPromise) + + // Closed groups + val sskDatabase = DatabaseFactory.getSSKDatabase(context) + ClosedGroupPoller.configureIfNeeded(context, sskDatabase) + promises.addAll(ClosedGroupPoller.shared.pollOnce()) + + // Open Groups + val openGroups = DatabaseFactory.getLokiThreadDatabase(context).getAllPublicChats().map { it.value } + for (openGroup in openGroups) { + val poller = PublicChatPoller(context, openGroup) + promises.add(poller.pollForNewMessages()) + } + + // Wait till all the promises get resolved + all(promises).get() + + return Result.success() + } catch (exception: Exception) { + Log.v(TAG, "Background poll failed due to error: ${exception.message}.", exception) + + return if (runAttemptCount < RETRY_ATTEMPTS) Result.retry() else Result.failure() + } + } + + class BootBroadcastReceiver: BroadcastReceiver() { + + override fun onReceive(context: Context, intent: Intent) { + if (intent.action == Intent.ACTION_BOOT_COMPLETED) { + Log.v(TAG, "Boot broadcast caught.") + BackgroundPollWorker.scheduleInstant(context) + BackgroundPollWorker.schedulePeriodic(context) + } + } + } +} diff --git a/src/org/thoughtcrime/securesms/loki/api/ClosedGroupPoller.kt b/src/org/thoughtcrime/securesms/loki/api/ClosedGroupPoller.kt index 77b973f57b..4f1a1d1930 100644 --- a/src/org/thoughtcrime/securesms/loki/api/ClosedGroupPoller.kt +++ b/src/org/thoughtcrime/securesms/loki/api/ClosedGroupPoller.kt @@ -17,7 +17,7 @@ import org.whispersystems.signalservice.loki.utilities.getRandomElementOrNull class ClosedGroupPoller private constructor(private val context: Context, private val database: SharedSenderKeysDatabase) { private var isPolling = false - private val handler = Handler() + private val handler: Handler by lazy { Handler() } private val task = object : Runnable { diff --git a/src/org/thoughtcrime/securesms/loki/api/PublicChatPoller.kt b/src/org/thoughtcrime/securesms/loki/api/PublicChatPoller.kt index ca73a77b3e..2d682f07d8 100644 --- a/src/org/thoughtcrime/securesms/loki/api/PublicChatPoller.kt +++ b/src/org/thoughtcrime/securesms/loki/api/PublicChatPoller.kt @@ -3,6 +3,7 @@ package org.thoughtcrime.securesms.loki.api import android.content.Context import android.os.Handler import android.util.Log +import androidx.annotation.WorkerThread import nl.komponents.kovenant.Promise import nl.komponents.kovenant.functional.bind import nl.komponents.kovenant.functional.map @@ -30,9 +31,10 @@ import org.whispersystems.signalservice.loki.api.opengroups.PublicChatMessage import org.whispersystems.signalservice.loki.protocol.shelved.multidevice.MultiDeviceProtocol import java.security.MessageDigest import java.util.* +import java.util.concurrent.CompletableFuture class PublicChatPoller(private val context: Context, private val group: PublicChat) { - private val handler = Handler() + private val handler by lazy { Handler() } private var hasStarted = false private var isPollOngoing = false public var isCaughtUp = false