cordova-plugin-crosswire-sword 0.2.8 → 0.2.11

package/RELEASENOTES.md

@@ -20,6 +20,24 @@
 -->
 # Release Notes
 
+### 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
+* iOS: a received BibleSync verse no longer crashes the app
+* The native binaries come from the sword-android-latest and sword-ios-latest links on crosswire.org
+
 ### 0.2.8 (Aug 22, 2026)
 * iOS: builds with cordova-ios 8 and Xcode 27 (xcframeworks for libsword and curl 8.22 with OpenSSL 3.5.8, verified against the iOS trust store)
 * The native binaries of both platforms are no longer in git: `make fetch` in bindings/Android and `make ios` in bindings/objc/dependencies download the published sets from crosswire.org

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: 37277640 bytes
-sha256: d4e974f37e98c9b7f39b1b8d253066bf01b3379f40dc13d29ef85930f17e01b4
+size: 37229112 bytes
+sha256: 3e031f0b4dbd6b3c5096cadf56adca793363d9d4bb40ad0810e79e2d2d4e7260

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: 37320688 bytes
-sha256: bd561095edca8a5277528bcd3140cc14b474d85498dd891d6656dd93e180db57
+size: 37272016 bytes
+sha256: d4a361c089cb1384d15fce6755470d9d3bd012d8acf7af69ba27315ea4f71ae8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cordova-plugin-crosswire-sword",
-  "version": "0.2.8",
+  "version": "0.2.11",
   "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.8">
+    version="0.2.11">
     <name>cordova-plugin-crosswire-sword</name>
     <description>The SWORD Project Plugin</description>
     <license>GNU 2.0</license>
@@ -43,6 +43,10 @@
                 <param name="android-package" value="org.crosswire.sword.cordova.SWORD"/>
             </feature>
         </config-file>
+        <!-- BibleSync: Wi-Fi drivers drop multicast unless the app holds a MulticastLock -->
+        <config-file target="AndroidManifest.xml" parent="/*">
+            <uses-permission android:name="android.permission.CHANGE_WIFI_MULTICAST_STATE" />
+        </config-file>
         <source-file src="src/android/SWORD.java" target-dir="src/org/crosswire/sword/cordova" />
         <source-file src="src/android/SWMgr.java" target-dir="src/org/crosswire/android/sword" />
         <source-file src="src/android/AndroidMgr.java" target-dir="src/org/crosswire/android/sword" />
@@ -133,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/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;
@@ -47,9 +48,15 @@ import org.crosswire.android.sword.InstallMgr;
 import android.provider.Settings;
 import android.util.Log;
 import android.content.Intent;
+import android.content.Context;
+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";
 	public static SWMgr mgr = null;
 	public static InstallMgr installMgr = null;
@@ -74,9 +81,28 @@ public class SWORD extends CordovaPlugin {
 	* @param webView The CordovaWebView Cordova is running in.
 	*/
 	// a sword:// or bible:// link the app was opened with, held until the
-	// page asks for it (SWMgr_getLaunchUrl)
+	// page has loaded, then handed to it exactly as cordova-ios's
+	// HandleOpenUrl does: handleOpenURL(url) once deviceready has fired
 	private static String launchUrl = null;
 
+	private void pushOpenUrl(final String url) {
+		final String js = "document.addEventListener('deviceready',function(){if (typeof handleOpenURL === 'function') { handleOpenURL(" + org.json.JSONObject.quote(url) + ");}});";
+		cordova.getActivity().runOnUiThread(new Runnable() { public void run() {
+			webView.getEngine().evaluateJavascript(js, null);
+		}});
+	}
+
+	// cold start: the page is loaded, the link can go in
+	@Override
+	public Object onMessage(String id, Object data) {
+		if ("onPageFinished".equals(id) && launchUrl != null) {
+			String url = launchUrl;
+			launchUrl = null;
+			pushOpenUrl(url);
+		}
+		return null;
+	}
+
 	private static String deepLink(Intent intent) {
 		if (intent == null || intent.getData() == null) return null;
 		String scheme = intent.getData().getScheme();
@@ -84,14 +110,12 @@ public class SWORD extends CordovaPlugin {
 		return intent.getDataString();
 	}
 
+	// warm start: the page is up, the link goes straight in
 	@Override
 	public void onNewIntent(Intent intent) {
 		final String url = deepLink(intent);
 		if (url == null) return;
-		launchUrl = url;
-		cordova.getActivity().runOnUiThread(new Runnable() { public void run() {
-			webView.getEngine().evaluateJavascript("if (window.swordDeepLink) swordDeepLink(" + org.json.JSONObject.quote(url) + ");", null);
-		}});
+		pushOpenUrl(url);
 	}
 
 	// who is asking, for the servers we talk to: "Bishop/1.7.905 (OnePlus
@@ -207,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")) {
@@ -520,6 +553,12 @@ Log.d(TAG, "SWModule_getRenderChapter");
 			final String userName = args.getString(1);
 			final String passphrase = args.getString(2);
 
+			if (multicastLock == null) {
+				WifiManager wifi = (WifiManager) cordova.getActivity().getApplicationContext().getSystemService(Context.WIFI_SERVICE);
+				if (wifi != null) { multicastLock = wifi.createMulticastLock("BibleSync"); multicastLock.setReferenceCounted(false); }
+			}
+			if (multicastLock != null) multicastLock.acquire();
+
 			cordova.getThreadPool().execute(new Runnable() {
 			    @Override
 			    public void run() {
@@ -557,6 +596,7 @@ Log.d(TAG, "SWModule_getRenderChapter");
 		}
 		else if (action.equals("SWMgr_stopBibleSync")) {
 			mgr.stopBibleSync();
+			if (multicastLock != null && multicastLock.isHeld()) multicastLock.release();
 			callbackContext.success();
 		}
 		else if (action.equals("SWMgr_setJavascript")) {
@@ -587,6 +627,7 @@ Log.d(TAG, "SWModule_getRenderChapter");
 			String translated = mgr.translate(text, locale);
 			callbackContext.success(translated);
 		}
+		// kept for older pages; the link now arrives through handleOpenURL
 		else if (action.equals("SWMgr_getLaunchUrl")) {
 			String url = launchUrl;
 			launchUrl = null;
@@ -606,9 +647,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();
@@ -656,7 +707,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()]);
 	}