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