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', ],
822 push @include, [ $tc, 'coupon', ]
823 unless $params{'no_coupon'};
825 foreach my $i (@include) {
827 my($base, $include) = @$i;
829 my $inc_file = $conf->key_orbase("$base$format$include", $template);
832 if ( $conf->exists($inc_file, $agentnum)
833 && length( $conf->config($inc_file, $agentnum) ) ) {
835 @inc_src = $conf->config($inc_file, $agentnum);
839 $inc_file = $conf->key_orbase("${base}latex$include", $template);
841 my $convert_map = $convert_maps{$format}{$include};
843 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
844 s/--\@\]/$delimiters{$format}[1]/g;
847 &$convert_map( $conf->config($inc_file, $agentnum) );
851 my $inc_tt = new Text::Template (
853 SOURCE => [ map "$_\n", @inc_src ],
854 DELIMITERS => $delimiters{$format},
855 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
857 unless ( $inc_tt->compile() ) {
858 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
859 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
863 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
865 $invoice_data{$include} =~ s/\n+$//
866 if ($format eq 'latex');
869 # let invoices use either of these as needed
870 $invoice_data{'po_num'} = ($cust_main->payby eq 'BILL')
871 ? $cust_main->payinfo : '';
872 $invoice_data{'po_line'} =
873 ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
874 ? &$escape_function($self->mt("Purchase Order #").$cust_main->payinfo)
877 my %money_chars = ( 'latex' => '',
878 'html' => $conf->config('money_char') || '$',
881 my $money_char = $money_chars{$format};
884 my %other_money_chars = ( 'latex' => '\dollar ',#XXX should be a config too
885 'html' => $conf->config('money_char') || '$',
888 my $other_money_char = $other_money_chars{$format};
889 $invoice_data{'dollar'} = $other_money_char;
891 my %minus_signs = ( 'latex' => '$-$',
893 'template' => '- ' );
894 my $minus = $minus_signs{$format};
896 my @detail_items = ();
897 my @total_items = ();
901 $invoice_data{'detail_items'} = \@detail_items;
902 $invoice_data{'total_items'} = \@total_items;
903 $invoice_data{'buf'} = \@buf;
904 $invoice_data{'sections'} = \@sections;
906 warn "$me generating sections\n"
909 my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
910 my $multisection = $conf->exists($tc.'sections', $cust_main->agentnum) ||
911 $conf->exists($tc.'sections_by_location', $cust_main->agentnum);
912 $invoice_data{'multisection'} = $multisection;
914 my $extra_sections = [];
915 my $extra_lines = ();
917 # default section ('Charges')
918 my $default_section = { 'description' => '',
923 # Previous Charges section
924 # subtotal is the first return value from $self->previous
925 my $previous_section;
926 # if the invoice has major sections, or if we're summarizing previous
927 # charges with a single line, or if we've been specifically told to put them
928 # in a section, create a section for previous charges:
929 if ( $multisection or
930 $conf->exists('previous_balance-summary_only') or
931 $conf->exists('previous_balance-section') ) {
933 $previous_section = { 'description' => $self->mt('Previous Charges'),
934 'subtotal' => $other_money_char.
935 sprintf('%.2f', $pr_total),
936 'summarized' => '', #why? $summarypage ? 'Y' : '',
938 $previous_section->{posttotal} = '0 / 30 / 60 / 90 days overdue '.
939 join(' / ', map { $cust_main->balance_date_range(@$_) }
940 $self->_prior_month30s
942 if $conf->exists('invoice_include_aging');
945 # otherwise put them in the main section
946 $previous_section = $default_section;
949 my $adjust_section = {
950 'description' => $self->mt('Credits, Payments, and Adjustments'),
951 'adjust_section' => 1,
952 'subtotal' => 0, # adjusted below
954 my $adjust_weight = _pkg_category($adjust_section->{description})
955 ? _pkg_category($adjust_section->{description})->weight
957 $adjust_section->{'summarized'} = ''; #why? $summarypage && !$adjust_weight ? 'Y' : '';
958 # Note: 'sort_weight' here is actually a flag telling whether there is an
959 # explicit package category for the adjust section. If so, certain behavior
961 $adjust_section->{'sort_weight'} = $adjust_weight;
964 if ( $multisection ) {
965 ($extra_sections, $extra_lines) =
966 $self->_items_extra_usage_sections($escape_function_nonbsp, $format)
967 if $conf->exists('usage_class_as_a_section', $cust_main->agentnum)
968 && $self->can('_items_extra_usage_sections');
970 push @$extra_sections, $adjust_section if $adjust_section->{sort_weight};
972 push @detail_items, @$extra_lines if $extra_lines;
974 # the code is written so that both methods can be used together, but
975 # we haven't yet changed the template to take advantage of that, so for
976 # now, treat them as mutually exclusive.
977 my %section_method = ( by_category => 1 );
978 if ( $conf->config($tc.'sections_method') eq 'location' ) {
979 %section_method = ( by_location => 1 );
982 $self->_items_sections( 'summary' => $summarypage,
983 'escape' => $escape_function_nonbsp,
984 'extra_sections' => $extra_sections,
988 push @sections, @$early;
989 $late_sections = $late;
991 if ( $conf->exists('svc_phone_sections')
992 && $self->can('_items_svc_phone_sections')
995 my ($phone_sections, $phone_lines) =
996 $self->_items_svc_phone_sections($escape_function_nonbsp, $format);
997 push @{$late_sections}, @$phone_sections;
998 push @detail_items, @$phone_lines;
1000 if ( $conf->exists('voip-cust_accountcode_cdr')
1001 && $cust_main->accountcode_cdr
1002 && $self->can('_items_accountcode_cdr')
1005 my ($accountcode_section, $accountcode_lines) =
1006 $self->_items_accountcode_cdr($escape_function_nonbsp,$format);
1007 if ( scalar(@$accountcode_lines) ) {
1008 push @{$late_sections}, $accountcode_section;
1009 push @detail_items, @$accountcode_lines;
1012 } else {# not multisection
1013 # make a default section
1014 push @sections, $default_section;
1015 # and calculate the finance charge total, since it won't get done otherwise.
1016 # and the default section total
1017 # XXX possibly finance_pkgclass should not be used in this manner?
1018 my @finance_charges;
1020 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1021 if ( $invoice_data{finance_section} and
1022 grep { $_->section eq $invoice_data{finance_section} }
1023 $cust_bill_pkg->cust_bill_pkg_display ) {
1024 # I think these are always setup fees, but just to be sure...
1025 push @finance_charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1027 push @charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1030 $invoice_data{finance_amount} =
1031 sprintf('%.2f', sum( @finance_charges ) || 0);
1032 $default_section->{subtotal} = $other_money_char.
1033 sprintf('%.2f', sum( @charges ) || 0);
1036 # start setting up summary subtotals
1037 my @summary_subtotals;
1038 my $method = $conf->config('summary_subtotals_method');
1039 if ( $method and $method ne $conf->config($tc.'sections_method') ) {
1040 # then re-section them by the correct method
1041 my %section_method = ( by_category => 1 );
1042 if ( $conf->config('summary_subtotals_method') eq 'location' ) {
1043 %section_method = ( by_location => 1 );
1045 my ($early, $late) =
1046 $self->_items_sections( 'summary' => $summarypage,
1047 'escape' => $escape_function_nonbsp,
1048 'extra_sections' => $extra_sections,
1049 'format' => $format,
1052 foreach ( @$early ) {
1053 next if $_->{subtotal} == 0;
1054 $_->{subtotal} = $other_money_char.sprintf('%.2f', $_->{subtotal});
1055 push @summary_subtotals, $_;
1058 # subtotal sectioning is the same as for the actual invoice sections
1059 @summary_subtotals = @sections;
1062 # Hereafter, push sections to both @sections and @summary_subtotals
1063 # if they belong in both places (e.g. tax section). Late sections are
1064 # never in @summary_subtotals.
1066 # previous invoice balances in the Previous Charges section if there
1067 # is one, otherwise in the main detail section
1068 # (except if summary_only is enabled, don't show them at all)
1069 if ( $self->can('_items_previous') &&
1070 $self->enable_previous &&
1071 ! $conf->exists('previous_balance-summary_only') ) {
1073 warn "$me adding previous balances\n"
1076 foreach my $line_item ( $self->_items_previous ) {
1079 ref => $line_item->{'pkgnum'},
1080 pkgpart => $line_item->{'pkgpart'},
1081 #quantity => 1, # not really correct
1082 section => $previous_section, # which might be $default_section
1083 description => &$escape_function($line_item->{'description'}),
1084 ext_description => [ map { &$escape_function($_) }
1085 @{ $line_item->{'ext_description'} || [] }
1087 amount => $money_char . $line_item->{'amount'},
1088 product_code => $line_item->{'pkgpart'} || 'N/A',
1091 push @detail_items, $detail;
1092 push @buf, [ $detail->{'description'},
1093 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1099 if ( @pr_cust_bill && $self->enable_previous ) {
1100 push @buf, ['','-----------'];
1101 push @buf, [ $self->mt('Total Previous Balance'),
1102 $money_char. sprintf("%10.2f", $pr_total) ];
1106 if ( $conf->exists('svc_phone-did-summary') && $self->can('_did_summary') ) {
1107 warn "$me adding DID summary\n"
1110 my ($didsummary,$minutes) = $self->_did_summary;
1111 my $didsummary_desc = 'DID Activity Summary (since last invoice)';
1113 { 'description' => $didsummary_desc,
1114 'ext_description' => [ $didsummary, $minutes ],
1118 foreach my $section (@sections, @$late_sections) {
1120 # begin some normalization
1121 $section->{'subtotal'} = $section->{'amount'}
1123 && !exists($section->{subtotal})
1124 && exists($section->{amount});
1126 $invoice_data{finance_amount} = sprintf('%.2f', $section->{'subtotal'} )
1127 if ( $invoice_data{finance_section} &&
1128 $section->{'description'} eq $invoice_data{finance_section} );
1130 $section->{'subtotal'} = $other_money_char.
1131 sprintf('%.2f', $section->{'subtotal'})
1134 # continue some normalization
1135 $section->{'amount'} = $section->{'subtotal'}
1139 if ( $section->{'description'} ) {
1140 push @buf, ( [ &$escape_function($section->{'description'}), '' ],
1145 warn "$me setting options\n"
1149 $options{'section'} = $section if $multisection;
1150 $options{'format'} = $format;
1151 $options{'escape_function'} = $escape_function;
1152 $options{'no_usage'} = 1 unless $unsquelched;
1153 $options{'unsquelched'} = $unsquelched;
1154 $options{'summary_page'} = $summarypage;
1155 $options{'skip_usage'} =
1156 scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
1157 $options{'preref_callback'} = $params{'preref_callback'};
1159 warn "$me searching for line items\n"
1162 foreach my $line_item ( $self->_items_pkg(%options),
1163 $self->_items_fee(%options) ) {
1165 warn "$me adding line item ".
1166 join(', ', map "$_=>".$line_item->{$_}, keys %$line_item). "\n"
1169 push @buf, ( [ $line_item->{'description'},
1170 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1172 map { [ " ". $_, '' ] } @{$line_item->{'ext_description'}},
1175 $line_item->{'ref'} = $line_item->{'pkgnum'};
1176 $line_item->{'product_code'} = $line_item->{'pkgpart'} || 'N/A'; # mt()?
1177 $line_item->{'section'} = $section;
1178 $line_item->{'description'} = &$escape_function($line_item->{'description'});
1179 $line_item->{'amount'} = $money_char.$line_item->{'amount'};
1181 if ( length($line_item->{'unit_amount'}) ) {
1182 $line_item->{'unit_amount'} = $money_char.$line_item->{'unit_amount'};
1184 $line_item->{'ext_description'} ||= [];
1186 push @detail_items, $line_item;
1189 if ( $section->{'description'} ) {
1190 push @buf, ( ['','-----------'],
1191 [ $section->{'description'}. ' sub-total',
1192 $section->{'subtotal'} # already formatted this
1201 $invoice_data{current_less_finance} =
1202 sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
1204 # if there's anything in the Previous Charges section, prepend it to the list
1205 if ( $pr_total and $previous_section ne $default_section ) {
1206 unshift @sections, $previous_section;
1207 # but not @summary_subtotals
1210 warn "$me adding taxes\n"
1213 # create a tax section if we don't yet have one
1214 my $tax_description = 'Taxes, Surcharges, and Fees';
1216 List::Util::first { $_->{description} eq $tax_description } @sections;
1217 if (!$tax_section) {
1218 $tax_section = { 'description' => $tax_description };
1219 push @sections, $tax_section if $multisection;
1221 $tax_section->{tax_section} = 1; # mark this section as containing taxes
1222 # if this is an existing tax section, we're merging the tax items into it.
1223 # grab the taxtotal that's already there, strip the money symbol if any
1224 my $taxtotal = $tax_section->{'subtotal'} || 0;
1225 $taxtotal =~ s/^\Q$other_money_char\E//;
1228 #my $tax_weight = _pkg_category($tax_section->{description})
1229 # ? _pkg_category($tax_section->{description})->weight
1231 #$tax_section->{'summarized'} = ''; #why? $summarypage && !$tax_weight ? 'Y' : '';
1232 #$tax_section->{'sort_weight'} = $tax_weight;
1234 my @items_tax = $self->_items_tax;
1235 foreach my $tax ( @items_tax ) {
1237 $taxtotal += $tax->{'amount'};
1239 my $description = &$escape_function( $tax->{'description'} );
1240 my $amount = sprintf( '%.2f', $tax->{'amount'} );
1242 if ( $multisection ) {
1244 push @detail_items, {
1245 ext_description => [],
1248 description => $description,
1249 amount => $money_char. $amount,
1251 section => $tax_section,
1256 push @total_items, {
1257 'total_item' => $description,
1258 'total_amount' => $other_money_char. $amount,
1263 push @buf,[ $description,
1264 $money_char. $amount,
1271 $total->{'total_item'} = $self->mt('Sub-total');
1272 $total->{'total_amount'} =
1273 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
1275 if ( $multisection ) {
1276 if ( $taxtotal > 0 ) {
1277 $tax_section->{'subtotal'} = $other_money_char.
1278 sprintf('%.2f', $taxtotal);
1279 $tax_section->{'pretotal'} = 'New charges sub-total '.
1280 $total->{'total_amount'};
1281 $tax_section->{'description'} = $self->mt($tax_description);
1283 # append it if it's not already there
1284 if ( !grep $tax_section, @sections ) {
1285 push @sections, $tax_section;
1286 push @summary_subtotals, $tax_section;
1291 unshift @total_items, $total;
1294 $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
1296 push @buf,['','-----------'];
1297 push @buf,[$self->mt(
1298 (!$self->enable_previous)
1300 : 'Total New Charges'
1302 $money_char. sprintf("%10.2f",$self->charged) ];
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 ( $self->can('_items_total') ) { # quotations
1318 my @new_total_items = $self->_items_total;
1320 foreach ( @new_total_items ) {
1321 $_->{'total_item'} = &$embolden_function( $_->{'total_item'} );
1322 $_->{'total_amount'} = &$embolden_function( $other_money_char.$_->{'total_amount'});
1323 push @total_items, $_;
1326 } else { #normal invoice case
1328 # calculate total, possibly including total owed on previous
1332 $item = $conf->config('previous_balance-exclude_from_total')
1333 || 'Total New Charges'
1334 if $conf->exists('previous_balance-exclude_from_total');
1335 my $amount = $self->charged;
1336 if ( $self->enable_previous and !$conf->exists('previous_balance-exclude_from_total') ) {
1337 $amount += $pr_total;
1340 $total->{'total_item'} = &$embolden_function($self->mt($item));
1341 $total->{'total_amount'} =
1342 &$embolden_function( $other_money_char. sprintf( '%.2f', $amount ) );
1343 if ( $multisection ) {
1344 if ( $adjust_section->{'sort_weight'} ) {
1345 $adjust_section->{'posttotal'} = $self->mt('Balance Forward').' '.
1346 $other_money_char. sprintf("%.2f", ($self->billing_balance || 0) );
1348 $adjust_section->{'pretotal'} = $self->mt('New charges total').' '.
1349 $other_money_char. sprintf('%.2f', $self->charged );
1352 push @total_items, $total;
1354 push @buf,['','-----------'];
1357 sprintf( '%10.2f', $amount )
1361 # if we're showing previous invoices, also show previous
1362 # credits and payments
1363 if ( $self->enable_previous
1364 and $self->can('_items_credits')
1365 and $self->can('_items_payments') )
1367 #foreach my $thing ( sort { $a->_date <=> $b->_date } $self->_items_credits, $self->_items_payments
1370 my $credittotal = 0;
1371 foreach my $credit (
1372 $self->_items_credits( 'template' => $template, 'trim_len' => 40 )
1376 $total->{'total_item'} = &$escape_function($credit->{'description'});
1377 $credittotal += $credit->{'amount'};
1378 $total->{'total_amount'} = $minus.$other_money_char.$credit->{'amount'};
1379 if ( $multisection ) {
1380 push @detail_items, {
1381 ext_description => [],
1384 description => &$escape_function($credit->{'description'}),
1385 amount => $money_char . $credit->{'amount'},
1387 section => $adjust_section,
1390 push @total_items, $total;
1394 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
1397 foreach my $credit (
1398 $self->_items_credits( 'template' => $template, 'trim_len'=>32 )
1400 push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
1404 my $paymenttotal = 0;
1405 foreach my $payment (
1406 $self->_items_payments( 'template' => $template )
1409 $total->{'total_item'} = &$escape_function($payment->{'description'});
1410 $paymenttotal += $payment->{'amount'};
1411 $total->{'total_amount'} = $minus.$other_money_char.$payment->{'amount'};
1412 if ( $multisection ) {
1413 push @detail_items, {
1414 ext_description => [],
1417 description => &$escape_function($payment->{'description'}),
1418 amount => $money_char . $payment->{'amount'},
1420 section => $adjust_section,
1423 push @total_items, $total;
1425 push @buf, [ $payment->{'description'},
1426 $money_char. sprintf("%10.2f", $payment->{'amount'}),
1429 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
1431 if ( $multisection ) {
1432 $adjust_section->{'subtotal'} = $other_money_char.
1433 sprintf('%.2f', $credittotal + $paymenttotal);
1435 #why this? because {sort_weight} forces the adjust_section to appear
1436 #in @extra_sections instead of @sections. obviously.
1437 push @sections, $adjust_section
1438 unless $adjust_section->{sort_weight};
1439 # do not summarize; adjustments there are shown according to
1443 # create Balance Due message
1446 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1447 $total->{'total_amount'} =
1448 &$embolden_function(
1449 $other_money_char. sprintf('%.2f', #why? $summarypage
1450 # ? $self->charged +
1451 # $self->billing_balance
1453 $self->owed + $pr_total
1456 if ( $multisection && !$adjust_section->{sort_weight} ) {
1457 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
1458 $total->{'total_amount'};
1460 push @total_items, $total;
1462 push @buf,['','-----------'];
1463 push @buf,[$self->balance_due_msg, $money_char.
1464 sprintf("%10.2f", $balance_due ) ];
1467 if ( $conf->exists('previous_balance-show_credit')
1468 and $cust_main->balance < 0 ) {
1469 my $credit_total = {
1470 'total_item' => &$embolden_function($self->credit_balance_msg),
1471 'total_amount' => &$embolden_function(
1472 $other_money_char. sprintf('%.2f', -$cust_main->balance)
1475 if ( $multisection ) {
1476 $adjust_section->{'posttotal'} .= $newline_token .
1477 $credit_total->{'total_item'} . ' ' . $credit_total->{'total_amount'};
1480 push @total_items, $credit_total;
1482 push @buf,['','-----------'];
1483 push @buf,[$self->credit_balance_msg, $money_char.
1484 sprintf("%10.2f", -$cust_main->balance ) ];
1488 } #end of default total adding ! can('_items_total')
1490 if ( $multisection ) {
1491 if ( $conf->exists('svc_phone_sections')
1492 && $self->can('_items_svc_phone_sections')
1496 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1497 $total->{'total_amount'} =
1498 &$embolden_function(
1499 $other_money_char. sprintf('%.2f', $self->owed + $pr_total)
1501 my $last_section = pop @sections;
1502 $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
1503 $total->{'total_amount'};
1504 push @sections, $last_section;
1506 push @sections, @$late_sections
1510 # make a discounts-available section, even without multisection
1511 if ( $conf->exists('discount-show_available')
1512 and my @discounts_avail = $self->_items_discounts_avail ) {
1513 my $discount_section = {
1514 'description' => $self->mt('Discounts Available'),
1519 push @sections, $discount_section; # do not summarize
1520 push @detail_items, map { +{
1521 'ref' => '', #should this be something else?
1522 'section' => $discount_section,
1523 'description' => &$escape_function( $_->{description} ),
1524 'amount' => $money_char . &$escape_function( $_->{amount} ),
1525 'ext_description' => [ &$escape_function($_->{ext_description}) || () ],
1526 } } @discounts_avail;
1529 # not adding any more sections after this
1530 $invoice_data{summary_subtotals} = \@summary_subtotals;
1533 if ( $conf->exists('usage_class_summary')
1534 and $self->can('_items_usage_class_summary') ) {
1535 my @usage_subtotals = $self->_items_usage_class_summary(escape => $escape_function);
1536 if ( @usage_subtotals ) {
1537 unshift @sections, $usage_subtotals[0]->{section}; # do not summarize
1538 unshift @detail_items, @usage_subtotals;
1542 # invoice history "section" (not really a section)
1543 # not to be included in any subtotals, completely independent of
1545 if ( $conf->exists('previous_invoice_history') and $cust_main->isa('FS::cust_main') ) {
1548 foreach my $cust_bill ( $cust_main->cust_bill ) {
1549 # XXX hardcoded format, and currently only 'charged'; add other fields
1550 # if they become necessary
1551 my $date = $self->time2str_local('%b %Y', $cust_bill->_date);
1552 $history{$date} ||= 0;
1553 $history{$date} += $cust_bill->charged;
1554 # just so we have a numeric sort key
1555 $monthorder{$date} ||= $cust_bill->_date;
1557 my @sorted_months = sort { $monthorder{$a} <=> $monthorder{$b} }
1559 my @sorted_amounts = map { sprintf('%.2f', $history{$_}) } @sorted_months;
1560 $invoice_data{monthly_history} = [ \@sorted_months, \@sorted_amounts ];
1563 # service locations: another option for template customization
1565 foreach my $item (@detail_items) {
1566 if ( $item->{locationnum} ) {
1567 $location_info{ $item->{locationnum} } ||= {
1568 FS::cust_location->by_key( $item->{locationnum} )->location_hash
1572 $invoice_data{location_info} = \%location_info;
1574 # debugging hook: call this with 'diag' => 1 to just get a hash of
1575 # the invoice variables
1576 return \%invoice_data if ( $params{'diag'} );
1578 # All sections and items are built; now fill in templates.
1579 my @includelist = ();
1580 push @includelist, 'summary' if $summarypage;
1581 foreach my $include ( @includelist ) {
1583 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
1586 if ( length( $conf->config($inc_file, $agentnum) ) ) {
1588 @inc_src = $conf->config($inc_file, $agentnum);
1592 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
1594 my $convert_map = $convert_maps{$format}{$include};
1596 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
1597 s/--\@\]/$delimiters{$format}[1]/g;
1600 &$convert_map( $conf->config($inc_file, $agentnum) );
1604 my $inc_tt = new Text::Template (
1606 SOURCE => [ map "$_\n", @inc_src ],
1607 DELIMITERS => $delimiters{$format},
1608 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
1610 unless ( $inc_tt->compile() ) {
1611 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
1612 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
1616 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
1618 $invoice_data{$include} =~ s/\n+$//
1619 if ($format eq 'latex');
1624 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1625 /invoice_lines\((\d*)\)/;
1626 $invoice_lines += $1 || scalar(@buf);
1629 die "no invoice_lines() functions in template?"
1630 if ( $format eq 'template' && !$wasfunc );
1632 if ($format eq 'template') {
1634 if ( $invoice_lines ) {
1635 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
1636 $invoice_data{'total_pages'}++
1637 if scalar(@buf) % $invoice_lines;
1640 #setup subroutine for the template
1641 $invoice_data{invoice_lines} = sub {
1642 my $lines = shift || scalar(@buf);
1654 push @collect, split("\n",
1655 $text_template->fill_in( HASH => \%invoice_data )
1657 $invoice_data{'page'}++;
1659 map "$_\n", @collect;
1661 } else { # this is where we actually create the invoice
1663 warn "filling in template for invoice ". $self->invnum. "\n"
1665 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
1668 $text_template->fill_in(HASH => \%invoice_data);
1672 sub notice_name { '('.shift->table.')'; }
1674 sub template_conf { 'invoice_'; }
1676 # helper routine for generating date ranges
1677 sub _prior_month30s {
1680 [ 1, 2592000 ], # 0-30 days ago
1681 [ 2592000, 5184000 ], # 30-60 days ago
1682 [ 5184000, 7776000 ], # 60-90 days ago
1683 [ 7776000, 0 ], # 90+ days ago
1686 map { [ $_->[0] ? $self->_date - $_->[0] - 1 : '',
1687 $_->[1] ? $self->_date - $_->[1] - 1 : '',
1692 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
1694 Returns an postscript invoice, as a scalar.
1696 Options can be passed as a hashref (recommended) or as a list of time, template
1697 and then any key/value pairs for any other options.
1699 I<time> an optional value used to control the printing of overdue messages. The
1700 default is now. It isn't the date of the invoice; that's the `_date' field.
1701 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1702 L<Time::Local> and L<Date::Parse> for conversion functions.
1704 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1711 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1712 my $ps = generate_ps($file);
1714 unlink($barcodefile) if $barcodefile;
1719 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
1721 Returns an PDF invoice, as a scalar.
1723 Options can be passed as a hashref (recommended) or as a list of time, template
1724 and then any key/value pairs for any other options.
1726 I<time> an optional value used to control the printing of overdue messages. The
1727 default is now. It isn't the date of the invoice; that's the `_date' field.
1728 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1729 L<Time::Local> and L<Date::Parse> for conversion functions.
1731 I<template>, if specified, is the name of a suffix for alternate invoices.
1733 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1740 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1741 my $pdf = generate_pdf($file);
1743 unlink($barcodefile) if $barcodefile;
1748 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
1750 Returns an HTML invoice, as a scalar.
1752 I<time> an optional value used to control the printing of overdue messages. The
1753 default is now. It isn't the date of the invoice; that's the `_date' field.
1754 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1755 L<Time::Local> and L<Date::Parse> for conversion functions.
1757 I<template>, if specified, is the name of a suffix for alternate invoices.
1759 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1761 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
1762 when emailing the invoice as part of a multipart/related MIME email.
1770 %params = %{ shift() };
1774 $params{'format'} = 'html';
1776 $self->print_generic( %params );
1779 # quick subroutine for print_latex
1781 # There are ten characters that LaTeX treats as special characters, which
1782 # means that they do not simply typeset themselves:
1783 # # $ % & ~ _ ^ \ { }
1785 # TeX ignores blanks following an escaped character; if you want a blank (as
1786 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
1790 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
1791 $value =~ s/([<>])/\$$1\$/g;
1797 encode_entities($value);
1801 sub _html_escape_nbsp {
1802 my $value = _html_escape(shift);
1803 $value =~ s/ +/ /g;
1807 #utility methods for print_*
1809 sub _translate_old_latex_format {
1810 warn "_translate_old_latex_format called\n"
1817 if ( $line =~ /^%%Detail\s*$/ ) {
1819 push @template, q![@--!,
1820 q! foreach my $_tr_line (@detail_items) {!,
1821 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
1822 q! $_tr_line->{'description'} .= !,
1823 q! "\\tabularnewline\n~~".!,
1824 q! join( "\\tabularnewline\n~~",!,
1825 q! @{$_tr_line->{'ext_description'}}!,
1829 while ( ( my $line_item_line = shift )
1830 !~ /^%%EndDetail\s*$/ ) {
1831 $line_item_line =~ s/'/\\'/g; # nice LTS
1832 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1833 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1834 push @template, " \$OUT .= '$line_item_line';";
1837 push @template, '}',
1840 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1842 push @template, '[@--',
1843 ' foreach my $_tr_line (@total_items) {';
1845 while ( ( my $total_item_line = shift )
1846 !~ /^%%EndTotalDetails\s*$/ ) {
1847 $total_item_line =~ s/'/\\'/g; # nice LTS
1848 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1849 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1850 push @template, " \$OUT .= '$total_item_line';";
1853 push @template, '}',
1857 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
1858 push @template, $line;
1864 warn "$_\n" foreach @template;
1876 my $conf = $self->conf;
1878 #check for an invoice-specific override
1879 return $self->invoice_terms if $self->invoice_terms;
1881 #check for a customer- specific override
1882 my $cust_main = $self->cust_main;
1883 return $cust_main->invoice_terms if $cust_main && $cust_main->invoice_terms;
1887 $agentnum = $cust_main->agentnum;
1888 } elsif ( my $prospect_main = $self->prospect_main ) {
1889 $agentnum = $prospect_main->agentnum;
1892 #use configured default
1893 $conf->config('invoice_default_terms', $agentnum) || '';
1903 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1904 $duedate = $self->_date() + ( $1 * 86400 );
1915 $self->due_date ? $self->time2str_local(shift, $self->due_date) : '';
1918 =item balance_due_msg
1922 sub balance_due_msg {
1924 my $msg = $self->mt('Balance Due');
1925 return $msg unless $self->terms;
1926 if ( $self->due_date ) {
1927 $msg .= ' - ' . $self->mt('Please pay by'). ' '.
1928 $self->due_date2str('short');
1929 } elsif ( $self->terms ) {
1930 $msg .= ' - '. $self->terms;
1935 =item balance_due_date
1939 sub balance_due_date {
1941 my $conf = $self->conf;
1943 my $terms = $self->terms;
1944 if ( $terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1945 $duedate = $self->time2str_local('rdate', $self->_date + ($1*86400) );
1950 sub credit_balance_msg {
1952 $self->mt('Credit Balance Remaining')
1957 Returns a string with the date, for example: "3/20/2008", localized for the
1958 customer. Use _date_pretty_unlocalized for non-end-customer display use.
1964 $self->time2str_local('short', $self->_date);
1967 =item _date_pretty_unlocalized
1969 Returns a string with the date, for example: "3/20/2008", in the format
1970 configured for the back-office. Use _date_pretty for end-customer display use.
1974 sub _date_pretty_unlocalized {
1976 time2str($date_format, $self->_date);
1981 Emails this template.
1983 Options are passed as a hashref. Available options:
1989 If specified, overrides the default From: address.
1993 If specified, overrides the name of the sent document ("Invoice" or "Quotation")
1997 (Deprecated) If specified, is the name of a suffix for alternate template files.
2001 Options accepted by generate_email can also be used.
2007 my $opt = shift || {};
2008 if ($opt and !ref($opt)) {
2009 die ref($self). '->email called with positional parameters';
2012 return if $self->hide;
2014 my $error = send_email(
2015 $self->generate_email(
2016 'subject' => $self->email_subject($opt->{template}),
2017 %$opt, # template, etc.
2021 die "can't email: $error\n" if $error;
2024 =item generate_email OPTION => VALUE ...
2032 sender address, required
2036 alternate template name, optional
2040 email subject, optional
2044 notice name instead of "Invoice", optional
2048 Returns an argument list to be passed to L<FS::Misc::send_email>.
2054 sub generate_email {
2058 my $conf = $self->conf;
2060 my $me = '[FS::Template_Mixin::generate_email]';
2063 'from' => $args{'from'},
2064 'subject' => ($args{'subject'} || $self->email_subject),
2065 'custnum' => $self->custnum,
2066 'msgtype' => 'invoice',
2069 $args{'unsquelch_cdr'} = $conf->exists('voip-cdr_email');
2071 my $cust_main = $self->cust_main;
2073 if (ref($args{'to'}) eq 'ARRAY') {
2074 $return{'to'} = $args{'to'};
2075 } elsif ( $cust_main ) {
2076 $return{'to'} = [ $cust_main->invoicing_list_emailonly ];
2079 my $tc = $self->template_conf;
2081 my @text; # array of lines
2082 my $html; # a big string
2083 my @related_parts; # will contain the text/HTML alternative, and images
2084 my $related; # will contain the multipart/related object
2086 if ( $conf->exists($tc. 'email_pdf') ) {
2087 if ( my $msgnum = $conf->config($tc.'email_pdf_msgnum') ) {
2089 warn "$me using '${tc}email_pdf_msgnum' in multipart message"
2092 my $msg_template = FS::msg_template->by_key($msgnum)
2093 or die "${tc}email_pdf_msgnum $msgnum not found\n";
2094 my %prepared = $msg_template->prepare(
2095 cust_main => $self->cust_main,
2099 @text = split(/(?=\n)/, $prepared{'text_body'});
2100 $html = $prepared{'html_body'};
2102 } elsif ( my @note = $conf->config($tc.'email_pdf_note') ) {
2104 warn "$me using '${tc}email_pdf_note' in multipart message"
2106 @text = $conf->config($tc.'email_pdf_note');
2107 $html = join('<BR>', @text);
2109 } # else use the plain text invoice
2114 warn "$me generating plain text invoice"
2117 # 'print_text' argument is no longer used
2118 @text = $self->print_text(\%args);
2122 my $text_part = build MIME::Entity (
2123 'Type' => 'text/plain',
2124 'Encoding' => 'quoted-printable',
2125 'Charset' => 'UTF-8',
2126 #'Encoding' => '7bit',
2128 'Disposition' => 'inline',
2133 if ( $conf->exists($tc.'html') ) {
2134 warn "$me generating HTML invoice"
2137 $args{'from'} =~ /\@([\w\.\-]+)/;
2138 my $from = $1 || 'example.com';
2139 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2142 my $agentnum = $cust_main ? $cust_main->agentnum
2143 : $self->prospect_main->agentnum;
2144 if ( defined($args{'template'}) && length($args{'template'})
2145 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
2148 $logo = 'logo_'. $args{'template'}. '.png';
2152 my $image_data = $conf->config_binary( $logo, $agentnum);
2154 push @related_parts, build MIME::Entity
2155 'Type' => 'image/png',
2156 'Encoding' => 'base64',
2157 'Data' => $image_data,
2158 'Filename' => 'logo.png',
2159 'Content-ID' => "<$content_id>",
2162 if ( ref($self) eq 'FS::cust_bill' && $conf->exists('invoice-barcode') ) {
2163 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2164 push @related_parts, build MIME::Entity
2165 'Type' => 'image/png',
2166 'Encoding' => 'base64',
2167 'Data' => $self->invoice_barcode(0),
2168 'Filename' => 'barcode.png',
2169 'Content-ID' => "<$barcode_content_id>",
2171 $args{'barcode_cid'} = $barcode_content_id;
2174 $html = $self->print_html({ 'cid'=>$content_id, %args });
2181 warn "$me creating HTML/text multipart message"
2184 $return{'nobody'} = 1;
2186 my $alternative = build MIME::Entity
2187 'Type' => 'multipart/alternative',
2188 #'Encoding' => '7bit',
2189 'Disposition' => 'inline'
2193 $alternative->add_part($text_part);
2196 $alternative->attach(
2197 'Type' => 'text/html',
2198 'Encoding' => 'quoted-printable',
2199 'Data' => [ '<html>',
2202 ' '. encode_entities($return{'subject'}),
2205 ' <body bgcolor="#e8e8e8">',
2210 'Disposition' => 'inline',
2211 #'Filename' => 'invoice.pdf',
2214 unshift @related_parts, $alternative;
2216 $related = build MIME::Entity 'Type' => 'multipart/related',
2217 'Encoding' => '7bit';
2219 #false laziness w/Misc::send_email
2220 $related->head->replace('Content-type',
2221 $related->mime_type.
2222 '; boundary="'. $related->head->multipart_boundary. '"'.
2223 '; type=multipart/alternative'
2226 $related->add_part($_) foreach @related_parts;
2230 my @otherparts = ();
2231 if ( ref($self) eq 'FS::cust_bill' && $cust_main->email_csv_cdr ) {
2233 push @otherparts, build MIME::Entity
2234 'Type' => 'text/csv',
2235 'Encoding' => '7bit',
2236 'Data' => [ map { "$_\n" }
2237 $self->call_details('prepend_billed_number' => 1)
2239 'Disposition' => 'attachment',
2240 'Filename' => 'usage-'. $self->invnum. '.csv',
2245 if ( $conf->exists($tc.'email_pdf') ) {
2250 # multipart/alternative
2256 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%args);
2257 push @otherparts, $pdf;
2261 $return{'content-type'} = 'multipart/mixed'; # of the outer container
2263 $return{'mimeparts'} = [ $related, @otherparts ];
2264 $return{'type'} = 'multipart/related'; # of the first part
2266 $return{'mimeparts'} = [ $text_part, @otherparts ];
2267 $return{'type'} = 'text/plain';
2269 } elsif ( $html ) { # no PDF or CSV, strip the outer container
2270 $return{'mimeparts'} = \@related_parts;
2271 $return{'content-type'} = 'multipart/related';
2272 $return{'type'} = 'multipart/alternative';
2273 } else { # no HTML either
2274 $return{'body'} = \@text;
2275 $return{'content-type'} = 'text/plain';
2284 Returns a list suitable for passing to MIME::Entity->build(), representing
2285 this invoice as PDF attachment.
2292 'Type' => 'application/pdf',
2293 'Encoding' => 'base64',
2294 'Data' => [ $self->print_pdf(@_) ],
2295 'Disposition' => 'attachment',
2296 'Filename' => 'invoice-'. $self->invnum. '.pdf',
2300 =item _items_sections OPTIONS
2302 Generate section information for all items appearing on this invoice.
2303 This will only be called for multi-section invoices.
2305 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
2306 related display records (L<FS::cust_bill_pkg_display>) and organize
2307 them into two groups ("early" and "late" according to whether they come
2308 before or after the total), then into sections. A subtotal is calculated
2311 Section descriptions are returned in sort weight order. Each consists
2312 of a hash containing:
2314 description: the package category name, escaped
2315 subtotal: the total charges in that section
2316 tax_section: a flag indicating that the section contains only tax charges
2317 summarized: same as tax_section, for some reason
2318 sort_weight: the package category's sort weight
2320 If 'condense' is set on the display record, it also contains everything
2321 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
2322 coderefs to generate parts of the invoice. This is not advised.
2324 The method returns two arrayrefs, one of "early" sections and one of "late"
2327 OPTIONS may include:
2329 by_location: a flag to divide the invoice into sections by location.
2330 Each section hash will have a 'location' element containing a hashref of
2331 the location fields (see L<FS::cust_location>). The section description
2332 will be the location label, but the template can use any of the location
2333 fields to create a suitable label.
2335 by_category: a flag to divide the invoice into sections using display
2336 records (see L<FS::cust_bill_pkg_display>). This is the "traditional"
2337 behavior. Each section hash will have a 'category' element containing
2338 the section name from the display record (which probably equals the
2339 category name of the package, but may not in some cases).
2341 summary: a flag indicating that this is a summary-format invoice.
2342 Turning this on has the following effects:
2343 - Ignores display items with the 'summary' flag.
2344 - Places all sections in the "early" group even if they have post_total.
2345 - Creates sections for all non-disabled package categories, even if they
2346 have no charges on this invoice, as well as a section with no name.
2348 escape: an escape function to use for section titles.
2350 extra_sections: an arrayref of additional sections to return after the
2351 sorted list. If there are any of these, section subtotals exclude
2354 format: 'latex', 'html', or 'template' (i.e. text). Not used, but
2355 passed through to C<_condense_section()>.
2359 use vars qw(%pkg_category_cache);
2360 sub _items_sections {
2364 my $escape = $opt{escape};
2365 my @extra_sections = @{ $opt{extra_sections} || [] };
2367 # $subtotal{$locationnum}{$categoryname} = amount.
2368 # if we're not using by_location, $locationnum is undef.
2369 # if we're not using by_category, you guessed it, $categoryname is undef.
2370 # if we're not using either one, we shouldn't be here in the first place...
2372 my %late_subtotal = ();
2375 # About tax items + multisection invoices:
2376 # If either invoice_*summary option is enabled, AND there is a
2377 # package category with the name of the tax, then there will be
2378 # a display record assigning the tax item to that category.
2380 # However, the taxes are always placed in the "Taxes, Surcharges,
2381 # and Fees" section regardless of that. The only effect of the
2382 # display record is to create a subtotal for the summary page.
2385 my $pkg_hash = $self->cust_pkg_hash;
2387 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2390 my $usage = $cust_bill_pkg->usage;
2393 if ( $opt{by_location} ) {
2394 if ( $cust_bill_pkg->pkgnum ) {
2395 $locationnum = $pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum;
2400 $locationnum = undef;
2403 # as in _items_cust_pkg, if a line item has no display records,
2404 # cust_bill_pkg_display() returns a default record for it
2406 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
2407 next if ( $display->summary && $opt{summary} );
2409 my $section = $display->section;
2410 my $type = $display->type;
2411 # Set $section = undef if we're sectioning by location and this
2412 # line item _has_ a location (i.e. isn't a fee).
2413 $section = undef if $locationnum;
2415 # set this flag if the section is not tax-only
2416 $not_tax{$locationnum}{$section} = 1
2417 if $cust_bill_pkg->pkgnum or $cust_bill_pkg->feepart;
2419 # there's actually a very important piece of logic buried in here:
2420 # incrementing $late_subtotal{$section} CREATES
2421 # $late_subtotal{$section}. keys(%late_subtotal) is later used
2422 # to define the list of late sections, and likewise keys(%subtotal).
2423 # When _items_cust_bill_pkg is called to generate line items for
2424 # real, it will be called with 'section' => $section for each
2426 if ( $display->post_total && !$opt{summary} ) {
2427 if (! $type || $type eq 'S') {
2428 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2429 if $cust_bill_pkg->setup != 0
2430 || $cust_bill_pkg->setup_show_zero;
2434 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur
2435 if $cust_bill_pkg->recur != 0
2436 || $cust_bill_pkg->recur_show_zero;
2439 if ($type && $type eq 'R') {
2440 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2441 if $cust_bill_pkg->recur != 0
2442 || $cust_bill_pkg->recur_show_zero;
2445 if ($type && $type eq 'U') {
2446 $late_subtotal{$locationnum}{$section} += $usage
2447 unless scalar(@extra_sections);
2450 } else { # it's a pre-total (normal) section
2452 # skip tax items unless they're explicitly included in a section
2453 next if $cust_bill_pkg->pkgnum == 0 and
2454 ! $cust_bill_pkg->feepart and
2457 if ( $type eq 'S' ) {
2458 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2459 if $cust_bill_pkg->setup != 0
2460 || $cust_bill_pkg->setup_show_zero;
2461 } elsif ( $type eq 'R' ) {
2462 $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2463 if $cust_bill_pkg->recur != 0
2464 || $cust_bill_pkg->recur_show_zero;
2465 } elsif ( $type eq 'U' ) {
2466 $subtotal{$locationnum}{$section} += $usage
2467 unless scalar(@extra_sections);
2468 } elsif ( !$type ) {
2469 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2470 + $cust_bill_pkg->recur;
2479 %pkg_category_cache = ();
2481 # summary invoices need subtotals for all non-disabled package categories,
2482 # even if they're zero
2483 # but currently assume that there are no location sections, or at least
2484 # that the summary page doesn't care about them
2485 if ( $opt{summary} ) {
2486 foreach my $category (qsearch('pkg_category', {disabled => ''})) {
2487 $subtotal{''}{$category->categoryname} ||= 0;
2489 $subtotal{''}{''} ||= 0;
2493 foreach my $post_total (0,1) {
2495 my $s = $post_total ? \%late_subtotal : \%subtotal;
2496 foreach my $locationnum (keys %$s) {
2497 foreach my $sectionname (keys %{ $s->{$locationnum} }) {
2499 'subtotal' => $s->{$locationnum}{$sectionname},
2500 'post_total' => $post_total,
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 my $discount_show_always = 0;
3012 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 40;
3014 my $cust_main = $self->cust_main;#for per-agent cust_bill-line_item-ate_style
3016 # for location labels: use default location on the invoice date
3017 my $default_locationnum;
3018 if ( $self->custnum ) {
3020 my @h_search = FS::h_cust_main->sql_h_search($self->_date);
3021 $h_cust_main = qsearchs({
3022 'table' => 'h_cust_main',
3023 'hashref' => { custnum => $self->custnum },
3024 'extra_sql' => $h_search[1],
3025 'addl_from' => $h_search[3],
3027 $default_locationnum = $h_cust_main->ship_locationnum;
3028 } elsif ( $self->prospectnum ) {
3029 my $cust_location = qsearchs('cust_location',
3030 { prospectnum => $self->prospectnum,
3032 $default_locationnum = $cust_location->locationnum if $cust_location;
3035 my @b = (); # accumulator for the line item hashes that we'll return
3036 my ($s, $r, $u, $d) = ( undef, undef, undef, undef );
3037 # the 'current' line item hashes for setup, recur, usage, discount
3038 foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
3040 # if the current line item is waiting to go out, and the one we're about
3041 # to start is not bundled, then push out the current one and start a new
3043 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3044 if ( $_ && !$cust_bill_pkg->hidden ) {
3045 $_->{amount} = sprintf( "%.2f", $_->{amount} );
3046 $_->{amount} =~ s/^\-0\.00$/0.00/;
3047 if (exists($_->{unit_amount})) {
3048 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3051 if $_->{amount} != 0
3052 || $discount_show_always
3053 || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3054 || ( $_->{_is_setup} && $_->{setup_show_zero} )
3060 if ( $locationnum ) {
3061 # this is a location section; skip packages that aren't at this
3063 next if $cust_bill_pkg->pkgnum == 0; # skips fees...
3064 next if $self->cust_pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum
3068 # Consider display records for this item to determine if it belongs
3069 # in this section. Note that if there are no display records, there
3070 # will be a default pseudo-record that includes all charge types
3071 # and has no section name.
3072 my @cust_bill_pkg_display = $cust_bill_pkg->can('cust_bill_pkg_display')
3073 ? $cust_bill_pkg->cust_bill_pkg_display
3074 : ( $cust_bill_pkg );
3076 warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
3077 $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
3080 if ( defined($category) ) {
3081 # then this is a package category section; process all display records
3082 # that belong to this section.
3083 @cust_bill_pkg_display = grep { $_->section eq $category }
3084 @cust_bill_pkg_display;
3086 # otherwise, process all display records that aren't usage summaries
3087 # (I don't think there should be usage summaries if you aren't using
3088 # category sections, but this is the historical behavior)
3089 @cust_bill_pkg_display = grep { !$_->summary }
3090 @cust_bill_pkg_display;
3093 my $classname = ''; # package class name, will fill in later
3095 foreach my $display (@cust_bill_pkg_display) {
3097 warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
3098 $display->billpkgdisplaynum. "\n"
3101 my $type = $display->type;
3103 my $desc = $cust_bill_pkg->desc( $cust_main ? $cust_main->locale : '' );
3104 $desc = substr($desc, 0, $maxlength). '...'
3105 if $format eq 'latex' && length($desc) > $maxlength;
3107 my %details_opt = ( 'format' => $format,
3108 'escape_function' => $escape_function,
3109 'format_function' => $format_function,
3110 'no_usage' => $opt{'no_usage'},
3113 if ( ref($cust_bill_pkg) eq 'FS::quotation_pkg' ) {
3114 # XXX this should be pulled out into quotation_pkg
3116 warn "$me _items_cust_bill_pkg cust_bill_pkg is quotation_pkg\n"
3118 # quotation_pkgs are never fees, so don't worry about the case where
3119 # part_pkg is undefined
3121 # and I guess they're never bundled either?
3122 if ( $cust_bill_pkg->setup != 0 ) {
3123 my $description = $desc;
3124 $description .= ' Setup'
3125 if $cust_bill_pkg->recur != 0
3126 || $discount_show_always
3127 || $cust_bill_pkg->recur_show_zero;
3129 # keep it consistent, please
3131 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref
3132 'description' => $description,
3133 'amount' => sprintf("%.2f", $cust_bill_pkg->setup),
3134 'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitsetup),
3135 'quantity' => $cust_bill_pkg->quantity,
3136 'preref_html' => ( $opt{preref_callback}
3137 ? &{ $opt{preref_callback} }( $cust_bill_pkg )
3142 if ( $cust_bill_pkg->recur != 0 ) {
3145 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref
3146 'description' => "$desc (". $cust_bill_pkg->part_pkg->freq_pretty.")",
3147 'amount' => sprintf("%.2f", $cust_bill_pkg->recur),
3148 'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitrecur),
3149 'quantity' => $cust_bill_pkg->quantity,
3150 'preref_html' => ( $opt{preref_callback}
3151 ? &{ $opt{preref_callback} }( $cust_bill_pkg )
3157 } elsif ( $cust_bill_pkg->pkgnum > 0 ) {
3158 # a "normal" package line item (not a quotation, not a fee, not a tax)
3160 warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
3163 my $cust_pkg = $cust_bill_pkg->cust_pkg;
3164 my $part_pkg = $cust_pkg->part_pkg;
3166 # which pkgpart to show for display purposes?
3167 my $pkgpart = $cust_bill_pkg->pkgpart_override || $cust_pkg->pkgpart;
3169 # start/end dates for invoice formats that do nonstandard
3171 my %item_dates = ();
3172 %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate')
3173 unless $part_pkg->option('disable_line_item_date_ranges',1);
3175 # not normally used, but pass this to the template anyway
3176 $classname = $part_pkg->classname;
3178 if ( (!$type || $type eq 'S')
3179 && ( $cust_bill_pkg->setup != 0
3180 || $cust_bill_pkg->setup_show_zero
3185 warn "$me _items_cust_bill_pkg adding setup\n"
3188 my $description = $desc;
3189 $description .= ' Setup'
3190 if $cust_bill_pkg->recur != 0
3191 || $discount_show_always
3192 || $cust_bill_pkg->recur_show_zero;
3194 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3196 if $part_pkg->is_prepaid #for prepaid, "display the validity period
3197 # triggered by the recurring charge freq
3199 && $cust_bill_pkg->recur == 0
3200 && ! $cust_bill_pkg->recur_show_zero;
3205 # always pass the svc_label through to the template, even if
3206 # not displaying it as an ext_description
3207 my @svc_labels = map &{$escape_function}($_),
3208 $cust_pkg->h_labels_short($self->_date, undef, 'I');
3210 $svc_label = $svc_labels[0];
3212 unless ( $cust_pkg->part_pkg->hide_svc_detail
3213 || $cust_bill_pkg->hidden )
3216 push @d, @svc_labels
3217 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3218 # show the location label if it's not the customer's default
3219 # location, and we're not grouping items by location already
3220 if ( $cust_pkg->locationnum != $default_locationnum
3221 and !defined($locationnum) ) {
3222 my $loc = $cust_pkg->location_label;
3223 $loc = substr($loc, 0, $maxlength). '...'
3224 if $format eq 'latex' && length($loc) > $maxlength;
3225 push @d, &{$escape_function}($loc);
3228 } #unless hiding service details
3230 push @d, $cust_bill_pkg->details(%details_opt)
3231 if $cust_bill_pkg->recur == 0;
3233 if ( $cust_bill_pkg->hidden ) {
3234 $s->{amount} += $cust_bill_pkg->setup;
3235 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
3236 push @{ $s->{ext_description} }, @d;
3240 description => $description,
3241 pkgpart => $pkgpart,
3242 pkgnum => $cust_bill_pkg->pkgnum,
3243 amount => $cust_bill_pkg->setup,
3244 setup_show_zero => $cust_bill_pkg->setup_show_zero,
3245 unit_amount => $cust_bill_pkg->unitsetup,
3246 quantity => $cust_bill_pkg->quantity,
3247 ext_description => \@d,
3248 svc_label => ($svc_label || ''),
3249 locationnum => $cust_pkg->locationnum, # sure, why not?
3255 if ( ( !$type || $type eq 'R' || $type eq 'U' )
3257 $cust_bill_pkg->recur != 0
3258 || $cust_bill_pkg->setup == 0
3259 || $discount_show_always
3260 || $cust_bill_pkg->recur_show_zero
3265 warn "$me _items_cust_bill_pkg adding recur/usage\n"
3268 my $is_summary = $display->summary;
3269 my $description = $desc;
3270 if ( $type eq 'U' and defined($r) ) {
3271 # don't just show the same description as the recur line
3272 $description = $self->mt('Usage charges');
3275 my $part_pkg = $cust_pkg->part_pkg;
3277 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3281 my @seconds = (); # for display of usage info
3284 #at least until cust_bill_pkg has "past" ranges in addition to
3285 #the "future" sdate/edate ones... see #3032
3286 my @dates = ( $self->_date );
3287 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
3288 push @dates, $prev->sdate if $prev;
3289 push @dates, undef if !$prev;
3291 my @svc_labels = map &{$escape_function}($_),
3292 $cust_pkg->h_labels_short(@dates, 'I');
3293 $svc_label = $svc_labels[0];
3295 # show service labels, unless...
3296 # the package is set not to display them
3297 unless ( $part_pkg->hide_svc_detail
3298 # or this is a tax-like line item
3299 || $cust_bill_pkg->itemdesc
3300 # or this is a hidden (bundled) line item
3301 || $cust_bill_pkg->hidden
3302 # or this is a usage summary line
3303 || $is_summary && $type && $type eq 'U'
3304 # or this is a usage line and there's a recurring line
3305 # for the package in the same section (which will
3306 # have service labels already)
3307 || ($type eq 'U' and defined($r))
3311 warn "$me _items_cust_bill_pkg adding service details\n"
3314 push @d, @svc_labels
3315 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3316 warn "$me _items_cust_bill_pkg done adding service details\n"
3319 # show the location label if it's not the customer's default
3320 # location, and we're not grouping items by location already
3321 if ( $cust_pkg->locationnum != $default_locationnum
3322 and !defined($locationnum) ) {
3323 my $loc = $cust_pkg->location_label;
3324 $loc = substr($loc, 0, $maxlength). '...'
3325 if $format eq 'latex' && length($loc) > $maxlength;
3326 push @d, &{$escape_function}($loc);
3329 # Display of seconds_since_sqlradacct:
3330 # On the invoice, when processing @detail_items, look for a field
3331 # named 'seconds'. This will contain total seconds for each
3332 # service, in the same order as @ext_description. For services
3333 # that don't support this it will show undef.
3334 if ( $conf->exists('svc_acct-usage_seconds')
3335 and ! $cust_bill_pkg->pkgpart_override ) {
3336 foreach my $cust_svc (
3337 $cust_pkg->h_cust_svc(@dates, 'I')
3340 # eval because not having any part_export_usage exports
3341 # is a fatal error, last_bill/_date because that's how
3342 # sqlradius_hour billing does it
3344 $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
3346 push @seconds, $sec;
3348 } #if svc_acct-usage_seconds
3350 } # if we are showing service labels
3352 unless ( $is_summary ) {
3353 warn "$me _items_cust_bill_pkg adding details\n"
3356 #instead of omitting details entirely in this case (unwanted side
3357 # effects), just omit CDRs
3358 $details_opt{'no_usage'} = 1
3359 if $type && $type eq 'R';
3361 push @d, $cust_bill_pkg->details(%details_opt);
3364 warn "$me _items_cust_bill_pkg calculating amount\n"
3369 $amount = $cust_bill_pkg->recur;
3370 } elsif ($type eq 'R') {
3371 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
3372 } elsif ($type eq 'U') {
3373 $amount = $cust_bill_pkg->usage;
3376 if ( !$type || $type eq 'R' ) {
3378 warn "$me _items_cust_bill_pkg adding recur\n"
3382 ( $cust_bill_pkg->unitrecur > 0 ) ? $cust_bill_pkg->unitrecur
3385 if ( $cust_bill_pkg->hidden ) {
3386 $r->{amount} += $amount;
3387 $r->{unit_amount} += $unit_amount;
3388 push @{ $r->{ext_description} }, @d;
3391 description => $description,
3392 pkgpart => $pkgpart,
3393 pkgnum => $cust_bill_pkg->pkgnum,
3395 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3396 unit_amount => $unit_amount,
3397 quantity => $cust_bill_pkg->quantity,
3399 ext_description => \@d,
3400 svc_label => ($svc_label || ''),
3401 locationnum => $cust_pkg->locationnum,
3403 $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
3406 } else { # $type eq 'U'
3408 warn "$me _items_cust_bill_pkg adding usage\n"
3411 if ( $cust_bill_pkg->hidden and defined($u) ) {
3412 # if this is a hidden package and there's already a usage
3413 # line for the bundle, add this package's total amount and
3414 # usage details to it
3415 $u->{amount} += $amount;
3416 push @{ $u->{ext_description} }, @d;
3417 } elsif ( $amount ) {
3418 # create a new usage line
3420 description => $description,
3421 pkgpart => $pkgpart,
3422 pkgnum => $cust_bill_pkg->pkgnum,
3425 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3427 ext_description => \@d,
3428 locationnum => $cust_pkg->locationnum,
3430 } # else this has no usage, so don't create a usage section
3433 } # recurring or usage with recurring charge
3435 } else { # taxes and fees
3437 warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
3440 # items of this kind should normally not have sdate/edate.
3442 'description' => $desc,
3443 'amount' => sprintf('%.2f', $cust_bill_pkg->setup
3444 + $cust_bill_pkg->recur)
3447 } # if quotation / package line item / other line item
3449 # decide whether to show active discounts here
3451 # case 1: we are showing a single line for the package
3453 # case 2: we are showing a setup line for a package that has
3454 # no base recurring fee
3455 or ( $type eq 'S' and $cust_bill_pkg->unitrecur == 0 )
3456 # case 3: we are showing a recur line for a package that has
3457 # a base recurring fee
3458 or ( $type eq 'R' and $cust_bill_pkg->unitrecur > 0 )
3461 my $item_discount = $cust_bill_pkg->_item_discount;
3462 if ( $item_discount ) {
3463 # $item_discount->{amount} is negative
3465 if ( $d and $cust_bill_pkg->hidden ) {
3466 $d->{amount} += $item_discount->{amount};
3468 $d = $item_discount;
3469 $_ = &{$escape_function}($_) foreach @{ $d->{ext_description} };
3472 # update the active line (before the discount) to show the
3473 # original price (whether this is a hidden line or not)
3475 # quotation discounts keep track of setup and recur; invoice
3476 # discounts currently don't
3477 if ( exists $item_discount->{setup_amount} ) {
3479 $s->{amount} -= $item_discount->{setup_amount} if $s;
3480 $r->{amount} -= $item_discount->{recur_amount} if $r;
3484 # $active_line is the line item hashref for the line that will
3485 # show the original price
3486 # (use the recur or single line for the package, unless we're
3487 # showing a setup line for a package with no recurring fee)
3488 my $active_line = $r;
3489 if ( $type eq 'S' ) {
3492 $active_line->{amount} -= $item_discount->{amount};
3496 } # if there are any discounts
3497 } # if this is an appropriate place to show discounts
3499 } # foreach $display
3501 $discount_show_always = ($cust_bill_pkg->cust_bill_pkg_discount
3502 && $conf->exists('discount-show-always'));
3506 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3508 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
3509 if exists($_->{amount});
3510 $_->{amount} =~ s/^\-0\.00$/0.00/;
3511 if (exists($_->{unit_amount})) {
3512 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3516 if $_->{amount} != 0
3517 || $discount_show_always
3518 || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3519 || ( $_->{_is_setup} && $_->{setup_show_zero} )
3523 warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
3530 =item _items_discounts_avail
3532 Returns an array of line item hashrefs representing available term discounts
3533 for this invoice. This makes the same assumptions that apply to term
3534 discounts in general: that the package is billed monthly, at a flat rate,
3535 with no usage charges. A prorated first month will be handled, as will
3536 a setup fee if the discount is allowed to apply to setup fees.
3540 sub _items_discounts_avail {
3543 #maybe move this method from cust_bill when quotations support discount_plans
3544 return () unless $self->can('discount_plans');
3545 my %plans = $self->discount_plans;
3547 my $list_pkgnums = 0; # if any packages are not eligible for all discounts
3548 $list_pkgnums = grep { $_->list_pkgnums } values %plans;
3552 my $plan = $plans{$months};
3554 my $term_total = sprintf('%.2f', $plan->discounted_total);
3555 my $percent = sprintf('%.0f',
3556 100 * (1 - $term_total / $plan->base_total) );
3557 my $permonth = sprintf('%.2f', $term_total / $months);
3558 my $detail = $self->mt('discount on item'). ' '.
3559 join(', ', map { "#$_" } $plan->pkgnums)
3562 # discounts for non-integer months don't work anyway
3563 $months = sprintf("%d", $months);
3566 description => $self->mt('Save [_1]% by paying for [_2] months',
3568 amount => $self->mt('[_1] ([_2] per month)',
3569 $term_total, $money_char.$permonth),
3570 ext_description => ($detail || ''),
3573 sort { $b <=> $a } keys %plans;