Update script
[grml2usb.git] / grml2usb.py
index 2efedc3..8097a83 100755 (executable)
@@ -6,13 +6,23 @@
 # License:       This file is licensed under the GPL v2 or any later version.
 ################################################################################
 
 # License:       This file is licensed under the GPL v2 or any later version.
 ################################################################################
 
+# TODO:
+# * write error messages to stderr
+# * log wrapper (log important messages to syslog, depending on loglevel)
+# * trap handling (umount devices when interrupting?)
+
 prog_version = "0.0.1"
 
 prog_version = "0.0.1"
 
-import os, sys
+import os, re, subprocess, sys
 from optparse import OptionParser
 
 # cmdline parsing {{{
 from optparse import OptionParser
 
 # cmdline parsing {{{
-usage = "usage: %prog [options] arg1 arg2"
+usage = "Usage: %prog [options] <ISO[s]> <partition>\n\
+\n\
+%prog installs a grml ISO to an USB device to be able to boot from it.\n\
+Make sure you have at least a grml ISO or a running grml system,\n\
+syslinux (just run 'aptitude install syslinux' on Debian-based systems)\n\
+and root access."
 parser = OptionParser(usage=usage)
 
 parser.add_option("--bootoptions", dest="bootoptions", action="store", type="string",
 parser = OptionParser(usage=usage)
 
 parser.add_option("--bootoptions", dest="bootoptions", action="store", type="string",
@@ -33,6 +43,8 @@ parser.add_option("--mbr", dest="mbr", action="store_true",
                   help="install master boot record (MBR) on the device")
 parser.add_option("--squashfs", dest="squashfs", action="store", type="string",
                   help="install specified squashfs file instead of the default")
                   help="install master boot record (MBR) on the device")
 parser.add_option("--squashfs", dest="squashfs", action="store", type="string",
                   help="install specified squashfs file instead of the default")
+parser.add_option("--uninstall", dest="uninstall", action="store_true",
+                  help="remove grml ISO files")
 parser.add_option("--verbose", dest="verbose", action="store_true",
                   help="enable verbose mode")
 parser.add_option("-v", "--version", dest="version", action="store_true",
 parser.add_option("--verbose", dest="verbose", action="store_true",
                   help="enable verbose mode")
 parser.add_option("-v", "--version", dest="version", action="store_true",
@@ -41,7 +53,8 @@ parser.add_option("-v", "--version", dest="version", action="store_true",
 (options, args) = parser.parse_args()
 # }}}
 
 (options, args) = parser.parse_args()
 # }}}
 
-# FIXME: implement argument handling
+# wrapper functions {{{
+# TODO: implement argument handling
 def execute(command):
     """Wrapper for executing a command. Either really executes
     the command (default) or when using --dry-run commandline option
 def execute(command):
     """Wrapper for executing a command. Either really executes
     the command (default) or when using --dry-run commandline option
@@ -51,25 +64,92 @@ def execute(command):
     else:
         print "executing %s" % command
 
     else:
         print "executing %s" % command
 
+def which(program):
+    def is_exe(fpath):
+        return os.path.exists(fpath) and os.access(fpath, os.X_OK)
+
+    fpath, fname = os.path.split(program)
+    if fpath:
+        if is_exe(program):
+            return program
+    else:
+        for path in os.environ["PATH"].split(os.pathsep):
+            exe_file = os.path.join(path, program)
+            if is_exe(exe_file):
+                return exe_file
+
+    return None
+# }}}
+
+
+def check_uid_root():
+    """Check for root permissions"""
+    if not os.geteuid()==0:
+        sys.exit("Error: please run this script with uid 0 (root).")
+
+
 def install_syslinux(device):
     """Install syslinux on specified device."""
     print("syslinux %s") % device
 
 def install_syslinux(device):
     """Install syslinux on specified device."""
     print("syslinux %s") % device
 
+
 def install_grub(device):
     """Install grub on specified device."""
     print("grub-install %s") % device
 
 def install_grub(device):
     """Install grub on specified device."""
     print("grub-install %s") % device
 
-def install_bootloader(device):
-    """Install bootloader on specified device."""
+
+def install_bootloader(partition):
+    """Install bootloader on device."""
+    # Install bootloader on the device (/dev/sda), not on the partition itself (/dev/sda1)
+    if partition[-1:].isdigit():
+        device = re.match(r'(.*?)\d*$', partition).group(1)
+    else:
+        device = partition
+
     if options.grub:
         install_grub(device)
     else:
         install_syslinux(device)
 
     if options.grub:
         install_grub(device)
     else:
         install_syslinux(device)
 
-def check_uid_root():
-    """Check for root permissions"""
-    if not os.geteuid()==0:
-        sys.exit("Error: please run this script with uid 0 (root).")
+
+def install_mbr(target):
+    """Install a default master boot record on given target"""
+    print("TODO")
+
+
+def loopback_mount(iso, target):
+    """Loopback mount specified ISO on given target"""
+    print("mount -o loop %s %s") % (iso, target)
+
+
+def check_for_vat(partition):
+    """Check whether specified partition is VFAT/FAT16 filesystem"""
+    try:
+        udev_info = subprocess.Popen(["/lib/udev/vol_id", "-t",
+            partition],stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+        filesystem = udev_info.communicate()[0].rstrip()
+
+        if udev_info.returncode == 2:
+            print("failed to read device %s - wrong UID / permissions?") % partition
+            return 1
+
+        if filesystem != "vfat":
+            return(1)
+
+        # TODO: check for ID_FS_VERSION=FAT16?
+
+    except OSError:
+        print("Sorry, /lib/udev/vol_id not available.")
+        return 1
+
+def copy_grml_files(target):
+    """Copy files from ISO on given target"""
+    print("TODO")
+
+
+def uninstall_files(device):
+    print("TODO")
+
 
 def main():
     if options.version:
 
 def main():
     if options.version:
@@ -84,12 +164,27 @@ def main():
     device = args[len(args) - 1]
     isos = args[0:len(args) - 1]
 
     device = args[len(args) - 1]
     isos = args[0:len(args) - 1]
 
-    # FIXME: check for valid blockdevice
-    if device is not None:
-        install_bootloader(device)
-
+    if not which("syslinux2"):
+        print("Sorry, syslinux not available. Exiting.")
+        print("Please install syslinux or consider using the --grub option.")
+        sys.exit(1)
+    
+    # TODO check for valid blockdevice, vfat and mount functions
+    # if device is not None:
+        # check_for_vat(device)
+        # mount_target(partition)
+
+    # TODO it doesn't need to be a ISO, could be /live/image as well!
     for iso in isos:
         print("iso = %s") % iso
     for iso in isos:
         print("iso = %s") % iso
+        # loopback_mount(iso)
+        # copy_grml_files(iso, target)
+        # loopback_unmount(iso)
+
+    if options.mbr:
+        print("would install MBR now")
+
+    install_bootloader(device)
 
 if __name__ == "__main__":
     main()
 
 if __name__ == "__main__":
     main()