cthrace/open-keychain
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #2382 from open-keychain/keychain-service-threadpool

Browse Source 
use AsyncTask for background task execution
This commit is contained in:
Vincent Breitmoser
2018-07-17 15:52:20 +02:00
committed by GitHub
parent f0f01eef55 ebf7512a9d
commit f664b1b57b
25 changed files with 415 additions and 639 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
OpenKeychain/src/main/java/org/sufficientlysecure/keychain/ui/base/CryptoOperationFragment.java
View File

@@ -29,7 +29,6 @@ import android.view.inputmethod.InputMethodManager;
import org.sufficientlysecure.keychain.R;
import org.sufficientlysecure.keychain.operations.results.OperationResult;
import org.sufficientlysecure.keychain.service.KeychainService;
import org.sufficientlysecure.keychain.service.input.CryptoInputParcel;
/** This is a base class for fragments which implement a cryptoOperation.
@@ -47,8 +46,6 @@ import org.sufficientlysecure.keychain.service.input.CryptoInputParcel;
* must override at least onCryptoOperationSuccess to proceed after a
* successful operation.
*
* @see KeychainService
*
*/
public abstract class CryptoOperationFragment<T extends Parcelable, S extends OperationResult>
extends Fragment implements CryptoOperationHelper.Callback<T, S> {

132
OpenKeychain/src/main/java/org/sufficientlysecure/keychain/ui/base/CryptoOperationHelper.java
View File

@@ -17,32 +17,31 @@
package org.sufficientlysecure.keychain.ui.base;
import java.util.Date;
import android.app.Activity;
import android.app.ProgressDialog;
import android.content.Intent;
import android.os.Bundle;
import android.os.Handler;
import android.os.Message;
import android.os.Messenger;
import android.os.Parcelable;
import android.os.SystemClock;
import android.support.annotation.UiThread;
import android.support.v4.app.Fragment;
import android.support.v4.app.FragmentActivity;
import android.support.v4.app.FragmentManager;
import android.support.v4.os.CancellationSignal;
import org.sufficientlysecure.keychain.operations.results.InputPendingResult;
import org.sufficientlysecure.keychain.operations.results.OperationResult;
import org.sufficientlysecure.keychain.service.KeychainService;
import org.sufficientlysecure.keychain.service.ServiceProgressHandler;
import org.sufficientlysecure.keychain.service.KeychainServiceTask;
import org.sufficientlysecure.keychain.service.KeychainServiceTask.OperationCallback;
import org.sufficientlysecure.keychain.service.ProgressDialogManager;
import org.sufficientlysecure.keychain.service.input.CryptoInputParcel;
import org.sufficientlysecure.keychain.service.input.RequiredInputParcel;
import org.sufficientlysecure.keychain.ui.SecurityTokenOperationActivity;
import org.sufficientlysecure.keychain.ui.OrbotRequiredDialogActivity;
import org.sufficientlysecure.keychain.ui.PassphraseDialogActivity;
import org.sufficientlysecure.keychain.ui.RetryUploadDialogActivity;
import org.sufficientlysecure.keychain.ui.dialog.ProgressDialogFragment;
import org.sufficientlysecure.keychain.ui.SecurityTokenOperationActivity;
import timber.log.Timber;
@@ -91,12 +90,12 @@ public class CryptoOperationHelper<T extends Parcelable, S extends OperationResu
// summands are stored in the mHelperId for easy operation.
private final int mHelperId;
// bitmask for helperId is everything except the least 8 bits
public static final int HELPER_ID_BITMASK = ~0xff;
private static final int HELPER_ID_BITMASK = ~0xff;
public static final int REQUEST_CODE_PASSPHRASE = 1;
public static final int REQUEST_CODE_NFC = 2;
public static final int REQUEST_CODE_ENABLE_ORBOT = 3;
public static final int REQUEST_CODE_RETRY_UPLOAD = 4;
private static final int REQUEST_CODE_PASSPHRASE = 1;
private static final int REQUEST_CODE_NFC = 2;
private static final int REQUEST_CODE_ENABLE_ORBOT = 3;
private static final int REQUEST_CODE_RETRY_UPLOAD = 4;
private Integer mProgressMessageResource;
private boolean mCancellable = false;
@@ -264,84 +263,60 @@ public class CryptoOperationHelper<T extends Parcelable, S extends OperationResu
return true;
}
protected void dismissProgress() {
FragmentManager fragmentManager =
mUseFragment ? mFragment.getFragmentManager() :
mActivity.getSupportFragmentManager();
if (fragmentManager == null) { // the fragment holding us has died
// fragmentManager was null when used with DialogFragments. (they close on click?)
return;
}
ProgressDialogFragment progressDialogFragment =
(ProgressDialogFragment) fragmentManager.findFragmentByTag(
ServiceProgressHandler.TAG_PROGRESS_DIALOG);
if (progressDialogFragment == null) {
return;
}
progressDialogFragment.dismissAllowingStateLoss();
}
public void cryptoOperation(final CryptoInputParcel cryptoInput) {
FragmentActivity activity = mUseFragment ? mFragment.getActivity() : mActivity;
T operationInput = mCallback.createOperationInput();
if (operationInput == null) {
return;
}
// Send all information needed to service to edit key in other thread
Intent intent = new Intent(activity, KeychainService.class);
FragmentActivity activity = mUseFragment ? mFragment.getActivity() : mActivity;
if (activity == null) {
throw new NullPointerException();
}
intent.putExtra(KeychainService.EXTRA_OPERATION_INPUT, operationInput);
intent.putExtra(KeychainService.EXTRA_CRYPTO_INPUT, cryptoInput);
ProgressDialogManager progressDialogManager;
if (mProgressMessageResource != null) {
progressDialogManager = new ProgressDialogManager(activity);
} else {
progressDialogManager = null;
}
ServiceProgressHandler saveHandler = new ServiceProgressHandler(activity) {
KeychainServiceTask keychainServiceTask = KeychainServiceTask.create(activity);
OperationCallback operationCallback = new OperationCallback() {
@Override
public void handleMessage(Message message) {
// handle messages by standard KeychainIntentServiceHandler first
super.handleMessage(message);
public void operationFinished(OperationResult result) {
if (progressDialogManager != null) {
progressDialogManager.dismissAllowingStateLoss();
}
onHandleResult(result);
}
if (message.arg1 == MessageStatus.OKAY.ordinal()) {
// get returned data bundle
Bundle returnData = message.getData();
if (returnData == null) {
return;
}
final OperationResult result =
returnData.getParcelable(OperationResult.EXTRA_RESULT);
onHandleResult(result);
@Override
public void setProgress(Integer resourceId, int current, int total) {
String msgString = resourceId != null ? activity.getString(resourceId) : null;
if (mCallback.onCryptoSetProgress(msgString, current, total)) {
return;
}
if (progressDialogManager != null) {
progressDialogManager.onSetProgress(resourceId, current, total);
}
}
@Override
protected void onSetProgress(String msg, int progress, int max) {
// allow handling of progress in fragment, or delegate upwards
if (!mCallback.onCryptoSetProgress(msg, progress, max)) {
super.onSetProgress(msg, progress, max);
public void setPreventCancel() {
if (progressDialogManager != null) {
progressDialogManager.setPreventCancel();
}
}
};
// Create a new Messenger for the communication back
Messenger messenger = new Messenger(saveHandler);
intent.putExtra(KeychainService.EXTRA_MESSENGER, messenger);
CancellationSignal cancellationSignal =
keychainServiceTask.startOperationInBackground(operationInput, cryptoInput, operationCallback);
if (mProgressMessageResource != null) {
saveHandler.showProgressDialog(
activity.getString(mProgressMessageResource),
ProgressDialog.STYLE_HORIZONTAL, mCancellable);
if (progressDialogManager != null) {
progressDialogManager.showProgressDialog(activity.getString(mProgressMessageResource),
ProgressDialog.STYLE_HORIZONTAL, mCancellable ? cancellationSignal : null);
}
activity.startService(intent);
}
public void cryptoOperation() {
@@ -349,8 +324,9 @@ public class CryptoOperationHelper<T extends Parcelable, S extends OperationResu
cryptoOperation(CryptoInputParcel.createCryptoInputParcel(new Date()));
}
private void onHandleResult(final OperationResult result) {
Timber.d("Handling result in OperationHelper success: " + result.success());
@UiThread
private void onHandleResult(OperationResult result) {
Timber.d("Handling result in OperationHelper success: %s", result.success());
if (result instanceof InputPendingResult) {
InputPendingResult pendingResult = (InputPendingResult) result;
@@ -361,20 +337,14 @@ public class CryptoOperationHelper<T extends Parcelable, S extends OperationResu
}
}
dismissProgress();
long elapsedTime = SystemClock.elapsedRealtime() - operationStartTime;
if (minimumOperationDelay == null || elapsedTime > minimumOperationDelay) {
returnResultToCallback(result);
return;
}
new Handler().postDelayed(new Runnable() {
@Override
public void run() {
returnResultToCallback(result);
}
}, minimumOperationDelay - elapsedTime);
long artificialDelay = minimumOperationDelay - elapsedTime;
new Handler().postDelayed(() -> returnResultToCallback(result), artificialDelay);
}
private void returnResultToCallback(OperationResult result) {

38
OpenKeychain/src/main/java/org/sufficientlysecure/keychain/ui/dialog/ProgressDialogFragment.java
View File

@@ -17,16 +17,17 @@
package org.sufficientlysecure.keychain.ui.dialog;
import android.app.Activity;
import android.app.Dialog;
import android.app.ProgressDialog;
import android.content.DialogInterface;
import android.content.DialogInterface.OnKeyListener;
import android.content.Intent;
import android.graphics.Color;
import android.os.Bundle;
import android.support.annotation.NonNull;
import android.support.v4.app.DialogFragment;
import android.support.v4.os.CancellationSignal;
import android.view.ContextThemeWrapper;
import android.view.KeyEvent;
import android.view.View;
@@ -34,7 +35,6 @@ import android.view.View.OnClickListener;
import android.widget.Button;
import org.sufficientlysecure.keychain.R;
import org.sufficientlysecure.keychain.service.KeychainService;
import org.sufficientlysecure.keychain.ui.util.ThemeChanger;
/**
@@ -44,15 +44,18 @@ public class ProgressDialogFragment extends DialogFragment {
private static final String ARG_MESSAGE = "message";
private static final String ARG_STYLE = "style";
private static final String ARG_CANCELABLE = "cancelable";
private static final String ARG_SERVICE_TYPE = "service_class";
boolean mCanCancel = false, mPreventCancel = false, mIsCancelled = false;
private CancellationSignal cancellationSignal;
/**
* creates a new instance of this fragment
* @param message the message to be displayed initially above the progress bar
* @param style the progress bar style, as defined in ProgressDialog (horizontal or spinner)
* @param cancelable should we let the user cancel this operation
*
* @param message
* the message to be displayed initially above the progress bar
* @param style
* the progress bar style, as defined in ProgressDialog (horizontal or spinner)
*
* @return
*/
public static ProgressDialogFragment newInstance(String message, int style, boolean cancelable) {
@@ -141,20 +144,24 @@ public class ProgressDialogFragment extends DialogFragment {
return dialog;
}
public void setPreventCancel(boolean preventCancel) {
public void setPreventCancel() {
// Don't care if we can't cancel anymore either way!
if (mIsCancelled || ! mCanCancel) {
return;
}
mPreventCancel = preventCancel;
mPreventCancel = true;
ProgressDialog dialog = (ProgressDialog) getDialog();
if (dialog == null) {
return;
}
final Button negative = dialog.getButton(DialogInterface.BUTTON_NEGATIVE);
negative.setEnabled(mIsCancelled && !preventCancel);
negative.setEnabled(false);
}
public void setCancellationSignal(CancellationSignal cancellationSignal) {
this.cancellationSignal = cancellationSignal;
}
@Override
@@ -167,7 +174,7 @@ public class ProgressDialogFragment extends DialogFragment {
@Override
public void onClick(View v) {
// nvm if we are already cancelled, or weren't able to begin with
if (mIsCancelled || ! mCanCancel) {
if (mIsCancelled || !mCanCancel || cancellationSignal == null) {
return;
}
@@ -176,13 +183,7 @@ public class ProgressDialogFragment extends DialogFragment {
negative.setClickable(false);
negative.setTextColor(Color.GRAY);
// send a cancel message. note that this message will be handled by
// KeychainService.onStartCommand, which runs in this thread,
// not the service one, and will not queue up a command.
Intent serviceIntent = new Intent(getActivity(), KeychainService.class);
serviceIntent.setAction(KeychainService.ACTION_CANCEL);
getActivity().startService(serviceIntent);
cancellationSignal.cancel();
// Set the progress bar accordingly
ProgressDialog dialog = (ProgressDialog) getDialog();
@@ -192,11 +193,8 @@ public class ProgressDialogFragment extends DialogFragment {
dialog.setIndeterminate(true);
dialog.setMessage(getString(R.string.progress_cancelling));
}
});
}
}