X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;ds=sidebyside;f=FS%2FFS%2Fcust_bill.pm;h=d649770c78874d3fabc5939bd7dac01da1d577d4;hb=691a587e56557208e9b3834c77f36ca47f3a1a25;hp=010d698d66a69e42c86c5bcf2e1c507d6e030a6a;hpb=ba1d8c4254912bfda153a2d6c91f57d256817b95;p=freeside.git diff --git a/FS/FS/cust_bill.pm b/FS/FS/cust_bill.pm index 010d698d6..d649770c7 100644 --- a/FS/FS/cust_bill.pm +++ b/FS/FS/cust_bill.pm @@ -1,13 +1,14 @@ package FS::cust_bill; use strict; -use vars qw( @ISA $conf $money_char ); +use vars qw( @ISA $DEBUG $conf $money_char ); use vars qw( $invoice_lines @buf ); #yuck use Date::Format; use Text::Template 1.20; use File::Temp 0.14; use String::ShellQuote; use HTML::Entities; +use Locale::Country; use FS::UID qw( datasrc ); use FS::Record qw( qsearch qsearchs ); use FS::Misc qw( send_email send_fax ); @@ -22,6 +23,8 @@ use FS::cust_bill_event; @ISA = qw( FS::Record ); +$DEBUG = 0; + #ask FS::UID to run this stuff for us later FS::UID->install_callback( sub { $conf = new FS::Conf; @@ -340,57 +343,200 @@ Returns an argument list to be passed to L. =cut +use MIME::Entity; + sub generate_email { my $self = shift; my %args = @_; - my $mimeparts; - if ($conf->exists('invoice_email_pdf')) { - #warn "[FS::cust_bill::send] creating PDF attachment"; - #mime parts arguments a la MIME::Entity->build(). - $mimeparts = [ - { - 'Type' => 'application/pdf', - 'Encoding' => 'base64', - 'Data' => [ $self->print_pdf('', $args{'template'}) ], - 'Disposition' => 'attachment', - 'Filename' => 'invoice.pdf', - }, - ]; - } + my $me = '[FS::cust_bill::generate_email]'; - my $email_text; - if ($conf->exists('invoice_email_pdf') - and scalar($conf->config('invoice_email_pdf_note'))) { + my %return = ( + 'from' => $args{'from'}, + 'subject' => (($args{'subject'}) ? $args{'subject'} : 'Invoice'), + ); - #warn "[FS::cust_bill::send] using 'invoice_email_pdf_note'"; - $email_text = [ map { $_ . "\n" } $conf->config('invoice_email_pdf_note') ]; + if (ref($args{'to'} eq 'ARRAY')) { + $return{'to'} = $args{'to'}; } else { - #warn "[FS::cust_bill::send] not using 'invoice_email_pdf_note'"; - if (ref($args{'print_text'}) eq 'ARRAY') { - $email_text = $args{'print_text'}; + $return{'to'} = [ grep { $_ !~ /^(POST|FAX)$/ } + $self->cust_main->invoicing_list + ]; + } + + if ( $conf->exists('invoice_html') ) { + + warn "$me creating HTML/text multipart message" + if $DEBUG; + + $return{'nobody'} = 1; + + my $alternative = build MIME::Entity + 'Type' => 'multipart/alternative', + 'Encoding' => '7bit', + 'Disposition' => 'inline' + ; + + my $data; + if ( $conf->exists('invoice_email_pdf') + and scalar($conf->config('invoice_email_pdf_note')) ) { + + warn "$me using 'invoice_email_pdf_note' in multipart message" + if $DEBUG; + $data = [ map { $_ . "\n" } + $conf->config('invoice_email_pdf_note') + ]; + } else { - $email_text = [ $self->print_text('', $args{'template'}) ]; + + warn "$me not using 'invoice_email_pdf_note' in multipart message" + if $DEBUG; + if ( ref($args{'print_text'}) eq 'ARRAY' ) { + $data = $args{'print_text'}; + } else { + $data = [ $self->print_text('', $args{'template'}) ]; + } + } - } - my @invoicing_list; - if (ref($args{'to'} eq 'ARRAY')) { - @invoicing_list = @{$args{'to'}}; + $alternative->attach( + 'Type' => 'text/plain', + #'Encoding' => 'quoted-printable', + 'Encoding' => '7bit', + 'Data' => $data, + 'Disposition' => 'inline', + ); + + $args{'from'} =~ /\@([\w\.\-]+)/ or $1 = 'example.com'; + my $content_id = join('.', rand()*(2**32), $$, time). "\@$1"; + + my $image = build MIME::Entity + 'Type' => 'image/png', + 'Encoding' => 'base64', + 'Path' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc/logo.png", + 'Filename' => 'logo.png', + 'Content-ID' => "<$content_id>", + ; + + $alternative->attach( + 'Type' => 'text/html', + 'Encoding' => 'quoted-printable', + 'Data' => [ '', + ' ', + ' ', + ' '. encode_entities($return{'subject'}), + ' ', + ' ', + ' ', + $self->print_html('', $args{'template'}, $content_id), + ' ', + '', + ], + 'Disposition' => 'inline', + #'Filename' => 'invoice.pdf', + ); + + if ( $conf->exists('invoice_email_pdf') ) { + + #attaching pdf too: + # multipart/mixed + # multipart/related + # multipart/alternative + # text/plain + # text/html + # image/png + # application/pdf + + my $related = build MIME::Entity 'Type' => 'multipart/related', + 'Encoding' => '7bit'; + + #false laziness w/Misc::send_email + $related->head->replace('Content-type', + $related->mime_type. + '; boundary="'. $related->head->multipart_boundary. '"'. + '; type=multipart/alternative' + ); + + $related->add_part($alternative); + + $related->add_part($image); + + my $pdf = build MIME::Entity $self->mimebuild_pdf('', $args{'template'}); + + $return{'mimeparts'} = [ $related, $pdf ]; + + } else { + + #no other attachment: + # multipart/related + # multipart/alternative + # text/plain + # text/html + # image/png + + $return{'content-type'} = 'multipart/related'; + $return{'mimeparts'} = [ $alternative, $image ]; + $return{'type'} = 'multipart/alternative'; #Content-Type of first part... + #$return{'disposition'} = 'inline'; + + } + } else { - @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list; + + if ( $conf->exists('invoice_email_pdf') ) { + warn "$me creating PDF attachment" + if $DEBUG; + + #mime parts arguments a la MIME::Entity->build(). + $return{'mimeparts'} = [ + { $self->mimebuild_pdf('', $args{'template'}) } + ]; + } + + if ( $conf->exists('invoice_email_pdf') + and scalar($conf->config('invoice_email_pdf_note')) ) { + + warn "$me using 'invoice_email_pdf_note'" + if $DEBUG; + $return{'body'} = [ map { $_ . "\n" } + $conf->config('invoice_email_pdf_note') + ]; + + } else { + + warn "$me not using 'invoice_email_pdf_note'" + if $DEBUG; + if ( ref($args{'print_text'}) eq 'ARRAY' ) { + $return{'body'} = $args{'print_text'}; + } else { + $return{'body'} = [ $self->print_text('', $args{'template'}) ]; + } + + } + } - return ( - 'from' => $args{'from'}, - 'to' => [ @invoicing_list ], - 'subject' => (($args{'subject'}) ? $args{'subject'} : 'Invoice'), - 'body' => $email_text, - 'mimeparts' => $mimeparts, - ); + %return; +} +=item mimebuild_pdf + +Returns a list suitable for passing to MIME::Entity->build(), representing +this invoice as PDF attachment. + +=cut + +sub mimebuild_pdf { + my $self = shift; + ( + 'Type' => 'application/pdf', + 'Encoding' => 'base64', + 'Data' => [ $self->print_pdf(@_) ], + 'Disposition' => 'attachment', + 'Filename' => 'invoice.pdf', + ); } =item send [ TEMPLATENAME [ , AGENTNUM [ , INVOICE_FROM ] ] ] @@ -416,7 +562,7 @@ sub send { ? shift : ( $self->_agent_invoice_from || $conf->config('invoice_from') ); - my @print_text = $self->print_text('', $template); + #my @print_text = $self->print_text('', $template); my @invoicing_list = $self->cust_main->invoicing_list; if ( grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list or !@invoicing_list ) { @@ -429,7 +575,8 @@ sub send { $self->generate_email( 'from' => $invoice_from, 'to' => [ grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list ], - 'print_text' => [ @print_text ], + #'print_text' => [ @print_text ], + 'template' => $template, ) ); die "can't email invoice: $error\n" if $error; @@ -442,7 +589,7 @@ sub send { if ($conf->config('invoice_latex')) { $lpr_data = [ $self->print_ps('', $template) ]; } else { - $lpr_data = \@print_text; + $lpr_data = [ $self->print_text('', $template) ]; } if ( grep { $_ eq 'POST' } @invoicing_list ) { #postal @@ -1029,8 +1176,10 @@ sub print_text { if $cust_main->address2; $FS::cust_bill::_template::address[$l++] = $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip; - $FS::cust_bill::_template::address[$l++] = $cust_main->country - unless $cust_main->country eq 'US'; + + my $countrydefault = $conf->config('countrydefault') || 'US'; + $FS::cust_bill::_template::address[$l++] = code2country($cust_main->country) + unless $cust_main->country eq $countrydefault; # #overdue? (variable for the template) # $FS::cust_bill::_template::overdue = ( @@ -1083,6 +1232,8 @@ sub print_latex { my( $self, $today, $template ) = @_; $today ||= time; + warn "FS::cust_bill::print_latex called on $self with suffix $template\n" + if $DEBUG; my $cust_main = $self->cust_main; $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') ) @@ -1132,6 +1283,7 @@ sub print_latex { my %invoice_data = ( 'invnum' => $self->invnum, 'date' => time2str('%b %o, %Y', $self->_date), + 'today' => time2str('%b %o, %Y', $today), 'agent' => _latex_escape($cust_main->agent->agent), 'payname' => _latex_escape($cust_main->payname), 'company' => _latex_escape($cust_main->company), @@ -1140,7 +1292,6 @@ sub print_latex { 'city' => _latex_escape($cust_main->city), 'state' => _latex_escape($cust_main->state), 'zip' => _latex_escape($cust_main->zip), - 'country' => _latex_escape($cust_main->country), 'footer' => join("\n", $conf->config('invoice_latexfooter') ), 'smallfooter' => join("\n", $conf->config('invoice_latexsmallfooter') ), 'returnaddress' => $returnaddress, @@ -1151,14 +1302,20 @@ sub print_latex { ); my $countrydefault = $conf->config('countrydefault') || 'US'; - $invoice_data{'country'} = '' if $invoice_data{'country'} eq $countrydefault; + if ( $cust_main->country eq $countrydefault ) { + $invoice_data{'country'} = ''; + } else { + $invoice_data{'country'} = _latex_escape(code2country($cust_main->country)); + } - #do variable substitutions in notes - $invoice_data{'notes'} = - join("\n", - map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b } - $conf->config_orbase('invoice_latexnotes', $suffix) - ); +# #do variable substitutions in notes +# $invoice_data{'notes'} = +# join("\n", +# map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b } +# $conf->config_orbase('invoice_latexnotes', $template) +# ); +# warn "invoice notes: ". $invoice_data{'notes'}. "\n" +# if $DEBUG; $invoice_data{'footer'} =~ s/\n+$//; $invoice_data{'smallfooter'} =~ s/\n+$//; @@ -1484,7 +1641,7 @@ sub print_pdf { } -=item print_html [ TIME [ , TEMPLATE ] ] +=item print_html [ TIME [ , TEMPLATE [ , CID ] ] ] Returns an HTML invoice, as a scalar. @@ -1493,76 +1650,13 @@ default is now. It isn't the date of the invoice; that's the `_date' field. It is specified as a UNIX timestamp; see L. Also see L and L for conversion functions. -=cut +CID is a MIME Content-ID used to create a "cid:" URL for the logo image, used +when emailing the invoice as part of a multipart/related MIME email. -#sub print_html { -# my $self = shift; -# -# my $file = $self->print_latex(@_); -# -# my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc; -# chdir($dir); -# -# my $sfile = shell_quote $file; -# -# system("htlatex $sfile.tex") == 0 -# or die "hlatex $file.tex failed; is hlatex installed, or see $file.log for details?\n"; -# #system("ltoh $sfile.tex") == 0 -# # or die "ltoh $file.tex failed; is hlatex installed, or see $file.log for details?\n"; -# -# open(HTML, "<$file.html") -# or die "can't open $file.html: $! (error in LaTeX template?)\n"; -# -# #unlink("$file.dvi", "$file.log", "$file.aux", "$file.html", "$file.tex"); -# -# my $html = ''; -# while () { -# -# s///; -## s/print_latex(@_); -# -# my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc; -# chdir($dir); -# -# my $sfile = shell_quote $file; -# -# system("htlatex $sfile.tex") == 0 -# or die "hlatex $file.tex failed; is hlatex installed, or see $file.log for details?\n"; -# #system("ltoh $sfile.tex") == 0 -# # or die "ltoh $file.tex failed; is hlatex installed, or see $file.log for details?\n"; -# -# open(CSS, "<$file.css") -# or die "can't open $file.html: $! (error in LaTeX template?)\n"; -# -# unlink("$file.dvi", "$file.log", "$file.aux", "$file.html", "$file.tex"); -# -# my $css = ''; -# while () { -# $css .= $_; -# } -# -# close CSS; -# -# return $css; -# -#} +=cut sub print_html { - my( $self, $today, $template ) = @_; + my( $self, $today, $template, $cid ) = @_; $today ||= time; my $cust_main = $self->cust_main; @@ -1585,17 +1679,10 @@ sub print_html { $html_template->compile() or die 'While compiling ' . $templatefile . ': ' . $Text::Template::ERROR; - my $returnaddress = $conf->exists('invoice_htmlreturnaddress') - ? join("\n", $conf->config('invoice_htmlreturnaddress') ) - : join("\n", map { s/~/ /g; s/\\\\\*?\s*$/
/; } - $conf->config('invoice_latexreturnaddress') - ); - warn $conf->config('invoice_latexreturnaddress'); - warn $returnaddress; - my %invoice_data = ( 'invnum' => $self->invnum, 'date' => time2str('%b %o, %Y', $self->_date), + 'today' => time2str('%b %o, %Y', $today), 'agent' => encode_entities($cust_main->agent->agent), 'payname' => encode_entities($cust_main->payname), 'company' => encode_entities($cust_main->company), @@ -1604,18 +1691,40 @@ sub print_html { 'city' => encode_entities($cust_main->city), 'state' => encode_entities($cust_main->state), 'zip' => encode_entities($cust_main->zip), - 'country' => encode_entities($cust_main->country), -# 'footer' => join("\n", $conf->config('invoice_latexfooter') ), -# 'smallfooter' => join("\n", $conf->config('invoice_latexsmallfooter') ), - 'returnaddress' => $returnaddress, 'terms' => $conf->config('invoice_default_terms') || 'Payable upon receipt', - #'notes' => join("\n", $conf->config('invoice_latexnotes') ), + 'cid' => $cid, # 'conf_dir' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc", ); + $invoice_data{'returnaddress'} = $conf->exists('invoice_htmlreturnaddress') + ? join("\n", $conf->config('invoice_htmlreturnaddress') ) + : join("\n", map { s/~/ /g; s/\\\\\*?\s*$/
/; $_; } + $conf->config('invoice_latexreturnaddress') + ); + my $countrydefault = $conf->config('countrydefault') || 'US'; - $invoice_data{'country'} = '' if $invoice_data{'country'} eq $countrydefault; + if ( $cust_main->country eq $countrydefault ) { + $invoice_data{'country'} = ''; + } else { + $invoice_data{'country'} = + encode_entities(code2country($cust_main->country)); + } + + $invoice_data{'notes'} = + length($conf->config_orbase('invoice_htmlnotes', $template)) + ? join("\n", $conf->config_orbase('invoice_htmlnotes', $template) ) + : join("\n", map { + s/%%(.*)$//; + s/\\section\*\{\\textsc\{(.)(.*)\}\}/

$1<\/font>\U$2<\/b>/; + s/\\begin\{enumerate\}/

    /; + s/\\item /
  1. /; + s/\\end\{enumerate\}/<\/ol>/; + s/\\textbf\{(.*)\}/$1<\/b>/; + $_; + } + $conf->config_orbase('invoice_latexnotes', $template) + ); # #do variable substitutions in notes # $invoice_data{'notes'} = @@ -1623,11 +1732,13 @@ sub print_html { # map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b } # $conf->config_orbase('invoice_latexnotes', $suffix) # ); -# -# $invoice_data{'footer'} =~ s/\n+$//; -# $invoice_data{'smallfooter'} =~ s/\n+$//; -# $invoice_data{'notes'} =~ s/\n+$//; -# + + $invoice_data{'footer'} = $conf->exists('invoice_htmlfooter') + ? join("\n", $conf->config('invoice_htmlfooter') ) + : join("\n", map { s/~/ /g; s/\\\\\*?\s*$/
    /; $_; } + $conf->config('invoice_latexfooter') + ); + $invoice_data{'po_line'} = ( $cust_main->payby eq 'BILL' && $cust_main->payinfo ) ? encode_entities("Purchase Order #". $cust_main->payinfo)