net/travelmate/files/travelmate.sh

   1 #!/bin/sh
   2 # travelmate, a wlan connection manager for travel router
   3 # written by Dirk Brenken (dev@brenken.org)
   4
   5 # This is free software, licensed under the GNU General Public License v3.
   6 # You should have received a copy of the GNU General Public License
   7 # along with this program. If not, see <http://www.gnu.org/licenses/>.
   8
   9 # set initial defaults
  10 #
  11 LC_ALL=C
  12 PATH="/usr/sbin:/usr/bin:/sbin:/bin"
  13 trm_ver="0.9.1"
  14 trm_sysver="$(ubus -S call system board | jsonfilter -e '@.release.description')"
  15 trm_enabled=0
  16 trm_debug=0
  17 trm_automatic=1
  18 trm_maxretry=3
  19 trm_maxwait=30
  20 trm_timeout=60
  21 trm_iwinfo="$(command -v iwinfo)"
  22 trm_radio=""
  23 trm_rtfile="/tmp/trm_runtime.json"
  24
  25 # f_envload: load travelmate environment
  26 #
  27 f_envload()
  28 {
  29     # initialize lists
  30     #
  31     trm_devlist=""
  32     trm_stalist=""
  33     trm_radiolist=""
  34
  35     # load uci config and check 'enabled' option
  36     #
  37     option_cb()
  38     {
  39         local option="${1}"
  40         local value="${2}"
  41         eval "${option}=\"${value}\""
  42     }
  43     config_load travelmate
  44
  45     if [ ${trm_enabled} -ne 1 ]
  46     then
  47         f_log "info " "travelmate is currently disabled, please set 'trm_enabled' to '1' to use this service"
  48         exit 0
  49     fi
  50 }
  51
  52 # f_prepare: gather radio information & bring down all STA interfaces
  53 #
  54 f_prepare()
  55 {
  56     local config="${1}"
  57     local mode="$(uci -q get wireless."${config}".mode)"
  58     local radio="$(uci -q get wireless."${config}".device)"
  59     local disabled="$(uci -q get wireless."${config}".disabled)"
  60
  61     if ([ -z "${trm_radio}" ] || [ "${trm_radio}" = "${radio}" ]) && \
  62         [ -z "$(printf "%s" "${trm_radiolist}" | grep -Fo " ${radio}")" ]
  63     then
  64         trm_radiolist="${trm_radiolist} ${radio}"
  65     fi
  66     if [ "${mode}" = "sta" ]
  67     then
  68         trm_stalist="${trm_stalist} ${config}_${radio}"
  69         if [ -z "${disabled}" ] || [ "${disabled}" = "0" ]
  70         then
  71             uci -q set wireless."${config}".disabled=1
  72         fi
  73     fi
  74     f_log "debug" "prepare: ${mode}, radio: ${radio}, config: ${config}, disabled: ${disabled}"
  75 }
  76
  77 # f_check: check interface status
  78 #
  79 f_check()
  80 {
  81     local ifname radio status cnt=1 mode="${1}"
  82
  83     trm_ifstatus="false"
  84     ubus call network reload
  85     while [ ${cnt} -le ${trm_maxwait} ]
  86     do
  87         status="$(ubus -S call network.wireless status 2>/dev/null)"
  88         if [ -n "${status}" ]
  89         then
  90             if [ "${mode}" = "dev" ]
  91             then
  92                 for radio in ${trm_radiolist}
  93                 do
  94                     trm_ifstatus="$(printf "%s" "${status}" | jsonfilter -l1 -e "@.${radio}.up")"
  95                     if [ "${trm_ifstatus}" = "true" ]
  96                     then
  97                         trm_devlist="${trm_devlist} ${radio}"
  98                     else
  99                         trm_devlist=""
 100                         break
 101                     fi
 102                 done
 103                 ifname="${trm_devlist}"
 104             else
 105                 ifname="$(printf "%s" "${status}" | jsonfilter -l1 -e '@.*.interfaces[@.config.mode="sta"].ifname')"
 106                 if [ -n "${ifname}" ]
 107                 then
 108                     trm_ifstatus="$(ubus -S call network.interface dump 2>/dev/null | jsonfilter -l1 -e "@.interface[@.device=\"${ifname}\"].up")"
 109                 fi
 110             fi
 111             if [ "${mode}" = "initial" ] || [ "${trm_ifstatus}" = "true" ]
 112             then
 113                 break
 114             fi
 115         fi
 116         cnt=$((cnt+1))
 117         sleep 1
 118     done
 119     f_log "debug" "check: ${mode}, name: ${ifname}, status: ${trm_ifstatus}, count: ${cnt}, max-wait: ${trm_maxwait}, automatic: ${trm_automatic}"
 120 }
 121
 122 # f_jsnupdate: update runtime information
 123 #
 124 f_jsnupdate()
 125 {
 126     local iface="${1}" radio="${2}" ssid="${3}"
 127
 128     json_init
 129     json_add_object "data"
 130     json_add_string "travelmate_version" "${trm_ver}"
 131     json_add_string "station_connection" "${trm_ifstatus}"
 132     json_add_string "station_ssid" "${ssid}"
 133     json_add_string "station_interface" "${iface}"
 134     json_add_string "station_radio" "${radio}"
 135     json_add_string "last_rundate" "$(/bin/date "+%d.%m.%Y %H:%M:%S")"
 136     json_add_string "system" "${trm_sysver}"
 137     json_close_object
 138     json_dump > "${trm_rtfile}"
 139 }
 140
 141 # f_status: output runtime information
 142 #
 143 f_status()
 144 {
 145     local key keylist value
 146
 147     if [ -s "${trm_rtfile}" ]
 148     then
 149         printf "%s\n" "::: travelmate runtime information"
 150         json_load "$(cat "${trm_rtfile}" 2>/dev/null)"
 151         json_select data
 152         json_get_keys keylist
 153         for key in ${keylist}
 154         do
 155             json_get_var value "${key}"
 156             printf " %-18s : %s\n" "${key}" "${value}"
 157         done
 158     fi
 159 }
 160
 161 # f_log: write to syslog, exit on error
 162 #
 163 f_log()
 164 {
 165     local class="${1}"
 166     local log_msg="${2}"
 167
 168     if [ -n "${log_msg}" ] && ([ "${class}" != "debug" ] || [ ${trm_debug} -eq 1 ])
 169     then
 170         logger -t "travelmate-[${trm_ver}] ${class}" "${log_msg}"
 171         if [ "${class}" = "error" ]
 172         then
 173             logger -t "travelmate-[${trm_ver}] ${class}" "Please check 'https://github.com/openwrt/packages/blob/master/net/travelmate/files/README.md' (${trm_sysver})"
 174             exit 255
 175         fi
 176     fi
 177 }
 178
 179 # f_main: main function for connection handling
 180 #
 181 f_main()
 182 {
 183     local dev config ssid_list sta_ssid sta_radio sta_iface cnt=1
 184
 185     f_check "initial"
 186     if [ "${trm_ifstatus}" != "true" ]
 187     then
 188         > "${trm_rtfile}"
 189         config_load wireless
 190         config_foreach f_prepare wifi-iface
 191         if [ -n "$(uci -q changes wireless)" ]
 192         then
 193             uci -q commit wireless
 194         fi
 195         f_check "dev"
 196         f_log "debug" "main: ${trm_devlist}, sta-list: ${trm_stalist}"
 197         for dev in ${trm_devlist}
 198         do
 199             cnt=1
 200             if [ -z "$(printf "%s" "${trm_stalist}" | grep -Fo "_${dev}")" ]
 201             then
 202                 continue
 203             fi
 204             while [ ${cnt} -le ${trm_maxretry} ]
 205             do
 206                 ssid_list="$(${trm_iwinfo} "${dev}" scan | awk '/ESSID: "/{ORS=" ";if (!seen[$0]++) for(i=2; i<=NF; i++) print $i}')"
 207                 f_log "debug" "main: ${trm_iwinfo}, dev: ${dev}, ssids: ${ssid_list}"
 208                 if [ -n "${ssid_list}" ]
 209                 then
 210                     for sta in ${trm_stalist}
 211                     do
 212                         config="${sta%%_*}"
 213                         sta_radio="${sta##*_}"
 214                         sta_ssid="$(uci -q get wireless."${config}".ssid)"
 215                         sta_iface="$(uci -q get wireless."${config}".network)"
 216                         if [ -n "$(printf "%s" "${ssid_list}" | grep -Fo "\"${sta_ssid}\"")" ] && [ "${dev}" = "${sta_radio}" ]
 217                         then
 218                             uci -q set wireless."${config}".disabled=0
 219                             f_check "sta"
 220                             if [ "${trm_ifstatus}" = "true" ]
 221                             then
 222                                 uci -q commit wireless
 223                                 f_log "info " "interface '${sta_iface}' on '${sta_radio}' connected to uplink '${sta_ssid}' (${trm_sysver})"
 224                                 f_jsnupdate "${sta_iface}" "${sta_radio}" "${sta_ssid}"
 225                                 return 0
 226                             elif [ ${cnt} -eq ${trm_maxretry} ]
 227                             then
 228                                 uci -q set wireless."${config}".disabled=1
 229                                 uci -q set wireless."${config}".ssid="${sta_ssid}_err"
 230                                 uci -q commit wireless
 231                                 f_check "dev"
 232                                 f_log "info " "interface 'can't connect to uplink '${sta_ssid}' (${cnt}/${trm_maxretry}), uplink disabled (${trm_sysver})"
 233                             else
 234                                 uci -q revert wireless
 235                                 f_check "dev"
 236                                 f_log "info " "can't connect to uplink '${sta_ssid}' (${cnt}/${trm_maxretry}) (${trm_sysver})"
 237                             fi
 238                             f_jsnupdate "${sta_iface}" "${sta_radio}" "${sta_ssid}"
 239                         fi
 240                     done
 241                 fi
 242                 cnt=$((cnt+1))
 243                 sleep 5
 244             done
 245         done
 246         if [ ! -s "${trm_rtfile}" ]
 247         then
 248             trm_ifstatus="false"
 249             f_jsnupdate "n/a" "n/a" "n/a"
 250         fi
 251     else
 252         if [ ! -s "${trm_rtfile}" ]
 253         then
 254             config="$(ubus -S call network.wireless status | jsonfilter -l1 -e '@.*.interfaces[@.config.mode="sta"].section')"
 255             sta_radio="$(uci -q get wireless."${config}".device)"
 256             sta_ssid="$(uci -q get wireless."${config}".ssid)"
 257             sta_iface="$(uci -q get wireless."${config}".network)"
 258             f_jsnupdate "${sta_iface}" "${sta_radio}" "${sta_ssid}"
 259         fi
 260     fi
 261 }
 262
 263 # source required system libraries
 264 #
 265 if [ -r "/lib/functions.sh" ] && [ -r "/usr/share/libubox/jshn.sh" ]
 266 then
 267     . "/lib/functions.sh"
 268     . "/usr/share/libubox/jshn.sh"
 269 else
 270     f_log "error" "system libraries not found"
 271 fi
 272
 273 # handle different travelmate actions
 274 #
 275 f_envload
 276 case "${1}" in
 277     status)
 278         f_status
 279         ;;
 280     *)
 281         f_main
 282         while [ ${trm_automatic} -eq 1 ]
 283         do
 284             sleep ${trm_timeout}
 285             f_envload
 286             f_main
 287         done
 288         ;;
 289 esac
 290 exit 0