Improve the java implementation of the Decompression extension.

ultraviolet-jordan · ultraviolet-jordan · commit 54f4c10fbfd4 · 2021-09-27T14:03:29.000-04:00
diff --git a/cache/src/main/kotlin/com/runetopic/cache/codec/CodecType.kt b/cache/src/main/kotlin/com/runetopic/cache/codec/CodecType.kt
@@ -0,0 +1,20 @@
+package com.runetopic.cache.codec
+
+import com.runetopic.cache.codec.impl.BZip2Codec
+import com.runetopic.cache.codec.impl.GZipCodec
+import com.runetopic.cache.codec.impl.NoFileCodec
+
+/**
+ * @author Tyler Telis
+ * @email <xlitersps@gmail.com>
+ *
+ * @author Jordan Abraham
+ */
+internal sealed class CodecType(
+    val codec: IFileCodec
+) {
+    object BadCodec: CodecType(NoFileCodec())
+    object NoCodec: CodecType(NoFileCodec())
+    object BZipCodec: CodecType(BZip2Codec())
+    object GZipCodec: CodecType(GZipCodec())
+}
diff --git a/cache/src/main/kotlin/com/runetopic/cache/codec/Container.kt b/cache/src/main/kotlin/com/runetopic/cache/codec/Container.kt
@@ -1,4 +1,4 @@
-package com.runetopic.cache.compression
+package com.runetopic.cache.codec
 
 /**
  * @author Tyler Telis
diff --git a/cache/src/main/kotlin/com/runetopic/cache/codec/ContainerCodec.kt b/cache/src/main/kotlin/com/runetopic/cache/codec/ContainerCodec.kt
@@ -1,6 +1,6 @@
-package com.runetopic.cache.compression
+package com.runetopic.cache.codec
 
-import com.runetopic.cache.compression.CompressionType.*
+import com.runetopic.cache.codec.CodecType.*
 import com.runetopic.cache.exception.CompressionException
 import com.runetopic.cache.extension.readUnsignedShort
 import com.runetopic.cache.extension.remainingBytes
@@ -14,7 +14,7 @@ import java.util.zip.CRC32
  *
  * @author Jordan Abraham
  */
-internal object Compression {
+internal object ContainerCodec {
 
     fun decompress(data: ByteArray, keys: IntArray = intArrayOf()): Container {
         val buffer = ByteBuffer.wrap(data)
@@ -30,8 +30,8 @@ internal object Compression {
         crc32.update(data, 0, 5)
 
         return when (val type = compressionType(compression)) {
-            BadCompression -> throw CompressionException("Compression type not found with a compression opcode of $compression.")
-            is NoCompression -> {
+            BadCodec -> throw CompressionException("Compression type not found with a compression opcode of $compression.")
+            is NoCodec -> {
                 val encrypted = ByteArray(length)
                 buffer.get(encrypted, 0, length)
                 crc32.update(encrypted, 0, length)
@@ -41,7 +41,7 @@ internal object Compression {
 
                 Container(decrypted, compression, revision, crc32.value.toInt())
             }
-            GZipCompression, BZipCompression-> {
+            GZipCodec, BZipCodec-> {
                 val encrypted = ByteArray(length + 4)
                 buffer.get(encrypted)
                 crc32.update(encrypted, 0, encrypted.size)
@@ -66,12 +66,12 @@ internal object Compression {
         }
     }
 
-    private fun compressionType(compression: Int): CompressionType {
+    private fun compressionType(compression: Int): CodecType {
         return when (compression) {
-            0 -> NoCompression
-            1 -> BZipCompression
-            2 -> GZipCompression
-            else -> BadCompression
+            0 -> NoCodec
+            1 -> BZipCodec
+            2 -> GZipCodec
+            else -> BadCodec
         }
     }
 }
diff --git a/cache/src/main/kotlin/com/runetopic/cache/codec/Decompression.kt b/cache/src/main/kotlin/com/runetopic/cache/codec/Decompression.kt
@@ -0,0 +1,13 @@
+@file:JvmName("Decompression")
+package com.runetopic.cache.codec
+
+/**
+ * @author Jordan Abraham
+ */
+fun ByteArray.decompress(keys: IntArray = intArrayOf()): ByteArray {
+    return ContainerCodec.decompress(this, keys).data
+}
+
+fun ByteArray.decompress(): ByteArray {
+    return ContainerCodec.decompress(this, intArrayOf()).data
+}
diff --git a/cache/src/main/kotlin/com/runetopic/cache/codec/IFileCodec.kt b/cache/src/main/kotlin/com/runetopic/cache/codec/IFileCodec.kt
@@ -1,4 +1,4 @@
-package com.runetopic.cache.compression
+package com.runetopic.cache.codec
 
 /**
  * @author Tyler Telis
diff --git a/cache/src/main/kotlin/com/runetopic/cache/codec/impl/BZip2Codec.kt b/cache/src/main/kotlin/com/runetopic/cache/codec/impl/BZip2Codec.kt
@@ -1,6 +1,6 @@
-package com.runetopic.cache.compression.impl
+package com.runetopic.cache.codec.impl
 
-import com.runetopic.cache.compression.IFileCodec
+import com.runetopic.cache.codec.IFileCodec
 import com.runetopic.cache.store.Constants.BZIP_HEADER
 import org.apache.commons.compress.compressors.bzip2.BZip2CompressorInputStream
 import org.apache.commons.compress.compressors.bzip2.BZip2CompressorOutputStream
diff --git a/cache/src/main/kotlin/com/runetopic/cache/codec/impl/GZipCodec.kt b/cache/src/main/kotlin/com/runetopic/cache/codec/impl/GZipCodec.kt
@@ -1,6 +1,6 @@
-package com.runetopic.cache.compression.impl
+package com.runetopic.cache.codec.impl
 
-import com.runetopic.cache.compression.IFileCodec
+import com.runetopic.cache.codec.IFileCodec
 import org.apache.commons.compress.utils.IOUtils
 import java.io.ByteArrayInputStream
 import java.io.ByteArrayOutputStream
diff --git a/cache/src/main/kotlin/com/runetopic/cache/codec/impl/NoFileCodec.kt b/cache/src/main/kotlin/com/runetopic/cache/codec/impl/NoFileCodec.kt
@@ -1,6 +1,6 @@
-package com.runetopic.cache.compression.impl
+package com.runetopic.cache.codec.impl
 
-import com.runetopic.cache.compression.IFileCodec
+import com.runetopic.cache.codec.IFileCodec
 
 /**
  * @author Tyler Telis
diff --git a/cache/src/main/kotlin/com/runetopic/cache/compression/CompressionType.kt b/cache/src/main/kotlin/com/runetopic/cache/compression/CompressionType.kt
diff --git a/cache/src/main/kotlin/com/runetopic/cache/extension/ByteArray.kt b/cache/src/main/kotlin/com/runetopic/cache/extension/ByteArray.kt
diff --git a/cache/src/main/kotlin/com/runetopic/cache/hierarchy/ReferenceTable.kt b/cache/src/main/kotlin/com/runetopic/cache/hierarchy/ReferenceTable.kt
@@ -1,6 +1,7 @@
 package com.runetopic.cache.hierarchy
 
-import com.runetopic.cache.compression.Compression
+import com.runetopic.cache.codec.ContainerCodec
+import com.runetopic.cache.codec.decompress
 import com.runetopic.cache.exception.ProtocolException
 import com.runetopic.cache.extension.readUnsignedByte
 import com.runetopic.cache.extension.readUnsignedShort
@@ -59,7 +60,7 @@ internal data class ReferenceTable(
     fun exists(): Boolean = (length != 0 && sector != 0)
 
     fun loadIndex(datFile: IDatFile, idxFile: IIdxFile, whirlpool: ByteArray, data: ByteArray): Js5Index {
-        val container = Compression.decompress(data)
+        val container = ContainerCodec.decompress(data)
         val buffer = ByteBuffer.wrap(container.data)
         val protocol = buffer.readUnsignedByte()
         var revision = 0
@@ -238,7 +239,7 @@ internal data class ReferenceTable(
         if (groupReferenceTableData.isEmpty()) return hashMapOf(Pair(0, Js5File.DEFAULT))
 
         val src: ByteArray = try {
-            Compression.decompress(groupReferenceTableData).data
+            groupReferenceTableData.decompress()
         } catch (exception: ZipException) {
             groupReferenceTableData
         }
diff --git a/cache/src/main/kotlin/com/runetopic/cache/store/storage/js5/Js5DiskStorage.kt b/cache/src/main/kotlin/com/runetopic/cache/store/storage/js5/Js5DiskStorage.kt
@@ -7,9 +7,9 @@ import com.runetopic.cache.hierarchy.index.Index
 import com.runetopic.cache.hierarchy.index.Js5Index
 import com.runetopic.cache.store.Constants
 import com.runetopic.cache.store.Js5Store
+import com.runetopic.cache.store.storage.IStorage
 import com.runetopic.cache.store.storage.js5.impl.DatFile
 import com.runetopic.cache.store.storage.js5.impl.IdxFile
-import com.runetopic.cache.store.storage.IStorage
 import java.io.File
 import java.io.FileNotFoundException
 import java.nio.ByteBuffer
diff --git a/loader/src/main/kotlin/com/runetopic/loader/index/map/MapEntryBuilder.kt b/loader/src/main/kotlin/com/runetopic/loader/index/map/MapEntryBuilder.kt
@@ -1,6 +1,6 @@
 package com.runetopic.loader.index.map
 
-import com.runetopic.cache.extension.decompress
+import com.runetopic.cache.codec.decompress
 import com.runetopic.cache.extension.readUnsignedByte
 import com.runetopic.cache.extension.readUnsignedShort
 import com.runetopic.cache.extension.skip
diff --git a/loader/src/main/kotlin/com/runetopic/loader/index/map/MapLocationEntryBuilder.kt b/loader/src/main/kotlin/com/runetopic/loader/index/map/MapLocationEntryBuilder.kt
@@ -1,6 +1,6 @@
 package com.runetopic.loader.index.map
 
-import com.runetopic.cache.extension.decompress
+import com.runetopic.cache.codec.decompress
 import com.runetopic.cache.extension.readUnsignedByte
 import com.runetopic.cache.extension.readUnsignedIntSmartShortCompat
 import com.runetopic.cache.extension.readUnsignedSmart

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package com.runetopic.cache.compression`
	`1`	`+package com.runetopic.cache.codec`
`2`	`2`
`3`	`3`	`/**`
`4`	`4`	`* @author Tyler Telis`