X-Git-Url: https://git.grml.org/?p=grml2usb.git;a=blobdiff_plain;f=grml2usb.py;h=7411e48f1ab12d7ea6240aa2eb71a9b5fa32641e;hp=b4c971fc9e099240b9ba380296e1ea2cee3be494;hb=691a25a0c38dc62ba2c64c93a05a290d7ed26b57;hpb=64bbc51ac9ee052ee3c310226d84ab735f5f7fe5 diff --git a/grml2usb.py b/grml2usb.py index b4c971f..7411e48 100755 --- a/grml2usb.py +++ b/grml2usb.py @@ -1,37 +1,52 @@ #!/usr/bin/env python -# Filename: grml2usb -# Purpose: install grml system to usb device -# Authors: grml-team (grml.org), (c) Michael Prokop -# Bug-Reports: see http://grml.org/bugs/ -# License: This file is licensed under the GPL v2 or any later version. -################################################################################ - -# TODO: -# * write error messages to stderr -# * log wrapper (log important messages to syslog, depending on loglevel) -# * trap handling (umount devices when interrupting?) -# * integrate https://www.mirbsd.org/cvs.cgi/src/sys/arch/i386/stand/mbr/mbr.S?rev=HEAD;content-type=text%2Fplain -# -> gcc -D_ASM_SOURCE -D__BOOT_VER=\"GRML\" -DBOOTMANAGER -c mbr.S; ld -# -nostdlib -Ttext 0 -N -Bstatic --oformat binary mbr.o -o mbrmgr - -prog_version = "0.0.1" - -import os, re, subprocess, sys +# -*- coding: utf-8 -*- +""" +grml2usb +~~~~~~~~ + +This script installs a grml system to a USB device + +:copyright: (c) 2009 by Michael Prokop +:license: GPL v2 or any later version +:bugreports: http://grml.org/bugs/ + +TODO +---- + +* improve error handling :) +* implement mount handling +* log wrapper (-> logging module) +* implement logic for storing information about copied files + -> register every single file? +* trap handling (like unmount devices when interrupting?) +* get rid of all TODOs in code :) +* graphical version +""" + +import os, re, subprocess, sys, tempfile from optparse import OptionParser from os.path import exists, join, abspath from os import pathsep +# TODO string.split() is deprecated - replace? +# -> http://docs.python.org/library/string.html#deprecated-string-functions from string import split -# cmdline parsing {{{ +PROG_VERSION = "0.0.1" + +# cmdline parsing +# TODO +# * --copy-only? +# * --bootloader-only? usage = "Usage: %prog [options] \n\ \n\ %prog installs a grml ISO to an USB device to be able to boot from it.\n\ Make sure you have at least a grml ISO or a running grml system,\n\ syslinux (just run 'aptitude install syslinux' on Debian-based systems)\n\ and root access." -parser = OptionParser(usage=usage) -parser.add_option("--bootoptions", dest="bootoptions", action="store", type="string", +parser = OptionParser(usage=usage) +parser.add_option("--bootoptions", dest="bootoptions", + action="store", type="string", help="use specified bootoptions as defaut") parser.add_option("--dry-run", dest="dryrun", action="store_true", help="do not actually execute any commands") @@ -55,25 +70,32 @@ parser.add_option("--verbose", dest="verbose", action="store_true", help="enable verbose mode") parser.add_option("-v", "--version", dest="version", action="store_true", help="display version and exit") - (options, args) = parser.parse_args() -# }}} -# wrapper functions {{{ -# TODO: implement argument handling -def execute(command): + +def execute(f, *args): """Wrapper for executing a command. Either really executes the command (default) or when using --dry-run commandline option just displays what would be executed.""" + # demo: execute(subprocess.Popen, (["ls", "-la"])) if options.dryrun: - print "would execute %s now" % command + print "would execute %s(%s) now" % (f, args) else: - print "executing %s" % command + return f(*args) + + +def is_exe(fpath): + """Check whether a given file can be executed + + @fpath: full path to file + @return:""" + return os.path.exists(fpath) and os.access(fpath, os.X_OK) + def which(program): - def is_exe(fpath): - return os.path.exists(fpath) and os.access(fpath, os.X_OK) + """Check whether a given program is available in PATH + @program: name of executable""" fpath, fname = os.path.split(program) if fpath: if is_exe(program): @@ -86,20 +108,20 @@ def which(program): return None + def search_file(filename, search_path='/bin' + pathsep + '/usr/bin'): - """Given a search path, find file""" - file_found = 0 - paths = split(search_path, pathsep) - for path in paths: - for current_dir, directories, files in os.walk(path): - if exists(join(current_dir, filename)): - file_found = 1 - break - if file_found: - return abspath(join(current_dir, filename)) - else: - return None -# }}} + """Given a search path, find file""" + file_found = 0 + paths = split(search_path, pathsep) + for path in paths: + for current_dir, directories, files in os.walk(path): + if exists(join(current_dir, filename)): + file_found = 1 + break + if file_found: + return abspath(join(current_dir, filename)) + else: + return None def check_uid_root(): @@ -109,8 +131,86 @@ def check_uid_root(): def install_syslinux(device): + # TODO """Install syslinux on specified device.""" - print("debug: syslinux %s") % device + print("debug: syslinux %s [TODO]") % device + + # syslinux -d boot/isolinux /dev/usb-sdb1 + + +def generate_grub_config(grml_flavour): + """Generate grub configuration for use via menu,lst""" + + # TODO + # * what about system using grub2 without having grub available? + # * support grub2 + + grml_name = grml_flavour + + return("""\ +# misc options: +timeout 30 +# color red/blue green/black +splashimage=/boot/grub/splash.xpm.gz +foreground = 000000 +background = FFCC33 + +# define entries: +title %(grml_name)s - Default boot (using 1024x768 framebuffer) +kernel /boot/release/%(grml_name)s/linux26 apm=power-off lang=us vga=791 quiet boot=live nomce module=%(grml_name)s +initrd /boot/release/%(grml_name)s/initrd.gz + +# TODO: extend configuration :) +""" % locals()) + + +def generate_isolinux_splash(grml_flavour): + """Generate bootsplash for isolinux/syslinux""" + + # TODO + # * adjust last bootsplash line + + grml_name = grml_flavour + + return("""\ +17 /boot/isolinux/logo.16 + +Some information and boot options available via keys F2 - F10. http://grml.org/ +%(grml_name)s +""" % locals()) + +def generate_syslinux_config(grml_flavour): + """Generate configuration for use in syslinux.cfg""" + + # TODO + # * unify isolinux and syslinux setup ("INCLUDE /boot/...") + + grml_name = grml_flavour + + return("""\ +# use this to control the bootup via a serial port +# SERIAL 0 9600 +DEFAULT grml +TIMEOUT 300 +PROMPT 1 +DISPLAY /boot/isolinux/boot.msg +F1 /boot/isolinux/boot.msg +F2 /boot/isolinux/f2 +F3 /boot/isolinux/f3 +F4 /boot/isolinux/f4 +F5 /boot/isolinux/f5 +F6 /boot/isolinux/f6 +F7 /boot/isolinux/f7 +F8 /boot/isolinux/f8 +F9 /boot/isolinux/f9 +F10 /boot/isolinux/f10 + +LABEL grml +KERNEL /boot/release/%(grml_name)s/linux26 +APPEND initrd=/boot/release/%(grml_name)s/initrd.gz apm=power-off lang=us boot=live nomce module=%(grml_name)s + +# TODO: extend configuration :) +""" % locals()) def install_grub(device): @@ -120,7 +220,8 @@ def install_grub(device): def install_bootloader(partition): """Install bootloader on device.""" - # Install bootloader on the device (/dev/sda), not on the partition itself (/dev/sda1) + # Install bootloader on the device (/dev/sda), + # not on the partition itself (/dev/sda1) if partition[-1:].isdigit(): device = re.match(r'(.*?)\d*$', partition).group(1) else: @@ -132,18 +233,70 @@ def install_bootloader(partition): install_syslinux(device) -def install_mbr(target): - """Install a default master boot record on given target""" - print("TODO") +def is_writeable(device): + """Check if the device is writeable for the current user""" + + if not device: + return False + #raise Exception, "no device for checking write permissions" + + if not os.path.exists(device): + return False + + return os.access(device, os.W_OK) and os.access(device, os.R_OK) + +def install_mbr(device): + """Install a default master boot record on given device + + @device: device where MBR should be installed to""" + + if not is_writeable(device): + raise IOError, "device not writeable for user" + + lilo = './lilo/lilo.static' # FIXME + + if not is_exe(lilo): + raise Exception, "lilo executable not available." + + # to support -A for extended partitions: + print("debug: ./lilo/lilo.static -S /dev/null -M %s ext") % device + proc = subprocess.Popen(["./lilo/lilo.static", "-S", "/dev/null", "-M", device, "ext"]) + proc.wait() + if proc.returncode != 0: + raise Exception, "error executing lilo" + + # activate partition: + print("debug: ./lilo/lilo.static -S /dev/null -A %s 1") % device + proc = subprocess.Popen(["./lilo/lilo.static", "-S", "/dev/null", "-A", device, "1"]) + proc.wait() + if proc.returncode != 0: + raise Exception, "error executing lilo" + + # lilo's mbr is broken, use the one from syslinux instead: + print("debug: cat /usr/lib/syslinux/mbr.bin > %s") % device + try: + # TODO use Popen instead? + retcode = subprocess.call("cat /usr/lib/syslinux/mbr.bin > "+ device, shell=True) + if retcode < 0: + print >> sys.stderr, "Error copying MBR to device", -retcode + except OSError, error: + print >> sys.stderr, "Execution failed:", error def loopback_mount(iso, target): - """Loopback mount specified ISO on given target""" + """Loopback mount specified ISO on given target + + @iso: name of ISO that should be mounted + @target: directory where the ISO should be mounted to""" + print("mount -o loop %s %s") % (iso, target) def check_for_vat(partition): - """Check whether specified partition is VFAT/FAT16 filesystem""" + """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) @@ -156,53 +309,123 @@ def check_for_vat(partition): if filesystem != "vfat": return(1) - # TODO: check for ID_FS_VERSION=FAT16? + # TODO + # * check for ID_FS_VERSION=FAT16 as well? except OSError: print("Sorry, /lib/udev/vol_id not available.") return 1 +def mkdir(directory): + """Simple wrapper around os.makedirs to get shell mkdir -p behaviour""" + + if not os.path.isdir(directory): + try: + os.makedirs(directory) + except OSError: + # just silently pass as it's just fine it the directory exists + pass + + def copy_grml_files(grml_flavour, iso_mount, target): """Copy files from ISO on given target""" - # TODO: provide alternative search_file() if file information is stored in - # a config.ini file? + # TODO + # * provide alternative search_file() if file information is stored in a config.ini file? + # * catch "install: .. No space left on device" & CO + # * abstract copy logic to make the code shorter? + squashfs = search_file(grml_flavour + '.squashfs', iso_mount) + squashfs_target = target + '/live/' + mkdir(squashfs_target) + + # use install(1) for now to make sure we can write the files afterwards as normal user as well print("debug: copy squashfs to %s") % target + '/live/' + grml_flavour + '.squashfs' + subprocess.Popen(["install", "--mode=664", squashfs, squashfs_target + grml_flavour + ".squashfs"]) filesystem_module = search_file('filesystem.module', iso_mount) - print("debug: copy filesystem.module to %s") % target + '/live/' + grml_flavour + '.module' + print("debug: copy filesystem.module to %s") % squashfs_target + grml_flavour + '.module' + subprocess.Popen(["install", "--mode=664", filesystem_module, squashfs_target + grml_flavour + '.module']) + + release_target = target + '/boot/release/' + grml_flavour + mkdir(release_target) kernel = search_file('linux26', iso_mount) - print("debug: copy kernel to %s") % target + '/boot/release/' + grml_flavour + '/linux26' + print("debug: copy kernel to %s") % release_target + '/linux26' + subprocess.Popen(["install", "--mode=664", kernel, release_target + '/linux26']) initrd = search_file('initrd.gz', iso_mount) - print("debug: copy initrd to %s") % target + '/boot/release/' + grml_flavour + '/initrd.gz' + print("debug: copy initrd to %s") % release_target + '/initrd.gz' + subprocess.Popen(["install", "--mode=664", initrd, release_target + '/initrd.gz']) + + isolinux_target = target + '/boot/isolinux/' + mkdir(isolinux_target) logo = search_file('logo.16', iso_mount) - print("debug: copy logo.16 to %s") % target + '/boot/isolinux/' + 'logo.16' + print("debug: copy logo.16 to %s") % isolinux_target + 'logo.16' + subprocess.Popen(["install", "--mode=664", logo, isolinux_target + 'logo.16']) + + for ffile in 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10': + bootsplash = search_file(ffile, iso_mount) + print("debug: copy %s to %s") % (bootsplash, isolinux_target + ffile) + subprocess.Popen(["install", "--mode=664", bootsplash, isolinux_target + ffile]) + + grub_target = target + '/boot/grub/' + mkdir(grub_target) + + print("debug: copy grub/splash.xpm.gz to %s") % grub_target + 'splash.xpm.gz' + subprocess.Popen(["install", "--mode=664", 'grub/splash.xpm.gz', grub_target + 'splash.xpm.gz']) + + print("debug: copy grub/stage2_eltorito to %s") % grub_target + 'stage2_eltorito' + subprocess.Popen(["install", "--mode=664", 'grub/stage2_eltorito', grub_target + 'stage2_eltorito']) - for file in 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10': - bootsplash = search_file(file, iso_mount) - print("debug: copy %s to %s") % (bootsplash, target + '/boot/isolinux/' + file) + print("debug: generating grub configuration %s") % grub_target + 'menu.lst' + grub_config_file = open(grub_target + 'menu.lst', 'w') + grub_config_file.write(generate_grub_config(grml_flavour)) + grub_config_file.close( ) + + syslinux_target = target + '/boot/isolinux/' + mkdir(syslinux_target) + + print("debug: generating syslinux configuration %s") % syslinux_target + 'syslinux.cfg' + syslinux_config_file = open(syslinux_target + 'syslinux.cfg', 'w') + syslinux_config_file.write(generate_syslinux_config(grml_flavour)) + syslinux_config_file.close( ) + + print("debug: generating isolinux/syslinux splash %s") % syslinux_target + 'boot.msg' + isolinux_splash = open(syslinux_target + 'boot.msg', 'w') + isolinux_splash.write(generate_isolinux_splash(grml_flavour)) + isolinux_splash.close( ) def uninstall_files(device): - print("TODO") + """Get rid of all grml files on specified device""" + + # TODO + print("TODO: %s") % device def identify_grml_flavour(mountpath): + """Get name of grml flavour + + @mountpath: path where the grml ISO is mounted to + @return: name of grml-flavour""" + version_file = search_file('grml-version', mountpath) - file = open(version_file, 'r') - grml_info = file.readline() - file.close + + tmpfile = open(version_file, 'r') + grml_info = tmpfile.readline() + #tmpfile.close # pylint: Statement seems to have no effect + grml_flavour = re.match(r'[\w-]*', grml_info).group() return grml_flavour def main(): + """Main function [make pylint happy :)]""" + if options.version: - print("%s %s")% (os.path.basename(sys.argv[0]), prog_version) + print("%s %s")% (os.path.basename(sys.argv[0]), PROG_VERSION) sys.exit(0) if len(args) < 2: @@ -214,24 +437,30 @@ def main(): isos = args[0:len(args) - 1] if not which("syslinux"): - print("Sorry, syslinux not available. Exiting.") - print("Please install syslinux or consider using the --grub option.") + print >> sys.stderr, 'Sorry, syslinux not available. Exiting.' + print >> sys.stderr, 'Please install syslinux or consider using the --grub option.' sys.exit(1) - # TODO check for valid blockdevice, vfat and mount functions + # TODO + # * check for valid blockdevice, vfat and mount functions # if device is not None: # check_for_vat(device) # mount_target(partition) - target = '/mnt/target' + # TODO + # target = '/mnt/usb-sdb1' + target = tempfile.mkdtemp() + print("debug: target = %s") % target - # TODO it doesn't need to be a ISO, could be /live/image as well + # TODO + # * it doesn't need to be a ISO, could be /live/image as well for iso in isos: print("debug: iso = %s") % iso # loopback_mount(iso) + iso_mount = '/mnt/test' # FIXME + loopback_mount(iso, target) # FIXME s/target/iso_mount/ # copy_grml_files(iso, target) # loopback_unmount(iso) - iso_mount = '/mnt/test' # FIXME grml_flavour = identify_grml_flavour(iso_mount) print("debug: grml_flavour = %s") % grml_flavour @@ -239,15 +468,30 @@ def main(): grml_flavour_short = grml_flavour.replace('-','') print("debug: grml_flavour_short = %s") % grml_flavour_short - copy_grml_files(grml_flavour, iso_mount, target) + # TODO - re-enable :) + # copy_grml_files(grml_flavour, iso_mount, target) if options.mbr: - print("debug: would install MBR now") + # make sure we install MBR on /dev/sdX and not /dev/sdX# + if device[-1:].isdigit(): + device = re.match(r'(.*?)\d*$', device).group(1) + + try: + install_mbr(device) + except IOError, error: + print >> sys.stderr, "Execution failed:", error + sys.exit(1) + except Exception, error: + print >> sys.stderr, "Execution failed:", error + sys.exit(1) install_bootloader(device) + if os.path.isdir(target): + os.rmdir(target) + if __name__ == "__main__": main() ## END OF FILE ################################################################# -# vim:foldmethod=marker expandtab ai ft=python tw=120 +# vim:foldmethod=marker expandtab ai ft=python tw=120 fileencoding=utf-8