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