@capgo/capacitor-updater 3.2.0 → 3.3.1

package/README.md

@@ -43,7 +43,7 @@ Create account in [capgo.app](https://capgo.app) and get your [API key](https://
 ```
 - Add to your main code
 ```javascript
-  import { CapacitorUpdater } from 'capacitor-updater'
+  import { CapacitorUpdater } from '@capgo/capacitor-updater'
   CapacitorUpdater.notifyAppReady()
   // To let auto update know you app boot well.
 ```
@@ -53,7 +53,7 @@ Create account in [capgo.app](https://capgo.app) and get your [API key](https://
 - If update fail it will roolback to previous version.
 
 See more there in the [Auto update](
-https://doc.capgo.app/Auto-update-2cf9edda70484d7fa57111ab9c435d08) documentation.
+https://github.com/Cap-go/capacitor-updater/wiki) documentation.
 
 
 ## Manual setup
@@ -64,7 +64,7 @@ install it when user background the app.
 In your main code :
 
 ```javascript
-  import { CapacitorUpdater } from 'capacitor-updater'
+  import { CapacitorUpdater } from '@capgo/capacitor-updater'
   import { SplashScreen } from '@capacitor/splash-screen'
   import { App } from '@capacitor/app'
 
@@ -436,7 +436,7 @@ removeAllListeners() => Promise<void>
 ### Listen to download events
 
 ```javascript
-  import { CapacitorUpdater } from 'capacitor-updater';
+  import { CapacitorUpdater } from '@capgo/capacitor-updater';
 
 CapacitorUpdater.addListener('download', (info: any) => {
   console.log('download was fired', info.percent);

package/android/src/main/java/ee/forgr/capacitor_updater/CapacitorUpdater.java

@@ -45,187 +45,168 @@ interface Callback {
 }
 
 public class CapacitorUpdater {
-    public String statsUrl = "";
+    static final String AB = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
+    static SecureRandom rnd = new SecureRandom();
+    private final String TAG = "Capacitor-updater";
+    private final Context context;
+    private final String basePathHot = "versions";
+    private final SharedPreferences prefs;
+    private final SharedPreferences.Editor editor;
+    private String versionBuild = "";
+    private String versionCode = "";
+    private String versionOs = "";
+
     public String appId = "";
     public String deviceID = "";
-    private String pluginVersion = "3.2.0";
+    public final String pluginVersion = "3.3.1";
+    public String statsUrl = "";
 
+    public CapacitorUpdater (final Context context) throws PackageManager.NameNotFoundException {
+        this.context = context;
+        this.prefs = this.context.getSharedPreferences("CapWebViewSettings", Activity.MODE_PRIVATE);
+        this.editor = this.prefs.edit();
+        this.versionOs = Build.VERSION.RELEASE;
+        this.deviceID = Secure.getString(context.getContentResolver(), Secure.ANDROID_ID);
+        final PackageInfo pInfo = context.getPackageManager().getPackageInfo(context.getPackageName(), 0);
+        this.versionBuild = pInfo.versionName;
+        this.versionCode = Integer.toString(pInfo.versionCode);
+    }
 
-    private FilenameFilter filter = new FilenameFilter() {
+    private final FilenameFilter filter = new FilenameFilter() {
         @Override
-        public boolean accept(File f, String name) {
+        public boolean accept(final File f, final String name) {
             // ignore directories generated by mac os x
             return !name.startsWith("__MACOSX") && !name.startsWith(".") && !name.startsWith(".DS_Store");
         }
     };
-    private final CapacitorUpdaterPlugin plugin;
-    private String versionBuild = "";
-    private String versionCode = "";
-    private String versionOs = "";
-    private String TAG = "Capacitor-updater";
-    private Context context;
-    private String basePathHot = "versions";
-    private SharedPreferences prefs;
-    private SharedPreferences.Editor editor;
-
-    static final String AB = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
-    static SecureRandom rnd = new SecureRandom();
 
-    private int calcTotalPercent(int percent, int min, int max) {
+    private int calcTotalPercent(final int percent, final int min, final int max) {
         return (percent * (max - min)) / 100 + min;
     }
 
-    private String randomString(int len){
-        StringBuilder sb = new StringBuilder(len);
+    void notifyDownload(final int percent) {
+        return;
+    }
+
+    private String randomString(final int len){
+        final StringBuilder sb = new StringBuilder(len);
         for(int i = 0; i < len; i++)
             sb.append(AB.charAt(rnd.nextInt(AB.length())));
         return sb.toString();
     }
-    public CapacitorUpdater (Context context) throws PackageManager.NameNotFoundException {
-        this.context = context;
-        this.plugin = new CapacitorUpdaterPlugin();
-        this.prefs = context.getSharedPreferences("CapWebViewSettings", Activity.MODE_PRIVATE);
-        this.editor = prefs.edit();
-        this.versionOs = Build.VERSION.RELEASE;
-        this.deviceID = Secure.getString(context.getContentResolver(), Secure.ANDROID_ID);
-        PackageInfo pInfo = context.getPackageManager().getPackageInfo(context.getPackageName(), 0);
-        this.versionBuild = pInfo.versionName;
-        this.versionCode = Integer.toString(pInfo.versionCode);
-    }
-    public CapacitorUpdater (Context context, CapacitorUpdaterPlugin plugin) throws PackageManager.NameNotFoundException {
-        this.context = context;
-        this.plugin = plugin;
-        this.prefs = context.getSharedPreferences("CapWebViewSettings", Activity.MODE_PRIVATE);
-        this.editor = prefs.edit();
-        this.versionOs = Build.VERSION.RELEASE;
-        this.deviceID = Secure.getString(context.getContentResolver(), Secure.ANDROID_ID);
-        PackageInfo pInfo = context.getPackageManager().getPackageInfo(context.getPackageName(), 0);
-        this.versionBuild = pInfo.versionName;
-        this.versionCode = Integer.toString(pInfo.versionCode);
-    }
-
-    private Boolean unzip(String source, String dest) {
-        File zipFile = new File(this.context.getFilesDir()  + "/" + source);
-        File targetDirectory = new File(this.context.getFilesDir()  + "/" + dest);
-        ZipInputStream zis = null;
+    private File unzip(final File zipFile, final String dest) throws IOException {
+        final File targetDirectory = new File(this.context.getFilesDir()  + "/" + dest);
+        final ZipInputStream zis = new ZipInputStream(new BufferedInputStream(new FileInputStream(zipFile)));
         try {
-            zis = new ZipInputStream(
-                    new BufferedInputStream(new FileInputStream(zipFile)));
-        } catch (FileNotFoundException e) {
-            e.printStackTrace();
-            return false;
-        }
-        try {
-            ZipEntry ze;
             int count;
-            int buffLength = 8192;
-            byte[] buffer = new byte[buffLength];
-            long totalLength = zipFile.length();
-            long readLength = buffLength;
+            final int bufferSize = 8192;
+            final byte[] buffer = new byte[bufferSize];
+            final long lengthTotal = zipFile.length();
+            long lengthRead = bufferSize;
             int percent = 0;
-            this.plugin.notifyDownload(75);
-            while ((ze = zis.getNextEntry()) != null) {
-                File file = new File(targetDirectory, ze.getName());
-                String canonicalPath = file.getCanonicalPath();
-                String canonicalDir = (new File(String.valueOf(targetDirectory))).getCanonicalPath();
-                File dir = ze.isDirectory() ? file : file.getParentFile();
+            this.notifyDownload(75);
+
+            ZipEntry entry;
+            while ((entry = zis.getNextEntry()) != null) {
+                final File file = new File(targetDirectory, entry.getName());
+                final String canonicalPath = file.getCanonicalPath();
+                final String canonicalDir = (new File(String.valueOf(targetDirectory))).getCanonicalPath();
+                final File dir = entry.isDirectory() ? file : file.getParentFile();
+
                 if (!canonicalPath.startsWith(canonicalDir)) {
                     throw new FileNotFoundException("SecurityException, Failed to ensure directory is the start path : " +
                             canonicalDir + " of " + canonicalPath);
                 }
-                if (!dir.isDirectory() && !dir.mkdirs())
+
+                if (!dir.isDirectory() && !dir.mkdirs()) {
                     throw new FileNotFoundException("Failed to ensure directory: " +
                             dir.getAbsolutePath());
-                if (ze.isDirectory())
+                }
+
+                if (entry.isDirectory()) {
                     continue;
-                FileOutputStream fileOut = new FileOutputStream(file);
-                try {
+                }
+
+                try(final FileOutputStream outputStream = new FileOutputStream(file)) {
                     while ((count = zis.read(buffer)) != -1)
-                        fileOut.write(buffer, 0, count);
-                } finally {
-                    fileOut.close();
+                        outputStream.write(buffer, 0, count);
                 }
-                int newPercent = (int)((readLength * 100) / totalLength);
-                if (totalLength > 1 && newPercent != percent) {
+
+                final int newPercent = (int)((lengthRead * 100) / lengthTotal);
+                if (lengthTotal > 1 && newPercent != percent) {
                     percent = newPercent;
-                    this.plugin.notifyDownload(calcTotalPercent((int)percent, 75, 90));
+                    this.notifyDownload(this.calcTotalPercent(percent, 75, 90));
                 }
-                readLength += ze.getCompressedSize();
+
+                lengthRead += entry.getCompressedSize();
             }
-        } catch (Exception e) {
-            Log.i(TAG, "unzip error", e);
-            return false;
+            return targetDirectory;
         } finally {
             try {
                 zis.close();
-            } catch (IOException e) {
-                e.printStackTrace();
-                return false;
+            } catch (final IOException e) {
+                Log.e(this.TAG, "Failed to close zip input stream", e);
             }
-            return true;
         }
     }
 
-    private Boolean flattenAssets(String source, String dest) {
-        File current = new File(this.context.getFilesDir()  + "/" + source);
-        if (!current.exists()) {
-            return false;
+    private void flattenAssets(final File sourceFile, final String dest) throws IOException {
+        if (!sourceFile.exists()) {
+            throw new FileNotFoundException("Source file not found: " + sourceFile.getPath());
         }
-        File fDest = new File(this.context.getFilesDir()  + "/" + dest);
-        fDest.getParentFile().mkdirs();
-        String[] pathsName = current.list(filter);
-        if (pathsName == null || pathsName.length == 0) {
-            return false;
+        final File destinationFile = new File(this.context.getFilesDir()  + "/" + dest);
+        destinationFile.getParentFile().mkdirs();
+        final String[] entries = sourceFile.list(this.filter);
+        if (entries == null || entries.length == 0) {
+            throw new IOException("Source file was not a directory or was empty: " + sourceFile.getPath());
         }
-        if (pathsName.length == 1 && !pathsName[0].equals("index.html")) {
-            File newFlat =  new File(current.getPath() + "/" + pathsName[0]);
-            newFlat.renameTo(fDest);
+        if (entries.length == 1 && !entries[0].equals("index.html")) {
+            final File child = new File(sourceFile.getPath() + "/" + entries[0]);
+            child.renameTo(destinationFile);
         } else {
-            current.renameTo(fDest);
+            sourceFile.renameTo(destinationFile);
         }
-        current.delete();
-        return true;
+        sourceFile.delete();
     }
 
-    private Boolean downloadFile(String url, String dest) throws JSONException {
-        try {
-            URL u = new URL(url);
-            URLConnection uc = u.openConnection();
-            InputStream is = u.openStream();
-            DataInputStream dis = new DataInputStream(is);
-            long totalLength = uc.getContentLength();
-            int buffLength = 1024;
-            byte[] buffer = new byte[buffLength];
-            int length;
-            File downFile = new File(this.context.getFilesDir()  + "/" + dest);
-            downFile.getParentFile().mkdirs();
-            downFile.createNewFile();
-            FileOutputStream fos = new FileOutputStream(downFile);
-            int readLength = buffLength;
-            int percent = 0;
-            this.plugin.notifyDownload(10);
-            while ((length = dis.read(buffer))>0) {
-                fos.write(buffer, 0, length);
-                int newPercent = (int)((readLength * 100) / totalLength);
-                if (totalLength > 1 && newPercent != percent) {
-                    percent = newPercent;
-                    this.plugin.notifyDownload(calcTotalPercent(percent, 10, 70));
-                }
-                readLength += length;
+    private File downloadFile(final String url, final String dest) throws IOException {
+
+        final URL u = new URL(url);
+        final URLConnection connection = u.openConnection();
+        final InputStream is = u.openStream();
+        final DataInputStream dis = new DataInputStream(is);
+
+        final File target = new File(this.context.getFilesDir()  + "/" + dest);
+        target.getParentFile().mkdirs();
+        target.createNewFile();
+        final FileOutputStream fos = new FileOutputStream(target);
+
+        final long totalLength = connection.getContentLength();
+        final int bufferSize = 1024;
+        final byte[] buffer = new byte[bufferSize];
+        int length;
+
+        int bytesRead = bufferSize;
+        int percent = 0;
+        this.notifyDownload(10);
+        while ((length = dis.read(buffer))>0) {
+            fos.write(buffer, 0, length);
+            final int newPercent = (int)((bytesRead * 100) / totalLength);
+            if (totalLength > 1 && newPercent != percent) {
+                percent = newPercent;
+                this.notifyDownload(this.calcTotalPercent(percent, 10, 70));
             }
-        } catch (Exception e) {
-            Log.e(TAG, "downloadFile error", e);
-            return false;
+            bytesRead += length;
         }
-        return true;
+        return target;
     }
 
-    private void deleteDirectory(File file) throws IOException {
+    private void deleteDirectory(final File file) throws IOException {
         if (file.isDirectory()) {
-            File[] entries = file.listFiles();
+            final File[] entries = file.listFiles();
             if (entries != null) {
-                for (File entry : entries) {
-                    deleteDirectory(entry);
+                for (final File entry : entries) {
+                    this.deleteDirectory(entry);
                 }
             }
         }
@@ -234,100 +215,92 @@ public class CapacitorUpdater {
         }
     }
 
-    public String download(String url) {
-        try {
-            this.plugin.notifyDownload(0);
-            String folderNameZip = this.randomString(10);
-            File fileZip = new File(this.context.getFilesDir()  + "/" + folderNameZip);
-            String folderNameUnZip = this.randomString(10);
-            String version = this.randomString(10);
-            String folderName = basePathHot + "/" + version;
-            this.plugin.notifyDownload(5);
-            Boolean downloaded = this.downloadFile(url, folderNameZip);
-            if(!downloaded) return "";
-            this.plugin.notifyDownload(71);
-            Boolean unzipped = this.unzip(folderNameZip, folderNameUnZip);
-            if(!unzipped) return "";
-            fileZip.delete();
-            this.plugin.notifyDownload(91);
-            Boolean flatt = this.flattenAssets(folderNameUnZip, folderName);
-            if(!flatt) return "";
-            this.plugin.notifyDownload(100);
-            return version;
-        } catch (Exception e) {
-            Log.e(TAG, "updateApp error", e);
-            return "";
-        }
+    public String download(final String url) throws IOException {
+        this.notifyDownload(0);
+        final String path = this.randomString(10);
+        final File zipFile = new File(this.context.getFilesDir()  + "/" + path);
+        final String folderNameUnZip = this.randomString(10);
+        final String version = this.randomString(10);
+        final String folderName = this.basePathHot + "/" + version;
+        this.notifyDownload(5);
+        final File downloaded = this.downloadFile(url, path);
+        this.notifyDownload(71);
+        final File unzipped = this.unzip(downloaded, folderNameUnZip);
+        zipFile.delete();
+        this.notifyDownload(91);
+        this.flattenAssets(unzipped, folderName);
+        this.notifyDownload(100);
+        return version;
     }
 
     public ArrayList<String> list() {
-        ArrayList<String> res = new ArrayList<String>();
-        File destHot = new File(this.context.getFilesDir()  + "/" + basePathHot);
-        Log.i(TAG, "list File : " + destHot.getPath());
+        final ArrayList<String> res = new ArrayList<String>();
+        final File destHot = new File(this.context.getFilesDir()  + "/" + this.basePathHot);
+        Log.i(this.TAG, "list File : " + destHot.getPath());
         if (destHot.exists()) {
-            for (File i : destHot.listFiles()) {
+            for (final File i : destHot.listFiles()) {
                 res.add(i.getName());
             }
         } else {
-            Log.i(TAG, "No version available" + destHot);
+            Log.i(this.TAG, "No version available" + destHot);
         }
         return res;
     }
 
-    public Boolean delete(String version, String versionName) throws IOException {
-        File destHot = new File(this.context.getFilesDir()  + "/" + basePathHot + "/" + version);
+    public Boolean delete(final String version, final String versionName) throws IOException {
+        final File destHot = new File(this.context.getFilesDir()  + "/" + this.basePathHot + "/" + version);
         if (destHot.exists()) {
-            deleteDirectory(destHot);
+            this.deleteDirectory(destHot);
             return true;
         }
-        Log.i(TAG, "Directory not removed: " + destHot.getPath());
+        Log.i(this.TAG, "Directory not removed: " + destHot.getPath());
         this.sendStats("delete", versionName);
         return false;
     }
 
-    public Boolean set(String version, String versionName) {
-        File destHot = new File(this.context.getFilesDir()  + "/" + basePathHot + "/" + version);
-        File destIndex = new File(destHot.getPath()  + "/index.html");
+    public Boolean set(final String version, final String versionName) {
+        final File destHot = new File(this.context.getFilesDir()  + "/" + this.basePathHot + "/" + version);
+        final File destIndex = new File(destHot.getPath()  + "/index.html");
         if (destHot.exists() && destIndex.exists()) {
-            editor.putString("lastPathHot", destHot.getPath());
-            editor.putString("serverBasePath", destHot.getPath());
-            editor.putString("versionName", versionName);
-            editor.commit();
-            sendStats("set", versionName);
+            this.editor.putString("lastPathHot", destHot.getPath());
+            this.editor.putString("serverBasePath", destHot.getPath());
+            this.editor.putString("versionName", versionName);
+            this.editor.commit();
+            this.sendStats("set", versionName);
             return true;
         }
-        sendStats("set_fail", versionName);
+        this.sendStats("set_fail", versionName);
         return false;
     }
 
-    public void getLatest(String url, Callback callback) {
-        String deviceID = this.deviceID;
-        String appId = this.appId;
-        String versionBuild = this.versionBuild;
-        String versionCode = this.versionCode;
-        String versionOs = this.versionOs;
-        String pluginVersion = this.pluginVersion;
-        String versionName = getVersionName().equals("") ? "builtin" : getVersionName();
-        StringRequest stringRequest = new StringRequest(Request.Method.GET, url,
+    public void getLatest(final String url, final Callback callback) {
+        final String deviceID = this.getDeviceID();
+        final String appId = this.getAppId();
+        final String versionBuild = this.versionBuild;
+        final String versionCode = this.versionCode;
+        final String versionOs = this.versionOs;
+        final String pluginVersion = this.pluginVersion;
+        final String versionName = this.getVersionName().equals("") ? "builtin" : this.getVersionName();
+        final StringRequest stringRequest = new StringRequest(Request.Method.GET, url,
                 new Response.Listener<String>() {
                     @Override
-                    public void onResponse(String response) {
+                    public void onResponse(final String response) {
                         try {
-                            JSONObject jsonObject = new JSONObject(response);
+                            final JSONObject jsonObject = new JSONObject(response);
                             callback.callback(jsonObject);
-                        } catch (JSONException e) {
-                            e.printStackTrace();
+                        } catch (final JSONException e) {
+                            Log.e(CapacitorUpdater.this.TAG, "Error parsing JSON", e);
                         }
                     }
                 }, new Response.ErrorListener() {
             @Override
-            public void onErrorResponse(VolleyError error) {
-                Log.e(TAG, "Error getting Latest" +  error);
+            public void onErrorResponse(final VolleyError error) {
+                Log.e(CapacitorUpdater.this.TAG, "Error getting Latest" +  error);
             }
         }) {
             @Override
             public Map<String, String> getHeaders() throws AuthFailureError {
-                Map<String, String>  params = new HashMap<String, String>();
+                final Map<String, String>  params = new HashMap<String, String>();
                 params.put("cap_platform", "android");
                 params.put("cap_device_id", deviceID);
                 params.put("cap_app_id", appId);
@@ -339,46 +312,46 @@ public class CapacitorUpdater {
                 return params;
             }
         };
-        RequestQueue requestQueue = Volley.newRequestQueue(this.context);
+        final RequestQueue requestQueue = Volley.newRequestQueue(this.context);
         requestQueue.add(stringRequest);
     }
 
     public String getLastPathHot() {
-        return prefs.getString("lastPathHot", "public");
+        return this.prefs.getString("lastPathHot", "public");
     }
 
     public String getVersionName() {
-        return prefs.getString("versionName", "");
+        return this.prefs.getString("versionName", "");
     }
 
     public void reset() {
-        String version = prefs.getString("versionName", "");
+        final String version = this.prefs.getString("versionName", "");
         this.sendStats("reset", version);
-        editor.putString("lastPathHot", "public");
-        editor.putString("serverBasePath", "public");
-        editor.putString("versionName", "");
-        editor.commit();
+        this.editor.putString("lastPathHot", "public");
+        this.editor.putString("serverBasePath", "public");
+        this.editor.putString("versionName", "");
+        this.editor.commit();
     }
 
-    public void sendStats(String action, String version) {
-        if (statsUrl == "") { return; }
-        URL url;
-        JSONObject json = new JSONObject();
-        String jsonString;
+    public void sendStats(final String action, final String version) {
+        if (this.getStatsUrl() == "") { return; }
+        final URL url;
+        final JSONObject json = new JSONObject();
+        final String jsonString;
         try {
-            url = new URL(statsUrl);
+            url = new URL(this.getStatsUrl());
             json.put("platform", "android");
             json.put("action", action);
             json.put("version_name", version);
-            json.put("device_id", this.deviceID);
+            json.put("device_id", this.getDeviceID());
             json.put("version_build", this.versionBuild);
             json.put("version_code", this.versionCode);
             json.put("version_os", this.versionOs);
             json.put("plugin_version", this.pluginVersion);
-            json.put("app_id", this.appId);
+            json.put("app_id", this.getAppId());
             jsonString = json.toString();
-        } catch (Exception ex) {
-            Log.e(TAG, "Error get stats", ex);
+        } catch (final Exception ex) {
+            Log.e(this.TAG, "Error get stats", ex);
             return;
         }
         new Thread(new Runnable(){
@@ -393,17 +366,17 @@ public class CapacitorUpdater {
                     con.setRequestProperty("Content-Length", Integer.toString(jsonString.getBytes().length));
                     con.setDoOutput(true);
                     con.setConnectTimeout(500);
-                    DataOutputStream wr = new DataOutputStream (con.getOutputStream());
+                    final DataOutputStream wr = new DataOutputStream (con.getOutputStream());
                     wr.writeBytes(jsonString);
                     wr.close();
-                    int responseCode = con.getResponseCode();
+                    final int responseCode = con.getResponseCode();
                     if (responseCode != 200) {
-                        Log.e(TAG, "Stats error responseCode: " + responseCode);
+                        Log.e(CapacitorUpdater.this.TAG, "Stats error responseCode: " + responseCode);
                     } else {
-                        Log.i(TAG, "Stats send for \"" + action + "\", version " + version);
+                        Log.i(CapacitorUpdater.this.TAG, "Stats send for \"" + action + "\", version " + version);
                     }
-                } catch (Exception ex) {
-                    Log.e(TAG, "Error post stats", ex);
+                } catch (final Exception ex) {
+                    Log.e(CapacitorUpdater.this.TAG, "Error post stats", ex);
                 } finally {
                     if (con != null) {
                         con.disconnect();
@@ -412,4 +385,28 @@ public class CapacitorUpdater {
             }
         }).start();
     }
+
+    public String getStatsUrl() {
+        return this.statsUrl;
+    }
+
+    public void setStatsUrl(final String statsUrl) {
+        this.statsUrl = statsUrl;
+    }
+
+    public String getAppId() {
+        return this.appId;
+    }
+
+    public void setAppId(final String appId) {
+        this.appId = appId;
+    }
+
+    public String getDeviceID() {
+        return this.deviceID;
+    }
+
+    public void setDeviceID(final String deviceID) {
+        this.deviceID = deviceID;
+    }
 }