install-nimbix.sh

#!/usr/bin/env bash

set -e

ARCH=$(arch)
export ARCH=${ARCH:-x86_64}
export BRANCH=master
export TUNE_DESKTOP=true

while [ $# -gt 0 ]; do
  case $1 in
  --skip-os-pkg-update)
    export SKIP_OS_PKG_UPDATE=1
    ;;
  --jarvice-desktop-branch)
    BRANCH=$2
    shift
    ;;
  --verbose)
    export VERBOSE=true
    ;;
  --reduce-image-size)
    export RIS=true
    ;;
  --no-desktop-tuning)
    export TUNE_DESKTOP=false
    ;;
  *)
    break
    ;;
  esac
  shift
done

if [ "$VERBOSE" = true ]; then
  echo -e "\e[1;33mINFO : Enabling verbosity\e[0m"
  sleep 1
  set -x
fi

echo -e "\e[1;34m     _  _   _____   _____ ___ ___   ___  ___ ___ _  _______ ___  ___ "
echo -e "\e[1;34m  _ | |/_\\ | _ \\ \\ / /_ _/ __| __| |   \\| __/ __| |/ /_   _/ _ \\| _ \\"
echo -e "\e[1;34m | || / _ \\|   /\\ V / | | (__| _|  | |) | _|\\__ \\ ' <  | || (_) |  _/"
echo -e "\e[1;34m  \\__/_/ \\_\\_|_\\ \\_/ |___\\___|___| |___/|___|___/_|\\_\\ |_| \\___/|_|  "
sleep 3

# Base OS
function setup_base_os() {

echo
echo -e "\e[1;33m ###############################################\e[0m"
echo -e "\e[1;33m #                SETUP BASE OS                #\e[0m"
echo -e "\e[1;33m ###############################################\e[0m"
echo
sleep 1

  # Core packages
  PKGS="curl zip unzip sudo mousepad"
  # Source current environment
  source /etc/os-release

  if [[ "$ID_LIKE" == *"rhel"* ]]; then # EL based system
    if [ "$RIS" = true ]; then
      export RIS="--nobest"
    fi

    RHEL_VERSIONS="8 9"
    if [[ $RHEL_VERSIONS =~ ${VERSION_ID:0:1} ]]; then # Supported EL version
      echo -e "\e[1;33mINFO : RHEL derivated detected\e[0m"
      dnf install wget -y
      if [[ "${VERSION_ID:0:1}" == "7" ]]; then
        wget https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm
        dnf -y install epel-release-latest-7.noarch.rpm
      elif [[ "${VERSION_ID:0:1}" == "8" ]]; then
        wget https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm
        dnf -y install epel-release-latest-8.noarch.rpm
      elif [[ "${VERSION_ID:0:1}" == "9" ]]; then
        dnf install curl --allowerasing -y
        wget https://dl.fedoraproject.org/pub/epel/epel-release-latest-9.noarch.rpm
        dnf -y install epel-release-latest-9.noarch.rpm
      fi

      # Packages to support MPI and basic container operation
      PKGS+=" passwd xz tar file openssh-server openssh-clients python3"
      PKGS+=" which sshpass mailcap initscripts"

      # If requested by user, update system
      [ -z "$SKIP_OS_PKG_UPDATE" ] && dnf -y update

      # Install packages
      dnf -y install $PKGS $RIS

      # EL 8 images have locals natively manually removed !!
      # We need to force reinstall packages to ensure files are present to build locals.
      if [[ "8 9" =~ ${VERSION_ID:0:1} ]]; then
        dnf -y install glibc-langpack-en glibc-common glibc-locale-source gzip
        dnf -y reinstall glibc-langpack-en glibc-common glibc-locale-source gzip
      fi
      # Set locale
      localedef -i en_US -f UTF-8 en_US.UTF-8

      echo '# leave empty' >/etc/fstab
    else
      echo -e "\e[1;31mERROR: unknown or unsupported image operating system."
      echo -e "Please report to documentation to know supported Linux versions."
      echo -e "Exiting...\e[0m"
      exit 1
    fi

  elif [[ "$ID" == *"ubuntu"* ]]; then # Ubuntu based system
    if [ "$RIS" = true ]; then
      export RIS="--no-install-recommends"
    fi
    UBUNTU_VERSIONS="20.04 22.04 24.04"
    if [[ $UBUNTU_VERSIONS =~ $VERSION_ID ]]; then
      echo -e "\e[1;33mINFO : Ubuntu derivated detected\e[0m"

      # Prevent interactive packages locks
      export DEBIAN_FRONTEND=noninteractive

      PKGS+=" kmod xz-utils vim openssh-server libpam-systemd iputils-ping python3"
      PKGS+=" iptables build-essential byacc flex git cmake"
      PKGS+=" screen grep locales locales-all net-tools lsb-release"
      PKGS+=" openssh-client sshpass ca-certificates"

      PY_IS_PY3_VER="20.04 22.04 24.04"
      if [[ $PY_IS_PY3_VER =~ $VERSION_ID ]]; then
        PKGS+=" python-is-python3"
      fi

      # Update cache
      apt-get -y update
      # If requested by user, update system
      [ -z "$SKIP_OS_PKG_UPDATE" ] && apt-get -y upgrade
      # Install packages
      apt-get -y install $PKGS $RIS

      locale-gen en_US.UTF-8
      update-locale LANG=en_US.UTF-8
    else
      echo -e "\e[1;31mERROR: unknown or unsupported image operating system."
      echo -e "Please report to documentation to know supported Linux versions."
      echo -e "Exiting...\e[0m"
      exit 1
    fi

  else
    echo -e "\e[1;31mERROR: unknown or unsupported image operating system."
    echo -e "Please report to documentation to know supported Linux versions."
    echo -e "Exiting...\e[0m"
    exit 1
  fi
}

# Nimbix JARVICE emulation
function setup_jarvice_emulation() {

  echo
  echo -e "\e[1;33m ###############################################\e[0m"
  echo -e "\e[1;33m #            SETUP JARVICE EMULATION          #\e[0m"
  echo -e "\e[1;33m ###############################################\e[0m"
  echo
  sleep 1

  cd /tmp
  if [ -f /tmp/jarvice-desktop/nimbix.zip ]; then # See if we are testing locally
    cd /tmp/jarvice-desktop/
    unzip nimbix.zip
    rm -f nimbix.zip
    cd /tmp
    mv /tmp/jarvice-desktop /tmp/jarvice-desktop-$BRANCH
  else
    curl https://codeload.github.com/nimbix/jarvice-desktop/zip/$BRANCH \
      >/tmp/nimbix.zip
    unzip nimbix.zip
    rm -f nimbix.zip
  fi

  # /tmp/jarvice-desktop-$BRANCH/setup-nimbix.sh    # not compatible with v2

  mkdir -p /usr/local/JARVICE
  cp -a /tmp/jarvice-desktop-$BRANCH/tools /usr/local/JARVICE

  # allow init to write in here for path-based ingress, etc.
  chmod 01777 /usr/local/JARVICE/tools/noVNC

  ln -sf /usr/local/JARVICE /usr/lib/JARVICE
  cat <<'EOF' | tee /etc/profile.d/jarvice-tools.sh >/dev/null
JARVICE_TOOLS="/usr/local/JARVICE/tools"
JARVICE_TOOLS_BIN="$JARVICE_TOOLS/bin"
PATH="$PATH:$JARVICE_TOOLS_BIN"
export JARVICE_TOOLS JARVICE_TOOLS_BIN PATH
EOF

  cd /tmp
  mkdir -p /etc/JARVICE
  cp -a /tmp/jarvice-desktop-"$BRANCH"/etc/* /etc/JARVICE
  chmod 755 /etc/JARVICE

  # mkdir -m 0755 /data
  # chown nimbix:nimbix /data
  # ^^^ not compatible with v2 ^^^
}

function setup_nimbix_desktop() {

  echo
  echo -e "\e[1;33m ###############################################\e[0m"
  echo -e "\e[1;33m #             SETUP NIMBIX DESKTOP            #\e[0m"
  echo -e "\e[1;33m ###############################################\e[0m"
  echo
  sleep 1

  mkdir -p /usr/local/lib/nimbix_desktop

  # Copy in the VNC server installers and the XFCE files
  source /etc/os-release

  if [[ "$ID_LIKE" == *"rhel"* ]]; then # EL based system
    files="install-rhel-desktop.sh"
  elif [[ "$ID" == *"ubuntu"* ]]; then # Ubuntu based system
    files="install-ubuntu-desktop.sh"
  fi
  files+=" prep-tiger.sh install-tiger.sh help-tiger.html postinstall-desktop.sh"
  files+=" nimbix_desktop url.txt xfce4-session-logout share skel.config mimeapps.list helpers.rc"

  # Pull the files from the install bolus
  for i in $files; do
    cp -a /tmp/jarvice-desktop-"$BRANCH"/nimbix_desktop/"$i" \
      /usr/local/lib/nimbix_desktop
  done

  # Setup the desktop files
  if [[ "$ID_LIKE" == *"rhel"* ]]; then # EL based system
    /usr/local/lib/nimbix_desktop/install-rhel-desktop.sh
  elif [[ "$ID" == *"ubuntu"* ]]; then # Ubuntu based system
    /usr/local/lib/nimbix_desktop/install-ubuntu-desktop.sh
  fi

  if [[ $ARCH == x86_64 ]]; then
    /usr/local/lib/nimbix_desktop/prep-tiger.sh
    cp /usr/local/lib/nimbix_desktop/help-tiger.html /etc/NAE/help.html
    /usr/local/lib/nimbix_desktop/install-tiger.sh
  fi

  # clean up older copies, make a link for all apps to find nimbix_desktop
  rm -f /usr/lib/JARVICE/tools/nimbix_desktop
  ln -sf /usr/local/lib/nimbix_desktop/ /usr/lib/JARVICE/tools/nimbix_desktop

  # recreate nimbix user home to get the right skeleton files
  # /bin/rm -rf /home/nimbix
  # /sbin/mkhomedir_helper nimbix
  # ^^^ not compatible with v2

  # Add a marker file for using a local, updated noVNC install
  echo /usr/local/JARVICE/tools/noVNC | tee /etc/.novnc-stable
  chmod 777 /etc/.novnc-stable
}

function cleanup() {

  echo
  echo -e "\e[1;33m ###############################################\e[0m"
  echo -e "\e[1;33m #                 CLEANING UP                 #\e[0m"
  echo -e "\e[1;33m ###############################################\e[0m"
  echo
  sleep 1

  if [[ "$ID_LIKE" == *"rhel"* ]]; then # EL based system
    dnf clean all
  elif [[ "$ID" == *"ubuntu"* ]]; then # Ubuntu based system
    apt-get clean
  fi
  rm -rf /tmp/jarvice-desktop-$BRANCH
  rm -rf /data /scratch
}

function tune_nimbix_desktop() {

  echo
  echo -e "\e[1;33m ###############################################\e[0m"
  echo -e "\e[1;33m #                TUNING DESKTOP               #\e[0m"
  echo -e "\e[1;33m ###############################################\e[0m"
  echo
  sleep 1

  # Hack XFCE wallpapers, to replace them with Nimbix's one
  for filename in /usr/share/backgrounds/xfce/*.png; do
      [ -e "$filename" ] || continue
      rm -f $filename
      cp /usr/local/lib/nimbix_desktop/share/backgrounds/Nimix_Desktop.png $filename
  done
  for filename in /usr/share/backgrounds/xfce/*.jpg; do
      [ -e "$filename" ] || continue
      rm -f $filename
      cp /usr/local/lib/nimbix_desktop/share/backgrounds/Nimix_Desktop.jpg $filename
  done

  # Ensure no screensaver lock possible
  rm -f /etc/xdg/autostart/xfce4-screensaver.desktop
  rm -f /etc/xdg/autostart/xscreensaver.desktop
  rm -f /etc/xdg/autostart/light-locker.desktop

  rm -f /usr/bin/xfce4-screensaver
  echo -e '#!/bin/sh\nexit 0' > /usr/bin/xfce4-screensaver

}

setup_base_os
setup_jarvice_emulation
setup_nimbix_desktop
tune_nimbix_desktop
cleanup

# Prevent desktop tuning, to be hardcoded in final start script
if [ "$TUNE_DESKTOP" == "false" ]; then
  sed -i 's/tune_desktop=true/tune_desktop=false/' /usr/local/bin/nimbix_desktop
fi

exit 0