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
32 # The line following this line is patched by debian/rules and tarball.sh.
33 PROG_VERSION = '***UNRELEASED***'
36 MOUNTED = set() # register mountpoints
37 TMPFILES = set() # register tmpfiles
38 DATESTAMP = time.mktime(datetime.datetime.now().timetuple()) # unique identifier for syslinux.cfg
39 GRML_FLAVOURS = set() # which flavours are being installed?
42 SYSLINUX_LIBS = "/usr/lib/syslinux/"
44 RE_PARTITION = re.compile(r'([a-z/]*?)(\d+)$')
45 RE_P_PARTITION = re.compile(r'(.*?\d+)p(\d+)$')
46 RE_LOOP_DEVICE = re.compile(r'/dev/loop\d+$')
48 def syslinux_warning(option, opt, value, opt_parser):
49 """A helper function for printing a warning about deprecated option
51 # pylint: disable-msg=W0613
52 sys.stderr.write("Note: the --syslinux option is deprecated as syslinux "
53 "is grml2usb's default. Continuing anyway.\n")
54 setattr(opt_parser.values, option.dest, True)
57 # if grub option is set, unset syslinux option
58 def grub_option(option, opt, value, opt_parser):
59 """A helper function adjusting other option values
61 # pylint: disable-msg=W0613
62 setattr(opt_parser.values, option.dest, True)
63 setattr(opt_parser.values, 'syslinux', False)
66 USAGE = "Usage: %prog [options] <[ISO[s] | /lib/live/mount/medium]> </dev/sdX#>\n\
68 %prog installs Grml ISO[s] to an USB device to be able to boot from it.\n\
69 Make sure you have at least one Grml ISO or a running Grml system (/lib/live/mount/medium),\n\
70 grub or syslinux and root access.\n\
72 Run %prog --help for usage hints, further information via: man grml2usb"
74 # pylint: disable-msg=C0103
75 # pylint: disable-msg=W0603
76 parser = OptionParser(usage=USAGE)
77 parser.add_option("--bootoptions", dest="bootoptions",
78 action="append", type="string",
79 help="use specified bootoptions as default")
80 parser.add_option("--bootloader-only", dest="bootloaderonly", action="store_true",
81 help="do not copy files but just install a bootloader")
82 parser.add_option("--copy-only", dest="copyonly", action="store_true",
83 help="copy files only but do not install bootloader")
84 parser.add_option("--dry-run", dest="dryrun", action="store_true",
85 help="avoid executing commands")
86 parser.add_option("--fat16", dest="fat16", action="store_true",
87 help="format specified partition with FAT16")
88 parser.add_option("--force", dest="force", action="store_true",
89 help="force any actions requiring manual interaction")
90 parser.add_option("--grub", dest="grub", action="callback",
92 help="install grub bootloader instead of (default) syslinux")
93 parser.add_option("--grub-mbr", dest="grubmbr", action="store_true",
94 help="install grub into MBR instead of (default) PBR")
95 parser.add_option("--mbr-menu", dest="mbrmenu", action="store_true",
96 help="enable interactive boot menu in MBR")
97 parser.add_option("--quiet", dest="quiet", action="store_true",
98 help="do not output anything but just errors on console")
99 parser.add_option("--remove-bootoption", dest="removeoption", action="append",
100 help="regex for removing existing bootoptions")
101 parser.add_option("--skip-addons", dest="skipaddons", action="store_true",
102 help="do not install /boot/addons/ files")
103 parser.add_option("--skip-grub-config", dest="skipgrubconfig", action="store_true",
104 help="skip generation of grub configuration files")
105 parser.add_option("--skip-mbr", dest="skipmbr", action="store_true",
106 help="do not install a master boot record (MBR) on the device")
107 parser.add_option("--skip-syslinux-config", dest="skipsyslinuxconfig", action="store_true",
108 help="skip generation of syslinux configuration files")
109 parser.add_option("--syslinux", dest="syslinux", action="callback", default=True,
110 callback=syslinux_warning,
111 help="install syslinux bootloader (deprecated as it's the default)")
112 parser.add_option("--syslinux-mbr", dest="syslinuxmbr", action="store_true",
113 help="install syslinux master boot record (MBR) instead of default")
114 parser.add_option("--tmpdir", dest="tmpdir", default="/tmp",
115 help="directory to be used for temporary files")
116 parser.add_option("--verbose", dest="verbose", action="store_true",
117 help="enable verbose mode")
118 parser.add_option("-v", "--version", dest="version", action="store_true",
119 help="display version and exit")
120 (options, args) = parser.parse_args()
123 GRML2USB_BASE = '/usr/share/grml2usb'
124 if not os.path.isdir(GRML2USB_BASE):
125 GRML2USB_BASE = os.path.dirname(os.path.realpath(__file__))
128 class CriticalException(Exception):
129 """Throw critical exception if the exact error is not known but fatal.
131 @Exception: message"""
134 class VerifyException(Exception):
135 """Throw critical exception if there is an fatal error when verifying something.
137 @Exception: message"""
141 # The following two functions help to operate on strings as
142 # array (list) of bytes (octets). In Python 3000, the bytes
143 # datatype will need to be used. This is intended for using
144 # with manipulation of files on the octet level, like shell
145 # arrays, e.g. in MBR creation.
148 def array2string(*a):
149 """Convert a list of integers [0;255] to a string."""
150 return struct.pack("%sB" % len(a), *a)
154 """Convert a (bytes) string into a list of integers."""
155 return struct.unpack("%sB" % len(s), s)
159 """Cleanup function to make sure there aren't any mounted devices left behind.
162 logging.info("Cleaning up before exiting...")
163 proc = subprocess.Popen(["sync"])
167 for device in MOUNTED:
169 for tmpfile in TMPFILES:
171 # ignore: RuntimeError: Set changed size during iteration
173 logging.debug('caught expection RuntimeError, ignoring')
176 def register_tmpfile(path):
184 def unregister_tmpfile(path):
186 remove registered tmpfile
190 TMPFILES.remove(path)
195 def register_mountpoint(target):
196 """register specified target in a set() for handling clean exiting
198 @target: destination target of mountpoint
204 def unregister_mountpoint(target):
205 """unregister specified target in a set() for handling clean exiting
207 @target: destination target of mountpoint
210 if target in MOUNTED:
211 MOUNTED.remove(target)
214 def get_function_name(obj):
215 """Helper function for use in execute() to retrive name of a function
217 @obj: the function object
219 if not (isroutine(obj) or isclass(obj)):
221 return obj.__module__ + '.' + obj.__name__
224 def execute(f, *exec_arguments):
225 """Wrapper for executing a command. Either really executes
226 the command (default) or when using --dry-run commandline option
227 just displays what would be executed."""
228 # usage: execute(subprocess.Popen, (["ls", "-la"]))
230 # pylint: disable-msg=W0141
231 logging.debug('dry-run only: %s(%s)', get_function_name(f), ', '.join(map(repr, exec_arguments)))
233 # pylint: disable-msg=W0142
234 return f(*exec_arguments)
238 """Check whether a given file can be executed
240 @fpath: full path to file
242 return os.path.exists(fpath) and os.access(fpath, os.X_OK)
246 """Check whether a given program is available in PATH
248 @program: name of executable"""
249 fpath = os.path.split(program)[0]
254 for path in os.environ["PATH"].split(os.pathsep):
255 exe_file = os.path.join(path, program)
262 def get_defaults_file(iso_mount, flavour, name):
263 """get the default file for syslinux
265 bootloader_dirs = ['/boot/isolinux/', '/boot/syslinux/']
266 for directory in bootloader_dirs:
268 "%s_%s" % (get_flavour_filename(flavour), name):
269 if os.path.isfile(iso_mount + directory + name):
270 return (directory, name)
274 def search_file(filename, search_path='/bin' + os.pathsep + '/usr/bin', lst_return=False):
275 """Given a search path, find file
277 @filename: name of file to search for
278 @search_path: path where searching for the specified filename
279 @lst_return: return list of matching files instead one file"""
280 paths = search_path.split(os.pathsep)
281 current_dir = '' # make pylint happy :)
285 """Helper function ffor testing if specified file exists in cwd
287 @cwd: current working directory
289 return os.path.exists(os.path.join(cwd, filename))
293 if match_file(current_dir):
294 retval.append(os.path.abspath(os.path.join(current_dir, filename)))
297 # pylint: disable-msg=W0612
298 for current_dir, directories, files in os.walk(path):
299 if match_file(current_dir):
300 retval.append(os.path.abspath(os.path.join(current_dir, filename)))
311 def check_uid_root():
312 """Check for root permissions"""
313 if not os.geteuid() == 0:
314 sys.exit("Error: please run this script with uid 0 (root).")
317 def check_boot_flag(device):
318 boot_dev, x = get_device_from_partition(device)
320 with open(boot_dev, 'r') as image:
321 data = image.read(512)
322 bootcode = data[440:]
323 if bootcode[6] == '\x80':
324 logging.debug("bootflag is enabled")
326 logging.debug("bootflag is NOT enabled")
327 raise VerifyException("Device %s does not have the bootflag set. "
328 "Please enable it to be able to boot." % boot_dev)
331 def mkfs_fat16(device):
332 """Format specified device with VFAT/FAT16 filesystem.
334 @device: partition that should be formated"""
337 logging.info("Would execute mkfs.vfat -F 16 %s now.", device)
340 logging.info("Formating partition with fat16 filesystem")
341 logging.debug("mkfs.vfat -F 16 %s", device)
342 proc = subprocess.Popen(["mkfs.vfat", "-F", "16", device])
344 if proc.returncode != 0:
345 raise CriticalException("error executing mkfs.vfat")
348 def generate_isolinux_splash(grml_flavour):
349 """Generate bootsplash for isolinux/syslinux
351 @grml_flavour: name of grml flavour the configuration should be generated for"""
353 grml_name = grml_flavour
356 \ f17
\f\18/boot/syslinux/logo.16
358 Some information and boot options available via keys F2 - F10. http://grml.org/
360 """ % {'grml_name': grml_name})
363 def generate_main_syslinux_config(*arg):
364 """Generate main configuration for use in syslinux.cfg
366 @*arg: just for backward compatibility"""
367 # pylint: disable-msg=W0613
368 # remove warning about unused arg
372 menu label Default boot modes:
381 menu label Additional boot entries for:
383 include additional.cfg
390 include promptname.cfg
393 Jump to old style isolinux prompt
394 featuring further information
395 regarding available boot options.
403 def generate_flavour_specific_syslinux_config(grml_flavour):
404 """Generate flavour specific configuration for use in syslinux.cfg
406 @grml_flavour: name of grml flavour the configuration should be generated for"""
409 menu begin grml %(grml_flavour)s
410 menu title %(display_name)s
412 menu label ^Back to main menu...
415 # include config for boot parameters from disk
416 include %(grml_flavour)s_grml.cfg
419 """ % {'grml_flavour': grml_flavour, 'display_name': get_flavour_filename(grml_flavour)})
422 def install_grub(device):
423 """Install grub on specified device.
425 @mntpoint: mountpoint of device where grub should install its files to
426 @device: partition where grub should be installed to"""
429 logging.info("Would execute grub-install [--root-directory=mount_point] %s now.", device)
431 device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
432 register_tmpfile(device_mountpoint)
435 mount(device, device_mountpoint, "")
437 # If using --grub-mbr then make sure we install grub in MBR instead of PBR
439 logging.debug("Using option --grub-mbr ...")
440 grub_device, x = get_device_from_partition(device)
444 logging.info("Installing grub as bootloader")
445 for opt in ["", "--force"]:
446 logging.debug("grub-install --recheck %s --no-floppy --root-directory=%s %s",
447 opt, device_mountpoint, grub_device)
448 proc = subprocess.Popen(["grub-install", "--recheck", opt, "--no-floppy",
449 "--root-directory=%s" % device_mountpoint, grub_device],
450 stdout=file(os.devnull, "r+"))
452 if proc.returncode == 0:
455 if proc.returncode != 0:
456 # raise Exception("error executing grub-install")
457 logging.critical("Fatal: error executing grub-install "
458 + "(please check the grml2usb FAQ or drop the --grub option)")
459 logging.critical("Note: if using grub2 consider using "
460 + "the --grub-mbr option as grub considers PBR problematic.")
463 except CriticalException, error:
464 logging.critical("Fatal: %s", error)
469 unmount(device_mountpoint, "")
470 os.rmdir(device_mountpoint)
471 unregister_tmpfile(device_mountpoint)
474 def install_syslinux(device):
475 """Install syslinux on specified device.
477 @device: partition where syslinux should be installed to"""
480 logging.info("Would install syslinux as bootloader on %s", device)
483 # syslinux -d boot/isolinux /dev/sdb1
484 logging.info("Installing syslinux as bootloader")
485 logging.debug("syslinux -d boot/syslinux %s", device)
486 proc = subprocess.Popen(["syslinux", "-d", "boot/syslinux", device])
488 if proc.returncode != 0:
489 raise CriticalException("Error executing syslinux (either try --fat16 or use grub?)")
492 def install_bootloader(device):
493 """Install bootloader on specified device.
495 @device: partition where bootloader should be installed to"""
497 # by default we use grub, so install syslinux only on request
501 except CriticalException, error:
502 logging.critical("Fatal: %s", error)
507 install_syslinux(device)
508 except CriticalException, error:
509 logging.critical("Fatal: %s", error)
514 def install_mbr(mbrtemplate, device, partition, ismirbsdmbr=True):
515 """install 'mbr' master boot record (MBR) on a device
517 Retrieve the partition table from "device", install an MBR from the
518 "mbrtemplate" file, set the "partition" (0..3) active, and install the
519 result back to "device".
521 @mbrtemplate: default MBR file
523 @device: name of a file assumed to be a hard disc (or USB stick) image, or
524 something like "/dev/sdb"
526 @partition: must be a number between 0 and 3, inclusive
528 @mbrtemplate: must be a valid MBR file of at least 440 (or 439 if
531 @ismirbsdmbr: if true then ignore the active flag, set the mirbsdmbr
532 specific flag to 0/1/2/3 and set the MBR's default value accordingly. If
533 false then leave the mirbsdmbr specific flag set to FFh, set all
534 active flags to 0 and set the active flag of the partition to 80h. Note:
535 behaviour of mirbsdmbr: if flag = 0/1/2/3 then use it, otherwise search for
538 logging.info("Installing default MBR")
540 if not os.path.isfile(mbrtemplate):
541 logging.critical("Error: %s can not be read.", mbrtemplate)
542 raise CriticalException("Error installing MBR (either try --syslinux-mbr or install missing file \"%s\"?)" % mbrtemplate)
544 if partition is not None and ((partition < 0) or (partition > 3)):
545 logging.warn("Cannot activate partition %d" % partition)
553 tmpf = tempfile.NamedTemporaryFile()
555 logging.debug("executing: dd if='%s' of='%s' bs=512 count=1", device, tmpf.name)
556 proc = subprocess.Popen(["dd", "if=%s" % device, "of=%s" % tmpf.name, "bs=512", "count=1"],
557 stderr=file(os.devnull, "r+"))
559 if proc.returncode != 0:
560 raise Exception("error executing dd (first run)")
562 logging.debug("executing: dd if=%s of=%s bs=%s count=1 conv=notrunc", mbrtemplate,
563 tmpf.name, nmbrbytes)
564 proc = subprocess.Popen(["dd", "if=%s" % mbrtemplate, "of=%s" % tmpf.name, "bs=%s" % nmbrbytes,
565 "count=1", "conv=notrunc"], stderr=file(os.devnull, "r+"))
567 if proc.returncode != 0:
568 raise Exception("error executing dd (second run)")
570 mbrcode = tmpf.file.read(512)
571 if len(mbrcode) < 512:
572 raise EOFError("MBR size (%d) < 512" % len(mbrcode))
574 if partition is not None:
576 mbrcode = mbrcode[0:439] + chr(partition) + \
577 mbrcode[440:510] + "\x55\xAA"
579 actives = ["\x00", "\x00", "\x00", "\x00"]
580 actives[partition] = "\x80"
581 mbrcode = mbrcode[0:446] + actives[0] + \
582 mbrcode[447:462] + actives[1] + \
583 mbrcode[463:478] + actives[2] + \
584 mbrcode[479:494] + actives[3] + \
585 mbrcode[495:510] + "\x55\xAA"
589 tmpf.file.write(mbrcode)
592 logging.debug("executing: dd if='%s' of='%s' bs=512 count=1 conv=notrunc", tmpf.name, device)
593 proc = subprocess.Popen(["dd", "if=%s" % tmpf.name, "of=%s" % device, "bs=512", "count=1",
594 "conv=notrunc"], stderr=file(os.devnull, "r+"))
596 if proc.returncode != 0:
597 raise Exception("error executing dd (third run)")
601 def is_writeable(device):
602 """Check if the device is writeable for the current user
604 @device: partition where bootloader should be installed to"""
608 #raise Exception("no device for checking write permissions")
610 if not os.path.exists(device):
613 return os.access(device, os.W_OK) and os.access(device, os.R_OK)
616 def mount(source, target, mount_options):
617 """Mount specified source on given target
619 @source: name of device/ISO that should be mounted
620 @target: directory where the ISO should be mounted to
621 @options: mount specific options"""
623 # note: options.dryrun does not work here, as we have to
624 # locate files and identify the grml flavour
626 for x in file('/proc/mounts').readlines():
627 if x.startswith(source):
628 raise CriticalException("Error executing mount: %s already mounted - " % source
629 + "please unmount before invoking grml2usb")
631 if os.path.isdir(source):
632 logging.debug("Source %s is not a device, therefore not mounting.", source)
635 logging.debug("mount %s %s %s", mount_options, source, target)
636 proc = subprocess.Popen(["mount"] + list(mount_options) + [source, target])
638 if proc.returncode != 0:
639 raise CriticalException("Error executing mount (no filesystem on the partition?)")
641 logging.debug("register_mountpoint(%s)", target)
642 register_mountpoint(target)
645 def unmount(target, unmount_options):
646 """Unmount specified target
648 @target: target where something is mounted on and which should be unmounted
649 @options: options for umount command"""
651 # make sure we unmount only already mounted targets
652 target_unmount = False
653 mounts = open('/proc/mounts').readlines()
654 mountstring = re.compile(".*%s.*" % re.escape(os.path.realpath(target)))
656 if re.match(mountstring, line):
657 target_unmount = True
659 if not target_unmount:
660 logging.debug("%s not mounted anymore", target)
662 logging.debug("umount %s %s", list(unmount_options), target)
663 proc = subprocess.Popen(["umount"] + list(unmount_options) + [target])
665 if proc.returncode != 0:
666 raise Exception("Error executing umount")
668 logging.debug("unregister_mountpoint(%s)", target)
669 unregister_mountpoint(target)
672 def check_for_usbdevice(device):
673 """Check whether the specified device is a removable USB device
675 @device: device name, like /dev/sda1 or /dev/sda
678 usbdevice = re.match(r'/dev/(.*?)\d*$', device).group(1)
680 usbdev = os.path.realpath('/sys/class/block/' + usbdevice + '/removable')
681 if not os.path.isfile(usbdev):
682 # Ubuntu with kernel 2.6.24 for example:
683 usbdev = os.path.realpath('/sys/block/' + usbdevice + '/removable')
685 if os.path.isfile(usbdev):
686 is_usb = open(usbdev).readline()
693 def check_for_fat(partition):
694 """Check whether specified partition is a valid VFAT/FAT16 filesystem
696 @partition: device name of partition"""
698 if not os.access(partition, os.R_OK):
699 raise CriticalException("Failed to read device %s"
700 " (wrong UID/permissions or device/directory not present?)" % partition)
703 udev_info = subprocess.Popen(["/sbin/blkid", "-s", "TYPE", "-o", "value", partition],
704 stdout=subprocess.PIPE, stderr=subprocess.PIPE)
705 filesystem = udev_info.communicate()[0].rstrip()
707 if filesystem != "vfat":
708 raise CriticalException(
709 "Partition %s does not contain a FAT16 filesystem. "
710 "(Use --fat16 or run mkfs.vfat %s)" % (partition, partition))
713 raise CriticalException("Sorry, /sbin/blkid not available (install e2fsprogs?)")
716 def mkdir(directory):
717 """Simple wrapper around os.makedirs to get shell mkdir -p behaviour"""
719 # just silently pass as it's just fine it the directory exists
720 if not os.path.isdir(directory):
722 os.makedirs(directory)
723 # pylint: disable-msg=W0704
728 def exec_rsync(source, target):
729 """Simple wrapper around rsync to install files
731 @source: source file/directory
732 @target: target file/directory"""
733 logging.debug("Source: %s / Target: %s", source, target)
734 proc = subprocess.Popen(["rsync", "-rlptDH", "--inplace", source, target])
736 if proc.returncode == 12:
737 logging.critical("Fatal: No space left on device")
741 if proc.returncode != 0:
742 logging.critical("Fatal: could not install %s", source)
747 def write_uuid(target_file):
748 """Generates an returns uuid and write it to the specified file
750 @target_file: filename to write the uuid to
753 fileh = open(target_file, 'w')
754 uid = str(uuid.uuid4())
760 def get_uuid(target):
761 """Get the uuid of the specified target. Will generate an uuid if none exist.
763 @target: directory/mountpoint containing the grml layout
766 conf_target = target + "/conf/"
767 uuid_file_name = conf_target + "/bootid.txt"
768 if os.path.isdir(conf_target):
769 if os.path.isfile(uuid_file_name):
770 uuid_file = open(uuid_file_name, 'r')
771 uid = uuid_file.readline().strip()
775 return write_uuid(uuid_file_name)
777 execute(mkdir, conf_target)
778 return write_uuid(uuid_file_name)
781 def get_shortname(grml_flavour):
782 """Get shortname based from grml_flavour name. The rules applied are the same as in grml-live
783 @grml_flavour: flavour name which shold be translated to shortname"""
785 return re.sub(r'[,._-]', '', grml_flavour)
788 def copy_system_files(grml_flavour, iso_mount, target):
789 """copy grml's main files (like squashfs, kernel and initrd) to a given target
791 @grml_flavour: name of grml flavour the configuration should be generated for
792 @iso_mount: path where a grml ISO is mounted on
793 @target: path where grml's main files should be copied to"""
795 squashfs = search_file(grml_flavour + '.squashfs', iso_mount)
797 logging.critical("Fatal: squashfs file not found"
798 ", please check that your iso is not corrupt")
799 raise CriticalException("error locating squashfs file")
801 squashfs_target = target + '/live/' + grml_flavour + '/'
802 execute(mkdir, squashfs_target)
803 exec_rsync(squashfs, squashfs_target + grml_flavour + '.squashfs')
805 for prefix in grml_flavour + "/", "":
806 filesystem_module = search_file(prefix + 'filesystem.module', iso_mount)
807 if filesystem_module:
809 if filesystem_module is None:
810 logging.critical("Fatal: filesystem.module not found")
811 raise CriticalException("error locating filesystem.module file")
813 exec_rsync(filesystem_module, squashfs_target + 'filesystem.module')
815 shortname = get_shortname(grml_flavour)
816 if os.path.isdir(iso_mount + '/boot/' + shortname):
817 exec_rsync(iso_mount + '/boot/' + shortname, target + '/boot')
819 kernel = search_file('vmlinuz', iso_mount)
821 # compat for releases < 2011.12
822 kernel = search_file('linux26', iso_mount)
825 logging.critical("Fatal: kernel not found")
826 raise CriticalException("error locating kernel file")
828 source = os.path.dirname(kernel) + '/'
829 dest = target + '/' + os.path.dirname(kernel).replace(iso_mount, '') + '/'
831 exec_rsync(source, dest)
834 def update_grml_versions(iso_mount, target):
835 """Update the grml version file on a cd
836 Returns true if version was updated successfully,
837 False if grml-version does not exist yet on the mountpoint
839 @iso_mount: string of the iso mount point
840 @target: path of the target mount point
842 grml_target = target + '/grml/'
843 target_grml_version_file = search_file('grml-version', grml_target)
844 if target_grml_version_file:
845 iso_grml_version_file = search_file('grml-version', iso_mount)
846 if not iso_grml_version_file:
847 logging.warn("Warning: %s could not be found - can not install it", iso_grml_version_file)
850 # read the flavours from the iso image
852 iso_file = open(iso_grml_version_file, 'r')
853 for line in iso_file:
854 iso_versions[get_flavour(line)] = line.strip()
856 # update the existing flavours on the target
857 for line in fileinput.input([target_grml_version_file], inplace=1):
858 flavour = get_flavour(line)
859 if flavour in iso_versions.keys():
860 print iso_versions.pop(flavour)
865 target_file = open(target_grml_version_file, 'a')
866 # add the new flavours from the current iso
867 for flavour in iso_versions:
868 target_file.write("%s\n" % iso_versions[flavour])
870 logging.warn("Warning: Could not write file")
879 def copy_grml_files(grml_flavour, iso_mount, target):
880 """copy some minor grml files to a given target
882 @grml_flavour: the current grml_flavour
883 @iso_mount: path where a grml ISO is mounted on
884 @target: path where grml's main files should be copied to"""
886 grml_target = target + '/grml/'
887 execute(mkdir, grml_target)
889 grml_prefixe = ["GRML", "grml"]
890 for prefix in grml_prefixe:
891 filename = "{0}/{1}/{2}".format(iso_mount, prefix, grml_flavour)
892 if os.path.exists(filename):
893 exec_rsync(filename, grml_target)
896 logging.warn("Warning: could not find flavour directory for %s ", grml_flavour)
899 def handle_addon_copy(filename, dst, iso_mount, ignore_errors=False):
900 """handle copy of optional addons
902 @filename: filename of the addon
903 @dst: destination directory
904 @iso_mount: location of the iso mount
905 @ignore_errors: don't report missing files
907 file_location = search_file(filename, iso_mount)
908 if file_location is None:
909 if not ignore_errors:
910 logging.warn("Warning: %s not found (that's fine if you don't need it)", filename)
912 exec_rsync(file_location, dst)
915 def copy_addons(iso_mount, target):
916 """copy grml's addons files (like allinoneimg, bsd4grml,..) to a given target
918 @iso_mount: path where a grml ISO is mounted on
919 @target: path where grml's main files should be copied to"""
921 addons = target + '/boot/addons/'
922 execute(mkdir, addons)
924 # grub all-in-one image
925 handle_addon_copy('allinone.img', addons, iso_mount)
928 handle_addon_copy('bsd4grml', addons, iso_mount)
931 handle_addon_copy('balder10.imz', addons, iso_mount)
933 # syslinux + pci.ids for hdt
934 for expr in '*.c32', 'pci.ids':
935 glob_and_copy(iso_mount + '/boot/addons/' + expr, addons)
938 handle_addon_copy('memdisk', addons, iso_mount)
941 handle_addon_copy('memtest', addons, iso_mount)
943 # gpxe.lkrn: got replaced by ipxe
944 handle_addon_copy('gpxe.lkrn', addons, iso_mount, ignore_errors=True)
947 handle_addon_copy('ipxe.lkrn', addons, iso_mount)
950 def build_loopbackcfg(target):
951 """Generate GRUB's loopback.cfg based on existing config files.
953 @target: target directory
956 grub_dir = '/boot/grub/'
957 mkdir(os.path.join(target, grub_dir))
959 f = open(target + grub_dir + 'loopback.cfg', 'w')
961 f.write("# grml2usb generated grub2 configuration file\n")
962 f.write("source /boot/grub/header.cfg\n")
964 for defaults in glob.glob(target + os.path.sep + grub_dir + os.path.sep + "*_default.cfg"):
965 sourcefile = defaults.split(target + os.path.sep)[1]
966 logging.debug("Found source file" + sourcefile)
967 os.path.isfile(defaults) and f.write("source " + sourcefile + "\n")
969 for ops in glob.glob(target + os.path.sep + grub_dir + os.path.sep + "*_options.cfg"):
970 sourcefile = ops.split(target + os.path.sep)[1]
971 logging.debug("Found source file" + sourcefile)
972 os.path.isfile(ops) and f.write("source " + sourcefile + "\n")
974 f.write("source /boot/grub/adddons.cfg\n")
975 f.write("source /boot/grub/footer.cfg\n")
979 def glob_and_copy(filepattern, dst):
980 """Glob on specified filepattern and copy the result to dst
982 @filepattern: globbing pattern
983 @dst: target directory
985 for name in glob.glob(filepattern):
986 copy_if_exist(name, dst)
989 def search_and_copy(filename, search_path, dst):
990 """Search for the specified filename at searchpath and copy it to dst
992 @filename: filename to look for
993 @search_path: base search file
994 @dst: destionation to copy the file to
996 file_location = search_file(filename, search_path)
997 copy_if_exist(file_location, dst)
1000 def copy_if_exist(filename, dst):
1001 """Copy filename to dst if filename is set.
1003 @filename: a filename
1006 if filename and (os.path.isfile(filename) or os.path.isdir(filename)):
1007 exec_rsync(filename, dst)
1010 def copy_bootloader_files(iso_mount, target, grml_flavour):
1011 """Copy grml's bootloader files to a given target
1013 @iso_mount: path where a grml ISO is mounted on
1014 @target: path where grml's main files should be copied to
1015 @grml_flavour: name of the current processed grml_flavour
1018 syslinux_target = target + '/boot/syslinux/'
1019 execute(mkdir, syslinux_target)
1021 grub_target = target + '/boot/grub/'
1022 execute(mkdir, grub_target)
1024 logo = search_file('logo.16', iso_mount)
1025 exec_rsync(logo, syslinux_target + 'logo.16')
1027 bootx64_efi = search_file('bootx64.efi', iso_mount)
1029 mkdir(target + '/efi/boot/')
1030 exec_rsync(bootx64_efi, target + '/efi/boot/bootx64.efi')
1032 efi_img = search_file('efi.img', iso_mount)
1034 mkdir(target + '/boot/')
1035 exec_rsync(efi_img, target + '/boot/efi.img')
1037 for ffile in ['f%d' % number for number in range(1, 11)]:
1038 search_and_copy(ffile, iso_mount, syslinux_target + ffile)
1040 # avoid the "file is read only, overwrite anyway (y/n) ?" question
1041 # of mtools by syslinux ("mmove -D o -D O s:/ldlinux.sys $target_file")
1042 if os.path.isfile(syslinux_target + 'ldlinux.sys'):
1043 os.unlink(syslinux_target + 'ldlinux.sys')
1045 (source_dir, name) = get_defaults_file(iso_mount, grml_flavour, "default.cfg")
1046 (source_dir, defaults_file) = get_defaults_file(iso_mount, grml_flavour, "grml.cfg")
1049 logging.critical("Fatal: file default.cfg could not be found.")
1050 logging.critical("Note: this grml2usb version requires an ISO generated by grml-live >=0.9.24 ...")
1051 logging.critical(" ... either use grml releases >=2009.10 or switch to an older grml2usb version.")
1054 if not os.path.exists(iso_mount + '/boot/grub/footer.cfg'):
1055 logging.warning("Warning: Grml releases older than 2011.12 support only one flavour in grub.")
1057 for expr in name, 'distri.cfg', \
1058 defaults_file, 'grml.png', 'hd.cfg', 'isolinux.cfg', 'isolinux.bin', \
1059 'isoprompt.cfg', 'options.cfg', \
1060 'prompt.cfg', 'vesamenu.cfg', 'grml.png', '*.c32':
1061 glob_and_copy(iso_mount + source_dir + expr, syslinux_target)
1063 for filename in glob.glob1(syslinux_target, "*.c32"):
1064 copy_if_exist(os.path.join(SYSLINUX_LIBS, filename), syslinux_target)
1066 # copy the addons_*.cfg file to the new syslinux directory
1067 glob_and_copy(iso_mount + source_dir + 'addon*.cfg', syslinux_target)
1069 search_and_copy('hidden.cfg', iso_mount + source_dir, syslinux_target + "new_" + 'hidden.cfg')
1071 # copy all grub files from ISO
1072 glob_and_copy(iso_mount + '/boot/grub/*', grub_target)
1074 # finally (after all GRUB files have been been installed) build static loopback.cfg
1075 build_loopbackcfg(target)
1078 def install_iso_files(grml_flavour, iso_mount, device, target):
1079 """Copy files from ISO to given target
1081 @grml_flavour: name of grml flavour the configuration should be generated for
1082 @iso_mount: path where a grml ISO is mounted on
1083 @device: device/partition where bootloader should be installed to
1084 @target: path where grml's main files should be copied to"""
1087 GRML_DEFAULT = GRML_DEFAULT or grml_flavour
1090 elif not options.bootloaderonly:
1091 logging.info("Copying files. This might take a while....")
1093 copy_system_files(grml_flavour, iso_mount, target)
1094 copy_grml_files(grml_flavour, iso_mount, target)
1095 except CriticalException, error:
1096 logging.critical("Execution failed: %s", error)
1099 if not options.skipaddons:
1100 if not search_file('addons', iso_mount):
1101 logging.info("Could not find addons, therefore not installing.")
1103 copy_addons(iso_mount, target)
1105 if not options.copyonly:
1106 copy_bootloader_files(iso_mount, target, grml_flavour)
1108 if not options.dryrun:
1109 handle_bootloader_config(grml_flavour, device, target)
1111 # make sure we sync filesystems before returning
1112 proc = subprocess.Popen(["sync"])
1116 def get_device_from_partition(partition):
1118 partition_number = None
1119 if partition[-1].isdigit() and not RE_LOOP_DEVICE.match(partition):
1120 m = RE_P_PARTITION.match(partition)
1122 m = RE_PARTITION.match(partition)
1125 partition_number = int(m.group(2)) - 1
1126 return (device, partition_number)
1129 def get_flavour(flavour_str):
1130 """Returns the flavour of a grml version string
1132 return re.match(r'[\w-]*', flavour_str).group()
1135 def identify_grml_flavour(mountpath):
1136 """Get name of grml flavour
1138 @mountpath: path where the grml ISO is mounted to
1139 @return: name of grml-flavour"""
1141 version_files = search_file('grml-version', mountpath, lst_return=True)
1143 if not version_files:
1144 if mountpath.startswith("/lib/live/mount/medium"):
1145 logging.critical("Error: could not find grml-version file.")
1146 logging.critical("Looks like your system is running from RAM but required files are not available.")
1147 logging.critical("Please either boot without toram=... or use boot option toram instead of toram=...")
1151 logging.critical("Error: could not find grml-version file.")
1156 logging.debug("version_files = %s", version_files)
1157 for version_file in version_files:
1160 tmpfile = open(version_file, 'r')
1161 for line in tmpfile.readlines():
1162 flavours.append(get_flavour(line))
1163 except TypeError, e:
1165 except Exception, e:
1166 logging.critical("Unexpected error: %s", e)
1175 def get_bootoptions(grml_flavour):
1176 """Returns bootoptions for specific flavour
1178 @grml_flavour: name of the grml_flavour
1180 # do NOT write "None" in kernel cmdline
1181 if not options.bootoptions:
1184 bootopt = " ".join(options.bootoptions)
1185 bootopt = bootopt.replace("%flavour", grml_flavour)
1189 def handle_grub_config(grml_flavour, device, target):
1190 """Main handler for generating grub (v1 and v2) configuration
1192 @grml_flavour: name of grml flavour the configuration should be generated for
1193 @device: device/partition where grub should be installed to
1194 @target: path of grub's configuration files"""
1198 logging.debug("Updating grub configuration")
1200 grub_target = target + '/boot/grub/'
1202 bootid_re = re.compile("bootid=[\w_-]+")
1203 live_media_path_re = re.compile("live-media-path=[\w_/-]+")
1205 bootopt = get_bootoptions(grml_flavour)
1208 option_re = re.compile(r'(.*/boot/.*(linux26|vmlinuz).*)')
1210 if options.removeoption:
1211 for regex in options.removeoption:
1212 remove_regexes.append(re.compile(regex))
1214 shortname = get_shortname(grml_flavour)
1215 for filename in glob.glob(grub_target + '*.cfg'):
1216 for line in fileinput.input(filename, inplace=1):
1217 line = line.rstrip("\r\n")
1218 if option_re.search(line):
1219 line = bootid_re.sub('', line)
1220 if shortname in filename:
1221 line = live_media_path_re.sub('', line)
1222 line = line.rstrip() + ' live-media-path=/live/%s/ ' % (grml_flavour)
1223 line = line.rstrip() + r' bootid=%s %s ' % (UUID, bootopt)
1224 for regex in remove_regexes:
1225 line = regex.sub(' ', line)
1230 def initial_syslinux_config(target):
1231 """Generates intial syslinux configuration
1233 @target path of syslinux's configuration files"""
1235 target = target + "/"
1236 filename = target + "grmlmain.cfg"
1237 if os.path.isfile(target + "grmlmain.cfg"):
1239 data = open(filename, "w")
1240 data.write(generate_main_syslinux_config())
1243 filename = target + "hiddens.cfg"
1244 data = open(filename, "w")
1245 data.write("include hidden.cfg\n")
1249 def add_entry_if_not_present(filename, entry):
1250 """Write entry into filename if entry is not already in the file
1252 @filanme: name of the file
1253 @entry: data to write to the file
1255 data = open(filename, "a+")
1265 def get_flavour_filename(flavour):
1266 """Generate a iso9960 save filename out of the specified flavour
1268 @flavour: grml flavour
1270 return flavour.replace('-', '_')
1273 def adjust_syslinux_bootoptions(src, flavour):
1274 """Adjust existing bootoptions of specified syslinux config to
1275 grml2usb specific ones, e.g. change the location of the kernel...
1277 @src: config file to alter
1278 @flavour: grml flavour
1281 append_re = re.compile("^(\s*append.*/boot/.*)$", re.I)
1282 # flavour_re = re.compile("(label.*)(grml\w+)")
1283 default_re = re.compile("(default.cfg)")
1284 bootid_re = re.compile("bootid=[\w_-]+")
1285 live_media_path_re = re.compile("live-media-path=[\w_/-]+")
1287 bootopt = get_bootoptions(flavour)
1291 if options.removeoption:
1292 option_re = re.compile(r'/boot/.*/(initrd.gz|initrd.img)')
1294 for regex in options.removeoption:
1295 regexe.append(re.compile(r'%s' % regex))
1297 for line in fileinput.input(src, inplace=1):
1298 # line = flavour_re.sub(r'\1 %s-\2' % flavour, line)
1299 line = default_re.sub(r'%s-\1' % flavour, line)
1300 line = bootid_re.sub('', line)
1301 line = live_media_path_re.sub('', line)
1302 line = append_re.sub(r'\1 live-media-path=/live/%s/ ' % flavour, line)
1303 line = append_re.sub(r'\1 boot=live %s ' % bootopt, line)
1304 line = append_re.sub(r'\1 %s=%s ' % ("bootid", UUID), line)
1305 if option_re and option_re.search(line):
1306 for regex in regexe:
1307 line = regex.sub(' ', line)
1308 sys.stdout.write(line)
1312 def adjust_labels(src, replacement):
1313 """Adjust the specified labels in the syslinux config file src with
1314 specified replacement
1316 label_re = re.compile("^(\s*label\s*) ([a-zA-Z0-9_-]+)", re.I)
1317 for line in fileinput.input(src, inplace=1):
1318 line = label_re.sub(replacement, line)
1319 sys.stdout.write(line)
1323 def add_syslinux_entry(filename, grml_flavour):
1324 """Add includes for a specific grml_flavour to the specified filename
1326 @filename: syslinux config file
1327 @grml_flavour: grml flavour to add
1330 entry_filename = "option_%s.cfg" % grml_flavour
1331 entry = "include %s\n" % entry_filename
1333 add_entry_if_not_present(filename, entry)
1334 path = os.path.dirname(filename)
1336 data = open(path + "/" + entry_filename, "w")
1337 data.write(generate_flavour_specific_syslinux_config(grml_flavour))
1341 def modify_filenames(grml_flavour, target, filenames):
1342 """Replace the standard filenames with the new ones
1344 @grml_flavour: grml-flavour strin
1345 @target: directory where the files are located
1346 @filenames: list of filenames to alter
1348 grml_filename = get_flavour_filename(grml_flavour)
1349 for filename in filenames:
1350 old_filename = "%s/%s" % (target, filename)
1351 new_filename = "%s/%s_%s" % (target, grml_filename, filename)
1352 os.rename(old_filename, new_filename)
1355 def remove_default_entry(filename):
1356 """Remove the default entry from specified syslinux file
1358 @filename: syslinux config file
1360 default_re = re.compile("^(\s*menu\s*default\s*)$", re.I)
1361 for line in fileinput.input(filename, inplace=1):
1362 if default_re.match(line):
1364 sys.stdout.write(line)
1368 def handle_syslinux_config(grml_flavour, target):
1369 """Main handler for generating syslinux configuration
1371 @grml_flavour: name of grml flavour the configuration should be generated for
1372 @target: path of syslinux's configuration files"""
1374 logging.debug("Generating syslinux configuration")
1375 syslinux_target = target + '/boot/syslinux/'
1376 # should be present via copy_bootloader_files(), but make sure it exits:
1377 execute(mkdir, syslinux_target)
1378 syslinux_cfg = syslinux_target + 'syslinux.cfg'
1380 # install main configuration only *once*, no matter how many ISOs we have:
1381 syslinux_config_file = open(syslinux_cfg, 'w')
1382 syslinux_config_file.write("TIMEOUT 300\n")
1383 syslinux_config_file.write("include vesamenu.cfg\n")
1384 syslinux_config_file.close()
1386 prompt_name = open(syslinux_target + 'promptname.cfg', 'w')
1387 prompt_name.write('menu label S^yslinux prompt\n')
1390 initial_syslinux_config(syslinux_target)
1391 flavour_filename = get_flavour_filename(grml_flavour)
1393 if search_file('default.cfg', syslinux_target):
1394 modify_filenames(grml_flavour, syslinux_target, ['grml.cfg', 'default.cfg'])
1396 filename = search_file("new_hidden.cfg", syslinux_target)
1398 # process hidden file
1399 if not search_file("hidden.cfg", syslinux_target):
1400 new_hidden = syslinux_target + "hidden.cfg"
1401 os.rename(filename, new_hidden)
1402 adjust_syslinux_bootoptions(new_hidden, grml_flavour)
1404 new_hidden_file = "%s/%s_hidden.cfg" % (syslinux_target, flavour_filename)
1405 os.rename(filename, new_hidden_file)
1406 adjust_labels(new_hidden_file, r'\1 %s-\2' % grml_flavour)
1407 adjust_syslinux_bootoptions(new_hidden_file, grml_flavour)
1408 entry = 'include %s_hidden.cfg\n' % flavour_filename
1409 add_entry_if_not_present("%s/hiddens.cfg" % syslinux_target, entry)
1411 new_default = "%s_default.cfg" % (flavour_filename)
1412 entry = 'include %s\n' % new_default
1413 defaults_file = '%s/defaults.cfg' % syslinux_target
1414 new_default_with_path = "%s/%s" % (syslinux_target, new_default)
1415 new_grml_cfg = "%s/%s_grml.cfg" % (syslinux_target, flavour_filename)
1417 if os.path.isfile(defaults_file):
1419 # remove default menu entry in menu
1420 remove_default_entry(new_default_with_path)
1422 # adjust all labels for additional isos
1423 adjust_labels(new_default_with_path, r'\1 %s' % grml_flavour)
1424 adjust_labels(new_grml_cfg, r'\1 %s-\2' % grml_flavour)
1426 # always adjust bootoptions
1427 adjust_syslinux_bootoptions(new_default_with_path, grml_flavour)
1428 adjust_syslinux_bootoptions(new_grml_cfg, grml_flavour)
1430 add_entry_if_not_present("%s/defaults.cfg" % syslinux_target, entry)
1432 add_syslinux_entry("%s/additional.cfg" % syslinux_target, flavour_filename)
1435 def handle_bootloader_config(grml_flavour, device, target):
1436 """Main handler for generating bootloader's configuration
1438 @grml_flavour: name of grml flavour the configuration should be generated for
1439 @device: device/partition where bootloader should be installed to
1440 @target: path of bootloader's configuration files"""
1443 UUID = get_uuid(target)
1444 if options.skipsyslinuxconfig:
1445 logging.info("Skipping generation of syslinux configuration as requested.")
1448 handle_syslinux_config(grml_flavour, target)
1449 except CriticalException, error:
1450 logging.critical("Fatal: %s", error)
1453 if options.skipgrubconfig:
1454 logging.info("Skipping generation of grub configuration as requested.")
1457 handle_grub_config(grml_flavour, device, target)
1458 except CriticalException, error:
1459 logging.critical("Fatal: %s", error)
1463 def install(image, device):
1464 """Install a grml image to the specified device
1466 @image: directory or is file
1467 @device: partition or directory to install the device
1469 iso_mountpoint = image
1470 remove_image_mountpoint = False
1471 if os.path.isdir(image):
1472 logging.info("Using %s as install base", image)
1474 logging.info("Using ISO %s", image)
1475 iso_mountpoint = tempfile.mkdtemp(prefix="grml2usb", dir=os.path.abspath(options.tmpdir))
1476 register_tmpfile(iso_mountpoint)
1477 remove_image_mountpoint = True
1479 mount(image, iso_mountpoint, ["-o", "loop,ro", "-t", "iso9660"])
1480 except CriticalException, error:
1481 logging.critical("Fatal: %s", error)
1485 install_grml(iso_mountpoint, device)
1487 if remove_image_mountpoint:
1489 remove_mountpoint(iso_mountpoint)
1490 except CriticalException, error:
1491 logging.critical("Fatal: %s", error)
1495 def install_grml(mountpoint, device):
1496 """Main logic for copying files of the currently running grml system.
1498 @mountpoint: directory where currently running live system resides (usually /lib/live/mount/medium)
1499 @device: partition where the specified ISO should be installed to"""
1501 device_mountpoint = device
1502 if os.path.isdir(device):
1503 logging.info("Specified device is a directory, therefore not mounting.")
1504 remove_device_mountpoint = False
1506 device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
1507 register_tmpfile(device_mountpoint)
1508 remove_device_mountpoint = True
1510 check_for_fat(device)
1511 check_boot_flag(device)
1512 mount(device, device_mountpoint, ['-o', 'utf8,iocharset=iso8859-1'])
1513 except VerifyException, error:
1514 logging.critical("Fatal: %s", error)
1516 except CriticalException, error:
1518 mount(device, device_mountpoint, "")
1519 except CriticalException, error:
1520 logging.critical("Fatal: %s", error)
1523 grml_flavours = identify_grml_flavour(mountpoint)
1524 for flavour in set(grml_flavours):
1526 logging.warning("No valid flavour found, please check your iso")
1527 logging.info("Identified grml flavour \"%s\".", flavour)
1528 install_iso_files(flavour, mountpoint, device, device_mountpoint)
1529 GRML_FLAVOURS.add(flavour)
1531 if remove_device_mountpoint:
1532 remove_mountpoint(device_mountpoint)
1535 def remove_mountpoint(mountpoint):
1536 """remove a registred mountpoint
1540 unmount(mountpoint, "")
1541 if os.path.isdir(mountpoint):
1542 os.rmdir(mountpoint)
1543 unregister_tmpfile(mountpoint)
1544 except CriticalException, error:
1545 logging.critical("Fatal: %s", error)
1549 def handle_mbr(device):
1550 """Main handler for installing master boot record (MBR)
1552 @device: device where the MBR should be installed to"""
1555 logging.info("Would install MBR")
1558 mbr_device, partition_number = get_device_from_partition(device)
1559 if partition_number is None:
1560 logging.warn("Could not detect partition number, not activating partition")
1562 # if we get e.g. /dev/loop1 as device we don't want to put the MBR
1563 # into /dev/loop of course, therefore use /dev/loop1 as mbr_device
1564 if mbr_device == "/dev/loop":
1566 logging.info("Detected loop device - using %s as MBR device therefore", mbr_device)
1568 mbrcode = GRML2USB_BASE + '/mbr/mbrldr'
1569 if options.syslinuxmbr:
1570 mbrcode = '/usr/lib/syslinux/mbr.bin'
1571 elif options.mbrmenu:
1572 mbrcode = GRML2USB_BASE + '/mbr/mbrldr'
1575 install_mbr(mbrcode, mbr_device, partition_number, True)
1576 except IOError, error:
1577 logging.critical("Execution failed: %s", error)
1579 except Exception, error:
1580 logging.critical("Execution failed: %s", error)
1584 def handle_vfat(device):
1585 """Check for FAT specific settings and options
1587 @device: device that should checked / formated"""
1589 # make sure we have mkfs.vfat available
1591 if not which("mkfs.vfat") and not options.copyonly and not options.dryrun:
1592 logging.critical('Sorry, mkfs.vfat not available. Exiting.')
1593 logging.critical('Please make sure to install dosfstools.')
1597 print "Forcing mkfs.fat16 on %s as requested via option --force." % device
1599 # make sure the user is aware of what he is doing
1600 f = raw_input("Are you sure you want to format the specified partition with fat16? y/N ")
1601 if f == "y" or f == "Y":
1602 logging.info("Note: you can skip this question using the option --force")
1607 except CriticalException, error:
1608 logging.critical("Execution failed: %s", error)
1611 # check for vfat filesystem
1612 if device is not None and not os.path.isdir(device) and options.syslinux:
1614 check_for_fat(device)
1615 except CriticalException, error:
1616 logging.critical("Execution failed: %s", error)
1619 if not os.path.isdir(device) and not check_for_usbdevice(device) and not options.force:
1620 print "Warning: the specified device %s does not look like a removable usb device." % device
1621 f = raw_input("Do you really want to continue? y/N ")
1622 if f == "y" or f == "Y":
1628 def handle_compat_warning(device):
1629 """Backwards compatible checks
1631 @device: device that should be checked"""
1633 # make sure we can replace old grml2usb script and warn user when using old way of life:
1634 if device.startswith("/mnt/external") or device.startswith("/mnt/usb") and not options.force:
1635 print "Warning: the semantics of grml2usb has changed."
1636 print "Instead of using grml2usb /path/to/iso %s you might" % device
1637 print "want to use grml2usb /path/to/iso /dev/... instead."
1638 print "Please check out the grml2usb manpage for details."
1639 f = raw_input("Do you really want to continue? y/N ")
1640 if f == "y" or f == "Y":
1646 def handle_logging():
1647 """Log handling and configuration"""
1649 if options.verbose and options.quiet:
1650 parser.error("please use either verbose (--verbose) or quiet (--quiet) option")
1653 FORMAT = "Debug: %(asctime)-15s %(message)s"
1654 logging.basicConfig(level=logging.DEBUG, format=FORMAT)
1656 FORMAT = "Critical: %(message)s"
1657 logging.basicConfig(level=logging.CRITICAL, format=FORMAT)
1659 FORMAT = "%(message)s"
1660 logging.basicConfig(level=logging.INFO, format=FORMAT)
1663 def handle_bootloader(device):
1664 """wrapper for installing bootloader
1666 @device: device where bootloader should be installed to"""
1668 # Install bootloader only if not using the --copy-only option
1669 if options.copyonly:
1670 logging.info("Not installing bootloader and its files as requested via option copyonly.")
1671 elif os.path.isdir(device):
1672 logging.info("Not installing bootloader as %s is a directory.", device)
1674 install_bootloader(device)
1677 def check_options(opts):
1678 """Check compability of provided user opts
1680 @opts option dict from OptionParser
1682 if opts.grubmbr and not opts.grub:
1683 logging.critical("Error: --grub-mbr requires --grub option.")
1687 def check_programs():
1688 """check if all needed programs are installed"""
1690 if not which("grub-install"):
1691 logging.critical("Fatal: grub-install not available (please install the "
1692 + "grub package or drop the --grub option)")
1695 if options.syslinux:
1696 if not which("syslinux"):
1697 logging.critical("Fatal: syslinux not available (please install the "
1698 + "syslinux package or use the --grub option)")
1701 if not which("rsync"):
1702 logging.critical("Fatal: rsync not available, can not continue - sorry.")
1707 """Runs modprobe loop and throws away it's output"""
1708 if not which("modprobe"):
1709 logging.critical("Fatal: modprobe not available, can not continue - sorry.")
1710 logging.critical("Hint: is /sbin missing in PATH?")
1713 proc = subprocess.Popen(["modprobe", "loop"], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
1718 """Main function [make pylint happy :)]"""
1721 print os.path.basename(sys.argv[0]) + " " + PROG_VERSION
1725 parser.error("invalid usage")
1730 # make sure we have the appropriate permissions
1733 check_options(options)
1737 logging.info("Executing grml2usb version %s", PROG_VERSION)
1740 logging.info("Running in simulation mode as requested via option dry-run.")
1744 # specified arguments
1745 device = os.path.realpath(args[len(args) - 1])
1746 isos = args[0:len(args) - 1]
1748 if not os.path.isdir(device):
1749 if device[-1:].isdigit():
1750 if int(device[-1:]) > 4 or device[-2:].isdigit():
1751 logging.critical("Fatal: installation on partition number >4 not supported. (BIOS won't support it.)")
1754 # provide upgrade path
1755 handle_compat_warning(device)
1757 # check for vfat partition
1760 # main operation (like installing files)
1762 install(iso, device)
1765 is_superfloppy = not device[-1:].isdigit()
1767 logging.info("Detected superfloppy format - not installing MBR")
1769 if not options.skipmbr and not os.path.isdir(device) and not is_superfloppy:
1772 handle_bootloader(device)
1774 logging.info("Note: grml flavour %s was installed as the default booting system.", GRML_DEFAULT)
1776 for flavour in GRML_FLAVOURS:
1777 logging.info("Note: you can boot flavour %s using '%s' on the commandline.", flavour, flavour)
1779 # finally be politely :)
1780 logging.info("Finished execution of grml2usb (%s). Have fun with your grml system.", PROG_VERSION)
1783 if __name__ == "__main__":
1786 except KeyboardInterrupt:
1787 logging.info("Received KeyboardInterrupt")
1790 ## END OF FILE #################################################################
1791 # vim:foldmethod=indent expandtab ai ft=python tw=120 fileencoding=utf-8