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="1.3.4"
  14 trm_sysver="unknown"
  15 trm_enabled=0
  16 trm_debug=0
  17 trm_captive=1
  18 trm_proactive=1
  19 trm_captiveurl="http://captive.apple.com"
  20 trm_minquality=35
  21 trm_maxretry=3
  22 trm_maxwait=30
  23 trm_timeout=60
  24 trm_radio=""
  25 trm_connection=""
  26 trm_rtfile="/tmp/trm_runtime.json"
  27 trm_fetch="$(command -v uclient-fetch)"
  28 trm_iwinfo="$(command -v iwinfo)"
  29 trm_wpa="$(command -v wpa_supplicant)"
  30 trm_action="${1:-"start"}"
  31 trm_pidfile="/var/run/travelmate.pid"
  32
  33 # trim leading and trailing whitespace characters
  34 #
  35 f_trim()
  36 {
  37         local trim="$1"
  38
  39         trim="${trim#"${trim%%[![:space:]]*}"}"
  40         trim="${trim%"${trim##*[![:space:]]}"}"
  41         printf '%s' "${trim}"
  42 }
  43
  44 # load travelmate environment
  45 #
  46 f_envload()
  47 {
  48         local sys_call sys_desc sys_model sys_ver
  49
  50         # get system information
  51         #
  52         sys_call="$(ubus -S call system board 2>/dev/null)"
  53         if [ -n "${sys_call}" ]
  54         then
  55                 sys_desc="$(printf '%s' "${sys_call}" | jsonfilter -e '@.release.description')"
  56                 sys_model="$(printf '%s' "${sys_call}" | jsonfilter -e '@.model')"
  57                 trm_sysver="${sys_model}, ${sys_desc}"
  58         fi
  59
  60         # (re-)initialize global list variables
  61         #
  62         unset trm_devlist trm_stalist trm_radiolist trm_active_sta
  63
  64         # load config and check 'enabled' option
  65         #
  66         option_cb()
  67         {
  68                 local option="${1}"
  69                 local value="${2}"
  70                 eval "${option}=\"${value}\""
  71         }
  72         config_load travelmate
  73
  74         if [ ${trm_enabled} -ne 1 ]
  75         then
  76                 f_log "info" "travelmate is currently disabled, please set 'trm_enabled' to '1' to use this service"
  77                 exit 0
  78         fi
  79
  80         # validate input ranges
  81         #
  82         if [ ${trm_minquality} -lt 20 ] || [ ${trm_minquality} -gt 80 ]
  83         then
  84                 trm_minquality=35
  85         fi
  86         if [ ${trm_maxretry} -lt 1 ] || [ ${trm_maxretry} -gt 10 ]
  87         then
  88                 trm_maxretry=3
  89         fi
  90         if [ ${trm_maxwait} -lt 20 ] || [ ${trm_maxwait} -gt 40 ] || [ ${trm_maxwait} -ge ${trm_timeout} ]
  91         then
  92                 trm_maxwait=30
  93         fi
  94         if [ ${trm_timeout} -lt 30 ] || [ ${trm_timeout} -gt 300 ] || [ ${trm_timeout} -le ${trm_maxwait} ]
  95         then
  96                 trm_timeout=60
  97         fi
  98 }
  99
 100 # gather radio information & bring down all STA interfaces
 101 #
 102 f_prep()
 103 {
 104         local eap_rc=0 config="${1}" proactive="${2}"
 105         local mode="$(uci_get wireless "${config}" mode)"
 106         local network="$(uci_get wireless "${config}" network)"
 107         local radio="$(uci_get wireless "${config}" device)"
 108         local disabled="$(uci_get wireless "${config}" disabled)"
 109         local eaptype="$(uci_get wireless "${config}" eap_type)"
 110
 111         if [ -z "${trm_radio}" ] && [ -z "$(printf "%s" "${trm_radiolist}" | grep -Fo "${radio}")" ]
 112         then
 113                 trm_radiolist="$(f_trim "${trm_radiolist} ${radio}")"
 114         elif [ -n "${trm_radio}" ] && [ -z "${trm_radiolist}" ]
 115         then
 116                 trm_radiolist="$(f_trim "$(printf "%s" "${trm_radio}" | \
 117                         awk '{while(match(tolower($0),/radio[0-9]/)){ORS=" ";print substr(tolower($0),RSTART,RLENGTH);$0=substr($0,RSTART+RLENGTH)}}')")"
 118         fi
 119         if [ "${mode}" = "sta" ] && [ "${network}" = "${trm_iface}" ]
 120         then
 121                 if ([ -z "${disabled}" ] || [ "${disabled}" = "0" ]) && ([ ${proactive} -eq 0 ] || [ "${trm_ifstatus}" != "true" ])
 122                 then
 123                         uci_set wireless "${config}" disabled 1
 124                 elif [ "${disabled}" = "0" ] && [ "${trm_ifstatus}" = "true" ] && [ -z "${trm_active_sta}" ] && [ ${proactive} -eq 1 ]
 125                 then
 126                         trm_active_sta="${config}"
 127                 fi
 128                 if [ -n "${eaptype}" ]
 129                 then
 130                         eap_rc="$("${trm_wpa}" -veap >/dev/null 2>&1; printf "%u" ${?})"
 131                 fi
 132                 if [ -z "${eaptype}" ] || [ ${eap_rc} -eq 0 ]
 133                 then
 134                         trm_stalist="$(f_trim "${trm_stalist} ${config}-${radio}")"
 135                 fi
 136         fi
 137         f_log "debug" "f_prep ::: config: ${config}, mode: ${mode}, network: ${network}, eap_rc: ${eap_rc}, radio: ${radio}, trm_radio: ${trm_radio:-"-"}, trm_active_sta: ${trm_active_sta:-"-"}, proactive: ${proactive}, disabled: ${disabled}"
 138 }
 139
 140 # check interface status
 141 #
 142 f_check()
 143 {
 144         local IFS ifname radio dev_status config sta_essid sta_bssid result wait=1 mode="${1}" status="${2:-"false"}"
 145
 146         trm_ifquality=0
 147         if [ "${mode}" = "initial" ]
 148         then
 149                 trm_ifstatus="false"
 150         else
 151                 if [ "${status}" = "false" ]
 152                 then
 153                         ubus call network reload
 154                 fi
 155         fi
 156         while [ ${wait} -le ${trm_maxwait} ]
 157         do
 158                 dev_status="$(ubus -S call network.wireless status 2>/dev/null)"
 159                 if [ -n "${dev_status}" ]
 160                 then
 161                         if [ "${mode}" = "dev" ]
 162                         then
 163                                 if [ "${trm_ifstatus}" != "${status}" ]
 164                                 then
 165                                         trm_ifstatus="${status}"
 166                                         f_jsnup
 167                                 fi
 168                                 for radio in ${trm_radiolist}
 169                                 do
 170                                         result="$(printf "%s" "${dev_status}" | jsonfilter -l1 -e "@.${radio}.up")"
 171                                         if [ "${result}" = "true" ] && [ -z "$(printf "%s" "${trm_devlist}" | grep -Fo "${radio}")" ]
 172                                         then
 173                                                 trm_devlist="$(f_trim "${trm_devlist} ${radio}")"
 174                                         fi
 175                                 done
 176                                 if [ "${trm_devlist}" = "${trm_radiolist}" ] || [ ${wait} -eq ${trm_maxwait} ]
 177                                 then
 178                                         ifname="${trm_devlist}"
 179                                         break
 180                                 else
 181                                         unset trm_devlist
 182                                 fi
 183                         elif [ "${mode}" = "rev" ]
 184                         then
 185                                 wait=$(( ${trm_maxwait} / 3 ))
 186                                 sleep ${wait}
 187                                 break
 188                         else
 189                                 ifname="$(printf "%s" "${dev_status}" | jsonfilter -l1 -e '@.*.interfaces[@.config.mode="sta"].ifname')"
 190                                 if [ -n "${ifname}" ]
 191                                 then
 192                                         trm_ifquality="$(${trm_iwinfo} ${ifname} info 2>/dev/null | awk -F "[\/| ]" '/Link Quality:/{printf "%i\n", (100 / $NF * $(NF-1)) }')"
 193                                         if [ ${trm_ifquality} -ge ${trm_minquality} ]
 194                                         then
 195                                                 trm_ifstatus="$(ubus -S call network.interface dump 2>/dev/null | jsonfilter -l1 -e "@.interface[@.device=\"${ifname}\"].up")"
 196                                         elif [ "${mode}" = "initial" ] && [ ${trm_ifquality} -lt ${trm_minquality} ]
 197                                         then
 198                                                 trm_ifstatus="${status}"
 199                                                 sta_essid="$(printf "%s" "${dev_status}" | jsonfilter -l1 -e '@.*.interfaces[@.config.mode="sta"].*.ssid')"
 200                                                 sta_bssid="$(printf "%s" "${dev_status}" | jsonfilter -l1 -e '@.*.interfaces[@.config.mode="sta"].*.bssid')"
 201                                                 f_log "info" "uplink '${sta_essid:-"-"}/${sta_bssid:-"-"}' is out of range (${trm_ifquality}/${trm_minquality}), uplink disconnected (${trm_sysver})"
 202                                         fi
 203                                 fi
 204                         fi
 205                         if [ "${mode}" = "initial" ] || [ "${trm_ifstatus}" = "true" ]
 206                         then
 207                                 if ([ "${trm_ifstatus}" != "true" ] && [ "${trm_ifstatus}" != "${status}" ]) || \
 208                                         ([ "${trm_ifstatus}" = "true" ] && [ "${mode}" = "sta" ] && [ -n "${trm_active_sta}" ]) || \
 209                                         [ ${trm_ifquality} -lt ${trm_minquality} ]
 210                                 then
 211                                         f_jsnup
 212                                 fi
 213                                 if [ "${mode}" = "initial" ] && [ ${trm_captive} -eq 1 ] && [ "${trm_ifstatus}" = "true" ]
 214                                 then
 215                                         result="$(${trm_fetch} --timeout=$(( ${trm_maxwait} / 3 )) "${trm_captiveurl}" -O /dev/null 2>&1 | \
 216                                                 awk '/^Redirected/{printf "%s" "net cp \047"$NF"\047";exit}/^Download completed/{printf "%s" "net ok";exit}/^Failed|^Connection error/{printf "%s" "net nok";exit}')"
 217                                         if [ -n "${result}" ] && ([ -z "${trm_connection}" ] || [ "${result}" != "${trm_connection%/*}" ])
 218                                         then
 219                                                 trm_connection="${result}/${trm_ifquality}"
 220                                                 f_jsnup
 221                                         fi
 222                                 fi
 223                                 break
 224                         fi
 225                 fi
 226                 wait=$(( wait + 1 ))
 227                 sleep 1
 228         done
 229         f_log "debug" "f_check::: mode: ${mode}, name: ${ifname:-"-"}, status: ${trm_ifstatus}, quality: ${trm_ifquality}, result: ${result:-"-"}, connection: ${trm_connection:-"-"}, wait: ${wait}, max_wait: ${trm_maxwait}, min_quality: ${trm_minquality}, captive: ${trm_captive}"
 230 }
 231
 232 # update runtime information
 233 #
 234 f_jsnup()
 235 {
 236         local config sta_iface sta_radio sta_essid sta_bssid dev_status status="${trm_ifstatus}" faulty_list faulty_station="${1}"
 237
 238         if [ "${status}" = "true" ]
 239         then
 240                 status="connected (${trm_connection:-"-"})"
 241         else
 242                 unset trm_connection
 243                 status="running / not connected"
 244         fi
 245
 246         dev_status="$(ubus -S call network.wireless status 2>/dev/null)"
 247         if [ -n "${dev_status}" ]
 248         then
 249                 config="$(printf "%s" "${dev_status}" | jsonfilter -l1 -e '@.*.interfaces[@.config.mode="sta"].section')"
 250                 if [ -n "${config}" ]
 251                 then
 252                         sta_iface="$(uci_get wireless "${config}" network)"
 253                         sta_radio="$(uci_get wireless "${config}" device)"
 254                         sta_essid="$(uci_get wireless "${config}" ssid)"
 255                         sta_bssid="$(uci_get wireless "${config}" bssid)"
 256                 fi
 257         fi
 258
 259         json_get_var faulty_list "faulty_stations"
 260         if [ -n "${faulty_station}" ]
 261         then
 262                 if [ -z "$(printf "%s" "${faulty_list}" | grep -Fo "${faulty_station}")" ]
 263                 then
 264                         faulty_list="$(f_trim "${faulty_list} ${faulty_station}")"
 265                 fi
 266         fi
 267         json_add_string "travelmate_status" "${status}"
 268         json_add_string "travelmate_version" "${trm_ver}"
 269         json_add_string "station_id" "${sta_radio:-"-"}/${sta_essid:-"-"}/${sta_bssid:-"-"}"
 270         json_add_string "station_interface" "${sta_iface:-"-"}"
 271         json_add_string "faulty_stations" "${faulty_list}"
 272         json_add_string "last_rundate" "$(/bin/date "+%d.%m.%Y %H:%M:%S")"
 273         json_add_string "system" "${trm_sysver}"
 274         json_dump > "${trm_rtfile}"
 275         f_log "debug" "f_jsnup::: config: ${config:-"-"}, status: ${status:-"-"}, sta_iface: ${sta_iface:-"-"}, sta_radio: ${sta_radio:-"-"}, sta_essid: ${sta_essid:-"-"}, sta_bssid: ${sta_bssid:-"-"}, faulty_list: ${faulty_list:-"-"}"
 276 }
 277
 278 # write to syslog
 279 #
 280 f_log()
 281 {
 282         local class="${1}"
 283         local log_msg="${2}"
 284
 285         if [ -n "${log_msg}" ] && ([ "${class}" != "debug" ] || [ ${trm_debug} -eq 1 ])
 286         then
 287                 logger -p "${class}" -t "travelmate-${trm_ver}[${$}]" "${log_msg}"
 288                 if [ "${class}" = "err" ]
 289                 then
 290                         trm_ifstatus="error"
 291                         f_jsnup
 292                         logger -p "${class}" -t "travelmate-${trm_ver}[${$}]" "Please check 'https://github.com/openwrt/packages/blob/master/net/travelmate/files/README.md' (${trm_sysver})"
 293                         exit 1
 294                 fi
 295         fi
 296 }
 297
 298 # main function for connection handling
 299 #
 300 f_main()
 301 {
 302         local IFS cnt dev config scan scan_list scan_essid scan_bssid scan_quality faulty_list
 303         local sta sta_essid sta_bssid sta_radio sta_iface active_essid active_bssid active_radio
 304
 305         f_check "initial"
 306         f_log "debug" "f_main ::: status: ${trm_ifstatus}, proactive: ${trm_proactive}"
 307         if [ "${trm_ifstatus}" != "true" ] || [ ${trm_proactive} -eq 1 ]
 308         then
 309                 config_load wireless
 310                 config_foreach f_prep wifi-iface ${trm_proactive}
 311                 if [ "${trm_ifstatus}" = "true" ] && [ ${trm_proactive} -eq 1 ]
 312                 then
 313                         json_get_var station_id "station_id"
 314                         active_radio="${station_id%%/*}"
 315                         active_essid="${station_id%/*}"
 316                         active_essid="${active_essid#*/}"
 317                         active_bssid="${station_id##*/}"
 318                         f_check "dev" "true"
 319                 else
 320                         uci_commit wireless
 321                         f_check "dev"
 322                 fi
 323                 json_get_var faulty_list "faulty_stations"
 324                 f_log "debug" "f_main ::: iwinfo: ${trm_iwinfo:-"-"}, dev_list: ${trm_devlist:-"-"}, sta_list: ${trm_stalist:0:800}, faulty_list: ${faulty_list:-"-"}"
 325                 for dev in ${trm_devlist}
 326                 do
 327                         f_log "debug" "f_main ::: device: ${dev}"
 328                         if [ -z "$(printf "%s" "${trm_stalist}" | grep -o "\-${dev}")" ]
 329                         then
 330                                 f_log "debug" "f_main ::: no station on '${dev}' - continue"
 331                                 continue
 332                         fi
 333                         cnt=1
 334                         while [ ${cnt} -le ${trm_maxretry} ]
 335                         do
 336                                 f_log "debug" "f_main ::: cnt: ${cnt}, max_cnt: ${trm_maxretry}"
 337                                 for sta in ${trm_stalist}
 338                                 do
 339                                         config="${sta%%-*}"
 340                                         sta_radio="${sta##*-}"
 341                                         sta_essid="$(uci_get wireless "${config}" ssid)"
 342                                         sta_bssid="$(uci_get wireless "${config}" bssid)"
 343                                         sta_iface="$(uci_get wireless "${config}" network)"
 344                                         json_get_var faulty_list "faulty_stations"
 345                                         if [ -n "$(printf "%s" "${faulty_list}" | grep -Fo "${sta_radio}/${sta_essid}/${sta_bssid}")" ]
 346                                         then
 347                                                 f_log "debug" "f_main ::: faulty station '${sta_radio}/${sta_essid}/${sta_bssid:-"-"}' - continue"
 348                                                 continue
 349                                         fi
 350                                         if [ "${dev}" = "${active_radio}" ] && [ "${sta_essid}" = "${active_essid}" ] && [ "${sta_bssid:-"-"}" = "${active_bssid}" ]
 351                                         then
 352                                                 f_log "debug" "f_main ::: active station prioritized '${active_radio}/${active_essid}/${active_bssid:-"-"}' - break"
 353                                                 break 3
 354                                         fi
 355                                         if [ -z "${scan_list}" ]
 356                                         then
 357                                                 scan_list="$(f_trim "$("${trm_iwinfo}" "${dev}" scan 2>/dev/null | \
 358                                                         awk 'BEGIN{FS="[/ ]"}/Address:/{var1=$NF}/ESSID:/{var2="";for(i=12;i<=NF;i++) \
 359                                                         if(var2==""){var2=$i}else{var2=var2" "$i}}/Quality:/{printf "%i,%s,%s\n",(100/$NF*$(NF-1)),var1,var2}' | \
 360                                                         sort -rn | awk '{ORS=",";print $0}')")"
 361                                                 f_log "debug" "f_main ::: scan_list: ${scan_list:0:800}"
 362                                                 if [ -z "${scan_list}" ]
 363                                                 then
 364                                                         f_log "debug" "f_main ::: no scan results on '${dev}' - continue"
 365                                                         continue 3
 366                                                 fi
 367                                         fi
 368                                         IFS=","
 369                                         for scan in ${scan_list}
 370                                         do
 371                                                 if [ -z "${scan_quality}" ]
 372                                                 then
 373                                                         scan_quality="${scan}"
 374                                                 elif [ -z "${scan_bssid}" ]
 375                                                 then
 376                                                         scan_bssid="${scan}"
 377                                                 elif [ -z "${scan_essid}" ]
 378                                                 then
 379                                                         scan_essid="${scan}"
 380                                                 fi
 381                                                 if [ -n "${scan_quality}" ] && [ -n "${scan_bssid}" ] && [ -n "${scan_essid}" ]
 382                                                 then
 383                                                         if [ ${scan_quality} -ge ${trm_minquality} ]
 384                                                         then
 385                                                                 if (([ "${scan_essid}" = "\"${sta_essid}\"" ] && ([ -z "${sta_bssid}" ] || [ "${scan_bssid}" = "${sta_bssid}" ])) || \
 386                                                                         ([ "${scan_bssid}" = "${sta_bssid}" ] && [ "${scan_essid}" = "unknown" ])) && [ "${dev}" = "${sta_radio}" ]
 387                                                                 then
 388                                                                         f_log "debug" "f_main ::: scan_quality: ${scan_quality}, sta_bssid: ${sta_bssid}, scan_bssid: ${scan_bssid}, sta_essid: \"${sta_essid}\", scan_essid: ${scan_essid}"
 389                                                                         if [ "${dev}" = "${active_radio}" ] && [ -n "${trm_active_sta}" ]
 390                                                                         then
 391                                                                                 uci_set wireless "${trm_active_sta}" disabled 1
 392                                                                                 unset trm_connection
 393                                                                         fi
 394                                                                         uci_set wireless "${config}" disabled 0
 395                                                                         f_check "sta"
 396                                                                         if [ "${trm_ifstatus}" = "true" ]
 397                                                                         then
 398                                                                                 uci_commit wireless
 399                                                                                 f_check "initial"
 400                                                                                 f_log "info" "connected to uplink '${sta_radio}/${sta_essid}/${sta_bssid:-"-"}' (${trm_sysver})"
 401                                                                                 return 0
 402                                                                         elif [ ${cnt} -eq ${trm_maxretry} ]
 403                                                                         then
 404                                                                                 uci -q revert wireless
 405                                                                                 f_check "rev"
 406                                                                                 if [ "${dev}" = "${active_radio}" ] && [ -n "${trm_active_sta}" ]
 407                                                                                 then
 408                                                                                         f_check "initial"
 409                                                                                 fi
 410                                                                                 faulty_station="${sta_radio}/${sta_essid}/${sta_bssid:-"-"}"
 411                                                                                 f_jsnup "${faulty_station}"
 412                                                                                 f_log "info" "uplink disabled '${sta_radio}/${sta_essid}/${sta_bssid:-"-"}' (${trm_sysver})"
 413                                                                                 break
 414                                                                         else
 415                                                                                 uci -q revert wireless
 416                                                                                 f_check "rev"
 417                                                                                 f_jsnup
 418                                                                                 f_log "info" "can't connect to uplink '${sta_radio}/${sta_essid}/${sta_bssid:-"-"}' (${trm_sysver})"
 419                                                                                 unset scan_list
 420                                                                                 break
 421                                                                         fi
 422                                                                 fi
 423                                                         fi
 424                                                         unset scan_quality scan_bssid scan_essid
 425                                                 fi
 426                                         done
 427                                         unset IFS scan_quality scan_bssid scan_essid
 428                                 done
 429                                 cnt=$(( cnt + 1 ))
 430                                 sleep $(( ${trm_maxwait} / 6 ))
 431                         done
 432                         unset scan_list
 433                 done
 434         fi
 435 }
 436
 437 # source required system libraries
 438 #
 439 if [ -r "/lib/functions.sh" ] && [ -r "/usr/share/libubox/jshn.sh" ]
 440 then
 441         . "/lib/functions.sh"
 442         . "/usr/share/libubox/jshn.sh"
 443 else
 444         f_log "err" "system libraries not found"
 445 fi
 446
 447 # initialize json runtime file
 448 #
 449 json_load_file "${trm_rtfile}" >/dev/null 2>&1
 450 json_select data >/dev/null 2>&1
 451 if [ ${?} -ne 0 ]
 452 then
 453         > "${trm_rtfile}"
 454         json_init
 455         json_add_object "data"
 456 fi
 457
 458 # control travelmate actions
 459 #
 460 while true
 461 do
 462         if [ -z "${trm_action}" ]
 463         then
 464                 sleep ${trm_timeout}
 465         elif [ "${trm_action}" = "stop" ]
 466         then
 467                 > "${trm_rtfile}"
 468                 f_log "info" "travelmate instance stopped ::: action: ${trm_action}, pid: $(cat ${trm_pidfile} 2>/dev/null)"
 469                 exit 0
 470         else
 471                 f_log "info" "travelmate instance started ::: action: ${trm_action}, pid: ${$}"
 472                 unset trm_action
 473         fi
 474         f_envload
 475         f_main
 476 done