Deleted Added
sdiff udiff text old ( 235005 ) new ( 235453 )
full compact
1#!/bin/sh
2#-
3# Copyright (c) 2010 iXsystems, Inc. All rights reserved.
4#
5# Redistribution and use in source and binary forms, with or without
6# modification, are permitted provided that the following conditions
7# are met:
8# 1. Redistributions of source code must retain the above copyright
9# notice, this list of conditions and the following disclaimer.
10# 2. Redistributions in binary form must reproduce the above copyright
11# notice, this list of conditions and the following disclaimer in the
12# documentation and/or other materials provided with the distribution.
13#
14# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24# SUCH DAMAGE.
25#
26# $FreeBSD: head/usr.sbin/pc-sysinstall/backend/functions.sh 235005 2012-05-04 15:31:35Z jpaetzel $
27
28# functions.sh
29# Library of functions which pc-sysinstall may call upon
30
31# Function which displays the help-index file
32display_help()
33{
34 if [ -e "${PROGDIR}/doc/help-index" ]
35 then
36 cat ${PROGDIR}/doc/help-index
37 else
38 echo "Error: ${PROGDIR}/doc/help-index not found"
39 exit 1
40 fi
41};
42
43# Function which displays the help for a specified command
44display_command_help()
45{
46 if [ -z "$1" ]
47 then
48 echo "Error: No command specified to display help for"
49 exit 1
50 fi
51
52 if [ -e "${PROGDIR}/doc/help-${1}" ]
53 then
54 cat ${PROGDIR}/doc/help-${1}
55 else
56 echo "Error: ${PROGDIR}/doc/help-${1} not found"
57 exit 1
58 fi
59};
60
61# Function to convert bytes to megabytes
62convert_byte_to_megabyte()
63{
64 if [ -z "${1}" ]
65 then
66 echo "Error: No bytes specified!"
67 exit 1
68 fi
69
70 expr -e ${1} / 1048576
71};
72
73# Function to convert blocks to megabytes
74convert_blocks_to_megabyte()
75{
76 if [ -z "${1}" ] ; then
77 echo "Error: No blocks specified!"
78 exit 1
79 fi
80
81 expr -e ${1} / 2048
82};
83
84# Takes $1 and strips the whitespace out of it, returns VAL
85strip_white_space()
86{
87 if [ -z "${1}" ]
88 then
89 echo "Error: No value setup to strip whitespace from!"
90
91 exit 1
92 fi
93
94 export VAL=`echo "$1" | tr -d ' '`
95};
96
97# Displays an error message and exits with error 1
98exit_err()
99{
100 # Echo the message for the users benefit
101 echo "EXITERROR: $1"
102
103 # Save this error to the log file
104 echo "EXITERROR: ${1}" >>$LOGOUT
105
106 # Check if we need to unmount any file-systems after this failure
107 unmount_all_filesystems_failure
108
109 echo "For more details see log file: $LOGOUT"
110
111 exit 1
112};
113
114# Run-command, don't halt if command exits with non-0
115rc_nohalt()
116{
117 CMD="$1"
118
119 if [ -z "${CMD}" ]
120 then
121 exit_err "Error: missing argument in rc_nohalt()"
122 fi
123
124 echo "Running: ${CMD}" >>${LOGOUT}
125 ${CMD} >>${LOGOUT} 2>>${LOGOUT}
126
127};
128
129# Run-command, halt if command exits with non-0
130rc_halt()
131{
132 CMD="$1"
133
134 if [ -z "${CMD}" ]
135 then
136 exit_err "Error: missing argument in rc_halt()"
137 fi
138
139 echo "Running: ${CMD}" >>${LOGOUT}
140 eval ${CMD} >>${LOGOUT} 2>>${LOGOUT}
141 STATUS="$?"
142 if [ "${STATUS}" != "0" ]
143 then
144 exit_err "Error ${STATUS}: ${CMD}"
145 fi
146};
147
148# Run-command w/echo to screen, halt if command exits with non-0
149rc_halt_echo()
150{
151 CMD="$1"
152
153 if [ -z "${CMD}" ]
154 then
155 exit_err "Error: missing argument in rc_halt_echo()"
156 fi
157
158 echo "Running: ${CMD}" >>${LOGOUT}
159 ${CMD} 2>&1 | tee -a ${LOGOUT}
160 STATUS="$?"
161 if [ "$STATUS" != "0" ]
162 then
163 exit_err "Error ${STATUS}: $CMD"
164 fi
165
166};
167
168# Run-command w/echo, don't halt if command exits with non-0
169rc_nohalt_echo()
170{
171 CMD="$1"
172
173 if [ -z "${CMD}" ]
174 then
175 exit_err "Error: missing argument in rc_nohalt_echo()"
176 fi
177
178 echo "Running: ${CMD}" >>${LOGOUT}
179 ${CMD} 2>&1 | tee -a ${LOGOUT}
180
181};
182
183# Echo to the screen and to the log
184echo_log()
185{
186 STR="$1"
187
188 if [ -z "${STR}" ]
189 then
190 exit_err "Error: missing argument in echo_log()"
191 fi
192
193 echo "${STR}" | tee -a ${LOGOUT}
194};
195
196# Make sure we have a numeric
197is_num()
198{
199 expr $1 + 1 2>/dev/null
200 return $?
201}
202
203# Function which uses "fetch" to download a file, and display a progress report
204fetch_file()
205{
206
207 FETCHFILE="$1"
208 FETCHOUTFILE="$2"
209 EXITFAILED="$3"
210
211 SIZEFILE="${TMPDIR}/.fetchSize"
212 EXITFILE="${TMPDIR}/.fetchExit"
213
214 rm ${SIZEFILE} 2>/dev/null >/dev/null
215 rm ${FETCHOUTFILE} 2>/dev/null >/dev/null
216
217 fetch -s "${FETCHFILE}" >${SIZEFILE}
218 SIZE="`cat ${SIZEFILE}`"
219 SIZE=$((SIZE/1024))
220 echo "FETCH: ${FETCHFILE}"
221 echo "FETCH: ${FETCHOUTFILE}" >>${LOGOUT}
222
223 ( fetch -o ${FETCHOUTFILE} "${FETCHFILE}" >/dev/null 2>/dev/null ; echo "$?" > ${EXITFILE} ) &
224 PID="$!"
225 while
226 z=1
227 do
228
229 if [ -e "${FETCHOUTFILE}" ]
230 then
231 DSIZE=`du -k ${FETCHOUTFILE} | tr -d '\t' | cut -d '/' -f 1`
232 if [ $(is_num "$DSIZE") ] ; then
233 if [ $SIZE -lt $DSIZE ] ; then DSIZE="$SIZE"; fi
234 echo "SIZE: ${SIZE} DOWNLOADED: ${DSIZE}"
235 echo "SIZE: ${SIZE} DOWNLOADED: ${DSIZE}" >>${LOGOUT}
236 fi
237 fi
238
239 # Check if the download is finished
240 ps -p ${PID} >/dev/null 2>/dev/null
241 if [ $? -ne 0 ]
242 then
243 break;
244 fi
245
246 sleep 2
247 done
248
249 echo "FETCHDONE"
250
251 EXIT="`cat ${EXITFILE}`"
252 if [ "${EXIT}" != "0" -a "$EXITFAILED" = "1" ]
253 then
254 exit_err "Error: Failed to download ${FETCHFILE}"
255 fi
256
257 return $EXIT
258
259};
260
261# Function to return a the zpool name for this device
262get_zpool_name()
263{
264 DEVICE="$1"
265
266 # Set the base name we use for zpools
267 BASENAME="tank"
268
269 if [ ! -d "${TMPDIR}/.zpools" ] ; then
270 mkdir -p ${TMPDIR}/.zpools
271 fi
272
273 if [ -e "${TMPDIR}/.zpools/${DEVICE}" ] ; then
274 cat ${TMPDIR}/.zpools/${DEVICE}
275 return 0
276 else
277 # Need to generate a zpool name for this device
278 NUM=`ls ${TMPDIR}/.zpools/ | wc -l | sed 's| ||g'`
279
280 # Is it used in another zpool?
281 while
282 z=1
283 do
284 NEWNAME="${BASENAME}${NUM}"
285 zpool import | grep -q "${NEWNAME}"
286 if [ $? -ne 0 ] ; then break ; fi
287 NUM=$((NUM+1))
288 done
289
290 # Now save the new tank name
291 mkdir -p ${TMPDIR}/.zpools/`dirname $DEVICE`
292 echo "$NEWNAME" >${TMPDIR}/.zpools/${DEVICE}
293 echo "${NEWNAME}"
294 return 0
295 fi
296};
297
298iscompressed()
299{
300 local FILE
301 local RES
302
303 FILE="$1"
304 RES=1
305
306 if echo "${FILE}" | \
307 grep -qiE '\.(Z|lzo|lzw|lzma|gz|bz2|xz|zip)$' 2>&1
308 then
309 RES=0
310 fi
311
312 return ${RES}
313}
314
315get_compression_type()
316{
317 local FILE
318 local SUFFIX
319
320 FILE="$1"
321 SUFFIX=`echo "${FILE}" | sed -E 's|^(.+)\.(.+)$|\2|'`
322
323 VAL=""
324 SUFFIX=`echo "${SUFFIX}" | tr A-Z a-z`
325 case "${SUFFIX}" in
326 z) VAL="lzw" ;;
327 lzo) VAL="lzo" ;;
328 lzw) VAL="lzw" ;;
329 lzma) VAL="lzma" ;;
330 gz) VAL="gzip" ;;
331 bz2) VAL="bzip2" ;;
332 xz) VAL="xz" ;;
333 zip) VAL="zip" ;;
334 esac
335
336 export VAL
337}
338
339write_image()
340{
341 local DEVICE_FILE
342
343 IMAGE_FILE="$1"
344 DEVICE_FILE="$2"
345
346 if [ -z "${IMAGE_FILE}" ]
347 then
348 exit_err "ERROR: Image file not specified!"
349 fi
350
351 if [ -z "${DEVICE_FILE}" ]
352 then
353 exit_err "ERROR: Device file not specified!"
354 fi
355
356 if [ ! -f "${IMAGE_FILE}" ]
357 then
358 exit_err "ERROR: '${IMAGE_FILE}' does not exist!"
359 fi
360
361 DEVICE_FILE="${DEVICE_FILE#/dev/}"
362 DEVICE_FILE="/dev/${DEVICE_FILE}"
363
364 if [ ! -c "${DEVICE_FILE}" ]
365 then
366 exit_err "ERROR: '${DEVICE_FILE}' is not a character device!"
367 fi
368
369 if iscompressed "${IMAGE_FILE}"
370 then
371 local COMPRESSION
372
373 get_compression_type "${IMAGE_FILE}"
374 COMPRESSION="${VAL}"
375
376 case "${COMPRESSION}" in
377 lzw)
378 rc_halt "uncompress ${IMAGE_FILE} -c | dd of=${DEVICE_FILE}"
379 IMAGE_FILE="${IMAGE_FILE%.Z}"
380 ;;
381
382 lzo)
383 rc_halt "lzop -d $IMAGE_{FILE} -c | dd of=${DEVICE_FILE}"
384 IMAGE_FILE="${IMAGE_FILE%.lzo}"
385 ;;
386
387 lzma)
388 rc_halt "lzma -d ${IMAGE_FILE} -c | dd of=${DEVICE_FILE}"
389 IMAGE_FILE="${IMAGE_FILE%.lzma}"
390 ;;
391
392 gzip)
393 rc_halt "gunzip ${IMAGE_FILE} -c | dd of=${DEVICE_FILE}"
394 IMAGE_FILE="${IMAGE_FILE%.gz}"
395 ;;
396
397 bzip2)
398 rc_halt "bunzip2 ${IMAGE_FILE} -c | dd of=${DEVICE_FILE}"
399 IMAGE_FILE="${IMAGE_FILE%.bz2}"
400 ;;
401
402 xz)
403 rc_halt "xz -d ${IMAGE_FILE} -c | dd of=${DEVICE_FILE}"
404 IMAGE_FILE="${IMAGE_FILE%.xz}"
405 ;;
406
407 zip)
408 rc_halt "unzip ${IMAGE_FILE} -c | dd of=${DEVICE_FILE}"
409 IMAGE_FILE="${IMAGE_FILE%.zip}"
410 ;;
411
412 *)
413 exit_err "ERROR: ${COMPRESSION} compression is not supported"
414 ;;
415 esac
416
417 else
418 rc_halt "dd if=${IMAGE_FILE} of=${DEVICE_FILE}"
419
420 fi
421};
422
423# Setup and install on a new disk / partition
424install_fresh()
425{
426 # Lets start setting up the disk slices now
427 setup_disk_slice
428
429 if [ -z "${ROOTIMAGE}" ]
430 then
431
432 # Disk setup complete, now lets parse WORKINGSLICES and setup the bsdlabels
433 setup_disk_label
434
435 # Now we've setup the bsdlabels, lets go ahead and run newfs / zfs
436 # to setup the filesystems
437 setup_filesystems
438
439 # Lets mount the partitions now
440 mount_all_filesystems
441
442 # We are ready to begin extraction, lets start now
443 init_extraction
444
445 # Check if we have any optional modules to load
446 install_components
447
448 # Check if we have any packages to install
449 install_packages
450
451 # Do any localization in configuration
452 run_localize
453
454 # Save any networking config on the installed system
455 save_networking_install
456
457 # Now add any users
458 setup_users
459
460 # Do any last cleanup / setup before unmounting
461 run_final_cleanup
462
463 # Now run any commands specified
464 run_commands
465
466 # Unmount and finish up
467 unmount_all_filesystems
468 fi
469
470 echo_log "Installation finished!"
471};
472
473# Extract the system to a pre-mounted directory
474install_extractonly()
475{
476 # We are ready to begin extraction, lets start now
477 init_extraction
478
479 # Check if we have any optional modules to load
480 install_components
481
482 # Check if we have any packages to install
483 install_packages
484
485 # Do any localization in configuration
486 run_localize
487
488 # Save any networking config on the installed system
489 save_networking_install
490
491 # Now add any users
492 setup_users
493
494 # Now run any commands specified
495 run_commands
496
497 # Set a hostname on the install system
498 setup_hostname
499
500 # Set the root_pw if it is specified
501 set_root_pw
502
503 echo_log "Installation finished!"
504};
505
506install_image()
507{
508 # We are ready to begin extraction, lets start now
509 init_extraction
510
511 echo_log "Installation finished!"
512};
513
514install_upgrade()
515{
516 # We're going to do an upgrade, skip all the disk setup
517 # and start by mounting the target drive/slices
518 mount_upgrade
519
520 # Start the extraction process
521 init_extraction
522
523 # Do any localization in configuration
524 run_localize
525
526 # Now run any commands specified
527 run_commands
528
529 # Merge any old configuration files
530 merge_old_configs
531
532 # Check if we have any optional modules to load
533 install_components
534
535 # Check if we have any packages to install
536 install_packages
537
538 # All finished, unmount the file-systems
539 unmount_upgrade
540
541 echo_log "Upgrade finished!"
542};