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