Update open exchange chess engine handling

Execute (open exchange chess) engines directly from their native library path to support Android 10.

Author: gkalab

.gitignore

@@ -1,18 +1,19 @@
 *.iml
 .gradle
-/local.properties
-/.idea/caches
-/.idea/libraries
-/.idea/modules.xml
-/.idea/workspace.xml
-/.idea/navEditor.xml
-/.idea/assetWizardSettings.xml
+local.properties
+.idea/caches
+.idea/libraries
+.idea/modules.xml
+.idea/workspace.xml
+.idea/navEditor.xml
+.idea/assetWizardSettings.xml
+.idea/misc.xml
 .DS_Store
-/captures
+captures
 .externalNativeBuild
-/build
-/scidOnTheGo/build
-/chessEngineSupportLibrary/build
-/scidOnTheGo/src/main/jniLibs
-/scidOnTheGo/src/main/libs
-/scidOnTheGo/src/main/obj
+build
+scidOnTheGo/build
+chessEngineSupportLibrary/build
+scidOnTheGo/src/main/jniLibs
+scidOnTheGo/src/main/libs
+scidOnTheGo/src/main/obj

build.gradle

@@ -2,6 +2,7 @@
 buildscript {
     repositories {
         jcenter()
+        google()
     }
     dependencies {
         classpath 'com.android.tools.build:gradle:3.4.2'
@@ -11,5 +12,6 @@ buildscript {
 allprojects {
     repositories {
         jcenter()
+        google()
     }
 }

chessEngineSupportLibrary/src/main/java/com/kalab/chess/enginesupport/ChessEngine.java

@@ -13,35 +13,28 @@
  */
 package com.kalab.chess.enginesupport;
 
-import java.io.File;
-import java.io.FileNotFoundException;
-import java.io.FileOutputStream;
-import java.io.IOException;
-import java.io.InputStream;
-
 import android.app.Activity;
 import android.content.ComponentName;
-import android.content.ContentResolver;
 import android.content.Intent;
-import android.net.Uri;
 import android.os.Bundle;
-import android.util.Log;
 
 public class ChessEngine {
 
 	private static final String TAG = ChessEngine.class.getSimpleName();
 
 	private final String name;
 	private final String fileName;
+	private final String enginePath;
 	private final String authority;
 	private final String packageName;
 	private final int versionCode;
 	private final String licenseCheckActivity;
 
-	public ChessEngine(String name, String fileName, String authority,
-			String packageName, int versionCode, String licenseCheckActivity) {
+	public ChessEngine(String name, String fileName, String enginePath, String authority,
+					   String packageName, int versionCode, String licenseCheckActivity) {
 		this.name = name;
 		this.fileName = fileName;
+		this.enginePath = enginePath;
 		this.authority = authority;
 		this.packageName = packageName;
 		this.versionCode = versionCode;
@@ -56,47 +49,8 @@ public String getFileName() {
 		return this.fileName;
 	}
 
-	public Uri getUri() {
-		return Uri.parse("content://" + authority + "/" + fileName);
-	}
-
-	public File copyToFiles(ContentResolver contentResolver, File destination)
-			throws FileNotFoundException, IOException {
-		Uri uri = getUri();
-		File output = new File(destination, uri.getPath().toString());
-		copyUri(contentResolver, uri, output.getAbsolutePath());
-		return output;
-	}
-
-	public void copyUri(final ContentResolver contentResolver,
-			final Uri source, String targetFilePath) throws IOException,
-			FileNotFoundException {
-		InputStream istream = contentResolver.openInputStream(source);
-		copyFile(istream, targetFilePath);
-		setExecutablePermission(targetFilePath);
-	}
-
-	private void copyFile(InputStream istream, String targetFilePath)
-			throws FileNotFoundException, IOException {
-		FileOutputStream fout = new FileOutputStream(targetFilePath);
-		byte[] b = new byte[1024];
-		int numBytes = 0;
-		while ((numBytes = istream.read(b)) != -1) {
-			fout.write(b, 0, numBytes);
-		}
-		istream.close();
-		fout.close();
-	}
-
-	private void setExecutablePermission(String engineFileName)
-			throws IOException {
-		String cmd[] = { "chmod", "744", engineFileName };
-		Process process = Runtime.getRuntime().exec(cmd);
-		try {
-			process.waitFor();
-		} catch (InterruptedException e) {
-			Log.e(TAG, e.getMessage(), e);
-		}
+	public String getEnginePath() {
+		return this.enginePath;
 	}
 
 	public String getPackageName() {

chessEngineSupportLibrary/src/main/java/com/kalab/chess/enginesupport/ChessEngineProvider.java

@@ -13,21 +13,19 @@
  */
 package com.kalab.chess.enginesupport;
 
-import java.io.File;
-import java.io.FileNotFoundException;
-import java.io.IOException;
-
-import android.annotation.TargetApi;
 import android.content.ContentProvider;
 import android.content.ContentValues;
 import android.content.res.AssetFileDescriptor;
 import android.content.res.AssetManager;
 import android.database.Cursor;
 import android.net.Uri;
-import android.os.Build;
 import android.os.ParcelFileDescriptor;
 import android.util.Log;
 
+import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.IOException;
+
 public class ChessEngineProvider extends ContentProvider {
 
 	private static final String MIME_TYPE = "application/x-chess-engine";
@@ -70,14 +68,8 @@ public AssetFileDescriptor openAssetFile(Uri uri, String mode)
 		return descriptor;
 	}
 
-	@TargetApi(Build.VERSION_CODES.GINGERBREAD)
 	private String getNativeLibraryDir() {
-		if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.GINGERBREAD) {
-			return getContext().getApplicationInfo().nativeLibraryDir;
-		} else {
-			return getContext().getApplicationInfo().dataDir + File.separator
-					+ "lib";
-		}
+		return getContext().getApplicationInfo().nativeLibraryDir;
 	}
 
 	public ParcelFileDescriptor openLibFile(File f)
@@ -93,7 +85,7 @@ public String getType(Uri uri) {
 
 	@Override
 	public Cursor query(Uri uri, String[] projection, String selection,
-			String[] selectionArgs, String sortOrder) {
+						String[] selectionArgs, String sortOrder) {
 		throw new UnsupportedOperationException(UNSUPPORTED);
 	}
 
@@ -109,7 +101,7 @@ public Uri insert(Uri uri, ContentValues values) {
 
 	@Override
 	public int update(Uri uri, ContentValues values, String selection,
-			String[] selectionArgs) {
+					  String[] selectionArgs) {
 		throw new UnsupportedOperationException(UNSUPPORTED);
 	}
 }

chessEngineSupportLibrary/src/main/java/com/kalab/chess/enginesupport/ChessEngineResolver.java

@@ -13,21 +13,11 @@
  */
 package com.kalab.chess.enginesupport;
 
-import java.io.File;
-import java.io.FileNotFoundException;
-import java.io.IOException;
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-
-import org.xmlpull.v1.XmlPullParserException;
-
 import android.app.Activity;
 import android.content.Context;
 import android.content.Intent;
 import android.content.pm.ActivityInfo;
-import android.content.pm.PackageInfo;
+import android.content.pm.ApplicationInfo;
 import android.content.pm.PackageManager;
 import android.content.pm.PackageManager.NameNotFoundException;
 import android.content.pm.ResolveInfo;
@@ -37,6 +27,15 @@
 import android.os.Bundle;
 import android.util.Log;
 
+import org.xmlpull.v1.XmlPullParserException;
+
+import java.io.File;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
 public class ChessEngineResolver {
 
 	private static final String ENGINE_PROVIDER_MARKER = "intent.chess.provider.ENGINE";
@@ -46,12 +45,13 @@ public class ChessEngineResolver {
 	private Context context;
 	private String target;
 	/** map of package -> activity for license checks */
-	Map<String, String> licenseCheckActivities = new HashMap<String, String>();
+	private Map<String, String> licenseCheckActivities = new HashMap<>();
 
+	@SuppressWarnings("deprecation")
 	public ChessEngineResolver(Context context) {
 		super();
 		this.context = context;
-		this.target = Build.CPU_ABI;
+		this.target = Build.CPU_ABI; // use Build.SUPPORTED_ABIS[0] from API level 21 onwards
 		sanitizeArmV6Target();
 	}
 
@@ -68,7 +68,7 @@ private void sanitizeArmV6Target() {
 	 */
 	public List<ChessEngine> resolveEngines() {
 		resolveLicenseCheckActivitiesPerPackage();
-		List<ChessEngine> result = new ArrayList<ChessEngine>();
+		List<ChessEngine> result = new ArrayList<>();
 		final Intent engineProviderIntent = new Intent(ENGINE_PROVIDER_MARKER);
 		List<ResolveInfo> engineProviderList = context.getPackageManager()
 				.queryIntentActivities(engineProviderIntent,
@@ -130,7 +130,7 @@ private List<ChessEngine> resolveEnginesForPackage(
 	}
 
 	private void parseEngineListXml(XmlResourceParser parser, String authority,
-			List<ChessEngine> result, String packageName) {
+									List<ChessEngine> result, String packageName) {
 		try {
 			int eventType = parser.getEventType();
 			while (eventType != XmlResourceParser.END_DOCUMENT) {
@@ -149,7 +149,7 @@ private void parseEngineListXml(XmlResourceParser parser, String authority,
 	}
 
 	private void addEngine(List<ChessEngine> result, XmlResourceParser parser,
-			String authority, String packageName) {
+						   String authority, String packageName) {
 		if (parser.getName().equalsIgnoreCase("engine")) {
 			String fileName = parser.getAttributeValue(null, "filename");
 			String title = parser.getAttributeValue(null, "name");
@@ -165,66 +165,18 @@ private void addEngine(List<ChessEngine> result, XmlResourceParser parser,
 					} catch (NameNotFoundException e) {
 						Log.e(TAG, e.getMessage());
 					}
-					result.add(new ChessEngine(title, fileName, authority,
-							packageName, versionCode, licenseCheckActivities
-									.get(packageName)));
-				}
-			}
-		}
-	}
-
-	/**
-	 * Ensure that the engine is current. It re-copies the engine if it was not
-	 * current.
-	 *
-	 * @param fileName
-	 *            the file name of the engine
-	 * @param packageName
-	 *            the package name of the engine
-	 * @param versionCode
-	 *            the (installed) version code of the engine
-	 * @param destination
-	 *            the destination folder to copy a new engine to
-	 * @return the new version of the engine, -1 in case of an error (IOError or
-	 *         if no engine was found)
-	 */
-	public int ensureEngineVersion(String fileName, String packageName,
-			int versionCode, File destination) {
-		int result = -1;
-		PackageInfo packageInfo;
-		Log.d(TAG, "checking engine " + fileName + ", " + packageName
-				+ ", version " + versionCode);
-		try {
-			packageInfo = context.getPackageManager().getPackageInfo(
-					packageName, 0);
-			if (packageInfo.versionCode > versionCode
-					|| !(new File(destination, fileName).exists())) {
-				// package is updated or file is missing, need to copy engine
-				// again
-				for (ChessEngine engine : resolveEngines()) {
-					if (engine.getPackageName().equals(packageName)
-							&& engine.getFileName().equals(fileName)) {
-						try {
-							Log.d(TAG, "engine is outdated");
-							engine.copyToFiles(context.getContentResolver(),
-									destination);
-							result = packageInfo.versionCode;
-						} catch (FileNotFoundException e) {
-							Log.e(TAG, e.getMessage(), e);
-						} catch (IOException e) {
-							Log.e(TAG, e.getMessage(), e);
-						}
-						break;
+					try {
+						ApplicationInfo app = context.getPackageManager().getApplicationInfo(packageName, 0);
+						String enginePath = new File(app.nativeLibraryDir, fileName).getAbsolutePath();
+						result.add(new ChessEngine(title, fileName, enginePath, authority,
+								packageName, versionCode, licenseCheckActivities
+								.get(packageName)));
+					} catch (NameNotFoundException e) {
+						Log.e(TAG, e.getLocalizedMessage(), e);
 					}
 				}
-			} else {
-				Log.d(TAG, "engine is up-to-date");
-				result = packageInfo.versionCode;
 			}
-		} catch (NameNotFoundException e) {
-			Log.w(TAG, "package " + packageName + " not found");
 		}
-		return result;
 	}
 
 	/**
@@ -242,7 +194,7 @@ public int ensureEngineVersion(String fileName, String packageName,
 	 *            If a license check is performed the caller must check the result in onActivityResult()
 	 */
 	public boolean checkLicense(Activity caller, int requestCode,
-			String fileName, String packageName) {
+								String fileName, String packageName) {
 		Log.d(TAG, "checking license for engine " + fileName + ", "
 				+ packageName);
 		for (ChessEngine engine : resolveEngines()) {

scidOnTheGo/build.gradle

@@ -28,5 +28,10 @@ android {
 }
 
 dependencies {
+    implementation 'com.android.support:appcompat-v7:28.0.0'
+    implementation 'com.android.support:design:28.0.0'
+    implementation 'com.android.support:recyclerview-v7:28.0.0'
+    implementation 'com.android.support:support-compat:28.0.0'
+
     api project(':chessEngineSupportLibrary')
 }

scidOnTheGo/src/main/java/org/scid/android/ExportPgnActivity.java

@@ -4,6 +4,7 @@
 
 import android.app.Activity;
 import android.content.Intent;
+import android.os.AsyncTask;
 import android.os.Bundle;
 
 public class ExportPgnActivity extends Activity {
@@ -27,6 +28,6 @@ protected Boolean doInBackground(Void... params) {
 					return false;
 				}
 			}
-		}).execute();
+		}).executeOnExecutor(AsyncTask.THREAD_POOL_EXECUTOR);
 	}
 }