Extract the ile compression logic into a separate class

Author: harri35

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+**Version 2.0.7**
+
+Date: 11.09.2019
+
+- Made the file compression logic usable separately via the FileCompressor class.
+- Bug fixes - LogViewBuilder now also supports the log file compression parameter.
+
 **Version 2.0.6**
 
 Date: 10.09.2019

scrolls-lib/src/main/java/mobi/lab/scrolls/LogPostImpl.java

@@ -12,6 +12,7 @@
 import java.io.File;
 import java.io.InputStream;
 
+import mobi.lab.scrolls.tools.FileCompressor;
 import mobi.lab.scrolls.tools.LogHelper;
 import mobi.lab.scrolls.tools.Util;
 
@@ -63,12 +64,12 @@ private void doPostSync(@NonNull Context context, @NonNull String callbackTag, @
     }
 
     private File compressAttachmentIfNeeded(File originalAttachment) {
-        if (!compressLogFile) {
+        if (!compressLogFile || originalAttachment == null) {
             return originalAttachment;
         }
-        final File compressedFile = new File(originalAttachment.getParentFile(), originalAttachment.getName().replaceFirst("[.][^.]+$", "") + ".zip");
-        Util.compressFiles(new File[]{originalAttachment}, compressedFile);
-        return compressedFile;
+        final File targetFile = FileCompressor.createCompressedFileCandidateFromUncompressedFilePath(originalAttachment);
+        final boolean success = FileCompressor.compressFiles(new File[]{originalAttachment}, targetFile);
+        return success ? targetFile : originalAttachment;
     }
 
     private Uri createUriIfNeeded(@NonNull Context context, @Nullable File attachment) {

scrolls-lib/src/main/java/mobi/lab/scrolls/tools/FileCompressor.java

@@ -0,0 +1,67 @@
+package mobi.lab.scrolls.tools;
+
+import android.support.annotation.NonNull;
+import android.support.annotation.WorkerThread;
+import android.util.Log;
+
+import java.io.BufferedInputStream;
+import java.io.BufferedOutputStream;
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileOutputStream;
+import java.util.zip.ZipEntry;
+import java.util.zip.ZipOutputStream;
+
+/**
+ * Helper to compress log files.
+ */
+public class FileCompressor {
+
+    /**
+     * Takes in a File and creates a new File with the same path and name and replaces the original extension with ".zip".
+     * This method does not do the actual compression, it just creates a path for the destination file.
+     * Use {@link #compressFiles(File[], File)} for the actual compression work.
+     *
+     * @param uncompressedFile original File
+     * @return Compressed File candidate
+     */
+    @NonNull
+    public static File createCompressedFileCandidateFromUncompressedFilePath(@NonNull File uncompressedFile) {
+        return new File(uncompressedFile.getParentFile(), uncompressedFile.getName().replaceFirst("[.][^.]+$", "") + ".zip");
+    }
+
+    /**
+     * Compress a N files into one compressed file.
+     *
+     * @param targetFiles    Target files to compress
+     * @param compressedFile Compressed file. Will be overwritten if exists.
+     * @return true if the operation was success
+     */
+    @WorkerThread
+    public static boolean compressFiles(@NonNull final File[] targetFiles, @NonNull final File compressedFile) {
+        try {
+            final int bufferSize = 4096;
+            BufferedInputStream origin;
+            final FileOutputStream dest = new FileOutputStream(compressedFile);
+            final ZipOutputStream out = new ZipOutputStream(new BufferedOutputStream(dest));
+            final byte[] data = new byte[bufferSize];
+            for (File file : targetFiles) {
+                FileInputStream fi = new FileInputStream(file);
+                origin = new BufferedInputStream(fi, bufferSize);
+
+                final ZipEntry entry = new ZipEntry(file.getName());
+                out.putNextEntry(entry);
+                int count;
+                while ((count = origin.read(data, 0, bufferSize)) != -1) {
+                    out.write(data, 0, count);
+                }
+                LogHelper.closeStream(origin);
+            }
+            LogHelper.closeStream(out);
+            return true;
+        } catch (Exception e) {
+            Log.w("FileCompressor", "compressFiles failed", e);
+            return false;
+        }
+    }
+}

scrolls-lib/src/main/java/mobi/lab/scrolls/tools/Util.java

@@ -3,23 +3,11 @@
 import android.content.Context;
 import android.content.pm.ApplicationInfo;
 import android.content.pm.PackageManager;
-import android.support.annotation.NonNull;
-import android.support.annotation.WorkerThread;
-import android.util.Log;
 
-import java.io.BufferedInputStream;
-import java.io.BufferedOutputStream;
-import java.io.File;
-import java.io.FileInputStream;
-import java.io.FileOutputStream;
-import java.io.IOException;
-import java.io.InputStream;
 import java.text.DateFormat;
 import java.text.SimpleDateFormat;
 import java.util.Date;
 import java.util.Locale;
-import java.util.zip.ZipEntry;
-import java.util.zip.ZipOutputStream;
 
 public class Util {
 
@@ -37,53 +25,9 @@ public static String getAppName(Context context) {
         return info.loadLabel(context.getPackageManager()).toString();
     }
 
-    public static String inputStreamToString(InputStream in) {
-        StringBuilder sb = new StringBuilder();
-        try {
-            byte[] buf = new byte[4096]; // not always 4k, but most of the times
-            while (in.read(buf) != -1) {
-                sb.append(new String(buf, "UTF-8"));
-            }
-        } catch (IOException ioe) {
-            Log.w("LogPost", "logpost failed", ioe);
-        } finally {
-            try {
-                in.close();
-            } catch (Exception ignored) {
-            }
-        }
-        return sb.toString();
-    }
-
     public static String getCurrentTimeString() {
         DateFormat dateFormat = new SimpleDateFormat("yyyy.MM.dd HH:mm:ssZ", Locale.US);
         return dateFormat.format(new Date());
     }
 
-    @WorkerThread
-    public static void compressFiles(@NonNull final File[] targetFiles, @NonNull final File compressedFile) {
-        try {
-            final int bufferSize = 4096;
-            BufferedInputStream origin;
-            final FileOutputStream dest = new FileOutputStream(compressedFile);
-            final ZipOutputStream out = new ZipOutputStream(new BufferedOutputStream(dest));
-            final byte[] data = new byte[bufferSize];
-            for (File file : targetFiles) {
-                FileInputStream fi = new FileInputStream(file);
-                origin = new BufferedInputStream(fi, bufferSize);
-
-                final ZipEntry entry = new ZipEntry(file.getName());
-                out.putNextEntry(entry);
-                int count;
-                while ((count = origin.read(data, 0, bufferSize)) != -1) {
-                    out.write(data, 0, count);
-                }
-                LogHelper.closeStream(origin);
-            }
-            LogHelper.closeStream(out);
-        } catch (Exception e) {
-            Log.w("LogPost", "compressFiles failed", e);
-        }
-    }
-
 }