xref: /PHP-7.4/ext/filter/filter_private.h (revision 92ac598a)
1 /*
2   +----------------------------------------------------------------------+
3   | PHP Version 7                                                        |
4   +----------------------------------------------------------------------+
5   | Copyright (c) The PHP Group                                          |
6   +----------------------------------------------------------------------+
7   | This source file is subject to version 3.01 of the PHP license,      |
8   | that is bundled with this package in the file LICENSE, and is        |
9   | available through the world-wide-web at the following url:           |
10   | http://www.php.net/license/3_01.txt                                  |
11   | If you did not receive a copy of the PHP license and are unable to   |
12   | obtain it through the world-wide-web, please send a note to          |
13   | license@php.net so we can mail you a copy immediately.               |
14   +----------------------------------------------------------------------+
15   | Authors: Derick Rethans <derick@php.net>                             |
16   +----------------------------------------------------------------------+
17 */
18 
19 #ifndef FILTER_PRIVATE_H
20 #define FILTER_PRIVATE_H
21 
22 #define FILTER_FLAG_NONE                    0x0000
23 
24 #define FILTER_REQUIRE_ARRAY			0x1000000
25 #define FILTER_REQUIRE_SCALAR			0x2000000
26 
27 #define FILTER_FORCE_ARRAY			0x4000000
28 #define FILTER_NULL_ON_FAILURE			0x8000000
29 
30 #define FILTER_FLAG_ALLOW_OCTAL             0x0001
31 #define FILTER_FLAG_ALLOW_HEX               0x0002
32 
33 #define FILTER_FLAG_STRIP_LOW               0x0004
34 #define FILTER_FLAG_STRIP_HIGH              0x0008
35 #define FILTER_FLAG_ENCODE_LOW              0x0010
36 #define FILTER_FLAG_ENCODE_HIGH             0x0020
37 #define FILTER_FLAG_ENCODE_AMP              0x0040
38 #define FILTER_FLAG_NO_ENCODE_QUOTES        0x0080
39 #define FILTER_FLAG_EMPTY_STRING_NULL       0x0100
40 #define FILTER_FLAG_STRIP_BACKTICK          0x0200
41 
42 #define FILTER_FLAG_ALLOW_FRACTION          0x1000
43 #define FILTER_FLAG_ALLOW_THOUSAND          0x2000
44 #define FILTER_FLAG_ALLOW_SCIENTIFIC        0x4000
45 
46 #define FILTER_FLAG_SCHEME_REQUIRED         0x010000
47 #define FILTER_FLAG_HOST_REQUIRED           0x020000
48 #define FILTER_FLAG_PATH_REQUIRED           0x040000
49 #define FILTER_FLAG_QUERY_REQUIRED          0x080000
50 
51 #define FILTER_FLAG_IPV4                    0x100000
52 #define FILTER_FLAG_IPV6                    0x200000
53 #define FILTER_FLAG_NO_RES_RANGE            0x400000
54 #define FILTER_FLAG_NO_PRIV_RANGE           0x800000
55 
56 #define FILTER_FLAG_HOSTNAME               0x100000
57 
58 #define FILTER_FLAG_EMAIL_UNICODE          0x100000
59 
60 #define FILTER_VALIDATE_INT           0x0101
61 #define FILTER_VALIDATE_BOOLEAN       0x0102
62 #define FILTER_VALIDATE_FLOAT         0x0103
63 
64 #define FILTER_VALIDATE_REGEXP        0x0110
65 #define FILTER_VALIDATE_URL           0x0111
66 #define FILTER_VALIDATE_EMAIL         0x0112
67 #define FILTER_VALIDATE_IP            0x0113
68 #define FILTER_VALIDATE_MAC           0x0114
69 #define FILTER_VALIDATE_DOMAIN        0x0115
70 #define FILTER_VALIDATE_LAST          0x0115
71 
72 #define FILTER_VALIDATE_ALL           0x0100
73 
74 #define FILTER_DEFAULT                0x0204
75 #define FILTER_UNSAFE_RAW             0x0204
76 
77 #define FILTER_SANITIZE_STRING        0x0201
78 #define FILTER_SANITIZE_ENCODED       0x0202
79 #define FILTER_SANITIZE_SPECIAL_CHARS 0x0203
80 #define FILTER_SANITIZE_EMAIL         0x0205
81 #define FILTER_SANITIZE_URL           0x0206
82 #define FILTER_SANITIZE_NUMBER_INT    0x0207
83 #define FILTER_SANITIZE_NUMBER_FLOAT  0x0208
84 #define FILTER_SANITIZE_MAGIC_QUOTES  0x0209
85 #define FILTER_SANITIZE_FULL_SPECIAL_CHARS 0x020a
86 #define FILTER_SANITIZE_ADD_SLASHES   0x020b
87 #define FILTER_SANITIZE_LAST          0x020b
88 
89 #define FILTER_SANITIZE_ALL           0x0200
90 
91 #define FILTER_CALLBACK               0x0400
92 
93 #define PHP_FILTER_ID_EXISTS(id) \
94 ((id >= FILTER_SANITIZE_ALL && id <= FILTER_SANITIZE_LAST) \
95 || (id >= FILTER_VALIDATE_ALL && id <= FILTER_VALIDATE_LAST) \
96 || id == FILTER_CALLBACK)
97 
98 #define RETURN_VALIDATION_FAILED	\
99 	zval_ptr_dtor(value);	\
100 	if (flags & FILTER_NULL_ON_FAILURE) {	\
101 		ZVAL_NULL(value);	\
102 	} else {	\
103 		ZVAL_FALSE(value);	\
104 	}	\
105 	return;	\
106 
107 #define PHP_FILTER_TRIM_DEFAULT(p, len) PHP_FILTER_TRIM_DEFAULT_EX(p, len, 1);
108 
109 #define PHP_FILTER_TRIM_DEFAULT_EX(p, len, return_if_empty) { \
110 	while ((len > 0)  && (*p == ' ' || *p == '\t' || *p == '\r' || *p == '\v' || *p == '\n')) { \
111 		p++; \
112 		len--; \
113 	} \
114 	if (len < 1 && return_if_empty) { \
115 		RETURN_VALIDATION_FAILED \
116 	} \
117 	if (len > 0) { \
118 		while (p[len-1] == ' ' || p[len-1] == '\t' || p[len-1] == '\r' || p[len-1] == '\v' || p[len-1] == '\n') { \
119 			len--; \
120 		} \
121 	} \
122 }
123 
124 #endif /* FILTER_PRIVATE_H */
125