correctly identify AArch as ARM
[webi-installers/.git] / _webi / template.sh
index 191cf1081944fcf86170b0491836fcec72633dd4..1f231976a345d56a212d2b089d65dd55c59e03ad 100644 (file)
@@ -7,8 +7,10 @@ set -u
 #set -x
 
 #WEBI_PKG=
-#WEBI_NAME=
+#PKG_NAME=
 # TODO should this be BASEURL instead?
+#WEBI_OS=
+#WEBI_ARCH=
 #WEBI_HOST=
 #WEBI_RELEASES=
 #WEBI_CSV=
@@ -22,8 +24,12 @@ set -u
 #WEBI_LTS=
 #WEBI_CHANNEL=
 #WEBI_EXT=
+#WEBI_FORMATS=
 #WEBI_PKG_URL=
 #WEBI_PKG_FILE=
+#PKG_OSES=
+#PKG_ARCHES=
+#PKG_FORMATS=
 WEBI_UA="$(uname -a)"
 export WEBI_HOST
 
@@ -32,6 +38,7 @@ export WEBI_HOST
 ##
 
 WEBI_TMP=${WEBI_TMP:-"$(mktemp -d -t webinstall-${WEBI_PKG:-}.XXXXXXXX)"}
+export _webi_tmp="${_webi_tmp:-"$HOME/.local/opt/webi-tmp.d"}"
 
 mkdir -p "$HOME/Downloads"
 mkdir -p "$HOME/.local/bin"
@@ -45,6 +52,8 @@ export WEBI_CURL="$(command -v curl)"
 export WEBI_WGET="$(command -v wget)"
 set -e
 
+
+# get the special formatted version (i.e. "go is go1.14" while node is "node v12.10.8")
 my_versioned_name=""
 _webi_canonical_name() {
     if [ -n "$my_versioned_name" ]; then
@@ -61,6 +70,7 @@ _webi_canonical_name() {
     echo "$my_versioned_name"
 }
 
+# update symlinks according to $HOME/.local/opt and $HOME/.local/bin install paths.
 webi_link() {
     if [ -n "$(command -v pkg_link)" ]; then
         pkg_link
@@ -68,27 +78,22 @@ webi_link() {
     fi
 
     if [ -n "$WEBI_SINGLE" ] || [ "single" == "${1:-}" ]; then
-        if [ -d "$pkg_dst_cmd" ]; then
-            rm -rf -i "$pkg_dst_cmd"
-        else
-            rm -f "$pkg_dst_cmd"
-        fi
+        rm -rf "$pkg_dst_cmd"
         ln -s "$pkg_src_cmd" "$pkg_dst_cmd"
     else
-        # 'pkg_dst' will default to $HOME/.local/opt/node
-        # 'pkg_src' will be the installed version, such as to $HOME/.local/opt/node-v12.8.0
-        if [ -d "$pkg_dst" ]; then
-            rm -rf -i "$pkg_dst"
-        else
-            rm -f "$pkg_dst"
-        fi
+        # 'pkg_dst' will default to $HOME/.local/opt/<pkg>
+        # 'pkg_src' will be the installed version, such as to $HOME/.local/opt/<pkg>-<version>
+        rm -rf "$pkg_dst"
         ln -s "$pkg_src" "$pkg_dst"
     fi
 }
 
+# detect if this program is already installed or if an installed version may cause conflict
 webi_check() {
     # Test for existing version
     set +e
+    my_path="$PATH"
+    export PATH="$(dirname "$pkg_dst_cmd"):$PATH"
     my_current_cmd="$(command -v "$pkg_cmd_name")"
     set -e
     if [ -n "$my_current_cmd" ]; then
@@ -102,7 +107,7 @@ webi_check() {
             exit 0
         else
             if [ "$my_current_cmd" != "$pkg_dst_cmd" ]; then
-                echo "WARN: possible conflict between $my_canonical_name and $pkg_current_version at $my_current_cmd"
+                >&2 echo "WARN: possible conflict between $my_canonical_name and $pkg_current_version at $my_current_cmd"
             fi
             if [ -x "$pkg_src_cmd" ]; then
                 webi_link
@@ -111,16 +116,22 @@ webi_check() {
             fi
           fi
     fi
+    export PATH="$my_path"
 }
 
+# detect if file is downloaded, and how to download it
 webi_download() {
     if [ -n "${1:-}" ]; then
         my_url="$1"
     else
         if [ "error" == "$WEBI_CHANNEL" ]; then
             # TODO pass back requested OS / Arch / Version
-            echo "Error: no '$WEBI_NAME' release found for the given OS and architecture by that tag or version"
-            echo "       (check that the package name and version are correct)"
+            >&2 echo "Error: no '$PKG_NAME' release for '$WEBI_OS' on '$WEBI_ARCH' as one of '$WEBI_FORMATS' by the tag '$WEBI_TAG'"
+            >&2 echo "       '$PKG_NAME' is available for '$PKG_OSES' on '$PKG_ARCHES' as one of '$PKG_FORMATS'"
+            >&2 echo "       (check that the package name and version are correct)"
+            >&2 echo ""
+            >&2 echo "       Double check at $(echo "$WEBI_RELEASES" | sed 's:\?.*::')"
+            >&2 echo ""
             exit 1
         fi
         my_url="$WEBI_PKG_URL"
@@ -136,7 +147,7 @@ webi_download() {
         return 0
     fi
 
-    echo "Downloading $WEBI_NAME to $my_dl"
+    echo "Downloading $PKG_NAME to $my_dl"
 
     # It's only 2020, we can't expect to have reliable CLI tools
     # to tell us the size of a file as part of a base system...
@@ -146,7 +157,7 @@ webi_download() {
         set +e
         wget -q --show-progress --user-agent="wget $WEBI_UA" -c "$my_url" -O "$my_dl.part"
         if ! [ $? -eq 0 ]; then
-          echo "failed to download from $WEBI_PKG_URL"
+          >&2 echo "failed to download from $WEBI_PKG_URL"
           exit 1
         fi
         set -e
@@ -159,6 +170,7 @@ webi_download() {
     mv "$my_dl.part" "$my_dl"
 }
 
+# detect which archives can be used
 webi_extract() {
     pushd "$WEBI_TMP" 2>&1 >/dev/null
         if [ "tar" == "$WEBI_EXT" ]; then
@@ -166,10 +178,10 @@ webi_extract() {
             tar xf "$HOME/Downloads/$WEBI_PKG_FILE"
         elif [ "zip" == "$WEBI_EXT" ]; then
             echo "Extracting $HOME/Downloads/$WEBI_PKG_FILE"
-            unzip "$HOME/Downloads/$WEBI_PKG_FILE"
+            unzip "$HOME/Downloads/$WEBI_PKG_FILE" > __unzip__.log
         elif [ "exe" == "$WEBI_EXT" ]; then
-            # do nothing (but don't leave an empty if block either)
-            echo -n ""
+            echo "Moving $HOME/Downloads/$WEBI_PKG_FILE"
+            mv "$HOME/Downloads/$WEBI_PKG_FILE" .
         elif [ "xz" == "$WEBI_EXT" ]; then
             echo "Inflating $HOME/Downloads/$WEBI_PKG_FILE"
             unxz -c "$HOME/Downloads/$WEBI_PKG_FILE" > $(basename "$WEBI_PKG_FILE")
@@ -181,58 +193,56 @@ webi_extract() {
     popd 2>&1 >/dev/null
 }
 
+# use 'pathman' to update $HOME/.config/envman/PATH.env
 webi_path_add() {
     # make sure that we don't recursively install pathman with webi
     my_path="$PATH"
     export PATH="$HOME/.local/bin:$PATH"
-    set +e
-    my_pathman=$(command -v pathman)
-    set -e
-    export PATH="$my_path"
 
     # install pathman if not already installed
-    if [ -z "$my_pathman" ]; then
-        "$HOME/.local/bin/webi" pathman
-        export PATH="$HOME/.local/bin:$PATH"
+    if [ -z "$(command -v pathman)" ]; then
+        "$HOME/.local/bin/webi" pathman > /dev/null
     fi
 
+    export PATH="$my_path"
+
     # in case pathman was recently installed and the PATH not updated
-    "$HOME/.local/bin/pathman" add "$1"
+    mkdir -p "$_webi_tmp"
+    "$HOME/.local/bin/pathman" add "$1" | grep "export" >> "$_webi_tmp/.PATH.env" || true
 }
 
+# group common pre-install tasks as default
 webi_pre_install() {
     webi_check
     webi_download
     webi_extract
 }
 
+# move commands from the extracted archive directory to $HOME/.local/opt or $HOME/.local/bin
 webi_install() {
     if [ -n "$WEBI_SINGLE" ] || [ "single" == "${1:-}" ]; then
         mkdir -p "$(dirname $pkg_src_cmd)"
         mv ./"$pkg_cmd_name"* "$pkg_src_cmd"
         chmod a+x "$pkg_src_cmd"
     else
-        mkdir -p "$(dirname $pkg_src)"
-        if [ -d "$pkg_src" ]; then
-            rm -rf -i "$pkg_src"
-        else
-            rm -f "$pkg_src"
-        fi
+        rm -rf "$pkg_src"
         mv ./"$pkg_cmd_name"* "$pkg_src"
     fi
 }
 
+# run post-install functions - just updating PATH by default
 webi_post_install() {
-    webi_path_add "$pkg_dst_bin"
+    webi_path_add "$(dirname "$pkg_dst_cmd")"
 }
 
+# a friendly message when all is well, showing the final install path in $HOME/.local
 _webi_done_message() {
     echo "Installed $(_webi_canonical_name) as $pkg_dst_cmd"
 }
 
 ##
 ##
-## BEGIN user-submited script
+## BEGIN custom override functions from <package>/install.sh
 ##
 ##
 
@@ -246,30 +256,29 @@ WEBI_SINGLE=
 
 ##
 ##
-## END user-submitted script
+## END custom override functions
 ##
 ##
 
+# run everything with defaults or overrides as needed
 if [ -n "$(command -v pkg_get_current_version)" ]; then
-    pkg_cmd_name="${pkg_cmd_name:-$WEBI_NAME}"
+    pkg_cmd_name="${pkg_cmd_name:-$PKG_NAME}"
 
     if [ -n "$WEBI_SINGLE" ]; then
         pkg_dst_cmd="${pkg_dst_cmd:-$HOME/.local/bin/$pkg_cmd_name}"
-        pkg_dst_bin="$(dirname $pkg_dst_cmd)"
-        pkg_dst="$(dirname $pkg_dst_bin)"
+        pkg_dst="$pkg_dst_cmd" # "$(dirname "$(dirname $pkg_dst_cmd)")"
 
-        pkg_src_cmd="${pkg_src_cmd:-$HOME/.local/xbin/$pkg_cmd_name-$WEBI_VERSION}"
-        pkg_src_bin="$(dirname $pkg_src_cmd)"
-        pkg_src="$(dirname $pkg_src_bin)"
+        pkg_src_cmd="${pkg_src_cmd:-$HOME/.local/xbin/$pkg_cmd_name-v$WEBI_VERSION}"
+        pkg_src="$pkg_src_cmd" # "$(dirname "$(dirname $pkg_src_cmd)")"
     else
         pkg_dst="${pkg_dst:-$HOME/.local/opt/$pkg_cmd_name}"
-        pkg_dst_bin="${pkg_dst_bin:-$pkg_dst/bin}"
-        pkg_dst_cmd="${pkg_dst_cmd:-$pkg_dst_bin/$pkg_cmd_name}"
+        pkg_dst_cmd="${pkg_dst_cmd:-$pkg_dst/bin/$pkg_cmd_name}"
 
         pkg_src="${pkg_src:-$HOME/.local/opt/$pkg_cmd_name-v$WEBI_VERSION}"
-        pkg_src_bin="${pkg_src_bin:-$pkg_src/bin}"
-        pkg_src_cmd="${pkg_src_cmd:-$pkg_src_bin/$pkg_cmd_name}"
+        pkg_src_cmd="${pkg_src_cmd:-$pkg_src/bin/$pkg_cmd_name}"
     fi
+    pkg_src_bin="$(dirname "$pkg_src_cmd")"
+    pkg_dst_bin="$(dirname "$pkg_dst_cmd")"
 
     [ -n "$(command -v pkg_pre_install)" ] && pkg_pre_install || webi_pre_install
 
@@ -291,6 +300,17 @@ if [ -n "$(command -v pkg_get_current_version)" ]; then
     echo ""
 fi
 
+webi_path_add "$HOME/.local/bin"
+if [ -z "${_WEBI_CHILD:-}" ] && [ -f "\$_webi_tmp/.PATH.env" ]; then
+    echo "You need to update your PATH to use $PKG_NAME:"
+    echo ""
+    cat "$_webi_tmp/.PATH.env" | sort -u
+    rm -f "$_webi_tmp/.PATH.env"
+fi
+
+# cleanup the temp directory
 rm -rf "$WEBI_TMP"
 
+# See? No magic. Just downloading and moving files.
+
 }