FS/FS/cust_pkg.pm

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