/
gpc_api.php
468 lines (426 loc) · 14.9 KB
/
gpc_api.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
<?php
# MantisBT - A PHP based bugtracking system
# MantisBT is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
# (at your option) any later version.
#
# MantisBT is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with MantisBT. If not, see <http://www.gnu.org/licenses/>.
/**
* GPC API
*
* Provides sanitisation and type conversion of user supplied data through
* HTTP GET, HTTP POST and cookies.
*
* @package CoreAPI
* @subpackage GPCAPI
* @copyright Copyright 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
* @copyright Copyright 2002 MantisBT Team - mantisbt-dev@lists.sourceforge.net
* @link http://www.mantisbt.org
*
* @uses config_api.php
* @uses constant_inc.php
* @uses error_api.php
* @uses http_api.php
*/
require_api( 'config_api.php' );
require_api( 'constant_inc.php' );
require_api( 'error_api.php' );
require_api( 'http_api.php' );
# Determines (once-off) whether the client is accessing this script via a
# secure connection. If they are, we want to use the Secure cookie flag to
# prevent the cookie from being transmitted to other domains.
# @global boolean $g_cookie_secure_flag_enabled
$g_cookie_secure_flag_enabled = http_is_protocol_https();
/**
* Retrieve a GPC variable.
* If the variable is not set, the default is returned.
*
* You may pass in any variable as a default (including null) but if
* you pass in *no* default then an error will be triggered if the field
* cannot be found
*
* @param string $p_var_name Variable name.
* @param mixed $p_default Default value.
* @return null
*/
function gpc_get( $p_var_name, $p_default = null ) {
if( isset( $_POST[$p_var_name] ) ) {
$t_result = $_POST[$p_var_name];
} else if( isset( $_GET[$p_var_name] ) ) {
$t_result = $_GET[$p_var_name];
} else if( func_num_args() > 1 ) {
# check for a default passed in (allowing null)
$t_result = $p_default;
} else {
error_parameters( $p_var_name );
trigger_error( ERROR_GPC_VAR_NOT_FOUND, ERROR );
$t_result = null;
}
return $t_result;
}
/**
* Check if GPC variable is set in $_POST or $_GET
* @param string $p_var_name Variable name to check if set by http request.
* @return boolean
*/
function gpc_isset( $p_var_name ) {
if( isset( $_POST[$p_var_name] ) ) {
return true;
} else if( isset( $_GET[$p_var_name] ) ) {
return true;
}
return false;
}
/**
* Retrieve a string GPC variable. Uses gpc_get().
* If you pass in *no* default, an error will be triggered if
* the variable does not exist
* @param string $p_var_name Variable name to retrieve.
* @param string $p_default Default value of the string if not set(optional).
* @return string|null
*/
function gpc_get_string( $p_var_name, $p_default = null ) {
# Don't pass along a default unless one was given to us
# otherwise we prevent an error being triggered
$t_args = func_get_args();
$t_result = call_user_func_array( 'gpc_get', $t_args );
if( is_array( $t_result ) ) {
error_parameters( $p_var_name );
trigger_error( ERROR_GPC_ARRAY_UNEXPECTED, ERROR );
}
if( $t_result === null ) {
return null;
} else {
return str_replace( "\0", '', $t_result );
}
}
/**
* Retrieve an integer GPC variable. Uses gpc_get().
* If you pass in *no* default, an error will be triggered if
* the variable does not exist
* @param string $p_var_name Variable name to retrieve.
* @param integer $p_default Default integer value if not set (optional).
* @return integer|null
*/
function gpc_get_int( $p_var_name, $p_default = null ) {
# Don't pass along a default unless one was given to us
# otherwise we prevent an error being triggered
$t_args = func_get_args();
$t_result = call_user_func_array( 'gpc_get', $t_args );
if( is_array( $t_result ) ) {
error_parameters( $p_var_name );
trigger_error( ERROR_GPC_ARRAY_UNEXPECTED, ERROR );
}
$t_val = str_replace( ' ', '', trim( $t_result ) );
if( !preg_match( '/^-?([0-9])*$/', $t_val ) ) {
error_parameters( $p_var_name );
trigger_error( ERROR_GPC_NOT_NUMBER, ERROR );
}
return (int)$t_val;
}
/**
* Retrieve a boolean GPC variable. Uses gpc_get().
* If you pass in *no* default, false will be used
* @param string $p_var_name Variable name to retrieve.
* @param boolean $p_default Default boolean value if not set (optional).
* @return boolean|null
*/
function gpc_get_bool( $p_var_name, $p_default = false ) {
$t_result = gpc_get( $p_var_name, $p_default );
if( $t_result === $p_default ) {
return (bool)$p_default;
} else {
if( is_array( $t_result ) ) {
error_parameters( $p_var_name );
trigger_error( ERROR_GPC_ARRAY_UNEXPECTED, ERROR );
}
return gpc_string_to_bool( $t_result );
}
}
/**
* see if a custom field variable is set. Uses gpc_isset().
* @param string $p_var_name Variable name to retrieve.
* @param integer $p_custom_field_type Custom field type.
* @return boolean
*/
function gpc_isset_custom_field( $p_var_name, $p_custom_field_type ) {
$t_field_name = 'custom_field_' . $p_var_name;
switch( $p_custom_field_type ) {
case CUSTOM_FIELD_TYPE_DATE:
# date field is three dropdowns that default to 0
# Dropdowns are always present, so check if they are set
return gpc_isset( $t_field_name . '_day' ) &&
gpc_get_int( $t_field_name . '_day', 0 ) != 0 &&
gpc_isset( $t_field_name . '_month' ) &&
gpc_get_int( $t_field_name . '_month', 0 ) != 0 &&
gpc_isset( $t_field_name . '_year' ) &&
gpc_get_int( $t_field_name . '_year', 0 ) != 0 ;
case CUSTOM_FIELD_TYPE_STRING:
case CUSTOM_FIELD_TYPE_NUMERIC:
case CUSTOM_FIELD_TYPE_FLOAT:
case CUSTOM_FIELD_TYPE_ENUM:
case CUSTOM_FIELD_TYPE_EMAIL:
return gpc_isset( $t_field_name ) && !is_blank( gpc_get_string( $t_field_name ) );
default:
return gpc_isset( $t_field_name );
}
}
/**
* Retrieve a custom field variable. Uses gpc_get().
* If you pass in *no* default, an error will be triggered if
* the variable does not exist
* @param string $p_var_name Variable name.
* @param integer $p_custom_field_type Custom Field Type.
* @param mixed $p_default Default value.
* @return string
*/
function gpc_get_custom_field( $p_var_name, $p_custom_field_type, $p_default = null ) {
switch( $p_custom_field_type ) {
case CUSTOM_FIELD_TYPE_MULTILIST:
case CUSTOM_FIELD_TYPE_CHECKBOX:
# ensure that the default is an array, if set
if( ( $p_default !== null ) && !is_array( $p_default ) ) {
$p_default = array( $p_default );
}
$t_values = gpc_get_string_array( $p_var_name, $p_default );
if( is_array( $t_values ) ) {
return implode( '|', $t_values );
} else {
return '';
}
break;
case CUSTOM_FIELD_TYPE_DATE:
$t_day = gpc_get_int( $p_var_name . '_day', 0 );
$t_month = gpc_get_int( $p_var_name . '_month', 0 );
$t_year = gpc_get_int( $p_var_name . '_year', 0 );
if( ( $t_year == 0 ) || ( $t_month == 0 ) || ( $t_day == 0 ) ) {
if( $p_default == null ) {
return '';
} else {
return $p_default;
}
} else {
return strtotime( $t_year . '-' . $t_month . '-' . $t_day );
}
break;
default:
return gpc_get_string( $p_var_name, $p_default );
}
}
/**
* Retrieve a string array GPC variable. Uses gpc_get().
* If you pass in *no* default, an error will be triggered if
* the variable does not exist
* @param string $p_var_name Variable name to retrieve.
* @param array $p_default Default value of the string array if not set.
* @return array
*/
function gpc_get_string_array( $p_var_name, array $p_default = null ) {
# Don't pass along a default unless one was given to us
# otherwise we prevent an error being triggered
$t_args = func_get_args();
$t_result = call_user_func_array( 'gpc_get', $t_args );
# If the result isn't the default we were given or an array, error
if( !((( 1 < func_num_args() ) && ( $t_result === $p_default ) ) || is_array( $t_result ) ) ) {
error_parameters( $p_var_name );
trigger_error( ERROR_GPC_ARRAY_EXPECTED, ERROR );
}
if( !is_array( $t_result ) ) {
return $t_result;
}
$t_array = array();
foreach( $t_result as $t_key => $t_value ) {
if( $t_value === null ) {
$t_array[$t_key] = null;
} else {
$t_array[$t_key] = str_replace( "\0", '', $t_value );
}
}
return $t_array;
}
/**
* Retrieve an integer array GPC variable. Uses gpc_get().
* If you pass in *no* default, an error will be triggered if
* the variable does not exist
* @param string $p_var_name Variable name to retrieve.
* @param array $p_default Default value of the integer array if not set.
* @return array
*/
function gpc_get_int_array( $p_var_name, array $p_default = null ) {
# Don't pass along a default unless one was given to us
# otherwise we prevent an error being triggered
$t_args = func_get_args();
$t_result = call_user_func_array( 'gpc_get', $t_args );
# If the result isn't the default we were given or an array, error
if( !((( 1 < func_num_args() ) && ( $t_result === $p_default ) ) || is_array( $t_result ) ) ) {
error_parameters( $p_var_name );
trigger_error( ERROR_GPC_ARRAY_EXPECTED, ERROR );
}
if( is_array( $t_result ) ) {
foreach( $t_result as $t_key => $t_value ) {
$t_result[$t_key] = (int)$t_value;
}
}
return $t_result;
}
/**
* Retrieve a boolean array GPC variable. Uses gpc_get().
* If you pass in *no* default, an error will be triggered if the variable does not exist.
* @param string $p_var_name Variable name to retrieve.
* @param array $p_default Default value of the boolean array if not set.
* @return array
*/
function gpc_get_bool_array( $p_var_name, array $p_default = null ) {
# Don't pass along a default unless one was given to us
# otherwise we prevent an error being triggered
$t_args = func_get_args();
$t_result = call_user_func_array( 'gpc_get', $t_args );
# If the result isn't the default we were given or an array, error
if( !((( 1 < func_num_args() ) && ( $t_result === $p_default ) ) || is_array( $t_result ) ) ) {
error_parameters( $p_var_name );
trigger_error( ERROR_GPC_ARRAY_EXPECTED, ERROR );
}
if( is_array( $t_result ) ) {
foreach( $t_result as $t_key => $t_value ) {
$t_result[$t_key] = gpc_string_to_bool( $t_value );
}
}
return $t_result;
}
/**
* Retrieve a cookie variable
* You may pass in any variable as a default (including null) but if
* you pass in *no* default then an error will be triggered if the cookie cannot be found
* @param string $p_var_name Variable name to retrieve.
* @param string $p_default Default value if not set.
* @return string
*/
function gpc_get_cookie( $p_var_name, $p_default = null ) {
if( isset( $_COOKIE[$p_var_name] ) ) {
$t_result = $_COOKIE[$p_var_name];
} else if( func_num_args() > 1 ) {
# check for a default passed in (allowing null)
$t_result = $p_default;
} else {
error_parameters( $p_var_name );
trigger_error( ERROR_GPC_VAR_NOT_FOUND, ERROR );
}
return $t_result;
}
/**
* Set a cookie variable
* If $p_expire is false instead of a number, the cookie will expire when
* the browser is closed; if it is true, the default time from the config
* file will be used.
* If $p_path or $p_domain are omitted, defaults are used.
* Set $p_httponly to false if client-side Javascript needs to read/write
* the cookie. Otherwise it is safe to leave this value unspecified, as
* the default value is true.
* @todo this function is to be modified by Victor to add CRC... for now it just passes the parameters through to setcookie()
* @param string $p_name Cookie name to set.
* @param string $p_value Cookie value to set.
* @param boolean $p_expire Cookie Expiry - default is false.
* @param string $p_path Cookie Path - default cookie_path configuration variable.
* @param string $p_domain Cookie Domain - default is cookie_domain configuration variable.
* @param boolean $p_httponly Default true.
* @return boolean - true on success, false on failure
*/
function gpc_set_cookie( $p_name, $p_value, $p_expire = false, $p_path = null, $p_domain = null, $p_httponly = true ) {
global $g_cookie_secure_flag_enabled;
if( false === $p_expire ) {
$p_expire = 0;
} else if( true === $p_expire ) {
$t_cookie_length = config_get( 'cookie_time_length' );
$p_expire = time() + $t_cookie_length;
}
if( null === $p_path ) {
$p_path = config_get( 'cookie_path' );
}
if( null === $p_domain ) {
$p_domain = config_get( 'cookie_domain' );
}
return setcookie( $p_name, $p_value, $p_expire, $p_path, $p_domain, $g_cookie_secure_flag_enabled, true );
}
/**
* Clear a cookie variable
* @param string $p_name Cookie clear to set.
* @param string $p_path Cookie path.
* @param string $p_domain Cookie domain.
* @return boolean
*/
function gpc_clear_cookie( $p_name, $p_path = null, $p_domain = null ) {
if( null === $p_path ) {
$p_path = config_get( 'cookie_path' );
}
if( null === $p_domain ) {
$p_domain = config_get( 'cookie_domain' );
}
if( isset( $_COOKIE[$p_name] ) ) {
unset( $_COOKIE[$p_name] );
}
# dont try to send cookie if headers are send (guideweb)
if( !headers_sent() ) {
return setcookie( $p_name, '', -1, $p_path, $p_domain );
} else {
return false;
}
}
/**
* Retrieve a file variable
* You may pass in any variable as a default (including null) but if
* you pass in *no* default then an error will be triggered if the file
* cannot be found
* @param string $p_var_name Variable name.
* @param mixed $p_default Default value.
* @return mixed
*/
function gpc_get_file( $p_var_name, $p_default = null ) {
if( isset( $_FILES[$p_var_name] ) ) {
# FILES are not escaped even if magic_quotes is ON, this applies to Windows paths.
$t_result = $_FILES[$p_var_name];
} else if( func_num_args() > 1 ) {
# check for a default passed in (allowing null)
$t_result = $p_default;
} else {
error_parameters( $p_var_name );
trigger_error( ERROR_GPC_VAR_NOT_FOUND, ERROR );
}
return $t_result;
}
/**
* Convert a POST/GET parameter to an array if it is not already one.
* There is no return value from this function - The $_POST/$_GET are updated as appropriate.
* @param string $p_var_name The name of the parameter.
* @return void
*/
function gpc_make_array( $p_var_name ) {
if( isset( $_POST[$p_var_name] ) && !is_array( $_POST[$p_var_name] ) ) {
$_POST[$p_var_name] = array(
$_POST[$p_var_name],
);
}
if( isset( $_GET[$p_var_name] ) && !is_array( $_GET[$p_var_name] ) ) {
$_GET[$p_var_name] = array(
$_GET[$p_var_name],
);
}
}
/**
* Convert a string to a bool
* @param string $p_string A string to convert to a boolean value.
* @return boolean
*/
function gpc_string_to_bool( $p_string ) {
if( 0 == strcasecmp( 'off', $p_string ) || 0 == strcasecmp( 'no', $p_string ) || 0 == strcasecmp( 'false', $p_string ) || 0 == strcasecmp( '', $p_string ) || 0 == strcasecmp( '0', $p_string ) ) {
return false;
} else {
return true;
}
}