2
* Copyright (c) 2003-2007 Tim Kientzle
3
* Copyright (c) 2008 Joerg Sonnenberger
6
* Redistribution and use in source and binary forms, with or without
7
* modification, are permitted provided that the following conditions
9
* 1. Redistributions of source code must retain the above copyright
10
* notice, this list of conditions and the following disclaimer.
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.
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.
27
#include "archive_platform.h"
28
__FBSDID("$FreeBSD: head/lib/libarchive/archive_write_set_format_shar.c 189438 2009-03-06 05:58:56Z kientzle $");
42
#include "archive_entry.h"
43
#include "archive_private.h"
44
#include "archive_write_private.h"
49
struct archive_entry *entry;
53
/* Line buffer for uuencoded dump format */
58
struct archive_string work;
59
struct archive_string quoted_name;
62
static int archive_write_shar_finish(struct archive_write *);
63
static int archive_write_shar_destroy(struct archive_write *);
64
static int archive_write_shar_header(struct archive_write *,
65
struct archive_entry *);
66
static ssize_t archive_write_shar_data_sed(struct archive_write *,
67
const void * buff, size_t);
68
static ssize_t archive_write_shar_data_uuencode(struct archive_write *,
69
const void * buff, size_t);
70
static int archive_write_shar_finish_entry(struct archive_write *);
73
* Copy the given string to the buffer, quoting all shell meta characters
77
shar_quote(struct archive_string *buf, const char *str, int in_shell)
79
static const char meta[] = "\n \t'`\";&<>()|*?{}[]\\$!#^~";
82
while (*str != '\0') {
83
if ((len = strcspn(str, meta)) != 0) {
84
archive_strncat(buf, str, len);
86
} else if (*str == '\n') {
88
archive_strcat(buf, "\"\n\"");
90
archive_strcat(buf, "\\n");
93
archive_strappend_char(buf, '\\');
94
archive_strappend_char(buf, *str);
101
* Set output format to 'shar' format.
104
archive_write_set_format_shar(struct archive *_a)
106
struct archive_write *a = (struct archive_write *)_a;
109
/* If someone else was already registered, unregister them. */
110
if (a->format_destroy != NULL)
111
(a->format_destroy)(a);
113
shar = (struct shar *)malloc(sizeof(*shar));
115
archive_set_error(&a->archive, ENOMEM, "Can't allocate shar data");
116
return (ARCHIVE_FATAL);
118
memset(shar, 0, sizeof(*shar));
119
archive_string_init(&shar->work);
120
archive_string_init(&shar->quoted_name);
121
a->format_data = shar;
123
a->pad_uncompressed = 0;
124
a->format_name = "shar";
125
a->format_write_header = archive_write_shar_header;
126
a->format_finish = archive_write_shar_finish;
127
a->format_destroy = archive_write_shar_destroy;
128
a->format_write_data = archive_write_shar_data_sed;
129
a->format_finish_entry = archive_write_shar_finish_entry;
130
a->archive.archive_format = ARCHIVE_FORMAT_SHAR_BASE;
131
a->archive.archive_format_name = "shar";
136
* An alternate 'shar' that uses uudecode instead of 'sed' to encode
137
* file contents and can therefore be used to archive binary files.
138
* In addition, this variant also attempts to restore ownership, file modes,
139
* and other extended file information.
142
archive_write_set_format_shar_dump(struct archive *_a)
144
struct archive_write *a = (struct archive_write *)_a;
147
archive_write_set_format_shar(&a->archive);
148
shar = (struct shar *)a->format_data;
150
a->format_write_data = archive_write_shar_data_uuencode;
151
a->archive.archive_format = ARCHIVE_FORMAT_SHAR_DUMP;
152
a->archive.archive_format_name = "shar dump";
157
archive_write_shar_header(struct archive_write *a, struct archive_entry *entry)
159
const char *linkname;
164
shar = (struct shar *)a->format_data;
165
if (!shar->wrote_header) {
166
archive_strcat(&shar->work, "#!/bin/sh\n");
167
archive_strcat(&shar->work, "# This is a shell archive\n");
168
shar->wrote_header = 1;
171
/* Save the entry for the closing. */
173
archive_entry_free(shar->entry);
174
shar->entry = archive_entry_clone(entry);
175
name = archive_entry_pathname(entry);
177
/* Handle some preparatory issues. */
178
switch(archive_entry_filetype(entry)) {
180
/* Only regular files have non-zero size. */
183
archive_entry_set_size(entry, 0);
184
/* Don't bother trying to recreate '.' */
185
if (strcmp(name, ".") == 0 || strcmp(name, "./") == 0)
191
/* All other file types have zero size in the archive. */
192
archive_entry_set_size(entry, 0);
195
archive_entry_set_size(entry, 0);
196
if (archive_entry_hardlink(entry) == NULL &&
197
archive_entry_symlink(entry) == NULL) {
198
archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
199
"shar format cannot archive this");
200
return (ARCHIVE_WARN);
204
archive_string_empty(&shar->quoted_name);
205
shar_quote(&shar->quoted_name, name, 1);
207
/* Stock preparation for all file types. */
208
archive_string_sprintf(&shar->work, "echo x %s\n", shar->quoted_name.s);
210
if (archive_entry_filetype(entry) != AE_IFDIR) {
211
/* Try to create the dir. */
213
pp = strrchr(p, '/');
214
/* If there is a / character, try to create the dir. */
218
/* Try to avoid a lot of redundant mkdir commands. */
219
if (strcmp(p, ".") == 0) {
220
/* Don't try to "mkdir ." */
222
} else if (shar->last_dir == NULL) {
223
archive_strcat(&shar->work, "mkdir -p ");
224
shar_quote(&shar->work, p, 1);
225
archive_strcat(&shar->work,
226
" > /dev/null 2>&1\n");
228
} else if (strcmp(p, shar->last_dir) == 0) {
229
/* We've already created this exact dir. */
231
} else if (strlen(p) < strlen(shar->last_dir) &&
232
strncmp(p, shar->last_dir, strlen(p)) == 0) {
233
/* We've already created a subdir. */
236
archive_strcat(&shar->work, "mkdir -p ");
237
shar_quote(&shar->work, p, 1);
238
archive_strcat(&shar->work,
239
" > /dev/null 2>&1\n");
247
/* Handle file-type specific issues. */
249
if ((linkname = archive_entry_hardlink(entry)) != NULL) {
250
archive_strcat(&shar->work, "ln -f ");
251
shar_quote(&shar->work, linkname, 1);
252
archive_string_sprintf(&shar->work, " %s\n",
253
shar->quoted_name.s);
254
} else if ((linkname = archive_entry_symlink(entry)) != NULL) {
255
archive_strcat(&shar->work, "ln -fs ");
256
shar_quote(&shar->work, linkname, 1);
257
archive_string_sprintf(&shar->work, " %s\n",
258
shar->quoted_name.s);
260
switch(archive_entry_filetype(entry)) {
262
if (archive_entry_size(entry) == 0) {
263
/* More portable than "touch." */
264
archive_string_sprintf(&shar->work,
265
"test -e \"%s\" || :> \"%s\"\n",
266
shar->quoted_name.s, shar->quoted_name.s);
269
archive_string_sprintf(&shar->work,
270
"uudecode -p > %s << 'SHAR_END'\n",
271
shar->quoted_name.s);
272
archive_string_sprintf(&shar->work,
274
archive_entry_mode(entry) & 0777);
275
shar_quote(&shar->work, name, 0);
276
archive_strcat(&shar->work, "\n");
278
archive_string_sprintf(&shar->work,
279
"sed 's/^X//' > %s << 'SHAR_END'\n",
280
shar->quoted_name.s);
283
shar->end_of_line = 1;
288
archive_string_sprintf(&shar->work,
289
"mkdir -p %s > /dev/null 2>&1\n",
290
shar->quoted_name.s);
291
/* Record that we just created this directory. */
292
if (shar->last_dir != NULL)
293
free(shar->last_dir);
295
shar->last_dir = strdup(name);
296
/* Trim a trailing '/'. */
297
pp = strrchr(shar->last_dir, '/');
298
if (pp != NULL && pp[1] == '\0')
301
* TODO: Put dir name/mode on a list to be fixed
302
* up at end of archive.
306
archive_string_sprintf(&shar->work,
307
"mkfifo %s\n", shar->quoted_name.s);
310
archive_string_sprintf(&shar->work,
311
"mknod %s c %d %d\n", shar->quoted_name.s,
312
archive_entry_rdevmajor(entry),
313
archive_entry_rdevminor(entry));
316
archive_string_sprintf(&shar->work,
317
"mknod %s b %d %d\n", shar->quoted_name.s,
318
archive_entry_rdevmajor(entry),
319
archive_entry_rdevminor(entry));
322
return (ARCHIVE_WARN);
330
archive_write_shar_data_sed(struct archive_write *a, const void *buff, size_t n)
332
static const size_t ensured = 65533;
339
shar = (struct shar *)a->format_data;
340
if (!shar->has_data || n == 0)
343
src = (const char *)buff;
346
* ensure is the number of bytes in buffer before expanding the
347
* current character. Each operation writes the current character
348
* and optionally the start-of-new-line marker. This can happen
349
* twice before entering the loop, so make sure three additional
350
* bytes can be written.
352
if (archive_string_ensure(&shar->work, ensured + 3) == NULL)
353
__archive_errx(1, "Out of memory");
355
if (shar->work.length > ensured) {
356
ret = (*a->compressor.write)(a, shar->work.s,
358
if (ret != ARCHIVE_OK)
359
return (ARCHIVE_FATAL);
360
archive_string_empty(&shar->work);
362
buf = shar->work.s + shar->work.length;
363
buf_end = shar->work.s + ensured;
365
if (shar->end_of_line) {
367
shar->end_of_line = 0;
371
if ((*buf++ = *src++) == '\n') {
373
shar->end_of_line = 1;
378
if (buf >= buf_end) {
379
shar->work.length = buf - shar->work.s;
380
ret = (*a->compressor.write)(a, shar->work.s,
382
if (ret != ARCHIVE_OK)
383
return (ARCHIVE_FATAL);
384
archive_string_empty(&shar->work);
389
shar->work.length = buf - shar->work.s;
394
#define UUENC(c) (((c)!=0) ? ((c) & 077) + ' ': '`')
397
uuencode_group(const char _in[3], char out[4])
399
const unsigned char *in = (const unsigned char *)_in;
402
t = (in[0] << 16) | (in[1] << 8) | in[2];
403
out[0] = UUENC( 0x3f & (t >> 18) );
404
out[1] = UUENC( 0x3f & (t >> 12) );
405
out[2] = UUENC( 0x3f & (t >> 6) );
406
out[3] = UUENC( 0x3f & t );
410
uuencode_line(struct shar *shar, const char *inbuf, size_t len)
412
char tmp_buf[3], *buf;
415
/* len <= 45 -> expanded to 60 + len byte + new line */
416
alloc_len = shar->work.length + 62;
417
if (archive_string_ensure(&shar->work, alloc_len) == NULL)
418
__archive_errx(1, "Out of memory");
420
buf = shar->work.s + shar->work.length;
423
uuencode_group(inbuf, buf);
429
tmp_buf[0] = inbuf[0];
433
tmp_buf[1] = inbuf[1];
435
uuencode_group(tmp_buf, buf);
439
if ((buf - shar->work.s) > (ptrdiff_t)(shar->work.length + 62))
440
__archive_errx(1, "Buffer overflow");
441
shar->work.length = buf - shar->work.s;
445
archive_write_shar_data_uuencode(struct archive_write *a, const void *buff,
453
shar = (struct shar *)a->format_data;
456
src = (const char *)buff;
458
if (shar->outpos != 0) {
459
n = 45 - shar->outpos;
462
memcpy(shar->outbuff + shar->outpos, src, n);
463
if (shar->outpos + n < 45) {
467
uuencode_line(shar, shar->outbuff, 45);
475
uuencode_line(shar, src, 45);
479
if (shar->work.length < 65536)
481
ret = (*a->compressor.write)(a, shar->work.s,
483
if (ret != ARCHIVE_OK)
484
return (ARCHIVE_FATAL);
485
archive_string_empty(&shar->work);
488
memcpy(shar->outbuff, src, n);
495
archive_write_shar_finish_entry(struct archive_write *a)
497
const char *g, *p, *u;
501
shar = (struct shar *)a->format_data;
502
if (shar->entry == NULL)
506
/* Finish uuencoded data. */
507
if (shar->has_data) {
508
if (shar->outpos > 0)
509
uuencode_line(shar, shar->outbuff,
511
archive_strcat(&shar->work, "`\nend\n");
512
archive_strcat(&shar->work, "SHAR_END\n");
514
/* Restore file mode, owner, flags. */
516
* TODO: Don't immediately restore mode for
517
* directories; defer that to end of script.
519
archive_string_sprintf(&shar->work, "chmod %o ",
520
archive_entry_mode(shar->entry) & 07777);
521
shar_quote(&shar->work, archive_entry_pathname(shar->entry), 1);
522
archive_strcat(&shar->work, "\n");
524
u = archive_entry_uname(shar->entry);
525
g = archive_entry_gname(shar->entry);
526
if (u != NULL || g != NULL) {
527
archive_strcat(&shar->work, "chown ");
529
shar_quote(&shar->work, u, 1);
531
archive_strcat(&shar->work, ":");
532
shar_quote(&shar->work, g, 1);
534
shar_quote(&shar->work,
535
archive_entry_pathname(shar->entry), 1);
536
archive_strcat(&shar->work, "\n");
539
if ((p = archive_entry_fflags_text(shar->entry)) != NULL) {
540
archive_string_sprintf(&shar->work, "chflags %s ",
541
p, archive_entry_pathname(shar->entry));
542
shar_quote(&shar->work,
543
archive_entry_pathname(shar->entry), 1);
544
archive_strcat(&shar->work, "\n");
547
/* TODO: restore ACLs */
550
if (shar->has_data) {
551
/* Finish sed-encoded data: ensure last line ends. */
552
if (!shar->end_of_line)
553
archive_strappend_char(&shar->work, '\n');
554
archive_strcat(&shar->work, "SHAR_END\n");
558
archive_entry_free(shar->entry);
561
if (shar->work.length < 65536)
564
ret = (*a->compressor.write)(a, shar->work.s, shar->work.length);
565
if (ret != ARCHIVE_OK)
566
return (ARCHIVE_FATAL);
567
archive_string_empty(&shar->work);
573
archive_write_shar_finish(struct archive_write *a)
579
* TODO: Accumulate list of directory names/modes and
580
* fix them all up at end-of-archive.
583
shar = (struct shar *)a->format_data;
586
* Only write the end-of-archive markers if the archive was
587
* actually started. This avoids problems if someone sets
588
* shar format, then sets another format (which would invoke
589
* shar_finish to free the format-specific data).
591
if (shar->wrote_header == 0)
594
archive_strcat(&shar->work, "exit\n");
596
ret = (*a->compressor.write)(a, shar->work.s, shar->work.length);
597
if (ret != ARCHIVE_OK)
598
return (ARCHIVE_FATAL);
600
/* Shar output is never padded. */
601
archive_write_set_bytes_in_last_block(&a->archive, 1);
603
* TODO: shar should also suppress padding of
604
* uncompressed data within gzip/bzip2 streams.
611
archive_write_shar_destroy(struct archive_write *a)
615
shar = (struct shar *)a->format_data;
619
archive_entry_free(shar->entry);
620
free(shar->last_dir);
621
archive_string_free(&(shar->work));
622
archive_string_free(&(shar->quoted_name));
624
a->format_data = NULL;
added
removed
src/libarchive/libarchive/archive_write_set_format_shar.c
