react-native-blob-util 0.14.0 → 0.16.0

package/README.md

@@ -303,6 +303,26 @@ ReactNativeBlobUtil
 
 **These files won't be removed automatically, please refer to [Cache File Management](#user-content-cache-file-management)**
 
+**Use File Transformer**
+
+If you need to perform any processing on the bytes prior to it being written into storage (e.g. if you want it to be encrypted) then you can use `transform` option.  NOTE: you will need to set a transformer on the libray (see [Setting a File Transformer](#Setting-A-File-Transformer))
+
+```js
+ReactNativeBlobUtil
+        .config({
+            // response data will be saved to this path if it has access right.
+            path: dirs.DocumentDir + '/path-to-file.anything',
+            transform: true
+        })
+        .fetch('GET', 'http://www.example.com/file/example.zip', {
+            //some headers ..
+        })
+        .then((res) => {
+            // the path should be dirs.DocumentDir + 'path-to-file.anything'
+            console.log('The file saved to ', res.path())
+        })
+```
+
 #### Upload example : Dropbox [files-upload](https://www.dropbox.com/developers/documentation/http/documentation#files-upload) API
 
 `react-native-blob-util` will convert the base64 string in `body` to binary format using native API, this process is done in a separated thread so that it won't block your GUI.
@@ -676,6 +696,14 @@ await ReactNativeBlobUtil.MediaCollection.writeToMediafile('content://....', //
 );
 ````
 
+Copies and tranforms data from a file in the apps storage to an existing entry of the Media Store. NOTE: you must set a transformer on the file in order for the transformation to happen (see [Setting a File Transformer](#Setting-A-File-Transformer)).
+
+````js
+await ReactNativeBlobUtil.MediaCollection.writeToMediafileWithTransform('content://....', // content uri of the entry in the media storage
+        localpath // path to the file that should be copied
+);
+````
+
 #### copyToInternal
 Copies an entry form the media storage to the apps internal storage.
 ````js
@@ -697,8 +725,10 @@ File Access APIs
 - [dirs](https://github.com/RonRadtke/react-native-blob-util/wiki/File-System-Access-API#dirs)
 - [createFile](https://github.com/RonRadtke/react-native-blob-util/wiki/File-System-Access-API#createfilepath-data-encodingpromise)
 - [writeFile (0.6.0)](https://github.com/RonRadtke/react-native-blob-util/wiki/File-System-Access-API#writefilepathstring-contentstring--array-encodingstring-appendbooleanpromise)
+- writeFileWithTransform
 - [appendFile (0.6.0) ](https://github.com/RonRadtke/react-native-blob-util/wiki/File-System-Access-API#appendfilepathstring-contentstring--arraynumber-encodingstring-promisenumber)
 - [readFile (0.6.0)](https://github.com/RonRadtke/react-native-blob-util/wiki/File-System-Access-API#readfilepath-encodingpromise)
+- readFileWithTransform
 - [readStream](https://github.com/RonRadtke/react-native-blob-util/wiki/File-System-Access-API#readstreampath-encoding-buffersize-interval-promisernfbreadstream)
 - [hash (0.10.9)](https://github.com/RonRadtke/react-native-blob-util/wiki/File-System-Access-API#hashpath-algorithm-promise)
 - [writeStream](https://github.com/RonRadtke/react-native-blob-util/wiki/File-System-Access-API#writestreampathstring-encodingstringpromise)
@@ -878,6 +908,30 @@ ReactNativeBlobUtil.fetch('POST', 'http://example.com/upload', {'Transfer-Encodi
 ### Self-Signed SSL Server
 
 By default, react-native-blob-util does NOT allow connection to unknown certification provider since it's dangerous. To connect a server with self-signed certification, you need to add `trusty` to `config` explicitly. This function is available for version >= `0.5.3`
+In addition since ``0.16.0`` you'll have to define your own trust manager for android.
+````java
+public class MainApplication extends Application implements ReactApplication {
+    ...
+    @Override
+    public void onCreate() {
+       ...
+        ReactNativeBlobUtilUtils.sharedTrustManager = final X509TrustManager x509TrustManager = new X509TrustManager() {
+                @Override
+                public void checkClientTrusted(java.security.cert.X509Certificate[] chain, String authType) throws CertificateException {
+                }
+
+                @Override
+                public void checkServerTrusted(java.security.cert.X509Certificate[] chain, String authType) throws CertificateException {
+                }
+
+                @Override
+                public java.security.cert.X509Certificate[] getAcceptedIssuers() {
+                    return new java.security.cert.X509Certificate[]{};
+                }
+        };
+        ...
+    }
+````
 
 ```js
 ReactNativeBlobUtil.config({
@@ -903,6 +957,10 @@ ReactNativeBlobUtil.config({
         })
 ```
 
+### Transform Files
+
+Sometimes you may need the files to be transformed after reading from storage or before writing into storage (eg encryption/decyrption). In order to perform the transformations, use `readFileWithTransform` and `writeFileWithTransform`. NOTE: you must set a transformer on the file in order for the transformation to happen (see [Setting a File Transformer](#Setting-A-File-Transformer)).
+
 ## Web API Polyfills
 
 After `0.8.0` we've made some [Web API polyfills](https://github.com/RonRadtke/react-native-blob-util/wiki/Web-API-Polyfills-(experimental)) that makes some browser-based library available in RN.
@@ -910,6 +968,48 @@ After `0.8.0` we've made some [Web API polyfills](https://github.com/RonRadtke/r
 - Blob
 - XMLHttpRequest (Use our implementation if you're going to use it with Blob)
 
+
+## Setting A File Transformer
+
+Setting a file transformer will allow you to specify how data should be transformed whenever the library is writing into storage or reading from storage. A use case for this is if you want the files handled by this library to be encrypted. 
+
+If you want to use a file transformer, you must implement an interface defined in:
+
+[ReactNativeBlobUtilFileTransformer.h (iOS)](/ios/ReactNativeBlobUtilFileTransformer.h)
+
+[ReactNativeBlobUtilFileTransformer.java (Android)](/android/src/main/java/com/ReactNativeBlobUtil/ReactNativeBlobUtilFileTransformer.java)
+
+Then you set the File Transformer during app startup
+
+Android:
+```java
+public class MainApplication extends Application implements ReactApplication {
+    ...
+    @Override
+    public void onCreate() {
+       ...
+       ReactNativeBlobUtilFileTransformer.sharedFileTransformer = new MyCustomEncryptor(); 
+       ...
+    }
+```
+
+iOS:
+```m
+@implementation AppDelegate
+...
+- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
+{
+    ...
+    [ReactNativeBlobUtilFileTransformer setFileTransformer: MyCustomEncryptor.new];
+    ...
+}
+```
+
+Here are the places where the transformer would apply 
+- Reading a file from the file system  
+- Writing a file into the file system
+- Http response is downloaded to storage directly
+
 ## Performance Tips
 
 **Read Stream and Progress Event Overhead**

package/android/src/main/AndroidManifest.xml

@@ -1,9 +1,6 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
     package="com.ReactNativeBlobUtil">
 
-    <!-- Required to access Google Play Licensing -->
-    <uses-permission android:name="com.android.vending.CHECK_LICENSE" />
-
     <!-- Required to download files from Google Play -->
     <uses-permission android:name="android.permission.INTERNET" />
 

package/android/src/main/java/com/ReactNativeBlobUtil/ReactNativeBlobUtil.java

@@ -233,11 +233,11 @@ public class ReactNativeBlobUtil extends ReactContextBaseJavaModule {
     }
 
     @ReactMethod
-    public void readFile(final String path, final String encoding, final Promise promise) {
+    public void readFile(final String path, final String encoding, final boolean transformFile, final Promise promise) {
         threadPool.execute(new Runnable() {
             @Override
             public void run() {
-                ReactNativeBlobUtilFS.readFile(path, encoding, promise);
+                ReactNativeBlobUtilFS.readFile(path, encoding, transformFile, promise);
             }
         });
     }
@@ -253,11 +253,11 @@ public class ReactNativeBlobUtil extends ReactContextBaseJavaModule {
     }
 
     @ReactMethod
-    public void writeFile(final String path, final String encoding, final String data, final boolean append, final Promise promise) {
+    public void writeFile(final String path, final String encoding, final String data, final boolean transformFile, final boolean append, final Promise promise) {
         threadPool.execute(new Runnable() {
             @Override
             public void run() {
-                ReactNativeBlobUtilFS.writeFile(path, encoding, data, append, promise);
+                ReactNativeBlobUtilFS.writeFile(path, encoding, data, transformFile, append, promise);
             }
         });
     }
@@ -432,29 +432,29 @@ public class ReactNativeBlobUtil extends ReactContextBaseJavaModule {
         if (mt == null) promise.reject("ReactNativeBlobUtil.createMediaFile", "invalid mediatype");
 
         FileDescription file = new FileDescription(filedata.getString("name"), filedata.getString("mimeType"), filedata.getString("parentFolder"));
-        Uri res = ReactNativeBlobUtilMediaCollection.createNewMediaFile(file, ReactNativeBlobUtilMediaCollection.MediaType.valueOf(mt));
+        Uri res = ReactNativeBlobUtilMediaCollection.createNewMediaFile(file, ReactNativeBlobUtilMediaCollection.MediaType.valueOf(mt), this.getReactApplicationContext());
         if (res != null) promise.resolve(res.toString());
         else promise.reject("ReactNativeBlobUtil.createMediaFile", "File could not be created");
     }
 
-    @RequiresApi(api = Build.VERSION_CODES.Q)
     @ReactMethod
-    public void writeToMediaFile(String fileUri, String path, Promise promise) {
-        boolean res = ReactNativeBlobUtilMediaCollection.writeToMediaFile(Uri.parse(fileUri), path, promise);
+    public void writeToMediaFile(String fileUri, String path, boolean transformFile, Promise promise) {
+        boolean res = ReactNativeBlobUtilMediaCollection.writeToMediaFile(Uri.parse(fileUri), path, transformFile, promise);
         if(res) promise.resolve("Success");
     }
 
+    @RequiresApi(api = Build.VERSION_CODES.Q)
     @ReactMethod
     public void copyToInternal(String contentUri, String destpath, Promise promise) {
         ReactNativeBlobUtilMediaCollection.copyToInternal(Uri.parse(contentUri), destpath, promise);
     }
 
+    @RequiresApi(api = Build.VERSION_CODES.Q)
     @ReactMethod
     public void getBlob(String contentUri, String encoding, Promise promise) {
         ReactNativeBlobUtilMediaCollection.getBlob(Uri.parse(contentUri), encoding, promise);
     }
 
-    @RequiresApi(api = Build.VERSION_CODES.Q)
     @ReactMethod
     public void copyToMediaStore(ReadableMap filedata, String mt, String path, Promise promise) {
         if (!(filedata.hasKey("name") && filedata.hasKey("parentFolder") && filedata.hasKey("mimeType"))) {
@@ -471,15 +471,14 @@ public class ReactNativeBlobUtil extends ReactContextBaseJavaModule {
         }
 
         FileDescription file = new FileDescription(filedata.getString("name"), filedata.getString("mimeType"), filedata.getString("parentFolder"));
-        Uri fileuri = ReactNativeBlobUtilMediaCollection.createNewMediaFile(file, ReactNativeBlobUtilMediaCollection.MediaType.valueOf(mt));
+        Uri fileuri = ReactNativeBlobUtilMediaCollection.createNewMediaFile(file, ReactNativeBlobUtilMediaCollection.MediaType.valueOf(mt), this.getReactApplicationContext());
 
         if (fileuri == null) {
             promise.reject("ReactNativeBlobUtil.createMediaFile", "File could not be created");
             return;
         }
 
-        boolean res = ReactNativeBlobUtilMediaCollection.writeToMediaFile(fileuri, path, promise);
-
+        boolean res = ReactNativeBlobUtilMediaCollection.writeToMediaFile(fileuri, path, false, promise);
         if(res) promise.resolve(fileuri.toString());
     }
 

package/android/src/main/java/com/ReactNativeBlobUtil/ReactNativeBlobUtilBody.java

@@ -26,7 +26,6 @@ import okio.BufferedSink;
 
 class ReactNativeBlobUtilBody extends RequestBody {
 
-    private InputStream requestStream;
     private long contentLength = 0;
     private ReadableArray form;
     private String mTaskId;
@@ -71,12 +70,10 @@ class ReactNativeBlobUtilBody extends RequestBody {
         try {
             switch (requestType) {
                 case SingleFile:
-                    requestStream = getRequestStream();
-                    contentLength = requestStream.available();
+                    contentLength = getRequestStream().available();
                     break;
                 case AsIs:
                     contentLength = this.rawBody.getBytes().length;
-                    requestStream = new ByteArrayInputStream(this.rawBody.getBytes());
                     break;
                 case Others:
                     break;
@@ -98,7 +95,6 @@ class ReactNativeBlobUtilBody extends RequestBody {
         this.form = body;
         try {
             bodyCache = createMultipartBodyCache();
-            requestStream = new FileInputStream(bodyCache);
             contentLength = bodyCache.length();
         } catch (Exception ex) {
             ex.printStackTrace();
@@ -107,6 +103,34 @@ class ReactNativeBlobUtilBody extends RequestBody {
         return this;
     }
 
+    // This organizes the input stream initialization logic into a method. This allows:
+    // 1) Initialization to be deferred until it's needed (when we are ready to pipe it into the BufferedSink)
+    // 2) The stream to be initialized and used as many times as necessary. When okhttp runs into
+    //    a connection error, it will retry the request which will require a new stream to write into
+    //    the sink once again.
+    InputStream getInputStreamForRequestBody() {
+        try {
+            if (this.form != null) {
+                return new FileInputStream(bodyCache);
+            } else {
+                switch (requestType) {
+                    case SingleFile:
+                        return getRequestStream();
+                    case AsIs:
+                        return new ByteArrayInputStream(this.rawBody.getBytes());
+                    case Others:
+                        ReactNativeBlobUtilUtils.emitWarningEvent("ReactNativeBlobUtil could not create input stream for request type others");
+                        break;
+                }
+            }
+        } catch (Exception ex){
+            ex.printStackTrace();
+            ReactNativeBlobUtilUtils.emitWarningEvent("ReactNativeBlobUtil failed to create input stream for request:" + ex.getLocalizedMessage());
+        }
+
+        return null;
+    }
+
     @Override
     public long contentLength() {
         return chunkedEncoding ? -1 : contentLength;
@@ -120,7 +144,7 @@ class ReactNativeBlobUtilBody extends RequestBody {
     @Override
     public void writeTo(@NonNull BufferedSink sink) {
         try {
-            pipeStreamToSink(requestStream, sink);
+            pipeStreamToSink(getInputStreamForRequestBody(), sink);
         } catch (Exception ex) {
             ReactNativeBlobUtilUtils.emitWarningEvent(ex.getLocalizedMessage());
             ex.printStackTrace();

package/android/src/main/java/com/ReactNativeBlobUtil/ReactNativeBlobUtilConfig.java

@@ -8,6 +8,7 @@ import java.util.Locale;
 class ReactNativeBlobUtilConfig {
 
     public Boolean fileCache;
+    public Boolean transformFile;
     public String path;
     public String appendExt;
     public ReadableMap addAndroidDownloads;
@@ -26,6 +27,7 @@ class ReactNativeBlobUtilConfig {
         if (options == null)
             return;
         this.fileCache = options.hasKey("fileCache") && options.getBoolean("fileCache");
+        this.transformFile = options.hasKey("transformFile") ? options.getBoolean("transformFile") : false;
         this.path = options.hasKey("path") ? options.getString("path") : null;
         this.appendExt = options.hasKey("appendExt") ? options.getString("appendExt") : "";
         this.trusty = options.hasKey("trusty") && options.getBoolean("trusty");

package/android/src/main/java/com/ReactNativeBlobUtil/ReactNativeBlobUtilFS.java

@@ -44,6 +44,76 @@ class ReactNativeBlobUtilFS {
         this.emitter = ctx.getJSModule(DeviceEventManagerModule.RCTDeviceEventEmitter.class);
     }
 
+    /**
+     * Write string with encoding to file (used for mediastore)
+     *
+     * @param path     Destination file path.
+     * @param encoding Encoding of the string.
+     * @param data     Array passed from JS context.
+     */
+    static boolean writeFile(String path, String encoding, String data, final boolean append) {
+        try {
+            int written;
+            path = ReactNativeBlobUtilUtils.normalizePath(path);
+            File f = new File(path);
+            File dir = f.getParentFile();
+            if (!f.exists()) {
+                if (dir != null && !dir.exists()) {
+                    if (!dir.mkdirs() && !dir.exists()) {
+                        return false;
+                    }
+                }
+                if (!f.createNewFile()) {
+                    return false;
+                }
+            }
+
+            // write data from a file
+            if (encoding.equalsIgnoreCase(ReactNativeBlobUtilConst.DATA_ENCODE_URI)) {
+                String normalizedData = ReactNativeBlobUtilUtils.normalizePath(data);
+                File src = new File(normalizedData);
+                if (!src.exists()) {
+                    return false;
+                }
+                byte[] buffer = new byte[10240];
+                int read;
+                written = 0;
+                FileInputStream fin = null;
+                FileOutputStream fout = null;
+                try {
+                    fin = new FileInputStream(src);
+                    fout = new FileOutputStream(f, append);
+                    while ((read = fin.read(buffer)) > 0) {
+                        fout.write(buffer, 0, read);
+                        written += read;
+                    }
+                } finally {
+                    if (fin != null) {
+                        fin.close();
+                    }
+                    if (fout != null) {
+                        fout.close();
+                    }
+                }
+            } else {
+                byte[] bytes = ReactNativeBlobUtilUtils.stringToBytes(data, encoding);
+                FileOutputStream fout = new FileOutputStream(f, append);
+                try {
+                    fout.write(bytes);
+                    written = bytes.length;
+                } finally {
+                    fout.close();
+                }
+            }
+            return true;
+        } catch (FileNotFoundException e) {
+            // According to https://docs.oracle.com/javase/7/docs/api/java/io/FileOutputStream.html
+            return false;
+        } catch (Exception e) {
+            return false;
+        }
+    }
+
     /**
      * Write string with encoding to file
      *
@@ -52,12 +122,11 @@ class ReactNativeBlobUtilFS {
      * @param data     Array passed from JS context.
      * @param promise  RCT Promise
      */
-    static void writeFile(String path, String encoding, String data, final boolean append, final Promise promise) {
+    static void writeFile(String path, String encoding, String data, final boolean transformFile, final boolean append, final Promise promise) {
         try {
             int written;
             File f = new File(path);
             File dir = f.getParentFile();
-
             if (!f.exists()) {
                 if (dir != null && !dir.exists()) {
                     if (!dir.mkdirs() && !dir.exists()) {
@@ -101,6 +170,12 @@ class ReactNativeBlobUtilFS {
                 }
             } else {
                 byte[] bytes = ReactNativeBlobUtilUtils.stringToBytes(data, encoding);
+                if (transformFile) {
+                    if (ReactNativeBlobUtilFileTransformer.sharedFileTransformer == null) {
+                        throw new IllegalStateException("Write file with transform was specified but the shared file transformer is not set");
+                    }
+                    bytes = ReactNativeBlobUtilFileTransformer.sharedFileTransformer.onWriteFile(bytes);
+                }
                 FileOutputStream fout = new FileOutputStream(f, append);
                 try {
                     fout.write(bytes);
@@ -169,7 +244,7 @@ class ReactNativeBlobUtilFS {
      * @param encoding Encoding of read stream.
      * @param promise  JS promise
      */
-    static void readFile(String path, String encoding, final Promise promise) {
+    static void readFile(String path, String encoding, final boolean transformFile, final Promise promise) {
         String resolved = ReactNativeBlobUtilUtils.normalizePath(path);
         if (resolved != null)
             path = resolved;
@@ -212,6 +287,13 @@ class ReactNativeBlobUtilFS {
                 return;
             }
 
+            if (transformFile) {
+                if (ReactNativeBlobUtilFileTransformer.sharedFileTransformer == null) {
+                    throw new IllegalStateException("Read file with transform was specified but the shared file transformer is not set");
+                }
+                bytes = ReactNativeBlobUtilFileTransformer.sharedFileTransformer.onReadFile(bytes);
+            }
+
             switch (encoding.toLowerCase(Locale.ROOT)) {
                 case "base64":
                     promise.resolve(Base64.encodeToString(bytes, Base64.NO_WRAP));
@@ -373,6 +455,7 @@ class ReactNativeBlobUtilFS {
      * @param promise JS promise
      */
     static void mkdir(String path, Promise promise) {
+        path = ReactNativeBlobUtilUtils.normalizePath(path);
         File dest = new File(path);
         if (dest.exists()) {
             promise.reject("EEXIST", (dest.isDirectory() ? "Folder" : "File") + " '" + path + "' already exists");
@@ -400,6 +483,7 @@ class ReactNativeBlobUtilFS {
      */
     static void cp(String path, String dest, Callback callback) {
         path = ReactNativeBlobUtilUtils.normalizePath(path);
+        dest = ReactNativeBlobUtilUtils.normalizePath(dest);
         InputStream in = null;
         OutputStream out = null;
         String message = "";
@@ -456,6 +540,8 @@ class ReactNativeBlobUtilFS {
      * @param callback JS context callback
      */
     static void mv(String path, String dest, Callback callback) {
+        path = ReactNativeBlobUtilUtils.normalizePath(path);
+        dest = ReactNativeBlobUtilUtils.normalizePath(dest);
         File src = new File(path);
         if (!src.exists()) {
             callback.invoke("Source file at path `" + path + "` does not exist");
@@ -559,6 +645,7 @@ class ReactNativeBlobUtilFS {
     static void slice(String path, String dest, int start, int end, String encode, Promise promise) {
         try {
             path = ReactNativeBlobUtilUtils.normalizePath(path);
+            dest = ReactNativeBlobUtilUtils.normalizePath(dest);
             File source = new File(path);
             if (source.isDirectory()) {
                 promise.reject("EISDIR", "Expecting a file but '" + path + "' is a directory");
@@ -722,6 +809,8 @@ class ReactNativeBlobUtilFS {
                 promise.reject("EINVAL", "Invalid algorithm '" + algorithm + "', must be one of md5, sha1, sha224, sha256, sha384, sha512");
                 return;
             }
+            
+            path = ReactNativeBlobUtilUtils.normalizePath(path);
 
             File file = new File(path);
 
@@ -769,6 +858,7 @@ class ReactNativeBlobUtilFS {
      */
     static void createFile(String path, String data, String encoding, Promise promise) {
         try {
+            path = ReactNativeBlobUtilUtils.normalizePath(path);
             File dest = new File(path);
             boolean created = dest.createNewFile();
             if (encoding.equals(ReactNativeBlobUtilConst.DATA_ENCODE_URI)) {
@@ -811,6 +901,7 @@ class ReactNativeBlobUtilFS {
      */
     static void createFileASCII(String path, ReadableArray data, Promise promise) {
         try {
+            path = ReactNativeBlobUtilUtils.normalizePath(path);
             File dest = new File(path);
             boolean created = dest.createNewFile();
             if (!created) {

package/android/src/main/java/com/ReactNativeBlobUtil/ReactNativeBlobUtilFileTransformer.java

@@ -0,0 +1,10 @@
+package com.ReactNativeBlobUtil;
+
+public class ReactNativeBlobUtilFileTransformer {
+    public interface FileTransformer {
+        public byte[] onWriteFile(byte[] data);
+        public byte[] onReadFile(byte[] data);
+    }
+
+    public static ReactNativeBlobUtilFileTransformer.FileTransformer sharedFileTransformer;
+}