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