FS/FS/Template_Mixin.pm

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