net.dankito.utils.process.CommandlineProgram.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-utils Show documentation

Some basic utils needed in many projects

There is a newer version: 1.0.20

package net.dankito.utils.process

import net.dankito.utils.os.OsHelper
import java.io.File


open class CommandlineProgram(
    osIndependentDefaultExecutableName: String,
    protected val commandExecutor: ICommandExecutor = CommandExecutor(),
    protected val osHelper: OsHelper = OsHelper()
) {

    open var programExecutablePath: String = ""
        protected set

    open var isAvailable: Boolean = false
        protected set


    init {
        setProgramExecutablePathTo(getOsDependentExecutableName(osIndependentDefaultExecutableName))
    }


    protected open fun getOsDependentExecutableName(executableName: String): String {
        if (osHelper.isRunningOnWindows && File(executableName).extension.isEmpty()) {
            return executableName + ".exe"
        }

        return executableName
    }


    open fun setProgramExecutablePathTo(programExecutablePath: String) {
        this.programExecutablePath = programExecutablePath

        checkIsProgramAvailable(programExecutablePath)
    }

    protected open fun checkIsProgramAvailable(programExecutablePath: String): Boolean {
        val executionResult = executeCheckIfProgramIsAvailable(getCommandArgsToCheckIfProgramIsAvailable(programExecutablePath))

        isAvailable = evaluateIfProgramIsAvailable(executionResult)

        return isAvailable
    }

    protected open fun getCommandArgsToCheckIfProgramIsAvailable(programExecutablePath: String): List {
        return listOf(programExecutablePath, "-v")
    }

    protected open fun executeCheckIfProgramIsAvailable(commandArgs: List): ExecuteCommandResult {
        return commandExecutor.executeCommandWithLittleOutput(CommandConfig(commandArgs))
    }

    protected open fun evaluateIfProgramIsAvailable(executionResult: ExecuteCommandResult): Boolean {
        return executionResult.successful
    }

}