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
21 PROG_VERSION = "0.9.2"
22 MOUNTED = set() # register mountpoints
23 TMPFILES = set() # register tmpfiles
24 DATESTAMP = time.mktime(datetime.datetime.now().timetuple()) # unique identifier for syslinux.cfg
27 USAGE = "Usage: %prog [options] <[ISO[s] | /live/image]> </dev/sdX#>\n\
29 %prog installs grml ISO[s] to an USB device to be able to boot from it.\n\
30 Make sure you have at least one grml ISO or a running grml system (/live/image),\n\
31 grub or syslinux and root access.\n\
33 Execute %prog --help for usage hints, further information can be found in: man grml2usb"
35 # pylint: disable-msg=C0103
36 parser = OptionParser(usage=USAGE)
37 parser.add_option("--bootoptions", dest="bootoptions",
38 action="store", type="string",
39 help="use specified bootoptions as default")
40 parser.add_option("--bootloader-only", dest="bootloaderonly", action="store_true",
41 help="do not copy files but just install a bootloader")
42 parser.add_option("--copy-only", dest="copyonly", action="store_true",
43 help="copy files only but do not install bootloader")
44 parser.add_option("--dry-run", dest="dryrun", action="store_true",
45 help="avoid executing commands")
46 parser.add_option("--fat16", dest="fat16", action="store_true",
47 help="format specified partition with FAT16")
48 parser.add_option("--force", dest="force", action="store_true",
49 help="force any actions requiring manual interaction")
50 #parser.add_option("--initrd", dest="initrd", action="store", type="string",
51 # help="install specified initrd instead of the default [TODO - not implemented yet]")
52 #parser.add_option("--kernel", dest="kernel", action="store", type="string",
53 # help="install specified kernel instead of the default [TODO - not implemented yet]")
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-manager", dest="mbrmgr", action="store_true",
57 help="enable interactive boot manager 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-mbr", dest="skipmbr", action="store_true",
63 help="do not install a master boot record (MBR) on the device")
64 parser.add_option("--syslinux", dest="syslinux", action="store_true",
65 help="install syslinux bootloader instead of grub")
66 parser.add_option("--syslinux-mbr", dest="syslinuxmbr", action="store_true",
67 help="install syslinux master boot record (MBR) instead of default")
68 #parser.add_option("--squashfs", dest="squashfs", action="store", type="string",
69 # help="install specified squashfs file instead of the default [TODO - not implemented yet]")
70 #parser.add_option("--uninstall", dest="uninstall", action="store_true",
71 # help="remove grml ISO files from specified device [TODO - not implemented yet]")
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 class CriticalException(Exception):
80 """Throw critical exception if the exact error is not known but fatal."
82 @Exception: message"""
87 """Cleanup function to make sure there aren't any mounted devices left behind.
90 logging.info("Cleaning up before exiting...")
91 proc = subprocess.Popen(["sync"])
95 for device in MOUNTED:
97 # ignore: RuntimeError: Set changed size during iteration
99 logging.debug('caught expection RuntimeError, ignoring')
102 def register_tmpfile(path):
104 TODO - not implemented yet
110 def unregister_tmpfile(path):
112 TODO - not implemented yet
116 TMPFILES.remove(path)
119 def register_mountpoint(target):
120 """register specified target in a set() for handling clean exiting
122 @target: destination target of mountpoint
128 def unregister_mountpoint(target):
129 """unregister specified target in a set() for handling clean exiting
131 @target: destination target of mountpoint
134 if target in MOUNTED:
135 MOUNTED.remove(target)
138 def get_function_name(obj):
139 """Helper function for use in execute() to retrive name of a function
141 @obj: the function object
143 if not (isroutine(obj) or isclass(obj)):
145 return obj.__module__ + '.' + obj.__name__
148 def execute(f, *exec_arguments):
149 """Wrapper for executing a command. Either really executes
150 the command (default) or when using --dry-run commandline option
151 just displays what would be executed."""
152 # usage: execute(subprocess.Popen, (["ls", "-la"]))
153 # TODO: doesn't work for proc = execute(subprocess.Popen...() -> any ideas?
155 # pylint: disable-msg=W0141
156 logging.debug('dry-run only: %s(%s)' % (get_function_name(f), ', '.join(map(repr, exec_arguments))))
158 # pylint: disable-msg=W0142
159 return f(*exec_arguments)
163 """Check whether a given file can be executed
165 @fpath: full path to file
167 return os.path.exists(fpath) and os.access(fpath, os.X_OK)
171 """Check whether a given program is available in PATH
173 @program: name of executable"""
174 fpath = os.path.split(program)[0]
179 for path in os.environ["PATH"].split(os.pathsep):
180 exe_file = os.path.join(path, program)
187 def search_file(filename, search_path='/bin' + os.pathsep + '/usr/bin'):
188 """Given a search path, find file
190 @filename: name of file to search for
191 @search_path: path where searching for the specified filename"""
193 paths = search_path.split(os.pathsep)
194 current_dir = '' # make pylint happy :)
196 # pylint: disable-msg=W0612
197 for current_dir, directories, files in os.walk(path):
198 if os.path.exists(os.path.join(current_dir, filename)):
202 return os.path.abspath(os.path.join(current_dir, filename))
207 def check_uid_root():
208 """Check for root permissions"""
209 if not os.geteuid()==0:
210 sys.exit("Error: please run this script with uid 0 (root).")
213 def mkfs_fat16(device):
214 """Format specified device with VFAT/FAT16 filesystem.
216 @device: partition that should be formated"""
218 # syslinux -d boot/isolinux /dev/sdb1
220 logging.info("Would execute mkfs.vfat -F 16 %s now.", device)
223 logging.info("Formating partition with fat16 filesystem")
224 logging.debug("mkfs.vfat -F 16 %s" % device)
225 proc = subprocess.Popen(["mkfs.vfat", "-F", "16", device])
227 if proc.returncode != 0:
228 raise CriticalException("error executing mkfs.vfat")
231 def generate_main_grub2_config(grml_flavour, install_partition, bootoptions):
232 """Generate grub2 configuration for use via grub.cfg
234 @grml_flavour: name of grml flavour the configuration should be generated for
235 @install_partition: partition number for use in (hd0,X)
236 @bootoptions: additional bootoptions that should be used by default"""
238 local_datestamp = DATESTAMP
241 ## main grub2 configuration - generated by grml2usb [main config generated at: %(local_datestamp)s]
247 if font (hd0,%(install_partition)s)/boot/grub/ascii.pff ; then
255 if background_image (hd0,%(install_partition)s)/boot/grub/grml.png ; then
256 set color_normal=black/black
257 set color_highlight=red/black
259 set menu_color_normal=white/black
260 set menu_color_highlight=black/yellow
263 menuentry "%(grml_flavour)s (default)" {
264 set root=(hd0,%(install_partition)s)
265 linux /boot/release/%(grml_flavour)s/linux26 apm=power-off lang=us vga=791 quiet boot=live nomce live-media-path=/live/%(grml_flavour)s/ %(bootoptions)s
266 initrd /boot/release/%(grml_flavour)s/initrd.gz
269 menuentry "Memory test (memtest86+)" {
270 set root=(hd0,%(install_partition)s)
271 linux /boot/addons/memtest
274 menuentry "Grub - all in one image" {
275 set root=(hd0,%(install_partition)s)
276 linux /boot/addons/memdisk
277 initrd /boot/addons/allinone.img
280 menuentry "FreeDOS" {
281 set root=(hd0,%(install_partition)s)
282 linux /boot/addons/memdisk
283 initrd /boot/addons/balder10.imz
287 set root=(hd0,%(install_partition)s)
288 linux /boot/addons/bsd4grml/ldbsd.com
291 menuentry "Boot OS of first partition on first disk" {
296 """ % {'grml_flavour': grml_flavour, 'local_datestamp': local_datestamp,
297 'bootoptions': bootoptions, 'install_partition': install_partition } )
300 def generate_flavour_specific_grub2_config(grml_flavour, install_partition, bootoptions):
301 """Generate grub2 configuration for use via grub.cfg
303 @grml_flavour: name of grml flavour the configuration should be generated for
304 @install_partition: partition number for use in (hd0,X)
305 @bootoptions: additional bootoptions that should be used by default"""
307 local_datestamp = DATESTAMP
310 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
311 menuentry "%(grml_flavour)s" {
312 set root=(hd0,%(install_partition)s)
313 linux /boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ %(bootoptions)s
314 initrd /boot/release/%(grml_flavour)s/initrd.gz
317 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
318 menuentry "%(grml_flavour)s2ram" {
319 set root=(hd0,%(install_partition)s)
320 linux /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 %(bootoptions)s
321 initrd /boot/release/%(grml_flavour)s/initrd.gz
324 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
325 menuentry "%(grml_flavour)s-debug" {
326 set root=(hd0,%(install_partition)s)
327 linux /boot/release/%(grml_flavour)s/linux26
328 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
331 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
332 menuentry "%(grml_flavour)s-x" {
333 set root=(hd0,%(install_partition)s)
334 linux /boot/release/%(grml_flavour)s/linux26
335 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
338 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
339 menuentry "%(grml_flavour)s-nofb" {
340 set root=(hd0,%(install_partition)s)
341 linux /boot/release/%(grml_flavour)s/linux26
342 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
345 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
346 menuentry "%(grml_flavour)s-failsafe" {
347 set root=(hd0,%(install_partition)s)
348 linux /boot/release/%(grml_flavour)s/linux26
349 initrd /boot/release/%(grml_flavour)s/initrd.gz apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ vga=normal lang=us boot=live noautoconfig atapicd noacpi acpi=off nomodules nofirewire noudev nousb nohotplug noapm nopcmcia maxcpus=1 noscsi noagp nodma ide=nodma noswap nofstab nosound nogpm nosyslog nodhcp nocpu nodisc nomodem xmodule=vesa noraid nolvm %(bootoptions)s
352 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
353 menuentry "%(grml_flavour)s-forensic" {
354 set root=(hd0,%(install_partition)s)
355 linux /boot/release/%(grml_flavour)s/linux26
356 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 %(bootoptions)s
359 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
360 menuentry "%(grml_flavour)s-serial" {
361 set root=(hd0,%(install_partition)s)
362 linux /boot/release/%(grml_flavour)s/linux26
363 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
366 """ % {'grml_flavour': grml_flavour, 'local_datestamp': local_datestamp,
367 'bootoptions': bootoptions, 'install_partition': install_partition } )
370 def generate_flavour_specific_grub1_config(grml_flavour, install_partition, bootoptions):
371 """Generate grub1 configuration for use via menu.lst
373 @grml_flavour: name of grml flavour the configuration should be generated for
374 @install_partition: partition number for use in (hd0,X)
375 @bootoptions: additional bootoptions that should be used by default"""
377 local_datestamp = DATESTAMP
380 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
381 title %(grml_flavour)s
382 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
383 initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
385 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
386 title %(grml_flavour)s2ram
387 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 %(bootoptions)s
388 initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
390 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
391 title %(grml_flavour)s-debug
392 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
393 initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
395 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
396 title %(grml_flavour)s-x
397 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
398 initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
400 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
401 title %(grml_flavour)s-nofb
402 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
403 initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
405 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
406 title %(grml_flavour)s-failsafe
407 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 lang=us boot=live noautoconfig atapicd noacpi acpi=off nomodules nofirewire noudev nousb nohotplug noapm nopcmcia maxcpus=1 noscsi noagp nodma ide=nodma noswap nofstab nosound nogpm nosyslog nodhcp nocpu nodisc nomodem xmodule=vesa noraid nolvm %(bootoptions)s
408 initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
410 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
411 title %(grml_flavour)s-forensic
412 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 %(bootoptions)s
413 initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
415 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
416 title %(grml_flavour)s-serial
417 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
418 initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
420 """ % {'grml_flavour': grml_flavour, 'local_datestamp': local_datestamp,
421 'bootoptions': bootoptions, 'install_partition': install_partition } )
424 def generate_main_grub1_config(grml_flavour, install_partition, bootoptions):
425 """Generate grub1 configuration for use via menu.lst
427 @grml_flavour: name of grml flavour the configuration should be generated for"""
429 local_datestamp = DATESTAMP
432 ## main grub1 configuration - generated by grml2usb [main config generated at: %(local_datestamp)s]
435 # color red/blue green/black
436 splashimage=(hd0,%(install_partition)s)/boot/grub/splash.xpm.gz
441 title %(grml_flavour)s - Default boot (using 1024x768 framebuffer)
442 kernel (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/linux26 apm=power-off lang=us vga=791 quiet boot=live nomce live-media-path=/live/%(grml_flavour)s/
443 initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
445 title Memory test (memtest86+)
446 kernel (hd0,%(install_partition)s)/boot/addons/memtest
448 title Grub - all in one image
449 kernel (hd0,%(install_partition)s)/boot/addons/memdisk
450 initrd (hd0,%(install_partition)s)/boot/addons/allinone.img
453 kernel (hd0,%(install_partition)s)/boot/addons/memdisk
454 initrd (hd0,%(install_partition)s)/boot/addons/balder10.imz
457 kernel (hd0,%(install_partition)s)/boot/addons/bsd4grml/ldbsd.com
459 """ % {'grml_flavour': grml_flavour, 'local_datestamp': local_datestamp,
460 'bootoptions': bootoptions, 'install_partition': install_partition } )
463 def generate_isolinux_splash(grml_flavour):
464 """Generate bootsplash for isolinux/syslinux
466 @grml_flavour: name of grml flavour the configuration should be generated for"""
468 # TODO: adjust last bootsplash line (the one following the "Some information and boot ...")
470 grml_name = grml_flavour
473 \ f17
\f\18/boot/syslinux/logo.16
475 Some information and boot options available via keys F2 - F10. http://grml.org/
477 """ % {'grml_name': grml_name} )
480 def generate_main_syslinux_config(grml_flavour, bootoptions):
481 """Generate main configuration for use in syslinux.cfg
483 @grml_flavour: name of grml flavour the configuration should be generated for
484 @bootoptions: additional bootoptions that should be used by default"""
486 local_datestamp = DATESTAMP
489 ## main syslinux configuration - generated by grml2usb [main config generated at: %(local_datestamp)s]
490 # use this to control the bootup via a serial port
495 DISPLAY /boot/syslinux/boot.msg
496 F1 /boot/syslinux/boot.msg
505 F10 /boot/syslinux/f10
506 ## end of main configuration
508 ## global configuration
509 # the default option (using %(grml_flavour)s)
511 KERNEL /boot/release/%(grml_flavour)s/linux26
512 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
516 KERNEL /boot/addons/memtest
521 KERNEL /boot/addons/memdisk
522 APPEND initrd=/boot/addons/allinone.img
527 KERNEL /boot/addons/memdisk
528 APPEND initrd=/boot/addons/balder10.imz
533 KERNEL /boot/addons/bsd4grml/ldbsd.com
535 ## end of global configuration
536 """ % {'grml_flavour': grml_flavour, 'local_datestamp': local_datestamp, 'bootoptions': bootoptions} )
539 def generate_flavour_specific_syslinux_config(grml_flavour, bootoptions):
540 """Generate flavour specific configuration for use in syslinux.cfg
542 @grml_flavour: name of grml flavour the configuration should be generated for
543 @bootoptions: bootoptions that should be used as a default"""
545 local_datestamp = DATESTAMP
549 # flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
550 LABEL %(grml_flavour)s
551 KERNEL /boot/release/%(grml_flavour)s/linux26
552 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
554 # flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
555 LABEL %(grml_flavour)s2ram
556 KERNEL /boot/release/%(grml_flavour)s/linux26
557 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 %(bootoptions)s
559 # flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
560 LABEL %(grml_flavour)s-debug
561 KERNEL /boot/release/%(grml_flavour)s/linux26
562 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
564 # flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
565 LABEL %(grml_flavour)s-x
566 KERNEL /boot/release/%(grml_flavour)s/linux26
567 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
569 # flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
570 LABEL %(grml_flavour)s-nofb
571 KERNEL /boot/release/%(grml_flavour)s/linux26
572 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
574 # flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
575 LABEL %(grml_flavour)s-failsafe
576 KERNEL /boot/release/%(grml_flavour)s/linux26
577 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 lang=us boot=live noautoconfig atapicd noacpi acpi=off nomodules nofirewire noudev nousb nohotplug noapm nopcmcia maxcpus=1 noscsi noagp nodma ide=nodma noswap nofstab nosound nogpm nosyslog nodhcp nocpu nodisc nomodem xmodule=vesa noraid nolvm %(bootoptions)s
579 # flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
580 LABEL %(grml_flavour)s-forensic
581 KERNEL /boot/release/%(grml_flavour)s/linux26
582 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 %(bootoptions)s
584 # flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
585 LABEL %(grml_flavour)s-serial
586 KERNEL /boot/release/%(grml_flavour)s/linux26
587 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
588 """ % {'grml_flavour': grml_flavour, 'local_datestamp': local_datestamp, 'bootoptions': bootoptions} )
591 def install_grub(device):
592 """Install grub on specified device.
594 @mntpoint: mountpoint of device where grub should install its files to
595 @device: partition where grub should be installed to"""
598 logging.info("Would execute grub-install [--root-directory=mount_point] %s now.", device)
600 device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
601 register_tmpfile(device_mountpoint)
603 mount(device, device_mountpoint, "")
604 logging.debug("grub-install --recheck --no-floppy --root-directory=%s %s", device_mountpoint, device)
605 proc = subprocess.Popen(["grub-install", "--recheck", "--no-floppy",
606 "--root-directory=%s" % device_mountpoint, device], stdout=file(os.devnull, "r+"))
608 if proc.returncode != 0:
609 raise Exception("error executing grub-install")
610 except CriticalException, error:
611 logging.critical("Fatal: %s" % error)
616 unmount(device_mountpoint, "")
617 os.rmdir(device_mountpoint)
618 unregister_tmpfile(device_mountpoint)
621 def install_syslinux(device):
622 """Install syslinux on specified device.
624 @device: partition where syslinux should be installed to"""
627 logging.info("Would install syslinux as bootloader on %s", device)
630 # syslinux -d boot/isolinux /dev/sdb1
631 logging.info("Installing syslinux as bootloader")
632 logging.debug("syslinux -d boot/syslinux %s" % device)
633 proc = subprocess.Popen(["syslinux", "-d", "boot/syslinux", device])
635 if proc.returncode != 0:
636 raise CriticalException("Error executing syslinux (either try --fat16 or --grub?)")
639 def install_bootloader(device):
640 """Install bootloader on specified device.
642 @device: partition where bootloader should be installed to"""
644 # by default we use grub, so install syslinux only on request
647 install_syslinux(device)
648 except CriticalException, error:
649 logging.critical("Fatal: %s" % error)
655 except CriticalException, error:
656 logging.critical("Fatal: %s" % error)
661 def execute_lilo(lilo, device):
662 """execute lilo for activating the partitions in the MBR
664 @lilo: path of lilo executable
665 @device: device where lilo should be executed on"""
667 # to support -A for extended partitions:
668 logging.info("Activating partitions in MBR via lilo")
669 logging.debug("%s -S /dev/null -M %s ext" % (lilo, device))
670 proc = subprocess.Popen([lilo, "-S", "/dev/null", "-M", device, "ext"])
672 if proc.returncode != 0:
673 raise Exception("error executing lilo")
675 # activate partition:
676 logging.debug("%s -S /dev/null -A %s 1" % (lilo, device))
677 proc = subprocess.Popen([lilo, "-S", "/dev/null", "-A", device, "1"])
679 if proc.returncode != 0:
680 raise Exception("error executing lilo")
683 def install_syslinux_mbr(device):
684 """install syslinux's master boot record (MBR) on the specified device
686 @device: device where MBR of syslinux should be installed to"""
688 # lilo's mbr is broken, use the one from syslinux instead:
689 if not os.path.isfile("/usr/lib/syslinux/mbr.bin"):
690 raise Exception("/usr/lib/syslinux/mbr.bin can not be read")
692 logging.info("Installing syslinux MBR")
693 logging.debug("cat /usr/lib/syslinux/mbr.bin > %s" % device)
695 # TODO -> use Popen instead?
696 retcode = subprocess.call("cat /usr/lib/syslinux/mbr.bin > "+ device, shell=True)
698 logging.critical("Error copying MBR to device (%s)" % retcode)
699 except OSError, error:
700 logging.critical("Execution failed:", error)
703 def install_mir_mbr(mbrtemplate, device, partition, ismirbsdmbr=True):
704 """install 'mbr' master boot record (MBR) on a device
706 Retrieve the partition table from "device", install an MBR from
707 the "mbrtemplate" file, set the "partition" (0..3) active, and
708 install the result back to "device".
710 @mbrtemplate: default MBR file
712 @device: name of a file assumed to be a hard disc (or USB stick) image,
713 or something like "/dev/sdb"
714 @partition: must be a number between 0 and 3, inclusive
716 @mbrtemplate: must be a valid MBR file of at least 440 (or 439
717 if ismirbsdmbr) bytes.
719 @ismirbsdmbr: if set the partitions' active flags are not changed.
720 Instead, the MBR's default value is set accordingly."""
722 logging.info("Installing default MBR")
724 if not os.path.isfile(mbrtemplate):
725 logging.critical("Error: %s can not be read." % mbrtemplate)
726 raise CriticalException("Error installing MBR (either try --syslinux-mbr or install missing file?)")
728 if (partition < 0) or (partition > 3):
729 raise ValueError("partition must be between 0 and 3")
736 tmpf = tempfile.NamedTemporaryFile()
738 logging.debug("executing: dd if='%s' of='%s' bs=512 count=1" % (device, tmpf.name))
739 proc = subprocess.Popen(["dd", "if=%s" % device, "of=%s" % tmpf.name, "bs=512", "count=1"], stderr=file(os.devnull, "r+"))
741 if proc.returncode != 0:
742 raise Exception("error executing dd (first run)")
744 logging.debug("executing: dd if=%s of=%s bs=%s count=1 conv=notrunc" % (mbrtemplate,
745 tmpf.name, nmbrbytes))
746 proc = subprocess.Popen(["dd", "if=%s" % mbrtemplate, "of=%s" % tmpf.name, "bs=%s" % nmbrbytes,
747 "count=1", "conv=notrunc"], stderr=file(os.devnull, "r+"))
749 if proc.returncode != 0:
750 raise Exception("error executing dd (second run)")
752 mbrcode = tmpf.file.read(512)
753 if len(mbrcode) < 512:
754 raise EOFError("MBR size (%d) < 512" % len(mbrcode))
757 mbrcode = mbrcode[0:439] + chr(partition) + \
758 mbrcode[440:510] + "\x55\xAA"
760 actives = ["\x00", "\x00", "\x00", "\x00"]
761 actives[partition] = "\x80"
762 mbrcode = mbrcode[0:446] + actives[0] + \
763 mbrcode[447:462] + actives[1] + \
764 mbrcode[463:478] + actives[2] + \
765 mbrcode[479:494] + actives[3] + \
766 mbrcode[495:510] + "\x55\xAA"
770 tmpf.file.write(mbrcode)
773 logging.debug("executing: dd if='%s' of='%s' bs=512 count=1 conv=notrunc" % (tmpf.name, device))
774 proc = subprocess.Popen(["dd", "if=%s" % tmpf.name, "of=%s" % device, "bs=512", "count=1",
775 "conv=notrunc"], stderr=file(os.devnull, "r+"))
777 if proc.returncode != 0:
778 raise Exception("error executing dd (third run)")
782 def handle_syslinux_mbr(device):
783 """Install syslinux master boot record on given device
785 @device: device where MBR should be installed to"""
787 if not is_writeable(device):
788 raise IOError("device not writeable for user")
790 # try to use system's lilo
794 # otherwise fall back to our static version
795 from platform import architecture
796 if architecture()[0] == '64bit':
797 lilo = '/usr/share/grml2usb/lilo/lilo.static.amd64'
799 lilo = '/usr/share/grml2usb/lilo/lilo.static.i386'
800 # finally prefer a specified lilo executable
802 lilo = options.lilobin
805 raise Exception("lilo executable can not be execute")
808 logging.info("Would install MBR running lilo and using syslinux.")
811 execute_lilo(lilo, device)
812 install_syslinux_mbr(device)
815 def is_writeable(device):
816 """Check if the device is writeable for the current user
818 @device: partition where bootloader should be installed to"""
822 #raise Exception("no device for checking write permissions")
824 if not os.path.exists(device):
827 return os.access(device, os.W_OK) and os.access(device, os.R_OK)
830 def mount(source, target, mount_options):
831 """Mount specified source on given target
833 @source: name of device/ISO that should be mounted
834 @target: directory where the ISO should be mounted to
835 @options: mount specific options"""
837 # note: options.dryrun does not work here, as we have to
838 # locate files and identify the grml flavour
840 for x in file('/proc/mounts').readlines():
841 if x.startswith(source):
842 raise CriticalException("Error executing mount: %s already mounted - please unmount before invoking grml2usb" % source)
844 if os.path.isdir(source):
845 logging.debug("Source %s is not a device, not mounting therefor." % source)
848 logging.debug("mount %s %s %s" % (mount_options, source, target))
849 proc = subprocess.Popen(["mount"] + list(mount_options) + [source, target])
851 if proc.returncode != 0:
852 raise CriticalException("Error executing mount (no filesystem on the partition?)")
854 logging.debug("register_mountpoint(%s)" % target)
855 register_mountpoint(target)
858 def unmount(target, unmount_options):
859 """Unmount specified target
861 @target: target where something is mounted on and which should be unmounted
862 @options: options for umount command"""
864 # make sure we unmount only already mounted targets
865 target_unmount = False
866 mounts = open('/proc/mounts').readlines()
867 mountstring = re.compile(".*%s.*" % re.escape(target))
869 if re.match(mountstring, line):
870 target_unmount = True
872 if not target_unmount:
873 logging.debug("%s not mounted anymore" % target)
875 logging.debug("umount %s %s" % (list(unmount_options), target))
876 proc = subprocess.Popen(["umount"] + list(unmount_options) + [target])
878 if proc.returncode != 0:
879 raise Exception("Error executing umount")
881 logging.debug("unregister_mountpoint(%s)" % target)
882 unregister_mountpoint(target)
885 def check_for_usbdevice(device):
886 """Check whether the specified device is a removable USB device
888 @device: device name, like /dev/sda1 or /dev/sda
891 usbdevice = re.match(r'/dev/(.*?)\d*$', device).group(1)
892 usbdevice = os.path.realpath('/sys/class/block/' + usbdevice + '/removable')
893 if os.path.isfile(usbdevice):
894 is_usb = open(usbdevice).readline()
901 def check_for_fat(partition):
902 """Check whether specified partition is a valid VFAT/FAT16 filesystem
904 @partition: device name of partition"""
907 udev_info = subprocess.Popen(["/lib/udev/vol_id", "-t", partition],
908 stdout=subprocess.PIPE, stderr=subprocess.PIPE)
909 filesystem = udev_info.communicate()[0].rstrip()
911 if udev_info.returncode == 2:
912 raise CriticalException("Failed to read device %s"
913 " (wrong UID/permissions or device/directory not present?)" % partition)
915 if options.syslinux and filesystem != "vfat":
916 raise CriticalException("Partition %s does not contain a FAT16 filesystem. (Use --fat16 or run mkfs.vfat %s)" % (partition, partition))
919 raise CriticalException("Sorry, /lib/udev/vol_id not available.")
922 def mkdir(directory):
923 """Simple wrapper around os.makedirs to get shell mkdir -p behaviour"""
925 # just silently pass as it's just fine it the directory exists
926 if not os.path.isdir(directory):
928 os.makedirs(directory)
929 # pylint: disable-msg=W0704
934 def copy_system_files(grml_flavour, iso_mount, target):
935 """copy grml's main files (like squashfs, kernel and initrd) to a given target
937 @grml_flavour: name of grml flavour the configuration should be generated for
938 @iso_mount: path where a grml ISO is mounted on
939 @target: path where grml's main files should be copied to"""
941 squashfs = search_file(grml_flavour + '.squashfs', iso_mount)
943 logging.critical("Fatal: squashfs file not found")
945 squashfs_target = target + '/live/' + grml_flavour + '/'
946 execute(mkdir, squashfs_target)
947 logging.debug("cp %s %s" % (squashfs, squashfs_target + grml_flavour + '.squashfs'))
948 proc = subprocess.Popen(["cp", squashfs, squashfs_target + grml_flavour + ".squashfs"])
951 filesystem_module = search_file('filesystem.module', iso_mount)
952 if filesystem_module is None:
953 logging.critical("Fatal: filesystem.module not found")
955 logging.debug("cp %s %s" % (filesystem_module, squashfs_target + 'filesystem.module'))
956 proc = subprocess.Popen(["cp", filesystem_module, squashfs_target + 'filesystem.module'])
959 release_target = target + '/boot/release/' + grml_flavour
960 execute(mkdir, release_target)
962 kernel = search_file('linux26', iso_mount)
964 logging.critical("Fatal kernel not found")
966 logging.debug("cp %s %s" % (kernel, release_target + '/linux26'))
967 proc = subprocess.Popen(["cp", kernel, release_target + '/linux26'])
970 initrd = search_file('initrd.gz', iso_mount)
972 logging.critical("Fatal: initrd not found")
974 logging.debug("cp %s %s" % (initrd, release_target + '/initrd.gz'))
975 proc = subprocess.Popen(["cp", initrd, release_target + '/initrd.gz'])
979 def copy_grml_files(iso_mount, target):
980 """copy some minor grml files to a given target
982 @iso_mount: path where a grml ISO is mounted on
983 @target: path where grml's main files should be copied to"""
985 grml_target = target + '/grml/'
986 execute(mkdir, grml_target)
988 for myfile in 'grml-cheatcodes.txt', 'grml-version', 'LICENSE.txt', 'md5sums', 'README.txt':
989 grml_file = search_file(myfile, iso_mount)
990 if grml_file is None:
991 logging.warn("Warning: myfile %s could not be found - can not install it", myfile)
993 logging.debug("cp %s %s" % (grml_file, grml_target + grml_file))
994 proc = subprocess.Popen(["cp", grml_file, grml_target + myfile])
997 grml_web_target = grml_target + '/web/'
998 execute(mkdir, grml_web_target)
1000 for myfile in 'index.html', 'style.css':
1001 grml_file = search_file(myfile, iso_mount)
1002 if grml_file is None:
1003 logging.warn("Warning: myfile %s could not be found - can not install it")
1005 logging.debug("cp %s %s" % (grml_file, grml_web_target + grml_file))
1006 proc = subprocess.Popen(["cp", grml_file, grml_web_target + myfile])
1009 grml_webimg_target = grml_web_target + '/images/'
1010 execute(mkdir, grml_webimg_target)
1012 for myfile in 'button.png', 'favicon.png', 'linux.jpg', 'logo.png':
1013 grml_file = search_file(myfile, iso_mount)
1014 if grml_file is None:
1015 logging.warn("Warning: myfile %s could not be found - can not install it")
1017 logging.debug("cp %s %s" % (grml_file, grml_webimg_target + grml_file))
1018 proc = subprocess.Popen(["cp", grml_file, grml_webimg_target + myfile])
1022 def copy_addons(iso_mount, target):
1023 """copy grml's addons files (like allinoneimg, bsd4grml,..) to a given target
1025 @iso_mount: path where a grml ISO is mounted on
1026 @target: path where grml's main files should be copied to"""
1028 addons = target + '/boot/addons/'
1029 execute(mkdir, addons)
1031 # grub all-in-one image
1032 allinoneimg = search_file('allinone.img', iso_mount)
1033 if allinoneimg is None:
1034 logging.warn("Warning: allinone.img not found - can not install it...")
1035 logging.warn(" |-> that's fine if you don't need it - or are you using grml-small?")
1037 logging.debug("cp %s %s" % (allinoneimg, addons + '/allinone.img'))
1038 proc = subprocess.Popen(["cp", allinoneimg, addons + 'allinone.img'])
1042 bsdimg = search_file('bsd4grml', iso_mount)
1044 logging.warn("Warning: bsd4grml not found - can not install it...")
1045 logging.warn(" |-> that's fine if you don't need it - or are you using grml-small?")
1047 logging.debug("cp -a %s %s" % (bsdimg, addons + '/'))
1048 proc = subprocess.Popen(["cp", "-a", bsdimg, addons + '/'])
1052 balderimg = search_file('balder10.imz', iso_mount)
1053 if balderimg is None:
1054 logging.warn("Warning: balder10.imz not found - can not install it...")
1055 logging.warn(" |-> that's fine if you don't need it - or are you using grml-small?")
1057 logging.debug("cp %s %s" % (balderimg, addons + '/balder10.imz'))
1058 proc = subprocess.Popen(["cp", balderimg, addons + 'balder10.imz'])
1062 memdiskimg = search_file('memdisk', iso_mount)
1063 if memdiskimg is None:
1064 logging.warn("Warning: memdisk not found - can not install it...")
1065 logging.warn(" |-> that's fine if you don't need it - or are you using grml-small?")
1067 logging.debug("cp %s %s" % (memdiskimg, addons + '/memdisk'))
1068 proc = subprocess.Popen(["cp", memdiskimg, addons + 'memdisk'])
1072 memtestimg = search_file('memtest', iso_mount)
1073 if memtestimg is None:
1074 logging.warn("Warning: memtest not found - can not install it...")
1075 logging.warn(" |-> that's fine if you don't need it - or are you using grml-small?")
1077 logging.debug("cp %s %s" % (memtestimg, addons + '/memtest'))
1078 proc = subprocess.Popen(["cp", memtestimg, addons + 'memtest'])
1082 def copy_bootloader_files(iso_mount, target):
1083 """copy grml's bootloader files to a given target
1085 @iso_mount: path where a grml ISO is mounted on
1086 @target: path where grml's main files should be copied to"""
1088 syslinux_target = target + '/boot/syslinux/'
1089 execute(mkdir, syslinux_target)
1091 logo = search_file('logo.16', iso_mount)
1092 logging.debug("cp %s %s" % (logo, syslinux_target + 'logo.16'))
1093 proc = subprocess.Popen(["cp", logo, syslinux_target + 'logo.16'])
1096 for ffile in 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10':
1097 bootsplash = search_file(ffile, iso_mount)
1098 logging.debug("cp %s %s" % (bootsplash, syslinux_target + ffile))
1099 proc = subprocess.Popen(["cp", bootsplash, syslinux_target + ffile])
1102 grub_target = target + '/boot/grub/'
1103 execute(mkdir, grub_target)
1105 if not os.path.isfile("/usr/share/grml2usb/grub/splash.xpm.gz"):
1106 logging.critical("Error: /usr/share/grml2usb/grub/splash.xpm.gz can not be read.")
1109 logging.debug("cp /usr/share/grml2usb/grub/splash.xpm.gz %s" % grub_target + 'splash.xpm.gz')
1110 proc = subprocess.Popen(["cp", '/usr/share/grml2usb/grub/splash.xpm.gz',
1111 grub_target + 'splash.xpm.gz'])
1114 # grml splash in grub
1115 if os.path.isfile("/usr/share/grml2usb/grub/grml.png"):
1116 logging.debug("cp /usr/share/grml2usb/grub/grml.png to %s" % grub_target + 'grml.png')
1117 proc = subprocess.Popen(["cp", '/usr/share/grml2usb/grub/grml.png',
1118 grub_target + 'grml.png'])
1121 # font file for graphical bootsplash in grub
1122 if os.path.isfile("/usr/share/grub/ascii.pff"):
1123 logging.debug("cp /usr/share/grub/ascii.pff to %s" % grub_target + 'ascii.pff')
1124 proc = subprocess.Popen(["cp", '/usr/share/grub/ascii.pff',
1125 grub_target + 'ascii.pff'])
1129 def install_iso_files(grml_flavour, iso_mount, device, target):
1130 """Copy files from ISO to given target
1132 @grml_flavour: name of grml flavour the configuration should be generated for
1133 @iso_mount: path where a grml ISO is mounted on
1134 @device: device/partition where bootloader should be installed to
1135 @target: path where grml's main files should be copied to"""
1137 # TODO => several improvements:
1138 # * make sure grml_flavour, iso_mount, target are set when the function is called, otherwise raise exception
1139 # * provide alternative search_file() if file information is stored in a config.ini file?
1140 # * catch "install: .. No space left on device" & CO
1144 elif not options.bootloaderonly:
1145 logging.info("Copying files. This might take a while....")
1146 copy_system_files(grml_flavour, iso_mount, target)
1147 copy_grml_files(iso_mount, target)
1149 if not options.skipaddons:
1150 if grml_flavour.endswith('-small'):
1151 logging.info("grml-small doesn't provide any addons, not installing them therefor.")
1153 copy_addons(iso_mount, target)
1155 if not options.copyonly:
1156 copy_bootloader_files(iso_mount, target)
1158 if not options.dryrun and not os.path.isdir(device):
1159 handle_bootloader_config(grml_flavour, device, target)
1161 # make sure we sync filesystems before returning
1162 proc = subprocess.Popen(["sync"])
1166 def uninstall_files(device):
1167 """Get rid of all grml files on specified device
1169 @device: partition where grml2usb files should be removed from"""
1171 # TODO - not implemented yet
1172 logging.critical("TODO: uninstalling files from %s not yet implement, sorry." % device)
1175 def identify_grml_flavour(mountpath):
1176 """Get name of grml flavour
1178 @mountpath: path where the grml ISO is mounted to
1179 @return: name of grml-flavour"""
1181 version_file = search_file('grml-version', mountpath)
1183 if version_file == "":
1184 logging.critical("Error: could not find grml-version file.")
1188 tmpfile = open(version_file, 'r')
1189 grml_info = tmpfile.readline()
1190 grml_flavour = re.match(r'[\w-]*', grml_info).group()
1194 logging.critical("Unexpected error:", sys.exc_info()[0])
1200 def handle_grub1_config(grml_flavour, install_partition, grub_target, bootopt):
1201 """Main handler for generating grub1 configuration
1203 @grml_flavour: name of grml flavour the configuration should be generated for
1204 @install_partition: partition number for use in (hd0,X)
1205 @grub_target: path of grub's configuration files
1206 @bootoptions: additional bootoptions that should be used by default"""
1209 grub1_cfg = grub_target + 'menu.lst'
1210 logging.debug("Creating grub1 configuration file (menu.lst)")
1212 # install main configuration only *once*, no matter how many ISOs we have:
1213 if os.path.isfile(grub1_cfg):
1214 string = open(grub1_cfg).readline()
1215 main_identifier = re.compile(".*main config generated at: %s.*" % re.escape(str(DATESTAMP)))
1216 if not re.match(main_identifier, string):
1217 grub1_config_file = open(grub1_cfg, 'w')
1218 grub1_config_file.write(generate_main_grub1_config(grml_flavour, install_partition, bootopt))
1219 grub1_config_file.close()
1221 grub1_config_file = open(grub1_cfg, 'w')
1222 grub1_config_file.write(generate_main_grub1_config(grml_flavour, install_partition, bootopt))
1223 grub1_config_file.close()
1225 grub_flavour_config = True
1226 if os.path.isfile(grub1_cfg):
1227 string = open(grub1_cfg).readlines()
1228 flavour = re.compile("grml2usb for %s: %s" % (re.escape(grml_flavour), re.escape(str(DATESTAMP))))
1230 if flavour.match(line):
1231 grub_flavour_config = False
1233 if grub_flavour_config:
1234 grub1_config_file = open(grub1_cfg, 'a')
1235 grub1_config_file.write(generate_flavour_specific_grub1_config(grml_flavour, install_partition, bootopt))
1236 grub1_config_file.close( )
1239 def handle_grub2_config(grml_flavour, install_partition, grub_target, bootopt):
1240 """Main handler for generating grub2 configuration
1242 @grml_flavour: name of grml flavour the configuration should be generated for
1243 @install_partition: partition number for use in (hd0,X)
1244 @grub_target: path of grub's configuration files
1245 @bootoptions: additional bootoptions that should be used by default"""
1248 grub2_cfg = grub_target + 'grub.cfg'
1249 logging.debug("Creating grub2 configuration file (grub.lst)")
1251 # install main configuration only *once*, no matter how many ISOs we have:
1252 if os.path.isfile(grub2_cfg):
1253 string = open(grub2_cfg).readline()
1254 main_identifier = re.compile(".*main config generated at: %s.*" % re.escape(str(DATESTAMP)))
1255 if not re.match(main_identifier, string):
1256 grub2_config_file = open(grub2_cfg, 'w')
1257 logging.info("Note: grml flavour %s is being installed as the default booting system." % grml_flavour)
1258 grub_flavour_is_default = True
1259 grub2_config_file.write(generate_main_grub2_config(grml_flavour, install_partition, bootopt))
1260 grub2_config_file.close()
1262 grub2_config_file = open(grub2_cfg, 'w')
1263 logging.info("Note: grml flavour %s is being installed as the default booting system." % grml_flavour)
1264 grub2_config_file.write(generate_main_grub2_config(grml_flavour, install_partition, bootopt))
1265 grub2_config_file.close()
1267 grub_flavour_config = True
1268 if os.path.isfile(grub2_cfg):
1269 string = open(grub2_cfg).readlines()
1270 flavour = re.compile("grml2usb for %s: %s" % (re.escape(grml_flavour), re.escape(str(DATESTAMP))))
1272 if flavour.match(line):
1273 grub_flavour_config = False
1275 if grub_flavour_config:
1276 grub2_config_file = open(grub2_cfg, 'a')
1277 # display only if the grml flavour isn't the default
1278 if not grub_flavour_is_default:
1279 logging.info("Note: you can boot flavour %s using '%s' on the commandline." % (grml_flavour, grml_flavour))
1280 grub2_config_file.write(generate_flavour_specific_grub2_config(grml_flavour, install_partition, bootopt))
1281 grub2_config_file.close( )
1284 def handle_grub_config(grml_flavour, device, target):
1285 """Main handler for generating grub (v1 and v2) configuration
1287 @grml_flavour: name of grml flavour the configuration should be generated for
1288 @device: device/partition where grub should be installed to
1289 @target: path of grub's configuration files"""
1291 logging.debug("Generating grub configuration")
1293 grub_target = target + '/boot/grub/'
1294 execute(mkdir, grub_target)
1296 # we have to adjust root() inside grub configuration
1297 if device[-1:].isdigit():
1298 install_grub1_partition = int(device[-1:]) - 1
1299 install_grub2_partition = device[-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, install_grub2_partition, grub_target, bootopt)
1315 def handle_syslinux_config(grml_flavour, target):
1316 """Main handler for generating syslinux configuration
1318 @grml_flavour: name of grml flavour the configuration should be generated for
1319 @target: path of syslinux's configuration files"""
1321 # do NOT write "None" in kernel cmdline
1322 if options.bootoptions is None:
1325 bootopt = options.bootoptions
1327 logging.info("Generating syslinux configuration")
1328 syslinux_target = target + '/boot/syslinux/'
1329 # should be present via copy_bootloader_files(), but make sure it exits:
1330 execute(mkdir, syslinux_target)
1331 syslinux_cfg = syslinux_target + 'syslinux.cfg'
1333 # install main configuration only *once*, no matter how many ISOs we have:
1334 if os.path.isfile(syslinux_cfg):
1335 string = open(syslinux_cfg).readline()
1336 main_identifier = re.compile(".*main config generated at: %s.*" % re.escape(str(DATESTAMP)))
1337 if not re.match(main_identifier, string):
1338 syslinux_config_file = open(syslinux_cfg, 'w')
1339 logging.info("Note: grml flavour %s is being installed as the default booting system." % grml_flavour)
1340 syslinux_config_file.write(generate_main_syslinux_config(grml_flavour, bootopt))
1341 syslinux_config_file.close()
1343 syslinux_config_file = open(syslinux_cfg, 'w')
1344 syslinux_config_file.write(generate_main_syslinux_config(grml_flavour, bootopt))
1345 syslinux_config_file.close()
1347 # install flavour specific configuration only *once* as well
1348 # kind of ugly - I'm pretty sure this could be smoother...
1349 syslinux_flavour_config = True
1350 if os.path.isfile(syslinux_cfg):
1351 string = open(syslinux_cfg).readlines()
1352 logging.info("Note: you can boot flavour %s using '%s' on the commandline." % (grml_flavour, grml_flavour))
1353 flavour = re.compile("grml2usb for %s: %s" % (re.escape(grml_flavour), re.escape(str(DATESTAMP))))
1355 if flavour.match(line):
1356 syslinux_flavour_config = False
1358 if syslinux_flavour_config:
1359 syslinux_config_file = open(syslinux_cfg, 'a')
1360 syslinux_config_file.write(generate_flavour_specific_syslinux_config(grml_flavour, bootopt))
1361 syslinux_config_file.close( )
1363 logging.debug("Generating isolinux/syslinux splash %s" % syslinux_target + 'boot.msg')
1364 isolinux_splash = open(syslinux_target + 'boot.msg', 'w')
1365 isolinux_splash.write(generate_isolinux_splash(grml_flavour))
1366 isolinux_splash.close( )
1369 def handle_bootloader_config(grml_flavour, device, target):
1370 """Main handler for generating bootloader's configuration
1372 @grml_flavour: name of grml flavour the configuration should be generated for
1373 @device: device/partition where bootloader should be installed to
1374 @target: path of bootloader's configuration files"""
1376 if options.syslinux:
1377 handle_syslinux_config(grml_flavour, target)
1380 handle_grub_config(grml_flavour, device, target)
1381 except CriticalException, error:
1382 logging.critical("Fatal: %s" % error)
1386 def handle_iso(iso, device):
1387 """Main logic for mounting ISOs and copying files.
1389 @iso: full path to the ISO that should be installed to the specified device
1390 @device: partition where the specified ISO should be installed to"""
1392 logging.info("Using ISO %s" % iso)
1394 if os.path.isdir(iso):
1395 logging.critical("TODO: /live/image handling not yet implemented - sorry")
1398 iso_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
1399 register_tmpfile(iso_mountpoint)
1400 remove_iso_mountpoint = True
1402 if not os.path.isfile(iso):
1403 logging.critical("Fatal: specified ISO %s could not be read" % iso)
1408 mount(iso, iso_mountpoint, ["-o", "loop", "-t", "iso9660"])
1409 except CriticalException, error:
1410 logging.critical("Fatal: %s" % error)
1413 if os.path.isdir(device):
1414 logging.info("Specified target is a directory, not mounting therefor.")
1415 device_mountpoint = device
1416 remove_device_mountpoint = False
1419 device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
1420 register_tmpfile(device_mountpoint)
1421 remove_device_mountpoint = True
1423 mount(device, device_mountpoint, "")
1424 except CriticalException, error:
1425 logging.critical("Fatal: %s" % error)
1430 grml_flavour = identify_grml_flavour(iso_mountpoint)
1431 logging.info("Identified grml flavour \"%s\"." % grml_flavour)
1432 install_iso_files(grml_flavour, iso_mountpoint, device, device_mountpoint)
1434 logging.critical("Fatal: a critical error happend during execution (not a grml ISO?), giving up")
1437 if os.path.isdir(iso_mountpoint) and remove_iso_mountpoint:
1438 unmount(iso_mountpoint, "")
1439 os.rmdir(iso_mountpoint)
1440 unregister_tmpfile(iso_mountpoint)
1441 if remove_device_mountpoint:
1442 unmount(device_mountpoint, "")
1443 if os.path.isdir(device_mountpoint):
1444 os.rmdir(device_mountpoint)
1445 unregister_tmpfile(device_mountpoint)
1448 def handle_mbr(device):
1449 """Main handler for installing master boot record (MBR)
1451 @device: device where the MBR should be installed to"""
1454 logging.info("Would install MBR")
1457 # make sure we have syslinux available
1458 if not options.skipmbr:
1459 if not which("syslinux") and not options.copyonly:
1460 logging.critical('Sorry, syslinux not available. Exiting.')
1461 logging.critical('Please install syslinux or consider using the --grub option.')
1464 if not options.skipmbr:
1465 if device[-1:].isdigit():
1466 mbr_device = re.match(r'(.*?)\d*$', device).group(1)
1467 partition_number = int(device[-1:]) - 1
1470 if options.syslinuxmbr:
1471 handle_syslinux_mbr(mbr_device)
1474 install_mir_mbr('/usr/share/grml2usb/mbr/mbrmgr', mbr_device, partition_number, True)
1476 install_mir_mbr('/usr/share/grml2usb/mbr/mbrldr', mbr_device, partition_number, True)
1477 except IOError, error:
1478 logging.critical("Execution failed: %s", error)
1480 except Exception, error:
1481 logging.critical("Execution failed: %s", error)
1485 def handle_vfat(device):
1486 """Check for FAT specific settings and options
1488 @device: device that should checked / formated"""
1490 # make sure we have mkfs.vfat available
1491 if options.fat16 and not options.force:
1492 if not which("mkfs.vfat") and not options.copyonly and not options.dryrun:
1493 logging.critical('Sorry, mkfs.vfat not available. Exiting.')
1494 logging.critical('Please make sure to install dosfstools.')
1497 # make sure the user is aware of what he is doing
1498 f = raw_input("Are you sure you want to format the specified partition with fat16? y/N ")
1499 if f == "y" or f == "Y":
1500 logging.info("Note: you can skip this question using the option --force")
1503 except CriticalException, error:
1504 logging.critical("Execution failed: %s", error)
1509 # check for vfat filesystem
1510 if device is not None and not os.path.isdir(device):
1512 check_for_fat(device)
1513 except CriticalException, error:
1514 logging.critical("Execution failed: %s", error)
1517 if not check_for_usbdevice(device) and not os.path.isdir(device):
1518 print "Warning: the specified device %s does not look like a removable usb device." % device
1519 f = raw_input("Do you really want to continue? y/N ")
1520 if f == "y" or f == "Y":
1526 def handle_compat_warning(device):
1527 """Backwards compatible checks
1529 @device: device that should be checked"""
1531 # make sure we can replace old grml2usb script and warn user when using old way of life:
1532 if device.startswith("/mnt/external") or device.startswith("/mnt/usb") and not options.force:
1533 print "Warning: the semantics of grml2usb has changed."
1534 print "Instead of using grml2usb /path/to/iso %s you might" % device
1535 print "want to use grml2usb /path/to/iso /dev/... instead."
1536 print "Please check out the grml2usb manpage for details."
1537 f = raw_input("Do you really want to continue? y/N ")
1538 if f == "y" or f == "Y":
1544 def handle_logging():
1545 """Log handling and configuration"""
1548 FORMAT = "Debug: %(asctime)-15s %(message)s"
1549 logging.basicConfig(level=logging.DEBUG, format=FORMAT)
1551 FORMAT = "Critical: %(message)s"
1552 logging.basicConfig(level=logging.CRITICAL, format=FORMAT)
1554 FORMAT = "%(message)s"
1555 logging.basicConfig(level=logging.INFO, format=FORMAT)
1558 def handle_bootloader(device):
1559 """wrapper for installing bootloader
1561 @device: device where bootloader should be installed to"""
1563 # Install bootloader only if not using the --copy-only option
1564 if options.copyonly:
1565 logging.info("Not installing bootloader and its files as requested via option copyonly.")
1566 elif os.path.isdir(device):
1567 logging.info("Not installing bootloader as %s is a directory." % device)
1569 install_bootloader(device)
1573 """Main function [make pylint happy :)]"""
1576 print os.path.basename(sys.argv[0]) + " " + PROG_VERSION
1580 parser.error("invalid usage")
1585 # make sure we have the appropriate permissions
1589 logging.info("Running in simulation mode as requested via option dry-run.")
1591 # specified arguments
1592 device = args[len(args) - 1]
1593 isos = args[0:len(args) - 1]
1595 if not os.path.isdir(device):
1596 if device[-1:].isdigit():
1597 if int(device[-1:]) > 4:
1598 logging.critical("Fatal: installation on partition number >4 not supported. (BIOS won't support it.)")
1601 if os.path.exists(device):
1602 logging.critical("Fatal: installation on raw device not supported. (BIOS won't support it.)")
1605 # provide upgrade path
1606 handle_compat_warning(device)
1608 # check for vfat partition
1611 # main operation (like installing files)
1613 handle_iso(iso, device)
1616 if not os.path.isdir(device):
1619 handle_bootloader(device)
1621 # finally be politely :)
1622 logging.info("Finished execution of grml2usb (%s). Have fun with your grml system." % PROG_VERSION)
1625 if __name__ == "__main__":
1628 except KeyboardInterrupt:
1629 logging.info("Received KeyboardInterrupt")
1632 ## END OF FILE #################################################################
1633 # vim:foldmethod=indent expandtab ai ft=python tw=120 fileencoding=utf-8