daemon: Move 'exists', 'is-file' and 'is-dir' to separate file.
[libguestfs.git] / daemon / file.c
1 /* libguestfs - the guestfsd daemon
2  * Copyright (C) 2009 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 <string.h>
24 #include <unistd.h>
25 #include <fcntl.h>
26 #include <sys/stat.h>
27
28 #include "../src/guestfs_protocol.h"
29 #include "daemon.h"
30 #include "actions.h"
31
32 int
33 do_touch (const char *path)
34 {
35   int fd;
36   int r;
37   struct stat buf;
38
39   /* RHBZ#582484: Restrict touch to regular files.  It's also OK
40    * here if the file does not exist, since we will create it.
41    */
42   CHROOT_IN;
43   r = lstat (path, &buf);
44   CHROOT_OUT;
45
46   if (r == -1) {
47     if (errno != ENOENT) {
48       reply_with_perror ("lstat: %s", path);
49       return -1;
50     }
51   } else {
52     if (! S_ISREG (buf.st_mode)) {
53       reply_with_error ("%s: touch can only be used on a regular files", path);
54       return -1;
55     }
56   }
57
58   CHROOT_IN;
59   fd = open (path, O_WRONLY | O_CREAT | O_NOCTTY, 0666);
60   CHROOT_OUT;
61
62   if (fd == -1) {
63     reply_with_perror ("open: %s", path);
64     return -1;
65   }
66
67   r = futimens (fd, NULL);
68   if (r == -1) {
69     reply_with_perror ("futimens: %s", path);
70     close (fd);
71     return -1;
72   }
73
74   if (close (fd) == -1) {
75     reply_with_perror ("close: %s", path);
76     return -1;
77   }
78
79   return 0;
80 }
81
82 char *
83 do_cat (const char *path)
84 {
85   int fd;
86   int alloc, size, r, max;
87   char *buf, *buf2;
88
89   CHROOT_IN;
90   fd = open (path, O_RDONLY);
91   CHROOT_OUT;
92
93   if (fd == -1) {
94     reply_with_perror ("open: %s", path);
95     return NULL;
96   }
97
98   /* Read up to GUESTFS_MESSAGE_MAX - <overhead> bytes.  If it's
99    * larger than that, we need to return an error instead (for
100    * correctness).
101    */
102   max = GUESTFS_MESSAGE_MAX - 1000;
103   buf = NULL;
104   size = alloc = 0;
105
106   for (;;) {
107     if (size >= alloc) {
108       alloc += 8192;
109       if (alloc > max) {
110         reply_with_error ("%s: file is too large for message buffer",
111                           path);
112         free (buf);
113         close (fd);
114         return NULL;
115       }
116       buf2 = realloc (buf, alloc);
117       if (buf2 == NULL) {
118         reply_with_perror ("realloc");
119         free (buf);
120         close (fd);
121         return NULL;
122       }
123       buf = buf2;
124     }
125
126     r = read (fd, buf + size, alloc - size);
127     if (r == -1) {
128       reply_with_perror ("read: %s", path);
129       free (buf);
130       close (fd);
131       return NULL;
132     }
133     if (r == 0) {
134       buf[size] = '\0';
135       break;
136     }
137     if (r > 0)
138       size += r;
139   }
140
141   if (close (fd) == -1) {
142     reply_with_perror ("close: %s", path);
143     free (buf);
144     return NULL;
145   }
146
147   return buf;                   /* caller will free */
148 }
149
150 char **
151 do_read_lines (const char *path)
152 {
153   char **r = NULL;
154   int size = 0, alloc = 0;
155   FILE *fp;
156   char *line = NULL;
157   size_t len = 0;
158   ssize_t n;
159
160   CHROOT_IN;
161   fp = fopen (path, "r");
162   CHROOT_OUT;
163
164   if (!fp) {
165     reply_with_perror ("fopen: %s", path);
166     return NULL;
167   }
168
169   while ((n = getline (&line, &len, fp)) != -1) {
170     /* Remove either LF or CRLF. */
171     if (n >= 2 && line[n-2] == '\r' && line[n-1] == '\n')
172       line[n-2] = '\0';
173     else if (n >= 1 && line[n-1] == '\n')
174       line[n-1] = '\0';
175
176     if (add_string (&r, &size, &alloc, line) == -1) {
177       free (line);
178       fclose (fp);
179       return NULL;
180     }
181   }
182
183   free (line);
184
185   if (add_string (&r, &size, &alloc, NULL) == -1) {
186     fclose (fp);
187     return NULL;
188   }
189
190   if (fclose (fp) == EOF) {
191     reply_with_perror ("fclose: %s", path);
192     free_strings (r);
193     return NULL;
194   }
195
196   return r;
197 }
198
199 int
200 do_rm (const char *path)
201 {
202   int r;
203
204   CHROOT_IN;
205   r = unlink (path);
206   CHROOT_OUT;
207
208   if (r == -1) {
209     reply_with_perror ("%s", path);
210     return -1;
211   }
212
213   return 0;
214 }
215
216 int
217 do_chmod (int mode, const char *path)
218 {
219   int r;
220
221   if (mode < 0) {
222     reply_with_error ("%s: mode is negative", path);
223     return -1;
224   }
225
226   CHROOT_IN;
227   r = chmod (path, mode);
228   CHROOT_OUT;
229
230   if (r == -1) {
231     reply_with_perror ("%s: 0%o", path, mode);
232     return -1;
233   }
234
235   return 0;
236 }
237
238 int
239 do_chown (int owner, int group, const char *path)
240 {
241   int r;
242
243   CHROOT_IN;
244   r = chown (path, owner, group);
245   CHROOT_OUT;
246
247   if (r == -1) {
248     reply_with_perror ("%s: %d.%d", path, owner, group);
249     return -1;
250   }
251
252   return 0;
253 }
254
255 int
256 do_lchown (int owner, int group, const char *path)
257 {
258   int r;
259
260   CHROOT_IN;
261   r = lchown (path, owner, group);
262   CHROOT_OUT;
263
264   if (r == -1) {
265     reply_with_perror ("%s: %d.%d", path, owner, group);
266     return -1;
267   }
268
269   return 0;
270 }
271
272 int
273 do_write_file (const char *path, const char *content, int size)
274 {
275   int fd;
276
277   /* This call is deprecated, and it has a broken interface.  New code
278    * should use the 'guestfs_write' call instead.  Because we used an
279    * XDR string type, 'content' cannot contain ASCII NUL and 'size'
280    * must never be longer than the string.  We must check this to
281    * ensure random stuff from XDR or daemon memory isn't written to
282    * the file (RHBZ#597135).
283    */
284   if (size < 0) {
285     reply_with_error ("size cannot be negative");
286     return -1;
287   }
288
289   /* Note content_len must be small because of the limits on protocol
290    * message size.
291    */
292   int content_len = (int) strlen (content);
293
294   if (size == 0)
295     size = content_len;
296   else if (size > content_len) {
297     reply_with_error ("size parameter is larger than string content");
298     return -1;
299   }
300
301   CHROOT_IN;
302   fd = open (path, O_WRONLY | O_TRUNC | O_CREAT | O_NOCTTY, 0666);
303   CHROOT_OUT;
304
305   if (fd == -1) {
306     reply_with_perror ("open: %s", path);
307     return -1;
308   }
309
310   if (xwrite (fd, content, size) == -1) {
311     reply_with_perror ("write");
312     close (fd);
313     return -1;
314   }
315
316   if (close (fd) == -1) {
317     reply_with_perror ("close: %s", path);
318     return -1;
319   }
320
321   return 0;
322 }
323
324 int
325 do_write (const char *path, const char *content, size_t size)
326 {
327   int fd;
328
329   CHROOT_IN;
330   fd = open (path, O_WRONLY | O_TRUNC | O_CREAT | O_NOCTTY, 0666);
331   CHROOT_OUT;
332
333   if (fd == -1) {
334     reply_with_perror ("open: %s", path);
335     return -1;
336   }
337
338   if (xwrite (fd, content, size) == -1) {
339     reply_with_perror ("write");
340     close (fd);
341     return -1;
342   }
343
344   if (close (fd) == -1) {
345     reply_with_perror ("close: %s", path);
346     return -1;
347   }
348
349   return 0;
350 }
351
352 char *
353 do_read_file (const char *path, size_t *size_r)
354 {
355   int fd;
356   struct stat statbuf;
357   char *r;
358
359   CHROOT_IN;
360   fd = open (path, O_RDONLY);
361   CHROOT_OUT;
362
363   if (fd == -1) {
364     reply_with_perror ("open: %s", path);
365     return NULL;
366   }
367
368   if (fstat (fd, &statbuf) == -1) {
369     reply_with_perror ("fstat: %s", path);
370     close (fd);
371     return NULL;
372   }
373
374   /* The actual limit on messages is smaller than this.  This
375    * check just limits the amount of memory we'll try and allocate
376    * here.  If the message is larger than the real limit, that will
377    * be caught later when we try to serialize the message.
378    */
379   if (statbuf.st_size >= GUESTFS_MESSAGE_MAX) {
380     reply_with_error ("%s: file is too large for the protocol, use guestfs_download instead", path);
381     close (fd);
382     return NULL;
383   }
384   r = malloc (statbuf.st_size);
385   if (r == NULL) {
386     reply_with_perror ("malloc");
387     close (fd);
388     return NULL;
389   }
390
391   if (xread (fd, r, statbuf.st_size) == -1) {
392     reply_with_perror ("read: %s", path);
393     close (fd);
394     free (r);
395     return NULL;
396   }
397
398   if (close (fd) == -1) {
399     reply_with_perror ("close: %s", path);
400     free (r);
401     return NULL;
402   }
403
404   /* Mustn't touch *size_r until we are sure that we won't return any
405    * error (RHBZ#589039).
406    */
407   *size_r = statbuf.st_size;
408   return r;
409 }
410
411 char *
412 do_pread (const char *path, int count, int64_t offset, size_t *size_r)
413 {
414   int fd;
415   ssize_t r;
416   char *buf;
417
418   /* The actual limit on messages is smaller than this.  This check
419    * just limits the amount of memory we'll try and allocate in the
420    * function.  If the message is larger than the real limit, that
421    * will be caught later when we try to serialize the message.
422    */
423   if (count >= GUESTFS_MESSAGE_MAX) {
424     reply_with_error ("%s: count is too large for the protocol, use smaller reads", path);
425     return NULL;
426   }
427
428   CHROOT_IN;
429   fd = open (path, O_RDONLY);
430   CHROOT_OUT;
431
432   if (fd == -1) {
433     reply_with_perror ("open: %s", path);
434     return NULL;
435   }
436
437   buf = malloc (count);
438   if (buf == NULL) {
439     reply_with_perror ("malloc");
440     close (fd);
441     return NULL;
442   }
443
444   r = pread (fd, buf, count, offset);
445   if (r == -1) {
446     reply_with_perror ("pread: %s", path);
447     close (fd);
448     free (buf);
449     return NULL;
450   }
451
452   if (close (fd) == -1) {
453     reply_with_perror ("close: %s", path);
454     close (fd);
455     free (buf);
456     return NULL;
457   }
458
459   /* Mustn't touch *size_r until we are sure that we won't return any
460    * error (RHBZ#589039).
461    */
462   *size_r = r;
463   return buf;
464 }
465
466 int
467 do_pwrite (const char *path, const char *content, size_t size, int64_t offset)
468 {
469   int fd;
470   ssize_t r;
471
472   CHROOT_IN;
473   fd = open (path, O_WRONLY);
474   CHROOT_OUT;
475
476   if (fd == -1) {
477     reply_with_perror ("open: %s", path);
478     return -1;
479   }
480
481   r = pwrite (fd, content, size, offset);
482   if (r == -1) {
483     reply_with_perror ("pwrite: %s", path);
484     close (fd);
485     return -1;
486   }
487
488   if (close (fd) == -1) {
489     reply_with_perror ("close: %s", path);
490     close (fd);
491     return -1;
492   }
493
494   return r;
495 }
496
497 /* This runs the 'file' command. */
498 char *
499 do_file (const char *path)
500 {
501   char *buf = NULL;
502   const char *display_path = path;
503
504   int is_dev = STRPREFIX (path, "/dev/");
505
506   if (!is_dev) {
507     buf = sysroot_path (path);
508     if (!buf) {
509       reply_with_perror ("malloc");
510       return NULL;
511     }
512     path = buf;
513
514     /* For non-dev, check this is a regular file, else just return the
515      * file type as a string (RHBZ#582484).
516      */
517     struct stat statbuf;
518     if (lstat (path, &statbuf) == -1) {
519       reply_with_perror ("lstat: %s", display_path);
520       free (buf);
521       return NULL;
522     }
523
524     if (! S_ISREG (statbuf.st_mode)) {
525       char *ret;
526
527       free (buf);
528
529       if (S_ISDIR (statbuf.st_mode))
530         ret = strdup ("directory");
531       else if (S_ISCHR (statbuf.st_mode))
532         ret = strdup ("character device");
533       else if (S_ISBLK (statbuf.st_mode))
534         ret = strdup ("block device");
535       else if (S_ISFIFO (statbuf.st_mode))
536         ret = strdup ("FIFO");
537       else if (S_ISLNK (statbuf.st_mode))
538         ret = strdup ("symbolic link");
539       else if (S_ISSOCK (statbuf.st_mode))
540         ret = strdup ("socket");
541       else
542         ret = strdup ("unknown, not regular file");
543
544       if (ret == NULL)
545         reply_with_perror ("strdup");
546       return ret;
547     }
548   }
549
550   /* Which flags to use?  For /dev paths, follow links because
551    * /dev/VG/LV is a symbolic link.
552    */
553   const char *flags = is_dev ? "-zbsL" : "-zb";
554
555   char *out, *err;
556   int r = command (&out, &err, "file", flags, path, NULL);
557   free (buf);
558
559   if (r == -1) {
560     free (out);
561     reply_with_error ("%s: %s", display_path, err);
562     free (err);
563     return NULL;
564   }
565   free (err);
566
567   /* We need to remove the trailing \n from output of file(1). */
568   size_t len = strlen (out);
569   if (len > 0 && out[len-1] == '\n')
570     out[len-1] = '\0';
571
572   return out;                   /* caller frees */
573 }
574
575 /* zcat | file */
576 char *
577 do_zfile (const char *method, const char *path)
578 {
579   int len;
580   const char *zcat;
581   char *cmd;
582   FILE *fp;
583   char line[256];
584
585   if (STREQ (method, "gzip") || STREQ (method, "compress"))
586     zcat = "zcat";
587   else if (STREQ (method, "bzip2"))
588     zcat = "bzcat";
589   else {
590     reply_with_error ("unknown method");
591     return NULL;
592   }
593
594   if (asprintf_nowarn (&cmd, "%s %R | file -bsL -", zcat, path) == -1) {
595     reply_with_perror ("asprintf");
596     return NULL;
597   }
598
599   if (verbose)
600     fprintf (stderr, "%s\n", cmd);
601
602   fp = popen (cmd, "r");
603   if (fp == NULL) {
604     reply_with_perror ("%s", cmd);
605     free (cmd);
606     return NULL;
607   }
608
609   free (cmd);
610
611   if (fgets (line, sizeof line, fp) == NULL) {
612     reply_with_perror ("fgets");
613     fclose (fp);
614     return NULL;
615   }
616
617   if (fclose (fp) == -1) {
618     reply_with_perror ("fclose");
619     return NULL;
620   }
621
622   len = strlen (line);
623   if (len > 0 && line[len-1] == '\n')
624     line[len-1] = '\0';
625
626   return strdup (line);
627 }
628
629 int64_t
630 do_filesize (const char *path)
631 {
632   int r;
633   struct stat buf;
634
635   CHROOT_IN;
636   r = stat (path, &buf);        /* follow symlinks */
637   CHROOT_OUT;
638
639   if (r == -1) {
640     reply_with_perror ("%s", path);
641     return -1;
642   }
643
644   return buf.st_size;
645 }