lib.sh 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877
  1. #!/usr/bin/env bash
  2. # -*- coding: utf-8; mode: sh indent-tabs-mode: nil -*-
  3. # SPDX-License-Identifier: AGPL-3.0-or-later
  4. # shellcheck disable=SC2059,SC1117
  5. ADMIN_NAME="${ADMIN_NAME:-$(git config user.name)}"
  6. ADMIN_NAME="${ADMIN_NAME:-$USER}"
  7. ADMIN_EMAIL="${ADMIN_EMAIL:-$(git config user.email)}"
  8. ADMIN_EMAIL="${ADMIN_EMAIL:-$USER@$(hostname)}"
  9. if [[ -z "${REPO_ROOT}" ]]; then
  10. REPO_ROOT=$(dirname "${BASH_SOURCE[0]}")
  11. while [ -h "${REPO_ROOT}" ] ; do
  12. REPO_ROOT=$(readlink "${REPO_ROOT}")
  13. done
  14. REPO_ROOT=$(cd "${REPO_ROOT}/.." && pwd -P )
  15. fi
  16. if [[ -z ${TEMPLATES} ]]; then
  17. TEMPLATES="${REPO_ROOT}/utils/templates"
  18. fi
  19. if [[ -z "$CACHE" ]]; then
  20. CACHE="${REPO_ROOT}/cache"
  21. fi
  22. if [[ -z ${DIFF_CMD} ]]; then
  23. DIFF_CMD="diff -u"
  24. if command -v colordiff >/dev/null; then
  25. DIFF_CMD="colordiff -u"
  26. fi
  27. fi
  28. DOT_CONFIG="${DOT_CONFIG:-${REPO_ROOT}/.config.sh}"
  29. source_dot_config() {
  30. if [[ ! -e "${DOT_CONFIG}" ]]; then
  31. err_msg "configuration does not extsts at: ${DOT_CONFIG}"
  32. return 42
  33. fi
  34. # shellcheck disable=SC1090
  35. source "${DOT_CONFIG}"
  36. }
  37. sudo_or_exit() {
  38. # usage: sudo_or_exit
  39. if [ ! "$(id -u)" -eq 0 ]; then
  40. err_msg "this command requires root (sudo) privilege!" >&2
  41. exit 42
  42. fi
  43. }
  44. required_commands() {
  45. # usage: requires_commands [cmd1 ...]
  46. local exit_val=0
  47. while [ -n "$1" ]; do
  48. if ! command -v "$1" &>/dev/null; then
  49. err_msg "missing command $1"
  50. exit_val=42
  51. fi
  52. shift
  53. done
  54. return $exit_val
  55. }
  56. # colors
  57. # ------
  58. # shellcheck disable=SC2034
  59. set_terminal_colors() {
  60. _colors=8
  61. _creset='\e[0m' # reset all attributes
  62. _Black='\e[0;30m'
  63. _White='\e[1;37m'
  64. _Red='\e[0;31m'
  65. _Green='\e[0;32m'
  66. _Yellow='\e[0;33m'
  67. _Blue='\e[0;34m'
  68. _Violet='\e[0;35m'
  69. _Cyan='\e[0;36m'
  70. _BBlack='\e[1;30m'
  71. _BWhite='\e[1;37m'
  72. _BRed='\e[1;31m'
  73. _BGreen='\e[1;32m'
  74. _BYellow='\e[1;33m'
  75. _BBlue='\e[1;34m'
  76. _BPurple='\e[1;35m'
  77. _BCyan='\e[1;36m'
  78. }
  79. if [ ! -p /dev/stdout ]; then
  80. set_terminal_colors
  81. fi
  82. # reST
  83. # ----
  84. if command -v fmt >/dev/null; then
  85. export FMT="fmt -u"
  86. else
  87. export FMT="cat"
  88. fi
  89. rst_title() {
  90. # usage: rst_title <header-text> [part|chapter|section]
  91. case ${2-chapter} in
  92. part) printf "\n${_BGreen}${1//?/=}\n${_BCyan}${1}${_BGreen}\n${1//?/=}${_creset}\n";;
  93. chapter) printf "\n${_BCyan}${1}\n${_BGreen}${1//?/=}${_creset}\n";;
  94. section) printf "\n${_BCyan}${1}\n${_BGreen}${1//?/-}${_creset}\n";;
  95. *)
  96. err_msg "invalid argument '${2}' in line $(caller)"
  97. return 42
  98. ;;
  99. esac
  100. }
  101. rst_para() {
  102. # usage: RST_INDENT=1 rst_para "lorem ipsum ..."
  103. local prefix=''
  104. if [[ -n $RST_INDENT ]] && [[ $RST_INDENT -gt 0 ]]; then
  105. prefix="$(for i in $(seq 1 "$RST_INDENT"); do printf " "; done)"
  106. echo -en "\n$*\n" | $FMT | prefix_stdout "$prefix"
  107. else
  108. echo -en "\n$*\n" | $FMT
  109. fi
  110. }
  111. err_msg() { echo -e "${_BRed}ERROR:${_creset} $*" >&2; }
  112. warn_msg() { echo -e "${_BBlue}WARN:${_creset} $*" >&2; }
  113. info_msg() { echo -e "${_BYellow}INFO:${_creset} $*" >&2; }
  114. clean_stdin() {
  115. if [[ $(uname -s) != 'Darwin' ]]; then
  116. while read -r -n1 -t 0.1; do : ; done
  117. fi
  118. }
  119. wait_key(){
  120. # usage: waitKEY [<timeout in sec>]
  121. clean_stdin
  122. local _t=$1
  123. local msg="${MSG}"
  124. [[ -z "$msg" ]] && msg="${_Green}** press any [${_BCyan}KEY${_Green}] to continue **${_creset}"
  125. [[ -n $FORCE_TIMEOUT ]] && _t=$FORCE_TIMEOUT
  126. [[ -n $_t ]] && _t="-t $_t"
  127. printf "$msg"
  128. # shellcheck disable=SC2086
  129. read -r -s -n1 $_t
  130. echo
  131. clean_stdin
  132. }
  133. ask_yn() {
  134. # usage: ask_yn <prompt-text> [Ny|Yn] [<timeout in sec>]
  135. local EXIT_YES=0 # exit status 0 --> successful
  136. local EXIT_NO=1 # exit status 1 --> error code
  137. local _t=$3
  138. [[ -n $FORCE_TIMEOUT ]] && _t=$FORCE_TIMEOUT
  139. [[ -n $_t ]] && _t="-t $_t"
  140. case "${FORCE_SELECTION:-${2}}" in
  141. Y) return ${EXIT_YES} ;;
  142. N) return ${EXIT_NO} ;;
  143. Yn)
  144. local exit_val=${EXIT_YES}
  145. local choice="[${_BGreen}YES${_creset}/no]"
  146. local default="Yes"
  147. ;;
  148. *)
  149. local exit_val=${EXIT_NO}
  150. local choice="[${_BGreen}NO${_creset}/yes]"
  151. local default="No"
  152. ;;
  153. esac
  154. echo
  155. while true; do
  156. clean_stdin
  157. printf "$1 ${choice} "
  158. # shellcheck disable=SC2086
  159. read -r -n1 $_t
  160. if [[ -z $REPLY ]]; then
  161. printf "$default\n"; break
  162. elif [[ $REPLY =~ ^[Yy]$ ]]; then
  163. exit_val=${EXIT_YES}
  164. printf "\n"
  165. break
  166. elif [[ $REPLY =~ ^[Nn]$ ]]; then
  167. exit_val=${EXIT_NO}
  168. printf "\n"
  169. break
  170. fi
  171. _t=""
  172. err_msg "invalid choice"
  173. done
  174. clean_stdin
  175. return $exit_val
  176. }
  177. tee_stderr () {
  178. # usage::
  179. # tee_stderr 1 <<EOF | python -i
  180. # print("hello")
  181. # EOF
  182. # ...
  183. # >>> print("hello")
  184. # hello
  185. local _t="0";
  186. if [[ -n $1 ]] ; then _t="$1"; fi
  187. (while read -r line; do
  188. # shellcheck disable=SC2086
  189. sleep $_t
  190. echo -e "$line" >&2
  191. echo "$line"
  192. done)
  193. }
  194. prefix_stdout () {
  195. # usage: <cmd> | prefix_stdout [prefix]
  196. local prefix="${_BYellow}-->|${_creset}"
  197. if [[ -n $1 ]] ; then prefix="${_BYellow}$1${_creset}"; fi
  198. # shellcheck disable=SC2162
  199. (while IFS= read line; do
  200. echo -e "${prefix}$line"
  201. done)
  202. }
  203. append_line() {
  204. # usage: append_line <line> <file>
  205. #
  206. # Append line if not exists, create file if not exists. E.g::
  207. #
  208. # append_line 'source ~/.foo' ~/bashrc
  209. local LINE=$1
  210. local FILE=$2
  211. grep -qFs -- "$LINE" "$FILE" || echo "$LINE" >> "$FILE"
  212. }
  213. cache_download() {
  214. # usage: cache_download <url> <local-filename>
  215. local exit_value=0
  216. if [[ -n ${SUDO_USER} ]]; then
  217. sudo -u "${SUDO_USER}" mkdir -p "${CACHE}"
  218. else
  219. mkdir -p "${CACHE}"
  220. fi
  221. if [[ -f "${CACHE}/$2" ]] ; then
  222. info_msg "already cached: $1"
  223. info_msg " --> ${CACHE}/$2"
  224. fi
  225. if [[ ! -f "${CACHE}/$2" ]]; then
  226. info_msg "caching: $1"
  227. info_msg " --> ${CACHE}/$2"
  228. if [[ -n ${SUDO_USER} ]]; then
  229. sudo -u "${SUDO_USER}" wget --progress=bar -O "${CACHE}/$2" "$1" ; exit_value=$?
  230. else
  231. wget --progress=bar -O "${CACHE}/$2" "$1" ; exit_value=$?
  232. fi
  233. if [[ ! $exit_value = 0 ]]; then
  234. err_msg "failed to download: $1"
  235. fi
  236. fi
  237. }
  238. choose_one() {
  239. # usage:
  240. #
  241. # DEFAULT_SELECT= 2 \
  242. # choose_one <name> "your selection?" "Coffee" "Coffee with milk"
  243. local default=${DEFAULT_SELECT-1}
  244. local REPLY
  245. local env_name=$1 && shift
  246. local choice=$1;
  247. local max="${#@}"
  248. local _t
  249. [[ -n $FORCE_TIMEOUT ]] && _t=$FORCE_TIMEOUT
  250. [[ -n $_t ]] && _t="-t $_t"
  251. list=("$@")
  252. echo -e "${_BGreen}Menu::${_creset}"
  253. for ((i=1; i<= $((max -1)); i++)); do
  254. if [[ "$i" == "$default" ]]; then
  255. echo -e " ${_BGreen}$i.${_creset}) ${list[$i]} [default]"
  256. else
  257. echo -e " $i.) ${list[$i]}"
  258. fi
  259. done
  260. while true; do
  261. clean_stdin
  262. printf "$1 [${_BGreen}$default${_creset}] "
  263. if (( 10 > max )); then
  264. # shellcheck disable=SC2086
  265. read -r -n1 $_t
  266. else
  267. # shellcheck disable=SC2086,SC2229
  268. read -r $_t
  269. fi
  270. # selection fits
  271. [[ $REPLY =~ ^-?[0-9]+$ ]] && (( REPLY > 0 )) && (( REPLY < max )) && break
  272. # take default
  273. [[ -z $REPLY ]] && REPLY=$default && break
  274. _t=""
  275. err_msg "invalid choice"
  276. done
  277. eval "$env_name"='${list[${REPLY}]}'
  278. echo
  279. clean_stdin
  280. }
  281. install_template() {
  282. # usage:
  283. #
  284. # install_template [--no-eval] [--variant=<name>] \
  285. # {file} [{owner} [{group} [{chmod}]]]
  286. #
  287. # E.g. the origin of variant 'raw' of /etc/updatedb.conf is::
  288. #
  289. # ${TEMPLATES}/etc/updatedb.conf:raw
  290. #
  291. # To install variant 'raw' of /etc/updatedb.conf without evaluated
  292. # replacements you can use::
  293. #
  294. # install_template --variant=raw --no-eval \
  295. # /etc/updatedb.conf root root 644
  296. local _reply=""
  297. local do_eval=1
  298. local variant=""
  299. local pos_args=("$0")
  300. for i in "$@"; do
  301. case $i in
  302. --no-eval) do_eval=0; shift ;;
  303. --variant=*) variant=":${i#*=}"; shift ;;
  304. *) pos_args+=("$i") ;;
  305. esac
  306. done
  307. local dst="${pos_args[1]}"
  308. local template_origin="${TEMPLATES}${dst}${variant}"
  309. local template_file="${TEMPLATES}${dst}"
  310. local owner="${pos_args[2]-$(id -un)}"
  311. local group="${pos_args[3]-$(id -gn)}"
  312. local chmod="${pos_args[4]-644}"
  313. info_msg "install (eval=$do_eval): ${dst}"
  314. [[ -n $variant ]] && info_msg "variant: ${variant}"
  315. if [[ ! -f "${template_origin}" ]] ; then
  316. err_msg "${template_origin} does not exists"
  317. err_msg "... can't install $dst"
  318. wait_key 30
  319. return 42
  320. fi
  321. if [[ "$do_eval" == "1" ]]; then
  322. template_file="${CACHE}${dst}${variant}"
  323. info_msg "BUILD template ${template_file}"
  324. if [[ -n ${SUDO_USER} ]]; then
  325. sudo -u "${SUDO_USER}" mkdir -p "$(dirname "${template_file}")"
  326. else
  327. mkdir -p "$(dirname "${template_file}")"
  328. fi
  329. # shellcheck disable=SC2086
  330. eval "echo \"$(cat ${template_origin})\"" > "${template_file}"
  331. if [[ -n ${SUDO_USER} ]]; then
  332. chown "${SUDO_USER}:${SUDO_USER}" "${template_file}"
  333. fi
  334. else
  335. template_file=$template_origin
  336. fi
  337. mkdir -p "$(dirname "${dst}")"
  338. if [[ ! -f "${dst}" ]]; then
  339. info_msg "install: ${template_file}"
  340. sudo -H install -v -o "${owner}" -g "${group}" -m "${chmod}" \
  341. "${template_file}" "${dst}" | prefix_stdout
  342. return $?
  343. fi
  344. if [[ -f "${dst}" ]] && cmp --silent "${template_file}" "${dst}" ; then
  345. info_msg "file ${dst} allready installed"
  346. return 0
  347. fi
  348. info_msg "diffrent file ${dst} allready exists on this host"
  349. while true; do
  350. choose_one _reply "choose next step with file $dst" \
  351. "replace file" \
  352. "leave file unchanged" \
  353. "interactiv shell" \
  354. "diff files"
  355. case $_reply in
  356. "replace file")
  357. info_msg "install: ${template_file}"
  358. sudo -H install -v -o "${owner}" -g "${group}" -m "${chmod}" \
  359. "${template_file}" "${dst}" | prefix_stdout
  360. break
  361. ;;
  362. "leave file unchanged")
  363. break
  364. ;;
  365. "interactiv shell")
  366. echo "// edit ${dst} to your needs"
  367. echo -e "// exit with [${_BCyan}CTRL-D${_creset}]"
  368. sudo -H -u "${owner}" -i
  369. $DIFF_CMD "${dst}" "${template_file}"
  370. echo
  371. echo "${_BBlack}did you edit file ...${_creset}"
  372. printf " ${template_file}"
  373. if ask_yn "... to your needs?"; then
  374. break
  375. fi
  376. ;;
  377. "diff files")
  378. $DIFF_CMD "${dst}" "${template_file}" | prefix_stdout
  379. esac
  380. done
  381. }
  382. service_is_available() {
  383. # usage: service_is_available <URL>
  384. local URL="$1"
  385. if [[ -z $URL ]]; then
  386. err_msg "service_is_available: missing arguments"
  387. return 42
  388. fi
  389. http_code=$(curl -H 'Cache-Control: no-cache' \
  390. --silent -o /dev/null --head --write-out '%{http_code}' --insecure \
  391. "${URL}")
  392. exit_val=$?
  393. if [[ $exit_val = 0 ]]; then
  394. info_msg "got $http_code from ${URL}"
  395. fi
  396. case "$http_code" in
  397. 404|410|423) exit_val=$http_code;;
  398. esac
  399. return "$exit_val"
  400. }
  401. # golang
  402. # ------
  403. go_is_available() {
  404. # usage: go_is_available $SERVICE_USER && echo "go is installed!"
  405. sudo -i -u "${1}" which go &>/dev/null
  406. }
  407. install_go() {
  408. # usage: install_go "${GO_PKG_URL}" "${GO_TAR}" "${SERVICE_USER}"
  409. local _svcpr=" |${3}| "
  410. rst_title "Install Go in user's HOME" section
  411. rst_para "download and install go binary .."
  412. cache_download "${1}" "${2}"
  413. tee_stderr 0.1 <<EOF | sudo -i -u "${3}" | prefix_stdout "$_svcpr"
  414. echo \$PATH
  415. echo \$GOPATH
  416. mkdir -p \$HOME/local
  417. rm -rf \$HOME/local/go
  418. tar -C \$HOME/local -xzf ${CACHE}/${2}
  419. EOF
  420. sudo -i -u "${3}" <<EOF | prefix_stdout
  421. ! which go >/dev/null && echo "ERROR - Go Installation not found in PATH!?!"
  422. which go >/dev/null && go version && echo "congratulations -- Go installation OK :)"
  423. EOF
  424. }
  425. # system accounts
  426. # ---------------
  427. service_account_is_available() {
  428. # usage: service_account_is_available "$SERVICE_USER" && echo "OK"
  429. sudo -i -u "$1" echo \$HOME &>/dev/null
  430. }
  431. drop_service_account() {
  432. # usage: drop_service_account "${SERVICE_USER}"
  433. rst_title "Drop ${1} HOME" section
  434. if ask_yn "Do you really want to drop ${1} home folder?"; then
  435. userdel -r -f "${1}" 2>&1 | prefix_stdout
  436. else
  437. rst_para "Leave HOME folder $(du -sh "${1}") unchanged."
  438. fi
  439. }
  440. interactive_shell(){
  441. # usage: interactive_shell "${SERVICE_USER}"
  442. echo -e "// exit with [${_BCyan}CTRL-D${_creset}]"
  443. sudo -H -u "${1}" -i
  444. }
  445. # systemd
  446. # -------
  447. SYSTEMD_UNITS="${SYSTEMD_UNITS:-/lib/systemd/system}"
  448. systemd_install_service() {
  449. # usage: systemd_install_service "${SERVICE_NAME}" "${SERVICE_SYSTEMD_UNIT}"
  450. rst_title "Install System-D Unit ${1}" section
  451. echo
  452. install_template "${2}" root root 644
  453. wait_key
  454. systemd_activate_service "${1}"
  455. }
  456. systemd_remove_service() {
  457. # usage: systemd_remove_service "${SERVICE_NAME}" "${SERVICE_SYSTEMD_UNIT}"
  458. if ! ask_yn "Do you really want to deinstall systemd unit ${1}?"; then
  459. return 42
  460. fi
  461. systemd_deactivate_service "${1}"
  462. rm "${2}" 2>&1 | prefix_stdout
  463. }
  464. systemd_activate_service() {
  465. # usage: systemd_activate_service "${SERVICE_NAME}"
  466. rst_title "Activate ${1} (service)" section
  467. echo
  468. tee_stderr <<EOF | bash 2>&1
  469. systemctl enable ${1}.service
  470. systemctl restart ${1}.service
  471. EOF
  472. tee_stderr <<EOF | bash 2>&1
  473. systemctl status --no-pager ${1}.service
  474. EOF
  475. }
  476. systemd_deactivate_service() {
  477. # usage: systemd_deactivate_service "${SERVICE_NAME}"
  478. rst_title "De-Activate ${1} (service)" section
  479. echo
  480. tee_stderr <<EOF | bash 2>&1 | prefix_stdout
  481. systemctl stop ${1}.service
  482. systemctl disable ${1}.service
  483. EOF
  484. }
  485. systemd_restart_service() {
  486. # usage: systemd_restart_service "${SERVICE_NAME}"
  487. rst_title "Restart ${1} (service)" section
  488. echo
  489. tee_stderr <<EOF | bash 2>&1
  490. systemctl restart ${1}.service
  491. EOF
  492. tee_stderr <<EOF | bash 2>&1
  493. systemctl status --no-pager ${1}.service
  494. EOF
  495. }
  496. # Apache
  497. # ------
  498. # FIXME: Arch Linux & RHEL should be added
  499. if [[ -z "${APACHE_SITES_AVAILABE}" ]]; then
  500. APACHE_SITES_AVAILABE="/etc/apache2/sites-available"
  501. fi
  502. apache_is_installed() {
  503. (command -v apachectl \
  504. && command -v a2ensite \
  505. && command -v a2dissite ) &>/dev/null
  506. }
  507. apache_reload() {
  508. info_msg "reload apache .."
  509. echo
  510. sudo -H apachectl configtest
  511. sudo -H service apache2 force-reload
  512. }
  513. apache_install_site() {
  514. # usage: apache_install_site [<template option> ...] <mysite.conf>
  515. #
  516. # <template option>: see install_template
  517. local template_opts=()
  518. local pos_args=("$0")
  519. for i in "$@"; do
  520. case $i in
  521. -*) template_opts+=("$i");;
  522. *) pos_args+=("$i");;
  523. esac
  524. done
  525. install_template "${template_opts[@]}" \
  526. "${APACHE_SITES_AVAILABE}/${pos_args[1]}" \
  527. root root 644
  528. apache_enable_site "${pos_args[1]}"
  529. info_msg "installed apache site: ${pos_args[1]}"
  530. }
  531. apache_remove_site() {
  532. # usage: apache_remove_site <mysite.conf>
  533. info_msg "remove apache site: $1"
  534. apache_dissable_site "$1"
  535. rm -f "${APACHE_SITES_AVAILABE}/$1"
  536. }
  537. apache_enable_site() {
  538. # usage: apache_enable_site <mysite.conf>
  539. info_msg "enable apache site: $1"
  540. sudo -H a2ensite -q "$1"
  541. apache_reload
  542. }
  543. apache_dissable_site() {
  544. # usage: apache_disable_site <mysite.conf>
  545. info_msg "disable apache site: $1"
  546. sudo -H a2dissite -q "$1"
  547. apache_reload
  548. }
  549. # uWSGI
  550. # -----
  551. uWSGI_SETUP="${uWSGI_SETUP:=/etc/uwsgi}"
  552. uWSGI_restart() {
  553. # usage: uWSGI_restart()
  554. info_msg "restart uWSGI service"
  555. systemctl restart uwsgi
  556. }
  557. uWSGI_app_available() {
  558. # usage: uWSGI_app_available <myapp.ini>
  559. local CONF="$1"
  560. if [[ -z $CONF ]]; then
  561. err_msg "uWSGI_app_available: missing arguments"
  562. return 42
  563. fi
  564. [[ -f "${uWSGI_SETUP}/apps-available/${CONF}" ]]
  565. }
  566. uWSGI_install_app() {
  567. # usage: uWSGI_install_app [<template option> ...] <myapp.ini>
  568. #
  569. # <template option>: see install_template
  570. local pos_args=("$0")
  571. for i in "$@"; do
  572. case $i in
  573. -*) template_opts+=("$i");;
  574. *) pos_args+=("$i");;
  575. esac
  576. done
  577. install_template "${template_opts[@]}" \
  578. "${uWSGI_SETUP}/apps-available/${pos_args[1]}" \
  579. root root 644
  580. uWSGI_enable_app "${pos_args[1]}"
  581. uWSGI_restart
  582. info_msg "installed uWSGI app: ${pos_args[1]}"
  583. }
  584. uWSGI_remove_app() {
  585. # usage: uWSGI_remove_app <myapp.ini>
  586. local CONF="$1"
  587. info_msg "remove uWSGI app: ${CONF}"
  588. uWSGI_disable_app "${CONF}"
  589. uWSGI_restart
  590. rm -f "${uWSGI_SETUP}/apps-available/${CONF}"
  591. }
  592. uWSGI_app_enabled() {
  593. # usage: uWSGI_app_enabled <myapp.ini>
  594. local CONF="$1"
  595. if [[ -z $CONF ]]; then
  596. err_msg "uWSGI_app_enabled: missing arguments"
  597. return 42
  598. fi
  599. [[ -f "${uWSGI_SETUP}/apps-enabled/${CONF}" ]]
  600. }
  601. # shellcheck disable=SC2164
  602. uWSGI_enable_app() {
  603. # usage: uWSGI_enable_app <myapp.ini>
  604. local CONF="$1"
  605. if [[ -z $CONF ]]; then
  606. err_msg "uWSGI_enable_app: missing arguments"
  607. return 42
  608. fi
  609. pushd "${uWSGI_SETUP}/apps-enabled" >/dev/null
  610. rm -f "$CONF"
  611. # shellcheck disable=SC2226
  612. ln -s "../apps-available/${CONF}"
  613. info_msg "enabled uWSGI app: ${CONF} (restart uWSGI required)"
  614. popd >/dev/null
  615. }
  616. uWSGI_disable_app() {
  617. # usage: uWSGI_disable_app <myapp.ini>
  618. local CONF="$1"
  619. if [[ -z $CONF ]]; then
  620. err_msg "uWSGI_enable_app: missing arguments"
  621. return 42
  622. fi
  623. rm -f "${uWSGI_SETUP}/apps-enabled/${CONF}"
  624. # FIXME: restart uwsgi service won't stop wsgi forked processes of user searx.
  625. # I had to kill them manually here ...
  626. pkill -f "${uWSGI_SETUP}/apps-enabled/${CONF}" -9
  627. info_msg "disabled uWSGI app: ${CONF} (restart uWSGI required)"
  628. }
  629. # distro's package manager
  630. # ------------------------
  631. #
  632. # FIXME: Arch Linux & RHEL should be added
  633. #
  634. pkg_install() {
  635. # usage: TITEL='install foobar' pkg_install foopkg barpkg
  636. rst_title "${TITLE:-installation of packages}" section
  637. echo -en "\npackage(s)::\n\n $*\n" | $FMT
  638. if ! ask_yn "Should packages be installed?" Yn 30; then
  639. return 42
  640. fi
  641. # shellcheck disable=SC2068
  642. apt-get install -y $@
  643. }
  644. pkg_remove() {
  645. # usage: TITEL='remove foobar' pkg_remove foopkg barpkg
  646. rst_title "${TITLE:-remove packages}" section
  647. echo -en "\npackage(s)::\n\n $*\n" | $FMT
  648. if ! ask_yn "Should packages be removed (purge)?" Yn 30; then
  649. return 42
  650. fi
  651. apt-get purge --autoremove --ignore-missing -y "$@"
  652. }
  653. pkg_is_installed() {
  654. # usage: pkg_is_install foopkg || pkg_install foopkg
  655. dpkg -l "$1" &> /dev/null
  656. return $?
  657. }
  658. # git tooling
  659. # -----------
  660. # shellcheck disable=SC2164
  661. git_clone() {
  662. # usage:
  663. #
  664. # git_clone <url> <name> [<branch> [<user>]]
  665. # git_clone <url> <path> [<branch> [<user>]]
  666. #
  667. # First form uses $CACHE/<name> as destination folder, second form clones
  668. # into <path>. If repository is allready cloned, pull from <branch> and
  669. # update working tree (if needed, the caller has to stash local changes).
  670. #
  671. # git clone https://github.com/asciimoo/searx searx-src origin/master searxlogin
  672. #
  673. local url="$1"
  674. local dest="$2"
  675. local branch="$3"
  676. local user="$4"
  677. local bash_cmd="bash"
  678. local remote="origin"
  679. if [[ ! "${dest:0:1}" = "/" ]]; then
  680. dest="$CACHE/$dest"
  681. fi
  682. [[ -z $branch ]] && branch=master
  683. [[ -z $user ]] && [[ -n "${SUDO_USER}" ]] && user="${SUDO_USER}"
  684. [[ -n $user ]] && bash_cmd="sudo -H -u $user -i"
  685. if [[ -d "${dest}" ]] ; then
  686. info_msg "already cloned: $dest"
  687. tee_stderr 0.1 <<EOF | $bash_cmd 2>&1 | prefix_stdout " |$user| "
  688. cd "${dest}"
  689. git checkout -m -B "$branch" --track "$remote/$branch"
  690. git pull --all
  691. EOF
  692. else
  693. info_msg "clone into: $dest"
  694. tee_stderr 0.1 <<EOF | $bash_cmd 2>&1 | prefix_stdout " |$user| "
  695. mkdir -p "$(dirname "$dest")"
  696. cd "$(dirname "$dest")"
  697. git clone --branch "$branch" --origin "$remote" "$url" "$(basename "$dest")"
  698. EOF
  699. fi
  700. }