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
70 # pylint: disable-msg=W0613
72 "Note: the --syslinux option is deprecated as syslinux "
73 "is grml2usb's default. Continuing anyway.\n"
75 setattr(opt_parser.values, option.dest, True)
78 # if grub option is set, unset syslinux option
79 def grub_option(option, opt, opt_parser):
80 """A helper function adjusting other option values
82 # pylint: disable-msg=W0613
83 setattr(opt_parser.values, option.dest, True)
84 setattr(opt_parser.values, "syslinux", False)
88 USAGE = "Usage: %prog [options] <[ISO[s] | /run/live/medium]> </dev/sdX#>\n\
90 %prog installs Grml ISO[s] to an USB device to be able to boot from it.\n\
91 Make sure you have at least one Grml ISO or a running Grml system (/run/live/medium),\n\
92 grub or syslinux and root access.\n\
94 Run %prog --help for usage hints, further information via: man grml2usb"
96 # pylint: disable-msg=C0103
97 # pylint: disable-msg=W0603
98 parser = OptionParser(usage=USAGE)
104 help="use specified bootoptions as default",
108 dest="bootloaderonly",
110 help="do not copy files but just install a bootloader",
116 help="copy files only but do not install bootloader",
119 "--dry-run", dest="dryrun", action="store_true", help="avoid executing commands"
125 help="format specified partition with FAT16",
131 help="force any actions requiring manual interaction",
137 callback=grub_option,
138 help="install grub bootloader instead of (default) syslinux",
144 help="install grub into MBR instead of (default) PBR",
150 help="enable interactive boot menu in MBR",
156 help="do not output anything but just errors on console",
159 "--remove-bootoption",
162 help="regex for removing existing bootoptions",
168 help="enforce read-write mode on involved block devices",
174 help="do not install /boot/addons/ files",
180 help="do not try to check whether the destination has the boot flag set",
183 "--skip-grub-config",
184 dest="skipgrubconfig",
186 help="skip generation of grub configuration files",
192 help="do not install a master boot record (MBR) on the device",
195 "--skip-syslinux-config",
196 dest="skipsyslinuxconfig",
198 help="skip generation of syslinux configuration files",
204 help="skip check to verify whether given device is removable",
211 callback=syslinux_warning,
212 help="install syslinux bootloader (deprecated as it's the default)",
218 help="install syslinux master boot record (MBR) instead of default",
225 help="syslinux modules directory path",
231 help="directory to be used for temporary files",
234 "--verbose", dest="verbose", action="store_true", help="enable verbose mode"
241 help="display version and exit",
243 (options, args) = parser.parse_args()
246 GRML2USB_BASE = "/usr/share/grml2usb"
247 if not os.path.isdir(GRML2USB_BASE):
248 GRML2USB_BASE = os.path.dirname(os.path.realpath(__file__))
251 class HodorException(Exception):
252 """Throw exception if the exact error is not known and not fatal.
254 @Exception: message"""
257 class CriticalException(Exception):
258 """Throw critical exception if the exact error is not known but fatal.
260 @Exception: message"""
263 class VerifyException(Exception):
264 """Throw critical exception if there is an fatal error when verifying something.
266 @Exception: message"""
270 """Cleanup function to make sure there aren't any mounted devices left behind.
273 def del_failed(_fn, path, _exc):
274 logging.warning("Deletion of %s failed in temporary folder", path)
276 logging.info("Cleaning up before exiting...")
277 proc = subprocess.Popen(["sync"])
280 for device in MOUNTED.copy():
283 logging.debug("Unmounted %s" % device)
285 logging.debug("RuntimeError while umount %s, ignoring" % device)
287 for tmppath in TMPFILES.copy():
289 if os.path.isdir(tmppath) and not os.path.islink(tmppath):
290 # symbolic links to directories are ignored
291 # without the check it will throw an OSError
292 shutil.rmtree(tmppath, onerror=del_failed)
293 logging.debug("temporary directory %s deleted" % tmppath)
294 unregister_tmpfile(tmppath)
297 logging.debug("temporary file %s deleted" % tmppath)
298 unregister_tmpfile(tmppath)
300 msg = "RuntimeError while removing temporary %s, ignoring"
301 logging.debug(msg % tmppath)
304 def register_tmpfile(path):
312 def unregister_tmpfile(path):
314 remove registered tmpfile
318 TMPFILES.remove(path)
323 def register_mountpoint(target):
324 """register specified target in a set() for handling clean exiting
326 @target: destination target of mountpoint
332 def unregister_mountpoint(target):
333 """unregister specified target in a set() for handling clean exiting
335 @target: destination target of mountpoint
338 if target in MOUNTED:
339 MOUNTED.remove(target)
342 def get_function_name(obj):
343 """Helper function for use in execute() to retrieve name of a function
345 @obj: the function object
347 if not (isroutine(obj) or isclass(obj)):
349 return obj.__module__ + "." + obj.__name__
353 if not options.rwblockdev:
356 logging.debug("executing: blockdev --setrw %s", device)
357 proc = subprocess.Popen(["blockdev", "--setrw", device])
359 if proc.returncode != 0:
360 raise Exception("error executing blockdev on %s" % device)
363 def execute(f, *exec_arguments):
364 """Wrapper for executing a command. Either really executes
365 the command (default) or when using --dry-run commandline option
366 just displays what would be executed."""
367 # usage: execute(subprocess.Popen, (["ls", "-la"]))
369 # pylint: disable-msg=W0141
371 "dry-run only: %s(%s)",
372 get_function_name(f),
373 ", ".join(map(repr, exec_arguments)),
376 # pylint: disable-msg=W0142
377 return f(*exec_arguments)
381 """Check whether a given file can be executed
383 @fpath: full path to file
385 return os.path.exists(fpath) and os.access(fpath, os.X_OK)
389 """Check whether a given program is available in PATH
391 @program: name of executable"""
392 fpath = os.path.split(program)[0]
397 for path in os.environ["PATH"].split(os.pathsep):
398 exe_file = os.path.join(path, program)
405 def get_defaults_file(iso_mount, flavour, name):
406 """get the default file for syslinux
408 bootloader_dirs = ["/boot/isolinux/", "/boot/syslinux/"]
409 for directory in bootloader_dirs:
410 for name in name, "%s_%s" % (get_flavour_filename(flavour), name):
411 if os.path.isfile(iso_mount + directory + name):
412 return (directory, name)
418 search_path="/bin" + os.pathsep + "/usr/bin",
422 """Given a search path, find file
424 @filename: name of file to search for
425 @search_path: path where searching for the specified filename
426 @lst_return: return list of matching files instead one file"""
427 paths = search_path.split(os.pathsep)
428 current_dir = "" # make pylint happy :)
432 """Helper function ffor testing if specified file exists in cwd
434 @cwd: current working directory
436 return os.path.exists(os.path.join(cwd, filename))
440 if match_file(current_dir):
441 retval.append(os.path.abspath(os.path.join(current_dir, filename)))
444 for current_dir, _directories, _files in os.walk(path):
445 if match_file(current_dir):
446 retval.append(os.path.abspath(os.path.join(current_dir, filename)))
450 if required and not retval:
451 raise CriticalException(
452 "Required file %s not found in %s" % (filename, search_path)
463 def check_uid_root():
464 """Check for root permissions"""
465 if not os.geteuid() == 0:
466 raise CriticalException("please run this script with uid 0 (root).")
469 # for usage inside check_boot_flag
470 def get_partition_for_path(path):
473 boot_dev, x = get_device_from_partition(path)
475 d = parted.getDevice(boot_dev)
476 disk = parted.Disk(d)
477 return disk.getPartitionByPath(path)
480 def check_boot_flag(device):
481 if os.path.isdir(device):
483 "Device %s is a directory, skipping check for boot flag." % device
487 boot_dev, x = get_device_from_partition(device)
489 logging.info("Checking for boot flag")
493 part = get_partition_for_path(device)
495 raise HodorException("parted could not find partition")
496 if part.getFlag(parted.PARTITION_BOOT):
497 logging.debug("boot flag is enabled on %s" % device)
500 logging.debug("boot flag is NOT enabled on %s" % device)
501 raise VerifyException(
502 "Device %s does not have the boot flag set. "
503 "Please enable it to be able to boot." % device
506 raise VerifyException(
507 "Could not import parted to verify boot flag on %s, please make sure python3-parted is installed."
512 def mkfs_fat16(device):
513 """Format specified device with VFAT/FAT16 filesystem.
515 @device: partition that should be formated"""
518 logging.info("Would execute mkfs.vfat -F 16 %s now.", device)
521 logging.info("Formating partition with fat16 filesystem")
522 logging.debug("mkfs.vfat -F 16 %s", device)
523 proc = subprocess.Popen(["mkfs.vfat", "-F", "16", device])
525 if proc.returncode != 0:
526 raise CriticalException("error executing mkfs.vfat")
529 def generate_main_syslinux_config():
530 """Generate main configuration for use in syslinux.cfg"""
534 menu label Default boot modes:
543 menu label Additional boot entries for:
545 include additional.cfg
552 include promptname.cfg
555 Jump to old style isolinux prompt
556 featuring further information
557 regarding available boot options.
565 def generate_flavour_specific_syslinux_config(grml_flavour):
566 """Generate flavour specific configuration for use in syslinux.cfg
568 @grml_flavour: name of grml flavour the configuration should be generated for"""
571 menu begin grml %(grml_flavour)s
572 menu title %(display_name)s
574 menu label ^Back to main menu...
577 # include config for boot parameters from disk
578 include %(grml_flavour)s_grml.cfg
582 "grml_flavour": grml_flavour,
583 "display_name": get_flavour_filename(grml_flavour),
587 def install_grub(device):
588 """Install grub on specified device.
590 @mntpoint: mountpoint of device where grub should install its files to
591 @device: partition where grub should be installed to"""
595 "Would execute grub-install [--root-directory=mount_point] %s now.", device
598 device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
599 register_tmpfile(device_mountpoint)
601 # If using --grub-mbr then make sure we install grub in MBR instead of PBR
603 logging.debug("Using option --grub-mbr ...")
604 grub_device, x = get_device_from_partition(device)
609 mount(device, device_mountpoint, "")
611 logging.info("Installing grub as bootloader")
612 for opt in ["--", "--force"]:
616 "%s --recheck --no-floppy --target=i386-pc --root-directory=%s %s %s",
622 proc = subprocess.Popen(
628 "--root-directory=%s" % device_mountpoint,
632 stdout=open(os.devnull, "r+"),
635 if proc.returncode == 0:
638 if proc.returncode != 0:
639 # raise Exception("error executing grub-install")
641 "Fatal: error executing grub-install "
642 "(please check the grml2usb FAQ or drop the --grub option)"
645 "Note: if using grub2 consider using "
646 "the --grub-mbr option as grub considers PBR problematic."
650 except CriticalException as error:
651 logging.critical("Fatal: %s", error)
655 unmount(device_mountpoint, "")
656 os.rmdir(device_mountpoint)
657 unregister_tmpfile(device_mountpoint)
660 def install_syslinux(device):
661 """Install syslinux on specified device.
663 @device: partition where syslinux should be installed to"""
666 logging.info("Would install syslinux as bootloader on %s", device)
671 # syslinux -d boot/isolinux /dev/sdb1
672 logging.info("Installing syslinux as bootloader")
673 logging.debug("syslinux -d boot/syslinux %s", device)
674 proc = subprocess.Popen(["syslinux", "-d", "boot/syslinux", device])
676 if proc.returncode != 0:
677 raise CriticalException(
678 "Error executing syslinux (either try --fat16 or use grub?)"
682 def install_bootloader(device):
683 """Install bootloader on specified device.
685 @device: partition where bootloader should be installed to"""
687 # by default we use grub, so install syslinux only on request
691 except CriticalException as error:
692 logging.critical("Fatal: %s", error)
697 install_syslinux(device)
698 except CriticalException as error:
699 logging.critical("Fatal: %s", error)
704 def install_mbr(mbrtemplate, device, partition, ismirbsdmbr=True):
705 """install 'mbr' master boot record (MBR) on a device
707 Retrieve the partition table from "device", install an MBR from the
708 "mbrtemplate" file, set the "partition" (0..3) active, and install the
709 result back to "device".
711 @mbrtemplate: default MBR file (must be a valid MBR file of at least 440
712 (or 439 if ismirbsdmbr) bytes)
714 @device: name of a file assumed to be a hard disc (or USB stick) image, or
715 something like "/dev/sdb"
717 @partition: must be a number between 0 and 3, inclusive
719 @ismirbsdmbr: if true then ignore the active flag, set the mirbsdmbr
720 specific flag to 0/1/2/3 and set the MBR's default value accordingly. If
721 false then leave the mirbsdmbr specific flag set to FFh, set all
722 active flags to 0 and set the active flag of the partition to 80h. Note:
723 behaviour of mirbsdmbr: if flag = 0/1/2/3 then use it, otherwise search for
726 logging.info("Installing default MBR")
728 if not os.path.isfile(mbrtemplate):
730 "Error installing MBR (either try --syslinux-mbr or "
731 'install missing file "%s"?)',
734 raise CriticalException("%s can not be read." % mbrtemplate)
736 if partition is not None and ((partition < 0) or (partition > 3)):
737 logging.warning("Cannot activate partition %d", partition)
745 tmpf = tempfile.NamedTemporaryFile()
747 logging.debug("executing: dd if='%s' of='%s' bs=512 count=1", device, tmpf.name)
748 proc = subprocess.Popen(
749 ["dd", "if=%s" % device, "of=%s" % tmpf.name, "bs=512", "count=1"],
750 stderr=open(os.devnull, "r+"),
753 if proc.returncode != 0:
754 raise Exception("error executing dd (first run)")
757 "executing: dd if=%s of=%s bs=%s count=1 conv=notrunc",
762 proc = subprocess.Popen(
765 "if=%s" % mbrtemplate,
771 stderr=open(os.devnull, "r+"),
774 if proc.returncode != 0:
775 raise Exception("error executing dd (second run)")
777 mbrcode = tmpf.file.read(512)
778 if len(mbrcode) < 512:
779 raise EOFError("MBR size (%d) < 512" % len(mbrcode))
781 if partition is not None:
785 + chr(partition).encode("latin-1")
790 actives = [b"\x00", b"\x00", b"\x00", b"\x00"]
791 actives[partition] = b"\x80"
807 tmpf.file.write(mbrcode)
813 "executing: dd if='%s' of='%s' bs=512 count=1 conv=notrunc", tmpf.name, device
815 proc = subprocess.Popen(
824 stderr=open(os.devnull, "r+"),
827 if proc.returncode != 0:
828 raise Exception("error executing dd (third run)")
831 # make sure we sync filesystems before returning
832 logging.debug("executing: sync")
833 proc = subprocess.Popen(["sync"])
836 logging.debug("Probing device via 'blockdev --rereadpt %s'", device)
837 proc = subprocess.Popen(["blockdev", "--rereadpt", device])
839 if proc.returncode != 0:
841 "Couldn't execute blockdev on '%s' (install util-linux?)", device
847 def mount(source, target, mount_options):
848 """Mount specified source on given target
850 @source: name of device/ISO that should be mounted
851 @target: directory where the ISO should be mounted to
852 @options: mount specific options"""
854 # note: options.dryrun does not work here, as we have to
855 # locate files and identify the grml flavour
857 for x in open("/proc/mounts", "r").readlines():
858 if x.startswith(source):
859 raise CriticalException(
861 "Error executing mount: {0} already mounted - "
862 "please unmount before invoking grml2usb"
866 if os.path.isdir(source):
867 logging.debug("Source %s is not a device, therefore not mounting.", source)
870 logging.debug("mount %s %s %s", mount_options, source, target)
871 proc = subprocess.Popen(["mount"] + list(mount_options) + [source, target])
873 if proc.returncode != 0:
874 raise CriticalException(
875 "Error executing mount (no filesystem on the partition?)"
878 logging.debug("register_mountpoint(%s)", target)
879 register_mountpoint(target)
882 def unmount(target, unmount_options):
883 """Unmount specified target
885 @target: target where something is mounted on and which should be unmounted
886 @options: options for umount command"""
888 # make sure we unmount only already mounted targets
889 target_unmount = False
890 mounts = open("/proc/mounts").readlines()
891 mountstring = re.compile(".*%s.*" % re.escape(os.path.realpath(target)))
893 if re.match(mountstring, line):
894 target_unmount = True
896 if not target_unmount:
897 logging.debug("%s not mounted anymore", target)
899 logging.debug("umount %s %s", list(unmount_options), target)
900 proc = subprocess.Popen(["umount"] + list(unmount_options) + [target])
902 if proc.returncode != 0:
903 raise Exception("Error executing umount")
905 logging.debug("unregister_mountpoint(%s)", target)
906 unregister_mountpoint(target)
909 def extract_device_name(device):
910 """Extract the device name of a given path
912 @device: device name, like /dev/sda1 or /dev/sda
914 return re.match(r"/dev/(.*?)\d*$", device).group(1)
917 def check_for_usbdevice(device):
918 """Check whether the specified device is a removable USB device
920 @device: device name, like /dev/sda1 or /dev/sda
923 usbdevice = extract_device_name(device)
925 usbdev = os.path.realpath("/sys/class/block/" + usbdevice + "/removable")
926 if not os.path.isfile(usbdev):
927 # Ubuntu with kernel 2.6.24 for example:
928 usbdev = os.path.realpath("/sys/block/" + usbdevice + "/removable")
930 if os.path.isfile(usbdev):
931 is_usb = open(usbdev).readline()
938 def check_for_fat(partition):
939 """Check whether specified partition is a valid VFAT/FAT16 filesystem
941 @partition: device name of partition"""
943 if not os.access(partition, os.R_OK):
944 raise CriticalException(
945 "Failed to read device %s"
946 " (wrong UID/permissions or device/directory not present?)" % partition
951 subprocess.check_output(
952 ["/sbin/blkid", "-s", "TYPE", "-o", "value", partition]
958 if filesystem != "vfat":
959 raise CriticalException(
960 "Partition %s does not contain a FAT16 filesystem. "
961 "(Use --fat16 or run mkfs.vfat %s)" % (partition, partition)
965 raise CriticalException(
966 "Sorry, /sbin/blkid not available (install util-linux?)"
970 def mkdir(directory):
971 """Simple wrapper around os.makedirs to get shell mkdir -p behaviour"""
973 # just silently pass as it's just fine it the directory exists
974 if not os.path.isdir(directory):
976 os.makedirs(directory)
977 # pylint: disable-msg=W0704
982 def exec_rsync(source, target):
983 """Simple wrapper around rsync to install files
985 @source: source file/directory
986 @target: target file/directory"""
987 logging.debug("Source: %s / Target: %s", source, target)
988 proc = subprocess.Popen(["rsync", "-rlptDH", "--inplace", source, target])
990 if proc.returncode == 12:
991 logging.critical("Fatal: No space left on device")
995 if proc.returncode != 0:
996 logging.critical("Fatal: could not install %s", source)
1001 def write_uuid(target_file):
1002 """Generates an returns uuid and write it to the specified file
1004 @target_file: filename to write the uuid to
1007 fileh = open(target_file, "w")
1008 uid = str(uuid.uuid4())
1014 def get_uuid(target):
1015 """Get the uuid of the specified target. Will generate an uuid if none exist.
1017 @target: directory/mountpoint containing the grml layout
1020 conf_target = target + "/conf/"
1021 uuid_file_name = conf_target + "/bootid.txt"
1022 if os.path.isdir(conf_target):
1023 if os.path.isfile(uuid_file_name):
1024 uuid_file = open(uuid_file_name, "r")
1025 uid = uuid_file.readline().strip()
1029 return write_uuid(uuid_file_name)
1031 execute(mkdir, conf_target)
1032 return write_uuid(uuid_file_name)
1035 def get_shortname(grml_flavour):
1036 """Get shortname based from grml_flavour name. The rules applied are the same as in grml-live
1037 @grml_flavour: flavour name which shold be translated to shortname"""
1039 return re.sub(r"[,._-]", "", grml_flavour)
1042 def copy_system_files(grml_flavour, iso_mount, target):
1043 """copy grml's main files (like squashfs, kernel and initrd) to a given target
1045 @grml_flavour: name of grml flavour the configuration should be generated for
1046 @iso_mount: path where a grml ISO is mounted on
1047 @target: path where grml's main files should be copied to"""
1049 squashfs = search_file(grml_flavour + ".squashfs", iso_mount)
1050 if squashfs is None:
1051 logging.error("error locating squashfs file")
1052 raise CriticalException(
1053 "squashfs file not found, please check that your iso is not corrupt"
1056 squashfs_target = target + "/live/" + grml_flavour + "/"
1057 execute(mkdir, squashfs_target)
1058 exec_rsync(squashfs, squashfs_target + grml_flavour + ".squashfs")
1060 for prefix in grml_flavour + "/", "":
1061 filesystem_module = search_file(prefix + "filesystem.module", iso_mount)
1062 if filesystem_module:
1064 if filesystem_module is None:
1065 logging.error("error locating filesystem.module file")
1066 raise CriticalException("filesystem.module not found")
1068 exec_rsync(filesystem_module, squashfs_target + "filesystem.module")
1070 shortname = get_shortname(grml_flavour)
1071 if os.path.isdir(iso_mount + "/boot/" + shortname):
1072 exec_rsync(iso_mount + "/boot/" + shortname, target + "/boot")
1074 kernel = search_file("vmlinuz", iso_mount)
1076 # compat for releases < 2011.12
1077 kernel = search_file("linux26", iso_mount)
1080 logging.error("error locating kernel file")
1081 raise CriticalException("Kernel not found")
1083 source = os.path.dirname(kernel) + "/"
1084 dest = target + "/" + os.path.dirname(kernel).replace(iso_mount, "") + "/"
1085 execute(mkdir, dest)
1086 exec_rsync(source, dest)
1089 def copy_grml_files(grml_flavour, iso_mount, target):
1090 """copy some minor grml files to a given target
1092 @grml_flavour: the current grml_flavour
1093 @iso_mount: path where a grml ISO is mounted on
1094 @target: path where grml's main files should be copied to"""
1096 grml_target = target + "/grml/"
1097 execute(mkdir, grml_target)
1099 grml_prefixe = ["GRML", "grml"]
1100 for prefix in grml_prefixe:
1101 filename = "{0}/{1}/{2}".format(iso_mount, prefix, grml_flavour)
1102 if os.path.exists(filename):
1103 exec_rsync(filename, grml_target)
1107 "Warning: could not find flavour directory for %s ", grml_flavour
1111 def copy_addons(iso_mount, target):
1112 """copy grml's addons files (like allinoneimg, bsd4grml,..) to a given target
1114 @iso_mount: path where a grml ISO is mounted on
1115 @target: path where grml's main files should be copied to"""
1117 addons = target + "/boot/addons/"
1118 execute(mkdir, addons)
1120 for addon_file in glob.glob(iso_mount + "/boot/addons/*"):
1121 filename = os.path.basename(addon_file)
1122 src_file = iso_mount + "/boot/addons/" + os.path.basename(addon_file)
1123 logging.debug("Copying addon file %s" % filename)
1124 exec_rsync(src_file, addons)
1127 def build_loopbackcfg(target):
1128 """Generate GRUB's loopback.cfg based on existing config files.
1130 @target: target directory
1133 grub_dir = "/boot/grub/"
1134 mkdir(os.path.join(target, grub_dir))
1136 f = open(target + grub_dir + "loopback.cfg", "w")
1138 f.write("# grml2usb generated grub2 configuration file\n")
1139 f.write("source /boot/grub/header.cfg\n")
1141 for defaults in glob.glob(
1142 target + os.path.sep + grub_dir + os.path.sep + "*_default.cfg"
1144 sourcefile = defaults.split(target + os.path.sep)[1]
1145 logging.debug("Found source file" + sourcefile)
1146 os.path.isfile(defaults) and f.write("source " + sourcefile + "\n")
1148 for ops in glob.glob(
1149 target + os.path.sep + grub_dir + os.path.sep + "*_options.cfg"
1151 sourcefile = ops.split(target + os.path.sep)[1]
1152 logging.debug("Found source file" + sourcefile)
1153 os.path.isfile(ops) and f.write("source " + sourcefile + "\n")
1155 f.write("source /boot/grub/addons.cfg\n")
1156 f.write("source /boot/grub/footer.cfg\n")
1160 def glob_and_copy(filepattern, dst):
1161 """Glob on specified filepattern and copy the result to dst
1163 @filepattern: globbing pattern
1164 @dst: target directory
1166 for name in glob.glob(filepattern):
1167 copy_if_exist(name, dst)
1170 def search_and_copy(filename, search_path, dst):
1171 """Search for the specified filename at searchpath and copy it to dst
1173 @filename: filename to look for
1174 @search_path: base search file
1175 @dst: destionation to copy the file to
1177 file_location = search_file(filename, search_path)
1178 copy_if_exist(file_location, dst)
1181 def copy_if_exist(filename, dst):
1182 """Copy filename to dst if filename is set.
1184 @filename: a filename
1187 if filename and (os.path.isfile(filename) or os.path.isdir(filename)):
1188 exec_rsync(filename, dst)
1191 def copy_bootloader_files(iso_mount, target, grml_flavour):
1192 """Copy grml's bootloader files to a given target
1194 @iso_mount: path where a grml ISO is mounted on
1195 @target: path where grml's main files should be copied to
1196 @grml_flavour: name of the current processed grml_flavour
1199 syslinux_target = target + "/boot/syslinux/"
1200 execute(mkdir, syslinux_target)
1202 grub_target = target + "/boot/grub/"
1203 execute(mkdir, grub_target)
1205 logo = search_file("logo.16", iso_mount, required=True)
1206 exec_rsync(logo, syslinux_target + "logo.16")
1208 bootx64_efi = search_file("bootx64.efi", iso_mount)
1210 mkdir(target + "/efi/boot/")
1211 exec_rsync(bootx64_efi, target + "/efi/boot/bootx64.efi")
1213 efi_img = search_file("efi.img", iso_mount)
1215 mkdir(target + "/boot/")
1216 exec_rsync(efi_img, target + "/boot/efi.img")
1217 handle_secure_boot(target, efi_img)
1219 execute(mkdir, target + "/conf/")
1220 glob_and_copy(iso_mount + "/conf/bootfile_*", target + "/conf/")
1222 for ffile in ["f%d" % number for number in range(1, 11)]:
1223 search_and_copy(ffile, iso_mount, syslinux_target + ffile)
1225 # avoid the "file is read only, overwrite anyway (y/n) ?" question
1226 # of mtools by syslinux ("mmove -D o -D O s:/ldlinux.sys $target_file")
1227 if os.path.isfile(syslinux_target + "ldlinux.sys"):
1228 os.unlink(syslinux_target + "ldlinux.sys")
1230 (source_dir, name) = get_defaults_file(iso_mount, grml_flavour, "default.cfg")
1231 (source_dir, defaults_file) = get_defaults_file(iso_mount, grml_flavour, "grml.cfg")
1234 raise CriticalException(
1235 "file default.cfg could not be found.\n"
1236 "Note: this grml2usb version requires an ISO generated by grml-live >=0.9.24 ...\n"
1237 " ... either use grml releases >=2009.10 or switch to an older grml2usb version."
1240 if not os.path.exists(iso_mount + "/boot/grub/footer.cfg"):
1242 "Warning: Grml releases older than 2011.12 support only one flavour in grub."
1260 glob_and_copy(iso_mount + source_dir + expr, syslinux_target)
1262 for modules_dir in options.syslinuxlibs + SYSLINUX_LIBS:
1263 if os.path.isdir(modules_dir):
1264 for filename in glob.glob1(syslinux_target, "*.c32"):
1265 copy_if_exist(os.path.join(modules_dir, filename), syslinux_target)
1268 # copy the addons_*.cfg file to the new syslinux directory
1269 glob_and_copy(iso_mount + source_dir + "addon*.cfg", syslinux_target)
1272 "hidden.cfg", iso_mount + source_dir, syslinux_target + "new_" + "hidden.cfg"
1275 # copy all grub files from ISO
1276 glob_and_copy(iso_mount + "/boot/grub/*", grub_target)
1278 # finally (after all GRUB files have been installed) build static loopback.cfg
1279 build_loopbackcfg(target)
1282 def install_iso_files(grml_flavour, iso_mount, device, target):
1283 """Copy files from ISO to given target
1285 @grml_flavour: name of grml flavour the configuration should be generated for
1286 @iso_mount: path where a grml ISO is mounted on
1287 @device: device/partition where bootloader should be installed to
1288 @target: path where grml's main files should be copied to"""
1291 GRML_DEFAULT = GRML_DEFAULT or grml_flavour
1294 elif not options.bootloaderonly:
1295 logging.info("Copying files. This might take a while....")
1297 copy_system_files(grml_flavour, iso_mount, target)
1298 copy_grml_files(grml_flavour, iso_mount, target)
1299 except CriticalException as error:
1300 logging.critical("Execution failed: %s", error)
1303 if not options.skipaddons:
1304 if not search_file("addons", iso_mount):
1305 logging.info("Could not find addons, therefore not installing.")
1307 copy_addons(iso_mount, target)
1309 if not options.copyonly:
1310 copy_bootloader_files(iso_mount, target, grml_flavour)
1312 if not options.dryrun:
1313 handle_bootloader_config(grml_flavour, device, target)
1315 # make sure we sync filesystems before returning
1316 logging.info("Synching data (this might take a while)")
1317 proc = subprocess.Popen(["sync"])
1321 def get_device_from_partition(partition):
1323 partition_number = None
1324 if partition[-1].isdigit() and not RE_LOOP_DEVICE.match(partition):
1325 m = RE_P_PARTITION.match(partition) or RE_PARTITION.match(partition)
1328 partition_number = int(m.group(2)) - 1
1329 return (device, partition_number)
1332 def get_flavour(flavour_str):
1333 """Returns the flavour of a grml version string
1335 return re.match(r"[\w-]*", flavour_str).group()
1338 def identify_grml_flavour(mountpath):
1339 """Get name of grml flavour
1341 @mountpath: path where the grml ISO is mounted to
1342 @return: name of grml-flavour"""
1344 version_files = search_file("grml-version", mountpath, lst_return=True)
1346 if not version_files:
1347 if mountpath.startswith("/run/live/medium"):
1348 logging.critical("Error: could not find grml-version file.")
1350 "Looks like your system is running from RAM but required files are not available."
1353 "Please either boot without toram=... or use boot option toram instead of toram=..."
1356 logging.critical("Error: could not find grml-version file.")
1361 logging.debug("version_files = %s", version_files)
1362 for version_file in version_files:
1365 tmpfile = open(version_file, "r")
1366 for line in tmpfile.readlines():
1367 flavours.append(get_flavour(line))
1375 def get_bootoptions(grml_flavour):
1376 """Returns bootoptions for specific flavour
1378 @grml_flavour: name of the grml_flavour
1380 # do NOT write "None" in kernel cmdline
1381 if not options.bootoptions:
1384 bootopt = " ".join(options.bootoptions)
1385 bootopt = bootopt.replace("%flavour", grml_flavour)
1389 def handle_grub_config(grml_flavour, device, target):
1390 """Main handler for generating grub (v1 and v2) configuration
1392 @grml_flavour: name of grml flavour the configuration should be generated for
1393 @device: device/partition where grub should be installed to
1394 @target: path of grub's configuration files"""
1398 logging.debug("Updating grub configuration")
1400 grub_target = target + "/boot/grub/"
1402 bootid_re = re.compile(r"bootid=[\w_-]+")
1403 live_media_path_re = re.compile(r"live-media-path=[\w_/-]+")
1405 bootopt = get_bootoptions(grml_flavour)
1408 option_re = re.compile(r"(.*/boot/.*(linux26|vmlinuz).*)")
1410 if options.removeoption:
1411 for regex in options.removeoption:
1412 remove_regexes.append(re.compile(regex))
1414 shortname = get_shortname(grml_flavour)
1415 for filename in glob.glob(grub_target + "*.cfg"):
1416 for line in fileinput.input(filename, inplace=1):
1417 line = line.rstrip("\r\n")
1418 if option_re.search(line):
1419 line = bootid_re.sub("", line)
1420 if shortname in filename:
1421 line = live_media_path_re.sub("", line)
1422 line = line.rstrip() + " live-media-path=/live/%s/ " % (
1426 line = line.replace(" {} ".format(bootopt.strip()), " ")
1427 if line.endswith(bootopt):
1428 line = line[: -len(bootopt)]
1429 line = line.rstrip() + r" bootid=%s %s " % (UUID, bootopt)
1430 for regex in remove_regexes:
1431 line = regex.sub(" ", line)
1436 def initial_syslinux_config(target):
1437 """Generates initial syslinux configuration
1439 @target path of syslinux's configuration files"""
1441 target = target + "/"
1442 filename = target + "grmlmain.cfg"
1443 if os.path.isfile(target + "grmlmain.cfg"):
1445 data = open(filename, "w")
1446 data.write(generate_main_syslinux_config())
1449 filename = target + "hiddens.cfg"
1450 data = open(filename, "w")
1451 data.write("include hidden.cfg\n")
1455 def add_entry_if_not_present(filename, entry):
1456 """Write entry into filename if entry is not already in the file
1458 @filename: name of the file
1459 @entry: data to write to the file
1461 data = open(filename, "a+")
1472 def get_flavour_filename(flavour):
1473 """Generate a iso9960 save filename out of the specified flavour
1475 @flavour: grml flavour
1477 return flavour.replace("-", "_")
1480 def adjust_syslinux_bootoptions(src, flavour):
1481 """Adjust existing bootoptions of specified syslinux config to
1482 grml2usb specific ones, e.g. change the location of the kernel...
1484 @src: config file to alter
1485 @flavour: grml flavour
1488 append_re = re.compile(r"^(\s*append.*/boot/.*)$", re.I)
1489 # flavour_re = re.compile("(label.*)(grml\w+)")
1490 default_re = re.compile(r"(default.cfg)")
1491 bootid_re = re.compile(r"bootid=[\w_-]+")
1492 live_media_path_re = re.compile(r"live-media-path=[\w_/-]+")
1494 bootopt = get_bootoptions(flavour)
1498 if options.removeoption:
1499 option_re = re.compile(r"/boot/.*/(initrd.gz|initrd.img)")
1501 for regex in options.removeoption:
1502 regexe.append(re.compile(r"%s" % regex))
1504 for line in fileinput.input(src, inplace=1):
1505 # line = flavour_re.sub(r'\1 %s-\2' % flavour, line)
1506 line = default_re.sub(r"%s-\1" % flavour, line)
1507 line = bootid_re.sub("", line)
1508 line = live_media_path_re.sub("", line)
1509 line = append_re.sub(r"\1 live-media-path=/live/%s/ " % flavour, line)
1510 line = append_re.sub(r"\1 boot=live %s " % bootopt, line)
1511 line = append_re.sub(r"\1 %s=%s " % ("bootid", UUID), line)
1512 if option_re and option_re.search(line):
1513 for regex in regexe:
1514 line = regex.sub(" ", line)
1515 sys.stdout.write(line)
1519 def adjust_labels(src, replacement):
1520 """Adjust the specified labels in the syslinux config file src with
1521 specified replacement
1523 label_re = re.compile(r"^(\s*label\s*) ([a-zA-Z0-9_-]+)", re.I)
1524 for line in fileinput.input(src, inplace=1):
1525 line = label_re.sub(replacement, line)
1526 sys.stdout.write(line)
1530 def add_syslinux_entry(filename, grml_flavour):
1531 """Add includes for a specific grml_flavour to the specified filename
1533 @filename: syslinux config file
1534 @grml_flavour: grml flavour to add
1537 entry_filename = "option_%s.cfg" % grml_flavour
1538 entry = "include %s\n" % entry_filename
1540 add_entry_if_not_present(filename, entry)
1541 path = os.path.dirname(filename)
1543 data = open(path + "/" + entry_filename, "w")
1544 data.write(generate_flavour_specific_syslinux_config(grml_flavour))
1548 def modify_filenames(grml_flavour, target, filenames):
1549 """Replace the standard filenames with the new ones
1551 @grml_flavour: grml-flavour strin
1552 @target: directory where the files are located
1553 @filenames: list of filenames to alter
1555 grml_filename = get_flavour_filename(grml_flavour)
1556 for filename in filenames:
1557 old_filename = "%s/%s" % (target, filename)
1558 new_filename = "%s/%s_%s" % (target, grml_filename, filename)
1559 os.rename(old_filename, new_filename)
1562 def remove_default_entry(filename):
1563 """Remove the default entry from specified syslinux file
1565 @filename: syslinux config file
1567 default_re = re.compile(r"^(\s*menu\s*default\s*)$", re.I)
1568 for line in fileinput.input(filename, inplace=1):
1569 if default_re.match(line):
1571 sys.stdout.write(line)
1575 def handle_syslinux_config(grml_flavour, target):
1576 """Main handler for generating syslinux configuration
1578 @grml_flavour: name of grml flavour the configuration should be generated for
1579 @target: path of syslinux's configuration files"""
1581 logging.debug("Generating syslinux configuration")
1582 syslinux_target = target + "/boot/syslinux/"
1583 # should be present via copy_bootloader_files(), but make sure it exits:
1584 execute(mkdir, syslinux_target)
1585 syslinux_cfg = syslinux_target + "syslinux.cfg"
1587 # install main configuration only *once*, no matter how many ISOs we have:
1588 syslinux_config_file = open(syslinux_cfg, "w")
1589 syslinux_config_file.write("timeout 300\n")
1590 syslinux_config_file.write("include vesamenu.cfg\n")
1591 syslinux_config_file.close()
1593 prompt_name = open(syslinux_target + "promptname.cfg", "w")
1594 prompt_name.write("menu label S^yslinux prompt\n")
1597 initial_syslinux_config(syslinux_target)
1598 flavour_filename = get_flavour_filename(grml_flavour)
1600 if search_file("default.cfg", syslinux_target):
1601 modify_filenames(grml_flavour, syslinux_target, ["grml.cfg", "default.cfg"])
1603 filename = search_file("new_hidden.cfg", syslinux_target)
1605 # process hidden file
1606 if not search_file("hidden.cfg", syslinux_target):
1607 new_hidden = syslinux_target + "hidden.cfg"
1608 os.rename(filename, new_hidden)
1609 adjust_syslinux_bootoptions(new_hidden, grml_flavour)
1611 new_hidden_file = "%s/%s_hidden.cfg" % (syslinux_target, flavour_filename)
1612 os.rename(filename, new_hidden_file)
1613 adjust_labels(new_hidden_file, r"\1 %s-\2" % grml_flavour)
1614 adjust_syslinux_bootoptions(new_hidden_file, grml_flavour)
1615 entry = "include %s_hidden.cfg\n" % flavour_filename
1616 add_entry_if_not_present("%s/hiddens.cfg" % syslinux_target, entry)
1618 new_default = "%s_default.cfg" % (flavour_filename)
1619 entry = "include %s\n" % new_default
1620 defaults_file = "%s/defaults.cfg" % syslinux_target
1621 new_default_with_path = "%s/%s" % (syslinux_target, new_default)
1622 new_grml_cfg = "%s/%s_grml.cfg" % (syslinux_target, flavour_filename)
1624 if os.path.isfile(defaults_file):
1626 # remove default menu entry in menu
1627 remove_default_entry(new_default_with_path)
1629 # adjust all labels for additional isos
1630 adjust_labels(new_default_with_path, r"\1 %s" % grml_flavour)
1631 adjust_labels(new_grml_cfg, r"\1 %s-\2" % grml_flavour)
1633 # always adjust bootoptions
1634 adjust_syslinux_bootoptions(new_default_with_path, grml_flavour)
1635 adjust_syslinux_bootoptions(new_grml_cfg, grml_flavour)
1637 add_entry_if_not_present("%s/defaults.cfg" % syslinux_target, entry)
1639 add_syslinux_entry("%s/additional.cfg" % syslinux_target, flavour_filename)
1642 def handle_secure_boot(target, efi_img):
1643 """Provide secure boot support by extracting files from /boot/efi.img
1645 @target: path where grml's main files should be copied to
1646 @efi_img: path to the efi.img file that includes the files for secure boot
1649 mkdir(target + "/efi/boot/")
1650 efi_mountpoint = tempfile.mkdtemp(
1651 prefix="grml2usb", dir=os.path.abspath(options.tmpdir)
1653 logging.debug("efi_mountpoint = %s" % efi_mountpoint)
1654 register_tmpfile(efi_mountpoint)
1658 "mount(%s, %s, ['-o', 'ro', '-t', 'vfat']" % (efi_img, efi_mountpoint)
1660 mount(efi_img, efi_mountpoint, ["-o", "ro", "-t", "vfat"])
1661 except CriticalException as error:
1662 logging.critical("Fatal: %s", error)
1665 grub_cfg = search_file("grub.cfg", efi_mountpoint + "/boot/grub/")
1666 logging.debug("grub_cfg = %s" % grub_cfg)
1669 "No /boot/grub/grub.cfg found inside EFI image, looks like Secure Boot support is missing."
1672 mkdir(target + "/boot/grub/x86_64-efi/")
1674 "exec_rsync(%s, %s + '/boot/grub/x86_64-efi/grub.cfg')" % (grub_cfg, target)
1676 exec_rsync(grub_cfg, target + "/boot/grub/x86_64-efi/grub.cfg")
1679 "exec_rsync(%s + '/EFI/BOOT/grubx64.efi', %s + '/efi/boot/grubx64.efi')'"
1680 % (efi_mountpoint, target)
1683 efi_mountpoint + "/EFI/BOOT/grubx64.efi", target + "/efi/boot/grubx64.efi"
1686 # NOTE - we're overwriting /efi/boot/bootx64.efi from copy_bootloader_files here
1688 "exec_rsync(%s + '/EFI/BOOT/bootx64.efi', %s + '/efi/boot/bootx64.efi')'"
1689 % (efi_mountpoint, target)
1692 efi_mountpoint + "/EFI/BOOT/bootx64.efi", target + "/efi/boot/bootx64.efi"
1696 unmount(efi_mountpoint, "")
1697 logging.debug("Unmounted %s" % efi_mountpoint)
1698 os.rmdir(efi_mountpoint)
1699 logging.debug("Removed directory %s" % efi_mountpoint)
1701 logging.critical("RuntimeError while umount %s" % efi_mountpoint)
1705 def handle_bootloader_config(grml_flavour, device, target):
1706 """Main handler for generating bootloader's configuration
1708 @grml_flavour: name of grml flavour the configuration should be generated for
1709 @device: device/partition where bootloader should be installed to
1710 @target: path of bootloader's configuration files"""
1713 UUID = get_uuid(target)
1714 if options.skipsyslinuxconfig:
1715 logging.info("Skipping generation of syslinux configuration as requested.")
1718 handle_syslinux_config(grml_flavour, target)
1719 except CriticalException as error:
1720 logging.critical("Fatal: %s", error)
1723 if options.skipgrubconfig:
1724 logging.info("Skipping generation of grub configuration as requested.")
1727 handle_grub_config(grml_flavour, device, target)
1728 except CriticalException as error:
1729 logging.critical("Fatal: %s", error)
1733 def install(image, device):
1734 """Install a grml image to the specified device
1736 @image: directory or is file
1737 @device: partition or directory to install the device
1739 iso_mountpoint = image
1740 remove_image_mountpoint = False
1741 if os.path.isdir(image):
1742 if options.force or os.path.exists(os.path.join(image, "live")):
1743 logging.info("Using %s as install base", image)
1746 "%s does not look like a Grml system. "
1747 "Do you really want to use this image? y/N " % image
1749 if q.lower() == "y":
1750 logging.info("Using %s as install base", image)
1752 logging.info("Skipping install base %s", image)
1754 logging.info("Using ISO %s", image)
1755 iso_mountpoint = tempfile.mkdtemp(
1756 prefix="grml2usb", dir=os.path.abspath(options.tmpdir)
1758 register_tmpfile(iso_mountpoint)
1759 remove_image_mountpoint = True
1761 mount(image, iso_mountpoint, ["-o", "loop,ro", "-t", "iso9660"])
1762 except CriticalException as error:
1763 logging.critical("Fatal: %s", error)
1767 install_grml(iso_mountpoint, device)
1769 if remove_image_mountpoint:
1771 remove_mountpoint(iso_mountpoint)
1772 except CriticalException:
1777 def install_grml(mountpoint, device):
1778 """Main logic for copying files of the currently running Grml system.
1780 @mountpoint: directory where currently running live system resides (usually /run/live/medium)
1781 @device: partition where the specified ISO should be installed to"""
1783 device_mountpoint = device
1784 if os.path.isdir(device):
1785 logging.info("Specified device is a directory, therefore not mounting.")
1786 remove_device_mountpoint = False
1788 device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
1789 register_tmpfile(device_mountpoint)
1790 remove_device_mountpoint = True
1793 mount(device, device_mountpoint, ["-o", "utf8,iocharset=iso8859-1"])
1794 except CriticalException:
1795 mount(device, device_mountpoint, "")
1797 grml_flavours = identify_grml_flavour(mountpoint)
1798 for flavour in set(grml_flavours):
1800 logging.warning("No valid flavour found, please check your iso")
1801 logging.info('Identified grml flavour "%s".', flavour)
1802 install_iso_files(flavour, mountpoint, device, device_mountpoint)
1803 GRML_FLAVOURS.add(flavour)
1805 if remove_device_mountpoint:
1806 remove_mountpoint(device_mountpoint)
1809 def remove_mountpoint(mountpoint):
1810 """remove a registered mountpoint
1814 unmount(mountpoint, "")
1815 if os.path.isdir(mountpoint):
1816 os.rmdir(mountpoint)
1817 unregister_tmpfile(mountpoint)
1818 except CriticalException:
1823 def handle_mbr(device):
1824 """Main handler for installing master boot record (MBR)
1826 @device: device where the MBR should be installed to"""
1829 logging.info("Would install MBR")
1832 mbr_device, partition_number = get_device_from_partition(device)
1833 if partition_number is None:
1834 logging.warning("Could not detect partition number, not activating partition")
1836 # if we get e.g. /dev/loop1 as device we don't want to put the MBR
1837 # into /dev/loop of course, therefore use /dev/loop1 as mbr_device
1838 if mbr_device == "/dev/loop":
1841 "Detected loop device - using %s as MBR device therefore", mbr_device
1844 mbrcode = GRML2USB_BASE + "/mbr/mbrldr"
1845 if options.syslinuxmbr:
1848 "/usr/lib/syslinux/mbr.bin",
1849 "/usr/lib/syslinux/bios/mbr.bin",
1850 "/usr/share/syslinux/mbr.bin",
1852 for mbrpath in mbr_locations:
1853 if os.path.isfile(mbrpath):
1858 str_locations = " or ".join(['"%s"' % x for x in mbr_locations])
1859 logging.error("Cannot find syslinux MBR, install it at %s)", str_locations)
1860 raise CriticalException(
1861 "syslinux MBR can not be found at %s." % str_locations
1863 elif options.mbrmenu:
1864 mbrcode = GRML2USB_BASE + "/mbr/mbrldr"
1867 install_mbr(mbrcode, mbr_device, partition_number, True)
1868 except (IOError, Exception) as error:
1869 logging.critical("Execution failed: %s", error)
1873 def handle_vfat(device):
1874 """Check for FAT specific settings and options
1876 @device: device that should checked / formated"""
1878 # make sure we have mkfs.vfat available
1880 if not which("mkfs.vfat") and not options.copyonly and not options.dryrun:
1881 logging.critical("Sorry, mkfs.vfat not available. Exiting.")
1882 logging.critical("Please make sure to install dosfstools.")
1886 print("Forcing mkfs.fat16 on %s as requested via option --force." % device)
1888 # make sure the user is aware of what he is doing
1890 "Are you sure you want to format the specified partition with fat16? y/N "
1892 if f == "y" or f == "Y":
1894 "Note: you can skip this question using the option --force"
1900 except CriticalException as error:
1901 logging.critical("Execution failed: %s", error)
1904 # check for vfat filesystem
1905 if device is not None and not os.path.isdir(device) and options.syslinux:
1907 check_for_fat(device)
1908 except CriticalException as error:
1909 logging.critical("Execution failed: %s", error)
1912 if options.skipusbcheck:
1914 "Not checking for removable USB device as requested via option --skip-usb-check."
1919 not os.path.isdir(device)
1920 and not check_for_usbdevice(device)
1921 and not options.force
1924 "Warning: the specified device %s does not look like a removable usb device."
1927 f = input("Do you really want to continue? y/N ")
1928 if f.lower() != "y":
1932 def handle_compat_warning(device):
1933 """Backwards compatible checks
1935 @device: device that should be checked"""
1937 # make sure we can replace old grml2usb script and warn user when using old way of life:
1939 device.startswith("/mnt/external")
1940 or device.startswith("/mnt/usb")
1941 and not options.force
1943 print("Warning: the semantics of grml2usb has changed.")
1944 print("Instead of using grml2usb /path/to/iso %s you might" % device)
1945 print("want to use grml2usb /path/to/iso /dev/... instead.")
1946 print("Please check out the grml2usb manpage for details.")
1947 f = input("Do you really want to continue? y/N ")
1948 if f.lower() != "y":
1952 def handle_logging():
1953 """Log handling and configuration"""
1955 if options.verbose and options.quiet:
1956 parser.error("please use either verbose (--verbose) or quiet (--quiet) option")
1958 FORMAT = "%(message)s"
1960 FORMAT = "%(asctime)-15s %(message)s"
1961 logging.basicConfig(level=logging.DEBUG, format=FORMAT)
1963 logging.basicConfig(level=logging.CRITICAL, format=FORMAT)
1965 logging.basicConfig(level=logging.INFO, format=FORMAT)
1968 def handle_bootloader(device):
1969 """wrapper for installing bootloader
1971 @device: device where bootloader should be installed to"""
1973 # Install bootloader only if not using the --copy-only option
1974 if options.copyonly:
1976 "Not installing bootloader and its files as requested via option copyonly."
1978 elif os.path.isdir(device):
1979 logging.info("Not installing bootloader as %s is a directory.", device)
1981 install_bootloader(device)
1984 def check_options(opts):
1985 """Check compatibility of provided user opts
1987 @opts option dict from OptionParser
1989 if opts.grubmbr and not opts.grub:
1990 raise CriticalException("--grub-mbr requires --grub option.")
1992 if opts.copyonly and opts.grub:
1993 raise CriticalException("Cannot use --copy-only and --grub at the same time.")
1996 def check_programs():
1997 """check if all needed programs are installed"""
2000 GRUB_INSTALL = which("grub-install") or which("grub2-install")
2001 if not GRUB_INSTALL:
2003 "Fatal: grub-install not available (please install the "
2004 "grub package or drop the --grub option)"
2008 if options.syslinux:
2009 if not which("syslinux"):
2011 "Fatal: syslinux not available (please install the "
2012 "syslinux package or use the --grub option)"
2016 if not which("rsync"):
2017 logging.critical("Fatal: rsync not available, can not continue - sorry.")
2022 """Runs modprobe loop and throws away its output"""
2023 if not which("modprobe"):
2024 logging.critical("Fatal: modprobe not available, can not continue - sorry.")
2025 logging.critical("Hint: is /sbin missing in PATH?")
2028 proc = subprocess.Popen(
2029 ["modprobe", "loop"], stdout=subprocess.PIPE, stderr=subprocess.PIPE
2035 """Main invocation"""
2039 print(os.path.basename(sys.argv[0]) + " " + PROG_VERSION)
2043 parser.error("invalid usage")
2048 # make sure we have the appropriate permissions
2051 check_options(options)
2055 logging.info("Executing grml2usb version %s", PROG_VERSION)
2058 logging.info("Running in simulation mode as requested via option dry-run.")
2062 # specified arguments
2063 device = os.path.realpath(args[len(args) - 1])
2064 isos = args[0 : len(args) - 1]
2066 if not os.path.isdir(device):
2067 if device[-1:].isdigit():
2068 if int(device[-1:]) > 4 or device[-2:].isdigit():
2070 "Warning: installing on partition number >4, booting *might* fail depending on your system."
2073 # provide upgrade path
2074 handle_compat_warning(device)
2076 if not options.skipbootflag:
2077 check_boot_flag(device)
2079 # check for vfat partition
2082 # main operation (like installing files)
2084 install(iso, device)
2087 is_superfloppy = not device[-1:].isdigit()
2089 logging.info("Detected superfloppy format - not installing MBR")
2091 if not options.skipmbr and not os.path.isdir(device) and not is_superfloppy:
2094 handle_bootloader(device)
2097 "Note: grml flavour %s was installed as the default booting system.",
2101 for flavour in GRML_FLAVOURS:
2103 "Note: you can boot flavour %s using '%s' on the commandline.",
2108 # finally be polite :)
2110 "Finished execution of grml2usb (%s). Have fun with your Grml system.",
2114 except Exception as error:
2115 logging.critical("Fatal: %s", str(error))
2117 logging.exception("Exception:")
2121 if __name__ == "__main__":
2124 except KeyboardInterrupt:
2125 logging.info("Received KeyboardInterrupt")
2128 # END OF FILE ##################################################################
2129 # vim:foldmethod=indent expandtab ai ft=python tw=120 fileencoding=utf-8