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 optparse import OptionParser
17 from inspect import isroutine, isclass
33 # The line following this line is patched by debian/rules and tarball.sh.
34 PROG_VERSION = '***UNRELEASED***'
37 MOUNTED = set() # register mountpoints
38 TMPFILES = set() # register tmpfiles
39 DATESTAMP = time.mktime(datetime.datetime.now().timetuple()) # unique identifier for syslinux.cfg
40 GRML_FLAVOURS = set() # which flavours are being installed?
43 SYSLINUX_LIBS = "/usr/lib/syslinux/"
44 GPT_HEADER = "\x55\xaa\x45\x46\x49\x20\x50\x41\x52\x54" # original GPT header
47 RE_PARTITION = re.compile(r'([a-z/]*?)(\d+)$')
48 RE_P_PARTITION = re.compile(r'(.*?\d+)p(\d+)$')
49 RE_LOOP_DEVICE = re.compile(r'/dev/loop\d+$')
52 def syslinux_warning(option, opt, value, opt_parser):
53 """A helper function for printing a warning about deprecated option
55 # pylint: disable-msg=W0613
56 sys.stderr.write("Note: the --syslinux option is deprecated as syslinux "
57 "is grml2usb's default. Continuing anyway.\n")
58 setattr(opt_parser.values, option.dest, True)
61 # if grub option is set, unset syslinux option
62 def grub_option(option, opt, value, opt_parser):
63 """A helper function adjusting other option values
65 # pylint: disable-msg=W0613
66 setattr(opt_parser.values, option.dest, True)
67 setattr(opt_parser.values, 'syslinux', False)
70 USAGE = "Usage: %prog [options] <[ISO[s] | /lib/live/mount/medium]> </dev/sdX#>\n\
72 %prog installs Grml ISO[s] to an USB device to be able to boot from it.\n\
73 Make sure you have at least one Grml ISO or a running Grml system (/lib/live/mount/medium),\n\
74 grub or syslinux and root access.\n\
76 Run %prog --help for usage hints, further information via: man grml2usb"
78 # pylint: disable-msg=C0103
79 # pylint: disable-msg=W0603
80 parser = OptionParser(usage=USAGE)
81 parser.add_option("--bootoptions", dest="bootoptions",
82 action="append", type="string",
83 help="use specified bootoptions as default")
84 parser.add_option("--bootloader-only", dest="bootloaderonly", action="store_true",
85 help="do not copy files but just install a bootloader")
86 parser.add_option("--copy-only", dest="copyonly", action="store_true",
87 help="copy files only but do not install bootloader")
88 parser.add_option("--dry-run", dest="dryrun", action="store_true",
89 help="avoid executing commands")
90 parser.add_option("--fat16", dest="fat16", action="store_true",
91 help="format specified partition with FAT16")
92 parser.add_option("--force", dest="force", action="store_true",
93 help="force any actions requiring manual interaction")
94 parser.add_option("--grub", dest="grub", action="callback",
96 help="install grub bootloader instead of (default) syslinux")
97 parser.add_option("--grub-mbr", dest="grubmbr", action="store_true",
98 help="install grub into MBR instead of (default) PBR")
99 parser.add_option("--mbr-menu", dest="mbrmenu", action="store_true",
100 help="enable interactive boot menu in MBR")
101 parser.add_option("--quiet", dest="quiet", action="store_true",
102 help="do not output anything but just errors on console")
103 parser.add_option("--remove-bootoption", dest="removeoption", action="append",
104 help="regex for removing existing bootoptions")
105 parser.add_option("--skip-addons", dest="skipaddons", action="store_true",
106 help="do not install /boot/addons/ files")
107 parser.add_option("--skip-grub-config", dest="skipgrubconfig", action="store_true",
108 help="skip generation of grub configuration files")
109 parser.add_option("--skip-mbr", dest="skipmbr", action="store_true",
110 help="do not install a master boot record (MBR) on the device")
111 parser.add_option("--skip-syslinux-config", dest="skipsyslinuxconfig", action="store_true",
112 help="skip generation of syslinux configuration files")
113 parser.add_option("--syslinux", dest="syslinux", action="callback", default=True,
114 callback=syslinux_warning,
115 help="install syslinux bootloader (deprecated as it's the default)")
116 parser.add_option("--syslinux-mbr", dest="syslinuxmbr", action="store_true",
117 help="install syslinux master boot record (MBR) instead of default")
118 parser.add_option("--tmpdir", dest="tmpdir", default="/tmp",
119 help="directory to be used for temporary files")
120 parser.add_option("--verbose", dest="verbose", action="store_true",
121 help="enable verbose mode")
122 parser.add_option("-v", "--version", dest="version", action="store_true",
123 help="display version and exit")
124 (options, args) = parser.parse_args()
127 GRML2USB_BASE = '/usr/share/grml2usb'
128 if not os.path.isdir(GRML2USB_BASE):
129 GRML2USB_BASE = os.path.dirname(os.path.realpath(__file__))
132 class CriticalException(Exception):
133 """Throw critical exception if the exact error is not known but fatal.
135 @Exception: message"""
139 class VerifyException(Exception):
140 """Throw critical exception if there is an fatal error when verifying something.
142 @Exception: message"""
146 # The following two functions help to operate on strings as
147 # array (list) of bytes (octets). In Python 3000, the bytes
148 # datatype will need to be used. This is intended for using
149 # with manipulation of files on the octet level, like shell
150 # arrays, e.g. in MBR creation.
153 def array2string(*a):
154 """Convert a list of integers [0;255] to a string."""
155 return struct.pack("%sB" % len(a), *a)
159 """Convert a (bytes) string into a list of integers."""
160 return struct.unpack("%sB" % len(s), s)
164 """Cleanup function to make sure there aren't any mounted devices left behind.
166 def del_failed(fn, filepath, exc):
167 msg = "Deletion of %s failed in temporary folder %s"
168 logging.warn(msg % (filepath, path))
170 logging.info("Cleaning up before exiting...")
171 proc = subprocess.Popen(["sync"])
174 for device in MOUNTED.copy():
177 logging.debug('Unmounted %s' % device)
178 except StandardError:
179 logging.debug('RuntimeError while umount %s, ignoring' % device)
181 for tmppath in TMPFILES.copy():
183 if os.path.isdir(tmppath) and not os.path.islink(tmppath):
184 # symbolic links to directories are ignored
185 # without the check it will throw an OSError
186 shutil.rmtree(tmppath, onerror=del_failed)
187 logging.debug('temporary directory %s deleted' % tmppath)
188 unregister_tmpfile(tmppath)
191 logging.debug('temporary file %s deleted' % tmppath)
192 unregister_tmpfile(tmppath)
193 except StandardError:
194 msg = 'RuntimeError while removing temporary %s, ignoring'
195 logging.debug(msg % tmppath)
198 def register_tmpfile(path):
206 def unregister_tmpfile(path):
208 remove registered tmpfile
212 TMPFILES.remove(path)
217 def register_mountpoint(target):
218 """register specified target in a set() for handling clean exiting
220 @target: destination target of mountpoint
226 def unregister_mountpoint(target):
227 """unregister specified target in a set() for handling clean exiting
229 @target: destination target of mountpoint
232 if target in MOUNTED:
233 MOUNTED.remove(target)
236 def get_function_name(obj):
237 """Helper function for use in execute() to retrive name of a function
239 @obj: the function object
241 if not (isroutine(obj) or isclass(obj)):
243 return obj.__module__ + '.' + obj.__name__
246 def execute(f, *exec_arguments):
247 """Wrapper for executing a command. Either really executes
248 the command (default) or when using --dry-run commandline option
249 just displays what would be executed."""
250 # usage: execute(subprocess.Popen, (["ls", "-la"]))
252 # pylint: disable-msg=W0141
253 logging.debug('dry-run only: %s(%s)', get_function_name(f), ', '.join(map(repr, exec_arguments)))
255 # pylint: disable-msg=W0142
256 return f(*exec_arguments)
260 """Check whether a given file can be executed
262 @fpath: full path to file
264 return os.path.exists(fpath) and os.access(fpath, os.X_OK)
268 """Check whether a given program is available in PATH
270 @program: name of executable"""
271 fpath = os.path.split(program)[0]
276 for path in os.environ["PATH"].split(os.pathsep):
277 exe_file = os.path.join(path, program)
284 def get_defaults_file(iso_mount, flavour, name):
285 """get the default file for syslinux
287 bootloader_dirs = ['/boot/isolinux/', '/boot/syslinux/']
288 for directory in bootloader_dirs:
290 "%s_%s" % (get_flavour_filename(flavour), name):
291 if os.path.isfile(iso_mount + directory + name):
292 return (directory, name)
296 def search_file(filename, search_path='/bin' + os.pathsep + '/usr/bin', lst_return=False):
297 """Given a search path, find file
299 @filename: name of file to search for
300 @search_path: path where searching for the specified filename
301 @lst_return: return list of matching files instead one file"""
302 paths = search_path.split(os.pathsep)
303 current_dir = '' # make pylint happy :)
307 """Helper function ffor testing if specified file exists in cwd
309 @cwd: current working directory
311 return os.path.exists(os.path.join(cwd, filename))
315 if match_file(current_dir):
316 retval.append(os.path.abspath(os.path.join(current_dir, filename)))
319 # pylint: disable-msg=W0612
320 for current_dir, directories, files in os.walk(path):
321 if match_file(current_dir):
322 retval.append(os.path.abspath(os.path.join(current_dir, filename)))
333 def check_uid_root():
334 """Check for root permissions"""
335 if not os.geteuid() == 0:
336 raise CriticalException("please run this script with uid 0 (root).")
339 def check_boot_flag(device):
340 boot_dev, x = get_device_from_partition(device)
342 with open(boot_dev, 'r') as image:
343 data = image.read(520)
344 bootcode = data[440:]
345 gpt_data = bootcode[70:80]
347 if gpt_data == GPT_HEADER:
348 logging.info("GPT detected, skipping bootflag check")
349 elif bootcode[6] == '\x80':
350 logging.debug("bootflag is enabled")
352 logging.debug("bootflag is NOT enabled")
353 raise VerifyException("Device %s does not have the bootflag set. "
354 "Please enable it to be able to boot." % boot_dev)
357 def mkfs_fat16(device):
358 """Format specified device with VFAT/FAT16 filesystem.
360 @device: partition that should be formated"""
363 logging.info("Would execute mkfs.vfat -F 16 %s now.", device)
366 logging.info("Formating partition with fat16 filesystem")
367 logging.debug("mkfs.vfat -F 16 %s", device)
368 proc = subprocess.Popen(["mkfs.vfat", "-F", "16", device])
370 if proc.returncode != 0:
371 raise CriticalException("error executing mkfs.vfat")
374 def generate_isolinux_splash(grml_flavour):
375 """Generate bootsplash for isolinux/syslinux
377 @grml_flavour: name of grml flavour the configuration should be generated for"""
379 grml_name = grml_flavour
382 \ f17
\f\18/boot/syslinux/logo.16
384 Some information and boot options available via keys F2 - F10. http://grml.org/
386 """ % {'grml_name': grml_name})
389 def generate_main_syslinux_config(*arg):
390 """Generate main configuration for use in syslinux.cfg
392 @*arg: just for backward compatibility"""
393 # pylint: disable-msg=W0613
394 # remove warning about unused arg
398 menu label Default boot modes:
407 menu label Additional boot entries for:
409 include additional.cfg
416 include promptname.cfg
419 Jump to old style isolinux prompt
420 featuring further information
421 regarding available boot options.
429 def generate_flavour_specific_syslinux_config(grml_flavour):
430 """Generate flavour specific configuration for use in syslinux.cfg
432 @grml_flavour: name of grml flavour the configuration should be generated for"""
435 menu begin grml %(grml_flavour)s
436 menu title %(display_name)s
438 menu label ^Back to main menu...
441 # include config for boot parameters from disk
442 include %(grml_flavour)s_grml.cfg
445 """ % {'grml_flavour': grml_flavour, 'display_name': get_flavour_filename(grml_flavour)})
448 def install_grub(device):
449 """Install grub on specified device.
451 @mntpoint: mountpoint of device where grub should install its files to
452 @device: partition where grub should be installed to"""
455 logging.info("Would execute grub-install [--root-directory=mount_point] %s now.", device)
457 device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
458 register_tmpfile(device_mountpoint)
461 mount(device, device_mountpoint, "")
463 # If using --grub-mbr then make sure we install grub in MBR instead of PBR
465 logging.debug("Using option --grub-mbr ...")
466 grub_device, x = get_device_from_partition(device)
470 logging.info("Installing grub as bootloader")
471 for opt in ["", "--force"]:
472 logging.debug("grub-install --recheck %s --no-floppy --root-directory=%s %s",
473 opt, device_mountpoint, grub_device)
474 proc = subprocess.Popen([GRUB_INSTALL, "--recheck", opt, "--no-floppy",
475 "--root-directory=%s" % device_mountpoint, grub_device],
476 stdout=file(os.devnull, "r+"))
478 if proc.returncode == 0:
481 if proc.returncode != 0:
482 # raise Exception("error executing grub-install")
483 logging.critical("Fatal: error executing grub-install "
484 + "(please check the grml2usb FAQ or drop the --grub option)")
485 logging.critical("Note: if using grub2 consider using "
486 + "the --grub-mbr option as grub considers PBR problematic.")
489 except CriticalException, error:
490 logging.critical("Fatal: %s", error)
495 unmount(device_mountpoint, "")
496 os.rmdir(device_mountpoint)
497 unregister_tmpfile(device_mountpoint)
500 def install_syslinux(device):
501 """Install syslinux on specified device.
503 @device: partition where syslinux should be installed to"""
506 logging.info("Would install syslinux as bootloader on %s", device)
509 # syslinux -d boot/isolinux /dev/sdb1
510 logging.info("Installing syslinux as bootloader")
511 logging.debug("syslinux -d boot/syslinux %s", device)
512 proc = subprocess.Popen(["syslinux", "-d", "boot/syslinux", device])
514 if proc.returncode != 0:
515 raise CriticalException("Error executing syslinux (either try --fat16 or use grub?)")
518 def install_bootloader(device):
519 """Install bootloader on specified device.
521 @device: partition where bootloader should be installed to"""
523 # by default we use grub, so install syslinux only on request
527 except CriticalException, error:
528 logging.critical("Fatal: %s", error)
533 install_syslinux(device)
534 except CriticalException, error:
535 logging.critical("Fatal: %s", error)
540 def install_mbr(mbrtemplate, device, partition, ismirbsdmbr=True):
541 """install 'mbr' master boot record (MBR) on a device
543 Retrieve the partition table from "device", install an MBR from the
544 "mbrtemplate" file, set the "partition" (0..3) active, and install the
545 result back to "device".
547 @mbrtemplate: default MBR file
549 @device: name of a file assumed to be a hard disc (or USB stick) image, or
550 something like "/dev/sdb"
552 @partition: must be a number between 0 and 3, inclusive
554 @mbrtemplate: must be a valid MBR file of at least 440 (or 439 if
557 @ismirbsdmbr: if true then ignore the active flag, set the mirbsdmbr
558 specific flag to 0/1/2/3 and set the MBR's default value accordingly. If
559 false then leave the mirbsdmbr specific flag set to FFh, set all
560 active flags to 0 and set the active flag of the partition to 80h. Note:
561 behaviour of mirbsdmbr: if flag = 0/1/2/3 then use it, otherwise search for
564 logging.info("Installing default MBR")
566 if not os.path.isfile(mbrtemplate):
567 logging.error('Error installing MBR (either try --syslinux-mbr or '
568 'install missing file "%s"?)', mbrtemplate)
569 raise CriticalException("%s can not be read." % mbrtemplate)
571 if partition is not None and ((partition < 0) or (partition > 3)):
572 logging.warn("Cannot activate partition %d", partition)
580 tmpf = tempfile.NamedTemporaryFile()
582 logging.debug("executing: dd if='%s' of='%s' bs=512 count=1", device, tmpf.name)
583 proc = subprocess.Popen(["dd", "if=%s" % device, "of=%s" % tmpf.name, "bs=512", "count=1"],
584 stderr=file(os.devnull, "r+"))
586 if proc.returncode != 0:
587 raise Exception("error executing dd (first run)")
589 logging.debug("executing: dd if=%s of=%s bs=%s count=1 conv=notrunc", mbrtemplate,
590 tmpf.name, nmbrbytes)
591 proc = subprocess.Popen(["dd", "if=%s" % mbrtemplate, "of=%s" % tmpf.name, "bs=%s" % nmbrbytes,
592 "count=1", "conv=notrunc"], stderr=file(os.devnull, "r+"))
594 if proc.returncode != 0:
595 raise Exception("error executing dd (second run)")
597 mbrcode = tmpf.file.read(512)
598 if len(mbrcode) < 512:
599 raise EOFError("MBR size (%d) < 512" % len(mbrcode))
601 if partition is not None:
603 mbrcode = mbrcode[0:439] + chr(partition) + \
604 mbrcode[440:510] + "\x55\xAA"
606 actives = ["\x00", "\x00", "\x00", "\x00"]
607 actives[partition] = "\x80"
608 mbrcode = mbrcode[0:446] + actives[0] + \
609 mbrcode[447:462] + actives[1] + \
610 mbrcode[463:478] + actives[2] + \
611 mbrcode[479:494] + actives[3] + \
612 mbrcode[495:510] + "\x55\xAA"
616 tmpf.file.write(mbrcode)
619 logging.debug("executing: dd if='%s' of='%s' bs=512 count=1 conv=notrunc", tmpf.name, device)
620 proc = subprocess.Popen(["dd", "if=%s" % tmpf.name, "of=%s" % device, "bs=512", "count=1",
621 "conv=notrunc"], stderr=file(os.devnull, "r+"))
623 if proc.returncode != 0:
624 raise Exception("error executing dd (third run)")
628 def is_writeable(device):
629 """Check if the device is writeable for the current user
631 @device: partition where bootloader should be installed to"""
635 #raise Exception("no device for checking write permissions")
637 if not os.path.exists(device):
640 return os.access(device, os.W_OK) and os.access(device, os.R_OK)
643 def mount(source, target, mount_options):
644 """Mount specified source on given target
646 @source: name of device/ISO that should be mounted
647 @target: directory where the ISO should be mounted to
648 @options: mount specific options"""
650 # note: options.dryrun does not work here, as we have to
651 # locate files and identify the grml flavour
653 for x in file('/proc/mounts').readlines():
654 if x.startswith(source):
655 raise CriticalException("Error executing mount: %s already mounted - " % source
656 + "please unmount before invoking grml2usb")
658 if os.path.isdir(source):
659 logging.debug("Source %s is not a device, therefore not mounting.", source)
662 logging.debug("mount %s %s %s", mount_options, source, target)
663 proc = subprocess.Popen(["mount"] + list(mount_options) + [source, target])
665 if proc.returncode != 0:
666 raise CriticalException("Error executing mount (no filesystem on the partition?)")
668 logging.debug("register_mountpoint(%s)", target)
669 register_mountpoint(target)
672 def unmount(target, unmount_options):
673 """Unmount specified target
675 @target: target where something is mounted on and which should be unmounted
676 @options: options for umount command"""
678 # make sure we unmount only already mounted targets
679 target_unmount = False
680 mounts = open('/proc/mounts').readlines()
681 mountstring = re.compile(".*%s.*" % re.escape(os.path.realpath(target)))
683 if re.match(mountstring, line):
684 target_unmount = True
686 if not target_unmount:
687 logging.debug("%s not mounted anymore", target)
689 logging.debug("umount %s %s", list(unmount_options), target)
690 proc = subprocess.Popen(["umount"] + list(unmount_options) + [target])
692 if proc.returncode != 0:
693 raise Exception("Error executing umount")
695 logging.debug("unregister_mountpoint(%s)", target)
696 unregister_mountpoint(target)
699 def check_for_usbdevice(device):
700 """Check whether the specified device is a removable USB device
702 @device: device name, like /dev/sda1 or /dev/sda
705 usbdevice = re.match(r'/dev/(.*?)\d*$', device).group(1)
707 usbdev = os.path.realpath('/sys/class/block/' + usbdevice + '/removable')
708 if not os.path.isfile(usbdev):
709 # Ubuntu with kernel 2.6.24 for example:
710 usbdev = os.path.realpath('/sys/block/' + usbdevice + '/removable')
712 if os.path.isfile(usbdev):
713 is_usb = open(usbdev).readline()
720 def check_for_fat(partition):
721 """Check whether specified partition is a valid VFAT/FAT16 filesystem
723 @partition: device name of partition"""
725 if not os.access(partition, os.R_OK):
726 raise CriticalException("Failed to read device %s"
727 " (wrong UID/permissions or device/directory not present?)" % partition)
730 udev_info = subprocess.Popen(["/sbin/blkid", "-s", "TYPE", "-o", "value", partition],
731 stdout=subprocess.PIPE, stderr=subprocess.PIPE)
732 filesystem = udev_info.communicate()[0].rstrip()
734 if filesystem != "vfat":
735 raise CriticalException(
736 "Partition %s does not contain a FAT16 filesystem. "
737 "(Use --fat16 or run mkfs.vfat %s)" % (partition, partition))
740 raise CriticalException("Sorry, /sbin/blkid not available (install e2fsprogs?)")
743 def mkdir(directory):
744 """Simple wrapper around os.makedirs to get shell mkdir -p behaviour"""
746 # just silently pass as it's just fine it the directory exists
747 if not os.path.isdir(directory):
749 os.makedirs(directory)
750 # pylint: disable-msg=W0704
755 def exec_rsync(source, target):
756 """Simple wrapper around rsync to install files
758 @source: source file/directory
759 @target: target file/directory"""
760 logging.debug("Source: %s / Target: %s", source, target)
761 proc = subprocess.Popen(["rsync", "-rlptDH", "--inplace", source, target])
763 if proc.returncode == 12:
764 logging.critical("Fatal: No space left on device")
768 if proc.returncode != 0:
769 logging.critical("Fatal: could not install %s", source)
774 def write_uuid(target_file):
775 """Generates an returns uuid and write it to the specified file
777 @target_file: filename to write the uuid to
780 fileh = open(target_file, 'w')
781 uid = str(uuid.uuid4())
787 def get_uuid(target):
788 """Get the uuid of the specified target. Will generate an uuid if none exist.
790 @target: directory/mountpoint containing the grml layout
793 conf_target = target + "/conf/"
794 uuid_file_name = conf_target + "/bootid.txt"
795 if os.path.isdir(conf_target):
796 if os.path.isfile(uuid_file_name):
797 uuid_file = open(uuid_file_name, 'r')
798 uid = uuid_file.readline().strip()
802 return write_uuid(uuid_file_name)
804 execute(mkdir, conf_target)
805 return write_uuid(uuid_file_name)
808 def get_shortname(grml_flavour):
809 """Get shortname based from grml_flavour name. The rules applied are the same as in grml-live
810 @grml_flavour: flavour name which shold be translated to shortname"""
812 return re.sub(r'[,._-]', '', grml_flavour)
815 def copy_system_files(grml_flavour, iso_mount, target):
816 """copy grml's main files (like squashfs, kernel and initrd) to a given target
818 @grml_flavour: name of grml flavour the configuration should be generated for
819 @iso_mount: path where a grml ISO is mounted on
820 @target: path where grml's main files should be copied to"""
822 squashfs = search_file(grml_flavour + '.squashfs', iso_mount)
824 logging.error("error locating squashfs file")
825 raise CriticalException("squashfs file not found, please check that your iso is not corrupt")
827 squashfs_target = target + '/live/' + grml_flavour + '/'
828 execute(mkdir, squashfs_target)
829 exec_rsync(squashfs, squashfs_target + grml_flavour + '.squashfs')
831 for prefix in grml_flavour + "/", "":
832 filesystem_module = search_file(prefix + 'filesystem.module', iso_mount)
833 if filesystem_module:
835 if filesystem_module is None:
836 logging.error("error locating filesystem.module file")
837 raise CriticalException("filesystem.module not found")
839 exec_rsync(filesystem_module, squashfs_target + 'filesystem.module')
841 shortname = get_shortname(grml_flavour)
842 if os.path.isdir(iso_mount + '/boot/' + shortname):
843 exec_rsync(iso_mount + '/boot/' + shortname, target + '/boot')
845 kernel = search_file('vmlinuz', iso_mount)
847 # compat for releases < 2011.12
848 kernel = search_file('linux26', iso_mount)
851 logging.error("error locating kernel file")
852 raise CriticalException("Kernel not found")
854 source = os.path.dirname(kernel) + '/'
855 dest = target + '/' + os.path.dirname(kernel).replace(iso_mount, '') + '/'
857 exec_rsync(source, dest)
860 def update_grml_versions(iso_mount, target):
861 """Update the grml version file on a cd
862 Returns true if version was updated successfully,
863 False if grml-version does not exist yet on the mountpoint
865 @iso_mount: string of the iso mount point
866 @target: path of the target mount point
868 grml_target = target + '/grml/'
869 target_grml_version_file = search_file('grml-version', grml_target)
870 if target_grml_version_file:
871 iso_grml_version_file = search_file('grml-version', iso_mount)
872 if not iso_grml_version_file:
873 logging.warn("Warning: %s could not be found - can not install it", iso_grml_version_file)
876 # read the flavours from the iso image
878 iso_file = open(iso_grml_version_file, 'r')
879 for line in iso_file:
880 iso_versions[get_flavour(line)] = line.strip()
882 # update the existing flavours on the target
883 for line in fileinput.input([target_grml_version_file], inplace=1):
884 flavour = get_flavour(line)
885 if flavour in iso_versions.keys():
886 print iso_versions.pop(flavour)
891 target_file = open(target_grml_version_file, 'a')
892 # add the new flavours from the current iso
893 for flavour in iso_versions:
894 target_file.write("%s\n" % iso_versions[flavour])
896 logging.warn("Warning: Could not write file")
905 def copy_grml_files(grml_flavour, iso_mount, target):
906 """copy some minor grml files to a given target
908 @grml_flavour: the current grml_flavour
909 @iso_mount: path where a grml ISO is mounted on
910 @target: path where grml's main files should be copied to"""
912 grml_target = target + '/grml/'
913 execute(mkdir, grml_target)
915 grml_prefixe = ["GRML", "grml"]
916 for prefix in grml_prefixe:
917 filename = "{0}/{1}/{2}".format(iso_mount, prefix, grml_flavour)
918 if os.path.exists(filename):
919 exec_rsync(filename, grml_target)
922 logging.warn("Warning: could not find flavour directory for %s ", grml_flavour)
925 def handle_addon_copy(filename, dst, iso_mount, ignore_errors=False):
926 """handle copy of optional addons
928 @filename: filename of the addon
929 @dst: destination directory
930 @iso_mount: location of the iso mount
931 @ignore_errors: don't report missing files
933 file_location = search_file(filename, iso_mount)
934 if file_location is None:
935 if not ignore_errors:
936 logging.warn("Warning: %s not found (that's fine if you don't need it)", filename)
938 exec_rsync(file_location, dst)
941 def copy_addons(iso_mount, target):
942 """copy grml's addons files (like allinoneimg, bsd4grml,..) to a given target
944 @iso_mount: path where a grml ISO is mounted on
945 @target: path where grml's main files should be copied to"""
947 addons = target + '/boot/addons/'
948 execute(mkdir, addons)
950 # grub all-in-one image
951 handle_addon_copy('allinone.img', addons, iso_mount)
954 handle_addon_copy('bsd4grml', addons, iso_mount)
957 handle_addon_copy('balder10.imz', addons, iso_mount)
959 # syslinux + pci.ids for hdt
960 for expr in '*.c32', 'pci.ids':
961 glob_and_copy(iso_mount + '/boot/addons/' + expr, addons)
964 handle_addon_copy('memdisk', addons, iso_mount)
967 handle_addon_copy('memtest', addons, iso_mount)
969 # gpxe.lkrn: got replaced by ipxe
970 handle_addon_copy('gpxe.lkrn', addons, iso_mount, ignore_errors=True)
973 handle_addon_copy('ipxe.lkrn', addons, iso_mount)
976 def build_loopbackcfg(target):
977 """Generate GRUB's loopback.cfg based on existing config files.
979 @target: target directory
982 grub_dir = '/boot/grub/'
983 mkdir(os.path.join(target, grub_dir))
985 f = open(target + grub_dir + 'loopback.cfg', 'w')
987 f.write("# grml2usb generated grub2 configuration file\n")
988 f.write("source /boot/grub/header.cfg\n")
990 for defaults in glob.glob(target + os.path.sep + grub_dir + os.path.sep + "*_default.cfg"):
991 sourcefile = defaults.split(target + os.path.sep)[1]
992 logging.debug("Found source file" + sourcefile)
993 os.path.isfile(defaults) and f.write("source " + sourcefile + "\n")
995 for ops in glob.glob(target + os.path.sep + grub_dir + os.path.sep + "*_options.cfg"):
996 sourcefile = ops.split(target + os.path.sep)[1]
997 logging.debug("Found source file" + sourcefile)
998 os.path.isfile(ops) and f.write("source " + sourcefile + "\n")
1000 f.write("source /boot/grub/addons.cfg\n")
1001 f.write("source /boot/grub/footer.cfg\n")
1005 def glob_and_copy(filepattern, dst):
1006 """Glob on specified filepattern and copy the result to dst
1008 @filepattern: globbing pattern
1009 @dst: target directory
1011 for name in glob.glob(filepattern):
1012 copy_if_exist(name, dst)
1015 def search_and_copy(filename, search_path, dst):
1016 """Search for the specified filename at searchpath and copy it to dst
1018 @filename: filename to look for
1019 @search_path: base search file
1020 @dst: destionation to copy the file to
1022 file_location = search_file(filename, search_path)
1023 copy_if_exist(file_location, dst)
1026 def copy_if_exist(filename, dst):
1027 """Copy filename to dst if filename is set.
1029 @filename: a filename
1032 if filename and (os.path.isfile(filename) or os.path.isdir(filename)):
1033 exec_rsync(filename, dst)
1036 def copy_bootloader_files(iso_mount, target, grml_flavour):
1037 """Copy grml's bootloader files to a given target
1039 @iso_mount: path where a grml ISO is mounted on
1040 @target: path where grml's main files should be copied to
1041 @grml_flavour: name of the current processed grml_flavour
1044 syslinux_target = target + '/boot/syslinux/'
1045 execute(mkdir, syslinux_target)
1047 grub_target = target + '/boot/grub/'
1048 execute(mkdir, grub_target)
1050 logo = search_file('logo.16', iso_mount)
1051 exec_rsync(logo, syslinux_target + 'logo.16')
1053 bootx64_efi = search_file('bootx64.efi', iso_mount)
1055 mkdir(target + '/efi/boot/')
1056 exec_rsync(bootx64_efi, target + '/efi/boot/bootx64.efi')
1058 efi_img = search_file('efi.img', iso_mount)
1060 mkdir(target + '/boot/')
1061 exec_rsync(efi_img, target + '/boot/efi.img')
1063 for ffile in ['f%d' % number for number in range(1, 11)]:
1064 search_and_copy(ffile, iso_mount, syslinux_target + ffile)
1066 # avoid the "file is read only, overwrite anyway (y/n) ?" question
1067 # of mtools by syslinux ("mmove -D o -D O s:/ldlinux.sys $target_file")
1068 if os.path.isfile(syslinux_target + 'ldlinux.sys'):
1069 os.unlink(syslinux_target + 'ldlinux.sys')
1071 (source_dir, name) = get_defaults_file(iso_mount, grml_flavour, "default.cfg")
1072 (source_dir, defaults_file) = get_defaults_file(iso_mount, grml_flavour, "grml.cfg")
1075 raise CriticalException(
1076 "file default.cfg could not be found.\n"
1077 "Note: this grml2usb version requires an ISO generated by grml-live >=0.9.24 ...\n"
1078 " ... either use grml releases >=2009.10 or switch to an older grml2usb version.")
1080 if not os.path.exists(iso_mount + '/boot/grub/footer.cfg'):
1081 logging.warning("Warning: Grml releases older than 2011.12 support only one flavour in grub.")
1083 for expr in name, 'distri.cfg', \
1084 defaults_file, 'grml.png', 'hd.cfg', 'isolinux.cfg', 'isolinux.bin', \
1085 'isoprompt.cfg', 'options.cfg', \
1086 'prompt.cfg', 'vesamenu.cfg', 'grml.png', '*.c32':
1087 glob_and_copy(iso_mount + source_dir + expr, syslinux_target)
1089 for filename in glob.glob1(syslinux_target, "*.c32"):
1090 copy_if_exist(os.path.join(SYSLINUX_LIBS, filename), syslinux_target)
1092 # copy the addons_*.cfg file to the new syslinux directory
1093 glob_and_copy(iso_mount + source_dir + 'addon*.cfg', syslinux_target)
1095 search_and_copy('hidden.cfg', iso_mount + source_dir, syslinux_target + "new_" + 'hidden.cfg')
1097 # copy all grub files from ISO
1098 glob_and_copy(iso_mount + '/boot/grub/*', grub_target)
1100 # finally (after all GRUB files have been been installed) build static loopback.cfg
1101 build_loopbackcfg(target)
1104 def install_iso_files(grml_flavour, iso_mount, device, target):
1105 """Copy files from ISO to given target
1107 @grml_flavour: name of grml flavour the configuration should be generated for
1108 @iso_mount: path where a grml ISO is mounted on
1109 @device: device/partition where bootloader should be installed to
1110 @target: path where grml's main files should be copied to"""
1113 GRML_DEFAULT = GRML_DEFAULT or grml_flavour
1116 elif not options.bootloaderonly:
1117 logging.info("Copying files. This might take a while....")
1119 copy_system_files(grml_flavour, iso_mount, target)
1120 copy_grml_files(grml_flavour, iso_mount, target)
1121 except CriticalException, error:
1122 logging.critical("Execution failed: %s", error)
1125 if not options.skipaddons:
1126 if not search_file('addons', iso_mount):
1127 logging.info("Could not find addons, therefore not installing.")
1129 copy_addons(iso_mount, target)
1131 if not options.copyonly:
1132 copy_bootloader_files(iso_mount, target, grml_flavour)
1134 if not options.dryrun:
1135 handle_bootloader_config(grml_flavour, device, target)
1137 # make sure we sync filesystems before returning
1138 proc = subprocess.Popen(["sync"])
1142 def get_device_from_partition(partition):
1144 partition_number = None
1145 if partition[-1].isdigit() and not RE_LOOP_DEVICE.match(partition):
1146 m = RE_P_PARTITION.match(partition)
1148 m = RE_PARTITION.match(partition)
1151 partition_number = int(m.group(2)) - 1
1152 return (device, partition_number)
1155 def get_flavour(flavour_str):
1156 """Returns the flavour of a grml version string
1158 return re.match(r'[\w-]*', flavour_str).group()
1161 def identify_grml_flavour(mountpath):
1162 """Get name of grml flavour
1164 @mountpath: path where the grml ISO is mounted to
1165 @return: name of grml-flavour"""
1167 version_files = search_file('grml-version', mountpath, lst_return=True)
1169 if not version_files:
1170 if mountpath.startswith("/lib/live/mount/medium"):
1171 logging.critical("Error: could not find grml-version file.")
1172 logging.critical("Looks like your system is running from RAM but required files are not available.")
1173 logging.critical("Please either boot without toram=... or use boot option toram instead of toram=...")
1177 logging.critical("Error: could not find grml-version file.")
1182 logging.debug("version_files = %s", version_files)
1183 for version_file in version_files:
1186 tmpfile = open(version_file, 'r')
1187 for line in tmpfile.readlines():
1188 flavours.append(get_flavour(line))
1189 except TypeError, e:
1191 except Exception, e:
1200 def get_bootoptions(grml_flavour):
1201 """Returns bootoptions for specific flavour
1203 @grml_flavour: name of the grml_flavour
1205 # do NOT write "None" in kernel cmdline
1206 if not options.bootoptions:
1209 bootopt = " ".join(options.bootoptions)
1210 bootopt = bootopt.replace("%flavour", grml_flavour)
1214 def handle_grub_config(grml_flavour, device, target):
1215 """Main handler for generating grub (v1 and v2) configuration
1217 @grml_flavour: name of grml flavour the configuration should be generated for
1218 @device: device/partition where grub should be installed to
1219 @target: path of grub's configuration files"""
1223 logging.debug("Updating grub configuration")
1225 grub_target = target + '/boot/grub/'
1227 bootid_re = re.compile("bootid=[\w_-]+")
1228 live_media_path_re = re.compile("live-media-path=[\w_/-]+")
1230 bootopt = get_bootoptions(grml_flavour)
1233 option_re = re.compile(r'(.*/boot/.*(linux26|vmlinuz).*)')
1235 if options.removeoption:
1236 for regex in options.removeoption:
1237 remove_regexes.append(re.compile(regex))
1239 shortname = get_shortname(grml_flavour)
1240 for filename in glob.glob(grub_target + '*.cfg'):
1241 for line in fileinput.input(filename, inplace=1):
1242 line = line.rstrip("\r\n")
1243 if option_re.search(line):
1244 line = bootid_re.sub('', line)
1245 if shortname in filename:
1246 line = live_media_path_re.sub('', line)
1247 line = line.rstrip() + ' live-media-path=/live/%s/ ' % (grml_flavour)
1248 line = line.rstrip() + r' bootid=%s %s ' % (UUID, bootopt)
1249 for regex in remove_regexes:
1250 line = regex.sub(' ', line)
1255 def initial_syslinux_config(target):
1256 """Generates intial syslinux configuration
1258 @target path of syslinux's configuration files"""
1260 target = target + "/"
1261 filename = target + "grmlmain.cfg"
1262 if os.path.isfile(target + "grmlmain.cfg"):
1264 data = open(filename, "w")
1265 data.write(generate_main_syslinux_config())
1268 filename = target + "hiddens.cfg"
1269 data = open(filename, "w")
1270 data.write("include hidden.cfg\n")
1274 def add_entry_if_not_present(filename, entry):
1275 """Write entry into filename if entry is not already in the file
1277 @filanme: name of the file
1278 @entry: data to write to the file
1280 data = open(filename, "a+")
1290 def get_flavour_filename(flavour):
1291 """Generate a iso9960 save filename out of the specified flavour
1293 @flavour: grml flavour
1295 return flavour.replace('-', '_')
1298 def adjust_syslinux_bootoptions(src, flavour):
1299 """Adjust existing bootoptions of specified syslinux config to
1300 grml2usb specific ones, e.g. change the location of the kernel...
1302 @src: config file to alter
1303 @flavour: grml flavour
1306 append_re = re.compile("^(\s*append.*/boot/.*)$", re.I)
1307 # flavour_re = re.compile("(label.*)(grml\w+)")
1308 default_re = re.compile("(default.cfg)")
1309 bootid_re = re.compile("bootid=[\w_-]+")
1310 live_media_path_re = re.compile("live-media-path=[\w_/-]+")
1312 bootopt = get_bootoptions(flavour)
1316 if options.removeoption:
1317 option_re = re.compile(r'/boot/.*/(initrd.gz|initrd.img)')
1319 for regex in options.removeoption:
1320 regexe.append(re.compile(r'%s' % regex))
1322 for line in fileinput.input(src, inplace=1):
1323 # line = flavour_re.sub(r'\1 %s-\2' % flavour, line)
1324 line = default_re.sub(r'%s-\1' % flavour, line)
1325 line = bootid_re.sub('', line)
1326 line = live_media_path_re.sub('', line)
1327 line = append_re.sub(r'\1 live-media-path=/live/%s/ ' % flavour, line)
1328 line = append_re.sub(r'\1 boot=live %s ' % bootopt, line)
1329 line = append_re.sub(r'\1 %s=%s ' % ("bootid", UUID), line)
1330 if option_re and option_re.search(line):
1331 for regex in regexe:
1332 line = regex.sub(' ', line)
1333 sys.stdout.write(line)
1337 def adjust_labels(src, replacement):
1338 """Adjust the specified labels in the syslinux config file src with
1339 specified replacement
1341 label_re = re.compile("^(\s*label\s*) ([a-zA-Z0-9_-]+)", re.I)
1342 for line in fileinput.input(src, inplace=1):
1343 line = label_re.sub(replacement, line)
1344 sys.stdout.write(line)
1348 def add_syslinux_entry(filename, grml_flavour):
1349 """Add includes for a specific grml_flavour to the specified filename
1351 @filename: syslinux config file
1352 @grml_flavour: grml flavour to add
1355 entry_filename = "option_%s.cfg" % grml_flavour
1356 entry = "include %s\n" % entry_filename
1358 add_entry_if_not_present(filename, entry)
1359 path = os.path.dirname(filename)
1361 data = open(path + "/" + entry_filename, "w")
1362 data.write(generate_flavour_specific_syslinux_config(grml_flavour))
1366 def modify_filenames(grml_flavour, target, filenames):
1367 """Replace the standard filenames with the new ones
1369 @grml_flavour: grml-flavour strin
1370 @target: directory where the files are located
1371 @filenames: list of filenames to alter
1373 grml_filename = get_flavour_filename(grml_flavour)
1374 for filename in filenames:
1375 old_filename = "%s/%s" % (target, filename)
1376 new_filename = "%s/%s_%s" % (target, grml_filename, filename)
1377 os.rename(old_filename, new_filename)
1380 def remove_default_entry(filename):
1381 """Remove the default entry from specified syslinux file
1383 @filename: syslinux config file
1385 default_re = re.compile("^(\s*menu\s*default\s*)$", re.I)
1386 for line in fileinput.input(filename, inplace=1):
1387 if default_re.match(line):
1389 sys.stdout.write(line)
1393 def handle_syslinux_config(grml_flavour, target):
1394 """Main handler for generating syslinux configuration
1396 @grml_flavour: name of grml flavour the configuration should be generated for
1397 @target: path of syslinux's configuration files"""
1399 logging.debug("Generating syslinux configuration")
1400 syslinux_target = target + '/boot/syslinux/'
1401 # should be present via copy_bootloader_files(), but make sure it exits:
1402 execute(mkdir, syslinux_target)
1403 syslinux_cfg = syslinux_target + 'syslinux.cfg'
1405 # install main configuration only *once*, no matter how many ISOs we have:
1406 syslinux_config_file = open(syslinux_cfg, 'w')
1407 syslinux_config_file.write("timeout 300\n")
1408 syslinux_config_file.write("include vesamenu.cfg\n")
1409 syslinux_config_file.close()
1411 prompt_name = open(syslinux_target + 'promptname.cfg', 'w')
1412 prompt_name.write('menu label S^yslinux prompt\n')
1415 initial_syslinux_config(syslinux_target)
1416 flavour_filename = get_flavour_filename(grml_flavour)
1418 if search_file('default.cfg', syslinux_target):
1419 modify_filenames(grml_flavour, syslinux_target, ['grml.cfg', 'default.cfg'])
1421 filename = search_file("new_hidden.cfg", syslinux_target)
1423 # process hidden file
1424 if not search_file("hidden.cfg", syslinux_target):
1425 new_hidden = syslinux_target + "hidden.cfg"
1426 os.rename(filename, new_hidden)
1427 adjust_syslinux_bootoptions(new_hidden, grml_flavour)
1429 new_hidden_file = "%s/%s_hidden.cfg" % (syslinux_target, flavour_filename)
1430 os.rename(filename, new_hidden_file)
1431 adjust_labels(new_hidden_file, r'\1 %s-\2' % grml_flavour)
1432 adjust_syslinux_bootoptions(new_hidden_file, grml_flavour)
1433 entry = 'include %s_hidden.cfg\n' % flavour_filename
1434 add_entry_if_not_present("%s/hiddens.cfg" % syslinux_target, entry)
1436 new_default = "%s_default.cfg" % (flavour_filename)
1437 entry = 'include %s\n' % new_default
1438 defaults_file = '%s/defaults.cfg' % syslinux_target
1439 new_default_with_path = "%s/%s" % (syslinux_target, new_default)
1440 new_grml_cfg = "%s/%s_grml.cfg" % (syslinux_target, flavour_filename)
1442 if os.path.isfile(defaults_file):
1444 # remove default menu entry in menu
1445 remove_default_entry(new_default_with_path)
1447 # adjust all labels for additional isos
1448 adjust_labels(new_default_with_path, r'\1 %s' % grml_flavour)
1449 adjust_labels(new_grml_cfg, r'\1 %s-\2' % grml_flavour)
1451 # always adjust bootoptions
1452 adjust_syslinux_bootoptions(new_default_with_path, grml_flavour)
1453 adjust_syslinux_bootoptions(new_grml_cfg, grml_flavour)
1455 add_entry_if_not_present("%s/defaults.cfg" % syslinux_target, entry)
1457 add_syslinux_entry("%s/additional.cfg" % syslinux_target, flavour_filename)
1460 def handle_bootloader_config(grml_flavour, device, target):
1461 """Main handler for generating bootloader's configuration
1463 @grml_flavour: name of grml flavour the configuration should be generated for
1464 @device: device/partition where bootloader should be installed to
1465 @target: path of bootloader's configuration files"""
1468 UUID = get_uuid(target)
1469 if options.skipsyslinuxconfig:
1470 logging.info("Skipping generation of syslinux configuration as requested.")
1473 handle_syslinux_config(grml_flavour, target)
1474 except CriticalException, error:
1475 logging.critical("Fatal: %s", error)
1478 if options.skipgrubconfig:
1479 logging.info("Skipping generation of grub configuration as requested.")
1482 handle_grub_config(grml_flavour, device, target)
1483 except CriticalException, error:
1484 logging.critical("Fatal: %s", error)
1488 def install(image, device):
1489 """Install a grml image to the specified device
1491 @image: directory or is file
1492 @device: partition or directory to install the device
1494 iso_mountpoint = image
1495 remove_image_mountpoint = False
1496 if os.path.isdir(image):
1497 if options.force or os.path.exists(os.path.join(image, 'live')):
1498 logging.info("Using %s as install base", image)
1500 q = raw_input("%s does not look like a Grml system. "
1501 "Do you really want to use this image? y/N " % image)
1502 if q.lower() == 'y':
1503 logging.info("Using %s as install base", image)
1505 logging.info("Skipping install base %s", image)
1507 logging.info("Using ISO %s", image)
1508 iso_mountpoint = tempfile.mkdtemp(prefix="grml2usb", dir=os.path.abspath(options.tmpdir))
1509 register_tmpfile(iso_mountpoint)
1510 remove_image_mountpoint = True
1512 mount(image, iso_mountpoint, ["-o", "loop,ro", "-t", "iso9660"])
1513 except CriticalException, error:
1514 logging.critical("Fatal: %s", error)
1518 install_grml(iso_mountpoint, device)
1520 if remove_image_mountpoint:
1522 remove_mountpoint(iso_mountpoint)
1523 except CriticalException, error:
1528 def install_grml(mountpoint, device):
1529 """Main logic for copying files of the currently running Grml system.
1531 @mountpoint: directory where currently running live system resides (usually /lib/live/mount/medium)
1532 @device: partition where the specified ISO should be installed to"""
1534 device_mountpoint = device
1535 if os.path.isdir(device):
1536 logging.info("Specified device is a directory, therefore not mounting.")
1537 remove_device_mountpoint = False
1539 device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
1540 register_tmpfile(device_mountpoint)
1541 remove_device_mountpoint = True
1543 check_for_fat(device)
1544 check_boot_flag(device)
1545 mount(device, device_mountpoint, ['-o', 'utf8,iocharset=iso8859-1'])
1546 except VerifyException, error:
1548 except CriticalException, error:
1549 mount(device, device_mountpoint, "")
1551 grml_flavours = identify_grml_flavour(mountpoint)
1552 for flavour in set(grml_flavours):
1554 logging.warning("No valid flavour found, please check your iso")
1555 logging.info("Identified grml flavour \"%s\".", flavour)
1556 install_iso_files(flavour, mountpoint, device, device_mountpoint)
1557 GRML_FLAVOURS.add(flavour)
1559 if remove_device_mountpoint:
1560 remove_mountpoint(device_mountpoint)
1563 def remove_mountpoint(mountpoint):
1564 """remove a registered mountpoint
1568 unmount(mountpoint, "")
1569 if os.path.isdir(mountpoint):
1570 os.rmdir(mountpoint)
1571 unregister_tmpfile(mountpoint)
1572 except CriticalException, error:
1577 def handle_mbr(device):
1578 """Main handler for installing master boot record (MBR)
1580 @device: device where the MBR should be installed to"""
1583 logging.info("Would install MBR")
1586 mbr_device, partition_number = get_device_from_partition(device)
1587 if partition_number is None:
1588 logging.warn("Could not detect partition number, not activating partition")
1590 # if we get e.g. /dev/loop1 as device we don't want to put the MBR
1591 # into /dev/loop of course, therefore use /dev/loop1 as mbr_device
1592 if mbr_device == "/dev/loop":
1594 logging.info("Detected loop device - using %s as MBR device therefore", mbr_device)
1596 mbrcode = GRML2USB_BASE + '/mbr/mbrldr'
1597 if options.syslinuxmbr:
1599 mbr_locations = ('/usr/lib/syslinux/mbr.bin',
1600 '/usr/share/syslinux/mbr.bin')
1601 for mbrpath in mbr_locations:
1602 if os.path.isfile(mbrpath):
1607 str_locations = " or ".join(['"%s"' % l for l in mbr_locations])
1608 logging.error('Cannot find syslinux MBR, install it at %s)',
1610 raise CriticalException("syslinux MBR can not be found at %s."
1612 elif options.mbrmenu:
1613 mbrcode = GRML2USB_BASE + '/mbr/mbrldr'
1616 install_mbr(mbrcode, mbr_device, partition_number, True)
1617 except IOError, error:
1618 logging.critical("Execution failed: %s", error)
1620 except Exception, error:
1621 logging.critical("Execution failed: %s", error)
1625 def handle_vfat(device):
1626 """Check for FAT specific settings and options
1628 @device: device that should checked / formated"""
1630 # make sure we have mkfs.vfat available
1632 if not which("mkfs.vfat") and not options.copyonly and not options.dryrun:
1633 logging.critical('Sorry, mkfs.vfat not available. Exiting.')
1634 logging.critical('Please make sure to install dosfstools.')
1638 print "Forcing mkfs.fat16 on %s as requested via option --force." % device
1640 # make sure the user is aware of what he is doing
1641 f = raw_input("Are you sure you want to format the specified partition with fat16? y/N ")
1642 if f == "y" or f == "Y":
1643 logging.info("Note: you can skip this question using the option --force")
1648 except CriticalException, error:
1649 logging.critical("Execution failed: %s", error)
1652 # check for vfat filesystem
1653 if device is not None and not os.path.isdir(device) and options.syslinux:
1655 check_for_fat(device)
1656 except CriticalException, error:
1657 logging.critical("Execution failed: %s", error)
1660 if not os.path.isdir(device) and not check_for_usbdevice(device) and not options.force:
1661 print "Warning: the specified device %s does not look like a removable usb device." % device
1662 f = raw_input("Do you really want to continue? y/N ")
1663 if f == "y" or f == "Y":
1669 def handle_compat_warning(device):
1670 """Backwards compatible checks
1672 @device: device that should be checked"""
1674 # make sure we can replace old grml2usb script and warn user when using old way of life:
1675 if device.startswith("/mnt/external") or device.startswith("/mnt/usb") and not options.force:
1676 print "Warning: the semantics of grml2usb has changed."
1677 print "Instead of using grml2usb /path/to/iso %s you might" % device
1678 print "want to use grml2usb /path/to/iso /dev/... instead."
1679 print "Please check out the grml2usb manpage for details."
1680 f = raw_input("Do you really want to continue? y/N ")
1681 if f == "y" or f == "Y":
1687 def handle_logging():
1688 """Log handling and configuration"""
1690 if options.verbose and options.quiet:
1691 parser.error("please use either verbose (--verbose) or quiet (--quiet) option")
1693 FORMAT = "%(message)s"
1695 FORMAT = "%(asctime)-15s %(message)s"
1696 logging.basicConfig(level=logging.DEBUG, format=FORMAT)
1698 logging.basicConfig(level=logging.CRITICAL, format=FORMAT)
1700 logging.basicConfig(level=logging.INFO, format=FORMAT)
1703 def handle_bootloader(device):
1704 """wrapper for installing bootloader
1706 @device: device where bootloader should be installed to"""
1708 # Install bootloader only if not using the --copy-only option
1709 if options.copyonly:
1710 logging.info("Not installing bootloader and its files as requested via option copyonly.")
1711 elif os.path.isdir(device):
1712 logging.info("Not installing bootloader as %s is a directory.", device)
1714 install_bootloader(device)
1717 def check_options(opts):
1718 """Check compability of provided user opts
1720 @opts option dict from OptionParser
1722 if opts.grubmbr and not opts.grub:
1723 raise CriticalException("--grub-mbr requires --grub option.")
1726 def check_programs():
1727 """check if all needed programs are installed"""
1729 GRUB_INSTALL = which("grub-install") or which("grub2-install")
1730 if not GRUB_INSTALL:
1731 logging.critical("Fatal: grub-install not available (please install the "
1732 + "grub package or drop the --grub option)")
1735 if options.syslinux:
1736 if not which("syslinux"):
1737 logging.critical("Fatal: syslinux not available (please install the "
1738 + "syslinux package or use the --grub option)")
1741 if not which("rsync"):
1742 logging.critical("Fatal: rsync not available, can not continue - sorry.")
1747 """Runs modprobe loop and throws away it's output"""
1748 if not which("modprobe"):
1749 logging.critical("Fatal: modprobe not available, can not continue - sorry.")
1750 logging.critical("Hint: is /sbin missing in PATH?")
1753 proc = subprocess.Popen(["modprobe", "loop"], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
1758 """Main function [make pylint happy :)]"""
1762 print os.path.basename(sys.argv[0]) + " " + PROG_VERSION
1766 parser.error("invalid usage")
1771 # make sure we have the appropriate permissions
1774 check_options(options)
1778 logging.info("Executing grml2usb version %s", PROG_VERSION)
1781 logging.info("Running in simulation mode as requested via option dry-run.")
1785 # specified arguments
1786 device = os.path.realpath(args[len(args) - 1])
1787 isos = args[0:len(args) - 1]
1789 if not os.path.isdir(device):
1790 if device[-1:].isdigit():
1791 if int(device[-1:]) > 4 or device[-2:].isdigit():
1792 logging.critical("Fatal: installation on partition number >4 not supported. (BIOS won't support it.)")
1795 # provide upgrade path
1796 handle_compat_warning(device)
1798 # check for vfat partition
1801 # main operation (like installing files)
1803 install(iso, device)
1806 is_superfloppy = not device[-1:].isdigit()
1808 logging.info("Detected superfloppy format - not installing MBR")
1810 if not options.skipmbr and not os.path.isdir(device) and not is_superfloppy:
1813 handle_bootloader(device)
1815 logging.info("Note: grml flavour %s was installed as the default booting system.", GRML_DEFAULT)
1817 for flavour in GRML_FLAVOURS:
1818 logging.info("Note: you can boot flavour %s using '%s' on the commandline.", flavour, flavour)
1820 # finally be polite :)
1821 logging.info("Finished execution of grml2usb (%s). Have fun with your Grml system.", PROG_VERSION)
1823 except Exception, error:
1824 logging.critical("Fatal: %s", str(error))
1828 if __name__ == "__main__":
1831 except KeyboardInterrupt:
1832 logging.info("Received KeyboardInterrupt")
1835 ## END OF FILE #################################################################
1836 # vim:foldmethod=indent expandtab ai ft=python tw=120 fileencoding=utf-8