]>
Commit | Line | Data |
---|---|---|
1848564d MT |
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 | ||
1c6a4e30 | 22 | hook_dir() { |
d61a01d4 MT |
23 | local type=${1} |
24 | ||
943e3f7e MT |
25 | if [ -n "${type}" ]; then |
26 | type="/${type}s" | |
27 | fi | |
28 | ||
d2a21d01 | 29 | echo "${NETWORK_HOOKS_DIR}${type}" |
d61a01d4 | 30 | } |
f41fa3d7 | 31 | NETWORK_HOOKS_DIR_ZONES="$(hook_dir zone)" |
d61a01d4 | 32 | |
1c6a4e30 | 33 | hook_exists() { |
d61a01d4 MT |
34 | local type=${1} |
35 | local hook=${2} | |
1848564d | 36 | |
943e3f7e MT |
37 | assert isset type |
38 | assert isset hook | |
39 | ||
f41fa3d7 MT |
40 | # Add the path prefix. |
41 | hook="$(hook_dir ${type})/${hook}" | |
1848564d | 42 | |
f41fa3d7 | 43 | [ ! -d "${hook}" ] && [ -x "${hook}" ] |
1848564d MT |
44 | } |
45 | ||
1c6a4e30 | 46 | hook_exec() { |
2181765d | 47 | local type="${1}" |
943e3f7e | 48 | assert isset type |
2181765d MT |
49 | |
50 | local hook="${2}" | |
943e3f7e | 51 | assert isset hook |
2181765d MT |
52 | |
53 | local cmd="${3}" | |
f41fa3d7 MT |
54 | assert isset cmd |
55 | ||
56 | assert hook_exists "${type}" "${hook}" | |
2181765d MT |
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. | |
426d620e | 63 | assert hook_valid_command "${type}" "${cmd}" |
2181765d MT |
64 | |
65 | local hook_path="$(hook_dir ${type})/${hook}" | |
f41fa3d7 MT |
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. | |
2181765d | 75 | source "${hook_path}" |
f41fa3d7 MT |
76 | |
77 | # Make sure HOOK is still properly set. | |
78 | assert isset HOOK | |
943e3f7e | 79 | |
f41fa3d7 | 80 | # Execute the requested command. |
1ba6a2bb | 81 | "${hook_cmd}" "$@" |
f41fa3d7 MT |
82 | ) |
83 | local ret=$? | |
84 | ||
2181765d | 85 | case "${ret}" in |
828eb94a MT |
86 | ${EXIT_COMMAND_NOT_FOUND}|${EXIT_NOT_SUPPORTED}) |
87 | log ERROR "Hook '${hook}' does not implement the method '${cmd}':" | |
88 | log ERROR " arguments: $@" | |
31cd8db9 | 89 | return ${EXIT_COMMAND_NOT_FOUND} |
2181765d MT |
90 | ;; |
91 | ${EXIT_ERROR_ASSERT}) | |
92 | log ERROR "Hook exited with an assertion error." | |
31cd8db9 | 93 | return ${EXIT_ERROR_ASSERT} |
2181765d MT |
94 | ;; |
95 | esac | |
d61a01d4 | 96 | |
f41fa3d7 | 97 | return ${ret} |
d61a01d4 MT |
98 | } |
99 | ||
1c6a4e30 | 100 | hook_list() { |
ea699552 MT |
101 | local type="${1}" |
102 | ||
103 | local dir="$(hook_dir "${type}")" | |
104 | assert isset dir | |
105 | ||
106 | local hook | |
60b1f378 | 107 | for hook in $(list_directory "${dir}"); do |
ea699552 MT |
108 | if hook_exists "${type}" "${hook}"; then |
109 | echo "${hook}" | |
110 | fi | |
111 | done | |
112 | } | |
113 | ||
ccbc0dd4 | 114 | # The default help function. |
1c6a4e30 | 115 | hook_help() { |
ccbc0dd4 MT |
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 | ||
c259c985 MT |
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 | ||
1c6a4e30 | 139 | config_get_hook() { |
d61a01d4 MT |
140 | local config=${1} |
141 | ||
943e3f7e | 142 | assert isset config |
a5ebb169 | 143 | assert [ -e "${config}" ] |
943e3f7e | 144 | |
d61a01d4 MT |
145 | ( |
146 | . ${config} | |
147 | echo "${HOOK}" | |
148 | ) | |
149 | } | |
150 | ||
1c6a4e30 | 151 | hook_zone_exists() { |
2212045f | 152 | hook_exists zone "$@" |
d61a01d4 MT |
153 | } |
154 | ||
1c6a4e30 | 155 | hook_zone_exec() { |
2212045f | 156 | hook_exec zone "$@" |
1848564d MT |
157 | } |
158 | ||
1c6a4e30 | 159 | hook_zone_get_all() { |
ea699552 | 160 | hook_list zone |
1848564d MT |
161 | } |
162 | ||
1c6a4e30 | 163 | hook_config_exists() { |
2212045f | 164 | hook_exists config "$@" |
ea699552 | 165 | } |
a5ebb169 | 166 | |
1c6a4e30 | 167 | hook_config_exec() { |
2212045f | 168 | hook_exec config "$@" |
ea699552 | 169 | } |
a5ebb169 | 170 | |
1c6a4e30 | 171 | hook_config_get_all() { |
ea699552 | 172 | hook_list config |
1848564d | 173 | } |
426d620e | 174 | |
1c6a4e30 | 175 | hook_valid_command() { |
426d620e MT |
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 | ||
1c6a4e30 | 197 | hook_valid_command_config() { |
426d620e MT |
198 | local cmd="${1}" |
199 | ||
200 | case "${cmd}" in | |
e3b67c2f | 201 | new|destroy|edit|up|down|status|hid) |
426d620e MT |
202 | return ${EXIT_TRUE} |
203 | ;; | |
204 | esac | |
205 | ||
206 | return ${EXIT_FALSE} | |
207 | } | |
208 | ||
1c6a4e30 | 209 | hook_valid_command_port() { |
426d620e MT |
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 | |
d0fde18f | 229 | status|children) |
426d620e MT |
230 | return ${EXIT_TRUE} |
231 | ;; | |
232 | esac | |
233 | ||
234 | return ${EXIT_FALSE} | |
235 | } | |
236 | ||
1c6a4e30 | 237 | hook_valid_command_zone() { |
426d620e MT |
238 | local cmd="${1}" |
239 | ||
240 | case "${cmd}" in | |
241 | # Configuration hooks | |
242 | new|edit|destroy) | |
243 | return ${EXIT_TRUE} | |
244 | ;; | |
245 | ||
2a6b2397 | 246 | config_new|config_destroy|config_edit|config_show) |
426d620e MT |
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 | |
76be48f2 | 261 | port_attach|port_detach|port_edit|port_create|port_remove|port_status|port_up|port_down) |
426d620e MT |
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 | } |