base-files: add macaddr_canonicalize helper function
[openwrt/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 hotplug_dev() {
21 env -i ACTION=$1 INTERFACE=$2 /sbin/hotplug-call net
22 }
23
24 append() {
25 local var="$1"
26 local value="$2"
27 local sep="${3:- }"
28
29 eval "export ${NO_EXPORT:+-n} -- \"$var=\${$var:+\${$var}\${value:+\$sep}}\$value\""
30 }
31
32 list_contains() {
33 local var="$1"
34 local str="$2"
35 local val
36
37 eval "val=\" \${$var} \""
38 [ "${val%% $str *}" != "$val" ]
39 }
40
41 list_remove() {
42 local var="$1"
43 local remove="$2"
44 local val
45
46 eval "val=\" \${$var} \""
47 val1="${val%% $remove *}"
48 [ "$val1" = "$val" ] && return
49 val2="${val##* $remove }"
50 [ "$val2" = "$val" ] && return
51 val="${val1## } ${val2%% }"
52 val="${val%% }"
53 eval "export ${NO_EXPORT:+-n} -- \"$var=\$val\""
54 }
55
56 config_load() {
57 [ -n "$IPKG_INSTROOT" ] && return 0
58 uci_load "$@"
59 }
60
61 reset_cb() {
62 config_cb() { return 0; }
63 option_cb() { return 0; }
64 list_cb() { return 0; }
65 }
66 reset_cb
67
68 package() {
69 return 0
70 }
71
72 config () {
73 local cfgtype="$1"
74 local name="$2"
75
76 export ${NO_EXPORT:+-n} CONFIG_NUM_SECTIONS=$(($CONFIG_NUM_SECTIONS + 1))
77 name="${name:-cfg$CONFIG_NUM_SECTIONS}"
78 append CONFIG_SECTIONS "$name"
79 [ -n "$NO_CALLBACK" ] || config_cb "$cfgtype" "$name"
80 export ${NO_EXPORT:+-n} CONFIG_SECTION="$name"
81 export ${NO_EXPORT:+-n} "CONFIG_${CONFIG_SECTION}_TYPE=$cfgtype"
82 }
83
84 option () {
85 local varname="$1"; shift
86 local value="$*"
87
88 export ${NO_EXPORT:+-n} "CONFIG_${CONFIG_SECTION}_${varname}=$value"
89 [ -n "$NO_CALLBACK" ] || option_cb "$varname" "$*"
90 }
91
92 list() {
93 local varname="$1"; shift
94 local value="$*"
95 local len
96
97 config_get len "$CONFIG_SECTION" "${varname}_LENGTH" 0
98 [ $len = 0 ] && append CONFIG_LIST_STATE "${CONFIG_SECTION}_${varname}"
99 len=$(($len + 1))
100 config_set "$CONFIG_SECTION" "${varname}_ITEM$len" "$value"
101 config_set "$CONFIG_SECTION" "${varname}_LENGTH" "$len"
102 append "CONFIG_${CONFIG_SECTION}_${varname}" "$value" "$LIST_SEP"
103 list_cb "$varname" "$*"
104 }
105
106 config_rename() {
107 local OLD="$1"
108 local NEW="$2"
109 local oldvar
110 local newvar
111
112 [ -n "$OLD" -a -n "$NEW" ] || return
113 for oldvar in `set | grep ^CONFIG_${OLD}_ | \
114 sed -e 's/\(.*\)=.*$/\1/'` ; do
115 newvar="CONFIG_${NEW}_${oldvar##CONFIG_${OLD}_}"
116 eval "export ${NO_EXPORT:+-n} \"$newvar=\${$oldvar}\""
117 unset "$oldvar"
118 done
119 export ${NO_EXPORT:+-n} CONFIG_SECTIONS="$(echo " $CONFIG_SECTIONS " | sed -e "s, $OLD , $NEW ,")"
120
121 [ "$CONFIG_SECTION" = "$OLD" ] && export ${NO_EXPORT:+-n} CONFIG_SECTION="$NEW"
122 }
123
124 config_unset() {
125 config_set "$1" "$2" ""
126 }
127
128 config_clear() {
129 local SECTION="$1"
130 local oldvar
131
132 list_remove CONFIG_SECTIONS "$SECTION"
133 export ${NO_EXPORT:+-n} CONFIG_SECTIONS="${SECTION:+$CONFIG_SECTIONS}"
134
135 for oldvar in `set | grep ^CONFIG_${SECTION:+${SECTION}_} | \
136 sed -e 's/\(.*\)=.*$/\1/'` ; do
137 unset $oldvar
138 done
139 }
140
141 # config_get <variable> <section> <option> [<default>]
142 # config_get <section> <option>
143 config_get() {
144 case "$3" in
145 "") eval echo "\${CONFIG_${1}_${2}:-\${4}}";;
146 *) eval export ${NO_EXPORT:+-n} -- "${1}=\${CONFIG_${2}_${3}:-\${4}}";;
147 esac
148 }
149
150 # config_get_bool <variable> <section> <option> [<default>]
151 config_get_bool() {
152 local _tmp
153 config_get _tmp "$2" "$3" "$4"
154 case "$_tmp" in
155 1|on|true|enabled) _tmp=1;;
156 0|off|false|disabled) _tmp=0;;
157 *) _tmp="$4";;
158 esac
159 export ${NO_EXPORT:+-n} "$1=$_tmp"
160 }
161
162 config_set() {
163 local section="$1"
164 local option="$2"
165 local value="$3"
166 local old_section="$CONFIG_SECTION"
167
168 CONFIG_SECTION="$section"
169 option "$option" "$value"
170 CONFIG_SECTION="$old_section"
171 }
172
173 config_foreach() {
174 local ___function="$1"
175 [ "$#" -ge 1 ] && shift
176 local ___type="$1"
177 [ "$#" -ge 1 ] && shift
178 local section cfgtype
179
180 [ -z "$CONFIG_SECTIONS" ] && return 0
181 for section in ${CONFIG_SECTIONS}; do
182 config_get cfgtype "$section" TYPE
183 [ -n "$___type" -a "x$cfgtype" != "x$___type" ] && continue
184 eval "$___function \"\$section\" \"\$@\""
185 done
186 }
187
188 config_list_foreach() {
189 [ "$#" -ge 3 ] || return 0
190 local section="$1"; shift
191 local option="$1"; shift
192 local function="$1"; shift
193 local val
194 local len
195 local c=1
196
197 config_get len "${section}" "${option}_LENGTH"
198 [ -z "$len" ] && return 0
199 while [ $c -le "$len" ]; do
200 config_get val "${section}" "${option}_ITEM$c"
201 eval "$function \"\$val\" \"\$@\""
202 c="$(($c + 1))"
203 done
204 }
205
206 insert_modules() {
207 [ -d /etc/modules.d ] && {
208 cd /etc/modules.d
209 sed 's/^[^#]/insmod &/' $* | ash 2>&- || :
210 }
211 }
212
213 include() {
214 local file
215
216 for file in $(ls $1/*.sh 2>/dev/null); do
217 . $file
218 done
219 }
220
221 find_mtd_index() {
222 local PART="$(grep "\"$1\"" /proc/mtd | awk -F: '{print $1}')"
223 local INDEX="${PART##mtd}"
224
225 echo ${INDEX}
226 }
227
228 find_mtd_part() {
229 local INDEX=$(find_mtd_index "$1")
230 local PREFIX=/dev/mtdblock
231
232 [ -d /dev/mtdblock ] && PREFIX=/dev/mtdblock/
233 echo "${INDEX:+$PREFIX$INDEX}"
234 }
235
236 find_mtd_chardev() {
237 local INDEX=$(find_mtd_index "$1")
238 local PREFIX=/dev/mtd
239
240 [ -d /dev/mtd ] && PREFIX=/dev/mtd/
241 echo "${INDEX:+$PREFIX$INDEX}"
242 }
243
244 mtd_get_mac_ascii()
245 {
246 local mtdname="$1"
247 local key="$2"
248 local part
249 local mac_dirty
250
251 part=$(find_mtd_part "$mtdname")
252 if [ -z "$part" ]; then
253 echo "mtd_get_mac_ascii: partition $mtdname not found!" >&2
254 return
255 fi
256
257 mac_dirty=$(strings "$part" | sed -n 's/^'"$key"'=//p')
258
259 # "canonicalize" mac
260 [ -n "$mac_dirty" ] && macaddr_canonicalize "$mac_dirty"
261 }
262
263 mtd_get_mac_binary() {
264 local mtdname="$1"
265 local offset="$2"
266 local part
267
268 part=$(find_mtd_part "$mtdname")
269 if [ -z "$part" ]; then
270 echo "mtd_get_mac_binary: partition $mtdname not found!" >&2
271 return
272 fi
273
274 dd bs=1 skip=$offset count=6 if=$part 2>/dev/null | hexdump -v -n 6 -e '5/1 "%02x:" 1/1 "%02x"'
275 }
276
277 mtd_get_part_size() {
278 local part_name=$1
279 local first dev size erasesize name
280 while read dev size erasesize name; do
281 name=${name#'"'}; name=${name%'"'}
282 if [ "$name" = "$part_name" ]; then
283 echo $((0x$size))
284 break
285 fi
286 done < /proc/mtd
287 }
288
289 macaddr_add() {
290 local mac=$1
291 local val=$2
292 local oui=${mac%:*:*:*}
293 local nic=${mac#*:*:*:}
294
295 nic=$(printf "%06x" $((0x${nic//:/} + $val & 0xffffff)) | sed 's/^\(.\{2\}\)\(.\{2\}\)\(.\{2\}\)/\1:\2:\3/')
296 echo $oui:$nic
297 }
298
299 macaddr_setbit_la()
300 {
301 local mac=$1
302
303 printf "%02x:%s" $((0x${mac%%:*} | 0x02)) ${mac#*:}
304 }
305
306 macaddr_2bin()
307 {
308 local mac=$1
309
310 echo -ne \\x${mac//:/\\x}
311 }
312
313 macaddr_canonicalize()
314 {
315 local mac="$1"
316 local canon=""
317
318 [ ${#mac} -gt 17 ] && return
319 [ -n "${mac//[a-fA-F0-9\.: -]/}" ] && return
320
321 for octet in ${mac//[\.:-]/ }; do
322 case "${#octet}" in
323 1)
324 octet="0${octet}"
325 ;;
326 2)
327 ;;
328 4)
329 octet="${octet:0:2} ${octet:2:2}"
330 ;;
331 12)
332 octet="${octet:0:2} ${octet:2:2} ${octet:4:2} ${octet:6:2} ${octet:8:2} ${octet:10:2}"
333 ;;
334 *)
335 return
336 ;;
337 esac
338 canon=${canon}${canon:+ }${octet}
339 done
340
341 [ ${#canon} -ne 17 ] && return
342
343 printf "%02x:%02x:%02x:%02x:%02x:%02x" 0x${canon// / 0x} 2>/dev/null
344 }
345
346 strtok() { # <string> { <variable> [<separator>] ... }
347 local tmp
348 local val="$1"
349 local count=0
350
351 shift
352
353 while [ $# -gt 1 ]; do
354 tmp="${val%%$2*}"
355
356 [ "$tmp" = "$val" ] && break
357
358 val="${val#$tmp$2}"
359
360 export ${NO_EXPORT:+-n} "$1=$tmp"; count=$((count+1))
361 shift 2
362 done
363
364 if [ $# -gt 0 -a -n "$val" ]; then
365 export ${NO_EXPORT:+-n} "$1=$val"; count=$((count+1))
366 fi
367
368 return $count
369 }
370
371
372 jffs2_mark_erase() {
373 local part="$(find_mtd_part "$1")"
374 [ -z "$part" ] && {
375 echo Partition not found.
376 return 1
377 }
378 echo -e "\xde\xad\xc0\xde" | mtd -qq write - "$1"
379 }
380
381 uci_apply_defaults() {
382 cd /etc/uci-defaults || return 0
383 files="$(ls)"
384 [ -z "$files" ] && return 0
385 mkdir -p /tmp/.uci
386 for file in $files; do
387 ( . "./$(basename $file)" ) && rm -f "$file"
388 done
389 uci commit
390 }
391
392 group_add() {
393 local name="$1"
394 local gid="$2"
395 local rc
396 [ -f "${IPKG_INSTROOT}/etc/group" ] || return 1
397 [ -n "$IPKG_INSTROOT" ] || lock /var/lock/group
398 echo "${name}:x:${gid}:" >> ${IPKG_INSTROOT}/etc/group
399 rc=$?
400 [ -n "$IPKG_INSTROOT" ] || lock -u /var/lock/group
401 return $rc
402 }
403
404 group_exists() {
405 grep -qs "^${1}:" ${IPKG_INSTROOT}/etc/group
406 }
407
408 user_add() {
409 local name="${1}"
410 local uid="${2}"
411 local gid="${3:-$2}"
412 local desc="${4:-$1}"
413 local home="${5:-/var/run/$1}"
414 local shell="${6:-/bin/false}"
415 local rc
416 [ -f "${IPKG_INSTROOT}/etc/passwd" ] || return 1
417 [ -n "$IPKG_INSTROOT" ] || lock /var/lock/passwd
418 echo "${name}:x:${uid}:${gid}:${desc}:${home}:${shell}" >> ${IPKG_INSTROOT}/etc/passwd
419 echo "${name}:x:0:0:99999:7:::" >> ${IPKG_INSTROOT}/etc/shadow
420 rc=$?
421 [ -n "$IPKG_INSTROOT" ] || lock -u /var/lock/passwd
422 return $rc
423 }
424
425 user_exists() {
426 grep -qs "^${1}:" ${IPKG_INSTROOT}/etc/passwd
427 }
428
429
430 pi_include() {
431 if [ -f "/tmp/overlay/$1" ]; then
432 . "/tmp/overlay/$1"
433 elif [ -f "$1" ]; then
434 . "$1"
435 elif [ -d "/tmp/overlay/$1" ]; then
436 if [ -n "$(ls /tmp/overlay/$1/*.sh 2>/dev/null)" ]; then
437 for src_script in /tmp/overlay/$1/*.sh; do
438 . "$src_script"
439 done
440 fi
441 elif [ -d "$1" ]; then
442 if [ -n "$(ls $1/*.sh 2>/dev/null)" ]; then
443 for src_script in $1/*.sh; do
444 . "$src_script"
445 done
446 fi
447 else
448 echo "WARNING: $1 not found"
449 return 1
450 fi
451 return 0
452 }
453
454 boot_hook_splice_start() {
455 export -n PI_HOOK_SPLICE=1
456 }
457
458 boot_hook_splice_finish() {
459 local hook
460 for hook in $PI_STACK_LIST; do
461 local v; eval "v=\${${hook}_splice:+\$${hook}_splice }$hook"
462 export -n "${hook}=${v% }"
463 export -n "${hook}_splice="
464 done
465 export -n PI_HOOK_SPLICE=
466 }
467
468 boot_hook_init() {
469 local hook="${1}_hook"
470 export -n "PI_STACK_LIST=${PI_STACK_LIST:+$PI_STACK_LIST }$hook"
471 export -n "$hook="
472 }
473
474 boot_hook_add() {
475 local hook="${1}_hook${PI_HOOK_SPLICE:+_splice}"
476 local func="${2}"
477
478 [ -n "$func" ] && {
479 local v; eval "v=\$$hook"
480 export -n "$hook=${v:+$v }$func"
481 }
482 }
483
484 boot_hook_shift() {
485 local hook="${1}_hook"
486 local rvar="${2}"
487
488 local v; eval "v=\$$hook"
489 [ -n "$v" ] && {
490 local first="${v%% *}"
491
492 [ "$v" != "${v#* }" ] && \
493 export -n "$hook=${v#* }" || \
494 export -n "$hook="
495
496 export -n "$rvar=$first"
497 return 0
498 }
499
500 return 1
501 }
502
503 boot_run_hook() {
504 local hook="$1"
505 local func
506
507 while boot_hook_shift "$hook" func; do
508 local ran; eval "ran=\$PI_RAN_$func"
509 [ -n "$ran" ] || {
510 export -n "PI_RAN_$func=1"
511 $func "$1" "$2"
512 }
513 done
514 }
515
516 jffs2_ready() {
517 mtdpart="$(find_mtd_part rootfs_data)"
518 [ -z "$mtdpart" ] && return 1
519 magic=$(hexdump $mtdpart -n 4 -e '4/1 "%02x"')
520 [ "$magic" != "deadc0de" ]
521 }
522
523 dupe() { # <new_root> <old_root>
524 cd $1
525 echo -n "creating directories... "
526 {
527 cd $2
528 find . -xdev -type d
529 echo "./dev ./overlay ./mnt ./proc ./tmp"
530 # xdev skips mounted directories
531 cd $1
532 } | xargs mkdir -p
533 echo "done"
534
535 echo -n "setting up symlinks... "
536 for file in $(cd $2; find . -xdev -type f;); do
537 case "$file" in
538 ./rom/note) ;; #nothing
539 ./etc/config*|\
540 ./usr/lib/opkg/info/*) cp -af $2/$file $file;;
541 *) ln -sf /rom/${file#./*} $file;;
542 esac
543 done
544 for file in $(cd $2; find . -xdev -type l;); do
545 cp -af $2/${file#./*} $file
546 done
547 echo "done"
548 }
549
550 pivot() { # <new_root> <old_root>
551 mount -o noatime,move /proc $1/proc && \
552 pivot_root $1 $1$2 && {
553 mount -o noatime,move $2/dev /dev
554 mount -o noatime,move $2/tmp /tmp
555 mount -o noatime,move $2/sys /sys 2>&-
556 mount -o noatime,move $2/overlay /overlay 2>&-
557 return 0
558 }
559 }
560
561 fopivot() { # <rw_root> <ro_root> <dupe?>
562 root=$1
563 {
564 if grep -q overlay /proc/filesystems; then
565 mount -o noatime,lowerdir=/,upperdir=$1 -t overlayfs "overlayfs:$1" /mnt && root=/mnt
566 elif grep -q mini_fo /proc/filesystems; then
567 mount -t mini_fo -o noatime,base=/,sto=$1 "mini_fo:$1" /mnt 2>&- && root=/mnt
568 else
569 mount --bind -o noatime / /mnt
570 mount --bind -o noatime,union "$1" /mnt && root=/mnt
571 fi
572 } || {
573 [ "$3" = "1" ] && {
574 mount | grep "on $1 type" 2>&- 1>&- || mount -o noatime,bind $1 $1
575 dupe $1 $rom
576 }
577 }
578 pivot $root $2
579 }
580
581 ramoverlay() {
582 mkdir -p /tmp/root
583 mount -t tmpfs -o noatime,mode=0755 root /tmp/root
584 fopivot /tmp/root /rom 1
585 }
586
587 [ -z "$IPKG_INSTROOT" -a -f /lib/config/uci.sh ] && . /lib/config/uci.sh