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