FS/FS/cust_pkg.pm

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