settings.sh

#!/bin/bash

shopt -s extglob # used for trailing slashes globbing

# init variables
aSettingsFiles=()
current_settings_file="server.cnf"
line_num=0
aSettStr=()
aSettVar=()
aSettVal=()
aSettValid=()

function def_var() {
	local cfg_upper="$1"
	local cfg_lower="$2"
	local default_value="$3"
	local validation="$4"
	if [ "$cfg_upper" == "CFG_CMAKE_FLAGS" ] || [ "$cfg_upper" == "CFG_BAM_FLAGS" ]
	then
		eval "read -r -a $cfg_upper <<< '$default_value'"
		eval "export $cfg_upper"
	else
		eval "export $cfg_upper='$default_value'"
	fi
	aSettStr+=("$cfg_lower")
	aSettVar+=("$cfg_upper")
	aSettVal+=("$default_value")
	aSettValid+=("$validation")
}

function rename_old_settings() {
	local filename="$1"
	if [ ! -f "$filename" ]
	then
		err "Error: file not found $filename"
		exit 1
	fi
	local i
	local old
	local new
	for i in "${!aSettStr[@]}"
	do
		old="${aSettStr[$i]}"
		new="${aSettVar[$i]}"
		echo "$old -> $new"
		sed "s/^$old=/$new=/" "$filename" > "$filename".tmp
		mv "$filename".tmp "$filename"
	done
	local incfile
	while read -r incfile
	do
		rename_old_settings "$(echo "$incfile" | awk '{ print $2 }')"
	done < <(grep "^include " "$filename")
}

function create_settings() {
	if [ -f $current_settings_file ];
	then
		return
	fi
	local i
	log "FileError: '$current_settings_file' not found"
	read -p "Do you want to create one? [y/N]" -n 1 -r
	echo 
	if [[ $REPLY =~ ^[Yy]$ ]]
	then
		{
			echo "# DDNet++ server config by ChillerDragon"
			echo "# https://github.com/DDNetPP/server"
			for i in "${!aSettStr[@]}"
			do
				echo "${aSettStr[$i]}=${aSettVal[$i]}"
			done
		} > "$current_settings_file"
	edit_file "$current_settings_file"
	fi
	exit 1
}

function settings_err() {
	err "SettingsError: $(tput bold)$current_settings_file:$line_num$(tput sgr0) $1"
}

function settings_err_tab() {
	err "               $1"
}

function parse_settings_line() {
	local sett=$1
	local val=$2
	local assign
	if [ "$sett" == "compiled_binary_name" ]
	then
		wrn "WARNING: 'compiled_binary_name' is deprecated by 'compiled_teeworlds_name'"
		wrn "         please fix at $current_settings_file:$line_num"
		sett=compiled_teeworlds_name
	elif [ "$sett" == "gitpath_src" ]
	then
		wrn "WARNING: 'gitpath_src' is deprecated by 'git_root'"
		wrn "         please fix at $current_settings_file:$line_num"
		sett=git_root
	fi
	local i
	for i in "${!aSettStr[@]}"
	do
		if  [ "$sett" == "${aSettStr[$i]}" ]
		then
			# printf "[setting] (%s)%-16s=  %s\\n" "$i" "$sett" "$val"
			if [[ "${aSettStr[$i]}" =~ path ]]
			then
				val="${val%%+(/)}" # strip trailing slash
			fi
			valid_pattern=${aSettValid[$i]}
			if [[ "$valid_pattern" != "" ]] && [[ ! "$val" =~ ^$valid_pattern$ ]]
			then
				settings_err "invalid value '$val' for setting '$sett'"
				err "               values have to match $valid_pattern"
				exit 1
			fi
			# escape single quotes
			val="${val//\'/\'\\\'\'}"
			assign="${aSettVar[$i]}='$val'"
			eval "$assign"
			return
		fi
	done
	settings_err "unknown setting '$(tput bold)$sett$(tput sgr0)'"
	exit 1
}

function parse_settings_cmd() {
	local cmd="$1"
	shift
	if [ "$cmd" == "include" ]
	then
		if [ ! -f "$1" ]
		then
			settings_err "include command failed"
			settings_err_tab "no such file $(tput bold)$1$(tput sgr0)"
			exit 1
		fi
		read_settings_file "$1"
	elif [ "$cmd" == "echo" ]
	then
		echo "$(tput bold)[settings]$(tput sgr0) $*"
	else
		settings_err "unknown command '$(tput bold)$cmd$(tput sgr0)'"
		exit 1
	fi
}

function include() {
	local old_sett
	old_sett="$current_settings_file"
	current_settings_file="$1"
	# shellcheck disable=SC1090
	source "$1"
	current_settings_file="$old_sett"

	if [ -x "$(command -v shellcheck)" ]
	then
		shellcheck -x -e SC2034 --shell=bash "$1"
	fi
}

function check_var_new() {
	local sett="$1"
	local val
	local i
	for i in "${!aSettStr[@]}"
	do
		if  [ "$sett" == "${aSettVar[$i]}" ]
		then
			# printf "[setting] (%s)%-16s=  %s\\n" "$i" "$sett" "$val"
			val="$(eval "echo \"\$$sett\"")"
			# todo: document this weird behavior somewhere
			#       this is intended as a feature that the user can config what he wants
			#       append as many trailing slashes at the end of paths
			#
			#       the fix is just stripping slashes of all configs that contain the str PATH
			#       then when they get concatinated with a filename you never get something like
			#       /some/path/var//concatfile.txt
			if [[ "$sett" =~ PATH ]]
			then
				val="${val%%+(/)}" # strip trailing slash
				# escape single quotes
				val="${val//\'/\'\\\'\'}"
				assign="$sett='$val'"
				eval "$assign"
			fi
			valid_pattern=${aSettValid[$i]}
			if [[ "$valid_pattern" != "" ]] && [[ ! "$val" =~ ^$valid_pattern$ ]]
			then
				settings_err "invalid value '$val' for setting '$sett'"
				err "               values have to match $valid_pattern"
				exit 1
			fi
			return
		fi
	done
	# this is a bit hacky
	# but since we not not parse our self we have to guess the current line_num
	line_num="$(grep -n "^$sett=" "$current_settings_file" | cut -d':' -f1)"
	settings_err "unknown setting '$(tput bold)$sett$(tput sgr0)'"
	exit 1
}

function read_settings_file_new() {
	local filename="$1"
	current_settings_file="$filename"
	if [ -x "$(command -v shellcheck)" ]
	then
		shellcheck -x -e SC2034 --shell=bash "$filename"
	fi
	local var
	if [ "$IS_SETT_FIX" != "1" ] && grep -qE '^[a-z]+[a-z0-9_]+=' "$filename"
	then
		err "Error: found old settings format in $filename"
		err "       run the following command to fix it"
		echo ""
		tput bold
		echo "  ./lib/fix_settings.sh"
		tput sgr0
		echo ""
		exit 1
	fi
	# shellcheck disable=SC1090
	source "$filename"

	for var in "${!CFG_@}"
	do
		check_var_new "$var"
	done
}

function read_settings_file() {
	# read_settings_file_new "$1"
	# return
	local filename="$1"
	current_settings_file="$filename"
	line_num=0
	local i
	local split_line
	local cmd_and_args
	for i in "${aSettingsFiles[@]}"
	do
		if [ "$i" == "$filename" ]
		then
			settings_err "trying to include $filename recursively"
			exit 1
		fi
	done
	aSettingsFiles+=("$filename")
	while read -r line
	do
		line_num="$((line_num + 1))"
		if [ "${line:0:1}" == "#" ]
		then
			continue # ignore comments
		elif [ -z "$line" ]
		then
			continue # ignore empty lines
		fi
		local line_set=""
		local line_val=""
		if ! echo "$line"| grep -q '='
		then
			IFS=' ' read -ra cmd_and_args <<< "$line"
			parse_settings_cmd "${cmd_and_args[@]}"
			continue
		fi
		IFS='=' read -ra split_line <<< "$line"
		for i in "${!split_line[@]}"
		do
			# split by '=' and then join all the elements bigger than 0
			# thus we allow using '=' inside the value
			if [ "$i" == "0" ]
			then
				line_set="${split_line[$i]}"
			else
				if [ "$i" -gt "1" ]
				then
					line_val+="="
				fi
				line_val+="${split_line[$i]}"
			fi
		done
		parse_settings_line "$line_set" "$line_val"
	done < "$filename"
}

function is_cfg() {
	# check if cfg is truthy
	# does not take a cfg value but a var name
	# example: is_cfg CFG_GDB_DUMP_CORE
	local cfg
	cfg=$1
	case "${!cfg}" in
		1|true) return 0;;
		yes|on) return 0;;
		*) return 1;;
	esac
}

# load syntax
source ./lib/include/vars.sh
for plugin in ./lib/plugins/*/
do
	[ -d "$plugin" ] || continue
	[ -f "$plugin"vars.sh ] || continue

	# shellcheck source=./lib/include/vars.sh
	source "$plugin"vars.sh
done

# load user configs
create_settings # create fresh if null
read_settings_file "$current_settings_file" # get values from file

IS_DUMPS_LOGPATH=0
default_save_dir="$HOME/.teeworlds/"

if [ "$CFG_SERVER_TYPE" == "tem" ]
then
	tem_settings_path="$CFG_TEM_PATH/$CFG_TEM_SETTINGS"
	if [ ! -f "$tem_settings_path" ]
	then
		err "ERROR: tem settings file not found"
		err "       $tem_settings_path"
		exit 1
	fi
	CFG_LOGS_PATH="$(grep '^sh_logs_path' "$tem_settings_path" | tail -n1 | cut -d'=' -f2-)"
	tem_tw_version="$(grep '^sh_tw_version' "$tem_settings_path" | tail -n1 | cut -d'=' -f2-)"
	if [ "${CFG_LOGS_PATH::1}" != "/" ]
	then
		if [ "$tem_tw_version" != "6" ]
		then
			CFG_LOGS_PATH="${default_save_dir}dumps/$CFG_LOGS_PATH"
		else
			CFG_LOGS_PATH="$default_save_dir$CFG_LOGS_PATH"
		fi
	fi
fi
CFG_LOGS_PATH="${CFG_LOGS_PATH%%+(/)}" # strip trailing slash
LOGS_PATH_TW="$CFG_LOGS_PATH"

if [ "$CFG_LOGS_PATH" == "" ]
then
	err "[setting] gitpath_log can not be empty"
	exit 1
fi

if [[ $CFG_LOGS_PATH =~ \.teeworlds/dumps/ ]]
then
	# log "detected 0.7 logpath"
	# only use the relative part starting from dumps dir
	LOGS_PATH_TW="${CFG_LOGS_PATH##*.teeworlds/dumps/}"
	IS_DUMPS_LOGPATH=1
	if [ "$LOGS_PATH_TW" == "" ]
	then
		wrn "WARNING log root path is empty"
		read -p "Do you want to proceed? [y/N]" -n 1 -r
		echo ""
		if ! [[ $REPLY =~ ^[Yy]$ ]]
		then
			log "aborting ..."
			exit 1
		fi
	fi
fi
LOGS_PATH_FULL="$CFG_LOGS_PATH/$CFG_SRV_NAME/logs"
LOGS_PATH_FULL_TW="$LOGS_PATH_TW/$CFG_SRV_NAME/logs"
if [[ "$LOGS_PATH_FULL" =~ ^$default_save_dir ]]
then
	# replace ~/.teeworlds/
	# by storage.cfg path
	def_len="${#default_save_dir}"
	LOGS_PATH_FULL="$(storage_get_save_path)/${LOGS_PATH_FULL:$def_len}"
fi
if [ "$CFG_SERVER_TYPE" == "tem" ]
then
	LOGS_PATH_FULL="$CFG_LOGS_PATH"
	LOGS_PATH_FULL_TW="$LOGS_PATH_TW"
fi

export CFG_CMAKE_FLAGS # usage: "${CFG_CMAKE_FLAGS[@]}"
export CFG_BAM_FLAGS # usage: "${CFG_BAM_FLAGS[@]}"
export IS_DUMPS_LOGPATH
export LOGS_PATH_TW
export LOGS_PATH_FULL
export LOGS_PATH_FULL_TW
export CFG_BIN=bin/$CFG_SRV_NAME
if [[ "${CFG_CMAKE_FLAGS,,}" =~ debug ]]
then
	export CFG_DEBUG=1
	export CFG_BIN="${CFG_BIN}_d"
else
	export CFG_DEBUG=0
fi