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