Update changelog for new release
[grml2usb.git] / grml2usb
index 032b7e9..06c3c9c 100755 (executable)
--- a/grml2usb
+++ b/grml2usb
@@ -18,7 +18,7 @@ from inspect import isroutine, isclass
 import datetime, logging, os, re, subprocess, sys, tempfile, time
 
 # global variables
-PROG_VERSION = "0.9.2"
+PROG_VERSION = "0.9.3"
 MOUNTED = set()  # register mountpoints
 TMPFILES = set() # register tmpfiles
 DATESTAMP = time.mktime(datetime.datetime.now().timetuple()) # unique identifier for syslinux.cfg
@@ -30,7 +30,7 @@ USAGE = "Usage: %prog [options] <[ISO[s] | /live/image]> </dev/sdX#>\n\
 Make sure you have at least one grml ISO or a running grml system (/live/image),\n\
 grub or syslinux and root access.\n\
 \n\
-Execute %prog --help for usage hints, further information can be found in: man grml2usb"
+Run %prog --help for usage hints, further information via: man grml2usb"
 
 # pylint: disable-msg=C0103
 parser = OptionParser(usage=USAGE)
@@ -53,8 +53,8 @@ parser.add_option("--force", dest="force", action="store_true",
 #                  help="install specified kernel instead of the default [TODO - not implemented yet]")
 parser.add_option("--lilo-binary", dest="lilobin",  action="store", type="string",
                   help="lilo executable to be used for installing MBR")
-parser.add_option("--mbr-manager", dest="mbrmgr", action="store_true",
-                  help="enable interactive boot manager menu in MBR")
+parser.add_option("--mbr-menu", dest="mbrmenu", action="store_true",
+                  help="enable interactive boot menu in MBR")
 parser.add_option("--quiet", dest="quiet", action="store_true",
                   help="do not output anything but just errors on console")
 parser.add_option("--skip-addons", dest="skipaddons", action="store_true",
@@ -262,7 +262,7 @@ fi
 
 menuentry "%(grml_flavour)s (default)" {
     set root=(hd0,%(install_partition)s)
-    linux   /boot/release/%(grml_flavour)s/linux26 apm=power-off lang=us vga=791 quiet boot=live nomce live-media-path=/live/%(grml_flavour)s/ %(bootoptions)s
+    linux   /boot/release/%(grml_flavour)s/linux26 apm=power-off vga=791 quiet boot=live nomce live-media-path=/live/%(grml_flavour)s/ %(bootoptions)s
     initrd  /boot/release/%(grml_flavour)s/initrd.gz
 }
 
@@ -346,7 +346,7 @@ menuentry "%(grml_flavour)s-nofb" {
 menuentry "%(grml_flavour)s-failsafe" {
     set root=(hd0,%(install_partition)s)
     linux /boot/release/%(grml_flavour)s/linux26
-    initrd /boot/release/%(grml_flavour)s/initrd.gz apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ vga=normal lang=us boot=live noautoconfig atapicd noacpi acpi=off nomodules nofirewire noudev nousb nohotplug noapm nopcmcia maxcpus=1 noscsi noagp nodma ide=nodma noswap nofstab nosound nogpm nosyslog nodhcp nocpu nodisc nomodem xmodule=vesa noraid nolvm %(bootoptions)s
+    initrd /boot/release/%(grml_flavour)s/initrd.gz apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ vga=normal boot=live 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 %(bootoptions)s
 }
 
 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
@@ -404,7 +404,7 @@ initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
 
 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
 title %(grml_flavour)s-failsafe
-kernel (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ vga=normal lang=us boot=live noautoconfig atapicd noacpi acpi=off nomodules nofirewire noudev nousb nohotplug noapm nopcmcia maxcpus=1 noscsi noagp nodma ide=nodma noswap nofstab nosound nogpm nosyslog nodhcp nocpu nodisc nomodem xmodule=vesa noraid nolvm %(bootoptions)s
+kernel (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ vga=normal boot=live 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 %(bootoptions)s
 initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
 
 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
@@ -439,7 +439,7 @@ background  = FFCC33
 
 # define entries:
 title %(grml_flavour)s  - Default boot (using 1024x768 framebuffer)
-kernel (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/linux26 apm=power-off lang=us vga=791 quiet boot=live nomce live-media-path=/live/%(grml_flavour)s/
+kernel (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/linux26 apm=power-off vga=791 quiet boot=live nomce live-media-path=/live/%(grml_flavour)s/ %(bootoptions)s
 initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
 
 title Memory test (memtest86+)
@@ -574,7 +574,7 @@ APPEND initrd=/boot/release/%(grml_flavour)s/initrd.gz apm=power-off boot=live n
 # flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
 LABEL  %(grml_flavour)s-failsafe
 KERNEL /boot/release/%(grml_flavour)s/linux26
-APPEND initrd=/boot/release/%(grml_flavour)s/initrd.gz apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ vga=normal lang=us boot=live noautoconfig atapicd noacpi acpi=off nomodules nofirewire noudev nousb nohotplug noapm nopcmcia maxcpus=1 noscsi noagp nodma ide=nodma noswap nofstab nosound nogpm nosyslog nodhcp nocpu nodisc nomodem xmodule=vesa noraid nolvm %(bootoptions)s
+APPEND initrd=/boot/release/%(grml_flavour)s/initrd.gz apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ vga=normal boot=live 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 %(bootoptions)s
 
 # flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
 LABEL  %(grml_flavour)s-forensic
@@ -597,7 +597,7 @@ def install_grub(device):
     if options.dryrun:
         logging.info("Would execute grub-install [--root-directory=mount_point] %s now.", device)
     else:
-        device_mountpoint = tempfile.mkdtemp()
+        device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
         register_tmpfile(device_mountpoint)
         try:
             mount(device, device_mountpoint, "")
@@ -703,21 +703,26 @@ def install_syslinux_mbr(device):
 def install_mir_mbr(mbrtemplate, device, partition, ismirbsdmbr=True):
     """install 'mbr' master boot record (MBR) on a device
 
-    Retrieve the partition table from "device", install an MBR from
-    the "mbrtemplate" file, set the "partition" (0..3) active, and
-    install the result back to "device".
+    Retrieve the partition table from "device", install an MBR from the
+    "mbrtemplate" file, set the "partition" (0..3) active, and install the
+    result back to "device".
 
     @mbrtemplate: default MBR file
 
-    @device: name of a file assumed to be a hard disc (or USB stick) image,
-    or something like "/dev/sdb"
+    @device: name of a file assumed to be a hard disc (or USB stick) image, or
+    something like "/dev/sdb"
+
     @partition: must be a number between 0 and 3, inclusive
 
-    @mbrtemplate: must be a valid MBR file of at least 440 (or 439
-    if ismirbsdmbr) bytes.
+    @mbrtemplate: must be a valid MBR file of at least 440 (or 439 if
+    ismirbsdmbr) bytes.
 
-    @ismirbsdmbr: if set the partitions' active flags are not changed.
-    Instead, the MBR's default value is set accordingly."""
+    @ismirbsdmbr: if true then ignore the active flag, set the mirbsdmbr
+    specific flag to 0/1/2/3 and set the MBR's default value accordingly. If
+    false then leave the mirbsdmbr specific flag set to FFh, set all
+    active flags to 0 and set the active flag of the partition to 80h.  Note:
+    behaviour of mirbsdmbr: if flag = 0/1/2/3 then use it, otherwise search for
+    the active flag."""
 
     logging.info("Installing default MBR")
 
@@ -889,13 +894,18 @@ def check_for_usbdevice(device):
     """
 
     usbdevice = re.match(r'/dev/(.*?)\d*$', device).group(1)
-    usbdevice = os.path.realpath('/sys/class/block/' + usbdevice + '/removable')
-    if os.path.isfile(usbdevice):
-        is_usb = open(usbdevice).readline()
-        if is_usb == "1":
+    # newer systems:
+    usbdev = os.path.realpath('/sys/class/block/' + usbdevice + '/removable')
+    if not os.path.isfile(usbdev):
+       # Ubuntu with kernel 2.6.24 for example:
+       usbdev = os.path.realpath('/sys/block/' + usbdevice + '/removable')
+
+    if os.path.isfile(usbdev):
+        is_usb = open(usbdev).readline()
+        if is_usb.find("1"):
             return 0
-        else:
-            return 1
+
+    return 1
 
 
 def check_for_fat(partition):
@@ -1031,8 +1041,7 @@ def copy_addons(iso_mount, target):
     # grub all-in-one image
     allinoneimg = search_file('allinone.img', iso_mount)
     if allinoneimg is None:
-        logging.warn("Warning: allinone.img not found - can not install it...")
-        logging.warn(" -> that's fine if you don't need it - or are you using grml-small?")
+        logging.warn("Warning: allinone.img not found (that's fine if you don't need it")
     else:
         logging.debug("cp %s %s" % (allinoneimg, addons + '/allinone.img'))
         proc = subprocess.Popen(["cp", allinoneimg, addons + 'allinone.img'])
@@ -1041,8 +1050,7 @@ def copy_addons(iso_mount, target):
     # bsd imag
     bsdimg = search_file('bsd4grml', iso_mount)
     if bsdimg is None:
-        logging.warn("Warning: bsd4grml not found - can not install it...")
-        logging.warn(" -> that's fine if you don't need it - or are you using grml-small?")
+        logging.warn("Warning: bsd4grml not found (that's fine if you don't need it")
     else:
         logging.debug("cp -a %s %s" % (bsdimg, addons + '/'))
         proc = subprocess.Popen(["cp", "-a", bsdimg, addons + '/'])
@@ -1051,8 +1059,7 @@ def copy_addons(iso_mount, target):
     # freedos image
     balderimg = search_file('balder10.imz', iso_mount)
     if balderimg is None:
-        logging.warn("Warning: balder10.imz not found - can not install it...")
-        logging.warn(" -> that's fine if you don't need it - or are you using grml-small?")
+        logging.warn("Warning: balder10.imz not found (that's fine if you don't need it")
     else:
         logging.debug("cp %s %s" % (balderimg, addons + '/balder10.imz'))
         proc = subprocess.Popen(["cp", balderimg, addons + 'balder10.imz'])
@@ -1061,8 +1068,7 @@ def copy_addons(iso_mount, target):
     # memdisk image
     memdiskimg = search_file('memdisk', iso_mount)
     if memdiskimg is None:
-        logging.warn("Warning: memdisk not found - can not install it...")
-        logging.warn(" -> that's fine if you don't need it - or are you using grml-small?")
+        logging.warn("Warning: memdisk not found (that's fine if you don't need it")
     else:
         logging.debug("cp %s %s" % (memdiskimg, addons + '/memdisk'))
         proc = subprocess.Popen(["cp", memdiskimg, addons + 'memdisk'])
@@ -1071,8 +1077,7 @@ def copy_addons(iso_mount, target):
     # memtest86+ image
     memtestimg = search_file('memtest', iso_mount)
     if memtestimg is None:
-        logging.warn("Warning: memtest not found - can not install it...")
-        logging.warn(" -> that's fine if you don't need it - or are you using grml-small?")
+        logging.warn("Warning: memtest not found (that's fine if you don't need it")
     else:
         logging.debug("cp %s %s" % (memtestimg, addons + '/memtest'))
         proc = subprocess.Popen(["cp", memtestimg, addons + 'memtest'])
@@ -1104,6 +1109,7 @@ def copy_bootloader_files(iso_mount, target):
 
     if not os.path.isfile("/usr/share/grml2usb/grub/splash.xpm.gz"):
         logging.critical("Error: /usr/share/grml2usb/grub/splash.xpm.gz can not be read.")
+        logging.critical("Please make sure you've the grml2usb Debian package installed!")
         raise
     else:
         logging.debug("cp /usr/share/grml2usb/grub/splash.xpm.gz %s" % grub_target + 'splash.xpm.gz')
@@ -1147,7 +1153,10 @@ def install_iso_files(grml_flavour, iso_mount, device, target):
         copy_grml_files(iso_mount, target)
 
     if not options.skipaddons:
-        copy_addons(iso_mount, target)
+        if grml_flavour.endswith('-small'):
+            logging.info("Note: grml-small doesn't provide any addons, not installing them therefor.")
+        else:
+            copy_addons(iso_mount, target)
 
     if not options.copyonly:
         copy_bootloader_files(iso_mount, target)
@@ -1230,7 +1239,7 @@ def handle_grub1_config(grml_flavour, install_partition, grub_target, bootopt):
     if grub_flavour_config:
         grub1_config_file = open(grub1_cfg, 'a')
         grub1_config_file.write(generate_flavour_specific_grub1_config(grml_flavour, install_partition, bootopt))
-        grub1_config_file.close( )
+        grub1_config_file.close()
 
 
 def handle_grub2_config(grml_flavour, install_partition, grub_target, bootopt):
@@ -1246,20 +1255,24 @@ def handle_grub2_config(grml_flavour, install_partition, grub_target, bootopt):
     logging.debug("Creating grub2 configuration file (grub.lst)")
 
     # install main configuration only *once*, no matter how many ISOs we have:
+    grub_flavour_is_default = False
     if os.path.isfile(grub2_cfg):
         string = open(grub2_cfg).readline()
         main_identifier = re.compile(".*main config generated at: %s.*" % re.escape(str(DATESTAMP)))
         if not re.match(main_identifier, string):
             grub2_config_file = open(grub2_cfg, 'w')
             logging.info("Note: grml flavour %s is being installed as the default booting system." % grml_flavour)
+            grub_flavour_is_default = True
             grub2_config_file.write(generate_main_grub2_config(grml_flavour, install_partition, bootopt))
             grub2_config_file.close()
     else:
         grub2_config_file = open(grub2_cfg, 'w')
         logging.info("Note: grml flavour %s is being installed as the default booting system." % grml_flavour)
+        grub_flavour_is_default = True
         grub2_config_file.write(generate_main_grub2_config(grml_flavour, install_partition, bootopt))
         grub2_config_file.close()
 
+    # install flavour specific configuration only *once* as well
     grub_flavour_config = True
     if os.path.isfile(grub2_cfg):
         string = open(grub2_cfg).readlines()
@@ -1270,9 +1283,11 @@ def handle_grub2_config(grml_flavour, install_partition, grub_target, bootopt):
 
     if grub_flavour_config:
         grub2_config_file = open(grub2_cfg, 'a')
-        logging.info("Note: you can boot flavour %s using '%s' on the commandline." % (grml_flavour, grml_flavour))
+        # display only if the grml flavour isn't the default
+        if not grub_flavour_is_default:
+            logging.info("Note: you can boot flavour %s using '%s' on the commandline." % (grml_flavour, grml_flavour))
         grub2_config_file.write(generate_flavour_specific_grub2_config(grml_flavour, install_partition, bootopt))
-        grub2_config_file.close( )
+        grub2_config_file.close()
 
 
 def handle_grub_config(grml_flavour, device, target):
@@ -1325,25 +1340,27 @@ def handle_syslinux_config(grml_flavour, target):
     syslinux_cfg = syslinux_target + 'syslinux.cfg'
 
     # install main configuration only *once*, no matter how many ISOs we have:
+    syslinux_flavour_is_default = False
     if os.path.isfile(syslinux_cfg):
         string = open(syslinux_cfg).readline()
         main_identifier = re.compile(".*main config generated at: %s.*" % re.escape(str(DATESTAMP)))
         if not re.match(main_identifier, string):
             syslinux_config_file = open(syslinux_cfg, 'w')
             logging.info("Note: grml flavour %s is being installed as the default booting system." % grml_flavour)
+            syslinux_flavour_is_default = True
             syslinux_config_file.write(generate_main_syslinux_config(grml_flavour, bootopt))
             syslinux_config_file.close()
     else:
         syslinux_config_file = open(syslinux_cfg, 'w')
+        logging.info("Note: grml flavour %s is being installed as the default booting system." % grml_flavour)
+        syslinux_flavour_is_default = True
         syslinux_config_file.write(generate_main_syslinux_config(grml_flavour, bootopt))
         syslinux_config_file.close()
 
     # install flavour specific configuration only *once* as well
-    # kind of ugly - I'm pretty sure this could be smoother...
     syslinux_flavour_config = True
     if os.path.isfile(syslinux_cfg):
         string = open(syslinux_cfg).readlines()
-        logging.info("Note: you can boot flavour %s using '%s' on the commandline." % (grml_flavour, grml_flavour))
         flavour = re.compile("grml2usb for %s: %s" % (re.escape(grml_flavour), re.escape(str(DATESTAMP))))
         for line in string:
             if flavour.match(line):
@@ -1351,13 +1368,16 @@ def handle_syslinux_config(grml_flavour, target):
 
     if syslinux_flavour_config:
         syslinux_config_file = open(syslinux_cfg, 'a')
+        # display only if the grml flavour isn't the default
+        if not syslinux_flavour_is_default:
+            logging.info("Note: you can boot flavour %s using '%s' on the commandline." % (grml_flavour, grml_flavour))
         syslinux_config_file.write(generate_flavour_specific_syslinux_config(grml_flavour, bootopt))
-        syslinux_config_file.close( )
+        syslinux_config_file.close()
 
     logging.debug("Generating isolinux/syslinux splash %s" % syslinux_target + 'boot.msg')
     isolinux_splash = open(syslinux_target + 'boot.msg', 'w')
     isolinux_splash.write(generate_isolinux_splash(grml_flavour))
-    isolinux_splash.close( )
+    isolinux_splash.close()
 
 
 def handle_bootloader_config(grml_flavour, device, target):
@@ -1389,7 +1409,7 @@ def handle_iso(iso, device):
         logging.critical("TODO: /live/image handling not yet implemented - sorry")
         sys.exit(1)
 
-    iso_mountpoint = tempfile.mkdtemp()
+    iso_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
     register_tmpfile(iso_mountpoint)
     remove_iso_mountpoint = True
 
@@ -1410,7 +1430,7 @@ def handle_iso(iso, device):
         remove_device_mountpoint = False
         # skip_mbr = True
     else:
-        device_mountpoint = tempfile.mkdtemp()
+        device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
         register_tmpfile(device_mountpoint)
         remove_device_mountpoint = True
         try:
@@ -1433,10 +1453,14 @@ def handle_iso(iso, device):
             os.rmdir(iso_mountpoint)
             unregister_tmpfile(iso_mountpoint)
         if remove_device_mountpoint:
-            unmount(device_mountpoint, "")
-            if os.path.isdir(device_mountpoint):
-                os.rmdir(device_mountpoint)
-                unregister_tmpfile(device_mountpoint)
+            try:
+                unmount(device_mountpoint, "")
+                if os.path.isdir(device_mountpoint):
+                    os.rmdir(device_mountpoint)
+                    unregister_tmpfile(device_mountpoint)
+            except CriticalException, error:
+                logging.critical("Fatal: %s" % error)
+                cleanup()
 
 
 def handle_mbr(device):
@@ -1464,10 +1488,10 @@ def handle_mbr(device):
             if options.syslinuxmbr:
                 handle_syslinux_mbr(mbr_device)
             else:
-                if options.mbrmgr:
+                if options.mbrmenu:
                     install_mir_mbr('/usr/share/grml2usb/mbr/mbrmgr', mbr_device, partition_number, True)
                 else:
-                    install_mir_mbr('/usr/share/grml2usb/mbr/mbrldr', mbr_device, partition_number, True)
+                    install_mir_mbr('/usr/share/grml2usb/mbr/mbrldr', mbr_device, partition_number, False)
         except IOError, error:
             logging.critical("Execution failed: %s", error)
             sys.exit(1)
@@ -1538,6 +1562,9 @@ def handle_compat_warning(device):
 def handle_logging():
     """Log handling and configuration"""
 
+    if options.verbose and options.quiet:
+        parser.error("please use either verbose (--verbose) or quiet (--quiet) option")
+
     if options.verbose:
         FORMAT = "Debug: %(asctime)-15s %(message)s"
         logging.basicConfig(level=logging.DEBUG, format=FORMAT)