/
mc_api.php
625 lines (521 loc) · 18.4 KB
/
mc_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
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
<?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/>.
/**
* A webservice interface to Mantis Bug Tracker
*
* @package MantisBT
* @copyright Copyright 2004 Victor Boctor - vboctor@users.sourceforge.net
* @copyright Copyright 2005 MantisBT Team - mantisbt-dev@lists.sourceforge.net
* @link http://www.mantisbt.org
*/
# set up error_handler() as the new default error handling function
set_error_handler( 'mc_error_handler' );
/**
* A factory class that can abstract away operations that can behave differently based
* on the underlying soap implementation.
*
* TODO: Consider removing this class since it currently has one implementation which
* targets the php soap extension.
*/
class SoapObjectsFactory {
/**
*
*/
static function newSoapFault( $p_fault_code, $p_fault_string) {
return new SoapFault( $p_fault_code, $p_fault_string );
}
/**
*
*/
static function unwrapObject( $p_object ) {
if ( is_object( $p_object ) ) {
return get_object_vars( $p_object );
}
return $p_object;
}
/**
*
*/
static function newDateTimeVar( $p_value ) {
$string_value = self::newDateTimeString( $p_value );
return new SoapVar( $string_value, XSD_DATETIME, 'xsd:dateTime');
}
/**
*
*/
static function newDateTimeString ( $p_timestamp ) {
if ( $p_timestamp == null || date_is_null( $p_timestamp ) ) {
return null;
}
return date('c', (int) $p_timestamp);
}
/**
*
*/
static function parseDateTimeString ( $p_string ) {
return strtotime( $p_string );
}
/**
*
*/
static function encodeBinary ( $p_binary ) {
return $p_binary;
}
/**
*
*/
static function isSoapFault ( $p_maybe_fault ) {
if ( !is_object( $p_maybe_fault ) ) {
return false;
}
return get_class($p_maybe_fault ) == 'SoapFault';
}
}
/**
* Abstract the differences in common actions between the php5 soap extension and nusoap
*
* <p>As long as we decide to support both implementations we should add all non-generic
* action code to this class.</p>
*/
class SoapActions {
/**
* Sends a fault to the user and immediately terminates processing
*
* @param string $p_error_type
* @param string $p_error_message
* @throws SoapFault
*/
static function sendSoapFault ( $p_error_type, $p_error_message) {
global $l_oServer;
if ( $l_oServer ) {
$l_oServer->fault( $p_error_type, $p_error_message);
$l_oServer->send_response();
exit();
} else {
throw new SoapFault($p_error_type, $p_error_message);
}
}
}
/**
* Get the MantisConnect webservice version.
*/
function mc_version() {
return MANTIS_VERSION;
}
/**
* Attempts to login the user.
* If logged in successfully, return user information.
* If failed to login in, then throw a fault.
*/
function mc_login( $p_username, $p_password ) {
$t_user_id = mci_check_login( $p_username, $p_password );
if ( $t_user_id === false ) {
return mci_soap_fault_login_failed();
}
return mci_user_get( $p_username, $p_password, $t_user_id );
}
/**
* Given an id, this method returns the user.
* When calling this method make sure that the caller has the right to retrieve
* information about the target user.
*/
function mci_user_get( $p_username, $p_password, $p_user_id ) {
$t_user_data = array();
// if user doesn't exist, then mci_account_get_array_by_id() will throw.
$t_user_data['account_data'] = mci_account_get_array_by_id( $p_user_id );
$t_user_data['access_level'] = access_get_global_level( $p_user_id );
$t_user_data['timezone'] = user_pref_get_pref( $p_user_id, 'timezone' );
return $t_user_data;
}
# access_ if MantisBT installation is marked as offline by the administrator.
# true: offline, false: online
function mci_is_mantis_offline() {
$t_offline_file = dirname( dirname( __FILE__ ) ) . DIRECTORY_SEPARATOR . 'mantis_offline.php';
return file_exists( $t_offline_file );
}
# return user_id if successful, otherwise false.
function mci_check_login( $p_username, $p_password ) {
if( mci_is_mantis_offline() ) {
return false;
}
# Must not pass in password, otherwise, authentication will be by-passed.
$t_password = ( $p_password === null ) ? '' : $p_password;
if ( false === auth_attempt_script_login( $p_username, $t_password ) ) {
return false;
}
return auth_get_current_user_id();
}
function mci_has_readonly_access( $p_user_id, $p_project_id = ALL_PROJECTS ) {
$t_access_level = user_get_access_level( $p_user_id, $p_project_id );
return( $t_access_level >= config_get( 'webservice_readonly_access_level_threshold' ) );
}
function mci_has_readwrite_access( $p_user_id, $p_project_id = ALL_PROJECTS ) {
$t_access_level = user_get_access_level( $p_user_id, $p_project_id );
return( $t_access_level >= config_get( 'webservice_readwrite_access_level_threshold' ) );
}
function mci_has_access( $p_access_level, $p_user_id, $p_project_id = ALL_PROJECTS ) {
$t_access_level = user_get_access_level( $p_user_id, $p_project_id );
return( $t_access_level >= (int) $p_access_level );
}
function mci_has_administrator_access( $p_user_id, $p_project_id = ALL_PROJECTS ) {
$t_access_level = user_get_access_level( $p_user_id, $p_project_id );
return( $t_access_level >= config_get( 'webservice_admin_access_level_threshold' ) );
}
function mci_get_project_id( $p_project ) {
if ( is_object( $p_project ) )
$p_project = get_object_vars( $p_project );
if ( isset( $p_project['id'] ) && (int) $p_project['id'] != 0 ) {
$t_project_id = (int) $p_project['id'];
} else if ( isset( $p_project['name'] ) && !is_blank( $p_project['name'] ) ) {
$t_project_id = project_get_id_by_name( $p_project['name'] );
} else {
$t_project_id = ALL_PROJECTS;
}
return $t_project_id;
}
function mci_get_project_status_id( $p_status ) {
return mci_get_enum_id_from_objectref( 'project_status', $p_status );
}
function mci_get_project_view_state_id( $p_view_state ) {
return mci_get_enum_id_from_objectref( 'project_view_state', $p_view_state );
}
function mci_get_user_id( $p_user ) {
$p_user = SoapObjectsFactory::unwrapObject( $p_user );
$t_user_id = 0;
if ( isset( $p_user['id'] ) && (int) $p_user['id'] != 0 ) {
$t_user_id = (int) $p_user['id'];
} elseif ( isset( $p_user['name'] ) ) {
$t_user_id = user_get_id_by_name( $p_user['name'] );
} elseif ( isset( $p_user['email'] ) ) {
$t_user_id = user_get_id_by_email( $p_user['email'] );
}
return $t_user_id;
}
function mci_get_user_lang( $p_user_id ) {
$t_lang = user_pref_get_pref( $p_user_id, 'language' );
if( $t_lang == 'auto' ) {
$t_lang = config_get( 'fallback_language' );
}
return $t_lang;
}
function mci_get_status_id( $p_status ) {
return mci_get_enum_id_from_objectref( 'status', $p_status );
}
function mci_get_severity_id( $p_severity ) {
return mci_get_enum_id_from_objectref( 'severity', $p_severity );
}
function mci_get_priority_id( $p_priority ) {
return mci_get_enum_id_from_objectref( 'priority', $p_priority );
}
function mci_get_reproducibility_id( $p_reproducibility ) {
return mci_get_enum_id_from_objectref( 'reproducibility', $p_reproducibility );
}
function mci_get_resolution_id( $p_resolution ) {
return mci_get_enum_id_from_objectref( 'resolution', $p_resolution );
}
function mci_get_projection_id( $p_projection ) {
return mci_get_enum_id_from_objectref( 'projection', $p_projection );
}
function mci_get_eta_id( $p_eta ) {
return mci_get_enum_id_from_objectref( 'eta', $p_eta );
}
function mci_get_view_state_id( $p_view_state ) {
return mci_get_enum_id_from_objectref( 'view_state', $p_view_state );
}
# Get null on empty value.
#
# @param Object $p_value The value
# @return Object The value if not empty; null otherwise.
#
function mci_null_if_empty( $p_value ) {
if( !is_blank( $p_value ) ) {
return $p_value;
}
return null;
}
/**
* Removes any invalid character from the string per XML 1.0 specification
*
* @param string $p_input
* @return string the sanitized XML
*/
function mci_sanitize_xml_string ( $p_input ) {
return preg_replace( '/[^\x9\xA\xD\x20-\x{D7FF}\x{E000}-\x{FFFD}\x{10000}-\x{10FFFF}]+/u', '', $p_input);
}
/**
* Gets the url for MantisBT.
*
* @return MantisBT URL terminated by a /.
*/
function mci_get_mantis_path() {
return config_get( 'path' );
}
# Given a enum string and num, return the appropriate localized string
function mci_get_enum_element( $p_enum_name, $p_val, $p_lang ) {
$t_enum_string = config_get( $p_enum_name . '_enum_string' );
$t_localized_enum_string = lang_get( $p_enum_name . '_enum_string', $p_lang );
return MantisEnum::getLocalizedLabel( $t_enum_string, $t_localized_enum_string, $p_val );
}
# Gets the sub-projects that are accessible to the specified user / project.
function mci_user_get_accessible_subprojects( $p_user_id, $p_parent_project_id, $p_lang = null ) {
if( $p_lang === null ) {
$t_lang = mci_get_user_lang( $p_user_id );
} else {
$t_lang = $p_lang;
}
$t_result = array();
foreach( user_get_accessible_subprojects( $p_user_id, $p_parent_project_id ) as $t_subproject_id ) {
$t_subproject_row = project_cache_row( $t_subproject_id );
$t_subproject = array();
$t_subproject['id'] = $t_subproject_id;
$t_subproject['name'] = $t_subproject_row['name'];
$t_subproject['status'] = mci_enum_get_array_by_id( $t_subproject_row['status'], 'project_status', $t_lang );
$t_subproject['enabled'] = $t_subproject_row['enabled'];
$t_subproject['view_state'] = mci_enum_get_array_by_id( $t_subproject_row['view_state'], 'project_view_state', $t_lang );
$t_subproject['access_min'] = mci_enum_get_array_by_id( $t_subproject_row['access_min'], 'access_levels', $t_lang );
$t_subproject['file_path'] = array_key_exists( 'file_path', $t_subproject_row ) ? $t_subproject_row['file_path'] : "";
$t_subproject['description'] = array_key_exists( 'description', $t_subproject_row ) ? $t_subproject_row['description'] : "";
$t_subproject['subprojects'] = mci_user_get_accessible_subprojects( $p_user_id, $t_subproject_id, $t_lang );
$t_result[] = $t_subproject;
}
return $t_result;
}
function translate_category_name_to_id( $p_category_name, $p_project_id ) {
if ( !isset( $p_category_name ) ) {
return 0;
}
$t_cat_array = category_get_all_rows( $p_project_id );
foreach( $t_cat_array as $t_category_row ) {
if( $t_category_row['name'] == $p_category_name ) {
return $t_category_row['id'];
}
}
return 0;
}
/**
* Basically this is a copy of core/filter_api.php#filter_db_get_available_queries().
* The only difference is that the result of this function is not an array of filter
* names but an array of filter structures.
*/
function mci_filter_db_get_available_queries( $p_project_id = null, $p_user_id = null ) {
$t_filters_table = db_get_table( 'filters' );
$t_overall_query_arr = array();
if( null === $p_project_id ) {
$t_project_id = helper_get_current_project();
} else {
$t_project_id = (int)$p_project_id;
}
if( null === $p_user_id ) {
$t_user_id = auth_get_current_user_id();
} else {
$t_user_id = (int)$p_user_id;
}
# If the user doesn't have access rights to stored queries, just return
if( !access_has_project_level( config_get( 'stored_query_use_threshold' ) ) ) {
return $t_overall_query_arr;
}
# Get the list of available queries. By sorting such that public queries are
# first, we can override any query that has the same name as a private query
# with that private one
$query = "SELECT * FROM $t_filters_table
WHERE (project_id=" . db_param() . "
OR project_id=0)
AND name!=''
AND (is_public = " . db_prepare_bool(true) . "
OR user_id = " . db_param() . ")
ORDER BY is_public DESC, name ASC";
$t_result = db_query_bound( $query, array( $t_project_id, $t_user_id ) );
$query_count = db_num_rows( $t_result );
for( $i = 0;$i < $query_count;$i++ ) {
$row = db_fetch_array( $t_result );
$t_filter_detail = explode( '#', $row['filter_string'], 2 );
if ( !isset($t_filter_detail[1]) ) {
continue;
}
$t_filter = unserialize( $t_filter_detail[1] );
$t_filter = filter_ensure_valid_filter( $t_filter );
$row['url'] = filter_get_url( $t_filter );
$t_overall_query_arr[$row['name']] = $row;
}
return array_values( $t_overall_query_arr );
}
/**
* Get a category definition.
*
* @param integer $p_category_id The id of the category to retrieve.
* @return array an array containing the id and the name of the category.
*/
function mci_category_as_array_by_id( $p_category_id ) {
$t_result = array();
$t_result['id'] = $p_category_id;
$t_result['name'] = category_get_name( $p_category_id );
return $t_result;
}
/**
* Transforms a version array into an array suitable for marshalling into ProjectVersionData
*
* @param array $p_version
*/
function mci_project_version_as_array( $p_version ) {
return array(
'id' => $p_version['id'],
'name' => $p_version['version'],
'project_id' => $p_version['project_id'],
'date_order' => SoapObjectsFactory::newDateTimeVar( $p_version['date_order'] ),
'description' => mci_null_if_empty( $p_version['description'] ),
'released' => $p_version['released'],
'obsolete' => $p_version['obsolete']
);
}
/**
* Returns time tracking information from a bug note.
*
* @param int $p_issue_id The id of the issue
* @param array $p_note A note as passed to the soap api methods
*
* @return String the string time entry to be added to the bugnote, in 'HH:mm' format
*/
function mci_get_time_tracking_from_note( $p_issue_id, $p_note) {
if ( !access_has_bug_level( config_get( 'time_tracking_view_threshold' ), $p_issue_id ) )
return '00:00';
if ( !isset( $p_note['time_tracking'] ))
return '00:00';
return db_minutes_to_hhmm($p_note['time_tracking']);
}
# Default error handler
#
# This handler will not receive E_ERROR, E_PARSE, E_CORE_*, or E_COMPILE_*
# errors.
#
# E_USER_* are triggered by us and will contain an error constant in $p_error
# The others, being system errors, will come with a string in $p_error
#
function mc_error_handler( $p_type, $p_error, $p_file, $p_line, $p_context ) {
# check if errors were disabled with @ somewhere in this call chain
# also suppress php 5 strict warnings
if( 0 == error_reporting() || 2048 == $p_type ) {
return;
}
# flush any language overrides to return to user's natural default
if( function_exists( 'db_is_connected' ) ) {
if( db_is_connected() ) {
lang_push( lang_get_default() );
}
}
# build an appropriate error string
switch( $p_type ) {
case E_WARNING:
$t_error_type = 'SYSTEM WARNING';
$t_error_description = $p_error;
break;
case E_NOTICE:
$t_error_type = 'SYSTEM NOTICE';
$t_error_description = $p_error;
break;
case E_USER_ERROR:
$t_error_type = "APPLICATION ERROR #$p_error";
$t_error_description = error_string( $p_error );
break;
case E_USER_WARNING:
$t_error_type = "APPLICATION WARNING #$p_error";
$t_error_description = error_string( $p_error );
break;
case E_USER_NOTICE:
# used for debugging
$t_error_type = 'DEBUG';
$t_error_description = $p_error;
break;
default:
#shouldn't happen, just display the error just in case
$t_error_type = '';
$t_error_description = $p_error;
}
$t_error_stack = error_get_stack_trace();
error_log("[mantisconnect.php] Error Type: $t_error_type,\nError Description: $t_error_description\nStack Trace:\n$t_error_stack");
SoapActions::sendSoapFault('Server', "Error Type: $t_error_type,\nError Description: $t_error_description");
}
# Get a stack trace if PHP provides the facility or xdebug is present
function error_get_stack_trace() {
$t_trace = '';
if ( extension_loaded( 'xdebug' ) ) {
#check for xdebug presence
$t_stack = xdebug_get_function_stack();
# reverse the array in a separate line of code so the
# array_reverse() call doesn't appear in the stack
$t_stack = array_reverse( $t_stack );
array_shift( $t_stack );
#remove the call to this function from the stack trace
foreach( $t_stack as $t_frame ) {
$t_trace .= ( isset( $t_frame['file'] ) ? basename( $t_frame['file'] ) : 'UnknownFile' ) . ' L' . ( isset( $t_frame['line'] ) ? $t_frame['line'] : '?' ) . ' ' . ( isset( $t_frame['function'] ) ? $t_frame['function'] : 'UnknownFunction' );
$t_args = array();
if ( isset( $t_frame['params'] ) && ( count( $t_frame['params'] ) > 0 ) ) {
$t_trace .= ' Params: ';
foreach( $t_frame['params'] as $t_value ) {
$t_args[] = error_build_parameter_string( $t_value );
}
$t_trace .= '(' . implode( $t_args, ', ' ) . ')';
} else {
$t_trace .= '()';
}
$t_trace .= "\n";
}
} else {
$t_stack = debug_backtrace();
array_shift( $t_stack ); #remove the call to this function from the stack trace
array_shift( $t_stack ); #remove the call to the error handler from the stack trace
foreach( $t_stack as $t_frame ) {
$t_trace .= ( isset( $t_frame['file'] ) ? basename( $t_frame['file'] ) : 'UnknownFile' ) . ' L' . ( isset( $t_frame['line'] ) ? $t_frame['line'] : '?' ) . ' ' . ( isset( $t_frame['function'] ) ? $t_frame['function'] : 'UnknownFunction' );
$t_args = array();
if( isset( $t_frame['args'] ) ) {
foreach( $t_frame['args'] as $t_value ) {
$t_args[] = error_build_parameter_string( $t_value );
}
$t_trace .= '(' . implode( $t_args, ', ' ) . ')';
} else {
$t_trace .= '()';
}
$t_trace .= "\n";
}
}
return $t_trace;
}
/**
* Returns a soap_fault signalling corresponding to a failed login
* situation
*
* @return soap_fault
*/
function mci_soap_fault_login_failed() {
return SoapObjectsFactory::newSoapFault('Client', 'Access denied');
}
/**
* Returns a soap_fault signalling that the user does not have
* access rights for the specific action.
*
* @param int $p_user_id a user id, optional
* @param string $p_detail The optional details to append to the error message
* @return soap_fault
*/
function mci_soap_fault_access_denied( $p_user_id = 0, $p_detail = '' ) {
if ( $p_user_id ) {
$t_user_name = user_get_name( $p_user_id );
$t_reason = 'Access denied for user '. $t_user_name . '.';
} else {
$t_reason = 'Access denied';
}
if ( !is_blank( $p_detail ))
$t_reason .= ' Reason: ' . $p_detail . '.';
return SoapObjectsFactory::newSoapFault('Client', $t_reason);
}