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, 2010, 2011 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 # The line following this line is patched by debian/rules and tarball.sh.
  25 PROG_VERSION='***UNRELEASED***'
  26
  27 # global variables
  28 MOUNTED = set()  # register mountpoints
  29 TMPFILES = set() # register tmpfiles
  30 DATESTAMP = time.mktime(datetime.datetime.now().timetuple()) # unique identifier for syslinux.cfg
  31 GRML_FLAVOURS = set() # which flavours are being installed?
  32 GRML_DEFAULT = None
  33 UUID = None
  34 SYSLINUX_LIBS = "/usr/lib/syslinux/"
  35
  36 def syslinux_warning(option, opt, value, opt_parser):
  37     """A helper function for printing a warning about deprecated option
  38     """
  39     # pylint: disable-msg=W0613
  40     sys.stderr.write("Note: the --syslinux option is deprecated as syslinux "
  41                      "is grml2usb's default. Continuing anyway.\n")
  42     setattr(opt_parser.values, option.dest, True)
  43
  44 # if grub option is set, unset syslinux option
  45 def grub_option(option, opt, value, opt_parser):
  46     """A helper function adjusting other option values
  47     """
  48     # pylint: disable-msg=W0613
  49     setattr(opt_parser.values, option.dest, True)
  50     setattr(opt_parser.values, 'syslinux', False)
  51
  52 # cmdline parsing
  53 USAGE = "Usage: %prog [options] <[ISO[s] | /live/image]> </dev/sdX#>\n\
  54 \n\
  55 %prog installs grml ISO[s] to an USB device to be able to boot from it.\n\
  56 Make sure you have at least one grml ISO or a running grml system (/live/image),\n\
  57 grub or syslinux and root access.\n\
  58 \n\
  59 Run %prog --help for usage hints, further information via: man grml2usb"
  60
  61 # pylint: disable-msg=C0103
  62 # pylint: disable-msg=W0603
  63 parser = OptionParser(usage=USAGE)
  64 parser.add_option("--bootoptions", dest="bootoptions",
  65                   action="append", type="string",
  66                   help="use specified bootoptions as default")
  67 parser.add_option("--bootloader-only", dest="bootloaderonly", action="store_true",
  68                   help="do not copy files but just install a bootloader")
  69 parser.add_option("--copy-only", dest="copyonly", action="store_true",
  70                   help="copy files only but do not install bootloader")
  71 parser.add_option("--dry-run", dest="dryrun", action="store_true",
  72                   help="avoid executing commands")
  73 parser.add_option("--fat16", dest="fat16", action="store_true",
  74                   help="format specified partition with FAT16")
  75 parser.add_option("--force", dest="force", action="store_true",
  76                   help="force any actions requiring manual interaction")
  77 parser.add_option("--grub", dest="grub", action="callback",
  78                   callback=grub_option,
  79                   help="install grub bootloader instead of (default) syslinux")
  80 parser.add_option("--grub-mbr", dest="grubmbr", action="store_true",
  81                   help="install grub into MBR instead of (default) PBR")
  82 parser.add_option("--mbr-menu", dest="mbrmenu", action="store_true",
  83                   help="enable interactive boot menu in MBR")
  84 parser.add_option("--quiet", dest="quiet", action="store_true",
  85                   help="do not output anything but just errors on console")
  86 parser.add_option("--remove-bootoption", dest="removeoption", action="append",
  87                   help="regex for removing existing bootoptions")
  88 parser.add_option("--skip-addons", dest="skipaddons", action="store_true",
  89                   help="do not install /boot/addons/ files")
  90 parser.add_option("--skip-grub-config", dest="skipgrubconfig", action="store_true",
  91                   help="skip generation of grub configuration files")
  92 parser.add_option("--skip-mbr", dest="skipmbr", action="store_true",
  93                   help="do not install a master boot record (MBR) on the device")
  94 parser.add_option("--skip-syslinux-config", dest="skipsyslinuxconfig", action="store_true",
  95                   help="skip generation of syslinux configuration files")
  96 parser.add_option("--syslinux", dest="syslinux", action="callback", default=True,
  97                   callback=syslinux_warning,
  98                   help="install syslinux bootloader (deprecated as it's the default)")
  99 parser.add_option("--syslinux-mbr", dest="syslinuxmbr", action="store_true",
 100                   help="install syslinux master boot record (MBR) instead of default")
 101 parser.add_option("--verbose", dest="verbose", action="store_true",
 102                   help="enable verbose mode")
 103 parser.add_option("-v", "--version", dest="version", action="store_true",
 104                   help="display version and exit")
 105 (options, args) = parser.parse_args()
 106
 107
 108 GRML2USB_BASE = '/usr/share/grml2usb'
 109 if not os.path.isdir(GRML2USB_BASE):
 110     GRML2USB_BASE = os.path.dirname(os.path.realpath(__file__))
 111
 112
 113 class CriticalException(Exception):
 114     """Throw critical exception if the exact error is not known but fatal."
 115
 116     @Exception: message"""
 117     pass
 118
 119
 120 # The following two functions help to operate on strings as
 121 # array (list) of bytes (octets). In Python 3000, the bytes
 122 # datatype will need to be used. This is intended for using
 123 # with manipulation of files on the octet level, like shell
 124 # arrays, e.g. in MBR creation.
 125
 126
 127 def array2string(*a):
 128     """Convert a list of integers [0;255] to a string."""
 129     return struct.pack("%sB" % len(a), *a)
 130
 131
 132 def string2array(s):
 133     """Convert a (bytes) string into a list of integers."""
 134     return struct.unpack("%sB" % len(s), s)
 135
 136
 137 def cleanup():
 138     """Cleanup function to make sure there aren't any mounted devices left behind.
 139     """
 140
 141     logging.info("Cleaning up before exiting...")
 142     proc = subprocess.Popen(["sync"])
 143     proc.wait()
 144
 145     try:
 146         for device in MOUNTED:
 147             unmount(device, "")
 148         for tmpfile in TMPFILES:
 149             os.unlink(tmpfile)
 150     # ignore: RuntimeError: Set changed size during iteration
 151     except RuntimeError:
 152         logging.debug('caught expection RuntimeError, ignoring')
 153
 154
 155 def register_tmpfile(path):
 156     """
 157     register tmpfile
 158     """
 159
 160     TMPFILES.add(path)
 161
 162
 163 def unregister_tmpfile(path):
 164     """
 165     remove registered tmpfile
 166     """
 167
 168     try:
 169         TMPFILES.remove(path)
 170     except KeyError:
 171         pass
 172
 173
 174 def register_mountpoint(target):
 175     """register specified target in a set() for handling clean exiting
 176
 177     @target: destination target of mountpoint
 178     """
 179
 180     MOUNTED.add(target)
 181
 182
 183 def unregister_mountpoint(target):
 184     """unregister specified target in a set() for handling clean exiting
 185
 186     @target: destination target of mountpoint
 187     """
 188
 189     if target in MOUNTED:
 190         MOUNTED.remove(target)
 191
 192
 193 def get_function_name(obj):
 194     """Helper function for use in execute() to retrive name of a function
 195
 196     @obj: the function object
 197     """
 198     if not (isroutine(obj) or isclass(obj)):
 199         obj = type(obj)
 200     return obj.__module__ + '.' + obj.__name__
 201
 202
 203 def execute(f, *exec_arguments):
 204     """Wrapper for executing a command. Either really executes
 205     the command (default) or when using --dry-run commandline option
 206     just displays what would be executed."""
 207     # usage: execute(subprocess.Popen, (["ls", "-la"]))
 208     if options.dryrun:
 209         # pylint: disable-msg=W0141
 210         logging.debug('dry-run only: %s(%s)', get_function_name(f), ', '.join(map(repr, exec_arguments)))
 211     else:
 212         # pylint: disable-msg=W0142
 213         return f(*exec_arguments)
 214
 215
 216 def is_exe(fpath):
 217     """Check whether a given file can be executed
 218
 219     @fpath: full path to file
 220     @return:"""
 221     return os.path.exists(fpath) and os.access(fpath, os.X_OK)
 222
 223
 224 def which(program):
 225     """Check whether a given program is available in PATH
 226
 227     @program: name of executable"""
 228     fpath = os.path.split(program)[0]
 229     if fpath:
 230         if is_exe(program):
 231             return program
 232     else:
 233         for path in os.environ["PATH"].split(os.pathsep):
 234             exe_file = os.path.join(path, program)
 235             if is_exe(exe_file):
 236                 return exe_file
 237
 238     return None
 239
 240
 241 def get_defaults_file(iso_mount, flavour, name):
 242     """get the default file for syslinux
 243     """
 244     bootloader_dirs = ['/boot/isolinux/', '/boot/syslinux/']
 245     for directory in bootloader_dirs:
 246         for name in name, \
 247         "%s_%s" % (get_flavour_filename(flavour), name):
 248             if os.path.isfile(iso_mount + directory + name):
 249                 return (directory, name)
 250     return ('','')
 251
 252 def search_file(filename, search_path='/bin' + os.pathsep + '/usr/bin'):
 253     """Given a search path, find file
 254
 255     @filename: name of file to search for
 256     @search_path: path where searching for the specified filename"""
 257     file_found = 0
 258     paths = search_path.split(os.pathsep)
 259     current_dir = '' # make pylint happy :)
 260
 261     def match_file(cwd):
 262         """Helper function ffor testing if specified file exists in cwd
 263
 264         @cwd: current working directory
 265         """
 266         return  os.path.exists(os.path.join(cwd, filename))
 267
 268     for path in paths:
 269         current_dir = path
 270         if match_file(current_dir):
 271             file_found = 1
 272             break
 273         # pylint: disable-msg=W0612
 274         for current_dir, directories, files in os.walk(path):
 275             if match_file(current_dir):
 276                 file_found = 1
 277                 break
 278     if file_found:
 279         return os.path.abspath(os.path.join(current_dir, filename))
 280     else:
 281         return None
 282
 283
 284 def check_uid_root():
 285     """Check for root permissions"""
 286     if not os.geteuid()==0:
 287         sys.exit("Error: please run this script with uid 0 (root).")
 288
 289
 290 def mkfs_fat16(device):
 291     """Format specified device with VFAT/FAT16 filesystem.
 292
 293     @device: partition that should be formated"""
 294
 295     if options.dryrun:
 296         logging.info("Would execute mkfs.vfat -F 16 %s now.", device)
 297         return 0
 298
 299     logging.info("Formating partition with fat16 filesystem")
 300     logging.debug("mkfs.vfat -F 16 %s", device)
 301     proc = subprocess.Popen(["mkfs.vfat", "-F", "16", device])
 302     proc.wait()
 303     if proc.returncode != 0:
 304         raise CriticalException("error executing mkfs.vfat")
 305
 306
 307 def generate_isolinux_splash(grml_flavour):
 308     """Generate bootsplash for isolinux/syslinux
 309
 310     @grml_flavour: name of grml flavour the configuration should be generated for"""
 311
 312     grml_name = grml_flavour
 313
 314     return("""\
 315 \ f17\f\18/boot/syslinux/logo.16
 316
 317 Some information and boot options available via keys F2 - F10. http://grml.org/
 318 %(grml_name)s
 319 """ % {'grml_name': grml_name} )
 320
 321
 322 def generate_main_syslinux_config(*arg):
 323     """Generate main configuration for use in syslinux.cfg
 324
 325     @*arg: just for backward compatibility"""
 326     # pylint: disable-msg=W0613
 327     # remove warning about unused arg
 328
 329     return("""\
 330 label -
 331 menu label Default boot modes:
 332 menu disable
 333 include defaults.cfg
 334
 335 menu end
 336 menu separator
 337
 338 # flavours:
 339 label -
 340 menu label Additional boot entries for:
 341 menu disable
 342 include additional.cfg
 343
 344 menu separator
 345 include options.cfg
 346 include addons.cfg
 347
 348 label help
 349   include promptname.cfg
 350   config prompt.cfg
 351   text help
 352                                         Jump to old style isolinux prompt
 353                                         featuring further information
 354                                         regarding available boot options.
 355   endtext
 356
 357
 358 include hiddens.cfg
 359 """)
 360
 361
 362 def generate_flavour_specific_syslinux_config(grml_flavour):
 363     """Generate flavour specific configuration for use in syslinux.cfg
 364
 365     @grml_flavour: name of grml flavour the configuration should be generated for"""
 366
 367
 368     return("""\
 369 menu begin grml %(grml_flavour)s
 370     menu title %(display_name)s
 371     label mainmenu
 372     menu label ^Back to main menu...
 373     menu exit
 374     menu separator
 375     # include config for boot parameters from disk
 376     include %(grml_flavour)s_grml.cfg
 377     menu hide
 378 menu end
 379 """ % {'grml_flavour': grml_flavour, 'display_name' : get_flavour_filename(grml_flavour) } )
 380
 381
 382 def install_grub(device):
 383     """Install grub on specified device.
 384
 385     @mntpoint: mountpoint of device where grub should install its files to
 386     @device: partition where grub should be installed to"""
 387
 388     if options.dryrun:
 389         logging.info("Would execute grub-install [--root-directory=mount_point] %s now.", device)
 390     else:
 391         device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
 392         register_tmpfile(device_mountpoint)
 393         try:
 394             try:
 395                 mount(device, device_mountpoint, "")
 396
 397                 # If using --grub-mbr then make sure we install grub in MBR instead of PBR
 398                 if options.grubmbr:
 399                     logging.debug("Using option --grub-mbr ...")
 400                     if device[-1:].isdigit():
 401                         grub_device = re.match(r'(.*?)\d*$', device).group(1)
 402                     else:
 403                         grub_device = device
 404                 else:
 405                     grub_device = device
 406
 407                 logging.info("Installing grub as bootloader")
 408                 for opt in ["", "--force" ]:
 409                     logging.debug("grub-install --recheck %s --no-floppy --root-directory=%s %s",
 410                                   opt, device_mountpoint, grub_device)
 411                     proc = subprocess.Popen(["grub-install", "--recheck", opt, "--no-floppy",
 412                                              "--root-directory=%s" % device_mountpoint, grub_device],
 413                                             stdout=file(os.devnull, "r+"))
 414                     proc.wait()
 415                     if proc.returncode == 0:
 416                         break
 417
 418                 if proc.returncode != 0:
 419                     # raise Exception("error executing grub-install")
 420                     logging.critical("Fatal: error executing grub-install "
 421                                      + "(please check the grml2usb FAQ or drop the --grub option)")
 422                     logging.critical("Note:  if using grub2 consider using "
 423                                      + "the --grub-mbr option as grub considers PBR problematic.")
 424                     cleanup()
 425                     sys.exit(1)
 426             except CriticalException, error:
 427                 logging.critical("Fatal: %s", error)
 428                 cleanup()
 429                 sys.exit(1)
 430
 431         finally:
 432             unmount(device_mountpoint, "")
 433             os.rmdir(device_mountpoint)
 434             unregister_tmpfile(device_mountpoint)
 435
 436
 437 def install_syslinux(device):
 438     """Install syslinux on specified device.
 439
 440     @device: partition where syslinux should be installed to"""
 441
 442     if options.dryrun:
 443         logging.info("Would install syslinux as bootloader on %s", device)
 444         return 0
 445
 446     # syslinux -d boot/isolinux /dev/sdb1
 447     logging.info("Installing syslinux as bootloader")
 448     logging.debug("syslinux -d boot/syslinux %s", device)
 449     proc = subprocess.Popen(["syslinux", "-d", "boot/syslinux", device])
 450     proc.wait()
 451     if proc.returncode != 0:
 452         raise CriticalException("Error executing syslinux (either try --fat16 or use grub?)")
 453
 454
 455 def install_bootloader(device):
 456     """Install bootloader on specified device.
 457
 458     @device: partition where bootloader should be installed to"""
 459
 460     # by default we use grub, so install syslinux only on request
 461     if options.grub:
 462         try:
 463             install_grub(device)
 464         except CriticalException, error:
 465             logging.critical("Fatal: %s", error)
 466             cleanup()
 467             sys.exit(1)
 468     else:
 469         try:
 470             install_syslinux(device)
 471         except CriticalException, error:
 472             logging.critical("Fatal: %s", error)
 473             cleanup()
 474             sys.exit(1)
 475
 476
 477 def install_mbr(mbrtemplate, device, partition, ismirbsdmbr=True):
 478     """install 'mbr' master boot record (MBR) on a device
 479
 480     Retrieve the partition table from "device", install an MBR from the
 481     "mbrtemplate" file, set the "partition" (0..3) active, and install the
 482     result back to "device".
 483
 484     @mbrtemplate: default MBR file
 485
 486     @device: name of a file assumed to be a hard disc (or USB stick) image, or
 487     something like "/dev/sdb"
 488
 489     @partition: must be a number between 0 and 3, inclusive
 490
 491     @mbrtemplate: must be a valid MBR file of at least 440 (or 439 if
 492     ismirbsdmbr) bytes.
 493
 494     @ismirbsdmbr: if true then ignore the active flag, set the mirbsdmbr
 495     specific flag to 0/1/2/3 and set the MBR's default value accordingly. If
 496     false then leave the mirbsdmbr specific flag set to FFh, set all
 497     active flags to 0 and set the active flag of the partition to 80h.  Note:
 498     behaviour of mirbsdmbr: if flag = 0/1/2/3 then use it, otherwise search for
 499     the active flag."""
 500
 501     logging.info("Installing default MBR")
 502
 503     if not os.path.isfile(mbrtemplate):
 504         logging.critical("Error: %s can not be read.", mbrtemplate)
 505         raise CriticalException("Error installing MBR (either try --syslinux-mbr or install missing file \"%s\"?)" % mbrtemplate)
 506
 507     if partition is not None and ((partition < 0) or (partition > 3)):
 508         logging.warn("Cannot activate partition %d" % partition)
 509         partition = None
 510
 511     if ismirbsdmbr:
 512         nmbrbytes = 439
 513     else:
 514         nmbrbytes = 440
 515
 516     tmpf = tempfile.NamedTemporaryFile()
 517
 518     logging.debug("executing: dd if='%s' of='%s' bs=512 count=1", device, tmpf.name)
 519     proc = subprocess.Popen(["dd", "if=%s" % device, "of=%s" % tmpf.name, "bs=512", "count=1"],
 520                             stderr=file(os.devnull, "r+"))
 521     proc.wait()
 522     if proc.returncode != 0:
 523         raise Exception("error executing dd (first run)")
 524
 525     logging.debug("executing: dd if=%s of=%s bs=%s count=1 conv=notrunc", mbrtemplate,
 526                   tmpf.name, nmbrbytes)
 527     proc = subprocess.Popen(["dd", "if=%s" % mbrtemplate, "of=%s" % tmpf.name, "bs=%s" % nmbrbytes,
 528                              "count=1", "conv=notrunc"], stderr=file(os.devnull, "r+"))
 529     proc.wait()
 530     if proc.returncode != 0:
 531         raise Exception("error executing dd (second run)")
 532
 533     mbrcode = tmpf.file.read(512)
 534     if len(mbrcode) < 512:
 535         raise EOFError("MBR size (%d) < 512" % len(mbrcode))
 536
 537     if partition is not None:
 538         if ismirbsdmbr:
 539             mbrcode = mbrcode[0:439] + chr(partition) + \
 540                     mbrcode[440:510] + "\x55\xAA"
 541         else:
 542             actives = ["\x00", "\x00", "\x00", "\x00"]
 543             actives[partition] = "\x80"
 544             mbrcode = mbrcode[0:446] + actives[0] + \
 545                     mbrcode[447:462] + actives[1] + \
 546                     mbrcode[463:478] + actives[2] + \
 547                     mbrcode[479:494] + actives[3] + \
 548                     mbrcode[495:510] + "\x55\xAA"
 549
 550     tmpf.file.seek(0)
 551     tmpf.file.truncate()
 552     tmpf.file.write(mbrcode)
 553     tmpf.file.close()
 554
 555     logging.debug("executing: dd if='%s' of='%s' bs=512 count=1 conv=notrunc", tmpf.name, device)
 556     proc = subprocess.Popen(["dd", "if=%s" % tmpf.name, "of=%s" % device, "bs=512", "count=1",
 557                              "conv=notrunc"], stderr=file(os.devnull, "r+"))
 558     proc.wait()
 559     if proc.returncode != 0:
 560         raise Exception("error executing dd (third run)")
 561     del tmpf
 562
 563
 564 def is_writeable(device):
 565     """Check if the device is writeable for the current user
 566
 567     @device: partition where bootloader should be installed to"""
 568
 569     if not device:
 570         return False
 571         #raise Exception("no device for checking write permissions")
 572
 573     if not os.path.exists(device):
 574         return False
 575
 576     return os.access(device, os.W_OK) and os.access(device, os.R_OK)
 577
 578
 579 def mount(source, target, mount_options):
 580     """Mount specified source on given target
 581
 582     @source: name of device/ISO that should be mounted
 583     @target: directory where the ISO should be mounted to
 584     @options: mount specific options"""
 585
 586     # note: options.dryrun does not work here, as we have to
 587     # locate files and identify the grml flavour
 588
 589     for x in file('/proc/mounts').readlines():
 590         if x.startswith(source):
 591             raise CriticalException("Error executing mount: %s already mounted - " % source
 592                                     + "please unmount before invoking grml2usb")
 593
 594     if os.path.isdir(source):
 595         logging.debug("Source %s is not a device, therefore not mounting.", source)
 596         return 0
 597
 598     logging.debug("mount %s %s %s", mount_options, source, target)
 599     proc = subprocess.Popen(["mount"] + list(mount_options) + [source, target])
 600     proc.wait()
 601     if proc.returncode != 0:
 602         raise CriticalException("Error executing mount (no filesystem on the partition?)")
 603     else:
 604         logging.debug("register_mountpoint(%s)", target)
 605         register_mountpoint(target)
 606
 607
 608 def unmount(target, unmount_options):
 609     """Unmount specified target
 610
 611     @target: target where something is mounted on and which should be unmounted
 612     @options: options for umount command"""
 613
 614     # make sure we unmount only already mounted targets
 615     target_unmount = False
 616     mounts = open('/proc/mounts').readlines()
 617     mountstring = re.compile(".*%s.*" % re.escape(os.path.realpath(target)))
 618     for line in mounts:
 619         if re.match(mountstring, line):
 620             target_unmount = True
 621
 622     if not target_unmount:
 623         logging.debug("%s not mounted anymore", target)
 624     else:
 625         logging.debug("umount %s %s", list(unmount_options), target)
 626         proc = subprocess.Popen(["umount"] + list(unmount_options) + [target])
 627         proc.wait()
 628         if proc.returncode != 0:
 629             raise Exception("Error executing umount")
 630         else:
 631             logging.debug("unregister_mountpoint(%s)", target)
 632             unregister_mountpoint(target)
 633
 634
 635 def check_for_usbdevice(device):
 636     """Check whether the specified device is a removable USB device
 637
 638     @device: device name, like /dev/sda1 or /dev/sda
 639     """
 640
 641     usbdevice = re.match(r'/dev/(.*?)\d*$', device).group(1)
 642     # newer systems:
 643     usbdev = os.path.realpath('/sys/class/block/' + usbdevice + '/removable')
 644     if not os.path.isfile(usbdev):
 645         # Ubuntu with kernel 2.6.24 for example:
 646         usbdev = os.path.realpath('/sys/block/' + usbdevice + '/removable')
 647
 648     if os.path.isfile(usbdev):
 649         is_usb = open(usbdev).readline()
 650         if is_usb.find("1"):
 651             return 0
 652
 653     return 1
 654
 655
 656 def check_for_fat(partition):
 657     """Check whether specified partition is a valid VFAT/FAT16 filesystem
 658
 659     @partition: device name of partition"""
 660
 661     if not os.access(partition, os.R_OK):
 662         raise CriticalException("Failed to read device %s"
 663                 " (wrong UID/permissions or device/directory not present?)" % partition)
 664
 665     try:
 666         udev_info = subprocess.Popen(["/sbin/blkid", "-s", "TYPE", "-o", "value", partition],
 667                                      stdout=subprocess.PIPE, stderr=subprocess.PIPE)
 668         filesystem = udev_info.communicate()[0].rstrip()
 669
 670         if filesystem != "vfat":
 671             raise CriticalException(
 672                     "Partition %s does not contain a FAT16 filesystem. "
 673                     "(Use --fat16 or run mkfs.vfat %s)" % (partition, partition))
 674
 675     except OSError:
 676         raise CriticalException("Sorry, /sbin/blkid not available (install e2fsprogs?)")
 677
 678
 679 def mkdir(directory):
 680     """Simple wrapper around os.makedirs to get shell mkdir -p behaviour"""
 681
 682     # just silently pass as it's just fine it the directory exists
 683     if not os.path.isdir(directory):
 684         try:
 685             os.makedirs(directory)
 686         # pylint: disable-msg=W0704
 687         except OSError:
 688             pass
 689
 690
 691 def exec_rsync(source, target):
 692     """Simple wrapper around rsync to install files
 693
 694     @source: source file/directory
 695     @target: target file/directory"""
 696     logging.debug("Source: %s / Target: %s", source, target)
 697     proc = subprocess.Popen(["rsync", "-rlptDH", "--inplace", source, target])
 698     proc.wait()
 699     if proc.returncode == 12:
 700         logging.critical("Fatal: No space left on device")
 701         cleanup()
 702         sys.exit(1)
 703
 704     if proc.returncode != 0:
 705         logging.critical("Fatal: could not install %s", source)
 706         cleanup()
 707         sys.exit(1)
 708
 709
 710 def write_uuid(target_file):
 711     """Generates an returns uuid and write it to the specified file
 712
 713     @target_file: filename to write the uuid to
 714     """
 715
 716     fileh = open(target_file, 'w')
 717     uid = str(uuid.uuid4())
 718     fileh.write(uid)
 719     fileh.close()
 720     return uid
 721
 722
 723 def get_uuid(target):
 724     """Get the uuid of the specified target. Will generate an uuid if none exist.
 725
 726     @target: directory/mountpoint containing the grml layout
 727     """
 728
 729     conf_target = target + "/conf/"
 730     uuid_file_name = conf_target + "/bootid.txt"
 731     if os.path.isdir(conf_target):
 732         if os.path.isfile(uuid_file_name):
 733             uuid_file = open(uuid_file_name, 'r')
 734             uid = uuid_file.readline().strip()
 735             uuid_file.close()
 736             return uid
 737         else:
 738             return write_uuid(uuid_file_name)
 739     else:
 740         execute(mkdir, conf_target)
 741         return write_uuid(uuid_file_name)
 742
 743 def get_shortname(grml_flavour):
 744     """Get shortname based from grml_flavour name. The rules applied are the same as in grml-live
 745     @grml_flavour: flavour name which shold be translated to shortname"""
 746
 747     return re.sub(r'[,._-]', '', grml_flavour)
 748
 749 def copy_system_files(grml_flavour, iso_mount, target):
 750     """copy grml's main files (like squashfs, kernel and initrd) to a given target
 751
 752     @grml_flavour: name of grml flavour the configuration should be generated for
 753     @iso_mount: path where a grml ISO is mounted on
 754     @target: path where grml's main files should be copied to"""
 755
 756     squashfs = search_file(grml_flavour + '.squashfs', iso_mount)
 757     if squashfs is None:
 758         logging.critical("Fatal: squashfs file not found"
 759         ", please check that your iso is not corrupt")
 760         raise CriticalException("error locating squashfs file")
 761     else:
 762         squashfs_target = target + '/live/' + grml_flavour + '/'
 763         execute(mkdir, squashfs_target)
 764     exec_rsync(squashfs, squashfs_target + grml_flavour + '.squashfs')
 765
 766     for prefix in grml_flavour + "/", "":
 767         filesystem_module = search_file(prefix + 'filesystem.module', iso_mount)
 768         if filesystem_module:
 769             break
 770     if filesystem_module is None:
 771         logging.critical("Fatal: filesystem.module not found")
 772         raise CriticalException("error locating filesystem.module file")
 773     else:
 774         exec_rsync(filesystem_module, squashfs_target + 'filesystem.module')
 775
 776
 777     shortname = get_shortname(grml_flavour)
 778     if os.path.isdir(iso_mount + '/boot/' + shortname):
 779         exec_rsync(iso_mount + '/boot/' + shortname, target + '/boot')
 780     else:
 781         kernel = search_file('vmlinuz', iso_mount)
 782         if kernel is None:
 783             # compat for releases < 2011.12
 784             kernel = search_file('linux26', iso_mount)
 785
 786         if kernel is None:
 787             logging.critical("Fatal: kernel not found")
 788             raise CriticalException("error locating kernel file")
 789
 790         source = os.path.dirname(kernel) + '/'
 791         dest = target + '/' + os.path.dirname(kernel).replace(iso_mount,'') + '/'
 792         execute(mkdir, dest)
 793         exec_rsync(source, dest)
 794
 795
 796 def update_grml_versions(iso_mount, target):
 797     """Update the grml version file on a cd
 798     Returns true if version was updated successfully,
 799     False if grml-version does not exist yet on the mountpoint
 800
 801     @iso_mount: string of the iso mount point
 802     @target: path of the target mount point
 803     """
 804     grml_target = target + '/grml/'
 805     target_grml_version_file = search_file('grml-version', grml_target)
 806     if target_grml_version_file:
 807         iso_grml_version_file = search_file('grml-version', iso_mount)
 808         if not iso_grml_version_file:
 809             logging.warn("Warning: %s could not be found - can not install it", iso_grml_version_file)
 810             return False
 811         try:
 812             # read the flavours from the iso image
 813             iso_versions = {}
 814             iso_file = open(iso_grml_version_file, 'r')
 815             for line in iso_file:
 816                 iso_versions[get_flavour(line)] = line.strip()
 817
 818             # update the existing flavours on the target
 819             for line in fileinput.input([target_grml_version_file], inplace=1):
 820                 flavour = get_flavour(line)
 821                 if flavour in iso_versions.keys():
 822                     print iso_versions.pop(flavour)
 823                 else:
 824                     print line.strip()
 825             fileinput.close()
 826
 827             target_file = open(target_grml_version_file, 'a')
 828             # add the new flavours from the current iso
 829             for flavour in iso_versions:
 830                 target_file.write("%s\n" % iso_versions[flavour])
 831         except IOError:
 832             logging.warn("Warning: Could not write file")
 833         finally:
 834             iso_file.close()
 835             target_file.close()
 836         return True
 837     else:
 838         return False
 839
 840 def copy_grml_files(grml_flavour, iso_mount, target):
 841     """copy some minor grml files to a given target
 842
 843     @grml_flavour: the current grml_flavour
 844     @iso_mount: path where a grml ISO is mounted on
 845     @target: path where grml's main files should be copied to"""
 846
 847     grml_target = target + '/grml/'
 848     execute(mkdir, grml_target)
 849
 850     grml_prefixe = ["GRML", "grml"]
 851     for prefix in grml_prefixe:
 852       filename = "{0}/{1}/{2}".format(iso_mount, prefix, grml_flavour)
 853       if os.path.exists(filename):
 854         exec_rsync(filename, grml_target)
 855         break
 856     else:
 857       logging.warn("Warning: could not find flavour directory for %s ", grml_flavour)
 858
 859
 860 def handle_addon_copy(filename, dst, iso_mount, ignore_errors=False):
 861     """handle copy of optional addons
 862
 863     @filename: filename of the addon
 864     @dst: destination directory
 865     @iso_mount: location of the iso mount
 866     @ignore_errors: don't report missing files
 867     """
 868     file_location = search_file(filename, iso_mount)
 869     if file_location is None:
 870         if not ignore_errors:
 871             logging.warn("Warning: %s not found (that's fine if you don't need it)",  filename)
 872     else:
 873         exec_rsync(file_location, dst)
 874
 875
 876 def copy_addons(iso_mount, target):
 877     """copy grml's addons files (like allinoneimg, bsd4grml,..) to a given target
 878
 879     @iso_mount: path where a grml ISO is mounted on
 880     @target: path where grml's main files should be copied to"""
 881
 882     addons = target + '/boot/addons/'
 883     execute(mkdir, addons)
 884
 885     # grub all-in-one image
 886     handle_addon_copy('allinone.img', addons, iso_mount)
 887
 888     # bsd imag
 889     handle_addon_copy('bsd4grml', addons, iso_mount)
 890
 891     handle_addon_copy('balder10.imz', addons, iso_mount)
 892
 893     # install hdt and pci.ids only when using syslinux (grub doesn't support it)
 894     if options.syslinux:
 895         # hdt (hardware detection tool) image
 896         hdtimg = search_file('hdt.c32', iso_mount)
 897         if hdtimg:
 898             exec_rsync(hdtimg, addons + '/hdt.c32')
 899
 900         # pci.ids file
 901         picids = search_file('pci.ids', iso_mount)
 902         if picids:
 903             exec_rsync(picids, addons + '/pci.ids')
 904
 905     # memdisk image
 906     handle_addon_copy('memdisk', addons, iso_mount)
 907
 908     # memtest86+ image
 909     handle_addon_copy('memtest', addons, iso_mount)
 910
 911     # gpxe.lkrn: got replaced by ipxe
 912     handle_addon_copy('gpxe.lkrn', addons, iso_mount, ignore_errors=True)
 913
 914     # ipxe.lkrn
 915     handle_addon_copy('ipxe.lkrn', addons, iso_mount)
 916
 917 def glob_and_copy(filepattern, dst):
 918     """Glob on specified filepattern and copy the result to dst
 919
 920     @filepattern: globbing pattern
 921     @dst: target directory
 922     """
 923     for name in glob.glob(filepattern):
 924         copy_if_exist(name, dst)
 925
 926 def search_and_copy(filename, search_path, dst):
 927     """Search for the specified filename at searchpath and copy it to dst
 928
 929     @filename: filename to look for
 930     @search_path: base search file
 931     @dst: destionation to copy the file to
 932     """
 933     file_location = search_file(filename, search_path)
 934     copy_if_exist(file_location, dst)
 935
 936 def copy_if_exist(filename, dst):
 937     """Copy filename to dst if filename is set.
 938
 939     @filename: a filename
 940     @dst: dst file
 941     """
 942     if filename and (os.path.isfile(filename) or os.path.isdir(filename)):
 943         exec_rsync(filename, dst)
 944
 945 def copy_bootloader_files(iso_mount, target, grml_flavour):
 946     """Copy grml's bootloader files to a given target
 947
 948     @iso_mount: path where a grml ISO is mounted on
 949     @target: path where grml's main files should be copied to
 950     @grml_flavour: name of the current processed grml_flavour
 951     """
 952
 953     syslinux_target = target + '/boot/syslinux/'
 954     execute(mkdir, syslinux_target)
 955
 956     grub_target = target + '/boot/grub/'
 957     execute(mkdir, grub_target)
 958
 959     logo = search_file('logo.16', iso_mount)
 960     exec_rsync(logo, syslinux_target + 'logo.16')
 961
 962     bootx64_efi = search_file('bootx64.efi', iso_mount)
 963     if bootx64_efi:
 964         mkdir(target + '/efi/boot/')
 965         exec_rsync(bootx64_efi, target + '/efi/boot/bootx64.efi')
 966
 967     efi_img = search_file('efi.img', iso_mount)
 968     if efi_img:
 969         mkdir(target + '/boot/')
 970         exec_rsync(efi_img, target + '/boot/efi.img')
 971
 972     for ffile in ['f%d' % number for number in range(1, 11) ]:
 973         search_and_copy(ffile, iso_mount, syslinux_target + ffile)
 974
 975     loopback_cfg = search_file("loopback.cfg", iso_mount)
 976     if loopback_cfg:
 977         directory = os.path.dirname(loopback_cfg)
 978         directory = directory.replace(iso_mount, "")
 979         mkdir(os.path.join(target, directory))
 980         exec_rsync(loopback_cfg, target + os.path.sep + directory)
 981
 982     # avoid the "file is read only, overwrite anyway (y/n) ?" question
 983     # of mtools by syslinux ("mmove -D o -D O s:/ldlinux.sys $target_file")
 984     if os.path.isfile(syslinux_target + 'ldlinux.sys'):
 985         os.unlink(syslinux_target + 'ldlinux.sys')
 986
 987     (source_dir, name) = get_defaults_file(iso_mount, grml_flavour, "default.cfg")
 988     (source_dir, defaults_file) = get_defaults_file(iso_mount, grml_flavour, "grml.cfg")
 989
 990     if not source_dir:
 991         logging.critical("Fatal: file default.cfg could not be found.")
 992         logging.critical("Note:  this grml2usb version requires an ISO generated by grml-live >=0.9.24 ...")
 993         logging.critical("       ... either use grml releases >=2009.10 or switch to an older grml2usb version.")
 994         raise
 995
 996     if not os.path.exists(iso_mount + '/boot/grub/footer.cfg'):
 997         logging.warning("Warning: Grml releases older than 2011.12 support only one flavour in grub.")
 998
 999     for expr in name, 'distri.cfg', \
1000         defaults_file, 'grml.png', 'hd.cfg', 'isolinux.cfg', 'isolinux.bin', \
1001         'isoprompt.cfg', 'options.cfg', \
1002         'prompt.cfg', 'vesamenu.cfg', 'grml.png', '*.c32':
1003         glob_and_copy(iso_mount + source_dir + expr, syslinux_target)
1004
1005     for filename in glob.glob1(syslinux_target, "*.c32"):
1006         copy_if_exist(os.path.join(SYSLINUX_LIBS, filename), syslinux_target)
1007
1008
1009     # copy the addons_*.cfg file to the new syslinux directory
1010     glob_and_copy(iso_mount + source_dir + 'addon*.cfg', syslinux_target)
1011
1012     search_and_copy('hidden.cfg', iso_mount + source_dir, syslinux_target + "new_" + 'hidden.cfg')
1013
1014     # copy all grub files from ISO
1015     glob_and_copy(iso_mount + '/boot/grub/*', grub_target)
1016
1017 def install_iso_files(grml_flavour, iso_mount, device, target):
1018     """Copy files from ISO to given target
1019
1020     @grml_flavour: name of grml flavour the configuration should be generated for
1021     @iso_mount: path where a grml ISO is mounted on
1022     @device: device/partition where bootloader should be installed to
1023     @target: path where grml's main files should be copied to"""
1024
1025     global GRML_DEFAULT
1026     GRML_DEFAULT = GRML_DEFAULT or grml_flavour
1027     if options.dryrun:
1028         return 0
1029     elif not options.bootloaderonly:
1030         logging.info("Copying files. This might take a while....")
1031         try:
1032             copy_system_files(grml_flavour, iso_mount, target)
1033             copy_grml_files(grml_flavour, iso_mount, target)
1034         except CriticalException, error:
1035             logging.critical("Execution failed: %s", error)
1036             sys.exit(1)
1037
1038     if not options.skipaddons:
1039         if not search_file('addons', iso_mount):
1040             logging.info("Could not find addons, therefore not installing.")
1041         else:
1042             copy_addons(iso_mount, target)
1043
1044     if not options.copyonly:
1045         copy_bootloader_files(iso_mount, target, grml_flavour)
1046
1047         if not options.dryrun:
1048             handle_bootloader_config(grml_flavour, device, target)
1049
1050     # make sure we sync filesystems before returning
1051     proc = subprocess.Popen(["sync"])
1052     proc.wait()
1053
1054
1055 def get_flavour(flavour_str):
1056     """Returns the flavour of a grml version string
1057     """
1058     return re.match(r'[\w-]*', flavour_str).group()
1059
1060 def identify_grml_flavour(mountpath):
1061     """Get name of grml flavour
1062
1063     @mountpath: path where the grml ISO is mounted to
1064     @return: name of grml-flavour"""
1065
1066     version_file = search_file('grml-version', mountpath)
1067
1068     if version_file == "":
1069         logging.critical("Error: could not find grml-version file.")
1070         raise
1071
1072     flavours = []
1073     tmpfile = None
1074     try:
1075         tmpfile = open(version_file, 'r')
1076         for line in tmpfile.readlines():
1077             flavours.append(get_flavour(line))
1078     except TypeError, e:
1079         raise
1080     except Exception, e:
1081         logging.critical("Unexpected error: %s", e)
1082         raise
1083     finally:
1084         if tmpfile:
1085             tmpfile.close()
1086
1087     return flavours
1088
1089
1090 def get_bootoptions(grml_flavour):
1091     """Returns bootoptions for specific flavour
1092
1093     @grml_flavour: name of the grml_flavour
1094     """
1095     # do NOT write "None" in kernel cmdline
1096     if not options.bootoptions:
1097         bootopt = ""
1098     else:
1099         bootopt = " ".join(options.bootoptions)
1100     bootopt = bootopt.replace("%flavour", grml_flavour)
1101     return bootopt
1102
1103
1104 def handle_grub_config(grml_flavour, device, target):
1105     """Main handler for generating grub (v1 and v2) configuration
1106
1107     @grml_flavour: name of grml flavour the configuration should be generated for
1108     @device: device/partition where grub should be installed to
1109     @target: path of grub's configuration files"""
1110
1111     global UUID
1112
1113     logging.debug("Updating grub configuration")
1114
1115     grub_target = target + '/boot/grub/'
1116
1117     bootid_re = re.compile("bootid=[\w_-]+")
1118     live_media_path_re = re.compile("live-media-path=[\w_/-]+")
1119
1120     bootopt = get_bootoptions(grml_flavour)
1121
1122     remove_regexes = []
1123     option_re = re.compile(r'(.*/boot/.*(linux26|vmlinuz).*)')
1124
1125     if options.removeoption:
1126         for regex in options.removeoption:
1127             remove_regexes.append(re.compile(regex))
1128
1129     shortname = get_shortname(grml_flavour)
1130     for filename in glob.glob(grub_target + '*.cfg'):
1131         for line in fileinput.input(filename, inplace=1):
1132             line = line.rstrip("\r\n")
1133             if option_re.search(line):
1134                 line = bootid_re.sub('', line)
1135                 if shortname in filename:
1136                     line = live_media_path_re.sub('', line)
1137                     line = line.rstrip() + ' live-media-path=/live/%s/ ' % (grml_flavour)
1138                 line = line.rstrip() + r' bootid=%s %s ' % (UUID, bootopt)
1139                 for regex in remove_regexes:
1140                     line = regex.sub(' ', line)
1141             print line
1142         fileinput.close()
1143
1144
1145 def initial_syslinux_config(target):
1146     """Generates intial syslinux configuration
1147
1148     @target path of syslinux's configuration files"""
1149
1150     target = target + "/"
1151     filename = target + "grmlmain.cfg"
1152     if os.path.isfile(target + "grmlmain.cfg"):
1153         return
1154     data = open(filename, "w")
1155     data.write(generate_main_syslinux_config())
1156     data.close()
1157
1158     filename = target + "hiddens.cfg"
1159     data = open(filename, "w")
1160     data.write("include hidden.cfg\n")
1161     data.close()
1162
1163 def add_entry_if_not_present(filename, entry):
1164     """Write entry into filename if entry is not already in the file
1165
1166     @filanme: name of the file
1167     @entry: data to write to the file
1168     """
1169     data = open(filename, "a+")
1170     for line in data:
1171         if line == entry:
1172             break
1173     else:
1174         data.write(entry)
1175
1176     data.close()
1177
1178 def get_flavour_filename(flavour):
1179     """Generate a iso9960 save filename out of the specified flavour
1180
1181     @flavour: grml flavour
1182     """
1183     return flavour.replace('-', '_')
1184
1185 def adjust_syslinux_bootoptions(src, flavour):
1186     """Adjust existing bootoptions of specified syslinux config to
1187     grml2usb specific ones, e.g. change the location of the kernel...
1188
1189     @src: config file to alter
1190     @flavour: grml flavour
1191     """
1192
1193     append_re = re.compile("^(\s*append.*/boot/.*)$", re.I)
1194     # flavour_re = re.compile("(label.*)(grml\w+)")
1195     default_re = re.compile("(default.cfg)")
1196     bootid_re = re.compile("bootid=[\w_-]+")
1197     live_media_path_re = re.compile("live-media-path=[\w_/-]+")
1198
1199     bootopt = get_bootoptions(flavour)
1200
1201     regexe = []
1202     option_re = None
1203     if options.removeoption:
1204         option_re = re.compile(r'/boot/.*/(initrd.gz|initrd.img)')
1205
1206         for regex in options.removeoption:
1207             regexe.append(re.compile(r'%s' % regex))
1208
1209     for line in fileinput.input(src, inplace=1):
1210         # line = flavour_re.sub(r'\1 %s-\2' % flavour, line)
1211         line = default_re.sub(r'%s-\1' % flavour, line)
1212         line = bootid_re.sub('', line)
1213         line = live_media_path_re.sub('', line)
1214         line = append_re.sub(r'\1 live-media-path=/live/%s/ ' % flavour, line)
1215         line = append_re.sub(r'\1 boot=live %s ' % bootopt, line)
1216         line = append_re.sub(r'\1 %s=%s ' % ("bootid", UUID), line)
1217         if option_re and option_re.search(line):
1218             for regex in regexe:
1219                 line = regex.sub(' ', line)
1220         sys.stdout.write(line)
1221     fileinput.close()
1222
1223 def adjust_labels(src, replacement):
1224     """Adjust the specified labels in the syslinux config file src with
1225     specified replacement
1226     """
1227     label_re = re.compile("^(\s*label\s*) ([a-zA-Z0-9_-]+)", re.I)
1228     for line in fileinput.input(src, inplace=1):
1229         line = label_re.sub(replacement, line)
1230         sys.stdout.write(line)
1231     fileinput.close()
1232
1233
1234 def add_syslinux_entry(filename, grml_flavour):
1235     """Add includes for a specific grml_flavour to the specified filename
1236
1237     @filename: syslinux config file
1238     @grml_flavour: grml flavour to add
1239     """
1240
1241     entry_filename = "option_%s.cfg" % grml_flavour
1242     entry = "include %s\n" % entry_filename
1243
1244     add_entry_if_not_present(filename, entry)
1245     path = os.path.dirname(filename)
1246
1247     data = open(path + "/" + entry_filename, "w")
1248     data.write(generate_flavour_specific_syslinux_config(grml_flavour))
1249     data.close()
1250
1251 def modify_filenames(grml_flavour, target, filenames):
1252     """Replace the standard filenames with the new ones
1253
1254     @grml_flavour: grml-flavour strin
1255     @target: directory where the files are located
1256     @filenames: list of filenames to alter
1257     """
1258     grml_filename = get_flavour_filename(grml_flavour)
1259     for filename in filenames:
1260         old_filename = "%s/%s" % (target, filename)
1261         new_filename = "%s/%s_%s" % (target, grml_filename, filename)
1262         os.rename(old_filename, new_filename)
1263
1264
1265 def remove_default_entry(filename):
1266     """Remove the default entry from specified syslinux file
1267
1268     @filename: syslinux config file
1269     """
1270     default_re = re.compile("^(\s*menu\s*default\s*)$", re.I)
1271     for line in fileinput.input(filename, inplace=1):
1272         if default_re.match(line):
1273             continue
1274         sys.stdout.write(line)
1275     fileinput.close()
1276
1277
1278 def handle_syslinux_config(grml_flavour, target):
1279     """Main handler for generating syslinux configuration
1280
1281     @grml_flavour: name of grml flavour the configuration should be generated for
1282     @target: path of syslinux's configuration files"""
1283
1284     logging.debug("Generating syslinux configuration")
1285     syslinux_target = target + '/boot/syslinux/'
1286     # should be present via  copy_bootloader_files(), but make sure it exits:
1287     execute(mkdir, syslinux_target)
1288     syslinux_cfg = syslinux_target + 'syslinux.cfg'
1289
1290
1291     # install main configuration only *once*, no matter how many ISOs we have:
1292     syslinux_config_file = open(syslinux_cfg, 'w')
1293     syslinux_config_file.write("TIMEOUT 300\n")
1294     syslinux_config_file.write("include vesamenu.cfg\n")
1295     syslinux_config_file.close()
1296
1297     prompt_name = open(syslinux_target + 'promptname.cfg', 'w')
1298     prompt_name.write('menu label S^yslinux prompt\n')
1299     prompt_name.close()
1300
1301     initial_syslinux_config(syslinux_target)
1302     flavour_filename = get_flavour_filename(grml_flavour)
1303
1304     if search_file('default.cfg', syslinux_target):
1305         modify_filenames(grml_flavour, syslinux_target, ['grml.cfg', 'default.cfg'])
1306
1307     filename = search_file("new_hidden.cfg", syslinux_target)
1308
1309
1310     # process hidden file
1311     if not search_file("hidden.cfg", syslinux_target):
1312         new_hidden = syslinux_target + "hidden.cfg"
1313         os.rename(filename, new_hidden)
1314         adjust_syslinux_bootoptions(new_hidden, grml_flavour)
1315     else:
1316         new_hidden_file =  "%s/%s_hidden.cfg" % (syslinux_target, flavour_filename)
1317         os.rename(filename, new_hidden_file)
1318         adjust_labels(new_hidden_file, r'\1 %s-\2' % grml_flavour)
1319         adjust_syslinux_bootoptions(new_hidden_file, grml_flavour)
1320         entry = 'include %s_hidden.cfg\n' % flavour_filename
1321         add_entry_if_not_present("%s/hiddens.cfg" % syslinux_target, entry)
1322
1323
1324
1325     new_default = "%s_default.cfg" % (flavour_filename)
1326     entry = 'include %s\n' % new_default
1327     defaults_file = '%s/defaults.cfg' % syslinux_target
1328     new_default_with_path = "%s/%s" % (syslinux_target, new_default)
1329     new_grml_cfg = "%s/%s_grml.cfg" % (syslinux_target, flavour_filename)
1330
1331     if os.path.isfile(defaults_file):
1332
1333         # remove default menu entry in menu
1334         remove_default_entry(new_default_with_path)
1335
1336         # adjust all labels for additional isos
1337         adjust_labels(new_default_with_path, r'\1 %s' % grml_flavour)
1338         adjust_labels(new_grml_cfg, r'\1 %s-\2' % grml_flavour)
1339
1340     # always adjust bootoptions
1341     adjust_syslinux_bootoptions(new_default_with_path, grml_flavour)
1342     adjust_syslinux_bootoptions(new_grml_cfg, grml_flavour)
1343
1344     add_entry_if_not_present("%s/defaults.cfg" % syslinux_target, entry)
1345
1346     add_syslinux_entry("%s/additional.cfg" % syslinux_target, flavour_filename)
1347
1348
1349 def handle_bootloader_config(grml_flavour, device, target):
1350     """Main handler for generating bootloader's configuration
1351
1352     @grml_flavour: name of grml flavour the configuration should be generated for
1353     @device: device/partition where bootloader should be installed to
1354     @target: path of bootloader's configuration files"""
1355
1356     global UUID
1357     UUID = get_uuid(target)
1358     if options.skipsyslinuxconfig:
1359         logging.info("Skipping generation of syslinux configuration as requested.")
1360     else:
1361         try:
1362             handle_syslinux_config(grml_flavour, target)
1363         except CriticalException, error:
1364             logging.critical("Fatal: %s", error)
1365             sys.exit(1)
1366
1367     if options.skipgrubconfig:
1368         logging.info("Skipping generation of grub configuration as requested.")
1369     else:
1370         try:
1371             handle_grub_config(grml_flavour, device, target)
1372         except CriticalException, error:
1373             logging.critical("Fatal: %s", error)
1374             sys.exit(1)
1375
1376
1377
1378 def install(image, device):
1379     """Install a grml image to the specified device
1380
1381     @image: directory or is file
1382     @device: partition or directory to install the device
1383     """
1384     iso_mountpoint = image
1385     remove_image_mountpoint = False
1386     if os.path.isdir(image):
1387         logging.info("Using %s as install base", image)
1388     else:
1389         logging.info("Using ISO %s", image)
1390         iso_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
1391         register_tmpfile(iso_mountpoint)
1392         remove_image_mountpoint = True
1393         try:
1394             mount(image, iso_mountpoint, ["-o", "loop,ro", "-t", "iso9660"])
1395         except CriticalException, error:
1396             logging.critical("Fatal: %s", error)
1397             sys.exit(1)
1398
1399     try:
1400         install_grml(iso_mountpoint, device)
1401     finally:
1402         if remove_image_mountpoint:
1403             try:
1404                 remove_mountpoint(iso_mountpoint)
1405             except CriticalException, error:
1406                 logging.critical("Fatal: %s", error)
1407                 cleanup()
1408
1409
1410
1411 def install_grml(mountpoint, device):
1412     """Main logic for copying files of the currently running grml system.
1413
1414     @mountpoin: directory where currently running live system resides (usually /live/image)
1415     @device: partition where the specified ISO should be installed to"""
1416
1417     device_mountpoint = device
1418     if os.path.isdir(device):
1419         logging.info("Specified device is not a directory, therefore not mounting.")
1420         remove_device_mountpoint = False
1421     else:
1422         device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
1423         register_tmpfile(device_mountpoint)
1424         remove_device_mountpoint = True
1425         try:
1426             check_for_fat(device)
1427             mount(device, device_mountpoint, ['-o', 'utf8,iocharset=iso8859-1'])
1428         except CriticalException, error:
1429             try:
1430                 mount(device, device_mountpoint, "")
1431             except CriticalException, error:
1432                 logging.critical("Fatal: %s", error)
1433                 raise
1434     try:
1435         grml_flavours = identify_grml_flavour(mountpoint)
1436         for flavour in set(grml_flavours):
1437             if not flavour:
1438                 logging.warning("No valid flavour found, please check your iso")
1439             logging.info("Identified grml flavour \"%s\".", flavour)
1440             install_iso_files(flavour, mountpoint, device, device_mountpoint)
1441             GRML_FLAVOURS.add(flavour)
1442     finally:
1443         if remove_device_mountpoint:
1444             remove_mountpoint(device_mountpoint)
1445
1446 def remove_mountpoint(mountpoint):
1447     """remove a registred mountpoint
1448     """
1449
1450     try:
1451         unmount(mountpoint, "")
1452         if os.path.isdir(mountpoint):
1453             os.rmdir(mountpoint)
1454             unregister_tmpfile(mountpoint)
1455     except CriticalException, error:
1456         logging.critical("Fatal: %s", error)
1457         cleanup()
1458
1459 def handle_mbr(device):
1460     """Main handler for installing master boot record (MBR)
1461
1462     @device: device where the MBR should be installed to"""
1463
1464     if options.dryrun:
1465         logging.info("Would install MBR")
1466         return 0
1467
1468     if device[-1:].isdigit():
1469         mbr_device = re.match(r'(.*?)\d*$', device).group(1)
1470         partition_number = int(device[-1:]) - 1
1471     else:
1472         logging.warn("Could not detect partition number, not activating partition")
1473         partition_number = None
1474
1475     # if we get e.g. /dev/loop1 as device we don't want to put the MBR
1476     # into /dev/loop of course, therefore use /dev/loop1 as mbr_device
1477     if mbr_device == "/dev/loop":
1478         mbr_device = device
1479         logging.info("Detected loop device - using %s as MBR device therefore", mbr_device)
1480
1481     mbrcode = GRML2USB_BASE + '/mbr/mbrldr'
1482     if options.syslinuxmbr:
1483         mbrcode = '/usr/lib/syslinux/mbr.bin'
1484     elif options.mbrmenu:
1485         mbrcode = GRML2USB_BASE + '/mbr/mbrldr'
1486
1487     try:
1488         install_mbr(mbrcode, mbr_device, partition_number, True)
1489     except IOError, error:
1490         logging.critical("Execution failed: %s", error)
1491         sys.exit(1)
1492     except Exception, error:
1493         logging.critical("Execution failed: %s", error)
1494         sys.exit(1)
1495
1496
1497 def handle_vfat(device):
1498     """Check for FAT specific settings and options
1499
1500     @device: device that should checked / formated"""
1501
1502     # make sure we have mkfs.vfat available
1503     if options.fat16:
1504         if not which("mkfs.vfat") and not options.copyonly and not options.dryrun:
1505             logging.critical('Sorry, mkfs.vfat not available. Exiting.')
1506             logging.critical('Please make sure to install dosfstools.')
1507             sys.exit(1)
1508
1509         if options.force:
1510             print "Forcing mkfs.fat16 on %s as requested via option --force." % device
1511         else:
1512             # make sure the user is aware of what he is doing
1513             f = raw_input("Are you sure you want to format the specified partition with fat16? y/N ")
1514             if f == "y" or f == "Y":
1515                 logging.info("Note: you can skip this question using the option --force")
1516             else:
1517                 sys.exit(1)
1518         try:
1519             mkfs_fat16(device)
1520         except CriticalException, error:
1521             logging.critical("Execution failed: %s", error)
1522             sys.exit(1)
1523
1524     # check for vfat filesystem
1525     if device is not None and not os.path.isdir(device) and options.syslinux:
1526         try:
1527             check_for_fat(device)
1528         except CriticalException, error:
1529             logging.critical("Execution failed: %s", error)
1530             sys.exit(1)
1531
1532     if not os.path.isdir(device) and not check_for_usbdevice(device) and not options.force:
1533         print "Warning: the specified device %s does not look like a removable usb device." % device
1534         f = raw_input("Do you really want to continue? y/N ")
1535         if f == "y" or f == "Y":
1536             pass
1537         else:
1538             sys.exit(1)
1539
1540
1541 def handle_compat_warning(device):
1542     """Backwards compatible checks
1543
1544     @device: device that should be checked"""
1545
1546     # make sure we can replace old grml2usb script and warn user when using old way of life:
1547     if device.startswith("/mnt/external") or device.startswith("/mnt/usb") and not options.force:
1548         print "Warning: the semantics of grml2usb has changed."
1549         print "Instead of using grml2usb /path/to/iso %s you might" % device
1550         print "want to use grml2usb /path/to/iso /dev/... instead."
1551         print "Please check out the grml2usb manpage for details."
1552         f = raw_input("Do you really want to continue? y/N ")
1553         if f == "y" or f == "Y":
1554             pass
1555         else:
1556             sys.exit(1)
1557
1558
1559 def handle_logging():
1560     """Log handling and configuration"""
1561
1562     if options.verbose and options.quiet:
1563         parser.error("please use either verbose (--verbose) or quiet (--quiet) option")
1564
1565     if options.verbose:
1566         FORMAT = "Debug: %(asctime)-15s %(message)s"
1567         logging.basicConfig(level=logging.DEBUG, format=FORMAT)
1568     elif options.quiet:
1569         FORMAT = "Critical: %(message)s"
1570         logging.basicConfig(level=logging.CRITICAL, format=FORMAT)
1571     else:
1572         FORMAT = "%(message)s"
1573         logging.basicConfig(level=logging.INFO, format=FORMAT)
1574
1575
1576 def handle_bootloader(device):
1577     """wrapper for installing bootloader
1578
1579     @device: device where bootloader should be installed to"""
1580
1581     # Install bootloader only if not using the --copy-only option
1582     if options.copyonly:
1583         logging.info("Not installing bootloader and its files as requested via option copyonly.")
1584     elif os.path.isdir(device):
1585         logging.info("Not installing bootloader as %s is a directory.", device)
1586     else:
1587         install_bootloader(device)
1588
1589
1590 def check_options(opts):
1591     """Check compability of provided user opts
1592
1593     @opts option dict from OptionParser
1594     """
1595     if opts.grubmbr and not opts.grub:
1596         logging.critical("Error: --grub-mbr requires --grub option.")
1597         sys.exit(1)
1598
1599
1600 def check_programs():
1601     """check if all needed programs are installed"""
1602     if options.grub:
1603         if not which("grub-install"):
1604             logging.critical("Fatal: grub-install not available (please install the "
1605                              + "grub package or drop the --grub option)")
1606             sys.exit(1)
1607
1608     if options.syslinux:
1609         if not which("syslinux"):
1610             logging.critical("Fatal: syslinux not available (please install the "
1611                              + "syslinux package or use the --grub option)")
1612             sys.exit(1)
1613
1614     if not which("rsync"):
1615         logging.critical("Fatal: rsync not available, can not continue - sorry.")
1616         sys.exit(1)
1617
1618 def load_loop():
1619     """Runs modprobe loop and throws away it's output"""
1620     proc = subprocess.Popen(["modprobe", "loop"], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
1621     proc.wait()
1622
1623 def main():
1624     """Main function [make pylint happy :)]"""
1625
1626     if options.version:
1627         print os.path.basename(sys.argv[0]) + " " + PROG_VERSION
1628         sys.exit(0)
1629
1630     if len(args) < 2:
1631         parser.error("invalid usage")
1632
1633     # log handling
1634     handle_logging()
1635
1636     # make sure we have the appropriate permissions
1637     check_uid_root()
1638
1639     check_options(options)
1640
1641     load_loop()
1642
1643     logging.info("Executing grml2usb version %s", PROG_VERSION)
1644
1645     if options.dryrun:
1646         logging.info("Running in simulation mode as requested via option dry-run.")
1647
1648     check_programs()
1649
1650     # specified arguments
1651     device = os.path.realpath(args[len(args) - 1])
1652     isos = args[0:len(args) - 1]
1653
1654     if not os.path.isdir(device):
1655         if device[-1:].isdigit():
1656             if int(device[-1:]) > 4 or device[-2:].isdigit():
1657                 logging.critical("Fatal: installation on partition number >4 not supported. (BIOS won't support it.)")
1658                 sys.exit(1)
1659
1660     # provide upgrade path
1661     handle_compat_warning(device)
1662
1663     # check for vfat partition
1664     handle_vfat(device)
1665
1666     # main operation (like installing files)
1667     for iso in isos:
1668         install(iso, device)
1669
1670     # install mbr
1671     is_superfloppy = not device[-1:].isdigit()
1672     if is_superfloppy:
1673         logging.info("Detected superfloppy format - not installing MBR")
1674
1675     if not options.skipmbr and not os.path.isdir(device) and not is_superfloppy:
1676         handle_mbr(device)
1677
1678     handle_bootloader(device)
1679
1680     logging.info("Note: grml flavour %s was installed as the default booting system.", GRML_DEFAULT)
1681
1682     for flavour in GRML_FLAVOURS:
1683         logging.info("Note: you can boot flavour %s using '%s' on the commandline.", flavour, flavour)
1684
1685     # finally be politely :)
1686     logging.info("Finished execution of grml2usb (%s). Have fun with your grml system.", PROG_VERSION)
1687
1688
1689 if __name__ == "__main__":
1690     try:
1691         main()
1692     except KeyboardInterrupt:
1693         logging.info("Received KeyboardInterrupt")
1694         cleanup()
1695
1696 ## END OF FILE #################################################################
1697 # vim:foldmethod=indent expandtab ai ft=python tw=120 fileencoding=utf-8