HardenedBSD src tree
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

165 lines
5.6KB

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