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; 24use Term::ANSIColor; 25use Git; 26 27$SIG{INT} =sub{print color("reset"),"\n";exit}; 28 29package FakeTerm; 30sub new { 31my($class,$reason) =@_; 32returnbless \$reason,shift; 33} 34subreadline{ 35my$self=shift; 36die"Cannot use readline on FakeTerm:$$self"; 37} 38package main; 39 40 41sub usage { 42print<<EOT; 43git-send-email [options] <file | directory>... 44Options: 45 --from Specify the "From:" line of the email to be sent. 46 47 --to Specify the primary "To:" line of the email. 48 49 --cc Specify an initial "Cc:" list for the entire series 50 of emails. 51 52 --cc-cmd Specify a command to execute per file which adds 53 per file specific cc address entries 54 55 --bcc Specify a list of email addresses that should be Bcc: 56 on all the emails. 57 58 --compose Use \$GIT_EDITOR, core.editor, \$EDITOR, or \$VISUALto edit 59 an introductory message for the patch series. 60 61 --subject Specify the initial "Subject:" line. 62 Only necessary if --compose is also set. If --compose 63 is not set, this will be prompted for. 64 65 --in-reply-to Specify the first "In-Reply-To:" header line. 66 Only used if --compose is also set. If --compose is not 67 set, this will be prompted for. 68 69 --chain-reply-to If set, the replies will all be to the previous 70 email sent, rather than to the first email sent. 71 Defaults to on. 72 73 --signed-off-cc Automatically add email addresses that appear in 74 Signed-off-by: or Cc: lines to the cc: list. Defaults to on. 75 76 --smtp-server If set, specifies the outgoing SMTP server to use. 77 Defaults to localhost. 78 79 --suppress-from Suppress sending emails to yourself if your address 80 appears in a From: line. Defaults to off. 81 82 --thread Specify that the "In-Reply-To:" header should be set on all 83 emails. Defaults to on. 84 85 --quiet Make git-send-email less verbose. One line per email 86 should be all that is output. 87 88 --dry-run Do everything except actually send the emails. 89 90 --envelope-sender Specify the envelope sender used to send the emails. 91 92EOT 93exit(1); 94} 95 96# most mail servers generate the Date: header, but not all... 97sub format_2822_time { 98my($time) =@_; 99my@localtm=localtime($time); 100my@gmttm=gmtime($time); 101my$localmin=$localtm[1] +$localtm[2] *60; 102my$gmtmin=$gmttm[1] +$gmttm[2] *60; 103if($localtm[0] !=$gmttm[0]) { 104die"local zone differs from GMT by a non-minute interval\n"; 105} 106if((($gmttm[6] +1) %7) ==$localtm[6]) { 107$localmin+=1440; 108}elsif((($gmttm[6] -1) %7) ==$localtm[6]) { 109$localmin-=1440; 110}elsif($gmttm[6] !=$localtm[6]) { 111die"local time offset greater than or equal to 24 hours\n"; 112} 113my$offset=$localmin-$gmtmin; 114my$offhour=$offset/60; 115my$offmin=abs($offset%60); 116if(abs($offhour) >=24) { 117die("local time offset greater than or equal to 24 hours\n"); 118} 119 120returnsprintf("%s,%2d%s%d%02d:%02d:%02d%s%02d%02d", 121qw(Sun Mon Tue Wed Thu Fri Sat)[$localtm[6]], 122$localtm[3], 123qw(Jan Feb Mar Apr May Jun 124 Jul Aug Sep Oct Nov Dec)[$localtm[4]], 125$localtm[5]+1900, 126$localtm[2], 127$localtm[1], 128$localtm[0], 129($offset>=0) ?'+':'-', 130abs($offhour), 131$offmin, 132); 133} 134 135my$have_email_valid=eval{require Email::Valid;1}; 136my$smtp; 137 138sub unique_email_list(@); 139sub cleanup_compose_files(); 140 141# Constants (essentially) 142my$compose_filename=".msg.$$"; 143 144# Variables we fill in automatically, or via prompting: 145my(@to,@cc,@initial_cc,@bcclist,@xh, 146$initial_reply_to,$initial_subject,@files,$author,$sender,$compose,$time); 147 148my$smtp_server; 149my$envelope_sender; 150 151# Example reply to: 152#$initial_reply_to = ''; #<20050203173208.GA23964@foobar.com>'; 153 154my$repo= Git->repository(); 155my$term=eval{ 156 new Term::ReadLine 'git-send-email'; 157}; 158if($@) { 159$term= new FakeTerm "$@: going non-interactive"; 160} 161 162# Behavior modification variables 163my($quiet,$dry_run) = (0,0); 164 165# Variables with corresponding config settings 166my($thread,$chain_reply_to,$suppress_from,$signed_off_cc,$cc_cmd); 167 168my%config_settings= ( 169"thread"=> [\$thread,1], 170"chainreplyto"=> [\$chain_reply_to,1], 171"suppressfrom"=> [\$suppress_from,0], 172"signedoffcc"=> [\$signed_off_cc,1], 173"cccmd"=> [\$cc_cmd,""], 174); 175 176foreachmy$setting(keys%config_settings) { 177my$config=$repo->config_bool("sendemail.$setting"); 178${$config_settings{$setting}->[0]} = (defined$config) ?$config:$config_settings{$setting}->[1]; 179} 180 181@bcclist=$repo->config('sendemail.bcc'); 182if(!@bcclistor!$bcclist[0]) { 183@bcclist= (); 184} 185 186# Begin by accumulating all the variables (defined above), that we will end up 187# needing, first, from the command line: 188 189my$rc= GetOptions("sender|from=s"=> \$sender, 190"in-reply-to=s"=> \$initial_reply_to, 191"subject=s"=> \$initial_subject, 192"to=s"=> \@to, 193"cc=s"=> \@initial_cc, 194"bcc=s"=> \@bcclist, 195"chain-reply-to!"=> \$chain_reply_to, 196"smtp-server=s"=> \$smtp_server, 197"compose"=> \$compose, 198"quiet"=> \$quiet, 199"cc-cmd=s"=> \$cc_cmd, 200"suppress-from!"=> \$suppress_from, 201"signed-off-cc|signed-off-by-cc!"=> \$signed_off_cc, 202"dry-run"=> \$dry_run, 203"envelope-sender=s"=> \$envelope_sender, 204"thread!"=> \$thread, 205); 206 207unless($rc) { 208 usage(); 209} 210 211# Verify the user input 212 213foreachmy$entry(@to) { 214die"Comma in --to entry:$entry'\n"unless$entry!~m/,/; 215} 216 217foreachmy$entry(@initial_cc) { 218die"Comma in --cc entry:$entry'\n"unless$entry!~m/,/; 219} 220 221foreachmy$entry(@bcclist) { 222die"Comma in --bcclist entry:$entry'\n"unless$entry!~m/,/; 223} 224 225# Now, let's fill any that aren't set in with defaults: 226 227my($repoauthor) =$repo->ident_person('author'); 228my($repocommitter) =$repo->ident_person('committer'); 229 230my%aliases; 231my@alias_files=$repo->config('sendemail.aliasesfile'); 232my$aliasfiletype=$repo->config('sendemail.aliasfiletype'); 233my%parse_alias= ( 234# multiline formats can be supported in the future 235 mutt =>sub{my$fh=shift;while(<$fh>) { 236if(/^\s*alias\s+(\S+)\s+(.*)$/) { 237my($alias,$addr) = ($1,$2); 238$addr=~s/#.*$//;# mutt allows # comments 239# commas delimit multiple addresses 240$aliases{$alias} = [split(/\s*,\s*/,$addr) ]; 241}}}, 242 mailrc =>sub{my$fh=shift;while(<$fh>) { 243if(/^alias\s+(\S+)\s+(.*)$/) { 244# spaces delimit multiple addresses 245$aliases{$1} = [split(/\s+/,$2) ]; 246}}}, 247 pine =>sub{my$fh=shift;while(<$fh>) { 248if(/^(\S+)\t.*\t(.*)$/) { 249$aliases{$1} = [split(/\s*,\s*/,$2) ]; 250}}}, 251 gnus =>sub{my$fh=shift;while(<$fh>) { 252if(/\(define-mail-alias\s+"(\S+?)"\s+"(\S+?)"\)/) { 253$aliases{$1} = [$2]; 254}}} 255); 256 257if(@alias_filesand$aliasfiletypeand defined$parse_alias{$aliasfiletype}) { 258foreachmy$file(@alias_files) { 259open my$fh,'<',$fileor die"opening$file:$!\n"; 260$parse_alias{$aliasfiletype}->($fh); 261close$fh; 262} 263} 264 265($sender) = expand_aliases($sender)ifdefined$sender; 266 267my$prompting=0; 268if(!defined$sender) { 269$sender=$repoauthor||$repocommitter; 270do{ 271$_=$term->readline("Who should the emails appear to be from? [$sender] "); 272}while(!defined$_); 273 274$sender=$_if($_); 275print"Emails will be sent from: ",$sender,"\n"; 276$prompting++; 277} 278 279if(!@to) { 280do{ 281$_=$term->readline("Who should the emails be sent to? ", 282""); 283}while(!defined$_); 284my$to=$_; 285push@to,split/,/,$to; 286$prompting++; 287} 288 289sub expand_aliases { 290my@cur=@_; 291my@last; 292do{ 293@last=@cur; 294@cur=map{$aliases{$_} ? @{$aliases{$_}} :$_}@last; 295}while(join(',',@cur)ne join(',',@last)); 296return@cur; 297} 298 299@to= expand_aliases(@to); 300@to= (map{ sanitize_address($_) }@to); 301@initial_cc= expand_aliases(@initial_cc); 302@bcclist= expand_aliases(@bcclist); 303 304if(!defined$initial_subject&&$compose) { 305do{ 306$_=$term->readline("What subject should the emails start with? ", 307$initial_subject); 308}while(!defined$_); 309$initial_subject=$_; 310$prompting++; 311} 312 313if($thread&& !defined$initial_reply_to&&$prompting) { 314do{ 315$_=$term->readline("Message-ID to be used as In-Reply-To for the first email? ", 316$initial_reply_to); 317}while(!defined$_); 318 319$initial_reply_to=$_; 320$initial_reply_to=~s/^\s+<?/</; 321$initial_reply_to=~s/>?\s+$/>/; 322} 323 324if(!$smtp_server) { 325$smtp_server=$repo->config('sendemail.smtpserver'); 326} 327if(!$smtp_server) { 328foreach(qw( /usr/sbin/sendmail /usr/lib/sendmail )) { 329if(-x $_) { 330$smtp_server=$_; 331last; 332} 333} 334$smtp_server||='localhost';# could be 127.0.0.1, too... *shrug* 335} 336 337if($compose) { 338# Note that this does not need to be secure, but we will make a small 339# effort to have it be unique 340open(C,">",$compose_filename) 341or die"Failed to open for writing$compose_filename:$!"; 342print C "From$sender# This line is ignored.\n"; 343printf C "Subject:%s\n\n",$initial_subject; 344printf C <<EOT; 345GIT: Please enter your email below. 346GIT: Lines beginning in "GIT: " will be removed. 347GIT: Consider including an overall diffstat or table of contents 348GIT: for the patch you are writing. 349 350EOT 351close(C); 352 353my$editor=$ENV{GIT_EDITOR} ||$repo->config("core.editor") ||$ENV{VISUAL} ||$ENV{EDITOR} ||"vi"; 354system($editor,$compose_filename); 355 356open(C2,">",$compose_filename.".final") 357or die"Failed to open$compose_filename.final : ".$!; 358 359open(C,"<",$compose_filename) 360or die"Failed to open$compose_filename: ".$!; 361 362while(<C>) { 363next ifm/^GIT: /; 364print C2 $_; 365} 366close(C); 367close(C2); 368 369do{ 370$_=$term->readline("Send this email? (y|n) "); 371}while(!defined$_); 372 373if(uc substr($_,0,1)ne'Y') { 374 cleanup_compose_files(); 375exit(0); 376} 377 378@files= ($compose_filename.".final"); 379} 380 381 382# Now that all the defaults are set, process the rest of the command line 383# arguments and collect up the files that need to be processed. 384formy$f(@ARGV) { 385if(-d $f) { 386opendir(DH,$f) 387or die"Failed to opendir$f:$!"; 388 389push@files,grep{ -f $_}map{ +$f."/".$_} 390sort readdir(DH); 391 392}elsif(-f $f) { 393push@files,$f; 394 395}else{ 396print STDERR "Skipping$f- not found.\n"; 397} 398} 399 400if(@files) { 401unless($quiet) { 402print$_,"\n"for(@files); 403} 404}else{ 405print STDERR "\nNo patch files specified!\n\n"; 406 usage(); 407} 408 409# Variables we set as part of the loop over files 410our($message_id,%mail,$subject,$reply_to,$references,$message); 411 412sub extract_valid_address { 413my$address=shift; 414my$local_part_regexp='[^<>"\s@]+'; 415my$domain_regexp='[^.<>"\s@]+(?:\.[^.<>"\s@]+)+'; 416 417# check for a local address: 418return$addressif($address=~/^($local_part_regexp)$/); 419 420$address=~s/^\s*<(.*)>\s*$/$1/; 421if($have_email_valid) { 422returnscalar Email::Valid->address($address); 423}else{ 424# less robust/correct than the monster regexp in Email::Valid, 425# but still does a 99% job, and one less dependency 426$address=~/($local_part_regexp\@$domain_regexp)/; 427return$1; 428} 429} 430 431# Usually don't need to change anything below here. 432 433# we make a "fake" message id by taking the current number 434# of seconds since the beginning of Unix time and tacking on 435# a random number to the end, in case we are called quicker than 436# 1 second since the last time we were called. 437 438# We'll setup a template for the message id, using the "from" address: 439 440my($message_id_stamp,$message_id_serial); 441sub make_message_id 442{ 443my$uniq; 444if(!defined$message_id_stamp) { 445$message_id_stamp=sprintf("%s-%s",time,$$); 446$message_id_serial=0; 447} 448$message_id_serial++; 449$uniq="$message_id_stamp-$message_id_serial"; 450 451my$du_part; 452for($sender,$repocommitter,$repoauthor) { 453$du_part= extract_valid_address(sanitize_address($_)); 454last if(defined$du_partand$du_partne''); 455} 456if(not defined$du_partor$du_parteq'') { 457use Sys::Hostname qw(); 458$du_part='user@'. Sys::Hostname::hostname(); 459} 460my$message_id_template="<%s-git-send-email-%s>"; 461$message_id=sprintf($message_id_template,$uniq,$du_part); 462#print "new message id = $message_id\n"; # Was useful for debugging 463} 464 465 466 467$time=time-scalar$#files; 468 469sub unquote_rfc2047 { 470local($_) =@_; 471if(s/=\?utf-8\?q\?(.*)\?=/$1/g) { 472s/_/ /g; 473s/=([0-9A-F]{2})/chr(hex($1))/eg; 474} 475return"$_"; 476} 477 478# use the simplest quoting being able to handle the recipient 479sub sanitize_address 480{ 481my($recipient) =@_; 482my($recipient_name,$recipient_addr) = ($recipient=~/^(.*?)\s*(<.*)/); 483 484if(not$recipient_name) { 485return"$recipient"; 486} 487 488# if recipient_name is already quoted, do nothing 489if($recipient_name=~/^(".*"|=\?utf-8\?q\?.*\?=)$/) { 490return$recipient; 491} 492 493# rfc2047 is needed if a non-ascii char is included 494if($recipient_name=~/[^[:ascii:]]/) { 495$recipient_name=~s/([^-a-zA-Z0-9!*+\/])/sprintf("=%02X",ord($1))/eg; 496$recipient_name=~s/(.*)/=\?utf-8\?q\?$1\?=/; 497} 498 499# double quotes are needed if specials or CTLs are included 500elsif($recipient_name=~/[][()<>@,;:\\".\000-\037\177]/) { 501$recipient_name=~s/(["\\\r])/\\$1/; 502$recipient_name="\"$recipient_name\""; 503} 504 505return"$recipient_name$recipient_addr"; 506 507} 508 509sub send_message 510{ 511my@recipients= unique_email_list(@to); 512@cc= (map{ sanitize_address($_) }@cc); 513my$to=join(",\n\t",@recipients); 514@recipients= unique_email_list(@recipients,@cc,@bcclist); 515@recipients= (map{ extract_valid_address($_) }@recipients); 516my$date= format_2822_time($time++); 517my$gitversion='@@GIT_VERSION@@'; 518if($gitversion=~m/..GIT_VERSION../) { 519$gitversion= Git::version(); 520} 521 522my$cc=join(", ", unique_email_list(@cc)); 523my$ccline=""; 524if($ccne'') { 525$ccline="\nCc:$cc"; 526} 527my$sanitized_sender= sanitize_address($sender); 528 make_message_id(); 529 530my$header="From:$sanitized_sender 531To:$to${ccline} 532Subject:$subject 533Date:$date 534Message-Id:$message_id 535X-Mailer: git-send-email$gitversion 536"; 537if($thread&&$reply_to) { 538 539$header.="In-Reply-To:$reply_to\n"; 540$header.="References:$references\n"; 541} 542if(@xh) { 543$header.=join("\n",@xh) ."\n"; 544} 545 546my@sendmail_parameters= ('-i',@recipients); 547my$raw_from=$sanitized_sender; 548$raw_from=$envelope_senderif(defined$envelope_sender); 549$raw_from= extract_valid_address($raw_from); 550unshift(@sendmail_parameters, 551'-f',$raw_from)if(defined$envelope_sender); 552 553if($dry_run) { 554# We don't want to send the email. 555}elsif($smtp_server=~ m#^/#) { 556my$pid=open my$sm,'|-'; 557defined$pidor die$!; 558if(!$pid) { 559exec($smtp_server,@sendmail_parameters)or die$!; 560} 561print$sm"$header\n$message"; 562close$smor die$?; 563}else{ 564require Net::SMTP; 565$smtp||= Net::SMTP->new($smtp_server); 566$smtp->mail($raw_from)or die$smtp->message; 567$smtp->to(@recipients)or die$smtp->message; 568$smtp->dataor die$smtp->message; 569$smtp->datasend("$header\n$message")or die$smtp->message; 570$smtp->dataend()or die$smtp->message; 571$smtp->okor die"Failed to send$subject\n".$smtp->message; 572} 573if($quiet) { 574printf(($dry_run?"Dry-":"")."Sent%s\n",$subject); 575}else{ 576print(($dry_run?"Dry-":"")."OK. Log says:\nDate:$date\n"); 577if($smtp_server!~ m#^/#) { 578print"Server:$smtp_server\n"; 579print"MAIL FROM:<$raw_from>\n"; 580print"RCPT TO:".join(',',(map{"<$_>"}@recipients))."\n"; 581}else{ 582print"Sendmail:$smtp_server".join(' ',@sendmail_parameters)."\n"; 583} 584print"From:$sanitized_sender\nSubject:$subject\nCc:$cc\nTo:$to\n\n"; 585if($smtp) { 586print"Result: ",$smtp->code,' ', 587($smtp->message=~/\n([^\n]+\n)$/s),"\n"; 588}else{ 589print"Result: OK\n"; 590} 591} 592} 593 594$reply_to=$initial_reply_to; 595$references=$initial_reply_to||''; 596$subject=$initial_subject; 597 598foreachmy$t(@files) { 599open(F,"<",$t)or die"can't open file$t"; 600 601my$author=undef; 602@cc=@initial_cc; 603@xh= (); 604my$input_format=undef; 605my$header_done=0; 606$message=""; 607while(<F>) { 608if(!$header_done) { 609if(/^From /) { 610$input_format='mbox'; 611next; 612} 613chomp; 614if(!defined$input_format&&/^[-A-Za-z]+:\s/) { 615$input_format='mbox'; 616} 617 618if(defined$input_format&&$input_formateq'mbox') { 619if(/^Subject:\s+(.*)$/) { 620$subject=$1; 621 622}elsif(/^(Cc|From):\s+(.*)$/) { 623if(unquote_rfc2047($2)eq$sender) { 624next if($suppress_from); 625} 626elsif($1eq'From') { 627$author= unquote_rfc2047($2); 628} 629printf("(mbox) Adding cc:%sfrom line '%s'\n", 630$2,$_)unless$quiet; 631push@cc,$2; 632} 633elsif(!/^Date:\s/&&/^[-A-Za-z]+:\s+\S/) { 634push@xh,$_; 635} 636 637}else{ 638# In the traditional 639# "send lots of email" format, 640# line 1 = cc 641# line 2 = subject 642# So let's support that, too. 643$input_format='lots'; 644if(@cc==0) { 645printf("(non-mbox) Adding cc:%sfrom line '%s'\n", 646$_,$_)unless$quiet; 647 648push@cc,$_; 649 650}elsif(!defined$subject) { 651$subject=$_; 652} 653} 654 655# A whitespace line will terminate the headers 656if(m/^\s*$/) { 657$header_done=1; 658} 659}else{ 660$message.=$_; 661if(/^(Signed-off-by|Cc): (.*)$/i&&$signed_off_cc) { 662my$c=$2; 663chomp$c; 664push@cc,$c; 665printf("(sob) Adding cc:%sfrom line '%s'\n", 666$c,$_)unless$quiet; 667} 668} 669} 670close F; 671 672if($cc_cmdne"") { 673open(F,"$cc_cmd$t|") 674or die"(cc-cmd) Could not execute '$cc_cmd'"; 675while(<F>) { 676my$c=$_; 677$c=~s/^\s*//g; 678$c=~s/\n$//g; 679push@cc,$c; 680printf("(cc-cmd) Adding cc:%sfrom: '%s'\n", 681$c,$cc_cmd)unless$quiet; 682} 683close F 684or die"(cc-cmd) failed to close pipe to '$cc_cmd'"; 685} 686 687if(defined$author) { 688$message="From:$author\n\n$message"; 689} 690 691 send_message(); 692 693# set up for the next message 694if($chain_reply_to|| !defined$reply_to||length($reply_to) ==0) { 695$reply_to=$message_id; 696if(length$references>0) { 697$references.="\n$message_id"; 698}else{ 699$references="$message_id"; 700} 701} 702} 703 704if($compose) { 705 cleanup_compose_files(); 706} 707 708sub cleanup_compose_files() { 709unlink($compose_filename,$compose_filename.".final"); 710 711} 712 713$smtp->quitif$smtp; 714 715sub unique_email_list(@) { 716my%seen; 717my@emails; 718 719foreachmy$entry(@_) { 720if(my$clean= extract_valid_address($entry)) { 721$seen{$clean} ||=0; 722next if$seen{$clean}++; 723push@emails,$entry; 724}else{ 725print STDERR "W: unable to extract a valid address", 726" from:$entry\n"; 727} 728} 729return@emails; 730}