1 package FS::Template_Mixin;
4 use vars qw( $DEBUG $me
7 use vars qw( $invoice_lines @buf ); #yuck
8 use List::Util qw(sum);
11 use Text::Template 1.20;
17 use FS::Record qw( qsearch qsearchs );
19 use FS::Misc qw( generate_ps generate_pdf );
26 $me = '[FS::Template_Mixin]';
27 FS::UID->install_callback( sub {
28 my $conf = new FS::Conf; #global
29 $money_char = $conf->config('money_char') || '$';
34 Returns a configuration handle (L<FS::Conf>) set to the customer's locale.
36 If the "mode" pseudo-field is set on the object, the configuration handle
37 will be an L<FS::invoice_conf> for that invoice mode (and the customer's
44 my $mode = $self->get('mode');
45 if ($self->{_conf} and !defined($mode)) {
46 return $self->{_conf};
49 my $cust_main = $self->cust_main;
50 my $locale = $cust_main ? $cust_main->locale : '';
53 if ( ref $mode and $mode->isa('FS::invoice_mode') ) {
54 $mode = $mode->modenum;
55 } elsif ( $mode =~ /\D/ ) {
56 die "invalid invoice mode $mode";
58 $conf = qsearchs('invoice_conf', { modenum => $mode, locale => $locale });
60 $conf = qsearchs('invoice_conf', { modenum => $mode, locale => '' });
61 # it doesn't have a locale, but system conf still might
62 $conf->set('locale' => $locale) if $conf;
65 # if $mode is unspecified, or if there is no invoice_conf matching this mode
66 # and locale, then use the system config only (but with the locale)
67 $conf ||= FS::Conf->new({ 'locale' => $locale });
69 return $self->{_conf} = $conf;
72 =item print_text OPTIONS
74 Returns an text invoice, as a list of lines.
76 Options can be passed as a hash.
78 I<time>, if specified, is used to control the printing of overdue messages. The
79 default is now. It isn't the date of the invoice; that's the `_date' field.
80 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
81 L<Time::Local> and L<Date::Parse> for conversion functions.
83 I<template>, if specified, is the name of a suffix for alternate invoices.
85 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
93 %params = %{ shift() };
98 $params{'format'} = 'template'; # for some reason
100 $self->print_generic( %params );
103 =item print_latex HASHREF
105 Internal method - returns a filename of a filled-in LaTeX template for this
106 invoice (Note: add ".tex" to get the actual filename), and a filename of
107 an associated logo (with the .eps extension included).
109 See print_ps and print_pdf for methods that return PostScript and PDF output.
111 Options can be passed as a hash.
113 I<time>, if specified, is used to control the printing of overdue messages. The
114 default is now. It isn't the date of the invoice; that's the `_date' field.
115 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
116 L<Time::Local> and L<Date::Parse> for conversion functions.
118 I<template>, if specified, is the name of a suffix for alternate invoices.
119 This is strongly deprecated; see L<FS::invoice_conf> for the right way to
120 customize invoice templates for different purposes.
122 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
131 %params = %{ shift() };
136 $params{'format'} = 'latex';
137 my $conf = $self->conf;
139 # this needs to go away
140 my $template = $params{'template'};
141 # and this especially
142 $template ||= $self->_agent_template
143 if $self->can('_agent_template');
145 my $pkey = $self->primary_key;
146 my $tmp_template = $self->table. '.'. $self->$pkey. '.XXXXXXXX';
148 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
149 my $lh = new File::Temp(
150 TEMPLATE => $tmp_template,
154 ) or die "can't open temp file: $!\n";
156 my $agentnum = $self->agentnum;
158 if ( $template && $conf->exists("logo_${template}.eps", $agentnum) ) {
159 print $lh $conf->config_binary("logo_${template}.eps", $agentnum)
160 or die "can't write temp file: $!\n";
162 print $lh $conf->config_binary('logo.eps', $agentnum)
163 or die "can't write temp file: $!\n";
166 $params{'logo_file'} = $lh->filename;
168 if( $conf->exists('invoice-barcode')
169 && $self->can('invoice_barcode')
170 && $self->invnum ) { # don't try to barcode statements
171 my $png_file = $self->invoice_barcode($dir);
172 my $eps_file = $png_file;
173 $eps_file =~ s/\.png$/.eps/g;
174 $png_file =~ /(barcode.*png)/;
176 $eps_file =~ /(barcode.*eps)/;
179 my $curr_dir = cwd();
181 # after painfuly long experimentation, it was determined that sam2p won't
182 # accept : and other chars in the path, no matter how hard I tried to
183 # escape them, hence the chdir (and chdir back, just to be safe)
184 system('sam2p', '-j:quiet', $png_file, 'EPS:', $eps_file ) == 0
185 or die "sam2p failed: $!\n";
189 $params{'barcode_file'} = $eps_file;
192 my @filled_in = $self->print_generic( %params );
194 my $fh = new File::Temp( TEMPLATE => $tmp_template,
198 ) or die "can't open temp file: $!\n";
199 binmode($fh, ':utf8'); # language support
200 print $fh join('', @filled_in );
203 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
204 return ($1, $params{'logo_file'}, $params{'barcode_file'});
210 my $cust_main = $self->cust_main;
211 $cust_main ? $cust_main->agentnum : $self->prospect_main->agentnum;
214 =item print_generic OPTION => VALUE ...
216 Internal method - returns a filled-in template for this invoice as a scalar.
218 See print_ps and print_pdf for methods that return PostScript and PDF output.
220 Non optional options include
221 format - latex, html, template
223 Optional options include
225 template - a value used as a suffix for a configuration template. Please
228 time - a value used to control the printing of overdue messages. The
229 default is now. It isn't the date of the invoice; that's the `_date' field.
230 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
231 L<Time::Local> and L<Date::Parse> for conversion functions.
235 unsquelch_cdr - overrides any per customer cdr squelching when true
237 notice_name - overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
239 locale - override customer's locale
243 #what's with all the sprintf('%10.2f')'s in here? will it cause any
244 # (alignment in text invoice?) problems to change them all to '%.2f' ?
245 # yes: fixed width/plain text printing will be borked
247 my( $self, %params ) = @_;
248 my $conf = $self->conf;
250 my $today = $params{today} ? $params{today} : time;
251 warn "$me print_generic called on $self with suffix $params{template}\n"
254 my $format = $params{format};
255 die "Unknown format: $format"
256 unless $format =~ /^(latex|html|template)$/;
258 my $cust_main = $self->cust_main || $self->prospect_main;
259 $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
260 unless $cust_main->payname
261 && $cust_main->payby !~ /^(CARD|DCRD|CHEK|DCHK)$/;
263 my $locale = $params{'locale'} || $cust_main->locale;
265 my %delimiters = ( 'latex' => [ '[@--', '--@]' ],
266 'html' => [ '<%=', '%>' ],
267 'template' => [ '{', '}' ],
270 warn "$me print_generic creating template\n"
273 # set the notice name here, and nowhere else.
274 my $notice_name = $params{notice_name}
275 || $conf->config('notice_name')
276 || $self->notice_name;
279 my $template = $params{template} ? $params{template} : $self->_agent_template;
280 my $templatefile = $self->template_conf. $format;
281 $templatefile .= "_$template"
282 if length($template) && $conf->exists($templatefile."_$template");
285 my @invoice_template = map "$_\n", $conf->config($templatefile)
286 or die "cannot load config data $templatefile";
289 if ( $format eq 'latex' && grep { /^%%Detail/ } @invoice_template ) {
290 #change this to a die when the old code is removed
291 warn "old-style invoice template $templatefile; ".
292 "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
294 @invoice_template = _translate_old_latex_format(@invoice_template);
297 warn "$me print_generic creating T:T object\n"
300 my $text_template = new Text::Template(
302 SOURCE => \@invoice_template,
303 DELIMITERS => $delimiters{$format},
306 warn "$me print_generic compiling T:T object\n"
309 $text_template->compile()
310 or die "Can't compile $templatefile: $Text::Template::ERROR\n";
313 # additional substitution could possibly cause breakage in existing templates
316 'notes' => sub { map "$_", @_ },
317 'footer' => sub { map "$_", @_ },
318 'smallfooter' => sub { map "$_", @_ },
319 'returnaddress' => sub { map "$_", @_ },
320 'coupon' => sub { map "$_", @_ },
321 'summary' => sub { map "$_", @_ },
327 s/%%(.*)$/<!-- $1 -->/g;
328 s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
329 s/\\begin\{enumerate\}/<ol>/g;
331 s/\\end\{enumerate\}/<\/ol>/g;
332 s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
341 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
343 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
349 s/\\hyphenation\{[\w\s\-]+}//;
354 'coupon' => sub { "" },
355 'summary' => sub { "" },
362 s/\\section\*\{\\textsc\{(.*)\}\}/\U$1/g;
363 s/\\begin\{enumerate\}//g;
365 s/\\end\{enumerate\}//g;
366 s/\\textbf\{(.*)\}/$1/g;
373 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
375 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
380 s/\\\\\*?\s*$/\n/; # dubious
381 s/\\hyphenation\{[\w\s\-]+}//;
385 'coupon' => sub { "" },
386 'summary' => sub { "" },
391 # hashes for differing output formats
392 my %nbsps = ( 'latex' => '~',
393 'html' => '', # '&nbps;' would be nice
394 'template' => '', # not used
396 my $nbsp = $nbsps{$format};
398 my %escape_functions = ( 'latex' => \&_latex_escape,
399 'html' => \&_html_escape_nbsp,#\&encode_entities,
400 'template' => sub { shift },
402 my $escape_function = $escape_functions{$format};
403 my $escape_function_nonbsp = ($format eq 'html')
404 ? \&_html_escape : $escape_function;
406 my %newline_tokens = ( 'latex' => '\\\\',
410 my $newline_token = $newline_tokens{$format};
412 warn "$me generating template variables\n"
415 # generate template variables
419 defined( $conf->config_orbase( "invoice_${format}returnaddress",
423 && length( $conf->config_orbase( "invoice_${format}returnaddress",
429 $returnaddress = join("\n",
430 $conf->config_orbase("invoice_${format}returnaddress", $template)
434 $conf->config_orbase('invoice_latexreturnaddress', $template) ) {
436 my $convert_map = $convert_maps{$format}{'returnaddress'};
439 &$convert_map( $conf->config_orbase( "invoice_latexreturnaddress",
444 } elsif ( grep /\S/, $conf->config('company_address', $cust_main->agentnum) ) {
446 my $convert_map = $convert_maps{$format}{'returnaddress'};
447 $returnaddress = join( "\n", &$convert_map(
448 map { s/( {2,})/'~' x length($1)/eg;
452 ( $conf->config('company_name', $cust_main->agentnum),
453 $conf->config('company_address', $cust_main->agentnum),
460 my $warning = "Couldn't find a return address; ".
461 "do you need to set the company_address configuration value?";
463 $returnaddress = $nbsp;
464 #$returnaddress = $warning;
468 warn "$me generating invoice data\n"
471 my $agentnum = $cust_main->agentnum;
476 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
477 'company_address' => join("\n", $conf->config('company_address', $agentnum) ). "\n",
478 'company_phonenum'=> scalar( $conf->config('company_phonenum', $agentnum) ),
479 'returnaddress' => $returnaddress,
480 'agent' => &$escape_function($cust_main->agent->agent),
482 #invoice/quotation info
483 'no_number' => $params{'no_number'},
484 'invnum' => ( $params{'no_number'} ? '' : $self->invnum ),
485 'quotationnum' => $self->quotationnum,
486 'no_date' => $params{'no_date'},
487 '_date' => ( $params{'no_date'} ? '' : $self->_date ),
488 # workaround for inconsistent behavior in the early plain text
489 # templates; see RT#28271
490 'date' => ( $params{'no_date'}
492 : ($format eq 'template'
494 : $self->time2str_local('long', $self->_date, $format)
497 'today' => $self->time2str_local('long', $today, $format),
498 'terms' => $self->terms,
499 'template' => $template, #params{'template'},
500 'notice_name' => $notice_name, # escape?
501 'current_charges' => sprintf("%.2f", $self->charged),
502 'duedate' => $self->due_date2str('rdate'), #date_format?
505 'custnum' => $cust_main->display_custnum,
506 'prospectnum' => $cust_main->prospectnum,
507 'agent_custid' => &$escape_function($cust_main->agent_custid),
508 ( map { $_ => &$escape_function($cust_main->$_()) } qw(
509 payname company address1 address2 city state zip fax
513 'ship_enable' => $conf->exists('invoice-ship_address'),
514 'unitprices' => $conf->exists('invoice-unitprice'),
515 'smallernotes' => $conf->exists('invoice-smallernotes'),
516 'smallerfooter' => $conf->exists('invoice-smallerfooter'),
517 'balance_due_below_line' => $conf->exists('balance_due_below_line'),
519 #layout info -- would be fancy to calc some of this and bury the template
521 'topmargin' => scalar($conf->config('invoice_latextopmargin', $agentnum)),
522 'headsep' => scalar($conf->config('invoice_latexheadsep', $agentnum)),
523 'textheight' => scalar($conf->config('invoice_latextextheight', $agentnum)),
524 'extracouponspace' => scalar($conf->config('invoice_latexextracouponspace', $agentnum)),
525 'couponfootsep' => scalar($conf->config('invoice_latexcouponfootsep', $agentnum)),
526 'verticalreturnaddress' => $conf->exists('invoice_latexverticalreturnaddress', $agentnum),
527 'addresssep' => scalar($conf->config('invoice_latexaddresssep', $agentnum)),
528 'amountenclosedsep' => scalar($conf->config('invoice_latexcouponamountenclosedsep', $agentnum)),
529 'coupontoaddresssep' => scalar($conf->config('invoice_latexcoupontoaddresssep', $agentnum)),
530 'addcompanytoaddress' => $conf->exists('invoice_latexcouponaddcompanytoaddress', $agentnum),
532 # better hang on to conf_dir for a while (for old templates)
533 'conf_dir' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
535 #these are only used when doing paged plaintext
542 $invoice_data{'emt'} = sub { &$escape_function($self->mt(@_)) };
543 # prototype here to silence warnings
544 $invoice_data{'time2str'} = sub ($;$$) { $self->time2str_local(@_, $format) };
546 my $min_sdate = 999999999999;
548 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
549 next unless $cust_bill_pkg->pkgnum > 0;
550 $min_sdate = $cust_bill_pkg->sdate
551 if length($cust_bill_pkg->sdate) && $cust_bill_pkg->sdate < $min_sdate;
552 $max_edate = $cust_bill_pkg->edate
553 if length($cust_bill_pkg->edate) && $cust_bill_pkg->edate > $max_edate;
556 $invoice_data{'bill_period'} = '';
557 $invoice_data{'bill_period'} =
558 $self->time2str_local('%e %h', $min_sdate, $format)
560 $self->time2str_local('%e %h', $max_edate, $format)
561 if ($max_edate != 0 && $min_sdate != 999999999999);
563 $invoice_data{finance_section} = '';
564 if ( $conf->config('finance_pkgclass') ) {
566 qsearchs('pkg_class', { classnum => $conf->config('finance_pkgclass') });
567 $invoice_data{finance_section} = $pkg_class->categoryname;
569 $invoice_data{finance_amount} = '0.00';
570 $invoice_data{finance_section} ||= 'Finance Charges'; #avoid config confusion
572 my $countrydefault = $conf->config('countrydefault') || 'US';
573 foreach ( qw( address1 address2 city state zip country fax) ){
574 my $method = 'ship_'.$_;
575 $invoice_data{"ship_$_"} = $escape_function->($cust_main->$method);
577 if ( length($cust_main->ship_company) ) {
578 $invoice_data{'ship_company'} = $escape_function->($cust_main->ship_company);
580 $invoice_data{'ship_company'} = $escape_function->($cust_main->company);
582 $invoice_data{'ship_contact'} = $escape_function->($cust_main->contact);
583 $invoice_data{'ship_country'} = ''
584 if ( $invoice_data{'ship_country'} eq $countrydefault );
586 $invoice_data{'cid'} = $params{'cid'}
589 if ( $cust_main->country eq $countrydefault ) {
590 $invoice_data{'country'} = '';
592 $invoice_data{'country'} = &$escape_function(code2country($cust_main->country));
596 $invoice_data{'address'} = \@address;
599 ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
600 ? " (P.O. #". $cust_main->payinfo. ")"
604 push @address, $cust_main->company
605 if $cust_main->company;
606 push @address, $cust_main->address1;
607 push @address, $cust_main->address2
608 if $cust_main->address2;
610 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
611 push @address, $invoice_data{'country'}
612 if $invoice_data{'country'};
614 while (scalar(@address) < 5);
616 $invoice_data{'logo_file'} = $params{'logo_file'}
617 if $params{'logo_file'};
618 $invoice_data{'barcode_file'} = $params{'barcode_file'}
619 if $params{'barcode_file'};
620 $invoice_data{'barcode_img'} = $params{'barcode_img'}
621 if $params{'barcode_img'};
622 $invoice_data{'barcode_cid'} = $params{'barcode_cid'}
623 if $params{'barcode_cid'};
625 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
626 # my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
627 #my $balance_due = $self->owed + $pr_total - $cr_total;
628 my $balance_due = $self->owed + $pr_total;
630 #these are used on the summary page only
632 # the customer's current balance as shown on the invoice before this one
633 $invoice_data{'true_previous_balance'} = sprintf("%.2f", ($self->previous_balance || 0) );
635 # the change in balance from that invoice to this one
636 $invoice_data{'balance_adjustments'} = sprintf("%.2f", ($self->previous_balance || 0) - ($self->billing_balance || 0) );
638 # the sum of amount owed on all previous invoices
639 # ($pr_total is used elsewhere but not as $previous_balance)
640 $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total);
642 # the sum of amount owed on all invoices
643 # (this is used in the summary & on the payment coupon)
644 $invoice_data{'balance'} = sprintf("%.2f", $balance_due);
646 # info from customer's last invoice before this one, for some
648 $invoice_data{'last_bill'} = {};
650 if ( $self->custnum && $self->invnum ) {
652 if ( $self->previous_bill ) {
653 my $last_bill = $self->previous_bill;
654 $invoice_data{'last_bill'} = {
655 '_date' => $last_bill->_date, #unformatted
657 my (@payments, @credits);
658 # for formats that itemize previous payments
659 foreach my $cust_pay ( qsearch('cust_pay', {
660 'custnum' => $self->custnum,
661 '_date' => { op => '>=',
662 value => $last_bill->_date }
665 next if $cust_pay->_date > $self->_date;
667 '_date' => $cust_pay->_date,
668 'date' => $self->time2str_local('long', $cust_pay->_date, $format),
669 'payinfo' => $cust_pay->payby_payinfo_pretty,
670 'amount' => sprintf('%.2f', $cust_pay->paid),
672 # not concerned about applications
674 foreach my $cust_credit ( qsearch('cust_credit', {
675 'custnum' => $self->custnum,
676 '_date' => { op => '>=',
677 value => $last_bill->_date }
680 next if $cust_credit->_date > $self->_date;
682 '_date' => $cust_credit->_date,
683 'date' => $self->time2str_local('long', $cust_credit->_date, $format),
684 'creditreason'=> $cust_credit->reason,
685 'amount' => sprintf('%.2f', $cust_credit->amount),
688 $invoice_data{'previous_payments'} = \@payments;
689 $invoice_data{'previous_credits'} = \@credits;
694 my $summarypage = '';
695 if ( $conf->exists('invoice_usesummary', $agentnum) ) {
698 $invoice_data{'summarypage'} = $summarypage;
700 warn "$me substituting variables in notes, footer, smallfooter\n"
703 my $tc = $self->template_conf;
704 my @include = ( [ $tc, 'notes' ],
705 [ 'invoice_', 'footer' ],
706 [ 'invoice_', 'smallfooter', ],
708 push @include, [ $tc, 'coupon', ]
709 unless $params{'no_coupon'};
711 foreach my $i (@include) {
713 my($base, $include) = @$i;
715 my $inc_file = $conf->key_orbase("$base$format$include", $template);
718 if ( $conf->exists($inc_file, $agentnum)
719 && length( $conf->config($inc_file, $agentnum) ) ) {
721 @inc_src = $conf->config($inc_file, $agentnum);
725 $inc_file = $conf->key_orbase("${base}latex$include", $template);
727 my $convert_map = $convert_maps{$format}{$include};
729 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
730 s/--\@\]/$delimiters{$format}[1]/g;
733 &$convert_map( $conf->config($inc_file, $agentnum) );
737 my $inc_tt = new Text::Template (
739 SOURCE => [ map "$_\n", @inc_src ],
740 DELIMITERS => $delimiters{$format},
741 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
743 unless ( $inc_tt->compile() ) {
744 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
745 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
749 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
751 $invoice_data{$include} =~ s/\n+$//
752 if ($format eq 'latex');
755 # let invoices use either of these as needed
756 $invoice_data{'po_num'} = ($cust_main->payby eq 'BILL')
757 ? $cust_main->payinfo : '';
758 $invoice_data{'po_line'} =
759 ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
760 ? &$escape_function($self->mt("Purchase Order #").$cust_main->payinfo)
763 my %money_chars = ( 'latex' => '',
764 'html' => $conf->config('money_char') || '$',
767 my $money_char = $money_chars{$format};
769 my %other_money_chars = ( 'latex' => '\dollar ',#XXX should be a config too
770 'html' => $conf->config('money_char') || '$',
773 my $other_money_char = $other_money_chars{$format};
774 $invoice_data{'dollar'} = $other_money_char;
776 my %minus_signs = ( 'latex' => '$-$',
778 'template' => '- ' );
779 my $minus = $minus_signs{$format};
781 my @detail_items = ();
782 my @total_items = ();
786 $invoice_data{'detail_items'} = \@detail_items;
787 $invoice_data{'total_items'} = \@total_items;
788 $invoice_data{'buf'} = \@buf;
789 $invoice_data{'sections'} = \@sections;
791 warn "$me generating sections\n"
795 my $tax_section = { 'description' => $self->mt('Taxes, Surcharges, and Fees'),
796 'subtotal' => $taxtotal, # adjusted below
799 my $tax_weight = _pkg_category($tax_section->{description})
800 ? _pkg_category($tax_section->{description})->weight
802 $tax_section->{'summarized'} = ''; #why? $summarypage && !$tax_weight ? 'Y' : '';
803 $tax_section->{'sort_weight'} = $tax_weight;
806 my $adjust_section = {
807 'description' => $self->mt('Credits, Payments, and Adjustments'),
808 'adjust_section' => 1,
809 'subtotal' => 0, # adjusted below
811 my $adjust_weight = _pkg_category($adjust_section->{description})
812 ? _pkg_category($adjust_section->{description})->weight
814 $adjust_section->{'summarized'} = ''; #why? $summarypage && !$adjust_weight ? 'Y' : '';
815 $adjust_section->{'sort_weight'} = $adjust_weight;
817 my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
818 my $multisection = $conf->exists($tc.'sections', $cust_main->agentnum) ||
819 $conf->exists($tc.'sections_by_location', $cust_main->agentnum);
820 $invoice_data{'multisection'} = $multisection;
822 my $extra_sections = [];
823 my $extra_lines = ();
825 # default section ('Charges')
826 my $default_section = { 'description' => '',
831 # Previous Charges section
832 # subtotal is the first return value from $self->previous
833 my $previous_section;
834 # if the invoice has major sections, or if we're summarizing previous
835 # charges with a single line, or if we've been specifically told to put them
836 # in a section, create a section for previous charges:
837 if ( $multisection or
838 $conf->exists('previous_balance-summary_only') or
839 $conf->exists('previous_balance-section') ) {
841 $previous_section = { 'description' => $self->mt('Previous Charges'),
842 'subtotal' => $other_money_char.
843 sprintf('%.2f', $pr_total),
844 'summarized' => '', #why? $summarypage ? 'Y' : '',
846 $previous_section->{posttotal} = '0 / 30 / 60 / 90 days overdue '.
847 join(' / ', map { $cust_main->balance_date_range(@$_) }
848 $self->_prior_month30s
850 if $conf->exists('invoice_include_aging');
853 # otherwise put them in the main section
854 $previous_section = $default_section;
857 if ( $multisection ) {
858 ($extra_sections, $extra_lines) =
859 $self->_items_extra_usage_sections($escape_function_nonbsp, $format)
860 if $conf->exists('usage_class_as_a_section', $cust_main->agentnum)
861 && $self->can('_items_extra_usage_sections');
863 push @$extra_sections, $adjust_section if $adjust_section->{sort_weight};
865 push @detail_items, @$extra_lines if $extra_lines;
867 # the code is written so that both methods can be used together, but
868 # we haven't yet changed the template to take advantage of that, so for
869 # now, treat them as mutually exclusive.
870 my %section_method = ( by_category => 1 );
871 if ( $conf->exists($tc.'sections_by_location') ) {
872 %section_method = ( by_location => 1 );
875 $self->_items_sections( 'summary' => $summarypage,
876 'escape' => $escape_function_nonbsp,
877 'extra_sections' => $extra_sections,
881 push @sections, @$early;
882 $late_sections = $late;
884 if ( $conf->exists('svc_phone_sections')
885 && $self->can('_items_svc_phone_sections')
888 my ($phone_sections, $phone_lines) =
889 $self->_items_svc_phone_sections($escape_function_nonbsp, $format);
890 push @{$late_sections}, @$phone_sections;
891 push @detail_items, @$phone_lines;
893 if ( $conf->exists('voip-cust_accountcode_cdr')
894 && $cust_main->accountcode_cdr
895 && $self->can('_items_accountcode_cdr')
898 my ($accountcode_section, $accountcode_lines) =
899 $self->_items_accountcode_cdr($escape_function_nonbsp,$format);
900 if ( scalar(@$accountcode_lines) ) {
901 push @{$late_sections}, $accountcode_section;
902 push @detail_items, @$accountcode_lines;
905 } else {# not multisection
906 # make a default section
907 push @sections, $default_section;
908 # and calculate the finance charge total, since it won't get done otherwise.
909 # and the default section total
910 # XXX possibly finance_pkgclass should not be used in this manner?
913 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
914 if ( $invoice_data{finance_section} and
915 grep { $_->section eq $invoice_data{finance_section} }
916 $cust_bill_pkg->cust_bill_pkg_display ) {
917 # I think these are always setup fees, but just to be sure...
918 push @finance_charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
920 push @charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
923 $invoice_data{finance_amount} =
924 sprintf('%.2f', sum( @finance_charges ) || 0);
925 $default_section->{subtotal} = $other_money_char.
926 sprintf('%.2f', sum( @charges ) || 0);
929 # previous invoice balances in the Previous Charges section if there
930 # is one, otherwise in the main detail section
931 # (except if summary_only is enabled, don't show them at all)
932 if ( $self->can('_items_previous') &&
933 $self->enable_previous &&
934 ! $conf->exists('previous_balance-summary_only') ) {
936 warn "$me adding previous balances\n"
939 foreach my $line_item ( $self->_items_previous ) {
942 ref => $line_item->{'pkgnum'},
943 pkgpart => $line_item->{'pkgpart'},
944 #quantity => 1, # not really correct
945 section => $previous_section, # which might be $default_section
946 description => &$escape_function($line_item->{'description'}),
947 ext_description => [ map { &$escape_function($_) }
948 @{ $line_item->{'ext_description'} || [] }
950 amount => ( $old_latex ? '' : $money_char).
951 $line_item->{'amount'},
952 product_code => $line_item->{'pkgpart'} || 'N/A',
955 push @detail_items, $detail;
956 push @buf, [ $detail->{'description'},
957 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
963 if ( @pr_cust_bill && $self->enable_previous ) {
964 push @buf, ['','-----------'];
965 push @buf, [ $self->mt('Total Previous Balance'),
966 $money_char. sprintf("%10.2f", $pr_total) ];
970 if ( $conf->exists('svc_phone-did-summary') && $self->can('_did_summary') ) {
971 warn "$me adding DID summary\n"
974 my ($didsummary,$minutes) = $self->_did_summary;
975 my $didsummary_desc = 'DID Activity Summary (since last invoice)';
977 { 'description' => $didsummary_desc,
978 'ext_description' => [ $didsummary, $minutes ],
982 foreach my $section (@sections, @$late_sections) {
984 # begin some normalization
985 $section->{'subtotal'} = $section->{'amount'}
987 && !exists($section->{subtotal})
988 && exists($section->{amount});
990 $invoice_data{finance_amount} = sprintf('%.2f', $section->{'subtotal'} )
991 if ( $invoice_data{finance_section} &&
992 $section->{'description'} eq $invoice_data{finance_section} );
994 $section->{'subtotal'} = $other_money_char.
995 sprintf('%.2f', $section->{'subtotal'})
998 # continue some normalization
999 $section->{'amount'} = $section->{'subtotal'}
1003 if ( $section->{'description'} ) {
1004 push @buf, ( [ &$escape_function($section->{'description'}), '' ],
1009 warn "$me setting options\n"
1013 $options{'section'} = $section if $multisection;
1014 $options{'format'} = $format;
1015 $options{'escape_function'} = $escape_function;
1016 $options{'no_usage'} = 1 unless $unsquelched;
1017 $options{'unsquelched'} = $unsquelched;
1018 $options{'summary_page'} = $summarypage;
1019 $options{'skip_usage'} =
1020 scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
1022 warn "$me searching for line items\n"
1025 foreach my $line_item ( $self->_items_pkg(%options),
1026 $self->_items_fee(%options) ) {
1028 warn "$me adding line item $line_item\n"
1032 ext_description => [],
1034 $detail->{'ref'} = $line_item->{'pkgnum'};
1035 $detail->{'pkgpart'} = $line_item->{'pkgpart'};
1036 $detail->{'quantity'} = $line_item->{'quantity'};
1037 $detail->{'section'} = $section;
1038 $detail->{'description'} = &$escape_function($line_item->{'description'});
1039 if ( exists $line_item->{'ext_description'} ) {
1040 @{$detail->{'ext_description'}} = @{$line_item->{'ext_description'}};
1042 $detail->{'amount'} = ( $old_latex ? '' : $money_char ).
1043 $line_item->{'amount'};
1044 if ( exists $line_item->{'unit_amount'} ) {
1045 $detail->{'unit_amount'} = ( $old_latex ? '' : $money_char ).
1046 $line_item->{'unit_amount'};
1048 $detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
1050 $detail->{'sdate'} = $line_item->{'sdate'};
1051 $detail->{'edate'} = $line_item->{'edate'};
1052 $detail->{'seconds'} = $line_item->{'seconds'};
1053 $detail->{'svc_label'} = $line_item->{'svc_label'};
1055 push @detail_items, $detail;
1056 push @buf, ( [ $detail->{'description'},
1057 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1059 map { [ " ". $_, '' ] } @{$detail->{'ext_description'}},
1063 if ( $section->{'description'} ) {
1064 push @buf, ( ['','-----------'],
1065 [ $section->{'description'}. ' sub-total',
1066 $section->{'subtotal'} # already formatted this
1075 $invoice_data{current_less_finance} =
1076 sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
1078 # if there's anything in the Previous Charges section, prepend it to the list
1079 if ( $pr_total and $previous_section ne $default_section ) {
1080 unshift @sections, $previous_section;
1083 warn "$me adding taxes\n"
1086 my @items_tax = $self->_items_tax;
1087 foreach my $tax ( @items_tax ) {
1089 $taxtotal += $tax->{'amount'};
1091 my $description = &$escape_function( $tax->{'description'} );
1092 my $amount = sprintf( '%.2f', $tax->{'amount'} );
1094 if ( $multisection ) {
1096 my $money = $old_latex ? '' : $money_char;
1097 push @detail_items, {
1098 ext_description => [],
1101 description => $description,
1102 amount => $money. $amount,
1104 section => $tax_section,
1109 push @total_items, {
1110 'total_item' => $description,
1111 'total_amount' => $other_money_char. $amount,
1116 push @buf,[ $description,
1117 $money_char. $amount,
1124 $total->{'total_item'} = $self->mt('Sub-total');
1125 $total->{'total_amount'} =
1126 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
1128 if ( $multisection ) {
1129 $tax_section->{'subtotal'} = $other_money_char.
1130 sprintf('%.2f', $taxtotal);
1131 $tax_section->{'pretotal'} = 'New charges sub-total '.
1132 $total->{'total_amount'};
1133 push @sections, $tax_section if $taxtotal;
1135 unshift @total_items, $total;
1138 $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
1140 push @buf,['','-----------'];
1141 push @buf,[$self->mt(
1142 (!$self->enable_previous)
1144 : 'Total New Charges'
1146 $money_char. sprintf("%10.2f",$self->charged) ];
1154 my %embolden_functions = (
1155 'latex' => sub { return '\textbf{'. shift(). '}' },
1156 'html' => sub { return '<b>'. shift(). '</b>' },
1157 'template' => sub { shift },
1159 my $embolden_function = $embolden_functions{$format};
1161 if ( $self->can('_items_total') ) { # quotations
1163 $self->_items_total(\@total_items);
1165 foreach ( @total_items ) {
1166 $_->{'total_item'} = &$embolden_function( $_->{'total_item'} );
1167 $_->{'total_amount'} = &$embolden_function( $other_money_char.
1168 $_->{'total_amount'}
1172 } else { #normal invoice case
1174 # calculate total, possibly including total owed on previous
1178 $item = $conf->config('previous_balance-exclude_from_total')
1179 || 'Total New Charges'
1180 if $conf->exists('previous_balance-exclude_from_total');
1181 my $amount = $self->charged;
1182 if ( $self->enable_previous and !$conf->exists('previous_balance-exclude_from_total') ) {
1183 $amount += $pr_total;
1186 $total->{'total_item'} = &$embolden_function($self->mt($item));
1187 $total->{'total_amount'} =
1188 &$embolden_function( $other_money_char. sprintf( '%.2f', $amount ) );
1189 if ( $multisection ) {
1190 if ( $adjust_section->{'sort_weight'} ) {
1191 $adjust_section->{'posttotal'} = $self->mt('Balance Forward').' '.
1192 $other_money_char. sprintf("%.2f", ($self->billing_balance || 0) );
1194 $adjust_section->{'pretotal'} = $self->mt('New charges total').' '.
1195 $other_money_char. sprintf('%.2f', $self->charged );
1198 push @total_items, $total;
1200 push @buf,['','-----------'];
1203 sprintf( '%10.2f', $amount )
1207 # if we're showing previous invoices, also show previous
1208 # credits and payments
1209 if ( $self->enable_previous
1210 and $self->can('_items_credits')
1211 and $self->can('_items_payments') )
1213 #foreach my $thing ( sort { $a->_date <=> $b->_date } $self->_items_credits, $self->_items_payments
1216 my $credittotal = 0;
1217 foreach my $credit (
1218 $self->_items_credits( 'template' => $template, 'trim_len' => 60 )
1222 $total->{'total_item'} = &$escape_function($credit->{'description'});
1223 $credittotal += $credit->{'amount'};
1224 $total->{'total_amount'} = $minus.$other_money_char.$credit->{'amount'};
1225 $adjusttotal += $credit->{'amount'};
1226 if ( $multisection ) {
1227 my $money = $old_latex ? '' : $money_char;
1228 push @detail_items, {
1229 ext_description => [],
1232 description => &$escape_function($credit->{'description'}),
1233 amount => $money. $credit->{'amount'},
1235 section => $adjust_section,
1238 push @total_items, $total;
1242 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
1245 foreach my $credit (
1246 $self->_items_credits( 'template' => $template, 'trim_len'=>32 )
1248 push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
1252 my $paymenttotal = 0;
1253 foreach my $payment (
1254 $self->_items_payments( 'template' => $template )
1257 $total->{'total_item'} = &$escape_function($payment->{'description'});
1258 $paymenttotal += $payment->{'amount'};
1259 $total->{'total_amount'} = $minus.$other_money_char.$payment->{'amount'};
1260 $adjusttotal += $payment->{'amount'};
1261 if ( $multisection ) {
1262 my $money = $old_latex ? '' : $money_char;
1263 push @detail_items, {
1264 ext_description => [],
1267 description => &$escape_function($payment->{'description'}),
1268 amount => $money. $payment->{'amount'},
1270 section => $adjust_section,
1273 push @total_items, $total;
1275 push @buf, [ $payment->{'description'},
1276 $money_char. sprintf("%10.2f", $payment->{'amount'}),
1279 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
1281 if ( $multisection ) {
1282 $adjust_section->{'subtotal'} = $other_money_char.
1283 sprintf('%.2f', $adjusttotal);
1284 push @sections, $adjust_section
1285 unless $adjust_section->{sort_weight};
1288 # create Balance Due message
1291 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1292 $total->{'total_amount'} =
1293 &$embolden_function(
1294 $other_money_char. sprintf('%.2f', #why? $summarypage
1295 # ? $self->charged +
1296 # $self->billing_balance
1298 $self->owed + $pr_total
1301 if ( $multisection && !$adjust_section->{sort_weight} ) {
1302 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
1303 $total->{'total_amount'};
1305 push @total_items, $total;
1307 push @buf,['','-----------'];
1308 push @buf,[$self->balance_due_msg, $money_char.
1309 sprintf("%10.2f", $balance_due ) ];
1312 if ( $conf->exists('previous_balance-show_credit')
1313 and $cust_main->balance < 0 ) {
1314 my $credit_total = {
1315 'total_item' => &$embolden_function($self->credit_balance_msg),
1316 'total_amount' => &$embolden_function(
1317 $other_money_char. sprintf('%.2f', -$cust_main->balance)
1320 if ( $multisection ) {
1321 $adjust_section->{'posttotal'} .= $newline_token .
1322 $credit_total->{'total_item'} . ' ' . $credit_total->{'total_amount'};
1325 push @total_items, $credit_total;
1327 push @buf,['','-----------'];
1328 push @buf,[$self->credit_balance_msg, $money_char.
1329 sprintf("%10.2f", -$cust_main->balance ) ];
1333 } #end of default total adding ! can('_items_total')
1335 if ( $multisection ) {
1336 if ( $conf->exists('svc_phone_sections')
1337 && $self->can('_items_svc_phone_sections')
1341 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1342 $total->{'total_amount'} =
1343 &$embolden_function(
1344 $other_money_char. sprintf('%.2f', $self->owed + $pr_total)
1346 my $last_section = pop @sections;
1347 $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
1348 $total->{'total_amount'};
1349 push @sections, $last_section;
1351 push @sections, @$late_sections
1355 # make a discounts-available section, even without multisection
1356 if ( $conf->exists('discount-show_available')
1357 and my @discounts_avail = $self->_items_discounts_avail ) {
1358 my $discount_section = {
1359 'description' => $self->mt('Discounts Available'),
1364 push @sections, $discount_section;
1365 push @detail_items, map { +{
1366 'ref' => '', #should this be something else?
1367 'section' => $discount_section,
1368 'description' => &$escape_function( $_->{description} ),
1369 'amount' => $money_char . &$escape_function( $_->{amount} ),
1370 'ext_description' => [ &$escape_function($_->{ext_description}) || () ],
1371 } } @discounts_avail;
1374 my @summary_subtotals;
1375 # the templates say "$_->{tax_section} || !$_->{summarized}"
1376 # except 'summarized' is only true when tax_section is true, so this
1377 # is always true, so what's the deal?
1378 foreach my $s (@sections) {
1379 # not to include in the "summary of new charges" block:
1380 # finance charges, adjustments, previous charges,
1381 # and itemized phone usage sections
1382 if ( $s eq $adjust_section or
1383 ($s eq $previous_section and $s ne $default_section) or
1384 ($invoice_data{'finance_section'} and
1385 $invoice_data{'finance_section'} eq $s->{description}) or
1386 $s->{'description'} =~ /^\d+ $/ ) {
1389 push @summary_subtotals, $s;
1391 $invoice_data{summary_subtotals} = \@summary_subtotals;
1393 # debugging hook: call this with 'diag' => 1 to just get a hash of
1394 # the invoice variables
1395 return \%invoice_data if ( $params{'diag'} );
1397 # All sections and items are built; now fill in templates.
1398 my @includelist = ();
1399 push @includelist, 'summary' if $summarypage;
1400 foreach my $include ( @includelist ) {
1402 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
1405 if ( length( $conf->config($inc_file, $agentnum) ) ) {
1407 @inc_src = $conf->config($inc_file, $agentnum);
1411 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
1413 my $convert_map = $convert_maps{$format}{$include};
1415 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
1416 s/--\@\]/$delimiters{$format}[1]/g;
1419 &$convert_map( $conf->config($inc_file, $agentnum) );
1423 my $inc_tt = new Text::Template (
1425 SOURCE => [ map "$_\n", @inc_src ],
1426 DELIMITERS => $delimiters{$format},
1427 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
1429 unless ( $inc_tt->compile() ) {
1430 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
1431 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
1435 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
1437 $invoice_data{$include} =~ s/\n+$//
1438 if ($format eq 'latex');
1443 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1444 /invoice_lines\((\d*)\)/;
1445 $invoice_lines += $1 || scalar(@buf);
1448 die "no invoice_lines() functions in template?"
1449 if ( $format eq 'template' && !$wasfunc );
1451 if ($format eq 'template') {
1453 if ( $invoice_lines ) {
1454 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
1455 $invoice_data{'total_pages'}++
1456 if scalar(@buf) % $invoice_lines;
1459 #setup subroutine for the template
1460 $invoice_data{invoice_lines} = sub {
1461 my $lines = shift || scalar(@buf);
1473 push @collect, split("\n",
1474 $text_template->fill_in( HASH => \%invoice_data )
1476 $invoice_data{'page'}++;
1478 map "$_\n", @collect;
1480 } else { # this is where we actually create the invoice
1482 warn "filling in template for invoice ". $self->invnum. "\n"
1484 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
1487 $text_template->fill_in(HASH => \%invoice_data);
1491 sub notice_name { '('.shift->table.')'; }
1493 sub template_conf { 'invoice_'; }
1495 # helper routine for generating date ranges
1496 sub _prior_month30s {
1499 [ 1, 2592000 ], # 0-30 days ago
1500 [ 2592000, 5184000 ], # 30-60 days ago
1501 [ 5184000, 7776000 ], # 60-90 days ago
1502 [ 7776000, 0 ], # 90+ days ago
1505 map { [ $_->[0] ? $self->_date - $_->[0] - 1 : '',
1506 $_->[1] ? $self->_date - $_->[1] - 1 : '',
1511 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
1513 Returns an postscript invoice, as a scalar.
1515 Options can be passed as a hashref (recommended) or as a list of time, template
1516 and then any key/value pairs for any other options.
1518 I<time> an optional value used to control the printing of overdue messages. The
1519 default is now. It isn't the date of the invoice; that's the `_date' field.
1520 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1521 L<Time::Local> and L<Date::Parse> for conversion functions.
1523 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1530 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1531 my $ps = generate_ps($file);
1533 unlink($barcodefile) if $barcodefile;
1538 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
1540 Returns an PDF invoice, as a scalar.
1542 Options can be passed as a hashref (recommended) or as a list of time, template
1543 and then any key/value pairs for any other options.
1545 I<time> an optional value used to control the printing of overdue messages. The
1546 default is now. It isn't the date of the invoice; that's the `_date' field.
1547 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1548 L<Time::Local> and L<Date::Parse> for conversion functions.
1550 I<template>, if specified, is the name of a suffix for alternate invoices.
1552 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1559 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1560 my $pdf = generate_pdf($file);
1562 unlink($barcodefile) if $barcodefile;
1567 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
1569 Returns an HTML invoice, as a scalar.
1571 I<time> an optional value used to control the printing of overdue messages. The
1572 default is now. It isn't the date of the invoice; that's the `_date' field.
1573 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1574 L<Time::Local> and L<Date::Parse> for conversion functions.
1576 I<template>, if specified, is the name of a suffix for alternate invoices.
1578 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1580 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
1581 when emailing the invoice as part of a multipart/related MIME email.
1589 %params = %{ shift() };
1593 $params{'format'} = 'html';
1595 $self->print_generic( %params );
1598 # quick subroutine for print_latex
1600 # There are ten characters that LaTeX treats as special characters, which
1601 # means that they do not simply typeset themselves:
1602 # # $ % & ~ _ ^ \ { }
1604 # TeX ignores blanks following an escaped character; if you want a blank (as
1605 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
1609 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
1610 $value =~ s/([<>])/\$$1\$/g;
1616 encode_entities($value);
1620 sub _html_escape_nbsp {
1621 my $value = _html_escape(shift);
1622 $value =~ s/ +/ /g;
1626 #utility methods for print_*
1628 sub _translate_old_latex_format {
1629 warn "_translate_old_latex_format called\n"
1636 if ( $line =~ /^%%Detail\s*$/ ) {
1638 push @template, q![@--!,
1639 q! foreach my $_tr_line (@detail_items) {!,
1640 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
1641 q! $_tr_line->{'description'} .= !,
1642 q! "\\tabularnewline\n~~".!,
1643 q! join( "\\tabularnewline\n~~",!,
1644 q! @{$_tr_line->{'ext_description'}}!,
1648 while ( ( my $line_item_line = shift )
1649 !~ /^%%EndDetail\s*$/ ) {
1650 $line_item_line =~ s/'/\\'/g; # nice LTS
1651 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1652 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1653 push @template, " \$OUT .= '$line_item_line';";
1656 push @template, '}',
1659 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1661 push @template, '[@--',
1662 ' foreach my $_tr_line (@total_items) {';
1664 while ( ( my $total_item_line = shift )
1665 !~ /^%%EndTotalDetails\s*$/ ) {
1666 $total_item_line =~ s/'/\\'/g; # nice LTS
1667 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1668 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1669 push @template, " \$OUT .= '$total_item_line';";
1672 push @template, '}',
1676 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
1677 push @template, $line;
1683 warn "$_\n" foreach @template;
1691 my $conf = $self->conf;
1693 #check for an invoice-specific override
1694 return $self->invoice_terms if $self->invoice_terms;
1696 #check for a customer- specific override
1697 my $cust_main = $self->cust_main;
1698 return $cust_main->invoice_terms if $cust_main && $cust_main->invoice_terms;
1700 #use configured default
1701 $conf->config('invoice_default_terms') || '';
1707 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1708 $duedate = $self->_date() + ( $1 * 86400 );
1715 $self->due_date ? $self->time2str_local(shift, $self->due_date) : '';
1718 sub balance_due_msg {
1720 my $msg = $self->mt('Balance Due');
1721 return $msg unless $self->terms;
1722 if ( $self->due_date ) {
1723 $msg .= ' - ' . $self->mt('Please pay by'). ' '.
1724 $self->due_date2str('short');
1725 } elsif ( $self->terms ) {
1726 $msg .= ' - '. $self->terms;
1731 sub balance_due_date {
1733 my $conf = $self->conf;
1735 if ( $conf->exists('invoice_default_terms')
1736 && $conf->config('invoice_default_terms')=~ /^\s*Net\s*(\d+)\s*$/ ) {
1737 $duedate = $self->time2str_local('rdate', $self->_date + ($1*86400) );
1742 sub credit_balance_msg {
1744 $self->mt('Credit Balance Remaining')
1749 Returns a string with the date, for example: "3/20/2008"
1755 $self->time2str_local('short', $self->_date);
1758 =item _items_sections OPTIONS
1760 Generate section information for all items appearing on this invoice.
1761 This will only be called for multi-section invoices.
1763 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
1764 related display records (L<FS::cust_bill_pkg_display>) and organize
1765 them into two groups ("early" and "late" according to whether they come
1766 before or after the total), then into sections. A subtotal is calculated
1769 Section descriptions are returned in sort weight order. Each consists
1770 of a hash containing:
1772 description: the package category name, escaped
1773 subtotal: the total charges in that section
1774 tax_section: a flag indicating that the section contains only tax charges
1775 summarized: same as tax_section, for some reason
1776 sort_weight: the package category's sort weight
1778 If 'condense' is set on the display record, it also contains everything
1779 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
1780 coderefs to generate parts of the invoice. This is not advised.
1782 The method returns two arrayrefs, one of "early" sections and one of "late"
1785 OPTIONS may include:
1787 by_location: a flag to divide the invoice into sections by location.
1788 Each section hash will have a 'location' element containing a hashref of
1789 the location fields (see L<FS::cust_location>). The section description
1790 will be the location label, but the template can use any of the location
1791 fields to create a suitable label.
1793 by_category: a flag to divide the invoice into sections using display
1794 records (see L<FS::cust_bill_pkg_display>). This is the "traditional"
1795 behavior. Each section hash will have a 'category' element containing
1796 the section name from the display record (which probably equals the
1797 category name of the package, but may not in some cases).
1799 summary: a flag indicating that this is a summary-format invoice.
1800 Turning this on has the following effects:
1801 - Ignores display items with the 'summary' flag.
1802 - Places all sections in the "early" group even if they have post_total.
1803 - Creates sections for all non-disabled package categories, even if they
1804 have no charges on this invoice, as well as a section with no name.
1806 escape: an escape function to use for section titles.
1808 extra_sections: an arrayref of additional sections to return after the
1809 sorted list. If there are any of these, section subtotals exclude
1812 format: 'latex', 'html', or 'template' (i.e. text). Not used, but
1813 passed through to C<_condense_section()>.
1817 use vars qw(%pkg_category_cache);
1818 sub _items_sections {
1822 my $escape = $opt{escape};
1823 my @extra_sections = @{ $opt{extra_sections} || [] };
1825 # $subtotal{$locationnum}{$categoryname} = amount.
1826 # if we're not using by_location, $locationnum is undef.
1827 # if we're not using by_category, you guessed it, $categoryname is undef.
1828 # if we're not using either one, we shouldn't be here in the first place...
1830 my %late_subtotal = ();
1833 # About tax items + multisection invoices:
1834 # If either invoice_*summary option is enabled, AND there is a
1835 # package category with the name of the tax, then there will be
1836 # a display record assigning the tax item to that category.
1838 # However, the taxes are always placed in the "Taxes, Surcharges,
1839 # and Fees" section regardless of that. The only effect of the
1840 # display record is to create a subtotal for the summary page.
1843 my $pkg_hash = $self->cust_pkg_hash;
1845 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
1848 my $usage = $cust_bill_pkg->usage;
1851 if ( $opt{by_location} ) {
1852 if ( $cust_bill_pkg->pkgnum ) {
1853 $locationnum = $pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum;
1858 $locationnum = undef;
1861 # as in _items_cust_pkg, if a line item has no display records,
1862 # cust_bill_pkg_display() returns a default record for it
1864 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
1865 next if ( $display->summary && $opt{summary} );
1867 my $section = $display->section;
1868 my $type = $display->type;
1869 # Set $section = undef if we're sectioning by location and this
1870 # line item _has_ a location (i.e. isn't a fee).
1871 $section = undef if $locationnum;
1873 # set this flag if the section is not tax-only
1874 $not_tax{$locationnum}{$section} = 1
1875 if $cust_bill_pkg->pkgnum or $cust_bill_pkg->feepart;
1877 # there's actually a very important piece of logic buried in here:
1878 # incrementing $late_subtotal{$section} CREATES
1879 # $late_subtotal{$section}. keys(%late_subtotal) is later used
1880 # to define the list of late sections, and likewise keys(%subtotal).
1881 # When _items_cust_bill_pkg is called to generate line items for
1882 # real, it will be called with 'section' => $section for each
1884 if ( $display->post_total && !$opt{summary} ) {
1885 if (! $type || $type eq 'S') {
1886 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
1887 if $cust_bill_pkg->setup != 0
1888 || $cust_bill_pkg->setup_show_zero;
1892 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur
1893 if $cust_bill_pkg->recur != 0
1894 || $cust_bill_pkg->recur_show_zero;
1897 if ($type && $type eq 'R') {
1898 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
1899 if $cust_bill_pkg->recur != 0
1900 || $cust_bill_pkg->recur_show_zero;
1903 if ($type && $type eq 'U') {
1904 $late_subtotal{$locationnum}{$section} += $usage
1905 unless scalar(@extra_sections);
1908 } else { # it's a pre-total (normal) section
1910 # skip tax items unless they're explicitly included in a section
1911 next if $cust_bill_pkg->pkgnum == 0 and
1912 ! $cust_bill_pkg->feepart and
1915 if (! $type || $type eq 'S') {
1916 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
1917 if $cust_bill_pkg->setup != 0
1918 || $cust_bill_pkg->setup_show_zero;
1922 $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur
1923 if $cust_bill_pkg->recur != 0
1924 || $cust_bill_pkg->recur_show_zero;
1927 if ($type && $type eq 'R') {
1928 $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
1929 if $cust_bill_pkg->recur != 0
1930 || $cust_bill_pkg->recur_show_zero;
1933 if ($type && $type eq 'U') {
1934 $subtotal{$locationnum}{$section} += $usage
1935 unless scalar(@extra_sections);
1944 %pkg_category_cache = ();
1946 # summary invoices need subtotals for all non-disabled package categories,
1947 # even if they're zero
1948 # but currently assume that there are no location sections, or at least
1949 # that the summary page doesn't care about them
1950 if ( $opt{summary} ) {
1951 foreach my $category (qsearch('pkg_category', {disabled => ''})) {
1952 $subtotal{''}{$category->categoryname} ||= 0;
1954 $subtotal{''}{''} ||= 0;
1958 foreach my $post_total (0,1) {
1960 my $s = $post_total ? \%late_subtotal : \%subtotal;
1961 foreach my $locationnum (keys %$s) {
1962 foreach my $sectionname (keys %{ $s->{$locationnum} }) {
1964 'subtotal' => $s->{$locationnum}{$sectionname},
1965 'post_total' => $post_total,
1968 if ( $locationnum ) {
1969 $section->{'locationnum'} = $locationnum;
1970 my $location = FS::cust_location->by_key($locationnum);
1971 $section->{'description'} = &{ $escape }($location->location_label);
1972 # Better ideas? This will roughly group them by proximity,
1973 # which alpha sorting on any of the address fields won't.
1974 # Sorting by locationnum is meaningless.
1975 # We have to sort on _something_ or the order may change
1976 # randomly from one invoice to the next, which will confuse
1978 $section->{'sort_weight'} = sprintf('%012s',$location->zip) .
1980 $section->{'location'} = {
1981 map { $_ => &{ $escape }($location->get($_)) }
1985 $section->{'category'} = $sectionname;
1986 $section->{'description'} = &{ $escape }($sectionname);
1987 if ( _pkg_category($_) ) {
1988 $section->{'sort_weight'} = _pkg_category($_)->weight;
1989 if ( _pkg_category($_)->condense ) {
1990 $section = { %$section, $self->_condense_section($opt{format}) };
1994 if ( !$post_total and !$not_tax{$locationnum}{$sectionname} ) {
1995 # then it's a tax-only section
1996 $section->{'summarized'} = 'Y';
1997 $section->{'tax_section'} = 'Y';
1999 push @these, $section;
2000 } # foreach $sectionname
2001 } #foreach $locationnum
2002 push @these, @extra_sections if $post_total == 0;
2003 # need an alpha sort for location sections, because postal codes can
2005 $sections[ $post_total ] = [ sort {
2006 $opt{'by_location'} ?
2007 ($a->{sort_weight} cmp $b->{sort_weight}) :
2008 ($a->{sort_weight} <=> $b->{sort_weight})
2010 } #foreach $post_total
2012 return @sections; # early, late
2015 #helper subs for above
2019 $self->{cust_pkg} ||= { map { $_->pkgnum => $_ } $self->cust_pkg };
2023 my $categoryname = shift;
2024 $pkg_category_cache{$categoryname} ||=
2025 qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
2028 my %condensed_format = (
2029 'label' => [ qw( Description Qty Amount ) ],
2031 sub { shift->{description} },
2032 sub { shift->{quantity} },
2033 sub { my($href, %opt) = @_;
2034 ($opt{dollar} || ''). $href->{amount};
2037 'align' => [ qw( l r r ) ],
2038 'span' => [ qw( 5 1 1 ) ], # unitprices?
2039 'width' => [ qw( 10.7cm 1.4cm 1.6cm ) ], # don't like this
2042 sub _condense_section {
2043 my ( $self, $format ) = ( shift, shift );
2045 map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
2046 qw( description_generator
2049 total_line_generator
2054 sub _condensed_generator_defaults {
2055 my ( $self, $format ) = ( shift, shift );
2056 return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
2065 sub _condensed_header_generator {
2066 my ( $self, $format ) = ( shift, shift );
2068 my ( $f, $prefix, $suffix, $separator, $column ) =
2069 _condensed_generator_defaults($format);
2071 if ($format eq 'latex') {
2072 $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
2073 $suffix = "\\\\\n\\hline";
2076 sub { my ($d,$a,$s,$w) = @_;
2077 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2079 } elsif ( $format eq 'html' ) {
2080 $prefix = '<th></th>';
2084 sub { my ($d,$a,$s,$w) = @_;
2085 return qq!<th align="$html_align{$a}">$d</th>!;
2093 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2095 &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
2098 $prefix. join($separator, @result). $suffix;
2103 sub _condensed_description_generator {
2104 my ( $self, $format ) = ( shift, shift );
2106 my ( $f, $prefix, $suffix, $separator, $column ) =
2107 _condensed_generator_defaults($format);
2109 my $money_char = '$';
2110 if ($format eq 'latex') {
2111 $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
2113 $separator = " & \n";
2115 sub { my ($d,$a,$s,$w) = @_;
2116 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2118 $money_char = '\\dollar';
2119 }elsif ( $format eq 'html' ) {
2120 $prefix = '"><td align="center"></td>';
2124 sub { my ($d,$a,$s,$w) = @_;
2125 return qq!<td align="$html_align{$a}">$d</td>!;
2127 #$money_char = $conf->config('money_char') || '$';
2128 $money_char = ''; # this is madness
2136 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2138 $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
2140 &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
2141 map { $f->{$_}->[$i] } qw(align span width)
2145 $prefix. join( $separator, @result ). $suffix;
2150 sub _condensed_total_generator {
2151 my ( $self, $format ) = ( shift, shift );
2153 my ( $f, $prefix, $suffix, $separator, $column ) =
2154 _condensed_generator_defaults($format);
2157 if ($format eq 'latex') {
2160 $separator = " & \n";
2162 sub { my ($d,$a,$s,$w) = @_;
2163 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2165 }elsif ( $format eq 'html' ) {
2169 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2171 sub { my ($d,$a,$s,$w) = @_;
2172 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2181 # my $r = &{$f->{fields}->[$i]}(@args);
2182 # $r .= ' Total' unless $i;
2184 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2186 &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
2187 map { $f->{$_}->[$i] } qw(align span width)
2191 $prefix. join( $separator, @result ). $suffix;
2196 =item total_line_generator FORMAT
2198 Returns a coderef used for generation of invoice total line items for this
2199 usage_class. FORMAT is either html or latex
2203 # should not be used: will have issues with hash element names (description vs
2204 # total_item and amount vs total_amount -- another array of functions?
2206 sub _condensed_total_line_generator {
2207 my ( $self, $format ) = ( shift, shift );
2209 my ( $f, $prefix, $suffix, $separator, $column ) =
2210 _condensed_generator_defaults($format);
2213 if ($format eq 'latex') {
2216 $separator = " & \n";
2218 sub { my ($d,$a,$s,$w) = @_;
2219 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2221 }elsif ( $format eq 'html' ) {
2225 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2227 sub { my ($d,$a,$s,$w) = @_;
2228 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2237 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2239 &{$column}( &{$f->{fields}->[$i]}(@args),
2240 map { $f->{$_}->[$i] } qw(align span width)
2244 $prefix. join( $separator, @result ). $suffix;
2249 =item _items_pkg [ OPTIONS ]
2251 Return line item hashes for each package item on this invoice. Nearly
2254 $self->_items_cust_bill_pkg([ $self->cust_bill_pkg ])
2256 The only OPTIONS accepted is 'section', which may point to a hashref
2257 with a key named 'condensed', which may have a true value. If it
2258 does, this method tries to merge identical items into items with
2259 'quantity' equal to the number of items (not the sum of their
2260 separate quantities, for some reason).
2266 grep { $_->pkgnum } $self->cust_bill_pkg;
2272 my @cust_bill_pkg = grep { $_->feepart } $self->cust_bill_pkg;
2274 foreach my $cust_bill_pkg (@cust_bill_pkg) {
2275 # cache this, so we don't look it up again in every section
2276 my $part_fee = $cust_bill_pkg->get('part_fee')
2277 || $cust_bill_pkg->part_fee;
2278 $cust_bill_pkg->set('part_fee', $part_fee);
2280 #die "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n"; # might make more sense
2281 warn "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n";
2284 if ( exists($options{section}) and exists($options{section}{category}) )
2286 my $categoryname = $options{section}{category};
2287 # then filter for items that have that section
2288 if ( $part_fee->categoryname ne $categoryname ) {
2289 warn "skipping fee '".$part_fee->itemdesc."'--not in section $categoryname\n" if $DEBUG;
2292 } # otherwise include them all in the main section
2293 # XXX what to do when sectioning by location?
2296 my %base_invnums; # invnum => invoice date
2297 foreach ($cust_bill_pkg->cust_bill_pkg_fee) {
2298 if ($_->base_invnum) {
2299 my $base_bill = FS::cust_bill->by_key($_->base_invnum);
2300 my $base_date = $self->time2str_local('short', $base_bill->_date)
2302 $base_invnums{$_->base_invnum} = $base_date || '';
2305 foreach (sort keys(%base_invnums)) {
2306 next if $_ == $self->invnum;
2308 $self->mt('from invoice \\#[_1] on [_2]', $_, $base_invnums{$_});
2311 { feepart => $cust_bill_pkg->feepart,
2312 amount => sprintf('%.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
2313 description => $part_fee->itemdesc_locale($self->cust_main->locale),
2314 ext_description => \@ext_desc
2325 warn "$me _items_pkg searching for all package line items\n"
2328 my @cust_bill_pkg = $self->_items_nontax;
2330 warn "$me _items_pkg filtering line items\n"
2332 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2334 if ($options{section} && $options{section}->{condensed}) {
2336 warn "$me _items_pkg condensing section\n"
2340 local $Storable::canonical = 1;
2341 foreach ( @items ) {
2343 delete $item->{ref};
2344 delete $item->{ext_description};
2345 my $key = freeze($item);
2346 $itemshash{$key} ||= 0;
2347 $itemshash{$key} ++; # += $item->{quantity};
2349 @items = sort { $a->{description} cmp $b->{description} }
2350 map { my $i = thaw($_);
2351 $i->{quantity} = $itemshash{$_};
2353 sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
2359 warn "$me _items_pkg returning ". scalar(@items). " items\n"
2366 return 0 unless $a->itemdesc cmp $b->itemdesc;
2367 return -1 if $b->itemdesc eq 'Tax';
2368 return 1 if $a->itemdesc eq 'Tax';
2369 return -1 if $b->itemdesc eq 'Other surcharges';
2370 return 1 if $a->itemdesc eq 'Other surcharges';
2371 $a->itemdesc cmp $b->itemdesc;
2376 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum and ! $_->feepart }
2377 $self->cust_bill_pkg;
2378 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2380 if ( $self->conf->exists('always_show_tax') ) {
2381 my $itemdesc = $self->conf->config('always_show_tax') || 'Tax';
2382 if (0 == grep { $_->{description} eq $itemdesc } @items) {
2384 { 'description' => $itemdesc,
2391 =item _items_cust_bill_pkg CUST_BILL_PKGS OPTIONS
2393 Takes an arrayref of L<FS::cust_bill_pkg> objects, and returns a
2394 list of hashrefs describing the line items they generate on the invoice.
2396 OPTIONS may include:
2398 format: the invoice format.
2400 escape_function: the function used to escape strings.
2402 DEPRECATED? (expensive, mostly unused?)
2403 format_function: the function used to format CDRs.
2405 section: a hashref containing 'category' and/or 'locationnum'; if this
2406 is present, only returns line items that belong to that category and/or
2407 location (whichever is defined).
2409 multisection: a flag indicating that this is a multisection invoice,
2410 which does something complicated.
2412 Returns a list of hashrefs, each of which may contain:
2414 pkgnum, description, amount, unit_amount, quantity, pkgpart, _is_setup, and
2415 ext_description, which is an arrayref of detail lines to show below
2420 sub _items_cust_bill_pkg {
2422 my $conf = $self->conf;
2423 my $cust_bill_pkgs = shift;
2426 my $format = $opt{format} || '';
2427 my $escape_function = $opt{escape_function} || sub { shift };
2428 my $format_function = $opt{format_function} || '';
2429 my $no_usage = $opt{no_usage} || '';
2430 my $unsquelched = $opt{unsquelched} || ''; #unused
2431 my ($section, $locationnum, $category);
2432 if ( $opt{section} ) {
2433 $category = $opt{section}->{category};
2434 $locationnum = $opt{section}->{locationnum};
2436 my $summary_page = $opt{summary_page} || ''; #unused
2437 my $multisection = defined($category) || defined($locationnum);
2438 my $discount_show_always = 0;
2440 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
2442 my $cust_main = $self->cust_main;#for per-agent cust_bill-line_item-ate_style
2443 # and location labels
2446 my ($s, $r, $u) = ( undef, undef, undef );
2447 foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
2450 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ) ) {
2451 if ( $_ && !$cust_bill_pkg->hidden ) {
2452 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
2453 $_->{amount} =~ s/^\-0\.00$/0.00/;
2454 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} ),
2456 if $_->{amount} != 0
2457 || $discount_show_always
2458 || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
2459 || ( $_->{_is_setup} && $_->{setup_show_zero} )
2465 if ( $locationnum ) {
2466 # this is a location section; skip packages that aren't at this
2468 next if $cust_bill_pkg->pkgnum == 0; # skips fees...
2469 next if $self->cust_pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum
2473 # Consider display records for this item to determine if it belongs
2474 # in this section. Note that if there are no display records, there
2475 # will be a default pseudo-record that includes all charge types
2476 # and has no section name.
2477 my @cust_bill_pkg_display = $cust_bill_pkg->can('cust_bill_pkg_display')
2478 ? $cust_bill_pkg->cust_bill_pkg_display
2479 : ( $cust_bill_pkg );
2481 warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
2482 $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
2485 if ( defined($category) ) {
2486 # then this is a package category section; process all display records
2487 # that belong to this section.
2488 @cust_bill_pkg_display = grep { $_->section eq $category }
2489 @cust_bill_pkg_display;
2491 # otherwise, process all display records that aren't usage summaries
2492 # (I don't think there should be usage summaries if you aren't using
2493 # category sections, but this is the historical behavior)
2494 @cust_bill_pkg_display = grep { !$_->summary }
2495 @cust_bill_pkg_display;
2497 foreach my $display (@cust_bill_pkg_display) {
2499 warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
2500 $display->billpkgdisplaynum. "\n"
2503 my $type = $display->type;
2505 my $desc = $cust_bill_pkg->desc( $cust_main ? $cust_main->locale : '' );
2506 $desc = substr($desc, 0, $maxlength). '...'
2507 if $format eq 'latex' && length($desc) > $maxlength;
2509 my %details_opt = ( 'format' => $format,
2510 'escape_function' => $escape_function,
2511 'format_function' => $format_function,
2512 'no_usage' => $opt{'no_usage'},
2515 if ( ref($cust_bill_pkg) eq 'FS::quotation_pkg' ) {
2517 warn "$me _items_cust_bill_pkg cust_bill_pkg is quotation_pkg\n"
2519 # quotation_pkgs are never fees, so don't worry about the case where
2520 # part_pkg is undefined
2522 if ( $cust_bill_pkg->setup != 0 ) {
2523 my $description = $desc;
2524 $description .= ' Setup'
2525 if $cust_bill_pkg->recur != 0
2526 || $discount_show_always
2527 || $cust_bill_pkg->recur_show_zero;
2529 'description' => $description,
2530 'amount' => sprintf("%.2f", $cust_bill_pkg->setup),
2533 if ( $cust_bill_pkg->recur != 0 ) {
2535 'description' => "$desc (". $cust_bill_pkg->part_pkg->freq_pretty.")",
2536 'amount' => sprintf("%.2f", $cust_bill_pkg->recur),
2540 } elsif ( $cust_bill_pkg->pkgnum > 0 ) { # and it's not a quotation_pkg
2542 warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
2545 my $cust_pkg = $cust_bill_pkg->cust_pkg;
2546 my $part_pkg = $cust_pkg->part_pkg;
2548 # which pkgpart to show for display purposes?
2549 my $pkgpart = $cust_bill_pkg->pkgpart_override || $cust_pkg->pkgpart;
2551 # start/end dates for invoice formats that do nonstandard
2553 my %item_dates = ();
2554 %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate')
2555 unless $part_pkg->option('disable_line_item_date_ranges',1);
2557 if ( (!$type || $type eq 'S')
2558 && ( $cust_bill_pkg->setup != 0
2559 || $cust_bill_pkg->setup_show_zero
2564 warn "$me _items_cust_bill_pkg adding setup\n"
2567 my $description = $desc;
2568 $description .= ' Setup'
2569 if $cust_bill_pkg->recur != 0
2570 || $discount_show_always
2571 || $cust_bill_pkg->recur_show_zero;
2573 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
2575 if $part_pkg->is_prepaid #for prepaid, "display the validity period
2576 # triggered by the recurring charge freq
2578 && $cust_bill_pkg->recur == 0
2579 && ! $cust_bill_pkg->recur_show_zero;
2583 unless ( $cust_pkg->part_pkg->hide_svc_detail
2584 || $cust_bill_pkg->hidden )
2587 my @svc_labels = map &{$escape_function}($_),
2588 $cust_pkg->h_labels_short($self->_date, undef, 'I');
2589 push @d, @svc_labels
2590 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
2591 $svc_label = $svc_labels[0];
2593 my $lnum = $cust_main ? $cust_main->ship_locationnum
2594 : $self->prospect_main->locationnum;
2595 # show the location label if it's not the customer's default
2596 # location, and we're not grouping items by location already
2597 if ( $cust_pkg->locationnum != $lnum and !defined($locationnum) ) {
2598 my $loc = $cust_pkg->location_label;
2599 $loc = substr($loc, 0, $maxlength). '...'
2600 if $format eq 'latex' && length($loc) > $maxlength;
2601 push @d, &{$escape_function}($loc);
2604 } #unless hiding service details
2606 push @d, $cust_bill_pkg->details(%details_opt)
2607 if $cust_bill_pkg->recur == 0;
2609 if ( $cust_bill_pkg->hidden ) {
2610 $s->{amount} += $cust_bill_pkg->setup;
2611 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
2612 push @{ $s->{ext_description} }, @d;
2616 description => $description,
2617 pkgpart => $pkgpart,
2618 pkgnum => $cust_bill_pkg->pkgnum,
2619 amount => $cust_bill_pkg->setup,
2620 setup_show_zero => $cust_bill_pkg->setup_show_zero,
2621 unit_amount => $cust_bill_pkg->unitsetup,
2622 quantity => $cust_bill_pkg->quantity,
2623 ext_description => \@d,
2624 svc_label => ($svc_label || ''),
2630 if ( ( !$type || $type eq 'R' || $type eq 'U' )
2632 $cust_bill_pkg->recur != 0
2633 || $cust_bill_pkg->setup == 0
2634 || $discount_show_always
2635 || $cust_bill_pkg->recur_show_zero
2640 warn "$me _items_cust_bill_pkg adding recur/usage\n"
2643 my $is_summary = $display->summary;
2644 my $description = $desc;
2645 if ( $type eq 'U' and defined($r) ) {
2646 # don't just show the same description as the recur line
2647 $description = $self->mt('Usage charges');
2650 my $part_pkg = $cust_pkg->part_pkg;
2652 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
2656 my @seconds = (); # for display of usage info
2659 #at least until cust_bill_pkg has "past" ranges in addition to
2660 #the "future" sdate/edate ones... see #3032
2661 my @dates = ( $self->_date );
2662 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
2663 push @dates, $prev->sdate if $prev;
2664 push @dates, undef if !$prev;
2666 # show service labels, unless...
2667 # the package is set not to display them
2668 unless ( $part_pkg->hide_svc_detail
2669 # or this is a tax-like line item
2670 || $cust_bill_pkg->itemdesc
2671 # or this is a hidden (bundled) line item
2672 || $cust_bill_pkg->hidden
2673 # or this is a usage summary line
2674 || $is_summary && $type && $type eq 'U'
2675 # or this is a usage line and there's a recurring line
2676 # for the package in the same section (which will
2677 # have service labels already)
2678 || ($type eq 'U' and defined($r))
2682 warn "$me _items_cust_bill_pkg adding service details\n"
2685 my @svc_labels = map &{$escape_function}($_),
2686 $cust_pkg->h_labels_short(@dates, 'I');
2687 push @d, @svc_labels
2688 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
2689 $svc_label = $svc_labels[0];
2691 warn "$me _items_cust_bill_pkg done adding service details\n"
2694 my $lnum = $cust_main ? $cust_main->ship_locationnum
2695 : $self->prospect_main->locationnum;
2696 # show the location label if it's not the customer's default
2697 # location, and we're not grouping items by location already
2698 if ( $cust_pkg->locationnum != $lnum and !defined($locationnum) ) {
2699 my $loc = $cust_pkg->location_label;
2700 $loc = substr($loc, 0, $maxlength). '...'
2701 if $format eq 'latex' && length($loc) > $maxlength;
2702 push @d, &{$escape_function}($loc);
2705 # Display of seconds_since_sqlradacct:
2706 # On the invoice, when processing @detail_items, look for a field
2707 # named 'seconds'. This will contain total seconds for each
2708 # service, in the same order as @ext_description. For services
2709 # that don't support this it will show undef.
2710 if ( $conf->exists('svc_acct-usage_seconds')
2711 and ! $cust_bill_pkg->pkgpart_override ) {
2712 foreach my $cust_svc (
2713 $cust_pkg->h_cust_svc(@dates, 'I')
2716 # eval because not having any part_export_usage exports
2717 # is a fatal error, last_bill/_date because that's how
2718 # sqlradius_hour billing does it
2720 $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
2722 push @seconds, $sec;
2724 } #if svc_acct-usage_seconds
2726 } # if we are showing service labels
2728 unless ( $is_summary ) {
2729 warn "$me _items_cust_bill_pkg adding details\n"
2732 #instead of omitting details entirely in this case (unwanted side
2733 # effects), just omit CDRs
2734 $details_opt{'no_usage'} = 1
2735 if $type && $type eq 'R';
2737 push @d, $cust_bill_pkg->details(%details_opt);
2740 warn "$me _items_cust_bill_pkg calculating amount\n"
2745 $amount = $cust_bill_pkg->recur;
2746 } elsif ($type eq 'R') {
2747 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
2748 } elsif ($type eq 'U') {
2749 $amount = $cust_bill_pkg->usage;
2752 if ( !$type || $type eq 'R' ) {
2754 warn "$me _items_cust_bill_pkg adding recur\n"
2758 ( $cust_bill_pkg->unitrecur > 0 ) ? $cust_bill_pkg->unitrecur
2761 if ( $cust_bill_pkg->hidden ) {
2762 $r->{amount} += $amount;
2763 $r->{unit_amount} += $unit_amount;
2764 push @{ $r->{ext_description} }, @d;
2767 description => $description,
2768 pkgpart => $pkgpart,
2769 pkgnum => $cust_bill_pkg->pkgnum,
2771 recur_show_zero => $cust_bill_pkg->recur_show_zero,
2772 unit_amount => $unit_amount,
2773 quantity => $cust_bill_pkg->quantity,
2775 ext_description => \@d,
2776 svc_label => ($svc_label || ''),
2778 $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
2781 } else { # $type eq 'U'
2783 warn "$me _items_cust_bill_pkg adding usage\n"
2786 if ( $cust_bill_pkg->hidden and defined($u) ) {
2787 # if this is a hidden package and there's already a usage
2788 # line for the bundle, add this package's total amount and
2789 # usage details to it
2790 $u->{amount} += $amount;
2791 push @{ $u->{ext_description} }, @d;
2792 } elsif ( $amount ) {
2793 # create a new usage line
2795 description => $description,
2796 pkgpart => $pkgpart,
2797 pkgnum => $cust_bill_pkg->pkgnum,
2799 recur_show_zero => $cust_bill_pkg->recur_show_zero,
2801 ext_description => \@d,
2803 } # else this has no usage, so don't create a usage section
2806 } # recurring or usage with recurring charge
2808 } else { # taxes and fees
2810 warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
2813 # items of this kind should normally not have sdate/edate.
2815 'description' => $desc,
2816 'amount' => sprintf('%.2f', $cust_bill_pkg->setup
2817 + $cust_bill_pkg->recur)
2820 } # if quotation / package line item / other line item
2822 } # foreach $display
2824 $discount_show_always = ($cust_bill_pkg->cust_bill_pkg_discount
2825 && $conf->exists('discount-show-always'));
2829 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ) ) {
2831 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
2832 if exists($_->{amount});
2833 $_->{amount} =~ s/^\-0\.00$/0.00/;
2834 $_->{unit_amount} = sprintf('%.2f', $_->{unit_amount})
2835 if exists($_->{unit_amount});
2838 if $_->{amount} != 0
2839 || $discount_show_always
2840 || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
2841 || ( $_->{_is_setup} && $_->{setup_show_zero} )
2845 warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
2852 =item _items_discounts_avail
2854 Returns an array of line item hashrefs representing available term discounts
2855 for this invoice. This makes the same assumptions that apply to term
2856 discounts in general: that the package is billed monthly, at a flat rate,
2857 with no usage charges. A prorated first month will be handled, as will
2858 a setup fee if the discount is allowed to apply to setup fees.
2862 sub _items_discounts_avail {
2865 #maybe move this method from cust_bill when quotations support discount_plans
2866 return () unless $self->can('discount_plans');
2867 my %plans = $self->discount_plans;
2869 my $list_pkgnums = 0; # if any packages are not eligible for all discounts
2870 $list_pkgnums = grep { $_->list_pkgnums } values %plans;
2874 my $plan = $plans{$months};
2876 my $term_total = sprintf('%.2f', $plan->discounted_total);
2877 my $percent = sprintf('%.0f',
2878 100 * (1 - $term_total / $plan->base_total) );
2879 my $permonth = sprintf('%.2f', $term_total / $months);
2880 my $detail = $self->mt('discount on item'). ' '.
2881 join(', ', map { "#$_" } $plan->pkgnums)
2884 # discounts for non-integer months don't work anyway
2885 $months = sprintf("%d", $months);
2888 description => $self->mt('Save [_1]% by paying for [_2] months',
2890 amount => $self->mt('[_1] ([_2] per month)',
2891 $term_total, $money_char.$permonth),
2892 ext_description => ($detail || ''),
2895 sort { $b <=> $a } keys %plans;