"""
+from __future__ import print_function
from optparse import OptionParser
from inspect import isroutine, isclass
import datetime
help="do not output anything but just errors on console")
parser.add_option("--remove-bootoption", dest="removeoption", action="append",
help="regex for removing existing bootoptions")
+parser.add_option("--rw-blockdev", dest="rwblockdev", action="store_true",
+ help="enforce read-write mode on involved block devices")
parser.add_option("--skip-addons", dest="skipaddons", action="store_true",
help="do not install /boot/addons/ files")
+parser.add_option("--skip-bootflag", dest="skipbootflag", action="store_true",
+ help="do not try to check whether the destination has the bootflag set")
parser.add_option("--skip-grub-config", dest="skipgrubconfig", action="store_true",
help="skip generation of grub configuration files")
parser.add_option("--skip-mbr", dest="skipmbr", action="store_true",
help="do not install a master boot record (MBR) on the device")
parser.add_option("--skip-syslinux-config", dest="skipsyslinuxconfig", action="store_true",
help="skip generation of syslinux configuration files")
+parser.add_option("--skip-usb-check", dest="skipusbcheck", action="store_true",
+ help="skip check to verify whether given device is removable")
parser.add_option("--syslinux", dest="syslinux", action="callback", default=True,
callback=syslinux_warning,
help="install syslinux bootloader (deprecated as it's the default)")
GRML2USB_BASE = os.path.dirname(os.path.realpath(__file__))
+class HodorException(Exception):
+ """Throw exception if the exact error is not known and not fatal.
+
+ @Exception: message"""
+
+
class CriticalException(Exception):
"""Throw critical exception if the exact error is not known but fatal.
@Exception: message"""
- pass
class VerifyException(Exception):
"""Throw critical exception if there is an fatal error when verifying something.
@Exception: message"""
- pass
# The following two functions help to operate on strings as
return obj.__module__ + '.' + obj.__name__
+def set_rw(device):
+ if not options.rwblockdev:
+ return
+
+ logging.debug("executing: blockdev --setrw %s", device)
+ proc = subprocess.Popen(["blockdev", "--setrw", device])
+ proc.wait()
+ if proc.returncode != 0:
+ raise Exception("error executing blockdev on %s" % device)
+
+
def execute(f, *exec_arguments):
"""Wrapper for executing a command. Either really executes
the command (default) or when using --dry-run commandline option
"""
bootloader_dirs = ['/boot/isolinux/', '/boot/syslinux/']
for directory in bootloader_dirs:
- for name in name, \
- "%s_%s" % (get_flavour_filename(flavour), name):
+ for name in name, "%s_%s" % (get_flavour_filename(flavour), name):
if os.path.isfile(iso_mount + directory + name):
return (directory, name)
return ('', '')
raise CriticalException("please run this script with uid 0 (root).")
+# for usage inside check_boot_flag
+def get_partition_for_path(path):
+ import parted
+
+ boot_dev, x = get_device_from_partition(path)
+
+ d = parted.getDevice(boot_dev)
+ disk = parted.Disk(d)
+ return disk.getPartitionByPath(path)
+
+
def check_boot_flag(device):
boot_dev, x = get_device_from_partition(device)
+ try:
+ import parted
+ part = get_partition_for_path(device)
+ if part is None:
+ raise HodorException("parted could not find partition")
+ if part.getFlag(parted.PARTITION_BOOT):
+ logging.debug("bootflag is enabled on %s" % device)
+ return
+ except HodorException, e:
+ logging.info("%s, falling back to old bootflag detection", e)
+ except ImportError, e:
+ logging.debug("could not import parted, falling back to old bootflag detection")
+
with open(boot_dev, 'r') as image:
data = image.read(520)
bootcode = data[440:]
else:
logging.debug("bootflag is NOT enabled")
raise VerifyException("Device %s does not have the bootflag set. "
- "Please enable it to be able to boot." % boot_dev)
+ "Please enable it to be able to boot." % device)
def mkfs_fat16(device):
device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
register_tmpfile(device_mountpoint)
try:
- try:
- mount(device, device_mountpoint, "")
+ # If using --grub-mbr then make sure we install grub in MBR instead of PBR
+ if options.grubmbr:
+ logging.debug("Using option --grub-mbr ...")
+ grub_device, x = get_device_from_partition(device)
+ else:
+ grub_device = device
- # If using --grub-mbr then make sure we install grub in MBR instead of PBR
- if options.grubmbr:
- logging.debug("Using option --grub-mbr ...")
- grub_device, x = get_device_from_partition(device)
- else:
- grub_device = device
-
- logging.info("Installing grub as bootloader")
- for opt in ["", "--force"]:
- logging.debug("grub-install --recheck %s --no-floppy --root-directory=%s %s",
- opt, device_mountpoint, grub_device)
- proc = subprocess.Popen([GRUB_INSTALL, "--recheck", opt, "--no-floppy",
- "--root-directory=%s" % device_mountpoint, grub_device],
- stdout=file(os.devnull, "r+"))
- proc.wait()
- if proc.returncode == 0:
- break
-
- if proc.returncode != 0:
- # raise Exception("error executing grub-install")
- logging.critical("Fatal: error executing grub-install "
- + "(please check the grml2usb FAQ or drop the --grub option)")
- logging.critical("Note: if using grub2 consider using "
- + "the --grub-mbr option as grub considers PBR problematic.")
- cleanup()
- sys.exit(1)
- except CriticalException, error:
- logging.critical("Fatal: %s", error)
+ set_rw(device)
+ mount(device, device_mountpoint, "")
+
+ logging.info("Installing grub as bootloader")
+ for opt in ["--", "--force"]:
+ set_rw(device)
+ set_rw(grub_device)
+ logging.debug("%s --recheck --no-floppy --target=i386-pc --root-directory=%s %s %s",
+ GRUB_INSTALL, device_mountpoint, opt, grub_device)
+ proc = subprocess.Popen([GRUB_INSTALL, "--recheck",
+ "--no-floppy", "--target=i386-pc",
+ "--root-directory=%s" % device_mountpoint,
+ opt, grub_device],
+ stdout=file(os.devnull, "r+"))
+ proc.wait()
+ if proc.returncode == 0:
+ break
+
+ if proc.returncode != 0:
+ # raise Exception("error executing grub-install")
+ logging.critical("Fatal: error executing grub-install " +
+ "(please check the grml2usb FAQ or drop the --grub option)")
+ logging.critical("Note: if using grub2 consider using " +
+ "the --grub-mbr option as grub considers PBR problematic.")
cleanup()
sys.exit(1)
-
+ except CriticalException as error:
+ logging.critical("Fatal: %s", error)
+ cleanup()
+ sys.exit(1)
finally:
unmount(device_mountpoint, "")
os.rmdir(device_mountpoint)
logging.info("Would install syslinux as bootloader on %s", device)
return 0
+ set_rw(device)
+
# syslinux -d boot/isolinux /dev/sdb1
logging.info("Installing syslinux as bootloader")
logging.debug("syslinux -d boot/syslinux %s", device)
if options.grub:
try:
install_grub(device)
- except CriticalException, error:
+ except CriticalException as error:
logging.critical("Fatal: %s", error)
cleanup()
sys.exit(1)
else:
try:
install_syslinux(device)
- except CriticalException, error:
+ except CriticalException as error:
logging.critical("Fatal: %s", error)
cleanup()
sys.exit(1)
tmpf.file.write(mbrcode)
tmpf.file.close()
+ set_rw(device)
+
logging.debug("executing: dd if='%s' of='%s' bs=512 count=1 conv=notrunc", tmpf.name, device)
proc = subprocess.Popen(["dd", "if=%s" % tmpf.name, "of=%s" % device, "bs=512", "count=1",
"conv=notrunc"], stderr=file(os.devnull, "r+"))
raise Exception("error executing dd (third run)")
del tmpf
+ # make sure we sync filesystems before returning
+ proc = subprocess.Popen(["sync"])
+ proc.wait()
+
+ set_rw(device)
+
def is_writeable(device):
"""Check if the device is writeable for the current user
if not device:
return False
- #raise Exception("no device for checking write permissions")
if not os.path.exists(device):
return False
for x in file('/proc/mounts').readlines():
if x.startswith(source):
- raise CriticalException("Error executing mount: %s already mounted - " % source
- + "please unmount before invoking grml2usb")
+ raise CriticalException("Error executing mount: %s already mounted - " % source +
+ "please unmount before invoking grml2usb")
if os.path.isdir(source):
logging.debug("Source %s is not a device, therefore not mounting.", source)
for line in fileinput.input([target_grml_version_file], inplace=1):
flavour = get_flavour(line)
if flavour in iso_versions.keys():
- print iso_versions.pop(flavour)
+ print(iso_versions.pop(flavour))
else:
- print line.strip()
+ print(line.strip())
fileinput.close()
target_file = open(target_grml_version_file, 'a')
# ipxe.lkrn
handle_addon_copy('ipxe.lkrn', addons, iso_mount)
+ # netboot.xyz
+ handle_addon_copy('netboot.xyz.lkrn', addons, iso_mount)
+
def build_loopbackcfg(target):
"""Generate GRUB's loopback.cfg based on existing config files.
if efi_img:
mkdir(target + '/boot/')
exec_rsync(efi_img, target + '/boot/efi.img')
+ handle_secure_boot(target, efi_img)
for ffile in ['f%d' % number for number in range(1, 11)]:
search_and_copy(ffile, iso_mount, syslinux_target + ffile)
logging.warning("Warning: Grml releases older than 2011.12 support only one flavour in grub.")
for expr in name, 'distri.cfg', \
- defaults_file, 'grml.png', 'hd.cfg', 'isolinux.cfg', 'isolinux.bin', \
- 'isoprompt.cfg', 'options.cfg', \
- 'prompt.cfg', 'vesamenu.cfg', 'grml.png', '*.c32':
+ defaults_file, 'grml.png', 'hd.cfg', 'isolinux.cfg', 'isolinux.bin', \
+ 'isoprompt.cfg', 'options.cfg', \
+ 'prompt.cfg', 'vesamenu.cfg', 'grml.png', '*.c32':
glob_and_copy(iso_mount + source_dir + expr, syslinux_target)
for filename in glob.glob1(syslinux_target, "*.c32"):
try:
copy_system_files(grml_flavour, iso_mount, target)
copy_grml_files(grml_flavour, iso_mount, target)
- except CriticalException, error:
+ except CriticalException as error:
logging.critical("Execution failed: %s", error)
sys.exit(1)
device = partition
partition_number = None
if partition[-1].isdigit() and not RE_LOOP_DEVICE.match(partition):
- m = RE_P_PARTITION.match(partition)
- if not m:
- m = RE_PARTITION.match(partition)
+ m = RE_P_PARTITION.match(partition) or RE_PARTITION.match(partition)
if m:
device = m.group(1)
partition_number = int(m.group(2)) - 1
logging.critical("Error: could not find grml-version file.")
logging.critical("Looks like your system is running from RAM but required files are not available.")
logging.critical("Please either boot without toram=... or use boot option toram instead of toram=...")
- cleanup()
- sys.exit(1)
else:
logging.critical("Error: could not find grml-version file.")
- cleanup()
- sys.exit(1)
+ cleanup()
+ sys.exit(1)
flavours = []
logging.debug("version_files = %s", version_files)
tmpfile = open(version_file, 'r')
for line in tmpfile.readlines():
flavours.append(get_flavour(line))
- except TypeError, e:
- raise
- except Exception, e:
- raise
finally:
if tmpfile:
tmpfile.close()
logging.debug("Updating grub configuration")
grub_target = target + '/boot/grub/'
+ secureboot_target = target + '/EFI/ubuntu/'
bootid_re = re.compile("bootid=[\w_-]+")
live_media_path_re = re.compile("live-media-path=[\w_/-]+")
remove_regexes.append(re.compile(regex))
shortname = get_shortname(grml_flavour)
- for filename in glob.glob(grub_target + '*.cfg'):
+ for filename in glob.glob(grub_target + '*.cfg') + glob.glob(secureboot_target + '*.cfg'):
for line in fileinput.input(filename, inplace=1):
line = line.rstrip("\r\n")
if option_re.search(line):
line = line.rstrip() + r' bootid=%s %s ' % (UUID, bootopt)
for regex in remove_regexes:
line = regex.sub(' ', line)
- print line
+ print(line)
fileinput.close()
def add_entry_if_not_present(filename, entry):
"""Write entry into filename if entry is not already in the file
- @filanme: name of the file
+ @filename: name of the file
@entry: data to write to the file
"""
data = open(filename, "a+")
add_syslinux_entry("%s/additional.cfg" % syslinux_target, flavour_filename)
+def handle_secure_boot(target, efi_img):
+ """Provide secure boot support by extracting files from /boot/efi.img
+
+ @target: path where grml's main files should be copied to
+ @efi_img: path to the efi.img file that includes the files for secure boot
+ """
+
+ mkdir(target + '/efi/boot/')
+ efi_mountpoint = tempfile.mkdtemp(prefix="grml2usb", dir=os.path.abspath(options.tmpdir))
+ logging.debug("efi_mountpoint = %s" % efi_mountpoint)
+ register_tmpfile(efi_mountpoint)
+
+ try:
+ logging.debug("mount(%s, %s, ['-o', 'ro', '-t', 'vfat']" % (efi_img, efi_mountpoint))
+ mount(efi_img, efi_mountpoint, ['-o', 'ro', '-t', 'vfat'])
+ except CriticalException as error:
+ logging.critical("Fatal: %s", error)
+ sys.exit(1)
+
+ ubuntu_cfg = search_file('grub.cfg', efi_mountpoint + '/EFI/ubuntu')
+ logging.debug("ubuntu_cfg = %s" % ubuntu_cfg)
+ if not ubuntu_cfg:
+ logging.info("No /EFI/ubuntu/grub.cfg found inside EFI image, looks like Secure Boot support is missing.")
+ else:
+ mkdir(target + '/efi/ubuntu')
+ logging.debug("exec_rsync(%s, %s + '/efi/ubuntu/grub.cfg')" % (ubuntu_cfg, target))
+ exec_rsync(ubuntu_cfg, target + '/efi/ubuntu/grub.cfg')
+
+ logging.debug("exec_rsync(%s + '/EFI/BOOT/grubx64.efi', %s + '/efi/boot/grubx64.efi')'" % (efi_mountpoint, target))
+ exec_rsync(efi_mountpoint + '/EFI/BOOT/grubx64.efi', target + '/efi/boot/grubx64.efi')
+
+ # NOTE - we're overwriting /efi/boot/bootx64.efi from copy_bootloader_files here
+ logging.debug("exec_rsync(%s + '/EFI/BOOT/bootx64.efi', %s + '/efi/boot/bootx64.efi')'" % (efi_mountpoint, target))
+ exec_rsync(efi_mountpoint + '/EFI/BOOT/bootx64.efi', target + '/efi/boot/bootx64.efi')
+
+ try:
+ unmount(efi_mountpoint, "")
+ logging.debug('Unmounted %s' % efi_mountpoint)
+ os.rmdir(efi_mountpoint)
+ logging.debug('Removed directory %s' % efi_mountpoint)
+ except StandardError:
+ logging.critical('RuntimeError while umount %s' % efi_mountpoint)
+ sys.exit(1)
+
+
def handle_bootloader_config(grml_flavour, device, target):
"""Main handler for generating bootloader's configuration
else:
try:
handle_syslinux_config(grml_flavour, target)
- except CriticalException, error:
+ except CriticalException as error:
logging.critical("Fatal: %s", error)
sys.exit(1)
else:
try:
handle_grub_config(grml_flavour, device, target)
- except CriticalException, error:
+ except CriticalException as error:
logging.critical("Fatal: %s", error)
sys.exit(1)
remove_image_mountpoint = True
try:
mount(image, iso_mountpoint, ["-o", "loop,ro", "-t", "iso9660"])
- except CriticalException, error:
+ except CriticalException as error:
logging.critical("Fatal: %s", error)
sys.exit(1)
if remove_image_mountpoint:
try:
remove_mountpoint(iso_mountpoint)
- except CriticalException, error:
+ except CriticalException as error:
cleanup()
raise
remove_device_mountpoint = True
try:
check_for_fat(device)
- check_boot_flag(device)
+ if not options.skipbootflag:
+ check_boot_flag(device)
+
+ set_rw(device)
mount(device, device_mountpoint, ['-o', 'utf8,iocharset=iso8859-1'])
- except VerifyException, error:
- raise
- except CriticalException, error:
+ except CriticalException as error:
mount(device, device_mountpoint, "")
try:
grml_flavours = identify_grml_flavour(mountpoint)
if os.path.isdir(mountpoint):
os.rmdir(mountpoint)
unregister_tmpfile(mountpoint)
- except CriticalException, error:
+ except CriticalException as error:
cleanup()
raise
if options.syslinuxmbr:
mbrcode = ""
mbr_locations = ('/usr/lib/syslinux/mbr.bin',
+ '/usr/lib/syslinux/bios/mbr.bin',
'/usr/share/syslinux/mbr.bin')
for mbrpath in mbr_locations:
if os.path.isfile(mbrpath):
try:
install_mbr(mbrcode, mbr_device, partition_number, True)
- except IOError, error:
- logging.critical("Execution failed: %s", error)
- sys.exit(1)
- except Exception, error:
+ except (IOError, Exception) as error:
logging.critical("Execution failed: %s", error)
sys.exit(1)
sys.exit(1)
if options.force:
- print "Forcing mkfs.fat16 on %s as requested via option --force." % device
+ print("Forcing mkfs.fat16 on %s as requested via option --force." % device)
else:
# make sure the user is aware of what he is doing
f = raw_input("Are you sure you want to format the specified partition with fat16? y/N ")
sys.exit(1)
try:
mkfs_fat16(device)
- except CriticalException, error:
+ except CriticalException as error:
logging.critical("Execution failed: %s", error)
sys.exit(1)
if device is not None and not os.path.isdir(device) and options.syslinux:
try:
check_for_fat(device)
- except CriticalException, error:
+ except CriticalException as error:
logging.critical("Execution failed: %s", error)
sys.exit(1)
+ if options.skipusbcheck:
+ logging.info("Not checking for removable USB device as requested via option --skip-usb-check.")
+ return
+
if not os.path.isdir(device) and not check_for_usbdevice(device) and not options.force:
- print "Warning: the specified device %s does not look like a removable usb device." % device
+ print("Warning: the specified device %s does not look like a removable usb device." % device)
f = raw_input("Do you really want to continue? y/N ")
- if f == "y" or f == "Y":
- pass
- else:
+ if f.lower() != "y":
sys.exit(1)
# make sure we can replace old grml2usb script and warn user when using old way of life:
if device.startswith("/mnt/external") or device.startswith("/mnt/usb") and not options.force:
- print "Warning: the semantics of grml2usb has changed."
- print "Instead of using grml2usb /path/to/iso %s you might" % device
- print "want to use grml2usb /path/to/iso /dev/... instead."
- print "Please check out the grml2usb manpage for details."
+ print("Warning: the semantics of grml2usb has changed.")
+ print("Instead of using grml2usb /path/to/iso %s you might" % device)
+ print("want to use grml2usb /path/to/iso /dev/... instead.")
+ print("Please check out the grml2usb manpage for details.")
f = raw_input("Do you really want to continue? y/N ")
- if f == "y" or f == "Y":
- pass
- else:
+ if f.lower() != "y":
sys.exit(1)
if opts.grubmbr and not opts.grub:
raise CriticalException("--grub-mbr requires --grub option.")
+ if opts.copyonly and opts.grub:
+ raise CriticalException("Cannot use --copy-only and --grub at the same time.")
+
def check_programs():
"""check if all needed programs are installed"""
if options.grub:
+ global GRUB_INSTALL
GRUB_INSTALL = which("grub-install") or which("grub2-install")
if not GRUB_INSTALL:
- logging.critical("Fatal: grub-install not available (please install the "
- + "grub package or drop the --grub option)")
+ logging.critical("Fatal: grub-install not available (please install the " +
+ "grub package or drop the --grub option)")
sys.exit(1)
if options.syslinux:
if not which("syslinux"):
- logging.critical("Fatal: syslinux not available (please install the "
- + "syslinux package or use the --grub option)")
+ logging.critical("Fatal: syslinux not available (please install the " +
+ "syslinux package or use the --grub option)")
sys.exit(1)
if not which("rsync"):
try:
if options.version:
- print os.path.basename(sys.argv[0]) + " " + PROG_VERSION
+ print(os.path.basename(sys.argv[0]) + " " + PROG_VERSION)
sys.exit(0)
if len(args) < 2:
if not os.path.isdir(device):
if device[-1:].isdigit():
if int(device[-1:]) > 4 or device[-2:].isdigit():
- logging.critical("Fatal: installation on partition number >4 not supported. (BIOS won't support it.)")
- sys.exit(1)
+ logging.warn("Warning: installing on partition number >4, booting *might* fail depending on your system.")
# provide upgrade path
handle_compat_warning(device)
# finally be polite :)
logging.info("Finished execution of grml2usb (%s). Have fun with your Grml system.", PROG_VERSION)
- except Exception, error:
+ except Exception as error:
logging.critical("Fatal: %s", str(error))
sys.exit(1)
logging.info("Received KeyboardInterrupt")
cleanup()
-## END OF FILE #################################################################
+# END OF FILE ##################################################################
# vim:foldmethod=indent expandtab ai ft=python tw=120 fileencoding=utf-8
projects / grml2usb.git / blobdiff