view src/name/blackcap/clipman/Files.kt @ 54:a9d5c94a177c

Add README file.
author David Barts <n5jrn@me.com>
date Tue, 13 Apr 2021 10:33:33 -0700
parents c8ec2d7af3fb
children 88056f373a94
line wrap: on
line source

/*
 * For dealing with files.
 * BUG: does not ensure directories exist
 */
package name.blackcap.clipman

import java.io.BufferedReader
import java.io.File
import java.io.FileInputStream
import java.io.InputStreamReader
import java.util.Properties
import java.util.logging.FileHandler
import java.util.logging.Level
import java.util.logging.Logger
import java.util.logging.SimpleFormatter

/* OS Type */

enum class OS {
    MAC, UNIX, WINDOWS, OTHER;
    companion object {
        private val rawType = System.getProperty("os.name")?.toLowerCase()
        val type = if (rawType == null) {
                OTHER
            } else if (rawType.contains("win")) {
                WINDOWS
            } else if (rawType.contains("mac")) {
                MAC
            } else if (rawType.contains("nix") || rawType.contains("nux") || rawType.contains("aix") || rawType.contains("sunos")) {
                UNIX
            } else {
                OTHER
            }
    }
}

/* joins path name components to java.io.File */

fun joinPath(base: String, vararg rest: String) = rest.fold(File(base), ::File)

/* file names */

private val SHORTNAME = "clipman"
private val LONGNAME = "name.blackcap." + SHORTNAME
private val HOME = System.getenv("HOME")
private val PF_DIR = when (OS.type) {
    OS.MAC -> joinPath(HOME, "Library", "Application Support", LONGNAME)
    OS.WINDOWS -> joinPath(System.getenv("APPDATA"), LONGNAME)
    else -> joinPath(HOME, "." + SHORTNAME)
}
private val LF_DIR = when (OS.type) {
    OS.MAC -> joinPath(HOME, "Library", "Application Support", LONGNAME)
    OS.WINDOWS -> joinPath(System.getenv("LOCALAPPDATA"), LONGNAME)
    else -> joinPath(HOME, "." + SHORTNAME)
}
val PROP_FILE = File(PF_DIR, SHORTNAME + ".properties")
val LOG_FILE = File(LF_DIR, SHORTNAME + ".log")

/* make some needed directories */

private fun File.makeIfNeeded() = if (exists()) { true } else { mkdirs() }

/* make some usable objects */

val DPROPERTIES = Properties().apply {
    OS::class.java.getResourceAsStream("default.properties").use { load(it) }
}

val PROPERTIES = Properties(DPROPERTIES).apply {
    PF_DIR.makeIfNeeded()
    PROP_FILE.createNewFile()
    BufferedReader(InputStreamReader(FileInputStream(PROP_FILE), CHARSET)).use  {
        load(it)
    }
}

val LOGGER = run {
    System.setProperty("java.util.logging.SimpleFormatter.format",
        "%1\$tFT%1\$tT%1\$tz %2\$s%n%4\$s: %5\$s%6\$s%n")
    LF_DIR.makeIfNeeded()
    Logger.getLogger(LONGNAME).apply {
        addHandler(FileHandler(LOG_FILE.toString()).apply {
            formatter = SimpleFormatter() })
        level = Level.CONFIG
        useParentHandlers = false
    }
}