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, 2010, 2011 by Michael Prokop <mika@grml.org>
11 :license: GPL v2 or any later version
12 :bugreports: http://grml.org/bugs/
16 from __future__ import print_function
17 from optparse import OptionParser
18 from inspect import isroutine, isclass
34 # The line following this line is patched by debian/rules and tarball.sh.
35 PROG_VERSION = '***UNRELEASED***'
38 MOUNTED = set() # register mountpoints
39 TMPFILES = set() # register tmpfiles
40 DATESTAMP = time.mktime(datetime.datetime.now().timetuple()) # unique identifier for syslinux.cfg
41 GRML_FLAVOURS = set() # which flavours are being installed?
44 SYSLINUX_LIBS = "/usr/lib/syslinux/"
45 GPT_HEADER = b"\x55\xaa\x45\x46\x49\x20\x50\x41\x52\x54" # original GPT header
48 RE_PARTITION = re.compile(r'([a-z/]*?)(\d+)$')
49 RE_P_PARTITION = re.compile(r'(.*?\d+)p(\d+)$')
50 RE_LOOP_DEVICE = re.compile(r'/dev/loop\d+$')
53 def syslinux_warning(option, opt, value, opt_parser):
54 """A helper function for printing a warning about deprecated option
56 # pylint: disable-msg=W0613
57 sys.stderr.write("Note: the --syslinux option is deprecated as syslinux "
58 "is grml2usb's default. Continuing anyway.\n")
59 setattr(opt_parser.values, option.dest, True)
62 # if grub option is set, unset syslinux option
63 def grub_option(option, opt, value, opt_parser):
64 """A helper function adjusting other option values
66 # pylint: disable-msg=W0613
67 setattr(opt_parser.values, option.dest, True)
68 setattr(opt_parser.values, 'syslinux', False)
72 USAGE = "Usage: %prog [options] <[ISO[s] | /lib/live/mount/medium]> </dev/sdX#>\n\
74 %prog installs Grml ISO[s] to an USB device to be able to boot from it.\n\
75 Make sure you have at least one Grml ISO or a running Grml system (/lib/live/mount/medium),\n\
76 grub or syslinux and root access.\n\
78 Run %prog --help for usage hints, further information via: man grml2usb"
80 # pylint: disable-msg=C0103
81 # pylint: disable-msg=W0603
82 parser = OptionParser(usage=USAGE)
83 parser.add_option("--bootoptions", dest="bootoptions",
84 action="append", type="string",
85 help="use specified bootoptions as default")
86 parser.add_option("--bootloader-only", dest="bootloaderonly", action="store_true",
87 help="do not copy files but just install a bootloader")
88 parser.add_option("--copy-only", dest="copyonly", action="store_true",
89 help="copy files only but do not install bootloader")
90 parser.add_option("--dry-run", dest="dryrun", action="store_true",
91 help="avoid executing commands")
92 parser.add_option("--fat16", dest="fat16", action="store_true",
93 help="format specified partition with FAT16")
94 parser.add_option("--force", dest="force", action="store_true",
95 help="force any actions requiring manual interaction")
96 parser.add_option("--grub", dest="grub", action="callback",
98 help="install grub bootloader instead of (default) syslinux")
99 parser.add_option("--grub-mbr", dest="grubmbr", action="store_true",
100 help="install grub into MBR instead of (default) PBR")
101 parser.add_option("--mbr-menu", dest="mbrmenu", action="store_true",
102 help="enable interactive boot menu in MBR")
103 parser.add_option("--quiet", dest="quiet", action="store_true",
104 help="do not output anything but just errors on console")
105 parser.add_option("--remove-bootoption", dest="removeoption", action="append",
106 help="regex for removing existing bootoptions")
107 parser.add_option("--rw-blockdev", dest="rwblockdev", action="store_true",
108 help="enforce read-write mode on involved block devices")
109 parser.add_option("--skip-addons", dest="skipaddons", action="store_true",
110 help="do not install /boot/addons/ files")
111 parser.add_option("--skip-bootflag", dest="skipbootflag", action="store_true",
112 help="do not try to check whether the destination has the bootflag set")
113 parser.add_option("--skip-grub-config", dest="skipgrubconfig", action="store_true",
114 help="skip generation of grub configuration files")
115 parser.add_option("--skip-mbr", dest="skipmbr", action="store_true",
116 help="do not install a master boot record (MBR) on the device")
117 parser.add_option("--skip-syslinux-config", dest="skipsyslinuxconfig", action="store_true",
118 help="skip generation of syslinux configuration files")
119 parser.add_option("--skip-usb-check", dest="skipusbcheck", action="store_true",
120 help="skip check to verify whether given device is removable")
121 parser.add_option("--syslinux", dest="syslinux", action="callback", default=True,
122 callback=syslinux_warning,
123 help="install syslinux bootloader (deprecated as it's the default)")
124 parser.add_option("--syslinux-mbr", dest="syslinuxmbr", action="store_true",
125 help="install syslinux master boot record (MBR) instead of default")
126 parser.add_option("--tmpdir", dest="tmpdir", default="/tmp",
127 help="directory to be used for temporary files")
128 parser.add_option("--verbose", dest="verbose", action="store_true",
129 help="enable verbose mode")
130 parser.add_option("-v", "--version", dest="version", action="store_true",
131 help="display version and exit")
132 (options, args) = parser.parse_args()
135 GRML2USB_BASE = '/usr/share/grml2usb'
136 if not os.path.isdir(GRML2USB_BASE):
137 GRML2USB_BASE = os.path.dirname(os.path.realpath(__file__))
140 class HodorException(Exception):
141 """Throw exception if the exact error is not known and not fatal.
143 @Exception: message"""
146 class CriticalException(Exception):
147 """Throw critical exception if the exact error is not known but fatal.
149 @Exception: message"""
152 class VerifyException(Exception):
153 """Throw critical exception if there is an fatal error when verifying something.
155 @Exception: message"""
158 # The following two functions help to operate on strings as
159 # array (list) of bytes (octets). In Python 3000, the bytes
160 # datatype will need to be used. This is intended for using
161 # with manipulation of files on the octet level, like shell
162 # arrays, e.g. in MBR creation.
165 def array2string(*a):
166 """Convert a list of integers [0;255] to a string."""
167 return struct.pack("%sB" % len(a), *a)
171 """Convert a (bytes) string into a list of integers."""
172 return struct.unpack("%sB" % len(s), s)
176 """Cleanup function to make sure there aren't any mounted devices left behind.
178 def del_failed(fn, filepath, exc):
179 msg = "Deletion of %s failed in temporary folder %s"
180 logging.warn(msg % (filepath, path))
182 logging.info("Cleaning up before exiting...")
183 proc = subprocess.Popen(["sync"])
186 for device in MOUNTED.copy():
189 logging.debug('Unmounted %s' % device)
190 except StandardError:
191 logging.debug('RuntimeError while umount %s, ignoring' % device)
193 for tmppath in TMPFILES.copy():
195 if os.path.isdir(tmppath) and not os.path.islink(tmppath):
196 # symbolic links to directories are ignored
197 # without the check it will throw an OSError
198 shutil.rmtree(tmppath, onerror=del_failed)
199 logging.debug('temporary directory %s deleted' % tmppath)
200 unregister_tmpfile(tmppath)
203 logging.debug('temporary file %s deleted' % tmppath)
204 unregister_tmpfile(tmppath)
205 except StandardError:
206 msg = 'RuntimeError while removing temporary %s, ignoring'
207 logging.debug(msg % tmppath)
210 def register_tmpfile(path):
218 def unregister_tmpfile(path):
220 remove registered tmpfile
224 TMPFILES.remove(path)
229 def register_mountpoint(target):
230 """register specified target in a set() for handling clean exiting
232 @target: destination target of mountpoint
238 def unregister_mountpoint(target):
239 """unregister specified target in a set() for handling clean exiting
241 @target: destination target of mountpoint
244 if target in MOUNTED:
245 MOUNTED.remove(target)
248 def get_function_name(obj):
249 """Helper function for use in execute() to retrieve name of a function
251 @obj: the function object
253 if not (isroutine(obj) or isclass(obj)):
255 return obj.__module__ + '.' + obj.__name__
259 if not options.rwblockdev:
262 logging.debug("executing: blockdev --setrw %s", device)
263 proc = subprocess.Popen(["blockdev", "--setrw", device])
265 if proc.returncode != 0:
266 raise Exception("error executing blockdev on %s" % device)
269 def execute(f, *exec_arguments):
270 """Wrapper for executing a command. Either really executes
271 the command (default) or when using --dry-run commandline option
272 just displays what would be executed."""
273 # usage: execute(subprocess.Popen, (["ls", "-la"]))
275 # pylint: disable-msg=W0141
276 logging.debug('dry-run only: %s(%s)', get_function_name(f), ', '.join(map(repr, exec_arguments)))
278 # pylint: disable-msg=W0142
279 return f(*exec_arguments)
283 """Check whether a given file can be executed
285 @fpath: full path to file
287 return os.path.exists(fpath) and os.access(fpath, os.X_OK)
291 """Check whether a given program is available in PATH
293 @program: name of executable"""
294 fpath = os.path.split(program)[0]
299 for path in os.environ["PATH"].split(os.pathsep):
300 exe_file = os.path.join(path, program)
307 def get_defaults_file(iso_mount, flavour, name):
308 """get the default file for syslinux
310 bootloader_dirs = ['/boot/isolinux/', '/boot/syslinux/']
311 for directory in bootloader_dirs:
312 for name in name, "%s_%s" % (get_flavour_filename(flavour), name):
313 if os.path.isfile(iso_mount + directory + name):
314 return (directory, name)
318 def search_file(filename, search_path='/bin' + os.pathsep + '/usr/bin', lst_return=False):
319 """Given a search path, find file
321 @filename: name of file to search for
322 @search_path: path where searching for the specified filename
323 @lst_return: return list of matching files instead one file"""
324 paths = search_path.split(os.pathsep)
325 current_dir = '' # make pylint happy :)
329 """Helper function ffor testing if specified file exists in cwd
331 @cwd: current working directory
333 return os.path.exists(os.path.join(cwd, filename))
337 if match_file(current_dir):
338 retval.append(os.path.abspath(os.path.join(current_dir, filename)))
341 # pylint: disable-msg=W0612
342 for current_dir, directories, files in os.walk(path):
343 if match_file(current_dir):
344 retval.append(os.path.abspath(os.path.join(current_dir, filename)))
355 def check_uid_root():
356 """Check for root permissions"""
357 if not os.geteuid() == 0:
358 raise CriticalException("please run this script with uid 0 (root).")
361 # for usage inside check_boot_flag
362 def get_partition_for_path(path):
365 boot_dev, x = get_device_from_partition(path)
367 d = parted.getDevice(boot_dev)
368 disk = parted.Disk(d)
369 return disk.getPartitionByPath(path)
372 def check_boot_flag(device):
373 boot_dev, x = get_device_from_partition(device)
377 part = get_partition_for_path(device)
379 raise HodorException("parted could not find partition")
380 if part.getFlag(parted.PARTITION_BOOT):
381 logging.debug("bootflag is enabled on %s" % device)
383 except HodorException as e:
384 logging.info("%s, falling back to old bootflag detection", e)
385 except ImportError as e:
386 logging.debug("could not import parted, falling back to old bootflag detection")
388 with open(boot_dev, 'r') as image:
389 data = image.read(520)
390 bootcode = data[440:]
391 gpt_data = bootcode[70:80]
393 if gpt_data == GPT_HEADER:
394 logging.info("GPT detected, skipping bootflag check")
395 elif bootcode[6] == b"\x80":
396 logging.debug("bootflag is enabled")
398 logging.debug("bootflag is NOT enabled")
399 raise VerifyException("Device %s does not have the bootflag set. "
400 "Please enable it to be able to boot." % device)
403 def mkfs_fat16(device):
404 """Format specified device with VFAT/FAT16 filesystem.
406 @device: partition that should be formated"""
409 logging.info("Would execute mkfs.vfat -F 16 %s now.", device)
412 logging.info("Formating partition with fat16 filesystem")
413 logging.debug("mkfs.vfat -F 16 %s", device)
414 proc = subprocess.Popen(["mkfs.vfat", "-F", "16", device])
416 if proc.returncode != 0:
417 raise CriticalException("error executing mkfs.vfat")
420 def generate_isolinux_splash(grml_flavour):
421 """Generate bootsplash for isolinux/syslinux
423 @grml_flavour: name of grml flavour the configuration should be generated for"""
425 grml_name = grml_flavour
428 \ f17
\f\18/boot/syslinux/logo.16
430 Some information and boot options available via keys F2 - F10. http://grml.org/
432 """ % {'grml_name': grml_name})
435 def generate_main_syslinux_config(*arg):
436 """Generate main configuration for use in syslinux.cfg
438 @*arg: just for backward compatibility"""
439 # pylint: disable-msg=W0613
440 # remove warning about unused arg
444 menu label Default boot modes:
453 menu label Additional boot entries for:
455 include additional.cfg
462 include promptname.cfg
465 Jump to old style isolinux prompt
466 featuring further information
467 regarding available boot options.
475 def generate_flavour_specific_syslinux_config(grml_flavour):
476 """Generate flavour specific configuration for use in syslinux.cfg
478 @grml_flavour: name of grml flavour the configuration should be generated for"""
481 menu begin grml %(grml_flavour)s
482 menu title %(display_name)s
484 menu label ^Back to main menu...
487 # include config for boot parameters from disk
488 include %(grml_flavour)s_grml.cfg
491 """ % {'grml_flavour': grml_flavour, 'display_name': get_flavour_filename(grml_flavour)})
494 def install_grub(device):
495 """Install grub on specified device.
497 @mntpoint: mountpoint of device where grub should install its files to
498 @device: partition where grub should be installed to"""
501 logging.info("Would execute grub-install [--root-directory=mount_point] %s now.", device)
503 device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
504 register_tmpfile(device_mountpoint)
506 # If using --grub-mbr then make sure we install grub in MBR instead of PBR
508 logging.debug("Using option --grub-mbr ...")
509 grub_device, x = get_device_from_partition(device)
514 mount(device, device_mountpoint, "")
516 logging.info("Installing grub as bootloader")
517 for opt in ["--", "--force"]:
520 logging.debug("%s --recheck --no-floppy --target=i386-pc --root-directory=%s %s %s",
521 GRUB_INSTALL, device_mountpoint, opt, grub_device)
522 proc = subprocess.Popen([GRUB_INSTALL, "--recheck",
523 "--no-floppy", "--target=i386-pc",
524 "--root-directory=%s" % device_mountpoint,
526 stdout=open(os.devnull, "r+"))
528 if proc.returncode == 0:
531 if proc.returncode != 0:
532 # raise Exception("error executing grub-install")
533 logging.critical("Fatal: error executing grub-install " +
534 "(please check the grml2usb FAQ or drop the --grub option)")
535 logging.critical("Note: if using grub2 consider using " +
536 "the --grub-mbr option as grub considers PBR problematic.")
539 except CriticalException as error:
540 logging.critical("Fatal: %s", error)
544 unmount(device_mountpoint, "")
545 os.rmdir(device_mountpoint)
546 unregister_tmpfile(device_mountpoint)
549 def install_syslinux(device):
550 """Install syslinux on specified device.
552 @device: partition where syslinux should be installed to"""
555 logging.info("Would install syslinux as bootloader on %s", device)
560 # syslinux -d boot/isolinux /dev/sdb1
561 logging.info("Installing syslinux as bootloader")
562 logging.debug("syslinux -d boot/syslinux %s", device)
563 proc = subprocess.Popen(["syslinux", "-d", "boot/syslinux", device])
565 if proc.returncode != 0:
566 raise CriticalException("Error executing syslinux (either try --fat16 or use grub?)")
569 def install_bootloader(device):
570 """Install bootloader on specified device.
572 @device: partition where bootloader should be installed to"""
574 # by default we use grub, so install syslinux only on request
578 except CriticalException as error:
579 logging.critical("Fatal: %s", error)
584 install_syslinux(device)
585 except CriticalException as error:
586 logging.critical("Fatal: %s", error)
591 def install_mbr(mbrtemplate, device, partition, ismirbsdmbr=True):
592 """install 'mbr' master boot record (MBR) on a device
594 Retrieve the partition table from "device", install an MBR from the
595 "mbrtemplate" file, set the "partition" (0..3) active, and install the
596 result back to "device".
598 @mbrtemplate: default MBR file
600 @device: name of a file assumed to be a hard disc (or USB stick) image, or
601 something like "/dev/sdb"
603 @partition: must be a number between 0 and 3, inclusive
605 @mbrtemplate: must be a valid MBR file of at least 440 (or 439 if
608 @ismirbsdmbr: if true then ignore the active flag, set the mirbsdmbr
609 specific flag to 0/1/2/3 and set the MBR's default value accordingly. If
610 false then leave the mirbsdmbr specific flag set to FFh, set all
611 active flags to 0 and set the active flag of the partition to 80h. Note:
612 behaviour of mirbsdmbr: if flag = 0/1/2/3 then use it, otherwise search for
615 logging.info("Installing default MBR")
617 if not os.path.isfile(mbrtemplate):
618 logging.error('Error installing MBR (either try --syslinux-mbr or '
619 'install missing file "%s"?)', mbrtemplate)
620 raise CriticalException("%s can not be read." % mbrtemplate)
622 if partition is not None and ((partition < 0) or (partition > 3)):
623 logging.warn("Cannot activate partition %d", partition)
631 tmpf = tempfile.NamedTemporaryFile()
633 logging.debug("executing: dd if='%s' of='%s' bs=512 count=1", device, tmpf.name)
634 proc = subprocess.Popen(["dd", "if=%s" % device, "of=%s" % tmpf.name, "bs=512", "count=1"],
635 stderr=open(os.devnull, "r+"))
637 if proc.returncode != 0:
638 raise Exception("error executing dd (first run)")
640 logging.debug("executing: dd if=%s of=%s bs=%s count=1 conv=notrunc", mbrtemplate,
641 tmpf.name, nmbrbytes)
642 proc = subprocess.Popen(["dd", "if=%s" % mbrtemplate, "of=%s" % tmpf.name, "bs=%s" % nmbrbytes,
643 "count=1", "conv=notrunc"], stderr=open(os.devnull, "r+"))
645 if proc.returncode != 0:
646 raise Exception("error executing dd (second run)")
648 mbrcode = tmpf.file.read(512)
649 if len(mbrcode) < 512:
650 raise EOFError("MBR size (%d) < 512" % len(mbrcode))
652 if partition is not None:
654 mbrcode = mbrcode[0:439] + chr(partition).encode('latin-1') + \
655 mbrcode[440:510] + b"\x55\xAA"
657 actives = [b"\x00", b"\x00", b"\x00", b"\x00"]
658 actives[partition] = b"\x80"
659 mbrcode = mbrcode[0:446] + actives[0] + \
660 mbrcode[447:462] + actives[1] + \
661 mbrcode[463:478] + actives[2] + \
662 mbrcode[479:494] + actives[3] + \
663 mbrcode[495:510] + b"\x55\xAA"
667 tmpf.file.write(mbrcode)
672 logging.debug("executing: dd if='%s' of='%s' bs=512 count=1 conv=notrunc", tmpf.name, device)
673 proc = subprocess.Popen(["dd", "if=%s" % tmpf.name, "of=%s" % device, "bs=512", "count=1",
674 "conv=notrunc"], stderr=open(os.devnull, "r+"))
676 if proc.returncode != 0:
677 raise Exception("error executing dd (third run)")
680 # make sure we sync filesystems before returning
681 proc = subprocess.Popen(["sync"])
687 def is_writeable(device):
688 """Check if the device is writeable for the current user
690 @device: partition where bootloader should be installed to"""
695 if not os.path.exists(device):
698 return os.access(device, os.W_OK) and os.access(device, os.R_OK)
701 def mount(source, target, mount_options):
702 """Mount specified source on given target
704 @source: name of device/ISO that should be mounted
705 @target: directory where the ISO should be mounted to
706 @options: mount specific options"""
708 # note: options.dryrun does not work here, as we have to
709 # locate files and identify the grml flavour
711 for x in open('/proc/mounts', 'r').readlines():
712 if x.startswith(source):
713 raise CriticalException("Error executing mount: %s already mounted - " % source +
714 "please unmount before invoking grml2usb")
716 if os.path.isdir(source):
717 logging.debug("Source %s is not a device, therefore not mounting.", source)
720 logging.debug("mount %s %s %s", mount_options, source, target)
721 proc = subprocess.Popen(["mount"] + list(mount_options) + [source, target])
723 if proc.returncode != 0:
724 raise CriticalException("Error executing mount (no filesystem on the partition?)")
726 logging.debug("register_mountpoint(%s)", target)
727 register_mountpoint(target)
730 def unmount(target, unmount_options):
731 """Unmount specified target
733 @target: target where something is mounted on and which should be unmounted
734 @options: options for umount command"""
736 # make sure we unmount only already mounted targets
737 target_unmount = False
738 mounts = open('/proc/mounts').readlines()
739 mountstring = re.compile(".*%s.*" % re.escape(os.path.realpath(target)))
741 if re.match(mountstring, line):
742 target_unmount = True
744 if not target_unmount:
745 logging.debug("%s not mounted anymore", target)
747 logging.debug("umount %s %s", list(unmount_options), target)
748 proc = subprocess.Popen(["umount"] + list(unmount_options) + [target])
750 if proc.returncode != 0:
751 raise Exception("Error executing umount")
753 logging.debug("unregister_mountpoint(%s)", target)
754 unregister_mountpoint(target)
757 def check_for_usbdevice(device):
758 """Check whether the specified device is a removable USB device
760 @device: device name, like /dev/sda1 or /dev/sda
763 usbdevice = re.match(r'/dev/(.*?)\d*$', device).group(1)
765 usbdev = os.path.realpath('/sys/class/block/' + usbdevice + '/removable')
766 if not os.path.isfile(usbdev):
767 # Ubuntu with kernel 2.6.24 for example:
768 usbdev = os.path.realpath('/sys/block/' + usbdevice + '/removable')
770 if os.path.isfile(usbdev):
771 is_usb = open(usbdev).readline()
778 def check_for_fat(partition):
779 """Check whether specified partition is a valid VFAT/FAT16 filesystem
781 @partition: device name of partition"""
783 if not os.access(partition, os.R_OK):
784 raise CriticalException("Failed to read device %s"
785 " (wrong UID/permissions or device/directory not present?)" % partition)
788 udev_info = subprocess.Popen(["/sbin/blkid", "-s", "TYPE", "-o", "value", partition],
789 stdout=subprocess.PIPE, stderr=subprocess.PIPE)
790 filesystem = udev_info.communicate()[0].rstrip()
792 if filesystem != "vfat":
793 raise CriticalException(
794 "Partition %s does not contain a FAT16 filesystem. "
795 "(Use --fat16 or run mkfs.vfat %s)" % (partition, partition))
798 raise CriticalException("Sorry, /sbin/blkid not available (install e2fsprogs?)")
801 def mkdir(directory):
802 """Simple wrapper around os.makedirs to get shell mkdir -p behaviour"""
804 # just silently pass as it's just fine it the directory exists
805 if not os.path.isdir(directory):
807 os.makedirs(directory)
808 # pylint: disable-msg=W0704
813 def exec_rsync(source, target):
814 """Simple wrapper around rsync to install files
816 @source: source file/directory
817 @target: target file/directory"""
818 logging.debug("Source: %s / Target: %s", source, target)
819 proc = subprocess.Popen(["rsync", "-rlptDH", "--inplace", source, target])
821 if proc.returncode == 12:
822 logging.critical("Fatal: No space left on device")
826 if proc.returncode != 0:
827 logging.critical("Fatal: could not install %s", source)
832 def write_uuid(target_file):
833 """Generates an returns uuid and write it to the specified file
835 @target_file: filename to write the uuid to
838 fileh = open(target_file, 'w')
839 uid = str(uuid.uuid4())
845 def get_uuid(target):
846 """Get the uuid of the specified target. Will generate an uuid if none exist.
848 @target: directory/mountpoint containing the grml layout
851 conf_target = target + "/conf/"
852 uuid_file_name = conf_target + "/bootid.txt"
853 if os.path.isdir(conf_target):
854 if os.path.isfile(uuid_file_name):
855 uuid_file = open(uuid_file_name, 'r')
856 uid = uuid_file.readline().strip()
860 return write_uuid(uuid_file_name)
862 execute(mkdir, conf_target)
863 return write_uuid(uuid_file_name)
866 def get_shortname(grml_flavour):
867 """Get shortname based from grml_flavour name. The rules applied are the same as in grml-live
868 @grml_flavour: flavour name which shold be translated to shortname"""
870 return re.sub(r'[,._-]', '', grml_flavour)
873 def copy_system_files(grml_flavour, iso_mount, target):
874 """copy grml's main files (like squashfs, kernel and initrd) to a given target
876 @grml_flavour: name of grml flavour the configuration should be generated for
877 @iso_mount: path where a grml ISO is mounted on
878 @target: path where grml's main files should be copied to"""
880 squashfs = search_file(grml_flavour + '.squashfs', iso_mount)
882 logging.error("error locating squashfs file")
883 raise CriticalException("squashfs file not found, please check that your iso is not corrupt")
885 squashfs_target = target + '/live/' + grml_flavour + '/'
886 execute(mkdir, squashfs_target)
887 exec_rsync(squashfs, squashfs_target + grml_flavour + '.squashfs')
889 for prefix in grml_flavour + "/", "":
890 filesystem_module = search_file(prefix + 'filesystem.module', iso_mount)
891 if filesystem_module:
893 if filesystem_module is None:
894 logging.error("error locating filesystem.module file")
895 raise CriticalException("filesystem.module not found")
897 exec_rsync(filesystem_module, squashfs_target + 'filesystem.module')
899 shortname = get_shortname(grml_flavour)
900 if os.path.isdir(iso_mount + '/boot/' + shortname):
901 exec_rsync(iso_mount + '/boot/' + shortname, target + '/boot')
903 kernel = search_file('vmlinuz', iso_mount)
905 # compat for releases < 2011.12
906 kernel = search_file('linux26', iso_mount)
909 logging.error("error locating kernel file")
910 raise CriticalException("Kernel not found")
912 source = os.path.dirname(kernel) + '/'
913 dest = target + '/' + os.path.dirname(kernel).replace(iso_mount, '') + '/'
915 exec_rsync(source, dest)
918 def update_grml_versions(iso_mount, target):
919 """Update the grml version file on a cd
920 Returns true if version was updated successfully,
921 False if grml-version does not exist yet on the mountpoint
923 @iso_mount: string of the iso mount point
924 @target: path of the target mount point
926 grml_target = target + '/grml/'
927 target_grml_version_file = search_file('grml-version', grml_target)
928 if target_grml_version_file:
929 iso_grml_version_file = search_file('grml-version', iso_mount)
930 if not iso_grml_version_file:
931 logging.warn("Warning: %s could not be found - can not install it", iso_grml_version_file)
934 # read the flavours from the iso image
936 iso_file = open(iso_grml_version_file, 'r')
937 for line in iso_file:
938 iso_versions[get_flavour(line)] = line.strip()
940 # update the existing flavours on the target
941 for line in fileinput.input([target_grml_version_file], inplace=1):
942 flavour = get_flavour(line)
943 if flavour in iso_versions.keys():
944 print(iso_versions.pop(flavour))
949 target_file = open(target_grml_version_file, 'a')
950 # add the new flavours from the current iso
951 for flavour in iso_versions:
952 target_file.write("%s\n" % iso_versions[flavour])
954 logging.warn("Warning: Could not write file")
963 def copy_grml_files(grml_flavour, iso_mount, target):
964 """copy some minor grml files to a given target
966 @grml_flavour: the current grml_flavour
967 @iso_mount: path where a grml ISO is mounted on
968 @target: path where grml's main files should be copied to"""
970 grml_target = target + '/grml/'
971 execute(mkdir, grml_target)
973 grml_prefixe = ["GRML", "grml"]
974 for prefix in grml_prefixe:
975 filename = "{0}/{1}/{2}".format(iso_mount, prefix, grml_flavour)
976 if os.path.exists(filename):
977 exec_rsync(filename, grml_target)
980 logging.warn("Warning: could not find flavour directory for %s ", grml_flavour)
983 def handle_addon_copy(filename, dst, iso_mount, ignore_errors=False):
984 """handle copy of optional addons
986 @filename: filename of the addon
987 @dst: destination directory
988 @iso_mount: location of the iso mount
989 @ignore_errors: don't report missing files
991 file_location = search_file(filename, iso_mount)
992 if file_location is None:
993 if not ignore_errors:
994 logging.warn("Warning: %s not found (that's fine if you don't need it)", filename)
996 exec_rsync(file_location, dst)
999 def copy_addons(iso_mount, target):
1000 """copy grml's addons files (like allinoneimg, bsd4grml,..) to a given target
1002 @iso_mount: path where a grml ISO is mounted on
1003 @target: path where grml's main files should be copied to"""
1005 addons = target + '/boot/addons/'
1006 execute(mkdir, addons)
1008 # grub all-in-one image
1009 handle_addon_copy('allinone.img', addons, iso_mount)
1012 handle_addon_copy('bsd4grml', addons, iso_mount)
1015 handle_addon_copy('balder10.imz', addons, iso_mount)
1017 # syslinux + pci.ids for hdt
1018 for expr in '*.c32', 'pci.ids':
1019 glob_and_copy(iso_mount + '/boot/addons/' + expr, addons)
1022 handle_addon_copy('memdisk', addons, iso_mount)
1025 handle_addon_copy('memtest', addons, iso_mount)
1027 # gpxe.lkrn: got replaced by ipxe
1028 handle_addon_copy('gpxe.lkrn', addons, iso_mount, ignore_errors=True)
1031 handle_addon_copy('ipxe.lkrn', addons, iso_mount)
1034 handle_addon_copy('netboot.xyz.lkrn', addons, iso_mount)
1037 def build_loopbackcfg(target):
1038 """Generate GRUB's loopback.cfg based on existing config files.
1040 @target: target directory
1043 grub_dir = '/boot/grub/'
1044 mkdir(os.path.join(target, grub_dir))
1046 f = open(target + grub_dir + 'loopback.cfg', 'w')
1048 f.write("# grml2usb generated grub2 configuration file\n")
1049 f.write("source /boot/grub/header.cfg\n")
1051 for defaults in glob.glob(target + os.path.sep + grub_dir + os.path.sep + "*_default.cfg"):
1052 sourcefile = defaults.split(target + os.path.sep)[1]
1053 logging.debug("Found source file" + sourcefile)
1054 os.path.isfile(defaults) and f.write("source " + sourcefile + "\n")
1056 for ops in glob.glob(target + os.path.sep + grub_dir + os.path.sep + "*_options.cfg"):
1057 sourcefile = ops.split(target + os.path.sep)[1]
1058 logging.debug("Found source file" + sourcefile)
1059 os.path.isfile(ops) and f.write("source " + sourcefile + "\n")
1061 f.write("source /boot/grub/addons.cfg\n")
1062 f.write("source /boot/grub/footer.cfg\n")
1066 def glob_and_copy(filepattern, dst):
1067 """Glob on specified filepattern and copy the result to dst
1069 @filepattern: globbing pattern
1070 @dst: target directory
1072 for name in glob.glob(filepattern):
1073 copy_if_exist(name, dst)
1076 def search_and_copy(filename, search_path, dst):
1077 """Search for the specified filename at searchpath and copy it to dst
1079 @filename: filename to look for
1080 @search_path: base search file
1081 @dst: destionation to copy the file to
1083 file_location = search_file(filename, search_path)
1084 copy_if_exist(file_location, dst)
1087 def copy_if_exist(filename, dst):
1088 """Copy filename to dst if filename is set.
1090 @filename: a filename
1093 if filename and (os.path.isfile(filename) or os.path.isdir(filename)):
1094 exec_rsync(filename, dst)
1097 def copy_bootloader_files(iso_mount, target, grml_flavour):
1098 """Copy grml's bootloader files to a given target
1100 @iso_mount: path where a grml ISO is mounted on
1101 @target: path where grml's main files should be copied to
1102 @grml_flavour: name of the current processed grml_flavour
1105 syslinux_target = target + '/boot/syslinux/'
1106 execute(mkdir, syslinux_target)
1108 grub_target = target + '/boot/grub/'
1109 execute(mkdir, grub_target)
1111 logo = search_file('logo.16', iso_mount)
1112 exec_rsync(logo, syslinux_target + 'logo.16')
1114 bootx64_efi = search_file('bootx64.efi', iso_mount)
1116 mkdir(target + '/efi/boot/')
1117 exec_rsync(bootx64_efi, target + '/efi/boot/bootx64.efi')
1119 efi_img = search_file('efi.img', iso_mount)
1121 mkdir(target + '/boot/')
1122 exec_rsync(efi_img, target + '/boot/efi.img')
1123 handle_secure_boot(target, efi_img)
1125 for ffile in ['f%d' % number for number in range(1, 11)]:
1126 search_and_copy(ffile, iso_mount, syslinux_target + ffile)
1128 # avoid the "file is read only, overwrite anyway (y/n) ?" question
1129 # of mtools by syslinux ("mmove -D o -D O s:/ldlinux.sys $target_file")
1130 if os.path.isfile(syslinux_target + 'ldlinux.sys'):
1131 os.unlink(syslinux_target + 'ldlinux.sys')
1133 (source_dir, name) = get_defaults_file(iso_mount, grml_flavour, "default.cfg")
1134 (source_dir, defaults_file) = get_defaults_file(iso_mount, grml_flavour, "grml.cfg")
1137 raise CriticalException(
1138 "file default.cfg could not be found.\n"
1139 "Note: this grml2usb version requires an ISO generated by grml-live >=0.9.24 ...\n"
1140 " ... either use grml releases >=2009.10 or switch to an older grml2usb version.")
1142 if not os.path.exists(iso_mount + '/boot/grub/footer.cfg'):
1143 logging.warning("Warning: Grml releases older than 2011.12 support only one flavour in grub.")
1145 for expr in name, 'distri.cfg', \
1146 defaults_file, 'grml.png', 'hd.cfg', 'isolinux.cfg', 'isolinux.bin', \
1147 'isoprompt.cfg', 'options.cfg', \
1148 'prompt.cfg', 'vesamenu.cfg', 'grml.png', '*.c32':
1149 glob_and_copy(iso_mount + source_dir + expr, syslinux_target)
1151 for filename in glob.glob1(syslinux_target, "*.c32"):
1152 copy_if_exist(os.path.join(SYSLINUX_LIBS, filename), syslinux_target)
1154 # copy the addons_*.cfg file to the new syslinux directory
1155 glob_and_copy(iso_mount + source_dir + 'addon*.cfg', syslinux_target)
1157 search_and_copy('hidden.cfg', iso_mount + source_dir, syslinux_target + "new_" + 'hidden.cfg')
1159 # copy all grub files from ISO
1160 glob_and_copy(iso_mount + '/boot/grub/*', grub_target)
1162 # finally (after all GRUB files have been installed) build static loopback.cfg
1163 build_loopbackcfg(target)
1166 def install_iso_files(grml_flavour, iso_mount, device, target):
1167 """Copy files from ISO to given target
1169 @grml_flavour: name of grml flavour the configuration should be generated for
1170 @iso_mount: path where a grml ISO is mounted on
1171 @device: device/partition where bootloader should be installed to
1172 @target: path where grml's main files should be copied to"""
1175 GRML_DEFAULT = GRML_DEFAULT or grml_flavour
1178 elif not options.bootloaderonly:
1179 logging.info("Copying files. This might take a while....")
1181 copy_system_files(grml_flavour, iso_mount, target)
1182 copy_grml_files(grml_flavour, iso_mount, target)
1183 except CriticalException as error:
1184 logging.critical("Execution failed: %s", error)
1187 if not options.skipaddons:
1188 if not search_file('addons', iso_mount):
1189 logging.info("Could not find addons, therefore not installing.")
1191 copy_addons(iso_mount, target)
1193 if not options.copyonly:
1194 copy_bootloader_files(iso_mount, target, grml_flavour)
1196 if not options.dryrun:
1197 handle_bootloader_config(grml_flavour, device, target)
1199 # make sure we sync filesystems before returning
1200 proc = subprocess.Popen(["sync"])
1204 def get_device_from_partition(partition):
1206 partition_number = None
1207 if partition[-1].isdigit() and not RE_LOOP_DEVICE.match(partition):
1208 m = RE_P_PARTITION.match(partition) or RE_PARTITION.match(partition)
1211 partition_number = int(m.group(2)) - 1
1212 return (device, partition_number)
1215 def get_flavour(flavour_str):
1216 """Returns the flavour of a grml version string
1218 return re.match(r'[\w-]*', flavour_str).group()
1221 def identify_grml_flavour(mountpath):
1222 """Get name of grml flavour
1224 @mountpath: path where the grml ISO is mounted to
1225 @return: name of grml-flavour"""
1227 version_files = search_file('grml-version', mountpath, lst_return=True)
1229 if not version_files:
1230 if mountpath.startswith("/lib/live/mount/medium"):
1231 logging.critical("Error: could not find grml-version file.")
1232 logging.critical("Looks like your system is running from RAM but required files are not available.")
1233 logging.critical("Please either boot without toram=... or use boot option toram instead of toram=...")
1235 logging.critical("Error: could not find grml-version file.")
1240 logging.debug("version_files = %s", version_files)
1241 for version_file in version_files:
1244 tmpfile = open(version_file, 'r')
1245 for line in tmpfile.readlines():
1246 flavours.append(get_flavour(line))
1254 def get_bootoptions(grml_flavour):
1255 """Returns bootoptions for specific flavour
1257 @grml_flavour: name of the grml_flavour
1259 # do NOT write "None" in kernel cmdline
1260 if not options.bootoptions:
1263 bootopt = " ".join(options.bootoptions)
1264 bootopt = bootopt.replace("%flavour", grml_flavour)
1268 def handle_grub_config(grml_flavour, device, target):
1269 """Main handler for generating grub (v1 and v2) configuration
1271 @grml_flavour: name of grml flavour the configuration should be generated for
1272 @device: device/partition where grub should be installed to
1273 @target: path of grub's configuration files"""
1277 logging.debug("Updating grub configuration")
1279 grub_target = target + '/boot/grub/'
1280 secureboot_target = target + '/EFI/ubuntu/'
1282 bootid_re = re.compile("bootid=[\w_-]+")
1283 live_media_path_re = re.compile("live-media-path=[\w_/-]+")
1285 bootopt = get_bootoptions(grml_flavour)
1288 option_re = re.compile(r'(.*/boot/.*(linux26|vmlinuz).*)')
1290 if options.removeoption:
1291 for regex in options.removeoption:
1292 remove_regexes.append(re.compile(regex))
1294 shortname = get_shortname(grml_flavour)
1295 for filename in glob.glob(grub_target + '*.cfg') + glob.glob(secureboot_target + '*.cfg'):
1296 for line in fileinput.input(filename, inplace=1):
1297 line = line.rstrip("\r\n")
1298 if option_re.search(line):
1299 line = bootid_re.sub('', line)
1300 if shortname in filename:
1301 line = live_media_path_re.sub('', line)
1302 line = line.rstrip() + ' live-media-path=/live/%s/ ' % (grml_flavour)
1303 line = line.rstrip() + r' bootid=%s %s ' % (UUID, bootopt)
1304 for regex in remove_regexes:
1305 line = regex.sub(' ', line)
1310 def initial_syslinux_config(target):
1311 """Generates initial syslinux configuration
1313 @target path of syslinux's configuration files"""
1315 target = target + "/"
1316 filename = target + "grmlmain.cfg"
1317 if os.path.isfile(target + "grmlmain.cfg"):
1319 data = open(filename, "w")
1320 data.write(generate_main_syslinux_config())
1323 filename = target + "hiddens.cfg"
1324 data = open(filename, "w")
1325 data.write("include hidden.cfg\n")
1329 def add_entry_if_not_present(filename, entry):
1330 """Write entry into filename if entry is not already in the file
1332 @filename: name of the file
1333 @entry: data to write to the file
1335 data = open(filename, "a+")
1345 def get_flavour_filename(flavour):
1346 """Generate a iso9960 save filename out of the specified flavour
1348 @flavour: grml flavour
1350 return flavour.replace('-', '_')
1353 def adjust_syslinux_bootoptions(src, flavour):
1354 """Adjust existing bootoptions of specified syslinux config to
1355 grml2usb specific ones, e.g. change the location of the kernel...
1357 @src: config file to alter
1358 @flavour: grml flavour
1361 append_re = re.compile("^(\s*append.*/boot/.*)$", re.I)
1362 # flavour_re = re.compile("(label.*)(grml\w+)")
1363 default_re = re.compile("(default.cfg)")
1364 bootid_re = re.compile("bootid=[\w_-]+")
1365 live_media_path_re = re.compile("live-media-path=[\w_/-]+")
1367 bootopt = get_bootoptions(flavour)
1371 if options.removeoption:
1372 option_re = re.compile(r'/boot/.*/(initrd.gz|initrd.img)')
1374 for regex in options.removeoption:
1375 regexe.append(re.compile(r'%s' % regex))
1377 for line in fileinput.input(src, inplace=1):
1378 # line = flavour_re.sub(r'\1 %s-\2' % flavour, line)
1379 line = default_re.sub(r'%s-\1' % flavour, line)
1380 line = bootid_re.sub('', line)
1381 line = live_media_path_re.sub('', line)
1382 line = append_re.sub(r'\1 live-media-path=/live/%s/ ' % flavour, line)
1383 line = append_re.sub(r'\1 boot=live %s ' % bootopt, line)
1384 line = append_re.sub(r'\1 %s=%s ' % ("bootid", UUID), line)
1385 if option_re and option_re.search(line):
1386 for regex in regexe:
1387 line = regex.sub(' ', line)
1388 sys.stdout.write(line)
1392 def adjust_labels(src, replacement):
1393 """Adjust the specified labels in the syslinux config file src with
1394 specified replacement
1396 label_re = re.compile("^(\s*label\s*) ([a-zA-Z0-9_-]+)", re.I)
1397 for line in fileinput.input(src, inplace=1):
1398 line = label_re.sub(replacement, line)
1399 sys.stdout.write(line)
1403 def add_syslinux_entry(filename, grml_flavour):
1404 """Add includes for a specific grml_flavour to the specified filename
1406 @filename: syslinux config file
1407 @grml_flavour: grml flavour to add
1410 entry_filename = "option_%s.cfg" % grml_flavour
1411 entry = "include %s\n" % entry_filename
1413 add_entry_if_not_present(filename, entry)
1414 path = os.path.dirname(filename)
1416 data = open(path + "/" + entry_filename, "w")
1417 data.write(generate_flavour_specific_syslinux_config(grml_flavour))
1421 def modify_filenames(grml_flavour, target, filenames):
1422 """Replace the standard filenames with the new ones
1424 @grml_flavour: grml-flavour strin
1425 @target: directory where the files are located
1426 @filenames: list of filenames to alter
1428 grml_filename = get_flavour_filename(grml_flavour)
1429 for filename in filenames:
1430 old_filename = "%s/%s" % (target, filename)
1431 new_filename = "%s/%s_%s" % (target, grml_filename, filename)
1432 os.rename(old_filename, new_filename)
1435 def remove_default_entry(filename):
1436 """Remove the default entry from specified syslinux file
1438 @filename: syslinux config file
1440 default_re = re.compile("^(\s*menu\s*default\s*)$", re.I)
1441 for line in fileinput.input(filename, inplace=1):
1442 if default_re.match(line):
1444 sys.stdout.write(line)
1448 def handle_syslinux_config(grml_flavour, target):
1449 """Main handler for generating syslinux configuration
1451 @grml_flavour: name of grml flavour the configuration should be generated for
1452 @target: path of syslinux's configuration files"""
1454 logging.debug("Generating syslinux configuration")
1455 syslinux_target = target + '/boot/syslinux/'
1456 # should be present via copy_bootloader_files(), but make sure it exits:
1457 execute(mkdir, syslinux_target)
1458 syslinux_cfg = syslinux_target + 'syslinux.cfg'
1460 # install main configuration only *once*, no matter how many ISOs we have:
1461 syslinux_config_file = open(syslinux_cfg, 'w')
1462 syslinux_config_file.write("timeout 300\n")
1463 syslinux_config_file.write("include vesamenu.cfg\n")
1464 syslinux_config_file.close()
1466 prompt_name = open(syslinux_target + 'promptname.cfg', 'w')
1467 prompt_name.write('menu label S^yslinux prompt\n')
1470 initial_syslinux_config(syslinux_target)
1471 flavour_filename = get_flavour_filename(grml_flavour)
1473 if search_file('default.cfg', syslinux_target):
1474 modify_filenames(grml_flavour, syslinux_target, ['grml.cfg', 'default.cfg'])
1476 filename = search_file("new_hidden.cfg", syslinux_target)
1478 # process hidden file
1479 if not search_file("hidden.cfg", syslinux_target):
1480 new_hidden = syslinux_target + "hidden.cfg"
1481 os.rename(filename, new_hidden)
1482 adjust_syslinux_bootoptions(new_hidden, grml_flavour)
1484 new_hidden_file = "%s/%s_hidden.cfg" % (syslinux_target, flavour_filename)
1485 os.rename(filename, new_hidden_file)
1486 adjust_labels(new_hidden_file, r'\1 %s-\2' % grml_flavour)
1487 adjust_syslinux_bootoptions(new_hidden_file, grml_flavour)
1488 entry = 'include %s_hidden.cfg\n' % flavour_filename
1489 add_entry_if_not_present("%s/hiddens.cfg" % syslinux_target, entry)
1491 new_default = "%s_default.cfg" % (flavour_filename)
1492 entry = 'include %s\n' % new_default
1493 defaults_file = '%s/defaults.cfg' % syslinux_target
1494 new_default_with_path = "%s/%s" % (syslinux_target, new_default)
1495 new_grml_cfg = "%s/%s_grml.cfg" % (syslinux_target, flavour_filename)
1497 if os.path.isfile(defaults_file):
1499 # remove default menu entry in menu
1500 remove_default_entry(new_default_with_path)
1502 # adjust all labels for additional isos
1503 adjust_labels(new_default_with_path, r'\1 %s' % grml_flavour)
1504 adjust_labels(new_grml_cfg, r'\1 %s-\2' % grml_flavour)
1506 # always adjust bootoptions
1507 adjust_syslinux_bootoptions(new_default_with_path, grml_flavour)
1508 adjust_syslinux_bootoptions(new_grml_cfg, grml_flavour)
1510 add_entry_if_not_present("%s/defaults.cfg" % syslinux_target, entry)
1512 add_syslinux_entry("%s/additional.cfg" % syslinux_target, flavour_filename)
1515 def handle_secure_boot(target, efi_img):
1516 """Provide secure boot support by extracting files from /boot/efi.img
1518 @target: path where grml's main files should be copied to
1519 @efi_img: path to the efi.img file that includes the files for secure boot
1522 mkdir(target + '/efi/boot/')
1523 efi_mountpoint = tempfile.mkdtemp(prefix="grml2usb", dir=os.path.abspath(options.tmpdir))
1524 logging.debug("efi_mountpoint = %s" % efi_mountpoint)
1525 register_tmpfile(efi_mountpoint)
1528 logging.debug("mount(%s, %s, ['-o', 'ro', '-t', 'vfat']" % (efi_img, efi_mountpoint))
1529 mount(efi_img, efi_mountpoint, ['-o', 'ro', '-t', 'vfat'])
1530 except CriticalException as error:
1531 logging.critical("Fatal: %s", error)
1534 ubuntu_cfg = search_file('grub.cfg', efi_mountpoint + '/EFI/ubuntu')
1535 logging.debug("ubuntu_cfg = %s" % ubuntu_cfg)
1537 logging.info("No /EFI/ubuntu/grub.cfg found inside EFI image, looks like Secure Boot support is missing.")
1539 mkdir(target + '/efi/ubuntu')
1540 logging.debug("exec_rsync(%s, %s + '/efi/ubuntu/grub.cfg')" % (ubuntu_cfg, target))
1541 exec_rsync(ubuntu_cfg, target + '/efi/ubuntu/grub.cfg')
1543 logging.debug("exec_rsync(%s + '/EFI/BOOT/grubx64.efi', %s + '/efi/boot/grubx64.efi')'" % (efi_mountpoint, target))
1544 exec_rsync(efi_mountpoint + '/EFI/BOOT/grubx64.efi', target + '/efi/boot/grubx64.efi')
1546 # NOTE - we're overwriting /efi/boot/bootx64.efi from copy_bootloader_files here
1547 logging.debug("exec_rsync(%s + '/EFI/BOOT/bootx64.efi', %s + '/efi/boot/bootx64.efi')'" % (efi_mountpoint, target))
1548 exec_rsync(efi_mountpoint + '/EFI/BOOT/bootx64.efi', target + '/efi/boot/bootx64.efi')
1551 unmount(efi_mountpoint, "")
1552 logging.debug('Unmounted %s' % efi_mountpoint)
1553 os.rmdir(efi_mountpoint)
1554 logging.debug('Removed directory %s' % efi_mountpoint)
1555 except StandardError:
1556 logging.critical('RuntimeError while umount %s' % efi_mountpoint)
1560 def handle_bootloader_config(grml_flavour, device, target):
1561 """Main handler for generating bootloader's configuration
1563 @grml_flavour: name of grml flavour the configuration should be generated for
1564 @device: device/partition where bootloader should be installed to
1565 @target: path of bootloader's configuration files"""
1568 UUID = get_uuid(target)
1569 if options.skipsyslinuxconfig:
1570 logging.info("Skipping generation of syslinux configuration as requested.")
1573 handle_syslinux_config(grml_flavour, target)
1574 except CriticalException as error:
1575 logging.critical("Fatal: %s", error)
1578 if options.skipgrubconfig:
1579 logging.info("Skipping generation of grub configuration as requested.")
1582 handle_grub_config(grml_flavour, device, target)
1583 except CriticalException as error:
1584 logging.critical("Fatal: %s", error)
1588 def install(image, device):
1589 """Install a grml image to the specified device
1591 @image: directory or is file
1592 @device: partition or directory to install the device
1594 iso_mountpoint = image
1595 remove_image_mountpoint = False
1596 if os.path.isdir(image):
1597 if options.force or os.path.exists(os.path.join(image, 'live')):
1598 logging.info("Using %s as install base", image)
1600 q = raw_input("%s does not look like a Grml system. "
1601 "Do you really want to use this image? y/N " % image)
1602 if q.lower() == 'y':
1603 logging.info("Using %s as install base", image)
1605 logging.info("Skipping install base %s", image)
1607 logging.info("Using ISO %s", image)
1608 iso_mountpoint = tempfile.mkdtemp(prefix="grml2usb", dir=os.path.abspath(options.tmpdir))
1609 register_tmpfile(iso_mountpoint)
1610 remove_image_mountpoint = True
1612 mount(image, iso_mountpoint, ["-o", "loop,ro", "-t", "iso9660"])
1613 except CriticalException as error:
1614 logging.critical("Fatal: %s", error)
1618 install_grml(iso_mountpoint, device)
1620 if remove_image_mountpoint:
1622 remove_mountpoint(iso_mountpoint)
1623 except CriticalException as error:
1628 def install_grml(mountpoint, device):
1629 """Main logic for copying files of the currently running Grml system.
1631 @mountpoint: directory where currently running live system resides (usually /lib/live/mount/medium)
1632 @device: partition where the specified ISO should be installed to"""
1634 device_mountpoint = device
1635 if os.path.isdir(device):
1636 logging.info("Specified device is a directory, therefore not mounting.")
1637 remove_device_mountpoint = False
1639 device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
1640 register_tmpfile(device_mountpoint)
1641 remove_device_mountpoint = True
1643 check_for_fat(device)
1644 if not options.skipbootflag:
1645 check_boot_flag(device)
1648 mount(device, device_mountpoint, ['-o', 'utf8,iocharset=iso8859-1'])
1649 except CriticalException as error:
1650 mount(device, device_mountpoint, "")
1652 grml_flavours = identify_grml_flavour(mountpoint)
1653 for flavour in set(grml_flavours):
1655 logging.warning("No valid flavour found, please check your iso")
1656 logging.info("Identified grml flavour \"%s\".", flavour)
1657 install_iso_files(flavour, mountpoint, device, device_mountpoint)
1658 GRML_FLAVOURS.add(flavour)
1660 if remove_device_mountpoint:
1661 remove_mountpoint(device_mountpoint)
1664 def remove_mountpoint(mountpoint):
1665 """remove a registered mountpoint
1669 unmount(mountpoint, "")
1670 if os.path.isdir(mountpoint):
1671 os.rmdir(mountpoint)
1672 unregister_tmpfile(mountpoint)
1673 except CriticalException as error:
1678 def handle_mbr(device):
1679 """Main handler for installing master boot record (MBR)
1681 @device: device where the MBR should be installed to"""
1684 logging.info("Would install MBR")
1687 mbr_device, partition_number = get_device_from_partition(device)
1688 if partition_number is None:
1689 logging.warn("Could not detect partition number, not activating partition")
1691 # if we get e.g. /dev/loop1 as device we don't want to put the MBR
1692 # into /dev/loop of course, therefore use /dev/loop1 as mbr_device
1693 if mbr_device == "/dev/loop":
1695 logging.info("Detected loop device - using %s as MBR device therefore", mbr_device)
1697 mbrcode = GRML2USB_BASE + '/mbr/mbrldr'
1698 if options.syslinuxmbr:
1700 mbr_locations = ('/usr/lib/syslinux/mbr.bin',
1701 '/usr/lib/syslinux/bios/mbr.bin',
1702 '/usr/share/syslinux/mbr.bin')
1703 for mbrpath in mbr_locations:
1704 if os.path.isfile(mbrpath):
1709 str_locations = " or ".join(['"%s"' % l for l in mbr_locations])
1710 logging.error('Cannot find syslinux MBR, install it at %s)',
1712 raise CriticalException("syslinux MBR can not be found at %s."
1714 elif options.mbrmenu:
1715 mbrcode = GRML2USB_BASE + '/mbr/mbrldr'
1718 install_mbr(mbrcode, mbr_device, partition_number, True)
1719 except (IOError, Exception) as error:
1720 logging.critical("Execution failed: %s", error)
1724 def handle_vfat(device):
1725 """Check for FAT specific settings and options
1727 @device: device that should checked / formated"""
1729 # make sure we have mkfs.vfat available
1731 if not which("mkfs.vfat") and not options.copyonly and not options.dryrun:
1732 logging.critical('Sorry, mkfs.vfat not available. Exiting.')
1733 logging.critical('Please make sure to install dosfstools.')
1737 print("Forcing mkfs.fat16 on %s as requested via option --force." % device)
1739 # make sure the user is aware of what he is doing
1740 f = raw_input("Are you sure you want to format the specified partition with fat16? y/N ")
1741 if f == "y" or f == "Y":
1742 logging.info("Note: you can skip this question using the option --force")
1747 except CriticalException as error:
1748 logging.critical("Execution failed: %s", error)
1751 # check for vfat filesystem
1752 if device is not None and not os.path.isdir(device) and options.syslinux:
1754 check_for_fat(device)
1755 except CriticalException as error:
1756 logging.critical("Execution failed: %s", error)
1759 if options.skipusbcheck:
1760 logging.info("Not checking for removable USB device as requested via option --skip-usb-check.")
1763 if not os.path.isdir(device) and not check_for_usbdevice(device) and not options.force:
1764 print("Warning: the specified device %s does not look like a removable usb device." % device)
1765 f = raw_input("Do you really want to continue? y/N ")
1766 if f.lower() != "y":
1770 def handle_compat_warning(device):
1771 """Backwards compatible checks
1773 @device: device that should be checked"""
1775 # make sure we can replace old grml2usb script and warn user when using old way of life:
1776 if device.startswith("/mnt/external") or device.startswith("/mnt/usb") and not options.force:
1777 print("Warning: the semantics of grml2usb has changed.")
1778 print("Instead of using grml2usb /path/to/iso %s you might" % device)
1779 print("want to use grml2usb /path/to/iso /dev/... instead.")
1780 print("Please check out the grml2usb manpage for details.")
1781 f = raw_input("Do you really want to continue? y/N ")
1782 if f.lower() != "y":
1786 def handle_logging():
1787 """Log handling and configuration"""
1789 if options.verbose and options.quiet:
1790 parser.error("please use either verbose (--verbose) or quiet (--quiet) option")
1792 FORMAT = "%(message)s"
1794 FORMAT = "%(asctime)-15s %(message)s"
1795 logging.basicConfig(level=logging.DEBUG, format=FORMAT)
1797 logging.basicConfig(level=logging.CRITICAL, format=FORMAT)
1799 logging.basicConfig(level=logging.INFO, format=FORMAT)
1802 def handle_bootloader(device):
1803 """wrapper for installing bootloader
1805 @device: device where bootloader should be installed to"""
1807 # Install bootloader only if not using the --copy-only option
1808 if options.copyonly:
1809 logging.info("Not installing bootloader and its files as requested via option copyonly.")
1810 elif os.path.isdir(device):
1811 logging.info("Not installing bootloader as %s is a directory.", device)
1813 install_bootloader(device)
1816 def check_options(opts):
1817 """Check compatibility of provided user opts
1819 @opts option dict from OptionParser
1821 if opts.grubmbr and not opts.grub:
1822 raise CriticalException("--grub-mbr requires --grub option.")
1824 if opts.copyonly and opts.grub:
1825 raise CriticalException("Cannot use --copy-only and --grub at the same time.")
1828 def check_programs():
1829 """check if all needed programs are installed"""
1832 GRUB_INSTALL = which("grub-install") or which("grub2-install")
1833 if not GRUB_INSTALL:
1834 logging.critical("Fatal: grub-install not available (please install the " +
1835 "grub package or drop the --grub option)")
1838 if options.syslinux:
1839 if not which("syslinux"):
1840 logging.critical("Fatal: syslinux not available (please install the " +
1841 "syslinux package or use the --grub option)")
1844 if not which("rsync"):
1845 logging.critical("Fatal: rsync not available, can not continue - sorry.")
1850 """Runs modprobe loop and throws away it's output"""
1851 if not which("modprobe"):
1852 logging.critical("Fatal: modprobe not available, can not continue - sorry.")
1853 logging.critical("Hint: is /sbin missing in PATH?")
1856 proc = subprocess.Popen(["modprobe", "loop"], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
1861 """Main function [make pylint happy :)]"""
1865 print(os.path.basename(sys.argv[0]) + " " + PROG_VERSION)
1869 parser.error("invalid usage")
1874 # make sure we have the appropriate permissions
1877 check_options(options)
1881 logging.info("Executing grml2usb version %s", PROG_VERSION)
1884 logging.info("Running in simulation mode as requested via option dry-run.")
1888 # specified arguments
1889 device = os.path.realpath(args[len(args) - 1])
1890 isos = args[0:len(args) - 1]
1892 if not os.path.isdir(device):
1893 if device[-1:].isdigit():
1894 if int(device[-1:]) > 4 or device[-2:].isdigit():
1895 logging.warn("Warning: installing on partition number >4, booting *might* fail depending on your system.")
1897 # provide upgrade path
1898 handle_compat_warning(device)
1900 # check for vfat partition
1903 # main operation (like installing files)
1905 install(iso, device)
1908 is_superfloppy = not device[-1:].isdigit()
1910 logging.info("Detected superfloppy format - not installing MBR")
1912 if not options.skipmbr and not os.path.isdir(device) and not is_superfloppy:
1915 handle_bootloader(device)
1917 logging.info("Note: grml flavour %s was installed as the default booting system.", GRML_DEFAULT)
1919 for flavour in GRML_FLAVOURS:
1920 logging.info("Note: you can boot flavour %s using '%s' on the commandline.", flavour, flavour)
1922 # finally be polite :)
1923 logging.info("Finished execution of grml2usb (%s). Have fun with your Grml system.", PROG_VERSION)
1925 except Exception as error:
1926 logging.critical("Fatal: %s", str(error))
1930 if __name__ == "__main__":
1933 except KeyboardInterrupt:
1934 logging.info("Received KeyboardInterrupt")
1937 # END OF FILE ##################################################################
1938 # vim:foldmethod=indent expandtab ai ft=python tw=120 fileencoding=utf-8