FS/FS/Template_Mixin.pm

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