Revision 8dab1768 setup.sh
setup.sh | ||
---|---|---|
23 | 23 |
|
24 | 24 |
#!/bin/bash |
25 | 25 |
|
26 |
################################################################################ |
|
27 |
# GENERIC FUNCTIONS # |
|
28 |
################################################################################ |
|
29 |
|
|
30 |
### print an error message ##################################################### |
|
31 |
# Prints a error <message> to standard output. |
|
32 |
#If variable 'LOG_FILE' is specified, the message is also appended to the given file. |
|
33 |
# |
|
34 |
# usage: printError <message> |
|
35 |
# arguments: <message> |
|
36 |
# Message string to print. |
|
37 |
# return: n/a |
|
38 |
# |
|
39 |
function printError { |
|
40 |
local string="ERROR: $1" |
|
41 |
# if a log file is specified |
|
42 |
if [ -n "$LOG_FILE" ]; then |
|
43 |
printf "[$(date '+%Y-%m-%d %H:%M:%S')] $string" >> $LOG_FILE |
|
44 |
fi |
|
45 |
printf "$(tput setaf 1)>>> $string$(tput sgr 0)" 1>&2 |
|
46 |
} |
|
47 |
|
|
48 |
### print a warning message #################################################### |
|
49 |
# Prints a warning <message> to standard output. |
|
50 |
#If variable 'LOG_FILE' is specified, the message is also appended to the given file. |
|
51 |
# |
|
52 |
# usage: printMessage <message> |
|
53 |
# arguments: <message> |
|
54 |
# Message string to print. |
|
55 |
# return: n/a |
|
56 |
# |
|
57 |
function printWarning { |
|
58 |
local string="WARNING: $1" |
|
59 |
# if a log file is specified |
|
60 |
if [ -n "$LOG_FILE" ]; then |
|
61 |
printf "[$(date '+%Y-%m-%d %H:%M:%S')] $string" >> $LOG_FILE |
|
62 |
fi |
|
63 |
printf "$(tput setaf 3)>>> $string$(tput sgr 0)" |
|
64 |
} |
|
65 |
|
|
66 |
### print an information message ############################################### |
|
67 |
# Prints an information <message> to standard output. |
|
68 |
#If variable 'LOG_FILE' is specified, the message is also appended to the given file. |
|
69 |
# |
|
70 |
# usage: printInfo <message> |
|
71 |
# arguments: <message> |
|
72 |
# Message string to print. |
|
73 |
# return: n/a |
|
74 |
# |
|
75 |
function printInfo { |
|
76 |
local string="INFO: $1" |
|
77 |
# if a log file is specified |
|
78 |
if [ -n "$LOG_FILE" ]; then |
|
79 |
printf "[$(date '+%Y-%m-%d %H:%M:%S')] $string" >> $LOG_FILE |
|
80 |
fi |
|
81 |
printf "$(tput setaf 2)>>> $string$(tput sgr 0)" |
|
82 |
} |
|
83 |
|
|
84 |
### print a message to file #################################################### |
|
85 |
# Appends a <message> to a log file, specified by the variable 'LOG_FILE'. |
|
86 |
# |
|
87 |
# usage printLog <message> |
|
88 |
# arguments: <message> |
|
89 |
# Message string to print. |
|
90 |
# return: n/a |
|
91 |
# |
|
92 |
function printLog { |
|
93 |
local string="LOG: $1" |
|
94 |
# if a log file is specified |
|
95 |
if [ -n "$LOG_FILE" ]; then |
|
96 |
printf "[$(date '+%Y-%m-%d %H:%M:%S')] $string" >> $LOG_FILE |
|
97 |
fi |
|
98 |
} |
|
99 |
|
|
100 |
### exit the script normally ################################################### |
|
101 |
# Prints a delimiter and exits the script normally (returns 0). |
|
102 |
# |
|
103 |
# usage: quitScript |
|
104 |
# arguments: n/a |
|
105 |
# return: 0 |
|
106 |
# No error or warning occurred. |
|
107 |
# |
|
108 |
function quitScript { |
|
109 |
printInfo "exiting $(realpath ${BASH_SOURCE[0]})\n" |
|
110 |
printf "\n" |
|
111 |
printf "######################################################################\n" |
|
112 |
exit 0 |
|
113 |
} |
|
114 |
|
|
115 |
### read a user input ########################################################## |
|
116 |
# Reads a single character user input from a set up <options> and stores it in |
|
117 |
# a given <return> variable. |
|
118 |
# |
|
119 |
# usage: readUserInput <options> <return> |
|
120 |
# arguments: <options> |
|
121 |
# String definiing the set of valid characters. |
|
122 |
# If the string is empty, the user can input any character. |
|
123 |
# <return> |
|
124 |
# Variable to store the selected character to. |
|
125 |
# return: n/a |
|
126 |
# |
|
127 |
function readUserInput { |
|
128 |
local input="" |
|
129 |
# read user input |
|
130 |
while [ -z $input ] || ( [ -n "$1" ] && [[ ! $input =~ ^[$1]$ ]] ); do |
|
131 |
read -p "your selection: " -n 1 -e input |
|
132 |
if [ -z $input ] || ( [ -n "$1" ] && [[ ! $input =~ ^[$1]$ ]] ); then |
|
133 |
printWarning "[$input] is no valid action\n" |
|
134 |
fi |
|
135 |
done |
|
136 |
printLog "[$input] has been selected\n" |
|
137 |
eval $2="$input" |
|
138 |
} |
|
139 |
|
|
140 |
### check whether argument is an option ######################################## |
|
141 |
# Checks a <string> whether it is an option. |
|
142 |
# Options are defined to either start with '--' followed by any string, or |
|
143 |
# to start with a single '-' followed by a single character, or |
|
144 |
# to start with a single '-' followed by a single character, a '=' and any string. |
|
145 |
# Examples: '--option', '--option=arg', '-o', '-o=arg', '--' |
|
146 |
# |
|
147 |
# usage: parseIsOption <string> |
|
148 |
# arguments: <string> |
|
149 |
# A string to check whether it is an option. |
|
150 |
# return: 0 |
|
151 |
# <string> is an option. |
|
152 |
# -1 |
|
153 |
# <string> is not an option. |
|
154 |
# |
|
155 |
function parseIsOption { |
|
156 |
if [[ "$1" =~ ^-(.$|.=.*) ]] || [[ "$1" =~ ^--.* ]]; then |
|
157 |
return 0 |
|
158 |
else |
|
159 |
return -1 |
|
160 |
fi |
|
161 |
} |
|
162 |
|
|
163 |
### set the log file ########################################################### |
|
164 |
# Sets a specified <infile> as log file and checks whether it already exists. |
|
165 |
# If so, the log may either be appended to the file, its content can be cleared, |
|
166 |
# or no log is generated at all. |
|
167 |
# The resulting path is stored in <outvar>. |
|
168 |
# |
|
169 |
# usage: setLogFile [--option=<option>] [--quiet] <infile> <outvar> |
|
170 |
# arguments: --option=<option> |
|
171 |
# Select what to do if <file> already exists. |
|
172 |
# Possible values are 'a', 'c', 'r' and 'n'. |
|
173 |
# - a: append (starts with a separator) |
|
174 |
# - c: continue (does not insert a seperator) |
|
175 |
# - r: delete and restart |
|
176 |
# - n: no log |
|
177 |
# If no option is secified but <file> exists, an interactive selection is provided. |
|
178 |
# --quiet |
|
179 |
# Suppress all messages. |
|
180 |
# <infile> |
|
181 |
# Path of the wanted log file. |
|
182 |
# <outvar> |
|
183 |
# Variable to store the path of the log file to. |
|
184 |
# return: 0 |
|
185 |
# No error or warning occurred. |
|
186 |
# -1 |
|
187 |
# Error: invalid input |
|
188 |
# |
|
189 |
function setLogFile { |
|
190 |
local filepath="" |
|
191 |
local option="" |
|
192 |
local quiet=false |
|
193 |
|
|
194 |
# parse arguments |
|
195 |
local otherargs=() |
|
196 |
while [ $# -gt 0 ]; do |
|
197 |
if ( parseIsOption $1 ); then |
|
198 |
case "$1" in |
|
199 |
-o=*|--option=*) |
|
200 |
option=${1#*=}; shift 1;; |
|
201 |
-o*|--option*) |
|
202 |
option="$2"; shift 2;; |
|
203 |
-q|--quiet) |
|
204 |
quiet=true; shift 1;; |
|
205 |
*) |
|
206 |
printError "invalid option: $1\n"; shift 1;; |
|
207 |
esac |
|
208 |
else |
|
209 |
otherargs+=("$1") |
|
210 |
shift 1 |
|
211 |
fi |
|
212 |
done |
|
213 |
filepath=$(realpath ${otherargs[0]}) |
|
214 |
|
|
215 |
# if file already exists |
|
216 |
if [ -e $filepath ]; then |
|
217 |
# if no option was specified, ask what to do |
|
218 |
if [ -z "$option" ]; then |
|
219 |
printWarning "log file $filepath already esists\n" |
|
220 |
local userinput="" |
|
221 |
printf "Select what to do:\n" |
|
222 |
printf " [A] - append log\n" |
|
223 |
printf " [R] - restart log (delete existing file)\n" |
|
224 |
printf " [N] - no log\n" |
|
225 |
readUserInput "AaRrNn" userinput |
|
226 |
option=${userinput,,} |
|
227 |
fi |
|
228 |
# evaluate option |
|
229 |
case "$option" in |
|
230 |
a|c) |
|
231 |
if [ $quiet = false ]; then |
|
232 |
printInfo "appending log to $filepath\n" |
|
233 |
fi |
|
234 |
if [ $option != c ]; then |
|
235 |
printf "\n" >> $filepath |
|
236 |
printf "######################################################################\n" >> $filepath |
|
237 |
printf "\n" >> $filepath |
|
238 |
fi |
|
239 |
;; |
|
240 |
r) |
|
241 |
echo -n "" > $filepath |
|
242 |
if [ $quiet = false ]; then |
|
243 |
printInfo "content of $filepath wiped\n" |
|
244 |
fi |
|
245 |
;; |
|
246 |
n) |
|
247 |
if [ $quiet = false ]; then |
|
248 |
printInfo "no log file will be generated\n" |
|
249 |
fi |
|
250 |
filepath="" |
|
251 |
;; |
|
252 |
*) # sanity check (return error) |
|
253 |
printError "unexpected argument: $option\n"; return -1;; |
|
254 |
esac |
|
255 |
else |
|
256 |
if [ $quiet = false ]; then |
|
257 |
printInfo "log file set to $filepath\n" |
|
258 |
fi |
|
259 |
fi |
|
260 |
|
|
261 |
eval ${otherargs[1]}="$filepath" |
|
262 |
|
|
263 |
return 0 |
|
264 |
} |
|
265 |
|
|
266 |
### check whether commands are available ####################################### |
|
267 |
# Checks whether the specified commands are available and can be executed. |
|
268 |
# |
|
269 |
# usage: checkCommand [<command> <command> ...] |
|
270 |
# arguments: <command> |
|
271 |
# Name of the command to check. |
|
272 |
# return: 0 |
|
273 |
# All requested commands are available. |
|
274 |
# >0 |
|
275 |
# Number of requested commands that were not found. |
|
276 |
# -1 |
|
277 |
# No argument given. |
|
278 |
# |
|
279 |
function checkCommands { |
|
280 |
local status=0 |
|
281 |
|
|
282 |
# return if no argument was specified |
|
283 |
if [ $# -eq 0 ]; then |
|
284 |
return -1 |
|
285 |
fi |
|
286 |
|
|
287 |
# check all specified commands |
|
288 |
while [ $# -gt 0 ]; do |
|
289 |
command -v $1 &>/dev/null |
|
290 |
if [ $? -ne 0 ]; then |
|
291 |
printWarning "Command '$1' not available.\n" |
|
292 |
status=$((status + 1)) |
|
293 |
fi |
|
294 |
shift 1 |
|
295 |
done |
|
296 |
|
|
297 |
return $status |
|
298 |
} |
|
299 |
|
|
300 |
################################################################################ |
|
301 |
# SPECIFIC FUNCTIONS # |
|
302 |
################################################################################ |
|
26 |
# load library |
|
27 |
source "$(dirname ${BASH_SOURCE[0]})/tools/bash/setuplib.sh" |
|
303 | 28 |
|
304 | 29 |
### print welcome text ######################################################### |
305 | 30 |
# Prints a welcome message to standard out. |
Also available in: Unified diff