install.sh

#!/usr/bin/env bash

set -uo pipefail
trap 's=$?; echo "$0: Error on line "$LINENO": $BASH_COMMAND"; exit $s' ERR

# makerfaire2018: Paris Maker Faire 2018 card, only fits Nabaztag V1.
# (default): Ulule 2019 card, fits Nabaztag V1 and Nabaztag V2. Features a microphone. Button is on GPIO 17.
makerfaire2018=0

# ci-chroot : we're running in CI to build a release image or run tests
ci_chroot=0

# test : user wants to run tests (good idea, makes sure sounds and leds are functional)
test=0

# upgrade : this script is invoked from upgrade.sh, typically from the button in the web interface.
upgrade=0

if [ "${1:-}" == "--makerfaire2018" ]; then
  makerfaire2018=1
  shift
fi

if [ "${1:-}" == "ci-chroot" ]; then
  ci_chroot=1
elif [ "${1:-}" == "ci-chroot-test" ]; then
  ci_chroot=1
  test=1
elif [ "${1:-}" == "test" ]; then
  test=1
elif [ "${1:-}" == "--upgrade" ]; then
  upgrade=1
  # auto-detect Maker Faire card here.
  if [ `sudo aplay -L | grep -c "hifiberry"` -gt 0 ]; then
    makerfaire2018=1
  fi
fi

model=$(grep "^Model" /proc/cpuinfo ; true)
if [[ ! "$model" == *"Raspberry Pi Zero"* ]]; then
  # not a Pi Zero or Zero 2
  echo "Installation only planned on Raspberry Pi Zero, will cowardly exit"
  exit 1
fi

if [ $USER == "root" ]; then
  echo "Please run this script as a regular user with sudo privileges"
  exit 1
fi

cd `dirname "$0"`
root_dir=`pwd`
owner=`stat -c '%U' ${root_dir}`
uid=`stat -c '%u' ${root_dir}`
gid=`stat -c '%g' ${root_dir}`
inst_dir=$(dirname ${root_dir})

if [ $ci_chroot -eq 0 -a $makerfaire2018 -eq 0 -a `sudo aplay -L | grep -c "tagtagtagsound"` -eq 0 ]; then
  if [ `sudo aplay -L | grep -c "hifiberry"` -gt 0 ]; then
    echo "Judging from the sound card, this looks likes a Paris Maker Faire 2018 card."
    echo "Please double-check and restart this script with --makerfaire2018"
  else
    echo "Please install and configure sound card driver:"
    echo " https://github.com/pguyot/wm8960/tree/tagtagtag-sound"
  fi
  exit 1
fi

if [ $makerfaire2018 -eq 1 ]; then
  if [ `sudo aplay -L | grep -c "hifiberry"` -eq 0 ]; then
    echo "Please install and configure sound card driver:"
    echo " https://web.archive.org/web/20170914003528/support.hifiberry.com/hc/en-us/articles/205377651-Configuring-Linux-4-x-or-higher"
    exit 1
  fi
fi

build_and_install_driver() {
  driver=${1}
  for dir in /lib/modules/*/build
  do
    kernel=$(basename $(dirname ${dir}))
    echo "Building ${driver} driver for kernel ${kernel}"
    make KERNELRELEASE=${kernel} && sudo make install KERNELRELEASE=${kernel} && make clean KERNELRELEASE=${kernel}
  done
}

if [ $upgrade -eq 1 -a $makerfaire2018 -eq 0 -a -d ${inst_dir}/wm8960 ]; then
  echo "Updating sound driver - 2/15" > /tmp/pynab.upgrade
  cd ${inst_dir}/wm8960
  sudo chown -R ${uid}:${gid} .
  pull=`git pull`
  if [ "$pull" != "Already up to date." ]; then
    build_and_install_driver wm8960
    sudo touch /tmp/pynab.upgrade.reboot
  fi
fi

if [ $upgrade -eq 1 ]; then
  echo "Updating ears driver - 3/15" > /tmp/pynab.upgrade
  if [ -d ${inst_dir}/tagtagtag-ears ]; then
    cd ${inst_dir}/tagtagtag-ears
    sudo chown -R ${uid}:${gid} .
    pull=`git pull`
    if [ "$pull" != "Already up to date." ]; then
      build_and_install_driver tagtagtag-ears
      sudo touch /tmp/pynab.upgrade.reboot
    fi
  else
    sudo mkdir -p ${inst_dir}/tagtagtag-ears
    sudo chown ${uid}:${gid} ${inst_dir}/tagtagtag-ears
    git clone https://github.com/pguyot/tagtagtag-ears ${inst_dir}/tagtagtag-ears
    cd ${inst_dir}/tagtagtag-ears
    build_and_install_driver tagtagtag-ears
    sudo touch /tmp/pynab.upgrade.reboot
  fi
else
  if [ $ci_chroot -eq 0 -a ! -e "/dev/ear0" ]; then
    echo "Please install ears driver https://github.com/pguyot/tagtagtag-ears"
    exit 1
  fi
fi

if [ $upgrade -eq 1 ]; then
  echo "Updating RFID drivers - 4/15" > /tmp/pynab.upgrade
  if [ -d ${inst_dir}/cr14 ]; then
    cd ${inst_dir}/cr14
    sudo chown -R ${uid}:${gid} .
    pull=`git pull`
    if [ "$pull" != "Already up to date." ]; then
      build_and_install_driver cr14
      sudo touch /tmp/pynab.upgrade.reboot
    fi
  else
    sudo mkdir -p ${inst_dir}/cr14
    sudo chown ${uid}:${gid} ${inst_dir}/cr14
    git clone https://github.com/pguyot/cr14 ${inst_dir}/cr14
    cd ${inst_dir}/cr14
    build_and_install_driver cr14
    sudo touch /tmp/pynab.upgrade.reboot
  fi
  if [ -d ${inst_dir}/st25r391x ]; then
    cd ${inst_dir}/st25r391x
    sudo chown -R ${uid}:${gid} .
    pull=`git pull`
    if [ "$pull" != "Already up to date." ]; then
      build_and_install_driver st25r391x
      sudo touch /tmp/pynab.upgrade.reboot
    fi
  else
    sudo mkdir -p ${inst_dir}/st25r391x
    sudo chown ${uid}:${gid} ${inst_dir}/st25r391x
    git clone https://github.com/pguyot/st25r391x ${inst_dir}/st25r391x
    cd ${inst_dir}/st25r391x
    build_and_install_driver st25r391x
    # Disable this driver as it conflicts with cr14 (nabboot will do the switch)
    sudo sed /boot/config.txt -i -e "s/^dtoverlay=st25r391x/#dtoverlay=st25r391x/"
    # Enable i2c-dev
    grep -q -E "^i2c-dev" /etc/modules || printf "i2c-dev\n" | sudo tee -a /etc/modules
    sudo touch /tmp/pynab.upgrade.reboot
  fi
else
  if [ $ci_chroot -eq 0 -a ! -e "/dev/rfid0" -a ! -e "/dev/nfc0" ]; then
    echo "If you have a TAGTAG with the original RFID card, you may want to install cr14 RFID driver https://github.com/pguyot/cr14"
    echo "If you have a 2022 NFC card, you need to install st25r391x RFID driver https://github.com/pguyot/st25r391x"
  fi
fi

if [ $upgrade -eq 1 ]; then
  echo "Updating NabBlockly - 5/15" > /tmp/pynab.upgrade
  if [ -d ${root_dir}/nabblockly ]; then
    cd ${root_dir}/nabblockly
    sudo chown -R ${uid}:${gid} .
    pull=`git pull`
    if [ "$pull" != "Already up to date." ]; then
      ./rebar3 release
    fi
  else
    echo "You may want to install NabBlockly from https://github.com/pguyot/nabblockly"
  fi
else
  if [ $ci_chroot -eq 0 -a ! -d "${root_dir}/nabblockly" ]; then
    echo "You may want to install NabBlockly from https://github.com/pguyot/nabblockly"
  fi
fi

if [ $upgrade -eq 1 ]; then
  echo "Updating Pynab CLI - 6/15" > /tmp/pynab.upgrade
  home_dir=$(getent passwd ${uid} | cut -d: -f6)
  if [ -d ${inst_dir}/pynab_cli ]; then
    cd ${inst_dir}/pynab_cli
    sudo chown -R ${uid}:${gid} .
    pull=`git pull`
    if [ "$pull" != "Already up to date." ]; then
      sudo -u ${owner} mkdir -p ${home_dir}/bin
      cd ${home_dir}/bin
      sudo -u ${owner} ln -fs ${inst_dir}/pynab_cli/bin/* .
    fi
  else
    sudo mkdir -p ${inst_dir}/pynab_cli
    sudo chown ${uid}:${gid} ${inst_dir}/pynab_cli
    git clone -b release https://github.com/f-laurens/pynab_cli ${inst_dir}/pynab_cli
    sudo -u ${owner} mkdir -p ${home_dir}/bin
    cd ${home_dir}/bin
    sudo -u ${owner} ln -fs ${inst_dir}/pynab_cli/bin/* .
  fi
else
  if [ $ci_chroot -eq 0 -a ! -d "${inst_dir}/pynab_cli" ]; then
    echo "You may want to install Pynab CLI from https://github.com/f-laurens/pynab_cli"
  fi
fi

cd ${inst_dir}
if [ $makerfaire2018 -eq 0 ]; then
  if [ $upgrade -eq 1 ]; then
    echo "Updating ASR models - 7/15" > /tmp/pynab.upgrade
  fi

  # Maker Faire card has no mic, no need to install Kaldi
  kaldi_release="e4940d045"
  kaldi_dir="/opt/kaldi"; kaldi_pkgconfig="/usr/lib/pkgconfig/kaldi-asr.pc"
  if [[ -f "${kaldi_pkgconfig}" && "$(grep -c ${kaldi_release} ${kaldi_pkgconfig})" -eq 0 ]]; then
     # Installed Kaldi does not match needed version: remove it
     sudo rm -rf "${kaldi_dir}"
  fi
  if [ ! -d "${kaldi_dir}" ]; then
    kaldi_platform=$(. /etc/os-release && echo "$ID$VERSION_ID-`uname -m`")
    if [ "${kaldi_platform}" = "debian11-armv7l" ]; then
      # (nasty) DietPi patch: debian11 version not available for armv7l
      kaldi_platform="raspbian11-armv7l"
    fi
    # When running in 32 bits mode, maintain Pi Zero compatibility
    if [ "${kaldi_platform}" = "raspbian10-armv7l" ]; then
      kaldi_platform="raspbian10-armv6l"
    fi
    if [ "${kaldi_platform}" = "raspbian11-armv7l" ]; then
      kaldi_platform="raspbian11-armv6l"
    fi
    echo "Installing precompiled ${kaldi_platform} Kaldi into ${kaldi_dir}"
    kaldi_archive="${kaldi_release}/kaldi-${kaldi_release}-linux_${kaldi_platform}.tar.xz"
    wget -O - -q https://github.com/pguyot/kaldi/releases/download/${kaldi_archive} | sudo tar xJ -C /
    sudo ldconfig

    # Fix upgrade of py-kaldi-asr
    pushd ${root_dir}
    if [[ -f venv/lib/python3.7/site-packages/kaldiasr/nnet3.cpython-37m-arm-linux-gnueabihf.so && "$(grep -c ZN3fst8internal14DenseSymbolMapD1Ev venv/lib/python3.7/site-packages/kaldiasr/nnet3.cpython-37m-arm-linux-gnueabihf.so)" -ne 0 ]]; then
        echo "Removing incompatible py-kaldi-asr package"
        venv/bin/pip uninstall -y py-kaldi-asr
    fi
    popd
  fi

  sudo mkdir -p "${kaldi_dir}/model"

  if [ ! -d "${kaldi_dir}/model/kaldi-nabaztag-en-adapt-r20191222" ]; then
    echo "Installing Kaldi model for English"
    sudo tar xJf ${root_dir}/asr/kaldi-nabaztag-en-adapt-r20191222.tar.xz -C ${kaldi_dir}/model/
  fi

  if [ ! -d "${kaldi_dir}/model/kaldi-nabaztag-fr-adapt-r20200203" ]; then
    echo "Installing Kaldi model for French"
    sudo tar xJf ${root_dir}/asr/kaldi-nabaztag-fr-adapt-r20200203.tar.xz -C ${kaldi_dir}/model/
  fi
fi

cd ${root_dir}
if [ -x "$(command -v python3.9)" ] ; then
  py_ver=3.9
elif [ -x "$(command -v python3.7)" ] ; then
  py_ver=3.7
else
  echo "Please install Python 3.7 or 3.9 (you might need to upgrade your Linux distribution)"
  exit 1
fi
python=python${py_ver}
venv_cfg="venv/pyvenv.cfg"
if [[ -f "${venv_cfg}" && "$(grep -c version\ =\ ${py_ver} ${venv_cfg})" -eq 0 ]]; then
   # Installed virtual env does not match needed version: remove it
   sudo rm -rf "venv"
fi
if [ ! -d "venv" ]; then
  echo "Creating Python ${py_ver} virtual environment"
  ${python} -m venv venv
fi

echo "Installing PyPi requirements"
if [ $upgrade -eq 1 ]; then
  echo "Updating Python requirements - 8/15" > /tmp/pynab.upgrade
fi
# Start with wheel which is required to compile some of the other requirements
venv/bin/pip install --no-cache-dir wheel
venv/bin/pip install --no-cache-dir -r requirements.txt

if [ $makerfaire2018 -eq 0 ]; then
  if [ $upgrade -eq 1 ]; then
    echo "Updating NLU models - 9/15" > /tmp/pynab.upgrade
  fi

  # maker faire card has no mic, no need to install snips
  if [ ! -d "venv/lib/${python}/site-packages/snips_nlu_fr" ]; then
    echo "Downloading Snips NLU models for French"
    venv/bin/python -m snips_nlu download fr
  fi

  if [ ! -d "venv/lib/${python}/site-packages/snips_nlu_en" ]; then
    echo "Downloading Snips NLU models for English"
    venv/bin/python -m snips_nlu download en
  fi

  echo "Compiling Snips datasets"
  mkdir -p nabd/nlu
  venv/bin/python -m snips_nlu generate-dataset en */nlu/intent_en.yaml > nabd/nlu/nlu_dataset_en.json
  venv/bin/python -m snips_nlu generate-dataset fr */nlu/intent_fr.yaml > nabd/nlu/nlu_dataset_fr.json

  echo "Persisting Snips engines"
  if [ -d nabd/nlu/engine_en ]; then
    rm -rf nabd/nlu/engine_en
  fi
  venv/bin/snips-nlu train nabd/nlu/nlu_dataset_en.json nabd/nlu/engine_en
  if [ -d nabd/nlu/engine_fr ]; then
    rm -rf nabd/nlu/engine_fr
  fi
  venv/bin/snips-nlu train nabd/nlu/nlu_dataset_fr.json nabd/nlu/engine_fr
fi

trust=`sudo grep local /etc/postgresql/*/main/pg_hba.conf | grep -cE '^local +all +all +trust' || echo -n ''`
if [ $trust -ne 1 ]; then
  echo "Configuring PostgreSQL for trusted access"
  sudo sed -i.orig -E -e 's|^(local +all +all +)peer$|\1trust|' /etc/postgresql/*/main/pg_hba.conf
  trust=`sudo grep local /etc/postgresql/*/main/pg_hba.conf | grep -cE '^local +all +all +trust' || echo -n ''`
  if [ $trust -ne 1 ]; then
    echo "Failed to configure PostgreSQL"
    exit 1
  fi
  if [ $ci_chroot -eq 1 ]; then
    cluster_version=`echo /etc/postgresql/*/main/pg_hba.conf  | sed -E 's|/etc/postgresql/(.+)/(.+)/pg_hba.conf|\1|g'`
    cluster_name=`echo /etc/postgresql/*/main/pg_hba.conf  | sed -E 's|/etc/postgresql/(.+)/(.+)/pg_hba.conf|\2|g'`
    sudo -u postgres /usr/lib/postgresql/${cluster_version}/bin/pg_ctl start -D /etc/postgresql/${cluster_version}/${cluster_name}/
  else
    sudo systemctl restart postgresql
  fi
fi

sudo sed -e "s|/opt/pynab|${root_dir}|g" < nabweb/nginx-site.conf > /tmp/nginx-site.conf
if [ $upgrade -eq 0 ]; then
  if [ ! -e '/etc/nginx/sites-enabled/pynab' ]; then
    echo "Installing Nginx configuration file"
    if [ -h '/etc/nginx/sites-enabled/default' ]; then
      sudo rm /etc/nginx/sites-enabled/default
    fi
    sudo mv /tmp/nginx-site.conf /etc/nginx/sites-enabled/pynab
    if [ $ci_chroot -eq 0 ]; then
      sudo systemctl restart nginx
    fi
  else
    diff -q '/etc/nginx/sites-enabled/pynab' /tmp/nginx-site.conf >/dev/null || {
      echo "Updating Nginx configuration file"
      sudo mv /tmp/nginx-site.conf /etc/nginx/sites-enabled/pynab
      if [ $ci_chroot -eq 0 ]; then
        sudo systemctl restart nginx
      fi
    }
  fi
else
  echo "Restarting Nginx"
  echo "Restarting Nginx - 10/15" > /tmp/pynab.upgrade
  if [ -e '/etc/nginx/sites-enabled/pynab' ]; then
    sudo mv /tmp/nginx-site.conf /etc/nginx/sites-enabled/pynab
    sudo systemctl restart nginx
  fi
fi
sudo rm -f /tmp/nginx-site.conf

psql -U pynab -c '' 2>/dev/null || {
  echo "Creating PostgreSQL database"
  sudo -u postgres psql -U postgres -c "CREATE USER pynab"
  sudo -u postgres psql -U postgres -c "CREATE DATABASE pynab OWNER=pynab LC_COLLATE='C' LC_CTYPE='C' ENCODING='UTF-8' TEMPLATE template0"
  sudo -u postgres psql -U postgres -c "ALTER ROLE pynab CREATEDB"
}

echo "Updating data models"
if [ $upgrade -eq 1 ]; then
  echo "Updating data models - 11/15" > /tmp/pynab.upgrade
fi
venv/bin/python manage.py migrate

all_locales="-l fr_FR -l de_DE -l en_US -l en_GB -l it_IT -l es_ES -l ja_jp -l pt_BR -l de -l en -l es -l fr -l it -l ja -l pt"

echo "Updating localization messages"
if [ $upgrade -eq 0 ]; then
  venv/bin/django-admin compilemessages ${all_locales}
else
  echo "Updating localization messages - 12/15" > /tmp/pynab.upgrade
  for module in nab*/locale; do
    (
      cd `dirname ${module}`
      ../venv/bin/django-admin compilemessages ${all_locales}
    )
  done
fi

if [ $test -eq 1 ]; then
  echo "Running tests"
  if [ $ci_chroot -eq 1 ]; then
      sudo CI=1 venv/bin/pytest
  else
      sudo venv/bin/pytest
  fi
fi

if [ $ci_chroot -eq 1 ]; then
  sudo -u postgres /usr/lib/postgresql/${cluster_version}/bin/pg_ctl stop -D /etc/postgresql/${cluster_version}/${cluster_name}/
fi

# copy service files
echo "Installing service files"
if [ $upgrade -eq 1 ]; then
  echo "Installing service files - 13/15" > /tmp/pynab.upgrade
fi
for service_file in nabd/nabd.socket */*.service ; do
  name=`basename ${service_file}`
  sudo sed -e "s|/opt/pynab|${root_dir}|g" -e "s|/home/pi/pynab|${root_dir}|g" < ${service_file} > /tmp/${name}
  sudo mv /tmp/${name} /lib/systemd/system/${name}
  sudo chown root /lib/systemd/system/${name}
  sudo systemctl enable ${name}
done
sudo sed -e "s|/opt/pynab|${root_dir}|g" < nabboot/nabboot.py > /tmp/nabboot.py
sudo mv /tmp/nabboot.py /lib/systemd/system-shutdown/nabboot.py
sudo chown root /lib/systemd/system-shutdown/nabboot.py
sudo chmod +x /lib/systemd/system-shutdown/nabboot.py

# setup Pynab logs rotation
echo "Setting up Pynab logs rotation"
cat > '/tmp/pynab' <<- END
/var/log/nab*.log {
  weekly
  rotate 4
  missingok
  notifempty
  copytruncate
  delaycompress
  compress
}
END
sudo mv /tmp/pynab /etc/logrotate.d/pynab
sudo chown root:root /etc/logrotate.d/pynab

# advertise rabbit on local network
if [ ! -f "/etc/avahi/services/pynab.service" ]; then
  echo "Setting up Avahi service for Pynab"
  cat > '/tmp/pynab.service' <<- END
<?xml version="1.0" standalone='no'?><!--*-nxml-*-->
<!DOCTYPE service-group SYSTEM "avahi-service.dtd">
<!-- See avahi.service(5) for more information about this configuration file -->
<service-group>
  <name replace-wildcards="yes">Nabaztag rabbit (%h)</name>
  <service>
    <type>_http._tcp</type>
    <port>80</port>
    <txt-record>vendor=violet</txt-record>
    <txt-record>model=tag:tag:tag</txt-record>
  </service>
</service-group>
END
  sudo mv /tmp/pynab.service /etc/avahi/services/pynab.service
fi
if [ ! -f "/etc/avahi/services/nabblocky.service" ]; then
  echo "Setting up Avahi service for NabBlockly"
  cat > '/tmp/nabblocky.service' <<- END
<?xml version="1.0" standalone='no'?><!--*-nxml-*-->
<!DOCTYPE service-group SYSTEM "avahi-service.dtd">
<!-- See avahi.service(5) for more information about this configuration file -->
<service-group>
  <name replace-wildcards="yes">NabBlockly (%h)</name>
  <service>
    <type>_http._tcp</type>
    <port>8080</port>
    <txt-record>vendor=Paul Guyot</txt-record>
    <txt-record>model=tag:tag:tag</txt-record>
  </service>
</service-group>
END
  sudo mv /tmp/nabblocky.service /etc/avahi/services/nabblocky.service
fi

if [ -e /tmp/pynab.upgrade.reboot ]; then
  echo "Rebooting..."
  echo "Upgrade requires reboot, rebooting now - 15/15" > /tmp/pynab.upgrade
  sudo rm -f /tmp/pynab.upgrade
  sudo rm -f /tmp/pynab.upgrade.reboot
  sudo reboot
else
  if [ $ci_chroot -eq 0 ]; then
    echo "Starting services"
    if [ $upgrade -eq 1 ]; then
      echo "Restarting services - 14/15" > /tmp/pynab.upgrade
    fi
    sudo systemctl restart logrotate.service || true
    sudo systemctl start nabd.socket
    sudo systemctl start nabd.service

    # start services
    for service_file in */*.service ; do
      name=`basename ${service_file}`
      if [ "${name}" != "nabd.service" -a "${name}" != "nabweb.service" ]; then
        sudo systemctl start ${name}
      fi
    done

    if [ $upgrade -eq 1 ]; then
      echo "Restarting web site - 15/15" > /tmp/pynab.upgrade
      sudo systemctl restart nabweb.service
    else
      sudo systemctl start nabweb.service
    fi
  fi
fi