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