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