Import libarchive-2.2.7.
[dragonfly.git] / contrib / libarchive-2 / libarchive / archive_entry.h
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: src/lib/libarchive/archive_entry.h,v 1.23 2007/07/15 19:10:34 kientzle Exp $
26  */
27
28 #ifndef ARCHIVE_ENTRY_H_INCLUDED
29 #define ARCHIVE_ENTRY_H_INCLUDED
30
31 #include <sys/types.h>
32 #include <stddef.h>  /* for wchar_t */
33 #include <time.h>
34 #include <unistd.h>
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40
41 /*
42  * Description of an archive entry.
43  *
44  * Basically, a "struct stat" with a few text fields added in.
45  *
46  * TODO: Add "comment", "charset", and possibly other entries that are
47  * supported by "pax interchange" format.  However, GNU, ustar, cpio,
48  * and other variants don't support these features, so they're not an
49  * excruciatingly high priority right now.
50  *
51  * TODO: "pax interchange" format allows essentially arbitrary
52  * key/value attributes to be attached to any entry.  Supporting
53  * such extensions may make this library useful for special
54  * applications (e.g., a package manager could attach special
55  * package-management attributes to each entry).
56  */
57 struct archive_entry;
58
59 /*
60  * File-type constants.  These are returned from archive_entry_filetype().
61  */
62 #define AE_IFMT         0170000
63 #define AE_IFREG        0100000
64 #define AE_IFLNK        0120000
65 #define AE_IFCHR        0020000
66 #define AE_IFBLK        0060000
67 #define AE_IFDIR        0040000
68 #define AE_IFIFO        0010000
69
70 /*
71  * Basic object manipulation
72  */
73
74 struct archive_entry    *archive_entry_clear(struct archive_entry *);
75 /* The 'clone' function does a deep copy; all of the strings are copied too. */
76 struct archive_entry    *archive_entry_clone(struct archive_entry *);
77 void                     archive_entry_free(struct archive_entry *);
78 struct archive_entry    *archive_entry_new(void);
79
80 /*
81  * Retrieve fields from an archive_entry.
82  */
83
84 time_t                   archive_entry_atime(struct archive_entry *);
85 long                     archive_entry_atime_nsec(struct archive_entry *);
86 time_t                   archive_entry_ctime(struct archive_entry *);
87 long                     archive_entry_ctime_nsec(struct archive_entry *);
88 dev_t                    archive_entry_dev(struct archive_entry *);
89 dev_t                    archive_entry_devmajor(struct archive_entry *);
90 dev_t                    archive_entry_devminor(struct archive_entry *);
91 mode_t                   archive_entry_filetype(struct archive_entry *);
92 void                     archive_entry_fflags(struct archive_entry *,
93                              unsigned long *set, unsigned long *clear);
94 const char              *archive_entry_fflags_text(struct archive_entry *);
95 gid_t                    archive_entry_gid(struct archive_entry *);
96 const char              *archive_entry_gname(struct archive_entry *);
97 const wchar_t           *archive_entry_gname_w(struct archive_entry *);
98 const char              *archive_entry_hardlink(struct archive_entry *);
99 const wchar_t           *archive_entry_hardlink_w(struct archive_entry *);
100 ino_t                    archive_entry_ino(struct archive_entry *);
101 mode_t                   archive_entry_mode(struct archive_entry *);
102 time_t                   archive_entry_mtime(struct archive_entry *);
103 long                     archive_entry_mtime_nsec(struct archive_entry *);
104 unsigned int             archive_entry_nlink(struct archive_entry *);
105 const char              *archive_entry_pathname(struct archive_entry *);
106 const wchar_t           *archive_entry_pathname_w(struct archive_entry *);
107 dev_t                    archive_entry_rdev(struct archive_entry *);
108 dev_t                    archive_entry_rdevmajor(struct archive_entry *);
109 dev_t                    archive_entry_rdevminor(struct archive_entry *);
110 int64_t                  archive_entry_size(struct archive_entry *);
111 const char              *archive_entry_symlink(struct archive_entry *);
112 const wchar_t           *archive_entry_symlink_w(struct archive_entry *);
113 uid_t                    archive_entry_uid(struct archive_entry *);
114 const char              *archive_entry_uname(struct archive_entry *);
115 const wchar_t           *archive_entry_uname_w(struct archive_entry *);
116
117 /*
118  * Set fields in an archive_entry.
119  *
120  * Note that string 'set' functions do not copy the string, only the pointer.
121  * In contrast, 'copy' functions do copy the object pointed to.
122  */
123
124 void    archive_entry_set_atime(struct archive_entry *, time_t, long);
125 void    archive_entry_set_ctime(struct archive_entry *, time_t, long);
126 void    archive_entry_set_dev(struct archive_entry *, dev_t);
127 void    archive_entry_set_devmajor(struct archive_entry *, dev_t);
128 void    archive_entry_set_devminor(struct archive_entry *, dev_t);
129 void    archive_entry_set_filetype(struct archive_entry *, unsigned int);
130 void    archive_entry_set_fflags(struct archive_entry *,
131             unsigned long set, unsigned long clear);
132 /* Returns pointer to start of first invalid token, or NULL if none. */
133 /* Note that all recognized tokens are processed, regardless. */
134 const wchar_t *archive_entry_copy_fflags_text_w(struct archive_entry *,
135             const wchar_t *);
136 void    archive_entry_set_gid(struct archive_entry *, gid_t);
137 void    archive_entry_set_gname(struct archive_entry *, const char *);
138 void    archive_entry_copy_gname(struct archive_entry *, const char *);
139 void    archive_entry_copy_gname_w(struct archive_entry *, const wchar_t *);
140 void    archive_entry_set_hardlink(struct archive_entry *, const char *);
141 void    archive_entry_copy_hardlink(struct archive_entry *, const char *);
142 void    archive_entry_copy_hardlink_w(struct archive_entry *, const wchar_t *);
143 void    archive_entry_set_ino(struct archive_entry *, unsigned long);
144 void    archive_entry_set_link(struct archive_entry *, const char *);
145 void    archive_entry_set_mode(struct archive_entry *, mode_t);
146 void    archive_entry_set_mtime(struct archive_entry *, time_t, long);
147 void    archive_entry_set_nlink(struct archive_entry *, unsigned int);
148 void    archive_entry_set_pathname(struct archive_entry *, const char *);
149 void    archive_entry_copy_pathname(struct archive_entry *, const char *);
150 void    archive_entry_copy_pathname_w(struct archive_entry *, const wchar_t *);
151 void    archive_entry_set_perm(struct archive_entry *, mode_t);
152 void    archive_entry_set_rdev(struct archive_entry *, dev_t);
153 void    archive_entry_set_rdevmajor(struct archive_entry *, dev_t);
154 void    archive_entry_set_rdevminor(struct archive_entry *, dev_t);
155 void    archive_entry_set_size(struct archive_entry *, int64_t);
156 void    archive_entry_set_symlink(struct archive_entry *, const char *);
157 void    archive_entry_copy_symlink(struct archive_entry *, const char *);
158 void    archive_entry_copy_symlink_w(struct archive_entry *, const wchar_t *);
159 void    archive_entry_set_uid(struct archive_entry *, uid_t);
160 void    archive_entry_set_uname(struct archive_entry *, const char *);
161 void    archive_entry_copy_uname(struct archive_entry *, const char *);
162 void    archive_entry_copy_uname_w(struct archive_entry *, const wchar_t *);
163
164 /*
165  * Routines to bulk copy fields to/from a platform-native "struct
166  * stat."  Libarchive used to just store a struct stat inside of each
167  * archive_entry object, but this created issues when trying to
168  * manipulate archives on systems different than the ones they were
169  * created on.
170  *
171  * TODO: On Linux, provide both stat32 and stat64 versions of these functions.
172  */
173 const struct stat       *archive_entry_stat(struct archive_entry *);
174 void    archive_entry_copy_stat(struct archive_entry *, const struct stat *);
175
176 /*
177  * ACL routines.  This used to simply store and return text-format ACL
178  * strings, but that proved insufficient for a number of reasons:
179  *   = clients need control over uname/uid and gname/gid mappings
180  *   = there are many different ACL text formats
181  *   = would like to be able to read/convert archives containing ACLs
182  *     on platforms that lack ACL libraries
183  */
184
185 /*
186  * Permission bits mimic POSIX.1e.  Note that I've not followed POSIX.1e's
187  * "permset"/"perm" abstract type nonsense.  A permset is just a simple
188  * bitmap, following long-standing Unix tradition.
189  */
190 #define ARCHIVE_ENTRY_ACL_EXECUTE       1
191 #define ARCHIVE_ENTRY_ACL_WRITE         2
192 #define ARCHIVE_ENTRY_ACL_READ          4
193
194 /* We need to be able to specify either or both of these. */
195 #define ARCHIVE_ENTRY_ACL_TYPE_ACCESS   256
196 #define ARCHIVE_ENTRY_ACL_TYPE_DEFAULT  512
197
198 /* Tag values mimic POSIX.1e */
199 #define ARCHIVE_ENTRY_ACL_USER          10001   /* Specified user. */
200 #define ARCHIVE_ENTRY_ACL_USER_OBJ      10002   /* User who owns the file. */
201 #define ARCHIVE_ENTRY_ACL_GROUP         10003   /* Specified group. */
202 #define ARCHIVE_ENTRY_ACL_GROUP_OBJ     10004   /* Group who owns the file. */
203 #define ARCHIVE_ENTRY_ACL_MASK          10005   /* Modify group access. */
204 #define ARCHIVE_ENTRY_ACL_OTHER         10006   /* Public. */
205
206 /*
207  * Set the ACL by clearing it and adding entries one at a time.
208  * Unlike the POSIX.1e ACL routines, you must specify the type
209  * (access/default) for each entry.  Internally, the ACL data is just
210  * a soup of entries.  API calls here allow you to retrieve just the
211  * entries of interest.  This design (which goes against the spirit of
212  * POSIX.1e) is useful for handling archive formats that combine
213  * default and access information in a single ACL list.
214  */
215 void     archive_entry_acl_clear(struct archive_entry *);
216 void     archive_entry_acl_add_entry(struct archive_entry *,
217              int type, int permset, int tag, int qual, const char *name);
218 void     archive_entry_acl_add_entry_w(struct archive_entry *,
219              int type, int permset, int tag, int qual, const wchar_t *name);
220
221 /*
222  * To retrieve the ACL, first "reset", then repeatedly ask for the
223  * "next" entry.  The want_type parameter allows you to request only
224  * access entries or only default entries.
225  */
226 int      archive_entry_acl_reset(struct archive_entry *, int want_type);
227 int      archive_entry_acl_next(struct archive_entry *, int want_type,
228              int *type, int *permset, int *tag, int *qual, const char **name);
229 int      archive_entry_acl_next_w(struct archive_entry *, int want_type,
230              int *type, int *permset, int *tag, int *qual,
231              const wchar_t **name);
232
233 /*
234  * Construct a text-format ACL.  The flags argument is a bitmask that
235  * can include any of the following:
236  *
237  * ARCHIVE_ENTRY_ACL_TYPE_ACCESS - Include access entries.
238  * ARCHIVE_ENTRY_ACL_TYPE_DEFAULT - Include default entries.
239  * ARCHIVE_ENTRY_ACL_STYLE_EXTRA_ID - Include extra numeric ID field in
240  *    each ACL entry.  (As used by 'star'.)
241  * ARCHIVE_ENTRY_ACL_STYLE_MARK_DEFAULT - Include "default:" before each
242  *    default ACL entry.
243  */
244 #define ARCHIVE_ENTRY_ACL_STYLE_EXTRA_ID        1024
245 #define ARCHIVE_ENTRY_ACL_STYLE_MARK_DEFAULT    2048
246 const wchar_t   *archive_entry_acl_text_w(struct archive_entry *, int flags);
247
248 /* Return a count of entries matching 'want_type' */
249 int      archive_entry_acl_count(struct archive_entry *, int want_type);
250
251 /*
252  * Private ACL parser.  This is private because it handles some
253  * very weird formats that clients should not be messing with.
254  * Clients should only deal with their platform-native formats.
255  * Because of the need to support many formats cleanly, new arguments
256  * are likely to get added on a regular basis.  Clients who try to use
257  * this interface are likely to be surprised when it changes.
258  *
259  * You were warned!
260  */
261 int              __archive_entry_acl_parse_w(struct archive_entry *,
262                      const wchar_t *, int type);
263
264
265 #ifdef __cplusplus
266 }
267 #endif
268
269 /*
270  * extended attributes
271  */
272
273 void     archive_entry_xattr_clear(struct archive_entry *);
274 void     archive_entry_xattr_add_entry(struct archive_entry *,
275              const char *name, const void *value, size_t size);
276
277 /*
278  * To retrieve the xattr list, first "reset", then repeatedly ask for the
279  * "next" entry.
280  */
281
282 int     archive_entry_xattr_count(struct archive_entry *);
283 int     archive_entry_xattr_reset(struct archive_entry *);
284 int     archive_entry_xattr_next(struct archive_entry *,
285              const char **name, const void **value, size_t *);
286
287
288 #endif /* !ARCHIVE_ENTRY_H_INCLUDED */