1 # This module is part of debbugs, and is released
2 # under the terms of the GPL version 2, or any later
3 # version at your option.
4 # See the file README and COPYING for more information.
6 # Copyright 2004-7 by Don Armstrong <don@donarmstrong.com>.
12 Debbugs::Mail -- Outgoing Mail Handling
16 use Debbugs::Mail qw(send_mail_message get_addresses);
18 my @addresses = get_addresses('blah blah blah foo@bar.com')
19 send_mail_message(message => <<END, recipients=>[@addresses]);
30 =item :all -- all functions that can be exported
41 use vars qw($VERSION $DEBUG %EXPORT_TAGS @EXPORT_OK @EXPORT);
42 use base qw(Exporter);
45 use POSIX qw(:sys_wait_h strftime);
46 use Time::HiRes qw(usleep gettimeofday);
48 use Debbugs::MIME qw(encode_rfc1522);
49 use Debbugs::Config qw(:config);
50 use Params::Validate qw(:types validate_with);
51 use Encode qw(encode is_utf8);
53 use Debbugs::Packages;
56 ($VERSION) = q$Revision: 1.1 $ =~ /^Revision:\s+([^\s+])/;
57 $DEBUG = 0 unless defined $DEBUG;
60 %EXPORT_TAGS = (addresses => [qw(get_addresses)],
61 misc => [qw(rfc822_date)],
62 mail => [qw(send_mail_message encode_headers default_headers)],
65 Exporter::export_ok_tags(keys %EXPORT_TAGS);
66 $EXPORT_TAGS{all} = [@EXPORT_OK];
69 # We set this here so it can be overridden for testing purposes
70 our $SENDMAIL = $config{sendmail};
74 my @addresses = get_addresses('don@debian.org blars@debian.org
75 kamion@debian.org ajt@debian.org');
77 Given a string containing some e-mail addresses, parses the string
78 using Mail::Address->parse and returns a list of the addresses.
83 return map { $_->address() } map { Mail::Address->parse($_) } @_;
87 =head2 default_headers
89 my @head = default_headers(queue_file => 'foo',
91 msgid => $header{'message-id'},
95 create_mime_message(\@headers,
99 This function is generally called to generate the headers for
100 create_mime_message (and anything else that needs a set of default
103 In list context, returns an array of headers. In scalar context,
104 returns headers for shoving in a mail message after encoding using
111 =item queue_file -- the queue file which will generate this set of
112 headers (refered to as $nn in lots of the code)
114 =item data -- the data of the bug which this message involves; can be
115 undefined if there is no bug involved.
117 =item msgid -- the Message-ID: of the message which will generate this
120 =item msgtype -- the type of message that this is.
122 =item pr_msg -- the pr message field
124 =item headers -- a set of headers which will override the default
125 headers; these headers will be passed through (and may be reordered.)
126 If a particular header is undef, it overrides the default, but isn't
131 =head3 default headers
135 =item X-Loop -- set to the maintainer e-mail
137 =item From -- set to the maintainer e-mail
139 =item To -- set to Unknown recipients
141 =item Subject -- set to Unknown subject
143 =item Message-ID -- set appropriately (see code)
145 =item Precedence -- set to bulk
147 =item References -- set to the full set of message ids that are known
148 (from data and the msgid option)
150 =item In-Reply-To -- set to msg id or the msgid from data
152 =item X-Project-PR-Message -- set to pr_msg with the bug number appended
154 =item X-Project-PR-Package -- set to the package of the bug
156 =item X-Project-PR-Keywords -- set to the keywords of the bug
158 =item X-Project-PR-Source -- set to the source of the bug
164 sub default_headers {
165 my %param = validate_with(params => \@_,
166 spec => {queue_file => {type => SCALAR|UNDEF,
169 data => {type => HASHREF,
172 msgid => {type => SCALAR|UNDEF,
175 msgtype => {type => SCALAR|UNDEF,
178 pr_msg => {type => SCALAR|UNDEF,
181 headers => {type => ARRAYREF,
186 my @header_order = (qw(X-Loop From To subject),
187 qw(Message-ID In-Reply-To References));
188 # handle various things being undefined
189 if (not exists $param{queue_file} or
190 not defined $param{queue_file}) {
191 $param{queue_file} = join('',gettimeofday())
193 for (qw(msgtype pr_msg)) {
194 if (not exists $param{$_} or
195 not defined $param{$_}) {
200 @header_order{map {lc $_} @header_order} = 0..$#header_order;
203 my @temp = @{$param{headers}};
205 while (my ($header,$value) = splice @temp,0,2) {
206 if (exists $header_order{lc($header)}) {
207 push @{$ordered_headers[$header_order{lc($header)}]},
211 push @other_headers,($header,$value);
213 $set_headers{lc($header)} = 1;
216 # calculate our headers
217 my $bug_num = exists $param{data} ? $param{data}{bug_num} : 'x';
218 my $nn = $param{queue_file};
219 # handle the user giving the actual queue filename instead of nn
220 $nn =~ s/^[a-zA-Z]([a-zA-Z])/$1/;
223 if (exists $param{msgid} and defined $param{msgid}) {
224 push @msgids, $param{msgid}
226 elsif (exists $param{data} and defined $param{data}{msgid}) {
227 push @msgids, $param{data}{msgid}
230 $default_header{'X-Loop'} = $config{maintainer_email};
231 $default_header{From} = "$config{maintainer_email} ($config{project} $config{ubug} Tracking System)";
232 $default_header{To} = "Unknown recipients";
233 $default_header{Subject} = "Unknown subject";
234 $default_header{'Message-ID'} = "<handler.${bug_num}.${nn}.$param{msgtype}\@$config{email_domain}>";
236 $default_header{'In-Reply-To'} = $msgids[0];
237 $default_header{'References'} = join(' ',@msgids);
239 $default_header{Precedence} = 'bulk';
240 $default_header{"X-$config{project}-PR-Message"} = $param{pr_msg} . (exists $param{data} ? ' '.$param{data}{bug_num}:'');
241 $default_header{Date} = rfc822_date();
242 if (exists $param{data}) {
243 if (defined $param{data}{keywords}) {
244 $default_header{"X-$config{project}-PR-Keywords"} = $param{data}{keywords};
246 if (defined $param{data}{package}) {
247 $default_header{"X-$config{project}-PR-Package"} = $param{data}{package};
248 if ($param{data}{package} =~ /^src:(.+)$/) {
249 $default_header{"X-$config{project}-PR-Source"} = $1;
252 my $pkg_src = Debbugs::Packages::getpkgsrc();
253 $default_header{"X-$config{project}-PR-Source"} = $pkg_src->{$param{data}{package}};
257 for my $header (sort keys %default_header) {
258 next if $set_headers{lc($header)};
259 if (exists $header_order{lc($header)}) {
260 push @{$ordered_headers[$header_order{lc($header)}]},
261 ($header,$default_header{$header});
264 push @other_headers,($header,$default_header{$header});
268 for my $hdr1 (@ordered_headers) {
269 next if not defined $hdr1;
271 while (my ($header,$value) = splice @temp,0,2) {
272 next if not defined $value;
273 push @headers,($header,$value);
276 push @headers,@other_headers;
282 while (my ($header,$value) = splice @headers,0,2) {
283 $headers .= "${header}: $value\n";
291 =head2 send_mail_message
293 send_mail_message(message => $message,
294 recipients => [@recipients],
295 envelope_from => 'don@debian.org',
301 =item message -- message to send out
303 =item recipients -- recipients to send the message to. If undefed or
304 an empty arrayref, will use '-t' to parse the message for recipients.
306 =item envelope_from -- envelope_from for outgoing messages
308 =item encode_headers -- encode headers using RFC1522 (default)
310 =item parse_for_recipients -- use -t to parse the message for
311 recipients in addition to those specified. [Can be used to set Bcc
312 recipients, for example.]
316 Returns true on success, false on failures. All errors are indicated
321 sub send_mail_message{
322 my %param = validate_with(params => \@_,
323 spec => {sendmail_arguments => {type => ARRAYREF,
324 default => $config{sendmail_arguments},
326 parse_for_recipients => {type => BOOLEAN,
329 encode_headers => {type => BOOLEAN,
332 message => {type => SCALAR,
334 envelope_from => {type => SCALAR,
337 recipients => {type => ARRAYREF|UNDEF,
342 my @sendmail_arguments = @{$param{sendmail_arguments}};
343 push @sendmail_arguments, '-f', $param{envelope_from} if exists $param{envelope_from};
346 @recipients = @{$param{recipients}} if defined $param{recipients} and
347 ref($param{recipients}) eq 'ARRAY';
349 @recipients{@recipients} = (1) x @recipients;
350 @recipients = keys %recipients;
351 # If there are no recipients, use -t to parse the message
352 if (@recipients == 0) {
353 $param{parse_for_recipients} = 1 unless exists $param{parse_for_recipients};
355 # Encode headers if necessary
356 $param{encode_headers} = 1 if not exists $param{encode_headers};
357 if ($param{encode_headers}) {
358 $param{message} = encode_headers($param{message});
361 # First, try to send the message as is.
363 _send_message($param{message},
365 $param{parse_for_recipients}?q(-t):(),
369 # If there's only one recipient, there's nothing more we can do,
371 warn $@ and return 0 if $@ and @recipients == 0;
372 # If that fails, try to send the message to each of the
373 # recipients separately. We also send the -t option separately in
374 # case one of the @recipients is ok, but the addresses in the
375 # mail message itself are malformed.
377 for my $recipient ($param{parse_for_recipients}?q(-t):(),@recipients) {
379 _send_message($param{message},@sendmail_arguments,$recipient);
381 push @errors, "Sending to $recipient failed with $@" if $@;
383 # If it still fails, complain bitterly but don't die.
384 warn join(qq(\n),@errors) and return 0 if @errors;
388 =head2 encode_headers
390 $message = encode_heeaders($message);
392 RFC 1522 encodes the headers of a message
399 my ($header,$body) = split /\n\n/, $message, 2;
400 $header = encode_rfc1522($header);
401 return $header . qq(\n\n). $body;
408 Return the current date in RFC822 format in the UTC timezone
413 return scalar strftime "%a, %d %h %Y %T +0000", gmtime;
416 =head1 PRIVATE FUNCTIONS
420 _send_message($message,@sendmail_args);
422 Private function that actually calls sendmail with @sendmail_args and
423 sends message $message.
425 dies with errors, so calls to this function in send_mail_message
426 should be wrapped in eval.
431 my ($message,@sendmail_args) = @_;
434 my $pid = open3($wfh,$rfh,$rfh,$SENDMAIL,@sendmail_args)
435 or die "Unable to fork off $SENDMAIL: $!";
436 local $SIG{PIPE} = 'IGNORE';
438 print {$wfh} $message or die "Unable to write to $SENDMAIL: $!";
439 close $wfh or die "$SENDMAIL exited with $?";
444 waitpid($pid,WNOHANG);
445 # This shouldn't block because the pipe closing is the only
446 # way this should be triggered.
447 my $message = <$rfh>;
450 # Wait for sendmail to exit for at most 30 seconds.
452 while (waitpid($pid, WNOHANG) == 0 or $loop++ >= 600){
453 # sleep for a 20th of a second
457 warn "$SENDMAIL didn't exit within 30 seconds";