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