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("--tmpdir", dest="tmpdir", default="/tmp",
112 help="directory to be used for temporary files")
113 parser.add_option("--verbose", dest="verbose", action="store_true",
114 help="enable verbose mode")
115 parser.add_option("-v", "--version", dest="version", action="store_true",
116 help="display version and exit")
117 (options, args) = parser.parse_args()
120 GRML2USB_BASE = '/usr/share/grml2usb'
121 if not os.path.isdir(GRML2USB_BASE):
122 GRML2USB_BASE = os.path.dirname(os.path.realpath(__file__))
125 class CriticalException(Exception):
126 """Throw critical exception if the exact error is not known but fatal.
128 @Exception: message"""
131 class VerifyException(Exception):
132 """Throw critical exception if there is an fatal error when verifying something.
134 @Exception: message"""
138 # The following two functions help to operate on strings as
139 # array (list) of bytes (octets). In Python 3000, the bytes
140 # datatype will need to be used. This is intended for using
141 # with manipulation of files on the octet level, like shell
142 # arrays, e.g. in MBR creation.
145 def array2string(*a):
146 """Convert a list of integers [0;255] to a string."""
147 return struct.pack("%sB" % len(a), *a)
151 """Convert a (bytes) string into a list of integers."""
152 return struct.unpack("%sB" % len(s), s)
156 """Cleanup function to make sure there aren't any mounted devices left behind.
159 logging.info("Cleaning up before exiting...")
160 proc = subprocess.Popen(["sync"])
164 for device in MOUNTED:
166 for tmpfile in TMPFILES:
168 # ignore: RuntimeError: Set changed size during iteration
170 logging.debug('caught expection RuntimeError, ignoring')
173 def register_tmpfile(path):
181 def unregister_tmpfile(path):
183 remove registered tmpfile
187 TMPFILES.remove(path)
192 def register_mountpoint(target):
193 """register specified target in a set() for handling clean exiting
195 @target: destination target of mountpoint
201 def unregister_mountpoint(target):
202 """unregister specified target in a set() for handling clean exiting
204 @target: destination target of mountpoint
207 if target in MOUNTED:
208 MOUNTED.remove(target)
211 def get_function_name(obj):
212 """Helper function for use in execute() to retrive name of a function
214 @obj: the function object
216 if not (isroutine(obj) or isclass(obj)):
218 return obj.__module__ + '.' + obj.__name__
221 def execute(f, *exec_arguments):
222 """Wrapper for executing a command. Either really executes
223 the command (default) or when using --dry-run commandline option
224 just displays what would be executed."""
225 # usage: execute(subprocess.Popen, (["ls", "-la"]))
227 # pylint: disable-msg=W0141
228 logging.debug('dry-run only: %s(%s)', get_function_name(f), ', '.join(map(repr, exec_arguments)))
230 # pylint: disable-msg=W0142
231 return f(*exec_arguments)
235 """Check whether a given file can be executed
237 @fpath: full path to file
239 return os.path.exists(fpath) and os.access(fpath, os.X_OK)
243 """Check whether a given program is available in PATH
245 @program: name of executable"""
246 fpath = os.path.split(program)[0]
251 for path in os.environ["PATH"].split(os.pathsep):
252 exe_file = os.path.join(path, program)
259 def get_defaults_file(iso_mount, flavour, name):
260 """get the default file for syslinux
262 bootloader_dirs = ['/boot/isolinux/', '/boot/syslinux/']
263 for directory in bootloader_dirs:
265 "%s_%s" % (get_flavour_filename(flavour), name):
266 if os.path.isfile(iso_mount + directory + name):
267 return (directory, name)
271 def search_file(filename, search_path='/bin' + os.pathsep + '/usr/bin', lst_return=False):
272 """Given a search path, find file
274 @filename: name of file to search for
275 @search_path: path where searching for the specified filename
276 @lst_return: return list of matching files instead one file"""
277 paths = search_path.split(os.pathsep)
278 current_dir = '' # make pylint happy :)
282 """Helper function ffor testing if specified file exists in cwd
284 @cwd: current working directory
286 return os.path.exists(os.path.join(cwd, filename))
290 if match_file(current_dir):
291 retval.append(os.path.abspath(os.path.join(current_dir, filename)))
294 # pylint: disable-msg=W0612
295 for current_dir, directories, files in os.walk(path):
296 if match_file(current_dir):
297 retval.append(os.path.abspath(os.path.join(current_dir, filename)))
308 def check_uid_root():
309 """Check for root permissions"""
310 if not os.geteuid() == 0:
311 sys.exit("Error: please run this script with uid 0 (root).")
314 def check_boot_flag(device):
315 with open(device, 'r') as image:
316 data = image.read(512)
317 bootcode = data[440:]
318 if bootcode[6] == '\x80':
319 logging.debug("bootflag is enabled")
321 logging.debug("bootflag is NOT enabled")
322 raise VerifyException("Device %s does not have the bootflag set. "
323 "Please enable it to be able to boot." % device)
326 def mkfs_fat16(device):
327 """Format specified device with VFAT/FAT16 filesystem.
329 @device: partition that should be formated"""
332 logging.info("Would execute mkfs.vfat -F 16 %s now.", device)
335 logging.info("Formating partition with fat16 filesystem")
336 logging.debug("mkfs.vfat -F 16 %s", device)
337 proc = subprocess.Popen(["mkfs.vfat", "-F", "16", device])
339 if proc.returncode != 0:
340 raise CriticalException("error executing mkfs.vfat")
343 def generate_isolinux_splash(grml_flavour):
344 """Generate bootsplash for isolinux/syslinux
346 @grml_flavour: name of grml flavour the configuration should be generated for"""
348 grml_name = grml_flavour
351 \ f17
\f\18/boot/syslinux/logo.16
353 Some information and boot options available via keys F2 - F10. http://grml.org/
355 """ % {'grml_name': grml_name})
358 def generate_main_syslinux_config(*arg):
359 """Generate main configuration for use in syslinux.cfg
361 @*arg: just for backward compatibility"""
362 # pylint: disable-msg=W0613
363 # remove warning about unused arg
367 menu label Default boot modes:
376 menu label Additional boot entries for:
378 include additional.cfg
385 include promptname.cfg
388 Jump to old style isolinux prompt
389 featuring further information
390 regarding available boot options.
398 def generate_flavour_specific_syslinux_config(grml_flavour):
399 """Generate flavour specific configuration for use in syslinux.cfg
401 @grml_flavour: name of grml flavour the configuration should be generated for"""
404 menu begin grml %(grml_flavour)s
405 menu title %(display_name)s
407 menu label ^Back to main menu...
410 # include config for boot parameters from disk
411 include %(grml_flavour)s_grml.cfg
414 """ % {'grml_flavour': grml_flavour, 'display_name': get_flavour_filename(grml_flavour)})
417 def install_grub(device):
418 """Install grub on specified device.
420 @mntpoint: mountpoint of device where grub should install its files to
421 @device: partition where grub should be installed to"""
424 logging.info("Would execute grub-install [--root-directory=mount_point] %s now.", device)
426 device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
427 register_tmpfile(device_mountpoint)
430 mount(device, device_mountpoint, "")
432 # If using --grub-mbr then make sure we install grub in MBR instead of PBR
434 logging.debug("Using option --grub-mbr ...")
435 if device[-1:].isdigit():
436 grub_device = re.match(r'(.*?)\d*$', device).group(1)
442 logging.info("Installing grub as bootloader")
443 for opt in ["", "--force"]:
444 logging.debug("grub-install --recheck %s --no-floppy --root-directory=%s %s",
445 opt, device_mountpoint, grub_device)
446 proc = subprocess.Popen(["grub-install", "--recheck", opt, "--no-floppy",
447 "--root-directory=%s" % device_mountpoint, grub_device],
448 stdout=file(os.devnull, "r+"))
450 if proc.returncode == 0:
453 if proc.returncode != 0:
454 # raise Exception("error executing grub-install")
455 logging.critical("Fatal: error executing grub-install "
456 + "(please check the grml2usb FAQ or drop the --grub option)")
457 logging.critical("Note: if using grub2 consider using "
458 + "the --grub-mbr option as grub considers PBR problematic.")
461 except CriticalException, error:
462 logging.critical("Fatal: %s", error)
467 unmount(device_mountpoint, "")
468 os.rmdir(device_mountpoint)
469 unregister_tmpfile(device_mountpoint)
472 def install_syslinux(device):
473 """Install syslinux on specified device.
475 @device: partition where syslinux should be installed to"""
478 logging.info("Would install syslinux as bootloader on %s", device)
481 # syslinux -d boot/isolinux /dev/sdb1
482 logging.info("Installing syslinux as bootloader")
483 logging.debug("syslinux -d boot/syslinux %s", device)
484 proc = subprocess.Popen(["syslinux", "-d", "boot/syslinux", device])
486 if proc.returncode != 0:
487 raise CriticalException("Error executing syslinux (either try --fat16 or use grub?)")
490 def install_bootloader(device):
491 """Install bootloader on specified device.
493 @device: partition where bootloader should be installed to"""
495 # by default we use grub, so install syslinux only on request
499 except CriticalException, error:
500 logging.critical("Fatal: %s", error)
505 install_syslinux(device)
506 except CriticalException, error:
507 logging.critical("Fatal: %s", error)
512 def install_mbr(mbrtemplate, device, partition, ismirbsdmbr=True):
513 """install 'mbr' master boot record (MBR) on a device
515 Retrieve the partition table from "device", install an MBR from the
516 "mbrtemplate" file, set the "partition" (0..3) active, and install the
517 result back to "device".
519 @mbrtemplate: default MBR file
521 @device: name of a file assumed to be a hard disc (or USB stick) image, or
522 something like "/dev/sdb"
524 @partition: must be a number between 0 and 3, inclusive
526 @mbrtemplate: must be a valid MBR file of at least 440 (or 439 if
529 @ismirbsdmbr: if true then ignore the active flag, set the mirbsdmbr
530 specific flag to 0/1/2/3 and set the MBR's default value accordingly. If
531 false then leave the mirbsdmbr specific flag set to FFh, set all
532 active flags to 0 and set the active flag of the partition to 80h. Note:
533 behaviour of mirbsdmbr: if flag = 0/1/2/3 then use it, otherwise search for
536 logging.info("Installing default MBR")
538 if not os.path.isfile(mbrtemplate):
539 logging.critical("Error: %s can not be read.", mbrtemplate)
540 raise CriticalException("Error installing MBR (either try --syslinux-mbr or install missing file \"%s\"?)" % mbrtemplate)
542 if partition is not None and ((partition < 0) or (partition > 3)):
543 logging.warn("Cannot activate partition %d" % partition)
551 tmpf = tempfile.NamedTemporaryFile()
553 logging.debug("executing: dd if='%s' of='%s' bs=512 count=1", device, tmpf.name)
554 proc = subprocess.Popen(["dd", "if=%s" % device, "of=%s" % tmpf.name, "bs=512", "count=1"],
555 stderr=file(os.devnull, "r+"))
557 if proc.returncode != 0:
558 raise Exception("error executing dd (first run)")
560 logging.debug("executing: dd if=%s of=%s bs=%s count=1 conv=notrunc", mbrtemplate,
561 tmpf.name, nmbrbytes)
562 proc = subprocess.Popen(["dd", "if=%s" % mbrtemplate, "of=%s" % tmpf.name, "bs=%s" % nmbrbytes,
563 "count=1", "conv=notrunc"], stderr=file(os.devnull, "r+"))
565 if proc.returncode != 0:
566 raise Exception("error executing dd (second run)")
568 mbrcode = tmpf.file.read(512)
569 if len(mbrcode) < 512:
570 raise EOFError("MBR size (%d) < 512" % len(mbrcode))
572 if partition is not None:
574 mbrcode = mbrcode[0:439] + chr(partition) + \
575 mbrcode[440:510] + "\x55\xAA"
577 actives = ["\x00", "\x00", "\x00", "\x00"]
578 actives[partition] = "\x80"
579 mbrcode = mbrcode[0:446] + actives[0] + \
580 mbrcode[447:462] + actives[1] + \
581 mbrcode[463:478] + actives[2] + \
582 mbrcode[479:494] + actives[3] + \
583 mbrcode[495:510] + "\x55\xAA"
587 tmpf.file.write(mbrcode)
590 logging.debug("executing: dd if='%s' of='%s' bs=512 count=1 conv=notrunc", tmpf.name, device)
591 proc = subprocess.Popen(["dd", "if=%s" % tmpf.name, "of=%s" % device, "bs=512", "count=1",
592 "conv=notrunc"], stderr=file(os.devnull, "r+"))
594 if proc.returncode != 0:
595 raise Exception("error executing dd (third run)")
599 def is_writeable(device):
600 """Check if the device is writeable for the current user
602 @device: partition where bootloader should be installed to"""
606 #raise Exception("no device for checking write permissions")
608 if not os.path.exists(device):
611 return os.access(device, os.W_OK) and os.access(device, os.R_OK)
614 def mount(source, target, mount_options):
615 """Mount specified source on given target
617 @source: name of device/ISO that should be mounted
618 @target: directory where the ISO should be mounted to
619 @options: mount specific options"""
621 # note: options.dryrun does not work here, as we have to
622 # locate files and identify the grml flavour
624 for x in file('/proc/mounts').readlines():
625 if x.startswith(source):
626 raise CriticalException("Error executing mount: %s already mounted - " % source
627 + "please unmount before invoking grml2usb")
629 if os.path.isdir(source):
630 logging.debug("Source %s is not a device, therefore not mounting.", source)
633 logging.debug("mount %s %s %s", mount_options, source, target)
634 proc = subprocess.Popen(["mount"] + list(mount_options) + [source, target])
636 if proc.returncode != 0:
637 raise CriticalException("Error executing mount (no filesystem on the partition?)")
639 logging.debug("register_mountpoint(%s)", target)
640 register_mountpoint(target)
643 def unmount(target, unmount_options):
644 """Unmount specified target
646 @target: target where something is mounted on and which should be unmounted
647 @options: options for umount command"""
649 # make sure we unmount only already mounted targets
650 target_unmount = False
651 mounts = open('/proc/mounts').readlines()
652 mountstring = re.compile(".*%s.*" % re.escape(os.path.realpath(target)))
654 if re.match(mountstring, line):
655 target_unmount = True
657 if not target_unmount:
658 logging.debug("%s not mounted anymore", target)
660 logging.debug("umount %s %s", list(unmount_options), target)
661 proc = subprocess.Popen(["umount"] + list(unmount_options) + [target])
663 if proc.returncode != 0:
664 raise Exception("Error executing umount")
666 logging.debug("unregister_mountpoint(%s)", target)
667 unregister_mountpoint(target)
670 def check_for_usbdevice(device):
671 """Check whether the specified device is a removable USB device
673 @device: device name, like /dev/sda1 or /dev/sda
676 usbdevice = re.match(r'/dev/(.*?)\d*$', device).group(1)
678 usbdev = os.path.realpath('/sys/class/block/' + usbdevice + '/removable')
679 if not os.path.isfile(usbdev):
680 # Ubuntu with kernel 2.6.24 for example:
681 usbdev = os.path.realpath('/sys/block/' + usbdevice + '/removable')
683 if os.path.isfile(usbdev):
684 is_usb = open(usbdev).readline()
691 def check_for_fat(partition):
692 """Check whether specified partition is a valid VFAT/FAT16 filesystem
694 @partition: device name of partition"""
696 if not os.access(partition, os.R_OK):
697 raise CriticalException("Failed to read device %s"
698 " (wrong UID/permissions or device/directory not present?)" % partition)
701 udev_info = subprocess.Popen(["/sbin/blkid", "-s", "TYPE", "-o", "value", partition],
702 stdout=subprocess.PIPE, stderr=subprocess.PIPE)
703 filesystem = udev_info.communicate()[0].rstrip()
705 if filesystem != "vfat":
706 raise CriticalException(
707 "Partition %s does not contain a FAT16 filesystem. "
708 "(Use --fat16 or run mkfs.vfat %s)" % (partition, partition))
711 raise CriticalException("Sorry, /sbin/blkid not available (install e2fsprogs?)")
714 def mkdir(directory):
715 """Simple wrapper around os.makedirs to get shell mkdir -p behaviour"""
717 # just silently pass as it's just fine it the directory exists
718 if not os.path.isdir(directory):
720 os.makedirs(directory)
721 # pylint: disable-msg=W0704
726 def exec_rsync(source, target):
727 """Simple wrapper around rsync to install files
729 @source: source file/directory
730 @target: target file/directory"""
731 logging.debug("Source: %s / Target: %s", source, target)
732 proc = subprocess.Popen(["rsync", "-rlptDH", "--inplace", source, target])
734 if proc.returncode == 12:
735 logging.critical("Fatal: No space left on device")
739 if proc.returncode != 0:
740 logging.critical("Fatal: could not install %s", source)
745 def write_uuid(target_file):
746 """Generates an returns uuid and write it to the specified file
748 @target_file: filename to write the uuid to
751 fileh = open(target_file, 'w')
752 uid = str(uuid.uuid4())
758 def get_uuid(target):
759 """Get the uuid of the specified target. Will generate an uuid if none exist.
761 @target: directory/mountpoint containing the grml layout
764 conf_target = target + "/conf/"
765 uuid_file_name = conf_target + "/bootid.txt"
766 if os.path.isdir(conf_target):
767 if os.path.isfile(uuid_file_name):
768 uuid_file = open(uuid_file_name, 'r')
769 uid = uuid_file.readline().strip()
773 return write_uuid(uuid_file_name)
775 execute(mkdir, conf_target)
776 return write_uuid(uuid_file_name)
779 def get_shortname(grml_flavour):
780 """Get shortname based from grml_flavour name. The rules applied are the same as in grml-live
781 @grml_flavour: flavour name which shold be translated to shortname"""
783 return re.sub(r'[,._-]', '', grml_flavour)
786 def copy_system_files(grml_flavour, iso_mount, target):
787 """copy grml's main files (like squashfs, kernel and initrd) to a given target
789 @grml_flavour: name of grml flavour the configuration should be generated for
790 @iso_mount: path where a grml ISO is mounted on
791 @target: path where grml's main files should be copied to"""
793 squashfs = search_file(grml_flavour + '.squashfs', iso_mount)
795 logging.critical("Fatal: squashfs file not found"
796 ", please check that your iso is not corrupt")
797 raise CriticalException("error locating squashfs file")
799 squashfs_target = target + '/live/' + grml_flavour + '/'
800 execute(mkdir, squashfs_target)
801 exec_rsync(squashfs, squashfs_target + grml_flavour + '.squashfs')
803 for prefix in grml_flavour + "/", "":
804 filesystem_module = search_file(prefix + 'filesystem.module', iso_mount)
805 if filesystem_module:
807 if filesystem_module is None:
808 logging.critical("Fatal: filesystem.module not found")
809 raise CriticalException("error locating filesystem.module file")
811 exec_rsync(filesystem_module, squashfs_target + 'filesystem.module')
813 shortname = get_shortname(grml_flavour)
814 if os.path.isdir(iso_mount + '/boot/' + shortname):
815 exec_rsync(iso_mount + '/boot/' + shortname, target + '/boot')
817 kernel = search_file('vmlinuz', iso_mount)
819 # compat for releases < 2011.12
820 kernel = search_file('linux26', iso_mount)
823 logging.critical("Fatal: kernel not found")
824 raise CriticalException("error locating kernel file")
826 source = os.path.dirname(kernel) + '/'
827 dest = target + '/' + os.path.dirname(kernel).replace(iso_mount, '') + '/'
829 exec_rsync(source, dest)
832 def update_grml_versions(iso_mount, target):
833 """Update the grml version file on a cd
834 Returns true if version was updated successfully,
835 False if grml-version does not exist yet on the mountpoint
837 @iso_mount: string of the iso mount point
838 @target: path of the target mount point
840 grml_target = target + '/grml/'
841 target_grml_version_file = search_file('grml-version', grml_target)
842 if target_grml_version_file:
843 iso_grml_version_file = search_file('grml-version', iso_mount)
844 if not iso_grml_version_file:
845 logging.warn("Warning: %s could not be found - can not install it", iso_grml_version_file)
848 # read the flavours from the iso image
850 iso_file = open(iso_grml_version_file, 'r')
851 for line in iso_file:
852 iso_versions[get_flavour(line)] = line.strip()
854 # update the existing flavours on the target
855 for line in fileinput.input([target_grml_version_file], inplace=1):
856 flavour = get_flavour(line)
857 if flavour in iso_versions.keys():
858 print iso_versions.pop(flavour)
863 target_file = open(target_grml_version_file, 'a')
864 # add the new flavours from the current iso
865 for flavour in iso_versions:
866 target_file.write("%s\n" % iso_versions[flavour])
868 logging.warn("Warning: Could not write file")
877 def copy_grml_files(grml_flavour, iso_mount, target):
878 """copy some minor grml files to a given target
880 @grml_flavour: the current grml_flavour
881 @iso_mount: path where a grml ISO is mounted on
882 @target: path where grml's main files should be copied to"""
884 grml_target = target + '/grml/'
885 execute(mkdir, grml_target)
887 grml_prefixe = ["GRML", "grml"]
888 for prefix in grml_prefixe:
889 filename = "{0}/{1}/{2}".format(iso_mount, prefix, grml_flavour)
890 if os.path.exists(filename):
891 exec_rsync(filename, grml_target)
894 logging.warn("Warning: could not find flavour directory for %s ", grml_flavour)
897 def handle_addon_copy(filename, dst, iso_mount, ignore_errors=False):
898 """handle copy of optional addons
900 @filename: filename of the addon
901 @dst: destination directory
902 @iso_mount: location of the iso mount
903 @ignore_errors: don't report missing files
905 file_location = search_file(filename, iso_mount)
906 if file_location is None:
907 if not ignore_errors:
908 logging.warn("Warning: %s not found (that's fine if you don't need it)", filename)
910 exec_rsync(file_location, dst)
913 def copy_addons(iso_mount, target):
914 """copy grml's addons files (like allinoneimg, bsd4grml,..) to a given target
916 @iso_mount: path where a grml ISO is mounted on
917 @target: path where grml's main files should be copied to"""
919 addons = target + '/boot/addons/'
920 execute(mkdir, addons)
922 # grub all-in-one image
923 handle_addon_copy('allinone.img', addons, iso_mount)
926 handle_addon_copy('bsd4grml', addons, iso_mount)
929 handle_addon_copy('balder10.imz', addons, iso_mount)
931 # syslinux + pci.ids for hdt
932 for expr in '*.c32', 'pci.ids':
933 glob_and_copy(iso_mount + '/boot/addons/' + expr, addons)
936 handle_addon_copy('memdisk', addons, iso_mount)
939 handle_addon_copy('memtest', addons, iso_mount)
941 # gpxe.lkrn: got replaced by ipxe
942 handle_addon_copy('gpxe.lkrn', addons, iso_mount, ignore_errors=True)
945 handle_addon_copy('ipxe.lkrn', addons, iso_mount)
948 def build_loopbackcfg(target):
949 """Generate GRUB's loopback.cfg based on existing config files.
951 @target: target directory
954 grub_dir = '/boot/grub/'
955 mkdir(os.path.join(target, grub_dir))
957 f = open(target + grub_dir + 'loopback.cfg', 'w')
959 f.write("# grml2usb generated grub2 configuration file\n")
960 f.write("source /boot/grub/header.cfg\n")
962 for defaults in glob.glob(target + os.path.sep + grub_dir + os.path.sep + "*_default.cfg"):
963 sourcefile = defaults.split(target + os.path.sep)[1]
964 logging.debug("Found source file" + sourcefile)
965 os.path.isfile(defaults) and f.write("source " + sourcefile + "\n")
967 for ops in glob.glob(target + os.path.sep + grub_dir + os.path.sep + "*_options.cfg"):
968 sourcefile = ops.split(target + os.path.sep)[1]
969 logging.debug("Found source file" + sourcefile)
970 os.path.isfile(ops) and f.write("source " + sourcefile + "\n")
972 f.write("source /boot/grub/adddons.cfg\n")
973 f.write("source /boot/grub/footer.cfg\n")
977 def glob_and_copy(filepattern, dst):
978 """Glob on specified filepattern and copy the result to dst
980 @filepattern: globbing pattern
981 @dst: target directory
983 for name in glob.glob(filepattern):
984 copy_if_exist(name, dst)
987 def search_and_copy(filename, search_path, dst):
988 """Search for the specified filename at searchpath and copy it to dst
990 @filename: filename to look for
991 @search_path: base search file
992 @dst: destionation to copy the file to
994 file_location = search_file(filename, search_path)
995 copy_if_exist(file_location, dst)
998 def copy_if_exist(filename, dst):
999 """Copy filename to dst if filename is set.
1001 @filename: a filename
1004 if filename and (os.path.isfile(filename) or os.path.isdir(filename)):
1005 exec_rsync(filename, dst)
1008 def copy_bootloader_files(iso_mount, target, grml_flavour):
1009 """Copy grml's bootloader files to a given target
1011 @iso_mount: path where a grml ISO is mounted on
1012 @target: path where grml's main files should be copied to
1013 @grml_flavour: name of the current processed grml_flavour
1016 syslinux_target = target + '/boot/syslinux/'
1017 execute(mkdir, syslinux_target)
1019 grub_target = target + '/boot/grub/'
1020 execute(mkdir, grub_target)
1022 logo = search_file('logo.16', iso_mount)
1023 exec_rsync(logo, syslinux_target + 'logo.16')
1025 bootx64_efi = search_file('bootx64.efi', iso_mount)
1027 mkdir(target + '/efi/boot/')
1028 exec_rsync(bootx64_efi, target + '/efi/boot/bootx64.efi')
1030 efi_img = search_file('efi.img', iso_mount)
1032 mkdir(target + '/boot/')
1033 exec_rsync(efi_img, target + '/boot/efi.img')
1035 for ffile in ['f%d' % number for number in range(1, 11)]:
1036 search_and_copy(ffile, iso_mount, syslinux_target + ffile)
1038 # avoid the "file is read only, overwrite anyway (y/n) ?" question
1039 # of mtools by syslinux ("mmove -D o -D O s:/ldlinux.sys $target_file")
1040 if os.path.isfile(syslinux_target + 'ldlinux.sys'):
1041 os.unlink(syslinux_target + 'ldlinux.sys')
1043 (source_dir, name) = get_defaults_file(iso_mount, grml_flavour, "default.cfg")
1044 (source_dir, defaults_file) = get_defaults_file(iso_mount, grml_flavour, "grml.cfg")
1047 logging.critical("Fatal: file default.cfg could not be found.")
1048 logging.critical("Note: this grml2usb version requires an ISO generated by grml-live >=0.9.24 ...")
1049 logging.critical(" ... either use grml releases >=2009.10 or switch to an older grml2usb version.")
1052 if not os.path.exists(iso_mount + '/boot/grub/footer.cfg'):
1053 logging.warning("Warning: Grml releases older than 2011.12 support only one flavour in grub.")
1055 for expr in name, 'distri.cfg', \
1056 defaults_file, 'grml.png', 'hd.cfg', 'isolinux.cfg', 'isolinux.bin', \
1057 'isoprompt.cfg', 'options.cfg', \
1058 'prompt.cfg', 'vesamenu.cfg', 'grml.png', '*.c32':
1059 glob_and_copy(iso_mount + source_dir + expr, syslinux_target)
1061 for filename in glob.glob1(syslinux_target, "*.c32"):
1062 copy_if_exist(os.path.join(SYSLINUX_LIBS, filename), syslinux_target)
1064 # copy the addons_*.cfg file to the new syslinux directory
1065 glob_and_copy(iso_mount + source_dir + 'addon*.cfg', syslinux_target)
1067 search_and_copy('hidden.cfg', iso_mount + source_dir, syslinux_target + "new_" + 'hidden.cfg')
1069 # copy all grub files from ISO
1070 glob_and_copy(iso_mount + '/boot/grub/*', grub_target)
1072 # finally (after all GRUB files have been been installed) build static loopback.cfg
1073 build_loopbackcfg(target)
1076 def install_iso_files(grml_flavour, iso_mount, device, target):
1077 """Copy files from ISO to given target
1079 @grml_flavour: name of grml flavour the configuration should be generated for
1080 @iso_mount: path where a grml ISO is mounted on
1081 @device: device/partition where bootloader should be installed to
1082 @target: path where grml's main files should be copied to"""
1085 GRML_DEFAULT = GRML_DEFAULT or grml_flavour
1088 elif not options.bootloaderonly:
1089 logging.info("Copying files. This might take a while....")
1091 copy_system_files(grml_flavour, iso_mount, target)
1092 copy_grml_files(grml_flavour, iso_mount, target)
1093 except CriticalException, error:
1094 logging.critical("Execution failed: %s", error)
1097 if not options.skipaddons:
1098 if not search_file('addons', iso_mount):
1099 logging.info("Could not find addons, therefore not installing.")
1101 copy_addons(iso_mount, target)
1103 if not options.copyonly:
1104 copy_bootloader_files(iso_mount, target, grml_flavour)
1106 if not options.dryrun:
1107 handle_bootloader_config(grml_flavour, device, target)
1109 # make sure we sync filesystems before returning
1110 proc = subprocess.Popen(["sync"])
1114 def get_flavour(flavour_str):
1115 """Returns the flavour of a grml version string
1117 return re.match(r'[\w-]*', flavour_str).group()
1120 def identify_grml_flavour(mountpath):
1121 """Get name of grml flavour
1123 @mountpath: path where the grml ISO is mounted to
1124 @return: name of grml-flavour"""
1126 version_files = search_file('grml-version', mountpath, lst_return=True)
1128 if not version_files:
1129 if mountpath.startswith("/live/image"):
1130 logging.critical("Error: could not find grml-version file.")
1131 logging.critical("Looks like your system is running from RAM but required files are not available.")
1132 logging.critical("Please either boot without toram=... or use boot option toram instead of toram=...")
1136 logging.critical("Error: could not find grml-version file.")
1141 logging.debug("version_files = %s", version_files)
1142 for version_file in version_files:
1145 tmpfile = open(version_file, 'r')
1146 for line in tmpfile.readlines():
1147 flavours.append(get_flavour(line))
1148 except TypeError, e:
1150 except Exception, e:
1151 logging.critical("Unexpected error: %s", e)
1160 def get_bootoptions(grml_flavour):
1161 """Returns bootoptions for specific flavour
1163 @grml_flavour: name of the grml_flavour
1165 # do NOT write "None" in kernel cmdline
1166 if not options.bootoptions:
1169 bootopt = " ".join(options.bootoptions)
1170 bootopt = bootopt.replace("%flavour", grml_flavour)
1174 def handle_grub_config(grml_flavour, device, target):
1175 """Main handler for generating grub (v1 and v2) configuration
1177 @grml_flavour: name of grml flavour the configuration should be generated for
1178 @device: device/partition where grub should be installed to
1179 @target: path of grub's configuration files"""
1183 logging.debug("Updating grub configuration")
1185 grub_target = target + '/boot/grub/'
1187 bootid_re = re.compile("bootid=[\w_-]+")
1188 live_media_path_re = re.compile("live-media-path=[\w_/-]+")
1190 bootopt = get_bootoptions(grml_flavour)
1193 option_re = re.compile(r'(.*/boot/.*(linux26|vmlinuz).*)')
1195 if options.removeoption:
1196 for regex in options.removeoption:
1197 remove_regexes.append(re.compile(regex))
1199 shortname = get_shortname(grml_flavour)
1200 for filename in glob.glob(grub_target + '*.cfg'):
1201 for line in fileinput.input(filename, inplace=1):
1202 line = line.rstrip("\r\n")
1203 if option_re.search(line):
1204 line = bootid_re.sub('', line)
1205 if shortname in filename:
1206 line = live_media_path_re.sub('', line)
1207 line = line.rstrip() + ' live-media-path=/live/%s/ ' % (grml_flavour)
1208 line = line.rstrip() + r' bootid=%s %s ' % (UUID, bootopt)
1209 for regex in remove_regexes:
1210 line = regex.sub(' ', line)
1215 def initial_syslinux_config(target):
1216 """Generates intial syslinux configuration
1218 @target path of syslinux's configuration files"""
1220 target = target + "/"
1221 filename = target + "grmlmain.cfg"
1222 if os.path.isfile(target + "grmlmain.cfg"):
1224 data = open(filename, "w")
1225 data.write(generate_main_syslinux_config())
1228 filename = target + "hiddens.cfg"
1229 data = open(filename, "w")
1230 data.write("include hidden.cfg\n")
1234 def add_entry_if_not_present(filename, entry):
1235 """Write entry into filename if entry is not already in the file
1237 @filanme: name of the file
1238 @entry: data to write to the file
1240 data = open(filename, "a+")
1250 def get_flavour_filename(flavour):
1251 """Generate a iso9960 save filename out of the specified flavour
1253 @flavour: grml flavour
1255 return flavour.replace('-', '_')
1258 def adjust_syslinux_bootoptions(src, flavour):
1259 """Adjust existing bootoptions of specified syslinux config to
1260 grml2usb specific ones, e.g. change the location of the kernel...
1262 @src: config file to alter
1263 @flavour: grml flavour
1266 append_re = re.compile("^(\s*append.*/boot/.*)$", re.I)
1267 # flavour_re = re.compile("(label.*)(grml\w+)")
1268 default_re = re.compile("(default.cfg)")
1269 bootid_re = re.compile("bootid=[\w_-]+")
1270 live_media_path_re = re.compile("live-media-path=[\w_/-]+")
1272 bootopt = get_bootoptions(flavour)
1276 if options.removeoption:
1277 option_re = re.compile(r'/boot/.*/(initrd.gz|initrd.img)')
1279 for regex in options.removeoption:
1280 regexe.append(re.compile(r'%s' % regex))
1282 for line in fileinput.input(src, inplace=1):
1283 # line = flavour_re.sub(r'\1 %s-\2' % flavour, line)
1284 line = default_re.sub(r'%s-\1' % flavour, line)
1285 line = bootid_re.sub('', line)
1286 line = live_media_path_re.sub('', line)
1287 line = append_re.sub(r'\1 live-media-path=/live/%s/ ' % flavour, line)
1288 line = append_re.sub(r'\1 boot=live %s ' % bootopt, line)
1289 line = append_re.sub(r'\1 %s=%s ' % ("bootid", UUID), line)
1290 if option_re and option_re.search(line):
1291 for regex in regexe:
1292 line = regex.sub(' ', line)
1293 sys.stdout.write(line)
1297 def adjust_labels(src, replacement):
1298 """Adjust the specified labels in the syslinux config file src with
1299 specified replacement
1301 label_re = re.compile("^(\s*label\s*) ([a-zA-Z0-9_-]+)", re.I)
1302 for line in fileinput.input(src, inplace=1):
1303 line = label_re.sub(replacement, line)
1304 sys.stdout.write(line)
1308 def add_syslinux_entry(filename, grml_flavour):
1309 """Add includes for a specific grml_flavour to the specified filename
1311 @filename: syslinux config file
1312 @grml_flavour: grml flavour to add
1315 entry_filename = "option_%s.cfg" % grml_flavour
1316 entry = "include %s\n" % entry_filename
1318 add_entry_if_not_present(filename, entry)
1319 path = os.path.dirname(filename)
1321 data = open(path + "/" + entry_filename, "w")
1322 data.write(generate_flavour_specific_syslinux_config(grml_flavour))
1326 def modify_filenames(grml_flavour, target, filenames):
1327 """Replace the standard filenames with the new ones
1329 @grml_flavour: grml-flavour strin
1330 @target: directory where the files are located
1331 @filenames: list of filenames to alter
1333 grml_filename = get_flavour_filename(grml_flavour)
1334 for filename in filenames:
1335 old_filename = "%s/%s" % (target, filename)
1336 new_filename = "%s/%s_%s" % (target, grml_filename, filename)
1337 os.rename(old_filename, new_filename)
1340 def remove_default_entry(filename):
1341 """Remove the default entry from specified syslinux file
1343 @filename: syslinux config file
1345 default_re = re.compile("^(\s*menu\s*default\s*)$", re.I)
1346 for line in fileinput.input(filename, inplace=1):
1347 if default_re.match(line):
1349 sys.stdout.write(line)
1353 def handle_syslinux_config(grml_flavour, target):
1354 """Main handler for generating syslinux configuration
1356 @grml_flavour: name of grml flavour the configuration should be generated for
1357 @target: path of syslinux's configuration files"""
1359 logging.debug("Generating syslinux configuration")
1360 syslinux_target = target + '/boot/syslinux/'
1361 # should be present via copy_bootloader_files(), but make sure it exits:
1362 execute(mkdir, syslinux_target)
1363 syslinux_cfg = syslinux_target + 'syslinux.cfg'
1365 # install main configuration only *once*, no matter how many ISOs we have:
1366 syslinux_config_file = open(syslinux_cfg, 'w')
1367 syslinux_config_file.write("TIMEOUT 300\n")
1368 syslinux_config_file.write("include vesamenu.cfg\n")
1369 syslinux_config_file.close()
1371 prompt_name = open(syslinux_target + 'promptname.cfg', 'w')
1372 prompt_name.write('menu label S^yslinux prompt\n')
1375 initial_syslinux_config(syslinux_target)
1376 flavour_filename = get_flavour_filename(grml_flavour)
1378 if search_file('default.cfg', syslinux_target):
1379 modify_filenames(grml_flavour, syslinux_target, ['grml.cfg', 'default.cfg'])
1381 filename = search_file("new_hidden.cfg", syslinux_target)
1383 # process hidden file
1384 if not search_file("hidden.cfg", syslinux_target):
1385 new_hidden = syslinux_target + "hidden.cfg"
1386 os.rename(filename, new_hidden)
1387 adjust_syslinux_bootoptions(new_hidden, grml_flavour)
1389 new_hidden_file = "%s/%s_hidden.cfg" % (syslinux_target, flavour_filename)
1390 os.rename(filename, new_hidden_file)
1391 adjust_labels(new_hidden_file, r'\1 %s-\2' % grml_flavour)
1392 adjust_syslinux_bootoptions(new_hidden_file, grml_flavour)
1393 entry = 'include %s_hidden.cfg\n' % flavour_filename
1394 add_entry_if_not_present("%s/hiddens.cfg" % syslinux_target, entry)
1396 new_default = "%s_default.cfg" % (flavour_filename)
1397 entry = 'include %s\n' % new_default
1398 defaults_file = '%s/defaults.cfg' % syslinux_target
1399 new_default_with_path = "%s/%s" % (syslinux_target, new_default)
1400 new_grml_cfg = "%s/%s_grml.cfg" % (syslinux_target, flavour_filename)
1402 if os.path.isfile(defaults_file):
1404 # remove default menu entry in menu
1405 remove_default_entry(new_default_with_path)
1407 # adjust all labels for additional isos
1408 adjust_labels(new_default_with_path, r'\1 %s' % grml_flavour)
1409 adjust_labels(new_grml_cfg, r'\1 %s-\2' % grml_flavour)
1411 # always adjust bootoptions
1412 adjust_syslinux_bootoptions(new_default_with_path, grml_flavour)
1413 adjust_syslinux_bootoptions(new_grml_cfg, grml_flavour)
1415 add_entry_if_not_present("%s/defaults.cfg" % syslinux_target, entry)
1417 add_syslinux_entry("%s/additional.cfg" % syslinux_target, flavour_filename)
1420 def handle_bootloader_config(grml_flavour, device, target):
1421 """Main handler for generating bootloader's configuration
1423 @grml_flavour: name of grml flavour the configuration should be generated for
1424 @device: device/partition where bootloader should be installed to
1425 @target: path of bootloader's configuration files"""
1428 UUID = get_uuid(target)
1429 if options.skipsyslinuxconfig:
1430 logging.info("Skipping generation of syslinux configuration as requested.")
1433 handle_syslinux_config(grml_flavour, target)
1434 except CriticalException, error:
1435 logging.critical("Fatal: %s", error)
1438 if options.skipgrubconfig:
1439 logging.info("Skipping generation of grub configuration as requested.")
1442 handle_grub_config(grml_flavour, device, target)
1443 except CriticalException, error:
1444 logging.critical("Fatal: %s", error)
1448 def install(image, device):
1449 """Install a grml image to the specified device
1451 @image: directory or is file
1452 @device: partition or directory to install the device
1454 iso_mountpoint = image
1455 remove_image_mountpoint = False
1456 if os.path.isdir(image):
1457 logging.info("Using %s as install base", image)
1459 logging.info("Using ISO %s", image)
1460 iso_mountpoint = tempfile.mkdtemp(prefix="grml2usb", dir=options.tmpdir)
1461 register_tmpfile(iso_mountpoint)
1462 remove_image_mountpoint = True
1464 mount(image, iso_mountpoint, ["-o", "loop,ro", "-t", "iso9660"])
1465 except CriticalException, error:
1466 logging.critical("Fatal: %s", error)
1470 install_grml(iso_mountpoint, device)
1472 if remove_image_mountpoint:
1474 remove_mountpoint(iso_mountpoint)
1475 except CriticalException, error:
1476 logging.critical("Fatal: %s", error)
1480 def install_grml(mountpoint, device):
1481 """Main logic for copying files of the currently running grml system.
1483 @mountpoin: directory where currently running live system resides (usually /live/image)
1484 @device: partition where the specified ISO should be installed to"""
1486 device_mountpoint = device
1487 if os.path.isdir(device):
1488 logging.info("Specified device is a directory, therefore not mounting.")
1489 remove_device_mountpoint = False
1491 device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
1492 register_tmpfile(device_mountpoint)
1493 remove_device_mountpoint = True
1495 check_for_fat(device)
1496 check_boot_flag(device)
1497 mount(device, device_mountpoint, ['-o', 'utf8,iocharset=iso8859-1'])
1498 except VerifyException, error:
1499 logging.critical("Fatal: %s", error)
1501 except CriticalException, error:
1503 mount(device, device_mountpoint, "")
1504 except CriticalException, error:
1505 logging.critical("Fatal: %s", error)
1508 grml_flavours = identify_grml_flavour(mountpoint)
1509 for flavour in set(grml_flavours):
1511 logging.warning("No valid flavour found, please check your iso")
1512 logging.info("Identified grml flavour \"%s\".", flavour)
1513 install_iso_files(flavour, mountpoint, device, device_mountpoint)
1514 GRML_FLAVOURS.add(flavour)
1516 if remove_device_mountpoint:
1517 remove_mountpoint(device_mountpoint)
1520 def remove_mountpoint(mountpoint):
1521 """remove a registred mountpoint
1525 unmount(mountpoint, "")
1526 if os.path.isdir(mountpoint):
1527 os.rmdir(mountpoint)
1528 unregister_tmpfile(mountpoint)
1529 except CriticalException, error:
1530 logging.critical("Fatal: %s", error)
1534 def handle_mbr(device):
1535 """Main handler for installing master boot record (MBR)
1537 @device: device where the MBR should be installed to"""
1540 logging.info("Would install MBR")
1543 if device[-1:].isdigit():
1544 mbr_device = re.match(r'(.*?)\d*$', device).group(1)
1545 partition_number = int(device[-1:]) - 1
1547 logging.warn("Could not detect partition number, not activating partition")
1548 partition_number = None
1550 # if we get e.g. /dev/loop1 as device we don't want to put the MBR
1551 # into /dev/loop of course, therefore use /dev/loop1 as mbr_device
1552 if mbr_device == "/dev/loop":
1554 logging.info("Detected loop device - using %s as MBR device therefore", mbr_device)
1556 mbrcode = GRML2USB_BASE + '/mbr/mbrldr'
1557 if options.syslinuxmbr:
1558 mbrcode = '/usr/lib/syslinux/mbr.bin'
1559 elif options.mbrmenu:
1560 mbrcode = GRML2USB_BASE + '/mbr/mbrldr'
1563 install_mbr(mbrcode, mbr_device, partition_number, True)
1564 except IOError, error:
1565 logging.critical("Execution failed: %s", error)
1567 except Exception, error:
1568 logging.critical("Execution failed: %s", error)
1572 def handle_vfat(device):
1573 """Check for FAT specific settings and options
1575 @device: device that should checked / formated"""
1577 # make sure we have mkfs.vfat available
1579 if not which("mkfs.vfat") and not options.copyonly and not options.dryrun:
1580 logging.critical('Sorry, mkfs.vfat not available. Exiting.')
1581 logging.critical('Please make sure to install dosfstools.')
1585 print "Forcing mkfs.fat16 on %s as requested via option --force." % device
1587 # make sure the user is aware of what he is doing
1588 f = raw_input("Are you sure you want to format the specified partition with fat16? y/N ")
1589 if f == "y" or f == "Y":
1590 logging.info("Note: you can skip this question using the option --force")
1595 except CriticalException, error:
1596 logging.critical("Execution failed: %s", error)
1599 # check for vfat filesystem
1600 if device is not None and not os.path.isdir(device) and options.syslinux:
1602 check_for_fat(device)
1603 except CriticalException, error:
1604 logging.critical("Execution failed: %s", error)
1607 if not os.path.isdir(device) and not check_for_usbdevice(device) and not options.force:
1608 print "Warning: the specified device %s does not look like a removable usb device." % device
1609 f = raw_input("Do you really want to continue? y/N ")
1610 if f == "y" or f == "Y":
1616 def handle_compat_warning(device):
1617 """Backwards compatible checks
1619 @device: device that should be checked"""
1621 # make sure we can replace old grml2usb script and warn user when using old way of life:
1622 if device.startswith("/mnt/external") or device.startswith("/mnt/usb") and not options.force:
1623 print "Warning: the semantics of grml2usb has changed."
1624 print "Instead of using grml2usb /path/to/iso %s you might" % device
1625 print "want to use grml2usb /path/to/iso /dev/... instead."
1626 print "Please check out the grml2usb manpage for details."
1627 f = raw_input("Do you really want to continue? y/N ")
1628 if f == "y" or f == "Y":
1634 def handle_logging():
1635 """Log handling and configuration"""
1637 if options.verbose and options.quiet:
1638 parser.error("please use either verbose (--verbose) or quiet (--quiet) option")
1641 FORMAT = "Debug: %(asctime)-15s %(message)s"
1642 logging.basicConfig(level=logging.DEBUG, format=FORMAT)
1644 FORMAT = "Critical: %(message)s"
1645 logging.basicConfig(level=logging.CRITICAL, format=FORMAT)
1647 FORMAT = "%(message)s"
1648 logging.basicConfig(level=logging.INFO, format=FORMAT)
1651 def handle_bootloader(device):
1652 """wrapper for installing bootloader
1654 @device: device where bootloader should be installed to"""
1656 # Install bootloader only if not using the --copy-only option
1657 if options.copyonly:
1658 logging.info("Not installing bootloader and its files as requested via option copyonly.")
1659 elif os.path.isdir(device):
1660 logging.info("Not installing bootloader as %s is a directory.", device)
1662 install_bootloader(device)
1665 def check_options(opts):
1666 """Check compability of provided user opts
1668 @opts option dict from OptionParser
1670 if opts.grubmbr and not opts.grub:
1671 logging.critical("Error: --grub-mbr requires --grub option.")
1675 def check_programs():
1676 """check if all needed programs are installed"""
1678 if not which("grub-install"):
1679 logging.critical("Fatal: grub-install not available (please install the "
1680 + "grub package or drop the --grub option)")
1683 if options.syslinux:
1684 if not which("syslinux"):
1685 logging.critical("Fatal: syslinux not available (please install the "
1686 + "syslinux package or use the --grub option)")
1689 if not which("rsync"):
1690 logging.critical("Fatal: rsync not available, can not continue - sorry.")
1695 """Runs modprobe loop and throws away it's output"""
1696 proc = subprocess.Popen(["modprobe", "loop"], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
1701 """Main function [make pylint happy :)]"""
1704 print os.path.basename(sys.argv[0]) + " " + PROG_VERSION
1708 parser.error("invalid usage")
1713 # make sure we have the appropriate permissions
1716 check_options(options)
1720 logging.info("Executing grml2usb version %s", PROG_VERSION)
1723 logging.info("Running in simulation mode as requested via option dry-run.")
1727 # specified arguments
1728 device = os.path.realpath(args[len(args) - 1])
1729 isos = args[0:len(args) - 1]
1731 if not os.path.isdir(device):
1732 if device[-1:].isdigit():
1733 if int(device[-1:]) > 4 or device[-2:].isdigit():
1734 logging.critical("Fatal: installation on partition number >4 not supported. (BIOS won't support it.)")
1737 # provide upgrade path
1738 handle_compat_warning(device)
1740 # check for vfat partition
1743 # main operation (like installing files)
1745 install(iso, device)
1748 is_superfloppy = not device[-1:].isdigit()
1750 logging.info("Detected superfloppy format - not installing MBR")
1752 if not options.skipmbr and not os.path.isdir(device) and not is_superfloppy:
1755 handle_bootloader(device)
1757 logging.info("Note: grml flavour %s was installed as the default booting system.", GRML_DEFAULT)
1759 for flavour in GRML_FLAVOURS:
1760 logging.info("Note: you can boot flavour %s using '%s' on the commandline.", flavour, flavour)
1762 # finally be politely :)
1763 logging.info("Finished execution of grml2usb (%s). Have fun with your grml system.", PROG_VERSION)
1766 if __name__ == "__main__":
1769 except KeyboardInterrupt:
1770 logging.info("Received KeyboardInterrupt")
1773 ## END OF FILE #################################################################
1774 # vim:foldmethod=indent expandtab ai ft=python tw=120 fileencoding=utf-8