cordova-plugin-crosswire-sword 0.2.9 → 0.2.12

package/RELEASENOTES.md

@@ -20,6 +20,25 @@
 -->
 # Release Notes
 
+### 0.2.12 (Oct 5, 2026)
+* BibleSync on a network that loses packets, as Wi-Fi does: each verse carries a sequence number and is sent three times, which a receiver shows once; a peer is kept through half an hour of silence, not one minute; a newcomer is answered at once, twice; a beacon every 10 seconds (biblesync 2.2.0 with pull requests 19 and 20)
+* startBibleSync takes options { repeatCount, repeatDelayMS, peerLifetimeS }; the defaults are 2, 500 and 1800
+* getBibleSyncStatus says whether a running session is still alive on the same network interface (off, alive, disabled, moved), so an app resumed from sleep or the background restarts BibleSync only when it must
+* The page hears BibleSync's interface, its peers and its errors on both platforms ({ cmd: info | peer | error }); a beacon that cannot be sent while the phone sleeps no longer ends the session
+* iOS: BibleSync is offered (features.bibleSync), the app carrying Apple's multicast entitlement; every received message had been dropped
+
+### 0.2.11 (Oct 1, 2026)
+* Study data (bookmarks and, in time, notes) in a folder of the user's choosing, named sword-studydata so several devices and SWORD apps can share it (doc/bookmarks-format.md in Bishop): a picked folder holding bookmarks/, or itself named sword-studydata, is used as it is, otherwise sword-studydata/ is made inside it
+* iOS: the study-data folder may be in iCloud Drive or any app's folder; where a provider grants files but no folder (Google Drive), the bookmark files are picked in place (SWMgr_chooseDataFiles) or Bishop's own are saved there and opened once (SWMgr_exportDataFiles); a provider's file is rewritten in place so it keeps its identity
+* Android: a cloud provider's stale record of a replaced file is refreshed before the retry by name
+* initSWORD answers `features` ({ dataStorage, dataFiles, sharedStorage, bibleSync }) so the page can offer what the platform has; SWORD.js keeps it as SWORD.features
+* iOS: HTTPUtils_makeRequest takes the method codes SWORD.js defines (METHOD_GET is 0) and no longer crashes on a bad URL; a user agent naming the app, device and engine; sharing a verse through the system share sheet; passive FTP and verified peers set in InstallMgr.conf
+
+### 0.2.10 (Sep 26, 2026)
+* iOS: HTTP(S) through Apple's NSURLSession; no curl or OpenSSL in the app, so App Store Connect's export-compliance questions do not arise (only Apple's encryption)
+* Android: a cloud folder (Google Drive) whose provider is still loading is waited for instead of being taken as empty, a listing that fails is reported to the page, and a file another device replaced is found again by name; the app no longer creates a second personal.conf beside the real one
+* FTP without curl (iOS): EPSV first and PASV's advertised address ignored, as curl does, so sources such as STEP answer; failures are reported as with curl, so file-by-file installs proceed on sources without packages
+
 ### 0.2.9 (Sep 25, 2026)
 * BibleSync works: biblesync 2.2.0 with the Android and Apple interface discovery sent upstream; Android holds a Wi-Fi multicast lock while it runs (CHANGE_WIFI_MULTICAST_STATE); every speaker in the room is heard, not only the first
 * Android: a sword:// or bible:// link the app is opened with reaches the page as handleOpenURL, exactly as cordova-ios does, on a cold start and a warm one

package/libs/ios/SWORD.xcframework/Info.plist

@@ -8,7 +8,7 @@
 			<key>BinaryPath</key>
 			<string>libSWORD.a</string>
 			<key>LibraryIdentifier</key>
-			<string>ios-arm64-simulator</string>
+			<string>ios-arm64</string>
 			<key>LibraryPath</key>
 			<string>libSWORD.a</string>
 			<key>SupportedArchitectures</key>
@@ -17,14 +17,12 @@
 			</array>
 			<key>SupportedPlatform</key>
 			<string>ios</string>
-			<key>SupportedPlatformVariant</key>
-			<string>simulator</string>
 		</dict>
 		<dict>
 			<key>BinaryPath</key>
 			<string>libSWORD.a</string>
 			<key>LibraryIdentifier</key>
-			<string>ios-arm64</string>
+			<string>ios-arm64-simulator</string>
 			<key>LibraryPath</key>
 			<string>libSWORD.a</string>
 			<key>SupportedArchitectures</key>
@@ -33,6 +31,8 @@
 			</array>
 			<key>SupportedPlatform</key>
 			<string>ios</string>
+			<key>SupportedPlatformVariant</key>
+			<string>simulator</string>
 		</dict>
 	</array>
 	<key>CFBundlePackageType</key>

package/libs/ios/SWORD.xcframework/ios-arm64/libSWORD.a

@@ -1,4 +1,4 @@
 [diffend] Oversized file quarantined before diffing.
 name: package/libs/ios/SWORD.xcframework/ios-arm64/libSWORD.a
-size: 37291856 bytes
-sha256: 7409692a95d76c57900b0b8744ec40929a86d3b8ab9e1484ed44a9d2f6ef5a88
+size: 37330824 bytes
+sha256: 6d136d967767f7d43435f027eb9b8c07480da1c56e9002a541d75eb0fb23662f

package/libs/ios/SWORD.xcframework/ios-arm64-simulator/libSWORD.a

@@ -1,4 +1,4 @@
 [diffend] Oversized file quarantined before diffing.
 name: package/libs/ios/SWORD.xcframework/ios-arm64-simulator/libSWORD.a
-size: 37334896 bytes
-sha256: 8feff5c7f71809535934d6d4f72c040eb1c8064fdfa042450dac079420e203d9
+size: 37373760 bytes
+sha256: 72a444c94c56c42f8b07cc847e09a99364a1fabe63d8343088393c6ec3e89ba5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cordova-plugin-crosswire-sword",
-  "version": "0.2.9",
+  "version": "0.2.12",
   "description": "The SWORD Project Plugin",
   "files": [
     "plugin.xml",

package/plugin.xml

@@ -4,7 +4,7 @@
     xmlns:rim="http://www.blackberry.com/ns/widgets"
     xmlns:android="http://schemas.android.com/apk/res/android"
     id="cordova-plugin-crosswire-sword"
-    version="0.2.9">
+    version="0.2.12">
     <name>cordova-plugin-crosswire-sword</name>
     <description>The SWORD Project Plugin</description>
     <license>GNU 2.0</license>
@@ -137,13 +137,11 @@
 		<header-file src="src/ios/SWORD-Bridging-Header.h" type="BridgingHeader" />
 		<source-file src="src/ios/SWORD.swift" />
 		<framework src="libs/ios/SWORD.xcframework" custom="true" embed="false" />
-		<framework src="libs/ios/curl.xcframework" custom="true" embed="false" />
 		<framework src="libc++.tbd" />
 		<framework src="libz.tbd" />
 		<framework src="libicucore.tbd" />
 		<framework src="Security.framework" />
 		<framework src="CoreFoundation.framework" />
-		<framework src="SystemConfiguration.framework" />
 
 <!--	<source-file src="lib/ios/libSWORD.a" framework="true" /> -->
 	</platform>

package/src/android/SWMgr.java

@@ -164,9 +164,32 @@ public class SWMgr {
 	public static interface BibleSyncListener {
 		public void navReceived(String osisRef);
 		public void chatReceived(String user, String message);
+		/** the interface address BibleSync is on */
+		public void infoReceived(String iface);
+		/**
+		 * @param state 'A' a peer announced itself, 'S' it is a speaker we now listen to, 'D' a speaker went quiet
+		 * @param who user @ address ('D': the uuid)
+		 * @param what app version; device; uuid ('D': empty)
+		 */
+		public void peerReceived(char state, String who, String what);
+		/** the library could not send, or stopped itself: what it said, and its detail */
+		public void errorReceived(String message, String detail);
 	}
 	public native void        startBibleSync(String appName, String userName, String passphrase, BibleSyncListener listener);
+	/**
+	 * For the next startBibleSync; a negative value leaves that one as it is.
+	 * @param repeatCount how many more times each verse is sent (nobody resends multicast); default 2
+	 * @param repeatDelayMS at least this long between those; default 500
+	 * @param peerLifetimeS a peer not heard from for this many seconds is given up; default 1800
+	 */
+	public native void        setBibleSyncOptions(int repeatCount, int repeatDelayMS, int peerLifetimeS);
 	public native void        stopBibleSync();
+	/**
+	 * @return "off" (not running), "alive <address>",
+	 * "disabled <address>" (the library shut itself down) or
+	 * "moved <address> <address now>" (the network changed under it)
+	 */
+	public native String      getBibleSyncStatus();
 	public native void        sendBibleSyncMessage(String osisRef);
 }
 

package/src/android/SWORD.java

@@ -40,6 +40,7 @@ import org.json.JSONException;
 import org.json.JSONObject;
 
 import org.crosswire.android.sword.SWMgr;
+import org.crosswire.android.sword.SafStorage;
 import org.crosswire.android.sword.AndroidMgr;
 import org.crosswire.android.sword.SWModule;
 import org.crosswire.android.sword.InstallMgr;
@@ -52,6 +53,8 @@ import android.net.wifi.WifiManager;
 import android.app.Activity;
 
 public class SWORD extends CordovaPlugin {
+	// the app-neutral study-data folder (see SWMgr_getDataPath)
+	public static final String STUDY_DATA_FOLDER = "sword-studydata";
 	// held while BibleSync runs: without it most Wi-Fi drivers filter out the multicast group
 	private WifiManager.MulticastLock multicastLock = null;
 	public static final String TAG = "SWORD";
@@ -228,6 +231,15 @@ public class SWORD extends CordovaPlugin {
 		if (action.equals("initSWORD")) {
 			JSONObject r = new JSONObject();
 			r.put("version", mgr.version());
+			// what the page may offer on Android (SWORD.features): a shared
+			// module library and a study-data folder, both picked as SAF trees;
+			// no picking of single files (a tree grant covers any provider)
+			JSONObject features = new JSONObject();
+			features.put("sharedStorage", true);
+			features.put("dataStorage", true);
+			features.put("dataFiles", false);
+			features.put("bibleSync", true);
+			r.put("features", features);
 			callbackContext.success(r);
 		}
 		else if (action.equals("echo")) {
@@ -540,6 +552,8 @@ Log.d(TAG, "SWModule_getRenderChapter");
 			final String appName = args.getString(0);
 			final String userName = args.getString(1);
 			final String passphrase = args.getString(2);
+			// repeatCount, repeatDelayMS, peerLifetimeS: -1 (or absent) keeps the default
+			mgr.setBibleSyncOptions(args.optInt(3, -1), args.optInt(4, -1), args.optInt(5, -1));
 
 			if (multicastLock == null) {
 				WifiManager wifi = (WifiManager) cordova.getActivity().getApplicationContext().getSystemService(Context.WIFI_SERVICE);
@@ -574,6 +588,42 @@ Log.d(TAG, "SWModule_getRenderChapter");
 						}
 						catch (Exception e) { e.printStackTrace(); }
 					}
+					public void infoReceived(String iface) {
+						try {
+							JSONObject m = new JSONObject();
+							m.put("cmd", "info");
+							m.put("interface", iface);
+							PluginResult result = new PluginResult(PluginResult.Status.OK, m);
+							result.setKeepCallback(true);
+							bibleSyncListener.sendPluginResult(result);
+						}
+						catch (Exception e) { e.printStackTrace(); }
+					}
+					public void peerReceived(char state, String who, String what) {
+						try {
+							JSONObject m = new JSONObject();
+							m.put("cmd", "peer");
+							m.put("state", state == 'A' ? "announce" : (state == 'S' ? "speaker" : "gone"));
+							m.put("who", who);
+							m.put("what", what);
+							PluginResult result = new PluginResult(PluginResult.Status.OK, m);
+							result.setKeepCallback(true);
+							bibleSyncListener.sendPluginResult(result);
+						}
+						catch (Exception e) { e.printStackTrace(); }
+					}
+					public void errorReceived(String message, String detail) {
+						try {
+							JSONObject m = new JSONObject();
+							m.put("cmd", "error");
+							m.put("message", message);
+							m.put("detail", detail);
+							PluginResult result = new PluginResult(PluginResult.Status.OK, m);
+							result.setKeepCallback(true);
+							bibleSyncListener.sendPluginResult(result);
+						}
+						catch (Exception e) { e.printStackTrace(); }
+					}
 				});
 			    }
 			});
@@ -587,6 +637,16 @@ Log.d(TAG, "SWModule_getRenderChapter");
 			if (multicastLock != null && multicastLock.isHeld()) multicastLock.release();
 			callbackContext.success();
 		}
+		else if (action.equals("SWMgr_getBibleSyncStatus")) {
+			// "alive 10.0.0.5" -> { state, alive, interface, current }
+			String[] s = mgr.getBibleSyncStatus().split(" ");
+			JSONObject r = new JSONObject();
+			r.put("state", s[0]);
+			r.put("alive", s[0].equals("alive"));
+			r.put("interface", s.length > 1 ? s[1] : "");
+			r.put("current", s.length > 2 ? s[2] : (s.length > 1 ? s[1] : ""));
+			callbackContext.success(r);
+		}
 		else if (action.equals("SWMgr_setJavascript")) {
 			boolean val = args.getBoolean(0);
 			mgr.setJavascript(val);
@@ -635,9 +695,19 @@ Log.d(TAG, "SWModule_getRenderChapter");
 			else callbackContext.error("couldn't write: " + args.getString(0));
 		}
 		else if (action.equals("SWMgr_listDir")) {
-			JSONArray r = new JSONArray();
-			for (String s : mgr.listDir(args.getString(0))) r.put(s);
-			callbackContext.success(r);
+			// off the WebView thread: a cloud folder's provider may take
+			// seconds to finish loading, and the listing waits for it
+			final String path = args.getString(0);
+			cordova.getThreadPool().execute(new Runnable() { public void run() {
+				JSONArray r = new JSONArray();
+				for (String s : mgr.listDir(path)) r.put(s);
+				// a shared or data folder whose provider failed or never finished
+				// loading answers an empty listing natively; the page must know
+				SWMgr.SharedStorage ds = mgr.getDataStorage(), ss = mgr.getSharedStorage();
+				boolean failed = (ds instanceof SafStorage && ((SafStorage) ds).lastListFailed) || (ss instanceof SafStorage && ((SafStorage) ss).lastListFailed);
+				if (failed) callbackContext.error("couldn't list: " + path);
+				else callbackContext.success(r);
+			}});
 		}
 		else if (action.equals("SWMgr_removeFile")) {
 			if (mgr.removeFile(args.getString(0))) callbackContext.success();
@@ -685,7 +755,26 @@ Log.d(TAG, "SWModule_getRenderChapter");
 			callbackContext.success(label);
 		}
 		else if (action.equals("SWMgr_getDataPath")) {
-			callbackContext.success(mgr.getDataPath());
+			// study data lives in an app-neutral folder named sword-studydata
+			// (bookmarks/ inside it, later notes and the like), so several
+			// devices and several SWORD apps can share one.  Decided by what
+			// the picked folder holds, not by its name (a provider can report
+			// a name from before a rename for a while): a folder which already
+			// has bookmarks/ at its root IS the study-data folder, and so is one
+			// named sword-studydata (just created to be it, so still empty);
+			// otherwise sword-studydata/ inside it, existing or made on the
+			// first write.  The provider is asked, so off the WebView thread.
+			cordova.getThreadPool().execute(new Runnable() { public void run() {
+				String path = mgr.getDataPath();
+				SWMgr.SharedStorage ds = mgr.getDataStorage();
+				if (ds instanceof SafStorage && path.startsWith("/sword-data")) {
+					SafStorage saf = (SafStorage) ds;
+					SWMgr.FileInfo root = saf.stat("bookmarks");
+					boolean isIt = (root != null && root.isDirectory) || STUDY_DATA_FOLDER.equals(saf.rootName());
+					if (!isIt) path += STUDY_DATA_FOLDER + "/";
+				}
+				callbackContext.success(path);
+			}});
 		}
 		else if (action.equals("SWMgr_getDataStorage")) {
 			// the separately chosen study-data folder, or "" if study data lives beside the library

package/src/android/SafStorage.java

@@ -33,6 +33,7 @@ import android.content.ContentResolver;
 import android.content.Context;
 import android.database.Cursor;
 import android.net.Uri;
+import android.os.Bundle;
 import android.os.ParcelFileDescriptor;
 import android.provider.DocumentsContract;
 import android.provider.DocumentsContract.Document;
@@ -74,6 +75,8 @@ public class SafStorage implements SWMgr.SharedStorage {
 	private final Map<Integer, Staged> staged = new HashMap<Integer, Staged>();
 	// relative path -> document id, learned from listings and creations
 	private final Map<String, String> docIds = new HashMap<String, String>();
+	// how long a first listing of a cloud folder may keep loading before we take what there is
+	private static final long LIST_WAIT_MILLIS = 15000, LIST_POLL_MILLIS = 250;
 
 	public SafStorage(Context context, Uri treeUri) {
 		this.stagingDir = new java.io.File(context.getCacheDir(), "saf-staging");
@@ -86,6 +89,12 @@ public class SafStorage implements SWMgr.SharedStorage {
 
 	public Uri getTreeUri() { return treeUri; }
 
+	/** the picked folder's own name as the provider reports it, or null */
+	public String rootName() {
+		SWMgr.FileInfo info = queryOne(docUri(treeDocId));
+		return (info == null || info.name == null || info.name.length() == 0) ? null : info.name;
+	}
+
 	/** true if we still hold a grant for the tree and it is reachable */
 	public boolean isAvailable() {
 		return stat("") != null;
@@ -159,7 +168,30 @@ public class SafStorage implements SWMgr.SharedStorage {
 		String prefix = (dirPath.length() == 0) ? "" : dirPath + "/";
 		Cursor c = null;
 		try {
-			c = resolver.query(childrenUri, COLUMNS, null, null, null);
+			// a cloud provider (Google Drive) answers the first query on a folder
+			// it has not fetched yet with a partial, often empty, cursor flagged
+			// EXTRA_LOADING: taking that as the folder's contents made Bishop
+			// think a bookmarks file was absent and create a second one.  Ask
+			// again until the provider says it is done, within reason.
+			long deadline = System.currentTimeMillis() + LIST_WAIT_MILLIS;
+			while (true) {
+				c = resolver.query(childrenUri, COLUMNS, null, null, null);
+				if (c == null) break;
+				Bundle extras = c.getExtras();
+				String error = (extras == null) ? null : extras.getString(DocumentsContract.EXTRA_ERROR);
+				if (error != null) {
+					Log.w(TAG, "list failed for " + dirPath + ": provider says " + error);
+					return null;
+				}
+				boolean loading = extras != null && extras.getBoolean(DocumentsContract.EXTRA_LOADING, false);
+				if (!loading) break;
+				if (System.currentTimeMillis() > deadline) {
+					Log.w(TAG, "list of " + dirPath + " still loading after " + LIST_WAIT_MILLIS + " ms: not trusting it");
+					return null;
+				}
+				c.close(); c = null;
+				try { Thread.sleep(LIST_POLL_MILLIS); } catch (InterruptedException e) { break; }
+			}
 			if (c != null) {
 				while (c.moveToNext()) {
 					SWMgr.FileInfo info = fromCursor(c);
@@ -191,6 +223,32 @@ public class SafStorage implements SWMgr.SharedStorage {
 
 	@Override
 	public int open(String path, String mode, boolean create) {
+		int fd = openResolved(path, mode, create);
+		if (fd >= 0) return fd;
+		// the id we had may be stale: another device can replace a file
+		// under the same name (a cloud provider gives it a new id); forget
+		// what we knew and look the name up once more
+		String known;
+		synchronized (this) { known = docIds.get(path); }
+		if (known == null) return fd;
+		forget(path);
+		// ask the provider to refresh what it knows about the file and its
+		// folder (a cloud provider's local record can lag a change made on
+		// the web or on another device) before the name is looked up again
+		try {
+			resolver.refresh(docUri(known), null, null);
+			String parentId = resolve(parentOf(path));
+			if (parentId != null) resolver.refresh(DocumentsContract.buildChildDocumentsUriUsingTree(treeUri, parentId), null, null);
+		}
+		catch (Exception e) {
+			Log.i(TAG, "refresh not honoured for " + path + ": " + e);
+		}
+		forget(path);
+		Log.i(TAG, "retrying " + path + " by name after a failed open");
+		return openResolved(path, mode, create);
+	}
+
+	private int openResolved(String path, String mode, boolean create) {
 		String id = resolve(path);
 		if (id == null) {
 			if (!create) return -1;
@@ -301,12 +359,18 @@ public class SafStorage implements SWMgr.SharedStorage {
 		return info;
 	}
 
+	/** set when the last list() could not be trusted (the provider failed or
+	 *  never finished loading): native code sees only an empty listing, and
+	 *  the app must not take that for an empty folder */
+	public volatile boolean lastListFailed = false;
+
 	@Override
 	public SWMgr.FileInfo[] list(String path) {
+		lastListFailed = false;
 		String id = resolve(path);
 		if (id == null) return null;
 		List<SWMgr.FileInfo> entries = listChildren(path, id);
-		if (entries == null) return null;
+		if (entries == null) { lastListFailed = true; return null; }
 		return entries.toArray(new SWMgr.FileInfo[entries.size()]);
 	}