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