src/functions/functions.zone

   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 zone_dir() {
  23         local zone=${1}
  24
  25         echo "${NETWORK_ZONE_DIR}/zones/${zone}"
  26 }
  27
  28 zone_exists() {
  29         local zone=${1}
  30         assert isset zone
  31
  32         [ -d "$(zone_dir ${zone})" ]
  33 }
  34
  35 zone_match() {
  36         local match
  37
  38         local i
  39         for i in ${VALID_ZONES}; do
  40                 match="${match}|${i}[0-9]{1,5}"
  41         done
  42
  43         echo "${match:1:${#match}}"
  44 }
  45
  46 zone_name_is_valid() {
  47         local zone=${1}
  48
  49         # Don't accept empty strings.
  50         [ -z "${zone}" ] && return ${EXIT_FALSE}
  51
  52         [[ ${zone} =~ $(zone_match) ]]
  53 }
  54
  55 zone_is_local() {
  56         local zone=${1}
  57
  58         [[ "${zone:0:${#ZONE_LOCAL}}" = "${ZONE_LOCAL}" ]]
  59 }
  60
  61 zone_is_nonlocal() {
  62         local zone=${1}
  63
  64         [[ "${zone:0:${#ZONE_NONLOCAL}}" = "${ZONE_NONLOCAL}" ]]
  65 }
  66
  67 zone_get_hook() {
  68         local zone=${1}
  69         assert isset zone
  70
  71         config_get_hook $(zone_dir ${zone})/settings
  72 }
  73
  74 zone_start() {
  75         # This function will bring up the zone
  76         # 'asynchronously' with help of systemd.
  77
  78         local zone=${1}
  79         assert zone_exists ${zone}
  80
  81         service_start "network@${zone}.service"
  82 }
  83
  84 zone_start_auto() {
  85         local zone="${1}"
  86         assert zone_exists "${zone}"
  87
  88         # If the zone has already been started, we
  89         # will reload it so the current configuration
  90         # is re-applied.
  91         if zone_is_active "${zone}"; then
  92                 zone_reload "${zone}"
  93                 return ${?}
  94
  95         # If the zone is still down, but in auto-start mode,
  96         # we will start it.
  97         elif zone_is_enabled "${zone}"; then
  98                 zone_start "${zone}"
  99                 return ${?}
 100         fi
 101
 102         # Otherwise, nothing will be done.
 103         return ${EXIT_OK}
 104 }
 105
 106 zone_stop() {
 107         # This function will bring down the zone
 108         # 'asynchronously' with help of systemd.
 109
 110         local zone=${1}
 111         assert zone_exists ${zone}
 112
 113         service_stop "network@${zone}.service"
 114 }
 115
 116 zone_reload() {
 117         local zone="${1}"
 118         assert zone_exists "${zone}"
 119
 120         service_reload "network@${zone}.service"
 121 }
 122
 123 zone_hotplug_event() {
 124         local zone="${1}"
 125         assert isset zone
 126
 127         hotplug_assert_in_hotplug_event
 128
 129         zone_cmd "hotplug" "${zone}"
 130 }
 131
 132 zone_enable() {
 133         # This function will enable the zone
 134         # with help of systemd.
 135
 136         local zone="${1}"
 137         assert zone_exists "${zone}"
 138
 139         # Enable service for the zone
 140         service_enable "network@${zone}.service"
 141         local ret=$?
 142
 143         if [ ${ret} -eq ${EXIT_OK} ]; then
 144                 log INFO "Auto-start enabled for zone ${zone}"
 145                 return ${EXIT_OK}
 146         fi
 147
 148         log ERROR "Could not enable zone ${zone}: ${ret}"
 149         return ${ret}
 150 }
 151
 152 zone_disable() {
 153         # This function will disable the zone
 154         # with help of systemd.
 155
 156         local zone="${1}"
 157         assert zone_exists "${zone}"
 158
 159         # Disable service for the zone
 160         service_disable "network@${zone}.service"
 161         local ret=$?
 162
 163         if [ ${ret} -eq ${EXIT_OK} ]; then
 164                 log INFO "Auto-start disabled for zone ${zone}"
 165                 return ${EXIT_OK}
 166         fi
 167
 168         log ERROR "Could not disable zone ${zone}: ${ret}"
 169         return ${ret}
 170 }
 171
 172 zone_is_enabled() {
 173         local zone="${1}"
 174         assert isset zone
 175
 176         # Ask systemd if the zone is enabled.
 177         if service_is_enabled "network@${zone}.service"; then
 178                 return ${EXIT_TRUE}
 179         fi
 180
 181         return ${EXIT_FALSE}
 182 }
 183
 184 zone_is_active() {
 185         local zone="${1}"
 186         assert isset zone
 187
 188         if service_is_active "network@${zone}.service"; then
 189                 return ${EXIT_TRUE}
 190         fi
 191
 192         return ${EXIT_FALSE}
 193 }
 194
 195 zone_is_enabled_or_active() {
 196         local zone="${1}"
 197         assert isset zone
 198
 199         zone_is_enabled "${zone}" || zone_is_active "${zone}"
 200 }
 201
 202 zone_cmd() {
 203         local cmd="${1}"
 204         local port="${2}"
 205         shift 2
 206
 207         assert isset cmd
 208         assert isset zone
 209
 210         local hook="$(zone_get_hook ${zone})"
 211         assert isset hook
 212
 213         hook_exec zone "${hook}" "${cmd}" "${zone}" $@
 214 }
 215
 216 zone_new() {
 217         local zone=${1}
 218         local hook=${2}
 219         shift 2
 220
 221         if ! zone_name_is_valid ${zone}; then
 222                 error "Zone name '${zone}' is not valid."
 223                 return ${EXIT_ERROR}
 224         fi
 225
 226         if zone_exists ${zone}; then
 227                 error "Zone '${zone}' does already exist."
 228                 return ${EXIT_ERROR}
 229         fi
 230
 231         if ! hook_zone_exists ${hook}; then
 232                 error "Hook '${hook}' does not exist."
 233                 return ${EXIT_ERROR}
 234         fi
 235
 236         mkdir -p $(zone_dir ${zone})
 237
 238         # Create directories for configs and ports
 239         mkdir -p $(zone_dir ${zone})/{configs,ports}
 240
 241         hook_zone_exec "${hook}" "new" "${zone}" $@
 242         local ret=$?
 243
 244         # Maybe the zone new hook did not exit correctly.
 245         # If this is the case we remove the created zone immediately.
 246         if [ "${ret}" != "${EXIT_OK}" ]; then
 247                 zone_destroy_now "${zone}"
 248                 return ${EXIT_ERROR}
 249         fi
 250
 251         # Automatically enable zone.
 252         zone_enable "${zone}"
 253
 254         # Bring up the zone immediately after
 255         zone_start "${zone}"
 256 }
 257
 258 zone_edit() {
 259         local zone=${1}
 260         shift
 261
 262         if ! zone_exists ${zone}; then
 263                 error "Zone '${zone}' does not exist."
 264                 return ${EXIT_ERROR}
 265         fi
 266
 267         # Check if the zone is tagged for removal.
 268         if zone_has_destroy_tag ${zone}; then
 269                 error "You cannot edit a zone that is tagged for removal."
 270                 return ${EXIT_ERROR}
 271         fi
 272
 273         local hook="$(zone_get_hook "${zone}")"
 274         if [ -z "${hook}" ]; then
 275                 error "Config file did not provide any hook."
 276                 return ${EXIT_ERROR}
 277         fi
 278
 279         if ! hook_zone_exists ${hook}; then
 280                 error "Hook '${hook}' does not exist."
 281                 return ${EXIT_ERROR}
 282         fi
 283
 284         hook_zone_exec ${hook} edit ${zone} $@
 285 }
 286
 287 zone_rename() {
 288         assert [ $# -eq 2 ]
 289
 290         local zone="${1}"
 291         local name="${2}"
 292
 293         assert zone_exists "${zone}"
 294         assert not zone_has_destroy_tag "${zone}"
 295         assert not zone_exists "${name}"
 296
 297         # The zone must be shut down before, is then renamed and
 298         # potentially brought up again
 299
 300         # Save if the zone is running right now
 301         zone_is_active "${zone}"
 302         local zone_was_active="${?}"
 303
 304         # Save if the zone is enabled (i.e. auto-start)
 305         zone_is_enabled "${zone}"
 306         local zone_was_enabled="${?}"
 307
 308         # Stop the zone
 309         zone_stop "${zone}"
 310
 311         # Disable the zone
 312         zone_disable "${zone}"
 313
 314         # Rename the configuration files
 315         mv -f "$(zone_dir "${zone}")" "$(zone_dir "${name}")"
 316
 317         # Enable the zone if it was enabled before
 318         [ ${zone_was_enabled} -eq ${EXIT_TRUE} ] && zone_enable "${name}"
 319
 320         # Start the zone if it was up before
 321         [ ${zone_was_active} -eq ${EXIT_TRUE} ] && zone_start "${name}"
 322
 323         log INFO "Zone ${zone} was renamed to ${name}"
 324         return ${EXIT_OK}
 325 }
 326
 327
 328 zone_destroy() {
 329         local zone="${1}"
 330         assert zone_exists "${zone}"
 331
 332         # Make the zone for removal.
 333         touch "$(zone_dir "${zone}")/.destroy"
 334
 335         log INFO "Zone '${zone}' has been tagged for removal."
 336 }
 337
 338 zone_has_destroy_tag() {
 339         local zone="${1}"
 340         assert zone_exists "${zone}"
 341
 342         [ -e "$(zone_dir "${zone}")/.destroy" ]
 343 }
 344
 345 # This function will remove the given zone
 346 # RIGHT NOW. Use zone_destroy to remove it
 347 # at the next status change.
 348 zone_destroy_now() {
 349         local zone="${1}"
 350         assert zone_exists "${zone}"
 351
 352         log INFO "Removing zone '${zone}' right now."
 353
 354         # Force the zone down.
 355         zone_is_active "${zone}" && zone_stop "${zone}"
 356
 357         # Disable zone.
 358         zone_disable "${zone}"
 359
 360         rm -rf "$(zone_dir "${zone}")"
 361 }
 362
 363 zone_up() {
 364         local zone=${1}
 365         shift
 366
 367         if ! zone_exists ${zone}; then
 368                 error "Zone '${zone}' does not exist."
 369                 return ${EXIT_ERROR}
 370         fi
 371
 372         # Check if a zone has got the remove tag.
 373         if zone_has_destroy_tag ${zone}; then
 374                 error "Cannot bring up any zone which is to be removed."
 375                 return ${EXIT_ERROR}
 376         fi
 377
 378         local hook="$(zone_get_hook "${zone}")"
 379         if [ -z "${hook}" ]; then
 380                 error "Config file did not provide any hook."
 381                 return ${EXIT_ERROR}
 382         fi
 383
 384         if ! hook_zone_exists ${hook}; then
 385                 error "Hook '${hook}' does not exist."
 386                 return ${EXIT_ERROR}
 387         fi
 388
 389         zone_db ${zone} starting
 390
 391         hook_zone_exec ${hook} up ${zone} $@
 392
 393         zone_db ${zone} started
 394
 395         # Execute all triggers after the zone got up
 396         triggers_execute_all "up" ZONE="${zone}"
 397 }
 398
 399 zone_down() {
 400         local zone=${1}
 401         shift
 402
 403         if ! zone_exists ${zone}; then
 404                 error "Zone '${zone}' does not exist."
 405                 return ${EXIT_ERROR}
 406         fi
 407
 408         local hook="$(zone_get_hook "${zone}")"
 409         if [ -z "${hook}" ]; then
 410                 error "Config file did not provide any hook."
 411                 return ${EXIT_ERROR}
 412         fi
 413
 414         if ! hook_zone_exists ${hook}; then
 415                 error "Hook '${hook}' does not exist."
 416                 return ${EXIT_ERROR}
 417         fi
 418
 419         zone_db ${zone} stopping
 420
 421         hook_zone_exec ${hook} down ${zone} $@
 422
 423         zone_db ${zone} stopped
 424
 425         # Execute all triggers after the zone went down
 426         triggers_execute_all "down" ZONE="${zone}"
 427
 428         # Remove the zone, if it has got a remove tag.
 429         if zone_has_destroy_tag "${zone}"; then
 430                 zone_destroy_now "${zone}"
 431         fi
 432 }
 433
 434 zone_status() {
 435         local zone="${1}"
 436         assert isset zone
 437         shift
 438
 439         if ! zone_exists "${zone}"; then
 440                 error "Zone '${zone}' does not exist."
 441                 return ${EXIT_ERROR}
 442         fi
 443
 444         local hook="$(zone_get_hook "${zone}")"
 445         if [ -z "${hook}" ]; then
 446                 error "Config file did not provide any hook."
 447                 return ${EXIT_ERROR}
 448         fi
 449
 450         if ! hook_zone_exists "${hook}"; then
 451                 error "Hook '${hook}' does not exist."
 452                 return ${EXIT_ERROR}
 453         fi
 454
 455         hook_zone_exec "${hook}" "status" "${zone}" "$@"
 456
 457         # Show that the zone it to be removed soon.
 458         if zone_has_destroy_tag ${zone}; then
 459                 warning "This zone is tagged for removal."
 460         fi
 461 }
 462
 463 zone_identify() {
 464         assert [ $# -ge 1 ]
 465
 466         local zone="${1}"
 467         shift
 468
 469         assert zone_exists "${zone}"
 470
 471         log INFO "Identifying zone ${zone}"
 472         local pids
 473
 474         local pid
 475         local port
 476         for port in $(zone_get_ports "${zone}"); do
 477                 # Identify all the ports
 478                 port_identify "${port}" --background $@
 479
 480                 # Save the PIDs of the subprocesses
 481                 list_append pids "$(cmd_background_get_pid)"
 482         done
 483
 484         # Wait until all port_identfy processes have finished
 485         for pid in ${pids}; do
 486                 cmd_background_result "${pid}"
 487         done
 488
 489         return ${EXIT_OK}
 490 }
 491
 492 zone_get_ports() {
 493         local zone=${1}
 494
 495         assert isset zone
 496
 497         local port
 498         for port in $(zone_dir ${zone})/ports/*; do
 499                 port=$(basename ${port})
 500
 501                 if port_exists ${port}; then
 502                         echo "${port}"
 503                 fi
 504         done
 505 }
 506
 507 zone_get_ports_num() {
 508         local zone="${1}"
 509         assert isset zone
 510
 511         local counter=0
 512         local port
 513         for port in $(zone_dir "${zone}")/ports/*; do
 514                 port="$(basename "${port}")"
 515
 516                 if port_exists "${port}"; then
 517                         counter=$(( ${counter} + 1 ))
 518                 fi
 519         done
 520
 521         echo "${counter}"
 522         return ${EXIT_OK}
 523 }
 524
 525 zone_has_port() {
 526         # Check, if the given port is configured
 527         # in this zone.
 528
 529         local zone=${1}
 530         local port=${2}
 531         shift 2
 532
 533         assert isset zone
 534         assert isset port
 535
 536         [ -e "$(zone_dir ${zone})/ports/${port}" ]
 537 }
 538
 539 zone_config() {
 540         local zone="${1}"
 541         local cmd="${2}"
 542         shift 2
 543
 544         assert isset zone
 545         assert isset cmd
 546         assert zone_exists "${zone}"
 547
 548         case "${cmd}" in
 549                 new)
 550                         zone_config_new "${zone}" "$@"
 551                         ;;
 552                 destroy)
 553                         local id=${1}
 554                         if zone_config_id_is_valid ${zone} ${id}; then
 555                                 zone_config_destroy "${zone}" "$@"
 556                         else
 557                                 log ERROR "${id} is not a valid id"
 558                         fi
 559                         ;;
 560                 list)
 561                         zone_config_list "${zone}" "$@"
 562                         ;;
 563                 *)
 564                         # Check is we get a valid id
 565                         # TODO This could be also a valid hid
 566                         local id=${cmd}
 567
 568                         if zone_config_id_is_valid ${zone} ${id} && [[ ${1} == "edit" ]]; then
 569                                 shift 1
 570                                 zone_config_edit "${zone}" "${id}" "$@"
 571                         else
 572                                 error "Unrecognized argument: ${cmd}"
 573                                 cli_usage root-zone-config-subcommands
 574                                 exit ${EXIT_ERROR}
 575                         fi
 576                         ;;
 577         esac
 578 }
 579
 580 zone_config_cmd() {
 581         assert [ $# -gt 2 ]
 582
 583         local cmd="${1}"
 584         local zone="${2}"
 585         shift 2
 586
 587         local hook="$(zone_get_hook "${zone}")"
 588         assert isset hook
 589
 590         hook_zone_exec "${hook}" "config_${cmd}" "${zone}" "$@"
 591 }
 592
 593 zone_config_new() {
 594         local zone="${1}"
 595         shift
 596
 597         # Create a new configuration, but exit when that was
 598         # not successful.
 599         zone_config_cmd "new" "${zone}" "$@" || return ${?}
 600
 601         # If the config could be created, we will try to bring
 602         # it up if the zone is up, too.
 603         if zone_is_up "${zone}"; then
 604                 zone_configs_up "${zone}"
 605         fi
 606 }
 607
 608 zone_config_destroy() {
 609         zone_config_cmd "destroy" "$@"
 610 }
 611
 612 zone_config_edit() {
 613         zone_config_cmd "edit" "$@"
 614 }
 615
 616 zone_config_list() {
 617         # This function list in an nice way all configs of a zone
 618         local zone=${1}
 619         assert isset zone
 620
 621         # Print a nice header
 622         local format="%-3s %-20s"
 623         print "${format}" "ID" "HOOK"
 624
 625         local config
 626         local hook
 627         local id
 628
 629         # Print for all config:
 630         # id and hook
 631         # TODO: Add hids here
 632         for config in $(zone_configs_list "${zone}"); do
 633                 id=${config##*.}
 634                 hook=$(zone_config_get_hook "${zone}" "${config}")
 635                 assert isset hook
 636                 print "${format}" "${id}" "${hook}"
 637         done
 638 }
 639
 640 zone_config_show() {
 641         zone_config_cmd "show" "$@"
 642 }
 643
 644 # Returns a list of all used ids for a zone
 645 zone_config_list_ids() {
 646         assert [ $# -eq 1 ]
 647
 648         local zone=${1}
 649         local config
 650         local ids
 651
 652         for config in $(zone_configs_list ${zone}); do
 653                 list_append ids "$(config_get_id_from_config ${config})"
 654         done
 655
 656         echo ${ids}
 657 }
 658
 659 zone_show() {
 660         local zone=${1}
 661
 662         echo "${zone}"
 663         echo "  Type: $(zone_get_hook ${zone})"
 664         echo
 665 }
 666
 667 zones_show() {
 668         local zone
 669
 670         for zone in $(zones_get $@); do
 671                 zone_show ${zone}
 672         done
 673 }
 674
 675 zones_get_all() {
 676         local zone
 677         for zone in $(zone_dir)/*; do
 678                 zone=$(basename ${zone})
 679                 zone_exists ${zone} || continue
 680
 681                 echo "${zone}"
 682         done
 683 }
 684
 685 zones_get_next_free() {
 686         # This function return the next free zones.
 687         # Example net0 upl0 upl1 are configured so the next free zones are:
 688         # net1 upl2
 689         local i
 690         local zone_name
 691         for zone_name in ${VALID_ZONES}; do
 692                 i=0
 693
 694                 while true; do
 695                         local zone="${zone_name}${i}"
 696                         if ! zone_exists ${zone}; then
 697                                 echo "${zone}"
 698                                 break
 699                         fi
 700                         i=$(( i + 1 ))
 701                 done
 702         done
 703 }
 704
 705 zones_get_local() {
 706         local zone
 707         for zone in $(zones_get_all); do
 708                 zone_is_local ${zone} && echo "${zone}"
 709         done
 710 }
 711
 712 zones_get_nonlocal() {
 713         local zone
 714         for zone in $(zones_get_all); do
 715                 zone_is_nonlocal ${zone} && echo "${zone}"
 716         done
 717 }
 718
 719 zones_get() {
 720         local local=1
 721         local remote=1
 722
 723         local zones
 724
 725         while [ $# -gt 0 ]; do
 726                 case "${1}" in
 727                         --local-only)
 728                                 local=1
 729                                 remote=0
 730                                 ;;
 731                         --remote-only)
 732                                 local=0
 733                                 remote=1
 734                                 ;;
 735                         --all)
 736                                 local=1
 737                                 remote=1
 738                                 ;;
 739                         *)
 740                                 if zone_name_is_valid ${1}; then
 741                                         zones="${zones} ${1}"
 742                                 else
 743                                         warning "Unrecognized argument '${1}'"
 744                                 fi
 745                                 ;;
 746                 esac
 747                 shift
 748         done
 749
 750         if [ -n "${zones}" ]; then
 751                 local zone
 752                 for zone in ${zones}; do
 753                         zone_exists ${zone} && echo "${zone}"
 754                 done
 755                 exit ${EXIT_OK}
 756         fi
 757
 758         if [ ${local} -eq 1 ] && [ ${remote} -eq 1 ]; then
 759                 zones_get_all
 760         elif [ ${local} -eq 1 ]; then
 761                 zones_get_local
 762         elif [ ${remote} -eq 1 ]; then
 763                 zones_get_nonlocal
 764         fi
 765 }
 766
 767 zone_ports_list() {
 768         local zone=${1}
 769
 770         local port
 771         for port in $(zone_dir ${zone})/ports/*; do
 772                 [ -e "${port}" ] || continue
 773
 774                 echo $(basename ${port})
 775         done
 776 }
 777
 778 zone_port_attach() {
 779         local zone="${1}"
 780         assert isset zone
 781
 782         local port="${2}"
 783         assert isset port
 784
 785         shift 2
 786
 787         # Check if the port actually exists.
 788         if ! port_exists "${port}"; then
 789                 error "Cannot attach port '${port}' which does not exist"
 790                 return ${EXIT_ERROR}
 791         fi
 792
 793         # Check if the port is already connected to this or any other zone.
 794         local z
 795         for z in $(zones_get_all); do
 796                 if zone_has_port "${z}" "${port}"; then
 797                         error "Port '${port}' is already attached to zone '${z}'"
 798                         return ${EXIT_ERROR}
 799                 fi
 800         done
 801
 802         local hook="$(zone_get_hook "${zone}")"
 803         assert isset hook
 804
 805         # Make the port briefly flash if supported
 806         if device_exists ${port}; then
 807                 port_identify "${port}" --background
 808         fi
 809
 810         hook_zone_exec "${hook}" "port_attach" "${zone}" "${port}" "$@"
 811         local ret="${?}"
 812
 813         case "${ret}" in
 814                 ${EXIT_OK})
 815                         log INFO "${port} has been attached to ${zone}"
 816
 817                         # Automatically connect the port
 818                         zone_port_start "${zone}" "${port}"
 819                         ;;
 820                 *)
 821                         log CRITICAL "${port} could not be attached to ${zone}"
 822                         ;;
 823         esac
 824
 825         return ${ret}
 826 }
 827
 828 zone_port_edit() {
 829         local zone="${1}"
 830         assert isset zone
 831
 832         local port="${2}"
 833         assert isset port
 834
 835         shift 2
 836
 837         # Check if the port actually exists.
 838         if ! port_exists "${port}"; then
 839                 error "Port '${port}' does not exist"
 840                 return ${EXIT_ERROR}
 841         fi
 842
 843         # Check if the zone actually has this port.
 844         if ! zone_has_port "${zone}" "${port}"; then
 845                 error "Port '${port}' is not attached to zone '${zone}'"
 846                 return ${EXIT_ERROR}
 847         fi
 848
 849         local hook=$(zone_get_hook "${zone}")
 850         assert isset hook
 851
 852         hook_zone_exec "${hook}" "port_edit" "${zone}" "${port}" "$@"
 853 }
 854
 855 zone_port_detach() {
 856         local zone="${1}"
 857         assert isset zone
 858
 859         local port="${2}"
 860         assert isset port
 861
 862         shift 2
 863
 864         # Check if the zone actually has this port.
 865         if ! zone_has_port "${zone}" "${port}"; then
 866                 error "Port '${port}' is not attached to zone '${zone}'"
 867                 return ${EXIT_ERROR}
 868         fi
 869
 870         local hook=$(zone_get_hook "${zone}")
 871         assert isset hook
 872
 873         # Make the port briefly flash if supported
 874         port_identify "${port}" --background
 875
 876         hook_zone_exec "${hook}" "port_detach" "${zone}" "${port}" "$@"
 877         local ret="${?}"
 878
 879         case "${ret}" in
 880                 ${EXIT_OK})
 881                         log INFO "${port} has been detached from ${zone}"
 882
 883                         # Bring down the port if needed
 884                         zone_port_stop "${zone}" "${port}"
 885                         ;;
 886                 *)
 887                         log CRITICAL "${port} could not be detached from ${zone}"
 888                         ;;
 889         esac
 890
 891         return ${ret}
 892 }
 893
 894 zone_port_cmd() {
 895         local cmd="${1}"
 896         assert isset cmd
 897
 898         local zone="${2}"
 899         assert isset zone
 900
 901         local port="${3}"
 902         assert isset port
 903
 904         shift 3
 905
 906         local hook="$(zone_get_hook "${zone}")"
 907         assert isset hook
 908
 909         # Dispatch command to hook
 910         hook_zone_exec "${hook}" "${cmd}" "${zone}" "${port}" $@
 911 }
 912
 913 zone_port_create() {
 914         zone_port_cmd "port_create" $@
 915 }
 916
 917 zone_port_remove() {
 918         zone_port_cmd "port_remove" $@
 919 }
 920
 921 zone_port_up() {
 922         zone_port_cmd "port_up" $@
 923 }
 924
 925 zone_port_down() {
 926         zone_port_cmd "port_down" $@
 927 }
 928
 929 # The next two functions automagically bring up and down
 930 # port that are attached to a bridge or similar.
 931 # The problem that is tried to overcome here is that there
 932 # are ports which exist all the time (like ethernet ports)
 933 # and therefore do not dispatch a hotplug event when
 934 # port_create is called.
 935
 936 zone_port_start() {
 937         local zone="${1}"
 938         local port="${2}"
 939
 940         if zone_is_active "${zone}"; then
 941                 if device_exists "${port}"; then
 942                         zone_port_up "${zone}" "${port}"
 943                         return ${?}
 944                 else
 945                         zone_port_create "${zone}" "${port}"
 946                         return ${?}
 947                 fi
 948         fi
 949
 950         return ${EXIT_OK}
 951 }
 952
 953 zone_port_stop() {
 954         local zone="${1}"
 955         local port="${2}"
 956
 957         # Shut down the port if necessary
 958         if zone_is_active "${zone}" && port_is_up "${port}"; then
 959                 zone_port_down "${zone}" "${port}"
 960         fi
 961
 962         # Remove the port
 963         zone_port_remove "${zone}" "${port}"
 964 }
 965
 966 zone_port_status() {
 967         zone_port_cmd "port_status" $@
 968 }
 969
 970 zone_ports_cmd() {
 971         local cmd="${1}"
 972         assert isset cmd
 973
 974         local zone="${2}"
 975         assert isset zone
 976
 977         shift 2
 978
 979         local hook="$(zone_get_hook "${zone}")"
 980
 981         local port
 982         for port in $(zone_get_ports ${zone}); do
 983                 hook_zone_exec "${hook}" "${cmd}" "${zone}" "${port}" $@
 984         done
 985 }
 986
 987 zone_ports_create() {
 988         zone_ports_cmd "port_create" $@
 989 }
 990
 991 zone_ports_remove() {
 992         zone_ports_cmd "port_remove" $@
 993 }
 994
 995 zone_ports_up() {
 996         zone_ports_cmd "port_up" $@
 997 }
 998
 999 zone_ports_down() {
1000         zone_ports_cmd "port_down" $@
1001 }
1002
1003 zone_ports_status() {
1004         zone_ports_cmd "port_status" $@
1005 }
1006
1007 zone_configs_cmd() {
1008         assert [ $# -ge 2 ]
1009
1010         local cmd="${1}"
1011         local zone="${2}"
1012         shift 2
1013
1014         assert zone_exists "${zone}"
1015
1016         local config
1017         for config in $(zone_configs_list "${zone}"); do
1018                 local config_hook="$(zone_config_get_hook "${zone}" "${config}")"
1019                 assert isset config_hook
1020
1021                 hook_config_exec "${config_hook}" "${cmd}" "${zone}" "${config}" $@
1022         done
1023 }
1024
1025 zone_configs_up() {
1026         zone_configs_cmd "up" $@
1027 }
1028
1029 zone_configs_down() {
1030         zone_configs_cmd "down" $@
1031 }
1032
1033 zone_configs_status() {
1034         zone_configs_cmd "status" $@
1035 }
1036
1037 zone_configs_list() {
1038         local zone=${1}
1039
1040         local config
1041         for config in $(zone_dir ${zone})/configs/*; do
1042                 [ -e "${config}" ] || continue
1043
1044                 basename ${config}
1045         done
1046 }
1047
1048 zone_config_get_new_id() {
1049         # This functions returns the next free id for a zone
1050
1051         assert [ $# -eq 1 ]
1052         local zone=${1}
1053
1054         local zone_path=$(zone_dir ${zone})
1055         local i=0
1056
1057         while true; do
1058                 if [ ! -f ${zone_path}/configs/*.${i} ]; then
1059                         echo "${i}"
1060                         return ${EXIT_OK}
1061                 fi
1062                 (( i++ ))
1063         done
1064 }
1065
1066 zone_config_get_hook() {
1067         assert [ $# -eq 2 ]
1068
1069         local zone="${1}"
1070         assert isset zone
1071
1072         local config="${2}"
1073         assert isset config
1074
1075         local HOOK
1076         zone_config_settings_read "${zone}" "${config}" \
1077                 --ignore-superfluous-settings HOOK
1078
1079         print "${HOOK}"
1080 }
1081
1082 zone_config_hook_is_configured() {
1083         # Checks if a zone has already at least one config with the given hook.
1084         # Returns True when yes and False when no
1085
1086         assert [ $# -eq 2 ]
1087         local zone=${1}
1088         local hook=${2}
1089
1090         local config
1091         for config in $(zone_configs_list "${zone}"); do
1092                 local config_hook="$(zone_config_get_hook "${zone}" "${config}")"
1093                 assert isset config_hook
1094                 if [[ ${hook} == ${config_hook} ]]; then
1095                         return ${EXIT_TRUE}
1096                 fi
1097
1098         done
1099
1100         # If we get here the zone has no config with the given hook
1101         return ${EXIT_FALSE}
1102 }
1103
1104 zone_config_id_is_valid() {
1105         # This function checks if a given id is valid for a zone
1106         # Return True when yes and false when no
1107
1108         assert [ $# -eq 2 ]
1109         local zone=${1}
1110         local id=${2}
1111
1112         local zone_path=$(zone_dir ${zone})
1113
1114         [ -f ${zone_path}/configs/*.${id} ];
1115 }
1116
1117 zone_config_get_hook_from_id() {
1118         # Returns the hook for a given id
1119         assert [ $# -eq 2 ]
1120         local zone=${1}
1121         local id=${2}
1122
1123         local config
1124         for config in $(zone_configs_list "${zone}"); do
1125                 if [[ ${config} == *.${id} ]]; then
1126                         local config_hook="$(zone_config_get_hook "${zone}" "${config}")"
1127                         assert isset config_hook
1128                         print "${config_hook}"
1129                         return "${EXIT_OK}"
1130                 fi
1131         done
1132
1133         # If we get here the zone has no config with the given id
1134         return ${EXIT_ERROR}
1135 }
1136
1137 zone_has_ip() {
1138         device_has_ip $@
1139 }
1140
1141 zone_db() {
1142         local zone=${1}
1143         local action=${2}
1144         shift 2
1145
1146         case "${action}" in
1147                 starting|started|stopping|stopped)
1148                         db_connection_update ${zone} ${action}
1149                         ;;
1150         esac
1151 }
1152
1153 zone_is_up() {
1154         local zone=${1}
1155
1156         device_is_up ${zone}
1157 }
1158
1159 zone_is_down() {
1160         ! zone_is_up $@
1161 }
1162
1163 zone_get_supported_port_hooks() {
1164         local zone=${1}
1165
1166         local hook=$(zone_get_hook ${zone})
1167
1168         hook_zone_ports_get_all ${hook}
1169 }
1170
1171 zone_get_supported_config_hooks() {
1172         hook_config_get_all
1173 }
1174
1175 zone_file() {
1176         local zone=${1}
1177
1178         assert isset zone
1179
1180         echo "$(zone_dir ${zone})/settings"
1181 }
1182
1183 zone_settings_read() {
1184         local zone=${1}
1185         assert isset zone
1186         shift
1187
1188         local args
1189         if [ $# -eq 0 ] && [ -n "${HOOK_SETTINGS}" ]; then
1190                 list_append args ${HOOK_SETTINGS}
1191         else
1192                 list_append args $@
1193         fi
1194
1195         # Save the HOOK variable.
1196         local hook="${HOOK}"
1197
1198         settings_read "$(zone_file "${zone}")" ${args}
1199
1200         # Restore hook.
1201         HOOK="${hook}"
1202 }
1203
1204 zone_settings_write() {
1205         local zone="${1}"
1206         assert isset zone
1207
1208         local args
1209         if function_exists "hook_check_settings"; then
1210                 list_append args "--check=\"hook_check_settings\""
1211         fi
1212         list_append args ${HOOK_SETTINGS}
1213
1214         settings_write "$(zone_file ${zone})" ${args}
1215 }
1216
1217 zone_settings_set() {
1218         local zone=${1}
1219         shift
1220         local args="$@"
1221
1222         assert isset zone
1223
1224         (
1225                 zone_settings_read ${zone}
1226
1227                 for arg in ${args}; do
1228                         eval "${arg}"
1229                 done
1230
1231                 zone_settings_write ${zone}
1232         )
1233 }
1234
1235 zone_settings_get() {
1236         local zone=${1}
1237         local key=${2}
1238
1239         assert isset zone
1240         assert isset key
1241
1242         (
1243                 zone_settings_read "${zone}" "${key}" \
1244                         --ignore-superfluous-settings
1245
1246                 echo "${!key}"
1247         )
1248 }
1249
1250 zone_config_settings_read() {
1251         assert [ $# -ge 2 ]
1252
1253         local zone="${1}"
1254         local config="${2}"
1255         shift 2
1256
1257         local args
1258         if [ $# -eq 0 ] && [ -n "${HOOK_CONFIG_SETTINGS}" ]; then
1259                 list_append args ${HOOK_CONFIG_SETTINGS}
1260         else
1261                 list_append args $@
1262         fi
1263
1264         local path="$(zone_dir "${zone}")/configs/${config}"
1265         settings_read "${path}" ${args}
1266 }
1267
1268 zone_config_settings_write() {
1269         assert [ $# -ge 2 ]
1270
1271         local zone="${1}"
1272         local hook="${2}"
1273         local id=${3}
1274
1275         if ! isset id; then
1276                 id=$(zone_config_get_new_id ${zone})
1277                 log DEBUG "ID for the config is: ${id}"
1278         fi
1279
1280         local args
1281         if function_exists "hook_check_config_settings"; then
1282                 list_append args "--check=\"hook_check_config_settings\""
1283         fi
1284         list_append args ${HOOK_CONFIG_SETTINGS}
1285
1286         local path="$(zone_dir "${zone}")/configs/${hook}.${id}"
1287         settings_write "${path}" ${args}
1288 }
1289
1290 zone_config_settings_destroy() {
1291         # This function deletes the config file for a given zone and config
1292         assert [ $# -ge 2 ]
1293         local zone="${1}"
1294         local config="${2}"
1295
1296         local path="$(zone_dir "${zone}")/configs/${config}"
1297
1298         # Check if path is valid
1299         if [ ! -f ${path} ]; then
1300                 log ERROR "Path: '${path}' is not valid"
1301                 return ${EXIT_ERROR}
1302         fi
1303
1304         log DEBUG "Deleting config file ${path}"
1305         rm -f "${path}"
1306
1307 }
1308 zone_port_settings_read() {
1309         assert [ $# -ge 2 ]
1310
1311         local zone="${1}"
1312         local port="${2}"
1313         shift 2
1314
1315         local args
1316         if [ $# -eq 0 ] && [ -n "${HOOK_PORT_SETTINGS}" ]; then
1317                 list_append args ${HOOK_PORT_SETTINGS}
1318         else
1319                 list_append args $@
1320         fi
1321
1322         local path="$(zone_dir "${zone}")/ports/${port}"
1323         settings_read "${path}" ${args}
1324 }
1325
1326 zone_port_settings_write() {
1327         assert [ $# -ge 2 ]
1328
1329         local zone="${1}"
1330         local port="${2}"
1331         shift 2
1332
1333         local args
1334         if function_exists "hook_check_port_settings"; then
1335                 list_append args "--check=\"hook_check_port_settings\""
1336         fi
1337         list_append args ${HOOK_PORT_SETTINGS}
1338
1339         local path="$(zone_dir "${zone}")/ports/${port}"
1340         settings_write "${path}" ${args}
1341 }
1342
1343 zone_port_settings_remove() {
1344         assert [ $# -eq 2 ]
1345
1346         local zone="${1}"
1347         local port="${2}"
1348
1349         local path="$(zone_dir "${zone}")/ports/${port}"
1350         settings_remove "${path}"
1351 }
1352
1353 zone_get_color() {
1354         # This function return the color of a zone
1355         assert [ $# -eq 1 ]
1356
1357         local name=${1}
1358         color_read "zone" ${name}
1359 }
1360
1361 zone_get_description_title() {
1362         assert [ $# -eq 1 ]
1363
1364         local name=${1}
1365         description_title_read $(description_format_filename "zone" "${name}")
1366 }