base-files: network.sh: gracefully handle missing network.interface ubus ns
[openwrt/openwrt.git] / package / base-files / files / lib / functions / network.sh
index 7475b00cba384afc7ef6f1e505b69ec7a8301286..d7fd2dea57308721425f89d4b8c38c7b8f1ccc70 100644 (file)
-. /usr/share/libubox/jshn.sh
-
-__network_ipaddr()
-{
-       local __var="$1"
-       local __iface="$2"
-       local __family="$3"
-       local __prefix="${4:-0}"
-
-       local __tmp="$(ubus call network.interface."$__iface" status 2>/dev/null)"
-
-       json_load "${__tmp:-{}}"
-       json_get_type __tmp "ipv${__family}_address"
+# 1: destination variable
+# 2: interface
+# 3: path
+# 4: separator
+# 5: limit
+__network_ifstatus() {
+       local __tmp
+
+       [ -z "$__NETWORK_CACHE" ] && {
+               __tmp="$(ubus call network.interface dump 2>&1)"
+               case "$?" in
+                       4) : ;;
+                       0) export __NETWORK_CACHE="$__tmp" ;;
+                       *) echo "$__tmp" >&2 ;;
+               esac
+       }
+
+       __tmp="$(jsonfilter ${4:+-F "$4"} ${5:+-l "$5"} -s "${__NETWORK_CACHE:-{}}" -e "$1=@.interface${2:+[@.interface='$2']}$3")"
+
+       [ -z "$__tmp" ] && \
+               unset "$1" && \
+               return 1
+
+       eval "$__tmp"
+}
 
-       if [ "$__tmp" = array ]; then
+# determine first IPv4 address of given logical interface
+# 1: destination variable
+# 2: interface
+network_get_ipaddr() {
+       __network_ifstatus "$1" "$2" "['ipv4-address'][0].address";
+}
 
-               json_select "ipv${__family}_address"
-               json_get_type __tmp 1
+# determine first IPv6 address of given logical interface
+# 1: destination variable
+# 2: interface
+network_get_ipaddr6() {
+       __network_ifstatus "$1" "$2" "['ipv6-address'][0].address" || \
+               __network_ifstatus "$1" "$2" "['ipv6-prefix-assignment'][0]['local-address'].address" || \
+               return 1
+}
 
-               if [ "$__tmp" = object ]; then
+# determine first IPv4 subnet of given logical interface
+# 1: destination variable
+# 2: interface
+network_get_subnet() {
+       __network_ifstatus "$1" "$2" "['ipv4-address'][0]['address','mask']" "/"
+}
 
-                       json_select 1
-                       json_get_var $__var address
+# determine first IPv6 subnet of given logical interface
+# 1: destination variable
+# 2: interface
+network_get_subnet6() {
+       local __nets __addr
+
+       if network_get_subnets6 __nets "$2"; then
+               # Attempt to return first non-fe80::/10, non-fc::/7 range
+               for __addr in $__nets; do
+                       case "$__addr" in fe[8ab]?:*|f[cd]??:*)
+                               continue
+                       esac
+                       export "$1=$__addr"
+                       return 0
+               done
 
-                       [ $__prefix -gt 0 ] && {
-                               json_get_var __tmp mask
-                               eval "export -- \"$__var=\${$__var}/$__tmp\""
-                       }
+               # Attempt to return first non-fe80::/10 range
+               for __addr in $__nets; do
+                       case "$__addr" in fe[8ab]?:*)
+                               continue
+                       esac
+                       export "$1=$__addr"
+                       return 0
+               done
 
+               # Return first item
+               for __addr in $__nets; do
+                       export "$1=$__addr"
                        return 0
-               fi
+               done
        fi
 
+       unset "$1"
        return 1
 }
 
-network_get_ipaddr()  { __network_ipaddr "$1" "$2" 4 0; }
-network_get_ipaddr6() { __network_ipaddr "$1" "$2" 6 0; }
+# determine first IPv6 prefix of given logical interface
+# 1: destination variable
+# 2: interface
+network_get_prefix6() {
+       __network_ifstatus "$1" "$2" "['ipv6-prefix'][0]['address','mask']" "/"
+}
 
-network_get_subnet()  { __network_ipaddr "$1" "$2" 4 1; }
-network_get_subnet6() { __network_ipaddr "$1" "$2" 6 1; }
+# determine all IPv4 addresses of given logical interface
+# 1: destination variable
+# 2: interface
+network_get_ipaddrs() {
+       __network_ifstatus "$1" "$2" "['ipv4-address'][*].address"
+}
 
+# determine all IPv6 addresses of given logical interface
+# 1: destination variable
+# 2: interface
+network_get_ipaddrs6() {
+       local __addr
+       local __list=""
 
-__network_gateway()
-{
-       local __var="$1"
-       local __iface="$2"
-       local __family="$3"
+       if __network_ifstatus "__addr" "$2" "['ipv6-address'][*].address"; then
+               for __addr in $__addr; do
+                       __list="${__list:+$__list }${__addr}"
+               done
+       fi
 
-       local __tmp="$(ubus call network.interface."$__iface" status 2>/dev/null)"
-       local __idx=1
+       if __network_ifstatus "__addr" "$2" "['ipv6-prefix-assignment'][*]['local-address'].address"; then
+               for __addr in $__addr; do
+                       __list="${__list:+$__list }${__addr}"
+               done
+       fi
 
-       json_load "${__tmp:-{}}"
+       if [ -n "$__list" ]; then
+               export "$1=$__list"
+               return 0
+       fi
 
-       if json_get_type __tmp route && [ "$__tmp" = array ]; then
+       unset "$1"
+       return 1
+}
 
-               json_select route
+# determine all IP addresses of given logical interface
+# 1: destination variable
+# 2: interface
+network_get_ipaddrs_all() {
+       local __addr __addr6
 
-               while json_get_type __tmp "$__idx" && [ "$__tmp" = object ]; do
+       network_get_ipaddrs __addr "$2"
+       network_get_ipaddrs6 __addr6 "$2"
 
-                       json_select "$((__idx++))"
-                       json_get_var __tmp target
+       if [ -n "$__addr" -o -n "$__addr6" ]; then
+               export "$1=${__addr:+$__addr }$__addr6"
+               return 0
+       fi
 
-                       case "${__family}/${__tmp}" in
-                               4/0.0.0.0|6/::)
-                                       json_get_var "$__var" nexthop
-                                       return $?
-                               ;;
-                       esac
+       unset "$1"
+       return 1
+}
+
+# determine all IPv4 subnets of given logical interface
+# 1: destination variable
+# 2: interface
+network_get_subnets() {
+       __network_ifstatus "$1" "$2" "['ipv4-address'][*]['address','mask']" "/ "
+}
 
-                       json_select ".."
+# determine all IPv6 subnets of given logical interface
+# 1: destination variable
+# 2: interface
+network_get_subnets6() {
+       local __addr __mask
+       local __list=""
+
+       if __network_ifstatus "__addr" "$2" "['ipv6-address'][*]['address','mask']" "/ "; then
+               for __addr in $__addr; do
+                       __list="${__list:+$__list }${__addr}"
+               done
+       fi
 
+       if __network_ifstatus "__addr" "$2" "['ipv6-prefix-assignment'][*]['local-address'].address" && \
+          __network_ifstatus "__mask" "$2" "['ipv6-prefix-assignment'][*].mask"; then
+               for __addr in $__addr; do
+                       __list="${__list:+$__list }${__addr}/${__mask%% *}"
+                       __mask="${__mask#* }"
                done
        fi
 
+       if [ -n "$__list" ]; then
+               export "$1=$__list"
+               return 0
+       fi
+
+       unset "$1"
        return 1
 }
 
-network_get_gateway()  { __network_gateway "$1" "$2" 4; }
-network_get_gateway6() { __network_gateway "$1" "$2" 6; }
+# determine all IPv6 prefixes of given logical interface
+# 1: destination variable
+# 2: interface
+network_get_prefixes6() {
+       __network_ifstatus "$1" "$2" "['ipv6-prefix'][*]['address','mask']" "/ "
+}
 
+# determine IPv4 gateway of given logical interface
+# 1: destination variable
+# 2: interface
+# 3: consider inactive gateway if "true" (optional)
+network_get_gateway() {
+       __network_ifstatus "$1" "$2" ".route[@.target='0.0.0.0' && !@.table].nexthop" "" 1 && \
+               return 0
 
-__network_wan() {
-       local __var="$1"
-       local __family="$2"
-       local __iface
+       [ "$3" = 1 -o "$3" = "true" ] && \
+               __network_ifstatus "$1" "$2" ".inactive.route[@.target='0.0.0.0' && !@.table].nexthop" "" 1
+}
 
-       for __iface in $(ubus list | sed -ne 's/^network\.interface\.//p'); do
-               if __network_gateway "$__var" "$__iface" "$__family"; then
-                       eval "export -- \"$__var=$__iface\""
-                       return 0
-               fi
-       done
+# determine IPv6 gateway of given logical interface
+# 1: destination variable
+# 2: interface
+# 3: consider inactive gateway if "true" (optional)
+network_get_gateway6() {
+       __network_ifstatus "$1" "$2" ".route[@.target='::' && !@.table].nexthop" "" 1 && \
+               return 0
 
-       eval "export -- \"$__var=\""
-       return 1
+       [ "$3" = 1 -o "$3" = "true" ] && \
+               __network_ifstatus "$1" "$2" ".inactive.route[@.target='::' && !@.table].nexthop" "" 1
 }
 
-network_find_wan()  { __network_wan "$1" 4; }
-network_find_wan6() { __network_wan "$1" 6; }
+# determine the DNS servers of the given logical interface
+# 1: destination variable
+# 2: interface
+# 3: consider inactive servers if "true" (optional)
+network_get_dnsserver() {
+       __network_ifstatus "$1" "$2" "['dns-server'][*]" && return 0
 
+       [ "$3" = 1 -o "$3" = "true" ] && \
+               __network_ifstatus "$1" "$2" ".inactive['dns-server'][*]"
+}
 
-__network_device()
-{
-       local __var="$1"
-       local __iface="$2"
-       local __field="$3"
+# determine the domains of the given logical interface
+# 1: destination variable
+# 2: interface
+# 3: consider inactive domains if "true" (optional)
+network_get_dnssearch() {
+       __network_ifstatus "$1" "$2" "['dns-search'][*]" && return 0
+
+       [ "$3" = 1 -o "$3" = "true" ] && \
+               __network_ifstatus "$1" "$2" ".inactive['dns-search'][*]"
+}
 
-       local __tmp="$(ubus call network.interface."$__iface" status 2>/dev/null)"
-       [ -n "$__tmp" ] || return 1
 
-       json_load "$__tmp"
-       json_get_var "$__var" "$__field"
+# 1: destination variable
+# 2: addr
+# 3: inactive
+__network_wan()
+{
+       __network_ifstatus "$1" "" \
+               "[@.route[@.target='$2' && !@.table]].interface" "" 1 && \
+                       return 0
+
+       [ "$3" = 1 -o "$3" = "true" ] && \
+               __network_ifstatus "$1" "" \
+                       "[@.inactive.route[@.target='$2' && !@.table]].interface" "" 1
 }
 
+# find the logical interface which holds the current IPv4 default route
+# 1: destination variable
+# 2: consider inactive default routes if "true" (optional)
+network_find_wan() { __network_wan "$1" "0.0.0.0" "$2"; }
+
+# find the logical interface which holds the current IPv6 default route
+# 1: destination variable
+# 2: consider inactive dafault routes if "true" (optional)
+network_find_wan6() { __network_wan "$1" "::" "$2"; }
+
+# test whether the given logical interface is running
+# 1: interface
 network_is_up()
 {
        local __up
-       __network_device __up "$1" up && [ $__up -eq 1 ]
+       __network_ifstatus "__up" "$1" ".up" && [ "$__up" = 1 ]
 }
 
-network_get_device()  { __network_device "$1" "$2" l3_device; }
-network_get_physdev() { __network_device "$1" "$2" device;    }
+# determine the protocol of the given logical interface
+# 1: destination variable
+# 2: interface
+network_get_protocol() { __network_ifstatus "$1" "$2" ".proto"; }
 
+# determine the layer 3 linux network device of the given logical interface
+# 1: destination variable
+# 2: interface
+network_get_device() { __network_ifstatus "$1" "$2" ".l3_device"; }
 
-__network_defer()
-{
-       local __device="$1"
-       local __defer="$2"
+# determine the layer 2 linux network device of the given logical interface
+# 1: destination variable
+# 2: interface
+network_get_physdev() { __network_ifstatus "$1" "$2" ".device"; }
 
-       json_init
-       json_add_string name "$__device"
-       json_add_boolean defer "$__defer"
+# defer netifd actions on the given linux network device
+# 1: device name
+network_defer_device()
+{
+       ubus call network.device set_state \
+               "$(printf '{ "name": "%s", "defer": true }' "$1")" 2>/dev/null
+}
 
-       ubus call network.device set_state "$(json_dump)" 2>/dev/null
+# continue netifd actions on the given linux network device
+# 1: device name
+network_ready_device()
+{
+       ubus call network.device set_state \
+               "$(printf '{ "name": "%s", "defer": false }' "$1")" 2>/dev/null
 }
 
-network_defer_device() { __network_defer "$1" 1; }
-network_ready_device() { __network_defer "$1" 0; }
+# flush the internal value cache to force re-reading values from ubus
+network_flush_cache() { unset __NETWORK_CACHE; }