First basic working app

Author: eikek

README.md

@@ -11,6 +11,9 @@ It works as follows:
   result with the docspell android app. It will upload it to the
   configured url.
 
+*Note, this is in very early state. I'm trying to get it into the
+f-droid store, until then you'd need to download from the release page
+and install manually.*
 
 ## Building
 
@@ -22,11 +25,13 @@ gradle assembleRelease
 
 Settings for signing must be made available.
 
-## Helpers
 
-- https://nixos.wiki/wiki/Android
-- https://developer.android.com/jetpack/androidx/releases/swiperefreshlayout
-- https://www.android-examples.com/android-swipe-down-to-refresh-recyclerview/
-- https://developer.android.com/studio/write/java8-support.html
-- https://stackoverflow.com/questions/31367599/how-to-update-recyclerview-adapter-data
-- https://zatackcoder.com/android-recyclerview-swipe-to-multiple-options/
+## Android 7.0 + TLS
+
+If you run in issues regarding your docspell server and tls, check
+whether you use android 7.0. It might be
+[this](https://github.com/nextcloud/news-android/issues/567#issuecomment-309700308).
+
+Summary: The `ssl_ecdh_curve secp384r1;` definition in nginx/apache is
+the problem. Replacing this with `ssl_ecdh_curve prime256v1;` solved
+it. Or, if possible, update android to 7.1+.

app/src/main/java/org/docspell/docspellshare/activity/ShareActivity.java

@@ -4,7 +4,9 @@
 import android.content.Intent;
 import android.net.Uri;
 import android.os.Bundle;
+import android.os.Handler;
 import android.util.Log;
+import android.view.View;
 import android.widget.ProgressBar;
 import android.widget.TextView;
 
@@ -13,6 +15,7 @@
 import org.docspell.docspellshare.R;
 import org.docspell.docspellshare.data.UrlItem;
 import org.docspell.docspellshare.http.HttpRequest;
+import org.docspell.docspellshare.http.ProgressListener;
 import org.docspell.docspellshare.http.UploadManager;
 import org.docspell.docspellshare.util.DataStore;
 import org.docspell.docspellshare.util.Strings;
@@ -23,26 +26,51 @@
 public class ShareActivity extends AppCompatActivity {
 
   private DataStore dataStore;
+  private Handler handler = new Handler();
+
+  private final ProgressListener progressListener =
+      new ProgressListener() {
+        @Override
+        public void onProgress(String name, long bytesWritten, long total) {
+          handler.post(
+              () -> {
+                TextView label = findViewById(R.id.uploadFileField);
+                label.setText(getString(R.string.uploadingLabel, name));
+
+                ProgressBar pb = findViewById(R.id.uploadProgress);
+                if (total > 0) {
+                  Log.w("share", String.format("Progress %d/%d", bytesWritten, total));
+                  pb.setIndeterminate(false);
+                  pb.setMax((int) total);
+                  pb.setProgress((int) bytesWritten);
+                } else {
+                  Log.w("share", "No total size: " + total);
+                  pb.setIndeterminate(true);
+                }
+              });
+        }
+
+        @Override
+        public void onFinish(int code) {
+          handler.post(() -> finish());
+        }
+
+        @Override
+        public void onException(Exception error) {
+          handler.post(
+              () -> {
+                TextView msg = findViewById(R.id.finishMessage);
+                msg.setText(getString(R.string.uploadError, error.getMessage()));
+              });
+        }
+      };
 
   @Override
   protected void onCreate(Bundle savedInstanceState) {
     super.onCreate(savedInstanceState);
     this.dataStore = new DataStore(this);
     setContentView(R.layout.activity_share);
-    UploadManager.getInstance()
-        .setProgress(
-            (name, progress) -> {
-              TextView label = findViewById(R.id.uploadFileField);
-              label.post(
-                  () -> {
-                    label.setText(name);
-                  });
-              ProgressBar pb = findViewById(R.id.uploadProgress);
-              pb.post(
-                  () -> {
-                    pb.setProgress(progress);
-                  });
-            });
+    UploadManager.getInstance().setProgress(progressListener);
 
     Intent intent = getIntent();
     String action = intent.getAction();
@@ -54,7 +82,7 @@ protected void onCreate(Bundle savedInstanceState) {
       } else {
         Uri uri = intent.getParcelableExtra(Intent.EXTRA_STREAM);
         if (uri != null) {
-          handleFiles(Collections.singletonList(uri), type);
+          handleFiles(Collections.singletonList(uri));
         }
       }
     } else if (Intent.ACTION_SEND_MULTIPLE.equals(action) && type != null) {
@@ -63,21 +91,21 @@ protected void onCreate(Bundle savedInstanceState) {
       } else {
         List<Uri> fileUris = intent.getParcelableArrayListExtra(Intent.EXTRA_STREAM);
         if (fileUris != null) {
-          handleFiles(fileUris, type);
+          handleFiles(fileUris);
         }
       }
     } else {
       Log.i("missing", "handling action '" + action + "' / '" + type + "' not implemented");
     }
   }
 
-  void handleFiles(List<Uri> uris, String type) {
+  void handleFiles(List<Uri> uris) {
     String url = dataStore.getDefaultUrl().map(UrlItem::getUrl).orElse(null);
     if (url != null) {
       HttpRequest.Builder req = HttpRequest.newBuilder().setUrl(url);
       ContentResolver resolver = getContentResolver();
       for (Uri uri : uris) {
-        req.addFile(resolver, uri, type);
+        req.addFile(resolver, uri);
       }
       UploadManager.getInstance().submit(req.build());
     }

app/src/main/java/org/docspell/docspellshare/http/HttpRequest.java

@@ -6,6 +6,7 @@
 import androidx.annotation.NonNull;
 
 import org.docspell.docspellshare.data.Option;
+import org.docspell.docspellshare.util.Uris;
 
 import java.io.IOException;
 import java.io.InputStream;
@@ -20,13 +21,15 @@
 import okhttp3.OkHttpClient;
 import okhttp3.Request;
 import okhttp3.RequestBody;
+import okhttp3.Response;
 import okio.BufferedSink;
 import okio.Okio;
 import okio.Source;
 
 import static org.docspell.docspellshare.util.Strings.requireNonEmpty;
 
 public final class HttpRequest {
+  private static final int CHUNK_SIZE = 16 * 1024;
   private static final OkHttpClient client =
       new OkHttpClient.Builder()
           .connectionSpecs(
@@ -36,6 +39,7 @@ public final class HttpRequest {
                   ConnectionSpec.CLEARTEXT))
           .readTimeout(5, TimeUnit.MINUTES)
           .writeTimeout(5, TimeUnit.MINUTES)
+          .socketFactory(new RestrictedSocketFactory(CHUNK_SIZE))
           .followRedirects(true)
           .followSslRedirects(true)
           .build();
@@ -48,14 +52,15 @@ private HttpRequest(String url, List<DataPart> data) {
     this.data = data;
   }
 
-  public void execute() throws IOException {
+  public int execute(ProgressListener progressListener) throws IOException {
     MultipartBody.Builder body = new MultipartBody.Builder().setType(MultipartBody.FORM);
     for (DataPart dp : data) {
-      body.addFormDataPart("file", dp.getName(), createPartBody(dp));
+      body.addFormDataPart("file", dp.getName(), createPartBody(dp, progressListener));
     }
 
     Request req = new Request.Builder().url(url).post(body.build()).build();
-    client.newCall(req).execute();
+    Response response = client.newCall(req).execute();
+    return response.code();
   }
 
   public static Builder newBuilder() {
@@ -66,7 +71,7 @@ public static class Builder {
     private final List<DataPart> parts = new ArrayList<>();
     private String url;
 
-    public Builder addFile(ContentResolver resolver, Uri data, String type) {
+    public Builder addFile(ContentResolver resolver, Uri data) {
       parts.add(
           new DataPart() {
             @Override
@@ -81,7 +86,12 @@ public String getName() {
 
             @Override
             public Option<String> getType() {
-              return Option.of(type);
+              return Option.ofNullable(resolver.getType(data));
+            }
+
+            @Override
+            public long getTotalSize() {
+              return Uris.getFileSize(data, resolver);
             }
           });
       return this;
@@ -103,9 +113,12 @@ public interface DataPart {
     String getName();
 
     Option<String> getType();
+
+    /** Return -1, if unknown. */
+    long getTotalSize();
   }
 
-  private static RequestBody createPartBody(DataPart part) {
+  private static RequestBody createPartBody(DataPart part, ProgressListener listener) {
     final String octetStream = "application/octet-stream";
     return new RequestBody() {
       @Override
@@ -114,11 +127,22 @@ public MediaType contentType() {
         return mt != null ? mt : MediaType.get(octetStream);
       }
 
+      @Override
+      public long contentLength() {
+        return part.getTotalSize();
+      }
+
       @Override
       public void writeTo(@NonNull BufferedSink sink) throws IOException {
         try (InputStream in = part.getData();
             Source source = Okio.source(in)) {
-          sink.writeAll(source);
+          long total = 0;
+          long read;
+          while ((read = source.read(sink.getBuffer(), CHUNK_SIZE)) != -1) {
+            total += read;
+            sink.flush();
+            listener.onProgress(part.getName(), total, part.getTotalSize());
+          }
         }
       }
     };

app/src/main/java/org/docspell/docspellshare/http/ProgressListener.java

@@ -0,0 +1,21 @@
+package org.docspell.docspellshare.http;
+
+public interface ProgressListener {
+  ProgressListener NONE =
+      new ProgressListener() {
+        @Override
+        public void onProgress(String name, long bytesWritten, long total) {}
+
+        @Override
+        public void onFinish(int code) {}
+
+        @Override
+        public void onException(Exception error) {}
+      };
+
+  void onProgress(String name, long bytesWritten, long total);
+
+  void onFinish(int code);
+
+  void onException(Exception error);
+}

app/src/main/java/org/docspell/docspellshare/http/RestrictedSocketFactory.java

@@ -0,0 +1,90 @@
+package org.docspell.docspellshare.http;
+
+import android.util.Log;
+
+import java.io.IOException;
+import java.net.InetAddress;
+import java.net.Socket;
+import java.net.SocketException;
+import java.net.UnknownHostException;
+
+import javax.net.SocketFactory;
+
+/**
+ * <b>Restricted Socket Factory</b>
+ *
+ * <p>OkHttp buffers to the network interface but the network interface's default buffer size is
+ * sometimes set very high e.g. 512Kb which makes tracking upload progress impossible as the upload
+ * content is sitting in the network interface buffer waiting to be transmitted. Re:
+ * https://github.com/square/okhttp/issues/1078
+ *
+ * <p>So here, we create socket factory that forces all sockets to have a restricted send buffer
+ * size. So that further down the chain in OkHttps' RequestBody we can track the actual progress to
+ * the nearest [sendBufferSize] unit.
+ *
+ * <p>Example usage with OkHttpClient 2.x:
+ *
+ * <pre>
+ *     okHttpClient.setSocketFactory(new RestrictedSocketFactory(16 * 1024));
+ * </pre>
+ *
+ * <p>Example usage with OkHttpClient 3.x:
+ *
+ * <pre>
+ *     okHttpClientBuilder.socketFactory(new RestrictedSocketFactory(16 * 1024))
+ * </pre>
+ *
+ * <p>Created by Simon Lightfoot <[email protected]> on 04/04/2016.
+ * https://gist.github.com/slightfoot/00a26683ea68856ceb50e26c7d8a47d0
+ */
+public class RestrictedSocketFactory extends SocketFactory {
+  private static final String TAG = RestrictedSocketFactory.class.getSimpleName();
+
+  private int mSendBufferSize;
+
+  public RestrictedSocketFactory(int sendBufferSize) {
+    mSendBufferSize = sendBufferSize;
+    try {
+      Socket socket = new Socket();
+      Log.w(
+          TAG,
+          String.format(
+              "Changing SO_SNDBUF on new sockets from %d to %d.",
+              socket.getSendBufferSize(), sendBufferSize));
+    } catch (SocketException e) {
+      //
+    }
+  }
+
+  @Override
+  public Socket createSocket() throws IOException {
+    return updateSendBufferSize(new Socket());
+  }
+
+  @Override
+  public Socket createSocket(String host, int port) throws IOException {
+    return updateSendBufferSize(new Socket(host, port));
+  }
+
+  @Override
+  public Socket createSocket(String host, int port, InetAddress localHost, int localPort)
+      throws IOException, UnknownHostException {
+    return updateSendBufferSize(new Socket(host, port, localHost, localPort));
+  }
+
+  @Override
+  public Socket createSocket(InetAddress host, int port) throws IOException {
+    return updateSendBufferSize(new Socket(host, port));
+  }
+
+  @Override
+  public Socket createSocket(InetAddress address, int port, InetAddress localAddress, int localPort)
+      throws IOException {
+    return updateSendBufferSize(new Socket(address, port, localAddress, localPort));
+  }
+
+  private Socket updateSendBufferSize(Socket socket) throws IOException {
+    socket.setSendBufferSize(mSendBufferSize);
+    return socket;
+  }
+}