kupiki_updater.sh

#!/usr/bin/env bash

# Autoupdater based on https://stackoverflow.com/a/44528451/3791371
set -fb

CURRENT_PWD=$(cd "$(dirname "$0")" ; pwd)
CURRENT_NAME=$(basename "$0")
KUPIKI_UPDATER_URL="https://raw.githubusercontent.com/pihomeserver/Kupiki-Hotspot-Script/master/kupiki_updater.sh"
EXISTING_SHELL_SCRIPT="${CURRENT_PWD}/kupiki_updater.sh"
EXECUTABLE_SHELL_SCRIPT="${CURRENT_PWD}/.kupiki_updater.sh"
LOGNAME="kupiki_updater.log"
LOGPATH="/var/log/"
KUPIKI_SCRIPT_ARCHIVE="https://raw.githubusercontent.com/pihomeserver/Kupiki-Hotspot-Script/master/pihotspot.sh"

declare -a KUPIKI_UPDATES=("2.0.1" "2.0.2" "2.0.3" "2.0.4" "2.0.5" "2.0.6" "2.0.7" "2.0.8" "2.0.9" "2.0.10" "2.0.11" "2.0.12" "2.0.13" "2.1.0" "2.1.1" "2.1.2" "2.1.3")

upgrade_2.1.3() {
  :
}

upgrade_2.1.2() {
  apt-get -y -qq install jq
  check_returned_code $?

  allCounters=`cat /etc/freeradius/3.0/mods-enabled/sqlcounter | grep "sqlcounter" | cut -d' ' -f2`
  positionLine=`grep -m 1 -nr -e "^#.*daily$" /etc/freeradius/3.0/sites-enabled/default | cut -d: -f1`

  display_message "Activating counters"
  for counterName in $allCounters
  do
      sed -n -i "p;${positionLine}a ${counterName}" /etc/freeradius/3.0/sites-enabled/default
  done
  check_returned_code $?

  display_message "Configuring daloradius DB proxy path"
  sed -i "s/\$configValues\['CONFIG_FILE_RADIUS_PROXY'\] = '/etc/freeradius/proxy.conf';/\$configValues\['CONFIG_FILE_RADIUS_PROXY'\] = '/etc/freeradius/3.0/proxy.conf';/g" /usr/share/nginx/html/daloradius/library/daloradius.conf.php
  check_returned_code $?

  display_message "Configuring daloradius DB proxy path"
  sed -i "s/\$configValues\['CONFIG_PATH_DALO_VARIABLE_DATA'\] = '/var/www/daloradius/var';/\$configValues\['CONFIG_PATH_DALO_VARIABLE_DATA'\] = '/usr/share/nginx/html/daloradius/var';/g" /usr/share/nginx/html/daloradius/library/daloradius.conf.php
  check_returned_code $?

  display_message "Update Chilli configuration to allow HTTPS in iptables"
  sed -e 's/^HS_TCP_PORTS.*/HS_TCP_PORTS="5000 80 443"/' /etc/chilli/config > /tmp/config && cp /tmp/config /etc/chilli/config
  check_returned_code $?

}

upgrade_2.1.1() {
  apt-get -y -qq install libffi-dev
  check_returned_code $?
}

upgrade_2.1.0() {
  # Captive Portal URL
  HOTSPOTPORTAL_BACKEND_ARCHIVE="https://github.com/Kupiki/Kupiki-Hotspot-Portal-Backend.git"
  execute_command "cd /usr/src/ && rm -rf kupiki-portal-backend && git clone $HOTSPOTPORTAL_BACKEND_ARCHIVE kupiki-portal-backend" true "Cloning Pi Hotspot portal backend project"

  display_message "Correct configuration for Collectd daemon"
  sed -i "s/^FQDNLookup true$/FQDNLookup false/g" /etc/collectd/collectd.conf
  check_returned_code $?

  type docker 2> /dev/null
  if [ $? -ne 0 ]; then
      display_message "Install Docker"
      curl -fsSL get.docker.com -o get-docker.sh && sh get-docker.sh
      check_returned_code $?
  fi

  id -u kupiki > /dev/null
  if [ $? -ne 0 ]; then
      display_message "Create dedicated user kupiki"
      adduser --disabled-password --gecos "" kupiki
      check_returned_code $?
  fi

  grep -q -E "^docker:" /etc/group
  if [ $? -ne 0 ]; then
      display_message "Create Docker user group"
      groupadd -f docker
      check_returned_code $?
  fi

  id kupiki | grep docker > /dev/null
  if [ $? -ne 0 ]; then
      display_message "Add user kupiki to docker group"
      gpasswd -a kupiki docker
      check_returned_code $?
  fi

  type docker-compose 2> /dev/null
  if [ $? -ne 0 ]; then
      display_message "Install docker-compose"
      pip install docker-compose
      check_returned_code $?
  fi

  HOTSPOTPORTAL_ARCHIVE="https://github.com/Kupiki/Kupiki-Hotspot-Portal.git"
  execute_command "cd /usr/src/ && rm -rf portal && git clone $HOTSPOTPORTAL_ARCHIVE portal" true "Cloning Pi Hotspot portal project"
  execute_command "cp -Rf /usr/src/portal /usr/share/nginx/" true "Updating the portal frontend"

  # Get hotspot IP
  HOTSPOT_IP=`grep HS_UAMLISTEN /etc/chilli/config | cut -d'=' -f2`
  display_message "Updating Captive Portal configuration file"
  sed -i "/XXXXXX/s/XXXXXX/$HOTSPOT_IP/g" /usr/share/nginx/portal/js/configuration.json
  check_returned_code $?

  execute_command "cp -Rf /usr/src/kupiki-portal-backend /home/kupiki/" true "Installing the portal backend in the user kupiki home folder"

  MYSQL_PASSWORD=pihotspot
  display_message "Updating Captive Portal backend configuration file"
  sed -i "/pihotspot/s/pihotspot/$MYSQL_PASSWORD/g" /home/kupiki/kupiki-portal-backend/app/src/config.json
  check_returned_code $?

  execute_command "chown -R kupiki:kupiki /home/kupiki/kupiki-portal-backend"

  display_message "Build the Docker image of Portal backend"
  su - kupiki -c "cd /home/kupiki/kupiki-portal-backend && /usr/local/bin/docker-compose build"
  check_returned_code $?

  # Make startup of docker compose as a service (after Docker)
  display_message "Adding portal backend in systemd startup"
  echo "
  [Unit]
  Description=Kupiki Portal Backend container
  Requires=docker.service
  After=docker.service

  [Service]
  #Restart=always
  Type=oneshot
  RemainAfterExit=yes
  WorkingDirectory=/home/kupiki/kupiki-portal-backend
  ExecStart=/usr/local/bin/docker-compose up -d
  ExecStop=/usr/local/bin/docker-compose stop

  [Install]
  WantedBy=default.target
  " > /etc/systemd/system/kupiki-portal-backend.service

  display_message "Disabling Portal backend service"
  /bin/systemctl disable kupiki-portal-backend.service
  check_returned_code $?
}

upgrade_2.0.13() {
  # Kupiki SQL counters
  KUPIKI_SQL_COUNTERS_URL="https://raw.githubusercontent.com/pihomeserver/Kupiki-Hotspot-Script/master/updates/sqlcounter"
  execute_command "cd /usr/src && rm -f sqlcounter && wget $KUPIKI_SQL_COUNTERS_URL" true "Download Kupiki SQL Counters"
  execute_command "service freeradius stop" true "Stoping freeradius service"
  execute_command "cp -f /usr/src/sqlcounter /etc/freeradius/3.0/mods-enabled/sqlcounter" true "Adding CoovaChilli counters (limit bandwidth)"
  execute_command "chown freerad:freerad /etc/freeradius/3.0/mods-enabled/sqlcounter" true "Updating file access rights"
  execute_command "service freeradius start" true "Starting freeradius service"
}

upgrade_2.0.12() {
  :
}

upgrade_2.0.11() {
  grep HS_UAMDOMAINS /etc/chilli/config
  if [ $? -ne 0 ]; then
    echo "HS_UAMDOMAINS=" >> /etc/chilli/config
  fi
}

upgrade_2.0.10() {
  grep HS_MACAUTH /etc/chilli/config
  if [ $? -ne 0 ]; then
    echo "HS_MACAUTH=off" >> /etc/chilli/config
    echo "HS_MACPASSWD=" >> /etc/chilli/config
  fi
}

upgrade_2.0.9() {
  :
}

upgrade_2.0.8() {
  :
}

upgrade_2.0.7() {
  if [ -f /etc/chilli/config ]; then
    echo "::: Configuration file already exists. Nothing to do."
    return 0
  fi
  display_message "Creating Coova configuration file based on current settings"
  cat /etc/chilli/defaults | grep '^[\s]*HS_' > /etc/chilli/config
  check_returned_code $?
}

upgrade_2.0.6() {
  :
}

upgrade_2.0.5() {
  :
}

upgrade_2.0.4() {
	display_message "Creating Kupiki Admin folder for the database"
	mkdir -p /var/local/kupiki
	check_returned_code $?

	display_message "Changing rights of the folder"
	chmod 777 /var/local/kupiki
	check_returned_code $?
}

upgrade_2.0.3() {
  :
}

upgrade_2.0.2() {
  execute_command "service freeradius stop" true "Stoping freeradius service"
  display_message "Activating COA support in Freeradius"
  rm -f /etc/freeradius/3.0/sites-enabled/coa
  echo '
  listen {
    type = coa
    ipaddr = *
    port = 1700
    virtual_server = coa
  }
  server coa {
    recv-coa {
      suffix
      ok
    }
    send-coa {
      ok
    }
  }' > /etc/freeradius/3.0/sites-enabled/coa
  check_returned_code $?
  chown -R freerad:freerad /etc/freeradius/3.0/sites-enabled/coa
  check_returned_code $?
  execute_command "service freeradius start" true "Starting freeradius service"

  if [ -e /etc/init.d/fprobe ]; then
    display_message "Installing nfdump"
    DEBIAN_FRONTEND=noninteractive apt-get install -y --allow-remove-essential --allow-change-held-packages fprobe nfdump
  fi
}

upgrade_2.0.1() {
  :
}

check_returned_code() {
    RETURNED_CODE=$@
    if [ $RETURNED_CODE -ne 0 ]; then
        display_message ""
        display_message "Something went wrong with the last command. Please check the log file"
        display_message ""
        exit 1
    fi
}

display_message() {
    MESSAGE=$@
    # Display on console
    echo "::: $MESSAGE"
    # Save it to log file
    echo "::: $MESSAGE" >> $LOGPATH$LOGNAME
}

execute_command() {
    display_message "$3"
    COMMAND="$1 >> $LOGPATH$LOGNAME 2>&1"
    eval $COMMAND
    COMMAND_RESULT=$?
    if [ "$2" != "false" ]; then
        check_returned_code $COMMAND_RESULT
    fi
}

prepare_logfile() {
    echo "::: Preparing log file"
    if [ -f $LOGPATH$LOGNAME ]; then
        echo "::: Log file already exists. Creating a backup."
        execute_command "mv $LOGPATH$LOGNAME $LOGPATH$LOGNAME.`date +%Y%m%d.%H%M%S`"
    fi
    echo "::: Creating the log file"
    execute_command "touch $LOGPATH$LOGNAME"
    display_message "Log file created : $LOGPATH$LOGNAME"
    display_message "Use command 'tail -f $LOGPATH$LOGNAME' in a new console to get updater process details"
}

check_root() {
  # Must be root to update the hotspot
  echo ":::"
  if [[ $EUID -eq 0 ]];then
    echo "::: You are root - OK"
  else
    echo "::: Please run this as root."
    exit 1
  fi
}

get_current_kupiki_version() {
  KUPIKI_CURRENT_VERSION=`cat /etc/kupiki/version`
}

check_requirements() {
  if [ ! -e /etc/kupiki/version ]; then
    display_message "Unable to find current version. Please reinstall Kupiki Hotspot"
    exit 1
  fi
  display_message "Getting current installed version"
  get_current_kupiki_version

  if [ $KUPIKI_CURRENT_VERSION \< "2.0.0" ]; then
    display_message "Only installation greater than 2.0.0 can be updated"
    exit 1
  fi
}

get_remote_file() {
  REQUEST_URL=$1
  OUTPUT_FILENAME=$2
  TEMP_FILE="${CURRENT_PWD}/tmp.file"

  if [ -n "$(which wget)" ]; then
    $(wget --quiet -O "${TEMP_FILE}" "$REQUEST_URL" 2>&1)
    if [[ $? -eq 0 ]]; then
      mv "${TEMP_FILE}" "${OUTPUT_FILENAME}"
      chmod 700 "${OUTPUT_FILENAME}"
    else
      return 1
    fi
  fi
}

function clean_up() {
  :
}

function self_clean_up() {
  rm -f "${EXECUTABLE_SHELL_SCRIPT}"
}

function update_self_and_invoke() {
  get_remote_file "${KUPIKI_UPDATER_URL}" "${EXECUTABLE_SHELL_SCRIPT}"
  if [ $? -ne 0 ]; then
    cp "${EXISTING_SHELL_SCRIPT}" "${EXECUTABLE_SHELL_SCRIPT}"
  fi
  exec "${EXECUTABLE_SHELL_SCRIPT}" "$@"
}

function copy_file() {
  cp "${EXECUTABLE_SHELL_SCRIPT}" "${EXISTING_SHELL_SCRIPT}"
}

db() { ( printf " db, ";for _i;do printf "%s" "$_i";done;printf "\n" ) >&2 ; }
db() { : ; }

function version_compare() {
  local a1 b1 c1 a2 b2 c2
  # echo|read succeeds in ksh, but fails in bash.
  # bash alternative is "set --"
  db "input 1 \"$1\", 2 \"$2\" "
  v1=$1
  v2=$2
  db "v1 $v1, v2 $v2"
  set -- $( echo "$v1" | sed 's/\./ /g' )
  a1=$1 b1=$2 c1=$3
  set -- $( echo "$v2" | sed 's/\./ /g' )
  a2=$1 b2=$2 c2=$3
  db "a1,b1,c1 $a1,$b1,$c1 ; a2,b2,c2 $a2,$b2,$c2"
  ret=$(( (a1-a2)*1000000+(b1-b2)*1000+c1-c2 ))
  db "ret is $ret"
  if [ $ret -lt 0 ] ; then
    v=-1
  elif [ $ret -eq 0 ] ; then
    v=0
  else
    v=1
  fi
  printf "%d" $v
  return
}

function main() {
  prepare_logfile

  check_requirements

  display_message "Getting latest version of the updater script"
  KUPIKI_LATEST_VERSION=`wget --quiet -O - $KUPIKI_SCRIPT_ARCHIVE | grep ^KUPIKI_VERSION | cut -d '"' -f 2`

  display_message "Latest version : ${KUPIKI_LATEST_VERSION}"
  display_message "Current installed version : ${KUPIKI_CURRENT_VERSION}"

  version_diff=$( version_compare $KUPIKI_LATEST_VERSION $KUPIKI_CURRENT_VERSION )

  if [[ ${version_diff} -eq -1 ]]; then
    display_message ""
    display_message "Ooops seems you have a newer version of the script than the latest one on GitHub"
    display_message "Please input a new issue on GitHub to solve the problem"
    exit 1
  fi

  if [[ ${version_diff} -eq 0 ]]; then
    display_message ""
    display_message "You already have the latest version. Nothing to do."
    exit 0
  fi

  display_message ""
  for i in "${!KUPIKI_UPDATES[@]}"; do
    version_diff=$( version_compare ${KUPIKI_UPDATES[$i]} $KUPIKI_CURRENT_VERSION )
    if [[ ${version_diff} -eq 1 ]]; then
      display_message "Upgrading to version "${KUPIKI_UPDATES[$i]}
      display_message ""
      UPGRADE_FUNCTION="upgrade_"${KUPIKI_UPDATES[$i]}
      ${UPGRADE_FUNCTION};
      echo ${KUPIKI_UPDATES[$i]} > /etc/kupiki/version
      get_current_kupiki_version
    fi
  done
}

if [[ $# -eq 1 && $1 = "noupdate" ]]; then
  check_root

  main "$@"
else
  check_root

  if [[ $CURRENT_NAME = \.* ]]; then
    display_message "Running updater"
    trap "clean_up; self_clean_up" EXIT
    copy_file
    main "$@"
  else
    display_message "Auto updating of the script "
    trap "clean_up" EXIT
    update_self_and_invoke "$@"
  fi
fi