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