Merge pull request #371 from magnusja/develop

magnusja · web-flow · commit c25e64345a8d · 2023-03-10T12:03:18.000+01:00
core v0.9.2 libusbcommunication v0.2.3
diff --git a/.github/workflows/android.yml b/.github/workflows/android.yml
@@ -14,9 +14,9 @@ jobs:
       with:
         java-version: 1.11
     - name: install libusb
-      run: wget https://github.com/libusb/libusb/archive/v1.0.24.zip && unzip v1.0.24.zip
+      run: wget https://github.com/libusb/libusb/archive/v1.0.26.zip && unzip v1.0.26.zip
     - name: write local properties
-      run: echo "libusb.dir=$GITHUB_WORKSPACE/libusb-1.0.24" > $GITHUB_WORKSPACE/local.properties
+      run: echo "libusb.dir=$GITHUB_WORKSPACE/libusb-1.0.26" > $GITHUB_WORKSPACE/local.properties
     - name: Build & test with Gradle
       run: ./gradlew jacocoTestReport --stacktrace
     - name: codecov
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@ A library to access USB mass storage devices (pen drives, external HDDs, card re
 The library can be included into your project like this:
 
 ```ruby
-implementation 'me.jahnen.libaums:core:0.9.1'
+implementation 'me.jahnen.libaums:core:0.9.2'
 ```
 
 If you need the HTTP or the storage provider module:
@@ -93,7 +93,7 @@ UsbFile root = currentFs.getRootDirectory();
 UsbFile[] files = root.listFiles();
 for(UsbFile file: files) {
     Log.d(TAG, file.getName());
-    if(file.isDirectory()) {
+    if(!file.isDirectory()) {
         Log.d(TAG, file.getLength());
     }
 }
diff --git a/androidtests/build.gradle b/androidtests/build.gradle
@@ -29,6 +29,7 @@ android {
     useLibrary 'android.test.runner'
     useLibrary 'android.test.base'
     useLibrary 'android.test.mock'
+    namespace 'me.jahnen.libaums.core.androidtests'
 }
 
 dependencies {
diff --git a/androidtests/src/main/AndroidManifest.xml b/androidtests/src/main/AndroidManifest.xml
@@ -1,3 +1,2 @@
-<manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    package="me.jahnen.libaums.core.androidtests">
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
 </manifest>
diff --git a/app/build.gradle b/app/build.gradle
@@ -18,10 +18,11 @@ android {
             proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
         }
     }
-
-    lintOptions {
+    lint {
         abortOnError false
     }
+    namespace 'me.jahnen.libaums.core.usbfileman'
+
 }
 
 dependencies {
diff --git a/app/src/main/AndroidManifest.xml b/app/src/main/AndroidManifest.xml
@@ -17,8 +17,7 @@
  */
 -->
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    xmlns:tools="http://schemas.android.com/tools"
-    package="me.jahnen.libaums.core.usbfileman" >
+    xmlns:tools="http://schemas.android.com/tools">
 
     <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
     <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
diff --git a/build.gradle b/build.gradle
@@ -1,25 +1,25 @@
 // Top-level build file where you can add configuration options common to all sub-projects/modules.
 
 buildscript {
-    ext.kotlin_version = '1.6.10'
+    ext.kotlin_version = '1.8.0'
     repositories {
         mavenCentral()
         maven { url "https://plugins.gradle.org/m2/" }
         google()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:7.0.4'
+        classpath 'com.android.tools.build:gradle:7.4.2'
 
         classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.8.4'
         classpath 'com.github.dcendents:android-maven-gradle-plugin:2.1'
 
         classpath 'org.codehaus.groovy:groovy-all:2.4.15'
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
 
-        classpath "org.jetbrains.dokka:dokka-gradle-plugin:1.6.10"
-        classpath "org.jacoco:org.jacoco.core:0.8.7"
+        classpath "org.jetbrains.dokka:dokka-gradle-plugin:1.8.10"
+        classpath "org.jacoco:org.jacoco.core:0.8.8"
         classpath 'com.dicedmelon.gradle:jacoco-android:0.1.5'
-        classpath 'io.github.gradle-nexus:publish-plugin:1.1.0'
+        classpath 'io.github.gradle-nexus:publish-plugin:1.3.0'
         // NOTE: Do not place your application dependencies here; they belong
         // in the individual module build.gradle files
     }
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,6 +1,6 @@
-#Wed Sep 11 11:27:30 CEST 2019
+#Tue Nov 22 10:59:55 CET 2022
 distributionBase=GRADLE_USER_HOME
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.5-bin.zip
 distributionPath=wrapper/dists
-zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.3-all.zip
+zipStoreBase=GRADLE_USER_HOME
diff --git a/httpserver/build.gradle b/httpserver/build.gradle
@@ -30,9 +30,10 @@ android {
             proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
         }
     }
-    lintOptions {
+    lint {
         abortOnError false
     }
+    namespace 'me.jahnen.libaums.core.httpserver'
 }
 
 
diff --git a/httpserver/src/main/AndroidManifest.xml b/httpserver/src/main/AndroidManifest.xml
@@ -1,5 +1,4 @@
-<manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    package="me.jahnen.libaums.core.httpserver">
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
 
     <uses-permission android:name="android.permission.INTERNET" />
 
diff --git a/javafs/build.gradle b/javafs/build.gradle
@@ -17,9 +17,10 @@ android {
             proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
         }
     }
-    lintOptions {
+    lint {
         abortOnError false
     }
+    namespace 'me.jahnen.libaums.javafs'
 }
 
 dependencies {
diff --git a/javafs/src/main/AndroidManifest.xml b/javafs/src/main/AndroidManifest.xml
@@ -1,5 +1,4 @@
-<manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    package="me.jahnen.libaums.javafs">
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
 
     <application android:allowBackup="true"
         android:supportsRtl="true">
diff --git a/libaums/build.gradle b/libaums/build.gradle
@@ -9,7 +9,7 @@ jacoco {
 
 ext {
     PUBLISH_GROUP_ID = 'me.jahnen.libaums'
-    PUBLISH_VERSION = '0.9.1'
+    PUBLISH_VERSION = '0.9.2'
     PUBLISH_ARTIFACT_ID = 'core'
 }
 
@@ -44,9 +44,6 @@ android {
         }
     }
 
-    lintOptions {
-        abortOnError false
-    }
 
     // TODO remove this?
     testOptions {
@@ -66,21 +63,25 @@ android {
             path "CMakeLists.txt"
         }
 
-        ndkVersion '23.1.7779620'
+        ndkVersion '25.2.9519653'
+    }
+    lint {
+        abortOnError false
     }
+    namespace 'me.jahnen.libaums.core'
 }
 
 dependencies {
-    testImplementation 'junit:junit:4.13'
+    testImplementation 'junit:junit:4.13.1'
     testImplementation 'org.apache.commons:commons-io:1.3.2'
     testImplementation 'com.eclipsesource.minimal-json:minimal-json:0.9.4'
     testImplementation 'org.xenei:junit-contracts:0.1.7'
     testImplementation 'org.mockito:mockito-core:2.28.2'
 
-    api 'androidx.annotation:annotation:1.3.0'
-    javadocDeps 'androidx.annotation:annotation:1.3.0'
-    api 'androidx.core:core:1.8.0-alpha01'
-    api "androidx.core:core-ktx:1.7.0"
+    api 'androidx.annotation:annotation:1.6.0'
+    javadocDeps 'androidx.annotation:annotation:1.6.0'
+    api 'androidx.core:core:1.12.0-alpha01'
+    api "androidx.core:core-ktx:1.9.0"
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
 }
 
diff --git a/libaums/src/main/AndroidManifest.xml b/libaums/src/main/AndroidManifest.xml
@@ -15,6 +15,6 @@
  * limitations under the License.
  */
 -->
-<manifest package="me.jahnen.libaums.core">
+<manifest>
 
 </manifest>
diff --git a/libaums/src/main/java/me/jahnen/libaums/core/UsbMassStorageDevice.kt b/libaums/src/main/java/me/jahnen/libaums/core/UsbMassStorageDevice.kt
@@ -168,8 +168,10 @@ private constructor(private val usbManager: UsbManager,
      * or write from or to the partitions returned by [.getPartitions].
      */
     fun close() {
-        usbCommunication.close()
-        inited = false
+        if (inited) {
+            usbCommunication.close()
+            inited = false
+        }
     }
 
     companion object {
diff --git a/libaums/src/main/java/me/jahnen/libaums/core/driver/scsi/ScsiBlockDevice.kt b/libaums/src/main/java/me/jahnen/libaums/core/driver/scsi/ScsiBlockDevice.kt
@@ -56,7 +56,7 @@ class ScsiBlockDevice(private val usbCommunication: UsbCommunication, private va
      *
      * @return The block device size in blocks
      */
-    override val blocks: Long = lastBlockAddress.toLong()
+    override val blocks: Long get() = lastBlockAddress.toLong()
 
     /**
      * Issues a SCSI Inquiry to determine the connected device. After that it is
diff --git a/libaums/src/main/java/me/jahnen/libaums/core/fs/FileSystemFactory.kt b/libaums/src/main/java/me/jahnen/libaums/core/fs/FileSystemFactory.kt
@@ -31,8 +31,20 @@ import java.util.*
  * @author mjahnen
  */
 object FileSystemFactory {
+    private data class PrioritizedFileSystemCreator(val priority: Int, val count: Int, val creator: FileSystemCreator)
+
+    private var count = 0
+    private val fileSystems = TreeSet(
+        compareBy<PrioritizedFileSystemCreator> { it.priority }.thenBy { it.count }
+    )
+
+    /**
+     * The default priority of a creator registered with the file system.  Creators will be evaluated
+     * in order from lowest priority number to highest priority number.  If two creators are
+     * registered with the same priority then the one inserted first will be evaluated first.
+     */
+    const val DEFAULT_PRIORITY = 0
 
-    private val fileSystems = ArrayList<FileSystemCreator>()
     /**
      * Set the timezone a file system should use to decode timestamps, if the file system only stores
      * local date and time and has no reference which zone these timestamp correspond to. (True for
@@ -45,14 +57,15 @@ object FileSystemFactory {
     class UnsupportedFileSystemException : IOException()
 
     init {
-        registerFileSystem(Fat32FileSystemCreator())
+        registerFileSystem(Fat32FileSystemCreator(), DEFAULT_PRIORITY + 1)
     }
 
+    @Synchronized
     @Throws(IOException::class, FileSystemFactory.UnsupportedFileSystemException::class)
     fun createFileSystem(entry: PartitionTableEntry,
                          blockDevice: BlockDeviceDriver): FileSystem {
-        for (creator in fileSystems) {
-            val fs = creator.read(entry, blockDevice)
+        fileSystems.forEach {
+            val fs = it.creator.read(entry, blockDevice)
             if (fs != null) {
                 return fs
             }
@@ -62,14 +75,40 @@ object FileSystemFactory {
     }
 
     /**
-     * Register a new file system.
+     * Register a new file system at the default priority.
      * @param creator The creator which is able to check if a [BlockDeviceDriver] is holding
      * the correct type of file system and is able to instantiate a [FileSystem]
      * instance.
      */
     @Synchronized
     @JvmStatic
     fun registerFileSystem(creator: FileSystemCreator) {
-        fileSystems.add(creator)
+        registerFileSystem(creator, DEFAULT_PRIORITY)
+    }
+
+    /**
+     * Register a new file system with the given priority.
+     * @param creator The creator which is able to check if a [BlockDeviceDriver] is holding
+     * the correct type of file system and is able to instantiate a [FileSystem]
+     * instance.
+     *
+     * @param priority The priority this file system creator has when attempting to
+     * create a file system.
+     */
+    @Synchronized
+    @JvmStatic
+    fun registerFileSystem(creator: FileSystemCreator, priority: Int) {
+        fileSystems.add(PrioritizedFileSystemCreator(priority, count++, creator))
     }
+
+
+    /**
+     * Removes all registered file systems.
+     */
+    @Synchronized
+    @JvmStatic
+    fun clearFileSystems() {
+        fileSystems.clear()
+    }
+
 }
diff --git a/libaums/src/test/java/me/jahnen/libaums/core/fs/FileSystemFactoryTest.java b/libaums/src/test/java/me/jahnen/libaums/core/fs/FileSystemFactoryTest.java
@@ -4,13 +4,16 @@
 import me.jahnen.libaums.core.driver.ByteBlockDevice;
 import me.jahnen.libaums.core.driver.file.FileBlockDeviceDriver;
 import me.jahnen.libaums.core.fs.fat32.Fat32FileSystem;
+import me.jahnen.libaums.core.fs.fat32.Fat32FileSystemCreator;
 import me.jahnen.libaums.core.partition.PartitionTableEntry;
 import me.jahnen.libaums.core.partition.PartitionTypes;
 
 import org.junit.Test;
-
 import java.net.URL;
+import java.util.ArrayList;
+import java.util.Arrays;
 
+import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertTrue;
 
 /**
@@ -19,15 +22,56 @@
 public class FileSystemFactoryTest {
     @Test
     public void createFat32FileSystem() throws Exception {
+        BlockDeviceDriver blockDevice = createDevice();
+        PartitionTableEntry entry = createPartitionTable();
+        FileSystem fs = FileSystemFactory.INSTANCE.createFileSystem(entry, blockDevice);
+
+        assertTrue(fs instanceof Fat32FileSystem);
+    }
+
+    @Test
+    public void fileSystemPriority() throws Exception  {
+        ArrayList<String> orderTracker = new ArrayList<>();
+
+        // Clear and register with varying priorities to verify creators are invoked in expected order
+        FileSystemFactory.clearFileSystems();
+        FileSystemFactory.registerFileSystem(mockCreator(orderTracker,"not called"), FileSystemFactory.DEFAULT_PRIORITY + 4);
+        FileSystemFactory.registerFileSystem(mockCreator(orderTracker,"third"), FileSystemFactory.DEFAULT_PRIORITY + 1);
+        FileSystemFactory.registerFileSystem(mockCreator(orderTracker,"first"));
+        FileSystemFactory.registerFileSystem(mockCreator(orderTracker,"fourth"), FileSystemFactory.DEFAULT_PRIORITY + 2);
+        FileSystemFactory.registerFileSystem(mockCreator(orderTracker,"second"));
+        FileSystemFactory.registerFileSystem(new Fat32FileSystemCreator(), FileSystemFactory.DEFAULT_PRIORITY + 3);
+        FileSystemFactory.registerFileSystem(mockCreator(orderTracker,"not called"), FileSystemFactory.DEFAULT_PRIORITY + 5);
+
+        BlockDeviceDriver blockDevice = createDevice();
+        PartitionTableEntry entry = createPartitionTable();
+        FileSystem fs = FileSystemFactory.INSTANCE.createFileSystem(entry, blockDevice);
+
+        assertEquals(orderTracker, Arrays.asList("first", "second", "third", "fourth"));
+        assertTrue(fs instanceof Fat32FileSystem);
+
+        // Since this is a singleton try to return it to its original state for other tests
+        FileSystemFactory.clearFileSystems();
+        FileSystemFactory.registerFileSystem(new Fat32FileSystemCreator(), FileSystemFactory.DEFAULT_PRIORITY + 1);
+    }
+
+    private FileSystemCreator mockCreator(ArrayList<String> orderTracker, String name)  {
+        return (entry, blockDevice) -> {
+            orderTracker.add(name);
+            return null;
+        };
+    }
+
+    private BlockDeviceDriver createDevice() throws Exception {
         BlockDeviceDriver blockDevice = new ByteBlockDevice(new FileBlockDeviceDriver(
                 new URL("https://www.dropbox.com/s/3bxngiqmwitlucd/mbr_fat32.img?dl=1"),
                 2 * 512));
         blockDevice.init();
 
-        PartitionTableEntry entry = new PartitionTableEntry(PartitionTypes.FAT32, 2 * 512, 1337);
-        FileSystem fs = FileSystemFactory.INSTANCE.createFileSystem(entry, blockDevice);
-
-        assertTrue(fs instanceof Fat32FileSystem);
+        return blockDevice;
     }
 
+    private PartitionTableEntry createPartitionTable() {
+        return new PartitionTableEntry(PartitionTypes.FAT32, 2 * 512, 1337);
+    }
 }
diff --git a/libusbcommunication/README.md b/libusbcommunication/README.md
diff --git a/libusbcommunication/build.gradle b/libusbcommunication/build.gradle
diff --git a/libusbcommunication/src/c/usb.c b/libusbcommunication/src/c/usb.c
diff --git a/libusbcommunication/src/main/AndroidManifest.xml b/libusbcommunication/src/main/AndroidManifest.xml
diff --git a/storageprovider/build.gradle b/storageprovider/build.gradle
diff --git a/storageprovider/src/main/AndroidManifest.xml b/storageprovider/src/main/AndroidManifest.xml

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,7 @@ android {`
`29`	`29`	`useLibrary 'android.test.runner'`
`30`	`30`	`useLibrary 'android.test.base'`
`31`	`31`	`useLibrary 'android.test.mock'`
	`32`	`+ namespace 'me.jahnen.libaums.core.androidtests'`
`32`	`33`	`}`
`33`	`34`
`34`	`35`	`dependencies {`
Original file line number	Diff line number	Diff line change
`@@ -18,10 +18,11 @@ android {`
`18`	`18`	`proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'`
`19`	`19`	`}`
`20`	`20`	`}`
`21`		`-`
`22`		`- lintOptions {`
	`21`	`+ lint {`
`23`	`22`	`abortOnError false`
`24`	`23`	`}`
	`24`	`+ namespace 'me.jahnen.libaums.core.usbfileman'`
	`25`	`+`
`25`	`26`	`}`
`26`	`27`
`27`	`28`	`dependencies {`
Original file line number	Diff line number	Diff line change
`@@ -30,9 +30,10 @@ android {`
`30`	`30`	`proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'`
`31`	`31`	`}`
`32`	`32`	`}`
`33`		`- lintOptions {`
	`33`	`+ lint {`
`34`	`34`	`abortOnError false`
`35`	`35`	`}`
	`36`	`+ namespace 'me.jahnen.libaums.core.httpserver'`
`36`	`37`	`}`
`37`	`38`
`38`	`39`