]> git.ipfire.org Git - people/stevee/network.git/blobdiff - src/functions/functions.zone
zone: add config hid functions
[people/stevee/network.git] / src / functions / functions.zone
index cad0b790e50f795b82ec6db44299b0db4186cee2..0ee0140cf79af86f6c9d26a20d4ba9e664955b56 100644 (file)
 #                                                                             #
 ###############################################################################
 
-function zone_dir() {
+zone_dir() {
        local zone=${1}
 
        echo "${NETWORK_ZONE_DIR}/zones/${zone}"
 }
 
-function zone_exists() {
+zone_exists() {
        local zone=${1}
        assert isset zone
 
        [ -d "$(zone_dir ${zone})" ]
 }
 
-function zone_match() {
+zone_match() {
        local match
 
        local i
@@ -43,7 +43,7 @@ function zone_match() {
        echo "${match:1:${#match}}"
 }
 
-function zone_name_is_valid() {
+zone_name_is_valid() {
        local zone=${1}
 
        # Don't accept empty strings.
@@ -52,26 +52,26 @@ function zone_name_is_valid() {
        [[ ${zone} =~ $(zone_match) ]]
 }
 
-function zone_is_local() {
+zone_is_local() {
        local zone=${1}
 
        [[ "${zone:0:${#ZONE_LOCAL}}" = "${ZONE_LOCAL}" ]]
 }
 
-function zone_is_nonlocal() {
+zone_is_nonlocal() {
        local zone=${1}
 
        [[ "${zone:0:${#ZONE_NONLOCAL}}" = "${ZONE_NONLOCAL}" ]]
 }
 
-function zone_get_hook() {
+zone_get_hook() {
        local zone=${1}
        assert isset zone
 
        config_get_hook $(zone_dir ${zone})/settings
 }
 
-function zone_start() {
+zone_start() {
        # This function will bring up the zone
        # 'asynchronously' with help of systemd.
 
@@ -81,7 +81,7 @@ function zone_start() {
        service_start "network@${zone}.service"
 }
 
-function zone_start_auto() {
+zone_start_auto() {
        local zone="${1}"
        assert zone_exists "${zone}"
 
@@ -103,7 +103,7 @@ function zone_start_auto() {
        return ${EXIT_OK}
 }
 
-function zone_stop() {
+zone_stop() {
        # This function will bring down the zone
        # 'asynchronously' with help of systemd.
 
@@ -113,14 +113,14 @@ function zone_stop() {
        service_stop "network@${zone}.service"
 }
 
-function zone_reload() {
+zone_reload() {
        local zone="${1}"
        assert zone_exists "${zone}"
 
        service_reload "network@${zone}.service"
 }
 
-function zone_hotplug_event() {
+zone_hotplug_event() {
        local zone="${1}"
        assert isset zone
 
@@ -129,7 +129,7 @@ function zone_hotplug_event() {
        zone_cmd "hotplug" "${zone}"
 }
 
-function zone_enable() {
+zone_enable() {
        # This function will enable the zone
        # with help of systemd.
 
@@ -149,7 +149,7 @@ function zone_enable() {
        return ${ret}
 }
 
-function zone_disable() {
+zone_disable() {
        # This function will disable the zone
        # with help of systemd.
 
@@ -169,7 +169,7 @@ function zone_disable() {
        return ${ret}
 }
 
-function zone_is_enabled() {
+zone_is_enabled() {
        local zone="${1}"
        assert isset zone
 
@@ -181,7 +181,7 @@ function zone_is_enabled() {
        return ${EXIT_FALSE}
 }
 
-function zone_is_active() {
+zone_is_active() {
        local zone="${1}"
        assert isset zone
 
@@ -192,14 +192,14 @@ function zone_is_active() {
        return ${EXIT_FALSE}
 }
 
-function zone_is_enabled_or_active() {
+zone_is_enabled_or_active() {
        local zone="${1}"
        assert isset zone
 
        zone_is_enabled "${zone}" || zone_is_active "${zone}"
 }
 
-function zone_cmd() {
+zone_cmd() {
        local cmd="${1}"
        local port="${2}"
        shift 2
@@ -213,7 +213,7 @@ function zone_cmd() {
        hook_exec zone "${hook}" "${cmd}" "${zone}" $@
 }
 
-function zone_create() {
+zone_new() {
        local zone=${1}
        local hook=${2}
        shift 2
@@ -238,21 +238,24 @@ function zone_create() {
        # Create directories for configs and ports
        mkdir -p $(zone_dir ${zone})/{configs,ports}
 
-       hook_zone_exec ${hook} create ${zone} $@
+       hook_zone_exec "${hook}" "new" "${zone}" $@
        local ret=$?
 
-       # Maybe the zone create hook did not exit correctly.
+       # Maybe the zone new hook did not exit correctly.
        # If this is the case we remove the created zone immediately.
-       if [ "${ret}" = "${EXIT_ERROR}" ]; then
-               zone_remove_now ${zone}
+       if [ "${ret}" != "${EXIT_OK}" ]; then
+               zone_destroy_now "${zone}"
                return ${EXIT_ERROR}
        fi
 
        # Automatically enable zone.
        zone_enable "${zone}"
+
+       # Bring up the zone immediately after
+       zone_start "${zone}"
 }
 
-function zone_edit() {
+zone_edit() {
        local zone=${1}
        shift
 
@@ -262,7 +265,7 @@ function zone_edit() {
        fi
 
        # Check if the zone is tagged for removal.
-       if zone_has_remove_tag ${zone}; then
+       if zone_has_destroy_tag ${zone}; then
                error "You cannot edit a zone that is tagged for removal."
                return ${EXIT_ERROR}
        fi
@@ -281,43 +284,83 @@ function zone_edit() {
        hook_zone_exec ${hook} edit ${zone} $@
 }
 
+zone_rename() {
+       assert [ $# -eq 2 ]
 
-function zone_remove() {
-       local zone=${1}
-       assert zone_exists ${zone}
+       local zone="${1}"
+       local name="${2}"
+
+       assert zone_exists "${zone}"
+       assert not zone_has_destroy_tag "${zone}"
+       assert not zone_exists "${name}"
+
+       # The zone must be shut down before, is then renamed and
+       # potentially brought up again
+
+       # Save if the zone is running right now
+       zone_is_active "${zone}"
+       local zone_was_active="${?}"
+
+       # Save if the zone is enabled (i.e. auto-start)
+       zone_is_enabled "${zone}"
+       local zone_was_enabled="${?}"
+
+       # Stop the zone
+       zone_stop "${zone}"
+
+       # Disable the zone
+       zone_disable "${zone}"
+
+       # Rename the configuration files
+       mv -f "$(zone_dir "${zone}")" "$(zone_dir "${name}")"
+
+       # Enable the zone if it was enabled before
+       [ ${zone_was_enabled} -eq ${EXIT_TRUE} ] && zone_enable "${name}"
+
+       # Start the zone if it was up before
+       [ ${zone_was_active} -eq ${EXIT_TRUE} ] && zone_start "${name}"
+
+       log INFO "Zone ${zone} was renamed to ${name}"
+       return ${EXIT_OK}
+}
+
+
+zone_destroy() {
+       local zone="${1}"
+       assert zone_exists "${zone}"
 
        # Make the zone for removal.
-       touch $(zone_dir ${zone})/.remove
+       touch "$(zone_dir "${zone}")/.destroy"
 
        log INFO "Zone '${zone}' has been tagged for removal."
 }
 
-function zone_has_remove_tag() {
-       local zone=${1}
-       assert zone_exists ${zone}
+zone_has_destroy_tag() {
+       local zone="${1}"
+       assert zone_exists "${zone}"
 
-       [ -e "$(zone_dir ${zone})/.remove" ]
+       [ -e "$(zone_dir "${zone}")/.destroy" ]
 }
 
 # This function will remove the given zone
-# RIGHT NOW. Use zone_remove to remove it
+# RIGHT NOW. Use zone_destroy to remove it
 # at the next status change.
-function zone_remove_now() {
-       local zone=${1}
-       assert zone_exists ${zone}
+zone_destroy_now() {
+       local zone="${1}"
+       assert zone_exists "${zone}"
 
        log INFO "Removing zone '${zone}' right now."
 
        # Force the zone down.
-       zone_is_up ${zone} && zone_set_down ${zone}
+       zone_is_active "${zone}" && zone_stop "${zone}"
 
        # Disable zone.
        zone_disable "${zone}"
 
-       rm -rf $(zone_dir ${zone})
+       rm -rf "$(zone_dir "${zone}")"
 }
 
-function zone_up() {
+zone_up() {
        local zone=${1}
        shift
 
@@ -327,7 +370,7 @@ function zone_up() {
        fi
 
        # Check if a zone has got the remove tag.
-       if zone_has_remove_tag ${zone}; then
+       if zone_has_destroy_tag ${zone}; then
                error "Cannot bring up any zone which is to be removed."
                return ${EXIT_ERROR}
        fi
@@ -348,9 +391,12 @@ function zone_up() {
        hook_zone_exec ${hook} up ${zone} $@
 
        zone_db ${zone} started
+
+       # Execute all triggers after the zone got up
+       triggers_execute_all "up" ZONE="${zone}"
 }
 
-function zone_down() {
+zone_down() {
        local zone=${1}
        shift
 
@@ -376,13 +422,16 @@ function zone_down() {
 
        zone_db ${zone} stopped
 
+       # Execute all triggers after the zone went down
+       triggers_execute_all "down" ZONE="${zone}"
+
        # Remove the zone, if it has got a remove tag.
-       if zone_has_remove_tag ${zone}; then
-               zone_remove_now ${zone}
+       if zone_has_destroy_tag "${zone}"; then
+               zone_destroy_now "${zone}"
        fi
 }
 
-function zone_status() {
+zone_status() {
        local zone="${1}"
        assert isset zone
        shift
@@ -406,111 +455,41 @@ function zone_status() {
        hook_zone_exec "${hook}" "status" "${zone}" "$@"
 
        # Show that the zone it to be removed soon.
-       if zone_has_remove_tag ${zone}; then
+       if zone_has_destroy_tag ${zone}; then
                warning "This zone is tagged for removal."
        fi
 }
 
-function zone_port() {
-       local zone=${1}
-       local action=${2}
-       shift 2
-
-       assert isset zone
-       assert isset action
-       assert zone_exists ${zone}
-
-       case "${action}" in
-               add|edit|remove)
-                       zone_port_${action} ${zone} $@
-                       ;;
-               *)
-                       error "Unrecognized argument: ${action}"
-                       cli_usage root-zone-port-subcommands
-                       exit ${EXIT_ERROR}
-                       ;;              
-       esac
-}
+zone_identify() {
+       assert [ $# -ge 1 ]
 
-function zone_port_add() {
        local zone="${1}"
-       assert isset zone
+       shift
 
-       local port="${2}"
-       assert isset port
+       assert zone_exists "${zone}"
 
-       shift 2
+       log INFO "Identifying zone ${zone}"
+       local pids
 
-       # Check if the port actually exists.
-       if ! port_exists "${port}"; then
-               error "Cannot add port '${port}' which does not exist"
-               return ${EXIT_ERROR}
-       fi
+       local pid
+       local port
+       for port in $(zone_get_ports "${zone}"); do
+               # Identify all the ports
+               port_identify "${port}" --background $@
 
-       # Check if the port is already connected to this or any other zone.
-       local z
-       for z in $(zones_get_all); do
-               if zone_has_port "${z}" "${port}"; then
-                       error "Port '${port}' is already assigned to zone '${z}'"
-                       return ${EXIT_ERROR}
-               fi
+               # Save the PIDs of the subprocesses
+               list_append pids "$(cmd_background_get_pid)"
        done
 
-       local hook=$(zone_get_hook "${zone}")
-       assert isset hook
-
-       hook_zone_exec "${hook}" "port_add" "${zone}" "${port}" "$@"
-}
-
-function zone_port_edit() {
-       local zone="${1}"
-       assert isset zone
-
-       local port="${2}"
-       assert isset port
-
-       shift 2
-
-       # Check if the port actually exists.
-       if ! port_exists "${port}"; then
-               error "Port '${port}' does not exist"
-               return ${EXIT_ERROR}
-       fi
-
-       # Check if the zone actually has this port.
-       if ! zone_has_port "${zone}" "${port}"; then
-               error "Port '${port}' is not attached to zone '${zone}'"
-               return ${EXIT_ERROR}
-       fi
-
-       local hook=$(zone_get_hook "${zone}")
-       assert isset hook
-
-       hook_zone_exec "${hook}" "port_edit" "${zone}" "${port}" "$@"
-}
-
-function zone_port_remove() {
-       local zone="${1}"
-       assert isset zone
-
-       local port="${2}"
-       assert isset port
-
-       shift 2
-
-       # Check if the zone actually has this port.
-       if ! zone_has_port "${zone}" "${port}"; then
-               error "Port '${port}' is not attached to zone '${zone}'"
-               return ${EXIT_ERROR}
-       fi
-
-       local hook=$(zone_get_hook "${zone}")
-       assert isset hook
+       # Wait until all port_identfy processes have finished
+       for pid in ${pids}; do
+               cmd_background_result "${pid}"
+       done
 
-       hook_zone_exec "${hook}" "port_remove" "${zone}" "${port}" "$@"
+       return ${EXIT_OK}
 }
 
-function zone_get_ports() {
+zone_get_ports() {
        local zone=${1}
 
        assert isset zone
@@ -525,7 +504,7 @@ function zone_get_ports() {
        done
 }
 
-function zone_get_ports_num() {
+zone_get_ports_num() {
        local zone="${1}"
        assert isset zone
 
@@ -543,7 +522,7 @@ function zone_get_ports_num() {
        return ${EXIT_OK}
 }
 
-function zone_has_port() {
+zone_has_port() {
        # Check, if the given port is configured
        # in this zone.
 
@@ -557,7 +536,7 @@ function zone_has_port() {
        [ -e "$(zone_dir ${zone})/ports/${port}" ]
 }
 
-function zone_config() {
+zone_config() {
        local zone="${1}"
        local cmd="${2}"
        shift 2
@@ -567,24 +546,38 @@ function zone_config() {
        assert zone_exists "${zone}"
 
        case "${cmd}" in
-               create)
-                       zone_config_create "${zone}" "$@"
+               new)
+                       zone_config_new "${zone}" "$@"
                        ;;
-               edit)
-                       zone_config_edit "${zone}" "$@"
+               destroy)
+                       local id=${1}
+                       if zone_config_id_is_valid ${zone} ${id}; then
+                               zone_config_destroy "${zone}" "$@"
+                       else
+                               log ERROR "${id} is not a valid id"
+                       fi
                        ;;
-               remove)
-                       zone_config_remove "${zone}" "$@"
+               list)
+                       zone_config_list "${zone}" "$@"
                        ;;
                *)
-                       error "Unrecognized argument: ${cmd}"
-                       cli_usage root-zone-config-subcommands
-                       exit ${EXIT_ERROR}
+                       # Check is we get a valid id
+                       # TODO This could be also a valid hid
+                       local id=${cmd}
+
+                       if zone_config_id_is_valid ${zone} ${id} && [[ ${1} == "edit" ]]; then
+                               shift 1
+                               zone_config_edit "${zone}" "${id}" "$@"
+                       else
+                               error "Unrecognized argument: ${cmd}"
+                               cli_usage root-zone-config-subcommands
+                               exit ${EXIT_ERROR}
+                       fi
                        ;;
        esac
 }
 
-function zone_config_cmd() {
+zone_config_cmd() {
        assert [ $# -gt 2 ]
 
        local cmd="${1}"
@@ -597,23 +590,135 @@ function zone_config_cmd() {
        hook_zone_exec "${hook}" "config_${cmd}" "${zone}" "$@"
 }
 
-function zone_config_create() {
-       zone_config_cmd "create" "$@"
+zone_config_new() {
+       local zone="${1}"
+       shift
+
+       # Create a new configuration, but exit when that was
+       # not successful.
+       zone_config_cmd "new" "${zone}" "$@" || return ${?}
+
+       # If the config could be created, we will try to bring
+       # it up if the zone is up, too.
+       if zone_is_up "${zone}"; then
+               zone_configs_up "${zone}"
+       fi
+}
+
+zone_config_destroy() {
+       zone_config_cmd "destroy" "$@"
 }
 
-function zone_config_edit() {
+zone_config_edit() {
        zone_config_cmd "edit" "$@"
 }
 
-function zone_config_remove() {
-       zone_config_cmd "remove" "$@"
+zone_config_list() {
+       # This function list in an nice way all configs of a zone
+       local zone=${1}
+       assert isset zone
+
+       # Print a nice header
+       local format="%-3s %-20s"
+       print "${format}" "ID" "HOOK"
+
+       local config
+       local hook
+       local id
+
+       # Print for all config:
+       # id and hook
+       # TODO: Add hids here
+       for config in $(zone_configs_list "${zone}"); do
+               id=${config##*.}
+               hook=$(zone_config_get_hook "${zone}" "${config}")
+               assert isset hook
+               print "${format}" "${id}" "${hook}"
+       done
 }
 
-function zone_config_show() {
+zone_config_show() {
        zone_config_cmd "show" "$@"
 }
 
-function zone_show() {
+# Returns a list of all used ids for a zone
+zone_config_list_ids() {
+       assert [ $# -eq 1 ]
+
+       local zone=${1}
+       local config
+       local ids
+
+       for config in $(zone_configs_list ${zone}); do
+               list_append ids "$(config_get_id_from_config ${config})"
+       done
+
+       echo ${ids}
+}
+
+# List all hids of a zone
+zone_config_list_hids() {
+       assert [ $# -eq 1 ]
+
+       local zone=${1}
+
+       local config
+       for config in $(zone_configs_list ${zone}); do
+               zone_config_get_hid "${zone}" "${config}"
+       done
+}
+
+# get the hid from a given config
+zone_config_get_hid() {
+       assert [ $# -eq 2 ]
+
+       local zone=${1}
+       local config=${2}
+
+       local hook="$(zone_config_get_hook "${zone}" "${config}")"
+
+       hook_exec "config" "${hook}" "hid" "${zone}" "${config}"
+}
+
+# Checks if a hid is valid for a given zone
+zone_config_hid_is_valid() {
+       assert [ $# -eq 2]
+
+       local zone=${1}
+       local hid=${2}
+
+       local _hid
+       for _hid in $(zone_config_list_hids "${zone}"); do
+               if [[ ${_hid} = ${hid} ]]; then
+                       return ${EXIT_TRUE}
+               fi
+       done
+
+       return ${EXIT_FALSE}
+}
+
+# This function converts a hid to a id
+zone_config_convert_hid_to_id() {
+       assert [ $# -eq 2 ]
+
+       local zone=${1}
+       local hid=${2}
+
+       local config
+       for config in $(zone_configs_list ${zone}); do
+               # Get hook from config
+               local hook="$(zone_config_get_hook "${zone}" "${config}")"
+
+               if [[ "$(hook_exec "config" "${hook}" "hid" "${zone}" "${config}")" == "${hid}" ]]; then
+                       config_get_id_from_config "${config}"
+                       return ${EXIT_TRUE}
+               fi
+       done
+
+       return ${EXIT_FALSE}
+}
+
+zone_show() {
        local zone=${1}
 
        echo "${zone}"
@@ -621,7 +726,7 @@ function zone_show() {
        echo
 }
 
-function zones_show() {
+zones_show() {
        local zone
 
        for zone in $(zones_get $@); do
@@ -629,7 +734,7 @@ function zones_show() {
        done
 }
 
-function zones_get_all() {
+zones_get_all() {
        local zone
        for zone in $(zone_dir)/*; do
                zone=$(basename ${zone})
@@ -639,21 +744,41 @@ function zones_get_all() {
        done
 }
 
-function zones_get_local() {
+zones_get_next_free() {
+       # This function return the next free zones.
+       # Example net0 upl0 upl1 are configured so the next free zones are:
+       # net1 upl2
+       local i
+       local zone_name
+       for zone_name in ${VALID_ZONES}; do
+               i=0
+
+               while true; do
+                       local zone="${zone_name}${i}"
+                       if ! zone_exists ${zone}; then
+                               echo "${zone}"
+                               break
+                       fi
+                       i=$(( i + 1 ))
+               done
+       done
+}
+
+zones_get_local() {
        local zone
        for zone in $(zones_get_all); do
                zone_is_local ${zone} && echo "${zone}"
        done
 }
 
-function zones_get_nonlocal() {
+zones_get_nonlocal() {
        local zone
        for zone in $(zones_get_all); do
                zone_is_nonlocal ${zone} && echo "${zone}"
        done
 }
 
-function zones_get() {
+zones_get() {
        local local=1
        local remote=1
 
@@ -701,7 +826,7 @@ function zones_get() {
        fi
 }
 
-function zone_ports_list() {
+zone_ports_list() {
        local zone=${1}
 
        local port
@@ -712,37 +837,236 @@ function zone_ports_list() {
        done
 }
 
-function zone_ports_cmd() {
-       local cmd=${1}
-       local zone=${2}
+zone_port_attach() {
+       local zone="${1}"
+       assert isset zone
+
+       local port="${2}"
+       assert isset port
+
        shift 2
 
+       # Check if the port actually exists.
+       if ! port_exists "${port}"; then
+               error "Cannot attach port '${port}' which does not exist"
+               return ${EXIT_ERROR}
+       fi
+
+       # Check if the port is already connected to this or any other zone.
+       local z
+       for z in $(zones_get_all); do
+               if zone_has_port "${z}" "${port}"; then
+                       error "Port '${port}' is already attached to zone '${z}'"
+                       return ${EXIT_ERROR}
+               fi
+       done
+
+       local hook="$(zone_get_hook "${zone}")"
+       assert isset hook
+
+       # Make the port briefly flash if supported
+       if device_exists ${port}; then
+               port_identify "${port}" --background
+       fi
+
+       hook_zone_exec "${hook}" "port_attach" "${zone}" "${port}" "$@"
+       local ret="${?}"
+
+       case "${ret}" in
+               ${EXIT_OK})
+                       log INFO "${port} has been attached to ${zone}"
+
+                       # Automatically connect the port
+                       zone_port_start "${zone}" "${port}"
+                       ;;
+               *)
+                       log CRITICAL "${port} could not be attached to ${zone}"
+                       ;;
+       esac
+
+       return ${ret}
+}
+
+zone_port_edit() {
+       local zone="${1}"
+       assert isset zone
+
+       local port="${2}"
+       assert isset port
+
+       shift 2
+
+       # Check if the port actually exists.
+       if ! port_exists "${port}"; then
+               error "Port '${port}' does not exist"
+               return ${EXIT_ERROR}
+       fi
+
+       # Check if the zone actually has this port.
+       if ! zone_has_port "${zone}" "${port}"; then
+               error "Port '${port}' is not attached to zone '${zone}'"
+               return ${EXIT_ERROR}
+       fi
+
+       local hook=$(zone_get_hook "${zone}")
+       assert isset hook
+
+       hook_zone_exec "${hook}" "port_edit" "${zone}" "${port}" "$@"
+}
+
+zone_port_detach() {
+       local zone="${1}"
+       assert isset zone
+
+       local port="${2}"
+       assert isset port
+
+       shift 2
+
+       # Check if the zone actually has this port.
+       if ! zone_has_port "${zone}" "${port}"; then
+               error "Port '${port}' is not attached to zone '${zone}'"
+               return ${EXIT_ERROR}
+       fi
+
+       local hook=$(zone_get_hook "${zone}")
+       assert isset hook
+
+       # Make the port briefly flash if supported
+       port_identify "${port}" --background
+
+       hook_zone_exec "${hook}" "port_detach" "${zone}" "${port}" "$@"
+       local ret="${?}"
+
+       case "${ret}" in
+               ${EXIT_OK})
+                       log INFO "${port} has been detached from ${zone}"
+
+                       # Bring down the port if needed
+                       zone_port_stop "${zone}" "${port}"
+                       ;;
+               *)
+                       log CRITICAL "${port} could not be detached from ${zone}"
+                       ;;
+       esac
+
+       return ${ret}
+}
+
+zone_port_cmd() {
+       local cmd="${1}"
        assert isset cmd
+
+       local zone="${2}"
        assert isset zone
 
-       assert zone_exists ${zone}
+       local port="${3}"
+       assert isset port
 
-       local hook=$(zone_get_hook ${zone})
+       shift 3
+
+       local hook="$(zone_get_hook "${zone}")"
+       assert isset hook
+
+       # Dispatch command to hook
+       hook_zone_exec "${hook}" "${cmd}" "${zone}" "${port}" $@
+}
+
+zone_port_create() {
+       zone_port_cmd "port_create" $@
+}
+
+zone_port_remove() {
+       zone_port_cmd "port_remove" $@
+}
+
+zone_port_up() {
+       zone_port_cmd "port_up" $@
+}
+
+zone_port_down() {
+       zone_port_cmd "port_down" $@
+}
+
+# The next two functions automagically bring up and down
+# port that are attached to a bridge or similar.
+# The problem that is tried to overcome here is that there
+# are ports which exist all the time (like ethernet ports)
+# and therefore do not dispatch a hotplug event when
+# port_create is called.
+
+zone_port_start() {
+       local zone="${1}"
+       local port="${2}"
+
+       if zone_is_active "${zone}"; then
+               if device_exists "${port}"; then
+                       zone_port_up "${zone}" "${port}"
+                       return ${?}
+               else
+                       zone_port_create "${zone}" "${port}"
+                       return ${?}
+               fi
+       fi
+
+       return ${EXIT_OK}
+}
+
+zone_port_stop() {
+       local zone="${1}"
+       local port="${2}"
+
+       # Shut down the port if necessary
+       if zone_is_active "${zone}" && port_is_up "${port}"; then
+               zone_port_down "${zone}" "${port}"
+       fi
+
+       # Remove the port
+       zone_port_remove "${zone}" "${port}"
+}
+
+zone_port_status() {
+       zone_port_cmd "port_status" $@
+}
+
+zone_ports_cmd() {
+       local cmd="${1}"
+       assert isset cmd
+
+       local zone="${2}"
+       assert isset zone
+
+       shift 2
+
+       local hook="$(zone_get_hook "${zone}")"
 
        local port
        for port in $(zone_get_ports ${zone}); do
-               hook_zone_exec ${hook} ${cmd} ${zone} ${port} $@
+               hook_zone_exec "${hook}" "${cmd}" "${zone}" "${port}" $@
        done
 }
 
-function zone_ports_up() {
-       zone_ports_cmd port_up $@
+zone_ports_create() {
+       zone_ports_cmd "port_create" $@
+}
+
+zone_ports_remove() {
+       zone_ports_cmd "port_remove" $@
 }
 
-function zone_ports_down() {
-       zone_ports_cmd port_down $@
+zone_ports_up() {
+       zone_ports_cmd "port_up" $@
 }
 
-function zone_ports_status() {
-       zone_ports_cmd port_status $@
+zone_ports_down() {
+       zone_ports_cmd "port_down" $@
 }
 
-function zone_configs_cmd() {
+zone_ports_status() {
+       zone_ports_cmd "port_status" $@
+}
+
+zone_configs_cmd() {
        assert [ $# -ge 2 ]
 
        local cmd="${1}"
@@ -760,19 +1084,19 @@ function zone_configs_cmd() {
        done
 }
 
-function zone_configs_up() {
+zone_configs_up() {
        zone_configs_cmd "up" $@
 }
 
-function zone_configs_down() {
+zone_configs_down() {
        zone_configs_cmd "down" $@
 }
 
-function zone_configs_status() {
+zone_configs_status() {
        zone_configs_cmd "status" $@
 }
 
-function zone_configs_list() {
+zone_configs_list() {
        local zone=${1}
 
        local config
@@ -783,7 +1107,25 @@ function zone_configs_list() {
        done
 }
 
-function zone_config_get_hook() {
+zone_config_get_new_id() {
+       # This functions returns the next free id for a zone
+
+       assert [ $# -eq 1 ]
+       local zone=${1}
+
+       local zone_path=$(zone_dir ${zone})
+       local i=0
+
+       while true; do
+               if [ ! -f ${zone_path}/configs/*.${i} ]; then
+                       echo "${i}"
+                       return ${EXIT_OK}
+               fi
+               (( i++ ))
+       done
+}
+
+zone_config_get_hook() {
        assert [ $# -eq 2 ]
 
        local zone="${1}"
@@ -799,11 +1141,83 @@ function zone_config_get_hook() {
        print "${HOOK}"
 }
 
-function zone_has_ip() {
+zone_config_hook_is_configured() {
+       # Checks if a zone has already at least one config with the given hook.
+       # Returns True when yes and False when no
+
+       assert [ $# -eq 2 ]
+       local zone=${1}
+       local hook=${2}
+
+       local config
+       for config in $(zone_configs_list "${zone}"); do
+               local config_hook="$(zone_config_get_hook "${zone}" "${config}")"
+               assert isset config_hook
+               if [[ ${hook} == ${config_hook} ]]; then
+                       return ${EXIT_TRUE}
+               fi
+
+       done
+
+       # If we get here the zone has no config with the given hook
+       return ${EXIT_FALSE}
+}
+
+zone_config_id_is_valid() {
+       # This function checks if a given id is valid for a zone
+       # Return True when yes and false when no
+
+       assert [ $# -eq 2 ]
+       local zone=${1}
+       local id=${2}
+
+       local zone_path=$(zone_dir ${zone})
+
+       [ -f ${zone_path}/configs/*.${id} ];
+}
+
+# This function checks if a given hid is valid for a zone
+# Return True when yes and false when no
+zone_config_hid_is_valid() {
+       assert [ $# -eq 2 ]
+       local zone=${1}
+       local hid=${2}
+
+       local _hid
+       for _hid in $(zone_config_list_hids ${zone}); do
+               if [[ ${_hid} == ${hid} ]]; then
+                       return ${EXIT_TRUE}
+               fi
+       done
+
+       return ${EXIT_FALSE}
+}
+
+zone_config_get_hook_from_id() {
+       # Returns the hook for a given id
+       assert [ $# -eq 2 ]
+       local zone=${1}
+       local id=${2}
+
+       local config
+       for config in $(zone_configs_list "${zone}"); do
+               if [[ ${config} == *.${id} ]]; then
+                       local config_hook="$(zone_config_get_hook "${zone}" "${config}")"
+                       assert isset config_hook
+                       print "${config_hook}"
+                       return "${EXIT_OK}"
+               fi
+       done
+
+       # If we get here the zone has no config with the given id
+       return ${EXIT_ERROR}
+}
+
+zone_has_ip() {
        device_has_ip $@
 }
 
-function zone_db() {
+zone_db() {
        local zone=${1}
        local action=${2}
        shift 2
@@ -815,17 +1229,17 @@ function zone_db() {
        esac
 }
 
-function zone_is_up() {
+zone_is_up() {
        local zone=${1}
 
        device_is_up ${zone}
 }
 
-function zone_is_down() {
+zone_is_down() {
        ! zone_is_up $@
 }
 
-function zone_get_supported_port_hooks() {
+zone_get_supported_port_hooks() {
        local zone=${1}
 
        local hook=$(zone_get_hook ${zone})
@@ -833,11 +1247,11 @@ function zone_get_supported_port_hooks() {
        hook_zone_ports_get_all ${hook}
 }
 
-function zone_get_supported_config_hooks() {
+zone_get_supported_config_hooks() {
        hook_config_get_all
 }
 
-function zone_file() {
+zone_file() {
        local zone=${1}
 
        assert isset zone
@@ -845,29 +1259,41 @@ function zone_file() {
        echo "$(zone_dir ${zone})/settings"
 }
 
-function zone_settings_read() {
+zone_settings_read() {
        local zone=${1}
-
        assert isset zone
+       shift
+
+       local args
+       if [ $# -eq 0 ] && [ -n "${HOOK_SETTINGS}" ]; then
+               list_append args ${HOOK_SETTINGS}
+       else
+               list_append args $@
+       fi
 
        # Save the HOOK variable.
        local hook="${HOOK}"
 
-       settings_read $(zone_file ${zone})
+       settings_read "$(zone_file "${zone}")" ${args}
 
        # Restore hook.
        HOOK="${hook}"
 }
 
-function zone_settings_write() {
-       local zone=${1}
-
+zone_settings_write() {
+       local zone="${1}"
        assert isset zone
 
-       settings_write $(zone_file ${zone}) ${HOOK_SETTINGS}
+       local args
+       if function_exists "hook_check_settings"; then
+               list_append args "--check=\"hook_check_settings\""
+       fi
+       list_append args ${HOOK_SETTINGS}
+
+       settings_write "$(zone_file ${zone})" ${args}
 }
 
-function zone_settings_set() {
+zone_settings_set() {
        local zone=${1}
        shift
        local args="$@"
@@ -885,7 +1311,7 @@ function zone_settings_set() {
        )
 }
 
-function zone_settings_get() {
+zone_settings_get() {
        local zone=${1}
        local key=${2}
 
@@ -893,57 +1319,107 @@ function zone_settings_get() {
        assert isset key
 
        (
-               zone_settings_read ${zone}
+               zone_settings_read "${zone}" "${key}" \
+                       --ignore-superfluous-settings
 
                echo "${!key}"
        )
 }
 
-function zone_config_settings_read() {
-       assert [ $# -gt 2 ]
+zone_config_settings_read() {
+       assert [ $# -ge 2 ]
 
        local zone="${1}"
        local config="${2}"
        shift 2
 
+       local args
+       if [ $# -eq 0 ] && [ -n "${HOOK_CONFIG_SETTINGS}" ]; then
+               list_append args ${HOOK_CONFIG_SETTINGS}
+       else
+               list_append args $@
+       fi
+
        local path="$(zone_dir "${zone}")/configs/${config}"
-       settings_read "${path}" "$@"
+       settings_read "${path}" ${args}
 }
 
-function zone_config_settings_write() {
-       assert [ $# -gt 2 ]
+zone_config_settings_write() {
+       assert [ $# -ge 2 ]
 
+       local zone="${1}"
+       local hook="${2}"
+       local id=${3}
+
+       if ! isset id; then
+               id=$(zone_config_get_new_id ${zone})
+               log DEBUG "ID for the config is: ${id}"
+       fi
+
+       local args
+       if function_exists "hook_check_config_settings"; then
+               list_append args "--check=\"hook_check_config_settings\""
+       fi
+       list_append args ${HOOK_CONFIG_SETTINGS}
+
+       local path="$(zone_dir "${zone}")/configs/${hook}.${id}"
+       settings_write "${path}" ${args}
+}
+
+zone_config_settings_destroy() {
+       # This function deletes the config file for a given zone and config
+       assert [ $# -ge 2 ]
        local zone="${1}"
        local config="${2}"
-       shift 2
 
        local path="$(zone_dir "${zone}")/configs/${config}"
-       settings_write "${path}" "$@"
-}
 
-function zone_port_settings_read() {
-       assert [ $# -gt 2 ]
+       # Check if path is valid
+       if [ ! -f ${path} ]; then
+               log ERROR "Path: '${path}' is not valid"
+               return ${EXIT_ERROR}
+       fi
+
+       log DEBUG "Deleting config file ${path}"
+       rm -f "${path}"
+
+}
+zone_port_settings_read() {
+       assert [ $# -ge 2 ]
 
        local zone="${1}"
        local port="${2}"
        shift 2
 
+       local args
+       if [ $# -eq 0 ] && [ -n "${HOOK_PORT_SETTINGS}" ]; then
+               list_append args ${HOOK_PORT_SETTINGS}
+       else
+               list_append args $@
+       fi
+
        local path="$(zone_dir "${zone}")/ports/${port}"
-       settings_read "${path}" "$@"
+       settings_read "${path}" ${args}
 }
 
-function zone_port_settings_write() {
-       assert [ $# -gt 2 ]
+zone_port_settings_write() {
+       assert [ $# -ge 2 ]
 
        local zone="${1}"
        local port="${2}"
        shift 2
 
+       local args
+       if function_exists "hook_check_port_settings"; then
+               list_append args "--check=\"hook_check_port_settings\""
+       fi
+       list_append args ${HOOK_PORT_SETTINGS}
+
        local path="$(zone_dir "${zone}")/ports/${port}"
-       settings_write "${path}" "$@"
+       settings_write "${path}" ${args}
 }
 
-function zone_port_settings_remove() {
+zone_port_settings_remove() {
        assert [ $# -eq 2 ]
 
        local zone="${1}"
@@ -952,3 +1428,18 @@ function zone_port_settings_remove() {
        local path="$(zone_dir "${zone}")/ports/${port}"
        settings_remove "${path}"
 }
+
+zone_get_color() {
+       # This function return the color of a zone
+       assert [ $# -eq 1 ]
+
+       local name=${1}
+       color_read "zone" ${name}
+}
+
+zone_get_description_title() {
+       assert [ $# -eq 1 ]
+
+       local name=${1}
+       description_title_read $(description_format_filename "zone" "${name}")
+}