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