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