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