@capacitor-community/sqlite 3.2.0 → 3.2.2

package/CHANGELOG.md

@@ -1,3 +1,33 @@
+## 3.2.2 (2021-09-17)
+
+### Bug Fixes
+
+ - Update API.md databases location for Web platform
+
+## 3.2.2-3 (2021-09-15)
+
+### Bug Fixes
+
+ - Fix Web Platform, add componentOnReady on constructor
+
+## 3.2.2-2 (2021-09-15)
+
+### Bug Fixes
+
+ - Fix All Platforms, executeSet breaks with empty array issue#170
+
+## 3.2.2-1 (2021-09-11)
+
+### Chore
+
+ - Update to @capacitor/core 3.2.2
+ - Update to @capacitor/ios 3.2.2
+ - Update to @capacitor/android 3.2.2
+
+### Added Features
+
+ - Add Views in JsonSQLite (issue#167)
+ 
 ## 3.2.0 (2021-08-31)
 
 ### Added Features

package/README.md

@@ -28,6 +28,18 @@
 
 ## CAPACITOR 3 (Master)
 
+🚨 Since release 3.2.2-2 ->> 🚨
+
+The executeSet method accepts now no values, see below
+
+```
+const setIssue170: Array<capSQLiteSet>  = [
+  { statement: "DROP TABLE IF EXISTS issue170", values: [] },
+  { statement: "CREATE TABLE issue170 (src VARCHAR(255))", values: [] },
+  { statement: "INSERT INTO issue170 (src) values (?)", values: ["google.com"] },
+]
+```
+
 🚨 Since release 3.2.0-5 ->> 🚨
 
 The Web plugin is now implemented based on the stencil companion `jeep-sqlite@0.0.7` which is using `sql.js@1.5.0` for database queries and `localeforage@1.9.0`for database persistency.
@@ -339,8 +351,9 @@ No configuration required for this plugin
 
 ## Dependencies
 
-The IOS and Android codes are using `SQLCipher` allowing for database encryption
-The Electron code is using `sqlite3` 
+The IOS and Android codes are using `SQLCipher` allowing for database encryption.
+The Electron code is using `sqlite3`.
+The Web code is using the Stencil component `jeep-sqlite` based on `sql.js` and `localforage`. 
 
 ## Contributors ✨
 

package/android/src/main/java/com/getcapacitor/community/database/sqlite/CapacitorSQLite.java

@@ -687,7 +687,7 @@ public class CapacitorSQLite {
             try {
                 JSObject ret = db.exportToJson(expMode);
 
-                if (ret.length() == 5) {
+                if (ret.length() == 5 || ret.length() == 6) {
                     return ret;
                 } else {
                     String msg = "ExportToJson: return Obj is not a JsonSQLite Obj";

package/android/src/main/java/com/getcapacitor/community/database/sqlite/SQLite/Database.java

@@ -329,7 +329,7 @@ public class Database {
                     for (int j = 0; j < valuesJson.length(); j++) {
                         values.add(valuesJson.get(j));
                     }
-                    Boolean isArray = _uSqlite.parse(values.get(0));
+                    Boolean isArray = values.size() > 0 ? _uSqlite.parse(values.get(0)) : false;
                     if (isArray) {
                         for (int j = 0; j < values.size(); j++) {
                             JSONArray valsJson = (JSONArray) values.get(j);
@@ -603,12 +603,17 @@ public class Database {
     public JSObject importFromJson(JsonSQLite jsonSQL) throws Exception {
         Log.d(TAG, "importFromJson:  ");
         JSObject retObj = new JSObject();
-        int changes = Integer.valueOf(-1);
+        int changes = Integer.valueOf(0);
         try {
-            // create the database schema
-            changes = fromJson.createDatabaseSchema(this, jsonSQL);
-            if (changes != -1) {
-                changes = fromJson.createDatabaseData(this, jsonSQL);
+            if (jsonSQL.getTables().size() > 0) {
+                // create the database schema
+                changes = fromJson.createDatabaseSchema(this, jsonSQL);
+                if (changes != -1) {
+                    changes += fromJson.createDatabaseData(this, jsonSQL);
+                }
+            }
+            if (jsonSQL.getViews().size() > 0) {
+                changes += fromJson.createViews(this, jsonSQL.getViews());
             }
             retObj.put("changes", changes);
             return retObj;
@@ -640,6 +645,9 @@ public class Database {
                     retObj.put("encrypted", retJson.getEncrypted());
                     retObj.put("mode", retJson.getMode());
                     retObj.put("tables", retJson.getTablesAsJSObject());
+                    if (keys.contains("views") && retJson.getViews().size() > 0) {
+                        retObj.put("views", retJson.getViewsAsJSObject());
+                    }
                 }
             }
         } catch (Exception e) {

package/android/src/main/java/com/getcapacitor/community/database/sqlite/SQLite/ImportExportJson/ExportToJson.java

@@ -40,13 +40,30 @@ public class ExportToJson {
      */
     public JsonSQLite createExportObject(Database db, JsonSQLite sqlObj) throws Exception {
         JsonSQLite retObj = new JsonSQLite();
-
-        String stmt = "SELECT name,sql FROM sqlite_master WHERE ";
-        stmt += "type = 'table' AND name NOT LIKE 'sqlite_%' AND ";
-        stmt += "name NOT LIKE 'android_%' AND ";
-        stmt += "name NOT LIKE 'sync_table';";
+        ArrayList<JsonView> views = new ArrayList<>();
         ArrayList<JsonTable> tables = new ArrayList<>();
         try {
+            // Get Views
+            String stmtV = "SELECT name,sql FROM sqlite_master WHERE ";
+            stmtV += "type = 'view' AND name NOT LIKE 'sqlite_%';";
+            JSArray resViews = db.selectSQL(stmtV, new ArrayList<Object>());
+            if (resViews.length() > 0) {
+                for (int i = 0; i < resViews.length(); i++) {
+                    JSONObject oView = resViews.getJSONObject(i);
+                    JsonView v = new JsonView();
+                    String val = (String) oView.get("sql");
+                    val = val.substring(val.indexOf("AS ") + 3);
+                    v.setName((String) oView.get("name"));
+                    v.setValue(val);
+                    views.add(v);
+                }
+            }
+            // Get Tables
+            String stmt = "SELECT name,sql FROM sqlite_master WHERE ";
+            stmt += "type = 'table' AND name NOT LIKE 'sqlite_%' AND ";
+            stmt += "name NOT LIKE 'android_%' AND ";
+            stmt += "name NOT LIKE 'sync_table';";
+
             JSArray resTables = db.selectSQL(stmt, new ArrayList<Object>());
             if (resTables.length() == 0) {
                 throw new Exception("CreateExportObject: table's names failed");
@@ -71,6 +88,9 @@ public class ExportToJson {
                 retObj.setEncrypted(sqlObj.getEncrypted());
                 retObj.setMode(sqlObj.getMode());
                 retObj.setTables(tables);
+                if (views.size() > 0) {
+                    retObj.setViews(views);
+                }
             }
             return retObj;
         }

package/android/src/main/java/com/getcapacitor/community/database/sqlite/SQLite/ImportExportJson/ImportFromJson.java

@@ -465,4 +465,47 @@ public class ImportFromJson {
         }
         return stmt;
     }
+
+    /**
+     * Create from the Json Object the database views
+     * @param mDb
+     * @param views
+     * @return
+     * @throws Exception
+     */
+    public Integer createViews(Database mDb, ArrayList<JsonView> views) throws Exception {
+        int changes = Integer.valueOf(0);
+        SupportSQLiteDatabase db = mDb.getDb();
+        try {
+            if (mDb != null && mDb.isOpen() && views.size() > 0) {
+                db.beginTransaction();
+                // Create Views
+                Integer initChanges = _uSqlite.dbChanges(db);
+                for (JsonView view : views) {
+                    if (view.getName().length() > 0 && view.getValue().length() > 0) {
+                        StringBuilder sBuilder = new StringBuilder("CREATE VIEW IF NOT EXISTS ")
+                            .append(view.getName())
+                            .append(" AS ")
+                            .append(view.getValue())
+                            .append(" ;");
+                        String stmt = sBuilder.toString();
+                        db.execSQL(stmt);
+                    } else {
+                        throw new Exception("CreateViews: no name and value");
+                    }
+                }
+                changes = _uSqlite.dbChanges(db) - initChanges;
+                if (changes >= 0) {
+                    db.setTransactionSuccessful();
+                }
+            } else {
+                throw new Exception("CreateViews: Database not opened");
+            }
+        } catch (Exception e) {
+            throw new Exception("CreateViews: " + e.getMessage());
+        } finally {
+            if (db != null && db.inTransaction()) db.endTransaction();
+        }
+        return changes;
+    }
 }

package/android/src/main/java/com/getcapacitor/community/database/sqlite/SQLite/ImportExportJson/JsonSQLite.java

@@ -19,9 +19,10 @@ public class JsonSQLite {
     private Boolean encrypted = null;
     private String mode = "";
     private ArrayList<JsonTable> tables = new ArrayList<JsonTable>();
+    private ArrayList<JsonView> views = new ArrayList<JsonView>();
 
     private static final List<String> keyFirstLevel = new ArrayList<String>(
-        Arrays.asList("database", "version", "encrypted", "mode", "tables")
+        Arrays.asList("database", "version", "encrypted", "mode", "tables", "views")
     );
 
     // Getter
@@ -45,6 +46,10 @@ public class JsonSQLite {
         return tables;
     }
 
+    public ArrayList<JsonView> getViews() {
+        return views;
+    }
+
     // Setter
     public void setDatabase(String newDatabase) {
         this.database = newDatabase;
@@ -66,6 +71,10 @@ public class JsonSQLite {
         this.tables = newTables;
     }
 
+    public void setViews(ArrayList<JsonView> newViews) {
+        this.views = newViews;
+    }
+
     public ArrayList<String> getKeys() {
         ArrayList<String> retArray = new ArrayList<String>();
         if (getDatabase().length() > 0) retArray.add("database");
@@ -73,6 +82,7 @@ public class JsonSQLite {
         if (getEncrypted() != null) retArray.add("encrypted");
         if (getMode().length() > 0) retArray.add("mode");
         if (getTables().size() > 0) retArray.add("tables");
+        if (getViews().size() > 0) retArray.add("views");
         return retArray;
     }
 
@@ -138,6 +148,23 @@ public class JsonSQLite {
                         }
                     }
                 }
+                if (key.equals("views")) {
+                    if (!(value instanceof JSONArray)) {
+                        String msg = "value: not instance of JSONArray";
+                        Log.d(TAG, msg);
+                        return false;
+                    } else {
+                        JSONArray arrJS = jsObj.getJSONArray(key);
+                        views = new ArrayList<>();
+
+                        for (int i = 0; i < arrJS.length(); i++) {
+                            JsonView view = new JsonView();
+                            boolean retView = view.isView(arrJS.getJSONObject(i));
+                            if (!retView) return false;
+                            views.add(view);
+                        }
+                    }
+                }
             } catch (JSONException e) {
                 e.printStackTrace();
                 return false;
@@ -155,6 +182,12 @@ public class JsonSQLite {
         for (JsonTable table : this.getTables()) {
             table.print();
         }
+        if (this.getViews().size() > 0) {
+            Log.d(TAG, "number of Views: " + this.getViews().size());
+            for (JsonView view : this.getViews()) {
+                view.print();
+            }
+        }
     }
 
     public JSArray getTablesAsJSObject() {
@@ -164,4 +197,12 @@ public class JsonSQLite {
         }
         return JSTables;
     }
+
+    public JSArray getViewsAsJSObject() {
+        JSArray JSViews = new JSArray();
+        for (JsonView view : this.views) {
+            JSViews.put(view.getViewAsJSObject());
+        }
+        return JSViews;
+    }
 }

package/android/src/main/java/com/getcapacitor/community/database/sqlite/SQLite/ImportExportJson/JsonView.java

@@ -0,0 +1,85 @@
+package com.getcapacitor.community.database.sqlite.SQLite.ImportExportJson;
+
+import android.util.Log;
+import com.getcapacitor.JSObject;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Iterator;
+import java.util.List;
+import org.json.JSONException;
+import org.json.JSONObject;
+
+public class JsonView {
+
+    private static final String TAG = "JsonView";
+    private static final List<String> keyViewsLevel = new ArrayList<String>(Arrays.asList("name", "value"));
+    private String name = "";
+    private String value = "";
+
+    // Getter
+    public String getName() {
+        return name;
+    }
+
+    public String getValue() {
+        return value;
+    }
+
+    // Setter
+    public void setName(String newName) {
+        this.name = newName;
+    }
+
+    public void setValue(String newValue) {
+        this.value = newValue;
+    }
+
+    public ArrayList<String> getKeys() {
+        ArrayList<String> retArray = new ArrayList<String>();
+        if (getName().length() > 0) retArray.add("name");
+        if (getValue().length() > 0) retArray.add("value");
+        return retArray;
+    }
+
+    public boolean isView(JSONObject jsObj) {
+        if (jsObj == null || jsObj.length() == 0) return false;
+        Iterator<String> keys = jsObj.keys();
+        while (keys.hasNext()) {
+            String key = keys.next();
+            if (!keyViewsLevel.contains(key)) return false;
+            try {
+                Object objValue = jsObj.get(key);
+                if (key.equals("name")) {
+                    if (!(objValue instanceof String)) {
+                        return false;
+                    } else {
+                        name = (String) objValue;
+                    }
+                }
+                if (key.equals("value")) {
+                    if (!(objValue instanceof String)) {
+                        return false;
+                    } else {
+                        value = (String) objValue;
+                    }
+                }
+            } catch (JSONException e) {
+                e.printStackTrace();
+                return false;
+            }
+        }
+        return true;
+    }
+
+    public void print() {
+        String toPrint = "name: " + this.getName() + " value: " + this.getValue();
+        Log.d(TAG, toPrint);
+    }
+
+    public JSObject getViewAsJSObject() {
+        JSObject retObj = new JSObject();
+        retObj.put("name", this.name);
+        retObj.put("value", this.value);
+        return retObj;
+    }
+}

package/android/src/main/java/com/getcapacitor/community/database/sqlite/SQLite/ImportExportJson/UtilsJson.java

@@ -15,6 +15,7 @@ public class UtilsJson {
     private JsonColumn uJCol = new JsonColumn();
     private JsonIndex uJIdx = new JsonIndex();
     private JsonTrigger uJTrg = new JsonTrigger();
+    private JsonView uJView = new JsonView();
 
     /**
      * Check if a table exists
@@ -37,6 +38,27 @@ public class UtilsJson {
         }
     }
 
+    /**
+     * Check if a view exists
+     * @param db
+     * @param viewName
+     * @return
+     */
+    public boolean isViewExists(Database db, String viewName) throws Exception {
+        boolean ret = false;
+        String query = new StringBuilder("SELECT name FROM " + "sqlite_master WHERE type='view' AND name='")
+            .append(viewName)
+            .append("';")
+            .toString();
+        try {
+            JSArray resQuery = db.selectSQL(query, new ArrayList<Object>());
+            if (resQuery.length() > 0) ret = true;
+            return ret;
+        } catch (Exception e) {
+            throw new Exception("isViewExists: " + e.getMessage());
+        }
+    }
+
     /**
      * Check if the Id already exsists
      * @param mDb
@@ -338,4 +360,27 @@ public class UtilsJson {
         }
         return;
     }
+
+    /**
+     * Check Views Validity
+     * @param views
+     * @throws Exception
+     */
+    public void checkViewsValidity(ArrayList<JsonView> views) throws Exception {
+        for (int i = 0; i < views.size(); i++) {
+            JSONObject jsView = new JSONObject();
+            ArrayList<String> keys = views.get(i).getKeys();
+            if (keys.contains("value")) {
+                jsView.put("value", views.get(i).getValue());
+            }
+            if (keys.contains("name")) {
+                jsView.put("name", views.get(i).getName());
+            }
+            boolean isValid = uJView.isView(jsView);
+            if (!isValid) {
+                throw new Exception("checkViewsValidity: views[" + i + "] not valid");
+            }
+        }
+        return;
+    }
 }