mkarchiso 18.3 KB
Newer Older
1
#!/bin/bash
2

3
4
set -e -u

5
6
export LANG=C

7
8
9
app_name=${0##*/}
arch=$(uname -m)
pkg_list=""
10
run_cmd=""
11
12
13
14
15
16
quiet="y"
pacman_conf="/etc/pacman.conf"
export iso_label="ARCH_$(date +%Y%m)"
iso_publisher="Arch Linux <http://www.archlinux.org>"
iso_application="Arch Linux Live/Rescue CD"
install_dir="arch"
17
18
work_dir="work"
out_dir="out"
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

# Show an INFO message
# $1: message string
_msg_info() {
    local _msg="${1}"
    echo "[mkarchiso] INFO: ${_msg}"
}

# Show an ERROR message then exit with status
# $1: message string
# $2: exit code number (with 0 does not exit)
_msg_error() {
    local _msg="${1}"
    local _error=${2}
    echo
    echo "[mkarchiso] ERROR: ${_msg}"
    echo
    if [[ ${_error} -gt 0 ]]; then
        exit ${_error}
    fi
}

# Show space usage similar to df, but better formatted.
# $1: mount-point or mounted device.
_show_space_usage () {
    local _where="${1}"
    local _fs _total _used _avail _pct_u=0 _mnt
    read _fs _total _used _avail _pct_u _mnt < <(df -m "${_where}" | tail -1) &> /dev/null
    _msg_info "Total: ${_total} MiB (100%) | Used: ${_used} MiB (${_pct_u}) | Avail: ${_avail} MiB ($((100 - ${_pct_u%\%}))%)"
}

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
_chroot_mount () {
    mount -t devtmpfs dev "${work_dir}/root-image/dev"
    mount -t devpts devpts "${work_dir}/root-image/dev/pts"
    mount -t tmpfs devshm "${work_dir}/root-image/dev/shm"
    mount -t proc proc "${work_dir}/root-image/proc"
    mount -t tmpfs run "${work_dir}/root-image/run"
    mount -t sysfs sys "${work_dir}/root-image/sys"
    mount -t tmpfs tmp "${work_dir}/root-image/tmp"

    trap '_chroot_umount' EXIT HUP INT TERM
}

_chroot_umount () {
    umount "${work_dir}/root-image/tmp"
    umount "${work_dir}/root-image/sys"
    umount "${work_dir}/root-image/run"
    umount "${work_dir}/root-image/proc"
    umount "${work_dir}/root-image/dev/shm"
    umount "${work_dir}/root-image/dev/pts"
    umount "${work_dir}/root-image/dev"

    trap - EXIT HUP INT TERM
}

_chroot_init() {
    if [[ ! -d ${work_dir}/root-image/var/cache/pacman ]]; then
        mkdir -p ${work_dir}/root-image/{dev,proc,run,sys,tmp,var/lib/pacman}
        _pacman "base"
        _pacman "syslinux"
    fi
}

_chroot_run() {
    _chroot_mount
    eval chroot ${work_dir}/root-image "${run_cmd}"
    _chroot_umount
}

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
# Mount a filesystem (trap signals in case of error for unmounting it
# $1: source image
# $2: mount-point
_mount_fs() {
    local _src="${1}"
    local _dst="${2}"
    trap "_umount_fs ${_src}" EXIT HUP INT TERM
    mkdir -p "${_dst}"
    _msg_info "Mounting '${_src}' on '${_dst}'"
    mount "${_src}" "${_dst}"
    _show_space_usage "${_dst}"
}

# Unmount a filesystem (and untrap signals)
# $1: mount-point or device/image
_umount_fs() {
    local _dst="${1}"
    _show_space_usage "${_dst}"
    _msg_info "Unmounting '${_dst}'"
    umount "${_dst}"
    rmdir "${_dst}"
    trap - EXIT HUP INT TERM
}

# Compare if a file/directory (source) is newer than other file (target)
# $1: source file/directory
# $2: target file
# return: 0 if target does not exists or if target is older than source.
#         1 if target is newer than source
_is_directory_changed() {
    local _src="${1}"
    local _dst="${2}"

    if [ -e "${_dst}" ]; then
        if [[ $(find ${_src} -newer ${_dst} | wc -l) -gt 0 ]]; then
            _msg_info "Target '${_dst}' is older than '${_src}', updating."
            rm -f "${_dst}"
            return 0
        else
            _msg_info "Target '${_dst}' is up to date with '${_src}', skipping."
            return 1
        fi
    else
        _msg_info "Target '${_dst}' does not exist, making it from '${_src}'"
        return 0
    fi
}

# Show help usage, with an exit status.
# $1: exit status number.
_usage ()
139
{
140
    echo "usage ${app_name} [options] command <command options>"
141
    echo " general options:"
142
    echo "    -p PACKAGE(S)    Package(s) to install, can be used multiple times"
143
    echo "    -r <command>     Run <command> inside root-image"
144
145
    echo "    -C <file>        Config file for pacman."
    echo "                     Default: '${pacman_conf}'"
146
    echo "    -L <label>       Set a label for the disk"
147
    echo "                     Default: '${iso_label}'"
148
    echo "    -P <publisher>   Set a publisher for the disk"
149
    echo "                     Default: '${iso_publisher}'"
150
    echo "    -A <application> Set an application name for the disk"
151
    echo "                     Default: '${iso_application}'"
152
    echo "    -D <install_dir> Set an install_dir. All files will by located here."
153
    echo "                     Default: '${install_dir}'"
154
    echo "                     NOTE: Max 8 characters, use only [a-z0-9]"
155
    echo "    -w <work_dir>    Set the working directory"
156
    echo "                     Default: '${work_dir}'"
157
    echo "    -o <out_dir>     Set the output directory"
158
    echo "                     Default: '${out_dir}'"
159
160
    echo "    -v               Enable verbose output"
    echo "    -h               This message"
161
    echo " commands:"
162
163
164
165
166
167
    echo "   init"
    echo "      Make base layout and install base group"
    echo "   install"
    echo "      Install all specified packages (-p)"
    echo "   run"
    echo "      run command specified by -r"
168
    echo "   prepare"
169
    echo "      build all images"
170
    echo "   checksum"
171
    echo "      make a checksum.md5 for self-test"
172
173
    echo "   pkglist"
    echo "      make a pkglist.txt of packages installed on root-image"
174
    echo "   iso <image name>"
175
    echo "      build an iso image from the working dir"
176
    exit ${1}
177
178
}

179
# Shows configuration according to command mode.
180
# $1: init | install | run | prepare | checksum | iso
181
182
183
184
185
186
187
188
189
_show_config () {
    local _mode="$1"
    echo
    _msg_info "Configuration settings"
    _msg_info "                  Command:   ${command_name}"
    _msg_info "             Architecture:   ${arch}"
    _msg_info "        Working directory:   ${work_dir}"
    _msg_info "   Installation directory:   ${install_dir}"
    case "${_mode}" in
190
191
192
193
        init)
            _msg_info "       Pacman config file:   ${pacman_conf}"
            ;;
        install)
194
195
196
            _msg_info "       Pacman config file:   ${pacman_conf}"
            _msg_info "                 Packages:   ${pkg_list}"
            ;;
197
198
199
        run)
            _msg_info "              Run command:   ${run_cmd}"
            ;;
200
201
        prepare)
            ;;
202
203
        checksum)
            ;;
204
205
        pkglist)
            ;;
206
207
208
209
210
211
        iso)
            _msg_info "               Image name:   ${img_name}"
            _msg_info "               Disk label:   ${iso_label}"
            _msg_info "           Disk publisher:   ${iso_publisher}"
            _msg_info "         Disk application:   ${iso_application}"
            ;;
212
    esac
213
214
    echo
}
215

216
# Install desired packages to root-image
217
218
_pacman ()
{
219
    _msg_info "Installing packages to '${work_dir}/root-image/'..."
220

221
222
    _chroot_mount

223
    if [[ "${quiet}" = "y" ]]; then
224
        pacman -Sy -r "${work_dir}/root-image" --config "${pacman_conf}" --needed --noconfirm $* &> /dev/null
225
    else
226
        pacman -Sy -r "${work_dir}/root-image" --config "${pacman_conf}" --needed --noconfirm $*
227
    fi
228

229
230
    _chroot_umount

231
    _msg_info "Packages installed successfully!"
232
233
}

234
235
236
# Cleanup root-image
_cleanup () {
    _msg_info "Cleaning up what we can on root-image"
237

238
239
240
241
242
243
    # remove the initcpio images that were generated for the host system
    if [[ -d "${work_dir}/root-image/boot" ]]; then 
        find "${work_dir}/root-image/boot" -name '*.img' -delete
    fi
    # Delete pacman database sync cache files (*.tar.gz)
    if [[ -d "${work_dir}/root-image/var/lib/pacman" ]]; then
244
        find "${work_dir}/root-image/var/lib/pacman" -maxdepth 1 -type f -delete
245
246
247
    fi
    # Delete pacman database sync cache
    if [[ -d "${work_dir}/root-image/var/lib/pacman/sync" ]]; then
248
        find "${work_dir}/root-image/var/lib/pacman/sync" -delete
249
250
251
    fi
    # Delete pacman package cache
    if [[ -d "${work_dir}/root-image/var/cache/pacman/pkg" ]]; then
252
        find "${work_dir}/root-image/var/cache/pacman/pkg" -type f -delete
253
254
255
    fi
    # Delete all log files, keeps empty dirs.
    if [[ -d "${work_dir}/root-image/var/log" ]]; then
256
        find "${work_dir}/root-image/var/log" -type f -delete
257
258
259
    fi
    # Delete all temporary files and dirs
    if [[ -d "${work_dir}/root-image/var/tmp" ]]; then
260
        find "${work_dir}/root-image/var/tmp" -mindepth 1 -delete
261
262
263
    fi
    # Delete all temporary files and dirs
    if [[ -d "${work_dir}/root-image/tmp" ]]; then
264
        find "${work_dir}/root-image/tmp" -mindepth 1 -delete
265
    fi
266
267
    # Delete package pacman related files.
    find "${work_dir}" -name "*.pacnew" -name "*.pacsave" -name "*.pacorig" -delete
268
    # Create etc/mtab if not is a symlink.
269
    if [[ ! -L "${work_dir}/root-image/etc/mtab" ]]; then
270
        ln -sf "/proc/self/mounts" "${work_dir}/root-image/etc/mtab"
271
    fi
272
}
273

274
275
276
277
278
279
# Makes a SquashFS filesystem image of file/directory passes as argument with desired compression.
# $1: Source file/directory
# $2: SquashFS compression type (gzip | lzo | xz)
_mksfs () {
    local _src="${1}"
    local _sfs_comp="${2}"
280

281
282
    if [[ ! -e "${work_dir}/${_src}" ]]; then
        _msg_error "The path '${work_dir}/${_src}' does not exist" 1
283
284
    fi

285
286
287
288
289
    local _sfs_img="${work_dir}/${_src}.sfs"

    _msg_info "Creating SquashFS image for '${work_dir}/${_src}', This may take some time..."
    local _seconds=${SECONDS}
    if [[ "${quiet}" = "y" ]]; then
290
        mksquashfs "${work_dir}/${_src}" "${_sfs_img}" -noappend -comp "${_sfs_comp}" -no-progress &> /dev/null
291
    else
292
        mksquashfs "${work_dir}/${_src}" "${_sfs_img}" -noappend -comp "${_sfs_comp}" -no-progress
293
    fi
294
295
    _seconds=$((SECONDS - _seconds))
    printf "[mkarchiso] INFO: Image creation done in %02d:%02d minutes\n" $((_seconds / 60)) $((_seconds % 60))
296
}
297

298
299
300
301
302
303
304
305
# Makes a filesystem from a source directory.
# $1: Source directory
# $2: Target filesystem type (ext4 | ext3 | ext2 | xfs)
# $3: Size of target filesystem. Can be an absolute value in MiB, or relative value of desired free space (1% - 99%)
_mkfs () {
    local _src="${1}"
    local _fs_type="${2}"
    local _fs_size="${3}"
306

307
308
    local _fs_src="${work_dir}/${_src}"
    local _fs_img="${work_dir}/${_src}.fs"
309

310
311
    if [[ ! -e "${_fs_src}" ]]; then
        _msg_error "The path '${_fs_src}' does not exist" 1
312
313
    fi

314
315
    local _spc_used
    _spc_used=$(du -sxm "${_fs_src}" | awk '{print $1}')
316

317
318
319
320
321
322
323
324
325
326
    # Caculate FS size with desired % of free space, adds 10% overhead to used space.
    if [[ ${_fs_size} != ${_fs_size%\%} ]]; then
        if [[ ${_fs_size%\%} -le 0 || ${_fs_size%\%} -ge 100 ]]; then
            _msg_error "Invalid percentage of free space specified '${_fs_size}' on '${_src}', should be 0% < x < 100%" 1
        fi
        _fs_size=$((_spc_used * 110 / (100 - ${_fs_size%\%})))
    else
        local _spc_used_over=$((_spc_used * 11 / 10))
        if [[ ${_fs_size} -lt ${_spc_used_over} ]]; then
            _msg_error "Filesystem size specified '${_fs_size}' MiB for '${_src}' is too small, must be at least '${_spc_used_over}' MiB" 1
327
328
329
        fi
    fi

330
    _msg_info "Creating ${_fs_type} image of ${_fs_size} MiB"
331
    rm -f "${_fs_img}"
332
333
334
335
    dd of="${_fs_img}" count=0 bs=1M seek=${_fs_size} &> /dev/null
    local _qflag=""
    if [[ ${quiet} == "y" ]]; then
        _qflag="-q"
336
    fi
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
    case "${_fs_type}" in
        ext4)
            mkfs.ext4 ${_qflag} -O ^has_journal -m 0 -F "${_fs_img}"
            tune2fs -c 0 -i 0 "${_fs_img}" &> /dev/null
            ;;
        ext3)
            mkfs.ext3 ${_qflag} -m 0 -F "${_fs_img}"
            tune2fs -c 0 -i 0 "${_fs_img}" &> /dev/null
            ;;
        ext2)
            mkfs.ext2 ${_qflag} -m 0 -F "${_fs_img}"
            tune2fs -c 0 -i 0 "${_fs_img}" &> /dev/null
            ;;
        xfs)
            mkfs.xfs ${_qflag} "${_fs_img}"
            ;;
        *)
            _msg_error "Invalid filesystem: ${_fs_type}" 1
            ;;
    esac
    _mount_fs "${_fs_img}" "${work_dir}/mnt/${_src}"
    _msg_info "Copying '${_fs_src}/' to '${work_dir}/mnt/${_src}/'"
    rsync -aH "${_fs_src}/" "${work_dir}/mnt/${_src}/"
    _umount_fs "${work_dir}/mnt/${_src}"
361
362
}

363
364
365
command_checksum () {
    _show_config checksum

366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
    local _chk_arch

    for _chk_arch in i686 x86_64; do
        if _is_directory_changed "${work_dir}/iso/${install_dir}" "${work_dir}/iso/${install_dir}/checksum.${_chk_arch}.md5"; then
            _msg_info "Creating checksum file for self-test (${_chk_arch})"
            cd "${work_dir}/iso/${install_dir}"
            if [[ -d "${_chk_arch}" ]]; then
                md5sum aitab > checksum.${_chk_arch}.md5
                find ${_chk_arch} -type f -print0 | xargs -0 md5sum >> checksum.${_chk_arch}.md5
                if [[ -d "any" ]]; then
                    find any -type f -print0 | xargs -0 md5sum >> checksum.${_chk_arch}.md5
                fi
            fi
            cd ${OLDPWD}
            _msg_info "Done!"
        fi
    done
383
384
}

385
386
387
388
389
390
391
392
393
394
395
396
397
command_pkglist () {
    _show_config pkglist

    if _is_directory_changed "${work_dir}/root-image/var/lib/pacman/local" "${work_dir}/iso/${install_dir}/pkglist.${arch}.txt"; then
        _msg_info "Creating a list of installed packages on live-enviroment"
        pacman -Sl -r "${work_dir}/root-image" --config "${pacman_conf}" | \
            awk '/\[installed\]$/ {print $1 "/" $2 "-" $3}' > \
            "${work_dir}/iso/${install_dir}/pkglist.${arch}.txt"
        _msg_info "Done!"
    fi

}

398
# Create an ISO9660 filesystem from "iso" directory.
399
command_iso () {
400
401
    local _iso_efi_boot_args=""

402
403
404
    if [[ ! -f "${work_dir}/iso/isolinux/isolinux.bin" ]]; then
         _msg_error "The file '${work_dir}/iso/isolinux/isolinux.bin' does not exist." 1
    fi
405
406
407
    if [[ ! -f "${work_dir}/iso/isolinux/isohdpfx.bin" ]]; then
         _msg_error "The file '${work_dir}/iso/isolinux/isohdpfx.bin' does not exist." 1
    fi
408

409
410
411
412
413
    # If exists, add an EFI "El Torito" boot image (FAT filesystem) to ISO-9660 image.
    if [[ -f "${work_dir}/iso/EFI/archiso/efiboot.img" ]]; then
        _iso_efi_boot_args="--efi-boot EFI/archiso/efiboot.img"
    fi

414
415
    _show_config iso

416
417
    if _is_directory_changed "${work_dir}/iso" "${out_dir}/${img_name}"; then
        mkdir -p ${out_dir}
418
419
420
421
422
        _msg_info "Creating ISO image..."
        local _qflag=""
        if [[ ${quiet} == "y" ]]; then
            _qflag="-quiet"
        fi
423
        xorriso -as mkisofs ${_qflag} \
424
            -iso-level 3 \
425
426
427
428
429
430
431
            -full-iso9660-filenames \
            -volid "${iso_label}" \
            -appid "${iso_application}" \
            -publisher "${iso_publisher}" \
            -preparer "prepared by mkarchiso" \
            -eltorito-boot isolinux/isolinux.bin \
            -eltorito-catalog isolinux/boot.cat \
432
            -no-emul-boot -boot-load-size 4 -boot-info-table \
433
            ${_iso_efi_boot_args} \
434
            -isohybrid-mbr ${work_dir}/iso/isolinux/isohdpfx.bin \
435
436
            -output "${out_dir}/${img_name}" \
            "${work_dir}/iso/"
437
        _msg_info "Done! | $(ls -sh ${out_dir}/${img_name})"
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
    fi
}

# Parse aitab and create each filesystem specified on that, and push it in "iso" directory.
command_prepare () {
    if [[ ! -f "${work_dir}/iso/${install_dir}/aitab" ]]; then
         _msg_error "The file '${work_dir}/iso/${install_dir}/aitab' does not exist." 1
    fi
    _show_config prepare

    _cleanup
    local _aitab_img _aitab_mnt _aitab_arch _aitab_sfs_comp _aitab_fs_type _aitab_fs_size
    while read _aitab_img _aitab_mnt _aitab_arch _aitab_sfs_comp _aitab_fs_type _aitab_fs_size ; do
        if [[ ${_aitab_img} =~ ^# ]]; then
            continue
        fi
        local _src="${work_dir}/${_aitab_img}"
        local _dst="${work_dir}/iso/${install_dir}/${_aitab_arch}"
        mkdir -p "${_dst}"
        if [[ ${_aitab_fs_type} != "none" ]]; then
458
459
460
461
462
            if _is_directory_changed "${_src}" "${_dst}/${_aitab_img}.fs.sfs"; then
                _mkfs ${_aitab_img} ${_aitab_fs_type} ${_aitab_fs_size}
                _mksfs ${_aitab_img}.fs ${_aitab_sfs_comp}
                mv "${_src}.fs.sfs" "${_dst}"
                rm "${_src}.fs"
463
464
465
466
467
468
469
470
471
472
473
474
            fi
        else
            if _is_directory_changed "${_src}" "${_dst}/${_aitab_img}.sfs"; then
                _mksfs ${_aitab_img} ${_aitab_sfs_comp}
                mv "${work_dir}/${_aitab_img}.sfs" "${_dst}"
            fi
        fi
    done < "${work_dir}/iso/${install_dir}/aitab"
}

# Install packages on root-image.
# A basic check to avoid double execution/reinstallation is done via hashing package names.
475
command_install () {
476
477
478
479
480
481
482
483
484
485
486
487
    if [[ ! -f "${pacman_conf}" ]]; then
        _msg_error "Pacman config file '${pacman_conf}' does not exist" 1
    fi

    #trim spaces
    pkg_list="$(echo ${pkg_list})"

    if [[ -z ${pkg_list} ]]; then
        _msg_error "Packages must be specified" 0
        _usage 1
    fi

488
    _show_config install
489
490
491

    local _pkg_list_hash
    _pkg_list_hash=$(echo ${pkg_list} | sort -u | md5sum | cut -c1-32)
492
    if [[ -f "${work_dir}/install.${_pkg_list_hash}" ]]; then
493
494
495
        _msg_info "These packages are already installed, skipping."
    else
        _pacman "${pkg_list}"
496
        : > "${work_dir}/install.${_pkg_list_hash}"
497
    fi
498
499
}

500
501
502
503
504
505
506
507
508
command_init() {
    _show_config init
    _chroot_init
}

command_run() {
    _show_config run
    _chroot_run
}
509
510
511
512
513

if [[ ${EUID} -ne 0 ]]; then
    _msg_error "This script must be run as root." 1
fi

514
while getopts 'p:r:C:L:P:A:D:w:o:vh' arg; do
515
516
    case "${arg}" in
        p) pkg_list="${pkg_list} ${OPTARG}" ;;
517
        r) run_cmd="${OPTARG}" ;;
518
519
520
521
522
        C) pacman_conf="${OPTARG}" ;;
        L) iso_label="${OPTARG}" ;;
        P) iso_publisher="${OPTARG}" ;;
        A) iso_application="${OPTARG}" ;;
        D) install_dir="${OPTARG}" ;;
523
524
        w) work_dir="${OPTARG}" ;;
        o) out_dir="${OPTARG}" ;;
525
526
527
528
529
530
531
532
533
534
535
536
537
538
        v) quiet="n" ;;
        h|?) _usage 0 ;;
        *)
            _msg_error "Invalid argument '${arg}'" 0
            _usage 1
            ;;
    esac
done

shift $((OPTIND - 1))

if [[ $# -lt 1 ]]; then
    _msg_error "No command specified" 0
    _usage 1
539
fi
540
541
542
command_name="${1}"

case "${command_name}" in
543
544
545
546
547
548
549
550
    init)
        command_init
        ;;
    install)
        command_install
        ;;
    run)
        command_run
551
552
553
554
        ;;
    prepare)
        command_prepare
        ;;
555
556
557
    checksum)
        command_checksum
        ;;
558
559
560
    pkglist)
        command_pkglist
        ;;
561
    iso)
562
        if [[ $# -lt 2 ]]; then
563
564
565
            _msg_error "No image specified" 0
            _usage 1
        fi
566
        img_name="${2}"
567
568
569
570
571
572
573
        command_iso
        ;;
    *)
        _msg_error "Invalid command name '${command_name}'" 0
        _usage 1
        ;;
esac
574
575

# vim:ts=4:sw=4:et: