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;
320 my $locale = $params{'locale'} || $cust_main->locale;
322 my %delimiters = ( 'latex' => [ '[@--', '--@]' ],
323 'html' => [ '<%=', '%>' ],
324 'template' => [ '{', '}' ],
327 warn "$me print_generic creating template\n"
330 # set the notice name here, and nowhere else.
331 my $notice_name = $params{notice_name}
332 || $conf->config('notice_name')
333 || $self->notice_name;
336 my $template = $params{template} ? $params{template} : $self->_agent_template;
337 my $templatefile = $self->template_conf. $format;
338 $templatefile .= "_$template"
339 if length($template) && $conf->exists($templatefile."_$template");
342 my @invoice_template = map "$_\n", $conf->config($templatefile)
343 or die "cannot load config data $templatefile";
345 if ( $format eq 'latex' && grep { /^%%Detail/ } @invoice_template ) {
346 #change this to a die when the old code is removed
347 # it's been almost ten years, changing it to a die
348 die "old-style invoice template $templatefile; ".
349 "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
350 #$old_latex = 'true';
351 #@invoice_template = _translate_old_latex_format(@invoice_template);
354 warn "$me print_generic creating T:T object\n"
357 my $text_template = new Text::Template(
359 SOURCE => \@invoice_template,
360 DELIMITERS => $delimiters{$format},
363 warn "$me print_generic compiling T:T object\n"
366 $text_template->compile()
367 or die "Can't compile $templatefile: $Text::Template::ERROR\n";
370 # additional substitution could possibly cause breakage in existing templates
373 'notes' => sub { map "$_", @_ },
374 'footer' => sub { map "$_", @_ },
375 'smallfooter' => sub { map "$_", @_ },
376 'returnaddress' => sub { map "$_", @_ },
377 'coupon' => sub { map "$_", @_ },
378 'summary' => sub { map "$_", @_ },
384 s/%%(.*)$/<!-- $1 -->/g;
385 s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
386 s/\\begin\{enumerate\}/<ol>/g;
388 s/\\end\{enumerate\}/<\/ol>/g;
389 s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
398 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
400 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
406 s/\\hyphenation\{[\w\s\-]+}//;
411 'coupon' => sub { "" },
412 'summary' => sub { "" },
419 s/\\section\*\{\\textsc\{(.*)\}\}/\U$1/g;
420 s/\\begin\{enumerate\}//g;
422 s/\\end\{enumerate\}//g;
423 s/\\textbf\{(.*)\}/$1/g;
430 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
432 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
437 s/\\\\\*?\s*$/\n/; # dubious
438 s/\\hyphenation\{[\w\s\-]+}//;
442 'coupon' => sub { "" },
443 'summary' => sub { "" },
448 # hashes for differing output formats
449 my %nbsps = ( 'latex' => '~',
450 'html' => '', # '&nbps;' would be nice
451 'template' => '', # not used
453 my $nbsp = $nbsps{$format};
455 my %escape_functions = ( 'latex' => \&_latex_escape,
456 'html' => \&_html_escape_nbsp,#\&encode_entities,
457 'template' => sub { shift },
459 my $escape_function = $escape_functions{$format};
460 my $escape_function_nonbsp = ($format eq 'html')
461 ? \&_html_escape : $escape_function;
463 my %newline_tokens = ( 'latex' => '\\\\',
467 my $newline_token = $newline_tokens{$format};
469 warn "$me generating template variables\n"
472 # generate template variables
476 defined( $conf->config_orbase( "invoice_${format}returnaddress",
480 && length( $conf->config_orbase( "invoice_${format}returnaddress",
486 $returnaddress = join("\n",
487 $conf->config_orbase("invoice_${format}returnaddress", $template)
491 $conf->config_orbase('invoice_latexreturnaddress', $template) ) {
493 my $convert_map = $convert_maps{$format}{'returnaddress'};
496 &$convert_map( $conf->config_orbase( "invoice_latexreturnaddress",
501 } elsif ( grep /\S/, $conf->config('company_address', $cust_main->agentnum) ) {
503 my $convert_map = $convert_maps{$format}{'returnaddress'};
504 $returnaddress = join( "\n", &$convert_map(
505 map { s/( {2,})/'~' x length($1)/eg;
509 ( $conf->config('company_name', $cust_main->agentnum),
510 $conf->config('company_address', $cust_main->agentnum),
517 my $warning = "Couldn't find a return address; ".
518 "do you need to set the company_address configuration value?";
520 $returnaddress = $nbsp;
521 #$returnaddress = $warning;
525 warn "$me generating invoice data\n"
528 my $agentnum = $cust_main->agentnum;
533 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
534 'company_address' => join("\n", $conf->config('company_address', $agentnum) ). "\n",
535 'company_phonenum'=> scalar( $conf->config('company_phonenum', $agentnum) ),
536 'returnaddress' => $returnaddress,
537 'agent' => &$escape_function($cust_main->agent->agent),
539 #invoice/quotation info
540 'no_number' => $params{'no_number'},
541 'invnum' => ( $params{'no_number'} ? '' : $self->invnum ),
542 'quotationnum' => $self->quotationnum,
543 'no_date' => $params{'no_date'},
544 '_date' => ( $params{'no_date'} ? '' : $self->_date ),
545 # workaround for inconsistent behavior in the early plain text
546 # templates; see RT#28271
547 'date' => ( $params{'no_date'}
549 : ($format eq 'template'
551 : $self->time2str_local('long', $self->_date, $format)
554 'today' => $self->time2str_local('long', $today, $format),
555 'terms' => $self->terms,
556 'template' => $template, #params{'template'},
557 'notice_name' => $notice_name, # escape?
558 'current_charges' => sprintf("%.2f", $self->charged),
559 'duedate' => $self->due_date2str('rdate'), #date_format?
562 'custnum' => $cust_main->display_custnum,
563 'prospectnum' => $cust_main->prospectnum,
564 'agent_custid' => &$escape_function($cust_main->agent_custid),
565 ( map { $_ => &$escape_function($cust_main->$_()) }
566 qw( company address1 address2 city state zip fax )
568 'payname' => &$escape_function( $cust_main->invoice_attn
569 || $cust_main->contact_firstlast ),
572 'ship_enable' => $cust_main->invoice_ship_address || $conf->exists('invoice-ship_address'),
573 'unitprices' => $conf->exists('invoice-unitprice'),
574 'smallernotes' => $conf->exists('invoice-smallernotes'),
575 'smallerfooter' => $conf->exists('invoice-smallerfooter'),
576 'balance_due_below_line' => $conf->exists('balance_due_below_line'),
578 #layout info -- would be fancy to calc some of this and bury the template
580 'topmargin' => scalar($conf->config('invoice_latextopmargin', $agentnum)),
581 'headsep' => scalar($conf->config('invoice_latexheadsep', $agentnum)),
582 'textheight' => scalar($conf->config('invoice_latextextheight', $agentnum)),
583 'extracouponspace' => scalar($conf->config('invoice_latexextracouponspace', $agentnum)),
584 'couponfootsep' => scalar($conf->config('invoice_latexcouponfootsep', $agentnum)),
585 'verticalreturnaddress' => $conf->exists('invoice_latexverticalreturnaddress', $agentnum),
586 'addresssep' => scalar($conf->config('invoice_latexaddresssep', $agentnum)),
587 'amountenclosedsep' => scalar($conf->config('invoice_latexcouponamountenclosedsep', $agentnum)),
588 'coupontoaddresssep' => scalar($conf->config('invoice_latexcoupontoaddresssep', $agentnum)),
589 'addcompanytoaddress' => $conf->exists('invoice_latexcouponaddcompanytoaddress', $agentnum),
591 # better hang on to conf_dir for a while (for old templates)
592 'conf_dir' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
594 #these are only used when doing paged plaintext
601 $invoice_data{'emt'} = sub { &$escape_function($self->mt(@_)) };
602 # prototype here to silence warnings
603 $invoice_data{'time2str'} = sub ($;$$) { $self->time2str_local(@_, $format) };
605 my $min_sdate = 999999999999;
607 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
608 next unless $cust_bill_pkg->pkgnum > 0;
609 $min_sdate = $cust_bill_pkg->sdate
610 if length($cust_bill_pkg->sdate) && $cust_bill_pkg->sdate < $min_sdate;
611 $max_edate = $cust_bill_pkg->edate
612 if length($cust_bill_pkg->edate) && $cust_bill_pkg->edate > $max_edate;
615 $invoice_data{'bill_period'} = '';
616 $invoice_data{'bill_period'} =
617 $self->time2str_local('%e %h', $min_sdate, $format)
619 $self->time2str_local('%e %h', $max_edate, $format)
620 if ($max_edate != 0 && $min_sdate != 999999999999);
622 $invoice_data{finance_section} = '';
623 if ( $conf->config('finance_pkgclass') ) {
625 qsearchs('pkg_class', { classnum => $conf->config('finance_pkgclass') });
626 $invoice_data{finance_section} = $pkg_class->categoryname;
628 $invoice_data{finance_amount} = '0.00';
629 $invoice_data{finance_section} ||= 'Finance Charges'; #avoid config confusion
631 my $countrydefault = $conf->config('countrydefault') || 'US';
632 foreach ( qw( address1 address2 city state zip country fax) ){
633 my $method = 'ship_'.$_;
634 $invoice_data{"ship_$_"} = $escape_function->($cust_main->$method);
636 if ( length($cust_main->ship_company) ) {
637 $invoice_data{'ship_company'} = $escape_function->($cust_main->ship_company);
639 $invoice_data{'ship_company'} = $escape_function->($cust_main->company);
641 $invoice_data{'ship_contact'} = $escape_function->($cust_main->contact);
642 $invoice_data{'ship_country'} = ''
643 if ( $invoice_data{'ship_country'} eq $countrydefault );
645 $invoice_data{'cid'} = $params{'cid'}
648 if ( $cust_main->country eq $countrydefault ) {
649 $invoice_data{'country'} = '';
651 $invoice_data{'country'} = &$escape_function(code2country($cust_main->country));
655 $invoice_data{'address'} = \@address;
657 $invoice_data{'payname'}.
658 ( $cust_main->po_number
659 ? " (P.O. #". $cust_main->po_number. ")"
663 push @address, $cust_main->company
664 if $cust_main->company;
665 push @address, $cust_main->address1;
666 push @address, $cust_main->address2
667 if $cust_main->address2;
669 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
670 push @address, $invoice_data{'country'}
671 if $invoice_data{'country'};
673 while (scalar(@address) < 5);
675 $invoice_data{'logo_file'} = $params{'logo_file'}
676 if $params{'logo_file'};
677 $invoice_data{'barcode_file'} = $params{'barcode_file'}
678 if $params{'barcode_file'};
679 $invoice_data{'barcode_img'} = $params{'barcode_img'}
680 if $params{'barcode_img'};
681 $invoice_data{'barcode_cid'} = $params{'barcode_cid'}
682 if $params{'barcode_cid'};
684 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
685 # my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
686 #my $balance_due = $self->owed + $pr_total - $cr_total;
687 my $balance_due = $self->owed + $pr_total;
689 # the sum of amount owed on all invoices
690 # (this is used in the summary & on the payment coupon)
691 $invoice_data{'balance'} = sprintf("%.2f", $balance_due);
693 # flag telling this invoice to have a first-page summary
694 my $summarypage = '';
696 if ( $self->custnum && $self->invnum ) {
697 # XXX should be an FS::cust_bill method to set the defaults, instead
698 # of checking the type here
700 # info from customer's last invoice before this one, for some
702 $invoice_data{'last_bill'} = {};
704 my $last_bill = $self->previous_bill;
707 # "balance_date_range" unfortunately is unsuitable for this, since it
708 # cares about application dates. We want to know the sum of all
709 # _top-level transactions_ dated before the last invoice.
711 map "$_ WHERE _date <= ? AND custnum = ?", (
712 "SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill",
713 "SELECT -1 * COALESCE( SUM(amount), 0 ) FROM cust_credit",
714 "SELECT -1 * COALESCE( SUM(paid), 0 ) FROM cust_pay",
715 "SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund",
718 # the customer's current balance immediately after generating the last
721 my $last_bill_balance = $last_bill->charged;
723 my $delta = FS::Record->scalar_sql(
725 $last_bill->_date - 1,
728 $last_bill_balance += $delta;
731 $last_bill_balance = sprintf("%.2f", $last_bill_balance);
733 warn sprintf("LAST BILL: INVNUM %d, DATE %s, BALANCE %.2f\n\n",
735 $self->time2str_local('%D', $last_bill->_date),
738 # ("true_previous_balance" is a terrible name, but at least it's no
739 # longer stored in the database)
740 $invoice_data{'true_previous_balance'} = $last_bill_balance;
742 # the change in balance from immediately after that invoice
743 # to immediately before this one
744 my $before_this_bill_balance = 0;
746 my $delta = FS::Record->scalar_sql(
751 $before_this_bill_balance += $delta;
753 $invoice_data{'balance_adjustments'} =
754 sprintf("%.2f", $last_bill_balance - $before_this_bill_balance);
756 warn sprintf("BALANCE ADJUSTMENTS: %.2f\n\n",
757 $invoice_data{'balance_adjustments'}
760 # the sum of amount owed on all previous invoices
761 # ($pr_total is used elsewhere but not as $previous_balance)
762 $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total);
764 $invoice_data{'last_bill'}{'_date'} = $last_bill->_date; #unformatted
765 my (@payments, @credits);
766 # for formats that itemize previous payments
767 foreach my $cust_pay ( qsearch('cust_pay', {
768 'custnum' => $self->custnum,
769 '_date' => { op => '>=',
770 value => $last_bill->_date }
773 next if $cust_pay->_date > $self->_date;
775 '_date' => $cust_pay->_date,
776 'date' => $self->time2str_local('long', $cust_pay->_date, $format),
777 'payinfo' => $cust_pay->payby_payinfo_pretty,
778 'amount' => sprintf('%.2f', $cust_pay->paid),
780 # not concerned about applications
782 foreach my $cust_credit ( qsearch('cust_credit', {
783 'custnum' => $self->custnum,
784 '_date' => { op => '>=',
785 value => $last_bill->_date }
788 next if $cust_credit->_date > $self->_date;
790 '_date' => $cust_credit->_date,
791 'date' => $self->time2str_local('long', $cust_credit->_date, $format),
792 'creditreason'=> $cust_credit->reason,
793 'amount' => sprintf('%.2f', $cust_credit->amount),
796 $invoice_data{'previous_payments'} = \@payments;
797 $invoice_data{'previous_credits'} = \@credits;
799 # there is no $last_bill
800 $invoice_data{'true_previous_balance'} =
801 $invoice_data{'balance_adjustments'} =
802 $invoice_data{'previous_balance'} = '0.00';
803 $invoice_data{'previous_payments'} = [];
804 $invoice_data{'previous_credits'} = [];
807 if ( $conf->exists('invoice_usesummary', $agentnum) ) {
808 $invoice_data{'summarypage'} = $summarypage = 1;
811 } # if this is an invoice
813 warn "$me substituting variables in notes, footer, smallfooter\n"
816 my $tc = $self->template_conf;
817 my @include = ( [ $tc, 'notes' ],
818 [ 'invoice_', 'footer' ],
819 [ 'invoice_', 'smallfooter', ],
821 push @include, [ $tc, 'coupon', ]
822 unless $params{'no_coupon'};
824 foreach my $i (@include) {
826 my($base, $include) = @$i;
828 my $inc_file = $conf->key_orbase("$base$format$include", $template);
831 if ( $conf->exists($inc_file, $agentnum)
832 && length( $conf->config($inc_file, $agentnum) ) ) {
834 @inc_src = $conf->config($inc_file, $agentnum);
838 $inc_file = $conf->key_orbase("${base}latex$include", $template);
840 my $convert_map = $convert_maps{$format}{$include};
842 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
843 s/--\@\]/$delimiters{$format}[1]/g;
846 &$convert_map( $conf->config($inc_file, $agentnum) );
850 my $inc_tt = new Text::Template (
852 SOURCE => [ map "$_\n", @inc_src ],
853 DELIMITERS => $delimiters{$format},
854 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
856 unless ( $inc_tt->compile() ) {
857 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
858 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
862 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
864 $invoice_data{$include} =~ s/\n+$//
865 if ($format eq 'latex');
868 # let invoices use either of these as needed
869 $invoice_data{'po_num'} = ($cust_main->payby eq 'BILL')
870 ? $cust_main->payinfo : '';
871 $invoice_data{'po_line'} =
872 ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
873 ? &$escape_function($self->mt("Purchase Order #").$cust_main->payinfo)
876 my %money_chars = ( 'latex' => '',
877 'html' => $conf->config('money_char') || '$',
880 my $money_char = $money_chars{$format};
883 my %other_money_chars = ( 'latex' => '\dollar ',#XXX should be a config too
884 'html' => $conf->config('money_char') || '$',
887 my $other_money_char = $other_money_chars{$format};
888 $invoice_data{'dollar'} = $other_money_char;
890 my %minus_signs = ( 'latex' => '$-$',
892 'template' => '- ' );
893 my $minus = $minus_signs{$format};
895 my @detail_items = ();
896 my @total_items = ();
900 $invoice_data{'detail_items'} = \@detail_items;
901 $invoice_data{'total_items'} = \@total_items;
902 $invoice_data{'buf'} = \@buf;
903 $invoice_data{'sections'} = \@sections;
905 warn "$me generating sections\n"
908 my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
909 my $multisection = $self->has_sections;
910 $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 };
1220 $tax_section->{tax_section} = 1; # mark this section as containing taxes
1221 # if this is an existing tax section, we're merging the tax items into it.
1222 # grab the taxtotal that's already there, strip the money symbol if any
1223 my $taxtotal = $tax_section->{'subtotal'} || 0;
1224 $taxtotal =~ s/^\Q$other_money_char\E//;
1227 #my $tax_weight = _pkg_category($tax_section->{description})
1228 # ? _pkg_category($tax_section->{description})->weight
1230 #$tax_section->{'summarized'} = ''; #why? $summarypage && !$tax_weight ? 'Y' : '';
1231 #$tax_section->{'sort_weight'} = $tax_weight;
1233 my @items_tax = $self->_items_tax;
1234 push @sections, $tax_section if $multisection and @items_tax > 0;
1236 foreach my $tax ( @items_tax ) {
1238 $taxtotal += $tax->{'amount'};
1240 my $description = &$escape_function( $tax->{'description'} );
1241 my $amount = sprintf( '%.2f', $tax->{'amount'} );
1243 if ( $multisection ) {
1245 push @detail_items, {
1246 ext_description => [],
1249 description => $description,
1250 amount => $money_char. $amount,
1252 section => $tax_section,
1257 push @total_items, {
1258 'total_item' => $description,
1259 'total_amount' => $other_money_char. $amount,
1264 push @buf,[ $description,
1265 $money_char. $amount,
1272 $total->{'total_item'} = $self->mt('Sub-total');
1273 $total->{'total_amount'} =
1274 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
1276 if ( $multisection ) {
1277 if ( $taxtotal > 0 ) {
1278 $tax_section->{'subtotal'} = $other_money_char.
1279 sprintf('%.2f', $taxtotal);
1280 $tax_section->{'pretotal'} = 'New charges sub-total '.
1281 $total->{'total_amount'};
1282 $tax_section->{'description'} = $self->mt($tax_description);
1284 # append it if it's not already there
1285 if ( !grep $tax_section, @sections ) {
1286 push @sections, $tax_section;
1287 push @summary_subtotals, $tax_section;
1292 unshift @total_items, $total;
1295 $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
1301 my %embolden_functions = (
1302 'latex' => sub { return '\textbf{'. shift(). '}' },
1303 'html' => sub { return '<b>'. shift(). '</b>' },
1304 'template' => sub { shift },
1306 my $embolden_function = $embolden_functions{$format};
1308 if ( $multisection ) {
1310 if ( $adjust_section->{'sort_weight'} ) {
1311 $adjust_section->{'posttotal'} = $self->mt('Balance Forward').' '.
1312 $other_money_char. sprintf("%.2f", ($self->billing_balance || 0) );
1314 $adjust_section->{'pretotal'} = $self->mt('New charges total').' '.
1315 $other_money_char. sprintf('%.2f', $self->charged );
1320 if ( $self->can('_items_total') ) { # should always be true now
1322 # even for multisection, need plain text version
1324 my @new_total_items = $self->_items_total;
1326 push @buf,['','-----------'];
1328 foreach ( @new_total_items ) {
1329 my ($item, $amount) = ($_->{'total_item'}, $_->{'total_amount'});
1330 $_->{'total_item'} = &$embolden_function( $item );
1331 $_->{'total_amount'} = &$embolden_function( $other_money_char.$amount );
1332 # but if it's multisection, don't append to @total_items. the adjust
1333 # section has all this stuff
1334 push @total_items, $_ if !$multisection;
1335 push @buf, [ $item, $money_char.sprintf('%10.2f',$amount) ];
1338 push @buf, [ '', '' ];
1340 # if we're showing previous invoices, also show previous
1341 # credits and payments
1342 if ( $self->enable_previous
1343 and $self->can('_items_credits')
1344 and $self->can('_items_payments') )
1348 my $credittotal = 0;
1349 foreach my $credit (
1350 $self->_items_credits( 'template' => $template, 'trim_len' => 40 )
1354 $total->{'total_item'} = &$escape_function($credit->{'description'});
1355 $credittotal += $credit->{'amount'};
1356 $total->{'total_amount'} = $minus.$other_money_char.$credit->{'amount'};
1357 if ( $multisection ) {
1358 push @detail_items, {
1359 ext_description => [],
1362 description => &$escape_function($credit->{'description'}),
1363 amount => $money_char . $credit->{'amount'},
1365 section => $adjust_section,
1368 push @total_items, $total;
1372 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
1375 foreach my $credit (
1376 $self->_items_credits( 'template' => $template, 'trim_len'=>32 )
1378 push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
1382 my $paymenttotal = 0;
1383 foreach my $payment (
1384 $self->_items_payments( 'template' => $template )
1387 $total->{'total_item'} = &$escape_function($payment->{'description'});
1388 $paymenttotal += $payment->{'amount'};
1389 $total->{'total_amount'} = $minus.$other_money_char.$payment->{'amount'};
1390 if ( $multisection ) {
1391 push @detail_items, {
1392 ext_description => [],
1395 description => &$escape_function($payment->{'description'}),
1396 amount => $money_char . $payment->{'amount'},
1398 section => $adjust_section,
1401 push @total_items, $total;
1403 push @buf, [ $payment->{'description'},
1404 $money_char. sprintf("%10.2f", $payment->{'amount'}),
1407 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
1409 if ( $multisection ) {
1410 $adjust_section->{'subtotal'} = $other_money_char.
1411 sprintf('%.2f', $credittotal + $paymenttotal);
1413 #why this? because {sort_weight} forces the adjust_section to appear
1414 #in @extra_sections instead of @sections. obviously.
1415 push @sections, $adjust_section
1416 unless $adjust_section->{sort_weight};
1417 # do not summarize; adjustments there are shown according to
1421 # create Balance Due message
1424 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1425 $total->{'total_amount'} =
1426 &$embolden_function(
1427 $other_money_char. sprintf('%.2f', #why? $summarypage
1428 # ? $self->charged +
1429 # $self->billing_balance
1431 $self->owed + $pr_total
1434 if ( $multisection && !$adjust_section->{sort_weight} ) {
1435 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
1436 $total->{'total_amount'};
1438 push @total_items, $total;
1440 push @buf,['','-----------'];
1441 push @buf,[$self->balance_due_msg, $money_char.
1442 sprintf("%10.2f", $balance_due ) ];
1445 if ( $conf->exists('previous_balance-show_credit')
1446 and $cust_main->balance < 0 ) {
1447 my $credit_total = {
1448 'total_item' => &$embolden_function($self->credit_balance_msg),
1449 'total_amount' => &$embolden_function(
1450 $other_money_char. sprintf('%.2f', -$cust_main->balance)
1453 if ( $multisection ) {
1454 $adjust_section->{'posttotal'} .= $newline_token .
1455 $credit_total->{'total_item'} . ' ' . $credit_total->{'total_amount'};
1458 push @total_items, $credit_total;
1460 push @buf,['','-----------'];
1461 push @buf,[$self->credit_balance_msg, $money_char.
1462 sprintf("%10.2f", -$cust_main->balance ) ];
1466 } #end of default total adding ! can('_items_total')
1468 if ( $multisection ) {
1469 if ( $conf->exists('svc_phone_sections')
1470 && $self->can('_items_svc_phone_sections')
1474 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1475 $total->{'total_amount'} =
1476 &$embolden_function(
1477 $other_money_char. sprintf('%.2f', $self->owed + $pr_total)
1479 my $last_section = pop @sections;
1480 $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
1481 $total->{'total_amount'};
1482 push @sections, $last_section;
1484 push @sections, @$late_sections
1488 # make a discounts-available section, even without multisection
1489 if ( $conf->exists('discount-show_available')
1490 and my @discounts_avail = $self->_items_discounts_avail ) {
1491 my $discount_section = {
1492 'description' => $self->mt('Discounts Available'),
1497 push @sections, $discount_section; # do not summarize
1498 push @detail_items, map { +{
1499 'ref' => '', #should this be something else?
1500 'section' => $discount_section,
1501 'description' => &$escape_function( $_->{description} ),
1502 'amount' => $money_char . &$escape_function( $_->{amount} ),
1503 'ext_description' => [ &$escape_function($_->{ext_description}) || () ],
1504 } } @discounts_avail;
1507 # not adding any more sections after this
1508 $invoice_data{summary_subtotals} = \@summary_subtotals;
1511 if ( $conf->exists('usage_class_summary')
1512 and $self->can('_items_usage_class_summary') ) {
1513 my @usage_subtotals = $self->_items_usage_class_summary(escape => $escape_function);
1514 if ( @usage_subtotals ) {
1515 unshift @sections, $usage_subtotals[0]->{section}; # do not summarize
1516 unshift @detail_items, @usage_subtotals;
1520 # invoice history "section" (not really a section)
1521 # not to be included in any subtotals, completely independent of
1523 if ( $conf->exists('previous_invoice_history') and $cust_main->isa('FS::cust_main') ) {
1526 foreach my $cust_bill ( $cust_main->cust_bill ) {
1527 # XXX hardcoded format, and currently only 'charged'; add other fields
1528 # if they become necessary
1529 my $date = $self->time2str_local('%b %Y', $cust_bill->_date);
1530 $history{$date} ||= 0;
1531 $history{$date} += $cust_bill->charged;
1532 # just so we have a numeric sort key
1533 $monthorder{$date} ||= $cust_bill->_date;
1535 my @sorted_months = sort { $monthorder{$a} <=> $monthorder{$b} }
1537 my @sorted_amounts = map { sprintf('%.2f', $history{$_}) } @sorted_months;
1538 $invoice_data{monthly_history} = [ \@sorted_months, \@sorted_amounts ];
1541 # service locations: another option for template customization
1543 foreach my $item (@detail_items) {
1544 if ( $item->{locationnum} ) {
1545 $location_info{ $item->{locationnum} } ||= {
1546 FS::cust_location->by_key( $item->{locationnum} )->location_hash
1550 $invoice_data{location_info} = \%location_info;
1552 # debugging hook: call this with 'diag' => 1 to just get a hash of
1553 # the invoice variables
1554 return \%invoice_data if ( $params{'diag'} );
1556 # All sections and items are built; now fill in templates.
1557 my @includelist = ();
1558 push @includelist, 'summary' if $summarypage;
1559 foreach my $include ( @includelist ) {
1561 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
1564 if ( length( $conf->config($inc_file, $agentnum) ) ) {
1566 @inc_src = $conf->config($inc_file, $agentnum);
1570 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
1572 my $convert_map = $convert_maps{$format}{$include};
1574 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
1575 s/--\@\]/$delimiters{$format}[1]/g;
1578 &$convert_map( $conf->config($inc_file, $agentnum) );
1582 my $inc_tt = new Text::Template (
1584 SOURCE => [ map "$_\n", @inc_src ],
1585 DELIMITERS => $delimiters{$format},
1586 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
1588 unless ( $inc_tt->compile() ) {
1589 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
1590 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
1594 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
1596 $invoice_data{$include} =~ s/\n+$//
1597 if ($format eq 'latex');
1602 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1603 /invoice_lines\((\d*)\)/;
1604 $invoice_lines += $1 || scalar(@buf);
1607 die "no invoice_lines() functions in template?"
1608 if ( $format eq 'template' && !$wasfunc );
1610 if ($format eq 'template') {
1612 if ( $invoice_lines ) {
1613 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
1614 $invoice_data{'total_pages'}++
1615 if scalar(@buf) % $invoice_lines;
1618 #setup subroutine for the template
1619 $invoice_data{invoice_lines} = sub {
1620 my $lines = shift || scalar(@buf);
1632 push @collect, split("\n",
1633 $text_template->fill_in( HASH => \%invoice_data )
1635 $invoice_data{'page'}++;
1637 map "$_\n", @collect;
1639 } else { # this is where we actually create the invoice
1641 warn "filling in template for invoice ". $self->invnum. "\n"
1643 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
1646 $text_template->fill_in(HASH => \%invoice_data);
1650 sub notice_name { '('.shift->table.')'; }
1652 # this is not supposed to happen
1653 sub template_conf { warn "bare FS::Template_Mixin::template_conf";
1657 # helper routine for generating date ranges
1658 sub _prior_month30s {
1661 [ 1, 2592000 ], # 0-30 days ago
1662 [ 2592000, 5184000 ], # 30-60 days ago
1663 [ 5184000, 7776000 ], # 60-90 days ago
1664 [ 7776000, 0 ], # 90+ days ago
1667 map { [ $_->[0] ? $self->_date - $_->[0] - 1 : '',
1668 $_->[1] ? $self->_date - $_->[1] - 1 : '',
1673 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
1675 Returns an postscript invoice, as a scalar.
1677 Options can be passed as a hashref (recommended) or as a list of time, template
1678 and then any key/value pairs for any other options.
1680 I<time> an optional value used to control the printing of overdue messages. The
1681 default is now. It isn't the date of the invoice; that's the `_date' field.
1682 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1683 L<Time::Local> and L<Date::Parse> for conversion functions.
1685 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1692 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1693 my $ps = generate_ps($file);
1695 unlink($barcodefile) if $barcodefile;
1700 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
1702 Returns an PDF invoice, as a scalar.
1704 Options can be passed as a hashref (recommended) or as a list of time, template
1705 and then any key/value pairs for any other options.
1707 I<time> an optional value used to control the printing of overdue messages. The
1708 default is now. It isn't the date of the invoice; that's the `_date' field.
1709 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1710 L<Time::Local> and L<Date::Parse> for conversion functions.
1712 I<template>, if specified, is the name of a suffix for alternate invoices.
1714 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1721 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1722 my $pdf = generate_pdf($file);
1724 unlink($barcodefile) if $barcodefile;
1729 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
1731 Returns an HTML invoice, as a scalar.
1733 I<time> an optional value used to control the printing of overdue messages. The
1734 default is now. It isn't the date of the invoice; that's the `_date' field.
1735 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1736 L<Time::Local> and L<Date::Parse> for conversion functions.
1738 I<template>, if specified, is the name of a suffix for alternate invoices.
1740 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1742 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
1743 when emailing the invoice as part of a multipart/related MIME email.
1751 %params = %{ shift() };
1755 $params{'format'} = 'html';
1757 $self->print_generic( %params );
1760 # quick subroutine for print_latex
1762 # There are ten characters that LaTeX treats as special characters, which
1763 # means that they do not simply typeset themselves:
1764 # # $ % & ~ _ ^ \ { }
1766 # TeX ignores blanks following an escaped character; if you want a blank (as
1767 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
1771 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
1772 $value =~ s/([<>])/\$$1\$/g;
1778 encode_entities($value);
1782 sub _html_escape_nbsp {
1783 my $value = _html_escape(shift);
1784 $value =~ s/ +/ /g;
1788 #utility methods for print_*
1790 sub _translate_old_latex_format {
1791 warn "_translate_old_latex_format called\n"
1798 if ( $line =~ /^%%Detail\s*$/ ) {
1800 push @template, q![@--!,
1801 q! foreach my $_tr_line (@detail_items) {!,
1802 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
1803 q! $_tr_line->{'description'} .= !,
1804 q! "\\tabularnewline\n~~".!,
1805 q! join( "\\tabularnewline\n~~",!,
1806 q! @{$_tr_line->{'ext_description'}}!,
1810 while ( ( my $line_item_line = shift )
1811 !~ /^%%EndDetail\s*$/ ) {
1812 $line_item_line =~ s/'/\\'/g; # nice LTS
1813 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1814 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1815 push @template, " \$OUT .= '$line_item_line';";
1818 push @template, '}',
1821 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1823 push @template, '[@--',
1824 ' foreach my $_tr_line (@total_items) {';
1826 while ( ( my $total_item_line = shift )
1827 !~ /^%%EndTotalDetails\s*$/ ) {
1828 $total_item_line =~ s/'/\\'/g; # nice LTS
1829 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1830 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1831 push @template, " \$OUT .= '$total_item_line';";
1834 push @template, '}',
1838 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
1839 push @template, $line;
1845 warn "$_\n" foreach @template;
1857 my $conf = $self->conf;
1859 #check for an invoice-specific override
1860 return $self->invoice_terms if $self->invoice_terms;
1862 #check for a customer- specific override
1863 my $cust_main = $self->cust_main;
1864 return $cust_main->invoice_terms if $cust_main && $cust_main->invoice_terms;
1868 $agentnum = $cust_main->agentnum;
1869 } elsif ( my $prospect_main = $self->prospect_main ) {
1870 $agentnum = $prospect_main->agentnum;
1873 #use configured default
1874 $conf->config('invoice_default_terms', $agentnum) || '';
1884 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1885 $duedate = $self->_date() + ( $1 * 86400 );
1896 $self->due_date ? $self->time2str_local(shift, $self->due_date) : '';
1899 =item balance_due_msg
1903 sub balance_due_msg {
1905 my $msg = $self->mt('Balance Due');
1906 return $msg unless $self->terms; # huh?
1907 if ( !$self->conf->exists('invoice_show_prior_due_date')
1908 or $self->conf->exists('invoice_sections') ) {
1909 # if enabled, the due date is shown with Total New Charges (see
1910 # _items_total) and not here
1911 # (yes, or if invoice_sections is enabled; this is just for compatibility)
1912 if ( $self->due_date ) {
1913 $msg .= ' - ' . $self->mt('Please pay by'). ' '.
1914 $self->due_date2str('short');
1915 } elsif ( $self->terms ) {
1916 $msg .= ' - '. $self->mt($self->terms);
1922 =item balance_due_date
1926 sub balance_due_date {
1928 my $conf = $self->conf;
1930 my $terms = $self->terms;
1931 if ( $terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1932 $duedate = $self->time2str_local('rdate', $self->_date + ($1*86400) );
1937 sub credit_balance_msg {
1939 $self->mt('Credit Balance Remaining')
1944 Returns a string with the date, for example: "3/20/2008", localized for the
1945 customer. Use _date_pretty_unlocalized for non-end-customer display use.
1951 $self->time2str_local('short', $self->_date);
1954 =item _date_pretty_unlocalized
1956 Returns a string with the date, for example: "3/20/2008", in the format
1957 configured for the back-office. Use _date_pretty for end-customer display use.
1961 sub _date_pretty_unlocalized {
1963 time2str($date_format, $self->_date);
1968 Emails this template.
1970 Options are passed as a hashref. Available options:
1976 If specified, overrides the default From: address.
1980 If specified, overrides the name of the sent document ("Invoice" or "Quotation")
1984 (Deprecated) If specified, is the name of a suffix for alternate template files.
1988 Options accepted by generate_email can also be used.
1994 my $opt = shift || {};
1995 if ($opt and !ref($opt)) {
1996 die ref($self). '->email called with positional parameters';
1999 return if $self->hide;
2001 my $error = send_email(
2002 $self->generate_email(
2003 'subject' => $self->email_subject($opt->{template}),
2004 %$opt, # template, etc.
2008 die "can't email: $error\n" if $error;
2011 =item generate_email OPTION => VALUE ...
2019 sender address, required
2023 alternate template name, optional
2027 email subject, optional
2031 notice name instead of "Invoice", optional
2035 Returns an argument list to be passed to L<FS::Misc::send_email>.
2041 sub generate_email {
2045 my $conf = $self->conf;
2047 my $me = '[FS::Template_Mixin::generate_email]';
2050 'from' => $args{'from'},
2051 'subject' => ($args{'subject'} || $self->email_subject),
2052 'custnum' => $self->custnum,
2053 'msgtype' => 'invoice',
2056 $args{'unsquelch_cdr'} = $conf->exists('voip-cdr_email');
2058 my $cust_main = $self->cust_main;
2060 if (ref($args{'to'}) eq 'ARRAY') {
2061 $return{'to'} = $args{'to'};
2062 } elsif ( $cust_main ) {
2063 $return{'to'} = [ $cust_main->invoicing_list_emailonly ];
2066 my $tc = $self->template_conf;
2068 my @text; # array of lines
2069 my $html; # a big string
2070 my @related_parts; # will contain the text/HTML alternative, and images
2071 my $related; # will contain the multipart/related object
2073 if ( $conf->exists($tc. 'email_pdf') ) {
2074 if ( my $msgnum = $conf->config($tc.'email_pdf_msgnum') ) {
2076 warn "$me using '${tc}email_pdf_msgnum' in multipart message"
2079 my $msg_template = FS::msg_template->by_key($msgnum)
2080 or die "${tc}email_pdf_msgnum $msgnum not found\n";
2081 my %prepared = $msg_template->prepare(
2082 cust_main => $self->cust_main,
2086 @text = split(/(?=\n)/, $prepared{'text_body'});
2087 $html = $prepared{'html_body'};
2089 } elsif ( my @note = $conf->config($tc.'email_pdf_note') ) {
2091 warn "$me using '${tc}email_pdf_note' in multipart message"
2093 @text = $conf->config($tc.'email_pdf_note');
2094 $html = join('<BR>', @text);
2096 } # else use the plain text invoice
2101 if ( $conf->config($tc.'template') ) {
2103 warn "$me generating plain text invoice"
2106 # 'print_text' argument is no longer used
2107 @text = $self->print_text(\%args);
2111 warn "$me no plain text version exists; sending empty message body"
2118 my $text_part = build MIME::Entity (
2119 'Type' => 'text/plain',
2120 'Encoding' => 'quoted-printable',
2121 'Charset' => 'UTF-8',
2122 #'Encoding' => '7bit',
2124 'Disposition' => 'inline',
2129 if ( $conf->exists($tc.'html') ) {
2130 warn "$me generating HTML invoice"
2133 $args{'from'} =~ /\@([\w\.\-]+)/;
2134 my $from = $1 || 'example.com';
2135 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2138 my $agentnum = $cust_main ? $cust_main->agentnum
2139 : $self->prospect_main->agentnum;
2140 if ( defined($args{'template'}) && length($args{'template'})
2141 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
2144 $logo = 'logo_'. $args{'template'}. '.png';
2148 my $image_data = $conf->config_binary( $logo, $agentnum);
2150 push @related_parts, build MIME::Entity
2151 'Type' => 'image/png',
2152 'Encoding' => 'base64',
2153 'Data' => $image_data,
2154 'Filename' => 'logo.png',
2155 'Content-ID' => "<$content_id>",
2158 if ( ref($self) eq 'FS::cust_bill' && $conf->exists('invoice-barcode') ) {
2159 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2160 push @related_parts, build MIME::Entity
2161 'Type' => 'image/png',
2162 'Encoding' => 'base64',
2163 'Data' => $self->invoice_barcode(0),
2164 'Filename' => 'barcode.png',
2165 'Content-ID' => "<$barcode_content_id>",
2167 $args{'barcode_cid'} = $barcode_content_id;
2170 $html = $self->print_html({ 'cid'=>$content_id, %args });
2177 warn "$me creating HTML/text multipart message"
2180 $return{'nobody'} = 1;
2182 my $alternative = build MIME::Entity
2183 'Type' => 'multipart/alternative',
2184 #'Encoding' => '7bit',
2185 'Disposition' => 'inline'
2189 $alternative->add_part($text_part);
2192 $alternative->attach(
2193 'Type' => 'text/html',
2194 'Encoding' => 'quoted-printable',
2195 'Data' => [ '<html>',
2198 ' '. encode_entities($return{'subject'}),
2201 ' <body bgcolor="#e8e8e8">',
2206 'Disposition' => 'inline',
2207 #'Filename' => 'invoice.pdf',
2210 unshift @related_parts, $alternative;
2212 $related = build MIME::Entity 'Type' => 'multipart/related',
2213 'Encoding' => '7bit';
2215 #false laziness w/Misc::send_email
2216 $related->head->replace('Content-type',
2217 $related->mime_type.
2218 '; boundary="'. $related->head->multipart_boundary. '"'.
2219 '; type=multipart/alternative'
2222 $related->add_part($_) foreach @related_parts;
2226 my @otherparts = ();
2227 if ( ref($self) eq 'FS::cust_bill' && $cust_main->email_csv_cdr ) {
2229 push @otherparts, build MIME::Entity
2230 'Type' => 'text/csv',
2231 'Encoding' => '7bit',
2232 'Data' => [ map { "$_\n" }
2233 $self->call_details('prepend_billed_number' => 1)
2235 'Disposition' => 'attachment',
2236 'Filename' => 'usage-'. $self->invnum. '.csv',
2241 if ( $conf->exists($tc.'email_pdf') ) {
2246 # multipart/alternative
2252 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%args);
2253 push @otherparts, $pdf;
2257 $return{'content-type'} = 'multipart/mixed'; # of the outer container
2259 $return{'mimeparts'} = [ $related, @otherparts ];
2260 $return{'type'} = 'multipart/related'; # of the first part
2262 $return{'mimeparts'} = [ $text_part, @otherparts ];
2263 $return{'type'} = 'text/plain';
2265 } elsif ( $html ) { # no PDF or CSV, strip the outer container
2266 $return{'mimeparts'} = \@related_parts;
2267 $return{'content-type'} = 'multipart/related';
2268 $return{'type'} = 'multipart/alternative';
2269 } else { # no HTML either
2270 $return{'body'} = \@text;
2271 $return{'content-type'} = 'text/plain';
2280 Returns a list suitable for passing to MIME::Entity->build(), representing
2281 this invoice as PDF attachment.
2288 'Type' => 'application/pdf',
2289 'Encoding' => 'base64',
2290 'Data' => [ $self->print_pdf(@_) ],
2291 'Disposition' => 'attachment',
2292 'Filename' => 'invoice-'. $self->invnum. '.pdf',
2296 =item _items_sections OPTIONS
2298 Generate section information for all items appearing on this invoice.
2299 This will only be called for multi-section invoices.
2301 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
2302 related display records (L<FS::cust_bill_pkg_display>) and organize
2303 them into two groups ("early" and "late" according to whether they come
2304 before or after the total), then into sections. A subtotal is calculated
2307 Section descriptions are returned in sort weight order. Each consists
2308 of a hash containing:
2310 description: the package category name, escaped
2311 subtotal: the total charges in that section
2312 tax_section: a flag indicating that the section contains only tax charges
2313 summarized: same as tax_section, for some reason
2314 sort_weight: the package category's sort weight
2316 If 'condense' is set on the display record, it also contains everything
2317 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
2318 coderefs to generate parts of the invoice. This is not advised.
2320 The method returns two arrayrefs, one of "early" sections and one of "late"
2323 OPTIONS may include:
2325 by_location: a flag to divide the invoice into sections by location.
2326 Each section hash will have a 'location' element containing a hashref of
2327 the location fields (see L<FS::cust_location>). The section description
2328 will be the location label, but the template can use any of the location
2329 fields to create a suitable label.
2331 by_category: a flag to divide the invoice into sections using display
2332 records (see L<FS::cust_bill_pkg_display>). This is the "traditional"
2333 behavior. Each section hash will have a 'category' element containing
2334 the section name from the display record (which probably equals the
2335 category name of the package, but may not in some cases).
2337 summary: a flag indicating that this is a summary-format invoice.
2338 Turning this on has the following effects:
2339 - Ignores display items with the 'summary' flag.
2340 - Places all sections in the "early" group even if they have post_total.
2341 - Creates sections for all non-disabled package categories, even if they
2342 have no charges on this invoice, as well as a section with no name.
2344 escape: an escape function to use for section titles.
2346 extra_sections: an arrayref of additional sections to return after the
2347 sorted list. If there are any of these, section subtotals exclude
2350 format: 'latex', 'html', or 'template' (i.e. text). Not used, but
2351 passed through to C<_condense_section()>.
2355 use vars qw(%pkg_category_cache);
2356 sub _items_sections {
2360 my $escape = $opt{escape};
2361 my @extra_sections = @{ $opt{extra_sections} || [] };
2363 # $subtotal{$locationnum}{$categoryname} = amount.
2364 # if we're not using by_location, $locationnum is undef.
2365 # if we're not using by_category, you guessed it, $categoryname is undef.
2366 # if we're not using either one, we shouldn't be here in the first place...
2368 my %late_subtotal = ();
2371 # About tax items + multisection invoices:
2372 # If either invoice_*summary option is enabled, AND there is a
2373 # package category with the name of the tax, then there will be
2374 # a display record assigning the tax item to that category.
2376 # However, the taxes are always placed in the "Taxes, Surcharges,
2377 # and Fees" section regardless of that. The only effect of the
2378 # display record is to create a subtotal for the summary page.
2381 my $pkg_hash = $self->cust_pkg_hash;
2383 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2386 my $usage = $cust_bill_pkg->usage;
2389 if ( $opt{by_location} ) {
2390 if ( $cust_bill_pkg->pkgnum ) {
2391 $locationnum = $pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum;
2396 $locationnum = undef;
2399 # as in _items_cust_pkg, if a line item has no display records,
2400 # cust_bill_pkg_display() returns a default record for it
2402 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
2403 next if ( $display->summary && $opt{summary} );
2405 my $section = $display->section;
2406 my $type = $display->type;
2407 # Set $section = undef if we're sectioning by location and this
2408 # line item _has_ a location (i.e. isn't a fee).
2409 $section = undef if $locationnum;
2411 # set this flag if the section is not tax-only
2412 $not_tax{$locationnum}{$section} = 1
2413 if $cust_bill_pkg->pkgnum or $cust_bill_pkg->feepart;
2415 # there's actually a very important piece of logic buried in here:
2416 # incrementing $late_subtotal{$section} CREATES
2417 # $late_subtotal{$section}. keys(%late_subtotal) is later used
2418 # to define the list of late sections, and likewise keys(%subtotal).
2419 # When _items_cust_bill_pkg is called to generate line items for
2420 # real, it will be called with 'section' => $section for each
2422 if ( $display->post_total && !$opt{summary} ) {
2423 if (! $type || $type eq 'S') {
2424 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2425 if $cust_bill_pkg->setup != 0
2426 || $cust_bill_pkg->setup_show_zero;
2430 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur
2431 if $cust_bill_pkg->recur != 0
2432 || $cust_bill_pkg->recur_show_zero;
2435 if ($type && $type eq 'R') {
2436 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2437 if $cust_bill_pkg->recur != 0
2438 || $cust_bill_pkg->recur_show_zero;
2441 if ($type && $type eq 'U') {
2442 $late_subtotal{$locationnum}{$section} += $usage
2443 unless scalar(@extra_sections);
2446 } else { # it's a pre-total (normal) section
2448 # skip tax items unless they're explicitly included in a section
2449 next if $cust_bill_pkg->pkgnum == 0 and
2450 ! $cust_bill_pkg->feepart and
2453 if ( $type eq 'S' ) {
2454 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2455 if $cust_bill_pkg->setup != 0
2456 || $cust_bill_pkg->setup_show_zero;
2457 } elsif ( $type eq 'R' ) {
2458 $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2459 if $cust_bill_pkg->recur != 0
2460 || $cust_bill_pkg->recur_show_zero;
2461 } elsif ( $type eq 'U' ) {
2462 $subtotal{$locationnum}{$section} += $usage
2463 unless scalar(@extra_sections);
2464 } elsif ( !$type ) {
2465 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2466 + $cust_bill_pkg->recur;
2475 %pkg_category_cache = ();
2477 # summary invoices need subtotals for all non-disabled package categories,
2478 # even if they're zero
2479 # but currently assume that there are no location sections, or at least
2480 # that the summary page doesn't care about them
2481 if ( $opt{summary} ) {
2482 foreach my $category (qsearch('pkg_category', {disabled => ''})) {
2483 $subtotal{''}{$category->categoryname} ||= 0;
2485 $subtotal{''}{''} ||= 0;
2489 foreach my $post_total (0,1) {
2491 my $s = $post_total ? \%late_subtotal : \%subtotal;
2492 foreach my $locationnum (keys %$s) {
2493 foreach my $sectionname (keys %{ $s->{$locationnum} }) {
2495 'subtotal' => $s->{$locationnum}{$sectionname},
2496 'post_total' => $post_total,
2499 if ( $locationnum ) {
2500 $section->{'locationnum'} = $locationnum;
2501 my $location = FS::cust_location->by_key($locationnum);
2502 $section->{'description'} = &{ $escape }($location->location_label);
2503 # Better ideas? This will roughly group them by proximity,
2504 # which alpha sorting on any of the address fields won't.
2505 # Sorting by locationnum is meaningless.
2506 # We have to sort on _something_ or the order may change
2507 # randomly from one invoice to the next, which will confuse
2509 $section->{'sort_weight'} = sprintf('%012s',$location->zip) .
2511 $section->{'location'} = {
2512 label_prefix => &{ $escape }($location->label_prefix),
2513 map { $_ => &{ $escape }($location->get($_)) }
2517 $section->{'category'} = $sectionname;
2518 $section->{'description'} = &{ $escape }($sectionname);
2519 if ( _pkg_category($sectionname) ) {
2520 $section->{'sort_weight'} = _pkg_category($sectionname)->weight;
2521 if ( _pkg_category($sectionname)->condense ) {
2522 $section = { %$section, $self->_condense_section($opt{format}) };
2526 if ( !$post_total and !$not_tax{$locationnum}{$sectionname} ) {
2527 # then it's a tax-only section
2528 $section->{'summarized'} = 'Y';
2529 $section->{'tax_section'} = 'Y';
2531 push @these, $section;
2532 } # foreach $sectionname
2533 } #foreach $locationnum
2534 push @these, @extra_sections if $post_total == 0;
2535 # need an alpha sort for location sections, because postal codes can
2537 $sections[ $post_total ] = [ sort {
2538 $opt{'by_location'} ?
2539 ($a->{sort_weight} cmp $b->{sort_weight}) :
2540 ($a->{sort_weight} <=> $b->{sort_weight})
2542 } #foreach $post_total
2544 return @sections; # early, late
2547 #helper subs for above
2551 $self->{cust_pkg} ||= { map { $_->pkgnum => $_ } $self->cust_pkg };
2555 my $categoryname = shift;
2556 $pkg_category_cache{$categoryname} ||=
2557 qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
2560 my %condensed_format = (
2561 'label' => [ qw( Description Qty Amount ) ],
2563 sub { shift->{description} },
2564 sub { shift->{quantity} },
2565 sub { my($href, %opt) = @_;
2566 ($opt{dollar} || ''). $href->{amount};
2569 'align' => [ qw( l r r ) ],
2570 'span' => [ qw( 5 1 1 ) ], # unitprices?
2571 'width' => [ qw( 10.7cm 1.4cm 1.6cm ) ], # don't like this
2574 sub _condense_section {
2575 my ( $self, $format ) = ( shift, shift );
2577 map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
2578 qw( description_generator
2581 total_line_generator
2586 sub _condensed_generator_defaults {
2587 my ( $self, $format ) = ( shift, shift );
2588 return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
2597 sub _condensed_header_generator {
2598 my ( $self, $format ) = ( shift, shift );
2600 my ( $f, $prefix, $suffix, $separator, $column ) =
2601 _condensed_generator_defaults($format);
2603 if ($format eq 'latex') {
2604 $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
2605 $suffix = "\\\\\n\\hline";
2608 sub { my ($d,$a,$s,$w) = @_;
2609 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2611 } elsif ( $format eq 'html' ) {
2612 $prefix = '<th></th>';
2616 sub { my ($d,$a,$s,$w) = @_;
2617 return qq!<th align="$html_align{$a}">$d</th>!;
2625 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2627 &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
2630 $prefix. join($separator, @result). $suffix;
2635 sub _condensed_description_generator {
2636 my ( $self, $format ) = ( shift, shift );
2638 my ( $f, $prefix, $suffix, $separator, $column ) =
2639 _condensed_generator_defaults($format);
2641 my $money_char = '$';
2642 if ($format eq 'latex') {
2643 $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
2645 $separator = " & \n";
2647 sub { my ($d,$a,$s,$w) = @_;
2648 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2650 $money_char = '\\dollar';
2651 }elsif ( $format eq 'html' ) {
2652 $prefix = '"><td align="center"></td>';
2656 sub { my ($d,$a,$s,$w) = @_;
2657 return qq!<td align="$html_align{$a}">$d</td>!;
2659 #$money_char = $conf->config('money_char') || '$';
2660 $money_char = ''; # this is madness
2668 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2670 $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
2672 &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
2673 map { $f->{$_}->[$i] } qw(align span width)
2677 $prefix. join( $separator, @result ). $suffix;
2682 sub _condensed_total_generator {
2683 my ( $self, $format ) = ( shift, shift );
2685 my ( $f, $prefix, $suffix, $separator, $column ) =
2686 _condensed_generator_defaults($format);
2689 if ($format eq 'latex') {
2692 $separator = " & \n";
2694 sub { my ($d,$a,$s,$w) = @_;
2695 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2697 }elsif ( $format eq 'html' ) {
2701 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2703 sub { my ($d,$a,$s,$w) = @_;
2704 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2713 # my $r = &{$f->{fields}->[$i]}(@args);
2714 # $r .= ' Total' unless $i;
2716 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2718 &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
2719 map { $f->{$_}->[$i] } qw(align span width)
2723 $prefix. join( $separator, @result ). $suffix;
2728 =item total_line_generator FORMAT
2730 Returns a coderef used for generation of invoice total line items for this
2731 usage_class. FORMAT is either html or latex
2735 # should not be used: will have issues with hash element names (description vs
2736 # total_item and amount vs total_amount -- another array of functions?
2738 sub _condensed_total_line_generator {
2739 my ( $self, $format ) = ( shift, shift );
2741 my ( $f, $prefix, $suffix, $separator, $column ) =
2742 _condensed_generator_defaults($format);
2745 if ($format eq 'latex') {
2748 $separator = " & \n";
2750 sub { my ($d,$a,$s,$w) = @_;
2751 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2753 }elsif ( $format eq 'html' ) {
2757 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2759 sub { my ($d,$a,$s,$w) = @_;
2760 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2769 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2771 &{$column}( &{$f->{fields}->[$i]}(@args),
2772 map { $f->{$_}->[$i] } qw(align span width)
2776 $prefix. join( $separator, @result ). $suffix;
2781 =item _items_pkg [ OPTIONS ]
2783 Return line item hashes for each package item on this invoice. Nearly
2786 $self->_items_cust_bill_pkg([ $self->cust_bill_pkg ])
2788 OPTIONS are passed through to _items_cust_bill_pkg, and should include
2789 'format' and 'escape_function' at minimum.
2791 To produce items for a specific invoice section, OPTIONS should include
2792 'section', a hashref containing 'category' and/or 'locationnum' keys.
2794 'section' may also contain a key named 'condensed'. If this is present
2795 and has a true value, _items_pkg will try to merge identical items into items
2796 with 'quantity' equal to the number of items (not the sum of their separate
2797 quantities, for some reason).
2803 # The order of these is important. Bundled line items will be merged into
2804 # the most recent non-hidden item, so it needs to be the one with:
2806 # - the same start date
2807 # - no pkgpart_override
2809 # So: sort by pkgnum,
2811 # then sort the base line item before any overrides
2812 # then sort hidden before non-hidden add-ons
2813 # then sort by override pkgpart (for consistency)
2814 sort { $a->pkgnum <=> $b->pkgnum or
2815 $a->sdate <=> $b->sdate or
2816 ($a->pkgpart_override ? 0 : -1) or
2817 ($b->pkgpart_override ? 0 : 1) or
2818 $b->hidden cmp $a->hidden or
2819 $a->pkgpart_override <=> $b->pkgpart_override
2821 # and of course exclude taxes and fees
2822 grep { $_->pkgnum > 0 } $self->cust_bill_pkg;
2828 my @cust_bill_pkg = grep { $_->feepart } $self->cust_bill_pkg;
2829 my $escape_function = $options{escape_function};
2832 foreach my $cust_bill_pkg (@cust_bill_pkg) {
2833 # cache this, so we don't look it up again in every section
2834 my $part_fee = $cust_bill_pkg->get('part_fee')
2835 || $cust_bill_pkg->part_fee;
2836 $cust_bill_pkg->set('part_fee', $part_fee);
2838 #die "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n"; # might make more sense
2839 warn "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n";
2842 if ( exists($options{section}) and exists($options{section}{category}) )
2844 my $categoryname = $options{section}{category};
2845 # then filter for items that have that section
2846 if ( $part_fee->categoryname ne $categoryname ) {
2847 warn "skipping fee '".$part_fee->itemdesc."'--not in section $categoryname\n" if $DEBUG;
2850 } # otherwise include them all in the main section
2851 # XXX what to do when sectioning by location?
2854 my %base_invnums; # invnum => invoice date
2855 foreach ($cust_bill_pkg->cust_bill_pkg_fee) {
2856 if ($_->base_invnum) {
2857 my $base_bill = FS::cust_bill->by_key($_->base_invnum);
2858 my $base_date = $self->time2str_local('short', $base_bill->_date)
2860 $base_invnums{$_->base_invnum} = $base_date || '';
2863 foreach (sort keys(%base_invnums)) {
2864 next if $_ == $self->invnum;
2865 # per convention, we must escape ext_description lines
2867 &{$escape_function}(
2868 $self->mt('from invoice #[_1] on [_2]', $_, $base_invnums{$_})
2871 my $desc = $part_fee->itemdesc_locale($self->cust_main->locale);
2872 # but not escape the base description line
2875 { feepart => $cust_bill_pkg->feepart,
2876 amount => sprintf('%.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
2877 description => $desc,
2878 ext_description => \@ext_desc
2889 warn "$me _items_pkg searching for all package line items\n"
2892 my @cust_bill_pkg = $self->_items_nontax;
2894 warn "$me _items_pkg filtering line items\n"
2896 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2898 if ($options{section} && $options{section}->{condensed}) {
2900 warn "$me _items_pkg condensing section\n"
2904 local $Storable::canonical = 1;
2905 foreach ( @items ) {
2907 delete $item->{ref};
2908 delete $item->{ext_description};
2909 my $key = freeze($item);
2910 $itemshash{$key} ||= 0;
2911 $itemshash{$key} ++; # += $item->{quantity};
2913 @items = sort { $a->{description} cmp $b->{description} }
2914 map { my $i = thaw($_);
2915 $i->{quantity} = $itemshash{$_};
2917 sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
2923 warn "$me _items_pkg returning ". scalar(@items). " items\n"
2930 return 0 unless $a->itemdesc cmp $b->itemdesc;
2931 return -1 if $b->itemdesc eq 'Tax';
2932 return 1 if $a->itemdesc eq 'Tax';
2933 return -1 if $b->itemdesc eq 'Other surcharges';
2934 return 1 if $a->itemdesc eq 'Other surcharges';
2935 $a->itemdesc cmp $b->itemdesc;
2940 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum and ! $_->feepart }
2941 $self->cust_bill_pkg;
2942 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2944 if ( $self->conf->exists('always_show_tax') ) {
2945 my $itemdesc = $self->conf->config('always_show_tax') || 'Tax';
2946 if (0 == grep { $_->{description} eq $itemdesc } @items) {
2948 { 'description' => $itemdesc,
2955 =item _items_cust_bill_pkg CUST_BILL_PKGS OPTIONS
2957 Takes an arrayref of L<FS::cust_bill_pkg> objects, and returns a
2958 list of hashrefs describing the line items they generate on the invoice.
2960 OPTIONS may include:
2962 format: the invoice format.
2964 escape_function: the function used to escape strings.
2966 DEPRECATED? (expensive, mostly unused?)
2967 format_function: the function used to format CDRs.
2969 section: a hashref containing 'category' and/or 'locationnum'; if this
2970 is present, only returns line items that belong to that category and/or
2971 location (whichever is defined).
2973 multisection: a flag indicating that this is a multisection invoice,
2974 which does something complicated.
2976 preref_callback: coderef run for each line item, code should return HTML to be
2977 displayed before that line item (quotations only)
2979 Returns a list of hashrefs, each of which may contain:
2981 pkgnum, description, amount, unit_amount, quantity, pkgpart, _is_setup, and
2982 ext_description, which is an arrayref of detail lines to show below
2987 sub _items_cust_bill_pkg {
2989 my $conf = $self->conf;
2990 my $cust_bill_pkgs = shift;
2993 my $format = $opt{format} || '';
2994 my $escape_function = $opt{escape_function} || sub { shift };
2995 my $format_function = $opt{format_function} || '';
2996 my $no_usage = $opt{no_usage} || '';
2997 my $unsquelched = $opt{unsquelched} || ''; #unused
2998 my ($section, $locationnum, $category);
2999 if ( $opt{section} ) {
3000 $category = $opt{section}->{category};
3001 $locationnum = $opt{section}->{locationnum};
3003 my $summary_page = $opt{summary_page} || ''; #unused
3004 my $multisection = defined($category) || defined($locationnum);
3005 my $discount_show_always = 0;
3007 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 40;
3009 my $cust_main = $self->cust_main;#for per-agent cust_bill-line_item-ate_style
3011 # for location labels: use default location on the invoice date
3012 my $default_locationnum;
3013 if ( $self->custnum ) {
3015 my @h_search = FS::h_cust_main->sql_h_search($self->_date);
3016 $h_cust_main = qsearchs({
3017 'table' => 'h_cust_main',
3018 'hashref' => { custnum => $self->custnum },
3019 'extra_sql' => $h_search[1],
3020 'addl_from' => $h_search[3],
3022 $default_locationnum = $h_cust_main->ship_locationnum;
3023 } elsif ( $self->prospectnum ) {
3024 my $cust_location = qsearchs('cust_location',
3025 { prospectnum => $self->prospectnum,
3027 $default_locationnum = $cust_location->locationnum if $cust_location;
3030 my @b = (); # accumulator for the line item hashes that we'll return
3031 my ($s, $r, $u, $d) = ( undef, undef, undef, undef );
3032 # the 'current' line item hashes for setup, recur, usage, discount
3033 foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
3035 # if the current line item is waiting to go out, and the one we're about
3036 # to start is not bundled, then push out the current one and start a new
3038 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3039 if ( $_ && !$cust_bill_pkg->hidden ) {
3040 $_->{amount} = sprintf( "%.2f", $_->{amount} );
3041 $_->{amount} =~ s/^\-0\.00$/0.00/;
3042 if (exists($_->{unit_amount})) {
3043 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3046 if $_->{amount} != 0
3047 || $discount_show_always
3048 || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3049 || ( $_->{_is_setup} && $_->{setup_show_zero} )
3055 if ( $locationnum ) {
3056 # this is a location section; skip packages that aren't at this
3058 next if $cust_bill_pkg->pkgnum == 0; # skips fees...
3059 next if $self->cust_pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum
3063 # Consider display records for this item to determine if it belongs
3064 # in this section. Note that if there are no display records, there
3065 # will be a default pseudo-record that includes all charge types
3066 # and has no section name.
3067 my @cust_bill_pkg_display = $cust_bill_pkg->can('cust_bill_pkg_display')
3068 ? $cust_bill_pkg->cust_bill_pkg_display
3069 : ( $cust_bill_pkg );
3071 warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
3072 $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
3075 if ( defined($category) ) {
3076 # then this is a package category section; process all display records
3077 # that belong to this section.
3078 @cust_bill_pkg_display = grep { $_->section eq $category }
3079 @cust_bill_pkg_display;
3081 # otherwise, process all display records that aren't usage summaries
3082 # (I don't think there should be usage summaries if you aren't using
3083 # category sections, but this is the historical behavior)
3084 @cust_bill_pkg_display = grep { !$_->summary }
3085 @cust_bill_pkg_display;
3088 my $classname = ''; # package class name, will fill in later
3090 foreach my $display (@cust_bill_pkg_display) {
3092 warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
3093 $display->billpkgdisplaynum. "\n"
3096 my $type = $display->type;
3098 my $desc = $cust_bill_pkg->desc( $cust_main ? $cust_main->locale : '' );
3099 $desc = substr($desc, 0, $maxlength). '...'
3100 if $format eq 'latex' && length($desc) > $maxlength;
3102 my %details_opt = ( 'format' => $format,
3103 'escape_function' => $escape_function,
3104 'format_function' => $format_function,
3105 'no_usage' => $opt{'no_usage'},
3108 if ( ref($cust_bill_pkg) eq 'FS::quotation_pkg' ) {
3109 # XXX this should be pulled out into quotation_pkg
3111 warn "$me _items_cust_bill_pkg cust_bill_pkg is quotation_pkg\n"
3113 # quotation_pkgs are never fees, so don't worry about the case where
3114 # part_pkg is undefined
3116 # and I guess they're never bundled either?
3117 if ( $cust_bill_pkg->setup != 0 ) {
3118 my $description = $desc;
3119 $description .= ' Setup'
3120 if $cust_bill_pkg->recur != 0
3121 || $discount_show_always
3122 || $cust_bill_pkg->recur_show_zero;
3124 # keep it consistent, please
3126 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref
3127 'description' => $description,
3128 'amount' => sprintf("%.2f", $cust_bill_pkg->setup),
3129 'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitsetup),
3130 'quantity' => $cust_bill_pkg->quantity,
3131 'preref_html' => ( $opt{preref_callback}
3132 ? &{ $opt{preref_callback} }( $cust_bill_pkg )
3137 if ( $cust_bill_pkg->recur != 0 ) {
3140 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref
3141 'description' => "$desc (". $cust_bill_pkg->part_pkg->freq_pretty.")",
3142 'amount' => sprintf("%.2f", $cust_bill_pkg->recur),
3143 'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitrecur),
3144 'quantity' => $cust_bill_pkg->quantity,
3145 'preref_html' => ( $opt{preref_callback}
3146 ? &{ $opt{preref_callback} }( $cust_bill_pkg )
3152 } elsif ( $cust_bill_pkg->pkgnum > 0 ) {
3153 # a "normal" package line item (not a quotation, not a fee, not a tax)
3155 warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
3158 my $cust_pkg = $cust_bill_pkg->cust_pkg;
3159 my $part_pkg = $cust_pkg->part_pkg;
3161 # which pkgpart to show for display purposes?
3162 my $pkgpart = $cust_bill_pkg->pkgpart_override || $cust_pkg->pkgpart;
3164 # start/end dates for invoice formats that do nonstandard
3166 my %item_dates = ();
3167 %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate')
3168 unless $part_pkg->option('disable_line_item_date_ranges',1);
3170 # not normally used, but pass this to the template anyway
3171 $classname = $part_pkg->classname;
3173 if ( (!$type || $type eq 'S')
3174 && ( $cust_bill_pkg->setup != 0
3175 || $cust_bill_pkg->setup_show_zero
3180 warn "$me _items_cust_bill_pkg adding setup\n"
3183 my $description = $desc;
3184 $description .= ' Setup'
3185 if $cust_bill_pkg->recur != 0
3186 || $discount_show_always
3187 || $cust_bill_pkg->recur_show_zero;
3189 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3191 if $part_pkg->is_prepaid #for prepaid, "display the validity period
3192 # triggered by the recurring charge freq
3194 && $cust_bill_pkg->recur == 0
3195 && ! $cust_bill_pkg->recur_show_zero;
3200 # always pass the svc_label through to the template, even if
3201 # not displaying it as an ext_description
3202 my @svc_labels = map &{$escape_function}($_),
3203 $cust_pkg->h_labels_short($self->_date, undef, 'I');
3205 $svc_label = $svc_labels[0];
3207 unless ( $cust_pkg->part_pkg->hide_svc_detail
3208 || $cust_bill_pkg->hidden )
3211 push @d, @svc_labels
3212 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3213 # show the location label if it's not the customer's default
3214 # location, and we're not grouping items by location already
3215 if ( $cust_pkg->locationnum != $default_locationnum
3216 and !defined($locationnum) ) {
3217 my $loc = $cust_pkg->location_label;
3218 $loc = substr($loc, 0, $maxlength). '...'
3219 if $format eq 'latex' && length($loc) > $maxlength;
3220 push @d, &{$escape_function}($loc);
3223 } #unless hiding service details
3225 push @d, $cust_bill_pkg->details(%details_opt)
3226 if $cust_bill_pkg->recur == 0;
3228 if ( $cust_bill_pkg->hidden ) {
3229 $s->{amount} += $cust_bill_pkg->setup;
3230 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
3231 push @{ $s->{ext_description} }, @d;
3235 description => $description,
3236 pkgpart => $pkgpart,
3237 pkgnum => $cust_bill_pkg->pkgnum,
3238 amount => $cust_bill_pkg->setup,
3239 setup_show_zero => $cust_bill_pkg->setup_show_zero,
3240 unit_amount => $cust_bill_pkg->unitsetup,
3241 quantity => $cust_bill_pkg->quantity,
3242 ext_description => \@d,
3243 svc_label => ($svc_label || ''),
3244 locationnum => $cust_pkg->locationnum, # sure, why not?
3250 if ( ( !$type || $type eq 'R' || $type eq 'U' )
3252 $cust_bill_pkg->recur != 0
3253 || $cust_bill_pkg->setup == 0
3254 || $discount_show_always
3255 || $cust_bill_pkg->recur_show_zero
3260 warn "$me _items_cust_bill_pkg adding recur/usage\n"
3263 my $is_summary = $display->summary;
3264 my $description = $desc;
3265 if ( $type eq 'U' and defined($r) ) {
3266 # don't just show the same description as the recur line
3267 $description = $self->mt('Usage charges');
3270 my $part_pkg = $cust_pkg->part_pkg;
3272 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3276 my @seconds = (); # for display of usage info
3279 #at least until cust_bill_pkg has "past" ranges in addition to
3280 #the "future" sdate/edate ones... see #3032
3281 my @dates = ( $self->_date );
3282 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
3283 push @dates, $prev->sdate if $prev;
3284 push @dates, undef if !$prev;
3286 my @svc_labels = map &{$escape_function}($_),
3287 $cust_pkg->h_labels_short(@dates, 'I');
3288 $svc_label = $svc_labels[0];
3290 # show service labels, unless...
3291 # the package is set not to display them
3292 unless ( $part_pkg->hide_svc_detail
3293 # or this is a tax-like line item
3294 || $cust_bill_pkg->itemdesc
3295 # or this is a hidden (bundled) line item
3296 || $cust_bill_pkg->hidden
3297 # or this is a usage summary line
3298 || $is_summary && $type && $type eq 'U'
3299 # or this is a usage line and there's a recurring line
3300 # for the package in the same section (which will
3301 # have service labels already)
3302 || ($type eq 'U' and defined($r))
3306 warn "$me _items_cust_bill_pkg adding service details\n"
3309 push @d, @svc_labels
3310 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3311 warn "$me _items_cust_bill_pkg done adding service details\n"
3314 # show the location label if it's not the customer's default
3315 # location, and we're not grouping items by location already
3316 if ( $cust_pkg->locationnum != $default_locationnum
3317 and !defined($locationnum) ) {
3318 my $loc = $cust_pkg->location_label;
3319 $loc = substr($loc, 0, $maxlength). '...'
3320 if $format eq 'latex' && length($loc) > $maxlength;
3321 push @d, &{$escape_function}($loc);
3324 # Display of seconds_since_sqlradacct:
3325 # On the invoice, when processing @detail_items, look for a field
3326 # named 'seconds'. This will contain total seconds for each
3327 # service, in the same order as @ext_description. For services
3328 # that don't support this it will show undef.
3329 if ( $conf->exists('svc_acct-usage_seconds')
3330 and ! $cust_bill_pkg->pkgpart_override ) {
3331 foreach my $cust_svc (
3332 $cust_pkg->h_cust_svc(@dates, 'I')
3335 # eval because not having any part_export_usage exports
3336 # is a fatal error, last_bill/_date because that's how
3337 # sqlradius_hour billing does it
3339 $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
3341 push @seconds, $sec;
3343 } #if svc_acct-usage_seconds
3345 } # if we are showing service labels
3347 unless ( $is_summary ) {
3348 warn "$me _items_cust_bill_pkg adding details\n"
3351 #instead of omitting details entirely in this case (unwanted side
3352 # effects), just omit CDRs
3353 $details_opt{'no_usage'} = 1
3354 if $type && $type eq 'R';
3356 push @d, $cust_bill_pkg->details(%details_opt);
3359 warn "$me _items_cust_bill_pkg calculating amount\n"
3364 $amount = $cust_bill_pkg->recur;
3365 } elsif ($type eq 'R') {
3366 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
3367 } elsif ($type eq 'U') {
3368 $amount = $cust_bill_pkg->usage;
3371 if ( !$type || $type eq 'R' ) {
3373 warn "$me _items_cust_bill_pkg adding recur\n"
3377 ( $cust_bill_pkg->unitrecur > 0 ) ? $cust_bill_pkg->unitrecur
3380 if ( $cust_bill_pkg->hidden ) {
3381 $r->{amount} += $amount;
3382 $r->{unit_amount} += $unit_amount;
3383 push @{ $r->{ext_description} }, @d;
3386 description => $description,
3387 pkgpart => $pkgpart,
3388 pkgnum => $cust_bill_pkg->pkgnum,
3390 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3391 unit_amount => $unit_amount,
3392 quantity => $cust_bill_pkg->quantity,
3394 ext_description => \@d,
3395 svc_label => ($svc_label || ''),
3396 locationnum => $cust_pkg->locationnum,
3398 $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
3401 } else { # $type eq 'U'
3403 warn "$me _items_cust_bill_pkg adding usage\n"
3406 if ( $cust_bill_pkg->hidden and defined($u) ) {
3407 # if this is a hidden package and there's already a usage
3408 # line for the bundle, add this package's total amount and
3409 # usage details to it
3410 $u->{amount} += $amount;
3411 push @{ $u->{ext_description} }, @d;
3412 } elsif ( $amount ) {
3413 # create a new usage line
3415 description => $description,
3416 pkgpart => $pkgpart,
3417 pkgnum => $cust_bill_pkg->pkgnum,
3420 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3422 ext_description => \@d,
3423 locationnum => $cust_pkg->locationnum,
3425 } # else this has no usage, so don't create a usage section
3428 } # recurring or usage with recurring charge
3430 } else { # taxes and fees
3432 warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
3435 # items of this kind should normally not have sdate/edate.
3437 'description' => $desc,
3438 'amount' => sprintf('%.2f', $cust_bill_pkg->setup
3439 + $cust_bill_pkg->recur)
3442 } # if quotation / package line item / other line item
3444 # decide whether to show active discounts here
3446 # case 1: we are showing a single line for the package
3448 # case 2: we are showing a setup line for a package that has
3449 # no base recurring fee
3450 or ( $type eq 'S' and $cust_bill_pkg->unitrecur == 0 )
3451 # case 3: we are showing a recur line for a package that has
3452 # a base recurring fee
3453 or ( $type eq 'R' and $cust_bill_pkg->unitrecur > 0 )
3456 my $item_discount = $cust_bill_pkg->_item_discount;
3457 if ( $item_discount ) {
3458 # $item_discount->{amount} is negative
3460 if ( $d and $cust_bill_pkg->hidden ) {
3461 $d->{amount} += $item_discount->{amount};
3463 $d = $item_discount;
3464 $_ = &{$escape_function}($_) foreach @{ $d->{ext_description} };
3467 # update the active line (before the discount) to show the
3468 # original price (whether this is a hidden line or not)
3470 # quotation discounts keep track of setup and recur; invoice
3471 # discounts currently don't
3472 if ( exists $item_discount->{setup_amount} ) {
3474 $s->{amount} -= $item_discount->{setup_amount} if $s;
3475 $r->{amount} -= $item_discount->{recur_amount} if $r;
3479 # $active_line is the line item hashref for the line that will
3480 # show the original price
3481 # (use the recur or single line for the package, unless we're
3482 # showing a setup line for a package with no recurring fee)
3483 my $active_line = $r;
3484 if ( $type eq 'S' ) {
3487 $active_line->{amount} -= $item_discount->{amount};
3491 } # if there are any discounts
3492 } # if this is an appropriate place to show discounts
3494 } # foreach $display
3496 $discount_show_always = ($cust_bill_pkg->cust_bill_pkg_discount
3497 && $conf->exists('discount-show-always'));
3501 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3503 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
3504 if exists($_->{amount});
3505 $_->{amount} =~ s/^\-0\.00$/0.00/;
3506 if (exists($_->{unit_amount})) {
3507 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3511 if $_->{amount} != 0
3512 || $discount_show_always
3513 || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3514 || ( $_->{_is_setup} && $_->{setup_show_zero} )
3518 warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
3525 =item _items_discounts_avail
3527 Returns an array of line item hashrefs representing available term discounts
3528 for this invoice. This makes the same assumptions that apply to term
3529 discounts in general: that the package is billed monthly, at a flat rate,
3530 with no usage charges. A prorated first month will be handled, as will
3531 a setup fee if the discount is allowed to apply to setup fees.
3535 sub _items_discounts_avail {
3538 #maybe move this method from cust_bill when quotations support discount_plans
3539 return () unless $self->can('discount_plans');
3540 my %plans = $self->discount_plans;
3542 my $list_pkgnums = 0; # if any packages are not eligible for all discounts
3543 $list_pkgnums = grep { $_->list_pkgnums } values %plans;
3547 my $plan = $plans{$months};
3549 my $term_total = sprintf('%.2f', $plan->discounted_total);
3550 my $percent = sprintf('%.0f',
3551 100 * (1 - $term_total / $plan->base_total) );
3552 my $permonth = sprintf('%.2f', $term_total / $months);
3553 my $detail = $self->mt('discount on item'). ' '.
3554 join(', ', map { "#$_" } $plan->pkgnums)
3557 # discounts for non-integer months don't work anyway
3558 $months = sprintf("%d", $months);
3561 description => $self->mt('Save [_1]% by paying for [_2] months',
3563 amount => $self->mt('[_1] ([_2] per month)',
3564 $term_total, $money_char.$permonth),
3565 ext_description => ($detail || ''),
3568 sort { $b <=> $a } keys %plans;