]> git.ipfire.org Git - people/stevee/network.git/blobdiff - functions.zone
headers: Add missing function and rename existing ones.
[people/stevee/network.git] / functions.zone
index 9fc343b01b4efdbee4a1ec7fdf6b6a74202cb7b4..3a5c60fb75e59282f3195bcae646c2a78672e280 100644 (file)
 function zone_dir() {
        local zone=${1}
 
-       echo "${ZONE_DIR}/${zone}"
+       echo "${NETWORK_ZONE_DIR}/zones/${zone}"
 }
 
 function zone_exists() {
        local zone=${1}
+       assert isset zone
 
        [ -d "$(zone_dir ${zone})" ]
 }
@@ -45,27 +46,51 @@ function zone_match() {
 function zone_name_is_valid() {
        local zone=${1}
 
+       # Don't accept empty strings.
+       [ -z "${zone}" ] && return ${EXIT_FALSE}
+
        [[ ${zone} =~ $(zone_match) ]]
 }
 
 function zone_is_local() {
        local zone=${1}
 
-       ! zone_is_nonlocal ${zone}
+       [[ "${zone:0:${#ZONE_LOCAL}}" = "${ZONE_LOCAL}" ]]
 }
 
 function zone_is_nonlocal() {
        local zone=${1}
 
-       [[ ${zone} =~ ^red[0-9]{1,5} ]]
+       [[ "${zone:0:${#ZONE_NONLOCAL}}" = "${ZONE_NONLOCAL}" ]]
 }
 
 function zone_get_hook() {
        local zone=${1}
+       assert isset zone
 
        config_get_hook $(zone_dir ${zone})/settings
 }
 
+function zone_start() {
+       # This function will bring up the zone
+       # 'asynchronously' with help of systemd.
+
+       local zone=${1}
+       assert zone_exists ${zone}
+
+       service_start "network@${zone}.service"
+}
+
+function zone_stop() {
+       # This function will bring down the zone
+       # 'asynchronously' with help of systemd.
+
+       local zone=${1}
+       assert zone_exists ${zone}
+
+       service_stop "network@${zone}.service"
+}
+
 function zone_create() {
        local zone=${1}
        local hook=${2}
@@ -81,20 +106,23 @@ function zone_create() {
                return ${EXIT_ERROR}
        fi
 
-       if ! hook_exists ${hook}; then
+       if ! hook_zone_exists ${hook}; then
                error "Hook '${hook}' does not exist."
                return ${EXIT_ERROR}
        fi
 
        mkdir -p $(zone_dir ${zone})
 
-       hook_exec ${hook} create ${zone} $@
+       # Create directories for configs and ports
+       mkdir -p $(zone_dir ${zone})/{configs,ports}
+
+       hook_zone_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}
+               zone_remove_now ${zone}
        fi
 }
 
@@ -107,6 +135,12 @@ function zone_edit() {
                return ${EXIT_ERROR}
        fi
 
+       # Check if the zone is tagged for removal.
+       if zone_has_remove_tag ${zone}; then
+               error "You cannot edit a zone that is tagged for removal."
+               return ${EXIT_ERROR}
+       fi
+
        local hook=$(config_get_hook $(zone_dir ${zone})/settings)
 
        if [ -z "${hook}" ]; then
@@ -114,24 +148,43 @@ function zone_edit() {
                return ${EXIT_ERROR}
        fi
 
-       if ! hook_exists ${hook}; then
+       if ! hook_zone_exists ${hook}; then
                error "Hook '${hook}' does not exist."
                return ${EXIT_ERROR}
        fi
 
-       hook_exec ${hook} edit ${zone} $@
+       hook_zone_exec ${hook} edit ${zone} $@
 }
 
+
 function zone_remove() {
        local zone=${1}
-       shift
+       assert zone_exists ${zone}
 
-       if ! zone_exists ${zone}; then
-               error "Zone '${zone}' does not exist."
-               return ${EXIT_ERROR}
-       fi
+       # Make the zone for removal.
+       touch $(zone_dir ${zone})/.remove
 
-       # XXX Tear this down here?
+       log INFO "Zone '${zone}' has been tagged for removal."
+}
+
+function zone_has_remove_tag() {
+       local zone=${1}
+       assert zone_exists ${zone}
+
+       [ -e "$(zone_dir ${zone})/.remove" ]
+}
+
+# This function will remove the given zone
+# RIGHT NOW. Use zone_remove to remove it
+# at the next status change.
+function zone_remove_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}
 
        rm -rf $(zone_dir ${zone})
 }
@@ -145,6 +198,12 @@ function zone_up() {
                return ${EXIT_ERROR}
        fi
 
+       # Check if a zone has got the remove tag.
+       if zone_has_remove_tag ${zone}; then
+               error "Cannot bring up any zone which is to be removed."
+               return ${EXIT_ERROR}
+       fi
+
        local hook=$(config_get_hook $(zone_dir ${zone})/settings)
 
        if [ -z "${hook}" ]; then
@@ -152,15 +211,15 @@ function zone_up() {
                return ${EXIT_ERROR}
        fi
 
-       if ! hook_exists ${hook}; then
+       if ! hook_zone_exists ${hook}; then
                error "Hook '${hook}' does not exist."
                return ${EXIT_ERROR}
        fi
 
        zone_db ${zone} starting
 
-       hook_exec ${hook} up ${zone} $@
-       
+       hook_zone_exec ${hook} up ${zone} $@
+
        zone_db ${zone} started
 }
 
@@ -180,16 +239,21 @@ function zone_down() {
                return ${EXIT_ERROR}
        fi
 
-       if ! hook_exists ${hook}; then
+       if ! hook_zone_exists ${hook}; then
                error "Hook '${hook}' does not exist."
                return ${EXIT_ERROR}
        fi
 
        zone_db ${zone} stopping
 
-       hook_exec ${hook} down ${zone} $@
+       hook_zone_exec ${hook} down ${zone} $@
 
        zone_db ${zone} stopped
+
+       # Remove the zone, if it has got a remove tag.
+       if zone_has_remove_tag ${zone}; then
+               zone_remove_now ${zone}
+       fi
 }
 
 function zone_status() {
@@ -208,38 +272,124 @@ function zone_status() {
                return ${EXIT_ERROR}
        fi
 
-       if ! hook_exists ${hook}; then
+       if ! hook_zone_exists ${hook}; then
                error "Hook '${hook}' does not exist."
                return ${EXIT_ERROR}
        fi
 
-       hook_exec ${hook} status ${zone} $@
+       hook_zone_exec ${hook} status ${zone} $@
+
+       # Show that the zone it to be removed soon.
+       if zone_has_remove_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}
+
+       # Aliases
+       case "${action}" in
+               del|delete|remove)
+                       action="rem"
+                       ;;
+       esac
+
+       case "${action}" in
+               add|edit|rem)
+                       zone_port_${action} ${zone} $@
+                       ;;
+               *)
+                       error "Unrecognized argument: ${action}"
+                       cli_usage root-zone-port-subcommands
+                       exit ${EXIT_ERROR}
+                       ;;              
+       esac
+}
+
+function zone_port_add() {
        local zone=${1}
        shift
 
-       if ! zone_exists ${zone}; then
-               error "Zone '${zone}' does not exist."
-               return ${EXIT_ERROR}
-       fi
+       assert isset zone
 
-       local hook=$(config_get_hook $(zone_dir ${zone})/settings)
+       local hook=$(zone_get_hook ${zone})
 
-       if [ -z "${hook}" ]; then
-               error "Config file did not provide any hook."
-               return ${EXIT_ERROR}
-       fi
+       assert isset hook
 
-       if ! hook_exists ${hook}; then
-               error "Hook '${hook}' does not exist."
-               return ${EXIT_ERROR}
-       fi
+       hook_zone_exec ${hook} port_add ${zone} $@
+}
+
+function zone_port_edit() {
+       zone_port_cmd edit $@
+}
+
+function zone_port_rem() {
+       zone_port_cmd rem $@
+}
+
+function zone_port_cmd() {
+       local cmd=${1}
+       local zone=${2}
+       local port=${3}
+       shift 3
+
+       assert isset zone
+       assert isset port
+
+       local hook_zone=$(zone_get_hook ${zone})
+       local hook_port=$(port_get_hook ${port})
+
+       assert isset hook_zone
+       assert isset hook_port
+
+       hook_zone_port_exec ${hook_zone} ${hook_port} ${cmd} ${zone} ${port} $@
+}
 
-       hook_exec ${hook} port ${zone} $@
+function zone_port_up() {
+       zone_port_cmd up $@
 }
 
+function zone_port_down() {
+       zone_port_cmd down $@
+}
+
+function zone_get_ports() {
+       local zone=${1}
+
+       assert isset zone
+
+       local port
+       for port in $(zone_dir ${zone})/ports/*; do
+               port=$(basename ${port})
+
+               if port_exists ${port}; then
+                       echo "${port}"
+               fi
+       done
+}
+
+function zone_has_port() {
+       # Check, if the given port is configured
+       # in this zone.
+
+       local zone=${1}
+       local port=${2}
+       shift 2
+
+       assert isset zone
+       assert isset port
+
+       [ -e "$(zone_dir ${zone})/ports/${port}" ]
+}
+
+# XXX overwritten some lines below
 function zone_config() {
        local zone=${1}
        shift
@@ -256,12 +406,71 @@ function zone_config() {
                return ${EXIT_ERROR}
        fi
 
-       if ! hook_exists ${hook}; then
+       if ! hook_zone_exists ${hook}; then
                error "Hook '${hook}' does not exist."
                return ${EXIT_ERROR}
        fi
 
-       hook_exec ${hook} config ${zone} $@
+       hook_zone_exec ${hook} config ${zone} $@
+}
+
+function zone_config() {
+       local zone=${1}
+       local action=${2}
+       shift 2
+
+       assert isset zone
+       assert isset action
+       assert zone_exists ${zone}
+
+       # Aliases
+       case "${action}" in
+               del|delete|remove)
+                       action="rem"
+                       ;;
+       esac
+
+       case "${action}" in
+               create|edit|rem)
+                       zone_config_${action} ${zone} $@
+                       ;;
+               *)
+                       error "Unrecognized argument: ${action}"
+                       cli_usage root-zone-config-subcommands
+                       exit ${EXIT_ERROR}
+                       ;;
+       esac
+}
+
+function zone_config_option() {
+       local zone=${1}
+       local option=${2}
+       local default=${3}
+       shift 2
+
+       assert isset zone
+       assert isset option
+
+       (
+               VALUE="${default}"
+               zone_config_read ${zone}
+
+               VALUE="${!option}"
+               echo "${VALUE}"
+       )
+}
+
+function zone_config_create() {
+       local zone=${1}
+       shift
+
+       assert isset zone
+
+       local hook=$(zone_get_hook ${zone})
+
+       assert isset hook
+
+       hook_zone_exec ${hook} config_create ${zone} $@
 }
 
 function zone_show() {
@@ -282,12 +491,12 @@ function zones_show() {
 
 function zones_get_all() {
        local zone
-       for zone in ${ZONE_DIR}/*; do
+       for zone in $(zone_dir)/*; do
                zone=$(basename ${zone})
                zone_exists ${zone} || continue
 
                echo "${zone}"
-       done | sort
+       done
 }
 
 function zones_get_local() {
@@ -356,11 +565,11 @@ function zone_ports_list() {
        local zone=${1}
 
        local port
-       for port in $(zone_dir ${zone})/port.*; do
+       for port in $(zone_dir ${zone})/ports/*; do
                [ -e "${port}" ] || continue
 
                echo $(basename ${port})
-       done | sort
+       done
 }
 
 function zone_ports_cmd() {
@@ -368,34 +577,40 @@ function zone_ports_cmd() {
        local zone=${2}
        shift 2
 
-       local hook_zone=$(config_get_hook $(zone_dir ${zone})/settings)
+       assert isset cmd
+       assert isset zone
 
-       local hook_port
-       local port
-       for port in $(zone_ports_list ${zone}); do
-               hook_port=$(config_get_hook $(zone_dir ${zone})/${port})
+       assert zone_exists ${zone}
+
+       local hook=$(zone_get_hook ${zone})
 
-               hook_port_exec ${hook_zone} ${hook_port} ${cmd} ${zone} ${port} $@
+       local port
+       for port in $(zone_get_ports ${zone}); do
+               hook_zone_exec ${hook} ${cmd} ${zone} ${port} $@
        done
 }
 
 function zone_ports_up() {
-       zone_ports_cmd up $@
+       zone_ports_cmd port_up $@
 }
 
 function zone_ports_down() {
-       zone_ports_cmd down $@
+       zone_ports_cmd port_down $@
+}
+
+function zone_ports_status() {
+       zone_ports_cmd port_status $@
 }
 
 function zone_configs_list() {
        local zone=${1}
 
        local config
-       for config in $(zone_dir ${zone})/config.*; do
+       for config in $(zone_dir ${zone})/configs/*; do
                [ -e "${config}" ] || continue
 
-               echo $(basename ${config})
-       done | sort
+               basename ${config}
+       done
 }
 
 function zone_configs_cmd() {
@@ -408,9 +623,9 @@ function zone_configs_cmd() {
        local hook_config
        local config
        for config in $(zone_configs_list ${zone}); do
-               hook_config=$(config_get_hook $(zone_dir ${zone})/${config})
+               hook_config=$(config_get_hook $(zone_dir ${zone})/configs/${config})
 
-               hook_config_exec ${hook_zone} ${hook_config} ${cmd} ${zone} ${config} $@
+               hook_zone_config_exec ${hook_zone} ${hook_config} ${cmd} ${zone} ${config} $@
        done
 }
 
@@ -422,12 +637,12 @@ function zone_configs_down() {
        zone_configs_cmd down $@
 }
 
-function zone_has_ipv4() {
-       device_has_ipv4 $@
+function zone_configs_status() {
+       zone_configs_cmd config_status $@
 }
 
-function zone_has_ipv6() {
-       device_has_ipv6 $@
+function zone_has_ip() {
+       device_has_ip $@
 }
 
 function zone_db() {
@@ -451,3 +666,81 @@ function zone_is_up() {
 function zone_is_down() {
        ! zone_is_up $@
 }
+
+function zone_get_supported_port_hooks() {
+       local zone=${1}
+
+       local hook=$(zone_get_hook ${zone})
+
+       hook_zone_ports_get_all ${hook}
+}
+
+function zone_get_supported_config_hooks() {
+       local zone=${1}
+
+       local hook=$(zone_get_hook ${zone})
+
+       hook_zone_configs_get_all ${hook}
+}
+
+function zone_file() {
+       local zone=${1}
+
+       assert isset zone
+
+       echo "$(zone_dir ${zone})/settings"
+}
+
+function zone_config_read() {
+       local zone=${1}
+
+       assert isset zone
+
+       # Save the HOOK variable.
+       local hook="${HOOK}"
+
+       config_read $(zone_file ${zone})
+
+       # Restore hook.
+       HOOK="${hook}"
+}
+
+function zone_config_write() {
+       local zone=${1}
+
+       assert isset zone
+
+       config_write $(zone_file ${zone}) ${HOOK_SETTINGS}
+}
+
+function zone_config_set() {
+       local zone=${1}
+       shift
+       local args="$@"
+
+       assert isset zone
+
+       (
+               zone_config_read ${zone}
+
+               for arg in ${args}; do
+                       eval "${arg}"
+               done
+       
+               zone_config_write ${zone}
+       )
+}
+
+function zone_config_get() {
+       local zone=${1}
+       local key=${2}
+
+       assert isset zone
+       assert isset key
+
+       (
+               zone_config_read ${zone}
+
+               echo "${!key}"
+       )
+}