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