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