Transcript Bestand: /home/karel/scripts/template Pagina 1 van 5

Bestand: /home/karel/scripts/template
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
Pagina 1 van 5
#!/bin/bash
#############################################################################
# Bestand: template XXX
#
# Doel:
Voorbeeldscript voor een nieuw script. XXX
#
# Gebruik: In het terminalvenster:
#
#
template [OPTIES] [ARGUMENTEN] XXX
#
#
Gebruik optie --usage of --help voor meer informatie.
#
# Gebruikt: script-common.sh (algemene variabelen en functies)
#
# Auteur:
Karel Zimmer (http://karelzimmer.nl, [email protected])
#
# ------------------------------------------------------------------------- #
# Auteursrecht © 2016 Karel Zimmer.
#
#
#
# Dit programma is vrije software: u mag het herdistribueren en/of wijzigen #
# onder de voorwaarden van de GNU Algemene Publieke Licentie zoals
#
# gepubliceerd door de Free Software Foundation, onder versie 3 van de
#
# Licentie of (naar uw keuze) elke latere versie.
#
#
#
# Dit programma is gedistribueerd in de hoop dat het nuttig zal zijn maar
#
# ZONDER ENIGE GARANTIE; zelfs zonder de impliciete garanties die
#
# GEBRUIKELIJK ZIJN IN DE HANDEL of voor BRUIKBAARHEID VOOR EEN SPECIFIEK
#
# DOEL. Zie de GNU Algemene Publieke Licentie voor meer details.
#
#
#
# U hoort een kopie van de GNU Algemene Publieke Licentie te hebben
#
# ontvangen samen met dit programma. Als dat niet het geval is, zie
#
# http://www.gnu.org/licenses/.
#
# ------------------------------------------------------------------------- #
# Versies: 1.0.0
2016-10-19 Eerste versie. XXX
#
#############################################################################
readonly VERSION_NUMBER=1.0.0
readonly RELEASE_DATE=2016-10-19 #XXX
#############################################################################
# Instellingen
#
#############################################################################
#---------------------------------------------------------------------------#
# Algemene instellingen
#
# ------------------------------------------------------------------------- #
# Lees de algemene variabelen en functies in.
#
#---------------------------------------------------------------------------#
source "$(dirname "$0")"/script-common.sh &> /dev/null ||
{
echo 'Het algemeen scriptbestand (script-common.sh) is niet gevonden'
echo "of bevat fouten. Is 'wget karelzimmer.nl/s;. s' uitgevoerd?"
echo 'Zie voor informatie http://karelzimmer.nl en klik op LEESMIJ.'
exit 1
}
#---------------------------------------------------------------------------#
# Globale constanten
#
#---------------------------------------------------------------------------#
# Algemeen ==================================================================
# XXX script-common.sh
*VERWIJDER DEZE REGEL!* XXX
readonly SCRIPT_NEEDS_SUDO=false
# Geen beheerdersrechten nodig
#A XXX of
*VERWIJDER DEZE REGEL!* XXX !zoek #A
#Aadonly SCRIPT_NEEDS_SUDO=true
# Beheerdersrechten nodig
readonly FIRST_COPYRIGHTYEAR=2016
# Eerste auteursrechtjaar
# Specifiek =================================================================
# XXX Op logische volgorde
*VERWIJDER DEZE REGEL!* XXX
readonly -A ASSOCIATIVE=(
[DRIVER]=driver.tar
[PATCH]=driver.patch
)
# Associatief array
readonly -a INDEXED=(
Bestand: /home/karel/scripts/template
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
[1]='driver.tar'
'driver.patch'
)
readonly INDEXES=${#INDEXED[@]}
readonly CONST_B='b'
readonly SLEEP=1s
readonly CONST_A='a'
Pagina 2 van 5
#
#
#
#
#
Normaal array
Aantal normaal array elementen
Constante B (logisch voor CONST_A)
Slaap zolang
Constante A (logisch na CONST_B)
readonly OPT_NEEDS_ARG=false
#B XXX of
#eadonly OPT_NEEDS_ARG=true
readonly OPTS_HELP=$(cat << OPTS_HELP
# Geen optie met een verplicht argum.
*VERWIJDER DEZE REGEL!* XXX
# Optie met een verplicht argument
-t, --test
voorbeeld,
BESTAND
voorbeeld,
argument..."
OPTS_HELP
)
#C XXX Geen extra hulp/gebruiks-opties?
#C XXX Dan "here document" leegmaken!
readonly OPTS_USAGE=$(cat << OPTS_USAGE
geeft nu de fout "Ongeldige optie..."
geeft nu de fout "Ongeldig \
# Extra hulp-opties
*VERWIJDER DEZE REGEL!* XXX
*VERWIJDER DEZE REGEL!* XXX
[-t|--test] [BESTAND]
OPTS_USAGE
)
# Extra gebruiks-opties
#C XXX Geen extra hulp/gebruiks-opties? *VERWIJDER DEZE REGEL!* XXX
#C XXX Dan "here document" leegmaken!
*VERWIJDER DEZE REGEL!* XXX
readonly HELP=$(cat << HELP
$PROGNAME - voorbeeldscript voor een nieuw script
!zoek #C
!zoek #C
!zoek #C
!zoek #C
*WIJZIG DEZE REGEL!*
$OPTS_HELP_SC$OPTS_HELP
Voorbeeldscript...
*WIJZIG DEZE REGEL!*
$ASK_FOR_PW_HELPTEXT
!zoek #A
$PART_OF_INSTALL_HELPTEXT
# Onderdeel van de installatie van Linux? Verwijder deze twee regels!
# Verwijder anders deze twee regels en één erboven in dit script!
HELP
)
# Hulptekst
# Foutcodes =================================================================
# XXX Op volgorde van foutcode
*VERWIJDER DEZE REGEL!* XXX
readonly E_FOUTCODE_1=64
readonly E_FOUTCODE_2=65
readonly E_FOUTCODE_3=66
#---------------------------------------------------------------------------#
# Globale variabelen
#
#---------------------------------------------------------------------------#
# Array, integer ============================================================
# XXX Op alfabetische volgorde
*VERWIJDER DEZE REGEL!* XXX
declare -A ASSOCIATIVE2
# Associatief array
declare -a INDEXED2
# Normaal array
declare -i INDEXED2S=0
# Aantal normaal array elementen
declare -i INTEGER_VAR=0
# Integer variabele
# Boolean ===================================================================
# XXX Op alfabetische volgorde
*VERWIJDER DEZE REGEL!* XXX
declare EOF=false
# End-of-file
declare OPT_FILE=false
# Optie file opgegeven
declare OPT_TEST=false
# Optie test opgegeven
# Overig ====================================================================
Bestand: /home/karel/scripts/template
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
# XXX Op alfabetische volgorde
declare VAR_A='a'
declare VAR_B='b'
declare VAR_C='c'
Pagina 3 van 5
*VERWIJDER DEZE REGEL!* XXX
# Variabele A
# Variabele B
# Variabele C
#############################################################################
# Functies
#
#############################################################################
# XXX Op volgorde van uitvoering
*VERWIJDER DEZE REGEL!* XXX
#-Functie-------------------------------------------------------------------#
# Naam: controleer_invoer
#
# Doel: Initiële controles en/of acties.
#
# Arg.: Geen argumenten.
#
#---------------------------------------------------------------------------#
controleer_invoer() {
log "$PROGNAME:$FUNCNAME:$LINENO"
#XXX
warning "Ik ga zometeen $SLEEP s slapen."
read -p 'Is dit OK? (j/N) '
case $REPLY in
j*|J*)
log 'Gebruiker kiest doorgaan met slapen.'
;;
n*|N*|'')
toon_keuze_stop_sc
;;
*)
toon_keuze_fout_sc
;;
esac
#XXX
return 0
}
#-Functie-------------------------------------------------------------------#
# Naam: toon_invoer
#
# Doel: Toon wat het script gaat doen.
#
# Arg.: Geen argumenten.
#
#---------------------------------------------------------------------------#
toon_invoer() {
log "$PROGNAME:$FUNCNAME:$LINENO"
info "Script: $PROGNAME"
info " Slaap: $SLEEP"
return 0
}
#-Functie-------------------------------------------------------------------#
# Naam: verwerk_invoer
#
# Doel: Slaap de (opgegeven) tijd. XXX
#
# Arg.: Geen argumenten.
#
#---------------------------------------------------------------------------#
verwerk_invoer() {
log "$PROGNAME:$FUNCNAME:$LINENO"
#XXX
slaap "$SLEEP"
#XXX
return 0
}
Bestand: /home/karel/scripts/template
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
Pagina 4 van 5
#-Functie-------------------------------------------------------------------#
# Naam: slaap
XXX
#
# Doel: Wacht het aantal opgegeven seconden. XXX
#
# Arg.: Eén verplicht argument:
XXX
#
#
1. slaaptijd
integer, invoer
XXX
#
# Vb. : slaap "$SLEEP"
XXX
#
#---------------------------------------------------------------------------#
slaap() {
log "$PROGNAME:$FUNCNAME:$LINENO:$@"
#XXX
local sleeptime=${1:-5}
info
info "Sleep $sleeptime..."
spinner aan
sleep
verwerk_rc
"$sleeptime" |& $LOGCMD
"$PROGNAME:$FUNCNAME:$LINENO"
'slaap voor een aantal seconden'
${PIPESTATUS[0]}
\
\
spinner uit
#XXX
return 0
}
#-Functie-------------------------------------------------------------------#
# Naam: toon_afsluiten
#
# Doel: Afsluitende meldingen en/of acties.
#
# Arg.: Geen argumenten.
#
#---------------------------------------------------------------------------#
toon_afsluiten() {
log "$PROGNAME:$FUNCNAME:$LINENO"
#XXX
:
#XXX
return 0
}
#############################################################################
# Hoofdlijn
#
#############################################################################
# init_script
{
controleer_invoer_sc
"$@"
controleer_gebruiker_sc $SCRIPT_NEEDS_SUDO "$@"
controleer_invoer
toon_invoer
}
# verwerk
{
toon_gestart_sc
verwerk_invoer
toon_gestopt_sc
}
# afsl_script
{
toon_afsluiten
toon_afsluiten_sc
exit 0
Bestand: /home/karel/scripts/template
261
262
263
}
# Einde script.
Pagina 5 van 5