FS/FS/Template_Mixin.pm

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