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.12"
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(grml_flavour, bootoptions):
494 """Generate main configuration for use in syslinux.cfg
496 @grml_flavour: name of grml flavour the configuration should be generated for
497 @bootoptions: additional bootoptions that should be used by default"""
499 local_datestamp = DATESTAMP
502 ## main syslinux configuration - generated by grml2usb [main config generated at: %(local_datestamp)s]
503 # use this to control the bootup via a serial port
508 DISPLAY /boot/syslinux/boot.msg
509 F1 /boot/syslinux/boot.msg
518 F10 /boot/syslinux/f10
519 ## end of main configuration
521 ## global configuration
522 # the default option (using %(grml_flavour)s)
524 KERNEL /boot/release/%(grml_flavour)s/linux26
525 APPEND initrd=/boot/release/%(grml_flavour)s/initrd.gz apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ %(bootoptions)s
529 KERNEL /boot/addons/memtest
534 KERNEL /boot/addons/memdisk
535 APPEND initrd=/boot/addons/allinone.img
540 KERNEL /boot/addons/memdisk
541 APPEND initrd=/boot/addons/balder10.imz
546 KERNEL /boot/addons/bsd4grml/ldbsd.com
548 # hardware detection tool
550 KERNEL /boot/addons/hdt.c32
551 APPEND pciids=/boot/addons/pci.ids
553 ## end of global configuration
554 """ % {'grml_flavour': grml_flavour, 'local_datestamp': local_datestamp, 'bootoptions': bootoptions} )
557 def generate_flavour_specific_syslinux_config(grml_flavour, bootoptions):
558 """Generate flavour specific configuration for use in syslinux.cfg
560 @grml_flavour: name of grml flavour the configuration should be generated for
561 @bootoptions: bootoptions that should be used as a default"""
563 local_datestamp = DATESTAMP
567 # flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
568 LABEL %(grml_flavour)s
569 KERNEL /boot/release/%(grml_flavour)s/linux26
570 APPEND initrd=/boot/release/%(grml_flavour)s/initrd.gz apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ %(bootoptions)s
572 # flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
573 LABEL %(grml_flavour)s-persistent
574 KERNEL /boot/release/%(grml_flavour)s/linux26
575 APPEND initrd=/boot/release/%(grml_flavour)s/initrd.gz apm=power-off boot=live nomce vga=791 quiet persistent live-media-path=/live/%(grml_flavour)s/ %(bootoptions)s
577 # flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
578 LABEL %(grml_flavour)s2ram
579 KERNEL /boot/release/%(grml_flavour)s/linux26
580 APPEND initrd=/boot/release/%(grml_flavour)s/initrd.gz apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ toram=%(grml_flavour)s.squashfs %(bootoptions)s
582 # flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
583 LABEL %(grml_flavour)s-debug
584 KERNEL /boot/release/%(grml_flavour)s/linux26
585 APPEND initrd=/boot/release/%(grml_flavour)s/initrd.gz apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ debug boot=live initcall_debug%(bootoptions)s
587 # flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
588 LABEL %(grml_flavour)s-x
589 KERNEL /boot/release/%(grml_flavour)s/linux26
590 APPEND initrd=/boot/release/%(grml_flavour)s/initrd.gz apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ startx=wm-ng %(bootoptions)s
592 # flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
593 LABEL %(grml_flavour)s-nofb
594 KERNEL /boot/release/%(grml_flavour)s/linux26
595 APPEND initrd=/boot/release/%(grml_flavour)s/initrd.gz apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ vga=normal video=ofonly %(bootoptions)s
597 # flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
598 LABEL %(grml_flavour)s-failsafe
599 KERNEL /boot/release/%(grml_flavour)s/linux26
600 APPEND initrd=/boot/release/%(grml_flavour)s/initrd.gz 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
602 # flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
603 LABEL %(grml_flavour)s-forensic
604 KERNEL /boot/release/%(grml_flavour)s/linux26
605 APPEND initrd=/boot/release/%(grml_flavour)s/initrd.gz 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
607 # flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
608 LABEL %(grml_flavour)s-serial
609 KERNEL /boot/release/%(grml_flavour)s/linux26
610 APPEND initrd=/boot/release/%(grml_flavour)s/initrd.gz 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
611 """ % {'grml_flavour': grml_flavour, 'local_datestamp': local_datestamp, 'bootoptions': bootoptions} )
614 def install_grub(device):
615 """Install grub on specified device.
617 @mntpoint: mountpoint of device where grub should install its files to
618 @device: partition where grub should be installed to"""
621 logging.info("Would execute grub-install [--root-directory=mount_point] %s now.", device)
623 device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
624 register_tmpfile(device_mountpoint)
627 mount(device, device_mountpoint, "")
629 # If using --grub-mbr then make sure we install grub in MBR instead of PBR
630 # Thanks to grub2. NOT.
632 logging.debug("Using option --grub-mbr ...")
633 if device[-1:].isdigit():
634 grub_device = re.match(r'(.*?)\d*$', device).group(1)
640 logging.debug("grub-install --recheck --no-floppy --root-directory=%s %s",
641 device_mountpoint, grub_device)
642 proc = subprocess.Popen(["grub-install", "--recheck", "--no-floppy",
643 "--root-directory=%s" % device_mountpoint, grub_device], stdout=file(os.devnull, "r+"))
645 if proc.returncode != 0:
646 # raise Exception("error executing grub-install")
647 logging.critical("Fatal: error executing grub-install (please check the grml2usb FAQ or use --syslinux)")
648 logging.critical("Note: if using grub2 consider using the --grub-mbr option because grub2's PBR feature is broken.")
651 except CriticalException, error:
652 logging.critical("Fatal: %s", error)
657 unmount(device_mountpoint, "")
658 os.rmdir(device_mountpoint)
659 unregister_tmpfile(device_mountpoint)
662 def install_syslinux(device):
663 """Install syslinux on specified device.
665 @device: partition where syslinux should be installed to"""
668 logging.info("Would install syslinux as bootloader on %s", device)
671 # syslinux -d boot/isolinux /dev/sdb1
672 logging.info("Installing syslinux as bootloader")
673 logging.debug("syslinux -d boot/syslinux %s", device)
674 proc = subprocess.Popen(["syslinux", "-d", "boot/syslinux", device])
676 if proc.returncode != 0:
677 raise CriticalException("Error executing syslinux (either try --fat16 or use grub?)")
680 def install_bootloader(device):
681 """Install bootloader on specified device.
683 @device: partition where bootloader should be installed to"""
685 # by default we use grub, so install syslinux only on request
688 install_syslinux(device)
689 except CriticalException, error:
690 logging.critical("Fatal: %s", error)
694 if not which("grub-install"):
695 logging.critical("Fatal: grub-install not available (please install the grub package or use the --syslinux option)")
701 except CriticalException, error:
702 logging.critical("Fatal: %s", error)
707 def execute_lilo(lilo, device):
708 """execute lilo for activating the partitions in the MBR
710 @lilo: path of lilo executable
711 @device: device where lilo should be executed on"""
713 # to support -A for extended partitions:
714 logging.info("Activating partitions in MBR via lilo")
715 logging.debug("%s -S /dev/null -M %s ext", lilo, device)
716 proc = subprocess.Popen([lilo, "-S", "/dev/null", "-M", device, "ext"])
718 if proc.returncode != 0:
719 raise Exception("error executing lilo")
721 # activate partition:
722 logging.debug("%s -S /dev/null -A %s 1", lilo, device)
723 proc = subprocess.Popen([lilo, "-S", "/dev/null", "-A", device, "1"])
725 if proc.returncode != 0:
726 raise Exception("error executing lilo")
729 def install_syslinux_mbr(device):
730 """install syslinux's master boot record (MBR) on the specified device
732 @device: device where MBR of syslinux should be installed to"""
734 # make sure we have syslinux available
735 if not which("syslinux") and not options.copyonly:
736 raise Exception("syslinux not available (either install it or consider dropping the --syslinux option)")
738 # lilo's mbr is broken, use the one from syslinux instead:
739 if not os.path.isfile("/usr/lib/syslinux/mbr.bin"):
740 raise Exception("/usr/lib/syslinux/mbr.bin can not be read")
742 logging.info("Installing syslinux MBR")
743 logging.debug("cat /usr/lib/syslinux/mbr.bin > %s", device)
745 # TODO -> use Popen instead?
746 retcode = subprocess.call("cat /usr/lib/syslinux/mbr.bin > "+ device, shell=True)
748 logging.critical("Error copying MBR to device (%s)", retcode)
749 except OSError, error:
750 logging.critical("Execution failed: %s", error)
753 def install_mir_mbr(mbrtemplate, device, partition, ismirbsdmbr=True):
754 """install 'mbr' master boot record (MBR) on a device
756 Retrieve the partition table from "device", install an MBR from the
757 "mbrtemplate" file, set the "partition" (0..3) active, and install the
758 result back to "device".
760 @mbrtemplate: default MBR file
762 @device: name of a file assumed to be a hard disc (or USB stick) image, or
763 something like "/dev/sdb"
765 @partition: must be a number between 0 and 3, inclusive
767 @mbrtemplate: must be a valid MBR file of at least 440 (or 439 if
770 @ismirbsdmbr: if true then ignore the active flag, set the mirbsdmbr
771 specific flag to 0/1/2/3 and set the MBR's default value accordingly. If
772 false then leave the mirbsdmbr specific flag set to FFh, set all
773 active flags to 0 and set the active flag of the partition to 80h. Note:
774 behaviour of mirbsdmbr: if flag = 0/1/2/3 then use it, otherwise search for
777 logging.info("Installing default MBR")
779 if not os.path.isfile(mbrtemplate):
780 logging.critical("Error: %s can not be read.", mbrtemplate)
781 raise CriticalException("Error installing MBR (either try --syslinux-mbr or install missing file?)")
783 if (partition < 0) or (partition > 3):
784 raise ValueError("partition must be between 0 and 3")
791 tmpf = tempfile.NamedTemporaryFile()
793 logging.debug("executing: dd if='%s' of='%s' bs=512 count=1", device, tmpf.name)
794 proc = subprocess.Popen(["dd", "if=%s" % device, "of=%s" % tmpf.name, "bs=512", "count=1"], stderr=file(os.devnull, "r+"))
796 if proc.returncode != 0:
797 raise Exception("error executing dd (first run)")
799 logging.debug("executing: dd if=%s of=%s bs=%s count=1 conv=notrunc", mbrtemplate,
800 tmpf.name, nmbrbytes)
801 proc = subprocess.Popen(["dd", "if=%s" % mbrtemplate, "of=%s" % tmpf.name, "bs=%s" % nmbrbytes,
802 "count=1", "conv=notrunc"], stderr=file(os.devnull, "r+"))
804 if proc.returncode != 0:
805 raise Exception("error executing dd (second run)")
807 mbrcode = tmpf.file.read(512)
808 if len(mbrcode) < 512:
809 raise EOFError("MBR size (%d) < 512" % len(mbrcode))
812 mbrcode = mbrcode[0:439] + chr(partition) + \
813 mbrcode[440:510] + "\x55\xAA"
815 actives = ["\x00", "\x00", "\x00", "\x00"]
816 actives[partition] = "\x80"
817 mbrcode = mbrcode[0:446] + actives[0] + \
818 mbrcode[447:462] + actives[1] + \
819 mbrcode[463:478] + actives[2] + \
820 mbrcode[479:494] + actives[3] + \
821 mbrcode[495:510] + "\x55\xAA"
825 tmpf.file.write(mbrcode)
828 logging.debug("executing: dd if='%s' of='%s' bs=512 count=1 conv=notrunc", tmpf.name, device)
829 proc = subprocess.Popen(["dd", "if=%s" % tmpf.name, "of=%s" % device, "bs=512", "count=1",
830 "conv=notrunc"], stderr=file(os.devnull, "r+"))
832 if proc.returncode != 0:
833 raise Exception("error executing dd (third run)")
837 def handle_syslinux_mbr(device):
838 """Install syslinux master boot record on given device
840 @device: device where MBR should be installed to"""
842 if not is_writeable(device):
843 raise IOError("device not writeable for user")
845 # try to use system's lilo
849 # otherwise fall back to our static version
850 from platform import architecture
851 if architecture()[0] == '64bit':
852 lilo = GRML2USB_BASE + '/lilo/lilo.static.amd64'
854 lilo = GRML2USB_BASE + '/lilo/lilo.static.i386'
855 # finally prefer a specified lilo executable
857 lilo = options.lilobin
860 raise Exception("lilo executable can not be execute")
863 logging.info("Would install MBR running lilo and using syslinux.")
866 execute_lilo(lilo, device)
867 install_syslinux_mbr(device)
870 def is_writeable(device):
871 """Check if the device is writeable for the current user
873 @device: partition where bootloader should be installed to"""
877 #raise Exception("no device for checking write permissions")
879 if not os.path.exists(device):
882 return os.access(device, os.W_OK) and os.access(device, os.R_OK)
885 def mount(source, target, mount_options):
886 """Mount specified source on given target
888 @source: name of device/ISO that should be mounted
889 @target: directory where the ISO should be mounted to
890 @options: mount specific options"""
892 # note: options.dryrun does not work here, as we have to
893 # locate files and identify the grml flavour
895 for x in file('/proc/mounts').readlines():
896 if x.startswith(source):
897 raise CriticalException("Error executing mount: %s already mounted - please unmount before invoking grml2usb" % source)
899 if os.path.isdir(source):
900 logging.debug("Source %s is not a device, therefore not mounting.", source)
903 logging.debug("mount %s %s %s", mount_options, source, target)
904 proc = subprocess.Popen(["mount"] + list(mount_options) + [source, target])
906 if proc.returncode != 0:
907 raise CriticalException("Error executing mount (no filesystem on the partition?)")
909 logging.debug("register_mountpoint(%s)", target)
910 register_mountpoint(target)
913 def unmount(target, unmount_options):
914 """Unmount specified target
916 @target: target where something is mounted on and which should be unmounted
917 @options: options for umount command"""
919 # make sure we unmount only already mounted targets
920 target_unmount = False
921 mounts = open('/proc/mounts').readlines()
922 mountstring = re.compile(".*%s.*" % re.escape(os.path.realpath(target)))
924 if re.match(mountstring, line):
925 target_unmount = True
927 if not target_unmount:
928 logging.debug("%s not mounted anymore", target)
930 logging.debug("umount %s %s", list(unmount_options), target)
931 proc = subprocess.Popen(["umount"] + list(unmount_options) + [target])
933 if proc.returncode != 0:
934 raise Exception("Error executing umount")
936 logging.debug("unregister_mountpoint(%s)", target)
937 unregister_mountpoint(target)
940 def check_for_usbdevice(device):
941 """Check whether the specified device is a removable USB device
943 @device: device name, like /dev/sda1 or /dev/sda
946 usbdevice = re.match(r'/dev/(.*?)\d*$', device).group(1)
948 usbdev = os.path.realpath('/sys/class/block/' + usbdevice + '/removable')
949 if not os.path.isfile(usbdev):
950 # Ubuntu with kernel 2.6.24 for example:
951 usbdev = os.path.realpath('/sys/block/' + usbdevice + '/removable')
953 if os.path.isfile(usbdev):
954 is_usb = open(usbdev).readline()
961 def check_for_fat(partition):
962 """Check whether specified partition is a valid VFAT/FAT16 filesystem
964 @partition: device name of partition"""
967 udev_info = subprocess.Popen(["/sbin/blkid", "-s", "TYPE", "-o", "value", partition],
968 stdout=subprocess.PIPE, stderr=subprocess.PIPE)
969 filesystem = udev_info.communicate()[0].rstrip()
971 if udev_info.returncode == 2:
972 raise CriticalException("Failed to read device %s"
973 " (wrong UID/permissions or device/directory not present?)" % partition)
975 if options.syslinux and filesystem != "vfat":
976 raise CriticalException("Partition %s does not contain a FAT16 filesystem. (Use --fat16 or run mkfs.vfat %s)" % (partition, partition))
979 raise CriticalException("Sorry, /sbin/blkid not available (install e2fsprogs?)")
982 def mkdir(directory):
983 """Simple wrapper around os.makedirs to get shell mkdir -p behaviour"""
985 # just silently pass as it's just fine it the directory exists
986 if not os.path.isdir(directory):
988 os.makedirs(directory)
989 # pylint: disable-msg=W0704
994 def exec_rsync(source, target):
995 """Simple wrapper around rsync to install files
997 @source: source file/directory
998 @target: target file/directory"""
999 logging.debug("Source: %s / Target: %s", source, target)
1000 proc = subprocess.Popen(["rsync", "-rlptDH", "--inplace", source, target])
1002 if proc.returncode == 12:
1003 logging.critical("Fatal: No space left on device")
1007 if proc.returncode != 0:
1008 logging.critical("Fatal: could not install %s", source)
1013 def copy_system_files(grml_flavour, iso_mount, target):
1014 """copy grml's main files (like squashfs, kernel and initrd) to a given target
1016 @grml_flavour: name of grml flavour the configuration should be generated for
1017 @iso_mount: path where a grml ISO is mounted on
1018 @target: path where grml's main files should be copied to"""
1020 squashfs = search_file(grml_flavour + '.squashfs', iso_mount)
1021 if squashfs is None:
1022 logging.critical("Fatal: squashfs file not found")
1023 raise CriticalException("error locating squashfs file")
1025 squashfs_target = target + '/live/' + grml_flavour + '/'
1026 execute(mkdir, squashfs_target)
1027 exec_rsync(squashfs, squashfs_target + grml_flavour + '.squashfs')
1029 filesystem_module = search_file('filesystem.module', iso_mount)
1030 if filesystem_module is None:
1031 logging.critical("Fatal: filesystem.module not found")
1033 exec_rsync(filesystem_module, squashfs_target + 'filesystem.module')
1035 release_target = target + '/boot/release/' + grml_flavour
1036 execute(mkdir, release_target)
1038 kernel = search_file('linux26', iso_mount)
1040 logging.critical("Fatal kernel not found")
1042 exec_rsync(kernel, release_target + '/linux26')
1044 initrd = search_file('initrd.gz', iso_mount)
1046 logging.critical("Fatal: initrd not found")
1048 exec_rsync(initrd, release_target + '/initrd.gz')
1051 def copy_grml_files(iso_mount, target):
1052 """copy some minor grml files to a given target
1054 @iso_mount: path where a grml ISO is mounted on
1055 @target: path where grml's main files should be copied to"""
1057 grml_target = target + '/grml/'
1058 execute(mkdir, grml_target)
1060 for myfile in 'grml-cheatcodes.txt', 'grml-version', 'LICENSE.txt', 'md5sums', 'README.txt':
1061 grml_file = search_file(myfile, iso_mount)
1062 if grml_file is None:
1063 logging.warn("Warning: myfile %s could not be found - can not install it", myfile)
1065 exec_rsync(grml_file, grml_target + myfile)
1067 grml_web_target = grml_target + '/web/'
1068 execute(mkdir, grml_web_target)
1070 for myfile in 'index.html', 'style.css':
1071 grml_file = search_file(myfile, iso_mount)
1072 if grml_file is None:
1073 logging.warn("Warning: myfile %s could not be found - can not install it")
1075 exec_rsync(grml_file, grml_web_target + myfile)
1077 grml_webimg_target = grml_web_target + '/images/'
1078 execute(mkdir, grml_webimg_target)
1080 for myfile in 'button.png', 'favicon.png', 'linux.jpg', 'logo.png':
1081 grml_file = search_file(myfile, iso_mount)
1082 if grml_file is None:
1083 logging.warn("Warning: myfile %s could not be found - can not install it")
1085 exec_rsync(grml_file, grml_webimg_target + myfile)
1088 def copy_addons(iso_mount, target):
1089 """copy grml's addons files (like allinoneimg, bsd4grml,..) to a given target
1091 @iso_mount: path where a grml ISO is mounted on
1092 @target: path where grml's main files should be copied to"""
1094 addons = target + '/boot/addons/'
1095 execute(mkdir, addons)
1097 # grub all-in-one image
1098 allinoneimg = search_file('allinone.img', iso_mount)
1099 if allinoneimg is None:
1100 logging.warn("Warning: allinone.img not found (that's fine if you don't need it)")
1102 exec_rsync(allinoneimg, addons + 'allinone.img')
1105 bsdimg = search_file('bsd4grml', iso_mount)
1107 logging.warn("Warning: bsd4grml not found (that's fine if you don't need it)")
1109 exec_rsync(bsdimg, addons + '/')
1112 balderimg = search_file('balder10.imz', iso_mount)
1113 if balderimg is None:
1114 logging.warn("Warning: balder10.imz not found (that's fine if you don't need it)")
1116 exec_rsync(balderimg, addons + 'balder10.imz')
1118 # install hdt and pci.ids only when using syslinux (grub doesn't support it)
1119 if options.syslinux:
1120 # hdt (hardware detection tool) image
1121 hdtimg = search_file('hdt.c32', iso_mount)
1123 exec_rsync(hdtimg, addons + '/hdt.c32')
1126 picids = search_file('pci.ids', iso_mount)
1128 exec_rsync(picids, addons + '/pci.ids')
1131 memdiskimg = search_file('memdisk', iso_mount)
1132 if memdiskimg is None:
1133 logging.warn("Warning: memdisk not found (that's fine if you don't need it)")
1135 exec_rsync(memdiskimg, addons + 'memdisk')
1138 memtestimg = search_file('memtest', iso_mount)
1139 if memtestimg is None:
1140 logging.warn("Warning: memtest not found (that's fine if you don't need it)")
1142 exec_rsync(memtestimg, addons + 'memtest')
1145 def copy_bootloader_files(iso_mount, target):
1146 """copy grml's bootloader files to a given target
1148 @iso_mount: path where a grml ISO is mounted on
1149 @target: path where grml's main files should be copied to"""
1151 syslinux_target = target + '/boot/syslinux/'
1152 execute(mkdir, syslinux_target)
1154 logo = search_file('logo.16', iso_mount)
1155 exec_rsync(logo, syslinux_target + 'logo.16')
1157 for ffile in 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10':
1158 bootsplash = search_file(ffile, iso_mount)
1159 exec_rsync(bootsplash, syslinux_target + ffile)
1161 grub_target = target + '/boot/grub/'
1162 execute(mkdir, grub_target)
1164 if not os.path.isfile(GRML2USB_BASE + "/grub/splash.xpm.gz"):
1165 logging.critical("Error: %s/grub/splash.xpm.gz can not be read.", GRML2USB_BASE)
1166 logging.critical("Please make sure you've installed the grml2usb (Debian) package!")
1169 exec_rsync(GRML2USB_BASE + '/grub/splash.xpm.gz', grub_target + 'splash.xpm.gz')
1171 # grml splash in grub
1172 if os.path.isfile(GRML2USB_BASE + "/grub/grml.png"):
1173 exec_rsync(GRML2USB_BASE + '/grub/grml.png', grub_target + 'grml.png')
1175 # font file for graphical bootsplash in grub
1176 if os.path.isfile("/usr/share/grub/ascii.pf2"):
1177 exec_rsync('/usr/share/grub/ascii.pf2', grub_target + 'ascii.pf2')
1179 def install_iso_files(grml_flavour, iso_mount, device, target):
1180 """Copy files from ISO to given target
1182 @grml_flavour: name of grml flavour the configuration should be generated for
1183 @iso_mount: path where a grml ISO is mounted on
1184 @device: device/partition where bootloader should be installed to
1185 @target: path where grml's main files should be copied to"""
1187 # TODO => several improvements:
1188 # * make sure grml_flavour, iso_mount, target are set when the function is called, otherwise raise exception
1189 # * provide alternative search_file() if file information is stored in a config.ini file?
1190 # * catch "install: .. No space left on device" & CO
1194 elif not options.bootloaderonly:
1195 logging.info("Copying files. This might take a while....")
1197 copy_system_files(grml_flavour, iso_mount, target)
1198 copy_grml_files(iso_mount, target)
1199 except CriticalException, error:
1200 logging.critical("Execution failed: %s", error)
1203 if not options.skipaddons:
1204 if grml_flavour.endswith('-small'):
1205 logging.info("Note: grml-small doesn't provide any addons, not installing them therefore.")
1207 copy_addons(iso_mount, target)
1209 if not options.copyonly:
1210 copy_bootloader_files(iso_mount, target)
1212 if not options.dryrun:
1213 handle_bootloader_config(grml_flavour, device, target)
1215 # make sure we sync filesystems before returning
1216 proc = subprocess.Popen(["sync"])
1220 def uninstall_files(device):
1221 """Get rid of all grml files on specified device
1223 @device: partition where grml2usb files should be removed from"""
1225 # TODO - not implemented yet
1226 logging.critical("TODO: uninstalling files from %s not yet implement, sorry.", device)
1229 def identify_grml_flavour(mountpath):
1230 """Get name of grml flavour
1232 @mountpath: path where the grml ISO is mounted to
1233 @return: name of grml-flavour"""
1235 version_file = search_file('grml-version', mountpath)
1237 if version_file == "":
1238 logging.critical("Error: could not find grml-version file.")
1242 tmpfile = open(version_file, 'r')
1243 grml_info = tmpfile.readline()
1244 grml_flavour = re.match(r'[\w-]*', grml_info).group()
1247 except Exception, e:
1248 logging.critical("Unexpected error: %s", e)
1254 def handle_grub1_config(grml_flavour, install_partition, grub_target, bootopt):
1255 """Main handler for generating grub1 configuration
1257 @grml_flavour: name of grml flavour the configuration should be generated for
1258 @install_partition: partition number for use in (hd0,X)
1259 @grub_target: path of grub's configuration files
1260 @bootoptions: additional bootoptions that should be used by default"""
1263 grub1_cfg = grub_target + 'menu.lst'
1264 logging.debug("Creating grub1 configuration file (menu.lst)")
1266 # install main configuration only *once*, no matter how many ISOs we have:
1267 if os.path.isfile(grub1_cfg):
1268 string = open(grub1_cfg).readline()
1269 main_identifier = re.compile(".*main config generated at: %s.*" % re.escape(str(DATESTAMP)))
1270 if not re.match(main_identifier, string):
1271 grub1_config_file = open(grub1_cfg, 'w')
1272 grub1_config_file.write(generate_main_grub1_config(grml_flavour, install_partition, bootopt))
1273 grub1_config_file.close()
1275 grub1_config_file = open(grub1_cfg, 'w')
1276 grub1_config_file.write(generate_main_grub1_config(grml_flavour, install_partition, bootopt))
1277 grub1_config_file.close()
1279 grub_flavour_config = True
1280 if os.path.isfile(grub1_cfg):
1281 string = open(grub1_cfg).readlines()
1282 flavour = re.compile("grml2usb for %s: %s" % (re.escape(grml_flavour), re.escape(str(DATESTAMP))))
1284 if flavour.match(line):
1285 grub_flavour_config = False
1287 if grub_flavour_config:
1288 grub1_config_file = open(grub1_cfg, 'a')
1289 grub1_config_file.write(generate_flavour_specific_grub1_config(grml_flavour, install_partition, bootopt))
1290 grub1_config_file.close()
1292 # make sure grub.conf isn't a symlink but a plain file instead,
1293 # otherwise it will break on FAT16 filesystems
1294 # this works around grub-install of (at least) Fedora 10
1295 if os.path.isfile(grub1_cfg):
1296 grubconf = grub_target + 'grub.conf'
1297 if not os.path.islink(grubconf):
1299 shutil.copyfile(grub1_cfg, grub_target + 'grub.conf')
1301 def handle_grub2_config(grml_flavour, grub_target, bootopt):
1302 """Main handler for generating grub2 configuration
1304 @grml_flavour: name of grml flavour the configuration should be generated for
1305 @grub_target: path of grub's configuration files
1306 @bootoptions: additional bootoptions that should be used by default"""
1309 grub2_cfg = grub_target + 'grub.cfg'
1310 logging.debug("Creating grub2 configuration file (grub.lst)")
1314 # install main configuration only *once*, no matter how many ISOs we have:
1315 grub_flavour_is_default = False
1316 if os.path.isfile(grub2_cfg):
1317 string = open(grub2_cfg).readline()
1318 main_identifier = re.compile(".*main config generated at: %s.*" % re.escape(str(DATESTAMP)))
1319 if not re.match(main_identifier, string):
1320 grub2_config_file = open(grub2_cfg, 'w')
1321 GRML_DEFAULT = grml_flavour
1322 grub_flavour_is_default = True
1323 grub2_config_file.write(generate_main_grub2_config(grml_flavour, bootopt))
1324 grub2_config_file.close()
1326 grub2_config_file = open(grub2_cfg, 'w')
1327 GRML_DEFAULT = grml_flavour
1328 grub_flavour_is_default = True
1329 grub2_config_file.write(generate_main_grub2_config(grml_flavour, bootopt))
1330 grub2_config_file.close()
1332 # install flavour specific configuration only *once* as well
1333 grub_flavour_config = True
1334 if os.path.isfile(grub2_cfg):
1335 string = open(grub2_cfg).readlines()
1336 flavour = re.compile("grml2usb for %s: %s" % (re.escape(grml_flavour), re.escape(str(DATESTAMP))))
1338 if flavour.match(line):
1339 grub_flavour_config = False
1341 if grub_flavour_config:
1342 grub2_config_file = open(grub2_cfg, 'a')
1343 # display only if the grml flavour isn't the default
1344 if not grub_flavour_is_default:
1345 GRML_FLAVOURS.add(grml_flavour)
1346 grub2_config_file.write(generate_flavour_specific_grub2_config(grml_flavour, bootopt))
1347 grub2_config_file.close()
1350 def handle_grub_config(grml_flavour, device, target):
1351 """Main handler for generating grub (v1 and v2) configuration
1353 @grml_flavour: name of grml flavour the configuration should be generated for
1354 @device: device/partition where grub should be installed to
1355 @target: path of grub's configuration files"""
1357 logging.debug("Generating grub configuration")
1359 grub_target = target + '/boot/grub/'
1360 execute(mkdir, grub_target)
1362 if os.path.isdir(device):
1363 install_grub1_partition = None
1365 if device[-1:].isdigit():
1366 install_grub1_partition = int(device[-1:]) - 1
1368 raise CriticalException("error validating partition schema (raw device?)")
1370 # do NOT write "None" in kernel cmdline
1371 if options.bootoptions is None:
1374 bootopt = options.bootoptions
1377 handle_grub1_config(grml_flavour, install_grub1_partition, grub_target, bootopt)
1379 handle_grub2_config(grml_flavour, grub_target, bootopt)
1382 def handle_syslinux_config(grml_flavour, target):
1383 """Main handler for generating syslinux configuration
1385 @grml_flavour: name of grml flavour the configuration should be generated for
1386 @target: path of syslinux's configuration files"""
1388 # do NOT write "None" in kernel cmdline
1389 if options.bootoptions is None:
1392 bootopt = options.bootoptions
1394 logging.debug("Generating syslinux configuration")
1395 syslinux_target = target + '/boot/syslinux/'
1396 # should be present via copy_bootloader_files(), but make sure it exits:
1397 execute(mkdir, syslinux_target)
1398 syslinux_cfg = syslinux_target + 'syslinux.cfg'
1402 # install main configuration only *once*, no matter how many ISOs we have:
1403 syslinux_flavour_is_default = False
1404 if os.path.isfile(syslinux_cfg):
1405 string = open(syslinux_cfg).readline()
1406 main_identifier = re.compile(".*main config generated at: %s.*" % re.escape(str(DATESTAMP)))
1407 if not re.match(main_identifier, string):
1408 syslinux_config_file = open(syslinux_cfg, 'w')
1409 GRML_DEFAULT = grml_flavour
1410 syslinux_flavour_is_default = True
1411 syslinux_config_file.write(generate_main_syslinux_config(grml_flavour, bootopt))
1412 syslinux_config_file.close()
1414 syslinux_config_file = open(syslinux_cfg, 'w')
1415 GRML_DEFAULT = grml_flavour
1416 syslinux_flavour_is_default = True
1417 syslinux_config_file.write(generate_main_syslinux_config(grml_flavour, bootopt))
1418 syslinux_config_file.close()
1420 # install flavour specific configuration only *once* as well
1421 syslinux_flavour_config = True
1422 if os.path.isfile(syslinux_cfg):
1423 string = open(syslinux_cfg).readlines()
1424 flavour = re.compile("grml2usb for %s: %s" % (re.escape(grml_flavour), re.escape(str(DATESTAMP))))
1426 if flavour.match(line):
1427 syslinux_flavour_config = False
1429 if syslinux_flavour_config:
1430 syslinux_config_file = open(syslinux_cfg, 'a')
1431 # display only if the grml flavour isn't the default
1432 if not syslinux_flavour_is_default:
1433 GRML_FLAVOURS.add(grml_flavour)
1434 syslinux_config_file.write(generate_flavour_specific_syslinux_config(grml_flavour, bootopt))
1435 syslinux_config_file.close()
1437 logging.debug("Generating isolinux/syslinux splash %s", syslinux_target + 'boot.msg')
1438 isolinux_splash = open(syslinux_target + 'boot.msg', 'w')
1439 isolinux_splash.write(generate_isolinux_splash(grml_flavour))
1440 isolinux_splash.close()
1443 def handle_bootloader_config(grml_flavour, device, target):
1444 """Main handler for generating bootloader's configuration
1446 @grml_flavour: name of grml flavour the configuration should be generated for
1447 @device: device/partition where bootloader should be installed to
1448 @target: path of bootloader's configuration files"""
1450 if options.skipsyslinuxconfig:
1451 logging.info("Skipping generation of syslinux configuration as requested.")
1454 handle_syslinux_config(grml_flavour, target)
1455 except CriticalException, error:
1456 logging.critical("Fatal: %s", error)
1459 if options.skipgrubconfig:
1460 logging.info("Skipping generation of grub configuration as requested.")
1463 handle_grub_config(grml_flavour, device, target)
1464 except CriticalException, error:
1465 logging.critical("Fatal: %s", error)
1468 def handle_dir(live_image, device):
1469 """Main logic for copying files of the currently running grml system.
1471 @live_image: directory where currently running live system resides (usually /live/image)
1472 @device: partition where the specified ISO should be installed to"""
1474 logging.info("Using %s as install base", live_image)
1476 if os.path.isdir(device):
1477 logging.info("Specified target is a directory, therefore not mounting.")
1478 device_mountpoint = device
1479 remove_device_mountpoint = False
1481 device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
1482 register_tmpfile(device_mountpoint)
1483 remove_device_mountpoint = True
1485 mount(device, device_mountpoint, "")
1486 except CriticalException, error:
1487 logging.critical("Fatal: %s", error)
1493 grml_flavour = identify_grml_flavour(live_image)
1494 logging.info("Identified grml flavour \"%s\".", grml_flavour)
1495 install_iso_files(grml_flavour, live_image, device, device_mountpoint)
1497 logging.critical("Fatal: a critical error happend during execution (not a grml ISO?), giving up")
1500 if remove_device_mountpoint:
1502 unmount(device_mountpoint, "")
1503 if os.path.isdir(device_mountpoint):
1504 os.rmdir(device_mountpoint)
1505 unregister_tmpfile(device_mountpoint)
1506 except CriticalException, error:
1507 logging.critical("Fatal: %s", error)
1511 def handle_iso(iso, device):
1512 """Main logic for mounting ISOs and copying files.
1514 @iso: full path to the ISO that should be installed to the specified device
1515 @device: partition where the specified ISO should be installed to"""
1517 logging.info("Using ISO %s", iso)
1519 iso_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
1520 register_tmpfile(iso_mountpoint)
1521 remove_iso_mountpoint = True
1523 if not os.path.isfile(iso):
1524 logging.critical("Fatal: specified ISO %s could not be read", iso)
1529 mount(iso, iso_mountpoint, ["-o", "loop", "-t", "iso9660"])
1530 except CriticalException, error:
1531 logging.critical("Fatal: %s", error)
1534 if os.path.isdir(device):
1535 logging.info("Specified target is a directory, therefore not mounting.")
1536 device_mountpoint = device
1537 remove_device_mountpoint = False
1540 device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
1541 register_tmpfile(device_mountpoint)
1542 remove_device_mountpoint = True
1544 mount(device, device_mountpoint, "")
1545 except CriticalException, error:
1546 logging.critical("Fatal: %s", error)
1552 grml_flavour = identify_grml_flavour(iso_mountpoint)
1553 logging.info("Identified grml flavour \"%s\".", grml_flavour)
1554 install_iso_files(grml_flavour, iso_mountpoint, device, device_mountpoint)
1556 logging.critical("Fatal: a critical error happend during execution (not a grml ISO?), giving up")
1559 if os.path.isdir(iso_mountpoint) and remove_iso_mountpoint:
1560 unmount(iso_mountpoint, "")
1561 os.rmdir(iso_mountpoint)
1562 unregister_tmpfile(iso_mountpoint)
1563 if remove_device_mountpoint:
1565 unmount(device_mountpoint, "")
1566 if os.path.isdir(device_mountpoint):
1567 os.rmdir(device_mountpoint)
1568 unregister_tmpfile(device_mountpoint)
1569 except CriticalException, error:
1570 logging.critical("Fatal: %s", error)
1574 def handle_mbr(device):
1575 """Main handler for installing master boot record (MBR)
1577 @device: device where the MBR should be installed to"""
1580 logging.info("Would install MBR")
1583 if device[-1:].isdigit():
1584 mbr_device = re.match(r'(.*?)\d*$', device).group(1)
1585 partition_number = int(device[-1:]) - 1
1586 skip_install_mir_mbr = False
1588 # if we get e.g. /dev/loop1 as device we don't want to put the MBR
1589 # into /dev/loop of course, therefore use /dev/loop1 as mbr_device
1590 if mbr_device == "/dev/loop":
1592 logging.info("Detected loop device - using %s as MBR device therefore", mbr_device)
1593 skip_install_mir_mbr = True
1596 if options.syslinuxmbr:
1597 handle_syslinux_mbr(mbr_device)
1598 elif not skip_install_mir_mbr:
1600 install_mir_mbr(GRML2USB_BASE + '/mbr/mbrmgr', mbr_device, partition_number, True)
1602 install_mir_mbr(GRML2USB_BASE + '/mbr/mbrldr', mbr_device, partition_number, False)
1603 except IOError, error:
1604 logging.critical("Execution failed: %s", error)
1606 except Exception, error:
1607 logging.critical("Execution failed: %s", error)
1611 def handle_vfat(device):
1612 """Check for FAT specific settings and options
1614 @device: device that should checked / formated"""
1616 # make sure we have mkfs.vfat available
1618 if not which("mkfs.vfat") and not options.copyonly and not options.dryrun:
1619 logging.critical('Sorry, mkfs.vfat not available. Exiting.')
1620 logging.critical('Please make sure to install dosfstools.')
1625 print "Forcing mkfs.fat16 on %s as requested via option --force." % device
1628 # make sure the user is aware of what he is doing
1629 f = raw_input("Are you sure you want to format the specified partition with fat16? y/N ")
1630 if f == "y" or f == "Y":
1631 logging.info("Note: you can skip this question using the option --force")
1637 except CriticalException, error:
1638 logging.critical("Execution failed: %s", error)
1643 # check for vfat filesystem
1644 if device is not None and not os.path.isdir(device):
1646 check_for_fat(device)
1647 except CriticalException, error:
1648 logging.critical("Execution failed: %s", error)
1651 if not os.path.isdir(device) and not check_for_usbdevice(device):
1652 print "Warning: the specified device %s does not look like a removable usb device." % device
1653 f = raw_input("Do you really want to continue? y/N ")
1654 if f == "y" or f == "Y":
1660 def handle_compat_warning(device):
1661 """Backwards compatible checks
1663 @device: device that should be checked"""
1665 # make sure we can replace old grml2usb script and warn user when using old way of life:
1666 if device.startswith("/mnt/external") or device.startswith("/mnt/usb") and not options.force:
1667 print "Warning: the semantics of grml2usb has changed."
1668 print "Instead of using grml2usb /path/to/iso %s you might" % device
1669 print "want to use grml2usb /path/to/iso /dev/... instead."
1670 print "Please check out the grml2usb manpage for details."
1671 f = raw_input("Do you really want to continue? y/N ")
1672 if f == "y" or f == "Y":
1678 def handle_logging():
1679 """Log handling and configuration"""
1681 if options.verbose and options.quiet:
1682 parser.error("please use either verbose (--verbose) or quiet (--quiet) option")
1685 FORMAT = "Debug: %(asctime)-15s %(message)s"
1686 logging.basicConfig(level=logging.DEBUG, format=FORMAT)
1688 FORMAT = "Critical: %(message)s"
1689 logging.basicConfig(level=logging.CRITICAL, format=FORMAT)
1691 FORMAT = "%(message)s"
1692 logging.basicConfig(level=logging.INFO, format=FORMAT)
1695 def handle_bootloader(device):
1696 """wrapper for installing bootloader
1698 @device: device where bootloader should be installed to"""
1700 # Install bootloader only if not using the --copy-only option
1701 if options.copyonly:
1702 logging.info("Not installing bootloader and its files as requested via option copyonly.")
1703 elif os.path.isdir(device):
1704 logging.info("Not installing bootloader as %s is a directory.", device)
1706 install_bootloader(device)
1710 """Main function [make pylint happy :)]"""
1713 print os.path.basename(sys.argv[0]) + " " + PROG_VERSION
1717 parser.error("invalid usage")
1722 # make sure we have the appropriate permissions
1725 logging.info("Executing grml2usb version %s", PROG_VERSION)
1728 logging.info("Running in simulation mode as requested via option dry-run.")
1730 # specified arguments
1731 device = args[len(args) - 1]
1732 isos = args[0:len(args) - 1]
1734 if not os.path.isdir(device):
1735 if device[-1:].isdigit():
1736 if int(device[-1:]) > 4 or device[-2:].isdigit():
1737 logging.critical("Fatal: installation on partition number >4 not supported. (BIOS won't support it.)")
1740 if os.path.exists(device):
1741 logging.critical("Fatal: installation on raw device not supported. (BIOS won't support it.)")
1744 if not which("rsync"):
1745 logging.critical("Fatal: rsync not available, can not continue - sorry.")
1748 # provide upgrade path
1749 handle_compat_warning(device)
1751 # check for vfat partition
1754 # main operation (like installing files)
1756 if os.path.isdir(iso):
1757 handle_dir(iso, device)
1759 handle_iso(iso, device)
1762 if not os.path.isdir(device):
1763 if not options.skipmbr:
1766 handle_bootloader(device)
1768 logging.info("Note: grml flavour %s was installed as the default booting system.", GRML_DEFAULT)
1770 for flavour in GRML_FLAVOURS:
1771 logging.info("Note: you can boot flavour %s using '%s' on the commandline.", flavour, flavour)
1773 # finally be politely :)
1774 logging.info("Finished execution of grml2usb (%s). Have fun with your grml system.", PROG_VERSION)
1777 if __name__ == "__main__":
1780 except KeyboardInterrupt:
1781 logging.info("Received KeyboardInterrupt")
1784 ## END OF FILE #################################################################
1785 # vim:foldmethod=indent expandtab ai ft=python tw=120 fileencoding=utf-8