From 4dd6b77ff7037ee220b530cefb412ace3d880f61 Mon Sep 17 00:00:00 2001 From: Richard Jones Date: Mon, 19 Oct 2009 12:16:00 +0100 Subject: [PATCH] New tool: virt-ls This tool makes available the functionality of "ls", "ll", and "find" in a slightly simpler to use form. Examples: virt-ls -l myguest /tmp --- .gitignore | 1 + Makefile.am | 1 + guestfish.pod | 1 + po/POTFILES.in | 1 + tools/Makefile.am | 2 +- tools/virt-ls | 234 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 6 files changed, 239 insertions(+), 1 deletion(-) create mode 100755 tools/virt-ls diff --git a/.gitignore b/.gitignore index 507f9f1..3c3b956 100644 --- a/.gitignore +++ b/.gitignore @@ -73,6 +73,7 @@ html/virt-cat.1.html html/virt-df.1.html html/virt-edit.1.html html/virt-inspector.1.html +html/virt-ls.1.html html/virt-rescue.1.html html/virt-tar.1.html images/100kallnewlines diff --git a/Makefile.am b/Makefile.am index f4d4dd1..9663449 100644 --- a/Makefile.am +++ b/Makefile.am @@ -168,6 +168,7 @@ all-local: -name 'virt-df' -o \ -name 'virt-edit' -o \ -name 'virt-inspector' -o \ + -name 'virt-ls' -o \ -name 'virt-rescue' -o \ -name 'virt-tar' | \ grep -v '^perl/blib/' | \ diff --git a/guestfish.pod b/guestfish.pod index 66d9914..e4b2333 100644 --- a/guestfish.pod +++ b/guestfish.pod @@ -604,6 +604,7 @@ L, L, L, L, +L, L, L. diff --git a/po/POTFILES.in b/po/POTFILES.in index 2017c5f..57cce91 100644 --- a/po/POTFILES.in +++ b/po/POTFILES.in @@ -87,5 +87,6 @@ test-tool/test-tool.c tools/virt-cat tools/virt-df tools/virt-edit +tools/virt-ls tools/virt-rescue tools/virt-tar diff --git a/tools/Makefile.am b/tools/Makefile.am index b6f95d2..f593d46 100644 --- a/tools/Makefile.am +++ b/tools/Makefile.am @@ -15,7 +15,7 @@ # along with this program; if not, write to the Free Software # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. -tools = cat df edit rescue tar +tools = cat df edit ls rescue tar EXTRA_DIST = \ run-locally \ diff --git a/tools/virt-ls b/tools/virt-ls new file mode 100755 index 0000000..7e489a2 --- /dev/null +++ b/tools/virt-ls @@ -0,0 +1,234 @@ +#!/usr/bin/perl -w +# virt-ls +# Copyright (C) 2009 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 +# the Free Software Foundation; either version 2 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, write to the Free Software +# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + +use warnings; +use strict; + +use Sys::Guestfs; +use Sys::Guestfs::Lib qw(open_guest get_partitions resolve_windows_path + inspect_all_partitions inspect_partition + inspect_operating_systems mount_operating_system); +use Pod::Usage; +use Getopt::Long; +use Locale::TextDomain 'libguestfs'; + +=encoding utf8 + +=head1 NAME + +virt-ls - List files in a virtual machine + +=head1 SYNOPSIS + + virt-ls [--options] domname directory + + virt-ls [--options] disk.img [disk.img ...] directory + +=head1 DESCRIPTION + +C is a command line tool to list the names of files in a +directory inside a virtual machine or disk image. + +C is just a simple wrapper around L +functionality. For more complex cases you should look at the +L tool. + +C can be used in one of three modes: simple, long and +recursive. A simple listing is like the ordinary L command: + + $ virt-ls myguest / + bin + boot + [etc.] + +With the C<-l> (C<--long>) option, C shows more detail: + + $ virt-ls -l myguest / + total 204 + dr-xr-xr-x. 2 root root 4096 2009-08-25 19:06 bin + dr-xr-xr-x. 5 root root 3072 2009-08-25 19:06 boot + [etc.] + +With the C<-R> (C<--recursive>) option, C lists the +names of files and directories recursively: + + $ virt-ls -R myguest /tmp + foo + foo/bar + [etc.] + +You I combine these options. To do more complicated things, +use L. + +=head1 OPTIONS + +=over 4 + +=cut + +my $help; + +=item B<--help> + +Display brief help. + +=cut + +my $version; + +=item B<--version> + +Display version number and exit. + +=cut + +my $uri; + +=item B<--connect URI> | B<-c URI> + +If using libvirt, connect to the given I. If omitted, then we +connect to the default libvirt hypervisor. + +If you specify guest block devices directly, then libvirt is not used +at all. + +=cut + +my $mode; + +=item B<-l> | B<--long> + +=item B<-R> | B<--recursive> + +Select the mode. With neither of these options, C +produces a simple, flat list of the files in the named directory. + +C produces a "long listing", which shows more detail (just +like the plain C command). + +C produces a recursive list of files starting at the named +directory. See the documentation for the C command +L for precise details. + +You cannot combine these options. + +=back + +=cut + +sub set_mode_l +{ + die __"virt-ls: cannot combine -l and -R options\n" if $mode; + $mode = "l"; +} + +sub set_mode_R +{ + die __"virt-ls: cannot combine -l and -R options\n" if $mode; + $mode = "R"; +} + +GetOptions ("help|?" => \$help, + "version" => \$version, + "connect|c=s" => \$uri, + "long|l" => \&set_mode_l, + "recursive|R" => \&set_mode_R, + ) or pod2usage (2); +pod2usage (1) if $help; +if ($version) { + my $g = Sys::Guestfs->new (); + my %h = $g->version (); + print "$h{major}.$h{minor}.$h{release}$h{extra}\n"; + exit +} + +pod2usage (__"virt-ls: no image, VM names or directory to list given") + if @ARGV <= 1; + +my $directory = pop @ARGV; + +my $g; +if ($uri) { + $g = open_guest (\@ARGV, address => $uri); +} else { + $g = open_guest (\@ARGV); +} + +$g->launch (); + +# List of possible filesystems. +my @partitions = get_partitions ($g); + +# Now query each one to build up a picture of what's in it. +my %fses = + inspect_all_partitions ($g, \@partitions, + use_windows_registry => 0); + +my $oses = inspect_operating_systems ($g, \%fses); + +my @roots = keys %$oses; +die __"no root device found in this operating system image\n" if @roots == 0; +die __"multiboot operating systems are not supported by virt-ls\n" if @roots > 1; +my $root_dev = $roots[0]; + +my $os = $oses->{$root_dev}; +mount_operating_system ($g, $os); + +my @r; +unless ($mode) { + @r = $g->ls ($directory); + print "$_\n" foreach @r; +} elsif ($mode eq "l") { + print ($g->ll ($directory)); +} else { # $mode eq "R" + @r = $g->find ($directory); + print "$_\n" foreach @r; +} + +=head1 SEE ALSO + +L, +L, +L, +L, +L, +L, +L, +L. + +=head1 AUTHOR + +Richard W.M. Jones L + +=head1 COPYRIGHT + +Copyright (C) 2009 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 +the Free Software Foundation; either version 2 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. -- 1.8.3.1