#!/usr/bin/perl -w
# virt-edit
-# Copyright (C) 2009-2010 Red Hat Inc.
+# Copyright (C) 2009-2011 Red Hat Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
C<virt-edit> is a command line tool to edit C<file> where C<file>
exists in the named virtual machine (or disk image).
-If you want to just view a file, use L<virt-cat(1)>. For more complex
-cases you should look at the L<guestfish(1)> tool.
+If you want to just view a file, use L<virt-cat(1)>.
+
+For more complex cases you should look at the L<guestfish(1)> tool
+(see L</USING GUESTFISH> below).
+
+C<virt-edit> cannot be used to create a new file, nor to edit
+multiple files. L<guestfish(1)> can do that and much more.
=head1 EXAMPLES
virt-edit mydomain /etc/passwd
+For Windows guests, some Windows paths are understood:
+
+ virt-edit mywindomain 'c:\autoexec.bat'
+
You can also edit files non-interactively (see
L</NON-INTERACTIVE EDITING> below).
To change the init default level to 5:
die __x("{prog}: multiboot operating systems are not supported.\n",
prog => basename ($0))
}
-my %fses = $g->inspect_get_mountpoints ($roots[0]);
+my $root = $roots[0];
+my %fses = $g->inspect_get_mountpoints ($root);
my @fses = sort { length $a <=> length $b } keys %fses;
foreach (@fses) {
$g->mount_options ("", $fses{$_}, $_);
}
+# Special handling for Windows filenames.
+$filename = windows_path ($g, $root, $filename)
+ if $g->inspect_get_type ($root) eq "windows";
+
my ($fh, $tempname) = tempfile (UNLINK => 1);
my $fddev = "/dev/fd/" . fileno ($fh);
undef $g;
-exit 0;
-
=head1 NON-INTERACTIVE EDITING
C<virt-edit> normally calls out to C<$EDITOR> (or vi) so
my $m = $_; chomp $m; $m =~ /some text$/
+=head1 WINDOWS PATHS
+
+C<virt-edit> has a limited ability to understand Windows drive letters
+and paths (eg. C<E:\foo\bar.txt>).
+
+If and only if the guest is running Windows then:
+
+=over 4
+
+=item *
+
+Drive letter prefixes like C<C:> are resolved against the
+Windows Registry to the correct filesystem.
+
+=item *
+
+Any backslash (C<\>) characters in the path are replaced
+with forward slashes so that libguestfs can process it.
+
+=item *
+
+The path is resolved case insensitively to locate the file
+that should be edited.
+
+=back
+
+There are some known shortcomings:
+
+=over 4
+
+=item *
+
+Some NTFS symbolic links may not be followed correctly.
+
+=item *
+
+NTFS junction points that cross filesystems are not followed.
+
+=back
+
+=cut
+
+sub windows_path
+{
+ my $g = shift;
+ my $root = shift;
+ my $filename = shift;
+
+ # Deal with drive letters.
+ if ($filename =~ /^([a-z]):(.*)/i) {
+ $filename = $2;
+ my $drive_letter = $1;
+
+ # Look up the drive letter in the drive mapping table. We
+ # have to do a case insensitive comparison, the slow way.
+ my $device;
+ my %drives = $g->inspect_get_drive_mappings ($root);
+ foreach (keys %drives) {
+ if (lc $_ eq lc $drive_letter) {
+ $device = $drives{$_};
+ last;
+ }
+ }
+
+ die __x("virt-edit: drive '{x}:' not found\n", x => $drive_letter)
+ unless defined $device;
+
+ # Unmount current disk and remount $device.
+ $g->umount_all ();
+ $g->mount_options ("", $device, "/");
+ }
+
+ # Replace any backslashes in the rest of the path with
+ # forward slashes.
+ $filename =~ s{\\}{/}g;
+
+ # If the user put \foo on the command line without quoting it
+ # properly, then we'll see that here as a bare path. Add a more
+ # descriptive error message here.
+ if (substr ($filename, 0, 1) ne "/") {
+ die __x("virt-edit: '{f}' does not start with a / or \\ character.
+If you are using Windows style paths with backslashes like C:\\foo.txt
+then don't forget that you must quote them with single quotes to
+prevent the shell from munging the backslashes.\n",
+ f => $filename)
+ }
+
+ # Case sensitivity.
+ $filename = $g->case_sensitive_path ($filename);
+
+ return $filename;
+}
+
+=head1 USING GUESTFISH
+
+L<guestfish(1)> is a more powerful, lower level tool which you can use
+when C<virt-edit> doesn't work.
+
+Using C<virt-edit> is approximately equivalent to doing:
+
+ guestfish --rw -i -d domname edit /file
+
+where C<domname> is the name of the libvirt guest, and C</file> is the
+full path to the file.
+
+The command above uses libguestfs's guest inspection feature and so
+does not work on guests that libguestfs cannot inspect, or on things
+like arbitrary disk images that don't contain guests. To edit a file
+on a disk image directly, use:
+
+ guestfish --rw -a disk.img -m /dev/sda1 edit /file
+
+where C<disk.img> is the disk image, C</dev/sda1> is the filesystem
+within the disk image to edit, and C</file> is the full path to the
+file.
+
+C<virt-edit> cannot create new files. Use the guestfish commands
+C<touch>, C<write> or C<upload> instead:
+
+ guestfish --rw -i -d domname touch /newfile
+
+ guestfish --rw -i -d domname write /newfile "new content"
+
+ guestfish --rw -i -d domname upload localfile /newfile
+
+C<virt-edit> cannot edit multiple files, but guestfish can
+do it like this:
+
+ guestfish --rw -i -d domname edit /file1 : edit /file2
+
+=cut
+
+exit 0;
+
=head1 ENVIRONMENT VARIABLES
=over 4
=head1 COPYRIGHT
-Copyright (C) 2009-2010 Red Hat Inc.
+Copyright (C) 2009-2011 Red Hat Inc.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by