src/header-port

   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 INFO_SETTINGS="HOOK PORT_PARENTS PORT_CHILDREN"
  23
  24 HOOK_PORT_PATTERN="${PORT_PATTERN}"
  25
  26 # This function is called after a device has been plugged
  27 # into the system and got its correct name.
  28 # The function is intended to create child ports and things
  29 # like that.
  30 hook_hotplug() {
  31         # If the hook does not handle the hotplug event, it
  32         # must return EXIT_NOT_HANDLED.
  33         exit ${EXIT_NOT_HANDLED}
  34 }
  35
  36 # This function gets called when a device is plugged in
  37 # to determine the right name.
  38 # The first argument is the port which should be tested
  39 # against the second argument which is the device that
  40 # has been plugged in.
  41 hook_hotplug_rename() {
  42         exit ${EXIT_FALSE}
  43 }
  44
  45 hook_default_new() {
  46         local ${HOOK_SETTINGS}
  47         if ! hook_parse_cmdline "$@"; then
  48                 return ${EXIT_ERROR}
  49         fi
  50
  51         assert isset HOOK_PORT_PATTERN
  52
  53         local port=$(port_find_free ${HOOK_PORT_PATTERN})
  54         assert isset port
  55
  56         port_settings_write "${port}" ${HOOK_SETTINGS}
  57
  58         exit ${EXIT_OK}
  59 }
  60
  61 hook_new() {
  62         hook_default_new "$@"
  63 }
  64
  65 hook_default_edit() {
  66         local port=${1}
  67         assert isset port
  68         shift
  69
  70         # Read settings
  71         if ! port_settings_read "${port}" ${HOOK_SETTINGS}; then
  72                 error "Could not read settings for port ${port}"
  73                 return ${EXIT_ERROR}
  74         fi
  75
  76         # Parse command line arguments
  77         if ! hook_parse_cmdline "$@"; then
  78                 return ${EXIT_ERROR}
  79         fi
  80
  81         # Save settings
  82         if ! port_settings_write "${port}" ${HOOK_SETTINGS}; then
  83                 error "Could not write settings for port ${port}"
  84                 return ${EXIT_ERROR}
  85         fi
  86
  87         # Apply settings
  88         port_restart "${port}"
  89
  90         return ${EXIT_OK}
  91 }
  92
  93 hook_edit() {
  94         hook_default_edit "$@"
  95 }
  96
  97 # Returns a list of all children of this port
  98 hook_children() {
  99         local port="${1}"
 100
 101         if ! port_settings_read "${port}" ${HOOK_SETTINGS}; then
 102                 log ERROR "Could not read port settings: ${port}"
 103                 return ${EXIT_OK}
 104         fi
 105
 106         print "${SLAVES}"
 107 }
 108
 109 hook_status() {
 110         local port="${1}"
 111         assert isset port
 112
 113         cli_device_headline "${port}" --long
 114         exit ${EXIT_OK}
 115 }
 116
 117 # Create any virtual devices, but don't bring them up
 118 # Must tolerate that the device may already exist
 119 hook_create() {
 120         cmd_not_implemented
 121 }
 122
 123 # Must tolerate that the device may not exist
 124 hook_remove() {
 125         cmd_not_implemented
 126 }
 127
 128 # Just bring up the device
 129 hook_default_up() {
 130         local port="${1}"
 131         assert isset port
 132
 133         if ! device_exists "${port}"; then
 134                 log ERROR "Port '${port}' does not exist and cannot be brought up"
 135                 exit ${EXIT_ERROR}
 136         fi
 137
 138         # Bring up the port
 139         device_set_up "${port}"
 140
 141         # Bring up all slaves if the port has any
 142         local slave
 143         for slave in $(port_get_slaves "${port}"); do
 144                 port_up "${slave}"
 145         done
 146 }
 147
 148 # Depends on the port existing
 149 hook_up() {
 150         hook_default_up "$@"
 151 }
 152
 153 hook_default_down() {
 154         local port="${1}"
 155         assert isset port
 156
 157         if device_exists "${port}"; then
 158                 device_set_down "${port}"
 159         fi
 160
 161         # Bring down all slaves if the port has any
 162         local slave
 163         for slave in $(port_get_slaves "${port}"); do
 164                 port_down "${slave}"
 165         done
 166 }
 167
 168 hook_down() {
 169         hook_default_down "$@"
 170 }