]> git.ipfire.org Git - people/stevee/network.git/blob - functions.config
Bump version to 006.
[people/stevee/network.git] / functions.config
1 #!/bin/bash
2 ###############################################################################
3 # #
4 # IPFire.org - A linux based firewall #
5 # Copyright (C) 2012 IPFire Network Development Team #
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 # Load all global configuration files.
23 function config_read_globals() {
24 network_config_read
25 firewall_config_read
26 }
27
28 function config_read() {
29 local file=${1}
30 assert isset file
31 shift
32
33 local valid_keys=$@
34
35 # Exit if the file cannot be read.
36 [ -r "${file}" ] || return ${EXIT_ERROR}
37
38 local line key val
39 while read -r line; do
40 case "${line}" in
41 *=*)
42 key=$(cli_get_key ${line})
43
44 # If valid keys is set, key must be in the list.
45 if [ -n "${valid_keys}" ]; then
46 if ! listmatch ${key} ${valid_keys}; then
47 log DEBUG "Ignoring configuration setting: ${key}"
48 continue
49 fi
50 fi
51
52 val=$(cli_get_val ${line})
53 val=$(config_strip ${val})
54
55 # Assign variable.
56 printf -v ${key} "%s" "${val}"
57 ;;
58 *)
59 log DEBUG "Invalid line in configuration file: ${line}"
60 ;;
61 esac
62 done < ${file}
63 }
64
65 function config_read_array() {
66 local file=${1}
67 assert isset file
68 shift
69
70 local array=${1}
71 assert isset array
72 shift
73
74 local valid_keys=$@
75
76 # Exit if the file cannot be read.
77 [ -r "${file}" ] || return ${EXIT_ERROR}
78
79 local line key val
80 while read -r line; do
81 case "${line}" in
82 *=*)
83 key=$(cli_get_key ${line})
84
85 # If valid_keys is set, key must be in the list.
86 if [ -n "${valid_keys}" ]; then
87 if ! listmatch ${key} ${valid_keys}; then
88 log DEBUG "Ignoring configuration setting: ${key}"
89 continue
90 fi
91 fi
92
93 val=$(cli_get_val ${line})
94 val=$(config_strip ${val})
95
96 # Assign variable.
97 printf -v "${array}["${key}"]" "%s" "${val}"
98 ;;
99 *)
100 log DEBUG "Invalid line in configuration file: ${line}"
101 ;;
102 esac
103 done < ${file}
104 }
105
106 # Strip leading and trailing "s.
107 function config_strip() {
108 local var="$@"
109
110 # Do nothing for strings that contain spaces.
111 if contains_spaces ${var}; then
112 print "${var}"
113 return ${EXIT_OK}
114 fi
115
116 unquote "${var}"
117 }
118
119 function config_write() {
120 local config_file=${1}
121 assert isset config_file
122 shift
123
124 # Check if all values to be written are sane
125 config_check
126
127 log DEBUG "Writing configuration file ${config_file}."
128
129 mkdir -p $(dirname ${config_file}) 2>/dev/null
130 > ${config_file}
131
132 local param
133 for param in $(listsort $@); do
134 echo "${param}=\"${!param}\"" >> ${config_file}
135 done
136 }
137
138 function config_print() {
139 local param
140
141 for param in $(listsort $@); do
142 printf "%-24s = %s\n" "${param}" "${!param}"
143 done
144 }
145
146 function config_check() {
147 # If there is a function defined that is called __check
148 # we call that function
149 [ -n "$(type -t _check)" ] && _check
150 }
151
152 function config_header() {
153 local what=${1}
154 assert isset what
155
156 # Print the header.
157 echo "#"
158 echo "# This is a ${what}."
159 echo "# THIS FILE IS AUTOMATICALLY GENERATED AND"
160 echo "# ANY CUSTOM CHANGES WILL BE OVERWRITTEN!"
161 echo "#"
162 echo "# $(date -u)"
163 echo "#"
164 echo
165 }
166
167 function config_hostname() {
168 local hostname=${1}
169
170 if [ -n "${hostname}" ]; then
171 echo "${hostname}" > ${CONFIG_HOSTNAME}
172 else
173 echo "$(<${CONFIG_HOSTNAME})"
174 fi
175 }
176
177 function config_domainname() {
178 local hostname=$(config_hostname)
179
180 # Strip off the hostname part and just return
181 # the domain part.
182 print "${hostname#*.}"
183 }
184
185 function config_set() {
186 while [ $# -gt 0 ]; do
187 case "${1}" in
188 *=*)
189 local key=$(cli_get_key ${1})
190 local val=$(cli_get_val ${1})
191
192 log INFO "Setting configuration option '${key}=${val}'".
193
194 printf -v ${key} "%s" "${val}"
195 ;;
196 *)
197 warning "Invalid parameter given: ${1}"
198 ;;
199 esac
200 shift
201 done
202 }
203
204 function network_config_read() {
205 local options=${NETWORK_CONFIG_FILE_PARAMS}
206
207 # If the DEBUG variable has already been set,
208 # don't overwrite it.
209 if [ -n "${DEBUG}" ]; then
210 list_remove options DEBUG
211 fi
212
213 config_read ${NETWORK_CONFIG_FILE} ${options}
214 }
215
216 function network_config_write() {
217 config_write ${NETWORK_CONFIG_FILE} ${NETWORK_CONFIG_FILE_PARAMS}
218
219 # Update DNS configuration.
220 dns_generate_resolvconf
221 }
222
223 function network_config_print() {
224 config_print ${NETWORK_CONFIG_FILE_PARAMS}
225 }
226
227 function firewall_config_read() {
228 config_read ${FIREWALL_CONFIG_FILE} ${FIREWALL_CONFIG_PARAMS}
229 }
230
231 function firewall_config_write() {
232 config_write ${FIREWALL_CONFIG_FILE} \
233 ${FIREWALL_CONFIG_PARAMS}
234 }
235
236 function firewall_config_print() {
237 config_print ${FIREWALL_CONFIG_PARAMS}
238 }