/
mc_project_api.php
1323 lines (1095 loc) · 44.8 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
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?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
*/
use Mantis\Exceptions\ClientException;
/**
* Use a standard filter to get issues associated with the specified user.
*
* @param string $p_username Logged in user name.
* @param string $p_password Login password.
* @param integer $p_project_id Id of project to filter on, or ALL_PROJECTS.
* @param string $p_filter_type The name of the filter to apply
* "assigned" - target user specified - issues assigned to target user that are not resolved.
* "assigned" - target user 0 - unassigned issues that are not resolved.
* "reported" - target user specified - issues reported by user.
* "reported" - target user 0 - will throw.
* "monitored" - target user specified - issues monitored by user.
* "monitored" - target user 0 - issues not monitored.
* @param object $p_target_user AccountData for target user, can include id, name, or both.
* @param integer $p_page_number The page to return (1 based).
* @param integer $p_per_page Number of issues per page.
* @return array|RestFault|SoapFault a page of matching issues or error.
*/
function mc_project_get_issues_for_user( $p_username, $p_password, $p_project_id, $p_filter_type, $p_target_user, $p_page_number, $p_per_page ) {
$t_user_id = mci_check_login( $p_username, $p_password );
if( $t_user_id === false ) {
return mci_fault_login_failed();
}
if( $p_project_id != ALL_PROJECTS && !project_exists( $p_project_id ) ) {
return ApiObjectFactory::faultNotFound( 'Project \'' . $p_project_id . '\' does not exist.' );
}
if( !mci_has_readonly_access( $t_user_id, $p_project_id ) ) {
return mci_fault_access_denied( $t_user_id );
}
$t_lang = mci_get_user_lang( $t_user_id );
$t_orig_page_number = $p_page_number < 1 ? 1 : $p_page_number;
$t_page_count = 0;
$t_bug_count = 0;
$t_target_user_id = mci_get_user_id( $p_target_user );
$t_show_sticky = true;
if( strcasecmp( $p_filter_type, 'assigned' ) == 0 ) {
# If user is filtering on handlers, then they must have access to view handlers
if( $t_target_user_id != $t_user_id && $t_target_user_id != NO_USER ) {
$t_view_handler_access = config_get( 'view_handler_threshold', null, $t_user_id, $p_project_id );
if( !access_has_project_level( $t_view_handler_access, $p_project_id, $t_user_id ) ) {
return ApiObjectFactory::faultForbidden( 'Issue handlers are not visible to user.' );
}
}
$t_filter = filter_create_assigned_to_unresolved( $p_project_id, $t_target_user_id );
} else if( strcasecmp( $p_filter_type, 'reported' ) == 0 ) {
# target id 0 for reporter doesn't make sense.
if( $t_target_user_id == 0 ) {
return ApiObjectFactory::faultBadRequest( 'Target user id must be specified for \'reported\' filter.' );
}
$t_filter = filter_create_reported_by( $p_project_id, $t_target_user_id );
} else if( strcasecmp( $p_filter_type, 'monitored' ) == 0 ) {
$t_filter = filter_create_monitored_by( $p_project_id, $t_target_user_id );
} else {
return ApiObjectFactory::faultBadRequest( 'Unknown filter type \'' . $p_filter_type . '\'.' );
}
$t_rows = filter_get_bug_rows(
$p_page_number, $p_per_page, $t_page_count, $t_bug_count, $t_filter,
$p_project_id, $t_user_id, $t_show_sticky );
$t_result = array();
# the page number was moved back, so we have exceeded the actual page number, see bug #12991
if( $t_orig_page_number > $p_page_number ) {
return $t_result;
}
foreach( $t_rows as $t_issue_data ) {
$t_result[] = mci_issue_data_as_array( $t_issue_data, $t_user_id, $t_lang );
}
return $t_result;
}
/**
* Project Get Issues
* @param string $p_username Logged in user name.
* @param string $p_password Login password.
* @param integer $p_project_id Project Id.
* @param integer $p_page_number Page number.
* @param integer $p_per_page Per page.
* @return array
*/
function mc_project_get_issues( $p_username, $p_password, $p_project_id, $p_page_number, $p_per_page ) {
global $g_project_override;
$t_user_id = mci_check_login( $p_username, $p_password );
if( $t_user_id === false ) {
return mci_fault_login_failed();
}
$t_lang = mci_get_user_lang( $t_user_id );
if( $p_project_id != ALL_PROJECTS && !project_exists( $p_project_id ) ) {
return ApiObjectFactory::faultNotFound( 'Project \'' . $p_project_id . '\' does not exist.' );
}
if( !mci_has_readonly_access( $t_user_id, $p_project_id ) ) {
return mci_fault_access_denied( $t_user_id );
}
$t_orig_page_number = $p_page_number < 1 ? 1 : $p_page_number;
$t_page_count = 0;
$t_bug_count = 0;
$g_project_override = $p_project_id;
$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();
# the page number was moved back, so we have exceeded the actual page number, see bug #12991
if( $t_orig_page_number > $p_page_number ) {
return $t_result;
}
foreach( $t_rows as $t_issue_data ) {
$t_result[] = mci_issue_data_as_array( $t_issue_data, $t_user_id, $t_lang );
}
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 mci_fault_login_failed();
}
if( !mci_has_readonly_access( $t_user_id ) ) {
return mci_fault_access_denied( $t_user_id );
}
$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 An array of category names
*/
function mc_project_get_categories( $p_username, $p_password, $p_project_id ) {
global $g_project_override;
$t_user_id = mci_check_login( $p_username, $p_password );
if( $t_user_id === false ) {
return mci_fault_login_failed();
}
if( !project_exists( $p_project_id ) ) {
return ApiObjectFactory::faultNotFound( 'Project \'' . $p_project_id . '\' does not exist.' );
}
$g_project_override = $p_project_id;
if( !mci_has_readonly_access( $t_user_id, $p_project_id ) ) {
return mci_fault_access_denied( $t_user_id );
}
$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;
}
/**
* Add a new category to 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.
* @param string $p_category_name The name of the new category to add.
* @return integer id of the new category
*/
function mc_project_add_category( $p_username, $p_password, $p_project_id, $p_category_name ) {
global $g_project_override;
$t_user_id = mci_check_login( $p_username, $p_password );
if( $t_user_id === false ) {
return mci_fault_access_denied();
}
if( !project_exists( $p_project_id ) ) {
return ApiObjectFactory::faultNotFound( 'Project \'' . $p_project_id . '\' does not exist.' );
}
$g_project_override = $p_project_id;
if( !mci_has_access( config_get( 'manage_project_threshold' ), $t_user_id, $p_project_id ) ) {
return mci_fault_access_denied();
}
return category_add( $p_project_id, $p_category_name );
}
/**
* Delete a category 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.
* @param string $p_category_name The name of the category to delete.
* @return boolean returns true or false depending on the success of the delete action
*/
function mc_project_delete_category ( $p_username, $p_password, $p_project_id, $p_category_name ) {
global $g_project_override;
$t_user_id = mci_check_login( $p_username, $p_password );
if( $t_user_id === false ) {
return mci_fault_access_denied();
}
if( !project_exists( $p_project_id ) ) {
return ApiObjectFactory::faultNotFound( 'Project \'' . $p_project_id . '\' does not exist.' );
}
$g_project_override = $p_project_id;
if( !mci_has_access( config_get( 'manage_project_threshold' ), $t_user_id, $p_project_id ) ) {
return mci_fault_access_denied();
}
# find the id of the category
$p_category_id = category_get_id_by_name( $p_category_name, $p_project_id );
if( !category_can_remove( $p_category_id ) ) {
return ApiObjectFactory::fault(
'Client',
"'$p_category_name' is used as default category for moves and can't be deleted.",
HTTP_STATUS_FORBIDDEN
);
}
# delete the category and link all the issues to the default category
return category_remove( $p_category_id, config_get( 'default_category_for_moves' ) );
}
/**
* Update a category 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.
* @param string $p_category_name The name of the category to rename.
* @param string $p_category_name_new The new name of the category to rename.
* @param integer $p_assigned_to User ID that category is assigned to.
* @return boolean returns true or false depending on the success of the update action
*/
function mc_project_rename_category_by_name( $p_username, $p_password, $p_project_id, $p_category_name, $p_category_name_new, $p_assigned_to ) {
global $g_project_override;
$t_user_id = mci_check_login( $p_username, $p_password );
if( null === $p_assigned_to ) {
return ApiObjectFactory::faultBadRequest( 'assigned_to needed' );
}
if( $t_user_id === false ) {
return mci_fault_access_denied();
}
if( !project_exists( $p_project_id ) ) {
return ApiObjectFactory::faultNotFound( 'Project \'' . $p_project_id . '\' does not exist.' );
}
$g_project_override = $p_project_id;
if( !mci_has_access( config_get( 'manage_project_threshold' ), $t_user_id, $p_project_id ) ) {
return mci_fault_access_denied();
}
# find the id of the category
$p_category_id = category_get_id_by_name( $p_category_name, $p_project_id );
# update the category
return category_update( $p_category_id, $p_category_name_new, $p_assigned_to );
}
/**
* 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 ) {
global $g_project_override;
$t_user_id = mci_check_login( $p_username, $p_password );
if( $t_user_id === false ) {
return mci_fault_login_failed();
}
if( !project_exists( $p_project_id ) ) {
return ApiObjectFactory::faultNotFound( 'Project \'' . $p_project_id . '\' does not exist.' );
}
$g_project_override = $p_project_id;
if( !mci_has_readonly_access( $t_user_id, $p_project_id ) ) {
return mci_fault_access_denied( $t_user_id );
}
$t_result = array();
foreach( version_get_all_rows( $p_project_id, VERSION_ALL ) as $t_version ) {
$t_result[] = mci_project_version_as_array( $t_version );
}
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 ) {
global $g_project_override;
$t_user_id = mci_check_login( $p_username, $p_password );
if( $t_user_id === false ) {
return mci_fault_login_failed();
}
if( !project_exists( $p_project_id ) ) {
return ApiObjectFactory::faultNotFound( 'Project \'' . $p_project_id . '\' does not exist.' );
}
$g_project_override = $p_project_id;
if( !mci_has_readonly_access( $t_user_id, $p_project_id ) ) {
return mci_fault_access_denied( $t_user_id );
}
$t_result = array();
foreach( version_get_all_rows( $p_project_id, VERSION_RELEASED ) as $t_version ) {
$t_result[] = mci_project_version_as_array( $t_version );
}
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 ) {
global $g_project_override;
$t_user_id = mci_check_login( $p_username, $p_password );
if( $t_user_id === false ) {
return mci_fault_login_failed();
}
if( !project_exists( $p_project_id ) ) {
return ApiObjectFactory::faultNotFound( 'Project \'' . $p_project_id . '\' does not exist.' );
}
$g_project_override = $p_project_id;
if( !mci_has_readonly_access( $t_user_id, $p_project_id ) ) {
return mci_fault_access_denied( $t_user_id );
}
$t_result = array();
foreach( version_get_all_rows( $p_project_id, VERSION_FUTURE ) as $t_version ) {
$t_result[] = mci_project_version_as_array( $t_version );
}
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 stdClass $p_version A ProjectVersionData structure containing information about the new version.
* @return integer The id of the created version.
*/
function mc_project_version_add( $p_username, $p_password, stdClass $p_version ) {
$t_user_id = mci_check_login( $p_username, $p_password );
if( $t_user_id === false ) {
return mci_fault_login_failed();
}
$p_version = ApiObjectFactory::objectToArray( $p_version );
$t_project_id = $p_version['project_id'];
if( !mci_has_readwrite_access( $t_user_id, $t_project_id ) ) {
return mci_fault_access_denied( $t_user_id );
}
$t_data = array(
'query' => array(
'project_id' => $t_project_id,
),
'payload' => array(
'name' => $p_version['name'],
'description' => $p_version['description'],
'released' => $p_version['released'],
'obsolete' => isset( $p_version['obsolete'] ) ? $p_version['obsolete'] : false,
'timestamp' => $p_version['date_order'],
)
);
$t_command = new VersionAddCommand( $t_data );
$t_result = $t_command->execute();
return $t_result['id'];
}
/**
* 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 stdClass $p_version A ProjectVersionData structure containing information about the new version.
* @return boolean returns true or false depending on the success of the update action
*/
function mc_project_version_update( $p_username, $p_password, $p_version_id, stdClass $p_version ) {
global $g_project_override;
$t_user_id = mci_check_login( $p_username, $p_password );
if( $t_user_id === false ) {
return mci_fault_login_failed();
}
if( is_blank( $p_version_id ) ) {
return ApiObjectFactory::faultBadRequest( 'Mandatory field "version_id" was missing' );
}
if( !version_exists( $p_version_id ) ) {
return ApiObjectFactory::faultNotFound( 'Version \'' . $p_version_id . '\' does not exist.' );
}
$p_version = ApiObjectFactory::objectToArray( $p_version );
$t_project_id = $p_version['project_id'];
$g_project_override = $t_project_id;
$t_name = $p_version['name'];
$t_released = $p_version['released'];
$t_description = $p_version['description'];
$t_date_order = isset( $p_version['date_order'] ) ? strtotime( $p_version['date_order'] ) : null;
$t_obsolete = isset( $p_version['obsolete'] ) ? $p_version['obsolete'] : false;
if( is_blank( $t_project_id ) ) {
return ApiObjectFactory::faultBadRequest( 'Mandatory field "project_id" was missing' );
}
if( !project_exists( $t_project_id ) ) {
return ApiObjectFactory::faultNotFound( 'Project \'' . $t_project_id . '\' does not exist.' );
}
if( !mci_has_readwrite_access( $t_user_id, $t_project_id ) ) {
return mci_fault_access_denied( $t_user_id );
}
if( !mci_has_access( config_get( 'manage_project_threshold' ), $t_user_id, $t_project_id ) ) {
return mci_fault_access_denied( $t_user_id );
}
if( is_blank( $t_name ) ) {
return ApiObjectFactory::faultBadRequest( '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 ApiObjectFactory::faultConflict( 'Version exists for 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 = $t_date_order;
$t_version_data->obsolete = $t_obsolete;
version_update( $t_version_data );
return true;
}
/**
* 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 boolean returns true or false depending on the success of the delete action
*/
function mc_project_version_delete( $p_username, $p_password, $p_version_id ) {
global $g_project_override;
$t_user_id = mci_check_login( $p_username, $p_password );
if( $t_user_id === false ) {
return mci_fault_login_failed();
}
if( is_blank( $p_version_id ) ) {
return ApiObjectFactory::faultBadRequest( 'Mandatory field "version_id" was missing' );
}
if( !version_exists( $p_version_id ) ) {
return ApiObjectFactory::faultNotFound( 'Version \'' . $p_version_id . '\' does not exist.' );
}
$t_project_id = version_get_field( $p_version_id, 'project_id' );
$g_project_override = $t_project_id;
if( !mci_has_readwrite_access( $t_user_id, $t_project_id ) ) {
return mci_fault_access_denied( $t_user_id );
}
if( !mci_has_access( config_get( 'manage_project_threshold' ), $t_user_id, $t_project_id ) ) {
return mci_fault_access_denied( $t_user_id );
}
version_remove( $p_version_id );
return true;
}
/**
* 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|RestFault|SoapFault 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 mci_fault_login_failed();
}
if( !mci_has_readonly_access( $t_user_id, $p_project_id ) ) {
return mci_fault_access_denied( $t_user_id );
}
return mci_project_get_custom_fields( $p_project_id );
}
/**
* Validate custom fields before creating/updating issues.
*
* @param integer $p_project_id The project id.
* @param array $p_custom_fields The custom fields, may be not set.
* @return bool|SoapFault|RestFault true or error.
*
* @throws ClientException
*/
function mci_project_custom_fields_validate( $p_project_id, &$p_custom_fields ) {
# Load custom field definitions for the specified project
$t_related_custom_field_ids = custom_field_get_linked_ids( $p_project_id );
$t_custom_field_defs = array();
foreach( $t_related_custom_field_ids as $t_custom_field_id ) {
$t_def = custom_field_get_definition( $t_custom_field_id );
$t_custom_field_defs[$t_custom_field_id] = $t_def;
}
$t_custom_field_values = array();
if( isset( $p_custom_fields ) ) {
if( !is_array( $p_custom_fields ) ) {
throw new ClientException(
"Invalid Custom Field '$p_custom_fields'",
ERROR_CUSTOM_FIELD_NOT_FOUND
);
}
foreach( $p_custom_fields as $t_custom_field ) {
$t_custom_field = ApiObjectFactory::objectToArray( $t_custom_field );
if( !isset( $t_custom_field['value'] ) ) {
throw new ClientException(
'Custom field has no value specified.',
ERROR_EMPTY_FIELD,
array( "custom_field['value']" )
);
}
if( !isset( $t_custom_field['field'] ) ) {
throw new ClientException(
'Custom field with no specified id or name.',
ERROR_EMPTY_FIELD,
array( "custom_field['field']" )
);
}
$t_custom_field_id = mci_get_custom_field_id_from_objectref( (object)$t_custom_field['field'] );
if( $t_custom_field_id == 0 ) {
throw new ClientException(
'Invalid Custom Field '
# Output JSON stripped of quotes to help caller identify offending field
. str_replace( '"', '', json_encode( $t_custom_field['field'] ) ),
ERROR_CUSTOM_FIELD_NOT_FOUND
);
} else {
# Make sure the custom field is linked to the current project
if( !isset( $t_custom_field_defs[$t_custom_field_id] ) ) {
throw new ClientException(
"Custom Field Id '$t_custom_field_id' not found in Project '$p_project_id'.",
ERROR_CUSTOM_FIELD_NOT_FOUND
);
}
$t_def = $t_custom_field_defs[$t_custom_field_id];
$t_custom_field_values[$t_def['name']] = $t_custom_field['value'];
}
}
}
# Validate the custom fields before adding the bug.
foreach( $t_related_custom_field_ids as $t_custom_field_id ) {
# Skip custom fields that user doesn't have access to write.
if( !custom_field_has_write_access_to_project( $t_custom_field_id, $p_project_id ) ) {
continue;
}
$t_def = $t_custom_field_defs[$t_custom_field_id];
$t_name = custom_field_get_field( $t_custom_field_id, 'name' );
# Produce an error if the field is required but wasn't posted
if( $t_def['require_report'] ) {
if( !isset( $t_custom_field_values[$t_name] ) ||
is_blank( $t_custom_field_values[$t_name] ) ) {
throw new ClientException(
"Mandatory field '$t_name' is missing.",
ERROR_EMPTY_FIELD,
array( $t_name )
);
}
}
if( isset( $t_custom_field_values[$t_name] ) &&
!custom_field_validate( $t_custom_field_id, $t_custom_field_values[$t_name] ) ) {
throw new ClientException(
"Invalid custom field '$t_name' value.",
ERROR_CUSTOM_FIELD_INVALID_VALUE,
array( $t_name )
);
}
}
return true;
}
/**
* Get the custom fields that belong to the specified project.
*
* @param integer $p_project_id The id of the project to retrieve the custom fields for.
* @return array|RestFault|SoapFault representing a CustomFieldDefinitionDataArray structure.
*/
function mci_project_get_custom_fields( $p_project_id ) {
global $g_project_override;
if( !project_exists( $p_project_id ) ) {
return ApiObjectFactory::faultNotFound( "Project '$p_project_id' does not exist." );
}
$g_project_override = $p_project_id;
$t_result = array();
$t_related_custom_field_ids = custom_field_get_linked_ids( $p_project_id );
$t_user_id = auth_get_current_user_id();
$t_lang = mci_get_user_lang( $t_user_id );
foreach( $t_related_custom_field_ids 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_custom_field = array();
if( ApiObjectFactory::$soap ) {
$t_custom_field['field'] = array(
'id' => $t_def['id'],
'name' => $t_def['name'],
);
} else {
$t_custom_field['id'] = (int)$t_def['id'];
$t_custom_field['name'] = $t_def['name'];
}
$t_custom_field['type'] = $t_def['type'];
$t_custom_field['default_value'] = $t_def['default_value'];
$t_custom_field['possible_values'] = $t_def['possible_values'];
$t_custom_field['valid_regexp'] = $t_def['valid_regexp'];
$t_custom_field['length_min'] = (int)$t_def['length_min'];
$t_custom_field['length_max'] = (int)$t_def['length_max'];
if( ApiObjectFactory::$soap ) {
$t_custom_field['access_level_r'] = $t_def['access_level_r'];
$t_custom_field['access_level_rw'] = $t_def['access_level_rw'];
$t_custom_field['display_report'] = (int)$t_def['display_report'];
$t_custom_field['display_update'] = (int)$t_def['display_update'];
$t_custom_field['display_resolved'] = (int)$t_def['display_resolved'];
$t_custom_field['display_closed'] = (int)$t_def['display_closed'];
$t_custom_field['require_report'] = (int)$t_def['require_report'];
$t_custom_field['require_update'] = (int)$t_def['require_update'];
$t_custom_field['require_resolved'] = (int)$t_def['require_resolved'];
$t_custom_field['require_closed'] = (int)$t_def['require_closed'];
} else {
$t_custom_field['type'] = mci_custom_field_type_name( $t_def['type'] );
$t_custom_field['access_level_r'] = mci_enum_get_array_by_id( $t_def['access_level_r'], 'access_levels', $t_lang );
$t_custom_field['access_level_rw'] = mci_enum_get_array_by_id( $t_def['access_level_rw'], 'access_levels', $t_lang );
$t_custom_field['display_report'] = (bool)$t_def['display_report'];
$t_custom_field['display_update'] = (bool)$t_def['display_update'];
$t_custom_field['display_resolved'] = (bool)$t_def['display_resolved'];
$t_custom_field['display_closed'] = (bool)$t_def['display_closed'];
$t_custom_field['require_report'] = (bool)$t_def['require_report'];
$t_custom_field['require_update'] = (bool)$t_def['require_update'];
$t_custom_field['require_resolved'] = (bool)$t_def['require_resolved'];
$t_custom_field['require_closed'] = (bool)$t_def['require_closed'];
}
$t_result[] = $t_custom_field;
}
}
return $t_result;
}
/**
* Get the custom field type name given its type id.
*
* @param int $p_type_id The custom field type id.
* @return string The type name or id if an unknown type.
*/
function mci_custom_field_type_name( $p_type_id ) {
switch( $p_type_id ) {
case CUSTOM_FIELD_TYPE_STRING:
return 'string';
case CUSTOM_FIELD_TYPE_TEXTAREA:
return 'textarea';
case CUSTOM_FIELD_TYPE_NUMERIC:
return 'numeric';
case CUSTOM_FIELD_TYPE_FLOAT:
return 'float';
case CUSTOM_FIELD_TYPE_ENUM:
return 'enum';
case CUSTOM_FIELD_TYPE_EMAIL:
return 'email';
case CUSTOM_FIELD_TYPE_CHECKBOX:
return 'checkbox';
case CUSTOM_FIELD_TYPE_LIST:
return 'list';
case CUSTOM_FIELD_TYPE_MULTILIST:
return 'multilist';
case CUSTOM_FIELD_TYPE_DATE:
return 'date';
default:
return $p_type_id;
}
}
/**
* Get list of versions for a project.
* @param int $p_project_id The project id
* @return array The project versions.
*/
function mci_project_versions( $p_project_id ) {
# use VERSION_ALL, true as the fastest way (no additional where clause in query)
# to get all released / non-released and obsolete / non-obsolete versions
$t_versions = version_get_all_rows( $p_project_id, VERSION_ALL, true );
$t_results = array();
foreach( $t_versions as $t_version ) {
$t_result = array(
'id' => (int)$t_version['id'],
'name' => $t_version['version'],
'description' => $t_version['description'],
'released' => (bool)$t_version['released'],
'obsolete' => (bool)$t_version['obsolete'],
'timestamp' => ApiObjectFactory::datetime( $t_version['date_order'] ),
);
$t_results[] = $t_result;
}
return $t_results;
}
/**
* Get projects for the specified project.
*
* @param int $p_project_id The project id
* @return array The array of categories with their info.
*/
function mci_project_categories( $p_project_id ) {
$t_categories = category_get_all_rows( $p_project_id );
$t_results = array();
foreach( $t_categories as $t_category ) {
$t_project_id = (int)$t_category['project_id'];
$t_result = array(
'id' => (int)$t_category['id'],
'name' => $t_category['name'],
'project' => array( 'id' => $t_project_id, 'name' => $t_category['project_name'] ),
);
# Do access check here to take into consider the project id that the category is associated with
# in case of inherited categories.
$t_default_handler_id = (int)$t_category['user_id'];
if( $t_default_handler_id != 0 &&
access_has_project_level( config_get( 'manage_project_threshold', null, null, $t_project_id ), $t_project_id ) ) {
$t_result['default_handler'] = mci_account_get_array_by_id( $t_default_handler_id );
}
$t_results[] = $t_result;
}
return $t_results;
}
/**
* 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 ) {
global $g_project_override;
$t_user_id = mci_check_login( $p_username, $p_password );
if( $t_user_id === false ) {
return mci_fault_login_failed();
}
$p_project_id = (int)$p_project_id;
$g_project_override = $p_project_id;
# Check if project documentation feature is enabled.
if( OFF == config_get( 'enable_project_documentation' ) || !file_is_uploading_enabled() ) {
return mci_fault_access_denied( $t_user_id );
}
if( !project_exists( $p_project_id ) ) {
return ApiObjectFactory::faultNotFound( 'Project \'' . $p_project_id . '\' does not exist.' );
}
if( !mci_has_readonly_access( $t_user_id, $p_project_id ) ) {
return mci_fault_access_denied( $t_user_id );
}
$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;
}
$t_query = 'SELECT pft.id, pft.project_id, pft.filename, pft.file_type, pft.filesize, pft.title, pft.description, pft.date_added, pft.user_id
FROM {project_file} pft
LEFT JOIN {project} pt ON pft.project_id = pt.id
LEFT JOIN {project_user_list} pult
ON pft.project_id = pult.project_id AND pult.user_id = ' . db_param() . '
LEFT JOIN {user} ut ON ut.id = ' . db_param() . '
WHERE pft.project_id in (' . implode( ',', $t_projects ) . ') AND
( ( ( pt.view_state = ' . db_param() . ' OR pt.view_state is null ) AND pult.user_id is null AND ut.access_level ' . $t_access_clause . ' ) OR
( ( pult.user_id = ' . db_param() . ' ) AND ( pult.access_level ' . $t_access_clause . ' ) ) OR
( ut.access_level = ' . db_param() . ' ) )
ORDER BY pt.name ASC, pft.title ASC';
$t_result = db_query( $t_query, array( $t_user_id, $t_user_id, $t_pub, $t_user_id, $t_admin ) );
$t_num_files = db_num_rows( $t_result );
$t_attachments = array();
for( $i = 0; $i < $t_num_files; $i++ ) {
$t_row = db_fetch_array( $t_result );
$t_attachment = array();
$t_attachment['id'] = $t_row['id'];
$t_attachment['filename'] = $t_row['filename'];
$t_attachment['title'] = $t_row['title'];
$t_attachment['description'] = $t_row['description'];
$t_attachment['size'] = $t_row['filesize'];
$t_attachment['content_type'] = $t_row['file_type'];
$t_attachment['date_submitted'] = ApiObjectFactory::datetime( $t_row['date_added'] );
$t_attachment['download_url'] = mci_get_mantis_path() . 'file_download.php?file_id=' . $t_row['id'] . '&type=doc';
$t_attachment['user_id'] = $t_row['user_id'];
$t_attachments[] = $t_attachment;
}
return $t_attachments;
}
/**
* Get the list of subprojects for a given 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
*/
function mc_project_get_all_subprojects( $p_username, $p_password, $p_project_id ) {
global $g_project_override;
$t_user_id = mci_check_login( $p_username, $p_password );
if( $t_user_id === false ) {
return mci_fault_access_denied();
}
if( !project_exists( $p_project_id ) ) {