Show error if unable to load libirecovery on Linux (#278), clean up native library mappings

Author: airsquared

src/main/java/airsquared/blobsaver/app/LibimobiledeviceUtil.java

@@ -183,7 +183,16 @@ private static PointerByReference waitForRecovery() throws LibimobiledeviceExcep
             if (!sleep(1000)) {
                 return null;
             }
-            errorCode = Libirecovery.open(irecvClient);
+            try {
+                errorCode = Libirecovery.open(irecvClient);
+            } catch (UnsatisfiedLinkError e) {
+                if (Platform.isLinux()) {
+                    throw new LibimobiledeviceException("Error: libirecovery not found.\n\n" +
+                            "Please ensure you have libirecovery installed as libirecovery.so, and not as libirecovery-1.0.so.", null, 0, false);
+                } else {
+                    throw e;
+                }
+            }
         }
         throwIfNeeded(errorCode, ErrorCodeType.irecv_error);
         return irecvClient;
@@ -259,11 +268,11 @@ private static Pointer getMobileGestaltKey(String key) throws LibimobiledeviceEx
         PointerByReference diagnosticsRelayClient = new PointerByReference();
         throwIfNeeded(diagnostics_relay_client_new(device.getValue(), service.getValue(), diagnosticsRelayClient), ErrorCodeType.diagnostics_relay_error);
 
-        Pointer keys = Libplist.plist_new_array();
-        Libplist.plist_array_append_item(keys, Libplist.plist_new_string(key));
+        Pointer keys = Libplist.newArray();
+        Libplist.arrayAppendItem(keys, Libplist.newString(key));
         PointerByReference plistResult = new PointerByReference();
         throwIfNeeded(diagnostics_relay_query_mobilegestalt(diagnosticsRelayClient.getValue(), keys, plistResult), ErrorCodeType.diagnostics_relay_error);
-        Pointer plistApnonce = Libplist.plist_dict_get_item(Libplist.plist_dict_get_item(plistResult.getValue(), "MobileGestalt"), key);
+        Pointer plistApnonce = Libplist.dictGetItem(Libplist.dictGetItem(plistResult.getValue(), "MobileGestalt"), key);
 
         diagnostics_relay_goodbye(diagnosticsRelayClient.getValue());
         diagnostics_relay_client_free(diagnosticsRelayClient.getValue());
@@ -276,7 +285,7 @@ private static Pointer getMobileGestaltKey(String key) throws LibimobiledeviceEx
 
     private static String plistDataToString(Pointer plist, ByteOrder byteOrder) {
         IntByReference apnonceLength = new IntByReference();
-        byte[] apnonceBytes = Libplist.plist_get_data_ptr(plist, apnonceLength).getByteArray(0, apnonceLength.getValue());
+        byte[] apnonceBytes = Libplist.getDataPtr(plist, apnonceLength).getByteArray(0, apnonceLength.getValue());
         String toReturn = Utils.bytesToHex(apnonceBytes, byteOrder);
         Libplist.free(plist);
 
@@ -369,7 +378,7 @@ public void showErrorAlert() {
             String message = getMessage();
             if (reportable) {
                 Utils.showReportableError(message);
-            } else if (errorType.equals(ErrorCodeType.idevice_error) && errorCode == -3 && Platform.isWindows()) {
+            } else if (ErrorCodeType.idevice_error.equals(errorType) && errorCode == -3 && Platform.isWindows()) {
                 message += "\n\nEnsure iTunes or Apple's iOS Drivers are installed.";
                 ButtonType downloadItunes = new ButtonType("Download iTunes");
                 if (downloadItunes.equals(Utils.showUnreportableError(message, downloadItunes))) {

src/main/java/airsquared/blobsaver/app/natives/Libimobiledevice.java

@@ -18,7 +18,6 @@
 
 package airsquared.blobsaver.app.natives;
 
-import com.sun.jna.Native;
 import com.sun.jna.Pointer;
 import com.sun.jna.ptr.PointerByReference;
 
@@ -59,6 +58,6 @@ public class Libimobiledevice {
     public static native void idevice_free(Pointer idevice);
 
     static {
-        Native.register(Libimobiledevice.class, "imobiledevice");
+        NativeUtils.register(Libimobiledevice.class, "imobiledevice");
     }
 }

src/main/java/airsquared/blobsaver/app/natives/Libirecovery.java

@@ -18,7 +18,7 @@
 
 package airsquared.blobsaver.app.natives;
 
-import com.sun.jna.Native;
+import airsquared.blobsaver.app.natives.NativeUtils.CFunctionName;
 import com.sun.jna.Pointer;
 import com.sun.jna.Structure;
 import com.sun.jna.ptr.PointerByReference;
@@ -32,43 +32,25 @@ public static int open(PointerByReference irecv_client) {
         return irecv_open_with_ecid(irecv_client, 0);
     }
 
-    public static int close(Pointer irecv_client) {
-        return irecv_close(irecv_client);
-    }
-
-    public static int setEnv(Pointer irecv_client, String variable, String value) {
-        return irecv_setenv(irecv_client, variable, value);
-    }
-
-    public static int saveEnv(Pointer irecv_client) {
-        return irecv_saveenv(irecv_client);
-    }
-
-    public static int reboot(Pointer irecv_client) {
-        return irecv_reboot(irecv_client);
-    }
-
-    public static int sendCommand(Pointer irecv_client, String command) {
-        return irecv_send_command(irecv_client, command);
-    }
-
-    public static irecv_device_info getDeviceInfo(Pointer irecv_client) {
-        return irecv_get_device_info(irecv_client);
-    }
-
     private static native int irecv_open_with_ecid(PointerByReference irecv_client, long ecid);
 
-    private static native int irecv_close(Pointer irecv_client);
+    @CFunctionName("irecv_close")
+    public static native int close(Pointer irecv_client);
 
-    private static native int irecv_setenv(Pointer irecv_client, String variable, String value);
+    @CFunctionName("irecv_setenv")
+    public static native int setEnv(Pointer irecv_client, String variable, String value);
 
-    private static native int irecv_saveenv(Pointer irecv_client);
+    @CFunctionName("irecv_saveenv")
+    public static native int saveEnv(Pointer irecv_client);
 
-    private static native int irecv_reboot(Pointer irecv_client);
+    @CFunctionName("irecv_reboot")
+    public static native int reboot(Pointer irecv_client);
 
-    private static native int irecv_send_command(Pointer irecv_client, String command);
+    @CFunctionName("irecv_send_command")
+    public static native int sendCommand(Pointer irecv_client, String command);
 
-    private static native irecv_device_info irecv_get_device_info(Pointer irecv_client);
+    @CFunctionName("irecv_get_device_info")
+    public static native irecv_device_info getDeviceInfo(Pointer irecv_client);
 
     @SuppressWarnings({"unused", "SpellCheckingInspection"})
     @Structure.FieldOrder({"cpid", "cprv", "cpfm", "scep", "bdid", "ecid", "ibfl", "srnm", "imei", "srtg", "serial_string", "ap_nonce", "ap_nonce_size", "sep_nonce", "sep_nonce_size"})
@@ -83,7 +65,8 @@ public static class irecv_device_info extends Structure {
         public int sep_nonce_size;
     }
 
+
     static {
-        Native.register(Libirecovery.class, "irecovery");
+        NativeUtils.register(Libirecovery.class, "irecovery");
     }
 }

src/main/java/airsquared/blobsaver/app/natives/Libplist.java

@@ -18,42 +18,38 @@
 
 package airsquared.blobsaver.app.natives;
 
-import com.sun.jna.Native;
+import airsquared.blobsaver.app.natives.NativeUtils.CFunctionName;
 import com.sun.jna.Pointer;
 import com.sun.jna.ptr.IntByReference;
 import com.sun.jna.ptr.PointerByReference;
 
 public class Libplist {
 
-    public static void getStringVal(Pointer plist, PointerByReference value) {
-        plist_get_string_val(plist, value);
-    }
-
-    public static void free(Pointer plist) {
-        plist_free(plist);
-    }
-
-    public static void toXml(Pointer plist, PointerByReference plist_xml, PointerByReference length) {
-        plist_to_xml(plist, plist_xml, length);
-    }
-
-    public static native Pointer plist_new_array();
+    @CFunctionName("plist_new_array")
+    public static native Pointer newArray();
 
-    public static native void plist_array_append_item(Pointer plist_t, Pointer plist_t_item);
+    @CFunctionName("plist_array_append_item")
+    public static native void arrayAppendItem(Pointer plist_t, Pointer plist_t_item);
 
-    public static native Pointer plist_new_string(String val);
+    @CFunctionName("plist_new_string")
+    public static native Pointer newString(String val);
 
-    public static native Pointer plist_dict_get_item(Pointer plist, String key);
+    @CFunctionName("plist_dict_get_item")
+    public static native Pointer dictGetItem(Pointer plist, String key);
 
-    public static native Pointer plist_get_data_ptr(Pointer plist, IntByReference length);
+    @CFunctionName("plist_get_data_ptr")
+    public static native Pointer getDataPtr(Pointer plist, IntByReference length);
 
-    private static native void plist_get_string_val(Pointer plist, PointerByReference value);
+    @CFunctionName("plist_get_string_val")
+    public static native void getStringVal(Pointer plist, PointerByReference value);
 
-    private static native void plist_free(Pointer plist);
+    @CFunctionName("plist_free")
+    public static native void free(Pointer plist);
 
-    private static native void plist_to_xml(Pointer plist, PointerByReference plist_xml, PointerByReference length);
+    @CFunctionName("plist_to_xml")
+    public static native void toXml(Pointer plist, PointerByReference plist_xml, PointerByReference length);
 
     static {
-        Native.register(Libplist.class, "plist");
+        NativeUtils.register(Libplist.class, "plist");
     }
 }

src/main/java/airsquared/blobsaver/app/natives/NativeUtils.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright (c) 2021  airsquared
+ *
+ * This file is part of blobsaver.
+ *
+ * blobsaver is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, version 3 of the License.
+ *
+ * blobsaver is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with blobsaver.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package airsquared.blobsaver.app.natives;
+
+import com.sun.jna.FunctionMapper;
+import com.sun.jna.Library;
+import com.sun.jna.Native;
+import com.sun.jna.NativeLibrary;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+import java.util.Map;
+
+final class NativeUtils {
+
+
+    private static final Map<String, ?> libraryOptions = Map.of(Library.OPTION_CLASSLOADER, NativeUtils.class.getClassLoader(),
+            Library.OPTION_FUNCTION_MAPPER, (FunctionMapper) (lib, method) ->
+                    method.isAnnotationPresent(CFunctionName.class) ?
+                            method.getAnnotation(CFunctionName.class).value() : method.getName());
+
+    /**
+     * Same exact implementation as Native.register(Class, String), except it
+     * also includes a function mapper for methods annotated with @CFunctionName
+     */
+    static void register(Class<?> cls, String libName) {
+        Native.register(cls, NativeLibrary.getInstance(libName, libraryOptions));
+    }
+
+    @Documented
+    @Retention(RetentionPolicy.RUNTIME)
+    @Target(ElementType.METHOD)
+    @interface CFunctionName {
+        String value();
+    }
+}