X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2FTemplate_Mixin.pm;h=f70ac3ce2ab8d64dc982728d88fb6c75c06ea192;hb=b6538b4641f900da4892d8c44292befb71188822;hp=afa17fca17752ca966696560bc78ec2429659d51;hpb=a455b3d4dd10624e223705477f55ef09ed81a85f;p=freeside.git diff --git a/FS/FS/Template_Mixin.pm b/FS/FS/Template_Mixin.pm index afa17fca1..f70ac3ce2 100644 --- a/FS/FS/Template_Mixin.pm +++ b/FS/FS/Template_Mixin.pm @@ -2,7 +2,9 @@ package FS::Template_Mixin; use strict; use vars qw( $DEBUG $me - $money_char ); + $money_char + $date_format + ); # but NOT $conf use vars qw( $invoice_lines @buf ); #yuck use List::Util qw(sum); @@ -26,7 +28,8 @@ $DEBUG = 0; $me = '[FS::Template_Mixin]'; FS::UID->install_callback( sub { my $conf = new FS::Conf; #global - $money_char = $conf->config('money_char') || '$'; + $money_char = $conf->config('money_char') || '$'; + $date_format = $conf->config('date_format') || '%x'; #/YY } ); =item conf [ MODE ] @@ -217,26 +220,82 @@ Internal method - returns a filled-in template for this invoice as a scalar. See print_ps and print_pdf for methods that return PostScript and PDF output. -Non optional options include - format - latex, html, template +Required options -Optional options include +=over 4 -template - a value used as a suffix for a configuration template. Please -don't use this. +=item format -time - a value used to control the printing of overdue messages. The +The B option is required and should be set to html, latex (print and PDF) or template (plaintext). + +=back + +Additional options + +=over 4 + +=item notice_name + +Overrides "Invoice" as the name of the sent document. + +=item today + +Used to control the printing of overdue messages. The default is now. It isn't the date of the invoice; that's the `_date' field. It is specified as a UNIX timestamp; see L. Also see L and L for conversion functions. -cid - +=item logo_file + +Logo file (path to temporary EPS file on the local filesystem) + +=item cid + +CID for inline (emailed) images (logo) + +=item locale + +Override customer's locale + +=item unsquelch_cdr + +Overrides any per customer cdr squelching when true + +=item no_number + +Supress the (invoice, quotation, statement, etc.) number + +=item no_date + +Supress the date + +=item no_coupon + +Supress the payment coupon + +=item barcode_file + +Barcode file (path to temporary EPS file on the local filesystem) + +=item barcode_img + +Flag indicating the barcode image should be a link (normal HTML dipaly) + +=item barcode_cid + +Barcode CID for inline (emailed) images -unsquelch_cdr - overrides any per customer cdr squelching when true +=item preref_callback -notice_name - overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required) +Coderef run for each line item, code should return HTML to be displayed +before that line item (quotations only) -locale - override customer's locale +=item template + +Dprecated. Used as a suffix for a configuration template. Please +don't use this, it deprecated in favor of more flexible alternatives. + +=back =cut @@ -627,18 +686,6 @@ sub print_generic { #my $balance_due = $self->owed + $pr_total - $cr_total; my $balance_due = $self->owed + $pr_total; - #these are used on the summary page only - - # the customer's current balance as shown on the invoice before this one - $invoice_data{'true_previous_balance'} = sprintf("%.2f", ($self->previous_balance || 0) ); - - # the change in balance from that invoice to this one - $invoice_data{'balance_adjustments'} = sprintf("%.2f", ($self->previous_balance || 0) - ($self->billing_balance || 0) ); - - # the sum of amount owed on all previous invoices - # ($pr_total is used elsewhere but not as $previous_balance) - $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total); - # the sum of amount owed on all invoices # (this is used in the summary & on the payment coupon) $invoice_data{'balance'} = sprintf("%.2f", $balance_due); @@ -649,8 +696,69 @@ sub print_generic { if ( $self->custnum && $self->invnum ) { - if ( $self->previous_bill ) { - my $last_bill = $self->previous_bill; + my $last_bill = $self->previous_bill; + if ( $last_bill ) { + + # "balance_date_range" unfortunately is unsuitable for this, since it + # cares about application dates. We want to know the sum of all + # _top-level transactions_ dated before the last invoice. + my @sql = ( + 'SELECT SUM(charged) FROM cust_bill WHERE _date <= ? AND custnum = ?', + 'SELECT -1*SUM(amount) FROM cust_credit WHERE _date <= ? AND custnum = ?', + 'SELECT -1*SUM(paid) FROM cust_pay WHERE _date <= ? AND custnum = ?', + 'SELECT SUM(refund) FROM cust_refund WHERE _date <= ? AND custnum = ?', + ); + + # the customer's current balance immediately after generating the last + # bill + + my $last_bill_balance = $last_bill->charged; + foreach (@sql) { + #warn "$_\n"; + my $delta = FS::Record->scalar_sql( + $_, + $last_bill->_date - 1, + $self->custnum, + ); + #warn "$delta\n"; + $last_bill_balance += $delta; + } + + $last_bill_balance = sprintf("%.2f", $last_bill_balance); + + warn sprintf("LAST BILL: INVNUM %d, DATE %s, BALANCE %.2f\n\n", + $last_bill->invnum, + $self->time2str_local('%D', $last_bill->_date), + $last_bill_balance + ) if $DEBUG > 0; + # ("true_previous_balance" is a terrible name, but at least it's no + # longer stored in the database) + $invoice_data{'true_previous_balance'} = $last_bill_balance; + + # the change in balance from immediately after that invoice + # to immediately before this one + my $before_this_bill_balance = 0; + foreach (@sql) { + #warn "$_\n"; + my $delta = FS::Record->scalar_sql( + $_, + $self->_date - 1, + $self->custnum, + ); + #warn "$delta\n"; + $before_this_bill_balance += $delta; + } + $invoice_data{'balance_adjustments'} = + sprintf("%.2f", $last_bill_balance - $before_this_bill_balance); + + warn sprintf("BALANCE ADJUSTMENTS: %.2f\n\n", + $invoice_data{'balance_adjustments'} + ) if $DEBUG > 0; + + # the sum of amount owed on all previous invoices + # ($pr_total is used elsewhere but not as $previous_balance) + $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total); + $invoice_data{'last_bill'} = { '_date' => $last_bill->_date, #unformatted }; @@ -687,9 +795,15 @@ sub print_generic { } $invoice_data{'previous_payments'} = \@payments; $invoice_data{'previous_credits'} = \@credits; + } else { + # there is no $last_bill + $invoice_data{'true_previous_balance'} = + $invoice_data{'balance_adjustments'} = + $invoice_data{'previous_balance'} = '0.00'; + $invoice_data{'previous_payments'} = []; + $invoice_data{'previous_credits'} = []; } - - } + } # if this is an invoice my $summarypage = ''; if ( $conf->exists('invoice_usesummary', $agentnum) ) { @@ -868,7 +982,7 @@ sub print_generic { # we haven't yet changed the template to take advantage of that, so for # now, treat them as mutually exclusive. my %section_method = ( by_category => 1 ); - if ( $conf->exists($tc.'sections_by_location') ) { + if ( $conf->config($tc.'sections_method') eq 'location' ) { %section_method = ( by_location => 1 ); } my ($early, $late) = @@ -926,6 +1040,36 @@ sub print_generic { sprintf('%.2f', sum( @charges ) || 0); } + # start setting up summary subtotals + my @summary_subtotals; + my $method = $conf->config('summary_subtotals_method'); + if ( $method and $method ne $conf->config($tc.'sections_method') ) { + # then re-section them by the correct method + my %section_method = ( by_category => 1 ); + if ( $conf->config('summary_subtotals_method') eq 'location' ) { + %section_method = ( by_location => 1 ); + } + my ($early, $late) = + $self->_items_sections( 'summary' => $summarypage, + 'escape' => $escape_function_nonbsp, + 'extra_sections' => $extra_sections, + 'format' => $format, + %section_method + ); + foreach ( @$early ) { + next if $_->{subtotal} == 0; + $_->{subtotal} = $other_money_char.sprintf('%.2f', $_->{subtotal}); + push @summary_subtotals, $_; + } + } else { + # subtotal sectioning is the same as for the actual invoice sections + @summary_subtotals = @sections; + } + + # Hereafter, push sections to both @sections and @summary_subtotals + # if they belong in both places (e.g. tax section). Late sections are + # never in @summary_subtotals. + # previous invoice balances in the Previous Charges section if there # is one, otherwise in the main detail section # (except if summary_only is enabled, don't show them at all) @@ -1018,6 +1162,7 @@ sub print_generic { $options{'summary_page'} = $summarypage; $options{'skip_usage'} = scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections; + $options{'preref_callback'} = $params{'preref_callback'}; warn "$me searching for line items\n" if $DEBUG > 1; @@ -1025,39 +1170,25 @@ sub print_generic { foreach my $line_item ( $self->_items_pkg(%options), $self->_items_fee(%options) ) { - warn "$me adding line item $line_item\n" + warn "$me adding line item ". + join(', ', map "$_=>".$line_item->{$_}, keys %$line_item). "\n" if $DEBUG > 1; - my $detail = { - ext_description => [], - }; - $detail->{'ref'} = $line_item->{'pkgnum'}; - $detail->{'pkgpart'} = $line_item->{'pkgpart'}; - $detail->{'quantity'} = $line_item->{'quantity'}; - $detail->{'section'} = $section; - $detail->{'description'} = &$escape_function($line_item->{'description'}); - if ( exists $line_item->{'ext_description'} ) { - @{$detail->{'ext_description'}} = @{$line_item->{'ext_description'}}; - } - $detail->{'amount'} = ( $old_latex ? '' : $money_char ). - $line_item->{'amount'}; - if ( exists $line_item->{'unit_amount'} ) { - $detail->{'unit_amount'} = ( $old_latex ? '' : $money_char ). - $line_item->{'unit_amount'}; + $line_item->{'ref'} = $line_item->{'pkgnum'}; + $line_item->{'product_code'} = $line_item->{'pkgpart'} || 'N/A'; # mt()? + $line_item->{'section'} = $section; + $line_item->{'description'} = &$escape_function($line_item->{'description'}); + if (!$old_latex) { # dubious; templates should provide this + $line_item->{'amount'} = $money_char.$line_item->{'amount'}; + $line_item->{'unit_amount'} = $money_char.$line_item->{'unit_amount'}; } - $detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A'; - - $detail->{'sdate'} = $line_item->{'sdate'}; - $detail->{'edate'} = $line_item->{'edate'}; - $detail->{'seconds'} = $line_item->{'seconds'}; - $detail->{'svc_label'} = $line_item->{'svc_label'}; - $detail->{'usage_item'} = $line_item->{'usage_item'}; - - push @detail_items, $detail; - push @buf, ( [ $detail->{'description'}, + $line_item->{'ext_description'} ||= []; + + push @detail_items, $line_item; + push @buf, ( [ $line_item->{'description'}, $money_char. sprintf("%10.2f", $line_item->{'amount'}), ], - map { [ " ". $_, '' ] } @{$detail->{'ext_description'}}, + map { [ " ". $_, '' ] } @{$line_item->{'ext_description'}}, ); } @@ -1079,6 +1210,7 @@ sub print_generic { # if there's anything in the Previous Charges section, prepend it to the list if ( $pr_total and $previous_section ne $default_section ) { unshift @sections, $previous_section; + # but not @summary_subtotals } warn "$me adding taxes\n" @@ -1131,8 +1263,11 @@ sub print_generic { sprintf('%.2f', $taxtotal); $tax_section->{'pretotal'} = 'New charges sub-total '. $total->{'total_amount'}; - push @sections, $tax_section if $taxtotal; - }else{ + if ( $taxtotal ) { + push @sections, $tax_section; + push @summary_subtotals, $tax_section; + } + } else { unshift @total_items, $total; } } @@ -1284,6 +1419,8 @@ sub print_generic { sprintf('%.2f', $adjusttotal); push @sections, $adjust_section unless $adjust_section->{sort_weight}; + # do not summarize; adjustments there are shown according to + # different rules } # create Balance Due message @@ -1362,7 +1499,7 @@ sub print_generic { 'no_subtotal' => 1, }; - push @sections, $discount_section; + push @sections, $discount_section; # do not summarize push @detail_items, map { +{ 'ref' => '', #should this be something else? 'section' => $discount_section, @@ -1372,23 +1509,7 @@ sub print_generic { } } @discounts_avail; } - my @summary_subtotals; - # the templates say "$_->{tax_section} || !$_->{summarized}" - # except 'summarized' is only true when tax_section is true, so this - # is always true, so what's the deal? - foreach my $s (@sections) { - # not to include in the "summary of new charges" block: - # finance charges, adjustments, previous charges, - # and itemized phone usage sections - if ( $s eq $adjust_section or - ($s eq $previous_section and $s ne $default_section) or - ($invoice_data{'finance_section'} and - $invoice_data{'finance_section'} eq $s->{description}) or - $s->{'description'} =~ /^\d+ $/ ) { - next; - } - push @summary_subtotals, $s; - } + # not adding any more sections after this $invoice_data{summary_subtotals} = \@summary_subtotals; # usage subtotals @@ -1396,7 +1517,7 @@ sub print_generic { and $self->can('_items_usage_class_summary') ) { my @usage_subtotals = $self->_items_usage_class_summary(escape => $escape_function); if ( @usage_subtotals ) { - unshift @sections, $usage_subtotals[0]->{section}; + unshift @sections, $usage_subtotals[0]->{section}; # do not summarize unshift @detail_items, @usage_subtotals; } } @@ -1422,6 +1543,17 @@ sub print_generic { $invoice_data{monthly_history} = [ \@sorted_months, \@sorted_amounts ]; } + # service locations: another option for template customization + my %location_info; + foreach my $item (@detail_items) { + if ( $item->{locationnum} ) { + $location_info{ $item->{locationnum} } ||= { + FS::cust_location->by_key( $item->{locationnum} )->location_hash + }; + } + } + $invoice_data{location_info} = \%location_info; + # debugging hook: call this with 'diag' => 1 to just get a hash of # the invoice variables return \%invoice_data if ( $params{'diag'} ); @@ -1778,7 +1910,8 @@ sub credit_balance_msg { =item _date_pretty -Returns a string with the date, for example: "3/20/2008" +Returns a string with the date, for example: "3/20/2008", localized for the +customer. Use _date_pretty_unlocalized for non-end-customer display use. =cut @@ -1787,6 +1920,18 @@ sub _date_pretty { $self->time2str_local('short', $self->_date); } +=item _date_pretty_unlocalized + +Returns a string with the date, for example: "3/20/2008", in the format +configured for the back-office. Use _date_pretty for end-customer display use. + +=cut + +sub _date_pretty_unlocalized { + my $self = shift; + time2str($date_format, $self->_date); +} + =item _items_sections OPTIONS Generate section information for all items appearing on this invoice. @@ -1944,27 +2089,20 @@ sub _items_sections { ! $cust_bill_pkg->feepart and ! $section; - if (! $type || $type eq 'S') { + if ( $type eq 'S' ) { $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup if $cust_bill_pkg->setup != 0 || $cust_bill_pkg->setup_show_zero; - } - - if (! $type) { - $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - if $cust_bill_pkg->recur != 0 - || $cust_bill_pkg->recur_show_zero; - } - - if ($type && $type eq 'R') { + } elsif ( $type eq 'R' ) { $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage if $cust_bill_pkg->recur != 0 || $cust_bill_pkg->recur_show_zero; - } - - if ($type && $type eq 'U') { + } elsif ( $type eq 'U' ) { $subtotal{$locationnum}{$section} += $usage unless scalar(@extra_sections); + } elsif ( !$type ) { + $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup + + $cust_bill_pkg->recur; } } @@ -2010,8 +2148,9 @@ sub _items_sections { $section->{'sort_weight'} = sprintf('%012s',$location->zip) . $locationnum; $section->{'location'} = { + label_prefix => &{ $escape }($location->label_prefix), map { $_ => &{ $escape }($location->get($_)) } - $location->fields + $location->fields }; } else { $section->{'category'} = $sectionname; @@ -2460,6 +2599,9 @@ location (whichever is defined). multisection: a flag indicating that this is a multisection invoice, which does something complicated. +preref_callback: coderef run for each line item, code should return HTML to be +displayed before that line item (quotations only) + Returns a list of hashrefs, each of which may contain: pkgnum, description, amount, unit_amount, quantity, pkgpart, _is_setup, and @@ -2580,12 +2722,18 @@ sub _items_cust_bill_pkg { || $discount_show_always || $cust_bill_pkg->recur_show_zero; push @b, { + 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref 'description' => $description, 'amount' => sprintf("%.2f", $cust_bill_pkg->setup), + 'preref_html' => ( $opt{preref_callback} + ? &{ $opt{preref_callback} }( $cust_bill_pkg ) + : '' + ), }; } if ( $cust_bill_pkg->recur != 0 ) { push @b, { + 'pkgnum' => $cust_bill_pkg->pkgpart, #so it displays in Ref 'description' => "$desc (". $cust_bill_pkg->part_pkg->freq_pretty.")", 'amount' => sprintf("%.2f", $cust_bill_pkg->recur), }; @@ -2683,6 +2831,7 @@ sub _items_cust_bill_pkg { quantity => $cust_bill_pkg->quantity, ext_description => \@d, svc_label => ($svc_label || ''), + locationnum => $cust_pkg->locationnum, # sure, why not? }; }; @@ -2835,6 +2984,7 @@ sub _items_cust_bill_pkg { %item_dates, ext_description => \@d, svc_label => ($svc_label || ''), + locationnum => $cust_pkg->locationnum, }; $r->{'seconds'} = \@seconds if grep {defined $_} @seconds; } @@ -2861,6 +3011,7 @@ sub _items_cust_bill_pkg { recur_show_zero => $cust_bill_pkg->recur_show_zero, %item_dates, ext_description => \@d, + locationnum => $cust_pkg->locationnum, }; } # else this has no usage, so don't create a usage section }