src/functions/functions.hook

   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 hook_dir() {
  23         local type=${1}
  24
  25         if [ -n "${type}" ]; then
  26                 type="/${type}s"
  27         fi
  28
  29         echo "${NETWORK_HOOKS_DIR}${type}"
  30 }
  31 NETWORK_HOOKS_DIR_ZONES="$(hook_dir zone)"
  32
  33 hook_exists() {
  34         local type=${1}
  35         local hook=${2}
  36
  37         assert isset type
  38         assert isset hook
  39
  40         # Add the path prefix.
  41         hook="$(hook_dir ${type})/${hook}"
  42
  43         [ ! -d "${hook}" ] && [ -x "${hook}" ]
  44 }
  45
  46 hook_exec() {
  47         local type="${1}"
  48         assert isset type
  49
  50         local hook="${2}"
  51         assert isset hook
  52
  53         local cmd="${3}"
  54         assert isset cmd
  55
  56         assert hook_exists "${type}" "${hook}"
  57         shift 3
  58
  59         # Complete the hook command by prepending "hook_"
  60         local hook_cmd="hook_${cmd}"
  61
  62         # Check if the hook action is valid.
  63         assert hook_valid_command "${type}" "${cmd}"
  64
  65         local hook_path="$(hook_dir ${type})/${hook}"
  66
  67         # For performance reasons, all hooks are executed
  68         # in a subshell and so will inherit the currently
  69         # running environment.
  70         (
  71                 # Set the name of the hook.
  72                 HOOK=$(basename ${hook})
  73
  74                 # Source the code of the hook.
  75                 source "${hook_path}"
  76
  77                 # Make sure HOOK is still properly set.
  78                 assert isset HOOK
  79
  80                 # Execute the requested command.
  81                 "${hook_cmd}" "$@"
  82         )
  83         local ret=$?
  84
  85         case "${ret}" in
  86                 ${EXIT_COMMAND_NOT_FOUND}|${EXIT_NOT_SUPPORTED})
  87                         log ERROR "Hook '${hook}' does not implement the method '${cmd}':"
  88                         log ERROR "  arguments: $@"
  89                         return ${EXIT_COMMAND_NOT_FOUND}
  90                         ;;
  91                 ${EXIT_ERROR_ASSERT})
  92                         log ERROR "Hook exited with an assertion error."
  93                         return ${EXIT_ERROR_ASSERT}
  94                         ;;
  95         esac
  96
  97         return ${ret}
  98 }
  99
 100 hook_list() {
 101         local type="${1}"
 102
 103         local dir="$(hook_dir "${type}")"
 104         assert isset dir
 105
 106         local hook
 107         for hook in $(list_directory "${dir}"); do
 108                 if hook_exists "${type}" "${hook}"; then
 109                         echo "${hook}"
 110                 fi
 111         done
 112 }
 113
 114 # The default help function.
 115 hook_help() {
 116         # If no man page has been configured, we print an error message.
 117         if [ -z "${HOOK_MANPAGE}" ]; then
 118                 error "There is no help available for hook '${HOOK}'. Exiting."
 119                 exit ${EXIT_ERROR}
 120         fi
 121
 122         cli_show_man "${HOOK_MANPAGE}"
 123
 124         exit $?
 125 }
 126
 127 # Sets all settings in HOOK_SETTINGS to their DEFAULT_* values
 128 hook_set_defaults() {
 129         local setting
 130         for setting in ${HOOK_SETTINGS}; do
 131                 local default="DEFAULT_${setting}"
 132
 133                 if isset ${default}; then
 134                         assign "${setting}" "${!default}"
 135                 fi
 136         done
 137 }
 138
 139 config_get_hook() {
 140         local config=${1}
 141
 142         assert isset config
 143         assert [ -e "${config}" ]
 144
 145         (
 146                 . ${config}
 147                 echo "${HOOK}"
 148         )
 149 }
 150
 151 hook_zone_exists() {
 152         hook_exists zone "$@"
 153 }
 154
 155 hook_zone_exec() {
 156         hook_exec zone "$@"
 157 }
 158
 159 hook_zone_get_all() {
 160         hook_list zone
 161 }
 162
 163 hook_config_exists() {
 164         hook_exists config "$@"
 165 }
 166
 167 hook_config_exec() {
 168         hook_exec config "$@"
 169 }
 170
 171 hook_config_get_all() {
 172         hook_list config
 173 }
 174
 175 hook_valid_command() {
 176         local type="${1}"
 177         local cmd="${2}"
 178
 179         case "${type}" in
 180                 config)
 181                         hook_valid_command_config "${cmd}"
 182                         return ${?}
 183                         ;;
 184                 port)
 185                         hook_valid_command_port "${cmd}"
 186                         return ${?}
 187                         ;;
 188                 zone)
 189                         hook_valid_command_zone "${cmd}"
 190                         return ${?}
 191                         ;;
 192         esac
 193
 194         return ${EXIT_FALSE}
 195 }
 196
 197 hook_valid_command_config() {
 198         local cmd="${1}"
 199
 200         case "${cmd}" in
 201                 new|destroy|edit|up|down|status|hid)
 202                         return ${EXIT_TRUE}
 203                         ;;
 204         esac
 205
 206         return ${EXIT_FALSE}
 207 }
 208
 209 hook_valid_command_port() {
 210         local cmd="${1}"
 211
 212         case "${cmd}" in
 213                 # Configuration hooks
 214                 new|edit|destroy)
 215                         return ${EXIT_TRUE}
 216                         ;;
 217
 218                 # Control hooks
 219                 create|remove|up|down)
 220                         return ${EXIT_TRUE}
 221                         ;;
 222
 223                 # Hotplug
 224                 hotplug|hotplug_rename)
 225                         return ${EXIT_TRUE}
 226                         ;;
 227
 228                 # Status
 229                 status|children)
 230                         return ${EXIT_TRUE}
 231                         ;;
 232         esac
 233
 234         return ${EXIT_FALSE}
 235 }
 236
 237 hook_valid_command_zone() {
 238         local cmd="${1}"
 239
 240         case "${cmd}" in
 241                 # Configuration hooks
 242                 new|edit|destroy)
 243                         return ${EXIT_TRUE}
 244                         ;;
 245
 246                 config_new|config_destroy|config_edit|config_show)
 247                         return ${EXIT_TRUE}
 248                         ;;
 249
 250                 # Control hooks
 251                 up|down)
 252                         return ${EXIT_TRUE}
 253                         ;;
 254
 255                 # Hotplug
 256                 hotplug)
 257                         return ${EXIT_TRUE}
 258                         ;;
 259
 260                 # Ports
 261                 port_attach|port_detach|port_edit|port_create|port_remove|port_status|port_up|port_down)
 262                         return ${EXIT_TRUE}
 263                         ;;
 264
 265                 # Status
 266                 status|info|help)
 267                         return ${EXIT_TRUE}
 268                         ;;
 269
 270                 # Discovery
 271                 discover)
 272                         return ${EXIT_TRUE}
 273                         ;;
 274
 275                 # PPP
 276                 ppp_ip_pre_up|ppp_ipv[64]_up|ppp_ipv[64]_down|ppp_write_config)
 277                         return ${EXIT_TRUE}
 278                         ;;
 279         esac
 280
 281         return ${EXIT_FALSE}
 282 }