ipv4-static: Update hook

[people/stevee/network.git] / src / functions / functions.hook

#!/bin/bash
###############################################################################
#                                                                             #
# IPFire.org - A linux based firewall                                         #
# Copyright (C) 2010  Michael Tremer & Christian Schmidt                      #
#                                                                             #
# This program is free software: you can redistribute it and/or modify        #
# it under the terms of the GNU General Public License as published by        #
# the Free Software Foundation, either version 3 of the License, or           #
# (at your option) any later version.                                         #
#                                                                             #
# This program is distributed in the hope that it will be useful,             #
# but WITHOUT ANY WARRANTY; without even the implied warranty of              #
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               #
# GNU General Public License for more details.                                #
#                                                                             #
# You should have received a copy of the GNU General Public License           #
# along with this program.  If not, see <http://www.gnu.org/licenses/>.       #
#                                                                             #
###############################################################################

HOOK_COMMANDS_CONFIG="hook_create hook_down hook_edit hook_status hook_remove"
HOOK_COMMANDS_CONFIG="${HOOK_COMMANDS_CONFIG} hook_up"

HOOK_COMMANDS_PORT="hook_create hook_down hook_edit hook_hotplug \
	hook_hotplug_rename hook_info hook_status hook_up"

HOOK_COMMANDS_ZONE="hook_add hook_create hook_discover hook_down hook_edit hook_help \
	hook_info hook_remove hook_status hook_up \
	\
	hook_config_create hook_config_edit hook_config_remove hook_config_show \
	\
	hook_port hook_port_add hook_port_edit hook_port_remove hook_port_show \
	hook_port_status hook_port_up hook_port_down \
	\
	hook_ppp_ip_pre_up hook_ppp_ipv4_down hook_ppp_ipv4_up \
	hook_ipv6_down hook_ipv6_up hook_ppp_write_config"

function hook_dir() {
	local type=${1}

	if [ -n "${type}" ]; then
		type="/${type}s"
	fi

	echo "${NETWORK_HOOKS_DIR}${type}"
}
NETWORK_HOOKS_DIR_ZONES="$(hook_dir zone)"

function hook_exists() {
	local type=${1}
	local hook=${2}

	assert isset type
	assert isset hook

	# Add the path prefix.
	hook="$(hook_dir ${type})/${hook}"

	[ ! -d "${hook}" ] && [ -x "${hook}" ]
}

function hook_exec() {
	local type="${1}"
	assert isset type

	local hook="${2}"
	assert isset hook

	local cmd="${3}"
	assert isset cmd

	assert hook_exists "${type}" "${hook}"
	shift 3

	# Complete the hook command by prepending "hook_"
	local hook_cmd="hook_${cmd}"

	# Check if the hook action is valid.
	local valid_commands
	case "${type}" in
		"config")
			valid_commands="${HOOK_COMMANDS_CONFIG}"
			;;
		"port")
			valid_commands="${HOOK_COMMANDS_PORT}"
			;;
		"zone")
			valid_commands="${HOOK_COMMANDS_ZONE}"
			;;
	esac
	isset valid_commands && assert list_match "${hook_cmd}" ${valid_commands}

	local hook_path="$(hook_dir ${type})/${hook}"

	# For performance reasons, all hooks are executed
	# in a subshell and so will inherit the currently
	# running environment.
	(
		# Set the name of the hook.
		HOOK=$(basename ${hook})

		# Source the code of the hook.
		source "${hook_path}"

		# Make sure HOOK is still properly set.
		assert isset HOOK

		# Execute the requested command.
		cmd "${hook_cmd}" "$@"
	)
	local ret=$?

	case "${ret}" in
		${EXIT_COMMAND_NOT_FOUND}|${EXIT_NOT_SUPPORTED})
			log ERROR "Hook '${hook}' does not implement the method '${cmd}':"
			log ERROR "  arguments: $@"
			exit ${EXIT_COMMAND_NOT_FOUND}
			;;
		${EXIT_ERROR_ASSERT})
			log ERROR "Hook exited with an assertion error."
			exit ${EXIT_ERROR_ASSERT}
			;;
	esac

	return ${ret}
}

function hook_list() {
	local type="${1}"

	local dir="$(hook_dir "${type}")"
	assert isset dir

	local hook
	for hook in ${dir}/*; do
		hook="$(basename "${hook}")"

		if hook_exists "${type}" "${hook}"; then
			echo "${hook}"
		fi
	done
}

# The default help function.
function hook_help() {
	# If no man page has been configured, we print an error message.
	if [ -z "${HOOK_MANPAGE}" ]; then
		error "There is no help available for hook '${HOOK}'. Exiting."
		exit ${EXIT_ERROR}
	fi

	cli_show_man "${HOOK_MANPAGE}"

	exit $?
}

function config_get_hook() {
	local config=${1}

	assert isset config
	assert [ -e "${config}" ]

	(
		. ${config}
		echo "${HOOK}"
	)
}

function hook_zone_exists() {
	hook_exists zone $@
}

function hook_zone_exec() {
	hook_exec zone $@
}

function hook_zone_get_all() {
	hook_list zone
}

function hook_config_exists() {
	hook_exists config $@
}

function hook_config_exec() {
	hook_exec config $@
}

function hook_config_get_all() {
	hook_list config
}