introduced CryptoOperationHelper

OpenKeychain/src/main/java/org/sufficientlysecure/keychain/service/ServiceProgressHandler.java

@@ -63,6 +63,8 @@ public class ServiceProgressHandler extends Handler {
     public static final String KEYBASE_PRESENCE_URL = "keybase_presence_url";
     public static final String KEYBASE_PRESENCE_LABEL = "keybase_presence_label";
 
+    public static final String TAG_PROGRESS_DIALOG = "progressDialog";
+
     FragmentActivity mActivity;
 
     public ServiceProgressHandler(FragmentActivity activity) {
@@ -87,7 +89,7 @@ public class ServiceProgressHandler extends Handler {
         Handler handler = new Handler();
         handler.post(new Runnable() {
             public void run() {
-                frag.show(manager, "progressDialog");
+                frag.show(manager, TAG_PROGRESS_DIALOG);
             }
         });
 

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

@@ -18,170 +18,65 @@
 
 package org.sufficientlysecure.keychain.ui.base;
 
-import android.app.Activity;
-import android.app.ProgressDialog;
 import android.content.Intent;
-import android.os.Bundle;
-import android.os.Message;
-import android.os.Messenger;
 import android.os.Parcelable;
 import android.support.v4.app.Fragment;
 
-import org.sufficientlysecure.keychain.R;
-import org.sufficientlysecure.keychain.operations.results.InputPendingResult;
 import org.sufficientlysecure.keychain.operations.results.OperationResult;
-import org.sufficientlysecure.keychain.service.KeychainNewService;
-import org.sufficientlysecure.keychain.service.KeychainService;
-import org.sufficientlysecure.keychain.service.ServiceProgressHandler;
 import org.sufficientlysecure.keychain.service.input.CryptoInputParcel;
-import org.sufficientlysecure.keychain.service.input.RequiredInputParcel;
-import org.sufficientlysecure.keychain.ui.NfcOperationActivity;
-import org.sufficientlysecure.keychain.ui.PassphraseDialogActivity;
-import org.sufficientlysecure.keychain.ui.dialog.ProgressDialogFragment;
 
 
 /**
  * All fragments executing crypto operations need to extend this class.
  */
-public abstract class CryptoOperationFragment <T extends Parcelable, S extends OperationResult>
+public abstract class CryptoOperationFragment<T extends Parcelable, S extends OperationResult>
         extends Fragment {
 
-    public static final int REQUEST_CODE_PASSPHRASE = 0x00008001;
+    private CryptoOperationHelper<T, S> mOperationHelper;
-    public static final int REQUEST_CODE_NFC = 0x00008002;
 
-    private void initiateInputActivity(RequiredInputParcel requiredInput) {
+    public CryptoOperationFragment() {
+        // this is implemented here instead of by the fragment so that the corresponding methods in
+        // CryptoOperationFragment may continue using the "protected" modifier.
+        CryptoOperationHelper.Callback callback = new CryptoOperationHelper.Callback<T, S>() {
 
-        switch (requiredInput.mType) {
+            @Override
-            case NFC_KEYTOCARD:
+            public T createOperationInput() {
-            case NFC_DECRYPT:
+                return CryptoOperationFragment.this.createOperationInput();
-            case NFC_SIGN: {
-                Intent intent = new Intent(getActivity(), NfcOperationActivity.class);
-                intent.putExtra(NfcOperationActivity.EXTRA_REQUIRED_INPUT, requiredInput);
-                startActivityForResult(intent, REQUEST_CODE_NFC);
-                return;
             }
 
-            case PASSPHRASE:
+            @Override
-            case PASSPHRASE_SYMMETRIC: {
+            public void onCryptoOperationSuccess(S result) {
-                Intent intent = new Intent(getActivity(), PassphraseDialogActivity.class);
+                CryptoOperationFragment.this.onCryptoOperationSuccess(result);
-                intent.putExtra(PassphraseDialogActivity.EXTRA_REQUIRED_INPUT, requiredInput);
-                startActivityForResult(intent, REQUEST_CODE_PASSPHRASE);
-                return;
-            }
             }
 
-        throw new RuntimeException("Unhandled pending result!");
+            @Override
+            public void onCryptoOperationCancelled() {
+                CryptoOperationFragment.this.onCryptoOperationCancelled();
+            }
+
+            @Override
+            public void onCryptoOperationError(S result) {
+                CryptoOperationFragment.this.onCryptoOperationError(result);
+            }
+        };
+
+        mOperationHelper = new CryptoOperationHelper<>(this, callback);
     }
 
     @Override
     public void onActivityResult(int requestCode, int resultCode, Intent data) {
-        if (resultCode == Activity.RESULT_CANCELED) {
+        mOperationHelper.handleActivityResult(requestCode, resultCode, data);
-            onCryptoOperationCancelled();
-            return;
-        }
-
-        switch (requestCode) {
-            case REQUEST_CODE_PASSPHRASE: {
-                if (resultCode == Activity.RESULT_OK && data != null) {
-                    CryptoInputParcel cryptoInput =
-                            data.getParcelableExtra(PassphraseDialogActivity.RESULT_CRYPTO_INPUT);
-                    cryptoOperation(cryptoInput);
-                    return;
-                }
-                break;
-            }
-
-            case REQUEST_CODE_NFC: {
-                if (resultCode == Activity.RESULT_OK && data != null) {
-                    CryptoInputParcel cryptoInput =
-                            data.getParcelableExtra(NfcOperationActivity.RESULT_DATA);
-                    cryptoOperation(cryptoInput);
-                    return;
-                }
-                break;
-            }
-
-            default: {
-                super.onActivityResult(requestCode, resultCode, data);
-            }
-        }
-    }
-
-    protected void dismissProgress() {
-
-        ProgressDialogFragment progressDialogFragment =
-                (ProgressDialogFragment) getFragmentManager().findFragmentByTag("progressDialog");
-
-        if (progressDialogFragment == null) {
-            return;
-        }
-
-        progressDialogFragment.dismissAllowingStateLoss();
-
     }
 
     protected abstract T createOperationInput();
 
-    protected void cryptoOperation(CryptoInputParcel cryptoInput) {
-
-        T operationInput = createOperationInput();
-        if (operationInput == null) {
-            return;
-        }
-
-        // Send all information needed to service to edit key in other thread
-        Intent intent = new Intent(getActivity(), KeychainNewService.class);
-
-        intent.putExtra(KeychainNewService.EXTRA_OPERATION_INPUT, operationInput);
-        intent.putExtra(KeychainNewService.EXTRA_CRYPTO_INPUT, cryptoInput);
-
-        ServiceProgressHandler saveHandler = new ServiceProgressHandler(getActivity()) {
-            @Override
-            public void handleMessage(Message message) {
-                // handle messages by standard KeychainIntentServiceHandler first
-                super.handleMessage(message);
-
-                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);
-                }
-            }
-        };
-
-        // Create a new Messenger for the communication back
-        Messenger messenger = new Messenger(saveHandler);
-        intent.putExtra(KeychainService.EXTRA_MESSENGER, messenger);
-
-        saveHandler.showProgressDialog(
-                getString(R.string.progress_building_key),
-                ProgressDialog.STYLE_HORIZONTAL, false);
-
-        getActivity().startService(intent);
-
-    }
-
     protected void cryptoOperation() {
         cryptoOperation(new CryptoInputParcel());
     }
 
-    protected void onCryptoOperationResult(S result) {
+    protected void cryptoOperation(CryptoInputParcel cryptoInput) {
-        if (result.success()) {
+        mOperationHelper.cryptoOperation(cryptoInput);
-            onCryptoOperationSuccess(result);
-        } else {
-            onCryptoOperationError(result);
     }
-    }
-
-    abstract protected void onCryptoOperationSuccess(S result);
 
     protected void onCryptoOperationError(S result) {
         result.createNotify(getActivity()).show();
@@ -190,28 +85,9 @@ public abstract class CryptoOperationFragment <T extends Parcelable, S extends O
     protected void onCryptoOperationCancelled() {
     }
 
-    public void onHandleResult(OperationResult result) {
+    abstract protected void onCryptoOperationSuccess(S result);
 
-        if (result instanceof InputPendingResult) {
+    protected void onCryptoOperationResult(S result) {
-            InputPendingResult pendingResult = (InputPendingResult) result;
+        mOperationHelper.onCryptoOperationResult(result);
-            if (pendingResult.isPending()) {
-                RequiredInputParcel requiredInput = pendingResult.getRequiredInputParcel();
-                initiateInputActivity(requiredInput);
-                return;
     }
-        }
-
-        dismissProgress();
-
-        try {
-            // noinspection unchecked, because type erasure :(
-            onCryptoOperationResult((S) result);
-        } catch (ClassCastException e) {
-            throw new AssertionError("bad return class ("
-                    + result.getClass().getSimpleName() + "), this is a programming error!");
-        }
-
-    }
-
-
 }

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

@@ -0,0 +1,291 @@
+/*
+ * Copyright (C) 2015 Dominik Schürmann <dominik@dominikschuermann.de>
+ * Copyright (C) 2015 Vincent Breitmoser <v.breitmoser@mugenguild.com>
+ * Copyright (C) 2015 Adithya Abraham Philip <adithyaphilip@gmail.com>
+ *
+ * This program 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.
+ *
+ * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package org.sufficientlysecure.keychain.ui.base;
+
+import android.app.Activity;
+import android.app.ProgressDialog;
+import android.content.Intent;
+import android.os.Bundle;
+import android.os.Message;
+import android.os.Messenger;
+import android.os.Parcelable;
+import android.support.v4.app.Fragment;
+import android.support.v4.app.FragmentActivity;
+
+import android.support.v4.app.FragmentManager;
+import org.sufficientlysecure.keychain.R;
+import org.sufficientlysecure.keychain.operations.results.InputPendingResult;
+import org.sufficientlysecure.keychain.operations.results.OperationResult;
+import org.sufficientlysecure.keychain.service.KeychainNewService;
+import org.sufficientlysecure.keychain.service.KeychainService;
+import org.sufficientlysecure.keychain.service.ServiceProgressHandler;
+import org.sufficientlysecure.keychain.service.input.CryptoInputParcel;
+import org.sufficientlysecure.keychain.service.input.RequiredInputParcel;
+import org.sufficientlysecure.keychain.ui.NfcOperationActivity;
+import org.sufficientlysecure.keychain.ui.PassphraseDialogActivity;
+import org.sufficientlysecure.keychain.ui.dialog.ProgressDialogFragment;
+import org.sufficientlysecure.keychain.util.Log;
+
+/**
+ * Designed to be integrated into activities or fragments used for CryptoOperations.
+ * Encapsulates the execution of a crypto operation and handling of input pending cases.s
+ *
+ * @param <T> The type of input parcel sent to the operation
+ * @param <S> The type of result returned by the operation
+ */
+public class CryptoOperationHelper<T extends Parcelable, S extends OperationResult> {
+
+    public interface Callback <T extends Parcelable, S extends  OperationResult> {
+        T createOperationInput();
+        void onCryptoOperationSuccess(S result);
+        void onCryptoOperationCancelled();
+        void onCryptoOperationError(S result);
+    }
+
+    public static final int REQUEST_CODE_PASSPHRASE = 0x00008001;
+    public static final int REQUEST_CODE_NFC = 0x00008002;
+
+    private int mProgressMessageString;
+
+    private FragmentActivity mActivity;
+    private Fragment mFragment;
+    private Callback<T, S> mCallback;
+
+    private boolean mUseFragment; // short hand for mActivity == null
+
+    /**
+     * If OperationHelper is being integrated into an activity
+     *
+     * @param activity
+     */
+    public CryptoOperationHelper(FragmentActivity activity, Callback<T, S> callback, int progressMessageString) {
+        mActivity = activity;
+        mUseFragment = false;
+        mCallback = callback;
+        mProgressMessageString = progressMessageString;
+    }
+
+    /**
+     * if OperationHelper is being integrated into a fragment
+     *
+     * @param fragment
+     */
+    public CryptoOperationHelper(Fragment fragment, Callback<T, S> callback, int progressMessageString) {
+        mFragment = fragment;
+        mUseFragment = true;
+        mProgressMessageString = progressMessageString;
+        mCallback = callback;
+    }
+
+    /**
+     * if OperationHelper is being integrated into a fragment with default message for the progress dialog
+     *
+     * @param fragment
+     */
+    public CryptoOperationHelper(Fragment fragment, Callback<T, S> callback) {
+        mFragment = fragment;
+        mUseFragment = true;
+        mProgressMessageString = R.string.progress_building_key;
+        mCallback = callback;
+    }
+
+    private void initiateInputActivity(RequiredInputParcel requiredInput) {
+
+        Activity activity = mUseFragment ? mFragment.getActivity() : mActivity;
+
+        Log.d("PHILIP", "Initating input " + requiredInput.mType);
+        switch (requiredInput.mType) {
+            case NFC_KEYTOCARD:
+            case NFC_DECRYPT:
+            case NFC_SIGN: {
+                Intent intent = new Intent(activity, NfcOperationActivity.class);
+                intent.putExtra(NfcOperationActivity.EXTRA_REQUIRED_INPUT, requiredInput);
+                if (mUseFragment) {
+                    mFragment.startActivityForResult(intent, REQUEST_CODE_NFC);
+                } else {
+                    mActivity.startActivityForResult(intent, REQUEST_CODE_NFC);
+                }
+                return;
+            }
+
+            case PASSPHRASE:
+            case PASSPHRASE_SYMMETRIC: {
+                Intent intent = new Intent(activity, PassphraseDialogActivity.class);
+                intent.putExtra(PassphraseDialogActivity.EXTRA_REQUIRED_INPUT, requiredInput);
+                if (mUseFragment) {
+                    mFragment.startActivityForResult(intent, REQUEST_CODE_PASSPHRASE);
+                } else {
+                    mActivity.startActivityForResult(intent, REQUEST_CODE_PASSPHRASE);
+                }
+                return;
+            }
+        }
+
+        throw new RuntimeException("Unhandled pending result!");
+    }
+
+    /**
+     * Attempts the result of an activity started by this helper. Returns true if requestCode is recognized,
+     * false otherwise.
+     *
+     * @param requestCode
+     * @param resultCode
+     * @param data
+     * @return true if requestCode was recognized, false otherwise
+     */
+    public boolean handleActivityResult(int requestCode, int resultCode, Intent data) {
+        Log.d("PHILIP", "received activity result in OperationHelper");
+        if (resultCode == Activity.RESULT_CANCELED) {
+            mCallback.onCryptoOperationCancelled();
+            return true;
+        }
+
+        switch (requestCode) {
+            case REQUEST_CODE_PASSPHRASE: {
+                if (resultCode == Activity.RESULT_OK && data != null) {
+                    CryptoInputParcel cryptoInput =
+                            data.getParcelableExtra(PassphraseDialogActivity.RESULT_CRYPTO_INPUT);
+                    cryptoOperation(cryptoInput);
+                    return true;
+                }
+                break;
+            }
+
+            case REQUEST_CODE_NFC: {
+                if (resultCode == Activity.RESULT_OK && data != null) {
+                    CryptoInputParcel cryptoInput =
+                            data.getParcelableExtra(NfcOperationActivity.RESULT_DATA);
+                    cryptoOperation(cryptoInput);
+                    return true;
+                }
+                break;
+            }
+
+            default: {
+                return false;
+            }
+        }
+        return true;
+    }
+
+    protected void dismissProgress() {
+        FragmentManager fragmentManager =
+                mUseFragment ? mFragment.getFragmentManager() : mActivity.getSupportFragmentManager();
+
+        ProgressDialogFragment progressDialogFragment =
+                (ProgressDialogFragment) fragmentManager.findFragmentByTag(ServiceProgressHandler.TAG_PROGRESS_DIALOG);
+
+        if (progressDialogFragment == null) {
+            return;
+        }
+
+        progressDialogFragment.dismissAllowingStateLoss();
+
+    }
+
+    public void cryptoOperation(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, KeychainNewService.class);
+
+        intent.putExtra(KeychainNewService.EXTRA_OPERATION_INPUT, operationInput);
+        intent.putExtra(KeychainNewService.EXTRA_CRYPTO_INPUT, cryptoInput);
+
+        ServiceProgressHandler saveHandler = new ServiceProgressHandler(activity) {
+            @Override
+            public void handleMessage(Message message) {
+                // handle messages by standard KeychainIntentServiceHandler first
+                super.handleMessage(message);
+
+                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);
+                }
+            }
+        };
+
+        saveHandler.showProgressDialog(
+                activity.getString(mProgressMessageString),
+                ProgressDialog.STYLE_HORIZONTAL, false);
+
+        // Create a new Messenger for the communication back
+        Messenger messenger = new Messenger(saveHandler);
+        intent.putExtra(KeychainService.EXTRA_MESSENGER, messenger);
+
+        activity.startService(intent);
+
+    }
+
+    public void cryptoOperation() {
+        cryptoOperation(new CryptoInputParcel());
+    }
+
+    protected void onCryptoOperationResult(S result) {
+        Log.d("PHILIP", "cryptoResult " + result.success());
+        if (result.success()) {
+            mCallback.onCryptoOperationSuccess(result);
+        } else {
+            mCallback.onCryptoOperationError(result);
+        }
+    }
+
+    public void onHandleResult(OperationResult result) {
+        Log.d("PHILIP", "Handling result in OperationHelper");
+
+        if (result instanceof InputPendingResult) {
+            Log.d("PHILIP", "is pending result");
+            InputPendingResult pendingResult = (InputPendingResult) result;
+            if (pendingResult.isPending()) {
+
+                Log.d("PHILIP", "Is pending");
+                RequiredInputParcel requiredInput = pendingResult.getRequiredInputParcel();
+                initiateInputActivity(requiredInput);
+                return;
+            }
+        }
+
+        dismissProgress();
+
+        try {
+            // noinspection unchecked, because type erasure :(
+            onCryptoOperationResult((S) result);
+        } catch (ClassCastException e) {
+            throw new AssertionError("bad return class ("
+                    + result.getClass().getSimpleName() + "), this is a programming error!");
+        }
+
+    }
+}