base-files: remove config_clear() and list_remove()
[openwrt.git] / package / base-files / files / lib / functions.sh
1 #!/bin/sh
2 # Copyright (C) 2006-2013 OpenWrt.org
3 # Copyright (C) 2006 Fokus Fraunhofer <carsten.tittel@fokus.fraunhofer.de>
4 # Copyright (C) 2010 Vertical Communications
5
6
7 debug () {
8         ${DEBUG:-:} "$@"
9 }
10
11 # newline
12 N="
13 "
14
15 _C=0
16 NO_EXPORT=1
17 LOAD_STATE=1
18 LIST_SEP=" "
19
20 append() {
21         local var="$1"
22         local value="$2"
23         local sep="${3:- }"
24
25         eval "export ${NO_EXPORT:+-n} -- \"$var=\${$var:+\${$var}\${value:+\$sep}}\$value\""
26 }
27
28 list_contains() {
29         local var="$1"
30         local str="$2"
31         local val
32
33         eval "val=\" \${$var} \""
34         [ "${val%% $str *}" != "$val" ]
35 }
36
37 config_load() {
38         [ -n "$IPKG_INSTROOT" ] && return 0
39         uci_load "$@"
40 }
41
42 reset_cb() {
43         config_cb() { return 0; }
44         option_cb() { return 0; }
45         list_cb() { return 0; }
46 }
47 reset_cb
48
49 package() {
50         return 0
51 }
52
53 config () {
54         local cfgtype="$1"
55         local name="$2"
56
57         export ${NO_EXPORT:+-n} CONFIG_NUM_SECTIONS=$(($CONFIG_NUM_SECTIONS + 1))
58         name="${name:-cfg$CONFIG_NUM_SECTIONS}"
59         append CONFIG_SECTIONS "$name"
60         [ -n "$NO_CALLBACK" ] || config_cb "$cfgtype" "$name"
61         export ${NO_EXPORT:+-n} CONFIG_SECTION="$name"
62         export ${NO_EXPORT:+-n} "CONFIG_${CONFIG_SECTION}_TYPE=$cfgtype"
63 }
64
65 option () {
66         local varname="$1"; shift
67         local value="$*"
68
69         export ${NO_EXPORT:+-n} "CONFIG_${CONFIG_SECTION}_${varname}=$value"
70         [ -n "$NO_CALLBACK" ] || option_cb "$varname" "$*"
71 }
72
73 list() {
74         local varname="$1"; shift
75         local value="$*"
76         local len
77
78         config_get len "$CONFIG_SECTION" "${varname}_LENGTH" 0
79         [ $len = 0 ] && append CONFIG_LIST_STATE "${CONFIG_SECTION}_${varname}"
80         len=$(($len + 1))
81         config_set "$CONFIG_SECTION" "${varname}_ITEM$len" "$value"
82         config_set "$CONFIG_SECTION" "${varname}_LENGTH" "$len"
83         append "CONFIG_${CONFIG_SECTION}_${varname}" "$value" "$LIST_SEP"
84         list_cb "$varname" "$*"
85 }
86
87 config_rename() {
88         local OLD="$1"
89         local NEW="$2"
90         local oldvar
91         local newvar
92
93         [ -n "$OLD" -a -n "$NEW" ] || return
94         for oldvar in `set | grep ^CONFIG_${OLD}_ | \
95                 sed -e 's/\(.*\)=.*$/\1/'` ; do
96                 newvar="CONFIG_${NEW}_${oldvar##CONFIG_${OLD}_}"
97                 eval "export ${NO_EXPORT:+-n} \"$newvar=\${$oldvar}\""
98                 unset "$oldvar"
99         done
100         export ${NO_EXPORT:+-n} CONFIG_SECTIONS="$(echo " $CONFIG_SECTIONS " | sed -e "s, $OLD , $NEW ,")"
101
102         [ "$CONFIG_SECTION" = "$OLD" ] && export ${NO_EXPORT:+-n} CONFIG_SECTION="$NEW"
103 }
104
105 config_unset() {
106         config_set "$1" "$2" ""
107 }
108
109 # config_get <variable> <section> <option> [<default>]
110 # config_get <section> <option>
111 config_get() {
112         case "$3" in
113                 "") eval echo "\${CONFIG_${1}_${2}:-\${4}}";;
114                 *)  eval export ${NO_EXPORT:+-n} -- "${1}=\${CONFIG_${2}_${3}:-\${4}}";;
115         esac
116 }
117
118 # config_get_bool <variable> <section> <option> [<default>]
119 config_get_bool() {
120         local _tmp
121         config_get _tmp "$2" "$3" "$4"
122         case "$_tmp" in
123                 1|on|true|enabled) _tmp=1;;
124                 0|off|false|disabled) _tmp=0;;
125                 *) _tmp="$4";;
126         esac
127         export ${NO_EXPORT:+-n} "$1=$_tmp"
128 }
129
130 config_set() {
131         local section="$1"
132         local option="$2"
133         local value="$3"
134         local old_section="$CONFIG_SECTION"
135
136         CONFIG_SECTION="$section"
137         option "$option" "$value"
138         CONFIG_SECTION="$old_section"
139 }
140
141 config_foreach() {
142         local ___function="$1"
143         [ "$#" -ge 1 ] && shift
144         local ___type="$1"
145         [ "$#" -ge 1 ] && shift
146         local section cfgtype
147
148         [ -z "$CONFIG_SECTIONS" ] && return 0
149         for section in ${CONFIG_SECTIONS}; do
150                 config_get cfgtype "$section" TYPE
151                 [ -n "$___type" -a "x$cfgtype" != "x$___type" ] && continue
152                 eval "$___function \"\$section\" \"\$@\""
153         done
154 }
155
156 config_list_foreach() {
157         [ "$#" -ge 3 ] || return 0
158         local section="$1"; shift
159         local option="$1"; shift
160         local function="$1"; shift
161         local val
162         local len
163         local c=1
164
165         config_get len "${section}" "${option}_LENGTH"
166         [ -z "$len" ] && return 0
167         while [ $c -le "$len" ]; do
168                 config_get val "${section}" "${option}_ITEM$c"
169                 eval "$function \"\$val\" \"\$@\""
170                 c="$(($c + 1))"
171         done
172 }
173
174 insert_modules() {
175         [ -d /etc/modules.d ] && {
176                 cd /etc/modules.d
177                 sed 's/^[^#]/insmod &/' $* | ash 2>&- || :
178         }
179 }
180
181 include() {
182         local file
183
184         for file in $(ls $1/*.sh 2>/dev/null); do
185                 . $file
186         done
187 }
188
189 find_mtd_index() {
190         local PART="$(grep "\"$1\"" /proc/mtd | awk -F: '{print $1}')"
191         local INDEX="${PART##mtd}"
192
193         echo ${INDEX}
194 }
195
196 find_mtd_part() {
197         local INDEX=$(find_mtd_index "$1")
198         local PREFIX=/dev/mtdblock
199
200         [ -d /dev/mtdblock ] && PREFIX=/dev/mtdblock/
201         echo "${INDEX:+$PREFIX$INDEX}"
202 }
203
204 find_mtd_chardev() {
205         local INDEX=$(find_mtd_index "$1")
206         local PREFIX=/dev/mtd
207
208         [ -d /dev/mtd ] && PREFIX=/dev/mtd/
209         echo "${INDEX:+$PREFIX$INDEX}"
210 }
211
212 mtd_get_mac_ascii()
213 {
214         local mtdname="$1"
215         local key="$2"
216         local part
217         local mac_dirty
218
219         part=$(find_mtd_part "$mtdname")
220         if [ -z "$part" ]; then
221                 echo "mtd_get_mac_ascii: partition $mtdname not found!" >&2
222                 return
223         fi
224
225         mac_dirty=$(strings "$part" | sed -n 's/^'"$key"'=//p')
226
227         # "canonicalize" mac
228         [ -n "$mac_dirty" ] && macaddr_canonicalize "$mac_dirty"
229 }
230
231 mtd_get_blob()
232 {
233         local mtdname="$1"
234         local offset="$2"
235         local count="$3"
236         local firmware="$4"
237         local part
238
239         part=$(find_mtd_part "$mtdname")
240         if [ -z "$part" ]; then
241                 echo "mtd_get_blob: partition $mtdname not found!" >&2
242                 return 1
243         fi
244
245         dd if=$part of=$firmware bs=1 skip=$offset count=$count 2>/dev/null || {
246                 echo "mtd_get_blob: failed to extract $firmware from $part" >&2
247                 return 1
248         }
249 }
250
251 mtd_get_mac_binary() {
252         local mtdname="$1"
253         local offset="$2"
254         local part
255
256         part=$(find_mtd_part "$mtdname")
257         if [ -z "$part" ]; then
258                 echo "mtd_get_mac_binary: partition $mtdname not found!" >&2
259                 return
260         fi
261
262         dd bs=1 skip=$offset count=6 if=$part 2>/dev/null | hexdump -v -n 6 -e '5/1 "%02x:" 1/1 "%02x"'
263 }
264
265 mtd_get_part_size() {
266         local part_name=$1
267         local first dev size erasesize name
268         while read dev size erasesize name; do
269                 name=${name#'"'}; name=${name%'"'}
270                 if [ "$name" = "$part_name" ]; then
271                         echo $((0x$size))
272                         break
273                 fi
274         done < /proc/mtd
275 }
276
277 macaddr_add() {
278         local mac=$1
279         local val=$2
280         local oui=${mac%:*:*:*}
281         local nic=${mac#*:*:*:}
282
283         nic=$(printf "%06x" $((0x${nic//:/} + $val & 0xffffff)) | sed 's/^\(.\{2\}\)\(.\{2\}\)\(.\{2\}\)/\1:\2:\3/')
284         echo $oui:$nic
285 }
286
287 macaddr_setbit_la()
288 {
289         local mac=$1
290
291         printf "%02x:%s" $((0x${mac%%:*} | 0x02)) ${mac#*:}
292 }
293
294 macaddr_2bin()
295 {
296         local mac=$1
297
298         echo -ne \\x${mac//:/\\x}
299 }
300
301 macaddr_canonicalize()
302 {
303         local mac="$1"
304         local canon=""
305
306         [ ${#mac} -gt 17 ] && return
307         [ -n "${mac//[a-fA-F0-9\.: -]/}" ] && return
308
309         for octet in ${mac//[\.:-]/ }; do
310                 case "${#octet}" in
311                 1)
312                         octet="0${octet}"
313                         ;;
314                 2)
315                         ;;
316                 4)
317                         octet="${octet:0:2} ${octet:2:2}"
318                         ;;
319                 12)
320                         octet="${octet:0:2} ${octet:2:2} ${octet:4:2} ${octet:6:2} ${octet:8:2} ${octet:10:2}"
321                         ;;
322                 *)
323                         return
324                         ;;
325                 esac
326                 canon=${canon}${canon:+ }${octet}
327         done
328
329         [ ${#canon} -ne 17 ] && return
330
331         printf "%02x:%02x:%02x:%02x:%02x:%02x" 0x${canon// / 0x} 2>/dev/null
332 }
333
334 jffs2_mark_erase() {
335         local part="$(find_mtd_part "$1")"
336         [ -z "$part" ] && {
337                 echo Partition not found.
338                 return 1
339         }
340         echo -e "\xde\xad\xc0\xde" | mtd -qq write - "$1"
341 }
342
343 group_add() {
344         local name="$1"
345         local gid="$2"
346         local rc
347         [ -f "${IPKG_INSTROOT}/etc/group" ] || return 1
348         [ -n "$IPKG_INSTROOT" ] || lock /var/lock/group
349         echo "${name}:x:${gid}:" >> ${IPKG_INSTROOT}/etc/group
350         rc=$?
351         [ -n "$IPKG_INSTROOT" ] || lock -u /var/lock/group
352         return $rc
353 }
354
355 group_exists() {
356         grep -qs "^${1}:" ${IPKG_INSTROOT}/etc/group
357 }
358
359 user_add() {
360         local name="${1}"
361         local uid="${2}"
362         local gid="${3:-$2}"
363         local desc="${4:-$1}"
364         local home="${5:-/var/run/$1}"
365         local shell="${6:-/bin/false}"
366         local rc
367         [ -f "${IPKG_INSTROOT}/etc/passwd" ] || return 1
368         [ -n "$IPKG_INSTROOT" ] || lock /var/lock/passwd
369         echo "${name}:x:${uid}:${gid}:${desc}:${home}:${shell}" >> ${IPKG_INSTROOT}/etc/passwd
370         echo "${name}:x:0:0:99999:7:::" >> ${IPKG_INSTROOT}/etc/shadow
371         rc=$?
372         [ -n "$IPKG_INSTROOT" ] || lock -u /var/lock/passwd
373         return $rc
374 }
375
376 user_exists() {
377         grep -qs "^${1}:" ${IPKG_INSTROOT}/etc/passwd
378 }
379
380 [ -z "$IPKG_INSTROOT" -a -f /lib/config/uci.sh ] && . /lib/config/uci.sh