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/"
45 def syslinux_warning(option, opt, value, opt_parser):
46 """A helper function for printing a warning about deprecated option
48 # pylint: disable-msg=W0613
49 sys.stderr.write("Note: the --syslinux option is deprecated as syslinux "
50 "is grml2usb's default. Continuing anyway.\n")
51 setattr(opt_parser.values, option.dest, True)
54 # if grub option is set, unset syslinux option
55 def grub_option(option, opt, value, opt_parser):
56 """A helper function adjusting other option values
58 # pylint: disable-msg=W0613
59 setattr(opt_parser.values, option.dest, True)
60 setattr(opt_parser.values, 'syslinux', False)
63 USAGE = "Usage: %prog [options] <[ISO[s] | /live/image]> </dev/sdX#>\n\
65 %prog installs grml ISO[s] to an USB device to be able to boot from it.\n\
66 Make sure you have at least one grml ISO or a running grml system (/live/image),\n\
67 grub or syslinux and root access.\n\
69 Run %prog --help for usage hints, further information via: man grml2usb"
71 # pylint: disable-msg=C0103
72 # pylint: disable-msg=W0603
73 parser = OptionParser(usage=USAGE)
74 parser.add_option("--bootoptions", dest="bootoptions",
75 action="append", type="string",
76 help="use specified bootoptions as default")
77 parser.add_option("--bootloader-only", dest="bootloaderonly", action="store_true",
78 help="do not copy files but just install a bootloader")
79 parser.add_option("--copy-only", dest="copyonly", action="store_true",
80 help="copy files only but do not install bootloader")
81 parser.add_option("--dry-run", dest="dryrun", action="store_true",
82 help="avoid executing commands")
83 parser.add_option("--fat16", dest="fat16", action="store_true",
84 help="format specified partition with FAT16")
85 parser.add_option("--force", dest="force", action="store_true",
86 help="force any actions requiring manual interaction")
87 parser.add_option("--grub", dest="grub", action="callback",
89 help="install grub bootloader instead of (default) syslinux")
90 parser.add_option("--grub-mbr", dest="grubmbr", action="store_true",
91 help="install grub into MBR instead of (default) PBR")
92 parser.add_option("--mbr-menu", dest="mbrmenu", action="store_true",
93 help="enable interactive boot menu in MBR")
94 parser.add_option("--quiet", dest="quiet", action="store_true",
95 help="do not output anything but just errors on console")
96 parser.add_option("--remove-bootoption", dest="removeoption", action="append",
97 help="regex for removing existing bootoptions")
98 parser.add_option("--skip-addons", dest="skipaddons", action="store_true",
99 help="do not install /boot/addons/ files")
100 parser.add_option("--skip-grub-config", dest="skipgrubconfig", action="store_true",
101 help="skip generation of grub configuration files")
102 parser.add_option("--skip-mbr", dest="skipmbr", action="store_true",
103 help="do not install a master boot record (MBR) on the device")
104 parser.add_option("--skip-syslinux-config", dest="skipsyslinuxconfig", action="store_true",
105 help="skip generation of syslinux configuration files")
106 parser.add_option("--syslinux", dest="syslinux", action="callback", default=True,
107 callback=syslinux_warning,
108 help="install syslinux bootloader (deprecated as it's the default)")
109 parser.add_option("--syslinux-mbr", dest="syslinuxmbr", action="store_true",
110 help="install syslinux master boot record (MBR) instead of default")
111 parser.add_option("--verbose", dest="verbose", action="store_true",
112 help="enable verbose mode")
113 parser.add_option("-v", "--version", dest="version", action="store_true",
114 help="display version and exit")
115 (options, args) = parser.parse_args()
118 GRML2USB_BASE = '/usr/share/grml2usb'
119 if not os.path.isdir(GRML2USB_BASE):
120 GRML2USB_BASE = os.path.dirname(os.path.realpath(__file__))
123 class CriticalException(Exception):
124 """Throw critical exception if the exact error is not known but fatal."
126 @Exception: message"""
130 # The following two functions help to operate on strings as
131 # array (list) of bytes (octets). In Python 3000, the bytes
132 # datatype will need to be used. This is intended for using
133 # with manipulation of files on the octet level, like shell
134 # arrays, e.g. in MBR creation.
137 def array2string(*a):
138 """Convert a list of integers [0;255] to a string."""
139 return struct.pack("%sB" % len(a), *a)
143 """Convert a (bytes) string into a list of integers."""
144 return struct.unpack("%sB" % len(s), s)
148 """Cleanup function to make sure there aren't any mounted devices left behind.
151 logging.info("Cleaning up before exiting...")
152 proc = subprocess.Popen(["sync"])
156 for device in MOUNTED:
158 for tmpfile in TMPFILES:
160 # ignore: RuntimeError: Set changed size during iteration
162 logging.debug('caught expection RuntimeError, ignoring')
165 def register_tmpfile(path):
173 def unregister_tmpfile(path):
175 remove registered tmpfile
179 TMPFILES.remove(path)
184 def register_mountpoint(target):
185 """register specified target in a set() for handling clean exiting
187 @target: destination target of mountpoint
193 def unregister_mountpoint(target):
194 """unregister specified target in a set() for handling clean exiting
196 @target: destination target of mountpoint
199 if target in MOUNTED:
200 MOUNTED.remove(target)
203 def get_function_name(obj):
204 """Helper function for use in execute() to retrive name of a function
206 @obj: the function object
208 if not (isroutine(obj) or isclass(obj)):
210 return obj.__module__ + '.' + obj.__name__
213 def execute(f, *exec_arguments):
214 """Wrapper for executing a command. Either really executes
215 the command (default) or when using --dry-run commandline option
216 just displays what would be executed."""
217 # usage: execute(subprocess.Popen, (["ls", "-la"]))
219 # pylint: disable-msg=W0141
220 logging.debug('dry-run only: %s(%s)', get_function_name(f), ', '.join(map(repr, exec_arguments)))
222 # pylint: disable-msg=W0142
223 return f(*exec_arguments)
227 """Check whether a given file can be executed
229 @fpath: full path to file
231 return os.path.exists(fpath) and os.access(fpath, os.X_OK)
235 """Check whether a given program is available in PATH
237 @program: name of executable"""
238 fpath = os.path.split(program)[0]
243 for path in os.environ["PATH"].split(os.pathsep):
244 exe_file = os.path.join(path, program)
251 def get_defaults_file(iso_mount, flavour, name):
252 """get the default file for syslinux
254 bootloader_dirs = ['/boot/isolinux/', '/boot/syslinux/']
255 for directory in bootloader_dirs:
257 "%s_%s" % (get_flavour_filename(flavour), name):
258 if os.path.isfile(iso_mount + directory + name):
259 return (directory, name)
263 def search_file(filename, search_path='/bin' + os.pathsep + '/usr/bin'):
264 """Given a search path, find file
266 @filename: name of file to search for
267 @search_path: path where searching for the specified filename"""
269 paths = search_path.split(os.pathsep)
270 current_dir = '' # make pylint happy :)
273 """Helper function ffor testing if specified file exists in cwd
275 @cwd: current working directory
277 return os.path.exists(os.path.join(cwd, filename))
281 if match_file(current_dir):
284 # pylint: disable-msg=W0612
285 for current_dir, directories, files in os.walk(path):
286 if match_file(current_dir):
290 return os.path.abspath(os.path.join(current_dir, filename))
295 def check_uid_root():
296 """Check for root permissions"""
297 if not os.geteuid() == 0:
298 sys.exit("Error: please run this script with uid 0 (root).")
301 def mkfs_fat16(device):
302 """Format specified device with VFAT/FAT16 filesystem.
304 @device: partition that should be formated"""
307 logging.info("Would execute mkfs.vfat -F 16 %s now.", device)
310 logging.info("Formating partition with fat16 filesystem")
311 logging.debug("mkfs.vfat -F 16 %s", device)
312 proc = subprocess.Popen(["mkfs.vfat", "-F", "16", device])
314 if proc.returncode != 0:
315 raise CriticalException("error executing mkfs.vfat")
318 def generate_isolinux_splash(grml_flavour):
319 """Generate bootsplash for isolinux/syslinux
321 @grml_flavour: name of grml flavour the configuration should be generated for"""
323 grml_name = grml_flavour
326 \ f17
\f\18/boot/syslinux/logo.16
328 Some information and boot options available via keys F2 - F10. http://grml.org/
330 """ % {'grml_name': grml_name})
333 def generate_main_syslinux_config(*arg):
334 """Generate main configuration for use in syslinux.cfg
336 @*arg: just for backward compatibility"""
337 # pylint: disable-msg=W0613
338 # remove warning about unused arg
342 menu label Default boot modes:
351 menu label Additional boot entries for:
353 include additional.cfg
360 include promptname.cfg
363 Jump to old style isolinux prompt
364 featuring further information
365 regarding available boot options.
373 def generate_flavour_specific_syslinux_config(grml_flavour):
374 """Generate flavour specific configuration for use in syslinux.cfg
376 @grml_flavour: name of grml flavour the configuration should be generated for"""
379 menu begin grml %(grml_flavour)s
380 menu title %(display_name)s
382 menu label ^Back to main menu...
385 # include config for boot parameters from disk
386 include %(grml_flavour)s_grml.cfg
389 """ % {'grml_flavour': grml_flavour, 'display_name': get_flavour_filename(grml_flavour)})
392 def install_grub(device):
393 """Install grub on specified device.
395 @mntpoint: mountpoint of device where grub should install its files to
396 @device: partition where grub should be installed to"""
399 logging.info("Would execute grub-install [--root-directory=mount_point] %s now.", device)
401 device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
402 register_tmpfile(device_mountpoint)
405 mount(device, device_mountpoint, "")
407 # If using --grub-mbr then make sure we install grub in MBR instead of PBR
409 logging.debug("Using option --grub-mbr ...")
410 if device[-1:].isdigit():
411 grub_device = re.match(r'(.*?)\d*$', device).group(1)
417 logging.info("Installing grub as bootloader")
418 for opt in ["", "--force"]:
419 logging.debug("grub-install --recheck %s --no-floppy --root-directory=%s %s",
420 opt, device_mountpoint, grub_device)
421 proc = subprocess.Popen(["grub-install", "--recheck", opt, "--no-floppy",
422 "--root-directory=%s" % device_mountpoint, grub_device],
423 stdout=file(os.devnull, "r+"))
425 if proc.returncode == 0:
428 if proc.returncode != 0:
429 # raise Exception("error executing grub-install")
430 logging.critical("Fatal: error executing grub-install "
431 + "(please check the grml2usb FAQ or drop the --grub option)")
432 logging.critical("Note: if using grub2 consider using "
433 + "the --grub-mbr option as grub considers PBR problematic.")
436 except CriticalException, error:
437 logging.critical("Fatal: %s", error)
442 unmount(device_mountpoint, "")
443 os.rmdir(device_mountpoint)
444 unregister_tmpfile(device_mountpoint)
447 def install_syslinux(device):
448 """Install syslinux on specified device.
450 @device: partition where syslinux should be installed to"""
453 logging.info("Would install syslinux as bootloader on %s", device)
456 # syslinux -d boot/isolinux /dev/sdb1
457 logging.info("Installing syslinux as bootloader")
458 logging.debug("syslinux -d boot/syslinux %s", device)
459 proc = subprocess.Popen(["syslinux", "-d", "boot/syslinux", device])
461 if proc.returncode != 0:
462 raise CriticalException("Error executing syslinux (either try --fat16 or use grub?)")
465 def install_bootloader(device):
466 """Install bootloader on specified device.
468 @device: partition where bootloader should be installed to"""
470 # by default we use grub, so install syslinux only on request
474 except CriticalException, error:
475 logging.critical("Fatal: %s", error)
480 install_syslinux(device)
481 except CriticalException, error:
482 logging.critical("Fatal: %s", error)
487 def install_mbr(mbrtemplate, device, partition, ismirbsdmbr=True):
488 """install 'mbr' master boot record (MBR) on a device
490 Retrieve the partition table from "device", install an MBR from the
491 "mbrtemplate" file, set the "partition" (0..3) active, and install the
492 result back to "device".
494 @mbrtemplate: default MBR file
496 @device: name of a file assumed to be a hard disc (or USB stick) image, or
497 something like "/dev/sdb"
499 @partition: must be a number between 0 and 3, inclusive
501 @mbrtemplate: must be a valid MBR file of at least 440 (or 439 if
504 @ismirbsdmbr: if true then ignore the active flag, set the mirbsdmbr
505 specific flag to 0/1/2/3 and set the MBR's default value accordingly. If
506 false then leave the mirbsdmbr specific flag set to FFh, set all
507 active flags to 0 and set the active flag of the partition to 80h. Note:
508 behaviour of mirbsdmbr: if flag = 0/1/2/3 then use it, otherwise search for
511 logging.info("Installing default MBR")
513 if not os.path.isfile(mbrtemplate):
514 logging.critical("Error: %s can not be read.", mbrtemplate)
515 raise CriticalException("Error installing MBR (either try --syslinux-mbr or install missing file \"%s\"?)" % mbrtemplate)
517 if partition is not None and ((partition < 0) or (partition > 3)):
518 logging.warn("Cannot activate partition %d" % partition)
526 tmpf = tempfile.NamedTemporaryFile()
528 logging.debug("executing: dd if='%s' of='%s' bs=512 count=1", device, tmpf.name)
529 proc = subprocess.Popen(["dd", "if=%s" % device, "of=%s" % tmpf.name, "bs=512", "count=1"],
530 stderr=file(os.devnull, "r+"))
532 if proc.returncode != 0:
533 raise Exception("error executing dd (first run)")
535 logging.debug("executing: dd if=%s of=%s bs=%s count=1 conv=notrunc", mbrtemplate,
536 tmpf.name, nmbrbytes)
537 proc = subprocess.Popen(["dd", "if=%s" % mbrtemplate, "of=%s" % tmpf.name, "bs=%s" % nmbrbytes,
538 "count=1", "conv=notrunc"], stderr=file(os.devnull, "r+"))
540 if proc.returncode != 0:
541 raise Exception("error executing dd (second run)")
543 mbrcode = tmpf.file.read(512)
544 if len(mbrcode) < 512:
545 raise EOFError("MBR size (%d) < 512" % len(mbrcode))
547 if partition is not None:
549 mbrcode = mbrcode[0:439] + chr(partition) + \
550 mbrcode[440:510] + "\x55\xAA"
552 actives = ["\x00", "\x00", "\x00", "\x00"]
553 actives[partition] = "\x80"
554 mbrcode = mbrcode[0:446] + actives[0] + \
555 mbrcode[447:462] + actives[1] + \
556 mbrcode[463:478] + actives[2] + \
557 mbrcode[479:494] + actives[3] + \
558 mbrcode[495:510] + "\x55\xAA"
562 tmpf.file.write(mbrcode)
565 logging.debug("executing: dd if='%s' of='%s' bs=512 count=1 conv=notrunc", tmpf.name, device)
566 proc = subprocess.Popen(["dd", "if=%s" % tmpf.name, "of=%s" % device, "bs=512", "count=1",
567 "conv=notrunc"], stderr=file(os.devnull, "r+"))
569 if proc.returncode != 0:
570 raise Exception("error executing dd (third run)")
574 def is_writeable(device):
575 """Check if the device is writeable for the current user
577 @device: partition where bootloader should be installed to"""
581 #raise Exception("no device for checking write permissions")
583 if not os.path.exists(device):
586 return os.access(device, os.W_OK) and os.access(device, os.R_OK)
589 def mount(source, target, mount_options):
590 """Mount specified source on given target
592 @source: name of device/ISO that should be mounted
593 @target: directory where the ISO should be mounted to
594 @options: mount specific options"""
596 # note: options.dryrun does not work here, as we have to
597 # locate files and identify the grml flavour
599 for x in file('/proc/mounts').readlines():
600 if x.startswith(source):
601 raise CriticalException("Error executing mount: %s already mounted - " % source
602 + "please unmount before invoking grml2usb")
604 if os.path.isdir(source):
605 logging.debug("Source %s is not a device, therefore not mounting.", source)
608 logging.debug("mount %s %s %s", mount_options, source, target)
609 proc = subprocess.Popen(["mount"] + list(mount_options) + [source, target])
611 if proc.returncode != 0:
612 raise CriticalException("Error executing mount (no filesystem on the partition?)")
614 logging.debug("register_mountpoint(%s)", target)
615 register_mountpoint(target)
618 def unmount(target, unmount_options):
619 """Unmount specified target
621 @target: target where something is mounted on and which should be unmounted
622 @options: options for umount command"""
624 # make sure we unmount only already mounted targets
625 target_unmount = False
626 mounts = open('/proc/mounts').readlines()
627 mountstring = re.compile(".*%s.*" % re.escape(os.path.realpath(target)))
629 if re.match(mountstring, line):
630 target_unmount = True
632 if not target_unmount:
633 logging.debug("%s not mounted anymore", target)
635 logging.debug("umount %s %s", list(unmount_options), target)
636 proc = subprocess.Popen(["umount"] + list(unmount_options) + [target])
638 if proc.returncode != 0:
639 raise Exception("Error executing umount")
641 logging.debug("unregister_mountpoint(%s)", target)
642 unregister_mountpoint(target)
645 def check_for_usbdevice(device):
646 """Check whether the specified device is a removable USB device
648 @device: device name, like /dev/sda1 or /dev/sda
651 usbdevice = re.match(r'/dev/(.*?)\d*$', device).group(1)
653 usbdev = os.path.realpath('/sys/class/block/' + usbdevice + '/removable')
654 if not os.path.isfile(usbdev):
655 # Ubuntu with kernel 2.6.24 for example:
656 usbdev = os.path.realpath('/sys/block/' + usbdevice + '/removable')
658 if os.path.isfile(usbdev):
659 is_usb = open(usbdev).readline()
666 def check_for_fat(partition):
667 """Check whether specified partition is a valid VFAT/FAT16 filesystem
669 @partition: device name of partition"""
671 if not os.access(partition, os.R_OK):
672 raise CriticalException("Failed to read device %s"
673 " (wrong UID/permissions or device/directory not present?)" % partition)
676 udev_info = subprocess.Popen(["/sbin/blkid", "-s", "TYPE", "-o", "value", partition],
677 stdout=subprocess.PIPE, stderr=subprocess.PIPE)
678 filesystem = udev_info.communicate()[0].rstrip()
680 if filesystem != "vfat":
681 raise CriticalException(
682 "Partition %s does not contain a FAT16 filesystem. "
683 "(Use --fat16 or run mkfs.vfat %s)" % (partition, partition))
686 raise CriticalException("Sorry, /sbin/blkid not available (install e2fsprogs?)")
689 def mkdir(directory):
690 """Simple wrapper around os.makedirs to get shell mkdir -p behaviour"""
692 # just silently pass as it's just fine it the directory exists
693 if not os.path.isdir(directory):
695 os.makedirs(directory)
696 # pylint: disable-msg=W0704
701 def exec_rsync(source, target):
702 """Simple wrapper around rsync to install files
704 @source: source file/directory
705 @target: target file/directory"""
706 logging.debug("Source: %s / Target: %s", source, target)
707 proc = subprocess.Popen(["rsync", "-rlptDH", "--inplace", source, target])
709 if proc.returncode == 12:
710 logging.critical("Fatal: No space left on device")
714 if proc.returncode != 0:
715 logging.critical("Fatal: could not install %s", source)
720 def write_uuid(target_file):
721 """Generates an returns uuid and write it to the specified file
723 @target_file: filename to write the uuid to
726 fileh = open(target_file, 'w')
727 uid = str(uuid.uuid4())
733 def get_uuid(target):
734 """Get the uuid of the specified target. Will generate an uuid if none exist.
736 @target: directory/mountpoint containing the grml layout
739 conf_target = target + "/conf/"
740 uuid_file_name = conf_target + "/bootid.txt"
741 if os.path.isdir(conf_target):
742 if os.path.isfile(uuid_file_name):
743 uuid_file = open(uuid_file_name, 'r')
744 uid = uuid_file.readline().strip()
748 return write_uuid(uuid_file_name)
750 execute(mkdir, conf_target)
751 return write_uuid(uuid_file_name)
754 def get_shortname(grml_flavour):
755 """Get shortname based from grml_flavour name. The rules applied are the same as in grml-live
756 @grml_flavour: flavour name which shold be translated to shortname"""
758 return re.sub(r'[,._-]', '', grml_flavour)
761 def copy_system_files(grml_flavour, iso_mount, target):
762 """copy grml's main files (like squashfs, kernel and initrd) to a given target
764 @grml_flavour: name of grml flavour the configuration should be generated for
765 @iso_mount: path where a grml ISO is mounted on
766 @target: path where grml's main files should be copied to"""
768 squashfs = search_file(grml_flavour + '.squashfs', iso_mount)
770 logging.critical("Fatal: squashfs file not found"
771 ", please check that your iso is not corrupt")
772 raise CriticalException("error locating squashfs file")
774 squashfs_target = target + '/live/' + grml_flavour + '/'
775 execute(mkdir, squashfs_target)
776 exec_rsync(squashfs, squashfs_target + grml_flavour + '.squashfs')
778 for prefix in grml_flavour + "/", "":
779 filesystem_module = search_file(prefix + 'filesystem.module', iso_mount)
780 if filesystem_module:
782 if filesystem_module is None:
783 logging.critical("Fatal: filesystem.module not found")
784 raise CriticalException("error locating filesystem.module file")
786 exec_rsync(filesystem_module, squashfs_target + 'filesystem.module')
788 shortname = get_shortname(grml_flavour)
789 if os.path.isdir(iso_mount + '/boot/' + shortname):
790 exec_rsync(iso_mount + '/boot/' + shortname, target + '/boot')
792 kernel = search_file('vmlinuz', iso_mount)
794 # compat for releases < 2011.12
795 kernel = search_file('linux26', iso_mount)
798 logging.critical("Fatal: kernel not found")
799 raise CriticalException("error locating kernel file")
801 source = os.path.dirname(kernel) + '/'
802 dest = target + '/' + os.path.dirname(kernel).replace(iso_mount, '') + '/'
804 exec_rsync(source, dest)
807 def update_grml_versions(iso_mount, target):
808 """Update the grml version file on a cd
809 Returns true if version was updated successfully,
810 False if grml-version does not exist yet on the mountpoint
812 @iso_mount: string of the iso mount point
813 @target: path of the target mount point
815 grml_target = target + '/grml/'
816 target_grml_version_file = search_file('grml-version', grml_target)
817 if target_grml_version_file:
818 iso_grml_version_file = search_file('grml-version', iso_mount)
819 if not iso_grml_version_file:
820 logging.warn("Warning: %s could not be found - can not install it", iso_grml_version_file)
823 # read the flavours from the iso image
825 iso_file = open(iso_grml_version_file, 'r')
826 for line in iso_file:
827 iso_versions[get_flavour(line)] = line.strip()
829 # update the existing flavours on the target
830 for line in fileinput.input([target_grml_version_file], inplace=1):
831 flavour = get_flavour(line)
832 if flavour in iso_versions.keys():
833 print iso_versions.pop(flavour)
838 target_file = open(target_grml_version_file, 'a')
839 # add the new flavours from the current iso
840 for flavour in iso_versions:
841 target_file.write("%s\n" % iso_versions[flavour])
843 logging.warn("Warning: Could not write file")
852 def copy_grml_files(grml_flavour, iso_mount, target):
853 """copy some minor grml files to a given target
855 @grml_flavour: the current grml_flavour
856 @iso_mount: path where a grml ISO is mounted on
857 @target: path where grml's main files should be copied to"""
859 grml_target = target + '/grml/'
860 execute(mkdir, grml_target)
862 grml_prefixe = ["GRML", "grml"]
863 for prefix in grml_prefixe:
864 filename = "{0}/{1}/{2}".format(iso_mount, prefix, grml_flavour)
865 if os.path.exists(filename):
866 exec_rsync(filename, grml_target)
869 logging.warn("Warning: could not find flavour directory for %s ", grml_flavour)
872 def handle_addon_copy(filename, dst, iso_mount, ignore_errors=False):
873 """handle copy of optional addons
875 @filename: filename of the addon
876 @dst: destination directory
877 @iso_mount: location of the iso mount
878 @ignore_errors: don't report missing files
880 file_location = search_file(filename, iso_mount)
881 if file_location is None:
882 if not ignore_errors:
883 logging.warn("Warning: %s not found (that's fine if you don't need it)", filename)
885 exec_rsync(file_location, dst)
888 def copy_addons(iso_mount, target):
889 """copy grml's addons files (like allinoneimg, bsd4grml,..) to a given target
891 @iso_mount: path where a grml ISO is mounted on
892 @target: path where grml's main files should be copied to"""
894 addons = target + '/boot/addons/'
895 execute(mkdir, addons)
897 # grub all-in-one image
898 handle_addon_copy('allinone.img', addons, iso_mount)
901 handle_addon_copy('bsd4grml', addons, iso_mount)
903 handle_addon_copy('balder10.imz', addons, iso_mount)
905 # install hdt and pci.ids only when using syslinux (grub doesn't support it)
907 # hdt (hardware detection tool) image
908 hdtimg = search_file('hdt.c32', iso_mount)
910 exec_rsync(hdtimg, addons + '/hdt.c32')
913 picids = search_file('pci.ids', iso_mount)
915 exec_rsync(picids, addons + '/pci.ids')
918 handle_addon_copy('memdisk', addons, iso_mount)
921 handle_addon_copy('memtest', addons, iso_mount)
923 # gpxe.lkrn: got replaced by ipxe
924 handle_addon_copy('gpxe.lkrn', addons, iso_mount, ignore_errors=True)
927 handle_addon_copy('ipxe.lkrn', addons, iso_mount)
930 def build_loopbackcfg(target):
931 """Generate GRUB's loopback.cfg based on existing config files.
933 @target: target directory
936 grub_dir = '/boot/grub/'
937 mkdir(os.path.join(target, grub_dir))
939 f = open(target + grub_dir + 'loopback.cfg', 'w')
941 f.write("# grml2usb generated grub2 configuration file\n")
942 f.write("source /boot/grub/header.cfg\n")
944 for defaults in glob.glob(target + os.path.sep + grub_dir + os.path.sep + "*_default.cfg"):
945 sourcefile = defaults.split(target + os.path.sep)[1]
946 logging.debug("Found source file" + sourcefile)
947 os.path.isfile(defaults) and f.write("source " + sourcefile + "\n")
949 for ops in glob.glob(target + os.path.sep + grub_dir + os.path.sep + "*_options.cfg"):
950 sourcefile = ops.split(target + os.path.sep)[1]
951 logging.debug("Found source file" + sourcefile)
952 os.path.isfile(ops) and f.write("source " + sourcefile + "\n")
954 f.write("source /boot/grub/adddons.cfg\n")
955 f.write("source /boot/grub/footer.cfg\n")
959 def glob_and_copy(filepattern, dst):
960 """Glob on specified filepattern and copy the result to dst
962 @filepattern: globbing pattern
963 @dst: target directory
965 for name in glob.glob(filepattern):
966 copy_if_exist(name, dst)
969 def search_and_copy(filename, search_path, dst):
970 """Search for the specified filename at searchpath and copy it to dst
972 @filename: filename to look for
973 @search_path: base search file
974 @dst: destionation to copy the file to
976 file_location = search_file(filename, search_path)
977 copy_if_exist(file_location, dst)
980 def copy_if_exist(filename, dst):
981 """Copy filename to dst if filename is set.
983 @filename: a filename
986 if filename and (os.path.isfile(filename) or os.path.isdir(filename)):
987 exec_rsync(filename, dst)
990 def copy_bootloader_files(iso_mount, target, grml_flavour):
991 """Copy grml's bootloader files to a given target
993 @iso_mount: path where a grml ISO is mounted on
994 @target: path where grml's main files should be copied to
995 @grml_flavour: name of the current processed grml_flavour
998 syslinux_target = target + '/boot/syslinux/'
999 execute(mkdir, syslinux_target)
1001 grub_target = target + '/boot/grub/'
1002 execute(mkdir, grub_target)
1004 logo = search_file('logo.16', iso_mount)
1005 exec_rsync(logo, syslinux_target + 'logo.16')
1007 bootx64_efi = search_file('bootx64.efi', iso_mount)
1009 mkdir(target + '/efi/boot/')
1010 exec_rsync(bootx64_efi, target + '/efi/boot/bootx64.efi')
1012 efi_img = search_file('efi.img', iso_mount)
1014 mkdir(target + '/boot/')
1015 exec_rsync(efi_img, target + '/boot/efi.img')
1017 for ffile in ['f%d' % number for number in range(1, 11)]:
1018 search_and_copy(ffile, iso_mount, syslinux_target + ffile)
1020 # avoid the "file is read only, overwrite anyway (y/n) ?" question
1021 # of mtools by syslinux ("mmove -D o -D O s:/ldlinux.sys $target_file")
1022 if os.path.isfile(syslinux_target + 'ldlinux.sys'):
1023 os.unlink(syslinux_target + 'ldlinux.sys')
1025 (source_dir, name) = get_defaults_file(iso_mount, grml_flavour, "default.cfg")
1026 (source_dir, defaults_file) = get_defaults_file(iso_mount, grml_flavour, "grml.cfg")
1029 logging.critical("Fatal: file default.cfg could not be found.")
1030 logging.critical("Note: this grml2usb version requires an ISO generated by grml-live >=0.9.24 ...")
1031 logging.critical(" ... either use grml releases >=2009.10 or switch to an older grml2usb version.")
1034 if not os.path.exists(iso_mount + '/boot/grub/footer.cfg'):
1035 logging.warning("Warning: Grml releases older than 2011.12 support only one flavour in grub.")
1037 for expr in name, 'distri.cfg', \
1038 defaults_file, 'grml.png', 'hd.cfg', 'isolinux.cfg', 'isolinux.bin', \
1039 'isoprompt.cfg', 'options.cfg', \
1040 'prompt.cfg', 'vesamenu.cfg', 'grml.png', '*.c32':
1041 glob_and_copy(iso_mount + source_dir + expr, syslinux_target)
1043 for filename in glob.glob1(syslinux_target, "*.c32"):
1044 copy_if_exist(os.path.join(SYSLINUX_LIBS, filename), syslinux_target)
1046 # copy the addons_*.cfg file to the new syslinux directory
1047 glob_and_copy(iso_mount + source_dir + 'addon*.cfg', syslinux_target)
1049 search_and_copy('hidden.cfg', iso_mount + source_dir, syslinux_target + "new_" + 'hidden.cfg')
1051 # copy all grub files from ISO
1052 glob_and_copy(iso_mount + '/boot/grub/*', grub_target)
1054 # finally (after all GRUB files have been been installed) build static loopback.cfg
1055 build_loopbackcfg(target)
1058 def install_iso_files(grml_flavour, iso_mount, device, target):
1059 """Copy files from ISO to given target
1061 @grml_flavour: name of grml flavour the configuration should be generated for
1062 @iso_mount: path where a grml ISO is mounted on
1063 @device: device/partition where bootloader should be installed to
1064 @target: path where grml's main files should be copied to"""
1067 GRML_DEFAULT = GRML_DEFAULT or grml_flavour
1070 elif not options.bootloaderonly:
1071 logging.info("Copying files. This might take a while....")
1073 copy_system_files(grml_flavour, iso_mount, target)
1074 copy_grml_files(grml_flavour, iso_mount, target)
1075 except CriticalException, error:
1076 logging.critical("Execution failed: %s", error)
1079 if not options.skipaddons:
1080 if not search_file('addons', iso_mount):
1081 logging.info("Could not find addons, therefore not installing.")
1083 copy_addons(iso_mount, target)
1085 if not options.copyonly:
1086 copy_bootloader_files(iso_mount, target, grml_flavour)
1088 if not options.dryrun:
1089 handle_bootloader_config(grml_flavour, device, target)
1091 # make sure we sync filesystems before returning
1092 proc = subprocess.Popen(["sync"])
1096 def get_flavour(flavour_str):
1097 """Returns the flavour of a grml version string
1099 return re.match(r'[\w-]*', flavour_str).group()
1102 def identify_grml_flavour(mountpath):
1103 """Get name of grml flavour
1105 @mountpath: path where the grml ISO is mounted to
1106 @return: name of grml-flavour"""
1108 version_file = search_file('grml-version', mountpath)
1110 if version_file == "":
1111 logging.critical("Error: could not find grml-version file.")
1117 tmpfile = open(version_file, 'r')
1118 for line in tmpfile.readlines():
1119 flavours.append(get_flavour(line))
1120 except TypeError, e:
1122 except Exception, e:
1123 logging.critical("Unexpected error: %s", e)
1132 def get_bootoptions(grml_flavour):
1133 """Returns bootoptions for specific flavour
1135 @grml_flavour: name of the grml_flavour
1137 # do NOT write "None" in kernel cmdline
1138 if not options.bootoptions:
1141 bootopt = " ".join(options.bootoptions)
1142 bootopt = bootopt.replace("%flavour", grml_flavour)
1146 def handle_grub_config(grml_flavour, device, target):
1147 """Main handler for generating grub (v1 and v2) configuration
1149 @grml_flavour: name of grml flavour the configuration should be generated for
1150 @device: device/partition where grub should be installed to
1151 @target: path of grub's configuration files"""
1155 logging.debug("Updating grub configuration")
1157 grub_target = target + '/boot/grub/'
1159 bootid_re = re.compile("bootid=[\w_-]+")
1160 live_media_path_re = re.compile("live-media-path=[\w_/-]+")
1162 bootopt = get_bootoptions(grml_flavour)
1165 option_re = re.compile(r'(.*/boot/.*(linux26|vmlinuz).*)')
1167 if options.removeoption:
1168 for regex in options.removeoption:
1169 remove_regexes.append(re.compile(regex))
1171 shortname = get_shortname(grml_flavour)
1172 for filename in glob.glob(grub_target + '*.cfg'):
1173 for line in fileinput.input(filename, inplace=1):
1174 line = line.rstrip("\r\n")
1175 if option_re.search(line):
1176 line = bootid_re.sub('', line)
1177 if shortname in filename:
1178 line = live_media_path_re.sub('', line)
1179 line = line.rstrip() + ' live-media-path=/live/%s/ ' % (grml_flavour)
1180 line = line.rstrip() + r' bootid=%s %s ' % (UUID, bootopt)
1181 for regex in remove_regexes:
1182 line = regex.sub(' ', line)
1187 def initial_syslinux_config(target):
1188 """Generates intial syslinux configuration
1190 @target path of syslinux's configuration files"""
1192 target = target + "/"
1193 filename = target + "grmlmain.cfg"
1194 if os.path.isfile(target + "grmlmain.cfg"):
1196 data = open(filename, "w")
1197 data.write(generate_main_syslinux_config())
1200 filename = target + "hiddens.cfg"
1201 data = open(filename, "w")
1202 data.write("include hidden.cfg\n")
1206 def add_entry_if_not_present(filename, entry):
1207 """Write entry into filename if entry is not already in the file
1209 @filanme: name of the file
1210 @entry: data to write to the file
1212 data = open(filename, "a+")
1222 def get_flavour_filename(flavour):
1223 """Generate a iso9960 save filename out of the specified flavour
1225 @flavour: grml flavour
1227 return flavour.replace('-', '_')
1230 def adjust_syslinux_bootoptions(src, flavour):
1231 """Adjust existing bootoptions of specified syslinux config to
1232 grml2usb specific ones, e.g. change the location of the kernel...
1234 @src: config file to alter
1235 @flavour: grml flavour
1238 append_re = re.compile("^(\s*append.*/boot/.*)$", re.I)
1239 # flavour_re = re.compile("(label.*)(grml\w+)")
1240 default_re = re.compile("(default.cfg)")
1241 bootid_re = re.compile("bootid=[\w_-]+")
1242 live_media_path_re = re.compile("live-media-path=[\w_/-]+")
1244 bootopt = get_bootoptions(flavour)
1248 if options.removeoption:
1249 option_re = re.compile(r'/boot/.*/(initrd.gz|initrd.img)')
1251 for regex in options.removeoption:
1252 regexe.append(re.compile(r'%s' % regex))
1254 for line in fileinput.input(src, inplace=1):
1255 # line = flavour_re.sub(r'\1 %s-\2' % flavour, line)
1256 line = default_re.sub(r'%s-\1' % flavour, line)
1257 line = bootid_re.sub('', line)
1258 line = live_media_path_re.sub('', line)
1259 line = append_re.sub(r'\1 live-media-path=/live/%s/ ' % flavour, line)
1260 line = append_re.sub(r'\1 boot=live %s ' % bootopt, line)
1261 line = append_re.sub(r'\1 %s=%s ' % ("bootid", UUID), line)
1262 if option_re and option_re.search(line):
1263 for regex in regexe:
1264 line = regex.sub(' ', line)
1265 sys.stdout.write(line)
1269 def adjust_labels(src, replacement):
1270 """Adjust the specified labels in the syslinux config file src with
1271 specified replacement
1273 label_re = re.compile("^(\s*label\s*) ([a-zA-Z0-9_-]+)", re.I)
1274 for line in fileinput.input(src, inplace=1):
1275 line = label_re.sub(replacement, line)
1276 sys.stdout.write(line)
1280 def add_syslinux_entry(filename, grml_flavour):
1281 """Add includes for a specific grml_flavour to the specified filename
1283 @filename: syslinux config file
1284 @grml_flavour: grml flavour to add
1287 entry_filename = "option_%s.cfg" % grml_flavour
1288 entry = "include %s\n" % entry_filename
1290 add_entry_if_not_present(filename, entry)
1291 path = os.path.dirname(filename)
1293 data = open(path + "/" + entry_filename, "w")
1294 data.write(generate_flavour_specific_syslinux_config(grml_flavour))
1298 def modify_filenames(grml_flavour, target, filenames):
1299 """Replace the standard filenames with the new ones
1301 @grml_flavour: grml-flavour strin
1302 @target: directory where the files are located
1303 @filenames: list of filenames to alter
1305 grml_filename = get_flavour_filename(grml_flavour)
1306 for filename in filenames:
1307 old_filename = "%s/%s" % (target, filename)
1308 new_filename = "%s/%s_%s" % (target, grml_filename, filename)
1309 os.rename(old_filename, new_filename)
1312 def remove_default_entry(filename):
1313 """Remove the default entry from specified syslinux file
1315 @filename: syslinux config file
1317 default_re = re.compile("^(\s*menu\s*default\s*)$", re.I)
1318 for line in fileinput.input(filename, inplace=1):
1319 if default_re.match(line):
1321 sys.stdout.write(line)
1325 def handle_syslinux_config(grml_flavour, target):
1326 """Main handler for generating syslinux configuration
1328 @grml_flavour: name of grml flavour the configuration should be generated for
1329 @target: path of syslinux's configuration files"""
1331 logging.debug("Generating syslinux configuration")
1332 syslinux_target = target + '/boot/syslinux/'
1333 # should be present via copy_bootloader_files(), but make sure it exits:
1334 execute(mkdir, syslinux_target)
1335 syslinux_cfg = syslinux_target + 'syslinux.cfg'
1337 # install main configuration only *once*, no matter how many ISOs we have:
1338 syslinux_config_file = open(syslinux_cfg, 'w')
1339 syslinux_config_file.write("TIMEOUT 300\n")
1340 syslinux_config_file.write("include vesamenu.cfg\n")
1341 syslinux_config_file.close()
1343 prompt_name = open(syslinux_target + 'promptname.cfg', 'w')
1344 prompt_name.write('menu label S^yslinux prompt\n')
1347 initial_syslinux_config(syslinux_target)
1348 flavour_filename = get_flavour_filename(grml_flavour)
1350 if search_file('default.cfg', syslinux_target):
1351 modify_filenames(grml_flavour, syslinux_target, ['grml.cfg', 'default.cfg'])
1353 filename = search_file("new_hidden.cfg", syslinux_target)
1355 # process hidden file
1356 if not search_file("hidden.cfg", syslinux_target):
1357 new_hidden = syslinux_target + "hidden.cfg"
1358 os.rename(filename, new_hidden)
1359 adjust_syslinux_bootoptions(new_hidden, grml_flavour)
1361 new_hidden_file = "%s/%s_hidden.cfg" % (syslinux_target, flavour_filename)
1362 os.rename(filename, new_hidden_file)
1363 adjust_labels(new_hidden_file, r'\1 %s-\2' % grml_flavour)
1364 adjust_syslinux_bootoptions(new_hidden_file, grml_flavour)
1365 entry = 'include %s_hidden.cfg\n' % flavour_filename
1366 add_entry_if_not_present("%s/hiddens.cfg" % syslinux_target, entry)
1368 new_default = "%s_default.cfg" % (flavour_filename)
1369 entry = 'include %s\n' % new_default
1370 defaults_file = '%s/defaults.cfg' % syslinux_target
1371 new_default_with_path = "%s/%s" % (syslinux_target, new_default)
1372 new_grml_cfg = "%s/%s_grml.cfg" % (syslinux_target, flavour_filename)
1374 if os.path.isfile(defaults_file):
1376 # remove default menu entry in menu
1377 remove_default_entry(new_default_with_path)
1379 # adjust all labels for additional isos
1380 adjust_labels(new_default_with_path, r'\1 %s' % grml_flavour)
1381 adjust_labels(new_grml_cfg, r'\1 %s-\2' % grml_flavour)
1383 # always adjust bootoptions
1384 adjust_syslinux_bootoptions(new_default_with_path, grml_flavour)
1385 adjust_syslinux_bootoptions(new_grml_cfg, grml_flavour)
1387 add_entry_if_not_present("%s/defaults.cfg" % syslinux_target, entry)
1389 add_syslinux_entry("%s/additional.cfg" % syslinux_target, flavour_filename)
1392 def handle_bootloader_config(grml_flavour, device, target):
1393 """Main handler for generating bootloader's configuration
1395 @grml_flavour: name of grml flavour the configuration should be generated for
1396 @device: device/partition where bootloader should be installed to
1397 @target: path of bootloader's configuration files"""
1400 UUID = get_uuid(target)
1401 if options.skipsyslinuxconfig:
1402 logging.info("Skipping generation of syslinux configuration as requested.")
1405 handle_syslinux_config(grml_flavour, target)
1406 except CriticalException, error:
1407 logging.critical("Fatal: %s", error)
1410 if options.skipgrubconfig:
1411 logging.info("Skipping generation of grub configuration as requested.")
1414 handle_grub_config(grml_flavour, device, target)
1415 except CriticalException, error:
1416 logging.critical("Fatal: %s", error)
1420 def install(image, device):
1421 """Install a grml image to the specified device
1423 @image: directory or is file
1424 @device: partition or directory to install the device
1426 iso_mountpoint = image
1427 remove_image_mountpoint = False
1428 if os.path.isdir(image):
1429 logging.info("Using %s as install base", image)
1431 logging.info("Using ISO %s", image)
1432 iso_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
1433 register_tmpfile(iso_mountpoint)
1434 remove_image_mountpoint = True
1436 mount(image, iso_mountpoint, ["-o", "loop,ro", "-t", "iso9660"])
1437 except CriticalException, error:
1438 logging.critical("Fatal: %s", error)
1442 install_grml(iso_mountpoint, device)
1444 if remove_image_mountpoint:
1446 remove_mountpoint(iso_mountpoint)
1447 except CriticalException, error:
1448 logging.critical("Fatal: %s", error)
1452 def install_grml(mountpoint, device):
1453 """Main logic for copying files of the currently running grml system.
1455 @mountpoin: directory where currently running live system resides (usually /live/image)
1456 @device: partition where the specified ISO should be installed to"""
1458 device_mountpoint = device
1459 if os.path.isdir(device):
1460 logging.info("Specified device is not a directory, therefore not mounting.")
1461 remove_device_mountpoint = False
1463 device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
1464 register_tmpfile(device_mountpoint)
1465 remove_device_mountpoint = True
1467 check_for_fat(device)
1468 mount(device, device_mountpoint, ['-o', 'utf8,iocharset=iso8859-1'])
1469 except CriticalException, error:
1471 mount(device, device_mountpoint, "")
1472 except CriticalException, error:
1473 logging.critical("Fatal: %s", error)
1476 grml_flavours = identify_grml_flavour(mountpoint)
1477 for flavour in set(grml_flavours):
1479 logging.warning("No valid flavour found, please check your iso")
1480 logging.info("Identified grml flavour \"%s\".", flavour)
1481 install_iso_files(flavour, mountpoint, device, device_mountpoint)
1482 GRML_FLAVOURS.add(flavour)
1484 if remove_device_mountpoint:
1485 remove_mountpoint(device_mountpoint)
1488 def remove_mountpoint(mountpoint):
1489 """remove a registred mountpoint
1493 unmount(mountpoint, "")
1494 if os.path.isdir(mountpoint):
1495 os.rmdir(mountpoint)
1496 unregister_tmpfile(mountpoint)
1497 except CriticalException, error:
1498 logging.critical("Fatal: %s", error)
1502 def handle_mbr(device):
1503 """Main handler for installing master boot record (MBR)
1505 @device: device where the MBR should be installed to"""
1508 logging.info("Would install MBR")
1511 if device[-1:].isdigit():
1512 mbr_device = re.match(r'(.*?)\d*$', device).group(1)
1513 partition_number = int(device[-1:]) - 1
1515 logging.warn("Could not detect partition number, not activating partition")
1516 partition_number = None
1518 # if we get e.g. /dev/loop1 as device we don't want to put the MBR
1519 # into /dev/loop of course, therefore use /dev/loop1 as mbr_device
1520 if mbr_device == "/dev/loop":
1522 logging.info("Detected loop device - using %s as MBR device therefore", mbr_device)
1524 mbrcode = GRML2USB_BASE + '/mbr/mbrldr'
1525 if options.syslinuxmbr:
1526 mbrcode = '/usr/lib/syslinux/mbr.bin'
1527 elif options.mbrmenu:
1528 mbrcode = GRML2USB_BASE + '/mbr/mbrldr'
1531 install_mbr(mbrcode, mbr_device, partition_number, True)
1532 except IOError, error:
1533 logging.critical("Execution failed: %s", error)
1535 except Exception, error:
1536 logging.critical("Execution failed: %s", error)
1540 def handle_vfat(device):
1541 """Check for FAT specific settings and options
1543 @device: device that should checked / formated"""
1545 # make sure we have mkfs.vfat available
1547 if not which("mkfs.vfat") and not options.copyonly and not options.dryrun:
1548 logging.critical('Sorry, mkfs.vfat not available. Exiting.')
1549 logging.critical('Please make sure to install dosfstools.')
1553 print "Forcing mkfs.fat16 on %s as requested via option --force." % device
1555 # make sure the user is aware of what he is doing
1556 f = raw_input("Are you sure you want to format the specified partition with fat16? y/N ")
1557 if f == "y" or f == "Y":
1558 logging.info("Note: you can skip this question using the option --force")
1563 except CriticalException, error:
1564 logging.critical("Execution failed: %s", error)
1567 # check for vfat filesystem
1568 if device is not None and not os.path.isdir(device) and options.syslinux:
1570 check_for_fat(device)
1571 except CriticalException, error:
1572 logging.critical("Execution failed: %s", error)
1575 if not os.path.isdir(device) and not check_for_usbdevice(device) and not options.force:
1576 print "Warning: the specified device %s does not look like a removable usb device." % device
1577 f = raw_input("Do you really want to continue? y/N ")
1578 if f == "y" or f == "Y":
1584 def handle_compat_warning(device):
1585 """Backwards compatible checks
1587 @device: device that should be checked"""
1589 # make sure we can replace old grml2usb script and warn user when using old way of life:
1590 if device.startswith("/mnt/external") or device.startswith("/mnt/usb") and not options.force:
1591 print "Warning: the semantics of grml2usb has changed."
1592 print "Instead of using grml2usb /path/to/iso %s you might" % device
1593 print "want to use grml2usb /path/to/iso /dev/... instead."
1594 print "Please check out the grml2usb manpage for details."
1595 f = raw_input("Do you really want to continue? y/N ")
1596 if f == "y" or f == "Y":
1602 def handle_logging():
1603 """Log handling and configuration"""
1605 if options.verbose and options.quiet:
1606 parser.error("please use either verbose (--verbose) or quiet (--quiet) option")
1609 FORMAT = "Debug: %(asctime)-15s %(message)s"
1610 logging.basicConfig(level=logging.DEBUG, format=FORMAT)
1612 FORMAT = "Critical: %(message)s"
1613 logging.basicConfig(level=logging.CRITICAL, format=FORMAT)
1615 FORMAT = "%(message)s"
1616 logging.basicConfig(level=logging.INFO, format=FORMAT)
1619 def handle_bootloader(device):
1620 """wrapper for installing bootloader
1622 @device: device where bootloader should be installed to"""
1624 # Install bootloader only if not using the --copy-only option
1625 if options.copyonly:
1626 logging.info("Not installing bootloader and its files as requested via option copyonly.")
1627 elif os.path.isdir(device):
1628 logging.info("Not installing bootloader as %s is a directory.", device)
1630 install_bootloader(device)
1633 def check_options(opts):
1634 """Check compability of provided user opts
1636 @opts option dict from OptionParser
1638 if opts.grubmbr and not opts.grub:
1639 logging.critical("Error: --grub-mbr requires --grub option.")
1643 def check_programs():
1644 """check if all needed programs are installed"""
1646 if not which("grub-install"):
1647 logging.critical("Fatal: grub-install not available (please install the "
1648 + "grub package or drop the --grub option)")
1651 if options.syslinux:
1652 if not which("syslinux"):
1653 logging.critical("Fatal: syslinux not available (please install the "
1654 + "syslinux package or use the --grub option)")
1657 if not which("rsync"):
1658 logging.critical("Fatal: rsync not available, can not continue - sorry.")
1663 """Runs modprobe loop and throws away it's output"""
1664 proc = subprocess.Popen(["modprobe", "loop"], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
1669 """Main function [make pylint happy :)]"""
1672 print os.path.basename(sys.argv[0]) + " " + PROG_VERSION
1676 parser.error("invalid usage")
1681 # make sure we have the appropriate permissions
1684 check_options(options)
1688 logging.info("Executing grml2usb version %s", PROG_VERSION)
1691 logging.info("Running in simulation mode as requested via option dry-run.")
1695 # specified arguments
1696 device = os.path.realpath(args[len(args) - 1])
1697 isos = args[0:len(args) - 1]
1699 if not os.path.isdir(device):
1700 if device[-1:].isdigit():
1701 if int(device[-1:]) > 4 or device[-2:].isdigit():
1702 logging.critical("Fatal: installation on partition number >4 not supported. (BIOS won't support it.)")
1705 # provide upgrade path
1706 handle_compat_warning(device)
1708 # check for vfat partition
1711 # main operation (like installing files)
1713 install(iso, device)
1716 is_superfloppy = not device[-1:].isdigit()
1718 logging.info("Detected superfloppy format - not installing MBR")
1720 if not options.skipmbr and not os.path.isdir(device) and not is_superfloppy:
1723 handle_bootloader(device)
1725 logging.info("Note: grml flavour %s was installed as the default booting system.", GRML_DEFAULT)
1727 for flavour in GRML_FLAVOURS:
1728 logging.info("Note: you can boot flavour %s using '%s' on the commandline.", flavour, flavour)
1730 # finally be politely :)
1731 logging.info("Finished execution of grml2usb (%s). Have fun with your grml system.", PROG_VERSION)
1734 if __name__ == "__main__":
1737 except KeyboardInterrupt:
1738 logging.info("Received KeyboardInterrupt")
1741 ## END OF FILE #################################################################
1742 # vim:foldmethod=indent expandtab ai ft=python tw=120 fileencoding=utf-8