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   # Before going any further here: if the package is still in the pre-setup
2367   # state, it's safe to modify it in place. No need to charge/credit for
2368   # partial period, transfer usage pools, copy invoice details, or change any
2369   # dates. We DO need to "transfer" services (from the package to itself) to
2370   # check their validity on the new pkgpart.
2371   if ( ! $self->setup and ! $opt->{cust_pkg} and ! $opt->{cust_main} ) {
2372     foreach ( qw( locationnum pkgpart quantity refnum salesnum ) ) {
2373       if ( length($opt->{$_}) ) {
2374         $self->set($_, $opt->{$_});
2375       }
2376     }
2377     # almost. if the new pkgpart specifies start/adjourn/expire timers,
2378     # apply those.
2379     if ( !$same_pkgpart ) {
2380       $self->set_initial_timers;
2381     }
2382     # but if contract_end was explicitly specified, that overrides all else
2383     $self->set('contract_end', $opt->{'contract_end'})
2384       if $opt->{'contract_end'};
2385
2386     $error = $self->replace;
2387     if ( $error ) {
2388       $dbh->rollback if $oldAutoCommit;
2389       return "modifying package: $error";
2390     }
2391
2392     # check/convert services (only on pkgpart change, to avoid surprises
2393     # when editing locations)
2394     # (maybe do this if changing quantity?)
2395     if ( !$same_pkgpart ) {
2396
2397       $error = $self->transfer($self);
2398
2399       if ( $error and $error == 0 ) {
2400         $error = "transferring $error";
2401       } elsif ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2402         warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2403         $error = $self->transfer($self, 'change_svcpart'=>1 );
2404         if ($error and $error == 0) {
2405           $error = "converting $error";
2406         }
2407       }
2408
2409       if ($error > 0) {
2410         $error = "unable to transfer all services";
2411       }
2412
2413       if ( $error ) {
2414         $dbh->rollback if $oldAutoCommit;
2415         return $error;
2416       }
2417
2418     } # done transferring services
2419
2420     $dbh->commit if $oldAutoCommit;
2421     return $self;
2422
2423   }
2424
2425   my %hash = ();
2426
2427   my $time = time;
2428
2429   $hash{'setup'} = $time if $self->get('setup');
2430
2431   $hash{'change_date'} = $time;
2432   $hash{"change_$_"}  = $self->$_()
2433     foreach qw( pkgnum pkgpart locationnum );
2434
2435   my $unused_credit = 0;
2436   my $keep_dates = $opt->{'keep_dates'};
2437
2438   # Special case.  If the pkgpart is changing, and the customer is going to be
2439   # credited for remaining time, don't keep setup, bill, or last_bill dates,
2440   # and DO pass the flag to cancel() to credit the customer.  If the old
2441   # package had a setup date, set the new package's setup to the package
2442   # change date so that it has the same status as before.
2443   if ( $opt->{'pkgpart'}
2444        and $opt->{'pkgpart'} != $self->pkgpart
2445        and $self->part_pkg->option('unused_credit_change', 1) ) {
2446     $unused_credit = 1;
2447     $keep_dates = 0;
2448     $hash{'last_bill'} = '';
2449     $hash{'bill'} = '';
2450   }
2451
2452   if ( $keep_dates ) {
2453     foreach my $date ( qw(setup bill last_bill) ) {
2454       $hash{$date} = $self->getfield($date);
2455     }
2456   }
2457   # always keep the following dates
2458   foreach my $date (qw(order_date susp adjourn cancel expire resume
2459                     start_date contract_end)) {
2460     $hash{$date} = $self->getfield($date);
2461   }
2462   # but if contract_end was explicitly specified, that overrides all else
2463   $hash{'contract_end'} = $opt->{'contract_end'}
2464     if $opt->{'contract_end'};
2465
2466   # allow $opt->{'locationnum'} = '' to specifically set it to null
2467   # (i.e. customer default location)
2468   $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2469
2470   # usually this doesn't matter.  the two cases where it does are:
2471   # 1. unused_credit_change + pkgpart change + setup fee on the new package
2472   # and
2473   # 2. (more importantly) changing a package before it's billed
2474   $hash{'waive_setup'} = $self->waive_setup;
2475
2476   # if this package is scheduled for a future package change, preserve that
2477   $hash{'change_to_pkgnum'} = $self->change_to_pkgnum;
2478
2479   my $custnum = $self->custnum;
2480   if ( $opt->{cust_main} ) {
2481     my $cust_main = $opt->{cust_main};
2482     unless ( $cust_main->custnum ) {
2483       my $error = $cust_main->insert( @{ $opt->{cust_main_insert_args}||[] } );
2484       if ( $error ) {
2485         $dbh->rollback if $oldAutoCommit;
2486         return "inserting customer record: $error";
2487       }
2488     }
2489     $custnum = $cust_main->custnum;
2490   }
2491
2492   $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
2493
2494   my $cust_pkg;
2495   if ( $opt->{'cust_pkg'} ) {
2496     # The target package already exists; update it to show that it was
2497     # changed from this package.
2498     $cust_pkg = $opt->{'cust_pkg'};
2499
2500     # follow all the above rules for date changes, etc.
2501     foreach (keys %hash) {
2502       $cust_pkg->set($_, $hash{$_});
2503     }
2504     # except those that implement the future package change behavior
2505     foreach (qw(change_to_pkgnum start_date expire)) {
2506       $cust_pkg->set($_, '');
2507     }
2508
2509     $error = $cust_pkg->replace;
2510
2511   } else {
2512     # Create the new package.
2513     $cust_pkg = new FS::cust_pkg {
2514       custnum     => $custnum,
2515       locationnum => $opt->{'locationnum'},
2516       ( map {  $_ => ( $opt->{$_} || $self->$_() )  }
2517           qw( pkgpart quantity refnum salesnum )
2518       ),
2519       %hash,
2520     };
2521     $error = $cust_pkg->insert( 'change' => 1,
2522                                 'allow_pkgpart' => $same_pkgpart );
2523   }
2524   if ($error) {
2525     $dbh->rollback if $oldAutoCommit;
2526     return "inserting new package: $error";
2527   }
2528
2529   # Transfer services and cancel old package.
2530   # Enforce service limits only if this is a pkgpart change.
2531   local $FS::cust_svc::ignore_quantity;
2532   $FS::cust_svc::ignore_quantity = 1 if $same_pkgpart;
2533   $error = $self->transfer($cust_pkg);
2534   if ($error and $error == 0) {
2535     # $old_pkg->transfer failed.
2536     $dbh->rollback if $oldAutoCommit;
2537     return "transferring $error";
2538   }
2539
2540   if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2541     warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2542     $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
2543     if ($error and $error == 0) {
2544       # $old_pkg->transfer failed.
2545       $dbh->rollback if $oldAutoCommit;
2546       return "converting $error";
2547     }
2548   }
2549
2550   # We set unprotect_svcs when executing a "future package change".  It's
2551   # not a user-interactive operation, so returning an error means the
2552   # package change will just fail.  Rather than have that happen, we'll
2553   # let leftover services be deleted.
2554   if ($error > 0 and !$opt->{'unprotect_svcs'}) {
2555     # Transfers were successful, but we still had services left on the old
2556     # package.  We can't change the package under this circumstances, so abort.
2557     $dbh->rollback if $oldAutoCommit;
2558     return "unable to transfer all services";
2559   }
2560
2561   #reset usage if changing pkgpart
2562   # AND usage rollover is off (otherwise adds twice, now and at package bill)
2563   if ($self->pkgpart != $cust_pkg->pkgpart) {
2564     my $part_pkg = $cust_pkg->part_pkg;
2565     $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
2566                                                  ? ()
2567                                                  : ( 'null' => 1 )
2568                                    )
2569       if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
2570
2571     if ($error) {
2572       $dbh->rollback if $oldAutoCommit;
2573       return "setting usage values: $error";
2574     }
2575   } else {
2576     # if NOT changing pkgpart, transfer any usage pools over
2577     foreach my $usage ($self->cust_pkg_usage) {
2578       $usage->set('pkgnum', $cust_pkg->pkgnum);
2579       $error = $usage->replace;
2580       if ( $error ) {
2581         $dbh->rollback if $oldAutoCommit;
2582         return "transferring usage pools: $error";
2583       }
2584     }
2585   }
2586
2587   # transfer discounts, if we're not changing pkgpart
2588   if ( $same_pkgpart ) {
2589     foreach my $old_discount ($self->cust_pkg_discount_active) {
2590       # don't remove the old discount, we may still need to bill that package.
2591       my $new_discount = new FS::cust_pkg_discount {
2592         'pkgnum'      => $cust_pkg->pkgnum,
2593         'discountnum' => $old_discount->discountnum,
2594         'months_used' => $old_discount->months_used,
2595       };
2596       $error = $new_discount->insert;
2597       if ( $error ) {
2598         $dbh->rollback if $oldAutoCommit;
2599         return "transferring discounts: $error";
2600       }
2601     }
2602   }
2603
2604   # transfer (copy) invoice details
2605   foreach my $detail ($self->cust_pkg_detail) {
2606     my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
2607     $new_detail->set('pkgdetailnum', '');
2608     $new_detail->set('pkgnum', $cust_pkg->pkgnum);
2609     $error = $new_detail->insert;
2610     if ( $error ) {
2611       $dbh->rollback if $oldAutoCommit;
2612       return "transferring package notes: $error";
2613     }
2614   }
2615
2616   # transfer scheduled expire/adjourn reasons
2617   foreach my $action ('expire', 'adjourn') {
2618     if ( $cust_pkg->get($action) ) {
2619       my $reason = $self->last_cust_pkg_reason($action);
2620       if ( $reason ) {
2621         $reason->set('pkgnum', $cust_pkg->pkgnum);
2622         $error = $reason->replace;
2623         if ( $error ) {
2624           $dbh->rollback if $oldAutoCommit;
2625           return "transferring $action reason: $error";
2626         }
2627       }
2628     }
2629   }
2630
2631   my @new_supp_pkgs;
2632
2633   if ( !$opt->{'cust_pkg'} ) {
2634     # Order any supplemental packages.
2635     my $part_pkg = $cust_pkg->part_pkg;
2636     my @old_supp_pkgs = $self->supplemental_pkgs;
2637     foreach my $link ($part_pkg->supp_part_pkg_link) {
2638       my $old;
2639       foreach (@old_supp_pkgs) {
2640         if ($_->pkgpart == $link->dst_pkgpart) {
2641           $old = $_;
2642           $_->pkgpart(0); # so that it can't match more than once
2643         }
2644         last if $old;
2645       }
2646       # false laziness with FS::cust_main::Packages::order_pkg
2647       my $new = FS::cust_pkg->new({
2648           pkgpart       => $link->dst_pkgpart,
2649           pkglinknum    => $link->pkglinknum,
2650           custnum       => $custnum,
2651           main_pkgnum   => $cust_pkg->pkgnum,
2652           locationnum   => $cust_pkg->locationnum,
2653           start_date    => $cust_pkg->start_date,
2654           order_date    => $cust_pkg->order_date,
2655           expire        => $cust_pkg->expire,
2656           adjourn       => $cust_pkg->adjourn,
2657           contract_end  => $cust_pkg->contract_end,
2658           refnum        => $cust_pkg->refnum,
2659           discountnum   => $cust_pkg->discountnum,
2660           waive_setup   => $cust_pkg->waive_setup,
2661       });
2662       if ( $old and $opt->{'keep_dates'} ) {
2663         foreach (qw(setup bill last_bill)) {
2664           $new->set($_, $old->get($_));
2665         }
2666       }
2667       $error = $new->insert( allow_pkgpart => $same_pkgpart );
2668       # transfer services
2669       if ( $old ) {
2670         $error ||= $old->transfer($new);
2671       }
2672       if ( $error and $error > 0 ) {
2673         # no reason why this should ever fail, but still...
2674         $error = "Unable to transfer all services from supplemental package ".
2675           $old->pkgnum;
2676       }
2677       if ( $error ) {
2678         $dbh->rollback if $oldAutoCommit;
2679         return $error;
2680       }
2681       push @new_supp_pkgs, $new;
2682     }
2683   } # if !$opt->{'cust_pkg'}
2684     # because if there is one, then supplemental packages would already
2685     # have been created for it.
2686
2687   #Good to go, cancel old package.  Notify 'cancel' of whether to credit
2688   #remaining time.
2689   #Don't allow billing the package (preceding period packages and/or
2690   #outstanding usage) if we are keeping dates (i.e. location changing),
2691   #because the new package will be billed for the same date range.
2692   #Supplemental packages are also canceled here.
2693
2694   # during scheduled changes, avoid canceling the package we just
2695   # changed to (duh)
2696   $self->set('change_to_pkgnum' => '');
2697
2698   $error = $self->cancel(
2699     quiet          => 1,
2700     unused_credit  => $unused_credit,
2701     nobill         => $keep_dates,
2702     change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2703     no_delay_cancel => 1,
2704   );
2705   if ($error) {
2706     $dbh->rollback if $oldAutoCommit;
2707     return "canceling old package: $error";
2708   }
2709
2710   # transfer rt_field_charge, if we're not changing pkgpart
2711   # after billing of old package, before billing of new package
2712   if ( $same_pkgpart ) {
2713     foreach my $rt_field_charge ($self->rt_field_charge) {
2714       $rt_field_charge->set('pkgnum', $cust_pkg->pkgnum);
2715       $error = $rt_field_charge->replace;
2716       if ( $error ) {
2717         $dbh->rollback if $oldAutoCommit;
2718         return "transferring rt_field_charge: $error";
2719       }
2720     }
2721   }
2722
2723   if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2724     #$self->cust_main
2725     my $error = $cust_pkg->cust_main->bill(
2726       'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2727     );
2728     if ( $error ) {
2729       $dbh->rollback if $oldAutoCommit;
2730       return "billing new package: $error";
2731     }
2732   }
2733
2734   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2735
2736   $cust_pkg;
2737
2738 }
2739
2740 =item change_later OPTION => VALUE...
2741
2742 Schedule a package change for a later date.  This actually orders the new
2743 package immediately, but sets its start date for a future date, and sets
2744 the current package to expire on the same date.
2745
2746 If the package is already scheduled for a change, this can be called with
2747 'start_date' to change the scheduled date, or with pkgpart and/or
2748 locationnum to modify the package change.  To cancel the scheduled change
2749 entirely, see C<abort_change>.
2750
2751 Options include:
2752
2753 =over 4
2754
2755 =item start_date
2756
2757 The date for the package change.  Required, and must be in the future.
2758
2759 =item pkgpart
2760
2761 =item locationnum
2762
2763 =item quantity
2764
2765 =item contract_end
2766
2767 The pkgpart, locationnum, quantity and optional contract_end of the new
2768 package, with the same meaning as in C<change>.
2769
2770 =back
2771
2772 =cut
2773
2774 sub change_later {
2775   my $self = shift;
2776   my $opt = ref($_[0]) ? shift : { @_ };
2777
2778   # check contract_end, prevent adding/removing
2779   my $error = $self->_check_change($opt);
2780   return $error if $error;
2781
2782   my $oldAutoCommit = $FS::UID::AutoCommit;
2783   local $FS::UID::AutoCommit = 0;
2784   my $dbh = dbh;
2785
2786   my $cust_main = $self->cust_main;
2787
2788   my $date = delete $opt->{'start_date'} or return 'start_date required';
2789
2790   if ( $date <= time ) {
2791     $dbh->rollback if $oldAutoCommit;
2792     return "start_date $date is in the past";
2793   }
2794
2795   # If the user entered a new location, set it up now.
2796   if ( $opt->{'cust_location'} ) {
2797     $error = $opt->{'cust_location'}->find_or_insert;
2798     if ( $error ) {
2799       $dbh->rollback if $oldAutoCommit;
2800       return "creating location record: $error";
2801     }
2802     $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
2803   }
2804
2805   if ( $self->change_to_pkgnum ) {
2806     my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
2807     my $new_pkgpart = $opt->{'pkgpart'}
2808         if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $change_to->pkgpart;
2809     my $new_locationnum = $opt->{'locationnum'}
2810         if $opt->{'locationnum'} and $opt->{'locationnum'} != $change_to->locationnum;
2811     my $new_quantity = $opt->{'quantity'}
2812         if $opt->{'quantity'} and $opt->{'quantity'} != $change_to->quantity;
2813     my $new_contract_end = $opt->{'contract_end'}
2814         if $opt->{'contract_end'} and $opt->{'contract_end'} != $change_to->contract_end;
2815     if ( $new_pkgpart or $new_locationnum or $new_quantity or $new_contract_end ) {
2816       # it hasn't been billed yet, so in principle we could just edit
2817       # it in place (w/o a package change), but that's bad form.
2818       # So change the package according to the new options...
2819       my $err_or_pkg = $change_to->change(%$opt);
2820       if ( ref $err_or_pkg ) {
2821         # Then set that package up for a future start.
2822         $self->set('change_to_pkgnum', $err_or_pkg->pkgnum);
2823         $self->set('expire', $date); # in case it's different
2824         $err_or_pkg->set('start_date', $date);
2825         $err_or_pkg->set('change_date', '');
2826         $err_or_pkg->set('change_pkgnum', '');
2827
2828         $error = $self->replace       ||
2829                  $err_or_pkg->replace ||
2830                  #because change() might've edited existing scheduled change in place
2831                  (($err_or_pkg->pkgnum == $change_to->pkgnum) ? '' :
2832                   $change_to->cancel('no_delay_cancel' => 1) ||
2833                   $change_to->delete);
2834       } else {
2835         $error = $err_or_pkg;
2836       }
2837     } else { # change the start date only.
2838       $self->set('expire', $date);
2839       $change_to->set('start_date', $date);
2840       $error = $self->replace || $change_to->replace;
2841     }
2842     if ( $error ) {
2843       $dbh->rollback if $oldAutoCommit;
2844       return $error;
2845     } else {
2846       $dbh->commit if $oldAutoCommit;
2847       return '';
2848     }
2849   } # if $self->change_to_pkgnum
2850
2851   my $new_pkgpart = $opt->{'pkgpart'}
2852       if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2853   my $new_locationnum = $opt->{'locationnum'}
2854       if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2855   my $new_quantity = $opt->{'quantity'}
2856       if $opt->{'quantity'} and $opt->{'quantity'} != $self->quantity;
2857   my $new_contract_end = $opt->{'contract_end'}
2858       if $opt->{'contract_end'} and $opt->{'contract_end'} != $self->contract_end;
2859
2860   return '' unless $new_pkgpart or $new_locationnum or $new_quantity or $new_contract_end; # wouldn't do anything
2861
2862   # allow $opt->{'locationnum'} = '' to specifically set it to null
2863   # (i.e. customer default location)
2864   $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2865
2866   my $new = FS::cust_pkg->new( {
2867     custnum     => $self->custnum,
2868     locationnum => $opt->{'locationnum'},
2869     start_date  => $date,
2870     map   {  $_ => ( $opt->{$_} || $self->$_() )  }
2871       qw( pkgpart quantity refnum salesnum contract_end )
2872   } );
2873   $error = $new->insert('change' => 1,
2874                         'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2875   if ( !$error ) {
2876     $self->set('change_to_pkgnum', $new->pkgnum);
2877     $self->set('expire', $date);
2878     $error = $self->replace;
2879   }
2880   if ( $error ) {
2881     $dbh->rollback if $oldAutoCommit;
2882   } else {
2883     $dbh->commit if $oldAutoCommit;
2884   }
2885
2886   $error;
2887 }
2888
2889 =item abort_change
2890
2891 Cancels a future package change scheduled by C<change_later>.
2892
2893 =cut
2894
2895 sub abort_change {
2896   my $self = shift;
2897   my $pkgnum = $self->change_to_pkgnum;
2898   my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
2899   my $error;
2900   if ( $change_to ) {
2901     $error = $change_to->cancel || $change_to->delete;
2902     return $error if $error;
2903   }
2904   $self->set('change_to_pkgnum', '');
2905   $self->set('expire', '');
2906   $self->replace;
2907 }
2908
2909 =item set_quantity QUANTITY
2910
2911 Change the package's quantity field.  This is one of the few package properties
2912 that can safely be changed without canceling and reordering the package
2913 (because it doesn't affect tax eligibility).  Returns an error or an
2914 empty string.
2915
2916 =cut
2917
2918 sub set_quantity {
2919   my $self = shift;
2920   $self = $self->replace_old; # just to make sure
2921   $self->quantity(shift);
2922   $self->replace;
2923 }
2924
2925 =item set_salesnum SALESNUM
2926
2927 Change the package's salesnum (sales person) field.  This is one of the few
2928 package properties that can safely be changed without canceling and reordering
2929 the package (because it doesn't affect tax eligibility).  Returns an error or
2930 an empty string.
2931
2932 =cut
2933
2934 sub set_salesnum {
2935   my $self = shift;
2936   $self = $self->replace_old; # just to make sure
2937   $self->salesnum(shift);
2938   $self->replace;
2939   # XXX this should probably reassign any credit that's already been given
2940 }
2941
2942 =item modify_charge OPTIONS
2943
2944 Change the properties of a one-time charge.  The following properties can
2945 be changed this way:
2946 - pkg: the package description
2947 - classnum: the package class
2948 - additional: arrayref of additional invoice details to add to this package
2949
2950 and, I<if the charge has not yet been billed>:
2951 - start_date: the date when it will be billed
2952 - amount: the setup fee to be charged
2953 - quantity: the multiplier for the setup fee
2954 - separate_bill: whether to put the charge on a separate invoice
2955
2956 If you pass 'adjust_commission' => 1, and the classnum changes, and there are
2957 commission credits linked to this charge, they will be recalculated.
2958
2959 =cut
2960
2961 sub modify_charge {
2962   my $self = shift;
2963   my %opt = @_;
2964   my $part_pkg = $self->part_pkg;
2965   my $pkgnum = $self->pkgnum;
2966
2967   my $dbh = dbh;
2968   my $oldAutoCommit = $FS::UID::AutoCommit;
2969   local $FS::UID::AutoCommit = 0;
2970
2971   return "Can't use modify_charge except on one-time charges"
2972     unless $part_pkg->freq eq '0';
2973
2974   if ( length($opt{'pkg'}) and $part_pkg->pkg ne $opt{'pkg'} ) {
2975     $part_pkg->set('pkg', $opt{'pkg'});
2976   }
2977
2978   my %pkg_opt = $part_pkg->options;
2979   my $pkg_opt_modified = 0;
2980
2981   $opt{'additional'} ||= [];
2982   my $i;
2983   my @old_additional;
2984   foreach (grep /^additional/, keys %pkg_opt) {
2985     ($i) = ($_ =~ /^additional_info(\d+)$/);
2986     $old_additional[$i] = $pkg_opt{$_} if $i;
2987     delete $pkg_opt{$_};
2988   }
2989
2990   for ( $i = 0; exists($opt{'additional'}->[$i]); $i++ ) {
2991     $pkg_opt{ "additional_info$i" } = $opt{'additional'}->[$i];
2992     if (!exists($old_additional[$i])
2993         or $old_additional[$i] ne $opt{'additional'}->[$i])
2994     {
2995       $pkg_opt_modified = 1;
2996     }
2997   }
2998   $pkg_opt_modified = 1 if scalar(@old_additional) != $i;
2999   $pkg_opt{'additional_count'} = $i if $i > 0;
3000
3001   my $old_classnum;
3002   if ( exists($opt{'classnum'}) and $part_pkg->classnum ne $opt{'classnum'} )
3003   {
3004     # remember it
3005     $old_classnum = $part_pkg->classnum;
3006     $part_pkg->set('classnum', $opt{'classnum'});
3007   }
3008
3009   if ( !$self->get('setup') ) {
3010     # not yet billed, so allow amount, setup_cost, quantity, start_date,
3011     # and separate_bill
3012
3013     if ( exists($opt{'amount'})
3014           and $part_pkg->option('setup_fee') != $opt{'amount'}
3015           and $opt{'amount'} > 0 ) {
3016
3017       $pkg_opt{'setup_fee'} = $opt{'amount'};
3018       $pkg_opt_modified = 1;
3019     }
3020
3021     if ( exists($opt{'setup_cost'})
3022           and $part_pkg->setup_cost != $opt{'setup_cost'}
3023           and $opt{'setup_cost'} > 0 ) {
3024
3025       $part_pkg->set('setup_cost', $opt{'setup_cost'});
3026     }
3027
3028     if ( exists($opt{'quantity'})
3029           and $opt{'quantity'} != $self->quantity
3030           and $opt{'quantity'} > 0 ) {
3031
3032       $self->set('quantity', $opt{'quantity'});
3033     }
3034
3035     if ( exists($opt{'start_date'})
3036           and $opt{'start_date'} != $self->start_date ) {
3037
3038       $self->set('start_date', $opt{'start_date'});
3039     }
3040
3041     if ( exists($opt{'separate_bill'})
3042           and $opt{'separate_bill'} ne $self->separate_bill ) {
3043
3044       $self->set('separate_bill', $opt{'separate_bill'});
3045     }
3046
3047
3048   } # else simply ignore them; the UI shouldn't allow editing the fields
3049
3050   if ( exists($opt{'taxclass'})
3051           and $part_pkg->taxclass ne $opt{'taxclass'}) {
3052
3053       $part_pkg->set('taxclass', $opt{'taxclass'});
3054   }
3055
3056   my $error;
3057   if ( $part_pkg->modified or $pkg_opt_modified ) {
3058     # can we safely modify the package def?
3059     # Yes, if it's not available for purchase, and this is the only instance
3060     # of it.
3061     if ( $part_pkg->disabled
3062          and FS::cust_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 1
3063          and FS::quotation_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 0
3064        ) {
3065       $error = $part_pkg->replace( options => \%pkg_opt );
3066     } else {
3067       # clone it
3068       $part_pkg = $part_pkg->clone;
3069       $part_pkg->set('disabled' => 'Y');
3070       $error = $part_pkg->insert( options => \%pkg_opt );
3071       # and associate this as yet-unbilled package to the new package def
3072       $self->set('pkgpart' => $part_pkg->pkgpart);
3073     }
3074     if ( $error ) {
3075       $dbh->rollback if $oldAutoCommit;
3076       return $error;
3077     }
3078   }
3079
3080   if ($self->modified) { # for quantity or start_date change, or if we had
3081                          # to clone the existing package def
3082     my $error = $self->replace;
3083     return $error if $error;
3084   }
3085   if (defined $old_classnum) {
3086     # fix invoice grouping records
3087     my $old_catname = $old_classnum
3088                       ? FS::pkg_class->by_key($old_classnum)->categoryname
3089                       : '';
3090     my $new_catname = $opt{'classnum'}
3091                       ? $part_pkg->pkg_class->categoryname
3092                       : '';
3093     if ( $old_catname ne $new_catname ) {
3094       foreach my $cust_bill_pkg ($self->cust_bill_pkg) {
3095         # (there should only be one...)
3096         my @display = qsearch( 'cust_bill_pkg_display', {
3097             'billpkgnum'  => $cust_bill_pkg->billpkgnum,
3098             'section'     => $old_catname,
3099         });
3100         foreach (@display) {
3101           $_->set('section', $new_catname);
3102           $error = $_->replace;
3103           if ( $error ) {
3104             $dbh->rollback if $oldAutoCommit;
3105             return $error;
3106           }
3107         }
3108       } # foreach $cust_bill_pkg
3109     }
3110
3111     if ( $opt{'adjust_commission'} ) {
3112       # fix commission credits...tricky.
3113       foreach my $cust_event ($self->cust_event) {
3114         my $part_event = $cust_event->part_event;
3115         foreach my $table (qw(sales agent)) {
3116           my $class =
3117             "FS::part_event::Action::Mixin::credit_${table}_pkg_class";
3118           my $credit = qsearchs('cust_credit', {
3119               'eventnum' => $cust_event->eventnum,
3120           });
3121           if ( $part_event->isa($class) ) {
3122             # Yes, this results in current commission rates being applied
3123             # retroactively to a one-time charge.  For accounting purposes
3124             # there ought to be some kind of time limit on doing this.
3125             my $amount = $part_event->_calc_credit($self);
3126             if ( $credit and $credit->amount ne $amount ) {
3127               # Void the old credit.
3128               $error = $credit->void('Package class changed');
3129               if ( $error ) {
3130                 $dbh->rollback if $oldAutoCommit;
3131                 return "$error (adjusting commission credit)";
3132               }
3133             }
3134             # redo the event action to recreate the credit.
3135             local $@ = '';
3136             eval { $part_event->do_action( $self, $cust_event ) };
3137             if ( $@ ) {
3138               $dbh->rollback if $oldAutoCommit;
3139               return $@;
3140             }
3141           } # if $part_event->isa($class)
3142         } # foreach $table
3143       } # foreach $cust_event
3144     } # if $opt{'adjust_commission'}
3145   } # if defined $old_classnum
3146
3147   $dbh->commit if $oldAutoCommit;
3148   '';
3149 }
3150
3151 use Storable 'thaw';
3152 use MIME::Base64;
3153 use Data::Dumper;
3154 sub process_bulk_cust_pkg {
3155   my $job = shift;
3156   my $param = thaw(decode_base64(shift));
3157   warn Dumper($param) if $DEBUG;
3158
3159   my $old_part_pkg = qsearchs('part_pkg',
3160                               { pkgpart => $param->{'old_pkgpart'} });
3161   my $new_part_pkg = qsearchs('part_pkg',
3162                               { pkgpart => $param->{'new_pkgpart'} });
3163   die "Must select a new package type\n" unless $new_part_pkg;
3164   #my $keep_dates = $param->{'keep_dates'} || 0;
3165   my $keep_dates = 1; # there is no good reason to turn this off
3166
3167   local $SIG{HUP} = 'IGNORE';
3168   local $SIG{INT} = 'IGNORE';
3169   local $SIG{QUIT} = 'IGNORE';
3170   local $SIG{TERM} = 'IGNORE';
3171   local $SIG{TSTP} = 'IGNORE';
3172   local $SIG{PIPE} = 'IGNORE';
3173
3174   my $oldAutoCommit = $FS::UID::AutoCommit;
3175   local $FS::UID::AutoCommit = 0;
3176   my $dbh = dbh;
3177
3178   my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
3179
3180   my $i = 0;
3181   foreach my $old_cust_pkg ( @cust_pkgs ) {
3182     $i++;
3183     $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
3184     if ( $old_cust_pkg->getfield('cancel') ) {
3185       warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
3186         $old_cust_pkg->pkgnum."\n"
3187         if $DEBUG;
3188       next;
3189     }
3190     warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
3191       if $DEBUG;
3192     my $error = $old_cust_pkg->change(
3193       'pkgpart'     => $param->{'new_pkgpart'},
3194       'keep_dates'  => $keep_dates
3195     );
3196     if ( !ref($error) ) { # change returns the cust_pkg on success
3197       $dbh->rollback;
3198       die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
3199     }
3200   }
3201   $dbh->commit if $oldAutoCommit;
3202   return;
3203 }
3204
3205 =item last_bill
3206
3207 Returns the last bill date, or if there is no last bill date, the setup date.
3208 Useful for billing metered services.
3209
3210 =cut
3211
3212 sub last_bill {
3213   my $self = shift;
3214   return $self->setfield('last_bill', $_[0]) if @_;
3215   return $self->getfield('last_bill') if $self->getfield('last_bill');
3216   my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
3217                                                   'edate'  => $self->bill,  } );
3218   $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
3219 }
3220
3221 =item last_cust_pkg_reason ACTION
3222
3223 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
3224 Returns false if there is no reason or the package is not currenly ACTION'd
3225 ACTION is one of adjourn, susp, cancel, or expire.
3226
3227 =cut
3228
3229 sub last_cust_pkg_reason {
3230   my ( $self, $action ) = ( shift, shift );
3231   my $date = $self->get($action);
3232   qsearchs( {
3233               'table' => 'cust_pkg_reason',
3234               'hashref' => { 'pkgnum' => $self->pkgnum,
3235                              'action' => substr(uc($action), 0, 1),
3236                              'date'   => $date,
3237                            },
3238               'order_by' => 'ORDER BY num DESC LIMIT 1',
3239            } );
3240 }
3241
3242 =item last_reason ACTION
3243
3244 Returns the most recent ACTION FS::reason associated with the package.
3245 Returns false if there is no reason or the package is not currenly ACTION'd
3246 ACTION is one of adjourn, susp, cancel, or expire.
3247
3248 =cut
3249
3250 sub last_reason {
3251   my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
3252   $cust_pkg_reason->reason
3253     if $cust_pkg_reason;
3254 }
3255
3256 =item part_pkg
3257
3258 Returns the definition for this billing item, as an FS::part_pkg object (see
3259 L<FS::part_pkg>).
3260
3261 =cut
3262
3263 sub part_pkg {
3264   my $self = shift;
3265   return $self->{'_pkgpart'} if $self->{'_pkgpart'};
3266   cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
3267   qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
3268 }
3269
3270 =item old_cust_pkg
3271
3272 Returns the cancelled package this package was changed from, if any.
3273
3274 =cut
3275
3276 sub old_cust_pkg {
3277   my $self = shift;
3278   return '' unless $self->change_pkgnum;
3279   qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
3280 }
3281
3282 =item change_cust_main
3283
3284 Returns the customter this package was detached to, if any.
3285
3286 =cut
3287
3288 sub change_cust_main {
3289   my $self = shift;
3290   return '' unless $self->change_custnum;
3291   qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
3292 }
3293
3294 =item calc_setup
3295
3296 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
3297 item.
3298
3299 =cut
3300
3301 sub calc_setup {
3302   my $self = shift;
3303   $self->part_pkg->calc_setup($self, @_);
3304 }
3305
3306 =item calc_recur
3307
3308 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
3309 item.
3310
3311 =cut
3312
3313 sub calc_recur {
3314   my $self = shift;
3315   $self->part_pkg->calc_recur($self, @_);
3316 }
3317
3318 =item base_setup
3319
3320 Returns the base setup fee (per unit) of this package, from the package
3321 definition.
3322
3323 =cut
3324
3325 # minimal version for 3.x; in 4.x this can invoke currency conversion
3326
3327 sub base_setup {
3328   my $self = shift;
3329   $self->part_pkg->unit_setup($self);
3330 }
3331
3332 =item base_recur
3333
3334 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
3335 item.
3336
3337 =cut
3338
3339 sub base_recur {
3340   my $self = shift;
3341   $self->part_pkg->base_recur($self, @_);
3342 }
3343
3344 =item calc_remain
3345
3346 Calls the I<calc_remain> of the FS::part_pkg object associated with this
3347 billing item.
3348
3349 =cut
3350
3351 sub calc_remain {
3352   my $self = shift;
3353   $self->part_pkg->calc_remain($self, @_);
3354 }
3355
3356 =item calc_cancel
3357
3358 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
3359 billing item.
3360
3361 =cut
3362
3363 sub calc_cancel {
3364   my $self = shift;
3365   $self->part_pkg->calc_cancel($self, @_);
3366 }
3367
3368 =item cust_bill_pkg
3369
3370 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
3371
3372 =cut
3373
3374 sub cust_bill_pkg {
3375   my $self = shift;
3376   qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
3377 }
3378
3379 =item cust_pkg_detail [ DETAILTYPE ]
3380
3381 Returns any customer package details for this package (see
3382 L<FS::cust_pkg_detail>).
3383
3384 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
3385
3386 =cut
3387
3388 sub cust_pkg_detail {
3389   my $self = shift;
3390   my %hash = ( 'pkgnum' => $self->pkgnum );
3391   $hash{detailtype} = shift if @_;
3392   qsearch({
3393     'table'    => 'cust_pkg_detail',
3394     'hashref'  => \%hash,
3395     'order_by' => 'ORDER BY weight, pkgdetailnum',
3396   });
3397 }
3398
3399 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
3400
3401 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
3402
3403 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
3404
3405 If there is an error, returns the error, otherwise returns false.
3406
3407 =cut
3408
3409 sub set_cust_pkg_detail {
3410   my( $self, $detailtype, @details ) = @_;
3411
3412   local $SIG{HUP} = 'IGNORE';
3413   local $SIG{INT} = 'IGNORE';
3414   local $SIG{QUIT} = 'IGNORE';
3415   local $SIG{TERM} = 'IGNORE';
3416   local $SIG{TSTP} = 'IGNORE';
3417   local $SIG{PIPE} = 'IGNORE';
3418
3419   my $oldAutoCommit = $FS::UID::AutoCommit;
3420   local $FS::UID::AutoCommit = 0;
3421   my $dbh = dbh;
3422
3423   foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
3424     my $error = $current->delete;
3425     if ( $error ) {
3426       $dbh->rollback if $oldAutoCommit;
3427       return "error removing old detail: $error";
3428     }
3429   }
3430
3431   foreach my $detail ( @details ) {
3432     my $cust_pkg_detail = new FS::cust_pkg_detail {
3433       'pkgnum'     => $self->pkgnum,
3434       'detailtype' => $detailtype,
3435       'detail'     => $detail,
3436     };
3437     my $error = $cust_pkg_detail->insert;
3438     if ( $error ) {
3439       $dbh->rollback if $oldAutoCommit;
3440       return "error adding new detail: $error";
3441     }
3442
3443   }
3444
3445   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3446   '';
3447
3448 }
3449
3450 =item cust_event
3451
3452 Returns the customer billing events (see L<FS::cust_event>) for this invoice.
3453
3454 =cut
3455
3456 #false laziness w/cust_bill.pm
3457 sub cust_event {
3458   my $self = shift;
3459   qsearch({
3460     'table'     => 'cust_event',
3461     'addl_from' => 'JOIN part_event USING ( eventpart )',
3462     'hashref'   => { 'tablenum' => $self->pkgnum },
3463     'extra_sql' => " AND eventtable = 'cust_pkg' ",
3464   });
3465 }
3466
3467 =item num_cust_event
3468
3469 Returns the number of customer billing events (see L<FS::cust_event>) for this package.
3470
3471 =cut
3472
3473 #false laziness w/cust_bill.pm
3474 sub num_cust_event {
3475   my $self = shift;
3476   my $sql = "SELECT COUNT(*) ". $self->_from_cust_event_where;
3477   $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref->[0];
3478 }
3479
3480 =item exists_cust_event
3481
3482 Returns true if there are customer billing events (see L<FS::cust_event>) for this package.  More efficient than using num_cust_event.
3483
3484 =cut
3485
3486 sub exists_cust_event {
3487   my $self = shift;
3488   my $sql = "SELECT 1 ". $self->_from_cust_event_where. " LIMIT 1";
3489   my $row = $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref;
3490   $row ? $row->[0] : '';
3491 }
3492
3493 sub _from_cust_event_where {
3494   #my $self = shift;
3495   " FROM cust_event JOIN part_event USING ( eventpart ) ".
3496   "  WHERE tablenum = ? AND eventtable = 'cust_pkg' ";
3497 }
3498
3499 sub _prep_ex {
3500   my( $self, $sql, @args ) = @_;
3501   my $sth = dbh->prepare($sql) or die  dbh->errstr. " preparing $sql";
3502   $sth->execute(@args)         or die $sth->errstr. " executing $sql";
3503   $sth;
3504 }
3505
3506 =item cust_svc [ SVCPART ] (old, deprecated usage)
3507
3508 =item cust_svc [ OPTION => VALUE ... ] (current usage)
3509
3510 =item cust_svc_unsorted [ OPTION => VALUE ... ]
3511
3512 Returns the services for this package, as FS::cust_svc objects (see
3513 L<FS::cust_svc>).  Available options are svcpart and svcdb.  If either is
3514 spcififed, returns only the matching services.
3515
3516 As an optimization, use the cust_svc_unsorted version if you are not displaying
3517 the results.
3518
3519 =cut
3520
3521 sub cust_svc {
3522   my $self = shift;
3523   cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
3524   $self->_sort_cust_svc( $self->cust_svc_unsorted_arrayref(@_) );
3525 }
3526
3527 sub cust_svc_unsorted {
3528   my $self = shift;
3529   @{ $self->cust_svc_unsorted_arrayref(@_) };
3530 }
3531
3532 sub cust_svc_unsorted_arrayref {
3533   my $self = shift;
3534
3535   return [] unless $self->num_cust_svc(@_);
3536
3537   my %opt = ();
3538   if ( @_ && $_[0] =~ /^\d+/ ) {
3539     $opt{svcpart} = shift;
3540   } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3541     %opt = %{ $_[0] };
3542   } elsif ( @_ ) {
3543     %opt = @_;
3544   }
3545
3546   my %search = (
3547     'select'    => 'cust_svc.*, part_svc.*',
3548     'table'     => 'cust_svc',
3549     'hashref'   => { 'pkgnum' => $self->pkgnum },
3550     'addl_from' => 'LEFT JOIN part_svc USING ( svcpart )',
3551   );
3552   $search{hashref}->{svcpart} = $opt{svcpart}
3553     if $opt{svcpart};
3554   $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{svcdb} )
3555     if $opt{svcdb};
3556
3557   [ qsearch(\%search) ];
3558
3559 }
3560
3561 =item overlimit [ SVCPART ]
3562
3563 Returns the services for this package which have exceeded their
3564 usage limit as FS::cust_svc objects (see L<FS::cust_svc>).  If a svcpart
3565 is specified, return only the matching services.
3566
3567 =cut
3568
3569 sub overlimit {
3570   my $self = shift;
3571   return () unless $self->num_cust_svc(@_);
3572   grep { $_->overlimit } $self->cust_svc(@_);
3573 }
3574
3575 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3576
3577 Returns historical services for this package created before END TIMESTAMP and
3578 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
3579 (see L<FS::h_cust_svc>).  If MODE is 'I' (for 'invoice'), services with the
3580 I<pkg_svc.hidden> flag will be omitted.
3581
3582 =cut
3583
3584 sub h_cust_svc {
3585   my $self = shift;
3586   warn "$me _h_cust_svc called on $self\n"
3587     if $DEBUG;
3588
3589   my ($end, $start, $mode) = @_;
3590   my @cust_svc = $self->_sort_cust_svc(
3591     [ qsearch( 'h_cust_svc',
3592       { 'pkgnum' => $self->pkgnum, },
3593       FS::h_cust_svc->sql_h_search(@_),
3594     ) ]
3595   );
3596   if ( defined($mode) && $mode eq 'I' ) {
3597     my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
3598     return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
3599   } else {
3600     return @cust_svc;
3601   }
3602 }
3603
3604 sub _sort_cust_svc {
3605   my( $self, $arrayref ) = @_;
3606
3607   my $sort =
3608     sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1]  or  $a->[2] <=> $b->[2] };
3609
3610   my %pkg_svc = map { $_->svcpart => $_ }
3611                 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
3612
3613   map  { $_->[0] }
3614   sort $sort
3615   map {
3616         my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
3617         [ $_,
3618           $pkg_svc ? $pkg_svc->primary_svc : '',
3619           $pkg_svc ? $pkg_svc->quantity : 0,
3620         ];
3621       }
3622   @$arrayref;
3623
3624 }
3625
3626 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
3627
3628 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
3629
3630 Returns the number of services for this package.  Available options are svcpart
3631 and svcdb.  If either is spcififed, returns only the matching services.
3632
3633 =cut
3634
3635 sub num_cust_svc {
3636   my $self = shift;
3637
3638   return $self->{'_num_cust_svc'}
3639     if !scalar(@_)
3640        && exists($self->{'_num_cust_svc'})
3641        && $self->{'_num_cust_svc'} =~ /\d/;
3642
3643   cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
3644     if $DEBUG > 2;
3645
3646   my %opt = ();
3647   if ( @_ && $_[0] =~ /^\d+/ ) {
3648     $opt{svcpart} = shift;
3649   } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3650     %opt = %{ $_[0] };
3651   } elsif ( @_ ) {
3652     %opt = @_;
3653   }
3654
3655   my $select = 'SELECT COUNT(*) FROM cust_svc ';
3656   my $where = ' WHERE pkgnum = ? ';
3657   my @param = ($self->pkgnum);
3658
3659   if ( $opt{'svcpart'} ) {
3660     $where .= ' AND svcpart = ? ';
3661     push @param, $opt{'svcpart'};
3662   }
3663   if ( $opt{'svcdb'} ) {
3664     $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
3665     $where .= ' AND svcdb = ? ';
3666     push @param, $opt{'svcdb'};
3667   }
3668
3669   my $sth = dbh->prepare("$select $where") or die  dbh->errstr;
3670   $sth->execute(@param) or die $sth->errstr;
3671   $sth->fetchrow_arrayref->[0];
3672 }
3673
3674 =item available_part_svc
3675
3676 Returns a list of FS::part_svc objects representing services included in this
3677 package but not yet provisioned.  Each FS::part_svc object also has an extra
3678 field, I<num_avail>, which specifies the number of available services.
3679
3680 Accepts option I<provision_hold>;  if true, only returns part_svc for which the
3681 associated pkg_svc has the provision_hold flag set.
3682
3683 =cut
3684
3685 sub available_part_svc {
3686   my $self = shift;
3687   my %opt  = @_;
3688
3689   my $pkg_quantity = $self->quantity || 1;
3690
3691   grep { $_->num_avail > 0 }
3692   map {
3693     my $part_svc = $_->part_svc;
3694     $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
3695     $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
3696
3697     # more evil encapsulation breakage
3698     if ($part_svc->{'Hash'}{'num_avail'} > 0) {
3699       my @exports = $part_svc->part_export_did;
3700       $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
3701         }
3702
3703     $part_svc;
3704   }
3705   grep { $opt{'provision_hold'} ? $_->provision_hold : 1 }
3706   $self->part_pkg->pkg_svc;
3707 }
3708
3709 =item part_svc [ OPTION => VALUE ... ]
3710
3711 Returns a list of FS::part_svc objects representing provisioned and available
3712 services included in this package.  Each FS::part_svc object also has the
3713 following extra fields:
3714
3715 =over 4
3716
3717 =item num_cust_svc
3718
3719 (count)
3720
3721 =item num_avail
3722
3723 (quantity - count)
3724
3725 =item cust_pkg_svc
3726
3727 (services) - array reference containing the provisioned services, as cust_svc objects
3728
3729 =back
3730
3731 Accepts two options:
3732
3733 =over 4
3734
3735 =item summarize_size
3736
3737 If true, will omit the extra cust_pkg_svc option for objects where num_cust_svc
3738 is this size or greater.
3739
3740 =item hide_discontinued
3741
3742 If true, will omit looking for services that are no longer avaialble in the
3743 package definition.
3744
3745 =back
3746
3747 =cut
3748
3749 #svcnum
3750 #label -> ($cust_svc->label)[1]
3751
3752 sub part_svc {
3753   my $self = shift;
3754   my %opt = @_;
3755
3756   my $pkg_quantity = $self->quantity || 1;
3757
3758   #XXX some sort of sort order besides numeric by svcpart...
3759   my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
3760     my $pkg_svc = $_;
3761     my $part_svc = $pkg_svc->part_svc;
3762     my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3763     $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
3764     $part_svc->{'Hash'}{'num_avail'}    =
3765       max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
3766     $part_svc->{'Hash'}{'cust_pkg_svc'} =
3767         $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
3768       unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
3769           && $num_cust_svc >= $opt{summarize_size};
3770     $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
3771     $part_svc;
3772   } $self->part_pkg->pkg_svc;
3773
3774   unless ( $opt{hide_discontinued} ) {
3775     #extras
3776     push @part_svc, map {
3777       my $part_svc = $_;
3778       my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3779       $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
3780       $part_svc->{'Hash'}{'num_avail'}    = 0; #0-$num_cust_svc ?
3781       $part_svc->{'Hash'}{'cust_pkg_svc'} =
3782         $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
3783       $part_svc;
3784     } $self->extra_part_svc;
3785   }
3786
3787   @part_svc;
3788
3789 }
3790
3791 =item extra_part_svc
3792
3793 Returns a list of FS::part_svc objects corresponding to services in this
3794 package which are still provisioned but not (any longer) available in the
3795 package definition.
3796
3797 =cut
3798
3799 sub extra_part_svc {
3800   my $self = shift;
3801
3802   my $pkgnum  = $self->pkgnum;
3803   #my $pkgpart = $self->pkgpart;
3804
3805 #  qsearch( {
3806 #    'table'     => 'part_svc',
3807 #    'hashref'   => {},
3808 #    'extra_sql' =>
3809 #      "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
3810 #                     WHERE pkg_svc.svcpart = part_svc.svcpart
3811 #                       AND pkg_svc.pkgpart = ?
3812 #                       AND quantity > 0
3813 #                 )
3814 #        AND 0 < ( SELECT COUNT(*) FROM cust_svc
3815 #                       LEFT JOIN cust_pkg USING ( pkgnum )
3816 #                     WHERE cust_svc.svcpart = part_svc.svcpart
3817 #                       AND pkgnum = ?
3818 #                 )",
3819 #    'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
3820 #  } );
3821
3822 #seems to benchmark slightly faster... (or did?)
3823
3824   my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
3825   my $pkgparts = join(',', @pkgparts);
3826
3827   qsearch( {
3828     #'select'      => 'DISTINCT ON (svcpart) part_svc.*',
3829     #MySQL doesn't grok DISINCT ON
3830     'select'      => 'DISTINCT part_svc.*',
3831     'table'       => 'part_svc',
3832     'addl_from'   =>
3833       "LEFT JOIN pkg_svc  ON (     pkg_svc.svcpart   = part_svc.svcpart
3834                                AND pkg_svc.pkgpart IN ($pkgparts)
3835                                AND quantity > 0
3836                              )
3837        LEFT JOIN cust_svc ON (     cust_svc.svcpart = part_svc.svcpart )
3838        LEFT JOIN cust_pkg USING ( pkgnum )
3839       ",
3840     'hashref'     => {},
3841     'extra_sql'   => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
3842     'extra_param' => [ [$self->pkgnum=>'int'] ],
3843   } );
3844 }
3845
3846 =item status
3847
3848 Returns a short status string for this package, currently:
3849
3850 =over 4
3851
3852 =item on hold
3853
3854 =item not yet billed
3855
3856 =item one-time charge
3857
3858 =item active
3859
3860 =item suspended
3861
3862 =item cancelled
3863
3864 =back
3865
3866 =cut
3867
3868 sub status {
3869   my $self = shift;
3870
3871   my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
3872
3873   return 'cancelled' if $self->get('cancel');
3874   return 'on hold' if $self->susp && ! $self->setup;
3875   return 'suspended' if $self->susp;
3876   return 'not yet billed' unless $self->setup;
3877   return 'one-time charge' if $freq =~ /^(0|$)/;
3878   return 'active';
3879 }
3880
3881 =item ucfirst_status
3882
3883 Returns the status with the first character capitalized.
3884
3885 =cut
3886
3887 sub ucfirst_status {
3888   ucfirst(shift->status);
3889 }
3890
3891 =item statuses
3892
3893 Class method that returns the list of possible status strings for packages
3894 (see L<the status method|/status>).  For example:
3895
3896   @statuses = FS::cust_pkg->statuses();
3897
3898 =cut
3899
3900 tie my %statuscolor, 'Tie::IxHash',
3901   'on hold'         => 'FF00F5', #brighter purple!
3902   'not yet billed'  => '009999', #teal? cyan?
3903   'one-time charge' => '0000CC', #blue  #'000000',
3904   'active'          => '00CC00',
3905   'suspended'       => 'FF9900',
3906   'cancelled'       => 'FF0000',
3907 ;
3908
3909 sub statuses {
3910   my $self = shift; #could be class...
3911   #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
3912   #                                    # mayble split btw one-time vs. recur
3913     keys %statuscolor;
3914 }
3915
3916 sub statuscolors {
3917   #my $self = shift;
3918   \%statuscolor;
3919 }
3920
3921 =item statuscolor
3922
3923 Returns a hex triplet color string for this package's status.
3924
3925 =cut
3926
3927 sub statuscolor {
3928   my $self = shift;
3929   $statuscolor{$self->status};
3930 }
3931
3932 =item is_status_delay_cancel
3933
3934 Returns true if part_pkg has option delay_cancel,
3935 cust_pkg status is 'suspended' and expire is set
3936 to cancel package within the next day (or however
3937 many days are set in global config part_pkg-delay_cancel-days.
3938
3939 Accepts option I<part_pkg-delay_cancel-days> which should be
3940 the value of the config setting, to avoid looking it up again.
3941
3942 This is not a real status, this only meant for hacking display
3943 values, because otherwise treating the package as suspended is
3944 really the whole point of the delay_cancel option.
3945
3946 =cut
3947
3948 sub is_status_delay_cancel {
3949   my ($self,%opt) = @_;
3950   if ( $self->main_pkgnum and $self->pkglinknum ) {
3951     return $self->main_pkg->is_status_delay_cancel;
3952   }
3953   return 0 unless $self->part_pkg->option('delay_cancel',1);
3954   return 0 unless $self->status eq 'suspended';
3955   return 0 unless $self->expire;
3956   my $expdays = $opt{'part_pkg-delay_cancel-days'};
3957   unless ($expdays) {
3958     my $conf = new FS::Conf;
3959     $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
3960   }
3961   my $expsecs = 60*60*24*$expdays;
3962   return 0 unless $self->expire < time + $expsecs;
3963   return 1;
3964 }
3965
3966 =item pkg_label
3967
3968 Returns a label for this package.  (Currently "pkgnum: pkg - comment" or
3969 "pkg - comment" depending on user preference).
3970
3971 =cut
3972
3973 sub pkg_label {
3974   my $self = shift;
3975   my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
3976   $label = $self->pkgnum. ": $label"
3977     if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
3978   $label;
3979 }
3980
3981 =item pkg_label_long
3982
3983 Returns a long label for this package, adding the primary service's label to
3984 pkg_label.
3985
3986 =cut
3987
3988 sub pkg_label_long {
3989   my $self = shift;
3990   my $label = $self->pkg_label;
3991   my $cust_svc = $self->primary_cust_svc;
3992   $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
3993   $label;
3994 }
3995
3996 =item pkg_locale
3997
3998 Returns a customer-localized label for this package.
3999
4000 =cut
4001
4002 sub pkg_locale {
4003   my $self = shift;
4004   $self->part_pkg->pkg_locale( $self->cust_main->locale );
4005 }
4006
4007 =item primary_cust_svc
4008
4009 Returns a primary service (as FS::cust_svc object) if one can be identified.
4010
4011 =cut
4012
4013 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
4014
4015 sub primary_cust_svc {
4016   my $self = shift;
4017
4018   my @cust_svc = $self->cust_svc;
4019
4020   return '' unless @cust_svc; #no serivces - irrelevant then
4021
4022   return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
4023
4024   # primary service as specified in the package definition
4025   # or exactly one service definition with quantity one
4026   my $svcpart = $self->part_pkg->svcpart;
4027   @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
4028   return $cust_svc[0] if scalar(@cust_svc) == 1;
4029
4030   #couldn't identify one thing..
4031   return '';
4032 }
4033
4034 =item labels
4035
4036 Returns a list of lists, calling the label method for all services
4037 (see L<FS::cust_svc>) of this billing item.
4038
4039 =cut
4040
4041 sub labels {
4042   my $self = shift;
4043   map { [ $_->label ] } $self->cust_svc;
4044 }
4045
4046 =item h_labels END_TIMESTAMP [, START_TIMESTAMP [, MODE [, LOCALE ] ] ]
4047
4048 Like the labels method, but returns historical information on services that
4049 were active as of END_TIMESTAMP and (optionally) not cancelled before
4050 START_TIMESTAMP.  If MODE is 'I' (for 'invoice'), services with the
4051 I<pkg_svc.hidden> flag will be omitted.
4052
4053 If LOCALE is passed, service definition names will be localized.
4054
4055 Returns a list of lists, calling the label method for all (historical)
4056 services (see L<FS::h_cust_svc>) of this billing item.
4057
4058 =cut
4059
4060 sub h_labels {
4061   my $self = shift;
4062   my ($end, $start, $mode, $locale) = @_;
4063   warn "$me h_labels\n"
4064     if $DEBUG;
4065   map { [ $_->label($end, $start, $locale) ] }
4066         $self->h_cust_svc($end, $start, $mode);
4067 }
4068
4069 =item labels_short
4070
4071 Like labels, except returns a simple flat list, and shortens long
4072 (currently >5 or the cust_bill-max_same_services configuration value) lists of
4073 identical services to one line that lists the service label and the number of
4074 individual services rather than individual items.
4075
4076 =cut
4077
4078 sub labels_short {
4079   shift->_labels_short( 'labels' ); # 'labels' takes no further arguments
4080 }
4081
4082 =item h_labels_short END_TIMESTAMP [, START_TIMESTAMP [, MODE [, LOCALE ] ] ]
4083
4084 Like h_labels, except returns a simple flat list, and shortens long
4085 (currently >5 or the cust_bill-max_same_services configuration value) lists
4086 of identical services to one line that lists the service label and the
4087 number of individual services rather than individual items.
4088
4089 =cut
4090
4091 sub h_labels_short {
4092   shift->_labels_short( 'h_labels', @_ );
4093 }
4094
4095 # takes a method name ('labels' or 'h_labels') and all its arguments;
4096 # maybe should be "shorten($self->h_labels( ... ) )"
4097
4098 sub _labels_short {
4099   my( $self, $method ) = ( shift, shift );
4100
4101   warn "$me _labels_short called on $self with $method method\n"
4102     if $DEBUG;
4103
4104   my $conf = new FS::Conf;
4105   my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
4106
4107   warn "$me _labels_short populating \%labels\n"
4108     if $DEBUG;
4109
4110   my %labels;
4111   #tie %labels, 'Tie::IxHash';
4112   push @{ $labels{$_->[0]} }, $_->[1]
4113     foreach $self->$method(@_);
4114
4115   warn "$me _labels_short populating \@labels\n"
4116     if $DEBUG;
4117
4118   my @labels;
4119   foreach my $label ( keys %labels ) {
4120     my %seen = ();
4121     my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
4122     my $num = scalar(@values);
4123     warn "$me _labels_short $num items for $label\n"
4124       if $DEBUG;
4125
4126     if ( $num > $max_same_services ) {
4127       warn "$me _labels_short   more than $max_same_services, so summarizing\n"
4128         if $DEBUG;
4129       push @labels, "$label ($num)";
4130     } else {
4131       if ( $conf->exists('cust_bill-consolidate_services') ) {
4132         warn "$me _labels_short   consolidating services\n"
4133           if $DEBUG;
4134         # push @labels, "$label: ". join(', ', @values);
4135         while ( @values ) {
4136           my $detail = "$label: ";
4137           $detail .= shift(@values). ', '
4138             while @values
4139                && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
4140           $detail =~ s/, $//;
4141           push @labels, $detail;
4142         }
4143         warn "$me _labels_short   done consolidating services\n"
4144           if $DEBUG;
4145       } else {
4146         warn "$me _labels_short   adding service data\n"
4147           if $DEBUG;
4148         push @labels, map { "$label: $_" } @values;
4149       }
4150     }
4151   }
4152
4153  @labels;
4154
4155 }
4156
4157 =item cust_main
4158
4159 Returns the parent customer object (see L<FS::cust_main>).
4160
4161 =cut
4162
4163 sub cust_main {
4164   my $self = shift;
4165   cluck 'cust_pkg->cust_main called' if $DEBUG;
4166   qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
4167 }
4168
4169 =item balance
4170
4171 Returns the balance for this specific package, when using
4172 experimental package balance.
4173
4174 =cut
4175
4176 sub balance {
4177   my $self = shift;
4178   $self->cust_main->balance_pkgnum( $self->pkgnum );
4179 }
4180
4181 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
4182
4183 =item cust_location
4184
4185 Returns the location object, if any (see L<FS::cust_location>).
4186
4187 =item cust_location_or_main
4188
4189 If this package is associated with a location, returns the locaiton (see
4190 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
4191
4192 =item location_label [ OPTION => VALUE ... ]
4193
4194 Returns the label of the location object (see L<FS::cust_location>).
4195
4196 =cut
4197
4198 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
4199
4200 =item tax_locationnum
4201
4202 Returns the foreign key to a L<FS::cust_location> object for calculating
4203 tax on this package, as determined by the C<tax-pkg_address> and
4204 C<tax-ship_address> configuration flags.
4205
4206 =cut
4207
4208 sub tax_locationnum {
4209   my $self = shift;
4210   my $conf = FS::Conf->new;
4211   if ( $conf->exists('tax-pkg_address') ) {
4212     return $self->locationnum;
4213   }
4214   elsif ( $conf->exists('tax-ship_address') ) {
4215     return $self->cust_main->ship_locationnum;
4216   }
4217   else {
4218     return $self->cust_main->bill_locationnum;
4219   }
4220 }
4221
4222 =item tax_location
4223
4224 Returns the L<FS::cust_location> object for tax_locationnum.
4225
4226 =cut
4227
4228 sub tax_location {
4229   my $self = shift;
4230   my $conf = FS::Conf->new;
4231   if ( $conf->exists('tax-pkg_address') and $self->locationnum ) {
4232     return FS::cust_location->by_key($self->locationnum);
4233   }
4234   elsif ( $conf->exists('tax-ship_address') ) {
4235     return $self->cust_main->ship_location;
4236   }
4237   else {
4238     return $self->cust_main->bill_location;
4239   }
4240 }
4241
4242 =item seconds_since TIMESTAMP
4243
4244 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
4245 package have been online since TIMESTAMP, according to the session monitor.
4246
4247 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
4248 L<Time::Local> and L<Date::Parse> for conversion functions.
4249
4250 =cut
4251
4252 sub seconds_since {
4253   my($self, $since) = @_;
4254   my $seconds = 0;
4255
4256   foreach my $cust_svc (
4257     grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
4258   ) {
4259     $seconds += $cust_svc->seconds_since($since);
4260   }
4261
4262   $seconds;
4263
4264 }
4265
4266 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
4267
4268 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
4269 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
4270 (exclusive).
4271
4272 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
4273 L<perlfunc/"time">.  Also see L<Time::Local> and L<Date::Parse> for conversion
4274 functions.
4275
4276
4277 =cut
4278
4279 sub seconds_since_sqlradacct {
4280   my($self, $start, $end) = @_;
4281
4282   my $seconds = 0;
4283
4284   foreach my $cust_svc (
4285     grep {
4286       my $part_svc = $_->part_svc;
4287       $part_svc->svcdb eq 'svc_acct'
4288         && scalar($part_svc->part_export_usage);
4289     } $self->cust_svc
4290   ) {
4291     $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
4292   }
4293
4294   $seconds;
4295
4296 }
4297
4298 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
4299
4300 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
4301 in this package for sessions ending between TIMESTAMP_START (inclusive) and
4302 TIMESTAMP_END
4303 (exclusive).
4304
4305 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
4306 L<perlfunc/"time">.  Also see L<Time::Local> and L<Date::Parse> for conversion
4307 functions.
4308
4309 =cut
4310
4311 sub attribute_since_sqlradacct {
4312   my($self, $start, $end, $attrib) = @_;
4313
4314   my $sum = 0;
4315
4316   foreach my $cust_svc (
4317     grep {
4318       my $part_svc = $_->part_svc;
4319       scalar($part_svc->part_export_usage);
4320     } $self->cust_svc
4321   ) {
4322     $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
4323   }
4324
4325   $sum;
4326
4327 }
4328
4329 =item quantity
4330
4331 =cut
4332
4333 sub quantity {
4334   my( $self, $value ) = @_;
4335   if ( defined($value) ) {
4336     $self->setfield('quantity', $value);
4337   }
4338   $self->getfield('quantity') || 1;
4339 }
4340
4341 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
4342
4343 Transfers as many services as possible from this package to another package.
4344
4345 The destination package can be specified by pkgnum by passing an FS::cust_pkg
4346 object.  The destination package must already exist.
4347
4348 Services are moved only if the destination allows services with the correct
4349 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true.  Use
4350 this option with caution!  No provision is made for export differences
4351 between the old and new service definitions.  Probably only should be used
4352 when your exports for all service definitions of a given svcdb are identical.
4353 (attempt a transfer without it first, to move all possible svcpart-matching
4354 services)
4355
4356 Any services that can't be moved remain in the original package.
4357
4358 Returns an error, if there is one; otherwise, returns the number of services
4359 that couldn't be moved.
4360
4361 =cut
4362
4363 sub transfer {
4364   my ($self, $dest_pkgnum, %opt) = @_;
4365
4366   my $remaining = 0;
4367   my $dest;
4368   my %target;
4369
4370   if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
4371     $dest = $dest_pkgnum;
4372     $dest_pkgnum = $dest->pkgnum;
4373   } else {
4374     $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
4375   }
4376
4377   return ('Package does not exist: '.$dest_pkgnum) unless $dest;
4378
4379   foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
4380     $target{$pkg_svc->svcpart} = $pkg_svc->quantity * ( $dest->quantity || 1 );
4381   }
4382
4383   unless ( $self->pkgnum == $dest->pkgnum ) {
4384     foreach my $cust_svc ($dest->cust_svc) {
4385       $target{$cust_svc->svcpart}--;
4386     }
4387   }
4388
4389   my %svcpart2svcparts = ();
4390   if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
4391     warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
4392     foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
4393       next if exists $svcpart2svcparts{$svcpart};
4394       my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
4395       $svcpart2svcparts{$svcpart} = [
4396         map  { $_->[0] }
4397         sort { $b->[1] cmp $a->[1]  or  $a->[2] <=> $b->[2] }
4398         map {
4399               my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
4400                                                    'svcpart' => $_          } );
4401               [ $_,
4402                 $pkg_svc ? $pkg_svc->primary_svc : '',
4403                 $pkg_svc ? $pkg_svc->quantity : 0,
4404               ];
4405             }
4406
4407         grep { $_ != $svcpart }
4408         map  { $_->svcpart }
4409         qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
4410       ];
4411       warn "alternates for svcpart $svcpart: ".
4412            join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
4413         if $DEBUG;
4414     }
4415   }
4416
4417   my $error;
4418   foreach my $cust_svc ($self->cust_svc) {
4419     my $svcnum = $cust_svc->svcnum;
4420
4421     if (    $target{$cust_svc->svcpart} > 0
4422          or $FS::cust_svc::ignore_quantity # maybe should be a 'force' option
4423        )
4424     {
4425       $target{$cust_svc->svcpart}--;
4426
4427       local $FS::cust_svc::ignore_quantity = 1
4428         if $self->pkgnum == $dest->pkgnum;
4429
4430       #why run replace at all in the $self->pkgnum == $dest->pkgnum case?
4431       # we do want to trigger location and pkg_change exports, but
4432       # without pkgnum changing from an old to new package, cust_svc->replace
4433       # doesn't know how to trigger those.  :/
4434       # does this mean we scrap the whole idea of "safe to modify it in place",
4435       # or do we special-case and pass the info needed to cust_svc->replace? :/
4436
4437       my $new = new FS::cust_svc { $cust_svc->hash };
4438       $new->pkgnum($dest_pkgnum);
4439       $error = $new->replace($cust_svc);
4440
4441     } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
4442
4443       if ( $DEBUG ) {
4444         warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
4445         warn "alternates to consider: ".
4446              join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
4447       }
4448
4449       my @alternate = grep {
4450                              warn "considering alternate svcpart $_: ".
4451                                   "$target{$_} available in new package\n"
4452                                if $DEBUG;
4453                              $target{$_} > 0;
4454                            } @{$svcpart2svcparts{$cust_svc->svcpart}};
4455
4456       if ( @alternate ) {
4457         warn "alternate(s) found\n" if $DEBUG;
4458         my $change_svcpart = $alternate[0];
4459         $target{$change_svcpart}--;
4460         my $new = new FS::cust_svc { $cust_svc->hash };
4461         $new->svcpart($change_svcpart);
4462         $new->pkgnum($dest_pkgnum);
4463         $error = $new->replace($cust_svc);
4464       } else {
4465         $remaining++;
4466       }
4467
4468     } else {
4469       $remaining++
4470     }
4471
4472     if ( $error ) {
4473       my @label = $cust_svc->label;
4474       return "service $label[1]: $error";
4475     }
4476
4477   }
4478   return $remaining;
4479 }
4480
4481 =item grab_svcnums SVCNUM, SVCNUM ...
4482
4483 Change the pkgnum for the provided services to this packages.  If there is an
4484 error, returns the error, otherwise returns false.
4485
4486 =cut
4487
4488 sub grab_svcnums {
4489   my $self = shift;
4490   my @svcnum = @_;
4491
4492   local $SIG{HUP} = 'IGNORE';
4493   local $SIG{INT} = 'IGNORE';
4494   local $SIG{QUIT} = 'IGNORE';
4495   local $SIG{TERM} = 'IGNORE';
4496   local $SIG{TSTP} = 'IGNORE';
4497   local $SIG{PIPE} = 'IGNORE';
4498
4499   my $oldAutoCommit = $FS::UID::AutoCommit;
4500   local $FS::UID::AutoCommit = 0;
4501   my $dbh = dbh;
4502
4503   foreach my $svcnum (@svcnum) {
4504     my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
4505       $dbh->rollback if $oldAutoCommit;
4506       return "unknown svcnum $svcnum";
4507     };
4508     $cust_svc->pkgnum( $self->pkgnum );
4509     my $error = $cust_svc->replace;
4510     if ( $error ) {
4511       $dbh->rollback if $oldAutoCommit;
4512       return $error;
4513     }
4514   }
4515
4516   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4517   '';
4518
4519 }
4520
4521 =item reexport
4522
4523 This method is deprecated.  See the I<depend_jobnum> option to the insert and
4524 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
4525
4526 =cut
4527
4528 sub reexport {
4529   my $self = shift;
4530
4531   local $SIG{HUP} = 'IGNORE';
4532   local $SIG{INT} = 'IGNORE';
4533   local $SIG{QUIT} = 'IGNORE';
4534   local $SIG{TERM} = 'IGNORE';
4535   local $SIG{TSTP} = 'IGNORE';
4536   local $SIG{PIPE} = 'IGNORE';
4537
4538   my $oldAutoCommit = $FS::UID::AutoCommit;
4539   local $FS::UID::AutoCommit = 0;
4540   my $dbh = dbh;
4541
4542   foreach my $cust_svc ( $self->cust_svc ) {
4543     #false laziness w/svc_Common::insert
4544     my $svc_x = $cust_svc->svc_x;
4545     foreach my $part_export ( $cust_svc->part_svc->part_export ) {
4546       my $error = $part_export->export_insert($svc_x);
4547       if ( $error ) {
4548         $dbh->rollback if $oldAutoCommit;
4549         return $error;
4550       }
4551     }
4552   }
4553
4554   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4555   '';
4556
4557 }
4558
4559 =item export_pkg_change OLD_CUST_PKG
4560
4561 Calls the "pkg_change" export action for all services attached to this package.
4562
4563 =cut
4564
4565 sub export_pkg_change {
4566   my( $self, $old )  = ( shift, shift );
4567
4568   local $SIG{HUP} = 'IGNORE';
4569   local $SIG{INT} = 'IGNORE';
4570   local $SIG{QUIT} = 'IGNORE';
4571   local $SIG{TERM} = 'IGNORE';
4572   local $SIG{TSTP} = 'IGNORE';
4573   local $SIG{PIPE} = 'IGNORE';
4574
4575   my $oldAutoCommit = $FS::UID::AutoCommit;
4576   local $FS::UID::AutoCommit = 0;
4577   my $dbh = dbh;
4578
4579   foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
4580     my $error = $svc_x->export('pkg_change', $self, $old);
4581     if ( $error ) {
4582       $dbh->rollback if $oldAutoCommit;
4583       return $error;
4584     }
4585   }
4586
4587   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4588   '';
4589
4590 }
4591
4592 =item insert_reason
4593
4594 Associates this package with a (suspension or cancellation) reason (see
4595 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
4596 L<FS::reason>).
4597
4598 Available options are:
4599
4600 =over 4
4601
4602 =item reason
4603
4604 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.
4605
4606 =item reason_otaker
4607
4608 the access_user (see L<FS::access_user>) providing the reason
4609
4610 =item date
4611
4612 a unix timestamp
4613
4614 =item action
4615
4616 the action (cancel, susp, adjourn, expire) associated with the reason
4617
4618 =back
4619
4620 If there is an error, returns the error, otherwise returns false.
4621
4622 =cut
4623
4624 sub insert_reason {
4625   my ($self, %options) = @_;
4626
4627   my $otaker = $options{reason_otaker} ||
4628                $FS::CurrentUser::CurrentUser->username;
4629
4630   my $reasonnum;
4631   if ( $options{'reason'} =~ /^(\d+)$/ ) {
4632
4633     $reasonnum = $1;
4634
4635   } elsif ( ref($options{'reason'}) ) {
4636
4637     return 'Enter a new reason (or select an existing one)'
4638       unless $options{'reason'}->{'reason'} !~ /^\s*$/;
4639
4640     my $reason = new FS::reason({
4641       'reason_type' => $options{'reason'}->{'typenum'},
4642       'reason'      => $options{'reason'}->{'reason'},
4643     });
4644     my $error = $reason->insert;
4645     return $error if $error;
4646
4647     $reasonnum = $reason->reasonnum;
4648
4649   } else {
4650     return "Unparseable reason: ". $options{'reason'};
4651   }
4652
4653   my $cust_pkg_reason =
4654     new FS::cust_pkg_reason({ 'pkgnum'    => $self->pkgnum,
4655                               'reasonnum' => $reasonnum,
4656                               'otaker'    => $otaker,
4657                               'action'    => substr(uc($options{'action'}),0,1),
4658                               'date'      => $options{'date'}
4659                                                ? $options{'date'}
4660                                                : time,
4661                             });
4662
4663   $cust_pkg_reason->insert;
4664 }
4665
4666 =item insert_discount
4667
4668 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
4669 inserting a new discount on the fly (see L<FS::discount>).
4670
4671 Available options are:
4672
4673 =over 4
4674
4675 =item discountnum
4676
4677 =back
4678
4679 If there is an error, returns the error, otherwise returns false.
4680
4681 =cut
4682
4683 sub insert_discount {
4684   #my ($self, %options) = @_;
4685   my $self = shift;
4686
4687   my $cust_pkg_discount = new FS::cust_pkg_discount {
4688     'pkgnum'      => $self->pkgnum,
4689     'discountnum' => $self->discountnum,
4690     'months_used' => 0,
4691     'end_date'    => '', #XXX
4692     #for the create a new discount case
4693     '_type'       => $self->discountnum__type,
4694     'amount'      => $self->discountnum_amount,
4695     'percent'     => $self->discountnum_percent,
4696     'months'      => $self->discountnum_months,
4697     'setup'      => $self->discountnum_setup,
4698     #'disabled'    => $self->discountnum_disabled,
4699   };
4700
4701   $cust_pkg_discount->insert;
4702 }
4703
4704 =item set_usage USAGE_VALUE_HASHREF
4705
4706 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4707 to which they should be set (see L<FS::svc_acct>).  Currently seconds,
4708 upbytes, downbytes, and totalbytes are appropriate keys.
4709
4710 All svc_accts which are part of this package have their values reset.
4711
4712 =cut
4713
4714 sub set_usage {
4715   my ($self, $valueref, %opt) = @_;
4716
4717   #only svc_acct can set_usage for now
4718   foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4719     my $svc_x = $cust_svc->svc_x;
4720     $svc_x->set_usage($valueref, %opt)
4721       if $svc_x->can("set_usage");
4722   }
4723 }
4724
4725 =item recharge USAGE_VALUE_HASHREF
4726
4727 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4728 to which they should be set (see L<FS::svc_acct>).  Currently seconds,
4729 upbytes, downbytes, and totalbytes are appropriate keys.
4730
4731 All svc_accts which are part of this package have their values incremented.
4732
4733 =cut
4734
4735 sub recharge {
4736   my ($self, $valueref) = @_;
4737
4738   #only svc_acct can set_usage for now
4739   foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4740     my $svc_x = $cust_svc->svc_x;
4741     $svc_x->recharge($valueref)
4742       if $svc_x->can("recharge");
4743   }
4744 }
4745
4746 =item cust_pkg_discount
4747
4748 =cut
4749
4750 sub cust_pkg_discount {
4751   my $self = shift;
4752   qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
4753 }
4754
4755 =item cust_pkg_discount_active
4756
4757 =cut
4758
4759 sub cust_pkg_discount_active {
4760   my $self = shift;
4761   grep { $_->status eq 'active' } $self->cust_pkg_discount;
4762 }
4763
4764 =item cust_pkg_usage
4765
4766 Returns a list of all voice usage counters attached to this package.
4767
4768 =cut
4769
4770 sub cust_pkg_usage {
4771   my $self = shift;
4772   qsearch('cust_pkg_usage', { pkgnum => $self->pkgnum });
4773 }
4774
4775 =item apply_usage OPTIONS
4776
4777 Takes the following options:
4778 - cdr: a call detail record (L<FS::cdr>)
4779 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
4780 - minutes: the maximum number of minutes to be charged
4781
4782 Finds available usage minutes for a call of this class, and subtracts
4783 up to that many minutes from the usage pool.  If the usage pool is empty,
4784 and the C<cdr-minutes_priority> global config option is set, minutes may
4785 be taken from other calls as well.  Either way, an allocation record will
4786 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
4787 number of minutes of usage applied to the call.
4788
4789 =cut
4790
4791 sub apply_usage {
4792   my ($self, %opt) = @_;
4793   my $cdr = $opt{cdr};
4794   my $rate_detail = $opt{rate_detail};
4795   my $minutes = $opt{minutes};
4796   my $classnum = $rate_detail->classnum;
4797   my $pkgnum = $self->pkgnum;
4798   my $custnum = $self->custnum;
4799
4800   local $SIG{HUP} = 'IGNORE';
4801   local $SIG{INT} = 'IGNORE';
4802   local $SIG{QUIT} = 'IGNORE';
4803   local $SIG{TERM} = 'IGNORE';
4804   local $SIG{TSTP} = 'IGNORE';
4805   local $SIG{PIPE} = 'IGNORE';
4806
4807   my $oldAutoCommit = $FS::UID::AutoCommit;
4808   local $FS::UID::AutoCommit = 0;
4809   my $dbh = dbh;
4810   my $order = FS::Conf->new->config('cdr-minutes_priority');
4811
4812   my $is_classnum;
4813   if ( $classnum ) {
4814     $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
4815   } else {
4816     $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
4817   }
4818   my @usage_recs = qsearch({
4819       'table'     => 'cust_pkg_usage',
4820       'addl_from' => ' JOIN part_pkg_usage       USING (pkgusagepart)'.
4821                      ' JOIN cust_pkg             USING (pkgnum)'.
4822                      ' JOIN part_pkg_usage_class USING (pkgusagepart)',
4823       'select'    => 'cust_pkg_usage.*',
4824       'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
4825                      " ( cust_pkg.custnum = $custnum AND ".
4826                      " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4827                      $is_classnum . ' AND '.
4828                      " cust_pkg_usage.minutes > 0",
4829       'order_by'  => " ORDER BY priority ASC",
4830   });
4831
4832   my $orig_minutes = $minutes;
4833   my $error;
4834   while (!$error and $minutes > 0 and @usage_recs) {
4835     my $cust_pkg_usage = shift @usage_recs;
4836     $cust_pkg_usage->select_for_update;
4837     my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
4838         pkgusagenum => $cust_pkg_usage->pkgusagenum,
4839         acctid      => $cdr->acctid,
4840         minutes     => min($cust_pkg_usage->minutes, $minutes),
4841     });
4842     $cust_pkg_usage->set('minutes',
4843       $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes
4844     );
4845     $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
4846     $minutes -= $cdr_cust_pkg_usage->minutes;
4847   }
4848   if ( $order and $minutes > 0 and !$error ) {
4849     # then try to steal minutes from another call
4850     my %search = (
4851         'table'     => 'cdr_cust_pkg_usage',
4852         'addl_from' => ' JOIN cust_pkg_usage        USING (pkgusagenum)'.
4853                        ' JOIN part_pkg_usage        USING (pkgusagepart)'.
4854                        ' JOIN cust_pkg              USING (pkgnum)'.
4855                        ' JOIN part_pkg_usage_class  USING (pkgusagepart)'.
4856                        ' JOIN cdr                   USING (acctid)',
4857         'select'    => 'cdr_cust_pkg_usage.*',
4858         'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
4859                        " ( cust_pkg.pkgnum = $pkgnum OR ".
4860                        " ( cust_pkg.custnum = $custnum AND ".
4861                        " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4862                        " part_pkg_usage_class.classnum = $classnum",
4863         'order_by'  => ' ORDER BY part_pkg_usage.priority ASC',
4864     );
4865     if ( $order eq 'time' ) {
4866       # find CDRs that are using minutes, but have a later startdate
4867       # than this call
4868       my $startdate = $cdr->startdate;
4869       if ($startdate !~ /^\d+$/) {
4870         die "bad cdr startdate '$startdate'";
4871       }
4872       $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
4873       # minimize needless reshuffling
4874       $search{'order_by'} .= ', cdr.startdate DESC';
4875     } else {
4876       # XXX may not work correctly with rate_time schedules.  Could
4877       # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
4878       # think...
4879       $search{'addl_from'} .=
4880         ' JOIN rate_detail'.
4881         ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
4882       if ( $order eq 'rate_high' ) {
4883         $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
4884                                 $rate_detail->min_charge;
4885         $search{'order_by'} .= ', rate_detail.min_charge ASC';
4886       } elsif ( $order eq 'rate_low' ) {
4887         $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
4888                                 $rate_detail->min_charge;
4889         $search{'order_by'} .= ', rate_detail.min_charge DESC';
4890       } else {
4891         #  this should really never happen
4892         die "invalid cdr-minutes_priority value '$order'\n";
4893       }
4894     }
4895     my @cdr_usage_recs = qsearch(\%search);
4896     my %reproc_cdrs;
4897     while (!$error and @cdr_usage_recs and $minutes > 0) {
4898       my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
4899       my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
4900       my $old_cdr = $cdr_cust_pkg_usage->cdr;
4901       $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
4902       $cdr_cust_pkg_usage->select_for_update;
4903       $old_cdr->select_for_update;
4904       $cust_pkg_usage->select_for_update;
4905       # in case someone else stole the usage from this CDR
4906       # while waiting for the lock...
4907       next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
4908       # steal the usage allocation and flag the old CDR for reprocessing
4909       $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
4910       # if the allocation is more minutes than we need, adjust it...
4911       my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
4912       if ( $delta > 0 ) {
4913         $cdr_cust_pkg_usage->set('minutes', $minutes);
4914         $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
4915         $error = $cust_pkg_usage->replace;
4916       }
4917       #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
4918       $error ||= $cdr_cust_pkg_usage->replace;
4919       # deduct the stolen minutes
4920       $minutes -= $cdr_cust_pkg_usage->minutes;
4921     }
4922     # after all minute-stealing is done, reset the affected CDRs
4923     foreach (values %reproc_cdrs) {
4924       $error ||= $_->set_status('');
4925       # XXX or should we just call $cdr->rate right here?
4926       # it's not like we can create a loop this way, since the min_charge
4927       # or call time has to go monotonically in one direction.
4928       # we COULD get some very deep recursions going, though...
4929     }
4930   } # if $order and $minutes
4931   if ( $error ) {
4932     $dbh->rollback;
4933     die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
4934   } else {
4935     $dbh->commit if $oldAutoCommit;
4936     return $orig_minutes - $minutes;
4937   }
4938 }
4939
4940 =item supplemental_pkgs
4941
4942 Returns a list of all packages supplemental to this one.
4943
4944 =cut
4945
4946 sub supplemental_pkgs {
4947   my $self = shift;
4948   qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
4949 }
4950
4951 =item main_pkg
4952
4953 Returns the package that this one is supplemental to, if any.
4954
4955 =cut
4956
4957 sub main_pkg {
4958   my $self = shift;
4959   if ( $self->main_pkgnum ) {
4960     return FS::cust_pkg->by_key($self->main_pkgnum);
4961   }
4962   return;
4963 }
4964
4965 =back
4966
4967 =head1 CLASS METHODS
4968
4969 =over 4
4970
4971 =item recurring_sql
4972
4973 Returns an SQL expression identifying recurring packages.
4974
4975 =cut
4976
4977 sub recurring_sql { "
4978   '0' != ( select freq from part_pkg
4979              where cust_pkg.pkgpart = part_pkg.pkgpart )
4980 "; }
4981
4982 =item onetime_sql
4983
4984 Returns an SQL expression identifying one-time packages.
4985
4986 =cut
4987
4988 sub onetime_sql { "
4989   '0' = ( select freq from part_pkg
4990             where cust_pkg.pkgpart = part_pkg.pkgpart )
4991 "; }
4992
4993 =item ordered_sql
4994
4995 Returns an SQL expression identifying ordered packages (recurring packages not
4996 yet billed).
4997
4998 =cut
4999
5000 sub ordered_sql {
5001    $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
5002 }
5003
5004 =item active_sql
5005
5006 Returns an SQL expression identifying active packages.
5007
5008 =cut
5009
5010 sub active_sql {
5011   $_[0]->recurring_sql. "
5012   AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
5013   AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5014   AND ( cust_pkg.susp   IS NULL OR cust_pkg.susp   = 0 )
5015 "; }
5016
5017 =item not_yet_billed_sql
5018
5019 Returns an SQL expression identifying packages which have not yet been billed.
5020
5021 =cut
5022
5023 sub not_yet_billed_sql { "
5024       ( cust_pkg.setup  IS NULL OR cust_pkg.setup  = 0 )
5025   AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5026   AND ( cust_pkg.susp   IS NULL OR cust_pkg.susp   = 0 )
5027 "; }
5028
5029 =item inactive_sql
5030
5031 Returns an SQL expression identifying inactive packages (one-time packages
5032 that are otherwise unsuspended/uncancelled).
5033
5034 =cut
5035
5036 sub inactive_sql { "
5037   ". $_[0]->onetime_sql(). "
5038   AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
5039   AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5040   AND ( cust_pkg.susp   IS NULL OR cust_pkg.susp   = 0 )
5041 "; }
5042
5043 =item on_hold_sql
5044
5045 Returns an SQL expression identifying on-hold packages.
5046
5047 =cut
5048
5049 sub on_hold_sql {
5050   #$_[0]->recurring_sql(). ' AND '.
5051   "
5052         ( cust_pkg.cancel IS     NULL  OR cust_pkg.cancel  = 0 )
5053     AND   cust_pkg.susp   IS NOT NULL AND cust_pkg.susp   != 0
5054     AND ( cust_pkg.setup  IS     NULL  OR cust_pkg.setup   = 0 )
5055   ";
5056 }
5057
5058 =item susp_sql
5059 =item suspended_sql
5060
5061 Returns an SQL expression identifying suspended packages.
5062
5063 =cut
5064
5065 sub suspended_sql { susp_sql(@_); }
5066 sub susp_sql {
5067   #$_[0]->recurring_sql(). ' AND '.
5068   "
5069         ( cust_pkg.cancel IS     NULL  OR cust_pkg.cancel = 0 )
5070     AND   cust_pkg.susp   IS NOT NULL AND cust_pkg.susp  != 0
5071     AND   cust_pkg.setup  IS NOT NULL AND cust_pkg.setup != 0
5072   ";
5073 }
5074
5075 =item cancel_sql
5076 =item cancelled_sql
5077
5078 Returns an SQL exprression identifying cancelled packages.
5079
5080 =cut
5081
5082 sub cancelled_sql { cancel_sql(@_); }
5083 sub cancel_sql {
5084   #$_[0]->recurring_sql(). ' AND '.
5085   "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
5086 }
5087
5088 =item ncancelled_recurring_sql
5089
5090 Returns an SQL expression identifying un-cancelled, recurring packages.
5091
5092 =cut
5093
5094 sub ncancelled_recurring_sql {
5095   $_[0]->recurring_sql().
5096   " AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 ) ";
5097 }
5098
5099 =item status_sql
5100
5101 Returns an SQL expression to give the package status as a string.
5102
5103 =cut
5104
5105 sub status_sql {
5106 "CASE
5107   WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
5108   WHEN ( cust_pkg.susp IS NOT NULL AND cust_pkg.setup IS NULL ) THEN 'on hold'
5109   WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
5110   WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
5111   WHEN ".onetime_sql()." THEN 'one-time charge'
5112   ELSE 'active'
5113 END"
5114 }
5115
5116 =item search HASHREF
5117
5118 (Class method)
5119
5120 Returns a qsearch hash expression to search for parameters specified in HASHREF.
5121 Valid parameters are
5122
5123 =over 4
5124
5125 =item agentnum
5126
5127 =item status
5128
5129 on hold, active, inactive (or one-time charge), suspended, canceled (or cancelled)
5130
5131 =item magic
5132
5133 Equivalent to "status", except that "canceled"/"cancelled" will exclude
5134 packages that were changed into a new package with the same pkgpart (i.e.
5135 location or quantity changes).
5136
5137 =item custom
5138
5139  boolean selects custom packages
5140
5141 =item classnum
5142
5143 =item pkgpart
5144
5145 pkgpart or arrayref or hashref of pkgparts
5146
5147 =item setup
5148
5149 arrayref of beginning and ending epoch date
5150
5151 =item last_bill
5152
5153 arrayref of beginning and ending epoch date
5154
5155 =item bill
5156
5157 arrayref of beginning and ending epoch date
5158
5159 =item adjourn
5160
5161 arrayref of beginning and ending epoch date
5162
5163 =item susp
5164
5165 arrayref of beginning and ending epoch date
5166
5167 =item expire
5168
5169 arrayref of beginning and ending epoch date
5170
5171 =item cancel
5172
5173 arrayref of beginning and ending epoch date
5174
5175 =item query
5176
5177 pkgnum or APKG_pkgnum
5178
5179 =item cust_fields
5180
5181 a value suited to passing to FS::UI::Web::cust_header
5182
5183 =item CurrentUser
5184
5185 specifies the user for agent virtualization
5186
5187 =item fcc_line
5188
5189 boolean; if true, returns only packages with more than 0 FCC phone lines.
5190
5191 =item state, country
5192
5193 Limit to packages with a service location in the specified state and country.
5194 For FCC 477 reporting, mostly.
5195
5196 =item location_cust
5197
5198 Limit to packages whose service locations are the same as the customer's
5199 default service location.
5200
5201 =item location_nocust
5202
5203 Limit to packages whose service locations are not the customer's default
5204 service location.
5205
5206 =item location_census
5207
5208 Limit to packages whose service locations have census tracts.
5209
5210 =item location_nocensus
5211
5212 Limit to packages whose service locations do not have a census tract.
5213
5214 =item location_geocode
5215
5216 Limit to packages whose locations have geocodes.
5217
5218 =item location_geocode
5219
5220 Limit to packages whose locations do not have geocodes.
5221
5222 =item towernum
5223
5224 Limit to packages associated with a svc_broadband, associated with a sector,
5225 associated with this towernum (or any of these, if it's an arrayref) (or NO
5226 towernum, if it's zero). This is an extreme niche case.
5227
5228 =item 477part, 477rownum, date
5229
5230 Limit to packages included in a specific row of one of the FCC 477 reports.
5231 '477part' is the section name (see L<FS::Report::FCC_477> methods), 'date'
5232 is the report as-of date (completely unrelated to the package setup/bill/
5233 other date fields), and '477rownum' is the row number of the report starting
5234 with zero. Row numbers have no inherent meaning, so this is useful only
5235 for explaining a 477 report you've already run.
5236
5237 =back
5238
5239 =cut
5240
5241 sub search {
5242   my ($class, $params) = @_;
5243   my @where = ();
5244
5245   ##
5246   # parse agent
5247   ##
5248
5249   if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
5250     push @where,
5251       "cust_main.agentnum = $1";
5252   }
5253
5254   ##
5255   # parse cust_status
5256   ##
5257
5258   if ( $params->{'cust_status'} =~ /^([a-z]+)$/ ) {
5259     push @where, FS::cust_main->cust_status_sql . " = '$1' ";
5260   }
5261
5262   ##
5263   # parse customer sales person
5264   ##
5265
5266   if ( $params->{'cust_main_salesnum'} =~ /^(\d+)$/ ) {
5267     push @where, ($1 > 0) ? "cust_main.salesnum = $1"
5268                           : 'cust_main.salesnum IS NULL';
5269   }
5270
5271
5272   ##
5273   # parse sales person
5274   ##
5275
5276   if ( $params->{'salesnum'} =~ /^(\d+)$/ ) {
5277     push @where, ($1 > 0) ? "cust_pkg.salesnum = $1"
5278                           : 'cust_pkg.salesnum IS NULL';
5279   }
5280
5281   ##
5282   # parse custnum
5283   ##
5284
5285   if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
5286     push @where,
5287       "cust_pkg.custnum = $1";
5288   }
5289
5290   ##
5291   # custbatch
5292   ##
5293
5294   if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
5295     push @where,
5296       "cust_pkg.pkgbatch = '$1'";
5297   }
5298
5299   ##
5300   # parse status
5301   ##
5302
5303   if (    $params->{'magic'}  eq 'active'
5304        || $params->{'status'} eq 'active' ) {
5305
5306     push @where, FS::cust_pkg->active_sql();
5307
5308   } elsif (    $params->{'magic'}  =~ /^not[ _]yet[ _]billed$/
5309             || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
5310
5311     push @where, FS::cust_pkg->not_yet_billed_sql();
5312
5313   } elsif (    $params->{'magic'}  =~ /^(one-time charge|inactive)/
5314             || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
5315
5316     push @where, FS::cust_pkg->inactive_sql();
5317
5318   } elsif (    $params->{'magic'}  =~ /^on[ _]hold$/
5319             || $params->{'status'} =~ /^on[ _]hold$/ ) {
5320
5321     push @where, FS::cust_pkg->on_hold_sql();
5322
5323
5324   } elsif (    $params->{'magic'}  eq 'suspended'
5325             || $params->{'status'} eq 'suspended'  ) {
5326
5327     push @where, FS::cust_pkg->suspended_sql();
5328
5329   } elsif (    $params->{'magic'}  =~ /^cancell?ed$/
5330             || $params->{'status'} =~ /^cancell?ed$/ ) {
5331
5332     push @where, FS::cust_pkg->cancelled_sql();
5333
5334   }
5335
5336   ### special case: "magic" is used in detail links from browse/part_pkg,
5337   # where "cancelled" has the restriction "and not replaced with a package
5338   # of the same pkgpart".  Be consistent with that.
5339   ###
5340
5341   if ( $params->{'magic'} =~ /^cancell?ed$/ ) {
5342     my $new_pkgpart = "SELECT pkgpart FROM cust_pkg AS cust_pkg_next ".
5343                       "WHERE cust_pkg_next.change_pkgnum = cust_pkg.pkgnum";
5344     # ...may not exist, if this was just canceled and not changed; in that
5345     # case give it a "new pkgpart" that never equals the old pkgpart
5346     push @where, "COALESCE(($new_pkgpart), 0) != cust_pkg.pkgpart";
5347   }
5348
5349   ###
5350   # parse package class
5351   ###
5352
5353   if ( exists($params->{'classnum'}) ) {
5354
5355     my @classnum = ();
5356     if ( ref($params->{'classnum'}) ) {
5357
5358       if ( ref($params->{'classnum'}) eq 'HASH' ) {
5359         @classnum = grep $params->{'classnum'}{$_}, keys %{ $params->{'classnum'} };
5360       } elsif ( ref($params->{'classnum'}) eq 'ARRAY' ) {
5361         @classnum = @{ $params->{'classnum'} };
5362       } else {
5363         die 'unhandled classnum ref '. $params->{'classnum'};
5364       }
5365
5366
5367     } elsif ( $params->{'classnum'} =~ /^(\d*)$/ && $1 ne '0' ) {
5368       @classnum = ( $1 );
5369     }
5370
5371     if ( @classnum ) {
5372
5373       my @c_where = ();
5374       my @nums = grep $_, @classnum;
5375       push @c_where, 'part_pkg.classnum IN ('. join(',',@nums). ')' if @nums;
5376       my $null = scalar( grep { $_ eq '' } @classnum );
5377       push @c_where, 'part_pkg.classnum IS NULL' if $null;
5378
5379       if ( scalar(@c_where) == 1 ) {
5380         push @where, @c_where;
5381       } elsif ( @c_where ) {
5382         push @where, ' ( '. join(' OR ', @c_where). ' ) ';
5383       }
5384
5385     }
5386
5387
5388   }
5389
5390   ###
5391   # parse (customer) refnum (advertising source)
5392   ###
5393
5394   if ( exists($params->{'refnum'}) ) {
5395     my @refnum;
5396     if (ref $params->{'refnum'}) {
5397       @refnum = @{ $params->{'refnum'} };
5398     } else {
5399       @refnum = ( $params->{'refnum'} );
5400     }
5401     my $in = join(',', grep /^\d+$/, @refnum);
5402     push @where, "cust_main.refnum IN($in)" if length $in;
5403   }
5404
5405   ###
5406   # parse package report options
5407   ###
5408
5409   my @report_option = ();
5410   if ( exists($params->{'report_option'}) ) {
5411     if ( ref($params->{'report_option'}) eq 'ARRAY' ) {
5412       @report_option = @{ $params->{'report_option'} };
5413     } elsif ( $params->{'report_option'} =~ /^([,\d]*)$/ ) {
5414       @report_option = split(',', $1);
5415     }
5416
5417   }
5418
5419   if (@report_option) {
5420     # this will result in the empty set for the dangling comma case as it should
5421     push @where,
5422       map{ "0 < ( SELECT count(*) FROM part_pkg_option
5423                     WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
5424                     AND optionname = 'report_option_$_'
5425                     AND optionvalue = '1' )"
5426          } @report_option;
5427   }
5428
5429   foreach my $any ( grep /^report_option_any/, keys %$params ) {
5430
5431     my @report_option_any = ();
5432     if ( ref($params->{$any}) eq 'ARRAY' ) {
5433       @report_option_any = @{ $params->{$any} };
5434     } elsif ( $params->{$any} =~ /^([,\d]*)$/ ) {
5435       @report_option_any = split(',', $1);
5436     }
5437
5438     if (@report_option_any) {
5439       # this will result in the empty set for the dangling comma case as it should
5440       push @where, ' ( '. join(' OR ',
5441         map{ "0 < ( SELECT count(*) FROM part_pkg_option
5442                       WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
5443                       AND optionname = 'report_option_$_'
5444                       AND optionvalue = '1' )"
5445            } @report_option_any
5446       ). ' ) ';
5447     }
5448
5449   }
5450
5451   ###
5452   # parse custom
5453   ###
5454
5455   push @where,  "part_pkg.custom = 'Y'" if $params->{custom};
5456
5457   ###
5458   # parse fcc_line
5459   ###
5460
5461   push @where,  "(part_pkg.fcc_ds0s > 0 OR pkg_class.fcc_ds0s > 0)"
5462                                                         if $params->{fcc_line};
5463
5464   ###
5465   # parse censustract
5466   ###
5467
5468   if ( exists($params->{'censustract'}) ) {
5469     $params->{'censustract'} =~ /^([.\d]*)$/;
5470     my $censustract = "cust_location.censustract = '$1'";
5471     $censustract .= ' OR cust_location.censustract is NULL' unless $1;
5472     push @where,  "( $censustract )";
5473   }
5474
5475   ###
5476   # parse censustract2
5477   ###
5478   if ( exists($params->{'censustract2'})
5479        && $params->{'censustract2'} =~ /^(\d*)$/
5480      )
5481   {
5482     if ($1) {
5483       push @where, "cust_location.censustract LIKE '$1%'";
5484     } else {
5485       push @where,
5486         "( cust_location.censustract = '' OR cust_location.censustract IS NULL )";
5487     }
5488   }
5489
5490   ###
5491   # parse country/state/zip
5492   ###
5493   for (qw(state country)) { # parsing rules are the same for these
5494   if ( exists($params->{$_})
5495     && uc($params->{$_}) =~ /^([A-Z]{2})$/ )
5496     {
5497       # XXX post-2.3 only--before that, state/country may be in cust_main
5498       push @where, "cust_location.$_ = '$1'";
5499     }
5500   }
5501   if ( exists($params->{zip}) ) {
5502     push @where, "cust_location.zip = " . dbh->quote($params->{zip});
5503   }
5504
5505   ###
5506   # location_* flags
5507   ###
5508   if ( $params->{location_cust} xor $params->{location_nocust} ) {
5509     my $op = $params->{location_cust} ? '=' : '!=';
5510     push @where, "cust_location.locationnum $op cust_main.ship_locationnum";
5511   }
5512   if ( $params->{location_census} xor $params->{location_nocensus} ) {
5513     my $op = $params->{location_census} ? "IS NOT NULL" : "IS NULL";
5514     push @where, "cust_location.censustract $op";
5515   }
5516   if ( $params->{location_geocode} xor $params->{location_nogeocode} ) {
5517     my $op = $params->{location_geocode} ? "IS NOT NULL" : "IS NULL";
5518     push @where, "cust_location.geocode $op";
5519   }
5520
5521   ###
5522   # parse part_pkg
5523   ###
5524
5525   if ( ref($params->{'pkgpart'}) ) {
5526
5527     my @pkgpart = ();
5528     if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
5529       @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
5530     } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
5531       @pkgpart = @{ $params->{'pkgpart'} };
5532     } else {
5533       die 'unhandled pkgpart ref '. $params->{'pkgpart'};
5534     }
5535
5536     @pkgpart = grep /^(\d+)$/, @pkgpart;
5537
5538     push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
5539
5540   } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
5541     push @where, "pkgpart = $1";
5542   }
5543
5544   ###
5545   # parse dates
5546   ###
5547
5548   my $orderby = '';
5549
5550   #false laziness w/report_cust_pkg.html
5551   my %disable = (
5552     'all'             => {},
5553     'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
5554     'active'          => { 'susp'=>1, 'cancel'=>1 },
5555     'suspended'       => { 'cancel' => 1 },
5556     'cancelled'       => {},
5557     ''                => {},
5558   );
5559
5560   if( exists($params->{'active'} ) ) {
5561     # This overrides all the other date-related fields, and includes packages
5562     # that were active at some time during the interval.  It excludes:
5563     # - packages that were set up after the end of the interval
5564     # - packages that were canceled before the start of the interval
5565     # - packages that were suspended before the start of the interval
5566     #   and are still suspended now
5567     my($beginning, $ending) = @{$params->{'active'}};
5568     push @where,
5569       "cust_pkg.setup IS NOT NULL",
5570       "cust_pkg.setup <= $ending",
5571       "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
5572       "(cust_pkg.susp   IS NULL OR cust_pkg.susp   >= $beginning )",
5573       "NOT (".FS::cust_pkg->onetime_sql . ")";
5574   }
5575   else {
5576     my $exclude_change_from = 0;
5577     my $exclude_change_to = 0;
5578
5579     foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end change_date cancel )) {
5580
5581       if ( $params->{$field.'_null'} ) {
5582
5583         push @where, "cust_pkg.$field IS NULL";
5584              # this should surely be obsoleted by now: OR cust_pkg.$field == 0
5585
5586       } else {
5587
5588         next unless exists($params->{$field});
5589
5590         my($beginning, $ending) = @{$params->{$field}};
5591
5592         next if $beginning == 0 && $ending == 4294967295;
5593
5594         push @where,
5595           "cust_pkg.$field IS NOT NULL",
5596           "cust_pkg.$field >= $beginning",
5597           "cust_pkg.$field <= $ending";
5598
5599         $orderby ||= "ORDER BY cust_pkg.$field";
5600
5601         if ( $field eq 'setup' ) {
5602           $exclude_change_from = 1;
5603         } elsif ( $field eq 'cancel' ) {
5604           $exclude_change_to = 1;
5605         } elsif ( $field eq 'change_date' ) {
5606           # if we are given setup and change_date ranges, and the setup date
5607           # falls in _both_ ranges, then include the package whether it was
5608           # a change or not
5609           $exclude_change_from = 0;
5610         }
5611       }
5612
5613     }
5614
5615     if ($exclude_change_from) {
5616       push @where, "change_pkgnum IS NULL";
5617     }
5618     if ($exclude_change_to) {
5619       # a join might be more efficient here
5620       push @where, "NOT EXISTS(
5621         SELECT 1 FROM cust_pkg AS changed_to_pkg
5622         WHERE cust_pkg.pkgnum = changed_to_pkg.change_pkgnum
5623       )";
5624     }
5625
5626   }
5627
5628   $orderby ||= 'ORDER BY bill';
5629
5630   ###
5631   # parse magic, legacy, etc.
5632   ###
5633
5634   if ( $params->{'magic'} &&
5635        $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
5636   ) {
5637
5638     $orderby = 'ORDER BY pkgnum';
5639
5640     if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
5641       push @where, "pkgpart = $1";
5642     }
5643
5644   } elsif ( $params->{'query'} eq 'pkgnum' ) {
5645
5646     $orderby = 'ORDER BY pkgnum';
5647
5648   } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
5649
5650     $orderby = 'ORDER BY pkgnum';
5651
5652     push @where, '0 < (
5653       SELECT count(*) FROM pkg_svc
5654        WHERE pkg_svc.pkgpart =  cust_pkg.pkgpart
5655          AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
5656                                    WHERE cust_svc.pkgnum  = cust_pkg.pkgnum
5657                                      AND cust_svc.svcpart = pkg_svc.svcpart
5658                                 )
5659     )';
5660
5661   }
5662
5663   ##
5664   # parse the extremely weird 'towernum' param
5665   ##
5666
5667   if ($params->{towernum}) {
5668     my $towernum = $params->{towernum};
5669     $towernum = [ $towernum ] if !ref($towernum);
5670     my $in = join(',', grep /^\d+$/, @$towernum);
5671     if (length $in) {
5672       # inefficient, but this is an obscure feature
5673       eval "use FS::Report::Table";
5674       FS::Report::Table->_init_tower_pkg_cache; # probably does nothing
5675       push @where, "EXISTS(
5676       SELECT 1 FROM tower_pkg_cache
5677       WHERE tower_pkg_cache.pkgnum = cust_pkg.pkgnum
5678         AND tower_pkg_cache.towernum IN ($in)
5679       )"
5680     }
5681   }
5682
5683   ##
5684   # parse the 477 report drill-down options
5685   ##
5686
5687   if ($params->{'477part'} =~ /^([a-z]+)$/) {
5688     my $section = $1;
5689     my ($date, $rownum, $agentnum);
5690     if ($params->{'date'} =~ /^(\d+)$/) {
5691       $date = $1;
5692     }
5693     if ($params->{'477rownum'} =~ /^(\d+)$/) {
5694       $rownum = $1;
5695     }
5696     if ($params->{'agentnum'} =~ /^(\d+)$/) {
5697       $agentnum = $1;
5698     }
5699     if ($date and defined($rownum)) {
5700       my $report = FS::Report::FCC_477->report($section,
5701         'date'      => $date,
5702         'agentnum'  => $agentnum,
5703         'detail'    => 1
5704       );
5705       my $pkgnums = $report->{detail}->[$rownum]
5706         or die "row $rownum is past the end of the report";
5707         # '0' so that if there are no pkgnums (empty string) it will create
5708         # a valid query that returns nothing
5709       warn "PKGNUMS:\n$pkgnums\n\n"; # XXX debug
5710
5711       # and this overrides everything
5712       @where = ( "cust_pkg.pkgnum IN($pkgnums)" );
5713     } # else we're missing some params, ignore the whole business
5714   }
5715
5716   ##
5717   # setup queries, links, subs, etc. for the search
5718   ##
5719
5720   # here is the agent virtualization
5721   if ($params->{CurrentUser}) {
5722     my $access_user =
5723       qsearchs('access_user', { username => $params->{CurrentUser} });
5724
5725     if ($access_user) {
5726       push @where, $access_user->agentnums_sql('table'=>'cust_main');
5727     } else {
5728       push @where, "1=0";
5729     }
5730   } else {
5731     push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
5732   }
5733
5734   my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
5735
5736   my $addl_from = 'LEFT JOIN part_pkg  USING ( pkgpart  ) '.
5737                   'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) '.
5738                   'LEFT JOIN cust_location USING ( locationnum ) '.
5739                   FS::UI::Web::join_cust_main('cust_pkg', 'cust_pkg');
5740
5741   my $select;
5742   my $count_query;
5743   if ( $params->{'select_zip5'} ) {
5744     my $zip = 'cust_location.zip';
5745
5746     $select = "DISTINCT substr($zip,1,5) as zip";
5747     $orderby = "ORDER BY substr($zip,1,5)";
5748     $count_query = "SELECT COUNT( DISTINCT substr($zip,1,5) )";
5749   } else {
5750     $select = join(', ',
5751                          'cust_pkg.*',
5752                          ( map "part_pkg.$_", qw( pkg freq ) ),
5753                          'pkg_class.classname',
5754                          'cust_main.custnum AS cust_main_custnum',
5755                          FS::UI::Web::cust_sql_fields(
5756                            $params->{'cust_fields'}
5757                          ),
5758                   );
5759     $count_query = 'SELECT COUNT(*)';
5760   }
5761
5762   $count_query .= " FROM cust_pkg $addl_from $extra_sql";
5763
5764   my $sql_query = {
5765     'table'       => 'cust_pkg',
5766     'hashref'     => {},
5767     'select'      => $select,
5768     'extra_sql'   => $extra_sql,
5769     'order_by'    => $orderby,
5770     'addl_from'   => $addl_from,
5771     'count_query' => $count_query,
5772   };
5773
5774 }
5775
5776 =item fcc_477_count
5777
5778 Returns a list of two package counts.  The first is a count of packages
5779 based on the supplied criteria and the second is the count of residential
5780 packages with those same criteria.  Criteria are specified as in the search
5781 method.
5782
5783 =cut
5784
5785 sub fcc_477_count {
5786   my ($class, $params) = @_;
5787
5788   my $sql_query = $class->search( $params );
5789
5790   my $count_sql = delete($sql_query->{'count_query'});
5791   $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
5792     or die "couldn't parse count_sql";
5793
5794   my $count_sth = dbh->prepare($count_sql)
5795     or die "Error preparing $count_sql: ". dbh->errstr;
5796   $count_sth->execute
5797     or die "Error executing $count_sql: ". $count_sth->errstr;
5798   my $count_arrayref = $count_sth->fetchrow_arrayref;
5799
5800   return ( @$count_arrayref );
5801
5802 }
5803
5804 =item tax_locationnum_sql
5805
5806 Returns an SQL expression for the tax location for a package, based
5807 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
5808
5809 =cut
5810
5811 sub tax_locationnum_sql {
5812   my $conf = FS::Conf->new;
5813   if ( $conf->exists('tax-pkg_address') ) {
5814     'cust_pkg.locationnum';
5815   }
5816   elsif ( $conf->exists('tax-ship_address') ) {
5817     'cust_main.ship_locationnum';
5818   }
5819   else {
5820     'cust_main.bill_locationnum';
5821   }
5822 }
5823
5824 =item location_sql
5825
5826 Returns a list: the first item is an SQL fragment identifying matching
5827 packages/customers via location (taking into account shipping and package
5828 address taxation, if enabled), and subsequent items are the parameters to
5829 substitute for the placeholders in that fragment.
5830
5831 =cut
5832
5833 sub location_sql {
5834   my($class, %opt) = @_;
5835   my $ornull = $opt{'ornull'};
5836
5837   my $conf = new FS::Conf;
5838
5839   # '?' placeholders in _location_sql_where
5840   my $x = $ornull ? 3 : 2;
5841   my @bill_param = (
5842     ('district')x3,
5843     ('city')x3,
5844     ('county')x$x,
5845     ('state')x$x,
5846     'country'
5847   );
5848
5849   my $main_where;
5850   my @main_param;
5851   if ( $conf->exists('tax-ship_address') ) {
5852
5853     $main_where = "(
5854          (     ( ship_last IS NULL     OR  ship_last  = '' )
5855            AND ". _location_sql_where('cust_main', '', $ornull ). "
5856          )
5857       OR (       ship_last IS NOT NULL AND ship_last != ''
5858            AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
5859          )
5860     )";
5861     #    AND payby != 'COMP'
5862
5863     @main_param = ( @bill_param, @bill_param );
5864
5865   } else {
5866
5867     $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
5868     @main_param = @bill_param;
5869
5870   }
5871
5872   my $where;
5873   my @param;
5874   if ( $conf->exists('tax-pkg_address') ) {
5875
5876     my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
5877
5878     $where = " (
5879                     ( cust_pkg.locationnum IS     NULL AND $main_where )
5880                  OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where  )
5881                )
5882              ";
5883     @param = ( @main_param, @bill_param );
5884
5885   } else {
5886
5887     $where = $main_where;
5888     @param = @main_param;
5889
5890   }
5891
5892   ( $where, @param );
5893
5894 }
5895
5896 #subroutine, helper for location_sql
5897 sub _location_sql_where {
5898   my $table  = shift;
5899   my $prefix = @_ ? shift : '';
5900   my $ornull = @_ ? shift : '';
5901
5902 #  $ornull             = $ornull          ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
5903
5904   $ornull = $ornull ? ' OR ? IS NULL ' : '';
5905
5906   my $or_empty_city     = " OR ( ? = '' AND $table.${prefix}city     IS NULL )";
5907   my $or_empty_county   = " OR ( ? = '' AND $table.${prefix}county   IS NULL )";
5908   my $or_empty_state    = " OR ( ? = '' AND $table.${prefix}state    IS NULL )";
5909
5910   my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
5911
5912 #        ( $table.${prefix}city    = ? $or_empty_city   $ornull )
5913   "
5914         ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
5915     AND ( $table.${prefix}city     = ? OR ? = '' OR CAST(? AS $text) IS NULL )
5916     AND ( $table.${prefix}county   = ? $or_empty_county $ornull )
5917     AND ( $table.${prefix}state    = ? $or_empty_state  $ornull )
5918     AND   $table.${prefix}country  = ?
5919   ";
5920 }
5921
5922 sub _X_show_zero {
5923   my( $self, $what ) = @_;
5924
5925   my $what_show_zero = $what. '_show_zero';
5926   length($self->$what_show_zero())
5927     ? ($self->$what_show_zero() eq 'Y')
5928     : $self->part_pkg->$what_show_zero();
5929 }
5930
5931 =head1 SUBROUTINES
5932
5933 =over 4
5934
5935 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
5936
5937 Bulk cancel + order subroutine.  Perhaps slightly deprecated, only used by the
5938 bulk cancel+order in the web UI and nowhere else (edit/process/cust_pkg.cgi)
5939
5940 CUSTNUM is a customer (see L<FS::cust_main>)
5941
5942 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5943 L<FS::part_pkg>) to order for this customer.  Duplicates are of course
5944 permitted.
5945
5946 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
5947 remove for this customer.  The services (see L<FS::cust_svc>) are moved to the
5948 new billing items.  An error is returned if this is not possible (see
5949 L<FS::pkg_svc>).  An empty arrayref is equivalent to not specifying this
5950 parameter.
5951
5952 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5953 newly-created cust_pkg objects.
5954
5955 REFNUM, if specified, will specify the FS::pkg_referral record to be created
5956 and inserted.  Multiple FS::pkg_referral records can be created by
5957 setting I<refnum> to an array reference of refnums or a hash reference with
5958 refnums as keys.  If no I<refnum> is defined, a default FS::pkg_referral
5959 record will be created corresponding to cust_main.refnum.
5960
5961 =cut
5962
5963 sub order {
5964   my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
5965
5966   my $conf = new FS::Conf;
5967
5968   # Transactionize this whole mess
5969   local $SIG{HUP} = 'IGNORE';
5970   local $SIG{INT} = 'IGNORE';
5971   local $SIG{QUIT} = 'IGNORE';
5972   local $SIG{TERM} = 'IGNORE';
5973   local $SIG{TSTP} = 'IGNORE';
5974   local $SIG{PIPE} = 'IGNORE';
5975
5976   my $oldAutoCommit = $FS::UID::AutoCommit;
5977   local $FS::UID::AutoCommit = 0;
5978   my $dbh = dbh;
5979
5980   my $error;
5981 #  my $cust_main = qsearchs('cust_main', { custnum => $custnum });
5982 #  return "Customer not found: $custnum" unless $cust_main;
5983
5984   warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
5985     if $DEBUG;
5986
5987   my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5988                          @$remove_pkgnum;
5989
5990   my $change = scalar(@old_cust_pkg) != 0;
5991
5992   my %hash = ();
5993   if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
5994
5995     warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
5996          " to pkgpart ". $pkgparts->[0]. "\n"
5997       if $DEBUG;
5998
5999     my $err_or_cust_pkg =
6000       $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
6001                                 'refnum'  => $refnum,
6002                               );
6003
6004     unless (ref($err_or_cust_pkg)) {
6005       $dbh->rollback if $oldAutoCommit;
6006       return $err_or_cust_pkg;
6007     }
6008
6009     push @$return_cust_pkg, $err_or_cust_pkg;
6010     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6011     return '';
6012
6013   }
6014
6015   # Create the new packages.
6016   foreach my $pkgpart (@$pkgparts) {
6017
6018     warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
6019
6020     my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
6021                                       pkgpart => $pkgpart,
6022                                       refnum  => $refnum,
6023                                       %hash,
6024                                     };
6025     $error = $cust_pkg->insert( 'change' => $change );
6026     push @$return_cust_pkg, $cust_pkg;
6027
6028     foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
6029       my $supp_pkg = FS::cust_pkg->new({
6030           custnum => $custnum,
6031           pkgpart => $link->dst_pkgpart,
6032           refnum  => $refnum,
6033           main_pkgnum => $cust_pkg->pkgnum,
6034           %hash,
6035       });
6036       $error ||= $supp_pkg->insert( 'change' => $change );
6037       push @$return_cust_pkg, $supp_pkg;
6038     }
6039
6040     if ($error) {
6041       $dbh->rollback if $oldAutoCommit;
6042       return $error;
6043     }
6044
6045   }
6046   # $return_cust_pkg now contains refs to all of the newly
6047   # created packages.
6048
6049   # Transfer services and cancel old packages.
6050   foreach my $old_pkg (@old_cust_pkg) {
6051
6052     warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
6053       if $DEBUG;
6054
6055     foreach my $new_pkg (@$return_cust_pkg) {
6056       $error = $old_pkg->transfer($new_pkg);
6057       if ($error and $error == 0) {
6058         # $old_pkg->transfer failed.
6059         $dbh->rollback if $oldAutoCommit;
6060         return $error;
6061       }
6062     }
6063
6064     if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
6065       warn "trying transfer again with change_svcpart option\n" if $DEBUG;
6066       foreach my $new_pkg (@$return_cust_pkg) {
6067         $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
6068         if ($error and $error == 0) {
6069           # $old_pkg->transfer failed.
6070         $dbh->rollback if $oldAutoCommit;
6071         return $error;
6072         }
6073       }
6074     }
6075
6076     if ($error > 0) {
6077       # Transfers were successful, but we went through all of the
6078       # new packages and still had services left on the old package.
6079       # We can't cancel the package under the circumstances, so abort.
6080       $dbh->rollback if $oldAutoCommit;
6081       return "Unable to transfer all services from package ".$old_pkg->pkgnum;
6082     }
6083     $error = $old_pkg->cancel( quiet=>1, 'no_delay_cancel'=>1 );
6084     if ($error) {
6085       $dbh->rollback;
6086       return $error;
6087     }
6088   }
6089   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6090   '';
6091 }
6092
6093 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
6094
6095 A bulk change method to change packages for multiple customers.
6096
6097 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
6098 L<FS::part_pkg>) to order for each customer.  Duplicates are of course
6099 permitted.
6100
6101 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
6102 replace.  The services (see L<FS::cust_svc>) are moved to the
6103 new billing items.  An error is returned if this is not possible (see
6104 L<FS::pkg_svc>).
6105
6106 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
6107 newly-created cust_pkg objects.
6108
6109 =cut
6110
6111 sub bulk_change {
6112   my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
6113
6114   # Transactionize this whole mess
6115   local $SIG{HUP} = 'IGNORE';
6116   local $SIG{INT} = 'IGNORE';
6117   local $SIG{QUIT} = 'IGNORE';
6118   local $SIG{TERM} = 'IGNORE';
6119   local $SIG{TSTP} = 'IGNORE';
6120   local $SIG{PIPE} = 'IGNORE';
6121
6122   my $oldAutoCommit = $FS::UID::AutoCommit;
6123   local $FS::UID::AutoCommit = 0;
6124   my $dbh = dbh;
6125
6126   my @errors;
6127   my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
6128                          @$remove_pkgnum;
6129
6130   while(scalar(@old_cust_pkg)) {
6131     my @return = ();
6132     my $custnum = $old_cust_pkg[0]->custnum;
6133     my (@remove) = map { $_->pkgnum }
6134                    grep { $_->custnum == $custnum } @old_cust_pkg;
6135     @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
6136
6137     my $error = order $custnum, $pkgparts, \@remove, \@return;
6138
6139     push @errors, $error
6140       if $error;
6141     push @$return_cust_pkg, @return;
6142   }
6143
6144   if (scalar(@errors)) {
6145     $dbh->rollback if $oldAutoCommit;
6146     return join(' / ', @errors);
6147   }
6148
6149   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6150   '';
6151 }
6152
6153 =item forward_emails
6154
6155 Returns a hash of svcnums and corresponding email addresses
6156 for svc_acct services that can be used as source or dest
6157 for svc_forward services provisioned in this package.
6158
6159 Accepts options I<svc_forward> OR I<svcnum> for a svc_forward
6160 service;  if included, will ensure the current values of the
6161 specified service are included in the list, even if for some
6162 other reason they wouldn't be.  If called as a class method
6163 with a specified service, returns only these current values.
6164
6165 Caution: does not actually check if svc_forward services are
6166 available to be provisioned on this package.
6167
6168 =cut
6169
6170 sub forward_emails {
6171   my $self = shift;
6172   my %opt = @_;
6173
6174   #load optional service, thoroughly validated
6175   die "Use svcnum or svc_forward, not both"
6176     if $opt{'svcnum'} && $opt{'svc_forward'};
6177   my $svc_forward = $opt{'svc_forward'};
6178   $svc_forward ||= qsearchs('svc_forward',{ 'svcnum' => $opt{'svcnum'} })
6179     if $opt{'svcnum'};
6180   die "Specified service is not a forward service"
6181     if $svc_forward && (ref($svc_forward) ne 'FS::svc_forward');
6182   die "Specified service not found"
6183     if ($opt{'svcnum'} || $opt{'svc_forward'}) && !$svc_forward;
6184
6185   my %email;
6186
6187   ## everything below was basically copied from httemplate/edit/svc_forward.cgi
6188   ## with minimal refactoring, not sure why we can't just load all svc_accts for this custnum
6189
6190   #add current values from specified service, if there was one
6191   if ($svc_forward) {
6192     foreach my $method (qw( srcsvc_acct dstsvc_acct )) {
6193       my $svc_acct = $svc_forward->$method();
6194       $email{$svc_acct->svcnum} = $svc_acct->email if $svc_acct;
6195     }
6196   }
6197
6198   if (ref($self) eq 'FS::cust_pkg') {
6199
6200     #and including the rest for this customer
6201     my($u_part_svc,@u_acct_svcparts);
6202     foreach $u_part_svc ( qsearch('part_svc',{'svcdb'=>'svc_acct'}) ) {
6203       push @u_acct_svcparts,$u_part_svc->getfield('svcpart');
6204     }
6205
6206     my $custnum = $self->getfield('custnum');
6207     foreach my $i_cust_pkg ( qsearch('cust_pkg',{'custnum'=>$custnum}) ) {
6208       my $cust_pkgnum = $i_cust_pkg->getfield('pkgnum');
6209       #now find the corresponding record(s) in cust_svc (for this pkgnum!)
6210       foreach my $acct_svcpart (@u_acct_svcparts) {
6211         foreach my $i_cust_svc (
6212           qsearch( 'cust_svc', { 'pkgnum'  => $cust_pkgnum,
6213                                  'svcpart' => $acct_svcpart } )
6214         ) {
6215           my $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $i_cust_svc->svcnum } );
6216           $email{$svc_acct->svcnum} = $svc_acct->email;
6217         }
6218       }
6219     }
6220   }
6221
6222   return %email;
6223 }
6224
6225 # Used by FS::Upgrade to migrate to a new database.
6226 sub _upgrade_data {  # class method
6227   my ($class, %opts) = @_;
6228   $class->_upgrade_otaker(%opts);
6229   my @statements = (
6230     # RT#10139, bug resulting in contract_end being set when it shouldn't
6231   'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
6232     # RT#10830, bad calculation of prorate date near end of year
6233     # the date range for bill is December 2009, and we move it forward
6234     # one year if it's before the previous bill date (which it should
6235     # never be)
6236   'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
6237   AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
6238   WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
6239     # RT6628, add order_date to cust_pkg
6240     'update cust_pkg set order_date = (select history_date from h_cust_pkg
6241         where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
6242         history_action = \'insert\') where order_date is null',
6243   );
6244   foreach my $sql (@statements) {
6245     my $sth = dbh->prepare($sql);
6246     $sth->execute or die $sth->errstr;
6247   }
6248
6249   # RT31194: supplemental package links that are deleted don't clean up
6250   # linked records
6251   my @pkglinknums = qsearch({
6252       'select'    => 'DISTINCT cust_pkg.pkglinknum',
6253       'table'     => 'cust_pkg',
6254       'addl_from' => ' LEFT JOIN part_pkg_link USING (pkglinknum) ',
6255       'extra_sql' => ' WHERE cust_pkg.pkglinknum IS NOT NULL
6256                         AND part_pkg_link.pkglinknum IS NULL',
6257   });
6258   foreach (@pkglinknums) {
6259     my $pkglinknum = $_->pkglinknum;
6260     warn "cleaning part_pkg_link #$pkglinknum\n";
6261     my $part_pkg_link = FS::part_pkg_link->new({pkglinknum => $pkglinknum});
6262     my $error = $part_pkg_link->remove_linked;
6263     die $error if $error;
6264   }
6265
6266   # RT#73607: canceling a package with billing addons sometimes changes its
6267   # pkgpart.
6268   # Find records where the last replace_new record for the package before it
6269   # was canceled has a different pkgpart from the package itself.
6270   my @cust_pkg = qsearch({
6271     'table' => 'cust_pkg',
6272     'select' => 'cust_pkg.*, h_cust_pkg.pkgpart AS h_pkgpart',
6273     'addl_from' => ' JOIN (
6274   SELECT pkgnum, MAX(historynum) AS historynum FROM h_cust_pkg
6275     WHERE cancel IS NULL
6276       AND history_action = \'replace_new\'
6277     GROUP BY pkgnum
6278   ) AS last_history USING (pkgnum)
6279   JOIN h_cust_pkg USING (historynum)',
6280     'extra_sql' => ' WHERE cust_pkg.cancel is not null
6281                      AND cust_pkg.pkgpart != h_cust_pkg.pkgpart'
6282   });
6283   foreach my $cust_pkg ( @cust_pkg ) {
6284     my $pkgnum = $cust_pkg->pkgnum;
6285     warn "fixing pkgpart on canceled pkg#$pkgnum\n";
6286     $cust_pkg->set('pkgpart', $cust_pkg->h_pkgpart);
6287     my $error = $cust_pkg->replace;
6288     die $error if $error;
6289   }
6290
6291 }
6292
6293 # will autoload in v4+
6294 sub rt_field_charge {
6295   my $self = shift;
6296   qsearch('rt_field_charge',{ 'pkgnum' => $self->pkgnum });
6297 }
6298
6299 =back
6300
6301 =head1 BUGS
6302
6303 sub order is not OO.  Perhaps it should be moved to FS::cust_main and made so?
6304
6305 In sub order, the @pkgparts array (passed by reference) is clobbered.
6306
6307 Also in sub order, no money is adjusted.  Once FS::part_pkg defines a standard
6308 method to pass dates to the recur_prog expression, it should do so.
6309
6310 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
6311 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
6312 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
6313 configuration values.  Probably need a subroutine which decides what to do
6314 based on whether or not we've fetched the user yet, rather than a hash.  See
6315 FS::UID and the TODO.
6316
6317 Now that things are transactional should the check in the insert method be
6318 moved to check ?
6319
6320 =head1 SEE ALSO
6321
6322 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
6323 L<FS::pkg_svc>, schema.html from the base documentation
6324
6325 =cut
6326
6327 1;
6328