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