1#!/usr/bin/perl -w 2# 3# Copyright 2002,2005 Greg Kroah-Hartman <greg@kroah.com> 4# Copyright 2005 Ryan Anderson <ryan@michonline.com> 5# 6# GPL v2 (See COPYING) 7# 8# Ported to support git "mbox" format files by Ryan Anderson <ryan@michonline.com> 9# 10# Sends a collection of emails to the given email addresses, disturbingly fast. 11# 12# Supports two formats: 13# 1. mbox format files (ignoring most headers and MIME formatting - this is designed for sending patches) 14# 2. The original format support by Greg's script: 15# first line of the message is who to CC, 16# and second line is the subject of the message. 17# 18 19use strict; 20use warnings; 21use Term::ReadLine; 22use Getopt::Long; 23use Data::Dumper; 24 25package FakeTerm; 26sub new { 27my($class,$reason) =@_; 28returnbless \$reason,shift; 29} 30subreadline{ 31my$self=shift; 32die"Cannot use readline on FakeTerm:$$self"; 33} 34package main; 35 36# most mail servers generate the Date: header, but not all... 37sub format_2822_time { 38my($time) =@_; 39my@localtm=localtime($time); 40my@gmttm=gmtime($time); 41my$localmin=$localtm[1] +$localtm[2] *60; 42my$gmtmin=$gmttm[1] +$gmttm[2] *60; 43if($localtm[0] !=$gmttm[0]) { 44die"local zone differs from GMT by a non-minute interval\n"; 45} 46if((($gmttm[6] +1) %7) ==$localtm[6]) { 47$localmin+=1440; 48}elsif((($gmttm[6] -1) %7) ==$localtm[6]) { 49$localmin-=1440; 50}elsif($gmttm[6] !=$localtm[6]) { 51die"local time offset greater than or equal to 24 hours\n"; 52} 53my$offset=$localmin-$gmtmin; 54my$offhour=$offset/60; 55my$offmin=abs($offset%60); 56if(abs($offhour) >=24) { 57die("local time offset greater than or equal to 24 hours\n"); 58} 59 60returnsprintf("%s,%2d%s%d%02d:%02d:%02d%s%02d%02d", 61qw(Sun Mon Tue Wed Thu Fri Sat)[$localtm[6]], 62$localtm[3], 63qw(Jan Feb Mar Apr May Jun 64 Jul Aug Sep Oct Nov Dec)[$localtm[4]], 65$localtm[5]+1900, 66$localtm[2], 67$localtm[1], 68$localtm[0], 69($offset>=0) ?'+':'-', 70abs($offhour), 71$offmin, 72); 73} 74 75my$have_email_valid=eval{require Email::Valid;1}; 76my$smtp; 77 78sub unique_email_list(@); 79sub cleanup_compose_files(); 80 81# Constants (essentially) 82my$compose_filename=".msg.$$"; 83 84# Variables we fill in automatically, or via prompting: 85my(@to,@cc,@initial_cc,@bcclist, 86$initial_reply_to,$initial_subject,@files,$from,$compose,$time); 87 88# Behavior modification variables 89my($chain_reply_to,$quiet,$suppress_from,$no_signed_off_cc) = (1,0,0,0); 90my$smtp_server; 91 92# Example reply to: 93#$initial_reply_to = ''; #<20050203173208.GA23964@foobar.com>'; 94 95my$term=eval{ 96 new Term::ReadLine 'git-send-email'; 97}; 98if($@) { 99$term= new FakeTerm "$@: going non-interactive"; 100} 101 102# Begin by accumulating all the variables (defined above), that we will end up 103# needing, first, from the command line: 104 105my$rc= GetOptions("from=s"=> \$from, 106"in-reply-to=s"=> \$initial_reply_to, 107"subject=s"=> \$initial_subject, 108"to=s"=> \@to, 109"cc=s"=> \@initial_cc, 110"bcc=s"=> \@bcclist, 111"chain-reply-to!"=> \$chain_reply_to, 112"smtp-server=s"=> \$smtp_server, 113"compose"=> \$compose, 114"quiet"=> \$quiet, 115"suppress-from"=> \$suppress_from, 116"no-signed-off-cc|no-signed-off-by-cc"=> \$no_signed_off_cc, 117); 118 119# Verify the user input 120 121foreachmy$entry(@to) { 122die"Comma in --to entry:$entry'\n"unless$entry!~m/,/; 123} 124 125foreachmy$entry(@initial_cc) { 126die"Comma in --cc entry:$entry'\n"unless$entry!~m/,/; 127} 128 129foreachmy$entry(@bcclist) { 130die"Comma in --bcclist entry:$entry'\n"unless$entry!~m/,/; 131} 132 133# Now, let's fill any that aren't set in with defaults: 134 135sub gitvar { 136my($var) =@_; 137my$fh; 138my$pid=open($fh,'-|'); 139die"$!"unlessdefined$pid; 140if(!$pid) { 141exec('git-var',$var)or die"$!"; 142} 143my($val) = <$fh>; 144close$fhor die"$!"; 145chomp($val); 146return$val; 147} 148 149sub gitvar_ident { 150my($name) =@_; 151my$val= gitvar($name); 152my@field=split(/\s+/,$val); 153returnjoin(' ',@field[0...(@field-3)]); 154} 155 156my($author) = gitvar_ident('GIT_AUTHOR_IDENT'); 157my($committer) = gitvar_ident('GIT_COMMITTER_IDENT'); 158 159my%aliases; 160chomp(my@alias_files=`git-repo-config --get-all sendemail.aliasesfile`); 161chomp(my$aliasfiletype=`git-repo-config sendemail.aliasfiletype`); 162my%parse_alias= ( 163# multiline formats can be supported in the future 164 mutt =>sub{my$fh=shift;while(<$fh>) { 165if(/^alias\s+(\S+)\s+(.*)$/) { 166my($alias,$addr) = ($1,$2); 167$addr=~s/#.*$//;# mutt allows # comments 168# commas delimit multiple addresses 169$aliases{$alias} = [split(/\s*,\s*/,$addr) ]; 170}}}, 171 mailrc =>sub{my$fh=shift;while(<$fh>) { 172if(/^alias\s+(\S+)\s+(.*)$/) { 173# spaces delimit multiple addresses 174$aliases{$1} = [split(/\s+/,$2) ]; 175}}}, 176 pine =>sub{my$fh=shift;while(<$fh>) { 177if(/^(\S+)\s+(.*)$/) { 178$aliases{$1} = [split(/\s*,\s*/,$2) ]; 179}}}, 180 gnus =>sub{my$fh=shift;while(<$fh>) { 181if(/\(define-mail-alias\s+"(\S+?)"\s+"(\S+?)"\)/) { 182$aliases{$1} = [$2]; 183}}} 184); 185 186if(@alias_files&&defined$parse_alias{$aliasfiletype}) { 187foreachmy$file(@alias_files) { 188open my$fh,'<',$fileor die"opening$file:$!\n"; 189$parse_alias{$aliasfiletype}->($fh); 190close$fh; 191} 192} 193 194my$prompting=0; 195if(!defined$from) { 196$from=$author||$committer; 197do{ 198$_=$term->readline("Who should the emails appear to be from? ", 199$from); 200}while(!defined$_); 201 202$from=$_; 203print"Emails will be sent from: ",$from,"\n"; 204$prompting++; 205} 206 207if(!@to) { 208do{ 209$_=$term->readline("Who should the emails be sent to? ", 210""); 211}while(!defined$_); 212my$to=$_; 213push@to,split/,/,$to; 214$prompting++; 215} 216 217sub expand_aliases { 218my@cur=@_; 219my@last; 220do{ 221@last=@cur; 222@cur=map{$aliases{$_} ? @{$aliases{$_}} :$_}@last; 223}while(join(',',@cur)ne join(',',@last)); 224return@cur; 225} 226 227@to= expand_aliases(@to); 228@initial_cc= expand_aliases(@initial_cc); 229@bcclist= expand_aliases(@bcclist); 230 231if(!defined$initial_subject&&$compose) { 232do{ 233$_=$term->readline("What subject should the emails start with? ", 234$initial_subject); 235}while(!defined$_); 236$initial_subject=$_; 237$prompting++; 238} 239 240if(!defined$initial_reply_to&&$prompting) { 241do{ 242$_=$term->readline("Message-ID to be used as In-Reply-To for the first email? ", 243$initial_reply_to); 244}while(!defined$_); 245 246$initial_reply_to=$_; 247$initial_reply_to=~s/(^\s+|\s+$)//g; 248} 249 250if(!$smtp_server) { 251foreach(qw( /usr/sbin/sendmail /usr/lib/sendmail )) { 252if(-x $_) { 253$smtp_server=$_; 254last; 255} 256} 257$smtp_server||='localhost';# could be 127.0.0.1, too... *shrug* 258} 259 260if($compose) { 261# Note that this does not need to be secure, but we will make a small 262# effort to have it be unique 263open(C,">",$compose_filename) 264or die"Failed to open for writing$compose_filename:$!"; 265print C "From$from# This line is ignored.\n"; 266printf C "Subject:%s\n\n",$initial_subject; 267printf C <<EOT; 268GIT: Please enter your email below. 269GIT: Lines beginning in "GIT: " will be removed. 270GIT: Consider including an overall diffstat or table of contents 271GIT: for the patch you are writing. 272 273EOT 274close(C); 275 276my$editor=$ENV{EDITOR}; 277$editor='vi'unlessdefined$editor; 278system($editor,$compose_filename); 279 280open(C2,">",$compose_filename.".final") 281or die"Failed to open$compose_filename.final : ".$!; 282 283open(C,"<",$compose_filename) 284or die"Failed to open$compose_filename: ".$!; 285 286while(<C>) { 287next ifm/^GIT: /; 288print C2 $_; 289} 290close(C); 291close(C2); 292 293do{ 294$_=$term->readline("Send this email? (y|n) "); 295}while(!defined$_); 296 297if(uc substr($_,0,1)ne'Y') { 298 cleanup_compose_files(); 299exit(0); 300} 301 302@files= ($compose_filename.".final"); 303} 304 305 306# Now that all the defaults are set, process the rest of the command line 307# arguments and collect up the files that need to be processed. 308formy$f(@ARGV) { 309if(-d $f) { 310opendir(DH,$f) 311or die"Failed to opendir$f:$!"; 312 313push@files,grep{ -f $_}map{ +$f."/".$_} 314sort readdir(DH); 315 316}elsif(-f $f) { 317push@files,$f; 318 319}else{ 320print STDERR "Skipping$f- not found.\n"; 321} 322} 323 324if(@files) { 325unless($quiet) { 326print$_,"\n"for(@files); 327} 328}else{ 329print<<EOT; 330git-send-email [options] <file | directory> [... file | directory ] 331Options: 332 --from Specify the "From:" line of the email to be sent. 333 334 --to Specify the primary "To:" line of the email. 335 336 --cc Specify an initial "Cc:" list for the entire series 337 of emails. 338 339 --bcc Specify a list of email addresses that should be Bcc: 340 on all the emails. 341 342 --compose Use \$EDITORto edit an introductory message for the 343 patch series. 344 345 --subject Specify the initial "Subject:" line. 346 Only necessary if --compose is also set. If --compose 347 is not set, this will be prompted for. 348 349 --in-reply-to Specify the first "In-Reply-To:" header line. 350 Only used if --compose is also set. If --compose is not 351 set, this will be prompted for. 352 353 --chain-reply-to If set, the replies will all be to the previous 354 email sent, rather than to the first email sent. 355 Defaults to on. 356 357 --no-signed-off-cc Suppress the automatic addition of email addresses 358 that appear in a Signed-off-by: line, to the cc: list. 359 Note: Using this option is not recommended. 360 361 --smtp-server If set, specifies the outgoing SMTP server to use. 362 Defaults to localhost. 363 364 --suppress-from Supress sending emails to yourself if your address 365 appears in a From: line. 366 367 --quiet Make git-send-email less verbose. One line per email should be 368 all that is output. 369 370Error: Please specify a file or a directory on the command line. 371EOT 372exit(1); 373} 374 375# Variables we set as part of the loop over files 376our($message_id,$cc,%mail,$subject,$reply_to,$references,$message); 377 378sub extract_valid_address { 379my$address=shift; 380my$local_part_regexp='[^<>"\s@]+'; 381my$domain_regexp='[^.<>"\s@]+(?:\.[^.<>"\s@]+)+'; 382 383# check for a local address: 384return$addressif($address=~/^($local_part_regexp)$/); 385 386if($have_email_valid) { 387returnscalar Email::Valid->address($address); 388}else{ 389# less robust/correct than the monster regexp in Email::Valid, 390# but still does a 99% job, and one less dependency 391$address=~/($local_part_regexp\@$domain_regexp)/; 392return$1; 393} 394} 395 396# Usually don't need to change anything below here. 397 398# we make a "fake" message id by taking the current number 399# of seconds since the beginning of Unix time and tacking on 400# a random number to the end, in case we are called quicker than 401# 1 second since the last time we were called. 402 403# We'll setup a template for the message id, using the "from" address: 404my$message_id_from= extract_valid_address($from); 405my$message_id_template="<%s-git-send-email-$message_id_from>"; 406 407sub make_message_id 408{ 409my$date=time; 410my$pseudo_rand=int(rand(4200)); 411$message_id=sprintf$message_id_template,"$date$pseudo_rand"; 412#print "new message id = $message_id\n"; # Was useful for debugging 413} 414 415 416 417$cc=""; 418$time=time-scalar$#files; 419 420sub send_message 421{ 422my@recipients= unique_email_list(@to); 423my$to=join(",\n\t",@recipients); 424@recipients= unique_email_list(@recipients,@cc,@bcclist); 425my$date= format_2822_time($time++); 426my$gitversion='@@GIT_VERSION@@'; 427if($gitversion=~m/..GIT_VERSION../) { 428$gitversion=`git --version`; 429chomp$gitversion; 430# keep only what's after the last space 431$gitversion=~s/^.* //; 432} 433 434my$header="From:$from 435To:$to 436Cc:$cc 437Subject:$subject 438Reply-To:$from 439Date:$date 440Message-Id:$message_id 441X-Mailer: git-send-email$gitversion 442"; 443if($reply_to) { 444 445$header.="In-Reply-To:$reply_to\n"; 446$header.="References:$references\n"; 447} 448 449if($smtp_server=~ m#^/#) { 450my$pid=open my$sm,'|-'; 451defined$pidor die$!; 452if(!$pid) { 453exec($smtp_server,'-i', 454map{ extract_valid_address($_) } 455@recipients)or die$!; 456} 457print$sm"$header\n$message"; 458close$smor die$?; 459}else{ 460require Net::SMTP; 461$smtp||= Net::SMTP->new($smtp_server); 462$smtp->mail($from)or die$smtp->message; 463$smtp->to(@recipients)or die$smtp->message; 464$smtp->dataor die$smtp->message; 465$smtp->datasend("$header\n$message")or die$smtp->message; 466$smtp->dataend()or die$smtp->message; 467$smtp->okor die"Failed to send$subject\n".$smtp->message; 468} 469if($quiet) { 470printf"Sent%s\n",$subject; 471}else{ 472print"OK. Log says:\nDate:$date\n"; 473if($smtp) { 474print"Server:$smtp_server\n"; 475}else{ 476print"Sendmail:$smtp_server\n"; 477} 478print"From:$from\nSubject:$subject\nCc:$cc\nTo:$to\n\n"; 479if($smtp) { 480print"Result: ",$smtp->code,' ', 481($smtp->message=~/\n([^\n]+\n)$/s),"\n"; 482}else{ 483print"Result: OK\n"; 484} 485} 486} 487 488$reply_to=$initial_reply_to; 489$references=$initial_reply_to||''; 490make_message_id(); 491$subject=$initial_subject; 492 493foreachmy$t(@files) { 494open(F,"<",$t)or die"can't open file$t"; 495 496my$author_not_sender=undef; 497@cc=@initial_cc; 498my$found_mbox=0; 499my$header_done=0; 500$message=""; 501while(<F>) { 502if(!$header_done) { 503$found_mbox=1,next if(/^From /); 504chomp; 505 506if($found_mbox) { 507if(/^Subject:\s+(.*)$/) { 508$subject=$1; 509 510}elsif(/^(Cc|From):\s+(.*)$/) { 511if($2eq$from) { 512next if($suppress_from); 513} 514else{ 515$author_not_sender=$2; 516} 517printf("(mbox) Adding cc:%sfrom line '%s'\n", 518$2,$_)unless$quiet; 519push@cc,$2; 520} 521 522}else{ 523# In the traditional 524# "send lots of email" format, 525# line 1 = cc 526# line 2 = subject 527# So let's support that, too. 528if(@cc==0) { 529printf("(non-mbox) Adding cc:%sfrom line '%s'\n", 530$_,$_)unless$quiet; 531 532push@cc,$_; 533 534}elsif(!defined$subject) { 535$subject=$_; 536} 537} 538 539# A whitespace line will terminate the headers 540if(m/^\s*$/) { 541$header_done=1; 542} 543}else{ 544$message.=$_; 545if(/^Signed-off-by: (.*)$/i&& !$no_signed_off_cc) { 546my$c=$1; 547chomp$c; 548push@cc,$c; 549printf("(sob) Adding cc:%sfrom line '%s'\n", 550$c,$_)unless$quiet; 551} 552} 553} 554close F; 555if(defined$author_not_sender) { 556$message="From:$author_not_sender\n\n$message"; 557} 558 559$cc=join(", ", unique_email_list(@cc)); 560 561 send_message(); 562 563# set up for the next message 564if($chain_reply_to||length($reply_to) ==0) { 565$reply_to=$message_id; 566if(length$references>0) { 567$references.="$message_id"; 568}else{ 569$references="$message_id"; 570} 571} 572 make_message_id(); 573} 574 575if($compose) { 576 cleanup_compose_files(); 577} 578 579sub cleanup_compose_files() { 580unlink($compose_filename,$compose_filename.".final"); 581 582} 583 584$smtp->quitif$smtp; 585 586sub unique_email_list(@) { 587my%seen; 588my@emails; 589 590foreachmy$entry(@_) { 591if(my$clean= extract_valid_address($entry)) { 592$seen{$clean} ||=0; 593next if$seen{$clean}++; 594push@emails,$entry; 595}else{ 596print STDERR "W: unable to extract a valid address", 597" from:$entry\n"; 598} 599} 600return@emails; 601}