]>
Commit | Line | Data |
---|---|---|
711ffac1 | 1 | #!/bin/bash |
1578dae9 MT |
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 | ############################################################################### | |
711ffac1 | 21 | |
1c6a4e30 | 22 | port_dir() { |
af51d3a9 JS |
23 | local port="${1}" |
24 | echo "${NETWORK_CONFIG_DIR}/ports/${port}" | |
711ffac1 MT |
25 | } |
26 | ||
1c6a4e30 | 27 | port_list() { |
bae37360 MT |
28 | local port |
29 | for port in $(port_dir)/*; do | |
30 | port="$(basename "${port}")" | |
31 | if port_exists "${port}"; then | |
32 | print "${port}" | |
33 | fi | |
34 | done | |
35 | } | |
36 | ||
1c6a4e30 | 37 | port_list_in_use() { |
bae37360 MT |
38 | local ports_in_use |
39 | ||
40 | # Collect all ports that are attached to a zone | |
41 | local zone | |
42 | for zone in $(zones_get_all); do | |
43 | list_append ports_in_use $(zone_get_ports "${zone}") | |
44 | done | |
45 | ||
46 | # Collect all ports that are enslaved by an other port | |
47 | local port | |
48 | for port in $(port_list); do | |
49 | list_append ports_in_use $(port_get_slaves "${port}") | |
50 | done | |
51 | ||
52 | list_sort ${ports_in_use} | |
53 | } | |
54 | ||
1c6a4e30 | 55 | port_list_free() { |
bae37360 MT |
56 | local ports_in_use="$(port_list_in_use)" |
57 | ||
58 | local port | |
59 | for port in $(port_list); do | |
60 | if ! list_match "${port}" ${ports_in_use}; then | |
61 | print "${port}" | |
62 | fi | |
63 | done | |
64 | ||
65 | return ${EXIT_OK} | |
66 | } | |
67 | ||
1c6a4e30 | 68 | port_get_hook() { |
49ec20d8 MT |
69 | local port=${1} |
70 | assert isset port | |
71 | ||
72 | config_get_hook $(port_file ${port}) | |
73 | } | |
74 | ||
1c6a4e30 | 75 | port_config_dir() { |
49ec20d8 MT |
76 | local port=${1} |
77 | ||
78 | print "${RUN_DIR}/ports/${port}" | |
79 | return ${EXIT_OK} | |
80 | } | |
81 | ||
1c6a4e30 | 82 | port_settings_read() { |
e9df08ad | 83 | local port="${1}" |
49ec20d8 MT |
84 | assert isset port |
85 | ||
86 | # Save the HOOK variable. | |
87 | local hook="${HOOK}" | |
88 | ||
1e6f187e | 89 | settings_read "$(port_file "${port}")" ${HOOK_SETTINGS} |
49ec20d8 MT |
90 | |
91 | # Restore hook. | |
92 | HOOK="${hook}" | |
93 | } | |
94 | ||
1c6a4e30 | 95 | port_settings_write() { |
e9df08ad | 96 | local port="${1}" |
49ec20d8 | 97 | assert isset port |
e9df08ad | 98 | shift |
49ec20d8 | 99 | |
1e6f187e MT |
100 | local args |
101 | if function_exists "hook_check_settings"; then | |
102 | list_append args "--check=\"hook_check_settings\"" | |
103 | fi | |
104 | list_append args ${HOOK_SETTINGS} | |
105 | ||
106 | settings_write "$(port_file "${port}")" ${args} | |
49ec20d8 MT |
107 | } |
108 | ||
1c6a4e30 | 109 | ports_get_all() { |
bae37360 | 110 | port_list |
8895cf8f MT |
111 | } |
112 | ||
1c6a4e30 | 113 | port_file() { |
e9df08ad | 114 | local port="${1}" |
711ffac1 MT |
115 | assert isset port |
116 | ||
af51d3a9 | 117 | echo "$(port_dir ${port})/settings" |
711ffac1 MT |
118 | } |
119 | ||
1c6a4e30 | 120 | port_exists() { |
711ffac1 MT |
121 | local port=${1} |
122 | ||
af51d3a9 | 123 | [ -d "${NETWORK_CONFIG_DIR}/ports/${port}" ] |
711ffac1 MT |
124 | } |
125 | ||
1c6a4e30 | 126 | port_get_hook() { |
711ffac1 MT |
127 | local port=${1} |
128 | ||
129 | assert isset port | |
130 | ||
131 | config_get_hook $(port_file ${port}) | |
132 | } | |
133 | ||
1c6a4e30 | 134 | port_is_attached() { |
711ffac1 MT |
135 | local port=${1} |
136 | shift | |
137 | ||
138 | assert isset port | |
139 | ||
140 | local zone | |
141 | for zone in $(zones_get_all); do | |
8c9205b1 | 142 | if list_match ${port} $(zone_get_ports ${zone}); then |
711ffac1 MT |
143 | echo "${zone}" |
144 | return ${EXIT_OK} | |
145 | fi | |
146 | done | |
147 | ||
148 | return ${EXIT_ERROR} | |
149 | } | |
150 | ||
1c6a4e30 | 151 | port_is_up() { |
2212045f | 152 | device_is_up "$@" |
abba34c1 MT |
153 | } |
154 | ||
1c6a4e30 | 155 | port_new() { |
ed75c16d | 156 | local hook="${1}" |
711ffac1 MT |
157 | shift |
158 | ||
ed75c16d | 159 | if ! hook_exists port "${hook}"; then |
711ffac1 MT |
160 | error "Port hook '${hook}' does not exist." |
161 | return ${EXIT_ERROR} | |
162 | fi | |
163 | ||
2212045f | 164 | hook_exec port "${hook}" new "$@" |
711ffac1 MT |
165 | } |
166 | ||
1c6a4e30 | 167 | port_destroy() { |
711ffac1 | 168 | local port=${1} |
711ffac1 MT |
169 | assert isset port |
170 | ||
ab5edf53 MT |
171 | # Cannot delete a port that does not exist |
172 | if ! port_exists ${port}; then | |
173 | error "No such port: ${port}" | |
174 | return ${EXIT_ERROR} | |
175 | fi | |
711ffac1 | 176 | |
98f4dae6 | 177 | local attached_zone=$(port_is_attached ${port}) |
711ffac1 | 178 | if [ -n "${attached_zone}" ]; then |
27fff860 MT |
179 | if ! zone_port_detach "${attached_zone}" "${port}"; then |
180 | error "Could not remove port ${port} from zone ${zone}" | |
181 | return ${EXIT_ERROR} | |
182 | fi | |
98f4dae6 MT |
183 | fi |
184 | ||
185 | # Check if the port is linked to any other port and don't allow the user | |
186 | # to delete it. | |
187 | local other_port | |
188 | for other_port in $(ports_get); do | |
189 | [ "${other_port}" = "${port}" ] && continue | |
190 | ||
8c9205b1 | 191 | if list_match ${port} $(port_get_children ${other_port}); then |
7e2b4356 MT |
192 | log ERROR "Cannot destroy port '${port}' which is child of port '${other_port}'." |
193 | return ${EXIT_ERROR} | |
98f4dae6 MT |
194 | fi |
195 | done | |
196 | ||
54c790c2 MT |
197 | # Shut down the port before destroying it |
198 | if ! port_remove "${port}"; then | |
199 | return ${EXIT_ERROR} | |
200 | fi | |
711ffac1 | 201 | |
af51d3a9 | 202 | rm -rf $(port_dir ${port}) |
711ffac1 MT |
203 | } |
204 | ||
1c6a4e30 | 205 | port_create() { |
2212045f | 206 | port_cmd "create" "$@" |
1ba6a2bb MT |
207 | } |
208 | ||
1c6a4e30 | 209 | port_remove() { |
1ba6a2bb MT |
210 | local port="${1}" |
211 | assert isset port | |
212 | ||
270aab39 MT |
213 | if ! port_exists "${port}"; then |
214 | log ERROR "Port ${port} does not exist" | |
215 | return ${EXIT_ERROR} | |
216 | fi | |
217 | ||
1ba6a2bb MT |
218 | # If the device is still up, we need to bring it down first. |
219 | if device_is_up "${port}"; then | |
220 | port_down "${port}" | |
221 | fi | |
222 | ||
223 | port_cmd "remove" "${port}" | |
f90e550b MT |
224 | } |
225 | ||
270aab39 MT |
226 | # Restarts the port by removing it and then re-creating it |
227 | port_restart() { | |
228 | local port="${1}" | |
229 | assert isset port | |
230 | ||
231 | port_remove "${port}" | |
232 | ||
233 | port_create "${port}" | |
234 | } | |
235 | ||
1c6a4e30 | 236 | port_edit() { |
2212045f | 237 | port_cmd edit "$@" |
711ffac1 MT |
238 | } |
239 | ||
1c6a4e30 | 240 | port_up() { |
f28e991c MT |
241 | assert [ $# -eq 1 ] |
242 | ||
243 | local port="${1}" | |
244 | ||
245 | # Check if the port exists | |
246 | if ! device_exists "${port}"; then | |
247 | log ERROR "Could not bring up port ${port} which has not been created" | |
248 | return ${EXIT_ERROR} | |
249 | fi | |
250 | ||
251 | port_cmd up "${port}" | |
711ffac1 MT |
252 | } |
253 | ||
1c6a4e30 | 254 | port_down() { |
2212045f | 255 | port_cmd down "$@" |
711ffac1 MT |
256 | } |
257 | ||
1c6a4e30 | 258 | port_status() { |
2212045f | 259 | port_cmd status "$@" |
711ffac1 MT |
260 | } |
261 | ||
1c6a4e30 | 262 | port_cmd() { |
711ffac1 MT |
263 | local cmd=${1} |
264 | local port=${2} | |
265 | shift 2 | |
266 | ||
267 | assert isset cmd | |
268 | assert isset port | |
269 | ||
270 | local hook=$(port_get_hook ${port}) | |
271 | ||
0c949dd5 MT |
272 | # Abort if we could not find a hook |
273 | if ! isset hook; then | |
274 | log CRITICAL "Port ${port} does not have a hook associated with it" | |
275 | return ${EXIT_ERROR} | |
276 | fi | |
711ffac1 | 277 | |
2212045f | 278 | hook_exec port ${hook} ${cmd} ${port} "$@" |
711ffac1 | 279 | } |
f90e550b | 280 | |
1c6a4e30 | 281 | ports_get() { |
f90e550b MT |
282 | local port |
283 | for port in $(port_dir)/*; do | |
284 | port=$(basename ${port}) | |
285 | if port_exists ${port}; then | |
286 | echo "${port}" | |
287 | fi | |
288 | done | |
289 | } | |
2ae0fb8d | 290 | |
1c6a4e30 | 291 | port_find_free() { |
d76f5107 MT |
292 | local pattern=${1} |
293 | ||
294 | assert isset pattern | |
295 | ||
296 | local port | |
297 | local i=0 | |
298 | ||
299 | while [ ${i} -lt 99 ]; do | |
300 | port=${pattern//N/${i}} | |
301 | if ! port_exists ${port} && ! device_exists ${port}; then | |
302 | echo "${port}" | |
a1a8f0f4 | 303 | return ${EXIT_OK} |
d76f5107 MT |
304 | fi |
305 | i=$(( ${i} + 1 )) | |
306 | done | |
a1a8f0f4 MT |
307 | |
308 | return ${EXIT_ERROR} | |
d76f5107 | 309 | } |
98f4dae6 | 310 | |
1c6a4e30 | 311 | port_get_children() { |
98f4dae6 MT |
312 | local port=${1} |
313 | ||
7da8cf02 MT |
314 | assert port_exists "${port}" |
315 | ||
316 | port_cmd "children" "${port}" | |
98f4dae6 | 317 | } |
3a7fef62 | 318 | |
1c6a4e30 | 319 | port_zone() { |
3a7fef62 MT |
320 | # Get name of the zones, this port is configured in. |
321 | local port=${1} | |
322 | shift | |
323 | ||
324 | assert isset port | |
325 | ||
326 | local zone | |
327 | for zone in $(zones_get_all); do | |
328 | if zone_has_port ${zone} ${port}; then | |
329 | echo "${zone}" | |
330 | return ${EXIT_OK} | |
331 | fi | |
332 | done | |
333 | ||
334 | return ${EXIT_OK} | |
335 | } | |
b8026986 | 336 | |
1c6a4e30 | 337 | port_hotplug_event() { |
b8026986 MT |
338 | local port="${1}" |
339 | assert isset port | |
340 | ||
341 | hotplug_assert_in_hotplug_event | |
342 | ||
343 | port_cmd "hotplug" "${port}" | |
344 | } | |
345 | ||
1c6a4e30 | 346 | port_get_slaves() { |
b8026986 MT |
347 | local port="${1}" |
348 | ||
349 | port_settings_read "${port}" \ | |
350 | --ignore-superfluous-settings SLAVES | |
351 | print "${SLAVES}" | |
352 | } | |
353 | ||
1c6a4e30 | 354 | port_device_is_slave() { |
b8026986 MT |
355 | assert [ $# -eq 2 ] |
356 | ||
357 | local port="${1}" | |
358 | local device="${2}" | |
359 | ||
360 | # Get slaves of port | |
361 | local slaves="$(port_get_slaves "${port}")" | |
362 | ||
363 | # Returns true if device is in slaves | |
364 | list_match "${device}" ${slaves} | |
365 | } | |
366 | ||
1c6a4e30 | 367 | port_get_phy() { |
b8026986 MT |
368 | local port="${1}" |
369 | ||
370 | port_settings_read "${port}" \ | |
371 | --ignore-superfluous-settings PHY | |
372 | print "${PHY}" | |
373 | } | |
374 | ||
1c6a4e30 | 375 | port_uses_phy() { |
b8026986 MT |
376 | assert [ $# -eq 2 ] |
377 | ||
378 | local port="${1}" | |
379 | local phy="${2}" | |
380 | ||
381 | # Nothing to do if an empty argument is given | |
382 | if ! isset phy; then | |
383 | return ${EXIT_FALSE} | |
384 | fi | |
385 | ||
386 | phy="$(phy_get_address "${phy}")" | |
387 | ||
388 | local port_phy="$(port_get_phy "${port}")" | |
389 | [ "${port_phy}" = "${phy}" ] | |
390 | } | |
7ad5252c | 391 | |
1c6a4e30 | 392 | ports_lowest_address() { |
7ad5252c MT |
393 | local address |
394 | local addresses | |
395 | ||
396 | local port | |
397 | for port in $(port_list); do | |
398 | # Skip all ports that do not exist | |
399 | # any more or are not plugged in | |
400 | device_exists "${port}" || continue | |
401 | ||
402 | # Skip all ports that are not proper ethernet devices | |
403 | device_is_wireless "${port}" && continue | |
404 | device_is_ethernet "${port}" || continue | |
405 | ||
406 | list_append addresses "$(device_get_address "${port}")" | |
407 | done | |
408 | ||
409 | # Sort the list | |
410 | addresses="$(list_sort ${addresses})" | |
411 | ||
412 | # Get the first element which is the lowest MAC address | |
413 | list_head ${addresses} | |
414 | } | |
f5ee091e MT |
415 | |
416 | port_identify() { | |
2212045f | 417 | device_identify "$@" |
f5ee091e | 418 | } |
410d2e85 JS |
419 | |
420 | port_get_color() { | |
421 | # This function return the color of a port | |
422 | assert [ $# -eq 1 ] | |
423 | ||
424 | local name=${1} | |
425 | color_read "port" ${name} | |
426 | } | |
5de34b4c JS |
427 | |
428 | port_get_description_title() { | |
429 | assert [ $# -eq 1 ] | |
430 | ||
431 | local name=${1} | |
432 | description_title_read $(description_format_filename "port" "${name}") | |
433 | } |