FS/FS/cust_pkg.pm

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