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