From: Michael Prokop Date: Wed, 4 Feb 2009 16:37:47 +0000 (+0100) Subject: Initial working version for multi ISO support X-Git-Tag: v0.9.2~50 X-Git-Url: https://git.grml.org/?p=grml2usb.git;a=commitdiff_plain;h=d38c41706080d319df5e1415c96c357fe5046c18 Initial working version for multi ISO support --- diff --git a/grml2usb.py b/grml2usb.py index f4e45e9..6b0a381 100755 --- a/grml2usb.py +++ b/grml2usb.py @@ -13,15 +13,16 @@ This script installs a grml system (running system / ISO[s]) to a USB device TODO ---- -* verify that the specified device is really an USB device (/sys/devices/*/removable_) -* validate partition schema/layout: - -> bootable flag? - -> fat16 partition if using syslinux +* code improvements: + - improve error handling :) + - get rid of all TODOs in code :) + - use 'with open("...", "w") as f: ... f.write("...")' + - simplify functions/code as much as possible -> audit * implement missing options (--kernel, --initrd, --uninstall,...) -* improve error handling :) -* implement logic for storing information about copied files - -> register every single file? -* get rid of all TODOs in code :) +* validate partition schema/layout: is the partition schema ok and the bootable flag set? +* implement logic for storing information about copied files -> register every file in a set() +* the last line in bootsplash (boot.msg) should mention all installed grml flavours +* extend flavour's syslinux configuration * graphical version? :) """ @@ -32,10 +33,14 @@ from os.path import exists, join, abspath from os import pathsep from inspect import isroutine, isclass import logging +import datetime, time +# global variables PROG_VERSION = "0.0.1" - skip_mbr = False # By default we don't want to skip it; TODO - can we get rid of that? +mounted = set() # register mountpoints +tmpfiles = set() # register tmpfiles +datestamp= time.mktime(datetime.datetime.now().timetuple()) # unique identifier for syslinux.cfg # cmdline parsing usage = "Usage: %prog [options] <[ISO[s] | /live/image]> \n\ @@ -67,8 +72,6 @@ parser.add_option("--kernel", dest="kernel", action="store", type="string", help="install specified kernel instead of the default") parser.add_option("--mbr", dest="mbr", action="store_true", help="install master boot record (MBR) on the device") -parser.add_option("--mountpath", dest="mountpath", action="store_true", - help="install system to specified mount path") parser.add_option("--quiet", dest="quiet", action="store_true", help="do not output anything than errors on console") parser.add_option("--squashfs", dest="squashfs", action="store", type="string", @@ -82,6 +85,21 @@ parser.add_option("-v", "--version", dest="version", action="store_true", (options, args) = parser.parse_args() +def cleanup(): + """TODO + """ + + logging.info("Cleaning up") + proc = subprocess.Popen(["sync"]) + proc.wait() + + try: + for device in mounted: + unmount(device, "") + # ignore: RuntimeError: Set changed size during iteration + except: + pass + def get_function_name(obj): if not (isroutine(obj) or isclass(obj)): obj = type(obj) @@ -150,7 +168,7 @@ def install_syslinux(device, dry_run=False): """Install syslinux on specified device.""" # syslinux -d boot/isolinux /dev/sdb1 - logging.info("Installing syslinux") + logging.info("Installing syslinux as bootloader") logging.debug("syslinux -d boot/syslinux %s" % device) proc = subprocess.Popen(["syslinux", "-d", "boot/syslinux", device]) proc.wait() @@ -208,8 +226,10 @@ def generate_main_syslinux_config(grml_flavour, grml_bootoptions): # * unify isolinux and syslinux setup ("INCLUDE /boot/...") # as far as possible + local_datestamp = datestamp + return("""\ -## main syslinux configuration - generated by grml2usb +## main syslinux configuration - generated by grml2usb [main config generated at: %(local_datestamp)s] # use this to control the bootup via a serial port # SERIAL 0 9600 DEFAULT grml @@ -238,9 +258,11 @@ APPEND initrd=/boot/release/%(grml_flavour)s/initrd.gz apm=power-off boot=live n def generate_flavour_specific_syslinux_config(grml_flavour, bootoptions): """Generate flavour specific configuration for use in syslinux.cfg""" + local_datestamp = datestamp + return("""\ -# flavour specific configuration for %(grml_flavour)s +# flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s] LABEL %(grml_flavour)s KERNEL /boot/release/%(grml_flavour)s/linux26 APPEND initrd=/boot/release/%(grml_flavour)s/initrd.gz apm=power-off boot=live nomce quiet module=%(grml_flavour)s %(bootoptions)s @@ -313,7 +335,7 @@ def install_mbr(device, dry_run=False): logging.debug("cat /usr/lib/syslinux/mbr.bin > %s" % device) if not dry_run: try: - # TODO use Popen instead? + # TODO -> use Popen instead? retcode = subprocess.call("cat /usr/lib/syslinux/mbr.bin > "+ device, shell=True) if retcode < 0: logging.critical("Error copying MBR to device (%s)" % retcode) @@ -321,6 +343,36 @@ def install_mbr(device, dry_run=False): logging.critical("Execution failed:", error) +def register_tmpfile(path): + """TODO + """ + + tmpfiles.add(path) + + +def unregister_tmpfile(path): + """TODO + """ + + if path in tmpfiles: + tmpfiles.remove(path) + + +def register_mountpoint(target): + """TODO + """ + + mounted.add(target) + + +def unregister_mountpoint(target): + """TODO + """ + + if target in mounted: + mounted.remove(target) + + def mount(source, target, options): """Mount specified source on given target @@ -334,42 +386,70 @@ def mount(source, target, options): proc.wait() if proc.returncode != 0: raise Exception, "Error executing mount" + else: + logging.debug("register_mountpoint(%s)" % target) + register_mountpoint(target) -def unmount(directory): - """Unmount specified directory +def unmount(target, options): + """Unmount specified target - @directory: directory where something is mounted on and which should be unmounted""" + @target: target where something is mounted on and which should be unmounted + @options: options for umount command""" - logging.debug("umount %s" % directory) - proc = subprocess.Popen(["umount"] + [directory]) - proc.wait() - if proc.returncode != 0: - raise Exception, "Error executing umount" + # make sure we unmount only already mounted targets + target_unmount = False + mounts = open('/proc/mounts').readlines() + mountstring = re.compile(".*%s.*" % re.escape(target)) + for line in mounts: + if re.match(mountstring, line): + target_unmount = True + + if not target_unmount: + logging.debug("%s not mounted anymore" % target) + else: + logging.debug("umount %s %s" % (list(options), target)) + proc = subprocess.Popen(["umount"] + list(options) + [target]) + proc.wait() + if proc.returncode != 0: + raise Exception, "Error executing umount" + else: + logging.debug("unregister_mountpoint(%s)" % target) + unregister_mountpoint(target) + + +def check_for_usbdevice(device): + """Check whether the specified device is a removable USB device + + @device: device name, like /dev/sda1 or /dev/sda + """ + + usbdevice = re.match(r'/dev/(.*?)\d*$', device).group(1) + usbdevice = os.path.realpath('/sys/class/block/' + usbdevice + '/removable') + if os.path.isfile(usbdevice): + is_usb = open(usbdevice).readline() + if is_usb == "1": + return 0 + else: + return 1 -def check_for_vat(partition): +def check_for_fat(partition): """Check whether specified partition is a valid VFAT/FAT16 filesystem @partition: device name of partition""" try: - udev_info = subprocess.Popen(["/lib/udev/vol_id", "-t", - partition],stdout=subprocess.PIPE, stderr=subprocess.PIPE) + udev_info = subprocess.Popen(["/lib/udev/vol_id", "-t", partition],stdout=subprocess.PIPE, stderr=subprocess.PIPE) filesystem = udev_info.communicate()[0].rstrip() if udev_info.returncode == 2: - logging.critical("failed to read device %s - wrong UID / permissions?" % partition) - return 1 + raise Exception, "Failed to read device %s - wrong UID / permissions?" % partition if filesystem != "vfat": - return 1 - - # TODO - # * check for ID_FS_VERSION=FAT16 as well? + raise Exception, "Device %s does not contain a FAT16 partition" % partition except OSError: - logging.critical("Sorry, /lib/udev/vol_id not available.") - return 1 + raise Exception, "Sorry, /lib/udev/vol_id not available." def mkdir(directory): @@ -391,34 +471,35 @@ def copy_grml_files(grml_flavour, iso_mount, target, dry_run=False): # * catch "install: .. No space left on device" & CO # * abstract copy logic to make the code shorter and get rid of spaghetti ;) - logging.info("Copying files. This might take a while....") + if not options.bootloaderonly: + logging.info("Copying files. This might take a while....") - squashfs = search_file(grml_flavour + '.squashfs', iso_mount) - squashfs_target = target + '/live/' - execute(mkdir, squashfs_target) + squashfs = search_file(grml_flavour + '.squashfs', iso_mount) + squashfs_target = target + '/live/' + execute(mkdir, squashfs_target) - # use install(1) for now to make sure we can write the files afterwards as normal user as well - logging.debug("cp %s %s" % (squashfs, target + '/live/' + grml_flavour + '.squashfs')) - proc = execute(subprocess.Popen, ["install", "--mode=664", squashfs, squashfs_target + grml_flavour + ".squashfs"]) - proc.wait() + # use install(1) for now to make sure we can write the files afterwards as normal user as well + logging.debug("cp %s %s" % (squashfs, target + '/live/' + grml_flavour + '.squashfs')) + proc = execute(subprocess.Popen, ["install", "--mode=664", squashfs, squashfs_target + grml_flavour + ".squashfs"]) + proc.wait() - filesystem_module = search_file('filesystem.module', iso_mount) - logging.debug("cp %s %s" % (filesystem_module, squashfs_target + grml_flavour + '.module')) - proc = execute(subprocess.Popen, ["install", "--mode=664", filesystem_module, squashfs_target + grml_flavour + '.module']) - proc.wait() + filesystem_module = search_file('filesystem.module', iso_mount) + logging.debug("cp %s %s" % (filesystem_module, squashfs_target + grml_flavour + '.module')) + proc = execute(subprocess.Popen, ["install", "--mode=664", filesystem_module, squashfs_target + grml_flavour + '.module']) + proc.wait() - release_target = target + '/boot/release/' + grml_flavour - execute(mkdir, release_target) + release_target = target + '/boot/release/' + grml_flavour + execute(mkdir, release_target) - kernel = search_file('linux26', iso_mount) - logging.debug("cp %s %s" % (kernel, release_target + '/linux26')) - proc = execute(subprocess.Popen, ["install", "--mode=664", kernel, release_target + '/linux26']) - proc.wait() + kernel = search_file('linux26', iso_mount) + logging.debug("cp %s %s" % (kernel, release_target + '/linux26')) + proc = execute(subprocess.Popen, ["install", "--mode=664", kernel, release_target + '/linux26']) + proc.wait() - initrd = search_file('initrd.gz', iso_mount) - logging.debug("cp %s %s" % (initrd, release_target + '/initrd.gz')) - proc = execute(subprocess.Popen, ["install", "--mode=664", initrd, release_target + '/initrd.gz']) - proc.wait() + initrd = search_file('initrd.gz', iso_mount) + logging.debug("cp %s %s" % (initrd, release_target + '/initrd.gz')) + proc = execute(subprocess.Popen, ["install", "--mode=664", initrd, release_target + '/initrd.gz']) + proc.wait() if not options.copyonly: syslinux_target = target + '/boot/syslinux/' @@ -447,41 +528,46 @@ def copy_grml_files(grml_flavour, iso_mount, target, dry_run=False): proc.wait() if not dry_run: - logging.debug("Generating grub configuration") # % grub_target + 'menu.lst') + logging.debug("Generating grub configuration") #with open("...", "w") as f: #f.write("bla bla bal") grub_config_file = open(grub_target + 'menu.lst', 'w') grub_config_file.write(generate_grub_config(grml_flavour)) grub_config_file.close() - logging.info("Generating syslinux configuration") # % syslinux_target + 'syslinux.cfg') + logging.info("Generating syslinux configuration") syslinux_cfg = syslinux_target + 'syslinux.cfg' # install main configuration only *once*, no matter how many ISOs we have: if os.path.isfile(syslinux_cfg): string = open(syslinux_cfg).readline() - if not re.match("## main syslinux configuration", string): + main_identifier = re.compile(".*main config generated at: %s.*" % re.escape(str(datestamp))) + if not re.match(main_identifier, string): syslinux_config_file = open(syslinux_cfg, 'w') - syslinux_config_file.write(generate_main_syslinux_config(grml_flavour, "")) # FIXME - bootoptions + logging.info("Notice: grml flavour %s is being installed as the default booting system." % grml_flavour) + syslinux_config_file.write(generate_main_syslinux_config(grml_flavour, options.bootoptions)) syslinux_config_file.close() else: syslinux_config_file = open(syslinux_cfg, 'w') - syslinux_config_file.write(generate_main_syslinux_config(grml_flavour, "")) # FIXME - bootoptions + syslinux_config_file.write(generate_main_syslinux_config(grml_flavour, options.bootoptions)) syslinux_config_file.close() + # install flavour specific configuration only *once* as well # ugly - I'm pretty sure this could be smoother... flavour_config = True if os.path.isfile(syslinux_cfg): string = open(syslinux_cfg).readlines() - flavour = re.compile("^# flavour specific configuration for %s" % re.escape(grml_flavour)) + logging.info("Notice: you can boot flavour %s using '%s' on the commandline." % (grml_flavour, grml_flavour)) + flavour = re.compile("grml2usb for %s: %s" % (re.escape(grml_flavour), re.escape(str(datestamp)))) for line in string: if flavour.match(line): flavour_config = False + if flavour_config: syslinux_config_file = open(syslinux_cfg, 'a') - syslinux_config_file.write(generate_flavour_specific_syslinux_config(grml_flavour, "")) # FIXME - bootoptions + syslinux_config_file.write(generate_flavour_specific_syslinux_config(grml_flavour, options.bootoptions)) syslinux_config_file.close( ) logging.debug("Generating isolinux/syslinux splash %s" % syslinux_target + 'boot.msg') @@ -490,7 +576,7 @@ def copy_grml_files(grml_flavour, iso_mount, target, dry_run=False): isolinux_splash.close( ) - # make sure we are sync before continuing + # make sure we sync filesystems before returning proc = subprocess.Popen(["sync"]) proc.wait() @@ -535,7 +621,9 @@ def handle_iso(iso, device): logging.critical("TODO: /live/image handling not yet implemented") # TODO else: iso_mountpoint = tempfile.mkdtemp() + register_tmpfile(iso_mountpoint) remove_iso_mountpoint = True + mount(iso, iso_mountpoint, ["-o", "loop", "-t", "iso9660"]) if os.path.isdir(device): @@ -546,26 +634,34 @@ def handle_iso(iso, device): else: device_mountpoint = tempfile.mkdtemp() + register_tmpfile(device_mountpoint) remove_device_mountpoint = True - mount(device, device_mountpoint, "") + try: + mount(device, device_mountpoint, "") + except Exception, error: + logging.critical("Fatal: %s" % error) + cleanup() try: grml_flavour = identify_grml_flavour(iso_mountpoint) logging.info("Identified grml flavour \"%s\"." % grml_flavour) copy_grml_files(grml_flavour, iso_mountpoint, device_mountpoint, dry_run=options.dryrun) except TypeError: - logging.critical("Fatal: something happend - TODO") + logging.critical("Fatal: a critical error happend during execution, giving up") sys.exit(1) finally: if os.path.isdir(iso_mountpoint) and remove_iso_mountpoint: - unmount(iso_mountpoint) + unmount(iso_mountpoint, "") + os.rmdir(iso_mountpoint) + unregister_tmpfile(iso_mountpoint) if remove_device_mountpoint: - unmount(device_mountpoint) + unmount(device_mountpoint, "") if os.path.isdir(device_mountpoint): os.rmdir(device_mountpoint) + unregister_tmpfile(device_mountpoint) # grml_flavour_short = grml_flavour.replace('-','') # logging.debug("grml_flavour_short = %s" % grml_flavour_short) @@ -581,6 +677,7 @@ def main(): if len(args) < 2: parser.error("invalid usage") + # log handling if options.verbose: FORMAT = "%(asctime)-15s %(message)s" logging.basicConfig(level=logging.DEBUG, format=FORMAT) @@ -596,6 +693,7 @@ def main(): else: check_uid_root() + # specified arguments device = args[len(args) - 1] isos = args[0:len(args) - 1] @@ -611,21 +709,36 @@ def main(): else: sys.exit(1) - if not which("syslinux"): + # make sure we have syslinux available + if not which("syslinux") and not options.copyonly: logging.critical('Sorry, syslinux not available. Exiting.') logging.critical('Please install syslinux or consider using the --grub option.') sys.exit(1) - # TODO - # * check for valid blockdevice, vfat and mount functions - # if device is not None: - # check_for_vat(device) + # check for vfat filesystem + if device is not None and not os.path.isdir(device): + try: + check_for_fat(device) + except Exception, error: + logging.critical("Execution failed: %s", error) + sys.exit(1) + + if not check_for_usbdevice(device): + print "Warning: the specified device %s does not look like a removable usb device." % device + f = raw_input("Do you really want to continue? y/N ") + if f == "y" or f == "Y": + pass + else: + sys.exit(1) + # main operation (like installing files) for iso in isos: handle_iso(iso, device) - if options.mbr and not skip_mbr: - + # install MBR + if not options.mbr or skip_mbr: + logging.info("You are not using the --mbr option. Consider using it to get a working USB setup.") + else: # make sure we install MBR on /dev/sdX and not /dev/sdX# if device[-1:].isdigit(): mbr_device = re.match(r'(.*?)\d*$', device).group(1) @@ -633,24 +746,27 @@ def main(): try: install_mbr(mbr_device, dry_run=options.dryrun) except IOError, error: - logging.critical("Execution failed:", error) + logging.critical("Execution failed: %s", error) sys.exit(1) except Exception, error: - logging.critical("Execution failed:", error) + logging.critical("Execution failed: %s", error) sys.exit(1) + # Install bootloader only if not using the --copy-only option if options.copyonly: logging.info("Not installing bootloader and its files as requested via option copyonly.") else: install_bootloader(device, dry_run=options.dryrun) + # finally be politely :) logging.info("Finished execution of grml2usb (%s). Have fun with your grml system." % PROG_VERSION) if __name__ == "__main__": try: main() except KeyboardInterrupt: - print "TODO / FIXME: handle me! :)" + logging.info("Received KeyboardInterrupt") + cleanup() ## END OF FILE ################################################################# # vim:foldmethod=marker expandtab ai ft=python tw=120 fileencoding=utf-8