/
email_api.php
1257 lines (1008 loc) · 46.1 KB
/
email_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/>.
/**
* @package CoreAPI
* @subpackage EmailAPI
* @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
*/
$t_core_dir = dirname( __FILE__ ) . DIRECTORY_SEPARATOR;
define( 'PHPMAILER_PATH', BASE_PATH . '/library/phpmailer/' );
require_once('phpmailer/class.phpmailer.php');
/**
* requires current_user_api
*/
require_once( $t_core_dir . 'current_user_api.php' );
/**
* requires bug_api
*/
require_once( $t_core_dir . 'bug_api.php' );
/**
* requires custom_field_api
*/
require_once( $t_core_dir . 'custom_field_api.php' );
/**
* requires string_api
*/
require_once( $t_core_dir . 'string_api.php' );
/**
* requires history_api
*/
require_once( $t_core_dir . 'history_api.php' );
/**
* requires email_queue_api
*/
require_once( $t_core_dir . 'email_queue_api.php' );
/**
* requires relationship_api
*/
require_once( $t_core_dir . 'relationship_api.php' );
# reusable object of class SMTP
$g_phpMailer = null;
# ##########################################################################
# Email API
# ##########################################################################
# Use a simple perl regex for valid email addresses. This is not a complete regex,
# as it does not cover quoted addresses or domain literals, but it is simple and
# covers the vast majority of all email addresses without being overly complex.
# Callers must surround this with appropriate delimiters with case insentive options.
function email_regex_simple() {
return "(([a-z0-9!#*+\/=?^_{|}~-]+(?:\.[a-z0-9!#*+\/=?^_{|}~-]+)*)" . # recipient
"\@((?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?))"; # @domain
}
# --------------------
# Return a perl compatible regular expression that will
# match a valid email address as per RFC 822 (approximately)
#
# The regex will provide too matched groups: the first will be the
# local part (or mailbox name) and the second will be the domain
function email_get_rfc822_regex() {
# Build up basic RFC 822 BNF definitions.
# list of the special characters: () < > @ , ; : \ " . [ ]
$t_specials = '\(\)\<\>\@\,\;\:\\\"\.\[\]';
# the space character
$t_space = '\040';
# valid characters in a quoted string
$t_char = '\000-\177';
# control characters
$t_ctl = '\000-\037\177';
# a chunk of quoted text (anything except " \ \r are valid)
$t_qtext_re = '[^"\\\r]+';
# match any valid character preceded by a backslash ( mostly for \" )
$t_qpair_re = "\\\\[$t_char]";
# a complete quoted string - " characters with valid characters or
# backslash-escaped characters between them
$t_quoted_string_re = "(?:\"(?:$t_qtext_re|$t_qpair_re)*\")";
# an unquoted atom (anything that isn't a control char, a space, or a
# special char)
$t_atom_re = "(?:[^$t_ctl$t_space$t_specials]+)";
# a domain ref is an atom
$t_domain_ref_re = $t_atom_re;
# the characters in a domain literal can be anything except: [ ] \ \r
$t_dtext_re = "[^\\[\\]\\\\\\r]";
# a domain-literal is a sequence of characters or escaped pairs inside
# square brackets
$t_domain_literal_re = "\\[(?:$t_dtext_re|$t_qpair_re)*\\]";
# a subdomain is a domain ref or a domain literal
$t_sub_domain_re = "(?:$t_domain_ref_re|$t_domain_literal_re)";
# a domain is at least one subdomain, with optional further subdomains
# separated by periods. eg: '[1.2.3.4]' or 'foo.bar'
$t_domain_re = "$t_sub_domain_re(?:\.$t_sub_domain_re)*";
# a word is either quoted string or an atom
$t_word_re = "(?:$t_atom_re|$t_quoted_string_re)";
# the local part of the address spec (the mailbox name)
# is one or more words separated by periods
$t_local_part_re = "$t_word_re(?:\.$t_word_re)*";
# the address spec is made up of a local part, and @ symbol,
# and a domain
$t_addr_spec_re = "/^($t_local_part_re)\@($t_domain_re)$/";
return $t_addr_spec_re;
}
# --------------------
# check to see that the format is valid and that the mx record exists
function email_is_valid( $p_email ) {
# if we don't validate then just accept
if( OFF == config_get( 'validate_email' ) ) {
return true;
}
if( is_blank( $p_email ) && ON == config_get( 'allow_blank_email' ) ) {
return true;
}
# Use a regular expression to check to see if the email is in valid format
# x-xx.xxx@yyy.zzz.abc etc.
if( preg_match( email_get_rfc822_regex(), $p_email, $t_check ) ) {
$t_local = $t_check[1];
$t_domain = $t_check[2];
# see if we're limited to one domain
$t_limit_email_domain = config_get( 'limit_email_domain' );
if( $t_limit_email_domain !== OFF ) {
if( 0 != strcasecmp( $t_limit_email_domain, $t_domain ) ) {
return false;
}
}
if( preg_match( '/\\[(\d+)\.(\d+)\.(\d+)\.(\d+)\\]/', $t_domain, $t_check ) ) {
# Handle domain-literals of the form '[1.2.3.4]'
# as long as each segment is less than 255, we're ok
if( $t_check[1] <= 255 && $t_check[2] <= 255 && $t_check[3] <= 255 && $t_check[4] <= 255 ) {
return true;
}
}
else if( ON == config_get( 'check_mx_record' ) ) {
$temp = '';
# Check for valid mx records
if( getmxrr( $t_domain, $temp ) ) {
return true;
} else {
$host = $t_domain . '.';
# for no mx record... try dns check
if( checkdnsrr( $host, 'ANY' ) ) {
return true;
}
}
} else {
# Email format was valid but did't check for valid mx records
return true;
}
}
# Everything failed. The email is invalid
return false;
}
# Check if the email address is valid
# return true if it is, trigger an ERROR if it isn't
function email_ensure_valid( $p_email ) {
if( !email_is_valid( $p_email ) ) {
trigger_error( ERROR_EMAIL_INVALID, ERROR );
}
}
# Check if the email address is disposable
function email_is_disposable( $p_email ) {
return DisposableEmailChecker::is_disposable_email( $p_email );
}
# Check if the email address is disposable
function email_ensure_not_disposable( $p_email ) {
if( email_is_disposable( $p_email ) ) {
trigger_error( ERROR_EMAIL_DISPOSABLE, ERROR );
}
}
# email_notify_flag
# Get the value associated with the specific action and flag.
# For example, you can get the value associated with notifying "admin"
# on action "new", i.e. notify administrators on new bugs which can be
# ON or OFF.
function email_notify_flag( $action, $flag ) {
$t_notify_flags = config_get( 'notify_flags' );
$t_default_notify_flags = config_get( 'default_notify_flags' );
if( isset( $t_notify_flags[$action][$flag] ) ) {
return $t_notify_flags[$action][$flag];
}
else if( isset( $t_default_notify_flags[$flag] ) ) {
return $t_default_notify_flags[$flag];
}
return OFF;
}
# @todo yarick123: email_collect_recipients(...) will be completely rewritten to provide additional information such as language, user access,..
# @todo yarick123:sort recipients list by language to reduce switches between different languages
function email_collect_recipients( $p_bug_id, $p_notify_type, $p_extra_user_ids_to_email = array() ) {
$c_bug_id = db_prepare_int( $p_bug_id );
$t_recipients = array();
# add explicitly specified users
if ( ON == email_notify_flag( $p_notify_type, 'explicit' ) ) {
foreach ( $p_extra_user_ids_to_email as $t_user_id ) {
$t_recipients[$t_user_id] = true;
log_event( LOG_EMAIL_RECIPIENT, sprintf( 'Issue = #%d, add explicitly specified user = @U%d', $p_bug_id, $t_user_id ) );
}
}
# add Reporter
if( ON == email_notify_flag( $p_notify_type, 'reporter' ) ) {
$t_reporter_id = bug_get_field( $p_bug_id, 'reporter_id' );
$t_recipients[$t_reporter_id] = true;
log_event( LOG_EMAIL_RECIPIENT, sprintf( 'Issue = #%d, add Reporter = @U%d', $p_bug_id, $t_reporter_id ) );
}
# add Handler
if( ON == email_notify_flag( $p_notify_type, 'handler' ) ) {
$t_handler_id = bug_get_field( $p_bug_id, 'handler_id' );
if( $t_handler_id > 0 ) {
$t_recipients[$t_handler_id] = true;
log_event( LOG_EMAIL_RECIPIENT, sprintf( 'Issue = #%d, add Handler = @U%d', $p_bug_id, $t_handler_id ) );
}
}
$t_project_id = bug_get_field( $p_bug_id, 'project_id' );
# add users monitoring the bug
$t_bug_monitor_table = db_get_table( 'mantis_bug_monitor_table' );
if( ON == email_notify_flag( $p_notify_type, 'monitor' ) ) {
$query = "SELECT DISTINCT user_id
FROM $t_bug_monitor_table
WHERE bug_id=" . db_param();
$result = db_query_bound( $query, Array( $c_bug_id ) );
$count = db_num_rows( $result );
for( $i = 0;$i < $count;$i++ ) {
$t_user_id = db_result( $result, $i );
$t_recipients[$t_user_id] = true;
log_event( LOG_EMAIL_RECIPIENT, sprintf( 'Issue = #%d, add Monitor = @U%d', $p_bug_id, $t_user_id ) );
}
}
# add users who contributed bugnotes
$t_bugnote_id = bugnote_get_latest_id( $p_bug_id );
$t_bugnote_view = bugnote_get_field( $t_bugnote_id, 'view_state' );
$t_bugnote_date = db_unixtimestamp( bugnote_get_field( $t_bugnote_id, 'last_modified' ) );
$t_bug_date = bug_get_field( $p_bug_id, 'last_updated' );
$t_bugnote_table = db_get_table( 'mantis_bugnote_table' );
if( ON == email_notify_flag( $p_notify_type, 'bugnotes' ) ) {
$query = "SELECT DISTINCT reporter_id
FROM $t_bugnote_table
WHERE bug_id = " . db_param();
$result = db_query_bound( $query, Array( $c_bug_id ) );
$count = db_num_rows( $result );
for( $i = 0;$i < $count;$i++ ) {
$t_user_id = db_result( $result, $i );
$t_recipients[$t_user_id] = true;
log_event( LOG_EMAIL_RECIPIENT, sprintf( 'Issue = #%d, add Note Author = @U%d', $p_bug_id, $t_user_id ) );
}
}
# add project users who meet the thresholds
$t_bug_is_private = bug_get_field( $p_bug_id, 'view_state' ) == VS_PRIVATE;
$t_threshold_min = email_notify_flag( $p_notify_type, 'threshold_min' );
$t_threshold_max = email_notify_flag( $p_notify_type, 'threshold_max' );
$t_threshold_users = project_get_all_user_rows( $t_project_id, $t_threshold_min );
foreach( $t_threshold_users as $t_user ) {
if( $t_user['access_level'] <= $t_threshold_max ) {
if( !$t_bug_is_private || access_compare_level( $t_user['access_level'], config_get( 'private_bug_threshold' ) ) ) {
$t_recipients[$t_user['id']] = true;
log_event( LOG_EMAIL_RECIPIENT, sprintf( 'Issue = #%d, add Project User = @U%d', $p_bug_id, $t_user['id'] ) );
}
}
}
# set up to eliminate unwanted users
# get list of status values that are not covered specifically in the prefs
# These are handled by email_on_status generically
# @@@ thraxisp note that email_on_assigned was co-opted to handle change in handler
$t_status_change = MantisEnum::getAssocArrayIndexedByValues( config_get( 'status_enum_string' ) );
unset( $t_status_change[NEW_] );
unset( $t_status_change[FEEDBACK] );
unset( $t_status_change[RESOLVED] );
unset( $t_status_change[CLOSED] );
if( 'owner' == $p_notify_type ) {
$t_pref_field = 'email_on_assigned';
}
else if( in_array( $p_notify_type, $t_status_change ) ) {
$t_pref_field = 'email_on_status';
} else {
$t_pref_field = 'email_on_' . $p_notify_type;
}
$t_user_pref_table = db_get_table( 'mantis_user_pref_table' );
if( !db_field_exists( $t_pref_field, $t_user_pref_table ) ) {
$t_pref_field = false;
}
# @@@ we could optimize by modifiying user_cache() to take an array
# of user ids so we could pull them all in. We'll see if it's necessary
$t_final_recipients = array();
# Check whether users should receive the emails
# and put email address to $t_recipients[user_id]
foreach( $t_recipients as $t_id => $t_ignore ) {
# Possibly eliminate the current user
if(( auth_get_current_user_id() == $t_id ) && ( OFF == config_get( 'email_receive_own' ) ) ) {
log_event( LOG_EMAIL_RECIPIENT, sprintf( 'Issue = #%d, drop @U%d (own)', $p_bug_id, $t_id ) );
continue;
}
# Eliminate users who don't exist anymore or who are disabled
if( !user_exists( $t_id ) || !user_is_enabled( $t_id ) ) {
log_event( LOG_EMAIL_RECIPIENT, sprintf( 'Issue = #%d, drop @U%d (disabled)', $p_bug_id, $t_id ) );
continue;
}
# Exclude users who have this notification type turned off
if( $t_pref_field ) {
$t_notify = user_pref_get_pref( $t_id, $t_pref_field );
if( OFF == $t_notify ) {
log_event( LOG_EMAIL_RECIPIENT, sprintf( 'Issue = #%d, drop @U%d (pref %s off)', $p_bug_id, $t_id, $t_pref_field ) );
continue;
} else {
# Users can define the severity of an issue before they are emailed for
# each type of notification
$t_min_sev_pref_field = $t_pref_field . '_min_severity';
$t_min_sev_notify = user_pref_get_pref( $t_id, $t_min_sev_pref_field );
$t_bug_severity = bug_get_field( $p_bug_id, 'severity' );
if( $t_bug_severity < $t_min_sev_notify ) {
log_event( LOG_EMAIL_RECIPIENT, sprintf( 'Issue = #%d, drop @U%d (pref threshold)', $p_bug_id, $t_id ) );
continue;
}
}
}
# check that user can see bugnotes if the last update included a bugnote
if( $t_bug_date == $t_bugnote_date ) {
if( !access_has_bugnote_level( VIEWER, $t_bugnote_id, $t_id ) ) {
log_event( LOG_EMAIL_RECIPIENT, sprintf( 'Issue = #%d, drop @U%d (access level)', $p_bug_id, $t_id ) );
continue;
}
}
# Finally, let's get their emails, if they've set one
$t_email = user_get_email( $t_id );
if( is_blank( $t_email ) ) {
log_event( LOG_EMAIL_RECIPIENT, sprintf( 'Issue = #%d, drop @U%d (no email)', $p_bug_id, $t_id ) );
} else {
# @@@ we could check the emails for validity again but I think
# it would be too slow
$t_final_recipients[$t_id] = $t_email;
}
}
return $t_final_recipients;
}
# Send password to user
function email_signup( $p_user_id, $p_password, $p_confirm_hash ) {
if(( OFF == config_get( 'send_reset_password' ) ) || ( OFF == config_get( 'enable_email_notification' ) ) ) {
return;
}
# @@@ thraxisp - removed to address #6084 - user won't have any settings yet,
# use same language as display for the email
# lang_push( user_pref_get_language( $p_user_id ) );
# retrieve the username and email
$t_username = user_get_field( $p_user_id, 'username' );
$t_email = user_get_email( $p_user_id );
# Build Welcome Message
$t_subject = '[' . config_get( 'window_title' ) . '] ' . lang_get( 'new_account_subject' );
$t_message = sprintf( lang_get( 'new_account_greeting' ), $t_username ) . " \n\n" . string_get_confirm_hash_url( $p_user_id, $p_confirm_hash ) . " \n\n" . lang_get( 'new_account_message' ) . " \n\n" . lang_get( 'new_account_do_not_reply' );
# Send signup email regardless of mail notification pref
# or else users won't be able to sign up
if( !is_blank( $t_email ) ) {
email_store( $t_email, $t_subject, $t_message );
log_event( LOG_EMAIL, sprintf( 'Signup Email = %s, Hash = %s, User = @U%d', $t_email, $p_confirm_hash, $p_user_id ) );
if( OFF == config_get( 'email_send_using_cronjob' ) ) {
email_send_all();
}
}
# lang_pop(); # see above
}
# Send confirm_hash url to user forgets the password
function email_send_confirm_hash_url( $p_user_id, $p_confirm_hash ) {
if(( OFF == config_get( 'send_reset_password' ) ) || ( OFF == config_get( 'enable_email_notification' ) ) ) {
return;
}
lang_push( user_pref_get_language( $p_user_id ) );
# retrieve the username and email
$t_username = user_get_field( $p_user_id, 'username' );
$t_email = user_get_email( $p_user_id );
$t_subject = '[' . config_get( 'window_title' ) . '] ' . lang_get( 'lost_password_subject' );
$t_message = lang_get( 'reset_request_msg' ) . " \n\n" . string_get_confirm_hash_url( $p_user_id, $p_confirm_hash ) . " \n\n" . lang_get( 'new_account_username' ) . lang_get( 'word_separator' ) . $t_username . " \n" . lang_get( 'new_account_IP' ) . lang_get( 'word_separator' ) . $_SERVER["REMOTE_ADDR"] . " \n\n" . lang_get( 'new_account_do_not_reply' );
# Send password reset regardless of mail notification prefs
# or else users won't be able to receive their reset pws
if( !is_blank( $t_email ) ) {
email_store( $t_email, $t_subject, $t_message );
log_event( LOG_EMAIL, sprintf( 'Password reset for email = %s', $t_email ) );
if( OFF == config_get( 'email_send_using_cronjob' ) ) {
email_send_all();
}
}
lang_pop();
}
# notify the selected group a new user has signup
function email_notify_new_account( $p_username, $p_email ) {
global $g_path;
$t_threshold_min = config_get( 'notify_new_user_created_threshold_min' );
$t_threshold_users = project_get_all_user_rows( ALL_PROJECTS, $t_threshold_min );
foreach( $t_threshold_users as $t_user ) {
lang_push( user_pref_get_language( $t_user['id'] ) );
$t_recipient_email = user_get_email( $t_user['id'] );
$t_subject = '[' . config_get( 'window_title' ) . '] ' . lang_get( 'new_account_subject' );
$t_message = lang_get( 'new_account_signup_msg' ) . " \n\n" . lang_get( 'new_account_username' ) . lang_get( 'word_separator' ) . $p_username . " \n" . lang_get( 'new_account_email' ) . lang_get( 'word_separator' ) . $p_email . " \n" . lang_get( 'new_account_IP' ) . lang_get( 'word_separator' ) . $_SERVER["REMOTE_ADDR"] . " \n" . $g_path . "\n\n" . lang_get( 'new_account_do_not_reply' );
if( !is_blank( $t_recipient_email ) ) {
email_store( $t_recipient_email, $t_subject, $t_message );
log_event( LOG_EMAIL, sprintf( 'New Account Notify for email = \'%s\'', $t_recipient_email ) );
if( OFF == config_get( 'email_send_using_cronjob' ) ) {
email_send_all();
}
}
lang_pop();
}
}
# send a generic email
# $p_notify_type: use check who she get notified of such event.
# $p_message_id: message id to be translated and included at the top of the email message.
# Return false if it were problems sending email
function email_generic( $p_bug_id, $p_notify_type, $p_message_id = null, $p_header_optional_params = null, $p_extra_user_ids_to_email = array() ) {
$t_ok = true;
if( ON === config_get( 'enable_email_notification' ) ) {
ignore_user_abort( true );
# @todo yarick123: email_collect_recipients(...) will be completely rewritten to provide additional information such as language, user access,..
# @todo yarick123:sort recipients list by language to reduce switches between different languages
$t_recipients = email_collect_recipients( $p_bug_id, $p_notify_type, $p_extra_user_ids_to_email );
$t_project_id = bug_get_field( $p_bug_id, 'project_id' );
if( is_array( $t_recipients ) ) {
# send email to every recipient
foreach( $t_recipients as $t_user_id => $t_user_email ) {
log_event( LOG_EMAIL, sprintf( "Issue = #%d, Type = %s, Msg = '%s', User = @U%d, Email = '%s'.", $p_bug_id, $p_notify_type, $p_message_id, $t_user_id, $t_user_email ) );
# load (push) user language here as build_visible_bug_data assumes current language
lang_push( user_pref_get_language( $t_user_id, $t_project_id ) );
$t_visible_bug_data = email_build_visible_bug_data( $t_user_id, $p_bug_id, $p_message_id );
$t_ok = email_bug_info_to_one_user( $t_visible_bug_data, $p_message_id, $t_project_id, $t_user_id, $p_header_optional_params ) && $t_ok;
lang_pop();
}
}
# Only trigger the draining of the email queue if cronjob is disabled and email notifications are enabled.
if( OFF == config_get( 'email_send_using_cronjob' ) ) {
email_send_all();
}
}
return $t_ok;
}
# Send notices that a user is now monitoring the bug. Typically this will only be sent when the added
# user is not the logged in user. This is assuming that receive own notifications is OFF (default).
function email_monitor_added( $p_bug_id, $p_user_id ) {
log_event( LOG_EMAIL, sprintf( 'Issue #%d monitored by user @U%d', $p_bug_id, $p_user_id ) );
$t_opt = array();
$t_opt[] = bug_format_id( $p_bug_id );
$t_opt[] = user_get_name( $p_user_id );
email_generic( $p_bug_id, 'monitor', 'email_notification_title_for_action_monitor', $t_opt, array( $p_user_id ) );
}
# send notices when a relationship is ADDED
# MASC RELATIONSHIP
function email_relationship_added( $p_bug_id, $p_related_bug_id, $p_rel_type ) {
log_event( LOG_EMAIL, sprintf( 'Relationship added: Issue #%d, related issue %d, relationship type %s.', $p_bug_id, $p_related_bug_id, $p_rel_type ) );
$t_opt = array();
$t_opt[] = bug_format_id( $p_related_bug_id );
global $g_relationships;
if( !isset( $g_relationships[$p_rel_type] ) ) {
trigger_error( ERROR_RELATIONSHIP_NOT_FOUND, ERROR );
}
email_generic( $p_bug_id, 'relation', $g_relationships[$p_rel_type]['#notify_added'], $t_opt );
}
# send notices when a relationship is DELETED
# MASC RELATIONSHIP
function email_relationship_deleted( $p_bug_id, $p_related_bug_id, $p_rel_type ) {
log_event( LOG_EMAIL, sprintf( 'Relationship deleted: Issue #%d, related issue %d, relationship type %s.', $p_bug_id, $p_related_bug_id, $p_rel_type ) );
$t_opt = array();
$t_opt[] = bug_format_id( $p_related_bug_id );
global $g_relationships;
if( !isset( $g_relationships[$p_rel_type] ) ) {
trigger_error( ERROR_RELATIONSHIP_NOT_FOUND, ERROR );
}
email_generic( $p_bug_id, 'relation', $g_relationships[$p_rel_type]['#notify_deleted'], $t_opt );
}
# send notices to all the handlers of the parent bugs when a child bug is RESOLVED
# MASC RELATIONSHIP
function email_relationship_child_resolved( $p_bug_id ) {
email_relationship_child_resolved_closed( $p_bug_id, 'email_notification_title_for_action_relationship_child_resolved' );
}
# send notices to all the handlers of the parent bugs when a child bug is CLOSED
# MASC RELATIONSHIP
function email_relationship_child_closed( $p_bug_id ) {
email_relationship_child_resolved_closed( $p_bug_id, 'email_notification_title_for_action_relationship_child_closed' );
}
# send notices to all the handlers of the parent bugs still open when a child bug is resolved/closed
# MASC RELATIONSHIP
function email_relationship_child_resolved_closed( $p_bug_id, $p_message_id ) {
# retrieve all the relationships in which the bug is the destination bug
$t_relationship = relationship_get_all_dest( $p_bug_id );
$t_relationship_count = count( $t_relationship );
if( $t_relationship_count == 0 ) {
# no parent bug found
return;
}
for( $i = 0;$i < $t_relationship_count;$i++ ) {
if( $t_relationship[$i]->type == BUG_DEPENDANT ) {
$t_src_bug_id = $t_relationship[$i]->src_bug_id;
$t_status = bug_get_field( $t_src_bug_id, 'status' );
if( $t_status < config_get( 'bug_resolved_status_threshold' ) ) {
# sent the notification just for parent bugs not resolved/closed
$t_opt = array();
$t_opt[] = bug_format_id( $p_bug_id );
email_generic( $t_src_bug_id, 'handler', $p_message_id, $t_opt );
}
}
}
}
# send notices when a bug is sponsored
function email_sponsorship_added( $p_bug_id ) {
email_generic( $p_bug_id, 'sponsor', 'email_notification_title_for_action_sponsorship_added' );
}
# send notices when a sponsorship is modified
function email_sponsorship_updated( $p_bug_id ) {
email_generic( $p_bug_id, 'sponsor', 'email_notification_title_for_action_sponsorship_updated' );
}
# send notices when a sponsorship is deleted
function email_sponsorship_deleted( $p_bug_id ) {
email_generic( $p_bug_id, 'sponsor', 'email_notification_title_for_action_sponsorship_deleted' );
}
# send notices when a new bug is added
function email_new_bug( $p_bug_id ) {
email_generic( $p_bug_id, 'new', 'email_notification_title_for_action_bug_submitted' );
}
# send notices when a new bugnote
function email_bugnote_add( $p_bug_id ) {
email_generic( $p_bug_id, 'bugnote', 'email_notification_title_for_action_bugnote_submitted' );
}
# send notices when a bug is RESOLVED
function email_resolved( $p_bug_id ) {
email_generic( $p_bug_id, 'resolved', 'email_notification_title_for_status_bug_resolved' );
}
# send notices when a bug is CLOSED
function email_close( $p_bug_id ) {
email_generic( $p_bug_id, 'closed', 'email_notification_title_for_status_bug_closed' );
}
# send notices when a bug is REOPENED
function email_reopen( $p_bug_id ) {
email_generic( $p_bug_id, 'reopened', 'email_notification_title_for_action_bug_reopened' );
}
# send notices when a bug is ASSIGNED
function email_assign( $p_bug_id ) {
email_generic( $p_bug_id, 'owner', 'email_notification_title_for_action_bug_assigned' );
}
# send notices when a bug is DELETED
function email_bug_deleted( $p_bug_id ) {
email_generic( $p_bug_id, 'deleted', 'email_notification_title_for_action_bug_deleted' );
}
function email_store( $p_recipient, $p_subject, $p_message, $p_headers = null ) {
$t_recipient = trim( $p_recipient );
$t_subject = string_email( trim( $p_subject ) );
$t_message = string_email_links( trim( $p_message ) );
# short-circuit if no recipient is defined, or email disabled
# note that this may cause signup messages not to be sent
if( is_blank( $p_recipient ) || ( OFF == config_get( 'enable_email_notification' ) ) ) {
return;
}
$t_email_data = new EmailData;
$t_email_data->email = $t_recipient;
$t_email_data->subject = $t_subject;
$t_email_data->body = $t_message;
$t_email_data->metadata = array();
$t_email_data->metadata['headers'] = $p_headers === null ? array() : $p_headers;
$t_email_data->metadata['priority'] = config_get( 'mail_priority' );
# Urgent = 1, Not Urgent = 5, Disable = 0
$t_email_data->metadata['charset'] = 'utf-8';
$t_hostname = '';
$t_server = isset( $_SERVER ) ? $_SERVER : $HTTP_SERVER_VARS;
if( isset( $t_server['SERVER_NAME'] ) ) {
$t_hostname = $t_server['SERVER_NAME'];
} else {
$t_address = explode( '@', config_get( 'from_email' ) );
if( isset( $t_address[1] ) ) {
$t_hostname = $t_address[1];
}
}
$t_email_data->metadata['hostname'] = $t_hostname;
$t_email_id = email_queue_add( $t_email_data );
return $t_email_id;
}
# This function sends all the emails that are stored in the queue. If a failure occurs, then the
# function exists. This function will be called after storing emails in case of synchronous
# emails, or will be called from a cronjob in case of asynchronous emails.
# @todo In case of synchronous email sending, we may get a race condition where two requests send the same email.
function email_send_all() {
$t_ids = email_queue_get_ids();
$t_emails_recipients_failed = array();
$t_start = microtime(true);
foreach( $t_ids as $t_id ) {
$t_email_data = email_queue_get( $t_id );
# check if email was not found. This can happen if another request picks up the email first and sends it.
if( $t_email_data === false ) {
continue;
}
# if unable to place the email in the email server queue, then the connection to the server is down,
# and hence no point to continue trying with the rest of the emails.
if( !email_send( $t_email_data ) ) {
if( microtime(true) - $t_start > 5 ) {
break;
} else {
continue;
}
}
}
}
# This function sends an email message based on the supplied email data.
function email_send( $p_email_data ) {
global $g_phpMailer;
$t_email_data = $p_email_data;
$t_recipient = trim( $t_email_data->email );
$t_subject = string_email( trim( $t_email_data->subject ) );
$t_message = string_email_links( trim( $t_email_data->body ) );
$t_debug_email = config_get( 'debug_email' );
$t_mailer_method = config_get( 'phpMailer_method' );
# Visit http://phpmailer.sourceforge.net
# if you have problems with phpMailer
if( is_null( $g_phpMailer ) ) {
if ( $t_mailer_method == PHPMAILER_METHOD_SMTP )
register_shutdown_function( 'email_smtp_close' );
$mail = new PHPMailer;
$mail->PluginDir = PHPMAILER_PATH;
} else {
$mail = $g_phpMailer;
}
if( isset( $t_email_data->metadata['hostname'] ) ) {
$mail->Hostname = $t_email_data->metadata['hostname'];
}
# @@@ should this be the current language (for the recipient) or the default one (for the user running the command) (thraxisp)
$t_lang = config_get( 'default_language' );
if( 'auto' == $t_lang ) {
$t_lang = config_get( 'fallback_language' );
}
$mail->SetLanguage( lang_get( 'phpmailer_language', $t_lang ), PHPMAILER_PATH . 'language' . DIRECTORY_SEPARATOR );
# Select the method to send mail
switch( config_get( 'phpMailer_method' ) ) {
case PHPMAILER_METHOD_MAIL:
$mail->IsMail();
break;
case PHPMAILER_METHOD_SENDMAIL:
$mail->IsSendmail();
break;
case PHPMAILER_METHOD_SMTP:
$mail->IsSMTP();
// SMTP collection is always kept alive
$mail->SMTPKeepAlive = true;
if ( !is_blank( config_get( 'smtp_username' ) ) ) {
# Use SMTP Authentication
$mail->SMTPAuth = true;
$mail->Username = config_get( 'smtp_username' );
$mail->Password = config_get( 'smtp_password' );
}
if ( !is_blank( config_get( 'smtp_connection_mode' ) ) ) {
$mail->SMTPSecure = config_get( 'smtp_connection_mode' );
}
$mail->Port = config_get( 'smtp_port' );
break;
}
$mail->IsHTML( false ); # set email format to plain text
$mail->WordWrap = 80; # set word wrap to 50 characters
$mail->Priority = $t_email_data->metadata['priority']; # Urgent = 1, Not Urgent = 5, Disable = 0
$mail->CharSet = $t_email_data->metadata['charset'];
$mail->Host = config_get( 'smtp_host' );
$mail->From = config_get( 'from_email' );
$mail->Sender = config_get( 'return_path_email' );
$mail->FromName = config_get( 'from_name' );
if( OFF !== $t_debug_email ) {
$t_message = 'To: ' . $t_recipient . "\n\n" . $t_message;
$mail->AddAddress( $t_debug_email, '' );
} else {
$mail->AddAddress( $t_recipient, '' );
}
$mail->Subject = $t_subject;
$mail->Body = make_lf_crlf( "\n" . $t_message );
if( isset( $t_email_data->metadata['headers'] ) && is_array( $t_email_data->metadata['headers'] ) ) {
foreach( $t_email_data->metadata['headers'] as $t_key => $t_value ) {
switch( $t_key ) {
case 'Message-ID':
/* Note: hostname can never be blank here as we set metadata['hostname']
in email_store() where mail gets queued. */
if ( !strchr( $t_value, '@' ) && !is_blank( $mail->Hostname ) ) {
$t_value = $t_value . '@' . $mail->Hostname;
}
$mail->set( 'MessageID', "<$t_value>" );
break;
case 'In-Reply-To':
$mail->AddCustomHeader( "$t_key: <{$t_value}@{$mail->Hostname}>" );
break;
default:
$mail->AddCustomHeader( "$t_key: $t_value" );
break;
}
}
}
try
{
if ( !$mail->Send() ) {
$t_success = false;
} else {
$t_success = true;
if ( $t_email_data->email_id > 0 ) {
email_queue_delete( $t_email_data->email_id );
}
}
}
catch ( phpmailerException $e )
{
$t_success = false;
}
$mail->ClearAllRecipients();
$mail->ClearAttachments();
$mail->ClearReplyTos();
$mail->ClearCustomHeaders();
return $t_success;
}
# closes opened kept alive SMTP connection (if it was opened)
function email_smtp_close() {
global $g_phpMailer;
if( !is_null( $g_phpMailer ) ) {
if( $g_phpMailer->smtp->Connected() ) {
$g_phpMailer->smtp->Quit();
$g_phpMailer->smtp->Close();
}
$g_phpMailer = null;
}
}
# formats the subject correctly
# we include the project name, bug id, and summary.
function email_build_subject( $p_bug_id ) {
# grab the project name
$p_project_name = project_get_field( bug_get_field( $p_bug_id, 'project_id' ), 'name' );
# grab the subject (summary)
$p_subject = bug_get_field( $p_bug_id, 'summary' );
# padd the bug id with zeros
$p_bug_id = bug_format_id( $p_bug_id );
return '[' . $p_project_name . ' ' . $p_bug_id . ']: ' . $p_subject;
}
# clean up LF to CRLF
function make_lf_crlf( $p_string ) {
$t_string = str_replace( "\n", "\r\n", $p_string );
return str_replace( "\r\r\n", "\r\n", $t_string );
}
# Check limit_email_domain option and append the domain name if it is set
/**
* Appends an email domain to the specified email address if email is
* not empty, it doesn't already have a domain part and if a
* limit_email_domain is configured.
*
* @param string $p_email The email address to append the domain to.
* @returns The email address with the appended domain (if applicable).
*/
function email_append_domain( $p_email ) {
# If email is empty or already contains a domain, then return as is.
if ( is_blank( $p_email ) || strchr( $p_email, '@' ) ) {
return $p_email;
}
# If limit email domain is set, then append it.
$t_limit_email_domain = config_get( 'limit_email_domain' );
if ( $t_limit_email_domain === OFF ) {
return $p_email;
}
return "$p_email@$t_limit_email_domain";
}
# Send a bug reminder to each of the given user, or to each user if the first
# parameter is an array
# return an array of usernames to which the reminder was successfully sent
#
# @@@ I'm not sure this shouldn't return an array of user ids... more work for
# the caller but cleaner from an API point of view.
function email_bug_reminder( $p_recipients, $p_bug_id, $p_message ) {
if( !is_array( $p_recipients ) ) {
$p_recipients = array(
$p_recipients,
);
}
$t_project_id = bug_get_field( $p_bug_id, 'project_id' );
$t_sender_id = auth_get_current_user_id();
$t_sender = user_get_name( $t_sender_id );
$t_subject = email_build_subject( $p_bug_id );
$t_date = date( config_get( 'normal_date_format' ) );
$result = array();
foreach( $p_recipients as $t_recipient ) {
lang_push( user_pref_get_language( $t_recipient, $t_project_id ) );
$t_email = user_get_email( $t_recipient );
$result[] = user_get_name( $t_recipient );
if( access_has_project_level( config_get( 'show_user_email_threshold' ), $t_project_id, $t_recipient ) ) {
$t_sender_email = ' <' . current_user_get_field( 'email' ) . '>';
} else {
$t_sender_email = '';
}
$t_header = "\n" . lang_get( 'on_date' ) . " $t_date, $t_sender $t_sender_email " . lang_get( 'sent_you_this_reminder_about' ) . ": \n\n";
$t_contents = $t_header . string_get_bug_view_url_with_fqdn( $p_bug_id, $t_recipient ) . " \n\n$p_message";
if( ON == config_get( 'enable_email_notification' ) ) {
email_store( $t_email, $t_subject, $t_contents );
}
lang_pop();
}
if( OFF == config_get( 'email_send_using_cronjob' ) ) {
email_send_all();
}
return $result;
}
# Send bug info to given user
# return true on success
function email_bug_info_to_one_user( $p_visible_bug_data, $p_message_id, $p_project_id, $p_user_id, $p_header_optional_params = null ) {
$t_user_email = user_get_email( $p_user_id );
# check whether email should be sent
# @@@ can be email field empty? if yes - then it should be handled here
if( ON !== config_get( 'enable_email_notification' ) || is_blank( $t_user_email ) ) {
return true;
}
# build subject
$t_subject = '[' . $p_visible_bug_data['email_project'] . ' ' . bug_format_id( $p_visible_bug_data['email_bug'] ) . ']: ' . $p_visible_bug_data['email_summary'];
# build message
$t_message = lang_get_defaulted( $p_message_id, null );