[people/stevee/network.git] / functions.zone

#!/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/>.       #
#                                                                             #
###############################################################################

function zone_dir() {
	local zone=${1}

	echo "${ZONE_DIR}/${zone}"
}

function zone_exists() {
	local zone=${1}

	[ -d "$(zone_dir ${zone})" ]
}

function zone_match() {
	local match

	local i
	for i in ${VALID_ZONES}; do
		match="${match}|${i}[0-9]{1,5}"
	done

	echo "${match:1:${#match}}"
}

function zone_name_is_valid() {
	local zone=${1}

	[[ ${zone} =~ $(zone_match) ]]
}

function zone_is_local() {
	local zone=${1}

	! zone_is_nonlocal ${zone}
}

function zone_is_nonlocal() {
	local zone=${1}

	[[ ${zone} =~ ^red[0-9]{1,5} ]]
}

function zone_get_hook() {
	local zone=${1}

	config_get_hook $(zone_dir ${zone})/settings
}

function zone_create() {
	local zone=${1}
	local hook=${2}
	shift 2

	if ! zone_name_is_valid ${zone}; then
		error "Zone name '${zone}' is not valid."
		return ${EXIT_ERROR}
	fi

	if zone_exists ${zone}; then
		error "Zone '${zone}' does already exist."
		return ${EXIT_ERROR}
	fi

	if ! hook_exists ${hook}; then
		error "Hook '${hook}' does not exist."
		return ${EXIT_ERROR}
	fi

	mkdir -p $(zone_dir ${zone})

	hook_exec ${hook} create ${zone} $@
	local ret=$?

	# Maybe the zone create hook did not exit correctly.
	# If this is the case we remove the created zone immediately.
	if [ "${ret}" = "${EXIT_ERROR}" ]; then
		zone_remove ${zone}
	fi
}

function zone_edit() {
	local zone=${1}
	shift

	if ! zone_exists ${zone}; then
		error "Zone '${zone}' does not exist."
		return ${EXIT_ERROR}
	fi

	local hook=$(config_get_hook $(zone_dir ${zone})/settings)

	if [ -z "${hook}" ]; then
		error "Config file did not provide any hook."
		return ${EXIT_ERROR}
	fi

	if ! hook_exists ${hook}; then
		error "Hook '${hook}' does not exist."
		return ${EXIT_ERROR}
	fi

	hook_exec ${hook} edit ${zone} $@
}

function zone_remove() {
	local zone=${1}
	shift

	if ! zone_exists ${zone}; then
		error "Zone '${zone}' does not exist."
		return ${EXIT_ERROR}
	fi

	# XXX Tear this down here?

	rm -rf $(zone_dir ${zone})
}

function zone_up() {
	local zone=${1}
	shift

	if ! zone_exists ${zone}; then
		error "Zone '${zone}' does not exist."
		return ${EXIT_ERROR}
	fi

	local hook=$(config_get_hook $(zone_dir ${zone})/settings)

	if [ -z "${hook}" ]; then
		error "Config file did not provide any hook."
		return ${EXIT_ERROR}
	fi

	if ! hook_exists ${hook}; then
		error "Hook '${hook}' does not exist."
		return ${EXIT_ERROR}
	fi

	zone_db ${zone} starting

	hook_exec ${hook} up ${zone} $@
	
	zone_db ${zone} started
}

function zone_down() {
	local zone=${1}
	shift

	if ! zone_exists ${zone}; then
		error "Zone '${zone}' does not exist."
		return ${EXIT_ERROR}
	fi

	local hook=$(config_get_hook $(zone_dir ${zone})/settings)

	if [ -z "${hook}" ]; then
		error "Config file did not provide any hook."
		return ${EXIT_ERROR}
	fi

	if ! hook_exists ${hook}; then
		error "Hook '${hook}' does not exist."
		return ${EXIT_ERROR}
	fi

	zone_db ${zone} stopping

	hook_exec ${hook} down ${zone} $@

	zone_db ${zone} stopped
}

function zone_status() {
	local zone=${1}
	shift

	if ! zone_exists ${zone}; then
		error "Zone '${zone}' does not exist."
		return ${EXIT_ERROR}
	fi

	local hook=$(config_get_hook $(zone_dir ${zone})/settings)

	if [ -z "${hook}" ]; then
		error "Config file did not provide any hook."
		return ${EXIT_ERROR}
	fi

	if ! hook_exists ${hook}; then
		error "Hook '${hook}' does not exist."
		return ${EXIT_ERROR}
	fi

	hook_exec ${hook} status ${zone} $@
}

function zone_port() {
	local zone=${1}
	shift

	if ! zone_exists ${zone}; then
		error "Zone '${zone}' does not exist."
		return ${EXIT_ERROR}
	fi

	local hook=$(config_get_hook $(zone_dir ${zone})/settings)

	if [ -z "${hook}" ]; then
		error "Config file did not provide any hook."
		return ${EXIT_ERROR}
	fi

	if ! hook_exists ${hook}; then
		error "Hook '${hook}' does not exist."
		return ${EXIT_ERROR}
	fi

	hook_exec ${hook} port ${zone} $@
}

function zone_config() {
	local zone=${1}
	shift

	if ! zone_exists ${zone}; then
		error "Zone '${zone}' does not exist."
		return ${EXIT_ERROR}
	fi

	local hook=$(config_get_hook $(zone_dir ${zone})/settings)

	if [ -z "${hook}" ]; then
		error "Config file did not provide any hook."
		return ${EXIT_ERROR}
	fi

	if ! hook_exists ${hook}; then
		error "Hook '${hook}' does not exist."
		return ${EXIT_ERROR}
	fi

	hook_exec ${hook} config ${zone} $@
}

function zone_show() {
	local zone=${1}

	echo "${zone}"
	echo "  Type: $(zone_get_hook ${zone})"
	echo
}

function zones_show() {
	local zone

	for zone in $(zones_get $@); do
		zone_show ${zone}
	done
}

function zones_get_all() {
	local zone
	for zone in ${ZONE_DIR}/*; do
		zone=$(basename ${zone})
		zone_exists ${zone} || continue

		echo "${zone}"
	done | sort
}

function zones_get_local() {
	local zone
	for zone in $(zones_get_all); do
		zone_is_local ${zone} && echo "${zone}"
	done
}

function zones_get_nonlocal() {
	local zone
	for zone in $(zones_get_all); do
		zone_is_nonlocal ${zone} && echo "${zone}"
	done
}

function zones_get() {
	local local=1
	local remote=1

	local zones

	while [ $# -gt 0 ]; do
		case "${1}" in
			--local-only)
				local=1
				remote=0
				;;
			--remote-only)
				local=0
				remote=1
				;;
			--all)
				local=1
				remote=1
				;;
			*)
				if zone_name_is_valid ${1}; then
					zones="${zones} ${1}"
				else			
					warning "Unrecognized argument '${1}'"
				fi
				;;
		esac
		shift
	done

	if [ -n "${zones}" ]; then
		local zone
		for zone in ${zones}; do
			zone_exists ${zone} && echo "${zone}"
		done
		exit ${EXIT_OK}
	fi

	if [ ${local} -eq 1 ] && [ ${remote} -eq 1 ]; then
		zones_get_all
	elif [ ${local} -eq 1 ]; then
		zones_get_local
	elif [ ${remote} -eq 1 ]; then
		zones_get_nonlocal
	fi
}

function zone_ports_list() {
	local zone=${1}

	local port
	for port in $(zone_dir ${zone})/port.*; do
		[ -e "${port}" ] || continue

		echo $(basename ${port})
	done | sort
}

function zone_ports_cmd() {
	local cmd=${1}
	local zone=${2}
	shift 2

	local hook_zone=$(config_get_hook $(zone_dir ${zone})/settings)

	local hook_port
	local port
	for port in $(zone_ports_list ${zone}); do
		hook_port=$(config_get_hook $(zone_dir ${zone})/${port})

		hook_port_exec ${hook_zone} ${hook_port} ${cmd} ${zone} ${port} $@
	done
}

function zone_ports_up() {
	zone_ports_cmd up $@
}

function zone_ports_down() {
	zone_ports_cmd down $@
}

function zone_configs_list() {
	local zone=${1}

	local config
	for config in $(zone_dir ${zone})/config.*; do
		[ -e "${config}" ] || continue

		echo $(basename ${config})
	done | sort
}

function zone_configs_cmd() {
	local cmd=${1}
	local zone=${2}
	shift 2

	local hook_zone=$(config_get_hook $(zone_dir ${zone})/settings)

	local hook_config
	local config
	for config in $(zone_configs_list ${zone}); do
		hook_config=$(config_get_hook $(zone_dir ${zone})/${config})

		hook_config_exec ${hook_zone} ${hook_config} ${cmd} ${zone} ${config} $@
	done
}

function zone_configs_up() {
	zone_configs_cmd up $@
}

function zone_configs_down() {
	zone_configs_cmd down $@
}

function zone_has_ipv4() {
	device_has_ipv4 $@
}

function zone_db() {
	local zone=${1}
	local action=${2}
	shift 2

	case "${action}" in
		starting|started|stopping|stopped)
			db_connection_update ${zone} ${action}
			;;
	esac
}

function zone_is_up() {
	local zone=${1}

	device_is_up ${zone}
}

function zone_is_down() {
	! zone_is_up $@
}
Commit	Line	Data
1848564d MT	1	#!/bin/bash
	2	###############################################################################
	3	# #
	4	# IPFire.org - A linux based firewall #
	5	# Copyright (C) 2010 Michael Tremer & Christian Schmidt #
	6	# #
	7	# This program is free software: you can redistribute it and/or modify #
	8	# it under the terms of the GNU General Public License as published by #
	9	# the Free Software Foundation, either version 3 of the License, or #
	10	# (at your option) any later version. #
	11	# #
	12	# This program is distributed in the hope that it will be useful, #
	13	# but WITHOUT ANY WARRANTY; without even the implied warranty of #
	14	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
	15	# GNU General Public License for more details. #
	16	# #
	17	# You should have received a copy of the GNU General Public License #
	18	# along with this program. If not, see <http://www.gnu.org/licenses/>. #
	19	# #
	20	###############################################################################
	21
	22	function zone_dir() {
	23	local zone=${1}
	24
	25	echo "${ZONE_DIR}/${zone}"
	26	}
	27
	28	function zone_exists() {
	29	local zone=${1}
	30
	31	[ -d "$(zone_dir ${zone})" ]
	32	}
	33
	34	function zone_match() {
	35	local match
	36
	37	local i
	38	for i in ${VALID_ZONES}; do
	39	match="${match}\|${i}[0-9]{1,5}"
	40	done
	41
	42	echo "${match:1:${#match}}"
	43	}
	44
	45	function zone_name_is_valid() {
	46	local zone=${1}
	47
	48	[[ ${zone} =~ $(zone_match) ]]
	49	}
	50
	51	function zone_is_local() {
	52	local zone=${1}
	53
5e42d659 MT	54	! zone_is_nonlocal ${zone}
	55	}
	56
	57	function zone_is_nonlocal() {
	58	local zone=${1}
	59
	60	[[ ${zone} =~ ^red[0-9]{1,5} ]]
1848564d MT	61	}
	62
	63	function zone_get_hook() {
	64	local zone=${1}
	65
	66	config_get_hook $(zone_dir ${zone})/settings
	67	}
	68
	69	function zone_create() {
	70	local zone=${1}
	71	local hook=${2}
	72	shift 2
	73
	74	if ! zone_name_is_valid ${zone}; then
	75	error "Zone name '${zone}' is not valid."
	76	return ${EXIT_ERROR}
	77	fi
	78
	79	if zone_exists ${zone}; then
	80	error "Zone '${zone}' does already exist."
	81	return ${EXIT_ERROR}
	82	fi
	83
	84	if ! hook_exists ${hook}; then
	85	error "Hook '${hook}' does not exist."
	86	return ${EXIT_ERROR}
	87	fi
	88
	89	mkdir -p $(zone_dir ${zone})
	90
	91	hook_exec ${hook} create ${zone} $@
	92	local ret=$?
	93
	94	# Maybe the zone create hook did not exit correctly.
	95	# If this is the case we remove the created zone immediately.
	96	if [ "${ret}" = "${EXIT_ERROR}" ]; then
	97	zone_remove ${zone}
	98	fi
	99	}
	100
	101	function zone_edit() {
	102	local zone=${1}
	103	shift
	104
	105	if ! zone_exists ${zone}; then
	106	error "Zone '${zone}' does not exist."
	107	return ${EXIT_ERROR}
	108	fi
	109
	110	local hook=$(config_get_hook $(zone_dir ${zone})/settings)
	111
	112	if [ -z "${hook}" ]; then
	113	error "Config file did not provide any hook."
	114	return ${EXIT_ERROR}
	115	fi
	116
	117	if ! hook_exists ${hook}; then
	118	error "Hook '${hook}' does not exist."
	119	return ${EXIT_ERROR}
	120	fi
	121
	122	hook_exec ${hook} edit ${zone} $@
	123	}
	124
125	function zone_remove() {
126	local zone=${1}
127	shift
128
129	if ! zone_exists ${zone}; then
130	error "Zone '${zone}' does not exist."
131	return ${EXIT_ERROR}
132	fi
133
134	# XXX Tear this down here?
135
136	rm -rf $(zone_dir ${zone})
137	}
138
139	function zone_up() {
140	local zone=${1}
141	shift
142
143	if ! zone_exists ${zone}; then
144	error "Zone '${zone}' does not exist."
145	return ${EXIT_ERROR}
146	fi
147
148	local hook=$(config_get_hook $(zone_dir ${zone})/settings)
149
150	if [ -z "${hook}" ]; then
151	error "Config file did not provide any hook."
152	return ${EXIT_ERROR}
153	fi
154
155	if ! hook_exists ${hook}; then
156	error "Hook '${hook}' does not exist."
157	return ${EXIT_ERROR}
158	fi
159
059469a8 MT	160	zone_db ${zone} starting
059469a8 MT	161
1848564d	162	hook_exec ${hook} up ${zone} $@
059469a8 MT	163
059469a8 MT	164	zone_db ${zone} started
1848564d MT	165	}
	166
	167	function zone_down() {
	168	local zone=${1}
	169	shift
	170
	171	if ! zone_exists ${zone}; then
	172	error "Zone '${zone}' does not exist."
	173	return ${EXIT_ERROR}
	174	fi
	175
	176	local hook=$(config_get_hook $(zone_dir ${zone})/settings)
	177
	178	if [ -z "${hook}" ]; then
	179	error "Config file did not provide any hook."
	180	return ${EXIT_ERROR}
	181	fi
	182
	183	if ! hook_exists ${hook}; then
	184	error "Hook '${hook}' does not exist."
	185	return ${EXIT_ERROR}
	186	fi
	187
059469a8 MT	188	zone_db ${zone} stopping
059469a8 MT	189
1848564d	190	hook_exec ${hook} down ${zone} $@
059469a8 MT	191
059469a8 MT	192	zone_db ${zone} stopped
1848564d MT	193	}
	194
	195	function zone_status() {
	196	local zone=${1}
	197	shift
	198
	199	if ! zone_exists ${zone}; then
	200	error "Zone '${zone}' does not exist."
	201	return ${EXIT_ERROR}
	202	fi
	203
	204	local hook=$(config_get_hook $(zone_dir ${zone})/settings)
	205
	206	if [ -z "${hook}" ]; then
	207	error "Config file did not provide any hook."
	208	return ${EXIT_ERROR}
	209	fi
	210
	211	if ! hook_exists ${hook}; then
	212	error "Hook '${hook}' does not exist."
	213	return ${EXIT_ERROR}
	214	fi
	215
	216	hook_exec ${hook} status ${zone} $@
	217	}
	218
	219	function zone_port() {
	220	local zone=${1}
	221	shift
	222
	223	if ! zone_exists ${zone}; then
	224	error "Zone '${zone}' does not exist."
	225	return ${EXIT_ERROR}
	226	fi
	227
	228	local hook=$(config_get_hook $(zone_dir ${zone})/settings)
	229
	230	if [ -z "${hook}" ]; then
	231	error "Config file did not provide any hook."
	232	return ${EXIT_ERROR}
	233	fi
	234
	235	if ! hook_exists ${hook}; then
	236	error "Hook '${hook}' does not exist."
	237	return ${EXIT_ERROR}
	238	fi
	239
	240	hook_exec ${hook} port ${zone} $@
	241	}
	242
	243	function zone_config() {
	244	local zone=${1}
	245	shift
	246
	247	if ! zone_exists ${zone}; then
	248	error "Zone '${zone}' does not exist."
	249	return ${EXIT_ERROR}
	250	fi
	251
	252	local hook=$(config_get_hook $(zone_dir ${zone})/settings)
	253
	254	if [ -z "${hook}" ]; then
	255	error "Config file did not provide any hook."
	256	return ${EXIT_ERROR}
257	fi
258
259	if ! hook_exists ${hook}; then
260	error "Hook '${hook}' does not exist."
261	return ${EXIT_ERROR}
262	fi
263
264	hook_exec ${hook} config ${zone} $@
265	}
266
267	function zone_show() {
268	local zone=${1}
269
270	echo "${zone}"
271	echo " Type: $(zone_get_hook ${zone})"
272	echo
273	}
274
275	function zones_show() {
276	local zone
277
278	for zone in $(zones_get $@); do
279	zone_show ${zone}
280	done
281	}
282
283	function zones_get_all() {
284	local zone
285	for zone in ${ZONE_DIR}/*; do
286	zone=$(basename ${zone})
287	zone_exists ${zone} \|\| continue
288
289	echo "${zone}"
290	done \| sort
291	}
292
293	function zones_get_local() {
294	local zone
295	for zone in $(zones_get_all); do
296	zone_is_local ${zone} && echo "${zone}"
297	done
298	}
299
300	function zones_get_nonlocal() {
301	local zone
302	for zone in $(zones_get_all); do
5e42d659	303	zone_is_nonlocal ${zone} && echo "${zone}"
1848564d MT	304	done
	305	}
	306
	307	function zones_get() {
	308	local local=1
	309	local remote=1
	310
	311	local zones
	312
	313	while [ $# -gt 0 ]; do
	314	case "${1}" in
	315	--local-only)
	316	local=1
	317	remote=0
	318	;;
	319	--remote-only)
	320	local=0
	321	remote=1
	322	;;
	323	--all)
	324	local=1
	325	remote=1
	326	;;
	327	*)
	328	if zone_name_is_valid ${1}; then
	329	zones="${zones} ${1}"
	330	else
	331	warning "Unrecognized argument '${1}'"
	332	fi
	333	;;
	334	esac
	335	shift
	336	done
	337
	338	if [ -n "${zones}" ]; then
	339	local zone
	340	for zone in ${zones}; do
	341	zone_exists ${zone} && echo "${zone}"
	342	done
	343	exit ${EXIT_OK}
	344	fi
	345
	346	if [ ${local} -eq 1 ] && [ ${remote} -eq 1 ]; then
	347	zones_get_all
	348	elif [ ${local} -eq 1 ]; then
	349	zones_get_local
	350	elif [ ${remote} -eq 1 ]; then
	351	zones_get_nonlocal
	352	fi
	353	}
	354
	355	function zone_ports_list() {
	356	local zone=${1}
	357
	358	local port
	359	for port in $(zone_dir ${zone})/port.*; do
	360	[ -e "${port}" ] \|\| continue
	361
	362	echo $(basename ${port})
	363	done \| sort
	364	}
	365
	366	function zone_ports_cmd() {
	367	local cmd=${1}
368	local zone=${2}
369	shift 2
370
371	local hook_zone=$(config_get_hook $(zone_dir ${zone})/settings)
372
373	local hook_port
374	local port
375	for port in $(zone_ports_list ${zone}); do
376	hook_port=$(config_get_hook $(zone_dir ${zone})/${port})
377
378	hook_port_exec ${hook_zone} ${hook_port} ${cmd} ${zone} ${port} $@
379	done
380	}
381
382	function zone_ports_up() {
383	zone_ports_cmd up $@
384	}
385
386	function zone_ports_down() {
387	zone_ports_cmd down $@
388	}
389
390	function zone_configs_list() {
391	local zone=${1}
392
393	local config
394	for config in $(zone_dir ${zone})/config.*; do
395	[ -e "${config}" ] \|\| continue
396
397	echo $(basename ${config})
398	done \| sort
399	}
400
401	function zone_configs_cmd() {
402	local cmd=${1}
403	local zone=${2}
404	shift 2
405
406	local hook_zone=$(config_get_hook $(zone_dir ${zone})/settings)
407
408	local hook_config
409	local config
410	for config in $(zone_configs_list ${zone}); do
411	hook_config=$(config_get_hook $(zone_dir ${zone})/${config})
412
413	hook_config_exec ${hook_zone} ${hook_config} ${cmd} ${zone} ${config} $@
414	done
415	}
416
417	function zone_configs_up() {
418	zone_configs_cmd up $@
419	}
420
421	function zone_configs_down() {
422	zone_configs_cmd down $@
423	}
424
425	function zone_has_ipv4() {
426	device_has_ipv4 $@
427	}
428
059469a8 MT	429	function zone_db() {
	430	local zone=${1}
	431	local action=${2}
	432	shift 2
	433
	434	case "${action}" in
	435	starting\|started\|stopping\|stopped)
	436	db_connection_update ${zone} ${action}
	437	;;
	438	esac
	439	}
5e42d659 MT	440
	441	function zone_is_up() {
	442	local zone=${1}
	443
	444	device_is_up ${zone}
	445	}
	446
	447	function zone_is_down() {
	448	! zone_is_up $@
	449	}