cordova-sqlcipher-adapter-alpha

v0.0.1

Published

2 years ago

SQLCipher database adapter for PhoneGap/Cordova, based on cordova-sqlite-storage

Downloads

0High
0Medium
0Low

flammarion

sqlite sqlcipher ecosystem:cordova cordova-android cordova-ios cordova-windows

THIS IS AN ALPHA VERSION WHICH IS NOT PRODUCTION READY IN ANY WAY

If you want to use this plugin in your project, I strongly advise to use original plugin.

Cordova/PhoneGap SQLCipher adapter plugin

Native interface to sqlcipher in a Cordova/PhoneGap plugin for Android, iOS, and Windows "Universal" (8.1), with API similar to HTML5/Web SQL API.

License for Android and Windows "Universal" (8.1) versions: MIT or Apache 2.0

License for iOS version: MIT only

NOTE (TBD): no Circle CI or Travis CI working in this version branch.

WARNING: In case you lose the database password you have no way to recover the data.

Status

Pre-alpha version with SQLCipher v3.3.1
- with OpenSSL libcrypto for Android
- using Security framework for iOS
- with LibTomCrypt (1.17) embedded for Windows "Universal" (8.1)
- for future consideration: embed OpenSSL libcrypto for all target platforms
Windows "Universal" for Windows 8.0/8.1(+) and Windows Phone 8.1(+) version is in an alpha state:
- Issue with UNICODE \u0000 character (same as \0)
- No background processing (for future consideration)
- You may encounter issues with Cordova CLI due to CB-8866; as a workaround you can install using litehelpers / cordova-windows-nufix and plugman as described below.
- In addition, problems with the Windows "Universal" version have been reported in case of a Cordova project using a Visual Studio template/extension instead of Cordova/PhoneGap CLI or plugman
- Not tested with a Windows 10 (or Windows Phone 10) target; Windows 10 build is not expected to work with Windows Phone
Android versions supported:
- ARM (v5/v6/v7/v7a) and x86 CPUs
- Minimum SDK 10 (a.k.a. Gingerbread, Android 2.3.3); support for older versions is available upon request.
- NOTE: 64-bit CPUs such as x64_64, ARM-64, and MIPS64 are currently not supported (for consideration in the near future).
FTS3, FTS4, and R-Tree support is tested working OK in this version (for all target platforms Android/iOS/Windows "Universal")
Pre-populatd DB is NOT supported by this version.
Lawnchair & PouchDB have NOT been tested with this version.
API to open the database is expected to be changed somewhat to be more streamlined. Transaction and single-statement query API will NOT be changed.
In case of memory issues please use smaller transactions or TBD not (yet) adapted for use with SQLCipher: use the version (with a different licensing scheme) at: litehelpers / Cordova-sqlite-enterprise-free

Announcements

PhoneGap Build is now supported through the npm package: http://phonegap.com/blog/2015/05/26/npm-plugins-available/
MetaMemoryT / websql-promise now provides a Promises-based interface to both Web SQL and this plugin
iOS version is now fixed to override the correct pluginInitialize method and should work with recent versions of iOS
New openDatabase and deleteDatabase location option to select database location (iOS only) and disable iCloud backup
Fixes to work with PouchDB by @nolanlawson

Highlights

This version connects to sqlcipher.
Drop-in replacement for HTML5/Web SQL API, the only change should be window.openDatabase() --> sqlitePlugin.openDatabase()
Failure-safe nested transactions with batch processing optimizations
As described in this posting:
- Keeps sqlite database in a user data location that is known; can be reconfigured (iOS version); and synchronized to iCloud by default (iOS version; can be disabled as described below).
- No 5MB maximum, more information at: http://www.sqlite.org/limits.html

Some apps using Cordova SQLCipher adapter

TBD YOUR APP HERE

Known issues

INSERT statement that affects multiple rows (due to SELECT cause or using triggers, for example) does not report proper rowsAffected on Android.
Memory issue observed when adding a large number of records on Android, due to JSON implementation
A stability issue was reported on the iOS version when in use together with SockJS client such as pusher-js at the same time. The workaround is to call sqlite functions and SockJS client functions in separate ticks (using setTimeout with 0 timeout).
If a sql statement fails for which there is no error handler or the error handler does not return false to signal transaction recovery, the plugin fires the remaining sql callbacks before aborting the transaction.
In case of an error, the error code member is bogus on Android and Windows (fixed for Android in litehelpers / Cordova-sqlite-enterprise-free).
Possible crash on Android when using Unicode emoji characters due to Android bug 81341, which should be fixed in Android 6.x
REGEXP is only supported on iOS, known to be broken on Android (default database implementation) and Windows ("Universal").
Close database bugs described below.
When a database is opened and deleted without closing, the iOS version is known to leak resources.
It is NOT possible to open multiple databases with the same name but in different locations (iOS version).
Problems reported with PhoneGap Build in the past:
- PhoneGap Build Hydration.
- For some reason, PhoneGap Build may fail to build the iOS version unless the name of the app starts with an uppercase and contains no spaces (see #243; Wizcorp/phonegap-facebook-plugin#830; phonegap/build#431).

Other limitations

The db version, display name, and size parameter values are not supported and will be ignored.
This plugin will not work before the callback for the "deviceready" event has been fired, as described in Usage. (This is consistent with the other Cordova plugins.)
Will not work in a web worker or iframe since these are not supported by the Cordova framework.
In-memory database db=window.sqlitePlugin.openDatabase({name: ":memory:"}) is currently not supported.
The Android version cannot work with more than 100 open db files (due to the threading model used).
UNICODE line separator (\u2028) and paragraph separator (\u2029) are currently not supported and known to be broken in iOS version due to Cordova bug CB-9435.
Blob type is currently not supported and known to be broken on multiple platforms.
UNICODE \u0000 (same as \0) character not working in Windows (8.1/XX) or Windows Phone 8.1/XX version(s)
Case-insensitive matching and other string manipulations on Unicode characters is not supported for iOS or Windows "Universal" platforms.
iOS version uses a thread pool but with only one thread working at a time due to "synchronized" database access
Large query result can be slow, also due to JSON implementation
ATTACH another database file is not supported (due to path specifications, which work differently depending on the target platform)
User-defined savepoints are not supported and not expected to be compatible with the transaction locking mechanism used by this plugin. In addition, the use of BEGIN/COMMIT/ROLLBACK statements is not supported.
Problems have been reported when using this plugin with Crosswalk (for Android). A couple of things you can try:
- Install Crosswalk as a plugin instead of using Crosswalk to create the project.
- Use androidDatabaseImplementation: 2 in the openDatabase options as described below.
Does not work with axemclion / react-native-cordova-plugin since the window.sqlitePlugin object exported (ES5 feature). Possible alternative solutions:
- Follow the solution given in this comment to axemclion/react-native-cordova-plugin#4 or litehelpers/Cordova-sqlite-storage#382
- Adapt andpor / react-native-sqlite-storage to work with SQLCipher

Further testing needed

Multi-page apps
Use within InAppBrowser
UNICODE characters not fully tested in the Windows "Universal" (8.1) version
Use with triggers and JOIN
TODO add some more REGEXP tests
Use of Android version with Amazon Fire-OS (reported to be broken)
Integration with JXCore for Cordova (must be built without sqlite(3) built-in)

Some tips and tricks

If you run into problems and your code follows the asynchronous HTML5/Web SQL transaction API, you can try opening your database using window.openDatabase and see if you get the same problems.

Common pitfalls

It is NOT allowed to execute sql statements on a transaction following the HTML5/Web SQL API, as described below.

Alternatives

NOTE: None of these alternatives currently support SQLCipher.

Other versions

litehelpers / Cordova-sqlite-storage - Cordova sqlite storage plugin without sqlcipher, supported for more platforms.
litehelpers / Cordova-sqlite-enterprise-free - internal memory improvements to support larger transactions (with a different licensing scheme)
litehelpers / Cordova-sqlcipher-adapter - supports SQLCipher for Android, iOS, and Windows (8.1)
Adaptation for React Native Android and iOS: andpor / react-native-sqlite-storage
Original version for iOS without sqlcipher (with a different API): davibe / Phonegap-SQLitePlugin

Other SQLite adapter projects

an-rahulpandey / cordova-plugin-dbcopy - Supports pre-populated database (NOT expected with work SQLCipher for Android)
object-layer / AnySQL - Unified SQL API over multiple database engines
Simpler sqlite plugin with a simpler API: samikrc / CordovaSQLite
an-rahulpandey / cordova-plugin-dbcopy - Alternative way to copy pre-populated database
EionRobb / phonegap-win8-sqlite - WebSQL add-on for Win8/Metro apps (perhaps with a different API), using an old version of the C++ library from SQLite3-WinRT Component (as referenced by 01org / cordova-win8)
SQLite3-WinRT Component - C++ component that provides a nice SQLite API with promises for WinJS
01org / cordova-win8 - old, unofficial version of Cordova API support for Windows 8 Metro that includes an old version of the C++ SQLite3-WinRT Component
MSOpenTech / cordova-plugin-websql - Windows 8(+) and Windows Phone 8(+) WebSQL plugin versions in C#
MetaMemoryT / websql-client - provides the same API and connects to websql-server through WebSockets.

Alternative solutions

Another sqlite binding for React-Native (iOS version): almost/react-native-sqlite
Use NativeScript with its web view and [NathanaelA / nativescript-sqlite](https://github.com/Natha naelA/nativescript-sqlite) (Android and/or iOS)
Standard HTML5 local storage
Realm.io

Usage

The idea is to emulate the HTML5/Web SQL API as closely as possible. The only major change is to use window.sqlitePlugin.openDatabase() (or sqlitePlugin.openDatabase()) instead of window.openDatabase(). If you see any other major change please report it, it is probably a bug.

NOTE: If a sqlite statement in a transaction fails with an error, the error handler must return false in order to recover the transaction. This is correct according to the HTML5/Web SQL API standard. This is different from the WebKit implementation of Web SQL in Android and iOS which recovers the transaction if a sql error hander returns a non-true value.

Opening a database

Supported way: var db = window.sqlitePlugin.openDatabase({name: "my.db", key: "your-password-here", location: 1}, successcb, errorcb);

The location option is used to select the database subdirectory location (iOS only) with the following choices:

0 (default): Documents - visible to iTunes and backed up by iCloud
1: Library - backed up by iCloud, NOT visible to iTunes
2: Library/LocalDatabase - NOT visible to iTunes and NOT backed up by iCloud

Classical way - unsupported and WILL BE REMOVED: var db = window.sqlitePlugin.openDatabase("myDatabase.db", "1.0", "Demo", -1);

IMPORTANT: Please wait for the "deviceready" event, as in the following example:

// Wait for Cordova to load
document.addEventListener("deviceready", onDeviceReady, false);

// Cordova is ready
function onDeviceReady() {
  var db = window.sqlitePlugin.openDatabase({name: "my.db", key: "your-password-here"});
  // ...
}

The successcb and errorcb callback parameters are optional but can be extremely helpful in case anything goes wrong. For example:

window.sqlitePlugin.openDatabase({name: "my.db", key: "your-password-here", location: 1}, function(db) {
  db.transaction(function(tx) {
    // ...
  }, function(err) {
    console.log('Open database ERROR: ' + JSON.stringify(err));
  });
});

If any sql statements or transactions are attempted on a database object before the openDatabase result is known, they will be queued and will be aborted in case the database cannot be opened.

OTHER NOTES:

The database file name should include the extension, if desired.
It is possible to open multiple database access objects for the same database.
The database access object can be closed as described below.

SQL transactions

The following types of SQL transactions are supported by this version:

Single-statement transactions
Standard asynchronous transactions

Single-statement transactions

Sample:

db.executeSql("SELECT LENGTH('tenletters') AS stringlength", [], function (res) {
  console.log('got stringlength: ' + res.rows.item(0).stringlength);
}, function(error) {
  console.log('SELECT error: ' + error.message);
});

Standard asynchronous transactions

Standard asynchronous transactions follow the HTML5/Web SQL API which is very well documented and uses BEGIN and COMMIT or ROLLBACK to keep the transactions failure-safe. Here is a very simple example from the test suite:

db.transaction(function(tx) {
  tx.executeSql("SELECT UPPER('Some US-ASCII text') AS uppertext", [], function(tx, res) {
    console.log("res.rows.item(0).uppertext: " + res.rows.item(0).uppertext);
  }, function(error) {
    console.log('SELECT error: ' + error.message);
  });
}, function(error) {
  console.log('transaction error: ' + error.message);
}, function() {
  console.log('transaction ok');
});

In case of a read-only transaction, it is possible to use readTransaction which will not use BEGIN, COMMIT, or ROLLBACK:

db.readTransaction(function(tx) {
  tx.executeSql("SELECT UPPER('Some US-ASCII text') AS uppertext", [], function(tx, res) {
    console.log("res.rows.item(0).uppertext: " + res.rows.item(0).uppertext);
  }, function(error) {
    console.log('SELECT error: ' + error.message);
  });
}, function(error) {
  console.log('transaction error: ' + error.message);
}, function() {
  console.log('transaction ok');
});

WARNING: It is NOT allowed to execute sql statements on a transaction after it has finished. Here is an example from my Populating Cordova SQLite storage with the JQuery API post: [post about , for example:

  // BROKEN SAMPLE:
  var db = window.sqlitePlugin.openDatabase({name: "test.db", key: "my-password"});
  db.executeSql("DROP TABLE IF EXISTS tt");
  db.executeSql("CREATE TABLE tt (data)");

  db.transaction(function(tx) {
    $.ajax({
      url: 'https://api.github.com/users/litehelpers/repos',
      dataType: 'json',
      success: function(res) {
        console.log('Got AJAX response: ' + JSON.stringify(res));
        $.each(res, function(i, item) {
          console.log('REPO NAME: ' + item.name);
          tx.executeSql("INSERT INTO tt values (?)", JSON.stringify(item.name));
        });
      }
    });
  }, function(e) {
    console.log('Transaction error: ' + e.message);
  }, function() {
    // Check results:
    db.executeSql('SELECT COUNT(*) FROM tt', [], function(res) {
      console.log('Check SELECT result: ' + JSON.stringify(res.rows.item(0)));
    });
  });

You can find more details and a step-by-step description how to do this right in the Populating Cordova SQLite storage with the JQuery API post:

Background processing

The threading model depends on which version is used:

For Android, one background thread per db;
for iOS, background processing using a very limited thread pool (only one thread working at a time);
for Windows "Universal" (8.1), no background processing (for future consideration).

Sample with PRAGMA feature

This is a pretty strong test: first we create a table and add a single entry, then query the count to check if the item was inserted as expected. Note that a new transaction is created in the middle of the first callback.

// Wait for Cordova to load
document.addEventListener("deviceready", onDeviceReady, false);

// Cordova is ready
function onDeviceReady() {
  var db = window.sqlitePlugin.openDatabase({name: "my.db"});

  db.transaction(function(tx) {
    tx.executeSql('DROP TABLE IF EXISTS test_table');
    tx.executeSql('CREATE TABLE IF NOT EXISTS test_table (id integer primary key, data text, data_num integer)');

    // demonstrate PRAGMA:
    db.executeSql("pragma table_info (test_table);", [], function(res) {
      console.log("PRAGMA res: " + JSON.stringify(res));
    });

    tx.executeSql("INSERT INTO test_table (data, data_num) VALUES (?,?)", ["test", 100], function(tx, res) {
      console.log("insertId: " + res.insertId + " -- probably 1");
      console.log("rowsAffected: " + res.rowsAffected + " -- should be 1");

      db.transaction(function(tx) {
        tx.executeSql("select count(id) as cnt from test_table;", [], function(tx, res) {
          console.log("res.rows.length: " + res.rows.length + " -- should be 1");
          console.log("res.rows.item(0).cnt: " + res.rows.item(0).cnt + " -- should be 1");
        });
      });

    }, function(e) {
      console.log("ERROR: " + e.message);
    });
  });
}

NOTE: PRAGMA statements must be executed in executeSql() on the database object (i.e. db.executeSql()) and NOT within a transaction.

Sample with transaction-level nesting

In this case, the same transaction in the first executeSql() callback is being reused to run executeSql() again.

// Wait for Cordova to load
document.addEventListener("deviceready", onDeviceReady, false);

// Cordova is ready
function onDeviceReady() {
  var db = window.sqlitePlugin.openDatabase({name: "my.db", key: "your-password-here"});

  db.transaction(function(tx) {
    tx.executeSql('DROP TABLE IF EXISTS test_table');
    tx.executeSql('CREATE TABLE IF NOT EXISTS test_table (id integer primary key, data text, data_num integer)');

    tx.executeSql("INSERT INTO test_table (data, data_num) VALUES (?,?)", ["test", 100], function(tx, res) {
      console.log("insertId: " + res.insertId + " -- probably 1");
      console.log("rowsAffected: " + res.rowsAffected + " -- should be 1");

      tx.executeSql("select count(id) as cnt from test_table;", [], function(tx, res) {
        console.log("res.rows.length: " + res.rows.length + " -- should be 1");
        console.log("res.rows.item(0).cnt: " + res.rows.item(0).cnt + " -- should be 1");
      });

    }, function(e) {
      console.log("ERROR: " + e.message);
    });
  });
}

This case will also works with Safari (WebKit) (with no encryption), assuming you replace window.sqlitePlugin.openDatabase with window.openDatabase.

Close a database object

db.close(successcb, errorcb);

It is OK to close the database within a transaction callback but NOT within a statement callback. The following example is OK:

db.transaction(function(tx) {
  tx.executeSql("SELECT LENGTH('tenletters') AS stringlength", [], function(tx, res) {
    console.log('got stringlength: ' + res.rows.item(0).stringlength);
  });
}, function(error) {
  // OK to close here:
  console.log('transaction error: ' + error.message);
  db.close();
}, function() {
  // OK to close here:
  console.log('transaction ok');
  db.close(function() {
    console.log('database is closed ok');
  });
});

The following example is NOT OK:

// BROKEN:
db.transaction(function(tx) {
  tx.executeSql("SELECT LENGTH('tenletters') AS stringlength", [], function(tx, res) {
    console.log('got stringlength: ' + res.rows.item(0).stringlength);
    // BROKEN - this will trigger the error callback:
    db.close(function() {
      console.log('database is closed ok');
    }, function(error) {
      console.log('ERROR closing database');
    });
  });
});

BUG 1: It is currently NOT possible to close a database in a db.executeSql callback. For example:

// BROKEN DUE TO BUG:
db.executeSql("SELECT LENGTH('tenletters') AS stringlength", [], function (res) {
  var stringlength = res.rows.item(0).stringlength;
  console.log('got stringlength: ' + res.rows.item(0).stringlength);

  // BROKEN - this will trigger the error callback DUE TO BUG:
  db.close(function() {
    console.log('database is closed ok');
  }, function(error) {
    console.log('ERROR closing database');
  });
});

BUG 2: If multiple database access objects are opened for the same database and one database access object is closed, the database is no longer available for the other database access objects. Possible workarounds:

It is still possible to open one or more new database access objects on a database that has been closed.
It should be OK not to explicitly close a database handle since database transactions are ACID compliant and the app's memory resources are cleaned up by the system upon termination.

Delete a database

window.sqlitePlugin.deleteDatabase({name: "my.db", location: 1}, successcb, errorcb);

location as described above for openDatabase (iOS only)

NOTE: not implemented for Windows "Universal" (8.1) version.

Installing

Windows Universal (8.1) target platform

IMPORTANT: The Cordova CLI currently does not support all Windows target platforms (such as ("Mixed Platforms") due to CB-8866. As an alternative, you can use plugman instead with litehelpers / cordova-windows-nufix, as described here.

Using plugman to support "Mixed Platforms"

make sure you have the latest version of plugman installed: npm install -g plugman
Download the cordova-windows-nufix 3.9.0-nufixpre-01 zipball (or you can clone litehelpers / cordova-windows-nufix instead)
Create your Windows "Universal" (8.1) project using litehelpers / cordova-windows-nufix:
- path.to.cordova-windows-nufix/bin/create.bat your_app_path your.app.id YourAppName
cd your_app_path and install plugin using plugman:
- plugman install --platform windows --project . --plugin https://github.com/litehelpers/Cordova-sqlcipher-adapter
Put your sql program in your project www (don't forget to reference it from www\index.html and wait for deviceready event)

Then your project in CordovaApp.sln should work with "Mixed Platforms" on both Windows 8.1 and Windows Phone 8.1.

Easy install with plugman tool

plugman install --platform MYPLATFORM --project path.to.my.project.folder --plugin https://github.com/litehelpers/cordova-sqlite-common

where MYPLATFORM is android, ios, or windows.

A posting how to get started developing on Windows host without the Cordova CLI tool (for Android target only) is available here.

Easy install with Cordova CLI tool

npm install -g cordova # if you don't have cordova
cordova create MyProjectFolder com.my.project MyProject && cd MyProjectFolder # if you are just starting
cordova plugin add https://github.com/litehelpers/Cordova-sqlcipher-adapter

You can find more details at this writeup.

WARNING: for Windows target platform please read the section above.

IMPORTANT: sometimes you have to update the version for a platform before you can build, like: cordova prepare ios

NOTE: If you cannot build for a platform after cordova prepare, you may have to remove the platform and add it again, such as:

cordova platform rm ios
cordova platform add ios

Source tree

SQLitePlugin.coffee.md: platform-independent (Literate coffee-script, can be read by recent coffee-script compiler)
www: SQLitePlugin.js platform-independent Javascript as generated from SQLitePlugin.coffee.md (and comitted!)
src: platform-specific source code:
- common - sqlcipher version of sqlite3.[hc] to be built for iOS and Windows Universal (8.1) platforms
- external - placeholder - not used in this branch
- android - Java plugin code for Android;
- ios - Objective-C plugin code for iOS;
- windows - Javascript proxy code and SQLite3-WinRT project for Windows "Universal" (8.1);
spec: test suite using Jasmine (2.2.0), ported from QUnit test-www test suite, working on all platforms
tests: very simple Jasmine test suite that is run on Circle CI (Android version) and Travis CI (iOS version)
Lawnchair-adapter: Lawnchair adapter, based on the version from the Lawnchair repository, with the basic Lawnchair test suite in test-www subdirectory

Manual installation - Android version

These installation instructions are based on the Android example project from Cordova/PhoneGap 2.7.0, using the lib/android/example subdirectory from the PhoneGap 2.7 zipball.

Install SQLitePlugin.js from www into assets/www
Install SQLitePlugin.java from src/android/io/liteglue into src/io/liteglue
Add the plugin element <plugin name="SQLitePlugin" value="io.liteglue.SQLitePlugin"/> to res/xml/config.xml
Install the SQLCipher for Android binary components from src/android/sqlcipher (TBD better description)

Sample change to res/xml/config.xml (Cordova/PhoneGap 2.x):

--- config.xml.orig	2015-04-14 14:03:05.000000000 +0200
+++ res/xml/config.xml	2015-04-14 14:08:08.000000000 +0200
@@ -36,6 +36,7 @@
     <preference name="useBrowserHistory" value="true" />
     <preference name="exit-on-suspend" value="false" />
 <plugins>
+    <plugin name="SQLitePlugin" value="io.liteglue.SQLitePlugin"/>
     <plugin name="App" value="org.apache.cordova.App"/>
     <plugin name="Geolocation" value="org.apache.cordova.GeoBroker"/>
     <plugin name="Device" value="org.apache.cordova.Device"/>

Before building for the first time, you have to update the project with the desired version of the Android SDK with a command like:

android update project --path $(pwd) --target android-19

(assuming Android SDK 19, use the correct desired Android SDK number here)

NOTE: using this plugin on Cordova pre-3.0 requires the following changes to SQLitePlugin.java:

diff -u Cordova-sqlite-storage/src/android/io/liteglue/SQLitePlugin.java src/io/liteglue/SQLitePlugin.java
--- Cordova-sqlite-storage/src/android/io/liteglue/SQLitePlugin.java	2015-04-14 14:05:01.000000000 +0200
+++ src/io/liteglue/SQLitePlugin.java	2015-04-14 14:10:44.000000000 +0200
@@ -22,8 +22,8 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
-import org.apache.cordova.CallbackContext;
-import org.apache.cordova.CordovaPlugin;
+import org.apache.cordova.api.CallbackContext;
+import org.apache.cordova.api.CordovaPlugin;
 
 import org.json.JSONArray;
 import org.json.JSONException;

Manual installation - iOS version

Security framework library

In the Project "Build Phases" tab, select the first "Link Binary with Libraries" dropdown menu and add the Security.framework.

NOTE: In the "Build Phases" there can be multiple "Link Binary with Libraries" dropdown menus. Please select the first one otherwise it will not work.

SQLite Plugin

Copy SQLitePlugin.[hm] and sqlite3.[hc] from src/ios into your project Plugins folder and add them in XCode (I always just have "Create references" as the option selected).
Copy sqlite3.h & sqlite3.c from src/windows/SQLite3-WinRT/SQLite3 [TBD will be src/common or src/common/sqlcipher] into your project's Plugins subdirectory in the file system.
Copy SQLitePlugin.js from www into your project www folder
Enable the SQLitePlugin in config.xml

Sample change to config.xml (Cordova/PhoneGap 2.x):

--- config.xml.old	2013-05-17 13:18:39.000000000 +0200
+++ config.xml	2013-05-17 13:18:49.000000000 +0200
@@ -39,6 +39,7 @@
     <content src="index.html" />
 
     <plugins>
+        <plugin name="SQLitePlugin" value="SQLitePlugin" />
         <plugin name="Device" value="CDVDevice" />
         <plugin name="Logger" value="CDVLogger" />
         <plugin name="Compass" value="CDVLocation" />

Manual installation - Windows "Universal" (8.1) version

Described above.

Quick installation test

TBD may be replaced:

Assuming your app has a recent template as used by the Cordova create script, add the following code to the onDeviceReady function, after app.receivedEvent('deviceready');:

  window.sqlitePlugin.openDatabase({ name: 'hello-world.db' }, function (db) {
    db.executeSql("select length('tenletters') as stringlength", [], function (res) {
      var stringlength = res.rows.item(0).stringlength;
      console.log('got stringlength: ' + stringlength);
      document.getElementById('deviceready').querySelector('.received').innerHTML = 'stringlength: ' + stringlength;
   });
  });

Old installation test

Make a change like this to index.html (or use the sample code) verify proper installation:

--- index.html.old	2012-08-04 14:40:07.000000000 +0200
+++ assets/www/index.html	2012-08-04 14:36:05.000000000 +0200
@@ -24,7 +24,35 @@
     <title>PhoneGap</title>
       <link rel="stylesheet" href="master.css" type="text/css" media="screen" title="no title">
       <script type="text/javascript" charset="utf-8" src="cordova-2.0.0.js"></script>
-      <script type="text/javascript" charset="utf-8" src="main.js"></script>
+      <script type="text/javascript" charset="utf-8" src="SQLitePlugin.js"></script>
+
+
+      <script type="text/javascript" charset="utf-8">
+      document.addEventListener("deviceready", onDeviceReady, false);
+      function onDeviceReady() {
+        var db = window.sqlitePlugin.openDatabase("Database", "1.0", "Demo", -1);
+
+        db.transaction(function(tx) {
+          tx.executeSql('DROP TABLE IF EXISTS test_table');
+          tx.executeSql('CREATE TABLE IF NOT EXISTS test_table (id integer primary key, data text, data_num integer)');
+
+          tx.executeSql("INSERT INTO test_table (data, data_num) VALUES (?,?)", ["test", 100], function(tx, res) {
+          console.log("insertId: " + res.insertId + " -- probably 1"); // check #18/#38 is fixed
+          alert("insertId: " + res.insertId + " -- should be valid");
+
+            db.transaction(function(tx) {
+              tx.executeSql("SELECT data_num from test_table;", [], function(tx, res) {
+                console.log("res.rows.length: " + res.rows.length + " -- should be 1");
+                alert("res.rows.item(0).data_num: " + res.rows.item(0).data_num + " -- should be 100");
+              });
+            });
+
+          }, function(e) {
+            console.log("ERROR: " + e.message);
+          });
+        });
+      }
+      </script>
 
   </head>
   <body onload="init();" id="stage" class="theme">

Common traps & pitfalls

The plugin class name starts with "SQL" in capital letters, but in Javascript the sqlitePlugin object name starts with "sql" in small letters.
Attempting to open a database before receiving the "deviceready" event callback.

Support

Reporting issues

If you have an issue with the plugin please check the following first:

You are using the latest version of the Plugin Javascript & platform-specific Java or Objective-C source from this repository.
You have installed the Javascript & platform-specific Java or Objective-C correctly.
You have included the correct version of the cordova Javascript and SQLitePlugin.js and got the path right.
You have registered the plugin properly in config.xml.

If you still cannot get something to work, please create a fresh, clean Cordova project, add this plugin according to the instructions above, and try a simple test program.

If you continue to see the issue in a new, clean Cordova project:

Make the simplest test program you can to demonstrate the issue, including the following characteristics:
- it completely self-contained, i.e. it is using no extra libraries beyond cordova & SQLitePlugin.js;
- if the issue is with adding data to a table, that the test program includes the statements you used to open the database and create the table;
- if the issue is with retrieving data from a table, that the test program includes the statements you used to open the database, create the table, and enter the data you are trying to retrieve.

Then you can raise the new issue.

Community forum

TBD

Unit tests

Unit testing is done in spec.

running tests from shell

TBD test.sh ~~not~~ tested with sqlcipher version of this plugin: does not auto-remove correct plugin id

To run the tests from *nix shell, simply do either:

./bin/test.sh ios

or for Android:

./bin/test.sh android

To run then from a windows powershell do either

.\bin\test.ps1 android

or for Windows (8.1):

.\bin\test.ps1 windows

Adapters

TBD: Need a smoother way to make these adapters work with the database encryption/decryption functionality.

Lawnchair Adapter

Common adapter

Please look at the Lawnchair-adapter tree that contains a common adapter, which should also work with the Android version, along with a test-www directory.

Included files

Include the following Javascript files in your HTML:

cordova.js (don't forget!)
lawnchair.js (you provide)
SQLitePlugin.js (in case of Cordova pre-3.0)
Lawnchair-sqlitePlugin.js (must come after SQLitePlugin.js in case of Cordova pre-3.0)

Sample

The name option determines the sqlite database filename, with no extension automatically added. Optionally, you can change the db filename using the db option.

In this example, you would be using/creating a database with filename kvstore:

kvstore = new Lawnchair({name: "kvstore"}, function() {
  // do stuff
);

Using the db option you can specify the filename with the desired extension and be able to create multiple stores in the same database file. (There will be one table per store.)

recipes = new Lawnchair({db: "cookbook", name: "recipes", ...}, myCallback());
ingredients = new Lawnchair({db: "cookbook", name: "ingredients", ...}, myCallback());

KNOWN ISSUE: the new db options are not supported by the Lawnchair adapter. The workaround is to first open the database file using sqlitePlugin.openDatabase().

PouchDB

The adapter is now part of PouchDB thanks to @nolanlawson, see PouchDB FAQ.

Contributing

Community

Testimonials of apps that are using this plugin would be especially helpful.
Reporting issues at litehelpers / Cordova-sqlcipher-adapter / issues can help improve the quality of this plugin.

Code

WARNING: Please do NOT propose changes from your default branch. In general, contributions are rebased using git rebase or git cherry-pick and not merged.

Patches with bug fixes are helpful, especially when submitted with test code.
Other enhancements welcome for consideration, when submitted with test code and are working for all supported platforms. Increase of complexity should be avoided.
All contributions may be reused by @brodybits (Chris Brody) under another license in the future. Efforts will be taken to give credit for major contributions but it will not be guaranteed.
Project restructuring, i.e. moving files and/or directories around, should be avoided if possible.
If you see a need for restructuring, it is better to first discuss it in a new issue where alternatives can be discussed before reaching a conclusion. If you want to propose a change to the project structure:
- Remember to make (and use) a special branch within your fork from which you can send the proposed restructuring;
- Always use git mv to move files & directories;
- Never mix a move/rename operation with any other changes in the same commit.

Major branches

common-src - source for Android, iOS, and Windows Universal (8.1) versions without sqlcipher
cipher-src - source for Android, iOS, and Windows Universal (8.1) versions with sqlcipher
cipher-rc - pre-release version, including sqlcipher dependencies
[FUTURE TBD] ~~cipher-master - version for release, may be included in PhoneGap build in the future.~~