configure.functions

# This file is part of shellfire configure. It is subject to the licence terms in the COPYRIGHT file found in the top-level directory of this distribution and at https://raw.githubusercontent.com/shellfire-dev/configure/master/COPYRIGHT. No part of shellfire configure, including this file, may be copied, modified, propagated, or distributed except according to the terms contained in the COPYRIGHT file.
# Copyright © 2014-2015 The developers of shellfire configure. See the COPYRIGHT file in the top-level directory of this distribution and at https://raw.githubusercontent.com/shellfire-dev/configure/master/COPYRIGHT.


core_usesIn configure validate
core_usesIn core variable variable/array

configure_register()
{
	local kind="$1"
	local configurationValidationFunction="configure_validate_${2}"
	local namespace="$3"
	local configurationSettingName="$4"
	
	case "$kind" in
		
		Array)
			if [ $# -gt 4 ]; then
				core_exitError $core_commandLine_exitCode_SOFTWARE "Arrays can not have default values"
			fi
		;;
		
		Value)
			:
		;;
		
		*)
			core_exitError $core_commandLine_exitCode_SOFTWARE "kind '$kind' is unrecognised (must be one of 'Array' or 'Value')"
		;;
		
	esac
	
	local configurationSettingNamespace
	local configurationSettingValue
	local configurationSettingValidate
	local configurationSettingDefault
	local configurationSettingIsArray
	_configure_configurationSetting "$namespace" "$configurationSettingName"
	
	if core_variable_isSet "$configurationSettingValidate"; then
		core_message NOTICE "The configuration setting '$configurationSettingValidate' is already registered"
		return 0
	fi
	
	core_variable_setVariable "$configurationSettingValidate" "$configurationValidationFunction"
	
	core_variable_array_append "$configurationSettingNamespace" "$configurationSettingName"
	
	if [ "$kind" = 'Array' ]; then
		core_variable_setVariable "$configurationSettingIsArray" 'yes'
	else
		core_variable_setVariable "$configurationSettingIsArray" 'no'
	fi
	
	if [ $# -eq 4 ]; then
		return 0
	fi
	shift 4
	
	IFS=' ' local configurationSettingDefaultValue="$*"
	
	if core_variable_isUnset "$configurationSettingDefault"; then
		$configurationValidationFunction "$configurationSettingDefaultValue"
		core_variable_setVariable "$configurationSettingDefault" "$configurationSettingDefaultValue"
	fi
}

configure_reset()
{
	local namespace="$1"

	local configurationSettingNamespace
	_configure_configurationNamespace
	
	_configure_reset_callback()
	{
		local configurationSettingName="$core_variable_array_element"
		local configurationSettingValue
		local configurationSettingValidate
		local configurationSettingDefault
		local configurationSettingIsArray
		_configure_configurationSetting "$namespace" "$configurationSettingName"

		if _configure_configurationSettingIsArray; then
			core_variable_array_unset "$configurationSettingValue"
			core_variable_array_initialise "$configurationSettingValue"
		else
			core_variable_unset "$configurationSettingValue"
			
			if core_variable_isSet "$configurationSettingDefault"; then
				local core_variable_indirectValue_result
				core_variable_indirectValue "$configurationSettingDefault"
				core_variable_setVariable "$configurationSettingValue" "$core_variable_indirectValue_result"
			fi
		fi
	}
	
	if core_variable_array_isUnset "$configurationSettingNamespace"; then
		return 0
	fi
	
	core_variable_array_iterate "$configurationSettingNamespace" _configure_reset_callback
}

configure()
{
	local namespace="$1"
	local configurationSettingName="$2"
	shift 2
	if [ $# -ne 0 ]; then
		IFS=' ' local value="$*"
	else
		local value="$(cat)"
	fi
	
	local configurationSettingNamespace
	local configurationSettingValue
	local configurationSettingValidate
	local configurationSettingDefault
	local configurationSettingIsArray
	_configure_configurationSetting "$namespace" "$configurationSettingName"
	
	local validateFunction
	local core_variable_indirectValue_result
	core_variable_indirectValue "$configurationSettingValidate"
	$core_variable_indirectValue_result "$value"
	
	if _configure_configurationSettingIsArray; then
		core_variable_array_append "$configurationSettingValue" "$value"
	else
		core_variable_setVariable "$configurationSettingValue" "$value"
	fi
}

configure_source()
{
	local configurationPath="$1"
	local configurationName="$2"
	local configurationFilePath="$configurationPath"/"$configurationName".conf
	if core_path_isReadableNonEmptyFilePath "$configurationFilePath"; then
		. "$configurationFilePath"
	fi
	
	local configurationFolderPath="$configurationPath"/"$configurationName".conf.d
	if core_path_isReadableAndSearchableFolderPath "$configurationFolderPath"; then
		pushd "$configurationFolderPath"
			set +f
			for configurationFilePath in *.conf
			do
				set -f
				if core_path_isReadableNonEmptyFilePath "$configurationFilePath"; then
					. "$configurationFilePath"
				fi
			done
			set -f
		popd
	fi
}

core_usesIn configure validate
configure_validate()
{
	local namespace="$1"
	
	_configure_validate_callback()
	{
		local configurationSettingName="$core_variable_array_element"
		local configurationSettingValue
		local configurationSettingValidate
		local configurationSettingDefault
		local configurationSettingIsArray
		_configure_configurationSetting "$namespace" "$configurationSettingName"
	
		if _configure_configurationSettingIsArray; then
			continue
		fi
		if core_variable_isUnset "$configurationSettingValue"; then
			core_exitError $core_commandLine_exitCode_CONFIG "The configuration setting '$namespace $configurationSettingName' can not be unset"
		fi
	}
	
	local configurationSettingNamespace
	_configure_configurationNamespace
	
	if core_variable_array_isUnset "$configurationSettingNamespace"; then
		return 0
	fi
	
	core_variable_array_iterate "$configurationSettingNamespace" _configure_validate_callback
}

configure_getValue()
{
	local namespace="$1"
	local configurationSettingName="$2"
	local configurationSettingValue
	local configurationSettingValidate
	local configurationSettingDefault
	local configurationSettingIsArray
	_configure_configurationSetting "$namespace" "$configurationSettingName"
		
	local core_variable_indirectValue_result
	core_variable_indirectValue "$configurationSettingValue"
	printf '%s' "$core_variable_indirectValue_result"
}

configure_iterateOverArrayWithDefaultsIfEmpty()
{
	local namespace="$1"
	local valueName="$2"
	local callback="$3"
	shift 3
	
	local configurationSettingValue
	_configure_configurationSettingValue "$namespace" "$valueName"
	
	if core_variable_array_isEmpty "$configurationSettingValue"; then
		
		local core_variable_array_element
		for core_variable_array_element in "$@"
		do
			$callback
		done
		
	else
		core_variable_array_iterate "$configurationSettingValue" "$callback"
	fi
}

configure_callFunctionWithDefaultsIfEmpty()
{
	local namespace="$1"
	local valueName="$2"
	local callback="$3"
	shift 3
	
	local configurationSettingValue
	_configure_configurationSettingValue "$namespace" "$valueName"
	
	if core_variable_array_isEmpty "$configurationSettingValue"; then
		"$callback" "$@"
	else
		core_variable_array_passToFunctionAsArguments "$configurationSettingValue" "$callback"
	fi
}

core_dependency_requires '*' rm
configure_isValueValid()
{
	local snippetName="$1"
	local configurationSettingValue="$2"
	
	local TMP_FILE
	core_temporaryFiles_newFileToRemoveOnExit
	core_snippet_retrieve "$snippetName" no "$TMP_FILE"
	local validValuesFilePath="$TMP_FILE"

	local validValue
	local found=0
	while IFS='' read -r validValue
	do
		if [ "$configurationSettingValue" = "$validValue" ]; then
			found=1
			break
		fi
	done <"$validValuesFilePath"
	
	if [ -n "$validValue" ]; then
		if [ "$configurationSettingValue" = "$validValue" ]; then
			found=1
		fi
	fi
	
	if [ $found -eq 0 ]; then
		core_message WARN "The configuration setting '$configurationSettingName' ('$configurationSettingValue') is not a valid '$snippetName'."
	fi
	
	rm "$validValuesFilePath"
}

_configure_configurationNamespace()
{
	if [ $# -eq 1 ]; then
		local namespace="$1"
	fi
	configurationSettingNamespace="${_program_namespace}_build_configuration_namespace_${namespace}"
}

_configure_configurationSettingValue()
{
	if [ $# -eq 2 ]; then
		local namespace="$1"
		local configurationSettingName="$2"
	fi
	local key="${namespace}_${configurationSettingName}"
	configurationSettingValue="${_program_namespace}_build_configuration_value_${key}"
}

_configure_configurationSetting()
{
	local namespace="$1"
	local configurationSettingName="$2"
	local key="${namespace}_${configurationSettingName}"
	_configure_configurationNamespace
	_configure_configurationSettingValue
	configurationSettingValidate="${_program_namespace}_build_configuration_validate_${key}"
	configurationSettingDefault="${_program_namespace}_build_configuration_default_${key}"
	configurationSettingIsArray="${_program_namespace}_build_configuration_isArray_${key}"
}

_configure_configurationSettingIsArray()
{
	local core_variable_indirectValue_result
	core_variable_indirectValue "$configurationSettingIsArray"
	core_variable_isTrue "$core_variable_indirectValue_result"
}