2 ###############################################################################
4 # IPFire.org - A linux based firewall #
5 # Copyright (C) 2010 Michael Tremer & Christian Schmidt #
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. #
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. #
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/>. #
20 ###############################################################################
22 function cli_config
() {
23 if cli_help_requested $@
; then
28 if [ -n "${1}" ]; then
35 function cli_device
() {
36 if device_config_exists
${1}; then
43 device_
${action} ${device} $@
56 echo "# XXX need to implement --raw here"
58 for device
in ${devices}; do
59 cli_device_discover
${device} $@
65 for device
in $
(device_get $@
); do
66 device_print
${device}
76 function cli_device_discover
() {
80 local device_type
=$
(device_get_type
${device})
81 if [ "${device_type}" != "real" ]; then
87 while [ $# -gt 0 ]; do
97 device_is_up
${device} && up
=1
98 device_set_up
${device}
100 enabled raw ||
echo "${device}"
105 for hook
in $
(hook_zone_get_all
); do
106 out
=$
(hook_zone_exec
${hook} discover
${device})
109 [ ${ret} -eq ${DISCOVER_NOT_SUPPORTED} ] && continue
117 echo "${hook}: ${line}"
122 echo "${hook}: FAILED"
128 echo " ${hook} was successful."
136 echo " ${hook} failed."
144 [ "${up}" = "1" ] || device_set_down
${device}
147 function cli_port
() {
148 if cli_help_requested $@
; then
156 if port_exists
${1}; then
176 port_
${action} ${port} $@
179 error
"Unrecognized argument: ${action}"
192 error
"Unrecognized argument: ${action}"
199 function cli_zone
() {
200 if cli_help_requested $@
; then
208 if zone_name_is_valid
${1}; then
227 config|down|edit|port|status|up
)
228 zone_
${action} ${zone} $@
231 error
"Unrecognized argument: ${action}"
232 cli_usage root-zone-subcommands
245 if [ -n "${action}" ]; then
246 error
"Unrecognized argument: '${action}'"
257 function cli_start
() {
258 if cli_help_requested $@
; then
263 local zones
=$
(zones_get $@
)
266 for zone
in ${zones}; do
271 function cli_stop
() {
272 if cli_help_requested $@
; then
277 local zones
=$
(zones_get $@
)
280 for zone
in ${zones}; do
285 function cli_restart
() {
286 if cli_help_requested $@
; then
287 cli_usage root-restart
293 # Give the system some time to calm down
294 sleep ${TIMEOUT_RESTART}
299 function cli_status
() {
300 if cli_help_requested $@
; then
301 cli_usage root-status
305 local zones
=$
(zones_get $@
)
308 for zone
in ${zones}; do
313 function cli_help_requested
() {
315 for argument
in ${1}; do
316 if [ "${argument}" = "help" -o "${argument}" = "-h" -o "${argument}" = "--help" ]; then
324 function cli_usage
() {
329 echo "${0}: [command] <options ...>"
333 echo " restart - ..."
343 echo "${0}: ${what#root-} [KEY=VAL, ...]"
345 echo " This command allows setting of global configuration parameters."
347 echo " If no additional arguments are passed it will list the current configuration."
349 echo " You can overwrite the settings like the following:"
351 echo " ${0} ${what#root-} DEBUG=1 ..."
354 root-start|root-stop|root-restart
)
355 echo "${0}: ${what#root-} [--local-only|--remote-only|--all|<zone>...]"
357 echo " This commands ${what#root-}s all zones by default."
358 echo " One can pass several parameters to only process a subset of all"
359 echo " available zones:"
361 echo -e " ${COLOUR_BOLD}--local-only${COLOUR_NORMAL}"
362 echo " Process all local zones which includes every zone without red."
364 echo -e " ${COLOUR_BOLD}--remote-only${COLOUR_NORMAL}"
365 echo " Process all remote zones which means only the red ones."
367 echo -e " ${COLOUR_BOLD}--all${COLOUR_NORMAL}"
368 echo " Process all zones. This is the default parameter."
370 echo " Additionally, you can pass one or more zone names which will"
371 echo " be processed."
375 echo "${0}: ${what#root-} [--local-only|--remote-only|--all|<zone>...]"
377 echo " This commands shows status information of all zones by default."
378 echo " One can pass several parameters to only process a subset of all"
379 echo " available zones:"
381 echo -e " ${COLOUR_BOLD}--local-only${COLOUR_NORMAL}"
382 echo " Process all local zones which includes every zone without red."
384 echo -e " ${COLOUR_BOLD}--remote-only${COLOUR_NORMAL}"
385 echo " Process all remote zones which means only the red ones."
387 echo -e " ${COLOUR_BOLD}--all${COLOUR_NORMAL}"
388 echo " Process all zones. This is the default parameter."
390 echo " Additionally, you can pass one or more zone names which will"
391 echo " be processed."
395 echo "${0}: ${what#root-} <create|remove> <zone> [<type> <options...>]"
397 echo " Create or remove a zone."
399 echo -e " ${COLOUR_BOLD}create <zone> <type> <options>${COLOUR_NORMAL}"
400 echo " Create a new zone of type <type> where <zone> is an allowed"
403 echo -e " ${COLOUR_BOLD}remove <zone>${COLOUR_NORMAL}"
404 echo " Remove the zone <zone>."
406 echo " You may also edit the configuration of the zones."
408 echo -e " ${COLOUR_BOLD}<zone> ...${COLOUR_NORMAL}"
409 echo " Edit the zone <zone>."
414 echo " Run '${0} help' to get information how to use this tool."
418 error
"No help available for this command '${what}'."
423 echo "Network configuration tool. Report all bugs to <http://bugs.ipfire.org>."
426 function cli_status_headline
() {
429 local state
="${COLOUR_DOWN}DOWN${COLOUR_NORMAL}"
430 zone_is_up
${zone} && state="${COLOUR_UP}UP${COLOUR_NORMAL}"
432 echo -e "${zone} - ${state} - $(zone_get_hook ${zone})"
435 function cli_headline() {
437 echo -e "${COLOUR_BOLD}$@
${COLOUR_NORMAL}"