diff --git a/.gitignore b/.gitignore index a1fc39c..134fdd8 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ .gradle /build/ +/bin/ # Ignore Gradle GUI config gradle-app.setting @@ -12,3 +13,9 @@ gradle-app.setting # # Work around https://youtrack.jetbrains.com/issue/IDEA-116898 # gradle/wrapper/gradle-wrapper.properties + +# Eclipse +.classpath +.project +.settings/ + diff --git a/README.md b/README.md new file mode 100644 index 0000000..e771ddc --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +# AppleSingle + +This project is an off-shoot of AppleCommander's support for the AppleSingle format in that there are multiple +Java-based tools that can benefit from a pre-built library to support the AppleSingle format. + +# Resources + +* [AppleSingle spec](http://kaiser-edv.de/documents/AppleSingle_AppleDouble.pdf) +* [Original ticket for AppleCommander](https://github.com/AppleCommander/AppleCommander/issues/20) diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..350779b --- /dev/null +++ b/build.gradle @@ -0,0 +1,13 @@ +apply plugin: 'java' +apply plugin: 'application' +apply plugin: 'maven' +apply plugin: 'signing' + +repositories { + jcenter() +} + +dependencies { + testImplementation 'junit:junit:4.12' +} + diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..27768f1 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..92165ee --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-4.3-bin.zip diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..cccdd3d --- /dev/null +++ b/gradlew @@ -0,0 +1,172 @@ +#!/usr/bin/env sh + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS="" + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin, switch paths to Windows format before running java +if $cygwin ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=$((i+1)) + done + case $i in + (0) set -- ;; + (1) set -- "$args0" ;; + (2) set -- "$args0" "$args1" ;; + (3) set -- "$args0" "$args1" "$args2" ;; + (4) set -- "$args0" "$args1" "$args2" "$args3" ;; + (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=$(save "$@") + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong +if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then + cd "$(dirname "$0")" +fi + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..e95643d --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,84 @@ +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS= + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..4d8eea1 --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'applesingle' diff --git a/src/main/java/io/github/applecommander/applesingle/AppleSingle.java b/src/main/java/io/github/applecommander/applesingle/AppleSingle.java new file mode 100644 index 0000000..83d9314 --- /dev/null +++ b/src/main/java/io/github/applecommander/applesingle/AppleSingle.java @@ -0,0 +1,235 @@ +package io.github.applecommander.applesingle; + +import java.io.ByteArrayOutputStream; +import java.io.File; +import java.io.FileOutputStream; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.nio.ByteBuffer; +import java.nio.ByteOrder; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.HashMap; +import java.util.Map; +import java.util.Objects; +import java.util.Optional; +import java.util.function.Consumer; + +/** + * Support reading of data from and AppleSingle source. + * Does not implement all components at this time, extend as required. + * All construction has been deferred to the read(...) or {@link #builder()} methods. + *

+ * Currently supports entries:
+ * 1. Data Fork
+ * 2. Resource Fork
+ * 3. Real Name
+ * 11. ProDOS File Info
+ * + * @see AppleCommander issue #20 + */ +public class AppleSingle { + public static final int MAGIC_NUMBER = 0x0051600; + public static final int VERSION_NUMBER = 0x00020000; + + private Map> entryConsumers = new HashMap<>(); + { + entryConsumers.put(1, this::setDataFork); + entryConsumers.put(2, this::setResourceFork); + entryConsumers.put(3, this::setRealName); + entryConsumers.put(11, this::setProdosFileInfo); + } + + private byte[] dataFork; + private byte[] resourceFork; + private String realName; + private ProdosFileInfo prodosFileInfo = ProdosFileInfo.standardBIN(); + + private AppleSingle() { + // Allow Builder construction + } + private AppleSingle(byte[] data) throws IOException { + ByteBuffer buffer = ByteBuffer.wrap(data) + .order(ByteOrder.BIG_ENDIAN) + .asReadOnlyBuffer(); + required(buffer, MAGIC_NUMBER, "Not an AppleSingle file - magic number does not match."); + required(buffer, VERSION_NUMBER, "Only AppleSingle version 2 supported."); + buffer.position(buffer.position() + 16); // Skip filler + int entries = buffer.getShort(); + for (int i = 0; i < entries; i++) { + int entryId = buffer.getInt(); + int offset = buffer.getInt(); + int length = buffer.getInt(); + buffer.mark(); + buffer.position(offset); + byte[] entryData = new byte[length]; + buffer.get(entryData); + // Defer to the proper set method or crash if we don't support that type of entry + Optional.of(entryConsumers.get(entryId)) + .orElseThrow(() -> new IOException(String.format("Unknown entry type of %04X", entryId))) + .accept(entryData); + buffer.reset(); + } + } + private void required(ByteBuffer buffer, int expected, String message) throws IOException { + int actual = buffer.getInt(); + if (actual != expected) { + throw new IOException(String.format("%s Expected 0x%08x but read 0x%08x.", message, expected, actual)); + } + } + private void setDataFork(byte[] entryData) { + this.dataFork = entryData; + } + private void setResourceFork(byte[] entryData) { + this.resourceFork = entryData; + } + private void setRealName(byte[] entryData) { + for (int i=0; i + * Note 1: {@link #standardBIN()} can be used to generate sensible defaults.
+ * Note 2: Fields are package-private to allow {@link Builder} to have direct access.
+ */ +public class ProdosFileInfo { + int access; + int fileType; + int auxType; + + public static ProdosFileInfo standardBIN() { + return new ProdosFileInfo(0xc3, 0x04, 0x000); + } + + public ProdosFileInfo(int access, int fileType, int auxType) { + this.access = access; + this.fileType = fileType; + this.auxType = auxType; + } + + public int getAccess() { + return access; + } + public int getFileType() { + return fileType; + } + public int getAuxType() { + return auxType; + } +} \ No newline at end of file diff --git a/src/main/java/io/github/applecommander/applesingle/package-info.java b/src/main/java/io/github/applecommander/applesingle/package-info.java new file mode 100644 index 0000000..fde1de2 --- /dev/null +++ b/src/main/java/io/github/applecommander/applesingle/package-info.java @@ -0,0 +1 @@ +package io.github.applecommander.applesingle; \ No newline at end of file