common-setup.sh

# This file should not be run directly; it exists to share setup code between the various scripts in this repository
# Before running this script, DIR should be defined equal to the directory containing this script

REPO="https://github.com/reflex-frp/reflex-platform"

NIXOPTS="--option extra-binary-caches https://nixcache.reflex-frp.org"

NIX_CONF="/etc/nix/nix.conf"

if [ -e "$NIX_CONF" ] && grep -q 'https://ryantrinkle\.com:5443' "$NIX_CONF"; then
  >&2 echo "Warning: The reflex-platform cache server has moved from https://ryantrinkle.com:5443 to https://nixcache.reflex-frp.org.  Please update your /etc/nixos/configuration/nix or /etc/nix/nix.conf accordingly"
  if ! grep -q 'https://nixcache\.reflex-frp\.org' ; then
    NIXOPTS+=" --option extra-binary-caches https://ryantrinkle.com:5443"
  fi
fi

LOGFILE="$0.log"

trap "echo 'It looks like a problem occurred.  Please submit an issue at $REPO/issues - include $LOGFILE to provide more information'; exit 1" ERR

echo "Command: " "$0" "$@" >"$LOGFILE"
exec 3>&1
exec 4>&2
exec > >(tee -ia "$LOGFILE")
exec 2> >(tee -ia "$LOGFILE" >&2)

terminate_logging() {
exec 1>&3
exec 2>&4
exec 3>&-
exec 4>&-
}

# Exit because the user caused an error, with the given error code and message
user_error() {
  >&2 echo "$2"
  trap - ERR
  exit "$1"
}

on_darwin_host() { [ "$(uname -s)" == 'Darwin' ]; }

reset_daemon() {
  if on_darwin_host; then
    sudo launchctl stop org.nixos.nix-daemon
    sudo launchctl start org.nixos.nix-daemon
  fi
}

installing_nix=false
user_prefs="$HOME/.local/share/reflex-platform"
skip_cache_setup="$user_prefs/skip_cache_setup"
nixconf_dir="/etc/nix"
nixconf="$nixconf_dir/nix.conf"
our_cache="https://nixcache.reflex-frp.org"
our_key="JJiAKaRv9mWgpVAz8dwewnZe0AzzEAzPkagE9SP5NWI="

nixconf_exists() {
  if [ -e "$nixconf" ]; then return 0; else return 1; fi;
}

nixconf_has_cache_settings() {
  if nixconf_exists && grep -q '^binary-caches\|^binary-cache-public-keys\|^binary-caches-parallel-connections' "$nixconf" ; then return 0; else return 1; fi;
}

nixconf_has_reflex_cache() {
  if nixconf_has_cache_settings && grep -q "$our_cache" "$nixconf"; then return 0; else return 1; fi;
}

nixconf_has_reflex_key() {
  if nixconf_has_cache_settings && grep -q "$our_key" "$nixconf"; then return 0; else return 1; fi;
}

enable_cache() {
  if [ -e "$skip_cache_setup" ]; then return 0; fi;

  if nixconf_has_reflex_cache && nixconf_has_reflex_key; then return 0; fi;

  if uname -v | grep -i "\bnixos\b"; then
    echo "Please enable reflex's binary cache by following the instructions at https://github.com/reflex-frp/reflex-platform/blob/develop/notes/NixOS.md"
    return 0;
  fi

  mkdir -p "$user_prefs"
  if [ "$installing_nix" = false ]; then
    echo "Add binary caches for reflex to $nixconf ?"
    select yn in "Yes" "No" "Ask again next time"; do
      case $yn in
        "Yes" )
          break;;
        "No" )
          touch "$skip_cache_setup"
          echo "To re-enable this prompt do: "
          echo "rm $skip_cache_setup"
          echo ""
          return 0;;
        "Ask again next time" )
          return 0;;
      esac
    done
  fi

  sudo_msg="This requires root access."
  backup="$nixconf.$(date -u +"%FT%TZ").bak"
  if nixconf_exists; then
    echo "$nixconf already exists: creating backup - $sudo_msg"
    sudo cp "$nixconf" "$backup"
    echo "backup saved at $backup"
  fi

  caches_line="binary-caches = https://cache.nixos.org $our_cache"
  keys_line="binary-cache-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= ryantrinkle.com-1:$our_key"
  if ! nixconf_has_cache_settings; then
    if ! nixconf_exists; then
      echo "Creating $nixconf - $sudo_msg";
    else
      echo "Adding cache settings to $nixconf - $sudo_msg";
    fi
    sudo mkdir -p "$nixconf_dir"
    sudo tee -a "$nixconf" > /dev/null <<EOF
$caches_line
$keys_line
binary-caches-parallel-connections = 40
EOF
    reset_daemon
  else
    echo "Adding cache settings to $nixconf - $sudo_msg"
    if ! nixconf_has_reflex_cache; then
      sudo sed -i.bak 's|^\(binary-caches[ =].*\)$|\1 '"$our_cache"'|' "$nixconf"
    fi
    if ! nixconf_has_reflex_key; then
      sudo sed -i.bak 's|^\(binary-cache-public-keys[ =].*\)$|\1 ryantrinkle.com-1:'"$our_key"'|' "$nixconf"
    fi
    reset_daemon
  fi
}

if on_darwin_host; then
  if (sw_vers | grep "ProductVersion" | grep "\(10.13.0\|10.13.1\)$" || false) &> /dev/null; then
    allow_broken_macos="$HOME/.local/share/reflex-platform/allow-broken-macos"
    if [ ! -d "$allow_broken_macos" ]; then
      echo "Running nix on High Sierra versions prior to 10.13.2 is likely to cause system crashes"
      echo "See https://github.com/NixOS/nix/issues/1583"
      echo "Please update your system to continue safely"
      echo "If you still want to try, do:"
      echo "mkdir -p $allow_broken_macos"
      exit 1
    fi
  fi
fi

>&2 echo "If you have any trouble with this script, please submit an issue at $REPO/issues"

(

cd "$DIR"

if [ ! -d /nix ]; then
  installing_nix=true
  if ! type -P curl >/dev/null ; then
    echo "Please make sure that 'curl' is installed and can be run from this shell"
    exit 1
  fi

  echo "In order to continue, $0 must install the Nix package manager.  This requires root access, so you will be prompted for your password.  If you do not wish to continue, just hit Ctrl-C at the password prompt."
  ./scripts/installNix.sh
fi

)

# The command to source the nix script.  This should be a line of valid bash code.
if [ -O /nix/store ]; then
  SOURCE_NIX_SCRIPT=". $HOME/.nix-profile/etc/profile.d/nix.sh"
else
  SOURCE_NIX_SCRIPT=". /nix/var/nix/profiles/default/etc/profile.d/nix-daemon.sh"
fi

# Whether the nix script needed to be sourced - i.e. nix commands are not available without doing so, from the user's basic prompt.
NEEDED_TO_SOURCE_NIX_SCRIPT=0

if ! type -P nix-shell >/dev/null; then
  set +eu
  $SOURCE_NIX_SCRIPT
  set -eu
  NEEDED_TO_SOURCE_NIX_SCRIPT=1
  if ! type -P nix-shell >/dev/null; then
    echo "It looks like Nix isn't working.  Please make sure you can run nix-shell, then retry the $0, or submit an issue at $REPO/issues"
    exit 1
  fi
fi

# The minimum required version of Nix to run this script.
MIN_REQUIRED_NIX_VERSION="1.8"

if [ "$(nix-instantiate --eval --expr "builtins.compareVersions builtins.nixVersion \"$MIN_REQUIRED_NIX_VERSION\" >= 0")" != "true" ]; then
  echo "It looks like your version of Nix, $(nix-instantiate --eval --expr "builtins.nixVersion"), is older than the minimum version required by the Reflex Platform, \"$MIN_REQUIRED_NIX_VERSION\".  You'll need to upgrade Nix to continue.  On non-NixOS platforms, that can usually be done like this:"
  if [ "$NEEDED_TO_SOURCE_NIX_SCRIPT" -ne 0 ]; then
    echo "$SOURCE_NIX_SCRIPT"
  fi
  echo "nix-env --upgrade"
  echo "If you're on NixOS, you may need to upgrade your OS to a later version.  See https://nixos.org/nixos/manual/sec-upgrading.html"
  exit 1
fi

enable_cache

git_thunk() {
  case "$1" in
    git) echo "import ((import <nixpkgs> {}).fetchgit (builtins.fromJSON (builtins.readFile ./git.json)))" ;;
    github) echo "import ((import <nixpkgs> {}).fetchFromGitHub (builtins.fromJSON (builtins.readFile ./github.json)))" ;;
  esac
}

# NOTE: Returns the manifest type in OUTPUT_GIT_MANIFEST_TYPE and the manifest contents in OUTPUT_GIT_MANIFEST
get_git_manifest() {
  local NIX_PREFETCH_SCRIPTS="$(nix-build --no-out-link -E "(import \"$DIR/nixpkgs\" {}).nix-prefetch-scripts")"
  local NIX="$(nix-build --no-out-link -E "(import \"$DIR/nixpkgs\" {}).nix")"
  local REPO="$(echo "$1" | sed 's/\.git$//')"

  local URL="$(git -C "$REPO" config --get remote.origin.url | sed 's_^[email protected]:_git://github.com/_')" # Don't use [email protected] origins, since these can't be accessed by nix
  local REV="$(git -C "$REPO" rev-parse HEAD)"

  local GITHUB_PATTERN="^git://github.com/\([^/]*\)/\([^/]*\)$"
  local GITHUB_ARCHIVE_URL="$(echo "$URL" | sed -n "s_${GITHUB_PATTERN}_https://github.com/\1/\2/archive/$REV.tar.gz_p")"
  if [ -n "$GITHUB_ARCHIVE_URL" -a "$(curl -o /dev/null --silent --head --write-out '%{http_code}' "$GITHUB_ARCHIVE_URL")" -ne 404 ] ; then
    OUTPUT_GIT_MANIFEST_TYPE=github
    local GITHUB_OWNER="$(echo "$URL" | sed "s_${GITHUB_PATTERN}_\1_")"
    local GITHUB_REPO="$(echo "$URL" | sed "s_${GITHUB_PATTERN}_\2_")"
    local SHA256="$($NIX/bin/nix-prefetch-url --unpack --type sha256 "$GITHUB_ARCHIVE_URL")"
    OUTPUT_GIT_MANIFEST="$(cat <<EOF
{
  "owner": "$GITHUB_OWNER",
  "repo": "$GITHUB_REPO",
  "rev": "$REV",
  "sha256": "$SHA256"
}
EOF
)"
  else
    OUTPUT_GIT_MANIFEST_TYPE=git
    OUTPUT_GIT_MANIFEST="$("$NIX_PREFETCH_SCRIPTS"/bin/nix-prefetch-git "$PWD/$REPO" "$REV" 2>/dev/null | sed -e '/^ *"date":/d' -e "s|$(echo "$PWD/$REPO" | sed 's/|/\\|/g')|$(echo "$URL" | sed 's/|/\\|/g')|" 2>/dev/null)"
  fi
}

# Clean up a path so it can be injected into a nix expression
cleanup_nix_path() {
  echo "$1" | sed 's@/*$@@'
}

prebuild_try_reflex_shell() {
  nix-instantiate "$DIR/shell.nix" --indirect --add-root "$DIR/gc-roots/shell.drv" $NIXOPTS >/dev/null
  nix-store --realize "$DIR/gc-roots/shell.drv" --indirect --add-root "$DIR/gc-roots/shell.out" >/dev/null
}

try_reflex_shell() {
  prebuild_try_reflex_shell
  nix-shell -E '{path}: import path' --arg path "$(readlink "$DIR/gc-roots/shell.drv")" $NIXOPTS "$@"
}

# For a given effective platform, turn a string representing a package, which
# may be a package name or a path, into a nix invocation representing the
# package.
package_invocation() {
    local EFFECTIVE_PLATFORM="$1"
    local PACKAGE="$2"

    if echo "$PACKAGE" | grep -q / ; then
        # Package name includes a slash
        local PACKAGE_PATH="$(cleanup_nix_path "$PACKAGE")"
        if ( echo "$PACKAGE_PATH" | grep -q '\.nix$' && [ -f "$PACKAGE_PATH" ] ) || [ -f "$PACKAGE_PATH/default.nix" ] ; then
            echo -n "($EFFECTIVE_PLATFORM.callPackage $PACKAGE_PATH {})"
        elif test -n "$(shopt -s nullglob ; echo "$PACKAGE_PATH"/*.cabal)" ; then
            echo -n "($EFFECTIVE_PLATFORM.callCabal2nix \"$(basename "$PACKAGE_PATH"/*.cabal | sed 's/\.cabal$//')\" $PACKAGE_PATH {})"
        else
            user_error 1 "Error: The given path must be a nix expression, a directory with a default.nix, or a directory with a cabal file"
        fi
    else
        echo -n "$EFFECTIVE_PLATFORM.$PACKAGE"
    fi
}