grml2usb

   1 #!/usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3 # pylint: disable-msg=C0302
   4 """
   5 grml2usb
   6 ~~~~~~~~
   7
   8 This script installs a grml system (either a running system or ISO[s]) to a USB device
   9
  10 :copyright: (c) 2009 by Michael Prokop <mika@grml.org>
  11 :license: GPL v2 or any later version
  12 :bugreports: http://grml.org/bugs/
  13
  14 """
  15
  16 from optparse import OptionParser
  17 from inspect import isroutine, isclass
  18 import datetime, logging, os, re, subprocess, sys, tempfile, time, os.path
  19 import fileinput
  20 import glob
  21 import uuid
  22 import struct
  23
  24 # global variables
  25 PROG_VERSION = "0.9.28~git"
  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?
  30 GRML_DEFAULT = None
  31 UUID = None
  32
  33 def syslinux_warning(option, opt, value, opt_parser):
  34     """A helper function for printing a warning about deprecated option
  35     """
  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)
  40
  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
  44     """
  45     # pylint: disable-msg=W0613
  46     setattr(opt_parser.values, option.dest, True)
  47     setattr(opt_parser.values, 'syslinux', False)
  48
  49 # cmdline parsing
  50 USAGE = "Usage: %prog [options] <[ISO[s] | /live/image]> </dev/sdX#>\n\
  51 \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\
  55 \n\
  56 Run %prog --help for usage hints, further information via: man grml2usb"
  57
  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",
  75                   callback=grub_option,
  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()
 105
 106
 107 GRML2USB_BASE = '/usr/share/grml2usb'
 108 if not os.path.isdir(GRML2USB_BASE):
 109     GRML2USB_BASE = os.path.dirname(os.path.realpath(__file__))
 110
 111
 112 class CriticalException(Exception):
 113     """Throw critical exception if the exact error is not known but fatal."
 114
 115     @Exception: message"""
 116     pass
 117
 118
 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.
 124
 125
 126 def array2string(*a):
 127     """Convert a list of integers [0;255] to a string."""
 128     return struct.pack("%sB" % len(a), *a)
 129
 130
 131 def string2array(s):
 132     """Convert a (bytes) string into a list of integers."""
 133     return struct.unpack("%sB" % len(s), s)
 134
 135
 136 def cleanup():
 137     """Cleanup function to make sure there aren't any mounted devices left behind.
 138     """
 139
 140     logging.info("Cleaning up before exiting...")
 141     proc = subprocess.Popen(["sync"])
 142     proc.wait()
 143
 144     try:
 145         for device in MOUNTED:
 146             unmount(device, "")
 147         for tmpfile in TMPFILES:
 148             os.unlink(tmpfile)
 149     # ignore: RuntimeError: Set changed size during iteration
 150     except RuntimeError:
 151         logging.debug('caught expection RuntimeError, ignoring')
 152
 153
 154 def register_tmpfile(path):
 155     """
 156     register tmpfile
 157     """
 158
 159     TMPFILES.add(path)
 160
 161
 162 def unregister_tmpfile(path):
 163     """
 164     remove registered tmpfile
 165     """
 166
 167     try:
 168         TMPFILES.remove(path)
 169     except KeyError:
 170         pass
 171
 172
 173 def register_mountpoint(target):
 174     """register specified target in a set() for handling clean exiting
 175
 176     @target: destination target of mountpoint
 177     """
 178
 179     MOUNTED.add(target)
 180
 181
 182 def unregister_mountpoint(target):
 183     """unregister specified target in a set() for handling clean exiting
 184
 185     @target: destination target of mountpoint
 186     """
 187
 188     if target in MOUNTED:
 189         MOUNTED.remove(target)
 190
 191
 192 def get_function_name(obj):
 193     """Helper function for use in execute() to retrive name of a function
 194
 195     @obj: the function object
 196     """
 197     if not (isroutine(obj) or isclass(obj)):
 198         obj = type(obj)
 199     return obj.__module__ + '.' + obj.__name__
 200
 201
 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"]))
 207     if options.dryrun:
 208         # pylint: disable-msg=W0141
 209         logging.debug('dry-run only: %s(%s)', get_function_name(f), ', '.join(map(repr, exec_arguments)))
 210     else:
 211         # pylint: disable-msg=W0142
 212         return f(*exec_arguments)
 213
 214
 215 def is_exe(fpath):
 216     """Check whether a given file can be executed
 217
 218     @fpath: full path to file
 219     @return:"""
 220     return os.path.exists(fpath) and os.access(fpath, os.X_OK)
 221
 222
 223 def which(program):
 224     """Check whether a given program is available in PATH
 225
 226     @program: name of executable"""
 227     fpath = os.path.split(program)[0]
 228     if fpath:
 229         if is_exe(program):
 230             return program
 231     else:
 232         for path in os.environ["PATH"].split(os.pathsep):
 233             exe_file = os.path.join(path, program)
 234             if is_exe(exe_file):
 235                 return exe_file
 236
 237     return None
 238
 239
 240 def get_defaults_file(iso_mount, flavour, name):
 241     """get the default file for syslinux
 242     """
 243     bootloader_dirs = ['/boot/isolinux/', '/boot/syslinux/']
 244     for directory in bootloader_dirs:
 245         for name in name, \
 246         "%s_%s" % (get_flavour_filename(flavour), name):
 247             if os.path.isfile(iso_mount + directory + name):
 248                 return (directory, name)
 249     return ('','')
 250
 251 def search_file(filename, search_path='/bin' + os.pathsep + '/usr/bin'):
 252     """Given a search path, find file
 253
 254     @filename: name of file to search for
 255     @search_path: path where searching for the specified filename"""
 256     file_found = 0
 257     paths = search_path.split(os.pathsep)
 258     current_dir = '' # make pylint happy :)
 259
 260     def match_file(cwd):
 261         """Helper function ffor testing if specified file exists in cwd
 262
 263         @cwd: current working directory
 264         """
 265         return  os.path.exists(os.path.join(cwd, filename))
 266
 267     for path in paths:
 268         current_dir = path
 269         if match_file(current_dir):
 270             file_found = 1
 271             break
 272         # pylint: disable-msg=W0612
 273         for current_dir, directories, files in os.walk(path):
 274             if match_file(current_dir):
 275                 file_found = 1
 276                 break
 277     if file_found:
 278         return os.path.abspath(os.path.join(current_dir, filename))
 279     else:
 280         return None
 281
 282
 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).")
 287
 288
 289 def mkfs_fat16(device):
 290     """Format specified device with VFAT/FAT16 filesystem.
 291
 292     @device: partition that should be formated"""
 293
 294     if options.dryrun:
 295         logging.info("Would execute mkfs.vfat -F 16 %s now.", device)
 296         return 0
 297
 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])
 301     proc.wait()
 302     if proc.returncode != 0:
 303         raise CriticalException("error executing mkfs.vfat")
 304
 305
 306 def generate_main_grub2_config(grml_flavour, bootoptions):
 307     """Generate grub2 configuration for use via grub.cfg
 308
 309     @grml_flavour: name of grml flavour the configuration should be generated for
 310     @bootoptions: additional bootoptions that should be used by default"""
 311
 312     local_datestamp = DATESTAMP
 313
 314     return("""\
 315 ## main grub2 configuration - generated by grml2usb [main config generated at: %(local_datestamp)s]
 316 set default=0
 317 set timeout=10
 318
 319 insmod fat
 320
 321 if loadfont /boot/grub/ascii.pf2 ; then
 322    insmod png
 323    set gfxmode=640x480
 324    insmod gfxterm
 325    insmod vbe
 326    if terminal_output.gfxterm ; then true ; else
 327     # For backward compatibility with versions of terminal.mod that don't
 328     # understand terminal_output
 329     terminal gfxterm
 330    fi
 331 fi
 332
 333 if background_image /boot/grub/grml.png ; then
 334   set color_normal=black/black
 335   set color_highlight=red/black
 336 else
 337   set menu_color_normal=white/black
 338   set menu_color_highlight=black/yellow
 339 fi
 340
 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
 345 }
 346
 347 menuentry "Memory test (memtest86+)" {
 348     linux16   /boot/addons/memtest
 349 }
 350
 351 menuentry "Boot Grub (all in one image)" {
 352     linux   /boot/addons/memdisk
 353     initrd  /boot/addons/allinone.img
 354 }
 355
 356 menuentry "Boot FreeDOS" {
 357     linux   /boot/addons/memdisk
 358     initrd  /boot/addons/balder10.imz
 359 }
 360
 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
 371 }
 372
 373 menuentry "Boot OS of first partition on first disk" {
 374     set root=(hd0,1)
 375     chainloader +1
 376 }
 377
 378 """ % {'grml_flavour': grml_flavour, 'local_datestamp': local_datestamp,
 379        'flavour_filename': grml_flavour.replace('-', ''),
 380        'uid': UUID, 'bootoptions': bootoptions } )
 381
 382
 383 def generate_flavour_specific_grub2_config(grml_flavour, bootoptions):
 384     """Generate grub2 configuration for use via grub.cfg
 385
 386     @grml_flavour: name of grml flavour the configuration should be generated for
 387     @bootoptions: additional bootoptions that should be used by default"""
 388
 389     local_datestamp = DATESTAMP
 390
 391     return("""\
 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
 397 }
 398
 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
 404 }
 405
 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
 411 }
 412
 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
 418 }
 419
 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
 425 }
 426
 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
 431 }
 432
 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
 437 }
 438
 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
 444 }
 445
 446 """ % {'grml_flavour': grml_flavour, 'local_datestamp': local_datestamp,
 447        'flavour_filename': grml_flavour.replace('-', ''),
 448        'uid': UUID, 'bootoptions': bootoptions } )
 449
 450
 451 def generate_flavour_specific_grub1_config(grml_flavour, install_partition, bootoptions):
 452     """Generate grub1 configuration for use via menu.lst
 453
 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"""
 457
 458     local_datestamp = DATESTAMP
 459
 460     return("""\
 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
 465
 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
 470
 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
 475
 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
 480
 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
 485
 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
 490
 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
 495
 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
 500
 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
 505
 506 """ % {'grml_flavour': grml_flavour, 'local_datestamp': local_datestamp,
 507        'flavour_filename': grml_flavour.replace('-', ''), 'uid': UUID,
 508        'bootoptions': bootoptions, 'install_partition': install_partition } )
 509
 510
 511 def generate_main_grub1_config(grml_flavour, install_partition, bootoptions):
 512     """Generate grub1 configuration for use via menu.lst
 513
 514     @grml_flavour: name of grml flavour the configuration should be generated for"""
 515
 516     local_datestamp = DATESTAMP
 517
 518     return("""\
 519 ## main grub1 configuration - generated by grml2usb [main config generated at: %(local_datestamp)s]
 520 # misc options:
 521 timeout 30
 522 # color red/blue green/black
 523 splashimage=(hd0,%(install_partition)s)/boot/grub/splash.xpm.gz
 524 foreground  = 000000
 525 background  = FFCC33
 526
 527 # define entries:
 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
 531
 532 title Memory test (memtest86+)
 533 kernel (hd0,%(install_partition)s)/boot/addons/memtest
 534
 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
 538
 539 title FreeDOS
 540 kernel (hd0,%(install_partition)s)/boot/addons/memdisk
 541 initrd (hd0,%(install_partition)s)/boot/addons/balder10.imz
 542
 543 title MirOS BSD
 544 kernel (hd0,%(install_partition)s)/boot/addons/bsd4grml/ldbsd.com
 545
 546 """ % {'grml_flavour': grml_flavour, 'local_datestamp': local_datestamp,
 547        'flavour_filename': grml_flavour.replace('-', ''), 'uid': UUID,
 548        'bootoptions': bootoptions, 'install_partition': install_partition } )
 549
 550
 551 def generate_isolinux_splash(grml_flavour):
 552     """Generate bootsplash for isolinux/syslinux
 553
 554     @grml_flavour: name of grml flavour the configuration should be generated for"""
 555
 556     grml_name = grml_flavour
 557
 558     return("""\
 559 \ f17\f\18/boot/syslinux/logo.16
 560
 561 Some information and boot options available via keys F2 - F10. http://grml.org/
 562 %(grml_name)s
 563 """ % {'grml_name': grml_name} )
 564
 565
 566 def generate_main_syslinux_config(*arg):
 567     """Generate main configuration for use in syslinux.cfg
 568
 569     @*arg: just for backward compatibility"""
 570     # pylint: disable-msg=W0613
 571     # remove warning about unused arg
 572
 573     return("""\
 574 label -
 575 menu label Default boot modes:
 576 menu disable
 577 include defaults.cfg
 578
 579 menu end
 580 menu separator
 581
 582 # flavours:
 583 label -
 584 menu label Additional boot entries for:
 585 menu disable
 586 include additional.cfg
 587
 588 menu separator
 589 include options.cfg
 590 include addons.cfg
 591
 592 label help
 593   include promptname.cfg
 594   config prompt.cfg
 595   text help
 596                                         Jump to old style isolinux prompt
 597                                         featuring further information
 598                                         regarding available boot options.
 599   endtext
 600
 601
 602 include hiddens.cfg
 603 """)
 604
 605
 606 def generate_flavour_specific_syslinux_config(grml_flavour):
 607     """Generate flavour specific configuration for use in syslinux.cfg
 608
 609     @grml_flavour: name of grml flavour the configuration should be generated for"""
 610
 611
 612     return("""\
 613 menu begin grml %(grml_flavour)s
 614     menu title %(display_name)s
 615     label mainmenu
 616     menu label ^Back to main menu...
 617     menu exit
 618     menu separator
 619     # include config for boot parameters from disk
 620     include %(grml_flavour)s_grml.cfg
 621     menu hide
 622 menu end
 623 """ % {'grml_flavour': grml_flavour, 'display_name' : grml_flavour.replace('_', '-') } )
 624
 625
 626 def install_grub(device):
 627     """Install grub on specified device.
 628
 629     @mntpoint: mountpoint of device where grub should install its files to
 630     @device: partition where grub should be installed to"""
 631
 632     if options.dryrun:
 633         logging.info("Would execute grub-install [--root-directory=mount_point] %s now.", device)
 634     else:
 635         device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
 636         register_tmpfile(device_mountpoint)
 637         try:
 638             try:
 639                 mount(device, device_mountpoint, "")
 640
 641                 # If using --grub-mbr then make sure we install grub in MBR instead of PBR
 642                 if options.grubmbr:
 643                     logging.debug("Using option --grub-mbr ...")
 644                     if device[-1:].isdigit():
 645                         grub_device = re.match(r'(.*?)\d*$', device).group(1)
 646                     else:
 647                         grub_device = device
 648                 else:
 649                     grub_device = device
 650
 651                 logging.info("Installing grub as bootloader")
 652                 logging.debug("grub-install --recheck --force --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+"))
 657                 proc.wait()
 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.")
 664                     cleanup()
 665                     sys.exit(1)
 666             except CriticalException, error:
 667                 logging.critical("Fatal: %s", error)
 668                 cleanup()
 669                 sys.exit(1)
 670
 671         finally:
 672             unmount(device_mountpoint, "")
 673             os.rmdir(device_mountpoint)
 674             unregister_tmpfile(device_mountpoint)
 675
 676
 677 def install_syslinux(device):
 678     """Install syslinux on specified device.
 679
 680     @device: partition where syslinux should be installed to"""
 681
 682     if options.dryrun:
 683         logging.info("Would install syslinux as bootloader on %s", device)
 684         return 0
 685
 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])
 690     proc.wait()
 691     if proc.returncode != 0:
 692         raise CriticalException("Error executing syslinux (either try --fat16 or use grub?)")
 693
 694
 695 def install_bootloader(device):
 696     """Install bootloader on specified device.
 697
 698     @device: partition where bootloader should be installed to"""
 699
 700     # by default we use grub, so install syslinux only on request
 701     if options.grub:
 702         try:
 703             install_grub(device)
 704         except CriticalException, error:
 705             logging.critical("Fatal: %s", error)
 706             cleanup()
 707             sys.exit(1)
 708     else:
 709         try:
 710             install_syslinux(device)
 711         except CriticalException, error:
 712             logging.critical("Fatal: %s", error)
 713             cleanup()
 714             sys.exit(1)
 715
 716
 717 def execute_lilo(lilo, device):
 718     """execute lilo for activating the partitions in the MBR
 719
 720     @lilo: path of lilo executable
 721     @device: device where lilo should be executed on"""
 722
 723     # to support -A for extended partitions:
 724     logging.info("Activating partitions in MBR via lilo")
 725     logging.debug("%s -S /dev/null -M %s ext", lilo, device)
 726     proc = subprocess.Popen([lilo, "-S", "/dev/null", "-M", device, "ext"])
 727     proc.wait()
 728     if proc.returncode != 0:
 729         raise Exception("error executing lilo")
 730
 731     # activate partition:
 732     logging.debug("%s -S /dev/null -A %s 1", lilo, device)
 733     proc = subprocess.Popen([lilo, "-S", "/dev/null", "-A", device, "1"])
 734     proc.wait()
 735     if proc.returncode != 0:
 736         raise Exception("error executing lilo")
 737
 738
 739 def install_syslinux_mbr(device):
 740     """install syslinux's master boot record (MBR) on the specified device
 741
 742     @device: device where MBR of syslinux should be installed to"""
 743
 744     # make sure we have syslinux available
 745     if not which("syslinux") and not options.copyonly:
 746         raise Exception("syslinux not available (either install it or consider using the --grub option)")
 747
 748     # lilo's mbr is broken, use the one from syslinux instead:
 749     if not os.path.isfile("/usr/lib/syslinux/mbr.bin"):
 750         raise Exception("/usr/lib/syslinux/mbr.bin can not be read")
 751
 752     logging.info("Installing syslinux MBR")
 753     logging.debug("cat /usr/lib/syslinux/mbr.bin > %s", device)
 754     try:
 755         retcode = subprocess.call("cat /usr/lib/syslinux/mbr.bin > "+ device, shell=True)
 756         if retcode < 0:
 757             logging.critical("Error copying MBR to device (%s)", retcode)
 758     except OSError, error:
 759         logging.critical("Execution failed: %s", error)
 760
 761
 762 def install_mir_mbr(mbrtemplate, device, partition, ismirbsdmbr=True):
 763     """install 'mbr' master boot record (MBR) on a device
 764
 765     Retrieve the partition table from "device", install an MBR from the
 766     "mbrtemplate" file, set the "partition" (0..3) active, and install the
 767     result back to "device".
 768
 769     @mbrtemplate: default MBR file
 770
 771     @device: name of a file assumed to be a hard disc (or USB stick) image, or
 772     something like "/dev/sdb"
 773
 774     @partition: must be a number between 0 and 3, inclusive
 775
 776     @mbrtemplate: must be a valid MBR file of at least 440 (or 439 if
 777     ismirbsdmbr) bytes.
 778
 779     @ismirbsdmbr: if true then ignore the active flag, set the mirbsdmbr
 780     specific flag to 0/1/2/3 and set the MBR's default value accordingly. If
 781     false then leave the mirbsdmbr specific flag set to FFh, set all
 782     active flags to 0 and set the active flag of the partition to 80h.  Note:
 783     behaviour of mirbsdmbr: if flag = 0/1/2/3 then use it, otherwise search for
 784     the active flag."""
 785
 786     logging.info("Installing default MBR")
 787
 788     if not os.path.isfile(mbrtemplate):
 789         logging.critical("Error: %s can not be read.", mbrtemplate)
 790         raise CriticalException("Error installing MBR (either try --syslinux-mbr or install missing file?)")
 791
 792     if (partition < 0) or (partition > 3):
 793         raise ValueError("partition must be between 0 and 3")
 794
 795     if ismirbsdmbr:
 796         nmbrbytes = 439
 797     else:
 798         nmbrbytes = 440
 799
 800     tmpf = tempfile.NamedTemporaryFile()
 801
 802     logging.debug("executing: dd if='%s' of='%s' bs=512 count=1", device, tmpf.name)
 803     proc = subprocess.Popen(["dd", "if=%s" % device, "of=%s" % tmpf.name, "bs=512", "count=1"],
 804                             stderr=file(os.devnull, "r+"))
 805     proc.wait()
 806     if proc.returncode != 0:
 807         raise Exception("error executing dd (first run)")
 808
 809     logging.debug("executing: dd if=%s of=%s bs=%s count=1 conv=notrunc", mbrtemplate,
 810                   tmpf.name, nmbrbytes)
 811     proc = subprocess.Popen(["dd", "if=%s" % mbrtemplate, "of=%s" % tmpf.name, "bs=%s" % nmbrbytes,
 812                              "count=1", "conv=notrunc"], stderr=file(os.devnull, "r+"))
 813     proc.wait()
 814     if proc.returncode != 0:
 815         raise Exception("error executing dd (second run)")
 816
 817     mbrcode = tmpf.file.read(512)
 818     if len(mbrcode) < 512:
 819         raise EOFError("MBR size (%d) < 512" % len(mbrcode))
 820
 821     if ismirbsdmbr:
 822         mbrcode = mbrcode[0:439] + chr(partition) + \
 823                 mbrcode[440:510] + "\x55\xAA"
 824     else:
 825         actives = ["\x00", "\x00", "\x00", "\x00"]
 826         actives[partition] = "\x80"
 827         mbrcode = mbrcode[0:446] + actives[0] + \
 828                 mbrcode[447:462] + actives[1] + \
 829                 mbrcode[463:478] + actives[2] + \
 830                 mbrcode[479:494] + actives[3] + \
 831                 mbrcode[495:510] + "\x55\xAA"
 832
 833     tmpf.file.seek(0)
 834     tmpf.file.truncate()
 835     tmpf.file.write(mbrcode)
 836     tmpf.file.close()
 837
 838     logging.debug("executing: dd if='%s' of='%s' bs=512 count=1 conv=notrunc", tmpf.name, device)
 839     proc = subprocess.Popen(["dd", "if=%s" % tmpf.name, "of=%s" % device, "bs=512", "count=1",
 840                              "conv=notrunc"], stderr=file(os.devnull, "r+"))
 841     proc.wait()
 842     if proc.returncode != 0:
 843         raise Exception("error executing dd (third run)")
 844     del tmpf
 845
 846
 847 def handle_syslinux_mbr(device):
 848     """Install syslinux master boot record on given device
 849
 850     @device: device where MBR should be installed to"""
 851
 852     if not is_writeable(device):
 853         raise IOError("device not writeable for user")
 854
 855     # try to use system's lilo
 856     if which("lilo"):
 857         lilo = which("lilo")
 858     else:
 859         # otherwise fall back to our static version
 860         from platform import architecture
 861         if architecture()[0] == '64bit':
 862             lilo = GRML2USB_BASE + '/lilo/lilo.static.amd64'
 863         else:
 864             lilo = GRML2USB_BASE + '/lilo/lilo.static.i386'
 865     # finally prefer a specified lilo executable
 866     if options.lilobin:
 867         lilo = options.lilobin
 868
 869     if not is_exe(lilo):
 870         raise Exception("lilo executable can not be execute")
 871
 872     if options.dryrun:
 873         logging.info("Would install MBR running lilo and using syslinux.")
 874         return 0
 875
 876     execute_lilo(lilo, device)
 877     install_syslinux_mbr(device)
 878
 879
 880 def is_writeable(device):
 881     """Check if the device is writeable for the current user
 882
 883     @device: partition where bootloader should be installed to"""
 884
 885     if not device:
 886         return False
 887         #raise Exception("no device for checking write permissions")
 888
 889     if not os.path.exists(device):
 890         return False
 891
 892     return os.access(device, os.W_OK) and os.access(device, os.R_OK)
 893
 894
 895 def mount(source, target, mount_options):
 896     """Mount specified source on given target
 897
 898     @source: name of device/ISO that should be mounted
 899     @target: directory where the ISO should be mounted to
 900     @options: mount specific options"""
 901
 902     # note: options.dryrun does not work here, as we have to
 903     # locate files and identify the grml flavour
 904
 905     for x in file('/proc/mounts').readlines():
 906         if x.startswith(source):
 907             raise CriticalException("Error executing mount: %s already mounted - " % source
 908                                     + "please unmount before invoking grml2usb")
 909
 910     if os.path.isdir(source):
 911         logging.debug("Source %s is not a device, therefore not mounting.", source)
 912         return 0
 913
 914     logging.debug("mount %s %s %s", mount_options, source, target)
 915     proc = subprocess.Popen(["mount"] + list(mount_options) + [source, target])
 916     proc.wait()
 917     if proc.returncode != 0:
 918         raise CriticalException("Error executing mount (no filesystem on the partition?)")
 919     else:
 920         logging.debug("register_mountpoint(%s)", target)
 921         register_mountpoint(target)
 922
 923
 924 def unmount(target, unmount_options):
 925     """Unmount specified target
 926
 927     @target: target where something is mounted on and which should be unmounted
 928     @options: options for umount command"""
 929
 930     # make sure we unmount only already mounted targets
 931     target_unmount = False
 932     mounts = open('/proc/mounts').readlines()
 933     mountstring = re.compile(".*%s.*" % re.escape(os.path.realpath(target)))
 934     for line in mounts:
 935         if re.match(mountstring, line):
 936             target_unmount = True
 937
 938     if not target_unmount:
 939         logging.debug("%s not mounted anymore", target)
 940     else:
 941         logging.debug("umount %s %s", list(unmount_options), target)
 942         proc = subprocess.Popen(["umount"] + list(unmount_options) + [target])
 943         proc.wait()
 944         if proc.returncode != 0:
 945             raise Exception("Error executing umount")
 946         else:
 947             logging.debug("unregister_mountpoint(%s)", target)
 948             unregister_mountpoint(target)
 949
 950
 951 def check_for_usbdevice(device):
 952     """Check whether the specified device is a removable USB device
 953
 954     @device: device name, like /dev/sda1 or /dev/sda
 955     """
 956
 957     usbdevice = re.match(r'/dev/(.*?)\d*$', device).group(1)
 958     # newer systems:
 959     usbdev = os.path.realpath('/sys/class/block/' + usbdevice + '/removable')
 960     if not os.path.isfile(usbdev):
 961         # Ubuntu with kernel 2.6.24 for example:
 962         usbdev = os.path.realpath('/sys/block/' + usbdevice + '/removable')
 963
 964     if os.path.isfile(usbdev):
 965         is_usb = open(usbdev).readline()
 966         if is_usb.find("1"):
 967             return 0
 968
 969     return 1
 970
 971
 972 def check_for_fat(partition):
 973     """Check whether specified partition is a valid VFAT/FAT16 filesystem
 974
 975     @partition: device name of partition"""
 976
 977     if not os.access(partition, os.R_OK):
 978         raise CriticalException("Failed to read device %s"
 979                 " (wrong UID/permissions or device/directory not present?)" % partition)
 980
 981     try:
 982         udev_info = subprocess.Popen(["/sbin/blkid", "-s", "TYPE", "-o", "value", partition],
 983                                      stdout=subprocess.PIPE, stderr=subprocess.PIPE)
 984         filesystem = udev_info.communicate()[0].rstrip()
 985
 986         if filesystem != "vfat":
 987             raise CriticalException(
 988                     "Partition %s does not contain a FAT16 filesystem. "
 989                     "(Use --fat16 or run mkfs.vfat %s)" % (partition, partition))
 990
 991     except OSError:
 992         raise CriticalException("Sorry, /sbin/blkid not available (install e2fsprogs?)")
 993
 994
 995 def mkdir(directory):
 996     """Simple wrapper around os.makedirs to get shell mkdir -p behaviour"""
 997
 998     # just silently pass as it's just fine it the directory exists
 999     if not os.path.isdir(directory):
1000         try:
1001             os.makedirs(directory)
1002         # pylint: disable-msg=W0704
1003         except OSError:
1004             pass
1005
1006
1007 def exec_rsync(source, target):
1008     """Simple wrapper around rsync to install files
1009
1010     @source: source file/directory
1011     @target: target file/directory"""
1012     logging.debug("Source: %s / Target: %s", source, target)
1013     proc = subprocess.Popen(["rsync", "-rlptDH", "--inplace", source, target])
1014     proc.wait()
1015     if proc.returncode == 12:
1016         logging.critical("Fatal: No space left on device")
1017         cleanup()
1018         sys.exit(1)
1019
1020     if proc.returncode != 0:
1021         logging.critical("Fatal: could not install %s", source)
1022         cleanup()
1023         sys.exit(1)
1024
1025
1026 def write_uuid(target_file):
1027     """Generates an returns uuid and write it to the specified file
1028
1029     @target_file: filename to write the uuid to
1030     """
1031
1032     fileh = open(target_file, 'w')
1033     uid = str(uuid.uuid4())
1034     fileh.write(uid)
1035     fileh.close()
1036     return uid
1037
1038
1039 def get_uuid(target):
1040     """Get the uuid of the specified target. Will generate an uuid if none exist.
1041
1042     @target: directory/mountpoint containing the grml layout
1043     """
1044
1045     conf_target = target + "/conf/"
1046     uuid_file_name = conf_target + "/bootid.txt"
1047     if os.path.isdir(conf_target):
1048         if os.path.isfile(uuid_file_name):
1049             uuid_file = open(uuid_file_name, 'r')
1050             uid = uuid_file.readline().strip()
1051             uuid_file.close()
1052             return uid
1053         else:
1054             return write_uuid(uuid_file_name)
1055     else:
1056         execute(mkdir, conf_target)
1057         return write_uuid(uuid_file_name)
1058
1059
1060 def copy_system_files(grml_flavour, iso_mount, target):
1061     """copy grml's main files (like squashfs, kernel and initrd) to a given target
1062
1063     @grml_flavour: name of grml flavour the configuration should be generated for
1064     @iso_mount: path where a grml ISO is mounted on
1065     @target: path where grml's main files should be copied to"""
1066
1067     squashfs = search_file(grml_flavour + '.squashfs', iso_mount)
1068     if squashfs is None:
1069         logging.critical("Fatal: squashfs file not found")
1070         raise CriticalException("error locating squashfs file")
1071     else:
1072         squashfs_target = target + '/live/' + grml_flavour + '/'
1073         execute(mkdir, squashfs_target)
1074     exec_rsync(squashfs, squashfs_target + grml_flavour + '.squashfs')
1075
1076     for prefix in grml_flavour + "/", "":
1077         filesystem_module = search_file(prefix + 'filesystem.module', iso_mount)
1078         if filesystem_module:
1079             break
1080     if filesystem_module is None:
1081         logging.critical("Fatal: filesystem.module not found")
1082         raise CriticalException("error locating filesystem.module file")
1083     else:
1084         exec_rsync(filesystem_module, squashfs_target + 'filesystem.module')
1085
1086
1087     release_path = 'boot/release/' + grml_flavour.replace('-', '')
1088     release_target = target + "/" + release_path
1089     execute(mkdir, release_target)
1090
1091     prefix = ""
1092     if os.path.isdir(iso_mount + '/boot/release'):
1093         prefix = release_path + '/'
1094
1095     kernel = search_file(prefix + 'linux26', iso_mount)
1096     if kernel is None:
1097         logging.critical("Fatal kernel not found")
1098         raise CriticalException("error locating kernel file")
1099     else:
1100         exec_rsync(kernel, release_target + '/linux26')
1101
1102     initrd = search_file(prefix + 'initrd.gz', iso_mount)
1103     if initrd is None:
1104         logging.critical("Fatal: initrd not found")
1105         raise CriticalException("error locating initrd file")
1106     else:
1107         exec_rsync(initrd, release_target + '/initrd.gz')
1108
1109
1110 def update_grml_versions(iso_mount, target):
1111     """Update the grml version file on a cd
1112     Returns true if version was updated successfully,
1113     False if grml-version does not exist yet on the mountpoint
1114
1115     @iso_mount: string of the iso mount point
1116     @target: path of the target mount point
1117     """
1118     grml_target = target + '/grml/'
1119     target_grml_version_file = search_file('grml-version', grml_target)
1120     if target_grml_version_file:
1121         iso_grml_version_file = search_file('grml-version', iso_mount)
1122         if not iso_grml_version_file:
1123             logging.warn("Warning: %s could not be found - can not install it", iso_grml_version_file)
1124             return False
1125         try:
1126             iso_versions = {}
1127             iso_file = open(iso_grml_version_file, 'r')
1128             for line in iso_file:
1129                 iso_versions[get_flavour(line)] = line.strip()
1130
1131             for line in fileinput.input([target_grml_version_file], inplace=1):
1132                 flavour = get_flavour(line)
1133                 if flavour in iso_versions.keys():
1134                     print iso_versions[flavour]
1135                 else:
1136                     print line.strip()
1137         except IOError:
1138             logging.warn("Warning: Could not write file")
1139         finally:
1140             iso_file.close()
1141             fileinput.close()
1142         return True
1143     else:
1144         return False
1145
1146 def copy_grml_files(iso_mount, target):
1147     """copy some minor grml files to a given target
1148
1149     @iso_mount: path where a grml ISO is mounted on
1150     @target: path where grml's main files should be copied to"""
1151
1152     grml_target = target + '/grml/'
1153     execute(mkdir, grml_target)
1154
1155     copy_files = [ 'grml-cheatcodes.txt', 'LICENSE.txt', 'md5sums', 'README.txt' ]
1156     # handle grml-version
1157     if not update_grml_versions(iso_mount, target):
1158         copy_files.append('grml-version')
1159
1160     for myfile in copy_files:
1161         grml_file = search_file(myfile, iso_mount)
1162         if grml_file is None:
1163             logging.warn("Warning: myfile %s could not be found - can not install it", myfile)
1164         else:
1165             exec_rsync(grml_file, grml_target + myfile)
1166
1167     grml_web_target = grml_target + '/web/'
1168     execute(mkdir, grml_web_target)
1169
1170     for myfile in 'index.html', 'style.css':
1171         grml_file = search_file(myfile, iso_mount)
1172         if grml_file is None:
1173             logging.warn("Warning: myfile %s could not be found - can not install it")
1174         else:
1175             exec_rsync(grml_file, grml_web_target + myfile)
1176
1177     grml_webimg_target = grml_web_target + '/images/'
1178     execute(mkdir, grml_webimg_target)
1179
1180     for myfile in 'button.png', 'favicon.png', 'linux.jpg', 'logo.png':
1181         grml_file = search_file(myfile, iso_mount)
1182         if grml_file is None:
1183             logging.warn("Warning: myfile %s could not be found - can not install it")
1184         else:
1185             exec_rsync(grml_file, grml_webimg_target + myfile)
1186
1187
1188 def handle_addon_copy(filename, dst, iso_mount):
1189     """handle copy of optional addons
1190
1191     @filename: filename of the addon
1192     @dst: destination directory
1193     @iso_mount: location of the iso mount
1194     """
1195     file_location = search_file(filename, iso_mount)
1196     if file_location is None:
1197         logging.warn("Warning: %s not found (that's fine if you don't need it)",  filename)
1198     else:
1199         exec_rsync(file_location, dst + filename)
1200
1201
1202 def copy_addons(iso_mount, target):
1203     """copy grml's addons files (like allinoneimg, bsd4grml,..) to a given target
1204
1205     @iso_mount: path where a grml ISO is mounted on
1206     @target: path where grml's main files should be copied to"""
1207
1208     addons = target + '/boot/addons/'
1209     execute(mkdir, addons)
1210
1211     # grub all-in-one image
1212     handle_addon_copy('allinone.img', addons, iso_mount)
1213
1214     # bsd imag
1215     handle_addon_copy('bsd4grml', addons, iso_mount)
1216
1217     handle_addon_copy('balder10.imz', addons, iso_mount)
1218
1219     # install hdt and pci.ids only when using syslinux (grub doesn't support it)
1220     if options.syslinux:
1221         # hdt (hardware detection tool) image
1222         hdtimg = search_file('hdt.c32', iso_mount)
1223         if hdtimg:
1224             exec_rsync(hdtimg, addons + '/hdt.c32')
1225
1226         # pci.ids file
1227         picids = search_file('pci.ids', iso_mount)
1228         if picids:
1229             exec_rsync(picids, addons + '/pci.ids')
1230
1231     # memdisk image
1232     handle_addon_copy('memdisk', addons, iso_mount)
1233
1234     # memtest86+ image
1235     handle_addon_copy('memtest', addons, iso_mount)
1236
1237     # gpxe.lkrn
1238     handle_addon_copy('gpxe.lkrn', addons, iso_mount)
1239
1240
1241 def glob_and_copy(filepattern, dst):
1242     """Glob on specified filepattern and copy the result to dst
1243
1244     @filepattern: globbing pattern
1245     @dst: target directory
1246     """
1247     for name in glob.glob(filepattern):
1248         copy_if_exist(name, dst)
1249
1250 def search_and_copy(filename, search_path, dst):
1251     """Search for the specified filename at searchpath and copy it to dst
1252
1253     @filename: filename to look for
1254     @search_path: base search file
1255     @dst: destionation to copy the file to
1256     """
1257     file_location = search_file(filename, search_path)
1258     copy_if_exist(file_location, dst)
1259
1260 def copy_if_exist(filename, dst):
1261     """Copy filename to dst if filename is set.
1262
1263     @filename: a filename
1264     @dst: dst file
1265     """
1266     if filename and (os.path.isfile(filename) or os.path.isdir(filename)):
1267         exec_rsync(filename, dst)
1268
1269 def copy_bootloader_files(iso_mount, target, grml_flavour):
1270     """Copy grml's bootloader files to a given target
1271
1272     @iso_mount: path where a grml ISO is mounted on
1273     @target: path where grml's main files should be copied to
1274     @grml_flavour: name of the current processed grml_flavour
1275     """
1276
1277     syslinux_target = target + '/boot/syslinux/'
1278     execute(mkdir, syslinux_target)
1279
1280     grub_target = target + '/boot/grub/'
1281     execute(mkdir, grub_target)
1282
1283
1284     logo = search_file('logo.16', iso_mount)
1285     exec_rsync(logo, syslinux_target + 'logo.16')
1286
1287
1288     for ffile in ['f%d' % number for number in range(1, 11) ]:
1289         search_and_copy(ffile, iso_mount, syslinux_target + ffile)
1290
1291     loopback_cfg = search_file("loopback.cfg", iso_mount)
1292     if loopback_cfg:
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)
1297
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')
1302
1303     (source_dir, name) = get_defaults_file(iso_mount, grml_flavour, "default.cfg")
1304     (source_dir, defaults_file) = get_defaults_file(iso_mount, grml_flavour, "grml.cfg")
1305
1306     if not source_dir:
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.")
1311         raise
1312
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)
1318
1319     # copy the addons_*.cfg file to the new syslinux directory
1320     glob_and_copy(iso_mount + source_dir + 'addon*.cfg', syslinux_target)
1321
1322     search_and_copy('hidden.cfg', iso_mount + source_dir, syslinux_target + "new_" + 'hidden.cfg')
1323
1324
1325     grub_target = target + '/boot/grub/'
1326     execute(mkdir, grub_target)
1327
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!")
1331         raise
1332     else:
1333         exec_rsync(GRML2USB_BASE + '/grub/splash.xpm.gz', grub_target + 'splash.xpm.gz')
1334
1335     # grml splash in grub
1336     copy_if_exist(GRML2USB_BASE + "/grub/grml.png", grub_target + 'grml.png')
1337
1338     # font file for graphical bootsplash in grub
1339     copy_if_exist('/usr/share/grub/ascii.pf2', grub_target + 'ascii.pf2')
1340
1341     # always copy grub content as it might be useful
1342
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)
1346
1347 def install_iso_files(grml_flavour, iso_mount, device, target):
1348     """Copy files from ISO to given target
1349
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"""
1354
1355     global GRML_DEFAULT
1356     GRML_DEFAULT = GRML_DEFAULT or grml_flavour
1357     if options.dryrun:
1358         return 0
1359     elif not options.bootloaderonly:
1360         logging.info("Copying files. This might take a while....")
1361         try:
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)
1366             sys.exit(1)
1367
1368     if not options.skipaddons:
1369         if not search_file('addons', iso_mount):
1370             logging.info("Could not find addons, therefore not installing.")
1371         else:
1372             copy_addons(iso_mount, target)
1373
1374     if not options.copyonly:
1375         copy_bootloader_files(iso_mount, target, grml_flavour)
1376
1377         if not options.dryrun:
1378             handle_bootloader_config(grml_flavour, device, target)
1379
1380     # make sure we sync filesystems before returning
1381     proc = subprocess.Popen(["sync"])
1382     proc.wait()
1383
1384
1385 def get_flavour(flavour_str):
1386     """Returns the flavour of a grml version string
1387     """
1388     return re.match(r'[\w-]*', flavour_str).group()
1389
1390 def identify_grml_flavour(mountpath):
1391     """Get name of grml flavour
1392
1393     @mountpath: path where the grml ISO is mounted to
1394     @return: name of grml-flavour"""
1395
1396     version_file = search_file('grml-version', mountpath)
1397
1398     if version_file == "":
1399         logging.critical("Error: could not find grml-version file.")
1400         raise
1401
1402     flavours = []
1403     tmpfile = None
1404     try:
1405         tmpfile = open(version_file, 'r')
1406         for line in tmpfile.readlines():
1407             flavours.append(get_flavour(line))
1408     except TypeError, e:
1409         raise
1410     except Exception, e:
1411         logging.critical("Unexpected error: %s", e)
1412         raise
1413     finally:
1414         if tmpfile:
1415             tmpfile.close()
1416
1417     return flavours
1418
1419
1420 def modify_grub_config(filename):
1421     """Adjust bootoptions for a grub file
1422
1423     @filename: filename to modify
1424     """
1425     if options.removeoption:
1426         regexe = []
1427         for regex in options.removeoption:
1428             regexe.append(re.compile(r'%s' % regex))
1429
1430         option_re = re.compile(r'(.*/boot/release/.*linux26.*)')
1431
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)
1436
1437             sys.stdout.write(line)
1438
1439         fileinput.close()
1440
1441 def handle_grub1_config(grml_flavour, install_partition, grub_target, bootopt):
1442     """Main handler for generating grub1 configuration
1443
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"""
1448
1449     # grub1 config
1450     grub1_cfg = grub_target + 'menu.lst'
1451     logging.debug("Creating grub1 configuration file (menu.lst)")
1452
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()
1461     else:
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()
1465
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))))
1470         for line in string:
1471             if flavour.match(line):
1472                 grub_flavour_config = False
1473
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()
1478
1479     modify_grub_config(grub1_cfg)
1480
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):
1487             import shutil
1488             shutil.copyfile(grub1_cfg, grub_target + 'grub.conf')
1489
1490 def handle_grub2_config(grml_flavour, grub_target, bootopt):
1491     """Main handler for generating grub2 configuration
1492
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"""
1496
1497     # grub2 config
1498     grub2_cfg = grub_target + 'grub.cfg'
1499     logging.debug("Creating grub2 configuration file (grub.lst)")
1500
1501     global GRML_DEFAULT
1502
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()
1514     else:
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()
1520
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))))
1526         for line in string:
1527             if flavour.match(line):
1528                 grub_flavour_config = False
1529
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()
1537
1538     modify_grub_config(grub2_cfg)
1539
1540
1541 def get_bootoptions(grml_flavour):
1542     """Returns bootoptions for specific flavour
1543
1544     @grml_flavour: name of the grml_flavour
1545     """
1546     # do NOT write "None" in kernel cmdline
1547     if options.bootoptions is None:
1548         bootopt = ""
1549     else:
1550         bootopt = options.bootoptions
1551     bootopt = bootopt.replace("%flavour", grml_flavour)
1552     return bootopt
1553
1554
1555 def handle_grub_config(grml_flavour, device, target):
1556     """Main handler for generating grub (v1 and v2) configuration
1557
1558     @grml_flavour: name of grml flavour the configuration should be generated for
1559     @device: device/partition where grub should be installed to
1560     @target: path of grub's configuration files"""
1561
1562     logging.debug("Generating grub configuration")
1563
1564     grub_target = target + '/boot/grub/'
1565
1566     if os.path.isdir(device):
1567         install_grub1_partition = None
1568     else:
1569         if device[-1:].isdigit():
1570             install_grub1_partition = int(device[-1:]) - 1
1571         else:
1572             raise CriticalException("error validating partition schema (raw device?)")
1573
1574
1575     bootopt = get_bootoptions(grml_flavour)
1576
1577     # write menu.lst
1578     handle_grub1_config(grml_flavour, install_grub1_partition, grub_target, bootopt)
1579     # write grub.cfg
1580     handle_grub2_config(grml_flavour, grub_target, bootopt)
1581
1582
1583 def initial_syslinux_config(target):
1584     """Generates intial syslinux configuration
1585
1586     @target path of syslinux's configuration files"""
1587
1588     target = target + "/"
1589     filename = target + "grmlmain.cfg"
1590     if os.path.isfile(target + "grmlmain.cfg"):
1591         return
1592     data = open(filename, "w")
1593     data.write(generate_main_syslinux_config())
1594     data.close()
1595
1596     filename = target + "hiddens.cfg"
1597     data = open(filename, "w")
1598     data.write("include hidden.cfg\n")
1599     data.close()
1600
1601 def add_entry_if_not_present(filename, entry):
1602     """Write entry into filename if entry is not already in the file
1603
1604     @filanme: name of the file
1605     @entry: data to write to the file
1606     """
1607     data = open(filename, "a+")
1608     for line in data:
1609         if line == entry:
1610             break
1611     else:
1612         data.write(entry)
1613
1614     data.close()
1615
1616 def get_flavour_filename(flavour):
1617     """Generate a iso9960 save filename out of the specified flavour
1618
1619     @flavour: grml flavour
1620     """
1621     return flavour.replace('-', '_')
1622
1623 def adjust_syslinux_bootoptions(src, flavour):
1624     """Adjust existing bootoptions of specified syslinux config to
1625     grml2usb specific ones, e.g. change the location of the kernel...
1626
1627     @src: config file to alter
1628     @flavour: grml flavour
1629     """
1630
1631     append_re = re.compile("^(\s*append.*/boot/release.*)$", re.I)
1632     boot_re = re.compile("/boot/([a-zA-Z0-9_]+/)+([a-zA-Z0-9._]+)")
1633     # flavour_re = re.compile("(label.*)(grml\w+)")
1634     default_re = re.compile("(default.cfg)")
1635     bootid_re = re.compile("bootid=[\w_-]+")
1636     live_media_path_re = re.compile("live-media-path=[\w_/-]+")
1637
1638     bootopt = get_bootoptions(flavour)
1639
1640     regexe = []
1641     option_re = None
1642     if options.removeoption:
1643         option_re = re.compile(r'/boot/release/.*/initrd.gz')
1644
1645         for regex in options.removeoption:
1646             regexe.append(re.compile(r'%s' % regex))
1647
1648     for line in fileinput.input(src, inplace=1):
1649         line = boot_re.sub(r'/boot/release/%s/\2 ' % flavour.replace('-', ''), line)
1650         # line = flavour_re.sub(r'\1 %s-\2' % flavour, line)
1651         line = default_re.sub(r'%s-\1' % flavour, line)
1652         line = bootid_re.sub('', line)
1653         line = live_media_path_re.sub('', line)
1654         line = append_re.sub(r'\1 live-media-path=/live/%s/ ' % flavour, line)
1655         line = append_re.sub(r'\1 boot=live %s ' % bootopt, line)
1656         line = append_re.sub(r'\1 %s=%s ' % ("bootid", UUID), line)
1657         if option_re and option_re.search(line):
1658             for regex in regexe:
1659                 line = regex.sub(' ', line)
1660         sys.stdout.write(line)
1661     fileinput.close()
1662
1663 def adjust_labels(src, replacement):
1664     """Adjust the specified labels in the syslinux config file src with
1665     specified replacement
1666     """
1667     label_re = re.compile("^(\s*label\s*) ([a-zA-Z0-9_-]+)", re.I)
1668     for line in fileinput.input(src, inplace=1):
1669         line = label_re.sub(replacement, line)
1670         sys.stdout.write(line)
1671     fileinput.close()
1672
1673
1674 def add_syslinux_entry(filename, grml_flavour):
1675     """Add includes for a specific grml_flavour to the specified filename
1676
1677     @filename: syslinux config file
1678     @grml_flavour: grml flavour to add
1679     """
1680
1681     entry_filename = "option_%s.cfg" % grml_flavour
1682     entry = "include %s\n" % entry_filename
1683
1684     add_entry_if_not_present(filename, entry)
1685     path = os.path.dirname(filename)
1686
1687     data = open(path + "/" + entry_filename, "w")
1688     data.write(generate_flavour_specific_syslinux_config(grml_flavour))
1689     data.close()
1690
1691 def modify_filenames(grml_flavour, target, filenames):
1692     """Replace the standarf filenames with the new ones
1693
1694     @grml_flavour: grml-flavour strin
1695     @target: directory where the files are located
1696     @filenames: list of filenames to alter
1697     """
1698     grml_filename = grml_flavour.replace('-', '_')
1699     for filename in filenames:
1700         old_filename = "%s/%s" % (target, filename)
1701         new_filename = "%s/%s_%s" % (target, grml_filename, filename)
1702         os.rename(old_filename, new_filename)
1703
1704
1705 def remove_default_entry(filename):
1706     """Remove the default entry from specified syslinux file
1707
1708     @filename: syslinux config file
1709     """
1710     default_re = re.compile("^(\s*menu\s*default\s*)$", re.I)
1711     for line in fileinput.input(filename, inplace=1):
1712         if default_re.match(line):
1713             continue
1714         sys.stdout.write(line)
1715     fileinput.close()
1716
1717
1718 def handle_syslinux_config(grml_flavour, target):
1719     """Main handler for generating syslinux configuration
1720
1721     @grml_flavour: name of grml flavour the configuration should be generated for
1722     @target: path of syslinux's configuration files"""
1723
1724     logging.debug("Generating syslinux configuration")
1725     syslinux_target = target + '/boot/syslinux/'
1726     # should be present via  copy_bootloader_files(), but make sure it exits:
1727     execute(mkdir, syslinux_target)
1728     syslinux_cfg = syslinux_target + 'syslinux.cfg'
1729
1730
1731     # install main configuration only *once*, no matter how many ISOs we have:
1732     syslinux_config_file = open(syslinux_cfg, 'w')
1733     syslinux_config_file.write("TIMEOUT 300\n")
1734     syslinux_config_file.write("include vesamenu.cfg\n")
1735     syslinux_config_file.close()
1736
1737     prompt_name = open(syslinux_target + 'promptname.cfg', 'w')
1738     prompt_name.write('menu label S^yslinux prompt\n')
1739     prompt_name.close()
1740
1741     initial_syslinux_config(syslinux_target)
1742     flavour_filename = grml_flavour.replace('-', '_')
1743
1744     if search_file('default.cfg', syslinux_target):
1745         modify_filenames(grml_flavour, syslinux_target, ['grml.cfg', 'default.cfg'])
1746
1747     filename = search_file("new_hidden.cfg", syslinux_target)
1748
1749
1750     # process hidden file
1751     if not search_file("hidden.cfg", syslinux_target):
1752         new_hidden = syslinux_target + "hidden.cfg"
1753         os.rename(filename, new_hidden)
1754         adjust_syslinux_bootoptions(new_hidden, grml_flavour)
1755     else:
1756         new_hidden_file =  "%s/%s_hidden.cfg" % (syslinux_target, flavour_filename)
1757         os.rename(filename, new_hidden_file)
1758         adjust_labels(new_hidden_file, r'\1 %s-\2' % grml_flavour)
1759         adjust_syslinux_bootoptions(new_hidden_file, grml_flavour)
1760         entry = 'include %s_hidden.cfg\n' % flavour_filename
1761         add_entry_if_not_present("%s/hiddens.cfg" % syslinux_target, entry)
1762
1763
1764
1765     new_default = "%s_default.cfg" % (flavour_filename)
1766     entry = 'include %s\n' % new_default
1767     defaults_file = '%s/defaults.cfg' % syslinux_target
1768     new_default_with_path = "%s/%s" % (syslinux_target, new_default)
1769     new_grml_cfg = "%s/%s_grml.cfg" % ( syslinux_target, flavour_filename)
1770
1771     if os.path.isfile(defaults_file):
1772
1773         # remove default menu entry in menu
1774         remove_default_entry(new_default_with_path)
1775
1776         # adjust all labels for additional isos
1777         adjust_labels(new_default_with_path, r'\1 %s' % grml_flavour)
1778         adjust_labels(new_grml_cfg, r'\1 %s-\2' % grml_flavour)
1779
1780     # always adjust bootoptions
1781     adjust_syslinux_bootoptions(new_default_with_path, grml_flavour)
1782     adjust_syslinux_bootoptions(new_grml_cfg, grml_flavour)
1783
1784     add_entry_if_not_present("%s/defaults.cfg" % syslinux_target, entry)
1785
1786     add_syslinux_entry("%s/additional.cfg" % syslinux_target, flavour_filename)
1787
1788
1789 def handle_bootloader_config(grml_flavour, device, target):
1790     """Main handler for generating bootloader's configuration
1791
1792     @grml_flavour: name of grml flavour the configuration should be generated for
1793     @device: device/partition where bootloader should be installed to
1794     @target: path of bootloader's configuration files"""
1795
1796     global UUID
1797     UUID = get_uuid(target)
1798     if options.skipsyslinuxconfig:
1799         logging.info("Skipping generation of syslinux configuration as requested.")
1800     else:
1801         try:
1802             handle_syslinux_config(grml_flavour, target)
1803         except CriticalException, error:
1804             logging.critical("Fatal: %s", error)
1805             sys.exit(1)
1806
1807     if options.skipgrubconfig:
1808         logging.info("Skipping generation of grub configuration as requested.")
1809     else:
1810         try:
1811             handle_grub_config(grml_flavour, device, target)
1812         except CriticalException, error:
1813             logging.critical("Fatal: %s", error)
1814             sys.exit(1)
1815
1816
1817
1818 def install(image, device):
1819     """Install a grml image to the specified device
1820
1821     @image: directory or is file
1822     @device: partition or directory to install the device
1823     """
1824     iso_mountpoint = image
1825     remove_image_mountpoint = False
1826     if os.path.isdir(image):
1827         logging.info("Using %s as install base", image)
1828     else:
1829         logging.info("Using ISO %s", image)
1830         iso_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
1831         register_tmpfile(iso_mountpoint)
1832         remove_image_mountpoint = True
1833         try:
1834             mount(image, iso_mountpoint, ["-o", "loop", "-t", "iso9660"])
1835         except CriticalException, error:
1836             logging.critical("Fatal: %s", error)
1837             sys.exit(1)
1838
1839     try:
1840         install_grml(iso_mountpoint, device)
1841     finally:
1842         if remove_image_mountpoint:
1843             try:
1844                 remove_mountpoint(iso_mountpoint)
1845             except CriticalException, error:
1846                 logging.critical("Fatal: %s", error)
1847                 cleanup()
1848
1849
1850
1851 def install_grml(mountpoint, device):
1852     """Main logic for copying files of the currently running grml system.
1853
1854     @mountpoin: directory where currently running live system resides (usually /live/image)
1855     @device: partition where the specified ISO should be installed to"""
1856
1857     device_mountpoint = device
1858     if os.path.isdir(device):
1859         logging.info("Specified device is not a directory, therefore not mounting.")
1860         remove_device_mountpoint = False
1861     else:
1862         device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
1863         register_tmpfile(device_mountpoint)
1864         remove_device_mountpoint = True
1865         try:
1866             check_for_fat(device)
1867             mount(device, device_mountpoint, ['-o', 'utf8,iocharset=iso8859-1'])
1868         except CriticalException, error:
1869             try:
1870                 mount(device, device_mountpoint, "")
1871             except CriticalException, error:
1872                 logging.critical("Fatal: %s", error)
1873                 raise
1874     try:
1875         grml_flavours = identify_grml_flavour(mountpoint)
1876         for flavour in set(grml_flavours):
1877             logging.info("Identified grml flavour \"%s\".", flavour)
1878             install_iso_files(flavour, mountpoint, device, device_mountpoint)
1879             GRML_FLAVOURS.add(flavour)
1880     finally:
1881         if remove_device_mountpoint:
1882             remove_mountpoint(device_mountpoint)
1883
1884 def remove_mountpoint(mountpoint):
1885     """remove a registred mountpoint
1886     """
1887
1888     try:
1889         unmount(mountpoint, "")
1890         if os.path.isdir(mountpoint):
1891             os.rmdir(mountpoint)
1892             unregister_tmpfile(mountpoint)
1893     except CriticalException, error:
1894         logging.critical("Fatal: %s", error)
1895         cleanup()
1896
1897 def handle_mbr(device):
1898     """Main handler for installing master boot record (MBR)
1899
1900     @device: device where the MBR should be installed to"""
1901
1902     if options.dryrun:
1903         logging.info("Would install MBR")
1904         return 0
1905
1906     if device[-1:].isdigit():
1907         mbr_device = re.match(r'(.*?)\d*$', device).group(1)
1908         partition_number = int(device[-1:]) - 1
1909         skip_install_mir_mbr = False
1910
1911     # if we get e.g. /dev/loop1 as device we don't want to put the MBR
1912     # into /dev/loop of course, therefore use /dev/loop1 as mbr_device
1913     if mbr_device == "/dev/loop":
1914         mbr_device = device
1915         logging.info("Detected loop device - using %s as MBR device therefore", mbr_device)
1916         skip_install_mir_mbr = True
1917
1918     try:
1919         if options.syslinuxmbr:
1920             handle_syslinux_mbr(mbr_device)
1921         elif not skip_install_mir_mbr:
1922             if options.mbrmenu:
1923                 install_mir_mbr(GRML2USB_BASE + '/mbr/mbrmgr', mbr_device, partition_number, True)
1924             else:
1925                 install_mir_mbr(GRML2USB_BASE + '/mbr/mbrldr', mbr_device, partition_number, False)
1926     except IOError, error:
1927         logging.critical("Execution failed: %s", error)
1928         sys.exit(1)
1929     except Exception, error:
1930         logging.critical("Execution failed: %s", error)
1931         sys.exit(1)
1932
1933
1934 def handle_vfat(device):
1935     """Check for FAT specific settings and options
1936
1937     @device: device that should checked / formated"""
1938
1939     # make sure we have mkfs.vfat available
1940     if options.fat16:
1941         if not which("mkfs.vfat") and not options.copyonly and not options.dryrun:
1942             logging.critical('Sorry, mkfs.vfat not available. Exiting.')
1943             logging.critical('Please make sure to install dosfstools.')
1944             sys.exit(1)
1945
1946         if options.force:
1947             print "Forcing mkfs.fat16 on %s as requested via option --force." % device
1948         else:
1949             # make sure the user is aware of what he is doing
1950             f = raw_input("Are you sure you want to format the specified partition with fat16? y/N ")
1951             if f == "y" or f == "Y":
1952                 logging.info("Note: you can skip this question using the option --force")
1953             else:
1954                 sys.exit(1)
1955         try:
1956             mkfs_fat16(device)
1957         except CriticalException, error:
1958             logging.critical("Execution failed: %s", error)
1959             sys.exit(1)
1960
1961     # check for vfat filesystem
1962     if device is not None and not os.path.isdir(device) and options.syslinux:
1963         try:
1964             check_for_fat(device)
1965         except CriticalException, error:
1966             logging.critical("Execution failed: %s", error)
1967             sys.exit(1)
1968
1969     if not os.path.isdir(device) and not check_for_usbdevice(device) and not options.force:
1970         print "Warning: the specified device %s does not look like a removable usb device." % device
1971         f = raw_input("Do you really want to continue? y/N ")
1972         if f == "y" or f == "Y":
1973             pass
1974         else:
1975             sys.exit(1)
1976
1977
1978 def handle_compat_warning(device):
1979     """Backwards compatible checks
1980
1981     @device: device that should be checked"""
1982
1983     # make sure we can replace old grml2usb script and warn user when using old way of life:
1984     if device.startswith("/mnt/external") or device.startswith("/mnt/usb") and not options.force:
1985         print "Warning: the semantics of grml2usb has changed."
1986         print "Instead of using grml2usb /path/to/iso %s you might" % device
1987         print "want to use grml2usb /path/to/iso /dev/... instead."
1988         print "Please check out the grml2usb manpage for details."
1989         f = raw_input("Do you really want to continue? y/N ")
1990         if f == "y" or f == "Y":
1991             pass
1992         else:
1993             sys.exit(1)
1994
1995
1996 def handle_logging():
1997     """Log handling and configuration"""
1998
1999     if options.verbose and options.quiet:
2000         parser.error("please use either verbose (--verbose) or quiet (--quiet) option")
2001
2002     if options.verbose:
2003         FORMAT = "Debug: %(asctime)-15s %(message)s"
2004         logging.basicConfig(level=logging.DEBUG, format=FORMAT)
2005     elif options.quiet:
2006         FORMAT = "Critical: %(message)s"
2007         logging.basicConfig(level=logging.CRITICAL, format=FORMAT)
2008     else:
2009         FORMAT = "%(message)s"
2010         logging.basicConfig(level=logging.INFO, format=FORMAT)
2011
2012
2013 def handle_bootloader(device):
2014     """wrapper for installing bootloader
2015
2016     @device: device where bootloader should be installed to"""
2017
2018     # Install bootloader only if not using the --copy-only option
2019     if options.copyonly:
2020         logging.info("Not installing bootloader and its files as requested via option copyonly.")
2021     elif os.path.isdir(device):
2022         logging.info("Not installing bootloader as %s is a directory.", device)
2023     else:
2024         install_bootloader(device)
2025
2026
2027 def check_options(opts):
2028     """Check compability of provided user opts
2029
2030     @opts option dict from OptionParser
2031     """
2032     if opts.grubmbr and not opts.grub:
2033         logging.critical("Error: --grub-mbr requires --grub option.")
2034         sys.exit(1)
2035
2036
2037 def check_programs():
2038     """check if all needed programs are installed"""
2039     if options.grub:
2040         if not which("grub-install"):
2041             logging.critical("Fatal: grub-install not available (please install the "
2042                              + "grub package or drop the --grub option)")
2043             sys.exit(1)
2044
2045     if options.syslinux:
2046         if not which("syslinux"):
2047             logging.critical("Fatal: syslinux not available (please install the "
2048                              + "syslinux package or use the --grub option)")
2049             sys.exit(1)
2050
2051     if not which("rsync"):
2052         logging.critical("Fatal: rsync not available, can not continue - sorry.")
2053         sys.exit(1)
2054
2055 def main():
2056     """Main function [make pylint happy :)]"""
2057
2058     if options.version:
2059         print os.path.basename(sys.argv[0]) + " " + PROG_VERSION
2060         sys.exit(0)
2061
2062     if len(args) < 2:
2063         parser.error("invalid usage")
2064
2065     # log handling
2066     handle_logging()
2067
2068     # make sure we have the appropriate permissions
2069     check_uid_root()
2070
2071     check_options(options)
2072
2073     logging.info("Executing grml2usb version %s", PROG_VERSION)
2074
2075     if options.dryrun:
2076         logging.info("Running in simulation mode as requested via option dry-run.")
2077
2078     check_programs()
2079
2080     # specified arguments
2081     device = args[len(args) - 1]
2082     isos = args[0:len(args) - 1]
2083
2084     if not os.path.isdir(device):
2085         if device[-1:].isdigit():
2086             if int(device[-1:]) > 4 or device[-2:].isdigit():
2087                 logging.critical("Fatal: installation on partition number >4 not supported. (BIOS won't support it.)")
2088                 sys.exit(1)
2089         elif os.path.exists(device):
2090             logging.critical("Fatal: installation on raw device not supported. (BIOS won't support it.)")
2091             sys.exit(1)
2092
2093
2094     # provide upgrade path
2095     handle_compat_warning(device)
2096
2097     # check for vfat partition
2098     handle_vfat(device)
2099
2100     # main operation (like installing files)
2101     for iso in isos:
2102         install(iso, device)
2103
2104     # install mbr
2105     if not options.skipmbr and not os.path.isdir(device):
2106         handle_mbr(device)
2107
2108     handle_bootloader(device)
2109
2110     logging.info("Note: grml flavour %s was installed as the default booting system.", GRML_DEFAULT)
2111
2112     for flavour in GRML_FLAVOURS:
2113         logging.info("Note: you can boot flavour %s using '%s' on the commandline.", flavour, flavour)
2114
2115     # finally be politely :)
2116     logging.info("Finished execution of grml2usb (%s). Have fun with your grml system.", PROG_VERSION)
2117
2118
2119 if __name__ == "__main__":
2120     try:
2121         main()
2122     except KeyboardInterrupt:
2123         logging.info("Received KeyboardInterrupt")
2124         cleanup()
2125
2126 ## END OF FILE #################################################################
2127 # vim:foldmethod=indent expandtab ai ft=python tw=120 fileencoding=utf-8