2 # -*- coding: utf-8 -*-
3 # pylint: disable-msg=C0302
8 This script installs a Grml system (either a running system or ISO[s]) to a USB device
10 :copyright: (c) 2009-2019 by Michael Prokop <mika@grml.org>
11 :license: GPL v2 or any later version
12 :bugreports: http://grml.org/bugs/
28 from inspect import isclass, isroutine
29 from optparse import OptionParser
31 # The line following this line is patched by debian/rules and tarball.sh.
32 PROG_VERSION = "***UNKNOWN***"
34 # when running from inside git, try to report version information via git-describe
36 git_dir = os.path.abspath(os.path.dirname(sys.argv[0]))
37 with open(os.devnull, "w") as devnull:
39 subprocess.check_output(
40 ["git", "-C", git_dir, "describe", "--always", "--dirty"],
44 .decode("utf-8", errors="replace")
51 MOUNTED = set() # register mountpoints
52 TMPFILES = set() # register tmpfiles
53 GRML_FLAVOURS = set() # which flavours are being installed?
57 "/usr/lib/syslinux/modules/bios/", # Debian
58 "/usr/lib/syslinux/bios/", # Arch Linux
62 RE_PARTITION = re.compile(r"([a-z/]*?)(\d+)$")
63 RE_P_PARTITION = re.compile(r"(.*?\d+)p(\d+)$")
64 RE_LOOP_DEVICE = re.compile(r"/dev/loop\d+$")
67 def syslinux_warning(option, opt, opt_parser):
68 """A helper function for printing a warning about deprecated option"""
69 # pylint: disable-msg=W0613
71 "Note: the --syslinux option is deprecated as syslinux "
72 "is grml2usb's default. Continuing anyway.\n"
74 setattr(opt_parser.values, option.dest, True)
77 # if grub option is set, unset syslinux option
78 def grub_option(option, opt, opt_parser):
79 """A helper function adjusting other option values"""
80 # pylint: disable-msg=W0613
81 setattr(opt_parser.values, option.dest, True)
82 setattr(opt_parser.values, "syslinux", False)
86 USAGE = "Usage: %prog [options] <[ISO[s] | /run/live/medium]> </dev/sdX#>\n\
88 %prog installs Grml ISO[s] to an USB device to be able to boot from it.\n\
89 Make sure you have at least one Grml ISO or a running Grml system (/run/live/medium),\n\
90 grub or syslinux and root access.\n\
92 Run %prog --help for usage hints, further information via: man grml2usb"
94 # pylint: disable-msg=C0103
95 # pylint: disable-msg=W0603
96 parser = OptionParser(usage=USAGE)
102 help="use specified bootoptions as default",
106 dest="bootloaderonly",
108 help="do not copy files but just install a bootloader",
114 help="copy files only but do not install bootloader",
117 "--dry-run", dest="dryrun", action="store_true", help="avoid executing commands"
123 help="format specified partition with FAT16",
129 help="force any actions requiring manual interaction",
135 callback=grub_option,
136 help="install grub bootloader instead of (default) syslinux",
142 help="install grub into MBR instead of (default) PBR",
148 help="enable interactive boot menu in MBR",
154 help="do not output anything but just errors on console",
157 "--remove-bootoption",
160 help="regex for removing existing bootoptions",
166 help="enforce read-write mode on involved block devices",
172 help="do not install /boot/addons/ files",
178 help="do not try to check whether the destination has the boot flag set",
181 "--skip-grub-config",
182 dest="skipgrubconfig",
184 help="skip generation of grub configuration files",
190 help="do not install a master boot record (MBR) on the device",
193 "--skip-syslinux-config",
194 dest="skipsyslinuxconfig",
196 help="skip generation of syslinux configuration files",
202 help="skip check to verify whether given device is removable",
209 callback=syslinux_warning,
210 help="install syslinux bootloader (deprecated as it's the default)",
216 help="install syslinux master boot record (MBR) instead of default",
223 help="syslinux modules directory path",
229 help="directory to be used for temporary files",
232 "--verbose", dest="verbose", action="store_true", help="enable verbose mode"
239 help="display version and exit",
241 (options, args) = parser.parse_args()
244 GRML2USB_BASE = "/usr/share/grml2usb"
245 if not os.path.isdir(GRML2USB_BASE):
246 GRML2USB_BASE = os.path.dirname(os.path.realpath(__file__))
249 class HodorException(Exception):
250 """Throw exception if the exact error is not known and not fatal.
252 @Exception: message"""
255 class CriticalException(Exception):
256 """Throw critical exception if the exact error is not known but fatal.
258 @Exception: message"""
261 class VerifyException(Exception):
262 """Throw critical exception if there is an fatal error when verifying something.
264 @Exception: message"""
268 """Cleanup function to make sure there aren't any mounted devices left behind."""
270 def del_failed(_fn, path, _exc):
271 logging.warning("Deletion of %s failed in temporary folder", path)
273 logging.info("Cleaning up before exiting...")
274 proc = subprocess.Popen(["sync"])
277 for device in MOUNTED.copy():
280 logging.debug("Unmounted %s" % device)
282 logging.debug("RuntimeError while umount %s, ignoring" % device)
284 for tmppath in TMPFILES.copy():
286 if os.path.isdir(tmppath) and not os.path.islink(tmppath):
287 # symbolic links to directories are ignored
288 # without the check it will throw an OSError
289 shutil.rmtree(tmppath, onerror=del_failed)
290 logging.debug("temporary directory %s deleted" % tmppath)
291 unregister_tmpfile(tmppath)
294 logging.debug("temporary file %s deleted" % tmppath)
295 unregister_tmpfile(tmppath)
297 msg = "RuntimeError while removing temporary %s, ignoring"
298 logging.debug(msg % tmppath)
301 def register_tmpfile(path):
309 def unregister_tmpfile(path):
311 remove registered tmpfile
315 TMPFILES.remove(path)
320 def register_mountpoint(target):
321 """register specified target in a set() for handling clean exiting
323 @target: destination target of mountpoint
329 def unregister_mountpoint(target):
330 """unregister specified target in a set() for handling clean exiting
332 @target: destination target of mountpoint
335 if target in MOUNTED:
336 MOUNTED.remove(target)
339 def get_function_name(obj):
340 """Helper function for use in execute() to retrieve name of a function
342 @obj: the function object
344 if not (isroutine(obj) or isclass(obj)):
346 return obj.__module__ + "." + obj.__name__
350 if not options.rwblockdev:
353 logging.debug("executing: blockdev --setrw %s", device)
354 proc = subprocess.Popen(["blockdev", "--setrw", device])
356 if proc.returncode != 0:
357 raise Exception("error executing blockdev on %s" % device)
360 def execute(f, *exec_arguments):
361 """Wrapper for executing a command. Either really executes
362 the command (default) or when using --dry-run commandline option
363 just displays what would be executed."""
364 # usage: execute(subprocess.Popen, (["ls", "-la"]))
366 # pylint: disable-msg=W0141
368 "dry-run only: %s(%s)",
369 get_function_name(f),
370 ", ".join(map(repr, exec_arguments)),
373 # pylint: disable-msg=W0142
374 return f(*exec_arguments)
378 """Check whether a given file can be executed
380 @fpath: full path to file
382 return os.path.exists(fpath) and os.access(fpath, os.X_OK)
386 """Check whether a given program is available in PATH
388 @program: name of executable"""
389 fpath = os.path.split(program)[0]
394 for path in os.environ["PATH"].split(os.pathsep):
395 exe_file = os.path.join(path, program)
402 def get_defaults_file(iso_mount, flavour, name):
403 """get the default file for syslinux"""
404 bootloader_dirs = ["/boot/isolinux/", "/boot/syslinux/"]
405 for directory in bootloader_dirs:
406 for name in name, "%s_%s" % (get_flavour_filename(flavour), name):
407 if os.path.isfile(iso_mount + directory + name):
408 return (directory, name)
414 search_path="/bin" + os.pathsep + "/usr/bin",
418 """Given a search path, find file
420 @filename: name of file to search for
421 @search_path: path where searching for the specified filename
422 @lst_return: return list of matching files instead one file"""
423 paths = search_path.split(os.pathsep)
424 current_dir = "" # make pylint happy :)
428 """Helper function ffor testing if specified file exists in cwd
430 @cwd: current working directory
432 return os.path.exists(os.path.join(cwd, filename))
436 if match_file(current_dir):
437 retval.append(os.path.abspath(os.path.join(current_dir, filename)))
440 for current_dir, _directories, _files in os.walk(path):
441 if match_file(current_dir):
442 retval.append(os.path.abspath(os.path.join(current_dir, filename)))
446 if required and not retval:
447 raise CriticalException(
448 "Required file %s not found in %s" % (filename, search_path)
459 def check_uid_root():
460 """Check for root permissions"""
461 if not os.geteuid() == 0:
462 raise CriticalException("please run this script with uid 0 (root).")
465 # for usage inside check_boot_flag
466 def get_partition_for_path(path):
469 boot_dev, x = get_device_from_partition(path)
471 d = parted.getDevice(boot_dev)
472 disk = parted.Disk(d)
473 return disk.getPartitionByPath(path)
476 def check_boot_flag(device):
477 if os.path.isdir(device):
479 "Device %s is a directory, skipping check for boot flag." % device
483 boot_dev, x = get_device_from_partition(device)
485 logging.info("Checking for boot flag")
489 part = get_partition_for_path(device)
491 raise HodorException("parted could not find partition")
492 if part.getFlag(parted.PARTITION_BOOT):
493 logging.debug("boot flag is enabled on %s" % device)
496 logging.debug("boot flag is NOT enabled on %s" % device)
497 raise VerifyException(
498 "Device %s does not have the boot flag set. "
499 "Please enable it to be able to boot." % device
502 raise VerifyException(
503 "Could not import parted to verify boot flag on %s, please make sure python3-parted is installed."
508 def mkfs_fat16(device):
509 """Format specified device with VFAT/FAT16 filesystem.
511 @device: partition that should be formated"""
514 logging.info("Would execute mkfs.vfat -F 16 %s now.", device)
517 logging.info("Formating partition with fat16 filesystem")
518 logging.debug("mkfs.vfat -F 16 %s", device)
519 proc = subprocess.Popen(["mkfs.vfat", "-n", "GRML", "-F", "16", device])
521 if proc.returncode != 0:
522 raise CriticalException("error executing mkfs.vfat")
525 def generate_main_syslinux_config():
526 """Generate main configuration for use in syslinux.cfg"""
530 menu label Default boot modes:
539 menu label Additional boot entries for:
541 include additional.cfg
548 include promptname.cfg
551 Jump to old style isolinux prompt
552 featuring further information
553 regarding available boot options.
561 def generate_flavour_specific_syslinux_config(grml_flavour):
562 """Generate flavour specific configuration for use in syslinux.cfg
564 @grml_flavour: name of grml flavour the configuration should be generated for"""
567 menu begin grml %(grml_flavour)s
568 menu title %(display_name)s
570 menu label ^Back to main menu...
573 # include config for boot parameters from disk
574 include %(grml_flavour)s_grml.cfg
578 "grml_flavour": grml_flavour,
579 "display_name": get_flavour_filename(grml_flavour),
583 def install_grub(device):
584 """Install grub on specified device.
586 @mntpoint: mountpoint of device where grub should install its files to
587 @device: partition where grub should be installed to"""
591 "Would execute grub-install [--root-directory=mount_point] %s now.", device
594 device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
595 register_tmpfile(device_mountpoint)
597 # If using --grub-mbr then make sure we install grub in MBR instead of PBR
599 logging.debug("Using option --grub-mbr ...")
600 grub_device, x = get_device_from_partition(device)
605 mount(device, device_mountpoint, "")
607 logging.info("Installing grub as bootloader")
608 for opt in ["--", "--force"]:
612 "%s --recheck --no-floppy --target=i386-pc --root-directory=%s %s %s",
618 proc = subprocess.Popen(
624 "--root-directory=%s" % device_mountpoint,
628 stdout=open(os.devnull, "r+"),
631 if proc.returncode == 0:
634 if proc.returncode != 0:
635 # raise Exception("error executing grub-install")
637 "Fatal: error executing grub-install "
638 "(please check the grml2usb FAQ or drop the --grub option)"
641 "Note: if using grub2 consider using "
642 "the --grub-mbr option as grub considers PBR problematic."
646 except CriticalException as error:
647 logging.critical("Fatal: %s", error)
651 unmount(device_mountpoint, "")
652 os.rmdir(device_mountpoint)
653 unregister_tmpfile(device_mountpoint)
656 def install_syslinux(device):
657 """Install syslinux on specified device.
659 @device: partition where syslinux should be installed to"""
662 logging.info("Would install syslinux as bootloader on %s", device)
667 # syslinux -d boot/isolinux /dev/sdb1
668 logging.info("Installing syslinux as bootloader")
669 logging.debug("syslinux -d boot/syslinux %s", device)
670 proc = subprocess.Popen(["syslinux", "-d", "boot/syslinux", device])
672 if proc.returncode != 0:
673 raise CriticalException(
674 "Error executing syslinux (either try --fat16 or use grub?)"
678 def install_bootloader(device):
679 """Install bootloader on specified device.
681 @device: partition where bootloader should be installed to"""
683 # by default we use grub, so install syslinux only on request
687 except CriticalException as error:
688 logging.critical("Fatal: %s", error)
693 install_syslinux(device)
694 except CriticalException as error:
695 logging.critical("Fatal: %s", error)
700 def install_mbr(mbrtemplate, device, partition, ismirbsdmbr=True):
701 """install 'mbr' master boot record (MBR) on a device
703 Retrieve the partition table from "device", install an MBR from the
704 "mbrtemplate" file, set the "partition" (0..3) active, and install the
705 result back to "device".
707 @mbrtemplate: default MBR file (must be a valid MBR file of at least 440
708 (or 439 if ismirbsdmbr) bytes)
710 @device: name of a file assumed to be a hard disc (or USB stick) image, or
711 something like "/dev/sdb"
713 @partition: must be a number between 0 and 3, inclusive
715 @ismirbsdmbr: if true then ignore the active flag, set the mirbsdmbr
716 specific flag to 0/1/2/3 and set the MBR's default value accordingly. If
717 false then leave the mirbsdmbr specific flag set to FFh, set all
718 active flags to 0 and set the active flag of the partition to 80h. Note:
719 behaviour of mirbsdmbr: if flag = 0/1/2/3 then use it, otherwise search for
722 logging.info("Installing default MBR")
724 if not os.path.isfile(mbrtemplate):
726 "Error installing MBR (either try --syslinux-mbr or "
727 'install missing file "%s"?)',
730 raise CriticalException("%s can not be read." % mbrtemplate)
732 if partition is not None and ((partition < 0) or (partition > 3)):
733 logging.warning("Cannot activate partition %d", partition)
741 tmpf = tempfile.NamedTemporaryFile()
743 logging.debug("executing: dd if='%s' of='%s' bs=512 count=1", device, tmpf.name)
744 proc = subprocess.Popen(
745 ["dd", "if=%s" % device, "of=%s" % tmpf.name, "bs=512", "count=1"],
746 stderr=open(os.devnull, "r+"),
749 if proc.returncode != 0:
750 raise Exception("error executing dd (first run)")
753 "executing: dd if=%s of=%s bs=%s count=1 conv=notrunc",
758 proc = subprocess.Popen(
761 "if=%s" % mbrtemplate,
767 stderr=open(os.devnull, "r+"),
770 if proc.returncode != 0:
771 raise Exception("error executing dd (second run)")
773 mbrcode = tmpf.file.read(512)
774 if len(mbrcode) < 512:
775 raise EOFError("MBR size (%d) < 512" % len(mbrcode))
777 if partition is not None:
781 + chr(partition).encode("latin-1")
786 actives = [b"\x00", b"\x00", b"\x00", b"\x00"]
787 actives[partition] = b"\x80"
803 tmpf.file.write(mbrcode)
809 "executing: dd if='%s' of='%s' bs=512 count=1 conv=notrunc", tmpf.name, device
811 proc = subprocess.Popen(
820 stderr=open(os.devnull, "r+"),
823 if proc.returncode != 0:
824 raise Exception("error executing dd (third run)")
827 # make sure we sync filesystems before returning
828 logging.debug("executing: sync")
829 proc = subprocess.Popen(["sync"])
832 logging.debug("Probing device via 'blockdev --rereadpt %s'", device)
833 proc = subprocess.Popen(["blockdev", "--rereadpt", device])
835 if proc.returncode != 0:
837 "Couldn't execute blockdev on '%s' (install util-linux?)", device
843 def mount(source, target, mount_options):
844 """Mount specified source on given target
846 @source: name of device/ISO that should be mounted
847 @target: directory where the ISO should be mounted to
848 @options: mount specific options"""
850 # note: options.dryrun does not work here, as we have to
851 # locate files and identify the grml flavour
853 for x in open("/proc/mounts", "r").readlines():
854 if x.startswith(source):
855 raise CriticalException(
857 "Error executing mount: {0} already mounted - "
858 "please unmount before invoking grml2usb"
862 if os.path.isdir(source):
863 logging.debug("Source %s is not a device, therefore not mounting.", source)
866 logging.debug("mount %s %s %s", mount_options, source, target)
867 proc = subprocess.Popen(["mount"] + list(mount_options) + [source, target])
869 if proc.returncode != 0:
870 raise CriticalException(
871 "Error executing mount (no filesystem on the partition?)"
874 logging.debug("register_mountpoint(%s)", target)
875 register_mountpoint(target)
878 def unmount(target, unmount_options):
879 """Unmount specified target
881 @target: target where something is mounted on and which should be unmounted
882 @options: options for umount command"""
884 # make sure we unmount only already mounted targets
885 target_unmount = False
886 mounts = open("/proc/mounts").readlines()
887 mountstring = re.compile(".*%s.*" % re.escape(os.path.realpath(target)))
889 if re.match(mountstring, line):
890 target_unmount = True
892 if not target_unmount:
893 logging.debug("%s not mounted anymore", target)
895 logging.debug("umount %s %s", list(unmount_options), target)
896 proc = subprocess.Popen(["umount"] + list(unmount_options) + [target])
898 if proc.returncode != 0:
899 raise Exception("Error executing umount")
901 logging.debug("unregister_mountpoint(%s)", target)
902 unregister_mountpoint(target)
905 def extract_device_name(device):
906 """Extract the device name of a given path
908 @device: device name, like /dev/sda1 or /dev/sda
910 return re.match(r"/dev/(.*?)\d*$", device).group(1)
913 def check_for_usbdevice(device):
914 """Check whether the specified device is a removable USB device
916 @device: device name, like /dev/sda1 or /dev/sda
919 usbdevice = extract_device_name(device)
921 usbdev = os.path.realpath("/sys/class/block/" + usbdevice + "/removable")
922 if not os.path.isfile(usbdev):
923 # Ubuntu with kernel 2.6.24 for example:
924 usbdev = os.path.realpath("/sys/block/" + usbdevice + "/removable")
926 if os.path.isfile(usbdev):
927 is_usb = open(usbdev).readline()
934 def check_for_fat(partition):
935 """Check whether specified partition is a valid VFAT/FAT16 filesystem
937 @partition: device name of partition"""
939 if not os.access(partition, os.R_OK):
940 raise CriticalException(
941 "Failed to read device %s"
942 " (wrong UID/permissions or device/directory not present?)" % partition
947 subprocess.check_output(
948 ["/sbin/blkid", "-s", "TYPE", "-o", "value", partition]
954 if filesystem != "vfat":
955 raise CriticalException(
956 "Partition %s does not contain a FAT16 filesystem. "
957 "(Use --fat16 or run mkfs.vfat %s)" % (partition, partition)
961 raise CriticalException(
962 "Sorry, /sbin/blkid not available (install util-linux?)"
966 def mkdir(directory):
967 """Simple wrapper around os.makedirs to get shell mkdir -p behaviour"""
969 # just silently pass as it's just fine it the directory exists
970 if not os.path.isdir(directory):
972 os.makedirs(directory)
973 # pylint: disable-msg=W0704
978 def exec_rsync(source, target):
979 """Simple wrapper around rsync to install files
981 @source: source file/directory
982 @target: target file/directory"""
983 logging.debug("Source: %s / Target: %s", source, target)
984 proc = subprocess.Popen(["rsync", "-rlptDH", "--inplace", source, target])
986 if proc.returncode == 12:
987 logging.critical("Fatal: No space left on device")
991 if proc.returncode != 0:
992 logging.critical("Fatal: could not install %s", source)
997 def write_uuid(target_file):
998 """Generates an returns uuid and write it to the specified file
1000 @target_file: filename to write the uuid to
1003 fileh = open(target_file, "w")
1004 uid = str(uuid.uuid4())
1010 def get_uuid(target):
1011 """Get the uuid of the specified target. Will generate an uuid if none exist.
1013 @target: directory/mountpoint containing the grml layout
1016 conf_target = target + "/conf/"
1017 uuid_file_name = conf_target + "/bootid.txt"
1018 if os.path.isdir(conf_target):
1019 if os.path.isfile(uuid_file_name):
1020 uuid_file = open(uuid_file_name, "r")
1021 uid = uuid_file.readline().strip()
1025 return write_uuid(uuid_file_name)
1027 execute(mkdir, conf_target)
1028 return write_uuid(uuid_file_name)
1031 def get_shortname(grml_flavour):
1032 """Get shortname based from grml_flavour name. The rules applied are the same as in grml-live
1033 @grml_flavour: flavour name which shold be translated to shortname"""
1035 return re.sub(r"[,._-]", "", grml_flavour)
1038 def copy_system_files(grml_flavour, iso_mount, target):
1039 """copy grml's main files (like squashfs, kernel and initrd) to a given target
1041 @grml_flavour: name of grml flavour the configuration should be generated for
1042 @iso_mount: path where a grml ISO is mounted on
1043 @target: path where grml's main files should be copied to"""
1045 squashfs = search_file(grml_flavour + ".squashfs", iso_mount)
1046 if squashfs is None:
1047 logging.error("error locating squashfs file")
1048 raise CriticalException(
1049 "squashfs file not found, please check that your iso is not corrupt"
1052 squashfs_target = target + "/live/" + grml_flavour + "/"
1053 execute(mkdir, squashfs_target)
1054 exec_rsync(squashfs, squashfs_target + grml_flavour + ".squashfs")
1056 for prefix in grml_flavour + "/", "":
1057 filesystem_module = search_file(prefix + "filesystem.module", iso_mount)
1058 if filesystem_module:
1060 if filesystem_module is None:
1061 logging.error("error locating filesystem.module file")
1062 raise CriticalException("filesystem.module not found")
1064 exec_rsync(filesystem_module, squashfs_target + "filesystem.module")
1066 shortname = get_shortname(grml_flavour)
1067 if os.path.isdir(iso_mount + "/boot/" + shortname):
1068 exec_rsync(iso_mount + "/boot/" + shortname, target + "/boot")
1070 kernel = search_file("vmlinuz", iso_mount)
1072 # compat for releases < 2011.12
1073 kernel = search_file("linux26", iso_mount)
1076 logging.error("error locating kernel file")
1077 raise CriticalException("Kernel not found")
1079 source = os.path.dirname(kernel) + "/"
1080 dest = target + "/" + os.path.dirname(kernel).replace(iso_mount, "") + "/"
1081 execute(mkdir, dest)
1082 exec_rsync(source, dest)
1085 def copy_grml_files(grml_flavour, iso_mount, target):
1086 """copy some minor grml files to a given target
1088 @grml_flavour: the current grml_flavour
1089 @iso_mount: path where a grml ISO is mounted on
1090 @target: path where grml's main files should be copied to"""
1092 grml_target = target + "/grml/"
1093 execute(mkdir, grml_target)
1095 grml_prefixe = ["GRML", "grml"]
1096 for prefix in grml_prefixe:
1097 filename = "{0}/{1}/{2}".format(iso_mount, prefix, grml_flavour)
1098 if os.path.exists(filename):
1099 exec_rsync(filename, grml_target)
1103 "Warning: could not find flavour directory for %s ", grml_flavour
1107 def copy_addons(iso_mount, target):
1108 """copy grml's addons files (like allinoneimg, bsd4grml,..) to a given target
1110 @iso_mount: path where a grml ISO is mounted on
1111 @target: path where grml's main files should be copied to"""
1113 addons = target + "/boot/addons/"
1114 execute(mkdir, addons)
1116 for addon_file in glob.glob(iso_mount + "/boot/addons/*"):
1117 filename = os.path.basename(addon_file)
1118 src_file = iso_mount + "/boot/addons/" + os.path.basename(addon_file)
1119 logging.debug("Copying addon file %s" % filename)
1120 exec_rsync(src_file, addons)
1123 def build_loopbackcfg(target):
1124 """Generate GRUB's loopback.cfg based on existing config files.
1126 @target: target directory
1129 grub_dir = "/boot/grub/"
1130 mkdir(os.path.join(target, grub_dir))
1132 f = open(target + grub_dir + "loopback.cfg", "w")
1134 f.write("# grml2usb generated grub2 configuration file\n")
1135 f.write("source /boot/grub/header.cfg\n")
1137 for defaults in glob.glob(
1138 target + os.path.sep + grub_dir + os.path.sep + "*_default.cfg"
1140 sourcefile = defaults.split(target + os.path.sep)[1]
1141 logging.debug("Found source file" + sourcefile)
1142 os.path.isfile(defaults) and f.write("source " + sourcefile + "\n")
1144 for ops in glob.glob(
1145 target + os.path.sep + grub_dir + os.path.sep + "*_options.cfg"
1147 sourcefile = ops.split(target + os.path.sep)[1]
1148 logging.debug("Found source file" + sourcefile)
1149 os.path.isfile(ops) and f.write("source " + sourcefile + "\n")
1151 f.write("source /boot/grub/addons.cfg\n")
1152 f.write("source /boot/grub/footer.cfg\n")
1156 def glob_and_copy(filepattern, dst):
1157 """Glob on specified filepattern and copy the result to dst
1159 @filepattern: globbing pattern
1160 @dst: target directory
1162 for name in glob.glob(filepattern):
1163 copy_if_exist(name, dst)
1166 def search_and_copy(filename, search_path, dst):
1167 """Search for the specified filename at searchpath and copy it to dst
1169 @filename: filename to look for
1170 @search_path: base search file
1171 @dst: destionation to copy the file to
1173 file_location = search_file(filename, search_path)
1174 copy_if_exist(file_location, dst)
1177 def copy_if_exist(filename, dst):
1178 """Copy filename to dst if filename is set.
1180 @filename: a filename
1183 if filename and (os.path.isfile(filename) or os.path.isdir(filename)):
1184 exec_rsync(filename, dst)
1187 def copy_bootloader_files(iso_mount, target, grml_flavour):
1188 """Copy grml's bootloader files to a given target
1190 @iso_mount: path where a grml ISO is mounted on
1191 @target: path where grml's main files should be copied to
1192 @grml_flavour: name of the current processed grml_flavour
1195 syslinux_target = target + "/boot/syslinux/"
1196 execute(mkdir, syslinux_target)
1198 grub_target = target + "/boot/grub/"
1199 execute(mkdir, grub_target)
1201 logo = search_file("logo.16", iso_mount, required=True)
1202 exec_rsync(logo, syslinux_target + "logo.16")
1204 bootx64_efi = search_file("bootx64.efi", iso_mount)
1206 mkdir(target + "/efi/boot/")
1207 exec_rsync(bootx64_efi, target + "/efi/boot/bootx64.efi")
1209 efi_img = search_file("efi.img", iso_mount)
1211 mkdir(target + "/boot/")
1212 exec_rsync(efi_img, target + "/boot/efi.img")
1213 handle_secure_boot(target, efi_img)
1215 execute(mkdir, target + "/conf/")
1216 glob_and_copy(iso_mount + "/conf/bootfile_*", target + "/conf/")
1218 for ffile in ["f%d" % number for number in range(1, 11)]:
1219 search_and_copy(ffile, iso_mount, syslinux_target + ffile)
1221 # avoid the "file is read only, overwrite anyway (y/n) ?" question
1222 # of mtools by syslinux ("mmove -D o -D O s:/ldlinux.sys $target_file")
1223 if os.path.isfile(syslinux_target + "ldlinux.sys"):
1224 os.unlink(syslinux_target + "ldlinux.sys")
1226 (source_dir, name) = get_defaults_file(iso_mount, grml_flavour, "default.cfg")
1227 (source_dir, defaults_file) = get_defaults_file(iso_mount, grml_flavour, "grml.cfg")
1230 raise CriticalException(
1231 "file default.cfg could not be found.\n"
1232 "Note: this grml2usb version requires an ISO generated by grml-live >=0.9.24 ...\n"
1233 " ... either use grml releases >=2009.10 or switch to an older grml2usb version."
1236 if not os.path.exists(iso_mount + "/boot/grub/footer.cfg"):
1238 "Warning: Grml releases older than 2011.12 support only one flavour in grub."
1256 glob_and_copy(iso_mount + source_dir + expr, syslinux_target)
1258 for modules_dir in options.syslinuxlibs + SYSLINUX_LIBS:
1259 if os.path.isdir(modules_dir):
1260 for filename in glob.glob1(syslinux_target, "*.c32"):
1261 copy_if_exist(os.path.join(modules_dir, filename), syslinux_target)
1264 # copy the addons_*.cfg file to the new syslinux directory
1265 glob_and_copy(iso_mount + source_dir + "addon*.cfg", syslinux_target)
1268 "hidden.cfg", iso_mount + source_dir, syslinux_target + "new_" + "hidden.cfg"
1271 # copy all grub files from ISO
1272 glob_and_copy(iso_mount + "/boot/grub/*", grub_target)
1274 # finally (after all GRUB files have been installed) build static loopback.cfg
1275 build_loopbackcfg(target)
1278 def install_iso_files(grml_flavour, iso_mount, device, target):
1279 """Copy files from ISO to given target
1281 @grml_flavour: name of grml flavour the configuration should be generated for
1282 @iso_mount: path where a grml ISO is mounted on
1283 @device: device/partition where bootloader should be installed to
1284 @target: path where grml's main files should be copied to"""
1287 GRML_DEFAULT = GRML_DEFAULT or grml_flavour
1290 elif not options.bootloaderonly:
1291 logging.info("Copying files. This might take a while....")
1293 copy_system_files(grml_flavour, iso_mount, target)
1294 copy_grml_files(grml_flavour, iso_mount, target)
1295 except CriticalException as error:
1296 logging.critical("Execution failed: %s", error)
1299 if not options.skipaddons:
1300 if not search_file("addons", iso_mount):
1301 logging.info("Could not find addons, therefore not installing.")
1303 copy_addons(iso_mount, target)
1305 if not options.copyonly:
1306 copy_bootloader_files(iso_mount, target, grml_flavour)
1308 if not options.dryrun:
1309 handle_bootloader_config(grml_flavour, device, target)
1311 # make sure we sync filesystems before returning
1312 logging.info("Synching data (this might take a while)")
1313 proc = subprocess.Popen(["sync"])
1317 def get_device_from_partition(partition):
1319 partition_number = None
1320 if partition[-1].isdigit() and not RE_LOOP_DEVICE.match(partition):
1321 m = RE_P_PARTITION.match(partition) or RE_PARTITION.match(partition)
1324 partition_number = int(m.group(2)) - 1
1325 return (device, partition_number)
1328 def get_flavour(flavour_str):
1329 """Returns the flavour of a grml version string"""
1330 return re.match(r"[\w-]*", flavour_str).group()
1333 def identify_grml_flavour(mountpath):
1334 """Get name of grml flavour
1336 @mountpath: path where the grml ISO is mounted to
1337 @return: name of grml-flavour"""
1339 version_files = search_file("grml-version", mountpath, lst_return=True)
1341 if not version_files:
1342 if mountpath.startswith("/run/live/medium"):
1343 logging.critical("Error: could not find grml-version file.")
1345 "Looks like your system is running from RAM but required files are not available."
1348 "Please either boot without toram=... or use boot option toram instead of toram=..."
1351 logging.critical("Error: could not find grml-version file.")
1356 logging.debug("version_files = %s", version_files)
1357 for version_file in version_files:
1360 tmpfile = open(version_file, "r")
1361 for line in tmpfile.readlines():
1362 flavours.append(get_flavour(line))
1370 def get_bootoptions(grml_flavour):
1371 """Returns bootoptions for specific flavour
1373 @grml_flavour: name of the grml_flavour
1375 # do NOT write "None" in kernel cmdline
1376 if not options.bootoptions:
1379 bootopt = " ".join(options.bootoptions)
1380 bootopt = bootopt.replace("%flavour", grml_flavour)
1384 def handle_grub_config(grml_flavour, device, target):
1385 """Main handler for generating grub (v1 and v2) configuration
1387 @grml_flavour: name of grml flavour the configuration should be generated for
1388 @device: device/partition where grub should be installed to
1389 @target: path of grub's configuration files"""
1393 logging.debug("Updating grub configuration")
1395 grub_target = target + "/boot/grub/"
1397 bootid_re = re.compile(r"bootid=[\w_-]+")
1398 live_media_path_re = re.compile(r"live-media-path=[\w_/-]+")
1400 bootopt = get_bootoptions(grml_flavour)
1403 option_re = re.compile(r"(.*/boot/.*(linux26|vmlinuz).*)")
1405 if options.removeoption:
1406 for regex in options.removeoption:
1407 remove_regexes.append(re.compile(regex))
1409 shortname = get_shortname(grml_flavour)
1410 for filename in glob.glob(grub_target + "*.cfg"):
1411 for line in fileinput.input(filename, inplace=1):
1412 line = line.rstrip("\r\n")
1413 if option_re.search(line):
1414 line = bootid_re.sub("", line)
1415 if shortname in filename:
1416 line = live_media_path_re.sub("", line)
1417 line = line.rstrip() + " live-media-path=/live/%s/ " % (
1421 line = line.replace(" {} ".format(bootopt.strip()), " ")
1422 if line.endswith(bootopt):
1423 line = line[: -len(bootopt)]
1424 line = line.rstrip() + r" bootid=%s %s " % (UUID, bootopt)
1425 for regex in remove_regexes:
1426 line = regex.sub(" ", line)
1431 def initial_syslinux_config(target):
1432 """Generates initial syslinux configuration
1434 @target path of syslinux's configuration files"""
1436 target = target + "/"
1437 filename = target + "grmlmain.cfg"
1438 if os.path.isfile(target + "grmlmain.cfg"):
1440 data = open(filename, "w")
1441 data.write(generate_main_syslinux_config())
1444 filename = target + "hiddens.cfg"
1445 data = open(filename, "w")
1446 data.write("include hidden.cfg\n")
1450 def add_entry_if_not_present(filename, entry):
1451 """Write entry into filename if entry is not already in the file
1453 @filename: name of the file
1454 @entry: data to write to the file
1456 data = open(filename, "a+")
1467 def get_flavour_filename(flavour):
1468 """Generate a iso9960 save filename out of the specified flavour
1470 @flavour: grml flavour
1472 return flavour.replace("-", "_")
1475 def adjust_syslinux_bootoptions(src, flavour):
1476 """Adjust existing bootoptions of specified syslinux config to
1477 grml2usb specific ones, e.g. change the location of the kernel...
1479 @src: config file to alter
1480 @flavour: grml flavour
1483 append_re = re.compile(r"^(\s*append.*/boot/.*)$", re.I)
1484 # flavour_re = re.compile("(label.*)(grml\w+)")
1485 default_re = re.compile(r"(default.cfg)")
1486 bootid_re = re.compile(r"bootid=[\w_-]+")
1487 live_media_path_re = re.compile(r"live-media-path=[\w_/-]+")
1489 bootopt = get_bootoptions(flavour)
1493 if options.removeoption:
1494 option_re = re.compile(r"/boot/.*/(initrd.gz|initrd.img)")
1496 for regex in options.removeoption:
1497 regexe.append(re.compile(r"%s" % regex))
1499 for line in fileinput.input(src, inplace=1):
1500 # line = flavour_re.sub(r'\1 %s-\2' % flavour, line)
1501 line = default_re.sub(r"%s-\1" % flavour, line)
1502 line = bootid_re.sub("", line)
1503 line = live_media_path_re.sub("", line)
1504 line = append_re.sub(r"\1 live-media-path=/live/%s/ " % flavour, line)
1505 line = append_re.sub(r"\1 boot=live %s " % bootopt, line)
1506 line = append_re.sub(r"\1 %s=%s " % ("bootid", UUID), line)
1507 if option_re and option_re.search(line):
1508 for regex in regexe:
1509 line = regex.sub(" ", line)
1510 sys.stdout.write(line)
1514 def adjust_labels(src, replacement):
1515 """Adjust the specified labels in the syslinux config file src with
1516 specified replacement
1518 label_re = re.compile(r"^(\s*label\s*) ([a-zA-Z0-9_-]+)", re.I)
1519 for line in fileinput.input(src, inplace=1):
1520 line = label_re.sub(replacement, line)
1521 sys.stdout.write(line)
1525 def add_syslinux_entry(filename, grml_flavour):
1526 """Add includes for a specific grml_flavour to the specified filename
1528 @filename: syslinux config file
1529 @grml_flavour: grml flavour to add
1532 entry_filename = "option_%s.cfg" % grml_flavour
1533 entry = "include %s\n" % entry_filename
1535 add_entry_if_not_present(filename, entry)
1536 path = os.path.dirname(filename)
1538 data = open(path + "/" + entry_filename, "w")
1539 data.write(generate_flavour_specific_syslinux_config(grml_flavour))
1543 def modify_filenames(grml_flavour, target, filenames):
1544 """Replace the standard filenames with the new ones
1546 @grml_flavour: grml-flavour strin
1547 @target: directory where the files are located
1548 @filenames: list of filenames to alter
1550 grml_filename = get_flavour_filename(grml_flavour)
1551 for filename in filenames:
1552 old_filename = "%s/%s" % (target, filename)
1553 new_filename = "%s/%s_%s" % (target, grml_filename, filename)
1554 os.rename(old_filename, new_filename)
1557 def remove_default_entry(filename):
1558 """Remove the default entry from specified syslinux file
1560 @filename: syslinux config file
1562 default_re = re.compile(r"^(\s*menu\s*default\s*)$", re.I)
1563 for line in fileinput.input(filename, inplace=1):
1564 if default_re.match(line):
1566 sys.stdout.write(line)
1570 def handle_syslinux_config(grml_flavour, target):
1571 """Main handler for generating syslinux configuration
1573 @grml_flavour: name of grml flavour the configuration should be generated for
1574 @target: path of syslinux's configuration files"""
1576 logging.debug("Generating syslinux configuration")
1577 syslinux_target = target + "/boot/syslinux/"
1578 # should be present via copy_bootloader_files(), but make sure it exits:
1579 execute(mkdir, syslinux_target)
1580 syslinux_cfg = syslinux_target + "syslinux.cfg"
1582 # install main configuration only *once*, no matter how many ISOs we have:
1583 syslinux_config_file = open(syslinux_cfg, "w")
1584 syslinux_config_file.write("timeout 300\n")
1585 syslinux_config_file.write("include vesamenu.cfg\n")
1586 syslinux_config_file.close()
1588 prompt_name = open(syslinux_target + "promptname.cfg", "w")
1589 prompt_name.write("menu label S^yslinux prompt\n")
1592 initial_syslinux_config(syslinux_target)
1593 flavour_filename = get_flavour_filename(grml_flavour)
1595 if search_file("default.cfg", syslinux_target):
1596 modify_filenames(grml_flavour, syslinux_target, ["grml.cfg", "default.cfg"])
1598 filename = search_file("new_hidden.cfg", syslinux_target)
1600 # process hidden file
1601 if not search_file("hidden.cfg", syslinux_target):
1602 new_hidden = syslinux_target + "hidden.cfg"
1603 os.rename(filename, new_hidden)
1604 adjust_syslinux_bootoptions(new_hidden, grml_flavour)
1606 new_hidden_file = "%s/%s_hidden.cfg" % (syslinux_target, flavour_filename)
1607 os.rename(filename, new_hidden_file)
1608 adjust_labels(new_hidden_file, r"\1 %s-\2" % grml_flavour)
1609 adjust_syslinux_bootoptions(new_hidden_file, grml_flavour)
1610 entry = "include %s_hidden.cfg\n" % flavour_filename
1611 add_entry_if_not_present("%s/hiddens.cfg" % syslinux_target, entry)
1613 new_default = "%s_default.cfg" % (flavour_filename)
1614 entry = "include %s\n" % new_default
1615 defaults_file = "%s/defaults.cfg" % syslinux_target
1616 new_default_with_path = "%s/%s" % (syslinux_target, new_default)
1617 new_grml_cfg = "%s/%s_grml.cfg" % (syslinux_target, flavour_filename)
1619 if os.path.isfile(defaults_file):
1621 # remove default menu entry in menu
1622 remove_default_entry(new_default_with_path)
1624 # adjust all labels for additional isos
1625 adjust_labels(new_default_with_path, r"\1 %s" % grml_flavour)
1626 adjust_labels(new_grml_cfg, r"\1 %s-\2" % grml_flavour)
1628 # always adjust bootoptions
1629 adjust_syslinux_bootoptions(new_default_with_path, grml_flavour)
1630 adjust_syslinux_bootoptions(new_grml_cfg, grml_flavour)
1632 add_entry_if_not_present("%s/defaults.cfg" % syslinux_target, entry)
1634 add_syslinux_entry("%s/additional.cfg" % syslinux_target, flavour_filename)
1637 def handle_secure_boot(target, efi_img):
1638 """Provide secure boot support by extracting files from /boot/efi.img
1640 @target: path where grml's main files should be copied to
1641 @efi_img: path to the efi.img file that includes the files for secure boot
1644 mkdir(target + "/efi/boot/")
1645 efi_mountpoint = tempfile.mkdtemp(
1646 prefix="grml2usb", dir=os.path.abspath(options.tmpdir)
1648 logging.debug("efi_mountpoint = %s" % efi_mountpoint)
1649 register_tmpfile(efi_mountpoint)
1653 "mount(%s, %s, ['-o', 'ro', '-t', 'vfat']" % (efi_img, efi_mountpoint)
1655 mount(efi_img, efi_mountpoint, ["-o", "ro", "-t", "vfat"])
1656 except CriticalException as error:
1657 logging.critical("Fatal: %s", error)
1660 grub_cfg = search_file("grub.cfg", efi_mountpoint + "/boot/grub/")
1661 logging.debug("grub_cfg = %s" % grub_cfg)
1664 "No /boot/grub/grub.cfg found inside EFI image, looks like Secure Boot support is missing."
1667 mkdir(target + "/boot/grub/x86_64-efi/")
1669 "exec_rsync(%s, %s + '/boot/grub/x86_64-efi/grub.cfg')" % (grub_cfg, target)
1671 exec_rsync(grub_cfg, target + "/boot/grub/x86_64-efi/grub.cfg")
1674 "exec_rsync(%s + '/EFI/BOOT/grubx64.efi', %s + '/efi/boot/grubx64.efi')'"
1675 % (efi_mountpoint, target)
1678 efi_mountpoint + "/EFI/BOOT/grubx64.efi", target + "/efi/boot/grubx64.efi"
1681 # NOTE - we're overwriting /efi/boot/bootx64.efi from copy_bootloader_files here
1683 "exec_rsync(%s + '/EFI/BOOT/bootx64.efi', %s + '/efi/boot/bootx64.efi')'"
1684 % (efi_mountpoint, target)
1687 efi_mountpoint + "/EFI/BOOT/bootx64.efi", target + "/efi/boot/bootx64.efi"
1691 unmount(efi_mountpoint, "")
1692 logging.debug("Unmounted %s" % efi_mountpoint)
1693 os.rmdir(efi_mountpoint)
1694 logging.debug("Removed directory %s" % efi_mountpoint)
1696 logging.critical("RuntimeError while umount %s" % efi_mountpoint)
1700 def handle_bootloader_config(grml_flavour, device, target):
1701 """Main handler for generating bootloader's configuration
1703 @grml_flavour: name of grml flavour the configuration should be generated for
1704 @device: device/partition where bootloader should be installed to
1705 @target: path of bootloader's configuration files"""
1708 UUID = get_uuid(target)
1709 if options.skipsyslinuxconfig:
1710 logging.info("Skipping generation of syslinux configuration as requested.")
1713 handle_syslinux_config(grml_flavour, target)
1714 except CriticalException as error:
1715 logging.critical("Fatal: %s", error)
1718 if options.skipgrubconfig:
1719 logging.info("Skipping generation of grub configuration as requested.")
1722 handle_grub_config(grml_flavour, device, target)
1723 except CriticalException as error:
1724 logging.critical("Fatal: %s", error)
1728 def install(image, device):
1729 """Install a grml image to the specified device
1731 @image: directory or is file
1732 @device: partition or directory to install the device
1734 iso_mountpoint = image
1735 remove_image_mountpoint = False
1736 if os.path.isdir(image):
1737 if options.force or os.path.exists(os.path.join(image, "live")):
1738 logging.info("Using %s as install base", image)
1741 "%s does not look like a Grml system. "
1742 "Do you really want to use this image? y/N " % image
1744 if q.lower() == "y":
1745 logging.info("Using %s as install base", image)
1747 logging.info("Skipping install base %s", image)
1749 logging.info("Using ISO %s", image)
1750 iso_mountpoint = tempfile.mkdtemp(
1751 prefix="grml2usb", dir=os.path.abspath(options.tmpdir)
1753 register_tmpfile(iso_mountpoint)
1754 remove_image_mountpoint = True
1756 mount(image, iso_mountpoint, ["-o", "loop,ro", "-t", "iso9660"])
1757 except CriticalException as error:
1758 logging.critical("Fatal: %s", error)
1762 install_grml(iso_mountpoint, device)
1764 if remove_image_mountpoint:
1766 remove_mountpoint(iso_mountpoint)
1767 except CriticalException:
1772 def install_grml(mountpoint, device):
1773 """Main logic for copying files of the currently running Grml system.
1775 @mountpoint: directory where currently running live system resides (usually /run/live/medium)
1776 @device: partition where the specified ISO should be installed to"""
1778 device_mountpoint = device
1779 if os.path.isdir(device):
1780 logging.info("Specified device is a directory, therefore not mounting.")
1781 remove_device_mountpoint = False
1783 device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
1784 register_tmpfile(device_mountpoint)
1785 remove_device_mountpoint = True
1788 mount(device, device_mountpoint, ["-o", "utf8,iocharset=iso8859-1"])
1789 except CriticalException:
1790 mount(device, device_mountpoint, "")
1792 grml_flavours = identify_grml_flavour(mountpoint)
1793 for flavour in set(grml_flavours):
1795 logging.warning("No valid flavour found, please check your iso")
1796 logging.info('Identified grml flavour "%s".', flavour)
1797 install_iso_files(flavour, mountpoint, device, device_mountpoint)
1798 GRML_FLAVOURS.add(flavour)
1800 if remove_device_mountpoint:
1801 remove_mountpoint(device_mountpoint)
1804 def remove_mountpoint(mountpoint):
1805 """remove a registered mountpoint"""
1808 unmount(mountpoint, "")
1809 if os.path.isdir(mountpoint):
1810 os.rmdir(mountpoint)
1811 unregister_tmpfile(mountpoint)
1812 except CriticalException:
1817 def handle_mbr(device):
1818 """Main handler for installing master boot record (MBR)
1820 @device: device where the MBR should be installed to"""
1823 logging.info("Would install MBR")
1826 mbr_device, partition_number = get_device_from_partition(device)
1827 if partition_number is None:
1828 logging.warning("Could not detect partition number, not activating partition")
1830 # if we get e.g. /dev/loop1 as device we don't want to put the MBR
1831 # into /dev/loop of course, therefore use /dev/loop1 as mbr_device
1832 if mbr_device == "/dev/loop":
1835 "Detected loop device - using %s as MBR device therefore", mbr_device
1838 mbrcode = GRML2USB_BASE + "/mbr/mbrldr"
1839 if options.syslinuxmbr:
1842 "/usr/lib/syslinux/mbr.bin",
1843 "/usr/lib/syslinux/bios/mbr.bin",
1844 "/usr/share/syslinux/mbr.bin",
1846 for mbrpath in mbr_locations:
1847 if os.path.isfile(mbrpath):
1852 str_locations = " or ".join(['"%s"' % x for x in mbr_locations])
1853 logging.error("Cannot find syslinux MBR, install it at %s)", str_locations)
1854 raise CriticalException(
1855 "syslinux MBR can not be found at %s." % str_locations
1857 elif options.mbrmenu:
1858 mbrcode = GRML2USB_BASE + "/mbr/mbrldr"
1861 install_mbr(mbrcode, mbr_device, partition_number, True)
1862 except (IOError, Exception) as error:
1863 logging.critical("Execution failed: %s", error)
1867 def handle_vfat(device):
1868 """Check for FAT specific settings and options
1870 @device: device that should checked / formated"""
1872 # make sure we have mkfs.vfat available
1874 if not which("mkfs.vfat") and not options.copyonly and not options.dryrun:
1875 logging.critical("Sorry, mkfs.vfat not available. Exiting.")
1876 logging.critical("Please make sure to install dosfstools.")
1880 print("Forcing mkfs.fat16 on %s as requested via option --force." % device)
1882 # make sure the user is aware of what he is doing
1884 "Are you sure you want to format the specified partition with fat16? y/N "
1886 if f == "y" or f == "Y":
1888 "Note: you can skip this question using the option --force"
1894 except CriticalException as error:
1895 logging.critical("Execution failed: %s", error)
1898 # check for vfat filesystem
1899 if device is not None and not os.path.isdir(device) and options.syslinux:
1901 check_for_fat(device)
1902 except CriticalException as error:
1903 logging.critical("Execution failed: %s", error)
1906 if options.skipusbcheck:
1908 "Not checking for removable USB device as requested via option --skip-usb-check."
1913 not os.path.isdir(device)
1914 and not check_for_usbdevice(device)
1915 and not options.force
1918 "Warning: the specified device %s does not look like a removable usb device."
1921 f = input("Do you really want to continue? y/N ")
1922 if f.lower() != "y":
1926 def handle_compat_warning(device):
1927 """Backwards compatible checks
1929 @device: device that should be checked"""
1931 # make sure we can replace old grml2usb script and warn user when using old way of life:
1933 device.startswith("/mnt/external")
1934 or device.startswith("/mnt/usb")
1935 and not options.force
1937 print("Warning: the semantics of grml2usb has changed.")
1938 print("Instead of using grml2usb /path/to/iso %s you might" % device)
1939 print("want to use grml2usb /path/to/iso /dev/... instead.")
1940 print("Please check out the grml2usb manpage for details.")
1941 f = input("Do you really want to continue? y/N ")
1942 if f.lower() != "y":
1946 def handle_logging():
1947 """Log handling and configuration"""
1949 if options.verbose and options.quiet:
1950 parser.error("please use either verbose (--verbose) or quiet (--quiet) option")
1952 FORMAT = "%(message)s"
1954 FORMAT = "%(asctime)-15s %(message)s"
1955 logging.basicConfig(level=logging.DEBUG, format=FORMAT)
1957 logging.basicConfig(level=logging.CRITICAL, format=FORMAT)
1959 logging.basicConfig(level=logging.INFO, format=FORMAT)
1962 def handle_bootloader(device):
1963 """wrapper for installing bootloader
1965 @device: device where bootloader should be installed to"""
1967 # Install bootloader only if not using the --copy-only option
1968 if options.copyonly:
1970 "Not installing bootloader and its files as requested via option copyonly."
1972 elif os.path.isdir(device):
1973 logging.info("Not installing bootloader as %s is a directory.", device)
1975 install_bootloader(device)
1978 def check_options(opts):
1979 """Check compatibility of provided user opts
1981 @opts option dict from OptionParser
1983 if opts.grubmbr and not opts.grub:
1984 raise CriticalException("--grub-mbr requires --grub option.")
1986 if opts.copyonly and opts.grub:
1987 raise CriticalException("Cannot use --copy-only and --grub at the same time.")
1990 def check_programs():
1991 """check if all needed programs are installed"""
1994 GRUB_INSTALL = which("grub-install") or which("grub2-install")
1995 if not GRUB_INSTALL:
1997 "Fatal: grub-install not available (please install the "
1998 "grub package or drop the --grub option)"
2002 if options.syslinux:
2003 if not which("syslinux"):
2005 "Fatal: syslinux not available (please install the "
2006 "syslinux package or use the --grub option)"
2010 if not which("rsync"):
2011 logging.critical("Fatal: rsync not available, can not continue - sorry.")
2016 """Runs modprobe loop and throws away its output"""
2017 if not which("modprobe"):
2018 logging.critical("Fatal: modprobe not available, can not continue - sorry.")
2019 logging.critical("Hint: is /sbin missing in PATH?")
2022 proc = subprocess.Popen(
2023 ["modprobe", "loop"], stdout=subprocess.PIPE, stderr=subprocess.PIPE
2029 """Main invocation"""
2033 print(os.path.basename(sys.argv[0]) + " " + PROG_VERSION)
2037 parser.error("invalid usage")
2042 # make sure we have the appropriate permissions
2045 check_options(options)
2049 logging.info("Executing grml2usb version %s", PROG_VERSION)
2052 logging.info("Running in simulation mode as requested via option dry-run.")
2056 # specified arguments
2057 device = os.path.realpath(args[len(args) - 1])
2058 isos = args[0 : len(args) - 1]
2060 if not os.path.isdir(device):
2061 if device[-1:].isdigit():
2062 if int(device[-1:]) > 4 or device[-2:].isdigit():
2064 "Warning: installing on partition number >4, booting *might* fail depending on your system."
2067 # provide upgrade path
2068 handle_compat_warning(device)
2070 if not options.skipbootflag:
2071 check_boot_flag(device)
2073 # check for vfat partition
2076 # main operation (like installing files)
2078 install(iso, device)
2081 is_superfloppy = not device[-1:].isdigit()
2083 logging.info("Detected superfloppy format - not installing MBR")
2085 if not options.skipmbr and not os.path.isdir(device) and not is_superfloppy:
2088 handle_bootloader(device)
2091 "Note: grml flavour %s was installed as the default booting system.",
2095 for flavour in GRML_FLAVOURS:
2097 "Note: you can boot flavour %s using '%s' on the commandline.",
2102 # finally be polite :)
2104 "Finished execution of grml2usb (%s). Have fun with your Grml system.",
2108 except Exception as error:
2109 logging.critical("Fatal: %s", str(error))
2111 logging.exception("Exception:")
2115 if __name__ == "__main__":
2118 except KeyboardInterrupt:
2119 logging.info("Received KeyboardInterrupt")
2122 # END OF FILE ##################################################################
2123 # vim:foldmethod=indent expandtab ai ft=python tw=120 fileencoding=utf-8