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 Time::Local qw( timelocal );
14 use Text::Template 1.20;
16 use Archive::Zip qw( :ERROR_CODES :CONSTANTS );
21 use FS::Misc qw( send_email );
22 use FS::Record qw( qsearch qsearchs );
24 use FS::Misc qw( generate_ps generate_pdf );
31 $me = '[FS::Template_Mixin]';
32 FS::UID->install_callback( sub {
33 my $conf = new FS::Conf; #global
34 $money_char = $conf->config('money_char') || '$';
35 $date_format = $conf->config('date_format') || '%x'; #/YY
40 Returns a configuration handle (L<FS::Conf>) set to the customer's locale.
42 If the "mode" pseudo-field is set on the object, the configuration handle
43 will be an L<FS::invoice_conf> for that invoice mode (and the customer's
50 my $mode = $self->get('mode');
51 if ($self->{_conf} and !defined($mode)) {
52 return $self->{_conf};
55 my $cust_main = $self->cust_main;
56 my $locale = $cust_main ? $cust_main->locale : '';
59 if ( ref $mode and $mode->isa('FS::invoice_mode') ) {
60 $mode = $mode->modenum;
61 } elsif ( $mode =~ /\D/ ) {
62 die "invalid invoice mode $mode";
64 $conf = qsearchs('invoice_conf', { modenum => $mode, locale => $locale });
66 $conf = qsearchs('invoice_conf', { modenum => $mode, locale => '' });
67 # it doesn't have a locale, but system conf still might
68 $conf->set('locale' => $locale) if $conf;
71 # if $mode is unspecified, or if there is no invoice_conf matching this mode
72 # and locale, then use the system config only (but with the locale)
73 $conf ||= FS::Conf->new({ 'locale' => $locale });
75 return $self->{_conf} = $conf;
78 =item print_text OPTIONS
80 Returns an text invoice, as a list of lines.
82 Options can be passed as a hash.
84 I<time>, if specified, is used to control the printing of overdue messages. The
85 default is now. It isn't the date of the invoice; that's the `_date' field.
86 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
87 L<Time::Local> and L<Date::Parse> for conversion functions.
89 I<template>, if specified, is the name of a suffix for alternate invoices.
91 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
99 %params = %{ shift() };
104 $params{'format'} = 'template'; # for some reason
106 $self->print_generic( %params );
109 =item print_latex HASHREF
111 Internal method - returns a filename of a filled-in LaTeX template for this
112 invoice (Note: add ".tex" to get the actual filename), and a filename of
113 an associated logo (with the .eps extension included).
115 See print_ps and print_pdf for methods that return PostScript and PDF output.
117 Options can be passed as a hash.
119 I<time>, if specified, is used to control the printing of overdue messages. The
120 default is now. It isn't the date of the invoice; that's the `_date' field.
121 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
122 L<Time::Local> and L<Date::Parse> for conversion functions.
124 I<template>, if specified, is the name of a suffix for alternate invoices.
125 This is strongly deprecated; see L<FS::invoice_conf> for the right way to
126 customize invoice templates for different purposes.
128 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
137 %params = %{ shift() };
142 $params{'format'} = 'latex';
143 my $conf = $self->conf;
145 # this needs to go away
146 my $template = $params{'template'};
147 # and this especially
148 $template ||= $self->_agent_template
149 if $self->can('_agent_template');
152 $self->set('mode', $params{mode})
155 my $pkey = $self->primary_key;
156 my $tmp_template = $self->table. '.'. $self->$pkey. '.XXXXXXXX';
158 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
159 my $lh = new File::Temp(
160 TEMPLATE => $tmp_template,
164 ) or die "can't open temp file: $!\n";
166 my $agentnum = $self->agentnum;
168 if ( $template && $conf->exists("logo_${template}.eps", $agentnum) ) {
169 print $lh $conf->config_binary("logo_${template}.eps", $agentnum)
170 or die "can't write temp file: $!\n";
172 print $lh $conf->config_binary('logo.eps', $agentnum)
173 or die "can't write temp file: $!\n";
176 $params{'logo_file'} = $lh->filename;
178 if( $conf->exists('invoice-barcode')
179 && $self->can('invoice_barcode')
180 && $self->invnum ) { # don't try to barcode statements
181 my $png_file = $self->invoice_barcode($dir);
182 my $eps_file = $png_file;
183 $eps_file =~ s/\.png$/.eps/g;
184 $png_file =~ /(barcode.*png)/;
186 $eps_file =~ /(barcode.*eps)/;
189 my $curr_dir = cwd();
191 # after painfuly long experimentation, it was determined that sam2p won't
192 # accept : and other chars in the path, no matter how hard I tried to
193 # escape them, hence the chdir (and chdir back, just to be safe)
194 system('sam2p', '-j:quiet', $png_file, 'EPS:', $eps_file ) == 0
195 or die "sam2p failed: $!\n";
199 $params{'barcode_file'} = $eps_file;
202 my @filled_in = $self->print_generic( %params );
204 my $fh = new File::Temp( TEMPLATE => $tmp_template,
208 ) or die "can't open temp file: $!\n";
209 binmode($fh, ':utf8'); # language support
210 print $fh join('', @filled_in );
213 $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
214 return ($1, $params{'logo_file'}, $params{'barcode_file'});
220 my $cust_main = $self->cust_main;
221 $cust_main ? $cust_main->agentnum : $self->prospect_main->agentnum;
224 =item print_generic OPTION => VALUE ...
226 Internal method - returns a filled-in template for this invoice as a scalar.
228 See print_ps and print_pdf for methods that return PostScript and PDF output.
236 The B<format> option is required and should be set to html, latex (print and PDF) or template (plaintext).
246 Overrides "Invoice" as the name of the sent document.
250 Used to control the printing of overdue messages. The
251 default is now. It isn't the date of the invoice; that's the `_date' field.
252 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
253 L<Time::Local> and L<Date::Parse> for conversion functions.
257 Logo file (path to temporary EPS file on the local filesystem)
261 CID for inline (emailed) images (logo)
265 Override customer's locale
269 Overrides any per customer cdr squelching when true
273 Supress the (invoice, quotation, statement, etc.) number
281 Supress the payment coupon
285 Barcode file (path to temporary EPS file on the local filesystem)
289 Flag indicating the barcode image should be a link (normal HTML dipaly)
293 Barcode CID for inline (emailed) images
295 =item preref_callback
297 Coderef run for each line item, code should return HTML to be displayed
298 before that line item (quotations only)
302 Dprecated. Used as a suffix for a configuration template. Please
303 don't use this, it deprecated in favor of more flexible alternatives.
309 #what's with all the sprintf('%10.2f')'s in here? will it cause any
310 # (alignment in text invoice?) problems to change them all to '%.2f' ?
311 # yes: fixed width/plain text printing will be borked
313 my( $self, %params ) = @_;
314 my $conf = $self->conf;
316 my $today = $params{today} ? $params{today} : time;
317 warn "$me print_generic called on $self with suffix $params{template}\n"
320 my $format = $params{format};
321 die "Unknown format: $format"
322 unless $format =~ /^(latex|html|template)$/;
324 my $cust_main = $self->cust_main || $self->prospect_main;
326 my $locale = $params{'locale'} || $cust_main->locale;
328 my %delimiters = ( 'latex' => [ '[@--', '--@]' ],
329 'html' => [ '<%=', '%>' ],
330 'template' => [ '{', '}' ],
333 warn "$me print_generic creating template\n"
336 # set the notice name here, and nowhere else.
337 my $notice_name = $params{notice_name}
338 || $conf->config('notice_name')
339 || $self->notice_name;
342 my $template = $params{template} ? $params{template} : $self->_agent_template;
343 my $templatefile = $self->template_conf. $format;
344 $templatefile .= "_$template"
345 if length($template) && $conf->exists($templatefile."_$template");
348 my @invoice_template = map "$_\n", $conf->config($templatefile)
349 or die "cannot load config data $templatefile";
351 if ( $format eq 'latex' && grep { /^%%Detail/ } @invoice_template ) {
352 #change this to a die when the old code is removed
353 # it's been almost ten years, changing it to a die
354 die "old-style invoice template $templatefile; ".
355 "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
356 #$old_latex = 'true';
357 #@invoice_template = _translate_old_latex_format(@invoice_template);
360 warn "$me print_generic creating T:T object\n"
363 my $text_template = new Text::Template(
365 SOURCE => \@invoice_template,
366 DELIMITERS => $delimiters{$format},
369 warn "$me print_generic compiling T:T object\n"
372 $text_template->compile()
373 or die "Can't compile $templatefile: $Text::Template::ERROR\n";
376 # additional substitution could possibly cause breakage in existing templates
379 'notes' => sub { map "$_", @_ },
380 'footer' => sub { map "$_", @_ },
381 'smallfooter' => sub { map "$_", @_ },
382 'returnaddress' => sub { map "$_", @_ },
383 'coupon' => sub { map "$_", @_ },
384 'summary' => sub { map "$_", @_ },
390 s/%%(.*)$/<!-- $1 -->/g;
391 s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
392 s/\\begin\{enumerate\}/<ol>/g;
394 s/\\end\{enumerate\}/<\/ol>/g;
395 s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
404 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
406 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
412 s/\\hyphenation\{[\w\s\-]+}//;
417 'coupon' => sub { "" },
418 'summary' => sub { "" },
425 s/\\section\*\{\\textsc\{(.*)\}\}/\U$1/g;
426 s/\\begin\{enumerate\}//g;
428 s/\\end\{enumerate\}//g;
429 s/\\textbf\{(.*)\}/$1/g;
436 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
438 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
443 s/\\\\\*?\s*$/\n/; # dubious
444 s/\\hyphenation\{[\w\s\-]+}//;
448 'coupon' => sub { "" },
449 'summary' => sub { "" },
454 # hashes for differing output formats
455 my %nbsps = ( 'latex' => '~',
456 'html' => '', # '&nbps;' would be nice
457 'template' => '', # not used
459 my $nbsp = $nbsps{$format};
461 my %escape_functions = ( 'latex' => \&_latex_escape,
462 'html' => \&_html_escape_nbsp,#\&encode_entities,
463 'template' => sub { shift },
465 my $escape_function = $escape_functions{$format};
466 my $escape_function_nonbsp = ($format eq 'html')
467 ? \&_html_escape : $escape_function;
469 my %newline_tokens = ( 'latex' => '\\\\',
473 my $newline_token = $newline_tokens{$format};
475 warn "$me generating template variables\n"
478 # generate template variables
482 defined( $conf->config_orbase( "invoice_${format}returnaddress",
486 && length( $conf->config_orbase( "invoice_${format}returnaddress",
492 $returnaddress = join("\n",
493 $conf->config_orbase("invoice_${format}returnaddress", $template)
497 $conf->config_orbase('invoice_latexreturnaddress', $template) ) {
499 my $convert_map = $convert_maps{$format}{'returnaddress'};
502 &$convert_map( $conf->config_orbase( "invoice_latexreturnaddress",
507 } elsif ( grep /\S/, $conf->config('company_address', $cust_main->agentnum) ) {
509 my $convert_map = $convert_maps{$format}{'returnaddress'};
510 $returnaddress = join( "\n", &$convert_map(
511 map { s/( {2,})/'~' x length($1)/eg;
515 ( $conf->config('company_name', $cust_main->agentnum),
516 $conf->config('company_address', $cust_main->agentnum),
523 my $warning = "Couldn't find a return address; ".
524 "do you need to set the company_address configuration value?";
526 $returnaddress = $nbsp;
527 #$returnaddress = $warning;
531 warn "$me generating invoice data\n"
534 my $agentnum = $cust_main->agentnum;
539 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
540 'company_address' => join("\n", $conf->config('company_address', $agentnum) ). "\n",
541 'company_phonenum'=> scalar( $conf->config('company_phonenum', $agentnum) ),
542 'returnaddress' => $returnaddress,
543 'agent' => &$escape_function($cust_main->agent->agent),
545 #invoice/quotation info
546 'no_number' => $params{'no_number'},
547 'invnum' => ( $params{'no_number'} ? '' : $self->invnum ),
548 'quotationnum' => $self->quotationnum,
549 'no_date' => $params{'no_date'},
550 '_date' => ( $params{'no_date'} ? '' : $self->_date ),
551 # workaround for inconsistent behavior in the early plain text
552 # templates; see RT#28271
553 'date' => ( $params{'no_date'}
555 : ($format eq 'template'
557 : $self->time2str_local('long', $self->_date, $format)
560 'today' => $self->time2str_local('long', $today, $format),
561 'terms' => $self->terms,
562 'template' => $template, #params{'template'},
563 'notice_name' => $notice_name, # escape?
564 'current_charges' => sprintf("%.2f", $self->charged),
565 'duedate' => $self->due_date2str('rdate'), #date_format?
568 'custnum' => $cust_main->display_custnum,
569 'prospectnum' => $cust_main->prospectnum,
570 'agent_custid' => &$escape_function($cust_main->agent_custid),
571 ( map { $_ => &$escape_function($cust_main->$_()) }
572 qw( company address1 address2 city state zip fax )
574 'payname' => &$escape_function( $cust_main->invoice_attn
575 || $cust_main->contact_firstlast ),
578 'ship_enable' => $cust_main->invoice_ship_address || $conf->exists('invoice-ship_address'),
579 'unitprices' => $conf->exists('invoice-unitprice'),
580 'smallernotes' => $conf->exists('invoice-smallernotes'),
581 'smallerfooter' => $conf->exists('invoice-smallerfooter'),
582 'balance_due_below_line' => $conf->exists('balance_due_below_line'),
584 #layout info -- would be fancy to calc some of this and bury the template
586 'topmargin' => scalar($conf->config('invoice_latextopmargin', $agentnum)),
587 'headsep' => scalar($conf->config('invoice_latexheadsep', $agentnum)),
588 'textheight' => scalar($conf->config('invoice_latextextheight', $agentnum)),
589 'extracouponspace' => scalar($conf->config('invoice_latexextracouponspace', $agentnum)),
590 'couponfootsep' => scalar($conf->config('invoice_latexcouponfootsep', $agentnum)),
591 'verticalreturnaddress' => $conf->exists('invoice_latexverticalreturnaddress', $agentnum),
592 'addresssep' => scalar($conf->config('invoice_latexaddresssep', $agentnum)),
593 'amountenclosedsep' => scalar($conf->config('invoice_latexcouponamountenclosedsep', $agentnum)),
594 'coupontoaddresssep' => scalar($conf->config('invoice_latexcoupontoaddresssep', $agentnum)),
595 'addcompanytoaddress' => $conf->exists('invoice_latexcouponaddcompanytoaddress', $agentnum),
597 # better hang on to conf_dir for a while (for old templates)
598 'conf_dir' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
600 #these are only used when doing paged plaintext
607 $invoice_data{'emt'} = sub { &$escape_function($self->mt(@_)) };
608 # prototype here to silence warnings
609 $invoice_data{'time2str'} = sub ($;$$) { $self->time2str_local(@_, $format) };
611 my $min_sdate = 999999999999;
613 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
614 next unless $cust_bill_pkg->pkgnum > 0;
615 $min_sdate = $cust_bill_pkg->sdate
616 if length($cust_bill_pkg->sdate) && $cust_bill_pkg->sdate < $min_sdate;
617 $max_edate = $cust_bill_pkg->edate
618 if length($cust_bill_pkg->edate) && $cust_bill_pkg->edate > $max_edate;
621 $invoice_data{'bill_period'} = '';
622 $invoice_data{'bill_period'} =
623 $self->time2str_local('%e %h', $min_sdate, $format)
625 $self->time2str_local('%e %h', $max_edate, $format)
626 if ($max_edate != 0 && $min_sdate != 999999999999);
628 $invoice_data{finance_section} = '';
629 if ( $conf->config('finance_pkgclass') ) {
631 qsearchs('pkg_class', { classnum => $conf->config('finance_pkgclass') });
632 $invoice_data{finance_section} = $pkg_class->categoryname;
634 $invoice_data{finance_amount} = '0.00';
635 $invoice_data{finance_section} ||= 'Finance Charges'; #avoid config confusion
637 my $countrydefault = $conf->config('countrydefault') || 'US';
638 foreach ( qw( address1 address2 city state zip country fax) ){
639 my $method = 'ship_'.$_;
640 $invoice_data{"ship_$_"} = $escape_function->($cust_main->$method);
642 if ( length($cust_main->ship_company) ) {
643 $invoice_data{'ship_company'} = $escape_function->($cust_main->ship_company);
645 $invoice_data{'ship_company'} = $escape_function->($cust_main->company);
647 $invoice_data{'ship_contact'} = $escape_function->($cust_main->contact);
648 $invoice_data{'ship_country'} = ''
649 if ( $invoice_data{'ship_country'} eq $countrydefault );
651 $invoice_data{'cid'} = $params{'cid'}
654 if ( $cust_main->country eq $countrydefault ) {
655 $invoice_data{'country'} = '';
657 $invoice_data{'country'} = &$escape_function($cust_main->bill_country_full);
661 $invoice_data{'address'} = \@address;
663 $invoice_data{'payname'}.
664 ( $cust_main->po_number
665 ? " (P.O. #". $cust_main->po_number. ")"
669 push @address, $cust_main->company
670 if $cust_main->company;
671 push @address, $cust_main->address1;
672 push @address, $cust_main->address2
673 if $cust_main->address2;
675 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
676 push @address, $invoice_data{'country'}
677 if $invoice_data{'country'};
679 while (scalar(@address) < 5);
681 $invoice_data{'logo_file'} = $params{'logo_file'}
682 if $params{'logo_file'};
683 $invoice_data{'barcode_file'} = $params{'barcode_file'}
684 if $params{'barcode_file'};
685 $invoice_data{'barcode_img'} = $params{'barcode_img'}
686 if $params{'barcode_img'};
687 $invoice_data{'barcode_cid'} = $params{'barcode_cid'}
688 if $params{'barcode_cid'};
690 my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
691 # my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
692 #my $balance_due = $self->owed + $pr_total - $cr_total;
693 my $balance_due = $self->owed;
694 if ( $self->enable_previous ) {
695 $balance_due += $pr_total;
697 # otherwise the previous balance is not shown, so including it in the
698 # balance due is just confusing
700 # the sum of amount owed on all invoices
701 # (this is used in the summary & on the payment coupon)
702 $invoice_data{'balance'} = sprintf("%.2f", $balance_due);
704 # flag telling this invoice to have a first-page summary
705 my $summarypage = '';
707 if ( $self->custnum && $self->invnum ) {
708 # XXX should be an FS::cust_bill method to set the defaults, instead
709 # of checking the type here
711 # info from customer's last invoice before this one, for some
713 $invoice_data{'last_bill'} = {};
715 my $last_bill = $self->previous_bill;
718 # "balance_date_range" unfortunately is unsuitable for this, since it
719 # cares about application dates. We want to know the sum of all
720 # _top-level transactions_ dated before the last invoice.
722 # still do this for the "Previous Balance" line of the summary block
724 map "$_ WHERE _date <= ? AND custnum = ?", (
725 "SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill",
726 "SELECT -1 * COALESCE( SUM(amount), 0 ) FROM cust_credit",
727 "SELECT -1 * COALESCE( SUM(paid), 0 ) FROM cust_pay",
728 "SELECT COALESCE( SUM(refund), 0 ) FROM cust_refund",
731 # the customer's current balance immediately after generating the last
734 my $last_bill_balance = $last_bill->charged;
736 my $delta = FS::Record->scalar_sql(
738 $last_bill->_date - 1,
741 $last_bill_balance += $delta;
744 $last_bill_balance = sprintf("%.2f", $last_bill_balance);
746 warn sprintf("LAST BILL: INVNUM %d, DATE %s, BALANCE %.2f\n\n",
748 $self->time2str_local('%D', $last_bill->_date),
751 # ("true_previous_balance" is a terrible name, but at least it's no
752 # longer stored in the database)
753 $invoice_data{'true_previous_balance'} = $last_bill_balance;
755 # Now, get all applications of credits/payments dated on or after the
756 # previous bill, to invoices before the current bill. (The
757 # credit/payment date restriction prevents these from intersecting
758 # the "Previous Balance" set.)
759 # These are "adjustments". The past due balance will be shown as
760 # Previous Balance - Adjustments.
763 "SELECT COALESCE(SUM(y.amount),0) FROM $_ JOIN cust_bill USING (invnum)
764 WHERE cust_bill._date < ?
766 AND cust_bill.custnum = ?"
767 } "cust_credit AS x JOIN cust_credit_bill y USING (crednum)",
768 "cust_pay AS x JOIN cust_bill_pay y USING (paynum)"
771 my $delta = FS::Record->scalar_sql(
777 $adjustments += $delta;
779 $invoice_data{'balance_adjustments'} = sprintf("%.2f", $adjustments);
781 warn sprintf("BALANCE ADJUSTMENTS: %.2f\n\n",
782 $invoice_data{'balance_adjustments'}
785 # the sum of amount owed on all previous invoices
786 # ($pr_total is used elsewhere but not as $previous_balance)
787 $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total);
789 $invoice_data{'last_bill'}{'_date'} = $last_bill->_date; #unformatted
790 my (@payments, @credits);
791 # for formats that itemize previous payments
792 foreach my $cust_pay ( qsearch('cust_pay', {
793 'custnum' => $self->custnum,
794 '_date' => { op => '>=',
795 value => $last_bill->_date }
798 next if $cust_pay->_date > $self->_date;
800 '_date' => $cust_pay->_date,
801 'date' => $self->time2str_local('long', $cust_pay->_date, $format),
802 'payinfo' => $cust_pay->payby_payinfo_pretty,
803 'amount' => sprintf('%.2f', $cust_pay->paid),
805 # not concerned about applications
807 foreach my $cust_credit ( qsearch('cust_credit', {
808 'custnum' => $self->custnum,
809 '_date' => { op => '>=',
810 value => $last_bill->_date }
813 next if $cust_credit->_date > $self->_date;
815 '_date' => $cust_credit->_date,
816 'date' => $self->time2str_local('long', $cust_credit->_date, $format),
817 'creditreason'=> $cust_credit->reason,
818 'amount' => sprintf('%.2f', $cust_credit->amount),
821 $invoice_data{'previous_payments'} = \@payments;
822 $invoice_data{'previous_credits'} = \@credits;
824 # there is no $last_bill
825 $invoice_data{'true_previous_balance'} =
826 $invoice_data{'balance_adjustments'} =
827 $invoice_data{'previous_balance'} = '0.00';
828 $invoice_data{'previous_payments'} = [];
829 $invoice_data{'previous_credits'} = [];
832 if ( $conf->exists('invoice_usesummary', $agentnum) ) {
833 $invoice_data{'summarypage'} = $summarypage = 1;
836 } # if this is an invoice
838 warn "$me substituting variables in notes, footer, smallfooter\n"
841 my $tc = $self->template_conf;
842 my @include = ( [ $tc, 'notes' ],
843 [ 'invoice_', 'footer' ],
844 [ 'invoice_', 'smallfooter', ],
845 [ 'invoice_', 'watermark' ],
847 push @include, [ $tc, 'coupon', ]
848 unless $params{'no_coupon'};
850 foreach my $i (@include) {
852 # load the configuration for this sub-template
854 my($base, $include) = @$i;
856 my $inc_file = $conf->key_orbase("$base$format$include", $template);
858 my @inc_src = $conf->config($inc_file, $agentnum);
860 my $converter = $convert_maps{$format}{$include};
862 # then attempt to convert LaTeX to the requested format
863 $inc_file = $conf->key_orbase($base.'latex'.$include, $template);
864 @inc_src = &$converter( $conf->config($inc_file, $agentnum) );
866 # this isn't included in the convert_maps
867 my ($open, $close) = @{ $delimiters{$format} };
872 } # else @inc_src is empty and that's fine
874 # make a Text::Template out of it
876 my $inc_tt = new Text::Template (
878 SOURCE => [ map "$_\n", @inc_src ],
879 DELIMITERS => $delimiters{$format},
880 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
882 unless ( $inc_tt->compile() ) {
883 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
884 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
890 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
892 $invoice_data{$include} =~ s/\n+$//
893 if ($format eq 'latex');
896 # if (well, probably when) we still need PO numbers in the brave new world of
897 # 4.x, then we'll have to add them back as their own customer fields
898 # # let invoices use either of these as needed
899 # $invoice_data{'po_num'} = ($cust_main->payby eq 'BILL')
900 # ? $cust_main->payinfo : '';
901 # $invoice_data{'po_line'} =
902 # ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
903 # ? &$escape_function($self->mt("Purchase Order #").$cust_main->payinfo)
906 my %money_chars = ( 'latex' => '',
907 'html' => $conf->config('money_char') || '$',
910 my $money_char = $money_chars{$format};
913 my %other_money_chars = ( 'latex' => '\dollar ',#XXX should be a config too
914 'html' => $conf->config('money_char') || '$',
917 my $other_money_char = $other_money_chars{$format};
918 $invoice_data{'dollar'} = $other_money_char;
920 my %minus_signs = ( 'latex' => '$-$',
922 'template' => '- ' );
923 my $minus = $minus_signs{$format};
925 my @detail_items = ();
926 my @total_items = ();
930 $invoice_data{'detail_items'} = \@detail_items;
931 $invoice_data{'total_items'} = \@total_items;
932 $invoice_data{'buf'} = \@buf;
933 $invoice_data{'sections'} = \@sections;
935 warn "$me generating sections\n"
938 my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
939 my $multisection = $self->has_sections;
940 $conf->exists($tc.'sections', $cust_main->agentnum) ||
941 $conf->exists($tc.'sections_by_location', $cust_main->agentnum);
942 $invoice_data{'multisection'} = $multisection;
944 my $extra_sections = [];
945 my $extra_lines = ();
947 # default section ('Charges')
948 my $default_section = { 'description' => '',
953 # Previous Charges section
954 # subtotal is the first return value from $self->previous
955 my $previous_section;
956 # if the invoice has major sections, or if we're summarizing previous
957 # charges with a single line, or if we've been specifically told to put them
958 # in a section, create a section for previous charges:
959 if ( $multisection or
960 $conf->exists('previous_balance-summary_only') or
961 $conf->exists('previous_balance-section') ) {
963 $previous_section = { 'description' => $self->mt('Previous Charges'),
964 'subtotal' => $other_money_char.
965 sprintf('%.2f', $pr_total),
966 'summarized' => '', #why? $summarypage ? 'Y' : '',
968 $previous_section->{posttotal} = '0 / 30 / 60 / 90 days overdue '.
969 join(' / ', map { $cust_main->balance_date_range(@$_) }
970 $self->_prior_month30s
972 if $conf->exists('invoice_include_aging');
975 # otherwise put them in the main section
976 $previous_section = $default_section;
979 my $adjust_section = {
980 'description' => $self->mt('Credits, Payments, and Adjustments'),
981 'adjust_section' => 1,
982 'subtotal' => 0, # adjusted below
984 my $adjust_weight = _pkg_category($adjust_section->{description})
985 ? _pkg_category($adjust_section->{description})->weight
987 $adjust_section->{'summarized'} = ''; #why? $summarypage && !$adjust_weight ? 'Y' : '';
988 # Note: 'sort_weight' here is actually a flag telling whether there is an
989 # explicit package category for the adjust section. If so, certain behavior
991 $adjust_section->{'sort_weight'} = $adjust_weight;
994 if ( $multisection ) {
995 ($extra_sections, $extra_lines) =
996 $self->_items_extra_usage_sections($escape_function_nonbsp, $format)
997 if $conf->exists('usage_class_as_a_section', $cust_main->agentnum)
998 && $self->can('_items_extra_usage_sections');
1000 push @$extra_sections, $adjust_section if $adjust_section->{sort_weight};
1002 push @detail_items, @$extra_lines if $extra_lines;
1004 # the code is written so that both methods can be used together, but
1005 # we haven't yet changed the template to take advantage of that, so for
1006 # now, treat them as mutually exclusive.
1007 my %section_method = ( by_category => 1 );
1008 if ( $conf->config($tc.'sections_method') eq 'location' ) {
1009 %section_method = ( by_location => 1 );
1011 my ($early, $late) =
1012 $self->_items_sections( 'summary' => $summarypage,
1013 'escape' => $escape_function_nonbsp,
1014 'extra_sections' => $extra_sections,
1015 'format' => $format,
1018 push @sections, @$early;
1019 $late_sections = $late;
1021 if ( $conf->exists('svc_phone_sections')
1022 && $self->can('_items_svc_phone_sections')
1025 my ($phone_sections, $phone_lines) =
1026 $self->_items_svc_phone_sections($escape_function_nonbsp, $format);
1027 push @{$late_sections}, @$phone_sections;
1028 push @detail_items, @$phone_lines;
1030 if ( $conf->exists('voip-cust_accountcode_cdr')
1031 && $cust_main->accountcode_cdr
1032 && $self->can('_items_accountcode_cdr')
1035 my ($accountcode_section, $accountcode_lines) =
1036 $self->_items_accountcode_cdr($escape_function_nonbsp,$format);
1037 if ( scalar(@$accountcode_lines) ) {
1038 push @{$late_sections}, $accountcode_section;
1039 push @detail_items, @$accountcode_lines;
1042 } else {# not multisection
1043 # make a default section
1044 push @sections, $default_section;
1045 # and calculate the finance charge total, since it won't get done otherwise.
1046 # and the default section total
1047 # XXX possibly finance_pkgclass should not be used in this manner?
1048 my @finance_charges;
1050 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1051 if ( $invoice_data{finance_section} and
1052 grep { $_->section eq $invoice_data{finance_section} }
1053 $cust_bill_pkg->cust_bill_pkg_display ) {
1054 # I think these are always setup fees, but just to be sure...
1055 push @finance_charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1057 push @charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1060 $invoice_data{finance_amount} =
1061 sprintf('%.2f', sum( @finance_charges ) || 0);
1062 $default_section->{subtotal} = $other_money_char.
1063 sprintf('%.2f', sum( @charges ) || 0);
1066 # start setting up summary subtotals
1067 my @summary_subtotals;
1068 my $method = $conf->config('summary_subtotals_method');
1069 if ( $method and $method ne $conf->config($tc.'sections_method') ) {
1070 # then re-section them by the correct method
1071 my %section_method = ( by_category => 1 );
1072 if ( $conf->config('summary_subtotals_method') eq 'location' ) {
1073 %section_method = ( by_location => 1 );
1075 my ($early, $late) =
1076 $self->_items_sections( 'summary' => $summarypage,
1077 'escape' => $escape_function_nonbsp,
1078 'extra_sections' => $extra_sections,
1079 'format' => $format,
1082 foreach ( @$early ) {
1083 next if $_->{subtotal} == 0;
1084 $_->{subtotal} = $other_money_char.sprintf('%.2f', $_->{subtotal});
1085 push @summary_subtotals, $_;
1088 # subtotal sectioning is the same as for the actual invoice sections
1089 @summary_subtotals = @sections;
1092 # Hereafter, push sections to both @sections and @summary_subtotals
1093 # if they belong in both places (e.g. tax section). Late sections are
1094 # never in @summary_subtotals.
1096 # previous invoice balances in the Previous Charges section if there
1097 # is one, otherwise in the main detail section
1098 # (except if summary_only is enabled, don't show them at all)
1099 if ( $self->can('_items_previous') &&
1100 $self->enable_previous &&
1101 ! $conf->exists('previous_balance-summary_only') ) {
1103 warn "$me adding previous balances\n"
1106 foreach my $line_item ( $self->_items_previous ) {
1109 ref => $line_item->{'pkgnum'},
1110 pkgpart => $line_item->{'pkgpart'},
1111 #quantity => 1, # not really correct
1112 section => $previous_section, # which might be $default_section
1113 description => &$escape_function($line_item->{'description'}),
1114 ext_description => [ map { &$escape_function($_) }
1115 @{ $line_item->{'ext_description'} || [] }
1117 amount => $money_char . $line_item->{'amount'},
1118 product_code => $line_item->{'pkgpart'} || 'N/A',
1121 push @detail_items, $detail;
1122 push @buf, [ $detail->{'description'},
1123 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1129 if ( @pr_cust_bill && $self->enable_previous ) {
1130 push @buf, ['','-----------'];
1131 push @buf, [ $self->mt('Total Previous Balance'),
1132 $money_char. sprintf("%10.2f", $pr_total) ];
1136 if ( $conf->exists('svc_phone-did-summary') && $self->can('_did_summary') ) {
1137 warn "$me adding DID summary\n"
1140 my ($didsummary,$minutes) = $self->_did_summary;
1141 my $didsummary_desc = 'DID Activity Summary (since last invoice)';
1143 { 'description' => $didsummary_desc,
1144 'ext_description' => [ $didsummary, $minutes ],
1148 foreach my $section (@sections, @$late_sections) {
1150 # begin some normalization
1151 $section->{'subtotal'} = $section->{'amount'}
1153 && !exists($section->{subtotal})
1154 && exists($section->{amount});
1156 $invoice_data{finance_amount} = sprintf('%.2f', $section->{'subtotal'} )
1157 if ( $invoice_data{finance_section} &&
1158 $section->{'description'} eq $invoice_data{finance_section} );
1160 $section->{'subtotal'} = $other_money_char.
1161 sprintf('%.2f', $section->{'subtotal'})
1164 # continue some normalization
1165 $section->{'amount'} = $section->{'subtotal'}
1169 if ( $section->{'description'} ) {
1170 push @buf, ( [ &$escape_function($section->{'description'}), '' ],
1175 warn "$me setting options\n"
1179 $options{'section'} = $section if $multisection;
1180 $options{'format'} = $format;
1181 $options{'escape_function'} = $escape_function;
1182 $options{'no_usage'} = 1 unless $unsquelched;
1183 $options{'unsquelched'} = $unsquelched;
1184 $options{'summary_page'} = $summarypage;
1185 $options{'skip_usage'} =
1186 scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
1187 $options{'preref_callback'} = $params{'preref_callback'};
1189 warn "$me searching for line items\n"
1192 foreach my $line_item ( $self->_items_pkg(%options),
1193 $self->_items_fee(%options) ) {
1195 warn "$me adding line item ".
1196 join(', ', map "$_=>".$line_item->{$_}, keys %$line_item). "\n"
1199 push @buf, ( [ $line_item->{'description'},
1200 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1202 map { [ " ". $_, '' ] } @{$line_item->{'ext_description'}},
1205 $line_item->{'ref'} = $line_item->{'pkgnum'};
1206 $line_item->{'product_code'} = $line_item->{'pkgpart'} || 'N/A'; # mt()?
1207 $line_item->{'section'} = $section;
1208 $line_item->{'description'} = &$escape_function($line_item->{'description'});
1209 $line_item->{'amount'} = $money_char.$line_item->{'amount'};
1211 if ( length($line_item->{'unit_amount'}) ) {
1212 $line_item->{'unit_amount'} = $money_char.$line_item->{'unit_amount'};
1214 $line_item->{'ext_description'} ||= [];
1216 push @detail_items, $line_item;
1219 if ( $section->{'description'} ) {
1220 push @buf, ( ['','-----------'],
1221 [ $section->{'description'}. ' sub-total',
1222 $section->{'subtotal'} # already formatted this
1231 $invoice_data{current_less_finance} =
1232 sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
1234 # if there's anything in the Previous Charges section, prepend it to the list
1235 if ( $pr_total and $previous_section ne $default_section ) {
1236 unshift @sections, $previous_section;
1237 # but not @summary_subtotals
1240 warn "$me adding taxes\n"
1243 # create a tax section if we don't yet have one
1244 my @items_tax = $self->_items_tax;
1245 my $tax_description = 'Taxes, Surcharges, and Fees';
1247 List::Util::first { $_->{description} eq $tax_description } @sections;
1248 if (!$tax_section) {
1249 $tax_section = { 'description' => $tax_description };
1250 push @sections, $tax_section if $multisection and @items_tax > 0;
1252 $tax_section->{tax_section} = 1; # mark this section as containing taxes
1253 # if this is an existing tax section, we're merging the tax items into it.
1254 # grab the taxtotal that's already there, strip the money symbol if any
1255 my $taxtotal = $tax_section->{'subtotal'} || 0;
1256 $taxtotal =~ s/^\Q$other_money_char\E//;
1259 #my $tax_weight = _pkg_category($tax_section->{description})
1260 # ? _pkg_category($tax_section->{description})->weight
1262 #$tax_section->{'summarized'} = ''; #why? $summarypage && !$tax_weight ? 'Y' : '';
1263 #$tax_section->{'sort_weight'} = $tax_weight;
1265 foreach my $tax ( @items_tax ) {
1267 $taxtotal += $tax->{'amount'};
1269 my $description = &$escape_function( $tax->{'description'} );
1270 my $amount = sprintf( '%.2f', $tax->{'amount'} );
1272 if ( $multisection ) {
1274 push @detail_items, {
1275 ext_description => [],
1278 description => $description,
1279 amount => $money_char. $amount,
1281 section => $tax_section,
1286 push @total_items, {
1287 'total_item' => $description,
1288 'total_amount' => $other_money_char. $amount,
1293 push @buf,[ $description,
1294 $money_char. $amount,
1301 $total->{'total_item'} = $self->mt('Sub-total');
1302 $total->{'total_amount'} =
1303 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
1305 if ( $multisection ) {
1306 if ( $taxtotal > 0 ) {
1307 # there are taxes, so prepare the section to be displayed.
1308 # $taxtotal already includes any line items that were already in the
1309 # section (fees, taxes that are charged as packages for some reason).
1310 # also set 'summarized' to false so that this isn't a summary-only
1312 $tax_section->{'subtotal'} = $other_money_char.
1313 sprintf('%.2f', $taxtotal);
1314 $tax_section->{'pretotal'} = 'New charges sub-total '.
1315 $total->{'total_amount'};
1316 $tax_section->{'description'} = $self->mt($tax_description);
1317 $tax_section->{'summarized'} = '';
1319 # append it if it's not already there
1320 if ( !grep $tax_section, @sections ) {
1321 push @sections, $tax_section;
1322 push @summary_subtotals, $tax_section;
1327 unshift @total_items, $total;
1330 $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
1336 my %embolden_functions = (
1337 'latex' => sub { return '\textbf{'. shift(). '}' },
1338 'html' => sub { return '<b>'. shift(). '</b>' },
1339 'template' => sub { shift },
1341 my $embolden_function = $embolden_functions{$format};
1343 if ( $multisection ) {
1345 if ( $adjust_section->{'sort_weight'} ) {
1346 $adjust_section->{'posttotal'} = $self->mt('Balance Forward').' '.
1347 $other_money_char. sprintf("%.2f", ($self->billing_balance || 0) );
1349 $adjust_section->{'pretotal'} = $self->mt('New charges total').' '.
1350 $other_money_char. sprintf('%.2f', $self->charged );
1355 if ( $self->can('_items_total') ) { # should always be true now
1357 # even for multisection, need plain text version
1359 my @new_total_items = $self->_items_total;
1361 push @buf,['','-----------'];
1363 foreach ( @new_total_items ) {
1364 my ($item, $amount) = ($_->{'total_item'}, $_->{'total_amount'});
1365 $_->{'total_item'} = &$embolden_function( $item );
1366 $_->{'total_amount'} = &$embolden_function( $other_money_char.$amount );
1367 # but if it's multisection, don't append to @total_items. the adjust
1368 # section has all this stuff
1369 push @total_items, $_ if !$multisection;
1370 push @buf, [ $item, $money_char.sprintf('%10.2f',$amount) ];
1373 push @buf, [ '', '' ];
1375 # if we're showing previous invoices, also show previous
1376 # credits and payments
1377 if ( $self->enable_previous
1378 and $self->can('_items_credits')
1379 and $self->can('_items_payments') )
1383 my $credittotal = 0;
1384 foreach my $credit (
1385 $self->_items_credits( 'template' => $template, 'trim_len' => 40 )
1389 $total->{'total_item'} = &$escape_function($credit->{'description'});
1390 $credittotal += $credit->{'amount'};
1391 $total->{'total_amount'} = $minus.$other_money_char.$credit->{'amount'};
1392 if ( $multisection ) {
1393 push @detail_items, {
1394 ext_description => [],
1397 description => &$escape_function($credit->{'description'}),
1398 amount => $money_char . $credit->{'amount'},
1400 section => $adjust_section,
1403 push @total_items, $total;
1407 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
1410 foreach my $credit (
1411 $self->_items_credits( 'template' => $template, 'trim_len'=>32 )
1413 push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
1417 my $paymenttotal = 0;
1418 foreach my $payment (
1419 $self->_items_payments( 'template' => $template )
1422 $total->{'total_item'} = &$escape_function($payment->{'description'});
1423 $paymenttotal += $payment->{'amount'};
1424 $total->{'total_amount'} = $minus.$other_money_char.$payment->{'amount'};
1425 if ( $multisection ) {
1426 push @detail_items, {
1427 ext_description => [],
1430 description => &$escape_function($payment->{'description'}),
1431 amount => $money_char . $payment->{'amount'},
1433 section => $adjust_section,
1436 push @total_items, $total;
1438 push @buf, [ $payment->{'description'},
1439 $money_char. sprintf("%10.2f", $payment->{'amount'}),
1442 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
1444 if ( $multisection ) {
1445 $adjust_section->{'subtotal'} = $other_money_char.
1446 sprintf('%.2f', $credittotal + $paymenttotal);
1448 #why this? because {sort_weight} forces the adjust_section to appear
1449 #in @extra_sections instead of @sections. obviously.
1450 push @sections, $adjust_section
1451 unless $adjust_section->{sort_weight};
1452 # do not summarize; adjustments there are shown according to
1456 # create Balance Due message
1459 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1460 $total->{'total_amount'} =
1461 &$embolden_function(
1462 $other_money_char. sprintf('%.2f', #why? $summarypage
1463 # ? $self->charged +
1464 # $self->billing_balance
1466 $self->owed + $pr_total
1469 if ( $multisection && !$adjust_section->{sort_weight} ) {
1470 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
1471 $total->{'total_amount'};
1473 push @total_items, $total;
1475 push @buf,['','-----------'];
1476 push @buf,[$self->balance_due_msg, $money_char.
1477 sprintf("%10.2f", $balance_due ) ];
1480 if ( $conf->exists('previous_balance-show_credit')
1481 and $cust_main->balance < 0 ) {
1482 my $credit_total = {
1483 'total_item' => &$embolden_function($self->credit_balance_msg),
1484 'total_amount' => &$embolden_function(
1485 $other_money_char. sprintf('%.2f', -$cust_main->balance)
1488 if ( $multisection ) {
1489 $adjust_section->{'posttotal'} .= $newline_token .
1490 $credit_total->{'total_item'} . ' ' . $credit_total->{'total_amount'};
1493 push @total_items, $credit_total;
1495 push @buf,['','-----------'];
1496 push @buf,[$self->credit_balance_msg, $money_char.
1497 sprintf("%10.2f", -$cust_main->balance ) ];
1501 } #end of default total adding ! can('_items_total')
1503 if ( $multisection ) {
1504 if ( $conf->exists('svc_phone_sections')
1505 && $self->can('_items_svc_phone_sections')
1509 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1510 $total->{'total_amount'} =
1511 &$embolden_function(
1512 $other_money_char. sprintf('%.2f', $self->owed + $pr_total)
1514 my $last_section = pop @sections;
1515 $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
1516 $total->{'total_amount'};
1517 push @sections, $last_section;
1519 push @sections, @$late_sections
1523 # make a discounts-available section, even without multisection
1524 if ( $conf->exists('discount-show_available')
1525 and my @discounts_avail = $self->_items_discounts_avail ) {
1526 my $discount_section = {
1527 'description' => $self->mt('Discounts Available'),
1532 push @sections, $discount_section; # do not summarize
1533 push @detail_items, map { +{
1534 'ref' => '', #should this be something else?
1535 'section' => $discount_section,
1536 'description' => &$escape_function( $_->{description} ),
1537 'amount' => $money_char . &$escape_function( $_->{amount} ),
1538 'ext_description' => [ &$escape_function($_->{ext_description}) || () ],
1539 } } @discounts_avail;
1542 # not adding any more sections after this
1543 $invoice_data{summary_subtotals} = \@summary_subtotals;
1546 if ( $conf->exists('usage_class_summary')
1547 and $self->can('_items_usage_class_summary') ) {
1548 my @usage_subtotals = $self->_items_usage_class_summary(escape => $escape_function, 'money_char' => $other_money_char);
1549 if ( @usage_subtotals ) {
1550 unshift @sections, $usage_subtotals[0]->{section}; # do not summarize
1551 unshift @detail_items, @usage_subtotals;
1555 # invoice history "section" (not really a section)
1556 # not to be included in any subtotals, completely independent of
1558 if ( $conf->exists('previous_invoice_history') and $cust_main->isa('FS::cust_main') ) {
1561 foreach my $cust_bill ( $cust_main->cust_bill ) {
1562 # XXX hardcoded format, and currently only 'charged'; add other fields
1563 # if they become necessary
1564 my $date = $self->time2str_local('%b %Y', $cust_bill->_date);
1565 $history{$date} ||= 0;
1566 $history{$date} += $cust_bill->charged;
1567 # just so we have a numeric sort key
1568 $monthorder{$date} ||= $cust_bill->_date;
1570 my @sorted_months = sort { $monthorder{$a} <=> $monthorder{$b} }
1572 my @sorted_amounts = map { sprintf('%.2f', $history{$_}) } @sorted_months;
1573 $invoice_data{monthly_history} = [ \@sorted_months, \@sorted_amounts ];
1576 # service locations: another option for template customization
1578 foreach my $item (@detail_items) {
1579 if ( $item->{locationnum} ) {
1580 $location_info{ $item->{locationnum} } ||= {
1581 FS::cust_location->by_key( $item->{locationnum} )->location_hash
1585 $invoice_data{location_info} = \%location_info;
1587 # debugging hook: call this with 'diag' => 1 to just get a hash of
1588 # the invoice variables
1589 return \%invoice_data if ( $params{'diag'} );
1591 # All sections and items are built; now fill in templates.
1592 my @includelist = ();
1593 push @includelist, 'summary' if $summarypage;
1594 foreach my $include ( @includelist ) {
1596 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
1599 if ( length( $conf->config($inc_file, $agentnum) ) ) {
1601 @inc_src = $conf->config($inc_file, $agentnum);
1605 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
1607 my $convert_map = $convert_maps{$format}{$include};
1609 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
1610 s/--\@\]/$delimiters{$format}[1]/g;
1613 &$convert_map( $conf->config($inc_file, $agentnum) );
1617 my $inc_tt = new Text::Template (
1619 SOURCE => [ map "$_\n", @inc_src ],
1620 DELIMITERS => $delimiters{$format},
1621 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
1623 unless ( $inc_tt->compile() ) {
1624 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
1625 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
1629 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
1631 $invoice_data{$include} =~ s/\n+$//
1632 if ($format eq 'latex');
1637 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1638 /invoice_lines\((\d*)\)/;
1639 $invoice_lines += $1 || scalar(@buf);
1642 die "no invoice_lines() functions in template?"
1643 if ( $format eq 'template' && !$wasfunc );
1645 if ($format eq 'template') {
1647 if ( $invoice_lines ) {
1648 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
1649 $invoice_data{'total_pages'}++
1650 if scalar(@buf) % $invoice_lines;
1653 #setup subroutine for the template
1654 $invoice_data{invoice_lines} = sub {
1655 my $lines = shift || scalar(@buf);
1667 push @collect, split("\n",
1668 $text_template->fill_in( HASH => \%invoice_data )
1670 $invoice_data{'page'}++;
1672 map "$_\n", @collect;
1674 } else { # this is where we actually create the invoice
1676 if ( $params{no_addresses} ) {
1677 delete $invoice_data{$_} foreach qw(
1678 payname company address1 address2 city state zip country
1680 $invoice_data{returnaddress} = '~';
1683 warn "filling in template for invoice ". $self->invnum. "\n"
1685 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
1688 $text_template->fill_in(HASH => \%invoice_data);
1692 sub notice_name { '('.shift->table.')'; }
1694 # this is not supposed to happen
1695 sub template_conf { warn "bare FS::Template_Mixin::template_conf";
1699 # helper routine for generating date ranges
1700 sub _prior_month30s {
1703 [ 1, 2592000 ], # 0-30 days ago
1704 [ 2592000, 5184000 ], # 30-60 days ago
1705 [ 5184000, 7776000 ], # 60-90 days ago
1706 [ 7776000, 0 ], # 90+ days ago
1709 map { [ $_->[0] ? $self->_date - $_->[0] - 1 : '',
1710 $_->[1] ? $self->_date - $_->[1] - 1 : '',
1715 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
1717 Returns an postscript invoice, as a scalar.
1719 Options can be passed as a hashref (recommended) or as a list of time, template
1720 and then any key/value pairs for any other options.
1722 I<time> an optional value used to control the printing of overdue messages. The
1723 default is now. It isn't the date of the invoice; that's the `_date' field.
1724 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1725 L<Time::Local> and L<Date::Parse> for conversion functions.
1727 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1734 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1735 my $ps = generate_ps($file);
1737 unlink($barcodefile) if $barcodefile;
1742 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
1744 Returns an PDF invoice, as a scalar.
1746 Options can be passed as a hashref (recommended) or as a list of time, template
1747 and then any key/value pairs for any other options.
1749 I<time> an optional value used to control the printing of overdue messages. The
1750 default is now. It isn't the date of the invoice; that's the `_date' field.
1751 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1752 L<Time::Local> and L<Date::Parse> for conversion functions.
1754 I<template>, if specified, is the name of a suffix for alternate invoices.
1756 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1763 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1764 my $pdf = generate_pdf($file);
1766 unlink($barcodefile) if $barcodefile;
1771 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
1773 Returns an HTML invoice, as a scalar.
1775 I<time> an optional value used to control the printing of overdue messages. The
1776 default is now. It isn't the date of the invoice; that's the `_date' field.
1777 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1778 L<Time::Local> and L<Date::Parse> for conversion functions.
1780 I<template>, if specified, is the name of a suffix for alternate invoices.
1782 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1784 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
1785 when emailing the invoice as part of a multipart/related MIME email.
1793 %params = %{ shift() };
1797 $params{'format'} = 'html';
1799 $self->print_generic( %params );
1802 # quick subroutine for print_latex
1804 # There are ten characters that LaTeX treats as special characters, which
1805 # means that they do not simply typeset themselves:
1806 # # $ % & ~ _ ^ \ { }
1808 # TeX ignores blanks following an escaped character; if you want a blank (as
1809 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
1813 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
1814 $value =~ s/([<>])/\$$1\$/g;
1820 encode_entities($value);
1824 sub _html_escape_nbsp {
1825 my $value = _html_escape(shift);
1826 $value =~ s/ +/ /g;
1830 #utility methods for print_*
1832 sub _translate_old_latex_format {
1833 warn "_translate_old_latex_format called\n"
1840 if ( $line =~ /^%%Detail\s*$/ ) {
1842 push @template, q![@--!,
1843 q! foreach my $_tr_line (@detail_items) {!,
1844 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
1845 q! $_tr_line->{'description'} .= !,
1846 q! "\\tabularnewline\n~~".!,
1847 q! join( "\\tabularnewline\n~~",!,
1848 q! @{$_tr_line->{'ext_description'}}!,
1852 while ( ( my $line_item_line = shift )
1853 !~ /^%%EndDetail\s*$/ ) {
1854 $line_item_line =~ s/'/\\'/g; # nice LTS
1855 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1856 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1857 push @template, " \$OUT .= '$line_item_line';";
1860 push @template, '}',
1863 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1865 push @template, '[@--',
1866 ' foreach my $_tr_line (@total_items) {';
1868 while ( ( my $total_item_line = shift )
1869 !~ /^%%EndTotalDetails\s*$/ ) {
1870 $total_item_line =~ s/'/\\'/g; # nice LTS
1871 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1872 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1873 push @template, " \$OUT .= '$total_item_line';";
1876 push @template, '}',
1880 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
1881 push @template, $line;
1887 warn "$_\n" foreach @template;
1899 my $conf = $self->conf;
1901 #check for an invoice-specific override
1902 return $self->invoice_terms if $self->invoice_terms;
1904 #check for a customer- specific override
1905 my $cust_main = $self->cust_main;
1906 return $cust_main->invoice_terms if $cust_main && $cust_main->invoice_terms;
1910 $agentnum = $cust_main->agentnum;
1911 } elsif ( my $prospect_main = $self->prospect_main ) {
1912 $agentnum = $prospect_main->agentnum;
1915 #use configured default
1916 $conf->config('invoice_default_terms', $agentnum) || '';
1926 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1927 $duedate = $self->_date() + ( $1 * 86400 );
1928 } elsif ( $self->terms =~ /^End of Month$/ ) {
1929 my ($mon,$year) = (localtime($self->_date) )[4,5];
1931 until ( $mon < 12 ) { $mon -= 12; $year++; }
1932 my $nextmonth_first = timelocal(0,0,0,1,$mon,$year);
1933 $duedate = $nextmonth_first - 86400;
1944 $self->due_date ? $self->time2str_local(shift, $self->due_date) : '';
1947 =item balance_due_msg
1951 sub balance_due_msg {
1953 my $msg = $self->mt('Balance Due');
1954 return $msg unless $self->terms; # huh?
1955 if ( !$self->conf->exists('invoice_show_prior_due_date')
1956 or $self->conf->exists('invoice_sections') ) {
1957 # if enabled, the due date is shown with Total New Charges (see
1958 # _items_total) and not here
1959 # (yes, or if invoice_sections is enabled; this is just for compatibility)
1960 if ( $self->due_date ) {
1961 $msg .= ' - ' . $self->mt('Please pay by'). ' '.
1962 $self->due_date2str('short')
1963 unless $self->conf->config_bool('invoice_omit_due_date',$self->agentnum);
1964 } elsif ( $self->terms ) {
1965 $msg .= ' - '. $self->mt($self->terms);
1971 =item balance_due_date
1975 sub balance_due_date {
1977 my $conf = $self->conf;
1979 my $terms = $self->terms;
1980 if ( $terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1981 $duedate = $self->time2str_local('rdate', $self->_date + ($1*86400) );
1986 sub credit_balance_msg {
1988 $self->mt('Credit Balance Remaining')
1993 Returns a string with the date, for example: "3/20/2008", localized for the
1994 customer. Use _date_pretty_unlocalized for non-end-customer display use.
2000 $self->time2str_local('short', $self->_date);
2003 =item _date_pretty_unlocalized
2005 Returns a string with the date, for example: "3/20/2008", in the format
2006 configured for the back-office. Use _date_pretty for end-customer display use.
2010 sub _date_pretty_unlocalized {
2012 time2str($date_format, $self->_date);
2017 Emails this template.
2019 Options are passed as a hashref. Available options:
2025 If specified, overrides the default From: address.
2029 If specified, overrides the name of the sent document ("Invoice" or "Quotation")
2033 (Deprecated) If specified, is the name of a suffix for alternate template files.
2037 Options accepted by generate_email can also be used.
2043 my $opt = shift || {};
2044 if ($opt and !ref($opt)) {
2045 die ref($self). '->email called with positional parameters';
2048 return if $self->hide;
2050 my $error = send_email(
2051 $self->generate_email(
2052 'subject' => $self->email_subject($opt->{template}),
2053 %$opt, # template, etc.
2057 die "can't email: $error\n" if $error;
2060 =item generate_email OPTION => VALUE ...
2068 sender address, required
2072 alternate template name, optional
2076 email subject, optional
2080 notice name instead of "Invoice", optional
2084 Returns an argument list to be passed to L<FS::Misc::send_email>.
2090 sub generate_email {
2094 my $conf = $self->conf;
2096 my $me = '[FS::Template_Mixin::generate_email]';
2099 'from' => $args{'from'},
2100 'subject' => ($args{'subject'} || $self->email_subject),
2101 'custnum' => $self->custnum,
2102 'msgtype' => 'invoice',
2105 $args{'unsquelch_cdr'} = $conf->exists('voip-cdr_email');
2107 my $cust_main = $self->cust_main;
2109 if (ref($args{'to'}) eq 'ARRAY') {
2110 $return{'to'} = $args{'to'};
2111 } elsif ( $cust_main ) {
2112 $return{'to'} = [ $cust_main->invoicing_list_emailonly ];
2115 my $tc = $self->template_conf;
2117 my @text; # array of lines
2118 my $html; # a big string
2119 my @related_parts; # will contain the text/HTML alternative, and images
2120 my $related; # will contain the multipart/related object
2122 if ( $conf->exists($tc. 'email_pdf') ) {
2123 if ( my $msgnum = $conf->config($tc.'email_pdf_msgnum') ) {
2125 warn "$me using '${tc}email_pdf_msgnum' in multipart message"
2128 my $msg_template = FS::msg_template->by_key($msgnum)
2129 or die "${tc}email_pdf_msgnum $msgnum not found\n";
2130 my $cust_msg = $msg_template->prepare(
2131 cust_main => $self->cust_main,
2133 msgtype => 'invoice',
2136 # XXX hack to make this work in the new cust_msg era; consider replacing
2137 # with cust_bill_send_with_notice events.
2138 my @parts = $cust_msg->parts;
2139 foreach my $part (@parts) { # will only have two parts, normally
2140 if ( $part->mime_type eq 'text/plain' ) {
2141 @text = @{ $part->body };
2142 } elsif ( $part->mime_type eq 'text/html' ) {
2143 $html = $part->bodyhandle->as_string;
2147 } elsif ( my @note = $conf->config($tc.'email_pdf_note') ) {
2149 warn "$me using '${tc}email_pdf_note' in multipart message"
2151 @text = $conf->config($tc.'email_pdf_note');
2152 $html = join('<BR>', @text);
2154 } # else use the plain text invoice
2159 if ( $conf->config($tc.'template') ) {
2161 warn "$me generating plain text invoice"
2164 # 'print_text' argument is no longer used
2165 @text = $self->print_text(\%args);
2169 warn "$me no plain text version exists; sending empty message body"
2176 my $text_part = build MIME::Entity (
2177 'Type' => 'text/plain',
2178 'Encoding' => 'quoted-printable',
2179 'Charset' => 'UTF-8',
2180 #'Encoding' => '7bit',
2182 'Disposition' => 'inline',
2187 if ( $conf->exists($tc.'html') ) {
2188 warn "$me generating HTML invoice"
2191 $args{'from'} =~ /\@([\w\.\-]+)/;
2192 my $from = $1 || 'example.com';
2193 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2196 my $agentnum = $cust_main ? $cust_main->agentnum
2197 : $self->prospect_main->agentnum;
2198 if ( defined($args{'template'}) && length($args{'template'})
2199 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
2202 $logo = 'logo_'. $args{'template'}. '.png';
2206 my $image_data = $conf->config_binary( $logo, $agentnum);
2208 push @related_parts, build MIME::Entity
2209 'Type' => 'image/png',
2210 'Encoding' => 'base64',
2211 'Data' => $image_data,
2212 'Filename' => 'logo.png',
2213 'Content-ID' => "<$content_id>",
2216 if ( ref($self) eq 'FS::cust_bill' && $conf->exists('invoice-barcode') ) {
2217 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2218 push @related_parts, build MIME::Entity
2219 'Type' => 'image/png',
2220 'Encoding' => 'base64',
2221 'Data' => $self->invoice_barcode(0),
2222 'Filename' => 'barcode.png',
2223 'Content-ID' => "<$barcode_content_id>",
2225 $args{'barcode_cid'} = $barcode_content_id;
2228 $html = $self->print_html({ 'cid'=>$content_id, %args });
2235 warn "$me creating HTML/text multipart message"
2238 $return{'nobody'} = 1;
2240 my $alternative = build MIME::Entity
2241 'Type' => 'multipart/alternative',
2242 #'Encoding' => '7bit',
2243 'Disposition' => 'inline'
2247 $alternative->add_part($text_part);
2250 $alternative->attach(
2251 'Type' => 'text/html',
2252 'Encoding' => 'quoted-printable',
2253 'Data' => [ '<html>',
2256 ' '. encode_entities($return{'subject'}),
2259 ' <body bgcolor="#e8e8e8">',
2264 'Disposition' => 'inline',
2265 #'Filename' => 'invoice.pdf',
2268 unshift @related_parts, $alternative;
2270 $related = build MIME::Entity 'Type' => 'multipart/related',
2271 'Encoding' => '7bit';
2273 #false laziness w/Misc::send_email
2274 $related->head->replace('Content-type',
2275 $related->mime_type.
2276 '; boundary="'. $related->head->multipart_boundary. '"'.
2277 '; type=multipart/alternative'
2280 $related->add_part($_) foreach @related_parts;
2284 my @otherparts = ();
2285 if ( ref($self) eq 'FS::cust_bill' && $cust_main->email_csv_cdr ) {
2287 if ( $conf->config('voip-cdr_email_attach') eq 'zip' ) {
2289 my $data = join('', map "$_\n",
2290 $self->call_details(prepend_billed_number=>1)
2293 my $zip = new Archive::Zip;
2294 my $file = $zip->addString( $data, 'usage-'.$self->invnum.'.csv' );
2295 $file->desiredCompressionMethod( COMPRESSION_DEFLATED );
2298 my $SH = IO::Scalar->new(\$zipdata);
2299 my $status = $zip->writeToFileHandle($SH);
2300 die "Error zipping CDR attachment: $!" unless $status == AZ_OK;
2302 push @otherparts, build MIME::Entity
2303 'Type' => 'application/zip',
2304 'Encoding' => 'base64',
2306 'Disposition' => 'attachment',
2307 'Filename' => 'usage-'. $self->invnum. '.zip',
2310 } else { # } elsif ( $conf->config('voip-cdr_email_attach') eq 'csv' ) {
2312 push @otherparts, build MIME::Entity
2313 'Type' => 'text/csv',
2314 'Encoding' => '7bit',
2315 'Data' => [ map { "$_\n" }
2316 $self->call_details('prepend_billed_number' => 1)
2318 'Disposition' => 'attachment',
2319 'Filename' => 'usage-'. $self->invnum. '.csv',
2326 if ( $conf->exists($tc.'email_pdf') ) {
2331 # multipart/alternative
2337 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%args);
2338 push @otherparts, $pdf;
2342 $return{'content-type'} = 'multipart/mixed'; # of the outer container
2344 $return{'mimeparts'} = [ $related, @otherparts ];
2345 $return{'type'} = 'multipart/related'; # of the first part
2347 $return{'mimeparts'} = [ $text_part, @otherparts ];
2348 $return{'type'} = 'text/plain';
2350 } elsif ( $html ) { # no PDF or CSV, strip the outer container
2351 $return{'mimeparts'} = \@related_parts;
2352 $return{'content-type'} = 'multipart/related';
2353 $return{'type'} = 'multipart/alternative';
2354 } else { # no HTML either
2355 $return{'body'} = \@text;
2356 $return{'content-type'} = 'text/plain';
2365 Returns a list suitable for passing to MIME::Entity->build(), representing
2366 this invoice as PDF attachment.
2373 'Type' => 'application/pdf',
2374 'Encoding' => 'base64',
2375 'Data' => [ $self->print_pdf(@_) ],
2376 'Disposition' => 'attachment',
2377 'Filename' => 'invoice-'. $self->invnum. '.pdf',
2381 =item postal_mail_fsinc
2383 Sends this invoice to the Freeside Internet Services, Inc. print and mail
2389 use IO::Socket::SSL;
2391 use HTTP::Request::Common qw( POST );
2392 use Cpanel::JSON::XS;
2394 sub postal_mail_fsinc {
2395 my ( $self, %opt ) = @_;
2397 my $url = 'https://ws.freeside.biz/print';
2399 my $cust_main = $self->cust_main;
2400 my $agentnum = $cust_main->agentnum;
2401 my $bill_location = $cust_main->bill_location;
2403 die "Extra charges for international mailing; contact support\@freeside.biz to enable\n"
2404 if $bill_location->country ne 'US';
2406 my $conf = new FS::Conf;
2408 my @company_address = $conf->config('company_address', $agentnum);
2409 my ( $company_address1, $company_address2, $company_city, $company_state, $company_zip );
2410 if ( $company_address[2] =~ /^\s*(\S.*\S)\s*[\s,](\w\w),?\s*(\d{5}(-\d{4})?)\s*$/ ) {
2411 $company_address1 = $company_address[0];
2412 $company_address2 = $company_address[1];
2414 $company_state = $2;
2416 } elsif ( $company_address[1] =~ /^\s*(\S.*\S)\s*[\s,](\w\w),?\s*(\d{5}(-\d{4})?)\s*$/ ) {
2417 $company_address1 = $company_address[0];
2418 $company_address2 = '';
2420 $company_state = $2;
2423 die "Unparsable company_address; contact support\@freeside.biz\n";
2425 $company_city =~ s/,$//;
2427 my $file = $self->print_pdf(%opt, 'no_addresses' => 1);
2428 my $pages = CAM::PDF->new($file)->numPages;
2430 my $ua = LWP::UserAgent->new(
2432 verify_hostname => 0,
2433 SSL_verify_mode => IO::Socket::SSL::SSL_VERIFY_NONE,
2436 my $response = $ua->request( POST $url, [
2437 'support-key' => scalar($conf->config('support-key')),
2438 'file' => encode_base64($file),
2442 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
2443 'company_address1' => $company_address1,
2444 'company_address2' => $company_address2,
2445 'company_city' => $company_city,
2446 'company_state' => $company_state,
2447 'company_zip' => $company_zip,
2448 'company_country' => 'US',
2449 'company_phonenum' => scalar($conf->config('company_phonenum', $agentnum)),
2450 'company_email' => scalar($conf->config('invoice_from', $agentnum)),
2453 'name' => $cust_main->invoice_attn
2454 || $cust_main->contact_firstlast,
2455 'company' => $cust_main->company,
2456 'address1' => $bill_location->address1,
2457 'address2' => $bill_location->address2,
2458 'city' => $bill_location->city,
2459 'state' => $bill_location->state,
2460 'zip' => $bill_location->zip,
2461 'country' => $bill_location->country,
2464 die "Print connection error: ". $response->message. "\n"
2465 unless $response->is_success;
2468 my $content = eval { decode_json($response->content) };
2469 die "Print JSON error : $@\n" if $@;
2471 die $content->{error}."\n"
2472 if $content->{error};
2474 #TODO: store this so we can query for a status later
2475 warn "Invoice printed, ID ". $content->{id}. "\n";
2481 =item _items_sections OPTIONS
2483 Generate section information for all items appearing on this invoice.
2484 This will only be called for multi-section invoices.
2486 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
2487 related display records (L<FS::cust_bill_pkg_display>) and organize
2488 them into two groups ("early" and "late" according to whether they come
2489 before or after the total), then into sections. A subtotal is calculated
2492 Section descriptions are returned in sort weight order. Each consists
2493 of a hash containing:
2495 description: the package category name, escaped
2496 subtotal: the total charges in that section
2497 tax_section: a flag indicating that the section contains only tax charges
2498 summarized: same as tax_section, for some reason
2499 sort_weight: the package category's sort weight
2501 If 'condense' is set on the display record, it also contains everything
2502 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
2503 coderefs to generate parts of the invoice. This is not advised.
2505 The method returns two arrayrefs, one of "early" sections and one of "late"
2508 OPTIONS may include:
2510 by_location: a flag to divide the invoice into sections by location.
2511 Each section hash will have a 'location' element containing a hashref of
2512 the location fields (see L<FS::cust_location>). The section description
2513 will be the location label, but the template can use any of the location
2514 fields to create a suitable label.
2516 by_category: a flag to divide the invoice into sections using display
2517 records (see L<FS::cust_bill_pkg_display>). This is the "traditional"
2518 behavior. Each section hash will have a 'category' element containing
2519 the section name from the display record (which probably equals the
2520 category name of the package, but may not in some cases).
2522 summary: a flag indicating that this is a summary-format invoice.
2523 Turning this on has the following effects:
2524 - Ignores display items with the 'summary' flag.
2525 - Places all sections in the "early" group even if they have post_total.
2526 - Creates sections for all non-disabled package categories, even if they
2527 have no charges on this invoice, as well as a section with no name.
2529 escape: an escape function to use for section titles.
2531 extra_sections: an arrayref of additional sections to return after the
2532 sorted list. If there are any of these, section subtotals exclude
2535 format: 'latex', 'html', or 'template' (i.e. text). Not used, but
2536 passed through to C<_condense_section()>.
2540 use vars qw(%pkg_category_cache);
2541 sub _items_sections {
2545 my $escape = $opt{escape};
2546 my @extra_sections = @{ $opt{extra_sections} || [] };
2548 # $subtotal{$locationnum}{$categoryname} = amount.
2549 # if we're not using by_location, $locationnum is undef.
2550 # if we're not using by_category, you guessed it, $categoryname is undef.
2551 # if we're not using either one, we shouldn't be here in the first place...
2553 my %late_subtotal = ();
2556 # About tax items + multisection invoices:
2557 # If either invoice_*summary option is enabled, AND there is a
2558 # package category with the name of the tax, then there will be
2559 # a display record assigning the tax item to that category.
2561 # However, the taxes are always placed in the "Taxes, Surcharges,
2562 # and Fees" section regardless of that. The only effect of the
2563 # display record is to create a subtotal for the summary page.
2566 my $pkg_hash = $self->cust_pkg_hash;
2568 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2571 my $usage = $cust_bill_pkg->usage;
2574 if ( $opt{by_location} ) {
2575 if ( $cust_bill_pkg->pkgnum ) {
2576 $locationnum = $pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum;
2581 $locationnum = undef;
2584 # as in _items_cust_pkg, if a line item has no display records,
2585 # cust_bill_pkg_display() returns a default record for it
2587 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
2588 next if ( $display->summary && $opt{summary} );
2590 my $section = $display->section;
2591 my $type = $display->type;
2592 # Set $section = undef if we're sectioning by location and this
2593 # line item _has_ a location (i.e. isn't a fee).
2594 $section = undef if $locationnum;
2596 # set this flag if the section is not tax-only
2597 $not_tax{$locationnum}{$section} = 1
2598 if $cust_bill_pkg->pkgnum or $cust_bill_pkg->feepart;
2600 # there's actually a very important piece of logic buried in here:
2601 # incrementing $late_subtotal{$section} CREATES
2602 # $late_subtotal{$section}. keys(%late_subtotal) is later used
2603 # to define the list of late sections, and likewise keys(%subtotal).
2604 # When _items_cust_bill_pkg is called to generate line items for
2605 # real, it will be called with 'section' => $section for each
2607 if ( $display->post_total && !$opt{summary} ) {
2608 if (! $type || $type eq 'S') {
2609 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2610 if $cust_bill_pkg->setup != 0
2611 || $cust_bill_pkg->setup_show_zero;
2615 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur
2616 if $cust_bill_pkg->recur != 0
2617 || $cust_bill_pkg->recur_show_zero;
2620 if ($type && $type eq 'R') {
2621 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2622 if $cust_bill_pkg->recur != 0
2623 || $cust_bill_pkg->recur_show_zero;
2626 if ($type && $type eq 'U') {
2627 $late_subtotal{$locationnum}{$section} += $usage
2628 unless scalar(@extra_sections);
2631 } else { # it's a pre-total (normal) section
2633 # skip tax items unless they're explicitly included in a section
2634 next if $cust_bill_pkg->pkgnum == 0 and
2635 ! $cust_bill_pkg->feepart and
2638 if ( $type eq 'S' ) {
2639 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2640 if $cust_bill_pkg->setup != 0
2641 || $cust_bill_pkg->setup_show_zero;
2642 } elsif ( $type eq 'R' ) {
2643 $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2644 if $cust_bill_pkg->recur != 0
2645 || $cust_bill_pkg->recur_show_zero;
2646 } elsif ( $type eq 'U' ) {
2647 $subtotal{$locationnum}{$section} += $usage
2648 unless scalar(@extra_sections);
2649 } elsif ( !$type ) {
2650 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2651 + $cust_bill_pkg->recur;
2660 %pkg_category_cache = ();
2662 # summary invoices need subtotals for all non-disabled package categories,
2663 # even if they're zero
2664 # but currently assume that there are no location sections, or at least
2665 # that the summary page doesn't care about them
2666 if ( $opt{summary} ) {
2667 foreach my $category (qsearch('pkg_category', {disabled => ''})) {
2668 $subtotal{''}{$category->categoryname} ||= 0;
2670 $subtotal{''}{''} ||= 0;
2674 foreach my $post_total (0,1) {
2676 my $s = $post_total ? \%late_subtotal : \%subtotal;
2677 foreach my $locationnum (keys %$s) {
2678 foreach my $sectionname (keys %{ $s->{$locationnum} }) {
2680 'subtotal' => $s->{$locationnum}{$sectionname},
2683 if ( $locationnum ) {
2684 $section->{'locationnum'} = $locationnum;
2685 my $location = FS::cust_location->by_key($locationnum);
2686 $section->{'description'} = &{ $escape }($location->location_label);
2687 # Better ideas? This will roughly group them by proximity,
2688 # which alpha sorting on any of the address fields won't.
2689 # Sorting by locationnum is meaningless.
2690 # We have to sort on _something_ or the order may change
2691 # randomly from one invoice to the next, which will confuse
2693 $section->{'sort_weight'} = sprintf('%012s',$location->zip) .
2695 $section->{'location'} = {
2696 label_prefix => &{ $escape }($location->label_prefix),
2697 map { $_ => &{ $escape }($location->get($_)) }
2701 $section->{'category'} = $sectionname;
2702 $section->{'description'} = &{ $escape }($sectionname);
2703 if ( _pkg_category($sectionname) ) {
2704 $section->{'sort_weight'} = _pkg_category($sectionname)->weight;
2705 if ( _pkg_category($sectionname)->condense ) {
2706 $section = { %$section, $self->_condense_section($opt{format}) };
2710 if ( !$post_total and !$not_tax{$locationnum}{$sectionname} ) {
2711 # then it's a tax-only section
2712 $section->{'summarized'} = 'Y';
2713 $section->{'tax_section'} = 'Y';
2715 push @these, $section;
2716 } # foreach $sectionname
2717 } #foreach $locationnum
2718 push @these, @extra_sections if $post_total == 0;
2719 # need an alpha sort for location sections, because postal codes can
2721 $sections[ $post_total ] = [ sort {
2722 $opt{'by_location'} ?
2723 ($a->{sort_weight} cmp $b->{sort_weight}) :
2724 ($a->{sort_weight} <=> $b->{sort_weight})
2726 } #foreach $post_total
2728 return @sections; # early, late
2731 #helper subs for above
2735 $self->{cust_pkg} ||= { map { $_->pkgnum => $_ } $self->cust_pkg };
2739 my $categoryname = shift;
2740 $pkg_category_cache{$categoryname} ||=
2741 qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
2744 my %condensed_format = (
2745 'label' => [ qw( Description Qty Amount ) ],
2747 sub { shift->{description} },
2748 sub { shift->{quantity} },
2749 sub { my($href, %opt) = @_;
2750 ($opt{dollar} || ''). $href->{amount};
2753 'align' => [ qw( l r r ) ],
2754 'span' => [ qw( 5 1 1 ) ], # unitprices?
2755 'width' => [ qw( 10.7cm 1.4cm 1.6cm ) ], # don't like this
2758 sub _condense_section {
2759 my ( $self, $format ) = ( shift, shift );
2761 map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
2762 qw( description_generator
2765 total_line_generator
2770 sub _condensed_generator_defaults {
2771 my ( $self, $format ) = ( shift, shift );
2772 return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
2781 sub _condensed_header_generator {
2782 my ( $self, $format ) = ( shift, shift );
2784 my ( $f, $prefix, $suffix, $separator, $column ) =
2785 _condensed_generator_defaults($format);
2787 if ($format eq 'latex') {
2788 $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
2789 $suffix = "\\\\\n\\hline";
2792 sub { my ($d,$a,$s,$w) = @_;
2793 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2795 } elsif ( $format eq 'html' ) {
2796 $prefix = '<th></th>';
2800 sub { my ($d,$a,$s,$w) = @_;
2801 return qq!<th align="$html_align{$a}">$d</th>!;
2809 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2811 &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
2814 $prefix. join($separator, @result). $suffix;
2819 sub _condensed_description_generator {
2820 my ( $self, $format ) = ( shift, shift );
2822 my ( $f, $prefix, $suffix, $separator, $column ) =
2823 _condensed_generator_defaults($format);
2825 my $money_char = '$';
2826 if ($format eq 'latex') {
2827 $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
2829 $separator = " & \n";
2831 sub { my ($d,$a,$s,$w) = @_;
2832 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2834 $money_char = '\\dollar';
2835 }elsif ( $format eq 'html' ) {
2836 $prefix = '"><td align="center"></td>';
2840 sub { my ($d,$a,$s,$w) = @_;
2841 return qq!<td align="$html_align{$a}">$d</td>!;
2843 #$money_char = $conf->config('money_char') || '$';
2844 $money_char = ''; # this is madness
2852 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2854 $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
2856 &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
2857 map { $f->{$_}->[$i] } qw(align span width)
2861 $prefix. join( $separator, @result ). $suffix;
2866 sub _condensed_total_generator {
2867 my ( $self, $format ) = ( shift, shift );
2869 my ( $f, $prefix, $suffix, $separator, $column ) =
2870 _condensed_generator_defaults($format);
2873 if ($format eq 'latex') {
2876 $separator = " & \n";
2878 sub { my ($d,$a,$s,$w) = @_;
2879 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2881 }elsif ( $format eq 'html' ) {
2885 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2887 sub { my ($d,$a,$s,$w) = @_;
2888 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2897 # my $r = &{$f->{fields}->[$i]}(@args);
2898 # $r .= ' Total' unless $i;
2900 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2902 &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
2903 map { $f->{$_}->[$i] } qw(align span width)
2907 $prefix. join( $separator, @result ). $suffix;
2912 =item total_line_generator FORMAT
2914 Returns a coderef used for generation of invoice total line items for this
2915 usage_class. FORMAT is either html or latex
2919 # should not be used: will have issues with hash element names (description vs
2920 # total_item and amount vs total_amount -- another array of functions?
2922 sub _condensed_total_line_generator {
2923 my ( $self, $format ) = ( shift, shift );
2925 my ( $f, $prefix, $suffix, $separator, $column ) =
2926 _condensed_generator_defaults($format);
2929 if ($format eq 'latex') {
2932 $separator = " & \n";
2934 sub { my ($d,$a,$s,$w) = @_;
2935 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2937 }elsif ( $format eq 'html' ) {
2941 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2943 sub { my ($d,$a,$s,$w) = @_;
2944 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2953 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2955 &{$column}( &{$f->{fields}->[$i]}(@args),
2956 map { $f->{$_}->[$i] } qw(align span width)
2960 $prefix. join( $separator, @result ). $suffix;
2965 =item _items_pkg [ OPTIONS ]
2967 Return line item hashes for each package item on this invoice. Nearly
2970 $self->_items_cust_bill_pkg([ $self->cust_bill_pkg ])
2972 OPTIONS are passed through to _items_cust_bill_pkg, and should include
2973 'format' and 'escape_function' at minimum.
2975 To produce items for a specific invoice section, OPTIONS should include
2976 'section', a hashref containing 'category' and/or 'locationnum' keys.
2978 'section' may also contain a key named 'condensed'. If this is present
2979 and has a true value, _items_pkg will try to merge identical items into items
2980 with 'quantity' equal to the number of items (not the sum of their separate
2981 quantities, for some reason).
2987 # The order of these is important. Bundled line items will be merged into
2988 # the most recent non-hidden item, so it needs to be the one with:
2990 # - the same start date
2991 # - no pkgpart_override
2993 # So: sort by pkgnum,
2995 # then sort the base line item before any overrides
2996 # then sort hidden before non-hidden add-ons
2997 # then sort by override pkgpart (for consistency)
2998 sort { $a->pkgnum <=> $b->pkgnum or
2999 $a->sdate <=> $b->sdate or
3000 ($a->pkgpart_override ? 0 : -1) or
3001 ($b->pkgpart_override ? 0 : 1) or
3002 $b->hidden cmp $a->hidden or
3003 $a->pkgpart_override <=> $b->pkgpart_override
3005 # and of course exclude taxes and fees
3006 grep { $_->pkgnum > 0 } $self->cust_bill_pkg;
3012 my @cust_bill_pkg = grep { $_->feepart } $self->cust_bill_pkg;
3013 my $escape_function = $options{escape_function};
3016 foreach my $cust_bill_pkg (@cust_bill_pkg) {
3017 # cache this, so we don't look it up again in every section
3018 my $part_fee = $cust_bill_pkg->get('part_fee')
3019 || $cust_bill_pkg->part_fee;
3020 $cust_bill_pkg->set('part_fee', $part_fee);
3022 #die "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n"; # might make more sense
3023 warn "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n";
3026 if ( exists($options{section}) and exists($options{section}{category}) )
3028 my $categoryname = $options{section}{category};
3029 # then filter for items that have that section
3030 if ( $part_fee->categoryname ne $categoryname ) {
3031 warn "skipping fee '".$part_fee->itemdesc."'--not in section $categoryname\n" if $DEBUG;
3034 } # otherwise include them all in the main section
3035 # XXX what to do when sectioning by location?
3038 my %base_invnums; # invnum => invoice date
3039 foreach ($cust_bill_pkg->cust_bill_pkg_fee) {
3040 if ($_->base_invnum) {
3041 my $base_bill = FS::cust_bill->by_key($_->base_invnum);
3042 my $base_date = $self->time2str_local('short', $base_bill->_date)
3044 $base_invnums{$_->base_invnum} = $base_date || '';
3047 foreach (sort keys(%base_invnums)) {
3048 next if $_ == $self->invnum;
3049 # per convention, we must escape ext_description lines
3051 &{$escape_function}(
3052 $self->mt('from invoice #[_1] on [_2]', $_, $base_invnums{$_})
3055 my $desc = $part_fee->itemdesc_locale($self->cust_main->locale);
3056 # but not escape the base description line
3059 { feepart => $cust_bill_pkg->feepart,
3060 amount => sprintf('%.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
3061 description => $desc,
3062 ext_description => \@ext_desc
3073 warn "$me _items_pkg searching for all package line items\n"
3076 my @cust_bill_pkg = $self->_items_nontax;
3078 warn "$me _items_pkg filtering line items\n"
3080 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3082 if ($options{section} && $options{section}->{condensed}) {
3084 warn "$me _items_pkg condensing section\n"
3088 local $Storable::canonical = 1;
3089 foreach ( @items ) {
3091 delete $item->{ref};
3092 delete $item->{ext_description};
3093 my $key = freeze($item);
3094 $itemshash{$key} ||= 0;
3095 $itemshash{$key} ++; # += $item->{quantity};
3097 @items = sort { $a->{description} cmp $b->{description} }
3098 map { my $i = thaw($_);
3099 $i->{quantity} = $itemshash{$_};
3101 sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
3107 warn "$me _items_pkg returning ". scalar(@items). " items\n"
3114 return 0 unless $a->itemdesc cmp $b->itemdesc;
3115 return -1 if $b->itemdesc eq 'Tax';
3116 return 1 if $a->itemdesc eq 'Tax';
3117 return -1 if $b->itemdesc eq 'Other surcharges';
3118 return 1 if $a->itemdesc eq 'Other surcharges';
3119 $a->itemdesc cmp $b->itemdesc;
3124 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum and ! $_->feepart }
3125 $self->cust_bill_pkg;
3126 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3128 if ( $self->conf->exists('always_show_tax') ) {
3129 my $itemdesc = $self->conf->config('always_show_tax') || 'Tax';
3130 if (0 == grep { $_->{description} eq $itemdesc } @items) {
3132 { 'description' => $itemdesc,
3139 =item _items_cust_bill_pkg CUST_BILL_PKGS OPTIONS
3141 Takes an arrayref of L<FS::cust_bill_pkg> objects, and returns a
3142 list of hashrefs describing the line items they generate on the invoice.
3144 OPTIONS may include:
3146 format: the invoice format.
3148 escape_function: the function used to escape strings.
3150 DEPRECATED? (expensive, mostly unused?)
3151 format_function: the function used to format CDRs.
3153 section: a hashref containing 'category' and/or 'locationnum'; if this
3154 is present, only returns line items that belong to that category and/or
3155 location (whichever is defined).
3157 multisection: a flag indicating that this is a multisection invoice,
3158 which does something complicated.
3160 Returns a list of hashrefs, each of which may contain:
3162 pkgnum, description, amount, unit_amount, quantity, pkgpart, _is_setup, and
3163 ext_description, which is an arrayref of detail lines to show below
3168 sub _items_cust_bill_pkg {
3170 my $conf = $self->conf;
3171 my $cust_bill_pkgs = shift;
3174 my $format = $opt{format} || '';
3175 my $escape_function = $opt{escape_function} || sub { shift };
3176 my $format_function = $opt{format_function} || '';
3177 my $no_usage = $opt{no_usage} || '';
3178 my $unsquelched = $opt{unsquelched} || ''; #unused
3179 my ($section, $locationnum, $category);
3180 if ( $opt{section} ) {
3181 $category = $opt{section}->{category};
3182 $locationnum = $opt{section}->{locationnum};
3184 my $summary_page = $opt{summary_page} || ''; #unused
3185 my $multisection = defined($category) || defined($locationnum);
3186 # this variable is the value of the config setting, not whether it applies
3187 # to this particular line item.
3188 my $discount_show_always = $conf->exists('discount-show-always');
3190 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 40;
3192 my $cust_main = $self->cust_main;#for per-agent cust_bill-line_item-ate_style
3194 # for location labels: use default location on the invoice date
3195 my $default_locationnum;
3196 if ( $conf->exists('invoice-all_pkg_addresses') ) {
3197 $default_locationnum = 0; # treat them all as non-default
3198 } elsif ( $self->custnum ) {
3200 my @h_search = FS::h_cust_main->sql_h_search($self->_date);
3201 $h_cust_main = qsearchs({
3202 'table' => 'h_cust_main',
3203 'hashref' => { custnum => $self->custnum },
3204 'extra_sql' => $h_search[1],
3205 'addl_from' => $h_search[3],
3207 $default_locationnum = $h_cust_main->ship_locationnum;
3208 } elsif ( $self->prospectnum ) {
3209 my $cust_location = qsearchs('cust_location',
3210 { prospectnum => $self->prospectnum,
3212 $default_locationnum = $cust_location->locationnum if $cust_location;
3215 my @b = (); # accumulator for the line item hashes that we'll return
3216 my ($s, $r, $u, $d) = ( undef, undef, undef, undef );
3217 # the 'current' line item hashes for setup, recur, usage, discount
3218 foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
3220 # if the current line item is waiting to go out, and the one we're about
3221 # to start is not bundled, then push out the current one and start a new
3224 $d->{amount} = $d->{setup_amount} + $d->{recur_amount};
3226 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3227 if ( $_ && !$cust_bill_pkg->hidden ) {
3228 $_->{amount} = sprintf( "%.2f", $_->{amount} );
3229 $_->{amount} =~ s/^\-0\.00$/0.00/;
3230 if (exists($_->{unit_amount})) {
3231 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3234 # we already decided to create this display line; don't reconsider it
3236 # if $_->{amount} != 0
3237 # || $discount_show_always
3238 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3239 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3245 if ( $locationnum ) {
3246 # this is a location section; skip packages that aren't at this
3248 next if $cust_bill_pkg->pkgnum == 0; # skips fees...
3249 next if $self->cust_pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum
3253 # Consider display records for this item to determine if it belongs
3254 # in this section. Note that if there are no display records, there
3255 # will be a default pseudo-record that includes all charge types
3256 # and has no section name.
3257 my @cust_bill_pkg_display = $cust_bill_pkg->can('cust_bill_pkg_display')
3258 ? $cust_bill_pkg->cust_bill_pkg_display
3259 : ( $cust_bill_pkg );
3261 warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
3262 $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
3265 if ( defined($category) ) {
3266 # then this is a package category section; process all display records
3267 # that belong to this section.
3268 @cust_bill_pkg_display = grep { $_->section eq $category }
3269 @cust_bill_pkg_display;
3271 # otherwise, process all display records that aren't usage summaries
3272 # (I don't think there should be usage summaries if you aren't using
3273 # category sections, but this is the historical behavior)
3274 @cust_bill_pkg_display = grep { !$_->summary }
3275 @cust_bill_pkg_display;
3278 my $classname = ''; # package class name, will fill in later
3280 foreach my $display (@cust_bill_pkg_display) {
3282 warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
3283 $display->billpkgdisplaynum. "\n"
3286 my $type = $display->type;
3288 my $desc = $cust_bill_pkg->desc( $cust_main ? $cust_main->locale : '' );
3289 $desc = substr($desc, 0, $maxlength). '...'
3290 if $format eq 'latex' && length($desc) > $maxlength;
3292 my %details_opt = ( 'format' => $format,
3293 'escape_function' => $escape_function,
3294 'format_function' => $format_function,
3295 'no_usage' => $opt{'no_usage'},
3298 if ( $cust_bill_pkg->pkgnum > 0 ) {
3299 # a "normal" package line item (not a quotation, not a fee, not a tax)
3301 warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
3304 my $cust_pkg = $cust_bill_pkg->cust_pkg;
3305 my $part_pkg = $cust_pkg->part_pkg;
3307 # which pkgpart to show for display purposes?
3308 my $pkgpart = $cust_bill_pkg->pkgpart_override || $cust_pkg->pkgpart;
3310 # start/end dates for invoice formats that do nonstandard
3312 my %item_dates = ();
3313 %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate')
3314 unless $part_pkg->option('disable_line_item_date_ranges',1);
3316 # not normally used, but pass this to the template anyway
3317 $classname = $part_pkg->classname;
3319 if ( (!$type || $type eq 'S')
3320 && ( $cust_bill_pkg->setup != 0
3321 || $cust_bill_pkg->setup_show_zero
3322 || ($discount_show_always and $cust_bill_pkg->unitsetup > 0)
3327 warn "$me _items_cust_bill_pkg adding setup\n"
3330 # append the word 'Setup' to the setup line if there's going to be
3331 # a recur line for the same package (i.e. not a one-time charge)
3333 my $description = $desc;
3334 $description .= ' Setup'
3335 if $cust_bill_pkg->recur != 0
3336 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3337 || $cust_bill_pkg->recur_show_zero;
3339 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3341 if $part_pkg->is_prepaid #for prepaid, "display the validity period
3342 # triggered by the recurring charge freq
3344 && $cust_bill_pkg->recur == 0
3345 && ! $cust_bill_pkg->recur_show_zero;
3350 # always pass the svc_label through to the template, even if
3351 # not displaying it as an ext_description
3352 my @svc_labels = map &{$escape_function}($_),
3353 $cust_pkg->h_labels_short($self->_date,
3356 $self->conf->{locale},
3358 $svc_label = $svc_labels[0];
3360 unless ( $cust_pkg->part_pkg->hide_svc_detail
3361 || $cust_bill_pkg->hidden )
3364 push @d, @svc_labels
3365 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3366 # show the location label if it's not the customer's default
3367 # location, and we're not grouping items by location already
3368 if ( $cust_pkg->locationnum != $default_locationnum
3369 and !defined($locationnum) ) {
3370 my $loc = $cust_pkg->location_label;
3371 $loc = substr($loc, 0, $maxlength). '...'
3372 if $format eq 'latex' && length($loc) > $maxlength;
3373 push @d, &{$escape_function}($loc);
3376 } #unless hiding service details
3378 push @d, $cust_bill_pkg->details(%details_opt)
3379 if $cust_bill_pkg->recur == 0;
3381 if ( $cust_bill_pkg->hidden ) {
3382 $s->{amount} += $cust_bill_pkg->setup;
3383 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
3384 push @{ $s->{ext_description} }, @d;
3388 description => $description,
3389 pkgpart => $pkgpart,
3390 pkgnum => $cust_bill_pkg->pkgnum,
3391 amount => $cust_bill_pkg->setup,
3392 setup_show_zero => $cust_bill_pkg->setup_show_zero,
3393 unit_amount => $cust_bill_pkg->unitsetup,
3394 quantity => $cust_bill_pkg->quantity,
3395 ext_description => \@d,
3396 svc_label => ($svc_label || ''),
3397 locationnum => $cust_pkg->locationnum, # sure, why not?
3403 # should we show a recur line?
3404 # if type eq 'S', then NO, because we've been told not to.
3405 # otherwise, show the recur line if:
3406 # - there's a recurring charge
3407 # - or recur_show_zero is on
3408 # - or there's a positive unitrecur (so it's been discounted to zero)
3409 # and discount-show-always is on
3410 if ( ( !$type || $type eq 'R' || $type eq 'U' )
3412 $cust_bill_pkg->recur != 0
3414 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3415 || $cust_bill_pkg->recur_show_zero
3420 warn "$me _items_cust_bill_pkg adding recur/usage\n"
3423 my $is_summary = $display->summary;
3424 my $description = $desc;
3425 if ( $type eq 'U' and defined($r) ) {
3426 # don't just show the same description as the recur line
3427 $description = $self->mt('Usage charges');
3430 my $part_pkg = $cust_pkg->part_pkg;
3432 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3436 my @seconds = (); # for display of usage info
3439 #at least until cust_bill_pkg has "past" ranges in addition to
3440 #the "future" sdate/edate ones... see #3032
3441 my @dates = ( $self->_date );
3442 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
3443 push @dates, $prev->sdate if $prev;
3444 push @dates, undef if !$prev;
3446 my @svc_labels = map &{$escape_function}($_),
3447 $cust_pkg->h_labels_short(@dates,
3449 $self->conf->{locale});
3450 $svc_label = $svc_labels[0];
3452 # show service labels, unless...
3453 # the package is set not to display them
3454 unless ( $part_pkg->hide_svc_detail
3455 # or this is a tax-like line item
3456 || $cust_bill_pkg->itemdesc
3457 # or this is a hidden (bundled) line item
3458 || $cust_bill_pkg->hidden
3459 # or this is a usage summary line
3460 || $is_summary && $type && $type eq 'U'
3461 # or this is a usage line and there's a recurring line
3462 # for the package in the same section (which will
3463 # have service labels already)
3464 || ($type eq 'U' and defined($r))
3468 warn "$me _items_cust_bill_pkg adding service details\n"
3471 push @d, @svc_labels
3472 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3473 warn "$me _items_cust_bill_pkg done adding service details\n"
3476 # show the location label if it's not the customer's default
3477 # location, and we're not grouping items by location already
3478 if ( $cust_pkg->locationnum != $default_locationnum
3479 and !defined($locationnum) ) {
3480 my $loc = $cust_pkg->location_label;
3481 $loc = substr($loc, 0, $maxlength). '...'
3482 if $format eq 'latex' && length($loc) > $maxlength;
3483 push @d, &{$escape_function}($loc);
3486 # Display of seconds_since_sqlradacct:
3487 # On the invoice, when processing @detail_items, look for a field
3488 # named 'seconds'. This will contain total seconds for each
3489 # service, in the same order as @ext_description. For services
3490 # that don't support this it will show undef.
3491 if ( $conf->exists('svc_acct-usage_seconds')
3492 and ! $cust_bill_pkg->pkgpart_override ) {
3493 foreach my $cust_svc (
3494 $cust_pkg->h_cust_svc(@dates, 'I')
3497 # eval because not having any part_export_usage exports
3498 # is a fatal error, last_bill/_date because that's how
3499 # sqlradius_hour billing does it
3501 $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
3503 push @seconds, $sec;
3505 } #if svc_acct-usage_seconds
3507 } # if we are showing service labels
3509 unless ( $is_summary ) {
3510 warn "$me _items_cust_bill_pkg adding details\n"
3513 #instead of omitting details entirely in this case (unwanted side
3514 # effects), just omit CDRs
3515 $details_opt{'no_usage'} = 1
3516 if $type && $type eq 'R';
3518 push @d, $cust_bill_pkg->details(%details_opt);
3521 warn "$me _items_cust_bill_pkg calculating amount\n"
3526 $amount = $cust_bill_pkg->recur;
3527 } elsif ($type eq 'R') {
3528 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
3529 } elsif ($type eq 'U') {
3530 $amount = $cust_bill_pkg->usage;
3533 if ( !$type || $type eq 'R' ) {
3535 warn "$me _items_cust_bill_pkg adding recur\n"
3539 ( $cust_bill_pkg->unitrecur > 0 ) ? $cust_bill_pkg->unitrecur
3542 if ( $cust_bill_pkg->hidden ) {
3543 $r->{amount} += $amount;
3544 $r->{unit_amount} += $unit_amount;
3545 push @{ $r->{ext_description} }, @d;
3548 description => $description,
3549 pkgpart => $pkgpart,
3550 pkgnum => $cust_bill_pkg->pkgnum,
3552 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3553 unit_amount => $unit_amount,
3554 quantity => $cust_bill_pkg->quantity,
3556 ext_description => \@d,
3557 svc_label => ($svc_label || ''),
3558 locationnum => $cust_pkg->locationnum,
3560 $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
3563 } else { # $type eq 'U'
3565 warn "$me _items_cust_bill_pkg adding usage\n"
3568 if ( $cust_bill_pkg->hidden and defined($u) ) {
3569 # if this is a hidden package and there's already a usage
3570 # line for the bundle, add this package's total amount and
3571 # usage details to it
3572 $u->{amount} += $amount;
3573 push @{ $u->{ext_description} }, @d;
3574 } elsif ( $amount ) {
3575 # create a new usage line
3577 description => $description,
3578 pkgpart => $pkgpart,
3579 pkgnum => $cust_bill_pkg->pkgnum,
3582 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3584 ext_description => \@d,
3585 locationnum => $cust_pkg->locationnum,
3587 } # else this has no usage, so don't create a usage section
3590 } # recurring or usage with recurring charge
3592 } else { # taxes and fees
3594 warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
3597 # items of this kind should normally not have sdate/edate.
3599 'description' => $desc,
3600 'amount' => sprintf('%.2f', $cust_bill_pkg->setup
3601 + $cust_bill_pkg->recur)
3604 } # if package line item / other line item
3606 # decide whether to show active discounts here
3608 # case 1: we are showing a single line for the package
3610 # case 2: we are showing a setup line for a package that has
3611 # no base recurring fee
3612 or ( $type eq 'S' and $cust_bill_pkg->unitrecur == 0 )
3613 # case 3: we are showing a recur line for a package that has
3614 # a base recurring fee
3615 or ( $type eq 'R' and $cust_bill_pkg->unitrecur > 0 )
3618 my $item_discount = $cust_bill_pkg->_item_discount;
3619 if ( $item_discount ) {
3620 # $item_discount->{amount} is negative
3622 if ( $d and $cust_bill_pkg->hidden ) {
3623 $d->{setup_amount} += $item_discount->{setup_amount};
3624 $d->{recur_amount} += $item_discount->{recur_amount};
3626 $d = $item_discount;
3627 $_ = &{$escape_function}($_) foreach @{ $d->{ext_description} };
3630 # update the active line (before the discount) to show the
3631 # original price (whether this is a hidden line or not)
3633 $s->{amount} -= $item_discount->{setup_amount} if $s;
3634 $r->{amount} -= $item_discount->{recur_amount} if $r;
3636 } # if there are any discounts
3637 } # if this is an appropriate place to show discounts
3639 } # foreach $display
3643 # discount amount is internally split up
3645 $d->{amount} = $d->{setup_amount} + $d->{recur_amount};
3648 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3650 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
3651 if exists($_->{amount});
3652 $_->{amount} =~ s/^\-0\.00$/0.00/;
3653 if (exists($_->{unit_amount})) {
3654 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3658 #if $_->{amount} != 0
3659 # || $discount_show_always
3660 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3661 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3665 warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
3672 =item _items_discounts_avail
3674 Returns an array of line item hashrefs representing available term discounts
3675 for this invoice. This makes the same assumptions that apply to term
3676 discounts in general: that the package is billed monthly, at a flat rate,
3677 with no usage charges. A prorated first month will be handled, as will
3678 a setup fee if the discount is allowed to apply to setup fees.
3682 sub _items_discounts_avail {
3685 #maybe move this method from cust_bill when quotations support discount_plans
3686 return () unless $self->can('discount_plans');
3687 my %plans = $self->discount_plans;
3689 my $list_pkgnums = 0; # if any packages are not eligible for all discounts
3690 $list_pkgnums = grep { $_->list_pkgnums } values %plans;
3694 my $plan = $plans{$months};
3696 my $term_total = sprintf('%.2f', $plan->discounted_total);
3697 my $percent = sprintf('%.0f',
3698 100 * (1 - $term_total / $plan->base_total) );
3699 my $permonth = sprintf('%.2f', $term_total / $months);
3700 my $detail = $self->mt('discount on item'). ' '.
3701 join(', ', map { "#$_" } $plan->pkgnums)
3704 # discounts for non-integer months don't work anyway
3705 $months = sprintf("%d", $months);
3708 description => $self->mt('Save [_1]% by paying for [_2] months',
3710 amount => $self->mt('[_1] ([_2] per month)',
3711 $term_total, $money_char.$permonth),
3712 ext_description => ($detail || ''),
3715 sort { $b <=> $a } keys %plans;