/
bug_api.php
1016 lines (829 loc) · 31.6 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
# Mantis - a php based bugtracking system
# Copyright (C) 2000 - 2002 Kenzaburo Ito - kenito@300baud.org
# Copyright (C) 2002 - 2003 Mantis Team - mantisbt-dev@lists.sourceforge.net
# This program is distributed under the terms and conditions of the GPL
# See the README and LICENSE files for details
# --------------------------------------------------------
# $Id: bug_api.php,v 1.35 2003-02-15 10:25:21 jfitzell Exp $
# --------------------------------------------------------
$t_core_dir = dirname( __FILE__ ).DIRECTORY_SEPARATOR;
require_once( $t_core_dir . 'history_api.php' );
require_once( $t_core_dir . 'email_api.php' );
require_once( $t_core_dir . 'bugnote_api.php' );
require_once( $t_core_dir . 'file_api.php' );
require_once( $t_core_dir . 'string_api.php' );
###########################################################################
# Bug API
###########################################################################
#===================================
# Bug Data Structure Definition
#===================================
class BugData {
var $project_id = 0;
var $reporter_id = 0;
var $handler_id = 0;
var $duplicate_id = 0;
var $priority = NORMAL;
var $severity = MINOR;
var $reproducibility = 10;
var $status = NEW_;
var $resolution = OPEN;
var $projection = 10;
var $category = '';
var $date_submitted = '';
var $last_updated = '';
var $eta = 10;
var $os = '';
var $os_build = '';
var $platform = '';
var $version = '';
var $build = '';
var $votes = 0;
var $view_state = PUBLIC;
var $summary = '';
# omitted:
# var $bug_text_id
# var $profile_id
# extended info
var $description = '';
var $steps_to_reproduce = '';
var $additional_information = '';
}
#===================================
# Caching
#===================================
#########################################
# SECURITY NOTE: cache globals are initialized here to prevent them
# being spoofed if register_globals is turned on
#
$g_cache_bug = array();
$g_cache_bug_text = array();
# Cache a bug row if necessary and return the cached copy
# If the second parameter is true (default), trigger an error
# if the bug can't be found. If the second parameter is
# false, return false if the bug can't be found.
function bug_cache_row( $p_bug_id, $p_trigger_errors=true ) {
global $g_cache_bug;
$c_bug_id = db_prepare_int( $p_bug_id );
$t_bug_table = config_get( 'mantis_bug_table' );
if ( isset ( $g_cache_bug[$c_bug_id] ) ) {
return $g_cache_bug[$c_bug_id];
}
$query = "SELECT *, UNIX_TIMESTAMP(date_submitted) as date_submitted,
UNIX_TIMESTAMP(last_updated) as last_updated
FROM $t_bug_table
WHERE id='$c_bug_id'";
$result = db_query( $query );
if ( 0 == db_num_rows( $result ) ) {
$g_cache_bug[$c_bug_id] = false;
if ( $p_trigger_errors ) {
trigger_error( ERROR_BUG_NOT_FOUND, ERROR );
} else {
return false;
}
}
$row = db_fetch_array( $result );
$g_cache_bug[$c_bug_id] = $row;
return $row;
}
# --------------------
# Clear the bug cache (or just the given id if specified)
function bug_clear_cache( $p_bug_id = null ) {
global $g_cache_bug;
if ( null === $p_bug_id ) {
$g_cache_bug = array();
} else {
$c_bug_id = db_prepare_int( $p_bug_id );
unset( $g_cache_bug[$c_bug_id] );
}
return true;
}
# --------------------
# Cache a bug text row if necessary and return the cached copy
# If the second parameter is true (default), trigger an error
# if the bug text can't be found. If the second parameter is
# false, return false if the bug text can't be found.
function bug_text_cache_row( $p_bug_id, $p_trigger_errors=true ) {
global $g_cache_bug_text;
$c_bug_id = db_prepare_int( $p_bug_id );
$t_bug_table = config_get( 'mantis_bug_table' );
$t_bug_text_table = config_get( '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='$c_bug_id'
AND b.bug_text_id = bt.id";
$result = db_query( $query );
if ( 0 == db_num_rows( $result ) ) {
$g_cache_bug_text[$c_bug_id] = false;
if ( $p_trigger_errors ) {
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 the bug text cache (or just the given id if specified)
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 {
$c_bug_id = db_prepare_int( $p_bug_id );
unset( $g_cache_bug_text[$c_bug_id] );
}
return true;
}
#===================================
# Boolean queries and ensures
#===================================
# --------------------
# check to see if bug exists by id
# return true if it does, false otherwise
function bug_exists( $p_bug_id ) {
if ( false == bug_cache_row( $p_bug_id, false ) ) {
return false;
} else {
return true;
}
}
# --------------------
# check to see if bug exists by id
# if it doesn't exist then error
# otherwise let execution continue undisturbed
function bug_ensure_exists( $p_bug_id ) {
if ( ! bug_exists( $p_bug_id ) ) {
trigger_error( ERROR_BUG_NOT_FOUND, ERROR );
}
}
# --------------------
# check if the given user is the reporter of the bug
# return true if the user is the reporter, false otherwise
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
# return true if the user is the handler, false otherwise
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;
}
}
#===================================
# Creation / Deletion / Updating
#===================================
# --------------------
# Create a new bug and return the bug id
#
# @@@ pass in a bug object instead of all these params
function bug_create( $p_project_id,
$p_reporter_id, $p_handler_id,
$p_priority,
$p_severity, $p_reproducibility,
$p_category,
$p_os, $p_os_build,
$p_platform, $p_version,
$p_build,
$p_profile_id, $p_summary, $p_view_state,
$p_description, $p_steps_to_reproduce, $p_additional_info ) {
$c_summary = db_prepare_string( $p_summary );
$c_description = db_prepare_string( $p_description );
$c_project_id = db_prepare_int( $p_project_id );
$c_reporter_id = db_prepare_int( $p_reporter_id );
$c_handler_id = db_prepare_int( $p_handler_id );
$c_priority = db_prepare_int( $p_priority );
$c_severity = db_prepare_int( $p_severity );
$c_reproducibility = db_prepare_int( $p_reproducibility );
$c_category = db_prepare_string( $p_category );
$c_os = db_prepare_string( $p_os );
$c_os_build = db_prepare_string( $p_os_build );
$c_platform = db_prepare_string( $p_platform );
$c_version = db_prepare_string( $p_version );
$c_build = db_prepare_string( $p_build );
$c_profile_id = db_prepare_int( $p_profile_id );
$c_view_state = db_prepare_int( $p_view_state );
$c_steps_to_reproduce = db_prepare_string( $p_steps_to_reproduce );
$c_additional_info = db_prepare_string( $p_additional_info );
# Summary and description cannot be blank
if ( is_blank( $c_summary ) || is_blank( $c_description ) ) {
trigger_error( ERROR_EMPTY_FIELD, ERROR );
}
$t_bug_text_table = config_get( 'mantis_bug_text_table' );
$t_bug_table = config_get( 'mantis_bug_table' );
$t_project_category_table = config_get( 'mantis_project_category_table' );
# Insert text information
$query = "INSERT
INTO $t_bug_text_table
( id, description, steps_to_reproduce, additional_information )
VALUES
( null, '$c_description', '$c_steps_to_reproduce',
'$c_additional_info' )";
db_query( $query );
# 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();
# check to see if we want to assign this right off
$t_status = NEW_;
# if not assigned, check if it should auto-assigned.
if ( 0 == $c_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_project_category_table
WHERE project_id='$c_project_id' AND category='$c_category'";
$result = db_query( $query );
if ( db_num_rows( $result ) > 0 ) {
$c_handler_id = $p_handler_id = db_result( $result );
}
}
# Check if bug was pre-assigned or auto-assigned.
if ( ( $c_handler_id != 0 ) && ( ON == config_get( 'auto_set_status_to_assigned' ) ) ) {
$t_status = ASSIGNED;
}
# Insert the rest of the data
$t_resolution = OPEN;
$query = "INSERT
INTO $t_bug_table
( id, project_id,
reporter_id, handler_id,
duplicate_id, priority,
severity, reproducibility,
status, resolution,
projection, category,
date_submitted, last_updated,
eta, bug_text_id,
os, os_build,
platform, version,
build, votes,
profile_id, summary, view_state )
VALUES
( null, '$c_project_id',
'$c_reporter_id', '$c_handler_id',
'0', '$c_priority',
'$c_severity', '$c_reproducibility',
'$t_status', '$t_resolution',
10, '$c_category',
NOW(), NOW(),
10, '$t_text_id',
'$c_os', '$c_os_build',
'$c_platform', '$c_version',
'$c_build', 1,
'$c_profile_id', '$c_summary', '$c_view_state' )";
db_query( $query );
$t_bug_id = db_insert_id();
# log new bug
history_log_event_special( $t_bug_id, NEW_BUG );
email_new_bug( $t_bug_id );
return $t_bug_id;
}
# --------------------
# allows bug deletion :
# delete the bug, bugtext, bugnote, and bugtexts selected
# used in bug_delete.php & mass treatments
function bug_delete( $p_bug_id ) {
$c_bug_id = db_prepare_int( $p_bug_id );
$t_bug_table = config_get( 'mantis_bug_table' );
$t_bug_text_table = config_get( 'mantis_bug_text_table' );
email_bug_deleted( $p_bug_id );
# Delete custom fields
if ( ON == config_get( 'use_experimental_custom_fields' ) ) {
custom_field_delete_all_values( $p_bug_id );
}
# Delete bugnotes
bugnote_delete_all( $p_bug_id );
# Delete files
file_delete_attachments( $p_bug_id );
# Delete the bug history
history_delete( $p_bug_id );
# Delete the bugnote text
$t_bug_text_id = bug_get_field( $p_bug_id, 'bug_text_id' );
$query = "DELETE
FROM $t_bug_text_table
WHERE id='$t_bug_text_id'";
db_query( $query );
# Delete the bug entry
$query = "DELETE
FROM $t_bug_table
WHERE id='$c_bug_id'";
db_query( $query );
bug_clear_cache( $p_bug_id );
bug_text_clear_cache( $p_bug_id );
# db_query() errors on failure so:
return true;
}
# --------------------
# Delete all bugs associated with a project
function bug_delete_all( $p_project_id ) {
$c_project_id = db_prepare_int( $p_project_id );
$t_bug_table = config_get( 'mantis_bug_table' );
$query = "SELECT id
FROM $t_bug_table
WHERE project_id='$c_project_id'";
$result = db_query( $query );
$bug_count = db_num_rows( $result );
for ( $i=0 ; $i < $bug_count ; $i++ ) {
$row = db_fetch_array( $result );
bug_delete( $row['id'] );
}
# @@@ should we check the return value of each bug_delete() and
# return false if any of them return false? Presumable bug_delete()
# will eventually trigger an error on failure so it won't matter...
return true;
}
# --------------------
# Update a bug from the given data structure
# If the third parameter is true, also update the longer strings table
function bug_update( $p_bug_id, $p_bug_data, $p_update_extended = false ) {
$c_bug_id = db_prepare_int( $p_bug_id );
$c_bug_data = bug_prepare_db( $p_bug_data );
# Summary field cannot be empty
if ( is_blank( $c_bug_data->summary ) ) {
trigger_error( ERROR_EMPTY_FIELD, ERROR );
}
if ( $p_update_extended )
{
# Description field cannot be empty
if ( is_blank( $c_bug_data->description ) ) {
trigger_error( ERROR_EMPTY_FIELD, ERROR );
}
}
$t_old_data = bug_get( $p_bug_id, true );
$t_bug_table = config_get( '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='$c_bug_data->project_id',
reporter_id='$c_bug_data->reporter_id',
handler_id='$c_bug_data->handler_id',
duplicate_id='$c_bug_data->duplicate_id',
priority='$c_bug_data->priority',
severity='$c_bug_data->severity',
reproducibility='$c_bug_data->reproducibility',
status='$c_bug_data->status',
resolution='$c_bug_data->resolution',
projection='$c_bug_data->projection',
category='$c_bug_data->category',
eta='$c_bug_data->eta',
os='$c_bug_data->os',
os_build='$c_bug_data->os_build',
platform='$c_bug_data->platform',
version='$c_bug_data->version',
build='$c_bug_data->build',
votes='$c_bug_data->votes',
view_state='$c_bug_data->view_state',
summary='$c_bug_data->summary'
WHERE id='$c_bug_id'";
db_query( $query );
bug_clear_cache( $p_bug_id );
# log changes
history_log_event_direct( $p_bug_id, 'project_id',
$t_old_data->project_id, $p_bug_data->project_id );
history_log_event_direct( $p_bug_id, 'reporter_id',
$t_old_data->reporter_id, $p_bug_data->reporter_id );
history_log_event_direct( $p_bug_id, 'handler_id',
$t_old_data->handler_id, $p_bug_data->handler_id );
history_log_event_direct( $p_bug_id, 'duplicate_id',
$t_old_data->duplicate_id, $p_bug_data->duplicate_id );
history_log_event_direct( $p_bug_id, 'priority',
$t_old_data->priority, $p_bug_data->priority );
history_log_event_direct( $p_bug_id, 'severity',
$t_old_data->severity, $p_bug_data->severity );
history_log_event_direct( $p_bug_id, 'reproducibility',
$t_old_data->reproducibility, $p_bug_data->reproducibility );
history_log_event_direct( $p_bug_id, 'status',
$t_old_data->status, $p_bug_data->status );
history_log_event_direct( $p_bug_id, 'resolution',
$t_old_data->resolution, $p_bug_data->resolution );
history_log_event_direct( $p_bug_id, 'projection',
$t_old_data->projection, $p_bug_data->projection );
history_log_event_direct( $p_bug_id, 'category',
$t_old_data->category, $p_bug_data->category );
history_log_event_direct( $p_bug_id, 'eta',
$t_old_data->eta, $p_bug_data->eta );
history_log_event_direct( $p_bug_id, 'os',
$t_old_data->os, $p_bug_data->os );
history_log_event_direct( $p_bug_id, 'os_build',
$t_old_data->os_build, $p_bug_data->os_build );
history_log_event_direct( $p_bug_id, 'platform',
$t_old_data->platform, $p_bug_data->platform );
history_log_event_direct( $p_bug_id, 'version',
$t_old_data->version, $p_bug_data->version );
history_log_event_direct( $p_bug_id, 'build',
$t_old_data->build, $p_bug_data->build );
history_log_event_direct( $p_bug_id, 'votes',
$t_old_data->votes, $p_bug_data->votes );
history_log_event_direct( $p_bug_id, 'view_state',
$t_old_data->view_state, $p_bug_data->view_state );
history_log_event_direct( $p_bug_id, 'summary',
$t_old_data->summary, $p_bug_data->summary );
# Update extended info if requested
if ( $p_update_extended ) {
$t_bug_text_table = config_get( 'mantis_bug_text_table' );
$t_bug_text_id = bug_get_field( $p_bug_id, 'bug_text_id' );
$query = "UPDATE $t_bug_text_table ".
"SET description='$c_bug_data->description', ".
"steps_to_reproduce='$c_bug_data->steps_to_reproduce', ".
"additional_information='$c_bug_data->additional_information' ".
"WHERE id='$t_bug_text_id'";
db_query( $query );
bug_text_clear_cache( $p_bug_id );
if ( $t_old_data->description != $p_bug_data->description ) {
history_log_event_special( $p_bug_id, DESCRIPTION_UPDATED );
}
if ( $t_old_data->steps_to_reproduce != $p_bug_data->steps_to_reproduce ) {
history_log_event_special( $p_bug_id, STEP_TO_REPRODUCE_UPDATED );
}
if ( $t_old_data->additional_information != $p_bug_data->additional_information ) {
history_log_event_special( $p_bug_id, ADDITIONAL_INFO_UPDATED );
}
}
# Update the last update date
bug_update_date( $p_bug_id );
# @@@ VBOCTOR: I don't like the following code since it hard-codes some assumptions
# about the bug states and when an email should be sent. There should
# be configuration options that achieves the same in a generic way.
# Suggestion:
# - An email should always be sent if the handler is changed, independent
# of whether the status is changed or not. The configs should specify
# who is to be notified in this case.
# - The first index of $g_notify_flags should be the status id rather
# a string that corresponds to it. For example, _NEW rather than
# 'new'.
# - $s_bug_update_notification[<status>] that is to be used to
# determine the message to be displayed at the top of the email.
#
# If we should notify and it's in feedback state then send an email
switch ( $p_bug_data->status ) {
case NEW_:
# This will be used in the case where auto-assign = OFF, in this case the bug can be
# assigned/unassigned while the status is NEW.
# @@@ In case of unassigned, the e-mail will still say ASSIGNED, but it will be shown
# that the handler is empty + history ( old_handler => @null@ ).
if ( $p_bug_data->handler_id != $t_old_data->handler_id ) {
email_assign( $p_bug_id );
}
break;
case FEEDBACK:
if ( $p_bug_data->status!= $t_old_data->status ) {
email_feedback( $p_bug_id );
}
break;
case ASSIGNED:
if ( ( $p_bug_data->handler_id != $t_old_data->handler_id )
|| ( $p_bug_data->status != $t_old_data->status ) ) {
email_assign( $p_bug_id );
}
break;
case RESOLVED:
email_resolved( $p_bug_id );
break;
case CLOSED:
email_close( $p_bug_id );
break;
}
return true;
}
#===================================
# Data Access
#===================================
# --------------------
# Returns the extended record of the specified bug, this includes
# the bug text fields
# @@@ include reporter name and handler name, the problem is that
# handler can be 0, in this case no corresponding name will be
# found. Use equivalent of (+) in Oracle.
function bug_get_extended_row( $p_bug_id ) {
$t_base = bug_cache_row( $p_bug_id );
$t_text = bug_text_cache_row( $p_bug_id );
# merge $t_text first so that the 'id' key has the bug id not the bug text id
return array_merge( $t_text, $t_base );
}
# --------------------
# Returns the record of the specified bug
function bug_get_row( $p_bug_id ) {
return bug_cache_row( $p_bug_id );
}
# --------------------
# Returns an object representing the specified bug
function bug_get( $p_bug_id, $p_get_extended = false ) {
if ( $p_get_extended ) {
$row = bug_get_extended_row( $p_bug_id );
} else {
$row = bug_get_row( $p_bug_id );
}
$t_bug_data = new BugData;
$t_row_keys = array_keys( $row );
$t_vars = get_object_vars( $t_bug_data );
# Check each variable in the class
foreach ( $t_vars as $var => $val ) {
# If we got a field from the DB with the same name
if ( in_array( $var, $t_row_keys, true ) ) {
# Store that value in the object
$t_bug_data->$var = $row[$var];
}
}
return $t_bug_data;
}
# --------------------
# return the specified field of the given bug
# if the field does not exist, display a warning and return ''
function bug_get_field( $p_bug_id, $p_field_name ) {
$row = bug_get_row( $p_bug_id );
if ( isset( $row[$p_field_name] ) ) {
return $row[$p_field_name];
} else {
trigger_error( ERROR_DB_FIELD_NOT_FOUND, WARNING );
return '';
}
}
# --------------------
# return the specified text field of the given bug
# if the field does not exist, display a warning and return ''
function bug_get_text_field( $p_bug_id, $p_field_name ) {
$row = bug_text_cache_row( $p_bug_id );
if ( isset( $row[$p_field_name] ) ) {
return $row[$p_field_name];
} else {
trigger_error( ERROR_DB_FIELD_NOT_FOUND, WARNING );
return '';
}
}
# --------------------
# Returns the number of bugnotes for the given bug_id
function bug_get_bugnote_count( $p_bug_id ) {
$c_bug_id = db_prepare_int( $p_bug_id );
$t_project_id = bug_get_field( $p_bug_id, 'project_id' );
if ( !access_has_project_level( config_get( 'private_bugnote_threshold' ), $t_project_id ) ) {
$t_restriction = 'AND view_state=' . PUBLIC;
} else {
$t_restriction = '';
}
$t_bugnote_table = config_get( 'mantis_bugnote_table' );
$query = "SELECT COUNT(*)
FROM $t_bugnote_table
WHERE bug_id ='$c_bug_id' $t_restriction";
$result = db_query( $query );
return db_result( $result );
}
# --------------------
# return the timestamp for the most recent time at which a bugnote
# associated wiht the bug was modified
function bug_get_newest_bugnote_timestamp( $p_bug_id ) {
$c_bug_id = db_prepare_int( $p_bug_id );
$t_bugnote_table = config_get( 'mantis_bugnote_table' );
$query = "SELECT UNIX_TIMESTAMP(last_modified) as last_modified
FROM $t_bugnote_table
WHERE bug_id='$c_bug_id'
ORDER BY last_modified DESC
LIMIT 1";
$result = db_query( $query );
return db_result( $result );
}
#===================================
# Data Modification
#===================================
# --------------------
# set the value of a bug field
function bug_set_field( $p_bug_id, $p_field_name, $p_status ) {
$c_bug_id = db_prepare_int( $p_bug_id );
$c_field_name = db_prepare_string( $p_field_name );
$c_status = db_prepare_string( $p_status ); #generic, unknown type
$h_status = bug_get_field( $p_bug_id, $p_field_name );
# return if status is already set
if ( $c_status == $h_status ) {
return true;
}
$t_bug_table = config_get( 'mantis_bug_table' );
# Update fields
$query = "UPDATE $t_bug_table
SET $c_field_name='$c_status'
WHERE id='$c_bug_id'";
db_query( $query );
# updated the last_updated date
bug_update_date( $p_bug_id );
# log changes
history_log_event_direct( $p_bug_id, $p_field_name, $h_status, $p_status );
bug_clear_cache( $p_bug_id );
return true;
}
# --------------------
# assign the bug to the given user
function bug_assign( $p_bug_id, $p_user_id, $p_bugnote_text='' ) {
$c_bug_id = db_prepare_int( $p_bug_id );
$c_user_id = db_prepare_int( $p_user_id );
# extract current information into history variables
$h_status = bug_get_field( $p_bug_id, 'status' );
$h_handler_id = bug_get_field( $p_bug_id, 'handler_id' );
if ( ON == config_get( 'auto_set_status_to_assigned' ) ) {
$t_ass_val = ASSIGNED;
} else {
$t_ass_val = $h_status;
}
$t_bug_table = config_get( 'mantis_bug_table' );
if ( ( $t_ass_val != $h_status ) || ( $p_user_id != $h_handler_id ) ) {
# get user id
$query = "UPDATE $t_bug_table
SET handler_id='$c_user_id', status='$t_ass_val'
WHERE id='$c_bug_id'";
db_query( $query );
# log changes
history_log_event_direct( $c_bug_id, 'status', $h_status, $t_ass_val );
history_log_event_direct( $c_bug_id, 'handler_id', $h_handler_id, $p_user_id );
# Add bugnote if supplied
if ( $p_bugnote_text != '' ) {
bugnote_add( $p_bug_id, $p_bugnote_text );
}
# updated the last_updated date
bug_update_date( $p_bug_id );
bug_clear_cache( $p_bug_id );
# send assigned to email
email_assign( $p_bug_id );
}
return true;
}
# --------------------
# close the given bug
function bug_close( $p_bug_id, $p_bugnote_text='' ) {
$p_bugnote_text = trim( $p_bugnote_text );
bug_set_field( $p_bug_id, 'status', CLOSED );
# Add bugnote if supplied
if ( $p_bugnote_text != '' ) {
bugnote_add( $p_bug_id, $p_bugnote_text );
}
email_close( $p_bug_id );
return true;
}
# --------------------
# resolve the given bug
function bug_resolve( $p_bug_id, $p_resolution, $p_bugnote_text = '', $p_duplicate_id = null, $p_handler_id = null ) {
$p_bugnote_text = trim( $p_bugnote_text );
bug_set_field( $p_bug_id, 'status', RESOLVED );
bug_set_field( $p_bug_id, 'resolution', (int)$p_resolution );
if ( null !== $p_duplicate_id ) {
bug_set_field( $p_bug_id, 'duplicate_id', (int)$p_duplicate_id );
}
if ( null == $p_handler_id ) {
$p_handler_id = auth_get_current_user_id();
}
bug_set_field( $p_bug_id, 'handler_id', $p_handler_id );
# Add bugnote if supplied
if ( '' != $p_bugnote_text ) {
bugnote_add( $p_bug_id, $p_bugnote_text );
}
email_resolved( $p_bug_id );
return true;
}
# --------------------
# reopen the given bug
function bug_reopen( $p_bug_id, $p_bugnote_text='' ) {
$p_bugnote_text = trim( $p_bugnote_text );
bug_set_field( $p_bug_id, 'status', FEEDBACK );
bug_set_field( $p_bug_id, 'resolution', REOPENED );
# Add bugnote if supplied
if ( '' != $p_bugnote_text ) {
bugnote_add( $p_bug_id, $p_bugnote_text );
}
email_reopen( $p_bug_id );
return true;
}
# --------------------
# updates the last_updated field
function bug_update_date( $p_bug_id ) {
$c_bug_id = db_prepare_int( $p_bug_id );
$t_bug_table = config_get( 'mantis_bug_table' );
$query = "UPDATE $t_bug_table
SET last_updated=NOW()
WHERE id='$c_bug_id'";
db_query( $query );
bug_clear_cache( $p_bug_id );
return true;
}
# --------------------
# enable monitoring of this bug for the user
function bug_monitor( $p_bug_id, $p_user_id ) {
$c_bug_id = db_prepare_int( $p_bug_id );
$c_user_id = db_prepare_int( $p_user_id );
# Make sure we aren't already monitoring this bug
if ( user_is_monitoring_bug( $p_user_id, $p_bug_id ) ) {
return true;
}
$t_bug_monitor_table = config_get( 'mantis_bug_monitor_table' );
# Insert monitoring record
$query ="INSERT ".
"INTO $t_bug_monitor_table ".
"( user_id, bug_id ) ".
"VALUES ".
"( '$c_user_id', '$c_bug_id' )";
db_query( $query );
# log new monitoring action
history_log_event_special( $p_bug_id, BUG_MONITOR, $c_user_id );
return true;
}
# --------------------
# dsable monitoring of this bug for the user
function bug_unmonitor( $p_bug_id, $p_user_id ) {
$c_bug_id = db_prepare_int( $p_bug_id );
$c_user_id = db_prepare_int( $p_user_id );
$t_bug_monitor_table = config_get( 'mantis_bug_monitor_table' );
# Delete monitoring record
$query ="DELETE ".
"FROM $t_bug_monitor_table ".
"WHERE user_id = '$c_user_id' AND bug_id = '$c_bug_id'";
db_query( $query );
# log new un-monitor action
history_log_event_special( $p_bug_id, BUG_UNMONITOR, $p_user_id );
return true;
}
#===================================
# Other
#===================================
# --------------------
# Pads the bug id with the appropriate number of zeros.
function bug_format_id( $p_bug_id ) {
return( str_pad( $p_bug_id, 7, '0', STR_PAD_LEFT ) );
}
# --------------------
# Return a copy of the bug structure with all the instvars prepared for db insertion
function bug_prepare_db( $p_bug_data ) {
$p_bug_data->project_id = db_prepare_int( $p_bug_data->project_id );
$p_bug_data->reporter_id = db_prepare_int( $p_bug_data->reporter_id );
$p_bug_data->handler_id = db_prepare_int( $p_bug_data->handler_id );
$p_bug_data->duplicate_id = db_prepare_int( $p_bug_data->duplicate_id );
$p_bug_data->priority = db_prepare_int( $p_bug_data->priority );
$p_bug_data->severity = db_prepare_int( $p_bug_data->severity );
$p_bug_data->reproducibility = db_prepare_int( $p_bug_data->reproducibility );
$p_bug_data->status = db_prepare_int( $p_bug_data->status );
$p_bug_data->resolution = db_prepare_int( $p_bug_data->resolution );
$p_bug_data->projection = db_prepare_int( $p_bug_data->projection );
$p_bug_data->category = db_prepare_string( $p_bug_data->category );
$p_bug_data->date_submitted = db_prepare_string( $p_bug_data->date_submitted );
$p_bug_data->last_updated = db_prepare_string( $p_bug_data->last_updated );
$p_bug_data->eta = db_prepare_int( $p_bug_data->eta );
$p_bug_data->os = db_prepare_string( $p_bug_data->os );
$p_bug_data->os_build = db_prepare_string( $p_bug_data->os_build );
$p_bug_data->platform = db_prepare_string( $p_bug_data->platform );
$p_bug_data->version = db_prepare_string( $p_bug_data->version );
$p_bug_data->build = db_prepare_string( $p_bug_data->build );
$p_bug_data->votes = db_prepare_int( $p_bug_data->votes );
$p_bug_data->view_state = db_prepare_int( $p_bug_data->view_state );
$p_bug_data->summary = db_prepare_string( $p_bug_data->summary );
$p_bug_data->description = db_prepare_string( $p_bug_data->description );
$p_bug_data->steps_to_reproduce = db_prepare_string( $p_bug_data->steps_to_reproduce );
$p_bug_data->additional_information = db_prepare_string( $p_bug_data->additional_information );
return $p_bug_data;
}
# --------------------
# Return a copy of the bug structure with all the instvars prepared for editing
# in an HTML form
function bug_prepare_edit( $p_bug_data ) {
$p_bug_data->category = string_attribute( $p_bug_data->category );
$p_bug_data->date_submitted = string_attribute( $p_bug_data->date_submitted );
$p_bug_data->last_updated = string_attribute( $p_bug_data->last_updated );
$p_bug_data->os = string_attribute( $p_bug_data->os );
$p_bug_data->os_build = string_attribute( $p_bug_data->os_build );
$p_bug_data->platform = string_attribute( $p_bug_data->platform );
$p_bug_data->version = string_attribute( $p_bug_data->version );
$p_bug_data->build = string_attribute( $p_bug_data->build );
$p_bug_data->summary = string_attribute( $p_bug_data->summary );
$p_bug_data->description = string_textarea( $p_bug_data->description );
$p_bug_data->steps_to_reproduce = string_textarea( $p_bug_data->steps_to_reproduce );
$p_bug_data->additional_information = string_textarea( $p_bug_data->additional_information );
return $p_bug_data;
}
# --------------------
# Return a copy of the bug structure with all the instvars prepared for editing
# in an HTML form
function bug_prepare_display( $p_bug_data ) {
$p_bug_data->category = string_display( $p_bug_data->category );