-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathwp_cleanup.sh
executable file
·1225 lines (1104 loc) · 38.8 KB
/
wp_cleanup.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
#!/usr/bin/env bash
### Created by Peter Forret ( pforret ) on 2023-04-12
### Based on https://github.com/pforret/bashew 1.19.3
script_version="0.0.1" # if there is a VERSION.md in this script's folder, that will have priority over this version number
readonly script_author="[email protected]"
readonly script_created="2023-04-12"
readonly run_as_root=-1 # run_as_root: 0 = don't check anything / 1 = script MUST run as root / -1 = script MAY NOT run as root
readonly script_description="clean up infected WordPress installations"
## some initialisation
action=""
script_prefix=""
script_basename=""
install_package=""
temp_files=()
function Option:config() {
grep <<<"
#commented lines will be filtered
flag|h|help|show usage
flag|q|quiet|no output
flag|v|verbose|also show debug messages
flag|f|force|do not ask for confirmation
flag|P|noplugins|do not copy plugins
flag|T|nothemes|do not copy themes
flag|U|nouploads|do not copy uploads
option|l|log_dir|folder for log files |$HOME/.$script_prefix/log
option|t|tmp_dir|folder for temp files|$HOME/.$script_prefix/tmp
option|W|WP|WordPress installation folder|.
option|M|MULTI|Multi-site setup: subdomain/subfolder|
choice|1|action|action to perform|detect,fix,check,env,update
" -v -e '^#' -e '^\s*$'
}
#####################################################################
## Put your Script:main script here
#####################################################################
Script:main() {
IO:log "[$script_basename] $script_version started"
Os:require "awk"
action=$(Str:lower "$action")
case $action in
detect)
#TIP: use «$script_prefix detect» to check if there is an infected WP installation in that folder
#TIP:> $script_prefix -W /home/sites/wp_1 detect
is_wp_installed "$WP" || IO:die "No WordPress installed in folder [$WP]"
# first check for unreadable files
find . -type f ! -readable |
while read -r file; do
IO:alert "# the file '$file' should readable"
done
[[ $(find . -type f ! -readable) ]] && IO:confirm "Shall I fix this?" && find . -type f ! -readable -exec chmod +r "{}" \;
# then check for eval( in scripts
grep --include="*.php" -lir "eval(" "$WP" 2>/dev/null |
while read -r file; do
[[ "$file" = */wp-includes/class-json.php ]] && continue
[[ "$file" = */wp-admin/includes/class-pclzip.php ]] && continue
IO:alert "'$file' might be infected"
done
;;
fix)
#TIP: use «$script_prefix fix» to run the cleanup (reinstall WP)
#TIP:> $script_prefix -W /home/sites/wp_1 fix
is_wp_installed "$WP" || IO:die "No WordPress installed in folder [$WP]"
now=$(date '+%Y%m%d_%H%M')
move_existing_wp "$WP" "$WP/_infected.$now"
install_new_wp "$WP" "$WP/_infected.$now"
;;
check | env)
## leave this default action, it will make it easier to test your script
#TIP: use «$script_prefix check» to check if this script is ready to execute and what values the options/flags are
#TIP:> $script_prefix check
#TIP: use «$script_prefix env» to generate an example .env file
#TIP:> $script_prefix env > .env
Script:check
;;
update)
## leave this default action, it will make it easier to test your script
#TIP: use «$script_prefix update» to update to the latest version
#TIP:> $script_prefix update
Script:git_pull
;;
*)
IO:die "action [$action] not recognized"
;;
esac
IO:log "[$script_basename] ended after $SECONDS secs"
#TIP: >>> bash script created with «pforret/bashew»
#TIP: >>> for bash development, also check IO:print «pforret/setver» and «pforret/IO:progressbar»
}
#####################################################################
## Put your helper scripts here
#####################################################################
function move_existing_wp() {
local from="$1"
local to="$2"
[[ ! -d "$from" ]] && IO:die "Cannot find folder [$from]"
[[ ! -d "$to" ]] && mkdir "$to"
from=$(realpath "$from")
to=$(realpath "$to")
IO:progress "Moving existing WordPress files"
find . -type f ! -readable -exec chmod +r "{}" \;
# avoid copying ZIP files too
find "$from" -maxdepth 1 -type f -name '*.php' -exec mv {} "$to" \;
find "$from" -maxdepth 1 -type f -name '*.txt' -exec mv {} "$to" \;
find "$from" -maxdepth 1 -type f -name '*.html' -exec mv {} "$to" \;
IO:debug "Moving WP folders to [$(basename "$to")]"
find "$from" -maxdepth 1 -type d -name 'wp-*' -exec mv {} "$to" \;
[[ -d "$from/wordpress" ]] && rm -fr "$from/wordpress"
IO:success "WordPress installation moved to [$(basename "$to")]"
weird_folders=$(find "$from" -maxdepth 1 -mindepth 1 -type d |
while read -r folder; do
base=$(basename "$folder")
[[ "$base" =~ _infected.* ]] && continue
IO:alert "# the folder '$base' should not be in a WP install"
echo "$folder"
done)
[[ "$weird_folders" ]] && IO:confirm "Do you want to remove them?" && for folder in $weird_folders ; do rm -fr "$folder" ; IO:success "delete folder [$folder]" ; done
}
function install_new_wp() {
local root="$1"
local backup="$2"
Os:require wget
Os:require unzip
[[ ! -d "$root" ]] && IO:die "Cannot find folder [$root]"
[[ ! -d "$backup" ]] && IO:die "Cannot find folder [$backup]"
root=$(realpath "$root")
backup=$(realpath "$backup")
pushd "$root" >/dev/null || return 1
IO:progress "WP Download"
wget -q "https://wordpress.org/latest.zip"
[[ ! -f latest.zip ]] && IO:die "Could not download latest version of WordPress"
IO:progress "WP unzip "
unzip -q latest.zip
[[ ! -d wordpress/wp-admin ]] && IO:die "No folder wp-admin could be found in the zip file"
WP_VERSION=$(detect_wp_version "wordpress")
IO:success "Wordpress ${WP_VERSION:-?} downloaded!"
IO:progress "WP move files "
mv wordpress/wp-admin .
mv wordpress/wp-content .
mv wordpress/wp-includes .
mv wordpress/*.php .
mv wordpress/*.txt .
mv wordpress/*.html .
IO:success "Wordpress system restored!"
IO:progress "WP restore config "
# shellcheck disable=SC2154
((nothemes)) || copy_missing_subs "$backup/wp-content/themes" "wp-content/themes"
# shellcheck disable=SC2154
((noplugins)) || copy_missing_subs "$backup/wp-content/plugins" "wp-content/plugins"
# shellcheck disable=SC2154
((nouploads)) || (
[[ ! -d "wp-content/uploads" ]] && mkdir "wp-content/uploads"
[[ -d "$backup/wp-content/uploads" ]] && copy_missing_subs "$backup/wp-content/uploads" "wp-content/uploads"
)
cp "$backup/wp-config.php" .
IO:success "Wordpress settings copied!"
if [[ -n "$MULTI" ]]; then
[[ ! -f "$script_install_folder/files/$MULTI.htaccess" ]] && IO:die "$MULTI can only be subfolder/sudomain"
cp "$script_install_folder/files/$MULTI.htaccess" .htaccess
else
cp "$script_install_folder/files/simple.htaccess" .htaccess
fi
IO:success "Wordpress .htaccess set!"
rm -fr wordpress
rm latest.zip
IO:success "Wordpress cleanup done"
IO:confirm "Do you want to compress the infected files?" && zip -qrm "$backup.zip" "$backup/" && IO:success "old WordPress moved to $(basename "$backup.zip") ( $(du -h "$backup.zip" | cut -f1)B )"
popd >/dev/null || return 1
}
function detect_wp_version() {
if [[ -f "$1/wp-admin/about.php" ]]; then
awk <"$1/wp-admin/about.php" '/includes more than/ {print $3}'
else
echo "?"
fi
}
function copy_missing_subs() {
local from="$1"
local to="$2"
local copied
IO:progress "Restoring $(basename "$to")"
copied=$(
find "$from" -maxdepth 1 -mindepth 1 -type d |
sort |
while read -r folder; do
base=$(basename "$folder")
[[ -d "$to/$base" ]] && continue # skip existing sub folders
printf "%s " "$base"
cp -r "$folder" "$to/"
done
echo " "
)
[[ -n "$copied" ]] && IO:success "Copied from $(basename "$from"): $copied"
}
function is_wp_installed() {
## if folder doesn't exist => false
[[ ! -d "$1" ]] && return 1
IO:debug "Folder [$1] exists"
## if folder is inaccessible => false
pushd "$1" >/dev/null || return 1
IO:debug "Folder [$1] is accessible ( $(pwd) )"
## if there is no wp-admin folder => false
[[ ! -d wp-admin ]] && return 1
IO:debug "Folder [$1] has wp-admin/"
## if there is no wp-config.php file => false
[[ ! -f wp-config.php ]] && return 1
IO:debug "Folder [$1] has wp-config.php"
WP_VERSION=$(detect_wp_version .)
popd >/dev/null || return 1
IO:print "WP version in [$(basename "$1")]: $WP_VERSION"
return 0
}
#####################################################################
################### DO NOT MODIFY BELOW THIS LINE ###################
#####################################################################
# set strict mode - via http://redsymbol.net/articles/unofficial-bash-strict-mode/
# removed -e because it made basic [[ testing ]] difficult
set -uo pipefail
IFS=$'\n\t'
force=0
help=0
error_prefix=""
#to enable verbose even before option parsing
verbose=0
[[ $# -gt 0 ]] && [[ $1 == "-v" ]] && verbose=1
#to enable quiet even before option parsing
quiet=0
[[ $# -gt 0 ]] && [[ $1 == "-q" ]] && quiet=1
### stdIO:print/stderr output
function IO:initialize() {
# shellcheck disable=SC2034
script_started_at=$(Tool:time)
[[ "${BASH_SOURCE[0]:-}" != "${0}" ]] && sourced=1 || sourced=0
[[ -t 1 ]] && piped=0 || piped=1 # detect if output is piped
if [[ $piped -eq 0 && -n $(command -v tput) ]]; then
txtReset=$(tput sgr0)
txtError=$(tput setaf 160)
txtInfo=$(tput setaf 2)
txtWarn=$(tput setaf 214)
txtBold=$(tput bold)
txtItalic=$(tput sitm)
txtUnderline=$(tput smul)
else
txtReset=""
txtError=""
txtInfo=""
txtInfo=""
txtWarn=""
txtBold=""
txtItalic=""
txtUnderline=""
fi
[[ $(echo -e '\xe2\x82\xac') == '€' ]] && unicode=1 || unicode=0 # detect if unicode is supported
if [[ $unicode -gt 0 ]]; then
char_succes="✅"
char_fail="⛔"
char_alert="✴️"
char_wait="⏳"
info_icon="🌼"
config_icon="🌱"
clean_icon="🧽"
require_icon="🔌"
else
char_succes="OK "
char_fail="!! "
char_alert="?? "
char_wait="..."
info_icon="(i)"
config_icon="[c]"
clean_icon="[c]"
require_icon="[r]"
fi
error_prefix="${txtError}>${txtReset}"
}
function IO:print() {
((quiet)) && true || printf '%b\n' "$*"
}
function IO:debug() {
((verbose)) && IO:print "${txtInfo}# $* ${txtReset}" >&2
true
}
function IO:die() {
IO:print "${txtError}${char_fail} $script_basename${txtReset}: $*" >&2
[[ $(command -v tput) ]] && tput bel
Script:exit
}
function IO:alert() {
IO:print "${txtWarn}${char_alert}${txtReset}: ${txtUnderline}$*${txtReset}" >&2
}
function IO:success() {
IO:print "${txtInfo}${char_succes}${txtReset} ${txtBold}$*${txtReset}"
}
function IO:announce() {
IO:print "${txtInfo}${char_wait}${txtReset} ${txtItalic}$*${txtReset}"
sleep 1
}
function IO:progress() {
((quiet)) || (
local screen_width
screen_width=$(tput cols 2>/dev/null || echo 80)
local rest_of_line
rest_of_line=$((screen_width - 5))
if ((piped)); then
IO:print "... $*" >&2
else
printf "... %-${rest_of_line}b\r" "$* " >&2
fi
)
}
function IO:countdown() {
local seconds=${1:-5}
local message=${2:-Countdown :}
if ((piped)); then
IO:print "$message $seconds seconds"
else
for ((i = 0; i < "$seconds"; i++)); do
IO:progress "${txtInfo}$message $((seconds - i)) seconds${txtReset}"
sleep 1
done
IO:print " "
fi
}
### interactive
function IO:confirm() {
((force)) && return 0
read -r -p "$1 [y/N] " -n 1
echo " "
[[ $REPLY =~ ^[Yy]$ ]]
}
function IO:question() {
local ANSWER
local DEFAULT=${2:-}
read -r -p "$1 ($DEFAULT) > " ANSWER
[[ -z "$ANSWER" ]] && echo "$DEFAULT" || echo "$ANSWER"
}
function IO:log() {
[[ -n "${log_file:-}" ]] && echo "$(date '+%H:%M:%S') | $*" >>"$log_file"
}
function Tool:calc() {
awk "BEGIN {print $*} ; "
}
function Tool:round() {
number=${1}
decimals=${2:-0}
awk "BEGIN {print sprintf( \"%.${decimals}f\" , $number )};"
}
function Tool:time() {
if [[ $(command -v perl) ]]; then
perl -MTime::HiRes=time -e 'printf "%f\n", time'
elif [[ $(command -v php) ]]; then
php -r 'printf("%f\n",microtime(true));'
elif [[ $(command -v python) ]]; then
python -c 'import time; print(time.time()) '
elif [[ $(command -v python3) ]]; then
python3 -c 'import time; print(time.time()) '
elif [[ $(command -v node) ]]; then
node -e 'console.log(+new Date() / 1000)'
elif [[ $(command -v ruby) ]]; then
ruby -e 'STDOUT.puts(Time.now.to_f)'
else
date '+%s.000'
fi
}
function Tool:throughput() {
local time_started="$1"
local operations=${2:-1}
local name=${3:-operation}
# shellcheck disable=SC2155
local time_finished=$(Tool:time)
duration=$(Tool:calc "$time_finished - $time_started")
seconds=$(Tool:round "$duration")
if [[ "$operations" -gt 1 ]]; then
if [[ $operations -gt $seconds ]]; then
ops=$(Tool:calc "$operations / $duration")
ops=$(Tool:round "$ops" 3)
duration=$(Tool:round "$duration" 2)
IO:print "$operations $name finished in $duration secs: $ops $name/sec"
else
ops=$(Tool:calc "$duration / $operations")
ops=$(Tool:round "$ops" 3)
duration=$(Tool:round "$duration" 2)
IO:print "$operations $name finished in $duration secs: $ops sec/$name"
fi
else
duration=$(Tool:round "$duration" 2)
IO:print "$name finished in $duration secs"
fi
}
### string processing
function Str:trim() {
local var="$*"
# remove leading whitespace characters
var="${var#"${var%%[![:space:]]*}"}"
# remove trailing whitespace characters
var="${var%"${var##*[![:space:]]}"}"
printf '%s' "$var"
}
function Str:lower() {
if [[ -n "$1" ]]; then
local input="$*"
echo "${input,,}"
else
awk '{print tolower($0)}'
fi
}
function Str:upper() {
if [[ -n "$1" ]]; then
local input="$*"
echo "${input^^}"
else
awk '{print toupper($0)}'
fi
}
function Str:ascii() {
# remove all characters with accents/diacritics to latin alphabet
# shellcheck disable=SC2020
sed 'y/àáâäæãåāǎçćčèéêëēėęěîïííīįìǐłñńôöòóœøōǒõßśšûüǔùǖǘǚǜúūÿžźżÀÁÂÄÆÃÅĀǍÇĆČÈÉÊËĒĖĘĚÎÏÍÍĪĮÌǏŁÑŃÔÖÒÓŒØŌǑÕẞŚŠÛÜǓÙǕǗǙǛÚŪŸŽŹŻ/aaaaaaaaaccceeeeeeeeiiiiiiiilnnooooooooosssuuuuuuuuuuyzzzAAAAAAAAACCCEEEEEEEEIIIIIIIILNNOOOOOOOOOSSSUUUUUUUUUUYZZZ/'
}
function Str:slugify() {
# Str:slugify <input> <separator>
# Str:slugify "Jack, Jill & Clémence LTD" => jack-jill-clemence-ltd
# Str:slugify "Jack, Jill & Clémence LTD" "_" => jack_jill_clemence_ltd
separator="${2:-}"
[[ -z "$separator" ]] && separator="-"
Str:lower "$1" |
Str:ascii |
awk '{
gsub(/[\[\]@#$%^&*;,.:()<>!?\/+=_]/," ",$0);
gsub(/^ */,"",$0);
gsub(/ *$/,"",$0);
gsub(/ */,"-",$0);
gsub(/[^a-z0-9\-]/,"");
print;
}' |
sed "s/-/$separator/g"
}
function Str:title() {
# Str:title <input> <separator>
# Str:title "Jack, Jill & Clémence LTD" => JackJillClemenceLtd
# Str:title "Jack, Jill & Clémence LTD" "_" => Jack_Jill_Clemence_Ltd
separator="${2:-}"
# shellcheck disable=SC2020
Str:lower "$1" |
tr 'àáâäæãåāçćčèéêëēėęîïííīįìłñńôöòóœøōõßśšûüùúūÿžźż' 'aaaaaaaaccceeeeeeeiiiiiiilnnoooooooosssuuuuuyzzz' |
awk '{ gsub(/[\[\]@#$%^&*;,.:()<>!?\/+=_-]/," ",$0); print $0; }' |
awk '{
for (i=1; i<=NF; ++i) {
$i = toupper(substr($i,1,1)) tolower(substr($i,2))
};
print $0;
}' |
sed "s/ /$separator/g" |
cut -c1-50
}
function Str:digest() {
local length=${1:-6}
if [[ -n $(command -v md5sum) ]]; then
# regular linux
md5sum | cut -c1-"$length"
else
# macos
md5 | cut -c1-"$length"
fi
}
# Gha: function should only be run inside of a Github Action
function Gha:finish() {
[[ -z "${RUNNER_OS:-}" ]] && IO:die "This should only run inside a Github Action, don't run it on your machine"
git config user.name "Bashew Runner"
git config user.email "[email protected]"
timestamp=$(date -u)
message="$timestamp < $script_basename $script_version"
git add -A
git commit -m "${message}" || exit 0
git pull --rebase
git push
exit 0
}
trap "IO:die \"ERROR \$? after \$SECONDS seconds \n\
\${error_prefix} last command : '\$BASH_COMMAND' \" \
\$(< \$script_install_path awk -v lineno=\$LINENO \
'NR == lineno {print \"\${error_prefix} from line \" lineno \" : \" \$0}')" INT TERM EXIT
# cf https://askubuntu.com/questions/513932/what-is-the-bash-command-variable-good-for
Script:exit() {
for temp_file in "${temp_files[@]-}"; do
[[ -f "$temp_file" ]] && (
IO:debug "Delete temp file [$temp_file]"
rm -f "$temp_file"
)
done
trap - INT TERM EXIT
IO:debug "$script_basename finished after $SECONDS seconds"
exit 0
}
Script:check_version() {
(
# shellcheck disable=SC2164
pushd "$script_install_folder" &>/dev/null
if [[ -d .git ]]; then
local remote
remote="$(git remote -v | grep fetch | awk 'NR == 1 {print $2}')"
IO:progress "Check for latest version - $remote"
git remote update &>/dev/null
if [[ $(git rev-list --count "HEAD...HEAD@{upstream}" 2>/dev/null) -gt 0 ]]; then
IO:print "There is a more recent update of this script - run <<$script_prefix update>> to update"
fi
fi
# shellcheck disable=SC2164
popd &>/dev/null
)
}
Script:git_pull() {
# run in background to avoid problems with modifying a running interpreted script
(
sleep 1
cd "$script_install_folder" && git pull
) &
}
Script:show_tips() {
((sourced)) && return 0
# shellcheck disable=SC2016
grep <"${BASH_SOURCE[0]}" -v '$0' |
awk \
-v green="$txtInfo" \
-v yellow="$txtWarn" \
-v reset="$txtReset" \
'
/TIP: / {$1=""; gsub(/«/,green); gsub(/»/,reset); print "*" $0}
/TIP:> / {$1=""; print " " yellow $0 reset}
' |
awk \
-v script_basename="$script_basename" \
-v script_prefix="$script_prefix" \
'{
gsub(/\$script_basename/,script_basename);
gsub(/\$script_prefix/,script_prefix);
print ;
}'
}
Script:check() {
local name
if [[ -n $(Option:filter flag) ]]; then
IO:print "## ${txtInfo}boolean flags${txtReset}:"
Option:filter flag |
while read -r name; do
if ((piped)); then
eval "echo \"$name=\$${name:-}\""
else
eval "echo -n \"$name=\$${name:-} \""
fi
done
IO:print " "
IO:print " "
fi
if [[ -n $(Option:filter option) ]]; then
IO:print "## ${txtInfo}option defaults${txtReset}:"
Option:filter option |
while read -r name; do
if ((piped)); then
eval "echo \"$name=\$${name:-}\""
else
eval "echo -n \"$name=\$${name:-} \""
fi
done
IO:print " "
IO:print " "
fi
if [[ -n $(Option:filter list) ]]; then
IO:print "## ${txtInfo}list options${txtReset}:"
Option:filter list |
while read -r name; do
if ((piped)); then
eval "echo \"$name=(\${${name}[@]})\""
else
eval "echo -n \"$name=(\${${name}[@]}) \""
fi
done
IO:print " "
IO:print " "
fi
if [[ -n $(Option:filter param) ]]; then
if ((piped)); then
IO:debug "Skip parameters for .env files"
else
IO:print "## ${txtInfo}parameters${txtReset}:"
Option:filter param |
while read -r name; do
# shellcheck disable=SC2015
((piped)) && eval "echo \"$name=\\\"\${$name:-}\\\"\"" || eval "echo -n \"$name=\\\"\${$name:-}\\\" \""
done
echo " "
fi
IO:print " "
fi
if [[ -n $(Option:filter choice) ]]; then
if ((piped)); then
IO:debug "Skip choices for .env files"
else
IO:print "## ${txtInfo}choice${txtReset}:"
Option:filter choice |
while read -r name; do
# shellcheck disable=SC2015
((piped)) && eval "echo \"$name=\\\"\${$name:-}\\\"\"" || eval "echo -n \"$name=\\\"\${$name:-}\\\" \""
done
echo " "
fi
IO:print " "
fi
IO:print "## ${txtInfo}required commands${txtReset}:"
Script:show_required
}
Option:usage() {
IO:print "Program : ${txtInfo}$script_basename${txtReset} by ${txtWarn}$script_author${txtReset}"
IO:print "Version : ${txtInfo}v$script_version${txtReset} (${txtWarn}$script_modified${txtReset})"
IO:print "Purpose : ${txtInfo}$script_description${txtReset}"
echo -n "Usage : $script_basename"
Option:config |
awk '
BEGIN { FS="|"; OFS=" "; oneline="" ; fulltext="Flags, options and parameters:"}
$1 ~ /flag/ {
fulltext = fulltext sprintf("\n -%1s|--%-12s: [flag] %s [default: off]",$2,$3,$4) ;
oneline = oneline " [-" $2 "]"
}
$1 ~ /option/ {
fulltext = fulltext sprintf("\n -%1s|--%-12s: [option] %s",$2,$3 " <?>",$4) ;
if($5!=""){fulltext = fulltext " [default: " $5 "]"; }
oneline = oneline " [-" $2 " <" $3 ">]"
}
$1 ~ /list/ {
fulltext = fulltext sprintf("\n -%1s|--%-12s: [list] %s (array)",$2,$3 " <?>",$4) ;
fulltext = fulltext " [default empty]";
oneline = oneline " [-" $2 " <" $3 ">]"
}
$1 ~ /secret/ {
fulltext = fulltext sprintf("\n -%1s|--%s <%s>: [secret] %s",$2,$3,"?",$4) ;
oneline = oneline " [-" $2 " <" $3 ">]"
}
$1 ~ /param/ {
if($2 == "1"){
fulltext = fulltext sprintf("\n %-17s: [parameter] %s","<"$3">",$4);
oneline = oneline " <" $3 ">"
}
if($2 == "?"){
fulltext = fulltext sprintf("\n %-17s: [parameter] %s (optional)","<"$3">",$4);
oneline = oneline " <" $3 "?>"
}
if($2 == "n"){
fulltext = fulltext sprintf("\n %-17s: [parameters] %s (1 or more)","<"$3">",$4);
oneline = oneline " <" $3 " …>"
}
}
$1 ~ /choice/ {
fulltext = fulltext sprintf("\n %-17s: [choice] %s","<"$3">",$4);
if($5!=""){fulltext = fulltext " [options: " $5 "]"; }
oneline = oneline " <" $3 ">"
}
END {print oneline; print fulltext}
'
}
function Option:filter() {
Option:config | grep "$1|" | cut -d'|' -f3 | sort | grep -v '^\s*$'
}
function Script:show_required() {
grep 'Os:require' "$script_install_path" |
grep -v -E '\(\)|grep|# Os:require' |
awk -v install="# $install_package " '
function ltrim(s) { sub(/^[ "\t\r\n]+/, "", s); return s }
function rtrim(s) { sub(/[ "\t\r\n]+$/, "", s); return s }
function trim(s) { return rtrim(ltrim(s)); }
NF == 2 {print install trim($2); }
NF == 3 {print install trim($3); }
NF > 3 {$1=""; $2=""; $0=trim($0); print "# " trim($0);}
' |
sort -u
}
function Option:initialize() {
local init_command
init_command=$(Option:config |
grep -v "verbose|" |
awk '
BEGIN { FS="|"; OFS=" ";}
$1 ~ /flag/ && $5 == "" {print $3 "=0; "}
$1 ~ /flag/ && $5 != "" {print $3 "=\"" $5 "\"; "}
$1 ~ /option/ && $5 == "" {print $3 "=\"\"; "}
$1 ~ /option/ && $5 != "" {print $3 "=\"" $5 "\"; "}
$1 ~ /choice/ {print $3 "=\"\"; "}
$1 ~ /list/ {print $3 "=(); "}
$1 ~ /secret/ {print $3 "=\"\"; "}
')
if [[ -n "$init_command" ]]; then
eval "$init_command"
fi
}
function Option:has_single() { Option:config | grep 'param|1|' >/dev/null; }
function Option:has_choice() { Option:config | grep 'choice|1' >/dev/null; }
function Option:has_optional() { Option:config | grep 'param|?|' >/dev/null; }
function Option:has_multi() { Option:config | grep 'param|n|' >/dev/null; }
function Option:parse() {
if [[ $# -eq 0 ]]; then
Option:usage >&2
Script:exit
fi
## first process all the -x --xxxx flags and options
while true; do
# flag <flag> is saved as $flag = 0/1
# option <option> is saved as $option
if [[ $# -eq 0 ]]; then
## all parameters processed
break
fi
if [[ ! $1 == -?* ]]; then
## all flags/options processed
break
fi
local save_option
save_option=$(Option:config |
awk -v opt="$1" '
BEGIN { FS="|"; OFS=" ";}
$1 ~ /flag/ && "-"$2 == opt {print $3"=1"}
$1 ~ /flag/ && "--"$3 == opt {print $3"=1"}
$1 ~ /option/ && "-"$2 == opt {print $3"=${2:-}; shift"}
$1 ~ /option/ && "--"$3 == opt {print $3"=${2:-}; shift"}
$1 ~ /list/ && "-"$2 == opt {print $3"+=(${2:-}); shift"}
$1 ~ /list/ && "--"$3 == opt {print $3"=(${2:-}); shift"}
$1 ~ /secret/ && "-"$2 == opt {print $3"=${2:-}; shift #noshow"}
$1 ~ /secret/ && "--"$3 == opt {print $3"=${2:-}; shift #noshow"}
')
if [[ -n "$save_option" ]]; then
if echo "$save_option" | grep shift >>/dev/null; then
local save_var
save_var=$(echo "$save_option" | cut -d= -f1)
IO:debug "$config_icon parameter: ${save_var}=$2"
else
IO:debug "$config_icon flag: $save_option"
fi
eval "$save_option"
else
IO:die "cannot interpret option [$1]"
fi
shift
done
((help)) && (
Option:usage
Script:check_version
IO:print " "
echo "### TIPS & EXAMPLES"
Script:show_tips
) && Script:exit
local option_list
local option_count
local choices
local single_params
## then run through the given parameters
if Option:has_choice; then
choices=$(Option:config | awk -F"|" '
$1 == "choice" && $2 == 1 {print $3}
')
option_list=$(xargs <<<"$choices")
option_count=$(wc <<<"$choices" -w | xargs)
IO:debug "$config_icon Expect : $option_count choice(s): $option_list"
[[ $# -eq 0 ]] && IO:die "need the choice(s) [$option_list]"
local choices_list
local valid_choice
for param in $choices; do
[[ $# -eq 0 ]] && IO:die "need choice [$param]"
[[ -z "$1" ]] && IO:die "need choice [$param]"
IO:debug "$config_icon Assign : $param=$1"
# check if choice is in list
choices_list=$(Option:config | awk -F"|" -v choice="$param" '$1 == "choice" && $3 = choice {print $5}')
valid_choice=$(tr <<<"$choices_list" "," "\n" | grep "$1")
[[ -z "$valid_choice" ]] && IO:die "choice [$1] is not valid, should be in list [$choices_list]"
eval "$param=\"$1\""
shift
done
else
IO:debug "$config_icon No choices to process"
choices=""
option_count=0
fi
if Option:has_single; then
single_params=$(Option:config | awk -F"|" '
$1 == "param" && $2 == 1 {print $3}
')
option_list=$(xargs <<<"$single_params")
option_count=$(wc <<<"$single_params" -w | xargs)
IO:debug "$config_icon Expect : $option_count single parameter(s): $option_list"
[[ $# -eq 0 ]] && IO:die "need the parameter(s) [$option_list]"
for param in $single_params; do
[[ $# -eq 0 ]] && IO:die "need parameter [$param]"
[[ -z "$1" ]] && IO:die "need parameter [$param]"
IO:debug "$config_icon Assign : $param=$1"
eval "$param=\"$1\""
shift
done
else
IO:debug "$config_icon No single params to process"
single_params=""
option_count=0
fi
if Option:has_optional; then
local optional_params
local optional_count
optional_params=$(Option:config | grep 'param|?|' | cut -d'|' -f3)
optional_count=$(wc <<<"$optional_params" -w | xargs)
IO:debug "$config_icon Expect : $optional_count optional parameter(s): $(echo "$optional_params" | xargs)"
for param in $optional_params; do
IO:debug "$config_icon Assign : $param=${1:-}"
eval "$param=\"${1:-}\""
shift
done
else
IO:debug "$config_icon No optional params to process"
optional_params=""
optional_count=0
fi
if Option:has_multi; then
#IO:debug "Process: multi param"
local multi_count
local multi_param
multi_count=$(Option:config | grep -c 'param|n|')
multi_param=$(Option:config | grep 'param|n|' | cut -d'|' -f3)
IO:debug "$config_icon Expect : $multi_count multi parameter: $multi_param"
((multi_count > 1)) && IO:die "cannot have >1 'multi' parameter: [$multi_param]"
((multi_count > 0)) && [[ $# -eq 0 ]] && IO:die "need the (multi) parameter [$multi_param]"
# save the rest of the params in the multi param
if [[ -n "$*" ]]; then
IO:debug "$config_icon Assign : $multi_param=$*"
eval "$multi_param=( $* )"
fi
else
multi_count=0
multi_param=""
[[ $# -gt 0 ]] && IO:die "cannot interpret extra parameters"
fi
}
function Os:require() {
local install_instructions
local binary
local words
local path_binary
# $1 = binary that is required
binary="$1"
path_binary=$(command -v "$binary" 2>/dev/null)
[[ -n "$path_binary" ]] && IO:debug "️$require_icon required [$binary] -> $path_binary" && return 0
# $2 = how to install it
words=$(echo "${2:-}" | wc -w)
if ((force)); then
IO:announce "Installing [$1] ..."
case $words in
0) eval "$install_package $1" ;;
# Os:require ffmpeg -- binary and package have the same name
1) eval "$install_package $2" ;;
# Os:require convert imagemagick -- binary and package have different names
*) eval "${2:-}" ;;
# Os:require primitive "go get -u github.com/fogleman/primitive" -- non-standard package manager
esac
else
install_instructions="$install_package $1"
[[ $words -eq 1 ]] && install_instructions="$install_package $2"
[[ $words -gt 1 ]] && install_instructions="${2:-}"
IO:alert "$script_basename needs [$binary] but it cannot be found"
IO:alert "1) install package : $install_instructions"
IO:alert "2) check path : export PATH=\"[path of your binary]:\$PATH\""
IO:die "Missing program/script [$binary]"
fi
}
function Os:folder() {
if [[ -n "$1" ]]; then
local folder="$1"
local max_days=${2:-365}
if [[ ! -d "$folder" ]]; then
IO:debug "$clean_icon Create folder : [$folder]"
mkdir -p "$folder"
else
IO:debug "$clean_icon Cleanup folder: [$folder] - delete files older than $max_days day(s)"
find "$folder" -mtime "+$max_days" -type f -exec rm {} \;
fi
fi
}
function Os:follow_link() {
[[ ! -L "$1" ]] && echo "$1" && return 0
local file_folder
local link_folder
local link_name
file_folder="$(dirname "$1")"
# resolve relative to absolute path
[[ "$file_folder" != /* ]] && link_folder="$(cd -P "$file_folder" &>/dev/null && pwd)"
local symlink
symlink=$(readlink "$1")
link_folder=$(dirname "$symlink")
link_name=$(basename "$symlink")
[[ -z "$link_folder" ]] && link_folder="$file_folder"
[[ "$link_folder" == \.* ]] && link_folder="$(cd -P "$file_folder" && cd -P "$link_folder" &>/dev/null && pwd)"
IO:debug "$info_icon Symbolic ln: $1 -> [$symlink]"
Os:follow_link "$link_folder/$link_name"
}
function Os:notify() {
# cf https://levelup.gitconnected.com/5-modern-bash-scripting-techniques-that-only-a-few-programmers-know-4abb58ddadad
local message="$1"
local source="${2:-$script_basename}"
[[ -n $(command -v notify-send) ]] && notify-send "$source" "$message" # for Linux
[[ -n $(command -v osascript) ]] && osascript -e "display notification \"$message\" with title \"$source\"" # for MacOS
}