FS/FS/cust_pkg.pm

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