mkarchiso 30 KB
Newer Older
1
#!/bin/bash
2
3
#
# SPDX-License-Identifier: GPL-3.0-or-later
4

5
6
set -e -u

7
8
9
10
# Control the environment
umask 0022
export LANG="C"
export SOURCE_DATE_EPOCH="${SOURCE_DATE_EPOCH:-"$(date +%s)"}"
11

12
# mkarchiso defaults
13
app_name="${0##*/}"
14
pkg_list=()
15
run_cmd=""
16
quiet="y"
17
18
work_dir="work"
out_dir="out"
19
img_name="${app_name}.iso"
20
sfs_mode="sfs"
21
sfs_comp="xz"
22
gpg_key=""
23
override_gpg_key=""
24

25
26
27
28
# profile defaults
profile=""
iso_name="${app_name}"
iso_label="${app_name^^}"
29
override_iso_label=""
30
iso_publisher="${app_name}"
31
override_iso_publisher=""
32
iso_application="${app_name} iso"
33
override_iso_application=""
34
35
iso_version=""
install_dir="${app_name}"
36
override_install_dir=""
37
38
arch="$(uname -m)"
pacman_conf="/etc/pacman.conf"
39
override_pacman_conf=""
40
41
42
bootmodes=()


43
44
45
46
# Show an INFO message
# $1: message string
_msg_info() {
    local _msg="${1}"
47
    [[ "${quiet}" == "y" ]] || printf '[%s] INFO: %s\n' "${app_name}" "${_msg}"
48
49
}

50
51
52
53
# Show a WARNING message
# $1: message string
_msg_warning() {
    local _msg="${1}"
54
    printf '[%s] WARNING: %s\n' "${app_name}" "${_msg}" >&2
55
56
}

57
58
59
60
61
62
# 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}
63
    printf '[%s] ERROR: %s\n' "${app_name}" "${_msg}" >&2
64
    if (( _error > 0 )); then
65
        exit "${_error}"
66
67
68
    fi
}

69
_chroot_init() {
70
    install -d -m 0755 -o 0 -g 0 -- "${airootfs_dir}"
71
    _pacman base syslinux
72
73
74
}

_chroot_run() {
75
    eval -- arch-chroot "${airootfs_dir}" "${run_cmd}"
76
77
}

78
79
_mount_airootfs() {
    trap "_umount_airootfs" EXIT HUP INT TERM
80
81
    install -d -m 0755 -- "${work_dir}/mnt/airootfs"
    _msg_info "Mounting '${airootfs_dir}.img' on '${work_dir}/mnt/airootfs'..."
82
    mount -- "${airootfs_dir}.img" "${work_dir}/mnt/airootfs"
83
    _msg_info "Done!"
84
85
}

86
_umount_airootfs() {
87
    _msg_info "Unmounting '${work_dir}/mnt/airootfs'..."
88
    umount -d -- "${work_dir}/mnt/airootfs"
89
    _msg_info "Done!"
90
    rmdir -- "${work_dir}/mnt/airootfs"
91
92
93
94
95
    trap - EXIT HUP INT TERM
}

# Show help usage, with an exit status.
# $1: exit status number.
96
_usage() {
97
    IFS='' read -r -d '' usagetext <<ENDUSAGETEXT || true
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
139
140
141
142
143
usage ${app_name} [options] <profile_dir or legacy_command>
  options:
     -A <application> Set an application name for the ISO
                      Default: '${iso_application}'
     -C <file>        pacman configuration file.
                      Default: '${pacman_conf}'
     -D <install_dir> Set an install_dir. All files will by located here.
                      Default: '${install_dir}'
                      NOTE: Max 8 characters, use only [a-z0-9]
     -L <label>       Set the ISO volume label
                      Default: '${iso_label}'
     -P <publisher>   Set the ISO publisher
                      Default: '${iso_publisher}'
     -c <comp_type>   Set SquashFS compression type (gzip, lzma, lzo, xz, zstd)
                      Default: '${sfs_comp}'
     -g <gpg_key>     Set the GPG key to be used for signing the sqashfs image
     -h               This message
     -o <out_dir>     Set the output directory
                      Default: '${out_dir}'
     -p PACKAGE(S)    Package(s) to install, can be used multiple times
     -r <run_cmd>     Set a command to be run in chroot (only relevant for for command_run)
                      NOTE: Deprecated, will be removed with archiso v49
     -s <sfs_mode>    Set SquashFS image mode (img or sfs)
                      img: prepare airootfs.sfs for dm-snapshot usage
                      sfs: prepare airootfs.sfs for overlayfs usage
                      Default: '${sfs_mode}'
     -v               Enable verbose output
     -w <work_dir>    Set the working directory
                      Default: '${work_dir}'

  profile_dir:        Directory of the archiso profile to build

  legacy_command:     Legacy build.sh command
                      NOTE: Deprecated, will be removed with archiso v49
    command_init
        initialize a chroot for building
    command_install
        install packages to the chroot
    command_run
        run a command in the chroot
    command_prepare
        cleanup and prepare the airootfs
    command_pkglist
        create a list of packages installed on the medium
    command_iso
        create the ISO
144
ENDUSAGETEXT
145
    printf '%s' "${usagetext}"
146
    exit "${1}"
147
148
}

149
# Shows configuration according to command mode.
150
151
# $1: build_profile | init | install | run | prepare | iso
_show_config() {
152
    local _mode="$1"
153
    _msg_info "${app_name} configuration settings"
154
155
156
157
158
    _msg_info "                  Command:   ${command_name}"
    _msg_info "             Architecture:   ${arch}"
    _msg_info "        Working directory:   ${work_dir}"
    _msg_info "   Installation directory:   ${install_dir}"
    case "${_mode}" in
159
160
161
162
163
164
165
166
167
168
169
170
        build_profile)
            _msg_info "         Output directory:   ${out_dir}"
            _msg_info "                  GPG key:   ${gpg_key:-None}"
            _msg_info "                  Profile:   ${profile}"
            _msg_info "Pacman configuration file:   ${pacman_conf}"
            _msg_info "          Image file name:   ${img_name}"
            _msg_info "         ISO volume label:   ${iso_label}"
            _msg_info "            ISO publisher:   ${iso_publisher}"
            _msg_info "          ISO application:   ${iso_application}"
            _msg_info "               Boot modes:   ${bootmodes[*]}"
            _msg_info "                 Packages:   ${pkg_list[*]}"
            ;;
171
        init)
172
            _msg_info "Pacman configuration file:   ${pacman_conf}"
173
174
            ;;
        install)
175
176
            _msg_info "                  GPG key:   ${gpg_key:-None}"
            _msg_info "Pacman configuration file:   ${pacman_conf}"
177
            _msg_info "                 Packages:   ${pkg_list[*]}"
178
            ;;
179
180
181
        run)
            _msg_info "              Run command:   ${run_cmd}"
            ;;
182
        prepare)
183
            _msg_info "                  GPG key:   ${gpg_key:-None}"
184
            ;;
185
186
        pkglist)
            ;;
187
        iso)
188
189
190
191
192
            _msg_info "         Output directory:   ${out_dir}"
            _msg_info "          Image file name:   ${img_name}"
            _msg_info "         ISO volume label:   ${iso_label}"
            _msg_info "            ISO publisher:   ${iso_publisher}"
            _msg_info "          ISO application:   ${iso_application}"
193
            ;;
194
    esac
195
    [[ "${quiet}" == "y" ]] || printf '\n'
196
}
197

198
# Install desired packages to airootfs
199
_pacman() {
200
    _msg_info "Installing packages to '${airootfs_dir}/'..."
201
202

    if [[ "${quiet}" = "y" ]]; then
203
        pacstrap -C "${pacman_conf}" -c -G -M -- "${airootfs_dir}" "$@" &> /dev/null
204
    else
205
        pacstrap -C "${pacman_conf}" -c -G -M -- "${airootfs_dir}" "$@"
206
    fi
207

208
    _msg_info "Done! Packages installed successfully."
209
210
}

211
# Cleanup airootfs
212
_cleanup() {
213
    _msg_info "Cleaning up what we can on airootfs..."
214

215
    # Delete all files in /boot
216
    if [[ -d "${airootfs_dir}/boot" ]]; then
217
        find "${airootfs_dir}/boot" -mindepth 1 -delete
218
219
    fi
    # Delete pacman database sync cache files (*.tar.gz)
220
221
    if [[ -d "${airootfs_dir}/var/lib/pacman" ]]; then
        find "${airootfs_dir}/var/lib/pacman" -maxdepth 1 -type f -delete
222
223
    fi
    # Delete pacman database sync cache
224
225
    if [[ -d "${airootfs_dir}/var/lib/pacman/sync" ]]; then
        find "${airootfs_dir}/var/lib/pacman/sync" -delete
226
227
    fi
    # Delete pacman package cache
228
229
    if [[ -d "${airootfs_dir}/var/cache/pacman/pkg" ]]; then
        find "${airootfs_dir}/var/cache/pacman/pkg" -type f -delete
230
231
    fi
    # Delete all log files, keeps empty dirs.
232
233
    if [[ -d "${airootfs_dir}/var/log" ]]; then
        find "${airootfs_dir}/var/log" -type f -delete
234
235
    fi
    # Delete all temporary files and dirs
236
237
    if [[ -d "${airootfs_dir}/var/tmp" ]]; then
        find "${airootfs_dir}/var/tmp" -mindepth 1 -delete
238
    fi
239
    # Delete package pacman related files.
240
    find "${work_dir}" \( -name '*.pacnew' -o -name '*.pacsave' -o -name '*.pacorig' \) -delete
241
    # Create an empty /etc/machine-id
242
    printf '' > "${airootfs_dir}/etc/machine-id"
243
244

    _msg_info "Done!"
245
}
246

247
# Makes a ext4 filesystem inside a SquashFS from a source directory.
248
_mkairootfs_img() {
249
250
    if [[ ! -e "${airootfs_dir}" ]]; then
        _msg_error "The path '${airootfs_dir}' does not exist" 1
251
252
    fi

253
    _msg_info "Creating ext4 image of 32 GiB..."
254
    if [[ "${quiet}" == "y" ]]; then
255
        mkfs.ext4 -q -O '^has_journal,^resize_inode' -E 'lazy_itable_init=0' -m 0 -F -- "${airootfs_dir}.img" 32G
256
    else
257
        mkfs.ext4 -O '^has_journal,^resize_inode' -E 'lazy_itable_init=0' -m 0 -F -- "${airootfs_dir}.img" 32G
258
    fi
259
    tune2fs -c 0 -i 0 -- "${airootfs_dir}.img" > /dev/null
260
    _msg_info "Done!"
261
    _mount_airootfs
262
263
    _msg_info "Copying '${airootfs_dir}/' to '${work_dir}/mnt/airootfs/'..."
    cp -aT -- "${airootfs_dir}/" "${work_dir}/mnt/airootfs/"
264
    chown -- 0:0 "${work_dir}/mnt/airootfs/"
265
    _msg_info "Done!"
266
    _umount_airootfs
267
    install -d -m 0755 -- "${isofs_dir}/${install_dir}/${arch}"
268
269
    _msg_info "Creating SquashFS image, this may take some time..."
    if [[ "${quiet}" = "y" ]]; then
270
        mksquashfs "${airootfs_dir}.img" "${isofs_dir}/${install_dir}/${arch}/airootfs.sfs" -noappend \
271
            -comp "${sfs_comp}" -no-progress > /dev/null
272
    else
273
        mksquashfs "${airootfs_dir}.img" "${isofs_dir}/${install_dir}/${arch}/airootfs.sfs" -noappend \
274
            -comp "${sfs_comp}"
275
276
    fi
    _msg_info "Done!"
277
    rm -- "${airootfs_dir}.img"
278
279
}

280
# Makes a SquashFS filesystem from a source directory.
281
_mkairootfs_sfs() {
282
283
    if [[ ! -e "${airootfs_dir}" ]]; then
        _msg_error "The path '${airootfs_dir}' does not exist" 1
284
285
    fi

286
    install -d -m 0755 -- "${isofs_dir}/${install_dir}/${arch}"
287
288
    _msg_info "Creating SquashFS image, this may take some time..."
    if [[ "${quiet}" = "y" ]]; then
289
        mksquashfs "${airootfs_dir}" "${isofs_dir}/${install_dir}/${arch}/airootfs.sfs" -noappend \
290
            -comp "${sfs_comp}" -no-progress > /dev/null
291
    else
292
        mksquashfs "${airootfs_dir}" "${isofs_dir}/${install_dir}/${arch}/airootfs.sfs" -noappend \
293
            -comp "${sfs_comp}"
294
295
296
297
    fi
    _msg_info "Done!"
}

298
_mkchecksum() {
299
    _msg_info "Creating checksum file for self-test..."
300
    cd -- "${isofs_dir}/${install_dir}/${arch}"
301
    sha512sum airootfs.sfs > airootfs.sha512
302
    cd -- "${OLDPWD}"
303
    _msg_info "Done!"
304
305
}

306
307
_mksignature() {
    _msg_info "Signing SquashFS image..."
308
    cd -- "${isofs_dir}/${install_dir}/${arch}"
309
    gpg --detach-sign --default-key "${gpg_key}" airootfs.sfs
310
    cd -- "${OLDPWD}"
311
312
313
    _msg_info "Done!"
}

314
315
316
317
318
319
320
# Helper function to run functions only one time.
_run_once() {
    if [[ ! -e "${work_dir}/build.${1}" ]]; then
        "$1"
        touch "${work_dir}/build.${1}"
    fi
}
321

322
323
324
325
326
327
328
329
330
331
332
# Set up custom pacman.conf with current cache directories.
_make_pacman_conf() {
    local _cache_dirs
    _cache_dirs="$(pacman-conf CacheDir)"
    sed -r "s|^#?\\s*CacheDir.+|CacheDir    = ${_cache_dirs[*]//$'\n'/ }|g" \
        "${pacman_conf}" > "${work_dir}/pacman.conf"
}

# Prepare working directory and copy custom airootfs files (airootfs)
_make_custom_airootfs() {
    local passwd=()
333
334
335

    install -d -m 0755 -o 0 -g 0 -- "${airootfs_dir}"

336
    if [[ -d "${profile}/airootfs" ]]; then
337
        _msg_info "Copying custom custom airootfs files and setting up user home directories..."
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
        cp -af --no-preserve=ownership -- "${profile}/airootfs/." "${airootfs_dir}"

        [[ -e "${airootfs_dir}/etc/shadow" ]] && chmod -f 0400 -- "${airootfs_dir}/etc/shadow"
        [[ -e "${airootfs_dir}/etc/gshadow" ]] && chmod -f 0400 -- "${airootfs_dir}/etc/gshadow"

        # Set up user home directories and permissions
        if [[ -e "${airootfs_dir}/etc/passwd" ]]; then
            while IFS=':' read -a passwd -r; do
                [[ "${passwd[5]}" == '/' ]] && continue
                [[ -z "${passwd[5]}" ]] && continue

                if [[ -d "${airootfs_dir}${passwd[5]}" ]]; then
                    chown -hR -- "${passwd[2]}:${passwd[3]}" "${airootfs_dir}${passwd[5]}"
                    chmod -f 0750 -- "${airootfs_dir}${passwd[5]}"
                else
                    install -d -m 0750 -o "${passwd[2]}" -g "${passwd[3]}" -- "${airootfs_dir}${passwd[5]}"
                fi
             done < "${airootfs_dir}/etc/passwd"
        fi
357
        _msg_info "Done!"
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
    fi
}

# Packages (airootfs)
_make_packages() {
    if [[ -n "${gpg_key}" ]]; then
        exec {ARCHISO_GNUPG_FD}<>"${work_dir}/pubkey.gpg"
        export ARCHISO_GNUPG_FD
    fi
    _pacman "${pkg_list[@]}"
    if [[ -n "${gpg_key}" ]]; then
        exec {ARCHISO_GNUPG_FD}<&-
        unset ARCHISO_GNUPG_FD
    fi
}

# Customize installation (airootfs)
_make_customize_airootfs() {
    local passwd=()
377

378
    if [[ -e "${profile}/airootfs/etc/passwd" ]]; then
379
        _msg_info "Copying /etc/skel/* to user homes..."
380
        while IFS=':' read -a passwd -r; do
381
382
            [[ "${passwd[5]}" == '/' ]] && continue
            [[ -z "${passwd[5]}" ]] && continue
383
384
385
386
            cp -RdT --preserve=mode,timestamps,links -- "${airootfs_dir}/etc/skel" "${airootfs_dir}${passwd[5]}"
            chown -hR -- "${passwd[2]}:${passwd[3]}" "${airootfs_dir}${passwd[5]}"

        done < "${profile}/airootfs/etc/passwd"
387
        _msg_info "Done!"
388
389
390
    fi

    if [[ -e "${airootfs_dir}/root/customize_airootfs.sh" ]]; then
391
        _msg_info "Running customize_airootfs.sh in '${airootfs_dir}' chroot..."
392
393
        _msg_warning "customize_airootfs.sh is deprecated! Support for it will be removed in a future archiso version."
        local run_cmd="/root/customize_airootfs.sh"
394
        _chroot_run
395
        rm -- "${airootfs_dir}/root/customize_airootfs.sh"
396
        _msg_info "Done! customize_airootfs.sh run successfully."
397
398
399
    fi
}

400
401
402
403
404
405
406
407
408
409
410
411
# Set up boot loaders
_make_bootmodes() {
    local bootmode
    for bootmode in "${bootmodes[@]}"; do
        if typeset -f "_make_boot_${bootmode}" &> /dev/null; then
            _run_once "_make_boot_${bootmode}"
        else
            _msg_error "${bootmode} is not a valid boot mode" 1
        fi
    done
}

412
# Prepare kernel/initramfs ${install_dir}/boot/
413
_make_boot_on_iso() {
414
415
    _msg_info "Preparing kernel and intramfs for the ISO 9660 file system..."
    install -d -m 0755 -- "${isofs_dir}/${install_dir}/boot/${arch}"
416
417
418
419
    install -m 0644 -- "${airootfs_dir}/boot/archiso.img" "${isofs_dir}/${install_dir}/boot/${arch}/"
    install -m 0644 -- "${airootfs_dir}/boot/vmlinuz-linux" "${isofs_dir}/${install_dir}/boot/${arch}/"
    if [[ -e "${airootfs_dir}/boot/intel-ucode.img" ]]; then
        install -m 0644 -- "${airootfs_dir}/boot/intel-ucode.img" "${isofs_dir}/${install_dir}/boot/"
420
        install -d -m 0755 -- "${isofs_dir}/${install_dir}/boot/licenses/intel-ucode/"
421
422
423
424
425
        install -m 0644 -- "${airootfs_dir}/usr/share/licenses/intel-ucode/"* \
            "${isofs_dir}/${install_dir}/boot/licenses/intel-ucode/"
    fi
    if [[ -e "${airootfs_dir}/boot/amd-ucode.img" ]]; then
        install -m 0644 -- "${airootfs_dir}/boot/amd-ucode.img" "${isofs_dir}/${install_dir}/boot/"
426
        install -d -m 0755 -- "${isofs_dir}/${install_dir}/boot/licenses/amd-ucode/"
427
428
429
        install -m 0644 -- "${airootfs_dir}/usr/share/licenses/amd-ucode/"* \
            "${isofs_dir}/${install_dir}/boot/licenses/amd-ucode/"
    fi
430
    _msg_info "Done!"
431
432
433
}

# Prepare /${install_dir}/boot/syslinux
434
_make_boot_bios.syslinux.mbr() {
435
436
    _msg_info "Setting up SYSLINUX for BIOS booting from a disk..."
    install -d -m 0755 -- "${isofs_dir}/${install_dir}/boot/syslinux"
437
438
    for _cfg in "${profile}/syslinux/"*.cfg; do
        sed "s|%ARCHISO_LABEL%|${iso_label}|g;
439
440
441
             s|%INSTALL_DIR%|${install_dir}|g;
             s|%ARCH%|${arch}|g" \
             "${_cfg}" > "${isofs_dir}/${install_dir}/boot/syslinux/${_cfg##*/}"
442
    done
443
444
445
    if [[ -e "${profile}/syslinux/splash.png" ]]; then
        install -m 0644 -- "${profile}/syslinux/splash.png" "${isofs_dir}/${install_dir}/boot/syslinux/"
    fi
446
447
448
    install -m 0644 -- "${airootfs_dir}/usr/lib/syslinux/bios/"*.c32 "${isofs_dir}/${install_dir}/boot/syslinux/"
    install -m 0644 -- "${airootfs_dir}/usr/lib/syslinux/bios/lpxelinux.0" "${isofs_dir}/${install_dir}/boot/syslinux/"
    install -m 0644 -- "${airootfs_dir}/usr/lib/syslinux/bios/memdisk" "${isofs_dir}/${install_dir}/boot/syslinux/"
449

450
    _run_once _make_boot_on_iso
451
452
    _uname_r=$(file -b "${isofs_dir}/${install_dir}/boot/${arch}/vmlinuz-linux" | awk 'f{print;f=0} /version/{f=1}' RS=' ')

453
    install -d -m 0755 -- "${isofs_dir}/${install_dir}/boot/syslinux/hdt"
454
455
456
457
    gzip -c -9 "${airootfs_dir}/usr/share/hwdata/pci.ids" > \
        "${isofs_dir}/${install_dir}/boot/syslinux/hdt/pciids.gz"
    gzip -c -9 "${airootfs_dir}/usr/lib/modules/${_uname_r}/modules.alias" > \
        "${isofs_dir}/${install_dir}/boot/syslinux/hdt/modalias.gz"
458
459
460
461
462

    # Add other aditional/extra files to ${install_dir}/boot/
    if [[ -e "${airootfs_dir}/boot/memtest86+/memtest.bin" ]]; then
        # rename for PXE: https://wiki.archlinux.org/index.php/Syslinux#Using_memtest
        install -m 0644 -- "${airootfs_dir}/boot/memtest86+/memtest.bin" "${isofs_dir}/${install_dir}/boot/memtest"
463
        install -d -m 0755 -- "${isofs_dir}/${install_dir}/boot/licenses/memtest86+/"
464
465
466
        install -m 0644 -- "${airootfs_dir}/usr/share/licenses/common/GPL2/license.txt" \
            "${isofs_dir}/${install_dir}/boot/licenses/memtest86+/"
    fi
467
    _msg_info "Done! SYSLINUX set up for BIOS booting from a disk successfully."
468
469
470
}

# Prepare /isolinux
471
_make_boot_bios.syslinux.eltorito() {
472
473
    _msg_info "Setting up SYSLINUX for BIOS booting from an optical disc..."
    install -d -m 0755 -- "${isofs_dir}/isolinux"
474
475
476
477
    sed "s|%ARCHISO_LABEL%|${iso_label}|g;
         s|%INSTALL_DIR%|${install_dir}|g;
         s|%ARCH%|${arch}|g" \
         "${profile}/isolinux/isolinux.cfg" > "${isofs_dir}/isolinux/isolinux.cfg"
478
479
480
    install -m 0644 -- "${airootfs_dir}/usr/lib/syslinux/bios/isolinux.bin" "${isofs_dir}/isolinux/"
    install -m 0644 -- "${airootfs_dir}/usr/lib/syslinux/bios/isohdpfx.bin" "${isofs_dir}/isolinux/"
    install -m 0644 -- "${airootfs_dir}/usr/lib/syslinux/bios/ldlinux.c32" "${isofs_dir}/isolinux/"
481
482
483

    # isolinux.cfg loads syslinux.cfg
    _run_once _make_boot_bios.syslinux.mbr
484
485

    _msg_info "Done! SYSLINUX set up for BIOS booting from an optical disc successfully."
486
487
488
489
}

# Prepare /EFI on ISO-9660
_make_efi() {
490
491
    _msg_info "Preparing an /EFI directory for the ISO 9660 file system..."
    install -d -m 0755 -- "${isofs_dir}/EFI/BOOT"
492
493
494
    install -m 0644 -- "${airootfs_dir}/usr/lib/systemd/boot/efi/systemd-bootx64.efi" \
        "${isofs_dir}/EFI/BOOT/BOOTx64.EFI"

495
    install -d -m 0755 -- "${isofs_dir}/loader/entries"
496
497
498
    install -m 0644 -- "${profile}/efiboot/loader/loader.conf" "${isofs_dir}/loader/"

    sed "s|%ARCHISO_LABEL%|${iso_label}|g;
499
500
         s|%INSTALL_DIR%|${install_dir}|g;
         s|%ARCH%|${arch}|g" \
501
502
503
504
505
        "${profile}/efiboot/loader/entries/archiso-x86_64-usb.conf" > \
        "${isofs_dir}/loader/entries/archiso-x86_64.conf"

    # edk2-shell based UEFI shell
    # shellx64.efi is picked up automatically when on /
506
507
508
    if [[ -e "${airootfs_dir}/usr/share/edk2-shell/x64/Shell_Full.efi" ]]; then
        install -m 0644 -- "${airootfs_dir}/usr/share/edk2-shell/x64/Shell_Full.efi" "${isofs_dir}/shellx64.efi"
    fi
509
    _msg_info "Done!"
510
511
}

512
513
# Prepare kernel/initramfs on efiboot.img
_make_boot_on_fat() {
514
    _msg_info "Preparing kernel and intramfs for the FAT file system..."
515
516
517
    mmd -i "${isofs_dir}/EFI/archiso/efiboot.img" ::/EFI/archiso
    mcopy -i "${isofs_dir}/EFI/archiso/efiboot.img" \
        "${airootfs_dir}/boot/vmlinuz-linux" "${airootfs_dir}/boot/archiso.img" ::/EFI/archiso/
518
    if [[ -e "${airootfs_dir}/boot/intel-ucode.img" ]]; then
519
        mcopy -i "${isofs_dir}/EFI/archiso/efiboot.img" "${airootfs_dir}/boot/intel-ucode.img" ::/EFI/archiso/
520
521
    fi
    if [[ -e "${airootfs_dir}/boot/amd-ucode.img" ]]; then
522
        mcopy -i "${isofs_dir}/EFI/archiso/efiboot.img" "${airootfs_dir}/boot/amd-ucode.img" ::/EFI/archiso/
523
    fi
524
    _msg_info "Done!"
525
526
527
528
}

# Prepare efiboot.img::/EFI for EFI boot mode
_make_boot_uefi-x64.systemd-boot.esp() {
529
530
    _msg_info "Setting up systemd-boot for UEFI booting..."
    install -d -m 0755 -- "${isofs_dir}/EFI/archiso"
531

532
533
534
    # The FAT image must be created with mkfs.fat not mformat, as some systems have issues with mformat made images:
    # https://lists.gnu.org/archive/html/grub-devel/2019-04/msg00099.html
    mkfs.fat -C -n ARCHISO_EFI "${isofs_dir}/EFI/archiso/efiboot.img" 65536
535

536
537
538
    mmd -i "${isofs_dir}/EFI/archiso/efiboot.img" ::/EFI ::/EFI/BOOT
    mcopy -i "${isofs_dir}/EFI/archiso/efiboot.img" \
        "${airootfs_dir}/usr/lib/systemd/boot/efi/systemd-bootx64.efi" ::/EFI/BOOT/BOOTx64.EFI
539

540
541
    mmd -i "${isofs_dir}/EFI/archiso/efiboot.img" ::/loader ::/loader/entries
    mcopy -i "${isofs_dir}/EFI/archiso/efiboot.img" "${profile}/efiboot/loader/loader.conf" ::/loader/
542
    sed "s|%ARCHISO_LABEL%|${iso_label}|g;
543
544
         s|%INSTALL_DIR%|${install_dir}|g;
         s|%ARCH%|${arch}|g" \
545
546
        "${profile}/efiboot/loader/entries/archiso-x86_64-cd.conf" \
        | mcopy -i "${isofs_dir}/EFI/archiso/efiboot.img" - ::/loader/entries/archiso-x86_64.conf
547
548

    # shellx64.efi is picked up automatically when on /
549
    if [[ -e "${airootfs_dir}/usr/share/edk2-shell/x64/Shell_Full.efi" ]]; then
550
551
        mcopy -i "${isofs_dir}/EFI/archiso/efiboot.img" \
            "${airootfs_dir}/usr/share/edk2-shell/x64/Shell_Full.efi" ::/shellx64.efi
552
553
554
    fi

    # Copy kernel and initramfs
555
    _run_once _make_boot_on_fat
556

557
    _msg_info "Done! systemd-boot set up for UEFI booting successfully."
558
559
}

560
561
562
563
564
565
566
# Prepare efiboot.img::/EFI for "El Torito" EFI boot mode
_make_boot_uefi-x64.systemd-boot.eltorito() {
    _run_once _make_boot_uefi-x64.systemd-boot.esp
    # Set up /EFI on ISO-9660
    _run_once _make_efi
}

567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
# Build airootfs filesystem image
_make_prepare() {
    if [[ "${sfs_mode}" == "sfs" ]]; then
        _mkairootfs_sfs
    else
        _mkairootfs_img
    fi
    _mkchecksum
    if [[ "${gpg_key}" ]]; then
      _mksignature
    fi
}

# Build ISO
_make_iso() {
582
583
    local xorrisofs_options=()

584
585
    [[ -d "${out_dir}" ]] || install -d -- "${out_dir}"

586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
    if [[ "${quiet}" == "y" ]]; then
        xorrisofs_options+=('-quiet')
    fi
    # shellcheck disable=SC2076
    if [[ " ${bootmodes[*]} " =~ ' bios.syslinux.' ]]; then
        if [[ ! -f "${isofs_dir}/isolinux/isolinux.bin" ]]; then
            _msg_error "The file '${isofs_dir}/isolinux/isolinux.bin' does not exist." 1
        fi
        if [[ ! -f "${isofs_dir}/isolinux/isohdpfx.bin" ]]; then
            _msg_error "The file '${isofs_dir}/isolinux/isohdpfx.bin' does not exist." 1
        fi
        xorrisofs_options+=(
            '-eltorito-boot' 'isolinux/isolinux.bin'
            '-eltorito-catalog' 'isolinux/boot.cat'
            '-no-emul-boot' '-boot-load-size' '4' '-boot-info-table'
            '-isohybrid-mbr' "${isofs_dir}/isolinux/isohdpfx.bin"
        )
    fi
    # shellcheck disable=SC2076
    if [[ " ${bootmodes[*]} " =~ ' uefi-x64.systemd-boot.' ]]; then
        xorrisofs_options+=(
            '-eltorito-alt-boot'
            '-e' 'EFI/archiso/efiboot.img'
            '-no-emul-boot'
            '-isohybrid-gpt-basdat'
        )
    fi

    _msg_info "Creating ISO image..."
    xorriso -as mkisofs \
            -iso-level 3 \
            -full-iso9660-filenames \
nl6720's avatar
nl6720 committed
618
619
            -joliet \
            -joliet-long \
620
621
622
623
624
625
626
627
            -rational-rock \
            -volid "${iso_label}" \
            -appid "${iso_application}" \
            -publisher "${iso_publisher}" \
            -preparer "prepared by ${app_name}" \
            "${xorrisofs_options[@]}" \
            -output "${out_dir}/${img_name}" \
            "${isofs_dir}/"
628
629
    _msg_info "Done!"
    du -h -- "${out_dir}/${img_name}"
630
631
632
}

# Read profile's values from profiledef.sh
633
_read_profile() {
634
635
636
637
638
639
640
641
    if [[ -z "${profile}" ]]; then
        _msg_error "No profile specified!" 1
    fi
    if [[ ! -d "${profile}" ]]; then
        _msg_error "Profile '${profile}' does not exist!" 1
    elif [[ ! -e "${profile}/profiledef.sh" ]]; then
        _msg_error "Profile '${profile}' is missing 'profiledef.sh'!" 1
    else
642
643
        cd -- "${profile}"

644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
        # Source profile's variables
        # shellcheck source=configs/releng/profiledef.sh
        . "${profile}/profiledef.sh"

        # Resolve paths
        packages="$(realpath -- "${profile}/packages.${arch}")"
        pacman_conf="$(realpath -- "${pacman_conf}")"

        # Enumerate packages
        [[ -e "${packages}" ]] || _msg_error "File '${packages}' does not exist!" 1
        mapfile -t pkg_list < <(sed '/^[[:blank:]]*#.*/d;s/#.*//;/^[[:blank:]]*$/d' "${packages}")

        cd -- "${OLDPWD}"
    fi
}

660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
# set overrides from mkarchiso option parameters, if present
_set_overrides() {
    if [[ -n "$override_iso_label" ]]; then
        iso_label="$override_iso_label"
    fi
    if [[ -n "$override_iso_publisher" ]]; then
        iso_publisher="$override_iso_publisher"
    fi
    if [[ -n "$override_iso_application" ]]; then
        iso_application="$override_iso_application"
    fi
    if [[ -n "$override_install_dir" ]]; then
        install_dir="$override_install_dir"
    fi
    if [[ -n "$override_pacman_conf" ]]; then
        pacman_conf="$override_pacman_conf"
    fi
    if [[ -n "$override_gpg_key" ]]; then
        gpg_key="$override_gpg_key"
    fi
}


683
684
685
686
687
688
689
690
_export_gpg_publickey() {
    if [[ -n "${gpg_key}" ]]; then
        gpg --batch --output "${work_dir}/pubkey.gpg" --export "${gpg_key}"
    fi
}


_make_pkglist() {
691
    install -d -m 0755 -- "${isofs_dir}/${install_dir}"
692
    _msg_info "Creating a list of installed packages on live-enviroment..."
693
    pacman -Q --sysroot "${airootfs_dir}" > "${isofs_dir}/${install_dir}/pkglist.${arch}.txt"
694
    _msg_info "Done!"
695
}
696

697
698
command_pkglist() {
    _show_config "${FUNCNAME[0]#command_}"
699
    _make_pkglist
700
701
}

702
# Create an ISO9660 filesystem from "iso" directory.
703
command_iso() {
704
    bootmodes=('bios.syslinux.mbr' 'bios.syslinux.eltorito')
705

706
    # If exists, add an EFI "El Torito" boot image (FAT filesystem) to ISO-9660 image.
707
    if [[ -f "${isofs_dir}/EFI/archiso/efiboot.img" ]]; then
708
        bootmodes+=('uefi-x64.systemd-boot.esp' 'uefi-x64.systemd-boot.eltorito')
709
710
    fi

711
    _show_config "${FUNCNAME[0]#command_}"
712
    _make_iso
713
714
}

715
# create airootfs.sfs filesystem, and push it in "iso" directory.
716
717
command_prepare() {
    _show_config "${FUNCNAME[0]#command_}"
718
719

    _cleanup
720
    _make_prepare
721
722
}

723
# Install packages on airootfs.
724
# A basic check to avoid double execution/reinstallation is done via hashing package names.
725
command_install() {
726
727
728
729
    if [[ ! -f "${pacman_conf}" ]]; then
        _msg_error "Pacman config file '${pacman_conf}' does not exist" 1
    fi

730
    if (( ${#pkg_list[@]} == 0 )); then
731
732
733
734
        _msg_error "Packages must be specified" 0
        _usage 1
    fi

735
    _show_config "${FUNCNAME[0]#command_}"
736

737
    _make_packages
738
739
}

740
command_init() {
741
    _show_config "${FUNCNAME[0]#command_}"
742
743
744
745
    _chroot_init
}

command_run() {
746
    _show_config "${FUNCNAME[0]#command_}"
747
748
    _chroot_run
}
749

750
751
752
command_build_profile() {
    # Set up essential directory paths
    airootfs_dir="${work_dir}/${arch}/airootfs"
753
754
755
756
    isofs_dir="${work_dir}/iso"
    # Set ISO file name
    img_name="${iso_name}-${iso_version}-${arch}.iso"

757
758
759
760
761
    _show_config "${FUNCNAME[0]#command_}"

    # Create working directory
    [[ -d "${work_dir}" ]] || install -d -- "${work_dir}"

762
763
764
765
766
767
    _run_once _make_pacman_conf
    _run_once _export_gpg_publickey
    _run_once _make_custom_airootfs
    _run_once _make_packages
    _run_once _make_customize_airootfs
    _run_once _make_pkglist
768
    _make_bootmodes
769
770
771
    _run_once _cleanup
    _run_once _make_prepare
    _run_once _make_iso
772
773
}

774
while getopts 'p:r:C:L:P:A:D:w:o:s:c:g:vh?' arg; do
775
    case "${arg}" in
776
777
        p)
            read -r -a opt_pkg_list <<< "${OPTARG}"
778
779
            pkg_list+=("${opt_pkg_list[@]}")
            ;;
780
        r) run_cmd="${OPTARG}" ;;
781
782
783
784
785
        C) override_pacman_conf="$(realpath -- "${OPTARG}")" ;;
        L) override_iso_label="${OPTARG}" ;;
        P) override_iso_publisher="${OPTARG}" ;;
        A) override_iso_application="${OPTARG}" ;;
        D) override_install_dir="${OPTARG}" ;;
786
787
        w) work_dir="$(realpath -- "${OPTARG}")" ;;
        o) out_dir="$(realpath -- "${OPTARG}")" ;;
788
        s) sfs_mode="${OPTARG}" ;;
789
        c) sfs_comp="${OPTARG}" ;;
790
        g) override_gpg_key="${OPTARG}" ;;
791
792
793
794
795
796
797
798
799
        v) quiet="n" ;;
        h|?) _usage 0 ;;
        *)
            _msg_error "Invalid argument '${arg}'" 0
            _usage 1
            ;;
    esac
done

800
801
802
803
if (( EUID != 0 )); then
    _msg_error "${app_name} must be run as root." 1
fi

804
805
shift $((OPTIND - 1))

806
if (( $# < 1 )); then
807
808
    _msg_error "No command specified" 0
    _usage 1
809
fi
810
811
command_name="${1}"

812
# Set directory path defaults for legacy commands
813
airootfs_dir="${work_dir}/airootfs"
814
isofs_dir="${work_dir}/iso"
815

816
case "${command_name}" in
817
    init)
818
819
        _msg_warning "The '${command_name}' command is deprecated! It will be removed with archiso v49."
        _set_overrides
820
821
822
        command_init
        ;;
    install)
823
824
        _msg_warning "The '${command_name}' command is deprecated! It will be removed with archiso v49."
        _set_overrides
825
826
827
        command_install
        ;;
    run)
828
        _msg_warning "The '${command_name}' command is deprecated! It will be removed with archiso v49."
829
        command_run
830
831
        ;;
    prepare)
832
833
        _msg_warning "The '${command_name}' command is deprecated! It will be removed with archiso v49."
        _set_overrides
834
835
        command_prepare
        ;;
836
    pkglist)
837
        _msg_warning "The '${command_name}' command is deprecated! It will be removed with archiso v49."
838
839
        command_pkglist
        ;;
840
    iso)
841
        _msg_warning "The '${command_name}' command is deprecated! It will be removed with archiso v49."
842
        if (( $# < 2 )); then
843
844
845
            _msg_error "No image specified" 0
            _usage 1
        fi
846
        img_name="${2}"
847
        _set_overrides
848
849
850
        command_iso
        ;;
    *)
851
852
853
854
855
856
857
        # NOTE: we call read_profile here, assuming that the first non-option parameter is a profile directory
        # This way we can retain backwards compatibility with legacy build.sh scripts until we deprecate the old way of
        # calling mkarchiso with named parameters in v49
        profile="$(realpath -- "${command_name}")"
        _read_profile
        _set_overrides
        command_build_profile
858
859
        ;;
esac
860
861

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