add new /bin/uci script and api for manipulating buildroot-ng config files
authorFelix Fietkau <nbd@openwrt.org>
Mon, 9 Oct 2006 05:59:26 +0000 (05:59 +0000)
committerFelix Fietkau <nbd@openwrt.org>
Mon, 9 Oct 2006 05:59:26 +0000 (05:59 +0000)
SVN-Revision: 4982

openwrt/package/base-files/default/bin/uci [new file with mode: 0755]
openwrt/package/base-files/default/etc/functions.sh
openwrt/package/base-files/default/lib/config/uci-update.awk [new file with mode: 0644]
openwrt/package/base-files/default/lib/config/uci.sh [new file with mode: 0755]

diff --git a/openwrt/package/base-files/default/bin/uci b/openwrt/package/base-files/default/bin/uci
new file mode 100755 (executable)
index 0000000..7f43549
--- /dev/null
@@ -0,0 +1,159 @@
+#!/bin/sh
+# Shell script for interacting with config files
+#
+# Copyright (C) 2006 by Fokus Fraunhofer <carsten.tittel@fokus.fraumhofer.de>
+# Copyright (C) 2006 by Felix Fietkau <nbd@openwrt.org>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+. /etc/functions.sh
+include /lib/config
+
+do_get() {
+       [ $# -ne 3 ] && {
+               uci_usage get
+               exit 1
+       }
+       local PACKAGE="$1"
+       local CONFIG="$2"
+       local OPTION="$3"
+
+       uci_load "$PACAKGE"
+       config_get "$CONFIG" "$OPTION"
+}
+
+do_set() {
+       [ $# -ne 4 ] && {
+               uci_usage set
+               exit 1
+       }
+       uci_set "$@"
+}
+
+do_add() {
+       [ $# -ne 3 ] && {
+               uci_usage add
+               exit 1
+       }
+       uci_add "$@"
+}
+
+do_rename() {
+       [ $# -ne 3 ] && {
+               uci_usage rename
+               exit 1
+       }
+       uci_rename "$@"
+}
+
+do_remove() {
+       [ $# -ne 3 -a $# -ne 2 ] && {
+               uci_usage rename
+               exit 1
+       }
+       uci_remove "$@"
+}
+
+do_commit() {
+       [ $# -ne 1 ] && {
+               uci_usage commit
+               exit 1
+       }
+       uci_commit "$1"
+}
+
+do_show() {
+       [ $# -gt 2 -o $# -lt 1 ] && {
+               uci_usage show
+               exit 1
+       }
+       
+       PACKAGE="$1"
+       CONFIG="$2"
+       SECTION=""
+       
+       config_cb() {
+               if [ -z "$CONFIG" -o "$CONFIG" = "$2" ]; then
+                       append SECTION "$2"
+                       option_cb() {
+                               append "${CONFIG_SECTION}_VARS" "$1"
+                       }
+               else
+                       option_cb() {
+                               return 0
+                       }
+               fi
+       }
+                       
+       uci_load "$PACKAGE"
+       
+       for section in $SECTION; do
+               config_get type "$section" TYPE
+               [ -z "$type" ] && continue
+               echo "@$section=$type"
+               eval "VARS=\"\${${section}_VARS}\""
+               for var in $VARS; do
+                       config_get val "$section" "$var"
+                       [ -n "$val" ] && {
+                               echo "${section}.${var}=${val}"
+                               config_set "$section" "$var" ""
+                       }
+               done
+               config_set "$section" TYPE ""
+       done
+}
+
+uci_usage() {
+       case "$1" in
+               show) echo "$0 show <package> [<config>]";;
+               get) echo "$0 get <package> <config> <option>";;
+               set) echo "$0 set <package> <config> <option> <value>";;
+               add) echo "$0 add <package> <type> <config>";;
+               del) echo "$0 del <package> <config> [<option>]";;
+               rename) echo "$0 rename <package> <config> <name>";;
+               commit) echo "$0 commit <package>";;
+               *) 
+                       echo "Syntax: $0 <command> <arguments...>"
+                       echo
+                       uci_usage show
+                       uci_usage get
+                       uci_usage set
+                       uci_usage add
+                       uci_usage del
+                       uci_usage rename
+                       uci_usage commit
+                       echo
+                       exit 1
+               ;;
+       esac
+}
+
+if [ $# -eq 0 ] ; then
+       uci_usage
+       exit 0
+fi
+CMD="$1"
+shift
+case "$CMD" in
+       set) do_set "$@";;
+       add) do_add "$@";;
+       del) do_remove "$@";;
+       rename) do_rename "$@";;
+       get) do_get "$@";;
+       show) do_show "$@";;
+       commit) do_commit "$@";;
+       *) uci_usage;;
+esac
+exit 0
index 2ce172e..9c3057e 100755 (executable)
@@ -54,6 +54,26 @@ option () {
        option_cb "$varname" "$*"
 }
 
+config_rename() {
+       local OLD="$1"
+       local NEW="$2"
+       local oldsetting
+       local newvar
+       
+       [ -z "$OLD" -o -z "$NEW" ] && return
+       for oldsetting in `set | grep ^CONFIG_${OLD}_ | \
+               sed -e 's/\(.*\)=.*$/\1/'` ; do
+               newvar="CONFIG_${NEW}_${oldsetting##CONFIG_${OLD}_}"
+               eval "${newvar}=\${$oldsetting}"
+               unset "$oldsetting"
+       done
+       [ "$CONFIG_SECTION" = "$OLD" ] && CONFIG_SECTION="$NEW"
+}
+
+config_unset() {
+       config_set "$1" "$2" ""
+}
+
 config_clear() {
        [ -z "$CONFIG_SECTION" ] && return
        for oldsetting in `set | grep ^CONFIG_${CONFIG_SECTION}_ | \
@@ -79,7 +99,7 @@ config_load() {
 
 config_get() {
        case "$3" in
-               "") eval "echo \${CONFIG_${1}_${2}}";;
+               "") eval "echo \"\${CONFIG_${1}_${2}}\"";;
                *) eval "$1=\"\${CONFIG_${2}_${3}}\"";;
        esac
 }
diff --git a/openwrt/package/base-files/default/lib/config/uci-update.awk b/openwrt/package/base-files/default/lib/config/uci-update.awk
new file mode 100644 (file)
index 0000000..efa8758
--- /dev/null
@@ -0,0 +1,160 @@
+# Configuration update functions
+#
+# Copyright (C) 2006 by Fokus Fraunhofer <carsten.tittel@fokus.fraunhofer.de>
+# Copyright (C) 2006 by Felix Fietkau <nbd@openwrt.org>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+
+function read_file(filename,  result) {
+       while ((getline <filename) == 1) {
+               result = result $0 "\n"
+       }
+       gsub(/\n*$/, "", result)
+       return result
+}
+
+function cmd2option(str,  tmp) {
+       if (match(str,"=")!=0) {
+               res = "\toption " substr(str,1,RSTART-1) "\t'" substr(str,RSTART+1) "'"
+       } else {
+               res= ""
+       }
+       return res
+}
+
+function cmd2config(atype,  aname) {
+       return "config \"" atype "\" \"" aname "\""
+}
+
+function update_config(cfg, update,  \
+  lines, line, l, n, i, i2, section, scnt, remove, tmp, aidx, rest) {
+       scnt = 1
+       linecnt=split(cfg "\n", lines, "\n")
+
+       cfg = ""
+       for (n = 1; n < linecnt; n++) {
+               # stupid parser for quoted arguments (e.g. for the type string).
+               # not to be used to gather variable values (backslash escaping doesn't work)
+               line = lines[n]
+               gsub(/^[ \t]*/, "", line)
+               gsub(/#.*$/, "", line)
+               i2 = 1
+               delete l
+               rest = line
+               while (length(rest)) {
+                       if (match(rest, /[ \t\"]+/)) {
+                               if (RSTART>1) {
+                                       l[i2] = substr(rest,1,RSTART-1)
+                                       i2++
+                               }
+                               aidx=index(rest,"\"")
+                               if (aidx>=RSTART && aidx<=RSTART+RLENGTH) {
+                                       rest=substr(rest,aidx+1)
+                                       # find the end of the string
+                                       match(rest,/\"/)
+                                       l[i2]=substr(rest,1,RSTART-1)
+                                       i2++
+                               }
+                               rest=substr(rest,RSTART+RLENGTH)
+                       } else {
+                               l[i2] = rest
+                               i2++
+                               rest = ""
+                       }
+               }
+               line = lines[n]
+               
+               # when a command wants to set a config value for the current
+               # section and a blank line is encountered before an option with
+               # the same name, insert it here to maintain some coherency between
+               # manually and automatically created option lines
+               # if an option with the same name appears after this point, simply
+               # ignore it, because it is already set.
+               if ((section != "") && (l[1] != "option")) {
+                       if (line ~ /^[ \t]*$/) {
+                               if (update ~ "^" section "\\.") {
+                                       gsub("^" section ".", "", update)
+                                       cfg = cfg cmd2option(update) "\n"
+                                       gsub(/=.*$/, "", update)
+                                       update = "-" section "." update
+                               }
+                       }
+               }
+
+               if (l[1] == "config") {
+                       # look for all unset values
+                       if (section != "") {
+                               flag=0
+                               if (update ~ "^" section "\\.") {
+                                       flag=1
+                                       gsub("^" section ".", "", update)
+                                       cfg = cfg cmd2option(update) "\n"
+                                       
+                                       update = "-" section "." update
+                               } 
+                               if (flag!=0) cfg = cfg "\n"
+                       }
+                       
+                       remove = ""
+                       section = l[3]
+                       if (!length(section)) {
+                               section = "cfg" scnt
+                       }       
+                       scnt++
+                       if (update == "-" section) {
+                               remove = "section"
+                               update = ""
+                       } else if (update ~ "^@" section "=") {
+                               update = ""
+                       } else if (update ~ "^&" section "=") {
+                               gsub("^&" section "=", "", update)
+                               line = cmd2config(l[2],update) 
+                               update = ""
+                       }
+               }
+               if (remove == "option") remove = ""
+               if (l[1] == "option") {
+                       if (update ~ "^-" section "\\." l[2] "$") remove = "option"
+                       # if a supplied config value already exists, replace the whole line
+                       if (match(update, "^" section "." l[2] "=")) {
+                               gsub("^" section ".", "", update)
+                               line = cmd2option(update)
+                               update = ""
+                       }
+               }
+               if (remove == "") cfg = cfg line "\n"
+       }
+       
+       # any new options for the last section??
+       if (section != "") {
+               if (update ~ "^" section "\\.") {
+                       gsub("^" section ".", "", update)
+                       cfg = cfg cmd2option(update) "\n"
+
+                       update = "-" section "." update
+               } 
+       }
+
+       if (update ~ "^@") {
+               # new section
+               section = stype = substr(update,2)
+               gsub(/=.*$/,"",section)
+               gsub(/^.*=/,"",stype)
+               cfg = cfg "\nconfig \"" stype "\" \"" section "\"\n"
+       }
+
+       return cfg
+}
diff --git a/openwrt/package/base-files/default/lib/config/uci.sh b/openwrt/package/base-files/default/lib/config/uci.sh
new file mode 100755 (executable)
index 0000000..ccd6ee5
--- /dev/null
@@ -0,0 +1,138 @@
+#!/bin/sh
+# Shell script defining macros for manipulating config files
+#
+# Copyright (C) 2006 by Fokus Fraunhofer <carsten.tittel@fokus.fraumhofer.de>
+# Copyright (C) 2006 by Felix Fietkau <nbd@openwrt.org>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+uci_load() {
+       config_load "$PACKAGE"
+       local PACKAGE_BASE="$(basename "$PACKAGE")"
+       [ -f "/tmp/.uci/${PACKAGE_BASE}" ] && {
+               . "/tmp/.uci/${PACKAGE_BASE}"
+               config_cb
+       }
+}
+
+uci_do_update() {
+       local FILENAME="$1"
+       local UPDATE="$2"
+       awk -f /lib/config/uci-update.awk -f - <<EOF
+BEGIN {
+       config = read_file("$FILENAME")
+       $UPDATE
+       print config
+}
+EOF
+}
+
+uci_add_update() {
+       local PACKAGE="$1"
+       local UPDATE="$2"
+       local PACKAGE_BASE="$(basename "$PACKAGE")"
+       
+       # FIXME: add locking?
+       mkdir -p "/tmp/.uci"
+       echo "$UPDATE" >> "/tmp/.uci/${PACKAGE_BASE}"
+}
+
+uci_set() {
+       local PACKAGE="$1"
+       local CONFIG="$2"
+       local OPTION="$3"
+       local VALUE="$4"
+
+       ( # spawn a subshell so you don't mess up the current environment
+               uci_load "$PACKAGE"
+               config_get type "$CONFIG" TYPE
+               [ -z "$type" ]
+       ) || uci_add_update "$PACKAGE" "CONFIG_SECTION='$CONFIG'${N}option '$OPTION' '$VALUE'"
+}
+
+uci_add() {
+       local PACKAGE="$1"
+       local TYPE="$2"
+       local CONFIG="$3"
+
+       uci_add_update "$PACKAGE" "config '$TYPE' '$CONFIG'"
+}
+
+uci_rename() {
+       local PACKAGE="$1"
+       local CONFIG="$2"
+       local VALUE="$3"
+
+       uci_add_update "$PACKAGE" "config_rename '$CONFIG' '$VALUE'"
+}
+
+uci_remove() {
+       local PACKAGE="$1"
+       local CONFIG="$2"
+       local OPTION="$3"
+
+       if [ -z "$OPTION" ]; then
+               uci_add_update "$PACKAGE" "config_clear '$CONFIG'"
+       else
+               uci_add_update "$PACKAGE" "config_unset '$CONFIG' '$OPTION'"
+       fi
+}
+
+uci_commit() {
+       local PACKAGE="$1"
+       local PACKAGE_BASE="$(basename "$PACKAGE")"
+       
+       mkdir -p /tmp/.uci
+       lock "/tmp/.uci/$PACKAGE_BASE.lock"
+       [ -f "/tmp/.uci/$PACKAGE_BASE" ] && (
+               updatestr=""
+               
+               # replace handlers
+               config() {
+                       append updatestr "config = update_config(config, \"@$2=$1\")" "$N"
+               }
+               option() {
+                       append updatestr "config = update_config(config, \"$CONFIG_SECTION.$1=$2\")" "$N"
+               }
+               config_rename() {
+                       append updatestr "config = update_config(config, \"&$1=$2\")" "$N"
+               }
+               config_unset() {
+                       append updatestr "config = update_config(config, \"-$1.$2\")" "$N"
+               }
+               config_clear() {
+                       append updatestr "config = update_config(config, \"-$1\")" "$N"
+               }
+               
+               . "/tmp/.uci/$PACKAGE_BASE"
+
+               # completely disable handlers so that they don't get in the way
+               config() {
+                       return 0
+               }
+               option() {
+                       return 0
+               }
+               
+               config_load "$PACKAGE" || CONFIG_FILENAME="$ROOT/etc/config/$PACKAGE_BASE"
+               uci_do_update "$CONFIG_FILENAME" "$updatestr" > "/tmp/.uci/$PACKAGE_BASE.new" && {
+                       mv -f "/tmp/.uci/$PACKAGE_BASE.new" "$CONFIG_FILENAME" && \
+                       rm -f "/tmp/.uci/$PACKAGE_BASE"
+               } 
+       )
+       lock -u "/tmp/.uci/$PACKAGE_BASE.lock"
+}
+
+