2 # -*- coding: utf-8 -*-
3 # pylint: disable-msg=C0302
8 This script installs a grml system (either a running system or ISO[s]) to a USB device
10 :copyright: (c) 2009 by Michael Prokop <mika@grml.org>
11 :license: GPL v2 or any later version
12 :bugreports: http://grml.org/bugs/
16 from optparse import OptionParser
17 from inspect import isroutine, isclass
18 import datetime, logging, os, re, subprocess, sys, tempfile, time, os.path
25 PROG_VERSION = "0.9.25"
26 MOUNTED = set() # register mountpoints
27 TMPFILES = set() # register tmpfiles
28 DATESTAMP = time.mktime(datetime.datetime.now().timetuple()) # unique identifier for syslinux.cfg
29 GRML_FLAVOURS = set() # which flavours are being installed?
33 def syslinux_warning(option, opt, value, opt_parser):
34 """A helper function for printing a warning about deprecated option
36 # pylint: disable-msg=W0613
37 sys.stderr.write("Note: the --syslinux option is deprecated as syslinux " +
38 "is grml2usb's default. Continuing anyway.\n")
39 setattr(opt_parser.values, option.dest, True)
41 # if grub option is set, unset syslinux option
42 def grub_option(option, opt, value, opt_parser):
43 """A helper function adjusting other option values
45 # pylint: disable-msg=W0613
46 setattr(opt_parser.values, option.dest, True)
47 setattr(opt_parser.values, 'syslinux', False)
50 USAGE = "Usage: %prog [options] <[ISO[s] | /live/image]> </dev/sdX#>\n\
52 %prog installs grml ISO[s] to an USB device to be able to boot from it.\n\
53 Make sure you have at least one grml ISO or a running grml system (/live/image),\n\
54 grub or syslinux and root access.\n\
56 Run %prog --help for usage hints, further information via: man grml2usb"
58 # pylint: disable-msg=C0103
59 # pylint: disable-msg=W0603
60 parser = OptionParser(usage=USAGE)
61 parser.add_option("--bootoptions", dest="bootoptions",
62 action="store", type="string",
63 help="use specified bootoptions as default")
64 parser.add_option("--bootloader-only", dest="bootloaderonly", action="store_true",
65 help="do not copy files but just install a bootloader")
66 parser.add_option("--copy-only", dest="copyonly", action="store_true",
67 help="copy files only but do not install bootloader")
68 parser.add_option("--dry-run", dest="dryrun", action="store_true",
69 help="avoid executing commands")
70 parser.add_option("--fat16", dest="fat16", action="store_true",
71 help="format specified partition with FAT16")
72 parser.add_option("--force", dest="force", action="store_true",
73 help="force any actions requiring manual interaction")
74 parser.add_option("--grub", dest="grub", action="callback",
76 help="install grub bootloader instead of (default) syslinux")
77 parser.add_option("--grub-mbr", dest="grubmbr", action="store_true",
78 help="install grub into MBR instead of (default) PBR")
79 parser.add_option("--lilo-binary", dest="lilobin", action="store", type="string",
80 help="lilo executable to be used for installing MBR")
81 parser.add_option("--mbr-menu", dest="mbrmenu", action="store_true",
82 help="enable interactive boot menu in MBR")
83 parser.add_option("--quiet", dest="quiet", action="store_true",
84 help="do not output anything but just errors on console")
85 parser.add_option("--remove-bootoption", dest="removeoption", action="append",
86 help="regex for removing existing bootoptions")
87 parser.add_option("--skip-addons", dest="skipaddons", action="store_true",
88 help="do not install /boot/addons/ files")
89 parser.add_option("--skip-grub-config", dest="skipgrubconfig", action="store_true",
90 help="skip generation of grub configuration files")
91 parser.add_option("--skip-mbr", dest="skipmbr", action="store_true",
92 help="do not install a master boot record (MBR) on the device")
93 parser.add_option("--skip-syslinux-config", dest="skipsyslinuxconfig", action="store_true",
94 help="skip generation of syslinux configuration files")
95 parser.add_option("--syslinux", dest="syslinux", action="callback", default=True,
96 callback=syslinux_warning,
97 help="install syslinux bootloader (deprecated as it's the default)")
98 parser.add_option("--syslinux-mbr", dest="syslinuxmbr", action="store_true",
99 help="install syslinux master boot record (MBR) instead of default")
100 parser.add_option("--verbose", dest="verbose", action="store_true",
101 help="enable verbose mode")
102 parser.add_option("-v", "--version", dest="version", action="store_true",
103 help="display version and exit")
104 (options, args) = parser.parse_args()
107 GRML2USB_BASE = '/usr/share/grml2usb'
108 if not os.path.isdir(GRML2USB_BASE):
109 GRML2USB_BASE = os.path.dirname(os.path.realpath(__file__))
112 class CriticalException(Exception):
113 """Throw critical exception if the exact error is not known but fatal."
115 @Exception: message"""
119 # The following two functions help to operate on strings as
120 # array (list) of bytes (octets). In Python 3000, the bytes
121 # datatype will need to be used. This is intended for using
122 # with manipulation of files on the octet level, like shell
123 # arrays, e.g. in MBR creation.
126 def array2string(*a):
127 """Convert a list of integers [0;255] to a string."""
128 return struct.pack("%sB" % len(a), *a)
132 """Convert a (bytes) string into a list of integers."""
133 return struct.unpack("%sB" % len(s), s)
137 """Cleanup function to make sure there aren't any mounted devices left behind.
140 logging.info("Cleaning up before exiting...")
141 proc = subprocess.Popen(["sync"])
145 for device in MOUNTED:
147 for tmpfile in TMPFILES:
149 # ignore: RuntimeError: Set changed size during iteration
151 logging.debug('caught expection RuntimeError, ignoring')
154 def register_tmpfile(path):
162 def unregister_tmpfile(path):
164 remove registered tmpfile
168 TMPFILES.remove(path)
173 def register_mountpoint(target):
174 """register specified target in a set() for handling clean exiting
176 @target: destination target of mountpoint
182 def unregister_mountpoint(target):
183 """unregister specified target in a set() for handling clean exiting
185 @target: destination target of mountpoint
188 if target in MOUNTED:
189 MOUNTED.remove(target)
192 def get_function_name(obj):
193 """Helper function for use in execute() to retrive name of a function
195 @obj: the function object
197 if not (isroutine(obj) or isclass(obj)):
199 return obj.__module__ + '.' + obj.__name__
202 def execute(f, *exec_arguments):
203 """Wrapper for executing a command. Either really executes
204 the command (default) or when using --dry-run commandline option
205 just displays what would be executed."""
206 # usage: execute(subprocess.Popen, (["ls", "-la"]))
208 # pylint: disable-msg=W0141
209 logging.debug('dry-run only: %s(%s)', get_function_name(f), ', '.join(map(repr, exec_arguments)))
211 # pylint: disable-msg=W0142
212 return f(*exec_arguments)
216 """Check whether a given file can be executed
218 @fpath: full path to file
220 return os.path.exists(fpath) and os.access(fpath, os.X_OK)
224 """Check whether a given program is available in PATH
226 @program: name of executable"""
227 fpath = os.path.split(program)[0]
232 for path in os.environ["PATH"].split(os.pathsep):
233 exe_file = os.path.join(path, program)
240 def get_defaults_file(iso_mount, flavour, name):
241 """get the default file for syslinux
243 bootloader_dirs = ['/boot/isolinux/', '/boot/syslinux/']
244 for directory in bootloader_dirs:
246 "%s_%s" % (get_flavour_filename(flavour), name):
247 if os.path.isfile(iso_mount + directory + name):
248 return (directory, name)
251 def search_file(filename, search_path='/bin' + os.pathsep + '/usr/bin'):
252 """Given a search path, find file
254 @filename: name of file to search for
255 @search_path: path where searching for the specified filename"""
257 paths = search_path.split(os.pathsep)
258 current_dir = '' # make pylint happy :)
261 """Helper function ffor testing if specified file exists in cwd
263 @cwd: current working directory
265 return os.path.exists(os.path.join(cwd, filename))
269 if match_file(current_dir):
272 # pylint: disable-msg=W0612
273 for current_dir, directories, files in os.walk(path):
274 if match_file(current_dir):
278 return os.path.abspath(os.path.join(current_dir, filename))
283 def check_uid_root():
284 """Check for root permissions"""
285 if not os.geteuid()==0:
286 sys.exit("Error: please run this script with uid 0 (root).")
289 def mkfs_fat16(device):
290 """Format specified device with VFAT/FAT16 filesystem.
292 @device: partition that should be formated"""
295 logging.info("Would execute mkfs.vfat -F 16 %s now.", device)
298 logging.info("Formating partition with fat16 filesystem")
299 logging.debug("mkfs.vfat -F 16 %s", device)
300 proc = subprocess.Popen(["mkfs.vfat", "-F", "16", device])
302 if proc.returncode != 0:
303 raise CriticalException("error executing mkfs.vfat")
306 def generate_main_grub2_config(grml_flavour, bootoptions):
307 """Generate grub2 configuration for use via grub.cfg
309 @grml_flavour: name of grml flavour the configuration should be generated for
310 @bootoptions: additional bootoptions that should be used by default"""
312 local_datestamp = DATESTAMP
315 ## main grub2 configuration - generated by grml2usb [main config generated at: %(local_datestamp)s]
321 if loadfont /boot/grub/ascii.pf2 ; then
326 if terminal_output.gfxterm ; then true ; else
327 # For backward compatibility with versions of terminal.mod that don't
328 # understand terminal_output
333 if background_image /boot/grub/grml.png ; then
334 set color_normal=black/black
335 set color_highlight=red/black
337 set menu_color_normal=white/black
338 set menu_color_highlight=black/yellow
341 menuentry "%(grml_flavour)s (default)" {
342 set gfxpayload=1024x768x16,1024x768
343 linux /boot/release/%(flavour_filename)s/linux26 apm=power-off quiet boot=live nomce live-media-path=/live/%(grml_flavour)s/ bootid=%(uid)s %(bootoptions)s
344 initrd /boot/release/%(flavour_filename)s/initrd.gz
347 menuentry "Memory test (memtest86+)" {
348 linux16 /boot/addons/memtest
351 menuentry "Boot Grub (all in one image)" {
352 linux /boot/addons/memdisk
353 initrd /boot/addons/allinone.img
356 menuentry "Boot FreeDOS" {
357 linux /boot/addons/memdisk
358 initrd /boot/addons/balder10.imz
361 menuentry "Boot MirOS bsd4grml" {
362 multiboot /boot/addons/bsd4grml/ldbsd.com
363 module /boot/addons/bsd4grml/bsd.rd
364 module /boot/addons/bsd4grml/boot.1
365 module /boot/addons/bsd4grml/boot.2
366 module /boot/addons/bsd4grml/boot.3
367 module /boot/addons/bsd4grml/boot.4
368 module /boot/addons/bsd4grml/boot.5
369 module /boot/addons/bsd4grml/boot.6
370 module /boot/addons/bsd4grml/boot.cfg
373 menuentry "Boot OS of first partition on first disk" {
378 """ % {'grml_flavour': grml_flavour, 'local_datestamp': local_datestamp,
379 'flavour_filename': grml_flavour.replace('-', ''),
380 'uid': UUID, 'bootoptions': bootoptions } )
383 def generate_flavour_specific_grub2_config(grml_flavour, bootoptions):
384 """Generate grub2 configuration for use via grub.cfg
386 @grml_flavour: name of grml flavour the configuration should be generated for
387 @bootoptions: additional bootoptions that should be used by default"""
389 local_datestamp = DATESTAMP
392 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
393 menuentry "%(grml_flavour)s - boot in default mode" {
394 set gfxpayload=1024x768x16,1024x768
395 linux /boot/release/%(flavour_filename)s/linux26 apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ bootid=%(uid)s %(bootoptions)s
396 initrd /boot/release/%(flavour_filename)s/initrd.gz
399 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
400 menuentry "%(grml_flavour)s-persistent - enable persistency feature" {
401 set gfxpayload=1024x768x16,1024x768
402 linux /boot/release/%(flavour_filename)s/linux26 apm=power-off boot=live nomce quiet persistent live-media-path=/live/%(grml_flavour)s/ bootid=%(uid)s %(bootoptions)s
403 initrd /boot/release/%(flavour_filename)s/initrd.gz
406 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
407 menuentry "%(grml_flavour)s2ram - copy compressed grml file to RAM" {
408 set gfxpayload=1024x768x16,1024x768
409 linux /boot/release/%(flavour_filename)s/linux26 apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ toram=%(grml_flavour)s.squashfs bootid=%(uid)s %(bootoptions)s
410 initrd /boot/release/%(flavour_filename)s/initrd.gz
413 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
414 menuentry "%(grml_flavour)s-debug - enable debugging options" {
415 set gfxpayload=1024x768x16,1024x768
416 linux /boot/release/%(flavour_filename)s/linux26 apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ debug bootid=%(uid)s initcall_debug %(bootoptions)s
417 initrd /boot/release/%(flavour_filename)s/initrd.gz
420 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
421 menuentry "%(grml_flavour)s-x - start X Window System" {
422 set gfxpayload=1024x768x16,1024x768
423 linux /boot/release/%(flavour_filename)s/linux26 apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ startx=wm-ng bootid=%(uid)s %(bootoptions)s
424 initrd /boot/release/%(flavour_filename)s/initrd.gz
427 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
428 menuentry "%(grml_flavour)s-nofb - disable framebuffer" {
429 linux /boot/release/%(flavour_filename)s/linux26 apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ vga=normal video=ofonly bootid=%(uid)s %(bootoptions)s
430 initrd /boot/release/%(flavour_filename)s/initrd.gz
433 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
434 menuentry "%(grml_flavour)s-failsafe - disable hardware detection" {
435 linux /boot/release/%(flavour_filename)s/linux26 apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ vga=normal 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 bootid=%(uid)s %(bootoptions)s
436 initrd /boot/release/%(flavour_filename)s/initrd.gz
439 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
440 menuentry "%(grml_flavour)s-forensic - do not touch harddisks during hw recognition" {
441 set gfxpayload=1024x768x16,1024x768
442 linux /boot/release/%(flavour_filename)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 bootid=%(uid)s %(bootoptions)s
443 initrd /boot/release/%(flavour_filename)s/initrd.gz
446 """ % {'grml_flavour': grml_flavour, 'local_datestamp': local_datestamp,
447 'flavour_filename': grml_flavour.replace('-', ''),
448 'uid': UUID, 'bootoptions': bootoptions } )
451 def generate_flavour_specific_grub1_config(grml_flavour, install_partition, bootoptions):
452 """Generate grub1 configuration for use via menu.lst
454 @grml_flavour: name of grml flavour the configuration should be generated for
455 @install_partition: partition number for use in (hd0,X)
456 @bootoptions: additional bootoptions that should be used by default"""
458 local_datestamp = DATESTAMP
461 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
462 title %(grml_flavour)s
463 kernel (hd0,%(install_partition)s)/boot/release/%(flavour_filename)s/linux26 apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ bootid=%(uid)s %(bootoptions)s
464 initrd (hd0,%(install_partition)s)/boot/release/%(flavour_filename)s/initrd.gz
466 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
467 title %(grml_flavour)s-persistent
468 kernel (hd0,%(install_partition)s)/boot/release/%(flavour_filename)s/linux26 apm=power-off boot=live nomce vga=791 quiet persistent live-media-path=/live/%(grml_flavour)s/ bootid=%(uid)s %(bootoptions)s
469 initrd (hd0,%(install_partition)s)/boot/release/%(flavour_filename)s/initrd.gz
471 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
472 title %(grml_flavour)s2ram
473 kernel (hd0,%(install_partition)s)/boot/release/%(flavour_filename)s/linux26 apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ toram=%(grml_flavour)s.squashfs bootid=%(uid)s %(bootoptions)s
474 initrd (hd0,%(install_partition)s)/boot/release/%(flavour_filename)s/initrd.gz
476 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
477 title %(grml_flavour)s-debug
478 kernel (hd0,%(install_partition)s)/boot/release/%(flavour_filename)s/linux26 apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ debug initcall_debug bootid=%(uid)s %(bootoptions)s
479 initrd (hd0,%(install_partition)s)/boot/release/%(flavour_filename)s/initrd.gz
481 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
482 title %(grml_flavour)s-x
483 kernel (hd0,%(install_partition)s)/boot/release/%(flavour_filename)s/linux26 apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ startx=wm-ng bootid=%(uid)s %(bootoptions)s
484 initrd (hd0,%(install_partition)s)/boot/release/%(flavour_filename)s/initrd.gz
486 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
487 title %(grml_flavour)s-nofb
488 kernel (hd0,%(install_partition)s)/boot/release/%(flavour_filename)s/linux26 apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ vga=normal video=ofonly bootid=%(uid)s %(bootoptions)s
489 initrd (hd0,%(install_partition)s)/boot/release/%(flavour_filename)s/initrd.gz
491 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
492 title %(grml_flavour)s-failsafe
493 kernel (hd0,%(install_partition)s)/boot/release/%(flavour_filename)s/linux26 apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ vga=normal 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 bootid=%(uid)s %(bootoptions)s
494 initrd (hd0,%(install_partition)s)/boot/release/%(flavour_filename)s/initrd.gz
496 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
497 title %(grml_flavour)s-forensic
498 kernel (hd0,%(install_partition)s)/boot/release/%(flavour_filename)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 bootid=%(uid)s %(bootoptions)s
499 initrd (hd0,%(install_partition)s)/boot/release/%(flavour_filename)s/initrd.gz
501 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
502 title %(grml_flavour)s-serial
503 kernel (hd0,%(install_partition)s)/boot/release/%(flavour_filename)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 bootid=%(uid)s %(bootoptions)s
504 initrd (hd0,%(install_partition)s)/boot/release/%(flavour_filename)s/initrd.gz
506 """ % {'grml_flavour': grml_flavour, 'local_datestamp': local_datestamp,
507 'flavour_filename': grml_flavour.replace('-', ''), 'uid': UUID,
508 'bootoptions': bootoptions, 'install_partition': install_partition } )
511 def generate_main_grub1_config(grml_flavour, install_partition, bootoptions):
512 """Generate grub1 configuration for use via menu.lst
514 @grml_flavour: name of grml flavour the configuration should be generated for"""
516 local_datestamp = DATESTAMP
519 ## main grub1 configuration - generated by grml2usb [main config generated at: %(local_datestamp)s]
522 # color red/blue green/black
523 splashimage=(hd0,%(install_partition)s)/boot/grub/splash.xpm.gz
528 title %(grml_flavour)s - Default boot (using 1024x768 framebuffer)
529 kernel (hd0,%(install_partition)s)/boot/release/%(flavour_filename)s/linux26 apm=power-off vga=791 quiet boot=live nomce live-media-path=/live/%(grml_flavour)s/ bootid=%(uid)s %(bootoptions)s
530 initrd (hd0,%(install_partition)s)/boot/release/%(flavour_filename)s/initrd.gz
532 title Memory test (memtest86+)
533 kernel (hd0,%(install_partition)s)/boot/addons/memtest
535 title Grub - all in one image
536 kernel (hd0,%(install_partition)s)/boot/addons/memdisk
537 initrd (hd0,%(install_partition)s)/boot/addons/allinone.img
540 kernel (hd0,%(install_partition)s)/boot/addons/memdisk
541 initrd (hd0,%(install_partition)s)/boot/addons/balder10.imz
544 kernel (hd0,%(install_partition)s)/boot/addons/bsd4grml/ldbsd.com
546 """ % {'grml_flavour': grml_flavour, 'local_datestamp': local_datestamp,
547 'flavour_filename': grml_flavour.replace('-', ''), 'uid': UUID,
548 'bootoptions': bootoptions, 'install_partition': install_partition } )
551 def generate_isolinux_splash(grml_flavour):
552 """Generate bootsplash for isolinux/syslinux
554 @grml_flavour: name of grml flavour the configuration should be generated for"""
556 grml_name = grml_flavour
559 \ f17
\f\18/boot/syslinux/logo.16
561 Some information and boot options available via keys F2 - F10. http://grml.org/
563 """ % {'grml_name': grml_name} )
566 def generate_main_syslinux_config(*arg):
567 """Generate main configuration for use in syslinux.cfg
569 @*arg: just for backward compatibility"""
570 # pylint: disable-msg=W0613
571 # remove warning about unused arg
575 menu label Default boot modes:
584 menu label Additional boot entries for:
586 include additional.cfg
593 include promptname.cfg
596 Jump to old style isolinux prompt
597 featuring further information
598 regarding available boot options.
606 def generate_flavour_specific_syslinux_config(grml_flavour):
607 """Generate flavour specific configuration for use in syslinux.cfg
609 @grml_flavour: name of grml flavour the configuration should be generated for"""
613 menu begin grml %(grml_flavour)s
614 menu title %(display_name)s
616 menu label ^Back to main menu...
619 # include config for boot parameters from disk
620 include %(grml_flavour)s_grml.cfg
623 """ % {'grml_flavour': grml_flavour, 'display_name' : grml_flavour.replace('_', '-') } )
626 def install_grub(device):
627 """Install grub on specified device.
629 @mntpoint: mountpoint of device where grub should install its files to
630 @device: partition where grub should be installed to"""
633 logging.info("Would execute grub-install [--root-directory=mount_point] %s now.", device)
635 device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
636 register_tmpfile(device_mountpoint)
639 mount(device, device_mountpoint, "")
641 # If using --grub-mbr then make sure we install grub in MBR instead of PBR
643 logging.debug("Using option --grub-mbr ...")
644 if device[-1:].isdigit():
645 grub_device = re.match(r'(.*?)\d*$', device).group(1)
651 logging.info("Installing grub as bootloader")
652 logging.debug("grub-install --recheck --no-floppy --root-directory=%s %s",
653 device_mountpoint, grub_device)
654 proc = subprocess.Popen(["grub-install", "--recheck", "--force", "--no-floppy",
655 "--root-directory=%s" % device_mountpoint, grub_device],
656 stdout=file(os.devnull, "r+"))
658 if proc.returncode != 0:
659 # raise Exception("error executing grub-install")
660 logging.critical("Fatal: error executing grub-install "
661 + "(please check the grml2usb FAQ or drop the --grub option)")
662 logging.critical("Note: if using grub2 consider using "
663 + "the --grub-mbr option as grub considers PBR problematic.")
666 except CriticalException, error:
667 logging.critical("Fatal: %s", error)
672 unmount(device_mountpoint, "")
673 os.rmdir(device_mountpoint)
674 unregister_tmpfile(device_mountpoint)
677 def install_syslinux(device):
678 """Install syslinux on specified device.
680 @device: partition where syslinux should be installed to"""
683 logging.info("Would install syslinux as bootloader on %s", device)
686 # syslinux -d boot/isolinux /dev/sdb1
687 logging.info("Installing syslinux as bootloader")
688 logging.debug("syslinux -d boot/syslinux %s", device)
689 proc = subprocess.Popen(["syslinux", "-d", "boot/syslinux", device])
691 if proc.returncode != 0:
692 raise CriticalException("Error executing syslinux (either try --fat16 or use grub?)")
695 def install_bootloader(device):
696 """Install bootloader on specified device.
698 @device: partition where bootloader should be installed to"""
700 # by default we use grub, so install syslinux only on request
702 if not which("grub-install"):
703 logging.critical("Fatal: grub-install not available (please install the "
704 + "grub package or use the --syslinux option)")
710 except CriticalException, error:
711 logging.critical("Fatal: %s", error)
716 install_syslinux(device)
717 except CriticalException, error:
718 logging.critical("Fatal: %s", error)
723 def execute_lilo(lilo, device):
724 """execute lilo for activating the partitions in the MBR
726 @lilo: path of lilo executable
727 @device: device where lilo should be executed on"""
729 # to support -A for extended partitions:
730 logging.info("Activating partitions in MBR via lilo")
731 logging.debug("%s -S /dev/null -M %s ext", lilo, device)
732 proc = subprocess.Popen([lilo, "-S", "/dev/null", "-M", device, "ext"])
734 if proc.returncode != 0:
735 raise Exception("error executing lilo")
737 # activate partition:
738 logging.debug("%s -S /dev/null -A %s 1", lilo, device)
739 proc = subprocess.Popen([lilo, "-S", "/dev/null", "-A", device, "1"])
741 if proc.returncode != 0:
742 raise Exception("error executing lilo")
745 def install_syslinux_mbr(device):
746 """install syslinux's master boot record (MBR) on the specified device
748 @device: device where MBR of syslinux should be installed to"""
750 # make sure we have syslinux available
751 if not which("syslinux") and not options.copyonly:
752 raise Exception("syslinux not available (either install it or consider using the --grub option)")
754 # lilo's mbr is broken, use the one from syslinux instead:
755 if not os.path.isfile("/usr/lib/syslinux/mbr.bin"):
756 raise Exception("/usr/lib/syslinux/mbr.bin can not be read")
758 logging.info("Installing syslinux MBR")
759 logging.debug("cat /usr/lib/syslinux/mbr.bin > %s", device)
761 retcode = subprocess.call("cat /usr/lib/syslinux/mbr.bin > "+ device, shell=True)
763 logging.critical("Error copying MBR to device (%s)", retcode)
764 except OSError, error:
765 logging.critical("Execution failed: %s", error)
768 def install_mir_mbr(mbrtemplate, device, partition, ismirbsdmbr=True):
769 """install 'mbr' master boot record (MBR) on a device
771 Retrieve the partition table from "device", install an MBR from the
772 "mbrtemplate" file, set the "partition" (0..3) active, and install the
773 result back to "device".
775 @mbrtemplate: default MBR file
777 @device: name of a file assumed to be a hard disc (or USB stick) image, or
778 something like "/dev/sdb"
780 @partition: must be a number between 0 and 3, inclusive
782 @mbrtemplate: must be a valid MBR file of at least 440 (or 439 if
785 @ismirbsdmbr: if true then ignore the active flag, set the mirbsdmbr
786 specific flag to 0/1/2/3 and set the MBR's default value accordingly. If
787 false then leave the mirbsdmbr specific flag set to FFh, set all
788 active flags to 0 and set the active flag of the partition to 80h. Note:
789 behaviour of mirbsdmbr: if flag = 0/1/2/3 then use it, otherwise search for
792 logging.info("Installing default MBR")
794 if not os.path.isfile(mbrtemplate):
795 logging.critical("Error: %s can not be read.", mbrtemplate)
796 raise CriticalException("Error installing MBR (either try --syslinux-mbr or install missing file?)")
798 if (partition < 0) or (partition > 3):
799 raise ValueError("partition must be between 0 and 3")
806 tmpf = tempfile.NamedTemporaryFile()
808 logging.debug("executing: dd if='%s' of='%s' bs=512 count=1", device, tmpf.name)
809 proc = subprocess.Popen(["dd", "if=%s" % device, "of=%s" % tmpf.name, "bs=512", "count=1"],
810 stderr=file(os.devnull, "r+"))
812 if proc.returncode != 0:
813 raise Exception("error executing dd (first run)")
815 logging.debug("executing: dd if=%s of=%s bs=%s count=1 conv=notrunc", mbrtemplate,
816 tmpf.name, nmbrbytes)
817 proc = subprocess.Popen(["dd", "if=%s" % mbrtemplate, "of=%s" % tmpf.name, "bs=%s" % nmbrbytes,
818 "count=1", "conv=notrunc"], stderr=file(os.devnull, "r+"))
820 if proc.returncode != 0:
821 raise Exception("error executing dd (second run)")
823 mbrcode = tmpf.file.read(512)
824 if len(mbrcode) < 512:
825 raise EOFError("MBR size (%d) < 512" % len(mbrcode))
828 mbrcode = mbrcode[0:439] + chr(partition) + \
829 mbrcode[440:510] + "\x55\xAA"
831 actives = ["\x00", "\x00", "\x00", "\x00"]
832 actives[partition] = "\x80"
833 mbrcode = mbrcode[0:446] + actives[0] + \
834 mbrcode[447:462] + actives[1] + \
835 mbrcode[463:478] + actives[2] + \
836 mbrcode[479:494] + actives[3] + \
837 mbrcode[495:510] + "\x55\xAA"
841 tmpf.file.write(mbrcode)
844 logging.debug("executing: dd if='%s' of='%s' bs=512 count=1 conv=notrunc", tmpf.name, device)
845 proc = subprocess.Popen(["dd", "if=%s" % tmpf.name, "of=%s" % device, "bs=512", "count=1",
846 "conv=notrunc"], stderr=file(os.devnull, "r+"))
848 if proc.returncode != 0:
849 raise Exception("error executing dd (third run)")
853 def handle_syslinux_mbr(device):
854 """Install syslinux master boot record on given device
856 @device: device where MBR should be installed to"""
858 if not is_writeable(device):
859 raise IOError("device not writeable for user")
861 # try to use system's lilo
865 # otherwise fall back to our static version
866 from platform import architecture
867 if architecture()[0] == '64bit':
868 lilo = GRML2USB_BASE + '/lilo/lilo.static.amd64'
870 lilo = GRML2USB_BASE + '/lilo/lilo.static.i386'
871 # finally prefer a specified lilo executable
873 lilo = options.lilobin
876 raise Exception("lilo executable can not be execute")
879 logging.info("Would install MBR running lilo and using syslinux.")
882 execute_lilo(lilo, device)
883 install_syslinux_mbr(device)
886 def is_writeable(device):
887 """Check if the device is writeable for the current user
889 @device: partition where bootloader should be installed to"""
893 #raise Exception("no device for checking write permissions")
895 if not os.path.exists(device):
898 return os.access(device, os.W_OK) and os.access(device, os.R_OK)
901 def mount(source, target, mount_options):
902 """Mount specified source on given target
904 @source: name of device/ISO that should be mounted
905 @target: directory where the ISO should be mounted to
906 @options: mount specific options"""
908 # note: options.dryrun does not work here, as we have to
909 # locate files and identify the grml flavour
911 for x in file('/proc/mounts').readlines():
912 if x.startswith(source):
913 raise CriticalException("Error executing mount: %s already mounted - "
914 + "please unmount before invoking grml2usb" % source)
916 if os.path.isdir(source):
917 logging.debug("Source %s is not a device, therefore not mounting.", source)
920 logging.debug("mount %s %s %s", mount_options, source, target)
921 proc = subprocess.Popen(["mount"] + list(mount_options) + [source, target])
923 if proc.returncode != 0:
924 raise CriticalException("Error executing mount (no filesystem on the partition?)")
926 logging.debug("register_mountpoint(%s)", target)
927 register_mountpoint(target)
930 def unmount(target, unmount_options):
931 """Unmount specified target
933 @target: target where something is mounted on and which should be unmounted
934 @options: options for umount command"""
936 # make sure we unmount only already mounted targets
937 target_unmount = False
938 mounts = open('/proc/mounts').readlines()
939 mountstring = re.compile(".*%s.*" % re.escape(os.path.realpath(target)))
941 if re.match(mountstring, line):
942 target_unmount = True
944 if not target_unmount:
945 logging.debug("%s not mounted anymore", target)
947 logging.debug("umount %s %s", list(unmount_options), target)
948 proc = subprocess.Popen(["umount"] + list(unmount_options) + [target])
950 if proc.returncode != 0:
951 raise Exception("Error executing umount")
953 logging.debug("unregister_mountpoint(%s)", target)
954 unregister_mountpoint(target)
957 def check_for_usbdevice(device):
958 """Check whether the specified device is a removable USB device
960 @device: device name, like /dev/sda1 or /dev/sda
963 usbdevice = re.match(r'/dev/(.*?)\d*$', device).group(1)
965 usbdev = os.path.realpath('/sys/class/block/' + usbdevice + '/removable')
966 if not os.path.isfile(usbdev):
967 # Ubuntu with kernel 2.6.24 for example:
968 usbdev = os.path.realpath('/sys/block/' + usbdevice + '/removable')
970 if os.path.isfile(usbdev):
971 is_usb = open(usbdev).readline()
978 def check_for_fat(partition):
979 """Check whether specified partition is a valid VFAT/FAT16 filesystem
981 @partition: device name of partition"""
984 udev_info = subprocess.Popen(["/sbin/blkid", "-s", "TYPE", "-o", "value", partition],
985 stdout=subprocess.PIPE, stderr=subprocess.PIPE)
986 filesystem = udev_info.communicate()[0].rstrip()
988 if udev_info.returncode == 2:
989 raise CriticalException("Failed to read device %s"
990 " (wrong UID/permissions or device/directory not present?)" % partition)
992 if filesystem != "vfat":
993 raise CriticalException("Partition %s does not contain a FAT16 filesystem. "
994 + "(Use --fat16 or run mkfs.vfat %s)" % (partition, partition))
997 raise CriticalException("Sorry, /sbin/blkid not available (install e2fsprogs?)")
1000 def mkdir(directory):
1001 """Simple wrapper around os.makedirs to get shell mkdir -p behaviour"""
1003 # just silently pass as it's just fine it the directory exists
1004 if not os.path.isdir(directory):
1006 os.makedirs(directory)
1007 # pylint: disable-msg=W0704
1012 def exec_rsync(source, target):
1013 """Simple wrapper around rsync to install files
1015 @source: source file/directory
1016 @target: target file/directory"""
1017 logging.debug("Source: %s / Target: %s", source, target)
1018 proc = subprocess.Popen(["rsync", "-rlptDH", "--inplace", source, target])
1020 if proc.returncode == 12:
1021 logging.critical("Fatal: No space left on device")
1025 if proc.returncode != 0:
1026 logging.critical("Fatal: could not install %s", source)
1031 def write_uuid(target_file):
1032 """Generates an returns uuid and write it to the specified file
1034 @target_file: filename to write the uuid to
1037 fileh = open(target_file, 'w')
1038 uid = str(uuid.uuid4())
1044 def get_uuid(target):
1045 """Get the uuid of the specified target. Will generate an uuid if none exist.
1047 @target: directory/mountpoint containing the grml layout
1050 conf_target = target + "/conf/"
1051 uuid_file_name = conf_target + "/bootid.txt"
1052 if os.path.isdir(conf_target):
1053 if os.path.isfile(uuid_file_name):
1054 uuid_file = open(uuid_file_name, 'r')
1055 uid = uuid_file.readline().strip()
1059 return write_uuid(uuid_file_name)
1061 execute(mkdir, conf_target)
1062 return write_uuid(uuid_file_name)
1065 def copy_system_files(grml_flavour, iso_mount, target):
1066 """copy grml's main files (like squashfs, kernel and initrd) to a given target
1068 @grml_flavour: name of grml flavour the configuration should be generated for
1069 @iso_mount: path where a grml ISO is mounted on
1070 @target: path where grml's main files should be copied to"""
1072 squashfs = search_file(grml_flavour + '.squashfs', iso_mount)
1073 if squashfs is None:
1074 logging.critical("Fatal: squashfs file not found")
1075 raise CriticalException("error locating squashfs file")
1077 squashfs_target = target + '/live/' + grml_flavour + '/'
1078 execute(mkdir, squashfs_target)
1079 exec_rsync(squashfs, squashfs_target + grml_flavour + '.squashfs')
1081 for prefix in grml_flavour + "/", "":
1082 filesystem_module = search_file(prefix + 'filesystem.module', iso_mount)
1083 if filesystem_module:
1085 if filesystem_module is None:
1086 logging.critical("Fatal: filesystem.module not found")
1087 raise CriticalException("error locating filesystem.module file")
1089 exec_rsync(filesystem_module, squashfs_target + 'filesystem.module')
1092 release_path = 'boot/release/' + grml_flavour.replace('-', '')
1093 release_target = target + "/" + release_path
1094 execute(mkdir, release_target)
1097 if os.path.isdir(iso_mount + '/boot/release'):
1098 prefix = release_path + '/'
1100 kernel = search_file(prefix + 'linux26', iso_mount)
1102 logging.critical("Fatal kernel not found")
1103 raise CriticalException("error locating kernel file")
1105 exec_rsync(kernel, release_target + '/linux26')
1107 initrd = search_file(prefix + 'initrd.gz', iso_mount)
1109 logging.critical("Fatal: initrd not found")
1110 raise CriticalException("error locating initrd file")
1112 exec_rsync(initrd, release_target + '/initrd.gz')
1115 def update_grml_versions(iso_mount, target):
1116 """Update the grml version file on a cd
1117 Returns true if version was updated successfully,
1118 False if grml-version does not exist yet on the mountpoint
1120 @iso_mount: string of the iso mount point
1121 @target: path of the target mount point
1123 grml_target = target + '/grml/'
1124 new_grml_version = search_file('grml-version', grml_target)
1125 if new_grml_version:
1126 orig_grml_version = search_file('grml-version', iso_mount)
1127 if not orig_grml_version:
1128 logging.warn("Warning: %s could not be found - can not install it", orig_grml_version)
1131 new_file = open(new_grml_version, 'a+')
1132 new_flavours = [ get_flavour(l) for l in new_file.readlines() ]
1134 old_file = open(orig_grml_version, 'r')
1135 old_lines = old_file.readlines()
1136 for line in old_lines:
1137 if not get_flavour(line) in new_flavours:
1138 new_file.write(line)
1140 logging.warn("Warning: Could not write file")
1148 def copy_grml_files(iso_mount, target):
1149 """copy some minor grml files to a given target
1151 @iso_mount: path where a grml ISO is mounted on
1152 @target: path where grml's main files should be copied to"""
1154 grml_target = target + '/grml/'
1155 execute(mkdir, grml_target)
1157 copy_files = [ 'grml-cheatcodes.txt', 'LICENSE.txt', 'md5sums', 'README.txt' ]
1158 # handle grml-version
1159 if not update_grml_versions(iso_mount, target):
1160 copy_files.append('grml-version')
1162 for myfile in copy_files:
1163 grml_file = search_file(myfile, iso_mount)
1164 if grml_file is None:
1165 logging.warn("Warning: myfile %s could not be found - can not install it", myfile)
1167 exec_rsync(grml_file, grml_target + myfile)
1169 grml_web_target = grml_target + '/web/'
1170 execute(mkdir, grml_web_target)
1172 for myfile in 'index.html', 'style.css':
1173 grml_file = search_file(myfile, iso_mount)
1174 if grml_file is None:
1175 logging.warn("Warning: myfile %s could not be found - can not install it")
1177 exec_rsync(grml_file, grml_web_target + myfile)
1179 grml_webimg_target = grml_web_target + '/images/'
1180 execute(mkdir, grml_webimg_target)
1182 for myfile in 'button.png', 'favicon.png', 'linux.jpg', 'logo.png':
1183 grml_file = search_file(myfile, iso_mount)
1184 if grml_file is None:
1185 logging.warn("Warning: myfile %s could not be found - can not install it")
1187 exec_rsync(grml_file, grml_webimg_target + myfile)
1190 def handle_addon_copy(filename, dst, iso_mount):
1191 """handle copy of optional addons
1193 @filename: filename of the addon
1194 @dst: destination directory
1195 @iso_mount: location of the iso mount
1197 file_location = search_file(filename, iso_mount)
1198 if file_location is None:
1199 logging.warn("Warning: %s not found (that's fine if you don't need it)", filename)
1201 exec_rsync(file_location, dst + filename)
1204 def copy_addons(iso_mount, target):
1205 """copy grml's addons files (like allinoneimg, bsd4grml,..) to a given target
1207 @iso_mount: path where a grml ISO is mounted on
1208 @target: path where grml's main files should be copied to"""
1210 addons = target + '/boot/addons/'
1211 execute(mkdir, addons)
1213 # grub all-in-one image
1214 handle_addon_copy('allinone.img', addons, iso_mount)
1217 handle_addon_copy('bsd4grml', addons, iso_mount)
1219 handle_addon_copy('balder10.imz', addons, iso_mount)
1221 # install hdt and pci.ids only when using syslinux (grub doesn't support it)
1222 if options.syslinux:
1223 # hdt (hardware detection tool) image
1224 hdtimg = search_file('hdt.c32', iso_mount)
1226 exec_rsync(hdtimg, addons + '/hdt.c32')
1229 picids = search_file('pci.ids', iso_mount)
1231 exec_rsync(picids, addons + '/pci.ids')
1234 handle_addon_copy('memdisk', addons, iso_mount)
1237 handle_addon_copy('memtest', addons, iso_mount)
1240 handle_addon_copy('gpxe.lkrn', addons, iso_mount)
1243 def glob_and_copy(filepattern, dst):
1244 """Glob on specified filepattern and copy the result to dst
1246 @filepattern: globbing pattern
1247 @dst: target directory
1249 for name in glob.glob(filepattern):
1250 copy_if_exist(name, dst)
1252 def search_and_copy(filename, search_path, dst):
1253 """Search for the specified filename at searchpath and copy it to dst
1255 @filename: filename to look for
1256 @search_path: base search file
1257 @dst: destionation to copy the file to
1259 file_location = search_file(filename, search_path)
1260 copy_if_exist(file_location, dst)
1262 def copy_if_exist(filename, dst):
1263 """Copy filename to dst if filename is set.
1265 @filename: a filename
1268 if filename and (os.path.isfile(filename) or os.path.isdir(filename)):
1269 exec_rsync(filename, dst)
1271 def copy_bootloader_files(iso_mount, target):
1272 """Copy grml's bootloader files to a given target
1274 @iso_mount: path where a grml ISO is mounted on
1275 @target: path where grml's main files should be copied to"""
1277 syslinux_target = target + '/boot/syslinux/'
1278 execute(mkdir, syslinux_target)
1280 grub_target = target + '/boot/grub/'
1281 execute(mkdir, grub_target)
1284 logo = search_file('logo.16', iso_mount)
1285 exec_rsync(logo, syslinux_target + 'logo.16')
1288 for ffile in ['f%d' % number for number in range(1, 11) ]:
1289 search_and_copy(ffile, iso_mount, syslinux_target + ffile)
1291 loopback_cfg = search_file("loopback.cfg", iso_mount)
1293 directory = os.path.dirname(loopback_cfg)
1294 directory = directory.replace(iso_mount, "")
1295 mkdir(os.path.join(target, directory))
1296 exec_rsync(loopback_cfg, target + os.path.sep + directory)
1298 # avoid the "file is read only, overwrite anyway (y/n) ?" question
1299 # of mtools by syslinux ("mmove -D o -D O s:/ldlinux.sys $target_file")
1300 if os.path.isfile(syslinux_target + 'ldlinux.sys'):
1301 os.unlink(syslinux_target + 'ldlinux.sys')
1303 (source_dir, name) = get_defaults_file(iso_mount, GRML_DEFAULT, "default.cfg")
1304 (source_dir, defaults_file) = get_defaults_file(iso_mount, GRML_DEFAULT, "grml.cfg")
1307 logging.critical("Fatal: file default.cfg could not be found.")
1308 logging.critical("Note: this grml2usb version requires an ISO generated by grml-live >=0.9.24 ...")
1309 logging.critical(" ... either use grml releases >=2009.10 or switch to an older grml2usb version.")
1310 logging.critical(" Please visit http://grml.org/grml2usb/#grml2usb-compat for further information.")
1313 for expr in name, 'distri.cfg', \
1314 defaults_file, 'grml.png', 'hd.cfg', 'isolinux.cfg', 'isolinux.bin', \
1315 'isoprompt.cfg', 'options.cfg', \
1316 'prompt.cfg', 'vesamenu.c32', 'vesamenu.cfg', 'grml.png', '*.c32':
1317 glob_and_copy(iso_mount + source_dir + expr, syslinux_target)
1319 # copy the addons_*.cfg file to the new syslinux directory
1320 glob_and_copy(iso_mount + source_dir + 'addon*.cfg', syslinux_target)
1322 search_and_copy('hidden.cfg', iso_mount + source_dir, syslinux_target + "new_" + 'hidden.cfg')
1325 grub_target = target + '/boot/grub/'
1326 execute(mkdir, grub_target)
1328 if not os.path.isfile(GRML2USB_BASE + "/grub/splash.xpm.gz"):
1329 logging.critical("Error: %s/grub/splash.xpm.gz can not be read.", GRML2USB_BASE)
1330 logging.critical("Please make sure you've installed the grml2usb (Debian) package!")
1333 exec_rsync(GRML2USB_BASE + '/grub/splash.xpm.gz', grub_target + 'splash.xpm.gz')
1335 # grml splash in grub
1336 copy_if_exist(GRML2USB_BASE + "/grub/grml.png", grub_target + 'grml.png')
1338 # font file for graphical bootsplash in grub
1339 copy_if_exist('/usr/share/grub/ascii.pf2', grub_target + 'ascii.pf2')
1341 # always copy grub content as it might be useful
1343 glob_and_copy(iso_mount + '/boot/grub/*.mod', grub_target)
1344 glob_and_copy(iso_mount + '/boot/grub/*.img', grub_target)
1345 glob_and_copy(iso_mount + '/boot/grub/stage*', grub_target)
1347 def install_iso_files(grml_flavour, iso_mount, device, target):
1348 """Copy files from ISO to given target
1350 @grml_flavour: name of grml flavour the configuration should be generated for
1351 @iso_mount: path where a grml ISO is mounted on
1352 @device: device/partition where bootloader should be installed to
1353 @target: path where grml's main files should be copied to"""
1356 GRML_DEFAULT = grml_flavour
1359 elif not options.bootloaderonly:
1360 logging.info("Copying files. This might take a while....")
1362 copy_system_files(grml_flavour, iso_mount, target)
1363 copy_grml_files(iso_mount, target)
1364 except CriticalException, error:
1365 logging.critical("Execution failed: %s", error)
1368 if not options.skipaddons:
1369 if not search_file('addons', iso_mount):
1370 logging.info("Could not find addons, therefore not installing.")
1372 copy_addons(iso_mount, target)
1374 if not options.copyonly:
1375 copy_bootloader_files(iso_mount, target)
1377 if not options.dryrun:
1378 handle_bootloader_config(grml_flavour, device, target)
1380 # make sure we sync filesystems before returning
1381 proc = subprocess.Popen(["sync"])
1385 def get_flavour(flavour_str):
1386 """Returns the flavour of a grml version string
1388 return re.match(r'[\w-]*', flavour_str).group()
1390 def identify_grml_flavour(mountpath):
1391 """Get name of grml flavour
1393 @mountpath: path where the grml ISO is mounted to
1394 @return: name of grml-flavour"""
1396 version_file = search_file('grml-version', mountpath)
1398 if version_file == "":
1399 logging.critical("Error: could not find grml-version file.")
1405 tmpfile = open(version_file, 'r')
1406 for line in tmpfile.readlines():
1407 flavours.append(get_flavour(line))
1408 except TypeError, e:
1410 except Exception, e:
1411 logging.critical("Unexpected error: %s", e)
1420 def modify_grub_config(filename):
1421 """Adjust bootoptions for a grub file
1423 @filename: filename to modify
1425 if options.removeoption:
1427 for regex in options.removeoption:
1428 regexe.append(re.compile(r'%s' % regex))
1430 option_re = re.compile(r'(.*/boot/release/.*linux26.*)')
1432 for line in fileinput.input(filename, inplace=1):
1433 if regexe and option_re.search(line):
1434 for regex in regexe:
1435 line = regex.sub(' ', line)
1437 sys.stdout.write(line)
1441 def handle_grub1_config(grml_flavour, install_partition, grub_target, bootopt):
1442 """Main handler for generating grub1 configuration
1444 @grml_flavour: name of grml flavour the configuration should be generated for
1445 @install_partition: partition number for use in (hd0,X)
1446 @grub_target: path of grub's configuration files
1447 @bootoptions: additional bootoptions that should be used by default"""
1450 grub1_cfg = grub_target + 'menu.lst'
1451 logging.debug("Creating grub1 configuration file (menu.lst)")
1453 # install main configuration only *once*, no matter how many ISOs we have:
1454 if os.path.isfile(grub1_cfg):
1455 string = open(grub1_cfg).readline()
1456 main_identifier = re.compile(".*main config generated at: %s.*" % re.escape(str(DATESTAMP)))
1457 if not re.match(main_identifier, string):
1458 grub1_config_file = open(grub1_cfg, 'w')
1459 grub1_config_file.write(generate_main_grub1_config(grml_flavour, install_partition, bootopt))
1460 grub1_config_file.close()
1462 grub1_config_file = open(grub1_cfg, 'w')
1463 grub1_config_file.write(generate_main_grub1_config(grml_flavour, install_partition, bootopt))
1464 grub1_config_file.close()
1466 grub_flavour_config = True
1467 if os.path.isfile(grub1_cfg):
1468 string = open(grub1_cfg).readlines()
1469 flavour = re.compile("grml2usb for %s: %s" % (re.escape(grml_flavour), re.escape(str(DATESTAMP))))
1471 if flavour.match(line):
1472 grub_flavour_config = False
1474 if grub_flavour_config:
1475 grub1_config_file = open(grub1_cfg, 'a')
1476 grub1_config_file.write(generate_flavour_specific_grub1_config(grml_flavour, install_partition, bootopt))
1477 grub1_config_file.close()
1479 modify_grub_config(grub1_cfg)
1481 # make sure grub.conf isn't a symlink but a plain file instead,
1482 # otherwise it will break on FAT16 filesystems
1483 # this works around grub-install of (at least) Fedora 10
1484 if os.path.isfile(grub1_cfg):
1485 grubconf = grub_target + 'grub.conf'
1486 if not os.path.islink(grubconf):
1488 shutil.copyfile(grub1_cfg, grub_target + 'grub.conf')
1490 def handle_grub2_config(grml_flavour, grub_target, bootopt):
1491 """Main handler for generating grub2 configuration
1493 @grml_flavour: name of grml flavour the configuration should be generated for
1494 @grub_target: path of grub's configuration files
1495 @bootoptions: additional bootoptions that should be used by default"""
1498 grub2_cfg = grub_target + 'grub.cfg'
1499 logging.debug("Creating grub2 configuration file (grub.lst)")
1503 # install main configuration only *once*, no matter how many ISOs we have:
1504 grub_flavour_is_default = False
1505 if os.path.isfile(grub2_cfg):
1506 string = open(grub2_cfg).readline()
1507 main_identifier = re.compile(".*main config generated at: %s.*" % re.escape(str(DATESTAMP)))
1508 if not re.match(main_identifier, string):
1509 grub2_config_file = open(grub2_cfg, 'w')
1510 GRML_DEFAULT = grml_flavour
1511 grub_flavour_is_default = True
1512 grub2_config_file.write(generate_main_grub2_config(grml_flavour, bootopt))
1513 grub2_config_file.close()
1515 grub2_config_file = open(grub2_cfg, 'w')
1516 GRML_DEFAULT = grml_flavour
1517 grub_flavour_is_default = True
1518 grub2_config_file.write(generate_main_grub2_config(grml_flavour, bootopt))
1519 grub2_config_file.close()
1521 # install flavour specific configuration only *once* as well
1522 grub_flavour_config = True
1523 if os.path.isfile(grub2_cfg):
1524 string = open(grub2_cfg).readlines()
1525 flavour = re.compile("grml2usb for %s: %s" % (re.escape(grml_flavour), re.escape(str(DATESTAMP))))
1527 if flavour.match(line):
1528 grub_flavour_config = False
1530 if grub_flavour_config:
1531 grub2_config_file = open(grub2_cfg, 'a')
1532 # display only if the grml flavour isn't the default
1533 if not grub_flavour_is_default:
1534 GRML_FLAVOURS.add(grml_flavour)
1535 grub2_config_file.write(generate_flavour_specific_grub2_config(grml_flavour, bootopt))
1536 grub2_config_file.close()
1538 modify_grub_config(grub2_cfg)
1541 def handle_grub_config(grml_flavour, device, target):
1542 """Main handler for generating grub (v1 and v2) configuration
1544 @grml_flavour: name of grml flavour the configuration should be generated for
1545 @device: device/partition where grub should be installed to
1546 @target: path of grub's configuration files"""
1548 logging.debug("Generating grub configuration")
1550 grub_target = target + '/boot/grub/'
1552 if os.path.isdir(device):
1553 install_grub1_partition = None
1555 if device[-1:].isdigit():
1556 install_grub1_partition = int(device[-1:]) - 1
1558 raise CriticalException("error validating partition schema (raw device?)")
1560 # do NOT write "None" in kernel cmdline
1561 if options.bootoptions is None:
1564 bootopt = options.bootoptions
1567 handle_grub1_config(grml_flavour, install_grub1_partition, grub_target, bootopt)
1569 handle_grub2_config(grml_flavour, grub_target, bootopt)
1572 def initial_syslinux_config(target):
1573 """Generates intial syslinux configuration
1575 @target path of syslinux's configuration files"""
1577 target = target + "/"
1578 filename = target + "grmlmain.cfg"
1579 if os.path.isfile(target + "grmlmain.cfg"):
1581 data = open(filename, "w")
1582 data.write(generate_main_syslinux_config())
1585 filename = target + "hiddens.cfg"
1586 data = open(filename, "w")
1587 data.write("include hidden.cfg\n")
1590 def add_entry_if_not_present(filename, entry):
1591 """Write entry into filename if entry is not already in the file
1593 @filanme: name of the file
1594 @entry: data to write to the file
1596 data = open(filename, "a+")
1605 def get_flavour_filename(flavour):
1606 """Generate a iso9960 save filename out of the specified flavour
1608 @flavour: grml flavour
1610 return flavour.replace('-', '_')
1612 def adjust_syslinux_bootoptions(src, flavour):
1613 """Adjust existing bootoptions of specified syslinux config to
1614 grml2usb specific ones, e.g. change the location of the kernel...
1616 @src: config file to alter
1617 @flavour: grml flavour
1620 append_re = re.compile("^(\s*append.*/boot/release.*)$", re.I)
1621 boot_re = re.compile("/boot/([a-zA-Z0-9_]+/)+([a-zA-Z0-9._]+)")
1622 # flavour_re = re.compile("(label.*)(grml\w+)")
1623 default_re = re.compile("(default.cfg)")
1624 bootid_re = re.compile("bootid=[\w_-]+")
1625 live_media_path_re = re.compile("live-media-path=[\w_/-]+")
1627 # do NOT write "None" in kernel cmdline
1628 if options.bootoptions is None:
1631 bootopt = options.bootoptions
1635 if options.removeoption:
1636 option_re = re.compile(r'/boot/release/.*/initrd.gz')
1638 for regex in options.removeoption:
1639 regexe.append(re.compile(r'%s' % regex))
1641 for line in fileinput.input(src, inplace=1):
1642 line = boot_re.sub(r'/boot/release/%s/\2 ' % flavour.replace('-', ''), line)
1643 # line = flavour_re.sub(r'\1 %s-\2' % flavour, line)
1644 line = default_re.sub(r'%s-\1' % flavour, line)
1645 line = bootid_re.sub('', line)
1646 line = live_media_path_re.sub('', line)
1647 line = append_re.sub(r'\1 live-media-path=/live/%s/ ' % flavour, line)
1648 line = append_re.sub(r'\1 boot=live %s ' % bootopt, line)
1649 line = append_re.sub(r'\1 %s=%s ' % ("bootid", UUID), line)
1650 if option_re and option_re.search(line):
1651 for regex in regexe:
1652 line = regex.sub(' ', line)
1653 sys.stdout.write(line)
1656 def adjust_labels(src, replacement):
1657 """Adjust the specified labels in the syslinux config file src with
1658 specified replacement
1660 label_re = re.compile("^(\s*label\s*) ([a-zA-Z0-9_-]+)", re.I)
1661 for line in fileinput.input(src, inplace=1):
1662 line = label_re.sub(replacement, line)
1663 sys.stdout.write(line)
1667 def add_syslinux_entry(filename, grml_flavour):
1668 """Add includes for a specific grml_flavour to the specified filename
1670 @filename: syslinux config file
1671 @grml_flavour: grml flavour to add
1674 entry_filename = "option_%s.cfg" % grml_flavour
1675 entry = "include %s\n" % entry_filename
1677 add_entry_if_not_present(filename, entry)
1678 path = os.path.dirname(filename)
1680 data = open(path + "/" + entry_filename, "w")
1681 data.write(generate_flavour_specific_syslinux_config(grml_flavour))
1684 def modify_filenames(grml_flavour, target, filenames):
1685 """Replace the standarf filenames with the new ones
1687 @grml_flavour: grml-flavour strin
1688 @target: directory where the files are located
1689 @filenames: list of filenames to alter
1691 grml_filename = grml_flavour.replace('-', '_')
1692 for filename in filenames:
1693 old_filename = "%s/%s" % (target, filename)
1694 new_filename = "%s/%s_%s" % (target, grml_filename, filename)
1695 os.rename(old_filename, new_filename)
1698 def remove_default_entry(filename):
1699 """Remove the default entry from specified syslinux file
1701 @filename: syslinux config file
1703 default_re = re.compile("^(\s*menu\s*default\s*)$", re.I)
1704 for line in fileinput.input(filename, inplace=1):
1705 if default_re.match(line):
1707 sys.stdout.write(line)
1711 def handle_syslinux_config(grml_flavour, target):
1712 """Main handler for generating syslinux configuration
1714 @grml_flavour: name of grml flavour the configuration should be generated for
1715 @target: path of syslinux's configuration files"""
1717 logging.debug("Generating syslinux configuration")
1718 syslinux_target = target + '/boot/syslinux/'
1719 # should be present via copy_bootloader_files(), but make sure it exits:
1720 execute(mkdir, syslinux_target)
1721 syslinux_cfg = syslinux_target + 'syslinux.cfg'
1724 # install main configuration only *once*, no matter how many ISOs we have:
1725 syslinux_config_file = open(syslinux_cfg, 'w')
1726 syslinux_config_file.write("TIMEOUT 300\n")
1727 syslinux_config_file.write("include vesamenu.cfg\n")
1728 syslinux_config_file.close()
1730 prompt_name = open(syslinux_target + 'promptname.cfg', 'w')
1731 prompt_name.write('menu label S^yslinux prompt\n')
1734 initial_syslinux_config(syslinux_target)
1735 flavour_filename = grml_flavour.replace('-', '_')
1737 if search_file('default.cfg', syslinux_target):
1738 modify_filenames(grml_flavour, syslinux_target, ['grml.cfg', 'default.cfg'])
1740 filename = search_file("new_hidden.cfg", syslinux_target)
1743 # process hidden file
1744 if not search_file("hidden.cfg", syslinux_target):
1745 new_hidden = syslinux_target + "hidden.cfg"
1746 os.rename(filename, new_hidden)
1747 adjust_syslinux_bootoptions(new_hidden, grml_flavour)
1749 new_hidden_file = "%s/%s_hidden.cfg" % (syslinux_target, flavour_filename)
1750 os.rename(filename, new_hidden_file)
1751 adjust_labels(new_hidden_file, r'\1 %s-\2' % grml_flavour)
1752 adjust_syslinux_bootoptions(new_hidden_file, grml_flavour)
1753 entry = 'include %s_hidden.cfg\n' % flavour_filename
1754 add_entry_if_not_present("%s/hiddens.cfg" % syslinux_target, entry)
1758 new_default = "%s_default.cfg" % (flavour_filename)
1759 entry = 'include %s\n' % new_default
1760 defaults_file = '%s/defaults.cfg' % syslinux_target
1761 new_default_with_path = "%s/%s" % (syslinux_target, new_default)
1762 new_grml_cfg = "%s/%s_grml.cfg" % ( syslinux_target, flavour_filename)
1764 if os.path.isfile(defaults_file):
1766 # remove default menu entry in menu
1767 remove_default_entry(new_default_with_path)
1769 # adjust all labels for additional isos
1770 adjust_labels(new_default_with_path, r'\1 %s' % grml_flavour)
1771 adjust_labels(new_grml_cfg, r'\1 %s-\2' % grml_flavour)
1773 # always adjust bootoptions
1774 adjust_syslinux_bootoptions(new_default_with_path, grml_flavour)
1775 adjust_syslinux_bootoptions(new_grml_cfg, grml_flavour)
1777 add_entry_if_not_present("%s/defaults.cfg" % syslinux_target, entry)
1779 add_syslinux_entry("%s/additional.cfg" % syslinux_target, flavour_filename)
1782 def handle_bootloader_config(grml_flavour, device, target):
1783 """Main handler for generating bootloader's configuration
1785 @grml_flavour: name of grml flavour the configuration should be generated for
1786 @device: device/partition where bootloader should be installed to
1787 @target: path of bootloader's configuration files"""
1790 UUID = get_uuid(target)
1791 if options.skipsyslinuxconfig:
1792 logging.info("Skipping generation of syslinux configuration as requested.")
1795 handle_syslinux_config(grml_flavour, target)
1796 except CriticalException, error:
1797 logging.critical("Fatal: %s", error)
1800 if options.skipgrubconfig:
1801 logging.info("Skipping generation of grub configuration as requested.")
1804 handle_grub_config(grml_flavour, device, target)
1805 except CriticalException, error:
1806 logging.critical("Fatal: %s", error)
1811 def install(image, device):
1812 """Install a grml image to the specified device
1814 @image: directory or is file
1815 @device: partition or directory to install the device
1817 iso_mountpoint = image
1818 remove_image_mountpoint = False
1819 if os.path.isdir(image):
1820 logging.info("Using %s as install base", image)
1822 logging.info("Using ISO %s", image)
1823 iso_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
1824 register_tmpfile(iso_mountpoint)
1825 remove_image_mountpoint = True
1827 mount(image, iso_mountpoint, ["-o", "loop", "-t", "iso9660"])
1828 except CriticalException, error:
1829 logging.critical("Fatal: %s", error)
1833 install_grml(iso_mountpoint, device)
1835 if remove_image_mountpoint:
1837 remove_mountpoint(iso_mountpoint)
1838 except CriticalException, error:
1839 logging.critical("Fatal: %s", error)
1844 def install_grml(mountpoint, device):
1845 """Main logic for copying files of the currently running grml system.
1847 @mountpoin: directory where currently running live system resides (usually /live/image)
1848 @device: partition where the specified ISO should be installed to"""
1850 device_mountpoint = device
1851 if os.path.isdir(device):
1852 logging.info("Specified device is not a directory, therefore not mounting.")
1853 remove_device_mountpoint = False
1855 device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
1856 register_tmpfile(device_mountpoint)
1857 remove_device_mountpoint = True
1859 check_for_fat(device)
1860 mount(device, device_mountpoint, ['-o', 'utf8,iocharset=iso8859-1'])
1861 except CriticalException, error:
1863 mount(device, device_mountpoint, "")
1864 except CriticalException, error:
1865 logging.critical("Fatal: %s", error)
1868 grml_flavours = identify_grml_flavour(mountpoint)
1869 for flavour in set(grml_flavours):
1870 logging.info("Identified grml flavour \"%s\".", flavour)
1871 install_iso_files(flavour, mountpoint, device, device_mountpoint)
1873 if remove_device_mountpoint:
1874 remove_mountpoint(device_mountpoint)
1876 def remove_mountpoint(mountpoint):
1877 """remove a registred mountpoint
1881 unmount(mountpoint, "")
1882 if os.path.isdir(mountpoint):
1883 os.rmdir(mountpoint)
1884 unregister_tmpfile(mountpoint)
1885 except CriticalException, error:
1886 logging.critical("Fatal: %s", error)
1889 def handle_mbr(device):
1890 """Main handler for installing master boot record (MBR)
1892 @device: device where the MBR should be installed to"""
1895 logging.info("Would install MBR")
1898 if device[-1:].isdigit():
1899 mbr_device = re.match(r'(.*?)\d*$', device).group(1)
1900 partition_number = int(device[-1:]) - 1
1901 skip_install_mir_mbr = False
1903 # if we get e.g. /dev/loop1 as device we don't want to put the MBR
1904 # into /dev/loop of course, therefore use /dev/loop1 as mbr_device
1905 if mbr_device == "/dev/loop":
1907 logging.info("Detected loop device - using %s as MBR device therefore", mbr_device)
1908 skip_install_mir_mbr = True
1911 if options.syslinuxmbr:
1912 handle_syslinux_mbr(mbr_device)
1913 elif not skip_install_mir_mbr:
1915 install_mir_mbr(GRML2USB_BASE + '/mbr/mbrmgr', mbr_device, partition_number, True)
1917 install_mir_mbr(GRML2USB_BASE + '/mbr/mbrldr', mbr_device, partition_number, False)
1918 except IOError, error:
1919 logging.critical("Execution failed: %s", error)
1921 except Exception, error:
1922 logging.critical("Execution failed: %s", error)
1926 def handle_vfat(device):
1927 """Check for FAT specific settings and options
1929 @device: device that should checked / formated"""
1931 # make sure we have mkfs.vfat available
1933 if not which("mkfs.vfat") and not options.copyonly and not options.dryrun:
1934 logging.critical('Sorry, mkfs.vfat not available. Exiting.')
1935 logging.critical('Please make sure to install dosfstools.')
1939 print "Forcing mkfs.fat16 on %s as requested via option --force." % device
1941 # make sure the user is aware of what he is doing
1942 f = raw_input("Are you sure you want to format the specified partition with fat16? y/N ")
1943 if f == "y" or f == "Y":
1944 logging.info("Note: you can skip this question using the option --force")
1949 except CriticalException, error:
1950 logging.critical("Execution failed: %s", error)
1953 # check for vfat filesystem
1954 if device is not None and not os.path.isdir(device) and options.syslinux:
1956 check_for_fat(device)
1957 except CriticalException, error:
1958 logging.critical("Execution failed: %s", error)
1961 if not os.path.isdir(device) and not check_for_usbdevice(device) and not options.force:
1962 print "Warning: the specified device %s does not look like a removable usb device." % device
1963 f = raw_input("Do you really want to continue? y/N ")
1964 if f == "y" or f == "Y":
1970 def handle_compat_warning(device):
1971 """Backwards compatible checks
1973 @device: device that should be checked"""
1975 # make sure we can replace old grml2usb script and warn user when using old way of life:
1976 if device.startswith("/mnt/external") or device.startswith("/mnt/usb") and not options.force:
1977 print "Warning: the semantics of grml2usb has changed."
1978 print "Instead of using grml2usb /path/to/iso %s you might" % device
1979 print "want to use grml2usb /path/to/iso /dev/... instead."
1980 print "Please check out the grml2usb manpage for details."
1981 f = raw_input("Do you really want to continue? y/N ")
1982 if f == "y" or f == "Y":
1988 def handle_logging():
1989 """Log handling and configuration"""
1991 if options.verbose and options.quiet:
1992 parser.error("please use either verbose (--verbose) or quiet (--quiet) option")
1995 FORMAT = "Debug: %(asctime)-15s %(message)s"
1996 logging.basicConfig(level=logging.DEBUG, format=FORMAT)
1998 FORMAT = "Critical: %(message)s"
1999 logging.basicConfig(level=logging.CRITICAL, format=FORMAT)
2001 FORMAT = "%(message)s"
2002 logging.basicConfig(level=logging.INFO, format=FORMAT)
2005 def handle_bootloader(device):
2006 """wrapper for installing bootloader
2008 @device: device where bootloader should be installed to"""
2010 # Install bootloader only if not using the --copy-only option
2011 if options.copyonly:
2012 logging.info("Not installing bootloader and its files as requested via option copyonly.")
2013 elif os.path.isdir(device):
2014 logging.info("Not installing bootloader as %s is a directory.", device)
2016 install_bootloader(device)
2019 def check_options(opts):
2020 """Check compability of provided user opts
2022 @opts option dict from OptionParser
2024 if opts.grubmbr and not opts.grub:
2025 logging.critical("Error: --grub-mbr requires --grub option.")
2030 """Main function [make pylint happy :)]"""
2033 print os.path.basename(sys.argv[0]) + " " + PROG_VERSION
2037 parser.error("invalid usage")
2042 # make sure we have the appropriate permissions
2045 check_options(options)
2047 logging.info("Executing grml2usb version %s", PROG_VERSION)
2050 logging.info("Running in simulation mode as requested via option dry-run.")
2053 # specified arguments
2054 device = args[len(args) - 1]
2055 isos = args[0:len(args) - 1]
2057 if not os.path.isdir(device):
2058 if device[-1:].isdigit():
2059 if int(device[-1:]) > 4 or device[-2:].isdigit():
2060 logging.critical("Fatal: installation on partition number >4 not supported. (BIOS won't support it.)")
2062 elif os.path.exists(device):
2063 logging.critical("Fatal: installation on raw device not supported. (BIOS won't support it.)")
2066 if not which("rsync"):
2067 logging.critical("Fatal: rsync not available, can not continue - sorry.")
2070 # provide upgrade path
2071 handle_compat_warning(device)
2073 # check for vfat partition
2076 # main operation (like installing files)
2078 install(iso, device)
2081 if not options.skipmbr and not os.path.isdir(device):
2084 handle_bootloader(device)
2086 logging.info("Note: grml flavour %s was installed as the default booting system.", GRML_DEFAULT)
2088 for flavour in GRML_FLAVOURS:
2089 logging.info("Note: you can boot flavour %s using '%s' on the commandline.", flavour, flavour)
2091 # finally be politely :)
2092 logging.info("Finished execution of grml2usb (%s). Have fun with your grml system.", PROG_VERSION)
2095 if __name__ == "__main__":
2098 except KeyboardInterrupt:
2099 logging.info("Received KeyboardInterrupt")
2102 ## END OF FILE #################################################################
2103 # vim:foldmethod=indent expandtab ai ft=python tw=120 fileencoding=utf-8