grml2usb
~~~~~~~~
-This script installs a grml system (either a running system or ISO[s]) to a USB device
+This script installs a Grml system (either a running system or ISO[s]) to a USB device
:copyright: (c) 2009, 2010, 2011 by Michael Prokop <mika@grml.org>
:license: GPL v2 or any later version
"""
+from __future__ import print_function
from optparse import OptionParser
from inspect import isroutine, isclass
-import datetime, logging, os, re, subprocess, sys, tempfile, time, os.path
+import datetime
import fileinput
import glob
-import uuid
+import logging
+import os
+import os.path
+import re
import struct
+import subprocess
+import sys
+import tempfile
+import time
+import uuid
+import shutil
# The line following this line is patched by debian/rules and tarball.sh.
-PROG_VERSION='***UNRELEASED***'
+PROG_VERSION = '***UNRELEASED***'
# global variables
-MOUNTED = set() # register mountpoints
-TMPFILES = set() # register tmpfiles
-DATESTAMP = time.mktime(datetime.datetime.now().timetuple()) # unique identifier for syslinux.cfg
-GRML_FLAVOURS = set() # which flavours are being installed?
+MOUNTED = set() # register mountpoints
+TMPFILES = set() # register tmpfiles
+DATESTAMP = time.mktime(datetime.datetime.now().timetuple()) # unique identifier for syslinux.cfg
+GRML_FLAVOURS = set() # which flavours are being installed?
GRML_DEFAULT = None
UUID = None
SYSLINUX_LIBS = "/usr/lib/syslinux/"
+GPT_HEADER = "\x55\xaa\x45\x46\x49\x20\x50\x41\x52\x54" # original GPT header
+GRUB_INSTALL = None
+
+RE_PARTITION = re.compile(r'([a-z/]*?)(\d+)$')
+RE_P_PARTITION = re.compile(r'(.*?\d+)p(\d+)$')
+RE_LOOP_DEVICE = re.compile(r'/dev/loop\d+$')
+
def syslinux_warning(option, opt, value, opt_parser):
"""A helper function for printing a warning about deprecated option
"is grml2usb's default. Continuing anyway.\n")
setattr(opt_parser.values, option.dest, True)
+
# if grub option is set, unset syslinux option
def grub_option(option, opt, value, opt_parser):
"""A helper function adjusting other option values
setattr(opt_parser.values, 'syslinux', False)
# cmdline parsing
-USAGE = "Usage: %prog [options] <[ISO[s] | /live/image]> </dev/sdX#>\n\
+USAGE = "Usage: %prog [options] <[ISO[s] | /lib/live/mount/medium]> </dev/sdX#>\n\
\n\
-%prog installs grml ISO[s] to an USB device to be able to boot from it.\n\
-Make sure you have at least one grml ISO or a running grml system (/live/image),\n\
+%prog installs Grml ISO[s] to an USB device to be able to boot from it.\n\
+Make sure you have at least one Grml ISO or a running Grml system (/lib/live/mount/medium),\n\
grub or syslinux and root access.\n\
\n\
Run %prog --help for usage hints, further information via: man grml2usb"
help="install syslinux bootloader (deprecated as it's the default)")
parser.add_option("--syslinux-mbr", dest="syslinuxmbr", action="store_true",
help="install syslinux master boot record (MBR) instead of default")
+parser.add_option("--tmpdir", dest="tmpdir", default="/tmp",
+ help="directory to be used for temporary files")
parser.add_option("--verbose", dest="verbose", action="store_true",
help="enable verbose mode")
parser.add_option("-v", "--version", dest="version", action="store_true",
class CriticalException(Exception):
- """Throw critical exception if the exact error is not known but fatal."
+ """Throw critical exception if the exact error is not known but fatal.
+
+ @Exception: message"""
+ pass
+
+
+class VerifyException(Exception):
+ """Throw critical exception if there is an fatal error when verifying something.
@Exception: message"""
pass
def cleanup():
"""Cleanup function to make sure there aren't any mounted devices left behind.
"""
+ def del_failed(fn, filepath, exc):
+ msg = "Deletion of %s failed in temporary folder %s"
+ logging.warn(msg % (filepath, path))
logging.info("Cleaning up before exiting...")
proc = subprocess.Popen(["sync"])
proc.wait()
- try:
- for device in MOUNTED:
+ for device in MOUNTED.copy():
+ try:
unmount(device, "")
- for tmpfile in TMPFILES:
- os.unlink(tmpfile)
- # ignore: RuntimeError: Set changed size during iteration
- except RuntimeError:
- logging.debug('caught expection RuntimeError, ignoring')
+ logging.debug('Unmounted %s' % device)
+ except StandardError:
+ logging.debug('RuntimeError while umount %s, ignoring' % device)
+
+ for tmppath in TMPFILES.copy():
+ try:
+ if os.path.isdir(tmppath) and not os.path.islink(tmppath):
+ # symbolic links to directories are ignored
+ # without the check it will throw an OSError
+ shutil.rmtree(tmppath, onerror=del_failed)
+ logging.debug('temporary directory %s deleted' % tmppath)
+ unregister_tmpfile(tmppath)
+ elif os.path.isfile:
+ os.unlink(tmppath)
+ logging.debug('temporary file %s deleted' % tmppath)
+ unregister_tmpfile(tmppath)
+ except StandardError:
+ msg = 'RuntimeError while removing temporary %s, ignoring'
+ logging.debug(msg % tmppath)
def register_tmpfile(path):
"%s_%s" % (get_flavour_filename(flavour), name):
if os.path.isfile(iso_mount + directory + name):
return (directory, name)
- return ('','')
+ return ('', '')
-def search_file(filename, search_path='/bin' + os.pathsep + '/usr/bin'):
+
+def search_file(filename, search_path='/bin' + os.pathsep + '/usr/bin', lst_return=False):
"""Given a search path, find file
@filename: name of file to search for
- @search_path: path where searching for the specified filename"""
- file_found = 0
+ @search_path: path where searching for the specified filename
+ @lst_return: return list of matching files instead one file"""
paths = search_path.split(os.pathsep)
- current_dir = '' # make pylint happy :)
+ current_dir = '' # make pylint happy :)
+ retval = []
def match_file(cwd):
"""Helper function ffor testing if specified file exists in cwd
@cwd: current working directory
"""
- return os.path.exists(os.path.join(cwd, filename))
+ return os.path.exists(os.path.join(cwd, filename))
for path in paths:
current_dir = path
if match_file(current_dir):
- file_found = 1
- break
+ retval.append(os.path.abspath(os.path.join(current_dir, filename)))
+ if not lst_return:
+ break
# pylint: disable-msg=W0612
for current_dir, directories, files in os.walk(path):
if match_file(current_dir):
- file_found = 1
- break
- if file_found:
- return os.path.abspath(os.path.join(current_dir, filename))
+ retval.append(os.path.abspath(os.path.join(current_dir, filename)))
+ if not lst_return:
+ break
+ if lst_return:
+ return retval
+ elif retval:
+ return retval[0]
else:
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).")
+ if not os.geteuid() == 0:
+ raise CriticalException("please run this script with uid 0 (root).")
+
+
+def check_boot_flag(device):
+ boot_dev, x = get_device_from_partition(device)
+
+ with open(boot_dev, 'r') as image:
+ data = image.read(520)
+ bootcode = data[440:]
+ gpt_data = bootcode[70:80]
+
+ if gpt_data == GPT_HEADER:
+ logging.info("GPT detected, skipping bootflag check")
+ elif bootcode[6] == '\x80':
+ logging.debug("bootflag is enabled")
+ else:
+ logging.debug("bootflag is NOT enabled")
+ raise VerifyException("Device %s does not have the bootflag set. "
+ "Please enable it to be able to boot." % boot_dev)
def mkfs_fat16(device):
Some information and boot options available via keys F2 - F10. http://grml.org/
%(grml_name)s
-""" % {'grml_name': grml_name} )
+""" % {'grml_name': grml_name})
def generate_main_syslinux_config(*arg):
@grml_flavour: name of grml flavour the configuration should be generated for"""
-
return("""\
menu begin grml %(grml_flavour)s
menu title %(display_name)s
include %(grml_flavour)s_grml.cfg
menu hide
menu end
-""" % {'grml_flavour': grml_flavour, 'display_name' : grml_flavour.replace('_', '-') } )
+""" % {'grml_flavour': grml_flavour, 'display_name': get_flavour_filename(grml_flavour)})
def install_grub(device):
# If using --grub-mbr then make sure we install grub in MBR instead of PBR
if options.grubmbr:
logging.debug("Using option --grub-mbr ...")
- if device[-1:].isdigit():
- grub_device = re.match(r'(.*?)\d*$', device).group(1)
- else:
- grub_device = device
+ grub_device, x = get_device_from_partition(device)
else:
grub_device = device
logging.info("Installing grub as bootloader")
- for opt in ["", "--force" ]:
+ for opt in ["", "--force"]:
logging.debug("grub-install --recheck %s --no-floppy --root-directory=%s %s",
opt, device_mountpoint, grub_device)
- proc = subprocess.Popen(["grub-install", "--recheck", opt, "--no-floppy",
+ proc = subprocess.Popen([GRUB_INSTALL, "--recheck", opt, "--no-floppy",
"--root-directory=%s" % device_mountpoint, grub_device],
stdout=file(os.devnull, "r+"))
proc.wait()
+ "the --grub-mbr option as grub considers PBR problematic.")
cleanup()
sys.exit(1)
- except CriticalException, error:
+ except CriticalException as error:
logging.critical("Fatal: %s", error)
cleanup()
sys.exit(1)
if options.grub:
try:
install_grub(device)
- except CriticalException, error:
+ except CriticalException as error:
logging.critical("Fatal: %s", error)
cleanup()
sys.exit(1)
else:
try:
install_syslinux(device)
- except CriticalException, error:
+ except CriticalException as error:
logging.critical("Fatal: %s", error)
cleanup()
sys.exit(1)
logging.info("Installing default MBR")
if not os.path.isfile(mbrtemplate):
- logging.critical("Error: %s can not be read.", mbrtemplate)
- raise CriticalException("Error installing MBR (either try --syslinux-mbr or install missing file \"%s\"?)" % mbrtemplate)
+ logging.error('Error installing MBR (either try --syslinux-mbr or '
+ 'install missing file "%s"?)', mbrtemplate)
+ raise CriticalException("%s can not be read." % mbrtemplate)
if partition is not None and ((partition < 0) or (partition > 3)):
- logging.warn("Cannot activate partition %d" % partition)
+ logging.warn("Cannot activate partition %d", partition)
partition = None
if ismirbsdmbr:
mbrcode[463:478] + actives[2] + \
mbrcode[479:494] + actives[3] + \
mbrcode[495:510] + "\x55\xAA"
-
+
tmpf.file.seek(0)
tmpf.file.truncate()
tmpf.file.write(mbrcode)
return write_uuid(uuid_file_name)
+def get_shortname(grml_flavour):
+ """Get shortname based from grml_flavour name. The rules applied are the same as in grml-live
+ @grml_flavour: flavour name which shold be translated to shortname"""
+
+ return re.sub(r'[,._-]', '', grml_flavour)
+
+
def copy_system_files(grml_flavour, iso_mount, target):
"""copy grml's main files (like squashfs, kernel and initrd) to a given target
squashfs = search_file(grml_flavour + '.squashfs', iso_mount)
if squashfs is None:
- logging.critical("Fatal: squashfs file not found"
- ", please check that your iso is not corrupt")
- raise CriticalException("error locating squashfs file")
+ logging.error("error locating squashfs file")
+ raise CriticalException("squashfs file not found, please check that your iso is not corrupt")
else:
squashfs_target = target + '/live/' + grml_flavour + '/'
execute(mkdir, squashfs_target)
if filesystem_module:
break
if filesystem_module is None:
- logging.critical("Fatal: filesystem.module not found")
- raise CriticalException("error locating filesystem.module file")
+ logging.error("error locating filesystem.module file")
+ raise CriticalException("filesystem.module not found")
else:
exec_rsync(filesystem_module, squashfs_target + 'filesystem.module')
- kernel = search_file('vmlinuz', iso_mount)
- if kernel is None:
- # compat for releases < 2011.12
- kernel = search_file('linux26', iso_mount)
+ shortname = get_shortname(grml_flavour)
+ if os.path.isdir(iso_mount + '/boot/' + shortname):
+ exec_rsync(iso_mount + '/boot/' + shortname, target + '/boot')
+ else:
+ kernel = search_file('vmlinuz', iso_mount)
+ if kernel is None:
+ # compat for releases < 2011.12
+ kernel = search_file('linux26', iso_mount)
- if kernel is None:
- logging.critical("Fatal: kernel not found")
- raise CriticalException("error locating kernel file")
+ if kernel is None:
+ logging.error("error locating kernel file")
+ raise CriticalException("Kernel not found")
- source = os.path.dirname(kernel) + '/'
- dest = target + '/' + os.path.dirname(kernel).replace(iso_mount,'') + '/'
- execute(mkdir, dest)
- exec_rsync(source, dest)
+ source = os.path.dirname(kernel) + '/'
+ dest = target + '/' + os.path.dirname(kernel).replace(iso_mount, '') + '/'
+ execute(mkdir, dest)
+ exec_rsync(source, dest)
def update_grml_versions(iso_mount, target):
for line in fileinput.input([target_grml_version_file], inplace=1):
flavour = get_flavour(line)
if flavour in iso_versions.keys():
- print iso_versions.pop(flavour)
+ print(iso_versions.pop(flavour))
else:
- print line.strip()
+ print(line.strip())
fileinput.close()
target_file = open(target_grml_version_file, 'a')
else:
return False
-def copy_grml_files(iso_mount, target):
+
+def copy_grml_files(grml_flavour, iso_mount, target):
"""copy some minor grml files to a given target
+ @grml_flavour: the current grml_flavour
@iso_mount: path where a grml ISO is mounted on
@target: path where grml's main files should be copied to"""
grml_target = target + '/grml/'
execute(mkdir, grml_target)
- copy_files = [ 'grml-cheatcodes.txt', 'LICENSE.txt', 'md5sums', 'README.txt' ]
- # handle grml-version
- if not update_grml_versions(iso_mount, target):
- copy_files.append('grml-version')
-
- for myfile in copy_files:
- grml_file = search_file(myfile, iso_mount)
- if grml_file is None:
- logging.warn("Warning: file %s could not be found - can not install it", myfile)
- else:
- exec_rsync(grml_file, grml_target + myfile)
-
- grml_web_target = grml_target + '/web/'
- execute(mkdir, grml_web_target)
-
- for myfile in 'index.html', 'style.css':
- grml_file = search_file(myfile, iso_mount)
- if grml_file is None:
- logging.warn("Warning: file %s could not be found - can not install it", myfile)
- else:
- exec_rsync(grml_file, grml_web_target + myfile)
-
- grml_webimg_target = grml_web_target + '/images/'
- execute(mkdir, grml_webimg_target)
-
- for myfile in 'button.png', 'favicon.png', 'linux.jpg', 'logo.png':
- grml_file = search_file(myfile, iso_mount)
- if grml_file is None:
- logging.warn("Warning: file %s could not be found - can not install it", myfile)
- else:
- exec_rsync(grml_file, grml_webimg_target + myfile)
+ grml_prefixe = ["GRML", "grml"]
+ for prefix in grml_prefixe:
+ filename = "{0}/{1}/{2}".format(iso_mount, prefix, grml_flavour)
+ if os.path.exists(filename):
+ exec_rsync(filename, grml_target)
+ break
+ else:
+ logging.warn("Warning: could not find flavour directory for %s ", grml_flavour)
def handle_addon_copy(filename, dst, iso_mount, ignore_errors=False):
file_location = search_file(filename, iso_mount)
if file_location is None:
if not ignore_errors:
- logging.warn("Warning: %s not found (that's fine if you don't need it)", filename)
+ logging.warn("Warning: %s not found (that's fine if you don't need it)", filename)
else:
exec_rsync(file_location, dst)
# grub all-in-one image
handle_addon_copy('allinone.img', addons, iso_mount)
- # bsd imag
+ # bsd image
handle_addon_copy('bsd4grml', addons, iso_mount)
+ # DOS image
handle_addon_copy('balder10.imz', addons, iso_mount)
- # install hdt and pci.ids only when using syslinux (grub doesn't support it)
- if options.syslinux:
- # hdt (hardware detection tool) image
- hdtimg = search_file('hdt.c32', iso_mount)
- if hdtimg:
- exec_rsync(hdtimg, addons + '/hdt.c32')
-
- # pci.ids file
- picids = search_file('pci.ids', iso_mount)
- if picids:
- exec_rsync(picids, addons + '/pci.ids')
+ # syslinux + pci.ids for hdt
+ for expr in '*.c32', 'pci.ids':
+ glob_and_copy(iso_mount + '/boot/addons/' + expr, addons)
# memdisk image
handle_addon_copy('memdisk', addons, iso_mount)
# ipxe.lkrn
handle_addon_copy('ipxe.lkrn', addons, iso_mount)
+
+def build_loopbackcfg(target):
+ """Generate GRUB's loopback.cfg based on existing config files.
+
+ @target: target directory
+ """
+
+ grub_dir = '/boot/grub/'
+ mkdir(os.path.join(target, grub_dir))
+
+ f = open(target + grub_dir + 'loopback.cfg', 'w')
+
+ f.write("# grml2usb generated grub2 configuration file\n")
+ f.write("source /boot/grub/header.cfg\n")
+
+ for defaults in glob.glob(target + os.path.sep + grub_dir + os.path.sep + "*_default.cfg"):
+ sourcefile = defaults.split(target + os.path.sep)[1]
+ logging.debug("Found source file" + sourcefile)
+ os.path.isfile(defaults) and f.write("source " + sourcefile + "\n")
+
+ for ops in glob.glob(target + os.path.sep + grub_dir + os.path.sep + "*_options.cfg"):
+ sourcefile = ops.split(target + os.path.sep)[1]
+ logging.debug("Found source file" + sourcefile)
+ os.path.isfile(ops) and f.write("source " + sourcefile + "\n")
+
+ f.write("source /boot/grub/addons.cfg\n")
+ f.write("source /boot/grub/footer.cfg\n")
+ f.close()
+
+
def glob_and_copy(filepattern, dst):
"""Glob on specified filepattern and copy the result to dst
for name in glob.glob(filepattern):
copy_if_exist(name, dst)
+
def search_and_copy(filename, search_path, dst):
"""Search for the specified filename at searchpath and copy it to dst
file_location = search_file(filename, search_path)
copy_if_exist(file_location, dst)
+
def copy_if_exist(filename, dst):
"""Copy filename to dst if filename is set.
if filename and (os.path.isfile(filename) or os.path.isdir(filename)):
exec_rsync(filename, dst)
+
def copy_bootloader_files(iso_mount, target, grml_flavour):
"""Copy grml's bootloader files to a given target
mkdir(target + '/boot/')
exec_rsync(efi_img, target + '/boot/efi.img')
- for ffile in ['f%d' % number for number in range(1, 11) ]:
+ for ffile in ['f%d' % number for number in range(1, 11)]:
search_and_copy(ffile, iso_mount, syslinux_target + ffile)
- loopback_cfg = search_file("loopback.cfg", iso_mount)
- if loopback_cfg:
- directory = os.path.dirname(loopback_cfg)
- directory = directory.replace(iso_mount, "")
- mkdir(os.path.join(target, directory))
- exec_rsync(loopback_cfg, target + os.path.sep + directory)
-
# avoid the "file is read only, overwrite anyway (y/n) ?" question
# of mtools by syslinux ("mmove -D o -D O s:/ldlinux.sys $target_file")
if os.path.isfile(syslinux_target + 'ldlinux.sys'):
(source_dir, defaults_file) = get_defaults_file(iso_mount, grml_flavour, "grml.cfg")
if not source_dir:
- logging.critical("Fatal: file default.cfg could not be found.")
- logging.critical("Note: this grml2usb version requires an ISO generated by grml-live >=0.9.24 ...")
- logging.critical(" ... either use grml releases >=2009.10 or switch to an older grml2usb version.")
- raise
+ raise CriticalException(
+ "file default.cfg could not be found.\n"
+ "Note: this grml2usb version requires an ISO generated by grml-live >=0.9.24 ...\n"
+ " ... either use grml releases >=2009.10 or switch to an older grml2usb version.")
if not os.path.exists(iso_mount + '/boot/grub/footer.cfg'):
logging.warning("Warning: Grml releases older than 2011.12 support only one flavour in grub.")
for filename in glob.glob1(syslinux_target, "*.c32"):
copy_if_exist(os.path.join(SYSLINUX_LIBS, filename), syslinux_target)
-
# copy the addons_*.cfg file to the new syslinux directory
glob_and_copy(iso_mount + source_dir + 'addon*.cfg', syslinux_target)
# copy all grub files from ISO
glob_and_copy(iso_mount + '/boot/grub/*', grub_target)
+ # finally (after all GRUB files have been been installed) build static loopback.cfg
+ build_loopbackcfg(target)
+
+
def install_iso_files(grml_flavour, iso_mount, device, target):
"""Copy files from ISO to given target
logging.info("Copying files. This might take a while....")
try:
copy_system_files(grml_flavour, iso_mount, target)
- copy_grml_files(iso_mount, target)
- except CriticalException, error:
+ copy_grml_files(grml_flavour, iso_mount, target)
+ except CriticalException as error:
logging.critical("Execution failed: %s", error)
sys.exit(1)
proc.wait()
+def get_device_from_partition(partition):
+ device = partition
+ partition_number = None
+ if partition[-1].isdigit() and not RE_LOOP_DEVICE.match(partition):
+ m = RE_P_PARTITION.match(partition)
+ if not m:
+ m = RE_PARTITION.match(partition)
+ if m:
+ device = m.group(1)
+ partition_number = int(m.group(2)) - 1
+ return (device, partition_number)
+
+
def get_flavour(flavour_str):
"""Returns the flavour of a grml version string
"""
return re.match(r'[\w-]*', flavour_str).group()
+
def identify_grml_flavour(mountpath):
"""Get name of grml flavour
@mountpath: path where the grml ISO is mounted to
@return: name of grml-flavour"""
- version_file = search_file('grml-version', mountpath)
+ version_files = search_file('grml-version', mountpath, lst_return=True)
- if version_file == "":
- logging.critical("Error: could not find grml-version file.")
- raise
+ if not version_files:
+ if mountpath.startswith("/lib/live/mount/medium"):
+ logging.critical("Error: could not find grml-version file.")
+ logging.critical("Looks like your system is running from RAM but required files are not available.")
+ logging.critical("Please either boot without toram=... or use boot option toram instead of toram=...")
+ cleanup()
+ sys.exit(1)
+ else:
+ logging.critical("Error: could not find grml-version file.")
+ cleanup()
+ sys.exit(1)
flavours = []
- tmpfile = None
- try:
- tmpfile = open(version_file, 'r')
- for line in tmpfile.readlines():
- flavours.append(get_flavour(line))
- except TypeError, e:
- raise
- except Exception, e:
- logging.critical("Unexpected error: %s", e)
- raise
- finally:
- if tmpfile:
- tmpfile.close()
+ logging.debug("version_files = %s", version_files)
+ for version_file in version_files:
+ tmpfile = None
+ try:
+ tmpfile = open(version_file, 'r')
+ for line in tmpfile.readlines():
+ flavours.append(get_flavour(line))
+ except TypeError as e:
+ raise
+ except Exception as e:
+ raise
+ finally:
+ if tmpfile:
+ tmpfile.close()
return flavours
for regex in options.removeoption:
remove_regexes.append(re.compile(regex))
+ shortname = get_shortname(grml_flavour)
for filename in glob.glob(grub_target + '*.cfg'):
for line in fileinput.input(filename, inplace=1):
line = line.rstrip("\r\n")
if option_re.search(line):
line = bootid_re.sub('', line)
- line = live_media_path_re.sub('', line)
- line = line.rstrip() + r' live-media-path=/live/%s/ bootid=%s %s ' % (grml_flavour, UUID, bootopt)
+ if shortname in filename:
+ line = live_media_path_re.sub('', line)
+ line = line.rstrip() + ' live-media-path=/live/%s/ ' % (grml_flavour)
+ line = line.rstrip() + r' bootid=%s %s ' % (UUID, bootopt)
for regex in remove_regexes:
line = regex.sub(' ', line)
- print line
+ print(line)
fileinput.close()
data.write("include hidden.cfg\n")
data.close()
+
def add_entry_if_not_present(filename, entry):
"""Write entry into filename if entry is not already in the file
data.close()
+
def get_flavour_filename(flavour):
"""Generate a iso9960 save filename out of the specified flavour
"""
return flavour.replace('-', '_')
+
def adjust_syslinux_bootoptions(src, flavour):
"""Adjust existing bootoptions of specified syslinux config to
grml2usb specific ones, e.g. change the location of the kernel...
sys.stdout.write(line)
fileinput.close()
+
def adjust_labels(src, replacement):
"""Adjust the specified labels in the syslinux config file src with
specified replacement
data.write(generate_flavour_specific_syslinux_config(grml_flavour))
data.close()
+
def modify_filenames(grml_flavour, target, filenames):
"""Replace the standard filenames with the new ones
@target: directory where the files are located
@filenames: list of filenames to alter
"""
- grml_filename = grml_flavour.replace('-', '_')
+ grml_filename = get_flavour_filename(grml_flavour)
for filename in filenames:
old_filename = "%s/%s" % (target, filename)
new_filename = "%s/%s_%s" % (target, grml_filename, filename)
execute(mkdir, syslinux_target)
syslinux_cfg = syslinux_target + 'syslinux.cfg'
-
# install main configuration only *once*, no matter how many ISOs we have:
syslinux_config_file = open(syslinux_cfg, 'w')
- syslinux_config_file.write("TIMEOUT 300\n")
+ syslinux_config_file.write("timeout 300\n")
syslinux_config_file.write("include vesamenu.cfg\n")
syslinux_config_file.close()
prompt_name.close()
initial_syslinux_config(syslinux_target)
- flavour_filename = grml_flavour.replace('-', '_')
+ flavour_filename = get_flavour_filename(grml_flavour)
if search_file('default.cfg', syslinux_target):
modify_filenames(grml_flavour, syslinux_target, ['grml.cfg', 'default.cfg'])
filename = search_file("new_hidden.cfg", syslinux_target)
-
# process hidden file
if not search_file("hidden.cfg", syslinux_target):
new_hidden = syslinux_target + "hidden.cfg"
os.rename(filename, new_hidden)
adjust_syslinux_bootoptions(new_hidden, grml_flavour)
else:
- new_hidden_file = "%s/%s_hidden.cfg" % (syslinux_target, flavour_filename)
+ new_hidden_file = "%s/%s_hidden.cfg" % (syslinux_target, flavour_filename)
os.rename(filename, new_hidden_file)
adjust_labels(new_hidden_file, r'\1 %s-\2' % grml_flavour)
adjust_syslinux_bootoptions(new_hidden_file, grml_flavour)
entry = 'include %s_hidden.cfg\n' % flavour_filename
add_entry_if_not_present("%s/hiddens.cfg" % syslinux_target, entry)
-
-
new_default = "%s_default.cfg" % (flavour_filename)
entry = 'include %s\n' % new_default
defaults_file = '%s/defaults.cfg' % syslinux_target
else:
try:
handle_syslinux_config(grml_flavour, target)
- except CriticalException, error:
+ except CriticalException as error:
logging.critical("Fatal: %s", error)
sys.exit(1)
else:
try:
handle_grub_config(grml_flavour, device, target)
- except CriticalException, error:
+ except CriticalException as error:
logging.critical("Fatal: %s", error)
sys.exit(1)
-
def install(image, device):
"""Install a grml image to the specified device
iso_mountpoint = image
remove_image_mountpoint = False
if os.path.isdir(image):
- logging.info("Using %s as install base", image)
+ if options.force or os.path.exists(os.path.join(image, 'live')):
+ logging.info("Using %s as install base", image)
+ else:
+ q = raw_input("%s does not look like a Grml system. "
+ "Do you really want to use this image? y/N " % image)
+ if q.lower() == 'y':
+ logging.info("Using %s as install base", image)
+ else:
+ logging.info("Skipping install base %s", image)
else:
logging.info("Using ISO %s", image)
- iso_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
+ iso_mountpoint = tempfile.mkdtemp(prefix="grml2usb", dir=os.path.abspath(options.tmpdir))
register_tmpfile(iso_mountpoint)
remove_image_mountpoint = True
try:
mount(image, iso_mountpoint, ["-o", "loop,ro", "-t", "iso9660"])
- except CriticalException, error:
+ except CriticalException as error:
logging.critical("Fatal: %s", error)
sys.exit(1)
if remove_image_mountpoint:
try:
remove_mountpoint(iso_mountpoint)
- except CriticalException, error:
- logging.critical("Fatal: %s", error)
+ except CriticalException as error:
cleanup()
-
+ raise
def install_grml(mountpoint, device):
- """Main logic for copying files of the currently running grml system.
+ """Main logic for copying files of the currently running Grml system.
- @mountpoin: directory where currently running live system resides (usually /live/image)
+ @mountpoint: directory where currently running live system resides (usually /lib/live/mount/medium)
@device: partition where the specified ISO should be installed to"""
device_mountpoint = device
if os.path.isdir(device):
- logging.info("Specified device is not a directory, therefore not mounting.")
+ logging.info("Specified device is a directory, therefore not mounting.")
remove_device_mountpoint = False
else:
device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
remove_device_mountpoint = True
try:
check_for_fat(device)
+ check_boot_flag(device)
mount(device, device_mountpoint, ['-o', 'utf8,iocharset=iso8859-1'])
- except CriticalException, error:
- try:
- mount(device, device_mountpoint, "")
- except CriticalException, error:
- logging.critical("Fatal: %s", error)
- raise
+ except VerifyException as error:
+ raise
+ except CriticalException as error:
+ mount(device, device_mountpoint, "")
try:
grml_flavours = identify_grml_flavour(mountpoint)
for flavour in set(grml_flavours):
if remove_device_mountpoint:
remove_mountpoint(device_mountpoint)
+
def remove_mountpoint(mountpoint):
- """remove a registred mountpoint
+ """remove a registered mountpoint
"""
try:
if os.path.isdir(mountpoint):
os.rmdir(mountpoint)
unregister_tmpfile(mountpoint)
- except CriticalException, error:
- logging.critical("Fatal: %s", error)
+ except CriticalException as error:
cleanup()
+ raise
+
def handle_mbr(device):
"""Main handler for installing master boot record (MBR)
logging.info("Would install MBR")
return 0
- if device[-1:].isdigit():
- mbr_device = re.match(r'(.*?)\d*$', device).group(1)
- partition_number = int(device[-1:]) - 1
- else:
+ mbr_device, partition_number = get_device_from_partition(device)
+ if partition_number is None:
logging.warn("Could not detect partition number, not activating partition")
- partition_number = None
# if we get e.g. /dev/loop1 as device we don't want to put the MBR
# into /dev/loop of course, therefore use /dev/loop1 as mbr_device
mbrcode = GRML2USB_BASE + '/mbr/mbrldr'
if options.syslinuxmbr:
- mbrcode = '/usr/lib/syslinux/mbr.bin'
+ mbrcode = ""
+ mbr_locations = ('/usr/lib/syslinux/mbr.bin',
+ '/usr/share/syslinux/mbr.bin')
+ for mbrpath in mbr_locations:
+ if os.path.isfile(mbrpath):
+ mbrcode = mbrpath
+ break
+
+ if mbrcode is "":
+ str_locations = " or ".join(['"%s"' % l for l in mbr_locations])
+ logging.error('Cannot find syslinux MBR, install it at %s)',
+ str_locations)
+ raise CriticalException("syslinux MBR can not be found at %s."
+ % str_locations)
elif options.mbrmenu:
mbrcode = GRML2USB_BASE + '/mbr/mbrldr'
try:
install_mbr(mbrcode, mbr_device, partition_number, True)
- except IOError, error:
+ except IOError as error:
logging.critical("Execution failed: %s", error)
sys.exit(1)
- except Exception, error:
+ except Exception as error:
logging.critical("Execution failed: %s", error)
sys.exit(1)
sys.exit(1)
if options.force:
- print "Forcing mkfs.fat16 on %s as requested via option --force." % device
+ print("Forcing mkfs.fat16 on %s as requested via option --force." % device)
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 ")
sys.exit(1)
try:
mkfs_fat16(device)
- except CriticalException, error:
+ except CriticalException as error:
logging.critical("Execution failed: %s", error)
sys.exit(1)
if device is not None and not os.path.isdir(device) and options.syslinux:
try:
check_for_fat(device)
- except CriticalException, error:
+ except CriticalException as error:
logging.critical("Execution failed: %s", error)
sys.exit(1)
if not os.path.isdir(device) and not check_for_usbdevice(device) and not options.force:
- print "Warning: the specified device %s does not look like a removable usb device." % device
+ print("Warning: the specified device %s does not look like a removable usb device." % device)
f = raw_input("Do you really want to continue? y/N ")
if f == "y" or f == "Y":
pass
# make sure we can replace old grml2usb script and warn user when using old way of life:
if device.startswith("/mnt/external") or device.startswith("/mnt/usb") and not options.force:
- print "Warning: the semantics of grml2usb has changed."
- print "Instead of using grml2usb /path/to/iso %s you might" % device
- print "want to use grml2usb /path/to/iso /dev/... instead."
- print "Please check out the grml2usb manpage for details."
+ print("Warning: the semantics of grml2usb has changed.")
+ print("Instead of using grml2usb /path/to/iso %s you might" % device)
+ print("want to use grml2usb /path/to/iso /dev/... instead.")
+ print("Please check out the grml2usb manpage for details.")
f = raw_input("Do you really want to continue? y/N ")
if f == "y" or f == "Y":
pass
if options.verbose and options.quiet:
parser.error("please use either verbose (--verbose) or quiet (--quiet) option")
+ FORMAT = "%(message)s"
if options.verbose:
- FORMAT = "Debug: %(asctime)-15s %(message)s"
+ FORMAT = "%(asctime)-15s %(message)s"
logging.basicConfig(level=logging.DEBUG, format=FORMAT)
elif options.quiet:
- FORMAT = "Critical: %(message)s"
logging.basicConfig(level=logging.CRITICAL, format=FORMAT)
else:
- FORMAT = "%(message)s"
logging.basicConfig(level=logging.INFO, format=FORMAT)
@opts option dict from OptionParser
"""
if opts.grubmbr and not opts.grub:
- logging.critical("Error: --grub-mbr requires --grub option.")
- sys.exit(1)
+ raise CriticalException("--grub-mbr requires --grub option.")
def check_programs():
"""check if all needed programs are installed"""
if options.grub:
- if not which("grub-install"):
+ GRUB_INSTALL = which("grub-install") or which("grub2-install")
+ if not GRUB_INSTALL:
logging.critical("Fatal: grub-install not available (please install the "
+ "grub package or drop the --grub option)")
sys.exit(1)
logging.critical("Fatal: rsync not available, can not continue - sorry.")
sys.exit(1)
+
def load_loop():
"""Runs modprobe loop and throws away it's output"""
+ if not which("modprobe"):
+ logging.critical("Fatal: modprobe not available, can not continue - sorry.")
+ logging.critical("Hint: is /sbin missing in PATH?")
+ sys.exit(1)
+
proc = subprocess.Popen(["modprobe", "loop"], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
proc.wait()
+
def main():
"""Main function [make pylint happy :)]"""
- if options.version:
- print os.path.basename(sys.argv[0]) + " " + PROG_VERSION
- sys.exit(0)
+ try:
+ if options.version:
+ print(os.path.basename(sys.argv[0]) + " " + PROG_VERSION)
+ sys.exit(0)
- if len(args) < 2:
- parser.error("invalid usage")
+ if len(args) < 2:
+ parser.error("invalid usage")
- # log handling
- handle_logging()
+ # log handling
+ handle_logging()
- # make sure we have the appropriate permissions
- check_uid_root()
+ # make sure we have the appropriate permissions
+ check_uid_root()
- check_options(options)
+ check_options(options)
- load_loop()
+ load_loop()
- logging.info("Executing grml2usb version %s", PROG_VERSION)
+ logging.info("Executing grml2usb version %s", PROG_VERSION)
- if options.dryrun:
- logging.info("Running in simulation mode as requested via option dry-run.")
+ if options.dryrun:
+ logging.info("Running in simulation mode as requested via option dry-run.")
- check_programs()
+ check_programs()
- # specified arguments
- device = args[len(args) - 1]
- isos = args[0:len(args) - 1]
+ # specified arguments
+ device = os.path.realpath(args[len(args) - 1])
+ isos = args[0:len(args) - 1]
- if not os.path.isdir(device):
- if device[-1:].isdigit():
- if int(device[-1:]) > 4 or device[-2:].isdigit():
- logging.critical("Fatal: installation on partition number >4 not supported. (BIOS won't support it.)")
- sys.exit(1)
+ if not os.path.isdir(device):
+ if device[-1:].isdigit():
+ if int(device[-1:]) > 4 or device[-2:].isdigit():
+ logging.critical("Fatal: installation on partition number >4 not supported. (BIOS won't support it.)")
+ sys.exit(1)
+
+ # provide upgrade path
+ handle_compat_warning(device)
- # provide upgrade path
- handle_compat_warning(device)
+ # check for vfat partition
+ handle_vfat(device)
- # check for vfat partition
- handle_vfat(device)
+ # main operation (like installing files)
+ for iso in isos:
+ install(iso, device)
- # main operation (like installing files)
- for iso in isos:
- install(iso, device)
+ # install mbr
+ is_superfloppy = not device[-1:].isdigit()
+ if is_superfloppy:
+ logging.info("Detected superfloppy format - not installing MBR")
- # install mbr
- is_superfloppy = not device[-1:].isdigit()
- if is_superfloppy:
- logging.info("Detected superfloppy format - not installing MBR")
+ if not options.skipmbr and not os.path.isdir(device) and not is_superfloppy:
+ handle_mbr(device)
- if not options.skipmbr and not os.path.isdir(device) and not is_superfloppy:
- handle_mbr(device)
+ handle_bootloader(device)
- handle_bootloader(device)
+ logging.info("Note: grml flavour %s was installed as the default booting system.", GRML_DEFAULT)
- logging.info("Note: grml flavour %s was installed as the default booting system.", GRML_DEFAULT)
+ for flavour in GRML_FLAVOURS:
+ logging.info("Note: you can boot flavour %s using '%s' on the commandline.", flavour, flavour)
- for flavour in GRML_FLAVOURS:
- logging.info("Note: you can boot flavour %s using '%s' on the commandline.", flavour, flavour)
+ # finally be polite :)
+ logging.info("Finished execution of grml2usb (%s). Have fun with your Grml system.", PROG_VERSION)
- # finally be politely :)
- logging.info("Finished execution of grml2usb (%s). Have fun with your grml system.", PROG_VERSION)
+ except Exception as error:
+ logging.critical("Fatal: %s", str(error))
+ sys.exit(1)
if __name__ == "__main__":
projects / grml2usb.git / blobdiff