FS/FS/cust_pkg.pm

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