xref: /PHP-8.0/ext/fileinfo/libmagic/magic.h (revision c3eeab01)
1 /*
2  * Copyright (c) Christos Zoulas 2003.
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 immediately at the beginning of the file, without modification,
10  *    this list of conditions, and the following disclaimer.
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 AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
19  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 #ifndef _MAGIC_H
28 #define _MAGIC_H
29 
30 #include <sys/types.h>
31 
32 #define	MAGIC_NONE		0x0000000 /* No flags */
33 #define	MAGIC_DEBUG		0x0000001 /* Turn on debugging */
34 #define	MAGIC_SYMLINK		0x0000002 /* Follow symlinks */
35 #define	MAGIC_COMPRESS		0x0000004 /* Check inside compressed files */
36 #define	MAGIC_DEVICES		0x0000008 /* Look at the contents of devices */
37 #define	MAGIC_MIME_TYPE		0x0000010 /* Return the MIME type */
38 #define	MAGIC_CONTINUE		0x0000020 /* Return all matches */
39 #define	MAGIC_CHECK		0x0000040 /* Print warnings to stderr */
40 #define	MAGIC_PRESERVE_ATIME	0x0000080 /* Restore access time on exit */
41 #define	MAGIC_RAW		0x0000100 /* Don't convert unprintable chars */
42 #define	MAGIC_ERROR		0x0000200 /* Handle ENOENT etc as real errors */
43 #define	MAGIC_MIME_ENCODING	0x0000400 /* Return the MIME encoding */
44 #define MAGIC_MIME		(MAGIC_MIME_TYPE|MAGIC_MIME_ENCODING)
45 #define	MAGIC_APPLE		0x0000800 /* Return the Apple creator/type */
46 #define	MAGIC_EXTENSION		0x1000000 /* Return a /-separated list of
47 					   * extensions */
48 #define MAGIC_COMPRESS_TRANSP	0x2000000 /* Check inside compressed files
49 					   * but not report compression */
50 #define MAGIC_NODESC		(MAGIC_EXTENSION|MAGIC_MIME|MAGIC_APPLE)
51 
52 #define	MAGIC_NO_CHECK_COMPRESS	0x0001000 /* Don't check for compressed files */
53 #define	MAGIC_NO_CHECK_TAR	0x0002000 /* Don't check for tar files */
54 #define	MAGIC_NO_CHECK_SOFT	0x0004000 /* Don't check magic entries */
55 #define	MAGIC_NO_CHECK_APPTYPE	0x0008000 /* Don't check application type */
56 #define	MAGIC_NO_CHECK_ELF	0x0010000 /* Don't check for elf details */
57 #define	MAGIC_NO_CHECK_TEXT	0x0020000 /* Don't check for text files */
58 #define	MAGIC_NO_CHECK_CDF	0x0040000 /* Don't check for cdf files */
59 #define MAGIC_NO_CHECK_CSV	0x0080000 /* Don't check for CSV files */
60 #define	MAGIC_NO_CHECK_TOKENS	0x0100000 /* Don't check tokens */
61 #define MAGIC_NO_CHECK_ENCODING 0x0200000 /* Don't check text encodings */
62 #define MAGIC_NO_CHECK_JSON	0x0400000 /* Don't check for JSON files */
63 
64 /* No built-in tests; only consult the magic file */
65 #define MAGIC_NO_CHECK_BUILTIN	( \
66 	MAGIC_NO_CHECK_COMPRESS	| \
67 	MAGIC_NO_CHECK_TAR	| \
68 /*	MAGIC_NO_CHECK_SOFT	| */ \
69 	MAGIC_NO_CHECK_APPTYPE	| \
70 	MAGIC_NO_CHECK_ELF	| \
71 	MAGIC_NO_CHECK_TEXT	| \
72 	MAGIC_NO_CHECK_CSV	| \
73 	MAGIC_NO_CHECK_CDF	| \
74 	MAGIC_NO_CHECK_TOKENS	| \
75 	MAGIC_NO_CHECK_ENCODING	| \
76 	MAGIC_NO_CHECK_JSON	| \
77 	0			  \
78 )
79 
80 #define MAGIC_SNPRINTB "\177\020\
81 b\0debug\0\
82 b\1symlink\0\
83 b\2compress\0\
84 b\3devices\0\
85 b\4mime_type\0\
86 b\5continue\0\
87 b\6check\0\
88 b\7preserve_atime\0\
89 b\10raw\0\
90 b\11error\0\
91 b\12mime_encoding\0\
92 b\13apple\0\
93 b\14no_check_compress\0\
94 b\15no_check_tar\0\
95 b\16no_check_soft\0\
96 b\17no_check_sapptype\0\
97 b\20no_check_elf\0\
98 b\21no_check_text\0\
99 b\22no_check_cdf\0\
100 b\23no_check_reserved0\0\
101 b\24no_check_tokens\0\
102 b\25no_check_encoding\0\
103 b\26no_check_json\0\
104 b\27no_check_reserved2\0\
105 b\30extension\0\
106 b\31transp_compression\0\
107 "
108 
109 /* Defined for backwards compatibility (renamed) */
110 #define	MAGIC_NO_CHECK_ASCII	MAGIC_NO_CHECK_TEXT
111 
112 /* Defined for backwards compatibility; do nothing */
113 #define	MAGIC_NO_CHECK_FORTRAN	0x000000 /* Don't check ascii/fortran */
114 #define	MAGIC_NO_CHECK_TROFF	0x000000 /* Don't check ascii/troff */
115 
116 #define MAGIC_VERSION		539	/* This implementation */
117 
118 
119 #ifdef __cplusplus
120 extern "C" {
121 #endif
122 
123 typedef struct magic_set *magic_t;
124 magic_t magic_open(int);
125 void magic_close(magic_t);
126 
127 const char *magic_getpath(const char *, int);
128 const char *magic_file(magic_t, const char *);
129 const char *magic_stream(magic_t, php_stream *);
130 const char *magic_descriptor(magic_t, int);
131 const char *magic_buffer(magic_t, const void *, size_t);
132 
133 const char *magic_error(magic_t);
134 int magic_getflags(magic_t);
135 int magic_setflags(magic_t, int);
136 
137 int magic_version(void);
138 int magic_load(magic_t, const char *);
139 int magic_load_buffers(magic_t, void **, size_t *, size_t);
140 
141 int magic_compile(magic_t, const char *);
142 int magic_check(magic_t, const char *);
143 int magic_list(magic_t, const char *);
144 int magic_errno(magic_t);
145 
146 #define MAGIC_PARAM_INDIR_MAX		0
147 #define MAGIC_PARAM_NAME_MAX		1
148 #define MAGIC_PARAM_ELF_PHNUM_MAX	2
149 #define MAGIC_PARAM_ELF_SHNUM_MAX	3
150 #define MAGIC_PARAM_ELF_NOTES_MAX	4
151 #define MAGIC_PARAM_REGEX_MAX		5
152 #define	MAGIC_PARAM_BYTES_MAX		6
153 
154 int magic_setparam(magic_t, int, const void *);
155 int magic_getparam(magic_t, int, void *);
156 
157 #ifdef __cplusplus
158 };
159 #endif
160 
161 #endif /* _MAGIC_H */
162