1 /* 2 +----------------------------------------------------------------------+ 3 | Zend Engine | 4 +----------------------------------------------------------------------+ 5 | Copyright (c) Zend Technologies Ltd. (http://www.zend.com) | 6 +----------------------------------------------------------------------+ 7 | This source file is subject to version 2.00 of the Zend 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.zend.com/license/2_00.txt. | 11 | If you did not receive a copy of the Zend license and are unable to | 12 | obtain it through the world-wide-web, please send a note to | 13 | license@zend.com so we can mail you a copy immediately. | 14 +----------------------------------------------------------------------+ 15 | Author: Zeev Suraski <zeev@php.net> | 16 +----------------------------------------------------------------------+ 17 */ 18 19 #ifndef ZEND_INI_H 20 #define ZEND_INI_H 21 22 #define ZEND_INI_USER (1<<0) 23 #define ZEND_INI_PERDIR (1<<1) 24 #define ZEND_INI_SYSTEM (1<<2) 25 26 #define ZEND_INI_ALL (ZEND_INI_USER|ZEND_INI_PERDIR|ZEND_INI_SYSTEM) 27 28 #define ZEND_INI_MH(name) int name(zend_ini_entry *entry, zend_string *new_value, void *mh_arg1, void *mh_arg2, void *mh_arg3, int stage) 29 #define ZEND_INI_DISP(name) ZEND_COLD void name(zend_ini_entry *ini_entry, int type) 30 31 typedef struct _zend_ini_entry_def { 32 const char *name; 33 ZEND_INI_MH((*on_modify)); 34 void *mh_arg1; 35 void *mh_arg2; 36 void *mh_arg3; 37 const char *value; 38 void (*displayer)(zend_ini_entry *ini_entry, int type); 39 40 uint32_t value_length; 41 uint16_t name_length; 42 uint8_t modifiable; 43 } zend_ini_entry_def; 44 45 struct _zend_ini_entry { 46 zend_string *name; 47 ZEND_INI_MH((*on_modify)); 48 void *mh_arg1; 49 void *mh_arg2; 50 void *mh_arg3; 51 zend_string *value; 52 zend_string *orig_value; 53 void (*displayer)(zend_ini_entry *ini_entry, int type); 54 55 int module_number; 56 57 uint8_t modifiable; 58 uint8_t orig_modifiable; 59 uint8_t modified; 60 61 }; 62 63 BEGIN_EXTERN_C() 64 ZEND_API void zend_ini_startup(void); 65 ZEND_API void zend_ini_shutdown(void); 66 ZEND_API void zend_ini_global_shutdown(void); 67 ZEND_API void zend_ini_deactivate(void); 68 ZEND_API void zend_ini_dtor(HashTable *ini_directives); 69 70 ZEND_API void zend_copy_ini_directives(void); 71 72 ZEND_API void zend_ini_sort_entries(void); 73 74 ZEND_API zend_result zend_register_ini_entries(const zend_ini_entry_def *ini_entry, int module_number); 75 ZEND_API zend_result zend_register_ini_entries_ex(const zend_ini_entry_def *ini_entry, int module_number, int module_type); 76 ZEND_API void zend_unregister_ini_entries(int module_number); 77 ZEND_API void zend_unregister_ini_entries_ex(int module_number, int module_type); 78 ZEND_API void zend_ini_refresh_caches(int stage); 79 ZEND_API zend_result zend_alter_ini_entry(zend_string *name, zend_string *new_value, int modify_type, int stage); 80 ZEND_API zend_result zend_alter_ini_entry_ex(zend_string *name, zend_string *new_value, int modify_type, int stage, bool force_change); 81 ZEND_API zend_result zend_alter_ini_entry_chars(zend_string *name, const char *value, size_t value_length, int modify_type, int stage); 82 ZEND_API zend_result zend_alter_ini_entry_chars_ex(zend_string *name, const char *value, size_t value_length, int modify_type, int stage, int force_change); 83 ZEND_API zend_result zend_restore_ini_entry(zend_string *name, int stage); 84 ZEND_API void display_ini_entries(zend_module_entry *module); 85 86 ZEND_API zend_long zend_ini_long(const char *name, size_t name_length, int orig); 87 ZEND_API double zend_ini_double(const char *name, size_t name_length, int orig); 88 ZEND_API char *zend_ini_string(const char *name, size_t name_length, int orig); 89 ZEND_API char *zend_ini_string_ex(const char *name, size_t name_length, int orig, bool *exists); 90 ZEND_API zend_string *zend_ini_str(const char *name, size_t name_length, bool orig); 91 ZEND_API zend_string *zend_ini_str_ex(const char *name, size_t name_length, bool orig, bool *exists); 92 ZEND_API zend_string *zend_ini_get_value(zend_string *name); 93 ZEND_API bool zend_ini_parse_bool(zend_string *str); 94 95 /** 96 * Parses an ini quantity 97 * 98 * The value parameter must be a string in the form 99 * 100 * sign? digits ws* multiplier? 101 * 102 * with 103 * 104 * sign: [+-] 105 * digit: [0-9] 106 * digits: digit+ 107 * ws: [ \t\n\r\v\f] 108 * multiplier: [KMG] 109 * 110 * Leading and trailing whitespaces are ignored. 111 * 112 * If the string is empty or consists only of only whitespaces, 0 is returned. 113 * 114 * Digits is parsed as decimal unless the first digit is '0', in which case 115 * digits is parsed as octal. 116 * 117 * The multiplier is case-insensitive. K, M, and G multiply the quantity by 118 * 2**10, 2**20, and 2**30, respectively. 119 * 120 * For backwards compatibility, ill-formatted values are handled as follows: 121 * - No leading digits: value is treated as '0' 122 * - Invalid multiplier: multiplier is ignored 123 * - Invalid characters between digits and multiplier: invalid characters are 124 * ignored 125 * - Integer overflow: The result of the overflow is returned 126 * 127 * In any of these cases an error string is stored in *errstr (caller must 128 * release it), otherwise *errstr is set to NULL. 129 */ 130 ZEND_API zend_long zend_ini_parse_quantity(zend_string *value, zend_string **errstr); 131 132 /** 133 * Unsigned variant of zend_ini_parse_quantity 134 */ 135 ZEND_API zend_ulong zend_ini_parse_uquantity(zend_string *value, zend_string **errstr); 136 137 ZEND_API zend_long zend_ini_parse_quantity_warn(zend_string *value, zend_string *setting); 138 139 ZEND_API zend_ulong zend_ini_parse_uquantity_warn(zend_string *value, zend_string *setting); 140 141 ZEND_API zend_result zend_ini_register_displayer(const char *name, uint32_t name_length, void (*displayer)(zend_ini_entry *ini_entry, int type)); 142 143 ZEND_API ZEND_INI_DISP(zend_ini_boolean_displayer_cb); 144 ZEND_API ZEND_INI_DISP(zend_ini_color_displayer_cb); 145 ZEND_API ZEND_INI_DISP(display_link_numbers); 146 END_EXTERN_C() 147 148 #define ZEND_INI_BEGIN() static const zend_ini_entry_def ini_entries[] = { 149 #define ZEND_INI_END() { NULL, NULL, NULL, NULL, NULL, NULL, NULL, 0, 0, 0} }; 150 151 #define ZEND_INI_ENTRY3_EX(name, default_value, modifiable, on_modify, arg1, arg2, arg3, displayer) \ 152 { name, on_modify, arg1, arg2, arg3, default_value, displayer, sizeof(default_value)-1, sizeof(name)-1, modifiable }, 153 154 #define ZEND_INI_ENTRY3(name, default_value, modifiable, on_modify, arg1, arg2, arg3) \ 155 ZEND_INI_ENTRY3_EX(name, default_value, modifiable, on_modify, arg1, arg2, arg3, NULL) 156 157 #define ZEND_INI_ENTRY2_EX(name, default_value, modifiable, on_modify, arg1, arg2, displayer) \ 158 ZEND_INI_ENTRY3_EX(name, default_value, modifiable, on_modify, arg1, arg2, NULL, displayer) 159 160 #define ZEND_INI_ENTRY2(name, default_value, modifiable, on_modify, arg1, arg2) \ 161 ZEND_INI_ENTRY2_EX(name, default_value, modifiable, on_modify, arg1, arg2, NULL) 162 163 #define ZEND_INI_ENTRY1_EX(name, default_value, modifiable, on_modify, arg1, displayer) \ 164 ZEND_INI_ENTRY3_EX(name, default_value, modifiable, on_modify, arg1, NULL, NULL, displayer) 165 166 #define ZEND_INI_ENTRY1(name, default_value, modifiable, on_modify, arg1) \ 167 ZEND_INI_ENTRY1_EX(name, default_value, modifiable, on_modify, arg1, NULL) 168 169 #define ZEND_INI_ENTRY_EX(name, default_value, modifiable, on_modify, displayer) \ 170 ZEND_INI_ENTRY3_EX(name, default_value, modifiable, on_modify, NULL, NULL, NULL, displayer) 171 172 #define ZEND_INI_ENTRY(name, default_value, modifiable, on_modify) \ 173 ZEND_INI_ENTRY_EX(name, default_value, modifiable, on_modify, NULL) 174 175 #ifdef ZTS 176 #define STD_ZEND_INI_ENTRY(name, default_value, modifiable, on_modify, property_name, struct_type, struct_ptr) \ 177 ZEND_INI_ENTRY2(name, default_value, modifiable, on_modify, (void *) XtOffsetOf(struct_type, property_name), (void *) &struct_ptr##_id) 178 #define STD_ZEND_INI_ENTRY_EX(name, default_value, modifiable, on_modify, property_name, struct_type, struct_ptr, displayer) \ 179 ZEND_INI_ENTRY2_EX(name, default_value, modifiable, on_modify, (void *) XtOffsetOf(struct_type, property_name), (void *) &struct_ptr##_id, displayer) 180 #define STD_ZEND_INI_BOOLEAN(name, default_value, modifiable, on_modify, property_name, struct_type, struct_ptr) \ 181 ZEND_INI_ENTRY3_EX(name, default_value, modifiable, on_modify, (void *) XtOffsetOf(struct_type, property_name), (void *) &struct_ptr##_id, NULL, zend_ini_boolean_displayer_cb) 182 #else 183 #define STD_ZEND_INI_ENTRY(name, default_value, modifiable, on_modify, property_name, struct_type, struct_ptr) \ 184 ZEND_INI_ENTRY2(name, default_value, modifiable, on_modify, (void *) XtOffsetOf(struct_type, property_name), (void *) &struct_ptr) 185 #define STD_ZEND_INI_ENTRY_EX(name, default_value, modifiable, on_modify, property_name, struct_type, struct_ptr, displayer) \ 186 ZEND_INI_ENTRY2_EX(name, default_value, modifiable, on_modify, (void *) XtOffsetOf(struct_type, property_name), (void *) &struct_ptr, displayer) 187 #define STD_ZEND_INI_BOOLEAN(name, default_value, modifiable, on_modify, property_name, struct_type, struct_ptr) \ 188 ZEND_INI_ENTRY3_EX(name, default_value, modifiable, on_modify, (void *) XtOffsetOf(struct_type, property_name), (void *) &struct_ptr, NULL, zend_ini_boolean_displayer_cb) 189 #endif 190 191 #define INI_INT(name) zend_ini_long((name), strlen(name), 0) 192 #define INI_FLT(name) zend_ini_double((name), strlen(name), 0) 193 #define INI_STR(name) zend_ini_string_ex((name), strlen(name), 0, NULL) 194 #define INI_BOOL(name) ((bool) INI_INT(name)) 195 196 #define INI_ORIG_INT(name) zend_ini_long((name), strlen(name), 1) 197 #define INI_ORIG_FLT(name) zend_ini_double((name), strlen(name), 1) 198 #define INI_ORIG_STR(name) zend_ini_string((name), strlen(name), 1) 199 #define INI_ORIG_BOOL(name) ((bool) INI_ORIG_INT(name)) 200 201 #define REGISTER_INI_ENTRIES() zend_register_ini_entries_ex(ini_entries, module_number, type) 202 #define UNREGISTER_INI_ENTRIES() zend_unregister_ini_entries_ex(module_number, type) 203 #define DISPLAY_INI_ENTRIES() display_ini_entries(zend_module) 204 205 #define REGISTER_INI_DISPLAYER(name, displayer) zend_ini_register_displayer((name), strlen(name), displayer) 206 #define REGISTER_INI_BOOLEAN(name) REGISTER_INI_DISPLAYER(name, zend_ini_boolean_displayer_cb) 207 208 /* Standard message handlers */ 209 BEGIN_EXTERN_C() 210 ZEND_API ZEND_INI_MH(OnUpdateBool); 211 ZEND_API ZEND_INI_MH(OnUpdateLong); 212 ZEND_API ZEND_INI_MH(OnUpdateLongGEZero); 213 ZEND_API ZEND_INI_MH(OnUpdateReal); 214 /* char* versions */ 215 ZEND_API ZEND_INI_MH(OnUpdateString); 216 ZEND_API ZEND_INI_MH(OnUpdateStringUnempty); 217 /* zend_string* versions */ 218 ZEND_API ZEND_INI_MH(OnUpdateStr); 219 ZEND_API ZEND_INI_MH(OnUpdateStrNotEmpty); 220 END_EXTERN_C() 221 222 #define ZEND_INI_DISPLAY_ORIG 1 223 #define ZEND_INI_DISPLAY_ACTIVE 2 224 225 #define ZEND_INI_STAGE_STARTUP (1<<0) 226 #define ZEND_INI_STAGE_SHUTDOWN (1<<1) 227 #define ZEND_INI_STAGE_ACTIVATE (1<<2) 228 #define ZEND_INI_STAGE_DEACTIVATE (1<<3) 229 #define ZEND_INI_STAGE_RUNTIME (1<<4) 230 #define ZEND_INI_STAGE_HTACCESS (1<<5) 231 232 #define ZEND_INI_STAGE_IN_REQUEST (ZEND_INI_STAGE_ACTIVATE|ZEND_INI_STAGE_DEACTIVATE|ZEND_INI_STAGE_RUNTIME|ZEND_INI_STAGE_HTACCESS) 233 234 /* INI parsing engine */ 235 typedef void (*zend_ini_parser_cb_t)(zval *arg1, zval *arg2, zval *arg3, int callback_type, void *arg); 236 BEGIN_EXTERN_C() 237 ZEND_API zend_result zend_parse_ini_file(zend_file_handle *fh, bool unbuffered_errors, int scanner_mode, zend_ini_parser_cb_t ini_parser_cb, void *arg); 238 ZEND_API zend_result zend_parse_ini_string(const char *str, bool unbuffered_errors, int scanner_mode, zend_ini_parser_cb_t ini_parser_cb, void *arg); 239 END_EXTERN_C() 240 241 /* INI entries */ 242 #define ZEND_INI_PARSER_ENTRY 1 /* Normal entry: foo = bar */ 243 #define ZEND_INI_PARSER_SECTION 2 /* Section: [foobar] */ 244 #define ZEND_INI_PARSER_POP_ENTRY 3 /* Offset entry: foo[] = bar */ 245 246 typedef struct _zend_ini_parser_param { 247 zend_ini_parser_cb_t ini_parser_cb; 248 void *arg; 249 } zend_ini_parser_param; 250 251 #ifndef ZTS 252 # define ZEND_INI_GET_BASE() ((char *) mh_arg2) 253 #else 254 # define ZEND_INI_GET_BASE() ((char *) ts_resource(*((int *) mh_arg2))) 255 #endif 256 257 #define ZEND_INI_GET_ADDR() (ZEND_INI_GET_BASE() + (size_t) mh_arg1) 258 259 #endif /* ZEND_INI_H */ 260
