Merge pull request #42 from gmuth/develop

Prepare 3.4 release

Author: gmuth

.github/workflows/build.yml

@@ -19,24 +19,31 @@ jobs:
     steps:
       # https://github.com/marketplace/actions/checkout
       - name: Checkout sources
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           # Disabling shallow clone is recommended for improving relevancy of reporting
           fetch-depth: 0
 
       # https://github.com/marketplace/actions/setup-java-jdk
       - name: Setup JDK 17
-        uses: actions/setup-java@v4
+        uses: actions/setup-java@v5
         with:
           distribution: 'temurin'
           java-version: '17'
-          cache: 'gradle'
+          #cache: 'gradle'
+
+      #- name: Show Gradle Version
+      #  run: gradle --version
+      # 9.x
 
       # https://github.com/marketplace/actions/build-with-gradle
-      #- name: Setup Gradle
-      #  uses: gradle/actions/setup-gradle@v4
-      - name: Gradle wrapper build and analyse
-        run: ./gradlew --no-daemon sonar
+      - name: Setup Gradle 7
+        uses: gradle/actions/setup-gradle@v4
+        with:
+          gradle-version: '7.6.6'
+          cache-read-only: 'false'
+      - name: Gradle build and analyse
+        run: gradle sonar
 
 #      - name: Publish GitHub Packages
 #        env:

README.md

@@ -13,7 +13,7 @@ RFCs
 [![Build](https://github.com/gmuth/ipp-client-kotlin/workflows/build/badge.svg)](https://github.com/gmuth/ipp-client-kotlin/actions?query=workflow%3Abuild)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=gmuth_ipp-client-kotlin&metric=alert_status)](https://sonarcloud.io/summary/overall?id=gmuth_ipp-client-kotlin)
 [![Sonar Coverage](https://img.shields.io/sonar/coverage/gmuth_ipp-client-kotlin?color=00AA00&server=https%3A%2F%2Fsonarcloud.io)](https://sonarcloud.io/component_measures?metric=Coverage&view=list&id=gmuth_ipp-client-kotlin)
-[![Maven Central](https://img.shields.io/maven-central/v/de.gmuth/ipp-client.svg?label=maven%20central)](https://central.sonatype.com/artifact/de.gmuth/ipp-client/3.2/overview)
+[![Maven Central](https://img.shields.io/maven-central/v/de.gmuth/ipp-client.svg?label=maven%20central)](https://central.sonatype.com/artifact/de.gmuth/ipp-client/3.4/overview)
 
 ## Usage
 
@@ -23,7 +23,7 @@ supports printer lookup by queue name.
 Repository [ipp-samples](https://github.com/gmuth/ipp-samples) contains examples how to use jmDNS.
 
 ```
-implementation("de.gmuth:ipp-client:3.3")
+implementation("de.gmuth:ipp-client:3.4")
 ```
 
 [README.md for version 2.x](https://github.com/gmuth/ipp-client-kotlin/blob/2.5/README.md) is still available.
@@ -219,7 +219,7 @@ Only when the library detects IPP issues through response codes, it consults the
 
 This library implements a different concept then jipp.
 jipp seems very strict about IPP syntax and is not designed to cope with illegal IPP responses.
-My IPP library in contrast is designed for resilience. E.g. it accepts messages and attributes that use wrong IPP tags.
+Library ipp-client in contrast is designed for resilience. E.g. it accepts messages and attributes that use wrong IPP tags.
 I've not yet seen any IPP server implementation without a single encoding bug.
 [IppInputStream](https://github.com/gmuth/ipp-client-kotlin/blob/master/src/main/kotlin/de/gmuth/ipp/core/IppInputStream.kt)
 for example includes workarounds for

build.gradle.kts

@@ -4,7 +4,7 @@ import org.jetbrains.dokka.gradle.DokkaTask
 // where is the jar? build/lib/ipp-client-kotlin...jar
 
 // update gradle wrapper
-// ./gradlew wrapper --gradle-version 7.6.4
+// ./gradlew wrapper --gradle-version 7.6.6
 // gradle 8? should be done when moved to kotlin.jvm plugin 1.9.x (to remove deprecation warnings)
 
 plugins {
@@ -16,10 +16,11 @@ plugins {
     id("java-library")                              // https://docs.gradle.org/7.6.2/userguide/java_library_plugin.html
     id("signing")                                   // https://docs.gradle.org/7.6.2/userguide/signing_plugin.html
     id("jacoco")                                    // https://docs.gradle.org/7.6.2/userguide/jacoco_plugin.html
+    //kotlin("jvm")
 }
 
 group = "de.gmuth"
-version = "3.4-SNAPSHOT"
+version = "3.4"
 
 repositories {
     mavenCentral()
@@ -28,6 +29,7 @@ repositories {
 dependencies {
     testImplementation("org.jetbrains.kotlin:kotlin-test")
     //testImplementation("org.jetbrains.kotlin:kotlin-test-junit")
+    //implementation(kotlin("stdlib-jdk8"))
 }
 
 // gradlew clean -x test build publishToMavenLocal
@@ -38,19 +40,19 @@ val javaVersion = "1.8" // JvmTarget.JVM_1_6, default depends on kotlin release
 val kotlinVersion = "1.7"
 tasks.apply {
 
-    // Kotlin
-    compileKotlin {
-        kotlinOptions {
-            jvmTarget = javaVersion
-            languageVersion = kotlinVersion
-        }
-    }
-    compileTestKotlin {
-        kotlinOptions {
-            jvmTarget = javaVersion
-            languageVersion = kotlinVersion
-        }
-    }
+//    // Kotlin
+//    compileKotlin {
+//        kotlinOptions {
+//            jvmTarget = javaVersion
+//            languageVersion = kotlinVersion
+//        }
+//    }
+//    compileTestKotlin {
+//        kotlinOptions {
+//            jvmTarget = javaVersion
+//            languageVersion = kotlinVersion
+//        }
+//    }
 
 // Java
 //    compileJava {
@@ -61,6 +63,15 @@ tasks.apply {
 //        sourceCompatibility = javaVersion
 //        targetCompatibility = javaVersion
 //    }
+    jar {
+        manifest {
+            attributes(
+                "Maven-Artifact-Name" to project.name,
+                "Maven-Artifact-Group" to project.group,
+                "Maven-Artifact-Version" to project.version
+            )
+        }
+    }
 }
 
 // ================= PUBLISHING ================
@@ -223,4 +234,8 @@ tasks.sonar {
 //    duplicatesStrategy = DuplicatesStrategy.EXCLUDE
 //    from(configurations.runtimeClasspath.get().map(::zipTree))
 //    with(tasks.jar.get())
+//}
+
+//kotlin {
+//    jvmToolchain(17)
 //}

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.4-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.6-bin.zip
 networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

src/main/kotlin/de/gmuth/ipp/Manifest.kt

@@ -0,0 +1,18 @@
+package de.gmuth.ipp
+
+import de.gmuth.ipp.client.IppClient
+import java.util.jar.Manifest
+
+/**
+ * Copyright (c) 2025 Gerhard Muth
+ */
+
+class Manifest {
+    companion object {
+        private val instance = Manifest(IppClient::class.java.getResourceAsStream("/META-INF/MANIFEST.MF"))
+        val mainAttributes = instance.mainAttributes
+        val mavenArtifactName = mainAttributes.getValue("Maven-Artifact-Name")
+        val mavenArtifactGroup = mainAttributes.getValue("Maven-Artifact-Group")
+        val mavenArtifactVersion = mainAttributes.getValue("Maven-Artifact-Version")
+    }
+}

src/main/kotlin/de/gmuth/ipp/client/CupsClient.kt

@@ -15,6 +15,7 @@ import de.gmuth.ipp.core.IppTag.*
 import java.io.File
 import java.io.InputStream
 import java.net.URI
+import java.nio.file.Path
 import java.time.Duration
 import java.util.concurrent.atomic.AtomicInteger
 import java.util.logging.Logger.getLogger
@@ -24,14 +25,15 @@ class CupsClient(
     val cupsUri: URI = URI.create("ipps://localhost"),
     val ippClient: IppClient = IppClient()
 ) {
-    constructor(cupsUri: URI) : this(cupsUri, IppClient())
+    @JvmOverloads
+    constructor(cupsUri: URI = URI.create("ipps://localhost")) : this(cupsUri, IppClient())
 
     private val logger = getLogger(javaClass.name)
     val config: IppConfig by ippClient::config
     var userName: String? by config::userName
 
     var cupsDirectory = with(cupsUri) {
-        File("CUPS" + (if (host in listOf("localhost", "127.0.0.1")) "-" else File.separator) + host)
+        Path.of("CUPS" + (if (host in listOf("localhost", "127.0.0.1")) "-" else File.separator) + host)
     }
 
     private val cupsServer =
@@ -75,8 +77,9 @@ class CupsClient(
 
     fun getPrinter(printerName: String) =
         try {
-            IppPrinter(printerUri = cupsPrinterUri(printerName), ippClient = ippClient)
-                .apply { printerDirectory = File(cupsDirectory, printerName).createDirectoryIfNotExists() }
+            IppPrinter(cupsPrinterUri(printerName), ippClient = ippClient).apply {
+                printerDirectory = cupsDirectory.resolve(printerName)
+            }
         } catch (clientErrorNotFoundException: ClientErrorNotFoundException) {
             with(getPrinters()) {
                 if (isNotEmpty()) logger.warning { "Available CUPS printers: ${map { it.name }}" }
@@ -327,7 +330,7 @@ class CupsClient(
                             useJobOwnerAsUserName = true
                             cupsGetDocuments(
                                 save = true,
-                                directory = File(cupsDirectory, printerUri.path.substringAfterLast("/")),
+                                directory = cupsDirectory.resolve(printerUri.path.substringAfterLast("/")),
                                 optionalCommandToHandleFile = commandToHandleSavedFile
                             )
                                 .apply { numberOfSavedDocuments.addAndGet(size) }

src/main/kotlin/de/gmuth/ipp/client/IppClient.kt

@@ -14,11 +14,11 @@ import de.gmuth.ipp.core.IppTag.Unsupported
 import de.gmuth.ipp.core.appendAttributeIfGroupContainsKey
 import de.gmuth.ipp.iana.IppRegistrationsSection2
 import java.io.ByteArrayInputStream
-import java.io.File
 import java.io.IOException
 import java.io.InputStream
 import java.net.HttpURLConnection
 import java.net.URI
+import java.nio.file.Path
 import java.util.concurrent.atomic.AtomicInteger
 import java.util.logging.Level.FINEST
 import java.util.logging.Level.WARNING
@@ -37,11 +37,11 @@ open class IppClient(val config: IppConfig = IppConfig()) {
     var saveEvents: Boolean = false
     var saveMessages: Boolean = false
     var saveDocuments: Boolean = false
-    var saveMessagesDirectory: File = createTempDirectory().toFile()
+    var saveMessagesDirectory: Path = createTempDirectory()
     var onExceptionSaveMessages: Boolean = false
     var throwWhenNotSuccessful: Boolean = true
     var disconnectAfterHttpPost: Boolean = false
-    var defaultPrinterUri: URI? = URI.create("ipp://ippbin:12345")
+    var defaultPrinterUri: URI? = URI.create("ipp://ippbin.net:12345")
 
     fun basicAuth(user: String, password: String) {
         config.userName = user
@@ -167,7 +167,7 @@ open class IppClient(val config: IppConfig = IppConfig()) {
                 if (status == ClientErrorNotFound) ClientErrorNotFoundException(request, response)
                 else IppOperationException(request, response)
             if (onExceptionSaveMessages)
-                exception.saveMessages("${request.operation}_${status}_${request.requestId}")
+                exception.saveMessages(fileNameWithoutSuffix = "${request.operation}_${status}_${request.requestId}")
             if (throwWhenNotSuccessful)
                 throw exception
         }
@@ -229,7 +229,9 @@ open class IppClient(val config: IppConfig = IppConfig()) {
             read(contentStream)
         } catch (throwable: Throwable) {
             throw IppOperationException(request, this, "Failed to decode ipp response", throwable).apply {
-                if (onExceptionSaveMessages) saveMessages("decoding_ipp_response_${request.requestId}_failed")
+                if (onExceptionSaveMessages) saveMessages(
+                    fileNameWithoutSuffix = "decoding_ipp_response_${request.requestId}_from_${request.operation}_failed"
+                )
             }
         }
     }

src/main/kotlin/de/gmuth/ipp/client/IppDocument.kt

@@ -1,7 +1,7 @@
 package de.gmuth.ipp.client
 
 /**
- * Copyright (c) 2021-2024 Gerhard Muth
+ * Copyright (c) 2021-2025 Gerhard Muth
  */
 
 import de.gmuth.ipp.core.IppAttributesGroup
@@ -11,9 +11,14 @@ import java.io.File
 import java.io.IOException
 import java.io.InputStream
 import java.io.OutputStream
+import java.nio.file.Files
+import java.nio.file.Files.newOutputStream
+import java.nio.file.Path
 import java.util.logging.Level
 import java.util.logging.Logger
 import java.util.logging.Logger.getLogger
+import kotlin.io.path.createDirectories
+import kotlin.io.path.isRegularFile
 
 @Suppress("kotlin:S1192")
 class IppDocument(
@@ -30,6 +35,7 @@ class IppDocument(
             "text/plain" -> "txt"
             else -> mediaType.split("/")[1]
         }
+
         fun getDocumentFormatFilenameExtension(attributes: IppAttributesGroup) =
             getFilenameExtension(attributes.getValue("document-format"))
     }
@@ -45,7 +51,7 @@ class IppDocument(
     val name: IppString
         get() = attributes.getValue("document-name")
 
-    var file: File? = null
+    var file: Path? = null
 
     fun readBytes() = inputStream.readBytes()
         .also { logger.fine { "Read ${it.size} bytes of $this" } }
@@ -71,25 +77,25 @@ class IppDocument(
         inputStream.copyTo(outputStream)
 
     fun save(
-        directory: File = job.printer.printerDirectory,
+        directory: Path = job.printer.printerDirectory,
         filename: String = filename(),
         overwrite: Boolean = true
-    ) = File(directory, filename).also {
-        if (!directory.exists()) directory.mkdirs()
-        if (it.isFile && !overwrite) throw IOException("File '$it' already exists")
-        copyTo(it.outputStream())
+    ) = directory.resolve(filename).also {
+        it.parent?.createDirectories()
+        if (it.isRegularFile() && !overwrite) throw IOException("File '$it' already exists")
+        copyTo(newOutputStream(it))
         this.file = it
         logger.info { "Saved $file ${if (attributes.containsKey("document-format")) "($format)" else ""}" }
     }
 
     fun runtimeExecCommand(commandToHandleFile: String) =
         if (file == null) throw IppException("Missing file to handle.")
-        else Runtime.getRuntime().exec(arrayOf(commandToHandleFile, file!!.absolutePath))
+        else Runtime.getRuntime().exec(arrayOf(commandToHandleFile, file!!.toAbsolutePath().toString()))
 
     override fun toString() = StringBuilder("Document #$number").run {
         append(" ($format) of job #${job.id}")
         if (attributes.containsKey("document-name")) append(" '$name'")
-        if (file != null) append(": $file (${file!!.length()} bytes)")
+        if (file != null) append(": $file (${Files.size(file!!)} bytes)")
         toString()
     }
 

src/main/kotlin/de/gmuth/ipp/client/IppExchangeException.kt

@@ -1,17 +1,16 @@
 package de.gmuth.ipp.client
 
 /**
- * Copyright (c) 2020-2024 Gerhard Muth
+ * Copyright (c) 2020-2025 Gerhard Muth
  */
 
 import de.gmuth.ipp.core.IppException
 import de.gmuth.ipp.core.IppRequest
-import java.io.File
+import java.nio.file.Path
 import java.util.logging.Level
 import java.util.logging.Level.INFO
 import java.util.logging.Logger
 import kotlin.io.path.createTempDirectory
-import kotlin.io.path.pathString
 
 open class IppExchangeException(
     val request: IppRequest,
@@ -25,10 +24,9 @@ open class IppExchangeException(
     }
 
     open fun saveMessages(
-        fileNameWithoutSuffix: String = "ipp_exchange_exception",
-        directory: String = createTempDirectory("ipp-client-").pathString
-    ) {
-        request.saveBytes(File(directory, "$fileNameWithoutSuffix.request"))
-    }
+        directory: Path = createTempDirectory("ipp-client-"),
+        fileNameWithoutSuffix: String = "ipp_exchange_exception"
+    ) =
+        request.saveBytes(directory.resolve("$fileNameWithoutSuffix.request"))
 
 }