FS/FS/cust_pkg.pm

   1 package FS::cust_pkg;
   2 use base qw( FS::cust_pkg::Search FS::cust_pkg::API
   3              FS::otaker_Mixin FS::cust_main_Mixin FS::Sales_Mixin
   4              FS::contact_Mixin FS::location_Mixin
   5              FS::m2m_Common FS::option_Common
   6            );
   7
   8 use strict;
   9 use Carp qw(cluck);
  10 use Scalar::Util qw( blessed );
  11 use List::Util qw(min max);
  12 use Tie::IxHash;
  13 use Time::Local qw( timelocal timelocal_nocheck );
  14 use MIME::Entity;
  15 use FS::UID qw( dbh driver_name );
  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_usageprice;
  35 use FS::cust_pkg_discount;
  36 use FS::discount;
  37 use FS::sales;
  38 # for modify_charge
  39 use FS::cust_credit;
  40
  41 # temporary fix; remove this once (un)suspend admin notices are cleaned up
  42 use FS::Misc qw(send_email);
  43
  44 # need to 'use' these instead of 'require' in sub { cancel, suspend, unsuspend,
  45 # setup }
  46 # because they load configuration by setting FS::UID::callback (see TODO)
  47 use FS::svc_acct;
  48 use FS::svc_domain;
  49 use FS::svc_www;
  50 use FS::svc_forward;
  51
  52 # for sending cancel emails in sub cancel
  53 use FS::Conf;
  54
  55 our ($disable_agentcheck, $DEBUG, $me, $import) = (0, 0, '[FS::cust_pkg]', 0);
  56
  57 our $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 If the package has an automatic transfer rule (C<change_to_pkgnum>), then
 261 this will also order the package and set its start date.
 262
 263 =cut
 264
 265 sub set_initial_timers {
 266   my $self = shift;
 267   my $part_pkg = $self->part_pkg;
 268   my $start = $self->start_date || $self->setup || time;
 269
 270   foreach my $action ( qw(expire adjourn contract_end) ) {
 271     my $months = $part_pkg->get("${action}_months");
 272     if($months and !$self->get($action)) {
 273       $self->set($action, $part_pkg->add_freq($start, $months) );
 274     }
 275   }
 276
 277   # if this package has an expire date and a change_to_pkgpart, set automatic
 278   # package transfer
 279   # (but don't call change_later, as that would call $self->replace, and we're
 280   # probably in the middle of $self->insert right now)
 281   if ( $part_pkg->expire_months and $part_pkg->change_to_pkgpart ) {
 282     if ( $self->change_to_pkgnum ) {
 283       # this can happen if a package is ordered on hold, scheduled for a
 284       # future change _while on hold_, and then released from hold, causing
 285       # the automatic transfer to schedule.
 286       #
 287       # what's correct behavior in that case? I think it's to disallow
 288       # future-changing an on-hold package that has an automatic transfer.
 289       # but if we DO get into this situation, let the manual package change
 290       # win.
 291       warn "pkgnum ".$self->pkgnum.": manual future package change blocks ".
 292            "automatic transfer.\n";
 293     } else {
 294       my $change_to = FS::cust_pkg->new( {
 295           start_date  => $self->get('expire'),
 296           pkgpart     => $part_pkg->change_to_pkgpart,
 297           map { $_ => $self->get($_) }
 298             qw( custnum locationnum quantity refnum salesnum contract_end )
 299       } );
 300       my $error = $change_to->insert;
 301
 302       return $error if $error;
 303       $self->set('change_to_pkgnum', $change_to->pkgnum);
 304     }
 305   }
 306
 307   # if this package has "free days" and delayed setup fee, then
 308   # set start date that many days in the future.
 309   # (this should have been set in the UI, but enforce it here)
 310   if ( $part_pkg->option('free_days',1)
 311        && $part_pkg->option('delay_setup',1)
 312      )
 313   {
 314     $self->start_date( $part_pkg->default_start_date );
 315   }
 316
 317   '';
 318 }
 319
 320 =item insert [ OPTION => VALUE ... ]
 321
 322 Adds this billing item to the database ("Orders" the item).  If there is an
 323 error, returns the error, otherwise returns false.
 324
 325 If the additional field I<promo_code> is defined instead of I<pkgpart>, it
 326 will be used to look up the package definition and agent restrictions will be
 327 ignored.
 328
 329 If the additional field I<refnum> is defined, an FS::pkg_referral record will
 330 be created and inserted.  Multiple FS::pkg_referral records can be created by
 331 setting I<refnum> to an array reference of refnums or a hash reference with
 332 refnums as keys.  If no I<refnum> is defined, a default FS::pkg_referral
 333 record will be created corresponding to cust_main.refnum.
 334
 335 If the additional field I<cust_pkg_usageprice> is defined, it will be treated
 336 as an arrayref of FS::cust_pkg_usageprice objects, which will be inserted.
 337 (Note that this field cannot be set with a usual ->cust_pkg_usageprice method.
 338 It can be set as part of the hash when creating the object, or with the B<set>
 339 method.)
 340
 341 The following options are available:
 342
 343 =over 4
 344
 345 =item change
 346
 347 If set true, supresses actions that should only be taken for new package
 348 orders.  (Currently this includes: intro periods when delay_setup is on,
 349 auto-adding a 1st start date, auto-adding expiration/adjourn/contract_end dates)
 350
 351 =item options
 352
 353 cust_pkg_option records will be created
 354
 355 =item ticket_subject
 356
 357 a ticket will be added to this customer with this subject
 358
 359 =item ticket_queue
 360
 361 an optional queue name for ticket additions
 362
 363 =item allow_pkgpart
 364
 365 Don't check the legality of the package definition.  This should be used
 366 when performing a package change that doesn't change the pkgpart (i.e.
 367 a location change).
 368
 369 =back
 370
 371 =cut
 372
 373 sub insert {
 374   my( $self, %options ) = @_;
 375
 376   my $oldAutoCommit = $FS::UID::AutoCommit;
 377   local $FS::UID::AutoCommit = 0;
 378   my $dbh = dbh;
 379
 380   my $error;
 381   $error = $self->check_pkgpart unless $options{'allow_pkgpart'};
 382
 383   my $part_pkg = $self->part_pkg;
 384
 385   if ( ! $import && ! $options{'change'} ) {
 386
 387     # set order date to now
 388     $self->order_date(time) unless ($import && $self->order_date);
 389
 390     # if the package def says to start only on the first of the month:
 391     if ( $part_pkg->option('start_1st', 1) && !$self->start_date ) {
 392       my ($sec,$min,$hour,$mday,$mon,$year) = (localtime(time) )[0,1,2,3,4,5];
 393       $mon += 1 unless $mday == 1;
 394       until ( $mon < 12 ) { $mon -= 12; $year++; }
 395       $self->start_date( timelocal_nocheck(0,0,0,1,$mon,$year) );
 396     }
 397
 398     if ($self->susp eq 'now' or $part_pkg->start_on_hold) {
 399       # if the package was ordered on hold:
 400       # - suspend it
 401       # - don't set the start date (it will be started manually)
 402       $self->set('susp', $self->order_date);
 403       $self->set('start_date', '');
 404     } else {
 405       # set expire/adjourn/contract_end timers, and free days, if appropriate
 406       # and automatic package transfer, which can fail, so capture the result
 407       $error = $self->set_initial_timers;
 408     }
 409   } # else this is a package change, and shouldn't have "new package" behavior
 410
 411   $error ||= $self->SUPER::insert($options{options} ? %{$options{options}} : ());
 412   if ( $error ) {
 413     $dbh->rollback if $oldAutoCommit;
 414     return $error;
 415   }
 416
 417   $self->refnum($self->cust_main->refnum) unless $self->refnum;
 418   $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
 419   $self->process_m2m( 'link_table'   => 'pkg_referral',
 420                       'target_table' => 'part_referral',
 421                       'params'       => $self->refnum,
 422                     );
 423
 424   if ( $self->hashref->{cust_pkg_usageprice} ) {
 425     for my $cust_pkg_usageprice ( @{ $self->hashref->{cust_pkg_usageprice} } ) {
 426       $cust_pkg_usageprice->pkgnum( $self->pkgnum );
 427       my $error = $cust_pkg_usageprice->insert;
 428       if ( $error ) {
 429         $dbh->rollback if $oldAutoCommit;
 430         return $error;
 431       }
 432     }
 433   }
 434
 435   if ( $self->setup_discountnum || $self->recur_discountnum ) {
 436     my $error = $self->insert_discount();
 437     if ( $error ) {
 438       $dbh->rollback if $oldAutoCommit;
 439       return $error;
 440     }
 441   }
 442
 443   my $conf = new FS::Conf;
 444
 445   if ($self->locationnum) {
 446     my @part_export =
 447       map qsearch( 'part_export', {exportnum=>$_} ),
 448         $conf->config('cust_location-exports'); #, $agentnum
 449
 450     foreach my $part_export ( @part_export ) {
 451       my $error = $part_export->export_pkg_location($self); #, @$export_args);
 452       if ( $error ) {
 453         $dbh->rollback if $oldAutoCommit;
 454         return "exporting to ". $part_export->exporttype.
 455                " (transaction rolled back): $error";
 456       }
 457     }
 458   }
 459
 460   if ( ! $import && $conf->config('ticket_system') && $options{ticket_subject} ) {
 461
 462     #this init stuff is still inefficient, but at least its limited to
 463     # the small number (any?) folks using ticket emailing on pkg order
 464
 465     #eval '
 466     #  use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
 467     #  use RT;
 468     #';
 469     #die $@ if $@;
 470     #
 471     #RT::LoadConfig();
 472     #RT::Init();
 473     use FS::TicketSystem;
 474     FS::TicketSystem->init();
 475
 476     my $q = new RT::Queue($RT::SystemUser);
 477     $q->Load($options{ticket_queue}) if $options{ticket_queue};
 478     my $t = new RT::Ticket($RT::SystemUser);
 479     my $mime = new MIME::Entity;
 480     $mime->build( Type => 'text/plain', Data => $options{ticket_subject} );
 481     $t->Create( $options{ticket_queue} ? (Queue => $q) : (),
 482                 Subject => $options{ticket_subject},
 483                 MIMEObj => $mime,
 484               );
 485     $t->AddLink( Type   => 'MemberOf',
 486                  Target => 'freeside://freeside/cust_main/'. $self->custnum,
 487                );
 488   }
 489
 490   if (! $import && $conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
 491     my $queue = new FS::queue {
 492       'job'     => 'FS::cust_main::queueable_print',
 493     };
 494     $error = $queue->insert(
 495       'custnum'  => $self->custnum,
 496       'template' => 'welcome_letter',
 497     );
 498
 499     if ($error) {
 500       warn "can't send welcome letter: $error";
 501     }
 502
 503   }
 504
 505   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 506   '';
 507
 508 }
 509
 510 =item delete
 511
 512 This method now works but you probably shouldn't use it.
 513
 514 You don't want to delete packages, because there would then be no record
 515 the customer ever purchased the package.  Instead, see the cancel method and
 516 hide cancelled packages.
 517
 518 =cut
 519
 520 # this is still used internally to abort future package changes, so it
 521 # does need to work
 522
 523 sub delete {
 524   my $self = shift;
 525
 526   # The following foreign keys to cust_pkg are not cleaned up here, and will
 527   # cause package deletion to fail:
 528   #
 529   # cust_credit.pkgnum and commission_pkgnum (and cust_credit_void)
 530   # cust_credit_bill.pkgnum
 531   # cust_pay_pending.pkgnum
 532   # cust_pay.pkgnum (and cust_pay_void)
 533   # cust_bill_pay.pkgnum (wtf, shouldn't reference pkgnum)
 534   # cust_pkg_usage.pkgnum
 535   # cust_pkg.uncancel_pkgnum, change_pkgnum, main_pkgnum, and change_to_pkgnum
 536
 537   # cust_svc is handled by canceling the package before deleting it
 538   # cust_pkg_option is handled via option_Common
 539
 540   my $oldAutoCommit = $FS::UID::AutoCommit;
 541   local $FS::UID::AutoCommit = 0;
 542   my $dbh = dbh;
 543
 544   foreach my $cust_pkg_discount ($self->cust_pkg_discount) {
 545     my $error = $cust_pkg_discount->delete;
 546     if ( $error ) {
 547       $dbh->rollback if $oldAutoCommit;
 548       return $error;
 549     }
 550   }
 551   #cust_bill_pkg_discount?
 552
 553   foreach my $cust_pkg_detail ($self->cust_pkg_detail) {
 554     my $error = $cust_pkg_detail->delete;
 555     if ( $error ) {
 556       $dbh->rollback if $oldAutoCommit;
 557       return $error;
 558     }
 559   }
 560
 561   foreach my $cust_pkg_reason (
 562     qsearchs( {
 563                 'table' => 'cust_pkg_reason',
 564                 'hashref' => { 'pkgnum' => $self->pkgnum },
 565               }
 566             )
 567   ) {
 568     my $error = $cust_pkg_reason->delete;
 569     if ( $error ) {
 570       $dbh->rollback if $oldAutoCommit;
 571       return $error;
 572     }
 573   }
 574
 575   foreach my $pkg_referral ( $self->pkg_referral ) {
 576     my $error = $pkg_referral->delete;
 577     if ( $error ) {
 578       $dbh->rollback if $oldAutoCommit;
 579       return $error;
 580     }
 581   }
 582
 583   my $error = $self->SUPER::delete(@_);
 584   if ( $error ) {
 585     $dbh->rollback if $oldAutoCommit;
 586     return $error;
 587   }
 588
 589   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 590
 591   '';
 592
 593 }
 594
 595 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
 596
 597 Replaces the OLD_RECORD with this one in the database.  If there is an error,
 598 returns the error, otherwise returns false.
 599
 600 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
 601
 602 Changing pkgpart may have disasterous effects.  See the order subroutine.
 603
 604 setup and bill are normally updated by calling the bill method of a customer
 605 object (see L<FS::cust_main>).
 606
 607 suspend is normally updated by the suspend and unsuspend methods.
 608
 609 cancel is normally updated by the cancel method (and also the order subroutine
 610 in some cases).
 611
 612 Available options are:
 613
 614 =over 4
 615
 616 =item reason
 617
 618 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.
 619
 620 =item reason_otaker
 621
 622 the access_user (see L<FS::access_user>) providing the reason
 623
 624 =item options
 625
 626 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
 627
 628 =back
 629
 630 =cut
 631
 632 sub replace {
 633   my $new = shift;
 634
 635   my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
 636               ? shift
 637               : $new->replace_old;
 638
 639   my $options =
 640     ( ref($_[0]) eq 'HASH' )
 641       ? shift
 642       : { @_ };
 643
 644   #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
 645   #return "Can't change otaker!" if $old->otaker ne $new->otaker;
 646
 647   #allow this *sigh*
 648   #return "Can't change setup once it exists!"
 649   #  if $old->getfield('setup') &&
 650   #     $old->getfield('setup') != $new->getfield('setup');
 651
 652   #some logic for bill, susp, cancel?
 653
 654   local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
 655
 656   my $oldAutoCommit = $FS::UID::AutoCommit;
 657   local $FS::UID::AutoCommit = 0;
 658   my $dbh = dbh;
 659
 660   foreach my $method ( qw(adjourn expire) ) {  # How many reasons?
 661     if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
 662       my $error = $new->insert_reason(
 663         'reason'        => $options->{'reason'},
 664         'date'          => $new->$method,
 665         'action'        => $method,
 666         'reason_otaker' => $options->{'reason_otaker'},
 667       );
 668       if ( $error ) {
 669         dbh->rollback if $oldAutoCommit;
 670         return "Error inserting cust_pkg_reason: $error";
 671       }
 672     }
 673   }
 674
 675   #save off and freeze RADIUS attributes for any associated svc_acct records
 676   my @svc_acct = ();
 677   if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
 678
 679                 #also check for specific exports?
 680                 # to avoid spurious modify export events
 681     @svc_acct = map  { $_->svc_x }
 682                 grep { $_->part_svc->svcdb eq 'svc_acct' }
 683                      $old->cust_svc;
 684
 685     $_->snapshot foreach @svc_acct;
 686
 687   }
 688
 689   my $error =  $new->export_pkg_change($old)
 690             || $new->SUPER::replace( $old,
 691                                      $options->{options}
 692                                        ? $options->{options}
 693                                        : ()
 694                                    );
 695   if ( $error ) {
 696     $dbh->rollback if $oldAutoCommit;
 697     return $error;
 698   }
 699
 700   #for prepaid packages,
 701   #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
 702   foreach my $old_svc_acct ( @svc_acct ) {
 703     my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
 704     my $s_error =
 705       $new_svc_acct->replace( $old_svc_acct,
 706                               'depend_jobnum' => $options->{depend_jobnum},
 707                             );
 708     if ( $s_error ) {
 709       $dbh->rollback if $oldAutoCommit;
 710       return $s_error;
 711     }
 712   }
 713
 714   # also run exports if removing locationnum?
 715   #   doesn't seem to happen, and we don't export blank locationnum on insert...
 716   if ($new->locationnum and ($new->locationnum != $old->locationnum)) {
 717     my $conf = new FS::Conf;
 718     my @part_export =
 719       map qsearch( 'part_export', {exportnum=>$_} ),
 720         $conf->config('cust_location-exports'); #, $agentnum
 721
 722     foreach my $part_export ( @part_export ) {
 723       my $error = $part_export->export_pkg_location($new); #, @$export_args);
 724       if ( $error ) {
 725         $dbh->rollback if $oldAutoCommit;
 726         return "exporting to ". $part_export->exporttype.
 727                " (transaction rolled back): $error";
 728       }
 729     }
 730   }
 731
 732   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 733   '';
 734
 735 }
 736
 737 =item check
 738
 739 Checks all fields to make sure this is a valid billing item.  If there is an
 740 error, returns the error, otherwise returns false.  Called by the insert and
 741 replace methods.
 742
 743 =cut
 744
 745 sub check {
 746   my $self = shift;
 747
 748   if ( !$self->locationnum or $self->locationnum == -1 ) {
 749     $self->set('locationnum', $self->cust_main->ship_locationnum);
 750   }
 751
 752   my $error =
 753     $self->ut_numbern('pkgnum')
 754     || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
 755     || $self->ut_numbern('pkgpart')
 756     || $self->ut_foreign_keyn('contactnum',  'contact',       'contactnum' )
 757     || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
 758     || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
 759     || $self->ut_numbern('quantity')
 760     || $self->ut_numbern('start_date')
 761     || $self->ut_numbern('setup')
 762     || $self->ut_numbern('bill')
 763     || $self->ut_numbern('susp')
 764     || $self->ut_numbern('cancel')
 765     || $self->ut_numbern('adjourn')
 766     || $self->ut_numbern('resume')
 767     || $self->ut_numbern('expire')
 768     || $self->ut_numbern('dundate')
 769     || $self->ut_flag('no_auto', [ '', 'Y' ])
 770     || $self->ut_flag('waive_setup', [ '', 'Y' ])
 771     || $self->ut_flag('separate_bill')
 772     || $self->ut_textn('agent_pkgid')
 773     || $self->ut_enum('recur_show_zero', [ '', 'Y', 'N', ])
 774     || $self->ut_enum('setup_show_zero', [ '', 'Y', 'N', ])
 775     || $self->ut_foreign_keyn('main_pkgnum', 'cust_pkg', 'pkgnum')
 776     || $self->ut_foreign_keyn('pkglinknum', 'part_pkg_link', 'pkglinknum')
 777     || $self->ut_foreign_keyn('change_to_pkgnum', 'cust_pkg', 'pkgnum')
 778   ;
 779   return $error if $error;
 780
 781   return "A package with both start date (future start) and setup date (already started) will never bill"
 782     if $self->start_date && $self->setup && ! $upgrade;
 783
 784   return "A future unsuspend date can only be set for a package with a suspend date"
 785     if $self->resume and !$self->susp and !$self->adjourn;
 786
 787   $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
 788
 789   $self->SUPER::check;
 790 }
 791
 792 =item check_pkgpart
 793
 794 Check the pkgpart to make sure it's allowed with the reg_code and/or
 795 promo_code of the package (if present) and with the customer's agent.
 796 Called from C<insert>, unless we are doing a package change that doesn't
 797 affect pkgpart.
 798
 799 =cut
 800
 801 sub check_pkgpart {
 802   my $self = shift;
 803
 804   # my $error = $self->ut_numbern('pkgpart'); # already done
 805
 806   my $error;
 807   if ( $self->reg_code ) {
 808
 809     unless ( grep { $self->pkgpart == $_->pkgpart }
 810              map  { $_->reg_code_pkg }
 811              qsearchs( 'reg_code', { 'code'     => $self->reg_code,
 812                                      'agentnum' => $self->cust_main->agentnum })
 813            ) {
 814       return "Unknown registration code";
 815     }
 816
 817   } elsif ( $self->promo_code ) {
 818
 819     my $promo_part_pkg =
 820       qsearchs('part_pkg', {
 821         'pkgpart'    => $self->pkgpart,
 822         'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
 823       } );
 824     return 'Unknown promotional code' unless $promo_part_pkg;
 825
 826   } else {
 827
 828     unless ( $disable_agentcheck ) {
 829       my $agent =
 830         qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
 831       return "agent ". $agent->agentnum. ':'. $agent->agent.
 832              " can't purchase pkgpart ". $self->pkgpart
 833         unless $agent->pkgpart_hashref->{ $self->pkgpart }
 834             || $agent->agentnum == $self->part_pkg->agentnum;
 835     }
 836
 837     $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
 838     return $error if $error;
 839
 840   }
 841
 842   '';
 843
 844 }
 845
 846 =item cancel [ OPTION => VALUE ... ]
 847
 848 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
 849 in this package, then cancels the package itself (sets the cancel field to
 850 now).
 851
 852 Available options are:
 853
 854 =over 4
 855
 856 =item quiet - can be set true to supress email cancellation notices.
 857
 858 =item time -  can be set to cancel the package based on a specific future or
 859 historical date.  Using time ensures that the remaining amount is calculated
 860 correctly.  Note however that this is an immediate cancel and just changes
 861 the date.  You are PROBABLY looking to expire the account instead of using
 862 this.
 863
 864 =item reason - can be set to a cancellation reason (see L<FS:reason>),
 865 either a reasonnum of an existing reason, or passing a hashref will create
 866 a new reason.  The hashref should have the following keys: typenum - Reason
 867 type (see L<FS::reason_type>, reason - Text of the new reason.
 868
 869 =item date - can be set to a unix style timestamp to specify when to
 870 cancel (expire)
 871
 872 =item nobill - can be set true to skip billing if it might otherwise be done.
 873
 874 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
 875 not credit it.  This must be set (by change()) when changing the package
 876 to a different pkgpart or location, and probably shouldn't be in any other
 877 case.  If it's not set, the 'unused_credit_cancel' part_pkg option will
 878 be used.
 879
 880 =item no_delay_cancel - prevents delay_cancel behavior
 881 no matter what other options say, for use when changing packages (or any
 882 other time you're really sure you want an immediate cancel)
 883
 884 =back
 885
 886 If there is an error, returns the error, otherwise returns false.
 887
 888 =cut
 889
 890 #NOT DOCUMENTING - this should only be used when calling recursively
 891 #=item delay_cancel - for internal use, to allow proper handling of
 892 #supplemental packages when the main package is flagged to suspend
 893 #before cancelling, probably shouldn't be used otherwise (set the
 894 #corresponding package option instead)
 895
 896 sub cancel {
 897   my( $self, %options ) = @_;
 898   my $error;
 899
 900   # supplemental packages can now be separately canceled, though the UI
 901   # shouldn't permit it
 902   #
 903   ## pass all suspend/cancel actions to the main package
 904   ## (unless the pkglinknum has been removed, then the link is defunct and
 905   ## this package can be canceled on its own)
 906   #if ( $self->main_pkgnum and $self->pkglinknum and !$options{'from_main'} ) {
 907   #  return $self->main_pkg->cancel(%options);
 908   #}
 909
 910   my $conf = new FS::Conf;
 911
 912   warn "cust_pkg::cancel called with options".
 913        join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
 914     if $DEBUG;
 915
 916   my $oldAutoCommit = $FS::UID::AutoCommit;
 917   local $FS::UID::AutoCommit = 0;
 918   my $dbh = dbh;
 919
 920   my $old = $self->select_for_update;
 921
 922   if ( $old->get('cancel') || $self->get('cancel') ) {
 923     dbh->rollback if $oldAutoCommit;
 924     return "";  # no error
 925   }
 926
 927   # XXX possibly set cancel_time to the expire date?
 928   my $cancel_time = $options{'time'} || time;
 929   my $date = $options{'date'} if $options{'date'}; # expire/cancel later
 930   $date = '' if ($date && $date <= $cancel_time);      # complain instead?
 931
 932   my $delay_cancel = $options{'no_delay_cancel'} ? 0 : $options{'delay_cancel'};
 933   if ( !$date && $self->part_pkg->option('delay_cancel',1)
 934        && (($self->status eq 'active') || ($self->status eq 'suspended'))
 935        && !$options{'no_delay_cancel'}
 936   ) {
 937     my $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
 938     my $expsecs = 60*60*24*$expdays;
 939     my $suspfor = $self->susp ? $cancel_time - $self->susp : 0;
 940     $expsecs = $expsecs - $suspfor if $suspfor;
 941     unless ($expsecs <= 0) { #if it's already been suspended long enough, don't re-suspend
 942       $delay_cancel = 1;
 943       $date = $cancel_time + $expsecs;
 944     }
 945   }
 946
 947   #race condition: usage could be ongoing until unprovisioned
 948   #resolved by performing a change package instead (which unprovisions) and
 949   #later cancelling
 950   if ( !$options{nobill} && !$date ) {
 951     # && $conf->exists('bill_usage_on_cancel') ) { #calc_cancel checks this
 952       my $copy = $self->new({$self->hash});
 953       my $error =
 954         $copy->cust_main->bill( 'pkg_list' => [ $copy ],
 955                                 'cancel'   => 1,
 956                                 'time'     => $cancel_time );
 957       warn "Error billing during cancel, custnum ".
 958         #$self->cust_main->custnum. ": $error"
 959         ": $error"
 960         if $error;
 961   }
 962
 963   if ( $options{'reason'} ) {
 964     $error = $self->insert_reason( 'reason' => $options{'reason'},
 965                                    'action' => $date ? 'expire' : 'cancel',
 966                                    'date'   => $date ? $date : $cancel_time,
 967                                    'reason_otaker' => $options{'reason_otaker'},
 968                                  );
 969     if ( $error ) {
 970       dbh->rollback if $oldAutoCommit;
 971       return "Error inserting cust_pkg_reason: $error";
 972     }
 973   }
 974
 975   my %svc_cancel_opt = ();
 976   $svc_cancel_opt{'date'} = $date if $date;
 977   foreach my $cust_svc (
 978     #schwartz
 979     map  { $_->[0] }
 980     sort { $a->[1] <=> $b->[1] }
 981     map  { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; }
 982     qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
 983   ) {
 984     my $part_svc = $cust_svc->part_svc;
 985     next if ( defined($part_svc) and $part_svc->preserve );
 986     my $error = $cust_svc->cancel( %svc_cancel_opt );
 987
 988     if ( $error ) {
 989       $dbh->rollback if $oldAutoCommit;
 990       return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
 991              " cust_svc: $error";
 992     }
 993   }
 994
 995   # if a reasonnum was passed, get the actual reason object so we can check
 996   # unused_credit
 997
 998   my $reason;
 999   if ($options{'reason'} =~ /^\d+$/) {
1000     $reason = FS::reason->by_key($options{'reason'});
1001   }
1002
1003   unless ($date) {
1004     # credit remaining time if any of these are true:
1005     # - unused_credit => 1 was passed (this happens when canceling a package
1006     #   for a package change when unused_credit_change is set)
1007     # - no unused_credit option, and there is a cancel reason, and the cancel
1008     #   reason says to credit the package
1009     # - no unused_credit option, and the package definition says to credit the
1010     #   package on cancellation
1011     my $do_credit;
1012     if ( exists($options{'unused_credit'}) ) {
1013       $do_credit = $options{'unused_credit'};
1014     } elsif ( defined($reason) && $reason->unused_credit ) {
1015       $do_credit = 1;
1016     } else {
1017       $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
1018     }
1019     if ( $do_credit ) {
1020       my $error = $self->credit_remaining('cancel', $cancel_time);
1021       if ($error) {
1022         $dbh->rollback if $oldAutoCommit;
1023         return $error;
1024       }
1025     }
1026   } #unless $date
1027
1028   my %hash = $self->hash;
1029   if ( $date ) {
1030     $hash{'expire'} = $date;
1031     if ($delay_cancel) {
1032       # just to be sure these are clear
1033       $hash{'adjourn'} = undef;
1034       $hash{'resume'} = undef;
1035     }
1036   } else {
1037     $hash{'cancel'} = $cancel_time;
1038   }
1039   $hash{'change_custnum'} = $options{'change_custnum'};
1040
1041   # if this is a supplemental package that's lost its part_pkg_link, and it's
1042   # being canceled for real, unlink it completely
1043   if ( !$date and ! $self->pkglinknum ) {
1044     $hash{main_pkgnum} = '';
1045   }
1046
1047   # if there is a future package change scheduled, unlink from it (like
1048   # abort_change) first, then delete it.
1049   $hash{'change_to_pkgnum'} = '';
1050
1051   # save the package state
1052   my $new = new FS::cust_pkg ( \%hash );
1053   $error = $new->replace( $self, options => { $self->options } );
1054
1055   if ( $self->change_to_pkgnum ) {
1056     my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
1057     $error ||= $change_to->cancel('no_delay_cancel' => 1) || $change_to->delete;
1058   }
1059   if ( $error ) {
1060     $dbh->rollback if $oldAutoCommit;
1061     return $error;
1062   }
1063
1064   foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1065     $error = $supp_pkg->cancel(%options,
1066       'from_main' => 1,
1067       'date' => $date, #in case it got changed by delay_cancel
1068       'delay_cancel' => $delay_cancel,
1069     );
1070     if ( $error ) {
1071       $dbh->rollback if $oldAutoCommit;
1072       return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1073     }
1074   }
1075
1076   if ($delay_cancel && !$options{'from_main'}) {
1077     $error = $new->suspend(
1078       'from_cancel' => 1,
1079       'time'        => $cancel_time
1080     );
1081   }
1082
1083   unless ($date) {
1084     foreach my $usage ( $self->cust_pkg_usage ) {
1085       $error = $usage->delete;
1086       if ( $error ) {
1087         $dbh->rollback if $oldAutoCommit;
1088         return "deleting usage pools: $error";
1089       }
1090     }
1091   }
1092
1093   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1094   return '' if $date; #no errors
1095
1096   my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
1097   if ( !$options{'quiet'} &&
1098         $conf->exists('emailcancel', $self->cust_main->agentnum) &&
1099         @invoicing_list ) {
1100     my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
1101     my $error = '';
1102     if ( $msgnum ) {
1103       my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
1104       $error = $msg_template->send( 'cust_main' => $self->cust_main,
1105                                     'object'    => $self );
1106     }
1107     #should this do something on errors?
1108   }
1109
1110   ''; #no errors
1111
1112 }
1113
1114 =item cancel_if_expired [ NOW_TIMESTAMP ]
1115
1116 Cancels this package if its expire date has been reached.
1117
1118 =cut
1119
1120 sub cancel_if_expired {
1121   my $self = shift;
1122   my $time = shift || time;
1123   return '' unless $self->expire && $self->expire <= $time;
1124   my $error = $self->cancel;
1125   if ( $error ) {
1126     return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
1127            $self->custnum. ": $error";
1128   }
1129   '';
1130 }
1131
1132 =item uncancel
1133
1134 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
1135 locationnum, (other fields?).  Attempts to re-provision cancelled services
1136 using history information (errors at this stage are not fatal).
1137
1138 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
1139
1140 svc_fatal: service provisioning errors are fatal
1141
1142 svc_errors: pass an array reference, will be filled in with any provisioning errors
1143
1144 main_pkgnum: link the package as a supplemental package of this one.  For
1145 internal use only.
1146
1147 =cut
1148
1149 sub uncancel {
1150   my( $self, %options ) = @_;
1151
1152   #in case you try do do $uncancel-date = $cust_pkg->uncacel
1153   return '' unless $self->get('cancel');
1154
1155   if ( $self->main_pkgnum and !$options{'main_pkgnum'} ) {
1156     return $self->main_pkg->uncancel(%options);
1157   }
1158
1159   ##
1160   # Transaction-alize
1161   ##
1162
1163   my $oldAutoCommit = $FS::UID::AutoCommit;
1164   local $FS::UID::AutoCommit = 0;
1165   my $dbh = dbh;
1166
1167   ##
1168   # insert the new package
1169   ##
1170
1171   my $cust_pkg = new FS::cust_pkg {
1172     last_bill       => ( $options{'last_bill'} || $self->get('last_bill') ),
1173     bill            => ( $options{'bill'}      || $self->get('bill')      ),
1174     uncancel        => time,
1175     uncancel_pkgnum => $self->pkgnum,
1176     main_pkgnum     => ($options{'main_pkgnum'} || ''),
1177     map { $_ => $self->get($_) } qw(
1178       custnum pkgpart locationnum
1179       setup
1180       susp adjourn resume expire start_date contract_end dundate
1181       change_date change_pkgpart change_locationnum
1182       no_auto separate_bill quantity agent_pkgid
1183       recur_show_zero setup_show_zero
1184     ),
1185   };
1186
1187   my $error = $cust_pkg->insert(
1188     'change' => 1, #supresses any referral credit to a referring customer
1189     'allow_pkgpart' => 1, # allow this even if the package def is disabled
1190   );
1191   if ($error) {
1192     $dbh->rollback if $oldAutoCommit;
1193     return $error;
1194   }
1195
1196   ##
1197   # insert services
1198   ##
1199
1200   #find historical services within this timeframe before the package cancel
1201   # (incompatible with "time" option to cust_pkg->cancel?)
1202   my $fuzz = 2 * 60; #2 minutes?  too much?   (might catch separate unprovision)
1203                      #            too little? (unprovisioing export delay?)
1204   my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
1205   my @h_cust_svc = $self->h_cust_svc( $end, $start );
1206
1207   my @svc_errors;
1208   foreach my $h_cust_svc (@h_cust_svc) {
1209     my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
1210     #next unless $h_svc_x; #should this happen?
1211     (my $table = $h_svc_x->table) =~ s/^h_//;
1212     require "FS/$table.pm";
1213     my $class = "FS::$table";
1214     my $svc_x = $class->new( {
1215       'pkgnum'  => $cust_pkg->pkgnum,
1216       'svcpart' => $h_cust_svc->svcpart,
1217       map { $_ => $h_svc_x->get($_) } fields($table)
1218     } );
1219
1220     # radius_usergroup
1221     if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
1222       $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
1223     }
1224
1225     my $svc_error = $svc_x->insert;
1226     if ( $svc_error ) {
1227       if ( $options{svc_fatal} ) {
1228         $dbh->rollback if $oldAutoCommit;
1229         return $svc_error;
1230       } else {
1231         # if we've failed to insert the svc_x object, svc_Common->insert
1232         # will have removed the cust_svc already.  if not, then both records
1233         # were inserted but we failed for some other reason (export, most
1234         # likely).  in that case, report the error and delete the records.
1235         push @svc_errors, $svc_error;
1236         my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1237         if ( $cust_svc ) {
1238           # except if export_insert failed, export_delete probably won't be
1239           # much better
1240           local $FS::svc_Common::noexport_hack = 1;
1241           my $cleanup_error = $svc_x->delete; # also deletes cust_svc
1242           if ( $cleanup_error ) { # and if THAT fails, then run away
1243             $dbh->rollback if $oldAutoCommit;
1244             return $cleanup_error;
1245           }
1246         }
1247       } # svc_fatal
1248     } # svc_error
1249   } #foreach $h_cust_svc
1250
1251   #these are pretty rare, but should handle them
1252   # - dsl_device (mac addresses)
1253   # - phone_device (mac addresses)
1254   # - dsl_note (ikano notes)
1255   # - domain_record (i.e. restore DNS information w/domains)
1256   # - inventory_item(?) (inventory w/un-cancelling service?)
1257   # - nas (svc_broaband nas stuff)
1258   #this stuff is unused in the wild afaik
1259   # - mailinglistmember
1260   # - router.svcnum?
1261   # - svc_domain.parent_svcnum?
1262   # - acct_snarf (ancient mail fetching config)
1263   # - cgp_rule (communigate)
1264   # - cust_svc_option (used by our Tron stuff)
1265   # - acct_rt_transaction (used by our time worked stuff)
1266
1267   ##
1268   # also move over any services that didn't unprovision at cancellation
1269   ##
1270
1271   foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1272     $cust_svc->pkgnum( $cust_pkg->pkgnum );
1273     my $error = $cust_svc->replace;
1274     if ( $error ) {
1275       $dbh->rollback if $oldAutoCommit;
1276       return $error;
1277     }
1278   }
1279
1280   ##
1281   # Uncancel any supplemental packages, and make them supplemental to the
1282   # new one.
1283   ##
1284
1285   foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1286     my $new_pkg;
1287     $error = $supp_pkg->uncancel(%options, 'main_pkgnum' => $cust_pkg->pkgnum);
1288     if ( $error ) {
1289       $dbh->rollback if $oldAutoCommit;
1290       return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1291     }
1292   }
1293
1294   ##
1295   # Finish
1296   ##
1297
1298   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1299
1300   ${ $options{cust_pkg} }   = $cust_pkg   if ref($options{cust_pkg});
1301   @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1302
1303   '';
1304 }
1305
1306 =item unexpire
1307
1308 Cancels any pending expiration (sets the expire field to null).
1309
1310 If there is an error, returns the error, otherwise returns false.
1311
1312 =cut
1313
1314 sub unexpire {
1315   my( $self, %options ) = @_;
1316   my $error;
1317
1318   my $oldAutoCommit = $FS::UID::AutoCommit;
1319   local $FS::UID::AutoCommit = 0;
1320   my $dbh = dbh;
1321
1322   my $old = $self->select_for_update;
1323
1324   my $pkgnum = $old->pkgnum;
1325   if ( $old->get('cancel') || $self->get('cancel') ) {
1326     dbh->rollback if $oldAutoCommit;
1327     return "Can't unexpire cancelled package $pkgnum";
1328     # or at least it's pointless
1329   }
1330
1331   unless ( $old->get('expire') && $self->get('expire') ) {
1332     dbh->rollback if $oldAutoCommit;
1333     return "";  # no error
1334   }
1335
1336   my %hash = $self->hash;
1337   $hash{'expire'} = '';
1338   my $new = new FS::cust_pkg ( \%hash );
1339   $error = $new->replace( $self, options => { $self->options } );
1340   if ( $error ) {
1341     $dbh->rollback if $oldAutoCommit;
1342     return $error;
1343   }
1344
1345   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1346
1347   ''; #no errors
1348
1349 }
1350
1351 =item suspend [ OPTION => VALUE ... ]
1352
1353 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1354 package, then suspends the package itself (sets the susp field to now).
1355
1356 Available options are:
1357
1358 =over 4
1359
1360 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1361 either a reasonnum of an existing reason, or passing a hashref will create
1362 a new reason.  The hashref should have the following keys:
1363 - typenum - Reason type (see L<FS::reason_type>
1364 - reason - Text of the new reason.
1365
1366 =item date - can be set to a unix style timestamp to specify when to
1367 suspend (adjourn)
1368
1369 =item time - can be set to override the current time, for calculation
1370 of final invoices or unused-time credits
1371
1372 =item resume_date - can be set to a time when the package should be
1373 unsuspended.  This may be more convenient than calling C<unsuspend()>
1374 separately.
1375
1376 =item from_main - allows a supplemental package to be suspended, rather
1377 than redirecting the method call to its main package.  For internal use.
1378
1379 =item from_cancel - used when suspending from the cancel method, forces
1380 this to skip everything besides basic suspension.  For internal use.
1381
1382 =back
1383
1384 If there is an error, returns the error, otherwise returns false.
1385
1386 =cut
1387
1388 sub suspend {
1389   my( $self, %options ) = @_;
1390   my $error;
1391
1392   # supplemental packages still can't be separately suspended, but silently
1393   # exit instead of failing or passing the action to the main package (so
1394   # that the "Suspend customer" action doesn't trip over the supplemental
1395   # packages and die)
1396
1397   if ( $self->main_pkgnum and !$options{'from_main'} ) {
1398     return;
1399   }
1400
1401   my $oldAutoCommit = $FS::UID::AutoCommit;
1402   local $FS::UID::AutoCommit = 0;
1403   my $dbh = dbh;
1404
1405   my $old = $self->select_for_update;
1406
1407   my $pkgnum = $old->pkgnum;
1408   if ( $old->get('cancel') || $self->get('cancel') ) {
1409     dbh->rollback if $oldAutoCommit;
1410     return "Can't suspend cancelled package $pkgnum";
1411   }
1412
1413   if ( $old->get('susp') || $self->get('susp') ) {
1414     dbh->rollback if $oldAutoCommit;
1415     return "";  # no error                     # complain on adjourn?
1416   }
1417
1418   my $suspend_time = $options{'time'} || time;
1419   my $date = $options{date} if $options{date}; # adjourn/suspend later
1420   $date = '' if ($date && $date <= $suspend_time); # complain instead?
1421
1422   if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1423     dbh->rollback if $oldAutoCommit;
1424     return "Package $pkgnum expires before it would be suspended.";
1425   }
1426
1427   # some false laziness with sub cancel
1428   if ( !$options{nobill} && !$date && !$options{'from_cancel'} &&
1429        $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1430     # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1431     # make the entire cust_main->bill path recognize 'suspend' and
1432     # 'cancel' separately.
1433     warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1434     my $copy = $self->new({$self->hash});
1435     my $error =
1436       $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1437                               'cancel'   => 1,
1438                               'time'     => $suspend_time );
1439     warn "Error billing during suspend, custnum ".
1440       #$self->cust_main->custnum. ": $error"
1441       ": $error"
1442       if $error;
1443   }
1444
1445   my $cust_pkg_reason;
1446   if ( $options{'reason'} ) {
1447     $error = $self->insert_reason( 'reason' => $options{'reason'},
1448                                    'action' => $date ? 'adjourn' : 'suspend',
1449                                    'date'   => $date ? $date : $suspend_time,
1450                                    'reason_otaker' => $options{'reason_otaker'},
1451                                  );
1452     if ( $error ) {
1453       dbh->rollback if $oldAutoCommit;
1454       return "Error inserting cust_pkg_reason: $error";
1455     }
1456     $cust_pkg_reason = qsearchs('cust_pkg_reason', {
1457         'date'    => $date ? $date : $suspend_time,
1458         'action'  => $date ? 'A' : 'S',
1459         'pkgnum'  => $self->pkgnum,
1460     });
1461   }
1462
1463   # if a reasonnum was passed, get the actual reason object so we can check
1464   # unused_credit
1465   # (passing a reason hashref is still allowed, but it can't be used with
1466   # the fancy behavioral options.)
1467
1468   my $reason;
1469   if ($options{'reason'} =~ /^\d+$/) {
1470     $reason = FS::reason->by_key($options{'reason'});
1471   }
1472
1473   my %hash = $self->hash;
1474   if ( $date ) {
1475     $hash{'adjourn'} = $date;
1476   } else {
1477     $hash{'susp'} = $suspend_time;
1478   }
1479
1480   my $resume_date = $options{'resume_date'} || 0;
1481   if ( $resume_date > ($date || $suspend_time) ) {
1482     $hash{'resume'} = $resume_date;
1483   }
1484
1485   $options{options} ||= {};
1486
1487   my $new = new FS::cust_pkg ( \%hash );
1488   $error = $new->replace( $self, options => { $self->options,
1489                                               %{ $options{options} },
1490                                             }
1491                         );
1492   if ( $error ) {
1493     $dbh->rollback if $oldAutoCommit;
1494     return $error;
1495   }
1496
1497   unless ( $date ) { # then we are suspending now
1498
1499     unless ($options{'from_cancel'}) {
1500       # credit remaining time if appropriate
1501       # (if required by the package def, or the suspend reason)
1502       my $unused_credit = $self->part_pkg->option('unused_credit_suspend',1)
1503                           || ( defined($reason) && $reason->unused_credit );
1504
1505       if ( $unused_credit ) {
1506         warn "crediting unused time on pkg#".$self->pkgnum."\n" if $DEBUG;
1507         my $error = $self->credit_remaining('suspend', $suspend_time);
1508         if ($error) {
1509           $dbh->rollback if $oldAutoCommit;
1510           return $error;
1511         }
1512       }
1513     }
1514
1515     my @cust_svc = qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } );
1516
1517     #attempt ordering ala cust_svc_suspend_cascade (without infinite-looping
1518     # on the circular dep case)
1519     #  (this is too simple for multi-level deps, we need to use something
1520     #   to resolve the DAG properly when possible)
1521     my %svcpart = ();
1522     $svcpart{$_->svcpart} = 0 foreach @cust_svc;
1523     foreach my $svcpart ( keys %svcpart ) {
1524       foreach my $part_svc_link (
1525         FS::part_svc_link->by_agentnum($self->cust_main->agentnum,
1526                                          src_svcpart => $svcpart,
1527                                          link_type => 'cust_svc_suspend_cascade'
1528                                       )
1529       ) {
1530         $svcpart{$part_svc_link->dst_svcpart} = max(
1531           $svcpart{$part_svc_link->dst_svcpart},
1532           $svcpart{$part_svc_link->src_svcpart} + 1
1533         );
1534       }
1535     }
1536     @cust_svc = sort { $svcpart{ $a->svcpart } <=> $svcpart{ $b->svcpart } }
1537                   @cust_svc;
1538
1539     my @labels = ();
1540     foreach my $cust_svc ( @cust_svc ) {
1541       $cust_svc->suspend( 'labels_arrayref' => \@labels );
1542     }
1543
1544     # suspension fees: if there is a feepart, and it's not an unsuspend fee,
1545     # and this is not a suspend-before-cancel
1546     if ( $cust_pkg_reason ) {
1547       my $reason_obj = $cust_pkg_reason->reason;
1548       if ( $reason_obj->feepart and
1549            ! $reason_obj->fee_on_unsuspend and
1550            ! $options{'from_cancel'} ) {
1551
1552         # register the need to charge a fee, cust_main->bill will do the rest
1553         warn "registering suspend fee: pkgnum ".$self->pkgnum.", feepart ".$reason->feepart."\n"
1554           if $DEBUG;
1555         my $cust_pkg_reason_fee = FS::cust_pkg_reason_fee->new({
1556             'pkgreasonnum'  => $cust_pkg_reason->num,
1557             'pkgnum'        => $self->pkgnum,
1558             'feepart'       => $reason->feepart,
1559             'nextbill'      => $reason->fee_hold,
1560         });
1561         $error ||= $cust_pkg_reason_fee->insert;
1562       }
1563     }
1564
1565     my $conf = new FS::Conf;
1566     if ( $conf->config('suspend_email_admin') && !$options{'from_cancel'} ) {
1567
1568       my $error = send_email(
1569         'from'    => $conf->config('invoice_from', $self->cust_main->agentnum),
1570                                    #invoice_from ??? well as good as any
1571         'to'      => $conf->config('suspend_email_admin'),
1572         'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1573         'body'    => [
1574           "This is an automatic message from your Freeside installation\n",
1575           "informing you that the following customer package has been suspended:\n",
1576           "\n",
1577           'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1578           'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1579           ( map { "Service : $_\n" } @labels ),
1580         ],
1581         'custnum' => $self->custnum,
1582         'msgtype' => 'admin'
1583       );
1584
1585       if ( $error ) {
1586         warn "WARNING: can't send suspension admin email (suspending anyway): ".
1587              "$error\n";
1588       }
1589
1590     }
1591
1592   }
1593
1594   foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1595     $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1596     if ( $error ) {
1597       $dbh->rollback if $oldAutoCommit;
1598       return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1599     }
1600   }
1601
1602   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1603
1604   ''; #no errors
1605 }
1606
1607 =item credit_remaining MODE TIME
1608
1609 Generate a credit for this package for the time remaining in the current
1610 billing period.  MODE is either "suspend" or "cancel" (determines the
1611 credit type).  TIME is the time of suspension/cancellation.  Both arguments
1612 are mandatory.
1613
1614 =cut
1615
1616 # Implementation note:
1617 #
1618 # If you pkgpart-change a package that has been billed, and it's set to give
1619 # credit on package change, then this method gets called and then the new
1620 # package will have no last_bill date. Therefore the customer will be credited
1621 # only once (per billing period) even if there are multiple package changes.
1622 #
1623 # If you location-change a package that has been billed, this method will NOT
1624 # be called and the new package WILL have the last bill date of the old
1625 # package.
1626 #
1627 # If the new package is then canceled within the same billing cycle,
1628 # credit_remaining needs to run calc_remain on the OLD package to determine
1629 # the amount of unused time to credit.
1630
1631 sub credit_remaining {
1632   # Add a credit for remaining service
1633   my ($self, $mode, $time) = @_;
1634   die 'credit_remaining requires suspend or cancel'
1635     unless $mode eq 'suspend' or $mode eq 'cancel';
1636   die 'no suspend/cancel time' unless $time > 0;
1637
1638   my $conf = FS::Conf->new;
1639   my $reason_type = $conf->config($mode.'_credit_type');
1640
1641   my $last_bill = $self->getfield('last_bill') || 0;
1642   my $next_bill = $self->getfield('bill') || 0;
1643   if ( $last_bill > 0         # the package has been billed
1644       and $next_bill > 0      # the package has a next bill date
1645       and $next_bill >= $time # which is in the future
1646   ) {
1647     my @cust_credit_source_bill_pkg = ();
1648     my $remaining_value = 0;
1649
1650     my $remain_pkg = $self;
1651     $remaining_value = $remain_pkg->calc_remain(
1652       'time' => $time,
1653       'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1654     );
1655
1656     # we may have to walk back past some package changes to get to the
1657     # one that actually has unused time
1658     while ( $remaining_value == 0 ) {
1659       if ( $remain_pkg->change_pkgnum ) {
1660         $remain_pkg = FS::cust_pkg->by_key($remain_pkg->change_pkgnum);
1661       } else {
1662         # the package has really never been billed
1663         return;
1664       }
1665       $remaining_value = $remain_pkg->calc_remain(
1666         'time' => $time,
1667         'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1668       );
1669     }
1670
1671     if ( $remaining_value > 0 ) {
1672       warn "Crediting for $remaining_value on package ".$self->pkgnum."\n"
1673         if $DEBUG;
1674       my $error = $self->cust_main->credit(
1675         $remaining_value,
1676         'Credit for unused time on '. $self->part_pkg->pkg,
1677         'reason_type' => $reason_type,
1678         'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1679       );
1680       return "Error crediting customer \$$remaining_value for unused time".
1681         " on ". $self->part_pkg->pkg. ": $error"
1682         if $error;
1683     } #if $remaining_value
1684   } #if $last_bill, etc.
1685   '';
1686 }
1687
1688 =item unsuspend [ OPTION => VALUE ... ]
1689
1690 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1691 package, then unsuspends the package itself (clears the susp field and the
1692 adjourn field if it is in the past).  If the suspend reason includes an
1693 unsuspension package, that package will be ordered.
1694
1695 Available options are:
1696
1697 =over 4
1698
1699 =item date
1700
1701 Can be set to a date to unsuspend the package in the future (the 'resume'
1702 field).
1703
1704 =item adjust_next_bill
1705
1706 Can be set true to adjust the next bill date forward by
1707 the amount of time the account was inactive.  This was set true by default
1708 in the past (from 1.4.2 and 1.5.0pre6 through 1.7.0), but now needs to be
1709 explicitly requested with this option or in the price plan.
1710
1711 =back
1712
1713 If there is an error, returns the error, otherwise returns false.
1714
1715 =cut
1716
1717 sub unsuspend {
1718   my( $self, %opt ) = @_;
1719   my $error;
1720
1721   # pass all suspend/cancel actions to the main package
1722   if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1723     return $self->main_pkg->unsuspend(%opt);
1724   }
1725
1726   my $oldAutoCommit = $FS::UID::AutoCommit;
1727   local $FS::UID::AutoCommit = 0;
1728   my $dbh = dbh;
1729
1730   my $old = $self->select_for_update;
1731
1732   my $pkgnum = $old->pkgnum;
1733   if ( $old->get('cancel') || $self->get('cancel') ) {
1734     $dbh->rollback if $oldAutoCommit;
1735     return "Can't unsuspend cancelled package $pkgnum";
1736   }
1737
1738   unless ( $old->get('susp') && $self->get('susp') ) {
1739     $dbh->rollback if $oldAutoCommit;
1740     return "";  # no error                     # complain instead?
1741   }
1742
1743   # handle the case of setting a future unsuspend (resume) date
1744   # and do not continue to actually unsuspend the package
1745   my $date = $opt{'date'};
1746   if ( $date and $date > time ) { # return an error if $date <= time?
1747
1748     if ( $old->get('expire') && $old->get('expire') < $date ) {
1749       $dbh->rollback if $oldAutoCommit;
1750       return "Package $pkgnum expires before it would be unsuspended.";
1751     }
1752
1753     my $new = new FS::cust_pkg { $self->hash };
1754     $new->set('resume', $date);
1755     $error = $new->replace($self, options => $self->options);
1756
1757     if ( $error ) {
1758       $dbh->rollback if $oldAutoCommit;
1759       return $error;
1760     }
1761     else {
1762       $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1763       return '';
1764     }
1765
1766   } #if $date
1767
1768   if (!$self->setup) {
1769     # then this package is being released from on-hold status
1770     $error = $self->set_initial_timers;
1771     if ( $error ) {
1772       $dbh->rollback if $oldAutoCommit;
1773       return $error;
1774     }
1775   }
1776
1777   my @labels = ();
1778
1779   foreach my $cust_svc (
1780     qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1781   ) {
1782     my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1783
1784     $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1785       $dbh->rollback if $oldAutoCommit;
1786       return "Illegal svcdb value in part_svc!";
1787     };
1788     my $svcdb = $1;
1789     require "FS/$svcdb.pm";
1790
1791     my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1792     if ($svc) {
1793       $error = $svc->unsuspend;
1794       if ( $error ) {
1795         $dbh->rollback if $oldAutoCommit;
1796         return $error;
1797       }
1798       my( $label, $value ) = $cust_svc->label;
1799       push @labels, "$label: $value";
1800     }
1801
1802   }
1803
1804   my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1805   my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1806
1807   my %hash = $self->hash;
1808   my $inactive = time - $hash{'susp'};
1809
1810   my $conf = new FS::Conf;
1811
1812   #adjust the next bill date forward
1813   # increment next bill date if certain conditions are met:
1814   # - it was due to be billed at some point
1815   # - either the global or local config says to do this
1816   my $adjust_bill = 0;
1817   if (
1818        $inactive > 0
1819     && ( $hash{'bill'} || $hash{'setup'} )
1820     && (    $opt{'adjust_next_bill'}
1821          || $conf->exists('unsuspend-always_adjust_next_bill_date')
1822          || $self->part_pkg->option('unsuspend_adjust_bill', 1)
1823        )
1824   ) {
1825     $adjust_bill = 1;
1826   }
1827
1828   # but not if:
1829   # - the package billed during suspension
1830   # - or it was ordered on hold
1831   # - or the customer was credited for the unused time
1832
1833   if ( $self->option('suspend_bill',1)
1834       or ( $self->part_pkg->option('suspend_bill',1)
1835            and ! $self->option('no_suspend_bill',1)
1836          )
1837       or $hash{'order_date'} == $hash{'susp'}
1838   ) {
1839     $adjust_bill = 0;
1840   }
1841
1842   if ( $adjust_bill ) {
1843     if (    $self->part_pkg->option('unused_credit_suspend')
1844          or ( ref($reason) and $reason->unused_credit ) ) {
1845       # then the customer was credited for the unused time before suspending,
1846       # so their next bill should be immediate
1847       $hash{'bill'} = time;
1848     } else {
1849       # add the length of time suspended to the bill date
1850       $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1851     }
1852   }
1853
1854   $hash{'susp'} = '';
1855   $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1856   $hash{'resume'} = '' if !$hash{'adjourn'};
1857   my $new = new FS::cust_pkg ( \%hash );
1858   $error = $new->replace( $self, options => { $self->options } );
1859   if ( $error ) {
1860     $dbh->rollback if $oldAutoCommit;
1861     return $error;
1862   }
1863
1864   my $unsusp_pkg;
1865
1866   if ( $reason ) {
1867     if ( $reason->unsuspend_pkgpart ) {
1868       warn "Suspend reason '".$reason->reason."' uses deprecated unsuspend_pkgpart feature.\n";
1869       my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
1870         or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
1871                     " not found.";
1872       my $start_date = $self->cust_main->next_bill_date
1873         if $reason->unsuspend_hold;
1874
1875       if ( $part_pkg ) {
1876         $unsusp_pkg = FS::cust_pkg->new({
1877             'custnum'     => $self->custnum,
1878             'pkgpart'     => $reason->unsuspend_pkgpart,
1879             'start_date'  => $start_date,
1880             'locationnum' => $self->locationnum,
1881             # discount? probably not...
1882         });
1883
1884         $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
1885       }
1886     }
1887     # new way, using fees
1888     if ( $reason->feepart and $reason->fee_on_unsuspend ) {
1889       # register the need to charge a fee, cust_main->bill will do the rest
1890       warn "registering unsuspend fee: pkgnum ".$self->pkgnum.", feepart ".$reason->feepart."\n"
1891         if $DEBUG;
1892       my $cust_pkg_reason_fee = FS::cust_pkg_reason_fee->new({
1893           'pkgreasonnum'  => $cust_pkg_reason->num,
1894           'pkgnum'        => $self->pkgnum,
1895           'feepart'       => $reason->feepart,
1896           'nextbill'      => $reason->fee_hold,
1897       });
1898       $error ||= $cust_pkg_reason_fee->insert;
1899     }
1900
1901     if ( $error ) {
1902       $dbh->rollback if $oldAutoCommit;
1903       return $error;
1904     }
1905   }
1906
1907   if ( $conf->config('unsuspend_email_admin') ) {
1908
1909     my $error = send_email(
1910       'from'    => $conf->config('invoice_from', $self->cust_main->agentnum),
1911                                  #invoice_from ??? well as good as any
1912       'to'      => $conf->config('unsuspend_email_admin'),
1913       'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended',       'body'    => [
1914         "This is an automatic message from your Freeside installation\n",
1915         "informing you that the following customer package has been unsuspended:\n",
1916         "\n",
1917         'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1918         'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1919         ( map { "Service : $_\n" } @labels ),
1920         ($unsusp_pkg ?
1921           "An unsuspension fee was charged: ".
1922             $unsusp_pkg->part_pkg->pkg_comment."\n"
1923           : ''
1924         ),
1925       ],
1926       'custnum' => $self->custnum,
1927       'msgtype' => 'admin',
1928     );
1929
1930     if ( $error ) {
1931       warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
1932            "$error\n";
1933     }
1934
1935   }
1936
1937   foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1938     $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
1939     if ( $error ) {
1940       $dbh->rollback if $oldAutoCommit;
1941       return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1942     }
1943   }
1944
1945   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1946
1947   ''; #no errors
1948 }
1949
1950 =item unadjourn
1951
1952 Cancels any pending suspension (sets the adjourn field to null).
1953
1954 If there is an error, returns the error, otherwise returns false.
1955
1956 =cut
1957
1958 sub unadjourn {
1959   my( $self, %options ) = @_;
1960   my $error;
1961
1962   my $oldAutoCommit = $FS::UID::AutoCommit;
1963   local $FS::UID::AutoCommit = 0;
1964   my $dbh = dbh;
1965
1966   my $old = $self->select_for_update;
1967
1968   my $pkgnum = $old->pkgnum;
1969   if ( $old->get('cancel') || $self->get('cancel') ) {
1970     dbh->rollback if $oldAutoCommit;
1971     return "Can't unadjourn cancelled package $pkgnum";
1972     # or at least it's pointless
1973   }
1974
1975   if ( $old->get('susp') || $self->get('susp') ) {
1976     dbh->rollback if $oldAutoCommit;
1977     return "Can't unadjourn suspended package $pkgnum";
1978     # perhaps this is arbitrary
1979   }
1980
1981   unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1982     dbh->rollback if $oldAutoCommit;
1983     return "";  # no error
1984   }
1985
1986   my %hash = $self->hash;
1987   $hash{'adjourn'} = '';
1988   $hash{'resume'}  = '';
1989   my $new = new FS::cust_pkg ( \%hash );
1990   $error = $new->replace( $self, options => { $self->options } );
1991   if ( $error ) {
1992     $dbh->rollback if $oldAutoCommit;
1993     return $error;
1994   }
1995
1996   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1997
1998   ''; #no errors
1999
2000 }
2001
2002
2003 =item change HASHREF | OPTION => VALUE ...
2004
2005 Changes this package: cancels it and creates a new one, with a different
2006 pkgpart or locationnum or both.  All services are transferred to the new
2007 package (no change will be made if this is not possible).
2008
2009 Options may be passed as a list of key/value pairs or as a hash reference.
2010 Options are:
2011
2012 =over 4
2013
2014 =item locationnum
2015
2016 New locationnum, to change the location for this package.
2017
2018 =item cust_location
2019
2020 New FS::cust_location object, to create a new location and assign it
2021 to this package.
2022
2023 =item cust_main
2024
2025 New FS::cust_main object, to create a new customer and assign the new package
2026 to it.
2027
2028 =item pkgpart
2029
2030 New pkgpart (see L<FS::part_pkg>).
2031
2032 =item refnum
2033
2034 New refnum (see L<FS::part_referral>).
2035
2036 =item quantity
2037
2038 New quantity; if unspecified, the new package will have the same quantity
2039 as the old.
2040
2041 =item cust_pkg
2042
2043 "New" (existing) FS::cust_pkg object.  The package's services and other
2044 attributes will be transferred to this package.
2045
2046 =item keep_dates
2047
2048 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
2049 susp, adjourn, cancel, expire, and contract_end) to the new package.
2050
2051 =item unprotect_svcs
2052
2053 Normally, change() will rollback and return an error if some services
2054 can't be transferred (also see the I<cust_pkg-change_svcpart> config option).
2055 If unprotect_svcs is true, this method will transfer as many services as
2056 it can and then unconditionally cancel the old package.
2057
2058 =item contract_end
2059
2060 If specified, sets this value for the contract_end date on the new package
2061 (without regard for keep_dates or the usual date-preservation behavior.)
2062 Will throw an error if defined but false;  the UI doesn't allow editing
2063 this unless it already exists, making removal impossible to undo.
2064
2065 =back
2066
2067 At least one of locationnum, cust_location, pkgpart, refnum, cust_main, or
2068 cust_pkg must be specified (otherwise, what's the point?)
2069
2070 Returns either the new FS::cust_pkg object or a scalar error.
2071
2072 For example:
2073
2074   my $err_or_new_cust_pkg = $old_cust_pkg->change
2075
2076 =cut
2077
2078 #used by change and change_later
2079 #didn't put with documented check methods because it depends on change-specific opts
2080 #and it also possibly edits the value of opts
2081 sub _check_change {
2082   my $self = shift;
2083   my $opt = shift;
2084   if ( defined($opt->{'contract_end'}) ) {
2085     my $current_contract_end = $self->get('contract_end');
2086     unless ($opt->{'contract_end'}) {
2087       if ($current_contract_end) {
2088         return "Cannot remove contract end date when changing packages";
2089       } else {
2090         #shouldn't even pass this option if there's not a current value
2091         #but can be handled gracefully if the option is empty
2092         warn "Contract end date passed unexpectedly";
2093         delete $opt->{'contract_end'};
2094         return '';
2095       }
2096     }
2097     unless ($current_contract_end) {
2098       #option shouldn't be passed, throw error if it's non-empty
2099       return "Cannot add contract end date when changing packages " . $self->pkgnum;
2100     }
2101   }
2102   return '';
2103 }
2104
2105 #some false laziness w/order
2106 sub change {
2107   my $self = shift;
2108   my $opt = ref($_[0]) ? shift : { @_ };
2109
2110   my $conf = new FS::Conf;
2111
2112   # handle contract_end on cust_pkg same as passed option
2113   if ( $opt->{'cust_pkg'} ) {
2114     $opt->{'contract_end'} = $opt->{'cust_pkg'}->contract_end;
2115     delete $opt->{'contract_end'} unless $opt->{'contract_end'};
2116   }
2117
2118   # check contract_end, prevent adding/removing
2119   my $error = $self->_check_change($opt);
2120   return $error if $error;
2121
2122   # Transactionize this whole mess
2123   my $oldAutoCommit = $FS::UID::AutoCommit;
2124   local $FS::UID::AutoCommit = 0;
2125   my $dbh = dbh;
2126
2127   if ( $opt->{'cust_location'} ) {
2128     $error = $opt->{'cust_location'}->find_or_insert;
2129     if ( $error ) {
2130       $dbh->rollback if $oldAutoCommit;
2131       return "creating location record: $error";
2132     }
2133     $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
2134   }
2135
2136   # Before going any further here: if the package is still in the pre-setup
2137   # state, it's safe to modify it in place. No need to charge/credit for
2138   # partial period, transfer services, transfer usage pools, copy invoice
2139   # details, or change any dates.
2140   if ( ! $self->setup and ! $opt->{cust_pkg} and ! $opt->{cust_main} ) {
2141     foreach ( qw( locationnum pkgpart quantity refnum salesnum ) ) {
2142       if ( length($opt->{$_}) ) {
2143         $self->set($_, $opt->{$_});
2144       }
2145     }
2146     # almost. if the new pkgpart specifies start/adjourn/expire timers,
2147     # apply those.
2148     if ( $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart ) {
2149       $error ||= $self->set_initial_timers;
2150     }
2151     # but if contract_end was explicitly specified, that overrides all else
2152     $self->set('contract_end', $opt->{'contract_end'})
2153       if $opt->{'contract_end'};
2154     $error ||= $self->replace;
2155     if ( $error ) {
2156       $dbh->rollback if $oldAutoCommit;
2157       return "modifying package: $error";
2158     } else {
2159       $dbh->commit if $oldAutoCommit;
2160       return $self;
2161     }
2162   }
2163
2164   my %hash = ();
2165
2166   my $time = time;
2167
2168   $hash{'setup'} = $time if $self->get('setup');
2169
2170   $hash{'change_date'} = $time;
2171   $hash{"change_$_"}  = $self->$_()
2172     foreach qw( pkgnum pkgpart locationnum );
2173
2174   if ( $opt->{'cust_pkg'} ) {
2175     # treat changing to a package with a different pkgpart as a
2176     # pkgpart change (because it is)
2177     $opt->{'pkgpart'} = $opt->{'cust_pkg'}->pkgpart;
2178   }
2179
2180   # whether to override pkgpart checking on the new package
2181   my $same_pkgpart = 1;
2182   if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
2183     $same_pkgpart = 0;
2184   }
2185
2186   my $unused_credit = 0;
2187   my $keep_dates = $opt->{'keep_dates'};
2188
2189   # Special case.  If the pkgpart is changing, and the customer is going to be
2190   # credited for remaining time, don't keep setup, bill, or last_bill dates,
2191   # and DO pass the flag to cancel() to credit the customer.  If the old
2192   # package had a setup date, set the new package's setup to the package
2193   # change date so that it has the same status as before.
2194   if ( $opt->{'pkgpart'}
2195        and $opt->{'pkgpart'} != $self->pkgpart
2196        and $self->part_pkg->option('unused_credit_change', 1) ) {
2197     $unused_credit = 1;
2198     $keep_dates = 0;
2199     $hash{'last_bill'} = '';
2200     $hash{'bill'} = '';
2201   }
2202
2203   if ( $keep_dates ) {
2204     foreach my $date ( qw(setup bill last_bill) ) {
2205       $hash{$date} = $self->getfield($date);
2206     }
2207   }
2208   # always keep the following dates
2209   foreach my $date (qw(order_date susp adjourn cancel expire resume
2210                     start_date contract_end)) {
2211     $hash{$date} = $self->getfield($date);
2212   }
2213   # but if contract_end was explicitly specified, that overrides all else
2214   $hash{'contract_end'} = $opt->{'contract_end'}
2215     if $opt->{'contract_end'};
2216
2217   # allow $opt->{'locationnum'} = '' to specifically set it to null
2218   # (i.e. customer default location)
2219   $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2220
2221   # usually this doesn't matter.  the two cases where it does are:
2222   # 1. unused_credit_change + pkgpart change + setup fee on the new package
2223   # and
2224   # 2. (more importantly) changing a package before it's billed
2225   $hash{'waive_setup'} = $self->waive_setup;
2226
2227   # if this package is scheduled for a future package change, preserve that
2228   $hash{'change_to_pkgnum'} = $self->change_to_pkgnum;
2229
2230   my $custnum = $self->custnum;
2231   if ( $opt->{cust_main} ) {
2232     my $cust_main = $opt->{cust_main};
2233     unless ( $cust_main->custnum ) {
2234       my $error = $cust_main->insert( @{ $opt->{cust_main_insert_args}||[] } );
2235       if ( $error ) {
2236         $dbh->rollback if $oldAutoCommit;
2237         return "inserting customer record: $error";
2238       }
2239     }
2240     $custnum = $cust_main->custnum;
2241   }
2242
2243   $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
2244
2245   my $cust_pkg;
2246   if ( $opt->{'cust_pkg'} ) {
2247     # The target package already exists; update it to show that it was
2248     # changed from this package.
2249     $cust_pkg = $opt->{'cust_pkg'};
2250
2251     # follow all the above rules for date changes, etc.
2252     foreach (keys %hash) {
2253       $cust_pkg->set($_, $hash{$_});
2254     }
2255     # except those that implement the future package change behavior
2256     foreach (qw(change_to_pkgnum start_date expire)) {
2257       $cust_pkg->set($_, '');
2258     }
2259
2260     $error = $cust_pkg->replace;
2261
2262   } else {
2263     # Create the new package.
2264     $cust_pkg = new FS::cust_pkg {
2265       custnum     => $custnum,
2266       locationnum => $opt->{'locationnum'},
2267       ( map {  $_ => ( $opt->{$_} || $self->$_() )  }
2268           qw( pkgpart quantity refnum salesnum )
2269       ),
2270       %hash,
2271     };
2272     $error = $cust_pkg->insert( 'change' => 1,
2273                                 'allow_pkgpart' => $same_pkgpart );
2274   }
2275   if ($error) {
2276     $dbh->rollback if $oldAutoCommit;
2277     return "inserting new package: $error";
2278   }
2279
2280   # Transfer services and cancel old package.
2281   # Enforce service limits only if this is a pkgpart change.
2282   local $FS::cust_svc::ignore_quantity;
2283   $FS::cust_svc::ignore_quantity = 1 if $same_pkgpart;
2284   $error = $self->transfer($cust_pkg);
2285   if ($error and $error == 0) {
2286     # $old_pkg->transfer failed.
2287     $dbh->rollback if $oldAutoCommit;
2288     return "transferring $error";
2289   }
2290
2291   if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2292     warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2293     $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
2294     if ($error and $error == 0) {
2295       # $old_pkg->transfer failed.
2296       $dbh->rollback if $oldAutoCommit;
2297       return "converting $error";
2298     }
2299   }
2300
2301   # We set unprotect_svcs when executing a "future package change".  It's
2302   # not a user-interactive operation, so returning an error means the
2303   # package change will just fail.  Rather than have that happen, we'll
2304   # let leftover services be deleted.
2305   if ($error > 0 and !$opt->{'unprotect_svcs'}) {
2306     # Transfers were successful, but we still had services left on the old
2307     # package.  We can't change the package under this circumstances, so abort.
2308     $dbh->rollback if $oldAutoCommit;
2309     return "unable to transfer all services";
2310   }
2311
2312   #reset usage if changing pkgpart
2313   # AND usage rollover is off (otherwise adds twice, now and at package bill)
2314   if ($self->pkgpart != $cust_pkg->pkgpart) {
2315     my $part_pkg = $cust_pkg->part_pkg;
2316     $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
2317                                                  ? ()
2318                                                  : ( 'null' => 1 )
2319                                    )
2320       if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
2321
2322     if ($error) {
2323       $dbh->rollback if $oldAutoCommit;
2324       return "setting usage values: $error";
2325     }
2326   } else {
2327     # if NOT changing pkgpart, transfer any usage pools over
2328     foreach my $usage ($self->cust_pkg_usage) {
2329       $usage->set('pkgnum', $cust_pkg->pkgnum);
2330       $error = $usage->replace;
2331       if ( $error ) {
2332         $dbh->rollback if $oldAutoCommit;
2333         return "transferring usage pools: $error";
2334       }
2335     }
2336   }
2337
2338   # transfer usage pricing add-ons, if we're not changing pkgpart or if they were specified
2339   if ( $same_pkgpart || $opt->{'cust_pkg_usageprice'}) {
2340     my @old_cust_pkg_usageprice;
2341     if ($opt->{'cust_pkg_usageprice'}) {
2342       @old_cust_pkg_usageprice = @{ $opt->{'cust_pkg_usageprice'} };
2343     } else {
2344       @old_cust_pkg_usageprice = $self->cust_pkg_usageprice;
2345     }
2346     foreach my $old_cust_pkg_usageprice (@old_cust_pkg_usageprice) {
2347       my $new_cust_pkg_usageprice = new FS::cust_pkg_usageprice {
2348         'pkgnum'         => $cust_pkg->pkgnum,
2349         'usagepricepart' => $old_cust_pkg_usageprice->usagepricepart,
2350         'quantity'       => $old_cust_pkg_usageprice->quantity,
2351       };
2352       $error = $new_cust_pkg_usageprice->insert;
2353       if ( $error ) {
2354         $dbh->rollback if $oldAutoCommit;
2355         return "Error transferring usage pricing add-on: $error";
2356       }
2357     }
2358   }
2359
2360   # transfer discounts, if we're not changing pkgpart
2361   if ( $same_pkgpart ) {
2362     foreach my $old_discount ($self->cust_pkg_discount_active) {
2363       # don't remove the old discount, we may still need to bill that package.
2364       my $new_discount = new FS::cust_pkg_discount {
2365         'pkgnum'      => $cust_pkg->pkgnum,
2366         'discountnum' => $old_discount->discountnum,
2367         'months_used' => $old_discount->months_used,
2368       };
2369       $error = $new_discount->insert;
2370       if ( $error ) {
2371         $dbh->rollback if $oldAutoCommit;
2372         return "transferring discounts: $error";
2373       }
2374     }
2375   }
2376
2377   # transfer (copy) invoice details
2378   foreach my $detail ($self->cust_pkg_detail) {
2379     my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
2380     $new_detail->set('pkgdetailnum', '');
2381     $new_detail->set('pkgnum', $cust_pkg->pkgnum);
2382     $error = $new_detail->insert;
2383     if ( $error ) {
2384       $dbh->rollback if $oldAutoCommit;
2385       return "transferring package notes: $error";
2386     }
2387   }
2388
2389   my @new_supp_pkgs;
2390
2391   if ( !$opt->{'cust_pkg'} ) {
2392     # Order any supplemental packages.
2393     my $part_pkg = $cust_pkg->part_pkg;
2394     my @old_supp_pkgs = $self->supplemental_pkgs;
2395     foreach my $link ($part_pkg->supp_part_pkg_link) {
2396       my $old;
2397       foreach (@old_supp_pkgs) {
2398         if ($_->pkgpart == $link->dst_pkgpart) {
2399           $old = $_;
2400           $_->pkgpart(0); # so that it can't match more than once
2401         }
2402         last if $old;
2403       }
2404       # false laziness with FS::cust_main::Packages::order_pkg
2405       my $new = FS::cust_pkg->new({
2406           pkgpart       => $link->dst_pkgpart,
2407           pkglinknum    => $link->pkglinknum,
2408           custnum       => $custnum,
2409           main_pkgnum   => $cust_pkg->pkgnum,
2410           locationnum   => $cust_pkg->locationnum,
2411           start_date    => $cust_pkg->start_date,
2412           order_date    => $cust_pkg->order_date,
2413           expire        => $cust_pkg->expire,
2414           adjourn       => $cust_pkg->adjourn,
2415           contract_end  => $cust_pkg->contract_end,
2416           refnum        => $cust_pkg->refnum,
2417           discountnum   => $cust_pkg->discountnum,
2418           waive_setup   => $cust_pkg->waive_setup,
2419       });
2420       if ( $old and $opt->{'keep_dates'} ) {
2421         foreach (qw(setup bill last_bill)) {
2422           $new->set($_, $old->get($_));
2423         }
2424       }
2425       $error = $new->insert( allow_pkgpart => $same_pkgpart );
2426       # transfer services
2427       if ( $old ) {
2428         $error ||= $old->transfer($new);
2429       }
2430       if ( $error and $error > 0 ) {
2431         # no reason why this should ever fail, but still...
2432         $error = "Unable to transfer all services from supplemental package ".
2433           $old->pkgnum;
2434       }
2435       if ( $error ) {
2436         $dbh->rollback if $oldAutoCommit;
2437         return $error;
2438       }
2439       push @new_supp_pkgs, $new;
2440     }
2441   } # if !$opt->{'cust_pkg'}
2442     # because if there is one, then supplemental packages would already
2443     # have been created for it.
2444
2445   #Good to go, cancel old package.  Notify 'cancel' of whether to credit
2446   #remaining time.
2447   #Don't allow billing the package (preceding period packages and/or
2448   #outstanding usage) if we are keeping dates (i.e. location changing),
2449   #because the new package will be billed for the same date range.
2450   #Supplemental packages are also canceled here.
2451
2452   # during scheduled changes, avoid canceling the package we just
2453   # changed to (duh)
2454   $self->set('change_to_pkgnum' => '');
2455
2456   $error = $self->cancel(
2457     quiet          => 1,
2458     unused_credit  => $unused_credit,
2459     nobill         => $keep_dates,
2460     change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2461     no_delay_cancel => 1,
2462   );
2463   if ($error) {
2464     $dbh->rollback if $oldAutoCommit;
2465     return "canceling old package: $error";
2466   }
2467
2468   if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2469     #$self->cust_main
2470     my $error = $cust_pkg->cust_main->bill(
2471       'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2472     );
2473     if ( $error ) {
2474       $dbh->rollback if $oldAutoCommit;
2475       return "billing new package: $error";
2476     }
2477   }
2478
2479   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2480
2481   $cust_pkg;
2482
2483 }
2484
2485 =item change_later OPTION => VALUE...
2486
2487 Schedule a package change for a later date.  This actually orders the new
2488 package immediately, but sets its start date for a future date, and sets
2489 the current package to expire on the same date.
2490
2491 If the package is already scheduled for a change, this can be called with
2492 'start_date' to change the scheduled date, or with pkgpart and/or
2493 locationnum to modify the package change.  To cancel the scheduled change
2494 entirely, see C<abort_change>.
2495
2496 Options include:
2497
2498 =over 4
2499
2500 =item start_date
2501
2502 The date for the package change.  Required, and must be in the future.
2503
2504 =item pkgpart
2505
2506 =item locationnum
2507
2508 =item quantity
2509
2510 =item contract_end
2511
2512 The pkgpart, locationnum, quantity and optional contract_end of the new
2513 package, with the same meaning as in C<change>.
2514
2515 =back
2516
2517 =cut
2518
2519 sub change_later {
2520   my $self = shift;
2521   my $opt = ref($_[0]) ? shift : { @_ };
2522
2523   # check contract_end, prevent adding/removing
2524   my $error = $self->_check_change($opt);
2525   return $error if $error;
2526
2527   my $oldAutoCommit = $FS::UID::AutoCommit;
2528   local $FS::UID::AutoCommit = 0;
2529   my $dbh = dbh;
2530
2531   my $cust_main = $self->cust_main;
2532
2533   my $date = delete $opt->{'start_date'} or return 'start_date required';
2534
2535   if ( $date <= time ) {
2536     $dbh->rollback if $oldAutoCommit;
2537     return "start_date $date is in the past";
2538   }
2539
2540   # If the user entered a new location, set it up now.
2541   if ( $opt->{'cust_location'} ) {
2542     $error = $opt->{'cust_location'}->find_or_insert;
2543     if ( $error ) {
2544       $dbh->rollback if $oldAutoCommit;
2545       return "creating location record: $error";
2546     }
2547     $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
2548   }
2549
2550   if ( $self->change_to_pkgnum ) {
2551     my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
2552     my $new_pkgpart = $opt->{'pkgpart'}
2553         if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $change_to->pkgpart;
2554     my $new_locationnum = $opt->{'locationnum'}
2555         if $opt->{'locationnum'} and $opt->{'locationnum'} != $change_to->locationnum;
2556     my $new_quantity = $opt->{'quantity'}
2557         if $opt->{'quantity'} and $opt->{'quantity'} != $change_to->quantity;
2558     my $new_contract_end = $opt->{'contract_end'}
2559         if $opt->{'contract_end'} and $opt->{'contract_end'} != $change_to->contract_end;
2560     if ( $new_pkgpart or $new_locationnum or $new_quantity or $new_contract_end ) {
2561       # it hasn't been billed yet, so in principle we could just edit
2562       # it in place (w/o a package change), but that's bad form.
2563       # So change the package according to the new options...
2564       my $err_or_pkg = $change_to->change(%$opt);
2565       if ( ref $err_or_pkg ) {
2566         # Then set that package up for a future start.
2567         $self->set('change_to_pkgnum', $err_or_pkg->pkgnum);
2568         $self->set('expire', $date); # in case it's different
2569         $err_or_pkg->set('start_date', $date);
2570         $err_or_pkg->set('change_date', '');
2571         $err_or_pkg->set('change_pkgnum', '');
2572
2573         $error = $self->replace       ||
2574                  $err_or_pkg->replace ||
2575                  #because change() might've edited existing scheduled change in place
2576                  (($err_or_pkg->pkgnum == $change_to->pkgnum) ? '' :
2577                   $change_to->cancel('no_delay_cancel' => 1) ||
2578                   $change_to->delete);
2579       } else {
2580         $error = $err_or_pkg;
2581       }
2582     } else { # change the start date only.
2583       $self->set('expire', $date);
2584       $change_to->set('start_date', $date);
2585       $error = $self->replace || $change_to->replace;
2586     }
2587     if ( $error ) {
2588       $dbh->rollback if $oldAutoCommit;
2589       return $error;
2590     } else {
2591       $dbh->commit if $oldAutoCommit;
2592       return '';
2593     }
2594   } # if $self->change_to_pkgnum
2595
2596   my $new_pkgpart = $opt->{'pkgpart'}
2597       if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2598   my $new_locationnum = $opt->{'locationnum'}
2599       if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2600   my $new_quantity = $opt->{'quantity'}
2601       if $opt->{'quantity'} and $opt->{'quantity'} != $self->quantity;
2602   my $new_contract_end = $opt->{'contract_end'}
2603       if $opt->{'contract_end'} and $opt->{'contract_end'} != $self->contract_end;
2604
2605   return '' unless $new_pkgpart or $new_locationnum or $new_quantity or $new_contract_end; # wouldn't do anything
2606
2607   # allow $opt->{'locationnum'} = '' to specifically set it to null
2608   # (i.e. customer default location)
2609   $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2610
2611   my $new = FS::cust_pkg->new( {
2612     custnum     => $self->custnum,
2613     locationnum => $opt->{'locationnum'},
2614     start_date  => $date,
2615     map   {  $_ => ( $opt->{$_} || $self->$_() )  }
2616       qw( pkgpart quantity refnum salesnum contract_end )
2617   } );
2618   $error = $new->insert('change' => 1,
2619                         'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2620   if ( !$error ) {
2621     $self->set('change_to_pkgnum', $new->pkgnum);
2622     $self->set('expire', $date);
2623     $error = $self->replace;
2624   }
2625   if ( $error ) {
2626     $dbh->rollback if $oldAutoCommit;
2627   } else {
2628     $dbh->commit if $oldAutoCommit;
2629   }
2630
2631   $error;
2632 }
2633
2634 =item abort_change
2635
2636 Cancels a future package change scheduled by C<change_later>.
2637
2638 =cut
2639
2640 sub abort_change {
2641   my $self = shift;
2642   my $oldAutoCommit = $FS::UID::AutoCommit;
2643   local $FS::UID::AutoCommit = 0;
2644
2645   my $pkgnum = $self->change_to_pkgnum;
2646   my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
2647   my $error;
2648   $self->set('change_to_pkgnum', '');
2649   $self->set('expire', '');
2650   $error = $self->replace;
2651   if ( $change_to ) {
2652     $error ||= $change_to->cancel || $change_to->delete;
2653   }
2654
2655   if ( $oldAutoCommit ) {
2656     if ( $error ) {
2657       dbh->rollback;
2658     } else {
2659       dbh->commit;
2660     }
2661   }
2662
2663   return $error;
2664 }
2665
2666 =item set_quantity QUANTITY
2667
2668 Change the package's quantity field.  This is one of the few package properties
2669 that can safely be changed without canceling and reordering the package
2670 (because it doesn't affect tax eligibility).  Returns an error or an
2671 empty string.
2672
2673 =cut
2674
2675 sub set_quantity {
2676   my $self = shift;
2677   $self = $self->replace_old; # just to make sure
2678   $self->quantity(shift);
2679   $self->replace;
2680 }
2681
2682 =item set_salesnum SALESNUM
2683
2684 Change the package's salesnum (sales person) field.  This is one of the few
2685 package properties that can safely be changed without canceling and reordering
2686 the package (because it doesn't affect tax eligibility).  Returns an error or
2687 an empty string.
2688
2689 =cut
2690
2691 sub set_salesnum {
2692   my $self = shift;
2693   $self = $self->replace_old; # just to make sure
2694   $self->salesnum(shift);
2695   $self->replace;
2696   # XXX this should probably reassign any credit that's already been given
2697 }
2698
2699 =item modify_charge OPTIONS
2700
2701 Change the properties of a one-time charge.  The following properties can
2702 be changed this way:
2703 - pkg: the package description
2704 - classnum: the package class
2705 - additional: arrayref of additional invoice details to add to this package
2706
2707 and, I<if the charge has not yet been billed>:
2708 - start_date: the date when it will be billed
2709 - amount: the setup fee to be charged
2710 - quantity: the multiplier for the setup fee
2711 - separate_bill: whether to put the charge on a separate invoice
2712
2713 If you pass 'adjust_commission' => 1, and the classnum changes, and there are
2714 commission credits linked to this charge, they will be recalculated.
2715
2716 =cut
2717
2718 sub modify_charge {
2719   my $self = shift;
2720   my %opt = @_;
2721   my $part_pkg = $self->part_pkg;
2722   my $pkgnum = $self->pkgnum;
2723
2724   my $dbh = dbh;
2725   my $oldAutoCommit = $FS::UID::AutoCommit;
2726   local $FS::UID::AutoCommit = 0;
2727
2728   return "Can't use modify_charge except on one-time charges"
2729     unless $part_pkg->freq eq '0';
2730
2731   if ( length($opt{'pkg'}) and $part_pkg->pkg ne $opt{'pkg'} ) {
2732     $part_pkg->set('pkg', $opt{'pkg'});
2733   }
2734
2735   my %pkg_opt = $part_pkg->options;
2736   my $pkg_opt_modified = 0;
2737
2738   $opt{'additional'} ||= [];
2739   my $i;
2740   my @old_additional;
2741   foreach (grep /^additional/, keys %pkg_opt) {
2742     ($i) = ($_ =~ /^additional_info(\d+)$/);
2743     $old_additional[$i] = $pkg_opt{$_} if $i;
2744     delete $pkg_opt{$_};
2745   }
2746
2747   for ( $i = 0; exists($opt{'additional'}->[$i]); $i++ ) {
2748     $pkg_opt{ "additional_info$i" } = $opt{'additional'}->[$i];
2749     if (!exists($old_additional[$i])
2750         or $old_additional[$i] ne $opt{'additional'}->[$i])
2751     {
2752       $pkg_opt_modified = 1;
2753     }
2754   }
2755   $pkg_opt_modified = 1 if (scalar(@old_additional) - 1) != $i;
2756   $pkg_opt{'additional_count'} = $i if $i > 0;
2757
2758   my $old_classnum;
2759   if ( exists($opt{'classnum'}) and $part_pkg->classnum ne $opt{'classnum'} )
2760   {
2761     # remember it
2762     $old_classnum = $part_pkg->classnum;
2763     $part_pkg->set('classnum', $opt{'classnum'});
2764   }
2765
2766   if ( !$self->get('setup') ) {
2767     # not yet billed, so allow amount, setup_cost, quantity, start_date,
2768     # and separate_bill
2769
2770     if ( exists($opt{'amount'})
2771           and $part_pkg->option('setup_fee') != $opt{'amount'}
2772           and $opt{'amount'} > 0 ) {
2773
2774       $pkg_opt{'setup_fee'} = $opt{'amount'};
2775       $pkg_opt_modified = 1;
2776     }
2777
2778     if ( exists($opt{'setup_cost'})
2779           and $part_pkg->setup_cost != $opt{'setup_cost'}
2780           and $opt{'setup_cost'} > 0 ) {
2781
2782       $part_pkg->set('setup_cost', $opt{'setup_cost'});
2783     }
2784
2785     if ( exists($opt{'quantity'})
2786           and $opt{'quantity'} != $self->quantity
2787           and $opt{'quantity'} > 0 ) {
2788
2789       $self->set('quantity', $opt{'quantity'});
2790     }
2791
2792     if ( exists($opt{'start_date'})
2793           and $opt{'start_date'} != $self->start_date ) {
2794
2795       $self->set('start_date', $opt{'start_date'});
2796     }
2797
2798     if ( exists($opt{'separate_bill'})
2799           and $opt{'separate_bill'} ne $self->separate_bill ) {
2800
2801       $self->set('separate_bill', $opt{'separate_bill'});
2802     }
2803
2804
2805   } # else simply ignore them; the UI shouldn't allow editing the fields
2806
2807
2808   if ( exists($opt{'taxclass'})
2809           and $part_pkg->taxclass ne $opt{'taxclass'}) {
2810
2811       $part_pkg->set('taxclass', $opt{'taxclass'});
2812   }
2813
2814   my $error;
2815   if ( $part_pkg->modified or $pkg_opt_modified ) {
2816     # can we safely modify the package def?
2817     # Yes, if it's not available for purchase, and this is the only instance
2818     # of it.
2819     if ( $part_pkg->disabled
2820          and FS::cust_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 1
2821          and FS::quotation_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 0
2822        ) {
2823       $error = $part_pkg->replace( options => \%pkg_opt );
2824     } else {
2825       # clone it
2826       $part_pkg = $part_pkg->clone;
2827       $part_pkg->set('disabled' => 'Y');
2828       $error = $part_pkg->insert( options => \%pkg_opt );
2829       # and associate this as yet-unbilled package to the new package def
2830       $self->set('pkgpart' => $part_pkg->pkgpart);
2831     }
2832     if ( $error ) {
2833       $dbh->rollback if $oldAutoCommit;
2834       return $error;
2835     }
2836   }
2837
2838   if ($self->modified) { # for quantity or start_date change, or if we had
2839                          # to clone the existing package def
2840     my $error = $self->replace;
2841     return $error if $error;
2842   }
2843   if (defined $old_classnum) {
2844     # fix invoice grouping records
2845     my $old_catname = $old_classnum
2846                       ? FS::pkg_class->by_key($old_classnum)->categoryname
2847                       : '';
2848     my $new_catname = $opt{'classnum'}
2849                       ? $part_pkg->pkg_class->categoryname
2850                       : '';
2851     if ( $old_catname ne $new_catname ) {
2852       foreach my $cust_bill_pkg ($self->cust_bill_pkg) {
2853         # (there should only be one...)
2854         my @display = qsearch( 'cust_bill_pkg_display', {
2855             'billpkgnum'  => $cust_bill_pkg->billpkgnum,
2856             'section'     => $old_catname,
2857         });
2858         foreach (@display) {
2859           $_->set('section', $new_catname);
2860           $error = $_->replace;
2861           if ( $error ) {
2862             $dbh->rollback if $oldAutoCommit;
2863             return $error;
2864           }
2865         }
2866       } # foreach $cust_bill_pkg
2867     }
2868
2869     if ( $opt{'adjust_commission'} ) {
2870       # fix commission credits...tricky.
2871       foreach my $cust_event ($self->cust_event) {
2872         my $part_event = $cust_event->part_event;
2873         foreach my $table (qw(sales agent)) {
2874           my $class =
2875             "FS::part_event::Action::Mixin::credit_${table}_pkg_class";
2876           my $credit = qsearchs('cust_credit', {
2877               'eventnum' => $cust_event->eventnum,
2878           });
2879           if ( $part_event->isa($class) ) {
2880             # Yes, this results in current commission rates being applied
2881             # retroactively to a one-time charge.  For accounting purposes
2882             # there ought to be some kind of time limit on doing this.
2883             my $amount = $part_event->_calc_credit($self);
2884             if ( $credit and $credit->amount ne $amount ) {
2885               # Void the old credit.
2886               $error = $credit->void('Package class changed');
2887               if ( $error ) {
2888                 $dbh->rollback if $oldAutoCommit;
2889                 return "$error (adjusting commission credit)";
2890               }
2891             }
2892             # redo the event action to recreate the credit.
2893             local $@ = '';
2894             eval { $part_event->do_action( $self, $cust_event ) };
2895             if ( $@ ) {
2896               $dbh->rollback if $oldAutoCommit;
2897               return $@;
2898             }
2899           } # if $part_event->isa($class)
2900         } # foreach $table
2901       } # foreach $cust_event
2902     } # if $opt{'adjust_commission'}
2903   } # if defined $old_classnum
2904
2905   $dbh->commit if $oldAutoCommit;
2906   '';
2907 }
2908
2909
2910
2911 use Data::Dumper;
2912 sub process_bulk_cust_pkg {
2913   my $job = shift;
2914   my $param = shift;
2915   warn Dumper($param) if $DEBUG;
2916
2917   my $old_part_pkg = qsearchs('part_pkg',
2918                               { pkgpart => $param->{'old_pkgpart'} });
2919   my $new_part_pkg = qsearchs('part_pkg',
2920                               { pkgpart => $param->{'new_pkgpart'} });
2921   die "Must select a new package type\n" unless $new_part_pkg;
2922   #my $keep_dates = $param->{'keep_dates'} || 0;
2923   my $keep_dates = 1; # there is no good reason to turn this off
2924
2925   my $oldAutoCommit = $FS::UID::AutoCommit;
2926   local $FS::UID::AutoCommit = 0;
2927   my $dbh = dbh;
2928
2929   my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
2930
2931   my $i = 0;
2932   foreach my $old_cust_pkg ( @cust_pkgs ) {
2933     $i++;
2934     $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
2935     if ( $old_cust_pkg->getfield('cancel') ) {
2936       warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
2937         $old_cust_pkg->pkgnum."\n"
2938         if $DEBUG;
2939       next;
2940     }
2941     warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
2942       if $DEBUG;
2943     my $error = $old_cust_pkg->change(
2944       'pkgpart'     => $param->{'new_pkgpart'},
2945       'keep_dates'  => $keep_dates
2946     );
2947     if ( !ref($error) ) { # change returns the cust_pkg on success
2948       $dbh->rollback;
2949       die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
2950     }
2951   }
2952   $dbh->commit if $oldAutoCommit;
2953   return;
2954 }
2955
2956 =item last_bill
2957
2958 Returns the last bill date, or if there is no last bill date, the setup date.
2959 Useful for billing metered services.
2960
2961 =cut
2962
2963 sub last_bill {
2964   my $self = shift;
2965   return $self->setfield('last_bill', $_[0]) if @_;
2966   return $self->getfield('last_bill') if $self->getfield('last_bill');
2967   my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
2968                                                   'edate'  => $self->bill,  } );
2969   $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
2970 }
2971
2972 =item last_cust_pkg_reason ACTION
2973
2974 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
2975 Returns false if there is no reason or the package is not currenly ACTION'd
2976 ACTION is one of adjourn, susp, cancel, or expire.
2977
2978 =cut
2979
2980 sub last_cust_pkg_reason {
2981   my ( $self, $action ) = ( shift, shift );
2982   my $date = $self->get($action);
2983   qsearchs( {
2984               'table' => 'cust_pkg_reason',
2985               'hashref' => { 'pkgnum' => $self->pkgnum,
2986                              'action' => substr(uc($action), 0, 1),
2987                              'date'   => $date,
2988                            },
2989               'order_by' => 'ORDER BY num DESC LIMIT 1',
2990            } );
2991 }
2992
2993 =item last_reason ACTION
2994
2995 Returns the most recent ACTION FS::reason associated with the package.
2996 Returns false if there is no reason or the package is not currenly ACTION'd
2997 ACTION is one of adjourn, susp, cancel, or expire.
2998
2999 =cut
3000
3001 sub last_reason {
3002   my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
3003   $cust_pkg_reason->reason
3004     if $cust_pkg_reason;
3005 }
3006
3007 =item part_pkg
3008
3009 Returns the definition for this billing item, as an FS::part_pkg object (see
3010 L<FS::part_pkg>).
3011
3012 =cut
3013
3014 sub part_pkg {
3015   my $self = shift;
3016   return $self->{'_pkgpart'} if $self->{'_pkgpart'};
3017   cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
3018   qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
3019 }
3020
3021 =item old_cust_pkg
3022
3023 Returns the cancelled package this package was changed from, if any.
3024
3025 =cut
3026
3027 sub old_cust_pkg {
3028   my $self = shift;
3029   return '' unless $self->change_pkgnum;
3030   qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
3031 }
3032
3033 =item change_cust_main
3034
3035 Returns the customter this package was detached to, if any.
3036
3037 =cut
3038
3039 sub change_cust_main {
3040   my $self = shift;
3041   return '' unless $self->change_custnum;
3042   qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
3043 }
3044
3045 =item calc_setup
3046
3047 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
3048 item.
3049
3050 =cut
3051
3052 sub calc_setup {
3053   my $self = shift;
3054   $self->part_pkg->calc_setup($self, @_);
3055 }
3056
3057 =item calc_recur
3058
3059 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
3060 item.
3061
3062 =cut
3063
3064 sub calc_recur {
3065   my $self = shift;
3066   $self->part_pkg->calc_recur($self, @_);
3067 }
3068
3069 =item base_setup
3070
3071 Calls the I<base_setup> of the FS::part_pkg object associated with this billing
3072 item.
3073
3074 =cut
3075
3076 sub base_setup {
3077   my $self = shift;
3078   $self->part_pkg->base_setup($self, @_);
3079 }
3080
3081 =item base_recur
3082
3083 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
3084 item.
3085
3086 =cut
3087
3088 sub base_recur {
3089   my $self = shift;
3090   $self->part_pkg->base_recur($self, @_);
3091 }
3092
3093 =item calc_remain
3094
3095 Calls the I<calc_remain> of the FS::part_pkg object associated with this
3096 billing item.
3097
3098 =cut
3099
3100 sub calc_remain {
3101   my $self = shift;
3102   $self->part_pkg->calc_remain($self, @_);
3103 }
3104
3105 =item calc_cancel
3106
3107 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
3108 billing item.
3109
3110 =cut
3111
3112 sub calc_cancel {
3113   my $self = shift;
3114   $self->part_pkg->calc_cancel($self, @_);
3115 }
3116
3117 =item cust_bill_pkg
3118
3119 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
3120
3121 =cut
3122
3123 sub cust_bill_pkg {
3124   my $self = shift;
3125   qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
3126 }
3127
3128 =item cust_pkg_detail [ DETAILTYPE ]
3129
3130 Returns any customer package details for this package (see
3131 L<FS::cust_pkg_detail>).
3132
3133 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
3134
3135 =cut
3136
3137 sub cust_pkg_detail {
3138   my $self = shift;
3139   my %hash = ( 'pkgnum' => $self->pkgnum );
3140   $hash{detailtype} = shift if @_;
3141   qsearch({
3142     'table'    => 'cust_pkg_detail',
3143     'hashref'  => \%hash,
3144     'order_by' => 'ORDER BY weight, pkgdetailnum',
3145   });
3146 }
3147
3148 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
3149
3150 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
3151
3152 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
3153
3154 If there is an error, returns the error, otherwise returns false.
3155
3156 =cut
3157
3158 sub set_cust_pkg_detail {
3159   my( $self, $detailtype, @details ) = @_;
3160
3161   my $oldAutoCommit = $FS::UID::AutoCommit;
3162   local $FS::UID::AutoCommit = 0;
3163   my $dbh = dbh;
3164
3165   foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
3166     my $error = $current->delete;
3167     if ( $error ) {
3168       $dbh->rollback if $oldAutoCommit;
3169       return "error removing old detail: $error";
3170     }
3171   }
3172
3173   foreach my $detail ( @details ) {
3174     my $cust_pkg_detail = new FS::cust_pkg_detail {
3175       'pkgnum'     => $self->pkgnum,
3176       'detailtype' => $detailtype,
3177       'detail'     => $detail,
3178     };
3179     my $error = $cust_pkg_detail->insert;
3180     if ( $error ) {
3181       $dbh->rollback if $oldAutoCommit;
3182       return "error adding new detail: $error";
3183     }
3184
3185   }
3186
3187   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3188   '';
3189
3190 }
3191
3192 =item cust_event
3193
3194 Returns the customer billing events (see L<FS::cust_event>) for this invoice.
3195
3196 =cut
3197
3198 #false laziness w/cust_bill.pm
3199 sub cust_event {
3200   my $self = shift;
3201   qsearch({
3202     'table'     => 'cust_event',
3203     'addl_from' => 'JOIN part_event USING ( eventpart )',
3204     'hashref'   => { 'tablenum' => $self->pkgnum },
3205     'extra_sql' => " AND eventtable = 'cust_pkg' ",
3206   });
3207 }
3208
3209 =item num_cust_event
3210
3211 Returns the number of customer billing events (see L<FS::cust_event>) for this package.
3212
3213 =cut
3214
3215 #false laziness w/cust_bill.pm
3216 sub num_cust_event {
3217   my $self = shift;
3218   my $sql = "SELECT COUNT(*) ". $self->_from_cust_event_where;
3219   $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref->[0];
3220 }
3221
3222 =item exists_cust_event
3223
3224 Returns true if there are customer billing events (see L<FS::cust_event>) for this package.  More efficient than using num_cust_event.
3225
3226 =cut
3227
3228 sub exists_cust_event {
3229   my $self = shift;
3230   my $sql = "SELECT 1 ". $self->_from_cust_event_where. " LIMIT 1";
3231   my $row = $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref;
3232   $row ? $row->[0] : '';
3233 }
3234
3235 sub _from_cust_event_where {
3236   #my $self = shift;
3237   " FROM cust_event JOIN part_event USING ( eventpart ) ".
3238   "  WHERE tablenum = ? AND eventtable = 'cust_pkg' ";
3239 }
3240
3241 sub _prep_ex {
3242   my( $self, $sql, @args ) = @_;
3243   my $sth = dbh->prepare($sql) or die  dbh->errstr. " preparing $sql";
3244   $sth->execute(@args)         or die $sth->errstr. " executing $sql";
3245   $sth;
3246 }
3247
3248 =item part_pkg_currency_option OPTIONNAME
3249
3250 Returns a two item list consisting of the currency of this customer, if any,
3251 and a value for the provided option.  If the customer has a currency, the value
3252 is the option value the given name and the currency (see
3253 L<FS::part_pkg_currency>).  Otherwise, if the customer has no currency, is the
3254 regular option value for the given name (see L<FS::part_pkg_option>).
3255
3256 =cut
3257
3258 sub part_pkg_currency_option {
3259   my( $self, $optionname ) = @_;
3260   my $part_pkg = $self->part_pkg;
3261   if ( my $currency = $self->cust_main->currency ) {
3262     ($currency, $part_pkg->part_pkg_currency_option($currency, $optionname) );
3263   } else {
3264     ('', $part_pkg->option($optionname) );
3265   }
3266 }
3267
3268 =item cust_svc [ SVCPART ] (old, deprecated usage)
3269
3270 =item cust_svc [ OPTION => VALUE ... ] (current usage)
3271
3272 =item cust_svc_unsorted [ OPTION => VALUE ... ]
3273
3274 Returns the services for this package, as FS::cust_svc objects (see
3275 L<FS::cust_svc>).  Available options are svcpart and svcdb.  If either is
3276 spcififed, returns only the matching services.
3277
3278 As an optimization, use the cust_svc_unsorted version if you are not displaying
3279 the results.
3280
3281 =cut
3282
3283 sub cust_svc {
3284   my $self = shift;
3285   cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
3286   $self->_sort_cust_svc( $self->cust_svc_unsorted_arrayref(@_) );
3287 }
3288
3289 sub cust_svc_unsorted {
3290   my $self = shift;
3291   @{ $self->cust_svc_unsorted_arrayref(@_) };
3292 }
3293
3294 sub cust_svc_unsorted_arrayref {
3295   my $self = shift;
3296
3297   return [] unless $self->num_cust_svc(@_);
3298
3299   my %opt = ();
3300   if ( @_ && $_[0] =~ /^\d+/ ) {
3301     $opt{svcpart} = shift;
3302   } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3303     %opt = %{ $_[0] };
3304   } elsif ( @_ ) {
3305     %opt = @_;
3306   }
3307
3308   my %search = (
3309     'select'    => 'cust_svc.*, part_svc.*',
3310     'table'     => 'cust_svc',
3311     'hashref'   => { 'pkgnum' => $self->pkgnum },
3312     'addl_from' => 'LEFT JOIN part_svc USING ( svcpart )',
3313   );
3314   $search{hashref}->{svcpart} = $opt{svcpart}
3315     if $opt{svcpart};
3316   $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{svcdb} )
3317     if $opt{svcdb};
3318
3319   [ qsearch(\%search) ];
3320
3321 }
3322
3323 =item overlimit [ SVCPART ]
3324
3325 Returns the services for this package which have exceeded their
3326 usage limit as FS::cust_svc objects (see L<FS::cust_svc>).  If a svcpart
3327 is specified, return only the matching services.
3328
3329 =cut
3330
3331 sub overlimit {
3332   my $self = shift;
3333   return () unless $self->num_cust_svc(@_);
3334   grep { $_->overlimit } $self->cust_svc(@_);
3335 }
3336
3337 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3338
3339 Returns historical services for this package created before END TIMESTAMP and
3340 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
3341 (see L<FS::h_cust_svc>).  If MODE is 'I' (for 'invoice'), services with the
3342 I<pkg_svc.hidden> flag will be omitted.
3343
3344 =cut
3345
3346 sub h_cust_svc {
3347   my $self = shift;
3348   warn "$me _h_cust_svc called on $self\n"
3349     if $DEBUG;
3350
3351   my ($end, $start, $mode) = @_;
3352
3353   local($FS::Record::qsearch_qualify_columns) = 0;
3354
3355   my @cust_svc = $self->_sort_cust_svc(
3356     [ qsearch( 'h_cust_svc',
3357       { 'pkgnum' => $self->pkgnum, },
3358       FS::h_cust_svc->sql_h_search(@_),
3359     ) ]
3360   );
3361
3362   if ( defined($mode) && $mode eq 'I' ) {
3363     my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
3364     return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
3365   } else {
3366     return @cust_svc;
3367   }
3368 }
3369
3370 sub _sort_cust_svc {
3371   my( $self, $arrayref ) = @_;
3372
3373   my $sort =
3374     sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1]  or  $a->[2] <=> $b->[2] };
3375
3376   my %pkg_svc = map { $_->svcpart => $_ }
3377                 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
3378
3379   map  { $_->[0] }
3380   sort $sort
3381   map {
3382         my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
3383         [ $_,
3384           $pkg_svc ? $pkg_svc->primary_svc : '',
3385           $pkg_svc ? $pkg_svc->quantity : 0,
3386         ];
3387       }
3388   @$arrayref;
3389
3390 }
3391
3392 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
3393
3394 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
3395
3396 Returns the number of services for this package.  Available options are svcpart
3397 and svcdb.  If either is spcififed, returns only the matching services.
3398
3399 =cut
3400
3401 sub num_cust_svc {
3402   my $self = shift;
3403
3404   return $self->{'_num_cust_svc'}
3405     if !scalar(@_)
3406        && exists($self->{'_num_cust_svc'})
3407        && $self->{'_num_cust_svc'} =~ /\d/;
3408
3409   cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
3410     if $DEBUG > 2;
3411
3412   my %opt = ();
3413   if ( @_ && $_[0] =~ /^\d+/ ) {
3414     $opt{svcpart} = shift;
3415   } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3416     %opt = %{ $_[0] };
3417   } elsif ( @_ ) {
3418     %opt = @_;
3419   }
3420
3421   my $select = 'SELECT COUNT(*) FROM cust_svc ';
3422   my $where = ' WHERE pkgnum = ? ';
3423   my @param = ($self->pkgnum);
3424
3425   if ( $opt{'svcpart'} ) {
3426     $where .= ' AND svcpart = ? ';
3427     push @param, $opt{'svcpart'};
3428   }
3429   if ( $opt{'svcdb'} ) {
3430     $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
3431     $where .= ' AND svcdb = ? ';
3432     push @param, $opt{'svcdb'};
3433   }
3434
3435   my $sth = dbh->prepare("$select $where") or die  dbh->errstr;
3436   $sth->execute(@param) or die $sth->errstr;
3437   $sth->fetchrow_arrayref->[0];
3438 }
3439
3440 =item available_part_svc
3441
3442 Returns a list of FS::part_svc objects representing services included in this
3443 package but not yet provisioned.  Each FS::part_svc object also has an extra
3444 field, I<num_avail>, which specifies the number of available services.
3445
3446 Accepts option I<provision_hold>;  if true, only returns part_svc for which the
3447 associated pkg_svc has the provision_hold flag set.
3448
3449 =cut
3450
3451 sub available_part_svc {
3452   my $self = shift;
3453   my %opt  = @_;
3454
3455   my $pkg_quantity = $self->quantity || 1;
3456
3457   grep { $_->num_avail > 0 }
3458   map {
3459     my $part_svc = $_->part_svc;
3460     $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
3461     $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
3462
3463     # more evil encapsulation breakage
3464     if ($part_svc->{'Hash'}{'num_avail'} > 0) {
3465       my @exports = $part_svc->part_export_did;
3466       $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
3467         }
3468
3469     $part_svc;
3470   }
3471   grep { $opt{'provision_hold'} ? $_->provision_hold : 1 }
3472   $self->part_pkg->pkg_svc;
3473 }
3474
3475 =item part_svc [ OPTION => VALUE ... ]
3476
3477 Returns a list of FS::part_svc objects representing provisioned and available
3478 services included in this package.  Each FS::part_svc object also has the
3479 following extra fields:
3480
3481 =over 4
3482
3483 =item num_cust_svc
3484
3485 (count)
3486
3487 =item num_avail
3488
3489 (quantity - count)
3490
3491 =item cust_pkg_svc
3492
3493 (services) - array reference containing the provisioned services, as cust_svc objects
3494
3495 =back
3496
3497 Accepts two options:
3498
3499 =over 4
3500
3501 =item summarize_size
3502
3503 If true, will omit the extra cust_pkg_svc option for objects where num_cust_svc
3504 is this size or greater.
3505
3506 =item hide_discontinued
3507
3508 If true, will omit looking for services that are no longer avaialble in the
3509 package definition.
3510
3511 =back
3512
3513 =cut
3514
3515 #svcnum
3516 #label -> ($cust_svc->label)[1]
3517
3518 sub part_svc {
3519   my $self = shift;
3520   my %opt = @_;
3521
3522   my $pkg_quantity = $self->quantity || 1;
3523
3524   #XXX some sort of sort order besides numeric by svcpart...
3525   my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
3526     my $pkg_svc = $_;
3527     my $part_svc = $pkg_svc->part_svc;
3528     my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3529     $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
3530     $part_svc->{'Hash'}{'num_avail'}    =
3531       max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
3532     $part_svc->{'Hash'}{'cust_pkg_svc'} =
3533         $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
3534       unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
3535           && $num_cust_svc >= $opt{summarize_size};
3536     $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
3537     $part_svc;
3538   } $self->part_pkg->pkg_svc;
3539
3540   unless ( $opt{hide_discontinued} ) {
3541     #extras
3542     push @part_svc, map {
3543       my $part_svc = $_;
3544       my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3545       $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
3546       $part_svc->{'Hash'}{'num_avail'}    = 0; #0-$num_cust_svc ?
3547       $part_svc->{'Hash'}{'cust_pkg_svc'} =
3548         $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
3549       $part_svc;
3550     } $self->extra_part_svc;
3551   }
3552
3553   @part_svc;
3554
3555 }
3556
3557 =item extra_part_svc
3558
3559 Returns a list of FS::part_svc objects corresponding to services in this
3560 package which are still provisioned but not (any longer) available in the
3561 package definition.
3562
3563 =cut
3564
3565 sub extra_part_svc {
3566   my $self = shift;
3567
3568   my $pkgnum  = $self->pkgnum;
3569   #my $pkgpart = $self->pkgpart;
3570
3571 #  qsearch( {
3572 #    'table'     => 'part_svc',
3573 #    'hashref'   => {},
3574 #    'extra_sql' =>
3575 #      "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
3576 #                     WHERE pkg_svc.svcpart = part_svc.svcpart
3577 #                       AND pkg_svc.pkgpart = ?
3578 #                       AND quantity > 0
3579 #                 )
3580 #        AND 0 < ( SELECT COUNT(*) FROM cust_svc
3581 #                       LEFT JOIN cust_pkg USING ( pkgnum )
3582 #                     WHERE cust_svc.svcpart = part_svc.svcpart
3583 #                       AND pkgnum = ?
3584 #                 )",
3585 #    'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
3586 #  } );
3587
3588 #seems to benchmark slightly faster... (or did?)
3589
3590   my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
3591   my $pkgparts = join(',', @pkgparts);
3592
3593   qsearch( {
3594     #'select'      => 'DISTINCT ON (svcpart) part_svc.*',
3595     #MySQL doesn't grok DISINCT ON
3596     'select'      => 'DISTINCT part_svc.*',
3597     'table'       => 'part_svc',
3598     'addl_from'   =>
3599       "LEFT JOIN pkg_svc  ON (     pkg_svc.svcpart   = part_svc.svcpart
3600                                AND pkg_svc.pkgpart IN ($pkgparts)
3601                                AND quantity > 0
3602                              )
3603        LEFT JOIN cust_svc ON (     cust_svc.svcpart = part_svc.svcpart )
3604        LEFT JOIN cust_pkg USING ( pkgnum )
3605       ",
3606     'hashref'     => {},
3607     'extra_sql'   => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
3608     'extra_param' => [ [$self->pkgnum=>'int'] ],
3609   } );
3610 }
3611
3612 =item status
3613
3614 Returns a short status string for this package, currently:
3615
3616 =over 4
3617
3618 =item on hold
3619
3620 =item not yet billed
3621
3622 =item one-time charge
3623
3624 =item active
3625
3626 =item suspended
3627
3628 =item cancelled
3629
3630 =back
3631
3632 =cut
3633
3634 sub status {
3635   my $self = shift;
3636
3637   my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
3638
3639   return 'cancelled' if $self->get('cancel');
3640   return 'on hold' if $self->susp && ! $self->setup;
3641   return 'suspended' if $self->susp;
3642   return 'not yet billed' unless $self->setup;
3643   return 'one-time charge' if $freq =~ /^(0|$)/;
3644   return 'active';
3645 }
3646
3647 =item ucfirst_status
3648
3649 Returns the status with the first character capitalized.
3650
3651 =cut
3652
3653 sub ucfirst_status {
3654   ucfirst(shift->status);
3655 }
3656
3657 =item statuses
3658
3659 Class method that returns the list of possible status strings for packages
3660 (see L<the status method|/status>).  For example:
3661
3662   @statuses = FS::cust_pkg->statuses();
3663
3664 =cut
3665
3666 tie my %statuscolor, 'Tie::IxHash',
3667   'on hold'         => 'FF00F5', #brighter purple!
3668   'not yet billed'  => '009999', #teal? cyan?
3669   'one-time charge' => '0000CC', #blue  #'000000',
3670   'active'          => '00CC00',
3671   'suspended'       => 'FF9900',
3672   'cancelled'       => 'FF0000',
3673 ;
3674
3675 sub statuses {
3676   my $self = shift; #could be class...
3677   #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
3678   #                                    # mayble split btw one-time vs. recur
3679     keys %statuscolor;
3680 }
3681
3682 sub statuscolors {
3683   #my $self = shift;
3684   \%statuscolor;
3685 }
3686
3687 =item statuscolor
3688
3689 Returns a hex triplet color string for this package's status.
3690
3691 =cut
3692
3693 sub statuscolor {
3694   my $self = shift;
3695   $statuscolor{$self->status};
3696 }
3697
3698 =item is_status_delay_cancel
3699
3700 Returns true if part_pkg has option delay_cancel,
3701 cust_pkg status is 'suspended' and expire is set
3702 to cancel package within the next day (or however
3703 many days are set in global config part_pkg-delay_cancel-days.
3704
3705 Accepts option I<part_pkg-delay_cancel-days> which should be
3706 the value of the config setting, to avoid looking it up again.
3707
3708 This is not a real status, this only meant for hacking display
3709 values, because otherwise treating the package as suspended is
3710 really the whole point of the delay_cancel option.
3711
3712 =cut
3713
3714 sub is_status_delay_cancel {
3715   my ($self,%opt) = @_;
3716   if ( $self->main_pkgnum and $self->pkglinknum ) {
3717     return $self->main_pkg->is_status_delay_cancel;
3718   }
3719   return 0 unless $self->part_pkg->option('delay_cancel',1);
3720   return 0 unless $self->status eq 'suspended';
3721   return 0 unless $self->expire;
3722   my $expdays = $opt{'part_pkg-delay_cancel-days'};
3723   unless ($expdays) {
3724     my $conf = new FS::Conf;
3725     $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
3726   }
3727   my $expsecs = 60*60*24*$expdays;
3728   return 0 unless $self->expire < time + $expsecs;
3729   return 1;
3730 }
3731
3732 =item pkg_label
3733
3734 Returns a label for this package.  (Currently "pkgnum: pkg - comment" or
3735 "pkg - comment" depending on user preference).
3736
3737 =cut
3738
3739 sub pkg_label {
3740   my $self = shift;
3741   my $label = $self->part_pkg->pkg_comment( cust_pkg=>$self, nopkgpart=>1 );
3742   $label = $self->pkgnum. ": $label"
3743     if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
3744   $label;
3745 }
3746
3747 =item pkg_label_long
3748
3749 Returns a long label for this package, adding the primary service's label to
3750 pkg_label.
3751
3752 =cut
3753
3754 sub pkg_label_long {
3755   my $self = shift;
3756   my $label = $self->pkg_label;
3757   my $cust_svc = $self->primary_cust_svc;
3758   $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
3759   $label;
3760 }
3761
3762 =item pkg_locale
3763
3764 Returns a customer-localized label for this package.
3765
3766 =cut
3767
3768 sub pkg_locale {
3769   my $self = shift;
3770   $self->part_pkg->pkg_locale( $self->cust_main->locale );
3771 }
3772
3773 =item primary_cust_svc
3774
3775 Returns a primary service (as FS::cust_svc object) if one can be identified.
3776
3777 =cut
3778
3779 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
3780
3781 sub primary_cust_svc {
3782   my $self = shift;
3783
3784   my @cust_svc = $self->cust_svc;
3785
3786   return '' unless @cust_svc; #no serivces - irrelevant then
3787
3788   return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
3789
3790   # primary service as specified in the package definition
3791   # or exactly one service definition with quantity one
3792   my $svcpart = $self->part_pkg->svcpart;
3793   @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
3794   return $cust_svc[0] if scalar(@cust_svc) == 1;
3795
3796   #couldn't identify one thing..
3797   return '';
3798 }
3799
3800 =item labels
3801
3802 Returns a list of lists, calling the label method for all services
3803 (see L<FS::cust_svc>) of this billing item.
3804
3805 =cut
3806
3807 sub labels {
3808   my $self = shift;
3809   map { [ $_->label ] } $self->cust_svc;
3810 }
3811
3812 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3813
3814 Like the labels method, but returns historical information on services that
3815 were active as of END_TIMESTAMP and (optionally) not cancelled before
3816 START_TIMESTAMP.  If MODE is 'I' (for 'invoice'), services with the
3817 I<pkg_svc.hidden> flag will be omitted.
3818
3819 Returns a list of lists, calling the label method for all (historical) services
3820 (see L<FS::h_cust_svc>) of this billing item.
3821
3822 =cut
3823
3824 sub h_labels {
3825   my $self = shift;
3826   warn "$me _h_labels called on $self\n"
3827     if $DEBUG;
3828   map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
3829 }
3830
3831 =item labels_short
3832
3833 Like labels, except returns a simple flat list, and shortens long
3834 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3835 identical services to one line that lists the service label and the number of
3836 individual services rather than individual items.
3837
3838 =cut
3839
3840 sub labels_short {
3841   shift->_labels_short( 'labels', @_ );
3842 }
3843
3844 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
3845
3846 Like h_labels, except returns a simple flat list, and shortens long
3847 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3848 identical services to one line that lists the service label and the number of
3849 individual services rather than individual items.
3850
3851 =cut
3852
3853 sub h_labels_short {
3854   shift->_labels_short( 'h_labels', @_ );
3855 }
3856
3857 sub _labels_short {
3858   my( $self, $method ) = ( shift, shift );
3859
3860   warn "$me _labels_short called on $self with $method method\n"
3861     if $DEBUG;
3862
3863   my $conf = new FS::Conf;
3864   my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
3865
3866   warn "$me _labels_short populating \%labels\n"
3867     if $DEBUG;
3868
3869   my %labels;
3870   #tie %labels, 'Tie::IxHash';
3871   push @{ $labels{$_->[0]} }, $_->[1]
3872     foreach $self->$method(@_);
3873
3874   warn "$me _labels_short populating \@labels\n"
3875     if $DEBUG;
3876
3877   my @labels;
3878   foreach my $label ( keys %labels ) {
3879     my %seen = ();
3880     my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
3881     my $num = scalar(@values);
3882     warn "$me _labels_short $num items for $label\n"
3883       if $DEBUG;
3884
3885     if ( $num > $max_same_services ) {
3886       warn "$me _labels_short   more than $max_same_services, so summarizing\n"
3887         if $DEBUG;
3888       push @labels, "$label ($num)";
3889     } else {
3890       if ( $conf->exists('cust_bill-consolidate_services') ) {
3891         warn "$me _labels_short   consolidating services\n"
3892           if $DEBUG;
3893         # push @labels, "$label: ". join(', ', @values);
3894         while ( @values ) {
3895           my $detail = "$label: ";
3896           $detail .= shift(@values). ', '
3897             while @values
3898                && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
3899           $detail =~ s/, $//;
3900           push @labels, $detail;
3901         }
3902         warn "$me _labels_short   done consolidating services\n"
3903           if $DEBUG;
3904       } else {
3905         warn "$me _labels_short   adding service data\n"
3906           if $DEBUG;
3907         push @labels, map { "$label: $_" } @values;
3908       }
3909     }
3910   }
3911
3912  @labels;
3913
3914 }
3915
3916 =item cust_main
3917
3918 Returns the parent customer object (see L<FS::cust_main>).
3919
3920 =item balance
3921
3922 Returns the balance for this specific package, when using
3923 experimental package balance.
3924
3925 =cut
3926
3927 sub balance {
3928   my $self = shift;
3929   $self->cust_main->balance_pkgnum( $self->pkgnum );
3930 }
3931
3932 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
3933
3934 =item cust_location
3935
3936 Returns the location object, if any (see L<FS::cust_location>).
3937
3938 =item cust_location_or_main
3939
3940 If this package is associated with a location, returns the locaiton (see
3941 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
3942
3943 =item location_label [ OPTION => VALUE ... ]
3944
3945 Returns the label of the location object (see L<FS::cust_location>).
3946
3947 =cut
3948
3949 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
3950
3951 =item tax_locationnum
3952
3953 Returns the foreign key to a L<FS::cust_location> object for calculating
3954 tax on this package, as determined by the C<tax-pkg_address> and
3955 C<tax-ship_address> configuration flags.
3956
3957 =cut
3958
3959 sub tax_locationnum {
3960   my $self = shift;
3961   my $conf = FS::Conf->new;
3962   if ( $conf->exists('tax-pkg_address') ) {
3963     return $self->locationnum;
3964   }
3965   elsif ( $conf->exists('tax-ship_address') ) {
3966     return $self->cust_main->ship_locationnum;
3967   }
3968   else {
3969     return $self->cust_main->bill_locationnum;
3970   }
3971 }
3972
3973 =item tax_location
3974
3975 Returns the L<FS::cust_location> object for tax_locationnum.
3976
3977 =cut
3978
3979 sub tax_location {
3980   my $self = shift;
3981   my $conf = FS::Conf->new;
3982   if ( $conf->exists('tax-pkg_address') and $self->locationnum ) {
3983     return FS::cust_location->by_key($self->locationnum);
3984   }
3985   elsif ( $conf->exists('tax-ship_address') ) {
3986     return $self->cust_main->ship_location;
3987   }
3988   else {
3989     return $self->cust_main->bill_location;
3990   }
3991 }
3992
3993 =item seconds_since TIMESTAMP
3994
3995 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
3996 package have been online since TIMESTAMP, according to the session monitor.
3997
3998 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
3999 L<Time::Local> and L<Date::Parse> for conversion functions.
4000
4001 =cut
4002
4003 sub seconds_since {
4004   my($self, $since) = @_;
4005   my $seconds = 0;
4006
4007   foreach my $cust_svc (
4008     grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
4009   ) {
4010     $seconds += $cust_svc->seconds_since($since);
4011   }
4012
4013   $seconds;
4014
4015 }
4016
4017 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
4018
4019 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
4020 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
4021 (exclusive).
4022
4023 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
4024 L<perlfunc/"time">.  Also see L<Time::Local> and L<Date::Parse> for conversion
4025 functions.
4026
4027
4028 =cut
4029
4030 sub seconds_since_sqlradacct {
4031   my($self, $start, $end) = @_;
4032
4033   my $seconds = 0;
4034
4035   foreach my $cust_svc (
4036     grep {
4037       my $part_svc = $_->part_svc;
4038       $part_svc->svcdb eq 'svc_acct'
4039         && scalar($part_svc->part_export_usage);
4040     } $self->cust_svc
4041   ) {
4042     $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
4043   }
4044
4045   $seconds;
4046
4047 }
4048
4049 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
4050
4051 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
4052 in this package for sessions ending between TIMESTAMP_START (inclusive) and
4053 TIMESTAMP_END
4054 (exclusive).
4055
4056 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
4057 L<perlfunc/"time">.  Also see L<Time::Local> and L<Date::Parse> for conversion
4058 functions.
4059
4060 =cut
4061
4062 sub attribute_since_sqlradacct {
4063   my($self, $start, $end, $attrib) = @_;
4064
4065   my $sum = 0;
4066
4067   foreach my $cust_svc (
4068     grep {
4069       my $part_svc = $_->part_svc;
4070       scalar($part_svc->part_export_usage);
4071     } $self->cust_svc
4072   ) {
4073     $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
4074   }
4075
4076   $sum;
4077
4078 }
4079
4080 =item quantity
4081
4082 =cut
4083
4084 sub quantity {
4085   my( $self, $value ) = @_;
4086   if ( defined($value) ) {
4087     $self->setfield('quantity', $value);
4088   }
4089   $self->getfield('quantity') || 1;
4090 }
4091
4092 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
4093
4094 Transfers as many services as possible from this package to another package.
4095
4096 The destination package can be specified by pkgnum by passing an FS::cust_pkg
4097 object.  The destination package must already exist.
4098
4099 Services are moved only if the destination allows services with the correct
4100 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true.  Use
4101 this option with caution!  No provision is made for export differences
4102 between the old and new service definitions.  Probably only should be used
4103 when your exports for all service definitions of a given svcdb are identical.
4104 (attempt a transfer without it first, to move all possible svcpart-matching
4105 services)
4106
4107 Any services that can't be moved remain in the original package.
4108
4109 Returns an error, if there is one; otherwise, returns the number of services
4110 that couldn't be moved.
4111
4112 =cut
4113
4114 sub transfer {
4115   my ($self, $dest_pkgnum, %opt) = @_;
4116
4117   my $remaining = 0;
4118   my $dest;
4119   my %target;
4120
4121   if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
4122     $dest = $dest_pkgnum;
4123     $dest_pkgnum = $dest->pkgnum;
4124   } else {
4125     $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
4126   }
4127
4128   return ('Package does not exist: '.$dest_pkgnum) unless $dest;
4129
4130   foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
4131     $target{$pkg_svc->svcpart} = $pkg_svc->quantity * ( $dest->quantity || 1 );
4132   }
4133
4134   foreach my $cust_svc ($dest->cust_svc) {
4135     $target{$cust_svc->svcpart}--;
4136   }
4137
4138   my %svcpart2svcparts = ();
4139   if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
4140     warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
4141     foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
4142       next if exists $svcpart2svcparts{$svcpart};
4143       my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
4144       $svcpart2svcparts{$svcpart} = [
4145         map  { $_->[0] }
4146         sort { $b->[1] cmp $a->[1]  or  $a->[2] <=> $b->[2] }
4147         map {
4148               my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
4149                                                    'svcpart' => $_          } );
4150               [ $_,
4151                 $pkg_svc ? $pkg_svc->primary_svc : '',
4152                 $pkg_svc ? $pkg_svc->quantity : 0,
4153               ];
4154             }
4155
4156         grep { $_ != $svcpart }
4157         map  { $_->svcpart }
4158         qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
4159       ];
4160       warn "alternates for svcpart $svcpart: ".
4161            join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
4162         if $DEBUG;
4163     }
4164   }
4165
4166   my $error;
4167   foreach my $cust_svc ($self->cust_svc) {
4168     my $svcnum = $cust_svc->svcnum;
4169     if($target{$cust_svc->svcpart} > 0
4170        or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
4171       $target{$cust_svc->svcpart}--;
4172       my $new = new FS::cust_svc { $cust_svc->hash };
4173       $new->pkgnum($dest_pkgnum);
4174       $error = $new->replace($cust_svc);
4175     } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
4176       if ( $DEBUG ) {
4177         warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
4178         warn "alternates to consider: ".
4179              join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
4180       }
4181       my @alternate = grep {
4182                              warn "considering alternate svcpart $_: ".
4183                                   "$target{$_} available in new package\n"
4184                                if $DEBUG;
4185                              $target{$_} > 0;
4186                            } @{$svcpart2svcparts{$cust_svc->svcpart}};
4187       if ( @alternate ) {
4188         warn "alternate(s) found\n" if $DEBUG;
4189         my $change_svcpart = $alternate[0];
4190         $target{$change_svcpart}--;
4191         my $new = new FS::cust_svc { $cust_svc->hash };
4192         $new->svcpart($change_svcpart);
4193         $new->pkgnum($dest_pkgnum);
4194         $error = $new->replace($cust_svc);
4195       } else {
4196         $remaining++;
4197       }
4198     } else {
4199       $remaining++
4200     }
4201     if ( $error ) {
4202       my @label = $cust_svc->label;
4203       return "$label[0] $label[1]: $error";
4204     }
4205   }
4206   return $remaining;
4207 }
4208
4209 =item grab_svcnums SVCNUM, SVCNUM ...
4210
4211 Change the pkgnum for the provided services to this packages.  If there is an
4212 error, returns the error, otherwise returns false.
4213
4214 =cut
4215
4216 sub grab_svcnums {
4217   my $self = shift;
4218   my @svcnum = @_;
4219
4220   my $oldAutoCommit = $FS::UID::AutoCommit;
4221   local $FS::UID::AutoCommit = 0;
4222   my $dbh = dbh;
4223
4224   foreach my $svcnum (@svcnum) {
4225     my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
4226       $dbh->rollback if $oldAutoCommit;
4227       return "unknown svcnum $svcnum";
4228     };
4229     $cust_svc->pkgnum( $self->pkgnum );
4230     my $error = $cust_svc->replace;
4231     if ( $error ) {
4232       $dbh->rollback if $oldAutoCommit;
4233       return $error;
4234     }
4235   }
4236
4237   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4238   '';
4239
4240 }
4241
4242 =item reexport
4243
4244 This method is deprecated.  See the I<depend_jobnum> option to the insert and
4245 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
4246
4247 =cut
4248
4249 #looks like this is still used by the order_pkg and change_pkg methods in
4250 # ClientAPI/MyAccount, need to look into those before removing
4251 sub reexport {
4252   my $self = shift;
4253
4254   my $oldAutoCommit = $FS::UID::AutoCommit;
4255   local $FS::UID::AutoCommit = 0;
4256   my $dbh = dbh;
4257
4258   foreach my $cust_svc ( $self->cust_svc ) {
4259     #false laziness w/svc_Common::insert
4260     my $svc_x = $cust_svc->svc_x;
4261     foreach my $part_export ( $cust_svc->part_svc->part_export ) {
4262       my $error = $part_export->export_insert($svc_x);
4263       if ( $error ) {
4264         $dbh->rollback if $oldAutoCommit;
4265         return $error;
4266       }
4267     }
4268   }
4269
4270   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4271   '';
4272
4273 }
4274
4275 =item export_pkg_change OLD_CUST_PKG
4276
4277 Calls the "pkg_change" export action for all services attached to this package.
4278
4279 =cut
4280
4281 sub export_pkg_change {
4282   my( $self, $old )  = ( shift, shift );
4283
4284   my $oldAutoCommit = $FS::UID::AutoCommit;
4285   local $FS::UID::AutoCommit = 0;
4286   my $dbh = dbh;
4287
4288   foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
4289     my $error = $svc_x->export('pkg_change', $self, $old);
4290     if ( $error ) {
4291       $dbh->rollback if $oldAutoCommit;
4292       return $error;
4293     }
4294   }
4295
4296   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4297   '';
4298
4299 }
4300
4301 =item insert_reason
4302
4303 Associates this package with a (suspension or cancellation) reason (see
4304 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
4305 L<FS::reason>).
4306
4307 Available options are:
4308
4309 =over 4
4310
4311 =item reason
4312
4313 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.
4314
4315 =item reason_otaker
4316
4317 the access_user (see L<FS::access_user>) providing the reason
4318
4319 =item date
4320
4321 a unix timestamp
4322
4323 =item action
4324
4325 the action (cancel, susp, adjourn, expire) associated with the reason
4326
4327 =back
4328
4329 If there is an error, returns the error, otherwise returns false.
4330
4331 =cut
4332
4333 sub insert_reason {
4334   my ($self, %options) = @_;
4335
4336   my $otaker = $options{reason_otaker} ||
4337                $FS::CurrentUser::CurrentUser->username;
4338
4339   my $reasonnum;
4340   if ( $options{'reason'} =~ /^(\d+)$/ ) {
4341
4342     $reasonnum = $1;
4343
4344   } elsif ( ref($options{'reason'}) ) {
4345
4346     return 'Enter a new reason (or select an existing one)'
4347       unless $options{'reason'}->{'reason'} !~ /^\s*$/;
4348
4349     my $reason = new FS::reason({
4350       'reason_type' => $options{'reason'}->{'typenum'},
4351       'reason'      => $options{'reason'}->{'reason'},
4352     });
4353     my $error = $reason->insert;
4354     return $error if $error;
4355
4356     $reasonnum = $reason->reasonnum;
4357
4358   } else {
4359     return "Unparseable reason: ". $options{'reason'};
4360   }
4361
4362   my $cust_pkg_reason =
4363     new FS::cust_pkg_reason({ 'pkgnum'    => $self->pkgnum,
4364                               'reasonnum' => $reasonnum,
4365                               'otaker'    => $otaker,
4366                               'action'    => substr(uc($options{'action'}),0,1),
4367                               'date'      => $options{'date'}
4368                                                ? $options{'date'}
4369                                                : time,
4370                             });
4371
4372   $cust_pkg_reason->insert;
4373 }
4374
4375 =item insert_discount
4376
4377 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
4378 inserting a new discount on the fly (see L<FS::discount>).
4379
4380 This will look at the cust_pkg for a pseudo-field named "setup_discountnum",
4381 and if present, will create a setup discount. If the discountnum is -1,
4382 a new discount definition will be inserted using the value in
4383 "setup_discountnum_amount" or "setup_discountnum_percent". Likewise for recur.
4384
4385 If there is an error, returns the error, otherwise returns false.
4386
4387 =cut
4388
4389 sub insert_discount {
4390   #my ($self, %options) = @_;
4391   my $self = shift;
4392
4393   foreach my $x (qw(setup recur)) {
4394     if ( my $discountnum = $self->get("${x}_discountnum") ) {
4395       my $cust_pkg_discount = FS::cust_pkg_discount->new( {
4396         'pkgnum'      => $self->pkgnum,
4397         'discountnum' => $discountnum,
4398         'setuprecur'  => $x,
4399         'months_used' => 0,
4400         'end_date'    => '', #XXX
4401         #for the create a new discount case
4402         'amount'      => $self->get("${x}_discountnum_amount"),
4403         'percent'     => $self->get("${x}_discountnum_percent"),
4404         'months'      => $self->get("${x}_discountnum_months"),
4405       } );
4406       if ( $x eq 'setup' ) {
4407         $cust_pkg_discount->setup('Y');
4408         $cust_pkg_discount->months('');
4409       }
4410       my $error = $cust_pkg_discount->insert;
4411       return $error if $error;
4412     }
4413   }
4414
4415   '';
4416 }
4417
4418 =item set_usage USAGE_VALUE_HASHREF
4419
4420 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4421 to which they should be set (see L<FS::svc_acct>).  Currently seconds,
4422 upbytes, downbytes, and totalbytes are appropriate keys.
4423
4424 All svc_accts which are part of this package have their values reset.
4425
4426 =cut
4427
4428 sub set_usage {
4429   my ($self, $valueref, %opt) = @_;
4430
4431   #only svc_acct can set_usage for now
4432   foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4433     my $svc_x = $cust_svc->svc_x;
4434     $svc_x->set_usage($valueref, %opt)
4435       if $svc_x->can("set_usage");
4436   }
4437 }
4438
4439 =item recharge USAGE_VALUE_HASHREF
4440
4441 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4442 to which they should be set (see L<FS::svc_acct>).  Currently seconds,
4443 upbytes, downbytes, and totalbytes are appropriate keys.
4444
4445 All svc_accts which are part of this package have their values incremented.
4446
4447 =cut
4448
4449 sub recharge {
4450   my ($self, $valueref) = @_;
4451
4452   #only svc_acct can set_usage for now
4453   foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4454     my $svc_x = $cust_svc->svc_x;
4455     $svc_x->recharge($valueref)
4456       if $svc_x->can("recharge");
4457   }
4458 }
4459
4460 =item apply_usageprice
4461
4462 =cut
4463
4464 sub apply_usageprice {
4465   my $self = shift;
4466
4467   my $oldAutoCommit = $FS::UID::AutoCommit;
4468   local $FS::UID::AutoCommit = 0;
4469   my $dbh = dbh;
4470
4471   my $error = '';
4472
4473   foreach my $cust_pkg_usageprice ( $self->cust_pkg_usageprice ) {
4474     $error ||= $cust_pkg_usageprice->apply;
4475   }
4476
4477   if ( $error ) {
4478     $dbh->rollback if $oldAutoCommit;
4479     die "error applying part_pkg_usageprice add-ons, pkgnum ". $self->pkgnum.
4480         ": $error\n";
4481   } else {
4482     $dbh->commit if $oldAutoCommit;
4483   }
4484
4485
4486 }
4487
4488 =item cust_pkg_discount
4489
4490 =item cust_pkg_discount_active
4491
4492 =cut
4493
4494 sub cust_pkg_discount_active {
4495   my $self = shift;
4496   grep { $_->status eq 'active' } $self->cust_pkg_discount;
4497 }
4498
4499 =item cust_pkg_usage
4500
4501 Returns a list of all voice usage counters attached to this package.
4502
4503 =item apply_usage OPTIONS
4504
4505 Takes the following options:
4506 - cdr: a call detail record (L<FS::cdr>)
4507 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
4508 - minutes: the maximum number of minutes to be charged
4509
4510 Finds available usage minutes for a call of this class, and subtracts
4511 up to that many minutes from the usage pool.  If the usage pool is empty,
4512 and the C<cdr-minutes_priority> global config option is set, minutes may
4513 be taken from other calls as well.  Either way, an allocation record will
4514 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
4515 number of minutes of usage applied to the call.
4516
4517 =cut
4518
4519 sub apply_usage {
4520   my ($self, %opt) = @_;
4521   my $cdr = $opt{cdr};
4522   my $rate_detail = $opt{rate_detail};
4523   my $minutes = $opt{minutes};
4524   my $classnum = $rate_detail->classnum;
4525   my $pkgnum = $self->pkgnum;
4526   my $custnum = $self->custnum;
4527
4528   my $oldAutoCommit = $FS::UID::AutoCommit;
4529   local $FS::UID::AutoCommit = 0;
4530   my $dbh = dbh;
4531
4532   my $order = FS::Conf->new->config('cdr-minutes_priority');
4533
4534   my $is_classnum;
4535   if ( $classnum ) {
4536     $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
4537   } else {
4538     $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
4539   }
4540   my @usage_recs = qsearch({
4541       'table'     => 'cust_pkg_usage',
4542       'addl_from' => ' JOIN part_pkg_usage       USING (pkgusagepart)'.
4543                      ' JOIN cust_pkg             USING (pkgnum)'.
4544                      ' JOIN part_pkg_usage_class USING (pkgusagepart)',
4545       'select'    => 'cust_pkg_usage.*',
4546       'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
4547                      " ( cust_pkg.custnum = $custnum AND ".
4548                      " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4549                      $is_classnum . ' AND '.
4550                      " cust_pkg_usage.minutes > 0",
4551       'order_by'  => " ORDER BY priority ASC",
4552   });
4553
4554   my $orig_minutes = $minutes;
4555   my $error;
4556   while (!$error and $minutes > 0 and @usage_recs) {
4557     my $cust_pkg_usage = shift @usage_recs;
4558     $cust_pkg_usage->select_for_update;
4559     my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
4560         pkgusagenum => $cust_pkg_usage->pkgusagenum,
4561         acctid      => $cdr->acctid,
4562         minutes     => min($cust_pkg_usage->minutes, $minutes),
4563     });
4564     $cust_pkg_usage->set('minutes',
4565       $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes
4566     );
4567     $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
4568     $minutes -= $cdr_cust_pkg_usage->minutes;
4569   }
4570   if ( $order and $minutes > 0 and !$error ) {
4571     # then try to steal minutes from another call
4572     my %search = (
4573         'table'     => 'cdr_cust_pkg_usage',
4574         'addl_from' => ' JOIN cust_pkg_usage        USING (pkgusagenum)'.
4575                        ' JOIN part_pkg_usage        USING (pkgusagepart)'.
4576                        ' JOIN cust_pkg              USING (pkgnum)'.
4577                        ' JOIN part_pkg_usage_class  USING (pkgusagepart)'.
4578                        ' JOIN cdr                   USING (acctid)',
4579         'select'    => 'cdr_cust_pkg_usage.*',
4580         'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
4581                        " ( cust_pkg.pkgnum = $pkgnum OR ".
4582                        " ( cust_pkg.custnum = $custnum AND ".
4583                        " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4584                        " part_pkg_usage_class.classnum = $classnum",
4585         'order_by'  => ' ORDER BY part_pkg_usage.priority ASC',
4586     );
4587     if ( $order eq 'time' ) {
4588       # find CDRs that are using minutes, but have a later startdate
4589       # than this call
4590       my $startdate = $cdr->startdate;
4591       if ($startdate !~ /^\d+$/) {
4592         die "bad cdr startdate '$startdate'";
4593       }
4594       $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
4595       # minimize needless reshuffling
4596       $search{'order_by'} .= ', cdr.startdate DESC';
4597     } else {
4598       # XXX may not work correctly with rate_time schedules.  Could
4599       # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
4600       # think...
4601       $search{'addl_from'} .=
4602         ' JOIN rate_detail'.
4603         ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
4604       if ( $order eq 'rate_high' ) {
4605         $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
4606                                 $rate_detail->min_charge;
4607         $search{'order_by'} .= ', rate_detail.min_charge ASC';
4608       } elsif ( $order eq 'rate_low' ) {
4609         $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
4610                                 $rate_detail->min_charge;
4611         $search{'order_by'} .= ', rate_detail.min_charge DESC';
4612       } else {
4613         #  this should really never happen
4614         die "invalid cdr-minutes_priority value '$order'\n";
4615       }
4616     }
4617     my @cdr_usage_recs = qsearch(\%search);
4618     my %reproc_cdrs;
4619     while (!$error and @cdr_usage_recs and $minutes > 0) {
4620       my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
4621       my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
4622       my $old_cdr = $cdr_cust_pkg_usage->cdr;
4623       $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
4624       $cdr_cust_pkg_usage->select_for_update;
4625       $old_cdr->select_for_update;
4626       $cust_pkg_usage->select_for_update;
4627       # in case someone else stole the usage from this CDR
4628       # while waiting for the lock...
4629       next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
4630       # steal the usage allocation and flag the old CDR for reprocessing
4631       $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
4632       # if the allocation is more minutes than we need, adjust it...
4633       my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
4634       if ( $delta > 0 ) {
4635         $cdr_cust_pkg_usage->set('minutes', $minutes);
4636         $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
4637         $error = $cust_pkg_usage->replace;
4638       }
4639       #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
4640       $error ||= $cdr_cust_pkg_usage->replace;
4641       # deduct the stolen minutes
4642       $minutes -= $cdr_cust_pkg_usage->minutes;
4643     }
4644     # after all minute-stealing is done, reset the affected CDRs
4645     foreach (values %reproc_cdrs) {
4646       $error ||= $_->set_status('');
4647       # XXX or should we just call $cdr->rate right here?
4648       # it's not like we can create a loop this way, since the min_charge
4649       # or call time has to go monotonically in one direction.
4650       # we COULD get some very deep recursions going, though...
4651     }
4652   } # if $order and $minutes
4653   if ( $error ) {
4654     $dbh->rollback;
4655     die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
4656   } else {
4657     $dbh->commit if $oldAutoCommit;
4658     return $orig_minutes - $minutes;
4659   }
4660 }
4661
4662 =item supplemental_pkgs
4663
4664 Returns a list of all packages supplemental to this one.
4665
4666 =cut
4667
4668 sub supplemental_pkgs {
4669   my $self = shift;
4670   qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
4671 }
4672
4673 =item main_pkg
4674
4675 Returns the package that this one is supplemental to, if any.
4676
4677 =cut
4678
4679 sub main_pkg {
4680   my $self = shift;
4681   if ( $self->main_pkgnum ) {
4682     return FS::cust_pkg->by_key($self->main_pkgnum);
4683   }
4684   return;
4685 }
4686
4687 =back
4688
4689 =head1 CLASS METHODS
4690
4691 =over 4
4692
4693 =item recurring_sql
4694
4695 Returns an SQL expression identifying recurring packages.
4696
4697 =cut
4698
4699 sub recurring_sql { "
4700   '0' != ( select freq from part_pkg
4701              where cust_pkg.pkgpart = part_pkg.pkgpart )
4702 "; }
4703
4704 =item onetime_sql
4705
4706 Returns an SQL expression identifying one-time packages.
4707
4708 =cut
4709
4710 sub onetime_sql { "
4711   '0' = ( select freq from part_pkg
4712             where cust_pkg.pkgpart = part_pkg.pkgpart )
4713 "; }
4714
4715 =item ordered_sql
4716
4717 Returns an SQL expression identifying ordered packages (recurring packages not
4718 yet billed).
4719
4720 =cut
4721
4722 sub ordered_sql {
4723    $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
4724 }
4725
4726 =item active_sql
4727
4728 Returns an SQL expression identifying active packages.
4729
4730 =cut
4731
4732 sub active_sql {
4733   $_[0]->recurring_sql. "
4734   AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4735   AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4736   AND ( cust_pkg.susp   IS NULL OR cust_pkg.susp   = 0 )
4737 "; }
4738
4739 =item not_yet_billed_sql
4740
4741 Returns an SQL expression identifying packages which have not yet been billed.
4742
4743 =cut
4744
4745 sub not_yet_billed_sql { "
4746       ( cust_pkg.setup  IS NULL OR cust_pkg.setup  = 0 )
4747   AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4748   AND ( cust_pkg.susp   IS NULL OR cust_pkg.susp   = 0 )
4749 "; }
4750
4751 =item inactive_sql
4752
4753 Returns an SQL expression identifying inactive packages (one-time packages
4754 that are otherwise unsuspended/uncancelled).
4755
4756 =cut
4757
4758 sub inactive_sql { "
4759   ". $_[0]->onetime_sql(). "
4760   AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4761   AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4762   AND ( cust_pkg.susp   IS NULL OR cust_pkg.susp   = 0 )
4763 "; }
4764
4765 =item on_hold_sql
4766
4767 Returns an SQL expression identifying on-hold packages.
4768
4769 =cut
4770
4771 sub on_hold_sql {
4772   #$_[0]->recurring_sql(). ' AND '.
4773   "
4774         ( cust_pkg.cancel IS     NULL  OR cust_pkg.cancel  = 0 )
4775     AND   cust_pkg.susp   IS NOT NULL AND cust_pkg.susp   != 0
4776     AND ( cust_pkg.setup  IS     NULL  OR cust_pkg.setup   = 0 )
4777   ";
4778 }
4779
4780 =item susp_sql
4781 =item suspended_sql
4782
4783 Returns an SQL expression identifying suspended packages.
4784
4785 =cut
4786
4787 sub suspended_sql { susp_sql(@_); }
4788 sub susp_sql {
4789   #$_[0]->recurring_sql(). ' AND '.
4790   "
4791         ( cust_pkg.cancel IS     NULL  OR cust_pkg.cancel = 0 )
4792     AND   cust_pkg.susp   IS NOT NULL AND cust_pkg.susp  != 0
4793     AND   cust_pkg.setup  IS NOT NULL AND cust_pkg.setup != 0
4794   ";
4795 }
4796
4797 =item cancel_sql
4798 =item cancelled_sql
4799
4800 Returns an SQL exprression identifying cancelled packages.
4801
4802 =cut
4803
4804 sub cancelled_sql { cancel_sql(@_); }
4805 sub cancel_sql {
4806   #$_[0]->recurring_sql(). ' AND '.
4807   "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
4808 }
4809
4810 =item status_sql
4811
4812 Returns an SQL expression to give the package status as a string.
4813
4814 =cut
4815
4816 sub status_sql {
4817 "CASE
4818   WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
4819   WHEN ( cust_pkg.susp IS NOT NULL AND cust_pkg.setup IS NULL ) THEN 'on hold'
4820   WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
4821   WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
4822   WHEN ".onetime_sql()." THEN 'one-time charge'
4823   ELSE 'active'
4824 END"
4825 }
4826
4827 =item fcc_477_count
4828
4829 Returns a list of two package counts.  The first is a count of packages
4830 based on the supplied criteria and the second is the count of residential
4831 packages with those same criteria.  Criteria are specified as in the search
4832 method.
4833
4834 =cut
4835
4836 sub fcc_477_count {
4837   my ($class, $params) = @_;
4838
4839   my $sql_query = $class->search( $params );
4840
4841   my $count_sql = delete($sql_query->{'count_query'});
4842   $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
4843     or die "couldn't parse count_sql";
4844
4845   my $count_sth = dbh->prepare($count_sql)
4846     or die "Error preparing $count_sql: ". dbh->errstr;
4847   $count_sth->execute
4848     or die "Error executing $count_sql: ". $count_sth->errstr;
4849   my $count_arrayref = $count_sth->fetchrow_arrayref;
4850
4851   return ( @$count_arrayref );
4852
4853 }
4854
4855 =item tax_locationnum_sql
4856
4857 Returns an SQL expression for the tax location for a package, based
4858 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
4859
4860 =cut
4861
4862 sub tax_locationnum_sql {
4863   my $conf = FS::Conf->new;
4864   if ( $conf->exists('tax-pkg_address') ) {
4865     'cust_pkg.locationnum';
4866   }
4867   elsif ( $conf->exists('tax-ship_address') ) {
4868     'cust_main.ship_locationnum';
4869   }
4870   else {
4871     'cust_main.bill_locationnum';
4872   }
4873 }
4874
4875 =item location_sql
4876
4877 Returns a list: the first item is an SQL fragment identifying matching
4878 packages/customers via location (taking into account shipping and package
4879 address taxation, if enabled), and subsequent items are the parameters to
4880 substitute for the placeholders in that fragment.
4881
4882 =cut
4883
4884 sub location_sql {
4885   my($class, %opt) = @_;
4886   my $ornull = $opt{'ornull'};
4887
4888   my $conf = new FS::Conf;
4889
4890   # '?' placeholders in _location_sql_where
4891   my $x = $ornull ? 3 : 2;
4892   my @bill_param = (
4893     ('district')x3,
4894     ('city')x3,
4895     ('county')x$x,
4896     ('state')x$x,
4897     'country'
4898   );
4899
4900   my $main_where;
4901   my @main_param;
4902   if ( $conf->exists('tax-ship_address') ) {
4903
4904     $main_where = "(
4905          (     ( ship_last IS NULL     OR  ship_last  = '' )
4906            AND ". _location_sql_where('cust_main', '', $ornull ). "
4907          )
4908       OR (       ship_last IS NOT NULL AND ship_last != ''
4909            AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
4910          )
4911     )";
4912     #    AND payby != 'COMP'
4913
4914     @main_param = ( @bill_param, @bill_param );
4915
4916   } else {
4917
4918     $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
4919     @main_param = @bill_param;
4920
4921   }
4922
4923   my $where;
4924   my @param;
4925   if ( $conf->exists('tax-pkg_address') ) {
4926
4927     my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
4928
4929     $where = " (
4930                     ( cust_pkg.locationnum IS     NULL AND $main_where )
4931                  OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where  )
4932                )
4933              ";
4934     @param = ( @main_param, @bill_param );
4935
4936   } else {
4937
4938     $where = $main_where;
4939     @param = @main_param;
4940
4941   }
4942
4943   ( $where, @param );
4944
4945 }
4946
4947 #subroutine, helper for location_sql
4948 sub _location_sql_where {
4949   my $table  = shift;
4950   my $prefix = @_ ? shift : '';
4951   my $ornull = @_ ? shift : '';
4952
4953 #  $ornull             = $ornull          ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
4954
4955   $ornull = $ornull ? ' OR ? IS NULL ' : '';
4956
4957   my $or_empty_city     = " OR ( ? = '' AND $table.${prefix}city     IS NULL )";
4958   my $or_empty_county   = " OR ( ? = '' AND $table.${prefix}county   IS NULL )";
4959   my $or_empty_state    = " OR ( ? = '' AND $table.${prefix}state    IS NULL )";
4960
4961   my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
4962
4963 #        ( $table.${prefix}city    = ? $or_empty_city   $ornull )
4964   "
4965         ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4966     AND ( $table.${prefix}city     = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4967     AND ( $table.${prefix}county   = ? $or_empty_county $ornull )
4968     AND ( $table.${prefix}state    = ? $or_empty_state  $ornull )
4969     AND   $table.${prefix}country  = ?
4970   ";
4971 }
4972
4973 sub _X_show_zero {
4974   my( $self, $what ) = @_;
4975
4976   my $what_show_zero = $what. '_show_zero';
4977   length($self->$what_show_zero())
4978     ? ($self->$what_show_zero() eq 'Y')
4979     : $self->part_pkg->$what_show_zero();
4980 }
4981
4982 =head1 SUBROUTINES
4983
4984 =over 4
4985
4986 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
4987
4988 Bulk cancel + order subroutine.  Perhaps slightly deprecated, only used by the
4989 bulk cancel+order in the web UI and nowhere else (edit/process/cust_pkg.cgi)
4990
4991 CUSTNUM is a customer (see L<FS::cust_main>)
4992
4993 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4994 L<FS::part_pkg>) to order for this customer.  Duplicates are of course
4995 permitted.
4996
4997 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
4998 remove for this customer.  The services (see L<FS::cust_svc>) are moved to the
4999 new billing items.  An error is returned if this is not possible (see
5000 L<FS::pkg_svc>).  An empty arrayref is equivalent to not specifying this
5001 parameter.
5002
5003 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5004 newly-created cust_pkg objects.
5005
5006 REFNUM, if specified, will specify the FS::pkg_referral record to be created
5007 and inserted.  Multiple FS::pkg_referral records can be created by
5008 setting I<refnum> to an array reference of refnums or a hash reference with
5009 refnums as keys.  If no I<refnum> is defined, a default FS::pkg_referral
5010 record will be created corresponding to cust_main.refnum.
5011
5012 =cut
5013
5014 sub order {
5015   my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
5016
5017   my $conf = new FS::Conf;
5018
5019   # Transactionize this whole mess
5020   my $oldAutoCommit = $FS::UID::AutoCommit;
5021   local $FS::UID::AutoCommit = 0;
5022   my $dbh = dbh;
5023
5024   my $error;
5025 #  my $cust_main = qsearchs('cust_main', { custnum => $custnum });
5026 #  return "Customer not found: $custnum" unless $cust_main;
5027
5028   warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
5029     if $DEBUG;
5030
5031   my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5032                          @$remove_pkgnum;
5033
5034   my $change = scalar(@old_cust_pkg) != 0;
5035
5036   my %hash = ();
5037   if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
5038
5039     warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
5040          " to pkgpart ". $pkgparts->[0]. "\n"
5041       if $DEBUG;
5042
5043     my $err_or_cust_pkg =
5044       $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
5045                                 'refnum'  => $refnum,
5046                               );
5047
5048     unless (ref($err_or_cust_pkg)) {
5049       $dbh->rollback if $oldAutoCommit;
5050       return $err_or_cust_pkg;
5051     }
5052
5053     push @$return_cust_pkg, $err_or_cust_pkg;
5054     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5055     return '';
5056
5057   }
5058
5059   # Create the new packages.
5060   foreach my $pkgpart (@$pkgparts) {
5061
5062     warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
5063
5064     my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
5065                                       pkgpart => $pkgpart,
5066                                       refnum  => $refnum,
5067                                       %hash,
5068                                     };
5069     $error = $cust_pkg->insert( 'change' => $change );
5070     push @$return_cust_pkg, $cust_pkg;
5071
5072     foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
5073       my $supp_pkg = FS::cust_pkg->new({
5074           custnum => $custnum,
5075           pkgpart => $link->dst_pkgpart,
5076           refnum  => $refnum,
5077           main_pkgnum => $cust_pkg->pkgnum,
5078           %hash,
5079       });
5080       $error ||= $supp_pkg->insert( 'change' => $change );
5081       push @$return_cust_pkg, $supp_pkg;
5082     }
5083
5084     if ($error) {
5085       $dbh->rollback if $oldAutoCommit;
5086       return $error;
5087     }
5088
5089   }
5090   # $return_cust_pkg now contains refs to all of the newly
5091   # created packages.
5092
5093   # Transfer services and cancel old packages.
5094   foreach my $old_pkg (@old_cust_pkg) {
5095
5096     warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
5097       if $DEBUG;
5098
5099     foreach my $new_pkg (@$return_cust_pkg) {
5100       $error = $old_pkg->transfer($new_pkg);
5101       if ($error and $error == 0) {
5102         # $old_pkg->transfer failed.
5103         $dbh->rollback if $oldAutoCommit;
5104         return $error;
5105       }
5106     }
5107
5108     if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
5109       warn "trying transfer again with change_svcpart option\n" if $DEBUG;
5110       foreach my $new_pkg (@$return_cust_pkg) {
5111         $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
5112         if ($error and $error == 0) {
5113           # $old_pkg->transfer failed.
5114         $dbh->rollback if $oldAutoCommit;
5115         return $error;
5116         }
5117       }
5118     }
5119
5120     if ($error > 0) {
5121       # Transfers were successful, but we went through all of the
5122       # new packages and still had services left on the old package.
5123       # We can't cancel the package under the circumstances, so abort.
5124       $dbh->rollback if $oldAutoCommit;
5125       return "Unable to transfer all services from package ".$old_pkg->pkgnum;
5126     }
5127     $error = $old_pkg->cancel( quiet=>1, 'no_delay_cancel'=>1 );
5128     if ($error) {
5129       $dbh->rollback;
5130       return $error;
5131     }
5132   }
5133   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5134   '';
5135 }
5136
5137 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
5138
5139 A bulk change method to change packages for multiple customers.
5140
5141 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5142 L<FS::part_pkg>) to order for each customer.  Duplicates are of course
5143 permitted.
5144
5145 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
5146 replace.  The services (see L<FS::cust_svc>) are moved to the
5147 new billing items.  An error is returned if this is not possible (see
5148 L<FS::pkg_svc>).
5149
5150 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5151 newly-created cust_pkg objects.
5152
5153 =cut
5154
5155 sub bulk_change {
5156   my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
5157
5158   # Transactionize this whole mess
5159   my $oldAutoCommit = $FS::UID::AutoCommit;
5160   local $FS::UID::AutoCommit = 0;
5161   my $dbh = dbh;
5162
5163   my @errors;
5164   my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5165                          @$remove_pkgnum;
5166
5167   while(scalar(@old_cust_pkg)) {
5168     my @return = ();
5169     my $custnum = $old_cust_pkg[0]->custnum;
5170     my (@remove) = map { $_->pkgnum }
5171                    grep { $_->custnum == $custnum } @old_cust_pkg;
5172     @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
5173
5174     my $error = order $custnum, $pkgparts, \@remove, \@return;
5175
5176     push @errors, $error
5177       if $error;
5178     push @$return_cust_pkg, @return;
5179   }
5180
5181   if (scalar(@errors)) {
5182     $dbh->rollback if $oldAutoCommit;
5183     return join(' / ', @errors);
5184   }
5185
5186   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5187   '';
5188 }
5189
5190 =item forward_emails
5191
5192 Returns a hash of svcnums and corresponding email addresses
5193 for svc_acct services that can be used as source or dest
5194 for svc_forward services provisioned in this package.
5195
5196 Accepts options I<svc_forward> OR I<svcnum> for a svc_forward
5197 service;  if included, will ensure the current values of the
5198 specified service are included in the list, even if for some
5199 other reason they wouldn't be.  If called as a class method
5200 with a specified service, returns only these current values.
5201
5202 Caution: does not actually check if svc_forward services are
5203 available to be provisioned on this package.
5204
5205 =cut
5206
5207 sub forward_emails {
5208   my $self = shift;
5209   my %opt = @_;
5210
5211   #load optional service, thoroughly validated
5212   die "Use svcnum or svc_forward, not both"
5213     if $opt{'svcnum'} && $opt{'svc_forward'};
5214   my $svc_forward = $opt{'svc_forward'};
5215   $svc_forward ||= qsearchs('svc_forward',{ 'svcnum' => $opt{'svcnum'} })
5216     if $opt{'svcnum'};
5217   die "Specified service is not a forward service"
5218     if $svc_forward && (ref($svc_forward) ne 'FS::svc_forward');
5219   die "Specified service not found"
5220     if ($opt{'svcnum'} || $opt{'svc_forward'}) && !$svc_forward;
5221
5222   my %email;
5223
5224   ## everything below was basically copied from httemplate/edit/svc_forward.cgi
5225   ## with minimal refactoring, not sure why we can't just load all svc_accts for this custnum
5226
5227   #add current values from specified service, if there was one
5228   if ($svc_forward) {
5229     foreach my $method (qw( srcsvc_acct dstsvc_acct )) {
5230       my $svc_acct = $svc_forward->$method();
5231       $email{$svc_acct->svcnum} = $svc_acct->email if $svc_acct;
5232     }
5233   }
5234
5235   if (ref($self) eq 'FS::cust_pkg') {
5236
5237     #and including the rest for this customer
5238     my($u_part_svc,@u_acct_svcparts);
5239     foreach $u_part_svc ( qsearch('part_svc',{'svcdb'=>'svc_acct'}) ) {
5240       push @u_acct_svcparts,$u_part_svc->getfield('svcpart');
5241     }
5242
5243     my $custnum = $self->getfield('custnum');
5244     foreach my $i_cust_pkg ( qsearch('cust_pkg',{'custnum'=>$custnum}) ) {
5245       my $cust_pkgnum = $i_cust_pkg->getfield('pkgnum');
5246       #now find the corresponding record(s) in cust_svc (for this pkgnum!)
5247       foreach my $acct_svcpart (@u_acct_svcparts) {
5248         foreach my $i_cust_svc (
5249           qsearch( 'cust_svc', { 'pkgnum'  => $cust_pkgnum,
5250                                  'svcpart' => $acct_svcpart } )
5251         ) {
5252           my $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $i_cust_svc->svcnum } );
5253           $email{$svc_acct->svcnum} = $svc_acct->email;
5254         }
5255       }
5256     }
5257   }
5258
5259   return %email;
5260 }
5261
5262 # Used by FS::Upgrade to migrate to a new database.
5263 sub _upgrade_data {  # class method
5264   my ($class, %opts) = @_;
5265   $class->_upgrade_otaker(%opts);
5266   my @statements = (
5267     # RT#10139, bug resulting in contract_end being set when it shouldn't
5268   'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
5269     # RT#10830, bad calculation of prorate date near end of year
5270     # the date range for bill is December 2009, and we move it forward
5271     # one year if it's before the previous bill date (which it should
5272     # never be)
5273   'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
5274   AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
5275   WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
5276     # RT6628, add order_date to cust_pkg
5277     'update cust_pkg set order_date = (select history_date from h_cust_pkg
5278         where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
5279         history_action = \'insert\') where order_date is null',
5280   );
5281   foreach my $sql (@statements) {
5282     my $sth = dbh->prepare($sql);
5283     $sth->execute or die $sth->errstr;
5284   }
5285
5286   # RT31194: supplemental package links that are deleted don't clean up
5287   # linked records
5288   my @pkglinknums = qsearch({
5289       'select'    => 'DISTINCT cust_pkg.pkglinknum',
5290       'table'     => 'cust_pkg',
5291       'addl_from' => ' LEFT JOIN part_pkg_link USING (pkglinknum) ',
5292       'extra_sql' => ' WHERE cust_pkg.pkglinknum IS NOT NULL
5293                         AND part_pkg_link.pkglinknum IS NULL',
5294   });
5295   foreach (@pkglinknums) {
5296     my $pkglinknum = $_->pkglinknum;
5297     warn "cleaning part_pkg_link #$pkglinknum\n";
5298     my $part_pkg_link = FS::part_pkg_link->new({pkglinknum => $pkglinknum});
5299     my $error = $part_pkg_link->remove_linked;
5300     die $error if $error;
5301   }
5302 }
5303
5304 =back
5305
5306 =head1 BUGS
5307
5308 sub order is not OO.  Perhaps it should be moved to FS::cust_main and made so?
5309
5310 In sub order, the @pkgparts array (passed by reference) is clobbered.
5311
5312 Also in sub order, no money is adjusted.  Once FS::part_pkg defines a standard
5313 method to pass dates to the recur_prog expression, it should do so.
5314
5315 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
5316 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
5317 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
5318 configuration values.  Probably need a subroutine which decides what to do
5319 based on whether or not we've fetched the user yet, rather than a hash.  See
5320 FS::UID and the TODO.
5321
5322 Now that things are transactional should the check in the insert method be
5323 moved to check ?
5324
5325 =head1 SEE ALSO
5326
5327 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
5328 L<FS::pkg_svc>, schema.html from the base documentation
5329
5330 =cut
5331
5332 1;
5333