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