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                 # Sets the default or empty
 134                 assign "${setting}" "${!default}"
 135         done
 136 }
 137
 138 config_get_hook() {
 139         local config=${1}
 140
 141         assert isset config
 142         assert [ -e "${config}" ]
 143
 144         (
 145                 . ${config}
 146                 echo "${HOOK}"
 147         )
 148 }
 149
 150 hook_zone_exists() {
 151         hook_exists zone "$@"
 152 }
 153
 154 hook_zone_exec() {
 155         hook_exec zone "$@"
 156 }
 157
 158 hook_zone_get_all() {
 159         hook_list zone
 160 }
 161
 162 hook_config_exists() {
 163         hook_exists config "$@"
 164 }
 165
 166 hook_config_exec() {
 167         hook_exec config "$@"
 168 }
 169
 170 hook_config_get_all() {
 171         hook_list config
 172 }
 173
 174 hook_valid_command() {
 175         local type="${1}"
 176         local cmd="${2}"
 177
 178         case "${type}" in
 179                 config)
 180                         hook_valid_command_config "${cmd}"
 181                         return ${?}
 182                         ;;
 183                 port)
 184                         hook_valid_command_port "${cmd}"
 185                         return ${?}
 186                         ;;
 187                 zone)
 188                         hook_valid_command_zone "${cmd}"
 189                         return ${?}
 190                         ;;
 191         esac
 192
 193         return ${EXIT_FALSE}
 194 }
 195
 196 hook_valid_command_config() {
 197         local cmd="${1}"
 198
 199         case "${cmd}" in
 200                 new|destroy|edit|up|down|status|hid)
 201                         return ${EXIT_TRUE}
 202                         ;;
 203         esac
 204
 205         return ${EXIT_FALSE}
 206 }
 207
 208 hook_valid_command_port() {
 209         local cmd="${1}"
 210
 211         case "${cmd}" in
 212                 # Configuration hooks
 213                 new|edit|destroy)
 214                         return ${EXIT_TRUE}
 215                         ;;
 216
 217                 # Control hooks
 218                 create|remove|up|down)
 219                         return ${EXIT_TRUE}
 220                         ;;
 221
 222                 # Hotplug
 223                 hotplug|hotplug_rename)
 224                         return ${EXIT_TRUE}
 225                         ;;
 226
 227                 # Status
 228                 status|children)
 229                         return ${EXIT_TRUE}
 230                         ;;
 231         esac
 232
 233         return ${EXIT_FALSE}
 234 }
 235
 236 hook_valid_command_zone() {
 237         local cmd="${1}"
 238
 239         case "${cmd}" in
 240                 # Configuration hooks
 241                 new|edit|destroy)
 242                         return ${EXIT_TRUE}
 243                         ;;
 244
 245                 config_new|config_destroy|config_edit|config_show)
 246                         return ${EXIT_TRUE}
 247                         ;;
 248
 249                 # Control hooks
 250                 up|down)
 251                         return ${EXIT_TRUE}
 252                         ;;
 253
 254                 # Hotplug
 255                 hotplug)
 256                         return ${EXIT_TRUE}
 257                         ;;
 258
 259                 # Ports
 260                 port_attach|port_detach|port_edit|port_create|port_remove|port_status|port_up|port_down)
 261                         return ${EXIT_TRUE}
 262                         ;;
 263
 264                 # Status
 265                 status|info|help)
 266                         return ${EXIT_TRUE}
 267                         ;;
 268
 269                 # Discovery
 270                 discover)
 271                         return ${EXIT_TRUE}
 272                         ;;
 273
 274                 # PPP
 275                 ppp_ip_pre_up|ppp_ipv[64]_up|ppp_ipv[64]_down|ppp_write_config)
 276                         return ${EXIT_TRUE}
 277                         ;;
 278         esac
 279
 280         return ${EXIT_FALSE}
 281 }