core_messages.sh 25 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060
  1. #!/bin/bash
  2. # LinuxGSM core_messages.sh module
  3. # Author: Daniel Gibbs
  4. # Contributors: https://linuxgsm.com/contrib
  5. # Website: https://linuxgsm.com
  6. # Description: Defines on-screen messages such as [ OK ] and how script logs look.
  7. moduleselfname="$(basename "$(readlink -f "${BASH_SOURCE[0]}")")"
  8. # nl: new line: message is following by a new line.
  9. # eol: end of line: message is placed at the end of the current line.
  10. fn_ansi_loader() {
  11. # carriage return.
  12. creeol="\r"
  13. if [ "${ansi}" != "off" ]; then
  14. # echo colors
  15. default="\e[0m"
  16. black="\e[30m"
  17. red="\e[31m"
  18. lightred="\e[91m"
  19. green="\e[32m"
  20. lightgreen="\e[92m"
  21. yellow="\e[33m"
  22. lightyellow="\e[93m"
  23. blue="\e[34m"
  24. lightblue="\e[94m"
  25. magenta="\e[35m"
  26. lightmagenta="\e[95m"
  27. cyan="\e[36m"
  28. lightcyan="\e[96m"
  29. darkgrey="\e[90m"
  30. lightgrey="\e[37m"
  31. white="\e[97m"
  32. # erase to end of line.
  33. creeol+="\033[K"
  34. fi
  35. # carriage return & erase to end of line.
  36. creeol="\r\033[K"
  37. bold="\e[1m"
  38. dim="\e[2m"
  39. italic="\e[3m"
  40. underline="\e[4m"
  41. reverse="\e[7m"
  42. }
  43. fn_sleep_time() {
  44. sleep "0.1"
  45. }
  46. fn_sleep_time_05() {
  47. sleep "0.5"
  48. }
  49. fn_sleep_time_1() {
  50. sleep "1"
  51. }
  52. fn_sleep_time_5() {
  53. sleep "5"
  54. }
  55. fn_sleep_time_10() {
  56. sleep "10"
  57. }
  58. # Log display
  59. ########################
  60. ## Feb 28 14:56:58 ut99-server: Monitor:
  61. fn_script_log() {
  62. if [ -d "${lgsmlogdir}" ]; then
  63. if [ -n "${commandname}" ]; then
  64. echo -e "$(date '+%b %d %H:%M:%S.%3N') ${selfname}: ${commandname}: ${1}" >> "${lgsmlog}"
  65. else
  66. echo -e "$(date '+%b %d %H:%M:%S.%3N') ${selfname}: ${1}" >> "${lgsmlog}"
  67. fi
  68. fi
  69. }
  70. ## Feb 28 14:56:58 ut99-server: Monitor: PASS:
  71. fn_script_log_pass() {
  72. fn_script_log "PASS: ${1}"
  73. exitcode=0
  74. }
  75. ## Feb 28 14:56:58 ut99-server: Monitor: FATAL:
  76. fn_script_log_fail() {
  77. fn_script_log "FAIL: ${1}"
  78. exitcode=1
  79. }
  80. ## Feb 28 14:56:58 ut99-server: Monitor: ERROR:
  81. fn_script_log_error() {
  82. fn_script_log "ERROR: ${1}"
  83. exitcode=2
  84. }
  85. ## Feb 28 14:56:58 ut99-server: Monitor: WARN:
  86. fn_script_log_warn() {
  87. fn_script_log "WARN: ${1}"
  88. exitcode=3
  89. }
  90. ## Feb 28 14:56:58 ut99-server: Monitor: INFO:
  91. fn_script_log_info() {
  92. fn_script_log "INFO: ${1}"
  93. }
  94. # On-Screen - Automated functions
  95. ##################################
  96. fn_print() {
  97. echo -en "$*${default}"
  98. }
  99. fn_print_nl() {
  100. echo -e "$*${default}"
  101. }
  102. # Helper function to print messages with a specific format and color
  103. fn_print_message() {
  104. local type="$1"
  105. local color="$2"
  106. local message="$3"
  107. if [ "${commandaction}" ]; then
  108. echo -en "${bold}${creeol}[${color} ${type} ${default}]${default} ${commandaction} ${selfname}: ${message}${default}"
  109. else
  110. echo -en "${bold}${creeol}[${color} ${type} ${default}]${default} ${message}${default}"
  111. fi
  112. fn_sleep_time
  113. }
  114. fn_print_message_nl() {
  115. local type="$1"
  116. local color="$2"
  117. local message="$3"
  118. if [ "${commandaction}" ]; then
  119. echo -e "${bold}${creeol}[${color} ${type} ${default}]${default} ${commandaction} ${selfname}: ${message}${default}"
  120. else
  121. echo -e "${bold}${creeol}[${color} ${type} ${default}]${default} ${message}${default}"
  122. fi
  123. fn_sleep_time
  124. echo -en "\n"
  125. }
  126. # [ .... ]
  127. fn_print_dots() {
  128. fn_print_message "...." "${default}" "$*"
  129. fn_sleep_time_05
  130. }
  131. fn_print_dots_nl() {
  132. fn_print_message_nl "...." "${default}" "$*"
  133. fn_sleep_time_05
  134. }
  135. # [ OK ]
  136. fn_print_ok() {
  137. fn_print_message " OK " "${green}" "$*"
  138. }
  139. fn_print_ok_nl() {
  140. fn_print_message_nl " OK " "${green}" "$*"
  141. }
  142. # [ FAIL ]
  143. fn_print_fail() {
  144. fn_print_message "FAIL" "${red}" "$*"
  145. }
  146. fn_print_fail_nl() {
  147. fn_print_message_nl "FAIL" "${red}" "$*"
  148. }
  149. # [ ERROR ]
  150. fn_print_error() {
  151. fn_print_message "ERROR" "${red}" "$*"
  152. }
  153. fn_print_error_nl() {
  154. fn_print_message_nl "ERROR" "${red}" "$*"
  155. }
  156. # [ WARN ]
  157. fn_print_warn() {
  158. fn_print_message "WARN" "${lightyellow}" "$*"
  159. }
  160. fn_print_warn_nl() {
  161. fn_print_message_nl "WARN" "${lightyellow}" "$*"
  162. }
  163. # [ INFO ]
  164. fn_print_info() {
  165. fn_print_message "INFO" "${cyan}" "$*"
  166. }
  167. fn_print_info_nl() {
  168. fn_print_message_nl "INFO" "${cyan}" "$*"
  169. }
  170. # [ START ]
  171. fn_print_start() {
  172. fn_print_message "START" "${lightgreen}" "$*"
  173. }
  174. fn_print_start_nl() {
  175. fn_print_message_nl "START" "${lightgreen}" "$*"
  176. }
  177. # On-Screen - Interactive messages
  178. ##################################
  179. # Separator is different for details.
  180. fn_messages_separator() {
  181. if [ "${commandname}" == "DETAILS" ]; then
  182. printf '%*s\n' "${COLUMNS:-$(tput cols)}" '' | tr ' ' =
  183. else
  184. echo -e "${bold}=================================${default}"
  185. fi
  186. fn_sleep_time
  187. }
  188. # No More Room in Hell Debug
  189. # =================================
  190. fn_print_header() {
  191. echo -e ""
  192. echo -e "${bold}${lightyellow}${gamename} ${commandaction}${default}"
  193. fn_messages_separator
  194. }
  195. # Complete!
  196. fn_print_complete() {
  197. fn_print_message "Complete!" "${green}" "$*"
  198. }
  199. fn_print_complete_nl() {
  200. fn_print_message_nl "Complete!" "${green}" "$*"
  201. }
  202. # Failure!
  203. fn_print_failure() {
  204. fn_print_message "Failure!" "${red}" "$*"
  205. }
  206. fn_print_failure_nl() {
  207. fn_print_message_nl "Failure!" "${red}" "$*"
  208. }
  209. # Error!
  210. fn_print_error2() {
  211. fn_print_message "Error!" "${red}" "$*"
  212. }
  213. fn_print_error2_nl() {
  214. fn_print_message_nl "Error!" "${red}" "$*"
  215. }
  216. # Warning!
  217. fn_print_warning() {
  218. fn_print_message "Warning!" "${lightyellow}" "$*"
  219. }
  220. fn_print_warning_nl() {
  221. fn_print_message_nl "Warning!" "${lightyellow}" "$*"
  222. }
  223. # Information!
  224. fn_print_information() {
  225. fn_print_message "Information!" "${cyan}" "$*"
  226. }
  227. fn_print_information_nl() {
  228. fn_print_message_nl "Information!" "${cyan}" "$*"
  229. }
  230. # Y/N Prompt
  231. fn_prompt_yn() {
  232. echo -e ""
  233. local prompt="$1"
  234. local initial="$2"
  235. if [ "${initial}" == "Y" ]; then
  236. prompt+=" [Y/n] "
  237. elif [ "${initial}" == "N" ]; then
  238. prompt+=" [y/N] "
  239. else
  240. prompt+=" [y/n] "
  241. fi
  242. while true; do
  243. read -e -i "${initial}" -p "${prompt}" -r yn
  244. case "${yn}" in
  245. [Yy] | [Yy][Ee][Ss]) return 0 ;;
  246. [Nn] | [Nn][Oo]) return 1 ;;
  247. *) echo -e "Please answer yes or no." ;;
  248. esac
  249. done
  250. }
  251. # Prompt for message
  252. fn_prompt_message() {
  253. while true; do
  254. unset prompt
  255. local prompt="$1"
  256. read -e -p "${prompt}" -r answer
  257. if fn_prompt_yn "Continue" Y; then
  258. break
  259. fi
  260. done
  261. echo "${answer}"
  262. }
  263. # On-Screen End of Line
  264. ##################################
  265. # YES
  266. fn_print_yes_eol() {
  267. echo -en " ... ${cyan}YES${default}"
  268. fn_sleep_time
  269. }
  270. fn_print_yes_eol_nl() {
  271. echo -e " ... ${cyan}YES${default}"
  272. fn_sleep_time
  273. }
  274. # NO
  275. fn_print_no_eol() {
  276. echo -en " ... ${red}NO${default}"
  277. fn_sleep_time
  278. }
  279. fn_print_no_eol_nl() {
  280. echo -e " ... ${red}NO${default}"
  281. fn_sleep_time
  282. }
  283. # OK
  284. fn_print_ok_eol() {
  285. echo -en " ... ${green}OK${default}"
  286. fn_sleep_time
  287. }
  288. fn_print_ok_eol_nl() {
  289. echo -e " ... ${green}OK${default}"
  290. fn_sleep_time
  291. }
  292. # FAIL
  293. fn_print_fail_eol() {
  294. echo -en " ... ${red}FAIL${default}"
  295. fn_sleep_time
  296. }
  297. fn_print_fail_eol_nl() {
  298. echo -e " ... ${red}FAIL${default}"
  299. fn_sleep_time
  300. }
  301. # ERROR
  302. fn_print_error_eol() {
  303. echo -en " ... ${red}ERROR${default}"
  304. fn_sleep_time
  305. }
  306. fn_print_error_eol_nl() {
  307. echo -e " ... ${red}ERROR${default}"
  308. fn_sleep_time
  309. }
  310. # WAIT
  311. fn_print_wait_eol() {
  312. echo -en " ... ${cyan}WAIT${default}"
  313. fn_sleep_time
  314. }
  315. fn_print_wait_eol_nl() {
  316. echo -e " ... ${cyan}WAIT${default}"
  317. fn_sleep_time
  318. }
  319. # WARN
  320. fn_print_warn_eol() {
  321. echo -en " ... ${lightyellow}WARN${default}"
  322. fn_sleep_time
  323. }
  324. fn_print_warn_eol_nl() {
  325. echo -e " ... ${lightyellow}WARN${default}"
  326. fn_sleep_time
  327. }
  328. # INFO
  329. fn_print_info_eol() {
  330. echo -en " ... ${cyan}INFO${default}"
  331. fn_sleep_time
  332. }
  333. fn_print_info_eol_nl() {
  334. echo -e " ... ${cyan}INFO${default}"
  335. fn_sleep_time
  336. }
  337. # QUERYING
  338. fn_print_querying_eol() {
  339. echo -en " ... ${cyan}QUERYING${default}"
  340. fn_sleep_time_1
  341. }
  342. fn_print_querying_eol_nl() {
  343. echo -e " ... ${cyan}QUERYING${default}"
  344. fn_sleep_time_1
  345. }
  346. # CHECKING
  347. fn_print_checking_eol() {
  348. echo -en " ... ${cyan}CHECKING${default}"
  349. fn_sleep_time_1
  350. }
  351. fn_print_checking_eol_nl() {
  352. echo -e " ... ${cyan}CHECKING${default}"
  353. fn_sleep_time_1
  354. }
  355. # DELAY
  356. fn_print_delay_eol() {
  357. echo -en " ... ${green}DELAY${default}"
  358. fn_sleep_time_1
  359. }
  360. fn_print_delay_eol_nl() {
  361. echo -e " ... ${green}DELAY${default}"
  362. fn_sleep_time_1
  363. }
  364. # CANCELED
  365. fn_print_canceled_eol() {
  366. echo -en " ... ${lightyellow}CANCELED${default}"
  367. fn_sleep_time_1
  368. }
  369. fn_print_canceled_eol_nl() {
  370. echo -e " ... ${lightyellow}CANCELED${default}"
  371. fn_sleep_time_1
  372. }
  373. # REMOVED
  374. fn_print_removed_eol() {
  375. echo -en " ... ${red}REMOVED${default}"
  376. fn_sleep_time_1
  377. }
  378. fn_print_removed_eol_nl() {
  379. echo -e " ... ${red}REMOVED${default}"
  380. fn_sleep_time_1
  381. }
  382. # UPDATE
  383. fn_print_update_eol() {
  384. echo -en " ... ${lightblue}UPDATE${default}"
  385. fn_sleep_time
  386. }
  387. fn_print_update_eol_nl() {
  388. echo -e " ... ${lightblue}UPDATE${default}"
  389. fn_sleep_time
  390. }
  391. # SKIP
  392. fn_print_skip_eol() {
  393. echo -en " ... ${cyan}SKIP${default}"
  394. fn_sleep_time
  395. }
  396. fn_print_skip_eol_nl() {
  397. echo -e " ... ${cyan}SKIP${default}"
  398. fn_sleep_time
  399. }
  400. fn_print_ascii_logo() {
  401. echo -e ""
  402. echo -e " mdMMMMbm"
  403. echo -e " mMMMMMMMMMMm"
  404. echo -e " mMMMMMMMMMMMMm"
  405. echo -e " mMMMMMMMMMMMMMMm"
  406. echo -e " hMMMV^VMMV^VMMMh"
  407. echo -e " MMMMM MM MMMMM"
  408. echo -e " hMMs vv sMMh"
  409. echo -e " hMMM: :MMMh"
  410. echo -e " .hMMMh hMMMh."
  411. echo -e " -dMMMh ${lightgrey}__${default} hMMMd-"
  412. echo -e " :mMMMs ${lightgrey}||${default} sMMMm:"
  413. echo -e " :MMMM+ ${lightgrey}||${default} ${red}_${default} +NMMN:"
  414. echo -e " .mMMM+ ${lightgrey}========${default} +MMMm."
  415. echo -e " yMMMy ${darkgrey}##############${default} yMMMy"
  416. echo -e " mMMM: ${darkgrey}##############${default} :MMMm"
  417. echo -e " mMM ${lightyellow}nn${default} ${lightyellow}nn${default} ${lightyellow}nn${default} ${lightyellow}nn${default} MMm"
  418. echo -e " o ${lightyellow}nNNNNNNNn${default} ${lightyellow}nNNNNNNNn${default} o"
  419. echo -e " ${lightyellow}nNNNNNNNNNn${default} ${lightyellow}nNNNNNNNNNn${default}"
  420. echo -e " ${lightyellow}nNNNNNNNNNNN${default} ${lightyellow}NNNNNNNNNNNn${default}"
  421. echo -e " ${lightyellow}+NNNNNNNNN:${default} ${lightyellow}:NNNNNNNNN+${default}"
  422. echo -e " ${lightyellow}nNNNNNNN${default} /\ ${lightyellow}NNNNNNNn${default}"
  423. echo -e " ${lightyellow}nnnnn${default} db ${lightyellow}nnnnn${default}"
  424. echo -e ""
  425. echo -e "${lightyellow}888${default} ${lightyellow}d8b${default} ${default}.d8888b. .d8888b. 888b d888"
  426. echo -e "${lightyellow}888 Y8P ${default}d88P Y88b d88P Y88b 8888b d8888"
  427. echo -e "${lightyellow}888${default} ${default}888${default} 888 Y88b. 88888b.d88888"
  428. echo -e "${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}88888b.${default} ${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}888${default} 888 Y888b. 888Y88888P888"
  429. echo -e "${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}88b${default} ${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}Y8bd8P${default} 888 88888 Y88b. 888 Y888P 888"
  430. echo -e "${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}X88K${default} 888 888 888 888 Y8P 888"
  431. echo -e "${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}Y88b${default} ${lightyellow}88Y${default} ${lightyellow}.d8pq8b.${default} Y88b d88P Y88b d88P 888 * 888"
  432. echo -e "${lightyellow}LinuxGSM${default} ${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}Y8888Y${default} ${lightyellow}888${default} ${lightyellow}888${default} Y2012P88 Y8888P 888 888"
  433. echo -e ""
  434. }
  435. fn_print_restart#!/bin/bash
  436. # LinuxGSM core_messages.sh module
  437. # Author: Daniel Gibbs
  438. # Contributors: https://linuxgsm.com/contrib
  439. # Website: https://linuxgsm.com
  440. # Description: Defines on-screen messages such as [ OK ] and how script logs look.
  441. moduleselfname="$(basename "$(readlink -f "${BASH_SOURCE[0]}")")"
  442. # nl: new line: message is following by a new line.
  443. # eol: end of line: message is placed at the end of the current line.
  444. fn_ansi_loader() {
  445. # carriage return.
  446. creeol="\r"
  447. if [ "${ansi}" != "off" ]; then
  448. # echo colors
  449. default="\e[0m"
  450. black="\e[30m"
  451. red="\e[31m"
  452. lightred="\e[91m"
  453. green="\e[32m"
  454. lightgreen="\e[92m"
  455. yellow="\e[33m"
  456. lightyellow="\e[93m"
  457. blue="\e[34m"
  458. lightblue="\e[94m"
  459. magenta="\e[35m"
  460. lightmagenta="\e[95m"
  461. cyan="\e[36m"
  462. lightcyan="\e[96m"
  463. darkgrey="\e[90m"
  464. lightgrey="\e[37m"
  465. white="\e[97m"
  466. # erase to end of line.
  467. creeol+="\033[K"
  468. fi
  469. # carriage return & erase to end of line.
  470. creeol="\r\033[K"
  471. bold="\e[1m"
  472. dim="\e[2m"
  473. italic="\e[3m"
  474. underline="\e[4m"
  475. reverse="\e[7m"
  476. }
  477. fn_sleep_time() {
  478. sleep "0.1"
  479. }
  480. fn_sleep_time_05() {
  481. sleep "0.5"
  482. }
  483. fn_sleep_time_1() {
  484. sleep "1"
  485. }
  486. fn_sleep_time_5() {
  487. sleep "5"
  488. }
  489. fn_sleep_time_10() {
  490. sleep "10"
  491. }
  492. # Log display
  493. ########################
  494. ## Feb 28 14:56:58 ut99-server: Monitor:
  495. fn_script_log() {
  496. if [ -d "${lgsmlogdir}" ]; then
  497. if [ -n "${commandname}" ]; then
  498. echo -e "$(date '+%b %d %H:%M:%S.%3N') ${selfname}: ${commandname}: ${1}" >> "${lgsmlog}"
  499. else
  500. echo -e "$(date '+%b %d %H:%M:%S.%3N') ${selfname}: ${1}" >> "${lgsmlog}"
  501. fi
  502. fi
  503. }
  504. ## Feb 28 14:56:58 ut99-server: Monitor: PASS:
  505. fn_script_log_pass() {
  506. fn_script_log "PASS: ${1}"
  507. exitcode=0
  508. }
  509. ## Feb 28 14:56:58 ut99-server: Monitor: FATAL:
  510. fn_script_log_fail() {
  511. fn_script_log "FAIL: ${1}"
  512. exitcode=1
  513. }
  514. ## Feb 28 14:56:58 ut99-server: Monitor: ERROR:
  515. fn_script_log_error() {
  516. fn_script_log "ERROR: ${1}"
  517. exitcode=2
  518. }
  519. ## Feb 28 14:56:58 ut99-server: Monitor: WARN:
  520. fn_script_log_warn() {
  521. fn_script_log "WARN: ${1}"
  522. exitcode=3
  523. }
  524. ## Feb 28 14:56:58 ut99-server: Monitor: INFO:
  525. fn_script_log_info() {
  526. fn_script_log "INFO: ${1}"
  527. }
  528. # On-Screen - Automated functions
  529. ##################################
  530. fn_print() {
  531. echo -en "$*${default}"
  532. }
  533. fn_print_nl() {
  534. echo -e "$*${default}"
  535. }
  536. # Helper function to print messages with a specific format and color
  537. fn_print_message() {
  538. local type="$1"
  539. local color="$2"
  540. local message="$3"
  541. if [ "${commandaction}" ]; then
  542. echo -en "${bold}${creeol}[${color} ${type} ${default}]${default} ${commandaction} ${selfname}: ${message}${default}"
  543. else
  544. echo -en "${bold}${cree}[${color} ${type} ${default}]${default} ${message}${default}"
  545. fi
  546. fn_sleep_time
  547. }
  548. fn_print_message_nl() {
  549. local type="$1"
  550. local color="$2"
  551. local message="$3"
  552. if [ "${commandaction}" ]; then
  553. echo -e "${bold}${creeol}[${color} ${type} ${default}]${default} ${commandaction} ${selfname}: ${message}${default}"
  554. else
  555. echo -e "${bold}${creeol}[${color} ${type} ${default}]${default} ${message}${default}"
  556. fi
  557. fn_sleep_time
  558. echo -en "\n"
  559. }
  560. # [ .... ]
  561. fn_print_dots() {
  562. fn_print_message "...." "${default}" "$*"
  563. fn_sleep_time_05
  564. }
  565. fn_print_dots_nl() {
  566. fn_print_message_nl "...." "${default}" "$*"
  567. fn_sleep_time_05
  568. }
  569. # [ OK ]
  570. fn_print_ok() {
  571. fn_print_message " OK " "${green}" "$*"
  572. }
  573. fn_print_ok_nl() {
  574. fn_print_message_nl " OK " "${green}" "$*"
  575. }
  576. # [ FAIL ]
  577. fn_print_fail() {
  578. fn_print_message "FAIL" "${red}" "$*"
  579. }
  580. fn_print_fail_nl() {
  581. fn_print_message_nl "FAIL" "${red}" "$*"
  582. }
  583. # [ ERROR ]
  584. fn_print_error() {
  585. fn_print_message "ERROR" "${red}" "$*"
  586. }
  587. fn_print_error_nl() {
  588. fn_print_message_nl "ERROR" "${red}" "$*"
  589. }
  590. # [ WARN ]
  591. fn_print_warn() {
  592. fn_print_message "WARN" "${lightyellow}" "$*"
  593. }
  594. fn_print_warn_nl() {
  595. fn_print_message_nl "WARN" "${lightyellow}" "$*"
  596. }
  597. # [ INFO ]
  598. fn_print_info() {
  599. fn_print_message "INFO" "${cyan}" "$*"
  600. }
  601. fn_print_info_nl() {
  602. fn_print_message_nl "INFO" "${cyan}" "$*"
  603. }
  604. # [ START ]
  605. fn_print_start() {
  606. fn_print_message "START" "${lightgreen}" "$*"
  607. }
  608. fn_print_start_nl() {
  609. fn_print_message_nl "START" "${lightgreen}" "$*"
  610. }
  611. # On-Screen - Interactive messages
  612. ##################################
  613. # Separator is different for details.
  614. fn_messages_separator() {
  615. if [ "${commandname}" == "DETAILS" ]; then
  616. printf '%*s\n' "${COLUMNS:-$(tput cols)}" '' | tr ' ' =
  617. else
  618. echo -e "${bold}=================================${default}"
  619. fn_sleep_time
  620. fi
  621. }
  622. # No More Room in Hell Debug
  623. # =================================
  624. fn_print_header() {
  625. echo -e ""
  626. echo -e "${bold}${lightyellow}${gamename} ${commandaction}${default}"
  627. fn_messages_separator
  628. }
  629. # Complete!
  630. fn_print_complete() {
  631. fn_print_message "Complete!" "${green}" "$*"
  632. }
  633. fn_print_complete_nl() {
  634. fn_print_message_nl "Complete!" "${green}" "$*"
  635. }
  636. # Failure!
  637. fn_print_failure() {
  638. fn_print_message "Failure!" "${red}" "$*"
  639. }
  640. fn_print_failure_nl() {
  641. fn_print_message_nl "Failure!" "${red}" "$*"
  642. }
  643. # Error!
  644. fn_print_error2() {
  645. fn_print_message "Error!" "${red}" "$*"
  646. }
  647. fn_print_error2_nl() {
  648. fn_print_message_nl "Error!" "${red}" "$*"
  649. }
  650. # Warning!
  651. fn_print_warning() {
  652. fn_print_message "Warning!" "${lightyellow}" "$*"
  653. }
  654. fn_print_warning_nl() {
  655. fn_print_message_nl "Warning!" "${lightyellow}" "$*"
  656. }
  657. # Information!
  658. fn_print_information() {
  659. fn_print_message "Information!" "${cyan}" "$*"
  660. }
  661. fn_print_information_nl() {
  662. fn_print_message_nl "Information!" "${cyan}" "$*"
  663. }
  664. # Y/N Prompt
  665. fn_prompt_yn() {
  666. echo -e ""
  667. local prompt="$1"
  668. local initial="$2"
  669. if [ "${initial}" == "Y" ]; then
  670. prompt+=" [Y/n] "
  671. elif [ "${initial}" == "N" ]; then
  672. prompt+=" [y/N] "
  673. else
  674. prompt+=" [y/n] "
  675. fi
  676. while true; do
  677. read -e -i "${initial}" -p "${prompt}" -r yn
  678. case "${yn}" in
  679. [Yy] | [Yy][Ee][Ss]) return 0 ;;
  680. [Nn] | [Nn][Oo]) return 1 ;;
  681. *) echo -e "Please answer yes or no." ;;
  682. esac
  683. done
  684. }
  685. # Prompt for message
  686. fn_prompt_message() {
  687. while true; do
  688. unset prompt
  689. local prompt="$1"
  690. read -e -p "${prompt}" -r answer
  691. if fn_prompt_yn "Continue" Y; then
  692. break
  693. fi
  694. done
  695. echo "${answer}"
  696. }
  697. # On-Screen End of Line
  698. ##################################
  699. # YES
  700. fn_print_yes_eol() {
  701. echo -en " ... ${cyan}YES${default}"
  702. fn_sleep_time
  703. }
  704. fn_print_yes_eol_nl() {
  705. echo -e " ... ${cyan}YES${default}"
  706. fn_sleep_time
  707. }
  708. # NO
  709. fn_print_no_eol() {
  710. echo -en " ... ${red}NO${default}"
  711. fn_sleep_time
  712. }
  713. fn_print_no_eol_nl() {
  714. echo -e " ... ${red}NO${default}"
  715. fn_sleep_time
  716. }
  717. # OK
  718. fn_print_ok_eol() {
  719. echo -en " ... ${green}OK${default}"
  720. fn_sleep_time
  721. }
  722. fn_print_ok_eol_nl() {
  723. echo -e " ... ${green}OK${default}"
  724. fn_sleep_time
  725. }
  726. # FAIL
  727. fn_print_fail_eol() {
  728. echo -en " ... ${red}FAIL${default}"
  729. fn_sleep_time
  730. }
  731. fn_print_fail_eol_nl() {
  732. echo -e " ... ${red}FAIL${default}"
  733. fn_sleep_time
  734. }
  735. # ERROR
  736. fn_print_error_eol() {
  737. echo -en " ... ${red}ERROR${default}"
  738. fn_sleep_time
  739. }
  740. fn_print_error_eol_nl() {
  741. echo -e " ... ${red}ERROR${default}"
  742. fn_sleep_time
  743. }
  744. # WAIT
  745. fn_print_wait_eol() {
  746. echo -en " ... ${cyan}WAIT${default}"
  747. fn_sleep_time
  748. }
  749. fn_print_wait_eol_nl() {
  750. echo -e " ... ${cyan}WAIT${default}"
  751. fn_sleep_time
  752. }
  753. # WARN
  754. fn_print_warn_eol() {
  755. echo -en " ... ${lightyellow}WARN${default}"
  756. fn_sleep_time
  757. }
  758. fn_print_warn_eol_nl() {
  759. echo -e " ... ${lightyellow}WARN${default}"
  760. fn_sleep_time
  761. }
  762. # INFO
  763. fn_print_info_eol() {
  764. echo -en " ... ${cyan}INFO${default}"
  765. fn_sleep_time
  766. }
  767. fn_print_info_eol_nl() {
  768. echo -e " ... ${cyan}INFO${default}"
  769. fn_sleep_time
  770. }
  771. # QUERYING
  772. fn_print_querying_eol() {
  773. echo -en " ... ${cyan}QUERYING${default}"
  774. fn_sleep_time_1
  775. }
  776. fn_print_querying_eol_nl() {
  777. echo -e " ... ${cyan}QUERYING${default}"
  778. fn_sleep_time_1
  779. }
  780. # CHECKING
  781. fn_print_checking_eol() {
  782. echo -en " ... ${cyan}CHECKING${default}"
  783. fn_sleep_time_1
  784. }
  785. fn_print_checking_eol_nl() {
  786. echo -e " ... ${cyan}CHECKING${default}"
  787. fn_sleep_time_1
  788. }
  789. # DELAY
  790. fn_print_delay_eol() {
  791. echo -en " ... ${green}DELAY${default}"
  792. fn_sleep_time_1
  793. }
  794. fn_print_delay_eol_nl() {
  795. echo -e " ... ${green}DELAY${default}"
  796. fn_sleep_time_1
  797. }
  798. # CANCELED
  799. fn_print_canceled_eol() {
  800. echo -en " ... ${lightyellow}CANCELED${default}"
  801. fn_sleep_time_1
  802. }
  803. fn_print_canceled_eol_nl() {
  804. echo -e " ... ${lightyellow}CANCELED${default}"
  805. fn_sleep_time_1
  806. }
  807. # REMOVED
  808. fn_print_removed_eol() {
  809. echo -en " ... ${red}REMOVED${default}"
  810. fn_sleep_time_1
  811. }
  812. fn_print_removed_eol_nl() {
  813. echo -e " ... ${red}REMOVED${default}"
  814. fn_sleep_time_1
  815. }
  816. # UPDATE
  817. fn_print_update_eol() {
  818. echo -en " ... ${lightblue}UPDATE${default}"
  819. fn_sleep_time
  820. }
  821. fn_print_update_eol_nl() {
  822. echo -e " ... ${lightblue}UPDATE${default}"
  823. fn_sleep_time
  824. }
  825. # SKIP
  826. fn_print_skip_eol() {
  827. echo -en " ... ${cyan}SKIP${default}"
  828. fn_sleep_time
  829. }
  830. fn_print_skip_eol_nl() {
  831. echo -e " ... ${cyan}SKIP${default}"
  832. fn_sleep_time
  833. }
  834. fn_print_ascii_logo() {
  835. echo -e ""
  836. echo -e " mdMMMMbm"
  837. echo -e " mMMMMMMMMMMm"
  838. echo -e " mMMMMMMMMMMMMm"
  839. echo -e " mMMMMMMMMMMMMMMm"
  840. echo -e " hMMMV^VMMV^VMMMh"
  841. echo -e " MMMMM MM MMMMM"
  842. echo -e " hMMs vv sMMh"
  843. echo -e " hMMM: :MMMh"
  844. echo -e " .hMMMh hMMMh."
  845. echo -e " -dMMMh ${lightgrey}__${default} hMMMd-"
  846. echo -e " :mMMMs ${lightgrey}||${default} sMMMm:"
  847. echo -e " :MMMM+ ${lightgrey}||${default} ${red}_${default} +NMMN:"
  848. echo -e " .mMMM+ ${lightgrey}========${default} +MMMm."
  849. echo -e " yMMMy ${darkgrey}##############${default} yMMMy"
  850. echo -e " mMMM: ${darkgrey}##############${default} :MMMm"
  851. echo -e " mMM ${lightyellow}nn${default} ${lightyellow}nn${default} ${lightyellow}nn${default} ${lightyellow}nn${default} MMm"
  852. echo -e " o ${lightyellow}nNNNNNNNn${default} ${lightyellow}nNNNNNNNn${default} o"
  853. echo -e " ${lightyellow}nNNNNNNNNNn${default} ${lightyellow}nNNNNNNNNNn${default}"
  854. echo -e " ${lightyellow}nNNNNNNNNNNN${default} ${lightyellow}NNNNNNNNNNNn${default}"
  855. echo -e " ${lightyellow}+NNNNNNNNN:${default} ${lightyellow}:NNNNNNNNN+${default}"
  856. echo -e " ${lightyellow}nNNNNNNN${default} /\ ${lightyellow}NNNNNNNn${default}"
  857. echo -e " ${lightyellow}nnnnn${default} db ${lightyellow}nnnnn${default}"
  858. echo -e ""
  859. echo -e "${lightyellow}888${default} ${lightyellow}d8b${default} ${default}.d8888b. .d8888b. 888b d888"
  860. echo -e "${lightyellow}888 Y8P ${default}d88P Y88b d88P Y88b 8888b d8888"
  861. echo -e "${lightyellow}888${default} ${default}888${default} 888 Y88b. 88888b.d88888"
  862. echo -e "${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}88888b.${default} ${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}888${default} 888 Y888b. 888Y88888P888"
  863. echo -e "${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}88b${default} ${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}Y8bd8P${default} 888 88888 Y88b. 888 Y888P 888"
  864. echo -e "${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}X88K${default} 888 888 888 888 Y8P 888"
  865. echo -e "${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}Y88b${default} ${lightyellow}88Y${default} ${lightyellow}.d8pq8b.${default} Y88b d88P Y88b d88P 888 * 888"
  866. echo -e "${lightyellow}LinuxGSM${default} ${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}888${default} ${lightyellow}Y8888Y${default} ${lightyellow}888${default} ${lightyellow}888${default} Y2012P88 Y8888P 888 888"
  867. echo -e ""
  868. }
  869. fn_print_restart_warning() {
  870. fn_print_warn "${selfname} will be restarted"
  871. fn_script_log_warn "${selfname} will be restarted"
  872. for seconds in {3..1}; do
  873. fn_print_warn "${selfname} will be restarted: ${seconds}"
  874. fn_sleep_time_1
  875. done
  876. fn_print_warn_nl "${selfname} will be restarted"
  877. }
  878. # Functions below are used to ensure that logs and UI correctly reflect the command it is actually running.
  879. # Useful when a command has to call upon another command causing the other command to overrite commandname variables
  880. # Used to remember the command that ran first.
  881. fn_firstcommand_set() {
  882. if [ -z "${firstcommandname}" ]; then
  883. firstcommandname="${commandname}"
  884. firstcommandaction="${commandaction}"
  885. fi
  886. }
  887. # Used to reset commandname variables to the command the script ran first.
  888. fn_firstcommand_reset() {
  889. commandname="${firstcommandname}"
  890. commandaction="${firstcommandaction}"
  891. }