Merge pull request #17 from alekseinovikov/Add-supertypes-for-MediaTypes

Add supertypes for media types

Author: alekseinovikov

build.gradle

@@ -7,7 +7,7 @@ plugins {
 }
 
 group 'org.ktypeparser'
-version '2.0'
+version '2.1'
 
 repositories {
     mavenCentral()

gradle/wrapper/gradle-wrapper.properties

@@ -3,4 +3,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.5-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.5.1-all.zip

src/main/kotlin/org/ktypeparser/processors/FileHelper.kt

@@ -11,19 +11,20 @@ import java.nio.file.Files
 import java.nio.file.Paths
 import java.util.*
 
-internal fun deleteTempFile(file: File) = file.delete()
+internal fun deleteTempFile(file: File?) = file?.delete()
 
 internal suspend fun deleteTempFileAsync(file: File) = GlobalScope.launch { file.delete() }
 
-internal suspend fun createTempFileAsync(bytes: ByteArray): Deferred<File> =
+internal suspend fun createTempFileAsync(bytes: ByteArray): Deferred<File?> =
     GlobalScope.async { createTempFile(bytes) }
 
-internal suspend fun createTempFileAsync(inputStream: InputStream): Deferred<File> =
+internal suspend fun createTempFileAsync(inputStream: InputStream): Deferred<File?> =
     GlobalScope.async { createTempFile(inputStream) }
 
-internal fun createTempFile(bytes: ByteArray): File = createTempFile(ByteArrayInputStream(bytes))
+internal fun createTempFile(bytes: ByteArray): File? =
+    bytes.takeIf { it.isNotEmpty() }?.let { createTempFile(ByteArrayInputStream(it)) }
 
-internal fun createTempFile(inputStream: InputStream): File = inputStream.use {
+internal fun createTempFile(inputStream: InputStream): File? = inputStream.takeIf { it.available() > 0 }?.use {
     val outputTempFilePath = "$tempDirectory/$randomName"
     Files.copy(it, Paths.get(outputTempFilePath))
 

src/main/kotlin/org/ktypeparser/processors/MediaTypeAsyncDetector.kt

@@ -19,13 +19,17 @@ internal object MediaTypeAsyncDetector {
 
     suspend fun detectAsync(bytes: ByteArray): Deferred<MediaType?> {
         val file = createTempFileAsync(bytes)
-        return file.await().toPath().detectAsync()
+        return file.await()?.toPath().detectAsync()
     }
 
     suspend fun detectAsync(inputStream: InputStream): Deferred<MediaType?> =
-        createTempFileAsync(inputStream).await().toPath().detectAsync()
-
-    private suspend fun Path.detectAsync() =
-        GlobalScope.async { mimeTypeDetector.detectMimeTypeAsync(this@detectAsync).await().parseMediaType() }
+        createTempFileAsync(inputStream).await()?.toPath().detectAsync()
+
+    private suspend fun Path?.detectAsync() =
+        GlobalScope.async {
+            this@detectAsync?.let {
+                mimeTypeDetector.detectMimeTypeAsync(it).await().parseMediaType()
+            }
+        }
 
 }

src/main/kotlin/org/ktypeparser/processors/MediaTypeSyncDetector.kt

@@ -24,8 +24,8 @@ internal object MediaTypeSyncDetector {
         }
     }
 
-    fun detect(file: File): MediaType? {
-        return parseMediaType(file)
+    fun detect(file: File?): MediaType? {
+        return file?.let { parseMediaType(it) }
     }
 
     private fun parseMediaType(file: File): MediaType? = mimeTypeDetector.detectMimeType(file)?.parseMediaType()

src/main/kotlin/org/ktypeparser/type/MediaType.kt

@@ -1,5 +1,7 @@
 package org.ktypeparser.type
 
+import org.ktypeparser.type.MediaSuperType.*
+
 private const val APPLICATION_TYPE = "application"
 private const val AUDIO_TYPE = "audio"
 private const val IMAGE_TYPE = "image"
@@ -8,125 +10,134 @@ private const val VIDEO_TYPE = "video"
 
 private const val WILDCARD = "*"
 
-enum class MediaType(val type: String, val subType: String) {
-    EMPTY("application","x-empty"),
+enum class MediaSuperType {
+    OTHER,
+    TEXT,
+    IMAGE,
+    AUDIO,
+    VIDEO,
+    APPLICATION
+}
+
+enum class MediaType(val type: String, val subType: String, val superType: MediaSuperType) {
+    EMPTY("application", "x-empty", OTHER),
 
-    ANY_TYPE(WILDCARD, WILDCARD),
-    ANY_TEXT_TYPE(TEXT_TYPE, WILDCARD),
-    ANY_IMAGE_TYPE(IMAGE_TYPE, WILDCARD),
-    ANY_AUDIO_TYPE(AUDIO_TYPE, WILDCARD),
-    ANY_VIDEO_TYPE(VIDEO_TYPE, WILDCARD),
-    ANY_APPLICATION_TYPE(APPLICATION_TYPE, WILDCARD),
+    ANY_TYPE(WILDCARD, WILDCARD, OTHER),
+    ANY_TEXT_TYPE(TEXT_TYPE, WILDCARD, TEXT),
+    ANY_IMAGE_TYPE(IMAGE_TYPE, WILDCARD, IMAGE),
+    ANY_AUDIO_TYPE(AUDIO_TYPE, WILDCARD, AUDIO),
+    ANY_VIDEO_TYPE(VIDEO_TYPE, WILDCARD, VIDEO),
+    ANY_APPLICATION_TYPE(APPLICATION_TYPE, WILDCARD, APPLICATION),
 
     /* TEXT TYPES */
-    CSS(TEXT_TYPE, "css"),
-    CSV(TEXT_TYPE, "csv"),
-    HTML(TEXT_TYPE, "html"),
-    I_CALENDAR(TEXT_TYPE, "calendar"),
-    PLAIN_TEXT(TEXT_TYPE, "plain"),
-    TEXT_JAVASCRIPT(TEXT_TYPE, "javascript"),
-    TSV(TEXT_TYPE, "tab-separated-values"),
-    VCARD(TEXT_TYPE, "vcard"),
-    WML(TEXT_TYPE, "vnd.wap.wml"),
-    XML(TEXT_TYPE, "xml"),
-    VTT(TEXT_TYPE, "vtt"),
+    CSS(TEXT_TYPE, "css", TEXT),
+    CSV(TEXT_TYPE, "csv", TEXT),
+    HTML(TEXT_TYPE, "html", TEXT),
+    I_CALENDAR(TEXT_TYPE, "calendar", TEXT),
+    PLAIN_TEXT(TEXT_TYPE, "plain", TEXT),
+    TEXT_JAVASCRIPT(TEXT_TYPE, "javascript", TEXT),
+    TSV(TEXT_TYPE, "tab-separated-values", TEXT),
+    VCARD(TEXT_TYPE, "vcard", TEXT),
+    WML(TEXT_TYPE, "vnd.wap.wml", TEXT),
+    XML(TEXT_TYPE, "xml", TEXT),
+    VTT(TEXT_TYPE, "vtt", TEXT),
 
     /* IMAGE TYPES */
-    BMP(IMAGE_TYPE, "bmp"),
-    CRW(IMAGE_TYPE, "x-canon-crw"),
-    GIF(IMAGE_TYPE, "gif"),
-    ICO(IMAGE_TYPE, "vnd.microsoft.icon"),
-    JPEG(IMAGE_TYPE, "jpeg"),
-    PNG(IMAGE_TYPE, "png"),
-    PSD(IMAGE_TYPE, "vnd.adobe.photoshop"),
-    SVG(IMAGE_TYPE, "svg+xml"),
-    TIFF(IMAGE_TYPE, "tiff"),
-    WEBP(IMAGE_TYPE, "webp"),
-    HEIF(IMAGE_TYPE, "heif"),
-    JP2K(IMAGE_TYPE, "jp2"),
+    BMP(IMAGE_TYPE, "bmp", IMAGE),
+    CRW(IMAGE_TYPE, "x-canon-crw", IMAGE),
+    GIF(IMAGE_TYPE, "gif", IMAGE),
+    ICO(IMAGE_TYPE, "vnd.microsoft.icon", IMAGE),
+    JPEG(IMAGE_TYPE, "jpeg", IMAGE),
+    PNG(IMAGE_TYPE, "png", IMAGE),
+    PSD(IMAGE_TYPE, "vnd.adobe.photoshop", IMAGE),
+    SVG(IMAGE_TYPE, "svg+xml", IMAGE),
+    TIFF(IMAGE_TYPE, "tiff", IMAGE),
+    WEBP(IMAGE_TYPE, "webp", IMAGE),
+    HEIF(IMAGE_TYPE, "heif", IMAGE),
+    JP2K(IMAGE_TYPE, "jp2", IMAGE),
 
     /* AUDIO TYPES */
-    MP4_AUDIO(AUDIO_TYPE, "mp4"),
-    MPEG_AUDIO(AUDIO_TYPE, "mpeg"),
-    OGG_AUDIO(AUDIO_TYPE, "ogg"),
-    WEBM_AUDIO(AUDIO_TYPE, "webm"),
-    L16_AUDIO(AUDIO_TYPE, "l16"),
-    L24_AUDIO(AUDIO_TYPE, "l24"),
-    BASIC_AUDIO(AUDIO_TYPE, "basic"),
-    AAC_AUDIO(AUDIO_TYPE, "aac"),
-    VORBIS_AUDIO(AUDIO_TYPE, "vorbis"),
-    WMA_AUDIO(AUDIO_TYPE, "x-ms-wma"),
-    WAX_AUDIO(AUDIO_TYPE, "x-ms-wax"),
-    VND_REAL_AUDIO(AUDIO_TYPE, "vnd.rn-realaudio"),
-    VND_WAVE_AUDIO(AUDIO_TYPE, "vnd.wave"),
+    MP4_AUDIO(AUDIO_TYPE, "mp4", AUDIO),
+    MPEG_AUDIO(AUDIO_TYPE, "mpeg", AUDIO),
+    OGG_AUDIO(AUDIO_TYPE, "ogg", AUDIO),
+    WEBM_AUDIO(AUDIO_TYPE, "webm", AUDIO),
+    L16_AUDIO(AUDIO_TYPE, "l16", AUDIO),
+    L24_AUDIO(AUDIO_TYPE, "l24", AUDIO),
+    BASIC_AUDIO(AUDIO_TYPE, "basic", AUDIO),
+    AAC_AUDIO(AUDIO_TYPE, "aac", AUDIO),
+    VORBIS_AUDIO(AUDIO_TYPE, "vorbis", AUDIO),
+    WMA_AUDIO(AUDIO_TYPE, "x-ms-wma", AUDIO),
+    WAX_AUDIO(AUDIO_TYPE, "x-ms-wax", AUDIO),
+    VND_REAL_AUDIO(AUDIO_TYPE, "vnd.rn-realaudio", AUDIO),
+    VND_WAVE_AUDIO(AUDIO_TYPE, "vnd.wave", AUDIO),
 
     /* VIDEO TYPES */
-    MP4_VIDEO(VIDEO_TYPE, "mp4"),
-    MPEG_VIDEO(VIDEO_TYPE, "mpeg"),
-    OGG_VIDEO(VIDEO_TYPE, "ogg"),
-    QUICKTIME(VIDEO_TYPE, "quicktime"),
-    WEBM_VIDEO(VIDEO_TYPE, "webm"),
-    WMV(VIDEO_TYPE, "x-ms-wmv"),
-    FLV_VIDEO(VIDEO_TYPE, "x-flv"),
-    THREE_GPP_VIDEO(VIDEO_TYPE, "3gpp"),
-    THREE_GPP2_VIDEO(VIDEO_TYPE, "3gpp2"),
+    MP4_VIDEO(VIDEO_TYPE, "mp4", VIDEO),
+    MPEG_VIDEO(VIDEO_TYPE, "mpeg", VIDEO),
+    OGG_VIDEO(VIDEO_TYPE, "ogg", VIDEO),
+    QUICKTIME(VIDEO_TYPE, "quicktime", VIDEO),
+    WEBM_VIDEO(VIDEO_TYPE, "webm", VIDEO),
+    WMV(VIDEO_TYPE, "x-ms-wmv", VIDEO),
+    FLV_VIDEO(VIDEO_TYPE, "x-flv", VIDEO),
+    THREE_GPP_VIDEO(VIDEO_TYPE, "3gpp", VIDEO),
+    THREE_GPP2_VIDEO(VIDEO_TYPE, "3gpp2", VIDEO),
 
     /* APPLICATION TYPES */
-    APPLICATION_XML(APPLICATION_TYPE, "xml"),
-    ATOM(APPLICATION_TYPE, "atom+xml"),
-    BZIP2(APPLICATION_TYPE, "x-bzip2"),
-    DART(APPLICATION_TYPE, "dart"),
-    APPLE_PASSBOOK(APPLICATION_TYPE, "vnd.apple.pkpass"),
-    EOT(APPLICATION_TYPE, "vnd.ms-fontobject"),
-    EPUB(APPLICATION_TYPE, "epub+zip"),
-    FORM_DATA(APPLICATION_TYPE, "x-www-form-urlencoded"),
-    KEY_ARCHIVE(APPLICATION_TYPE, "pkcs12"),
-    APPLICATION_BINARY(APPLICATION_TYPE, "binary"),
-    GEO_JSON(APPLICATION_TYPE, "geo+json"),
-    GZIP(APPLICATION_TYPE, "x-gzip"),
-    HAL_JSON(APPLICATION_TYPE, "hal+json"),
-    JAVASCRIPT(APPLICATION_TYPE, "javascript"),
-    JOSE(APPLICATION_TYPE, "jose"),
-    JOSE_JSON(APPLICATION_TYPE, "jose+json"),
-    JSON(APPLICATION_TYPE, "json"),
-    MANIFEST_JSON(APPLICATION_TYPE, "manifest+json"),
-    KML(APPLICATION_TYPE, "vnd.google-earth.kml+xml"),
-    KMZ(APPLICATION_TYPE, "vnd.google-earth.kmz"),
-    MBOX(APPLICATION_TYPE, "mbox"),
-    APPLE_MOBILE_CONFIG(APPLICATION_TYPE, "x-apple-aspen-config"),
-    MICROSOFT_EXCEL(APPLICATION_TYPE, "vnd.ms-excel"),
-    MICROSOFT_OUTLOOK(APPLICATION_TYPE, "vnd.ms-outlook"),
-    MICROSOFT_POWERPOINT(APPLICATION_TYPE, "vnd.ms-powerpoint"),
-    MICROSOFT_WORD(APPLICATION_TYPE, "msword"),
-    MEDIA_PRESENTATION_DESCRIPTION(APPLICATION_TYPE, "dash+xml"),
-    WASM_APPLICATION(APPLICATION_TYPE, "wasm"),
-    NACL_APPLICATION(APPLICATION_TYPE, "x-nacl"),
-    NACL_PORTABLE_APPLICATION(APPLICATION_TYPE, "x-pnacl"),
-    OCTET_STREAM(APPLICATION_TYPE, "octet-stream"),
-    OGG_CONTAINER(APPLICATION_TYPE, "ogg"),
-    OOXML_DOCUMENT(APPLICATION_TYPE, "vnd.openxmlformats-officedocument.wordprocessingml.document"),
-    OOXML_PRESENTATION(APPLICATION_TYPE, "vnd.openxmlformats-officedocument.presentationml.presentation"),
-    OOXML_SHEET(APPLICATION_TYPE, "vnd.openxmlformats-officedocument.spreadsheetml.sheet"),
-    OPENDOCUMENT_GRAPHICS(APPLICATION_TYPE, "vnd.oasis.opendocument.graphics"),
-    OPENDOCUMENT_PRESENTATION(APPLICATION_TYPE, "vnd.oasis.opendocument.presentation"),
-    OPENDOCUMENT_SPREADSHEET(APPLICATION_TYPE, "vnd.oasis.opendocument.spreadsheet"),
-    OPENDOCUMENT_TEXT(APPLICATION_TYPE, "vnd.oasis.opendocument.text"),
-    OPENSEARCH_DESCRIPTION(APPLICATION_TYPE, "opensearchdescription+xml"),
-    PDF(APPLICATION_TYPE, "pdf"),
-    POSTSCRIPT(APPLICATION_TYPE, "postscript"),
-    PROTOBUF(APPLICATION_TYPE, "protobuf"),
-    RDF_XML(APPLICATION_TYPE, "rdf+xml"),
-    RTF(APPLICATION_TYPE, "rtf"),
-    SFNT(APPLICATION_TYPE, "font-sfnt"),
-    SHOCKWAVE_FLASH(APPLICATION_TYPE, "x-shockwave-flash"),
-    SKETCHUP(APPLICATION_TYPE, "vnd.sketchup.skp"),
-    SOAP_XML(APPLICATION_TYPE, "soap+xml"),
-    TAR(APPLICATION_TYPE, "x-tar"),
-    WOFF(APPLICATION_TYPE, "font-woff"),
-    WOFF2(APPLICATION_TYPE, "font-woff2"),
-    XHTML(APPLICATION_TYPE, "xhtml+xml"),
-    XRD(APPLICATION_TYPE, "xrd+xml"),
-    ZIP(APPLICATION_TYPE, "zip")
+    APPLICATION_XML(APPLICATION_TYPE, "xml", APPLICATION),
+    ATOM(APPLICATION_TYPE, "atom+xml", APPLICATION),
+    BZIP2(APPLICATION_TYPE, "x-bzip2", APPLICATION),
+    DART(APPLICATION_TYPE, "dart", APPLICATION),
+    APPLE_PASSBOOK(APPLICATION_TYPE, "vnd.apple.pkpass", APPLICATION),
+    EOT(APPLICATION_TYPE, "vnd.ms-fontobject", APPLICATION),
+    EPUB(APPLICATION_TYPE, "epub+zip", APPLICATION),
+    FORM_DATA(APPLICATION_TYPE, "x-www-form-urlencoded", APPLICATION),
+    KEY_ARCHIVE(APPLICATION_TYPE, "pkcs12", APPLICATION),
+    APPLICATION_BINARY(APPLICATION_TYPE, "binary", APPLICATION),
+    GEO_JSON(APPLICATION_TYPE, "geo+json", APPLICATION),
+    GZIP(APPLICATION_TYPE, "x-gzip", APPLICATION),
+    HAL_JSON(APPLICATION_TYPE, "hal+json", APPLICATION),
+    JAVASCRIPT(APPLICATION_TYPE, "javascript", APPLICATION),
+    JOSE(APPLICATION_TYPE, "jose", APPLICATION),
+    JOSE_JSON(APPLICATION_TYPE, "jose+json", APPLICATION),
+    JSON(APPLICATION_TYPE, "json", APPLICATION),
+    MANIFEST_JSON(APPLICATION_TYPE, "manifest+json", APPLICATION),
+    KML(APPLICATION_TYPE, "vnd.google-earth.kml+xml", APPLICATION),
+    KMZ(APPLICATION_TYPE, "vnd.google-earth.kmz", APPLICATION),
+    MBOX(APPLICATION_TYPE, "mbox", APPLICATION),
+    APPLE_MOBILE_CONFIG(APPLICATION_TYPE, "x-apple-aspen-config", APPLICATION),
+    MICROSOFT_EXCEL(APPLICATION_TYPE, "vnd.ms-excel", APPLICATION),
+    MICROSOFT_OUTLOOK(APPLICATION_TYPE, "vnd.ms-outlook", APPLICATION),
+    MICROSOFT_POWERPOINT(APPLICATION_TYPE, "vnd.ms-powerpoint", APPLICATION),
+    MICROSOFT_WORD(APPLICATION_TYPE, "msword", APPLICATION),
+    MEDIA_PRESENTATION_DESCRIPTION(APPLICATION_TYPE, "dash+xml", APPLICATION),
+    WASM_APPLICATION(APPLICATION_TYPE, "wasm", APPLICATION),
+    NACL_APPLICATION(APPLICATION_TYPE, "x-nacl", APPLICATION),
+    NACL_PORTABLE_APPLICATION(APPLICATION_TYPE, "x-pnacl", APPLICATION),
+    OCTET_STREAM(APPLICATION_TYPE, "octet-stream", APPLICATION),
+    OGG_CONTAINER(APPLICATION_TYPE, "ogg", APPLICATION),
+    OOXML_DOCUMENT(APPLICATION_TYPE, "vnd.openxmlformats-officedocument.wordprocessingml.document", APPLICATION),
+    OOXML_PRESENTATION(APPLICATION_TYPE, "vnd.openxmlformats-officedocument.presentationml.presentation", APPLICATION),
+    OOXML_SHEET(APPLICATION_TYPE, "vnd.openxmlformats-officedocument.spreadsheetml.sheet", APPLICATION),
+    OPENDOCUMENT_GRAPHICS(APPLICATION_TYPE, "vnd.oasis.opendocument.graphics", APPLICATION),
+    OPENDOCUMENT_PRESENTATION(APPLICATION_TYPE, "vnd.oasis.opendocument.presentation", APPLICATION),
+    OPENDOCUMENT_SPREADSHEET(APPLICATION_TYPE, "vnd.oasis.opendocument.spreadsheet", APPLICATION),
+    OPENDOCUMENT_TEXT(APPLICATION_TYPE, "vnd.oasis.opendocument.text", APPLICATION),
+    OPENSEARCH_DESCRIPTION(APPLICATION_TYPE, "opensearchdescription+xml", APPLICATION),
+    PDF(APPLICATION_TYPE, "pdf", APPLICATION),
+    POSTSCRIPT(APPLICATION_TYPE, "postscript", APPLICATION),
+    PROTOBUF(APPLICATION_TYPE, "protobuf", APPLICATION),
+    RDF_XML(APPLICATION_TYPE, "rdf+xml", APPLICATION),
+    RTF(APPLICATION_TYPE, "rtf", APPLICATION),
+    SFNT(APPLICATION_TYPE, "font-sfnt", APPLICATION),
+    SHOCKWAVE_FLASH(APPLICATION_TYPE, "x-shockwave-flash", APPLICATION),
+    SKETCHUP(APPLICATION_TYPE, "vnd.sketchup.skp", APPLICATION),
+    SOAP_XML(APPLICATION_TYPE, "soap+xml", APPLICATION),
+    TAR(APPLICATION_TYPE, "x-tar", APPLICATION),
+    WOFF(APPLICATION_TYPE, "font-woff", APPLICATION),
+    WOFF2(APPLICATION_TYPE, "font-woff2", APPLICATION),
+    XHTML(APPLICATION_TYPE, "xhtml+xml", APPLICATION),
+    XRD(APPLICATION_TYPE, "xrd+xml", APPLICATION),
+    ZIP(APPLICATION_TYPE, "zip", APPLICATION)
 }
 
 private val nameToMediaTypeMap: Map<String, MediaType> by lazy {