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;
688 if ( $self->enable_previous ) {
689 $balance_due += $pr_total;
691 # otherwise the previous balance is not shown, so including it in the
692 # balance due is just confusing
694 # the sum of amount owed on all invoices
695 # (this is used in the summary & on the payment coupon)
696 $invoice_data{'balance'} = sprintf("%.2f", $balance_due);
698 # flag telling this invoice to have a first-page summary
699 my $summarypage = '';
701 if ( $self->custnum && $self->invnum ) {
702 # XXX should be an FS::cust_bill method to set the defaults, instead
703 # of checking the type here
705 # info from customer's last invoice before this one, for some
707 $invoice_data{'last_bill'} = {};
709 my $last_bill = $self->previous_bill;
712 # "balance_date_range" unfortunately is unsuitable for this, since it
713 # cares about application dates. We want to know the sum of all
714 # _top-level transactions_ dated before the last invoice.
716 map "$_ WHERE _date <= ? AND custnum = ?", (
717 "SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill",
718 "SELECT -1 * COALESCE( SUM(amount), 0 ) FROM cust_credit",
719 "SELECT -1 * COALESCE( SUM(paid), 0 ) FROM cust_pay",
720 "SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund",
723 # the customer's current balance immediately after generating the last
726 my $last_bill_balance = $last_bill->charged;
728 my $delta = FS::Record->scalar_sql(
730 $last_bill->_date - 1,
733 $last_bill_balance += $delta;
736 $last_bill_balance = sprintf("%.2f", $last_bill_balance);
738 warn sprintf("LAST BILL: INVNUM %d, DATE %s, BALANCE %.2f\n\n",
740 $self->time2str_local('%D', $last_bill->_date),
743 # ("true_previous_balance" is a terrible name, but at least it's no
744 # longer stored in the database)
745 $invoice_data{'true_previous_balance'} = $last_bill_balance;
747 # the change in balance from immediately after that invoice
748 # to immediately before this one
749 my $before_this_bill_balance = 0;
751 my $delta = FS::Record->scalar_sql(
756 $before_this_bill_balance += $delta;
758 $invoice_data{'balance_adjustments'} =
759 sprintf("%.2f", $last_bill_balance - $before_this_bill_balance);
761 warn sprintf("BALANCE ADJUSTMENTS: %.2f\n\n",
762 $invoice_data{'balance_adjustments'}
765 # the sum of amount owed on all previous invoices
766 # ($pr_total is used elsewhere but not as $previous_balance)
767 $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total);
769 $invoice_data{'last_bill'}{'_date'} = $last_bill->_date; #unformatted
770 my (@payments, @credits);
771 # for formats that itemize previous payments
772 foreach my $cust_pay ( qsearch('cust_pay', {
773 'custnum' => $self->custnum,
774 '_date' => { op => '>=',
775 value => $last_bill->_date }
778 next if $cust_pay->_date > $self->_date;
780 '_date' => $cust_pay->_date,
781 'date' => $self->time2str_local('long', $cust_pay->_date, $format),
782 'payinfo' => $cust_pay->payby_payinfo_pretty,
783 'amount' => sprintf('%.2f', $cust_pay->paid),
785 # not concerned about applications
787 foreach my $cust_credit ( qsearch('cust_credit', {
788 'custnum' => $self->custnum,
789 '_date' => { op => '>=',
790 value => $last_bill->_date }
793 next if $cust_credit->_date > $self->_date;
795 '_date' => $cust_credit->_date,
796 'date' => $self->time2str_local('long', $cust_credit->_date, $format),
797 'creditreason'=> $cust_credit->reason,
798 'amount' => sprintf('%.2f', $cust_credit->amount),
801 $invoice_data{'previous_payments'} = \@payments;
802 $invoice_data{'previous_credits'} = \@credits;
804 # there is no $last_bill
805 $invoice_data{'true_previous_balance'} =
806 $invoice_data{'balance_adjustments'} =
807 $invoice_data{'previous_balance'} = '0.00';
808 $invoice_data{'previous_payments'} = [];
809 $invoice_data{'previous_credits'} = [];
812 if ( $conf->exists('invoice_usesummary', $agentnum) ) {
813 $invoice_data{'summarypage'} = $summarypage = 1;
816 } # if this is an invoice
818 warn "$me substituting variables in notes, footer, smallfooter\n"
821 my $tc = $self->template_conf;
822 my @include = ( [ $tc, 'notes' ],
823 [ 'invoice_', 'footer' ],
824 [ 'invoice_', 'smallfooter', ],
825 [ 'invoice_', 'watermark' ],
827 push @include, [ $tc, 'coupon', ]
828 unless $params{'no_coupon'};
830 foreach my $i (@include) {
832 # load the configuration for this sub-template
834 my($base, $include) = @$i;
836 my $inc_file = $conf->key_orbase("$base$format$include", $template);
838 my @inc_src = $conf->config($inc_file, $agentnum);
840 my $converter = $convert_maps{$format}{$include};
842 # then attempt to convert LaTeX to the requested format
843 $inc_file = $conf->key_orbase($base.'latex'.$include, $template);
844 @inc_src = &$converter( $conf->config($inc_file, $agentnum) );
846 # this isn't included in the convert_maps
847 my ($open, $close) = @{ $delimiters{$format} };
852 } # else @inc_src is empty and that's fine
854 # make a Text::Template out of it
856 my $inc_tt = new Text::Template (
858 SOURCE => [ map "$_\n", @inc_src ],
859 DELIMITERS => $delimiters{$format},
860 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
862 unless ( $inc_tt->compile() ) {
863 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
864 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
870 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
872 $invoice_data{$include} =~ s/\n+$//
873 if ($format eq 'latex');
876 # let invoices use either of these as needed
877 $invoice_data{'po_num'} = ($cust_main->payby eq 'BILL')
878 ? $cust_main->payinfo : '';
879 $invoice_data{'po_line'} =
880 ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
881 ? &$escape_function($self->mt("Purchase Order #").$cust_main->payinfo)
884 my %money_chars = ( 'latex' => '',
885 'html' => $conf->config('money_char') || '$',
888 my $money_char = $money_chars{$format};
891 my %other_money_chars = ( 'latex' => '\dollar ',#XXX should be a config too
892 'html' => $conf->config('money_char') || '$',
895 my $other_money_char = $other_money_chars{$format};
896 $invoice_data{'dollar'} = $other_money_char;
898 my %minus_signs = ( 'latex' => '$-$',
900 'template' => '- ' );
901 my $minus = $minus_signs{$format};
903 my @detail_items = ();
904 my @total_items = ();
908 $invoice_data{'detail_items'} = \@detail_items;
909 $invoice_data{'total_items'} = \@total_items;
910 $invoice_data{'buf'} = \@buf;
911 $invoice_data{'sections'} = \@sections;
913 warn "$me generating sections\n"
916 my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
917 my $multisection = $self->has_sections;
918 $conf->exists($tc.'sections', $cust_main->agentnum) ||
919 $conf->exists($tc.'sections_by_location', $cust_main->agentnum);
920 $invoice_data{'multisection'} = $multisection;
922 my $extra_sections = [];
923 my $extra_lines = ();
925 # default section ('Charges')
926 my $default_section = { 'description' => '',
931 # Previous Charges section
932 # subtotal is the first return value from $self->previous
933 my $previous_section;
934 # if the invoice has major sections, or if we're summarizing previous
935 # charges with a single line, or if we've been specifically told to put them
936 # in a section, create a section for previous charges:
937 if ( $multisection or
938 $conf->exists('previous_balance-summary_only') or
939 $conf->exists('previous_balance-section') ) {
941 $previous_section = { 'description' => $self->mt('Previous Charges'),
942 'subtotal' => $other_money_char.
943 sprintf('%.2f', $pr_total),
944 'summarized' => '', #why? $summarypage ? 'Y' : '',
946 $previous_section->{posttotal} = '0 / 30 / 60 / 90 days overdue '.
947 join(' / ', map { $cust_main->balance_date_range(@$_) }
948 $self->_prior_month30s
950 if $conf->exists('invoice_include_aging');
953 # otherwise put them in the main section
954 $previous_section = $default_section;
957 my $adjust_section = {
958 'description' => $self->mt('Credits, Payments, and Adjustments'),
959 'adjust_section' => 1,
960 'subtotal' => 0, # adjusted below
962 my $adjust_weight = _pkg_category($adjust_section->{description})
963 ? _pkg_category($adjust_section->{description})->weight
965 $adjust_section->{'summarized'} = ''; #why? $summarypage && !$adjust_weight ? 'Y' : '';
966 # Note: 'sort_weight' here is actually a flag telling whether there is an
967 # explicit package category for the adjust section. If so, certain behavior
969 $adjust_section->{'sort_weight'} = $adjust_weight;
972 if ( $multisection ) {
973 ($extra_sections, $extra_lines) =
974 $self->_items_extra_usage_sections($escape_function_nonbsp, $format)
975 if $conf->exists('usage_class_as_a_section', $cust_main->agentnum)
976 && $self->can('_items_extra_usage_sections');
978 push @$extra_sections, $adjust_section if $adjust_section->{sort_weight};
980 push @detail_items, @$extra_lines if $extra_lines;
982 # the code is written so that both methods can be used together, but
983 # we haven't yet changed the template to take advantage of that, so for
984 # now, treat them as mutually exclusive.
985 my %section_method = ( by_category => 1 );
986 if ( $conf->config($tc.'sections_method') eq 'location' ) {
987 %section_method = ( by_location => 1 );
990 $self->_items_sections( 'summary' => $summarypage,
991 'escape' => $escape_function_nonbsp,
992 'extra_sections' => $extra_sections,
996 push @sections, @$early;
997 $late_sections = $late;
999 if ( $conf->exists('svc_phone_sections')
1000 && $self->can('_items_svc_phone_sections')
1003 my ($phone_sections, $phone_lines) =
1004 $self->_items_svc_phone_sections($escape_function_nonbsp, $format);
1005 push @{$late_sections}, @$phone_sections;
1006 push @detail_items, @$phone_lines;
1008 if ( $conf->exists('voip-cust_accountcode_cdr')
1009 && $cust_main->accountcode_cdr
1010 && $self->can('_items_accountcode_cdr')
1013 my ($accountcode_section, $accountcode_lines) =
1014 $self->_items_accountcode_cdr($escape_function_nonbsp,$format);
1015 if ( scalar(@$accountcode_lines) ) {
1016 push @{$late_sections}, $accountcode_section;
1017 push @detail_items, @$accountcode_lines;
1020 } else {# not multisection
1021 # make a default section
1022 push @sections, $default_section;
1023 # and calculate the finance charge total, since it won't get done otherwise.
1024 # and the default section total
1025 # XXX possibly finance_pkgclass should not be used in this manner?
1026 my @finance_charges;
1028 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1029 if ( $invoice_data{finance_section} and
1030 grep { $_->section eq $invoice_data{finance_section} }
1031 $cust_bill_pkg->cust_bill_pkg_display ) {
1032 # I think these are always setup fees, but just to be sure...
1033 push @finance_charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1035 push @charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1038 $invoice_data{finance_amount} =
1039 sprintf('%.2f', sum( @finance_charges ) || 0);
1040 $default_section->{subtotal} = $other_money_char.
1041 sprintf('%.2f', sum( @charges ) || 0);
1044 # start setting up summary subtotals
1045 my @summary_subtotals;
1046 my $method = $conf->config('summary_subtotals_method');
1047 if ( $method and $method ne $conf->config($tc.'sections_method') ) {
1048 # then re-section them by the correct method
1049 my %section_method = ( by_category => 1 );
1050 if ( $conf->config('summary_subtotals_method') eq 'location' ) {
1051 %section_method = ( by_location => 1 );
1053 my ($early, $late) =
1054 $self->_items_sections( 'summary' => $summarypage,
1055 'escape' => $escape_function_nonbsp,
1056 'extra_sections' => $extra_sections,
1057 'format' => $format,
1060 foreach ( @$early ) {
1061 next if $_->{subtotal} == 0;
1062 $_->{subtotal} = $other_money_char.sprintf('%.2f', $_->{subtotal});
1063 push @summary_subtotals, $_;
1066 # subtotal sectioning is the same as for the actual invoice sections
1067 @summary_subtotals = @sections;
1070 # Hereafter, push sections to both @sections and @summary_subtotals
1071 # if they belong in both places (e.g. tax section). Late sections are
1072 # never in @summary_subtotals.
1074 # previous invoice balances in the Previous Charges section if there
1075 # is one, otherwise in the main detail section
1076 # (except if summary_only is enabled, don't show them at all)
1077 if ( $self->can('_items_previous') &&
1078 $self->enable_previous &&
1079 ! $conf->exists('previous_balance-summary_only') ) {
1081 warn "$me adding previous balances\n"
1084 foreach my $line_item ( $self->_items_previous ) {
1087 ref => $line_item->{'pkgnum'},
1088 pkgpart => $line_item->{'pkgpart'},
1089 #quantity => 1, # not really correct
1090 section => $previous_section, # which might be $default_section
1091 description => &$escape_function($line_item->{'description'}),
1092 ext_description => [ map { &$escape_function($_) }
1093 @{ $line_item->{'ext_description'} || [] }
1095 amount => $money_char . $line_item->{'amount'},
1096 product_code => $line_item->{'pkgpart'} || 'N/A',
1099 push @detail_items, $detail;
1100 push @buf, [ $detail->{'description'},
1101 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1107 if ( @pr_cust_bill && $self->enable_previous ) {
1108 push @buf, ['','-----------'];
1109 push @buf, [ $self->mt('Total Previous Balance'),
1110 $money_char. sprintf("%10.2f", $pr_total) ];
1114 if ( $conf->exists('svc_phone-did-summary') && $self->can('_did_summary') ) {
1115 warn "$me adding DID summary\n"
1118 my ($didsummary,$minutes) = $self->_did_summary;
1119 my $didsummary_desc = 'DID Activity Summary (since last invoice)';
1121 { 'description' => $didsummary_desc,
1122 'ext_description' => [ $didsummary, $minutes ],
1126 foreach my $section (@sections, @$late_sections) {
1128 # begin some normalization
1129 $section->{'subtotal'} = $section->{'amount'}
1131 && !exists($section->{subtotal})
1132 && exists($section->{amount});
1134 $invoice_data{finance_amount} = sprintf('%.2f', $section->{'subtotal'} )
1135 if ( $invoice_data{finance_section} &&
1136 $section->{'description'} eq $invoice_data{finance_section} );
1138 $section->{'subtotal'} = $other_money_char.
1139 sprintf('%.2f', $section->{'subtotal'})
1142 # continue some normalization
1143 $section->{'amount'} = $section->{'subtotal'}
1147 if ( $section->{'description'} ) {
1148 push @buf, ( [ &$escape_function($section->{'description'}), '' ],
1153 warn "$me setting options\n"
1157 $options{'section'} = $section if $multisection;
1158 $options{'format'} = $format;
1159 $options{'escape_function'} = $escape_function;
1160 $options{'no_usage'} = 1 unless $unsquelched;
1161 $options{'unsquelched'} = $unsquelched;
1162 $options{'summary_page'} = $summarypage;
1163 $options{'skip_usage'} =
1164 scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
1165 $options{'preref_callback'} = $params{'preref_callback'};
1167 warn "$me searching for line items\n"
1170 foreach my $line_item ( $self->_items_pkg(%options),
1171 $self->_items_fee(%options) ) {
1173 warn "$me adding line item ".
1174 join(', ', map "$_=>".$line_item->{$_}, keys %$line_item). "\n"
1177 push @buf, ( [ $line_item->{'description'},
1178 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1180 map { [ " ". $_, '' ] } @{$line_item->{'ext_description'}},
1183 $line_item->{'ref'} = $line_item->{'pkgnum'};
1184 $line_item->{'product_code'} = $line_item->{'pkgpart'} || 'N/A'; # mt()?
1185 $line_item->{'section'} = $section;
1186 $line_item->{'description'} = &$escape_function($line_item->{'description'});
1187 $line_item->{'amount'} = $money_char.$line_item->{'amount'};
1189 if ( length($line_item->{'unit_amount'}) ) {
1190 $line_item->{'unit_amount'} = $money_char.$line_item->{'unit_amount'};
1192 $line_item->{'ext_description'} ||= [];
1194 push @detail_items, $line_item;
1197 if ( $section->{'description'} ) {
1198 push @buf, ( ['','-----------'],
1199 [ $section->{'description'}. ' sub-total',
1200 $section->{'subtotal'} # already formatted this
1209 $invoice_data{current_less_finance} =
1210 sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
1212 # if there's anything in the Previous Charges section, prepend it to the list
1213 if ( $pr_total and $previous_section ne $default_section ) {
1214 unshift @sections, $previous_section;
1215 # but not @summary_subtotals
1218 warn "$me adding taxes\n"
1221 # create a tax section if we don't yet have one
1222 my $tax_description = 'Taxes, Surcharges, and Fees';
1224 List::Util::first { $_->{description} eq $tax_description } @sections;
1225 if (!$tax_section) {
1226 $tax_section = { 'description' => $tax_description };
1228 $tax_section->{tax_section} = 1; # mark this section as containing taxes
1229 # if this is an existing tax section, we're merging the tax items into it.
1230 # grab the taxtotal that's already there, strip the money symbol if any
1231 my $taxtotal = $tax_section->{'subtotal'} || 0;
1232 $taxtotal =~ s/^\Q$other_money_char\E//;
1235 #my $tax_weight = _pkg_category($tax_section->{description})
1236 # ? _pkg_category($tax_section->{description})->weight
1238 #$tax_section->{'summarized'} = ''; #why? $summarypage && !$tax_weight ? 'Y' : '';
1239 #$tax_section->{'sort_weight'} = $tax_weight;
1241 my @items_tax = $self->_items_tax;
1242 push @sections, $tax_section if $multisection and @items_tax > 0;
1244 foreach my $tax ( @items_tax ) {
1246 $taxtotal += $tax->{'amount'};
1248 my $description = &$escape_function( $tax->{'description'} );
1249 my $amount = sprintf( '%.2f', $tax->{'amount'} );
1251 if ( $multisection ) {
1253 push @detail_items, {
1254 ext_description => [],
1257 description => $description,
1258 amount => $money_char. $amount,
1260 section => $tax_section,
1265 push @total_items, {
1266 'total_item' => $description,
1267 'total_amount' => $other_money_char. $amount,
1272 push @buf,[ $description,
1273 $money_char. $amount,
1280 $total->{'total_item'} = $self->mt('Sub-total');
1281 $total->{'total_amount'} =
1282 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
1284 if ( $multisection ) {
1285 if ( $taxtotal > 0 ) {
1286 # there are taxes, so prepare the section to be displayed.
1287 # $taxtotal already includes any line items that were already in the
1288 # section (fees, taxes that are charged as packages for some reason).
1289 # also set 'summarized' to false so that this isn't a summary-only
1291 $tax_section->{'subtotal'} = $other_money_char.
1292 sprintf('%.2f', $taxtotal);
1293 $tax_section->{'pretotal'} = 'New charges sub-total '.
1294 $total->{'total_amount'};
1295 $tax_section->{'description'} = $self->mt($tax_description);
1296 $tax_section->{'summarized'} = '';
1298 # append it if it's not already there
1299 if ( !grep $tax_section, @sections ) {
1300 push @sections, $tax_section;
1301 push @summary_subtotals, $tax_section;
1306 unshift @total_items, $total;
1309 $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
1315 my %embolden_functions = (
1316 'latex' => sub { return '\textbf{'. shift(). '}' },
1317 'html' => sub { return '<b>'. shift(). '</b>' },
1318 'template' => sub { shift },
1320 my $embolden_function = $embolden_functions{$format};
1322 if ( $multisection ) {
1324 if ( $adjust_section->{'sort_weight'} ) {
1325 $adjust_section->{'posttotal'} = $self->mt('Balance Forward').' '.
1326 $other_money_char. sprintf("%.2f", ($self->billing_balance || 0) );
1328 $adjust_section->{'pretotal'} = $self->mt('New charges total').' '.
1329 $other_money_char. sprintf('%.2f', $self->charged );
1334 if ( $self->can('_items_total') ) { # should always be true now
1336 # even for multisection, need plain text version
1338 my @new_total_items = $self->_items_total;
1340 push @buf,['','-----------'];
1342 foreach ( @new_total_items ) {
1343 my ($item, $amount) = ($_->{'total_item'}, $_->{'total_amount'});
1344 $_->{'total_item'} = &$embolden_function( $item );
1345 $_->{'total_amount'} = &$embolden_function( $other_money_char.$amount );
1346 # but if it's multisection, don't append to @total_items. the adjust
1347 # section has all this stuff
1348 push @total_items, $_ if !$multisection;
1349 push @buf, [ $item, $money_char.sprintf('%10.2f',$amount) ];
1352 push @buf, [ '', '' ];
1354 # if we're showing previous invoices, also show previous
1355 # credits and payments
1356 if ( $self->enable_previous
1357 and $self->can('_items_credits')
1358 and $self->can('_items_payments') )
1362 my $credittotal = 0;
1363 foreach my $credit (
1364 $self->_items_credits( 'template' => $template, 'trim_len' => 40 )
1368 $total->{'total_item'} = &$escape_function($credit->{'description'});
1369 $credittotal += $credit->{'amount'};
1370 $total->{'total_amount'} = $minus.$other_money_char.$credit->{'amount'};
1371 if ( $multisection ) {
1372 push @detail_items, {
1373 ext_description => [],
1376 description => &$escape_function($credit->{'description'}),
1377 amount => $money_char . $credit->{'amount'},
1379 section => $adjust_section,
1382 push @total_items, $total;
1386 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
1389 foreach my $credit (
1390 $self->_items_credits( 'template' => $template, 'trim_len'=>32 )
1392 push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
1396 my $paymenttotal = 0;
1397 foreach my $payment (
1398 $self->_items_payments( 'template' => $template )
1401 $total->{'total_item'} = &$escape_function($payment->{'description'});
1402 $paymenttotal += $payment->{'amount'};
1403 $total->{'total_amount'} = $minus.$other_money_char.$payment->{'amount'};
1404 if ( $multisection ) {
1405 push @detail_items, {
1406 ext_description => [],
1409 description => &$escape_function($payment->{'description'}),
1410 amount => $money_char . $payment->{'amount'},
1412 section => $adjust_section,
1415 push @total_items, $total;
1417 push @buf, [ $payment->{'description'},
1418 $money_char. sprintf("%10.2f", $payment->{'amount'}),
1421 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
1423 if ( $multisection ) {
1424 $adjust_section->{'subtotal'} = $other_money_char.
1425 sprintf('%.2f', $credittotal + $paymenttotal);
1427 #why this? because {sort_weight} forces the adjust_section to appear
1428 #in @extra_sections instead of @sections. obviously.
1429 push @sections, $adjust_section
1430 unless $adjust_section->{sort_weight};
1431 # do not summarize; adjustments there are shown according to
1435 # create Balance Due message
1438 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1439 $total->{'total_amount'} =
1440 &$embolden_function(
1441 $other_money_char. sprintf('%.2f', #why? $summarypage
1442 # ? $self->charged +
1443 # $self->billing_balance
1445 $self->owed + $pr_total
1448 if ( $multisection && !$adjust_section->{sort_weight} ) {
1449 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
1450 $total->{'total_amount'};
1452 push @total_items, $total;
1454 push @buf,['','-----------'];
1455 push @buf,[$self->balance_due_msg, $money_char.
1456 sprintf("%10.2f", $balance_due ) ];
1459 if ( $conf->exists('previous_balance-show_credit')
1460 and $cust_main->balance < 0 ) {
1461 my $credit_total = {
1462 'total_item' => &$embolden_function($self->credit_balance_msg),
1463 'total_amount' => &$embolden_function(
1464 $other_money_char. sprintf('%.2f', -$cust_main->balance)
1467 if ( $multisection ) {
1468 $adjust_section->{'posttotal'} .= $newline_token .
1469 $credit_total->{'total_item'} . ' ' . $credit_total->{'total_amount'};
1472 push @total_items, $credit_total;
1474 push @buf,['','-----------'];
1475 push @buf,[$self->credit_balance_msg, $money_char.
1476 sprintf("%10.2f", -$cust_main->balance ) ];
1480 } #end of default total adding ! can('_items_total')
1482 if ( $multisection ) {
1483 if ( $conf->exists('svc_phone_sections')
1484 && $self->can('_items_svc_phone_sections')
1488 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1489 $total->{'total_amount'} =
1490 &$embolden_function(
1491 $other_money_char. sprintf('%.2f', $self->owed + $pr_total)
1493 my $last_section = pop @sections;
1494 $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
1495 $total->{'total_amount'};
1496 push @sections, $last_section;
1498 push @sections, @$late_sections
1502 # make a discounts-available section, even without multisection
1503 if ( $conf->exists('discount-show_available')
1504 and my @discounts_avail = $self->_items_discounts_avail ) {
1505 my $discount_section = {
1506 'description' => $self->mt('Discounts Available'),
1511 push @sections, $discount_section; # do not summarize
1512 push @detail_items, map { +{
1513 'ref' => '', #should this be something else?
1514 'section' => $discount_section,
1515 'description' => &$escape_function( $_->{description} ),
1516 'amount' => $money_char . &$escape_function( $_->{amount} ),
1517 'ext_description' => [ &$escape_function($_->{ext_description}) || () ],
1518 } } @discounts_avail;
1521 # not adding any more sections after this
1522 $invoice_data{summary_subtotals} = \@summary_subtotals;
1525 if ( $conf->exists('usage_class_summary')
1526 and $self->can('_items_usage_class_summary') ) {
1527 my @usage_subtotals = $self->_items_usage_class_summary(escape => $escape_function, 'money_char' => $other_money_char);
1528 if ( @usage_subtotals ) {
1529 unshift @sections, $usage_subtotals[0]->{section}; # do not summarize
1530 unshift @detail_items, @usage_subtotals;
1534 # invoice history "section" (not really a section)
1535 # not to be included in any subtotals, completely independent of
1537 if ( $conf->exists('previous_invoice_history') and $cust_main->isa('FS::cust_main') ) {
1540 foreach my $cust_bill ( $cust_main->cust_bill ) {
1541 # XXX hardcoded format, and currently only 'charged'; add other fields
1542 # if they become necessary
1543 my $date = $self->time2str_local('%b %Y', $cust_bill->_date);
1544 $history{$date} ||= 0;
1545 $history{$date} += $cust_bill->charged;
1546 # just so we have a numeric sort key
1547 $monthorder{$date} ||= $cust_bill->_date;
1549 my @sorted_months = sort { $monthorder{$a} <=> $monthorder{$b} }
1551 my @sorted_amounts = map { sprintf('%.2f', $history{$_}) } @sorted_months;
1552 $invoice_data{monthly_history} = [ \@sorted_months, \@sorted_amounts ];
1555 # service locations: another option for template customization
1557 foreach my $item (@detail_items) {
1558 if ( $item->{locationnum} ) {
1559 $location_info{ $item->{locationnum} } ||= {
1560 FS::cust_location->by_key( $item->{locationnum} )->location_hash
1564 $invoice_data{location_info} = \%location_info;
1566 # debugging hook: call this with 'diag' => 1 to just get a hash of
1567 # the invoice variables
1568 return \%invoice_data if ( $params{'diag'} );
1570 # All sections and items are built; now fill in templates.
1571 my @includelist = ();
1572 push @includelist, 'summary' if $summarypage;
1573 foreach my $include ( @includelist ) {
1575 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
1578 if ( length( $conf->config($inc_file, $agentnum) ) ) {
1580 @inc_src = $conf->config($inc_file, $agentnum);
1584 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
1586 my $convert_map = $convert_maps{$format}{$include};
1588 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
1589 s/--\@\]/$delimiters{$format}[1]/g;
1592 &$convert_map( $conf->config($inc_file, $agentnum) );
1596 my $inc_tt = new Text::Template (
1598 SOURCE => [ map "$_\n", @inc_src ],
1599 DELIMITERS => $delimiters{$format},
1600 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
1602 unless ( $inc_tt->compile() ) {
1603 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
1604 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
1608 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
1610 $invoice_data{$include} =~ s/\n+$//
1611 if ($format eq 'latex');
1616 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1617 /invoice_lines\((\d*)\)/;
1618 $invoice_lines += $1 || scalar(@buf);
1621 die "no invoice_lines() functions in template?"
1622 if ( $format eq 'template' && !$wasfunc );
1624 if ($format eq 'template') {
1626 if ( $invoice_lines ) {
1627 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
1628 $invoice_data{'total_pages'}++
1629 if scalar(@buf) % $invoice_lines;
1632 #setup subroutine for the template
1633 $invoice_data{invoice_lines} = sub {
1634 my $lines = shift || scalar(@buf);
1646 push @collect, split("\n",
1647 $text_template->fill_in( HASH => \%invoice_data )
1649 $invoice_data{'page'}++;
1651 map "$_\n", @collect;
1653 } else { # this is where we actually create the invoice
1655 warn "filling in template for invoice ". $self->invnum. "\n"
1657 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
1660 $text_template->fill_in(HASH => \%invoice_data);
1664 sub notice_name { '('.shift->table.')'; }
1666 # this is not supposed to happen
1667 sub template_conf { warn "bare FS::Template_Mixin::template_conf";
1671 # helper routine for generating date ranges
1672 sub _prior_month30s {
1675 [ 1, 2592000 ], # 0-30 days ago
1676 [ 2592000, 5184000 ], # 30-60 days ago
1677 [ 5184000, 7776000 ], # 60-90 days ago
1678 [ 7776000, 0 ], # 90+ days ago
1681 map { [ $_->[0] ? $self->_date - $_->[0] - 1 : '',
1682 $_->[1] ? $self->_date - $_->[1] - 1 : '',
1687 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
1689 Returns an postscript invoice, as a scalar.
1691 Options can be passed as a hashref (recommended) or as a list of time, template
1692 and then any key/value pairs for any other options.
1694 I<time> an optional value used to control the printing of overdue messages. The
1695 default is now. It isn't the date of the invoice; that's the `_date' field.
1696 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1697 L<Time::Local> and L<Date::Parse> for conversion functions.
1699 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1706 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1707 my $ps = generate_ps($file);
1709 unlink($barcodefile) if $barcodefile;
1714 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
1716 Returns an PDF invoice, as a scalar.
1718 Options can be passed as a hashref (recommended) or as a list of time, template
1719 and then any key/value pairs for any other options.
1721 I<time> an optional value used to control the printing of overdue messages. The
1722 default is now. It isn't the date of the invoice; that's the `_date' field.
1723 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1724 L<Time::Local> and L<Date::Parse> for conversion functions.
1726 I<template>, if specified, is the name of a suffix for alternate invoices.
1728 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1735 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1736 my $pdf = generate_pdf($file);
1738 unlink($barcodefile) if $barcodefile;
1743 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
1745 Returns an HTML invoice, as a scalar.
1747 I<time> an optional value used to control the printing of overdue messages. The
1748 default is now. It isn't the date of the invoice; that's the `_date' field.
1749 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1750 L<Time::Local> and L<Date::Parse> for conversion functions.
1752 I<template>, if specified, is the name of a suffix for alternate invoices.
1754 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1756 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
1757 when emailing the invoice as part of a multipart/related MIME email.
1765 %params = %{ shift() };
1769 $params{'format'} = 'html';
1771 $self->print_generic( %params );
1774 # quick subroutine for print_latex
1776 # There are ten characters that LaTeX treats as special characters, which
1777 # means that they do not simply typeset themselves:
1778 # # $ % & ~ _ ^ \ { }
1780 # TeX ignores blanks following an escaped character; if you want a blank (as
1781 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
1785 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
1786 $value =~ s/([<>])/\$$1\$/g;
1792 encode_entities($value);
1796 sub _html_escape_nbsp {
1797 my $value = _html_escape(shift);
1798 $value =~ s/ +/ /g;
1802 #utility methods for print_*
1804 sub _translate_old_latex_format {
1805 warn "_translate_old_latex_format called\n"
1812 if ( $line =~ /^%%Detail\s*$/ ) {
1814 push @template, q![@--!,
1815 q! foreach my $_tr_line (@detail_items) {!,
1816 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
1817 q! $_tr_line->{'description'} .= !,
1818 q! "\\tabularnewline\n~~".!,
1819 q! join( "\\tabularnewline\n~~",!,
1820 q! @{$_tr_line->{'ext_description'}}!,
1824 while ( ( my $line_item_line = shift )
1825 !~ /^%%EndDetail\s*$/ ) {
1826 $line_item_line =~ s/'/\\'/g; # nice LTS
1827 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1828 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1829 push @template, " \$OUT .= '$line_item_line';";
1832 push @template, '}',
1835 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1837 push @template, '[@--',
1838 ' foreach my $_tr_line (@total_items) {';
1840 while ( ( my $total_item_line = shift )
1841 !~ /^%%EndTotalDetails\s*$/ ) {
1842 $total_item_line =~ s/'/\\'/g; # nice LTS
1843 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1844 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1845 push @template, " \$OUT .= '$total_item_line';";
1848 push @template, '}',
1852 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
1853 push @template, $line;
1859 warn "$_\n" foreach @template;
1871 my $conf = $self->conf;
1873 #check for an invoice-specific override
1874 return $self->invoice_terms if $self->invoice_terms;
1876 #check for a customer- specific override
1877 my $cust_main = $self->cust_main;
1878 return $cust_main->invoice_terms if $cust_main && $cust_main->invoice_terms;
1882 $agentnum = $cust_main->agentnum;
1883 } elsif ( my $prospect_main = $self->prospect_main ) {
1884 $agentnum = $prospect_main->agentnum;
1887 #use configured default
1888 $conf->config('invoice_default_terms', $agentnum) || '';
1898 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1899 $duedate = $self->_date() + ( $1 * 86400 );
1910 $self->due_date ? $self->time2str_local(shift, $self->due_date) : '';
1913 =item balance_due_msg
1917 sub balance_due_msg {
1919 my $msg = $self->mt('Balance Due');
1920 return $msg unless $self->terms; # huh?
1921 if ( !$self->conf->exists('invoice_show_prior_due_date')
1922 or $self->conf->exists('invoice_sections') ) {
1923 # if enabled, the due date is shown with Total New Charges (see
1924 # _items_total) and not here
1925 # (yes, or if invoice_sections is enabled; this is just for compatibility)
1926 if ( $self->due_date ) {
1927 $msg .= ' - ' . $self->mt('Please pay by'). ' '.
1928 $self->due_date2str('short');
1929 } elsif ( $self->terms ) {
1930 $msg .= ' - '. $self->mt($self->terms);
1936 =item balance_due_date
1940 sub balance_due_date {
1942 my $conf = $self->conf;
1944 my $terms = $self->terms;
1945 if ( $terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1946 $duedate = $self->time2str_local('rdate', $self->_date + ($1*86400) );
1951 sub credit_balance_msg {
1953 $self->mt('Credit Balance Remaining')
1958 Returns a string with the date, for example: "3/20/2008", localized for the
1959 customer. Use _date_pretty_unlocalized for non-end-customer display use.
1965 $self->time2str_local('short', $self->_date);
1968 =item _date_pretty_unlocalized
1970 Returns a string with the date, for example: "3/20/2008", in the format
1971 configured for the back-office. Use _date_pretty for end-customer display use.
1975 sub _date_pretty_unlocalized {
1977 time2str($date_format, $self->_date);
1982 Emails this template.
1984 Options are passed as a hashref. Available options:
1990 If specified, overrides the default From: address.
1994 If specified, overrides the name of the sent document ("Invoice" or "Quotation")
1998 (Deprecated) If specified, is the name of a suffix for alternate template files.
2002 Options accepted by generate_email can also be used.
2008 my $opt = shift || {};
2009 if ($opt and !ref($opt)) {
2010 die ref($self). '->email called with positional parameters';
2013 return if $self->hide;
2015 my $error = send_email(
2016 $self->generate_email(
2017 'subject' => $self->email_subject($opt->{template}),
2018 %$opt, # template, etc.
2022 die "can't email: $error\n" if $error;
2025 =item generate_email OPTION => VALUE ...
2033 sender address, required
2037 alternate template name, optional
2041 email subject, optional
2045 notice name instead of "Invoice", optional
2049 Returns an argument list to be passed to L<FS::Misc::send_email>.
2055 sub generate_email {
2059 my $conf = $self->conf;
2061 my $me = '[FS::Template_Mixin::generate_email]';
2064 'from' => $args{'from'},
2065 'subject' => ($args{'subject'} || $self->email_subject),
2066 'custnum' => $self->custnum,
2067 'msgtype' => 'invoice',
2070 $args{'unsquelch_cdr'} = $conf->exists('voip-cdr_email');
2072 my $cust_main = $self->cust_main;
2074 if (ref($args{'to'}) eq 'ARRAY') {
2075 $return{'to'} = $args{'to'};
2076 } elsif ( $cust_main ) {
2077 $return{'to'} = [ $cust_main->invoicing_list_emailonly ];
2080 my $tc = $self->template_conf;
2082 my @text; # array of lines
2083 my $html; # a big string
2084 my @related_parts; # will contain the text/HTML alternative, and images
2085 my $related; # will contain the multipart/related object
2087 if ( $conf->exists($tc. 'email_pdf') ) {
2088 if ( my $msgnum = $conf->config($tc.'email_pdf_msgnum') ) {
2090 warn "$me using '${tc}email_pdf_msgnum' in multipart message"
2093 my $msg_template = FS::msg_template->by_key($msgnum)
2094 or die "${tc}email_pdf_msgnum $msgnum not found\n";
2095 my %prepared = $msg_template->prepare(
2096 cust_main => $self->cust_main,
2100 @text = split(/(?=\n)/, $prepared{'text_body'});
2101 $html = $prepared{'html_body'};
2103 } elsif ( my @note = $conf->config($tc.'email_pdf_note') ) {
2105 warn "$me using '${tc}email_pdf_note' in multipart message"
2107 @text = $conf->config($tc.'email_pdf_note');
2108 $html = join('<BR>', @text);
2110 } # else use the plain text invoice
2115 if ( $conf->config($tc.'template') ) {
2117 warn "$me generating plain text invoice"
2120 # 'print_text' argument is no longer used
2121 @text = $self->print_text(\%args);
2125 warn "$me no plain text version exists; sending empty message body"
2132 my $text_part = build MIME::Entity (
2133 'Type' => 'text/plain',
2134 'Encoding' => 'quoted-printable',
2135 'Charset' => 'UTF-8',
2136 #'Encoding' => '7bit',
2138 'Disposition' => 'inline',
2143 if ( $conf->exists($tc.'html') ) {
2144 warn "$me generating HTML invoice"
2147 $args{'from'} =~ /\@([\w\.\-]+)/;
2148 my $from = $1 || 'example.com';
2149 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2152 my $agentnum = $cust_main ? $cust_main->agentnum
2153 : $self->prospect_main->agentnum;
2154 if ( defined($args{'template'}) && length($args{'template'})
2155 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
2158 $logo = 'logo_'. $args{'template'}. '.png';
2162 my $image_data = $conf->config_binary( $logo, $agentnum);
2164 push @related_parts, build MIME::Entity
2165 'Type' => 'image/png',
2166 'Encoding' => 'base64',
2167 'Data' => $image_data,
2168 'Filename' => 'logo.png',
2169 'Content-ID' => "<$content_id>",
2172 if ( ref($self) eq 'FS::cust_bill' && $conf->exists('invoice-barcode') ) {
2173 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2174 push @related_parts, build MIME::Entity
2175 'Type' => 'image/png',
2176 'Encoding' => 'base64',
2177 'Data' => $self->invoice_barcode(0),
2178 'Filename' => 'barcode.png',
2179 'Content-ID' => "<$barcode_content_id>",
2181 $args{'barcode_cid'} = $barcode_content_id;
2184 $html = $self->print_html({ 'cid'=>$content_id, %args });
2191 warn "$me creating HTML/text multipart message"
2194 $return{'nobody'} = 1;
2196 my $alternative = build MIME::Entity
2197 'Type' => 'multipart/alternative',
2198 #'Encoding' => '7bit',
2199 'Disposition' => 'inline'
2203 $alternative->add_part($text_part);
2206 $alternative->attach(
2207 'Type' => 'text/html',
2208 'Encoding' => 'quoted-printable',
2209 'Data' => [ '<html>',
2212 ' '. encode_entities($return{'subject'}),
2215 ' <body bgcolor="#e8e8e8">',
2220 'Disposition' => 'inline',
2221 #'Filename' => 'invoice.pdf',
2224 unshift @related_parts, $alternative;
2226 $related = build MIME::Entity 'Type' => 'multipart/related',
2227 'Encoding' => '7bit';
2229 #false laziness w/Misc::send_email
2230 $related->head->replace('Content-type',
2231 $related->mime_type.
2232 '; boundary="'. $related->head->multipart_boundary. '"'.
2233 '; type=multipart/alternative'
2236 $related->add_part($_) foreach @related_parts;
2240 my @otherparts = ();
2241 if ( ref($self) eq 'FS::cust_bill' && $cust_main->email_csv_cdr ) {
2243 push @otherparts, build MIME::Entity
2244 'Type' => 'text/csv',
2245 'Encoding' => '7bit',
2246 'Data' => [ map { "$_\n" }
2247 $self->call_details('prepend_billed_number' => 1)
2249 'Disposition' => 'attachment',
2250 'Filename' => 'usage-'. $self->invnum. '.csv',
2255 if ( $conf->exists($tc.'email_pdf') ) {
2260 # multipart/alternative
2266 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%args);
2267 push @otherparts, $pdf;
2271 $return{'content-type'} = 'multipart/mixed'; # of the outer container
2273 $return{'mimeparts'} = [ $related, @otherparts ];
2274 $return{'type'} = 'multipart/related'; # of the first part
2276 $return{'mimeparts'} = [ $text_part, @otherparts ];
2277 $return{'type'} = 'text/plain';
2279 } elsif ( $html ) { # no PDF or CSV, strip the outer container
2280 $return{'mimeparts'} = \@related_parts;
2281 $return{'content-type'} = 'multipart/related';
2282 $return{'type'} = 'multipart/alternative';
2283 } else { # no HTML either
2284 $return{'body'} = \@text;
2285 $return{'content-type'} = 'text/plain';
2294 Returns a list suitable for passing to MIME::Entity->build(), representing
2295 this invoice as PDF attachment.
2302 'Type' => 'application/pdf',
2303 'Encoding' => 'base64',
2304 'Data' => [ $self->print_pdf(@_) ],
2305 'Disposition' => 'attachment',
2306 'Filename' => 'invoice-'. $self->invnum. '.pdf',
2310 =item _items_sections OPTIONS
2312 Generate section information for all items appearing on this invoice.
2313 This will only be called for multi-section invoices.
2315 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
2316 related display records (L<FS::cust_bill_pkg_display>) and organize
2317 them into two groups ("early" and "late" according to whether they come
2318 before or after the total), then into sections. A subtotal is calculated
2321 Section descriptions are returned in sort weight order. Each consists
2322 of a hash containing:
2324 description: the package category name, escaped
2325 subtotal: the total charges in that section
2326 tax_section: a flag indicating that the section contains only tax charges
2327 summarized: same as tax_section, for some reason
2328 sort_weight: the package category's sort weight
2330 If 'condense' is set on the display record, it also contains everything
2331 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
2332 coderefs to generate parts of the invoice. This is not advised.
2334 The method returns two arrayrefs, one of "early" sections and one of "late"
2337 OPTIONS may include:
2339 by_location: a flag to divide the invoice into sections by location.
2340 Each section hash will have a 'location' element containing a hashref of
2341 the location fields (see L<FS::cust_location>). The section description
2342 will be the location label, but the template can use any of the location
2343 fields to create a suitable label.
2345 by_category: a flag to divide the invoice into sections using display
2346 records (see L<FS::cust_bill_pkg_display>). This is the "traditional"
2347 behavior. Each section hash will have a 'category' element containing
2348 the section name from the display record (which probably equals the
2349 category name of the package, but may not in some cases).
2351 summary: a flag indicating that this is a summary-format invoice.
2352 Turning this on has the following effects:
2353 - Ignores display items with the 'summary' flag.
2354 - Places all sections in the "early" group even if they have post_total.
2355 - Creates sections for all non-disabled package categories, even if they
2356 have no charges on this invoice, as well as a section with no name.
2358 escape: an escape function to use for section titles.
2360 extra_sections: an arrayref of additional sections to return after the
2361 sorted list. If there are any of these, section subtotals exclude
2364 format: 'latex', 'html', or 'template' (i.e. text). Not used, but
2365 passed through to C<_condense_section()>.
2369 use vars qw(%pkg_category_cache);
2370 sub _items_sections {
2374 my $escape = $opt{escape};
2375 my @extra_sections = @{ $opt{extra_sections} || [] };
2377 # $subtotal{$locationnum}{$categoryname} = amount.
2378 # if we're not using by_location, $locationnum is undef.
2379 # if we're not using by_category, you guessed it, $categoryname is undef.
2380 # if we're not using either one, we shouldn't be here in the first place...
2382 my %late_subtotal = ();
2385 # About tax items + multisection invoices:
2386 # If either invoice_*summary option is enabled, AND there is a
2387 # package category with the name of the tax, then there will be
2388 # a display record assigning the tax item to that category.
2390 # However, the taxes are always placed in the "Taxes, Surcharges,
2391 # and Fees" section regardless of that. The only effect of the
2392 # display record is to create a subtotal for the summary page.
2395 my $pkg_hash = $self->cust_pkg_hash;
2397 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2400 my $usage = $cust_bill_pkg->usage;
2403 if ( $opt{by_location} ) {
2404 if ( $cust_bill_pkg->pkgnum ) {
2405 $locationnum = $pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum;
2410 $locationnum = undef;
2413 # as in _items_cust_pkg, if a line item has no display records,
2414 # cust_bill_pkg_display() returns a default record for it
2416 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
2417 next if ( $display->summary && $opt{summary} );
2419 my $section = $display->section;
2420 my $type = $display->type;
2421 # Set $section = undef if we're sectioning by location and this
2422 # line item _has_ a location (i.e. isn't a fee).
2423 $section = undef if $locationnum;
2425 # set this flag if the section is not tax-only
2426 $not_tax{$locationnum}{$section} = 1
2427 if $cust_bill_pkg->pkgnum or $cust_bill_pkg->feepart;
2429 # there's actually a very important piece of logic buried in here:
2430 # incrementing $late_subtotal{$section} CREATES
2431 # $late_subtotal{$section}. keys(%late_subtotal) is later used
2432 # to define the list of late sections, and likewise keys(%subtotal).
2433 # When _items_cust_bill_pkg is called to generate line items for
2434 # real, it will be called with 'section' => $section for each
2436 if ( $display->post_total && !$opt{summary} ) {
2437 if (! $type || $type eq 'S') {
2438 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2439 if $cust_bill_pkg->setup != 0
2440 || $cust_bill_pkg->setup_show_zero;
2444 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur
2445 if $cust_bill_pkg->recur != 0
2446 || $cust_bill_pkg->recur_show_zero;
2449 if ($type && $type eq 'R') {
2450 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2451 if $cust_bill_pkg->recur != 0
2452 || $cust_bill_pkg->recur_show_zero;
2455 if ($type && $type eq 'U') {
2456 $late_subtotal{$locationnum}{$section} += $usage
2457 unless scalar(@extra_sections);
2460 } else { # it's a pre-total (normal) section
2462 # skip tax items unless they're explicitly included in a section
2463 next if $cust_bill_pkg->pkgnum == 0 and
2464 ! $cust_bill_pkg->feepart and
2467 if ( $type eq 'S' ) {
2468 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2469 if $cust_bill_pkg->setup != 0
2470 || $cust_bill_pkg->setup_show_zero;
2471 } elsif ( $type eq 'R' ) {
2472 $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2473 if $cust_bill_pkg->recur != 0
2474 || $cust_bill_pkg->recur_show_zero;
2475 } elsif ( $type eq 'U' ) {
2476 $subtotal{$locationnum}{$section} += $usage
2477 unless scalar(@extra_sections);
2478 } elsif ( !$type ) {
2479 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2480 + $cust_bill_pkg->recur;
2489 %pkg_category_cache = ();
2491 # summary invoices need subtotals for all non-disabled package categories,
2492 # even if they're zero
2493 # but currently assume that there are no location sections, or at least
2494 # that the summary page doesn't care about them
2495 if ( $opt{summary} ) {
2496 foreach my $category (qsearch('pkg_category', {disabled => ''})) {
2497 $subtotal{''}{$category->categoryname} ||= 0;
2499 $subtotal{''}{''} ||= 0;
2503 foreach my $post_total (0,1) {
2505 my $s = $post_total ? \%late_subtotal : \%subtotal;
2506 foreach my $locationnum (keys %$s) {
2507 foreach my $sectionname (keys %{ $s->{$locationnum} }) {
2509 'subtotal' => $s->{$locationnum}{$sectionname},
2512 if ( $locationnum ) {
2513 $section->{'locationnum'} = $locationnum;
2514 my $location = FS::cust_location->by_key($locationnum);
2515 $section->{'description'} = &{ $escape }($location->location_label);
2516 # Better ideas? This will roughly group them by proximity,
2517 # which alpha sorting on any of the address fields won't.
2518 # Sorting by locationnum is meaningless.
2519 # We have to sort on _something_ or the order may change
2520 # randomly from one invoice to the next, which will confuse
2522 $section->{'sort_weight'} = sprintf('%012s',$location->zip) .
2524 $section->{'location'} = {
2525 label_prefix => &{ $escape }($location->label_prefix),
2526 map { $_ => &{ $escape }($location->get($_)) }
2530 $section->{'category'} = $sectionname;
2531 $section->{'description'} = &{ $escape }($sectionname);
2532 if ( _pkg_category($sectionname) ) {
2533 $section->{'sort_weight'} = _pkg_category($sectionname)->weight;
2534 if ( _pkg_category($sectionname)->condense ) {
2535 $section = { %$section, $self->_condense_section($opt{format}) };
2539 if ( !$post_total and !$not_tax{$locationnum}{$sectionname} ) {
2540 # then it's a tax-only section
2541 $section->{'summarized'} = 'Y';
2542 $section->{'tax_section'} = 'Y';
2544 push @these, $section;
2545 } # foreach $sectionname
2546 } #foreach $locationnum
2547 push @these, @extra_sections if $post_total == 0;
2548 # need an alpha sort for location sections, because postal codes can
2550 $sections[ $post_total ] = [ sort {
2551 $opt{'by_location'} ?
2552 ($a->{sort_weight} cmp $b->{sort_weight}) :
2553 ($a->{sort_weight} <=> $b->{sort_weight})
2555 } #foreach $post_total
2557 return @sections; # early, late
2560 #helper subs for above
2564 $self->{cust_pkg} ||= { map { $_->pkgnum => $_ } $self->cust_pkg };
2568 my $categoryname = shift;
2569 $pkg_category_cache{$categoryname} ||=
2570 qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
2573 my %condensed_format = (
2574 'label' => [ qw( Description Qty Amount ) ],
2576 sub { shift->{description} },
2577 sub { shift->{quantity} },
2578 sub { my($href, %opt) = @_;
2579 ($opt{dollar} || ''). $href->{amount};
2582 'align' => [ qw( l r r ) ],
2583 'span' => [ qw( 5 1 1 ) ], # unitprices?
2584 'width' => [ qw( 10.7cm 1.4cm 1.6cm ) ], # don't like this
2587 sub _condense_section {
2588 my ( $self, $format ) = ( shift, shift );
2590 map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
2591 qw( description_generator
2594 total_line_generator
2599 sub _condensed_generator_defaults {
2600 my ( $self, $format ) = ( shift, shift );
2601 return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
2610 sub _condensed_header_generator {
2611 my ( $self, $format ) = ( shift, shift );
2613 my ( $f, $prefix, $suffix, $separator, $column ) =
2614 _condensed_generator_defaults($format);
2616 if ($format eq 'latex') {
2617 $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
2618 $suffix = "\\\\\n\\hline";
2621 sub { my ($d,$a,$s,$w) = @_;
2622 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2624 } elsif ( $format eq 'html' ) {
2625 $prefix = '<th></th>';
2629 sub { my ($d,$a,$s,$w) = @_;
2630 return qq!<th align="$html_align{$a}">$d</th>!;
2638 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2640 &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
2643 $prefix. join($separator, @result). $suffix;
2648 sub _condensed_description_generator {
2649 my ( $self, $format ) = ( shift, shift );
2651 my ( $f, $prefix, $suffix, $separator, $column ) =
2652 _condensed_generator_defaults($format);
2654 my $money_char = '$';
2655 if ($format eq 'latex') {
2656 $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
2658 $separator = " & \n";
2660 sub { my ($d,$a,$s,$w) = @_;
2661 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2663 $money_char = '\\dollar';
2664 }elsif ( $format eq 'html' ) {
2665 $prefix = '"><td align="center"></td>';
2669 sub { my ($d,$a,$s,$w) = @_;
2670 return qq!<td align="$html_align{$a}">$d</td>!;
2672 #$money_char = $conf->config('money_char') || '$';
2673 $money_char = ''; # this is madness
2681 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2683 $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
2685 &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
2686 map { $f->{$_}->[$i] } qw(align span width)
2690 $prefix. join( $separator, @result ). $suffix;
2695 sub _condensed_total_generator {
2696 my ( $self, $format ) = ( shift, shift );
2698 my ( $f, $prefix, $suffix, $separator, $column ) =
2699 _condensed_generator_defaults($format);
2702 if ($format eq 'latex') {
2705 $separator = " & \n";
2707 sub { my ($d,$a,$s,$w) = @_;
2708 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2710 }elsif ( $format eq 'html' ) {
2714 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2716 sub { my ($d,$a,$s,$w) = @_;
2717 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2726 # my $r = &{$f->{fields}->[$i]}(@args);
2727 # $r .= ' Total' unless $i;
2729 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2731 &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
2732 map { $f->{$_}->[$i] } qw(align span width)
2736 $prefix. join( $separator, @result ). $suffix;
2741 =item total_line_generator FORMAT
2743 Returns a coderef used for generation of invoice total line items for this
2744 usage_class. FORMAT is either html or latex
2748 # should not be used: will have issues with hash element names (description vs
2749 # total_item and amount vs total_amount -- another array of functions?
2751 sub _condensed_total_line_generator {
2752 my ( $self, $format ) = ( shift, shift );
2754 my ( $f, $prefix, $suffix, $separator, $column ) =
2755 _condensed_generator_defaults($format);
2758 if ($format eq 'latex') {
2761 $separator = " & \n";
2763 sub { my ($d,$a,$s,$w) = @_;
2764 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2766 }elsif ( $format eq 'html' ) {
2770 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2772 sub { my ($d,$a,$s,$w) = @_;
2773 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2782 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2784 &{$column}( &{$f->{fields}->[$i]}(@args),
2785 map { $f->{$_}->[$i] } qw(align span width)
2789 $prefix. join( $separator, @result ). $suffix;
2794 =item _items_pkg [ OPTIONS ]
2796 Return line item hashes for each package item on this invoice. Nearly
2799 $self->_items_cust_bill_pkg([ $self->cust_bill_pkg ])
2801 OPTIONS are passed through to _items_cust_bill_pkg, and should include
2802 'format' and 'escape_function' at minimum.
2804 To produce items for a specific invoice section, OPTIONS should include
2805 'section', a hashref containing 'category' and/or 'locationnum' keys.
2807 'section' may also contain a key named 'condensed'. If this is present
2808 and has a true value, _items_pkg will try to merge identical items into items
2809 with 'quantity' equal to the number of items (not the sum of their separate
2810 quantities, for some reason).
2816 # The order of these is important. Bundled line items will be merged into
2817 # the most recent non-hidden item, so it needs to be the one with:
2819 # - the same start date
2820 # - no pkgpart_override
2822 # So: sort by pkgnum,
2824 # then sort the base line item before any overrides
2825 # then sort hidden before non-hidden add-ons
2826 # then sort by override pkgpart (for consistency)
2827 sort { $a->pkgnum <=> $b->pkgnum or
2828 $a->sdate <=> $b->sdate or
2829 ($a->pkgpart_override ? 0 : -1) or
2830 ($b->pkgpart_override ? 0 : 1) or
2831 $b->hidden cmp $a->hidden or
2832 $a->pkgpart_override <=> $b->pkgpart_override
2834 # and of course exclude taxes and fees
2835 grep { $_->pkgnum > 0 } $self->cust_bill_pkg;
2841 my @cust_bill_pkg = grep { $_->feepart } $self->cust_bill_pkg;
2842 my $escape_function = $options{escape_function};
2845 foreach my $cust_bill_pkg (@cust_bill_pkg) {
2846 # cache this, so we don't look it up again in every section
2847 my $part_fee = $cust_bill_pkg->get('part_fee')
2848 || $cust_bill_pkg->part_fee;
2849 $cust_bill_pkg->set('part_fee', $part_fee);
2851 #die "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n"; # might make more sense
2852 warn "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n";
2855 if ( exists($options{section}) and exists($options{section}{category}) )
2857 my $categoryname = $options{section}{category};
2858 # then filter for items that have that section
2859 if ( $part_fee->categoryname ne $categoryname ) {
2860 warn "skipping fee '".$part_fee->itemdesc."'--not in section $categoryname\n" if $DEBUG;
2863 } # otherwise include them all in the main section
2864 # XXX what to do when sectioning by location?
2867 my %base_invnums; # invnum => invoice date
2868 foreach ($cust_bill_pkg->cust_bill_pkg_fee) {
2869 if ($_->base_invnum) {
2870 my $base_bill = FS::cust_bill->by_key($_->base_invnum);
2871 my $base_date = $self->time2str_local('short', $base_bill->_date)
2873 $base_invnums{$_->base_invnum} = $base_date || '';
2876 foreach (sort keys(%base_invnums)) {
2877 next if $_ == $self->invnum;
2878 # per convention, we must escape ext_description lines
2880 &{$escape_function}(
2881 $self->mt('from invoice #[_1] on [_2]', $_, $base_invnums{$_})
2884 my $desc = $part_fee->itemdesc_locale($self->cust_main->locale);
2885 # but not escape the base description line
2888 { feepart => $cust_bill_pkg->feepart,
2889 amount => sprintf('%.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
2890 description => $desc,
2891 ext_description => \@ext_desc
2902 warn "$me _items_pkg searching for all package line items\n"
2905 my @cust_bill_pkg = $self->_items_nontax;
2907 warn "$me _items_pkg filtering line items\n"
2909 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2911 if ($options{section} && $options{section}->{condensed}) {
2913 warn "$me _items_pkg condensing section\n"
2917 local $Storable::canonical = 1;
2918 foreach ( @items ) {
2920 delete $item->{ref};
2921 delete $item->{ext_description};
2922 my $key = freeze($item);
2923 $itemshash{$key} ||= 0;
2924 $itemshash{$key} ++; # += $item->{quantity};
2926 @items = sort { $a->{description} cmp $b->{description} }
2927 map { my $i = thaw($_);
2928 $i->{quantity} = $itemshash{$_};
2930 sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
2936 warn "$me _items_pkg returning ". scalar(@items). " items\n"
2943 return 0 unless $a->itemdesc cmp $b->itemdesc;
2944 return -1 if $b->itemdesc eq 'Tax';
2945 return 1 if $a->itemdesc eq 'Tax';
2946 return -1 if $b->itemdesc eq 'Other surcharges';
2947 return 1 if $a->itemdesc eq 'Other surcharges';
2948 $a->itemdesc cmp $b->itemdesc;
2953 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum and ! $_->feepart }
2954 $self->cust_bill_pkg;
2955 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2957 if ( $self->conf->exists('always_show_tax') ) {
2958 my $itemdesc = $self->conf->config('always_show_tax') || 'Tax';
2959 if (0 == grep { $_->{description} eq $itemdesc } @items) {
2961 { 'description' => $itemdesc,
2968 =item _items_cust_bill_pkg CUST_BILL_PKGS OPTIONS
2970 Takes an arrayref of L<FS::cust_bill_pkg> objects, and returns a
2971 list of hashrefs describing the line items they generate on the invoice.
2973 OPTIONS may include:
2975 format: the invoice format.
2977 escape_function: the function used to escape strings.
2979 DEPRECATED? (expensive, mostly unused?)
2980 format_function: the function used to format CDRs.
2982 section: a hashref containing 'category' and/or 'locationnum'; if this
2983 is present, only returns line items that belong to that category and/or
2984 location (whichever is defined).
2986 multisection: a flag indicating that this is a multisection invoice,
2987 which does something complicated.
2989 preref_callback: coderef run for each line item, code should return HTML to be
2990 displayed before that line item (quotations only)
2992 Returns a list of hashrefs, each of which may contain:
2994 pkgnum, description, amount, unit_amount, quantity, pkgpart, _is_setup, and
2995 ext_description, which is an arrayref of detail lines to show below
3000 sub _items_cust_bill_pkg {
3002 my $conf = $self->conf;
3003 my $cust_bill_pkgs = shift;
3006 my $format = $opt{format} || '';
3007 my $escape_function = $opt{escape_function} || sub { shift };
3008 my $format_function = $opt{format_function} || '';
3009 my $no_usage = $opt{no_usage} || '';
3010 my $unsquelched = $opt{unsquelched} || ''; #unused
3011 my ($section, $locationnum, $category);
3012 if ( $opt{section} ) {
3013 $category = $opt{section}->{category};
3014 $locationnum = $opt{section}->{locationnum};
3016 my $summary_page = $opt{summary_page} || ''; #unused
3017 my $multisection = defined($category) || defined($locationnum);
3018 # this variable is the value of the config setting, not whether it applies
3019 # to this particular line item.
3020 my $discount_show_always = $conf->exists('discount-show-always');
3022 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 40;
3024 my $cust_main = $self->cust_main;#for per-agent cust_bill-line_item-ate_style
3026 # for location labels: use default location on the invoice date
3027 my $default_locationnum;
3028 if ( $self->custnum ) {
3030 my @h_search = FS::h_cust_main->sql_h_search($self->_date);
3031 $h_cust_main = qsearchs({
3032 'table' => 'h_cust_main',
3033 'hashref' => { custnum => $self->custnum },
3034 'extra_sql' => $h_search[1],
3035 'addl_from' => $h_search[3],
3037 $default_locationnum = $h_cust_main->ship_locationnum;
3038 } elsif ( $self->prospectnum ) {
3039 my $cust_location = qsearchs('cust_location',
3040 { prospectnum => $self->prospectnum,
3042 $default_locationnum = $cust_location->locationnum if $cust_location;
3045 my @b = (); # accumulator for the line item hashes that we'll return
3046 my ($s, $r, $u, $d) = ( undef, undef, undef, undef );
3047 # the 'current' line item hashes for setup, recur, usage, discount
3048 foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
3050 # if the current line item is waiting to go out, and the one we're about
3051 # to start is not bundled, then push out the current one and start a new
3054 $d->{amount} = $d->{setup_amount} + $d->{recur_amount};
3056 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3057 if ( $_ && !$cust_bill_pkg->hidden ) {
3058 $_->{amount} = sprintf( "%.2f", $_->{amount} );
3059 $_->{amount} =~ s/^\-0\.00$/0.00/;
3060 if (exists($_->{unit_amount})) {
3061 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3064 # we already decided to create this display line; don't reconsider it
3066 # if $_->{amount} != 0
3067 # || $discount_show_always
3068 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3069 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3075 if ( $locationnum ) {
3076 # this is a location section; skip packages that aren't at this
3078 next if $cust_bill_pkg->pkgnum == 0; # skips fees...
3079 next if $self->cust_pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum
3083 # Consider display records for this item to determine if it belongs
3084 # in this section. Note that if there are no display records, there
3085 # will be a default pseudo-record that includes all charge types
3086 # and has no section name.
3087 my @cust_bill_pkg_display = $cust_bill_pkg->can('cust_bill_pkg_display')
3088 ? $cust_bill_pkg->cust_bill_pkg_display
3089 : ( $cust_bill_pkg );
3091 warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
3092 $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
3095 if ( defined($category) ) {
3096 # then this is a package category section; process all display records
3097 # that belong to this section.
3098 @cust_bill_pkg_display = grep { $_->section eq $category }
3099 @cust_bill_pkg_display;
3101 # otherwise, process all display records that aren't usage summaries
3102 # (I don't think there should be usage summaries if you aren't using
3103 # category sections, but this is the historical behavior)
3104 @cust_bill_pkg_display = grep { !$_->summary }
3105 @cust_bill_pkg_display;
3108 my $classname = ''; # package class name, will fill in later
3110 foreach my $display (@cust_bill_pkg_display) {
3112 warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
3113 $display->billpkgdisplaynum. "\n"
3116 my $type = $display->type;
3118 my $desc = $cust_bill_pkg->desc( $cust_main ? $cust_main->locale : '' );
3119 $desc = substr($desc, 0, $maxlength). '...'
3120 if $format eq 'latex' && length($desc) > $maxlength;
3122 my %details_opt = ( 'format' => $format,
3123 'escape_function' => $escape_function,
3124 'format_function' => $format_function,
3125 'no_usage' => $opt{'no_usage'},
3128 if ( ref($cust_bill_pkg) eq 'FS::quotation_pkg' ) {
3129 # XXX this should be pulled out into quotation_pkg
3131 warn "$me _items_cust_bill_pkg cust_bill_pkg is quotation_pkg\n"
3133 # quotation_pkgs are never fees, so don't worry about the case where
3134 # part_pkg is undefined
3136 # and I guess they're never bundled either?
3137 if ( $cust_bill_pkg->setup != 0 ) {
3138 my $description = $desc;
3139 $description .= ' Setup'
3140 if $cust_bill_pkg->recur != 0
3141 || $discount_show_always
3142 || $cust_bill_pkg->recur_show_zero;
3144 # keep it consistent, please
3146 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref
3147 'description' => $description,
3148 'amount' => sprintf("%.2f", $cust_bill_pkg->setup),
3149 'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitsetup),
3150 'quantity' => $cust_bill_pkg->quantity,
3151 'preref_html' => ( $opt{preref_callback}
3152 ? &{ $opt{preref_callback} }( $cust_bill_pkg )
3157 if ( $cust_bill_pkg->recur != 0 ) {
3160 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref
3161 'description' => "$desc (". $cust_bill_pkg->part_pkg->freq_pretty.")",
3162 'amount' => sprintf("%.2f", $cust_bill_pkg->recur),
3163 'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitrecur),
3164 'quantity' => $cust_bill_pkg->quantity,
3165 'preref_html' => ( $opt{preref_callback}
3166 ? &{ $opt{preref_callback} }( $cust_bill_pkg )
3172 } elsif ( $cust_bill_pkg->pkgnum > 0 ) {
3173 # a "normal" package line item (not a quotation, not a fee, not a tax)
3175 warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
3178 my $cust_pkg = $cust_bill_pkg->cust_pkg;
3179 my $part_pkg = $cust_pkg->part_pkg;
3181 # which pkgpart to show for display purposes?
3182 my $pkgpart = $cust_bill_pkg->pkgpart_override || $cust_pkg->pkgpart;
3184 # start/end dates for invoice formats that do nonstandard
3186 my %item_dates = ();
3187 %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate')
3188 unless $part_pkg->option('disable_line_item_date_ranges',1);
3190 # not normally used, but pass this to the template anyway
3191 $classname = $part_pkg->classname;
3193 if ( (!$type || $type eq 'S')
3194 && ( $cust_bill_pkg->setup != 0
3195 || $cust_bill_pkg->setup_show_zero
3196 || ($discount_show_always and $cust_bill_pkg->unitsetup > 0)
3201 warn "$me _items_cust_bill_pkg adding setup\n"
3204 # append the word 'Setup' to the setup line if there's going to be
3205 # a recur line for the same package (i.e. not a one-time charge)
3206 my $description = $desc;
3207 $description .= ' Setup'
3208 if $cust_bill_pkg->recur != 0
3209 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3210 || $cust_bill_pkg->recur_show_zero;
3212 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3214 if $part_pkg->is_prepaid #for prepaid, "display the validity period
3215 # triggered by the recurring charge freq
3217 && $cust_bill_pkg->recur == 0
3218 && ! $cust_bill_pkg->recur_show_zero;
3223 # always pass the svc_label through to the template, even if
3224 # not displaying it as an ext_description
3225 my @svc_labels = map &{$escape_function}($_),
3226 $cust_pkg->h_labels_short($self->_date, undef, 'I');
3228 $svc_label = $svc_labels[0];
3230 unless ( $cust_pkg->part_pkg->hide_svc_detail
3231 || $cust_bill_pkg->hidden )
3234 push @d, @svc_labels
3235 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3236 # show the location label if it's not the customer's default
3237 # location, and we're not grouping items by location already
3238 if ( $cust_pkg->locationnum != $default_locationnum
3239 and !defined($locationnum) ) {
3240 my $loc = $cust_pkg->location_label;
3241 $loc = substr($loc, 0, $maxlength). '...'
3242 if $format eq 'latex' && length($loc) > $maxlength;
3243 push @d, &{$escape_function}($loc);
3246 } #unless hiding service details
3248 push @d, $cust_bill_pkg->details(%details_opt)
3249 if $cust_bill_pkg->recur == 0;
3251 if ( $cust_bill_pkg->hidden ) {
3252 $s->{amount} += $cust_bill_pkg->setup;
3253 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
3254 push @{ $s->{ext_description} }, @d;
3258 description => $description,
3259 pkgpart => $pkgpart,
3260 pkgnum => $cust_bill_pkg->pkgnum,
3261 amount => $cust_bill_pkg->setup,
3262 setup_show_zero => $cust_bill_pkg->setup_show_zero,
3263 unit_amount => $cust_bill_pkg->unitsetup,
3264 quantity => $cust_bill_pkg->quantity,
3265 ext_description => \@d,
3266 svc_label => ($svc_label || ''),
3267 locationnum => $cust_pkg->locationnum, # sure, why not?
3273 # should we show a recur line?
3274 # if type eq 'S', then NO, because we've been told not to.
3275 # otherwise, show the recur line if:
3276 # - there's a recurring charge
3277 # - or recur_show_zero is on
3278 # - or there's a positive unitrecur (so it's been discounted to zero)
3279 # and discount-show-always is on
3280 if ( ( !$type || $type eq 'R' || $type eq 'U' )
3282 $cust_bill_pkg->recur != 0
3284 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3285 || $cust_bill_pkg->recur_show_zero
3290 warn "$me _items_cust_bill_pkg adding recur/usage\n"
3293 my $is_summary = $display->summary;
3294 my $description = $desc;
3295 if ( $type eq 'U' and defined($r) ) {
3296 # don't just show the same description as the recur line
3297 $description = $self->mt('Usage charges');
3300 my $part_pkg = $cust_pkg->part_pkg;
3302 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3306 my @seconds = (); # for display of usage info
3309 #at least until cust_bill_pkg has "past" ranges in addition to
3310 #the "future" sdate/edate ones... see #3032
3311 my @dates = ( $self->_date );
3312 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
3313 push @dates, $prev->sdate if $prev;
3314 push @dates, undef if !$prev;
3316 my @svc_labels = map &{$escape_function}($_),
3317 $cust_pkg->h_labels_short(@dates, 'I');
3318 $svc_label = $svc_labels[0];
3320 # show service labels, unless...
3321 # the package is set not to display them
3322 unless ( $part_pkg->hide_svc_detail
3323 # or this is a tax-like line item
3324 || $cust_bill_pkg->itemdesc
3325 # or this is a hidden (bundled) line item
3326 || $cust_bill_pkg->hidden
3327 # or this is a usage summary line
3328 || $is_summary && $type && $type eq 'U'
3329 # or this is a usage line and there's a recurring line
3330 # for the package in the same section (which will
3331 # have service labels already)
3332 || ($type eq 'U' and defined($r))
3336 warn "$me _items_cust_bill_pkg adding service details\n"
3339 push @d, @svc_labels
3340 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3341 warn "$me _items_cust_bill_pkg done adding service details\n"
3344 # show the location label if it's not the customer's default
3345 # location, and we're not grouping items by location already
3346 if ( $cust_pkg->locationnum != $default_locationnum
3347 and !defined($locationnum) ) {
3348 my $loc = $cust_pkg->location_label;
3349 $loc = substr($loc, 0, $maxlength). '...'
3350 if $format eq 'latex' && length($loc) > $maxlength;
3351 push @d, &{$escape_function}($loc);
3354 # Display of seconds_since_sqlradacct:
3355 # On the invoice, when processing @detail_items, look for a field
3356 # named 'seconds'. This will contain total seconds for each
3357 # service, in the same order as @ext_description. For services
3358 # that don't support this it will show undef.
3359 if ( $conf->exists('svc_acct-usage_seconds')
3360 and ! $cust_bill_pkg->pkgpart_override ) {
3361 foreach my $cust_svc (
3362 $cust_pkg->h_cust_svc(@dates, 'I')
3365 # eval because not having any part_export_usage exports
3366 # is a fatal error, last_bill/_date because that's how
3367 # sqlradius_hour billing does it
3369 $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
3371 push @seconds, $sec;
3373 } #if svc_acct-usage_seconds
3375 } # if we are showing service labels
3377 unless ( $is_summary ) {
3378 warn "$me _items_cust_bill_pkg adding details\n"
3381 #instead of omitting details entirely in this case (unwanted side
3382 # effects), just omit CDRs
3383 $details_opt{'no_usage'} = 1
3384 if $type && $type eq 'R';
3386 push @d, $cust_bill_pkg->details(%details_opt);
3389 warn "$me _items_cust_bill_pkg calculating amount\n"
3394 $amount = $cust_bill_pkg->recur;
3395 } elsif ($type eq 'R') {
3396 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
3397 } elsif ($type eq 'U') {
3398 $amount = $cust_bill_pkg->usage;
3401 if ( !$type || $type eq 'R' ) {
3403 warn "$me _items_cust_bill_pkg adding recur\n"
3407 ( $cust_bill_pkg->unitrecur > 0 ) ? $cust_bill_pkg->unitrecur
3410 if ( $cust_bill_pkg->hidden ) {
3411 $r->{amount} += $amount;
3412 $r->{unit_amount} += $unit_amount;
3413 push @{ $r->{ext_description} }, @d;
3416 description => $description,
3417 pkgpart => $pkgpart,
3418 pkgnum => $cust_bill_pkg->pkgnum,
3420 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3421 unit_amount => $unit_amount,
3422 quantity => $cust_bill_pkg->quantity,
3424 ext_description => \@d,
3425 svc_label => ($svc_label || ''),
3426 locationnum => $cust_pkg->locationnum,
3428 $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
3431 } else { # $type eq 'U'
3433 warn "$me _items_cust_bill_pkg adding usage\n"
3436 if ( $cust_bill_pkg->hidden and defined($u) ) {
3437 # if this is a hidden package and there's already a usage
3438 # line for the bundle, add this package's total amount and
3439 # usage details to it
3440 $u->{amount} += $amount;
3441 push @{ $u->{ext_description} }, @d;
3442 } elsif ( $amount ) {
3443 # create a new usage line
3445 description => $description,
3446 pkgpart => $pkgpart,
3447 pkgnum => $cust_bill_pkg->pkgnum,
3450 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3452 ext_description => \@d,
3453 locationnum => $cust_pkg->locationnum,
3455 } # else this has no usage, so don't create a usage section
3458 } # recurring or usage with recurring charge
3460 } else { # taxes and fees
3462 warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
3465 # items of this kind should normally not have sdate/edate.
3467 'description' => $desc,
3468 'amount' => sprintf('%.2f', $cust_bill_pkg->setup
3469 + $cust_bill_pkg->recur)
3472 } # if quotation / package line item / other line item
3474 # decide whether to show active discounts here
3476 # case 1: we are showing a single line for the package
3478 # case 2: we are showing a setup line for a package that has
3479 # no base recurring fee
3480 or ( $type eq 'S' and $cust_bill_pkg->unitrecur == 0 )
3481 # case 3: we are showing a recur line for a package that has
3482 # a base recurring fee
3483 or ( $type eq 'R' and $cust_bill_pkg->unitrecur > 0 )
3486 my $item_discount = $cust_bill_pkg->_item_discount;
3487 if ( $item_discount ) {
3488 # $item_discount->{amount} is negative
3490 if ( $d and $cust_bill_pkg->hidden ) {
3491 $d->{setup_amount} += $item_discount->{setup_amount};
3492 $d->{recur_amount} += $item_discount->{recur_amount};
3494 $d = $item_discount;
3495 $_ = &{$escape_function}($_) foreach @{ $d->{ext_description} };
3498 # update the active line (before the discount) to show the
3499 # original price (whether this is a hidden line or not)
3501 $s->{amount} -= $item_discount->{setup_amount} if $s;
3502 $r->{amount} -= $item_discount->{recur_amount} if $r;
3504 } # if there are any discounts
3505 } # if this is an appropriate place to show discounts
3507 } # foreach $display
3511 # discount amount is internally split up
3513 $d->{amount} = $d->{setup_amount} + $d->{recur_amount};
3516 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3518 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
3519 if exists($_->{amount});
3520 $_->{amount} =~ s/^\-0\.00$/0.00/;
3521 if (exists($_->{unit_amount})) {
3522 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3526 #if $_->{amount} != 0
3527 # || $discount_show_always
3528 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3529 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3533 warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
3540 =item _items_discounts_avail
3542 Returns an array of line item hashrefs representing available term discounts
3543 for this invoice. This makes the same assumptions that apply to term
3544 discounts in general: that the package is billed monthly, at a flat rate,
3545 with no usage charges. A prorated first month will be handled, as will
3546 a setup fee if the discount is allowed to apply to setup fees.
3550 sub _items_discounts_avail {
3553 #maybe move this method from cust_bill when quotations support discount_plans
3554 return () unless $self->can('discount_plans');
3555 my %plans = $self->discount_plans;
3557 my $list_pkgnums = 0; # if any packages are not eligible for all discounts
3558 $list_pkgnums = grep { $_->list_pkgnums } values %plans;
3562 my $plan = $plans{$months};
3564 my $term_total = sprintf('%.2f', $plan->discounted_total);
3565 my $percent = sprintf('%.0f',
3566 100 * (1 - $term_total / $plan->base_total) );
3567 my $permonth = sprintf('%.2f', $term_total / $months);
3568 my $detail = $self->mt('discount on item'). ' '.
3569 join(', ', map { "#$_" } $plan->pkgnums)
3572 # discounts for non-integer months don't work anyway
3573 $months = sprintf("%d", $months);
3576 description => $self->mt('Save [_1]% by paying for [_2] months',
3578 amount => $self->mt('[_1] ([_2] per month)',
3579 $term_total, $money_char.$permonth),
3580 ext_description => ($detail || ''),
3583 sort { $b <=> $a } keys %plans;