_webi/template.sh

   1 #!/bin/bash
   2
   3 function __bootstrap_webi() {
   4
   5     set -e
   6     set -u
   7     #set -x
   8
   9     #WEBI_PKG=
  10     #PKG_NAME=
  11     # TODO should this be BASEURL instead?
  12     #WEBI_OS=
  13     #WEBI_ARCH=
  14     #WEBI_HOST=
  15     #WEBI_RELEASES=
  16     #WEBI_CSV=
  17     #WEBI_TAG=
  18     #WEBI_VERSION=
  19     #WEBI_MAJOR=
  20     #WEBI_MINOR=
  21     #WEBI_PATCH=
  22     # TODO not sure if BUILD is the best name for this
  23     #WEBI_BUILD=
  24     #WEBI_LTS=
  25     #WEBI_CHANNEL=
  26     #WEBI_EXT=
  27     #WEBI_FORMATS=
  28     #WEBI_PKG_URL=
  29     #WEBI_PKG_FILE=
  30     #PKG_OSES=
  31     #PKG_ARCHES=
  32     #PKG_FORMATS=
  33     WEBI_UA="$(uname -a)"
  34     export WEBI_HOST
  35
  36     ##
  37     ## Set up tmp, download, and install directories
  38     ##
  39
  40     WEBI_TMP=${WEBI_TMP:-"$(mktemp -d -t webinstall-${WEBI_PKG:-}.XXXXXXXX)"}
  41     export _webi_tmp="${_webi_tmp:-"$HOME/.local/opt/webi-tmp.d"}"
  42
  43     mkdir -p "$HOME/Downloads"
  44     mkdir -p "$HOME/.local/bin"
  45     mkdir -p "$HOME/.local/opt"
  46
  47     ##
  48     ## Detect http client
  49     ##
  50     set +e
  51     export WEBI_CURL="$(command -v curl)"
  52     export WEBI_WGET="$(command -v wget)"
  53     set -e
  54
  55     # get the special formatted version (i.e. "go is go1.14" while node is "node v12.10.8")
  56     my_versioned_name=""
  57     _webi_canonical_name() {
  58         if [ -n "$my_versioned_name" ]; then
  59             echo "$my_versioned_name"
  60             return 0
  61         fi
  62
  63         if [ -n "$(command -v pkg_format_cmd_version)" ]; then
  64             my_versioned_name="$(pkg_format_cmd_version "$WEBI_VERSION")"
  65         else
  66             my_versioned_name="'$pkg_cmd_name' v$WEBI_VERSION"
  67         fi
  68
  69         echo "$my_versioned_name"
  70     }
  71
  72     # update symlinks according to $HOME/.local/opt and $HOME/.local/bin install paths.
  73     webi_link() {
  74         if [ -n "$(command -v pkg_link)" ]; then
  75             pkg_link
  76             return 0
  77         fi
  78
  79         if [ -n "$WEBI_SINGLE" ] || [ "single" == "${1:-}" ]; then
  80             rm -rf "$pkg_dst_cmd"
  81             ln -s "$pkg_src_cmd" "$pkg_dst_cmd"
  82         else
  83             # 'pkg_dst' will default to $HOME/.local/opt/<pkg>
  84             # 'pkg_src' will be the installed version, such as to $HOME/.local/opt/<pkg>-<version>
  85             rm -rf "$pkg_dst"
  86             ln -s "$pkg_src" "$pkg_dst"
  87         fi
  88     }
  89
  90     # detect if this program is already installed or if an installed version may cause conflict
  91     webi_check() {
  92         # Test for existing version
  93         set +e
  94         my_path="$PATH"
  95         export PATH="$(dirname "$pkg_dst_cmd"):$PATH"
  96         my_current_cmd="$(command -v "$pkg_cmd_name")"
  97         set -e
  98         if [ -n "$my_current_cmd" ]; then
  99             pkg_current_version="$(pkg_get_current_version 2> /dev/null | head -n 1)"
 100             # remove trailing '.0's for golang's sake
 101             my_current_version="$(echo $pkg_current_version | sed 's:\.0::g')"
 102             my_src_version="$(echo $WEBI_VERSION | sed 's:\.0::g')"
 103             my_canonical_name="$(_webi_canonical_name)"
 104             if [ "$my_src_version" == "$my_current_version" ]; then
 105                 echo "$my_canonical_name already installed at $my_current_cmd"
 106                 exit 0
 107             else
 108                 if [ "$my_current_cmd" != "$pkg_dst_cmd" ]; then
 109                     echo >&2 "WARN: possible conflict between $my_canonical_name and $pkg_current_version at $my_current_cmd"
 110                 fi
 111                 if [ -x "$pkg_src_cmd" ]; then
 112                     webi_link
 113                     echo "switched to $my_canonical_name at $pkg_src"
 114                     exit 0
 115                 fi
 116             fi
 117         fi
 118         export PATH="$my_path"
 119     }
 120
 121     # detect if file is downloaded, and how to download it
 122     webi_download() {
 123         if [ -n "${1:-}" ]; then
 124             my_url="$1"
 125         else
 126             if [ "error" == "$WEBI_CHANNEL" ]; then
 127                 # TODO pass back requested OS / Arch / Version
 128                 echo >&2 "Error: no '$PKG_NAME' release for '$WEBI_OS' on '$WEBI_ARCH' as one of '$WEBI_FORMATS' by the tag '$WEBI_TAG'"
 129                 echo >&2 "       '$PKG_NAME' is available for '$PKG_OSES' on '$PKG_ARCHES' as one of '$PKG_FORMATS'"
 130                 echo >&2 "       (check that the package name and version are correct)"
 131                 echo >&2 ""
 132                 echo >&2 "       Double check at $(echo "$WEBI_RELEASES" | sed 's:\?.*::')"
 133                 echo >&2 ""
 134                 exit 1
 135             fi
 136             my_url="$WEBI_PKG_URL"
 137         fi
 138         if [ -n "${2:-}" ]; then
 139             my_dl="$2"
 140         else
 141             my_dl="$HOME/Downloads/$WEBI_PKG_FILE"
 142         fi
 143
 144         if [ -e "$my_dl" ]; then
 145             echo "Found $my_dl"
 146             return 0
 147         fi
 148
 149         echo "Downloading $PKG_NAME from"
 150         echo "$my_url"
 151
 152         # It's only 2020, we can't expect to have reliable CLI tools
 153         # to tell us the size of a file as part of a base system...
 154         if [ -n "$WEBI_WGET" ]; then
 155             # wget has resumable downloads
 156             # TODO wget -c --content-disposition "$my_url"
 157             set +e
 158             my_show_progress=""
 159             if [[ $- == *i* ]]; then
 160                 my_show_progress="--show-progress"
 161             fi
 162             wget -q $my_show_progress --user-agent="wget $WEBI_UA" -c "$my_url" -O "$my_dl.part"
 163             if ! [ $? -eq 0 ]; then
 164                 echo >&2 "failed to download from $WEBI_PKG_URL"
 165                 exit 1
 166             fi
 167             set -e
 168         else
 169             # Neither GNU nor BSD curl have sane resume download options, hence we don't bother
 170             # TODO curl -fsSL --remote-name --remote-header-name --write-out "$my_url"
 171             my_show_progress="-#"
 172             if [[ $- == *i* ]]; then
 173                 my_show_progress=""
 174             fi
 175             curl -fSL $my_show_progress -H "User-Agent: curl $WEBI_UA" "$my_url" -o "$my_dl.part"
 176         fi
 177         mv "$my_dl.part" "$my_dl"
 178
 179         echo ""
 180         echo "Saved as $my_dl"
 181     }
 182
 183     # detect which archives can be used
 184     webi_extract() {
 185         pushd "$WEBI_TMP" 2>&1 > /dev/null
 186         if [ "tar" == "$WEBI_EXT" ]; then
 187             echo "Extracting $HOME/Downloads/$WEBI_PKG_FILE"
 188             tar xf "$HOME/Downloads/$WEBI_PKG_FILE"
 189         elif [ "zip" == "$WEBI_EXT" ]; then
 190             echo "Extracting $HOME/Downloads/$WEBI_PKG_FILE"
 191             unzip "$HOME/Downloads/$WEBI_PKG_FILE" > __unzip__.log
 192         elif [ "exe" == "$WEBI_EXT" ]; then
 193             echo "Moving $HOME/Downloads/$WEBI_PKG_FILE"
 194             mv "$HOME/Downloads/$WEBI_PKG_FILE" .
 195         elif [ "xz" == "$WEBI_EXT" ]; then
 196             echo "Inflating $HOME/Downloads/$WEBI_PKG_FILE"
 197             unxz -c "$HOME/Downloads/$WEBI_PKG_FILE" > $(basename "$WEBI_PKG_FILE")
 198         else
 199             # do nothing
 200             echo "Failed to extract $HOME/Downloads/$WEBI_PKG_FILE"
 201             exit 1
 202         fi
 203         popd 2>&1 > /dev/null
 204     }
 205
 206     # use 'pathman' to update $HOME/.config/envman/PATH.env
 207     webi_path_add() {
 208         # make sure that we don't recursively install pathman with webi
 209         my_path="$PATH"
 210         export PATH="$HOME/.local/bin:$PATH"
 211
 212         # install pathman if not already installed
 213         if [ -z "$(command -v pathman)" ]; then
 214             "$HOME/.local/bin/webi" pathman > /dev/null
 215         fi
 216
 217         export PATH="$my_path"
 218
 219         # in case pathman was recently installed and the PATH not updated
 220         mkdir -p "$_webi_tmp"
 221         # prevent "too few arguments" output on bash when there are 0 lines of stdout
 222         "$HOME/.local/bin/pathman" add "$1" | grep "export" 2> /dev/null >> "$_webi_tmp/.PATH.env" || true
 223     }
 224
 225     # group common pre-install tasks as default
 226     webi_pre_install() {
 227         webi_check
 228         webi_download
 229         webi_extract
 230     }
 231
 232     # move commands from the extracted archive directory to $HOME/.local/opt or $HOME/.local/bin
 233     webi_install() {
 234         if [ -n "$WEBI_SINGLE" ] || [ "single" == "${1:-}" ]; then
 235             mkdir -p "$(dirname $pkg_src_cmd)"
 236             mv ./"$pkg_cmd_name"* "$pkg_src_cmd"
 237         else
 238             rm -rf "$pkg_src"
 239             mv ./"$pkg_cmd_name"* "$pkg_src"
 240         fi
 241     }
 242
 243     # run post-install functions - just updating PATH by default
 244     webi_post_install() {
 245         webi_path_add "$(dirname "$pkg_dst_cmd")"
 246     }
 247
 248     _webi_enable_exec() {
 249         if [ -n "$(command -v spctl)" ] && [ -n "$(command -v xattr)" ]; then
 250             # note: some packages contain files that cannot be affected by xattr
 251             xattr -r -d com.apple.quarantine "$pkg_src" || true
 252             return 0
 253         fi
 254         # TODO need to test that the above actually worked
 255         # (and proceed to this below if it did not)
 256         if [ -n "$(command -v spctl)" ]; then
 257             echo "Checking permission to execute '$pkg_cmd_name' on macOS 11+"
 258             set +e
 259             is_allowed="$(spctl -a "$pkg_src_cmd" 2>&1 | grep valid)"
 260             set -e
 261             if [ -z "$is_allowed" ]; then
 262                 echo ""
 263                 echo "##########################################"
 264                 echo "#  IMPORTANT: Permission Grant Required  #"
 265                 echo "##########################################"
 266                 echo ""
 267                 echo "Requesting permission to execute '$pkg_cmd_name' on macOS 10.14+"
 268                 echo ""
 269                 sleep 3
 270                 spctl --add "$pkg_src_cmd"
 271             fi
 272         fi
 273     }
 274
 275     # a friendly message when all is well, showing the final install path in $HOME/.local
 276     _webi_done_message() {
 277         echo "Installed $(_webi_canonical_name) as $pkg_dst_cmd"
 278     }
 279
 280     ##
 281     ##
 282     ## BEGIN custom override functions from <package>/install.sh
 283     ##
 284     ##
 285
 286     WEBI_SINGLE=
 287
 288     echo ""
 289     echo "Thanks for using webi to install '$PKG_NAME' on '$WEBI_OS/$WEBI_ARCH'."
 290     echo "Have a problem? Experience a bug? Please let us know:"
 291     echo "        https://github.com/webinstall/packages/issues"
 292     echo ""
 293
 294     function __init_installer() {
 295
 296         {{ installer }}
 297
 298     }
 299
 300     __init_installer
 301
 302     ##
 303     ##
 304     ## END custom override functions
 305     ##
 306     ##
 307
 308     # run everything with defaults or overrides as needed
 309     if [ -n "$(command -v pkg_get_current_version)" ]; then
 310         pkg_cmd_name="${pkg_cmd_name:-$PKG_NAME}"
 311
 312         if [ -n "$WEBI_SINGLE" ]; then
 313             pkg_dst_cmd="${pkg_dst_cmd:-$HOME/.local/bin/$pkg_cmd_name}"
 314             pkg_dst="$pkg_dst_cmd" # "$(dirname "$(dirname $pkg_dst_cmd)")"
 315
 316             #pkg_src_cmd="${pkg_src_cmd:-$HOME/.local/opt/$pkg_cmd_name-v$WEBI_VERSION/bin/$pkg_cmd_name-v$WEBI_VERSION}"
 317             pkg_src_cmd="${pkg_src_cmd:-$HOME/.local/opt/$pkg_cmd_name-v$WEBI_VERSION/bin/$pkg_cmd_name}"
 318             pkg_src="$pkg_src_cmd" # "$(dirname "$(dirname $pkg_src_cmd)")"
 319         else
 320             pkg_dst="${pkg_dst:-$HOME/.local/opt/$pkg_cmd_name}"
 321             pkg_dst_cmd="${pkg_dst_cmd:-$pkg_dst/bin/$pkg_cmd_name}"
 322
 323             pkg_src="${pkg_src:-$HOME/.local/opt/$pkg_cmd_name-v$WEBI_VERSION}"
 324             pkg_src_cmd="${pkg_src_cmd:-$pkg_src/bin/$pkg_cmd_name}"
 325         fi
 326         pkg_src_bin="$(dirname "$pkg_src_cmd")"
 327         pkg_dst_bin="$(dirname "$pkg_dst_cmd")"
 328
 329         [ -n "$(command -v pkg_pre_install)" ] && pkg_pre_install || webi_pre_install
 330
 331         pushd "$WEBI_TMP" 2>&1 > /dev/null
 332         echo "Installing to $pkg_src_cmd"
 333         [ -n "$(command -v pkg_install)" ] && pkg_install || webi_install
 334         chmod a+x "$pkg_src"
 335         chmod a+x "$pkg_src_cmd"
 336         popd 2>&1 > /dev/null
 337
 338         webi_link
 339
 340         _webi_enable_exec
 341         pushd "$WEBI_TMP" 2>&1 > /dev/null
 342         [ -n "$(command -v pkg_post_install)" ] && pkg_post_install || webi_post_install
 343         popd 2>&1 > /dev/null
 344
 345         pushd "$WEBI_TMP" 2>&1 > /dev/null
 346         [ -n "$(command -v pkg_done_message)" ] && pkg_done_message || _webi_done_message
 347         popd 2>&1 > /dev/null
 348
 349         echo ""
 350     fi
 351
 352     webi_path_add "$HOME/.local/bin"
 353     if [ -z "${_WEBI_CHILD:-}" ] && [ -f '$_webi_tmp/.PATH.env' ]; then
 354         echo "You need to update your PATH to use $PKG_NAME:"
 355         echo ""
 356         cat "$_webi_tmp/.PATH.env" | sort -u
 357         rm -f "$_webi_tmp/.PATH.env"
 358     fi
 359
 360     # cleanup the temp directory
 361     rm -rf "$WEBI_TMP"
 362
 363     # See? No magic. Just downloading and moving files.
 364
 365 }
 366
 367 __bootstrap_webi