1 /*- 2 * Copyright (c) 2003-2007 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 * $FreeBSD$ 26 */ 27 28 #ifndef ARCHIVE_WRITE_PRIVATE_H_INCLUDED 29 #define ARCHIVE_WRITE_PRIVATE_H_INCLUDED 30 31 #ifndef __LIBARCHIVE_BUILD 32 #ifndef __LIBARCHIVE_TEST 33 #error This header is only to be used internally to libarchive. 34 #endif 35 #endif 36 37 #include "archive.h" 38 #include "archive_string.h" 39 #include "archive_private.h" 40 41 #define ARCHIVE_WRITE_FILTER_STATE_NEW 1U 42 #define ARCHIVE_WRITE_FILTER_STATE_OPEN 2U 43 #define ARCHIVE_WRITE_FILTER_STATE_CLOSED 4U 44 #define ARCHIVE_WRITE_FILTER_STATE_FATAL 0x8000U 45 46 struct archive_write; 47 48 struct archive_write_filter { 49 int64_t bytes_written; 50 struct archive *archive; /* Associated archive. */ 51 struct archive_write_filter *next_filter; /* Who I write to. */ 52 int (*options)(struct archive_write_filter *, 53 const char *key, const char *value); 54 int (*open)(struct archive_write_filter *); 55 int (*write)(struct archive_write_filter *, const void *, size_t); 56 int (*flush)(struct archive_write_filter *); 57 int (*close)(struct archive_write_filter *); 58 int (*free)(struct archive_write_filter *); 59 void *data; 60 const char *name; 61 int code; 62 int bytes_per_block; 63 int bytes_in_last_block; 64 int state; 65 }; 66 67 #if ARCHIVE_VERSION < 4000000 68 void __archive_write_filters_free(struct archive *); 69 #endif 70 71 struct archive_write_filter *__archive_write_allocate_filter(struct archive *); 72 73 int __archive_write_output(struct archive_write *, const void *, size_t); 74 int __archive_write_nulls(struct archive_write *, size_t); 75 int __archive_write_filter(struct archive_write_filter *, const void *, size_t); 76 77 struct archive_write { 78 struct archive archive; 79 80 /* Dev/ino of the archive being written. */ 81 int skip_file_set; 82 int64_t skip_file_dev; 83 int64_t skip_file_ino; 84 85 /* Utility: Pointer to a block of nulls. */ 86 const unsigned char *nulls; 87 size_t null_length; 88 89 /* Callbacks to open/read/write/close archive stream. */ 90 archive_open_callback *client_opener; 91 archive_write_callback *client_writer; 92 archive_close_callback *client_closer; 93 archive_free_callback *client_freer; 94 void *client_data; 95 96 /* 97 * Blocking information. Note that bytes_in_last_block is 98 * misleadingly named; I should find a better name. These 99 * control the final output from all compressors, including 100 * compression_none. 101 */ 102 int bytes_per_block; 103 int bytes_in_last_block; 104 105 /* 106 * First and last write filters in the pipeline. 107 */ 108 struct archive_write_filter *filter_first; 109 struct archive_write_filter *filter_last; 110 111 /* 112 * Pointers to format-specific functions for writing. They're 113 * initialized by archive_write_set_format_XXX() calls. 114 */ 115 void *format_data; 116 const char *format_name; 117 int (*format_init)(struct archive_write *); 118 int (*format_options)(struct archive_write *, 119 const char *key, const char *value); 120 int (*format_finish_entry)(struct archive_write *); 121 int (*format_write_header)(struct archive_write *, 122 struct archive_entry *); 123 ssize_t (*format_write_data)(struct archive_write *, 124 const void *buff, size_t); 125 int (*format_close)(struct archive_write *); 126 int (*format_free)(struct archive_write *); 127 128 129 /* 130 * Encryption passphrase. 131 */ 132 char *passphrase; 133 archive_passphrase_callback *passphrase_callback; 134 void *passphrase_client_data; 135 }; 136 137 /* 138 * Utility function to format a USTAR header into a buffer. If 139 * "strict" is set, this tries to create the absolutely most portable 140 * version of a ustar header. If "strict" is set to 0, then it will 141 * relax certain requirements. 142 * 143 * Generally, format-specific declarations don't belong in this 144 * header; this is a rare example of a function that is shared by 145 * two very similar formats (ustar and pax). 146 */ 147 int 148 __archive_write_format_header_ustar(struct archive_write *, char buff[512], 149 struct archive_entry *, int tartype, int strict, 150 struct archive_string_conv *); 151 152 struct archive_write_program_data; 153 struct archive_write_program_data * __archive_write_program_allocate(const char *program_name); 154 int __archive_write_program_free(struct archive_write_program_data *); 155 int __archive_write_program_open(struct archive_write_filter *, 156 struct archive_write_program_data *, const char *); 157 int __archive_write_program_close(struct archive_write_filter *, 158 struct archive_write_program_data *); 159 int __archive_write_program_write(struct archive_write_filter *, 160 struct archive_write_program_data *, const void *, size_t); 161 162 /* 163 * Get a encryption passphrase. 164 */ 165 const char * __archive_write_get_passphrase(struct archive_write *a); 166 #endif 167