1 /*-
2  * Copyright (c) 2003-2009 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  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17  * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25 #include "archive_platform.h"
26 __FBSDID("$FreeBSD: head/lib/libarchive/archive_read_support_format_raw.c 201107 2009-12-28 03:25:33Z kientzle $");
27 
28 #ifdef HAVE_ERRNO_H
29 #include <errno.h>
30 #endif
31 #include <stdio.h>
32 #ifdef HAVE_STDLIB_H
33 #include <stdlib.h>
34 #endif
35 
36 #include "archive.h"
37 #include "archive_entry.h"
38 #include "archive_private.h"
39 #include "archive_read_private.h"
40 
41 struct raw_info {
42 	int64_t offset; /* Current position in the file. */
43 	int64_t unconsumed;
44 	int     end_of_file;
45 };
46 
47 static int	archive_read_format_raw_bid(struct archive_read *, int);
48 static int	archive_read_format_raw_cleanup(struct archive_read *);
49 static int	archive_read_format_raw_read_data(struct archive_read *,
50 		    const void **, size_t *, int64_t *);
51 static int	archive_read_format_raw_read_data_skip(struct archive_read *);
52 static int	archive_read_format_raw_read_header(struct archive_read *,
53 		    struct archive_entry *);
54 
55 int
56 archive_read_support_format_raw(struct archive *_a)
57 {
58 	struct raw_info *info;
59 	struct archive_read *a = (struct archive_read *)_a;
60 	int r;
61 
62 	archive_check_magic(_a, ARCHIVE_READ_MAGIC,
63 	    ARCHIVE_STATE_NEW, "archive_read_support_format_raw");
64 
65 	info = (struct raw_info *)calloc(1, sizeof(*info));
66 	if (info == NULL) {
67 		archive_set_error(&a->archive, ENOMEM,
68 		    "Can't allocate raw_info data");
69 		return (ARCHIVE_FATAL);
70 	}
71 
72 	r = __archive_read_register_format(a,
73 	    info,
74 	    "raw",
75 	    archive_read_format_raw_bid,
76 	    NULL,
77 	    archive_read_format_raw_read_header,
78 	    archive_read_format_raw_read_data,
79 	    archive_read_format_raw_read_data_skip,
80 	    NULL,
81 	    archive_read_format_raw_cleanup);
82 	if (r != ARCHIVE_OK)
83 		free(info);
84 	return (r);
85 }
86 
87 /*
88  * Bid 1 if this is a non-empty file.  Anyone who can really support
89  * this should outbid us, so it should generally be safe to use "raw"
90  * in conjunction with other formats.  But, this could really confuse
91  * folks if there are bid errors or minor file damage, so we don't
92  * include "raw" as part of support_format_all().
93  */
94 static int
95 archive_read_format_raw_bid(struct archive_read *a, int best_bid)
96 {
97 	if (best_bid < 1 && __archive_read_ahead(a, 1, NULL) != NULL)
98 		return (1);
99 	return (-1);
100 }
101 
102 /*
103  * Mock up a fake header.
104  */
105 static int
106 archive_read_format_raw_read_header(struct archive_read *a,
107     struct archive_entry *entry)
108 {
109 	struct raw_info *info;
110 
111 	info = (struct raw_info *)(a->format->data);
112 	if (info->end_of_file)
113 		return (ARCHIVE_EOF);
114 
115 	a->archive.archive_format = ARCHIVE_FORMAT_RAW;
116 	a->archive.archive_format_name = "raw";
117 	archive_entry_set_pathname(entry, "data");
118 	archive_entry_set_filetype(entry, AE_IFREG);
119 	archive_entry_set_perm(entry, 0644);
120 	/* I'm deliberately leaving most fields unset here. */
121 	return (ARCHIVE_OK);
122 }
123 
124 static int
125 archive_read_format_raw_read_data(struct archive_read *a,
126     const void **buff, size_t *size, int64_t *offset)
127 {
128 	struct raw_info *info;
129 	ssize_t avail;
130 
131 	info = (struct raw_info *)(a->format->data);
132 
133 	/* Consume the bytes we read last time. */
134 	if (info->unconsumed) {
135 		__archive_read_consume(a, info->unconsumed);
136 		info->unconsumed = 0;
137 	}
138 
139 	if (info->end_of_file)
140 		return (ARCHIVE_EOF);
141 
142 	/* Get whatever bytes are immediately available. */
143 	*buff = __archive_read_ahead(a, 1, &avail);
144 	if (avail > 0) {
145 		/* Return the bytes we just read */
146 		*size = avail;
147 		*offset = info->offset;
148 		info->offset += *size;
149 		info->unconsumed = avail;
150 		return (ARCHIVE_OK);
151 	} else if (0 == avail) {
152 		/* Record and return end-of-file. */
153 		info->end_of_file = 1;
154 		*size = 0;
155 		*offset = info->offset;
156 		return (ARCHIVE_EOF);
157 	} else {
158 		/* Record and return an error. */
159 		*size = 0;
160 		*offset = info->offset;
161 		return ((int)avail);
162 	}
163 }
164 
165 static int
166 archive_read_format_raw_read_data_skip(struct archive_read *a)
167 {
168 	struct raw_info *info = (struct raw_info *)(a->format->data);
169 
170 	/* Consume the bytes we read last time. */
171 	if (info->unconsumed) {
172 		__archive_read_consume(a, info->unconsumed);
173 		info->unconsumed = 0;
174 	}
175 	info->end_of_file = 1;
176 	return (ARCHIVE_OK);
177 }
178 
179 static int
180 archive_read_format_raw_cleanup(struct archive_read *a)
181 {
182 	struct raw_info *info;
183 
184 	info = (struct raw_info *)(a->format->data);
185 	free(info);
186 	a->format->data = NULL;
187 	return (ARCHIVE_OK);
188 }
189