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