-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathinstsrv_functions.sh
executable file
·6270 lines (5152 loc) · 193 KB
/
instsrv_functions.sh
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/bin/bash
######################################################################################################
# Bash include script for generically installing services on upstart, systemd & sysv systems
# 20240120 -- Gordon Harris
#
# Last mod: systemd_unit_file_create -- added Wants=network-online.target to make sure network
# dependent services properly wait until network is up before starting.
# Depends on systemd-networkd-wait-online.service or NetworkManager-wait-online.service being enabled too.
######################################################################################################
INCSCRIPT_VERSION=20240206.101827
SCRIPT_NAME=$(basename -- "$0")
# Get the underlying user...i.e. who called sudo...modified for WSL2
UUSER="$(whoami 2>/dev/null)"
if [ "$UUSER" = 'root' ]; then
UUSER="$SUDO_USER"
[ -z "$UUSER" ] && UUSER="$(logname 2>/dev/null)"
[ -z "$UUSER" ] && UUSER="$(who am i | awk '{print $1}')"
[ -z "$UUSER" ] && [ "$(tty)" != 'not a tty' ] && UUSER="$(ls -l $(tty) | awk '{print $3}')"
[ -z "$UUSER" ] && UUSER="$(awk -F':' '{ if($7 ~ /\/bin\/bash/ && $1 !~ /root/) {print $1; exit} };0' /etc/passwd)"
[ -z "$UUSER" ] && UUSER="$(grep '/bin/bash' /etc/passwd | grep -m1 -v 'root' | awk -F ':' '{print $1}')"
fi
UGROUP="$(id -g -n "$UUSER")"
: "${DEBUG:=0}"
: "${QUIET:=0}"
: "${VERBOSE:=0}"
: "${TEST:=0}"
: "${FORCE:=0}"
: "${LOG:=0}"
: "${LOGFILE:=}"
if [ "$(basename -- "$0")" = "instsrv_functions.sh" ]; then
DEBUG=1
fi
NOPROMPT=0
#DEBUG=0
#QUIET=0
#VERBOSE=0
#TEST=0
#FORCE=0
UPDATE=0
UNINSTALL=0
REMOVEALL=0
DISABLE=0
ENABLE=0
UPDATE=0
UNINSTALL=0
# Defaults..should be overridden in calling script
NEEDSPID=0
NEEDSUSER=0
NEEDSDATA=0
NEEDSLOG=0
NEEDSCONF=0
NEEDSPRIORITY=0
############################################################################################################################################################################
######################################################################################################
# Variables identifying system properties. 1 == true, 0 == false
######################################################################################################
# system architecture
M_ARCH="$(uname -m)"
OS_BIT="$(getconf LONG_BIT)"
# Distros
IS_DEBIAN=0
DEBIAN_VER=0
DEBIAN_NAME=
IS_UBUNTU=0
UBUNTU_VER=0
UBUNTU_NAME=
IS_FOCAL=0 # if Ubuntu ver >= 20.04, IS_FOCAL=1
IS_RHINO=0
IS_RASPBIAN=0
RASPBIAN_VER=0
RASPBIAN_NAME=
IS_FEDORA=0
FEDORA_VER=0
FEDORA_NAME=
IS_WSL=0
IS_AWS=0
IS_GCE=0
IS_MAC=0
# Init system
IS_SYSV=0
IS_UPSTART=0
IS_SYSTEMD=0
USE_SYSV=0
USE_UPSTART=0
USE_SYSTEMD=0
SYSTEMD_VER=0
# Package manager
USE_APT=0
USE_NALA=0
USE_YUM=0
# Network config & renderer
IS_NETPLAN=0
IS_DHCPCD=0
IS_NETWORKD=0
IS_NETWORKMNGR=0
IS_NETINTERFACES=0
# Firewall
USE_UFW=0
USE_FIREWALLD=0
# GUI or text?
HAS_GUI=0
IS_GUI=0
IS_TEXT=0
test -t 0 && IS_TTY=1 || IS_TYY=0
######################################################################################################
# Identify init system
######################################################################################################
# Our distro type?
# The following works for debian, ubuntu, raspbian..
#IS_DEBIAN="$(grep -c -e '^ID.*=.*debian' /etc/os-release 2>/dev/null)"
grep -c -e '^ID.*=.*debian' /etc/os-release >/dev/null 2>&1 && IS_DEBIAN=1 || IS_DEBIAN=0
# The following ought to work for fedora, centos, etc..
#~ IS_FEDORA="$(grep -c -e '^ID.*=.*fedora' /etc/os-release 2>/dev/null)"
grep -c -e '^ID.*=.*fedora' /etc/os-release >/dev/null 2>&1 && IS_FEDORA=1 || IS_FEDORA=0
# The follwing works with MacOS Catalina & zsh..
IS_MAC=$( [[ $OSTYPE == 'darwin'* ]] && echo 1 || echo 0)
# The following works with WSL & WSL2
IS_WSL=$(uname -a | grep -ci 'microsoft')
# Are we running on a Google Compute Engine?
curl --silent metadata.google.internal -i >/dev/null 2>&1 && IS_GCE=1 || IS_GCE=0
# Are we running on an Amazon Elastic Compute Cloud Instance?
# See: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/identify_ec2_instances.html
IS_AWS="$(cat /sys/hypervisor/uuid 2>/dev/null | grep -ci -E '^EC2')"
# Is systemd our init system?
# (default for ubuntu from 15.04 - i.e. 14.10 is the last version to use upstart)
#~ IS_SYSTEMD=$(systemctl 2>&1 | grep -c '\-\.mount')
systemctl is-active --quiet -- '-.mount' 2>/dev/null && IS_SYSTEMD=1 || IS_SYSTEMD=0
if [ $IS_SYSTEMD -gt 0 ]; then
USE_SYSTEMD=1
SYSTEMD_VER=$(systemctl --version | grep 'systemd' | awk '{ print $2 }')
elif [ $(initctl version 2>/dev/null | grep -c 'upstart') -gt 0 ]; then
IS_UPSTART=1
USE_UPSTART=1
else
IS_SYSV=1
USE_SYSV=1
fi
#~ echo "Here at ${LINENO}"
######################################################################################################
# Network renderer service
######################################################################################################
IS_NETWORKD=$(( systemctl is-enabled --quiet 'systemd-networkd' 2>/dev/null ) && echo 1 || echo 0)
IS_NETWORKMNGR=$(( systemctl is-enabled --quiet 'NetworkManager' 2>/dev/null ) && echo 1 || echo 0)
IS_DHCPCD=$(( systemctl is-enabled --quiet 'dhcpcd' 2>/dev/null ) && echo 1 || echo 0)
if [[ $IS_DHCPCD -gt 0 ]] && [[ $IS_SYSTEMD -gt 0 ]]; then
systemctl is-active --quiet dhcpcd.service 2>/dev/null
[ $? -eq 0 ] && IS_DHCPCD=1 || IS_DHCPCD=0
fi
# If not systemd-networkd or NetworkManager or dhcpcd, the use old still ifupdown /etc/networking/interfaces
IS_NETINTERFACES=0
[ $IS_NETWORKD -lt 1 ] && [ $IS_NETWORKMNGR -lt 1 ] && [ $IS_DHCPCD -lt 1 ] && IS_NETINTERFACES=1
######################################################################################################
# Network configuration app
######################################################################################################
IS_NETPLAN="$(which netplan 2>/dev/null | wc -l | xargs)"
#~ [ $IS_NETPLAN -gt 0 ] && NETPLAN_VER="$(dpkg-query --showformat='${Version}\n' --show 'netplan.io' | sed -e 's/-.*$//')" || NETPLAN_VER=
#~ NETPLAN_USE_ROUTES="$(netplan info | grep -c default-routes)"
######################################################################################################
# Firewall font-end
######################################################################################################
USE_UFW=$(( systemctl is-enabled --quiet 'ufw' 2>/dev/null ) && echo 1 || echo 0)
USE_FIREWALLD=$(( systemctl is-enabled --quiet 'firewalld' 2>/dev/null ) && echo 1 || echo 0)
######################################################################################################
# Gui?
######################################################################################################
#~ HAS_GUI=$(ls -l /usr/bin/gnome* 2>/dev/null | wc -l)
HAS_GUI=$(find /usr/bin -name 'gnome*' | wc -l | xargs)
IS_GUI=$(systemctl get-default 2>/dev/null | grep -c 'graphical')
IS_TEXT=$(systemctl get-default 2>/dev/null | grep -c 'multi-user')
# Ubuntu server defaults to graphical.target even though there is no display manager
[ $IS_GUI -gt 0 ] && [ $HAS_GUI -lt 1 ] && IS_GUI=0 && IS_TEXT=1
######################################################################################################
# Fixups for various distros..
######################################################################################################
if [[ $IS_DEBIAN -gt 0 ]]; then
IS_DEB=1
USE_APT=1
IS_RPM=0
USE_YUM=0
IS_MAC=0
DEBIAN_NAME="$(cat /etc/debian_version | sed -n -e 's#^\(.*\)/.*$#\1#p')"
case "$DEBIAN_NAME" in
squeeze)
DEBIAN_VER='6'
;;
wheezy)
DEBIAN_VER='7'
;;
jessie)
DEBIAN_VER='8'
;;
stretch)
DEBIAN_VER='9'
;;
buster)
DEBIAN_VER='10'
;;
bullseye)
DEBIAN_VER='11'
;;
bookworm)
DEBIAN_VER='12'
;;
trixie)
DEBIAN_VER='13'
;;
forky)
DEBIAN_VER='14'
;;
*)
DEBIAN_VER='0'
;;
esac
IS_UBUNTU=$(grep -c -E '^NAME="Ubuntu"' /etc/os-release 2>/dev/null)
# Test to see if is Ubuntu 20.04 or later..
if [ $IS_UBUNTU -gt 0 ]; then
UBUNTU_VER="$(lsb_release -rs)"
UBUNTU_NAME="$(cat /etc/os-release | grep 'UBUNTU_CODENAME' | sed -n -e 's/^.*=\(.*\)$/\1/p')"
# Not less than 20.04 == Greater than or equal to 20.04
if [[ ! "$UBUNTU_VER" < '20.04' ]]; then
#~ if version_cmp "$UBUNTU_VER" -ge '20.04'; then
IS_FOCAL=1
else
IS_FOCAL=0
fi
fi
IS_RASPBIAN=$(grep -c -E '^NAME="Raspbian.*"' /etc/os-release 2>/dev/null)
if [ $IS_RASPBIAN -gt 0 ]; then
RASPBIAN_VER="$(cat /etc/os-release | grep 'VERSION_ID=' | sed -n -e 's/^.*=\(.*\)$/\1/p' | tr -d '"')"
RASPBIAN_NAME="$(cat /etc/os-release | grep 'PRETTY_NAME=' | sed -n -e 's/^.*=\(.*\)$/\1/p' | tr -d '"')"
fi
# Test to see if this is a Rolling Rhino Remix install
IS_RHINO="$(grep -c -E '^PRETTY_NAME=.*Rhino.*' /etc/os-release 2>/dev/null)"
USE_NALA="$(which nala | wc -l)"
[ $IS_SYSTEMD -lt 1 ] && IS_UPSTART=$(initctl version 2>/dev/null | grep -c 'upstart')
USE_UPSTART=$IS_UPSTART
elif [[ $IS_FEDORA -gt 0 ]]; then
FEDORA_VER="$(rpm -E %fedora)"
# Fedora no longer uses release names beginning with Fedora 21 in 2014
[ $FEDORA_VER -gt 20 ] && FEDORA_NAME='sinnombre'
USE_YUM=1
IS_DEB=0
USE_APT=0
IS_RPM=1
USE_YUM=1
IS_MAC=0
elif [ $IS_MAC -gt 0 ]; then
IS_MAC=1
IS_SYSV=0
USE_SYSV=0
IS_DEB=0
USE_APT=0
IS_RPM=0
USE_YUM=0
fi
if [ $IS_WSL -gt 0 ]; then
IS_SYSV=0
USE_SYSV=0
IS_NETPLAN=0
USE_UFW=0
IS_TEXT=1
fi
############################################################################################################################################################################
######################################################################################################
# Variables for fetching scripts to fetch/install from a mothership server to this machine.
######################################################################################################
MOTHERSHIP='gharris-mini'
MOTHERSHIP_IP='192.168.0.110'
PING_BIN="$(which ping)"
PING_OPTS='-c 1 -w 5'
######################################################################################################
# Vars: the calling script must define at least define INST_NAME & INST_BIN
######################################################################################################
INST_NAME=
INST_PROD=
INST_DESC=
INST_BIN=
INST_PID=
INST_PIDDIR=
INST_CONF=
INST_NICE=
INST_RTPRIO=
INST_MEMLOCK=
INST_USER=
INST_GROUP=
INST_ENVFILE=
INST_ENVFILE_LOCK=0
INST_DATADIR=
INST_DATAFILE=
INST_LOGDIR=
INST_LOGFILE=
INST_IFACE=
INST_SUBNET=
INST_FWZONE=
HOSTNAME=$(hostname | tr [a-z] [A-Z])
######################################################################################################
# is_root() -- make sure we're running with suficient credentials..
######################################################################################################
function is_root(){
if [ $(whoami) != 'root' ]; then
echo '################################################################################'
echo -e "\nError: ${SCRIPT_NAME} needs to be run with root cridentials, either via:\n\n# sudo ${0}\n\nor under su.\n"
echo '################################################################################'
exit 1
fi
}
######################################################################################################
# is_root() -- make sure we're running with suficient credentials..
######################################################################################################
function is_not_root(){
if [ $(whoami) = 'root' ]; then
echo '################################################################################'
echo "Error: ${SCRIPT_NAME} needs to be run with user, not root cridentials,"
echo '################################################################################'
exit 1
fi
}
######################################################################################################
# is_host( hostname, [ port_num ] ) -- See if hostname has port_num open
######################################################################################################
is_host(){
debug_echo "${FUNCNAME}( $@ )"
local LHOST="$1"
local LPORT="${2:-22}"
local LTIMEOUT="${3:-1}"
local NC_OPTS=
# -z' Specifies that nc should just scan for listening daemons, without sending any data to them. It is an error to use this option in conjunction with the -l option.
# -w timeout. If a connection and stdin are idle for more than timeout seconds, then the connection is silently closed.
[ $IS_FEDORA -gt 0 ] && NC_OPTS="-z" || NC_OPTS="-w ${LTIMEOUT} -z"
# Delete any user prefix of the host
if [ $(echo "$LHOST" | grep -c '@') -gt 0 ]; then
LHOST="$(echo "$LHOST" | sed -n -e 's/^.*@//p')"
fi
nc $NC_OPTS "$LHOST" $LPORT >/dev/null 2>&1
if [ $? -lt 1 ]; then
[ $VERBOSE -gt 0 ] && error_echo "Host ${LHOST} responds on port ${LPORT}"
return 0
else
[ $QUIET -lt 1 ] && error_echo "No response from host ${LHOST} on port ${LPORT} within ${LTIMEOUT} seconds."
return 1
fi
}
######################################################################################################
# psgrep() -- get info on a process grepping via a regular expression..
######################################################################################################
function psgrep(){
ps aux | grep -v grep | grep -E $*
}
######################################################################################################
# timezone_get() -- Use the api.ipgeolocation.io website to get the local timezone..
######################################################################################################
function timezone_get(){
debug_echo "${FUNCNAME}( $@ )"
#~ local LMY_APIKEY='60aca0cf9d45428e9ee1e27a63bbb329'
#~ local LMYTZ="$(curl --silent "https://api.ipgeolocation.io/timezone?apiKey=${LMY_APIKEY}" | sed -n -e 's/^.*"timezone":"\([^\s]\+\/[^\s]\+\)",.*$/\1/p')"
if [ -z "$(which curl)" ]; then
error_echo "${FUNCNAME} error: curl not installed."
return 1
fi
# 4 Different methods of getting a time zone..
local LMYTZ=
local LCMD=
local LCMD1="LMYTZ=\$(curl --silent \"https://ipapi.co/timezone\" 2>/dev/null)"
local LCMD3="LMYTZ=\$(curl --silent \"http://ip-api.com/line/?fields=256\" 2>/dev/null)"
local LCMD3="LMYTZ=\$(curl --silent \"https://freegeoip.app/json/\" 2>/dev/null | sed -n -e 's/^.*\"time_zone\":\"\([^\s]\+\/[^\s]\+\)\",.*$/\1/p')"
local LCMD4="LMYTZ=\$(curl --silent \"http://worldtimeapi.org/api/ip/\" 2>/dev/null | sed -n -e 's/^.*\"timezone\":\"\([^\s]\+\/[^\s]\+\)\",\"unixtime\".*$/\1/p')"
for LCMD in "$LCMD1" "$LCMD2" "$LCMD3" "$LCMD4"
do
debug_echo "${FUNCNAME} evaluating command: ${LCMD}"
eval "$LCMD"
# Does this look like a timezone?
if [ $(echo $LMYTZ | grep -c -E '^\S+/\S+$') -gt 0 ]; then
debug_echo "${FUNCNAME} detected timezone: ${LMYTZ}"
echo "$LMYTZ"
return 0
fi
done
return 1
}
######################################################################################################
# timestamp_get_iso8601() -- Get a second granularity local TZ timestamp in ISO-8601 format..
######################################################################################################
function timestamp_get_iso8601(){
echo "$(date --iso-8601=s)"
}
######################################################################################################
# timestamp_get_iso8601u() -- Get a second granularity UTC timestamp in ISO-8601 format..
######################################################################################################
timestamp_get_iso8601u(){
echo "$(date -u --iso-8601=s)"
}
######################################################################################################
# timestamp_get_epoch() -- Get a second granularity epoch timestamp..
######################################################################################################
timestamp_get_epoch(){
echo "$(date +%s)"
}
######################################################################################################
# date_iso8601_to_epoch() -- Convert a ISO-8601 timestamp to epoch time..
######################################################################################################
date_iso8601_to_epoch(){
local LISO="$1"
echo "$(date "-d${LISO}" +%s)"
}
######################################################################################################
# date_epoch_to_iso8601() -- Convert an epoch time to ISO-8601 format in local TZ..
######################################################################################################
date_epoch_to_iso8601(){
local LEPOCH="$1"
echo "$(date -d "@${LEPOCH}" --iso-8601=s)"
}
######################################################################################################
# date_epoch_to_iso8601u() -- Convert an epoch time to ISO-8601 format in UTC..
######################################################################################################
date_epoch_to_iso8601u(){
local LEPOCH="$1"
echo "$(date -u -d "@${LEPOCH}" --iso-8601=s)"
}
######################################################################################################
# error_echo() -- echo a message to stderr
######################################################################################################
error_echo(){
echo "$@" 1>&2;
}
error_log(){
[ -z "$SCRIPT_LOG" ] && [ ! -z "$INST_LOGFILE" ] && SCRIPT_LOG="$INST_LOGFILE"
[ $LOG -gt 0 ] && echo "${SCRIPT} $(timestamp_get_iso8601) " "$@" >>"$SCRIPT_LOG"
}
date_msg(){
DATE=$(timestamp_get_iso8601)
echo "[${DATE}] " "$@"
}
error_date_msg(){
DATE=$(timestamp_get_iso8601)
echo "[${DATE}] " "$@" 1>&2;
}
log_msg_dir_create(){
local LLOGFILE="$1"
local LLOGDIR=
[ $LOG -lt 1 ] && return 1
[ -z "$LLOGFILE" ] && [ ! -z "$SCRIPT_LOG" ] && LLOGFILE="$SCRIPT_LOG"
[ -z "$LLOGFILE" ] && return 1
local LLOGDIR="$(dirname "$LLOGFILE")"
[ ! -d "$LLOGDIR" ] && mkdir -p "$LLOGDIR"
}
log_msg(){
error_echo "$@"
error_log "$@"
}
log_msg_error(){
error_echo "$@"
error_log "$@"
}
log_exit(){
error_echo "Error: $@"
error_log "Error: $@"
exit 1
}
######################################################################################################
# debug_cat() -- cats a file to stderr
######################################################################################################
log_cat(){
local LFILE="$1"
if [ -f "$LFILE" ]; then
error_log ' '
error_log '================================================================================='
error_log "${LFILE} contents:"
error_log '================================================================================='
cat "$LFILE" 1>&2;
cat "$LFILE" >>"$SCRIPT_LOG"
error_log '================================================================================='
error_log ' '
fi
}
debug_stacktrace(){
[ $DEBUG -lt 1 ] && return
local i=0 line file func
while read line func file; do
error_echo -n "[$i] $file:$line $func(): "
test -f "$file" && sed -n ${line}p "$file" || error_echo "<unknown>"
((i++))
done < <(while caller $i; do ((i++)); done)
}
######################################################################################################
# debug_echo() -- echo a debugging message to stderr
######################################################################################################
debug_echo(){
[ $DEBUG -gt 0 ] && echo "$@" 1>&2;
}
######################################################################################################
# debug_log() -- echo a debugging message to stderr and to the log file
######################################################################################################
debug_log(){
[ $DEBUG -gt 0 ] && error_echo "$@"
[ $DEBUG -gt 0 ] && [ $LOG -gt 0 ] && error_log "$@"
}
######################################################################################################
# error_exit() -- echo a message to stderr and exit with an errorlevel
######################################################################################################
error_exit(){
error_echo "Error: $@"
exit 1
}
######################################################################################################
# pause() -- echo a prompt and then wait for keypress
######################################################################################################
pause(){
[ $IS_TTY -gt 0 ] && read -p "$*"
}
######################################################################################################
# pause_yn() -- echo a prompt and then waits for y/n response.
# 'Y|y' returns 0, any other character return 1
######################################################################################################
pause_yn(){
local LMSG="$@"
local LREPLY=
local LRET=1
error_echo "$@"
error_echo ' '
read -p "Continue? (Yes/No): " -n 1 -r LREPLY
error_echo ' '
[[ $LREPLY =~ ^[Yy]$ ]] && return 0 || return 1
}
######################################################################################################
# debug_pause() -- Pauses execution if DEBUG > 1 && NO_PAUSE < 1 debug_pause "${FUNCNAME}: ${LINENO}"
######################################################################################################
debug_pause(){
[ $DEBUG -gt 0 ] && echo "Debug check at line ${1}: " 1>&2;
[ $DEBUG -gt 1 ] && [ $NO_PAUSE -lt 1 ] && [ $IS_TTY -gt 0 ] && pause 'Press Enter to continue, or ctrl-c to abort..'
}
######################################################################################################
# debug_cat() -- cats a file to stderr
######################################################################################################
debug_cat(){
[ $DEBUG -lt 1 ] && return
local LFILE="$1"
local LRE="$2"
if [ -f "$LFILE" ]; then
error_echo ' '
error_echo '================================================================================='
error_echo "${LFILE} ${LRE} contents:"
error_echo '================================================================================='
[ ! -z "$LRE" ] && grep -E "$LRE" "$LFILE" 1>&2 || cat "$LFILE" 1>&2
error_echo '================================================================================='
error_echo ' '
fi
}
########################################################################
# disp_help() -- display the getopts allowable args
########################################################################
disp_help(){
local LSCRIPTNAME="$(basename "$0")"
local LDESCRIPTION="$1"
local LEXTRA_ARGS="${@:2}"
error_echo -e "\n${LSCRIPTNAME}: ${LDESCRIPTION}\n"
error_echo -e "\nSyntax: ${LSCRIPTNAME} [ options ] ${LEXTRA_ARGS}\n"
error_echo -e " Optional parameters:\n"
#~ cat "$(readlink -f "$0")" | grep -E '^\s+-' | grep -v -- '--)' | sed 's/)//' 1>&2
if [ ! -z "$SCRIPT" ] && [ -e "$SCRIPT" ]; then
cat "$SCRIPT" | grep -E '^\s+-.*)\s+#' | grep -v -- '--)' | grep -vi '# hide' | sed 's/)//' 1>&2
else
grep -E '^\s+-.*)\s+#' "$0" | grep -v -- '--)' | grep -vi '# hide' | sed 's/)//' 1>&2
fi
error_echo ' '
}
disp_help_old(){
local LSCRIPTNAME="$(basename "$0")"
local LDESCRIPTION="$1"
local LEXTRA_ARGS="${@:2}"
error_echo -e "\n${LSCRIPTNAME}: ${LDESCRIPTION}\n"
error_echo -e "Syntax: ${LSCRIPTNAME} ${LEXTRA_ARGS}\n"
error_echo -e " Optional parameters:\n"
# See: https://gist.github.com/sv99/6852cc2e2a09bd3a68ed for explaination of the sed newling replacement
#~ cat "$(readlink -f "$0")" | grep -E '^\s+-' | grep -v -- '--)' | grep -vi '# hide' | sed -e 's/)//' -e 's/#/\n\t\t\t\t#/' | fmt -t -s | sed ':a;N;$!ba;s/\n\s\+\(#\)/\t\1/g' 1>&2
if [ ! -z "$SCRIPT" ] && [ -e "$SCRIPT" ]; then
cat "$SCRIPT" | grep -E '^\s+-.*)\s+#' | grep -v -- '--)' | grep -vi '# hide' | sed 's/)//' 1>&2
else
grep -E '^\s+-.*)\s+#' "$0" | grep -v -- '--)' | grep -vi '# hide' | sed 's/)//' 1>&2
fi
error_echo ' '
}
######################################################################################################
# service_inst_prep() -- Set most of the INST_ variables based on $INST_NAME
######################################################################################################
service_inst_prep(){
debug_echo "${FUNCNAME}( $@ )"
if [ -z "$INST_NAME" ]; then
error_exit "INST_NAME undefined."
fi
[ -z "$INST_PROD" ] && INST_PROD=$(echo "$INST_NAME" | tr [a-z] [A-Z])
[ -z "$INST_DESC" ] && INST_DESC="${INST_PROD} service daemon"
if [ -z "$INST_BIN" ]; then
# Try tacking on a 'd'
INST_BIN=$(which "${INST_NAME}d")
if [ ! -x "$INST_BIN" ]; then
# Try just the name..
INST_BIN=$(which "${INST_NAME}")
if [ ! -x "$INST_BIN" ]; then
# Try removing the 'd'
INST_BIN=$(which "${INST_NAME%d}")
if [ ! -x "$INST_BIN" ]; then
# Punt!
INST_BIN="/usr/local/bin/${INST_NAME}"
fi
fi
fi
fi
[ -z "$INST_PIDDIR" ] && INST_PIDDIR="/var/run/${INST_NAME}"
[ -z "$INST_PID" ] && INST_PID="${INST_PIDDIR}/${INST_NAME}.pid"
[ -z "$INST_CONF" ] && INST_CONF="/etc/${INST_NAME}/${INST_NAME}.conf"
[ -z "$INST_USER" ] && inst_user_create
# [ -z "$INST_GROUP" ] &&
if [ -z "$INST_ENVFILE" ]; then
if [ $IS_DEBIAN -gt 0 ]; then
INST_ENVFILE="/etc/default/${INST_NAME}"
else
INST_ENVFILE="/etc/sysconfig/${INST_NAME}"
fi
fi
[ -z "$INST_DATADIR" ] && INST_DATADIR="/var/lib/${INST_NAME}"
[ -z "$INST_LOGDIR" ] && INST_LOGDIR="/var/lib/${INST_NAME}"
[ -z "$INST_LOGFILE" ] && INST_LOGFILE="${INST_LOGDIR}/${INST_NAME}.log"
}
############################################################################
# sudo_user_get() -- Returns the name of the user calling sudo or sudo su
# Modified for WSL2..
############################################################################
sudo_user_get(){
local LUUSER="$(whoami 2>/dev/null)"
if [ "$LUUSER" = 'root' ]; then
LUUSER="$SUDO_USER"
[ -z "$LUUSER" ] && LUUSER="$(logname 2>/dev/null)"
[ -z "$LUUSER" ] && LUUSER="$(who am i | awk '{print $1}')"
[ -z "$LUUSER" ] && [ "$(tty)" != 'not a tty' ] && LUUSER="$(ls -l $(tty) | awk '{print $3}')"
[ -z "$LUUSER" ] && LUUSER="$(awk -F':' '{ if($7 ~ /\/bin\/bash/ && $1 !~ /root/) {print $1; exit} };0' /etc/passwd)"
[ -z "$LUUSER" ] && LUUSER="$(grep '/bin/bash' /etc/passwd | grep -m1 -v 'root' | awk -F ':' '{print $1}')"
fi
echo "$LUUSER"
[ -z "$LUUSER" ] && return 1
return 0
}
user_get(){
echo "$UUSER"
[ -z "$UUSER" ] && return 1
return 0
}
user_group_get(){
local LUSER="$1"
local LGROUP=
if ( is_user "$LUSER" ); then
LGROUP="$(id -g -n "$LUSER")"
else
return 1
fi
echo "$LGROUP"
}
user_homedir_get(){
debug_echo "${FUNCNAME}( $@ )"
#~ local LINST_USER="${1:-$(who am i | sed -n -e 's/^\([[:alnum:]]*\)\s*.*$/\1/p')}"
local LINST_USER="${1:-$(sudo_user_get)}"
local LHOME_DIR=
# 1st try
LHOME_DIR="$( eval echo "~${LINST_USER}")"
# 2nd try
if [ -z "$LHOME_DIR" ] || [ ! -d "$LHOME_DIR" ]; then
LHOME_DIR="$(cat /etc/passwd | grep "$LINST_USER" | awk -F':' '{ print $6 }')"
fi
# 3rd try
if [ -z "$LHOME_DIR" ] || [ ! -d "$LHOME_DIR" ]; then
LHOME_DIR="/var/lib/${LINST_USER}"
fi
[ -d "$LHOME_DIR" ] && echo "$LHOME_DIR" || echo ""
}
######################################################################################################
# is_user() -- Check to see if a username exists..
######################################################################################################
is_user(){
[ -z "$1" ] && return 1
id -u "$1" >/dev/null 2>&1
return $?
}
######################################################################################################
# inst_user_create() Find or create the user account the service will run under.
######################################################################################################
inst_user_create(){
debug_echo "${FUNCNAME}( $@ )"
local LINST_USER="${1:-${INST_USER}}"
local LNEEDS_HOME="${1:-0}"
local LINST_GROUP="$INST_GROUP"
local LINST_HOME=
# If we don't need a user, our user will be root..
if [ $NEEDSUSER -lt 1 ]; then
if [ -z "$INST_USER" ]; then
INST_USER='root'
INST_GROUP="$(id -ng "$INST_USER")"
fi
return 0
fi
# If not specific username, then name after the service..
if [ -z "$LINST_USER" ]; then
LINST_USER="$INST_NAME"
fi
# If still no INST_USER, get the underlying user account..
if [ -z "$LINST_USER" ]; then
LINST_USER=$(who am i | sed -n -e 's/^\([[:alnum:]]*\)\s*.*$/\1/p')
if [ "$LINST_USER" = 'root' ]; then
#get the 1st user name with a bash shell who is not root..
LINST_USER=$(awk -F':' '{ if($7 ~ /\/bin\/bash/ && $1 !~ /root/) {print $1; exit} };0' /etc/passwd)
fi
# punt!
if [ -z "$LINST_USER" ]; then
LINST_USER=$(whoami)
fi
fi
# Check the id of the INST_USER..
# If no such user, create the user as a system user..
id -u "$LINST_USER" >/dev/null 2>&1
#~ adduser --system --home /var/lib/serviceuser serviceuser
if [[ ! $? -eq 0 ]]; then
if [ $IS_DEBIAN -gt 0 ]; then
if [ ! -z "$LINST_GROUP" ]; then
# If the group exists..
if [ $(grep -c "$INST_GROUP" /etc/group) -lt 1 ]; then
if [ "$LINST_GROUP" = "$LINST_USER" ]; then
adduser --system --no-create-home --group --gecos "${INST_PROD} user account" "$LINST_USER"
else
addgroup --system "$LINST_GROUP"
adduser --system --no-create-home --ingroup "$LINST_GROUP" --gecos "${INST_PROD} user account" "$LINST_USER"
fi
else
adduser --system --no-create-home --ingroup "$LINST_GROUP" --gecos "${INST_PROD} user account" "$LINST_USER"
fi
else
adduser --system --no-create-home --gecos "${INST_PROD} user account" "$LINST_USER"
fi
else
useradd --user-group --no-create-home --system --shell /sbin/nologin "$LINST_USER"
fi
fi
INST_USER="$LINST_USER"
INST_GROUP=$(id -ng $LINST_USER)
echo "${INST_NAME} service account set to ${LINST_USER}:${LINST_GROUP}"
}
######################################################################################################
# inst_user_remove() Delete the user account..
######################################################################################################
inst_user_remove(){
debug_echo "${FUNCNAME}( $@ )"
local LINST_USER="${1:-${INST_USER}}"
local LINST_GROUP="$INST_GROUP"
# Don't delete root
debug_echo "inst_user_remove: LINST_USER == ${LINST_USER}"
if [[ -z "$LINST_USER" ]] || [[ "$LINST_USER" = 'root' ]]; then
return 1
fi
# Don't delete a user with a real login account
if [ $(cat /etc/passwd | grep -E "^${LINST_USER}:.*$" | grep -c -E '/nologin|/false' ) -lt 1 ]; then
return 1
fi
# Remove the user account if it exists..
id "$LINST_USER" >/dev/null 2>&1
if [ $? -eq 0 ]; then
error_echo "Removing ${LINST_USER} user account.."
LINST_GROUP="$(id -ng "$LINST_USER")"
if [ $IS_DEBIAN -gt 0 ]; then
userdel -r $LINST_USER >/dev/null 2>&1
else
/usr/sbin/userdel -r -f "$LINST_USER" >/dev/null 2>&1
/usr/sbin/groupdel "$LINST_GROUP" >/dev/null 2>&1
fi
fi
}
######################################################################################################
# home_dir_create( dir ) Create the service home dir (usually parent of data_dir
######################################################################################################
home_dir_create(){
debug_echo "${FUNCNAME}( $@ )"
local LINST_HOMEDIR="${1:-/var/lib/${INST_NAME}}"
if [ $NEEDSHOME -lt 0 ]; then
return 1
fi
if [ -z "$INST_USER" ]; then
inst_user_create
fi
if [ ! -d "$LINST_HOMEDIR" ];then
error_echo "Creating ${LINST_HOMEDIR}.."
mkdir -p "$LINST_HOMEDIR"
fi
chown -R "${INST_USER}:${INST_GROUP}" "$LINST_HOMEDIR"
chmod 1754 "$LINST_HOMEDIR"
if [ ! -d "$LINST_HOMEDIR" ]; then
error_echo "Error: could not create ${LINST_HOMEDIR} home directory.."
return 1
fi
}
home_dir_update(){
debug_echo "${FUNCNAME}( $@ )"
local LINST_HOMEDIR="${1:-/var/lib/${INST_NAME}}"
home_dir_create "$LINST_HOMEDIR"
}
######################################################################################################
# home_dir_remove( dir ) Removes the service home dir (usually parent of data_dir
######################################################################################################
home_dir_remove(){
debug_echo "${FUNCNAME}( $@ )"
local LINST_HOMEDIR="${1:-/var/lib/${INST_NAME}}"
if [ $NEEDSHOME -lt 0 ]; then
return 1
fi
if [ -d "$LINST_HOMEDIR" ];then
error_echo "Removing ${LINST_HOMEDIR}.."
rm -Rf "$LINST_HOMEDIR"
fi
if [ -d "$LINST_HOMEDIR" ]; then
error_echo "Error: could not remove ${LINST_HOMEDIR} home directory.."
return 1
fi
}
######################################################################################################
# create_data_dir( dir, file ) Create the service data dir..
######################################################################################################
data_dir_create(){
debug_echo "${FUNCNAME}( $@ )"
local LINST_DATADIR="${1:-/var/lib/${INST_NAME}}"
local LINST_DATAFILE="$2"
if [ $NEEDSDATA -lt 0 ]; then
return 1
fi
if [ -z "$INST_USER" ]; then
inst_user_create
fi
#~ # Create the service data directory..
#~ [ -z "$INST_DATADIR" ] && INST_DATADIR="/var/lib/${INST_NAME}"
if [ ! -d "$LINST_DATADIR" ];then
error_echo "Creating ${LINST_DATADIR}.."