FS/FS/cust_pkg.pm

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