xref: /php-src/Zend/zend_ini_parser.y (revision a48b977d)
1 %require "3.0"
2 %{
3 /*
4    +----------------------------------------------------------------------+
5    | Zend Engine                                                          |
6    +----------------------------------------------------------------------+
7    | Copyright (c) Zend Technologies Ltd. (http://www.zend.com)           |
8    +----------------------------------------------------------------------+
9    | This source file is subject to version 2.00 of the Zend license,     |
10    | that is bundled with this package in the file LICENSE, and is        |
11    | available through the world-wide-web at the following url:           |
12    | http://www.zend.com/license/2_00.txt.                                |
13    | If you did not receive a copy of the Zend license and are unable to  |
14    | obtain it through the world-wide-web, please send a note to          |
15    | license@zend.com so we can mail you a copy immediately.              |
16    +----------------------------------------------------------------------+
17    | Authors: Zeev Suraski <zeev@php.net>                                 |
18    |          Jani Taskinen <jani@php.net>                                |
19    +----------------------------------------------------------------------+
20 */
21 
22 #define DEBUG_CFG_PARSER 0
23 
24 #include "zend.h"
25 #include "zend_API.h"
26 #include "zend_ini.h"
27 #include "zend_constants.h"
28 #include "zend_ini_scanner.h"
29 #include "zend_extensions.h"
30 
31 #ifdef ZEND_WIN32
32 #include "win32/syslog.h"
33 #endif
34 
35 int ini_parse(void);
36 
37 #define ZEND_INI_PARSER_CB	(CG(ini_parser_param))->ini_parser_cb
38 #define ZEND_INI_PARSER_ARG	(CG(ini_parser_param))->arg
39 
40 #ifdef _MSC_VER
41 #define YYMALLOC malloc
42 #define YYFREE free
43 #endif
44 
45 #define ZEND_SYSTEM_INI CG(ini_parser_unbuffered_errors)
46 #define INI_ZVAL_IS_NUMBER 1
47 
get_int_val(zval * op)48 static int get_int_val(zval *op) {
49 	switch (Z_TYPE_P(op)) {
50 		case IS_LONG:
51 			return Z_LVAL_P(op);
52 		case IS_DOUBLE:
53 			return (int)Z_DVAL_P(op);
54 		case IS_STRING:
55 		{
56 			int val = atoi(Z_STRVAL_P(op));
57 			zend_string_free(Z_STR_P(op));
58 			return val;
59 		}
60 		EMPTY_SWITCH_DEFAULT_CASE()
61 	}
62 }
63 
64 /* {{{ zend_ini_do_op() */
zend_ini_do_op(char type,zval * result,zval * op1,zval * op2)65 static void zend_ini_do_op(char type, zval *result, zval *op1, zval *op2)
66 {
67 	int i_result;
68 	int i_op1, i_op2;
69 	int str_len;
70 	char str_result[MAX_LENGTH_OF_LONG+1];
71 
72 	i_op1 = get_int_val(op1);
73 	i_op2 = op2 ? get_int_val(op2) : 0;
74 
75 	switch (type) {
76 		case '|':
77 			i_result = i_op1 | i_op2;
78 			break;
79 		case '&':
80 			i_result = i_op1 & i_op2;
81 			break;
82 		case '^':
83 			i_result = i_op1 ^ i_op2;
84 			break;
85 		case '~':
86 			i_result = ~i_op1;
87 			break;
88 		case '!':
89 			i_result = !i_op1;
90 			break;
91 		default:
92 			i_result = 0;
93 			break;
94 	}
95 
96 	if (INI_SCNG(scanner_mode) != ZEND_INI_SCANNER_TYPED) {
97 		str_len = sprintf(str_result, "%d", i_result);
98 		ZVAL_NEW_STR(result, zend_string_init(str_result, str_len, ZEND_SYSTEM_INI));
99 	} else {
100 		ZVAL_LONG(result, i_result);
101 	}
102 }
103 /* }}} */
104 
105 /* {{{ zend_ini_init_string() */
zend_ini_init_string(zval * result)106 static void zend_ini_init_string(zval *result)
107 {
108 	if (ZEND_SYSTEM_INI) {
109 		ZVAL_EMPTY_PSTRING(result);
110 	} else {
111 		ZVAL_EMPTY_STRING(result);
112 	}
113 	Z_EXTRA_P(result) = 0;
114 }
115 /* }}} */
116 
117 /* {{{ zend_ini_add_string() */
zend_ini_add_string(zval * result,zval * op1,zval * op2)118 static void zend_ini_add_string(zval *result, zval *op1, zval *op2)
119 {
120 	int length, op1_len;
121 
122 	if (Z_TYPE_P(op1) != IS_STRING) {
123 		/* ZEND_ASSERT(!Z_REFCOUNTED_P(op1)); */
124 		if (ZEND_SYSTEM_INI) {
125 			zend_string *tmp_str;
126 			zend_string *str = zval_get_tmp_string(op1, &tmp_str);
127 			ZVAL_PSTRINGL(op1, ZSTR_VAL(str), ZSTR_LEN(str));
128 			zend_tmp_string_release(tmp_str);
129 		} else {
130 			ZVAL_STR(op1, zval_get_string_func(op1));
131 		}
132 	}
133 	op1_len = (int)Z_STRLEN_P(op1);
134 
135 	if (Z_TYPE_P(op2) != IS_STRING) {
136 		convert_to_string(op2);
137 	}
138 	length = op1_len + (int)Z_STRLEN_P(op2);
139 
140 	ZVAL_NEW_STR(result, zend_string_extend(Z_STR_P(op1), length, ZEND_SYSTEM_INI));
141 	memcpy(Z_STRVAL_P(result) + op1_len, Z_STRVAL_P(op2), Z_STRLEN_P(op2) + 1);
142 }
143 /* }}} */
144 
145 /* {{{ zend_ini_get_constant() */
zend_ini_get_constant(zval * result,zval * name)146 static void zend_ini_get_constant(zval *result, zval *name)
147 {
148 	zval *c, tmp;
149 
150 	/* If name contains ':' it is not a constant. Bug #26893. */
151 	if (!memchr(Z_STRVAL_P(name), ':', Z_STRLEN_P(name))
152 		   	&& (c = zend_get_constant(Z_STR_P(name))) != 0) {
153 		if (Z_TYPE_P(c) != IS_STRING) {
154 			ZVAL_COPY_OR_DUP(&tmp, c);
155 			if (Z_OPT_CONSTANT(tmp)) {
156 				zval_update_constant_ex(&tmp, NULL);
157 			}
158 			convert_to_string(&tmp);
159 			c = &tmp;
160 		}
161 		ZVAL_NEW_STR(result, zend_string_init(Z_STRVAL_P(c), Z_STRLEN_P(c), ZEND_SYSTEM_INI));
162 		if (c == &tmp) {
163 			zend_string_release(Z_STR(tmp));
164 		}
165 		zend_string_free(Z_STR_P(name));
166 	} else {
167 		*result = *name;
168 	}
169 }
170 /* }}} */
171 
172 /* {{{ zend_ini_get_var() */
zend_ini_get_var(zval * result,zval * name,zval * fallback)173 static void zend_ini_get_var(zval *result, zval *name, zval *fallback)
174 {
175 	zval *curval;
176 	char *envvar;
177 
178 	/* Fetch configuration option value */
179 	if ((curval = zend_get_configuration_directive(Z_STR_P(name))) != NULL) {
180 		ZVAL_NEW_STR(result, zend_string_init(Z_STRVAL_P(curval), Z_STRLEN_P(curval), ZEND_SYSTEM_INI));
181 	/* ..or if not found, try ENV */
182 	} else if ((envvar = zend_getenv(Z_STRVAL_P(name), Z_STRLEN_P(name))) != NULL ||
183 			   (envvar = getenv(Z_STRVAL_P(name))) != NULL) {
184 		ZVAL_NEW_STR(result, zend_string_init(envvar, strlen(envvar), ZEND_SYSTEM_INI));
185 	/* ..or if not defined, try fallback value */
186 	} else if (fallback) {
187 		ZVAL_NEW_STR(result, zend_string_init(Z_STRVAL_P(fallback), strlen(Z_STRVAL_P(fallback)), ZEND_SYSTEM_INI));
188 	} else {
189 		zend_ini_init_string(result);
190 	}
191 
192 }
193 /* }}} */
194 
195 /* {{{ ini_error() */
ini_error(const char * msg)196 static ZEND_COLD void ini_error(const char *msg)
197 {
198 	char *error_buf;
199 	int error_buf_len;
200 
201 	const char *const currently_parsed_filename = zend_ini_scanner_get_filename();
202 	if (currently_parsed_filename) {
203 		error_buf_len = 128 + (int)strlen(msg) + (int)strlen(currently_parsed_filename); /* should be more than enough */
204 		error_buf = (char *) emalloc(error_buf_len);
205 
206 		sprintf(error_buf, "%s in %s on line %d\n", msg, currently_parsed_filename, zend_ini_scanner_get_lineno());
207 	} else {
208 		error_buf = estrdup("Invalid configuration directive\n");
209 	}
210 
211 	if (CG(ini_parser_unbuffered_errors)) {
212 #ifdef ZEND_WIN32
213 		syslog(LOG_ALERT, "PHP: %s (%s)", error_buf, GetCommandLine());
214 #endif
215 		fprintf(stderr, "PHP:  %s", error_buf);
216 	} else {
217 		zend_error(E_WARNING, "%s", error_buf);
218 	}
219 	efree(error_buf);
220 }
221 /* }}} */
222 
223 /* {{{ zend_parse_ini_file() */
zend_parse_ini_file(zend_file_handle * fh,bool unbuffered_errors,int scanner_mode,zend_ini_parser_cb_t ini_parser_cb,void * arg)224 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)
225 {
226 	int retval;
227 	zend_ini_parser_param ini_parser_param;
228 
229 	ini_parser_param.ini_parser_cb = ini_parser_cb;
230 	ini_parser_param.arg = arg;
231 	CG(ini_parser_param) = &ini_parser_param;
232 
233 	if (zend_ini_open_file_for_scanning(fh, scanner_mode) == FAILURE) {
234 		return FAILURE;
235 	}
236 
237 	CG(ini_parser_unbuffered_errors) = unbuffered_errors;
238 	retval = ini_parse();
239 
240 	shutdown_ini_scanner();
241 
242 	if (retval == 0) {
243 		return SUCCESS;
244 	} else {
245 		return FAILURE;
246 	}
247 }
248 /* }}} */
249 
250 /* {{{ zend_parse_ini_string() */
zend_parse_ini_string(const char * str,bool unbuffered_errors,int scanner_mode,zend_ini_parser_cb_t ini_parser_cb,void * arg)251 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)
252 {
253 	int retval;
254 	zend_ini_parser_param ini_parser_param;
255 
256 	ini_parser_param.ini_parser_cb = ini_parser_cb;
257 	ini_parser_param.arg = arg;
258 	CG(ini_parser_param) = &ini_parser_param;
259 
260 	if (zend_ini_prepare_string_for_scanning(str, scanner_mode) == FAILURE) {
261 		return FAILURE;
262 	}
263 
264 	CG(ini_parser_unbuffered_errors) = unbuffered_errors;
265 	retval = ini_parse();
266 
267 	shutdown_ini_scanner();
268 
269 	if (retval == 0) {
270 		return SUCCESS;
271 	} else {
272 		return FAILURE;
273 	}
274 }
275 /* }}} */
276 
277 /* {{{ zval_ini_dtor() */
zval_ini_dtor(zval * zv)278 static void zval_ini_dtor(zval *zv)
279 {
280 	if (Z_TYPE_P(zv) == IS_STRING) {
281 		if (ZEND_SYSTEM_INI) {
282 			GC_MAKE_PERSISTENT_LOCAL(Z_STR_P(zv));
283 		}
284 		zend_string_release(Z_STR_P(zv));
285 	}
286 }
287 /* }}} */
288 
convert_to_number(zval * retval,const char * str,const int str_len)289 static inline zend_result convert_to_number(zval *retval, const char *str, const int str_len)
290 {
291 	uint8_t type;
292 	int overflow;
293 	zend_long lval;
294 	double dval;
295 
296 	if ((type = is_numeric_string_ex(str, str_len, &lval, &dval, 0, &overflow, NULL)) != 0) {
297 		if (type == IS_LONG) {
298 			ZVAL_LONG(retval, lval);
299 			return SUCCESS;
300 		} else if (type == IS_DOUBLE && !overflow) {
301 			ZVAL_DOUBLE(retval, dval);
302 			return SUCCESS;
303 		}
304 	}
305 
306 	return FAILURE;
307 }
308 
normalize_value(zval * zv)309 static void normalize_value(zval *zv)
310 {
311 	if (INI_SCNG(scanner_mode) != ZEND_INI_SCANNER_TYPED) {
312 		return;
313 	}
314 
315 	ZEND_ASSERT(Z_EXTRA_P(zv) == 0 || Z_EXTRA_P(zv) == INI_ZVAL_IS_NUMBER);
316 	if (Z_EXTRA_P(zv) == INI_ZVAL_IS_NUMBER && Z_TYPE_P(zv) == IS_STRING) {
317 		zval number_rv;
318 		if (convert_to_number(&number_rv, Z_STRVAL_P(zv), Z_STRLEN_P(zv)) == SUCCESS) {
319 			zval_ptr_dtor(zv);
320 			ZVAL_COPY_VALUE(zv, &number_rv);
321 		}
322 	}
323 }
324 
325 %}
326 
327 %expect 0
328 %define api.prefix {ini_}
329 %define api.pure full
330 %define api.value.type {zval}
331 %define parse.error verbose
332 
333 %token END 0 "end of file"
334 %token TC_SECTION
335 %token TC_RAW
336 %token TC_CONSTANT
337 %token TC_NUMBER
338 %token TC_STRING
339 %token TC_WHITESPACE
340 %token TC_LABEL
341 %token TC_OFFSET
342 %token TC_DOLLAR_CURLY
343 %token TC_VARNAME
344 %token TC_QUOTED_STRING
345 %token TC_FALLBACK
346 %token BOOL_TRUE
347 %token BOOL_FALSE
348 %token NULL_NULL
349 %token END_OF_LINE
350 %token '=' ':' ',' '.' '"' '\'' '^' '+' '-' '/' '*' '%' '$' '~' '<' '>' '?' '@' '{' '}'
351 %left '|' '&' '^'
352 %precedence '~' '!'
353 
354 %destructor { zval_ini_dtor(&$$); } TC_RAW TC_CONSTANT TC_NUMBER TC_STRING TC_WHITESPACE TC_LABEL TC_OFFSET TC_VARNAME BOOL_TRUE BOOL_FALSE NULL_NULL cfg_var_ref constant_literal constant_string encapsed_list expr option_offset section_string_or_value string_or_value var_string_list var_string_list_section
355 
356 %%
357 
358 statement_list:
359 		statement_list statement
360 	|	%empty { (void) ini_nerrs; }
361 ;
362 
363 statement:
364 		TC_SECTION section_string_or_value ']' {
365 #if DEBUG_CFG_PARSER
366 			printf("SECTION: [%s]\n", Z_STRVAL($2));
367 #endif
368 			ZEND_INI_PARSER_CB(&$2, NULL, NULL, ZEND_INI_PARSER_SECTION, ZEND_INI_PARSER_ARG);
369 			zend_string_release(Z_STR($2));
370 		}
371 	|	TC_LABEL '=' string_or_value {
372 #if DEBUG_CFG_PARSER
373 			printf("NORMAL: '%s' = '%s'\n", Z_STRVAL($1), Z_STRVAL($3));
374 #endif
375 			ZEND_INI_PARSER_CB(&$1, &$3, NULL, ZEND_INI_PARSER_ENTRY, ZEND_INI_PARSER_ARG);
376 			if (ZEND_SYSTEM_INI) {
377 				GC_MAKE_PERSISTENT_LOCAL(Z_STR($1));
378 			}
379 			zend_string_release(Z_STR($1));
380 			zval_ini_dtor(&$3);
381 		}
382 	|	TC_OFFSET option_offset ']' '=' string_or_value {
383 #if DEBUG_CFG_PARSER
384 			printf("OFFSET: '%s'[%s] = '%s'\n", Z_STRVAL($1), Z_STRVAL($2), Z_STRVAL($5));
385 #endif
386 			ZEND_INI_PARSER_CB(&$1, &$5, &$2, ZEND_INI_PARSER_POP_ENTRY, ZEND_INI_PARSER_ARG);
387 			zend_string_release(Z_STR($1));
388 			zval_ini_dtor(&$2);
389 			zval_ini_dtor(&$5);
390 		}
391 	|	TC_LABEL	{ ZEND_INI_PARSER_CB(&$1, NULL, NULL, ZEND_INI_PARSER_ENTRY, ZEND_INI_PARSER_ARG); zend_string_release(Z_STR($1)); }
392 	|	END_OF_LINE
393 ;
394 
395 section_string_or_value:
396 		var_string_list_section			{ $$ = $1; }
397 	|	%empty						{ zend_ini_init_string(&$$); }
398 ;
399 
400 string_or_value:
401 		expr							{ $$ = $1; normalize_value(&$$); }
402 	|	BOOL_TRUE						{ $$ = $1; }
403 	|	BOOL_FALSE						{ $$ = $1; }
404 	|	NULL_NULL						{ $$ = $1; }
405 	|	END_OF_LINE						{ zend_ini_init_string(&$$); }
406 ;
407 
408 option_offset:
409 		var_string_list					{ $$ = $1; }
410 	|	%empty						{ zend_ini_init_string(&$$); }
411 ;
412 
413 encapsed_list:
414 		encapsed_list cfg_var_ref		{ zend_ini_add_string(&$$, &$1, &$2); zend_string_free(Z_STR($2)); }
415 	|	encapsed_list TC_QUOTED_STRING	{ zend_ini_add_string(&$$, &$1, &$2); zend_string_free(Z_STR($2)); }
416 	|	%empty						{ zend_ini_init_string(&$$); }
417 ;
418 
419 var_string_list_section:
420 		cfg_var_ref						{ $$ = $1; }
421 	|	constant_literal				{ $$ = $1; }
422 	|	'"' encapsed_list '"'			{ $$ = $2; }
423 	|	var_string_list_section cfg_var_ref 	{ zend_ini_add_string(&$$, &$1, &$2); zend_string_free(Z_STR($2)); }
424 	|	var_string_list_section constant_literal	{ zend_ini_add_string(&$$, &$1, &$2); zend_string_free(Z_STR($2)); }
425 	|	var_string_list_section '"' encapsed_list '"'  { zend_ini_add_string(&$$, &$1, &$3); zend_string_free(Z_STR($3)); }
426 ;
427 
428 var_string_list:
429 		cfg_var_ref						{ $$ = $1; }
430 	|	constant_string					{ $$ = $1; }
431 	|	'"' encapsed_list '"'			{ $$ = $2; }
432 	|	var_string_list cfg_var_ref 	{ zend_ini_add_string(&$$, &$1, &$2); zend_string_free(Z_STR($2)); }
433 	|	var_string_list constant_string	{ zend_ini_add_string(&$$, &$1, &$2); zend_string_free(Z_STR($2)); }
434 	|	var_string_list '"' encapsed_list '"'  { zend_ini_add_string(&$$, &$1, &$3); zend_string_free(Z_STR($3)); }
435 ;
436 
437 expr:
438 		var_string_list					{ $$ = $1; }
439 	|	expr '|' expr					{ zend_ini_do_op('|', &$$, &$1, &$3); }
440 	|	expr '&' expr					{ zend_ini_do_op('&', &$$, &$1, &$3); }
441 	|	expr '^' expr					{ zend_ini_do_op('^', &$$, &$1, &$3); }
442 	|	'~' expr						{ zend_ini_do_op('~', &$$, &$2, NULL); }
443 	|	'!'	expr						{ zend_ini_do_op('!', &$$, &$2, NULL); }
444 	|	'(' expr ')'					{ $$ = $2; }
445 ;
446 
447 cfg_var_ref:
448 		TC_DOLLAR_CURLY TC_VARNAME '}'				{ zend_ini_get_var(&$$, &$2, NULL); zend_string_free(Z_STR($2)); }
449 	|	TC_DOLLAR_CURLY TC_VARNAME TC_FALLBACK fallback '}'	{ zend_ini_get_var(&$$, &$2, &$4); zend_string_free(Z_STR($2)); zend_string_free(Z_STR($4)); }
450 ;
451 
452 
453 fallback:
454 		var_string_list	{ $$ = $1; }
455 	|	%empty			{ zend_ini_init_string(&$$); }
456 ;
457 
458 constant_literal:
459 		TC_CONSTANT						{ $$ = $1; }
460 	|	TC_RAW							{ $$ = $1; /*printf("TC_RAW: '%s'\n", Z_STRVAL($1));*/ }
461 	|	TC_NUMBER						{ $$ = $1; /*printf("TC_NUMBER: '%s'\n", Z_STRVAL($1));*/ }
462 	|	TC_STRING						{ $$ = $1; /*printf("TC_STRING: '%s'\n", Z_STRVAL($1));*/ }
463 	|	TC_WHITESPACE					{ $$ = $1; /*printf("TC_WHITESPACE: '%s'\n", Z_STRVAL($1));*/ }
464 ;
465 
466 constant_string:
467 		TC_CONSTANT						{ zend_ini_get_constant(&$$, &$1); }
468 	|	TC_RAW							{ $$ = $1; /*printf("TC_RAW: '%s'\n", Z_STRVAL($1));*/ }
469 	|	TC_NUMBER {
470 			$$ = $1;
471 			Z_EXTRA($$) = INI_ZVAL_IS_NUMBER;
472 			/*printf("TC_NUMBER: '%s'\n", Z_STRVAL($1));*/
473 		}
474 	|	TC_STRING						{ $$ = $1; /*printf("TC_STRING: '%s'\n", Z_STRVAL($1));*/ }
475 	|	TC_WHITESPACE					{ $$ = $1; /*printf("TC_WHITESPACE: '%s'\n", Z_STRVAL($1));*/ }
476 ;
477