2 # -*- coding: utf-8 -*-
7 This script installs a grml system (either a running system or ISO[s]) to a USB device
9 :copyright: (c) 2009 by Michael Prokop <mika@grml.org>
10 :license: GPL v2 or any later version
11 :bugreports: http://grml.org/bugs/
15 # from __future__ import with_statement
16 from optparse import OptionParser
17 from inspect import isroutine, isclass
18 import datetime, logging, os, re, subprocess, sys, tempfile, time, os.path
21 PROG_VERSION = "0.9.13-pre1"
22 MOUNTED = set() # register mountpoints
23 TMPFILES = set() # register tmpfiles
24 DATESTAMP = time.mktime(datetime.datetime.now().timetuple()) # unique identifier for syslinux.cfg
25 GRML_FLAVOURS = set() # which flavours are being installed?
29 USAGE = "Usage: %prog [options] <[ISO[s] | /live/image]> </dev/sdX#>\n\
31 %prog installs grml ISO[s] to an USB device to be able to boot from it.\n\
32 Make sure you have at least one grml ISO or a running grml system (/live/image),\n\
33 grub or syslinux and root access.\n\
35 Run %prog --help for usage hints, further information via: man grml2usb"
37 # pylint: disable-msg=C0103
38 parser = OptionParser(usage=USAGE)
39 parser.add_option("--bootoptions", dest="bootoptions",
40 action="store", type="string",
41 help="use specified bootoptions as default")
42 parser.add_option("--bootloader-only", dest="bootloaderonly", action="store_true",
43 help="do not copy files but just install a bootloader")
44 parser.add_option("--copy-only", dest="copyonly", action="store_true",
45 help="copy files only but do not install bootloader")
46 parser.add_option("--dry-run", dest="dryrun", action="store_true",
47 help="avoid executing commands")
48 parser.add_option("--fat16", dest="fat16", action="store_true",
49 help="format specified partition with FAT16")
50 parser.add_option("--force", dest="force", action="store_true",
51 help="force any actions requiring manual interaction")
52 parser.add_option("--grub-mbr", dest="grubmbr", action="store_true",
53 help="install grub into MBR instead of (default) PBR")
54 parser.add_option("--lilo-binary", dest="lilobin", action="store", type="string",
55 help="lilo executable to be used for installing MBR")
56 parser.add_option("--mbr-menu", dest="mbrmenu", action="store_true",
57 help="enable interactive boot menu in MBR")
58 parser.add_option("--quiet", dest="quiet", action="store_true",
59 help="do not output anything but just errors on console")
60 parser.add_option("--skip-addons", dest="skipaddons", action="store_true",
61 help="do not install /boot/addons/ files")
62 parser.add_option("--skip-grub-config", dest="skipgrubconfig", action="store_true",
63 help="skip generation of grub configuration files")
64 parser.add_option("--skip-mbr", dest="skipmbr", action="store_true",
65 help="do not install a master boot record (MBR) on the device")
66 parser.add_option("--skip-syslinux-config", dest="skipsyslinuxconfig", action="store_true",
67 help="skip generation of syslinux configuration files")
68 parser.add_option("--syslinux", dest="syslinux", action="store_true",
69 help="install syslinux bootloader instead of grub")
70 parser.add_option("--syslinux-mbr", dest="syslinuxmbr", action="store_true",
71 help="install syslinux master boot record (MBR) instead of default")
72 parser.add_option("--verbose", dest="verbose", action="store_true",
73 help="enable verbose mode")
74 parser.add_option("-v", "--version", dest="version", action="store_true",
75 help="display version and exit")
76 (options, args) = parser.parse_args()
79 GRML2USB_BASE = '/usr/share/grml2usb'
80 if not os.path.isdir(GRML2USB_BASE):
81 GRML2USB_BASE = os.path.dirname(os.path.realpath(__file__))
84 class CriticalException(Exception):
85 """Throw critical exception if the exact error is not known but fatal."
87 @Exception: message"""
92 """Cleanup function to make sure there aren't any mounted devices left behind.
95 logging.info("Cleaning up before exiting...")
96 proc = subprocess.Popen(["sync"])
100 for device in MOUNTED:
102 # ignore: RuntimeError: Set changed size during iteration
104 logging.debug('caught expection RuntimeError, ignoring')
107 def register_tmpfile(path):
109 TODO - not implemented yet
115 def unregister_tmpfile(path):
117 TODO - not implemented yet
121 TMPFILES.remove(path)
124 def register_mountpoint(target):
125 """register specified target in a set() for handling clean exiting
127 @target: destination target of mountpoint
133 def unregister_mountpoint(target):
134 """unregister specified target in a set() for handling clean exiting
136 @target: destination target of mountpoint
139 if target in MOUNTED:
140 MOUNTED.remove(target)
143 def get_function_name(obj):
144 """Helper function for use in execute() to retrive name of a function
146 @obj: the function object
148 if not (isroutine(obj) or isclass(obj)):
150 return obj.__module__ + '.' + obj.__name__
153 def execute(f, *exec_arguments):
154 """Wrapper for executing a command. Either really executes
155 the command (default) or when using --dry-run commandline option
156 just displays what would be executed."""
157 # usage: execute(subprocess.Popen, (["ls", "-la"]))
158 # TODO: doesn't work for proc = execute(subprocess.Popen...() -> any ideas?
160 # pylint: disable-msg=W0141
161 logging.debug('dry-run only: %s(%s)', get_function_name(f), ', '.join(map(repr, exec_arguments)))
163 # pylint: disable-msg=W0142
164 return f(*exec_arguments)
168 """Check whether a given file can be executed
170 @fpath: full path to file
172 return os.path.exists(fpath) and os.access(fpath, os.X_OK)
176 """Check whether a given program is available in PATH
178 @program: name of executable"""
179 fpath = os.path.split(program)[0]
184 for path in os.environ["PATH"].split(os.pathsep):
185 exe_file = os.path.join(path, program)
192 def search_file(filename, search_path='/bin' + os.pathsep + '/usr/bin'):
193 """Given a search path, find file
195 @filename: name of file to search for
196 @search_path: path where searching for the specified filename"""
198 paths = search_path.split(os.pathsep)
199 current_dir = '' # make pylint happy :)
201 # pylint: disable-msg=W0612
202 for current_dir, directories, files in os.walk(path):
203 if os.path.exists(os.path.join(current_dir, filename)):
207 return os.path.abspath(os.path.join(current_dir, filename))
212 def check_uid_root():
213 """Check for root permissions"""
214 if not os.geteuid()==0:
215 sys.exit("Error: please run this script with uid 0 (root).")
218 def mkfs_fat16(device):
219 """Format specified device with VFAT/FAT16 filesystem.
221 @device: partition that should be formated"""
224 logging.info("Would execute mkfs.vfat -F 16 %s now.", device)
227 logging.info("Formating partition with fat16 filesystem")
228 logging.debug("mkfs.vfat -F 16 %s", device)
229 proc = subprocess.Popen(["mkfs.vfat", "-F", "16", device])
231 if proc.returncode != 0:
232 raise CriticalException("error executing mkfs.vfat")
235 def generate_main_grub2_config(grml_flavour, bootoptions):
236 """Generate grub2 configuration for use via grub.cfg
238 @grml_flavour: name of grml flavour the configuration should be generated for
239 @bootoptions: additional bootoptions that should be used by default"""
241 local_datestamp = DATESTAMP
244 ## main grub2 configuration - generated by grml2usb [main config generated at: %(local_datestamp)s]
250 if loadfont /boot/grub/ascii.pf2 ; then
255 if terminal_output.gfxterm ; then true ; else
256 # For backward compatibility with versions of terminal.mod that don't
257 # understand terminal_output
262 if background_image /boot/grub/grml.png ; then
263 set color_normal=black/black
264 set color_highlight=red/black
266 set menu_color_normal=white/black
267 set menu_color_highlight=black/yellow
270 menuentry "%(grml_flavour)s (default)" {
271 set gfxpayload=1024x768x16,1024x768
272 linux /boot/release/%(grml_flavour)s/linux26 apm=power-off quiet boot=live nomce live-media-path=/live/%(grml_flavour)s/ %(bootoptions)s
273 initrd /boot/release/%(grml_flavour)s/initrd.gz
276 menuentry "Memory test (memtest86+)" {
277 linux16 /boot/addons/memtest
280 menuentry "Boot Grub (all in one image)" {
281 linux /boot/addons/memdisk
282 initrd /boot/addons/allinone.img
285 menuentry "Boot FreeDOS" {
286 linux /boot/addons/memdisk
287 initrd /boot/addons/balder10.imz
290 menuentry "Boot MirOS bsd4grml" {
291 multiboot /boot/addons/bsd4grml/ldbsd.com
292 module /boot/addons/bsd4grml/bsd.rd
293 module /boot/addons/bsd4grml/boot.1
294 module /boot/addons/bsd4grml/boot.2
295 module /boot/addons/bsd4grml/boot.3
296 module /boot/addons/bsd4grml/boot.4
297 module /boot/addons/bsd4grml/boot.5
298 module /boot/addons/bsd4grml/boot.6
299 module /boot/addons/bsd4grml/boot.cfg
302 menuentry "Boot OS of first partition on first disk" {
307 """ % {'grml_flavour': grml_flavour, 'local_datestamp': local_datestamp,
308 'bootoptions': bootoptions } )
311 def generate_flavour_specific_grub2_config(grml_flavour, bootoptions):
312 """Generate grub2 configuration for use via grub.cfg
314 @grml_flavour: name of grml flavour the configuration should be generated for
315 @bootoptions: additional bootoptions that should be used by default"""
317 local_datestamp = DATESTAMP
320 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
321 menuentry "%(grml_flavour)s - boot in default mode" {
322 set gfxpayload=1024x768x16,1024x768
323 linux /boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ %(bootoptions)s
324 initrd /boot/release/%(grml_flavour)s/initrd.gz
327 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
328 menuentry "%(grml_flavour)s-persistent - enable persistency feature" {
329 set gfxpayload=1024x768x16,1024x768
330 linux /boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce quiet persistent live-media-path=/live/%(grml_flavour)s/ %(bootoptions)s
331 initrd /boot/release/%(grml_flavour)s/initrd.gz
334 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
335 menuentry "%(grml_flavour)s2ram - copy compressed grml file to RAM" {
336 set gfxpayload=1024x768x16,1024x768
337 linux /boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ toram=%(grml_flavour)s.squashfs %(bootoptions)s
338 initrd /boot/release/%(grml_flavour)s/initrd.gz
341 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
342 menuentry "%(grml_flavour)s-debug - enable debugging options" {
343 set gfxpayload=1024x768x16,1024x768
344 linux /boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ debug boot=live initcall_debug%(bootoptions)s
345 initrd /boot/release/%(grml_flavour)s/initrd.gz
348 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
349 menuentry "%(grml_flavour)s-x - start X Window System" {
350 set gfxpayload=1024x768x16,1024x768
351 linux /boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ startx=wm-ng %(bootoptions)s
352 initrd /boot/release/%(grml_flavour)s/initrd.gz
355 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
356 menuentry "%(grml_flavour)s-nofb - disable framebuffer" {
357 linux /boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ vga=normal video=ofonly %(bootoptions)s
358 initrd /boot/release/%(grml_flavour)s/initrd.gz
361 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
362 menuentry "%(grml_flavour)s-failsafe - disable hardware detection" {
363 linux /boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ vga=normal boot=live noautoconfig atapicd noapic noacpi acpi=off nomodules nofirewire noudev nousb nohotplug noapm nopcmcia nosmp maxcpus=0 noscsi noagp nodma ide=nodma noswap nofstab nosound nogpm nosyslog nodhcp nocpu nodisc nomodem xmodule=vesa noraid nolvm noresume selinux=0 edd=off pci=nomsi %(bootoptions)s
364 initrd /boot/release/%(grml_flavour)s/initrd.gz
367 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
368 menuentry "%(grml_flavour)s-forensic - do not touch harddisks during hw recognition" {
369 set gfxpayload=1024x768x16,1024x768
370 linux /boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ nofstab noraid nolvm noautoconfig noswap raid=noautodetect forensic readonly %(bootoptions)s
371 initrd /boot/release/%(grml_flavour)s/initrd.gz
374 """ % {'grml_flavour': grml_flavour, 'local_datestamp': local_datestamp,
375 'bootoptions': bootoptions } )
378 def generate_flavour_specific_grub1_config(grml_flavour, install_partition, bootoptions):
379 """Generate grub1 configuration for use via menu.lst
381 @grml_flavour: name of grml flavour the configuration should be generated for
382 @install_partition: partition number for use in (hd0,X)
383 @bootoptions: additional bootoptions that should be used by default"""
385 local_datestamp = DATESTAMP
388 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
389 title %(grml_flavour)s
390 kernel (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ %(bootoptions)s
391 initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
393 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
394 title %(grml_flavour)s-persistent
395 kernel (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce vga=791 quiet persistent live-media-path=/live/%(grml_flavour)s/ %(bootoptions)s
396 initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
398 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
399 title %(grml_flavour)s2ram
400 kernel (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ toram=%(grml_flavour)s.squashfs %(bootoptions)s
401 initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
403 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
404 title %(grml_flavour)s-debug
405 kernel (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ debug boot=live initcall_debug%(bootoptions)s
406 initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
408 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
409 title %(grml_flavour)s-x
410 kernel (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ startx=wm-ng %(bootoptions)s
411 initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
413 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
414 title %(grml_flavour)s-nofb
415 kernel (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ vga=normal video=ofonly %(bootoptions)s
416 initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
418 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
419 title %(grml_flavour)s-failsafe
420 kernel (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ vga=normal boot=live noautoconfig atapicd noapic noacpi acpi=off nomodules nofirewire noudev nousb nohotplug noapm nopcmcia nosmp maxcpus=0 noscsi noagp nodma ide=nodma noswap nofstab nosound nogpm nosyslog nodhcp nocpu nodisc nomodem xmodule=vesa noraid nolvm noresume selinux=0 edd=off pci=nomsi %(bootoptions)s
421 initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
423 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
424 title %(grml_flavour)s-forensic
425 kernel (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ nofstab noraid nolvm noautoconfig noswap raid=noautodetect forensic readonly %(bootoptions)s
426 initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
428 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
429 title %(grml_flavour)s-serial
430 kernel (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ vga=normal video=vesafb:off console=tty1 console=ttyS0,9600n8 %(bootoptions)s
431 initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
433 """ % {'grml_flavour': grml_flavour, 'local_datestamp': local_datestamp,
434 'bootoptions': bootoptions, 'install_partition': install_partition } )
437 def generate_main_grub1_config(grml_flavour, install_partition, bootoptions):
438 """Generate grub1 configuration for use via menu.lst
440 @grml_flavour: name of grml flavour the configuration should be generated for"""
442 local_datestamp = DATESTAMP
445 ## main grub1 configuration - generated by grml2usb [main config generated at: %(local_datestamp)s]
448 # color red/blue green/black
449 splashimage=(hd0,%(install_partition)s)/boot/grub/splash.xpm.gz
454 title %(grml_flavour)s - Default boot (using 1024x768 framebuffer)
455 kernel (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/linux26 apm=power-off vga=791 quiet boot=live nomce live-media-path=/live/%(grml_flavour)s/ %(bootoptions)s
456 initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
458 title Memory test (memtest86+)
459 kernel (hd0,%(install_partition)s)/boot/addons/memtest
461 title Grub - all in one image
462 kernel (hd0,%(install_partition)s)/boot/addons/memdisk
463 initrd (hd0,%(install_partition)s)/boot/addons/allinone.img
466 kernel (hd0,%(install_partition)s)/boot/addons/memdisk
467 initrd (hd0,%(install_partition)s)/boot/addons/balder10.imz
470 kernel (hd0,%(install_partition)s)/boot/addons/bsd4grml/ldbsd.com
472 """ % {'grml_flavour': grml_flavour, 'local_datestamp': local_datestamp,
473 'bootoptions': bootoptions, 'install_partition': install_partition } )
476 def generate_isolinux_splash(grml_flavour):
477 """Generate bootsplash for isolinux/syslinux
479 @grml_flavour: name of grml flavour the configuration should be generated for"""
481 # TODO: adjust last bootsplash line (the one following the "Some information and boot ...")
483 grml_name = grml_flavour
486 \ f17
\f\18/boot/syslinux/logo.16
488 Some information and boot options available via keys F2 - F10. http://grml.org/
490 """ % {'grml_name': grml_name} )
493 def generate_main_syslinux_config(*args):
494 """Generate main configuration for use in syslinux.cfg
496 @*args: just for backward compatibility"""
498 local_datestamp = DATESTAMP
502 menu label Default boot modes:
511 menu label Additional boot entries for:
513 include additional.cfg
520 def generate_flavour_specific_syslinux_config(grml_flavour):
521 """Generate flavour specific configuration for use in syslinux.cfg
523 @grml_flavour: name of grml flavour the configuration should be generated for"""
527 menu begin grml %(grml_flavour)s
528 menu title %(grml_flavour)s
530 menu label ^Back to main menu...
533 # include config for boot parameters from disk
534 include %(grml_flavour)s-grml.cfg
537 """ % {'grml_flavour': grml_flavour } )
540 def install_grub(device):
541 """Install grub on specified device.
543 @mntpoint: mountpoint of device where grub should install its files to
544 @device: partition where grub should be installed to"""
547 logging.info("Would execute grub-install [--root-directory=mount_point] %s now.", device)
549 device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
550 register_tmpfile(device_mountpoint)
553 mount(device, device_mountpoint, "")
555 # If using --grub-mbr then make sure we install grub in MBR instead of PBR
556 # Thanks to grub2. NOT.
558 logging.debug("Using option --grub-mbr ...")
559 if device[-1:].isdigit():
560 grub_device = re.match(r'(.*?)\d*$', device).group(1)
566 logging.debug("grub-install --recheck --no-floppy --root-directory=%s %s",
567 device_mountpoint, grub_device)
568 proc = subprocess.Popen(["grub-install", "--recheck", "--no-floppy",
569 "--root-directory=%s" % device_mountpoint, grub_device], stdout=file(os.devnull, "r+"))
571 if proc.returncode != 0:
572 # raise Exception("error executing grub-install")
573 logging.critical("Fatal: error executing grub-install (please check the grml2usb FAQ or use --syslinux)")
574 logging.critical("Note: if using grub2 consider using the --grub-mbr option because grub2's PBR feature is broken.")
577 except CriticalException, error:
578 logging.critical("Fatal: %s", error)
583 unmount(device_mountpoint, "")
584 os.rmdir(device_mountpoint)
585 unregister_tmpfile(device_mountpoint)
588 def install_syslinux(device):
589 """Install syslinux on specified device.
591 @device: partition where syslinux should be installed to"""
594 logging.info("Would install syslinux as bootloader on %s", device)
597 # syslinux -d boot/isolinux /dev/sdb1
598 logging.info("Installing syslinux as bootloader")
599 logging.debug("syslinux -d boot/syslinux %s", device)
600 proc = subprocess.Popen(["syslinux", "-d", "boot/syslinux", device])
602 if proc.returncode != 0:
603 raise CriticalException("Error executing syslinux (either try --fat16 or use grub?)")
606 def install_bootloader(device):
607 """Install bootloader on specified device.
609 @device: partition where bootloader should be installed to"""
611 # by default we use grub, so install syslinux only on request
614 install_syslinux(device)
615 except CriticalException, error:
616 logging.critical("Fatal: %s", error)
620 if not which("grub-install"):
621 logging.critical("Fatal: grub-install not available (please install the grub package or use the --syslinux option)")
627 except CriticalException, error:
628 logging.critical("Fatal: %s", error)
633 def execute_lilo(lilo, device):
634 """execute lilo for activating the partitions in the MBR
636 @lilo: path of lilo executable
637 @device: device where lilo should be executed on"""
639 # to support -A for extended partitions:
640 logging.info("Activating partitions in MBR via lilo")
641 logging.debug("%s -S /dev/null -M %s ext", lilo, device)
642 proc = subprocess.Popen([lilo, "-S", "/dev/null", "-M", device, "ext"])
644 if proc.returncode != 0:
645 raise Exception("error executing lilo")
647 # activate partition:
648 logging.debug("%s -S /dev/null -A %s 1", lilo, device)
649 proc = subprocess.Popen([lilo, "-S", "/dev/null", "-A", device, "1"])
651 if proc.returncode != 0:
652 raise Exception("error executing lilo")
655 def install_syslinux_mbr(device):
656 """install syslinux's master boot record (MBR) on the specified device
658 @device: device where MBR of syslinux should be installed to"""
660 # make sure we have syslinux available
661 if not which("syslinux") and not options.copyonly:
662 raise Exception("syslinux not available (either install it or consider dropping the --syslinux option)")
664 # lilo's mbr is broken, use the one from syslinux instead:
665 if not os.path.isfile("/usr/lib/syslinux/mbr.bin"):
666 raise Exception("/usr/lib/syslinux/mbr.bin can not be read")
668 logging.info("Installing syslinux MBR")
669 logging.debug("cat /usr/lib/syslinux/mbr.bin > %s", device)
671 # TODO -> use Popen instead?
672 retcode = subprocess.call("cat /usr/lib/syslinux/mbr.bin > "+ device, shell=True)
674 logging.critical("Error copying MBR to device (%s)", retcode)
675 except OSError, error:
676 logging.critical("Execution failed: %s", error)
679 def install_mir_mbr(mbrtemplate, device, partition, ismirbsdmbr=True):
680 """install 'mbr' master boot record (MBR) on a device
682 Retrieve the partition table from "device", install an MBR from the
683 "mbrtemplate" file, set the "partition" (0..3) active, and install the
684 result back to "device".
686 @mbrtemplate: default MBR file
688 @device: name of a file assumed to be a hard disc (or USB stick) image, or
689 something like "/dev/sdb"
691 @partition: must be a number between 0 and 3, inclusive
693 @mbrtemplate: must be a valid MBR file of at least 440 (or 439 if
696 @ismirbsdmbr: if true then ignore the active flag, set the mirbsdmbr
697 specific flag to 0/1/2/3 and set the MBR's default value accordingly. If
698 false then leave the mirbsdmbr specific flag set to FFh, set all
699 active flags to 0 and set the active flag of the partition to 80h. Note:
700 behaviour of mirbsdmbr: if flag = 0/1/2/3 then use it, otherwise search for
703 logging.info("Installing default MBR")
705 if not os.path.isfile(mbrtemplate):
706 logging.critical("Error: %s can not be read.", mbrtemplate)
707 raise CriticalException("Error installing MBR (either try --syslinux-mbr or install missing file?)")
709 if (partition < 0) or (partition > 3):
710 raise ValueError("partition must be between 0 and 3")
717 tmpf = tempfile.NamedTemporaryFile()
719 logging.debug("executing: dd if='%s' of='%s' bs=512 count=1", device, tmpf.name)
720 proc = subprocess.Popen(["dd", "if=%s" % device, "of=%s" % tmpf.name, "bs=512", "count=1"], stderr=file(os.devnull, "r+"))
722 if proc.returncode != 0:
723 raise Exception("error executing dd (first run)")
725 logging.debug("executing: dd if=%s of=%s bs=%s count=1 conv=notrunc", mbrtemplate,
726 tmpf.name, nmbrbytes)
727 proc = subprocess.Popen(["dd", "if=%s" % mbrtemplate, "of=%s" % tmpf.name, "bs=%s" % nmbrbytes,
728 "count=1", "conv=notrunc"], stderr=file(os.devnull, "r+"))
730 if proc.returncode != 0:
731 raise Exception("error executing dd (second run)")
733 mbrcode = tmpf.file.read(512)
734 if len(mbrcode) < 512:
735 raise EOFError("MBR size (%d) < 512" % len(mbrcode))
738 mbrcode = mbrcode[0:439] + chr(partition) + \
739 mbrcode[440:510] + "\x55\xAA"
741 actives = ["\x00", "\x00", "\x00", "\x00"]
742 actives[partition] = "\x80"
743 mbrcode = mbrcode[0:446] + actives[0] + \
744 mbrcode[447:462] + actives[1] + \
745 mbrcode[463:478] + actives[2] + \
746 mbrcode[479:494] + actives[3] + \
747 mbrcode[495:510] + "\x55\xAA"
751 tmpf.file.write(mbrcode)
754 logging.debug("executing: dd if='%s' of='%s' bs=512 count=1 conv=notrunc", tmpf.name, device)
755 proc = subprocess.Popen(["dd", "if=%s" % tmpf.name, "of=%s" % device, "bs=512", "count=1",
756 "conv=notrunc"], stderr=file(os.devnull, "r+"))
758 if proc.returncode != 0:
759 raise Exception("error executing dd (third run)")
763 def handle_syslinux_mbr(device):
764 """Install syslinux master boot record on given device
766 @device: device where MBR should be installed to"""
768 if not is_writeable(device):
769 raise IOError("device not writeable for user")
771 # try to use system's lilo
775 # otherwise fall back to our static version
776 from platform import architecture
777 if architecture()[0] == '64bit':
778 lilo = GRML2USB_BASE + '/lilo/lilo.static.amd64'
780 lilo = GRML2USB_BASE + '/lilo/lilo.static.i386'
781 # finally prefer a specified lilo executable
783 lilo = options.lilobin
786 raise Exception("lilo executable can not be execute")
789 logging.info("Would install MBR running lilo and using syslinux.")
792 execute_lilo(lilo, device)
793 install_syslinux_mbr(device)
796 def is_writeable(device):
797 """Check if the device is writeable for the current user
799 @device: partition where bootloader should be installed to"""
803 #raise Exception("no device for checking write permissions")
805 if not os.path.exists(device):
808 return os.access(device, os.W_OK) and os.access(device, os.R_OK)
811 def mount(source, target, mount_options):
812 """Mount specified source on given target
814 @source: name of device/ISO that should be mounted
815 @target: directory where the ISO should be mounted to
816 @options: mount specific options"""
818 # note: options.dryrun does not work here, as we have to
819 # locate files and identify the grml flavour
821 for x in file('/proc/mounts').readlines():
822 if x.startswith(source):
823 raise CriticalException("Error executing mount: %s already mounted - please unmount before invoking grml2usb" % source)
825 if os.path.isdir(source):
826 logging.debug("Source %s is not a device, therefore not mounting.", source)
829 logging.debug("mount %s %s %s", mount_options, source, target)
830 proc = subprocess.Popen(["mount"] + list(mount_options) + [source, target])
832 if proc.returncode != 0:
833 raise CriticalException("Error executing mount (no filesystem on the partition?)")
835 logging.debug("register_mountpoint(%s)", target)
836 register_mountpoint(target)
839 def unmount(target, unmount_options):
840 """Unmount specified target
842 @target: target where something is mounted on and which should be unmounted
843 @options: options for umount command"""
845 # make sure we unmount only already mounted targets
846 target_unmount = False
847 mounts = open('/proc/mounts').readlines()
848 mountstring = re.compile(".*%s.*" % re.escape(os.path.realpath(target)))
850 if re.match(mountstring, line):
851 target_unmount = True
853 if not target_unmount:
854 logging.debug("%s not mounted anymore", target)
856 logging.debug("umount %s %s", list(unmount_options), target)
857 proc = subprocess.Popen(["umount"] + list(unmount_options) + [target])
859 if proc.returncode != 0:
860 raise Exception("Error executing umount")
862 logging.debug("unregister_mountpoint(%s)", target)
863 unregister_mountpoint(target)
866 def check_for_usbdevice(device):
867 """Check whether the specified device is a removable USB device
869 @device: device name, like /dev/sda1 or /dev/sda
872 usbdevice = re.match(r'/dev/(.*?)\d*$', device).group(1)
874 usbdev = os.path.realpath('/sys/class/block/' + usbdevice + '/removable')
875 if not os.path.isfile(usbdev):
876 # Ubuntu with kernel 2.6.24 for example:
877 usbdev = os.path.realpath('/sys/block/' + usbdevice + '/removable')
879 if os.path.isfile(usbdev):
880 is_usb = open(usbdev).readline()
887 def check_for_fat(partition):
888 """Check whether specified partition is a valid VFAT/FAT16 filesystem
890 @partition: device name of partition"""
893 udev_info = subprocess.Popen(["/sbin/blkid", "-s", "TYPE", "-o", "value", partition],
894 stdout=subprocess.PIPE, stderr=subprocess.PIPE)
895 filesystem = udev_info.communicate()[0].rstrip()
897 if udev_info.returncode == 2:
898 raise CriticalException("Failed to read device %s"
899 " (wrong UID/permissions or device/directory not present?)" % partition)
901 if options.syslinux and filesystem != "vfat":
902 raise CriticalException("Partition %s does not contain a FAT16 filesystem. (Use --fat16 or run mkfs.vfat %s)" % (partition, partition))
905 raise CriticalException("Sorry, /sbin/blkid not available (install e2fsprogs?)")
908 def mkdir(directory):
909 """Simple wrapper around os.makedirs to get shell mkdir -p behaviour"""
911 # just silently pass as it's just fine it the directory exists
912 if not os.path.isdir(directory):
914 os.makedirs(directory)
915 # pylint: disable-msg=W0704
920 def exec_rsync(source, target):
921 """Simple wrapper around rsync to install files
923 @source: source file/directory
924 @target: target file/directory"""
925 logging.debug("Source: %s / Target: %s", source, target)
926 proc = subprocess.Popen(["rsync", "-rlptDH", "--inplace", source, target])
928 if proc.returncode == 12:
929 logging.critical("Fatal: No space left on device")
933 if proc.returncode != 0:
934 logging.critical("Fatal: could not install %s", source)
939 def copy_system_files(grml_flavour, iso_mount, target):
940 """copy grml's main files (like squashfs, kernel and initrd) to a given target
942 @grml_flavour: name of grml flavour the configuration should be generated for
943 @iso_mount: path where a grml ISO is mounted on
944 @target: path where grml's main files should be copied to"""
946 squashfs = search_file(grml_flavour + '.squashfs', iso_mount)
948 logging.critical("Fatal: squashfs file not found")
949 raise CriticalException("error locating squashfs file")
951 squashfs_target = target + '/live/' + grml_flavour + '/'
952 execute(mkdir, squashfs_target)
953 exec_rsync(squashfs, squashfs_target + grml_flavour + '.squashfs')
955 filesystem_module = search_file('filesystem.module', iso_mount)
956 if filesystem_module is None:
957 logging.critical("Fatal: filesystem.module not found")
958 raise CriticalException("error locating filesystem.module file")
960 exec_rsync(filesystem_module, squashfs_target + 'filesystem.module')
962 release_target = target + '/boot/release/' + grml_flavour
963 execute(mkdir, release_target)
965 kernel = search_file('linux26', iso_mount)
967 logging.critical("Fatal kernel not found")
968 raise CriticalException("error locating kernel file")
970 exec_rsync(kernel, release_target + '/linux26')
972 initrd = search_file('initrd.gz', iso_mount)
974 logging.critical("Fatal: initrd not found")
975 raise CriticalException("error locating initrd file")
977 exec_rsync(initrd, release_target + '/initrd.gz')
980 def copy_grml_files(iso_mount, target):
981 """copy some minor grml files to a given target
983 @iso_mount: path where a grml ISO is mounted on
984 @target: path where grml's main files should be copied to"""
986 grml_target = target + '/grml/'
987 execute(mkdir, grml_target)
989 for myfile in 'grml-cheatcodes.txt', 'grml-version', 'LICENSE.txt', 'md5sums', 'README.txt':
990 grml_file = search_file(myfile, iso_mount)
991 if grml_file is None:
992 logging.warn("Warning: myfile %s could not be found - can not install it", myfile)
994 exec_rsync(grml_file, grml_target + myfile)
996 grml_web_target = grml_target + '/web/'
997 execute(mkdir, grml_web_target)
999 for myfile in 'index.html', 'style.css':
1000 grml_file = search_file(myfile, iso_mount)
1001 if grml_file is None:
1002 logging.warn("Warning: myfile %s could not be found - can not install it")
1004 exec_rsync(grml_file, grml_web_target + myfile)
1006 grml_webimg_target = grml_web_target + '/images/'
1007 execute(mkdir, grml_webimg_target)
1009 for myfile in 'button.png', 'favicon.png', 'linux.jpg', 'logo.png':
1010 grml_file = search_file(myfile, iso_mount)
1011 if grml_file is None:
1012 logging.warn("Warning: myfile %s could not be found - can not install it")
1014 exec_rsync(grml_file, grml_webimg_target + myfile)
1017 def copy_addons(iso_mount, target):
1018 """copy grml's addons files (like allinoneimg, bsd4grml,..) to a given target
1020 @iso_mount: path where a grml ISO is mounted on
1021 @target: path where grml's main files should be copied to"""
1023 addons = target + '/boot/addons/'
1024 execute(mkdir, addons)
1026 # grub all-in-one image
1027 allinoneimg = search_file('allinone.img', iso_mount)
1028 if allinoneimg is None:
1029 logging.warn("Warning: allinone.img not found (that's fine if you don't need it)")
1031 exec_rsync(allinoneimg, addons + 'allinone.img')
1034 bsdimg = search_file('bsd4grml', iso_mount)
1036 logging.warn("Warning: bsd4grml not found (that's fine if you don't need it)")
1038 exec_rsync(bsdimg, addons + '/')
1041 balderimg = search_file('balder10.imz', iso_mount)
1042 if balderimg is None:
1043 logging.warn("Warning: balder10.imz not found (that's fine if you don't need it)")
1045 exec_rsync(balderimg, addons + 'balder10.imz')
1047 # install hdt and pci.ids only when using syslinux (grub doesn't support it)
1048 if options.syslinux:
1049 # hdt (hardware detection tool) image
1050 hdtimg = search_file('hdt.c32', iso_mount)
1052 exec_rsync(hdtimg, addons + '/hdt.c32')
1055 picids = search_file('pci.ids', iso_mount)
1057 exec_rsync(picids, addons + '/pci.ids')
1060 memdiskimg = search_file('memdisk', iso_mount)
1061 if memdiskimg is None:
1062 logging.warn("Warning: memdisk not found (that's fine if you don't need it)")
1064 exec_rsync(memdiskimg, addons + 'memdisk')
1067 memtestimg = search_file('memtest', iso_mount)
1068 if memtestimg is None:
1069 logging.warn("Warning: memtest not found (that's fine if you don't need it)")
1071 exec_rsync(memtestimg, addons + 'memtest')
1074 def copy_bootloader_files(iso_mount, target):
1075 """copy grml's bootloader files to a given target
1077 @iso_mount: path where a grml ISO is mounted on
1078 @target: path where grml's main files should be copied to"""
1080 syslinux_target = target + '/boot/syslinux/'
1081 execute(mkdir, syslinux_target)
1083 logo = search_file('logo.16', iso_mount)
1084 exec_rsync(logo, syslinux_target + 'logo.16')
1086 for ffile in 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10':
1087 bootsplash = search_file(ffile, iso_mount)
1088 exec_rsync(bootsplash, syslinux_target + ffile)
1090 for filename in 'addons.cfg', 'default.cfg', 'distri.cfg', 'hidden.cfg', 'grml.cfg', 'grml.png', 'hd.cfg', 'isoprompt.cfg', 'options.cfg','vesamenu.c32', 'vesamenu.cfg', 'grml.png':
1091 path = search_file(filename, iso_mount)
1092 exec_rsync(path, syslinux_target + filename)
1094 grub_target = target + '/boot/grub/'
1095 execute(mkdir, grub_target)
1097 if not os.path.isfile(GRML2USB_BASE + "/grub/splash.xpm.gz"):
1098 logging.critical("Error: %s/grub/splash.xpm.gz can not be read.", GRML2USB_BASE)
1099 logging.critical("Please make sure you've installed the grml2usb (Debian) package!")
1102 exec_rsync(GRML2USB_BASE + '/grub/splash.xpm.gz', grub_target + 'splash.xpm.gz')
1104 # grml splash in grub
1105 if os.path.isfile(GRML2USB_BASE + "/grub/grml.png"):
1106 exec_rsync(GRML2USB_BASE + '/grub/grml.png', grub_target + 'grml.png')
1108 # font file for graphical bootsplash in grub
1109 if os.path.isfile("/usr/share/grub/ascii.pf2"):
1110 exec_rsync('/usr/share/grub/ascii.pf2', grub_target + 'ascii.pf2')
1112 def install_iso_files(grml_flavour, iso_mount, device, target):
1113 """Copy files from ISO to given target
1115 @grml_flavour: name of grml flavour the configuration should be generated for
1116 @iso_mount: path where a grml ISO is mounted on
1117 @device: device/partition where bootloader should be installed to
1118 @target: path where grml's main files should be copied to"""
1120 # TODO => several improvements:
1121 # * make sure grml_flavour, iso_mount, target are set when the function is called, otherwise raise exception
1122 # * provide alternative search_file() if file information is stored in a config.ini file?
1123 # * catch "install: .. No space left on device" & CO
1127 elif not options.bootloaderonly:
1128 logging.info("Copying files. This might take a while....")
1130 copy_system_files(grml_flavour, iso_mount, target)
1131 copy_grml_files(iso_mount, target)
1132 except CriticalException, error:
1133 logging.critical("Execution failed: %s", error)
1136 if not options.skipaddons:
1137 if grml_flavour.endswith('-small'):
1138 logging.info("Note: grml-small doesn't provide any addons, not installing them therefore.")
1140 copy_addons(iso_mount, target)
1142 if not options.copyonly:
1143 copy_bootloader_files(iso_mount, target)
1145 if not options.dryrun:
1146 handle_bootloader_config(grml_flavour, device, target)
1148 # make sure we sync filesystems before returning
1149 proc = subprocess.Popen(["sync"])
1153 def uninstall_files(device):
1154 """Get rid of all grml files on specified device
1156 @device: partition where grml2usb files should be removed from"""
1158 # TODO - not implemented yet
1159 logging.critical("TODO: uninstalling files from %s not yet implement, sorry.", device)
1162 def identify_grml_flavour(mountpath):
1163 """Get name of grml flavour
1165 @mountpath: path where the grml ISO is mounted to
1166 @return: name of grml-flavour"""
1168 version_file = search_file('grml-version', mountpath)
1170 if version_file == "":
1171 logging.critical("Error: could not find grml-version file.")
1175 tmpfile = open(version_file, 'r')
1176 grml_info = tmpfile.readline()
1177 grml_flavour = re.match(r'[\w-]*', grml_info).group()
1180 except Exception, e:
1181 logging.critical("Unexpected error: %s", e)
1187 def handle_grub1_config(grml_flavour, install_partition, grub_target, bootopt):
1188 """Main handler for generating grub1 configuration
1190 @grml_flavour: name of grml flavour the configuration should be generated for
1191 @install_partition: partition number for use in (hd0,X)
1192 @grub_target: path of grub's configuration files
1193 @bootoptions: additional bootoptions that should be used by default"""
1196 grub1_cfg = grub_target + 'menu.lst'
1197 logging.debug("Creating grub1 configuration file (menu.lst)")
1199 # install main configuration only *once*, no matter how many ISOs we have:
1200 if os.path.isfile(grub1_cfg):
1201 string = open(grub1_cfg).readline()
1202 main_identifier = re.compile(".*main config generated at: %s.*" % re.escape(str(DATESTAMP)))
1203 if not re.match(main_identifier, string):
1204 grub1_config_file = open(grub1_cfg, 'w')
1205 grub1_config_file.write(generate_main_grub1_config(grml_flavour, install_partition, bootopt))
1206 grub1_config_file.close()
1208 grub1_config_file = open(grub1_cfg, 'w')
1209 grub1_config_file.write(generate_main_grub1_config(grml_flavour, install_partition, bootopt))
1210 grub1_config_file.close()
1212 grub_flavour_config = True
1213 if os.path.isfile(grub1_cfg):
1214 string = open(grub1_cfg).readlines()
1215 flavour = re.compile("grml2usb for %s: %s" % (re.escape(grml_flavour), re.escape(str(DATESTAMP))))
1217 if flavour.match(line):
1218 grub_flavour_config = False
1220 if grub_flavour_config:
1221 grub1_config_file = open(grub1_cfg, 'a')
1222 grub1_config_file.write(generate_flavour_specific_grub1_config(grml_flavour, install_partition, bootopt))
1223 grub1_config_file.close()
1225 # make sure grub.conf isn't a symlink but a plain file instead,
1226 # otherwise it will break on FAT16 filesystems
1227 # this works around grub-install of (at least) Fedora 10
1228 if os.path.isfile(grub1_cfg):
1229 grubconf = grub_target + 'grub.conf'
1230 if not os.path.islink(grubconf):
1232 shutil.copyfile(grub1_cfg, grub_target + 'grub.conf')
1234 def handle_grub2_config(grml_flavour, grub_target, bootopt):
1235 """Main handler for generating grub2 configuration
1237 @grml_flavour: name of grml flavour the configuration should be generated for
1238 @grub_target: path of grub's configuration files
1239 @bootoptions: additional bootoptions that should be used by default"""
1242 grub2_cfg = grub_target + 'grub.cfg'
1243 logging.debug("Creating grub2 configuration file (grub.lst)")
1247 # install main configuration only *once*, no matter how many ISOs we have:
1248 grub_flavour_is_default = False
1249 if os.path.isfile(grub2_cfg):
1250 string = open(grub2_cfg).readline()
1251 main_identifier = re.compile(".*main config generated at: %s.*" % re.escape(str(DATESTAMP)))
1252 if not re.match(main_identifier, string):
1253 grub2_config_file = open(grub2_cfg, 'w')
1254 GRML_DEFAULT = grml_flavour
1255 grub_flavour_is_default = True
1256 grub2_config_file.write(generate_main_grub2_config(grml_flavour, bootopt))
1257 grub2_config_file.close()
1259 grub2_config_file = open(grub2_cfg, 'w')
1260 GRML_DEFAULT = grml_flavour
1261 grub_flavour_is_default = True
1262 grub2_config_file.write(generate_main_grub2_config(grml_flavour, bootopt))
1263 grub2_config_file.close()
1265 # install flavour specific configuration only *once* as well
1266 grub_flavour_config = True
1267 if os.path.isfile(grub2_cfg):
1268 string = open(grub2_cfg).readlines()
1269 flavour = re.compile("grml2usb for %s: %s" % (re.escape(grml_flavour), re.escape(str(DATESTAMP))))
1271 if flavour.match(line):
1272 grub_flavour_config = False
1274 if grub_flavour_config:
1275 grub2_config_file = open(grub2_cfg, 'a')
1276 # display only if the grml flavour isn't the default
1277 if not grub_flavour_is_default:
1278 GRML_FLAVOURS.add(grml_flavour)
1279 grub2_config_file.write(generate_flavour_specific_grub2_config(grml_flavour, bootopt))
1280 grub2_config_file.close()
1283 def handle_grub_config(grml_flavour, device, target):
1284 """Main handler for generating grub (v1 and v2) configuration
1286 @grml_flavour: name of grml flavour the configuration should be generated for
1287 @device: device/partition where grub should be installed to
1288 @target: path of grub's configuration files"""
1290 logging.debug("Generating grub configuration")
1292 grub_target = target + '/boot/grub/'
1293 execute(mkdir, grub_target)
1295 if os.path.isdir(device):
1296 install_grub1_partition = None
1298 if device[-1:].isdigit():
1299 install_grub1_partition = int(device[-1:]) - 1
1301 raise CriticalException("error validating partition schema (raw device?)")
1303 # do NOT write "None" in kernel cmdline
1304 if options.bootoptions is None:
1307 bootopt = options.bootoptions
1310 handle_grub1_config(grml_flavour, install_grub1_partition, grub_target, bootopt)
1312 handle_grub2_config(grml_flavour, grub_target, bootopt)
1315 def initial_syslinux_config(target):
1316 """Generates intial syslinux configuration
1318 @target path of syslinux's configuration files"""
1320 target = target + "/"
1321 filename = target + "grmlmain.cfg"
1322 if os.path.isfile(target + "grmlmain.cfg"):
1324 data = open(filename, "w")
1325 data.write(generate_main_syslinux_config())
1328 def adjust_syslinux_bootoptions(src_name, dst_name, flavour):
1329 append_re = re.compile("^(\s*append.*)$", re.I)
1330 boot_re = re.compile("/boot/([a-zA-Z0-9_]+/)+(\w+)")
1331 flavour_re = re.compile("(label.*)(grml\w+)")
1332 default_re = re.compile("(default.cfg)")
1333 src = open(src_name, "r")
1334 dst = open(dst_name, "w")
1337 line = boot_re.sub(r'/boot/release/%s/\2 ' % flavour, line)
1338 line = flavour_re.sub(r'\1 %s-\2' % flavour, line)
1339 line = default_re.sub(r'%s-\1' % flavour, line)
1340 line = append_re.sub(r'\1 live-media-path=/live/%s/ ' % flavour, line)
1346 def add_syslinux_entry(filename, grml_flavour):
1347 data = open(filename, "a+")
1348 entry_filename = "option-%s.cfg" % grml_flavour
1349 entry = "include %s\n" % entry_filename
1350 path = os.path.dirname(filename)
1358 data = open(path + "/" + entry_filename, "w")
1359 data.write(generate_flavour_specific_syslinux_config(grml_flavour))
1365 def handle_syslinux_config(grml_flavour, target):
1366 """Main handler for generating syslinux configuration
1368 @grml_flavour: name of grml flavour the configuration should be generated for
1369 @target: path of syslinux's configuration files"""
1371 # do NOT write "None" in kernel cmdline
1372 if options.bootoptions is None:
1375 bootopt = options.bootoptions
1377 logging.debug("Generating syslinux configuration")
1378 syslinux_target = target + '/boot/syslinux/'
1379 # should be present via copy_bootloader_files(), but make sure it exits:
1380 execute(mkdir, syslinux_target)
1381 syslinux_cfg = syslinux_target + 'syslinux.cfg'
1385 # install main configuration only *once*, no matter how many ISOs we have:
1386 syslinux_flavour_is_default = False
1387 syslinux_config_file = open(syslinux_cfg, 'w')
1388 syslinux_config_file.write("include vesamenu.cfg")
1389 syslinux_config_file.close()
1391 initial_syslinux_config(syslinux_target)
1392 for filename in 'grml.cfg', 'default.cfg', 'hidden.cfg':
1393 old_filename = "%s/%s" % (syslinux_target, filename)
1394 new_filename = "%s/%s-%s" % (syslinux_target, grml_flavour, filename)
1395 adjust_syslinux_bootoptions(old_filename, new_filename, grml_flavour)
1396 os.unlink(old_filename)
1398 new_hidden = "%s-hidden.cfg" % (grml_flavour)
1399 new_default = "%s-default.cfg" % (grml_flavour)
1400 default_file = open("%s/defaults.cfg" % syslinux_target, "a+")
1401 entry = "include %s\n" % new_default
1402 for line in default_file:
1406 default_file.write("include %s\n" % new_default)
1408 default_file.close()
1409 add_syslinux_entry("%s/additional.cfg" % syslinux_target, grml_flavour)
1415 def handle_bootloader_config(grml_flavour, device, target):
1416 """Main handler for generating bootloader's configuration
1418 @grml_flavour: name of grml flavour the configuration should be generated for
1419 @device: device/partition where bootloader should be installed to
1420 @target: path of bootloader's configuration files"""
1422 if options.skipsyslinuxconfig:
1423 logging.info("Skipping generation of syslinux configuration as requested.")
1426 handle_syslinux_config(grml_flavour, target)
1427 except CriticalException, error:
1428 logging.critical("Fatal: %s", error)
1431 if options.skipgrubconfig:
1432 logging.info("Skipping generation of grub configuration as requested.")
1435 handle_grub_config(grml_flavour, device, target)
1436 except CriticalException, error:
1437 logging.critical("Fatal: %s", error)
1440 def handle_dir(live_image, device):
1441 """Main logic for copying files of the currently running grml system.
1443 @live_image: directory where currently running live system resides (usually /live/image)
1444 @device: partition where the specified ISO should be installed to"""
1446 logging.info("Using %s as install base", live_image)
1448 if os.path.isdir(device):
1449 logging.info("Specified target is a directory, therefore not mounting.")
1450 device_mountpoint = device
1451 remove_device_mountpoint = False
1453 device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
1454 register_tmpfile(device_mountpoint)
1455 remove_device_mountpoint = True
1457 mount(device, device_mountpoint, "")
1458 except CriticalException, error:
1459 logging.critical("Fatal: %s", error)
1465 grml_flavour = identify_grml_flavour(live_image)
1466 logging.info("Identified grml flavour \"%s\".", grml_flavour)
1467 install_iso_files(grml_flavour, live_image, device, device_mountpoint)
1469 logging.critical("Fatal: a critical error happend during execution (not a grml ISO?), giving up")
1472 if remove_device_mountpoint:
1474 unmount(device_mountpoint, "")
1475 if os.path.isdir(device_mountpoint):
1476 os.rmdir(device_mountpoint)
1477 unregister_tmpfile(device_mountpoint)
1478 except CriticalException, error:
1479 logging.critical("Fatal: %s", error)
1483 def handle_iso(iso, device):
1484 """Main logic for mounting ISOs and copying files.
1486 @iso: full path to the ISO that should be installed to the specified device
1487 @device: partition where the specified ISO should be installed to"""
1489 logging.info("Using ISO %s", iso)
1491 iso_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
1492 register_tmpfile(iso_mountpoint)
1493 remove_iso_mountpoint = True
1495 if not os.path.isfile(iso):
1496 logging.critical("Fatal: specified ISO %s could not be read", iso)
1501 mount(iso, iso_mountpoint, ["-o", "loop", "-t", "iso9660"])
1502 except CriticalException, error:
1503 logging.critical("Fatal: %s", error)
1506 if os.path.isdir(device):
1507 logging.info("Specified target is a directory, therefore not mounting.")
1508 device_mountpoint = device
1509 remove_device_mountpoint = False
1512 device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
1513 register_tmpfile(device_mountpoint)
1514 remove_device_mountpoint = True
1516 mount(device, device_mountpoint, "")
1517 except CriticalException, error:
1518 logging.critical("Fatal: %s", error)
1524 grml_flavour = identify_grml_flavour(iso_mountpoint)
1525 logging.info("Identified grml flavour \"%s\".", grml_flavour)
1526 install_iso_files(grml_flavour, iso_mountpoint, device, device_mountpoint)
1528 logging.critical("Fatal: a critical error happend during execution (not a grml ISO?), giving up")
1531 if os.path.isdir(iso_mountpoint) and remove_iso_mountpoint:
1532 unmount(iso_mountpoint, "")
1533 os.rmdir(iso_mountpoint)
1534 unregister_tmpfile(iso_mountpoint)
1535 if remove_device_mountpoint:
1537 unmount(device_mountpoint, "")
1538 if os.path.isdir(device_mountpoint):
1539 os.rmdir(device_mountpoint)
1540 unregister_tmpfile(device_mountpoint)
1541 except CriticalException, error:
1542 logging.critical("Fatal: %s", error)
1546 def handle_mbr(device):
1547 """Main handler for installing master boot record (MBR)
1549 @device: device where the MBR should be installed to"""
1552 logging.info("Would install MBR")
1555 if device[-1:].isdigit():
1556 mbr_device = re.match(r'(.*?)\d*$', device).group(1)
1557 partition_number = int(device[-1:]) - 1
1558 skip_install_mir_mbr = False
1560 # if we get e.g. /dev/loop1 as device we don't want to put the MBR
1561 # into /dev/loop of course, therefore use /dev/loop1 as mbr_device
1562 if mbr_device == "/dev/loop":
1564 logging.info("Detected loop device - using %s as MBR device therefore", mbr_device)
1565 skip_install_mir_mbr = True
1568 if options.syslinuxmbr:
1569 handle_syslinux_mbr(mbr_device)
1570 elif not skip_install_mir_mbr:
1572 install_mir_mbr(GRML2USB_BASE + '/mbr/mbrmgr', mbr_device, partition_number, True)
1574 install_mir_mbr(GRML2USB_BASE + '/mbr/mbrldr', mbr_device, partition_number, False)
1575 except IOError, error:
1576 logging.critical("Execution failed: %s", error)
1578 except Exception, error:
1579 logging.critical("Execution failed: %s", error)
1583 def handle_vfat(device):
1584 """Check for FAT specific settings and options
1586 @device: device that should checked / formated"""
1588 # make sure we have mkfs.vfat available
1590 if not which("mkfs.vfat") and not options.copyonly and not options.dryrun:
1591 logging.critical('Sorry, mkfs.vfat not available. Exiting.')
1592 logging.critical('Please make sure to install dosfstools.')
1597 print "Forcing mkfs.fat16 on %s as requested via option --force." % device
1600 # make sure the user is aware of what he is doing
1601 f = raw_input("Are you sure you want to format the specified partition with fat16? y/N ")
1602 if f == "y" or f == "Y":
1603 logging.info("Note: you can skip this question using the option --force")
1609 except CriticalException, error:
1610 logging.critical("Execution failed: %s", error)
1615 # check for vfat filesystem
1616 if device is not None and not os.path.isdir(device):
1618 check_for_fat(device)
1619 except CriticalException, error:
1620 logging.critical("Execution failed: %s", error)
1623 if not os.path.isdir(device) and not check_for_usbdevice(device):
1624 print "Warning: the specified device %s does not look like a removable usb device." % device
1625 f = raw_input("Do you really want to continue? y/N ")
1626 if f == "y" or f == "Y":
1632 def handle_compat_warning(device):
1633 """Backwards compatible checks
1635 @device: device that should be checked"""
1637 # make sure we can replace old grml2usb script and warn user when using old way of life:
1638 if device.startswith("/mnt/external") or device.startswith("/mnt/usb") and not options.force:
1639 print "Warning: the semantics of grml2usb has changed."
1640 print "Instead of using grml2usb /path/to/iso %s you might" % device
1641 print "want to use grml2usb /path/to/iso /dev/... instead."
1642 print "Please check out the grml2usb manpage for details."
1643 f = raw_input("Do you really want to continue? y/N ")
1644 if f == "y" or f == "Y":
1650 def handle_logging():
1651 """Log handling and configuration"""
1653 if options.verbose and options.quiet:
1654 parser.error("please use either verbose (--verbose) or quiet (--quiet) option")
1657 FORMAT = "Debug: %(asctime)-15s %(message)s"
1658 logging.basicConfig(level=logging.DEBUG, format=FORMAT)
1660 FORMAT = "Critical: %(message)s"
1661 logging.basicConfig(level=logging.CRITICAL, format=FORMAT)
1663 FORMAT = "%(message)s"
1664 logging.basicConfig(level=logging.INFO, format=FORMAT)
1667 def handle_bootloader(device):
1668 """wrapper for installing bootloader
1670 @device: device where bootloader should be installed to"""
1672 # Install bootloader only if not using the --copy-only option
1673 if options.copyonly:
1674 logging.info("Not installing bootloader and its files as requested via option copyonly.")
1675 elif os.path.isdir(device):
1676 logging.info("Not installing bootloader as %s is a directory.", device)
1678 install_bootloader(device)
1682 """Main function [make pylint happy :)]"""
1685 print os.path.basename(sys.argv[0]) + " " + PROG_VERSION
1689 parser.error("invalid usage")
1694 # make sure we have the appropriate permissions
1697 logging.info("Executing grml2usb version %s", PROG_VERSION)
1700 logging.info("Running in simulation mode as requested via option dry-run.")
1702 # specified arguments
1703 device = args[len(args) - 1]
1704 isos = args[0:len(args) - 1]
1706 if not os.path.isdir(device):
1707 if device[-1:].isdigit():
1708 if int(device[-1:]) > 4 or device[-2:].isdigit():
1709 logging.critical("Fatal: installation on partition number >4 not supported. (BIOS won't support it.)")
1712 if os.path.exists(device):
1713 logging.critical("Fatal: installation on raw device not supported. (BIOS won't support it.)")
1716 if not which("rsync"):
1717 logging.critical("Fatal: rsync not available, can not continue - sorry.")
1720 # provide upgrade path
1721 handle_compat_warning(device)
1723 # check for vfat partition
1726 # main operation (like installing files)
1728 if os.path.isdir(iso):
1729 handle_dir(iso, device)
1731 handle_iso(iso, device)
1734 if not os.path.isdir(device):
1735 if not options.skipmbr:
1738 handle_bootloader(device)
1740 logging.info("Note: grml flavour %s was installed as the default booting system.", GRML_DEFAULT)
1742 for flavour in GRML_FLAVOURS:
1743 logging.info("Note: you can boot flavour %s using '%s' on the commandline.", flavour, flavour)
1745 # finally be politely :)
1746 logging.info("Finished execution of grml2usb (%s). Have fun with your grml system.", PROG_VERSION)
1749 if __name__ == "__main__":
1752 except KeyboardInterrupt:
1753 logging.info("Received KeyboardInterrupt")
1756 ## END OF FILE #################################################################
1757 # vim:foldmethod=indent expandtab ai ft=python tw=120 fileencoding=utf-8