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