/
mc_project_api.php
800 lines (664 loc) · 28.7 KB
/
mc_project_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
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
<?php
# MantisConnect - A webservice interface to Mantis Bug Tracker
# Copyright (C) 2004-2007 Victor Boctor - vboctor@users.sourceforge.net
# This program is distributed under dual licensing. These include
# GPL and a commercial licenses. Victor Boctor reserves the right to
# change the license of future releases.
# See docs/ folder for more details
function mc_project_get_issues( $p_username, $p_password, $p_project_id, $p_page_number, $p_per_page ) {
$t_user_id = mci_check_login( $p_username, $p_password );
$t_lang = mci_get_user_lang( $t_user_id );
if( $t_user_id === false ) {
return new soap_fault( 'Client', '', 'Access Denied' );
}
if( !project_exists( $p_project_id ) ) {
return new soap_fault( 'Client', '', "Project '$p_project_id' does not exist." );
}
if( !mci_has_readonly_access( $t_user_id, $p_project_id ) ) {
return new soap_fault( 'Client', '', 'Access Denied' );
}
$t_page_count = 0;
$t_bug_count = 0;
$t_rows = filter_get_bug_rows( $p_page_number, $p_per_page, $t_page_count, $t_bug_count, null, $p_project_id );
$t_result = array();
foreach( $t_rows as $t_issue_data ) {
$t_id = $t_issue_data->id;
$t_issue = array();
$t_issue['id'] = $t_id;
$t_issue['view_state'] = mci_enum_get_array_by_id( $t_issue_data->view_state, 'view_state', $t_lang );
$t_issue['last_updated'] = timestamp_to_iso8601( $t_issue_data->last_updated );
$t_issue['project'] = mci_project_as_array_by_id( $t_issue_data->project_id );
$t_issue['category'] = mci_null_if_empty( category_get_name( $t_issue_data->category_id ) );
$t_issue['priority'] = mci_enum_get_array_by_id( $t_issue_data->priority, 'priority', $t_lang );
$t_issue['severity'] = mci_enum_get_array_by_id( $t_issue_data->severity, 'severity', $t_lang );
$t_issue['status'] = mci_enum_get_array_by_id( $t_issue_data->status, 'status', $t_lang );
$t_issue['reporter'] = mci_account_get_array_by_id( $t_issue_data->reporter_id );
$t_issue['summary'] = $t_issue_data->summary;
$t_issue['version'] = mci_null_if_empty( $t_issue_data->version );
$t_issue['build'] = mci_null_if_empty( $t_issue_data->build );
$t_issue['platform'] = mci_null_if_empty( $t_issue_data->platform );
$t_issue['os'] = mci_null_if_empty( $t_issue_data->os );
$t_issue['os_build'] = mci_null_if_empty( $t_issue_data->os_build );
$t_issue['reproducibility'] = mci_enum_get_array_by_id( $t_issue_data->reproducibility, 'reproducibility', $t_lang );
$t_issue['date_submitted'] = timestamp_to_iso8601( $t_issue_data->date_submitted );
$t_issue['sponsorship_total'] = $t_issue_data->sponsorship_total;
if( !empty( $t_issue_data->handler_id ) ) {
$t_issue['handler'] = mci_account_get_array_by_id( $t_issue_data->handler_id );
}
$t_issue['projection'] = mci_enum_get_array_by_id( $t_issue_data->projection, 'projection', $t_lang );
$t_issue['eta'] = mci_enum_get_array_by_id( $t_issue_data->eta, 'eta', $t_lang );
$t_issue['resolution'] = mci_enum_get_array_by_id( $t_issue_data->resolution, 'resolution', $t_lang );
$t_issue['fixed_in_version'] = mci_null_if_empty( $t_issue_data->fixed_in_version );
$t_issue['description'] = bug_get_text_field( $t_id, 'description' );
$t_issue['steps_to_reproduce'] = mci_null_if_empty( bug_get_text_field( $t_id, 'steps_to_reproduce' ) );
$t_issue['additional_information'] = mci_null_if_empty( bug_get_text_field( $t_id, 'additional_information' ) );
$t_issue['attachments'] = mci_issue_get_attachments( $t_issue_data->id );
$t_issue['relationships'] = mci_issue_get_relationships( $t_issue_data->id, $t_user_id );
$t_issue['notes'] = mci_issue_get_notes( $t_issue_data->id );
$t_issue['custom_fields'] = mci_issue_get_custom_fields( $t_issue_data->id );
$t_result[] = $t_issue;
}
return $t_result;
}
/**
* Get all projects accessible by the given user.
*
* @param string $p_username The name of the user trying to access the project list.
* @param string $p_password The password of the user.
* @return Array suitable to be converted into a ProjectDataArray
*/
function mc_projects_get_user_accessible( $p_username, $p_password ) {
$t_user_id = mci_check_login( $p_username, $p_password );
if( $t_user_id === false ) {
return new soap_fault( 'Client', '', 'Access Denied' );
}
if( !mci_has_readonly_access( $t_user_id ) ) {
return new soap_fault( 'Client', '', 'Access Denied' );
}
$t_lang = mci_get_user_lang( $t_user_id );
$t_result = array();
foreach( user_get_accessible_projects( $t_user_id ) as $t_project_id ) {
$t_project_row = project_cache_row( $t_project_id );
$t_project = array();
$t_project['id'] = $t_project_id;
$t_project['name'] = $t_project_row['name'];
$t_project['status'] = mci_enum_get_array_by_id( $t_project_row['status'], 'project_status', $t_lang );
$t_project['enabled'] = $t_project_row['enabled'];
$t_project['view_state'] = mci_enum_get_array_by_id( $t_project_row['view_state'], 'project_view_state', $t_lang );
$t_project['access_min'] = mci_enum_get_array_by_id( $t_project_row['access_min'], 'access_levels', $t_lang );
$t_project['file_path'] = array_key_exists( 'file_path', $t_project_row ) ? $t_project_row['file_path'] : "";
$t_project['description'] = array_key_exists( 'description', $t_project_row ) ? $t_project_row['description'] : "";
$t_project['subprojects'] = mci_user_get_accessible_subprojects( $t_user_id, $t_project_id, $t_lang );
$t_result[] = $t_project;
}
return $t_result;
}
/**
* Get all categories of a project.
*
* @param string $p_username The name of the user trying to access the categories.
* @param string $p_password The password of the user.
* @param integer $p_project_id The id of the project to retrieve the categories for.
* @return Array of categorie names
*/
function mc_project_get_categories( $p_username, $p_password, $p_project_id ) {
$t_user_id = mci_check_login( $p_username, $p_password );
if( $t_user_id === false ) {
return new soap_fault( 'Client', '', 'Access Denied' );
}
if( !project_exists( $p_project_id ) ) {
return new soap_fault( 'Client', '', "Project '$p_project_id' does not exist." );
}
if( !mci_has_readonly_access( $t_user_id, $p_project_id ) ) {
return new soap_fault( 'Client', '', 'Access Denied' );
}
$t_result = array();
$t_cat_array = category_get_all_rows( $p_project_id );
foreach( $t_cat_array as $t_category_row ) {
$t_result[] = $t_category_row['name'];
}
return $t_result;
}
/**
* Get all versions of a project.
*
* @param string $p_username The name of the user trying to access the versions.
* @param string $p_password The password of the user.
* @param integer $p_project_id The id of the project to retrieve the versions for.
* @return Array representing a ProjectVersionDataArray structure.
*/
function mc_project_get_versions( $p_username, $p_password, $p_project_id ) {
$t_user_id = mci_check_login( $p_username, $p_password );
if( $t_user_id === false ) {
return new soap_fault( 'Client', '', 'Access Denied' );
}
if( !project_exists( $p_project_id ) ) {
return new soap_fault( 'Client', '', "Project '$p_project_id' does not exist." );
}
if( !mci_has_readonly_access( $t_user_id, $p_project_id ) ) {
return new soap_fault( 'Client', '', 'Access Denied' );
}
$t_result = array();
foreach( version_get_all_rows( $p_project_id, VERSION_ALL ) as $t_version ) {
$t_result[] = array(
'id' => $t_version['id'],
'name' => $t_version['version'],
'project_id' => $p_project_id,
'date_order' => timestamp_to_iso8601( $t_version['date_order'] ),
'description' => mci_null_if_empty( $t_version['description'] ),
'released' => $t_version['released'],
);
}
return $t_result;
}
/**
* Get all released versions of a project.
*
* @param string $p_username The name of the user trying to access the versions.
* @param string $p_password The password of the user.
* @param integer $p_project_id The id of the project to retrieve the versions for.
* @return Array representing a ProjectVersionDataArray structure.
*/
function mc_project_get_released_versions( $p_username, $p_password, $p_project_id ) {
$t_user_id = mci_check_login( $p_username, $p_password );
if( $t_user_id === false ) {
return new soap_fault( 'Client', '', 'Access Denied' );
}
if( !project_exists( $p_project_id ) ) {
return new soap_fault( 'Client', '', "Project '$p_project_id' does not exist." );
}
if( !mci_has_readonly_access( $t_user_id, $p_project_id ) ) {
return new soap_fault( 'Client', '', 'Access Denied' );
}
$t_result = array();
foreach( version_get_all_rows( $p_project_id, VERSION_RELEASED ) as $t_version ) {
$t_result[] = array(
'id' => $t_version['id'],
'name' => $t_version['version'],
'project_id' => $p_project_id,
'date_order' => timestamp_to_iso8601( $t_version['date_order'] ),
'description' => mci_null_if_empty( $t_version['description'] ),
'released' => $t_version['released'],
);
}
return $t_result;
}
/**
* Get all unreleased (a.k.a. future) versions of a project.
*
* @param string $p_username The name of the user trying to access the versions.
* @param string $p_password The password of the user.
* @param integer $p_project_id The id of the project to retrieve the versions for.
* @return Array representing a ProjectVersionDataArray structure.
*/
function mc_project_get_unreleased_versions( $p_username, $p_password, $p_project_id ) {
$t_user_id = mci_check_login( $p_username, $p_password );
if( $t_user_id === false ) {
return new soap_fault( 'Client', '', 'Access Denied' );
}
if( !project_exists( $p_project_id ) ) {
return new soap_fault( 'Client', '', "Project '$p_project_id' does not exist." );
}
if( !mci_has_readonly_access( $t_user_id, $p_project_id ) ) {
return new soap_fault( 'Client', '', 'Access Denied' );
}
$t_result = array();
foreach( version_get_all_rows( $p_project_id, VERSION_FUTURE ) as $t_version ) {
$t_result[] = array(
'id' => $t_version['id'],
'name' => $t_version['version'],
'project_id' => $p_project_id,
'date_order' => timestamp_to_iso8601( $t_version['date_order'] ),
'description' => mci_null_if_empty( $t_version['description'] ),
'released' => $t_version['released'],
);
}
return $t_result;
}
/**
* Submit the specified version details.
*
* @param string $p_username The name of the user trying to add the issue.
* @param string $p_password The password of the user.
* @param Array $p_version A ProjectVersionData structure containing information about the new verison.
* @return integer The id of the created version.
*/
function mc_project_version_add( $p_username, $p_password, $p_version ) {
$t_user_id = mci_check_login( $p_username, $p_password );
if( $t_user_id === false ) {
return new soap_fault( 'Client', '', 'Access Denied', 'Username/password combination was incorrect' );
}
$t_project_id = $p_version['project_id'];
$t_name = $p_version['name'];
$t_released = $p_version['released'];
$t_description = $p_version['description'];
$t_date_order = $p_version['date_order'];
if ( is_blank( $t_project_id ) ) {
return new soap_fault( 'Client', '', 'Mandatory field "project_id" was missing' );
}
if ( !project_exists( $t_project_id ) ) {
return new soap_fault( 'Client', '', "Project '$t_project_id' does not exist." );
}
if ( !mci_has_readwrite_access( $t_user_id, $t_project_id ) ) {
return new soap_fault( 'Client', '', 'Access Denied' );
}
if ( !mci_has_access( config_get( 'manage_project_threshold' ), $t_user_id, $t_project_id ) ) {
return new soap_fault( 'Client', '', 'Access Denied' );
}
if ( is_blank( $t_name ) ) {
return new soap_fault( 'Client', '', 'Mandatory field "name" was missing' );
}
if ( !version_is_unique( $t_name, $t_project_id ) ) {
return new soap_fault( 'Client', '', 'Version exists for project', 'The version you attempted to add already exists for this project' );
}
if ( $t_released === false ) {
$t_released = VERSION_FUTURE;
} else {
$t_released = VERSION_RELEASED;
}
if ( version_add( $t_project_id, $t_name, $t_released, $t_description ) ) {
$t_version_id = version_get_id( $t_name, $t_project_id );
if ( !is_blank( $t_date_order ) ) {
$t_version = version_get( $t_version_id );
$t_version->date_order = date( "Y-m-d H:i:s", strtotime( $t_date_order ) );
version_update( $t_version );
}
return $t_version_id;
}
return null;
}
/**
* Submit the specified version details.
*
* @param string $p_username The name of the user trying to update the issue.
* @param string $p_password The password of the user.
* @param integer $p_version_id A version's id
* @param Array $p_version A ProjectVersionData structure containing information about the new verison.
* @return bool returns true or false depending on the success of the update action
*/
function mc_project_version_update( $p_username, $p_password, $p_version_id, $p_version ) {
$t_user_id = mci_check_login( $p_username, $p_password );
if( $t_user_id === false ) {
return new soap_fault( 'Client', '', 'Access Denied', 'Username/password combination was incorrect' );
}
if( is_blank( $p_version_id ) ) {
return new soap_fault( 'Client', '', 'Mandatory field "version_id" was missing' );
}
if( !version_exists( $p_version_id ) ) {
return new soap_fault( 'Client', '', "Version '$p_version_id' does not exist." );
}
$t_project_id = $p_version['project_id'];
$t_name = $p_version['name'];
$t_released = $p_version['released'];
$t_description = $p_version['description'];
$t_date_order = $p_version['date_order'];
if ( is_blank( $t_project_id ) ) {
return new soap_fault( 'Client', '', 'Mandatory field "project_id" was missing' );
}
if ( !project_exists( $t_project_id ) ) {
return new soap_fault( 'Client', '', "Project '$t_project_id' does not exist." );
}
if ( !mci_has_readwrite_access( $t_user_id, $t_project_id ) ) {
return new soap_fault( 'Client', '', 'Access Denied' );
}
if ( !mci_has_access( config_get( 'manage_project_threshold' ), $t_user_id, $t_project_id ) ) {
return new soap_fault( 'Client', '', 'Access Denied' );
}
if ( is_blank( $t_name ) ) {
return new soap_fault( 'Client', '', 'Mandatory field "name" was missing' );
}
# check for duplicates
$t_old_version_name = version_get_field( $p_version_id, 'version' );
if ( ( strtolower( $t_old_version_name ) != strtolower( $t_name ) ) && !version_is_unique( $t_name, $t_project_id ) ) {
return new soap_fault( 'Client', '', 'Version exists for project', 'The version you attempted to update already exists for this project' );
}
if ( $t_released === false ) {
$t_released = VERSION_FUTURE;
} else {
$t_released = VERSION_RELEASED;
}
$t_version_data = new VersionData();
$t_version_data->id = $p_version_id;
$t_version_data->project_id = $t_project_id;
$t_version_data->version = $t_name;
$t_version_data->description = $t_description;
$t_version_data->released = $t_released;
$t_version_data->date_order = date( "Y-m-d H:i:s", strtotime( $t_date_order ) );
return version_update( $t_version_data );
}
/**
* Delete a version.
*
* @param string $p_username The name of the user trying to delete the version.
* @param string $p_password The password of the user.
* @param integer $p_version_id A version's id
* @return bool returns true or false depending on the success of the delete action
*/
function mc_project_version_delete( $p_username, $p_password, $p_version_id ) {
$t_user_id = mci_check_login( $p_username, $p_password );
if( $t_user_id === false ) {
return new soap_fault( 'Client', '', 'Access Denied', 'Username/password combination was incorrect' );
}
if( is_blank( $p_version_id ) ) {
return new soap_fault( 'Client', '', 'Mandatory field "version_id" was missing' );
}
if( !version_exists( $p_version_id ) ) {
return new soap_fault( 'Client', '', "Version '$p_version_id' does not exist." );
}
$t_project_id = version_get_field( $p_version_id, 'project_id' );
if( !mci_has_readwrite_access( $t_user_id, $t_project_id ) ) {
return new soap_fault( 'Client', '', 'Access Denied' );
}
if( !mci_has_access( config_get( 'manage_project_threshold' ), $t_user_id, $t_project_id ) ) {
return new soap_fault( 'Client', '', 'Access Denied' );
}
return version_remove( $p_version_id );
}
/**
* Get the custom fields that belong to the specified project.
*
* @param string $p_username The name of the user trying to access the versions.
* @param string $p_password The password of the user.
* @param integer $p_project_id The id of the project to retrieve the custom fields for.
* @return Array representing a CustomFieldDefinitionDataArray structure.
*/
function mc_project_get_custom_fields( $p_username, $p_password, $p_project_id ) {
$t_user_id = mci_check_login( $p_username, $p_password );
if( $t_user_id === false ) {
return new soap_fault( 'Client', '', 'Access Denied' );
}
if( !project_exists( $p_project_id ) ) {
return new soap_fault( 'Client', '', "Project '$p_project_id' does not exist." );
}
if( !mci_has_readonly_access( $t_user_id, $p_project_id ) ) {
return new soap_fault( 'Client', '', 'Access Denied' );
}
$t_result = array();
$t_related_custom_field_ids = custom_field_get_linked_ids( $p_project_id );
foreach( custom_field_get_linked_ids( $p_project_id ) as $t_id ) {
$t_def = custom_field_get_definition( $t_id );
if( access_has_project_level( $t_def['access_level_r'], $p_project_id ) ) {
$t_result[] = array(
'field' => array(
'id' => $t_def['id'],
'name' => $t_def['name'],
),
'type' => $t_def['type'],
'default_value' => $t_def['default_value'],
'possible_values' => $t_def['possible_values'],
'valid_regexp' => $t_def['valid_regexp'],
'access_level_r' => $t_def['access_level_r'],
'access_level_rw' => $t_def['access_level_rw'],
'length_min' => $t_def['length_min'],
'length_max' => $t_def['length_max'],
'advanced' => $t_def['advanced'],
'display_report' => $t_def['display_report'],
'display_update' => $t_def['display_update'],
'display_resolved' => $t_def['display_resolved'],
'display_closed' => $t_def['display_closed'],
'require_report' => $t_def['require_report'],
'require_update' => $t_def['require_update'],
'require_resolved' => $t_def['require_resolved'],
'require_closed' => $t_def['require_closed'],
);
}
}
return $t_result;
}
/**
* Get the attachments that belong to the specified project.
*
* @param string $p_username The name of the user trying to access the versions.
* @param string $p_password The password of the user.
* @param integer $p_project_id The id of the project to retrieve the attachments for.
* @return Array representing a ProjectAttachmentDataArray structure.
*/
function mc_project_get_attachments( $p_username, $p_password, $p_project_id ) {
$t_user_id = mci_check_login( $p_username, $p_password );
if( $t_user_id === false ) {
return new soap_fault( 'Client', '', 'Access Denied' );
}
# Check if project documentation feature is enabled.
if( OFF == config_get( 'enable_project_documentation' ) || !file_is_uploading_enabled() ) {
return new soap_fault( 'Client', '', 'Access Denied' );
}
if( !project_exists( $p_project_id ) ) {
return new soap_fault( 'Client', '', "Project '$p_project_id' does not exist." );
}
if( !mci_has_readonly_access( $t_user_id, $p_project_id ) ) {
return new soap_fault( 'Client', '', 'Access Denied' );
}
$t_project_file_table = db_get_table( 'mantis_project_file_table' );
$t_project_table = db_get_table( 'mantis_project_table' );
$t_project_user_list_table = db_get_table( 'mantis_project_user_list_table' );
$t_user_table = db_get_table( 'mantis_user_table' );
$t_pub = VS_PUBLIC;
$t_priv = VS_PRIVATE;
$t_admin = config_get_global( 'admin_site_threshold' );
if( $p_project_id == ALL_PROJECTS ) {
# Select all the projects that the user has access to
$t_projects = user_get_accessible_projects( $t_user_id );
} else {
# Select the specific project
$t_projects = array(
$p_project_id,
);
}
$t_projects[] = ALL_PROJECTS; # add ALL_PROJECTS to the list of projects to fetch
$t_reqd_access = config_get( 'view_proj_doc_threshold' );
if( is_array( $t_reqd_access ) ) {
if( 1 == count( $t_reqd_access ) ) {
$t_access_clause = "= " . array_shift( $t_reqd_access ) . " ";
} else {
$t_access_clause = "IN (" . implode( ',', $t_reqd_access ) . ")";
}
} else {
$t_access_clause = ">= $t_reqd_access ";
}
$query = "SELECT pft.id, pft.project_id, pft.filename, pft.file_type, pft.filesize, pft.title, pft.description, pft.date_added
FROM $t_project_file_table pft
LEFT JOIN $t_project_table pt ON pft.project_id = pt.id
LEFT JOIN $t_project_user_list_table pult
ON pft.project_id = pult.project_id AND pult.user_id = $t_user_id
LEFT JOIN $t_user_table ut ON ut.id = $t_user_id
WHERE pft.project_id in (" . implode( ',', $t_projects ) . ") AND
( ( ( pt.view_state = $t_pub OR pt.view_state is null ) AND pult.user_id is null AND ut.access_level $t_access_clause ) OR
( ( pult.user_id = $t_user_id ) AND ( pult.access_level $t_access_clause ) ) OR
( ut.access_level = $t_admin ) )
ORDER BY pt.name ASC, pft.title ASC";
$result = db_query( $query );
$num_files = db_num_rows( $result );
$t_result = array();
for( $i = 0;$i < $num_files;$i++ ) {
$row = db_fetch_array( $result );
$t_attachment = array();
$t_attachment['id'] = $row['id'];
$t_attachment['filename'] = $row['filename'];
$t_attachment['title'] = $row['title'];
$t_attachment['description'] = $row['description'];
$t_attachment['size'] = $row['filesize'];
$t_attachment['content_type'] = $row['file_type'];
$t_attachment['date_submitted'] = timestamp_to_iso8601( $row['date_added'] );
$t_attachment['download_url'] = mci_get_mantis_path() . 'file_download.php?file_id=' . $row['id'] . '&type=doc';
$t_result[] = $t_attachment;
}
return $t_result;
}
/**
* Get a project definition.
*
* @param integer $p_project_id The id of the project to retrieve.
* @return Array an Array containing the id and the name of the project.
*/
function mci_project_as_array_by_id( $p_project_id ) {
$t_result = array();
$t_result['id'] = $p_project_id;
$t_result['name'] = project_get_name( $p_project_id );
return $t_result;
}
### MantisConnect Administrative Webservices ###
/**
* Add a new project.
*
* @param string $p_username The name of the user trying to access the versions.
* @param string $p_password The password of the user.
* @param Array $p_project A new ProjectData structure
* @return integer the new project's project_id
*/
function mc_project_add( $p_username, $p_password, $p_project ) {
$t_user_id = mci_check_login( $p_username, $p_password );
if( $t_user_id === false ) {
return new soap_fault( 'Client', '', 'Access Denied', 'Username/password combination was incorrect' );
}
if( !mci_has_administrator_access( $t_user_id ) ) {
return new soap_fault( 'Client', '', 'Access Denied', 'User does not have administrator access' );
}
if ( !isset( $p_project['name'] ) ) {
return new soap_fault( 'Client', '', 'Missing Field', 'Required Field Missing' );
} else {
$t_name = $p_project['name'];
}
if( isset( $p_project['status'] ) ) {
$t_status = $p_project['status'];
} else {
$t_status = array( 'name' => 'development' ); // development
}
if( isset( $p_project['view_state'] ) ) {
$t_view_state = $p_project['view_state'];
} else {
$t_view_state = array( 'id' => VS_PUBLIC );
}
if ( isset( $p_project['enabled'] ) ) {
$t_enabled = $p_project['enabled'];
} else {
$t_enabled = true;
}
if ( isset( $p_project['description'] ) ) {
$t_description = $p_project['description'];
} else {
$t_description = '';
}
if ( isset( $p_project['file_path'] ) ) {
$t_file_path = $p_project['file_path'];
} else {
$t_file_path = '';
}
if ( isset( $p_project['inherit_global'] ) ) {
$t_inherit_global = $p_project['inherit_global'];
} else {
$t_inherit_global = true;
}
// check to make sure project doesn't already exist
if( !project_is_name_unique( $t_name ) ) {
return new soap_fault( 'Client', '', 'Project name exists', 'The project name you attempted to add exists already' );
}
$t_project_status = mci_get_project_status_id( $t_status );
$t_project_view_state = mci_get_project_view_state_id( $t_view_state );
// project_create returns the new project's id, spit that out to webservice caller
return project_create( $t_name, $t_description, $t_project_status, $t_project_view_state, $t_file_path, $t_enabled, $t_inherit_global );
}
/**
* Delete a project.
*
* @param string $p_username The name of the user trying to access the versions.
* @param string $p_password The password of the user.
* @param integer $p_project_id A project's id
* @return bool returns true or false depending on the success of the delete action
*/
function mc_project_delete( $p_username, $p_password, $p_project_id ) {
$t_user_id = mci_check_login( $p_username, $p_password );
if( $t_user_id === false ) {
return new soap_fault( 'Client', '', 'Access Denied', 'Username/password combination was incorrect' );
}
if( !project_exists( $p_project_id ) ) {
return new soap_fault( 'Client', '', "Project '$p_project_id' does not exist." );
}
if( !mci_has_administrator_access( $t_user_id, $p_project_id ) ) {
return new soap_fault( 'Client', '', 'Access Denied', 'User does not have administrator access' );
}
return project_delete( $p_project_id );
}
function mc_project_get_issue_headers( $p_username, $p_password, $p_project_id, $p_page_number, $p_per_page ) {
$t_user_id = mci_check_login( $p_username, $p_password );
if( $t_user_id === false ) {
return new soap_fault( 'Client', '', 'Access Denied' );
}
if( !project_exists( $p_project_id ) ) {
return new soap_fault( 'Client', '', "Project '$p_project_id' does not exist." );
}
if( !mci_has_readonly_access( $t_user_id, $p_project_id ) ) {
return new soap_fault( 'Client', '', 'Access Denied' );
}
$t_page_count = 0;
$t_bug_count = 0;
$t_rows = filter_get_bug_rows( $p_page_number, $p_per_page, $t_page_count, $t_bug_count, null, $p_project_id );
$t_result = array();
foreach( $t_rows as $t_issue_data ) {
$t_id = $t_issue_data['id'];
$t_issue = array();
$t_issue['id'] = $t_id;
$t_issue['view_state'] = $t_issue_data['view_state'];
$t_issue['last_updated'] = timestamp_to_iso8601( $t_issue_data['last_updated'] );
$t_issue['project'] = $t_issue_data['project_id'];
$t_issue['category'] = mci_null_if_empty( category_get_name( $t_issue_data['category_id'] ) );
$t_issue['priority'] = $t_issue_data['priority'];
$t_issue['severity'] = $t_issue_data['severity'];
$t_issue['status'] = $t_issue_data['status'];
$t_issue['reporter'] = $t_issue_data['reporter_id'];
$t_issue['summary'] = $t_issue_data['summary'];
if( !empty( $t_issue_data['handler_id'] ) ) {
$t_issue['handler'] = $t_issue_data['handler_id'];
}
$t_issue['resolution'] = $t_issue_data['resolution'];
$t_issue['attachments_count'] = count( mci_issue_get_attachments( $t_issue_data['id'] ) );
$t_issue['notes_count'] = count( mci_issue_get_notes( $t_issue_data['id'] ) );
$t_result[] = $t_issue;
}
return $t_result;
}
/**
* Get appropriate users assigned to a project by access level.
*
* @param string $p_username The name of the user trying to access the versions.
* @param string $p_password The password of the user.
* @param integer $p_project_id The id of the project to retrieve the users for.
* @param integer $p_access Minimum access level.
* @return Array representing a ProjectAttachmentDataArray structure.
*/
function mc_project_get_users( $p_username, $p_password, $p_project_id, $p_access ) {
$t_user_id = mci_check_login( $p_username, $p_password );
if( $t_user_id === false ) {
return new soap_fault( 'Client', '', 'Access Denied' );
}
$t_users = array();
$t_users = project_get_all_user_rows( $p_project_id, $p_access ); # handles ALL_PROJECTS case
$t_display = array();
$t_sort = array();
$t_show_realname = ( ON == config_get( 'show_realname' ) );
$t_sort_by_last_name = ( ON == config_get( 'sort_by_last_name' ) );
foreach( $t_users as $t_user ) {
$t_user_name = string_attribute( $t_user['username'] );
$t_sort_name = strtolower( $t_user_name );
if( $t_show_realname && ( $t_user['realname'] <> "" ) ) {
$t_user_name = string_attribute( $t_user['realname'] );
if( $t_sort_by_last_name ) {
$t_sort_name_bits = explode( ' ', strtolower( $t_user_name ), 2 );
$t_sort_name = ( isset( $t_sort_name_bits[1] ) ? $t_sort_name_bits[1] . ', ' : '' ) . $t_sort_name_bits[0];
} else {
$t_sort_name = strtolower( $t_user_name );
}
}
$t_display[] = $t_user_name;
$t_sort[] = $t_sort_name;
}
array_multisort( $t_sort, SORT_ASC, SORT_STRING, $t_users, $t_display );
$t_result = array();
for( $i = 0;$i < count( $t_sort );$i++ ) {
$t_row = $t_users[$i];
// This is not very performant - But we have to assure that the data returned is exactly
// the same as the data that comes with an issue (test for equality - $t_row[] does not
// contain email fields).
$t_result[] = mci_account_get_array_by_id( $t_row['id'] );
}
return $t_result;
}