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.26"
  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     try:
 978         udev_info = subprocess.Popen(["/sbin/blkid", "-s", "TYPE", "-o", "value", partition],
 979                                      stdout=subprocess.PIPE, stderr=subprocess.PIPE)
 980         filesystem = udev_info.communicate()[0].rstrip()
 981
 982         if udev_info.returncode == 2:
 983             raise CriticalException("Failed to read device %s"
 984                                     " (wrong UID/permissions or device/directory not present?)" % partition)
 985
 986         if filesystem != "vfat":
 987             raise CriticalException(
 988                     "Partition %s does not contain a FAT16 filesystem." % (partition) \
 989                     + "(Use --fat16 or run mkfs.vfat %s)" % (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     new_grml_version = search_file('grml-version', grml_target)
1120     if new_grml_version:
1121         orig_grml_version = search_file('grml-version', iso_mount)
1122         if not orig_grml_version:
1123             logging.warn("Warning: %s could not be found - can not install it", orig_grml_version)
1124             return False
1125         try:
1126             new_file = open(new_grml_version, 'a+')
1127             new_flavours = [ get_flavour(l) for l in new_file.readlines() ]
1128
1129             old_file = open(orig_grml_version, 'r')
1130             old_lines = old_file.readlines()
1131             for line in old_lines:
1132                 if not get_flavour(line) in new_flavours:
1133                     new_file.write(line)
1134         except IOError:
1135             logging.warn("Warning: Could not write file")
1136         finally:
1137             new_file.close()
1138             old_file.close()
1139         return True
1140     else:
1141         return False
1142
1143 def copy_grml_files(iso_mount, target):
1144     """copy some minor grml files to a given target
1145
1146     @iso_mount: path where a grml ISO is mounted on
1147     @target: path where grml's main files should be copied to"""
1148
1149     grml_target = target + '/grml/'
1150     execute(mkdir, grml_target)
1151
1152     copy_files = [ 'grml-cheatcodes.txt', 'LICENSE.txt', 'md5sums', 'README.txt' ]
1153     # handle grml-version
1154     if not update_grml_versions(iso_mount, target):
1155         copy_files.append('grml-version')
1156
1157     for myfile in copy_files:
1158         grml_file = search_file(myfile, iso_mount)
1159         if grml_file is None:
1160             logging.warn("Warning: myfile %s could not be found - can not install it", myfile)
1161         else:
1162             exec_rsync(grml_file, grml_target + myfile)
1163
1164     grml_web_target = grml_target + '/web/'
1165     execute(mkdir, grml_web_target)
1166
1167     for myfile in 'index.html', 'style.css':
1168         grml_file = search_file(myfile, iso_mount)
1169         if grml_file is None:
1170             logging.warn("Warning: myfile %s could not be found - can not install it")
1171         else:
1172             exec_rsync(grml_file, grml_web_target + myfile)
1173
1174     grml_webimg_target = grml_web_target + '/images/'
1175     execute(mkdir, grml_webimg_target)
1176
1177     for myfile in 'button.png', 'favicon.png', 'linux.jpg', 'logo.png':
1178         grml_file = search_file(myfile, iso_mount)
1179         if grml_file is None:
1180             logging.warn("Warning: myfile %s could not be found - can not install it")
1181         else:
1182             exec_rsync(grml_file, grml_webimg_target + myfile)
1183
1184
1185 def handle_addon_copy(filename, dst, iso_mount):
1186     """handle copy of optional addons
1187
1188     @filename: filename of the addon
1189     @dst: destination directory
1190     @iso_mount: location of the iso mount
1191     """
1192     file_location = search_file(filename, iso_mount)
1193     if file_location is None:
1194         logging.warn("Warning: %s not found (that's fine if you don't need it)",  filename)
1195     else:
1196         exec_rsync(file_location, dst + filename)
1197
1198
1199 def copy_addons(iso_mount, target):
1200     """copy grml's addons files (like allinoneimg, bsd4grml,..) to a given target
1201
1202     @iso_mount: path where a grml ISO is mounted on
1203     @target: path where grml's main files should be copied to"""
1204
1205     addons = target + '/boot/addons/'
1206     execute(mkdir, addons)
1207
1208     # grub all-in-one image
1209     handle_addon_copy('allinone.img', addons, iso_mount)
1210
1211     # bsd imag
1212     handle_addon_copy('bsd4grml', addons, iso_mount)
1213
1214     handle_addon_copy('balder10.imz', addons, iso_mount)
1215
1216     # install hdt and pci.ids only when using syslinux (grub doesn't support it)
1217     if options.syslinux:
1218         # hdt (hardware detection tool) image
1219         hdtimg = search_file('hdt.c32', iso_mount)
1220         if hdtimg:
1221             exec_rsync(hdtimg, addons + '/hdt.c32')
1222
1223         # pci.ids file
1224         picids = search_file('pci.ids', iso_mount)
1225         if picids:
1226             exec_rsync(picids, addons + '/pci.ids')
1227
1228     # memdisk image
1229     handle_addon_copy('memdisk', addons, iso_mount)
1230
1231     # memtest86+ image
1232     handle_addon_copy('memtest', addons, iso_mount)
1233
1234     # gpxe.lkrn
1235     handle_addon_copy('gpxe.lkrn', addons, iso_mount)
1236
1237
1238 def glob_and_copy(filepattern, dst):
1239     """Glob on specified filepattern and copy the result to dst
1240
1241     @filepattern: globbing pattern
1242     @dst: target directory
1243     """
1244     for name in glob.glob(filepattern):
1245         copy_if_exist(name, dst)
1246
1247 def search_and_copy(filename, search_path, dst):
1248     """Search for the specified filename at searchpath and copy it to dst
1249
1250     @filename: filename to look for
1251     @search_path: base search file
1252     @dst: destionation to copy the file to
1253     """
1254     file_location = search_file(filename, search_path)
1255     copy_if_exist(file_location, dst)
1256
1257 def copy_if_exist(filename, dst):
1258     """Copy filename to dst if filename is set.
1259
1260     @filename: a filename
1261     @dst: dst file
1262     """
1263     if filename and (os.path.isfile(filename) or os.path.isdir(filename)):
1264         exec_rsync(filename, dst)
1265
1266 def copy_bootloader_files(iso_mount, target):
1267     """Copy grml's bootloader files to a given target
1268
1269     @iso_mount: path where a grml ISO is mounted on
1270     @target: path where grml's main files should be copied to"""
1271
1272     syslinux_target = target + '/boot/syslinux/'
1273     execute(mkdir, syslinux_target)
1274
1275     grub_target = target + '/boot/grub/'
1276     execute(mkdir, grub_target)
1277
1278
1279     logo = search_file('logo.16', iso_mount)
1280     exec_rsync(logo, syslinux_target + 'logo.16')
1281
1282
1283     for ffile in ['f%d' % number for number in range(1, 11) ]:
1284         search_and_copy(ffile, iso_mount, syslinux_target + ffile)
1285
1286     loopback_cfg = search_file("loopback.cfg", iso_mount)
1287     if loopback_cfg:
1288         directory = os.path.dirname(loopback_cfg)
1289         directory = directory.replace(iso_mount, "")
1290         mkdir(os.path.join(target, directory))
1291         exec_rsync(loopback_cfg, target + os.path.sep + directory)
1292
1293     # avoid the "file is read only, overwrite anyway (y/n) ?" question
1294     # of mtools by syslinux ("mmove -D o -D O s:/ldlinux.sys $target_file")
1295     if os.path.isfile(syslinux_target + 'ldlinux.sys'):
1296         os.unlink(syslinux_target + 'ldlinux.sys')
1297
1298     (source_dir, name) = get_defaults_file(iso_mount, GRML_DEFAULT, "default.cfg")
1299     (source_dir, defaults_file) = get_defaults_file(iso_mount, GRML_DEFAULT, "grml.cfg")
1300
1301     if not source_dir:
1302         logging.critical("Fatal: file default.cfg could not be found.")
1303         logging.critical("Note:  this grml2usb version requires an ISO generated by grml-live >=0.9.24 ...")
1304         logging.critical("       ... either use grml releases >=2009.10 or switch to an older grml2usb version.")
1305         logging.critical("       Please visit http://grml.org/grml2usb/#grml2usb-compat for further information.")
1306         raise
1307
1308     for expr in name, 'distri.cfg', \
1309         defaults_file, 'grml.png', 'hd.cfg', 'isolinux.cfg', 'isolinux.bin', \
1310         'isoprompt.cfg', 'options.cfg', \
1311         'prompt.cfg', 'vesamenu.c32', 'vesamenu.cfg', 'grml.png', '*.c32':
1312         glob_and_copy(iso_mount + source_dir + expr, syslinux_target)
1313
1314     # copy the addons_*.cfg file to the new syslinux directory
1315     glob_and_copy(iso_mount + source_dir + 'addon*.cfg', syslinux_target)
1316
1317     search_and_copy('hidden.cfg', iso_mount + source_dir, syslinux_target + "new_" + 'hidden.cfg')
1318
1319
1320     grub_target = target + '/boot/grub/'
1321     execute(mkdir, grub_target)
1322
1323     if not os.path.isfile(GRML2USB_BASE + "/grub/splash.xpm.gz"):
1324         logging.critical("Error: %s/grub/splash.xpm.gz can not be read.", GRML2USB_BASE)
1325         logging.critical("Please make sure you've installed the grml2usb (Debian) package!")
1326         raise
1327     else:
1328         exec_rsync(GRML2USB_BASE + '/grub/splash.xpm.gz', grub_target + 'splash.xpm.gz')
1329
1330     # grml splash in grub
1331     copy_if_exist(GRML2USB_BASE + "/grub/grml.png", grub_target + 'grml.png')
1332
1333     # font file for graphical bootsplash in grub
1334     copy_if_exist('/usr/share/grub/ascii.pf2', grub_target + 'ascii.pf2')
1335
1336     # always copy grub content as it might be useful
1337
1338     glob_and_copy(iso_mount + '/boot/grub/*.mod', grub_target)
1339     glob_and_copy(iso_mount + '/boot/grub/*.img', grub_target)
1340     glob_and_copy(iso_mount + '/boot/grub/stage*', grub_target)
1341
1342 def install_iso_files(grml_flavour, iso_mount, device, target):
1343     """Copy files from ISO to given target
1344
1345     @grml_flavour: name of grml flavour the configuration should be generated for
1346     @iso_mount: path where a grml ISO is mounted on
1347     @device: device/partition where bootloader should be installed to
1348     @target: path where grml's main files should be copied to"""
1349
1350     global GRML_DEFAULT
1351     GRML_DEFAULT = grml_flavour
1352     if options.dryrun:
1353         return 0
1354     elif not options.bootloaderonly:
1355         logging.info("Copying files. This might take a while....")
1356         try:
1357             copy_system_files(grml_flavour, iso_mount, target)
1358             copy_grml_files(iso_mount, target)
1359         except CriticalException, error:
1360             logging.critical("Execution failed: %s", error)
1361             sys.exit(1)
1362
1363     if not options.skipaddons:
1364         if not search_file('addons', iso_mount):
1365             logging.info("Could not find addons, therefore not installing.")
1366         else:
1367             copy_addons(iso_mount, target)
1368
1369     if not options.copyonly:
1370         copy_bootloader_files(iso_mount, target)
1371
1372         if not options.dryrun:
1373             handle_bootloader_config(grml_flavour, device, target)
1374
1375     # make sure we sync filesystems before returning
1376     proc = subprocess.Popen(["sync"])
1377     proc.wait()
1378
1379
1380 def get_flavour(flavour_str):
1381     """Returns the flavour of a grml version string
1382     """
1383     return re.match(r'[\w-]*', flavour_str).group()
1384
1385 def identify_grml_flavour(mountpath):
1386     """Get name of grml flavour
1387
1388     @mountpath: path where the grml ISO is mounted to
1389     @return: name of grml-flavour"""
1390
1391     version_file = search_file('grml-version', mountpath)
1392
1393     if version_file == "":
1394         logging.critical("Error: could not find grml-version file.")
1395         raise
1396
1397     flavours = []
1398     tmpfile = None
1399     try:
1400         tmpfile = open(version_file, 'r')
1401         for line in tmpfile.readlines():
1402             flavours.append(get_flavour(line))
1403     except TypeError, e:
1404         raise
1405     except Exception, e:
1406         logging.critical("Unexpected error: %s", e)
1407         raise
1408     finally:
1409         if tmpfile:
1410             tmpfile.close()
1411
1412     return flavours
1413
1414
1415 def modify_grub_config(filename):
1416     """Adjust bootoptions for a grub file
1417
1418     @filename: filename to modify
1419     """
1420     if options.removeoption:
1421         regexe = []
1422         for regex in options.removeoption:
1423             regexe.append(re.compile(r'%s' % regex))
1424
1425         option_re = re.compile(r'(.*/boot/release/.*linux26.*)')
1426
1427         for line in fileinput.input(filename, inplace=1):
1428             if regexe and option_re.search(line):
1429                 for regex in regexe:
1430                     line = regex.sub(' ', line)
1431
1432             sys.stdout.write(line)
1433
1434         fileinput.close()
1435
1436 def handle_grub1_config(grml_flavour, install_partition, grub_target, bootopt):
1437     """Main handler for generating grub1 configuration
1438
1439     @grml_flavour: name of grml flavour the configuration should be generated for
1440     @install_partition: partition number for use in (hd0,X)
1441     @grub_target: path of grub's configuration files
1442     @bootoptions: additional bootoptions that should be used by default"""
1443
1444     # grub1 config
1445     grub1_cfg = grub_target + 'menu.lst'
1446     logging.debug("Creating grub1 configuration file (menu.lst)")
1447
1448     # install main configuration only *once*, no matter how many ISOs we have:
1449     if os.path.isfile(grub1_cfg):
1450         string = open(grub1_cfg).readline()
1451         main_identifier = re.compile(".*main config generated at: %s.*" % re.escape(str(DATESTAMP)))
1452         if not re.match(main_identifier, string):
1453             grub1_config_file = open(grub1_cfg, 'w')
1454             grub1_config_file.write(generate_main_grub1_config(grml_flavour, install_partition, bootopt))
1455             grub1_config_file.close()
1456     else:
1457         grub1_config_file = open(grub1_cfg, 'w')
1458         grub1_config_file.write(generate_main_grub1_config(grml_flavour, install_partition, bootopt))
1459         grub1_config_file.close()
1460
1461     grub_flavour_config = True
1462     if os.path.isfile(grub1_cfg):
1463         string = open(grub1_cfg).readlines()
1464         flavour = re.compile("grml2usb for %s: %s" % (re.escape(grml_flavour), re.escape(str(DATESTAMP))))
1465         for line in string:
1466             if flavour.match(line):
1467                 grub_flavour_config = False
1468
1469     if grub_flavour_config:
1470         grub1_config_file = open(grub1_cfg, 'a')
1471         grub1_config_file.write(generate_flavour_specific_grub1_config(grml_flavour, install_partition, bootopt))
1472         grub1_config_file.close()
1473
1474     modify_grub_config(grub1_cfg)
1475
1476     # make sure grub.conf isn't a symlink but a plain file instead,
1477     # otherwise it will break on FAT16 filesystems
1478     # this works around grub-install of (at least) Fedora 10
1479     if os.path.isfile(grub1_cfg):
1480         grubconf = grub_target + 'grub.conf'
1481         if not os.path.islink(grubconf):
1482             import shutil
1483             shutil.copyfile(grub1_cfg, grub_target + 'grub.conf')
1484
1485 def handle_grub2_config(grml_flavour, grub_target, bootopt):
1486     """Main handler for generating grub2 configuration
1487
1488     @grml_flavour: name of grml flavour the configuration should be generated for
1489     @grub_target: path of grub's configuration files
1490     @bootoptions: additional bootoptions that should be used by default"""
1491
1492     # grub2 config
1493     grub2_cfg = grub_target + 'grub.cfg'
1494     logging.debug("Creating grub2 configuration file (grub.lst)")
1495
1496     global GRML_DEFAULT
1497
1498     # install main configuration only *once*, no matter how many ISOs we have:
1499     grub_flavour_is_default = False
1500     if os.path.isfile(grub2_cfg):
1501         string = open(grub2_cfg).readline()
1502         main_identifier = re.compile(".*main config generated at: %s.*" % re.escape(str(DATESTAMP)))
1503         if not re.match(main_identifier, string):
1504             grub2_config_file = open(grub2_cfg, 'w')
1505             GRML_DEFAULT = grml_flavour
1506             grub_flavour_is_default = True
1507             grub2_config_file.write(generate_main_grub2_config(grml_flavour, bootopt))
1508             grub2_config_file.close()
1509     else:
1510         grub2_config_file = open(grub2_cfg, 'w')
1511         GRML_DEFAULT = grml_flavour
1512         grub_flavour_is_default = True
1513         grub2_config_file.write(generate_main_grub2_config(grml_flavour, bootopt))
1514         grub2_config_file.close()
1515
1516     # install flavour specific configuration only *once* as well
1517     grub_flavour_config = True
1518     if os.path.isfile(grub2_cfg):
1519         string = open(grub2_cfg).readlines()
1520         flavour = re.compile("grml2usb for %s: %s" % (re.escape(grml_flavour), re.escape(str(DATESTAMP))))
1521         for line in string:
1522             if flavour.match(line):
1523                 grub_flavour_config = False
1524
1525     if grub_flavour_config:
1526         grub2_config_file = open(grub2_cfg, 'a')
1527         # display only if the grml flavour isn't the default
1528         if not grub_flavour_is_default:
1529             GRML_FLAVOURS.add(grml_flavour)
1530         grub2_config_file.write(generate_flavour_specific_grub2_config(grml_flavour, bootopt))
1531         grub2_config_file.close()
1532
1533     modify_grub_config(grub2_cfg)
1534
1535
1536 def get_bootoptions(grml_flavour):
1537     """Returns bootoptions for specific flavour
1538
1539     @grml_flavour: name of the grml_flavour
1540     """
1541     # do NOT write "None" in kernel cmdline
1542     if options.bootoptions is None:
1543         bootopt = ""
1544     else:
1545         bootopt = options.bootoptions
1546     bootopt = bootopt.replace("%flavour", grml_flavour)
1547     return bootopt
1548
1549
1550 def handle_grub_config(grml_flavour, device, target):
1551     """Main handler for generating grub (v1 and v2) configuration
1552
1553     @grml_flavour: name of grml flavour the configuration should be generated for
1554     @device: device/partition where grub should be installed to
1555     @target: path of grub's configuration files"""
1556
1557     logging.debug("Generating grub configuration")
1558
1559     grub_target = target + '/boot/grub/'
1560
1561     if os.path.isdir(device):
1562         install_grub1_partition = None
1563     else:
1564         if device[-1:].isdigit():
1565             install_grub1_partition = int(device[-1:]) - 1
1566         else:
1567             raise CriticalException("error validating partition schema (raw device?)")
1568
1569
1570     bootopt = get_bootoptions(grml_flavour)
1571
1572     # write menu.lst
1573     handle_grub1_config(grml_flavour, install_grub1_partition, grub_target, bootopt)
1574     # write grub.cfg
1575     handle_grub2_config(grml_flavour, grub_target, bootopt)
1576
1577
1578 def initial_syslinux_config(target):
1579     """Generates intial syslinux configuration
1580
1581     @target path of syslinux's configuration files"""
1582
1583     target = target + "/"
1584     filename = target + "grmlmain.cfg"
1585     if os.path.isfile(target + "grmlmain.cfg"):
1586         return
1587     data = open(filename, "w")
1588     data.write(generate_main_syslinux_config())
1589     data.close()
1590
1591     filename = target + "hiddens.cfg"
1592     data = open(filename, "w")
1593     data.write("include hidden.cfg\n")
1594     data.close()
1595
1596 def add_entry_if_not_present(filename, entry):
1597     """Write entry into filename if entry is not already in the file
1598
1599     @filanme: name of the file
1600     @entry: data to write to the file
1601     """
1602     data = open(filename, "a+")
1603     for line in data:
1604         if line == entry:
1605             break
1606     else:
1607         data.write(entry)
1608
1609     data.close()
1610
1611 def get_flavour_filename(flavour):
1612     """Generate a iso9960 save filename out of the specified flavour
1613
1614     @flavour: grml flavour
1615     """
1616     return flavour.replace('-', '_')
1617
1618 def adjust_syslinux_bootoptions(src, flavour):
1619     """Adjust existing bootoptions of specified syslinux config to
1620     grml2usb specific ones, e.g. change the location of the kernel...
1621
1622     @src: config file to alter
1623     @flavour: grml flavour
1624     """
1625
1626     append_re = re.compile("^(\s*append.*/boot/release.*)$", re.I)
1627     boot_re = re.compile("/boot/([a-zA-Z0-9_]+/)+([a-zA-Z0-9._]+)")
1628     # flavour_re = re.compile("(label.*)(grml\w+)")
1629     default_re = re.compile("(default.cfg)")
1630     bootid_re = re.compile("bootid=[\w_-]+")
1631     live_media_path_re = re.compile("live-media-path=[\w_/-]+")
1632
1633     bootopt = get_bootoptions(flavour)
1634
1635     regexe = []
1636     option_re = None
1637     if options.removeoption:
1638         option_re = re.compile(r'/boot/release/.*/initrd.gz')
1639
1640         for regex in options.removeoption:
1641             regexe.append(re.compile(r'%s' % regex))
1642
1643     for line in fileinput.input(src, inplace=1):
1644         line = boot_re.sub(r'/boot/release/%s/\2 ' % flavour.replace('-', ''), line)
1645         # line = flavour_re.sub(r'\1 %s-\2' % flavour, line)
1646         line = default_re.sub(r'%s-\1' % flavour, line)
1647         line = bootid_re.sub('', line)
1648         line = live_media_path_re.sub('', line)
1649         line = append_re.sub(r'\1 live-media-path=/live/%s/ ' % flavour, line)
1650         line = append_re.sub(r'\1 boot=live %s ' % bootopt, line)
1651         line = append_re.sub(r'\1 %s=%s ' % ("bootid", UUID), line)
1652         if option_re and option_re.search(line):
1653             for regex in regexe:
1654                 line = regex.sub(' ', line)
1655         sys.stdout.write(line)
1656     fileinput.close()
1657
1658 def adjust_labels(src, replacement):
1659     """Adjust the specified labels in the syslinux config file src with
1660     specified replacement
1661     """
1662     label_re = re.compile("^(\s*label\s*) ([a-zA-Z0-9_-]+)", re.I)
1663     for line in fileinput.input(src, inplace=1):
1664         line = label_re.sub(replacement, line)
1665         sys.stdout.write(line)
1666     fileinput.close()
1667
1668
1669 def add_syslinux_entry(filename, grml_flavour):
1670     """Add includes for a specific grml_flavour to the specified filename
1671
1672     @filename: syslinux config file
1673     @grml_flavour: grml flavour to add
1674     """
1675
1676     entry_filename = "option_%s.cfg" % grml_flavour
1677     entry = "include %s\n" % entry_filename
1678
1679     add_entry_if_not_present(filename, entry)
1680     path = os.path.dirname(filename)
1681
1682     data = open(path + "/" + entry_filename, "w")
1683     data.write(generate_flavour_specific_syslinux_config(grml_flavour))
1684     data.close()
1685
1686 def modify_filenames(grml_flavour, target, filenames):
1687     """Replace the standarf filenames with the new ones
1688
1689     @grml_flavour: grml-flavour strin
1690     @target: directory where the files are located
1691     @filenames: list of filenames to alter
1692     """
1693     grml_filename = grml_flavour.replace('-', '_')
1694     for filename in filenames:
1695         old_filename = "%s/%s" % (target, filename)
1696         new_filename = "%s/%s_%s" % (target, grml_filename, filename)
1697         os.rename(old_filename, new_filename)
1698
1699
1700 def remove_default_entry(filename):
1701     """Remove the default entry from specified syslinux file
1702
1703     @filename: syslinux config file
1704     """
1705     default_re = re.compile("^(\s*menu\s*default\s*)$", re.I)
1706     for line in fileinput.input(filename, inplace=1):
1707         if default_re.match(line):
1708             continue
1709         sys.stdout.write(line)
1710     fileinput.close()
1711
1712
1713 def handle_syslinux_config(grml_flavour, target):
1714     """Main handler for generating syslinux configuration
1715
1716     @grml_flavour: name of grml flavour the configuration should be generated for
1717     @target: path of syslinux's configuration files"""
1718
1719     logging.debug("Generating syslinux configuration")
1720     syslinux_target = target + '/boot/syslinux/'
1721     # should be present via  copy_bootloader_files(), but make sure it exits:
1722     execute(mkdir, syslinux_target)
1723     syslinux_cfg = syslinux_target + 'syslinux.cfg'
1724
1725
1726     # install main configuration only *once*, no matter how many ISOs we have:
1727     syslinux_config_file = open(syslinux_cfg, 'w')
1728     syslinux_config_file.write("TIMEOUT 300\n")
1729     syslinux_config_file.write("include vesamenu.cfg\n")
1730     syslinux_config_file.close()
1731
1732     prompt_name = open(syslinux_target + 'promptname.cfg', 'w')
1733     prompt_name.write('menu label S^yslinux prompt\n')
1734     prompt_name.close()
1735
1736     initial_syslinux_config(syslinux_target)
1737     flavour_filename = grml_flavour.replace('-', '_')
1738
1739     if search_file('default.cfg', syslinux_target):
1740         modify_filenames(grml_flavour, syslinux_target, ['grml.cfg', 'default.cfg'])
1741
1742     filename = search_file("new_hidden.cfg", syslinux_target)
1743
1744
1745     # process hidden file
1746     if not search_file("hidden.cfg", syslinux_target):
1747         new_hidden = syslinux_target + "hidden.cfg"
1748         os.rename(filename, new_hidden)
1749         adjust_syslinux_bootoptions(new_hidden, grml_flavour)
1750     else:
1751         new_hidden_file =  "%s/%s_hidden.cfg" % (syslinux_target, flavour_filename)
1752         os.rename(filename, new_hidden_file)
1753         adjust_labels(new_hidden_file, r'\1 %s-\2' % grml_flavour)
1754         adjust_syslinux_bootoptions(new_hidden_file, grml_flavour)
1755         entry = 'include %s_hidden.cfg\n' % flavour_filename
1756         add_entry_if_not_present("%s/hiddens.cfg" % syslinux_target, entry)
1757
1758
1759
1760     new_default = "%s_default.cfg" % (flavour_filename)
1761     entry = 'include %s\n' % new_default
1762     defaults_file = '%s/defaults.cfg' % syslinux_target
1763     new_default_with_path = "%s/%s" % (syslinux_target, new_default)
1764     new_grml_cfg = "%s/%s_grml.cfg" % ( syslinux_target, flavour_filename)
1765
1766     if os.path.isfile(defaults_file):
1767
1768         # remove default menu entry in menu
1769         remove_default_entry(new_default_with_path)
1770
1771         # adjust all labels for additional isos
1772         adjust_labels(new_default_with_path, r'\1 %s' % grml_flavour)
1773         adjust_labels(new_grml_cfg, r'\1 %s-\2' % grml_flavour)
1774
1775     # always adjust bootoptions
1776     adjust_syslinux_bootoptions(new_default_with_path, grml_flavour)
1777     adjust_syslinux_bootoptions(new_grml_cfg, grml_flavour)
1778
1779     add_entry_if_not_present("%s/defaults.cfg" % syslinux_target, entry)
1780
1781     add_syslinux_entry("%s/additional.cfg" % syslinux_target, flavour_filename)
1782
1783
1784 def handle_bootloader_config(grml_flavour, device, target):
1785     """Main handler for generating bootloader's configuration
1786
1787     @grml_flavour: name of grml flavour the configuration should be generated for
1788     @device: device/partition where bootloader should be installed to
1789     @target: path of bootloader's configuration files"""
1790
1791     global UUID
1792     UUID = get_uuid(target)
1793     if options.skipsyslinuxconfig:
1794         logging.info("Skipping generation of syslinux configuration as requested.")
1795     else:
1796         try:
1797             handle_syslinux_config(grml_flavour, target)
1798         except CriticalException, error:
1799             logging.critical("Fatal: %s", error)
1800             sys.exit(1)
1801
1802     if options.skipgrubconfig:
1803         logging.info("Skipping generation of grub configuration as requested.")
1804     else:
1805         try:
1806             handle_grub_config(grml_flavour, device, target)
1807         except CriticalException, error:
1808             logging.critical("Fatal: %s", error)
1809             sys.exit(1)
1810
1811
1812
1813 def install(image, device):
1814     """Install a grml image to the specified device
1815
1816     @image: directory or is file
1817     @device: partition or directory to install the device
1818     """
1819     iso_mountpoint = image
1820     remove_image_mountpoint = False
1821     if os.path.isdir(image):
1822         logging.info("Using %s as install base", image)
1823     else:
1824         logging.info("Using ISO %s", image)
1825         iso_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
1826         register_tmpfile(iso_mountpoint)
1827         remove_image_mountpoint = True
1828         try:
1829             mount(image, iso_mountpoint, ["-o", "loop", "-t", "iso9660"])
1830         except CriticalException, error:
1831             logging.critical("Fatal: %s", error)
1832             sys.exit(1)
1833
1834     try:
1835         install_grml(iso_mountpoint, device)
1836     finally:
1837         if remove_image_mountpoint:
1838             try:
1839                 remove_mountpoint(iso_mountpoint)
1840             except CriticalException, error:
1841                 logging.critical("Fatal: %s", error)
1842                 cleanup()
1843
1844
1845
1846 def install_grml(mountpoint, device):
1847     """Main logic for copying files of the currently running grml system.
1848
1849     @mountpoin: directory where currently running live system resides (usually /live/image)
1850     @device: partition where the specified ISO should be installed to"""
1851
1852     device_mountpoint = device
1853     if os.path.isdir(device):
1854         logging.info("Specified device is not a directory, therefore not mounting.")
1855         remove_device_mountpoint = False
1856     else:
1857         device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
1858         register_tmpfile(device_mountpoint)
1859         remove_device_mountpoint = True
1860         try:
1861             check_for_fat(device)
1862             mount(device, device_mountpoint, ['-o', 'utf8,iocharset=iso8859-1'])
1863         except CriticalException, error:
1864             try:
1865                 mount(device, device_mountpoint, "")
1866             except CriticalException, error:
1867                 logging.critical("Fatal: %s", error)
1868                 raise
1869     try:
1870         grml_flavours = identify_grml_flavour(mountpoint)
1871         for flavour in set(grml_flavours):
1872             logging.info("Identified grml flavour \"%s\".", flavour)
1873             install_iso_files(flavour, mountpoint, device, device_mountpoint)
1874     finally:
1875         if remove_device_mountpoint:
1876             remove_mountpoint(device_mountpoint)
1877
1878 def remove_mountpoint(mountpoint):
1879     """remove a registred mountpoint
1880     """
1881
1882     try:
1883         unmount(mountpoint, "")
1884         if os.path.isdir(mountpoint):
1885             os.rmdir(mountpoint)
1886             unregister_tmpfile(mountpoint)
1887     except CriticalException, error:
1888         logging.critical("Fatal: %s", error)
1889         cleanup()
1890
1891 def handle_mbr(device):
1892     """Main handler for installing master boot record (MBR)
1893
1894     @device: device where the MBR should be installed to"""
1895
1896     if options.dryrun:
1897         logging.info("Would install MBR")
1898         return 0
1899
1900     if device[-1:].isdigit():
1901         mbr_device = re.match(r'(.*?)\d*$', device).group(1)
1902         partition_number = int(device[-1:]) - 1
1903         skip_install_mir_mbr = False
1904
1905     # if we get e.g. /dev/loop1 as device we don't want to put the MBR
1906     # into /dev/loop of course, therefore use /dev/loop1 as mbr_device
1907     if mbr_device == "/dev/loop":
1908         mbr_device = device
1909         logging.info("Detected loop device - using %s as MBR device therefore", mbr_device)
1910         skip_install_mir_mbr = True
1911
1912     try:
1913         if options.syslinuxmbr:
1914             handle_syslinux_mbr(mbr_device)
1915         elif not skip_install_mir_mbr:
1916             if options.mbrmenu:
1917                 install_mir_mbr(GRML2USB_BASE + '/mbr/mbrmgr', mbr_device, partition_number, True)
1918             else:
1919                 install_mir_mbr(GRML2USB_BASE + '/mbr/mbrldr', mbr_device, partition_number, False)
1920     except IOError, error:
1921         logging.critical("Execution failed: %s", error)
1922         sys.exit(1)
1923     except Exception, error:
1924         logging.critical("Execution failed: %s", error)
1925         sys.exit(1)
1926
1927
1928 def handle_vfat(device):
1929     """Check for FAT specific settings and options
1930
1931     @device: device that should checked / formated"""
1932
1933     # make sure we have mkfs.vfat available
1934     if options.fat16:
1935         if not which("mkfs.vfat") and not options.copyonly and not options.dryrun:
1936             logging.critical('Sorry, mkfs.vfat not available. Exiting.')
1937             logging.critical('Please make sure to install dosfstools.')
1938             sys.exit(1)
1939
1940         if options.force:
1941             print "Forcing mkfs.fat16 on %s as requested via option --force." % device
1942         else:
1943             # make sure the user is aware of what he is doing
1944             f = raw_input("Are you sure you want to format the specified partition with fat16? y/N ")
1945             if f == "y" or f == "Y":
1946                 logging.info("Note: you can skip this question using the option --force")
1947             else:
1948                 sys.exit(1)
1949         try:
1950             mkfs_fat16(device)
1951         except CriticalException, error:
1952             logging.critical("Execution failed: %s", error)
1953             sys.exit(1)
1954
1955     # check for vfat filesystem
1956     if device is not None and not os.path.isdir(device) and options.syslinux:
1957         try:
1958             check_for_fat(device)
1959         except CriticalException, error:
1960             logging.critical("Execution failed: %s", error)
1961             sys.exit(1)
1962
1963     if not os.path.isdir(device) and not check_for_usbdevice(device) and not options.force:
1964         print "Warning: the specified device %s does not look like a removable usb device." % device
1965         f = raw_input("Do you really want to continue? y/N ")
1966         if f == "y" or f == "Y":
1967             pass
1968         else:
1969             sys.exit(1)
1970
1971
1972 def handle_compat_warning(device):
1973     """Backwards compatible checks
1974
1975     @device: device that should be checked"""
1976
1977     # make sure we can replace old grml2usb script and warn user when using old way of life:
1978     if device.startswith("/mnt/external") or device.startswith("/mnt/usb") and not options.force:
1979         print "Warning: the semantics of grml2usb has changed."
1980         print "Instead of using grml2usb /path/to/iso %s you might" % device
1981         print "want to use grml2usb /path/to/iso /dev/... instead."
1982         print "Please check out the grml2usb manpage for details."
1983         f = raw_input("Do you really want to continue? y/N ")
1984         if f == "y" or f == "Y":
1985             pass
1986         else:
1987             sys.exit(1)
1988
1989
1990 def handle_logging():
1991     """Log handling and configuration"""
1992
1993     if options.verbose and options.quiet:
1994         parser.error("please use either verbose (--verbose) or quiet (--quiet) option")
1995
1996     if options.verbose:
1997         FORMAT = "Debug: %(asctime)-15s %(message)s"
1998         logging.basicConfig(level=logging.DEBUG, format=FORMAT)
1999     elif options.quiet:
2000         FORMAT = "Critical: %(message)s"
2001         logging.basicConfig(level=logging.CRITICAL, format=FORMAT)
2002     else:
2003         FORMAT = "%(message)s"
2004         logging.basicConfig(level=logging.INFO, format=FORMAT)
2005
2006
2007 def handle_bootloader(device):
2008     """wrapper for installing bootloader
2009
2010     @device: device where bootloader should be installed to"""
2011
2012     # Install bootloader only if not using the --copy-only option
2013     if options.copyonly:
2014         logging.info("Not installing bootloader and its files as requested via option copyonly.")
2015     elif os.path.isdir(device):
2016         logging.info("Not installing bootloader as %s is a directory.", device)
2017     else:
2018         install_bootloader(device)
2019
2020
2021 def check_options(opts):
2022     """Check compability of provided user opts
2023
2024     @opts option dict from OptionParser
2025     """
2026     if opts.grubmbr and not opts.grub:
2027         logging.critical("Error: --grub-mbr requires --grub option.")
2028         sys.exit(1)
2029
2030
2031 def main():
2032     """Main function [make pylint happy :)]"""
2033
2034     if options.version:
2035         print os.path.basename(sys.argv[0]) + " " + PROG_VERSION
2036         sys.exit(0)
2037
2038     if len(args) < 2:
2039         parser.error("invalid usage")
2040
2041     # log handling
2042     handle_logging()
2043
2044     # make sure we have the appropriate permissions
2045     check_uid_root()
2046
2047     check_options(options)
2048
2049     logging.info("Executing grml2usb version %s", PROG_VERSION)
2050
2051     if options.dryrun:
2052         logging.info("Running in simulation mode as requested via option dry-run.")
2053
2054     # specified arguments
2055     device = args[len(args) - 1]
2056     isos = args[0:len(args) - 1]
2057
2058     if not os.path.isdir(device):
2059         if device[-1:].isdigit():
2060             if int(device[-1:]) > 4 or device[-2:].isdigit():
2061                 logging.critical("Fatal: installation on partition number >4 not supported. (BIOS won't support it.)")
2062                 sys.exit(1)
2063         elif os.path.exists(device):
2064             logging.critical("Fatal: installation on raw device not supported. (BIOS won't support it.)")
2065             sys.exit(1)
2066
2067     if options.grub:
2068         if not which("grub-install"):
2069             logging.critical("Fatal: grub-install not available (please install the "
2070                              + "grub package or drop the --grub option)")
2071             sys.exit(1)
2072
2073     if options.syslinux:
2074         if not which("syslinux"):
2075             logging.critical("Fatal: syslinux not available (please install the "
2076                              + "syslinux package or use the --grub option)")
2077             sys.exit(1)
2078
2079     if not which("rsync"):
2080         logging.critical("Fatal: rsync not available, can not continue - sorry.")
2081         sys.exit(1)
2082
2083     # provide upgrade path
2084     handle_compat_warning(device)
2085
2086     # check for vfat partition
2087     handle_vfat(device)
2088
2089     # main operation (like installing files)
2090     for iso in isos:
2091         install(iso, device)
2092
2093     # install mbr
2094     if not options.skipmbr and not os.path.isdir(device):
2095         handle_mbr(device)
2096
2097     handle_bootloader(device)
2098
2099     logging.info("Note: grml flavour %s was installed as the default booting system.", GRML_DEFAULT)
2100
2101     for flavour in GRML_FLAVOURS:
2102         logging.info("Note: you can boot flavour %s using '%s' on the commandline.", flavour, flavour)
2103
2104     # finally be politely :)
2105     logging.info("Finished execution of grml2usb (%s). Have fun with your grml system.", PROG_VERSION)
2106
2107
2108 if __name__ == "__main__":
2109     try:
2110         main()
2111     except KeyboardInterrupt:
2112         logging.info("Received KeyboardInterrupt")
2113         cleanup()
2114
2115 ## END OF FILE #################################################################
2116 # vim:foldmethod=indent expandtab ai ft=python tw=120 fileencoding=utf-8