install-legacy-support.sh

#!/usr/bin/env bash

# install-legacy-support.sh
#
# This script attempts to enable installation of Fermentrack alongside BrewPi/RaspberryPints (which use Apache).
# Technically, this script modifies one of the two to use a port other than 80, and then


# Portions of this script were loosely based on brewpi-tools.

# Copyright 2013 BrewPi

# BrewPi is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.

# BrewPi is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.

# You should have received a copy of the GNU General Public License
# along with BrewPi.  If not, see <http://www.gnu.org/licenses/>.

# Fermentrack is free software, and is distributed under the terms of the MIT license.
# A copy of the MIT license should be included with Fermentrack. If not, a copy can be
# reviewed at <https://opensource.org/licenses/MIT>

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.


package_name="Fermentrack"
github_repo="https://github.com/thorrak/fermentrack.git"
github_branch="master"
green=$(tput setaf 76)
red=$(tput setaf 1)
tan=$(tput setaf 3)
reset=$(tput sgr0)

# These are currently unused (hence the exclusion from the help text). Eventually, I may use them to make the ports
# configurable.
fermentrack_port=80
legacy_port=81


############## Command Line Options Parser

INTERACTIVE=1

# Help text
function usage() {
    echo "Usage: $0 [-h] [-n]" 1>&2
    echo "Options:"
    echo "  -h               This help"
    echo "  -n               Run non interactive installation"
    exit 1
}

while getopts "nhp:l:" opt; do
  case ${opt} in
    n)
      INTERACTIVE=0  # Silent/Non-interactive Mode
      ;;
    p)
      fermentrack_port=$OPTARG
      ;;
    l)
      legacy_port=$OPTARG
      ;;
    h)
      usage
      exit 1
      ;;
    :)
      echo "Option -$OPTARG requires an argument." >&2
      exit 1
      ;;
    \?)
      echo "Invalid option: -$OPTARG" >&2
      usage
      exit 1
      ;;
  esac
done

shift $((OPTIND-1))




printinfo() {
  printf "::: ${green}%s${reset}\n" "$@"
}


printwarn() {
 printf "${tan}*** WARNING: %s${reset}\n" "$@"
}


printerror() {
 printf "${red}*** ERROR: %s${reset}\n" "$@"
}


# Functions
warn() {
  local fmt="$1"
  command shift 2>/dev/null
  echo "${red}*** ----------------------------------${reset}"
  echo "${red}*** ERROR ERROR ERROR ERROR ERROR ***${reset}"
  echo -e "${red}$fmt\n" "${@}${reset}"
  echo "${red}*** ----------------------------------${reset}"
  echo "${red}*** See above lines for error message${reset}"
  echo "${red}*** Setup NOT completed${reset}"
  echo "${red}*** More information in the \"install.log\" file${reset}"
}


die () {
  local st="$?"
  warn "$@"
  exit "$st"
}

welcomeMessage() {
  echo -n "${tan}"
  cat << "EOF"
 _____                              _                  _
|  ___|__ _ __ _ __ ___   ___ _ __ | |_ _ __ __ _  ___| | __
| |_ / _ \ '__| '_ ` _ \ / _ \ '_ \| __| '__/ _` |/ __| |/ /
|  _|  __/ |  | | | | | |  __/ | | | |_| | | (_| | (__|   <
|_|  \___|_|  |_| |_| |_|\___|_| |_|\__|_|  \__,_|\___|_|\_\

EOF
  echo -n "${reset}"
  echo "This script installs support for legacy (PHP/Apache) applications under Nginx."
  echo "Legacy applications (such as RaspberryPints and brewpi-www) traditionally used Apache to"
  echo "serve webpages. This script will deactivate Apache and configure nginx to serve those"
  echo "pages instead."
  echo
  if [[ ${INTERACTIVE} -eq 1 ]]; then  # Don't ask this if we're running in noninteractive mode
      read -p "Do you want to continue to install legacy (PHP) application support? [y/N] " yn
      case "$yn" in
        y | Y | yes | YES| Yes ) printinfo "Ok, let's go!";;
        * ) exit;;
      esac
  fi
}


verifyRunAsRoot() {
    # verifyRunAsRoot does two things - First, it checks if the script was run by a root user. Assuming it wasn't,
    # then it attempts to relaunch itself as root.
    if [[ ${EUID} -eq 0 ]]; then
        printinfo "This script was launched as root. Continuing installation."
    else
        printinfo "This script was called without root privileges. It installs and updates several packages,"
        printinfo "creates user accounts and updates system settings. To continue this script will now attempt"
        printinfo "to use 'sudo' to relaunch itself as root. Please check the contents of this script for any"
        printinfo "concerns with this requirement. Please be sure to access this script from a trusted source."
        echo

        if command -v sudo &> /dev/null; then
            # TODO - Make this require user confirmation before continuing
            printinfo "This script will now attempt to relaunch using sudo."
            exec sudo bash "$0" "$@"
            exit $?
        else
            printerror "The sudo utility does not appear to be available on this system, and thus installation cannot continue."
            printerror "Please run this script as root and it will be automatically installed."
            exit 1
        fi
    fi
    echo

}


# Check for network connection
verifyInternetConnection() {
  printinfo "Checking for Internet connection: "
  wget -q --spider --no-check-certificate github.com &>> install.log
  if [ $? -ne 0 ]; then
      echo
      printerror "Could not connect to GitHub. Are you sure you have a working Internet"
      printerror "connection? Installer will exit; it needs to fetch code from GitHub."
      exit 1
  fi
  printinfo "Internet connection Success!"
  echo
}


# Check if installer is up-to-date
verifyInstallerVersion() {
  printinfo "Checking whether this script is up to date..."
  unset CDPATH
  myPath="$( cd "$( dirname "${BASH_SOURCE[0]}")" && pwd )"
  printinfo ""$myPath"/update-tools-repo.sh start."
  bash "$myPath"/update-tools-repo.sh &>> install.log
  printinfo ""$myPath"/update-tools-repo.sh end."
  if [ $? -ne 0 ]; then
    printerror "The update script was not up-to-date, but it should have been updated. Please re-run install.sh."
    exit 1
  fi
  echo
}


# getAptPackages runs apt-get update, and installs the basic packages we need to continue the Fermentrack install
getAptPackages() {
    printinfo "Installing dependencies using apt-get"
    lastUpdate=$(stat -c %Y /var/lib/apt/lists)
    nowTime=$(date +%s)
    if [ $(($nowTime - $lastUpdate)) -gt 604800 ] ; then
        printinfo "Last 'apt-get update' was awhile back. Updating now. (This may take a minute)"
        apt-key update &>> install.log||die
        printinfo "'apt-key update' ran successfully."
        apt-get update &>> install.log||die
        printinfo "'apt-get update' ran successfully."
    fi
    # Installing the nginx stack along with everything we need for circus, etc.
    printinfo "apt is updated - checking that the packages required for Fermentrack are already installed."
    printinfo "(This may take a few minutes during which everything will be silent) ..."

    # All of the below should already be installed as part of the default Fermentrack install
    # For the curious:
    # git-core enables us to get the code from git (har har)
    # build-essential allows for building certain python (& other) packages
    # python-dev, python-pip, and python-virtualenv all enable us to run Python scripts
    # nginx is a webserver
    # redis-server is a key/value store used for gravity sensor & task queue support
    # avrdude is used to flash Arduino-based devices
    apt-get install -y git-core build-essential nginx &>> install.log || die


    printinfo "Now installing additional packages required for legacy (PHP/Apache) software support"
    # These packages are required for PHP support. PHP support is required by BrewPi and RaspberryPints
    apt-get install -y php5-common php5-cli php5-fpm &>>install.log || die

    printinfo "All packages installed successfully."
    echo
}


verifyFreeDiskSpace() {
  printinfo "Verifying free disk space..."
  local required_free_kilobytes=256000
  local existing_free_kilobytes=$(df -Pk | grep -m1 '\/$' | awk '{print $4}')

  # - Unknown free disk space , not a integer
  if ! [[ "${existing_free_kilobytes}" =~ ^([0-9])+$ ]]; then
    printerror "Unknown free disk space!"
    printerror "We were unable to determine available free disk space on this system."
    exit 1
  # - Insufficient free disk space
  elif [[ ${existing_free_kilobytes} -lt ${required_free_kilobytes} ]]; then
    printerror "Insufficient Disk Space!"
    printerror "Your system appears to be low on disk space. ${package_name} recommends a minimum of $required_free_kilobytes KB."
    printerror "You only have ${existing_free_kilobytes} KB free."
    printerror "If this is a new install you may need to expand your disk."
    printerror "Try running 'sudo raspi-config', and choose the 'expand file system option'"
    printerror "After rebooting, run this installation again."
    printerror "Insufficient free space, exiting..."
    exit 1
  fi
  echo
}


deactivateApache() {
  printinfo "Deactivating launch of Apache at startup (if active)"
  # Disable auto-launch of apache2 on startup
  update-rc.d apache2 disable
  # then explicitly stop apache
  service apache2 stop
}


# Set up nginx
setupNginx() {
  printinfo "Copying nginx configuration to /etc/nginx and activating."
  rm -f /etc/nginx/sites-available/optional-apache &> /dev/null
  cp "$myPath"/nginx-configs/optional-apache /etc/nginx/sites-available/optional-apache
  rm -f /etc/nginx/sites-enabled/default &> /dev/null
  ln -sf /etc/nginx/sites-available/optional-apache /etc/nginx/sites-enabled/optional-apache
  service php5-fpm restart
  service nginx restart
}


installationReport() {
  MYIP=$(/sbin/ifconfig|egrep -A 1 'eth|wlan'|awk -F"[Bcast:]" '/inet addr/ {print $4}')
  MYIP_TRIM="$(echo -e "${MYIP}" | tr -d '[:space:]')"
  echo "Done installing legacy (PHP) application support!"
  echo "====================================================================================================="
  echo "Review the log above for any errors, otherwise, installation of support is complete!"
  echo
  echo "To view legacy applications, enter http://${MYIP_TRIM}:81 into your web browser."
  echo
  echo " - Fermentrack frontend    : http://${MYIP_TRIM}"
  echo " - Legacy frontend         : http://${MYIP_TRIM}:81"
  echo " - Legacy file location    : /var/www/html"
  echo ""
  echo "Happy Brewing!"
  echo ""
}


## ------------------- Script "main" starts here -----------------------
# Create install log file
verifyRunAsRoot
welcomeMessage

# This one should remove color escape codes from log, but it needs some more
# work so the EOL esc codes also get stripped.
# exec > >( tee >( sed 's/\x1B\[[0-9;]*[JKmsu]//g' >> install.log ) )
exec > >(tee -ai install.log)
exec 2>&1

echo


verifyInternetConnection
verifyInstallerVersion
getAptPackages
verifyFreeDiskSpace
deactivateApache
setupNginx

installationReport