FS/FS/Template_Mixin.pm

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