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 function hook_dir() {
  23         local type=${1}
  24
  25         echo "${HOOKS_DIR}/${type}s"
  26 }
  27
  28 function hook_exists() {
  29         local type=${1}
  30         local hook=${2}
  31
  32         local hook_dir=$(hook_dir ${type})
  33
  34         [ -d "${hook_dir}/${hook}" ] && return ${EXIT_ERROR}
  35
  36         [ -x "${hook_dir}/${hook}" ]
  37 }
  38
  39 function hook_exec() {
  40         local type=${1}
  41         local hook=${2}
  42         shift 2
  43
  44         if ! hook_exists ${type} ${hook}; then
  45                 error "Hook '${hook}' does not exist."
  46                 return ${EXIT_ERROR}
  47         fi
  48
  49         exec_cmd $(hook_dir ${type})/${hook} $@
  50 }
  51
  52 function config_get_hook() {
  53         local config=${1}
  54
  55         (
  56                 . ${config}
  57                 echo "${HOOK}"
  58         )
  59 }
  60
  61 ## Wrappers around the hook functions for zones
  62
  63 function hook_zone_exists() {
  64         hook_exists zone $@
  65 }
  66
  67 function hook_zone_port_exists() {
  68         local hook_zone=${1}
  69         local hook_port=${2}
  70
  71         hook_zone_exists ${hook_zone} || return ${EXIT_ERROR}
  72
  73         [ -x "$(hook_dir zone)/${hook_zone}.ports/${hook_port}" ]
  74 }
  75
  76 function hook_zone_config_exists() {
  77         local hook_zone=${1}
  78         local hook_config=${2}
  79
  80         hook_zone_exists ${hook_zone} || return ${EXIT_ERROR}
  81
  82         [ -x "$(hook_dir zone)/${hook_zone}.configs/${hook_config}" ]
  83 }
  84
  85 function hook_zone_has_ports() {
  86         local hook=${1}
  87
  88         [ -d "$(hook_dir zone)/${hook}.ports" ]
  89 }
  90
  91 function hook_zone_port_exists() {
  92         : # XXX WANTED
  93 }
  94
  95 function hook_zone_has_configs() {
  96         local hook=${1}
  97
  98         [ -d "$(hook_dir zone)/${hook}.configs" ]
  99 }
 100
 101 function hook_zone_exec() {
 102         hook_exec zone $@
 103 }
 104
 105 function hook_zone_port_exec() {
 106         local hook_zone=${1}
 107         local hook_port=${2}
 108         shift 2
 109
 110         if ! hook_exists zone ${hook_zone}; then
 111                 error "Hook '${hook_zone}' does not exist."
 112                 return ${EXIT_ERROR}
 113         fi
 114
 115         if ! hook_zone_port_exists ${hook_zone} ${hook_port}; then
 116                 error "Port hook '${hook_port}' does not exist."
 117                 return ${EXIT_ERROR}
 118         fi
 119
 120         exec_cmd $(hook_dir zone)/${hook_zone}.ports/${hook_port} $@
 121 }
 122
 123 function hook_zone_config_exec() {
 124         local hook_zone=${1}
 125         local hook_config=${2}
 126         shift 2
 127
 128         if ! hook_zone_exists ${hook_zone}; then
 129                 error "Hook '${hook_zone}' does not exist."
 130                 return ${EXIT_ERROR}
 131         fi
 132
 133         if ! hook_zone_config_exists ${hook_zone} ${hook_config}; then
 134                 error "Config hook '${hook_config}' does not exist."
 135                 return ${EXIT_ERROR}
 136         fi
 137
 138         exec_cmd $(hook_dir zone)/${hook_zone}.configs/${hook_config} $@
 139 }
 140
 141 function hook_zone_get_all() {
 142         local type=${1}
 143
 144         local hook
 145         for hook in $(hook_dir zone)/*; do
 146                 hook=$(basename ${hook})
 147                 hook_zone_exists ${hook} && echo "${hook}"
 148         done | sort
 149 }
 150
 151 function hook_zone_ports_get_all() {
 152         local hook=${1}
 153
 154         if ! hook_exists zone ${hook}; then
 155                 error "Hook '${hook}' does not exist."
 156                 return ${EXIT_ERROR}
 157         fi
 158
 159         local h
 160         for h in $(hook_dir zone)/${hook}.ports/*; do
 161                 h=$(basename ${h})
 162                 ## XXX executeable?
 163                 echo "${h}"
 164         done | sort
 165 }
 166
 167 function hook_device_exists() {
 168         hook_exists device $@
 169 }