FS/FS/cust_pkg.pm

   1 package FS::cust_pkg;
   2
   3 use strict;
   4 use base qw( FS::otaker_Mixin FS::cust_main_Mixin FS::location_Mixin
   5              FS::m2m_Common FS::option_Common );
   6 use vars qw($disable_agentcheck $DEBUG $me);
   7 use Carp qw(cluck);
   8 use Scalar::Util qw( blessed );
   9 use List::Util qw(max);
  10 use Tie::IxHash;
  11 use Time::Local qw( timelocal_nocheck );
  12 use MIME::Entity;
  13 use FS::UID qw( getotaker dbh );
  14 use FS::Misc qw( send_email );
  15 use FS::Record qw( qsearch qsearchs );
  16 use FS::CurrentUser;
  17 use FS::cust_svc;
  18 use FS::part_pkg;
  19 use FS::cust_main;
  20 use FS::cust_location;
  21 use FS::pkg_svc;
  22 use FS::cust_bill_pkg;
  23 use FS::cust_pkg_detail;
  24 use FS::cust_event;
  25 use FS::h_cust_svc;
  26 use FS::reg_code;
  27 use FS::part_svc;
  28 use FS::cust_pkg_reason;
  29 use FS::reason;
  30 use FS::cust_pkg_discount;
  31 use FS::discount;
  32 use FS::UI::Web;
  33
  34 # need to 'use' these instead of 'require' in sub { cancel, suspend, unsuspend,
  35 # setup }
  36 # because they load configuration by setting FS::UID::callback (see TODO)
  37 use FS::svc_acct;
  38 use FS::svc_domain;
  39 use FS::svc_www;
  40 use FS::svc_forward;
  41
  42 # for sending cancel emails in sub cancel
  43 use FS::Conf;
  44
  45 $DEBUG = 0;
  46 $me = '[FS::cust_pkg]';
  47
  48 $disable_agentcheck = 0;
  49
  50 sub _cache {
  51   my $self = shift;
  52   my ( $hashref, $cache ) = @_;
  53   #if ( $hashref->{'pkgpart'} ) {
  54   if ( $hashref->{'pkg'} ) {
  55     # #@{ $self->{'_pkgnum'} } = ();
  56     # my $subcache = $cache->subcache('pkgpart', 'part_pkg');
  57     # $self->{'_pkgpart'} = $subcache;
  58     # #push @{ $self->{'_pkgnum'} },
  59     #   FS::part_pkg->new_or_cached($hashref, $subcache);
  60     $self->{'_pkgpart'} = FS::part_pkg->new($hashref);
  61   }
  62   if ( exists $hashref->{'svcnum'} ) {
  63     #@{ $self->{'_pkgnum'} } = ();
  64     my $subcache = $cache->subcache('svcnum', 'cust_svc', $hashref->{pkgnum});
  65     $self->{'_svcnum'} = $subcache;
  66     #push @{ $self->{'_pkgnum'} },
  67     FS::cust_svc->new_or_cached($hashref, $subcache) if $hashref->{svcnum};
  68   }
  69 }
  70
  71 =head1 NAME
  72
  73 FS::cust_pkg - Object methods for cust_pkg objects
  74
  75 =head1 SYNOPSIS
  76
  77   use FS::cust_pkg;
  78
  79   $record = new FS::cust_pkg \%hash;
  80   $record = new FS::cust_pkg { 'column' => 'value' };
  81
  82   $error = $record->insert;
  83
  84   $error = $new_record->replace($old_record);
  85
  86   $error = $record->delete;
  87
  88   $error = $record->check;
  89
  90   $error = $record->cancel;
  91
  92   $error = $record->suspend;
  93
  94   $error = $record->unsuspend;
  95
  96   $part_pkg = $record->part_pkg;
  97
  98   @labels = $record->labels;
  99
 100   $seconds = $record->seconds_since($timestamp);
 101
 102   $error = FS::cust_pkg::order( $custnum, \@pkgparts );
 103   $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );
 104
 105 =head1 DESCRIPTION
 106
 107 An FS::cust_pkg object represents a customer billing item.  FS::cust_pkg
 108 inherits from FS::Record.  The following fields are currently supported:
 109
 110 =over 4
 111
 112 =item pkgnum
 113
 114 Primary key (assigned automatically for new billing items)
 115
 116 =item custnum
 117
 118 Customer (see L<FS::cust_main>)
 119
 120 =item pkgpart
 121
 122 Billing item definition (see L<FS::part_pkg>)
 123
 124 =item locationnum
 125
 126 Optional link to package location (see L<FS::location>)
 127
 128 =item order_date
 129
 130 date package was ordered (also remains same on changes)
 131
 132 =item start_date
 133
 134 date
 135
 136 =item setup
 137
 138 date
 139
 140 =item bill
 141
 142 date (next bill date)
 143
 144 =item last_bill
 145
 146 last bill date
 147
 148 =item adjourn
 149
 150 date
 151
 152 =item susp
 153
 154 date
 155
 156 =item expire
 157
 158 date
 159
 160 =item contract_end
 161
 162 date
 163
 164 =item cancel
 165
 166 date
 167
 168 =item usernum
 169
 170 order taker (see L<FS::access_user>)
 171
 172 =item manual_flag
 173
 174 If this field is set to 1, disables the automatic
 175 unsuspension of this package when using the B<unsuspendauto> config option.
 176
 177 =item quantity
 178
 179 If not set, defaults to 1
 180
 181 =item change_date
 182
 183 Date of change from previous package
 184
 185 =item change_pkgnum
 186
 187 Previous pkgnum
 188
 189 =item change_pkgpart
 190
 191 Previous pkgpart
 192
 193 =item change_locationnum
 194
 195 Previous locationnum
 196
 197 =back
 198
 199 Note: setup, last_bill, bill, adjourn, susp, expire, cancel and change_date
 200 are specified as UNIX timestamps; see L<perlfunc/"time">.  Also see
 201 L<Time::Local> and L<Date::Parse> for conversion functions.
 202
 203 =head1 METHODS
 204
 205 =over 4
 206
 207 =item new HASHREF
 208
 209 Create a new billing item.  To add the item to the database, see L<"insert">.
 210
 211 =cut
 212
 213 sub table { 'cust_pkg'; }
 214 sub cust_linked { $_[0]->cust_main_custnum; }
 215 sub cust_unlinked_msg {
 216   my $self = shift;
 217   "WARNING: can't find cust_main.custnum ". $self->custnum.
 218   ' (cust_pkg.pkgnum '. $self->pkgnum. ')';
 219 }
 220
 221 =item insert [ OPTION => VALUE ... ]
 222
 223 Adds this billing item to the database ("Orders" the item).  If there is an
 224 error, returns the error, otherwise returns false.
 225
 226 If the additional field I<promo_code> is defined instead of I<pkgpart>, it
 227 will be used to look up the package definition and agent restrictions will be
 228 ignored.
 229
 230 If the additional field I<refnum> is defined, an FS::pkg_referral record will
 231 be created and inserted.  Multiple FS::pkg_referral records can be created by
 232 setting I<refnum> to an array reference of refnums or a hash reference with
 233 refnums as keys.  If no I<refnum> is defined, a default FS::pkg_referral
 234 record will be created corresponding to cust_main.refnum.
 235
 236 The following options are available:
 237
 238 =over 4
 239
 240 =item change
 241
 242 If set true, supresses any referral credit to a referring customer.
 243
 244 =item options
 245
 246 cust_pkg_option records will be created
 247
 248 =item ticket_subject
 249
 250 a ticket will be added to this customer with this subject
 251
 252 =item ticket_queue
 253
 254 an optional queue name for ticket additions
 255
 256 =back
 257
 258 =cut
 259
 260 sub insert {
 261   my( $self, %options ) = @_;
 262
 263   if ( $self->part_pkg->option('start_1st', 1) && !$self->start_date ) {
 264     my ($sec,$min,$hour,$mday,$mon,$year) = (localtime(time) )[0,1,2,3,4,5];
 265     $mon += 1 unless $mday == 1;
 266     until ( $mon < 12 ) { $mon -= 12; $year++; }
 267     $self->start_date( timelocal_nocheck(0,0,0,1,$mon,$year) );
 268   }
 269
 270   foreach my $action ( qw(expire adjourn contract_end) ) {
 271     my $months = $self->part_pkg->option("${action}_months",1);
 272     if($months and !$self->$action) {
 273       my $start = $self->start_date || $self->setup || time;
 274       $self->$action( $self->part_pkg->add_freq($start, $months) );
 275     }
 276   }
 277
 278   $self->order_date(time);
 279
 280   local $SIG{HUP} = 'IGNORE';
 281   local $SIG{INT} = 'IGNORE';
 282   local $SIG{QUIT} = 'IGNORE';
 283   local $SIG{TERM} = 'IGNORE';
 284   local $SIG{TSTP} = 'IGNORE';
 285   local $SIG{PIPE} = 'IGNORE';
 286
 287   my $oldAutoCommit = $FS::UID::AutoCommit;
 288   local $FS::UID::AutoCommit = 0;
 289   my $dbh = dbh;
 290
 291   my $error = $self->SUPER::insert($options{options} ? %{$options{options}} : ());
 292   if ( $error ) {
 293     $dbh->rollback if $oldAutoCommit;
 294     return $error;
 295   }
 296
 297   $self->refnum($self->cust_main->refnum) unless $self->refnum;
 298   $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
 299   $self->process_m2m( 'link_table'   => 'pkg_referral',
 300                       'target_table' => 'part_referral',
 301                       'params'       => $self->refnum,
 302                     );
 303
 304   if ( $self->discountnum ) {
 305     my $error = $self->insert_discount();
 306     if ( $error ) {
 307       $dbh->rollback if $oldAutoCommit;
 308       return $error;
 309     }
 310   }
 311
 312   #if ( $self->reg_code ) {
 313   #  my $reg_code = qsearchs('reg_code', { 'code' => $self->reg_code } );
 314   #  $error = $reg_code->delete;
 315   #  if ( $error ) {
 316   #    $dbh->rollback if $oldAutoCommit;
 317   #    return $error;
 318   #  }
 319   #}
 320
 321   my $conf = new FS::Conf;
 322
 323   if ( $conf->config('ticket_system') && $options{ticket_subject} ) {
 324
 325     #eval '
 326     #  use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
 327     #  use RT;
 328     #';
 329     #die $@ if $@;
 330     #
 331     #RT::LoadConfig();
 332     #RT::Init();
 333     use FS::TicketSystem;
 334     FS::TicketSystem->init();
 335
 336     my $q = new RT::Queue($RT::SystemUser);
 337     $q->Load($options{ticket_queue}) if $options{ticket_queue};
 338     my $t = new RT::Ticket($RT::SystemUser);
 339     my $mime = new MIME::Entity;
 340     $mime->build( Type => 'text/plain', Data => $options{ticket_subject} );
 341     $t->Create( $options{ticket_queue} ? (Queue => $q) : (),
 342                 Subject => $options{ticket_subject},
 343                 MIMEObj => $mime,
 344               );
 345     $t->AddLink( Type   => 'MemberOf',
 346                  Target => 'freeside://freeside/cust_main/'. $self->custnum,
 347                );
 348   }
 349
 350   if ($conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
 351     my $queue = new FS::queue {
 352       'job'     => 'FS::cust_main::queueable_print',
 353     };
 354     $error = $queue->insert(
 355       'custnum'  => $self->custnum,
 356       'template' => 'welcome_letter',
 357     );
 358
 359     if ($error) {
 360       warn "can't send welcome letter: $error";
 361     }
 362
 363   }
 364
 365   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 366   '';
 367
 368 }
 369
 370 =item delete
 371
 372 This method now works but you probably shouldn't use it.
 373
 374 You don't want to delete packages, because there would then be no record
 375 the customer ever purchased the package.  Instead, see the cancel method and
 376 hide cancelled packages.
 377
 378 =cut
 379
 380 sub delete {
 381   my $self = shift;
 382
 383   local $SIG{HUP} = 'IGNORE';
 384   local $SIG{INT} = 'IGNORE';
 385   local $SIG{QUIT} = 'IGNORE';
 386   local $SIG{TERM} = 'IGNORE';
 387   local $SIG{TSTP} = 'IGNORE';
 388   local $SIG{PIPE} = 'IGNORE';
 389
 390   my $oldAutoCommit = $FS::UID::AutoCommit;
 391   local $FS::UID::AutoCommit = 0;
 392   my $dbh = dbh;
 393
 394   foreach my $cust_pkg_discount ($self->cust_pkg_discount) {
 395     my $error = $cust_pkg_discount->delete;
 396     if ( $error ) {
 397       $dbh->rollback if $oldAutoCommit;
 398       return $error;
 399     }
 400   }
 401   #cust_bill_pkg_discount?
 402
 403   foreach my $cust_pkg_detail ($self->cust_pkg_detail) {
 404     my $error = $cust_pkg_detail->delete;
 405     if ( $error ) {
 406       $dbh->rollback if $oldAutoCommit;
 407       return $error;
 408     }
 409   }
 410
 411   foreach my $cust_pkg_reason (
 412     qsearchs( {
 413                 'table' => 'cust_pkg_reason',
 414                 'hashref' => { 'pkgnum' => $self->pkgnum },
 415               }
 416             )
 417   ) {
 418     my $error = $cust_pkg_reason->delete;
 419     if ( $error ) {
 420       $dbh->rollback if $oldAutoCommit;
 421       return $error;
 422     }
 423   }
 424
 425   #pkg_referral?
 426
 427   my $error = $self->SUPER::delete(@_);
 428   if ( $error ) {
 429     $dbh->rollback if $oldAutoCommit;
 430     return $error;
 431   }
 432
 433   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 434
 435   '';
 436
 437 }
 438
 439 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
 440
 441 Replaces the OLD_RECORD with this one in the database.  If there is an error,
 442 returns the error, otherwise returns false.
 443
 444 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
 445
 446 Changing pkgpart may have disasterous effects.  See the order subroutine.
 447
 448 setup and bill are normally updated by calling the bill method of a customer
 449 object (see L<FS::cust_main>).
 450
 451 suspend is normally updated by the suspend and unsuspend methods.
 452
 453 cancel is normally updated by the cancel method (and also the order subroutine
 454 in some cases).
 455
 456 Available options are:
 457
 458 =over 4
 459
 460 =item reason
 461
 462 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.
 463
 464 =item reason_otaker
 465
 466 the access_user (see L<FS::access_user>) providing the reason
 467
 468 =item options
 469
 470 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
 471
 472 =back
 473
 474 =cut
 475
 476 sub replace {
 477   my $new = shift;
 478
 479   my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
 480               ? shift
 481               : $new->replace_old;
 482
 483   my $options =
 484     ( ref($_[0]) eq 'HASH' )
 485       ? shift
 486       : { @_ };
 487
 488   #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
 489   #return "Can't change otaker!" if $old->otaker ne $new->otaker;
 490
 491   #allow this *sigh*
 492   #return "Can't change setup once it exists!"
 493   #  if $old->getfield('setup') &&
 494   #     $old->getfield('setup') != $new->getfield('setup');
 495
 496   #some logic for bill, susp, cancel?
 497
 498   local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
 499
 500   local $SIG{HUP} = 'IGNORE';
 501   local $SIG{INT} = 'IGNORE';
 502   local $SIG{QUIT} = 'IGNORE';
 503   local $SIG{TERM} = 'IGNORE';
 504   local $SIG{TSTP} = 'IGNORE';
 505   local $SIG{PIPE} = 'IGNORE';
 506
 507   my $oldAutoCommit = $FS::UID::AutoCommit;
 508   local $FS::UID::AutoCommit = 0;
 509   my $dbh = dbh;
 510
 511   foreach my $method ( qw(adjourn expire) ) {  # How many reasons?
 512     if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
 513       my $error = $new->insert_reason(
 514         'reason'        => $options->{'reason'},
 515         'date'          => $new->$method,
 516         'action'        => $method,
 517         'reason_otaker' => $options->{'reason_otaker'},
 518       );
 519       if ( $error ) {
 520         dbh->rollback if $oldAutoCommit;
 521         return "Error inserting cust_pkg_reason: $error";
 522       }
 523     }
 524   }
 525
 526   #save off and freeze RADIUS attributes for any associated svc_acct records
 527   my @svc_acct = ();
 528   if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
 529
 530                 #also check for specific exports?
 531                 # to avoid spurious modify export events
 532     @svc_acct = map  { $_->svc_x }
 533                 grep { $_->part_svc->svcdb eq 'svc_acct' }
 534                      $old->cust_svc;
 535
 536     $_->snapshot foreach @svc_acct;
 537
 538   }
 539
 540   my $error = $new->SUPER::replace($old,
 541                                    $options->{options} ? $options->{options} : ()
 542                                   );
 543   if ( $error ) {
 544     $dbh->rollback if $oldAutoCommit;
 545     return $error;
 546   }
 547
 548   #for prepaid packages,
 549   #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
 550   foreach my $old_svc_acct ( @svc_acct ) {
 551     my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
 552     my $s_error =
 553       $new_svc_acct->replace( $old_svc_acct,
 554                               'depend_jobnum' => $options->{depend_jobnum},
 555                             );
 556     if ( $s_error ) {
 557       $dbh->rollback if $oldAutoCommit;
 558       return $s_error;
 559     }
 560   }
 561
 562   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 563   '';
 564
 565 }
 566
 567 =item check
 568
 569 Checks all fields to make sure this is a valid billing item.  If there is an
 570 error, returns the error, otherwise returns false.  Called by the insert and
 571 replace methods.
 572
 573 =cut
 574
 575 sub check {
 576   my $self = shift;
 577
 578   $self->locationnum('') if !$self->locationnum || $self->locationnum == -1;
 579
 580   my $error =
 581     $self->ut_numbern('pkgnum')
 582     || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
 583     || $self->ut_numbern('pkgpart')
 584     || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
 585     || $self->ut_numbern('start_date')
 586     || $self->ut_numbern('setup')
 587     || $self->ut_numbern('bill')
 588     || $self->ut_numbern('susp')
 589     || $self->ut_numbern('cancel')
 590     || $self->ut_numbern('adjourn')
 591     || $self->ut_numbern('expire')
 592     || $self->ut_enum('no_auto', [ '', 'Y' ])
 593   ;
 594   return $error if $error;
 595
 596   if ( $self->reg_code ) {
 597
 598     unless ( grep { $self->pkgpart == $_->pkgpart }
 599              map  { $_->reg_code_pkg }
 600              qsearchs( 'reg_code', { 'code'     => $self->reg_code,
 601                                      'agentnum' => $self->cust_main->agentnum })
 602            ) {
 603       return "Unknown registration code";
 604     }
 605
 606   } elsif ( $self->promo_code ) {
 607
 608     my $promo_part_pkg =
 609       qsearchs('part_pkg', {
 610         'pkgpart'    => $self->pkgpart,
 611         'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
 612       } );
 613     return 'Unknown promotional code' unless $promo_part_pkg;
 614
 615   } else {
 616
 617     unless ( $disable_agentcheck ) {
 618       my $agent =
 619         qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
 620       return "agent ". $agent->agentnum. ':'. $agent->agent.
 621              " can't purchase pkgpart ". $self->pkgpart
 622         unless $agent->pkgpart_hashref->{ $self->pkgpart }
 623             || $agent->agentnum == $self->part_pkg->agentnum;
 624     }
 625
 626     $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
 627     return $error if $error;
 628
 629   }
 630
 631   $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
 632
 633   if ( $self->dbdef_table->column('manual_flag') ) {
 634     $self->manual_flag('') if $self->manual_flag eq ' ';
 635     $self->manual_flag =~ /^([01]?)$/
 636       or return "Illegal manual_flag ". $self->manual_flag;
 637     $self->manual_flag($1);
 638   }
 639
 640   $self->SUPER::check;
 641 }
 642
 643 =item cancel [ OPTION => VALUE ... ]
 644
 645 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
 646 in this package, then cancels the package itself (sets the cancel field to
 647 now).
 648
 649 Available options are:
 650
 651 =over 4
 652
 653 =item quiet - can be set true to supress email cancellation notices.
 654
 655 =item time -  can be set to cancel the package based on a specific future or historical date.  Using time ensures that the remaining amount is calculated correctly.  Note however that this is an immediate cancel and just changes the date.  You are PROBABLY looking to expire the account instead of using this.
 656
 657 =item reason - 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.
 658
 659 =item date - can be set to a unix style timestamp to specify when to cancel (expire)
 660
 661 =item nobill - can be set true to skip billing if it might otherwise be done.
 662
 663 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
 664 not credit it.  This must be set (by change()) when changing the package
 665 to a different pkgpart or location, and probably shouldn't be in any other
 666 case.  If it's not set, the 'unused_credit_cancel' part_pkg option will
 667 be used.
 668
 669 =back
 670
 671 If there is an error, returns the error, otherwise returns false.
 672
 673 =cut
 674
 675 sub cancel {
 676   my( $self, %options ) = @_;
 677   my $error;
 678
 679   my $conf = new FS::Conf;
 680
 681   warn "cust_pkg::cancel called with options".
 682        join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
 683     if $DEBUG;
 684
 685   local $SIG{HUP} = 'IGNORE';
 686   local $SIG{INT} = 'IGNORE';
 687   local $SIG{QUIT} = 'IGNORE';
 688   local $SIG{TERM} = 'IGNORE';
 689   local $SIG{TSTP} = 'IGNORE';
 690   local $SIG{PIPE} = 'IGNORE';
 691
 692   my $oldAutoCommit = $FS::UID::AutoCommit;
 693   local $FS::UID::AutoCommit = 0;
 694   my $dbh = dbh;
 695
 696   my $old = $self->select_for_update;
 697
 698   if ( $old->get('cancel') || $self->get('cancel') ) {
 699     dbh->rollback if $oldAutoCommit;
 700     return "";  # no error
 701   }
 702
 703   my $date = $options{date} if $options{date}; # expire/cancel later
 704   $date = '' if ($date && $date <= time);      # complain instead?
 705
 706   #race condition: usage could be ongoing until unprovisioned
 707   #resolved by performing a change package instead (which unprovisions) and
 708   #later cancelling
 709   if ( !$options{nobill} && !$date && $conf->exists('bill_usage_on_cancel') ) {
 710       my $copy = $self->new({$self->hash});
 711       my $error =
 712         $copy->cust_main->bill( pkg_list => [ $copy ], cancel => 1 );
 713       warn "Error billing during cancel, custnum ".
 714         #$self->cust_main->custnum. ": $error"
 715         ": $error"
 716         if $error;
 717   }
 718
 719   my $cancel_time = $options{'time'} || time;
 720
 721   if ( $options{'reason'} ) {
 722     $error = $self->insert_reason( 'reason' => $options{'reason'},
 723                                    'action' => $date ? 'expire' : 'cancel',
 724                                    'date'   => $date ? $date : $cancel_time,
 725                                    'reason_otaker' => $options{'reason_otaker'},
 726                                  );
 727     if ( $error ) {
 728       dbh->rollback if $oldAutoCommit;
 729       return "Error inserting cust_pkg_reason: $error";
 730     }
 731   }
 732
 733   my %svc;
 734   if ( $date ) {
 735 # copied from below
 736     foreach my $cust_svc (
 737       #schwartz
 738       map  { $_->[0] }
 739       sort { $a->[1] <=> $b->[1] }
 740       map  { [ $_, $_->svc_x->table_info->{'cancel_weight'} ]; }
 741       qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
 742     ) {
 743       my $error = $cust_svc->cancel( ('date' => $date) );
 744
 745       if ( $error ) {
 746         $dbh->rollback if $oldAutoCommit;
 747         return "Error expiring cust_svc: $error";
 748       }
 749     }
 750   } else { #!date
 751     foreach my $cust_svc (
 752       #schwartz
 753       map  { $_->[0] }
 754       sort { $a->[1] <=> $b->[1] }
 755       map  { [ $_, $_->svc_x->table_info->{'cancel_weight'} ]; }
 756       qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
 757     ) {
 758       my $error = $cust_svc->cancel;
 759
 760       if ( $error ) {
 761         $dbh->rollback if $oldAutoCommit;
 762         return "Error cancelling cust_svc: $error";
 763       }
 764     }
 765   } #if $date
 766
 767   # Add a credit for remaining service
 768   my $last_bill = $self->getfield('last_bill') || 0;
 769   my $next_bill = $self->getfield('bill') || 0;
 770   my $do_credit;
 771   if ( exists($options{'unused_credit'}) ) {
 772     $do_credit = $options{'unused_credit'};
 773   }
 774   else {
 775     $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
 776   }
 777   if ( $do_credit
 778         and $last_bill > 0 # the package has been billed
 779         and $next_bill > 0 # the package has a next bill date
 780         and $next_bill >= $cancel_time # which is in the future
 781   ) {
 782     my $remaining_value = $self->calc_remain('time' => $cancel_time);
 783     if ( $remaining_value > 0 ) {
 784       # && !$options{'no_credit'} ) {
 785       # Undocumented, unused option.
 786       # part_pkg configuration should decide this anyway.
 787       my $error = $self->cust_main->credit(
 788         $remaining_value,
 789         'Credit for unused time on '. $self->part_pkg->pkg,
 790         'reason_type' => $conf->config('cancel_credit_type'),
 791       );
 792       if ($error) {
 793         $dbh->rollback if $oldAutoCommit;
 794         return "Error crediting customer \$$remaining_value for unused time on".
 795                $self->part_pkg->pkg. ": $error";
 796       }
 797     } #if $remaining_value
 798   } #if $do_credit
 799
 800   my %hash = $self->hash;
 801   $date ? ($hash{'expire'} = $date) : ($hash{'cancel'} = $cancel_time);
 802   my $new = new FS::cust_pkg ( \%hash );
 803   $error = $new->replace( $self, options => { $self->options } );
 804   if ( $error ) {
 805     $dbh->rollback if $oldAutoCommit;
 806     return $error;
 807   }
 808
 809   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 810   return '' if $date; #no errors
 811
 812   my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
 813   if ( !$options{'quiet'} &&
 814         $conf->exists('emailcancel', $self->cust_main->agentnum) &&
 815         @invoicing_list ) {
 816     my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
 817     my $error = '';
 818     if ( $msgnum ) {
 819       my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
 820       $error = $msg_template->send( 'cust_main' => $self->cust_main,
 821                                     'object'    => $self );
 822     }
 823     else {
 824       $error = send_email(
 825         'from'    => $conf->config('invoice_from', $self->cust_main->agentnum),
 826         'to'      => \@invoicing_list,
 827         'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
 828         'body'    => [ map "$_\n", $conf->config('cancelmessage') ],
 829       );
 830     }
 831     #should this do something on errors?
 832   }
 833
 834   ''; #no errors
 835
 836 }
 837
 838 =item cancel_if_expired [ NOW_TIMESTAMP ]
 839
 840 Cancels this package if its expire date has been reached.
 841
 842 =cut
 843
 844 sub cancel_if_expired {
 845   my $self = shift;
 846   my $time = shift || time;
 847   return '' unless $self->expire && $self->expire <= $time;
 848   my $error = $self->cancel;
 849   if ( $error ) {
 850     return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
 851            $self->custnum. ": $error";
 852   }
 853   '';
 854 }
 855
 856 =item unexpire
 857
 858 Cancels any pending expiration (sets the expire field to null).
 859
 860 If there is an error, returns the error, otherwise returns false.
 861
 862 =cut
 863
 864 sub unexpire {
 865   my( $self, %options ) = @_;
 866   my $error;
 867
 868   local $SIG{HUP} = 'IGNORE';
 869   local $SIG{INT} = 'IGNORE';
 870   local $SIG{QUIT} = 'IGNORE';
 871   local $SIG{TERM} = 'IGNORE';
 872   local $SIG{TSTP} = 'IGNORE';
 873   local $SIG{PIPE} = 'IGNORE';
 874
 875   my $oldAutoCommit = $FS::UID::AutoCommit;
 876   local $FS::UID::AutoCommit = 0;
 877   my $dbh = dbh;
 878
 879   my $old = $self->select_for_update;
 880
 881   my $pkgnum = $old->pkgnum;
 882   if ( $old->get('cancel') || $self->get('cancel') ) {
 883     dbh->rollback if $oldAutoCommit;
 884     return "Can't unexpire cancelled package $pkgnum";
 885     # or at least it's pointless
 886   }
 887
 888   unless ( $old->get('expire') && $self->get('expire') ) {
 889     dbh->rollback if $oldAutoCommit;
 890     return "";  # no error
 891   }
 892
 893   my %hash = $self->hash;
 894   $hash{'expire'} = '';
 895   my $new = new FS::cust_pkg ( \%hash );
 896   $error = $new->replace( $self, options => { $self->options } );
 897   if ( $error ) {
 898     $dbh->rollback if $oldAutoCommit;
 899     return $error;
 900   }
 901
 902   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 903
 904   ''; #no errors
 905
 906 }
 907
 908 =item suspend [ OPTION => VALUE ... ]
 909
 910 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
 911 package, then suspends the package itself (sets the susp field to now).
 912
 913 Available options are:
 914
 915 =over 4
 916
 917 =item reason - 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.
 918
 919 =item date - can be set to a unix style timestamp to specify when to suspend (adjourn)
 920
 921 =back
 922
 923 If there is an error, returns the error, otherwise returns false.
 924
 925 =cut
 926
 927 sub suspend {
 928   my( $self, %options ) = @_;
 929   my $error;
 930
 931   local $SIG{HUP} = 'IGNORE';
 932   local $SIG{INT} = 'IGNORE';
 933   local $SIG{QUIT} = 'IGNORE';
 934   local $SIG{TERM} = 'IGNORE';
 935   local $SIG{TSTP} = 'IGNORE';
 936   local $SIG{PIPE} = 'IGNORE';
 937
 938   my $oldAutoCommit = $FS::UID::AutoCommit;
 939   local $FS::UID::AutoCommit = 0;
 940   my $dbh = dbh;
 941
 942   my $old = $self->select_for_update;
 943
 944   my $pkgnum = $old->pkgnum;
 945   if ( $old->get('cancel') || $self->get('cancel') ) {
 946     dbh->rollback if $oldAutoCommit;
 947     return "Can't suspend cancelled package $pkgnum";
 948   }
 949
 950   if ( $old->get('susp') || $self->get('susp') ) {
 951     dbh->rollback if $oldAutoCommit;
 952     return "";  # no error                     # complain on adjourn?
 953   }
 954
 955   my $date = $options{date} if $options{date}; # adjourn/suspend later
 956   $date = '' if ($date && $date <= time);      # complain instead?
 957
 958   if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
 959     dbh->rollback if $oldAutoCommit;
 960     return "Package $pkgnum expires before it would be suspended.";
 961   }
 962
 963   my $suspend_time = $options{'time'} || time;
 964
 965   if ( $options{'reason'} ) {
 966     $error = $self->insert_reason( 'reason' => $options{'reason'},
 967                                    'action' => $date ? 'adjourn' : 'suspend',
 968                                    'date'   => $date ? $date : $suspend_time,
 969                                    'reason_otaker' => $options{'reason_otaker'},
 970                                  );
 971     if ( $error ) {
 972       dbh->rollback if $oldAutoCommit;
 973       return "Error inserting cust_pkg_reason: $error";
 974     }
 975   }
 976
 977   unless ( $date ) {
 978
 979     my @labels = ();
 980
 981     foreach my $cust_svc (
 982       qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
 983     ) {
 984       my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
 985
 986       $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
 987         $dbh->rollback if $oldAutoCommit;
 988         return "Illegal svcdb value in part_svc!";
 989       };
 990       my $svcdb = $1;
 991       require "FS/$svcdb.pm";
 992
 993       my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
 994       if ($svc) {
 995         $error = $svc->suspend;
 996         if ( $error ) {
 997           $dbh->rollback if $oldAutoCommit;
 998           return $error;
 999         }
1000         my( $label, $value ) = $cust_svc->label;
1001         push @labels, "$label: $value";
1002       }
1003     }
1004
1005     my $conf = new FS::Conf;
1006     if ( $conf->config('suspend_email_admin') ) {
1007
1008       my $error = send_email(
1009         'from'    => $conf->config('invoice_from', $self->cust_main->agentnum),
1010                                    #invoice_from ??? well as good as any
1011         'to'      => $conf->config('suspend_email_admin'),
1012         'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1013         'body'    => [
1014           "This is an automatic message from your Freeside installation\n",
1015           "informing you that the following customer package has been suspended:\n",
1016           "\n",
1017           'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1018           'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1019           ( map { "Service : $_\n" } @labels ),
1020         ],
1021       );
1022
1023       if ( $error ) {
1024         warn "WARNING: can't send suspension admin email (suspending anyway): ".
1025              "$error\n";
1026       }
1027
1028     }
1029
1030   }
1031
1032   my %hash = $self->hash;
1033   if ( $date ) {
1034     $hash{'adjourn'} = $date;
1035   } else {
1036     $hash{'susp'} = $suspend_time;
1037   }
1038   my $new = new FS::cust_pkg ( \%hash );
1039   $error = $new->replace( $self, options => { $self->options } );
1040   if ( $error ) {
1041     $dbh->rollback if $oldAutoCommit;
1042     return $error;
1043   }
1044
1045   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1046
1047   ''; #no errors
1048 }
1049
1050 =item unsuspend [ OPTION => VALUE ... ]
1051
1052 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1053 package, then unsuspends the package itself (clears the susp field and the
1054 adjourn field if it is in the past).
1055
1056 Available options are:
1057
1058 =over 4
1059
1060 =item adjust_next_bill
1061
1062 Can be set true to adjust the next bill date forward by
1063 the amount of time the account was inactive.  This was set true by default
1064 since 1.4.2 and 1.5.0pre6; however, starting with 1.7.0 this needs to be
1065 explicitly requested.  Price plans for which this makes sense (anniversary-date
1066 based than prorate or subscription) could have an option to enable this
1067 behaviour?
1068
1069 =back
1070
1071 If there is an error, returns the error, otherwise returns false.
1072
1073 =cut
1074
1075 sub unsuspend {
1076   my( $self, %opt ) = @_;
1077   my $error;
1078
1079   local $SIG{HUP} = 'IGNORE';
1080   local $SIG{INT} = 'IGNORE';
1081   local $SIG{QUIT} = 'IGNORE';
1082   local $SIG{TERM} = 'IGNORE';
1083   local $SIG{TSTP} = 'IGNORE';
1084   local $SIG{PIPE} = 'IGNORE';
1085
1086   my $oldAutoCommit = $FS::UID::AutoCommit;
1087   local $FS::UID::AutoCommit = 0;
1088   my $dbh = dbh;
1089
1090   my $old = $self->select_for_update;
1091
1092   my $pkgnum = $old->pkgnum;
1093   if ( $old->get('cancel') || $self->get('cancel') ) {
1094     dbh->rollback if $oldAutoCommit;
1095     return "Can't unsuspend cancelled package $pkgnum";
1096   }
1097
1098   unless ( $old->get('susp') && $self->get('susp') ) {
1099     dbh->rollback if $oldAutoCommit;
1100     return "";  # no error                     # complain instead?
1101   }
1102
1103   foreach my $cust_svc (
1104     qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1105   ) {
1106     my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1107
1108     $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1109       $dbh->rollback if $oldAutoCommit;
1110       return "Illegal svcdb value in part_svc!";
1111     };
1112     my $svcdb = $1;
1113     require "FS/$svcdb.pm";
1114
1115     my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1116     if ($svc) {
1117       $error = $svc->unsuspend;
1118       if ( $error ) {
1119         $dbh->rollback if $oldAutoCommit;
1120         return $error;
1121       }
1122     }
1123
1124   }
1125
1126   my %hash = $self->hash;
1127   my $inactive = time - $hash{'susp'};
1128
1129   my $conf = new FS::Conf;
1130
1131   if ( $inactive > 0 &&
1132        ( $hash{'bill'} || $hash{'setup'} ) &&
1133        ( $opt{'adjust_next_bill'} ||
1134          $conf->exists('unsuspend-always_adjust_next_bill_date') ||
1135          $self->part_pkg->option('unsuspend_adjust_bill', 1) )
1136      ) {
1137
1138     $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1139
1140   }
1141
1142   $hash{'susp'} = '';
1143   $hash{'adjourn'} = '' if $hash{'adjourn'} < time;
1144   my $new = new FS::cust_pkg ( \%hash );
1145   $error = $new->replace( $self, options => { $self->options } );
1146   if ( $error ) {
1147     $dbh->rollback if $oldAutoCommit;
1148     return $error;
1149   }
1150
1151   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1152
1153   ''; #no errors
1154 }
1155
1156 =item unadjourn
1157
1158 Cancels any pending suspension (sets the adjourn field to null).
1159
1160 If there is an error, returns the error, otherwise returns false.
1161
1162 =cut
1163
1164 sub unadjourn {
1165   my( $self, %options ) = @_;
1166   my $error;
1167
1168   local $SIG{HUP} = 'IGNORE';
1169   local $SIG{INT} = 'IGNORE';
1170   local $SIG{QUIT} = 'IGNORE';
1171   local $SIG{TERM} = 'IGNORE';
1172   local $SIG{TSTP} = 'IGNORE';
1173   local $SIG{PIPE} = 'IGNORE';
1174
1175   my $oldAutoCommit = $FS::UID::AutoCommit;
1176   local $FS::UID::AutoCommit = 0;
1177   my $dbh = dbh;
1178
1179   my $old = $self->select_for_update;
1180
1181   my $pkgnum = $old->pkgnum;
1182   if ( $old->get('cancel') || $self->get('cancel') ) {
1183     dbh->rollback if $oldAutoCommit;
1184     return "Can't unadjourn cancelled package $pkgnum";
1185     # or at least it's pointless
1186   }
1187
1188   if ( $old->get('susp') || $self->get('susp') ) {
1189     dbh->rollback if $oldAutoCommit;
1190     return "Can't unadjourn suspended package $pkgnum";
1191     # perhaps this is arbitrary
1192   }
1193
1194   unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1195     dbh->rollback if $oldAutoCommit;
1196     return "";  # no error
1197   }
1198
1199   my %hash = $self->hash;
1200   $hash{'adjourn'} = '';
1201   my $new = new FS::cust_pkg ( \%hash );
1202   $error = $new->replace( $self, options => { $self->options } );
1203   if ( $error ) {
1204     $dbh->rollback if $oldAutoCommit;
1205     return $error;
1206   }
1207
1208   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1209
1210   ''; #no errors
1211
1212 }
1213
1214
1215 =item change HASHREF | OPTION => VALUE ...
1216
1217 Changes this package: cancels it and creates a new one, with a different
1218 pkgpart or locationnum or both.  All services are transferred to the new
1219 package (no change will be made if this is not possible).
1220
1221 Options may be passed as a list of key/value pairs or as a hash reference.
1222 Options are:
1223
1224 =over 4
1225
1226 =item locationnum
1227
1228 New locationnum, to change the location for this package.
1229
1230 =item cust_location
1231
1232 New FS::cust_location object, to create a new location and assign it
1233 to this package.
1234
1235 =item pkgpart
1236
1237 New pkgpart (see L<FS::part_pkg>).
1238
1239 =item refnum
1240
1241 New refnum (see L<FS::part_referral>).
1242
1243 =item keep_dates
1244
1245 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1246 susp, adjourn, cancel, expire, and contract_end) to the new package.
1247
1248 =back
1249
1250 At least one of locationnum, cust_location, pkgpart, refnum must be specified
1251 (otherwise, what's the point?)
1252
1253 Returns either the new FS::cust_pkg object or a scalar error.
1254
1255 For example:
1256
1257   my $err_or_new_cust_pkg = $old_cust_pkg->change
1258
1259 =cut
1260
1261 #some false laziness w/order
1262 sub change {
1263   my $self = shift;
1264   my $opt = ref($_[0]) ? shift : { @_ };
1265
1266 #  my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
1267 #
1268
1269   my $conf = new FS::Conf;
1270
1271   # Transactionize this whole mess
1272   local $SIG{HUP} = 'IGNORE';
1273   local $SIG{INT} = 'IGNORE';
1274   local $SIG{QUIT} = 'IGNORE';
1275   local $SIG{TERM} = 'IGNORE';
1276   local $SIG{TSTP} = 'IGNORE';
1277   local $SIG{PIPE} = 'IGNORE';
1278
1279   my $oldAutoCommit = $FS::UID::AutoCommit;
1280   local $FS::UID::AutoCommit = 0;
1281   my $dbh = dbh;
1282
1283   my $error;
1284
1285   my %hash = ();
1286
1287   my $time = time;
1288
1289   #$hash{$_} = $self->$_() foreach qw( last_bill bill );
1290
1291   #$hash{$_} = $self->$_() foreach qw( setup );
1292
1293   $hash{'setup'} = $time if $self->setup;
1294
1295   $hash{'change_date'} = $time;
1296   $hash{"change_$_"}  = $self->$_()
1297     foreach qw( pkgnum pkgpart locationnum );
1298
1299   if ( $opt->{'cust_location'} &&
1300        ( ! $opt->{'locationnum'} || $opt->{'locationnum'} == -1 ) ) {
1301     $error = $opt->{'cust_location'}->insert;
1302     if ( $error ) {
1303       $dbh->rollback if $oldAutoCommit;
1304       return "inserting cust_location (transaction rolled back): $error";
1305     }
1306     $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1307   }
1308
1309   my $unused_credit = 0;
1310   if ( $opt->{'keep_dates'} ) {
1311     foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1312                           start_date contract_end ) ) {
1313       $hash{$date} = $self->getfield($date);
1314     }
1315   }
1316   # Special case.  If the pkgpart is changing, and the customer is
1317   # going to be credited for remaining time, don't keep setup, bill,
1318   # or last_bill dates, and DO pass the flag to cancel() to credit
1319   # the customer.
1320   if ( $opt->{'pkgpart'}
1321       and $opt->{'pkgpart'} != $self->pkgpart
1322       and $self->part_pkg->option('unused_credit_change', 1) ) {
1323     $unused_credit = 1;
1324     $hash{$_} = '' foreach qw(setup bill last_bill);
1325   }
1326
1327   # Create the new package.
1328   my $cust_pkg = new FS::cust_pkg {
1329     custnum      => $self->custnum,
1330     pkgpart      => ( $opt->{'pkgpart'}     || $self->pkgpart      ),
1331     refnum       => ( $opt->{'refnum'}      || $self->refnum       ),
1332     locationnum  => ( $opt->{'locationnum'} || $self->locationnum  ),
1333     %hash,
1334   };
1335
1336   $error = $cust_pkg->insert( 'change' => 1 );
1337   if ($error) {
1338     $dbh->rollback if $oldAutoCommit;
1339     return $error;
1340   }
1341
1342   # Transfer services and cancel old package.
1343
1344   $error = $self->transfer($cust_pkg);
1345   if ($error and $error == 0) {
1346     # $old_pkg->transfer failed.
1347     $dbh->rollback if $oldAutoCommit;
1348     return $error;
1349   }
1350
1351   if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
1352     warn "trying transfer again with change_svcpart option\n" if $DEBUG;
1353     $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
1354     if ($error and $error == 0) {
1355       # $old_pkg->transfer failed.
1356       $dbh->rollback if $oldAutoCommit;
1357       return $error;
1358     }
1359   }
1360
1361   if ($error > 0) {
1362     # Transfers were successful, but we still had services left on the old
1363     # package.  We can't change the package under this circumstances, so abort.
1364     $dbh->rollback if $oldAutoCommit;
1365     return "Unable to transfer all services from package ". $self->pkgnum;
1366   }
1367
1368   #reset usage if changing pkgpart
1369   # AND usage rollover is off (otherwise adds twice, now and at package bill)
1370   if ($self->pkgpart != $cust_pkg->pkgpart) {
1371     my $part_pkg = $cust_pkg->part_pkg;
1372     $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
1373                                                  ? ()
1374                                                  : ( 'null' => 1 )
1375                                    )
1376       if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
1377
1378     if ($error) {
1379       $dbh->rollback if $oldAutoCommit;
1380       return "Error setting usage values: $error";
1381     }
1382   }
1383
1384   #Good to go, cancel old package.  Notify 'cancel' of whether to credit
1385   #remaining time.
1386   $error = $self->cancel( quiet=>1, unused_credit => $unused_credit );
1387   if ($error) {
1388     $dbh->rollback if $oldAutoCommit;
1389     return $error;
1390   }
1391
1392   if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
1393     #$self->cust_main
1394     my $error = $cust_pkg->cust_main->bill( 'pkg_list' => [ $cust_pkg ] );
1395     if ( $error ) {
1396       $dbh->rollback if $oldAutoCommit;
1397       return $error;
1398     }
1399   }
1400
1401   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1402
1403   $cust_pkg;
1404
1405 }
1406
1407 use Data::Dumper;
1408 use Storable 'thaw';
1409 use MIME::Base64;
1410 sub process_bulk_cust_pkg {
1411   my $job = shift;
1412   my $param = thaw(decode_base64(shift));
1413   warn Dumper($param) if $DEBUG;
1414
1415   my $old_part_pkg = qsearchs('part_pkg',
1416                               { pkgpart => $param->{'old_pkgpart'} });
1417   my $new_part_pkg = qsearchs('part_pkg',
1418                               { pkgpart => $param->{'new_pkgpart'} });
1419   die "Must select a new package type\n" unless $new_part_pkg;
1420   #my $keep_dates = $param->{'keep_dates'} || 0;
1421   my $keep_dates = 1; # there is no good reason to turn this off
1422
1423   local $SIG{HUP} = 'IGNORE';
1424   local $SIG{INT} = 'IGNORE';
1425   local $SIG{QUIT} = 'IGNORE';
1426   local $SIG{TERM} = 'IGNORE';
1427   local $SIG{TSTP} = 'IGNORE';
1428   local $SIG{PIPE} = 'IGNORE';
1429
1430   my $oldAutoCommit = $FS::UID::AutoCommit;
1431   local $FS::UID::AutoCommit = 0;
1432   my $dbh = dbh;
1433
1434   my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
1435
1436   my $i = 0;
1437   foreach my $old_cust_pkg ( @cust_pkgs ) {
1438     $i++;
1439     $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
1440     if ( $old_cust_pkg->getfield('cancel') ) {
1441       warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
1442         $old_cust_pkg->pkgnum."\n"
1443         if $DEBUG;
1444       next;
1445     }
1446     warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
1447       if $DEBUG;
1448     my $error = $old_cust_pkg->change(
1449       'pkgpart'     => $param->{'new_pkgpart'},
1450       'keep_dates'  => $keep_dates
1451     );
1452     if ( !ref($error) ) { # change returns the cust_pkg on success
1453       $dbh->rollback;
1454       die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
1455     }
1456   }
1457   $dbh->commit if $oldAutoCommit;
1458   return;
1459 }
1460
1461 =item last_bill
1462
1463 Returns the last bill date, or if there is no last bill date, the setup date.
1464 Useful for billing metered services.
1465
1466 =cut
1467
1468 sub last_bill {
1469   my $self = shift;
1470   return $self->setfield('last_bill', $_[0]) if @_;
1471   return $self->getfield('last_bill') if $self->getfield('last_bill');
1472   my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
1473                                                   'edate'  => $self->bill,  } );
1474   $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
1475 }
1476
1477 =item last_cust_pkg_reason ACTION
1478
1479 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
1480 Returns false if there is no reason or the package is not currenly ACTION'd
1481 ACTION is one of adjourn, susp, cancel, or expire.
1482
1483 =cut
1484
1485 sub last_cust_pkg_reason {
1486   my ( $self, $action ) = ( shift, shift );
1487   my $date = $self->get($action);
1488   qsearchs( {
1489               'table' => 'cust_pkg_reason',
1490               'hashref' => { 'pkgnum' => $self->pkgnum,
1491                              'action' => substr(uc($action), 0, 1),
1492                              'date'   => $date,
1493                            },
1494               'order_by' => 'ORDER BY num DESC LIMIT 1',
1495            } );
1496 }
1497
1498 =item last_reason ACTION
1499
1500 Returns the most recent ACTION FS::reason associated with the package.
1501 Returns false if there is no reason or the package is not currenly ACTION'd
1502 ACTION is one of adjourn, susp, cancel, or expire.
1503
1504 =cut
1505
1506 sub last_reason {
1507   my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
1508   $cust_pkg_reason->reason
1509     if $cust_pkg_reason;
1510 }
1511
1512 =item part_pkg
1513
1514 Returns the definition for this billing item, as an FS::part_pkg object (see
1515 L<FS::part_pkg>).
1516
1517 =cut
1518
1519 sub part_pkg {
1520   my $self = shift;
1521   return $self->{'_pkgpart'} if $self->{'_pkgpart'};
1522   cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
1523   qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
1524 }
1525
1526 =item old_cust_pkg
1527
1528 Returns the cancelled package this package was changed from, if any.
1529
1530 =cut
1531
1532 sub old_cust_pkg {
1533   my $self = shift;
1534   return '' unless $self->change_pkgnum;
1535   qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
1536 }
1537
1538 =item calc_setup
1539
1540 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
1541 item.
1542
1543 =cut
1544
1545 sub calc_setup {
1546   my $self = shift;
1547   $self->part_pkg->calc_setup($self, @_);
1548 }
1549
1550 =item calc_recur
1551
1552 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
1553 item.
1554
1555 =cut
1556
1557 sub calc_recur {
1558   my $self = shift;
1559   $self->part_pkg->calc_recur($self, @_);
1560 }
1561
1562 =item base_recur
1563
1564 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
1565 item.
1566
1567 =cut
1568
1569 sub base_recur {
1570   my $self = shift;
1571   $self->part_pkg->base_recur($self, @_);
1572 }
1573
1574 =item calc_remain
1575
1576 Calls the I<calc_remain> of the FS::part_pkg object associated with this
1577 billing item.
1578
1579 =cut
1580
1581 sub calc_remain {
1582   my $self = shift;
1583   $self->part_pkg->calc_remain($self, @_);
1584 }
1585
1586 =item calc_cancel
1587
1588 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
1589 billing item.
1590
1591 =cut
1592
1593 sub calc_cancel {
1594   my $self = shift;
1595   $self->part_pkg->calc_cancel($self, @_);
1596 }
1597
1598 =item cust_bill_pkg
1599
1600 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
1601
1602 =cut
1603
1604 sub cust_bill_pkg {
1605   my $self = shift;
1606   qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
1607 }
1608
1609 =item cust_pkg_detail [ DETAILTYPE ]
1610
1611 Returns any customer package details for this package (see
1612 L<FS::cust_pkg_detail>).
1613
1614 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1615
1616 =cut
1617
1618 sub cust_pkg_detail {
1619   my $self = shift;
1620   my %hash = ( 'pkgnum' => $self->pkgnum );
1621   $hash{detailtype} = shift if @_;
1622   qsearch({
1623     'table'    => 'cust_pkg_detail',
1624     'hashref'  => \%hash,
1625     'order_by' => 'ORDER BY weight, pkgdetailnum',
1626   });
1627 }
1628
1629 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
1630
1631 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
1632
1633 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1634
1635 If there is an error, returns the error, otherwise returns false.
1636
1637 =cut
1638
1639 sub set_cust_pkg_detail {
1640   my( $self, $detailtype, @details ) = @_;
1641
1642   local $SIG{HUP} = 'IGNORE';
1643   local $SIG{INT} = 'IGNORE';
1644   local $SIG{QUIT} = 'IGNORE';
1645   local $SIG{TERM} = 'IGNORE';
1646   local $SIG{TSTP} = 'IGNORE';
1647   local $SIG{PIPE} = 'IGNORE';
1648
1649   my $oldAutoCommit = $FS::UID::AutoCommit;
1650   local $FS::UID::AutoCommit = 0;
1651   my $dbh = dbh;
1652
1653   foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
1654     my $error = $current->delete;
1655     if ( $error ) {
1656       $dbh->rollback if $oldAutoCommit;
1657       return "error removing old detail: $error";
1658     }
1659   }
1660
1661   foreach my $detail ( @details ) {
1662     my $cust_pkg_detail = new FS::cust_pkg_detail {
1663       'pkgnum'     => $self->pkgnum,
1664       'detailtype' => $detailtype,
1665       'detail'     => $detail,
1666     };
1667     my $error = $cust_pkg_detail->insert;
1668     if ( $error ) {
1669       $dbh->rollback if $oldAutoCommit;
1670       return "error adding new detail: $error";
1671     }
1672
1673   }
1674
1675   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1676   '';
1677
1678 }
1679
1680 =item cust_event
1681
1682 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
1683
1684 =cut
1685
1686 #false laziness w/cust_bill.pm
1687 sub cust_event {
1688   my $self = shift;
1689   qsearch({
1690     'table'     => 'cust_event',
1691     'addl_from' => 'JOIN part_event USING ( eventpart )',
1692     'hashref'   => { 'tablenum' => $self->pkgnum },
1693     'extra_sql' => " AND eventtable = 'cust_pkg' ",
1694   });
1695 }
1696
1697 =item num_cust_event
1698
1699 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
1700
1701 =cut
1702
1703 #false laziness w/cust_bill.pm
1704 sub num_cust_event {
1705   my $self = shift;
1706   my $sql =
1707     "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
1708     "  WHERE tablenum = ? AND eventtable = 'cust_pkg'";
1709   my $sth = dbh->prepare($sql) or die  dbh->errstr. " preparing $sql";
1710   $sth->execute($self->pkgnum) or die $sth->errstr. " executing $sql";
1711   $sth->fetchrow_arrayref->[0];
1712 }
1713
1714 =item cust_svc [ SVCPART ]
1715
1716 Returns the services for this package, as FS::cust_svc objects (see
1717 L<FS::cust_svc>).  If a svcpart is specified, return only the matching
1718 services.
1719
1720 =cut
1721
1722 sub cust_svc {
1723   my $self = shift;
1724
1725   return () unless $self->num_cust_svc(@_);
1726
1727   if ( @_ ) {
1728     return qsearch( 'cust_svc', { 'pkgnum'  => $self->pkgnum,
1729                                   'svcpart' => shift,          } );
1730   }
1731
1732   cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
1733
1734   #if ( $self->{'_svcnum'} ) {
1735   #  values %{ $self->{'_svcnum'}->cache };
1736   #} else {
1737     $self->_sort_cust_svc(
1738       [ qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } ) ]
1739     );
1740   #}
1741
1742 }
1743
1744 =item overlimit [ SVCPART ]
1745
1746 Returns the services for this package which have exceeded their
1747 usage limit as FS::cust_svc objects (see L<FS::cust_svc>).  If a svcpart
1748 is specified, return only the matching services.
1749
1750 =cut
1751
1752 sub overlimit {
1753   my $self = shift;
1754   return () unless $self->num_cust_svc(@_);
1755   grep { $_->overlimit } $self->cust_svc(@_);
1756 }
1757
1758 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
1759
1760 Returns historical services for this package created before END TIMESTAMP and
1761 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
1762 (see L<FS::h_cust_svc>).  If MODE is 'I' (for 'invoice'), services with the
1763 I<pkg_svc.hidden> flag will be omitted.
1764
1765 =cut
1766
1767 sub h_cust_svc {
1768   my $self = shift;
1769   my ($end, $start, $mode) = @_;
1770   my @cust_svc = $self->_sort_cust_svc(
1771     [ qsearch( 'h_cust_svc',
1772       { 'pkgnum' => $self->pkgnum, },
1773       FS::h_cust_svc->sql_h_search(@_),
1774     ) ]
1775   );
1776   if ( $mode eq 'I' ) {
1777     my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
1778     return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
1779   }
1780   else {
1781     return @cust_svc;
1782   }
1783 }
1784
1785 sub _sort_cust_svc {
1786   my( $self, $arrayref ) = @_;
1787
1788   my $sort =
1789     sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1]  or  $a->[2] <=> $b->[2] };
1790
1791   map  { $_->[0] }
1792   sort $sort
1793   map {
1794         my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $self->pkgpart,
1795                                              'svcpart' => $_->svcpart     } );
1796         [ $_,
1797           $pkg_svc ? $pkg_svc->primary_svc : '',
1798           $pkg_svc ? $pkg_svc->quantity : 0,
1799         ];
1800       }
1801   @$arrayref;
1802
1803 }
1804
1805 =item num_cust_svc [ SVCPART ]
1806
1807 Returns the number of provisioned services for this package.  If a svcpart is
1808 specified, counts only the matching services.
1809
1810 =cut
1811
1812 sub num_cust_svc {
1813   my $self = shift;
1814
1815   return $self->{'_num_cust_svc'}
1816     if !scalar(@_)
1817        && exists($self->{'_num_cust_svc'})
1818        && $self->{'_num_cust_svc'} =~ /\d/;
1819
1820   cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
1821     if $DEBUG > 2;
1822
1823   my $sql = 'SELECT COUNT(*) FROM cust_svc WHERE pkgnum = ?';
1824   $sql .= ' AND svcpart = ?' if @_;
1825
1826   my $sth = dbh->prepare($sql)     or die  dbh->errstr;
1827   $sth->execute($self->pkgnum, @_) or die $sth->errstr;
1828   $sth->fetchrow_arrayref->[0];
1829 }
1830
1831 =item available_part_svc
1832
1833 Returns a list of FS::part_svc objects representing services included in this
1834 package but not yet provisioned.  Each FS::part_svc object also has an extra
1835 field, I<num_avail>, which specifies the number of available services.
1836
1837 =cut
1838
1839 sub available_part_svc {
1840   my $self = shift;
1841   grep { $_->num_avail > 0 }
1842     map {
1843           my $part_svc = $_->part_svc;
1844           $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
1845             $_->quantity - $self->num_cust_svc($_->svcpart);
1846
1847           # more evil encapsulation breakage
1848           if($part_svc->{'Hash'}{'num_avail'} > 0) {
1849             my @exports = $part_svc->part_export_did;
1850             $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
1851           }
1852
1853           $part_svc;
1854         }
1855       $self->part_pkg->pkg_svc;
1856 }
1857
1858 =item part_svc
1859
1860 Returns a list of FS::part_svc objects representing provisioned and available
1861 services included in this package.  Each FS::part_svc object also has the
1862 following extra fields:
1863
1864 =over 4
1865
1866 =item num_cust_svc  (count)
1867
1868 =item num_avail     (quantity - count)
1869
1870 =item cust_pkg_svc (services) - array reference containing the provisioned services, as cust_svc objects
1871
1872 svcnum
1873 label -> ($cust_svc->label)[1]
1874
1875 =back
1876
1877 =cut
1878
1879 sub part_svc {
1880   my $self = shift;
1881
1882   #XXX some sort of sort order besides numeric by svcpart...
1883   my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
1884     my $pkg_svc = $_;
1885     my $part_svc = $pkg_svc->part_svc;
1886     my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
1887     $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
1888     $part_svc->{'Hash'}{'num_avail'}    =
1889       max( 0, $pkg_svc->quantity - $num_cust_svc );
1890     $part_svc->{'Hash'}{'cust_pkg_svc'} =
1891       $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
1892     $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
1893     $part_svc;
1894   } $self->part_pkg->pkg_svc;
1895
1896   #extras
1897   push @part_svc, map {
1898     my $part_svc = $_;
1899     my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
1900     $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
1901     $part_svc->{'Hash'}{'num_avail'}    = 0; #0-$num_cust_svc ?
1902     $part_svc->{'Hash'}{'cust_pkg_svc'} =
1903       $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
1904     $part_svc;
1905   } $self->extra_part_svc;
1906
1907   @part_svc;
1908
1909 }
1910
1911 =item extra_part_svc
1912
1913 Returns a list of FS::part_svc objects corresponding to services in this
1914 package which are still provisioned but not (any longer) available in the
1915 package definition.
1916
1917 =cut
1918
1919 sub extra_part_svc {
1920   my $self = shift;
1921
1922   my $pkgnum  = $self->pkgnum;
1923   my $pkgpart = $self->pkgpart;
1924
1925 #  qsearch( {
1926 #    'table'     => 'part_svc',
1927 #    'hashref'   => {},
1928 #    'extra_sql' =>
1929 #      "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
1930 #                     WHERE pkg_svc.svcpart = part_svc.svcpart
1931 #                       AND pkg_svc.pkgpart = ?
1932 #                       AND quantity > 0
1933 #                 )
1934 #        AND 0 < ( SELECT COUNT(*) FROM cust_svc
1935 #                       LEFT JOIN cust_pkg USING ( pkgnum )
1936 #                     WHERE cust_svc.svcpart = part_svc.svcpart
1937 #                       AND pkgnum = ?
1938 #                 )",
1939 #    'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
1940 #  } );
1941
1942 #seems to benchmark slightly faster...
1943   qsearch( {
1944     #'select'      => 'DISTINCT ON (svcpart) part_svc.*',
1945     #MySQL doesn't grok DISINCT ON
1946     'select'      => 'DISTINCT part_svc.*',
1947     'table'       => 'part_svc',
1948     'addl_from'   =>
1949       'LEFT JOIN pkg_svc  ON (     pkg_svc.svcpart   = part_svc.svcpart
1950                                AND pkg_svc.pkgpart   = ?
1951                                AND quantity > 0
1952                              )
1953        LEFT JOIN cust_svc ON (     cust_svc.svcpart = part_svc.svcpart )
1954        LEFT JOIN cust_pkg USING ( pkgnum )
1955       ',
1956     'hashref'     => {},
1957     'extra_sql'   => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
1958     'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
1959   } );
1960 }
1961
1962 =item status
1963
1964 Returns a short status string for this package, currently:
1965
1966 =over 4
1967
1968 =item not yet billed
1969
1970 =item one-time charge
1971
1972 =item active
1973
1974 =item suspended
1975
1976 =item cancelled
1977
1978 =back
1979
1980 =cut
1981
1982 sub status {
1983   my $self = shift;
1984
1985   my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
1986
1987   return 'cancelled' if $self->get('cancel');
1988   return 'suspended' if $self->susp;
1989   return 'not yet billed' unless $self->setup;
1990   return 'one-time charge' if $freq =~ /^(0|$)/;
1991   return 'active';
1992 }
1993
1994 =item ucfirst_status
1995
1996 Returns the status with the first character capitalized.
1997
1998 =cut
1999
2000 sub ucfirst_status {
2001   ucfirst(shift->status);
2002 }
2003
2004 =item statuses
2005
2006 Class method that returns the list of possible status strings for packages
2007 (see L<the status method|/status>).  For example:
2008
2009   @statuses = FS::cust_pkg->statuses();
2010
2011 =cut
2012
2013 tie my %statuscolor, 'Tie::IxHash',
2014   'not yet billed'  => '009999', #teal? cyan?
2015   'one-time charge' => '000000',
2016   'active'          => '00CC00',
2017   'suspended'       => 'FF9900',
2018   'cancelled'       => 'FF0000',
2019 ;
2020
2021 sub statuses {
2022   my $self = shift; #could be class...
2023   #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
2024   #                                    # mayble split btw one-time vs. recur
2025     keys %statuscolor;
2026 }
2027
2028 =item statuscolor
2029
2030 Returns a hex triplet color string for this package's status.
2031
2032 =cut
2033
2034 sub statuscolor {
2035   my $self = shift;
2036   $statuscolor{$self->status};
2037 }
2038
2039 =item pkg_label
2040
2041 Returns a label for this package.  (Currently "pkgnum: pkg - comment" or
2042 "pkg-comment" depending on user preference).
2043
2044 =cut
2045
2046 sub pkg_label {
2047   my $self = shift;
2048   my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
2049   $label = $self->pkgnum. ": $label"
2050     if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
2051   $label;
2052 }
2053
2054 =item pkg_label_long
2055
2056 Returns a long label for this package, adding the primary service's label to
2057 pkg_label.
2058
2059 =cut
2060
2061 sub pkg_label_long {
2062   my $self = shift;
2063   my $label = $self->pkg_label;
2064   my $cust_svc = $self->primary_cust_svc;
2065   $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
2066   $label;
2067 }
2068
2069 =item primary_cust_svc
2070
2071 Returns a primary service (as FS::cust_svc object) if one can be identified.
2072
2073 =cut
2074
2075 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
2076
2077 sub primary_cust_svc {
2078   my $self = shift;
2079
2080   my @cust_svc = $self->cust_svc;
2081
2082   return '' unless @cust_svc; #no serivces - irrelevant then
2083
2084   return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
2085
2086   # primary service as specified in the package definition
2087   # or exactly one service definition with quantity one
2088   my $svcpart = $self->part_pkg->svcpart;
2089   @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
2090   return $cust_svc[0] if scalar(@cust_svc) == 1;
2091
2092   #couldn't identify one thing..
2093   return '';
2094 }
2095
2096 =item labels
2097
2098 Returns a list of lists, calling the label method for all services
2099 (see L<FS::cust_svc>) of this billing item.
2100
2101 =cut
2102
2103 sub labels {
2104   my $self = shift;
2105   map { [ $_->label ] } $self->cust_svc;
2106 }
2107
2108 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2109
2110 Like the labels method, but returns historical information on services that
2111 were active as of END_TIMESTAMP and (optionally) not cancelled before
2112 START_TIMESTAMP.  If MODE is 'I' (for 'invoice'), services with the
2113 I<pkg_svc.hidden> flag will be omitted.
2114
2115 Returns a list of lists, calling the label method for all (historical) services
2116 (see L<FS::h_cust_svc>) of this billing item.
2117
2118 =cut
2119
2120 sub h_labels {
2121   my $self = shift;
2122   map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
2123 }
2124
2125 =item labels_short
2126
2127 Like labels, except returns a simple flat list, and shortens long
2128 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2129 identical services to one line that lists the service label and the number of
2130 individual services rather than individual items.
2131
2132 =cut
2133
2134 sub labels_short {
2135   shift->_labels_short( 'labels', @_ );
2136 }
2137
2138 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
2139
2140 Like h_labels, except returns a simple flat list, and shortens long
2141 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2142 identical services to one line that lists the service label and the number of
2143 individual services rather than individual items.
2144
2145 =cut
2146
2147 sub h_labels_short {
2148   shift->_labels_short( 'h_labels', @_ );
2149 }
2150
2151 sub _labels_short {
2152   my( $self, $method ) = ( shift, shift );
2153
2154   my $conf = new FS::Conf;
2155   my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
2156
2157   my %labels;
2158   #tie %labels, 'Tie::IxHash';
2159   push @{ $labels{$_->[0]} }, $_->[1]
2160     foreach $self->$method(@_);
2161   my @labels;
2162   foreach my $label ( keys %labels ) {
2163     my %seen = ();
2164     my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
2165     my $num = scalar(@values);
2166     if ( $num > $max_same_services ) {
2167       push @labels, "$label ($num)";
2168     } else {
2169       if ( $conf->exists('cust_bill-consolidate_services') ) {
2170         # push @labels, "$label: ". join(', ', @values);
2171         while ( @values ) {
2172           my $detail = "$label: ";
2173           $detail .= shift(@values). ', '
2174             while @values && length($detail.$values[0]) < 78;
2175           $detail =~ s/, $//;
2176           push @labels, $detail;
2177         }
2178       } else {
2179         push @labels, map { "$label: $_" } @values;
2180       }
2181     }
2182   }
2183
2184  @labels;
2185
2186 }
2187
2188 =item cust_main
2189
2190 Returns the parent customer object (see L<FS::cust_main>).
2191
2192 =cut
2193
2194 sub cust_main {
2195   my $self = shift;
2196   qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
2197 }
2198
2199 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
2200
2201 =item cust_location
2202
2203 Returns the location object, if any (see L<FS::cust_location>).
2204
2205 =item cust_location_or_main
2206
2207 If this package is associated with a location, returns the locaiton (see
2208 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
2209
2210 =item location_label [ OPTION => VALUE ... ]
2211
2212 Returns the label of the location object (see L<FS::cust_location>).
2213
2214 =cut
2215
2216 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
2217
2218 =item seconds_since TIMESTAMP
2219
2220 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
2221 package have been online since TIMESTAMP, according to the session monitor.
2222
2223 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
2224 L<Time::Local> and L<Date::Parse> for conversion functions.
2225
2226 =cut
2227
2228 sub seconds_since {
2229   my($self, $since) = @_;
2230   my $seconds = 0;
2231
2232   foreach my $cust_svc (
2233     grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
2234   ) {
2235     $seconds += $cust_svc->seconds_since($since);
2236   }
2237
2238   $seconds;
2239
2240 }
2241
2242 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
2243
2244 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
2245 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
2246 (exclusive).
2247
2248 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2249 L<perlfunc/"time">.  Also see L<Time::Local> and L<Date::Parse> for conversion
2250 functions.
2251
2252
2253 =cut
2254
2255 sub seconds_since_sqlradacct {
2256   my($self, $start, $end) = @_;
2257
2258   my $seconds = 0;
2259
2260   foreach my $cust_svc (
2261     grep {
2262       my $part_svc = $_->part_svc;
2263       $part_svc->svcdb eq 'svc_acct'
2264         && scalar($part_svc->part_export('sqlradius'));
2265     } $self->cust_svc
2266   ) {
2267     $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
2268   }
2269
2270   $seconds;
2271
2272 }
2273
2274 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
2275
2276 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
2277 in this package for sessions ending between TIMESTAMP_START (inclusive) and
2278 TIMESTAMP_END
2279 (exclusive).
2280
2281 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2282 L<perlfunc/"time">.  Also see L<Time::Local> and L<Date::Parse> for conversion
2283 functions.
2284
2285 =cut
2286
2287 sub attribute_since_sqlradacct {
2288   my($self, $start, $end, $attrib) = @_;
2289
2290   my $sum = 0;
2291
2292   foreach my $cust_svc (
2293     grep {
2294       my $part_svc = $_->part_svc;
2295       $part_svc->svcdb eq 'svc_acct'
2296         && scalar($part_svc->part_export('sqlradius'));
2297     } $self->cust_svc
2298   ) {
2299     $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
2300   }
2301
2302   $sum;
2303
2304 }
2305
2306 =item quantity
2307
2308 =cut
2309
2310 sub quantity {
2311   my( $self, $value ) = @_;
2312   if ( defined($value) ) {
2313     $self->setfield('quantity', $value);
2314   }
2315   $self->getfield('quantity') || 1;
2316 }
2317
2318 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
2319
2320 Transfers as many services as possible from this package to another package.
2321
2322 The destination package can be specified by pkgnum by passing an FS::cust_pkg
2323 object.  The destination package must already exist.
2324
2325 Services are moved only if the destination allows services with the correct
2326 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true.  Use
2327 this option with caution!  No provision is made for export differences
2328 between the old and new service definitions.  Probably only should be used
2329 when your exports for all service definitions of a given svcdb are identical.
2330 (attempt a transfer without it first, to move all possible svcpart-matching
2331 services)
2332
2333 Any services that can't be moved remain in the original package.
2334
2335 Returns an error, if there is one; otherwise, returns the number of services
2336 that couldn't be moved.
2337
2338 =cut
2339
2340 sub transfer {
2341   my ($self, $dest_pkgnum, %opt) = @_;
2342
2343   my $remaining = 0;
2344   my $dest;
2345   my %target;
2346
2347   if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
2348     $dest = $dest_pkgnum;
2349     $dest_pkgnum = $dest->pkgnum;
2350   } else {
2351     $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
2352   }
2353
2354   return ('Package does not exist: '.$dest_pkgnum) unless $dest;
2355
2356   foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
2357     $target{$pkg_svc->svcpart} = $pkg_svc->quantity;
2358   }
2359
2360   foreach my $cust_svc ($dest->cust_svc) {
2361     $target{$cust_svc->svcpart}--;
2362   }
2363
2364   my %svcpart2svcparts = ();
2365   if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2366     warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
2367     foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
2368       next if exists $svcpart2svcparts{$svcpart};
2369       my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
2370       $svcpart2svcparts{$svcpart} = [
2371         map  { $_->[0] }
2372         sort { $b->[1] cmp $a->[1]  or  $a->[2] <=> $b->[2] }
2373         map {
2374               my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
2375                                                    'svcpart' => $_          } );
2376               [ $_,
2377                 $pkg_svc ? $pkg_svc->primary_svc : '',
2378                 $pkg_svc ? $pkg_svc->quantity : 0,
2379               ];
2380             }
2381
2382         grep { $_ != $svcpart }
2383         map  { $_->svcpart }
2384         qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
2385       ];
2386       warn "alternates for svcpart $svcpart: ".
2387            join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
2388         if $DEBUG;
2389     }
2390   }
2391
2392   foreach my $cust_svc ($self->cust_svc) {
2393     if($target{$cust_svc->svcpart} > 0) {
2394       $target{$cust_svc->svcpart}--;
2395       my $new = new FS::cust_svc { $cust_svc->hash };
2396       $new->pkgnum($dest_pkgnum);
2397       my $error = $new->replace($cust_svc);
2398       return $error if $error;
2399     } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2400       if ( $DEBUG ) {
2401         warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
2402         warn "alternates to consider: ".
2403              join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
2404       }
2405       my @alternate = grep {
2406                              warn "considering alternate svcpart $_: ".
2407                                   "$target{$_} available in new package\n"
2408                                if $DEBUG;
2409                              $target{$_} > 0;
2410                            } @{$svcpart2svcparts{$cust_svc->svcpart}};
2411       if ( @alternate ) {
2412         warn "alternate(s) found\n" if $DEBUG;
2413         my $change_svcpart = $alternate[0];
2414         $target{$change_svcpart}--;
2415         my $new = new FS::cust_svc { $cust_svc->hash };
2416         $new->svcpart($change_svcpart);
2417         $new->pkgnum($dest_pkgnum);
2418         my $error = $new->replace($cust_svc);
2419         return $error if $error;
2420       } else {
2421         $remaining++;
2422       }
2423     } else {
2424       $remaining++
2425     }
2426   }
2427   return $remaining;
2428 }
2429
2430 =item reexport
2431
2432 This method is deprecated.  See the I<depend_jobnum> option to the insert and
2433 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
2434
2435 =cut
2436
2437 sub reexport {
2438   my $self = shift;
2439
2440   local $SIG{HUP} = 'IGNORE';
2441   local $SIG{INT} = 'IGNORE';
2442   local $SIG{QUIT} = 'IGNORE';
2443   local $SIG{TERM} = 'IGNORE';
2444   local $SIG{TSTP} = 'IGNORE';
2445   local $SIG{PIPE} = 'IGNORE';
2446
2447   my $oldAutoCommit = $FS::UID::AutoCommit;
2448   local $FS::UID::AutoCommit = 0;
2449   my $dbh = dbh;
2450
2451   foreach my $cust_svc ( $self->cust_svc ) {
2452     #false laziness w/svc_Common::insert
2453     my $svc_x = $cust_svc->svc_x;
2454     foreach my $part_export ( $cust_svc->part_svc->part_export ) {
2455       my $error = $part_export->export_insert($svc_x);
2456       if ( $error ) {
2457         $dbh->rollback if $oldAutoCommit;
2458         return $error;
2459       }
2460     }
2461   }
2462
2463   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2464   '';
2465
2466 }
2467
2468 =item insert_reason
2469
2470 Associates this package with a (suspension or cancellation) reason (see
2471 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
2472 L<FS::reason>).
2473
2474 Available options are:
2475
2476 =over 4
2477
2478 =item reason
2479
2480 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.
2481
2482 =item reason_otaker
2483
2484 the access_user (see L<FS::access_user>) providing the reason
2485
2486 =item date
2487
2488 a unix timestamp
2489
2490 =item action
2491
2492 the action (cancel, susp, adjourn, expire) associated with the reason
2493
2494 =back
2495
2496 If there is an error, returns the error, otherwise returns false.
2497
2498 =cut
2499
2500 sub insert_reason {
2501   my ($self, %options) = @_;
2502
2503   my $otaker = $options{reason_otaker} ||
2504                $FS::CurrentUser::CurrentUser->username;
2505
2506   my $reasonnum;
2507   if ( $options{'reason'} =~ /^(\d+)$/ ) {
2508
2509     $reasonnum = $1;
2510
2511   } elsif ( ref($options{'reason'}) ) {
2512
2513     return 'Enter a new reason (or select an existing one)'
2514       unless $options{'reason'}->{'reason'} !~ /^\s*$/;
2515
2516     my $reason = new FS::reason({
2517       'reason_type' => $options{'reason'}->{'typenum'},
2518       'reason'      => $options{'reason'}->{'reason'},
2519     });
2520     my $error = $reason->insert;
2521     return $error if $error;
2522
2523     $reasonnum = $reason->reasonnum;
2524
2525   } else {
2526     return "Unparsable reason: ". $options{'reason'};
2527   }
2528
2529   my $cust_pkg_reason =
2530     new FS::cust_pkg_reason({ 'pkgnum'    => $self->pkgnum,
2531                               'reasonnum' => $reasonnum,
2532                               'otaker'    => $otaker,
2533                               'action'    => substr(uc($options{'action'}),0,1),
2534                               'date'      => $options{'date'}
2535                                                ? $options{'date'}
2536                                                : time,
2537                             });
2538
2539   $cust_pkg_reason->insert;
2540 }
2541
2542 =item insert_discount
2543
2544 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
2545 inserting a new discount on the fly (see L<FS::discount>).
2546
2547 Available options are:
2548
2549 =over 4
2550
2551 =item discountnum
2552
2553 =back
2554
2555 If there is an error, returns the error, otherwise returns false.
2556
2557 =cut
2558
2559 sub insert_discount {
2560   #my ($self, %options) = @_;
2561   my $self = shift;
2562
2563   my $cust_pkg_discount = new FS::cust_pkg_discount {
2564     'pkgnum'      => $self->pkgnum,
2565     'discountnum' => $self->discountnum,
2566     'months_used' => 0,
2567     'end_date'    => '', #XXX
2568     #for the create a new discount case
2569     '_type'       => $self->discountnum__type,
2570     'amount'      => $self->discountnum_amount,
2571     'percent'     => $self->discountnum_percent,
2572     'months'      => $self->discountnum_months,
2573     #'disabled'    => $self->discountnum_disabled,
2574   };
2575
2576   $cust_pkg_discount->insert;
2577 }
2578
2579 =item set_usage USAGE_VALUE_HASHREF
2580
2581 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2582 to which they should be set (see L<FS::svc_acct>).  Currently seconds,
2583 upbytes, downbytes, and totalbytes are appropriate keys.
2584
2585 All svc_accts which are part of this package have their values reset.
2586
2587 =cut
2588
2589 sub set_usage {
2590   my ($self, $valueref, %opt) = @_;
2591
2592   foreach my $cust_svc ($self->cust_svc){
2593     my $svc_x = $cust_svc->svc_x;
2594     $svc_x->set_usage($valueref, %opt)
2595       if $svc_x->can("set_usage");
2596   }
2597 }
2598
2599 =item recharge USAGE_VALUE_HASHREF
2600
2601 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2602 to which they should be set (see L<FS::svc_acct>).  Currently seconds,
2603 upbytes, downbytes, and totalbytes are appropriate keys.
2604
2605 All svc_accts which are part of this package have their values incremented.
2606
2607 =cut
2608
2609 sub recharge {
2610   my ($self, $valueref) = @_;
2611
2612   foreach my $cust_svc ($self->cust_svc){
2613     my $svc_x = $cust_svc->svc_x;
2614     $svc_x->recharge($valueref)
2615       if $svc_x->can("recharge");
2616   }
2617 }
2618
2619 =item cust_pkg_discount
2620
2621 =cut
2622
2623 sub cust_pkg_discount {
2624   my $self = shift;
2625   qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
2626 }
2627
2628 =item cust_pkg_discount_active
2629
2630 =cut
2631
2632 sub cust_pkg_discount_active {
2633   my $self = shift;
2634   grep { $_->status eq 'active' } $self->cust_pkg_discount;
2635 }
2636
2637 =back
2638
2639 =head1 CLASS METHODS
2640
2641 =over 4
2642
2643 =item recurring_sql
2644
2645 Returns an SQL expression identifying recurring packages.
2646
2647 =cut
2648
2649 sub recurring_sql { "
2650   '0' != ( select freq from part_pkg
2651              where cust_pkg.pkgpart = part_pkg.pkgpart )
2652 "; }
2653
2654 =item onetime_sql
2655
2656 Returns an SQL expression identifying one-time packages.
2657
2658 =cut
2659
2660 sub onetime_sql { "
2661   '0' = ( select freq from part_pkg
2662             where cust_pkg.pkgpart = part_pkg.pkgpart )
2663 "; }
2664
2665 =item ordered_sql
2666
2667 Returns an SQL expression identifying ordered packages (recurring packages not
2668 yet billed).
2669
2670 =cut
2671
2672 sub ordered_sql {
2673    $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
2674 }
2675
2676 =item active_sql
2677
2678 Returns an SQL expression identifying active packages.
2679
2680 =cut
2681
2682 sub active_sql {
2683   $_[0]->recurring_sql. "
2684   AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
2685   AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2686   AND ( cust_pkg.susp   IS NULL OR cust_pkg.susp   = 0 )
2687 "; }
2688
2689 =item not_yet_billed_sql
2690
2691 Returns an SQL expression identifying packages which have not yet been billed.
2692
2693 =cut
2694
2695 sub not_yet_billed_sql { "
2696       ( cust_pkg.setup  IS NULL OR cust_pkg.setup  = 0 )
2697   AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2698   AND ( cust_pkg.susp   IS NULL OR cust_pkg.susp   = 0 )
2699 "; }
2700
2701 =item inactive_sql
2702
2703 Returns an SQL expression identifying inactive packages (one-time packages
2704 that are otherwise unsuspended/uncancelled).
2705
2706 =cut
2707
2708 sub inactive_sql { "
2709   ". $_[0]->onetime_sql(). "
2710   AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
2711   AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2712   AND ( cust_pkg.susp   IS NULL OR cust_pkg.susp   = 0 )
2713 "; }
2714
2715 =item susp_sql
2716 =item suspended_sql
2717
2718 Returns an SQL expression identifying suspended packages.
2719
2720 =cut
2721
2722 sub suspended_sql { susp_sql(@_); }
2723 sub susp_sql {
2724   #$_[0]->recurring_sql(). ' AND '.
2725   "
2726         ( cust_pkg.cancel IS     NULL  OR cust_pkg.cancel = 0 )
2727     AND   cust_pkg.susp   IS NOT NULL AND cust_pkg.susp  != 0
2728   ";
2729 }
2730
2731 =item cancel_sql
2732 =item cancelled_sql
2733
2734 Returns an SQL exprression identifying cancelled packages.
2735
2736 =cut
2737
2738 sub cancelled_sql { cancel_sql(@_); }
2739 sub cancel_sql {
2740   #$_[0]->recurring_sql(). ' AND '.
2741   "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
2742 }
2743
2744 =item status_sql
2745
2746 Returns an SQL expression to give the package status as a string.
2747
2748 =cut
2749
2750 sub status_sql {
2751 "CASE
2752   WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
2753   WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
2754   WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
2755   WHEN ".onetime_sql()." THEN 'one-time charge'
2756   ELSE 'active'
2757 END"
2758 }
2759
2760 =item search HASHREF
2761
2762 (Class method)
2763
2764 Returns a qsearch hash expression to search for parameters specified in HASHREF.
2765 Valid parameters are
2766
2767 =over 4
2768
2769 =item agentnum
2770
2771 =item magic
2772
2773 active, inactive, suspended, cancel (or cancelled)
2774
2775 =item status
2776
2777 active, inactive, suspended, one-time charge, inactive, cancel (or cancelled)
2778
2779 =item custom
2780
2781  boolean selects custom packages
2782
2783 =item classnum
2784
2785 =item pkgpart
2786
2787 pkgpart or arrayref or hashref of pkgparts
2788
2789 =item setup
2790
2791 arrayref of beginning and ending epoch date
2792
2793 =item last_bill
2794
2795 arrayref of beginning and ending epoch date
2796
2797 =item bill
2798
2799 arrayref of beginning and ending epoch date
2800
2801 =item adjourn
2802
2803 arrayref of beginning and ending epoch date
2804
2805 =item susp
2806
2807 arrayref of beginning and ending epoch date
2808
2809 =item expire
2810
2811 arrayref of beginning and ending epoch date
2812
2813 =item cancel
2814
2815 arrayref of beginning and ending epoch date
2816
2817 =item query
2818
2819 pkgnum or APKG_pkgnum
2820
2821 =item cust_fields
2822
2823 a value suited to passing to FS::UI::Web::cust_header
2824
2825 =item CurrentUser
2826
2827 specifies the user for agent virtualization
2828
2829 =item fcc_line
2830
2831  boolean selects packages containing fcc form 477 telco lines
2832
2833 =back
2834
2835 =cut
2836
2837 sub search {
2838   my ($class, $params) = @_;
2839   my @where = ();
2840
2841   ##
2842   # parse agent
2843   ##
2844
2845   if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
2846     push @where,
2847       "cust_main.agentnum = $1";
2848   }
2849
2850   ##
2851   # parse custnum
2852   ##
2853
2854   if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
2855     push @where,
2856       "cust_pkg.custnum = $1";
2857   }
2858
2859   ##
2860   # custbatch
2861   ##
2862
2863   if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
2864     push @where,
2865       "cust_pkg.pkgbatch = '$1'";
2866   }
2867
2868   ##
2869   # parse status
2870   ##
2871
2872   if (    $params->{'magic'}  eq 'active'
2873        || $params->{'status'} eq 'active' ) {
2874
2875     push @where, FS::cust_pkg->active_sql();
2876
2877   } elsif (    $params->{'magic'}  =~ /^not[ _]yet[ _]billed$/
2878             || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
2879
2880     push @where, FS::cust_pkg->not_yet_billed_sql();
2881
2882   } elsif (    $params->{'magic'}  =~ /^(one-time charge|inactive)/
2883             || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
2884
2885     push @where, FS::cust_pkg->inactive_sql();
2886
2887   } elsif (    $params->{'magic'}  eq 'suspended'
2888             || $params->{'status'} eq 'suspended'  ) {
2889
2890     push @where, FS::cust_pkg->suspended_sql();
2891
2892   } elsif (    $params->{'magic'}  =~ /^cancell?ed$/
2893             || $params->{'status'} =~ /^cancell?ed$/ ) {
2894
2895     push @where, FS::cust_pkg->cancelled_sql();
2896
2897   }
2898
2899   ###
2900   # parse package class
2901   ###
2902
2903   #false lazinessish w/graph/cust_bill_pkg.cgi
2904   my $classnum = 0;
2905   my @pkg_class = ();
2906   if ( exists($params->{'classnum'})
2907        && $params->{'classnum'} =~ /^(\d*)$/
2908      )
2909   {
2910     $classnum = $1;
2911     if ( $classnum ) { #a specific class
2912       push @where, "part_pkg.classnum = $classnum";
2913
2914       #@pkg_class = ( qsearchs('pkg_class', { 'classnum' => $classnum } ) );
2915       #die "classnum $classnum not found!" unless $pkg_class[0];
2916       #$title .= $pkg_class[0]->classname.' ';
2917
2918     } elsif ( $classnum eq '' ) { #the empty class
2919
2920       push @where, "part_pkg.classnum IS NULL";
2921       #$title .= 'Empty class ';
2922       #@pkg_class = ( '(empty class)' );
2923     } elsif ( $classnum eq '0' ) {
2924       #@pkg_class = qsearch('pkg_class', {} ); # { 'disabled' => '' } );
2925       #push @pkg_class, '(empty class)';
2926     } else {
2927       die "illegal classnum";
2928     }
2929   }
2930   #eslaf
2931
2932   ###
2933   # parse package report options
2934   ###
2935
2936   my @report_option = ();
2937   if ( exists($params->{'report_option'})
2938        && $params->{'report_option'} =~ /^([,\d]*)$/
2939      )
2940   {
2941     @report_option = split(',', $1);
2942   }
2943
2944   if (@report_option) {
2945     # this will result in the empty set for the dangling comma case as it should
2946     push @where,
2947       map{ "0 < ( SELECT count(*) FROM part_pkg_option
2948                     WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
2949                     AND optionname = 'report_option_$_'
2950                     AND optionvalue = '1' )"
2951          } @report_option;
2952   }
2953
2954   #eslaf
2955
2956   ###
2957   # parse custom
2958   ###
2959
2960   push @where,  "part_pkg.custom = 'Y'" if $params->{custom};
2961
2962   ###
2963   # parse fcc_line
2964   ###
2965
2966   push @where,  "part_pkg.fcc_ds0s > 0" if $params->{fcc_line};
2967
2968   ###
2969   # parse censustract
2970   ###
2971
2972   if ( exists($params->{'censustract'}) ) {
2973     $params->{'censustract'} =~ /^([.\d]*)$/;
2974     my $censustract = "cust_main.censustract = '$1'";
2975     $censustract .= ' OR cust_main.censustract is NULL' unless $1;
2976     push @where,  "( $censustract )";
2977   }
2978
2979   ###
2980   # parse part_pkg
2981   ###
2982
2983   if ( ref($params->{'pkgpart'}) ) {
2984
2985     my @pkgpart = ();
2986     if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
2987       @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
2988     } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
2989       @pkgpart = @{ $params->{'pkgpart'} };
2990     } else {
2991       die 'unhandled pkgpart ref '. $params->{'pkgpart'};
2992     }
2993
2994     @pkgpart = grep /^(\d+)$/, @pkgpart;
2995
2996     push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
2997
2998   } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
2999     push @where, "pkgpart = $1";
3000   }
3001
3002   ###
3003   # parse dates
3004   ###
3005
3006   my $orderby = '';
3007
3008   #false laziness w/report_cust_pkg.html
3009   my %disable = (
3010     'all'             => {},
3011     'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
3012     'active'          => { 'susp'=>1, 'cancel'=>1 },
3013     'suspended'       => { 'cancel' => 1 },
3014     'cancelled'       => {},
3015     ''                => {},
3016   );
3017
3018   if( exists($params->{'active'} ) ) {
3019     # This overrides all the other date-related fields
3020     my($beginning, $ending) = @{$params->{'active'}};
3021     push @where,
3022       "cust_pkg.setup IS NOT NULL",
3023       "cust_pkg.setup <= $ending",
3024       "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
3025       "NOT (".FS::cust_pkg->onetime_sql . ")";
3026   }
3027   else {
3028     foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end cancel )) {
3029
3030       next unless exists($params->{$field});
3031
3032       my($beginning, $ending) = @{$params->{$field}};
3033
3034       next if $beginning == 0 && $ending == 4294967295;
3035
3036       push @where,
3037         "cust_pkg.$field IS NOT NULL",
3038         "cust_pkg.$field >= $beginning",
3039         "cust_pkg.$field <= $ending";
3040
3041       $orderby ||= "ORDER BY cust_pkg.$field";
3042
3043     }
3044   }
3045
3046   $orderby ||= 'ORDER BY bill';
3047
3048   ###
3049   # parse magic, legacy, etc.
3050   ###
3051
3052   if ( $params->{'magic'} &&
3053        $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
3054   ) {
3055
3056     $orderby = 'ORDER BY pkgnum';
3057
3058     if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
3059       push @where, "pkgpart = $1";
3060     }
3061
3062   } elsif ( $params->{'query'} eq 'pkgnum' ) {
3063
3064     $orderby = 'ORDER BY pkgnum';
3065
3066   } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
3067
3068     $orderby = 'ORDER BY pkgnum';
3069
3070     push @where, '0 < (
3071       SELECT count(*) FROM pkg_svc
3072        WHERE pkg_svc.pkgpart =  cust_pkg.pkgpart
3073          AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
3074                                    WHERE cust_svc.pkgnum  = cust_pkg.pkgnum
3075                                      AND cust_svc.svcpart = pkg_svc.svcpart
3076                                 )
3077     )';
3078
3079   }
3080
3081   ##
3082   # setup queries, links, subs, etc. for the search
3083   ##
3084
3085   # here is the agent virtualization
3086   if ($params->{CurrentUser}) {
3087     my $access_user =
3088       qsearchs('access_user', { username => $params->{CurrentUser} });
3089
3090     if ($access_user) {
3091       push @where, $access_user->agentnums_sql('table'=>'cust_main');
3092     } else {
3093       push @where, "1=0";
3094     }
3095   } else {
3096     push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
3097   }
3098
3099   my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
3100
3101   my $addl_from = 'LEFT JOIN cust_main USING ( custnum  ) '.
3102                   'LEFT JOIN part_pkg  USING ( pkgpart  ) '.
3103                   'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) ';
3104
3105   my $count_query = "SELECT COUNT(*) FROM cust_pkg $addl_from $extra_sql";
3106
3107   my $sql_query = {
3108     'table'       => 'cust_pkg',
3109     'hashref'     => {},
3110     'select'      => join(', ',
3111                                 'cust_pkg.*',
3112                                 ( map "part_pkg.$_", qw( pkg freq ) ),
3113                                 'pkg_class.classname',
3114                                 'cust_main.custnum AS cust_main_custnum',
3115                                 FS::UI::Web::cust_sql_fields(
3116                                   $params->{'cust_fields'}
3117                                 ),
3118                      ),
3119     'extra_sql'   => "$extra_sql $orderby",
3120     'addl_from'   => $addl_from,
3121     'count_query' => $count_query,
3122   };
3123
3124 }
3125
3126 =item fcc_477_count
3127
3128 Returns a list of two package counts.  The first is a count of packages
3129 based on the supplied criteria and the second is the count of residential
3130 packages with those same criteria.  Criteria are specified as in the search
3131 method.
3132
3133 =cut
3134
3135 sub fcc_477_count {
3136   my ($class, $params) = @_;
3137
3138   my $sql_query = $class->search( $params );
3139
3140   my $count_sql = delete($sql_query->{'count_query'});
3141   $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
3142     or die "couldn't parse count_sql";
3143
3144   my $count_sth = dbh->prepare($count_sql)
3145     or die "Error preparing $count_sql: ". dbh->errstr;
3146   $count_sth->execute
3147     or die "Error executing $count_sql: ". $count_sth->errstr;
3148   my $count_arrayref = $count_sth->fetchrow_arrayref;
3149
3150   return ( @$count_arrayref );
3151
3152 }
3153
3154
3155 =item location_sql
3156
3157 Returns a list: the first item is an SQL fragment identifying matching
3158 packages/customers via location (taking into account shipping and package
3159 address taxation, if enabled), and subsequent items are the parameters to
3160 substitute for the placeholders in that fragment.
3161
3162 =cut
3163
3164 sub location_sql {
3165   my($class, %opt) = @_;
3166   my $ornull = $opt{'ornull'};
3167
3168   my $conf = new FS::Conf;
3169
3170   # '?' placeholders in _location_sql_where
3171   my $x = $ornull ? 3 : 2;
3172   my @bill_param = ( ('city')x3, ('county')x$x, ('state')x$x, 'country' );
3173
3174   my $main_where;
3175   my @main_param;
3176   if ( $conf->exists('tax-ship_address') ) {
3177
3178     $main_where = "(
3179          (     ( ship_last IS NULL     OR  ship_last  = '' )
3180            AND ". _location_sql_where('cust_main', '', $ornull ). "
3181          )
3182       OR (       ship_last IS NOT NULL AND ship_last != ''
3183            AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
3184          )
3185     )";
3186     #    AND payby != 'COMP'
3187
3188     @main_param = ( @bill_param, @bill_param );
3189
3190   } else {
3191
3192     $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
3193     @main_param = @bill_param;
3194
3195   }
3196
3197   my $where;
3198   my @param;
3199   if ( $conf->exists('tax-pkg_address') ) {
3200
3201     my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
3202
3203     $where = " (
3204                     ( cust_pkg.locationnum IS     NULL AND $main_where )
3205                  OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where  )
3206                )
3207              ";
3208     @param = ( @main_param, @bill_param );
3209
3210   } else {
3211
3212     $where = $main_where;
3213     @param = @main_param;
3214
3215   }
3216
3217   ( $where, @param );
3218
3219 }
3220
3221 #subroutine, helper for location_sql
3222 sub _location_sql_where {
3223   my $table  = shift;
3224   my $prefix = @_ ? shift : '';
3225   my $ornull = @_ ? shift : '';
3226
3227 #  $ornull             = $ornull          ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
3228
3229   $ornull = $ornull ? ' OR ? IS NULL ' : '';
3230
3231   my $or_empty_city   = " OR ( ? = '' AND $table.${prefix}city   IS NULL ) ";
3232   my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL ) ";
3233   my $or_empty_state =  " OR ( ? = '' AND $table.${prefix}state  IS NULL ) ";
3234
3235 #        ( $table.${prefix}city    = ? $or_empty_city   $ornull )
3236   "
3237         ( $table.${prefix}city    = ? OR ? = '' OR CAST(? AS text) IS NULL )
3238     AND ( $table.${prefix}county  = ? $or_empty_county $ornull )
3239     AND ( $table.${prefix}state   = ? $or_empty_state  $ornull )
3240     AND   $table.${prefix}country = ?
3241   ";
3242 }
3243
3244 =head1 SUBROUTINES
3245
3246 =over 4
3247
3248 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
3249
3250 CUSTNUM is a customer (see L<FS::cust_main>)
3251
3252 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3253 L<FS::part_pkg>) to order for this customer.  Duplicates are of course
3254 permitted.
3255
3256 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
3257 remove for this customer.  The services (see L<FS::cust_svc>) are moved to the
3258 new billing items.  An error is returned if this is not possible (see
3259 L<FS::pkg_svc>).  An empty arrayref is equivalent to not specifying this
3260 parameter.
3261
3262 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3263 newly-created cust_pkg objects.
3264
3265 REFNUM, if specified, will specify the FS::pkg_referral record to be created
3266 and inserted.  Multiple FS::pkg_referral records can be created by
3267 setting I<refnum> to an array reference of refnums or a hash reference with
3268 refnums as keys.  If no I<refnum> is defined, a default FS::pkg_referral
3269 record will be created corresponding to cust_main.refnum.
3270
3271 =cut
3272
3273 sub order {
3274   my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
3275
3276   my $conf = new FS::Conf;
3277
3278   # Transactionize this whole mess
3279   local $SIG{HUP} = 'IGNORE';
3280   local $SIG{INT} = 'IGNORE';
3281   local $SIG{QUIT} = 'IGNORE';
3282   local $SIG{TERM} = 'IGNORE';
3283   local $SIG{TSTP} = 'IGNORE';
3284   local $SIG{PIPE} = 'IGNORE';
3285
3286   my $oldAutoCommit = $FS::UID::AutoCommit;
3287   local $FS::UID::AutoCommit = 0;
3288   my $dbh = dbh;
3289
3290   my $error;
3291 #  my $cust_main = qsearchs('cust_main', { custnum => $custnum });
3292 #  return "Customer not found: $custnum" unless $cust_main;
3293
3294   warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
3295     if $DEBUG;
3296
3297   my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3298                          @$remove_pkgnum;
3299
3300   my $change = scalar(@old_cust_pkg) != 0;
3301
3302   my %hash = ();
3303   if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
3304
3305     warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
3306          " to pkgpart ". $pkgparts->[0]. "\n"
3307       if $DEBUG;
3308
3309     my $err_or_cust_pkg =
3310       $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
3311                                 'refnum'  => $refnum,
3312                               );
3313
3314     unless (ref($err_or_cust_pkg)) {
3315       $dbh->rollback if $oldAutoCommit;
3316       return $err_or_cust_pkg;
3317     }
3318
3319     push @$return_cust_pkg, $err_or_cust_pkg;
3320     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3321     return '';
3322
3323   }
3324
3325   # Create the new packages.
3326   foreach my $pkgpart (@$pkgparts) {
3327
3328     warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
3329
3330     my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
3331                                       pkgpart => $pkgpart,
3332                                       refnum  => $refnum,
3333                                       %hash,
3334                                     };
3335     $error = $cust_pkg->insert( 'change' => $change );
3336     if ($error) {
3337       $dbh->rollback if $oldAutoCommit;
3338       return $error;
3339     }
3340     push @$return_cust_pkg, $cust_pkg;
3341   }
3342   # $return_cust_pkg now contains refs to all of the newly
3343   # created packages.
3344
3345   # Transfer services and cancel old packages.
3346   foreach my $old_pkg (@old_cust_pkg) {
3347
3348     warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
3349       if $DEBUG;
3350
3351     foreach my $new_pkg (@$return_cust_pkg) {
3352       $error = $old_pkg->transfer($new_pkg);
3353       if ($error and $error == 0) {
3354         # $old_pkg->transfer failed.
3355         $dbh->rollback if $oldAutoCommit;
3356         return $error;
3357       }
3358     }
3359
3360     if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
3361       warn "trying transfer again with change_svcpart option\n" if $DEBUG;
3362       foreach my $new_pkg (@$return_cust_pkg) {
3363         $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
3364         if ($error and $error == 0) {
3365           # $old_pkg->transfer failed.
3366         $dbh->rollback if $oldAutoCommit;
3367         return $error;
3368         }
3369       }
3370     }
3371
3372     if ($error > 0) {
3373       # Transfers were successful, but we went through all of the
3374       # new packages and still had services left on the old package.
3375       # We can't cancel the package under the circumstances, so abort.
3376       $dbh->rollback if $oldAutoCommit;
3377       return "Unable to transfer all services from package ".$old_pkg->pkgnum;
3378     }
3379     $error = $old_pkg->cancel( quiet=>1 );
3380     if ($error) {
3381       $dbh->rollback;
3382       return $error;
3383     }
3384   }
3385   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3386   '';
3387 }
3388
3389 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
3390
3391 A bulk change method to change packages for multiple customers.
3392
3393 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3394 L<FS::part_pkg>) to order for each customer.  Duplicates are of course
3395 permitted.
3396
3397 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
3398 replace.  The services (see L<FS::cust_svc>) are moved to the
3399 new billing items.  An error is returned if this is not possible (see
3400 L<FS::pkg_svc>).
3401
3402 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3403 newly-created cust_pkg objects.
3404
3405 =cut
3406
3407 sub bulk_change {
3408   my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
3409
3410   # Transactionize this whole mess
3411   local $SIG{HUP} = 'IGNORE';
3412   local $SIG{INT} = 'IGNORE';
3413   local $SIG{QUIT} = 'IGNORE';
3414   local $SIG{TERM} = 'IGNORE';
3415   local $SIG{TSTP} = 'IGNORE';
3416   local $SIG{PIPE} = 'IGNORE';
3417
3418   my $oldAutoCommit = $FS::UID::AutoCommit;
3419   local $FS::UID::AutoCommit = 0;
3420   my $dbh = dbh;
3421
3422   my @errors;
3423   my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3424                          @$remove_pkgnum;
3425
3426   while(scalar(@old_cust_pkg)) {
3427     my @return = ();
3428     my $custnum = $old_cust_pkg[0]->custnum;
3429     my (@remove) = map { $_->pkgnum }
3430                    grep { $_->custnum == $custnum } @old_cust_pkg;
3431     @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
3432
3433     my $error = order $custnum, $pkgparts, \@remove, \@return;
3434
3435     push @errors, $error
3436       if $error;
3437     push @$return_cust_pkg, @return;
3438   }
3439
3440   if (scalar(@errors)) {
3441     $dbh->rollback if $oldAutoCommit;
3442     return join(' / ', @errors);
3443   }
3444
3445   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3446   '';
3447 }
3448
3449 # Used by FS::Upgrade to migrate to a new database.
3450 sub _upgrade_data {  # class method
3451   my ($class, %opts) = @_;
3452   $class->_upgrade_otaker(%opts);
3453   my @statements = (
3454     # RT#10139, bug resulting in contract_end being set when it shouldn't
3455   'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
3456     # RT#10830, bad calculation of prorate date near end of year
3457     # the date range for bill is December 2009, and we move it forward
3458     # one year if it's before the previous bill date (which it should
3459     # never be)
3460   'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
3461   AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
3462   WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
3463     # RT6628, add order_date to cust_pkg
3464     'update cust_pkg set order_date = (select history_date from h_cust_pkg
3465         where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
3466         history_action = \'insert\') where order_date is null',
3467   );
3468   foreach my $sql (@statements) {
3469     my $sth = dbh->prepare($sql);
3470     $sth->execute or die $sth->errstr;
3471   }
3472 }
3473
3474 =back
3475
3476 =head1 BUGS
3477
3478 sub order is not OO.  Perhaps it should be moved to FS::cust_main and made so?
3479
3480 In sub order, the @pkgparts array (passed by reference) is clobbered.
3481
3482 Also in sub order, no money is adjusted.  Once FS::part_pkg defines a standard
3483 method to pass dates to the recur_prog expression, it should do so.
3484
3485 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
3486 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
3487 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
3488 configuration values.  Probably need a subroutine which decides what to do
3489 based on whether or not we've fetched the user yet, rather than a hash.  See
3490 FS::UID and the TODO.
3491
3492 Now that things are transactional should the check in the insert method be
3493 moved to check ?
3494
3495 =head1 SEE ALSO
3496
3497 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
3498 L<FS::pkg_svc>, schema.html from the base documentation
3499
3500 =cut
3501
3502 1;
3503