Statistics
| Branch: | Tag: | Revision:

amiro-os / periphery-lld / peripherylldsetup.sh @ 1bb524af

History | View | Annotate | Download (19.2 KB)

1 e545e620 Thomas Schöpping
################################################################################
2
# AMiRo-OS is an operating system designed for the Autonomous Mini Robot       #
3
# (AMiRo) platform.                                                            #
4
# Copyright (C) 2016..2018  Thomas Schöpping et al.                            #
5
#                                                                              #
6
# This program is free software: you can redistribute it and/or modify         #
7
# it under the terms of the GNU General Public License as published by         #
8
# the Free Software Foundation, either version 3 of the License, or            #
9
# (at your option) any later version.                                          #
10
#                                                                              #
11
# This program is distributed in the hope that it will be useful,              #
12
# but WITHOUT ANY WARRANTY; without even the implied warranty of               #
13
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the                #
14
# GNU General Public License for more details.                                 #
15
#                                                                              #
16
# You should have received a copy of the GNU General Public License            #
17
# along with this program.  If not, see <http://www.gnu.org/licenses/>.        #
18
#                                                                              #
19
# This research/work was supported by the Cluster of Excellence Cognitive      #
20
# Interaction Technology 'CITEC' (EXC 277) at Bielefeld University, which is   #
21
# funded by the German Research Foundation (DFG).                              #
22
################################################################################
23
24
#!/bin/bash
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
################################################################################
267
# SPECIFIC FUNCTIONS                                                           #
268
################################################################################
269
270
### print welcome text #########################################################
271
# Prints a welcome message to standard out.
272
#
273
# usage:      printWelcomeText
274
# arguments:  n/a
275
# return:     n/a
276
#
277
function printWelcomeText {
278
  printf "######################################################################\n"
279
  printf "#                                                                    #\n"
280
  printf "#             Welcome to the AMiRo-LLD submodule setup!              #\n"
281
  printf "#                                                                    #\n"
282
  printf "######################################################################\n"
283
  printf "#                                                                    #\n"
284
  printf "# Copyright (c) 2016..2018  Thomas Schöpping                         #\n"
285
  printf "#                                                                    #\n"
286
  printf "# This is free software; see the source for copying conditions.      #\n"
287
  printf "# There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR  #\n"
288
  printf "# A PARTICULAR PURPOSE. The development of this software was         #\n"
289
  printf "# supported by the Excellence Cluster EXC 227 Cognitive Interaction  #\n"
290
  printf "# Technology. The Excellence Cluster EXC 227 is a grant of the       #\n"
291
  printf "# Deutsche Forschungsgemeinschaft (DFG) in the context of the German #\n"
292
  printf "# Excellence Initiative.                                             #\n"
293
  printf "#                                                                    #\n"
294
  printf "######################################################################\n"
295
}
296
297
### print help #################################################################
298
# Prints a help text to standard out.
299
#
300
# usage:      printHelp
301
# arguments:  n/a
302
# return:     n/a
303
#
304
function printHelp {
305
  printInfo "printing help text\n"
306
  printf "usage:    $(basename ${BASH_SOURCE[0]}) [-h|--help] [-i|--init] [-w|--wipe] [-q|--quit] [--log=<file>]\n"
307
  printf "options:  -h, --help\n"
308
  printf "              Print this help text.\n"
309
  printf "          -i, --init\n"
310
  printf "              Initialize AMiRo-LLD submodule.\n"
311
  printf "          -w, --wipe\n"
312
  printf "              Wipe AMiRo-LLD submodule.\n"
313
  printf "          -q, --quit\n"
314
  printf "              Quit the script.\n"
315
  printf "          --log=<file>\n"
316
  printf "              Specify a log file.\n"
317
}
318
319
### initialize AMiRo-LLD submodule #############################################
320
# Initialize the AMiRo-LLD submodule.
321
#
322
# usage:      initAmiroLld
323
# arguments:  n/a
324
# return:     0
325
#                 No error or warning occurred.
326
#             1
327
#                 Warning: Arborted by user.
328
#             -1
329
#                 Error: Unexpected user input.
330
#
331
function initAmiroLld {
332
  printInfo "initializing AMiRo-LLD submodule...\n"
333
  local userdir=$(pwd)
334
  local peripheryllddir=$(dirname $(realpath ${BASH_SOURCE[0]}))
335
  local amirollddir=${peripheryllddir}/AMiRo-LLD
336
337 1bb524af Thomas Schöpping
  # if the AMiRo-LLD folder is not empty
338 e545e620 Thomas Schöpping
  if [ ! -z "$(ls -A $amirollddir)" ]; then
339
    printWarning "$(realpath $amirollddir) is not empty. Delete and reinitialize? [y/n]\n"
340
    local userinput=""
341
    readUserInput "YyNn" userinput
342
    case $userinput in
343
      Y|y)
344 1bb524af Thomas Schöpping
        wipeAmiroLld
345 e545e620 Thomas Schöpping
        ;;
346
      N|n)
347
        printWarning "AMiRo-LLD initialization aborted by user\n"
348
        return 1
349
        ;;
350
      *) # sanity check (return error)
351
        printError "unexpected input: $userinput\n"; return -1;;
352
    esac
353
  fi
354
355
  # initialize submodule to default branch
356
  cd $peripheryllddir
357
  git submodule update --init $amirollddir 2>&1 | tee -a $LOG_FILE
358
  while [ ${PIPESTATUS[0]} -ne 0 ]; do
359
    printWarning "initialitaion failed. Retry? [y/n]\n"
360
    local userinput=""
361
    readUserInput "YyNn" userinput
362
    case "$userinput" in
363
      Y|y)
364
        git submodule update --init $amirollddir 2>&1 | tee -a $LOG_FILE;;
365
      N|n)
366
        printWarning "AMiRo-LLD initialization aborted by user\n"
367
        cd $userdir
368
        return 1
369
        ;;
370
      *) # sanity check (return error)
371
        printError "unexpected input: $userinput\n"; return -1;;
372
    esac
373
  done
374
  cd $userdir
375
376
  return 0
377
}
378
379
### reset AMiRo-LLD submodule and wipe directory ###############################
380
# Resets the AMiRo-LLD Git submodule and wipes the directory.
381
#
382
# usage:      wipeAmiroLld
383
# arguments:  n/a
384
# return:     n/a
385
function wipeAmiroLld {
386
  printInfo "reset and wipe Git submodule $amirollddir\n"
387
  local userdir=$(pwd)
388
  local peripheryllddir=$(dirname $(realpath ${BASH_SOURCE[0]}))
389
  local amirollddir=${peripheryllddir}/AMiRo-LLD
390
391
  # if the AMiRo-LLD folder is empty
392
  if [ -z "$(ls -A $amirollddir)" ]; then
393
    printWarning "$amirollddir is already empty\n"
394
    return 1
395
  else
396
    # get some information from Git
397
    local userdir=$(pwd)
398
    cd $peripheryllddir
399
    local git_basehash=($(git ls-tree -d HEAD $amirollddir)); git_basehash=${git_basehash[2]}
400
    cd $amirollddir
401
    local git_branch_current=$(git rev-parse --abbrev-ref HEAD)
402
    local git_difftobase="$(git diff ${git_basehash}..HEAD)"
403
    local git_commits=$(git log --format=oneline ${git_basehash}..HEAD)
404
    local git_dirtyfiles=($(git ls-files -dmo --exclude-standard --exclude=/doc))
405
    cd $userdir
406
    local issues=0
407
    # if HEAD is ahead of submodule base commit
408
    if [ -n "$git_difftobase" ]; then
409
      issues=$((issues + 1))
410
      printWarning "HEAD is ahead of submodule base\n"
411
    fi
412
    # if there are untracked, modified, or deleted files
413
    if [ ${#git_dirtyfiles[@]} != 0 ]; then
414
      issues=$((issues + 1))
415
      printWarning "there are ${#git_dirtyfiles[@]} untracked, modified, or deleted files\n"
416
    fi
417
    if [ $issues -gt 0 ]; then
418
      local userinput=""
419
      printWarning "$issues issues detected. Do you want to continue? [y/n]\n"
420
      readUserInput "YyNn" userinput
421
      case "$userinput" in
422
        Y|y)
423
          ;;
424
        N|n)
425
          printfWarning "wiping AMiRo-LLD Git submodule aborted by user\n"
426
          return 2
427
          ;;
428
        *) # sanity check (return error)
429
          printError "unexpected input: $userinput\n"; return -1;;
430
      esac
431
    fi
432
433
    # checkout base commit and delete all local branches
434
    cd $peripheryllddir
435
    git submodule update --force --checkout $amirollddir | tee -a $LOG_FILE
436
    cd $amirollddir
437
    local git_branches=($(git for-each-ref --format="%(refname)"))
438
    for branch in $git_branches; do
439
      if [[ $branch = *"heads/"* ]]; then
440
        git branch -D ${branch##*/} | tee -a $LOG_FILE
441
      fi
442
    done
443
    cd $userdir
444
445
    # deinitialize AMiRo-LLD submodule and delete any remaining files
446
    cd $peripheryllddir
447
    git submodule deinit -f $amirollddir 2>&1 | tee -a $LOG_FILE
448
    rm -rf $amirollddir/*
449
    cd $userdir
450
451
    return 0
452
  fi
453
}
454
455
### main function of this script ###############################################
456
# Initializes or wipes the AMiRo-LLD Git submodule.
457
#
458
# usage:      see function printHelp
459
# arguments:  see function printHelp
460
# return:     0
461
#                 No error or warning occurred.
462
#
463
function main {
464
  # print welcome/info text if not suppressed
465
  if [[ $@ != *"--noinfo"* ]]; then
466
    printWelcomeText
467
  else
468
    printf "######################################################################\n"
469
  fi
470
  printf "\n"
471
472
  # if --help or -h was specified, print the help text and exit
473
  if [[ $@ == *"--help"* || $@ == *"-h"* ]]; then
474
    printHelp
475
    printf "\n"
476
    quitScript
477
  fi
478
479
  # set log file if specified
480
  if [[ $@ == *"--log"* ]] || [[ $@ == *"--LOG"* ]]; then
481
    # get the parameter (file name)
482
    local cmdidx=1
483
    while [[ ! "${!cmdidx}" = "--log"* ]] && [[ ! "${!cmdidx}" = "--LOG"* ]]; do
484
      cmdidx=$[cmdidx + 1]
485
    done
486
    local cmd="${!cmdidx}"
487
    local logfile=""
488
    if [[ "$cmd" = "--log="* ]] || [[ "$cmd" = "--LOG="* ]]; then
489
      logfile=${cmd#*=}
490
    else
491
      local filenameidx=$((cmdidx + 1))
492
      logfile="${!filenameidx}"
493
    fi
494
    # optionally force silent appending
495
    if [[ "$cmd" = "--LOG"* ]]; then
496
      setLogFile --option=c --quiet "$logfile" LOG_FILE
497
    else
498
      setLogFile "$logfile" LOG_FILE
499
      printf "\n"
500
    fi
501
  fi
502
  # log script name
503
  printLog "this is $(realpath ${BASH_SOURCE[0]})\n"
504
505
  # parse arguments
506
  local otherargs=()
507
  while [ $# -gt 0 ]; do
508
    if ( parseIsOption $1 ); then
509
      case "$1" in
510
        -h|--help) # already handled; ignore
511
          shift 1;;
512
        -i|--init)
513
           initAmiroLld; printf "\n"; shift 1;;
514
        -w|--wipe)
515
           wipeAmiroLld; printf "\n"; shift 1;;
516
        -q|--quit)
517
          quitScript; shift 1;;
518
        --log=*|--LOG=*) # already handled; ignore
519
          shift 1;;
520
        --log|--LOG) # already handled; ignore
521
          shift 2;;
522
        --noinfo) # already handled; ignore
523
          shift 1;;
524
        *)
525
          printError "invalid option: $1\n"; shift 1;;
526
      esac
527
    else
528
      otherargs+=("$1")
529
      shift 1
530
    fi
531
  done
532
533
  # interactive menu
534
  while ( true ); do
535
    # main menu info prompt and selection
536
    printInfo "Periphery-LLD setup main menu\n"
537
    printf "Please select one of the following actions:\n"
538
    printf "  [I] - initialize AMiRo-LLD submodule\n"
539
    printf "  [W] - wipe AMiRo-LLD submodule\n"
540
    printf "  [Q] - quit this setup\n"
541
    local userinput=""
542
    readUserInput "IiPpDdWwQq" userinput
543
    printf "\n"
544
545
    # evaluate user selection
546
    case "$userinput" in
547
      I|i)
548
        initAmiroLld; printf "\n";;
549
      W|w)
550
        wipeAmiroLld; printf "\n";;
551
      Q|q)
552
        quitScript;;
553
      *) # sanity check (exit with error)
554
        printError "unexpected argument: $userinput\n";;
555
    esac
556
  done
557
558
  exit 0
559
}
560
561
################################################################################
562
# SCRIPT ENTRY POINT                                                           #
563
################################################################################
564
565
main "$@"