shifted multi-threading to own service

added multi-threaded cloud import, restored KeychainIntentService

eliminated code duplication in multi-threaded import

1 files changed, 35 insertions, 218 deletions

diff --git a/OpenKeychain/src/main/java/org/sufficientlysecure/keychain/service/KeychainIntentService.java b/OpenKeychain/src/main/java/org/sufficientlysecure/keychain/service/KeychainIntentService.java
index 0cac8fb32..5ecfb29f5 100644
--- a/OpenKeychain/src/main/java/org/sufficientlysecure/keychain/service/KeychainIntentService.java
+++ b/OpenKeychain/src/main/java/org/sufficientlysecure/keychain/service/KeychainIntentService.java
@@ -21,11 +21,11 @@ package org.sufficientlysecure.keychain.service;
 import android.app.IntentService;
 import android.content.Intent;
 import android.net.Uri;
-
 import android.os.Bundle;
 import android.os.Message;
 import android.os.Messenger;
 import android.os.RemoteException;
+
 import com.textuality.keybase.lib.Proof;
 import com.textuality.keybase.lib.prover.Prover;
 
@@ -60,7 +60,7 @@ import org.sufficientlysecure.keychain.pgp.SignEncryptParcel;
 import org.sufficientlysecure.keychain.pgp.exception.PgpGeneralException;
 import org.sufficientlysecure.keychain.pgp.exception.PgpGeneralMsgIdException;
 import org.sufficientlysecure.keychain.provider.ProviderHelper;
-import org.sufficientlysecure.keychain.service.KeychainIntentServiceHandler.MessageStatus;
+import org.sufficientlysecure.keychain.service.ServiceProgressHandler.MessageStatus;
 import org.sufficientlysecure.keychain.util.FileHelper;
 import org.sufficientlysecure.keychain.util.InputData;
 import org.sufficientlysecure.keychain.util.Log;
@@ -74,9 +74,7 @@ import java.io.IOException;
 import java.io.InputStream;
 import java.io.OutputStream;
 import java.util.ArrayList;
-import java.util.Iterator;
 import java.util.List;
-import java.util.concurrent.*;
 import java.util.concurrent.atomic.AtomicBoolean;
 
 import de.measite.minidns.Client;
@@ -203,127 +201,7 @@ public class KeychainIntentService extends IntentService implements Progressable
     Messenger mMessenger;
 
     // this attribute can possibly merged with the one above? not sure...
-    private static AtomicBoolean sActionCanceled = new AtomicBoolean(false);
-
-    /**
-     * accumulates the results from a multi-threaded key import from a keyserver and
-     * consolidates them into a single ImportKeyResult, besides keeping count of keys imported and
-     * total keys to be imported. Also provides the Progressable used by these threads, which
-     * currently ignores updates
-     */
-    private class KeyImportAccumulator {
-        private OperationLog mImportLog = new OperationLog();
-        private int mTotalKeys;
-        private int mImportedKeys = 0;
-        private Progressable mImportProgressable;
-        ArrayList<Long> mImportedMasterKeyIds = new ArrayList<Long>();
-        private int mBadKeys = 0;
-        private int mNewKeys = 0;
-        private int mUpdatedKeys = 0;
-        private int mSecret = 0;
-        private int mResultType = 0;
-
-        public KeyImportAccumulator(int totalKeys) {
-            mTotalKeys = totalKeys;
-            //ignore updates from ImportExportOperation for now
-            mImportProgressable = new Progressable() {
-                @Override
-                public void setProgress(String message, int current, int total) {
-
-                }
-
-                @Override
-                public void setProgress(int resourceId, int current, int total) {
-
-                }
-
-                @Override
-                public void setProgress(int current, int total) {
-
-                }
-
-                @Override
-                public void setPreventCancel() {
-
-                }
-            };
-        }
-
-        public Progressable getImportProgressable() {
-            return mImportProgressable;
-        }
-
-        public int getTotalKeys() {
-            return mTotalKeys;
-        }
-
-        public int getImportedKeys() {
-            return mImportedKeys;
-        }
-
-        public synchronized void accumulateKeyImport(ImportKeyResult result) {
-            mImportedKeys++;
-            mImportLog.addAll(result.getLog().toList());//accumulates log
-            mBadKeys += result.mBadKeys;
-            mNewKeys += result.mNewKeys;
-            mUpdatedKeys += result.mUpdatedKeys;
-            mSecret += result.mSecret;
-
-            long[] masterKeyIds = result.getImportedMasterKeyIds();
-            for (int i = 0; i < masterKeyIds.length; i++) {
-                mImportedMasterKeyIds.add(masterKeyIds[i]);
-            }
-
-            // if any key import has been cancelled, set result type to cancelled
-            // resultType is added to in getConsolidatedKayImport to account for remaining factors
-            mResultType |= result.getResult() & ImportKeyResult.RESULT_CANCELLED;
-
-        }
-
-        /**
-         * returns accumulated result of all imports so far
-         *
-         * @return
-         */
-        public ImportKeyResult getConsolidatedImportKeyResult() {
-
-            // adding required information to mResultType
-            // special case,no keys requested for import
-            if (mBadKeys == 0 && mNewKeys == 0 && mUpdatedKeys == 0) {
-                mResultType = ImportKeyResult.RESULT_FAIL_NOTHING;
-            } else {
-                if (mNewKeys > 0) {
-                    mResultType |= ImportKeyResult.RESULT_OK_NEWKEYS;
-                }
-                if (mUpdatedKeys > 0) {
-                    mResultType |= ImportKeyResult.RESULT_OK_UPDATED;
-                }
-                if (mBadKeys > 0) {
-                    mResultType |= ImportKeyResult.RESULT_WITH_ERRORS;
-                    if (mNewKeys == 0 && mUpdatedKeys == 0) {
-                        mResultType |= ImportKeyResult.RESULT_ERROR;
-                    }
-                }
-                if (mImportLog.containsWarnings()) {
-                    mResultType |= ImportKeyResult.RESULT_WARNINGS;
-                }
-            }
-
-            long masterKeyIds[] = new long[mImportedMasterKeyIds.size()];
-            for (int i = 0; i < masterKeyIds.length; i++) {
-                masterKeyIds[i] = mImportedMasterKeyIds.get(i);
-            }
-
-            return new ImportKeyResult(mResultType, mImportLog, mNewKeys, mUpdatedKeys, mBadKeys,
-                    mSecret, masterKeyIds);
-        }
-
-        public boolean isImportFinished() {
-            return mTotalKeys == mImportedKeys;
-        }
-    }
-
-    private KeyImportAccumulator mKeyImportAccumulator;
+    private AtomicBoolean mActionCanceled = new AtomicBoolean(false);
 
     public KeychainIntentService() {
         super("KeychainIntentService");
@@ -338,7 +216,7 @@ public class KeychainIntentService extends IntentService implements Progressable
     protected void onHandleIntent(Intent intent) {
 
         // We have not been cancelled! (yet)
-        sActionCanceled.set(false);
+        mActionCanceled.set(false);
 
         Bundle extras = intent.getExtras();
         if (extras == null) {
@@ -364,7 +242,7 @@ public class KeychainIntentService extends IntentService implements Progressable
 
         Log.logDebugBundle(data, "EXTRA_DATA");
 
-        final ProviderHelper providerHelper = new ProviderHelper(this);
+        ProviderHelper providerHelper = new ProviderHelper(this);
 
         String action = intent.getAction();
 
@@ -377,7 +255,7 @@ public class KeychainIntentService extends IntentService implements Progressable
                 String keyServerUri = data.getString(UPLOAD_KEY_SERVER);
 
                 // Operation
-                CertifyOperation op = new CertifyOperation(this, providerHelper, this, sActionCanceled);
+                CertifyOperation op = new CertifyOperation(this, providerHelper, this, mActionCanceled);
                 CertifyResult result = op.certify(parcel, keyServerUri);
 
                 // Result
@@ -517,12 +395,12 @@ public class KeychainIntentService extends IntentService implements Progressable
                     }
 
                     Bundle resultData = new Bundle();
-                    resultData.putString(KeychainIntentServiceHandler.DATA_MESSAGE, "OK");
+                    resultData.putString(ServiceProgressHandler.DATA_MESSAGE, "OK");
 
                     // these help the handler construct a useful human-readable message
-                    resultData.putString(KeychainIntentServiceHandler.KEYBASE_PROOF_URL, prover.getProofUrl());
-                    resultData.putString(KeychainIntentServiceHandler.KEYBASE_PRESENCE_URL, prover.getPresenceUrl());
-                    resultData.putString(KeychainIntentServiceHandler.KEYBASE_PRESENCE_LABEL, prover.getPresenceLabel());
+                    resultData.putString(ServiceProgressHandler.KEYBASE_PROOF_URL, prover.getProofUrl());
+                    resultData.putString(ServiceProgressHandler.KEYBASE_PRESENCE_URL, prover.getPresenceUrl());
+                    resultData.putString(ServiceProgressHandler.KEYBASE_PRESENCE_LABEL, prover.getPresenceLabel());
                     sendMessageToHandler(MessageStatus.OKAY, resultData);
                 } catch (Exception e) {
                     sendErrorToHandler(e);
@@ -595,7 +473,7 @@ public class KeychainIntentService extends IntentService implements Progressable
                 Passphrase passphrase = data.getParcelable(EDIT_KEYRING_PASSPHRASE);
 
                 // Operation
-                EditKeyOperation op = new EditKeyOperation(this, providerHelper, this, sActionCanceled);
+                EditKeyOperation op = new EditKeyOperation(this, providerHelper, this, mActionCanceled);
                 EditKeyResult result = op.execute(saveParcel, passphrase);
 
                 // Result
@@ -609,7 +487,7 @@ public class KeychainIntentService extends IntentService implements Progressable
                 long keyRingId = data.getInt(EXPORT_KEY_RING_MASTER_KEY_ID);
 
                 // Operation
-                PromoteKeyOperation op = new PromoteKeyOperation(this, providerHelper, this, sActionCanceled);
+                PromoteKeyOperation op = new PromoteKeyOperation(this, providerHelper, this, mActionCanceled);
                 PromoteKeyResult result = op.execute(keyRingId);
 
                 // Result
@@ -642,68 +520,26 @@ public class KeychainIntentService extends IntentService implements Progressable
                 break;
             }
             case ACTION_IMPORT_KEYRING: {
+
                 // Input
-                final String keyServer = data.getString(IMPORT_KEY_SERVER);
+                String keyServer = data.getString(IMPORT_KEY_SERVER);
                 ArrayList<ParcelableKeyRing> list = data.getParcelableArrayList(IMPORT_KEY_LIST);
                 ParcelableFileCache<ParcelableKeyRing> cache =
                         new ParcelableFileCache<>(this, "key_import.pcl");
-                int totKeys = 0;
-                Iterator<ParcelableKeyRing> keyListIterator = null;
-                //either list or cache must be null, no guarantees otherwise
-                if (list == null) {//export from cache, copied from ImportExportOperation.importKeyRings
-
-                    try {
-                        ParcelableFileCache.IteratorWithSize<ParcelableKeyRing> it = cache.readCache();
-                        keyListIterator = it;
-                        totKeys = it.getSize();
-                    } catch (IOException e) {
-
-                        // Special treatment here, we need a lot
-                        OperationLog log = new OperationLog();
-                        log.add(OperationResult.LogType.MSG_IMPORT, 0, 0);
-                        log.add(OperationResult.LogType.MSG_IMPORT_ERROR_IO, 0, 0);
-
-                        keyImportFailed(new ImportKeyResult(ImportKeyResult.RESULT_ERROR, log));
-                    }
-                } else {
-                    keyListIterator = list.iterator();
-                    totKeys = list.size();
-                }
 
+                // Operation
+                ImportExportOperation importExportOperation = new ImportExportOperation(
+                        this, providerHelper, this, mActionCanceled);
+                // Either list or cache must be null, no guarantees otherwise.
+                ImportKeyResult result = list != null
+                        ? importExportOperation.importKeyRings(list, keyServer)
+                        : importExportOperation.importKeyRings(cache, keyServer);
 
-                if (keyListIterator != null) {
-                    mKeyImportAccumulator = new KeyImportAccumulator(totKeys);
-                    setProgress(0, totKeys);
-
-                    final int maxThreads = 200;
-                    ExecutorService importExecutor = new ThreadPoolExecutor(0, maxThreads,
-                            30L, TimeUnit.SECONDS,
-                            new SynchronousQueue<Runnable>());
-
-                    while (keyListIterator.hasNext()) {
-                        final ParcelableKeyRing pkRing = keyListIterator.next();
-                        Runnable importOperationRunnable = new Runnable() {
-                            @Override
-                            public void run() {
-                                // Operation
-                                ImportExportOperation importExportOperation = new ImportExportOperation(
-                                        KeychainIntentService.this,
-                                        new ProviderHelper(KeychainIntentService.this),
-                                        mKeyImportAccumulator.getImportProgressable(),
-                                        sActionCanceled);
-
-                                ArrayList<ParcelableKeyRing> list = new ArrayList<>();
-                                list.add(pkRing);
-                                ImportKeyResult result = importExportOperation.importKeyRings(list,
-                                        keyServer);
-                                singleKeyRingImportCompleted(result);
-                            }
-                        };
-                        importExecutor.execute(importOperationRunnable);
-                    }
-                }
+                // Result
+                sendMessageToHandler(MessageStatus.OKAY, result);
 
                 break;
+
             }
             case ACTION_SIGN_ENCRYPT: {
 
@@ -712,7 +548,7 @@ public class KeychainIntentService extends IntentService implements Progressable
 
                 // Operation
                 SignEncryptOperation op = new SignEncryptOperation(
-                        this, new ProviderHelper(this), this, sActionCanceled);
+                        this, new ProviderHelper(this), this, mActionCanceled);
                 SignEncryptResult result = op.execute(inputParcel);
 
                 // Result
@@ -748,23 +584,6 @@ public class KeychainIntentService extends IntentService implements Progressable
         }
     }
 
-    private synchronized void singleKeyRingImportCompleted(ImportKeyResult result) {
-        mKeyImportAccumulator.accumulateKeyImport(result);
-
-        setProgress(mKeyImportAccumulator.getImportedKeys(), mKeyImportAccumulator.getTotalKeys());
-
-        if (mKeyImportAccumulator.isImportFinished()) {
-            ContactSyncAdapterService.requestSync();
-
-            sendMessageToHandler(MessageStatus.OKAY,
-                    mKeyImportAccumulator.getConsolidatedImportKeyResult());
-        }
-    }
-
-    private void keyImportFailed(ImportKeyResult result) {
-        sendMessageToHandler(MessageStatus.OKAY, result);
-    }
-
     private void sendProofError(List<String> log, String label) {
         String msg = null;
         label = (label == null) ? "" : label + ": ";
@@ -777,7 +596,7 @@ public class KeychainIntentService extends IntentService implements Progressable
 
     private void sendProofError(String msg) {
         Bundle bundle = new Bundle();
-        bundle.putString(KeychainIntentServiceHandler.DATA_ERROR, msg);
+        bundle.putString(ServiceProgressHandler.DATA_ERROR, msg);
         sendMessageToHandler(MessageStatus.OKAY, bundle);
     }
 
@@ -794,7 +613,7 @@ public class KeychainIntentService extends IntentService implements Progressable
         Log.d(Constants.TAG, "KeychainIntentService Exception: ", e);
 
         Bundle data = new Bundle();
-        data.putString(KeychainIntentServiceHandler.DATA_ERROR, message);
+        data.putString(ServiceProgressHandler.DATA_ERROR, message);
         sendMessageToHandler(MessageStatus.EXCEPTION, null, data);
     }
 
@@ -836,30 +655,30 @@ public class KeychainIntentService extends IntentService implements Progressable
     /**
      * Set progress of ProgressDialog by sending message to handler on UI thread
      */
-    public synchronized void setProgress(String message, int progress, int max) {
+    public void setProgress(String message, int progress, int max) {
         Log.d(Constants.TAG, "Send message by setProgress with progress=" + progress + ", max="
                 + max);
 
         Bundle data = new Bundle();
         if (message != null) {
-            data.putString(KeychainIntentServiceHandler.DATA_MESSAGE, message);
+            data.putString(ServiceProgressHandler.DATA_MESSAGE, message);
         }
-        data.putInt(KeychainIntentServiceHandler.DATA_PROGRESS, progress);
-        data.putInt(KeychainIntentServiceHandler.DATA_PROGRESS_MAX, max);
+        data.putInt(ServiceProgressHandler.DATA_PROGRESS, progress);
+        data.putInt(ServiceProgressHandler.DATA_PROGRESS_MAX, max);
 
         sendMessageToHandler(MessageStatus.UPDATE_PROGRESS, null, data);
     }
 
-    public synchronized void setProgress(int resourceId, int progress, int max) {
+    public void setProgress(int resourceId, int progress, int max) {
         setProgress(getString(resourceId), progress, max);
     }
 
-    public synchronized void setProgress(int progress, int max) {
+    public void setProgress(int progress, int max) {
         setProgress(null, progress, max);
     }
 
     @Override
-    public synchronized void setPreventCancel() {
+    public void setPreventCancel() {
         sendMessageToHandler(MessageStatus.PREVENT_CANCEL);
     }
 
@@ -924,10 +743,8 @@ public class KeychainIntentService extends IntentService implements Progressable
 
     @Override
     public int onStartCommand(Intent intent, int flags, int startId) {
-        // onStartCommand will be run on the thread which starts the service
-        // cancel operation is introduced here as it must not be queued up
         if (ACTION_CANCEL.equals(intent.getAction())) {
-            sActionCanceled.set(true);
+            mActionCanceled.set(true);
             return START_NOT_STICKY;
         }
         return super.onStartCommand(intent, flags, startId);