Document the recently added WITHOUT_SRCS variable.
[dragonfly.git] / contrib / libarchive / archive_read_open_file.c
1 /*-
2  * Copyright (c) 2003-2004 Tim Kientzle
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer
10  *    in this position and unchanged.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #include "archive_platform.h"
28 __FBSDID("$FreeBSD: src/lib/libarchive/archive_read_open_file.c,v 1.8 2005/03/13 01:51:16 kientzle Exp $");
29
30 #include <sys/stat.h>
31 #include <errno.h>
32 #include <fcntl.h>
33 #include <stdlib.h>
34 #include <string.h>
35 #include <unistd.h>
36
37 #include "archive.h"
38 #include "archive_private.h"
39
40 struct read_file_data {
41         int      fd;
42         size_t   block_size;
43         void    *buffer;
44         mode_t   st_mode;  /* Mode bits for opened file. */
45         char     filename[1]; /* Must be last! */
46 };
47
48 static int      file_close(struct archive *, void *);
49 static int      file_open(struct archive *, void *);
50 static ssize_t  file_read(struct archive *, void *, const void **buff);
51
52 int
53 archive_read_open_file(struct archive *a, const char *filename,
54     size_t block_size)
55 {
56         struct read_file_data *mine;
57
58         if (filename == NULL || filename[0] == '\0') {
59                 mine = malloc(sizeof(*mine));
60                 if (mine == NULL) {
61                         archive_set_error(a, ENOMEM, "No memory");
62                         return (ARCHIVE_FATAL);
63                 }
64                 mine->filename[0] = '\0';
65         } else {
66                 mine = malloc(sizeof(*mine) + strlen(filename));
67                 if (mine == NULL) {
68                         archive_set_error(a, ENOMEM, "No memory");
69                         return (ARCHIVE_FATAL);
70                 }
71                 strcpy(mine->filename, filename);
72         }
73         mine->block_size = block_size;
74         mine->buffer = NULL;
75         mine->fd = -1;
76         return (archive_read_open(a, mine, file_open, file_read, file_close));
77 }
78
79 static int
80 file_open(struct archive *a, void *client_data)
81 {
82         struct read_file_data *mine = client_data;
83         struct stat st;
84
85         mine->buffer = malloc(mine->block_size);
86         if (mine->filename[0] != '\0')
87                 mine->fd = open(mine->filename, O_RDONLY);
88         else
89                 mine->fd = 0; /* Fake "open" for stdin. */
90         if (mine->fd < 0) {
91                 archive_set_error(a, errno, "Failed to open '%s'",
92                     mine->filename);
93                 return (ARCHIVE_FATAL);
94         }
95         if (fstat(mine->fd, &st) == 0) {
96                 /* Set dev/ino of archive file so extract won't overwrite. */
97                 a->skip_file_dev = st.st_dev;
98                 a->skip_file_ino = st.st_ino;
99                 /* Remember mode so close can decide whether to flush. */
100                 mine->st_mode = st.st_mode;
101         } else {
102                 if (mine->filename[0] == '\0')
103                         archive_set_error(a, errno, "Can't stat stdin");
104                 else
105                         archive_set_error(a, errno, "Can't stat '%s'",
106                             mine->filename);
107                 return (ARCHIVE_FATAL);
108         }
109         return (0);
110 }
111
112 static ssize_t
113 file_read(struct archive *a, void *client_data, const void **buff)
114 {
115         struct read_file_data *mine = client_data;
116         ssize_t bytes_read;
117
118         (void)a; /* UNUSED */
119         *buff = mine->buffer;
120         bytes_read = read(mine->fd, mine->buffer, mine->block_size);
121         if (bytes_read < 0) {
122                 if (mine->filename[0] == '\0')
123                         archive_set_error(a, errno, "Error reading stdin");
124                 else
125                         archive_set_error(a, errno, "Error reading '%s'",
126                             mine->filename);
127         }
128         return (bytes_read);
129 }
130
131 static int
132 file_close(struct archive *a, void *client_data)
133 {
134         struct read_file_data *mine = client_data;
135
136         (void)a; /* UNUSED */
137
138         /*
139          * Sometimes, we should flush the input before closing.
140          *   Regular files: faster to just close without flush.
141          *   Devices: must not flush (user might need to
142          *      read the "next" item on a non-rewind device).
143          *   Pipes and sockets:  must flush (otherwise, the
144          *      program feeding the pipe or socket may complain).
145          * Here, I flush everything except for regular files and
146          * device nodes.
147          */
148         if (!S_ISREG(mine->st_mode)
149             && !S_ISCHR(mine->st_mode)
150             && !S_ISBLK(mine->st_mode)) {
151                 ssize_t bytesRead;
152                 do {
153                         bytesRead = read(mine->fd, mine->buffer,
154                             mine->block_size);
155                 } while (bytesRead > 0);
156         }
157         /* If a named file was opened, then it needs to be closed. */
158         if (mine->filename[0] != '\0')
159                 close(mine->fd);
160         if (mine->buffer != NULL)
161                 free(mine->buffer);
162         free(mine);
163         return (ARCHIVE_OK);
164 }