FS/FS/Template_Mixin.pm

   1 package FS::Template_Mixin;
   2
   3 use strict;
   4 use vars qw( $DEBUG $me
   5              $money_char
   6              $date_format
   7            );
   8              # but NOT $conf
   9 use vars qw( $invoice_lines @buf ); #yuck
  10 use List::Util qw(sum);
  11 use Date::Format;
  12 use Date::Language;
  13 use Text::Template 1.20;
  14 use File::Temp 0.14;
  15 use HTML::Entities;
  16 use Locale::Country;
  17 use Cwd;
  18 use FS::UID;
  19 use FS::Record qw( qsearch qsearchs );
  20 use FS::Conf;
  21 use FS::Misc qw( generate_ps generate_pdf );
  22 use FS::pkg_category;
  23 use FS::pkg_class;
  24 use FS::invoice_mode;
  25 use FS::L10N;
  26
  27 $DEBUG = 0;
  28 $me = '[FS::Template_Mixin]';
  29 FS::UID->install_callback( sub {
  30   my $conf = new FS::Conf; #global
  31   $money_char  = $conf->config('money_char')  || '$';
  32   $date_format = $conf->config('date_format') || '%x'; #/YY
  33 } );
  34
  35 =item conf [ MODE ]
  36
  37 Returns a configuration handle (L<FS::Conf>) set to the customer's locale.
  38
  39 If the "mode" pseudo-field is set on the object, the configuration handle
  40 will be an L<FS::invoice_conf> for that invoice mode (and the customer's
  41 locale).
  42
  43 =cut
  44
  45 sub conf {
  46   my $self = shift;
  47   my $mode = $self->get('mode');
  48   if ($self->{_conf} and !defined($mode)) {
  49     return $self->{_conf};
  50   }
  51
  52   my $cust_main = $self->cust_main;
  53   my $locale = $cust_main ? $cust_main->locale : '';
  54   my $conf;
  55   if ( $mode ) {
  56     if ( ref $mode and $mode->isa('FS::invoice_mode') ) {
  57       $mode = $mode->modenum;
  58     } elsif ( $mode =~ /\D/ ) {
  59       die "invalid invoice mode $mode";
  60     }
  61     $conf = qsearchs('invoice_conf', { modenum => $mode, locale => $locale });
  62     if (!$conf) {
  63       $conf = qsearchs('invoice_conf', { modenum => $mode, locale => '' });
  64       # it doesn't have a locale, but system conf still might
  65       $conf->set('locale' => $locale) if $conf;
  66     }
  67   }
  68   # if $mode is unspecified, or if there is no invoice_conf matching this mode
  69   # and locale, then use the system config only (but with the locale)
  70   $conf ||= FS::Conf->new({ 'locale' => $locale });
  71   # cache it
  72   return $self->{_conf} = $conf;
  73 }
  74
  75 =item print_text OPTIONS
  76
  77 Returns an text invoice, as a list of lines.
  78
  79 Options can be passed as a hash.
  80
  81 I<time>, if specified, is used to control the printing of overdue messages.  The
  82 default is now.  It isn't the date of the invoice; that's the `_date' field.
  83 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
  84 L<Time::Local> and L<Date::Parse> for conversion functions.
  85
  86 I<template>, if specified, is the name of a suffix for alternate invoices.
  87
  88 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
  89
  90 =cut
  91
  92 sub print_text {
  93   my $self = shift;
  94   my %params;
  95   if ( ref($_[0]) ) {
  96     %params = %{ shift() };
  97   } else {
  98     %params = @_;
  99   }
 100
 101   $params{'format'} = 'template'; # for some reason
 102
 103   $self->print_generic( %params );
 104 }
 105
 106 =item print_latex HASHREF
 107
 108 Internal method - returns a filename of a filled-in LaTeX template for this
 109 invoice (Note: add ".tex" to get the actual filename), and a filename of
 110 an associated logo (with the .eps extension included).
 111
 112 See print_ps and print_pdf for methods that return PostScript and PDF output.
 113
 114 Options can be passed as a hash.
 115
 116 I<time>, if specified, is used to control the printing of overdue messages.  The
 117 default is now.  It isn't the date of the invoice; that's the `_date' field.
 118 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
 119 L<Time::Local> and L<Date::Parse> for conversion functions.
 120
 121 I<template>, if specified, is the name of a suffix for alternate invoices.
 122 This is strongly deprecated; see L<FS::invoice_conf> for the right way to
 123 customize invoice templates for different purposes.
 124
 125 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
 126
 127 =cut
 128
 129 sub print_latex {
 130   my $self = shift;
 131   my %params;
 132
 133   if ( ref($_[0]) ) {
 134     %params = %{ shift() };
 135   } else {
 136     %params = @_;
 137   }
 138
 139   $params{'format'} = 'latex';
 140   my $conf = $self->conf;
 141
 142   # this needs to go away
 143   my $template = $params{'template'};
 144   # and this especially
 145   $template ||= $self->_agent_template
 146     if $self->can('_agent_template');
 147
 148   my $pkey = $self->primary_key;
 149   my $tmp_template = $self->table. '.'. $self->$pkey. '.XXXXXXXX';
 150
 151   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
 152   my $lh = new File::Temp(
 153     TEMPLATE => $tmp_template,
 154     DIR      => $dir,
 155     SUFFIX   => '.eps',
 156     UNLINK   => 0,
 157   ) or die "can't open temp file: $!\n";
 158
 159   my $agentnum = $self->agentnum;
 160
 161   if ( $template && $conf->exists("logo_${template}.eps", $agentnum) ) {
 162     print $lh $conf->config_binary("logo_${template}.eps", $agentnum)
 163       or die "can't write temp file: $!\n";
 164   } else {
 165     print $lh $conf->config_binary('logo.eps', $agentnum)
 166       or die "can't write temp file: $!\n";
 167   }
 168   close $lh;
 169   $params{'logo_file'} = $lh->filename;
 170
 171   if( $conf->exists('invoice-barcode')
 172         && $self->can('invoice_barcode')
 173         && $self->invnum ) { # don't try to barcode statements
 174       my $png_file = $self->invoice_barcode($dir);
 175       my $eps_file = $png_file;
 176       $eps_file =~ s/\.png$/.eps/g;
 177       $png_file =~ /(barcode.*png)/;
 178       $png_file = $1;
 179       $eps_file =~ /(barcode.*eps)/;
 180       $eps_file = $1;
 181
 182       my $curr_dir = cwd();
 183       chdir($dir);
 184       # after painfuly long experimentation, it was determined that sam2p won't
 185       # accept : and other chars in the path, no matter how hard I tried to
 186       # escape them, hence the chdir (and chdir back, just to be safe)
 187       system('sam2p', '-j:quiet', $png_file, 'EPS:', $eps_file ) == 0
 188         or die "sam2p failed: $!\n";
 189       unlink($png_file);
 190       chdir($curr_dir);
 191
 192       $params{'barcode_file'} = $eps_file;
 193   }
 194
 195   my @filled_in = $self->print_generic( %params );
 196
 197   my $fh = new File::Temp( TEMPLATE => $tmp_template,
 198                            DIR      => $dir,
 199                            SUFFIX   => '.tex',
 200                            UNLINK   => 0,
 201                          ) or die "can't open temp file: $!\n";
 202   binmode($fh, ':utf8'); # language support
 203   print $fh join('', @filled_in );
 204   close $fh;
 205
 206   $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
 207   return ($1, $params{'logo_file'}, $params{'barcode_file'});
 208
 209 }
 210
 211 sub agentnum {
 212   my $self = shift;
 213   my $cust_main = $self->cust_main;
 214   $cust_main ? $cust_main->agentnum : $self->prospect_main->agentnum;
 215 }
 216
 217 =item print_generic OPTION => VALUE ...
 218
 219 Internal method - returns a filled-in template for this invoice as a scalar.
 220
 221 See print_ps and print_pdf for methods that return PostScript and PDF output.
 222
 223 Required options
 224
 225 =over 4
 226
 227 =item format
 228
 229 The B<format> option is required and should be set to html, latex (print and PDF) or template (plaintext).
 230
 231 =back
 232
 233 Additional options
 234
 235 =over 4
 236
 237 =item notice_name
 238
 239 Overrides "Invoice" as the name of the sent document.
 240
 241 =item today
 242
 243 Used to control the printing of overdue messages.  The
 244 default is now.  It isn't the date of the invoice; that's the `_date' field.
 245 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
 246 L<Time::Local> and L<Date::Parse> for conversion functions.
 247
 248 =item logo_file
 249
 250 Logo file (path to temporary EPS file on the local filesystem)
 251
 252 =item cid
 253
 254 CID for inline (emailed) images (logo)
 255
 256 =item locale
 257
 258 Override customer's locale
 259
 260 =item unsquelch_cdr
 261
 262 Overrides any per customer cdr squelching when true
 263
 264 =item no_number
 265
 266 Supress the (invoice, quotation, statement, etc.) number
 267
 268 =item no_date
 269
 270 Supress the date
 271
 272 =item no_coupon
 273
 274 Supress the payment coupon
 275
 276 =item barcode_file
 277
 278 Barcode file (path to temporary EPS file on the local filesystem)
 279
 280 =item barcode_img
 281
 282 Flag indicating the barcode image should be a link (normal HTML dipaly)
 283
 284 =item barcode_cid
 285
 286 Barcode CID for inline (emailed) images
 287
 288 =item preref_callback
 289
 290 Coderef run for each line item, code should return HTML to be displayed
 291 before that line item (quotations only)
 292
 293 =item template
 294
 295 Dprecated.  Used as a suffix for a configuration template.  Please
 296 don't use this, it deprecated in favor of more flexible alternatives.
 297
 298 =back
 299
 300 =cut
 301
 302 #what's with all the sprintf('%10.2f')'s in here?  will it cause any
 303 # (alignment in text invoice?) problems to change them all to '%.2f' ?
 304 # yes: fixed width/plain text printing will be borked
 305 sub print_generic {
 306   my( $self, %params ) = @_;
 307   my $conf = $self->conf;
 308
 309   my $today = $params{today} ? $params{today} : time;
 310   warn "$me print_generic called on $self with suffix $params{template}\n"
 311     if $DEBUG;
 312
 313   my $format = $params{format};
 314   die "Unknown format: $format"
 315     unless $format =~ /^(latex|html|template)$/;
 316
 317   my $cust_main = $self->cust_main || $self->prospect_main;
 318   $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
 319     unless $cust_main->payname
 320         && $cust_main->payby !~ /^(CARD|DCRD|CHEK|DCHK)$/;
 321
 322   my $locale = $params{'locale'} || $cust_main->locale;
 323
 324   my %delimiters = ( 'latex'    => [ '[@--', '--@]' ],
 325                      'html'     => [ '<%=', '%>' ],
 326                      'template' => [ '{', '}' ],
 327                    );
 328
 329   warn "$me print_generic creating template\n"
 330     if $DEBUG > 1;
 331
 332   # set the notice name here, and nowhere else.
 333   my $notice_name =  $params{notice_name}
 334                   || $conf->config('notice_name')
 335                   || $self->notice_name;
 336
 337   #create the template
 338   my $template = $params{template} ? $params{template} : $self->_agent_template;
 339   my $templatefile = $self->template_conf. $format;
 340   $templatefile .= "_$template"
 341     if length($template) && $conf->exists($templatefile."_$template");
 342
 343   # the base template
 344   my @invoice_template = map "$_\n", $conf->config($templatefile)
 345     or die "cannot load config data $templatefile";
 346
 347   if ( $format eq 'latex' && grep { /^%%Detail/ } @invoice_template ) {
 348     #change this to a die when the old code is removed
 349     # it's been almost ten years, changing it to a die.
 350     die "old-style invoice template $templatefile; ".
 351          "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
 352          #$old_latex = 'true';
 353          #@invoice_template = _translate_old_latex_format(@invoice_template);
 354   }
 355
 356   warn "$me print_generic creating T:T object\n"
 357     if $DEBUG > 1;
 358
 359   my $text_template = new Text::Template(
 360     TYPE => 'ARRAY',
 361     SOURCE => \@invoice_template,
 362     DELIMITERS => $delimiters{$format},
 363   );
 364
 365   warn "$me print_generic compiling T:T object\n"
 366     if $DEBUG > 1;
 367
 368   $text_template->compile()
 369     or die "Can't compile $templatefile: $Text::Template::ERROR\n";
 370
 371
 372   # additional substitution could possibly cause breakage in existing templates
 373   my %convert_maps = (
 374     'latex' => {
 375                  'notes'         => sub { map "$_", @_ },
 376                  'footer'        => sub { map "$_", @_ },
 377                  'smallfooter'   => sub { map "$_", @_ },
 378                  'returnaddress' => sub { map "$_", @_ },
 379                  'coupon'        => sub { map "$_", @_ },
 380                  'summary'       => sub { map "$_", @_ },
 381                },
 382     'html'  => {
 383                  'notes' =>
 384                    sub {
 385                      map {
 386                        s/%%(.*)$/<!-- $1 -->/g;
 387                        s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
 388                        s/\\begin\{enumerate\}/<ol>/g;
 389                        s/\\item /  <li>/g;
 390                        s/\\end\{enumerate\}/<\/ol>/g;
 391                        s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
 392                        s/\\\\\*/<br>/g;
 393                        s/\\dollar ?/\$/g;
 394                        s/\\#/#/g;
 395                        s/~/&nbsp;/g;
 396                        $_;
 397                      }  @_
 398                    },
 399                  'footer' =>
 400                    sub { map { s/~/&nbsp;/g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
 401                  'smallfooter' =>
 402                    sub { map { s/~/&nbsp;/g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
 403                  'returnaddress' =>
 404                    sub {
 405                      map {
 406                        s/~/&nbsp;/g;
 407                        s/\\\\\*?\s*$/<BR>/;
 408                        s/\\hyphenation\{[\w\s\-]+}//;
 409                        s/\\([&])/$1/g;
 410                        $_;
 411                      }  @_
 412                    },
 413                  'coupon'        => sub { "" },
 414                  'summary'       => sub { "" },
 415                },
 416     'template' => {
 417                  'notes' =>
 418                    sub {
 419                      map {
 420                        s/%%.*$//g;
 421                        s/\\section\*\{\\textsc\{(.*)\}\}/\U$1/g;
 422                        s/\\begin\{enumerate\}//g;
 423                        s/\\item /  * /g;
 424                        s/\\end\{enumerate\}//g;
 425                        s/\\textbf\{(.*)\}/$1/g;
 426                        s/\\\\\*/ /;
 427                        s/\\dollar ?/\$/g;
 428                        $_;
 429                      }  @_
 430                    },
 431                  'footer' =>
 432                    sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
 433                  'smallfooter' =>
 434                    sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
 435                  'returnaddress' =>
 436                    sub {
 437                      map {
 438                        s/~/ /g;
 439                        s/\\\\\*?\s*$/\n/;             # dubious
 440                        s/\\hyphenation\{[\w\s\-]+}//;
 441                        $_;
 442                      }  @_
 443                    },
 444                  'coupon'        => sub { "" },
 445                  'summary'       => sub { "" },
 446                },
 447   );
 448
 449
 450   # hashes for differing output formats
 451   my %nbsps = ( 'latex'    => '~',
 452                 'html'     => '',    # '&nbps;' would be nice
 453                 'template' => '',    # not used
 454               );
 455   my $nbsp = $nbsps{$format};
 456
 457   my %escape_functions = ( 'latex'    => \&_latex_escape,
 458                            'html'     => \&_html_escape_nbsp,#\&encode_entities,
 459                            'template' => sub { shift },
 460                          );
 461   my $escape_function = $escape_functions{$format};
 462   my $escape_function_nonbsp = ($format eq 'html')
 463                                  ? \&_html_escape : $escape_function;
 464
 465   my %newline_tokens = (  'latex'     => '\\\\',
 466                           'html'      => '<br>',
 467                           'template'  => "\n",
 468                         );
 469   my $newline_token = $newline_tokens{$format};
 470
 471   warn "$me generating template variables\n"
 472     if $DEBUG > 1;
 473
 474   # generate template variables
 475   my $returnaddress;
 476
 477   if (
 478          defined( $conf->config_orbase( "invoice_${format}returnaddress",
 479                                         $template
 480                                       )
 481                 )
 482        && length( $conf->config_orbase( "invoice_${format}returnaddress",
 483                                         $template
 484                                       )
 485                 )
 486   ) {
 487
 488     $returnaddress = join("\n",
 489       $conf->config_orbase("invoice_${format}returnaddress", $template)
 490     );
 491
 492   } elsif ( grep /\S/,
 493             $conf->config_orbase('invoice_latexreturnaddress', $template) ) {
 494
 495     my $convert_map = $convert_maps{$format}{'returnaddress'};
 496     $returnaddress =
 497       join( "\n",
 498             &$convert_map( $conf->config_orbase( "invoice_latexreturnaddress",
 499                                                  $template
 500                                                )
 501                          )
 502           );
 503   } elsif ( grep /\S/, $conf->config('company_address', $cust_main->agentnum) ) {
 504
 505     my $convert_map = $convert_maps{$format}{'returnaddress'};
 506     $returnaddress = join( "\n", &$convert_map(
 507                                    map { s/( {2,})/'~' x length($1)/eg;
 508                                          s/$/\\\\\*/;
 509                                          $_
 510                                        }
 511                                      ( $conf->config('company_name', $cust_main->agentnum),
 512                                        $conf->config('company_address', $cust_main->agentnum),
 513                                      )
 514                                  )
 515                      );
 516
 517   } else {
 518
 519     my $warning = "Couldn't find a return address; ".
 520                   "do you need to set the company_address configuration value?";
 521     warn "$warning\n";
 522     $returnaddress = $nbsp;
 523     #$returnaddress = $warning;
 524
 525   }
 526
 527   warn "$me generating invoice data\n"
 528     if $DEBUG > 1;
 529
 530   my $agentnum = $cust_main->agentnum;
 531
 532   my %invoice_data = (
 533
 534     #invoice from info
 535     'company_name'    => scalar( $conf->config('company_name', $agentnum) ),
 536     'company_address' => join("\n", $conf->config('company_address', $agentnum) ). "\n",
 537     'company_phonenum'=> scalar( $conf->config('company_phonenum', $agentnum) ),
 538     'returnaddress'   => $returnaddress,
 539     'agent'           => &$escape_function($cust_main->agent->agent),
 540
 541     #invoice/quotation info
 542     'no_number'       => $params{'no_number'},
 543     'invnum'          => ( $params{'no_number'} ? '' : $self->invnum ),
 544     'quotationnum'    => $self->quotationnum,
 545     'no_date'         => $params{'no_date'},
 546     '_date'           => ( $params{'no_date'} ? '' : $self->_date ),
 547       # workaround for inconsistent behavior in the early plain text
 548       # templates; see RT#28271
 549     'date'            => ( $params{'no_date'}
 550                              ? ''
 551                              : ($format eq 'template'
 552                                ? $self->_date
 553                                : $self->time2str_local('long', $self->_date, $format)
 554                                )
 555                          ),
 556     'today'           => $self->time2str_local('long', $today, $format),
 557     'terms'           => $self->terms,
 558     'template'        => $template, #params{'template'},
 559     'notice_name'     => $notice_name, # escape?
 560     'current_charges' => sprintf("%.2f", $self->charged),
 561     'duedate'         => $self->due_date2str('rdate'), #date_format?
 562
 563     #customer info
 564     'custnum'         => $cust_main->display_custnum,
 565     'prospectnum'     => $cust_main->prospectnum,
 566     'agent_custid'    => &$escape_function($cust_main->agent_custid),
 567     ( map { $_ => &$escape_function($cust_main->$_()) } qw(
 568       payname company address1 address2 city state zip fax
 569     )),
 570
 571     #global config
 572     'ship_enable'     => $conf->exists('invoice-ship_address'),
 573     'unitprices'      => $conf->exists('invoice-unitprice'),
 574     'smallernotes'    => $conf->exists('invoice-smallernotes'),
 575     'smallerfooter'   => $conf->exists('invoice-smallerfooter'),
 576     'balance_due_below_line' => $conf->exists('balance_due_below_line'),
 577
 578     #layout info -- would be fancy to calc some of this and bury the template
 579     #               here in the code
 580     'topmargin'             => scalar($conf->config('invoice_latextopmargin', $agentnum)),
 581     'headsep'               => scalar($conf->config('invoice_latexheadsep', $agentnum)),
 582     'textheight'            => scalar($conf->config('invoice_latextextheight', $agentnum)),
 583     'extracouponspace'      => scalar($conf->config('invoice_latexextracouponspace', $agentnum)),
 584     'couponfootsep'         => scalar($conf->config('invoice_latexcouponfootsep', $agentnum)),
 585     'verticalreturnaddress' => $conf->exists('invoice_latexverticalreturnaddress', $agentnum),
 586     'addresssep'            => scalar($conf->config('invoice_latexaddresssep', $agentnum)),
 587     'amountenclosedsep'     => scalar($conf->config('invoice_latexcouponamountenclosedsep', $agentnum)),
 588     'coupontoaddresssep'    => scalar($conf->config('invoice_latexcoupontoaddresssep', $agentnum)),
 589     'addcompanytoaddress'   => $conf->exists('invoice_latexcouponaddcompanytoaddress', $agentnum),
 590
 591     # better hang on to conf_dir for a while (for old templates)
 592     'conf_dir'        => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
 593
 594     #these are only used when doing paged plaintext
 595     'page'            => 1,
 596     'total_pages'     => 1,
 597
 598   );
 599
 600   #localization
 601   $invoice_data{'emt'} = sub { &$escape_function($self->mt(@_)) };
 602   # prototype here to silence warnings
 603   $invoice_data{'time2str'} = sub ($;$$) { $self->time2str_local(@_, $format) };
 604
 605   my $min_sdate = 999999999999;
 606   my $max_edate = 0;
 607   foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
 608     next unless $cust_bill_pkg->pkgnum > 0;
 609     $min_sdate = $cust_bill_pkg->sdate
 610       if length($cust_bill_pkg->sdate) && $cust_bill_pkg->sdate < $min_sdate;
 611     $max_edate = $cust_bill_pkg->edate
 612       if length($cust_bill_pkg->edate) && $cust_bill_pkg->edate > $max_edate;
 613   }
 614
 615   $invoice_data{'bill_period'} = '';
 616   $invoice_data{'bill_period'} =
 617       $self->time2str_local('%e %h', $min_sdate, $format)
 618       . " to " .
 619       $self->time2str_local('%e %h', $max_edate, $format)
 620     if ($max_edate != 0 && $min_sdate != 999999999999);
 621
 622   $invoice_data{finance_section} = '';
 623   if ( $conf->config('finance_pkgclass') ) {
 624     my $pkg_class =
 625       qsearchs('pkg_class', { classnum => $conf->config('finance_pkgclass') });
 626     $invoice_data{finance_section} = $pkg_class->categoryname;
 627   }
 628   $invoice_data{finance_amount} = '0.00';
 629   $invoice_data{finance_section} ||= 'Finance Charges'; #avoid config confusion
 630
 631   my $countrydefault = $conf->config('countrydefault') || 'US';
 632   foreach ( qw( address1 address2 city state zip country fax) ){
 633     my $method = 'ship_'.$_;
 634     $invoice_data{"ship_$_"} = $escape_function->($cust_main->$method);
 635   }
 636   if ( length($cust_main->ship_company) ) {
 637     $invoice_data{'ship_company'} = $escape_function->($cust_main->ship_company);
 638   } else {
 639     $invoice_data{'ship_company'} = $escape_function->($cust_main->company);
 640   }
 641   $invoice_data{'ship_contact'} = $escape_function->($cust_main->contact);
 642   $invoice_data{'ship_country'} = ''
 643     if ( $invoice_data{'ship_country'} eq $countrydefault );
 644
 645   $invoice_data{'cid'} = $params{'cid'}
 646     if $params{'cid'};
 647
 648   if ( $cust_main->country eq $countrydefault ) {
 649     $invoice_data{'country'} = '';
 650   } else {
 651     $invoice_data{'country'} = &$escape_function(code2country($cust_main->country));
 652   }
 653
 654   my @address = ();
 655   $invoice_data{'address'} = \@address;
 656   push @address,
 657     $cust_main->payname.
 658       ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
 659         ? " (P.O. #". $cust_main->payinfo. ")"
 660         : ''
 661       )
 662   ;
 663   push @address, $cust_main->company
 664     if $cust_main->company;
 665   push @address, $cust_main->address1;
 666   push @address, $cust_main->address2
 667     if $cust_main->address2;
 668   push @address,
 669     $cust_main->city. ", ". $cust_main->state. "  ".  $cust_main->zip;
 670   push @address, $invoice_data{'country'}
 671     if $invoice_data{'country'};
 672   push @address, ''
 673     while (scalar(@address) < 5);
 674
 675   $invoice_data{'logo_file'} = $params{'logo_file'}
 676     if $params{'logo_file'};
 677   $invoice_data{'barcode_file'} = $params{'barcode_file'}
 678     if $params{'barcode_file'};
 679   $invoice_data{'barcode_img'} = $params{'barcode_img'}
 680     if $params{'barcode_img'};
 681   $invoice_data{'barcode_cid'} = $params{'barcode_cid'}
 682     if $params{'barcode_cid'};
 683
 684   my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
 685 #  my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
 686   #my $balance_due = $self->owed + $pr_total - $cr_total;
 687   my $balance_due = $self->owed + $pr_total;
 688
 689   # the sum of amount owed on all invoices
 690   # (this is used in the summary & on the payment coupon)
 691   $invoice_data{'balance'} = sprintf("%.2f", $balance_due);
 692
 693   # info from customer's last invoice before this one, for some
 694   # summary formats
 695   $invoice_data{'last_bill'} = {};
 696
 697   if ( $self->custnum && $self->invnum ) {
 698
 699     my $last_bill = $self->previous_bill;
 700     if ( $last_bill ) {
 701
 702       # "balance_date_range" unfortunately is unsuitable for this, since it
 703       # cares about application dates.  We want to know the sum of all
 704       # _top-level transactions_ dated before the last invoice.
 705       my @sql =
 706         map "$_ WHERE _date <= ? AND custnum = ?", (
 707           "SELECT      COALESCE( SUM(charged), 0 ) FROM cust_bill",
 708           "SELECT -1 * COALESCE( SUM(amount),  0 ) FROM cust_credit",
 709           "SELECT -1 * COALESCE( SUM(paid),    0 ) FROM cust_pay",
 710           "SELECT      COALESCE( SUM(refund),  0 ) FROM cust_refund",
 711         );
 712
 713       # the customer's current balance immediately after generating the last
 714       # bill
 715
 716       my $last_bill_balance = $last_bill->charged;
 717       foreach (@sql) {
 718         my $delta = FS::Record->scalar_sql(
 719           $_,
 720           $last_bill->_date - 1,
 721           $self->custnum,
 722         );
 723         $last_bill_balance += $delta;
 724       }
 725
 726       $last_bill_balance = sprintf("%.2f", $last_bill_balance);
 727
 728       warn sprintf("LAST BILL: INVNUM %d, DATE %s, BALANCE %.2f\n\n",
 729         $last_bill->invnum,
 730         $self->time2str_local('%D', $last_bill->_date),
 731         $last_bill_balance
 732       ) if $DEBUG > 0;
 733       # ("true_previous_balance" is a terrible name, but at least it's no
 734       # longer stored in the database)
 735       $invoice_data{'true_previous_balance'} = $last_bill_balance;
 736
 737       # the change in balance from immediately after that invoice
 738       # to immediately before this one
 739       my $before_this_bill_balance = 0;
 740       foreach (@sql) {
 741         my $delta = FS::Record->scalar_sql(
 742           $_,
 743           $self->_date - 1,
 744           $self->custnum,
 745         );
 746         $before_this_bill_balance += $delta;
 747       }
 748       $invoice_data{'balance_adjustments'} =
 749         sprintf("%.2f", $last_bill_balance - $before_this_bill_balance);
 750
 751       warn sprintf("BALANCE ADJUSTMENTS: %.2f\n\n",
 752                    $invoice_data{'balance_adjustments'}
 753       ) if $DEBUG > 0;
 754
 755       # the sum of amount owed on all previous invoices
 756       # ($pr_total is used elsewhere but not as $previous_balance)
 757       $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total);
 758
 759       $invoice_data{'last_bill'} = {
 760         '_date'     => $last_bill->_date, #unformatted
 761       };
 762       my (@payments, @credits);
 763       # for formats that itemize previous payments
 764       foreach my $cust_pay ( qsearch('cust_pay', {
 765                               'custnum' => $self->custnum,
 766                               '_date'   => { op => '>=',
 767                                              value => $last_bill->_date }
 768                              } ) )
 769       {
 770         next if $cust_pay->_date > $self->_date;
 771         push @payments, {
 772             '_date'       => $cust_pay->_date,
 773             'date'        => $self->time2str_local('long', $cust_pay->_date, $format),
 774             'payinfo'     => $cust_pay->payby_payinfo_pretty,
 775             'amount'      => sprintf('%.2f', $cust_pay->paid),
 776         };
 777         # not concerned about applications
 778       }
 779       foreach my $cust_credit ( qsearch('cust_credit', {
 780                               'custnum' => $self->custnum,
 781                               '_date'   => { op => '>=',
 782                                              value => $last_bill->_date }
 783                              } ) )
 784       {
 785         next if $cust_credit->_date > $self->_date;
 786         push @credits, {
 787             '_date'       => $cust_credit->_date,
 788             'date'        => $self->time2str_local('long', $cust_credit->_date, $format),
 789             'creditreason'=> $cust_credit->reason,
 790             'amount'      => sprintf('%.2f', $cust_credit->amount),
 791         };
 792       }
 793       $invoice_data{'previous_payments'} = \@payments;
 794       $invoice_data{'previous_credits'}  = \@credits;
 795     } else {
 796       # there is no $last_bill
 797       $invoice_data{'true_previous_balance'} =
 798       $invoice_data{'balance_adjustments'}   =
 799       $invoice_data{'previous_balance'}      = '0.00';
 800       $invoice_data{'previous_payments'} = [];
 801       $invoice_data{'previous_credits'} = [];
 802     }
 803   } # if this is an invoice
 804
 805   my $summarypage = '';
 806   if ( $conf->exists('invoice_usesummary', $agentnum) ) {
 807     $summarypage = 1;
 808   }
 809   $invoice_data{'summarypage'} = $summarypage;
 810
 811   warn "$me substituting variables in notes, footer, smallfooter\n"
 812     if $DEBUG > 1;
 813
 814   my $tc = $self->template_conf;
 815   my @include = ( [ $tc,        'notes' ],
 816                   [ 'invoice_', 'footer' ],
 817                   [ 'invoice_', 'smallfooter', ],
 818                 );
 819   push @include, [ $tc,        'coupon', ]
 820     unless $params{'no_coupon'};
 821
 822   foreach my $i (@include) {
 823
 824     my($base, $include) = @$i;
 825
 826     my $inc_file = $conf->key_orbase("$base$format$include", $template);
 827     my @inc_src;
 828
 829     if ( $conf->exists($inc_file, $agentnum)
 830          && length( $conf->config($inc_file, $agentnum) ) ) {
 831
 832       @inc_src = $conf->config($inc_file, $agentnum);
 833
 834     } else {
 835
 836       $inc_file = $conf->key_orbase("${base}latex$include", $template);
 837
 838       my $convert_map = $convert_maps{$format}{$include};
 839
 840       @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
 841                        s/--\@\]/$delimiters{$format}[1]/g;
 842                        $_;
 843                      }
 844                  &$convert_map( $conf->config($inc_file, $agentnum) );
 845
 846     }
 847
 848     my $inc_tt = new Text::Template (
 849       TYPE       => 'ARRAY',
 850       SOURCE     => [ map "$_\n", @inc_src ],
 851       DELIMITERS => $delimiters{$format},
 852     ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
 853
 854     unless ( $inc_tt->compile() ) {
 855       my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
 856       warn $error. "Template:\n". join('', map "$_\n", @inc_src);
 857       die $error;
 858     }
 859
 860     $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
 861
 862     $invoice_data{$include} =~ s/\n+$//
 863       if ($format eq 'latex');
 864   }
 865
 866   # let invoices use either of these as needed
 867   $invoice_data{'po_num'} = ($cust_main->payby eq 'BILL')
 868     ? $cust_main->payinfo : '';
 869   $invoice_data{'po_line'} =
 870     (  $cust_main->payby eq 'BILL' && $cust_main->payinfo )
 871       ? &$escape_function($self->mt("Purchase Order #").$cust_main->payinfo)
 872       : $nbsp;
 873
 874   my %money_chars = ( 'latex'    => '',
 875                       'html'     => $conf->config('money_char') || '$',
 876                       'template' => '',
 877                     );
 878   my $money_char = $money_chars{$format};
 879
 880   # extremely dubious
 881   my %other_money_chars = ( 'latex'    => '\dollar ',#XXX should be a config too
 882                             'html'     => $conf->config('money_char') || '$',
 883                             'template' => '',
 884                           );
 885   my $other_money_char = $other_money_chars{$format};
 886   $invoice_data{'dollar'} = $other_money_char;
 887
 888   my %minus_signs = ( 'latex'    => '$-$',
 889                       'html'     => '&minus;',
 890                       'template' => '- ' );
 891   my $minus = $minus_signs{$format};
 892
 893   my @detail_items = ();
 894   my @total_items = ();
 895   my @buf = ();
 896   my @sections = ();
 897
 898   $invoice_data{'detail_items'} = \@detail_items;
 899   $invoice_data{'total_items'} = \@total_items;
 900   $invoice_data{'buf'} = \@buf;
 901   $invoice_data{'sections'} = \@sections;
 902
 903   warn "$me generating sections\n"
 904     if $DEBUG > 1;
 905
 906   my $taxtotal = 0;
 907   my $tax_section = { 'description' => $self->mt('Taxes, Surcharges, and Fees'),
 908                       'subtotal'    => $taxtotal,   # adjusted below
 909                       'tax_section' => 1,
 910                     };
 911   my $tax_weight = _pkg_category($tax_section->{description})
 912                         ? _pkg_category($tax_section->{description})->weight
 913                         : 0;
 914   $tax_section->{'summarized'} = ''; #why? $summarypage && !$tax_weight ? 'Y' : '';
 915   $tax_section->{'sort_weight'} = $tax_weight;
 916
 917   my $adjusttotal = 0;
 918   my $adjust_section = {
 919     'description'    => $self->mt('Credits, Payments, and Adjustments'),
 920     'adjust_section' => 1,
 921     'subtotal'       => 0,   # adjusted below
 922   };
 923   my $adjust_weight = _pkg_category($adjust_section->{description})
 924                         ? _pkg_category($adjust_section->{description})->weight
 925                         : 0;
 926   $adjust_section->{'summarized'} = ''; #why? $summarypage && !$adjust_weight ? 'Y' : '';
 927   $adjust_section->{'sort_weight'} = $adjust_weight;
 928
 929   my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
 930   my $multisection = $conf->exists($tc.'sections', $cust_main->agentnum) ||
 931                      $conf->exists($tc.'sections_by_location', $cust_main->agentnum);
 932   $invoice_data{'multisection'} = $multisection;
 933   my $late_sections;
 934   my $extra_sections = [];
 935   my $extra_lines = ();
 936
 937   # default section ('Charges')
 938   my $default_section = { 'description' => '',
 939                           'subtotal'    => '',
 940                           'no_subtotal' => 1,
 941                         };
 942
 943   # Previous Charges section
 944   # subtotal is the first return value from $self->previous
 945   my $previous_section;
 946   # if the invoice has major sections, or if we're summarizing previous
 947   # charges with a single line, or if we've been specifically told to put them
 948   # in a section, create a section for previous charges:
 949   if ( $multisection or
 950        $conf->exists('previous_balance-summary_only') or
 951        $conf->exists('previous_balance-section') ) {
 952
 953     $previous_section =  { 'description' => $self->mt('Previous Charges'),
 954                            'subtotal'    => $other_money_char.
 955                                             sprintf('%.2f', $pr_total),
 956                            'summarized'  => '', #why? $summarypage ? 'Y' : '',
 957                          };
 958     $previous_section->{posttotal} = '0 / 30 / 60 / 90 days overdue '.
 959       join(' / ', map { $cust_main->balance_date_range(@$_) }
 960                   $self->_prior_month30s
 961           )
 962       if $conf->exists('invoice_include_aging');
 963
 964   } else {
 965     # otherwise put them in the main section
 966     $previous_section = $default_section;
 967   }
 968
 969   if ( $multisection ) {
 970     ($extra_sections, $extra_lines) =
 971       $self->_items_extra_usage_sections($escape_function_nonbsp, $format)
 972       if $conf->exists('usage_class_as_a_section', $cust_main->agentnum)
 973       && $self->can('_items_extra_usage_sections');
 974
 975     push @$extra_sections, $adjust_section if $adjust_section->{sort_weight};
 976
 977     push @detail_items, @$extra_lines if $extra_lines;
 978
 979     # the code is written so that both methods can be used together, but
 980     # we haven't yet changed the template to take advantage of that, so for
 981     # now, treat them as mutually exclusive.
 982     my %section_method = ( by_category => 1 );
 983     if ( $conf->config($tc.'sections_method') eq 'location' ) {
 984       %section_method = ( by_location => 1 );
 985     }
 986     my ($early, $late) =
 987       $self->_items_sections( 'summary' => $summarypage,
 988                               'escape'  => $escape_function_nonbsp,
 989                               'extra_sections' => $extra_sections,
 990                               'format'  => $format,
 991                               %section_method
 992                             );
 993     push @sections, @$early;
 994     $late_sections = $late;
 995
 996     if (    $conf->exists('svc_phone_sections')
 997          && $self->can('_items_svc_phone_sections')
 998        )
 999     {
1000       my ($phone_sections, $phone_lines) =
1001         $self->_items_svc_phone_sections($escape_function_nonbsp, $format);
1002       push @{$late_sections}, @$phone_sections;
1003       push @detail_items, @$phone_lines;
1004     }
1005     if ( $conf->exists('voip-cust_accountcode_cdr')
1006          && $cust_main->accountcode_cdr
1007          && $self->can('_items_accountcode_cdr')
1008        )
1009     {
1010       my ($accountcode_section, $accountcode_lines) =
1011         $self->_items_accountcode_cdr($escape_function_nonbsp,$format);
1012       if ( scalar(@$accountcode_lines) ) {
1013           push @{$late_sections}, $accountcode_section;
1014           push @detail_items, @$accountcode_lines;
1015       }
1016     }
1017   } else {# not multisection
1018     # make a default section
1019     push @sections, $default_section;
1020     # and calculate the finance charge total, since it won't get done otherwise.
1021     # and the default section total
1022     # XXX possibly finance_pkgclass should not be used in this manner?
1023     my @finance_charges;
1024     my @charges;
1025     foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1026       if ( $invoice_data{finance_section} and
1027         grep { $_->section eq $invoice_data{finance_section} }
1028            $cust_bill_pkg->cust_bill_pkg_display ) {
1029         # I think these are always setup fees, but just to be sure...
1030         push @finance_charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1031       } else {
1032         push @charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
1033       }
1034     }
1035     $invoice_data{finance_amount} =
1036       sprintf('%.2f', sum( @finance_charges ) || 0);
1037     $default_section->{subtotal} = $other_money_char.
1038                                     sprintf('%.2f', sum( @charges ) || 0);
1039   }
1040
1041   # start setting up summary subtotals
1042   my @summary_subtotals;
1043   my $method = $conf->config('summary_subtotals_method');
1044   if ( $method and $method ne $conf->config($tc.'sections_method') ) {
1045     # then re-section them by the correct method
1046     my %section_method = ( by_category => 1 );
1047     if ( $conf->config('summary_subtotals_method') eq 'location' ) {
1048       %section_method = ( by_location => 1 );
1049     }
1050     my ($early, $late) =
1051       $self->_items_sections( 'summary' => $summarypage,
1052                               'escape'  => $escape_function_nonbsp,
1053                               'extra_sections' => $extra_sections,
1054                               'format'  => $format,
1055                               %section_method
1056                             );
1057     foreach ( @$early ) {
1058       next if $_->{subtotal} == 0;
1059       $_->{subtotal} = $other_money_char.sprintf('%.2f', $_->{subtotal});
1060       push @summary_subtotals, $_;
1061     }
1062   } else {
1063     # subtotal sectioning is the same as for the actual invoice sections
1064     @summary_subtotals = @sections;
1065   }
1066
1067   # Hereafter, push sections to both @sections and @summary_subtotals
1068   # if they belong in both places (e.g. tax section).  Late sections are
1069   # never in @summary_subtotals.
1070
1071   # previous invoice balances in the Previous Charges section if there
1072   # is one, otherwise in the main detail section
1073   # (except if summary_only is enabled, don't show them at all)
1074   if ( $self->can('_items_previous') &&
1075        $self->enable_previous &&
1076        ! $conf->exists('previous_balance-summary_only') ) {
1077
1078     warn "$me adding previous balances\n"
1079       if $DEBUG > 1;
1080
1081     foreach my $line_item ( $self->_items_previous ) {
1082
1083       my $detail = {
1084         ref             => $line_item->{'pkgnum'},
1085         pkgpart         => $line_item->{'pkgpart'},
1086         #quantity        => 1, # not really correct
1087         section         => $previous_section, # which might be $default_section
1088         description     => &$escape_function($line_item->{'description'}),
1089         ext_description => [ map { &$escape_function($_) }
1090                              @{ $line_item->{'ext_description'} || [] }
1091                            ],
1092         amount          => $money_char . $line_item->{'amount'},
1093         product_code    => $line_item->{'pkgpart'} || 'N/A',
1094       };
1095
1096       push @detail_items, $detail;
1097       push @buf, [ $detail->{'description'},
1098                    $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1099                  ];
1100     }
1101
1102   }
1103
1104   if ( @pr_cust_bill && $self->enable_previous ) {
1105     push @buf, ['','-----------'];
1106     push @buf, [ $self->mt('Total Previous Balance'),
1107                  $money_char. sprintf("%10.2f", $pr_total) ];
1108     push @buf, ['',''];
1109   }
1110
1111   if ( $conf->exists('svc_phone-did-summary') && $self->can('_did_summary') ) {
1112       warn "$me adding DID summary\n"
1113         if $DEBUG > 1;
1114
1115       my ($didsummary,$minutes) = $self->_did_summary;
1116       my $didsummary_desc = 'DID Activity Summary (since last invoice)';
1117       push @detail_items,
1118        { 'description' => $didsummary_desc,
1119            'ext_description' => [ $didsummary, $minutes ],
1120        };
1121   }
1122
1123   foreach my $section (@sections, @$late_sections) {
1124
1125     # begin some normalization
1126     $section->{'subtotal'} = $section->{'amount'}
1127       if $multisection
1128          && !exists($section->{subtotal})
1129          && exists($section->{amount});
1130
1131     $invoice_data{finance_amount} = sprintf('%.2f', $section->{'subtotal'} )
1132       if ( $invoice_data{finance_section} &&
1133            $section->{'description'} eq $invoice_data{finance_section} );
1134
1135     $section->{'subtotal'} = $other_money_char.
1136                              sprintf('%.2f', $section->{'subtotal'})
1137       if $multisection;
1138
1139     # continue some normalization
1140     $section->{'amount'}   = $section->{'subtotal'}
1141       if $multisection;
1142
1143
1144     if ( $section->{'description'} ) {
1145       push @buf, ( [ &$escape_function($section->{'description'}), '' ],
1146                    [ '', '' ],
1147                  );
1148     }
1149
1150     warn "$me   setting options\n"
1151       if $DEBUG > 1;
1152
1153     my %options = ();
1154     $options{'section'} = $section if $multisection;
1155     $options{'format'} = $format;
1156     $options{'escape_function'} = $escape_function;
1157     $options{'no_usage'} = 1 unless $unsquelched;
1158     $options{'unsquelched'} = $unsquelched;
1159     $options{'summary_page'} = $summarypage;
1160     $options{'skip_usage'} =
1161       scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
1162     $options{'preref_callback'} = $params{'preref_callback'};
1163
1164     warn "$me   searching for line items\n"
1165       if $DEBUG > 1;
1166
1167     foreach my $line_item ( $self->_items_pkg(%options),
1168                             $self->_items_fee(%options) ) {
1169
1170       warn "$me     adding line item ".
1171            join(', ', map "$_=>".$line_item->{$_}, keys %$line_item). "\n"
1172         if $DEBUG > 1;
1173
1174       $line_item->{'ref'} = $line_item->{'pkgnum'};
1175       $line_item->{'product_code'} = $line_item->{'pkgpart'} || 'N/A'; # mt()?
1176       $line_item->{'section'} = $section;
1177       $line_item->{'description'} = &$escape_function($line_item->{'description'});
1178       $line_item->{'amount'} = $money_char.$line_item->{'amount'};
1179
1180       if ( length($line_item->{'unit_amount'}) ) {
1181         $line_item->{'unit_amount'} = $money_char.$line_item->{'unit_amount'};
1182       }
1183       $line_item->{'ext_description'} ||= [];
1184
1185       push @detail_items, $line_item;
1186       push @buf, ( [ $line_item->{'description'},
1187                      $money_char. sprintf("%10.2f", $line_item->{'amount'}),
1188                    ],
1189                    map { [ " ". $_, '' ] } @{$line_item->{'ext_description'}},
1190                  );
1191     }
1192
1193     if ( $section->{'description'} ) {
1194       push @buf, ( ['','-----------'],
1195                    [ $section->{'description'}. ' sub-total',
1196                       $section->{'subtotal'} # already formatted this
1197                    ],
1198                    [ '', '' ],
1199                    [ '', '' ],
1200                  );
1201     }
1202
1203   }
1204
1205   $invoice_data{current_less_finance} =
1206     sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
1207
1208   # if there's anything in the Previous Charges section, prepend it to the list
1209   if ( $pr_total and $previous_section ne $default_section ) {
1210     unshift @sections, $previous_section;
1211     # but not @summary_subtotals
1212   }
1213
1214   warn "$me adding taxes\n"
1215     if $DEBUG > 1;
1216
1217   my @items_tax = $self->_items_tax;
1218   foreach my $tax ( @items_tax ) {
1219
1220     $taxtotal += $tax->{'amount'};
1221
1222     my $description = &$escape_function( $tax->{'description'} );
1223     my $amount      = sprintf( '%.2f', $tax->{'amount'} );
1224
1225     if ( $multisection ) {
1226
1227       push @detail_items, {
1228         ext_description => [],
1229         ref          => '',
1230         quantity     => '',
1231         description  => $description,
1232         amount       => $money_char. $amount,
1233         product_code => '',
1234         section      => $tax_section,
1235       };
1236
1237     } else {
1238
1239       push @total_items, {
1240         'total_item'   => $description,
1241         'total_amount' => $other_money_char. $amount,
1242       };
1243
1244     }
1245
1246     push @buf,[ $description,
1247                 $money_char. $amount,
1248               ];
1249
1250   }
1251
1252   if ( @items_tax ) {
1253     my $total = {};
1254     $total->{'total_item'} = $self->mt('Sub-total');
1255     $total->{'total_amount'} =
1256       $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
1257
1258     if ( $multisection ) {
1259       $tax_section->{'subtotal'} = $other_money_char.
1260                                    sprintf('%.2f', $taxtotal);
1261       $tax_section->{'pretotal'} = 'New charges sub-total '.
1262                                    $total->{'total_amount'};
1263       if ( $taxtotal ) {
1264         push @sections, $tax_section;
1265         push @summary_subtotals, $tax_section;
1266       }
1267     } else {
1268       unshift @total_items, $total;
1269     }
1270   }
1271   $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
1272
1273   push @buf,['','-----------'];
1274   push @buf,[$self->mt(
1275               (!$self->enable_previous)
1276                ? 'Total Charges'
1277                : 'Total New Charges'
1278              ),
1279              $money_char. sprintf("%10.2f",$self->charged) ];
1280   push @buf,['',''];
1281
1282
1283   ###
1284   # Totals
1285   ###
1286
1287   my %embolden_functions = (
1288     'latex'    => sub { return '\textbf{'. shift(). '}' },
1289     'html'     => sub { return '<b>'. shift(). '</b>' },
1290     'template' => sub { shift },
1291   );
1292   my $embolden_function = $embolden_functions{$format};
1293
1294   if ( $self->can('_items_total') ) { # quotations
1295
1296     $self->_items_total(\@total_items);
1297
1298     foreach ( @total_items ) {
1299       $_->{'total_item'}   = &$embolden_function( $_->{'total_item'} );
1300       $_->{'total_amount'} = &$embolden_function( $other_money_char.
1301                                                    $_->{'total_amount'}
1302                                                 );
1303     }
1304
1305   } else { #normal invoice case
1306
1307     # calculate total, possibly including total owed on previous
1308     # invoices
1309     my $total = {};
1310     my $item = 'Total';
1311     $item = $conf->config('previous_balance-exclude_from_total')
1312          || 'Total New Charges'
1313       if $conf->exists('previous_balance-exclude_from_total');
1314     my $amount = $self->charged;
1315     if ( $self->enable_previous and !$conf->exists('previous_balance-exclude_from_total') ) {
1316       $amount += $pr_total;
1317     }
1318
1319     $total->{'total_item'} = &$embolden_function($self->mt($item));
1320     $total->{'total_amount'} =
1321       &$embolden_function( $other_money_char.  sprintf( '%.2f', $amount ) );
1322     if ( $multisection ) {
1323       if ( $adjust_section->{'sort_weight'} ) {
1324         $adjust_section->{'posttotal'} = $self->mt('Balance Forward').' '.
1325           $other_money_char.  sprintf("%.2f", ($self->billing_balance || 0) );
1326       } else {
1327         $adjust_section->{'pretotal'} = $self->mt('New charges total').' '.
1328           $other_money_char.  sprintf('%.2f', $self->charged );
1329       }
1330     } else {
1331       push @total_items, $total;
1332     }
1333     push @buf,['','-----------'];
1334     push @buf,[$item,
1335                $money_char.
1336                sprintf( '%10.2f', $amount )
1337               ];
1338     push @buf,['',''];
1339
1340     # if we're showing previous invoices, also show previous
1341     # credits and payments
1342     if ( $self->enable_previous
1343           and $self->can('_items_credits')
1344           and $self->can('_items_payments') )
1345       {
1346       #foreach my $thing ( sort { $a->_date <=> $b->_date } $self->_items_credits, $self->_items_payments
1347
1348       # credits
1349       my $credittotal = 0;
1350       foreach my $credit (
1351         $self->_items_credits( 'template' => $template, 'trim_len' => 60 )
1352       ) {
1353
1354         my $total;
1355         $total->{'total_item'} = &$escape_function($credit->{'description'});
1356         $credittotal += $credit->{'amount'};
1357         $total->{'total_amount'} = $minus.$other_money_char.$credit->{'amount'};
1358         $adjusttotal += $credit->{'amount'};
1359         if ( $multisection ) {
1360           push @detail_items, {
1361             ext_description => [],
1362             ref          => '',
1363             quantity     => '',
1364             description  => &$escape_function($credit->{'description'}),
1365             amount       => $money_char . $credit->{'amount'},
1366             product_code => '',
1367             section      => $adjust_section,
1368           };
1369         } else {
1370           push @total_items, $total;
1371         }
1372
1373       }
1374       $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
1375
1376       #credits (again)
1377       foreach my $credit (
1378         $self->_items_credits( 'template' => $template, 'trim_len'=>32 )
1379       ) {
1380         push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
1381       }
1382
1383       # payments
1384       my $paymenttotal = 0;
1385       foreach my $payment (
1386         $self->_items_payments( 'template' => $template )
1387       ) {
1388         my $total = {};
1389         $total->{'total_item'} = &$escape_function($payment->{'description'});
1390         $paymenttotal += $payment->{'amount'};
1391         $total->{'total_amount'} = $minus.$other_money_char.$payment->{'amount'};
1392         $adjusttotal += $payment->{'amount'};
1393         if ( $multisection ) {
1394           push @detail_items, {
1395             ext_description => [],
1396             ref          => '',
1397             quantity     => '',
1398             description  => &$escape_function($payment->{'description'}),
1399             amount       => $money_char . $payment->{'amount'},
1400             product_code => '',
1401             section      => $adjust_section,
1402           };
1403         }else{
1404           push @total_items, $total;
1405         }
1406         push @buf, [ $payment->{'description'},
1407                      $money_char. sprintf("%10.2f", $payment->{'amount'}),
1408                    ];
1409       }
1410       $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
1411
1412       if ( $multisection ) {
1413         $adjust_section->{'subtotal'} = $other_money_char.
1414                                         sprintf('%.2f', $adjusttotal);
1415         push @sections, $adjust_section
1416           unless $adjust_section->{sort_weight};
1417         # do not summarize; adjustments there are shown according to
1418         # different rules
1419       }
1420
1421       # create Balance Due message
1422       {
1423         my $total;
1424         $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1425         $total->{'total_amount'} =
1426           &$embolden_function(
1427             $other_money_char. sprintf('%.2f', #why? $summarypage
1428                                                #  ? $self->charged +
1429                                                #    $self->billing_balance
1430                                                #  :
1431                                                    $self->owed + $pr_total
1432                                       )
1433           );
1434         if ( $multisection && !$adjust_section->{sort_weight} ) {
1435           $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
1436                                            $total->{'total_amount'};
1437         }else{
1438           push @total_items, $total;
1439         }
1440         push @buf,['','-----------'];
1441         push @buf,[$self->balance_due_msg, $money_char.
1442           sprintf("%10.2f", $balance_due ) ];
1443       }
1444
1445       if ( $conf->exists('previous_balance-show_credit')
1446           and $cust_main->balance < 0 ) {
1447         my $credit_total = {
1448           'total_item'    => &$embolden_function($self->credit_balance_msg),
1449           'total_amount'  => &$embolden_function(
1450             $other_money_char. sprintf('%.2f', -$cust_main->balance)
1451           ),
1452         };
1453         if ( $multisection ) {
1454           $adjust_section->{'posttotal'} .= $newline_token .
1455             $credit_total->{'total_item'} . ' ' . $credit_total->{'total_amount'};
1456         }
1457         else {
1458           push @total_items, $credit_total;
1459         }
1460         push @buf,['','-----------'];
1461         push @buf,[$self->credit_balance_msg, $money_char.
1462           sprintf("%10.2f", -$cust_main->balance ) ];
1463       }
1464     }
1465
1466   } #end of default total adding ! can('_items_total')
1467
1468   if ( $multisection ) {
1469     if (    $conf->exists('svc_phone_sections')
1470          && $self->can('_items_svc_phone_sections')
1471        )
1472     {
1473       my $total;
1474       $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
1475       $total->{'total_amount'} =
1476         &$embolden_function(
1477           $other_money_char. sprintf('%.2f', $self->owed + $pr_total)
1478         );
1479       my $last_section = pop @sections;
1480       $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
1481                                      $total->{'total_amount'};
1482       push @sections, $last_section;
1483     }
1484     push @sections, @$late_sections
1485       if $unsquelched;
1486   }
1487
1488   # make a discounts-available section, even without multisection
1489   if ( $conf->exists('discount-show_available')
1490        and my @discounts_avail = $self->_items_discounts_avail ) {
1491     my $discount_section = {
1492       'description' => $self->mt('Discounts Available'),
1493       'subtotal'    => '',
1494       'no_subtotal' => 1,
1495     };
1496
1497     push @sections, $discount_section; # do not summarize
1498     push @detail_items, map { +{
1499         'ref'         => '', #should this be something else?
1500         'section'     => $discount_section,
1501         'description' => &$escape_function( $_->{description} ),
1502         'amount'      => $money_char . &$escape_function( $_->{amount} ),
1503         'ext_description' => [ &$escape_function($_->{ext_description}) || () ],
1504     } } @discounts_avail;
1505   }
1506
1507   # not adding any more sections after this
1508   $invoice_data{summary_subtotals} = \@summary_subtotals;
1509
1510   # usage subtotals
1511   if ( $conf->exists('usage_class_summary')
1512        and $self->can('_items_usage_class_summary') ) {
1513     my @usage_subtotals = $self->_items_usage_class_summary(escape => $escape_function);
1514     if ( @usage_subtotals ) {
1515       unshift @sections, $usage_subtotals[0]->{section}; # do not summarize
1516       unshift @detail_items, @usage_subtotals;
1517     }
1518   }
1519
1520   # invoice history "section" (not really a section)
1521   # not to be included in any subtotals, completely independent of
1522   # everything...
1523   if ( $conf->exists('previous_invoice_history') ) {
1524     my %history;
1525     my %monthorder;
1526     foreach my $cust_bill ( $cust_main->cust_bill ) {
1527       # XXX hardcoded format, and currently only 'charged'; add other fields
1528       # if they become necessary
1529       my $date = $self->time2str_local('%b %Y', $cust_bill->_date);
1530       $history{$date} ||= 0;
1531       $history{$date} += $cust_bill->charged;
1532       # just so we have a numeric sort key
1533       $monthorder{$date} ||= $cust_bill->_date;
1534     }
1535     my @sorted_months = sort { $monthorder{$a} <=> $monthorder{$b} }
1536                         keys %history;
1537     my @sorted_amounts = map { sprintf('%.2f', $history{$_}) } @sorted_months;
1538     $invoice_data{monthly_history} = [ \@sorted_months, \@sorted_amounts ];
1539   }
1540
1541   # service locations: another option for template customization
1542   my %location_info;
1543   foreach my $item (@detail_items) {
1544     if ( $item->{locationnum} ) {
1545       $location_info{ $item->{locationnum} } ||= {
1546         FS::cust_location->by_key( $item->{locationnum} )->location_hash
1547       };
1548     }
1549   }
1550   $invoice_data{location_info} = \%location_info;
1551
1552   # debugging hook: call this with 'diag' => 1 to just get a hash of
1553   # the invoice variables
1554   return \%invoice_data if ( $params{'diag'} );
1555
1556   # All sections and items are built; now fill in templates.
1557   my @includelist = ();
1558   push @includelist, 'summary' if $summarypage;
1559   foreach my $include ( @includelist ) {
1560
1561     my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
1562     my @inc_src;
1563
1564     if ( length( $conf->config($inc_file, $agentnum) ) ) {
1565
1566       @inc_src = $conf->config($inc_file, $agentnum);
1567
1568     } else {
1569
1570       $inc_file = $conf->key_orbase("invoice_latex$include", $template);
1571
1572       my $convert_map = $convert_maps{$format}{$include};
1573
1574       @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
1575                        s/--\@\]/$delimiters{$format}[1]/g;
1576                        $_;
1577                      }
1578                  &$convert_map( $conf->config($inc_file, $agentnum) );
1579
1580     }
1581
1582     my $inc_tt = new Text::Template (
1583       TYPE       => 'ARRAY',
1584       SOURCE     => [ map "$_\n", @inc_src ],
1585       DELIMITERS => $delimiters{$format},
1586     ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
1587
1588     unless ( $inc_tt->compile() ) {
1589       my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
1590       warn $error. "Template:\n". join('', map "$_\n", @inc_src);
1591       die $error;
1592     }
1593
1594     $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
1595
1596     $invoice_data{$include} =~ s/\n+$//
1597       if ($format eq 'latex');
1598   }
1599
1600   $invoice_lines = 0;
1601   my $wasfunc = 0;
1602   foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1603     /invoice_lines\((\d*)\)/;
1604     $invoice_lines += $1 || scalar(@buf);
1605     $wasfunc=1;
1606   }
1607   die "no invoice_lines() functions in template?"
1608     if ( $format eq 'template' && !$wasfunc );
1609
1610   if ($format eq 'template') {
1611
1612     if ( $invoice_lines ) {
1613       $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
1614       $invoice_data{'total_pages'}++
1615         if scalar(@buf) % $invoice_lines;
1616     }
1617
1618     #setup subroutine for the template
1619     $invoice_data{invoice_lines} = sub {
1620       my $lines = shift || scalar(@buf);
1621       map {
1622         scalar(@buf)
1623           ? shift @buf
1624           : [ '', '' ];
1625       }
1626       ( 1 .. $lines );
1627     };
1628
1629     my $lines;
1630     my @collect;
1631     while (@buf) {
1632       push @collect, split("\n",
1633         $text_template->fill_in( HASH => \%invoice_data )
1634       );
1635       $invoice_data{'page'}++;
1636     }
1637     map "$_\n", @collect;
1638
1639   } else { # this is where we actually create the invoice
1640
1641     warn "filling in template for invoice ". $self->invnum. "\n"
1642       if $DEBUG;
1643     warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
1644       if $DEBUG > 1;
1645
1646     $text_template->fill_in(HASH => \%invoice_data);
1647   }
1648 }
1649
1650 sub notice_name { '('.shift->table.')'; }
1651
1652 sub template_conf { 'invoice_'; }
1653
1654 # helper routine for generating date ranges
1655 sub _prior_month30s {
1656   my $self = shift;
1657   my @ranges = (
1658    [ 1,       2592000 ], # 0-30 days ago
1659    [ 2592000, 5184000 ], # 30-60 days ago
1660    [ 5184000, 7776000 ], # 60-90 days ago
1661    [ 7776000, 0       ], # 90+   days ago
1662   );
1663
1664   map { [ $_->[0] ? $self->_date - $_->[0] - 1 : '',
1665           $_->[1] ? $self->_date - $_->[1] - 1 : '',
1666       ] }
1667   @ranges;
1668 }
1669
1670 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
1671
1672 Returns an postscript invoice, as a scalar.
1673
1674 Options can be passed as a hashref (recommended) or as a list of time, template
1675 and then any key/value pairs for any other options.
1676
1677 I<time> an optional value used to control the printing of overdue messages.  The
1678 default is now.  It isn't the date of the invoice; that's the `_date' field.
1679 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
1680 L<Time::Local> and L<Date::Parse> for conversion functions.
1681
1682 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1683
1684 =cut
1685
1686 sub print_ps {
1687   my $self = shift;
1688
1689   my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1690   my $ps = generate_ps($file);
1691   unlink($logofile);
1692   unlink($barcodefile) if $barcodefile;
1693
1694   $ps;
1695 }
1696
1697 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
1698
1699 Returns an PDF invoice, as a scalar.
1700
1701 Options can be passed as a hashref (recommended) or as a list of time, template
1702 and then any key/value pairs for any other options.
1703
1704 I<time> an optional value used to control the printing of overdue messages.  The
1705 default is now.  It isn't the date of the invoice; that's the `_date' field.
1706 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
1707 L<Time::Local> and L<Date::Parse> for conversion functions.
1708
1709 I<template>, if specified, is the name of a suffix for alternate invoices.
1710
1711 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1712
1713 =cut
1714
1715 sub print_pdf {
1716   my $self = shift;
1717
1718   my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
1719   my $pdf = generate_pdf($file);
1720   unlink($logofile);
1721   unlink($barcodefile) if $barcodefile;
1722
1723   $pdf;
1724 }
1725
1726 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
1727
1728 Returns an HTML invoice, as a scalar.
1729
1730 I<time> an optional value used to control the printing of overdue messages.  The
1731 default is now.  It isn't the date of the invoice; that's the `_date' field.
1732 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
1733 L<Time::Local> and L<Date::Parse> for conversion functions.
1734
1735 I<template>, if specified, is the name of a suffix for alternate invoices.
1736
1737 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1738
1739 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
1740 when emailing the invoice as part of a multipart/related MIME email.
1741
1742 =cut
1743
1744 sub print_html {
1745   my $self = shift;
1746   my %params;
1747   if ( ref($_[0]) ) {
1748     %params = %{ shift() };
1749   } else {
1750     %params = @_;
1751   }
1752   $params{'format'} = 'html';
1753
1754   $self->print_generic( %params );
1755 }
1756
1757 # quick subroutine for print_latex
1758 #
1759 # There are ten characters that LaTeX treats as special characters, which
1760 # means that they do not simply typeset themselves:
1761 #      # $ % & ~ _ ^ \ { }
1762 #
1763 # TeX ignores blanks following an escaped character; if you want a blank (as
1764 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
1765
1766 sub _latex_escape {
1767   my $value = shift;
1768   $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
1769   $value =~ s/([<>])/\$$1\$/g;
1770   $value;
1771 }
1772
1773 sub _html_escape {
1774   my $value = shift;
1775   encode_entities($value);
1776   $value;
1777 }
1778
1779 sub _html_escape_nbsp {
1780   my $value = _html_escape(shift);
1781   $value =~ s/ +/&nbsp;/g;
1782   $value;
1783 }
1784
1785 #utility methods for print_*
1786
1787 sub _translate_old_latex_format {
1788   warn "_translate_old_latex_format called\n"
1789     if $DEBUG;
1790
1791   my @template = ();
1792   while ( @_ ) {
1793     my $line = shift;
1794
1795     if ( $line =~ /^%%Detail\s*$/ ) {
1796
1797       push @template, q![@--!,
1798                       q!  foreach my $_tr_line (@detail_items) {!,
1799                       q!    if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
1800                       q!      $_tr_line->{'description'} .= !,
1801                       q!        "\\tabularnewline\n~~".!,
1802                       q!        join( "\\tabularnewline\n~~",!,
1803                       q!          @{$_tr_line->{'ext_description'}}!,
1804                       q!        );!,
1805                       q!    }!;
1806
1807       while ( ( my $line_item_line = shift )
1808               !~ /^%%EndDetail\s*$/                            ) {
1809         $line_item_line =~ s/'/\\'/g;    # nice LTS
1810         $line_item_line =~ s/\\/\\\\/g;  # escape quotes and backslashes
1811         $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1812         push @template, "    \$OUT .= '$line_item_line';";
1813       }
1814
1815       push @template, '}',
1816                       '--@]';
1817       #' doh, gvim
1818     } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1819
1820       push @template, '[@--',
1821                       '  foreach my $_tr_line (@total_items) {';
1822
1823       while ( ( my $total_item_line = shift )
1824               !~ /^%%EndTotalDetails\s*$/                      ) {
1825         $total_item_line =~ s/'/\\'/g;    # nice LTS
1826         $total_item_line =~ s/\\/\\\\/g;  # escape quotes and backslashes
1827         $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
1828         push @template, "    \$OUT .= '$total_item_line';";
1829       }
1830
1831       push @template, '}',
1832                       '--@]';
1833
1834     } else {
1835       $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
1836       push @template, $line;
1837     }
1838
1839   }
1840
1841   if ($DEBUG) {
1842     warn "$_\n" foreach @template;
1843   }
1844
1845   (@template);
1846 }
1847
1848 sub terms {
1849   my $self = shift;
1850   my $conf = $self->conf;
1851
1852   #check for an invoice-specific override
1853   return $self->invoice_terms if $self->invoice_terms;
1854
1855   #check for a customer- specific override
1856   my $cust_main = $self->cust_main;
1857   return $cust_main->invoice_terms if $cust_main && $cust_main->invoice_terms;
1858
1859   #use configured default
1860   $conf->config('invoice_default_terms') || '';
1861 }
1862
1863 sub due_date {
1864   my $self = shift;
1865   my $duedate = '';
1866   if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
1867     $duedate = $self->_date() + ( $1 * 86400 );
1868   }
1869   $duedate;
1870 }
1871
1872 sub due_date2str {
1873   my $self = shift;
1874   $self->due_date ? $self->time2str_local(shift, $self->due_date) : '';
1875 }
1876
1877 sub balance_due_msg {
1878   my $self = shift;
1879   my $msg = $self->mt('Balance Due');
1880   return $msg unless $self->terms;
1881   if ( $self->due_date ) {
1882     $msg .= ' - ' . $self->mt('Please pay by'). ' '.
1883       $self->due_date2str('short');
1884   } elsif ( $self->terms ) {
1885     $msg .= ' - '. $self->terms;
1886   }
1887   $msg;
1888 }
1889
1890 sub balance_due_date {
1891   my $self = shift;
1892   my $conf = $self->conf;
1893   my $duedate = '';
1894   if (    $conf->exists('invoice_default_terms')
1895        && $conf->config('invoice_default_terms')=~ /^\s*Net\s*(\d+)\s*$/ ) {
1896     $duedate = $self->time2str_local('rdate', $self->_date + ($1*86400) );
1897   }
1898   $duedate;
1899 }
1900
1901 sub credit_balance_msg {
1902   my $self = shift;
1903   $self->mt('Credit Balance Remaining')
1904 }
1905
1906 =item _date_pretty
1907
1908 Returns a string with the date, for example: "3/20/2008", localized for the
1909 customer.  Use _date_pretty_unlocalized for non-end-customer display use.
1910
1911 =cut
1912
1913 sub _date_pretty {
1914   my $self = shift;
1915   $self->time2str_local('short', $self->_date);
1916 }
1917
1918 =item _date_pretty_unlocalized
1919
1920 Returns a string with the date, for example: "3/20/2008", in the format
1921 configured for the back-office.  Use _date_pretty for end-customer display use.
1922
1923 =cut
1924
1925 sub _date_pretty_unlocalized {
1926   my $self = shift;
1927   time2str($date_format, $self->_date);
1928 }
1929
1930 =item _items_sections OPTIONS
1931
1932 Generate section information for all items appearing on this invoice.
1933 This will only be called for multi-section invoices.
1934
1935 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
1936 related display records (L<FS::cust_bill_pkg_display>) and organize
1937 them into two groups ("early" and "late" according to whether they come
1938 before or after the total), then into sections.  A subtotal is calculated
1939 for each section.
1940
1941 Section descriptions are returned in sort weight order.  Each consists
1942 of a hash containing:
1943
1944 description: the package category name, escaped
1945 subtotal: the total charges in that section
1946 tax_section: a flag indicating that the section contains only tax charges
1947 summarized: same as tax_section, for some reason
1948 sort_weight: the package category's sort weight
1949
1950 If 'condense' is set on the display record, it also contains everything
1951 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
1952 coderefs to generate parts of the invoice.  This is not advised.
1953
1954 The method returns two arrayrefs, one of "early" sections and one of "late"
1955 sections.
1956
1957 OPTIONS may include:
1958
1959 by_location: a flag to divide the invoice into sections by location.
1960 Each section hash will have a 'location' element containing a hashref of
1961 the location fields (see L<FS::cust_location>).  The section description
1962 will be the location label, but the template can use any of the location
1963 fields to create a suitable label.
1964
1965 by_category: a flag to divide the invoice into sections using display
1966 records (see L<FS::cust_bill_pkg_display>).  This is the "traditional"
1967 behavior.  Each section hash will have a 'category' element containing
1968 the section name from the display record (which probably equals the
1969 category name of the package, but may not in some cases).
1970
1971 summary: a flag indicating that this is a summary-format invoice.
1972 Turning this on has the following effects:
1973 - Ignores display items with the 'summary' flag.
1974 - Places all sections in the "early" group even if they have post_total.
1975 - Creates sections for all non-disabled package categories, even if they
1976 have no charges on this invoice, as well as a section with no name.
1977
1978 escape: an escape function to use for section titles.
1979
1980 extra_sections: an arrayref of additional sections to return after the
1981 sorted list.  If there are any of these, section subtotals exclude
1982 usage charges.
1983
1984 format: 'latex', 'html', or 'template' (i.e. text).  Not used, but
1985 passed through to C<_condense_section()>.
1986
1987 =cut
1988
1989 use vars qw(%pkg_category_cache);
1990 sub _items_sections {
1991   my $self = shift;
1992   my %opt = @_;
1993
1994   my $escape = $opt{escape};
1995   my @extra_sections = @{ $opt{extra_sections} || [] };
1996
1997   # $subtotal{$locationnum}{$categoryname} = amount.
1998   # if we're not using by_location, $locationnum is undef.
1999   # if we're not using by_category, you guessed it, $categoryname is undef.
2000   # if we're not using either one, we shouldn't be here in the first place...
2001   my %subtotal = ();
2002   my %late_subtotal = ();
2003   my %not_tax = ();
2004
2005   # About tax items + multisection invoices:
2006   # If either invoice_*summary option is enabled, AND there is a
2007   # package category with the name of the tax, then there will be
2008   # a display record assigning the tax item to that category.
2009   #
2010   # However, the taxes are always placed in the "Taxes, Surcharges,
2011   # and Fees" section regardless of that.  The only effect of the
2012   # display record is to create a subtotal for the summary page.
2013
2014   # cache these
2015   my $pkg_hash = $self->cust_pkg_hash;
2016
2017   foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
2018   {
2019
2020       my $usage = $cust_bill_pkg->usage;
2021
2022       my $locationnum;
2023       if ( $opt{by_location} ) {
2024         if ( $cust_bill_pkg->pkgnum ) {
2025           $locationnum = $pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum;
2026         } else {
2027           $locationnum = '';
2028         }
2029       } else {
2030         $locationnum = undef;
2031       }
2032
2033       # as in _items_cust_pkg, if a line item has no display records,
2034       # cust_bill_pkg_display() returns a default record for it
2035
2036       foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
2037         next if ( $display->summary && $opt{summary} );
2038
2039         my $section = $display->section;
2040         my $type    = $display->type;
2041         # Set $section = undef if we're sectioning by location and this
2042         # line item _has_ a location (i.e. isn't a fee).
2043         $section = undef if $locationnum;
2044
2045         # set this flag if the section is not tax-only
2046         $not_tax{$locationnum}{$section} = 1
2047           if $cust_bill_pkg->pkgnum  or $cust_bill_pkg->feepart;
2048
2049         # there's actually a very important piece of logic buried in here:
2050         # incrementing $late_subtotal{$section} CREATES
2051         # $late_subtotal{$section}.  keys(%late_subtotal) is later used
2052         # to define the list of late sections, and likewise keys(%subtotal).
2053         # When _items_cust_bill_pkg is called to generate line items for
2054         # real, it will be called with 'section' => $section for each
2055         # of these.
2056         if ( $display->post_total && !$opt{summary} ) {
2057           if (! $type || $type eq 'S') {
2058             $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2059               if $cust_bill_pkg->setup != 0
2060               || $cust_bill_pkg->setup_show_zero;
2061           }
2062
2063           if (! $type) {
2064             $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur
2065               if $cust_bill_pkg->recur != 0
2066               || $cust_bill_pkg->recur_show_zero;
2067           }
2068
2069           if ($type && $type eq 'R') {
2070             $late_subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2071               if $cust_bill_pkg->recur != 0
2072               || $cust_bill_pkg->recur_show_zero;
2073           }
2074
2075           if ($type && $type eq 'U') {
2076             $late_subtotal{$locationnum}{$section} += $usage
2077               unless scalar(@extra_sections);
2078           }
2079
2080         } else { # it's a pre-total (normal) section
2081
2082           # skip tax items unless they're explicitly included in a section
2083           next if $cust_bill_pkg->pkgnum == 0 and
2084                   ! $cust_bill_pkg->feepart   and
2085                   ! $section;
2086
2087           if ( $type eq 'S' ) {
2088             $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2089               if $cust_bill_pkg->setup != 0
2090               || $cust_bill_pkg->setup_show_zero;
2091           } elsif ( $type eq 'R' ) {
2092             $subtotal{$locationnum}{$section} += $cust_bill_pkg->recur - $usage
2093               if $cust_bill_pkg->recur != 0
2094               || $cust_bill_pkg->recur_show_zero;
2095           } elsif ( $type eq 'U' ) {
2096             $subtotal{$locationnum}{$section} += $usage
2097               unless scalar(@extra_sections);
2098           } elsif ( !$type ) {
2099             $subtotal{$locationnum}{$section} += $cust_bill_pkg->setup
2100                                                + $cust_bill_pkg->recur;
2101           }
2102
2103         }
2104
2105       }
2106
2107   }
2108
2109   %pkg_category_cache = ();
2110
2111   # summary invoices need subtotals for all non-disabled package categories,
2112   # even if they're zero
2113   # but currently assume that there are no location sections, or at least
2114   # that the summary page doesn't care about them
2115   if ( $opt{summary} ) {
2116     foreach my $category (qsearch('pkg_category', {disabled => ''})) {
2117       $subtotal{''}{$category->categoryname} ||= 0;
2118     }
2119     $subtotal{''}{''} ||= 0;
2120   }
2121
2122   my @sections;
2123   foreach my $post_total (0,1) {
2124     my @these;
2125     my $s = $post_total ? \%late_subtotal : \%subtotal;
2126     foreach my $locationnum (keys %$s) {
2127       foreach my $sectionname (keys %{ $s->{$locationnum} }) {
2128         my $section = {
2129                         'subtotal'    => $s->{$locationnum}{$sectionname},
2130                         'post_total'  => $post_total,
2131                         'sort_weight' => 0,
2132                       };
2133         if ( $locationnum ) {
2134           $section->{'locationnum'} = $locationnum;
2135           my $location = FS::cust_location->by_key($locationnum);
2136           $section->{'description'} = &{ $escape }($location->location_label);
2137           # Better ideas? This will roughly group them by proximity,
2138           # which alpha sorting on any of the address fields won't.
2139           # Sorting by locationnum is meaningless.
2140           # We have to sort on _something_ or the order may change
2141           # randomly from one invoice to the next, which will confuse
2142           # people.
2143           $section->{'sort_weight'} = sprintf('%012s',$location->zip) .
2144                                       $locationnum;
2145           $section->{'location'} = {
2146             label_prefix => &{ $escape }($location->label_prefix),
2147             map { $_ => &{ $escape }($location->get($_)) }
2148               $location->fields
2149           };
2150         } else {
2151           $section->{'category'} = $sectionname;
2152           $section->{'description'} = &{ $escape }($sectionname);
2153           if ( _pkg_category($sectionname) ) {
2154             $section->{'sort_weight'} = _pkg_category($sectionname)->weight;
2155             if ( _pkg_category($sectionname)->condense ) {
2156               $section = { %$section, $self->_condense_section($opt{format}) };
2157             }
2158           }
2159         }
2160         if ( !$post_total and !$not_tax{$locationnum}{$sectionname} ) {
2161           # then it's a tax-only section
2162           $section->{'summarized'} = 'Y';
2163           $section->{'tax_section'} = 'Y';
2164         }
2165         push @these, $section;
2166       } # foreach $sectionname
2167     } #foreach $locationnum
2168     push @these, @extra_sections if $post_total == 0;
2169     # need an alpha sort for location sections, because postal codes can
2170     # be non-numeric
2171     $sections[ $post_total ] = [ sort {
2172       $opt{'by_location'} ?
2173         ($a->{sort_weight} cmp $b->{sort_weight}) :
2174         ($a->{sort_weight} <=> $b->{sort_weight})
2175       } @these ];
2176   } #foreach $post_total
2177
2178   return @sections; # early, late
2179 }
2180
2181 #helper subs for above
2182
2183 sub cust_pkg_hash {
2184   my $self = shift;
2185   $self->{cust_pkg} ||= { map { $_->pkgnum => $_ } $self->cust_pkg };
2186 }
2187
2188 sub _pkg_category {
2189   my $categoryname = shift;
2190   $pkg_category_cache{$categoryname} ||=
2191     qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
2192 }
2193
2194 my %condensed_format = (
2195   'label' => [ qw( Description Qty Amount ) ],
2196   'fields' => [
2197                 sub { shift->{description} },
2198                 sub { shift->{quantity} },
2199                 sub { my($href, %opt) = @_;
2200                       ($opt{dollar} || ''). $href->{amount};
2201                     },
2202               ],
2203   'align'  => [ qw( l r r ) ],
2204   'span'   => [ qw( 5 1 1 ) ],            # unitprices?
2205   'width'  => [ qw( 10.7cm 1.4cm 1.6cm ) ],   # don't like this
2206 );
2207
2208 sub _condense_section {
2209   my ( $self, $format ) = ( shift, shift );
2210   ( 'condensed' => 1,
2211     map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
2212       qw( description_generator
2213           header_generator
2214           total_generator
2215           total_line_generator
2216         )
2217   );
2218 }
2219
2220 sub _condensed_generator_defaults {
2221   my ( $self, $format ) = ( shift, shift );
2222   return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
2223 }
2224
2225 my %html_align = (
2226   'c' => 'center',
2227   'l' => 'left',
2228   'r' => 'right',
2229 );
2230
2231 sub _condensed_header_generator {
2232   my ( $self, $format ) = ( shift, shift );
2233
2234   my ( $f, $prefix, $suffix, $separator, $column ) =
2235     _condensed_generator_defaults($format);
2236
2237   if ($format eq 'latex') {
2238     $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
2239     $suffix = "\\\\\n\\hline";
2240     $separator = "&\n";
2241     $column =
2242       sub { my ($d,$a,$s,$w) = @_;
2243             return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2244           };
2245   } elsif ( $format eq 'html' ) {
2246     $prefix = '<th></th>';
2247     $suffix = '';
2248     $separator = '';
2249     $column =
2250       sub { my ($d,$a,$s,$w) = @_;
2251             return qq!<th align="$html_align{$a}">$d</th>!;
2252       };
2253   }
2254
2255   sub {
2256     my @args = @_;
2257     my @result = ();
2258
2259     foreach  (my $i = 0; $f->{label}->[$i]; $i++) {
2260       push @result,
2261         &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
2262     }
2263
2264     $prefix. join($separator, @result). $suffix;
2265   };
2266
2267 }
2268
2269 sub _condensed_description_generator {
2270   my ( $self, $format ) = ( shift, shift );
2271
2272   my ( $f, $prefix, $suffix, $separator, $column ) =
2273     _condensed_generator_defaults($format);
2274
2275   my $money_char = '$';
2276   if ($format eq 'latex') {
2277     $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
2278     $suffix = '\\\\';
2279     $separator = " & \n";
2280     $column =
2281       sub { my ($d,$a,$s,$w) = @_;
2282             return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
2283           };
2284     $money_char = '\\dollar';
2285   }elsif ( $format eq 'html' ) {
2286     $prefix = '"><td align="center"></td>';
2287     $suffix = '';
2288     $separator = '';
2289     $column =
2290       sub { my ($d,$a,$s,$w) = @_;
2291             return qq!<td align="$html_align{$a}">$d</td>!;
2292       };
2293     #$money_char = $conf->config('money_char') || '$';
2294     $money_char = '';  # this is madness
2295   }
2296
2297   sub {
2298     #my @args = @_;
2299     my $href = shift;
2300     my @result = ();
2301
2302     foreach  (my $i = 0; $f->{label}->[$i]; $i++) {
2303       my $dollar = '';
2304       $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
2305       push @result,
2306         &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
2307                     map { $f->{$_}->[$i] } qw(align span width)
2308                   );
2309     }
2310
2311     $prefix. join( $separator, @result ). $suffix;
2312   };
2313
2314 }
2315
2316 sub _condensed_total_generator {
2317   my ( $self, $format ) = ( shift, shift );
2318
2319   my ( $f, $prefix, $suffix, $separator, $column ) =
2320     _condensed_generator_defaults($format);
2321   my $style = '';
2322
2323   if ($format eq 'latex') {
2324     $prefix = "& ";
2325     $suffix = "\\\\\n";
2326     $separator = " & \n";
2327     $column =
2328       sub { my ($d,$a,$s,$w) = @_;
2329             return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2330           };
2331   }elsif ( $format eq 'html' ) {
2332     $prefix = '';
2333     $suffix = '';
2334     $separator = '';
2335     $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2336     $column =
2337       sub { my ($d,$a,$s,$w) = @_;
2338             return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2339       };
2340   }
2341
2342
2343   sub {
2344     my @args = @_;
2345     my @result = ();
2346
2347     #  my $r = &{$f->{fields}->[$i]}(@args);
2348     #  $r .= ' Total' unless $i;
2349
2350     foreach  (my $i = 0; $f->{label}->[$i]; $i++) {
2351       push @result,
2352         &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
2353                     map { $f->{$_}->[$i] } qw(align span width)
2354                   );
2355     }
2356
2357     $prefix. join( $separator, @result ). $suffix;
2358   };
2359
2360 }
2361
2362 =item total_line_generator FORMAT
2363
2364 Returns a coderef used for generation of invoice total line items for this
2365 usage_class.  FORMAT is either html or latex
2366
2367 =cut
2368
2369 # should not be used: will have issues with hash element names (description vs
2370 # total_item and amount vs total_amount -- another array of functions?
2371
2372 sub _condensed_total_line_generator {
2373   my ( $self, $format ) = ( shift, shift );
2374
2375   my ( $f, $prefix, $suffix, $separator, $column ) =
2376     _condensed_generator_defaults($format);
2377   my $style = '';
2378
2379   if ($format eq 'latex') {
2380     $prefix = "& ";
2381     $suffix = "\\\\\n";
2382     $separator = " & \n";
2383     $column =
2384       sub { my ($d,$a,$s,$w) = @_;
2385             return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
2386           };
2387   }elsif ( $format eq 'html' ) {
2388     $prefix = '';
2389     $suffix = '';
2390     $separator = '';
2391     $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
2392     $column =
2393       sub { my ($d,$a,$s,$w) = @_;
2394             return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
2395       };
2396   }
2397
2398
2399   sub {
2400     my @args = @_;
2401     my @result = ();
2402
2403     foreach  (my $i = 0; $f->{label}->[$i]; $i++) {
2404       push @result,
2405         &{$column}( &{$f->{fields}->[$i]}(@args),
2406                     map { $f->{$_}->[$i] } qw(align span width)
2407                   );
2408     }
2409
2410     $prefix. join( $separator, @result ). $suffix;
2411   };
2412
2413 }
2414
2415 =item _items_pkg [ OPTIONS ]
2416
2417 Return line item hashes for each package item on this invoice. Nearly
2418 equivalent to
2419
2420 $self->_items_cust_bill_pkg([ $self->cust_bill_pkg ])
2421
2422 The only OPTIONS accepted is 'section', which may point to a hashref
2423 with a key named 'condensed', which may have a true value.  If it
2424 does, this method tries to merge identical items into items with
2425 'quantity' equal to the number of items (not the sum of their
2426 separate quantities, for some reason).
2427
2428 =cut
2429
2430 sub _items_nontax {
2431   my $self = shift;
2432   # The order of these is important.  Bundled line items will be merged into
2433   # the most recent non-hidden item, so it needs to be the one with:
2434   # - the same pkgnum
2435   # - the same start date
2436   # - no pkgpart_override
2437   #
2438   # So: sort by pkgnum,
2439   # then by sdate
2440   # then sort the base line item before any overrides
2441   # then sort hidden before non-hidden add-ons
2442   # then sort by override pkgpart (for consistency)
2443   sort { $a->pkgnum <=> $b->pkgnum        or
2444          $a->sdate  <=> $b->sdate         or
2445          ($a->pkgpart_override ? 0 : -1)  or
2446          ($b->pkgpart_override ? 0 : 1)   or
2447          $b->hidden cmp $a->hidden        or
2448          $a->pkgpart_override <=> $b->pkgpart_override
2449        }
2450   # and of course exclude taxes and fees
2451   grep { $_->pkgnum > 0 } $self->cust_bill_pkg;
2452 }
2453
2454 sub _items_fee {
2455   my $self = shift;
2456   my %options = @_;
2457   my @cust_bill_pkg = grep { $_->feepart } $self->cust_bill_pkg;
2458   my @items;
2459   foreach my $cust_bill_pkg (@cust_bill_pkg) {
2460     # cache this, so we don't look it up again in every section
2461     my $part_fee = $cust_bill_pkg->get('part_fee')
2462        || $cust_bill_pkg->part_fee;
2463     $cust_bill_pkg->set('part_fee', $part_fee);
2464     if (!$part_fee) {
2465       #die "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n"; # might make more sense
2466       warn "fee definition not found for line item #".$cust_bill_pkg->billpkgnum."\n";
2467       next;
2468     }
2469     if ( exists($options{section}) and exists($options{section}{category}) )
2470     {
2471       my $categoryname = $options{section}{category};
2472       # then filter for items that have that section
2473       if ( $part_fee->categoryname ne $categoryname ) {
2474         warn "skipping fee '".$part_fee->itemdesc."'--not in section $categoryname\n" if $DEBUG;
2475         next;
2476       }
2477     } # otherwise include them all in the main section
2478     # XXX what to do when sectioning by location?
2479
2480     my @ext_desc;
2481     my %base_invnums; # invnum => invoice date
2482     foreach ($cust_bill_pkg->cust_bill_pkg_fee) {
2483       if ($_->base_invnum) {
2484         my $base_bill = FS::cust_bill->by_key($_->base_invnum);
2485         my $base_date = $self->time2str_local('short', $base_bill->_date)
2486           if $base_bill;
2487         $base_invnums{$_->base_invnum} = $base_date || '';
2488       }
2489     }
2490     foreach (sort keys(%base_invnums)) {
2491       next if $_ == $self->invnum;
2492       push @ext_desc,
2493         $self->mt('from invoice \\#[_1] on [_2]', $_, $base_invnums{$_});
2494     }
2495     push @items,
2496       { feepart     => $cust_bill_pkg->feepart,
2497         amount      => sprintf('%.2f', $cust_bill_pkg->setup + $cust_bill_pkg->recur),
2498         description => $part_fee->itemdesc_locale($self->cust_main->locale),
2499         ext_description => \@ext_desc
2500         # sdate/edate?
2501       };
2502   }
2503   @items;
2504 }
2505
2506 sub _items_pkg {
2507   my $self = shift;
2508   my %options = @_;
2509
2510   warn "$me _items_pkg searching for all package line items\n"
2511     if $DEBUG > 1;
2512
2513   my @cust_bill_pkg = $self->_items_nontax;
2514
2515   warn "$me _items_pkg filtering line items\n"
2516     if $DEBUG > 1;
2517   my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2518
2519   if ($options{section} && $options{section}->{condensed}) {
2520
2521     warn "$me _items_pkg condensing section\n"
2522       if $DEBUG > 1;
2523
2524     my %itemshash = ();
2525     local $Storable::canonical = 1;
2526     foreach ( @items ) {
2527       my $item = { %$_ };
2528       delete $item->{ref};
2529       delete $item->{ext_description};
2530       my $key = freeze($item);
2531       $itemshash{$key} ||= 0;
2532       $itemshash{$key} ++; # += $item->{quantity};
2533     }
2534     @items = sort { $a->{description} cmp $b->{description} }
2535              map { my $i = thaw($_);
2536                    $i->{quantity} = $itemshash{$_};
2537                    $i->{amount} =
2538                      sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
2539                    $i;
2540                  }
2541              keys %itemshash;
2542   }
2543
2544   warn "$me _items_pkg returning ". scalar(@items). " items\n"
2545     if $DEBUG > 1;
2546
2547   @items;
2548 }
2549
2550 sub _taxsort {
2551   return 0 unless $a->itemdesc cmp $b->itemdesc;
2552   return -1 if $b->itemdesc eq 'Tax';
2553   return 1 if $a->itemdesc eq 'Tax';
2554   return -1 if $b->itemdesc eq 'Other surcharges';
2555   return 1 if $a->itemdesc eq 'Other surcharges';
2556   $a->itemdesc cmp $b->itemdesc;
2557 }
2558
2559 sub _items_tax {
2560   my $self = shift;
2561   my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum and ! $_->feepart }
2562     $self->cust_bill_pkg;
2563   my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2564
2565   if ( $self->conf->exists('always_show_tax') ) {
2566     my $itemdesc = $self->conf->config('always_show_tax') || 'Tax';
2567     if (0 == grep { $_->{description} eq $itemdesc } @items) {
2568       push @items,
2569         { 'description' => $itemdesc,
2570           'amount'      => 0.00 };
2571     }
2572   }
2573   @items;
2574 }
2575
2576 =item _items_cust_bill_pkg CUST_BILL_PKGS OPTIONS
2577
2578 Takes an arrayref of L<FS::cust_bill_pkg> objects, and returns a
2579 list of hashrefs describing the line items they generate on the invoice.
2580
2581 OPTIONS may include:
2582
2583 format: the invoice format.
2584
2585 escape_function: the function used to escape strings.
2586
2587 DEPRECATED? (expensive, mostly unused?)
2588 format_function: the function used to format CDRs.
2589
2590 section: a hashref containing 'category' and/or 'locationnum'; if this
2591 is present, only returns line items that belong to that category and/or
2592 location (whichever is defined).
2593
2594 multisection: a flag indicating that this is a multisection invoice,
2595 which does something complicated.
2596
2597 preref_callback: coderef run for each line item, code should return HTML to be
2598 displayed before that line item (quotations only)
2599
2600 Returns a list of hashrefs, each of which may contain:
2601
2602 pkgnum, description, amount, unit_amount, quantity, pkgpart, _is_setup, and
2603 ext_description, which is an arrayref of detail lines to show below
2604 the package line.
2605
2606 =cut
2607
2608 sub _items_cust_bill_pkg {
2609   my $self = shift;
2610   my $conf = $self->conf;
2611   my $cust_bill_pkgs = shift;
2612   my %opt = @_;
2613
2614   my $format = $opt{format} || '';
2615   my $escape_function = $opt{escape_function} || sub { shift };
2616   my $format_function = $opt{format_function} || '';
2617   my $no_usage = $opt{no_usage} || '';
2618   my $unsquelched = $opt{unsquelched} || ''; #unused
2619   my ($section, $locationnum, $category);
2620   if ( $opt{section} ) {
2621     $category = $opt{section}->{category};
2622     $locationnum = $opt{section}->{locationnum};
2623   }
2624   my $summary_page = $opt{summary_page} || ''; #unused
2625   my $multisection = defined($category) || defined($locationnum);
2626   my $discount_show_always = 0;
2627
2628   my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
2629
2630   my $cust_main = $self->cust_main;#for per-agent cust_bill-line_item-ate_style
2631                                    # and location labels
2632
2633   my @b = (); # accumulator for the line item hashes that we'll return
2634   my ($s, $r, $u, $d) = ( undef, undef, undef );
2635             # the 'current' line item hashes for setup, recur, usage, discount
2636   foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
2637   {
2638     # if the current line item is waiting to go out, and the one we're about
2639     # to start is not bundled, then push out the current one and start a new
2640     # one.
2641     foreach ( $s, $r, ($opt{skip_usage} ? () : $u ) , $d ) {
2642       if ( $_ && !$cust_bill_pkg->hidden ) {
2643         $_->{amount}      = sprintf( "%.2f", $_->{amount} );
2644         $_->{amount}      =~ s/^\-0\.00$/0.00/;
2645         if (exists($_->{unit_amount})) {
2646           $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
2647         }
2648         push @b, { %$_ }
2649           if $_->{amount} != 0
2650           || $discount_show_always
2651           || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
2652           || (   $_->{_is_setup} && $_->{setup_show_zero} )
2653         ;
2654         $_ = undef;
2655       }
2656     }
2657
2658     if ( $locationnum ) {
2659       # this is a location section; skip packages that aren't at this
2660       # service location.
2661       next if $cust_bill_pkg->pkgnum == 0; # skips fees...
2662       next if $self->cust_pkg_hash->{ $cust_bill_pkg->pkgnum }->locationnum
2663               != $locationnum;
2664     }
2665
2666     # Consider display records for this item to determine if it belongs
2667     # in this section.  Note that if there are no display records, there
2668     # will be a default pseudo-record that includes all charge types
2669     # and has no section name.
2670     my @cust_bill_pkg_display = $cust_bill_pkg->can('cust_bill_pkg_display')
2671                                   ? $cust_bill_pkg->cust_bill_pkg_display
2672                                   : ( $cust_bill_pkg );
2673
2674     warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
2675          $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
2676       if $DEBUG > 1;
2677
2678     if ( defined($category) ) {
2679       # then this is a package category section; process all display records
2680       # that belong to this section.
2681       @cust_bill_pkg_display = grep { $_->section eq $category }
2682                                 @cust_bill_pkg_display;
2683     } else {
2684       # otherwise, process all display records that aren't usage summaries
2685       # (I don't think there should be usage summaries if you aren't using
2686       # category sections, but this is the historical behavior)
2687       @cust_bill_pkg_display = grep { !$_->summary }
2688                                 @cust_bill_pkg_display;
2689     }
2690
2691     my $classname = ''; # package class name, will fill in later
2692
2693     foreach my $display (@cust_bill_pkg_display) {
2694
2695       warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
2696            $display->billpkgdisplaynum. "\n"
2697         if $DEBUG > 1;
2698
2699       my $type = $display->type;
2700
2701       my $desc = $cust_bill_pkg->desc( $cust_main ? $cust_main->locale : '' );
2702       $desc = substr($desc, 0, $maxlength). '...'
2703         if $format eq 'latex' && length($desc) > $maxlength;
2704
2705       my %details_opt = ( 'format'          => $format,
2706                           'escape_function' => $escape_function,
2707                           'format_function' => $format_function,
2708                           'no_usage'        => $opt{'no_usage'},
2709                         );
2710
2711       if ( ref($cust_bill_pkg) eq 'FS::quotation_pkg' ) {
2712
2713         warn "$me _items_cust_bill_pkg cust_bill_pkg is quotation_pkg\n"
2714           if $DEBUG > 1;
2715         # quotation_pkgs are never fees, so don't worry about the case where
2716         # part_pkg is undefined
2717
2718         # and I guess they're never bundled either?
2719         if ( $cust_bill_pkg->setup != 0 ) {
2720           my $description = $desc;
2721           $description .= ' Setup'
2722             if $cust_bill_pkg->recur != 0
2723             || $discount_show_always
2724             || $cust_bill_pkg->recur_show_zero;
2725           push @b, {
2726             'pkgnum'      => $cust_bill_pkg->pkgpart, #so it displays in Ref
2727             'description' => $description,
2728             'amount'      => sprintf("%.2f", $cust_bill_pkg->setup),
2729             'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitsetup),
2730             'quantity'    => $cust_bill_pkg->quantity,
2731             'preref_html' => ( $opt{preref_callback}
2732                                  ? &{ $opt{preref_callback} }( $cust_bill_pkg )
2733                                  : ''
2734                              ),
2735           };
2736         }
2737         if ( $cust_bill_pkg->recur != 0 ) {
2738           push @b, {
2739             'pkgnum'      => $cust_bill_pkg->pkgpart, #so it displays in Ref
2740             'description' => "$desc (". $cust_bill_pkg->part_pkg->freq_pretty.")",
2741             'amount'      => sprintf("%.2f", $cust_bill_pkg->recur),
2742             'unit_amount' => sprintf("%.2f", $cust_bill_pkg->unitrecur),
2743             'quantity'    => $cust_bill_pkg->quantity,
2744            'preref_html'  => ( $opt{preref_callback}
2745                                  ? &{ $opt{preref_callback} }( $cust_bill_pkg )
2746                                  : ''
2747                              ),
2748           };
2749         }
2750
2751       } elsif ( $cust_bill_pkg->pkgnum > 0 ) {
2752         # a "normal" package line item (not a quotation, not a fee, not a tax)
2753
2754         warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
2755           if $DEBUG > 1;
2756
2757         my $cust_pkg = $cust_bill_pkg->cust_pkg;
2758         my $part_pkg = $cust_pkg->part_pkg;
2759
2760         # which pkgpart to show for display purposes?
2761         my $pkgpart = $cust_bill_pkg->pkgpart_override || $cust_pkg->pkgpart;
2762
2763         # start/end dates for invoice formats that do nonstandard
2764         # things with them
2765         my %item_dates = ();
2766         %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate')
2767           unless $part_pkg->option('disable_line_item_date_ranges',1);
2768
2769         # not normally used, but pass this to the template anyway
2770         $classname = $part_pkg->classname;
2771
2772         if (    (!$type || $type eq 'S')
2773              && (    $cust_bill_pkg->setup != 0
2774                   || $cust_bill_pkg->setup_show_zero
2775                 )
2776            )
2777          {
2778
2779           warn "$me _items_cust_bill_pkg adding setup\n"
2780             if $DEBUG > 1;
2781
2782           my $description = $desc;
2783           $description .= ' Setup'
2784             if $cust_bill_pkg->recur != 0
2785             || $discount_show_always
2786             || $cust_bill_pkg->recur_show_zero;
2787
2788           $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
2789                                                               $self->agentnum )
2790             if $part_pkg->is_prepaid #for prepaid, "display the validity period
2791                                      # triggered by the recurring charge freq
2792                                      # (RT#26274)
2793             && $cust_bill_pkg->recur == 0
2794             && ! $cust_bill_pkg->recur_show_zero;
2795
2796           my @d = ();
2797           my $svc_label;
2798
2799           # always pass the svc_label through to the template, even if
2800           # not displaying it as an ext_description
2801           my @svc_labels = map &{$escape_function}($_),
2802                       $cust_pkg->h_labels_short($self->_date, undef, 'I');
2803
2804           $svc_label = $svc_labels[0];
2805
2806           unless ( $cust_pkg->part_pkg->hide_svc_detail
2807                 || $cust_bill_pkg->hidden )
2808           {
2809
2810             push @d, @svc_labels
2811               unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
2812             my $lnum = $cust_main ? $cust_main->ship_locationnum
2813                                   : $self->prospect_main->locationnum;
2814             # show the location label if it's not the customer's default
2815             # location, and we're not grouping items by location already
2816             if ( $cust_pkg->locationnum != $lnum and !defined($locationnum) ) {
2817               my $loc = $cust_pkg->location_label;
2818               $loc = substr($loc, 0, $maxlength). '...'
2819                 if $format eq 'latex' && length($loc) > $maxlength;
2820               push @d, &{$escape_function}($loc);
2821             }
2822
2823           } #unless hiding service details
2824
2825           push @d, $cust_bill_pkg->details(%details_opt)
2826             if $cust_bill_pkg->recur == 0;
2827
2828           if ( $cust_bill_pkg->hidden ) {
2829             $s->{amount}      += $cust_bill_pkg->setup;
2830             $s->{unit_amount} += $cust_bill_pkg->unitsetup;
2831             push @{ $s->{ext_description} }, @d;
2832           } else {
2833             $s = {
2834               _is_setup       => 1,
2835               description     => $description,
2836               pkgpart         => $pkgpart,
2837               pkgnum          => $cust_bill_pkg->pkgnum,
2838               amount          => $cust_bill_pkg->setup,
2839               setup_show_zero => $cust_bill_pkg->setup_show_zero,
2840               unit_amount     => $cust_bill_pkg->unitsetup,
2841               quantity        => $cust_bill_pkg->quantity,
2842               ext_description => \@d,
2843               svc_label       => ($svc_label || ''),
2844               locationnum     => $cust_pkg->locationnum, # sure, why not?
2845             };
2846           };
2847
2848         }
2849
2850         if (    ( !$type || $type eq 'R' || $type eq 'U' )
2851              && (
2852                      $cust_bill_pkg->recur != 0
2853                   || $cust_bill_pkg->setup == 0
2854                   || $discount_show_always
2855                   || $cust_bill_pkg->recur_show_zero
2856                 )
2857            )
2858         {
2859
2860           warn "$me _items_cust_bill_pkg adding recur/usage\n"
2861             if $DEBUG > 1;
2862
2863           my $is_summary = $display->summary;
2864           my $description = $desc;
2865           if ( $type eq 'U' and defined($r) ) {
2866             # don't just show the same description as the recur line
2867             $description = $self->mt('Usage charges');
2868           }
2869
2870           my $part_pkg = $cust_pkg->part_pkg;
2871
2872           $description .= $cust_bill_pkg->time_period_pretty( $part_pkg,
2873                                                               $self->agentnum );
2874
2875           my @d = ();
2876           my @seconds = (); # for display of usage info
2877           my $svc_label = '';
2878
2879           #at least until cust_bill_pkg has "past" ranges in addition to
2880           #the "future" sdate/edate ones... see #3032
2881           my @dates = ( $self->_date );
2882           my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
2883           push @dates, $prev->sdate if $prev;
2884           push @dates, undef if !$prev;
2885
2886           my @svc_labels = map &{$escape_function}($_),
2887                       $cust_pkg->h_labels_short(@dates, 'I');
2888           $svc_label = $svc_labels[0];
2889
2890           # show service labels, unless...
2891                     # the package is set not to display them
2892           unless ( $part_pkg->hide_svc_detail
2893                     # or this is a tax-like line item
2894                 || $cust_bill_pkg->itemdesc
2895                     # or this is a hidden (bundled) line item
2896                 || $cust_bill_pkg->hidden
2897                     # or this is a usage summary line
2898                 || $is_summary && $type && $type eq 'U'
2899                     # or this is a usage line and there's a recurring line
2900                     # for the package in the same section (which will
2901                     # have service labels already)
2902                 || ($type eq 'U' and defined($r))
2903               )
2904           {
2905
2906             warn "$me _items_cust_bill_pkg adding service details\n"
2907               if $DEBUG > 1;
2908
2909             push @d, @svc_labels
2910               unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
2911             warn "$me _items_cust_bill_pkg done adding service details\n"
2912               if $DEBUG > 1;
2913
2914             my $lnum = $cust_main ? $cust_main->ship_locationnum
2915                                   : $self->prospect_main->locationnum;
2916             # show the location label if it's not the customer's default
2917             # location, and we're not grouping items by location already
2918             if ( $cust_pkg->locationnum != $lnum and !defined($locationnum) ) {
2919               my $loc = $cust_pkg->location_label;
2920               $loc = substr($loc, 0, $maxlength). '...'
2921                 if $format eq 'latex' && length($loc) > $maxlength;
2922               push @d, &{$escape_function}($loc);
2923             }
2924
2925             # Display of seconds_since_sqlradacct:
2926             # On the invoice, when processing @detail_items, look for a field
2927             # named 'seconds'.  This will contain total seconds for each
2928             # service, in the same order as @ext_description.  For services
2929             # that don't support this it will show undef.
2930             if ( $conf->exists('svc_acct-usage_seconds')
2931                  and ! $cust_bill_pkg->pkgpart_override ) {
2932               foreach my $cust_svc (
2933                   $cust_pkg->h_cust_svc(@dates, 'I')
2934                 ) {
2935
2936                 # eval because not having any part_export_usage exports
2937                 # is a fatal error, last_bill/_date because that's how
2938                 # sqlradius_hour billing does it
2939                 my $sec = eval {
2940                   $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
2941                 };
2942                 push @seconds, $sec;
2943               }
2944             } #if svc_acct-usage_seconds
2945
2946           } # if we are showing service labels
2947
2948           unless ( $is_summary ) {
2949             warn "$me _items_cust_bill_pkg adding details\n"
2950               if $DEBUG > 1;
2951
2952             #instead of omitting details entirely in this case (unwanted side
2953             # effects), just omit CDRs
2954             $details_opt{'no_usage'} = 1
2955               if $type && $type eq 'R';
2956
2957             push @d, $cust_bill_pkg->details(%details_opt);
2958           }
2959
2960           warn "$me _items_cust_bill_pkg calculating amount\n"
2961             if $DEBUG > 1;
2962
2963           my $amount = 0;
2964           if (!$type) {
2965             $amount = $cust_bill_pkg->recur;
2966           } elsif ($type eq 'R') {
2967             $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
2968           } elsif ($type eq 'U') {
2969             $amount = $cust_bill_pkg->usage;
2970           }
2971
2972           if ( !$type || $type eq 'R' ) {
2973
2974             warn "$me _items_cust_bill_pkg adding recur\n"
2975               if $DEBUG > 1;
2976
2977             my $unit_amount =
2978               ( $cust_bill_pkg->unitrecur > 0 ) ? $cust_bill_pkg->unitrecur
2979                                                 : $amount;
2980
2981             if ( $cust_bill_pkg->hidden ) {
2982               $r->{amount}      += $amount;
2983               $r->{unit_amount} += $unit_amount;
2984               push @{ $r->{ext_description} }, @d;
2985             } else {
2986               $r = {
2987                 description     => $description,
2988                 pkgpart         => $pkgpart,
2989                 pkgnum          => $cust_bill_pkg->pkgnum,
2990                 amount          => $amount,
2991                 recur_show_zero => $cust_bill_pkg->recur_show_zero,
2992                 unit_amount     => $unit_amount,
2993                 quantity        => $cust_bill_pkg->quantity,
2994                 %item_dates,
2995                 ext_description => \@d,
2996                 svc_label       => ($svc_label || ''),
2997                 locationnum     => $cust_pkg->locationnum,
2998               };
2999               $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
3000             }
3001
3002           } else {  # $type eq 'U'
3003
3004             warn "$me _items_cust_bill_pkg adding usage\n"
3005               if $DEBUG > 1;
3006
3007             if ( $cust_bill_pkg->hidden and defined($u) ) {
3008               # if this is a hidden package and there's already a usage
3009               # line for the bundle, add this package's total amount and
3010               # usage details to it
3011               $u->{amount}      += $amount;
3012               push @{ $u->{ext_description} }, @d;
3013             } elsif ( $amount ) {
3014               # create a new usage line
3015               $u = {
3016                 description     => $description,
3017                 pkgpart         => $pkgpart,
3018                 pkgnum          => $cust_bill_pkg->pkgnum,
3019                 amount          => $amount,
3020                 usage_item      => 1,
3021                 recur_show_zero => $cust_bill_pkg->recur_show_zero,
3022                 %item_dates,
3023                 ext_description => \@d,
3024                 locationnum     => $cust_pkg->locationnum,
3025               };
3026             } # else this has no usage, so don't create a usage section
3027           }
3028
3029         } # recurring or usage with recurring charge
3030
3031         # decide whether to show active discounts here
3032         if (
3033             # case 1: we are showing a single line for the package
3034             ( !$type )
3035             # case 2: we are showing a setup line for a package that has
3036             # no base recurring fee
3037             or ( $type eq 'S' and $cust_bill_pkg->unitrecur == 0 )
3038             # case 3: we are showing a recur line for a package that has
3039             # a base recurring fee
3040             or ( $type eq 'R' and $cust_bill_pkg->unitrecur > 0 )
3041         ) {
3042
3043           my @discounts = $cust_bill_pkg->cust_bill_pkg_discount;
3044           # special case: if there are old "discount details" on this line
3045           # item, don't show discount line items
3046           if ( FS::cust_bill_pkg_detail->count(
3047               "detail LIKE 'Includes discount%' AND billpkgnum = " .
3048               $cust_bill_pkg->billpkgnum
3049              ) > 0 ) {
3050              @discounts = ();
3051           }
3052           if( @discounts ) {
3053             warn "$me _items_cust_bill_pkg including discounts for ".
3054               $cust_bill_pkg->billpkgnum."\n"
3055               if $DEBUG;
3056             my $discount_amount = sum( map {$_->amount} @discounts );
3057             my $orig_amount = $cust_bill_pkg->setup + $cust_bill_pkg->recur
3058                               + $discount_amount;
3059             # if multiple discounts apply to the same package, how to display
3060             # them? ext_description lines, apparently
3061             if ( $d and $cust_bill_pkg->hidden ) {
3062               $d->{amount}      += $discount_amount;
3063               $d->{orig_amount} += $orig_amount;
3064             } else {
3065               my @ext;
3066               # make a placeholder for the original price, if necessary
3067               # (if unit prices are enabled, it won't be necessary)
3068               push @ext, '' if !$conf->exists('invoice-unitprice');
3069               $d = {
3070                 _is_discount    => 1,
3071                 description     => $self->mt('Discount included'),
3072                 amount          => $discount_amount,
3073                 orig_amount     => $orig_amount,
3074                 ext_description => \@ext,
3075               };
3076               foreach my $cust_bill_pkg_discount (@discounts) {
3077                 my $def = $cust_bill_pkg_discount->cust_pkg_discount->discount;
3078                 push @ext, &{$escape_function}( $def->description );
3079               }
3080             }
3081
3082             # update the placeholder to show the original price in the
3083             # first ext_description line
3084             if ( !$conf->exists('invoice-unitprice') ) {
3085               $d->{ext_description}->[0] =
3086                 sprintf('Original price: %.2f', $d->{orig_amount});
3087             }
3088           } # if there are any discounts
3089         } # if this is an appropriate place to show discounts
3090
3091       } else { # taxes and fees
3092
3093         warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
3094           if $DEBUG > 1;
3095
3096         # items of this kind should normally not have sdate/edate.
3097         push @b, {
3098           'description' => $desc,
3099           'amount'      => sprintf('%.2f', $cust_bill_pkg->setup
3100                                            + $cust_bill_pkg->recur)
3101         };
3102
3103       } # if quotation / package line item / other line item
3104
3105     } # foreach $display
3106
3107     $discount_show_always = ($cust_bill_pkg->cust_bill_pkg_discount
3108                                 && $conf->exists('discount-show-always'));
3109
3110   }
3111
3112   foreach ( $s, $r, ($opt{skip_usage} ? () : $u, $d ) ) {
3113     if ( $_  ) {
3114       $_->{amount}      = sprintf( "%.2f", $_->{amount} ),
3115         if exists($_->{amount});
3116       $_->{amount}      =~ s/^\-0\.00$/0.00/;
3117       if (exists($_->{unit_amount})) {
3118         $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} );
3119       }
3120
3121       push @b, { %$_ }
3122         if $_->{amount} != 0
3123         || $discount_show_always
3124         || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
3125         || (   $_->{_is_setup} && $_->{setup_show_zero} )
3126     }
3127   }
3128
3129   warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
3130     if $DEBUG > 1;
3131
3132   @b;
3133
3134 }
3135
3136 =item _items_discounts_avail
3137
3138 Returns an array of line item hashrefs representing available term discounts
3139 for this invoice.  This makes the same assumptions that apply to term
3140 discounts in general: that the package is billed monthly, at a flat rate,
3141 with no usage charges.  A prorated first month will be handled, as will
3142 a setup fee if the discount is allowed to apply to setup fees.
3143
3144 =cut
3145
3146 sub _items_discounts_avail {
3147   my $self = shift;
3148
3149   #maybe move this method from cust_bill when quotations support discount_plans
3150   return () unless $self->can('discount_plans');
3151   my %plans = $self->discount_plans;
3152
3153   my $list_pkgnums = 0; # if any packages are not eligible for all discounts
3154   $list_pkgnums = grep { $_->list_pkgnums } values %plans;
3155
3156   map {
3157     my $months = $_;
3158     my $plan = $plans{$months};
3159
3160     my $term_total = sprintf('%.2f', $plan->discounted_total);
3161     my $percent = sprintf('%.0f',
3162                           100 * (1 - $term_total / $plan->base_total) );
3163     my $permonth = sprintf('%.2f', $term_total / $months);
3164     my $detail = $self->mt('discount on item'). ' '.
3165                  join(', ', map { "#$_" } $plan->pkgnums)
3166       if $list_pkgnums;
3167
3168     # discounts for non-integer months don't work anyway
3169     $months = sprintf("%d", $months);
3170
3171     +{
3172       description => $self->mt('Save [_1]% by paying for [_2] months',
3173                                 $percent, $months),
3174       amount      => $self->mt('[_1] ([_2] per month)',
3175                                 $term_total, $money_char.$permonth),
3176       ext_description => ($detail || ''),
3177     }
3178   } #map
3179   sort { $b <=> $a } keys %plans;
3180
3181 }
3182
3183 1;