checks for downloaded file integrity using ETag header

krishna · krishna · commit bb1c4d7bd9cb · 2018-08-29T12:38:05.000+05:30
diff --git a/.idea/caches/build_file_checksums.ser b/.idea/caches/build_file_checksums.ser
diff --git a/.idea/codeStyles/Project.xml b/.idea/codeStyles/Project.xml
diff --git a/app/build.gradle b/app/build.gradle
@@ -2,7 +2,7 @@ apply plugin: 'com.android.application'
 
 android {
     compileSdkVersion 26
-    buildToolsVersion '26.0.2'
+    buildToolsVersion '27.0.3'
     defaultConfig {
         applicationId "com.krishna.fileloadersample"
         minSdkVersion 16
diff --git a/app/src/main/java/com/krishna/fileloadersample/MainActivity.java b/app/src/main/java/com/krishna/fileloadersample/MainActivity.java
@@ -37,6 +37,7 @@ protected void onCreate(Bundle savedInstanceState) {
         //Asynchronously load file as generic file
         FileLoader.with(this)
                 .load("https://upload.wikimedia.org/wikipedia/commons/3/3c/Enrique_Simonet_-_Marina_veneciana_6MB.jpg")
+                .checkFileintegrity(true)
                 .fromDirectory("test4", FileLoader.DIR_EXTERNAL_PUBLIC)
                 .asFile(new FileRequestListener<File>() {
                     @Override
@@ -61,6 +62,7 @@ public void onError(FileLoadRequest request, Throwable t) {
             FileResponse response = FileLoader.with(this)
                     .load("http://echo.jsontest.com/key1/value1/key2/value2")
                     .fromDirectory("test4", FileLoader.DIR_EXTERNAL_PUBLIC)
+                    .checkFileintegrity(true)
                     .asObject(JsonTest.class);
             JsonTest test = (JsonTest) response.getBody();
             Log.d(TAG, "" + test);
@@ -97,6 +99,7 @@ public void onError(FileLoadRequest request, Throwable t) {
         multiFileLoadRequests.add(new MultiFileLoadRequest(uris[1], Environment.DIRECTORY_PICTURES, FileLoader.DIR_EXTERNAL_PUBLIC, true));
 
         final MultiFileDownloader multiFileDownloader = FileLoader.multiFileDownload(this);
+        multiFileDownloader.checkFileintegrity(true);
         multiFileDownloader.progressListener(new MultiFileDownloadListener() {
             @Override
             public void onProgress(File downloadedFile, int progress, int totalFiles) {
diff --git a/build.gradle b/build.gradle
@@ -2,20 +2,20 @@
 
 buildscript {
     repositories {
-        jcenter()
         google()
+        jcenter()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:3.0.0'
+        classpath 'com.android.tools.build:gradle:3.1.4'
         // NOTE: Do not place your application dependencies here; they belong
         // in the individual module build.gradle files
     }
 }
 
 allprojects {
     repositories {
-        jcenter()
         google()
+        jcenter()
         maven { url 'https://jitpack.io' }
     }
 }
diff --git a/fileloader/build.gradle b/fileloader/build.gradle
@@ -5,7 +5,7 @@ group='com.github.kk121'
 
 android {
     compileSdkVersion 26
-    buildToolsVersion '26.0.2'
+    buildToolsVersion '27.0.3'
 
     defaultConfig {
         minSdkVersion 16
diff --git a/fileloader/src/main/java/com/krishna/fileloader/FileLoader.java b/fileloader/src/main/java/com/krishna/fileloader/FileLoader.java
@@ -263,7 +263,7 @@ protected DownloadResponse doInBackground(Void... voids) {
                     if (loadedFile == null || !loadedFile.exists()) {
                         //download from internet
                         FileDownloader downloader = new FileDownloader(context, fileLoadRequest.getUri(), fileLoadRequest.getDirectoryName(), fileLoadRequest.getDirectoryType());
-                        loadedFile = downloader.download(fileLoadRequest.isAutoRefresh());
+                        loadedFile = downloader.download(fileLoadRequest.isAutoRefresh(), fileLoadRequest.isCheckIntegrity());
                     }
                     downloadResponse.setDownloadedFile(loadedFile);
                 } catch (Exception e) {
diff --git a/fileloader/src/main/java/com/krishna/fileloader/MultiFileDownloadTask.java b/fileloader/src/main/java/com/krishna/fileloader/MultiFileDownloadTask.java
@@ -38,9 +38,9 @@ protected Void doInBackground(MultiFileLoadRequest... requests) {
                 File downloadedFile = AndroidFileManager.searchAndGetLocalFile(context, loadRequest.getUri(), loadRequest.getDirectoryName(), loadRequest.getDirectoryType());
                 FileDownloader downloader = new FileDownloader(context, loadRequest.getUri(), loadRequest.getDirectoryName(), loadRequest.getDirectoryType());
                 if (loadRequest.isForceLoadFromNetwork() || downloadedFile == null || !downloadedFile.exists()) {
-                    downloadedFile = downloader.download(false);
+                    downloadedFile = downloader.download(false, loadRequest.isCheckIntegrity());
                 } else if (loadRequest.isAutoRefresh()) {
-                    File tempFile = downloader.download(true);
+                    File tempFile = downloader.download(true, loadRequest.isCheckIntegrity());
                     if (tempFile != null) {
                         downloadedFile = tempFile;
                     }
diff --git a/fileloader/src/main/java/com/krishna/fileloader/builder/FileLoaderBuilder.java b/fileloader/src/main/java/com/krishna/fileloader/builder/FileLoaderBuilder.java
@@ -29,6 +29,7 @@ public class FileLoaderBuilder {
     private FileLoader fileLoader;
     private boolean forceLoadFromNetwork;
     private boolean autoRefresh;
+    private boolean checkIntegrity;
 
 
     public FileLoaderBuilder(Context context) {
@@ -56,6 +57,11 @@ public FileLoaderBuilder fromDirectory(String directoryName, @FileLoader.Directo
         return this;
     }
 
+    public FileLoaderBuilder checkFileintegrity(boolean checkIntegrity) {
+        this.checkIntegrity = checkIntegrity;
+        return this;
+    }
+
     public FileResponse asFile() throws Exception {
         returnFileType = FileLoadRequest.TYPE_FILE;
         buildFileLoader();
@@ -111,6 +117,6 @@ public void asObject(FileRequestListener<? extends Object> listener) {
 
     private void buildFileLoader() {
         fileLoader = new FileLoader(context);
-        fileLoader.setFileLoadRequest(new FileLoadRequest(uri, directoryName, directoryType, returnFileType, requestClass, fileExtension, forceLoadFromNetwork, autoRefresh, listener));
+        fileLoader.setFileLoadRequest(new FileLoadRequest(uri, directoryName, directoryType, returnFileType, requestClass, fileExtension, forceLoadFromNetwork, autoRefresh, checkIntegrity, listener));
     }
 }
diff --git a/fileloader/src/main/java/com/krishna/fileloader/builder/MultiFileDownloader.java b/fileloader/src/main/java/com/krishna/fileloader/builder/MultiFileDownloader.java
@@ -22,6 +22,7 @@ public class MultiFileDownloader {
     private MultiFileDownloadListener listener;
     private boolean forceLoadFromNetwork;
     private boolean autoRefresh;
+    private boolean checkIntegrity;
     private MultiFileDownloadTask multiFileDownloadTask;
 
     public MultiFileDownloader(Context context) {
@@ -44,11 +45,17 @@ public MultiFileDownloader progressListener(MultiFileDownloadListener listener)
         return this;
     }
 
+    public MultiFileDownloader checkFileintegrity(boolean checkIntegrity) {
+        this.checkIntegrity = checkIntegrity;
+        return this;
+    }
+
     public void loadMultiple(String... uris) {
         MultiFileLoadRequest[] loadRequestArr = new MultiFileLoadRequest[uris.length];
         for (int i = 0; i < uris.length; i++) {
             MultiFileLoadRequest loadRequest = new MultiFileLoadRequest(uris[i], directoryName, directoryType, forceLoadFromNetwork);
             loadRequest.setAutoRefresh(autoRefresh);
+            loadRequest.setCheckIntegrity(checkIntegrity);
             loadRequestArr[i] = loadRequest;
         }
         multiFileDownloadTask = new MultiFileDownloadTask(context, listener);
@@ -66,6 +73,7 @@ public void loadMultiple(boolean forceLoadFromNetwork, List<MultiFileLoadRequest
         for (int i = 0; i < multiFileLoadRequestList.size(); i++) {
             loadRequestArr[i] = multiFileLoadRequestList.get(i);
             loadRequestArr[i].setAutoRefresh(autoRefresh);
+            loadRequestArr[i].setCheckIntegrity(checkIntegrity);
         }
         multiFileDownloadTask = new MultiFileDownloadTask(context, listener);
         multiFileDownloadTask.executeOnExecutor(Utils.getThreadPoolExecutor(), loadRequestArr);
diff --git a/fileloader/src/main/java/com/krishna/fileloader/network/FileDownloader.java b/fileloader/src/main/java/com/krishna/fileloader/network/FileDownloader.java
@@ -2,9 +2,12 @@
 
 import android.content.Context;
 import android.support.annotation.WorkerThread;
+import android.text.TextUtils;
+import android.util.Log;
 
 import com.krishna.fileloader.BuildConfig;
 import com.krishna.fileloader.utility.AndroidFileManager;
+import com.krishna.fileloader.utility.MD5;
 import com.krishna.fileloader.utility.Utils;
 
 import java.io.File;
@@ -23,6 +26,7 @@
  */
 
 public class FileDownloader {
+    private static final String TAG = "FileDownloader";
     private String uri;
     private String dirName;
     private int dirType;
@@ -54,7 +58,7 @@ private void initHttpClient() {
     }
 
     @WorkerThread
-    public File download(boolean autoRefresh) throws Exception {
+    public File download(boolean autoRefresh, boolean checkIntegrity) throws Exception {
         Request.Builder requestBuilder = new Request.Builder().url(uri);
 
         //if auto-refresh is enabled then add header "If-Modified-Since" to the request and send last modified time of local file
@@ -90,12 +94,31 @@ public File download(boolean autoRefresh) throws Exception {
         sink.close();
 
         //check if downloaded file is not corrupt
-        if (readBytes < response.body().contentLength()) {
+        int contentLength = 0;
+        try {
+            contentLength = Integer.parseInt(response.header("Content-Length", ""));
+        } catch (NumberFormatException e) {
+            e.printStackTrace();
+        }
+        if (readBytes < contentLength) {
             //delete the corrupt file
             downloadFilePath.delete();
+            Log.i(TAG, "downloaded file is corrupt: " + request.url());
             throw new IOException("Failed to download file: " + response);
         }
 
+        if (checkIntegrity) {
+            String eTag = response.header("ETag", "").replaceAll("\"", "").trim();
+            if (!TextUtils.isEmpty(eTag)) {
+                if (!MD5.checkMD5(eTag, downloadFilePath)) {
+                    //delete the corrupt file
+                    downloadFilePath.delete();
+                    Log.i(TAG, "checksum did not match: " + request.url());
+                    throw new IOException("Failed to download file: " + response);
+                }
+            }
+        }
+
         //set server Last-Modified time to file. send this time to server on next request.
         long timeStamp = Utils.parseLastModifiedHeader(response.header("Last-Modified"));
         if (timeStamp > 0) {
diff --git a/fileloader/src/main/java/com/krishna/fileloader/request/FileLoadRequest.java b/fileloader/src/main/java/com/krishna/fileloader/request/FileLoadRequest.java
@@ -29,6 +29,7 @@ public class FileLoadRequest {
     private Class requestClass;
     private boolean forceLoadFromNetwork;
     private boolean autoRefresh;
+    private boolean checkIntegrity;
     private FileRequestListener requestListener;
 
     public FileLoadRequest(String uri, String directoryName, int directoryType, int fileType, Class requestClass, String fileExtension, boolean forceLoadFromNetwork, FileRequestListener listener) {
@@ -42,9 +43,10 @@ public FileLoadRequest(String uri, String directoryName, int directoryType, int
         this.requestListener = listener;
     }
 
-    public FileLoadRequest(String uri, String directoryName, int directoryType, int fileType, Class requestClass, String fileExtension, boolean forceLoadFromNetwork, boolean autoRefresh, FileRequestListener listener) {
+    public FileLoadRequest(String uri, String directoryName, int directoryType, int fileType, Class requestClass, String fileExtension, boolean forceLoadFromNetwork, boolean autoRefresh, boolean checkIntegrity, FileRequestListener listener) {
         this(uri, directoryName, directoryType, fileType, requestClass, fileExtension, forceLoadFromNetwork, listener);
         this.autoRefresh = autoRefresh;
+        this.checkIntegrity = checkIntegrity;
     }
 
     public FileLoadRequest(String uri, String directoryName, int directoryType) {
@@ -125,6 +127,14 @@ public void setAutoRefresh(boolean autoRefresh) {
         this.autoRefresh = autoRefresh;
     }
 
+    public boolean isCheckIntegrity() {
+        return checkIntegrity;
+    }
+
+    public void setCheckIntegrity(boolean checkIntegrity) {
+        this.checkIntegrity = checkIntegrity;
+    }
+
     @Override
     public boolean equals(Object o) {
         if (this == o) return true;
diff --git a/fileloader/src/main/java/com/krishna/fileloader/request/MultiFileLoadRequest.java b/fileloader/src/main/java/com/krishna/fileloader/request/MultiFileLoadRequest.java
@@ -10,6 +10,7 @@ public class MultiFileLoadRequest {
     private int directoryType;
     private boolean forceLoadFromNetwork;
     private boolean autoRefresh;
+    private boolean checkIntegrity;
 
     /**
      * @param uri                  Url of the image to download (ex. https://images.pexels.com/photos/45170/kittens-cat-cat-puppy-rush-45170.jpeg)
@@ -63,4 +64,12 @@ public boolean isAutoRefresh() {
     public void setAutoRefresh(boolean autoRefresh) {
         this.autoRefresh = autoRefresh;
     }
+
+    public boolean isCheckIntegrity() {
+        return checkIntegrity;
+    }
+
+    public void setCheckIntegrity(boolean checkIntegrity) {
+        this.checkIntegrity = checkIntegrity;
+    }
 }
diff --git a/fileloader/src/main/java/com/krishna/fileloader/utility/MD5.java b/fileloader/src/main/java/com/krishna/fileloader/utility/MD5.java
@@ -0,0 +1,75 @@
+package com.krishna.fileloader.utility;
+
+import android.text.TextUtils;
+import android.util.Log;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.io.InputStream;
+import java.math.BigInteger;
+import java.security.MessageDigest;
+import java.security.NoSuchAlgorithmException;
+
+public class MD5 {
+    private static final String TAG = "MD5";
+
+    public static boolean checkMD5(String md5, File updateFile) {
+        if (TextUtils.isEmpty(md5) || updateFile == null) {
+            Log.e(TAG, "MD5 string empty or updateFile null");
+            return false;
+        }
+
+        String calculatedDigest = calculateMD5(updateFile);
+        if (calculatedDigest == null) {
+            Log.e(TAG, "calculatedDigest null");
+            return false;
+        }
+
+        Log.v(TAG, "Calculated digest: " + calculatedDigest);
+        Log.v(TAG, "Provided digest: " + md5);
+
+        return calculatedDigest.equalsIgnoreCase(md5);
+    }
+
+    public static String calculateMD5(File updateFile) {
+        MessageDigest digest;
+        try {
+            digest = MessageDigest.getInstance("MD5");
+        } catch (NoSuchAlgorithmException e) {
+            Log.e(TAG, "Exception while getting digest", e);
+            return null;
+        }
+
+        InputStream is;
+        try {
+            is = new FileInputStream(updateFile);
+        } catch (FileNotFoundException e) {
+            Log.e(TAG, "Exception while getting FileInputStream", e);
+            return null;
+        }
+
+        byte[] buffer = new byte[8192];
+        int read;
+        try {
+            while ((read = is.read(buffer)) > 0) {
+                digest.update(buffer, 0, read);
+            }
+            byte[] md5sum = digest.digest();
+            BigInteger bigInt = new BigInteger(1, md5sum);
+            String output = bigInt.toString(16);
+            // Fill to 32 chars
+            output = String.format("%32s", output).replace(' ', '0');
+            return output;
+        } catch (IOException e) {
+            throw new RuntimeException("Unable to process file for MD5", e);
+        } finally {
+            try {
+                is.close();
+            } catch (IOException e) {
+                Log.e(TAG, "Exception on closing MD5 input stream", e);
+            }
+        }
+    }
+}
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,6 +1,6 @@
-#Wed Nov 08 21:32:47 IST 2017
+#Thu Aug 16 20:46:08 IST 2018
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-4.1-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-4.4-all.zip

Original file line number	Diff line number	Diff line change
`@@ -2,20 +2,20 @@`
`2`	`2`
`3`	`3`	`buildscript {`
`4`	`4`	`repositories {`
`5`		`- jcenter()`
`6`	`5`	`google()`
	`6`	`+ jcenter()`
`7`	`7`	`}`
`8`	`8`	`dependencies {`
`9`		`- classpath 'com.android.tools.build:gradle:3.0.0'`
	`9`	`+ classpath 'com.android.tools.build:gradle:3.1.4'`
`10`	`10`	`// NOTE: Do not place your application dependencies here; they belong`
`11`	`11`	`// in the individual module build.gradle files`
`12`	`12`	`}`
`13`	`13`	`}`
`14`	`14`
`15`	`15`	`allprojects {`
`16`	`16`	`repositories {`
`17`		`- jcenter()`
`18`	`17`	`google()`
	`18`	`+ jcenter()`
`19`	`19`	`maven { url 'https://jitpack.io' }`
`20`	`20`	`}`
`21`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -263,7 +263,7 @@ protected DownloadResponse doInBackground(Void... voids) {`
`263`	`263`	`if (loadedFile == null \|\| !loadedFile.exists()) {`
`264`	`264`	`//download from internet`
`265`	`265`	`FileDownloader downloader = new FileDownloader(context, fileLoadRequest.getUri(), fileLoadRequest.getDirectoryName(), fileLoadRequest.getDirectoryType());`
`266`		`- loadedFile = downloader.download(fileLoadRequest.isAutoRefresh());`
	`266`	`+ loadedFile = downloader.download(fileLoadRequest.isAutoRefresh(), fileLoadRequest.isCheckIntegrity());`
`267`	`267`	`}`
`268`	`268`	`downloadResponse.setDownloadedFile(loadedFile);`
`269`	`269`	`} catch (Exception e) {`