com.intershop.gradle.icm.extension.DevelopmentConfiguration.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of icm-gradle-plugin Show documentation
Show all versions of icm-gradle-plugin Show documentation
Intershop Commerce Management Plugins
/*
* Copyright 2019 Intershop Communications AG.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package com.intershop.gradle.icm.extension
import org.gradle.api.model.ObjectFactory
import org.gradle.api.provider.Property
import org.gradle.api.provider.ProviderFactory
import org.gradle.wrapper.GradleUserHomeLookup
import org.slf4j.Logger
import org.slf4j.LoggerFactory
import java.io.File
import java.util.*
import javax.inject.Inject
/**
* Extends the extension with important
* file directories for the server.
*
* @constructor creates a configuration from environment variables.
*/
open class DevelopmentConfiguration
@Inject constructor(objectFactory: ObjectFactory, providerFactory: ProviderFactory) {
private val logger: Logger = LoggerFactory.getLogger(DevelopmentConfiguration::class.java)
companion object {
/**
* Logger instance for logging.
*/
val log: Logger = LoggerFactory.getLogger(this::class.java.name)
const val LICENSE_DIR_ENV = "LICENSEDIR"
const val CONFIG_DIR_ENV = "CONFIGDIR"
const val CONFIG_DIR_SEC_ENV = "CONFIGDIR"
const val LICENSE_DIR_SYS = "licenseDir"
const val CONFIG_DIR_SYS = "configDir"
const val CONFIG_DIR_SEC_SYS = "configDir"
const val DEFAULT_LIC_PATH = "icm-default/lic"
const val DEFAULT_CONFIG_PATH = "icm-default/conf"
const val DEFAULT_CONFIGSEC_PATH = "icm-default/confSec"
const val LICENSE_FILE_NAME = "license.xml"
const val CONFIG_FILE_NAME = "icm.properties"
}
private val licenseDirectoryProperty: Property = objectFactory.property(String::class.java)
private val configDirectoryProperty: Property = objectFactory.property(String::class.java)
private val configDirectorySecProperty: Property = objectFactory.property(String::class.java)
private val configProperties: Properties = Properties()
private val configPropertiesSec: Properties = Properties()
init {
// read environment
val gradleUserHomePath = GradleUserHomeLookup.gradleUserHome().absolutePath
with(providerFactory) {
var licDirPath = environmentVariable(LICENSE_DIR_ENV).forUseAtConfigurationTime().orNull
var configDirPath = environmentVariable(CONFIG_DIR_ENV).forUseAtConfigurationTime().orNull
var configDirSecPath = environmentVariable(CONFIG_DIR_SEC_ENV).forUseAtConfigurationTime().orNull
// read system if necessary
if (licDirPath == null) {
licDirPath = systemProperty(LICENSE_DIR_SYS).forUseAtConfigurationTime().orNull
}
if (configDirPath == null) {
configDirPath = systemProperty(CONFIG_DIR_SYS).forUseAtConfigurationTime().orNull
}
if (configDirSecPath == null) {
configDirSecPath = systemProperty(CONFIG_DIR_SEC_SYS).forUseAtConfigurationTime().orNull
}
if (licDirPath == null) {
try {
licDirPath = gradleProperty(LICENSE_DIR_SYS).forUseAtConfigurationTime().orNull
} catch (ise: IllegalStateException) {
log.error(ise.message)
}
}
if (configDirPath == null) {
try {
configDirPath = gradleProperty(CONFIG_DIR_SYS).forUseAtConfigurationTime().orNull
} catch (ise: IllegalStateException) {
log.error(ise.message)
}
}
if (configDirSecPath == null) {
try {
configDirSecPath = gradleProperty(CONFIG_DIR_SEC_SYS).forUseAtConfigurationTime().orNull
} catch (ise: IllegalStateException) {
log.info(ise.message)
}
}
if (licDirPath == null) {
logger.warn("The default value is used for license directory, because there is no " +
"other value specified.")
licDirPath = File(File(gradleUserHomePath), DEFAULT_LIC_PATH).absolutePath
}
if (configDirPath == null) {
logger.warn("The default value is used for configuration directory, because there is no " +
"other value specified.")
configDirPath = File(File(gradleUserHomePath), DEFAULT_CONFIG_PATH).absolutePath
}
if (configDirSecPath == null) {
val tempConfigDirSecPath = File(File(gradleUserHomePath), DEFAULT_CONFIGSEC_PATH).absolutePath
configDirSecPath = if(File(tempConfigDirSecPath, CONFIG_FILE_NAME).exists()) {
tempConfigDirSecPath } else { null }
}
licenseDirectoryProperty.set(licDirPath)
configDirectoryProperty.set(configDirPath)
if (configDirSecPath != null) {
configDirectorySecProperty.set(configDirSecPath)
val configFile = File(configDirectorySec, CONFIG_FILE_NAME)
if (configFile.exists() && configFile.canRead()) {
configPropertiesSec.load(configFile.inputStream())
} else {
logger.warn("File for second configuration '{}' does not exists!", configFile.absolutePath)
}
}
val licFile = File(licenseDirectory, LICENSE_FILE_NAME)
if (! licFile.exists() && ! licFile.canRead()) {
logger.error("The File {} does not exists." +
"Please specify the directory with the license file with LICENSEDIR environment or" +
"with 'licenseDir' Gradle Property or system variable.", licFile.absolutePath)
}
val configFile = File(configDirectory, CONFIG_FILE_NAME)
if (configFile.exists() && configFile.canRead()) {
configProperties.load(configFile.inputStream())
} else {
logger.error("The file {} does not exists." +
"Please specify the configuration directory with CONFIGDIR environment or" +
"with 'configDir' Gradle Property or system variable.", configFile.absolutePath)
}
}
}
/**
* License directory path of the project.
*/
val licenseDirectory: String
get() = licenseDirectoryProperty.get()
val licenseFilePath: String
get() = File(licenseDirectory, LICENSE_FILE_NAME).absolutePath
/**
* Local configuration path of the project.
*/
val configDirectory: String
get() = configDirectoryProperty.get()
/**
* Local configuration path of the project.
*/
val configDirectorySec: String?
get() = configDirectorySecProperty.orNull
/**
* Get file path for configuration property.
*/
val configFilePath: String
get() = File(configDirectory, CONFIG_FILE_NAME).absolutePath
/**
* Get file path for configuration property.
*/
val configFilePathSec: String?
get() = configDirectorySecProperty.orNull
/**
* Get access to properties in configuration property file.
*
* @param property key of the properties file
*/
fun getConfigProperty(property: String): String {
return configProperties.getProperty(property, "")
}
/**
* Get access to properties in second configuration property file.
*
* @param property key of the properties file
*/
fun getConfigPropertySec(property: String): String {
return configPropertiesSec.getProperty(property, "")
}
/**
* Get access to properties in configuration property file.
*
* @param property key of the properties file
* @param defaultValue if key not available the default value is used.
*/
fun getConfigProperty(property: String, defaultValue: String): String {
return configProperties.getProperty(property, defaultValue)
}
/**
* Get access to properties in second configuration property file.
*
* @param property key of the properties file
* @param defaultValue if key not available the default value is used.
*/
fun getConfigPropertySec(property: String, defaultValue: String): String {
return configPropertiesSec.getProperty(property, defaultValue)
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy