xref: /freebsd/contrib/libarchive/libarchive/archive_read_disk_private.h (revision 2e113ef82465598b8c26e0ca415fbe90677fbd47)
1 /*-
2  * Copyright (c) 2003-2009 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  *    in this position and unchanged.
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.
14  *
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.
25  */
26 
27 #ifndef ARCHIVE_READ_DISK_PRIVATE_H_INCLUDED
28 #define ARCHIVE_READ_DISK_PRIVATE_H_INCLUDED
29 
30 #ifndef __LIBARCHIVE_BUILD
31 #error This header is only to be used internally to libarchive.
32 #endif
33 
34 #include "archive_platform_acl.h"
35 
36 struct tree;
37 struct archive_entry;
38 
39 struct archive_read_disk {
40 	struct archive	archive;
41 
42 	/* Reused by archive_read_next_header() */
43 	struct archive_entry *entry;
44 
45 	/*
46 	 * Symlink mode is one of 'L'ogical, 'P'hysical, or 'H'ybrid,
47 	 * following an old BSD convention.  'L' follows all symlinks,
48 	 * 'P' follows none, 'H' follows symlinks only for the first
49 	 * item.
50 	 */
51 	char	symlink_mode;
52 
53 	/*
54 	 * Since symlink interaction changes, we need to track whether
55 	 * we're following symlinks for the current item, governed by the above
56 	 * symlink_mode.  'L' sets this true, 'P' sets it false, 'H' changes it
57 	 * as we traverse.
58 	 */
59 	char	follow_symlinks;  /* Either 0 or 1. */
60 
61 	/* Directory traversals. */
62 	struct tree *tree;
63 	int	(*open_on_current_dir)(struct tree*, const char *, int);
64 	int	(*tree_current_dir_fd)(struct tree*);
65 	int	(*tree_enter_working_dir)(struct tree*);
66 
67 	/* Bitfield with ARCHIVE_READDISK_* tunables */
68 	int	flags;
69 
70 	const char * (*lookup_gname)(void *private, int64_t gid);
71 	void	(*cleanup_gname)(void *private);
72 	void	 *lookup_gname_data;
73 	const char * (*lookup_uname)(void *private, int64_t uid);
74 	void	(*cleanup_uname)(void *private);
75 	void	 *lookup_uname_data;
76 
77 	int	(*metadata_filter_func)(struct archive *, void *,
78 			struct archive_entry *);
79 	void	*metadata_filter_data;
80 
81 	/* ARCHIVE_MATCH object. */
82 	struct archive	*matching;
83 	/* Callback function, this will be invoked when ARCHIVE_MATCH
84 	 * archive_match_*_excluded_ae return true. */
85 	void	(*excluded_cb_func)(struct archive *, void *,
86 			 struct archive_entry *);
87 	void	*excluded_cb_data;
88 };
89 
90 const char *
91 archive_read_disk_entry_setup_path(struct archive_read_disk *,
92     struct archive_entry *, int *);
93 
94 int
95 archive_read_disk_entry_setup_acls(struct archive_read_disk *,
96     struct archive_entry *, int *);
97 #endif
98