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");
347 $self->set('_template',$template);
350 my @invoice_template = map "$_\n", $conf->config($templatefile)
351 or die "cannot load config data $templatefile";
353 if ( $format eq 'latex' && grep { /^%%Detail/ } @invoice_template ) {
354 #change this to a die when the old code is removed
355 # it's been almost ten years, changing it to a die
356 die "old-style invoice template $templatefile; ".
357 "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
358 #$old_latex = 'true';
359 #@invoice_template = _translate_old_latex_format(@invoice_template);
362 warn "$me print_generic creating T:T object\n"
365 my $text_template = new Text::Template(
367 SOURCE => \@invoice_template,
368 DELIMITERS => $delimiters{$format},
371 warn "$me print_generic compiling T:T object\n"
374 $text_template->compile()
375 or die "Can't compile $templatefile: $Text::Template::ERROR\n";
378 # additional substitution could possibly cause breakage in existing templates
381 'notes' => sub { map "$_", @_ },
382 'footer' => sub { map "$_", @_ },
383 'smallfooter' => sub { map "$_", @_ },
384 'returnaddress' => sub { map "$_", @_ },
385 'coupon' => sub { map "$_", @_ },
386 'summary' => sub { map "$_", @_ },
392 s/%%(.*)$/<!-- $1 -->/g;
393 s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
394 s/\\begin\{enumerate\}/<ol>/g;
396 s/\\end\{enumerate\}/<\/ol>/g;
397 s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
406 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
408 sub { map { s/~/ /g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
414 s/\\hyphenation\{[\w\s\-]+}//;
419 'coupon' => sub { "" },
420 'summary' => sub { "" },
427 s/\\section\*\{\\textsc\{(.*)\}\}/\U$1/g;
428 s/\\begin\{enumerate\}//g;
430 s/\\end\{enumerate\}//g;
431 s/\\textbf\{(.*)\}/$1/g;
438 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
440 sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
445 s/\\\\\*?\s*$/\n/; # dubious
446 s/\\hyphenation\{[\w\s\-]+}//;
450 'coupon' => sub { "" },
451 'summary' => sub { "" },
456 # hashes for differing output formats
457 my %nbsps = ( 'latex' => '~',
458 'html' => '', # '&nbps;' would be nice
459 'template' => '', # not used
461 my $nbsp = $nbsps{$format};
463 my %escape_functions = ( 'latex' => \&_latex_escape,
464 'html' => \&_html_escape_nbsp,#\&encode_entities,
465 'template' => sub { shift },
467 my $escape_function = $escape_functions{$format};
468 my $escape_function_nonbsp = ($format eq 'html')
469 ? \&_html_escape : $escape_function;
471 my %newline_tokens = ( 'latex' => '\\\\',
475 my $newline_token = $newline_tokens{$format};
477 warn "$me generating template variables\n"
480 # generate template variables
484 defined( $conf->config_orbase( "invoice_${format}returnaddress",
488 && length( $conf->config_orbase( "invoice_${format}returnaddress",
494 $returnaddress = join("\n",
495 $conf->config_orbase("invoice_${format}returnaddress", $template)
499 $conf->config_orbase('invoice_latexreturnaddress', $template) ) {
501 my $convert_map = $convert_maps{$format}{'returnaddress'};
504 &$convert_map( $conf->config_orbase( "invoice_latexreturnaddress",
509 } elsif ( grep /\S/, $conf->config('company_address', $cust_main->agentnum) ) {
511 my $convert_map = $convert_maps{$format}{'returnaddress'};
512 $returnaddress = join( "\n", &$convert_map(
513 map { s/( {2,})/'~' x length($1)/eg;
517 ( $conf->config('company_name', $cust_main->agentnum),
518 $conf->config('company_address', $cust_main->agentnum),
525 my $warning = "Couldn't find a return address; ".
526 "do you need to set the company_address configuration value?";
528 $returnaddress = $nbsp;
529 #$returnaddress = $warning;
533 warn "$me generating invoice data\n"
536 my $agentnum = $cust_main->agentnum;
541 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
542 'company_address' => join("\n", $conf->config('company_address', $agentnum) ). "\n",
543 'company_phonenum'=> scalar( $conf->config('company_phonenum', $agentnum) ),
544 'returnaddress' => $returnaddress,
545 'agent' => &$escape_function($cust_main->agent->agent),
547 #invoice/quotation info
548 'no_number' => $params{'no_number'},
549 'invnum' => ( $params{'no_number'} ? '' : $self->invnum ),
550 'quotationnum' => $self->quotationnum,
551 'no_date' => $params{'no_date'},
552 '_date' => ( $params{'no_date'} ? '' : $self->_date ),
553 # workaround for inconsistent behavior in the early plain text
554 # templates; see RT#28271
555 'date' => ( $params{'no_date'}
557 : ($format eq 'template'
559 : $self->time2str_local('long', $self->_date, $format)
562 'today' => $self->time2str_local('long', $today, $format),
563 'terms' => $self->terms,
564 'template' => $template, #params{'template'},
565 'notice_name' => $notice_name, # escape?
566 'current_charges' => sprintf("%.2f", $self->charged),
567 'duedate' => $self->due_date2str('rdate'), #date_format?
568 'duedate_long' => $self->due_date2str('long'),
571 'custnum' => $cust_main->display_custnum,
572 'prospectnum' => $cust_main->prospectnum,
573 'agent_custid' => &$escape_function($cust_main->agent_custid),
574 ( map { $_ => &$escape_function($cust_main->$_()) }
575 qw( company address1 address2 city state zip fax )
577 'payname' => &$escape_function( $cust_main->invoice_attn
578 || $cust_main->contact_firstlast ),
581 'ship_enable' => $cust_main->invoice_ship_address || $conf->exists('invoice-ship_address'),
582 'unitprices' => $conf->exists('invoice-unitprice'),
583 'smallernotes' => $conf->exists('invoice-smallernotes'),
584 'smallerfooter' => $conf->exists('invoice-smallerfooter'),
585 'balance_due_below_line' => $conf->exists('balance_due_below_line'),
587 #layout info -- would be fancy to calc some of this and bury the template
589 'topmargin' => scalar($conf->config('invoice_latextopmargin', $agentnum)),
590 'headsep' => scalar($conf->config('invoice_latexheadsep', $agentnum)),
591 'textheight' => scalar($conf->config('invoice_latextextheight', $agentnum)),
592 'extracouponspace' => scalar($conf->config('invoice_latexextracouponspace', $agentnum)),
593 'couponfootsep' => scalar($conf->config('invoice_latexcouponfootsep', $agentnum)),
594 'verticalreturnaddress' => $conf->exists('invoice_latexverticalreturnaddress', $agentnum),
595 'addresssep' => scalar($conf->config('invoice_latexaddresssep', $agentnum)),
596 'amountenclosedsep' => scalar($conf->config('invoice_latexcouponamountenclosedsep', $agentnum)),
597 'coupontoaddresssep' => scalar($conf->config('invoice_latexcoupontoaddresssep', $agentnum)),
598 'addcompanytoaddress' => $conf->exists('invoice_latexcouponaddcompanytoaddress', $agentnum),
600 # better hang on to conf_dir for a while (for old templates)
601 'conf_dir' => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
603 #these are only used when doing paged plaintext
609 #quotations have $name
610 $invoice_data{'name'} = $invoice_data{'payname'};
613 $invoice_data{'emt'} = sub { &$escape_function($self->mt(@_)) };
614 # prototype here to silence warnings
615 $invoice_data{'time2str'} = sub ($;$$) { $self->time2str_local(@_, $format) };
617 my $min_sdate = 999999999999;
619 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
620 next unless $cust_bill_pkg->pkgnum > 0;
621 $min_sdate = $cust_bill_pkg->sdate
622 if length($cust_bill_pkg->sdate) && $cust_bill_pkg->sdate < $min_sdate;
623 $max_edate = $cust_bill_pkg->edate
624 if length($cust_bill_pkg->edate) && $cust_bill_pkg->edate > $max_edate;
627 $invoice_data{'bill_period'} = '';
628 $invoice_data{'bill_period'} =
629 $self->time2str_local('%e %h', $min_sdate, $format)
631 $self->time2str_local('%e %h', $max_edate, $format)
632 if ($max_edate != 0 && $min_sdate != 999999999999);
634 $invoice_data{finance_section} = '';
635 if ( $conf->config('finance_pkgclass') ) {
637 qsearchs('pkg_class', { classnum => $conf->config('finance_pkgclass') });
638 $invoice_data{finance_section} = $pkg_class->categoryname;
640 $invoice_data{finance_amount} = '0.00';
641 $invoice_data{finance_section} ||= 'Finance Charges'; #avoid config confusion
643 my $countrydefault = $conf->config('countrydefault') || 'US';
644 foreach ( qw( address1 address2 city state zip country fax) ){
645 my $method = 'ship_'.$_;
646 $invoice_data{"ship_$_"} = $escape_function->($cust_main->$method);
648 if ( length($cust_main->ship_company) ) {
649 $invoice_data{'ship_company'} = $escape_function->($cust_main->ship_company);
651 $invoice_data{'ship_company'} = $escape_function->($cust_main->company);
653 $invoice_data{'ship_contact'} = $escape_function->($cust_main->contact);
654 $invoice_data{'ship_country'} = ''
655 if ( $invoice_data{'ship_country'} eq $countrydefault );
657 $invoice_data{'cid'} = $params{'cid'}
660 if ( $cust_main->bill_locationnum
661 && $cust_main->bill_location->country ne $countrydefault ) {
662 $invoice_data{'country'} = &$escape_function($cust_main->bill_country_full);
664 $invoice_data{'country'} = '';
668 $invoice_data{'address'} = \@address;
670 $invoice_data{'payname'}.
671 ( $cust_main->po_number
672 ? " (P.O. #". $cust_main->po_number. ")"
676 push @address, $cust_main->company
677 if $cust_main->company;
678 push @address, $cust_main->address1;
679 push @address, $cust_main->address2
680 if $cust_main->address2;
682 $cust_main->city. ", ". $cust_main->state. " ". $cust_main->zip;
683 push @address, $invoice_data{'country'}
684 if $invoice_data{'country'};
686 while (scalar(@address) < 5);
688 $invoice_data{'logo_file'} = $params{'logo_file'}
689 if $params{'logo_file'};
690 $invoice_data{'barcode_file'} = $params{'barcode_file'}
691 if $params{'barcode_file'};
692 $invoice_data{'barcode_img'} = $params{'barcode_img'}
693 if $params{'barcode_img'};
694 $invoice_data{'barcode_cid'} = $params{'barcode_cid'}
695 if $params{'barcode_cid'};
699 # using owed_on_invoice() instead of owed() here for $balance_due
700 # using _items_previous_total() instead of ->previous() for $pr_total
702 # owed_on_invoice() is aware of configuration flags that affect how an
703 # invoice is rendered. May not return actual current balance. Will
704 # return balance appropriate for the invoice being rendered, based
705 # on which past due items, current charges, and future payments are
708 # Going forward, usage of owed(), or bypassing cust_bill helper methods
709 # when generating invoice lines may lead to incorrect or misleading
712 # Helper methods that are aware of invoicing conf flags:
713 # - owed_on_invoice # use instead of owed()
714 # - _items_previous() # use instead of previous()
715 # - _items_credits() # use instead of cust_credit()
716 # - _items_payments()
718 # - _items_previous_total() # use instead of previous()
719 # - _items_payments_total()
720 # - _items_credits_total() # use instead of cust_credit()
722 my $pr_total = $self->_items_previous_total();
724 my $balance_due = $self->owed_on_invoice();
725 $invoice_data{'balance'} = sprintf("%.2f", $balance_due);
727 # flag telling this invoice to have a first-page summary
728 my $summarypage = '';
730 if ( $self->custnum && $self->invnum ) {
731 # XXX should be an FS::cust_bill method to set the defaults, instead
732 # of checking the type here
734 # info from customer's last invoice before this one, for some
736 $invoice_data{'last_bill'} = {};
738 # my $last_bill = $self->previous_bill;
739 # if ( $last_bill ) {
741 # Populate template stash for previous balance and payments
743 # Used on summary page as "Previous Balance"
744 $invoice_data{'true_previous_balance'} = sprintf("%.2f", $pr_total);
746 # Used on summary page as "Payments"
747 $invoice_data{'balance_adjustments'} = sprintf("%.2f",
748 $self->_items_payments_total() + $self->_items_credits_total()
751 # Used in invoice template as "Previous Balance"
752 $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total);
754 # $invoice_data{last_bill}{_date}:
755 # Not used in default templates, but may be in use by someone
757 # ! May be a problem field if they are using it... this field
758 # stores the date of the previous invoice... it is possible to
759 # carry a balance, but have the immediately previous invoice paid off.
760 # In this case, this field might be presenting bad data? Not
761 # altering the problematic behavior, because someone might be
762 # expecting this bad behavior in their templates for some other
763 # purpose, such as a "your last bill was dated %_date%"
764 my $last_bill = $self->previous_bill;
765 $invoice_data{'last_bill'}{'_date'}
767 ? $last_bill->_date()
770 # $invoice_data{previous_payments}
771 # Not used in default templates, but may be in use by someone
773 # Returns an array of hrefs representing payments, each with keys:
774 # - _date: epoch timestamp
775 # - date: text formatted date
776 # - amount: money formatted amount string
777 # - payinfo: string from payby_payinfo_pretty()
778 # - paynum: id for cust_pay
779 # - description: Text description for bill line item
781 my @payments = $self->_items_payments();
782 $invoice_data{previous_payments} = \@payments;
784 # $invoice_data{previous_credits}
785 # Not used in default templates, but may be in use by someone
787 # Returns an array of hrefs representing credits, each with keys:
788 # - _date: epoch timestamp
789 # - date: text formatted date
790 # - amount: money formatted amount string
791 # - crednum: id for cust_credit
792 # - description: Text description for bill line item
793 # - creditreason: reason() from cust_credit
795 my @credits = $self->_items_credits();
796 $invoice_data{previous_credits} = \@credits;
798 # Populate formatted date field
799 for my $pmt_href (@payments, @credits) {
800 $pmt_href->{date} = $self->time2str_local(
808 # There are no outstanding invoices = YAPH
809 $invoice_data{'true_previous_balance'} =
810 $invoice_data{'balance_adjustments'} =
811 $invoice_data{'previous_balance'} = '0.00';
812 $invoice_data{'previous_payments'} =
813 $invoice_data{'previous_credits'} = [];
816 # Condencing a lot of debug staements here
818 warn "\$invoice_data{$_}: $invoice_data{$_}"
820 true_previous_balance
828 if ( $conf->exists('invoice_usesummary', $agentnum) ) {
829 $invoice_data{'summarypage'} = $summarypage = 1;
832 } # if this is an invoice
834 warn "$me substituting variables in notes, footer, smallfooter\n"
837 my $tc = $self->template_conf;
838 my @include = ( [ $tc, 'notes' ],
839 [ 'invoice_', 'footer' ],
840 [ 'invoice_', 'smallfooter', ],
841 [ 'invoice_', 'watermark' ],
843 push @include, [ $tc, 'coupon', ]
844 unless $params{'no_coupon'};
846 foreach my $i (@include) {
848 # load the configuration for this sub-template
850 my($base, $include) = @$i;
852 my $inc_file = $conf->key_orbase("$base$format$include", $template);
854 my @inc_src = $conf->config($inc_file, $agentnum);
856 my $converter = $convert_maps{$format}{$include};
858 # then attempt to convert LaTeX to the requested format
859 $inc_file = $conf->key_orbase($base.'latex'.$include, $template);
860 @inc_src = &$converter( $conf->config($inc_file, $agentnum) );
862 # this isn't included in the convert_maps
863 my ($open, $close) = @{ $delimiters{$format} };
868 } # else @inc_src is empty and that's fine
870 # make a Text::Template out of it
872 my $inc_tt = new Text::Template (
874 SOURCE => [ map "$_\n", @inc_src ],
875 DELIMITERS => $delimiters{$format},
876 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
878 unless ( $inc_tt->compile() ) {
879 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
880 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
886 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
888 $invoice_data{$include} =~ s/\n+$//
889 if ($format eq 'latex');
892 # if (well, probably when) we still need PO numbers in the brave new world of
893 # 4.x, then we'll have to add them back as their own customer fields
894 # # let invoices use either of these as needed
895 # $invoice_data{'po_num'} = ($cust_main->payby eq 'BILL')
896 # ? $cust_main->payinfo : '';
897 # $invoice_data{'po_line'} =
898 # ( $cust_main->payby eq 'BILL' && $cust_main->payinfo )
899 # ? &$escape_function($self->mt("Purchase Order #").$cust_main->payinfo)
902 my %money_chars = ( 'latex' => '',
903 'html' => $conf->config('money_char') || '$',
906 my $money_char = $money_chars{$format};
909 my %other_money_chars = ( 'latex' => '\dollar ',#XXX should be a config too
910 'html' => $conf->config('money_char') || '$',
913 my $other_money_char = $other_money_chars{$format};
914 $invoice_data{'dollar'} = $other_money_char;
916 my %minus_signs = ( 'latex' => '$-$',
918 'template' => '- ' );
919 my $minus = $minus_signs{$format};
921 my @detail_items = ();
922 my @total_items = ();
926 $invoice_data{'detail_items'} = \@detail_items;
927 $invoice_data{'total_items'} = \@total_items;
928 $invoice_data{'buf'} = \@buf;
929 $invoice_data{'sections'} = \@sections;
931 warn "$me generating sections\n"
934 my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
935 my $multisection = $self->has_sections;
936 $conf->exists($tc.'sections', $cust_main->agentnum) ||
937 $conf->exists($tc.'sections_by_location', $cust_main->agentnum);
938 $invoice_data{'multisection'} = $multisection;
940 my $extra_sections = [];
941 my $extra_lines = ();
943 # default section ('Charges')
944 my $default_section = { 'description' => '',
949 # Previous Charges section
950 # subtotal is the first return value from $self->previous
951 my $previous_section;
952 # if the invoice has major sections, or if we're summarizing previous
953 # charges with a single line, or if we've been specifically told to put them
954 # in a section, create a section for previous charges:
955 if ( $multisection or
956 $conf->exists('previous_balance-summary_only') or
957 $conf->exists('previous_balance-section') ) {
959 $previous_section = { 'description' => $self->mt('Previous Charges'),
960 'subtotal' => $other_money_char.
961 sprintf('%.2f', $pr_total),
962 'summarized' => '', #why? $summarypage ? 'Y' : '',
965 # Include balance aging line and template variables
966 my @aged_balances = $self->_items_aging_balances();
967 ( $invoice_data{aged_balance_current},
968 $invoice_data{aged_balance_30d},
969 $invoice_data{aged_balance_60d},
970 $invoice_data{aged_balance_90d}
973 if ($conf->exists('invoice_include_aging')) {
974 $previous_section->{posttotal} = sprintf(
975 '0 / 30 / 60 / 90 days overdue %.2f / %.2f / %.2f / %.2f',
981 # otherwise put them in the main section
982 $previous_section = $default_section;
985 my $adjust_section = {
986 'description' => $self->mt('Credits, Payments, and Adjustments'),
987 'adjust_section' => 1,
988 'subtotal' => 0, # adjusted below
990 my $adjust_weight = _pkg_category($adjust_section->{description})
991 ? _pkg_category($adjust_section->{description})->weight
993 $adjust_section->{'summarized'} = ''; #why? $summarypage && !$adjust_weight ? 'Y' : '';
994 # Note: 'sort_weight' here is actually a flag telling whether there is an
995 # explicit package category for the adjust section. If so, certain behavior
997 $adjust_section->{'sort_weight'} = $adjust_weight;
1000 if ( $multisection ) {
1001 ($extra_sections, $extra_lines) =
1002 $self->_items_extra_usage_sections($escape_function_nonbsp, $format)
1003 if $conf->exists('usage_class_as_a_section', $cust_main->agentnum)
1004 && $self->can('_items_extra_usage_sections');
1006 push @$extra_sections, $adjust_section if $adjust_section->{sort_weight};
1008 push @detail_items, @$extra_lines if $extra_lines;
1010 # the code is written so that both methods can be used together, but
1011 # we haven't yet changed the template to take advantage of that, so for
1012 # now, treat them as mutually exclusive.
1013 my %section_method = ( by_category => 1 );
1014 if ( $conf->config($tc.'sections_method') eq 'location' ) {
1015 %section_method = ( by_location => 1 );
1017 my ($early, $late) =
1018 $self->_items_sections( 'summary' => $summarypage,
1019 'escape' => $escape_function_nonbsp,
1020 'extra_sections' => $extra_sections,
1021 'format' => $format,
1024 push @sections, @$early;
1025 $late_sections = $late;
1027 if ( $conf->exists('svc_phone_sections')
1028 && $self->can('_items_svc_phone_sections')
1031 my ($phone_sections, $phone_lines) =
1032 $self->_items_svc_phone_sections($escape_function_nonbsp, $format);
1033 push @{$late_sections}, @$phone_sections;
1034 push @detail_items, @$phone_lines;
1036 if ( $conf->exists('voip-cust_accountcode_cdr')
1037 && $cust_main->accountcode_cdr
1038 && $self->can('_items_accountcode_cdr')
1041 my ($accountcode_section, $accountcode_lines) =
1042 $self->_items_accountcode_cdr($escape_function_nonbsp,$format);
1043 if ( scalar(@$accountcode_lines) ) {
1044 push @{$late_sections}, $accountcode_section;
1045 push @detail_items, @$accountcode_lines;
1048 } else {# not multisection
1049 # make a default section
1050 push @sections, $default_section;
1051 # and calculate the finance charge total, since it won't get done otherwise.
1052 # and the default section total
1053 # XXX possibly finance_pkgclass should not be used in this manner?
1054 my @finance_charges;
1056 foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1057 if ( $invoice_data{finance_section} and
1058 grep { $_->section eq $invoice_data{finance_section} }
1059 $cust_bill_pkg->cust_bill_pkg_display ) {
1060 # I think these are always setup fees, but just to be sure...
1061 push @finance_charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1063 push @charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1066 $invoice_data{finance_amount} =
1067 sprintf('%.2f', sum( @finance_charges ) || 0);
1068 $default_section->{subtotal} = $other_money_char.
1069 sprintf('%.2f', sum( @charges ) || 0);
1072 # start setting up summary subtotals
1073 my @summary_subtotals;
1074 my $method = $conf->config('summary_subtotals_method');
1075 if ( $method and $method ne $conf->config($tc.'sections_method') ) {
1076 # then re-section them by the correct method
1077 my %section_method = ( by_category => 1 );
1078 if ( $conf->config('summary_subtotals_method') eq 'location' ) {
1079 %section_method = ( by_location => 1 );
1081 my ($early, $late) =
1082 $self->_items_sections( 'summary' => $summarypage,
1083 'escape' => $escape_function_nonbsp,
1084 'extra_sections' => $extra_sections,
1085 'format' => $format,
1088 foreach ( @$early ) {
1089 next if $_->{subtotal} == 0;
1090 $_->{subtotal} = $other_money_char.sprintf('%.2f', $_->{subtotal});
1091 push @summary_subtotals, $_;
1094 # subtotal sectioning is the same as for the actual invoice sections
1095 @summary_subtotals = @sections;
1098 # Hereafter, push sections to both @sections and @summary_subtotals
1099 # if they belong in both places (e.g. tax section). Late sections are
1100 # never in @summary_subtotals.
1102 # previous invoice balances in the Previous Charges section if there
1103 # is one, otherwise in the main detail section
1104 # (except if summary_only is enabled, don't show them at all)
1105 if ( $self->can('_items_previous') &&
1106 $self->enable_previous &&
1107 ! $conf->exists('previous_balance-summary_only') ) {
1109 warn "$me adding previous balances\n"
1112 foreach my $line_item ( $self->_items_previous ) {
1115 ref => $line_item->{'pkgnum'},
1116 pkgpart => $line_item->{'pkgpart'},
1117 #quantity => 1, # not really correct
1118 section => $previous_section, # which might be $default_section
1119 description => &$escape_function($line_item->{'description'}),
1120 ext_description => [ map { &$escape_function($_) }
1121 @{ $line_item->{'ext_description'} || [] }
1123 amount => $money_char . $line_item->{'amount'},
1124 product_code => $line_item->{'pkgpart'} || 'N/A',
1127 push @detail_items, $detail;
1128 push @buf, [ $detail->{'description'},
1129 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1135 if ( $pr_total && $self->enable_previous ) {
1136 push @buf, ['','-----------'];
1137 push @buf, [ $self->mt('Total Previous Balance'),
1138 $money_char. sprintf("%10.2f", $pr_total) ];
1142 if ( $conf->exists('svc_phone-did-summary') && $self->can('_did_summary') ) {
1143 warn "$me adding DID summary\n"
1146 my ($didsummary,$minutes) = $self->_did_summary;
1147 my $didsummary_desc = 'DID Activity Summary (since last invoice)';
1149 { 'description' => $didsummary_desc,
1150 'ext_description' => [ $didsummary, $minutes ],
1154 foreach my $section (@sections, @$late_sections) {
1156 # begin some normalization
1157 $section->{'subtotal'} = $section->{'amount'}
1159 && !exists($section->{subtotal})
1160 && exists($section->{amount});
1162 $invoice_data{finance_amount} = sprintf('%.2f', $section->{'subtotal'} )
1163 if ( $invoice_data{finance_section} &&
1164 $section->{'description'} eq $invoice_data{finance_section} );
1166 if ( $multisection ) {
1168 if ( ref($section->{'subtotal'}) ) {
1170 $section->{'subtotal'} =
1171 sprintf("$other_money_char%.2f to $other_money_char%.2f",
1172 $section->{'subtotal'}[0],
1173 $section->{'subtotal'}[1]
1178 $section->{'subtotal'} = $other_money_char.
1179 sprintf('%.2f', $section->{'subtotal'})
1183 # continue some normalization
1184 $section->{'amount'} = $section->{'subtotal'}
1188 if ( $section->{'description'} ) {
1189 push @buf, ( [ &$escape_function($section->{'description'}), '' ],
1194 warn "$me setting options\n"
1198 $options{'section'} = $section if $multisection;
1199 $options{'format'} = $format;
1200 $options{'escape_function'} = $escape_function;
1201 $options{'no_usage'} = 1 unless $unsquelched;
1202 $options{'unsquelched'} = $unsquelched;
1203 $options{'summary_page'} = $summarypage;
1204 $options{'skip_usage'} =
1205 scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
1206 $options{'preref_callback'} = $params{'preref_callback'};
1208 warn "$me searching for line items\n"
1211 foreach my $line_item ( $self->_items_pkg(%options),
1212 $self->_items_fee(%options) ) {
1214 warn "$me adding line item ".
1215 join(', ', map "$_=>".$line_item->{$_}, keys %$line_item). "\n"
1218 push @buf, ( [ $line_item->{'description'},
1219 $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1221 map { [ " ". $_, '' ] } @{$line_item->{'ext_description'}},
1224 $line_item->{'ref'} = $line_item->{'pkgnum'};
1225 $line_item->{'product_code'} = $line_item->{'pkgpart'} || 'N/A'; # mt()?
1226 $line_item->{'section'} = $section;
1227 $line_item->{'description'} = &$escape_function($line_item->{'description'});
1228 $line_item->{'amount'} = $money_char.$line_item->{'amount'};
1230 if ( length($line_item->{'unit_amount'}) ) {
1231 $line_item->{'unit_amount'} = $money_char.$line_item->{'unit_amount'};
1233 $line_item->{'ext_description'} ||= [];
1235 push @detail_items, $line_item;
1238 if ( $section->{'description'} ) {
1239 push @buf, ( ['','-----------'],
1240 [ $section->{'description'}. ' sub-total',
1241 $section->{'subtotal'} # already formatted this
1250 $invoice_data{current_less_finance} =
1251 sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
1253 # if there's anything in the Previous Charges section, prepend it to the list
1254 if ( $pr_total and $previous_section ne $default_section ) {
1255 unshift @sections, $previous_section;
1256 # but not @summary_subtotals
1259 warn "$me adding taxes\n"
1262 # create a tax section if we don't yet have one
1263 my @items_tax = $self->_items_tax;
1264 my $tax_description = 'Taxes, Surcharges, and Fees';
1266 List::Util::first { $_->{description} eq $tax_description } @sections;
1267 if (!$tax_section) {
1268 $tax_section = { 'description' => $tax_description };
1269 push @sections, $tax_section if $multisection and @items_tax > 0;
1271 $tax_section->{tax_section} = 1; # mark this section as containing taxes
1272 # if this is an existing tax section, we're merging the tax items into it.
1273 # grab the taxtotal that's already there, strip the money symbol if any
1274 my $taxtotal = $tax_section->{'subtotal'} || 0;
1275 $taxtotal =~ s/^\Q$other_money_char\E//;
1278 #my $tax_weight = _pkg_category($tax_section->{description})
1279 # ? _pkg_category($tax_section->{description})->weight
1281 #$tax_section->{'summarized'} = ''; #why? $summarypage && !$tax_weight ? 'Y' : '';
1282 #$tax_section->{'sort_weight'} = $tax_weight;
1284 foreach my $tax ( @items_tax ) {
1286 $taxtotal += $tax->{'amount'};
1288 my $description = &$escape_function( $tax->{'description'} );
1289 my $amount = sprintf( '%.2f', $tax->{'amount'} );
1291 if ( $multisection ) {
1293 push @detail_items, {
1294 ext_description => [],
1297 description => $description,
1298 amount => $money_char. $amount,
1300 section => $tax_section,
1305 push @total_items, {
1306 'total_item' => $description,
1307 'total_amount' => $other_money_char. $amount,
1312 push @buf,[ $description,
1313 $money_char. $amount,
1320 $total->{'total_item'} = $self->mt('Sub-total');
1321 $total->{'total_amount'} =
1322 $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
1324 if ( $multisection ) {
1325 if ( $taxtotal > 0 ) {
1326 # there are taxes, so prepare the section to be displayed.
1327 # $taxtotal already includes any line items that were already in the
1328 # section (fees, taxes that are charged as packages for some reason).
1329 # also set 'summarized' to false so that this isn't a summary-only
1331 $tax_section->{'subtotal'} = $other_money_char.
1332 sprintf('%.2f', $taxtotal);
1333 $tax_section->{'pretotal'} = 'New charges sub-total '.
1334 $total->{'total_amount'};
1335 $tax_section->{'description'} = $self->mt($tax_description);
1336 $tax_section->{'summarized'} = '';
1338 # append it if it's not already there
1339 if ( !grep $tax_section, @sections ) {
1340 push @sections, $tax_section;
1341 push @summary_subtotals, $tax_section;
1346 unshift @total_items, $total;
1349 $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
1355 my %embolden_functions = (
1356 'latex' => sub { return '\textbf{'. shift(). '}' },
1357 'html' => sub { return '<b>'. shift(). '</b>' },
1358 'template' => sub { shift },
1360 my $embolden_function = $embolden_functions{$format};
1362 if ( $multisection ) {
1364 if ( $adjust_section->{'sort_weight'} ) {
1365 $adjust_section->{'posttotal'} = $self->mt('Balance Forward').' '.
1366 $other_money_char. sprintf("%.2f", ($self->billing_balance || 0) );
1368 $adjust_section->{'pretotal'} = $self->mt('New charges total').' '.
1369 $other_money_char. sprintf('%.2f', $self->charged );
1374 if ( $self->can('_items_total') ) { # should always be true now
1376 # even for multisection, need plain text version
1378 my @new_total_items = $self->_items_total;
1380 push @buf,['','-----------'];
1382 foreach ( @new_total_items ) {
1383 my ($item, $amount) = ($_->{'total_item'}, $_->{'total_amount'});
1384 $_->{'total_item'} = &$embolden_function( $item );
1386 if ( ref($amount) ) {
1387 $_->{'total_amount'} = &$embolden_function(
1388 $other_money_char.$amount->[0]. ' to '.
1389 $other_money_char.$amount->[1]
1392 $_->{'total_amount'} = &$embolden_function( $other_money_char.$amount );
1395 # but if it's multisection, don't append to @total_items. the adjust
1396 # section has all this stuff
1397 push @total_items, $_ if !$multisection;
1398 push @buf, [ $item, $money_char.sprintf('%10.2f',$amount) ];
1401 push @buf, [ '', '' ];
1403 # if we're showing previous invoices, also show previous
1404 # credits and payments
1405 if ( $self->enable_previous
1406 and $self->can('_items_credits')
1407 and $self->can('_items_payments') )
1411 my $credittotal = 0;
1412 foreach my $credit (
1413 $self->_items_credits( 'template' => $template, 'trim_len' => 40 )
1417 $total->{'total_item'} = &$escape_function($credit->{'description'});
1418 $credittotal += $credit->{'amount'};
1419 $total->{'total_amount'} = $minus.$other_money_char.$credit->{'amount'};
1420 if ( $multisection ) {
1421 push @detail_items, {
1422 ext_description => [],
1425 description => &$escape_function($credit->{'description'}),
1426 amount => $money_char . $credit->{'amount'},
1428 section => $adjust_section,
1431 push @total_items, $total;
1435 $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
1438 foreach my $credit (
1439 $self->_items_credits( 'template' => $template, 'trim_len'=>32 )
1441 push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
1445 my $paymenttotal = 0;
1446 foreach my $payment (
1447 $self->_items_payments( 'template' => $template )
1450 $total->{'total_item'} = &$escape_function($payment->{'description'});
1451 $paymenttotal += $payment->{'amount'};
1452 $total->{'total_amount'} = $minus.$other_money_char.$payment->{'amount'};
1453 if ( $multisection ) {
1454 push @detail_items, {
1455 ext_description => [],
1458 description => &$escape_function($payment->{'description'}),
1459 amount => $money_char . $payment->{'amount'},
1461 section => $adjust_section,
1464 push @total_items, $total;
1466 push @buf, [ $payment->{'description'},
1467 $money_char. sprintf("%10.2f", $payment->{'amount'}),
1470 $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
1472 if ( $multisection ) {
1473 $adjust_section->{'subtotal'} = $other_money_char.
1474 sprintf('%.2f', $credittotal + $paymenttotal);
1476 #why this? because {sort_weight} forces the adjust_section to appear
1477 #in @extra_sections instead of @sections. obviously.
1478 push @sections, $adjust_section
1479 unless $adjust_section->{sort_weight};
1480 # do not summarize; adjustments there are shown according to
1484 # create Balance Due message
1487 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1488 $total->{'total_amount'} =
1489 &$embolden_function(
1490 $other_money_char. sprintf('%.2f', #why? $summarypage
1491 # ? $self->charged +
1492 # $self->billing_balance
1497 if ( $multisection && !$adjust_section->{sort_weight} ) {
1498 $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
1499 $total->{'total_amount'};
1501 push @total_items, $total;
1503 push @buf,['','-----------'];
1504 push @buf,[$self->balance_due_msg, $money_char.
1505 sprintf("%10.2f", $balance_due ) ];
1508 if ( $conf->exists('previous_balance-show_credit')
1509 and $cust_main->balance < 0 ) {
1510 my $credit_total = {
1511 'total_item' => &$embolden_function($self->credit_balance_msg),
1512 'total_amount' => &$embolden_function(
1513 $other_money_char. sprintf('%.2f', -$cust_main->balance)
1516 if ( $multisection ) {
1517 $adjust_section->{'posttotal'} .= $newline_token .
1518 $credit_total->{'total_item'} . ' ' . $credit_total->{'total_amount'};
1521 push @total_items, $credit_total;
1523 push @buf,['','-----------'];
1524 push @buf,[$self->credit_balance_msg, $money_char.
1525 sprintf("%10.2f", -$cust_main->balance ) ];
1529 } #end of default total adding ! can('_items_total')
1531 if ( $multisection ) {
1532 if ( $conf->exists('svc_phone_sections')
1533 && $self->can('_items_svc_phone_sections')
1537 $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1538 $total->{'total_amount'} =
1539 &$embolden_function(
1540 $other_money_char. sprintf('%.2f', $balance_due)
1542 my $last_section = pop @sections;
1543 $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
1544 $total->{'total_amount'};
1545 push @sections, $last_section;
1547 push @sections, @$late_sections
1551 # make a discounts-available section, even without multisection
1552 if ( $conf->exists('discount-show_available')
1553 and my @discounts_avail = $self->_items_discounts_avail ) {
1554 my $discount_section = {
1555 'description' => $self->mt('Discounts Available'),
1560 push @sections, $discount_section; # do not summarize
1561 push @detail_items, map { +{
1562 'ref' => '', #should this be something else?
1563 'section' => $discount_section,
1564 'description' => &$escape_function( $_->{description} ),
1565 'amount' => $money_char . &$escape_function( $_->{amount} ),
1566 'ext_description' => [ &$escape_function($_->{ext_description}) || () ],
1567 } } @discounts_avail;
1570 # not adding any more sections after this
1571 $invoice_data{summary_subtotals} = \@summary_subtotals;
1574 if ( $conf->exists('usage_class_summary')
1575 and $self->can('_items_usage_class_summary') ) {
1576 my @usage_subtotals = $self->_items_usage_class_summary(escape => $escape_function, 'money_char' => $other_money_char);
1577 if ( @usage_subtotals ) {
1578 unshift @sections, $usage_subtotals[0]->{section}; # do not summarize
1579 unshift @detail_items, @usage_subtotals;
1583 # invoice history "section" (not really a section)
1584 # not to be included in any subtotals, completely independent of
1586 if ( $conf->exists('previous_invoice_history') and $cust_main->isa('FS::cust_main') ) {
1589 foreach my $cust_bill ( $cust_main->cust_bill ) {
1590 # XXX hardcoded format, and currently only 'charged'; add other fields
1591 # if they become necessary
1592 my $date = $self->time2str_local('%b %Y', $cust_bill->_date);
1593 $history{$date} ||= 0;
1594 $history{$date} += $cust_bill->charged;
1595 # just so we have a numeric sort key
1596 $monthorder{$date} ||= $cust_bill->_date;
1598 my @sorted_months = sort { $monthorder{$a} <=> $monthorder{$b} }
1600 my @sorted_amounts = map { sprintf('%.2f', $history{$_}) } @sorted_months;
1601 $invoice_data{monthly_history} = [ \@sorted_months, \@sorted_amounts ];
1604 # service locations: another option for template customization
1606 foreach my $item (@detail_items) {
1607 if ( $item->{locationnum} ) {
1608 $location_info{ $item->{locationnum} } ||= {
1609 FS::cust_location->by_key( $item->{locationnum} )->location_hash
1613 $invoice_data{location_info} = \%location_info;
1615 # debugging hook: call this with 'diag' => 1 to just get a hash of
1616 # the invoice variables
1617 return \%invoice_data if ( $params{'diag'} );
1619 # All sections and items are built; now fill in templates.
1620 my @includelist = ();
1621 push @includelist, 'summary' if $summarypage;
1622 foreach my $include ( @includelist ) {
1624 my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
1627 if ( length( $conf->config($inc_file, $agentnum) ) ) {
1629 @inc_src = $conf->config($inc_file, $agentnum);
1633 $inc_file = $conf->key_orbase("invoice_latex$include", $template);
1635 my $convert_map = $convert_maps{$format}{$include};
1637 @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
1638 s/--\@\]/$delimiters{$format}[1]/g;
1641 &$convert_map( $conf->config($inc_file, $agentnum) );
1645 my $inc_tt = new Text::Template (
1647 SOURCE => [ map "$_\n", @inc_src ],
1648 DELIMITERS => $delimiters{$format},
1649 ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
1651 unless ( $inc_tt->compile() ) {
1652 my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
1653 warn $error. "Template:\n". join('', map "$_\n", @inc_src);
1657 $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
1659 $invoice_data{$include} =~ s/\n+$//
1660 if ($format eq 'latex');
1665 foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1666 /invoice_lines\((\d*)\)/;
1667 $invoice_lines += $1 || scalar(@buf);
1670 die "no invoice_lines() functions in template?"
1671 if ( $format eq 'template' && !$wasfunc );
1673 if ( $invoice_lines ) {
1674 $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
1675 $invoice_data{'total_pages'}++
1676 if scalar(@buf) % $invoice_lines;
1679 #setup subroutine for the template
1680 $invoice_data{invoice_lines} = sub {
1681 my $lines = shift || scalar(@buf);
1690 if ($format eq 'template') {
1695 push @collect, split("\n",
1696 $text_template->fill_in( HASH => \%invoice_data )
1698 $invoice_data{'page'}++;
1700 map "$_\n", @collect;
1702 } else { # this is where we actually create the invoice
1704 if ( $params{no_addresses} ) {
1705 delete $invoice_data{$_} foreach qw(
1706 payname company address1 address2 city state zip country
1708 $invoice_data{returnaddress} = '~';
1711 warn "filling in template for invoice ". $self->invnum. "\n"
1713 warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
1716 $text_template->fill_in(HASH => \%invoice_data);
1720 sub notice_name { '('.shift->table.')'; }
1722 # this is not supposed to happen
1723 sub template_conf { warn "bare FS::Template_Mixin::template_conf";
1727 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
1729 Returns an postscript invoice, as a scalar.
1731 Options can be passed as a hashref (recommended) or as a list of time, template
1732 and then any key/value pairs for any other options.
1734 I<time> an optional value used to control the printing of overdue messages. The
1735 default is now. It isn't the date of the invoice; that's the `_date' field.
1736 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1737 L<Time::Local> and L<Date::Parse> for conversion functions.
1739 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1746 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1747 my $ps = generate_ps($file);
1749 unlink($barcodefile) if $barcodefile;
1754 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
1756 Returns an PDF invoice, as a scalar.
1758 Options can be passed as a hashref (recommended) or as a list of time, template
1759 and then any key/value pairs for any other options.
1761 I<time> an optional value used to control the printing of overdue messages. The
1762 default is now. It isn't the date of the invoice; that's the `_date' field.
1763 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1764 L<Time::Local> and L<Date::Parse> for conversion functions.
1766 I<template>, if specified, is the name of a suffix for alternate invoices.
1768 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1775 my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1776 my $pdf = generate_pdf($file);
1778 unlink($barcodefile) if $barcodefile;
1783 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
1785 Returns an HTML invoice, as a scalar.
1787 I<time> an optional value used to control the printing of overdue messages. The
1788 default is now. It isn't the date of the invoice; that's the `_date' field.
1789 It is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
1790 L<Time::Local> and L<Date::Parse> for conversion functions.
1792 I<template>, if specified, is the name of a suffix for alternate invoices.
1794 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1796 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
1797 when emailing the invoice as part of a multipart/related MIME email.
1805 %params = %{ shift() };
1809 $params{'format'} = 'html';
1811 $self->print_generic( %params );
1814 # quick subroutine for print_latex
1816 # There are ten characters that LaTeX treats as special characters, which
1817 # means that they do not simply typeset themselves:
1818 # # $ % & ~ _ ^ \ { }
1820 # TeX ignores blanks following an escaped character; if you want a blank (as
1821 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
1825 $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
1826 $value =~ s/([<>])/\$$1\$/g;
1832 encode_entities($value);
1836 sub _html_escape_nbsp {
1837 my $value = _html_escape(shift);
1838 $value =~ s/ +/ /g;
1842 #utility methods for print_*
1844 sub _translate_old_latex_format {
1845 warn "_translate_old_latex_format called\n"
1852 if ( $line =~ /^%%Detail\s*$/ ) {
1854 push @template, q![@--!,
1855 q! foreach my $_tr_line (@detail_items) {!,
1856 q! if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
1857 q! $_tr_line->{'description'} .= !,
1858 q! "\\tabularnewline\n~~".!,
1859 q! join( "\\tabularnewline\n~~",!,
1860 q! @{$_tr_line->{'ext_description'}}!,
1864 while ( ( my $line_item_line = shift )
1865 !~ /^%%EndDetail\s*$/ ) {
1866 $line_item_line =~ s/'/\\'/g; # nice LTS
1867 $line_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1868 $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1869 push @template, " \$OUT .= '$line_item_line';";
1872 push @template, '}',
1875 } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1877 push @template, '[@--',
1878 ' foreach my $_tr_line (@total_items) {';
1880 while ( ( my $total_item_line = shift )
1881 !~ /^%%EndTotalDetails\s*$/ ) {
1882 $total_item_line =~ s/'/\\'/g; # nice LTS
1883 $total_item_line =~ s/\\/\\\\/g; # escape quotes and backslashes
1884 $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1885 push @template, " \$OUT .= '$total_item_line';";
1888 push @template, '}',
1892 $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
1893 push @template, $line;
1899 warn "$_\n" foreach @template;
1911 my $conf = $self->conf;
1913 #check for an invoice-specific override
1914 return $self->invoice_terms if $self->invoice_terms;
1916 #check for a customer- specific override
1917 my $cust_main = $self->cust_main;
1918 return $cust_main->invoice_terms if $cust_main && $cust_main->invoice_terms;
1922 $agentnum = $cust_main->agentnum;
1923 } elsif ( my $prospect_main = $self->prospect_main ) {
1924 $agentnum = $prospect_main->agentnum;
1927 #use configured default
1928 $conf->config('invoice_default_terms', $agentnum) || '';
1938 if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1939 $duedate = $self->_date() + ( $1 * 86400 );
1940 } elsif ( $self->terms =~ /^End of Month$/ ) {
1941 my ($mon,$year) = (localtime($self->_date) )[4,5];
1943 until ( $mon < 12 ) { $mon -= 12; $year++; }
1944 my $nextmonth_first = timelocal(0,0,0,1,$mon,$year);
1945 $duedate = $nextmonth_first - 86400;
1956 $self->due_date ? $self->time2str_local(shift, $self->due_date) : '';
1959 =item invoice_pay_by_msg
1961 displays the invoice_pay_by_msg or default Please pay by [_1] if empty.
1965 sub invoice_pay_by_msg {
1969 $self->conf->config('invoice_pay_by_msg', $self->agentnum)
1970 || 'Please pay by [_1]';
1971 $msg .= ' - ' . $self->mt($please_pay_by, $self->due_date2str('short')) . ' ';
1976 =item balance_due_msg
1980 sub balance_due_msg {
1982 my $msg = $self->mt('Balance Due');
1983 return $msg unless $self->terms; # huh?
1984 if ( !$self->conf->exists('invoice_show_prior_due_date')
1985 or $self->conf->exists('invoice_sections') ) {
1986 # if enabled, the due date is shown with Total New Charges (see
1987 # _items_total) and not here
1988 # (yes, or if invoice_sections is enabled; this is just for compatibility)
1989 if ( $self->due_date ) {
1990 $msg .= $self->invoice_pay_by_msg
1991 unless $self->conf->config_bool('invoice_omit_due_date',$self->agentnum);
1992 } elsif ( $self->terms ) {
1993 $msg .= ' - '. $self->mt($self->terms);
1999 =item balance_due_date
2003 sub balance_due_date {
2005 my $conf = $self->conf;
2007 my $terms = $self->terms;
2008 if ( $terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
2009 $duedate = $self->time2str_local('rdate', $self->_date + ($1*86400) );
2014 sub credit_balance_msg {
2016 $self->mt('Credit Balance Remaining')
2021 Returns a string with the date, for example: "3/20/2008", localized for the
2022 customer. Use _date_pretty_unlocalized for non-end-customer display use.
2028 $self->time2str_local('short', $self->_date);
2031 =item _date_pretty_unlocalized
2033 Returns a string with the date, for example: "3/20/2008", in the format
2034 configured for the back-office. Use _date_pretty for end-customer display use.
2038 sub _date_pretty_unlocalized {
2040 time2str($date_format, $self->_date);
2045 Emails this template.
2047 Options are passed as a hashref. Available options:
2053 If specified, overrides the default From: address.
2057 If specified, overrides the name of the sent document ("Invoice" or "Quotation")
2061 (Deprecated) If specified, is the name of a suffix for alternate template files.
2065 Options accepted by generate_email can also be used.
2071 my $opt = shift || {};
2072 if ($opt and !ref($opt)) {
2073 die ref($self). '->email called with positional parameters';
2076 return if $self->hide;
2078 my $error = send_email(
2079 $self->generate_email(
2080 'subject' => $self->email_subject($opt->{template}),
2081 %$opt, # template, etc.
2085 die "can't email: $error\n" if $error;
2088 =item generate_email OPTION => VALUE ...
2096 sender address, required
2100 alternate template name, optional
2104 email subject, optional
2108 notice name instead of "Invoice", optional
2112 Returns an argument list to be passed to L<FS::Misc::send_email>.
2119 sub generate_email {
2123 my $conf = $self->conf;
2125 my $me = '[FS::Template_Mixin::generate_email]';
2128 'from' => $args{'from'},
2129 'subject' => ($args{'subject'} || $self->email_subject),
2130 'custnum' => $self->custnum,
2131 'msgtype' => 'invoice',
2134 $args{'unsquelch_cdr'} = $conf->exists('voip-cdr_email');
2136 my $cust_main = $self->cust_main;
2138 if (ref($args{'to'}) eq 'ARRAY') {
2139 $return{'to'} = $args{'to'};
2140 } elsif ( $cust_main ) {
2141 $return{'to'} = [ $cust_main->invoicing_list_emailonly ];
2144 my $tc = $self->template_conf;
2146 my @text; # array of lines
2147 my $html; # a big string
2148 my @related_parts; # will contain the text/HTML alternative, and images
2149 my $related; # will contain the multipart/related object
2151 if ( $conf->exists($tc. 'email_pdf') ) {
2152 if ( my $msgnum = $conf->config($tc.'email_pdf_msgnum') ) {
2154 warn "$me using '${tc}email_pdf_msgnum' in multipart message"
2157 my $msg_template = FS::msg_template->by_key($msgnum)
2158 or die "${tc}email_pdf_msgnum $msgnum not found\n";
2159 my $cust_msg = $msg_template->prepare(
2160 cust_main => $self->cust_main,
2162 msgtype => 'invoice',
2165 # XXX hack to make this work in the new cust_msg era; consider replacing
2166 # with cust_bill_send_with_notice events.
2167 my @parts = $cust_msg->parts;
2168 foreach my $part (@parts) { # will only have two parts, normally
2169 if ( $part->mime_type eq 'text/plain' ) {
2170 @text = @{ $part->body };
2171 } elsif ( $part->mime_type eq 'text/html' ) {
2172 $html = $part->bodyhandle->as_string;
2176 } elsif ( my @note = $conf->config($tc.'email_pdf_note') ) {
2178 warn "$me using '${tc}email_pdf_note' in multipart message"
2180 @text = $conf->config($tc.'email_pdf_note');
2181 $html = join('<BR>', @text);
2183 } # else use the plain text invoice
2188 if ( $conf->config($tc.'template') ) {
2190 warn "$me generating plain text invoice"
2193 # 'print_text' argument is no longer used
2194 @text = map Encode::encode_utf8($_), $self->print_text(\%args);
2198 warn "$me no plain text version exists; sending empty message body"
2205 my $text_part = build MIME::Entity (
2206 'Type' => 'text/plain',
2207 'Encoding' => 'quoted-printable',
2208 'Charset' => 'UTF-8',
2209 #'Encoding' => '7bit',
2211 'Disposition' => 'inline',
2216 if ( $conf->exists($tc.'html') ) {
2217 warn "$me generating HTML invoice"
2220 $args{'from'} =~ /\@([\w\.\-]+)/;
2221 my $from = $1 || 'example.com';
2222 my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2225 my $agentnum = $cust_main ? $cust_main->agentnum
2226 : $self->prospect_main->agentnum;
2227 if ( defined($args{'template'}) && length($args{'template'})
2228 && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
2231 $logo = 'logo_'. $args{'template'}. '.png';
2235 my $image_data = $conf->config_binary( $logo, $agentnum);
2237 push @related_parts, build MIME::Entity
2238 'Type' => 'image/png',
2239 'Encoding' => 'base64',
2240 'Data' => $image_data,
2241 'Filename' => 'logo.png',
2242 'Content-ID' => "<$content_id>",
2245 if ( ref($self) eq 'FS::cust_bill' && $conf->exists('invoice-barcode') ) {
2246 my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
2247 push @related_parts, build MIME::Entity
2248 'Type' => 'image/png',
2249 'Encoding' => 'base64',
2250 'Data' => $self->invoice_barcode(0),
2251 'Filename' => 'barcode.png',
2252 'Content-ID' => "<$barcode_content_id>",
2254 $args{'barcode_cid'} = $barcode_content_id;
2257 $html = $self->print_html({ 'cid'=>$content_id, %args });
2264 warn "$me creating HTML/text multipart message"
2267 $return{'nobody'} = 1;
2269 my $alternative = build MIME::Entity
2270 'Type' => 'multipart/alternative',
2271 #'Encoding' => '7bit',
2272 'Disposition' => 'inline'
2276 $alternative->add_part($text_part);
2279 $alternative->attach(
2280 'Type' => 'text/html',
2281 'Encoding' => 'quoted-printable',
2282 'Data' => [ '<html>',
2285 ' '. encode_entities($return{'subject'}),
2288 ' <body bgcolor="#e8e8e8">',
2289 Encode::encode_utf8($html),
2293 'Disposition' => 'inline',
2294 #'Filename' => 'invoice.pdf',
2297 unshift @related_parts, $alternative;
2299 $related = build MIME::Entity 'Type' => 'multipart/related',
2300 'Encoding' => '7bit';
2302 #false laziness w/Misc::send_email
2303 $related->head->replace('Content-type',
2304 $related->mime_type.
2305 '; boundary="'. $related->head->multipart_boundary. '"'.
2306 '; type=multipart/alternative'
2309 $related->add_part($_) foreach @related_parts;
2313 my @otherparts = ();
2314 if ( ref($self) eq 'FS::cust_bill' && $cust_main->email_csv_cdr ) {
2316 if ( $conf->config('voip-cdr_email_attach') eq 'zip' ) {
2318 my $data = join('', map "$_\n",
2319 $self->call_details(prepend_billed_number=>1)
2322 my $zip = new Archive::Zip;
2323 my $file = $zip->addString( $data, 'usage-'.$self->invnum.'.csv' );
2324 $file->desiredCompressionMethod( COMPRESSION_DEFLATED );
2327 my $SH = IO::Scalar->new(\$zipdata);
2328 my $status = $zip->writeToFileHandle($SH);
2329 die "Error zipping CDR attachment: $!" unless $status == AZ_OK;
2331 push @otherparts, build MIME::Entity
2332 'Type' => 'application/zip',
2333 'Encoding' => 'base64',
2335 'Disposition' => 'attachment',
2336 'Filename' => 'usage-'. $self->invnum. '.zip',
2339 } else { # } elsif ( $conf->config('voip-cdr_email_attach') eq 'csv' ) {
2341 push @otherparts, build MIME::Entity
2342 'Type' => 'text/csv',
2343 'Encoding' => '7bit',
2344 'Data' => [ map { "$_\n" }
2345 $self->call_details('prepend_billed_number' => 1)
2347 'Disposition' => 'attachment',
2348 'Filename' => 'usage-'. $self->invnum. '.csv',
2355 if ( $conf->exists($tc.'email_pdf') ) {
2360 # multipart/alternative
2366 my $pdf = build MIME::Entity $self->mimebuild_pdf(\%args);
2367 push @otherparts, $pdf;
2371 $return{'content-type'} = 'multipart/mixed'; # of the outer container
2373 $return{'mimeparts'} = [ $related, @otherparts ];
2374 $return{'type'} = 'multipart/related'; # of the first part
2376 $return{'mimeparts'} = [ $text_part, @otherparts ];
2377 $return{'type'} = 'text/plain';
2379 } elsif ( $html ) { # no PDF or CSV, strip the outer container
2380 $return{'mimeparts'} = \@related_parts;
2381 $return{'content-type'} = 'multipart/related';
2382 $return{'type'} = 'multipart/alternative';
2383 } else { # no HTML either
2384 $return{'body'} = \@text;
2385 $return{'content-type'} = 'text/plain';
2394 Returns a list suitable for passing to MIME::Entity->build(), representing
2395 this quotation or invoice as PDF attachment.
2402 'Type' => 'application/pdf',
2403 'Encoding' => 'base64',
2404 'Data' => [ $self->print_pdf(@_) ],
2405 'Disposition' => 'attachment',
2406 'Filename' => $self->pdf_filename,
2410 =item postal_mail_fsinc
2412 Sends this invoice to the Freeside Internet Services, Inc. print and mail
2418 use IO::Socket::SSL;
2420 use HTTP::Request::Common qw( POST );
2421 use Cpanel::JSON::XS;
2423 sub postal_mail_fsinc {
2424 my ( $self, %opt ) = @_;
2426 my $url = 'https://ws.freeside.biz/print';
2428 my $cust_main = $self->cust_main;
2429 my $agentnum = $cust_main->agentnum;
2430 my $bill_location = $cust_main->bill_location;
2432 die "Extra charges for international mailing; contact support\@freeside.biz to enable\n"
2433 if $bill_location->country ne 'US';
2435 my $conf = new FS::Conf;
2437 my @company_address = $conf->config('company_address', $agentnum);
2438 my ( $company_address1, $company_address2, $company_city, $company_state, $company_zip );
2439 if ( $company_address[2] =~ /^\s*(\S.*\S)\s*[\s,](\w\w),?\s*(\d{5}(-\d{4})?)\s*$/ ) {
2440 $company_address1 = $company_address[0];
2441 $company_address2 = $company_address[1];
2443 $company_state = $2;
2445 } elsif ( $company_address[1] =~ /^\s*(\S.*\S)\s*[\s,](\w\w),?\s*(\d{5}(-\d{4})?)\s*$/ ) {
2446 $company_address1 = $company_address[0];
2447 $company_address2 = '';
2449 $company_state = $2;
2452 die "Unparsable company_address; contact support\@freeside.biz\n";
2454 $company_city =~ s/,$//;
2456 my $file = $self->print_pdf(%opt, 'no_addresses' => 1);
2457 my $pages = CAM::PDF->new($file)->numPages;
2459 my $ua = LWP::UserAgent->new(
2461 verify_hostname => 0,
2462 SSL_verify_mode => IO::Socket::SSL::SSL_VERIFY_NONE,
2463 SSL_version => 'SSLv3',
2466 my $response = $ua->request( POST $url, [
2467 'support-key' => scalar($conf->config('support-key')),
2468 'file' => encode_base64($file),
2472 'company_name' => scalar( $conf->config('company_name', $agentnum) ),
2473 'company_address1' => $company_address1,
2474 'company_address2' => $company_address2,
2475 'company_city' => $company_city,
2476 'company_state' => $company_state,
2477 'company_zip' => $company_zip,
2478 'company_country' => 'US',
2479 'company_phonenum' => scalar($conf->config('company_phonenum', $agentnum)),
2480 'company_email' => scalar($conf->config('invoice_from', $agentnum)),
2483 'name' => $cust_main->invoice_attn
2484 || $cust_main->contact_firstlast,
2485 'company' => $cust_main->company,
2486 'address1' => $bill_location->address1,
2487 'address2' => $bill_location->address2,
2488 'city' => $bill_location->city,
2489 'state' => $bill_location->state,
2490 'zip' => $bill_location->zip,
2491 'country' => $bill_location->country,
2494 die "Print connection error: ". $response->message.
2495 ' ('. $response->as_string. ")\n"
2496 unless $response->is_success;
2499 my $content = eval { decode_json($response->content) };
2500 die "Print JSON error : $@\n" if $@;
2502 die $content->{error}."\n"
2503 if $content->{error};
2505 #TODO: store this so we can query for a status later
2506 warn "Invoice printed, ID ". $content->{id}. "\n";
2512 =item _items_sections OPTIONS
2514 Generate section information for all items appearing on this invoice.
2515 This will only be called for multi-section invoices.
2517 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
2518 related display records (L<FS::cust_bill_pkg_display>) and organize
2519 them into two groups ("early" and "late" according to whether they come
2520 before or after the total), then into sections. A subtotal is calculated
2523 Section descriptions are returned in sort weight order. Each consists
2524 of a hash containing:
2526 description: the package category name, escaped
2527 subtotal: the total charges in that section
2528 tax_section: a flag indicating that the section contains only tax charges
2529 summarized: same as tax_section, for some reason
2530 sort_weight: the package category's sort weight
2532 If 'condense' is set on the display record, it also contains everything
2533 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
2534 coderefs to generate parts of the invoice. This is not advised.
2536 The method returns two arrayrefs, one of "early" sections and one of "late"
2539 OPTIONS may include:
2541 by_location: a flag to divide the invoice into sections by location.
2542 Each section hash will have a 'location' element containing a hashref of
2543 the location fields (see L<FS::cust_location>). The section description
2544 will be the location label, but the template can use any of the location
2545 fields to create a suitable label.
2547 by_category: a flag to divide the invoice into sections using display
2548 records (see L<FS::cust_bill_pkg_display>). This is the "traditional"
2549 behavior. Each section hash will have a 'category' element containing
2550 the section name from the display record (which probably equals the
2551 category name of the package, but may not in some cases).
2553 summary: a flag indicating that this is a summary-format invoice.
2554 Turning this on has the following effects:
2555 - Ignores display items with the 'summary' flag.
2556 - Places all sections in the "early" group even if they have post_total.
2557 - Creates sections for all non-disabled package categories, even if they
2558 have no charges on this invoice, as well as a section with no name.
2560 escape: an escape function to use for section titles.
2562 extra_sections: an arrayref of additional sections to return after the
2563 sorted list. If there are any of these, section subtotals exclude
2566 format: 'latex', 'html', or 'template' (i.e. text). Not used, but
2567 passed through to C<_condense_section()>.
2571 use vars qw(%pkg_category_cache);
2572 sub _items_sections {
2576 my $escape = $opt{escape};
2577 my @extra_sections = @{ $opt{extra_sections} || [] };
2579 # $subtotal{$locationnum}{$categoryname} = amount.
2580 # if we're not using by_location, $locationnum is undef.
2581 # if we're not using by_category, you guessed it, $categoryname is undef.
2582 # if we're not using either one, we shouldn't be here in the first place...
2584 my %late_subtotal = ();
2587 # About tax items + multisection invoices:
2588 # If either invoice_*summary option is enabled, AND there is a
2589 # package category with the name of the tax, then there will be
2590 # a display record assigning the tax item to that category.
2592 # However, the taxes are always placed in the "Taxes, Surcharges,
2593 # and Fees" section regardless of that. The only effect of the
2594 # display record is to create a subtotal for the summary page.
2597 my $pkg_hash = $self->cust_pkg_hash;
2599 foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2602 my $usage = $cust_bill_pkg->usage;
2605 if ( $opt{by_location} ) {
2606 if ( $cust_bill_pkg->pkgnum ) {
2607 $locationnum = $pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum;
2612 $locationnum = undef;
2615 # as in _items_cust_pkg, if a line item has no display records,
2616 # cust_bill_pkg_display() returns a default record for it
2618 foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
2619 next if ( $display->summary && $opt{summary} );
2621 my $section = $display->section;
2622 my $type = $display->type;
2623 # Set $section = undef if we're sectioning by location and this
2624 # line item _has_ a location (i.e. isn't a fee).
2625 $section = undef if $locationnum;
2627 # set this flag if the section is not tax-only
2628 $not_tax{$locationnum}{$section} = 1
2629 if $cust_bill_pkg->pkgnum or $cust_bill_pkg->feepart;
2631 # there's actually a very important piece of logic buried in here:
2632 # incrementing $late_subtotal{$section} CREATES
2633 # $late_subtotal{$section}. keys(%late_subtotal) is later used
2634 # to define the list of late sections, and likewise keys(%subtotal).
2635 # When _items_cust_bill_pkg is called to generate line items for
2636 # real, it will be called with 'section' => $section for each
2638 if ( $display->post_total && !$opt{summary} ) {
2639 if (! $type || $type eq 'S') {
2640 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2641 if $cust_bill_pkg->setup != 0
2642 || $cust_bill_pkg->setup_show_zero;
2646 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur
2647 if $cust_bill_pkg->recur != 0
2648 || $cust_bill_pkg->recur_show_zero;
2651 if ($type && $type eq 'R') {
2652 $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2653 if $cust_bill_pkg->recur != 0
2654 || $cust_bill_pkg->recur_show_zero;
2657 if ($type && $type eq 'U') {
2658 $late_subtotal{$locationnum}{$section} += $usage
2659 unless scalar(@extra_sections);
2662 } else { # it's a pre-total (normal) section
2664 # skip tax items unless they're explicitly included in a section
2665 next if $cust_bill_pkg->pkgnum == 0 and
2666 ! $cust_bill_pkg->feepart and
2669 if ( $type eq 'S' ) {
2670 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2671 if $cust_bill_pkg->setup != 0
2672 || $cust_bill_pkg->setup_show_zero;
2673 } elsif ( $type eq 'R' ) {
2674 $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2675 if $cust_bill_pkg->recur != 0
2676 || $cust_bill_pkg->recur_show_zero;
2677 } elsif ( $type eq 'U' ) {
2678 $subtotal{$locationnum}{$section} += $usage
2679 unless scalar(@extra_sections);
2680 } elsif ( !$type ) {
2681 $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2682 + $cust_bill_pkg->recur;
2691 %pkg_category_cache = ();
2693 # summary invoices need subtotals for all non-disabled package categories,
2694 # even if they're zero
2695 # but currently assume that there are no location sections, or at least
2696 # that the summary page doesn't care about them
2697 if ( $opt{summary} ) {
2698 foreach my $category (qsearch('pkg_category', {disabled => ''})) {
2699 $subtotal{''}{$category->categoryname} ||= 0;
2701 $subtotal{''}{''} ||= 0;
2705 foreach my $post_total (0,1) {
2707 my $s = $post_total ? \%late_subtotal : \%subtotal;
2708 foreach my $locationnum (keys %$s) {
2709 foreach my $sectionname (keys %{ $s->{$locationnum} }) {
2711 'subtotal' => $s->{$locationnum}{$sectionname},
2714 if ( $locationnum ) {
2715 $section->{'locationnum'} = $locationnum;
2716 my $location = FS::cust_location->by_key($locationnum);
2717 $section->{'description'} = &{ $escape }($location->location_label);
2718 # Better ideas? This will roughly group them by proximity,
2719 # which alpha sorting on any of the address fields won't.
2720 # Sorting by locationnum is meaningless.
2721 # We have to sort on _something_ or the order may change
2722 # randomly from one invoice to the next, which will confuse
2724 $section->{'sort_weight'} = sprintf('%012s',$location->zip) .
2726 $section->{'location'} = {
2727 label_prefix => &{ $escape }($location->label_prefix),
2728 map { $_ => &{ $escape }($location->get($_)) }
2732 $section->{'category'} = $sectionname;
2733 $section->{'description'} = &{ $escape }($sectionname);
2734 if ( _pkg_category($sectionname) ) {
2735 $section->{'sort_weight'} = _pkg_category($sectionname)->weight;
2736 if ( _pkg_category($sectionname)->condense ) {
2737 $section = { %$section, $self->_condense_section($opt{format}) };
2741 if ( !$post_total and !$not_tax{$locationnum}{$sectionname} ) {
2742 # then it's a tax-only section
2743 $section->{'summarized'} = 'Y';
2744 $section->{'tax_section'} = 'Y';
2746 push @these, $section;
2747 } # foreach $sectionname
2748 } #foreach $locationnum
2749 push @these, @extra_sections if $post_total == 0;
2750 # need an alpha sort for location sections, because postal codes can
2752 $sections[ $post_total ] = [ sort {
2753 $opt{'by_location'} ?
2754 ($a->{sort_weight} cmp $b->{sort_weight}) :
2755 ($a->{sort_weight} <=> $b->{sort_weight})
2757 } #foreach $post_total
2759 return @sections; # early, late
2762 #helper subs for above
2766 $self->{cust_pkg} ||= { map { $_->pkgnum => $_ } $self->cust_pkg };
2770 my $categoryname = shift;
2771 $pkg_category_cache{$categoryname} ||=
2772 qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
2775 my %condensed_format = (
2776 'label' => [ qw( Description Qty Amount ) ],
2778 sub { shift->{description} },
2779 sub { shift->{quantity} },
2780 sub { my($href, %opt) = @_;
2781 ($opt{dollar} || ''). $href->{amount};
2784 'align' => [ qw( l r r ) ],
2785 'span' => [ qw( 5 1 1 ) ], # unitprices?
2786 'width' => [ qw( 10.7cm 1.4cm 1.6cm ) ], # don't like this
2789 sub _condense_section {
2790 my ( $self, $format ) = ( shift, shift );
2792 map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
2793 qw( description_generator
2796 total_line_generator
2801 sub _condensed_generator_defaults {
2802 my ( $self, $format ) = ( shift, shift );
2803 return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
2812 sub _condensed_header_generator {
2813 my ( $self, $format ) = ( shift, shift );
2815 my ( $f, $prefix, $suffix, $separator, $column ) =
2816 _condensed_generator_defaults($format);
2818 if ($format eq 'latex') {
2819 $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
2820 $suffix = "\\\\\n\\hline";
2823 sub { my ($d,$a,$s,$w) = @_;
2824 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2826 } elsif ( $format eq 'html' ) {
2827 $prefix = '<th></th>';
2831 sub { my ($d,$a,$s,$w) = @_;
2832 return qq!<th align="$html_align{$a}">$d</th>!;
2840 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2842 &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
2845 $prefix. join($separator, @result). $suffix;
2850 sub _condensed_description_generator {
2851 my ( $self, $format ) = ( shift, shift );
2853 my ( $f, $prefix, $suffix, $separator, $column ) =
2854 _condensed_generator_defaults($format);
2856 my $money_char = '$';
2857 if ($format eq 'latex') {
2858 $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
2860 $separator = " & \n";
2862 sub { my ($d,$a,$s,$w) = @_;
2863 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2865 $money_char = '\\dollar';
2866 }elsif ( $format eq 'html' ) {
2867 $prefix = '"><td align="center"></td>';
2871 sub { my ($d,$a,$s,$w) = @_;
2872 return qq!<td align="$html_align{$a}">$d</td>!;
2874 #$money_char = $conf->config('money_char') || '$';
2875 $money_char = ''; # this is madness
2883 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2885 $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
2887 &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
2888 map { $f->{$_}->[$i] } qw(align span width)
2892 $prefix. join( $separator, @result ). $suffix;
2897 sub _condensed_total_generator {
2898 my ( $self, $format ) = ( shift, shift );
2900 my ( $f, $prefix, $suffix, $separator, $column ) =
2901 _condensed_generator_defaults($format);
2904 if ($format eq 'latex') {
2907 $separator = " & \n";
2909 sub { my ($d,$a,$s,$w) = @_;
2910 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2912 }elsif ( $format eq 'html' ) {
2916 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2918 sub { my ($d,$a,$s,$w) = @_;
2919 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2928 # my $r = &{$f->{fields}->[$i]}(@args);
2929 # $r .= ' Total' unless $i;
2931 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2933 &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
2934 map { $f->{$_}->[$i] } qw(align span width)
2938 $prefix. join( $separator, @result ). $suffix;
2943 =item total_line_generator FORMAT
2945 Returns a coderef used for generation of invoice total line items for this
2946 usage_class. FORMAT is either html or latex
2950 # should not be used: will have issues with hash element names (description vs
2951 # total_item and amount vs total_amount -- another array of functions?
2953 sub _condensed_total_line_generator {
2954 my ( $self, $format ) = ( shift, shift );
2956 my ( $f, $prefix, $suffix, $separator, $column ) =
2957 _condensed_generator_defaults($format);
2960 if ($format eq 'latex') {
2963 $separator = " & \n";
2965 sub { my ($d,$a,$s,$w) = @_;
2966 return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2968 }elsif ( $format eq 'html' ) {
2972 $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2974 sub { my ($d,$a,$s,$w) = @_;
2975 return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2984 foreach (my $i = 0; $f->{label}->[$i]; $i++) {
2986 &{$column}( &{$f->{fields}->[$i]}(@args),
2987 map { $f->{$_}->[$i] } qw(align span width)
2991 $prefix. join( $separator, @result ). $suffix;
2996 =item _items_pkg [ OPTIONS ]
2998 Return line item hashes for each package item on this invoice. Nearly
3001 $self->_items_cust_bill_pkg([ $self->cust_bill_pkg ])
3003 OPTIONS are passed through to _items_cust_bill_pkg, and should include
3004 'format' and 'escape_function' at minimum.
3006 To produce items for a specific invoice section, OPTIONS should include
3007 'section', a hashref containing 'category' and/or 'locationnum' keys.
3009 'section' may also contain a key named 'condensed'. If this is present
3010 and has a true value, _items_pkg will try to merge identical items into items
3011 with 'quantity' equal to the number of items (not the sum of their separate
3012 quantities, for some reason).
3018 # The order of these is important. Bundled line items will be merged into
3019 # the most recent non-hidden item, so it needs to be the one with:
3021 # - the same start date
3022 # - no pkgpart_override
3024 # So: sort by pkgnum,
3026 # then sort the base line item before any overrides
3027 # then sort hidden before non-hidden add-ons
3028 # then sort by override pkgpart (for consistency)
3029 sort { $a->pkgnum <=> $b->pkgnum or
3030 $a->sdate <=> $b->sdate or
3031 ($a->pkgpart_override ? 0 : -1) or
3032 ($b->pkgpart_override ? 0 : 1) or
3033 $b->hidden cmp $a->hidden or
3034 $a->pkgpart_override <=> $b->pkgpart_override
3036 # and of course exclude taxes and fees
3037 grep { $_->pkgnum > 0 } $self->cust_bill_pkg;
3043 my @cust_bill_pkg = grep { $_->feepart } $self->cust_bill_pkg;
3044 my $escape_function = $options{escape_function};
3047 foreach my $cust_bill_pkg (@cust_bill_pkg) {
3048 # cache this, so we don't look it up again in every section
3049 my $part_fee = $cust_bill_pkg->get('part_fee')
3050 || $cust_bill_pkg->part_fee;
3051 $cust_bill_pkg->set('part_fee', $part_fee);
3053 #die "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n"; # might make more sense
3054 warn "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n";
3057 if ( exists($options{section}) and exists($options{section}{category}) )
3059 my $categoryname = $options{section}{category};
3060 # then filter for items that have that section
3061 if ( $part_fee->categoryname ne $categoryname ) {
3062 warn "skipping fee '".$part_fee->itemdesc."'--not in section $categoryname\n" if $DEBUG;
3065 } # otherwise include them all in the main section
3066 # XXX what to do when sectioning by location?
3069 my %base_invnums; # invnum => invoice date
3070 foreach ($cust_bill_pkg->cust_bill_pkg_fee) {
3071 if ($_->base_invnum) {
3072 my $base_bill = FS::cust_bill->by_key($_->base_invnum);
3073 my $base_date = $self->time2str_local('short', $base_bill->_date)
3075 $base_invnums{$_->base_invnum} = $base_date || '';
3078 foreach (sort keys(%base_invnums)) {
3079 next if $_ == $self->invnum;
3080 # per convention, we must escape ext_description lines
3082 &{$escape_function}(
3083 $self->mt('from invoice #[_1] on [_2]', $_, $base_invnums{$_})
3086 my $desc = $part_fee->itemdesc_locale($self->cust_main->locale);
3087 # but not escape the base description line
3090 { feepart => $cust_bill_pkg->feepart,
3091 amount => sprintf('%.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
3092 description => $desc,
3093 ext_description => \@ext_desc
3104 warn "$me _items_pkg searching for all package line items\n"
3107 my @cust_bill_pkg = $self->_items_nontax;
3109 warn "$me _items_pkg filtering line items\n"
3111 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3113 if ($options{section} && $options{section}->{condensed}) {
3115 warn "$me _items_pkg condensing section\n"
3119 local $Storable::canonical = 1;
3120 foreach ( @items ) {
3122 delete $item->{ref};
3123 delete $item->{ext_description};
3124 my $key = freeze($item);
3125 $itemshash{$key} ||= 0;
3126 $itemshash{$key} ++; # += $item->{quantity};
3128 @items = sort { $a->{description} cmp $b->{description} }
3129 map { my $i = thaw($_);
3130 $i->{quantity} = $itemshash{$_};
3132 sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
3138 warn "$me _items_pkg returning ". scalar(@items). " items\n"
3145 return 0 unless $a->itemdesc cmp $b->itemdesc;
3146 return -1 if $b->itemdesc eq 'Tax';
3147 return 1 if $a->itemdesc eq 'Tax';
3148 return -1 if $b->itemdesc eq 'Other surcharges';
3149 return 1 if $a->itemdesc eq 'Other surcharges';
3150 $a->itemdesc cmp $b->itemdesc;
3155 my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum and ! $_->feepart }
3156 $self->cust_bill_pkg;
3157 my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
3159 if ( $self->conf->exists('always_show_tax') ) {
3160 my $itemdesc = $self->conf->config('always_show_tax') || 'Tax';
3161 if (0 == grep { $_->{description} eq $itemdesc } @items) {
3163 { 'description' => $itemdesc,
3170 =item _items_cust_bill_pkg CUST_BILL_PKGS OPTIONS
3172 Takes an arrayref of L<FS::cust_bill_pkg> objects, and returns a
3173 list of hashrefs describing the line items they generate on the invoice.
3175 OPTIONS may include:
3177 format: the invoice format.
3179 escape_function: the function used to escape strings.
3181 DEPRECATED? (expensive, mostly unused?)
3182 format_function: the function used to format CDRs.
3184 section: a hashref containing 'category' and/or 'locationnum'; if this
3185 is present, only returns line items that belong to that category and/or
3186 location (whichever is defined).
3188 multisection: a flag indicating that this is a multisection invoice,
3189 which does something complicated.
3191 Returns a list of hashrefs, each of which may contain:
3193 pkgnum, description, amount, unit_amount, quantity, pkgpart, _is_setup, and
3194 ext_description, which is an arrayref of detail lines to show below
3199 sub _items_cust_bill_pkg {
3201 my $conf = $self->conf;
3202 my $cust_bill_pkgs = shift;
3205 my $format = $opt{format} || '';
3206 my $escape_function = $opt{escape_function} || sub { shift };
3207 my $format_function = $opt{format_function} || '';
3208 my $no_usage = $opt{no_usage} || '';
3209 my $unsquelched = $opt{unsquelched} || ''; #unused
3210 my ($section, $locationnum, $category);
3211 if ( $opt{section} ) {
3212 $category = $opt{section}->{category};
3213 $locationnum = $opt{section}->{locationnum};
3215 my $summary_page = $opt{summary_page} || ''; #unused
3216 my $multisection = defined($category) || defined($locationnum);
3217 # this variable is the value of the config setting, not whether it applies
3218 # to this particular line item.
3219 my $discount_show_always = $conf->exists('discount-show-always');
3221 my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 40;
3223 my $cust_main = $self->cust_main;#for per-agent cust_bill-line_item-ate_style
3225 # for location labels: use default location on the invoice date
3226 my $default_locationnum;
3227 if ( $conf->exists('invoice-all_pkg_addresses') ) {
3228 $default_locationnum = 0; # treat them all as non-default
3229 } elsif ( $self->custnum ) {
3231 my @h_search = FS::h_cust_main->sql_h_search($self->_date);
3232 $h_cust_main = qsearchs({
3233 'table' => 'h_cust_main',
3234 'hashref' => { custnum => $self->custnum },
3235 'extra_sql' => $h_search[1],
3236 'addl_from' => $h_search[3],
3238 $default_locationnum = $h_cust_main->ship_locationnum;
3239 } elsif ( $self->prospectnum ) {
3240 my $cust_location = qsearchs('cust_location',
3241 { prospectnum => $self->prospectnum,
3243 $default_locationnum = $cust_location->locationnum if $cust_location;
3246 my @b = (); # accumulator for the line item hashes that we'll return
3247 my ($s, $r, $u, $d) = ( undef, undef, undef, undef );
3248 # the 'current' line item hashes for setup, recur, usage, discount
3249 foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
3251 # if the current line item is waiting to go out, and the one we're about
3252 # to start is not bundled, then push out the current one and start a new
3255 $d->{amount} = $d->{setup_amount} + $d->{recur_amount};
3257 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3258 if ( $_ && !$cust_bill_pkg->hidden ) {
3259 $_->{amount} = sprintf( "%.2f", $_->{amount} );
3260 $_->{amount} =~ s/^\-0\.00$/0.00/;
3261 if (exists($_->{unit_amount})) {
3262 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3265 # we already decided to create this display line; don't reconsider it
3267 # if $_->{amount} != 0
3268 # || $discount_show_always
3269 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3270 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3276 if ( $locationnum ) {
3277 # this is a location section; skip packages that aren't at this
3279 next if $cust_bill_pkg->pkgnum == 0; # skips fees...
3280 next if $self->cust_pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum
3284 # Consider display records for this item to determine if it belongs
3285 # in this section. Note that if there are no display records, there
3286 # will be a default pseudo-record that includes all charge types
3287 # and has no section name.
3288 my @cust_bill_pkg_display = $cust_bill_pkg->can('cust_bill_pkg_display')
3289 ? $cust_bill_pkg->cust_bill_pkg_display
3290 : ( $cust_bill_pkg );
3292 warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
3293 $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
3296 if ( defined($category) ) {
3297 # then this is a package category section; process all display records
3298 # that belong to this section.
3299 @cust_bill_pkg_display = grep { $_->section eq $category }
3300 @cust_bill_pkg_display;
3302 # otherwise, process all display records that aren't usage summaries
3303 # (I don't think there should be usage summaries if you aren't using
3304 # category sections, but this is the historical behavior)
3305 @cust_bill_pkg_display = grep { !$_->summary }
3306 @cust_bill_pkg_display;
3309 my $classname = ''; # package class name, will fill in later
3311 foreach my $display (@cust_bill_pkg_display) {
3313 warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
3314 $display->billpkgdisplaynum. "\n"
3317 my $type = $display->type;
3319 my $desc = $cust_bill_pkg->desc( $cust_main ? $cust_main->locale : '' );
3320 $desc = substr($desc, 0, $maxlength). '...'
3321 if $format eq 'latex' && length($desc) > $maxlength;
3323 my %details_opt = ( 'format' => $format,
3324 'escape_function' => $escape_function,
3325 'format_function' => $format_function,
3326 'no_usage' => $opt{'no_usage'},
3329 if ( $cust_bill_pkg->pkgnum > 0 ) {
3330 # a "normal" package line item (not a quotation, not a fee, not a tax)
3332 warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
3335 my $cust_pkg = $cust_bill_pkg->cust_pkg;
3336 my $part_pkg = $cust_pkg->part_pkg;
3338 # which pkgpart to show for display purposes?
3339 my $pkgpart = $cust_bill_pkg->pkgpart_override || $cust_pkg->pkgpart;
3341 # start/end dates for invoice formats that do nonstandard
3343 my %item_dates = ();
3344 %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate')
3345 unless $part_pkg->option('disable_line_item_date_ranges',1);
3347 # not normally used, but pass this to the template anyway
3348 $classname = $part_pkg->classname;
3350 if ( (!$type || $type eq 'S')
3351 && ( $cust_bill_pkg->setup != 0
3352 || $cust_bill_pkg->setup_show_zero
3353 || ($discount_show_always and $cust_bill_pkg->unitsetup > 0)
3358 warn "$me _items_cust_bill_pkg adding setup\n"
3361 # append the word 'Setup' to the setup line if there's going to be
3362 # a recur line for the same package (i.e. not a one-time charge)
3364 my $description = $desc;
3365 $description .= ' Setup'
3366 if $cust_bill_pkg->recur != 0
3367 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3368 || $cust_bill_pkg->recur_show_zero;
3370 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3372 if $part_pkg->is_prepaid #for prepaid, "display the validity period
3373 # triggered by the recurring charge freq
3375 && $cust_bill_pkg->recur == 0
3376 && ! $cust_bill_pkg->recur_show_zero;
3379 my @svc_labels = ();
3382 unless ( $part_pkg->hide_svc_detail ) {
3384 # still pass the svc_label through to the template, even if
3385 # not displaying it as an ext_description
3386 @svc_labels = map &{$escape_function}($_),
3387 $cust_pkg->h_labels_short($self->_date,
3390 $self->conf->{locale},
3392 $svc_label = $svc_labels[0];
3396 unless ( $part_pkg->hide_svc_detail
3397 || $cust_bill_pkg->hidden )
3400 push @d, @svc_labels
3401 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3402 # show the location label if it's not the customer's default
3403 # location, and we're not grouping items by location already
3404 if ( $cust_pkg->locationnum != $default_locationnum
3405 and !defined($locationnum) ) {
3406 my $loc = $cust_pkg->location_label;
3407 $loc = substr($loc, 0, $maxlength). '...'
3408 if $format eq 'latex' && length($loc) > $maxlength;
3409 push @d, &{$escape_function}($loc);
3412 } #unless hiding service details
3414 push @d, $cust_bill_pkg->details(%details_opt)
3415 if $cust_bill_pkg->recur == 0;
3417 if ( $cust_bill_pkg->hidden ) {
3418 $s->{amount} += $cust_bill_pkg->setup;
3419 $s->{unit_amount} += $cust_bill_pkg->unitsetup;
3420 push @{ $s->{ext_description} }, @d;
3424 description => $description,
3425 pkgpart => $pkgpart,
3426 pkgnum => $cust_bill_pkg->pkgnum,
3427 amount => $cust_bill_pkg->setup,
3428 setup_show_zero => $cust_bill_pkg->setup_show_zero,
3429 unit_amount => $cust_bill_pkg->unitsetup,
3430 quantity => $cust_bill_pkg->quantity,
3431 ext_description => \@d,
3432 svc_label => ($svc_label || ''),
3433 locationnum => $cust_pkg->locationnum, # sure, why not?
3439 # should we show a recur line?
3440 # if type eq 'S', then NO, because we've been told not to.
3441 # otherwise, show the recur line if:
3442 # - there's a recurring charge
3443 # - or recur_show_zero is on
3444 # - or there's a positive unitrecur (so it's been discounted to zero)
3445 # and discount-show-always is on
3446 if ( ( !$type || $type eq 'R' || $type eq 'U' )
3448 $cust_bill_pkg->recur != 0
3450 || ($discount_show_always and $cust_bill_pkg->unitrecur > 0)
3451 || $cust_bill_pkg->recur_show_zero
3456 warn "$me _items_cust_bill_pkg adding recur/usage\n"
3459 my $is_summary = $display->summary;
3460 my $description = $desc;
3461 if ( $type eq 'U' and defined($r) ) {
3462 # don't just show the same description as the recur line
3463 $description = $self->mt('Usage charges');
3466 my $part_pkg = $cust_pkg->part_pkg;
3468 $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
3472 my @seconds = (); # for display of usage info
3473 my @svc_labels = ();
3476 #at least until cust_bill_pkg has "past" ranges in addition to
3477 #the "future" sdate/edate ones... see #3032
3478 my @dates = ( $self->_date );
3479 my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
3480 push @dates, $prev->sdate if $prev;
3481 push @dates, undef if !$prev;
3483 unless ( $part_pkg->hide_svc_detail ) {
3484 @svc_labels = map &{$escape_function}($_),
3485 $cust_pkg->h_labels_short(@dates,
3487 $self->conf->{locale});
3488 $svc_label = $svc_labels[0];
3491 # show service labels, unless...
3492 # the package is set not to display them
3493 unless ( $part_pkg->hide_svc_detail
3494 # or this is a tax-like line item
3495 || $cust_bill_pkg->itemdesc
3496 # or this is a hidden (bundled) line item
3497 || $cust_bill_pkg->hidden
3498 # or this is a usage summary line
3499 || $is_summary && $type && $type eq 'U'
3500 # or this is a usage line and there's a recurring line
3501 # for the package in the same section (which will
3502 # have service labels already)
3503 || ($type eq 'U' and defined($r))
3507 warn "$me _items_cust_bill_pkg adding service details\n"
3510 push @d, @svc_labels
3511 unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
3512 warn "$me _items_cust_bill_pkg done adding service details\n"
3515 # show the location label if it's not the customer's default
3516 # location, and we're not grouping items by location already
3517 if ( $cust_pkg->locationnum != $default_locationnum
3518 and !defined($locationnum) ) {
3519 my $loc = $cust_pkg->location_label;
3520 $loc = substr($loc, 0, $maxlength). '...'
3521 if $format eq 'latex' && length($loc) > $maxlength;
3522 push @d, &{$escape_function}($loc);
3525 # Display of seconds_since_sqlradacct:
3526 # On the invoice, when processing @detail_items, look for a field
3527 # named 'seconds'. This will contain total seconds for each
3528 # service, in the same order as @ext_description. For services
3529 # that don't support this it will show undef.
3530 if ( $conf->exists('svc_acct-usage_seconds')
3531 and ! $cust_bill_pkg->pkgpart_override ) {
3532 foreach my $cust_svc (
3533 $cust_pkg->h_cust_svc(@dates, 'I')
3536 # eval because not having any part_export_usage exports
3537 # is a fatal error, last_bill/_date because that's how
3538 # sqlradius_hour billing does it
3540 $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
3542 push @seconds, $sec;
3544 } #if svc_acct-usage_seconds
3546 } # if we are showing service labels
3548 unless ( $is_summary ) {
3549 warn "$me _items_cust_bill_pkg adding details\n"
3552 #instead of omitting details entirely in this case (unwanted side
3553 # effects), just omit CDRs
3554 $details_opt{'no_usage'} = 1
3555 if $type && $type eq 'R';
3557 push @d, $cust_bill_pkg->details(%details_opt);
3560 warn "$me _items_cust_bill_pkg calculating amount\n"
3565 $amount = $cust_bill_pkg->recur;
3566 } elsif ($type eq 'R') {
3567 $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
3568 } elsif ($type eq 'U') {
3569 $amount = $cust_bill_pkg->usage;
3572 if ( !$type || $type eq 'R' ) {
3574 warn "$me _items_cust_bill_pkg adding recur\n"
3578 ( $cust_bill_pkg->unitrecur > 0 ) ? $cust_bill_pkg->unitrecur
3581 if ( $cust_bill_pkg->hidden ) {
3582 $r->{amount} += $amount;
3583 $r->{unit_amount} += $unit_amount;
3584 push @{ $r->{ext_description} }, @d;
3587 description => $description,
3588 pkgpart => $pkgpart,
3589 pkgnum => $cust_bill_pkg->pkgnum,
3591 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3592 unit_amount => $unit_amount,
3593 quantity => $cust_bill_pkg->quantity,
3595 ext_description => \@d,
3596 svc_label => ($svc_label || ''),
3597 locationnum => $cust_pkg->locationnum,
3599 $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
3602 } else { # $type eq 'U'
3604 warn "$me _items_cust_bill_pkg adding usage\n"
3607 if ( $cust_bill_pkg->hidden and defined($u) ) {
3608 # if this is a hidden package and there's already a usage
3609 # line for the bundle, add this package's total amount and
3610 # usage details to it
3611 $u->{amount} += $amount;
3612 push @{ $u->{ext_description} }, @d;
3613 } elsif ( $amount ) {
3614 # create a new usage line
3616 description => $description,
3617 pkgpart => $pkgpart,
3618 pkgnum => $cust_bill_pkg->pkgnum,
3621 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3623 ext_description => \@d,
3624 locationnum => $cust_pkg->locationnum,
3626 } # else this has no usage, so don't create a usage section
3629 } # recurring or usage with recurring charge
3631 } else { # taxes and fees
3633 warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
3636 # items of this kind should normally not have sdate/edate.
3638 'description' => $desc,
3639 'amount' => sprintf('%.2f', $cust_bill_pkg->setup
3640 + $cust_bill_pkg->recur)
3643 } # if package line item / other line item
3645 # decide whether to show active discounts here
3647 # case 1: we are showing a single line for the package
3649 # case 2: we are showing a setup line for a package that has
3650 # no base recurring fee
3651 or ( $type eq 'S' and $cust_bill_pkg->unitrecur == 0 )
3652 # case 3: we are showing a recur line for a package that has
3653 # a base recurring fee
3654 or ( $type eq 'R' and $cust_bill_pkg->unitrecur > 0 )
3657 my $item_discount = $cust_bill_pkg->_item_discount;
3658 if ( $item_discount ) {
3659 # $item_discount->{amount} is negative
3661 if ( $d and $cust_bill_pkg->hidden ) {
3662 $d->{setup_amount} += $item_discount->{setup_amount};
3663 $d->{recur_amount} += $item_discount->{recur_amount};
3665 $d = $item_discount;
3666 $_ = &{$escape_function}($_) foreach @{ $d->{ext_description} };
3669 # update the active line (before the discount) to show the
3670 # original price (whether this is a hidden line or not)
3672 $s->{amount} -= $item_discount->{setup_amount} if $s;
3673 $r->{amount} -= $item_discount->{recur_amount} if $r;
3675 } # if there are any discounts
3676 } # if this is an appropriate place to show discounts
3678 } # foreach $display
3682 # discount amount is internally split up
3684 $d->{amount} = $d->{setup_amount} + $d->{recur_amount};
3687 foreach ( $s, $r, ($opt{skip_usage} ? () : $u ), $d ) {
3689 $_->{amount} = sprintf( "%.2f", $_->{amount} ),
3690 if exists($_->{amount});
3691 $_->{amount} =~ s/^\-0\.00$/0.00/;
3692 if (exists($_->{unit_amount})) {
3693 $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3697 #if $_->{amount} != 0
3698 # || $discount_show_always
3699 # || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3700 # || ( $_->{_is_setup} && $_->{setup_show_zero} )
3704 warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
3711 =item _items_discounts_avail
3713 Returns an array of line item hashrefs representing available term discounts
3714 for this invoice. This makes the same assumptions that apply to term
3715 discounts in general: that the package is billed monthly, at a flat rate,
3716 with no usage charges. A prorated first month will be handled, as will
3717 a setup fee if the discount is allowed to apply to setup fees.
3721 sub _items_discounts_avail {
3724 #maybe move this method from cust_bill when quotations support discount_plans
3725 return () unless $self->can('discount_plans');
3726 my %plans = $self->discount_plans;
3728 my $list_pkgnums = 0; # if any packages are not eligible for all discounts
3729 $list_pkgnums = grep { $_->list_pkgnums } values %plans;
3733 my $plan = $plans{$months};
3735 my $term_total = sprintf('%.2f', $plan->discounted_total);
3736 my $percent = sprintf('%.0f',
3737 100 * (1 - $term_total / $plan->base_total) );
3738 my $permonth = sprintf('%.2f', $term_total / $months);
3739 my $detail = $self->mt('discount on item'). ' '.
3740 join(', ', map { "#$_" } $plan->pkgnums)
3743 # discounts for non-integer months don't work anyway
3744 $months = sprintf("%d", $months);
3747 description => $self->mt('Save [_1]% by paying for [_2] months',
3749 amount => $self->mt('[_1] ([_2] per month)',
3750 $term_total, $money_char.$permonth),
3751 ext_description => ($detail || ''),
3754 sort { $b <=> $a } keys %plans;