]>
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 | |
d389e96b | 130 | for setting in ${HOOK_SETTINGS[*]}; do |
c259c985 MT |
131 | local default="DEFAULT_${setting}" |
132 | ||
4637109c MT |
133 | # Sets the default or empty |
134 | assign "${setting}" "${!default}" | |
c259c985 MT |
135 | done |
136 | } | |
137 | ||
1c6a4e30 | 138 | config_get_hook() { |
d61a01d4 MT |
139 | local config=${1} |
140 | ||
943e3f7e | 141 | assert isset config |
a5ebb169 | 142 | assert [ -e "${config}" ] |
943e3f7e | 143 | |
d61a01d4 MT |
144 | ( |
145 | . ${config} | |
146 | echo "${HOOK}" | |
147 | ) | |
148 | } | |
149 | ||
1c6a4e30 | 150 | hook_zone_exists() { |
2212045f | 151 | hook_exists zone "$@" |
d61a01d4 MT |
152 | } |
153 | ||
1c6a4e30 | 154 | hook_zone_exec() { |
2212045f | 155 | hook_exec zone "$@" |
1848564d MT |
156 | } |
157 | ||
1c6a4e30 | 158 | hook_zone_get_all() { |
ea699552 | 159 | hook_list zone |
1848564d MT |
160 | } |
161 | ||
1c6a4e30 | 162 | hook_config_exists() { |
2212045f | 163 | hook_exists config "$@" |
ea699552 | 164 | } |
a5ebb169 | 165 | |
1c6a4e30 | 166 | hook_config_exec() { |
2212045f | 167 | hook_exec config "$@" |
ea699552 | 168 | } |
a5ebb169 | 169 | |
1c6a4e30 | 170 | hook_config_get_all() { |
ea699552 | 171 | hook_list config |
1848564d | 172 | } |
426d620e | 173 | |
1c6a4e30 | 174 | hook_valid_command() { |
426d620e MT |
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 | ||
1c6a4e30 | 196 | hook_valid_command_config() { |
426d620e MT |
197 | local cmd="${1}" |
198 | ||
199 | case "${cmd}" in | |
e3b67c2f | 200 | new|destroy|edit|up|down|status|hid) |
426d620e MT |
201 | return ${EXIT_TRUE} |
202 | ;; | |
203 | esac | |
204 | ||
205 | return ${EXIT_FALSE} | |
206 | } | |
207 | ||
1c6a4e30 | 208 | hook_valid_command_port() { |
426d620e MT |
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 | |
d0fde18f | 228 | status|children) |
426d620e MT |
229 | return ${EXIT_TRUE} |
230 | ;; | |
231 | esac | |
232 | ||
233 | return ${EXIT_FALSE} | |
234 | } | |
235 | ||
1c6a4e30 | 236 | hook_valid_command_zone() { |
426d620e MT |
237 | local cmd="${1}" |
238 | ||
239 | case "${cmd}" in | |
240 | # Configuration hooks | |
241 | new|edit|destroy) | |
242 | return ${EXIT_TRUE} | |
243 | ;; | |
244 | ||
2a6b2397 | 245 | config_new|config_destroy|config_edit|config_show) |
426d620e MT |
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 | |
76be48f2 | 260 | port_attach|port_detach|port_edit|port_create|port_remove|port_status|port_up|port_down) |
426d620e MT |
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 | } |