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