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_ERROR}" ]; 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                         zone_config_destroy "${zone}" "$@"
 554                         ;;
 555                 edit)
 556                         zone_config_edit "${zone}" "$@"
 557                         ;;
 558                 *)
 559                         error "Unrecognized argument: ${cmd}"
 560                         cli_usage root-zone-config-subcommands
 561                         exit ${EXIT_ERROR}
 562                         ;;
 563         esac
 564 }
 565
 566 zone_config_cmd() {
 567         assert [ $# -gt 2 ]
 568
 569         local cmd="${1}"
 570         local zone="${2}"
 571         shift 2
 572
 573         local hook="$(zone_get_hook "${zone}")"
 574         assert isset hook
 575
 576         hook_zone_exec "${hook}" "config_${cmd}" "${zone}" "$@"
 577 }
 578
 579 zone_config_new() {
 580         local zone="${1}"
 581         shift
 582
 583         # Create a new configuration, but exit when that was
 584         # not successful.
 585         zone_config_cmd "new" "${zone}" "$@" || return ${?}
 586
 587         # If the config could be created, we will try to bring
 588         # it up if the zone is up, too.
 589         if zone_is_up "${zone}"; then
 590                 zone_configs_up "${zone}"
 591         fi
 592 }
 593
 594 zone_config_destroy() {
 595         zone_config_cmd "destroy" "$@"
 596 }
 597
 598 zone_config_edit() {
 599         zone_config_cmd "edit" "$@"
 600 }
 601
 602 zone_config_show() {
 603         zone_config_cmd "show" "$@"
 604 }
 605
 606 zone_show() {
 607         local zone=${1}
 608
 609         echo "${zone}"
 610         echo "  Type: $(zone_get_hook ${zone})"
 611         echo
 612 }
 613
 614 zones_show() {
 615         local zone
 616
 617         for zone in $(zones_get $@); do
 618                 zone_show ${zone}
 619         done
 620 }
 621
 622 zones_get_all() {
 623         local zone
 624         for zone in $(zone_dir)/*; do
 625                 zone=$(basename ${zone})
 626                 zone_exists ${zone} || continue
 627
 628                 echo "${zone}"
 629         done
 630 }
 631
 632 zones_get_next_free() {
 633         # This function return the next free zones.
 634         # Example net0 upl0 upl1 are configured so the next free zones are:
 635         # net1 upl2
 636         local i
 637         local zone_name
 638         for zone_name in ${VALID_ZONES}; do
 639                 i=0
 640
 641                 while true; do
 642                         local zone="${zone_name}${i}"
 643                         if ! zone_exists ${zone}; then
 644                                 echo "${zone}"
 645                                 break
 646                         fi
 647                         i=$(( i + 1 ))
 648                 done
 649         done
 650 }
 651
 652 zones_get_local() {
 653         local zone
 654         for zone in $(zones_get_all); do
 655                 zone_is_local ${zone} && echo "${zone}"
 656         done
 657 }
 658
 659 zones_get_nonlocal() {
 660         local zone
 661         for zone in $(zones_get_all); do
 662                 zone_is_nonlocal ${zone} && echo "${zone}"
 663         done
 664 }
 665
 666 zones_get() {
 667         local local=1
 668         local remote=1
 669
 670         local zones
 671
 672         while [ $# -gt 0 ]; do
 673                 case "${1}" in
 674                         --local-only)
 675                                 local=1
 676                                 remote=0
 677                                 ;;
 678                         --remote-only)
 679                                 local=0
 680                                 remote=1
 681                                 ;;
 682                         --all)
 683                                 local=1
 684                                 remote=1
 685                                 ;;
 686                         *)
 687                                 if zone_name_is_valid ${1}; then
 688                                         zones="${zones} ${1}"
 689                                 else
 690                                         warning "Unrecognized argument '${1}'"
 691                                 fi
 692                                 ;;
 693                 esac
 694                 shift
 695         done
 696
 697         if [ -n "${zones}" ]; then
 698                 local zone
 699                 for zone in ${zones}; do
 700                         zone_exists ${zone} && echo "${zone}"
 701                 done
 702                 exit ${EXIT_OK}
 703         fi
 704
 705         if [ ${local} -eq 1 ] && [ ${remote} -eq 1 ]; then
 706                 zones_get_all
 707         elif [ ${local} -eq 1 ]; then
 708                 zones_get_local
 709         elif [ ${remote} -eq 1 ]; then
 710                 zones_get_nonlocal
 711         fi
 712 }
 713
 714 zone_ports_list() {
 715         local zone=${1}
 716
 717         local port
 718         for port in $(zone_dir ${zone})/ports/*; do
 719                 [ -e "${port}" ] || continue
 720
 721                 echo $(basename ${port})
 722         done
 723 }
 724
 725 zone_port_attach() {
 726         local zone="${1}"
 727         assert isset zone
 728
 729         local port="${2}"
 730         assert isset port
 731
 732         shift 2
 733
 734         # Check if the port actually exists.
 735         if ! port_exists "${port}"; then
 736                 error "Cannot attach port '${port}' which does not exist"
 737                 return ${EXIT_ERROR}
 738         fi
 739
 740         # Check if the port is already connected to this or any other zone.
 741         local z
 742         for z in $(zones_get_all); do
 743                 if zone_has_port "${z}" "${port}"; then
 744                         error "Port '${port}' is already attached to zone '${z}'"
 745                         return ${EXIT_ERROR}
 746                 fi
 747         done
 748
 749         local hook="$(zone_get_hook "${zone}")"
 750         assert isset hook
 751
 752         # Make the port briefly flash if supported
 753         if device_exists ${port}; then
 754                 port_identify "${port}" --background
 755         fi
 756
 757         hook_zone_exec "${hook}" "port_attach" "${zone}" "${port}" "$@"
 758         local ret="${?}"
 759
 760         case "${ret}" in
 761                 ${EXIT_OK})
 762                         log INFO "${port} has been attached to ${zone}"
 763
 764                         # Automatically connect the port
 765                         zone_port_start "${zone}" "${port}"
 766                         ;;
 767                 *)
 768                         log CRITICAL "${port} could not be attached to ${zone}"
 769                         ;;
 770         esac
 771
 772         return ${ret}
 773 }
 774
 775 zone_port_edit() {
 776         local zone="${1}"
 777         assert isset zone
 778
 779         local port="${2}"
 780         assert isset port
 781
 782         shift 2
 783
 784         # Check if the port actually exists.
 785         if ! port_exists "${port}"; then
 786                 error "Port '${port}' does not exist"
 787                 return ${EXIT_ERROR}
 788         fi
 789
 790         # Check if the zone actually has this port.
 791         if ! zone_has_port "${zone}" "${port}"; then
 792                 error "Port '${port}' is not attached to zone '${zone}'"
 793                 return ${EXIT_ERROR}
 794         fi
 795
 796         local hook=$(zone_get_hook "${zone}")
 797         assert isset hook
 798
 799         hook_zone_exec "${hook}" "port_edit" "${zone}" "${port}" "$@"
 800 }
 801
 802 zone_port_detach() {
 803         local zone="${1}"
 804         assert isset zone
 805
 806         local port="${2}"
 807         assert isset port
 808
 809         shift 2
 810
 811         # Check if the zone actually has this port.
 812         if ! zone_has_port "${zone}" "${port}"; then
 813                 error "Port '${port}' is not attached to zone '${zone}'"
 814                 return ${EXIT_ERROR}
 815         fi
 816
 817         local hook=$(zone_get_hook "${zone}")
 818         assert isset hook
 819
 820         # Make the port briefly flash if supported
 821         port_identify "${port}" --background
 822
 823         hook_zone_exec "${hook}" "port_detach" "${zone}" "${port}" "$@"
 824         local ret="${?}"
 825
 826         case "${ret}" in
 827                 ${EXIT_OK})
 828                         log INFO "${port} has been detached from ${zone}"
 829
 830                         # Bring down the port if needed
 831                         zone_port_stop "${zone}" "${port}"
 832                         ;;
 833                 *)
 834                         log CRITICAL "${port} could not be detached from ${zone}"
 835                         ;;
 836         esac
 837
 838         return ${ret}
 839 }
 840
 841 zone_port_cmd() {
 842         local cmd="${1}"
 843         assert isset cmd
 844
 845         local zone="${2}"
 846         assert isset zone
 847
 848         local port="${3}"
 849         assert isset port
 850
 851         shift 3
 852
 853         local hook="$(zone_get_hook "${zone}")"
 854         assert isset hook
 855
 856         # Dispatch command to hook
 857         hook_zone_exec "${hook}" "${cmd}" "${zone}" "${port}" $@
 858 }
 859
 860 zone_port_create() {
 861         zone_port_cmd "port_create" $@
 862 }
 863
 864 zone_port_remove() {
 865         zone_port_cmd "port_remove" $@
 866 }
 867
 868 zone_port_up() {
 869         zone_port_cmd "port_up" $@
 870 }
 871
 872 zone_port_down() {
 873         zone_port_cmd "port_down" $@
 874 }
 875
 876 # The next two functions automagically bring up and down
 877 # port that are attached to a bridge or similar.
 878 # The problem that is tried to overcome here is that there
 879 # are ports which exist all the time (like ethernet ports)
 880 # and therefore do not dispatch a hotplug event when
 881 # port_create is called.
 882
 883 zone_port_start() {
 884         local zone="${1}"
 885         local port="${2}"
 886
 887         if zone_is_active "${zone}"; then
 888                 if device_exists "${port}"; then
 889                         zone_port_up "${zone}" "${port}"
 890                         return ${?}
 891                 else
 892                         zone_port_create "${zone}" "${port}"
 893                         return ${?}
 894                 fi
 895         fi
 896
 897         return ${EXIT_OK}
 898 }
 899
 900 zone_port_stop() {
 901         local zone="${1}"
 902         local port="${2}"
 903
 904         # Shut down the port if necessary
 905         if zone_is_active "${zone}" && port_is_up "${port}"; then
 906                 zone_port_down "${zone}" "${port}"
 907         fi
 908
 909         # Remove the port
 910         zone_port_remove "${zone}" "${port}"
 911 }
 912
 913 zone_port_status() {
 914         zone_port_cmd "port_status" $@
 915 }
 916
 917 zone_ports_cmd() {
 918         local cmd="${1}"
 919         assert isset cmd
 920
 921         local zone="${2}"
 922         assert isset zone
 923
 924         shift 2
 925
 926         local hook="$(zone_get_hook "${zone}")"
 927
 928         local port
 929         for port in $(zone_get_ports ${zone}); do
 930                 hook_zone_exec "${hook}" "${cmd}" "${zone}" "${port}" $@
 931         done
 932 }
 933
 934 zone_ports_create() {
 935         zone_ports_cmd "port_create" $@
 936 }
 937
 938 zone_ports_remove() {
 939         zone_ports_cmd "port_remove" $@
 940 }
 941
 942 zone_ports_up() {
 943         zone_ports_cmd "port_up" $@
 944 }
 945
 946 zone_ports_down() {
 947         zone_ports_cmd "port_down" $@
 948 }
 949
 950 zone_ports_status() {
 951         zone_ports_cmd "port_status" $@
 952 }
 953
 954 zone_configs_cmd() {
 955         assert [ $# -ge 2 ]
 956
 957         local cmd="${1}"
 958         local zone="${2}"
 959         shift 2
 960
 961         assert zone_exists "${zone}"
 962
 963         local config
 964         for config in $(zone_configs_list "${zone}"); do
 965                 local config_hook="$(zone_config_get_hook "${zone}" "${config}")"
 966                 assert isset config_hook
 967
 968                 hook_config_exec "${config_hook}" "${cmd}" "${zone}" "${config}" $@
 969         done
 970 }
 971
 972 zone_configs_up() {
 973         zone_configs_cmd "up" $@
 974 }
 975
 976 zone_configs_down() {
 977         zone_configs_cmd "down" $@
 978 }
 979
 980 zone_configs_status() {
 981         zone_configs_cmd "status" $@
 982 }
 983
 984 zone_configs_list() {
 985         local zone=${1}
 986
 987         local config
 988         for config in $(zone_dir ${zone})/configs/*; do
 989                 [ -e "${config}" ] || continue
 990
 991                 basename ${config}
 992         done
 993 }
 994
 995 zone_config_get_new_id() {
 996         # This functions returns the next free id for a zone
 997
 998         assert [ $# -eq 1 ]
 999         local zone=${1}
1000
1001         local zone_path=$(zone_dir ${zone})
1002         local i=0
1003
1004         while true; do
1005                 if [ ! -f ${zone_path}/configs/*.${i} ]; then
1006                         echo "${i}"
1007                         return ${EXIT_OK}
1008                 fi
1009                 (( i++ ))
1010         done
1011 }
1012
1013 zone_config_get_hook() {
1014         assert [ $# -eq 2 ]
1015
1016         local zone="${1}"
1017         assert isset zone
1018
1019         local config="${2}"
1020         assert isset config
1021
1022         local HOOK
1023         zone_config_settings_read "${zone}" "${config}" \
1024                 --ignore-superfluous-settings HOOK
1025
1026         print "${HOOK}"
1027 }
1028
1029 zone_config_hook_is_configured() {
1030         # Checks if a zone has already at least one config with the given hook.
1031         # Returns True when yes and False when no
1032
1033         assert [ $# -eq 2 ]
1034         local zone=${1}
1035         local hook=${2}
1036
1037         local config
1038         for config in $(zone_configs_list "${zone}"); do
1039                 local config_hook="$(zone_config_get_hook "${zone}" "${config}")"
1040                 assert isset config_hook
1041                 if [[ ${hook} == ${config_hook} ]]; then
1042                         return ${EXIT_TRUE}
1043                 fi
1044
1045         done
1046
1047         # If we get here the zone has no config with the given hook
1048         return ${EXIT_FALSE}
1049 }
1050
1051 zone_config_id_is_valid() {
1052         # This function checks if a given id is valid for a zone
1053         # Return True when yes and false when no
1054
1055         assert [ $# -eq 2 ]
1056         local zone=${1}
1057         local id=${2}
1058
1059         local zone_path=$(zone_dir ${zone})
1060
1061         [ -f ${zone_path}/configs/*.${id} ];
1062 }
1063
1064 zone_config_get_hook_from_id() {
1065         # Returns the hook for a given id
1066         assert [ $# -eq 2 ]
1067         local zone=${1}
1068         local id=${2}
1069
1070         local config
1071         for config in $(zone_configs_list "${zone}"); do
1072                 if [[ ${config} == *.${id} ]]; then
1073                         local config_hook="$(zone_config_get_hook "${zone}" "${config}")"
1074                         assert isset config_hook
1075                         print "${config_hook}"
1076                         return "${EXIT_OK}"
1077                 fi
1078         done
1079
1080         # If we get here the zone has no config with the given id
1081         return ${EXIT_ERROR}
1082 }
1083
1084 zone_has_ip() {
1085         device_has_ip $@
1086 }
1087
1088 zone_db() {
1089         local zone=${1}
1090         local action=${2}
1091         shift 2
1092
1093         case "${action}" in
1094                 starting|started|stopping|stopped)
1095                         db_connection_update ${zone} ${action}
1096                         ;;
1097         esac
1098 }
1099
1100 zone_is_up() {
1101         local zone=${1}
1102
1103         device_is_up ${zone}
1104 }
1105
1106 zone_is_down() {
1107         ! zone_is_up $@
1108 }
1109
1110 zone_get_supported_port_hooks() {
1111         local zone=${1}
1112
1113         local hook=$(zone_get_hook ${zone})
1114
1115         hook_zone_ports_get_all ${hook}
1116 }
1117
1118 zone_get_supported_config_hooks() {
1119         hook_config_get_all
1120 }
1121
1122 zone_file() {
1123         local zone=${1}
1124
1125         assert isset zone
1126
1127         echo "$(zone_dir ${zone})/settings"
1128 }
1129
1130 zone_settings_read() {
1131         local zone=${1}
1132         assert isset zone
1133         shift
1134
1135         local args
1136         if [ $# -eq 0 ] && [ -n "${HOOK_SETTINGS}" ]; then
1137                 list_append args ${HOOK_SETTINGS}
1138         else
1139                 list_append args $@
1140         fi
1141
1142         # Save the HOOK variable.
1143         local hook="${HOOK}"
1144
1145         settings_read "$(zone_file "${zone}")" ${args}
1146
1147         # Restore hook.
1148         HOOK="${hook}"
1149 }
1150
1151 zone_settings_write() {
1152         local zone="${1}"
1153         assert isset zone
1154
1155         local args
1156         if function_exists "hook_check_settings"; then
1157                 list_append args "--check=\"hook_check_settings\""
1158         fi
1159         list_append args ${HOOK_SETTINGS}
1160
1161         settings_write "$(zone_file ${zone})" ${args}
1162 }
1163
1164 zone_settings_set() {
1165         local zone=${1}
1166         shift
1167         local args="$@"
1168
1169         assert isset zone
1170
1171         (
1172                 zone_settings_read ${zone}
1173
1174                 for arg in ${args}; do
1175                         eval "${arg}"
1176                 done
1177
1178                 zone_settings_write ${zone}
1179         )
1180 }
1181
1182 zone_settings_get() {
1183         local zone=${1}
1184         local key=${2}
1185
1186         assert isset zone
1187         assert isset key
1188
1189         (
1190                 zone_settings_read "${zone}" "${key}" \
1191                         --ignore-superfluous-settings
1192
1193                 echo "${!key}"
1194         )
1195 }
1196
1197 zone_config_settings_read() {
1198         assert [ $# -ge 2 ]
1199
1200         local zone="${1}"
1201         local config="${2}"
1202         shift 2
1203
1204         local args
1205         if [ $# -eq 0 ] && [ -n "${HOOK_CONFIG_SETTINGS}" ]; then
1206                 list_append args ${HOOK_CONFIG_SETTINGS}
1207         else
1208                 list_append args $@
1209         fi
1210
1211         local path="$(zone_dir "${zone}")/configs/${config}"
1212         settings_read "${path}" ${args}
1213 }
1214
1215 zone_config_settings_write() {
1216         assert [ $# -ge 2 ]
1217
1218         local zone="${1}"
1219         local config="${2}"
1220         shift 2
1221
1222         local args
1223         if function_exists "hook_check_config_settings"; then
1224                 list_append args "--check=\"hook_check_config_settings\""
1225         fi
1226         list_append args ${HOOK_CONFIG_SETTINGS}
1227
1228         local path="$(zone_dir "${zone}")/configs/${config}"
1229         settings_write "${path}" ${args}
1230 }
1231
1232 zone_port_settings_read() {
1233         assert [ $# -ge 2 ]
1234
1235         local zone="${1}"
1236         local port="${2}"
1237         shift 2
1238
1239         local args
1240         if [ $# -eq 0 ] && [ -n "${HOOK_PORT_SETTINGS}" ]; then
1241                 list_append args ${HOOK_PORT_SETTINGS}
1242         else
1243                 list_append args $@
1244         fi
1245
1246         local path="$(zone_dir "${zone}")/ports/${port}"
1247         settings_read "${path}" ${args}
1248 }
1249
1250 zone_port_settings_write() {
1251         assert [ $# -ge 2 ]
1252
1253         local zone="${1}"
1254         local port="${2}"
1255         shift 2
1256
1257         local args
1258         if function_exists "hook_check_port_settings"; then
1259                 list_append args "--check=\"hook_check_port_settings\""
1260         fi
1261         list_append args ${HOOK_PORT_SETTINGS}
1262
1263         local path="$(zone_dir "${zone}")/ports/${port}"
1264         settings_write "${path}" ${args}
1265 }
1266
1267 zone_port_settings_remove() {
1268         assert [ $# -eq 2 ]
1269
1270         local zone="${1}"
1271         local port="${2}"
1272
1273         local path="$(zone_dir "${zone}")/ports/${port}"
1274         settings_remove "${path}"
1275 }
1276
1277 zone_get_color() {
1278         # This function return the color of a zone
1279         assert [ $# -eq 1 ]
1280
1281         local name=${1}
1282         color_read "zone" ${name}
1283 }
1284
1285 zone_get_description_title() {
1286         assert [ $# -eq 1 ]
1287
1288         local name=${1}
1289         description_title_read $(description_format_filename "zone" "${name}")
1290 }