Fix usage of --force in combination with --fat16
[grml2usb.git] / grml2usb
index 9a100dd..33d574c 100755 (executable)
--- a/grml2usb
+++ b/grml2usb
@@ -15,10 +15,10 @@ This script installs a grml system (either a running system or ISO[s]) to a USB
 # from __future__ import with_statement
 from optparse import OptionParser
 from inspect import isroutine, isclass
-import datetime, logging, os, re, subprocess, sys, tempfile, time
+import datetime, logging, os, re, subprocess, sys, tempfile, time, os.path
 
 # global variables
-PROG_VERSION = "0.9.9"
+PROG_VERSION = "0.9.10"
 MOUNTED = set()  # register mountpoints
 TMPFILES = set() # register tmpfiles
 DATESTAMP = time.mktime(datetime.datetime.now().timetuple()) # unique identifier for syslinux.cfg
@@ -81,6 +81,10 @@ parser.add_option("-v", "--version", dest="version", action="store_true",
                   help="display version and exit")
 (options, args) = parser.parse_args()
 
+GRML2USB_BASE = '/usr/share/grml2usb'
+if not os.path.isdir(GRML2USB_BASE):
+    GRML2USB_BASE = os.path.dirname(os.path.realpath(__file__))
+
 
 class CriticalException(Exception):
     """Throw critical exception if the exact error is not known but fatal."
@@ -245,7 +249,7 @@ def generate_main_grub2_config(grml_flavour, bootoptions):
     return("""\
 ## main grub2 configuration - generated by grml2usb [main config generated at: %(local_datestamp)s]
 set default=0
-set timeout=5
+set timeout=10
 
 insmod fat
 
@@ -276,21 +280,29 @@ menuentry "%(grml_flavour)s (default)" {
 }
 
 menuentry "Memory test (memtest86+)" {
-    linux   /boot/addons/memtest
+    linux16   /boot/addons/memtest
 }
 
-menuentry "Grub - all in one image" {
+menuentry "Boot Grub (all in one image)" {
     linux   /boot/addons/memdisk
     initrd  /boot/addons/allinone.img
 }
 
-menuentry "FreeDOS" {
+menuentry "Boot FreeDOS" {
     linux   /boot/addons/memdisk
     initrd  /boot/addons/balder10.imz
 }
 
-menuentry "MirOS BSD" {
-    multiboot   /boot/addons/bsd4grml/ldbsd.com
+menuentry "Boot MirOS bsd4grml" {
+    multiboot /boot/addons/bsd4grml/ldbsd.com
+    module    /boot/addons/bsd4grml/bsd.rd
+    module    /boot/addons/bsd4grml/boot.1
+    module    /boot/addons/bsd4grml/boot.2
+    module    /boot/addons/bsd4grml/boot.3
+    module    /boot/addons/bsd4grml/boot.4
+    module    /boot/addons/bsd4grml/boot.5
+    module    /boot/addons/bsd4grml/boot.6
+    module    /boot/addons/bsd4grml/boot.cfg
 }
 
 menuentry "Boot OS of first partition on first disk" {
@@ -312,65 +324,59 @@ def generate_flavour_specific_grub2_config(grml_flavour, bootoptions):
 
     return("""\
 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
-menuentry "%(grml_flavour)s" {
+menuentry "%(grml_flavour)s            - boot in default mode" {
     set gfxpayload=1024x768x16,1024x768
     linux  /boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ %(bootoptions)s
     initrd /boot/release/%(grml_flavour)s/initrd.gz
 }
 
 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
-menuentry "%(grml_flavour)s-persistent" {
+menuentry "%(grml_flavour)s-persistent - enable persistency feature" {
     set gfxpayload=1024x768x16,1024x768
     linux  /boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce quiet persistent live-media-path=/live/%(grml_flavour)s/ %(bootoptions)s
     initrd /boot/release/%(grml_flavour)s/initrd.gz
 }
 
 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
-menuentry "%(grml_flavour)s2ram" {
+menuentry "%(grml_flavour)s2ram        - copy compressed grml file to RAM" {
     set gfxpayload=1024x768x16,1024x768
     linux  /boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ toram=%(grml_flavour)s.squashfs %(bootoptions)s
     initrd /boot/release/%(grml_flavour)s/initrd.gz
 }
 
 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
-menuentry "%(grml_flavour)s-debug" {
+menuentry "%(grml_flavour)s-debug      - enable debugging options" {
     set gfxpayload=1024x768x16,1024x768
     linux /boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ debug boot=live initcall_debug%(bootoptions)s
     initrd /boot/release/%(grml_flavour)s/initrd.gz
 }
 
 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
-menuentry "%(grml_flavour)s-x" {
+menuentry "%(grml_flavour)s-x          - start X Window System" {
     set gfxpayload=1024x768x16,1024x768
     linux  /boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ startx=wm-ng %(bootoptions)s
     initrd /boot/release/%(grml_flavour)s/initrd.gz
 }
 
 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
-menuentry "%(grml_flavour)s-nofb" {
+menuentry "%(grml_flavour)s-nofb       - disable framebuffer" {
     linux  /boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ vga=normal video=ofonly %(bootoptions)s
     initrd /boot/release/%(grml_flavour)s/initrd.gz
 }
 
 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
-menuentry "%(grml_flavour)s-failsafe" {
-    linux /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
+menuentry "%(grml_flavour)s-failsafe   - disable hardware detection" {
+    linux /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 pci=nomsi %(bootoptions)s
     initrd /boot/release/%(grml_flavour)s/initrd.gz
 }
 
 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
-menuentry "%(grml_flavour)s-forensic" {
+menuentry "%(grml_flavour)s-forensic   - do not touch harddisks during hw recognition" {
     set gfxpayload=1024x768x16,1024x768
     linux /boot/release/%(grml_flavour)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 %(bootoptions)s
     initrd /boot/release/%(grml_flavour)s/initrd.gz
 }
 
-## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
-menuentry "%(grml_flavour)s-serial" {
-    linux /boot/release/%(grml_flavour)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 %(bootoptions)s
-    initrd /boot/release/%(grml_flavour)s/initrd.gz
-}
-
 """ % {'grml_flavour': grml_flavour, 'local_datestamp': local_datestamp,
        'bootoptions': bootoptions } )
 
@@ -417,7 +423,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 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
+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 pci=nomsi %(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]
@@ -597,7 +603,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 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
+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 pci=nomsi %(bootoptions)s
 
 # flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
 LABEL  %(grml_flavour)s-forensic
@@ -631,7 +637,7 @@ def install_grub(device):
                 proc.wait()
                 if proc.returncode != 0:
                     # raise Exception("error executing grub-install")
-                    logging.critical("Fatal: error executing grub-install (please check the grml2usb FAQ)")
+                    logging.critical("Fatal: error executing grub-install (please check the grml2usb FAQ or use --syslinux)")
                     cleanup()
                     sys.exit(1)
             except CriticalException, error:
@@ -835,9 +841,9 @@ def handle_syslinux_mbr(device):
         # otherwise fall back to our static version
         from platform import architecture
         if architecture()[0] == '64bit':
-            lilo = '/usr/share/grml2usb/lilo/lilo.static.amd64'
+            lilo = GRML2USB_BASE + '/lilo/lilo.static.amd64'
         else:
-            lilo = '/usr/share/grml2usb/lilo/lilo.static.i386'
+            lilo = GRML2USB_BASE + '/lilo/lilo.static.i386'
     # finally prefer a specified lilo executable
     if options.lilobin:
         lilo = options.lilobin
@@ -1160,20 +1166,20 @@ def copy_bootloader_files(iso_mount, target):
     grub_target = target + '/boot/grub/'
     execute(mkdir, grub_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.")
+    if not os.path.isfile(GRML2USB_BASE + "/grub/splash.xpm.gz"):
+        logging.critical("Error: %s/grub/splash.xpm.gz can not be read." % (GRML2USB_BASE, ))
         logging.critical("Please make sure you've the grml2usb Debian package installed!")
         raise
     else:
-        logging.debug("rsync -rlptDH --inplace /usr/share/grml2usb/grub/splash.xpm.gz %s" % grub_target + 'splash.xpm.gz')
-        proc = subprocess.Popen(["rsync", "-rlptDH", "--inplace", '/usr/share/grml2usb/grub/splash.xpm.gz',
+        logging.debug("rsync -rlptDH --inplace %s/grub/splash.xpm.gz %s%s" % (GRML2USB_BASE, grub_target, 'splash.xpm.gz'))
+        proc = subprocess.Popen(["rsync", "-rlptDH", "--inplace", GRML2USB_BASE + '/grub/splash.xpm.gz',
                                 grub_target + 'splash.xpm.gz'])
         proc.wait()
 
     # grml splash in grub
-    if os.path.isfile("/usr/share/grml2usb/grub/grml.png"):
-        logging.debug("rsync -rlptDH --inplace /usr/share/grml2usb/grub/grml.png to %s" % grub_target + 'grml.png')
-        proc = subprocess.Popen(["rsync", "-rlptDH", "--inplace", '/usr/share/grml2usb/grub/grml.png',
+    if os.path.isfile(GRML2USB_BASE + "/grub/grml.png"):
+        logging.debug("rsync -rlptDH --inplace %s/grub/grml.png to %s%s" % (GRML2USB_BASE, grub_target, 'grml.png'))
+        proc = subprocess.Popen(["rsync", "-rlptDH", "--inplace", GRML2USB_BASE + '/grub/grml.png',
                                 grub_target + 'grml.png'])
         proc.wait()
 
@@ -1298,6 +1304,14 @@ def handle_grub1_config(grml_flavour, install_partition, grub_target, bootopt):
         grub1_config_file.write(generate_flavour_specific_grub1_config(grml_flavour, install_partition, bootopt))
         grub1_config_file.close()
 
+    # make sure grub.conf isn't a symlink but a plain file instead,
+    # otherwise it will break on FAT16 filesystems
+    # this works around grub-install of (at least) Fedora 10
+    if os.path.isfile(grub1_cfg):
+        grubconf = grub_target + 'grub.conf'
+        if not os.path.islink(grubconf):
+            import shutil
+            shutil.copyfile(grub1_cfg, grub_target + 'grub.conf')
 
 def handle_grub2_config(grml_flavour, grub_target, bootopt):
     """Main handler for generating grub2 configuration
@@ -1375,8 +1389,7 @@ def handle_grub_config(grml_flavour, device, target):
         bootopt = options.bootoptions
 
     # write menu.lst
-    if install_grub1_partition:
-        handle_grub1_config(grml_flavour, install_grub1_partition, grub_target, bootopt)
+    handle_grub1_config(grml_flavour, install_grub1_partition, grub_target, bootopt)
     # write grub.cfg
     handle_grub2_config(grml_flavour, grub_target, bootopt)
 
@@ -1599,9 +1612,9 @@ def handle_mbr(device):
             handle_syslinux_mbr(mbr_device)
         elif not skip_install_mir_mbr:
             if options.mbrmenu:
-                install_mir_mbr('/usr/share/grml2usb/mbr/mbrmgr', mbr_device, partition_number, True)
+                install_mir_mbr(GRML2USB_BASE + '/mbr/mbrmgr', mbr_device, partition_number, True)
             else:
-                install_mir_mbr('/usr/share/grml2usb/mbr/mbrldr', mbr_device, partition_number, False)
+                install_mir_mbr(GRML2USB_BASE + '/mbr/mbrldr', mbr_device, partition_number, False)
     except IOError, error:
         logging.critical("Execution failed: %s", error)
         sys.exit(1)
@@ -1616,16 +1629,24 @@ def handle_vfat(device):
     @device: device that should checked / formated"""
 
     # make sure we have mkfs.vfat available
-    if options.fat16 and not options.force:
+    if options.fat16:
         if not which("mkfs.vfat") and not options.copyonly and not options.dryrun:
             logging.critical('Sorry, mkfs.vfat not available. Exiting.')
             logging.critical('Please make sure to install dosfstools.')
             sys.exit(1)
 
-        # make sure the user is aware of what he is doing
-        f = raw_input("Are you sure you want to format the specified partition with fat16? y/N ")
-        if f == "y" or f == "Y":
-            logging.info("Note: you can skip this question using the option --force")
+        exec_mkfs = False
+        if options.force:
+            print "Forcing mkfs.fat16 on %s as requested via option --force." % device
+            exec_mkfs = True
+        else:
+            # make sure the user is aware of what he is doing
+            f = raw_input("Are you sure you want to format the specified partition with fat16? y/N ")
+            if f == "y" or f == "Y":
+                logging.info("Note: you can skip this question using the option --force")
+                exec_mkfs = True
+
+        if exec_mkfs:
             try:
                 mkfs_fat16(device)
             except CriticalException, error: