Blame libarchive/archive_write_add_filter_uuencode.c

Packit 08bd4c
/*-
Packit 08bd4c
 * Copyright (c) 2012 Michihiro NAKAJIMA
Packit 08bd4c
 * All rights reserved.
Packit 08bd4c
 *
Packit 08bd4c
 * Redistribution and use in source and binary forms, with or without
Packit 08bd4c
 * modification, are permitted provided that the following conditions
Packit 08bd4c
 * are met:
Packit 08bd4c
 * 1. Redistributions of source code must retain the above copyright
Packit 08bd4c
 *    notice, this list of conditions and the following disclaimer.
Packit 08bd4c
 * 2. Redistributions in binary form must reproduce the above copyright
Packit 08bd4c
 *    notice, this list of conditions and the following disclaimer in the
Packit 08bd4c
 *    documentation and/or other materials provided with the distribution.
Packit 08bd4c
 *
Packit 08bd4c
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
Packit 08bd4c
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
Packit 08bd4c
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
Packit 08bd4c
 * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
Packit 08bd4c
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
Packit 08bd4c
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
Packit 08bd4c
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
Packit 08bd4c
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
Packit 08bd4c
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
Packit 08bd4c
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Packit 08bd4c
 */
Packit 08bd4c
Packit 08bd4c
#include "archive_platform.h"
Packit 08bd4c
Packit 08bd4c
__FBSDID("$FreeBSD$");
Packit 08bd4c
Packit 08bd4c
#ifdef HAVE_ERRNO_H
Packit 08bd4c
#include <errno.h>
Packit 08bd4c
#endif
Packit 08bd4c
#ifdef HAVE_STDLIB_H
Packit 08bd4c
#include <stdlib.h>
Packit 08bd4c
#endif
Packit 08bd4c
#ifdef HAVE_STRING_H
Packit 08bd4c
#include <string.h>
Packit 08bd4c
#endif
Packit 08bd4c
Packit 08bd4c
#include "archive.h"
Packit 08bd4c
#include "archive_private.h"
Packit 08bd4c
#include "archive_string.h"
Packit 08bd4c
#include "archive_write_private.h"
Packit 08bd4c
Packit 08bd4c
#define LBYTES 45
Packit 08bd4c
Packit 08bd4c
struct private_uuencode {
Packit 08bd4c
	int			mode;
Packit 08bd4c
	struct archive_string	name;
Packit 08bd4c
	struct archive_string	encoded_buff;
Packit 08bd4c
	size_t			bs;
Packit 08bd4c
	size_t			hold_len;
Packit 08bd4c
	unsigned char		hold[LBYTES];
Packit 08bd4c
};
Packit 08bd4c
Packit 08bd4c
static int archive_filter_uuencode_options(struct archive_write_filter *,
Packit 08bd4c
    const char *, const char *);
Packit 08bd4c
static int archive_filter_uuencode_open(struct archive_write_filter *);
Packit 08bd4c
static int archive_filter_uuencode_write(struct archive_write_filter *,
Packit 08bd4c
    const void *, size_t);
Packit 08bd4c
static int archive_filter_uuencode_close(struct archive_write_filter *);
Packit 08bd4c
static int archive_filter_uuencode_free(struct archive_write_filter *);
Packit 08bd4c
static void uu_encode(struct archive_string *, const unsigned char *, size_t);
Packit 08bd4c
static int64_t atol8(const char *, size_t);
Packit 08bd4c
Packit 08bd4c
/*
Packit 08bd4c
 * Add a compress filter to this write handle.
Packit 08bd4c
 */
Packit 08bd4c
int
Packit 08bd4c
archive_write_add_filter_uuencode(struct archive *_a)
Packit 08bd4c
{
Packit 08bd4c
	struct archive_write *a = (struct archive_write *)_a;
Packit 08bd4c
	struct archive_write_filter *f = __archive_write_allocate_filter(_a);
Packit 08bd4c
	struct private_uuencode *state;
Packit 08bd4c
Packit 08bd4c
	archive_check_magic(&a->archive, ARCHIVE_WRITE_MAGIC,
Packit 08bd4c
	    ARCHIVE_STATE_NEW, "archive_write_add_filter_uu");
Packit 08bd4c
Packit 08bd4c
	state = (struct private_uuencode *)calloc(1, sizeof(*state));
Packit 08bd4c
	if (state == NULL) {
Packit 08bd4c
		archive_set_error(f->archive, ENOMEM,
Packit 08bd4c
		    "Can't allocate data for uuencode filter");
Packit 08bd4c
		return (ARCHIVE_FATAL);
Packit 08bd4c
	}
Packit 08bd4c
	archive_strcpy(&state->name, "-");
Packit 08bd4c
	state->mode = 0644;
Packit 08bd4c
Packit 08bd4c
	f->data = state;
Packit 08bd4c
	f->name = "uuencode";
Packit 08bd4c
	f->code = ARCHIVE_FILTER_UU;
Packit 08bd4c
	f->open = archive_filter_uuencode_open;
Packit 08bd4c
	f->options = archive_filter_uuencode_options;
Packit 08bd4c
	f->write = archive_filter_uuencode_write;
Packit 08bd4c
	f->close = archive_filter_uuencode_close;
Packit 08bd4c
	f->free = archive_filter_uuencode_free;
Packit 08bd4c
Packit 08bd4c
	return (ARCHIVE_OK);
Packit 08bd4c
}
Packit 08bd4c
Packit 08bd4c
/*
Packit 08bd4c
 * Set write options.
Packit 08bd4c
 */
Packit 08bd4c
static int
Packit 08bd4c
archive_filter_uuencode_options(struct archive_write_filter *f, const char *key,
Packit 08bd4c
    const char *value)
Packit 08bd4c
{
Packit 08bd4c
	struct private_uuencode *state = (struct private_uuencode *)f->data;
Packit 08bd4c
Packit 08bd4c
	if (strcmp(key, "mode") == 0) {
Packit 08bd4c
		if (value == NULL) {
Packit 08bd4c
			archive_set_error(f->archive, ARCHIVE_ERRNO_MISC,
Packit 08bd4c
			    "mode option requires octal digits");
Packit 08bd4c
			return (ARCHIVE_FAILED);
Packit 08bd4c
		}
Packit 08bd4c
		state->mode = (int)atol8(value, strlen(value)) & 0777;
Packit 08bd4c
		return (ARCHIVE_OK);
Packit 08bd4c
	} else if (strcmp(key, "name") == 0) {
Packit 08bd4c
		if (value == NULL) {
Packit 08bd4c
			archive_set_error(f->archive, ARCHIVE_ERRNO_MISC,
Packit 08bd4c
			    "name option requires a string");
Packit 08bd4c
			return (ARCHIVE_FAILED);
Packit 08bd4c
		}
Packit 08bd4c
		archive_strcpy(&state->name, value);
Packit 08bd4c
		return (ARCHIVE_OK);
Packit 08bd4c
	}
Packit 08bd4c
Packit 08bd4c
	/* Note: The "warn" return is just to inform the options
Packit 08bd4c
	 * supervisor that we didn't handle it.  It will generate
Packit 08bd4c
	 * a suitable error if no one used this option. */
Packit 08bd4c
	return (ARCHIVE_WARN);
Packit 08bd4c
}
Packit 08bd4c
Packit 08bd4c
/*
Packit 08bd4c
 * Setup callback.
Packit 08bd4c
 */
Packit 08bd4c
static int
Packit 08bd4c
archive_filter_uuencode_open(struct archive_write_filter *f)
Packit 08bd4c
{
Packit 08bd4c
	struct private_uuencode *state = (struct private_uuencode *)f->data;
Packit 08bd4c
	size_t bs = 65536, bpb;
Packit 08bd4c
	int ret;
Packit 08bd4c
Packit 08bd4c
	ret = __archive_write_open_filter(f->next_filter);
Packit 08bd4c
	if (ret != ARCHIVE_OK)
Packit 08bd4c
		return (ret);
Packit 08bd4c
Packit 08bd4c
	if (f->archive->magic == ARCHIVE_WRITE_MAGIC) {
Packit 08bd4c
		/* Buffer size should be a multiple number of the of bytes
Packit 08bd4c
		 * per block for performance. */
Packit 08bd4c
		bpb = archive_write_get_bytes_per_block(f->archive);
Packit 08bd4c
		if (bpb > bs)
Packit 08bd4c
			bs = bpb;
Packit 08bd4c
		else if (bpb != 0)
Packit 08bd4c
			bs -= bs % bpb;
Packit 08bd4c
	}
Packit 08bd4c
Packit 08bd4c
	state->bs = bs;
Packit 08bd4c
	if (archive_string_ensure(&state->encoded_buff, bs + 512) == NULL) {
Packit 08bd4c
		archive_set_error(f->archive, ENOMEM,
Packit 08bd4c
		    "Can't allocate data for uuencode buffer");
Packit 08bd4c
		return (ARCHIVE_FATAL);
Packit 08bd4c
	}
Packit 08bd4c
Packit 08bd4c
	archive_string_sprintf(&state->encoded_buff, "begin %o %s\n",
Packit 08bd4c
	    state->mode, state->name.s);
Packit 08bd4c
Packit 08bd4c
	f->data = state;
Packit 08bd4c
	return (0);
Packit 08bd4c
}
Packit 08bd4c
Packit 08bd4c
static void
Packit 08bd4c
uu_encode(struct archive_string *as, const unsigned char *p, size_t len)
Packit 08bd4c
{
Packit 08bd4c
	int c;
Packit 08bd4c
Packit 08bd4c
	c = (int)len;
Packit 08bd4c
	archive_strappend_char(as, c?c + 0x20:'`');
Packit 08bd4c
	for (; len >= 3; p += 3, len -= 3) {
Packit 08bd4c
		c = p[0] >> 2;
Packit 08bd4c
		archive_strappend_char(as, c?c + 0x20:'`');
Packit 08bd4c
		c = ((p[0] & 0x03) << 4) | ((p[1] & 0xf0) >> 4);
Packit 08bd4c
		archive_strappend_char(as, c?c + 0x20:'`');
Packit 08bd4c
		c = ((p[1] & 0x0f) << 2) | ((p[2] & 0xc0) >> 6);
Packit 08bd4c
		archive_strappend_char(as, c?c + 0x20:'`');
Packit 08bd4c
		c = p[2] & 0x3f;
Packit 08bd4c
		archive_strappend_char(as, c?c + 0x20:'`');
Packit 08bd4c
	}
Packit 08bd4c
	if (len > 0) {
Packit 08bd4c
		c = p[0] >> 2;
Packit 08bd4c
		archive_strappend_char(as, c?c + 0x20:'`');
Packit 08bd4c
		c = (p[0] & 0x03) << 4;
Packit 08bd4c
		if (len == 1) {
Packit 08bd4c
			archive_strappend_char(as, c?c + 0x20:'`');
Packit 08bd4c
			archive_strappend_char(as, '`');
Packit 08bd4c
			archive_strappend_char(as, '`');
Packit 08bd4c
		} else {
Packit 08bd4c
			c |= (p[1] & 0xf0) >> 4;
Packit 08bd4c
			archive_strappend_char(as, c?c + 0x20:'`');
Packit 08bd4c
			c = (p[1] & 0x0f) << 2;
Packit 08bd4c
			archive_strappend_char(as, c?c + 0x20:'`');
Packit 08bd4c
			archive_strappend_char(as, '`');
Packit 08bd4c
		}
Packit 08bd4c
	}
Packit 08bd4c
	archive_strappend_char(as, '\n');
Packit 08bd4c
}
Packit 08bd4c
Packit 08bd4c
/*
Packit 08bd4c
 * Write data to the encoded stream.
Packit 08bd4c
 */
Packit 08bd4c
static int
Packit 08bd4c
archive_filter_uuencode_write(struct archive_write_filter *f, const void *buff,
Packit 08bd4c
    size_t length)
Packit 08bd4c
{
Packit 08bd4c
	struct private_uuencode *state = (struct private_uuencode *)f->data;
Packit 08bd4c
	const unsigned char *p = buff;
Packit 08bd4c
	int ret = ARCHIVE_OK;
Packit 08bd4c
Packit 08bd4c
	if (length == 0)
Packit 08bd4c
		return (ret);
Packit 08bd4c
Packit 08bd4c
	if (state->hold_len) {
Packit 08bd4c
		while (state->hold_len < LBYTES && length > 0) {
Packit 08bd4c
			state->hold[state->hold_len++] = *p++;
Packit 08bd4c
			length--;
Packit 08bd4c
		}
Packit 08bd4c
		if (state->hold_len < LBYTES)
Packit 08bd4c
			return (ret);
Packit 08bd4c
		uu_encode(&state->encoded_buff, state->hold, LBYTES);
Packit 08bd4c
		state->hold_len = 0;
Packit 08bd4c
	}
Packit 08bd4c
Packit 08bd4c
	for (; length >= LBYTES; length -= LBYTES, p += LBYTES)
Packit 08bd4c
		uu_encode(&state->encoded_buff, p, LBYTES);
Packit 08bd4c
Packit 08bd4c
	/* Save remaining bytes. */
Packit 08bd4c
	if (length > 0) {
Packit 08bd4c
		memcpy(state->hold, p, length);
Packit 08bd4c
		state->hold_len = length;
Packit 08bd4c
	}
Packit 08bd4c
	while (archive_strlen(&state->encoded_buff) >= state->bs) {
Packit 08bd4c
		ret = __archive_write_filter(f->next_filter,
Packit 08bd4c
		    state->encoded_buff.s, state->bs);
Packit 08bd4c
		memmove(state->encoded_buff.s,
Packit 08bd4c
		    state->encoded_buff.s + state->bs,
Packit 08bd4c
		    state->encoded_buff.length - state->bs);
Packit 08bd4c
		state->encoded_buff.length -= state->bs;
Packit 08bd4c
	}
Packit 08bd4c
Packit 08bd4c
	return (ret);
Packit 08bd4c
}
Packit 08bd4c
Packit 08bd4c
Packit 08bd4c
/*
Packit 08bd4c
 * Finish the compression...
Packit 08bd4c
 */
Packit 08bd4c
static int
Packit 08bd4c
archive_filter_uuencode_close(struct archive_write_filter *f)
Packit 08bd4c
{
Packit 08bd4c
	struct private_uuencode *state = (struct private_uuencode *)f->data;
Packit 08bd4c
	int ret, ret2;
Packit 08bd4c
Packit 08bd4c
	/* Flush remaining bytes. */
Packit 08bd4c
	if (state->hold_len != 0)
Packit 08bd4c
		uu_encode(&state->encoded_buff, state->hold, state->hold_len);
Packit 08bd4c
	archive_string_sprintf(&state->encoded_buff, "`\nend\n");
Packit 08bd4c
	/* Write the last block */
Packit 08bd4c
	archive_write_set_bytes_in_last_block(f->archive, 1);
Packit 08bd4c
	ret = __archive_write_filter(f->next_filter,
Packit 08bd4c
	    state->encoded_buff.s, archive_strlen(&state->encoded_buff));
Packit 08bd4c
	ret2 = __archive_write_close_filter(f->next_filter);
Packit 08bd4c
	if (ret > ret2)
Packit 08bd4c
		ret = ret2;
Packit 08bd4c
	return (ret);
Packit 08bd4c
}
Packit 08bd4c
Packit 08bd4c
static int
Packit 08bd4c
archive_filter_uuencode_free(struct archive_write_filter *f)
Packit 08bd4c
{
Packit 08bd4c
	struct private_uuencode *state = (struct private_uuencode *)f->data;
Packit 08bd4c
Packit 08bd4c
	archive_string_free(&state->name);
Packit 08bd4c
	archive_string_free(&state->encoded_buff);
Packit 08bd4c
	free(state);
Packit 08bd4c
	return (ARCHIVE_OK);
Packit 08bd4c
}
Packit 08bd4c
Packit 08bd4c
static int64_t
Packit 08bd4c
atol8(const char *p, size_t char_cnt)
Packit 08bd4c
{
Packit 08bd4c
	int64_t l;
Packit 08bd4c
	int digit;
Packit 08bd4c
        
Packit 08bd4c
	l = 0;
Packit 08bd4c
	while (char_cnt-- > 0) {
Packit 08bd4c
		if (*p >= '0' && *p <= '7')
Packit 08bd4c
			digit = *p - '0';
Packit 08bd4c
		else
Packit 08bd4c
			break;
Packit 08bd4c
		p++;
Packit 08bd4c
		l <<= 3;
Packit 08bd4c
		l |= digit;
Packit 08bd4c
	}
Packit 08bd4c
	return (l);
Packit 08bd4c
}
Packit 08bd4c