#!/usr/bin/env python
# Filename: grml2usb
-# Purpose: install grml-system to usb-device
+# Purpose: install grml system to usb device
# Authors: grml-team (grml.org), (c) Michael Prokop <mika@grml.org>
# Bug-Reports: see http://grml.org/bugs/
# License: This file is licensed under the GPL v2 or any later version.
################################################################################
+# TODO
+# * strongly improve error handling :)
+# * implement mount handling
+# * write error messages to stderr
+# * log wrapper (log important messages to syslog, depending on loglevel -> logging module)
+# * trap handling (umount devices when interrupting?)
+# * provide progress bar?
+# * graphical version?
+# * 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, sys
+import os, re, subprocess, sys
from optparse import OptionParser
+from os.path import exists, join, abspath
+from os import pathsep
+from string import split
# cmdline parsing {{{
-usage = "usage: %prog [options] arg1 arg2"
+usage = "Usage: %prog [options] <ISO[s]> <partition>\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)
+# TODO
+# * --copy-only?
+# * --bootloader-only?
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="install master boot record (MBR) on the device")
parser.add_option("--squashfs", dest="squashfs", action="store", type="string",
help="install specified squashfs file instead of the default")
+parser.add_option("--uninstall", dest="uninstall", action="store_true",
+ help="remove grml ISO files")
parser.add_option("--verbose", dest="verbose", action="store_true",
help="enable verbose mode")
parser.add_option("-v", "--version", dest="version", action="store_true",
(options, args) = parser.parse_args()
# }}}
-# FIXME: implement argument handling
+# wrapper functions {{{
+# TODO
+# * implement argument handling
def execute(command):
"""Wrapper for executing a command. Either really executes
the command (default) or when using --dry-run commandline option
if options.dryrun:
print "would execute %s now" % command
else:
+ # TODO
+ # * actual execution ;)
+ # * wrap subprocess.Popen()?
print "executing %s" % command
+def is_exe(fpath):
+ return os.path.exists(fpath) and os.access(fpath, os.X_OK)
+
+
+def which(program):
+ fpath, fname = os.path.split(program)
+ if fpath:
+ if is_exe(program):
+ return program
+ else:
+ for path in os.environ["PATH"].split(os.pathsep):
+ exe_file = os.path.join(path, program)
+ if is_exe(exe_file):
+ return exe_file
+
+ 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
+# }}}
+
+
+def check_uid_root():
+ """Check for root permissions"""
+ if not os.geteuid()==0:
+ sys.exit("Error: please run this script with uid 0 (root).")
+
+
def install_syslinux(device):
+ # TODO
"""Install syslinux on specified device."""
- print("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("""\
+\ f17\f\18/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):
"""Install grub on specified device."""
print("grub-install %s") % device
-def install_bootloader(device):
- """Install bootloader on specified device."""
+
+def install_bootloader(partition):
+ """Install bootloader on device."""
+ # 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:
+ device = partition
+
if options.grub:
install_grub(device)
else:
install_syslinux(device)
-def check_uid_root():
- """Check for root permissions"""
- if not os.geteuid()==0:
- sys.exit("Error: please run this script with uid 0 (root).")
+
+def isWriteable(device):
+ """Check if the device is writeable for the current user"""
+
+ if not device:
+ raise "WrongArguments", "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 isWriteable(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
+ subprocess.Popen(["./lilo/lilo.static", "-S", "/dev/null", "-M", device, "ext"])
+
+ # activate partition:
+ print("debug: ./lilo/lilo.static -S /dev/null -A %s 1") % device
+ subprocess.Popen(["./lilo/lilo.static", "-S", "/dev/null", "-A", device, "1"])
+
+ # lilo's mbr is broken, use the one from syslinux instead:
+ print("debug: cat /usr/lib/syslinux/mbr.bin > %s") % device
+ try:
+ # FIXME: 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, e:
+ print >>sys.stderr, "Execution failed:", e
+
+
+def loopback_mount(iso, target):
+ """Loopback mount specified ISO on given target"""
+
+ print("mount -o loop %s %s") % (iso, target)
+
+
+def check_for_vat(partition):
+ """Check whether specified partition is VFAT/FAT16 filesystem"""
+
+ try:
+ 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:
+ print("failed to read device %s - wrong UID / permissions?") % partition
+ return 1
+
+ if filesystem != "vfat":
+ return(1)
+
+ # 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:
+ 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?
+ # * 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") % 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") % 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") % 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") % isolinux_target + 'logo.16'
+ subprocess.Popen(["install", "--mode=664", logo, isolinux_target + 'logo.16'])
+
+ 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, isolinux_target + file)
+ subprocess.Popen(["install", "--mode=664", bootsplash, isolinux_target + file])
+
+ 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'])
+
+ 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):
+ """Get rid of all grml files on specified device"""
+
+ # TODO
+ print("TODO")
+
+
+def identify_grml_flavour(mountpath):
+ """Get name of grml flavour"""
+
+ version_file = search_file('grml-version', mountpath)
+ file = open(version_file, 'r')
+ grml_info = file.readline()
+ file.close
+ grml_flavour = re.match(r'[\w-]*', grml_info).group()
+ return grml_flavour
+
def main():
+
if options.version:
print("%s %s")% (os.path.basename(sys.argv[0]), prog_version)
sys.exit(0)
device = args[len(args) - 1]
isos = args[0:len(args) - 1]
- # FIXME: check for valid blockdevice
- if device is not None:
- install_bootloader(device)
+ if not which("syslinux"):
+ 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
+ # if device is not None:
+ # check_for_vat(device)
+ # mount_target(partition)
+
+ # FIXME
+ target = '/mnt/usb-sdb1'
+ # TODO
+ # * it doesn't need to be a ISO, could be /live/image as well
for iso in isos:
- print("iso = %s") % iso
+ print("debug: iso = %s") % iso
+ # loopback_mount(iso)
+ # 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
+
+ grml_flavour_short = grml_flavour.replace('-','')
+ print("debug: grml_flavour_short = %s") % grml_flavour_short
+
+ # copy_grml_files(grml_flavour, iso_mount, target)
+
+ if options.mbr:
+ # 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, e:
+ print >>sys.stderr, "Execution failed:", e
+ sys.exit(1)
+ except Exception, e:
+ print >>sys.stderr, "Execution failed:", e
+ sys.exit(1)
+
+ install_bootloader(device)
if __name__ == "__main__":
main()
## END OF FILE #################################################################
-# vim:foldmethod=marker expandtab ai ft=python
+# vim:foldmethod=marker expandtab ai ft=python tw=120
projects / grml2usb.git / blobdiff