FS/FS/cust_pkg.pm

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