export: externalize upload into its own operation

2015-09-26 03:20:39 +02:00
parent 603eab729f
commit c93670f3c6
9 changed files with 317 additions and 144 deletions
--- a/OpenKeychain/src/main/java/org/sufficientlysecure/keychain/operations/CertifyOperation.java
+++ b/OpenKeychain/src/main/java/org/sufficientlysecure/keychain/operations/CertifyOperation.java
@@ -17,15 +17,20 @@

 package org.sufficientlysecure.keychain.operations;

+
+import java.net.Proxy;
+import java.util.ArrayList;
+import java.util.concurrent.atomic.AtomicBoolean;
+
 import android.content.Context;
 import android.support.annotation.NonNull;

 import org.sufficientlysecure.keychain.keyimport.HkpKeyserver;
 import org.sufficientlysecure.keychain.operations.results.CertifyResult;
-import org.sufficientlysecure.keychain.operations.results.ExportResult;
 import org.sufficientlysecure.keychain.operations.results.OperationResult.LogType;
 import org.sufficientlysecure.keychain.operations.results.OperationResult.OperationLog;
 import org.sufficientlysecure.keychain.operations.results.SaveKeyringResult;
+import org.sufficientlysecure.keychain.operations.results.UploadResult;
 import org.sufficientlysecure.keychain.pgp.CanonicalizedPublicKeyRing;
 import org.sufficientlysecure.keychain.pgp.CanonicalizedSecretKey;
 import org.sufficientlysecure.keychain.pgp.CanonicalizedSecretKeyRing;
@@ -48,10 +53,6 @@ import org.sufficientlysecure.keychain.util.Passphrase;
 import org.sufficientlysecure.keychain.util.Preferences;
 import org.sufficientlysecure.keychain.util.orbot.OrbotHelper;

-import java.net.Proxy;
-import java.util.ArrayList;
-import java.util.concurrent.atomic.AtomicBoolean;
-
 /**
 * An operation which implements a high level user id certification operation.
 * <p/>
@@ -205,11 +206,11 @@ public class CertifyOperation extends BaseOperation<CertifyActionsParcel> {

        // these variables are used inside the following loop, but they need to be created only once
        HkpKeyserver keyServer = null;
-        ExportOperation exportOperation = null;
+        UploadOperation uploadOperation = null;
        Proxy proxy = null;
        if (parcel.keyServerUri != null) {
            keyServer = new HkpKeyserver(parcel.keyServerUri);
-            exportOperation = new ExportOperation(mContext, mProviderHelper, mProgressable);
+            uploadOperation = new UploadOperation(mContext, mProviderHelper, mProgressable);
            if (cryptoInput.getParcelableProxy() == null) {
                // explicit proxy not set
                if (!OrbotHelper.isOrbotInRequiredState(mContext)) {
@@ -239,8 +240,8 @@ public class CertifyOperation extends BaseOperation<CertifyActionsParcel> {
            mProviderHelper.clearLog();
            SaveKeyringResult result = mProviderHelper.savePublicKeyRing(certifiedKey);

-            if (exportOperation != null) {
-                ExportResult uploadResult = exportOperation.uploadKeyRingToServer(
+            if (uploadOperation != null) {
+                UploadResult uploadResult = uploadOperation.uploadKeyRingToServer(
                        keyServer,
                        certifiedKey,
                        proxy);
--- a/OpenKeychain/src/main/java/org/sufficientlysecure/keychain/operations/ExportOperation.java
+++ b/OpenKeychain/src/main/java/org/sufficientlysecure/keychain/operations/ExportOperation.java
@@ -20,30 +20,24 @@ package org.sufficientlysecure.keychain.operations;


 import java.io.BufferedOutputStream;
-import java.io.ByteArrayOutputStream;
 import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.io.OutputStream;
-import java.net.Proxy;
 import java.util.Collections;
 import java.util.concurrent.atomic.AtomicBoolean;

 import android.content.Context;
 import android.database.Cursor;
-import android.net.Uri;
 import android.support.annotation.NonNull;
 import android.text.TextUtils;

 import org.spongycastle.bcpg.ArmoredOutputStream;
 import org.sufficientlysecure.keychain.Constants;
 import org.sufficientlysecure.keychain.R;
-import org.sufficientlysecure.keychain.keyimport.HkpKeyserver;
-import org.sufficientlysecure.keychain.keyimport.Keyserver.AddKeyException;
 import org.sufficientlysecure.keychain.operations.results.ExportResult;
 import org.sufficientlysecure.keychain.operations.results.OperationResult.LogType;
 import org.sufficientlysecure.keychain.operations.results.OperationResult.OperationLog;
 import org.sufficientlysecure.keychain.pgp.CanonicalizedKeyRing;
-import org.sufficientlysecure.keychain.pgp.CanonicalizedPublicKeyRing;
 import org.sufficientlysecure.keychain.pgp.Progressable;
 import org.sufficientlysecure.keychain.pgp.UncachedKeyRing;
 import org.sufficientlysecure.keychain.pgp.exception.PgpGeneralException;
@@ -52,11 +46,9 @@ import org.sufficientlysecure.keychain.provider.KeychainDatabase.Tables;
 import org.sufficientlysecure.keychain.provider.ProviderHelper;
 import org.sufficientlysecure.keychain.service.ExportKeyringParcel;
 import org.sufficientlysecure.keychain.service.input.CryptoInputParcel;
-import org.sufficientlysecure.keychain.service.input.RequiredInputParcel;
 import org.sufficientlysecure.keychain.ui.util.KeyFormattingUtils;
 import org.sufficientlysecure.keychain.util.Log;
-import org.sufficientlysecure.keychain.util.Preferences;
-import org.sufficientlysecure.keychain.util.orbot.OrbotHelper;
+

 /**
 * An operation class which implements high level export
@@ -93,107 +85,24 @@ public class ExportOperation extends BaseOperation<ExportKeyringParcel> {

    @NonNull
    public ExportResult execute(ExportKeyringParcel exportInput, CryptoInputParcel cryptoInput) {
-        switch (exportInput.mExportType) {
-            case UPLOAD_KEYSERVER: {
-                Proxy proxy;
-                if (cryptoInput.getParcelableProxy() == null) {
-                    // explicit proxy not set
-                    if (!OrbotHelper.isOrbotInRequiredState(mContext)) {
-                        return new ExportResult(null,
-                                RequiredInputParcel.createOrbotRequiredOperation(), cryptoInput);
-                    }
-                    proxy = Preferences.getPreferences(mContext).getProxyPrefs()
-                            .parcelableProxy.getProxy();
-                } else {
-                    proxy = cryptoInput.getParcelableProxy().getProxy();
-                }
-
-                HkpKeyserver hkpKeyserver = new HkpKeyserver(exportInput.mKeyserver);
-                try {
-                    if (exportInput.mCanonicalizedPublicKeyringUri != null) {
-                        CanonicalizedPublicKeyRing keyring
-                                = mProviderHelper.getCanonicalizedPublicKeyRing(
-                                exportInput.mCanonicalizedPublicKeyringUri);
-                        return uploadKeyRingToServer(hkpKeyserver, keyring.getUncachedKeyRing(), proxy);
-                    } else {
-                        return uploadKeyRingToServer(hkpKeyserver, exportInput.mUncachedKeyRing, proxy);
-                    }
-                } catch (ProviderHelper.NotFoundException e) {
-                    Log.e(Constants.TAG, "error uploading key", e);
-                    return new ExportResult(ExportResult.RESULT_ERROR, new OperationLog());
-                }
-            }
-            case EXPORT_URI: {
-                return exportToUri(exportInput.mMasterKeyIds, exportInput.mExportSecret, exportInput.mOutputUri);
-            }
-            default: { // can never happen, all enum types must be handled above
-                throw new AssertionError("must not happen, this is a bug!");
-            }
-        }
-    }
-
-    public ExportResult uploadKeyRingToServer(HkpKeyserver server, UncachedKeyRing keyring, Proxy proxy) {
-        mProgressable.setProgress(R.string.progress_uploading, 0, 1);
-
-        ByteArrayOutputStream bos = new ByteArrayOutputStream();
-        ArmoredOutputStream aos = null;
-        OperationLog log = new OperationLog();
-        log.add(LogType.MSG_EXPORT_UPLOAD_PUBLIC, 0, KeyFormattingUtils.convertKeyIdToHex(
-                keyring.getPublicKey().getKeyId()
-        ));
-
-        try {
-            aos = new ArmoredOutputStream(bos);
-            keyring.encode(aos);
-            aos.close();
-
-            String armoredKey = bos.toString("UTF-8");
-            server.add(armoredKey, proxy);
-
-            log.add(LogType.MSG_EXPORT_UPLOAD_SUCCESS, 1);
-            return new ExportResult(ExportResult.RESULT_OK, log);
-        } catch (IOException e) {
-            Log.e(Constants.TAG, "IOException", e);
-
-            log.add(LogType.MSG_EXPORT_ERROR_KEY, 1);
-            return new ExportResult(ExportResult.RESULT_ERROR, log);
-        } catch (AddKeyException e) {
-            Log.e(Constants.TAG, "AddKeyException", e);
-
-            log.add(LogType.MSG_EXPORT_ERROR_UPLOAD, 1);
-            return new ExportResult(ExportResult.RESULT_ERROR, log);
-        } finally {
-            mProgressable.setProgress(R.string.progress_uploading, 1, 1);
-            try {
-                if (aos != null) {
-                    aos.close();
-                }
-                bos.close();
-            } catch (IOException e) {
-                // this is just a finally thing, no matter if it doesn't work out.
-            }
-        }
-    }
-
-    public ExportResult exportToUri(long[] masterKeyIds, boolean exportSecret, Uri outputUri) {

        OperationLog log = new OperationLog();
-        if (masterKeyIds != null) {
-            log.add(LogType.MSG_EXPORT, 0, masterKeyIds.length);
+        if (exportInput.mMasterKeyIds != null) {
+            log.add(LogType.MSG_EXPORT, 0, exportInput.mMasterKeyIds.length);
        } else {
            log.add(LogType.MSG_EXPORT_ALL, 0);
        }

        // do we have a file name?
-        if (outputUri == null) {
+        if (exportInput.mOutputUri == null) {
            log.add(LogType.MSG_EXPORT_ERROR_NO_URI, 1);
            return new ExportResult(ExportResult.RESULT_ERROR, log);
        }

        try {
-            OutputStream outStream = mProviderHelper.getContentResolver().openOutputStream(outputUri);
+            OutputStream outStream = mProviderHelper.getContentResolver().openOutputStream(exportInput.mOutputUri);
            outStream = new BufferedOutputStream(outStream);
-            return exportKeyRings(log, masterKeyIds, exportSecret, outStream);
+            return exportKeyRings(log, exportInput.mMasterKeyIds, exportInput.mExportSecret, outStream);
        } catch (FileNotFoundException e) {
            log.add(LogType.MSG_EXPORT_ERROR_URI_OPEN, 1);
            return new ExportResult(ExportResult.RESULT_ERROR, log);
--- a/OpenKeychain/src/main/java/org/sufficientlysecure/keychain/operations/UploadOperation.java
+++ b/OpenKeychain/src/main/java/org/sufficientlysecure/keychain/operations/UploadOperation.java
@@ -0,0 +1,141 @@
+/*
+ * Copyright (C) 2012-2014 Dominik Schürmann <dominik@dominikschuermann.de>
+ * Copyright (C) 2010-2014 Thialfihar <thi@thialfihar.org>
+ * Copyright (C) 2015 Vincent Breitmoser <valodim@mugenguild.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.operations;
+
+
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.net.Proxy;
+import java.util.concurrent.atomic.AtomicBoolean;
+
+import android.content.Context;
+import android.support.annotation.NonNull;
+
+import org.spongycastle.bcpg.ArmoredOutputStream;
+import org.sufficientlysecure.keychain.Constants;
+import org.sufficientlysecure.keychain.R;
+import org.sufficientlysecure.keychain.keyimport.HkpKeyserver;
+import org.sufficientlysecure.keychain.keyimport.Keyserver.AddKeyException;
+import org.sufficientlysecure.keychain.operations.results.OperationResult.LogType;
+import org.sufficientlysecure.keychain.operations.results.OperationResult.OperationLog;
+import org.sufficientlysecure.keychain.operations.results.UploadResult;
+import org.sufficientlysecure.keychain.pgp.CanonicalizedPublicKeyRing;
+import org.sufficientlysecure.keychain.pgp.Progressable;
+import org.sufficientlysecure.keychain.pgp.UncachedKeyRing;
+import org.sufficientlysecure.keychain.provider.ProviderHelper;
+import org.sufficientlysecure.keychain.service.UploadKeyringParcel;
+import org.sufficientlysecure.keychain.service.input.CryptoInputParcel;
+import org.sufficientlysecure.keychain.service.input.RequiredInputParcel;
+import org.sufficientlysecure.keychain.ui.util.KeyFormattingUtils;
+import org.sufficientlysecure.keychain.util.Log;
+import org.sufficientlysecure.keychain.util.Preferences;
+import org.sufficientlysecure.keychain.util.orbot.OrbotHelper;
+
+
+/**
+ * An operation class which implements high level export operations.
+ * This class receives a source and/or destination of keys as input and performs
+ * all steps for this export.
+ *
+ * @see org.sufficientlysecure.keychain.ui.adapter.ImportKeysAdapter#getSelectedEntries()
+ * For the export operation, the input consists of a set of key ids and
+ * either the name of a file or an output uri to write to.
+ */
+public class UploadOperation extends BaseOperation<UploadKeyringParcel> {
+
+    public UploadOperation(Context context, ProviderHelper providerHelper, Progressable
+            progressable) {
+        super(context, providerHelper, progressable);
+    }
+
+    public UploadOperation(Context context, ProviderHelper providerHelper,
+            Progressable progressable, AtomicBoolean cancelled) {
+        super(context, providerHelper, progressable, cancelled);
+    }
+
+    @NonNull
+    public UploadResult execute(UploadKeyringParcel exportInput, CryptoInputParcel cryptoInput) {
+        Proxy proxy;
+        if (cryptoInput.getParcelableProxy() == null) {
+            // explicit proxy not set
+            if (!OrbotHelper.isOrbotInRequiredState(mContext)) {
+                return new UploadResult(null, RequiredInputParcel.createOrbotRequiredOperation(), cryptoInput);
+            }
+            proxy = Preferences.getPreferences(mContext).getProxyPrefs().parcelableProxy.getProxy();
+        } else {
+            proxy = cryptoInput.getParcelableProxy().getProxy();
+        }
+
+        HkpKeyserver hkpKeyserver = new HkpKeyserver(exportInput.mKeyserver);
+        try {
+            CanonicalizedPublicKeyRing keyring = mProviderHelper.getCanonicalizedPublicKeyRing(
+                    exportInput.mCanonicalizedPublicKeyringUri);
+            return uploadKeyRingToServer(hkpKeyserver, keyring.getUncachedKeyRing(), proxy);
+        } catch (ProviderHelper.NotFoundException e) {
+            Log.e(Constants.TAG, "error uploading key", e);
+            return new UploadResult(UploadResult.RESULT_ERROR, new OperationLog());
+        }
+    }
+
+    public UploadResult uploadKeyRingToServer(HkpKeyserver server, UncachedKeyRing keyring, Proxy proxy) {
+
+        mProgressable.setProgress(R.string.progress_uploading, 0, 1);
+
+        ByteArrayOutputStream bos = new ByteArrayOutputStream();
+        ArmoredOutputStream aos = null;
+        OperationLog log = new OperationLog();
+        log.add(LogType.MSG_EXPORT_UPLOAD_PUBLIC, 0, KeyFormattingUtils.convertKeyIdToHex(
+                keyring.getPublicKey().getKeyId()
+        ));
+
+        try {
+            aos = new ArmoredOutputStream(bos);
+            keyring.encode(aos);
+            aos.close();
+
+            String armoredKey = bos.toString("UTF-8");
+            server.add(armoredKey, proxy);
+
+            log.add(LogType.MSG_EXPORT_UPLOAD_SUCCESS, 1);
+            return new UploadResult(UploadResult.RESULT_OK, log);
+        } catch (IOException e) {
+            Log.e(Constants.TAG, "IOException", e);
+
+            log.add(LogType.MSG_EXPORT_ERROR_KEY, 1);
+            return new UploadResult(UploadResult.RESULT_ERROR, log);
+        } catch (AddKeyException e) {
+            Log.e(Constants.TAG, "AddKeyException", e);
+
+            log.add(LogType.MSG_EXPORT_ERROR_UPLOAD, 1);
+            return new UploadResult(UploadResult.RESULT_ERROR, log);
+        } finally {
+            mProgressable.setProgress(R.string.progress_uploading, 1, 1);
+            try {
+                if (aos != null) {
+                    aos.close();
+                }
+                bos.close();
+            } catch (IOException e) {
+                // this is just a finally thing, no matter if it doesn't work out.
+            }
+        }
+    }
+
+}
--- a/OpenKeychain/src/main/java/org/sufficientlysecure/keychain/operations/results/UploadResult.java
+++ b/OpenKeychain/src/main/java/org/sufficientlysecure/keychain/operations/results/UploadResult.java
@@ -0,0 +1,73 @@
+/*
+ * Copyright (C) 2014 Vincent Breitmoser <v.breitmoser@mugenguild.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.operations.results;
+
+import android.os.Parcel;
+
+import org.sufficientlysecure.keychain.service.input.CryptoInputParcel;
+import org.sufficientlysecure.keychain.service.input.RequiredInputParcel;
+
+
+public class UploadResult extends InputPendingResult {
+
+    final int mOkPublic, mOkSecret;
+
+    public UploadResult(int result, OperationLog log) {
+        this(result, log, 0, 0);
+    }
+
+    public UploadResult(int result, OperationLog log, int okPublic, int okSecret) {
+        super(result, log);
+        mOkPublic = okPublic;
+        mOkSecret = okSecret;
+    }
+
+
+    public UploadResult(OperationLog log, RequiredInputParcel requiredInputParcel,
+            CryptoInputParcel cryptoInputParcel) {
+        super(log, requiredInputParcel, cryptoInputParcel);
+        // we won't use these values
+        mOkPublic = -1;
+        mOkSecret = -1;
+    }
+
+    /** Construct from a parcel - trivial because we have no extra data. */
+    public UploadResult(Parcel source) {
+        super(source);
+        mOkPublic = source.readInt();
+        mOkSecret = source.readInt();
+    }
+
+    @Override
+    public void writeToParcel(Parcel dest, int flags) {
+        super.writeToParcel(dest, flags);
+        dest.writeInt(mOkPublic);
+        dest.writeInt(mOkSecret);
+    }
+
+    public static Creator<UploadResult> CREATOR = new Creator<UploadResult>() {
+        public UploadResult createFromParcel(final Parcel source) {
+            return new UploadResult(source);
+        }
+
+        public UploadResult[] newArray(final int size) {
+            return new UploadResult[size];
+        }
+    };
+
+}