FS/FS/cust_pkg.pm

   1 package FS::cust_pkg;
   2 use base qw( FS::cust_pkg::API FS::otaker_Mixin FS::cust_main_Mixin FS::Sales_Mixin
   3              FS::contact_Mixin FS::location_Mixin
   4              FS::m2m_Common FS::option_Common );
   5
   6 use strict;
   7 use vars qw( $disable_agentcheck $DEBUG $me $upgrade );
   8 use Carp qw(cluck);
   9 use Scalar::Util qw( blessed );
  10 use List::Util qw(min max sum);
  11 use Tie::IxHash;
  12 use Time::Local qw( timelocal timelocal_nocheck );
  13 use MIME::Entity;
  14 use FS::UID qw( getotaker dbh driver_name );
  15 use FS::Misc qw( send_email );
  16 use FS::Record qw( qsearch qsearchs fields );
  17 use FS::CurrentUser;
  18 use FS::cust_svc;
  19 use FS::part_pkg;
  20 use FS::cust_main;
  21 use FS::contact;
  22 use FS::cust_location;
  23 use FS::pkg_svc;
  24 use FS::cust_bill_pkg;
  25 use FS::cust_pkg_detail;
  26 use FS::cust_pkg_usage;
  27 use FS::cdr_cust_pkg_usage;
  28 use FS::cust_event;
  29 use FS::h_cust_svc;
  30 use FS::reg_code;
  31 use FS::part_svc;
  32 use FS::cust_pkg_reason;
  33 use FS::reason;
  34 use FS::cust_pkg_discount;
  35 use FS::discount;
  36 use FS::UI::Web;
  37 use FS::sales;
  38 # for modify_charge
  39 use FS::cust_credit;
  40
  41 # need to 'use' these instead of 'require' in sub { cancel, suspend, unsuspend,
  42 # setup }
  43 # because they load configuration by setting FS::UID::callback (see TODO)
  44 use FS::svc_acct;
  45 use FS::svc_domain;
  46 use FS::svc_www;
  47 use FS::svc_forward;
  48
  49 # for sending cancel emails in sub cancel
  50 use FS::Conf;
  51
  52 $DEBUG = 0;
  53 $me = '[FS::cust_pkg]';
  54
  55 $disable_agentcheck = 0;
  56
  57 $upgrade = 0; #go away after setup+start dates cleaned up for old customers
  58
  59 our $cache_enabled = 0;
  60
  61 sub _simplecache {
  62   my( $self, $hashref ) = @_;
  63   if ( $cache_enabled && $hashref->{'pkg'} && $hashref->{'plan'} ) {
  64     $self->{'_pkgpart'} = FS::part_pkg->new($hashref);
  65   }
  66 }
  67
  68 sub _cache {
  69   my $self = shift;
  70   my ( $hashref, $cache ) = @_;
  71 #  #if ( $hashref->{'pkgpart'} ) {
  72 #  if ( $hashref->{'pkg'} ) {
  73 #    # #@{ $self->{'_pkgnum'} } = ();
  74 #    # my $subcache = $cache->subcache('pkgpart', 'part_pkg');
  75 #    # $self->{'_pkgpart'} = $subcache;
  76 #    # #push @{ $self->{'_pkgnum'} },
  77 #    #   FS::part_pkg->new_or_cached($hashref, $subcache);
  78 #    $self->{'_pkgpart'} = FS::part_pkg->new($hashref);
  79 #  }
  80   if ( exists $hashref->{'svcnum'} ) {
  81     #@{ $self->{'_pkgnum'} } = ();
  82     my $subcache = $cache->subcache('svcnum', 'cust_svc', $hashref->{pkgnum});
  83     $self->{'_svcnum'} = $subcache;
  84     #push @{ $self->{'_pkgnum'} },
  85     FS::cust_svc->new_or_cached($hashref, $subcache) if $hashref->{svcnum};
  86   }
  87 }
  88
  89 =head1 NAME
  90
  91 FS::cust_pkg - Object methods for cust_pkg objects
  92
  93 =head1 SYNOPSIS
  94
  95   use FS::cust_pkg;
  96
  97   $record = new FS::cust_pkg \%hash;
  98   $record = new FS::cust_pkg { 'column' => 'value' };
  99
 100   $error = $record->insert;
 101
 102   $error = $new_record->replace($old_record);
 103
 104   $error = $record->delete;
 105
 106   $error = $record->check;
 107
 108   $error = $record->cancel;
 109
 110   $error = $record->suspend;
 111
 112   $error = $record->unsuspend;
 113
 114   $part_pkg = $record->part_pkg;
 115
 116   @labels = $record->labels;
 117
 118   $seconds = $record->seconds_since($timestamp);
 119
 120   #bulk cancel+order... perhaps slightly deprecated, only used by the bulk
 121   # cancel+order in the web UI and nowhere else (edit/process/cust_pkg.cgi)
 122   $error = FS::cust_pkg::order( $custnum, \@pkgparts );
 123   $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );
 124
 125 =head1 DESCRIPTION
 126
 127 An FS::cust_pkg object represents a customer billing item.  FS::cust_pkg
 128 inherits from FS::Record.  The following fields are currently supported:
 129
 130 =over 4
 131
 132 =item pkgnum
 133
 134 Primary key (assigned automatically for new billing items)
 135
 136 =item custnum
 137
 138 Customer (see L<FS::cust_main>)
 139
 140 =item pkgpart
 141
 142 Billing item definition (see L<FS::part_pkg>)
 143
 144 =item locationnum
 145
 146 Optional link to package location (see L<FS::location>)
 147
 148 =item order_date
 149
 150 date package was ordered (also remains same on changes)
 151
 152 =item start_date
 153
 154 date
 155
 156 =item setup
 157
 158 date
 159
 160 =item bill
 161
 162 date (next bill date)
 163
 164 =item last_bill
 165
 166 last bill date
 167
 168 =item adjourn
 169
 170 date
 171
 172 =item susp
 173
 174 date
 175
 176 =item expire
 177
 178 date
 179
 180 =item contract_end
 181
 182 date
 183
 184 =item cancel
 185
 186 date
 187
 188 =item usernum
 189
 190 order taker (see L<FS::access_user>)
 191
 192 =item quantity
 193
 194 If not set, defaults to 1
 195
 196 =item change_date
 197
 198 Date of change from previous package
 199
 200 =item change_pkgnum
 201
 202 Previous pkgnum
 203
 204 =item change_pkgpart
 205
 206 Previous pkgpart
 207
 208 =item change_locationnum
 209
 210 Previous locationnum
 211
 212 =item waive_setup
 213
 214 =item main_pkgnum
 215
 216 The pkgnum of the package that this package is supplemental to, if any.
 217
 218 =item pkglinknum
 219
 220 The package link (L<FS::part_pkg_link>) that defines this supplemental
 221 package, if it is one.
 222
 223 =item change_to_pkgnum
 224
 225 The pkgnum of the package this one will be "changed to" in the future
 226 (on its expiration date).
 227
 228 =back
 229
 230 Note: setup, last_bill, bill, adjourn, susp, expire, cancel and change_date
 231 are specified as UNIX timestamps; see L<perlfunc/"time">.  Also see
 232 L<Time::Local> and L<Date::Parse> for conversion functions.
 233
 234 =head1 METHODS
 235
 236 =over 4
 237
 238 =item new HASHREF
 239
 240 Create a new billing item.  To add the item to the database, see L<"insert">.
 241
 242 =cut
 243
 244 sub table { 'cust_pkg'; }
 245 sub cust_linked { $_[0]->cust_main_custnum || $_[0]->custnum }
 246 sub cust_unlinked_msg {
 247   my $self = shift;
 248   "WARNING: can't find cust_main.custnum ". $self->custnum.
 249   ' (cust_pkg.pkgnum '. $self->pkgnum. ')';
 250 }
 251
 252 =item set_initial_timers
 253
 254 If required by the package definition, sets any automatic expire, adjourn,
 255 or contract_end timers to some number of months after the start date
 256 (or setup date, if the package has already been setup). If the package has
 257 a delayed setup fee after a period of "free days", will also set the
 258 start date to the end of that period.
 259
 260 =cut
 261
 262 sub set_initial_timers {
 263   my $self = shift;
 264   my $part_pkg = $self->part_pkg;
 265   foreach my $action ( qw(expire adjourn contract_end) ) {
 266     my $months = $part_pkg->option("${action}_months",1);
 267     if($months and !$self->get($action)) {
 268       my $start = $self->start_date || $self->setup || time;
 269       $self->set($action, $part_pkg->add_freq($start, $months) );
 270     }
 271   }
 272
 273   # if this package has "free days" and delayed setup fee, then
 274   # set start date that many days in the future.
 275   # (this should have been set in the UI, but enforce it here)
 276   if ( $part_pkg->option('free_days',1)
 277        && $part_pkg->option('delay_setup',1)
 278      )
 279   {
 280     $self->start_date( $part_pkg->default_start_date );
 281   }
 282   '';
 283 }
 284
 285 =item insert [ OPTION => VALUE ... ]
 286
 287 Adds this billing item to the database ("Orders" the item).  If there is an
 288 error, returns the error, otherwise returns false.
 289
 290 If the additional field I<promo_code> is defined instead of I<pkgpart>, it
 291 will be used to look up the package definition and agent restrictions will be
 292 ignored.
 293
 294 If the additional field I<refnum> is defined, an FS::pkg_referral record will
 295 be created and inserted.  Multiple FS::pkg_referral records can be created by
 296 setting I<refnum> to an array reference of refnums or a hash reference with
 297 refnums as keys.  If no I<refnum> is defined, a default FS::pkg_referral
 298 record will be created corresponding to cust_main.refnum.
 299
 300 The following options are available:
 301
 302 =over 4
 303
 304 =item change
 305
 306 If set true, supresses actions that should only be taken for new package
 307 orders.  (Currently this includes: intro periods when delay_setup is on,
 308 auto-adding a 1st start date, auto-adding expiration/adjourn/contract_end dates)
 309
 310 =item options
 311
 312 cust_pkg_option records will be created
 313
 314 =item ticket_subject
 315
 316 a ticket will be added to this customer with this subject
 317
 318 =item ticket_queue
 319
 320 an optional queue name for ticket additions
 321
 322 =item allow_pkgpart
 323
 324 Don't check the legality of the package definition.  This should be used
 325 when performing a package change that doesn't change the pkgpart (i.e.
 326 a location change).
 327
 328 =back
 329
 330 =cut
 331
 332 sub insert {
 333   my( $self, %options ) = @_;
 334
 335   my $error;
 336   $error = $self->check_pkgpart unless $options{'allow_pkgpart'};
 337   return $error if $error;
 338
 339   my $part_pkg = $self->part_pkg;
 340
 341   if ( ! $options{'change'} ) {
 342
 343     # set order date to now
 344     $self->order_date(time);
 345
 346     # if the package def says to start only on the first of the month:
 347     if ( $part_pkg->option('start_1st', 1) && !$self->start_date ) {
 348       my ($sec,$min,$hour,$mday,$mon,$year) = (localtime(time) )[0,1,2,3,4,5];
 349       $mon += 1 unless $mday == 1;
 350       until ( $mon < 12 ) { $mon -= 12; $year++; }
 351       $self->start_date( timelocal_nocheck(0,0,0,1,$mon,$year) );
 352     }
 353
 354     if ($self->susp eq 'now' or $part_pkg->start_on_hold) {
 355       # if the package was ordered on hold:
 356       # - suspend it
 357       # - don't set the start date (it will be started manually)
 358       $self->set('susp', $self->order_date);
 359       $self->set('start_date', '');
 360     } else {
 361       # set expire/adjourn/contract_end timers, and free days, if appropriate
 362       $self->set_initial_timers;
 363     }
 364   } # else this is a package change, and shouldn't have "new package" behavior
 365
 366   local $SIG{HUP} = 'IGNORE';
 367   local $SIG{INT} = 'IGNORE';
 368   local $SIG{QUIT} = 'IGNORE';
 369   local $SIG{TERM} = 'IGNORE';
 370   local $SIG{TSTP} = 'IGNORE';
 371   local $SIG{PIPE} = 'IGNORE';
 372
 373   my $oldAutoCommit = $FS::UID::AutoCommit;
 374   local $FS::UID::AutoCommit = 0;
 375   my $dbh = dbh;
 376
 377   $error = $self->SUPER::insert($options{options} ? %{$options{options}} : ());
 378   if ( $error ) {
 379     $dbh->rollback if $oldAutoCommit;
 380     return $error;
 381   }
 382
 383   $self->refnum($self->cust_main->refnum) unless $self->refnum;
 384   $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
 385   $self->process_m2m( 'link_table'   => 'pkg_referral',
 386                       'target_table' => 'part_referral',
 387                       'params'       => $self->refnum,
 388                     );
 389
 390   if ( $self->discountnum ) {
 391     my $error = $self->insert_discount();
 392     if ( $error ) {
 393       $dbh->rollback if $oldAutoCommit;
 394       return $error;
 395     }
 396   }
 397
 398   my $conf = new FS::Conf;
 399
 400   if ($self->locationnum) {
 401     my @part_export =
 402       map qsearch( 'part_export', {exportnum=>$_} ),
 403         $conf->config('cust_location-exports'); #, $agentnum
 404
 405     foreach my $part_export ( @part_export ) {
 406       my $error = $part_export->export_pkg_location($self); #, @$export_args);
 407       if ( $error ) {
 408         $dbh->rollback if $oldAutoCommit;
 409         return "exporting to ". $part_export->exporttype.
 410                " (transaction rolled back): $error";
 411       }
 412     }
 413   }
 414
 415   if ( $conf->config('ticket_system') && $options{ticket_subject} ) {
 416
 417     #this init stuff is still inefficient, but at least its limited to
 418     # the small number (any?) folks using ticket emailing on pkg order
 419
 420     #eval '
 421     #  use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
 422     #  use RT;
 423     #';
 424     #die $@ if $@;
 425     #
 426     #RT::LoadConfig();
 427     #RT::Init();
 428     use FS::TicketSystem;
 429     FS::TicketSystem->init();
 430
 431     my $q = new RT::Queue($RT::SystemUser);
 432     $q->Load($options{ticket_queue}) if $options{ticket_queue};
 433     my $t = new RT::Ticket($RT::SystemUser);
 434     my $mime = new MIME::Entity;
 435     $mime->build( Type => 'text/plain', Data => $options{ticket_subject} );
 436     $t->Create( $options{ticket_queue} ? (Queue => $q) : (),
 437                 Subject => $options{ticket_subject},
 438                 MIMEObj => $mime,
 439               );
 440     $t->AddLink( Type   => 'MemberOf',
 441                  Target => 'freeside://freeside/cust_main/'. $self->custnum,
 442                );
 443   }
 444
 445   if ($conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
 446     my $queue = new FS::queue {
 447       'job'     => 'FS::cust_main::queueable_print',
 448     };
 449     $error = $queue->insert(
 450       'custnum'  => $self->custnum,
 451       'template' => 'welcome_letter',
 452     );
 453
 454     if ($error) {
 455       warn "can't send welcome letter: $error";
 456     }
 457
 458   }
 459
 460   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 461   '';
 462
 463 }
 464
 465 =item delete
 466
 467 This method now works but you probably shouldn't use it.
 468
 469 You don't want to delete packages, because there would then be no record
 470 the customer ever purchased the package.  Instead, see the cancel method and
 471 hide cancelled packages.
 472
 473 =cut
 474
 475 sub delete {
 476   my $self = shift;
 477
 478   local $SIG{HUP} = 'IGNORE';
 479   local $SIG{INT} = 'IGNORE';
 480   local $SIG{QUIT} = 'IGNORE';
 481   local $SIG{TERM} = 'IGNORE';
 482   local $SIG{TSTP} = 'IGNORE';
 483   local $SIG{PIPE} = 'IGNORE';
 484
 485   my $oldAutoCommit = $FS::UID::AutoCommit;
 486   local $FS::UID::AutoCommit = 0;
 487   my $dbh = dbh;
 488
 489   foreach my $cust_pkg_discount ($self->cust_pkg_discount) {
 490     my $error = $cust_pkg_discount->delete;
 491     if ( $error ) {
 492       $dbh->rollback if $oldAutoCommit;
 493       return $error;
 494     }
 495   }
 496   #cust_bill_pkg_discount?
 497
 498   foreach my $cust_pkg_detail ($self->cust_pkg_detail) {
 499     my $error = $cust_pkg_detail->delete;
 500     if ( $error ) {
 501       $dbh->rollback if $oldAutoCommit;
 502       return $error;
 503     }
 504   }
 505
 506   foreach my $cust_pkg_reason (
 507     qsearchs( {
 508                 'table' => 'cust_pkg_reason',
 509                 'hashref' => { 'pkgnum' => $self->pkgnum },
 510               }
 511             )
 512   ) {
 513     my $error = $cust_pkg_reason->delete;
 514     if ( $error ) {
 515       $dbh->rollback if $oldAutoCommit;
 516       return $error;
 517     }
 518   }
 519
 520   #pkg_referral?
 521
 522   my $error = $self->SUPER::delete(@_);
 523   if ( $error ) {
 524     $dbh->rollback if $oldAutoCommit;
 525     return $error;
 526   }
 527
 528   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 529
 530   '';
 531
 532 }
 533
 534 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
 535
 536 Replaces the OLD_RECORD with this one in the database.  If there is an error,
 537 returns the error, otherwise returns false.
 538
 539 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
 540
 541 Changing pkgpart may have disasterous effects.  See the order subroutine.
 542
 543 setup and bill are normally updated by calling the bill method of a customer
 544 object (see L<FS::cust_main>).
 545
 546 suspend is normally updated by the suspend and unsuspend methods.
 547
 548 cancel is normally updated by the cancel method (and also the order subroutine
 549 in some cases).
 550
 551 Available options are:
 552
 553 =over 4
 554
 555 =item reason
 556
 557 can be set to a cancellation reason (see L<FS:reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason.  The hashref should have the following keys: typenum - Reason type (see L<FS::reason_type>, reason - Text of the new reason.
 558
 559 =item reason_otaker
 560
 561 the access_user (see L<FS::access_user>) providing the reason
 562
 563 =item options
 564
 565 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
 566
 567 =back
 568
 569 =cut
 570
 571 sub replace {
 572   my $new = shift;
 573
 574   my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
 575               ? shift
 576               : $new->replace_old;
 577
 578   my $options =
 579     ( ref($_[0]) eq 'HASH' )
 580       ? shift
 581       : { @_ };
 582
 583   #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
 584   #return "Can't change otaker!" if $old->otaker ne $new->otaker;
 585
 586   #allow this *sigh*
 587   #return "Can't change setup once it exists!"
 588   #  if $old->getfield('setup') &&
 589   #     $old->getfield('setup') != $new->getfield('setup');
 590
 591   #some logic for bill, susp, cancel?
 592
 593   local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
 594
 595   local $SIG{HUP} = 'IGNORE';
 596   local $SIG{INT} = 'IGNORE';
 597   local $SIG{QUIT} = 'IGNORE';
 598   local $SIG{TERM} = 'IGNORE';
 599   local $SIG{TSTP} = 'IGNORE';
 600   local $SIG{PIPE} = 'IGNORE';
 601
 602   my $oldAutoCommit = $FS::UID::AutoCommit;
 603   local $FS::UID::AutoCommit = 0;
 604   my $dbh = dbh;
 605
 606   foreach my $method ( qw(adjourn expire) ) {  # How many reasons?
 607     if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
 608       my $error = $new->insert_reason(
 609         'reason'        => $options->{'reason'},
 610         'date'          => $new->$method,
 611         'action'        => $method,
 612         'reason_otaker' => $options->{'reason_otaker'},
 613       );
 614       if ( $error ) {
 615         dbh->rollback if $oldAutoCommit;
 616         return "Error inserting cust_pkg_reason: $error";
 617       }
 618     }
 619   }
 620
 621   #save off and freeze RADIUS attributes for any associated svc_acct records
 622   my @svc_acct = ();
 623   if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
 624
 625                 #also check for specific exports?
 626                 # to avoid spurious modify export events
 627     @svc_acct = map  { $_->svc_x }
 628                 grep { $_->part_svc->svcdb eq 'svc_acct' }
 629                      $old->cust_svc;
 630
 631     $_->snapshot foreach @svc_acct;
 632
 633   }
 634
 635   my $error =  $new->export_pkg_change($old)
 636             || $new->SUPER::replace( $old,
 637                                      $options->{options}
 638                                        ? $options->{options}
 639                                        : ()
 640                                    );
 641   if ( $error ) {
 642     $dbh->rollback if $oldAutoCommit;
 643     return $error;
 644   }
 645
 646   #for prepaid packages,
 647   #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
 648   foreach my $old_svc_acct ( @svc_acct ) {
 649     my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
 650     my $s_error =
 651       $new_svc_acct->replace( $old_svc_acct,
 652                               'depend_jobnum' => $options->{depend_jobnum},
 653                             );
 654     if ( $s_error ) {
 655       $dbh->rollback if $oldAutoCommit;
 656       return $s_error;
 657     }
 658   }
 659
 660   # also run exports if removing locationnum?
 661   #   doesn't seem to happen, and we don't export blank locationnum on insert...
 662   if ($new->locationnum and ($new->locationnum != $old->locationnum)) {
 663     my $conf = new FS::Conf;
 664     my @part_export =
 665       map qsearch( 'part_export', {exportnum=>$_} ),
 666         $conf->config('cust_location-exports'); #, $agentnum
 667
 668     foreach my $part_export ( @part_export ) {
 669       my $error = $part_export->export_pkg_location($new); #, @$export_args);
 670       if ( $error ) {
 671         $dbh->rollback if $oldAutoCommit;
 672         return "exporting to ". $part_export->exporttype.
 673                " (transaction rolled back): $error";
 674       }
 675     }
 676   }
 677
 678   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 679   '';
 680
 681 }
 682
 683 =item check
 684
 685 Checks all fields to make sure this is a valid billing item.  If there is an
 686 error, returns the error, otherwise returns false.  Called by the insert and
 687 replace methods.
 688
 689 =cut
 690
 691 sub check {
 692   my $self = shift;
 693
 694   if ( !$self->locationnum or $self->locationnum == -1 ) {
 695     $self->set('locationnum', $self->cust_main->ship_locationnum);
 696   }
 697
 698   my $error =
 699     $self->ut_numbern('pkgnum')
 700     || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
 701     || $self->ut_numbern('pkgpart')
 702     || $self->ut_foreign_keyn('contactnum',  'contact',       'contactnum' )
 703     || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
 704     || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
 705     || $self->ut_numbern('quantity')
 706     || $self->ut_numbern('start_date')
 707     || $self->ut_numbern('setup')
 708     || $self->ut_numbern('bill')
 709     || $self->ut_numbern('susp')
 710     || $self->ut_numbern('cancel')
 711     || $self->ut_numbern('adjourn')
 712     || $self->ut_numbern('resume')
 713     || $self->ut_numbern('expire')
 714     || $self->ut_numbern('dundate')
 715     || $self->ut_flag('no_auto', [ '', 'Y' ])
 716     || $self->ut_flag('waive_setup', [ '', 'Y' ])
 717     || $self->ut_flag('separate_bill')
 718     || $self->ut_textn('agent_pkgid')
 719     || $self->ut_enum('recur_show_zero', [ '', 'Y', 'N', ])
 720     || $self->ut_enum('setup_show_zero', [ '', 'Y', 'N', ])
 721     || $self->ut_foreign_keyn('main_pkgnum', 'cust_pkg', 'pkgnum')
 722     || $self->ut_foreign_keyn('pkglinknum', 'part_pkg_link', 'pkglinknum')
 723     || $self->ut_foreign_keyn('change_to_pkgnum', 'cust_pkg', 'pkgnum')
 724   ;
 725   return $error if $error;
 726
 727   return "A package with both start date (future start) and setup date (already started) will never bill"
 728     if $self->start_date && $self->setup && ! $upgrade;
 729
 730   return "A future unsuspend date can only be set for a package with a suspend date"
 731     if $self->resume and !$self->susp and !$self->adjourn;
 732
 733   $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
 734
 735   if ( $self->dbdef_table->column('manual_flag') ) {
 736     $self->manual_flag('') if $self->manual_flag eq ' ';
 737     $self->manual_flag =~ /^([01]?)$/
 738       or return "Illegal manual_flag ". $self->manual_flag;
 739     $self->manual_flag($1);
 740   }
 741
 742   $self->SUPER::check;
 743 }
 744
 745 =item check_pkgpart
 746
 747 Check the pkgpart to make sure it's allowed with the reg_code and/or
 748 promo_code of the package (if present) and with the customer's agent.
 749 Called from C<insert>, unless we are doing a package change that doesn't
 750 affect pkgpart.
 751
 752 =cut
 753
 754 sub check_pkgpart {
 755   my $self = shift;
 756
 757   # my $error = $self->ut_numbern('pkgpart'); # already done
 758
 759   my $error;
 760   if ( $self->reg_code ) {
 761
 762     unless ( grep { $self->pkgpart == $_->pkgpart }
 763              map  { $_->reg_code_pkg }
 764              qsearchs( 'reg_code', { 'code'     => $self->reg_code,
 765                                      'agentnum' => $self->cust_main->agentnum })
 766            ) {
 767       return "Unknown registration code";
 768     }
 769
 770   } elsif ( $self->promo_code ) {
 771
 772     my $promo_part_pkg =
 773       qsearchs('part_pkg', {
 774         'pkgpart'    => $self->pkgpart,
 775         'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
 776       } );
 777     return 'Unknown promotional code' unless $promo_part_pkg;
 778
 779   } else {
 780
 781     unless ( $disable_agentcheck ) {
 782       my $agent =
 783         qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
 784       return "agent ". $agent->agentnum. ':'. $agent->agent.
 785              " can't purchase pkgpart ". $self->pkgpart
 786         unless $agent->pkgpart_hashref->{ $self->pkgpart }
 787             || $agent->agentnum == $self->part_pkg->agentnum;
 788     }
 789
 790     $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
 791     return $error if $error;
 792
 793   }
 794
 795   '';
 796
 797 }
 798
 799 =item cancel [ OPTION => VALUE ... ]
 800
 801 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
 802 in this package, then cancels the package itself (sets the cancel field to
 803 now).
 804
 805 Available options are:
 806
 807 =over 4
 808
 809 =item quiet - can be set true to supress email cancellation notices.
 810
 811 =item time -  can be set to cancel the package based on a specific future or
 812 historical date.  Using time ensures that the remaining amount is calculated
 813 correctly.  Note however that this is an immediate cancel and just changes
 814 the date.  You are PROBABLY looking to expire the account instead of using
 815 this.
 816
 817 =item reason - can be set to a cancellation reason (see L<FS:reason>),
 818 either a reasonnum of an existing reason, or a hashref to create
 819 a new reason.  The hashref should have the following keys:
 820 typenum - Reason type (see L<FS::reason_type>
 821 reason - Text of the new reason.
 822
 823 If this argument isn't given or is a false value, then the package will be
 824 canceled with no reason.
 825
 826 =item date - can be set to a unix style timestamp to specify when to
 827 cancel (expire)
 828
 829 =item nobill - can be set true to skip billing if it might otherwise be done.
 830
 831 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
 832 not credit it.  This must be set (by change()) when changing the package
 833 to a different pkgpart or location, and probably shouldn't be in any other
 834 case.  If it's not set, the 'unused_credit_cancel' part_pkg option will
 835 be used.
 836
 837 =item no_delay_cancel - prevents delay_cancel behavior
 838 no matter what other options say, for use when changing packages (or any
 839 other time you're really sure you want an immediate cancel)
 840
 841 =back
 842
 843 If there is an error, returns the error, otherwise returns false.
 844
 845 =cut
 846
 847 #NOT DOCUMENTING - this should only be used when calling recursively
 848 #=item delay_cancel - for internal use, to allow proper handling of
 849 #supplemental packages when the main package is flagged to suspend
 850 #before cancelling, probably shouldn't be used otherwise (set the
 851 #corresponding package option instead)
 852
 853 sub cancel {
 854   my( $self, %options ) = @_;
 855   my $error;
 856
 857   # pass all suspend/cancel actions to the main package
 858   # (unless the pkglinknum has been removed, then the link is defunct and
 859   # this package can be canceled on its own)
 860   if ( $self->main_pkgnum and $self->pkglinknum and !$options{'from_main'} ) {
 861     return $self->main_pkg->cancel(%options);
 862   }
 863
 864   my $conf = new FS::Conf;
 865
 866   warn "cust_pkg::cancel called with options".
 867        join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
 868     if $DEBUG;
 869
 870   local $SIG{HUP} = 'IGNORE';
 871   local $SIG{INT} = 'IGNORE';
 872   local $SIG{QUIT} = 'IGNORE';
 873   local $SIG{TERM} = 'IGNORE';
 874   local $SIG{TSTP} = 'IGNORE';
 875   local $SIG{PIPE} = 'IGNORE';
 876
 877   my $oldAutoCommit = $FS::UID::AutoCommit;
 878   local $FS::UID::AutoCommit = 0;
 879   my $dbh = dbh;
 880
 881   my $old = $self->select_for_update;
 882
 883   if ( $old->get('cancel') || $self->get('cancel') ) {
 884     dbh->rollback if $oldAutoCommit;
 885     return "";  # no error
 886   }
 887
 888   # XXX possibly set cancel_time to the expire date?
 889   my $cancel_time = $options{'time'} || time;
 890   my $date = $options{'date'} if $options{'date'}; # expire/cancel later
 891   $date = '' if ($date && $date <= $cancel_time);      # complain instead?
 892
 893   my $delay_cancel = $options{'no_delay_cancel'} ? 0 : $options{'delay_cancel'};
 894   if ( !$date && $self->part_pkg->option('delay_cancel',1)
 895        && (($self->status eq 'active') || ($self->status eq 'suspended'))
 896        && !$options{'no_delay_cancel'}
 897   ) {
 898     my $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
 899     my $expsecs = 60*60*24*$expdays;
 900     my $suspfor = $self->susp ? $cancel_time - $self->susp : 0;
 901     $expsecs = $expsecs - $suspfor if $suspfor;
 902     unless ($expsecs <= 0) { #if it's already been suspended long enough, don't re-suspend
 903       $delay_cancel = 1;
 904       $date = $cancel_time + $expsecs;
 905     }
 906   }
 907
 908   #race condition: usage could be ongoing until unprovisioned
 909   #resolved by performing a change package instead (which unprovisions) and
 910   #later cancelling
 911   if ( !$options{nobill} && !$date ) {
 912     # && $conf->exists('bill_usage_on_cancel') ) { #calc_cancel checks this
 913       my $copy = $self->new({$self->hash});
 914       my $error =
 915         $copy->cust_main->bill( 'pkg_list' => [ $copy ],
 916                                 'cancel'   => 1,
 917                                 'time'     => $cancel_time );
 918       warn "Error billing during cancel, custnum ".
 919         #$self->cust_main->custnum. ": $error"
 920         ": $error"
 921         if $error;
 922   }
 923
 924   if ( $options{'reason'} ) {
 925     $error = $self->insert_reason( 'reason' => $options{'reason'},
 926                                    'action' => $date ? 'expire' : 'cancel',
 927                                    'date'   => $date ? $date : $cancel_time,
 928                                    'reason_otaker' => $options{'reason_otaker'},
 929                                  );
 930     if ( $error ) {
 931       dbh->rollback if $oldAutoCommit;
 932       return "Error inserting cust_pkg_reason: $error";
 933     }
 934   }
 935
 936   my %svc_cancel_opt = ();
 937   $svc_cancel_opt{'date'} = $date if $date;
 938   foreach my $cust_svc (
 939     #schwartz
 940     map  { $_->[0] }
 941     sort { $a->[1] <=> $b->[1] }
 942     map  { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; }
 943     qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
 944   ) {
 945     my $part_svc = $cust_svc->part_svc;
 946     next if ( defined($part_svc) and $part_svc->preserve );
 947     my $error = $cust_svc->cancel( %svc_cancel_opt );
 948
 949     if ( $error ) {
 950       $dbh->rollback if $oldAutoCommit;
 951       return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
 952              " cust_svc: $error";
 953     }
 954   }
 955
 956   # if a reasonnum was passed, get the actual reason object so we can check
 957   # unused_credit
 958
 959   my $reason;
 960   if ($options{'reason'} =~ /^\d+$/) {
 961     $reason = FS::reason->by_key($options{'reason'});
 962   }
 963
 964   unless ($date) {
 965     # credit remaining time if any of these are true:
 966     # - unused_credit => 1 was passed (this happens when canceling a package
 967     #   for a package change when unused_credit_change is set)
 968     # - no unused_credit option, and there is a cancel reason, and the cancel
 969     #   reason says to credit the package
 970     # - no unused_credit option, and the package definition says to credit the
 971     #   package on cancellation
 972     my $do_credit;
 973     if ( exists($options{'unused_credit'}) ) {
 974       $do_credit = $options{'unused_credit'};
 975     } elsif ( defined($reason) && $reason->unused_credit ) {
 976       $do_credit = 1;
 977     } else {
 978       $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
 979     }
 980     if ( $do_credit ) {
 981       my $error = $self->credit_remaining('cancel', $cancel_time);
 982       if ($error) {
 983         $dbh->rollback if $oldAutoCommit;
 984         return $error;
 985       }
 986     }
 987   } #unless $date
 988
 989   my %hash = $self->hash;
 990   if ( $date ) {
 991     $hash{'expire'} = $date;
 992     if ($delay_cancel) {
 993       # just to be sure these are clear
 994       $hash{'adjourn'} = undef;
 995       $hash{'resume'} = undef;
 996     }
 997   } else {
 998     $hash{'cancel'} = $cancel_time;
 999   }
1000   $hash{'change_custnum'} = $options{'change_custnum'};
1001
1002   # if this is a supplemental package that's lost its part_pkg_link, and it's
1003   # being canceled for real, unlink it completely
1004   if ( !$date and ! $self->pkglinknum ) {
1005     $hash{main_pkgnum} = '';
1006   }
1007
1008   my $new = new FS::cust_pkg ( \%hash );
1009   $error = $new->replace( $self, options => { $self->options } );
1010   if ( $self->change_to_pkgnum ) {
1011     my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
1012     $error ||= $change_to->cancel('no_delay_cancel' => 1) || $change_to->delete;
1013   }
1014   if ( $error ) {
1015     $dbh->rollback if $oldAutoCommit;
1016     return $error;
1017   }
1018
1019   foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1020     $error = $supp_pkg->cancel(%options,
1021       'from_main' => 1,
1022       'date' => $date, #in case it got changed by delay_cancel
1023       'delay_cancel' => $delay_cancel,
1024     );
1025     if ( $error ) {
1026       $dbh->rollback if $oldAutoCommit;
1027       return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1028     }
1029   }
1030
1031   if ($delay_cancel && !$options{'from_main'}) {
1032     $error = $new->suspend(
1033       'from_cancel' => 1,
1034       'time'        => $cancel_time
1035     );
1036   }
1037
1038   unless ($date) {
1039     foreach my $usage ( $self->cust_pkg_usage ) {
1040       $error = $usage->delete;
1041       if ( $error ) {
1042         $dbh->rollback if $oldAutoCommit;
1043         return "deleting usage pools: $error";
1044       }
1045     }
1046   }
1047
1048   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1049   return '' if $date; #no errors
1050
1051   my $cust_main = $self->cust_main;
1052
1053   my @invoicing_list = $cust_main->invoicing_list_emailonly;
1054   if (    !$options{'quiet'}
1055        && $conf->config_bool('emailcancel', $cust_main->agentnum)
1056        && @invoicing_list
1057      )
1058   {
1059     my $msgnum = $conf->config('cancel_msgnum', $cust_main->agentnum);
1060     my $error = '';
1061     if ( $msgnum ) {
1062       my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
1063       $error = $msg_template->send(
1064         'cust_main' => $cust_main,
1065         'object'    => $self,
1066       );
1067     } else {
1068       $error = send_email(
1069         'from'    => $conf->invoice_from_full( $self->cust_main->agentnum ),
1070         'to'      => \@invoicing_list,
1071         'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
1072         'body'    => [ map "$_\n", $conf->config('cancelmessage') ],
1073         'custnum' => $self->custnum,
1074         'msgtype' => '', #admin?
1075       );
1076     }
1077     #should this do something on errors?
1078   }
1079
1080   my %pkg_class = map { $_=>1 }
1081                     $conf->config('cancel_msgnum-referring_cust-pkg_class');
1082   my $ref_msgnum = $conf->config('cancel_msgnum-referring_cust');
1083   if (    !$options{'quiet'}
1084        && $cust_main->referral_custnum
1085        && $pkg_class{ $self->classnum }
1086        && $ref_msgnum
1087      )
1088   {
1089     my $msg_template = qsearchs('msg_template', { msgnum => $ref_msgnum });
1090     my $error = $msg_template->send(
1091       'cust_main' => $cust_main->referring_cust_main,
1092       'object'    => $self,
1093     );
1094     #should this do something on errors?
1095   }
1096
1097   ''; #no errors
1098
1099 }
1100
1101 =item cancel_if_expired [ NOW_TIMESTAMP ]
1102
1103 Cancels this package if its expire date has been reached.
1104
1105 =cut
1106
1107 # XXX should look for an expire reason
1108 # but seems to be unused; this is now handled more holistically in
1109 # cust_main::Billing
1110
1111 sub cancel_if_expired {
1112   my $self = shift;
1113   my $time = shift || time;
1114   return '' unless $self->expire && $self->expire <= $time;
1115   my $error = $self->cancel;
1116   if ( $error ) {
1117     return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
1118            $self->custnum. ": $error";
1119   }
1120   '';
1121 }
1122
1123 =item uncancel_svc_x
1124
1125 For cancelled cust_pkg, returns a list of new, uninserted FS::svc_X records
1126 for services that would be inserted by L</uncancel>.  Returned objects also
1127 include the field _h_svc_x, which contains the service history object.
1128
1129 Set pkgnum before inserting.
1130
1131 Accepts the following options:
1132
1133 only_svcnum - arrayref of svcnum, only returns objects for these svcnum
1134 (and only if they would otherwise be returned by this)
1135
1136 =cut
1137
1138 sub uncancel_svc_x {
1139   my ($self, %opt) = @_;
1140
1141   die 'uncancel_svc_x called on a non-cancelled cust_pkg' unless $self->get('cancel');
1142
1143   #find historical services within this timeframe before the package cancel
1144   # (incompatible with "time" option to cust_pkg->cancel?)
1145   my $fuzz = 2 * 60; #2 minutes?  too much?   (might catch separate unprovision)
1146                      #            too little? (unprovisioing export delay?)
1147   my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
1148   my @h_cust_svc = $self->h_cust_svc( $end, $start );
1149
1150   my @svc_x;
1151   foreach my $h_cust_svc (@h_cust_svc) {
1152     next if $opt{'only_svcnum'} && !(grep { $_ == $h_cust_svc->svcnum } @{$opt{'only_svcnum'}});
1153     # filter out services that still exist on this package (ie preserved svcs)
1154     # but keep services that have since been provisioned on another package (for informational purposes)
1155     next if qsearchs('cust_svc',{ 'svcnum' => $h_cust_svc->svcnum, 'pkgnum' => $self->pkgnum });
1156     my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
1157     next unless $h_svc_x; # this probably doesn't happen, but just in case
1158     (my $table = $h_svc_x->table) =~ s/^h_//;
1159     require "FS/$table.pm";
1160     my $class = "FS::$table";
1161     my $svc_x = $class->new( {
1162       'svcpart' => $h_cust_svc->svcpart,
1163       '_h_svc_x' => $h_svc_x,
1164       map { $_ => $h_svc_x->get($_) } fields($table)
1165     } );
1166
1167     # radius_usergroup
1168     if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
1169       $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
1170     }
1171
1172     #these are pretty rare, but should handle them
1173     # - dsl_device (mac addresses)
1174     # - phone_device (mac addresses)
1175     # - dsl_note (ikano notes)
1176     # - domain_record (i.e. restore DNS information w/domains)
1177     # - inventory_item(?) (inventory w/un-cancelling service?)
1178     # - nas (svc_broaband nas stuff)
1179     #this stuff is unused in the wild afaik
1180     # - mailinglistmember
1181     # - router.svcnum?
1182     # - svc_domain.parent_svcnum?
1183     # - acct_snarf (ancient mail fetching config)
1184     # - cgp_rule (communigate)
1185     # - cust_svc_option (used by our Tron stuff)
1186     # - acct_rt_transaction (used by our time worked stuff)
1187
1188     push @svc_x, $svc_x;
1189   }
1190   return @svc_x;
1191 }
1192
1193 =item uncancel_svc_summary
1194
1195 Returns an array of hashrefs, one for each service that could
1196 potentially be reprovisioned by L</uncancel>, with the following keys:
1197
1198 svcpart
1199
1200 svc
1201
1202 uncancel_svcnum
1203
1204 label - from history table if not currently calculable, undefined if it can't be loaded
1205
1206 reprovisionable - 1 if test reprovision succeeded, otherwise 0
1207
1208 num_cust_svc - number of svcs for this svcpart, only if summarizing (see below)
1209
1210 Cannot be run from within a transaction.  Performs inserts
1211 to test the results, and then rolls back the transaction.
1212 Does not perform exports, so does not catch if export would fail.
1213
1214 Also accepts the following options:
1215
1216 no_test_reprovision - skip the test inserts (reprovisionable field will not exist)
1217
1218 summarize_size - if true, returns a single summary record for svcparts with at
1219 least this many svcs, will have key num_cust_svc but not uncancel_svcnum, label or reprovisionable
1220
1221 =cut
1222
1223 sub uncancel_svc_summary {
1224   my ($self, %opt) = @_;
1225
1226   die 'uncancel_svc_summary called on a non-cancelled cust_pkg' unless $self->get('cancel');
1227   die 'uncancel_svc_summary called from within a transaction' unless $FS::UID::AutoCommit;
1228
1229   local $FS::svc_Common::noexport_hack = 1; # very important not to run exports!!!
1230   local $FS::UID::AutoCommit = 0;
1231
1232   # sort by svcpart, to check summarize_size
1233   my $uncancel_svc_x = {};
1234   foreach my $svc_x (sort { $a->{'svcpart'} <=> $b->{'svcpart'} } $self->uncancel_svc_x) {
1235     $uncancel_svc_x->{$svc_x->svcpart} = [] unless $uncancel_svc_x->{$svc_x->svcpart};
1236     push @{$uncancel_svc_x->{$svc_x->svcpart}}, $svc_x;
1237   }
1238
1239   my @out;
1240   foreach my $svcpart (keys %$uncancel_svc_x) {
1241     my @svcpart_svc_x = @{$uncancel_svc_x->{$svcpart}};
1242     if ($opt{'summarize_size'} && (@svcpart_svc_x >= $opt{'summarize_size'})) {
1243       my $svc_x = $svcpart_svc_x[0]; #grab first one for access to $part_svc
1244       my $part_svc = $svc_x->part_svc;
1245       push @out, {
1246         'svcpart'      => $part_svc->svcpart,
1247         'svc'          => $part_svc->svc,
1248         'num_cust_svc' => scalar(@svcpart_svc_x),
1249       };
1250     } else {
1251       foreach my $svc_x (@svcpart_svc_x) {
1252         my $part_svc = $svc_x->part_svc;
1253         my $out = {
1254           'svcpart' => $part_svc->svcpart,
1255           'svc'     => $part_svc->svc,
1256           'uncancel_svcnum' => $svc_x->get('_h_svc_x')->svcnum,
1257         };
1258         $svc_x->pkgnum($self->pkgnum); # provisioning services on a canceled package, will be rolled back
1259         my $insert_error;
1260         unless ($opt{'no_test_reprovision'}) {
1261           # avoid possibly fatal errors from missing linked records
1262           eval { $insert_error = $svc_x->insert };
1263           $insert_error ||= $@;
1264         }
1265         if ($opt{'no_test_reprovision'} or $insert_error) {
1266           # avoid possibly fatal errors from missing linked records
1267           eval { $out->{'label'} = $svc_x->label };
1268           eval { $out->{'label'} = $svc_x->get('_h_svc_x')->label } unless defined($out->{'label'});
1269           $out->{'reprovisionable'} = 0 unless $opt{'no_test_reprovision'};
1270         } else {
1271           $out->{'label'} = $svc_x->label;
1272           $out->{'reprovisionable'} = 1;
1273         }
1274         push @out, $out;
1275       }
1276     }
1277   }
1278
1279   dbh->rollback;
1280   return @out;
1281 }
1282
1283 =item uncancel
1284
1285 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
1286 locationnum, (other fields?).  Attempts to re-provision cancelled services
1287 using history information (errors at this stage are not fatal).
1288
1289 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
1290
1291 svc_fatal: service provisioning errors are fatal
1292
1293 svc_errors: pass an array reference, will be filled in with any provisioning errors
1294
1295 only_svcnum: arrayref, only attempt to re-provision these cancelled services
1296
1297 main_pkgnum: link the package as a supplemental package of this one.  For
1298 internal use only.
1299
1300 =cut
1301
1302 sub uncancel {
1303   my( $self, %options ) = @_;
1304
1305   #in case you try do do $uncancel-date = $cust_pkg->uncacel
1306   return '' unless $self->get('cancel');
1307
1308   if ( $self->main_pkgnum and !$options{'main_pkgnum'} ) {
1309     return $self->main_pkg->uncancel(%options);
1310   }
1311
1312   ##
1313   # Transaction-alize
1314   ##
1315
1316   local $SIG{HUP} = 'IGNORE';
1317   local $SIG{INT} = 'IGNORE';
1318   local $SIG{QUIT} = 'IGNORE';
1319   local $SIG{TERM} = 'IGNORE';
1320   local $SIG{TSTP} = 'IGNORE';
1321   local $SIG{PIPE} = 'IGNORE';
1322
1323   my $oldAutoCommit = $FS::UID::AutoCommit;
1324   local $FS::UID::AutoCommit = 0;
1325   my $dbh = dbh;
1326
1327   ##
1328   # insert the new package
1329   ##
1330
1331   my $cust_pkg = new FS::cust_pkg {
1332     last_bill       => ( $options{'last_bill'} || $self->get('last_bill') ),
1333     bill            => ( $options{'bill'}      || $self->get('bill')      ),
1334     uncancel        => time,
1335     uncancel_pkgnum => $self->pkgnum,
1336     main_pkgnum     => ($options{'main_pkgnum'} || ''),
1337     map { $_ => $self->get($_) } qw(
1338       custnum pkgpart locationnum
1339       setup
1340       susp adjourn resume expire start_date contract_end dundate
1341       change_date change_pkgpart change_locationnum
1342       manual_flag no_auto separate_bill quantity agent_pkgid
1343       recur_show_zero setup_show_zero
1344     ),
1345   };
1346
1347   my $error = $cust_pkg->insert(
1348     'change' => 1, #supresses any referral credit to a referring customer
1349     'allow_pkgpart' => 1, # allow this even if the package def is disabled
1350   );
1351   if ($error) {
1352     $dbh->rollback if $oldAutoCommit;
1353     return $error;
1354   }
1355
1356   ##
1357   # insert services
1358   ##
1359
1360   my @svc_errors;
1361   foreach my $svc_x ($self->uncancel_svc_x('only_svcnum' => $options{'only_svcnum'})) {
1362
1363     $svc_x->pkgnum($cust_pkg->pkgnum);
1364     my $svc_error = $svc_x->insert;
1365
1366     if ( $svc_error ) {
1367       if ( $options{svc_fatal} ) {
1368         $dbh->rollback if $oldAutoCommit;
1369         return $svc_error;
1370       } else {
1371         # if we've failed to insert the svc_x object, svc_Common->insert
1372         # will have removed the cust_svc already.  if not, then both records
1373         # were inserted but we failed for some other reason (export, most
1374         # likely).  in that case, report the error and delete the records.
1375         push @svc_errors, $svc_error;
1376         my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1377         if ( $cust_svc ) {
1378           # except if export_insert failed, export_delete probably won't be
1379           # much better
1380           local $FS::svc_Common::noexport_hack = 1;
1381           my $cleanup_error = $svc_x->delete; # also deletes cust_svc
1382           if ( $cleanup_error ) { # and if THAT fails, then run away
1383             $dbh->rollback if $oldAutoCommit;
1384             return $cleanup_error;
1385           }
1386         }
1387       } # svc_fatal
1388     } # svc_error
1389   } #foreach uncancel_svc_x
1390
1391   ##
1392   # also move over any services that didn't unprovision at cancellation
1393   ##
1394
1395   foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1396     $cust_svc->pkgnum( $cust_pkg->pkgnum );
1397     my $error = $cust_svc->replace;
1398     if ( $error ) {
1399       $dbh->rollback if $oldAutoCommit;
1400       return $error;
1401     }
1402   }
1403
1404   ##
1405   # Uncancel any supplemental packages, and make them supplemental to the
1406   # new one.
1407   ##
1408
1409   foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1410     my $new_pkg;
1411     $error = $supp_pkg->uncancel(%options, 'main_pkgnum' => $cust_pkg->pkgnum);
1412     if ( $error ) {
1413       $dbh->rollback if $oldAutoCommit;
1414       return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1415     }
1416   }
1417
1418   ##
1419   # Finish
1420   ##
1421
1422   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1423
1424   ${ $options{cust_pkg} }   = $cust_pkg   if ref($options{cust_pkg});
1425   @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1426
1427   '';
1428 }
1429
1430 =item unexpire
1431
1432 Cancels any pending expiration (sets the expire field to null)
1433 for this package and any supplemental packages.
1434
1435 If there is an error, returns the error, otherwise returns false.
1436
1437 =cut
1438
1439 sub unexpire {
1440   my( $self ) = @_;
1441   my $error;
1442
1443   local $SIG{HUP} = 'IGNORE';
1444   local $SIG{INT} = 'IGNORE';
1445   local $SIG{QUIT} = 'IGNORE';
1446   local $SIG{TERM} = 'IGNORE';
1447   local $SIG{TSTP} = 'IGNORE';
1448   local $SIG{PIPE} = 'IGNORE';
1449
1450   my $oldAutoCommit = $FS::UID::AutoCommit;
1451   local $FS::UID::AutoCommit = 0;
1452   my $dbh = dbh;
1453
1454   my $old = $self->select_for_update;
1455
1456   my $pkgnum = $old->pkgnum;
1457   if ( $old->get('cancel') || $self->get('cancel') ) {
1458     dbh->rollback if $oldAutoCommit;
1459     return "Can't unexpire cancelled package $pkgnum";
1460     # or at least it's pointless
1461   }
1462
1463   unless ( $old->get('expire') && $self->get('expire') ) {
1464     dbh->rollback if $oldAutoCommit;
1465     return "";  # no error
1466   }
1467
1468   my %hash = $self->hash;
1469   $hash{'expire'} = '';
1470   my $new = new FS::cust_pkg ( \%hash );
1471   $error = $new->replace( $self, options => { $self->options } );
1472   if ( $error ) {
1473     $dbh->rollback if $oldAutoCommit;
1474     return $error;
1475   }
1476
1477   foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1478     $error = $supp_pkg->unexpire;
1479     if ( $error ) {
1480       $dbh->rollback if $oldAutoCommit;
1481       return "unexpiring supplemental pkg#".$supp_pkg->pkgnum.": $error";
1482     }
1483   }
1484
1485   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1486
1487   ''; #no errors
1488
1489 }
1490
1491 =item suspend [ OPTION => VALUE ... ]
1492
1493 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1494 package, then suspends the package itself (sets the susp field to now).
1495
1496 Available options are:
1497
1498 =over 4
1499
1500 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1501 either a reasonnum of an existing reason, or passing a hashref will create
1502 a new reason.  The hashref should have the following keys:
1503 - typenum - Reason type (see L<FS::reason_type>
1504 - reason - Text of the new reason.
1505
1506 =item date - can be set to a unix style timestamp to specify when to
1507 suspend (adjourn)
1508
1509 =item time - can be set to override the current time, for calculation
1510 of final invoices or unused-time credits
1511
1512 =item resume_date - can be set to a time when the package should be
1513 unsuspended.  This may be more convenient than calling C<unsuspend()>
1514 separately.
1515
1516 =item from_main - allows a supplemental package to be suspended, rather
1517 than redirecting the method call to its main package.  For internal use.
1518
1519 =item from_cancel - used when suspending from the cancel method, forces
1520 this to skip everything besides basic suspension.  For internal use.
1521
1522 =back
1523
1524 If there is an error, returns the error, otherwise returns false.
1525
1526 =cut
1527
1528 sub suspend {
1529   my( $self, %options ) = @_;
1530   my $error;
1531
1532   # pass all suspend/cancel actions to the main package
1533   if ( $self->main_pkgnum and !$options{'from_main'} ) {
1534     return $self->main_pkg->suspend(%options);
1535   }
1536
1537   local $SIG{HUP} = 'IGNORE';
1538   local $SIG{INT} = 'IGNORE';
1539   local $SIG{QUIT} = 'IGNORE';
1540   local $SIG{TERM} = 'IGNORE';
1541   local $SIG{TSTP} = 'IGNORE';
1542   local $SIG{PIPE} = 'IGNORE';
1543
1544   my $oldAutoCommit = $FS::UID::AutoCommit;
1545   local $FS::UID::AutoCommit = 0;
1546   my $dbh = dbh;
1547
1548   my $old = $self->select_for_update;
1549
1550   my $pkgnum = $old->pkgnum;
1551   if ( $old->get('cancel') || $self->get('cancel') ) {
1552     dbh->rollback if $oldAutoCommit;
1553     return "Can't suspend cancelled package $pkgnum";
1554   }
1555
1556   if ( $old->get('susp') || $self->get('susp') ) {
1557     dbh->rollback if $oldAutoCommit;
1558     return "";  # no error                     # complain on adjourn?
1559   }
1560
1561   my $suspend_time = $options{'time'} || time;
1562   my $date = $options{date} if $options{date}; # adjourn/suspend later
1563   $date = '' if ($date && $date <= $suspend_time); # complain instead?
1564
1565   if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1566     dbh->rollback if $oldAutoCommit;
1567     return "Package $pkgnum expires before it would be suspended.";
1568   }
1569
1570   # some false laziness with sub cancel
1571   if ( !$options{nobill} && !$date && !$options{'from_cancel'} &&
1572        $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1573     # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1574     # make the entire cust_main->bill path recognize 'suspend' and
1575     # 'cancel' separately.
1576     warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1577     my $copy = $self->new({$self->hash});
1578     my $error =
1579       $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1580                               'cancel'   => 1,
1581                               'time'     => $suspend_time );
1582     warn "Error billing during suspend, custnum ".
1583       #$self->cust_main->custnum. ": $error"
1584       ": $error"
1585       if $error;
1586   }
1587
1588   my $cust_pkg_reason;
1589   if ( $options{'reason'} ) {
1590     $error = $self->insert_reason( 'reason' => $options{'reason'},
1591                                    'action' => $date ? 'adjourn' : 'suspend',
1592                                    'date'   => $date ? $date : $suspend_time,
1593                                    'reason_otaker' => $options{'reason_otaker'},
1594                                  );
1595     if ( $error ) {
1596       dbh->rollback if $oldAutoCommit;
1597       return "Error inserting cust_pkg_reason: $error";
1598     }
1599     $cust_pkg_reason = qsearchs('cust_pkg_reason', {
1600         'date'    => $date ? $date : $suspend_time,
1601         'action'  => $date ? 'A' : 'S',
1602         'pkgnum'  => $self->pkgnum,
1603     });
1604   }
1605
1606   # if a reasonnum was passed, get the actual reason object so we can check
1607   # unused_credit
1608   # (passing a reason hashref is still allowed, but it can't be used with
1609   # the fancy behavioral options.)
1610
1611   my $reason;
1612   if ($options{'reason'} =~ /^\d+$/) {
1613     $reason = FS::reason->by_key($options{'reason'});
1614   }
1615
1616   my %hash = $self->hash;
1617   if ( $date ) {
1618     $hash{'adjourn'} = $date;
1619   } else {
1620     $hash{'susp'} = $suspend_time;
1621   }
1622
1623   my $resume_date = $options{'resume_date'} || 0;
1624   if ( $resume_date > ($date || $suspend_time) ) {
1625     $hash{'resume'} = $resume_date;
1626   }
1627
1628   $options{options} ||= {};
1629
1630   my $new = new FS::cust_pkg ( \%hash );
1631   $error = $new->replace( $self, options => { $self->options,
1632                                               %{ $options{options} },
1633                                             }
1634                         );
1635   if ( $error ) {
1636     $dbh->rollback if $oldAutoCommit;
1637     return $error;
1638   }
1639
1640   unless ( $date ) { # then we are suspending now
1641
1642     unless ($options{'from_cancel'}) {
1643       # credit remaining time if appropriate
1644       # (if required by the package def, or the suspend reason)
1645       my $unused_credit = $self->part_pkg->option('unused_credit_suspend',1)
1646                           || ( defined($reason) && $reason->unused_credit );
1647
1648       if ( $unused_credit ) {
1649         warn "crediting unused time on pkg#".$self->pkgnum."\n" if $DEBUG;
1650         my $error = $self->credit_remaining('suspend', $suspend_time);
1651         if ($error) {
1652           $dbh->rollback if $oldAutoCommit;
1653           return $error;
1654         }
1655       }
1656     }
1657
1658     my @labels = ();
1659
1660     foreach my $cust_svc (
1661       qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1662     ) {
1663       my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1664
1665       $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1666         $dbh->rollback if $oldAutoCommit;
1667         return "Illegal svcdb value in part_svc!";
1668       };
1669       my $svcdb = $1;
1670       require "FS/$svcdb.pm";
1671
1672       my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1673       if ($svc) {
1674         $error = $svc->suspend;
1675         if ( $error ) {
1676           $dbh->rollback if $oldAutoCommit;
1677           return $error;
1678         }
1679         my( $label, $value ) = $cust_svc->label;
1680         push @labels, "$label: $value";
1681       }
1682     }
1683
1684     # suspension fees: if there is a feepart, and it's not an unsuspend fee,
1685     # and this is not a suspend-before-cancel
1686     if ( $cust_pkg_reason ) {
1687       my $reason_obj = $cust_pkg_reason->reason;
1688       if ( $reason_obj->feepart and
1689            ! $reason_obj->fee_on_unsuspend and
1690            ! $options{'from_cancel'} ) {
1691
1692         # register the need to charge a fee, cust_main->bill will do the rest
1693         warn "registering suspend fee: pkgnum ".$self->pkgnum.", feepart ".$reason->feepart."\n"
1694           if $DEBUG;
1695         my $cust_pkg_reason_fee = FS::cust_pkg_reason_fee->new({
1696             'pkgreasonnum'  => $cust_pkg_reason->num,
1697             'pkgnum'        => $self->pkgnum,
1698             'feepart'       => $reason->feepart,
1699             'nextbill'      => $reason->fee_hold,
1700         });
1701         $error ||= $cust_pkg_reason_fee->insert;
1702       }
1703     }
1704
1705     my $conf = new FS::Conf;
1706     if ( $conf->config('suspend_email_admin') && !$options{'from_cancel'} ) {
1707
1708       my $error = send_email(
1709         'from'    => $conf->config('invoice_from', $self->cust_main->agentnum),
1710                                    #invoice_from ??? well as good as any
1711         'to'      => $conf->config('suspend_email_admin'),
1712         'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1713         'body'    => [
1714           "This is an automatic message from your Freeside installation\n",
1715           "informing you that the following customer package has been suspended:\n",
1716           "\n",
1717           'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1718           'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1719           ( map { "Service : $_\n" } @labels ),
1720         ],
1721         'custnum' => $self->custnum,
1722         'msgtype' => 'admin'
1723       );
1724
1725       if ( $error ) {
1726         warn "WARNING: can't send suspension admin email (suspending anyway): ".
1727              "$error\n";
1728       }
1729
1730     }
1731
1732   }
1733
1734   foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1735     $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1736     if ( $error ) {
1737       $dbh->rollback if $oldAutoCommit;
1738       return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1739     }
1740   }
1741
1742   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1743
1744   ''; #no errors
1745 }
1746
1747 =item credit_remaining MODE TIME
1748
1749 Generate a credit for this package for the time remaining in the current
1750 billing period.  MODE is either "suspend" or "cancel" (determines the
1751 credit type).  TIME is the time of suspension/cancellation.  Both arguments
1752 are mandatory.
1753
1754 =cut
1755
1756 # Implementation note:
1757 #
1758 # If you pkgpart-change a package that has been billed, and it's set to give
1759 # credit on package change, then this method gets called and then the new
1760 # package will have no last_bill date. Therefore the customer will be credited
1761 # only once (per billing period) even if there are multiple package changes.
1762 #
1763 # If you location-change a package that has been billed, this method will NOT
1764 # be called and the new package WILL have the last bill date of the old
1765 # package.
1766 #
1767 # If the new package is then canceled within the same billing cycle,
1768 # credit_remaining needs to run calc_remain on the OLD package to determine
1769 # the amount of unused time to credit.
1770
1771 sub credit_remaining {
1772   # Add a credit for remaining service
1773   my ($self, $mode, $time) = @_;
1774   die 'credit_remaining requires suspend or cancel'
1775     unless $mode eq 'suspend' or $mode eq 'cancel';
1776   die 'no suspend/cancel time' unless $time > 0;
1777
1778   my $conf = FS::Conf->new;
1779   my $reason_type = $conf->config($mode.'_credit_type');
1780
1781   $time ||= time;
1782
1783   my $remain_pkg = $self;
1784   my (@billpkgnums, @amounts, @setuprecurs);
1785
1786   # we may have to walk back past some package changes to get to the
1787   # one that actually has unused time. loop until that happens, or we
1788   # reach the first package in the chain.
1789   while (1) {
1790     my $last_bill = $remain_pkg->get('last_bill') || 0;
1791     my $next_bill = $remain_pkg->get('bill') || 0;
1792     if ( $last_bill > 0         # the package has been billed
1793         and $next_bill > 0      # the package has a next bill date
1794         and $next_bill >= $time # which is in the future
1795     ) {
1796
1797       # Find actual charges for the period ending on or after the cancel
1798       # date.
1799       my @charges = qsearch('cust_bill_pkg', {
1800         pkgnum => $remain_pkg->pkgnum,
1801         edate => {op => '>=', value => $time},
1802         recur => {op => '>' , value => 0},
1803       });
1804
1805       foreach my $cust_bill_pkg (@charges) {
1806         # hack to deal with the weird behavior of edate on package
1807         # cancellation
1808         my $edate = $cust_bill_pkg->edate;
1809         if ( $self->recur_temporality eq 'preceding' ) {
1810           $edate = $self->add_freq($cust_bill_pkg->sdate);
1811         }
1812
1813         # this will also get any package charges that are _entirely_ after
1814         # the cancellation date (can happen with advance billing). in that
1815         # case, use the entire recurring charge:
1816         my $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
1817         my $max_credit = $amount
1818             - $cust_bill_pkg->credited('', '', setuprecur => 'recur') || 0;
1819
1820         # but if the cancellation happens during the interval, prorate it:
1821         # (XXX obey prorate_round_day here?)
1822         if ( $cust_bill_pkg->sdate < $time ) {
1823           $amount = $amount *
1824                       ($edate - $time) / ($edate - $cust_bill_pkg->sdate);
1825         }
1826
1827         # if there are existing credits, don't let the sum of credits exceed
1828         # the recurring charge
1829         $amount = $max_credit if $amount > $max_credit;
1830
1831         $amount = sprintf('%.2f', $amount);
1832
1833         # if no time has been used and/or there are existing line item
1834         # credits, we may end up not needing to credit anything.
1835         if ( $amount > 0 ) {
1836
1837           push @billpkgnums, $cust_bill_pkg->billpkgnum;
1838           push @amounts,     $amount;
1839           push @setuprecurs, 'recur';
1840
1841           warn "Crediting for $amount on package ".$remain_pkg->pkgnum."\n"
1842             if $DEBUG;
1843         }
1844
1845       }
1846
1847       last if @charges;
1848     }
1849
1850     if ( my $changed_from_pkgnum = $remain_pkg->change_pkgnum ) {
1851       $remain_pkg = FS::cust_pkg->by_key($changed_from_pkgnum);
1852     } else {
1853       # the package has really never been billed
1854       return;
1855     }
1856   }
1857
1858   # keep traditional behavior here.
1859   local $@;
1860   my $reason = FS::reason->new_or_existing(
1861     reason  => 'Credit for unused time on '. $self->part_pkg->pkg,
1862     type    => $reason_type,
1863     class   => 'R',
1864   );
1865   if ( $@ ) {
1866     return "failed to set credit reason: $@";
1867   }
1868
1869   my $error = FS::cust_credit->credit_lineitems(
1870     'billpkgnums' => \@billpkgnums,
1871     'setuprecurs' => \@setuprecurs,
1872     'amounts'     => \@amounts,
1873     'custnum'     => $self->custnum,
1874     'date'        => time,
1875     'reasonnum'   => $reason->reasonnum,
1876     'apply'       => 1,
1877   );
1878
1879   '';
1880 }
1881
1882 =item unsuspend [ OPTION => VALUE ... ]
1883
1884 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1885 package, then unsuspends the package itself (clears the susp field and the
1886 adjourn field if it is in the past).  If the suspend reason includes an
1887 unsuspension package, that package will be ordered.
1888
1889 Available options are:
1890
1891 =over 4
1892
1893 =item date
1894
1895 Can be set to a date to unsuspend the package in the future (the 'resume'
1896 field).
1897
1898 =item adjust_next_bill
1899
1900 Can be set true to adjust the next bill date forward by
1901 the amount of time the account was inactive.  This was set true by default
1902 in the past (from 1.4.2 and 1.5.0pre6 through 1.7.0), but now needs to be
1903 explicitly requested with this option or in the price plan.
1904
1905 =back
1906
1907 If there is an error, returns the error, otherwise returns false.
1908
1909 =cut
1910
1911 sub unsuspend {
1912   my( $self, %opt ) = @_;
1913   my $error;
1914
1915   # pass all suspend/cancel actions to the main package
1916   if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1917     return $self->main_pkg->unsuspend(%opt);
1918   }
1919
1920   local $SIG{HUP} = 'IGNORE';
1921   local $SIG{INT} = 'IGNORE';
1922   local $SIG{QUIT} = 'IGNORE';
1923   local $SIG{TERM} = 'IGNORE';
1924   local $SIG{TSTP} = 'IGNORE';
1925   local $SIG{PIPE} = 'IGNORE';
1926
1927   my $oldAutoCommit = $FS::UID::AutoCommit;
1928   local $FS::UID::AutoCommit = 0;
1929   my $dbh = dbh;
1930
1931   my $old = $self->select_for_update;
1932
1933   my $pkgnum = $old->pkgnum;
1934   if ( $old->get('cancel') || $self->get('cancel') ) {
1935     $dbh->rollback if $oldAutoCommit;
1936     return "Can't unsuspend cancelled package $pkgnum";
1937   }
1938
1939   unless ( $old->get('susp') && $self->get('susp') ) {
1940     $dbh->rollback if $oldAutoCommit;
1941     return "";  # no error                     # complain instead?
1942   }
1943
1944   # handle the case of setting a future unsuspend (resume) date
1945   # and do not continue to actually unsuspend the package
1946   my $date = $opt{'date'};
1947   if ( $date and $date > time ) { # return an error if $date <= time?
1948
1949     if ( $old->get('expire') && $old->get('expire') < $date ) {
1950       $dbh->rollback if $oldAutoCommit;
1951       return "Package $pkgnum expires before it would be unsuspended.";
1952     }
1953
1954     my $new = new FS::cust_pkg { $self->hash };
1955     $new->set('resume', $date);
1956     $error = $new->replace($self, options => $self->options);
1957
1958     if ( $error ) {
1959       $dbh->rollback if $oldAutoCommit;
1960       return $error;
1961     }
1962     else {
1963       $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1964       return '';
1965     }
1966
1967   } #if $date
1968
1969   if (!$self->setup) {
1970     # then this package is being released from on-hold status
1971     $self->set_initial_timers;
1972   }
1973
1974   my @labels = ();
1975
1976   foreach my $cust_svc (
1977     qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1978   ) {
1979     my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1980
1981     $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1982       $dbh->rollback if $oldAutoCommit;
1983       return "Illegal svcdb value in part_svc!";
1984     };
1985     my $svcdb = $1;
1986     require "FS/$svcdb.pm";
1987
1988     my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1989     if ($svc) {
1990       $error = $svc->unsuspend;
1991       if ( $error ) {
1992         $dbh->rollback if $oldAutoCommit;
1993         return $error;
1994       }
1995       my( $label, $value ) = $cust_svc->label;
1996       push @labels, "$label: $value";
1997     }
1998
1999   }
2000
2001   my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
2002   my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
2003
2004   my %hash = $self->hash;
2005   my $inactive = time - $hash{'susp'};
2006
2007   my $conf = new FS::Conf;
2008
2009   # increment next bill date if certain conditions are met:
2010   # - it was due to be billed at some point
2011   # - either the global or local config says to do this
2012   my $adjust_bill = 0;
2013   if (
2014        $inactive > 0
2015     && ( $hash{'bill'} || $hash{'setup'} )
2016     && (    $opt{'adjust_next_bill'}
2017          || $conf->exists('unsuspend-always_adjust_next_bill_date')
2018          || $self->part_pkg->option('unsuspend_adjust_bill', 1)
2019        )
2020   ) {
2021     $adjust_bill = 1;
2022   }
2023
2024   # but not if:
2025   # - the package billed during suspension
2026   # - or it was ordered on hold
2027   # - or the customer was credited for the unused time
2028
2029   if ( $self->option('suspend_bill',1)
2030       or ( $self->part_pkg->option('suspend_bill',1)
2031            and ! $self->option('no_suspend_bill',1)
2032          )
2033       or $hash{'order_date'} == $hash{'susp'}
2034   ) {
2035     $adjust_bill = 0;
2036   }
2037
2038   if ( $adjust_bill ) {
2039     if (    $self->part_pkg->option('unused_credit_suspend')
2040          or ( $reason and $reason->unused_credit ) ) {
2041       # then the customer was credited for the unused time before suspending,
2042       # so their next bill should be immediate.
2043       $hash{'bill'} = time;
2044     } else {
2045       # add the length of time suspended to the bill date
2046       $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
2047     }
2048   }
2049
2050   $hash{'susp'} = '';
2051   $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
2052   $hash{'resume'} = '' if !$hash{'adjourn'};
2053   my $new = new FS::cust_pkg ( \%hash );
2054   $error = $new->replace( $self, options => { $self->options } );
2055   if ( $error ) {
2056     $dbh->rollback if $oldAutoCommit;
2057     return $error;
2058   }
2059
2060   my $unsusp_pkg;
2061
2062   if ( $reason ) {
2063     if ( $reason->unsuspend_pkgpart ) {
2064       #warn "Suspend reason '".$reason->reason."' uses deprecated unsuspend_pkgpart feature.\n"; # in 4.x
2065       my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
2066         or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
2067                     " not found.";
2068       my $start_date = $self->cust_main->next_bill_date
2069         if $reason->unsuspend_hold;
2070
2071       if ( $part_pkg ) {
2072         $unsusp_pkg = FS::cust_pkg->new({
2073             'custnum'     => $self->custnum,
2074             'pkgpart'     => $reason->unsuspend_pkgpart,
2075             'start_date'  => $start_date,
2076             'locationnum' => $self->locationnum,
2077             # discount? probably not...
2078         });
2079
2080         $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
2081       }
2082     }
2083     # new way, using fees
2084     if ( $reason->feepart and $reason->fee_on_unsuspend ) {
2085       # register the need to charge a fee, cust_main->bill will do the rest
2086       warn "registering unsuspend fee: pkgnum ".$self->pkgnum.", feepart ".$reason->feepart."\n"
2087         if $DEBUG;
2088       my $cust_pkg_reason_fee = FS::cust_pkg_reason_fee->new({
2089           'pkgreasonnum'  => $cust_pkg_reason->num,
2090           'pkgnum'        => $self->pkgnum,
2091           'feepart'       => $reason->feepart,
2092           'nextbill'      => $reason->fee_hold,
2093       });
2094       $error ||= $cust_pkg_reason_fee->insert;
2095     }
2096
2097     if ( $error ) {
2098       $dbh->rollback if $oldAutoCommit;
2099       return $error;
2100     }
2101   }
2102
2103   if ( $conf->config('unsuspend_email_admin') ) {
2104
2105     my $error = send_email(
2106       'from'    => $conf->config('invoice_from', $self->cust_main->agentnum),
2107                                  #invoice_from ??? well as good as any
2108       'to'      => $conf->config('unsuspend_email_admin'),
2109       'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended',       'body'    => [
2110         "This is an automatic message from your Freeside installation\n",
2111         "informing you that the following customer package has been unsuspended:\n",
2112         "\n",
2113         'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
2114         'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
2115         ( map { "Service : $_\n" } @labels ),
2116         ($unsusp_pkg ?
2117           "An unsuspension fee was charged: ".
2118             $unsusp_pkg->part_pkg->pkg_comment."\n"
2119           : ''
2120         ),
2121       ],
2122       'custnum' => $self->custnum,
2123       'msgtype' => 'admin',
2124     );
2125
2126     if ( $error ) {
2127       warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
2128            "$error\n";
2129     }
2130
2131   }
2132
2133   foreach my $supp_pkg ( $self->supplemental_pkgs ) {
2134     $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
2135     if ( $error ) {
2136       $dbh->rollback if $oldAutoCommit;
2137       return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
2138     }
2139   }
2140
2141   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2142
2143   ''; #no errors
2144 }
2145
2146 =item unadjourn
2147
2148 Cancels any pending suspension (sets the adjourn field to null)
2149 for this package and any supplemental packages.
2150
2151 If there is an error, returns the error, otherwise returns false.
2152
2153 =cut
2154
2155 sub unadjourn {
2156   my( $self ) = @_;
2157   my $error;
2158
2159   local $SIG{HUP} = 'IGNORE';
2160   local $SIG{INT} = 'IGNORE';
2161   local $SIG{QUIT} = 'IGNORE';
2162   local $SIG{TERM} = 'IGNORE';
2163   local $SIG{TSTP} = 'IGNORE';
2164   local $SIG{PIPE} = 'IGNORE';
2165
2166   my $oldAutoCommit = $FS::UID::AutoCommit;
2167   local $FS::UID::AutoCommit = 0;
2168   my $dbh = dbh;
2169
2170   my $old = $self->select_for_update;
2171
2172   my $pkgnum = $old->pkgnum;
2173   if ( $old->get('cancel') || $self->get('cancel') ) {
2174     dbh->rollback if $oldAutoCommit;
2175     return "Can't unadjourn cancelled package $pkgnum";
2176     # or at least it's pointless
2177   }
2178
2179   if ( $old->get('susp') || $self->get('susp') ) {
2180     dbh->rollback if $oldAutoCommit;
2181     return "Can't unadjourn suspended package $pkgnum";
2182     # perhaps this is arbitrary
2183   }
2184
2185   unless ( $old->get('adjourn') && $self->get('adjourn') ) {
2186     dbh->rollback if $oldAutoCommit;
2187     return "";  # no error
2188   }
2189
2190   my %hash = $self->hash;
2191   $hash{'adjourn'} = '';
2192   $hash{'resume'}  = '';
2193   my $new = new FS::cust_pkg ( \%hash );
2194   $error = $new->replace( $self, options => { $self->options } );
2195   if ( $error ) {
2196     $dbh->rollback if $oldAutoCommit;
2197     return $error;
2198   }
2199
2200   foreach my $supp_pkg ( $self->supplemental_pkgs ) {
2201     $error = $supp_pkg->unadjourn;
2202     if ( $error ) {
2203       $dbh->rollback if $oldAutoCommit;
2204       return "unadjourning supplemental pkg#".$supp_pkg->pkgnum.": $error";
2205     }
2206   }
2207
2208   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2209
2210   ''; #no errors
2211
2212 }
2213
2214
2215 =item change HASHREF | OPTION => VALUE ...
2216
2217 Changes this package: cancels it and creates a new one, with a different
2218 pkgpart or locationnum or both.  All services are transferred to the new
2219 package (no change will be made if this is not possible).
2220
2221 Options may be passed as a list of key/value pairs or as a hash reference.
2222 Options are:
2223
2224 =over 4
2225
2226 =item locationnum
2227
2228 New locationnum, to change the location for this package.
2229
2230 =item cust_location
2231
2232 New FS::cust_location object, to create a new location and assign it
2233 to this package.
2234
2235 =item cust_main
2236
2237 New FS::cust_main object, to create a new customer and assign the new package
2238 to it.
2239
2240 =item pkgpart
2241
2242 New pkgpart (see L<FS::part_pkg>).
2243
2244 =item refnum
2245
2246 New refnum (see L<FS::part_referral>).
2247
2248 =item quantity
2249
2250 New quantity; if unspecified, the new package will have the same quantity
2251 as the old.
2252
2253 =item cust_pkg
2254
2255 "New" (existing) FS::cust_pkg object.  The package's services and other
2256 attributes will be transferred to this package.
2257
2258 =item keep_dates
2259
2260 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
2261 susp, adjourn, cancel, expire, and contract_end) to the new package.
2262
2263 =item unprotect_svcs
2264
2265 Normally, change() will rollback and return an error if some services
2266 can't be transferred (also see the I<cust_pkg-change_svcpart> config option).
2267 If unprotect_svcs is true, this method will transfer as many services as
2268 it can and then unconditionally cancel the old package.
2269
2270 =item contract_end
2271
2272 If specified, sets this value for the contract_end date on the new package
2273 (without regard for keep_dates or the usual date-preservation behavior.)
2274 Will throw an error if defined but false;  the UI doesn't allow editing
2275 this unless it already exists, making removal impossible to undo.
2276
2277 =back
2278
2279 At least one of locationnum, cust_location, pkgpart, refnum, cust_main, or
2280 cust_pkg must be specified (otherwise, what's the point?)
2281
2282 Returns either the new FS::cust_pkg object or a scalar error.
2283
2284 For example:
2285
2286   my $err_or_new_cust_pkg = $old_cust_pkg->change
2287
2288 =cut
2289
2290 #used by change and change_later
2291 #didn't put with documented check methods because it depends on change-specific opts
2292 #and it also possibly edits the value of opts
2293 sub _check_change {
2294   my $self = shift;
2295   my $opt = shift;
2296   if ( defined($opt->{'contract_end'}) ) {
2297     my $current_contract_end = $self->get('contract_end');
2298     unless ($opt->{'contract_end'}) {
2299       if ($current_contract_end) {
2300         return "Cannot remove contract end date when changing packages";
2301       } else {
2302         #shouldn't even pass this option if there's not a current value
2303         #but can be handled gracefully if the option is empty
2304         warn "Contract end date passed unexpectedly";
2305         delete $opt->{'contract_end'};
2306         return '';
2307       }
2308     }
2309     unless ($current_contract_end) {
2310       #option shouldn't be passed, throw error if it's non-empty
2311       return "Cannot add contract end date when changing packages " . $self->pkgnum;
2312     }
2313   }
2314   return '';
2315 }
2316
2317 #some false laziness w/order
2318 sub change {
2319   my $self = shift;
2320   my $opt = ref($_[0]) ? shift : { @_ };
2321
2322   my $conf = new FS::Conf;
2323
2324   # handle contract_end on cust_pkg same as passed option
2325   if ( $opt->{'cust_pkg'} ) {
2326     $opt->{'contract_end'} = $opt->{'cust_pkg'}->contract_end;
2327     delete $opt->{'contract_end'} unless $opt->{'contract_end'};
2328   }
2329
2330   # check contract_end, prevent adding/removing
2331   my $error = $self->_check_change($opt);
2332   return $error if $error;
2333
2334   # Transactionize this whole mess
2335   local $SIG{HUP} = 'IGNORE';
2336   local $SIG{INT} = 'IGNORE';
2337   local $SIG{QUIT} = 'IGNORE';
2338   local $SIG{TERM} = 'IGNORE';
2339   local $SIG{TSTP} = 'IGNORE';
2340   local $SIG{PIPE} = 'IGNORE';
2341
2342   my $oldAutoCommit = $FS::UID::AutoCommit;
2343   local $FS::UID::AutoCommit = 0;
2344   my $dbh = dbh;
2345
2346   if ( $opt->{'cust_location'} ) {
2347     $error = $opt->{'cust_location'}->find_or_insert;
2348     if ( $error ) {
2349       $dbh->rollback if $oldAutoCommit;
2350       return "creating location record: $error";
2351     }
2352     $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
2353   }
2354
2355   # figure out if we're changing pkgpart
2356   if ( $opt->{'cust_pkg'} ) {
2357     $opt->{'pkgpart'} = $opt->{'cust_pkg'}->pkgpart;
2358   }
2359
2360   # whether to override pkgpart checking on the new package
2361   my $same_pkgpart = 1;
2362   if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
2363     $same_pkgpart = 0;
2364   }
2365
2366   if ($opt->{'waive_setup'}) { $self->set('waive_setup', $opt->{'waive_setup'}) }
2367   else { $self->set('waive_setup', ''); }
2368
2369   # Before going any further here: if the package is still in the pre-setup
2370   # state, it's safe to modify it in place. No need to charge/credit for
2371   # partial period, transfer usage pools, copy invoice details, or change any
2372   # dates. We DO need to "transfer" services (from the package to itself) to
2373   # check their validity on the new pkgpart.
2374   if ( ! $self->setup and ! $opt->{cust_pkg} and ! $opt->{cust_main} ) {
2375     foreach ( qw( locationnum pkgpart quantity refnum salesnum waive_setup ) ) {
2376       if ( length($opt->{$_}) ) {
2377         $self->set($_, $opt->{$_});
2378       }
2379     }
2380     # almost. if the new pkgpart specifies start/adjourn/expire timers,
2381     # apply those.
2382     if ( !$same_pkgpart ) {
2383       $self->set_initial_timers;
2384     }
2385     # but if contract_end was explicitly specified, that overrides all else
2386     $self->set('contract_end', $opt->{'contract_end'})
2387       if $opt->{'contract_end'};
2388
2389     $error = $self->replace;
2390     if ( $error ) {
2391       $dbh->rollback if $oldAutoCommit;
2392       return "modifying package: $error";
2393     }
2394
2395     # check/convert services (only on pkgpart change, to avoid surprises
2396     # when editing locations)
2397     # (maybe do this if changing quantity?)
2398     if ( !$same_pkgpart ) {
2399
2400       $error = $self->transfer($self);
2401
2402       if ( $error and $error == 0 ) {
2403         $error = "transferring $error";
2404       } elsif ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2405         warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2406         $error = $self->transfer($self, 'change_svcpart'=>1 );
2407         if ($error and $error == 0) {
2408           $error = "converting $error";
2409         }
2410       }
2411
2412       if ($error > 0) {
2413         $error = "unable to transfer all services";
2414       }
2415
2416       if ( $error ) {
2417         $dbh->rollback if $oldAutoCommit;
2418         return $error;
2419       }
2420
2421     } # done transferring services
2422
2423     $dbh->commit if $oldAutoCommit;
2424     return $self;
2425
2426   }
2427
2428   my %hash = ();
2429
2430   my $time = time;
2431
2432   $hash{'setup'} = $time if $self->get('setup');
2433
2434   $hash{'change_date'} = $time;
2435   $hash{"change_$_"}  = $self->$_()
2436     foreach qw( pkgnum pkgpart locationnum );
2437
2438   my $unused_credit = 0;
2439   my $keep_dates = $opt->{'keep_dates'};
2440
2441   # Special case.  If the pkgpart is changing, and the customer is going to be
2442   # credited for remaining time, don't keep setup, bill, or last_bill dates,
2443   # and DO pass the flag to cancel() to credit the customer.  If the old
2444   # package had a setup date, set the new package's setup to the package
2445   # change date so that it has the same status as before.
2446   if ( $opt->{'pkgpart'}
2447        and $opt->{'pkgpart'} != $self->pkgpart
2448        and $self->part_pkg->option('unused_credit_change', 1) ) {
2449     $unused_credit = 1;
2450     $keep_dates = 0;
2451     $hash{'last_bill'} = '';
2452     $hash{'bill'} = '';
2453   }
2454
2455   if ( $keep_dates ) {
2456     foreach my $date ( qw(setup bill last_bill) ) {
2457       $hash{$date} = $self->getfield($date);
2458     }
2459   }
2460   # always keep the following dates
2461   foreach my $date (qw(order_date susp adjourn cancel expire resume
2462                     start_date contract_end)) {
2463     $hash{$date} = $self->getfield($date);
2464   }
2465   # but if contract_end was explicitly specified, that overrides all else
2466   $hash{'contract_end'} = $opt->{'contract_end'}
2467     if $opt->{'contract_end'};
2468
2469   # allow $opt->{'locationnum'} = '' to specifically set it to null
2470   # (i.e. customer default location)
2471   $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2472
2473   # usually this doesn't matter.  the two cases where it does are:
2474   # 1. unused_credit_change + pkgpart change + setup fee on the new package
2475   # and
2476   # 2. (more importantly) changing a package before it's billed
2477   $hash{'waive_setup'} = $self->waive_setup;
2478
2479   # if this package is scheduled for a future package change, preserve that
2480   $hash{'change_to_pkgnum'} = $self->change_to_pkgnum;
2481
2482   my $custnum = $self->custnum;
2483   if ( $opt->{cust_main} ) {
2484     my $cust_main = $opt->{cust_main};
2485     unless ( $cust_main->custnum ) {
2486       my $error = $cust_main->insert( @{ $opt->{cust_main_insert_args}||[] } );
2487       if ( $error ) {
2488         $dbh->rollback if $oldAutoCommit;
2489         return "inserting customer record: $error";
2490       }
2491     }
2492     $custnum = $cust_main->custnum;
2493   }
2494
2495   $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
2496
2497   my $cust_pkg;
2498   if ( $opt->{'cust_pkg'} ) {
2499     # The target package already exists; update it to show that it was
2500     # changed from this package.
2501     $cust_pkg = $opt->{'cust_pkg'};
2502
2503     # follow all the above rules for date changes, etc.
2504     foreach (keys %hash) {
2505       $cust_pkg->set($_, $hash{$_});
2506     }
2507     # except those that implement the future package change behavior
2508     foreach (qw(change_to_pkgnum start_date expire)) {
2509       $cust_pkg->set($_, '');
2510     }
2511
2512     $error = $cust_pkg->replace;
2513
2514   } else {
2515     # Create the new package.
2516     $cust_pkg = new FS::cust_pkg {
2517       custnum     => $custnum,
2518       locationnum => $opt->{'locationnum'},
2519       ( map {  $_ => ( $opt->{$_} || $self->$_() )  }
2520           qw( pkgpart quantity refnum salesnum )
2521       ),
2522       %hash,
2523     };
2524     $error = $cust_pkg->insert( 'change' => 1,
2525                                 'allow_pkgpart' => $same_pkgpart );
2526   }
2527   if ($error) {
2528     $dbh->rollback if $oldAutoCommit;
2529     return "inserting new package: $error";
2530   }
2531
2532   # Transfer services and cancel old package.
2533   # Enforce service limits only if this is a pkgpart change.
2534   local $FS::cust_svc::ignore_quantity;
2535   $FS::cust_svc::ignore_quantity = 1 if $same_pkgpart;
2536   $error = $self->transfer($cust_pkg);
2537   if ($error and $error == 0) {
2538     # $old_pkg->transfer failed.
2539     $dbh->rollback if $oldAutoCommit;
2540     return "transferring $error";
2541   }
2542
2543   if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2544     warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2545     $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
2546     if ($error and $error == 0) {
2547       # $old_pkg->transfer failed.
2548       $dbh->rollback if $oldAutoCommit;
2549       return "converting $error";
2550     }
2551   }
2552
2553   # We set unprotect_svcs when executing a "future package change".  It's
2554   # not a user-interactive operation, so returning an error means the
2555   # package change will just fail.  Rather than have that happen, we'll
2556   # let leftover services be deleted.
2557   if ($error > 0 and !$opt->{'unprotect_svcs'}) {
2558     # Transfers were successful, but we still had services left on the old
2559     # package.  We can't change the package under this circumstances, so abort.
2560     $dbh->rollback if $oldAutoCommit;
2561     return "unable to transfer all services";
2562   }
2563
2564   #reset usage if changing pkgpart
2565   # AND usage rollover is off (otherwise adds twice, now and at package bill)
2566   if ($self->pkgpart != $cust_pkg->pkgpart) {
2567     my $part_pkg = $cust_pkg->part_pkg;
2568     $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
2569                                                  ? ()
2570                                                  : ( 'null' => 1 )
2571                                    )
2572       if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
2573
2574     if ($error) {
2575       $dbh->rollback if $oldAutoCommit;
2576       return "setting usage values: $error";
2577     }
2578   } else {
2579     # if NOT changing pkgpart, transfer any usage pools over
2580     foreach my $usage ($self->cust_pkg_usage) {
2581       $usage->set('pkgnum', $cust_pkg->pkgnum);
2582       $error = $usage->replace;
2583       if ( $error ) {
2584         $dbh->rollback if $oldAutoCommit;
2585         return "transferring usage pools: $error";
2586       }
2587     }
2588   }
2589
2590   # transfer discounts, if we're not changing pkgpart
2591   if ( $same_pkgpart ) {
2592     foreach my $old_discount ($self->cust_pkg_discount_active) {
2593       # don't remove the old discount, we may still need to bill that package.
2594       my $new_discount = new FS::cust_pkg_discount {
2595         'pkgnum'      => $cust_pkg->pkgnum,
2596         'discountnum' => $old_discount->discountnum,
2597         'months_used' => $old_discount->months_used,
2598       };
2599       $error = $new_discount->insert;
2600       if ( $error ) {
2601         $dbh->rollback if $oldAutoCommit;
2602         return "transferring discounts: $error";
2603       }
2604     }
2605   }
2606
2607   # transfer (copy) invoice details
2608   foreach my $detail ($self->cust_pkg_detail) {
2609     my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
2610     $new_detail->set('pkgdetailnum', '');
2611     $new_detail->set('pkgnum', $cust_pkg->pkgnum);
2612     $error = $new_detail->insert;
2613     if ( $error ) {
2614       $dbh->rollback if $oldAutoCommit;
2615       return "transferring package notes: $error";
2616     }
2617   }
2618
2619   # transfer scheduled expire/adjourn reasons
2620   foreach my $action ('expire', 'adjourn') {
2621     if ( $cust_pkg->get($action) ) {
2622       my $reason = $self->last_cust_pkg_reason($action);
2623       if ( $reason ) {
2624         $reason->set('pkgnum', $cust_pkg->pkgnum);
2625         $error = $reason->replace;
2626         if ( $error ) {
2627           $dbh->rollback if $oldAutoCommit;
2628           return "transferring $action reason: $error";
2629         }
2630       }
2631     }
2632   }
2633
2634   my @new_supp_pkgs;
2635
2636   if ( !$opt->{'cust_pkg'} ) {
2637     # Order any supplemental packages.
2638     my $part_pkg = $cust_pkg->part_pkg;
2639     my @old_supp_pkgs = $self->supplemental_pkgs;
2640     foreach my $link ($part_pkg->supp_part_pkg_link) {
2641       my $old;
2642       foreach (@old_supp_pkgs) {
2643         if ($_->pkgpart == $link->dst_pkgpart) {
2644           $old = $_;
2645           $_->pkgpart(0); # so that it can't match more than once
2646         }
2647         last if $old;
2648       }
2649       # false laziness with FS::cust_main::Packages::order_pkg
2650       my $new = FS::cust_pkg->new({
2651           pkgpart       => $link->dst_pkgpart,
2652           pkglinknum    => $link->pkglinknum,
2653           custnum       => $custnum,
2654           main_pkgnum   => $cust_pkg->pkgnum,
2655           locationnum   => $cust_pkg->locationnum,
2656           start_date    => $cust_pkg->start_date,
2657           order_date    => $cust_pkg->order_date,
2658           expire        => $cust_pkg->expire,
2659           adjourn       => $cust_pkg->adjourn,
2660           contract_end  => $cust_pkg->contract_end,
2661           refnum        => $cust_pkg->refnum,
2662           discountnum   => $cust_pkg->discountnum,
2663           waive_setup   => $cust_pkg->waive_setup,
2664       });
2665       if ( $old and $opt->{'keep_dates'} ) {
2666         foreach (qw(setup bill last_bill)) {
2667           $new->set($_, $old->get($_));
2668         }
2669       }
2670       $error = $new->insert( allow_pkgpart => $same_pkgpart );
2671       # transfer services
2672       if ( $old ) {
2673         $error ||= $old->transfer($new);
2674       }
2675       if ( $error and $error > 0 ) {
2676         # no reason why this should ever fail, but still...
2677         $error = "Unable to transfer all services from supplemental package ".
2678           $old->pkgnum;
2679       }
2680       if ( $error ) {
2681         $dbh->rollback if $oldAutoCommit;
2682         return $error;
2683       }
2684       push @new_supp_pkgs, $new;
2685     }
2686   } # if !$opt->{'cust_pkg'}
2687     # because if there is one, then supplemental packages would already
2688     # have been created for it.
2689
2690   #Good to go, cancel old package.  Notify 'cancel' of whether to credit
2691   #remaining time.
2692   #Don't allow billing the package (preceding period packages and/or
2693   #outstanding usage) if we are keeping dates (i.e. location changing),
2694   #because the new package will be billed for the same date range.
2695   #Supplemental packages are also canceled here.
2696
2697   # during scheduled changes, avoid canceling the package we just
2698   # changed to (duh)
2699   $self->set('change_to_pkgnum' => '');
2700
2701   $error = $self->cancel(
2702     quiet          => 1,
2703     unused_credit  => $unused_credit,
2704     nobill         => $keep_dates,
2705     change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2706     no_delay_cancel => 1,
2707   );
2708   if ($error) {
2709     $dbh->rollback if $oldAutoCommit;
2710     return "canceling old package: $error";
2711   }
2712
2713   # transfer rt_field_charge, if we're not changing pkgpart
2714   # after billing of old package, before billing of new package
2715   if ( $same_pkgpart ) {
2716     foreach my $rt_field_charge ($self->rt_field_charge) {
2717       $rt_field_charge->set('pkgnum', $cust_pkg->pkgnum);
2718       $error = $rt_field_charge->replace;
2719       if ( $error ) {
2720         $dbh->rollback if $oldAutoCommit;
2721         return "transferring rt_field_charge: $error";
2722       }
2723     }
2724   }
2725
2726   if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2727     #$self->cust_main
2728     my $error = $cust_pkg->cust_main->bill(
2729       'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2730     );
2731     if ( $error ) {
2732       $dbh->rollback if $oldAutoCommit;
2733       return "billing new package: $error";
2734     }
2735   }
2736
2737   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2738
2739   $cust_pkg;
2740
2741 }
2742
2743 =item change_later OPTION => VALUE...
2744
2745 Schedule a package change for a later date.  This actually orders the new
2746 package immediately, but sets its start date for a future date, and sets
2747 the current package to expire on the same date.
2748
2749 If the package is already scheduled for a change, this can be called with
2750 'start_date' to change the scheduled date, or with pkgpart and/or
2751 locationnum to modify the package change.  To cancel the scheduled change
2752 entirely, see C<abort_change>.
2753
2754 Options include:
2755
2756 =over 4
2757
2758 =item start_date
2759
2760 The date for the package change.  Required, and must be in the future.
2761
2762 =item pkgpart
2763
2764 =item locationnum
2765
2766 =item quantity
2767
2768 =item discount
2769
2770 Optional hashref that will be passed to $new_pkg->change_discount()
2771
2772 =item contract_end
2773
2774 The pkgpart, locationnum, quantity and optional contract_end of the new
2775 package, with the same meaning as in C<change>.
2776
2777 =back
2778
2779 =cut
2780
2781 sub change_later {
2782   my $self = shift;
2783   my $opt = ref($_[0]) ? shift : { @_ };
2784
2785   # check contract_end, prevent adding/removing
2786   my $error = $self->_check_change($opt);
2787   return $error if $error;
2788
2789   my %discount;
2790   %discount = %{$opt->{discount}} if ref $opt->{discount};
2791
2792   my $oldAutoCommit = $FS::UID::AutoCommit;
2793   local $FS::UID::AutoCommit = 0;
2794   my $dbh = dbh;
2795
2796   my $cust_main = $self->cust_main;
2797
2798   my $date = delete $opt->{'start_date'} or return 'start_date required';
2799
2800   if ( $date <= time ) {
2801     $dbh->rollback if $oldAutoCommit;
2802     return "start_date $date is in the past";
2803   }
2804
2805   # If the user entered a new location, set it up now.
2806   if ( $opt->{'cust_location'} ) {
2807     $error = $opt->{'cust_location'}->find_or_insert;
2808     if ( $error ) {
2809       $dbh->rollback if $oldAutoCommit;
2810       return "creating location record: $error";
2811     }
2812     $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
2813   }
2814
2815   if ( $self->change_to_pkgnum ) {
2816     my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
2817     my $new_pkgpart = $opt->{'pkgpart'}
2818         if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $change_to->pkgpart;
2819     my $new_locationnum = $opt->{'locationnum'}
2820         if $opt->{'locationnum'} and $opt->{'locationnum'} != $change_to->locationnum;
2821     my $new_quantity = $opt->{'quantity'}
2822         if $opt->{'quantity'} and $opt->{'quantity'} != $change_to->quantity;
2823     my $new_contract_end = $opt->{'contract_end'}
2824         if $opt->{'contract_end'} and $opt->{'contract_end'} != $change_to->contract_end;
2825     if ( $new_pkgpart or $new_locationnum or $new_quantity or $new_contract_end ) {
2826       # it hasn't been billed yet, so in principle we could just edit
2827       # it in place (w/o a package change), but that's bad form.
2828       # So change the package according to the new options...
2829       my $err_or_pkg = $change_to->change(%$opt);
2830       if ( ref $err_or_pkg ) {
2831         # Then set that package up for a future start.
2832         $self->set('change_to_pkgnum', $err_or_pkg->pkgnum);
2833         $self->set('expire', $date); # in case it's different
2834         $err_or_pkg->set('start_date', $date);
2835         $err_or_pkg->set('change_date', '');
2836         $err_or_pkg->set('change_pkgnum', '');
2837
2838         $error = $self->replace       ||
2839                  $err_or_pkg->replace ||
2840                  #because change() might've edited existing scheduled change in place
2841                  (($err_or_pkg->pkgnum == $change_to->pkgnum) ? '' :
2842                   $change_to->cancel('no_delay_cancel' => 1) ||
2843                   $change_to->delete);
2844
2845         # Apply user-specified discount to new cust_pkg
2846         $error = $err_or_pkg->change_discount(\%discount)
2847           if !$error && %discount && %discount{discountnum} =~ /^-?\d+$/;
2848       } else {
2849         $error = $err_or_pkg;
2850       }
2851     } else { # change the start date only.
2852       $self->set('expire', $date);
2853       $change_to->set('start_date', $date);
2854       $error = $self->replace || $change_to->replace;
2855
2856       # Apply user-specified discount to new cust_pkg
2857       $error = $change_to->change_discount(\%discount)
2858         if !$error && %discount && %discount{discountnum} =~ /^-?\d+$/;
2859     }
2860     if ( $error ) {
2861       $dbh->rollback if $oldAutoCommit;
2862       return $error;
2863     } else {
2864       $dbh->commit if $oldAutoCommit;
2865       return '';
2866     }
2867   } # if $self->change_to_pkgnum
2868
2869   my $new_pkgpart = $opt->{'pkgpart'}
2870       if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2871   my $new_locationnum = $opt->{'locationnum'}
2872       if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2873   my $new_quantity = $opt->{'quantity'}
2874       if $opt->{'quantity'} and $opt->{'quantity'} != $self->quantity;
2875   my $new_contract_end = $opt->{'contract_end'}
2876       if $opt->{'contract_end'} and $opt->{'contract_end'} != $self->contract_end;
2877
2878   return '' unless $new_pkgpart or $new_locationnum or $new_quantity or $new_contract_end; # wouldn't do anything
2879
2880   # allow $opt->{'locationnum'} = '' to specifically set it to null
2881   # (i.e. customer default location)
2882   $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2883
2884   my $new = FS::cust_pkg->new( {
2885     custnum     => $self->custnum,
2886     locationnum => $opt->{'locationnum'},
2887     start_date  => $date,
2888     map   {  $_ => ( $opt->{$_} || $self->$_() )  }
2889       qw( pkgpart quantity refnum salesnum contract_end )
2890   } );
2891   $error = $new->insert('change' => 1,
2892                         'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2893   if ( !$error ) {
2894     $self->set('change_to_pkgnum', $new->pkgnum);
2895     $self->set('expire', $date);
2896     $error = $self->replace;
2897   }
2898
2899   # Apply user-specified discount to new cust_pkg
2900   $new->change_discount(\%discount)
2901     if !$error && %discount && %discount{discountnum} =~ /^-?\d+$/;
2902
2903   if ( $error ) {
2904     $dbh->rollback if $oldAutoCommit;
2905   } else {
2906     $dbh->commit if $oldAutoCommit;
2907   }
2908
2909   $error;
2910 }
2911
2912 =item abort_change
2913
2914 Cancels a future package change scheduled by C<change_later>.
2915
2916 =cut
2917
2918 sub abort_change {
2919   my $self = shift;
2920   my $pkgnum = $self->change_to_pkgnum;
2921   my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
2922   my $error;
2923   if ( $change_to ) {
2924     $error = $change_to->cancel || $change_to->delete;
2925     return $error if $error;
2926   }
2927   $self->set('change_to_pkgnum', '');
2928   $self->set('expire', '');
2929   $self->replace;
2930 }
2931
2932 =item set_quantity QUANTITY
2933
2934 Change the package's quantity field.  This is one of the few package properties
2935 that can safely be changed without canceling and reordering the package
2936 (because it doesn't affect tax eligibility).  Returns an error or an
2937 empty string.
2938
2939 =cut
2940
2941 sub set_quantity {
2942   my $self = shift;
2943   $self = $self->replace_old; # just to make sure
2944   $self->quantity(shift);
2945   $self->replace;
2946 }
2947
2948 =item set_salesnum SALESNUM
2949
2950 Change the package's salesnum (sales person) field.  This is one of the few
2951 package properties that can safely be changed without canceling and reordering
2952 the package (because it doesn't affect tax eligibility).  Returns an error or
2953 an empty string.
2954
2955 =cut
2956
2957 sub set_salesnum {
2958   my $self = shift;
2959   $self = $self->replace_old; # just to make sure
2960   $self->salesnum(shift);
2961   $self->replace;
2962   # XXX this should probably reassign any credit that's already been given
2963 }
2964
2965 =item modify_charge OPTIONS
2966
2967 Change the properties of a one-time charge.  The following properties can
2968 be changed this way:
2969 - pkg: the package description
2970 - classnum: the package class
2971 - additional: arrayref of additional invoice details to add to this package
2972
2973 and, I<if the charge has not yet been billed>:
2974 - start_date: the date when it will be billed
2975 - amount: the setup fee to be charged
2976 - quantity: the multiplier for the setup fee
2977 - separate_bill: whether to put the charge on a separate invoice
2978
2979 If you pass 'adjust_commission' => 1, and the classnum changes, and there are
2980 commission credits linked to this charge, they will be recalculated.
2981
2982 =cut
2983
2984 sub modify_charge {
2985   my $self = shift;
2986   my %opt = @_;
2987   my $part_pkg = $self->part_pkg;
2988   my $pkgnum = $self->pkgnum;
2989
2990   my $dbh = dbh;
2991   my $oldAutoCommit = $FS::UID::AutoCommit;
2992   local $FS::UID::AutoCommit = 0;
2993
2994   return "Can't use modify_charge except on one-time charges"
2995     unless $part_pkg->freq eq '0';
2996
2997   if ( length($opt{'pkg'}) and $part_pkg->pkg ne $opt{'pkg'} ) {
2998     $part_pkg->set('pkg', $opt{'pkg'});
2999   }
3000
3001   my %pkg_opt = $part_pkg->options;
3002   my $pkg_opt_modified = 0;
3003
3004   $opt{'additional'} ||= [];
3005   my $i;
3006   my @old_additional;
3007   foreach (grep /^additional/, keys %pkg_opt) {
3008     ($i) = ($_ =~ /^additional_info(\d+)$/);
3009     $old_additional[$i] = $pkg_opt{$_} if $i;
3010     delete $pkg_opt{$_};
3011   }
3012
3013   for ( $i = 0; exists($opt{'additional'}->[$i]); $i++ ) {
3014     $pkg_opt{ "additional_info$i" } = $opt{'additional'}->[$i];
3015     if (!exists($old_additional[$i])
3016         or $old_additional[$i] ne $opt{'additional'}->[$i])
3017     {
3018       $pkg_opt_modified = 1;
3019     }
3020   }
3021   $pkg_opt_modified = 1 if scalar(@old_additional) != $i;
3022   $pkg_opt{'additional_count'} = $i if $i > 0;
3023
3024   my $old_classnum;
3025   if ( exists($opt{'classnum'}) and $part_pkg->classnum ne $opt{'classnum'} )
3026   {
3027     # remember it
3028     $old_classnum = $part_pkg->classnum;
3029     $part_pkg->set('classnum', $opt{'classnum'});
3030   }
3031
3032   if ( !$self->get('setup') ) {
3033     # not yet billed, so allow amount, setup_cost, quantity, start_date,
3034     # and separate_bill
3035
3036     if ( exists($opt{'amount'})
3037           and $part_pkg->option('setup_fee') != $opt{'amount'}
3038           and $opt{'amount'} > 0 ) {
3039
3040       $pkg_opt{'setup_fee'} = $opt{'amount'};
3041       $pkg_opt_modified = 1;
3042     }
3043
3044     if ( exists($opt{'setup_cost'})
3045           and $part_pkg->setup_cost != $opt{'setup_cost'}
3046           and $opt{'setup_cost'} > 0 ) {
3047
3048       $part_pkg->set('setup_cost', $opt{'setup_cost'});
3049     }
3050
3051     if ( exists($opt{'quantity'})
3052           and $opt{'quantity'} != $self->quantity
3053           and $opt{'quantity'} > 0 ) {
3054
3055       $self->set('quantity', $opt{'quantity'});
3056     }
3057
3058     if ( exists($opt{'start_date'})
3059           and $opt{'start_date'} != $self->start_date ) {
3060
3061       $self->set('start_date', $opt{'start_date'});
3062     }
3063
3064     if ( exists($opt{'separate_bill'})
3065           and $opt{'separate_bill'} ne $self->separate_bill ) {
3066
3067       $self->set('separate_bill', $opt{'separate_bill'});
3068     }
3069
3070
3071   } # else simply ignore them; the UI shouldn't allow editing the fields
3072
3073   if ( exists($opt{'taxclass'})
3074           and $part_pkg->taxclass ne $opt{'taxclass'}) {
3075
3076       $part_pkg->set('taxclass', $opt{'taxclass'});
3077   }
3078
3079   my $error;
3080   if ( $part_pkg->modified or $pkg_opt_modified ) {
3081     # can we safely modify the package def?
3082     # Yes, if it's not available for purchase, and this is the only instance
3083     # of it.
3084     if ( $part_pkg->disabled
3085          and FS::cust_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 1
3086          and FS::quotation_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 0
3087        ) {
3088       $error = $part_pkg->replace( options => \%pkg_opt );
3089     } else {
3090       # clone it
3091       $part_pkg = $part_pkg->clone;
3092       $part_pkg->set('disabled' => 'Y');
3093       $error = $part_pkg->insert( options => \%pkg_opt );
3094       # and associate this as yet-unbilled package to the new package def
3095       $self->set('pkgpart' => $part_pkg->pkgpart);
3096     }
3097     if ( $error ) {
3098       $dbh->rollback if $oldAutoCommit;
3099       return $error;
3100     }
3101   }
3102
3103   if ($self->modified) { # for quantity or start_date change, or if we had
3104                          # to clone the existing package def
3105     my $error = $self->replace;
3106     return $error if $error;
3107   }
3108   if (defined $old_classnum) {
3109     # fix invoice grouping records
3110     my $old_catname = $old_classnum
3111                       ? FS::pkg_class->by_key($old_classnum)->categoryname
3112                       : '';
3113     my $new_catname = $opt{'classnum'}
3114                       ? $part_pkg->pkg_class->categoryname
3115                       : '';
3116     if ( $old_catname ne $new_catname ) {
3117       foreach my $cust_bill_pkg ($self->cust_bill_pkg) {
3118         # (there should only be one...)
3119         my @display = qsearch( 'cust_bill_pkg_display', {
3120             'billpkgnum'  => $cust_bill_pkg->billpkgnum,
3121             'section'     => $old_catname,
3122         });
3123         foreach (@display) {
3124           $_->set('section', $new_catname);
3125           $error = $_->replace;
3126           if ( $error ) {
3127             $dbh->rollback if $oldAutoCommit;
3128             return $error;
3129           }
3130         }
3131       } # foreach $cust_bill_pkg
3132     }
3133
3134     if ( $opt{'adjust_commission'} ) {
3135       # fix commission credits...tricky.
3136       foreach my $cust_event ($self->cust_event) {
3137         my $part_event = $cust_event->part_event;
3138         foreach my $table (qw(sales agent)) {
3139           my $class =
3140             "FS::part_event::Action::Mixin::credit_${table}_pkg_class";
3141           my $credit = qsearchs('cust_credit', {
3142               'eventnum' => $cust_event->eventnum,
3143           });
3144           if ( $part_event->isa($class) ) {
3145             # Yes, this results in current commission rates being applied
3146             # retroactively to a one-time charge.  For accounting purposes
3147             # there ought to be some kind of time limit on doing this.
3148             my $amount = $part_event->_calc_credit($self);
3149             if ( $credit and $credit->amount ne $amount ) {
3150               # Void the old credit.
3151               $error = $credit->void('Package class changed');
3152               if ( $error ) {
3153                 $dbh->rollback if $oldAutoCommit;
3154                 return "$error (adjusting commission credit)";
3155               }
3156             }
3157             # redo the event action to recreate the credit.
3158             local $@ = '';
3159             eval { $part_event->do_action( $self, $cust_event ) };
3160             if ( $@ ) {
3161               $dbh->rollback if $oldAutoCommit;
3162               return $@;
3163             }
3164           } # if $part_event->isa($class)
3165         } # foreach $table
3166       } # foreach $cust_event
3167     } # if $opt{'adjust_commission'}
3168   } # if defined $old_classnum
3169
3170   $dbh->commit if $oldAutoCommit;
3171   '';
3172 }
3173
3174 use Storable 'thaw';
3175 use MIME::Base64;
3176 use Data::Dumper;
3177 sub process_bulk_cust_pkg {
3178   my $job = shift;
3179   my $param = thaw(decode_base64(shift));
3180   warn Dumper($param) if $DEBUG;
3181
3182   my $old_part_pkg = qsearchs('part_pkg',
3183                               { pkgpart => $param->{'old_pkgpart'} });
3184   my $new_part_pkg = qsearchs('part_pkg',
3185                               { pkgpart => $param->{'new_pkgpart'} });
3186   die "Must select a new package type\n" unless $new_part_pkg;
3187   #my $keep_dates = $param->{'keep_dates'} || 0;
3188   my $keep_dates = 1; # there is no good reason to turn this off
3189
3190   local $SIG{HUP} = 'IGNORE';
3191   local $SIG{INT} = 'IGNORE';
3192   local $SIG{QUIT} = 'IGNORE';
3193   local $SIG{TERM} = 'IGNORE';
3194   local $SIG{TSTP} = 'IGNORE';
3195   local $SIG{PIPE} = 'IGNORE';
3196
3197   my $oldAutoCommit = $FS::UID::AutoCommit;
3198   local $FS::UID::AutoCommit = 0;
3199   my $dbh = dbh;
3200
3201   my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
3202
3203   my $i = 0;
3204   foreach my $old_cust_pkg ( @cust_pkgs ) {
3205     $i++;
3206     $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
3207     if ( $old_cust_pkg->getfield('cancel') ) {
3208       warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
3209         $old_cust_pkg->pkgnum."\n"
3210         if $DEBUG;
3211       next;
3212     }
3213     warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
3214       if $DEBUG;
3215     my $error = $old_cust_pkg->change(
3216       'pkgpart'     => $param->{'new_pkgpart'},
3217       'keep_dates'  => $keep_dates
3218     );
3219     if ( !ref($error) ) { # change returns the cust_pkg on success
3220       $dbh->rollback;
3221       die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
3222     }
3223   }
3224   $dbh->commit if $oldAutoCommit;
3225   return;
3226 }
3227
3228 =item last_bill
3229
3230 Returns the last bill date, or if there is no last bill date, the setup date.
3231 Useful for billing metered services.
3232
3233 =cut
3234
3235 sub last_bill {
3236   my $self = shift;
3237   return $self->setfield('last_bill', $_[0]) if @_;
3238   return $self->getfield('last_bill') if $self->getfield('last_bill');
3239   my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
3240                                                   'edate'  => $self->bill,  } );
3241   $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
3242 }
3243
3244 =item last_cust_pkg_reason ACTION
3245
3246 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
3247 Returns false if there is no reason or the package is not currenly ACTION'd
3248 ACTION is one of adjourn, susp, cancel, or expire.
3249
3250 =cut
3251
3252 sub last_cust_pkg_reason {
3253   my ( $self, $action ) = ( shift, shift );
3254   my $date = $self->get($action);
3255   qsearchs( {
3256               'table' => 'cust_pkg_reason',
3257               'hashref' => { 'pkgnum' => $self->pkgnum,
3258                              'action' => substr(uc($action), 0, 1),
3259                              'date'   => $date,
3260                            },
3261               'order_by' => 'ORDER BY num DESC LIMIT 1',
3262            } );
3263 }
3264
3265 =item last_reason ACTION
3266
3267 Returns the most recent ACTION FS::reason associated with the package.
3268 Returns false if there is no reason or the package is not currenly ACTION'd
3269 ACTION is one of adjourn, susp, cancel, or expire.
3270
3271 =cut
3272
3273 sub last_reason {
3274   my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
3275   $cust_pkg_reason->reason
3276     if $cust_pkg_reason;
3277 }
3278
3279 =item part_pkg
3280
3281 Returns the definition for this billing item, as an FS::part_pkg object (see
3282 L<FS::part_pkg>).
3283
3284 =cut
3285
3286 sub part_pkg {
3287   my $self = shift;
3288   return $self->{'_pkgpart'} if $self->{'_pkgpart'};
3289   cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
3290   qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
3291 }
3292
3293 =item old_cust_pkg
3294
3295 Returns the cancelled package this package was changed from, if any.
3296
3297 =cut
3298
3299 sub old_cust_pkg {
3300   my $self = shift;
3301   return '' unless $self->change_pkgnum;
3302   qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
3303 }
3304
3305 =item change_cust_main
3306
3307 Returns the customter this package was detached to, if any.
3308
3309 =cut
3310
3311 sub change_cust_main {
3312   my $self = shift;
3313   return '' unless $self->change_custnum;
3314   qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
3315 }
3316
3317 =item calc_setup
3318
3319 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
3320 item.
3321
3322 =cut
3323
3324 sub calc_setup {
3325   my $self = shift;
3326   $self->part_pkg->calc_setup($self, @_);
3327 }
3328
3329 =item calc_recur
3330
3331 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
3332 item.
3333
3334 =cut
3335
3336 sub calc_recur {
3337   my $self = shift;
3338   $self->part_pkg->calc_recur($self, @_);
3339 }
3340
3341 =item base_setup
3342
3343 Returns the base setup fee (per unit) of this package, from the package
3344 definition.
3345
3346 =cut
3347
3348 # minimal version for 3.x; in 4.x this can invoke currency conversion
3349
3350 sub base_setup {
3351   my $self = shift;
3352   $self->part_pkg->unit_setup($self);
3353 }
3354
3355 =item base_recur
3356
3357 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
3358 item.
3359
3360 =cut
3361
3362 sub base_recur {
3363   my $self = shift;
3364   $self->part_pkg->base_recur($self, @_);
3365 }
3366
3367 =item calc_remain
3368
3369 Calls the I<calc_remain> of the FS::part_pkg object associated with this
3370 billing item.
3371
3372 =cut
3373
3374 sub calc_remain {
3375   my $self = shift;
3376   $self->part_pkg->calc_remain($self, @_);
3377 }
3378
3379 =item calc_cancel
3380
3381 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
3382 billing item.
3383
3384 =cut
3385
3386 sub calc_cancel {
3387   my $self = shift;
3388   $self->part_pkg->calc_cancel($self, @_);
3389 }
3390
3391 =item cust_bill_pkg
3392
3393 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
3394
3395 =cut
3396
3397 sub cust_bill_pkg {
3398   my $self = shift;
3399   qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
3400 }
3401
3402 =item cust_pkg_detail [ DETAILTYPE ]
3403
3404 Returns any customer package details for this package (see
3405 L<FS::cust_pkg_detail>).
3406
3407 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
3408
3409 =cut
3410
3411 sub cust_pkg_detail {
3412   my $self = shift;
3413   my %hash = ( 'pkgnum' => $self->pkgnum );
3414   $hash{detailtype} = shift if @_;
3415   qsearch({
3416     'table'    => 'cust_pkg_detail',
3417     'hashref'  => \%hash,
3418     'order_by' => 'ORDER BY weight, pkgdetailnum',
3419   });
3420 }
3421
3422 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
3423
3424 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
3425
3426 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
3427
3428 If there is an error, returns the error, otherwise returns false.
3429
3430 =cut
3431
3432 sub set_cust_pkg_detail {
3433   my( $self, $detailtype, @details ) = @_;
3434
3435   local $SIG{HUP} = 'IGNORE';
3436   local $SIG{INT} = 'IGNORE';
3437   local $SIG{QUIT} = 'IGNORE';
3438   local $SIG{TERM} = 'IGNORE';
3439   local $SIG{TSTP} = 'IGNORE';
3440   local $SIG{PIPE} = 'IGNORE';
3441
3442   my $oldAutoCommit = $FS::UID::AutoCommit;
3443   local $FS::UID::AutoCommit = 0;
3444   my $dbh = dbh;
3445
3446   foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
3447     my $error = $current->delete;
3448     if ( $error ) {
3449       $dbh->rollback if $oldAutoCommit;
3450       return "error removing old detail: $error";
3451     }
3452   }
3453
3454   foreach my $detail ( @details ) {
3455     my $cust_pkg_detail = new FS::cust_pkg_detail {
3456       'pkgnum'     => $self->pkgnum,
3457       'detailtype' => $detailtype,
3458       'detail'     => $detail,
3459     };
3460     my $error = $cust_pkg_detail->insert;
3461     if ( $error ) {
3462       $dbh->rollback if $oldAutoCommit;
3463       return "error adding new detail: $error";
3464     }
3465
3466   }
3467
3468   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3469   '';
3470
3471 }
3472
3473 =item cust_event
3474
3475 Returns the customer billing events (see L<FS::cust_event>) for this invoice.
3476
3477 =cut
3478
3479 #false laziness w/cust_bill.pm
3480 sub cust_event {
3481   my $self = shift;
3482   qsearch({
3483     'table'     => 'cust_event',
3484     'addl_from' => 'JOIN part_event USING ( eventpart )',
3485     'hashref'   => { 'tablenum' => $self->pkgnum },
3486     'extra_sql' => " AND eventtable = 'cust_pkg' ",
3487   });
3488 }
3489
3490 =item num_cust_event
3491
3492 Returns the number of customer billing events (see L<FS::cust_event>) for this package.
3493
3494 =cut
3495
3496 #false laziness w/cust_bill.pm
3497 sub num_cust_event {
3498   my $self = shift;
3499   my $sql = "SELECT COUNT(*) ". $self->_from_cust_event_where;
3500   $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref->[0];
3501 }
3502
3503 =item exists_cust_event
3504
3505 Returns true if there are customer billing events (see L<FS::cust_event>) for this package.  More efficient than using num_cust_event.
3506
3507 =cut
3508
3509 sub exists_cust_event {
3510   my $self = shift;
3511   my $sql = "SELECT 1 ". $self->_from_cust_event_where. " LIMIT 1";
3512   my $row = $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref;
3513   $row ? $row->[0] : '';
3514 }
3515
3516 sub _from_cust_event_where {
3517   #my $self = shift;
3518   " FROM cust_event JOIN part_event USING ( eventpart ) ".
3519   "  WHERE tablenum = ? AND eventtable = 'cust_pkg' ";
3520 }
3521
3522 sub _prep_ex {
3523   my( $self, $sql, @args ) = @_;
3524   my $sth = dbh->prepare($sql) or die  dbh->errstr. " preparing $sql";
3525   $sth->execute(@args)         or die $sth->errstr. " executing $sql";
3526   $sth;
3527 }
3528
3529 =item cust_svc [ SVCPART ] (old, deprecated usage)
3530
3531 =item cust_svc [ OPTION => VALUE ... ] (current usage)
3532
3533 =item cust_svc_unsorted [ OPTION => VALUE ... ]
3534
3535 Returns the services for this package, as FS::cust_svc objects (see
3536 L<FS::cust_svc>).  Available options are svcpart and svcdb.  If either is
3537 spcififed, returns only the matching services.
3538
3539 As an optimization, use the cust_svc_unsorted version if you are not displaying
3540 the results.
3541
3542 =cut
3543
3544 sub cust_svc {
3545   my $self = shift;
3546   cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
3547   $self->_sort_cust_svc( $self->cust_svc_unsorted_arrayref(@_) );
3548 }
3549
3550 sub cust_svc_unsorted {
3551   my $self = shift;
3552   @{ $self->cust_svc_unsorted_arrayref(@_) };
3553 }
3554
3555 sub cust_svc_unsorted_arrayref {
3556   my $self = shift;
3557
3558   return [] unless $self->num_cust_svc(@_);
3559
3560   my %opt = ();
3561   if ( @_ && $_[0] =~ /^\d+/ ) {
3562     $opt{svcpart} = shift;
3563   } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3564     %opt = %{ $_[0] };
3565   } elsif ( @_ ) {
3566     %opt = @_;
3567   }
3568
3569   my %search = (
3570     'select'    => 'cust_svc.*, part_svc.*',
3571     'table'     => 'cust_svc',
3572     'hashref'   => { 'pkgnum' => $self->pkgnum },
3573     'addl_from' => 'LEFT JOIN part_svc USING ( svcpart )',
3574   );
3575   $search{hashref}->{svcpart} = $opt{svcpart}
3576     if $opt{svcpart};
3577   $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{svcdb} )
3578     if $opt{svcdb};
3579
3580   [ qsearch(\%search) ];
3581
3582 }
3583
3584 =item overlimit [ SVCPART ]
3585
3586 Returns the services for this package which have exceeded their
3587 usage limit as FS::cust_svc objects (see L<FS::cust_svc>).  If a svcpart
3588 is specified, return only the matching services.
3589
3590 =cut
3591
3592 sub overlimit {
3593   my $self = shift;
3594   return () unless $self->num_cust_svc(@_);
3595   grep { $_->overlimit } $self->cust_svc(@_);
3596 }
3597
3598 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3599
3600 Returns historical services for this package created before END TIMESTAMP and
3601 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
3602 (see L<FS::h_cust_svc>).  If MODE is 'I' (for 'invoice'), services with the
3603 I<pkg_svc.hidden> flag will be omitted.
3604
3605 =cut
3606
3607 sub h_cust_svc {
3608   my $self = shift;
3609   warn "$me _h_cust_svc called on $self\n"
3610     if $DEBUG;
3611
3612   my ($end, $start, $mode) = @_;
3613   my @cust_svc = $self->_sort_cust_svc(
3614     [ qsearch( 'h_cust_svc',
3615       { 'pkgnum' => $self->pkgnum, },
3616       FS::h_cust_svc->sql_h_search(@_),
3617     ) ]
3618   );
3619   if ( defined($mode) && $mode eq 'I' ) {
3620     my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
3621     return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
3622   } else {
3623     return @cust_svc;
3624   }
3625 }
3626
3627 sub _sort_cust_svc {
3628   my( $self, $arrayref ) = @_;
3629
3630   my $sort =
3631     sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1]  or  $a->[2] <=> $b->[2] };
3632
3633   my %pkg_svc = map { $_->svcpart => $_ }
3634                 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
3635
3636   map  { $_->[0] }
3637   sort $sort
3638   map {
3639         my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
3640         [ $_,
3641           $pkg_svc ? $pkg_svc->primary_svc : '',
3642           $pkg_svc ? $pkg_svc->quantity : 0,
3643         ];
3644       }
3645   @$arrayref;
3646
3647 }
3648
3649 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
3650
3651 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
3652
3653 Returns the number of services for this package.  Available options are svcpart
3654 and svcdb.  If either is spcififed, returns only the matching services.
3655
3656 =cut
3657
3658 sub num_cust_svc {
3659   my $self = shift;
3660
3661   return $self->{'_num_cust_svc'}
3662     if !scalar(@_)
3663        && exists($self->{'_num_cust_svc'})
3664        && $self->{'_num_cust_svc'} =~ /\d/;
3665
3666   cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
3667     if $DEBUG > 2;
3668
3669   my %opt = ();
3670   if ( @_ && $_[0] =~ /^\d+/ ) {
3671     $opt{svcpart} = shift;
3672   } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3673     %opt = %{ $_[0] };
3674   } elsif ( @_ ) {
3675     %opt = @_;
3676   }
3677
3678   my $select = 'SELECT COUNT(*) FROM cust_svc ';
3679   my $where = ' WHERE pkgnum = ? ';
3680   my @param = ($self->pkgnum);
3681
3682   if ( $opt{'svcpart'} ) {
3683     $where .= ' AND svcpart = ? ';
3684     push @param, $opt{'svcpart'};
3685   }
3686   if ( $opt{'svcdb'} ) {
3687     $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
3688     $where .= ' AND svcdb = ? ';
3689     push @param, $opt{'svcdb'};
3690   }
3691
3692   my $sth = dbh->prepare("$select $where") or die  dbh->errstr;
3693   $sth->execute(@param) or die $sth->errstr;
3694   $sth->fetchrow_arrayref->[0];
3695 }
3696
3697 =item available_part_svc
3698
3699 Returns a list of FS::part_svc objects representing services included in this
3700 package but not yet provisioned.  Each FS::part_svc object also has an extra
3701 field, I<num_avail>, which specifies the number of available services.
3702
3703 Accepts option I<provision_hold>;  if true, only returns part_svc for which the
3704 associated pkg_svc has the provision_hold flag set.
3705
3706 =cut
3707
3708 sub available_part_svc {
3709   my $self = shift;
3710   my %opt  = @_;
3711
3712   my $pkg_quantity = $self->quantity || 1;
3713
3714   grep { $_->num_avail > 0 }
3715   map {
3716     my $part_svc = $_->part_svc;
3717     $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
3718     $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
3719
3720     # more evil encapsulation breakage
3721     if ($part_svc->{'Hash'}{'num_avail'} > 0) {
3722       my @exports = $part_svc->part_export_did;
3723       $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
3724         }
3725
3726     $part_svc;
3727   }
3728   grep { $opt{'provision_hold'} ? $_->provision_hold : 1 }
3729   $self->part_pkg->pkg_svc;
3730 }
3731
3732 =item part_svc [ OPTION => VALUE ... ]
3733
3734 Returns a list of FS::part_svc objects representing provisioned and available
3735 services included in this package.  Each FS::part_svc object also has the
3736 following extra fields:
3737
3738 =over 4
3739
3740 =item num_cust_svc
3741
3742 (count)
3743
3744 =item num_avail
3745
3746 (quantity - count)
3747
3748 =item cust_pkg_svc
3749
3750 (services) - array reference containing the provisioned services, as cust_svc objects
3751
3752 =back
3753
3754 Accepts two options:
3755
3756 =over 4
3757
3758 =item summarize_size
3759
3760 If true, will omit the extra cust_pkg_svc option for objects where num_cust_svc
3761 is this size or greater.
3762
3763 =item hide_discontinued
3764
3765 If true, will omit looking for services that are no longer avaialble in the
3766 package definition.
3767
3768 =back
3769
3770 =cut
3771
3772 #svcnum
3773 #label -> ($cust_svc->label)[1]
3774
3775 sub part_svc {
3776   my $self = shift;
3777   my %opt = @_;
3778
3779   my $pkg_quantity = $self->quantity || 1;
3780
3781   #XXX some sort of sort order besides numeric by svcpart...
3782   my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
3783     my $pkg_svc = $_;
3784     my $part_svc = $pkg_svc->part_svc;
3785     my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3786     $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
3787     $part_svc->{'Hash'}{'num_avail'}    =
3788       max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
3789     $part_svc->{'Hash'}{'cust_pkg_svc'} =
3790         $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
3791       unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
3792           && $num_cust_svc >= $opt{summarize_size};
3793     $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
3794     $part_svc;
3795   } $self->part_pkg->pkg_svc;
3796
3797   unless ( $opt{hide_discontinued} ) {
3798     #extras
3799     push @part_svc, map {
3800       my $part_svc = $_;
3801       my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3802       $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
3803       $part_svc->{'Hash'}{'num_avail'}    = 0; #0-$num_cust_svc ?
3804       $part_svc->{'Hash'}{'cust_pkg_svc'} =
3805         $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
3806       $part_svc;
3807     } $self->extra_part_svc;
3808   }
3809
3810   @part_svc;
3811
3812 }
3813
3814 =item extra_part_svc
3815
3816 Returns a list of FS::part_svc objects corresponding to services in this
3817 package which are still provisioned but not (any longer) available in the
3818 package definition.
3819
3820 =cut
3821
3822 sub extra_part_svc {
3823   my $self = shift;
3824
3825   my $pkgnum  = $self->pkgnum;
3826   #my $pkgpart = $self->pkgpart;
3827
3828 #  qsearch( {
3829 #    'table'     => 'part_svc',
3830 #    'hashref'   => {},
3831 #    'extra_sql' =>
3832 #      "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
3833 #                     WHERE pkg_svc.svcpart = part_svc.svcpart
3834 #                       AND pkg_svc.pkgpart = ?
3835 #                       AND quantity > 0
3836 #                 )
3837 #        AND 0 < ( SELECT COUNT(*) FROM cust_svc
3838 #                       LEFT JOIN cust_pkg USING ( pkgnum )
3839 #                     WHERE cust_svc.svcpart = part_svc.svcpart
3840 #                       AND pkgnum = ?
3841 #                 )",
3842 #    'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
3843 #  } );
3844
3845 #seems to benchmark slightly faster... (or did?)
3846
3847   my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
3848   my $pkgparts = join(',', @pkgparts);
3849
3850   qsearch( {
3851     #'select'      => 'DISTINCT ON (svcpart) part_svc.*',
3852     #MySQL doesn't grok DISINCT ON
3853     'select'      => 'DISTINCT part_svc.*',
3854     'table'       => 'part_svc',
3855     'addl_from'   =>
3856       "LEFT JOIN pkg_svc  ON (     pkg_svc.svcpart   = part_svc.svcpart
3857                                AND pkg_svc.pkgpart IN ($pkgparts)
3858                                AND quantity > 0
3859                              )
3860        LEFT JOIN cust_svc ON (     cust_svc.svcpart = part_svc.svcpart )
3861        LEFT JOIN cust_pkg USING ( pkgnum )
3862       ",
3863     'hashref'     => {},
3864     'extra_sql'   => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
3865     'extra_param' => [ [$self->pkgnum=>'int'] ],
3866   } );
3867 }
3868
3869 =item status
3870
3871 Returns a short status string for this package, currently:
3872
3873 =over 4
3874
3875 =item on hold
3876
3877 =item not yet billed
3878
3879 =item one-time charge
3880
3881 =item active
3882
3883 =item suspended
3884
3885 =item cancelled
3886
3887 =back
3888
3889 =cut
3890
3891 sub status {
3892   my $self = shift;
3893
3894   my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
3895
3896   return 'cancelled' if $self->get('cancel');
3897   return 'on hold' if $self->susp && ! $self->setup;
3898   return 'suspended' if $self->susp;
3899   return 'not yet billed' unless $self->setup;
3900   return 'one-time charge' if $freq =~ /^(0|$)/;
3901   return 'active';
3902 }
3903
3904 =item ucfirst_status
3905
3906 Returns the status with the first character capitalized.
3907
3908 =cut
3909
3910 sub ucfirst_status {
3911   ucfirst(shift->status);
3912 }
3913
3914 =item statuses
3915
3916 Class method that returns the list of possible status strings for packages
3917 (see L<the status method|/status>).  For example:
3918
3919   @statuses = FS::cust_pkg->statuses();
3920
3921 =cut
3922
3923 tie my %statuscolor, 'Tie::IxHash',
3924   'on hold'         => 'FF00F5', #brighter purple!
3925   'not yet billed'  => '009999', #teal? cyan?
3926   'one-time charge' => '0000CC', #blue  #'000000',
3927   'active'          => '00CC00',
3928   'suspended'       => 'FF9900',
3929   'cancelled'       => 'FF0000',
3930 ;
3931
3932 sub statuses {
3933   my $self = shift; #could be class...
3934   #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
3935   #                                    # mayble split btw one-time vs. recur
3936     keys %statuscolor;
3937 }
3938
3939 sub statuscolors {
3940   #my $self = shift;
3941   \%statuscolor;
3942 }
3943
3944 =item statuscolor
3945
3946 Returns a hex triplet color string for this package's status.
3947
3948 =cut
3949
3950 sub statuscolor {
3951   my $self = shift;
3952   $statuscolor{$self->status};
3953 }
3954
3955 =item is_status_delay_cancel
3956
3957 Returns true if part_pkg has option delay_cancel,
3958 cust_pkg status is 'suspended' and expire is set
3959 to cancel package within the next day (or however
3960 many days are set in global config part_pkg-delay_cancel-days.
3961
3962 Accepts option I<part_pkg-delay_cancel-days> which should be
3963 the value of the config setting, to avoid looking it up again.
3964
3965 This is not a real status, this only meant for hacking display
3966 values, because otherwise treating the package as suspended is
3967 really the whole point of the delay_cancel option.
3968
3969 =cut
3970
3971 sub is_status_delay_cancel {
3972   my ($self,%opt) = @_;
3973   if ( $self->main_pkgnum and $self->pkglinknum ) {
3974     return $self->main_pkg->is_status_delay_cancel;
3975   }
3976   return 0 unless $self->part_pkg->option('delay_cancel',1);
3977   return 0 unless $self->status eq 'suspended';
3978   return 0 unless $self->expire;
3979   my $expdays = $opt{'part_pkg-delay_cancel-days'};
3980   unless ($expdays) {
3981     my $conf = new FS::Conf;
3982     $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
3983   }
3984   my $expsecs = 60*60*24*$expdays;
3985   return 0 unless $self->expire < time + $expsecs;
3986   return 1;
3987 }
3988
3989 =item pkg_label
3990
3991 Returns a label for this package.  (Currently "pkgnum: pkg - comment" or
3992 "pkg - comment" depending on user preference).
3993
3994 =cut
3995
3996 sub pkg_label {
3997   my $self = shift;
3998   my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
3999   $label = $self->pkgnum. ": $label"
4000     if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
4001   $label;
4002 }
4003
4004 =item pkg_label_long
4005
4006 Returns a long label for this package, adding the primary service's label to
4007 pkg_label.
4008
4009 =cut
4010
4011 sub pkg_label_long {
4012   my $self = shift;
4013   my $label = $self->pkg_label;
4014   my $cust_svc = $self->primary_cust_svc;
4015   $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
4016   $label;
4017 }
4018
4019 =item pkg_locale
4020
4021 Returns a customer-localized label for this package.
4022
4023 =cut
4024
4025 sub pkg_locale {
4026   my $self = shift;
4027   $self->part_pkg->pkg_locale( $self->cust_main->locale );
4028 }
4029
4030 =item primary_cust_svc
4031
4032 Returns a primary service (as FS::cust_svc object) if one can be identified.
4033
4034 =cut
4035
4036 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
4037
4038 sub primary_cust_svc {
4039   my $self = shift;
4040
4041   my @cust_svc = $self->cust_svc;
4042
4043   return '' unless @cust_svc; #no serivces - irrelevant then
4044
4045   return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
4046
4047   # primary service as specified in the package definition
4048   # or exactly one service definition with quantity one
4049   my $svcpart = $self->part_pkg->svcpart;
4050   @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
4051   return $cust_svc[0] if scalar(@cust_svc) == 1;
4052
4053   #couldn't identify one thing..
4054   return '';
4055 }
4056
4057 =item labels
4058
4059 Returns a list of lists, calling the label method for all services
4060 (see L<FS::cust_svc>) of this billing item.
4061
4062 =cut
4063
4064 sub labels {
4065   my $self = shift;
4066   map { [ $_->label ] } $self->cust_svc;
4067 }
4068
4069 =item h_labels END_TIMESTAMP [, START_TIMESTAMP [, MODE [, LOCALE ] ] ]
4070
4071 Like the labels method, but returns historical information on services that
4072 were active as of END_TIMESTAMP and (optionally) not cancelled before
4073 START_TIMESTAMP.  If MODE is 'I' (for 'invoice'), services with the
4074 I<pkg_svc.hidden> flag will be omitted.
4075
4076 If LOCALE is passed, service definition names will be localized.
4077
4078 Returns a list of lists, calling the label method for all (historical)
4079 services (see L<FS::h_cust_svc>) of this billing item.
4080
4081 =cut
4082
4083 sub h_labels {
4084   my $self = shift;
4085   my ($end, $start, $mode, $locale) = @_;
4086   warn "$me h_labels\n"
4087     if $DEBUG;
4088   map { [ $_->label($end, $start, $locale) ] }
4089         $self->h_cust_svc($end, $start, $mode);
4090 }
4091
4092 =item labels_short
4093
4094 Like labels, except returns a simple flat list, and shortens long
4095 (currently >5 or the cust_bill-max_same_services configuration value) lists of
4096 identical services to one line that lists the service label and the number of
4097 individual services rather than individual items.
4098
4099 =cut
4100
4101 sub labels_short {
4102   shift->_labels_short( 'labels' ); # 'labels' takes no further arguments
4103 }
4104
4105 =item h_labels_short END_TIMESTAMP [, START_TIMESTAMP [, MODE [, LOCALE ] ] ]
4106
4107 Like h_labels, except returns a simple flat list, and shortens long
4108 (currently >5 or the cust_bill-max_same_services configuration value) lists
4109 of identical services to one line that lists the service label and the
4110 number of individual services rather than individual items.
4111
4112 =cut
4113
4114 sub h_labels_short {
4115   shift->_labels_short( 'h_labels', @_ );
4116 }
4117
4118 # takes a method name ('labels' or 'h_labels') and all its arguments;
4119 # maybe should be "shorten($self->h_labels( ... ) )"
4120
4121 sub _labels_short {
4122   my( $self, $method ) = ( shift, shift );
4123
4124   warn "$me _labels_short called on $self with $method method\n"
4125     if $DEBUG;
4126
4127   my $conf = new FS::Conf;
4128   my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
4129
4130   warn "$me _labels_short populating \%labels\n"
4131     if $DEBUG;
4132
4133   my %labels;
4134   #tie %labels, 'Tie::IxHash';
4135   push @{ $labels{$_->[0]} }, $_->[1]
4136     foreach $self->$method(@_);
4137
4138   warn "$me _labels_short populating \@labels\n"
4139     if $DEBUG;
4140
4141   my @labels;
4142   foreach my $label ( keys %labels ) {
4143     my %seen = ();
4144     my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
4145     my $num = scalar(@values);
4146     warn "$me _labels_short $num items for $label\n"
4147       if $DEBUG;
4148
4149     if ( $num > $max_same_services ) {
4150       warn "$me _labels_short   more than $max_same_services, so summarizing\n"
4151         if $DEBUG;
4152       push @labels, "$label ($num)";
4153     } else {
4154       if ( $conf->exists('cust_bill-consolidate_services') ) {
4155         warn "$me _labels_short   consolidating services\n"
4156           if $DEBUG;
4157         # push @labels, "$label: ". join(', ', @values);
4158         while ( @values ) {
4159           my $detail = "$label: ";
4160           $detail .= shift(@values). ', '
4161             while @values
4162                && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
4163           $detail =~ s/, $//;
4164           push @labels, $detail;
4165         }
4166         warn "$me _labels_short   done consolidating services\n"
4167           if $DEBUG;
4168       } else {
4169         warn "$me _labels_short   adding service data\n"
4170           if $DEBUG;
4171         push @labels, map { "$label: $_" } @values;
4172       }
4173     }
4174   }
4175
4176  @labels;
4177
4178 }
4179
4180 =item cust_main
4181
4182 Returns the parent customer object (see L<FS::cust_main>).
4183
4184 =cut
4185
4186 sub cust_main {
4187   my $self = shift;
4188   cluck 'cust_pkg->cust_main called' if $DEBUG;
4189   qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
4190 }
4191
4192 =item balance
4193
4194 Returns the balance for this specific package, when using
4195 experimental package balance.
4196
4197 =cut
4198
4199 sub balance {
4200   my $self = shift;
4201   $self->cust_main->balance_pkgnum( $self->pkgnum );
4202 }
4203
4204 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
4205
4206 =item cust_location
4207
4208 Returns the location object, if any (see L<FS::cust_location>).
4209
4210 =item cust_location_or_main
4211
4212 If this package is associated with a location, returns the locaiton (see
4213 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
4214
4215 =item location_label [ OPTION => VALUE ... ]
4216
4217 Returns the label of the location object (see L<FS::cust_location>).
4218
4219 =cut
4220
4221 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
4222
4223 =item tax_locationnum
4224
4225 Returns the foreign key to a L<FS::cust_location> object for calculating
4226 tax on this package, as determined by the C<tax-pkg_address> and
4227 C<tax-ship_address> configuration flags.
4228
4229 =cut
4230
4231 sub tax_locationnum {
4232   my $self = shift;
4233   my $conf = FS::Conf->new;
4234   if ( $conf->exists('tax-pkg_address') ) {
4235     return $self->locationnum;
4236   }
4237   elsif ( $conf->exists('tax-ship_address') ) {
4238     return $self->cust_main->ship_locationnum;
4239   }
4240   else {
4241     return $self->cust_main->bill_locationnum;
4242   }
4243 }
4244
4245 =item tax_location
4246
4247 Returns the L<FS::cust_location> object for tax_locationnum.
4248
4249 =cut
4250
4251 sub tax_location {
4252   my $self = shift;
4253   my $conf = FS::Conf->new;
4254   if ( $conf->exists('tax-pkg_address') and $self->locationnum ) {
4255     return FS::cust_location->by_key($self->locationnum);
4256   }
4257   elsif ( $conf->exists('tax-ship_address') ) {
4258     return $self->cust_main->ship_location;
4259   }
4260   else {
4261     return $self->cust_main->bill_location;
4262   }
4263 }
4264
4265 =item seconds_since TIMESTAMP
4266
4267 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
4268 package have been online since TIMESTAMP, according to the session monitor.
4269
4270 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
4271 L<Time::Local> and L<Date::Parse> for conversion functions.
4272
4273 =cut
4274
4275 sub seconds_since {
4276   my($self, $since) = @_;
4277   my $seconds = 0;
4278
4279   foreach my $cust_svc (
4280     grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
4281   ) {
4282     $seconds += $cust_svc->seconds_since($since);
4283   }
4284
4285   $seconds;
4286
4287 }
4288
4289 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
4290
4291 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
4292 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
4293 (exclusive).
4294
4295 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
4296 L<perlfunc/"time">.  Also see L<Time::Local> and L<Date::Parse> for conversion
4297 functions.
4298
4299
4300 =cut
4301
4302 sub seconds_since_sqlradacct {
4303   my($self, $start, $end) = @_;
4304
4305   my $seconds = 0;
4306
4307   foreach my $cust_svc (
4308     grep {
4309       my $part_svc = $_->part_svc;
4310       $part_svc->svcdb eq 'svc_acct'
4311         && scalar($part_svc->part_export_usage);
4312     } $self->cust_svc
4313   ) {
4314     $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
4315   }
4316
4317   $seconds;
4318
4319 }
4320
4321 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
4322
4323 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
4324 in this package for sessions ending between TIMESTAMP_START (inclusive) and
4325 TIMESTAMP_END
4326 (exclusive).
4327
4328 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
4329 L<perlfunc/"time">.  Also see L<Time::Local> and L<Date::Parse> for conversion
4330 functions.
4331
4332 =cut
4333
4334 sub attribute_since_sqlradacct {
4335   my($self, $start, $end, $attrib) = @_;
4336
4337   my $sum = 0;
4338
4339   foreach my $cust_svc (
4340     grep {
4341       my $part_svc = $_->part_svc;
4342       scalar($part_svc->part_export_usage);
4343     } $self->cust_svc
4344   ) {
4345     $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
4346   }
4347
4348   $sum;
4349
4350 }
4351
4352 =item quantity
4353
4354 =cut
4355
4356 sub quantity {
4357   my( $self, $value ) = @_;
4358   if ( defined($value) ) {
4359     $self->setfield('quantity', $value);
4360   }
4361   $self->getfield('quantity') || 1;
4362 }
4363
4364 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
4365
4366 Transfers as many services as possible from this package to another package.
4367
4368 The destination package can be specified by pkgnum by passing an FS::cust_pkg
4369 object.  The destination package must already exist.
4370
4371 Services are moved only if the destination allows services with the correct
4372 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true.  Use
4373 this option with caution!  No provision is made for export differences
4374 between the old and new service definitions.  Probably only should be used
4375 when your exports for all service definitions of a given svcdb are identical.
4376 (attempt a transfer without it first, to move all possible svcpart-matching
4377 services)
4378
4379 Any services that can't be moved remain in the original package.
4380
4381 Returns an error, if there is one; otherwise, returns the number of services
4382 that couldn't be moved.
4383
4384 =cut
4385
4386 sub transfer {
4387   my ($self, $dest_pkgnum, %opt) = @_;
4388
4389   my $remaining = 0;
4390   my $dest;
4391   my %target;
4392
4393   if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
4394     $dest = $dest_pkgnum;
4395     $dest_pkgnum = $dest->pkgnum;
4396   } else {
4397     $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
4398   }
4399
4400   return ('Package does not exist: '.$dest_pkgnum) unless $dest;
4401
4402   foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
4403     $target{$pkg_svc->svcpart} = $pkg_svc->quantity * ( $dest->quantity || 1 );
4404   }
4405
4406   unless ( $self->pkgnum == $dest->pkgnum ) {
4407     foreach my $cust_svc ($dest->cust_svc) {
4408       $target{$cust_svc->svcpart}--;
4409     }
4410   }
4411
4412   my %svcpart2svcparts = ();
4413   if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
4414     warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
4415     foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
4416       next if exists $svcpart2svcparts{$svcpart};
4417       my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
4418       $svcpart2svcparts{$svcpart} = [
4419         map  { $_->[0] }
4420         sort { $b->[1] cmp $a->[1]  or  $a->[2] <=> $b->[2] }
4421         map {
4422               my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
4423                                                    'svcpart' => $_          } );
4424               [ $_,
4425                 $pkg_svc ? $pkg_svc->primary_svc : '',
4426                 $pkg_svc ? $pkg_svc->quantity : 0,
4427               ];
4428             }
4429
4430         grep { $_ != $svcpart }
4431         map  { $_->svcpart }
4432         qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
4433       ];
4434       warn "alternates for svcpart $svcpart: ".
4435            join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
4436         if $DEBUG;
4437     }
4438   }
4439
4440   my $error;
4441   foreach my $cust_svc ($self->cust_svc) {
4442     my $svcnum = $cust_svc->svcnum;
4443
4444     if (    $target{$cust_svc->svcpart} > 0
4445          or $FS::cust_svc::ignore_quantity # maybe should be a 'force' option
4446        )
4447     {
4448       $target{$cust_svc->svcpart}--;
4449
4450       local $FS::cust_svc::ignore_quantity = 1
4451         if $self->pkgnum == $dest->pkgnum;
4452
4453       #why run replace at all in the $self->pkgnum == $dest->pkgnum case?
4454       # we do want to trigger location and pkg_change exports, but
4455       # without pkgnum changing from an old to new package, cust_svc->replace
4456       # doesn't know how to trigger those.  :/
4457       # does this mean we scrap the whole idea of "safe to modify it in place",
4458       # or do we special-case and pass the info needed to cust_svc->replace? :/
4459
4460       my $new = new FS::cust_svc { $cust_svc->hash };
4461       $new->pkgnum($dest_pkgnum);
4462       $error = $new->replace($cust_svc);
4463
4464     } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
4465
4466       if ( $DEBUG ) {
4467         warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
4468         warn "alternates to consider: ".
4469              join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
4470       }
4471
4472       my @alternate = grep {
4473                              warn "considering alternate svcpart $_: ".
4474                                   "$target{$_} available in new package\n"
4475                                if $DEBUG;
4476                              $target{$_} > 0;
4477                            } @{$svcpart2svcparts{$cust_svc->svcpart}};
4478
4479       if ( @alternate ) {
4480         warn "alternate(s) found\n" if $DEBUG;
4481         my $change_svcpart = $alternate[0];
4482         $target{$change_svcpart}--;
4483         my $new = new FS::cust_svc { $cust_svc->hash };
4484         $new->svcpart($change_svcpart);
4485         $new->pkgnum($dest_pkgnum);
4486         $error = $new->replace($cust_svc);
4487       } else {
4488         $remaining++;
4489       }
4490
4491     } else {
4492       $remaining++
4493     }
4494
4495     if ( $error ) {
4496       my @label = $cust_svc->label;
4497       return "service $label[1]: $error";
4498     }
4499
4500   }
4501   return $remaining;
4502 }
4503
4504 =item grab_svcnums SVCNUM, SVCNUM ...
4505
4506 Change the pkgnum for the provided services to this packages.  If there is an
4507 error, returns the error, otherwise returns false.
4508
4509 =cut
4510
4511 sub grab_svcnums {
4512   my $self = shift;
4513   my @svcnum = @_;
4514
4515   local $SIG{HUP} = 'IGNORE';
4516   local $SIG{INT} = 'IGNORE';
4517   local $SIG{QUIT} = 'IGNORE';
4518   local $SIG{TERM} = 'IGNORE';
4519   local $SIG{TSTP} = 'IGNORE';
4520   local $SIG{PIPE} = 'IGNORE';
4521
4522   my $oldAutoCommit = $FS::UID::AutoCommit;
4523   local $FS::UID::AutoCommit = 0;
4524   my $dbh = dbh;
4525
4526   foreach my $svcnum (@svcnum) {
4527     my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
4528       $dbh->rollback if $oldAutoCommit;
4529       return "unknown svcnum $svcnum";
4530     };
4531     $cust_svc->pkgnum( $self->pkgnum );
4532     my $error = $cust_svc->replace;
4533     if ( $error ) {
4534       $dbh->rollback if $oldAutoCommit;
4535       return $error;
4536     }
4537   }
4538
4539   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4540   '';
4541
4542 }
4543
4544 =item reexport
4545
4546 This method is deprecated.  See the I<depend_jobnum> option to the insert and
4547 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
4548
4549 =cut
4550
4551 sub reexport {
4552   my $self = shift;
4553
4554   local $SIG{HUP} = 'IGNORE';
4555   local $SIG{INT} = 'IGNORE';
4556   local $SIG{QUIT} = 'IGNORE';
4557   local $SIG{TERM} = 'IGNORE';
4558   local $SIG{TSTP} = 'IGNORE';
4559   local $SIG{PIPE} = 'IGNORE';
4560
4561   my $oldAutoCommit = $FS::UID::AutoCommit;
4562   local $FS::UID::AutoCommit = 0;
4563   my $dbh = dbh;
4564
4565   foreach my $cust_svc ( $self->cust_svc ) {
4566     #false laziness w/svc_Common::insert
4567     my $svc_x = $cust_svc->svc_x;
4568     foreach my $part_export ( $cust_svc->part_svc->part_export ) {
4569       my $error = $part_export->export_insert($svc_x);
4570       if ( $error ) {
4571         $dbh->rollback if $oldAutoCommit;
4572         return $error;
4573       }
4574     }
4575   }
4576
4577   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4578   '';
4579
4580 }
4581
4582 =item export_pkg_change OLD_CUST_PKG
4583
4584 Calls the "pkg_change" export action for all services attached to this package.
4585
4586 =cut
4587
4588 sub export_pkg_change {
4589   my( $self, $old )  = ( shift, shift );
4590
4591   local $SIG{HUP} = 'IGNORE';
4592   local $SIG{INT} = 'IGNORE';
4593   local $SIG{QUIT} = 'IGNORE';
4594   local $SIG{TERM} = 'IGNORE';
4595   local $SIG{TSTP} = 'IGNORE';
4596   local $SIG{PIPE} = 'IGNORE';
4597
4598   my $oldAutoCommit = $FS::UID::AutoCommit;
4599   local $FS::UID::AutoCommit = 0;
4600   my $dbh = dbh;
4601
4602   foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
4603     my $error = $svc_x->export('pkg_change', $self, $old);
4604     if ( $error ) {
4605       $dbh->rollback if $oldAutoCommit;
4606       return $error;
4607     }
4608   }
4609
4610   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4611   '';
4612
4613 }
4614
4615 =item insert_reason
4616
4617 Associates this package with a (suspension or cancellation) reason (see
4618 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
4619 L<FS::reason>).
4620
4621 Available options are:
4622
4623 =over 4
4624
4625 =item reason
4626
4627 can be set to a cancellation reason (see L<FS:reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason.  The hashref should have the following keys: typenum - Reason type (see L<FS::reason_type>, reason - Text of the new reason.
4628
4629 =item reason_otaker
4630
4631 the access_user (see L<FS::access_user>) providing the reason
4632
4633 =item date
4634
4635 a unix timestamp
4636
4637 =item action
4638
4639 the action (cancel, susp, adjourn, expire) associated with the reason
4640
4641 =back
4642
4643 If there is an error, returns the error, otherwise returns false.
4644
4645 =cut
4646
4647 sub insert_reason {
4648   my ($self, %options) = @_;
4649
4650   my $otaker = $options{reason_otaker} ||
4651                $FS::CurrentUser::CurrentUser->username;
4652
4653   my $reasonnum;
4654   if ( $options{'reason'} =~ /^(\d+)$/ ) {
4655
4656     $reasonnum = $1;
4657
4658   } elsif ( ref($options{'reason'}) ) {
4659
4660     return 'Enter a new reason (or select an existing one)'
4661       unless $options{'reason'}->{'reason'} !~ /^\s*$/;
4662
4663     my $reason = new FS::reason({
4664       'reason_type' => $options{'reason'}->{'typenum'},
4665       'reason'      => $options{'reason'}->{'reason'},
4666     });
4667     my $error = $reason->insert;
4668     return $error if $error;
4669
4670     $reasonnum = $reason->reasonnum;
4671
4672   } else {
4673     return "Unparseable reason: ". $options{'reason'};
4674   }
4675
4676   my $cust_pkg_reason =
4677     new FS::cust_pkg_reason({ 'pkgnum'    => $self->pkgnum,
4678                               'reasonnum' => $reasonnum,
4679                               'otaker'    => $otaker,
4680                               'action'    => substr(uc($options{'action'}),0,1),
4681                               'date'      => $options{'date'}
4682                                                ? $options{'date'}
4683                                                : time,
4684                             });
4685
4686   $cust_pkg_reason->insert;
4687 }
4688
4689 =item insert_discount
4690
4691 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
4692 inserting a new discount on the fly (see L<FS::discount>).
4693
4694 Available options are:
4695
4696 =over 4
4697
4698 =item discountnum
4699
4700 =back
4701
4702 If there is an error, returns the error, otherwise returns false.
4703
4704 =cut
4705
4706 sub insert_discount {
4707   #my ($self, %options) = @_;
4708   my $self = shift;
4709
4710   my $cust_pkg_discount = new FS::cust_pkg_discount {
4711     'pkgnum'      => $self->pkgnum,
4712     'discountnum' => $self->discountnum,
4713     'months_used' => 0,
4714     'end_date'    => '', #XXX
4715     #for the create a new discount case
4716     '_type'       => $self->discountnum__type,
4717     'amount'      => $self->discountnum_amount,
4718     'percent'     => $self->discountnum_percent,
4719     'months'      => $self->discountnum_months,
4720     'setup'      => $self->discountnum_setup,
4721     #'disabled'    => $self->discountnum_disabled,
4722   };
4723
4724   $cust_pkg_discount->insert;
4725 }
4726
4727
4728 =item change_discount %opt
4729
4730 Method checks if the given values represent a change in either setup or
4731 discount level.  If so, the existing discounts are revoked, the new
4732 discounts are recorded.
4733
4734 Usage:
4735
4736 $error = change_discount(
4737   {
4738     # -1: Indicates a "custom discount"
4739     #  0: Indicates to remove any discount
4740     # >0: discountnum to apply
4741     discountnum => [-1, 0, discountnum],
4742
4743     # When discountnum is "-1" to indicate custom discount, include
4744     # the additional fields:
4745     amount      => AMOUNT_DISCOUNT
4746     percent     => PERCENTAGE_DISCOUNT
4747     months      => 12,
4748     setup       => 1, # APPLY TO SETUP
4749     _type       => amount/percentage
4750   },
4751 );
4752
4753
4754 =cut
4755
4756 sub change_discount {
4757   my ($self, $opt) = @_;
4758   return "change_discount() called with bad \%opt hashref"
4759     unless ref $opt;
4760
4761   my %opt = %{$opt};
4762
4763   my @old_discount =
4764     qsearch('cust_pkg_discount',{
4765       pkgnum   => $self->pkgnum,
4766       disabled => '',
4767     });
4768
4769   if ($DEBUG) {
4770     warn "change_discount() pkgnum: ".$self->pkgnum." \n";
4771     warn "change_discount() \%opt: \n";
4772     warn Dumper(\%opt);
4773   }
4774
4775   my @to_be_disabled;
4776   my %change = %opt;
4777
4778   return "change_discount() called with bad discountnum"
4779     unless $change{discountnum} =~ /^-?\d+$/;
4780
4781   if ($change{discountnum} eq 0) {
4782     # Removing old discount
4783
4784     %change = ();
4785
4786     push @to_be_disabled, @old_discount;
4787
4788   } else {
4789
4790     if ( grep { $_->discountnum eq $change{discountnum} } @old_discount ){
4791       # Duplicate, disregard this entry
4792       %change = ();
4793     } else {
4794       # Mark any discounts we're replacing
4795       push @to_be_disabled, @old_discount;
4796     }
4797   }
4798
4799   # If we still have changes queued, create data structures for
4800   # insert_discount().
4801   my @discount_insert;
4802   if (%change) {
4803     push @discount_insert, {
4804       discountnum         => $change{discountnum},
4805       discountnum__type   => $change{_type},
4806       discountnum_amount  => $change{amount},
4807       discountnum_percent => $change{percent} ? $change{percent} : '0',
4808       discountnum_months  => $change{months},
4809       discountnum_setup   => $change{setup} ? 'Y' : '',
4810     }
4811   }
4812
4813   if ($DEBUG) {
4814     warn "change_discount() \% opt before insert \n";
4815     warn Dumper \%opt;
4816     warn "\@to_be_disabled \n";
4817     warn Dumper \@to_be_disabled;
4818   }
4819
4820   # Roll these updates into a transaction
4821   my $oldAutoCommit = $FS::UID::AutoCommit;
4822   local $FS::UID::AutoCommit = 0;
4823   my $dbh = dbh;
4824
4825   my $error;
4826
4827   # The "waive setup fee" flag has traditionally been handled by setting
4828   # $cust_pkg->waive_setup = Y.  This has been appropriately, and separately
4829   # handled, and it operates on a different table than cust_pkg_discount,
4830   # so the "-2 for waive setup fee" option is not being reimplemented
4831   # here.  Perhaps this may change later.
4832
4833   # Create new discounts
4834   for my $insert_discount (@discount_insert) {
4835
4836     # Set parameters for insert_discount into object, and insert
4837     for my $k (keys %{$insert_discount}) {
4838       $self->set($k, $insert_discount->{$k});
4839     }
4840     $error ||= $self->insert_discount();
4841   }
4842
4843   # Disabling old discounts
4844   for my $tbd (@to_be_disabled) {
4845     unless ($error) {
4846       $tbd->set(disabled => 'Y');
4847       $error = $tbd->replace();
4848     }
4849   }
4850
4851   if ($error) {
4852     $dbh->rollback if $oldAutoCommit;
4853     return $error;
4854   }
4855
4856   $dbh->commit if $oldAutoCommit;
4857   return undef;
4858 }
4859
4860 =item set_usage USAGE_VALUE_HASHREF
4861
4862 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4863 to which they should be set (see L<FS::svc_acct>).  Currently seconds,
4864 upbytes, downbytes, and totalbytes are appropriate keys.
4865
4866 All svc_accts which are part of this package have their values reset.
4867
4868 =cut
4869
4870 sub set_usage {
4871   my ($self, $valueref, %opt) = @_;
4872
4873   #only svc_acct can set_usage for now
4874   foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4875     my $svc_x = $cust_svc->svc_x;
4876     $svc_x->set_usage($valueref, %opt)
4877       if $svc_x->can("set_usage");
4878   }
4879 }
4880
4881 =item recharge USAGE_VALUE_HASHREF
4882
4883 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4884 to which they should be set (see L<FS::svc_acct>).  Currently seconds,
4885 upbytes, downbytes, and totalbytes are appropriate keys.
4886
4887 All svc_accts which are part of this package have their values incremented.
4888
4889 =cut
4890
4891 sub recharge {
4892   my ($self, $valueref) = @_;
4893
4894   #only svc_acct can set_usage for now
4895   foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4896     my $svc_x = $cust_svc->svc_x;
4897     $svc_x->recharge($valueref)
4898       if $svc_x->can("recharge");
4899   }
4900 }
4901
4902 =item cust_pkg_discount
4903
4904 =cut
4905
4906 sub cust_pkg_discount {
4907   my $self = shift;
4908   qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
4909 }
4910
4911 =item cust_pkg_discount_active
4912
4913 =cut
4914
4915 sub cust_pkg_discount_active {
4916   my $self = shift;
4917   grep { $_->status eq 'active' } $self->cust_pkg_discount;
4918 }
4919
4920 =item cust_pkg_usage
4921
4922 Returns a list of all voice usage counters attached to this package.
4923
4924 =cut
4925
4926 sub cust_pkg_usage {
4927   my $self = shift;
4928   qsearch('cust_pkg_usage', { pkgnum => $self->pkgnum });
4929 }
4930
4931 =item apply_usage OPTIONS
4932
4933 Takes the following options:
4934 - cdr: a call detail record (L<FS::cdr>)
4935 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
4936 - minutes: the maximum number of minutes to be charged
4937
4938 Finds available usage minutes for a call of this class, and subtracts
4939 up to that many minutes from the usage pool.  If the usage pool is empty,
4940 and the C<cdr-minutes_priority> global config option is set, minutes may
4941 be taken from other calls as well.  Either way, an allocation record will
4942 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
4943 number of minutes of usage applied to the call.
4944
4945 =cut
4946
4947 sub apply_usage {
4948   my ($self, %opt) = @_;
4949   my $cdr = $opt{cdr};
4950   my $rate_detail = $opt{rate_detail};
4951   my $minutes = $opt{minutes};
4952   my $classnum = $rate_detail->classnum;
4953   my $pkgnum = $self->pkgnum;
4954   my $custnum = $self->custnum;
4955
4956   local $SIG{HUP} = 'IGNORE';
4957   local $SIG{INT} = 'IGNORE';
4958   local $SIG{QUIT} = 'IGNORE';
4959   local $SIG{TERM} = 'IGNORE';
4960   local $SIG{TSTP} = 'IGNORE';
4961   local $SIG{PIPE} = 'IGNORE';
4962
4963   my $oldAutoCommit = $FS::UID::AutoCommit;
4964   local $FS::UID::AutoCommit = 0;
4965   my $dbh = dbh;
4966   my $order = FS::Conf->new->config('cdr-minutes_priority');
4967
4968   my $is_classnum;
4969   if ( $classnum ) {
4970     $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
4971   } else {
4972     $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
4973   }
4974   my @usage_recs = qsearch({
4975       'table'     => 'cust_pkg_usage',
4976       'addl_from' => ' JOIN part_pkg_usage       USING (pkgusagepart)'.
4977                      ' JOIN cust_pkg             USING (pkgnum)'.
4978                      ' JOIN part_pkg_usage_class USING (pkgusagepart)',
4979       'select'    => 'cust_pkg_usage.*',
4980       'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
4981                      " ( cust_pkg.custnum = $custnum AND ".
4982                      " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4983                      $is_classnum . ' AND '.
4984                      " cust_pkg_usage.minutes > 0",
4985       'order_by'  => " ORDER BY priority ASC",
4986   });
4987
4988   my $orig_minutes = $minutes;
4989   my $error;
4990   while (!$error and $minutes > 0 and @usage_recs) {
4991     my $cust_pkg_usage = shift @usage_recs;
4992     $cust_pkg_usage->select_for_update;
4993     my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
4994         pkgusagenum => $cust_pkg_usage->pkgusagenum,
4995         acctid      => $cdr->acctid,
4996         minutes     => min($cust_pkg_usage->minutes, $minutes),
4997     });
4998     $cust_pkg_usage->set('minutes',
4999       $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes
5000     );
5001     $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
5002     $minutes -= $cdr_cust_pkg_usage->minutes;
5003   }
5004   if ( $order and $minutes > 0 and !$error ) {
5005     # then try to steal minutes from another call
5006     my %search = (
5007         'table'     => 'cdr_cust_pkg_usage',
5008         'addl_from' => ' JOIN cust_pkg_usage        USING (pkgusagenum)'.
5009                        ' JOIN part_pkg_usage        USING (pkgusagepart)'.
5010                        ' JOIN cust_pkg              USING (pkgnum)'.
5011                        ' JOIN part_pkg_usage_class  USING (pkgusagepart)'.
5012                        ' JOIN cdr                   USING (acctid)',
5013         'select'    => 'cdr_cust_pkg_usage.*',
5014         'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
5015                        " ( cust_pkg.pkgnum = $pkgnum OR ".
5016                        " ( cust_pkg.custnum = $custnum AND ".
5017                        " part_pkg_usage.shared IS NOT NULL ) ) AND ".
5018                        " part_pkg_usage_class.classnum = $classnum",
5019         'order_by'  => ' ORDER BY part_pkg_usage.priority ASC',
5020     );
5021     if ( $order eq 'time' ) {
5022       # find CDRs that are using minutes, but have a later startdate
5023       # than this call
5024       my $startdate = $cdr->startdate;
5025       if ($startdate !~ /^\d+$/) {
5026         die "bad cdr startdate '$startdate'";
5027       }
5028       $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
5029       # minimize needless reshuffling
5030       $search{'order_by'} .= ', cdr.startdate DESC';
5031     } else {
5032       # XXX may not work correctly with rate_time schedules.  Could
5033       # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
5034       # think...
5035       $search{'addl_from'} .=
5036         ' JOIN rate_detail'.
5037         ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
5038       if ( $order eq 'rate_high' ) {
5039         $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
5040                                 $rate_detail->min_charge;
5041         $search{'order_by'} .= ', rate_detail.min_charge ASC';
5042       } elsif ( $order eq 'rate_low' ) {
5043         $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
5044                                 $rate_detail->min_charge;
5045         $search{'order_by'} .= ', rate_detail.min_charge DESC';
5046       } else {
5047         #  this should really never happen
5048         die "invalid cdr-minutes_priority value '$order'\n";
5049       }
5050     }
5051     my @cdr_usage_recs = qsearch(\%search);
5052     my %reproc_cdrs;
5053     while (!$error and @cdr_usage_recs and $minutes > 0) {
5054       my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
5055       my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
5056       my $old_cdr = $cdr_cust_pkg_usage->cdr;
5057       $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
5058       $cdr_cust_pkg_usage->select_for_update;
5059       $old_cdr->select_for_update;
5060       $cust_pkg_usage->select_for_update;
5061       # in case someone else stole the usage from this CDR
5062       # while waiting for the lock...
5063       next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
5064       # steal the usage allocation and flag the old CDR for reprocessing
5065       $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
5066       # if the allocation is more minutes than we need, adjust it...
5067       my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
5068       if ( $delta > 0 ) {
5069         $cdr_cust_pkg_usage->set('minutes', $minutes);
5070         $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
5071         $error = $cust_pkg_usage->replace;
5072       }
5073       #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
5074       $error ||= $cdr_cust_pkg_usage->replace;
5075       # deduct the stolen minutes
5076       $minutes -= $cdr_cust_pkg_usage->minutes;
5077     }
5078     # after all minute-stealing is done, reset the affected CDRs
5079     foreach (values %reproc_cdrs) {
5080       $error ||= $_->set_status('');
5081       # XXX or should we just call $cdr->rate right here?
5082       # it's not like we can create a loop this way, since the min_charge
5083       # or call time has to go monotonically in one direction.
5084       # we COULD get some very deep recursions going, though...
5085     }
5086   } # if $order and $minutes
5087   if ( $error ) {
5088     $dbh->rollback;
5089     die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
5090   } else {
5091     $dbh->commit if $oldAutoCommit;
5092     return $orig_minutes - $minutes;
5093   }
5094 }
5095
5096 =item supplemental_pkgs
5097
5098 Returns a list of all packages supplemental to this one.
5099
5100 =cut
5101
5102 sub supplemental_pkgs {
5103   my $self = shift;
5104   qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
5105 }
5106
5107 =item main_pkg
5108
5109 Returns the package that this one is supplemental to, if any.
5110
5111 =cut
5112
5113 sub main_pkg {
5114   my $self = shift;
5115   if ( $self->main_pkgnum ) {
5116     return FS::cust_pkg->by_key($self->main_pkgnum);
5117   }
5118   return;
5119 }
5120
5121 =back
5122
5123 =head1 CLASS METHODS
5124
5125 =over 4
5126
5127 =item recurring_sql
5128
5129 Returns an SQL expression identifying recurring packages.
5130
5131 =cut
5132
5133 sub recurring_sql { "
5134   '0' != ( select freq from part_pkg
5135              where cust_pkg.pkgpart = part_pkg.pkgpart )
5136 "; }
5137
5138 =item onetime_sql
5139
5140 Returns an SQL expression identifying one-time packages.
5141
5142 =cut
5143
5144 sub onetime_sql { "
5145   '0' = ( select freq from part_pkg
5146             where cust_pkg.pkgpart = part_pkg.pkgpart )
5147 "; }
5148
5149 =item ordered_sql
5150
5151 Returns an SQL expression identifying ordered packages (recurring packages not
5152 yet billed).
5153
5154 =cut
5155
5156 sub ordered_sql {
5157    $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
5158 }
5159
5160 =item active_sql
5161
5162 Returns an SQL expression identifying active packages.
5163
5164 =cut
5165
5166 sub active_sql {
5167   $_[0]->recurring_sql. "
5168   AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
5169   AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5170   AND ( cust_pkg.susp   IS NULL OR cust_pkg.susp   = 0 )
5171 "; }
5172
5173 =item not_yet_billed_sql
5174
5175 Returns an SQL expression identifying packages which have not yet been billed.
5176
5177 =cut
5178
5179 sub not_yet_billed_sql { "
5180       ( cust_pkg.setup  IS NULL OR cust_pkg.setup  = 0 )
5181   AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5182   AND ( cust_pkg.susp   IS NULL OR cust_pkg.susp   = 0 )
5183 "; }
5184
5185 =item inactive_sql
5186
5187 Returns an SQL expression identifying inactive packages (one-time packages
5188 that are otherwise unsuspended/uncancelled).
5189
5190 =cut
5191
5192 sub inactive_sql { "
5193   ". $_[0]->onetime_sql(). "
5194   AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
5195   AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5196   AND ( cust_pkg.susp   IS NULL OR cust_pkg.susp   = 0 )
5197 "; }
5198
5199 =item on_hold_sql
5200
5201 Returns an SQL expression identifying on-hold packages.
5202
5203 =cut
5204
5205 sub on_hold_sql {
5206   #$_[0]->recurring_sql(). ' AND '.
5207   "
5208         ( cust_pkg.cancel IS     NULL  OR cust_pkg.cancel  = 0 )
5209     AND   cust_pkg.susp   IS NOT NULL AND cust_pkg.susp   != 0
5210     AND ( cust_pkg.setup  IS     NULL  OR cust_pkg.setup   = 0 )
5211   ";
5212 }
5213
5214 =item susp_sql
5215 =item suspended_sql
5216
5217 Returns an SQL expression identifying suspended packages.
5218
5219 =cut
5220
5221 sub suspended_sql { susp_sql(@_); }
5222 sub susp_sql {
5223   #$_[0]->recurring_sql(). ' AND '.
5224   "
5225         ( cust_pkg.cancel IS     NULL  OR cust_pkg.cancel = 0 )
5226     AND   cust_pkg.susp   IS NOT NULL AND cust_pkg.susp  != 0
5227     AND   cust_pkg.setup  IS NOT NULL AND cust_pkg.setup != 0
5228   ";
5229 }
5230
5231 =item cancel_sql
5232 =item cancelled_sql
5233
5234 Returns an SQL exprression identifying cancelled packages.
5235
5236 =cut
5237
5238 sub cancelled_sql { cancel_sql(@_); }
5239 sub cancel_sql {
5240   #$_[0]->recurring_sql(). ' AND '.
5241   "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
5242 }
5243
5244 =item ncancelled_recurring_sql
5245
5246 Returns an SQL expression identifying un-cancelled, recurring packages.
5247
5248 =cut
5249
5250 sub ncancelled_recurring_sql {
5251   $_[0]->recurring_sql().
5252   " AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 ) ";
5253 }
5254
5255 =item status_sql
5256
5257 Returns an SQL expression to give the package status as a string.
5258
5259 =cut
5260
5261 sub status_sql {
5262 "CASE
5263   WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
5264   WHEN ( cust_pkg.susp IS NOT NULL AND cust_pkg.setup IS NULL ) THEN 'on hold'
5265   WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
5266   WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
5267   WHEN ".onetime_sql()." THEN 'one-time charge'
5268   ELSE 'active'
5269 END"
5270 }
5271
5272 =item search HASHREF
5273
5274 (Class method)
5275
5276 Returns a qsearch hash expression to search for parameters specified in HASHREF.
5277 Valid parameters are
5278
5279 =over 4
5280
5281 =item agentnum
5282
5283 =item status
5284
5285 on hold, active, inactive (or one-time charge), suspended, canceled (or cancelled)
5286
5287 =item magic
5288
5289 Equivalent to "status", except that "canceled"/"cancelled" will exclude
5290 packages that were changed into a new package with the same pkgpart (i.e.
5291 location or quantity changes).
5292
5293 =item custom
5294
5295  boolean selects custom packages
5296
5297 =item classnum
5298
5299 =item pkgpart
5300
5301 pkgpart or arrayref or hashref of pkgparts
5302
5303 =item setup
5304
5305 arrayref of beginning and ending epoch date
5306
5307 =item last_bill
5308
5309 arrayref of beginning and ending epoch date
5310
5311 =item bill
5312
5313 arrayref of beginning and ending epoch date
5314
5315 =item adjourn
5316
5317 arrayref of beginning and ending epoch date
5318
5319 =item susp
5320
5321 arrayref of beginning and ending epoch date
5322
5323 =item expire
5324
5325 arrayref of beginning and ending epoch date
5326
5327 =item cancel
5328
5329 arrayref of beginning and ending epoch date
5330
5331 =item query
5332
5333 pkgnum or APKG_pkgnum
5334
5335 =item cust_fields
5336
5337 a value suited to passing to FS::UI::Web::cust_header
5338
5339 =item CurrentUser
5340
5341 specifies the user for agent virtualization
5342
5343 =item fcc_line
5344
5345 boolean; if true, returns only packages with more than 0 FCC phone lines.
5346
5347 =item state, country
5348
5349 Limit to packages with a service location in the specified state and country.
5350 For FCC 477 reporting, mostly.
5351
5352 =item location_cust
5353
5354 Limit to packages whose service locations are the same as the customer's
5355 default service location.
5356
5357 =item location_nocust
5358
5359 Limit to packages whose service locations are not the customer's default
5360 service location.
5361
5362 =item location_census
5363
5364 Limit to packages whose service locations have census tracts.
5365
5366 =item location_nocensus
5367
5368 Limit to packages whose service locations do not have a census tract.
5369
5370 =item location_geocode
5371
5372 Limit to packages whose locations have geocodes.
5373
5374 =item location_geocode
5375
5376 Limit to packages whose locations do not have geocodes.
5377
5378 =item towernum
5379
5380 Limit to packages associated with a svc_broadband, associated with a sector,
5381 associated with this towernum (or any of these, if it's an arrayref) (or NO
5382 towernum, if it's zero). This is an extreme niche case.
5383
5384 =item 477part, 477rownum, date
5385
5386 Limit to packages included in a specific row of one of the FCC 477 reports.
5387 '477part' is the section name (see L<FS::Report::FCC_477> methods), 'date'
5388 is the report as-of date (completely unrelated to the package setup/bill/
5389 other date fields), and '477rownum' is the row number of the report starting
5390 with zero. Row numbers have no inherent meaning, so this is useful only
5391 for explaining a 477 report you've already run.
5392
5393 =back
5394
5395 =cut
5396
5397 sub search {
5398   my ($class, $params) = @_;
5399   my @where = ();
5400
5401   ##
5402   # parse agent
5403   ##
5404
5405   if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
5406     push @where,
5407       "cust_main.agentnum = $1";
5408   }
5409
5410   ##
5411   # parse cust_status
5412   ##
5413
5414   if ( $params->{'cust_status'} =~ /^([a-z]+)$/ ) {
5415     push @where, FS::cust_main->cust_status_sql . " = '$1' ";
5416   }
5417
5418   ##
5419   # parse customer sales person
5420   ##
5421
5422   if ( $params->{'cust_main_salesnum'} =~ /^(\d+)$/ ) {
5423     push @where, ($1 > 0) ? "cust_main.salesnum = $1"
5424                           : 'cust_main.salesnum IS NULL';
5425   }
5426
5427
5428   ##
5429   # parse sales person
5430   ##
5431
5432   if ( $params->{'salesnum'} =~ /^(\d+)$/ ) {
5433     push @where, ($1 > 0) ? "cust_pkg.salesnum = $1"
5434                           : 'cust_pkg.salesnum IS NULL';
5435   }
5436
5437   ##
5438   # parse custnum
5439   ##
5440
5441   if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
5442     push @where,
5443       "cust_pkg.custnum = $1";
5444   }
5445
5446   ##
5447   # custbatch
5448   ##
5449
5450   if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
5451     push @where,
5452       "cust_pkg.pkgbatch = '$1'";
5453   }
5454
5455   ##
5456   # parse status
5457   ##
5458
5459   if (    $params->{'magic'}  eq 'active'
5460        || $params->{'status'} eq 'active' ) {
5461
5462     push @where, FS::cust_pkg->active_sql();
5463
5464   } elsif (    $params->{'magic'}  =~ /^not[ _]yet[ _]billed$/
5465             || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
5466
5467     push @where, FS::cust_pkg->not_yet_billed_sql();
5468
5469   } elsif (    $params->{'magic'}  =~ /^(one-time charge|inactive)/
5470             || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
5471
5472     push @where, FS::cust_pkg->inactive_sql();
5473
5474   } elsif (    $params->{'magic'}  =~ /^on[ _]hold$/
5475             || $params->{'status'} =~ /^on[ _]hold$/ ) {
5476
5477     push @where, FS::cust_pkg->on_hold_sql();
5478
5479
5480   } elsif (    $params->{'magic'}  eq 'suspended'
5481             || $params->{'status'} eq 'suspended'  ) {
5482
5483     push @where, FS::cust_pkg->suspended_sql();
5484
5485   } elsif (    $params->{'magic'}  =~ /^cancell?ed$/
5486             || $params->{'status'} =~ /^cancell?ed$/ ) {
5487
5488     push @where, FS::cust_pkg->cancelled_sql();
5489
5490   }
5491
5492   ### special case: "magic" is used in detail links from browse/part_pkg,
5493   # where "cancelled" has the restriction "and not replaced with a package
5494   # of the same pkgpart".  Be consistent with that.
5495   ###
5496
5497   if ( $params->{'magic'} =~ /^cancell?ed$/ ) {
5498     my $new_pkgpart = "SELECT pkgpart FROM cust_pkg AS cust_pkg_next ".
5499                       "WHERE cust_pkg_next.change_pkgnum = cust_pkg.pkgnum";
5500     # ...may not exist, if this was just canceled and not changed; in that
5501     # case give it a "new pkgpart" that never equals the old pkgpart
5502     push @where, "COALESCE(($new_pkgpart), 0) != cust_pkg.pkgpart";
5503   }
5504
5505   ###
5506   # parse package class
5507   ###
5508
5509   if ( exists($params->{'classnum'}) ) {
5510
5511     my @classnum = ();
5512     if ( ref($params->{'classnum'}) ) {
5513
5514       if ( ref($params->{'classnum'}) eq 'HASH' ) {
5515         @classnum = grep $params->{'classnum'}{$_}, keys %{ $params->{'classnum'} };
5516       } elsif ( ref($params->{'classnum'}) eq 'ARRAY' ) {
5517         @classnum = @{ $params->{'classnum'} };
5518       } else {
5519         die 'unhandled classnum ref '. $params->{'classnum'};
5520       }
5521
5522
5523     } elsif ( $params->{'classnum'} =~ /^(\d*)$/ && $1 ne '0' ) {
5524       @classnum = ( $1 );
5525     }
5526
5527     if ( @classnum ) {
5528
5529       my @c_where = ();
5530       my @nums = grep $_, @classnum;
5531       push @c_where, 'part_pkg.classnum IN ('. join(',',@nums). ')' if @nums;
5532       my $null = scalar( grep { $_ eq '' } @classnum );
5533       push @c_where, 'part_pkg.classnum IS NULL' if $null;
5534
5535       if ( scalar(@c_where) == 1 ) {
5536         push @where, @c_where;
5537       } elsif ( @c_where ) {
5538         push @where, ' ( '. join(' OR ', @c_where). ' ) ';
5539       }
5540
5541     }
5542
5543
5544   }
5545
5546   ###
5547   # parse (customer) refnum (advertising source)
5548   ###
5549
5550   if ( exists($params->{'refnum'}) ) {
5551     my @refnum;
5552     if (ref $params->{'refnum'}) {
5553       @refnum = @{ $params->{'refnum'} };
5554     } else {
5555       @refnum = ( $params->{'refnum'} );
5556     }
5557     my $in = join(',', grep /^\d+$/, @refnum);
5558     push @where, "cust_main.refnum IN($in)" if length $in;
5559   }
5560
5561   ###
5562   # parse package report options
5563   ###
5564
5565   my @report_option = ();
5566   if ( exists($params->{'report_option'}) ) {
5567     if ( ref($params->{'report_option'}) eq 'ARRAY' ) {
5568       @report_option = @{ $params->{'report_option'} };
5569     } elsif ( $params->{'report_option'} =~ /^([,\d]*)$/ ) {
5570       @report_option = split(',', $1);
5571     }
5572
5573   }
5574
5575   if (@report_option) {
5576     # this will result in the empty set for the dangling comma case as it should
5577     push @where,
5578       map{ "0 < ( SELECT count(*) FROM part_pkg_option
5579                     WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
5580                     AND optionname = 'report_option_$_'
5581                     AND optionvalue = '1' )"
5582          } @report_option;
5583   }
5584
5585   foreach my $any ( grep /^report_option_any/, keys %$params ) {
5586
5587     my @report_option_any = ();
5588     if ( ref($params->{$any}) eq 'ARRAY' ) {
5589       @report_option_any = @{ $params->{$any} };
5590     } elsif ( $params->{$any} =~ /^([,\d]*)$/ ) {
5591       @report_option_any = split(',', $1);
5592     }
5593
5594     if (@report_option_any) {
5595       # this will result in the empty set for the dangling comma case as it should
5596       push @where, ' ( '. join(' OR ',
5597         map{ "0 < ( SELECT count(*) FROM part_pkg_option
5598                       WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
5599                       AND optionname = 'report_option_$_'
5600                       AND optionvalue = '1' )"
5601            } @report_option_any
5602       ). ' ) ';
5603     }
5604
5605   }
5606
5607   ###
5608   # parse custom
5609   ###
5610
5611   push @where,  "part_pkg.custom = 'Y'" if $params->{custom};
5612
5613   ###
5614   # parse fcc_line
5615   ###
5616
5617   push @where,  "(part_pkg.fcc_ds0s > 0 OR pkg_class.fcc_ds0s > 0)"
5618                                                         if $params->{fcc_line};
5619
5620   ###
5621   # parse censustract
5622   ###
5623
5624   if ( exists($params->{'censustract'}) ) {
5625     $params->{'censustract'} =~ /^([.\d]*)$/;
5626     my $censustract = "cust_location.censustract = '$1'";
5627     $censustract .= ' OR cust_location.censustract is NULL' unless $1;
5628     push @where,  "( $censustract )";
5629   }
5630
5631   ###
5632   # parse censustract2
5633   ###
5634   if ( exists($params->{'censustract2'})
5635        && $params->{'censustract2'} =~ /^(\d*)$/
5636      )
5637   {
5638     if ($1) {
5639       push @where, "cust_location.censustract LIKE '$1%'";
5640     } else {
5641       push @where,
5642         "( cust_location.censustract = '' OR cust_location.censustract IS NULL )";
5643     }
5644   }
5645
5646   ###
5647   # parse country/state/zip
5648   ###
5649   for (qw(state country)) { # parsing rules are the same for these
5650   if ( exists($params->{$_})
5651     && uc($params->{$_}) =~ /^([A-Z]{2})$/ )
5652     {
5653       # XXX post-2.3 only--before that, state/country may be in cust_main
5654       push @where, "cust_location.$_ = '$1'";
5655     }
5656   }
5657   if ( exists($params->{zip}) ) {
5658     push @where, "cust_location.zip = " . dbh->quote($params->{zip});
5659   }
5660
5661   ###
5662   # location_* flags
5663   ###
5664   if ( $params->{location_cust} xor $params->{location_nocust} ) {
5665     my $op = $params->{location_cust} ? '=' : '!=';
5666     push @where, "cust_location.locationnum $op cust_main.ship_locationnum";
5667   }
5668   if ( $params->{location_census} xor $params->{location_nocensus} ) {
5669     my $op = $params->{location_census} ? "IS NOT NULL" : "IS NULL";
5670     push @where, "cust_location.censustract $op";
5671   }
5672   if ( $params->{location_geocode} xor $params->{location_nogeocode} ) {
5673     my $op = $params->{location_geocode} ? "IS NOT NULL" : "IS NULL";
5674     push @where, "cust_location.geocode $op";
5675   }
5676
5677   ###
5678   # parse part_pkg
5679   ###
5680
5681   if ( ref($params->{'pkgpart'}) ) {
5682
5683     my @pkgpart = ();
5684     if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
5685       @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
5686     } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
5687       @pkgpart = @{ $params->{'pkgpart'} };
5688     } else {
5689       die 'unhandled pkgpart ref '. $params->{'pkgpart'};
5690     }
5691
5692     @pkgpart = grep /^(\d+)$/, @pkgpart;
5693
5694     push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
5695
5696   } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
5697     push @where, "pkgpart = $1";
5698   }
5699
5700   ###
5701   # parse dates
5702   ###
5703
5704   my $orderby = '';
5705
5706   #false laziness w/report_cust_pkg.html
5707   my %disable = (
5708     'all'             => {},
5709     'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
5710     'active'          => { 'susp'=>1, 'cancel'=>1 },
5711     'suspended'       => { 'cancel' => 1 },
5712     'cancelled'       => {},
5713     ''                => {},
5714   );
5715
5716   if( exists($params->{'active'} ) ) {
5717     # This overrides all the other date-related fields, and includes packages
5718     # that were active at some time during the interval.  It excludes:
5719     # - packages that were set up after the end of the interval
5720     # - packages that were canceled before the start of the interval
5721     # - packages that were suspended before the start of the interval
5722     #   and are still suspended now
5723     my($beginning, $ending) = @{$params->{'active'}};
5724     push @where,
5725       "cust_pkg.setup IS NOT NULL",
5726       "cust_pkg.setup <= $ending",
5727       "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
5728       "(cust_pkg.susp   IS NULL OR cust_pkg.susp   >= $beginning )",
5729       "NOT (".FS::cust_pkg->onetime_sql . ")";
5730   }
5731   else {
5732     my $exclude_change_from = 0;
5733     my $exclude_change_to = 0;
5734
5735     foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end change_date cancel )) {
5736
5737       if ( $params->{$field.'_null'} ) {
5738
5739         push @where, "cust_pkg.$field IS NULL";
5740              # this should surely be obsoleted by now: OR cust_pkg.$field == 0
5741
5742       } else {
5743
5744         next unless exists($params->{$field});
5745
5746         my($beginning, $ending) = @{$params->{$field}};
5747
5748         next if $beginning == 0 && $ending == 4294967295;
5749
5750         push @where,
5751           "cust_pkg.$field IS NOT NULL",
5752           "cust_pkg.$field >= $beginning",
5753           "cust_pkg.$field <= $ending";
5754
5755         $orderby ||= "ORDER BY cust_pkg.$field";
5756
5757         if ( $field eq 'setup' ) {
5758           $exclude_change_from = 1;
5759         } elsif ( $field eq 'cancel' ) {
5760           $exclude_change_to = 1;
5761         } elsif ( $field eq 'change_date' ) {
5762           # if we are given setup and change_date ranges, and the setup date
5763           # falls in _both_ ranges, then include the package whether it was
5764           # a change or not
5765           $exclude_change_from = 0;
5766         }
5767       }
5768
5769     }
5770
5771     if ($exclude_change_from) {
5772       push @where, "change_pkgnum IS NULL";
5773     }
5774     if ($exclude_change_to) {
5775       # a join might be more efficient here
5776       push @where, "NOT EXISTS(
5777         SELECT 1 FROM cust_pkg AS changed_to_pkg
5778         WHERE cust_pkg.pkgnum = changed_to_pkg.change_pkgnum
5779       )";
5780     }
5781
5782   }
5783
5784   $orderby ||= 'ORDER BY bill';
5785
5786   ###
5787   # parse magic, legacy, etc.
5788   ###
5789
5790   if ( $params->{'magic'} &&
5791        $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
5792   ) {
5793
5794     $orderby = 'ORDER BY pkgnum';
5795
5796     if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
5797       push @where, "pkgpart = $1";
5798     }
5799
5800   } elsif ( $params->{'query'} eq 'pkgnum' ) {
5801
5802     $orderby = 'ORDER BY pkgnum';
5803
5804   } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
5805
5806     $orderby = 'ORDER BY pkgnum';
5807
5808     push @where, '0 < (
5809       SELECT count(*) FROM pkg_svc
5810        WHERE pkg_svc.pkgpart =  cust_pkg.pkgpart
5811          AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
5812                                    WHERE cust_svc.pkgnum  = cust_pkg.pkgnum
5813                                      AND cust_svc.svcpart = pkg_svc.svcpart
5814                                 )
5815     )';
5816
5817   }
5818
5819   ##
5820   # parse the extremely weird 'towernum' param
5821   ##
5822
5823   if ($params->{towernum}) {
5824     my $towernum = $params->{towernum};
5825     $towernum = [ $towernum ] if !ref($towernum);
5826     my $in = join(',', grep /^\d+$/, @$towernum);
5827     if (length $in) {
5828       # inefficient, but this is an obscure feature
5829       eval "use FS::Report::Table";
5830       FS::Report::Table->_init_tower_pkg_cache; # probably does nothing
5831       push @where, "EXISTS(
5832       SELECT 1 FROM tower_pkg_cache
5833       WHERE tower_pkg_cache.pkgnum = cust_pkg.pkgnum
5834         AND tower_pkg_cache.towernum IN ($in)
5835       )"
5836     }
5837   }
5838
5839   ##
5840   # parse the 477 report drill-down options
5841   ##
5842
5843   if ($params->{'477part'} =~ /^([a-z]+)$/) {
5844     my $section = $1;
5845     my ($date, $rownum, $agentnum);
5846     if ($params->{'date'} =~ /^(\d+)$/) {
5847       $date = $1;
5848     }
5849     if ($params->{'477rownum'} =~ /^(\d+)$/) {
5850       $rownum = $1;
5851     }
5852     if ($params->{'agentnum'} =~ /^(\d+)$/) {
5853       $agentnum = $1;
5854     }
5855     if ($date and defined($rownum)) {
5856       my $report = FS::Report::FCC_477->report($section,
5857         'date'      => $date,
5858         'agentnum'  => $agentnum,
5859         'detail'    => 1
5860       );
5861       my $pkgnums = $report->{detail}->[$rownum]
5862         or die "row $rownum is past the end of the report";
5863         # '0' so that if there are no pkgnums (empty string) it will create
5864         # a valid query that returns nothing
5865       warn "PKGNUMS:\n$pkgnums\n\n"; # XXX debug
5866
5867       # and this overrides everything
5868       @where = ( "cust_pkg.pkgnum IN($pkgnums)" );
5869     } # else we're missing some params, ignore the whole business
5870   }
5871
5872   ##
5873   # setup queries, links, subs, etc. for the search
5874   ##
5875
5876   # here is the agent virtualization
5877   if ($params->{CurrentUser}) {
5878     my $access_user =
5879       qsearchs('access_user', { username => $params->{CurrentUser} });
5880
5881     if ($access_user) {
5882       push @where, $access_user->agentnums_sql('table'=>'cust_main');
5883     } else {
5884       push @where, "1=0";
5885     }
5886   } else {
5887     push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
5888   }
5889
5890   my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
5891
5892   my $addl_from = 'LEFT JOIN part_pkg  USING ( pkgpart  ) '.
5893                   'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) '.
5894                   'LEFT JOIN cust_location USING ( locationnum ) '.
5895                   FS::UI::Web::join_cust_main('cust_pkg', 'cust_pkg');
5896
5897   my $select;
5898   my $count_query;
5899   if ( $params->{'select_zip5'} ) {
5900     my $zip = 'cust_location.zip';
5901
5902     $select = "DISTINCT substr($zip,1,5) as zip";
5903     $orderby = "ORDER BY substr($zip,1,5)";
5904     $count_query = "SELECT COUNT( DISTINCT substr($zip,1,5) )";
5905   } else {
5906     $select = join(', ',
5907                          'cust_pkg.*',
5908                          ( map "part_pkg.$_", qw( pkg freq ) ),
5909                          'pkg_class.classname',
5910                          'cust_main.custnum AS cust_main_custnum',
5911                          FS::UI::Web::cust_sql_fields(
5912                            $params->{'cust_fields'}
5913                          ),
5914                   );
5915     $count_query = 'SELECT COUNT(*)';
5916   }
5917
5918   $count_query .= " FROM cust_pkg $addl_from $extra_sql";
5919
5920   my $sql_query = {
5921     'table'       => 'cust_pkg',
5922     'hashref'     => {},
5923     'select'      => $select,
5924     'extra_sql'   => $extra_sql,
5925     'order_by'    => $orderby,
5926     'addl_from'   => $addl_from,
5927     'count_query' => $count_query,
5928   };
5929
5930 }
5931
5932 =item fcc_477_count
5933
5934 Returns a list of two package counts.  The first is a count of packages
5935 based on the supplied criteria and the second is the count of residential
5936 packages with those same criteria.  Criteria are specified as in the search
5937 method.
5938
5939 =cut
5940
5941 sub fcc_477_count {
5942   my ($class, $params) = @_;
5943
5944   my $sql_query = $class->search( $params );
5945
5946   my $count_sql = delete($sql_query->{'count_query'});
5947   $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
5948     or die "couldn't parse count_sql";
5949
5950   my $count_sth = dbh->prepare($count_sql)
5951     or die "Error preparing $count_sql: ". dbh->errstr;
5952   $count_sth->execute
5953     or die "Error executing $count_sql: ". $count_sth->errstr;
5954   my $count_arrayref = $count_sth->fetchrow_arrayref;
5955
5956   return ( @$count_arrayref );
5957
5958 }
5959
5960 =item tax_locationnum_sql
5961
5962 Returns an SQL expression for the tax location for a package, based
5963 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
5964
5965 =cut
5966
5967 sub tax_locationnum_sql {
5968   my $conf = FS::Conf->new;
5969   if ( $conf->exists('tax-pkg_address') ) {
5970     'cust_pkg.locationnum';
5971   }
5972   elsif ( $conf->exists('tax-ship_address') ) {
5973     'cust_main.ship_locationnum';
5974   }
5975   else {
5976     'cust_main.bill_locationnum';
5977   }
5978 }
5979
5980 =item location_sql
5981
5982 Returns a list: the first item is an SQL fragment identifying matching
5983 packages/customers via location (taking into account shipping and package
5984 address taxation, if enabled), and subsequent items are the parameters to
5985 substitute for the placeholders in that fragment.
5986
5987 =cut
5988
5989 sub location_sql {
5990   my($class, %opt) = @_;
5991   my $ornull = $opt{'ornull'};
5992
5993   my $conf = new FS::Conf;
5994
5995   # '?' placeholders in _location_sql_where
5996   my $x = $ornull ? 3 : 2;
5997   my @bill_param = (
5998     ('district')x3,
5999     ('city')x3,
6000     ('county')x$x,
6001     ('state')x$x,
6002     'country'
6003   );
6004
6005   my $main_where;
6006   my @main_param;
6007   if ( $conf->exists('tax-ship_address') ) {
6008
6009     $main_where = "(
6010          (     ( ship_last IS NULL     OR  ship_last  = '' )
6011            AND ". _location_sql_where('cust_main', '', $ornull ). "
6012          )
6013       OR (       ship_last IS NOT NULL AND ship_last != ''
6014            AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
6015          )
6016     )";
6017     #    AND payby != 'COMP'
6018
6019     @main_param = ( @bill_param, @bill_param );
6020
6021   } else {
6022
6023     $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
6024     @main_param = @bill_param;
6025
6026   }
6027
6028   my $where;
6029   my @param;
6030   if ( $conf->exists('tax-pkg_address') ) {
6031
6032     my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
6033
6034     $where = " (
6035                     ( cust_pkg.locationnum IS     NULL AND $main_where )
6036                  OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where  )
6037                )
6038              ";
6039     @param = ( @main_param, @bill_param );
6040
6041   } else {
6042
6043     $where = $main_where;
6044     @param = @main_param;
6045
6046   }
6047
6048   ( $where, @param );
6049
6050 }
6051
6052 #subroutine, helper for location_sql
6053 sub _location_sql_where {
6054   my $table  = shift;
6055   my $prefix = @_ ? shift : '';
6056   my $ornull = @_ ? shift : '';
6057
6058 #  $ornull             = $ornull          ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
6059
6060   $ornull = $ornull ? ' OR ? IS NULL ' : '';
6061
6062   my $or_empty_city     = " OR ( ? = '' AND $table.${prefix}city     IS NULL )";
6063   my $or_empty_county   = " OR ( ? = '' AND $table.${prefix}county   IS NULL )";
6064   my $or_empty_state    = " OR ( ? = '' AND $table.${prefix}state    IS NULL )";
6065
6066   my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
6067
6068 #        ( $table.${prefix}city    = ? $or_empty_city   $ornull )
6069   "
6070         ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
6071     AND ( $table.${prefix}city     = ? OR ? = '' OR CAST(? AS $text) IS NULL )
6072     AND ( $table.${prefix}county   = ? $or_empty_county $ornull )
6073     AND ( $table.${prefix}state    = ? $or_empty_state  $ornull )
6074     AND   $table.${prefix}country  = ?
6075   ";
6076 }
6077
6078 sub _X_show_zero {
6079   my( $self, $what ) = @_;
6080
6081   my $what_show_zero = $what. '_show_zero';
6082   length($self->$what_show_zero())
6083     ? ($self->$what_show_zero() eq 'Y')
6084     : $self->part_pkg->$what_show_zero();
6085 }
6086
6087 =head1 SUBROUTINES
6088
6089 =over 4
6090
6091 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
6092
6093 Bulk cancel + order subroutine.  Perhaps slightly deprecated, only used by the
6094 bulk cancel+order in the web UI and nowhere else (edit/process/cust_pkg.cgi)
6095
6096 CUSTNUM is a customer (see L<FS::cust_main>)
6097
6098 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
6099 L<FS::part_pkg>) to order for this customer.  Duplicates are of course
6100 permitted.
6101
6102 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
6103 remove for this customer.  The services (see L<FS::cust_svc>) are moved to the
6104 new billing items.  An error is returned if this is not possible (see
6105 L<FS::pkg_svc>).  An empty arrayref is equivalent to not specifying this
6106 parameter.
6107
6108 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
6109 newly-created cust_pkg objects.
6110
6111 REFNUM, if specified, will specify the FS::pkg_referral record to be created
6112 and inserted.  Multiple FS::pkg_referral records can be created by
6113 setting I<refnum> to an array reference of refnums or a hash reference with
6114 refnums as keys.  If no I<refnum> is defined, a default FS::pkg_referral
6115 record will be created corresponding to cust_main.refnum.
6116
6117 =cut
6118
6119 sub order {
6120   my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
6121
6122   my $conf = new FS::Conf;
6123
6124   # Transactionize this whole mess
6125   local $SIG{HUP} = 'IGNORE';
6126   local $SIG{INT} = 'IGNORE';
6127   local $SIG{QUIT} = 'IGNORE';
6128   local $SIG{TERM} = 'IGNORE';
6129   local $SIG{TSTP} = 'IGNORE';
6130   local $SIG{PIPE} = 'IGNORE';
6131
6132   my $oldAutoCommit = $FS::UID::AutoCommit;
6133   local $FS::UID::AutoCommit = 0;
6134   my $dbh = dbh;
6135
6136   my $error;
6137 #  my $cust_main = qsearchs('cust_main', { custnum => $custnum });
6138 #  return "Customer not found: $custnum" unless $cust_main;
6139
6140   warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
6141     if $DEBUG;
6142
6143   my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
6144                          @$remove_pkgnum;
6145
6146   my $change = scalar(@old_cust_pkg) != 0;
6147
6148   my %hash = ();
6149   if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
6150
6151     warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
6152          " to pkgpart ". $pkgparts->[0]. "\n"
6153       if $DEBUG;
6154
6155     my $err_or_cust_pkg =
6156       $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
6157                                 'refnum'  => $refnum,
6158                               );
6159
6160     unless (ref($err_or_cust_pkg)) {
6161       $dbh->rollback if $oldAutoCommit;
6162       return $err_or_cust_pkg;
6163     }
6164
6165     push @$return_cust_pkg, $err_or_cust_pkg;
6166     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6167     return '';
6168
6169   }
6170
6171   # Create the new packages.
6172   foreach my $pkgpart (@$pkgparts) {
6173
6174     warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
6175
6176     my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
6177                                       pkgpart => $pkgpart,
6178                                       refnum  => $refnum,
6179                                       %hash,
6180                                     };
6181     $error = $cust_pkg->insert( 'change' => $change );
6182     push @$return_cust_pkg, $cust_pkg;
6183
6184     foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
6185       my $supp_pkg = FS::cust_pkg->new({
6186           custnum => $custnum,
6187           pkgpart => $link->dst_pkgpart,
6188           refnum  => $refnum,
6189           main_pkgnum => $cust_pkg->pkgnum,
6190           %hash,
6191       });
6192       $error ||= $supp_pkg->insert( 'change' => $change );
6193       push @$return_cust_pkg, $supp_pkg;
6194     }
6195
6196     if ($error) {
6197       $dbh->rollback if $oldAutoCommit;
6198       return $error;
6199     }
6200
6201   }
6202   # $return_cust_pkg now contains refs to all of the newly
6203   # created packages.
6204
6205   # Transfer services and cancel old packages.
6206   foreach my $old_pkg (@old_cust_pkg) {
6207
6208     warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
6209       if $DEBUG;
6210
6211     foreach my $new_pkg (@$return_cust_pkg) {
6212       $error = $old_pkg->transfer($new_pkg);
6213       if ($error and $error == 0) {
6214         # $old_pkg->transfer failed.
6215         $dbh->rollback if $oldAutoCommit;
6216         return $error;
6217       }
6218     }
6219
6220     if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
6221       warn "trying transfer again with change_svcpart option\n" if $DEBUG;
6222       foreach my $new_pkg (@$return_cust_pkg) {
6223         $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
6224         if ($error and $error == 0) {
6225           # $old_pkg->transfer failed.
6226         $dbh->rollback if $oldAutoCommit;
6227         return $error;
6228         }
6229       }
6230     }
6231
6232     if ($error > 0) {
6233       # Transfers were successful, but we went through all of the
6234       # new packages and still had services left on the old package.
6235       # We can't cancel the package under the circumstances, so abort.
6236       $dbh->rollback if $oldAutoCommit;
6237       return "Unable to transfer all services from package ".$old_pkg->pkgnum;
6238     }
6239     $error = $old_pkg->cancel( quiet=>1, 'no_delay_cancel'=>1 );
6240     if ($error) {
6241       $dbh->rollback;
6242       return $error;
6243     }
6244   }
6245   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6246   '';
6247 }
6248
6249 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
6250
6251 A bulk change method to change packages for multiple customers.
6252
6253 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
6254 L<FS::part_pkg>) to order for each customer.  Duplicates are of course
6255 permitted.
6256
6257 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
6258 replace.  The services (see L<FS::cust_svc>) are moved to the
6259 new billing items.  An error is returned if this is not possible (see
6260 L<FS::pkg_svc>).
6261
6262 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
6263 newly-created cust_pkg objects.
6264
6265 =cut
6266
6267 sub bulk_change {
6268   my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
6269
6270   # Transactionize this whole mess
6271   local $SIG{HUP} = 'IGNORE';
6272   local $SIG{INT} = 'IGNORE';
6273   local $SIG{QUIT} = 'IGNORE';
6274   local $SIG{TERM} = 'IGNORE';
6275   local $SIG{TSTP} = 'IGNORE';
6276   local $SIG{PIPE} = 'IGNORE';
6277
6278   my $oldAutoCommit = $FS::UID::AutoCommit;
6279   local $FS::UID::AutoCommit = 0;
6280   my $dbh = dbh;
6281
6282   my @errors;
6283   my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
6284                          @$remove_pkgnum;
6285
6286   while(scalar(@old_cust_pkg)) {
6287     my @return = ();
6288     my $custnum = $old_cust_pkg[0]->custnum;
6289     my (@remove) = map { $_->pkgnum }
6290                    grep { $_->custnum == $custnum } @old_cust_pkg;
6291     @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
6292
6293     my $error = order $custnum, $pkgparts, \@remove, \@return;
6294
6295     push @errors, $error
6296       if $error;
6297     push @$return_cust_pkg, @return;
6298   }
6299
6300   if (scalar(@errors)) {
6301     $dbh->rollback if $oldAutoCommit;
6302     return join(' / ', @errors);
6303   }
6304
6305   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6306   '';
6307 }
6308
6309 =item forward_emails
6310
6311 Returns a hash of svcnums and corresponding email addresses
6312 for svc_acct services that can be used as source or dest
6313 for svc_forward services provisioned in this package.
6314
6315 Accepts options I<svc_forward> OR I<svcnum> for a svc_forward
6316 service;  if included, will ensure the current values of the
6317 specified service are included in the list, even if for some
6318 other reason they wouldn't be.  If called as a class method
6319 with a specified service, returns only these current values.
6320
6321 Caution: does not actually check if svc_forward services are
6322 available to be provisioned on this package.
6323
6324 =cut
6325
6326 sub forward_emails {
6327   my $self = shift;
6328   my %opt = @_;
6329
6330   #load optional service, thoroughly validated
6331   die "Use svcnum or svc_forward, not both"
6332     if $opt{'svcnum'} && $opt{'svc_forward'};
6333   my $svc_forward = $opt{'svc_forward'};
6334   $svc_forward ||= qsearchs('svc_forward',{ 'svcnum' => $opt{'svcnum'} })
6335     if $opt{'svcnum'};
6336   die "Specified service is not a forward service"
6337     if $svc_forward && (ref($svc_forward) ne 'FS::svc_forward');
6338   die "Specified service not found"
6339     if ($opt{'svcnum'} || $opt{'svc_forward'}) && !$svc_forward;
6340
6341   my %email;
6342
6343   ## everything below was basically copied from httemplate/edit/svc_forward.cgi
6344   ## with minimal refactoring, not sure why we can't just load all svc_accts for this custnum
6345
6346   #add current values from specified service, if there was one
6347   if ($svc_forward) {
6348     foreach my $method (qw( srcsvc_acct dstsvc_acct )) {
6349       my $svc_acct = $svc_forward->$method();
6350       $email{$svc_acct->svcnum} = $svc_acct->email if $svc_acct;
6351     }
6352   }
6353
6354   if (ref($self) eq 'FS::cust_pkg') {
6355
6356     #and including the rest for this customer
6357     my($u_part_svc,@u_acct_svcparts);
6358     foreach $u_part_svc ( qsearch('part_svc',{'svcdb'=>'svc_acct'}) ) {
6359       push @u_acct_svcparts,$u_part_svc->getfield('svcpart');
6360     }
6361
6362     my $custnum = $self->getfield('custnum');
6363     foreach my $i_cust_pkg ( qsearch('cust_pkg',{'custnum'=>$custnum}) ) {
6364       my $cust_pkgnum = $i_cust_pkg->getfield('pkgnum');
6365       #now find the corresponding record(s) in cust_svc (for this pkgnum!)
6366       foreach my $acct_svcpart (@u_acct_svcparts) {
6367         foreach my $i_cust_svc (
6368           qsearch( 'cust_svc', { 'pkgnum'  => $cust_pkgnum,
6369                                  'svcpart' => $acct_svcpart } )
6370         ) {
6371           my $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $i_cust_svc->svcnum } );
6372           $email{$svc_acct->svcnum} = $svc_acct->email;
6373         }
6374       }
6375     }
6376   }
6377
6378   return %email;
6379 }
6380
6381 # Used by FS::Upgrade to migrate to a new database.
6382 sub _upgrade_data {  # class method
6383   my ($class, %opts) = @_;
6384   $class->_upgrade_otaker(%opts);
6385   my @statements = (
6386     # RT#10139, bug resulting in contract_end being set when it shouldn't
6387   'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
6388     # RT#10830, bad calculation of prorate date near end of year
6389     # the date range for bill is December 2009, and we move it forward
6390     # one year if it's before the previous bill date (which it should
6391     # never be)
6392   'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
6393   AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
6394   WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
6395     # RT6628, add order_date to cust_pkg
6396     'update cust_pkg set order_date = (select history_date from h_cust_pkg
6397         where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
6398         history_action = \'insert\') where order_date is null',
6399   );
6400   foreach my $sql (@statements) {
6401     my $sth = dbh->prepare($sql);
6402     $sth->execute or die $sth->errstr;
6403   }
6404
6405   # RT31194: supplemental package links that are deleted don't clean up
6406   # linked records
6407   my @pkglinknums = qsearch({
6408       'select'    => 'DISTINCT cust_pkg.pkglinknum',
6409       'table'     => 'cust_pkg',
6410       'addl_from' => ' LEFT JOIN part_pkg_link USING (pkglinknum) ',
6411       'extra_sql' => ' WHERE cust_pkg.pkglinknum IS NOT NULL
6412                         AND part_pkg_link.pkglinknum IS NULL',
6413   });
6414   foreach (@pkglinknums) {
6415     my $pkglinknum = $_->pkglinknum;
6416     warn "cleaning part_pkg_link #$pkglinknum\n";
6417     my $part_pkg_link = FS::part_pkg_link->new({pkglinknum => $pkglinknum});
6418     my $error = $part_pkg_link->remove_linked;
6419     die $error if $error;
6420   }
6421
6422   # RT#73607: canceling a package with billing addons sometimes changes its
6423   # pkgpart.
6424   # Find records where the last replace_new record for the package before it
6425   # was canceled has a different pkgpart from the package itself.
6426   my @cust_pkg = qsearch({
6427     'table' => 'cust_pkg',
6428     'select' => 'cust_pkg.*, h_cust_pkg.pkgpart AS h_pkgpart',
6429     'addl_from' => ' JOIN (
6430   SELECT pkgnum, MAX(historynum) AS historynum FROM h_cust_pkg
6431     WHERE cancel IS NULL
6432       AND history_action = \'replace_new\'
6433     GROUP BY pkgnum
6434   ) AS last_history USING (pkgnum)
6435   JOIN h_cust_pkg USING (historynum)',
6436     'extra_sql' => ' WHERE cust_pkg.cancel is not null
6437                      AND cust_pkg.pkgpart != h_cust_pkg.pkgpart'
6438   });
6439   foreach my $cust_pkg ( @cust_pkg ) {
6440     my $pkgnum = $cust_pkg->pkgnum;
6441     warn "fixing pkgpart on canceled pkg#$pkgnum\n";
6442     $cust_pkg->set('pkgpart', $cust_pkg->h_pkgpart);
6443     my $error = $cust_pkg->replace;
6444     die $error if $error;
6445   }
6446
6447 }
6448
6449 # will autoload in v4+
6450 sub rt_field_charge {
6451   my $self = shift;
6452   qsearch('rt_field_charge',{ 'pkgnum' => $self->pkgnum });
6453 }
6454
6455 =back
6456
6457 =head1 BUGS
6458
6459 sub order is not OO.  Perhaps it should be moved to FS::cust_main and made so?
6460
6461 In sub order, the @pkgparts array (passed by reference) is clobbered.
6462
6463 Also in sub order, no money is adjusted.  Once FS::part_pkg defines a standard
6464 method to pass dates to the recur_prog expression, it should do so.
6465
6466 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
6467 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
6468 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
6469 configuration values.  Probably need a subroutine which decides what to do
6470 based on whether or not we've fetched the user yet, rather than a hash.  See
6471 FS::UID and the TODO.
6472
6473 Now that things are transactional should the check in the insert method be
6474 moved to check ?
6475
6476 =head1 SEE ALSO
6477
6478 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
6479 L<FS::pkg_svc>, schema.html from the base documentation
6480
6481 =cut
6482
6483 1;