/
bug_api.php
1787 lines (1506 loc) · 55.3 KB
/
bug_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/>.
/**
* Bug API
* @copyright Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
* @copyright Copyright (C) 2002 - 2009 MantisBT Team - mantisbt-dev@lists.sourceforge.net
* @link http://www.mantisbt.org
* @package CoreAPI
* @subpackage BugAPI
*/
/**
* requires history_api
*/
require_once( 'history_api.php' );
/**
* requires email_api
*/
require_once( 'email_api.php' );
/**
* requires bugnote_api
*/
require_once( 'bugnote_api.php' );
/**
* requires file_api
*/
require_once( 'file_api.php' );
/**
* requires string_api
*/
require_once( 'string_api.php' );
/**
* requires sponsorship_api
*/
require_once( 'sponsorship_api.php' );
/**
* requires twitter_api
*/
require_once( 'twitter_api.php' );
/**
* requires tag_api
*/
require_once( 'tag_api.php' );
/**
* requires relationship_api
*/
require_once( 'relationship_api.php' );
/**
* requires bug_revision_api
*/
require_once( 'bug_revision_api.php' );
/**
* Bug Data Structure Definition
* @package MantisBT
* @subpackage classes
*/
class BugData {
protected $id;
protected $project_id = null;
protected $reporter_id = 0;
protected $handler_id = 0;
protected $duplicate_id = 0;
protected $priority = NORMAL;
protected $severity = MINOR;
protected $reproducibility = 10;
protected $status = NEW_;
protected $resolution = OPEN;
protected $projection = 10;
protected $category_id = 1;
protected $date_submitted = '';
protected $last_updated = '';
protected $eta = 10;
protected $os = '';
protected $os_build = '';
protected $platform = '';
protected $version = '';
protected $fixed_in_version = '';
protected $target_version = '';
protected $build = '';
protected $view_state = VS_PUBLIC;
protected $summary = '';
protected $sponsorship_total = 0;
protected $sticky = 0;
# omitted:
# var $bug_text_id
protected $profile_id;
# extended info
protected $description = '';
protected $steps_to_reproduce = '';
protected $additional_information = '';
# internal helper objects
private $_stats = null;
# due date
protected $due_date = '';
public $attachment_count = null;
public $bugnotes_count = null;
private $loading = false;
/**
* return number of file attachment's linked to current bug
* @return int
*/
public function get_attachment_count() {
if ( $this->attachment_count === null ) {
$this->attachment_count = file_bug_attachment_count( $this->id );
return $this->attachment_count;
} else {
return $this->attachment_count;
}
}
/**
* return number of bugnotes's linked to current bug
* @return int
*/
public function get_bugnotes_count() {
if ( $this->bugnotes_count === null ) {
$this->bugnotes_count = self::bug_get_bugnote_count();
return $this->bugnotes_count;
} else {
return $this->bugnotes_count;
}
}
/**
* @private
*/
public function __set($name, $value) {
switch ($name) {
// integer types
case 'id':
case 'project_id':
case 'reporter_id':
case 'handler_id':
case 'duplicate_id':
case 'priority':
case 'severity':
case 'reproducibility':
case 'status':
case 'resolution':
case 'projection':
case 'category_id':
$value = (int)$value;
break;
case 'fixed_in_version':
if ( !$this->loading ) {
if ( !access_has_project_level( config_get( 'handle_bug_threshold' ) ) ) {
trigger_error( ERROR_ACCESS_DENIED, ERROR );
}
}
break;
case 'target_version':
if ( !$this->loading ) {
# Only set target_version if user has access to do so
if( !access_has_project_level( config_get( 'roadmap_update_threshold' ) ) ) {
trigger_error( ERROR_ACCESS_DENIED, ERROR );
}
}
break;
case 'due_date':
if ( !is_numeric( $value ) ) {
$value = strtotime($value);
}
break;
}
$this->$name = $value;
}
/**
* @private
*/
public function __get($name) {
return $this->{$name};
}
/**
* @private
*/
public function __isset($name) {
return isset( $this->{$name} );
}
/**
* fast-load database row into bugobject
* @param array $p_row
*/
public function loadrow( $p_row ) {
$this->loading = true;
foreach( $p_row as $var => $val ) {
$this->__set( $var, $p_row[$var] );
}
$this->loading = false;
}
/**
* Retrieves extended information for bug (e.g. bug description)
* @return null
*/
public function fetch_extended_info() {
if ( $this->description == '' ) {
$t_text = bug_text_cache_row($this->id);
$this->description = $t_text['description'];
$this->steps_to_reproduce = $t_text['steps_to_reproduce'];
$this->additional_information = $t_text['additional_information'];
}
}
/**
* Returns the number of bugnotes for the given bug_id
* @return int number of bugnotes
* @access private
* @uses database_api.php
*/
private function bug_get_bugnote_count() {
if( !access_has_project_level( config_get( 'private_bugnote_threshold' ), $this->project_id ) ) {
$t_restriction = 'AND view_state=' . VS_PUBLIC;
} else {
$t_restriction = '';
}
$t_bugnote_table = db_get_table( 'mantis_bugnote_table' );
$query = "SELECT COUNT(*)
FROM $t_bugnote_table
WHERE bug_id =" . db_param() . " $t_restriction";
$result = db_query_bound( $query, Array( $this->bug_id ) );
return db_result( $result );
}
/**
* validate current bug object for database insert/update
* triggers error on failure
* @param bool $p_update_extended
*/
function validate( $p_update_extended = true) {
# Summary cannot be blank
if( is_blank( $this->summary ) ) {
error_parameters( lang_get( 'summary' ) );
trigger_error( ERROR_EMPTY_FIELD, ERROR );
}
if( $p_update_extended ) {
# Description field cannot be empty
if( is_blank( $this->description ) ) {
error_parameters( lang_get( 'description' ) );
trigger_error( ERROR_EMPTY_FIELD, ERROR );
}
}
# Make sure a category is set
if( 0 == $this->category_id && !config_get( 'allow_no_category' ) ) {
error_parameters( lang_get( 'category' ) );
trigger_error( ERROR_EMPTY_FIELD, ERROR );
}
if( !is_blank( $this->duplicate_id ) && ( $this->duplicate_id != 0 ) && ( $this->id == $this->duplicate_id ) ) {
trigger_error( ERROR_BUG_DUPLICATE_SELF, ERROR );
# never returns
}
}
/**
* Insert a new bug into the database
* @return int integer representing the bug id that was created
* @access public
* @uses database_api.php
* @uses lang_api.php
*/
function create() {
self::validate( true );
# check due_date format
if( is_blank( $this->due_date ) ) {
$this_due_date = date_get_null();
}
$t_bug_table = db_get_table( 'mantis_bug_table' );
$t_bug_text_table = db_get_table( 'mantis_bug_text_table' );
$t_category_table = db_get_table( 'mantis_category_table' );
# Insert text information
$query = "INSERT INTO $t_bug_text_table
( description, steps_to_reproduce, additional_information )
VALUES
( " . db_param() . ',' . db_param() . ',' . db_param() . ')';
db_query_bound( $query, Array( $this->description, $this->steps_to_reproduce, $this->additional_information ) );
# Get the id of the text information we just inserted
# NOTE: this is guarranteed to be the correct one.
# The value LAST_INSERT_ID is stored on a per connection basis.
$t_text_id = db_insert_id( $t_bug_text_table );
# check to see if we want to assign this right off
$t_starting_status = config_get( 'bug_submit_status' );
$t_original_status = $this->status;
# if not assigned, check if it should auto-assigned.
if( 0 == $this->handler_id ) {
# if a default user is associated with the category and we know at this point
# that that the bug was not assigned to somebody, then assign it automatically.
$query = "SELECT user_id
FROM $t_category_table
WHERE id=" . db_param();
$result = db_query_bound( $query, array( $this->category_id ) );
if( db_num_rows( $result ) > 0 ) {
$this->handler_id = db_result( $result );
}
}
# Check if bug was pre-assigned or auto-assigned.
if( ( $this->handler_id != 0 ) && ( $this->status == $t_starting_status ) && ( ON == config_get( 'auto_set_status_to_assigned' ) ) ) {
$t_status = config_get( 'bug_assigned_status' );
} else {
$t_status = $this->status;
}
# Insert the rest of the data
$query = "INSERT INTO $t_bug_table
( project_id,reporter_id, handler_id,duplicate_id,
priority,severity, reproducibility,status,
resolution,projection, category_id,date_submitted,
last_updated,eta, bug_text_id,
os, os_build,platform, version,build,
profile_id, summary, view_state, sponsorship_total, sticky, fixed_in_version,
target_version, due_date
)
VALUES
( " . db_param() . ',' . db_param() . ',' . db_param() . ',' . db_param() . ",
" . db_param() . ',' . db_param() . ',' . db_param() . ',' . db_param() . ",
" . db_param() . ',' . db_param() . ',' . db_param() . ',' . db_param() . ",
" . db_param() . ',' . db_param() . ',' . db_param() . ',' . db_param() . ",
" . db_param() . ',' . db_param() . ',' . db_param() . ',' . db_param() . ",
" . db_param() . ',' . db_param() . ',' . db_param() . ',' . db_param() . ",
" . db_param() . ',' . db_param() . ',' . db_param() . ',' . db_param() . ')';
db_query_bound( $query, Array( $this->project_id, $this->reporter_id, $this->handler_id, $this->duplicate_id, $this->priority, $this->severity, $this->reproducibility, $t_status, $this->resolution, $this->projection, $this->category_id, db_now(), db_now(), $this->eta, $t_text_id, $this->os, $this->os_build, $this->platform, $this->version, $this->build, $this->profile_id, $this->summary, $this->view_state, $this->sponsorship_total, $this->sticky, $this->fixed_in_version, $this->target_version, $this->due_date ) );
$this->id = db_insert_id( $t_bug_table );
# log new bug
history_log_event_special( $this->id, NEW_BUG );
# log changes, if any (compare happens in history_log_event_direct)
history_log_event_direct( $t_bug_id, 'status', $t_original_status, $t_status );
history_log_event_direct( $t_bug_id, 'handler_id', 0, $c_handler_id );
return $this->id;
}
/**
* Update a bug from the given data structure
* If the third parameter is true, also update the longer strings table
* @param bool p_update_extended
* @param bool p_bypass_email Default false, set to true to avoid generating emails (if sending elsewhere)
* @return bool (always true)
* @access public
*/
function update( $p_update_extended = false, $p_bypass_mail = false ) {
self::validate( $p_update_extended );
$c_bug_id = $this->id;
if( is_blank( $this->due_date ) ) {
$this->due_date = date_get_null();
}
$t_old_data = bug_get( $this->id, true );
$t_bug_table = db_get_table( 'mantis_bug_table' );
# Update all fields
# Ignore date_submitted and last_updated since they are pulled out
# as unix timestamps which could confuse the history log and they
# shouldn't get updated like this anyway. If you really need to change
# them use bug_set_field()
$query = "UPDATE $t_bug_table
SET project_id=" . db_param() . ', reporter_id=' . db_param() . ",
handler_id=" . db_param() . ', duplicate_id=' . db_param() . ",
priority=" . db_param() . ', severity=' . db_param() . ",
reproducibility=" . db_param() . ', status=' . db_param() . ",
resolution=" . db_param() . ', projection=' . db_param() . ",
category_id=" . db_param() . ', eta=' . db_param() . ",
os=" . db_param() . ', os_build=' . db_param() . ",
platform=" . db_param() . ', version=' . db_param() . ",
build=" . db_param() . ', fixed_in_version=' . db_param() . ',';
$t_fields = Array(
$this->project_id, $this->reporter_id,
$this->handler_id, $this->duplicate_id,
$this->priority, $this->severity,
$this->reproducibility, $this->status,
$this->resolution, $this->projection,
$this->category_id, $this->eta,
$this->os, $this->os_build,
$this->platform, $this->version,
$this->build, $this->fixed_in_version,
);
$t_field_count = 18;
$t_roadmap_updated = false;
if( access_has_project_level( config_get( 'roadmap_update_threshold' ) ) ) {
$query .= "
target_version=" . db_param() . ",";
$t_fields[] = $this->target_version;
$t_roadmap_updated = true;
}
$query .= "
view_state=" . db_param() . ",
summary=" . db_param() . ",
sponsorship_total=" . db_param() . ",
sticky=" . db_param() . ",
due_date=" . db_param() . "
WHERE id=" . db_param();
$t_fields[] = $this->view_state;
$t_fields[] = $this->summary;
$t_fields[] = $this->sponsorship_total;
$t_fields[] = (bool)$this->sticky;
$t_fields[] = $this->due_date;
$t_fields[] = $this->id;
db_query_bound( $query, $t_fields );
bug_clear_cache( $this->id );
# log changes
history_log_event_direct( $c_bug_id, 'project_id', $t_old_data->project_id, $this->project_id );
history_log_event_direct( $c_bug_id, 'reporter_id', $t_old_data->reporter_id, $this->reporter_id );
history_log_event_direct( $c_bug_id, 'handler_id', $t_old_data->handler_id, $this->handler_id );
history_log_event_direct( $c_bug_id, 'priority', $t_old_data->priority, $this->priority );
history_log_event_direct( $c_bug_id, 'severity', $t_old_data->severity, $this->severity );
history_log_event_direct( $c_bug_id, 'reproducibility', $t_old_data->reproducibility, $this->reproducibility );
history_log_event_direct( $c_bug_id, 'status', $t_old_data->status, $this->status );
history_log_event_direct( $c_bug_id, 'resolution', $t_old_data->resolution, $this->resolution );
history_log_event_direct( $c_bug_id, 'projection', $t_old_data->projection, $this->projection );
history_log_event_direct( $c_bug_id, 'category', category_full_name( $t_old_data->category_id, false ), category_full_name( $this->category_id, false ) );
history_log_event_direct( $c_bug_id, 'eta', $t_old_data->eta, $this->eta );
history_log_event_direct( $c_bug_id, 'os', $t_old_data->os, $this->os );
history_log_event_direct( $c_bug_id, 'os_build', $t_old_data->os_build, $this->os_build );
history_log_event_direct( $c_bug_id, 'platform', $t_old_data->platform, $this->platform );
history_log_event_direct( $c_bug_id, 'version', $t_old_data->version, $this->version );
history_log_event_direct( $c_bug_id, 'build', $t_old_data->build, $this->build );
history_log_event_direct( $c_bug_id, 'fixed_in_version', $t_old_data->fixed_in_version, $this->fixed_in_version );
if( $t_roadmap_updated ) {
history_log_event_direct( $c_bug_id, 'target_version', $t_old_data->target_version, $this->target_version );
}
history_log_event_direct( $c_bug_id, 'view_state', $t_old_data->view_state, $this->view_state );
history_log_event_direct( $c_bug_id, 'summary', $t_old_data->summary, $this->summary );
history_log_event_direct( $c_bug_id, 'sponsorship_total', $t_old_data->sponsorship_total, $this->sponsorship_total );
history_log_event_direct( $c_bug_id, 'sticky', $t_old_data->sticky, $this->sticky );
history_log_event_direct( $c_bug_id, 'due_date', ( $t_old_data->due_date != date_get_null() ) ? $t_old_data->due_date : null, ( $this->due_date != date_get_null() ) ? $this->due_date : null );
# Update extended info if requested
if( $p_update_extended ) {
$t_bug_text_table = db_get_table( 'mantis_bug_text_table' );
$t_bug_text_id = bug_get_field( $c_bug_id, 'bug_text_id' );
$query = "UPDATE $t_bug_text_table
SET description=" . db_param() . ",
steps_to_reproduce=" . db_param() . ",
additional_information=" . db_param() . "
WHERE id=" . db_param();
db_query_bound( $query, Array( $this->description, $this->steps_to_reproduce, $this->additional_information, $t_bug_text_id ) );
bug_text_clear_cache( $c_bug_id );
$t_current_user = auth_get_current_user_id();
if( $t_old_data->description != $this->description ) {
if ( bug_revision_count( $c_bug_id, REV_DESCRIPTION ) < 1 ) {
$t_revision_id = bug_revision_add( $c_bug_id, $t_current_user, REV_DESCRIPTION, $t_old_data->description, 0, $t_old_data->last_updated );
}
$t_revision_id = bug_revision_add( $c_bug_id, $t_current_user, REV_DESCRIPTION, $this->description );
history_log_event_special( $c_bug_id, DESCRIPTION_UPDATED, $t_revision_id );
}
if( $t_old_data->steps_to_reproduce != $this->steps_to_reproduce ) {
if ( bug_revision_count( $c_bug_id, REV_STEPS_TO_REPRODUCE ) < 1 ) {
$t_revision_id = bug_revision_add( $c_bug_id, $t_current_user, REV_STEPS_TO_REPRODUCE, $t_old_data->steps_to_reproduce, 0, $t_old_data->last_updated );
}
$t_revision_id = bug_revision_add( $c_bug_id, $t_current_user, REV_STEPS_TO_REPRODUCE, $this->steps_to_reproduce );
history_log_event_special( $c_bug_id, STEP_TO_REPRODUCE_UPDATED, $t_revision_id );
}
if( $t_old_data->additional_information != $this->additional_information ) {
if ( bug_revision_count( $c_bug_id, REV_ADDITIONAL_INFO ) < 1 ) {
$t_revision_id = bug_revision_add( $c_bug_id, $t_current_user, REV_ADDITIONAL_INFO, $t_old_data->additional_information, 0, $t_old_data->last_updated );
}
$t_revision_id = bug_revision_add( $c_bug_id, $t_current_user, REV_ADDITIONAL_INFO, $this->additional_information );
history_log_event_special( $c_bug_id, ADDITIONAL_INFO_UPDATED, $t_revision_id );
}
}
# Update the last update date
bug_update_date( $c_bug_id );
# allow bypass if user is sending mail separately
if( false == $p_bypass_mail ) {
# status changed
if( $t_old_data->status != $this->status ) {
$t_status = MantisEnum::getLabel( config_get( 'status_enum_string' ), $this->status );
$t_status = str_replace( ' ', '_', $t_status );
email_generic( $c_bug_id, $t_status, 'email_notification_title_for_status_bug_' . $t_status );
return true;
}
# bug assigned
if( $t_old_data->handler_id != $this->handler_id ) {
email_generic( $c_bug_id, 'owner', 'email_notification_title_for_action_bug_assigned' );
return true;
}
# @todo handle priority change if it requires special handling
# generic update notification
email_generic( $c_bug_id, 'updated', 'email_notification_title_for_action_bug_updated' );
}
return true;
}
}
$g_cache_bug = array();
$g_cache_bug_text = array();
/**
* Cache a database result-set containing full contents of bug_table row.
* @param array p_bug_database_result database row containing all columns from mantis_bug_table
* @param array p_stats (optional) array representing bugnote stats
* @return array returns an array representing the bug row if bug exists
* @access public
*/
function bug_cache_database_result( $p_bug_database_result, $p_stats = null ) {
global $g_cache_bug;
if( !is_array( $p_bug_database_result ) || isset( $g_cache_bug[(int) $p_bug_database_result['id']] ) ) {
return $g_cache_bug[(int) $p_bug_database_result['id']];
}
return bug_add_to_cache( $p_bug_database_result, $p_stats );
}
/**
* Cache a bug row if necessary and return the cached copy
* @param array p_bug_id id of bug to cache from mantis_bug_table
* @param array p_trigger_errors set to true to trigger an error if the bug does not exist.
* @return bool|array returns an array representing the bug row if bug exists or false if bug does not exist
* @access public
* @uses database_api.php
*/
function bug_cache_row( $p_bug_id, $p_trigger_errors = true ) {
global $g_cache_bug;
if( isset( $g_cache_bug[$p_bug_id] ) ) {
return $g_cache_bug[$p_bug_id];
}
$c_bug_id = (int) $p_bug_id;
$t_bug_table = db_get_table( 'mantis_bug_table' );
$query = "SELECT *
FROM $t_bug_table
WHERE id=" . db_param();
$result = db_query_bound( $query, Array( $c_bug_id ) );
if( 0 == db_num_rows( $result ) ) {
$g_cache_bug[$c_bug_id] = false;
if( $p_trigger_errors ) {
error_parameters( $p_bug_id );
trigger_error( ERROR_BUG_NOT_FOUND, ERROR );
} else {
return false;
}
}
$row = db_fetch_array( $result );
return bug_add_to_cache( $row );
}
/**
* Cache a set of bugs
* @param array p_bug_id_array integer array representing bug ids to cache
* @return null
* @access public
* @uses database_api.php
*/
function bug_cache_array_rows( $p_bug_id_array ) {
global $g_cache_bug;
$c_bug_id_array = array();
foreach( $p_bug_id_array as $t_bug_id ) {
if( !isset( $g_cache_bug[(int) $t_bug_id] ) ) {
$c_bug_id_array[] = (int) $t_bug_id;
}
}
if( empty( $c_bug_id_array ) ) {
return;
}
$t_bug_table = db_get_table( 'mantis_bug_table' );
$query = "SELECT *
FROM $t_bug_table
WHERE id IN (" . implode( ',', $c_bug_id_array ) . ')';
$result = db_query_bound( $query );
while( $row = db_fetch_array( $result ) ) {
bug_add_to_cache( $row );
}
return;
}
/**
* Inject a bug into the bug cache
* @param array p_bug_row bug row to cache
* @param array p_stats bugnote stats to cache
* @return null
* @access private
*/
function bug_add_to_cache( $p_bug_row, $p_stats = null ) {
global $g_cache_bug;
$g_cache_bug[(int) $p_bug_row['id']] = $p_bug_row;
if( !is_null( $p_stats ) ) {
$g_cache_bug[(int) $p_bug_row['id']]['_stats'] = $p_stats;
}
return $g_cache_bug[(int) $p_bug_row['id']];
}
/**
* Clear a bug from the cache or all bugs if no bug id specified.
* @param int bug id to clear (optional)
* @return null
* @access public
*/
function bug_clear_cache( $p_bug_id = null ) {
global $g_cache_bug;
if( null === $p_bug_id ) {
$g_cache_bug = array();
} else {
unset( $g_cache_bug[(int) $p_bug_id] );
}
return true;
}
/**
* Cache a bug text row if necessary and return the cached copy
* @param int p_bug_id integer bug id to retrieve text for
* @param bool p_trigger_errors If the second parameter is true (default), trigger an error if bug text not found.
* @return bool|array returns false if not bug text found or array of bug text
* @access public
* @uses database_api.php
*/
function bug_text_cache_row( $p_bug_id, $p_trigger_errors = true ) {
global $g_cache_bug_text;
$c_bug_id = (int) $p_bug_id;
$t_bug_table = db_get_table( 'mantis_bug_table' );
$t_bug_text_table = db_get_table( 'mantis_bug_text_table' );
if( isset( $g_cache_bug_text[$c_bug_id] ) ) {
return $g_cache_bug_text[$c_bug_id];
}
$query = "SELECT bt.*
FROM $t_bug_text_table bt, $t_bug_table b
WHERE b.id=" . db_param() . " AND
b.bug_text_id = bt.id";
$result = db_query_bound( $query, Array( $c_bug_id ) );
if( 0 == db_num_rows( $result ) ) {
$g_cache_bug_text[$c_bug_id] = false;
if( $p_trigger_errors ) {
error_parameters( $p_bug_id );
trigger_error( ERROR_BUG_NOT_FOUND, ERROR );
} else {
return false;
}
}
$row = db_fetch_array( $result );
$g_cache_bug_text[$c_bug_id] = $row;
return $row;
}
/**
* Clear a bug's bug text from the cache or all bug text if no bug id specified.
* @param int bug id to clear (optional)
* @return null
* @access public
*/
function bug_text_clear_cache( $p_bug_id = null ) {
global $g_cache_bug_text;
if( null === $p_bug_id ) {
$g_cache_bug_text = array();
} else {
unset( $g_cache_bug_text[(int) $p_bug_id] );
}
return true;
}
/**
* Check if a bug exists
* @param int p_bug_id integer representing bug id
* @return bool true if bug exists, false otherwise
* @access public
*/
function bug_exists( $p_bug_id ) {
if( false == bug_cache_row( $p_bug_id, false ) ) {
return false;
} else {
return true;
}
}
/**
* Check if a bug exists. If it doesn't then trigger an error
* @param int p_bug_id integer representing bug id
* @return null
* @access public
*/
function bug_ensure_exists( $p_bug_id ) {
if( !bug_exists( $p_bug_id ) ) {
error_parameters( $p_bug_id );
trigger_error( ERROR_BUG_NOT_FOUND, ERROR );
}
}
/**
* check if the given user is the reporter of the bug
* @param int p_bug_id integer representing bug id
* @param int p_user_id integer reprenting a user id
* @return bool return true if the user is the reporter, false otherwise
* @access public
*/
function bug_is_user_reporter( $p_bug_id, $p_user_id ) {
if( bug_get_field( $p_bug_id, 'reporter_id' ) == $p_user_id ) {
return true;
} else {
return false;
}
}
/**
* check if the given user is the handler of the bug
* @param int p_bug_id integer representing bug id
* @param int p_user_id integer reprenting a user id
* @return bool return true if the user is the handler, false otherwise
* @access public
*/
function bug_is_user_handler( $p_bug_id, $p_user_id ) {
if( bug_get_field( $p_bug_id, 'handler_id' ) == $p_user_id ) {
return true;
} else {
return false;
}
}
/**
* Check if the bug is readonly and shouldn't be modified
* For a bug to be readonly the status has to be >= bug_readonly_status_threshold and
* current user access level < update_readonly_bug_threshold.
* @param int p_bug_id integer representing bug id
* @return bool
* @access public
* @uses access_api.php
* @uses config_api.php
*/
function bug_is_readonly( $p_bug_id ) {
$t_status = bug_get_field( $p_bug_id, 'status' );
if( $t_status < config_get( 'bug_readonly_status_threshold' ) ) {
return false;
}
if( access_has_bug_level( config_get( 'update_readonly_bug_threshold' ), $p_bug_id ) ) {
return false;
}
return true;
}
/**
* Check if a given bug is resolved
* @param int p_bug_id integer representing bug id
* @return bool true if bug is resolved, false otherwise
* @access public
* @uses config_api.php
*/
function bug_is_resolved( $p_bug_id ) {
$t_status = bug_get_field( $p_bug_id, 'status' );
return( $t_status >= config_get( 'bug_resolved_status_threshold' ) );
}
/**
* Check if a given bug is overdue
* @param int p_bug_id integer representing bug id
* @return bool true if bug is overdue, false otherwise
* @access public
* @uses database_api.php
*/
function bug_is_overdue( $p_bug_id ) {
$t_due_date = bug_get_field( $p_bug_id, 'due_date' );
if( !date_is_null( $t_due_date ) ) {
$t_now = db_now();
if( $t_now > $t_due_date ) {
if( !bug_is_resolved( $p_bug_id ) ) {
return true;
}
}
}
return false;
}
/**
* Validate workflow state to see if bug can be moved to requested state
* @param int p_bug_status current bug status
* @param int p_wanted_status new bug status
* @return bool
* @access public
* @uses config_api.php
* @uses utility_api.php
*/
function bug_check_workflow( $p_bug_status, $p_wanted_status ) {
$t_status_enum_workflow = config_get( 'status_enum_workflow' );
if( count( $t_status_enum_workflow ) < 1 ) {
# workflow not defined, use default enum
return true;
}
if ( $p_bug_status == $p_wanted_status ) {
# no change in state, allow the transition
return true;
}
# workflow defined - find allowed states
$t_allowed_states = $t_status_enum_workflow[$p_bug_status];
return MantisEnum::hasValue( $t_allowed_states, $p_wanted_status );
}
/**
* Copy a bug from one project to another. Also make copies of issue notes, attachments, history,
* email notifications etc.
* @todo Not managed FTP file upload
* @param array p_bug_id integer representing bug id
* @param int p_target_project_id
* @param bool p_copy_custom_fields
* @param bool p_copy_relationships
* @return int representing the new bugid
* @access public
*/
function bug_copy( $p_bug_id, $p_target_project_id = null, $p_copy_custom_fields = false, $p_copy_relationships = false, $p_copy_history = false, $p_copy_attachments = false, $p_copy_bugnotes = false, $p_copy_monitoring_users = false ) {
global $g_db;
$t_mantis_custom_field_string_table = db_get_table( 'mantis_custom_field_string_table' );
$t_mantis_bug_file_table = db_get_table( 'mantis_bug_file_table' );
$t_mantis_bugnote_table = db_get_table( 'mantis_bugnote_table' );
$t_mantis_bugnote_text_table = db_get_table( 'mantis_bugnote_text_table' );
$t_mantis_bug_monitor_table = db_get_table( 'mantis_bug_monitor_table' );
$t_mantis_bug_history_table = db_get_table( 'mantis_bug_history_table' );
$t_mantis_db = $g_db;
$t_bug_id = db_prepare_int( $p_bug_id );
$t_target_project_id = db_prepare_int( $p_target_project_id );
$t_bug_data = bug_get( $t_bug_id, true );
# retrieve the project id associated with the bug
if(( $p_target_project_id == null ) || is_blank( $p_target_project_id ) ) {
$t_target_project_id = $t_bug_data->project_id;
}
$t_bug_data->project_id = $t_target_project_id;
$t_new_bug_id = $t_bug_data->create();
# MASC ATTENTION: IF THE SOURCE BUG HAS TO HANDLER THE bug_create FUNCTION CAN TRY TO AUTO-ASSIGN THE BUG
# WE FORCE HERE TO DUPLICATE THE SAME HANDLER OF THE SOURCE BUG
# @todo VB: Shouldn't we check if the handler in the source project is also a handler in the destination project?
bug_set_field( $t_new_bug_id, 'handler_id', $t_bug_data->handler_id );
bug_set_field( $t_new_bug_id, 'duplicate_id', $t_bug_data->duplicate_id );
bug_set_field( $t_new_bug_id, 'status', $t_bug_data->status );
bug_set_field( $t_new_bug_id, 'resolution', $t_bug_data->resolution );
bug_set_field( $t_new_bug_id, 'projection', $t_bug_data->projection );
bug_set_field( $t_new_bug_id, 'date_submitted', $t_bug_data->date_submitted );
bug_set_field( $t_new_bug_id, 'last_updated', $t_bug_data->last_updated );
bug_set_field( $t_new_bug_id, 'eta', $t_bug_data->eta );
bug_set_field( $t_new_bug_id, 'fixed_in_version', $t_bug_data->fixed_in_version );
bug_set_field( $t_new_bug_id, 'target_version', $t_bug_data->target_version );
bug_set_field( $t_new_bug_id, 'sponsorship_total', 0 );
bug_set_field( $t_new_bug_id, 'sticky', 0 );
bug_set_field( $t_new_bug_id, 'due_date', $t_bug_data->due_date );
# COPY CUSTOM FIELDS
if( $p_copy_custom_fields ) {
$query = "SELECT field_id, bug_id, value
FROM $t_mantis_custom_field_string_table
WHERE bug_id=" . db_param();
$result = db_query_bound( $query, Array( $t_bug_id ) );
$t_count = db_num_rows( $result );
for( $i = 0;$i < $t_count;$i++ ) {
$t_bug_custom = db_fetch_array( $result );
$c_field_id = db_prepare_int( $t_bug_custom['field_id'] );
$c_new_bug_id = db_prepare_int( $t_new_bug_id );
$c_value = $t_bug_custom['value'];
$query = "INSERT INTO $t_mantis_custom_field_string_table
( field_id, bug_id, value )
VALUES (" . db_param() . ', ' . db_param() . ', ' . db_param() . ')';
db_query_bound( $query, Array( $c_field_id, $c_new_bug_id, $c_value ) );
}
}
# Copy Relationships
if( $p_copy_relationships ) {
relationship_copy_all( $t_bug_id, $t_new_bug_id );
}
# Copy bugnotes
if( $p_copy_bugnotes ) {
$query = "SELECT *
FROM $t_mantis_bugnote_table
WHERE bug_id=" . db_param();
$result = db_query_bound( $query, Array( $t_bug_id ) );
$t_count = db_num_rows( $result );
for( $i = 0;$i < $t_count;$i++ ) {
$t_bug_note = db_fetch_array( $result );
$t_bugnote_text_id = $t_bug_note['bugnote_text_id'];
$query2 = "SELECT *
FROM $t_mantis_bugnote_text_table
WHERE id=" . db_param();
$result2 = db_query_bound( $query2, Array( $t_bugnote_text_id ) );
$t_count2 = db_num_rows( $result2 );
$t_bugnote_text_insert_id = -1;
if( $t_count2 > 0 ) {
$t_bugnote_text = db_fetch_array( $result2 );
$query2 = "INSERT INTO $t_mantis_bugnote_text_table
( note )
VALUES ( " . db_param() . ' )';
db_query_bound( $query2, Array( $t_bugnote_text['note'] ) );
$t_bugnote_text_insert_id = db_insert_id( $t_mantis_bugnote_text_table );
}
$query2 = "INSERT INTO $t_mantis_bugnote_table
( bug_id, reporter_id, bugnote_text_id, view_state, date_submitted, last_modified )
VALUES ( " . db_param() . ",
" . db_param() . ",
" . db_param() . ",
" . db_param() . ",
" . db_param() . ",
" . db_param() . ')';
db_query_bound( $query2, Array( $t_new_bug_id, $t_bug_note['reporter_id'], $t_bugnote_text_insert_id, $t_bug_note['view_state'], $t_bug_note['date_submitted'], $t_bug_note['last_modified'] ) );
}