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