54e8f444eabf232ac61def69f121191814f5ade3
[libguestfs.git] / cat / virt-ls.c
1 /* virt-ls
2  * Copyright (C) 2010 Red Hat Inc.
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 #include <config.h>
20
21 #include <stdio.h>
22 #include <stdlib.h>
23 #include <inttypes.h>
24 #include <unistd.h>
25 #include <getopt.h>
26 #include <fcntl.h>
27 #include <locale.h>
28 #include <assert.h>
29
30 #include "progname.h"
31
32 #include "guestfs.h"
33 #include "options.h"
34
35 /* Currently open libguestfs handle. */
36 guestfs_h *g;
37
38 int read_only = 1;
39 int verbose = 0;
40 int keys_from_stdin = 0;
41 int echo_keys = 0;
42 const char *libvirt_uri = NULL;
43 int inspector = 1;
44
45 static inline char *
46 bad_cast (char const *s)
47 {
48   return (char *) s;
49 }
50
51 static void __attribute__((noreturn))
52 usage (int status)
53 {
54   if (status != EXIT_SUCCESS)
55     fprintf (stderr, _("Try `%s --help' for more information.\n"),
56              program_name);
57   else {
58     fprintf (stdout,
59            _("%s: list files in a virtual machine\n"
60              "Copyright (C) 2010 Red Hat Inc.\n"
61              "Usage:\n"
62              "  %s [--options] -d domname dir [dir ...]\n"
63              "  %s [--options] -a disk.img [-a disk.img ...] dir [dir ...]\n"
64              "Options:\n"
65              "  -a|--add image       Add image\n"
66              "  -c|--connect uri     Specify libvirt URI for -d option\n"
67              "  -d|--domain guest    Add disks from libvirt guest\n"
68              "  --echo-keys          Don't turn off echo for passphrases\n"
69              "  --format[=raw|..]    Force disk format for -a option\n"
70              "  --help               Display brief help\n"
71              "  --keys-from-stdin    Read passphrases from stdin\n"
72              "  -l|--long            Long listing\n"
73              "  -R|--recursive       Recursive listing\n"
74              "  -v|--verbose         Verbose messages\n"
75              "  -V|--version         Display version and exit\n"
76              "  -x                   Trace libguestfs API calls\n"
77              "For more information, see the manpage %s(1).\n"),
78              program_name, program_name, program_name,
79              program_name);
80   }
81   exit (status);
82 }
83
84 int
85 main (int argc, char *argv[])
86 {
87   /* Set global program name that is not polluted with libtool artifacts.  */
88   set_program_name (argv[0]);
89
90   setlocale (LC_ALL, "");
91   bindtextdomain (PACKAGE, LOCALEBASEDIR);
92   textdomain (PACKAGE);
93
94   enum { HELP_OPTION = CHAR_MAX + 1 };
95
96   static const char *options = "a:c:d:lRvVx";
97   static const struct option long_options[] = {
98     { "add", 1, 0, 'a' },
99     { "connect", 1, 0, 'c' },
100     { "domain", 1, 0, 'd' },
101     { "echo-keys", 0, 0, 0 },
102     { "format", 2, 0, 0 },
103     { "help", 0, 0, HELP_OPTION },
104     { "keys-from-stdin", 0, 0, 0 },
105     { "long", 0, 0, 'l' },
106     { "recursive", 0, 0, 'R' },
107     { "verbose", 0, 0, 'v' },
108     { "version", 0, 0, 'V' },
109     { 0, 0, 0, 0 }
110   };
111   struct drv *drvs = NULL;
112   struct drv *drv;
113   const char *format = NULL;
114   int c;
115   int option_index;
116   char mode = 0;
117
118   g = guestfs_create ();
119   if (g == NULL) {
120     fprintf (stderr, _("guestfs_create: failed to create handle\n"));
121     exit (EXIT_FAILURE);
122   }
123
124   argv[0] = bad_cast (program_name);
125
126   for (;;) {
127     c = getopt_long (argc, argv, options, long_options, &option_index);
128     if (c == -1) break;
129
130     switch (c) {
131     case 0:                     /* options which are long only */
132       if (STREQ (long_options[option_index].name, "keys-from-stdin")) {
133         keys_from_stdin = 1;
134       } else if (STREQ (long_options[option_index].name, "echo-keys")) {
135         echo_keys = 1;
136       } else if (STREQ (long_options[option_index].name, "format")) {
137         if (!optarg || STREQ (optarg, ""))
138           format = NULL;
139         else
140           format = optarg;
141       } else {
142         fprintf (stderr, _("%s: unknown long option: %s (%d)\n"),
143                  program_name, long_options[option_index].name, option_index);
144         exit (EXIT_FAILURE);
145       }
146       break;
147
148     case 'a':
149       OPTION_a;
150       break;
151
152     case 'c':
153       OPTION_c;
154       break;
155
156     case 'd':
157       OPTION_d;
158       break;
159
160     case 'h':
161       usage (EXIT_SUCCESS);
162
163     case 'l':
164       mode = 'l';
165       break;
166
167     case 'R':
168       mode = 'R';
169       break;
170
171     case 'v':
172       OPTION_v;
173       break;
174
175     case 'V':
176       OPTION_V;
177       break;
178
179     case 'x':
180       OPTION_x;
181       break;
182
183     case HELP_OPTION:
184       usage (EXIT_SUCCESS);
185
186     default:
187       usage (EXIT_FAILURE);
188     }
189   }
190
191   /* Old-style syntax?  There were no -a or -d options in the old
192    * virt-ls which is how we detect this.
193    */
194   if (drvs == NULL) {
195     /* argc - 1 because last parameter is the single directory name. */
196     while (optind < argc - 1) {
197       if (strchr (argv[optind], '/') ||
198           access (argv[optind], F_OK) == 0) { /* simulate -a option */
199         drv = malloc (sizeof (struct drv));
200         if (!drv) {
201           perror ("malloc");
202           exit (EXIT_FAILURE);
203         }
204         drv->type = drv_a;
205         drv->a.filename = argv[optind];
206         drv->a.format = NULL;
207         drv->next = drvs;
208         drvs = drv;
209       } else {                  /* simulate -d option */
210         drv = malloc (sizeof (struct drv));
211         if (!drv) {
212           perror ("malloc");
213           exit (EXIT_FAILURE);
214         }
215         drv->type = drv_d;
216         drv->d.guest = argv[optind];
217         drv->next = drvs;
218         drvs = drv;
219       }
220
221       optind++;
222     }
223   }
224
225   /* These are really constants, but they have to be variables for the
226    * options parsing code.  Assert here that they have known-good
227    * values.
228    */
229   assert (read_only == 1);
230   assert (inspector == 1);
231
232   /* User must specify at least one directory name on the command line. */
233   if (optind >= argc || argc - optind < 1)
234     usage (EXIT_FAILURE);
235
236   /* User must have specified some drives. */
237   if (drvs == NULL)
238     usage (EXIT_FAILURE);
239
240   /* Add drives, inspect and mount.  Note that inspector is always true,
241    * and there is no -m option.
242    */
243   add_drives (drvs, 'a');
244
245   if (guestfs_launch (g) == -1)
246     exit (EXIT_FAILURE);
247
248   inspect_mount ();
249
250   /* Free up data structures, no longer needed after this point. */
251   free_drives (drvs);
252
253   unsigned errors = 0;
254
255   while (optind < argc) {
256     const char *dir = argv[optind];
257
258     if (mode == 0) {
259       char **lines;
260       size_t i;
261
262       if ((lines = guestfs_ls (g, dir)) == NULL)
263         errors++;
264       else {
265         for (i = 0; lines[i] != NULL; ++i) {
266           printf ("%s\n", lines[i]);
267           free (lines[i]);
268         }
269         free (lines);
270       }
271     }
272     else if (mode == 'l') {
273       char *out;
274
275       if ((out = guestfs_ll (g, dir)) == NULL)
276         errors++;
277       else {
278         printf ("%s", out);
279         free (out);
280       }
281     }
282     else if (mode == 'R') {
283       /* This is TMP_TEMPLATE_ON_STACK expanded from fish.h. */
284       const char *tmpdir = guestfs_tmpdir ();
285       char tmpfile[strlen (tmpdir) + 32];
286       sprintf (tmpfile, "%s/virtlsXXXXXX", tmpdir);
287
288       int fd = mkstemp (tmpfile);
289       if (fd == -1) {
290         perror ("mkstemp");
291         exit (EXIT_FAILURE);
292       }
293
294       char buf[BUFSIZ]; /* also used below */
295       snprintf (buf, sizeof buf, "/dev/fd/%d", fd);
296
297       if (guestfs_find0 (g, dir, buf) == -1)
298         errors++;
299       else {
300         if (close (fd) == -1) {
301           perror (tmpfile);
302           exit (EXIT_FAILURE);
303         }
304
305         /* The output of find0 is a \0-separated file.  Turn each \0 into
306          * a \n character.
307          */
308         fd = open (tmpfile, O_RDONLY);
309         if (fd == -1) {
310           perror (tmpfile);
311           exit (EXIT_FAILURE);
312         }
313
314         ssize_t r;
315         while ((r = read (fd, buf, sizeof buf)) > 0) {
316           size_t i;
317           for (i = 0; i < (size_t) r; ++i)
318             if (buf[i] == '\0')
319               buf[i] = '\n';
320
321           size_t n = r;
322           while (n > 0) {
323             r = write (1, buf, n);
324             if (r == -1) {
325               perror ("write");
326               exit (EXIT_FAILURE);
327             }
328             n -= r;
329           }
330         }
331
332         if (r == -1 || close (fd) == -1) {
333           perror (tmpfile);
334           exit (EXIT_FAILURE);
335         }
336       }
337
338       unlink (tmpfile);
339     }
340     optind++;
341   }
342
343   guestfs_close (g);
344
345   exit (errors == 0 ? EXIT_SUCCESS : EXIT_FAILURE);
346 }