1 package FS::Template_Mixin;
4 use vars qw( $DEBUG $me
9 use vars qw( $invoice_lines @buf ); #yuck
10 use List::Util qw(sum); #can't import first, it conflicts with cust_main.first
13 use Text::Template 1.20;
19 use FS::Misc qw( send_email );
20 use FS::Record qw( qsearch qsearchs );
22 use FS::Misc qw( generate_ps generate_pdf );
29 $me = '[FS::Template_Mixin]';
30 FS::UID->install_callback( sub {
31 my $conf = new FS::Conf; #global
32 $money_char = $conf->config('money_char') || '$';
33 $date_format = $conf->config('date_format') || '%x'; #/YY
38 Returns a configuration handle (L<FS::Conf>) set to the customer's locale.
40 If the "mode" pseudo-field is set on the object, the configuration handle
41 will be an L<FS::invoice_conf> for that invoice mode (and the customer's
48 my $mode = $self->get('mode');
49 if ($self->{_conf} and !defined($mode)) {
50 return $self->{_conf};
53 my $cust_main = $self->cust_main;
54 my $locale = $cust_main ? $cust_main->locale : '';
57 if ( ref $mode and $mode->isa('FS::invoice_mode') ) {
58 $mode = $mode->modenum;
59 } elsif ( $mode =~ /\D/ ) {
60 die "invalid invoice mode $mode";
62 $conf = qsearchs('invoice_conf', { modenum => $mode, locale => $locale });
64 $conf = qsearchs('invoice_conf', { modenum => $mode, locale => '' });
65 # it doesn't have a locale, but system conf still might
66 $conf->set('locale' => $locale) if $conf;
69 # if $mode is unspecified, or if there is no invoice_conf matching this mode
70 # and locale, then use the system config only (but with the locale)
71 $conf ||= FS::Conf->new({ 'locale' => $locale });
73 return $self->{_conf} = $conf;
76 =item print_text OPTIONS
78 Returns an text invoice, as a list of lines.
80 Options can be passed as a hash.
82 I<time>, if specified, is used to control the printing of overdue messages. The
83 default is now. It isn't the date of the invoice; that's the `_date' field.
84 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
85 L<Time::Local> and L<Date::Parse> for conversion functions.
87 I<template>, if specified, is the name of a suffix for alternate invoices.
89 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
97 %params = %{ shift() };
102 $params{'format'} = 'template'; # for some reason
104 $self->print_generic( %params );
107 =item print_latex HASHREF
109 Internal method - returns a filename of a filled-in LaTeX template for this
110 invoice (Note: add ".tex" to get the actual filename), and a filename of
111 an associated logo (with the .eps extension included).
113 See print_ps and print_pdf for methods that return PostScript and PDF output.
115 Options can be passed as a hash.
117 I<time>, if specified, is used to control the printing of overdue messages. The
118 default is now. It isn't the date of the invoice; that's the `_date' field.
119 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
120 L<Time::Local> and L<Date::Parse> for conversion functions.
122 I<template>, if specified, is the name of a suffix for alternate invoices.
123 This is strongly deprecated; see L<FS::invoice_conf> for the right way to
124 customize invoice templates for different purposes.
126 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
135 %params = %{ shift() };
140 $params{'format'} = 'latex';
141 my $conf = $self->conf;
143 # this needs to go away
144 my $template = $params{'template'};
145 # and this especially
146 $template ||= $self->_agent_template
147 if $self->can('_agent_template');
149 my $pkey = $self->primary_key;
150 my $tmp_template = $self->table. '.'. $self->$pkey. '.XXXXXXXX';
152 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
153 my $lh = new File::Temp(
154 TEMPLATE => $tmp_template,
158 ) or die "can't open temp file: $!\n";
160 my $agentnum = $self->agentnum;
162 if ( $template && $conf->exists("logo_${template}.eps", $agentnum) ) {
163 print $lh $conf->config_binary("logo_${template}.eps", $agentnum)
164 or die "can't write temp file: $!\n";
166 print $lh $conf->config_binary('logo.eps', $agentnum)
167 or die "can't write temp file: $!\n";
170 $params{'logo_file'} = $lh->filename;
172 if( $conf->exists('invoice-barcode')
173 && $self->can('invoice_barcode')
174 && $self->invnum ) { # don't try to barcode statements
175 my $png_file = $self->invoice_barcode($dir);
176 my $eps_file = $png_file;
177 $eps_file =~ s/\.png$/.eps/g;
178 $png_file =~ /(barcode.*png)/;
180 $eps_file =~ /(barcode.*eps)/;
183 my $curr_dir = cwd();
185 # after painfuly long experimentation, it was determined that sam2p won't
186 # accept : and other chars in the path, no matter how hard I tried to
187 # escape them, hence the chdir (and chdir back, just to be safe)
188 system('sam2p', '-j:quiet', $png_file, 'EPS:', $eps_file ) == 0
189 or die "sam2p failed: $!\n";
193 $params{'barcode_file'} = $eps_file;
196 my @filled_in = $self->print_generic( %params );
198 my $fh = new File::Temp( TEMPLATE => $tmp_template,
202 ) or die "can't open temp file: $!\n";
203 binmode($fh, ':utf8'); # language support
204 print $fh join('', @filled_in );
207 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
208 return ($1, $params{'logo_file'}, $params{'barcode_file'});
214 my $cust_main = $self->cust_main;
215 $cust_main ? $cust_main->agentnum : $self->prospect_main->agentnum;
218 =item print_generic OPTION => VALUE ...
220 Internal method - returns a filled-in template for this invoice as a scalar.
222 See print_ps and print_pdf for methods that return PostScript and PDF output.
230 The B<format> option is required and should be set to html, latex (print and PDF) or template (plaintext).
240 Overrides "Invoice" as the name of the sent document.
244 Used to control the printing of overdue messages. The
245 default is now. It isn't the date of the invoice; that's the `_date' field.
246 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
247 L<Time::Local> and L<Date::Parse> for conversion functions.
251 Logo file (path to temporary EPS file on the local filesystem)
255 CID for inline (emailed) images (logo)
259 Override customer's locale
263 Overrides any per customer cdr squelching when true
267 Supress the (invoice, quotation, statement, etc.) number
275 Supress the payment coupon
279 Barcode file (path to temporary EPS file on the local filesystem)
283 Flag indicating the barcode image should be a link (normal HTML dipaly)
287 Barcode CID for inline (emailed) images
289 =item preref_callback
291 Coderef run for each line item, code should return HTML to be displayed
292 before that line item (quotations only)
296 Dprecated. Used as a suffix for a configuration template. Please
297 don't use this, it deprecated in favor of more flexible alternatives.
303 #what's with all the sprintf('%10.2f')'s in here? will it cause any
304 # (alignment in text invoice?) problems to change them all to '%.2f' ?
305 # yes: fixed width/plain text printing will be borked
307 my( $self, %params ) = @_;
308 my $conf = $self->conf;
310 my $today = $params{today} ? $params{today} : time;
311 warn "$me print_generic called on $self with suffix $params{template}\n"
314 my $format = $params{format};
315 die "Unknown format: $format"
316 unless $format =~ /^(latex|html|template)$/;
318 my $cust_main = $self->cust_main || $self->prospect_main;
319 $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
320 unless $cust_main->payname
321 && $cust_main->payby !~ /^(CARD|DCRD|CHEK|DCHK)$/;
323 my $locale = $params{'locale'} || $cust_main->locale;
325 my %delimiters = ( 'latex' => [ '[@--', '--@]' ],
326 'html' => [ '<%=', '%>' ],
327 'template' => [ '{', '}' ],
330 warn "$me print_generic creating template\n"
333 # set the notice name here, and nowhere else.
334 my $notice_name = $params{notice_name}
335 || $conf->config('notice_name')
336 || $self->notice_name;
339 my $template = $params{template} ? $params{template} : $self->_agent_template;
340 my $templatefile = $self->template_conf. $format;
341 $templatefile .= "_$template"
342 if length($template) && $conf->exists($templatefile."_$template");
345 my @invoice_template = map "$_\n", $conf->config($templatefile)
346 or die "cannot load config data $templatefile";
348 if ( $format eq 'latex' && grep { /^%%Detail/ } @invoice_template ) {
349 #change this to a die when the old code is removed
350 # it's been almost ten years, changing it to a die on the next release.
351 warn "old-style invoice template $templatefile; ".
352 "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
353 #$old_latex = 'true';
354 #@invoice_template = _translate_old_latex_format(@invoice_template);
357 warn "$me print_generic creating T:T object\n"
360 my $text_template = new Text::Template(
362 SOURCE => \@invoice_template,
363 DELIMITERS => $delimiters{$format},
366 warn "$me print_generic compiling T:T object\n"
369 $text_template->compile()
370 or die "Can't compile $templatefile: $Text::Template::ERROR\n";
373 # additional substitution could possibly cause breakage in existing templates
376 'notes' => sub { map "$_", @_ },
377 'footer' => sub { map "$_", @_ },
378 'smallfooter' => sub { map "$_", @_ },
379 'returnaddress' => sub { map "$_", @_ },
380 'coupon' => sub { map "$_", @_ },
381 'summary' => sub { map "$_", @_ },
387 s/%%(.*)$/<!-- $1 -->/g;
388 s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
389 s/\\begin\{enumerate\}/<ol>/g;
391 s/\\end\{enumerate\}/<\/ol>/g;
392 s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
401 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
403 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
409 s/\\hyphenation\{[\w\s\-]+}//;
414 'coupon' => sub { "" },
415 'summary' => sub { "" },
422 s/\\section\*\{\\textsc\{(.*)\}\}/\U$1/g;
423 s/\\begin\{enumerate\}//g;
425 s/\\end\{enumerate\}//g;
426 s/\\textbf\{(.*)\}/$1/g;
433 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
435 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
440 s/\\\\\*?\s*$/\n/; # dubious
441 s/\\hyphenation\{[\w\s\-]+}//;
445 'coupon' => sub { "" },
446 'summary' => sub { "" },
451 # hashes for differing output formats
452 my %nbsps = ( 'latex' => '~',
453 'html' => '', # '&nbps;' would be nice
454 'template' => '', # not used
456 my $nbsp = $nbsps{$format};
458 my %escape_functions = ( 'latex' => \&_latex_escape,
459 'html' => \&_html_escape_nbsp,#\&encode_entities,
460 'template' => sub { shift },
462 my $escape_function = $escape_functions{$format};
463 my $escape_function_nonbsp = ($format eq 'html')
464 ? \&_html_escape : $escape_function;
466 my %newline_tokens = ( 'latex' => '\\\\',
470 my $newline_token = $newline_tokens{$format};
472 warn "$me generating template variables\n"
475 # generate template variables
479 defined( $conf->config_orbase( "invoice_${format}returnaddress",
483 && length( $conf->config_orbase( "invoice_${format}returnaddress",
489 $returnaddress = join("\n",
490 $conf->config_orbase("invoice_${format}returnaddress", $template)
494 $conf->config_orbase('invoice_latexreturnaddress', $template) ) {
496 my $convert_map = $convert_maps{$format}{'returnaddress'};
499 &$convert_map( $conf->config_orbase( "invoice_latexreturnaddress",
504 } elsif ( grep /\S/, $conf->config('company_address', $cust_main->agentnum) ) {
506 my $convert_map = $convert_maps{$format}{'returnaddress'};
507 $returnaddress = join( "\n", &$convert_map(
508 map { s/( {2,})/'~' x length($1)/eg;
512 ( $conf->config('company_name', $cust_main->agentnum),
513 $conf->config('company_address', $cust_main->agentnum),
520 my $warning = "Couldn't find a return address; ".
521 "do you need to set the company_address configuration value?";
523 $returnaddress = $nbsp;
524 #$returnaddress = $warning;
528 warn "$me generating invoice data\n"
531 my $agentnum = $cust_main->agentnum;
536 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
537 'company_address' => join("\n", $conf->config('company_address', $agentnum) ). "\n",
538 'company_phonenum'=> scalar( $conf->config('company_phonenum', $agentnum) ),
539 'returnaddress' => $returnaddress,
540 'agent' => &$escape_function($cust_main->agent->agent),
542 #invoice/quotation info
543 'no_number' => $params{'no_number'},
544 'invnum' => ( $params{'no_number'} ? '' : $self->invnum ),
545 'quotationnum' => $self->quotationnum,
546 'no_date' => $params{'no_date'},
547 '_date' => ( $params{'no_date'} ? '' : $self->_date ),
548 # workaround for inconsistent behavior in the early plain text
549 # templates; see RT#28271
550 'date' => ( $params{'no_date'}
552 : ($format eq 'template'
554 : $self->time2str_local('long', $self->_date, $format)
557 'today' => $self->time2str_local('long', $today, $format),
558 'terms' => $self->terms,
559 'template' => $template, #params{'template'},
560 'notice_name' => $notice_name, # escape?
561 'current_charges' => sprintf("%.2f", $self->charged),
562 'duedate' => $self->due_date2str('rdate'), #date_format?
565 'custnum' => $cust_main->display_custnum,
566 'prospectnum' => $cust_main->prospectnum,
567 'agent_custid' => &$escape_function($cust_main->agent_custid),
568 ( map { $_ => &$escape_function($cust_main->$_()) } qw(
569 payname company address1 address2 city state zip fax
573 'ship_enable' => $cust_main->invoice_ship_address || $conf->exists('invoice-ship_address'),
574 'unitprices' => $conf->exists('invoice-unitprice'),
575 'smallernotes' => $conf->exists('invoice-smallernotes'),
576 'smallerfooter' => $conf->exists('invoice-smallerfooter'),
577 'balance_due_below_line' => $conf->exists('balance_due_below_line'),
579 #layout info -- would be fancy to calc some of this and bury the template
581 'topmargin' => scalar($conf->config('invoice_latextopmargin', $agentnum)),
582 'headsep' => scalar($conf->config('invoice_latexheadsep', $agentnum)),
583 'textheight' => scalar($conf->config('invoice_latextextheight', $agentnum)),
584 'extracouponspace' => scalar($conf->config('invoice_latexextracouponspace', $agentnum)),
585 'couponfootsep' => scalar($conf->config('invoice_latexcouponfootsep', $agentnum)),
586 'verticalreturnaddress' => $conf->exists('invoice_latexverticalreturnaddress', $agentnum),
587 'addresssep' => scalar($conf->config('invoice_latexaddresssep', $agentnum)),
588 'amountenclosedsep' => scalar($conf->config('invoice_latexcouponamountenclosedsep', $agentnum)),
589 'coupontoaddresssep' => scalar($conf->config('invoice_latexcoupontoaddresssep', $agentnum)),
590 'addcompanytoaddress' => $conf->exists('invoice_latexcouponaddcompanytoaddress', $agentnum),
592 # better hang on to conf_dir for a while (for old templates)
593 'conf_dir' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
595 #these are only used when doing paged plaintext
602 $invoice_data{'emt'} = sub { &$escape_function($self->mt(@_)) };
603 # prototype here to silence warnings
604 $invoice_data{'time2str'} = sub ($;$$) { $self->time2str_local(@_, $format) };
606 my $min_sdate = 999999999999;
608 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
609 next unless $cust_bill_pkg->pkgnum > 0;
610 $min_sdate = $cust_bill_pkg->sdate
611 if length($cust_bill_pkg->sdate) && $cust_bill_pkg->sdate < $min_sdate;
612 $max_edate = $cust_bill_pkg->edate
613 if length($cust_bill_pkg->edate) && $cust_bill_pkg->edate > $max_edate;
616 $invoice_data{'bill_period'} = '';
617 $invoice_data{'bill_period'} =
618 $self->time2str_local('%e %h', $min_sdate, $format)
620 $self->time2str_local('%e %h', $max_edate, $format)
621 if ($max_edate != 0 && $min_sdate != 999999999999);
623 $invoice_data{finance_section} = '';
624 if ( $conf->config('finance_pkgclass') ) {
626 qsearchs('pkg_class', { classnum => $conf->config('finance_pkgclass') });
627 $invoice_data{finance_section} = $pkg_class->categoryname;
629 $invoice_data{finance_amount} = '0.00';
630 $invoice_data{finance_section} ||= 'Finance Charges'; #avoid config confusion
632 my $countrydefault = $conf->config('countrydefault') || 'US';
633 foreach ( qw( address1 address2 city state zip country fax) ){
634 my $method = 'ship_'.$_;
635 $invoice_data{"ship_$_"} = $escape_function->($cust_main->$method);
637 if ( length($cust_main->ship_company) ) {
638 $invoice_data{'ship_company'} = $escape_function->($cust_main->ship_company);
640 $invoice_data{'ship_company'} = $escape_function->($cust_main->company);
642 $invoice_data{'ship_contact'} = $escape_function->($cust_main->contact);
643 $invoice_data{'ship_country'} = ''
644 if ( $invoice_data{'ship_country'} eq $countrydefault );
646 $invoice_data{'cid'} = $params{'cid'}
649 if ( $cust_main->country eq $countrydefault ) {
650 $invoice_data{'country'} = '';
652 $invoice_data{'country'} = &$escape_function(code2country($cust_main->country));
656 $invoice_data{'address'} = \@address;
659 ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
660 ? " (P.O. #". $cust_main->payinfo. ")"
664 push @address, $cust_main->company
665 if $cust_main->company;
666 push @address, $cust_main->address1;
667 push @address, $cust_main->address2
668 if $cust_main->address2;
670 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
671 push @address, $invoice_data{'country'}
672 if $invoice_data{'country'};
674 while (scalar(@address) < 5);
676 $invoice_data{'logo_file'} = $params{'logo_file'}
677 if $params{'logo_file'};
678 $invoice_data{'barcode_file'} = $params{'barcode_file'}
679 if $params{'barcode_file'};
680 $invoice_data{'barcode_img'} = $params{'barcode_img'}
681 if $params{'barcode_img'};
682 $invoice_data{'barcode_cid'} = $params{'barcode_cid'}
683 if $params{'barcode_cid'};
685 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
686 # my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
687 #my $balance_due = $self->owed + $pr_total - $cr_total;
688 my $balance_due = $self->owed + $pr_total;
690 # the sum of amount owed on all invoices
691 # (this is used in the summary & on the payment coupon)
692 $invoice_data{'balance'} = sprintf("%.2f", $balance_due);
694 # flag telling this invoice to have a first-page summary
695 my $summarypage = '';
697 if ( $self->custnum && $self->invnum ) {
698 # XXX should be an FS::cust_bill method to set the defaults, instead
699 # of checking the type here
701 # info from customer's last invoice before this one, for some
703 $invoice_data{'last_bill'} = {};
705 my $last_bill = $self->previous_bill;
708 # "balance_date_range" unfortunately is unsuitable for this, since it
709 # cares about application dates. We want to know the sum of all
710 # _top-level transactions_ dated before the last invoice.
712 map "$_ WHERE _date <= ? AND custnum = ?", (
713 "SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill",
714 "SELECT -1 * COALESCE( SUM(amount), 0 ) FROM cust_credit",
715 "SELECT -1 * COALESCE( SUM(paid), 0 ) FROM cust_pay",
716 "SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund",
719 # the customer's current balance immediately after generating the last
722 my $last_bill_balance = $last_bill->charged;
724 my $delta = FS::Record->scalar_sql(
726 $last_bill->_date - 1,
729 $last_bill_balance += $delta;
732 $last_bill_balance = sprintf("%.2f", $last_bill_balance);
734 warn sprintf("LAST BILL: INVNUM %d, DATE %s, BALANCE %.2f\n\n",
736 $self->time2str_local('%D', $last_bill->_date),
739 # ("true_previous_balance" is a terrible name, but at least it's no
740 # longer stored in the database)
741 $invoice_data{'true_previous_balance'} = $last_bill_balance;
743 # the change in balance from immediately after that invoice
744 # to immediately before this one
745 my $before_this_bill_balance = 0;
747 my $delta = FS::Record->scalar_sql(
752 $before_this_bill_balance += $delta;
754 $invoice_data{'balance_adjustments'} =
755 sprintf("%.2f", $last_bill_balance - $before_this_bill_balance);
757 warn sprintf("BALANCE ADJUSTMENTS: %.2f\n\n",
758 $invoice_data{'balance_adjustments'}
761 # the sum of amount owed on all previous invoices
762 # ($pr_total is used elsewhere but not as $previous_balance)
763 $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total);
765 $invoice_data{'last_bill'}{'_date'} = $last_bill->_date; #unformatted
766 my (@payments, @credits);
767 # for formats that itemize previous payments
768 foreach my $cust_pay ( qsearch('cust_pay', {
769 'custnum' => $self->custnum,
770 '_date' => { op => '>=',
771 value => $last_bill->_date }
774 next if $cust_pay->_date > $self->_date;
776 '_date' => $cust_pay->_date,
777 'date' => $self->time2str_local('long', $cust_pay->_date, $format),
778 'payinfo' => $cust_pay->payby_payinfo_pretty,
779 'amount' => sprintf('%.2f', $cust_pay->paid),
781 # not concerned about applications
783 foreach my $cust_credit ( qsearch('cust_credit', {
784 'custnum' => $self->custnum,
785 '_date' => { op => '>=',
786 value => $last_bill->_date }
789 next if $cust_credit->_date > $self->_date;
791 '_date' => $cust_credit->_date,
792 'date' => $self->time2str_local('long', $cust_credit->_date, $format),
793 'creditreason'=> $cust_credit->reason,
794 'amount' => sprintf('%.2f', $cust_credit->amount),
797 $invoice_data{'previous_payments'} = \@payments;
798 $invoice_data{'previous_credits'} = \@credits;
800 # there is no $last_bill
801 $invoice_data{'true_previous_balance'} =
802 $invoice_data{'balance_adjustments'} =
803 $invoice_data{'previous_balance'} = '0.00';
804 $invoice_data{'previous_payments'} = [];
805 $invoice_data{'previous_credits'} = [];
808 if ( $conf->exists('invoice_usesummary', $agentnum) ) {
809 $invoice_data{'summarypage'} = $summarypage = 1;
812 } # if this is an invoice
814 warn "$me substituting variables in notes, footer, smallfooter\n"
817 my $tc = $self->template_conf;
818 my @include = ( [ $tc, 'notes' ],
819 [ 'invoice_', 'footer' ],
820 [ 'invoice_', 'smallfooter', ],
821 [ 'invoice_', 'watermark' ],
823 push @include, [ $tc, 'coupon', ]
824 unless $params{'no_coupon'};
826 foreach my $i (@include) {
828 # load the configuration for this sub-template
830 my($base, $include) = @$i;
832 my $inc_file = $conf->key_orbase("$base$format$include", $template);
834 my @inc_src = $conf->config($inc_file, $agentnum);
836 my $converter = $convert_maps{$format}{$include};
838 # then attempt to convert LaTeX to the requested format
839 $inc_file = $conf->key_orbase($base.'latex'.$include, $template);
840 @inc_src = &$converter( $conf->config($inc_file, $agentnum) );
842 # this isn't included in the convert_maps
843 my ($open, $close) = @{ $delimiters{$format} };
848 } # else @inc_src is empty and that's fine
850 # make a Text::Template out of it
852 my $inc_tt = new Text::Template (
854 SOURCE => [ map "$_\n", @inc_src ],
855 DELIMITERS => $delimiters{$format},
856 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
858 unless ( $inc_tt->compile() ) {
859 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
860 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
866 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
868 $invoice_data{$include} =~ s/\n+$//
869 if ($format eq 'latex');
872 # let invoices use either of these as needed
873 $invoice_data{'po_num'} = ($cust_main->payby eq 'BILL')
874 ? $cust_main->payinfo : '';
875 $invoice_data{'po_line'} =
876 ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
877 ? &$escape_function($self->mt("Purchase Order #").$cust_main->payinfo)
880 my %money_chars = ( 'latex' => '',
881 'html' => $conf->config('money_char') || '$',
884 my $money_char = $money_chars{$format};
887 my %other_money_chars = ( 'latex' => '\dollar ',#XXX should be a config too
888 'html' => $conf->config('money_char') || '$',
891 my $other_money_char = $other_money_chars{$format};
892 $invoice_data{'dollar'} = $other_money_char;
894 my %minus_signs = ( 'latex' => '$-$',
896 'template' => '- ' );
897 my $minus = $minus_signs{$format};
899 my @detail_items = ();
900 my @total_items = ();
904 $invoice_data{'detail_items'} = \@detail_items;
905 $invoice_data{'total_items'} = \@total_items;
906 $invoice_data{'buf'} = \@buf;
907 $invoice_data{'sections'} = \@sections;
909 warn "$me generating sections\n"
912 my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
913 my $multisection = $conf->exists($tc.'sections', $cust_main->agentnum) ||
914 $conf->exists($tc.'sections_by_location', $cust_main->agentnum);
915 $invoice_data{'multisection'} = $multisection;
917 my $extra_sections = [];
918 my $extra_lines = ();
920 # default section ('Charges')
921 my $default_section = { 'description' => '',
926 # Previous Charges section
927 # subtotal is the first return value from $self->previous
928 my $previous_section;
929 # if the invoice has major sections, or if we're summarizing previous
930 # charges with a single line, or if we've been specifically told to put them
931 # in a section, create a section for previous charges:
932 if ( $multisection or
933 $conf->exists('previous_balance-summary_only') or
934 $conf->exists('previous_balance-section') ) {
936 $previous_section = { 'description' => $self->mt('Previous Charges'),
937 'subtotal' => $other_money_char.
938 sprintf('%.2f', $pr_total),
939 'summarized' => '', #why? $summarypage ? 'Y' : '',
941 $previous_section->{posttotal} = '0 / 30 / 60 / 90 days overdue '.
942 join(' / ', map { $cust_main->balance_date_range(@$_) }
943 $self->_prior_month30s
945 if $conf->exists('invoice_include_aging');
948 # otherwise put them in the main section
949 $previous_section = $default_section;
952 my $adjust_section = {
953 'description' => $self->mt('Credits, Payments, and Adjustments'),
954 'adjust_section' => 1,
955 'subtotal' => 0, # adjusted below
957 my $adjust_weight = _pkg_category($adjust_section->{description})
958 ? _pkg_category($adjust_section->{description})->weight
960 $adjust_section->{'summarized'} = ''; #why? $summarypage && !$adjust_weight ? 'Y' : '';
961 # Note: 'sort_weight' here is actually a flag telling whether there is an
962 # explicit package category for the adjust section. If so, certain behavior
964 $adjust_section->{'sort_weight'} = $adjust_weight;
967 if ( $multisection ) {
968 ($extra_sections, $extra_lines) =
969 $self->_items_extra_usage_sections($escape_function_nonbsp, $format)
970 if $conf->exists('usage_class_as_a_section', $cust_main->agentnum)
971 && $self->can('_items_extra_usage_sections');
973 push @$extra_sections, $adjust_section if $adjust_section->{sort_weight};
975 push @detail_items, @$extra_lines if $extra_lines;
977 # the code is written so that both methods can be used together, but
978 # we haven't yet changed the template to take advantage of that, so for
979 # now, treat them as mutually exclusive.
980 my %section_method = ( by_category => 1 );
981 if ( $conf->config($tc.'sections_method') eq 'location' ) {
982 %section_method = ( by_location => 1 );
985 $self->_items_sections( 'summary' => $summarypage,
986 'escape' => $escape_function_nonbsp,
987 'extra_sections' => $extra_sections,
991 push @sections, @$early;
992 $late_sections = $late;
994 if ( $conf->exists('svc_phone_sections')
995 && $self->can('_items_svc_phone_sections')
998 my ($phone_sections, $phone_lines) =
999 $self->_items_svc_phone_sections($escape_function_nonbsp, $format);
1000 push @{$late_sections}, @$phone_sections;
1001 push @detail_items, @$phone_lines;
1003 if ( $conf->exists('voip-cust_accountcode_cdr')
1004 && $cust_main->accountcode_cdr
1005 && $self->can('_items_accountcode_cdr')
1008 my ($accountcode_section, $accountcode_lines) =
1009 $self->_items_accountcode_cdr($escape_function_nonbsp,$format);
1010 if ( scalar(@$accountcode_lines) ) {
1011 push @{$late_sections}, $accountcode_section;
1012 push @detail_items, @$accountcode_lines;
1015 } else {# not multisection
1016 # make a default section
1017 push @sections, $default_section;
1018 # and calculate the finance charge total, since it won't get done otherwise.
1019 # and the default section total
1020 # XXX possibly finance_pkgclass should not be used in this manner?
1021 my @finance_charges;
1023 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1024 if ( $invoice_data{finance_section} and
1025 grep { $_->section eq $invoice_data{finance_section} }
1026 $cust_bill_pkg->cust_bill_pkg_display ) {
1027 # I think these are always setup fees, but just to be sure...
1028 push @finance_charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1030 push @charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1033 $invoice_data{finance_amount} =
1034 sprintf('%.2f', sum( @finance_charges ) || 0);
1035 $default_section->{subtotal} = $other_money_char.
1036 sprintf('%.2f', sum( @charges ) || 0);
1039 # start setting up summary subtotals
1040 my @summary_subtotals;
1041 my $method = $conf->config('summary_subtotals_method');
1042 if ( $method and $method ne $conf->config($tc.'sections_method') ) {
1043 # then re-section them by the correct method
1044 my %section_method = ( by_category => 1 );
1045 if ( $conf->config('summary_subtotals_method') eq 'location' ) {
1046 %section_method = ( by_location => 1 );
1048 my ($early, $late) =
1049 $self->_items_sections( 'summary' => $summarypage,
1050 'escape' => $escape_function_nonbsp,
1051 'extra_sections' => $extra_sections,
1052 'format' => $format,
1055 foreach ( @$early ) {
1056 next if $_->{subtotal} == 0;
1057 $_->{subtotal} = $other_money_char.sprintf('%.2f', $_->{subtotal});
1058 push @summary_subtotals, $_;
1061 # subtotal sectioning is the same as for the actual invoice sections
1062 @summary_subtotals = @sections;
1065 # Hereafter, push sections to both @sections and @summary_subtotals
1066 # if they belong in both places (e.g. tax section). Late sections are
1067 # never in @summary_subtotals.
1069 # previous invoice balances in the Previous Charges section if there
1070 # is one, otherwise in the main detail section
1071 # (except if summary_only is enabled, don't show them at all)
1072 if ( $self->can('_items_previous') &&
1073 $self->enable_previous &&
1074 ! $conf->exists('previous_balance-summary_only') ) {
1076 warn "$me adding previous balances\n"
1079 foreach my $line_item ( $self->_items_previous ) {
1082 ref => $line_item->{'pkgnum'},
1083 pkgpart => $line_item->{'pkgpart'},
1084 #quantity => 1, # not really correct
1085 section => $previous_section, # which might be $default_section
1086 description => &$escape_function($line_item->{'description'}),
1087 ext_description => [ map { &$escape_function($_) }
1088 @{ $line_item->{'ext_description'} || [] }
1090 amount => $money_char . $line_item->{'amount'},
1091 product_code => $line_item->{'pkgpart'} || 'N/A',
1094 push @detail_items, $detail;
1095 push @buf, [ $detail->{'description'},
1096 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1102 if ( @pr_cust_bill && $self->enable_previous ) {
1103 push @buf, ['','-----------'];
1104 push @buf, [ $self->mt('Total Previous Balance'),
1105 $money_char. sprintf("%10.2f", $pr_total) ];
1109 if ( $conf->exists('svc_phone-did-summary') && $self->can('_did_summary') ) {
1110 warn "$me adding DID summary\n"
1113 my ($didsummary,$minutes) = $self->_did_summary;
1114 my $didsummary_desc = 'DID Activity Summary (since last invoice)';
1116 { 'description' => $didsummary_desc,
1117 'ext_description' => [ $didsummary, $minutes ],
1121 foreach my $section (@sections, @$late_sections) {
1123 # begin some normalization
1124 $section->{'subtotal'} = $section->{'amount'}
1126 && !exists($section->{subtotal})
1127 && exists($section->{amount});
1129 $invoice_data{finance_amount} = sprintf('%.2f', $section->{'subtotal'} )
1130 if ( $invoice_data{finance_section} &&
1131 $section->{'description'} eq $invoice_data{finance_section} );
1133 $section->{'subtotal'} = $other_money_char.
1134 sprintf('%.2f', $section->{'subtotal'})
1137 # continue some normalization
1138 $section->{'amount'} = $section->{'subtotal'}
1142 if ( $section->{'description'} ) {
1143 push @buf, ( [ &$escape_function($section->{'description'}), '' ],
1148 warn "$me setting options\n"
1152 $options{'section'} = $section if $multisection;
1153 $options{'format'} = $format;
1154 $options{'escape_function'} = $escape_function;
1155 $options{'no_usage'} = 1 unless $unsquelched;
1156 $options{'unsquelched'} = $unsquelched;
1157 $options{'summary_page'} = $summarypage;
1158 $options{'skip_usage'} =
1159 scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
1160 $options{'preref_callback'} = $params{'preref_callback'};
1162 warn "$me searching for line items\n"
1165 foreach my $line_item ( $self->_items_pkg(%options),
1166 $self->_items_fee(%options) ) {
1168 warn "$me adding line item ".
1169 join(', ', map "$_=>".$line_item->{$_}, keys %$line_item). "\n"
1172 push @buf, ( [ $line_item->{'description'},
1173 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1175 map { [ " ". $_, '' ] } @{$line_item->{'ext_description'}},
1178 $line_item->{'ref'} = $line_item->{'pkgnum'};
1179 $line_item->{'product_code'} = $line_item->{'pkgpart'} || 'N/A'; # mt()?
1180 $line_item->{'section'} = $section;
1181 $line_item->{'description'} = &$escape_function($line_item->{'description'});
1182 $line_item->{'amount'} = $money_char.$line_item->{'amount'};
1184 if ( length($line_item->{'unit_amount'}) ) {
1185 $line_item->{'unit_amount'} = $money_char.$line_item->{'unit_amount'};
1187 $line_item->{'ext_description'} ||= [];
1189 push @detail_items, $line_item;
1192 if ( $section->{'description'} ) {
1193 push @buf, ( ['','-----------'],
1194 [ $section->{'description'}. ' sub-total',
1195 $section->{'subtotal'} # already formatted this
1204 $invoice_data{current_less_finance} =
1205 sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
1207 # if there's anything in the Previous Charges section, prepend it to the list
1208 if ( $pr_total and $previous_section ne $default_section ) {
1209 unshift @sections, $previous_section;
1210 # but not @summary_subtotals
1213 warn "$me adding taxes\n"
1216 # create a tax section if we don't yet have one
1217 my $tax_description = 'Taxes, Surcharges, and Fees';
1219 List::Util::first { $_->{description} eq $tax_description } @sections;
1220 if (!$tax_section) {
1221 $tax_section = { 'description' => $tax_description };
1222 push @sections, $tax_section if $multisection;
1224 $tax_section->{tax_section} = 1; # mark this section as containing taxes
1225 # if this is an existing tax section, we're merging the tax items into it.
1226 # grab the taxtotal that's already there, strip the money symbol if any
1227 my $taxtotal = $tax_section->{'subtotal'} || 0;
1228 $taxtotal =~ s/^\Q$other_money_char\E//;
1231 #my $tax_weight = _pkg_category($tax_section->{description})
1232 # ? _pkg_category($tax_section->{description})->weight
1234 #$tax_section->{'summarized'} = ''; #why? $summarypage && !$tax_weight ? 'Y' : '';
1235 #$tax_section->{'sort_weight'} = $tax_weight;
1237 my @items_tax = $self->_items_tax;
1238 foreach my $tax ( @items_tax ) {
1240 $taxtotal += $tax->{'amount'};
1242 my $description = &$escape_function( $tax->{'description'} );
1243 my $amount = sprintf( '%.2f', $tax->{'amount'} );
1245 if ( $multisection ) {
1247 push @detail_items, {
1248 ext_description => [],
1251 description => $description,
1252 amount => $money_char. $amount,
1254 section => $tax_section,
1259 push @total_items, {
1260 'total_item' => $description,
1261 'total_amount' => $other_money_char. $amount,
1266 push @buf,[ $description,
1267 $money_char. $amount,
1274 $total->{'total_item'} = $self->mt('Sub-total');
1275 $total->{'total_amount'} =
1276 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
1278 if ( $multisection ) {
1279 if ( $taxtotal > 0 ) {
1280 # there are taxes, so prepare the section to be displayed.
1281 # $taxtotal already includes any line items that were already in the
1282 # section (fees, taxes that are charged as packages for some reason).
1283 # also set 'summarized' to false so that this isn't a summary-only
1285 $tax_section->{'subtotal'} = $other_money_char.
1286 sprintf('%.2f', $taxtotal);
1287 $tax_section->{'pretotal'} = 'New charges sub-total '.
1288 $total->{'total_amount'};
1289 $tax_section->{'description'} = $self->mt($tax_description);
1290 $tax_section->{'summarized'} = '';
1292 # append it if it's not already there
1293 if ( !grep $tax_section, @sections ) {
1294 push @sections, $tax_section;
1295 push @summary_subtotals, $tax_section;
1300 unshift @total_items, $total;
1303 $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
1309 my %embolden_functions = (
1310 'latex' => sub { return '\textbf{'. shift(). '}' },
1311 'html' => sub { return '<b>'. shift(). '</b>' },
1312 'template' => sub { shift },
1314 my $embolden_function = $embolden_functions{$format};
1316 if ( $multisection ) {
1318 if ( $adjust_section->{'sort_weight'} ) {
1319 $adjust_section->{'posttotal'} = $self->mt('Balance Forward').' '.
1320 $other_money_char. sprintf("%.2f", ($self->billing_balance || 0) );
1322 $adjust_section->{'pretotal'} = $self->mt('New charges total').' '.
1323 $other_money_char. sprintf('%.2f', $self->charged );
1328 if ( $self->can('_items_total') ) { # should always be true now
1330 # even for multisection, need plain text version
1332 my @new_total_items = $self->_items_total;
1334 push @buf,['','-----------'];
1336 foreach ( @new_total_items ) {
1337 my ($item, $amount) = ($_->{'total_item'}, $_->{'total_amount'});
1338 $_->{'total_item'} = &$embolden_function( $item );
1339 $_->{'total_amount'} = &$embolden_function( $other_money_char.$amount );
1340 # but if it's multisection, don't append to @total_items. the adjust
1341 # section has all this stuff
1342 push @total_items, $_ if !$multisection;
1343 push @buf, [ $item, $money_char.sprintf('%10.2f',$amount) ];
1346 push @buf, [ '', '' ];
1348 # if we're showing previous invoices, also show previous
1349 # credits and payments
1350 if ( $self->enable_previous
1351 and $self->can('_items_credits')
1352 and $self->can('_items_payments') )
1356 my $credittotal = 0;
1357 foreach my $credit (
1358 $self->_items_credits( 'template' => $template, 'trim_len' => 40 )
1362 $total->{'total_item'} = &$escape_function($credit->{'description'});
1363 $credittotal += $credit->{'amount'};
1364 $total->{'total_amount'} = $minus.$other_money_char.$credit->{'amount'};
1365 if ( $multisection ) {
1366 push @detail_items, {
1367 ext_description => [],
1370 description => &$escape_function($credit->{'description'}),
1371 amount => $money_char . $credit->{'amount'},
1373 section => $adjust_section,
1376 push @total_items, $total;
1380 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
1383 foreach my $credit (
1384 $self->_items_credits( 'template' => $template, 'trim_len'=>32 )
1386 push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
1390 my $paymenttotal = 0;
1391 foreach my $payment (
1392 $self->_items_payments( 'template' => $template )
1395 $total->{'total_item'} = &$escape_function($payment->{'description'});
1396 $paymenttotal += $payment->{'amount'};
1397 $total->{'total_amount'} = $minus.$other_money_char.$payment->{'amount'};
1398 if ( $multisection ) {
1399 push @detail_items, {
1400 ext_description => [],
1403 description => &$escape_function($payment->{'description'}),
1404 amount => $money_char . $payment->{'amount'},
1406 section => $adjust_section,
1409 push @total_items, $total;
1411 push @buf, [ $payment->{'description'},
1412 $money_char. sprintf("%10.2f", $payment->{'amount'}),
1415 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
1417 if ( $multisection ) {
1418 $adjust_section->{'subtotal'} = $other_money_char.
1419 sprintf('%.2f', $credittotal + $paymenttotal);
1421 #why this? because {sort_weight} forces the adjust_section to appear
1422 #in @extra_sections instead of @sections. obviously.
1423 push @sections, $adjust_section
1424 unless $adjust_section->{sort_weight};
1425 # do not summarize; adjustments there are shown according to
1429 # create Balance Due message
1432 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1433 $total->{'total_amount'} =
1434 &$embolden_function(
1435 $other_money_char. sprintf('%.2f', #why? $summarypage
1436 # ? $self->charged +
1437 # $self->billing_balance
1439 $self->owed + $pr_total
1442 if ( $multisection && !$adjust_section->{sort_weight} ) {
1443 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
1444 $total->{'total_amount'};
1446 push @total_items, $total;
1448 push @buf,['','-----------'];
1449 push @buf,[$self->balance_due_msg, $money_char.
1450 sprintf("%10.2f", $balance_due ) ];
1453 if ( $conf->exists('previous_balance-show_credit')
1454 and $cust_main->balance < 0 ) {
1455 my $credit_total = {
1456 'total_item' => &$embolden_function($self->credit_balance_msg),
1457 'total_amount' => &$embolden_function(
1458 $other_money_char. sprintf('%.2f', -$cust_main->balance)
1461 if ( $multisection ) {
1462 $adjust_section->{'posttotal'} .= $newline_token .
1463 $credit_total->{'total_item'} . ' ' . $credit_total->{'total_amount'};
1466 push @total_items, $credit_total;
1468 push @buf,['','-----------'];
1469 push @buf,[$self->credit_balance_msg, $money_char.
1470 sprintf("%10.2f", -$cust_main->balance ) ];
1474 } #end of default total adding ! can('_items_total')
1476 if ( $multisection ) {
1477 if ( $conf->exists('svc_phone_sections')
1478 && $self->can('_items_svc_phone_sections')
1482 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1483 $total->{'total_amount'} =
1484 &$embolden_function(
1485 $other_money_char. sprintf('%.2f', $self->owed + $pr_total)
1487 my $last_section = pop @sections;
1488 $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
1489 $total->{'total_amount'};
1490 push @sections, $last_section;
1492 push @sections, @$late_sections
1496 # make a discounts-available section, even without multisection
1497 if ( $conf->exists('discount-show_available')
1498 and my @discounts_avail = $self->_items_discounts_avail ) {
1499 my $discount_section = {
1500 'description' => $self->mt('Discounts Available'),
1505 push @sections, $discount_section; # do not summarize
1506 push @detail_items, map { +{
1507 'ref' => '', #should this be something else?
1508 'section' => $discount_section,
1509 'description' => &$escape_function( $_->{description} ),
1510 'amount' => $money_char . &$escape_function( $_->{amount} ),
1511 'ext_description' => [ &$escape_function($_->{ext_description}) || () ],
1512 } } @discounts_avail;
1515 # not adding any more sections after this
1516 $invoice_data{summary_subtotals} = \@summary_subtotals;
1519 if ( $conf->exists('usage_class_summary')
1520 and $self->can('_items_usage_class_summary') ) {
1521 my @usage_subtotals = $self->_items_usage_class_summary(escape => $escape_function, 'money_char' => $other_money_char);
1522 if ( @usage_subtotals ) {
1523 unshift @sections, $usage_subtotals[0]->{section}; # do not summarize
1524 unshift @detail_items, @usage_subtotals;
1528 # invoice history "section" (not really a section)
1529 # not to be included in any subtotals, completely independent of
1531 if ( $conf->exists('previous_invoice_history') and $cust_main->isa('FS::cust_main') ) {
1534 foreach my $cust_bill ( $cust_main->cust_bill ) {
1535 # XXX hardcoded format, and currently only 'charged'; add other fields
1536 # if they become necessary
1537 my $date = $self->time2str_local('%b %Y', $cust_bill->_date);
1538 $history{$date} ||= 0;
1539 $history{$date} += $cust_bill->charged;
1540 # just so we have a numeric sort key
1541 $monthorder{$date} ||= $cust_bill->_date;
1543 my @sorted_months = sort { $monthorder{$a} <=> $monthorder{$b} }
1545 my @sorted_amounts = map { sprintf('%.2f', $history{$_}) } @sorted_months;
1546 $invoice_data{monthly_history} = [ \@sorted_months, \@sorted_amounts ];
1549 # service locations: another option for template customization
1551 foreach my $item (@detail_items) {
1552 if ( $item->{locationnum} ) {
1553 $location_info{ $item->{locationnum} } ||= {
1554 FS::cust_location->by_key( $item->{locationnum} )->location_hash
1558 $invoice_data{location_info} = \%location_info;
1560 # debugging hook: call this with 'diag' => 1 to just get a hash of
1561 # the invoice variables
1562 return \%invoice_data if ( $params{'diag'} );
1564 # All sections and items are built; now fill in templates.
1565 my @includelist = ();
1566 push @includelist, 'summary' if $summarypage;
1567 foreach my $include ( @includelist ) {
1569 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
1572 if ( length( $conf->config($inc_file, $agentnum) ) ) {
1574 @inc_src = $conf->config($inc_file, $agentnum);
1578 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
1580 my $convert_map = $convert_maps{$format}{$include};
1582 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
1583 s/--\@\]/$delimiters{$format}[1]/g;
1586 &$convert_map( $conf->config($inc_file, $agentnum) );
1590 my $inc_tt = new Text::Template (
1592 SOURCE => [ map "$_\n", @inc_src ],
1593 DELIMITERS => $delimiters{$format},
1594 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
1596 unless ( $inc_tt->compile() ) {
1597 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
1598 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
1602 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
1604 $invoice_data{$include} =~ s/\n+$//
1605 if ($format eq 'latex');
1610 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1611 /invoice_lines\((\d*)\)/;
1612 $invoice_lines += $1 || scalar(@buf);
1615 die "no invoice_lines() functions in template?"
1616 if ( $format eq 'template' && !$wasfunc );
1618 if ($format eq 'template') {
1620 if ( $invoice_lines ) {
1621 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
1622 $invoice_data{'total_pages'}++
1623 if scalar(@buf) % $invoice_lines;
1626 #setup subroutine for the template
1627 $invoice_data{invoice_lines} = sub {
1628 my $lines = shift || scalar(@buf);
1640 push @collect, split("\n",
1641 $text_template->fill_in( HASH => \%invoice_data )
1643 $invoice_data{'page'}++;
1645 map "$_\n", @collect;
1647 } else { # this is where we actually create the invoice
1649 warn "filling in template for invoice ". $self->invnum. "\n"
1651 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
1654 $text_template->fill_in(HASH => \%invoice_data);
1658 sub notice_name { '('.shift->table.')'; }
1660 sub template_conf { 'invoice_'; }
1662 # helper routine for generating date ranges
1663 sub _prior_month30s {
1666 [ 1, 2592000 ], # 0-30 days ago
1667 [ 2592000, 5184000 ], # 30-60 days ago
1668 [ 5184000, 7776000 ], # 60-90 days ago
1669 [ 7776000, 0 ], # 90+ days ago
1672 map { [ $_->[0] ? $self->_date - $_->[0] - 1 : '',
1673 $_->[1] ? $self->_date - $_->[1] - 1 : '',
1678 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
1680 Returns an postscript invoice, as a scalar.
1682 Options can be passed as a hashref (recommended) or as a list of time, template
1683 and then any key/value pairs for any other options.
1685 I<time> an optional value used to control the printing of overdue messages. The
1686 default is now. It isn't the date of the invoice; that's the `_date' field.
1687 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1688 L<Time::Local> and L<Date::Parse> for conversion functions.
1690 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1697 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1698 my $ps = generate_ps($file);
1700 unlink($barcodefile) if $barcodefile;
1705 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
1707 Returns an PDF invoice, as a scalar.
1709 Options can be passed as a hashref (recommended) or as a list of time, template
1710 and then any key/value pairs for any other options.
1712 I<time> an optional value used to control the printing of overdue messages. The
1713 default is now. It isn't the date of the invoice; that's the `_date' field.
1714 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1715 L<Time::Local> and L<Date::Parse> for conversion functions.
1717 I<template>, if specified, is the name of a suffix for alternate invoices.
1719 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1726 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1727 my $pdf = generate_pdf($file);
1729 unlink($barcodefile) if $barcodefile;
1734 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
1736 Returns an HTML invoice, as a scalar.
1738 I<time> an optional value used to control the printing of overdue messages. The
1739 default is now. It isn't the date of the invoice; that's the `_date' field.
1740 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1741 L<Time::Local> and L<Date::Parse> for conversion functions.
1743 I<template>, if specified, is the name of a suffix for alternate invoices.
1745 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1747 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
1748 when emailing the invoice as part of a multipart/related MIME email.
1756 %params = %{ shift() };
1760 $params{'format'} = 'html';
1762 $self->print_generic( %params );
1765 # quick subroutine for print_latex
1767 # There are ten characters that LaTeX treats as special characters, which
1768 # means that they do not simply typeset themselves:
1769 # # $ % & ~ _ ^ \ { }
1771 # TeX ignores blanks following an escaped character; if you want a blank (as
1772 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
1776 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
1777 $value =~ s/([<>])/\$$1\$/g;
1783 encode_entities($value);
1787 sub _html_escape_nbsp {
1788 my $value = _html_escape(shift);
1789 $value =~ s/ +/ /g;
1793 #utility methods for print_*
1795 sub _translate_old_latex_format {
1796 warn "_translate_old_latex_format called\n"
1803 if ( $line =~ /^%%Detail\s*$/ ) {
1805 push @template, q![@--!,
1806 q! foreach my $_tr_line (@detail_items) {!,
1807 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
1808 q! $_tr_line->{'description'} .= !,
1809 q! "\\tabularnewline\n~~".!,
1810 q! join( "\\tabularnewline\n~~",!,
1811 q! @{$_tr_line->{'ext_description'}}!,
1815 while ( ( my $line_item_line = shift )
1816 !~ /^%%EndDetail\s*$/ ) {
1817 $line_item_line =~ s/'/\\'/g; # nice LTS
1818 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1819 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1820 push @template, " \$OUT .= '$line_item_line';";
1823 push @template, '}',
1826 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1828 push @template, '[@--',
1829 ' foreach my $_tr_line (@total_items) {';
1831 while ( ( my $total_item_line = shift )
1832 !~ /^%%EndTotalDetails\s*$/ ) {
1833 $total_item_line =~ s/'/\\'/g; # nice LTS
1834 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1835 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1836 push @template, " \$OUT .= '$total_item_line';";
1839 push @template, '}',
1843 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
1844 push @template, $line;
1850 warn "$_\n" foreach @template;
1862 my $conf = $self->conf;
1864 #check for an invoice-specific override
1865 return $self->invoice_terms if $self->invoice_terms;
1867 #check for a customer- specific override
1868 my $cust_main = $self->cust_main;
1869 return $cust_main->invoice_terms if $cust_main && $cust_main->invoice_terms;
1873 $agentnum = $cust_main->agentnum;
1874 } elsif ( my $prospect_main = $self->prospect_main ) {
1875 $agentnum = $prospect_main->agentnum;
1878 #use configured default
1879 $conf->config('invoice_default_terms', $agentnum) || '';
1889 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1890 $duedate = $self->_date() + ( $1 * 86400 );
1901 $self->due_date ? $self->time2str_local(shift, $self->due_date) : '';
1904 =item balance_due_msg
1908 sub balance_due_msg {
1910 my $msg = $self->mt('Balance Due');
1911 return $msg unless $self->terms; # huh?
1912 if ( !$self->conf->exists('invoice_show_prior_due_date')
1913 or $self->conf->exists('invoice_sections') ) {
1914 # if enabled, the due date is shown with Total New Charges (see
1915 # _items_total) and not here
1916 # (yes, or if invoice_sections is enabled; this is just for compatibility)
1917 if ( $self->due_date ) {
1918 $msg .= ' - ' . $self->mt('Please pay by'). ' '.
1919 $self->due_date2str('short');
1920 } elsif ( $self->terms ) {
1921 $msg .= ' - '. $self->mt($self->terms);
1927 =item balance_due_date
1931 sub balance_due_date {
1933 my $conf = $self->conf;
1935 my $terms = $self->terms;
1936 if ( $terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1937 $duedate = $self->time2str_local('rdate', $self->_date + ($1*86400) );
1942 sub credit_balance_msg {
1944 $self->mt('Credit Balance Remaining')
1949 Returns a string with the date, for example: "3/20/2008", localized for the
1950 customer. Use _date_pretty_unlocalized for non-end-customer display use.
1956 $self->time2str_local('short', $self->_date);
1959 =item _date_pretty_unlocalized
1961 Returns a string with the date, for example: "3/20/2008", in the format
1962 configured for the back-office. Use _date_pretty for end-customer display use.
1966 sub _date_pretty_unlocalized {
1968 time2str($date_format, $self->_date);
1973 Emails this template.
1975 Options are passed as a hashref. Available options:
1981 If specified, overrides the default From: address.
1985 If specified, overrides the name of the sent document ("Invoice" or "Quotation")
1989 (Deprecated) If specified, is the name of a suffix for alternate template files.
1993 Options accepted by generate_email can also be used.
1999 my $opt = shift || {};
2000 if ($opt and !ref($opt)) {
2001 die ref($self). '->email called with positional parameters';
2004 return if $self->hide;
2006 my $error = send_email(
2007 $self->generate_email(
2008 'subject' => $self->email_subject($opt->{template}),
2009 %$opt, # template, etc.
2013 die "can't email: $error\n" if $error;
2016 =item generate_email OPTION => VALUE ...
2024 sender address, required
2028 alternate template name, optional
2032 email subject, optional
2036 notice name instead of "Invoice", optional
2040 Returns an argument list to be passed to L<FS::Misc::send_email>.
2046 sub generate_email {
2050 my $conf = $self->conf;
2052 my $me = '[FS::Template_Mixin::generate_email]';
2055 'from' => $args{'from'},
2056 'subject' => ($args{'subject'} || $self->email_subject),
2057 'custnum' => $self->custnum,
2058 'msgtype' => 'invoice',
2061 $args{'unsquelch_cdr'} = $conf->exists('voip-cdr_email');
2063 my $cust_main = $self->cust_main;
2065 if (ref($args{'to'}) eq 'ARRAY') {
2066 $return{'to'} = $args{'to'};
2067 } elsif ( $cust_main ) {
2068 $return{'to'} = [ $cust_main->invoicing_list_emailonly ];
2071 my $tc = $self->template_conf;
2073 my @text; # array of lines
2074 my $html; # a big string
2075 my @related_parts; # will contain the text/HTML alternative, and images
2076 my $related; # will contain the multipart/related object
2078 if ( $conf->exists($tc. 'email_pdf') ) {
2079 if ( my $msgnum = $conf->config($tc.'email_pdf_msgnum') ) {
2081 warn "$me using '${tc}email_pdf_msgnum' in multipart message"
2084 my $msg_template = FS::msg_template->by_key($msgnum)
2085 or die "${tc}email_pdf_msgnum $msgnum not found\n";
2086 my %prepared = $msg_template->prepare(
2087 cust_main => $self->cust_main,
2091 @text = split(/(?=\n)/, $prepared{'text_body'});
2092 $html = $prepared{'html_body'};
2094 } elsif ( my @note = $conf->config($tc.'email_pdf_note') ) {
2096 warn "$me using '${tc}email_pdf_note' in multipart message"
2098 @text = $conf->config($tc.'email_pdf_note');
2099 $html = join('<BR>', @text);
2101 } # else use the plain text invoice
2106 if ( $conf->config($tc.'template') ) {
2108 warn "$me generating plain text invoice"
2111 # 'print_text' argument is no longer used
2112 @text = $self->print_text(\%args);
2116 warn "$me no plain text version exists; sending empty message body"
2123 my $text_part = build MIME::Entity (
2124 'Type' => 'text/plain',
2125 'Encoding' => 'quoted-printable',
2126 'Charset' => 'UTF-8',
2127 #'Encoding' => '7bit',
2129 'Disposition' => 'inline',
2134 if ( $conf->exists($tc.'html') ) {
2135 warn "$me generating HTML invoice"
2138 $args{'from'} =~ /\@([\w\.\-]+)/;
2139 my $from = $1 || 'example.com';
2140 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2143 my $agentnum = $cust_main ? $cust_main->agentnum
2144 : $self->prospect_main->agentnum;
2145 if ( defined($args{'template'}) && length($args{'template'})
2146 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
2149 $logo = 'logo_'. $args{'template'}. '.png';
2153 my $image_data = $conf->config_binary( $logo, $agentnum);
2155 push @related_parts, build MIME::Entity
2156 'Type' => 'image/png',
2157 'Encoding' => 'base64',
2158 'Data' => $image_data,
2159 'Filename' => 'logo.png',
2160 'Content-ID' => "<$content_id>",
2163 if ( ref($self) eq 'FS::cust_bill' && $conf->exists('invoice-barcode') ) {
2164 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2165 push @related_parts, build MIME::Entity
2166 'Type' => 'image/png',
2167 'Encoding' => 'base64',
2168 'Data' => $self->invoice_barcode(0),
2169 'Filename' => 'barcode.png',
2170 'Content-ID' => "<$barcode_content_id>",
2172 $args{'barcode_cid'} = $barcode_content_id;
2175 $html = $self->print_html({ 'cid'=>$content_id, %args });
2182 warn "$me creating HTML/text multipart message"
2185 $return{'nobody'} = 1;
2187 my $alternative = build MIME::Entity
2188 'Type' => 'multipart/alternative',
2189 #'Encoding' => '7bit',
2190 'Disposition' => 'inline'
2194 $alternative->add_part($text_part);
2197 $alternative->attach(
2198 'Type' => 'text/html',
2199 'Encoding' => 'quoted-printable',
2200 'Data' => [ '<html>',
2203 ' '. encode_entities($return{'subject'}),
2206 ' <body bgcolor="#e8e8e8">',
2211 'Disposition' => 'inline',
2212 #'Filename' => 'invoice.pdf',
2215 unshift @related_parts, $alternative;
2217 $related = build MIME::Entity 'Type' => 'multipart/related',
2218 'Encoding' => '7bit';
2220 #false laziness w/Misc::send_email
2221 $related->head->replace('Content-type',
2222 $related->mime_type.
2223 '; boundary="'. $related->head->multipart_boundary. '"'.
2224 '; type=multipart/alternative'
2227 $related->add_part($_) foreach @related_parts;
2231 my @otherparts = ();
2232 if ( ref($self) eq 'FS::cust_bill' && $cust_main->email_csv_cdr ) {
2234 push @otherparts, build MIME::Entity
2235 'Type' => 'text/csv',
2236 'Encoding' => '7bit',
2237 'Data' => [ map { "$_\n" }
2238 $self->call_details('prepend_billed_number' => 1)
2240 'Disposition' => 'attachment',
2241 'Filename' => 'usage-'. $self->invnum. '.csv',
2246 if ( $conf->exists($tc.'email_pdf') ) {
2251 # multipart/alternative
2257 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%args);
2258 push @otherparts, $pdf;
2262 $return{'content-type'} = 'multipart/mixed'; # of the outer container
2264 $return{'mimeparts'} = [ $related, @otherparts ];
2265 $return{'type'} = 'multipart/related'; # of the first part
2267 $return{'mimeparts'} = [ $text_part, @otherparts ];
2268 $return{'type'} = 'text/plain';
2270 } elsif ( $html ) { # no PDF or CSV, strip the outer container
2271 $return{'mimeparts'} = \@related_parts;
2272 $return{'content-type'} = 'multipart/related';
2273 $return{'type'} = 'multipart/alternative';
2274 } else { # no HTML either
2275 $return{'body'} = \@text;
2276 $return{'content-type'} = 'text/plain';
2285 Returns a list suitable for passing to MIME::Entity->build(), representing
2286 this invoice as PDF attachment.
2293 'Type' => 'application/pdf',
2294 'Encoding' => 'base64',
2295 'Data' => [ $self->print_pdf(@_) ],
2296 'Disposition' => 'attachment',
2297 'Filename' => 'invoice-'. $self->invnum. '.pdf',
2301 =item _items_sections OPTIONS
2303 Generate section information for all items appearing on this invoice.
2304 This will only be called for multi-section invoices.
2306 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
2307 related display records (L<FS::cust_bill_pkg_display>) and organize
2308 them into two groups ("early" and "late" according to whether they come
2309 before or after the total), then into sections. A subtotal is calculated
2312 Section descriptions are returned in sort weight order. Each consists
2313 of a hash containing:
2315 description: the package category name, escaped
2316 subtotal: the total charges in that section
2317 tax_section: a flag indicating that the section contains only tax charges
2318 summarized: same as tax_section, for some reason
2319 sort_weight: the package category's sort weight
2321 If 'condense' is set on the display record, it also contains everything
2322 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
2323 coderefs to generate parts of the invoice. This is not advised.
2325 The method returns two arrayrefs, one of "early" sections and one of "late"
2328 OPTIONS may include:
2330 by_location: a flag to divide the invoice into sections by location.
2331 Each section hash will have a 'location' element containing a hashref of
2332 the location fields (see L<FS::cust_location>). The section description
2333 will be the location label, but the template can use any of the location
2334 fields to create a suitable label.
2336 by_category: a flag to divide the invoice into sections using display
2337 records (see L<FS::cust_bill_pkg_display>). This is the "traditional"
2338 behavior. Each section hash will have a 'category' element containing
2339 the section name from the display record (which probably equals the
2340 category name of the package, but may not in some cases).
2342 summary: a flag indicating that this is a summary-format invoice.
2343 Turning this on has the following effects:
2344 - Ignores display items with the 'summary' flag.
2345 - Places all sections in the "early" group even if they have post_total.
2346 - Creates sections for all non-disabled package categories, even if they
2347 have no charges on this invoice, as well as a section with no name.
2349 escape: an escape function to use for section titles.
2351 extra_sections: an arrayref of additional sections to return after the
2352 sorted list. If there are any of these, section subtotals exclude
2355 format: 'latex', 'html', or 'template' (i.e. text). Not used, but
2356 passed through to C<_condense_section()>.
2360 use vars qw(%pkg_category_cache);
2361 sub _items_sections {
2365 my $escape = $opt{escape};
2366 my @extra_sections = @{ $opt{extra_sections} || [] };
2368 # $subtotal{$locationnum}{$categoryname} = amount.
2369 # if we're not using by_location, $locationnum is undef.
2370 # if we're not using by_category, you guessed it, $categoryname is undef.
2371 # if we're not using either one, we shouldn't be here in the first place...
2373 my %late_subtotal = ();
2376 # About tax items + multisection invoices:
2377 # If either invoice_*summary option is enabled, AND there is a
2378 # package category with the name of the tax, then there will be
2379 # a display record assigning the tax item to that category.
2381 # However, the taxes are always placed in the "Taxes, Surcharges,
2382 # and Fees" section regardless of that. The only effect of the
2383 # display record is to create a subtotal for the summary page.
2386 my $pkg_hash = $self->cust_pkg_hash;
2388 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2391 my $usage = $cust_bill_pkg->usage;
2394 if ( $opt{by_location} ) {
2395 if ( $cust_bill_pkg->pkgnum ) {
2396 $locationnum = $pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum;
2401 $locationnum = undef;
2404 # as in _items_cust_pkg, if a line item has no display records,
2405 # cust_bill_pkg_display() returns a default record for it
2407 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
2408 next if ( $display->summary && $opt{summary} );
2410 my $section = $display->section;
2411 my $type = $display->type;
2412 # Set $section = undef if we're sectioning by location and this
2413 # line item _has_ a location (i.e. isn't a fee).
2414 $section = undef if $locationnum;
2416 # set this flag if the section is not tax-only
2417 $not_tax{$locationnum}{$section} = 1
2418 if $cust_bill_pkg->pkgnum or $cust_bill_pkg->feepart;
2420 # there's actually a very important piece of logic buried in here:
2421 # incrementing $late_subtotal{$section} CREATES
2422 # $late_subtotal{$section}. keys(%late_subtotal) is later used
2423 # to define the list of late sections, and likewise keys(%subtotal).
2424 # When _items_cust_bill_pkg is called to generate line items for
2425 # real, it will be called with 'section' => $section for each
2427 if ( $display->post_total && !$opt{summary} ) {
2428 if (! $type || $type eq 'S') {
2429 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2430 if $cust_bill_pkg->setup != 0
2431 || $cust_bill_pkg->setup_show_zero;
2435 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur
2436 if $cust_bill_pkg->recur != 0
2437 || $cust_bill_pkg->recur_show_zero;
2440 if ($type && $type eq 'R') {
2441 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2442 if $cust_bill_pkg->recur != 0
2443 || $cust_bill_pkg->recur_show_zero;
2446 if ($type && $type eq 'U') {
2447 $late_subtotal{$locationnum}{$section} += $usage
2448 unless scalar(@extra_sections);
2451 } else { # it's a pre-total (normal) section
2453 # skip tax items unless they're explicitly included in a section
2454 next if $cust_bill_pkg->pkgnum == 0 and
2455 ! $cust_bill_pkg->feepart and
2458 if ( $type eq 'S' ) {
2459 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2460 if $cust_bill_pkg->setup != 0
2461 || $cust_bill_pkg->setup_show_zero;
2462 } elsif ( $type eq 'R' ) {
2463 $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2464 if $cust_bill_pkg->recur != 0
2465 || $cust_bill_pkg->recur_show_zero;
2466 } elsif ( $type eq 'U' ) {
2467 $subtotal{$locationnum}{$section} += $usage
2468 unless scalar(@extra_sections);
2469 } elsif ( !$type ) {
2470 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2471 + $cust_bill_pkg->recur;
2480 %pkg_category_cache = ();
2482 # summary invoices need subtotals for all non-disabled package categories,
2483 # even if they're zero
2484 # but currently assume that there are no location sections, or at least
2485 # that the summary page doesn't care about them
2486 if ( $opt{summary} ) {
2487 foreach my $category (qsearch('pkg_category', {disabled => ''})) {
2488 $subtotal{''}{$category->categoryname} ||= 0;
2490 $subtotal{''}{''} ||= 0;
2494 foreach my $post_total (0,1) {
2496 my $s = $post_total ? \%late_subtotal : \%subtotal;
2497 foreach my $locationnum (keys %$s) {
2498 foreach my $sectionname (keys %{ $s->{$locationnum} }) {
2500 'subtotal' => $s->{$locationnum}{$sectionname},
2503 if ( $locationnum ) {
2504 $section->{'locationnum'} = $locationnum;
2505 my $location = FS::cust_location->by_key($locationnum);
2506 $section->{'description'} = &{ $escape }($location->location_label);
2507 # Better ideas? This will roughly group them by proximity,
2508 # which alpha sorting on any of the address fields won't.
2509 # Sorting by locationnum is meaningless.
2510 # We have to sort on _something_ or the order may change
2511 # randomly from one invoice to the next, which will confuse
2513 $section->{'sort_weight'} = sprintf('%012s',$location->zip) .
2515 $section->{'location'} = {
2516 label_prefix => &{ $escape }($location->label_prefix),
2517 map { $_ => &{ $escape }($location->get($_)) }
2521 $section->{'category'} = $sectionname;
2522 $section->{'description'} = &{ $escape }($sectionname);
2523 if ( _pkg_category($sectionname) ) {
2524 $section->{'sort_weight'} = _pkg_category($sectionname)->weight;
2525 if ( _pkg_category($sectionname)->condense ) {
2526 $section = { %$section, $self->_condense_section($opt{format}) };
2530 if ( !$post_total and !$not_tax{$locationnum}{$sectionname} ) {
2531 # then it's a tax-only section
2532 $section->{'summarized'} = 'Y';
2533 $section->{'tax_section'} = 'Y';
2535 push @these, $section;
2536 } # foreach $sectionname
2537 } #foreach $locationnum
2538 push @these, @extra_sections if $post_total == 0;
2539 # need an alpha sort for location sections, because postal codes can
2541 $sections[ $post_total ] = [ sort {
2542 $opt{'by_location'} ?
2543 ($a->{sort_weight} cmp $b->{sort_weight}) :
2544 ($a->{sort_weight} <=> $b->{sort_weight})
2546 } #foreach $post_total
2548 return @sections; # early, late
2551 #helper subs for above
2555 $self->{cust_pkg} ||= { map { $_->pkgnum => $_ } $self->cust_pkg };
2559 my $categoryname = shift;
2560 $pkg_category_cache{$categoryname} ||=
2561 qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
2564 my %condensed_format = (
2565 'label' => [ qw( Description Qty Amount ) ],
2567 sub { shift->{description} },
2568 sub { shift->{quantity} },
2569 sub { my($href, %opt) = @_;
2570 ($opt{dollar} || ''). $href->{amount};
2573 'align' => [ qw( l r r ) ],
2574 'span' => [ qw( 5 1 1 ) ], # unitprices?
2575 'width' => [ qw( 10.7cm 1.4cm 1.6cm ) ], # don't like this
2578 sub _condense_section {
2579 my ( $self, $format ) = ( shift, shift );
2581 map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
2582 qw( description_generator
2585 total_line_generator
2590 sub _condensed_generator_defaults {
2591 my ( $self, $format ) = ( shift, shift );
2592 return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
2601 sub _condensed_header_generator {
2602 my ( $self, $format ) = ( shift, shift );
2604 my ( $f, $prefix, $suffix, $separator, $column ) =
2605 _condensed_generator_defaults($format);
2607 if ($format eq 'latex') {
2608 $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
2609 $suffix = "\\\\\n\\hline";
2612 sub { my ($d,$a,$s,$w) = @_;
2613 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2615 } elsif ( $format eq 'html' ) {
2616 $prefix = '<th></th>';
2620 sub { my ($d,$a,$s,$w) = @_;
2621 return qq!<th align="$html_align{$a}">$d</th>!;
2629 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2631 &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
2634 $prefix. join($separator, @result). $suffix;
2639 sub _condensed_description_generator {
2640 my ( $self, $format ) = ( shift, shift );
2642 my ( $f, $prefix, $suffix, $separator, $column ) =
2643 _condensed_generator_defaults($format);
2645 my $money_char = '$';
2646 if ($format eq 'latex') {
2647 $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
2649 $separator = " & \n";
2651 sub { my ($d,$a,$s,$w) = @_;
2652 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2654 $money_char = '\\dollar';
2655 }elsif ( $format eq 'html' ) {
2656 $prefix = '"><td align="center"></td>';
2660 sub { my ($d,$a,$s,$w) = @_;
2661 return qq!<td align="$html_align{$a}">$d</td>!;
2663 #$money_char = $conf->config('money_char') || '$';
2664 $money_char = ''; # this is madness
2672 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2674 $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
2676 &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
2677 map { $f->{$_}->[$i] } qw(align span width)
2681 $prefix. join( $separator, @result ). $suffix;
2686 sub _condensed_total_generator {
2687 my ( $self, $format ) = ( shift, shift );
2689 my ( $f, $prefix, $suffix, $separator, $column ) =
2690 _condensed_generator_defaults($format);
2693 if ($format eq 'latex') {
2696 $separator = " & \n";
2698 sub { my ($d,$a,$s,$w) = @_;
2699 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2701 }elsif ( $format eq 'html' ) {
2705 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2707 sub { my ($d,$a,$s,$w) = @_;
2708 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2717 # my $r = &{$f->{fields}->[$i]}(@args);
2718 # $r .= ' Total' unless $i;
2720 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2722 &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
2723 map { $f->{$_}->[$i] } qw(align span width)
2727 $prefix. join( $separator, @result ). $suffix;
2732 =item total_line_generator FORMAT
2734 Returns a coderef used for generation of invoice total line items for this
2735 usage_class. FORMAT is either html or latex
2739 # should not be used: will have issues with hash element names (description vs
2740 # total_item and amount vs total_amount -- another array of functions?
2742 sub _condensed_total_line_generator {
2743 my ( $self, $format ) = ( shift, shift );
2745 my ( $f, $prefix, $suffix, $separator, $column ) =
2746 _condensed_generator_defaults($format);
2749 if ($format eq 'latex') {
2752 $separator = " & \n";
2754 sub { my ($d,$a,$s,$w) = @_;
2755 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2757 }elsif ( $format eq 'html' ) {
2761 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2763 sub { my ($d,$a,$s,$w) = @_;
2764 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2773 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2775 &{$column}( &{$f->{fields}->[$i]}(@args),
2776 map { $f->{$_}->[$i] } qw(align span width)
2780 $prefix. join( $separator, @result ). $suffix;
2785 =item _items_pkg [ OPTIONS ]
2787 Return line item hashes for each package item on this invoice. Nearly
2790 $self->_items_cust_bill_pkg([ $self->cust_bill_pkg ])
2792 OPTIONS are passed through to _items_cust_bill_pkg, and should include
2793 'format' and 'escape_function' at minimum.
2795 To produce items for a specific invoice section, OPTIONS should include
2796 'section', a hashref containing 'category' and/or 'locationnum' keys.
2798 'section' may also contain a key named 'condensed'. If this is present
2799 and has a true value, _items_pkg will try to merge identical items into items
2800 with 'quantity' equal to the number of items (not the sum of their separate
2801 quantities, for some reason).
2807 # The order of these is important. Bundled line items will be merged into
2808 # the most recent non-hidden item, so it needs to be the one with:
2810 # - the same start date
2811 # - no pkgpart_override
2813 # So: sort by pkgnum,
2815 # then sort the base line item before any overrides
2816 # then sort hidden before non-hidden add-ons
2817 # then sort by override pkgpart (for consistency)
2818 sort { $a->pkgnum <=> $b->pkgnum or
2819 $a->sdate <=> $b->sdate or
2820 ($a->pkgpart_override ? 0 : -1) or
2821 ($b->pkgpart_override ? 0 : 1) or
2822 $b->hidden cmp $a->hidden or
2823 $a->pkgpart_override <=> $b->pkgpart_override
2825 # and of course exclude taxes and fees
2826 grep { $_->pkgnum > 0 } $self->cust_bill_pkg;
2832 my @cust_bill_pkg = grep { $_->feepart } $self->cust_bill_pkg;
2833 my $escape_function = $options{escape_function};
2836 foreach my $cust_bill_pkg (@cust_bill_pkg) {
2837 # cache this, so we don't look it up again in every section
2838 my $part_fee = $cust_bill_pkg->get('part_fee')
2839 || $cust_bill_pkg->part_fee;
2840 $cust_bill_pkg->set('part_fee', $part_fee);
2842 #die "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n"; # might make more sense
2843 warn "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n";
2846 if ( exists($options{section}) and exists($options{section}{category}) )
2848 my $categoryname = $options{section}{category};
2849 # then filter for items that have that section
2850 if ( $part_fee->categoryname ne $categoryname ) {
2851 warn "skipping fee '".$part_fee->itemdesc."'--not in section $categoryname\n" if $DEBUG;
2854 } # otherwise include them all in the main section
2855 # XXX what to do when sectioning by location?
2858 my %base_invnums; # invnum => invoice date
2859 foreach ($cust_bill_pkg->cust_bill_pkg_fee) {
2860 if ($_->base_invnum) {
2861 # XXX what if base_bill has been voided?
2862 my $base_bill = FS::cust_bill->by_key($_->base_invnum);
2863 my $base_date = $self->time2str_local('short', $base_bill->_date)
2865 $base_invnums{$_->base_invnum} = $base_date || '';
2868 foreach (sort keys(%base_invnums)) {
2869 next if $_ == $self->invnum;
2870 # per convention, we must escape ext_description lines
2872 &{$escape_function}(
2873 $self->mt('from invoice #[_1] on [_2]', $_, $base_invnums{$_})
2876 my $desc = $part_fee->itemdesc_locale($self->cust_main->locale);
2877 # but not escape the base description line
2880 { feepart => $cust_bill_pkg->feepart,
2881 amount => sprintf('%.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
2882 description => $desc,
2883 ext_description => \@ext_desc
2894 warn "$me _items_pkg searching for all package line items\n"
2897 my @cust_bill_pkg = $self->_items_nontax;
2899 warn "$me _items_pkg filtering line items\n"
2901 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2903 if ($options{section} && $options{section}->{condensed}) {
2905 warn "$me _items_pkg condensing section\n"
2909 local $Storable::canonical = 1;
2910 foreach ( @items ) {
2912 delete $item->{ref};
2913 delete $item->{ext_description};
2914 my $key = freeze($item);
2915 $itemshash{$key} ||= 0;
2916 $itemshash{$key} ++; # += $item->{quantity};
2918 @items = sort { $a->{description} cmp $b->{description} }
2919 map { my $i = thaw($_);
2920 $i->{quantity} = $itemshash{$_};
2922 sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
2928 warn "$me _items_pkg returning ". scalar(@items). " items\n"
2935 return 0 unless $a->itemdesc cmp $b->itemdesc;
2936 return -1 if $b->itemdesc eq 'Tax';
2937 return 1 if $a->itemdesc eq 'Tax';
2938 return -1 if $b->itemdesc eq 'Other surcharges';
2939 return 1 if $a->itemdesc eq 'Other surcharges';
2940 $a->itemdesc cmp $b->itemdesc;
2945 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum and ! $_->feepart }
2946 $self->cust_bill_pkg;
2947 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2949 if ( $self->conf->exists('always_show_tax') ) {
2950 my $itemdesc = $self->conf->config('always_show_tax') || 'Tax';
2951 if (0 == grep { $_->{description} eq $itemdesc } @items) {
2953 { 'description' => $itemdesc,
2960 =item _items_cust_bill_pkg CUST_BILL_PKGS OPTIONS
2962 Takes an arrayref of L<FS::cust_bill_pkg> objects, and returns a
2963 list of hashrefs describing the line items they generate on the invoice.
2965 OPTIONS may include:
2967 format: the invoice format.
2969 escape_function: the function used to escape strings.
2971 DEPRECATED? (expensive, mostly unused?)
2972 format_function: the function used to format CDRs.
2974 section: a hashref containing 'category' and/or 'locationnum'; if this
2975 is present, only returns line items that belong to that category and/or
2976 location (whichever is defined).
2978 multisection: a flag indicating that this is a multisection invoice,
2979 which does something complicated.
2981 preref_callback: coderef run for each line item, code should return HTML to be
2982 displayed before that line item (quotations only)
2984 Returns a list of hashrefs, each of which may contain:
2986 pkgnum, description, amount, unit_amount, quantity, pkgpart, _is_setup, and
2987 ext_description, which is an arrayref of detail lines to show below
2992 sub _items_cust_bill_pkg {
2994 my $conf = $self->conf;
2995 my $cust_bill_pkgs = shift;
2998 my $format = $opt{format} || '';
2999 my $escape_function = $opt{escape_function} || sub { shift };
3000 my $format_function = $opt{format_function} || '';
3001 my $no_usage = $opt{no_usage} || '';
3002 my $unsquelched = $opt{unsquelched} || ''; #unused
3003 my ($section, $locationnum, $category);
3004 if ( $opt{section} ) {
3005 $category = $opt{section}->{category};
3006 $locationnum = $opt{section}->{locationnum};
3008 my $summary_page = $opt{summary_page} || ''; #unused
3009 my $multisection = defined($category) || defined($locationnum);
3010 # this variable is the value of the config setting, not whether it applies
3011 # to this particular line item.
3012 my $discount_show_always = $conf->exists('discount-show-always');
3014 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 40;
3016 my $cust_main = $self->cust_main;#for per-agent cust_bill-line_item-ate_style
3018 # for location labels: use default location on the invoice date
3019 my $default_locationnum;
3020 if ( $self->custnum ) {
3022 my @h_search = FS::h_cust_main->sql_h_search($self->_date);
3023 $h_cust_main = qsearchs({
3024 'table' => 'h_cust_main',
3025 'hashref' => { custnum => $self->custnum },
3026 'extra_sql' => $h_search[1],
3027 'addl_from' => $h_search[3],
3029 $default_locationnum = $h_cust_main->ship_locationnum;
3030 } elsif ( $self->prospectnum ) {
3031 my $cust_location = qsearchs('cust_location',
3032 { prospectnum => $self->prospectnum,
3034 $default_locationnum = $cust_location->locationnum if $cust_location;
3037 my @b = (); # accumulator for the line item hashes that we'll return
3038 my ($s, $r, $u, $d) = ( undef, undef, undef, undef );
3039 # the 'current' line item hashes for setup, recur, usage, discount
3040 foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
3042 # if the current line item is waiting to go out, and the one we're about
3043 # to start is not bundled, then push out the current one and start a new
3045 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3046 if ( $_ && !$cust_bill_pkg->hidden ) {
3047 $_->{amount} = sprintf( "%.2f", $_->{amount} );
3048 $_->{amount} =~ s/^\-0\.00$/0.00/;
3049 if (exists($_->{unit_amount})) {
3050 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3053 # we already decided to create this display line; don't reconsider it
3055 # if $_->{amount} != 0
3056 # || $discount_show_always
3057 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3058 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3064 if ( $locationnum ) {
3065 # this is a location section; skip packages that aren't at this
3067 next if $cust_bill_pkg->pkgnum == 0; # skips fees...
3068 next if $self->cust_pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum
3072 # Consider display records for this item to determine if it belongs
3073 # in this section. Note that if there are no display records, there
3074 # will be a default pseudo-record that includes all charge types
3075 # and has no section name.
3076 my @cust_bill_pkg_display = $cust_bill_pkg->can('cust_bill_pkg_display')
3077 ? $cust_bill_pkg->cust_bill_pkg_display
3078 : ( $cust_bill_pkg );
3080 warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
3081 $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
3084 if ( defined($category) ) {
3085 # then this is a package category section; process all display records
3086 # that belong to this section.
3087 @cust_bill_pkg_display = grep { $_->section eq $category }
3088 @cust_bill_pkg_display;
3090 # otherwise, process all display records that aren't usage summaries
3091 # (I don't think there should be usage summaries if you aren't using
3092 # category sections, but this is the historical behavior)
3093 @cust_bill_pkg_display = grep { !$_->summary }
3094 @cust_bill_pkg_display;
3097 my $classname = ''; # package class name, will fill in later
3099 foreach my $display (@cust_bill_pkg_display) {
3101 warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
3102 $display->billpkgdisplaynum. "\n"
3105 my $type = $display->type;
3107 my $desc = $cust_bill_pkg->desc( $cust_main ? $cust_main->locale : '' );
3108 $desc = substr($desc, 0, $maxlength). '...'
3109 if $format eq 'latex' && length($desc) > $maxlength;
3111 my %details_opt = ( 'format' => $format,
3112 'escape_function' => $escape_function,
3113 'format_function' => $format_function,
3114 'no_usage' => $opt{'no_usage'},
3117 if ( ref($cust_bill_pkg) eq 'FS::quotation_pkg' ) {
3118 # XXX this should be pulled out into quotation_pkg
3120 warn "$me _items_cust_bill_pkg cust_bill_pkg is quotation_pkg\n"
3122 # quotation_pkgs are never fees, so don't worry about the case where
3123 # part_pkg is undefined
3125 # and I guess they're never bundled either?
3126 if ( $cust_bill_pkg->setup != 0 ) {
3127 my $description = $desc;
3128 $description .= ' Setup'
3129 if $cust_bill_pkg->recur != 0
3130 || $discount_show_always
3131 || $cust_bill_pkg->recur_show_zero;
3133 # keep it consistent, please
3135 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref
3136 'description' => $description,
3137 'amount' => sprintf("%.2f", $cust_bill_pkg->setup),
3138 'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitsetup),
3139 'quantity' => $cust_bill_pkg->quantity,
3140 'preref_html' => ( $opt{preref_callback}
3141 ? &{ $opt{preref_callback} }( $cust_bill_pkg )
3146 if ( $cust_bill_pkg->recur != 0 ) {
3149 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref
3150 'description' => "$desc (". $cust_bill_pkg->part_pkg->freq_pretty.")",
3151 'amount' => sprintf("%.2f", $cust_bill_pkg->recur),
3152 'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitrecur),
3153 'quantity' => $cust_bill_pkg->quantity,
3154 'preref_html' => ( $opt{preref_callback}
3155 ? &{ $opt{preref_callback} }( $cust_bill_pkg )
3161 } elsif ( $cust_bill_pkg->pkgnum > 0 ) {
3162 # a "normal" package line item (not a quotation, not a fee, not a tax)
3164 warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
3167 my $cust_pkg = $cust_bill_pkg->cust_pkg;
3168 my $part_pkg = $cust_pkg->part_pkg;
3170 # which pkgpart to show for display purposes?
3171 my $pkgpart = $cust_bill_pkg->pkgpart_override || $cust_pkg->pkgpart;
3173 # start/end dates for invoice formats that do nonstandard
3175 my %item_dates = ();
3176 %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate')
3177 unless $part_pkg->option('disable_line_item_date_ranges',1);
3179 # not normally used, but pass this to the template anyway
3180 $classname = $part_pkg->classname;
3182 if ( (!$type || $type eq 'S')
3183 && ( $cust_bill_pkg->setup != 0
3184 || $cust_bill_pkg->setup_show_zero
3185 || ($discount_show_always and $cust_bill_pkg->unitsetup > 0)
3190 warn "$me _items_cust_bill_pkg adding setup\n"
3193 # append the word 'Setup' to the setup line if there's going to be
3194 # a recur line for the same package (i.e. not a one-time charge)
3195 my $description = $desc;
3196 $description .= ' Setup'
3197 if $cust_bill_pkg->recur != 0
3198 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3199 || $cust_bill_pkg->recur_show_zero;
3201 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3203 if $part_pkg->is_prepaid #for prepaid, "display the validity period
3204 # triggered by the recurring charge freq
3206 && $cust_bill_pkg->recur == 0
3207 && ! $cust_bill_pkg->recur_show_zero;
3212 # always pass the svc_label through to the template, even if
3213 # not displaying it as an ext_description
3214 my @svc_labels = map &{$escape_function}($_),
3215 $cust_pkg->h_labels_short($self->_date, undef, 'I');
3217 $svc_label = $svc_labels[0];
3219 unless ( $cust_pkg->part_pkg->hide_svc_detail
3220 || $cust_bill_pkg->hidden )
3223 push @d, @svc_labels
3224 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3225 # show the location label if it's not the customer's default
3226 # location, and we're not grouping items by location already
3227 if ( $cust_pkg->locationnum != $default_locationnum
3228 and !defined($locationnum) ) {
3229 my $loc = $cust_pkg->location_label;
3230 $loc = substr($loc, 0, $maxlength). '...'
3231 if $format eq 'latex' && length($loc) > $maxlength;
3232 push @d, &{$escape_function}($loc);
3235 } #unless hiding service details
3237 push @d, $cust_bill_pkg->details(%details_opt)
3238 if $cust_bill_pkg->recur == 0;
3240 if ( $cust_bill_pkg->hidden ) {
3241 $s->{amount} += $cust_bill_pkg->setup;
3242 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
3243 push @{ $s->{ext_description} }, @d;
3247 description => $description,
3248 pkgpart => $pkgpart,
3249 pkgnum => $cust_bill_pkg->pkgnum,
3250 amount => $cust_bill_pkg->setup,
3251 setup_show_zero => $cust_bill_pkg->setup_show_zero,
3252 unit_amount => $cust_bill_pkg->unitsetup,
3253 quantity => $cust_bill_pkg->quantity,
3254 ext_description => \@d,
3255 svc_label => ($svc_label || ''),
3256 locationnum => $cust_pkg->locationnum, # sure, why not?
3262 # should we show a recur line?
3263 # if type eq 'S', then NO, because we've been told not to.
3264 # otherwise, show the recur line if:
3265 # - there's a recurring charge
3266 # - or recur_show_zero is on
3267 # - or there's a positive unitrecur (so it's been discounted to zero)
3268 # and discount-show-always is on
3269 if ( ( !$type || $type eq 'R' || $type eq 'U' )
3271 $cust_bill_pkg->recur != 0
3273 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3274 || $cust_bill_pkg->recur_show_zero
3279 warn "$me _items_cust_bill_pkg adding recur/usage\n"
3282 my $is_summary = $display->summary;
3283 my $description = $desc;
3284 if ( $type eq 'U' and defined($r) ) {
3285 # don't just show the same description as the recur line
3286 $description = $self->mt('Usage charges');
3289 my $part_pkg = $cust_pkg->part_pkg;
3291 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3295 my @seconds = (); # for display of usage info
3298 #at least until cust_bill_pkg has "past" ranges in addition to
3299 #the "future" sdate/edate ones... see #3032
3300 my @dates = ( $self->_date );
3301 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
3302 push @dates, $prev->sdate if $prev;
3303 push @dates, undef if !$prev;
3305 my @svc_labels = map &{$escape_function}($_),
3306 $cust_pkg->h_labels_short(@dates, 'I');
3307 $svc_label = $svc_labels[0];
3309 # show service labels, unless...
3310 # the package is set not to display them
3311 unless ( $part_pkg->hide_svc_detail
3312 # or this is a tax-like line item
3313 || $cust_bill_pkg->itemdesc
3314 # or this is a hidden (bundled) line item
3315 || $cust_bill_pkg->hidden
3316 # or this is a usage summary line
3317 || $is_summary && $type && $type eq 'U'
3318 # or this is a usage line and there's a recurring line
3319 # for the package in the same section (which will
3320 # have service labels already)
3321 || ($type eq 'U' and defined($r))
3325 warn "$me _items_cust_bill_pkg adding service details\n"
3328 push @d, @svc_labels
3329 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3330 warn "$me _items_cust_bill_pkg done adding service details\n"
3333 # show the location label if it's not the customer's default
3334 # location, and we're not grouping items by location already
3335 if ( $cust_pkg->locationnum != $default_locationnum
3336 and !defined($locationnum) ) {
3337 my $loc = $cust_pkg->location_label;
3338 $loc = substr($loc, 0, $maxlength). '...'
3339 if $format eq 'latex' && length($loc) > $maxlength;
3340 push @d, &{$escape_function}($loc);
3343 # Display of seconds_since_sqlradacct:
3344 # On the invoice, when processing @detail_items, look for a field
3345 # named 'seconds'. This will contain total seconds for each
3346 # service, in the same order as @ext_description. For services
3347 # that don't support this it will show undef.
3348 if ( $conf->exists('svc_acct-usage_seconds')
3349 and ! $cust_bill_pkg->pkgpart_override ) {
3350 foreach my $cust_svc (
3351 $cust_pkg->h_cust_svc(@dates, 'I')
3354 # eval because not having any part_export_usage exports
3355 # is a fatal error, last_bill/_date because that's how
3356 # sqlradius_hour billing does it
3358 $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
3360 push @seconds, $sec;
3362 } #if svc_acct-usage_seconds
3364 } # if we are showing service labels
3366 unless ( $is_summary ) {
3367 warn "$me _items_cust_bill_pkg adding details\n"
3370 #instead of omitting details entirely in this case (unwanted side
3371 # effects), just omit CDRs
3372 $details_opt{'no_usage'} = 1
3373 if $type && $type eq 'R';
3375 push @d, $cust_bill_pkg->details(%details_opt);
3378 warn "$me _items_cust_bill_pkg calculating amount\n"
3383 $amount = $cust_bill_pkg->recur;
3384 } elsif ($type eq 'R') {
3385 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
3386 } elsif ($type eq 'U') {
3387 $amount = $cust_bill_pkg->usage;
3390 if ( !$type || $type eq 'R' ) {
3392 warn "$me _items_cust_bill_pkg adding recur\n"
3396 ( $cust_bill_pkg->unitrecur > 0 ) ? $cust_bill_pkg->unitrecur
3399 if ( $cust_bill_pkg->hidden ) {
3400 $r->{amount} += $amount;
3401 $r->{unit_amount} += $unit_amount;
3402 push @{ $r->{ext_description} }, @d;
3405 description => $description,
3406 pkgpart => $pkgpart,
3407 pkgnum => $cust_bill_pkg->pkgnum,
3409 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3410 unit_amount => $unit_amount,
3411 quantity => $cust_bill_pkg->quantity,
3413 ext_description => \@d,
3414 svc_label => ($svc_label || ''),
3415 locationnum => $cust_pkg->locationnum,
3417 $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
3420 } else { # $type eq 'U'
3422 warn "$me _items_cust_bill_pkg adding usage\n"
3425 if ( $cust_bill_pkg->hidden and defined($u) ) {
3426 # if this is a hidden package and there's already a usage
3427 # line for the bundle, add this package's total amount and
3428 # usage details to it
3429 $u->{amount} += $amount;
3430 push @{ $u->{ext_description} }, @d;
3431 } elsif ( $amount ) {
3432 # create a new usage line
3434 description => $description,
3435 pkgpart => $pkgpart,
3436 pkgnum => $cust_bill_pkg->pkgnum,
3439 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3441 ext_description => \@d,
3442 locationnum => $cust_pkg->locationnum,
3444 } # else this has no usage, so don't create a usage section
3447 } # recurring or usage with recurring charge
3449 } else { # taxes and fees
3451 warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
3454 # items of this kind should normally not have sdate/edate.
3456 'description' => $desc,
3457 'amount' => sprintf('%.2f', $cust_bill_pkg->setup
3458 + $cust_bill_pkg->recur)
3461 } # if quotation / package line item / other line item
3463 # decide whether to show active discounts here
3465 # case 1: we are showing a single line for the package
3467 # case 2: we are showing a setup line for a package that has
3468 # no base recurring fee
3469 or ( $type eq 'S' and $cust_bill_pkg->unitrecur == 0 )
3470 # case 3: we are showing a recur line for a package that has
3471 # a base recurring fee
3472 or ( $type eq 'R' and $cust_bill_pkg->unitrecur > 0 )
3475 my $item_discount = $cust_bill_pkg->_item_discount;
3476 if ( $item_discount ) {
3477 # $item_discount->{amount} is negative
3479 if ( $d and $cust_bill_pkg->hidden ) {
3480 $d->{amount} += $item_discount->{amount};
3482 $d = $item_discount;
3483 $_ = &{$escape_function}($_) foreach @{ $d->{ext_description} };
3486 # update the active line (before the discount) to show the
3487 # original price (whether this is a hidden line or not)
3489 # quotation discounts keep track of setup and recur; invoice
3490 # discounts currently don't
3491 if ( exists $item_discount->{setup_amount} ) {
3493 $s->{amount} -= $item_discount->{setup_amount} if $s;
3494 $r->{amount} -= $item_discount->{recur_amount} if $r;
3498 # $active_line is the line item hashref for the line that will
3499 # show the original price
3500 # (use the recur or single line for the package, unless we're
3501 # showing a setup line for a package with no recurring fee)
3502 my $active_line = $r;
3503 if ( $type eq 'S' ) {
3506 $active_line->{amount} -= $item_discount->{amount};
3510 } # if there are any discounts
3511 } # if this is an appropriate place to show discounts
3513 } # foreach $display
3517 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3519 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
3520 if exists($_->{amount});
3521 $_->{amount} =~ s/^\-0\.00$/0.00/;
3522 if (exists($_->{unit_amount})) {
3523 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3527 #if $_->{amount} != 0
3528 # || $discount_show_always
3529 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3530 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3534 warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
3541 =item _items_discounts_avail
3543 Returns an array of line item hashrefs representing available term discounts
3544 for this invoice. This makes the same assumptions that apply to term
3545 discounts in general: that the package is billed monthly, at a flat rate,
3546 with no usage charges. A prorated first month will be handled, as will
3547 a setup fee if the discount is allowed to apply to setup fees.
3551 sub _items_discounts_avail {
3554 #maybe move this method from cust_bill when quotations support discount_plans
3555 return () unless $self->can('discount_plans');
3556 my %plans = $self->discount_plans;
3558 my $list_pkgnums = 0; # if any packages are not eligible for all discounts
3559 $list_pkgnums = grep { $_->list_pkgnums } values %plans;
3563 my $plan = $plans{$months};
3565 my $term_total = sprintf('%.2f', $plan->discounted_total);
3566 my $percent = sprintf('%.0f',
3567 100 * (1 - $term_total / $plan->base_total) );
3568 my $permonth = sprintf('%.2f', $term_total / $months);
3569 my $detail = $self->mt('discount on item'). ' '.
3570 join(', ', map { "#$_" } $plan->pkgnums)
3573 # discounts for non-integer months don't work anyway
3574 $months = sprintf("%d", $months);
3577 description => $self->mt('Save [_1]% by paying for [_2] months',
3579 amount => $self->mt('[_1] ([_2] per month)',
3580 $term_total, $money_char.$permonth),
3581 ext_description => ($detail || ''),
3584 sort { $b <=> $a } keys %plans;