Mention the Debian package in the error message
[grml2usb.git] / grml2usb
1 #!/usr/bin/env python
2 # -*- coding: utf-8 -*-
3 """
4 grml2usb
5 ~~~~~~~~
6
7 This script installs a grml system (either a running system or ISO[s]) to a USB device
8
9 :copyright: (c) 2009 by Michael Prokop <mika@grml.org>
10 :license: GPL v2 or any later version
11 :bugreports: http://grml.org/bugs/
12
13 """
14
15 from __future__ import with_statement
16 from optparse import OptionParser
17 from inspect import isroutine, isclass
18 import datetime, logging, os, re, subprocess, sys, tempfile, time
19
20 # global variables
21 PROG_VERSION = "0.9.3"
22 MOUNTED = set()  # register mountpoints
23 TMPFILES = set() # register tmpfiles
24 DATESTAMP = time.mktime(datetime.datetime.now().timetuple()) # unique identifier for syslinux.cfg
25
26 # cmdline parsing
27 USAGE = "Usage: %prog [options] <[ISO[s] | /live/image]> </dev/sdX#>\n\
28 \n\
29 %prog installs grml ISO[s] to an USB device to be able to boot from it.\n\
30 Make sure you have at least one grml ISO or a running grml system (/live/image),\n\
31 grub or syslinux and root access.\n\
32 \n\
33 Run %prog --help for usage hints, further information via: man grml2usb"
34
35 # pylint: disable-msg=C0103
36 parser = OptionParser(usage=USAGE)
37 parser.add_option("--bootoptions", dest="bootoptions",
38                   action="store", type="string",
39                   help="use specified bootoptions as default")
40 parser.add_option("--bootloader-only", dest="bootloaderonly", action="store_true",
41                   help="do not copy files but just install a bootloader")
42 parser.add_option("--copy-only", dest="copyonly", action="store_true",
43                   help="copy files only but do not install bootloader")
44 parser.add_option("--dry-run", dest="dryrun", action="store_true",
45                   help="avoid executing commands")
46 parser.add_option("--fat16", dest="fat16", action="store_true",
47                   help="format specified partition with FAT16")
48 parser.add_option("--force", dest="force", action="store_true",
49                   help="force any actions requiring manual interaction")
50 #parser.add_option("--initrd", dest="initrd", action="store", type="string",
51 #                  help="install specified initrd instead of the default [TODO - not implemented yet]")
52 #parser.add_option("--kernel", dest="kernel", action="store", type="string",
53 #                  help="install specified kernel instead of the default [TODO - not implemented yet]")
54 parser.add_option("--lilo-binary", dest="lilobin",  action="store", type="string",
55                   help="lilo executable to be used for installing MBR")
56 parser.add_option("--mbr-menu", dest="mbrmenu", action="store_true",
57                   help="enable interactive boot menu in MBR")
58 parser.add_option("--quiet", dest="quiet", action="store_true",
59                   help="do not output anything but just errors on console")
60 parser.add_option("--skip-addons", dest="skipaddons", action="store_true",
61                   help="do not install /boot/addons/ files")
62 parser.add_option("--skip-mbr", dest="skipmbr", action="store_true",
63                   help="do not install a master boot record (MBR) on the device")
64 parser.add_option("--syslinux", dest="syslinux", action="store_true",
65                   help="install syslinux bootloader instead of grub")
66 parser.add_option("--syslinux-mbr", dest="syslinuxmbr", action="store_true",
67                   help="install syslinux master boot record (MBR) instead of default")
68 #parser.add_option("--squashfs", dest="squashfs", action="store", type="string",
69 #                  help="install specified squashfs file instead of the default [TODO - not implemented yet]")
70 #parser.add_option("--uninstall", dest="uninstall", action="store_true",
71 #                  help="remove grml ISO files from specified device [TODO - not implemented yet]")
72 parser.add_option("--verbose", dest="verbose", action="store_true",
73                   help="enable verbose mode")
74 parser.add_option("-v", "--version", dest="version", action="store_true",
75                   help="display version and exit")
76 (options, args) = parser.parse_args()
77
78
79 class CriticalException(Exception):
80     """Throw critical exception if the exact error is not known but fatal."
81
82     @Exception: message"""
83     pass
84
85
86 def cleanup():
87     """Cleanup function to make sure there aren't any mounted devices left behind.
88     """
89
90     logging.info("Cleaning up before exiting...")
91     proc = subprocess.Popen(["sync"])
92     proc.wait()
93
94     try:
95         for device in MOUNTED:
96             unmount(device, "")
97     # ignore: RuntimeError: Set changed size during iteration
98     except RuntimeError:
99         logging.debug('caught expection RuntimeError, ignoring')
100
101
102 def register_tmpfile(path):
103     """
104     TODO - not implemented yet
105     """
106
107     TMPFILES.add(path)
108
109
110 def unregister_tmpfile(path):
111     """
112     TODO - not implemented yet
113     """
114
115     if path in TMPFILES:
116         TMPFILES.remove(path)
117
118
119 def register_mountpoint(target):
120     """register specified target in a set() for handling clean exiting
121
122     @target: destination target of mountpoint
123     """
124
125     MOUNTED.add(target)
126
127
128 def unregister_mountpoint(target):
129     """unregister specified target in a set() for handling clean exiting
130
131     @target: destination target of mountpoint
132     """
133
134     if target in MOUNTED:
135         MOUNTED.remove(target)
136
137
138 def get_function_name(obj):
139     """Helper function for use in execute() to retrive name of a function
140
141     @obj: the function object
142     """
143     if not (isroutine(obj) or isclass(obj)):
144         obj = type(obj)
145     return obj.__module__ + '.' + obj.__name__
146
147
148 def execute(f, *exec_arguments):
149     """Wrapper for executing a command. Either really executes
150     the command (default) or when using --dry-run commandline option
151     just displays what would be executed."""
152     # usage: execute(subprocess.Popen, (["ls", "-la"]))
153     # TODO: doesn't work for proc = execute(subprocess.Popen...() -> any ideas?
154     if options.dryrun:
155         # pylint: disable-msg=W0141
156         logging.debug('dry-run only: %s(%s)' % (get_function_name(f), ', '.join(map(repr, exec_arguments))))
157     else:
158         # pylint: disable-msg=W0142
159         return f(*exec_arguments)
160
161
162 def is_exe(fpath):
163     """Check whether a given file can be executed
164
165     @fpath: full path to file
166     @return:"""
167     return os.path.exists(fpath) and os.access(fpath, os.X_OK)
168
169
170 def which(program):
171     """Check whether a given program is available in PATH
172
173     @program: name of executable"""
174     fpath = os.path.split(program)[0]
175     if fpath:
176         if is_exe(program):
177             return program
178     else:
179         for path in os.environ["PATH"].split(os.pathsep):
180             exe_file = os.path.join(path, program)
181             if is_exe(exe_file):
182                 return exe_file
183
184     return None
185
186
187 def search_file(filename, search_path='/bin' + os.pathsep + '/usr/bin'):
188     """Given a search path, find file
189
190     @filename: name of file to search for
191     @search_path: path where searching for the specified filename"""
192     file_found = 0
193     paths = search_path.split(os.pathsep)
194     current_dir = '' # make pylint happy :)
195     for path in paths:
196         # pylint: disable-msg=W0612
197         for current_dir, directories, files in os.walk(path):
198             if os.path.exists(os.path.join(current_dir, filename)):
199                 file_found = 1
200                 break
201     if file_found:
202         return os.path.abspath(os.path.join(current_dir, filename))
203     else:
204         return None
205
206
207 def check_uid_root():
208     """Check for root permissions"""
209     if not os.geteuid()==0:
210         sys.exit("Error: please run this script with uid 0 (root).")
211
212
213 def mkfs_fat16(device):
214     """Format specified device with VFAT/FAT16 filesystem.
215
216     @device: partition that should be formated"""
217
218     # syslinux -d boot/isolinux /dev/sdb1
219     if options.dryrun:
220         logging.info("Would execute mkfs.vfat -F 16 %s now.", device)
221         return 0
222
223     logging.info("Formating partition with fat16 filesystem")
224     logging.debug("mkfs.vfat -F 16 %s" % device)
225     proc = subprocess.Popen(["mkfs.vfat", "-F", "16", device])
226     proc.wait()
227     if proc.returncode != 0:
228         raise CriticalException("error executing mkfs.vfat")
229
230
231 def generate_main_grub2_config(grml_flavour, install_partition, bootoptions):
232     """Generate grub2 configuration for use via grub.cfg
233
234     @grml_flavour: name of grml flavour the configuration should be generated for
235     @install_partition: partition number for use in (hd0,X)
236     @bootoptions: additional bootoptions that should be used by default"""
237
238     local_datestamp = DATESTAMP
239
240     return("""\
241 ## main grub2 configuration - generated by grml2usb [main config generated at: %(local_datestamp)s]
242 set default=0
243 set timeout=5
244
245 insmod fat
246
247 if font (hd0,%(install_partition)s)/boot/grub/ascii.pff ; then
248    insmod png
249    set gfxmode=640x480
250    insmod gfxterm
251    insmod vbe
252    terminal gfxterm
253 fi
254
255 if background_image (hd0,%(install_partition)s)/boot/grub/grml.png ; then
256   set color_normal=black/black
257   set color_highlight=red/black
258 else
259   set menu_color_normal=white/black
260   set menu_color_highlight=black/yellow
261 fi
262
263 menuentry "%(grml_flavour)s (default)" {
264     set root=(hd0,%(install_partition)s)
265     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
266     initrd  /boot/release/%(grml_flavour)s/initrd.gz
267 }
268
269 menuentry "Memory test (memtest86+)" {
270     set root=(hd0,%(install_partition)s)
271     linux   /boot/addons/memtest
272 }
273
274 menuentry "Grub - all in one image" {
275     set root=(hd0,%(install_partition)s)
276     linux   /boot/addons/memdisk
277     initrd  /boot/addons/allinone.img
278 }
279
280 menuentry "FreeDOS" {
281     set root=(hd0,%(install_partition)s)
282     linux   /boot/addons/memdisk
283     initrd  /boot/addons/balder10.imz
284 }
285
286 menuentry "MirBSD" {
287     set root=(hd0,%(install_partition)s)
288     linux   /boot/addons/bsd4grml/ldbsd.com
289 }
290
291 menuentry "Boot OS of first partition on first disk" {
292     set root=(hd0,1)
293     chainloader +1
294 }
295
296 """ % {'grml_flavour': grml_flavour, 'local_datestamp': local_datestamp,
297         'bootoptions': bootoptions, 'install_partition': install_partition } )
298
299
300 def generate_flavour_specific_grub2_config(grml_flavour, install_partition, bootoptions):
301     """Generate grub2 configuration for use via grub.cfg
302
303     @grml_flavour: name of grml flavour the configuration should be generated for
304     @install_partition: partition number for use in (hd0,X)
305     @bootoptions: additional bootoptions that should be used by default"""
306
307     local_datestamp = DATESTAMP
308
309     return("""\
310 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
311 menuentry "%(grml_flavour)s" {
312     set root=(hd0,%(install_partition)s)
313     linux  /boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ %(bootoptions)s
314     initrd /boot/release/%(grml_flavour)s/initrd.gz
315 }
316
317 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
318 menuentry "%(grml_flavour)s2ram" {
319     set root=(hd0,%(install_partition)s)
320     linux  /boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ toram=%(grml_flavour)s %(bootoptions)s
321     initrd /boot/release/%(grml_flavour)s/initrd.gz
322 }
323
324 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
325 menuentry "%(grml_flavour)s-debug" {
326     set root=(hd0,%(install_partition)s)
327     linux /boot/release/%(grml_flavour)s/linux26
328     initrd /boot/release/%(grml_flavour)s/initrd.gz apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ debug boot=live initcall_debug%(bootoptions)s
329 }
330
331 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
332 menuentry "%(grml_flavour)s-x" {
333     set root=(hd0,%(install_partition)s)
334     linux  /boot/release/%(grml_flavour)s/linux26
335     initrd /boot/release/%(grml_flavour)s/initrd.gz apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ startx=wm-ng %(bootoptions)s
336 }
337
338 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
339 menuentry "%(grml_flavour)s-nofb" {
340     set root=(hd0,%(install_partition)s)
341     linux  /boot/release/%(grml_flavour)s/linux26
342     initrd /boot/release/%(grml_flavour)s/initrd.gz apm=power-off boot=live nomce quiet live-media-path=/live/%(grml_flavour)s/ vga=normal video=ofonly %(bootoptions)s
343 }
344
345 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
346 menuentry "%(grml_flavour)s-failsafe" {
347     set root=(hd0,%(install_partition)s)
348     linux /boot/release/%(grml_flavour)s/linux26
349     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
350 }
351
352 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
353 menuentry "%(grml_flavour)s-forensic" {
354     set root=(hd0,%(install_partition)s)
355     linux /boot/release/%(grml_flavour)s/linux26
356     initrd /boot/release/%(grml_flavour)s/initrd.gz apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ nofstab noraid nolvm noautoconfig noswap raid=noautodetect %(bootoptions)s
357 }
358
359 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
360 menuentry "%(grml_flavour)s-serial" {
361     set root=(hd0,%(install_partition)s)
362     linux /boot/release/%(grml_flavour)s/linux26
363     initrd /boot/release/%(grml_flavour)s/initrd.gz 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
364 }
365
366 """ % {'grml_flavour': grml_flavour, 'local_datestamp': local_datestamp,
367        'bootoptions': bootoptions, 'install_partition': install_partition } )
368
369
370 def generate_flavour_specific_grub1_config(grml_flavour, install_partition, bootoptions):
371     """Generate grub1 configuration for use via menu.lst
372
373     @grml_flavour: name of grml flavour the configuration should be generated for
374     @install_partition: partition number for use in (hd0,X)
375     @bootoptions: additional bootoptions that should be used by default"""
376
377     local_datestamp = DATESTAMP
378
379     return("""\
380 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
381 title %(grml_flavour)s
382 kernel (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ %(bootoptions)s
383 initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
384
385 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
386 title %(grml_flavour)s2ram
387 kernel (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ toram=%(grml_flavour)s %(bootoptions)s
388 initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
389
390 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
391 title %(grml_flavour)s-debug
392 kernel (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ debug boot=live initcall_debug%(bootoptions)s
393 initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
394
395 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
396 title %(grml_flavour)s-x
397 kernel (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ startx=wm-ng %(bootoptions)s
398 initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
399
400 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
401 title %(grml_flavour)s-nofb
402 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 video=ofonly %(bootoptions)s
403 initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
404
405 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
406 title %(grml_flavour)s-failsafe
407 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
408 initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
409
410 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
411 title %(grml_flavour)s-forensic
412 kernel (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/linux26 apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ nofstab noraid nolvm noautoconfig noswap raid=noautodetect %(bootoptions)s
413 initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
414
415 ## flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
416 title %(grml_flavour)s-serial
417 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 video=vesafb:off console=tty1 console=ttyS0,9600n8 %(bootoptions)s
418 initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
419
420 """ % {'grml_flavour': grml_flavour, 'local_datestamp': local_datestamp,
421        'bootoptions': bootoptions, 'install_partition': install_partition } )
422
423
424 def generate_main_grub1_config(grml_flavour, install_partition, bootoptions):
425     """Generate grub1 configuration for use via menu.lst
426
427     @grml_flavour: name of grml flavour the configuration should be generated for"""
428
429     local_datestamp = DATESTAMP
430
431     return("""\
432 ## main grub1 configuration - generated by grml2usb [main config generated at: %(local_datestamp)s]
433 # misc options:
434 timeout 30
435 # color red/blue green/black
436 splashimage=(hd0,%(install_partition)s)/boot/grub/splash.xpm.gz
437 foreground  = 000000
438 background  = FFCC33
439
440 # define entries:
441 title %(grml_flavour)s  - Default boot (using 1024x768 framebuffer)
442 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/
443 initrd (hd0,%(install_partition)s)/boot/release/%(grml_flavour)s/initrd.gz
444
445 title Memory test (memtest86+)
446 kernel (hd0,%(install_partition)s)/boot/addons/memtest
447
448 title Grub - all in one image
449 kernel (hd0,%(install_partition)s)/boot/addons/memdisk
450 initrd (hd0,%(install_partition)s)/boot/addons/allinone.img
451
452 title FreeDOS
453 kernel (hd0,%(install_partition)s)/boot/addons/memdisk
454 initrd (hd0,%(install_partition)s)/boot/addons/balder10.imz
455
456 title MirBSD
457 kernel (hd0,%(install_partition)s)/boot/addons/bsd4grml/ldbsd.com
458
459 """ % {'grml_flavour': grml_flavour, 'local_datestamp': local_datestamp,
460        'bootoptions': bootoptions, 'install_partition': install_partition } )
461
462
463 def generate_isolinux_splash(grml_flavour):
464     """Generate bootsplash for isolinux/syslinux
465
466     @grml_flavour: name of grml flavour the configuration should be generated for"""
467
468     # TODO: adjust last bootsplash line (the one following the "Some information and boot ...")
469
470     grml_name = grml_flavour
471
472     return("""\
473 \ f17\f\18/boot/syslinux/logo.16
474
475 Some information and boot options available via keys F2 - F10. http://grml.org/
476 %(grml_name)s
477 """ % {'grml_name': grml_name} )
478
479
480 def generate_main_syslinux_config(grml_flavour, bootoptions):
481     """Generate main configuration for use in syslinux.cfg
482
483     @grml_flavour: name of grml flavour the configuration should be generated for
484     @bootoptions: additional bootoptions that should be used by default"""
485
486     local_datestamp = DATESTAMP
487
488     return("""\
489 ## main syslinux configuration - generated by grml2usb [main config generated at: %(local_datestamp)s]
490 # use this to control the bootup via a serial port
491 # SERIAL 0 9600
492 DEFAULT grml
493 TIMEOUT 300
494 PROMPT 1
495 DISPLAY /boot/syslinux/boot.msg
496 F1 /boot/syslinux/boot.msg
497 F2 /boot/syslinux/f2
498 F3 /boot/syslinux/f3
499 F4 /boot/syslinux/f4
500 F5 /boot/syslinux/f5
501 F6 /boot/syslinux/f6
502 F7 /boot/syslinux/f7
503 F8 /boot/syslinux/f8
504 F9 /boot/syslinux/f9
505 F10 /boot/syslinux/f10
506 ## end of main configuration
507
508 ## global configuration
509 # the default option (using %(grml_flavour)s)
510 LABEL  grml
511 KERNEL /boot/release/%(grml_flavour)s/linux26
512 APPEND initrd=/boot/release/%(grml_flavour)s/initrd.gz apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ %(bootoptions)s
513
514 # memtest
515 LABEL  memtest
516 KERNEL /boot/addons/memtest
517
518 # grub
519 LABEL grub
520 MENU LABEL grub
521 KERNEL /boot/addons/memdisk
522 APPEND initrd=/boot/addons/allinone.img
523
524 # dos
525 LABEL dos
526 MENU LABEL dos
527 KERNEL /boot/addons/memdisk
528 APPEND initrd=/boot/addons/balder10.imz
529
530 # bsd
531 LABEL bsd
532 MENU LABEL bsd
533 KERNEL /boot/addons/bsd4grml/ldbsd.com
534
535 ## end of global configuration
536 """ % {'grml_flavour': grml_flavour, 'local_datestamp': local_datestamp, 'bootoptions': bootoptions} )
537
538
539 def generate_flavour_specific_syslinux_config(grml_flavour, bootoptions):
540     """Generate flavour specific configuration for use in syslinux.cfg
541
542     @grml_flavour: name of grml flavour the configuration should be generated for
543     @bootoptions: bootoptions that should be used as a default"""
544
545     local_datestamp = DATESTAMP
546
547     return("""\
548
549 # flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
550 LABEL  %(grml_flavour)s
551 KERNEL /boot/release/%(grml_flavour)s/linux26
552 APPEND initrd=/boot/release/%(grml_flavour)s/initrd.gz apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ %(bootoptions)s
553
554 # flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
555 LABEL  %(grml_flavour)s2ram
556 KERNEL /boot/release/%(grml_flavour)s/linux26
557 APPEND initrd=/boot/release/%(grml_flavour)s/initrd.gz apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ toram=%(grml_flavour)s %(bootoptions)s
558
559 # flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
560 LABEL  %(grml_flavour)s-debug
561 KERNEL /boot/release/%(grml_flavour)s/linux26
562 APPEND initrd=/boot/release/%(grml_flavour)s/initrd.gz apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ debug boot=live initcall_debug%(bootoptions)s
563
564 # flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
565 LABEL  %(grml_flavour)s-x
566 KERNEL /boot/release/%(grml_flavour)s/linux26
567 APPEND initrd=/boot/release/%(grml_flavour)s/initrd.gz apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ startx=wm-ng %(bootoptions)s
568
569 # flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
570 LABEL  %(grml_flavour)s-nofb
571 KERNEL /boot/release/%(grml_flavour)s/linux26
572 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 video=ofonly %(bootoptions)s
573
574 # flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
575 LABEL  %(grml_flavour)s-failsafe
576 KERNEL /boot/release/%(grml_flavour)s/linux26
577 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
578
579 # flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
580 LABEL  %(grml_flavour)s-forensic
581 KERNEL /boot/release/%(grml_flavour)s/linux26
582 APPEND initrd=/boot/release/%(grml_flavour)s/initrd.gz apm=power-off boot=live nomce vga=791 quiet live-media-path=/live/%(grml_flavour)s/ nofstab noraid nolvm noautoconfig noswap raid=noautodetect %(bootoptions)s
583
584 # flavour specific configuration for %(grml_flavour)s [grml2usb for %(grml_flavour)s: %(local_datestamp)s]
585 LABEL  %(grml_flavour)s-serial
586 KERNEL /boot/release/%(grml_flavour)s/linux26
587 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 video=vesafb:off console=tty1 console=ttyS0,9600n8 %(bootoptions)s
588 """ % {'grml_flavour': grml_flavour, 'local_datestamp': local_datestamp, 'bootoptions': bootoptions} )
589
590
591 def install_grub(device):
592     """Install grub on specified device.
593
594     @mntpoint: mountpoint of device where grub should install its files to
595     @device: partition where grub should be installed to"""
596
597     if options.dryrun:
598         logging.info("Would execute grub-install [--root-directory=mount_point] %s now.", device)
599     else:
600         device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
601         register_tmpfile(device_mountpoint)
602         try:
603             mount(device, device_mountpoint, "")
604             logging.debug("grub-install --recheck --no-floppy --root-directory=%s %s", device_mountpoint, device)
605             proc = subprocess.Popen(["grub-install", "--recheck", "--no-floppy",
606                 "--root-directory=%s" % device_mountpoint, device], stdout=file(os.devnull, "r+"))
607             proc.wait()
608             if proc.returncode != 0:
609                 raise Exception("error executing grub-install")
610         except CriticalException, error:
611             logging.critical("Fatal: %s" % error)
612             cleanup()
613             sys.exit(1)
614
615         finally:
616             unmount(device_mountpoint, "")
617             os.rmdir(device_mountpoint)
618             unregister_tmpfile(device_mountpoint)
619
620
621 def install_syslinux(device):
622     """Install syslinux on specified device.
623
624     @device: partition where syslinux should be installed to"""
625
626     if options.dryrun:
627         logging.info("Would install syslinux as bootloader on %s", device)
628         return 0
629
630     # syslinux -d boot/isolinux /dev/sdb1
631     logging.info("Installing syslinux as bootloader")
632     logging.debug("syslinux -d boot/syslinux %s" % device)
633     proc = subprocess.Popen(["syslinux", "-d", "boot/syslinux", device])
634     proc.wait()
635     if proc.returncode != 0:
636         raise CriticalException("Error executing syslinux (either try --fat16 or --grub?)")
637
638
639 def install_bootloader(device):
640     """Install bootloader on specified device.
641
642     @device: partition where bootloader should be installed to"""
643
644     # by default we use grub, so install syslinux only on request
645     if options.syslinux:
646         try:
647             install_syslinux(device)
648         except CriticalException, error:
649             logging.critical("Fatal: %s" % error)
650             cleanup()
651             sys.exit(1)
652     else:
653         try:
654             install_grub(device)
655         except CriticalException, error:
656             logging.critical("Fatal: %s" % error)
657             cleanup()
658             sys.exit(1)
659
660
661 def execute_lilo(lilo, device):
662     """execute lilo for activating the partitions in the MBR
663
664     @lilo: path of lilo executable
665     @device: device where lilo should be executed on"""
666
667     # to support -A for extended partitions:
668     logging.info("Activating partitions in MBR via lilo")
669     logging.debug("%s -S /dev/null -M %s ext" % (lilo, device))
670     proc = subprocess.Popen([lilo, "-S", "/dev/null", "-M", device, "ext"])
671     proc.wait()
672     if proc.returncode != 0:
673         raise Exception("error executing lilo")
674
675     # activate partition:
676     logging.debug("%s -S /dev/null -A %s 1" % (lilo, device))
677     proc = subprocess.Popen([lilo, "-S", "/dev/null", "-A", device, "1"])
678     proc.wait()
679     if proc.returncode != 0:
680         raise Exception("error executing lilo")
681
682
683 def install_syslinux_mbr(device):
684     """install syslinux's master boot record (MBR) on the specified device
685
686     @device: device where MBR of syslinux should be installed to"""
687
688     # lilo's mbr is broken, use the one from syslinux instead:
689     if not os.path.isfile("/usr/lib/syslinux/mbr.bin"):
690         raise Exception("/usr/lib/syslinux/mbr.bin can not be read")
691
692     logging.info("Installing syslinux MBR")
693     logging.debug("cat /usr/lib/syslinux/mbr.bin > %s" % device)
694     try:
695         # TODO -> use Popen instead?
696         retcode = subprocess.call("cat /usr/lib/syslinux/mbr.bin > "+ device, shell=True)
697         if retcode < 0:
698             logging.critical("Error copying MBR to device (%s)" % retcode)
699     except OSError, error:
700         logging.critical("Execution failed:", error)
701
702
703 def install_mir_mbr(mbrtemplate, device, partition, ismirbsdmbr=True):
704     """install 'mbr' master boot record (MBR) on a device
705
706     Retrieve the partition table from "device", install an MBR from the
707     "mbrtemplate" file, set the "partition" (0..3) active, and install the
708     result back to "device".
709
710     @mbrtemplate: default MBR file
711
712     @device: name of a file assumed to be a hard disc (or USB stick) image, or
713     something like "/dev/sdb"
714
715     @partition: must be a number between 0 and 3, inclusive
716
717     @mbrtemplate: must be a valid MBR file of at least 440 (or 439 if
718     ismirbsdmbr) bytes.
719
720     @ismirbsdmbr: if true then ignore the active flag, set the mirbsdmbr
721     specific flag to 0/1/2/3 and set the MBR's default value accordingly. If
722     false then leave the mirbsdmbr specific flag set to FFh, set all
723     active flags to 0 and set the active flag of the partition to 80h.  Note:
724     behaviour of mirbsdmbr: if flag = 0/1/2/3 then use it, otherwise search for
725     the active flag."""
726
727     logging.info("Installing default MBR")
728
729     if not os.path.isfile(mbrtemplate):
730         logging.critical("Error: %s can not be read." % mbrtemplate)
731         raise CriticalException("Error installing MBR (either try --syslinux-mbr or install missing file?)")
732
733     if (partition < 0) or (partition > 3):
734         raise ValueError("partition must be between 0 and 3")
735
736     if ismirbsdmbr:
737         nmbrbytes = 439
738     else:
739         nmbrbytes = 440
740
741     tmpf = tempfile.NamedTemporaryFile()
742
743     logging.debug("executing: dd if='%s' of='%s' bs=512 count=1" % (device, tmpf.name))
744     proc = subprocess.Popen(["dd", "if=%s" % device, "of=%s" % tmpf.name, "bs=512", "count=1"], stderr=file(os.devnull, "r+"))
745     proc.wait()
746     if proc.returncode != 0:
747         raise Exception("error executing dd (first run)")
748
749     logging.debug("executing: dd if=%s of=%s bs=%s count=1 conv=notrunc" % (mbrtemplate,
750         tmpf.name, nmbrbytes))
751     proc = subprocess.Popen(["dd", "if=%s" % mbrtemplate, "of=%s" % tmpf.name, "bs=%s" % nmbrbytes,
752         "count=1", "conv=notrunc"], stderr=file(os.devnull, "r+"))
753     proc.wait()
754     if proc.returncode != 0:
755         raise Exception("error executing dd (second run)")
756
757     mbrcode = tmpf.file.read(512)
758     if len(mbrcode) < 512:
759         raise EOFError("MBR size (%d) < 512" % len(mbrcode))
760
761     if ismirbsdmbr:
762         mbrcode = mbrcode[0:439] + chr(partition) + \
763           mbrcode[440:510] + "\x55\xAA"
764     else:
765         actives = ["\x00", "\x00", "\x00", "\x00"]
766         actives[partition] = "\x80"
767         mbrcode = mbrcode[0:446] + actives[0] + \
768           mbrcode[447:462] + actives[1] + \
769           mbrcode[463:478] + actives[2] + \
770           mbrcode[479:494] + actives[3] + \
771           mbrcode[495:510] + "\x55\xAA"
772
773     tmpf.file.seek(0)
774     tmpf.file.truncate()
775     tmpf.file.write(mbrcode)
776     tmpf.file.close()
777
778     logging.debug("executing: dd if='%s' of='%s' bs=512 count=1 conv=notrunc" % (tmpf.name, device))
779     proc = subprocess.Popen(["dd", "if=%s" % tmpf.name, "of=%s" % device, "bs=512", "count=1",
780                             "conv=notrunc"], stderr=file(os.devnull, "r+"))
781     proc.wait()
782     if proc.returncode != 0:
783         raise Exception("error executing dd (third run)")
784     del tmpf
785
786
787 def handle_syslinux_mbr(device):
788     """Install syslinux master boot record on given device
789
790     @device: device where MBR should be installed to"""
791
792     if not is_writeable(device):
793         raise IOError("device not writeable for user")
794
795     # try to use system's lilo
796     if which("lilo"):
797         lilo = which("lilo")
798     else:
799         # otherwise fall back to our static version
800         from platform import architecture
801         if architecture()[0] == '64bit':
802             lilo = '/usr/share/grml2usb/lilo/lilo.static.amd64'
803         else:
804             lilo = '/usr/share/grml2usb/lilo/lilo.static.i386'
805     # finally prefer a specified lilo executable
806     if options.lilobin:
807         lilo = options.lilobin
808
809     if not is_exe(lilo):
810         raise Exception("lilo executable can not be execute")
811
812     if options.dryrun:
813         logging.info("Would install MBR running lilo and using syslinux.")
814         return 0
815
816     execute_lilo(lilo, device)
817     install_syslinux_mbr(device)
818
819
820 def is_writeable(device):
821     """Check if the device is writeable for the current user
822
823     @device: partition where bootloader should be installed to"""
824
825     if not device:
826         return False
827         #raise Exception("no device for checking write permissions")
828
829     if not os.path.exists(device):
830         return False
831
832     return os.access(device, os.W_OK) and os.access(device, os.R_OK)
833
834
835 def mount(source, target, mount_options):
836     """Mount specified source on given target
837
838     @source: name of device/ISO that should be mounted
839     @target: directory where the ISO should be mounted to
840     @options: mount specific options"""
841
842     # note: options.dryrun does not work here, as we have to
843     # locate files and identify the grml flavour
844
845     for x in file('/proc/mounts').readlines():
846         if x.startswith(source):
847             raise CriticalException("Error executing mount: %s already mounted - please unmount before invoking grml2usb" % source)
848
849     if os.path.isdir(source):
850         logging.debug("Source %s is not a device, not mounting therefor." % source)
851         return 0
852
853     logging.debug("mount %s %s %s" % (mount_options, source, target))
854     proc = subprocess.Popen(["mount"] + list(mount_options) + [source, target])
855     proc.wait()
856     if proc.returncode != 0:
857         raise CriticalException("Error executing mount (no filesystem on the partition?)")
858     else:
859         logging.debug("register_mountpoint(%s)" % target)
860         register_mountpoint(target)
861
862
863 def unmount(target, unmount_options):
864     """Unmount specified target
865
866     @target: target where something is mounted on and which should be unmounted
867     @options: options for umount command"""
868
869     # make sure we unmount only already mounted targets
870     target_unmount = False
871     mounts = open('/proc/mounts').readlines()
872     mountstring = re.compile(".*%s.*" % re.escape(target))
873     for line in mounts:
874         if re.match(mountstring, line):
875             target_unmount = True
876
877     if not target_unmount:
878         logging.debug("%s not mounted anymore" % target)
879     else:
880         logging.debug("umount %s %s" % (list(unmount_options), target))
881         proc = subprocess.Popen(["umount"] + list(unmount_options) + [target])
882         proc.wait()
883         if proc.returncode != 0:
884             raise Exception("Error executing umount")
885         else:
886             logging.debug("unregister_mountpoint(%s)" % target)
887             unregister_mountpoint(target)
888
889
890 def check_for_usbdevice(device):
891     """Check whether the specified device is a removable USB device
892
893     @device: device name, like /dev/sda1 or /dev/sda
894     """
895
896     usbdevice = re.match(r'/dev/(.*?)\d*$', device).group(1)
897     usbdevice = os.path.realpath('/sys/class/block/' + usbdevice + '/removable')
898     if os.path.isfile(usbdevice):
899         is_usb = open(usbdevice).readline()
900         if is_usb == "1":
901             return 0
902         else:
903             return 1
904
905
906 def check_for_fat(partition):
907     """Check whether specified partition is a valid VFAT/FAT16 filesystem
908
909     @partition: device name of partition"""
910
911     try:
912         udev_info = subprocess.Popen(["/lib/udev/vol_id", "-t", partition],
913                     stdout=subprocess.PIPE, stderr=subprocess.PIPE)
914         filesystem = udev_info.communicate()[0].rstrip()
915
916         if udev_info.returncode == 2:
917             raise CriticalException("Failed to read device %s"
918                                     " (wrong UID/permissions or device/directory not present?)" % partition)
919
920         if options.syslinux and filesystem != "vfat":
921             raise CriticalException("Partition %s does not contain a FAT16 filesystem. (Use --fat16 or run mkfs.vfat %s)" % (partition, partition))
922
923     except OSError:
924         raise CriticalException("Sorry, /lib/udev/vol_id not available.")
925
926
927 def mkdir(directory):
928     """Simple wrapper around os.makedirs to get shell mkdir -p behaviour"""
929
930     # just silently pass as it's just fine it the directory exists
931     if not os.path.isdir(directory):
932         try:
933             os.makedirs(directory)
934         # pylint: disable-msg=W0704
935         except OSError:
936             pass
937
938
939 def copy_system_files(grml_flavour, iso_mount, target):
940     """copy grml's main files (like squashfs, kernel and initrd) to a given target
941
942     @grml_flavour: name of grml flavour the configuration should be generated for
943     @iso_mount: path where a grml ISO is mounted on
944     @target: path where grml's main files should be copied to"""
945
946     squashfs = search_file(grml_flavour + '.squashfs', iso_mount)
947     if squashfs is None:
948         logging.critical("Fatal: squashfs file not found")
949     else:
950         squashfs_target = target + '/live/' + grml_flavour + '/'
951         execute(mkdir, squashfs_target)
952         logging.debug("cp %s %s" % (squashfs, squashfs_target + grml_flavour + '.squashfs'))
953         proc = subprocess.Popen(["cp", squashfs, squashfs_target + grml_flavour + ".squashfs"])
954         proc.wait()
955
956     filesystem_module = search_file('filesystem.module', iso_mount)
957     if filesystem_module is None:
958         logging.critical("Fatal: filesystem.module not found")
959     else:
960         logging.debug("cp %s %s" % (filesystem_module, squashfs_target + 'filesystem.module'))
961         proc = subprocess.Popen(["cp", filesystem_module, squashfs_target + 'filesystem.module'])
962         proc.wait()
963
964     release_target = target + '/boot/release/' + grml_flavour
965     execute(mkdir, release_target)
966
967     kernel = search_file('linux26', iso_mount)
968     if kernel is None:
969         logging.critical("Fatal kernel not found")
970     else:
971         logging.debug("cp %s %s" % (kernel, release_target + '/linux26'))
972         proc = subprocess.Popen(["cp", kernel, release_target + '/linux26'])
973         proc.wait()
974
975     initrd = search_file('initrd.gz', iso_mount)
976     if initrd is None:
977         logging.critical("Fatal: initrd not found")
978     else:
979         logging.debug("cp %s %s" % (initrd, release_target + '/initrd.gz'))
980         proc = subprocess.Popen(["cp", initrd, release_target + '/initrd.gz'])
981         proc.wait()
982
983
984 def copy_grml_files(iso_mount, target):
985     """copy some minor grml files to a given target
986
987     @iso_mount: path where a grml ISO is mounted on
988     @target: path where grml's main files should be copied to"""
989
990     grml_target = target + '/grml/'
991     execute(mkdir, grml_target)
992
993     for myfile in 'grml-cheatcodes.txt', 'grml-version', 'LICENSE.txt', 'md5sums', 'README.txt':
994         grml_file = search_file(myfile, iso_mount)
995         if grml_file is None:
996             logging.warn("Warning: myfile %s could not be found - can not install it", myfile)
997         else:
998             logging.debug("cp %s %s" % (grml_file, grml_target + grml_file))
999             proc = subprocess.Popen(["cp", grml_file, grml_target + myfile])
1000             proc.wait()
1001
1002     grml_web_target = grml_target + '/web/'
1003     execute(mkdir, grml_web_target)
1004
1005     for myfile in 'index.html', 'style.css':
1006         grml_file = search_file(myfile, iso_mount)
1007         if grml_file is None:
1008             logging.warn("Warning: myfile %s could not be found - can not install it")
1009         else:
1010             logging.debug("cp %s %s" % (grml_file, grml_web_target + grml_file))
1011             proc = subprocess.Popen(["cp", grml_file, grml_web_target + myfile])
1012             proc.wait()
1013
1014     grml_webimg_target = grml_web_target + '/images/'
1015     execute(mkdir, grml_webimg_target)
1016
1017     for myfile in 'button.png', 'favicon.png', 'linux.jpg', 'logo.png':
1018         grml_file = search_file(myfile, iso_mount)
1019         if grml_file is None:
1020             logging.warn("Warning: myfile %s could not be found - can not install it")
1021         else:
1022             logging.debug("cp %s %s" % (grml_file, grml_webimg_target + grml_file))
1023             proc = subprocess.Popen(["cp", grml_file, grml_webimg_target + myfile])
1024             proc.wait()
1025
1026
1027 def copy_addons(iso_mount, target):
1028     """copy grml's addons files (like allinoneimg, bsd4grml,..) to a given target
1029
1030     @iso_mount: path where a grml ISO is mounted on
1031     @target: path where grml's main files should be copied to"""
1032
1033     addons = target + '/boot/addons/'
1034     execute(mkdir, addons)
1035
1036     # grub all-in-one image
1037     allinoneimg = search_file('allinone.img', iso_mount)
1038     if allinoneimg is None:
1039         logging.warn("Warning: allinone.img not found (that's fine if you don't need it")
1040     else:
1041         logging.debug("cp %s %s" % (allinoneimg, addons + '/allinone.img'))
1042         proc = subprocess.Popen(["cp", allinoneimg, addons + 'allinone.img'])
1043         proc.wait()
1044
1045     # bsd imag
1046     bsdimg = search_file('bsd4grml', iso_mount)
1047     if bsdimg is None:
1048         logging.warn("Warning: bsd4grml not found (that's fine if you don't need it")
1049     else:
1050         logging.debug("cp -a %s %s" % (bsdimg, addons + '/'))
1051         proc = subprocess.Popen(["cp", "-a", bsdimg, addons + '/'])
1052         proc.wait()
1053
1054     # freedos image
1055     balderimg = search_file('balder10.imz', iso_mount)
1056     if balderimg is None:
1057         logging.warn("Warning: balder10.imz not found (that's fine if you don't need it")
1058     else:
1059         logging.debug("cp %s %s" % (balderimg, addons + '/balder10.imz'))
1060         proc = subprocess.Popen(["cp", balderimg, addons + 'balder10.imz'])
1061         proc.wait()
1062
1063     # memdisk image
1064     memdiskimg = search_file('memdisk', iso_mount)
1065     if memdiskimg is None:
1066         logging.warn("Warning: memdisk not found (that's fine if you don't need it")
1067     else:
1068         logging.debug("cp %s %s" % (memdiskimg, addons + '/memdisk'))
1069         proc = subprocess.Popen(["cp", memdiskimg, addons + 'memdisk'])
1070         proc.wait()
1071
1072     # memtest86+ image
1073     memtestimg = search_file('memtest', iso_mount)
1074     if memtestimg is None:
1075         logging.warn("Warning: memtest not found (that's fine if you don't need it")
1076     else:
1077         logging.debug("cp %s %s" % (memtestimg, addons + '/memtest'))
1078         proc = subprocess.Popen(["cp", memtestimg, addons + 'memtest'])
1079         proc.wait()
1080
1081
1082 def copy_bootloader_files(iso_mount, target):
1083     """copy grml's bootloader files to a given target
1084
1085     @iso_mount: path where a grml ISO is mounted on
1086     @target: path where grml's main files should be copied to"""
1087
1088     syslinux_target = target + '/boot/syslinux/'
1089     execute(mkdir, syslinux_target)
1090
1091     logo = search_file('logo.16', iso_mount)
1092     logging.debug("cp %s %s" % (logo, syslinux_target + 'logo.16'))
1093     proc = subprocess.Popen(["cp", logo, syslinux_target + 'logo.16'])
1094     proc.wait()
1095
1096     for ffile in 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10':
1097         bootsplash = search_file(ffile, iso_mount)
1098         logging.debug("cp %s %s" % (bootsplash, syslinux_target + ffile))
1099         proc = subprocess.Popen(["cp", bootsplash, syslinux_target + ffile])
1100         proc.wait()
1101
1102     grub_target = target + '/boot/grub/'
1103     execute(mkdir, grub_target)
1104
1105     if not os.path.isfile("/usr/share/grml2usb/grub/splash.xpm.gz"):
1106         logging.critical("Error: /usr/share/grml2usb/grub/splash.xpm.gz can not be read.")
1107         logging.critical("Please make sure you've the grml2usb Debian package installed!")
1108         raise
1109     else:
1110         logging.debug("cp /usr/share/grml2usb/grub/splash.xpm.gz %s" % grub_target + 'splash.xpm.gz')
1111         proc = subprocess.Popen(["cp", '/usr/share/grml2usb/grub/splash.xpm.gz',
1112                                 grub_target + 'splash.xpm.gz'])
1113         proc.wait()
1114
1115     # grml splash in grub
1116     if os.path.isfile("/usr/share/grml2usb/grub/grml.png"):
1117         logging.debug("cp /usr/share/grml2usb/grub/grml.png to %s" % grub_target + 'grml.png')
1118         proc = subprocess.Popen(["cp", '/usr/share/grml2usb/grub/grml.png',
1119                                 grub_target + 'grml.png'])
1120         proc.wait()
1121
1122     # font file for graphical bootsplash in grub
1123     if os.path.isfile("/usr/share/grub/ascii.pff"):
1124         logging.debug("cp /usr/share/grub/ascii.pff to %s" % grub_target + 'ascii.pff')
1125         proc = subprocess.Popen(["cp", '/usr/share/grub/ascii.pff',
1126                                 grub_target + 'ascii.pff'])
1127         proc.wait()
1128
1129
1130 def install_iso_files(grml_flavour, iso_mount, device, target):
1131     """Copy files from ISO to given target
1132
1133     @grml_flavour: name of grml flavour the configuration should be generated for
1134     @iso_mount: path where a grml ISO is mounted on
1135     @device: device/partition where bootloader should be installed to
1136     @target: path where grml's main files should be copied to"""
1137
1138     # TODO => several improvements:
1139     # * make sure grml_flavour, iso_mount, target are set when the function is called, otherwise raise exception
1140     # * provide alternative search_file() if file information is stored in a config.ini file?
1141     # * catch "install: .. No space left on device" & CO
1142
1143     if options.dryrun:
1144         return 0
1145     elif not options.bootloaderonly:
1146         logging.info("Copying files. This might take a while....")
1147         copy_system_files(grml_flavour, iso_mount, target)
1148         copy_grml_files(iso_mount, target)
1149
1150     if not options.skipaddons:
1151         if grml_flavour.endswith('-small'):
1152             logging.info("Note: grml-small doesn't provide any addons, not installing them therefor.")
1153         else:
1154             copy_addons(iso_mount, target)
1155
1156     if not options.copyonly:
1157         copy_bootloader_files(iso_mount, target)
1158
1159         if not options.dryrun and not os.path.isdir(device):
1160             handle_bootloader_config(grml_flavour, device, target)
1161
1162     # make sure we sync filesystems before returning
1163     proc = subprocess.Popen(["sync"])
1164     proc.wait()
1165
1166
1167 def uninstall_files(device):
1168     """Get rid of all grml files on specified device
1169
1170     @device: partition where grml2usb files should be removed from"""
1171
1172     # TODO - not implemented yet
1173     logging.critical("TODO: uninstalling files from %s not yet implement, sorry." % device)
1174
1175
1176 def identify_grml_flavour(mountpath):
1177     """Get name of grml flavour
1178
1179     @mountpath: path where the grml ISO is mounted to
1180     @return: name of grml-flavour"""
1181
1182     version_file = search_file('grml-version', mountpath)
1183
1184     if version_file == "":
1185         logging.critical("Error: could not find grml-version file.")
1186         raise
1187
1188     try:
1189         tmpfile = open(version_file, 'r')
1190         grml_info = tmpfile.readline()
1191         grml_flavour = re.match(r'[\w-]*', grml_info).group()
1192     except TypeError:
1193         raise
1194     except:
1195         logging.critical("Unexpected error:", sys.exc_info()[0])
1196         raise
1197
1198     return grml_flavour
1199
1200
1201 def handle_grub1_config(grml_flavour, install_partition, grub_target, bootopt):
1202     """Main handler for generating grub1 configuration
1203
1204     @grml_flavour: name of grml flavour the configuration should be generated for
1205     @install_partition: partition number for use in (hd0,X)
1206     @grub_target: path of grub's configuration files
1207     @bootoptions: additional bootoptions that should be used by default"""
1208
1209     # grub1 config
1210     grub1_cfg = grub_target + 'menu.lst'
1211     logging.debug("Creating grub1 configuration file (menu.lst)")
1212
1213     # install main configuration only *once*, no matter how many ISOs we have:
1214     if os.path.isfile(grub1_cfg):
1215         string = open(grub1_cfg).readline()
1216         main_identifier = re.compile(".*main config generated at: %s.*" % re.escape(str(DATESTAMP)))
1217         if not re.match(main_identifier, string):
1218             grub1_config_file = open(grub1_cfg, 'w')
1219             grub1_config_file.write(generate_main_grub1_config(grml_flavour, install_partition, bootopt))
1220             grub1_config_file.close()
1221     else:
1222         grub1_config_file = open(grub1_cfg, 'w')
1223         grub1_config_file.write(generate_main_grub1_config(grml_flavour, install_partition, bootopt))
1224         grub1_config_file.close()
1225
1226     grub_flavour_config = True
1227     if os.path.isfile(grub1_cfg):
1228         string = open(grub1_cfg).readlines()
1229         flavour = re.compile("grml2usb for %s: %s" % (re.escape(grml_flavour), re.escape(str(DATESTAMP))))
1230         for line in string:
1231             if flavour.match(line):
1232                 grub_flavour_config = False
1233
1234     if grub_flavour_config:
1235         grub1_config_file = open(grub1_cfg, 'a')
1236         grub1_config_file.write(generate_flavour_specific_grub1_config(grml_flavour, install_partition, bootopt))
1237         grub1_config_file.close()
1238
1239
1240 def handle_grub2_config(grml_flavour, install_partition, grub_target, bootopt):
1241     """Main handler for generating grub2 configuration
1242
1243     @grml_flavour: name of grml flavour the configuration should be generated for
1244     @install_partition: partition number for use in (hd0,X)
1245     @grub_target: path of grub's configuration files
1246     @bootoptions: additional bootoptions that should be used by default"""
1247
1248     # grub2 config
1249     grub2_cfg = grub_target + 'grub.cfg'
1250     logging.debug("Creating grub2 configuration file (grub.lst)")
1251
1252     # install main configuration only *once*, no matter how many ISOs we have:
1253     grub_flavour_is_default = False
1254     if os.path.isfile(grub2_cfg):
1255         string = open(grub2_cfg).readline()
1256         main_identifier = re.compile(".*main config generated at: %s.*" % re.escape(str(DATESTAMP)))
1257         if not re.match(main_identifier, string):
1258             grub2_config_file = open(grub2_cfg, 'w')
1259             logging.info("Note: grml flavour %s is being installed as the default booting system." % grml_flavour)
1260             grub_flavour_is_default = True
1261             grub2_config_file.write(generate_main_grub2_config(grml_flavour, install_partition, bootopt))
1262             grub2_config_file.close()
1263     else:
1264         grub2_config_file = open(grub2_cfg, 'w')
1265         logging.info("Note: grml flavour %s is being installed as the default booting system." % grml_flavour)
1266         grub_flavour_is_default = True
1267         grub2_config_file.write(generate_main_grub2_config(grml_flavour, install_partition, bootopt))
1268         grub2_config_file.close()
1269
1270     # install flavour specific configuration only *once* as well
1271     grub_flavour_config = True
1272     if os.path.isfile(grub2_cfg):
1273         string = open(grub2_cfg).readlines()
1274         flavour = re.compile("grml2usb for %s: %s" % (re.escape(grml_flavour), re.escape(str(DATESTAMP))))
1275         for line in string:
1276             if flavour.match(line):
1277                 grub_flavour_config = False
1278
1279     if grub_flavour_config:
1280         grub2_config_file = open(grub2_cfg, 'a')
1281         # display only if the grml flavour isn't the default
1282         if not grub_flavour_is_default:
1283             logging.info("Note: you can boot flavour %s using '%s' on the commandline." % (grml_flavour, grml_flavour))
1284         grub2_config_file.write(generate_flavour_specific_grub2_config(grml_flavour, install_partition, bootopt))
1285         grub2_config_file.close()
1286
1287
1288 def handle_grub_config(grml_flavour, device, target):
1289     """Main handler for generating grub (v1 and v2) configuration
1290
1291     @grml_flavour: name of grml flavour the configuration should be generated for
1292     @device: device/partition where grub should be installed to
1293     @target: path of grub's configuration files"""
1294
1295     logging.debug("Generating grub configuration")
1296
1297     grub_target = target + '/boot/grub/'
1298     execute(mkdir, grub_target)
1299
1300     # we have to adjust root() inside grub configuration
1301     if device[-1:].isdigit():
1302         install_grub1_partition = int(device[-1:]) - 1
1303         install_grub2_partition = device[-1:]
1304     else:
1305         raise CriticalException("error validating partition schema (raw device?)")
1306
1307     # do NOT write "None" in kernel cmdline
1308     if options.bootoptions is None:
1309         bootopt = ""
1310     else:
1311         bootopt = options.bootoptions
1312
1313     # write menu.lst
1314     handle_grub1_config(grml_flavour, install_grub1_partition, grub_target, bootopt)
1315     # write grub.cfg
1316     handle_grub2_config(grml_flavour, install_grub2_partition, grub_target, bootopt)
1317
1318
1319 def handle_syslinux_config(grml_flavour, target):
1320     """Main handler for generating syslinux configuration
1321
1322     @grml_flavour: name of grml flavour the configuration should be generated for
1323     @target: path of syslinux's configuration files"""
1324
1325     # do NOT write "None" in kernel cmdline
1326     if options.bootoptions is None:
1327         bootopt = ""
1328     else:
1329         bootopt = options.bootoptions
1330
1331     logging.info("Generating syslinux configuration")
1332     syslinux_target = target + '/boot/syslinux/'
1333     # should be present via  copy_bootloader_files(), but make sure it exits:
1334     execute(mkdir, syslinux_target)
1335     syslinux_cfg = syslinux_target + 'syslinux.cfg'
1336
1337     # install main configuration only *once*, no matter how many ISOs we have:
1338     syslinux_flavour_is_default = False
1339     if os.path.isfile(syslinux_cfg):
1340         string = open(syslinux_cfg).readline()
1341         main_identifier = re.compile(".*main config generated at: %s.*" % re.escape(str(DATESTAMP)))
1342         if not re.match(main_identifier, string):
1343             syslinux_config_file = open(syslinux_cfg, 'w')
1344             logging.info("Note: grml flavour %s is being installed as the default booting system." % grml_flavour)
1345             syslinux_flavour_is_default = True
1346             syslinux_config_file.write(generate_main_syslinux_config(grml_flavour, bootopt))
1347             syslinux_config_file.close()
1348     else:
1349         syslinux_config_file = open(syslinux_cfg, 'w')
1350         logging.info("Note: grml flavour %s is being installed as the default booting system." % grml_flavour)
1351         syslinux_flavour_is_default = True
1352         syslinux_config_file.write(generate_main_syslinux_config(grml_flavour, bootopt))
1353         syslinux_config_file.close()
1354
1355     # install flavour specific configuration only *once* as well
1356     syslinux_flavour_config = True
1357     if os.path.isfile(syslinux_cfg):
1358         string = open(syslinux_cfg).readlines()
1359         flavour = re.compile("grml2usb for %s: %s" % (re.escape(grml_flavour), re.escape(str(DATESTAMP))))
1360         for line in string:
1361             if flavour.match(line):
1362                 syslinux_flavour_config = False
1363
1364     if syslinux_flavour_config:
1365         syslinux_config_file = open(syslinux_cfg, 'a')
1366         # display only if the grml flavour isn't the default
1367         if not syslinux_flavour_is_default:
1368             logging.info("Note: you can boot flavour %s using '%s' on the commandline." % (grml_flavour, grml_flavour))
1369         syslinux_config_file.write(generate_flavour_specific_syslinux_config(grml_flavour, bootopt))
1370         syslinux_config_file.close()
1371
1372     logging.debug("Generating isolinux/syslinux splash %s" % syslinux_target + 'boot.msg')
1373     isolinux_splash = open(syslinux_target + 'boot.msg', 'w')
1374     isolinux_splash.write(generate_isolinux_splash(grml_flavour))
1375     isolinux_splash.close()
1376
1377
1378 def handle_bootloader_config(grml_flavour, device, target):
1379     """Main handler for generating bootloader's configuration
1380
1381     @grml_flavour: name of grml flavour the configuration should be generated for
1382     @device: device/partition where bootloader should be installed to
1383     @target: path of bootloader's configuration files"""
1384
1385     if options.syslinux:
1386         handle_syslinux_config(grml_flavour, target)
1387     else:
1388         try:
1389             handle_grub_config(grml_flavour, device, target)
1390         except CriticalException, error:
1391             logging.critical("Fatal: %s" % error)
1392             sys.exit(1)
1393
1394
1395 def handle_iso(iso, device):
1396     """Main logic for mounting ISOs and copying files.
1397
1398     @iso: full path to the ISO that should be installed to the specified device
1399     @device: partition where the specified ISO should be installed to"""
1400
1401     logging.info("Using ISO %s" % iso)
1402
1403     if os.path.isdir(iso):
1404         logging.critical("TODO: /live/image handling not yet implemented - sorry")
1405         sys.exit(1)
1406
1407     iso_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
1408     register_tmpfile(iso_mountpoint)
1409     remove_iso_mountpoint = True
1410
1411     if not os.path.isfile(iso):
1412         logging.critical("Fatal: specified ISO %s could not be read" % iso)
1413         cleanup()
1414         sys.exit(1)
1415
1416     try:
1417         mount(iso, iso_mountpoint, ["-o", "loop", "-t", "iso9660"])
1418     except CriticalException, error:
1419         logging.critical("Fatal: %s" % error)
1420         sys.exit(1)
1421
1422     if os.path.isdir(device):
1423         logging.info("Specified target is a directory, not mounting therefor.")
1424         device_mountpoint = device
1425         remove_device_mountpoint = False
1426         # skip_mbr = True
1427     else:
1428         device_mountpoint = tempfile.mkdtemp(prefix="grml2usb")
1429         register_tmpfile(device_mountpoint)
1430         remove_device_mountpoint = True
1431         try:
1432             mount(device, device_mountpoint, "")
1433         except CriticalException, error:
1434             logging.critical("Fatal: %s" % error)
1435             cleanup()
1436             sys.exit(1)
1437
1438     try:
1439         grml_flavour = identify_grml_flavour(iso_mountpoint)
1440         logging.info("Identified grml flavour \"%s\"." % grml_flavour)
1441         install_iso_files(grml_flavour, iso_mountpoint, device, device_mountpoint)
1442     except TypeError:
1443         logging.critical("Fatal: a critical error happend during execution (not a grml ISO?), giving up")
1444         sys.exit(1)
1445     finally:
1446         if os.path.isdir(iso_mountpoint) and remove_iso_mountpoint:
1447             unmount(iso_mountpoint, "")
1448             os.rmdir(iso_mountpoint)
1449             unregister_tmpfile(iso_mountpoint)
1450         if remove_device_mountpoint:
1451             try:
1452                 unmount(device_mountpoint, "")
1453                 if os.path.isdir(device_mountpoint):
1454                     os.rmdir(device_mountpoint)
1455                     unregister_tmpfile(device_mountpoint)
1456             except CriticalException, error:
1457                 logging.critical("Fatal: %s" % error)
1458                 cleanup()
1459
1460
1461 def handle_mbr(device):
1462     """Main handler for installing master boot record (MBR)
1463
1464     @device: device where the MBR should be installed to"""
1465
1466     if options.dryrun:
1467         logging.info("Would install MBR")
1468         return 0
1469
1470     # make sure we have syslinux available
1471     if not options.skipmbr:
1472         if not which("syslinux") and not options.copyonly:
1473             logging.critical('Sorry, syslinux not available. Exiting.')
1474             logging.critical('Please install syslinux or consider using the --grub option.')
1475             sys.exit(1)
1476
1477     if not options.skipmbr:
1478         if device[-1:].isdigit():
1479             mbr_device = re.match(r'(.*?)\d*$', device).group(1)
1480             partition_number = int(device[-1:]) - 1
1481
1482         try:
1483             if options.syslinuxmbr:
1484                 handle_syslinux_mbr(mbr_device)
1485             else:
1486                 if options.mbrmenu:
1487                     install_mir_mbr('/usr/share/grml2usb/mbr/mbrmgr', mbr_device, partition_number, True)
1488                 else:
1489                     install_mir_mbr('/usr/share/grml2usb/mbr/mbrldr', mbr_device, partition_number, False)
1490         except IOError, error:
1491             logging.critical("Execution failed: %s", error)
1492             sys.exit(1)
1493         except Exception, error:
1494             logging.critical("Execution failed: %s", error)
1495             sys.exit(1)
1496
1497
1498 def handle_vfat(device):
1499     """Check for FAT specific settings and options
1500
1501     @device: device that should checked / formated"""
1502
1503     # make sure we have mkfs.vfat available
1504     if options.fat16 and not options.force:
1505         if not which("mkfs.vfat") and not options.copyonly and not options.dryrun:
1506             logging.critical('Sorry, mkfs.vfat not available. Exiting.')
1507             logging.critical('Please make sure to install dosfstools.')
1508             sys.exit(1)
1509
1510         # make sure the user is aware of what he is doing
1511         f = raw_input("Are you sure you want to format the specified partition with fat16? y/N ")
1512         if f == "y" or f == "Y":
1513             logging.info("Note: you can skip this question using the option --force")
1514             try:
1515                 mkfs_fat16(device)
1516             except CriticalException, error:
1517                 logging.critical("Execution failed: %s", error)
1518                 sys.exit(1)
1519         else:
1520             sys.exit(1)
1521
1522     # check for vfat filesystem
1523     if device is not None and not os.path.isdir(device):
1524         try:
1525             check_for_fat(device)
1526         except CriticalException, error:
1527             logging.critical("Execution failed: %s", error)
1528             sys.exit(1)
1529
1530     if not check_for_usbdevice(device) and not os.path.isdir(device):
1531         print "Warning: the specified device %s does not look like a removable usb device." % device
1532         f = raw_input("Do you really want to continue? y/N ")
1533         if f == "y" or f == "Y":
1534             pass
1535         else:
1536             sys.exit(1)
1537
1538
1539 def handle_compat_warning(device):
1540     """Backwards compatible checks
1541
1542     @device: device that should be checked"""
1543
1544     # make sure we can replace old grml2usb script and warn user when using old way of life:
1545     if device.startswith("/mnt/external") or device.startswith("/mnt/usb") and not options.force:
1546         print "Warning: the semantics of grml2usb has changed."
1547         print "Instead of using grml2usb /path/to/iso %s you might" % device
1548         print "want to use grml2usb /path/to/iso /dev/... instead."
1549         print "Please check out the grml2usb manpage for details."
1550         f = raw_input("Do you really want to continue? y/N ")
1551         if f == "y" or f == "Y":
1552             pass
1553         else:
1554             sys.exit(1)
1555
1556
1557 def handle_logging():
1558     """Log handling and configuration"""
1559
1560     if options.verbose:
1561         FORMAT = "Debug: %(asctime)-15s %(message)s"
1562         logging.basicConfig(level=logging.DEBUG, format=FORMAT)
1563     elif options.quiet:
1564         FORMAT = "Critical: %(message)s"
1565         logging.basicConfig(level=logging.CRITICAL, format=FORMAT)
1566     else:
1567         FORMAT = "%(message)s"
1568         logging.basicConfig(level=logging.INFO, format=FORMAT)
1569
1570
1571 def handle_bootloader(device):
1572     """wrapper for installing bootloader
1573
1574     @device: device where bootloader should be installed to"""
1575
1576     # Install bootloader only if not using the --copy-only option
1577     if options.copyonly:
1578         logging.info("Not installing bootloader and its files as requested via option copyonly.")
1579     elif os.path.isdir(device):
1580         logging.info("Not installing bootloader as %s is a directory." % device)
1581     else:
1582         install_bootloader(device)
1583
1584
1585 def main():
1586     """Main function [make pylint happy :)]"""
1587
1588     if options.version:
1589         print os.path.basename(sys.argv[0]) + " " + PROG_VERSION
1590         sys.exit(0)
1591
1592     if len(args) < 2:
1593         parser.error("invalid usage")
1594
1595     # log handling
1596     handle_logging()
1597
1598     # make sure we have the appropriate permissions
1599     check_uid_root()
1600
1601     if options.dryrun:
1602         logging.info("Running in simulation mode as requested via option dry-run.")
1603
1604     # specified arguments
1605     device = args[len(args) - 1]
1606     isos = args[0:len(args) - 1]
1607
1608     if not os.path.isdir(device):
1609         if device[-1:].isdigit():
1610             if int(device[-1:]) > 4:
1611                 logging.critical("Fatal: installation on partition number >4 not supported. (BIOS won't support it.)")
1612                 sys.exit(1)
1613         else:
1614              if os.path.exists(device):
1615                 logging.critical("Fatal: installation on raw device not supported. (BIOS won't support it.)")
1616                 sys.exit(1)
1617
1618     # provide upgrade path
1619     handle_compat_warning(device)
1620
1621     # check for vfat partition
1622     handle_vfat(device)
1623
1624     # main operation (like installing files)
1625     for iso in isos:
1626         handle_iso(iso, device)
1627
1628     # install mbr
1629     if not os.path.isdir(device):
1630         handle_mbr(device)
1631
1632     handle_bootloader(device)
1633
1634     # finally be politely :)
1635     logging.info("Finished execution of grml2usb (%s). Have fun with your grml system." % PROG_VERSION)
1636
1637
1638 if __name__ == "__main__":
1639     try:
1640         main()
1641     except KeyboardInterrupt:
1642         logging.info("Received KeyboardInterrupt")
1643         cleanup()
1644
1645 ## END OF FILE #################################################################
1646 # vim:foldmethod=indent expandtab ai ft=python tw=120 fileencoding=utf-8