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                  (($err_or_pkg->pkgnum == $change_to->pkgnum) ? '' :
2446                   $change_to->cancel('no_delay_cancel' => 1) ||
2447                   $change_to->delete);
2448       } else {
2449         $error = $err_or_pkg;
2450       }
2451     } else { # change the start date only.
2452       $self->set('expire', $date);
2453       $change_to->set('start_date', $date);
2454       $error = $self->replace || $change_to->replace;
2455     }
2456     if ( $error ) {
2457       $dbh->rollback if $oldAutoCommit;
2458       return $error;
2459     } else {
2460       $dbh->commit if $oldAutoCommit;
2461       return '';
2462     }
2463   } # if $self->change_to_pkgnum
2464
2465   my $new_pkgpart = $opt->{'pkgpart'}
2466       if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2467   my $new_locationnum = $opt->{'locationnum'}
2468       if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2469   my $new_quantity = $opt->{'quantity'}
2470       if $opt->{'quantity'} and $opt->{'quantity'} != $self->quantity;
2471   my $new_contract_end = $opt->{'contract_end'}
2472       if $opt->{'contract_end'} and $opt->{'contract_end'} != $self->contract_end;
2473
2474   return '' unless $new_pkgpart or $new_locationnum or $new_quantity or $new_contract_end; # wouldn't do anything
2475
2476   # allow $opt->{'locationnum'} = '' to specifically set it to null
2477   # (i.e. customer default location)
2478   $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2479
2480   my $new = FS::cust_pkg->new( {
2481     custnum     => $self->custnum,
2482     locationnum => $opt->{'locationnum'},
2483     start_date  => $date,
2484     map   {  $_ => ( $opt->{$_} || $self->$_() )  }
2485       qw( pkgpart quantity refnum salesnum contract_end )
2486   } );
2487   $error = $new->insert('change' => 1,
2488                         'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2489   if ( !$error ) {
2490     $self->set('change_to_pkgnum', $new->pkgnum);
2491     $self->set('expire', $date);
2492     $error = $self->replace;
2493   }
2494   if ( $error ) {
2495     $dbh->rollback if $oldAutoCommit;
2496   } else {
2497     $dbh->commit if $oldAutoCommit;
2498   }
2499
2500   $error;
2501 }
2502
2503 =item abort_change
2504
2505 Cancels a future package change scheduled by C<change_later>.
2506
2507 =cut
2508
2509 sub abort_change {
2510   my $self = shift;
2511   my $pkgnum = $self->change_to_pkgnum;
2512   my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
2513   my $error;
2514   if ( $change_to ) {
2515     $error = $change_to->cancel || $change_to->delete;
2516     return $error if $error;
2517   }
2518   $self->set('change_to_pkgnum', '');
2519   $self->set('expire', '');
2520   $self->replace;
2521 }
2522
2523 =item set_quantity QUANTITY
2524
2525 Change the package's quantity field.  This is one of the few package properties
2526 that can safely be changed without canceling and reordering the package
2527 (because it doesn't affect tax eligibility).  Returns an error or an
2528 empty string.
2529
2530 =cut
2531
2532 sub set_quantity {
2533   my $self = shift;
2534   $self = $self->replace_old; # just to make sure
2535   $self->quantity(shift);
2536   $self->replace;
2537 }
2538
2539 =item set_salesnum SALESNUM
2540
2541 Change the package's salesnum (sales person) field.  This is one of the few
2542 package properties that can safely be changed without canceling and reordering
2543 the package (because it doesn't affect tax eligibility).  Returns an error or
2544 an empty string.
2545
2546 =cut
2547
2548 sub set_salesnum {
2549   my $self = shift;
2550   $self = $self->replace_old; # just to make sure
2551   $self->salesnum(shift);
2552   $self->replace;
2553   # XXX this should probably reassign any credit that's already been given
2554 }
2555
2556 =item modify_charge OPTIONS
2557
2558 Change the properties of a one-time charge.  The following properties can
2559 be changed this way:
2560 - pkg: the package description
2561 - classnum: the package class
2562 - additional: arrayref of additional invoice details to add to this package
2563
2564 and, I<if the charge has not yet been billed>:
2565 - start_date: the date when it will be billed
2566 - amount: the setup fee to be charged
2567 - quantity: the multiplier for the setup fee
2568 - separate_bill: whether to put the charge on a separate invoice
2569
2570 If you pass 'adjust_commission' => 1, and the classnum changes, and there are
2571 commission credits linked to this charge, they will be recalculated.
2572
2573 =cut
2574
2575 sub modify_charge {
2576   my $self = shift;
2577   my %opt = @_;
2578   my $part_pkg = $self->part_pkg;
2579   my $pkgnum = $self->pkgnum;
2580
2581   my $dbh = dbh;
2582   my $oldAutoCommit = $FS::UID::AutoCommit;
2583   local $FS::UID::AutoCommit = 0;
2584
2585   return "Can't use modify_charge except on one-time charges"
2586     unless $part_pkg->freq eq '0';
2587
2588   if ( length($opt{'pkg'}) and $part_pkg->pkg ne $opt{'pkg'} ) {
2589     $part_pkg->set('pkg', $opt{'pkg'});
2590   }
2591
2592   my %pkg_opt = $part_pkg->options;
2593   my $pkg_opt_modified = 0;
2594
2595   $opt{'additional'} ||= [];
2596   my $i;
2597   my @old_additional;
2598   foreach (grep /^additional/, keys %pkg_opt) {
2599     ($i) = ($_ =~ /^additional_info(\d+)$/);
2600     $old_additional[$i] = $pkg_opt{$_} if $i;
2601     delete $pkg_opt{$_};
2602   }
2603
2604   for ( $i = 0; exists($opt{'additional'}->[$i]); $i++ ) {
2605     $pkg_opt{ "additional_info$i" } = $opt{'additional'}->[$i];
2606     if (!exists($old_additional[$i])
2607         or $old_additional[$i] ne $opt{'additional'}->[$i])
2608     {
2609       $pkg_opt_modified = 1;
2610     }
2611   }
2612   $pkg_opt_modified = 1 if (scalar(@old_additional) - 1) != $i;
2613   $pkg_opt{'additional_count'} = $i if $i > 0;
2614
2615   my $old_classnum;
2616   if ( exists($opt{'classnum'}) and $part_pkg->classnum ne $opt{'classnum'} )
2617   {
2618     # remember it
2619     $old_classnum = $part_pkg->classnum;
2620     $part_pkg->set('classnum', $opt{'classnum'});
2621   }
2622
2623   if ( !$self->get('setup') ) {
2624     # not yet billed, so allow amount, setup_cost, quantity, start_date,
2625     # and separate_bill
2626
2627     if ( exists($opt{'amount'})
2628           and $part_pkg->option('setup_fee') != $opt{'amount'}
2629           and $opt{'amount'} > 0 ) {
2630
2631       $pkg_opt{'setup_fee'} = $opt{'amount'};
2632       $pkg_opt_modified = 1;
2633     }
2634
2635     if ( exists($opt{'setup_cost'})
2636           and $part_pkg->setup_cost != $opt{'setup_cost'}
2637           and $opt{'setup_cost'} > 0 ) {
2638
2639       $part_pkg->set('setup_cost', $opt{'setup_cost'});
2640     }
2641
2642     if ( exists($opt{'quantity'})
2643           and $opt{'quantity'} != $self->quantity
2644           and $opt{'quantity'} > 0 ) {
2645
2646       $self->set('quantity', $opt{'quantity'});
2647     }
2648
2649     if ( exists($opt{'start_date'})
2650           and $opt{'start_date'} != $self->start_date ) {
2651
2652       $self->set('start_date', $opt{'start_date'});
2653     }
2654
2655     if ( exists($opt{'separate_bill'})
2656           and $opt{'separate_bill'} ne $self->separate_bill ) {
2657
2658       $self->set('separate_bill', $opt{'separate_bill'});
2659     }
2660
2661
2662   } # else simply ignore them; the UI shouldn't allow editing the fields
2663
2664
2665   if ( exists($opt{'taxclass'})
2666           and $part_pkg->taxclass ne $opt{'taxclass'}) {
2667
2668       $part_pkg->set('taxclass', $opt{'taxclass'});
2669   }
2670
2671   my $error;
2672   if ( $part_pkg->modified or $pkg_opt_modified ) {
2673     # can we safely modify the package def?
2674     # Yes, if it's not available for purchase, and this is the only instance
2675     # of it.
2676     if ( $part_pkg->disabled
2677          and FS::cust_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 1
2678          and FS::quotation_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 0
2679        ) {
2680       $error = $part_pkg->replace( options => \%pkg_opt );
2681     } else {
2682       # clone it
2683       $part_pkg = $part_pkg->clone;
2684       $part_pkg->set('disabled' => 'Y');
2685       $error = $part_pkg->insert( options => \%pkg_opt );
2686       # and associate this as yet-unbilled package to the new package def
2687       $self->set('pkgpart' => $part_pkg->pkgpart);
2688     }
2689     if ( $error ) {
2690       $dbh->rollback if $oldAutoCommit;
2691       return $error;
2692     }
2693   }
2694
2695   if ($self->modified) { # for quantity or start_date change, or if we had
2696                          # to clone the existing package def
2697     my $error = $self->replace;
2698     return $error if $error;
2699   }
2700   if (defined $old_classnum) {
2701     # fix invoice grouping records
2702     my $old_catname = $old_classnum
2703                       ? FS::pkg_class->by_key($old_classnum)->categoryname
2704                       : '';
2705     my $new_catname = $opt{'classnum'}
2706                       ? $part_pkg->pkg_class->categoryname
2707                       : '';
2708     if ( $old_catname ne $new_catname ) {
2709       foreach my $cust_bill_pkg ($self->cust_bill_pkg) {
2710         # (there should only be one...)
2711         my @display = qsearch( 'cust_bill_pkg_display', {
2712             'billpkgnum'  => $cust_bill_pkg->billpkgnum,
2713             'section'     => $old_catname,
2714         });
2715         foreach (@display) {
2716           $_->set('section', $new_catname);
2717           $error = $_->replace;
2718           if ( $error ) {
2719             $dbh->rollback if $oldAutoCommit;
2720             return $error;
2721           }
2722         }
2723       } # foreach $cust_bill_pkg
2724     }
2725
2726     if ( $opt{'adjust_commission'} ) {
2727       # fix commission credits...tricky.
2728       foreach my $cust_event ($self->cust_event) {
2729         my $part_event = $cust_event->part_event;
2730         foreach my $table (qw(sales agent)) {
2731           my $class =
2732             "FS::part_event::Action::Mixin::credit_${table}_pkg_class";
2733           my $credit = qsearchs('cust_credit', {
2734               'eventnum' => $cust_event->eventnum,
2735           });
2736           if ( $part_event->isa($class) ) {
2737             # Yes, this results in current commission rates being applied
2738             # retroactively to a one-time charge.  For accounting purposes
2739             # there ought to be some kind of time limit on doing this.
2740             my $amount = $part_event->_calc_credit($self);
2741             if ( $credit and $credit->amount ne $amount ) {
2742               # Void the old credit.
2743               $error = $credit->void('Package class changed');
2744               if ( $error ) {
2745                 $dbh->rollback if $oldAutoCommit;
2746                 return "$error (adjusting commission credit)";
2747               }
2748             }
2749             # redo the event action to recreate the credit.
2750             local $@ = '';
2751             eval { $part_event->do_action( $self, $cust_event ) };
2752             if ( $@ ) {
2753               $dbh->rollback if $oldAutoCommit;
2754               return $@;
2755             }
2756           } # if $part_event->isa($class)
2757         } # foreach $table
2758       } # foreach $cust_event
2759     } # if $opt{'adjust_commission'}
2760   } # if defined $old_classnum
2761
2762   $dbh->commit if $oldAutoCommit;
2763   '';
2764 }
2765
2766
2767
2768 use Data::Dumper;
2769 sub process_bulk_cust_pkg {
2770   my $job = shift;
2771   my $param = shift;
2772   warn Dumper($param) if $DEBUG;
2773
2774   my $old_part_pkg = qsearchs('part_pkg',
2775                               { pkgpart => $param->{'old_pkgpart'} });
2776   my $new_part_pkg = qsearchs('part_pkg',
2777                               { pkgpart => $param->{'new_pkgpart'} });
2778   die "Must select a new package type\n" unless $new_part_pkg;
2779   #my $keep_dates = $param->{'keep_dates'} || 0;
2780   my $keep_dates = 1; # there is no good reason to turn this off
2781
2782   my $oldAutoCommit = $FS::UID::AutoCommit;
2783   local $FS::UID::AutoCommit = 0;
2784   my $dbh = dbh;
2785
2786   my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
2787
2788   my $i = 0;
2789   foreach my $old_cust_pkg ( @cust_pkgs ) {
2790     $i++;
2791     $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
2792     if ( $old_cust_pkg->getfield('cancel') ) {
2793       warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
2794         $old_cust_pkg->pkgnum."\n"
2795         if $DEBUG;
2796       next;
2797     }
2798     warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
2799       if $DEBUG;
2800     my $error = $old_cust_pkg->change(
2801       'pkgpart'     => $param->{'new_pkgpart'},
2802       'keep_dates'  => $keep_dates
2803     );
2804     if ( !ref($error) ) { # change returns the cust_pkg on success
2805       $dbh->rollback;
2806       die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
2807     }
2808   }
2809   $dbh->commit if $oldAutoCommit;
2810   return;
2811 }
2812
2813 =item last_bill
2814
2815 Returns the last bill date, or if there is no last bill date, the setup date.
2816 Useful for billing metered services.
2817
2818 =cut
2819
2820 sub last_bill {
2821   my $self = shift;
2822   return $self->setfield('last_bill', $_[0]) if @_;
2823   return $self->getfield('last_bill') if $self->getfield('last_bill');
2824   my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
2825                                                   'edate'  => $self->bill,  } );
2826   $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
2827 }
2828
2829 =item last_cust_pkg_reason ACTION
2830
2831 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
2832 Returns false if there is no reason or the package is not currenly ACTION'd
2833 ACTION is one of adjourn, susp, cancel, or expire.
2834
2835 =cut
2836
2837 sub last_cust_pkg_reason {
2838   my ( $self, $action ) = ( shift, shift );
2839   my $date = $self->get($action);
2840   qsearchs( {
2841               'table' => 'cust_pkg_reason',
2842               'hashref' => { 'pkgnum' => $self->pkgnum,
2843                              'action' => substr(uc($action), 0, 1),
2844                              'date'   => $date,
2845                            },
2846               'order_by' => 'ORDER BY num DESC LIMIT 1',
2847            } );
2848 }
2849
2850 =item last_reason ACTION
2851
2852 Returns the most recent ACTION FS::reason associated with the package.
2853 Returns false if there is no reason or the package is not currenly ACTION'd
2854 ACTION is one of adjourn, susp, cancel, or expire.
2855
2856 =cut
2857
2858 sub last_reason {
2859   my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
2860   $cust_pkg_reason->reason
2861     if $cust_pkg_reason;
2862 }
2863
2864 =item part_pkg
2865
2866 Returns the definition for this billing item, as an FS::part_pkg object (see
2867 L<FS::part_pkg>).
2868
2869 =cut
2870
2871 sub part_pkg {
2872   my $self = shift;
2873   return $self->{'_pkgpart'} if $self->{'_pkgpart'};
2874   cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
2875   qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
2876 }
2877
2878 =item old_cust_pkg
2879
2880 Returns the cancelled package this package was changed from, if any.
2881
2882 =cut
2883
2884 sub old_cust_pkg {
2885   my $self = shift;
2886   return '' unless $self->change_pkgnum;
2887   qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
2888 }
2889
2890 =item change_cust_main
2891
2892 Returns the customter this package was detached to, if any.
2893
2894 =cut
2895
2896 sub change_cust_main {
2897   my $self = shift;
2898   return '' unless $self->change_custnum;
2899   qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
2900 }
2901
2902 =item calc_setup
2903
2904 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
2905 item.
2906
2907 =cut
2908
2909 sub calc_setup {
2910   my $self = shift;
2911   $self->part_pkg->calc_setup($self, @_);
2912 }
2913
2914 =item calc_recur
2915
2916 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
2917 item.
2918
2919 =cut
2920
2921 sub calc_recur {
2922   my $self = shift;
2923   $self->part_pkg->calc_recur($self, @_);
2924 }
2925
2926 =item base_setup
2927
2928 Calls the I<base_setup> of the FS::part_pkg object associated with this billing
2929 item.
2930
2931 =cut
2932
2933 sub base_setup {
2934   my $self = shift;
2935   $self->part_pkg->base_setup($self, @_);
2936 }
2937
2938 =item base_recur
2939
2940 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
2941 item.
2942
2943 =cut
2944
2945 sub base_recur {
2946   my $self = shift;
2947   $self->part_pkg->base_recur($self, @_);
2948 }
2949
2950 =item calc_remain
2951
2952 Calls the I<calc_remain> of the FS::part_pkg object associated with this
2953 billing item.
2954
2955 =cut
2956
2957 sub calc_remain {
2958   my $self = shift;
2959   $self->part_pkg->calc_remain($self, @_);
2960 }
2961
2962 =item calc_cancel
2963
2964 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
2965 billing item.
2966
2967 =cut
2968
2969 sub calc_cancel {
2970   my $self = shift;
2971   $self->part_pkg->calc_cancel($self, @_);
2972 }
2973
2974 =item cust_bill_pkg
2975
2976 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
2977
2978 =cut
2979
2980 sub cust_bill_pkg {
2981   my $self = shift;
2982   qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
2983 }
2984
2985 =item cust_pkg_detail [ DETAILTYPE ]
2986
2987 Returns any customer package details for this package (see
2988 L<FS::cust_pkg_detail>).
2989
2990 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2991
2992 =cut
2993
2994 sub cust_pkg_detail {
2995   my $self = shift;
2996   my %hash = ( 'pkgnum' => $self->pkgnum );
2997   $hash{detailtype} = shift if @_;
2998   qsearch({
2999     'table'    => 'cust_pkg_detail',
3000     'hashref'  => \%hash,
3001     'order_by' => 'ORDER BY weight, pkgdetailnum',
3002   });
3003 }
3004
3005 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
3006
3007 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
3008
3009 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
3010
3011 If there is an error, returns the error, otherwise returns false.
3012
3013 =cut
3014
3015 sub set_cust_pkg_detail {
3016   my( $self, $detailtype, @details ) = @_;
3017
3018   my $oldAutoCommit = $FS::UID::AutoCommit;
3019   local $FS::UID::AutoCommit = 0;
3020   my $dbh = dbh;
3021
3022   foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
3023     my $error = $current->delete;
3024     if ( $error ) {
3025       $dbh->rollback if $oldAutoCommit;
3026       return "error removing old detail: $error";
3027     }
3028   }
3029
3030   foreach my $detail ( @details ) {
3031     my $cust_pkg_detail = new FS::cust_pkg_detail {
3032       'pkgnum'     => $self->pkgnum,
3033       'detailtype' => $detailtype,
3034       'detail'     => $detail,
3035     };
3036     my $error = $cust_pkg_detail->insert;
3037     if ( $error ) {
3038       $dbh->rollback if $oldAutoCommit;
3039       return "error adding new detail: $error";
3040     }
3041
3042   }
3043
3044   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3045   '';
3046
3047 }
3048
3049 =item cust_event
3050
3051 Returns the customer billing events (see L<FS::cust_event>) for this invoice.
3052
3053 =cut
3054
3055 #false laziness w/cust_bill.pm
3056 sub cust_event {
3057   my $self = shift;
3058   qsearch({
3059     'table'     => 'cust_event',
3060     'addl_from' => 'JOIN part_event USING ( eventpart )',
3061     'hashref'   => { 'tablenum' => $self->pkgnum },
3062     'extra_sql' => " AND eventtable = 'cust_pkg' ",
3063   });
3064 }
3065
3066 =item num_cust_event
3067
3068 Returns the number of customer billing events (see L<FS::cust_event>) for this package.
3069
3070 =cut
3071
3072 #false laziness w/cust_bill.pm
3073 sub num_cust_event {
3074   my $self = shift;
3075   my $sql = "SELECT COUNT(*) ". $self->_from_cust_event_where;
3076   $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref->[0];
3077 }
3078
3079 =item exists_cust_event
3080
3081 Returns true if there are customer billing events (see L<FS::cust_event>) for this package.  More efficient than using num_cust_event.
3082
3083 =cut
3084
3085 sub exists_cust_event {
3086   my $self = shift;
3087   my $sql = "SELECT 1 ". $self->_from_cust_event_where. " LIMIT 1";
3088   my $row = $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref;
3089   $row ? $row->[0] : '';
3090 }
3091
3092 sub _from_cust_event_where {
3093   #my $self = shift;
3094   " FROM cust_event JOIN part_event USING ( eventpart ) ".
3095   "  WHERE tablenum = ? AND eventtable = 'cust_pkg' ";
3096 }
3097
3098 sub _prep_ex {
3099   my( $self, $sql, @args ) = @_;
3100   my $sth = dbh->prepare($sql) or die  dbh->errstr. " preparing $sql";
3101   $sth->execute(@args)         or die $sth->errstr. " executing $sql";
3102   $sth;
3103 }
3104
3105 =item part_pkg_currency_option OPTIONNAME
3106
3107 Returns a two item list consisting of the currency of this customer, if any,
3108 and a value for the provided option.  If the customer has a currency, the value
3109 is the option value the given name and the currency (see
3110 L<FS::part_pkg_currency>).  Otherwise, if the customer has no currency, is the
3111 regular option value for the given name (see L<FS::part_pkg_option>).
3112
3113 =cut
3114
3115 sub part_pkg_currency_option {
3116   my( $self, $optionname ) = @_;
3117   my $part_pkg = $self->part_pkg;
3118   if ( my $currency = $self->cust_main->currency ) {
3119     ($currency, $part_pkg->part_pkg_currency_option($currency, $optionname) );
3120   } else {
3121     ('', $part_pkg->option($optionname) );
3122   }
3123 }
3124
3125 =item cust_svc [ SVCPART ] (old, deprecated usage)
3126
3127 =item cust_svc [ OPTION => VALUE ... ] (current usage)
3128
3129 =item cust_svc_unsorted [ OPTION => VALUE ... ]
3130
3131 Returns the services for this package, as FS::cust_svc objects (see
3132 L<FS::cust_svc>).  Available options are svcpart and svcdb.  If either is
3133 spcififed, returns only the matching services.
3134
3135 As an optimization, use the cust_svc_unsorted version if you are not displaying
3136 the results.
3137
3138 =cut
3139
3140 sub cust_svc {
3141   my $self = shift;
3142   cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
3143   $self->_sort_cust_svc( $self->cust_svc_unsorted_arrayref(@_) );
3144 }
3145
3146 sub cust_svc_unsorted {
3147   my $self = shift;
3148   @{ $self->cust_svc_unsorted_arrayref(@_) };
3149 }
3150
3151 sub cust_svc_unsorted_arrayref {
3152   my $self = shift;
3153
3154   return [] unless $self->num_cust_svc(@_);
3155
3156   my %opt = ();
3157   if ( @_ && $_[0] =~ /^\d+/ ) {
3158     $opt{svcpart} = shift;
3159   } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3160     %opt = %{ $_[0] };
3161   } elsif ( @_ ) {
3162     %opt = @_;
3163   }
3164
3165   my %search = (
3166     'table'   => 'cust_svc',
3167     'hashref' => { 'pkgnum' => $self->pkgnum },
3168   );
3169   if ( $opt{svcpart} ) {
3170     $search{hashref}->{svcpart} = $opt{'svcpart'};
3171   }
3172   if ( $opt{'svcdb'} ) {
3173     $search{addl_from} = ' LEFT JOIN part_svc USING ( svcpart ) ';
3174     $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{'svcdb'} );
3175   }
3176
3177   [ qsearch(\%search) ];
3178
3179 }
3180
3181 =item overlimit [ SVCPART ]
3182
3183 Returns the services for this package which have exceeded their
3184 usage limit as FS::cust_svc objects (see L<FS::cust_svc>).  If a svcpart
3185 is specified, return only the matching services.
3186
3187 =cut
3188
3189 sub overlimit {
3190   my $self = shift;
3191   return () unless $self->num_cust_svc(@_);
3192   grep { $_->overlimit } $self->cust_svc(@_);
3193 }
3194
3195 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3196
3197 Returns historical services for this package created before END TIMESTAMP and
3198 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
3199 (see L<FS::h_cust_svc>).  If MODE is 'I' (for 'invoice'), services with the
3200 I<pkg_svc.hidden> flag will be omitted.
3201
3202 =cut
3203
3204 sub h_cust_svc {
3205   my $self = shift;
3206   warn "$me _h_cust_svc called on $self\n"
3207     if $DEBUG;
3208
3209   my ($end, $start, $mode) = @_;
3210
3211   local($FS::Record::qsearch_qualify_columns) = 0;
3212
3213   my @cust_svc = $self->_sort_cust_svc(
3214     [ qsearch( 'h_cust_svc',
3215       { 'pkgnum' => $self->pkgnum, },
3216       FS::h_cust_svc->sql_h_search(@_),
3217     ) ]
3218   );
3219
3220   if ( defined($mode) && $mode eq 'I' ) {
3221     my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
3222     return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
3223   } else {
3224     return @cust_svc;
3225   }
3226 }
3227
3228 sub _sort_cust_svc {
3229   my( $self, $arrayref ) = @_;
3230
3231   my $sort =
3232     sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1]  or  $a->[2] <=> $b->[2] };
3233
3234   my %pkg_svc = map { $_->svcpart => $_ }
3235                 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
3236
3237   map  { $_->[0] }
3238   sort $sort
3239   map {
3240         my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
3241         [ $_,
3242           $pkg_svc ? $pkg_svc->primary_svc : '',
3243           $pkg_svc ? $pkg_svc->quantity : 0,
3244         ];
3245       }
3246   @$arrayref;
3247
3248 }
3249
3250 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
3251
3252 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
3253
3254 Returns the number of services for this package.  Available options are svcpart
3255 and svcdb.  If either is spcififed, returns only the matching services.
3256
3257 =cut
3258
3259 sub num_cust_svc {
3260   my $self = shift;
3261
3262   return $self->{'_num_cust_svc'}
3263     if !scalar(@_)
3264        && exists($self->{'_num_cust_svc'})
3265        && $self->{'_num_cust_svc'} =~ /\d/;
3266
3267   cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
3268     if $DEBUG > 2;
3269
3270   my %opt = ();
3271   if ( @_ && $_[0] =~ /^\d+/ ) {
3272     $opt{svcpart} = shift;
3273   } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3274     %opt = %{ $_[0] };
3275   } elsif ( @_ ) {
3276     %opt = @_;
3277   }
3278
3279   my $select = 'SELECT COUNT(*) FROM cust_svc ';
3280   my $where = ' WHERE pkgnum = ? ';
3281   my @param = ($self->pkgnum);
3282
3283   if ( $opt{'svcpart'} ) {
3284     $where .= ' AND svcpart = ? ';
3285     push @param, $opt{'svcpart'};
3286   }
3287   if ( $opt{'svcdb'} ) {
3288     $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
3289     $where .= ' AND svcdb = ? ';
3290     push @param, $opt{'svcdb'};
3291   }
3292
3293   my $sth = dbh->prepare("$select $where") or die  dbh->errstr;
3294   $sth->execute(@param) or die $sth->errstr;
3295   $sth->fetchrow_arrayref->[0];
3296 }
3297
3298 =item available_part_svc
3299
3300 Returns a list of FS::part_svc objects representing services included in this
3301 package but not yet provisioned.  Each FS::part_svc object also has an extra
3302 field, I<num_avail>, which specifies the number of available services.
3303
3304 =cut
3305
3306 sub available_part_svc {
3307   my $self = shift;
3308
3309   my $pkg_quantity = $self->quantity || 1;
3310
3311   grep { $_->num_avail > 0 }
3312     map {
3313           my $part_svc = $_->part_svc;
3314           $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
3315             $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
3316
3317           # more evil encapsulation breakage
3318           if($part_svc->{'Hash'}{'num_avail'} > 0) {
3319             my @exports = $part_svc->part_export_did;
3320             $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
3321           }
3322
3323           $part_svc;
3324         }
3325       $self->part_pkg->pkg_svc;
3326 }
3327
3328 =item part_svc [ OPTION => VALUE ... ]
3329
3330 Returns a list of FS::part_svc objects representing provisioned and available
3331 services included in this package.  Each FS::part_svc object also has the
3332 following extra fields:
3333
3334 =over 4
3335
3336 =item num_cust_svc
3337
3338 (count)
3339
3340 =item num_avail
3341
3342 (quantity - count)
3343
3344 =item cust_pkg_svc
3345
3346 (services) - array reference containing the provisioned services, as cust_svc objects
3347
3348 =back
3349
3350 Accepts two options:
3351
3352 =over 4
3353
3354 =item summarize_size
3355
3356 If true, will omit the extra cust_pkg_svc option for objects where num_cust_svc
3357 is this size or greater.
3358
3359 =item hide_discontinued
3360
3361 If true, will omit looking for services that are no longer avaialble in the
3362 package definition.
3363
3364 =back
3365
3366 =cut
3367
3368 #svcnum
3369 #label -> ($cust_svc->label)[1]
3370
3371 sub part_svc {
3372   my $self = shift;
3373   my %opt = @_;
3374
3375   my $pkg_quantity = $self->quantity || 1;
3376
3377   #XXX some sort of sort order besides numeric by svcpart...
3378   my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
3379     my $pkg_svc = $_;
3380     my $part_svc = $pkg_svc->part_svc;
3381     my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3382     $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
3383     $part_svc->{'Hash'}{'num_avail'}    =
3384       max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
3385     $part_svc->{'Hash'}{'cust_pkg_svc'} =
3386         $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
3387       unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
3388           && $num_cust_svc >= $opt{summarize_size};
3389     $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
3390     $part_svc;
3391   } $self->part_pkg->pkg_svc;
3392
3393   unless ( $opt{hide_discontinued} ) {
3394     #extras
3395     push @part_svc, map {
3396       my $part_svc = $_;
3397       my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3398       $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
3399       $part_svc->{'Hash'}{'num_avail'}    = 0; #0-$num_cust_svc ?
3400       $part_svc->{'Hash'}{'cust_pkg_svc'} =
3401         $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
3402       $part_svc;
3403     } $self->extra_part_svc;
3404   }
3405
3406   @part_svc;
3407
3408 }
3409
3410 =item extra_part_svc
3411
3412 Returns a list of FS::part_svc objects corresponding to services in this
3413 package which are still provisioned but not (any longer) available in the
3414 package definition.
3415
3416 =cut
3417
3418 sub extra_part_svc {
3419   my $self = shift;
3420
3421   my $pkgnum  = $self->pkgnum;
3422   #my $pkgpart = $self->pkgpart;
3423
3424 #  qsearch( {
3425 #    'table'     => 'part_svc',
3426 #    'hashref'   => {},
3427 #    'extra_sql' =>
3428 #      "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
3429 #                     WHERE pkg_svc.svcpart = part_svc.svcpart
3430 #                       AND pkg_svc.pkgpart = ?
3431 #                       AND quantity > 0
3432 #                 )
3433 #        AND 0 < ( SELECT COUNT(*) FROM cust_svc
3434 #                       LEFT JOIN cust_pkg USING ( pkgnum )
3435 #                     WHERE cust_svc.svcpart = part_svc.svcpart
3436 #                       AND pkgnum = ?
3437 #                 )",
3438 #    'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
3439 #  } );
3440
3441 #seems to benchmark slightly faster... (or did?)
3442
3443   my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
3444   my $pkgparts = join(',', @pkgparts);
3445
3446   qsearch( {
3447     #'select'      => 'DISTINCT ON (svcpart) part_svc.*',
3448     #MySQL doesn't grok DISINCT ON
3449     'select'      => 'DISTINCT part_svc.*',
3450     'table'       => 'part_svc',
3451     'addl_from'   =>
3452       "LEFT JOIN pkg_svc  ON (     pkg_svc.svcpart   = part_svc.svcpart
3453                                AND pkg_svc.pkgpart IN ($pkgparts)
3454                                AND quantity > 0
3455                              )
3456        LEFT JOIN cust_svc ON (     cust_svc.svcpart = part_svc.svcpart )
3457        LEFT JOIN cust_pkg USING ( pkgnum )
3458       ",
3459     'hashref'     => {},
3460     'extra_sql'   => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
3461     'extra_param' => [ [$self->pkgnum=>'int'] ],
3462   } );
3463 }
3464
3465 =item status
3466
3467 Returns a short status string for this package, currently:
3468
3469 =over 4
3470
3471 =item on hold
3472
3473 =item not yet billed
3474
3475 =item one-time charge
3476
3477 =item active
3478
3479 =item suspended
3480
3481 =item cancelled
3482
3483 =back
3484
3485 =cut
3486
3487 sub status {
3488   my $self = shift;
3489
3490   my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
3491
3492   return 'cancelled' if $self->get('cancel');
3493   return 'on hold' if $self->susp && ! $self->setup;
3494   return 'suspended' if $self->susp;
3495   return 'not yet billed' unless $self->setup;
3496   return 'one-time charge' if $freq =~ /^(0|$)/;
3497   return 'active';
3498 }
3499
3500 =item ucfirst_status
3501
3502 Returns the status with the first character capitalized.
3503
3504 =cut
3505
3506 sub ucfirst_status {
3507   ucfirst(shift->status);
3508 }
3509
3510 =item statuses
3511
3512 Class method that returns the list of possible status strings for packages
3513 (see L<the status method|/status>).  For example:
3514
3515   @statuses = FS::cust_pkg->statuses();
3516
3517 =cut
3518
3519 tie my %statuscolor, 'Tie::IxHash',
3520   'on hold'         => 'FF00F5', #brighter purple!
3521   'not yet billed'  => '009999', #teal? cyan?
3522   'one-time charge' => '0000CC', #blue  #'000000',
3523   'active'          => '00CC00',
3524   'suspended'       => 'FF9900',
3525   'cancelled'       => 'FF0000',
3526 ;
3527
3528 sub statuses {
3529   my $self = shift; #could be class...
3530   #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
3531   #                                    # mayble split btw one-time vs. recur
3532     keys %statuscolor;
3533 }
3534
3535 sub statuscolors {
3536   #my $self = shift;
3537   \%statuscolor;
3538 }
3539
3540 =item statuscolor
3541
3542 Returns a hex triplet color string for this package's status.
3543
3544 =cut
3545
3546 sub statuscolor {
3547   my $self = shift;
3548   $statuscolor{$self->status};
3549 }
3550
3551 =item is_status_delay_cancel
3552
3553 Returns true if part_pkg has option delay_cancel,
3554 cust_pkg status is 'suspended' and expire is set
3555 to cancel package within the next day (or however
3556 many days are set in global config part_pkg-delay_cancel-days.
3557
3558 Accepts option I<part_pkg-delay_cancel-days> which should be
3559 the value of the config setting, to avoid looking it up again.
3560
3561 This is not a real status, this only meant for hacking display
3562 values, because otherwise treating the package as suspended is
3563 really the whole point of the delay_cancel option.
3564
3565 =cut
3566
3567 sub is_status_delay_cancel {
3568   my ($self,%opt) = @_;
3569   if ( $self->main_pkgnum and $self->pkglinknum ) {
3570     return $self->main_pkg->is_status_delay_cancel;
3571   }
3572   return 0 unless $self->part_pkg->option('delay_cancel',1);
3573   return 0 unless $self->status eq 'suspended';
3574   return 0 unless $self->expire;
3575   my $expdays = $opt{'part_pkg-delay_cancel-days'};
3576   unless ($expdays) {
3577     my $conf = new FS::Conf;
3578     $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
3579   }
3580   my $expsecs = 60*60*24*$expdays;
3581   return 0 unless $self->expire < time + $expsecs;
3582   return 1;
3583 }
3584
3585 =item pkg_label
3586
3587 Returns a label for this package.  (Currently "pkgnum: pkg - comment" or
3588 "pkg - comment" depending on user preference).
3589
3590 =cut
3591
3592 sub pkg_label {
3593   my $self = shift;
3594   my $label = $self->part_pkg->pkg_comment( cust_pkg=>$self, nopkgpart=>1 );
3595   $label = $self->pkgnum. ": $label"
3596     if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
3597   $label;
3598 }
3599
3600 =item pkg_label_long
3601
3602 Returns a long label for this package, adding the primary service's label to
3603 pkg_label.
3604
3605 =cut
3606
3607 sub pkg_label_long {
3608   my $self = shift;
3609   my $label = $self->pkg_label;
3610   my $cust_svc = $self->primary_cust_svc;
3611   $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
3612   $label;
3613 }
3614
3615 =item pkg_locale
3616
3617 Returns a customer-localized label for this package.
3618
3619 =cut
3620
3621 sub pkg_locale {
3622   my $self = shift;
3623   $self->part_pkg->pkg_locale( $self->cust_main->locale );
3624 }
3625
3626 =item primary_cust_svc
3627
3628 Returns a primary service (as FS::cust_svc object) if one can be identified.
3629
3630 =cut
3631
3632 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
3633
3634 sub primary_cust_svc {
3635   my $self = shift;
3636
3637   my @cust_svc = $self->cust_svc;
3638
3639   return '' unless @cust_svc; #no serivces - irrelevant then
3640
3641   return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
3642
3643   # primary service as specified in the package definition
3644   # or exactly one service definition with quantity one
3645   my $svcpart = $self->part_pkg->svcpart;
3646   @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
3647   return $cust_svc[0] if scalar(@cust_svc) == 1;
3648
3649   #couldn't identify one thing..
3650   return '';
3651 }
3652
3653 =item labels
3654
3655 Returns a list of lists, calling the label method for all services
3656 (see L<FS::cust_svc>) of this billing item.
3657
3658 =cut
3659
3660 sub labels {
3661   my $self = shift;
3662   map { [ $_->label ] } $self->cust_svc;
3663 }
3664
3665 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3666
3667 Like the labels method, but returns historical information on services that
3668 were active as of END_TIMESTAMP and (optionally) not cancelled before
3669 START_TIMESTAMP.  If MODE is 'I' (for 'invoice'), services with the
3670 I<pkg_svc.hidden> flag will be omitted.
3671
3672 Returns a list of lists, calling the label method for all (historical) services
3673 (see L<FS::h_cust_svc>) of this billing item.
3674
3675 =cut
3676
3677 sub h_labels {
3678   my $self = shift;
3679   warn "$me _h_labels called on $self\n"
3680     if $DEBUG;
3681   map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
3682 }
3683
3684 =item labels_short
3685
3686 Like labels, except returns a simple flat list, and shortens long
3687 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3688 identical services to one line that lists the service label and the number of
3689 individual services rather than individual items.
3690
3691 =cut
3692
3693 sub labels_short {
3694   shift->_labels_short( 'labels', @_ );
3695 }
3696
3697 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
3698
3699 Like h_labels, except returns a simple flat list, and shortens long
3700 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3701 identical services to one line that lists the service label and the number of
3702 individual services rather than individual items.
3703
3704 =cut
3705
3706 sub h_labels_short {
3707   shift->_labels_short( 'h_labels', @_ );
3708 }
3709
3710 sub _labels_short {
3711   my( $self, $method ) = ( shift, shift );
3712
3713   warn "$me _labels_short called on $self with $method method\n"
3714     if $DEBUG;
3715
3716   my $conf = new FS::Conf;
3717   my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
3718
3719   warn "$me _labels_short populating \%labels\n"
3720     if $DEBUG;
3721
3722   my %labels;
3723   #tie %labels, 'Tie::IxHash';
3724   push @{ $labels{$_->[0]} }, $_->[1]
3725     foreach $self->$method(@_);
3726
3727   warn "$me _labels_short populating \@labels\n"
3728     if $DEBUG;
3729
3730   my @labels;
3731   foreach my $label ( keys %labels ) {
3732     my %seen = ();
3733     my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
3734     my $num = scalar(@values);
3735     warn "$me _labels_short $num items for $label\n"
3736       if $DEBUG;
3737
3738     if ( $num > $max_same_services ) {
3739       warn "$me _labels_short   more than $max_same_services, so summarizing\n"
3740         if $DEBUG;
3741       push @labels, "$label ($num)";
3742     } else {
3743       if ( $conf->exists('cust_bill-consolidate_services') ) {
3744         warn "$me _labels_short   consolidating services\n"
3745           if $DEBUG;
3746         # push @labels, "$label: ". join(', ', @values);
3747         while ( @values ) {
3748           my $detail = "$label: ";
3749           $detail .= shift(@values). ', '
3750             while @values
3751                && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
3752           $detail =~ s/, $//;
3753           push @labels, $detail;
3754         }
3755         warn "$me _labels_short   done consolidating services\n"
3756           if $DEBUG;
3757       } else {
3758         warn "$me _labels_short   adding service data\n"
3759           if $DEBUG;
3760         push @labels, map { "$label: $_" } @values;
3761       }
3762     }
3763   }
3764
3765  @labels;
3766
3767 }
3768
3769 =item cust_main
3770
3771 Returns the parent customer object (see L<FS::cust_main>).
3772
3773 =item balance
3774
3775 Returns the balance for this specific package, when using
3776 experimental package balance.
3777
3778 =cut
3779
3780 sub balance {
3781   my $self = shift;
3782   $self->cust_main->balance_pkgnum( $self->pkgnum );
3783 }
3784
3785 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
3786
3787 =item cust_location
3788
3789 Returns the location object, if any (see L<FS::cust_location>).
3790
3791 =item cust_location_or_main
3792
3793 If this package is associated with a location, returns the locaiton (see
3794 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
3795
3796 =item location_label [ OPTION => VALUE ... ]
3797
3798 Returns the label of the location object (see L<FS::cust_location>).
3799
3800 =cut
3801
3802 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
3803
3804 =item tax_locationnum
3805
3806 Returns the foreign key to a L<FS::cust_location> object for calculating
3807 tax on this package, as determined by the C<tax-pkg_address> and
3808 C<tax-ship_address> configuration flags.
3809
3810 =cut
3811
3812 sub tax_locationnum {
3813   my $self = shift;
3814   my $conf = FS::Conf->new;
3815   if ( $conf->exists('tax-pkg_address') ) {
3816     return $self->locationnum;
3817   }
3818   elsif ( $conf->exists('tax-ship_address') ) {
3819     return $self->cust_main->ship_locationnum;
3820   }
3821   else {
3822     return $self->cust_main->bill_locationnum;
3823   }
3824 }
3825
3826 =item tax_location
3827
3828 Returns the L<FS::cust_location> object for tax_locationnum.
3829
3830 =cut
3831
3832 sub tax_location {
3833   my $self = shift;
3834   my $conf = FS::Conf->new;
3835   if ( $conf->exists('tax-pkg_address') and $self->locationnum ) {
3836     return FS::cust_location->by_key($self->locationnum);
3837   }
3838   elsif ( $conf->exists('tax-ship_address') ) {
3839     return $self->cust_main->ship_location;
3840   }
3841   else {
3842     return $self->cust_main->bill_location;
3843   }
3844 }
3845
3846 =item seconds_since TIMESTAMP
3847
3848 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
3849 package have been online since TIMESTAMP, according to the session monitor.
3850
3851 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
3852 L<Time::Local> and L<Date::Parse> for conversion functions.
3853
3854 =cut
3855
3856 sub seconds_since {
3857   my($self, $since) = @_;
3858   my $seconds = 0;
3859
3860   foreach my $cust_svc (
3861     grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
3862   ) {
3863     $seconds += $cust_svc->seconds_since($since);
3864   }
3865
3866   $seconds;
3867
3868 }
3869
3870 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
3871
3872 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
3873 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
3874 (exclusive).
3875
3876 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3877 L<perlfunc/"time">.  Also see L<Time::Local> and L<Date::Parse> for conversion
3878 functions.
3879
3880
3881 =cut
3882
3883 sub seconds_since_sqlradacct {
3884   my($self, $start, $end) = @_;
3885
3886   my $seconds = 0;
3887
3888   foreach my $cust_svc (
3889     grep {
3890       my $part_svc = $_->part_svc;
3891       $part_svc->svcdb eq 'svc_acct'
3892         && scalar($part_svc->part_export_usage);
3893     } $self->cust_svc
3894   ) {
3895     $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
3896   }
3897
3898   $seconds;
3899
3900 }
3901
3902 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
3903
3904 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
3905 in this package for sessions ending between TIMESTAMP_START (inclusive) and
3906 TIMESTAMP_END
3907 (exclusive).
3908
3909 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3910 L<perlfunc/"time">.  Also see L<Time::Local> and L<Date::Parse> for conversion
3911 functions.
3912
3913 =cut
3914
3915 sub attribute_since_sqlradacct {
3916   my($self, $start, $end, $attrib) = @_;
3917
3918   my $sum = 0;
3919
3920   foreach my $cust_svc (
3921     grep {
3922       my $part_svc = $_->part_svc;
3923       scalar($part_svc->part_export_usage);
3924     } $self->cust_svc
3925   ) {
3926     $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
3927   }
3928
3929   $sum;
3930
3931 }
3932
3933 =item quantity
3934
3935 =cut
3936
3937 sub quantity {
3938   my( $self, $value ) = @_;
3939   if ( defined($value) ) {
3940     $self->setfield('quantity', $value);
3941   }
3942   $self->getfield('quantity') || 1;
3943 }
3944
3945 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
3946
3947 Transfers as many services as possible from this package to another package.
3948
3949 The destination package can be specified by pkgnum by passing an FS::cust_pkg
3950 object.  The destination package must already exist.
3951
3952 Services are moved only if the destination allows services with the correct
3953 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true.  Use
3954 this option with caution!  No provision is made for export differences
3955 between the old and new service definitions.  Probably only should be used
3956 when your exports for all service definitions of a given svcdb are identical.
3957 (attempt a transfer without it first, to move all possible svcpart-matching
3958 services)
3959
3960 Any services that can't be moved remain in the original package.
3961
3962 Returns an error, if there is one; otherwise, returns the number of services
3963 that couldn't be moved.
3964
3965 =cut
3966
3967 sub transfer {
3968   my ($self, $dest_pkgnum, %opt) = @_;
3969
3970   my $remaining = 0;
3971   my $dest;
3972   my %target;
3973
3974   if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
3975     $dest = $dest_pkgnum;
3976     $dest_pkgnum = $dest->pkgnum;
3977   } else {
3978     $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
3979   }
3980
3981   return ('Package does not exist: '.$dest_pkgnum) unless $dest;
3982
3983   foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
3984     $target{$pkg_svc->svcpart} = $pkg_svc->quantity * ( $dest->quantity || 1 );
3985   }
3986
3987   foreach my $cust_svc ($dest->cust_svc) {
3988     $target{$cust_svc->svcpart}--;
3989   }
3990
3991   my %svcpart2svcparts = ();
3992   if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3993     warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
3994     foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
3995       next if exists $svcpart2svcparts{$svcpart};
3996       my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
3997       $svcpart2svcparts{$svcpart} = [
3998         map  { $_->[0] }
3999         sort { $b->[1] cmp $a->[1]  or  $a->[2] <=> $b->[2] }
4000         map {
4001               my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
4002                                                    'svcpart' => $_          } );
4003               [ $_,
4004                 $pkg_svc ? $pkg_svc->primary_svc : '',
4005                 $pkg_svc ? $pkg_svc->quantity : 0,
4006               ];
4007             }
4008
4009         grep { $_ != $svcpart }
4010         map  { $_->svcpart }
4011         qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
4012       ];
4013       warn "alternates for svcpart $svcpart: ".
4014            join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
4015         if $DEBUG;
4016     }
4017   }
4018
4019   my $error;
4020   foreach my $cust_svc ($self->cust_svc) {
4021     my $svcnum = $cust_svc->svcnum;
4022     if($target{$cust_svc->svcpart} > 0
4023        or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
4024       $target{$cust_svc->svcpart}--;
4025       my $new = new FS::cust_svc { $cust_svc->hash };
4026       $new->pkgnum($dest_pkgnum);
4027       $error = $new->replace($cust_svc);
4028     } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
4029       if ( $DEBUG ) {
4030         warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
4031         warn "alternates to consider: ".
4032              join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
4033       }
4034       my @alternate = grep {
4035                              warn "considering alternate svcpart $_: ".
4036                                   "$target{$_} available in new package\n"
4037                                if $DEBUG;
4038                              $target{$_} > 0;
4039                            } @{$svcpart2svcparts{$cust_svc->svcpart}};
4040       if ( @alternate ) {
4041         warn "alternate(s) found\n" if $DEBUG;
4042         my $change_svcpart = $alternate[0];
4043         $target{$change_svcpart}--;
4044         my $new = new FS::cust_svc { $cust_svc->hash };
4045         $new->svcpart($change_svcpart);
4046         $new->pkgnum($dest_pkgnum);
4047         $error = $new->replace($cust_svc);
4048       } else {
4049         $remaining++;
4050       }
4051     } else {
4052       $remaining++
4053     }
4054     if ( $error ) {
4055       my @label = $cust_svc->label;
4056       return "$label[0] $label[1]: $error";
4057     }
4058   }
4059   return $remaining;
4060 }
4061
4062 =item grab_svcnums SVCNUM, SVCNUM ...
4063
4064 Change the pkgnum for the provided services to this packages.  If there is an
4065 error, returns the error, otherwise returns false.
4066
4067 =cut
4068
4069 sub grab_svcnums {
4070   my $self = shift;
4071   my @svcnum = @_;
4072
4073   my $oldAutoCommit = $FS::UID::AutoCommit;
4074   local $FS::UID::AutoCommit = 0;
4075   my $dbh = dbh;
4076
4077   foreach my $svcnum (@svcnum) {
4078     my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
4079       $dbh->rollback if $oldAutoCommit;
4080       return "unknown svcnum $svcnum";
4081     };
4082     $cust_svc->pkgnum( $self->pkgnum );
4083     my $error = $cust_svc->replace;
4084     if ( $error ) {
4085       $dbh->rollback if $oldAutoCommit;
4086       return $error;
4087     }
4088   }
4089
4090   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4091   '';
4092
4093 }
4094
4095 =item reexport
4096
4097 This method is deprecated.  See the I<depend_jobnum> option to the insert and
4098 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
4099
4100 =cut
4101
4102 #looks like this is still used by the order_pkg and change_pkg methods in
4103 # ClientAPI/MyAccount, need to look into those before removing
4104 sub reexport {
4105   my $self = shift;
4106
4107   my $oldAutoCommit = $FS::UID::AutoCommit;
4108   local $FS::UID::AutoCommit = 0;
4109   my $dbh = dbh;
4110
4111   foreach my $cust_svc ( $self->cust_svc ) {
4112     #false laziness w/svc_Common::insert
4113     my $svc_x = $cust_svc->svc_x;
4114     foreach my $part_export ( $cust_svc->part_svc->part_export ) {
4115       my $error = $part_export->export_insert($svc_x);
4116       if ( $error ) {
4117         $dbh->rollback if $oldAutoCommit;
4118         return $error;
4119       }
4120     }
4121   }
4122
4123   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4124   '';
4125
4126 }
4127
4128 =item export_pkg_change OLD_CUST_PKG
4129
4130 Calls the "pkg_change" export action for all services attached to this package.
4131
4132 =cut
4133
4134 sub export_pkg_change {
4135   my( $self, $old )  = ( shift, shift );
4136
4137   my $oldAutoCommit = $FS::UID::AutoCommit;
4138   local $FS::UID::AutoCommit = 0;
4139   my $dbh = dbh;
4140
4141   foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
4142     my $error = $svc_x->export('pkg_change', $self, $old);
4143     if ( $error ) {
4144       $dbh->rollback if $oldAutoCommit;
4145       return $error;
4146     }
4147   }
4148
4149   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4150   '';
4151
4152 }
4153
4154 =item insert_reason
4155
4156 Associates this package with a (suspension or cancellation) reason (see
4157 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
4158 L<FS::reason>).
4159
4160 Available options are:
4161
4162 =over 4
4163
4164 =item reason
4165
4166 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.
4167
4168 =item reason_otaker
4169
4170 the access_user (see L<FS::access_user>) providing the reason
4171
4172 =item date
4173
4174 a unix timestamp
4175
4176 =item action
4177
4178 the action (cancel, susp, adjourn, expire) associated with the reason
4179
4180 =back
4181
4182 If there is an error, returns the error, otherwise returns false.
4183
4184 =cut
4185
4186 sub insert_reason {
4187   my ($self, %options) = @_;
4188
4189   my $otaker = $options{reason_otaker} ||
4190                $FS::CurrentUser::CurrentUser->username;
4191
4192   my $reasonnum;
4193   if ( $options{'reason'} =~ /^(\d+)$/ ) {
4194
4195     $reasonnum = $1;
4196
4197   } elsif ( ref($options{'reason'}) ) {
4198
4199     return 'Enter a new reason (or select an existing one)'
4200       unless $options{'reason'}->{'reason'} !~ /^\s*$/;
4201
4202     my $reason = new FS::reason({
4203       'reason_type' => $options{'reason'}->{'typenum'},
4204       'reason'      => $options{'reason'}->{'reason'},
4205     });
4206     my $error = $reason->insert;
4207     return $error if $error;
4208
4209     $reasonnum = $reason->reasonnum;
4210
4211   } else {
4212     return "Unparseable reason: ". $options{'reason'};
4213   }
4214
4215   my $cust_pkg_reason =
4216     new FS::cust_pkg_reason({ 'pkgnum'    => $self->pkgnum,
4217                               'reasonnum' => $reasonnum,
4218                               'otaker'    => $otaker,
4219                               'action'    => substr(uc($options{'action'}),0,1),
4220                               'date'      => $options{'date'}
4221                                                ? $options{'date'}
4222                                                : time,
4223                             });
4224
4225   $cust_pkg_reason->insert;
4226 }
4227
4228 =item insert_discount
4229
4230 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
4231 inserting a new discount on the fly (see L<FS::discount>).
4232
4233 Available options are:
4234
4235 =over 4
4236
4237 =item discountnum
4238
4239 =back
4240
4241 If there is an error, returns the error, otherwise returns false.
4242
4243 =cut
4244
4245 sub insert_discount {
4246   #my ($self, %options) = @_;
4247   my $self = shift;
4248
4249   my $cust_pkg_discount = new FS::cust_pkg_discount {
4250     'pkgnum'      => $self->pkgnum,
4251     'discountnum' => $self->discountnum,
4252     'months_used' => 0,
4253     'end_date'    => '', #XXX
4254     #for the create a new discount case
4255     '_type'       => $self->discountnum__type,
4256     'amount'      => $self->discountnum_amount,
4257     'percent'     => $self->discountnum_percent,
4258     'months'      => $self->discountnum_months,
4259     'setup'      => $self->discountnum_setup,
4260     #'disabled'    => $self->discountnum_disabled,
4261   };
4262
4263   $cust_pkg_discount->insert;
4264 }
4265
4266 =item set_usage USAGE_VALUE_HASHREF
4267
4268 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4269 to which they should be set (see L<FS::svc_acct>).  Currently seconds,
4270 upbytes, downbytes, and totalbytes are appropriate keys.
4271
4272 All svc_accts which are part of this package have their values reset.
4273
4274 =cut
4275
4276 sub set_usage {
4277   my ($self, $valueref, %opt) = @_;
4278
4279   #only svc_acct can set_usage for now
4280   foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4281     my $svc_x = $cust_svc->svc_x;
4282     $svc_x->set_usage($valueref, %opt)
4283       if $svc_x->can("set_usage");
4284   }
4285 }
4286
4287 =item recharge USAGE_VALUE_HASHREF
4288
4289 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4290 to which they should be set (see L<FS::svc_acct>).  Currently seconds,
4291 upbytes, downbytes, and totalbytes are appropriate keys.
4292
4293 All svc_accts which are part of this package have their values incremented.
4294
4295 =cut
4296
4297 sub recharge {
4298   my ($self, $valueref) = @_;
4299
4300   #only svc_acct can set_usage for now
4301   foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4302     my $svc_x = $cust_svc->svc_x;
4303     $svc_x->recharge($valueref)
4304       if $svc_x->can("recharge");
4305   }
4306 }
4307
4308 =item apply_usageprice
4309
4310 =cut
4311
4312 sub apply_usageprice {
4313   my $self = shift;
4314
4315   my $oldAutoCommit = $FS::UID::AutoCommit;
4316   local $FS::UID::AutoCommit = 0;
4317   my $dbh = dbh;
4318
4319   my $error = '';
4320
4321   foreach my $cust_pkg_usageprice ( $self->cust_pkg_usageprice ) {
4322     $error ||= $cust_pkg_usageprice->apply;
4323   }
4324
4325   if ( $error ) {
4326     $dbh->rollback if $oldAutoCommit;
4327     die "error applying part_pkg_usageprice add-ons, pkgnum ". $self->pkgnum.
4328         ": $error\n";
4329   } else {
4330     $dbh->commit if $oldAutoCommit;
4331   }
4332
4333
4334 }
4335
4336 =item cust_pkg_discount
4337
4338 =item cust_pkg_discount_active
4339
4340 =cut
4341
4342 sub cust_pkg_discount_active {
4343   my $self = shift;
4344   grep { $_->status eq 'active' } $self->cust_pkg_discount;
4345 }
4346
4347 =item cust_pkg_usage
4348
4349 Returns a list of all voice usage counters attached to this package.
4350
4351 =item apply_usage OPTIONS
4352
4353 Takes the following options:
4354 - cdr: a call detail record (L<FS::cdr>)
4355 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
4356 - minutes: the maximum number of minutes to be charged
4357
4358 Finds available usage minutes for a call of this class, and subtracts
4359 up to that many minutes from the usage pool.  If the usage pool is empty,
4360 and the C<cdr-minutes_priority> global config option is set, minutes may
4361 be taken from other calls as well.  Either way, an allocation record will
4362 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
4363 number of minutes of usage applied to the call.
4364
4365 =cut
4366
4367 sub apply_usage {
4368   my ($self, %opt) = @_;
4369   my $cdr = $opt{cdr};
4370   my $rate_detail = $opt{rate_detail};
4371   my $minutes = $opt{minutes};
4372   my $classnum = $rate_detail->classnum;
4373   my $pkgnum = $self->pkgnum;
4374   my $custnum = $self->custnum;
4375
4376   my $oldAutoCommit = $FS::UID::AutoCommit;
4377   local $FS::UID::AutoCommit = 0;
4378   my $dbh = dbh;
4379
4380   my $order = FS::Conf->new->config('cdr-minutes_priority');
4381
4382   my $is_classnum;
4383   if ( $classnum ) {
4384     $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
4385   } else {
4386     $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
4387   }
4388   my @usage_recs = qsearch({
4389       'table'     => 'cust_pkg_usage',
4390       'addl_from' => ' JOIN part_pkg_usage       USING (pkgusagepart)'.
4391                      ' JOIN cust_pkg             USING (pkgnum)'.
4392                      ' JOIN part_pkg_usage_class USING (pkgusagepart)',
4393       'select'    => 'cust_pkg_usage.*',
4394       'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
4395                      " ( cust_pkg.custnum = $custnum AND ".
4396                      " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4397                      $is_classnum . ' AND '.
4398                      " cust_pkg_usage.minutes > 0",
4399       'order_by'  => " ORDER BY priority ASC",
4400   });
4401
4402   my $orig_minutes = $minutes;
4403   my $error;
4404   while (!$error and $minutes > 0 and @usage_recs) {
4405     my $cust_pkg_usage = shift @usage_recs;
4406     $cust_pkg_usage->select_for_update;
4407     my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
4408         pkgusagenum => $cust_pkg_usage->pkgusagenum,
4409         acctid      => $cdr->acctid,
4410         minutes     => min($cust_pkg_usage->minutes, $minutes),
4411     });
4412     $cust_pkg_usage->set('minutes',
4413       $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes
4414     );
4415     $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
4416     $minutes -= $cdr_cust_pkg_usage->minutes;
4417   }
4418   if ( $order and $minutes > 0 and !$error ) {
4419     # then try to steal minutes from another call
4420     my %search = (
4421         'table'     => 'cdr_cust_pkg_usage',
4422         'addl_from' => ' JOIN cust_pkg_usage        USING (pkgusagenum)'.
4423                        ' JOIN part_pkg_usage        USING (pkgusagepart)'.
4424                        ' JOIN cust_pkg              USING (pkgnum)'.
4425                        ' JOIN part_pkg_usage_class  USING (pkgusagepart)'.
4426                        ' JOIN cdr                   USING (acctid)',
4427         'select'    => 'cdr_cust_pkg_usage.*',
4428         'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
4429                        " ( cust_pkg.pkgnum = $pkgnum OR ".
4430                        " ( cust_pkg.custnum = $custnum AND ".
4431                        " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4432                        " part_pkg_usage_class.classnum = $classnum",
4433         'order_by'  => ' ORDER BY part_pkg_usage.priority ASC',
4434     );
4435     if ( $order eq 'time' ) {
4436       # find CDRs that are using minutes, but have a later startdate
4437       # than this call
4438       my $startdate = $cdr->startdate;
4439       if ($startdate !~ /^\d+$/) {
4440         die "bad cdr startdate '$startdate'";
4441       }
4442       $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
4443       # minimize needless reshuffling
4444       $search{'order_by'} .= ', cdr.startdate DESC';
4445     } else {
4446       # XXX may not work correctly with rate_time schedules.  Could
4447       # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
4448       # think...
4449       $search{'addl_from'} .=
4450         ' JOIN rate_detail'.
4451         ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
4452       if ( $order eq 'rate_high' ) {
4453         $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
4454                                 $rate_detail->min_charge;
4455         $search{'order_by'} .= ', rate_detail.min_charge ASC';
4456       } elsif ( $order eq 'rate_low' ) {
4457         $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
4458                                 $rate_detail->min_charge;
4459         $search{'order_by'} .= ', rate_detail.min_charge DESC';
4460       } else {
4461         #  this should really never happen
4462         die "invalid cdr-minutes_priority value '$order'\n";
4463       }
4464     }
4465     my @cdr_usage_recs = qsearch(\%search);
4466     my %reproc_cdrs;
4467     while (!$error and @cdr_usage_recs and $minutes > 0) {
4468       my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
4469       my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
4470       my $old_cdr = $cdr_cust_pkg_usage->cdr;
4471       $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
4472       $cdr_cust_pkg_usage->select_for_update;
4473       $old_cdr->select_for_update;
4474       $cust_pkg_usage->select_for_update;
4475       # in case someone else stole the usage from this CDR
4476       # while waiting for the lock...
4477       next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
4478       # steal the usage allocation and flag the old CDR for reprocessing
4479       $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
4480       # if the allocation is more minutes than we need, adjust it...
4481       my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
4482       if ( $delta > 0 ) {
4483         $cdr_cust_pkg_usage->set('minutes', $minutes);
4484         $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
4485         $error = $cust_pkg_usage->replace;
4486       }
4487       #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
4488       $error ||= $cdr_cust_pkg_usage->replace;
4489       # deduct the stolen minutes
4490       $minutes -= $cdr_cust_pkg_usage->minutes;
4491     }
4492     # after all minute-stealing is done, reset the affected CDRs
4493     foreach (values %reproc_cdrs) {
4494       $error ||= $_->set_status('');
4495       # XXX or should we just call $cdr->rate right here?
4496       # it's not like we can create a loop this way, since the min_charge
4497       # or call time has to go monotonically in one direction.
4498       # we COULD get some very deep recursions going, though...
4499     }
4500   } # if $order and $minutes
4501   if ( $error ) {
4502     $dbh->rollback;
4503     die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
4504   } else {
4505     $dbh->commit if $oldAutoCommit;
4506     return $orig_minutes - $minutes;
4507   }
4508 }
4509
4510 =item supplemental_pkgs
4511
4512 Returns a list of all packages supplemental to this one.
4513
4514 =cut
4515
4516 sub supplemental_pkgs {
4517   my $self = shift;
4518   qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
4519 }
4520
4521 =item main_pkg
4522
4523 Returns the package that this one is supplemental to, if any.
4524
4525 =cut
4526
4527 sub main_pkg {
4528   my $self = shift;
4529   if ( $self->main_pkgnum ) {
4530     return FS::cust_pkg->by_key($self->main_pkgnum);
4531   }
4532   return;
4533 }
4534
4535 =back
4536
4537 =head1 CLASS METHODS
4538
4539 =over 4
4540
4541 =item recurring_sql
4542
4543 Returns an SQL expression identifying recurring packages.
4544
4545 =cut
4546
4547 sub recurring_sql { "
4548   '0' != ( select freq from part_pkg
4549              where cust_pkg.pkgpart = part_pkg.pkgpart )
4550 "; }
4551
4552 =item onetime_sql
4553
4554 Returns an SQL expression identifying one-time packages.
4555
4556 =cut
4557
4558 sub onetime_sql { "
4559   '0' = ( select freq from part_pkg
4560             where cust_pkg.pkgpart = part_pkg.pkgpart )
4561 "; }
4562
4563 =item ordered_sql
4564
4565 Returns an SQL expression identifying ordered packages (recurring packages not
4566 yet billed).
4567
4568 =cut
4569
4570 sub ordered_sql {
4571    $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
4572 }
4573
4574 =item active_sql
4575
4576 Returns an SQL expression identifying active packages.
4577
4578 =cut
4579
4580 sub active_sql {
4581   $_[0]->recurring_sql. "
4582   AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4583   AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4584   AND ( cust_pkg.susp   IS NULL OR cust_pkg.susp   = 0 )
4585 "; }
4586
4587 =item not_yet_billed_sql
4588
4589 Returns an SQL expression identifying packages which have not yet been billed.
4590
4591 =cut
4592
4593 sub not_yet_billed_sql { "
4594       ( cust_pkg.setup  IS NULL OR cust_pkg.setup  = 0 )
4595   AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4596   AND ( cust_pkg.susp   IS NULL OR cust_pkg.susp   = 0 )
4597 "; }
4598
4599 =item inactive_sql
4600
4601 Returns an SQL expression identifying inactive packages (one-time packages
4602 that are otherwise unsuspended/uncancelled).
4603
4604 =cut
4605
4606 sub inactive_sql { "
4607   ". $_[0]->onetime_sql(). "
4608   AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4609   AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4610   AND ( cust_pkg.susp   IS NULL OR cust_pkg.susp   = 0 )
4611 "; }
4612
4613 =item on_hold_sql
4614
4615 Returns an SQL expression identifying on-hold packages.
4616
4617 =cut
4618
4619 sub on_hold_sql {
4620   #$_[0]->recurring_sql(). ' AND '.
4621   "
4622         ( cust_pkg.cancel IS     NULL  OR cust_pkg.cancel  = 0 )
4623     AND   cust_pkg.susp   IS NOT NULL AND cust_pkg.susp   != 0
4624     AND ( cust_pkg.setup  IS     NULL  OR cust_pkg.setup   = 0 )
4625   ";
4626 }
4627
4628 =item susp_sql
4629 =item suspended_sql
4630
4631 Returns an SQL expression identifying suspended packages.
4632
4633 =cut
4634
4635 sub suspended_sql { susp_sql(@_); }
4636 sub susp_sql {
4637   #$_[0]->recurring_sql(). ' AND '.
4638   "
4639         ( cust_pkg.cancel IS     NULL  OR cust_pkg.cancel = 0 )
4640     AND   cust_pkg.susp   IS NOT NULL AND cust_pkg.susp  != 0
4641     AND   cust_pkg.setup  IS NOT NULL AND cust_pkg.setup != 0
4642   ";
4643 }
4644
4645 =item cancel_sql
4646 =item cancelled_sql
4647
4648 Returns an SQL exprression identifying cancelled packages.
4649
4650 =cut
4651
4652 sub cancelled_sql { cancel_sql(@_); }
4653 sub cancel_sql {
4654   #$_[0]->recurring_sql(). ' AND '.
4655   "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
4656 }
4657
4658 =item status_sql
4659
4660 Returns an SQL expression to give the package status as a string.
4661
4662 =cut
4663
4664 sub status_sql {
4665 "CASE
4666   WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
4667   WHEN ( cust_pkg.susp IS NOT NULL AND cust_pkg.setup IS NULL ) THEN 'on hold'
4668   WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
4669   WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
4670   WHEN ".onetime_sql()." THEN 'one-time charge'
4671   ELSE 'active'
4672 END"
4673 }
4674
4675 =item fcc_477_count
4676
4677 Returns a list of two package counts.  The first is a count of packages
4678 based on the supplied criteria and the second is the count of residential
4679 packages with those same criteria.  Criteria are specified as in the search
4680 method.
4681
4682 =cut
4683
4684 sub fcc_477_count {
4685   my ($class, $params) = @_;
4686
4687   my $sql_query = $class->search( $params );
4688
4689   my $count_sql = delete($sql_query->{'count_query'});
4690   $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
4691     or die "couldn't parse count_sql";
4692
4693   my $count_sth = dbh->prepare($count_sql)
4694     or die "Error preparing $count_sql: ". dbh->errstr;
4695   $count_sth->execute
4696     or die "Error executing $count_sql: ". $count_sth->errstr;
4697   my $count_arrayref = $count_sth->fetchrow_arrayref;
4698
4699   return ( @$count_arrayref );
4700
4701 }
4702
4703 =item tax_locationnum_sql
4704
4705 Returns an SQL expression for the tax location for a package, based
4706 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
4707
4708 =cut
4709
4710 sub tax_locationnum_sql {
4711   my $conf = FS::Conf->new;
4712   if ( $conf->exists('tax-pkg_address') ) {
4713     'cust_pkg.locationnum';
4714   }
4715   elsif ( $conf->exists('tax-ship_address') ) {
4716     'cust_main.ship_locationnum';
4717   }
4718   else {
4719     'cust_main.bill_locationnum';
4720   }
4721 }
4722
4723 =item location_sql
4724
4725 Returns a list: the first item is an SQL fragment identifying matching
4726 packages/customers via location (taking into account shipping and package
4727 address taxation, if enabled), and subsequent items are the parameters to
4728 substitute for the placeholders in that fragment.
4729
4730 =cut
4731
4732 sub location_sql {
4733   my($class, %opt) = @_;
4734   my $ornull = $opt{'ornull'};
4735
4736   my $conf = new FS::Conf;
4737
4738   # '?' placeholders in _location_sql_where
4739   my $x = $ornull ? 3 : 2;
4740   my @bill_param = (
4741     ('district')x3,
4742     ('city')x3,
4743     ('county')x$x,
4744     ('state')x$x,
4745     'country'
4746   );
4747
4748   my $main_where;
4749   my @main_param;
4750   if ( $conf->exists('tax-ship_address') ) {
4751
4752     $main_where = "(
4753          (     ( ship_last IS NULL     OR  ship_last  = '' )
4754            AND ". _location_sql_where('cust_main', '', $ornull ). "
4755          )
4756       OR (       ship_last IS NOT NULL AND ship_last != ''
4757            AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
4758          )
4759     )";
4760     #    AND payby != 'COMP'
4761
4762     @main_param = ( @bill_param, @bill_param );
4763
4764   } else {
4765
4766     $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
4767     @main_param = @bill_param;
4768
4769   }
4770
4771   my $where;
4772   my @param;
4773   if ( $conf->exists('tax-pkg_address') ) {
4774
4775     my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
4776
4777     $where = " (
4778                     ( cust_pkg.locationnum IS     NULL AND $main_where )
4779                  OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where  )
4780                )
4781              ";
4782     @param = ( @main_param, @bill_param );
4783
4784   } else {
4785
4786     $where = $main_where;
4787     @param = @main_param;
4788
4789   }
4790
4791   ( $where, @param );
4792
4793 }
4794
4795 #subroutine, helper for location_sql
4796 sub _location_sql_where {
4797   my $table  = shift;
4798   my $prefix = @_ ? shift : '';
4799   my $ornull = @_ ? shift : '';
4800
4801 #  $ornull             = $ornull          ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
4802
4803   $ornull = $ornull ? ' OR ? IS NULL ' : '';
4804
4805   my $or_empty_city     = " OR ( ? = '' AND $table.${prefix}city     IS NULL )";
4806   my $or_empty_county   = " OR ( ? = '' AND $table.${prefix}county   IS NULL )";
4807   my $or_empty_state    = " OR ( ? = '' AND $table.${prefix}state    IS NULL )";
4808
4809   my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
4810
4811 #        ( $table.${prefix}city    = ? $or_empty_city   $ornull )
4812   "
4813         ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4814     AND ( $table.${prefix}city     = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4815     AND ( $table.${prefix}county   = ? $or_empty_county $ornull )
4816     AND ( $table.${prefix}state    = ? $or_empty_state  $ornull )
4817     AND   $table.${prefix}country  = ?
4818   ";
4819 }
4820
4821 sub _X_show_zero {
4822   my( $self, $what ) = @_;
4823
4824   my $what_show_zero = $what. '_show_zero';
4825   length($self->$what_show_zero())
4826     ? ($self->$what_show_zero() eq 'Y')
4827     : $self->part_pkg->$what_show_zero();
4828 }
4829
4830 =head1 SUBROUTINES
4831
4832 =over 4
4833
4834 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
4835
4836 Bulk cancel + order subroutine.  Perhaps slightly deprecated, only used by the
4837 bulk cancel+order in the web UI and nowhere else (edit/process/cust_pkg.cgi)
4838
4839 CUSTNUM is a customer (see L<FS::cust_main>)
4840
4841 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4842 L<FS::part_pkg>) to order for this customer.  Duplicates are of course
4843 permitted.
4844
4845 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
4846 remove for this customer.  The services (see L<FS::cust_svc>) are moved to the
4847 new billing items.  An error is returned if this is not possible (see
4848 L<FS::pkg_svc>).  An empty arrayref is equivalent to not specifying this
4849 parameter.
4850
4851 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4852 newly-created cust_pkg objects.
4853
4854 REFNUM, if specified, will specify the FS::pkg_referral record to be created
4855 and inserted.  Multiple FS::pkg_referral records can be created by
4856 setting I<refnum> to an array reference of refnums or a hash reference with
4857 refnums as keys.  If no I<refnum> is defined, a default FS::pkg_referral
4858 record will be created corresponding to cust_main.refnum.
4859
4860 =cut
4861
4862 sub order {
4863   my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
4864
4865   my $conf = new FS::Conf;
4866
4867   # Transactionize this whole mess
4868   my $oldAutoCommit = $FS::UID::AutoCommit;
4869   local $FS::UID::AutoCommit = 0;
4870   my $dbh = dbh;
4871
4872   my $error;
4873 #  my $cust_main = qsearchs('cust_main', { custnum => $custnum });
4874 #  return "Customer not found: $custnum" unless $cust_main;
4875
4876   warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
4877     if $DEBUG;
4878
4879   my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4880                          @$remove_pkgnum;
4881
4882   my $change = scalar(@old_cust_pkg) != 0;
4883
4884   my %hash = ();
4885   if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
4886
4887     warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
4888          " to pkgpart ". $pkgparts->[0]. "\n"
4889       if $DEBUG;
4890
4891     my $err_or_cust_pkg =
4892       $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
4893                                 'refnum'  => $refnum,
4894                               );
4895
4896     unless (ref($err_or_cust_pkg)) {
4897       $dbh->rollback if $oldAutoCommit;
4898       return $err_or_cust_pkg;
4899     }
4900
4901     push @$return_cust_pkg, $err_or_cust_pkg;
4902     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4903     return '';
4904
4905   }
4906
4907   # Create the new packages.
4908   foreach my $pkgpart (@$pkgparts) {
4909
4910     warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
4911
4912     my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
4913                                       pkgpart => $pkgpart,
4914                                       refnum  => $refnum,
4915                                       %hash,
4916                                     };
4917     $error = $cust_pkg->insert( 'change' => $change );
4918     push @$return_cust_pkg, $cust_pkg;
4919
4920     foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
4921       my $supp_pkg = FS::cust_pkg->new({
4922           custnum => $custnum,
4923           pkgpart => $link->dst_pkgpart,
4924           refnum  => $refnum,
4925           main_pkgnum => $cust_pkg->pkgnum,
4926           %hash,
4927       });
4928       $error ||= $supp_pkg->insert( 'change' => $change );
4929       push @$return_cust_pkg, $supp_pkg;
4930     }
4931
4932     if ($error) {
4933       $dbh->rollback if $oldAutoCommit;
4934       return $error;
4935     }
4936
4937   }
4938   # $return_cust_pkg now contains refs to all of the newly
4939   # created packages.
4940
4941   # Transfer services and cancel old packages.
4942   foreach my $old_pkg (@old_cust_pkg) {
4943
4944     warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
4945       if $DEBUG;
4946
4947     foreach my $new_pkg (@$return_cust_pkg) {
4948       $error = $old_pkg->transfer($new_pkg);
4949       if ($error and $error == 0) {
4950         # $old_pkg->transfer failed.
4951         $dbh->rollback if $oldAutoCommit;
4952         return $error;
4953       }
4954     }
4955
4956     if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
4957       warn "trying transfer again with change_svcpart option\n" if $DEBUG;
4958       foreach my $new_pkg (@$return_cust_pkg) {
4959         $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
4960         if ($error and $error == 0) {
4961           # $old_pkg->transfer failed.
4962         $dbh->rollback if $oldAutoCommit;
4963         return $error;
4964         }
4965       }
4966     }
4967
4968     if ($error > 0) {
4969       # Transfers were successful, but we went through all of the
4970       # new packages and still had services left on the old package.
4971       # We can't cancel the package under the circumstances, so abort.
4972       $dbh->rollback if $oldAutoCommit;
4973       return "Unable to transfer all services from package ".$old_pkg->pkgnum;
4974     }
4975     $error = $old_pkg->cancel( quiet=>1, 'no_delay_cancel'=>1 );
4976     if ($error) {
4977       $dbh->rollback;
4978       return $error;
4979     }
4980   }
4981   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4982   '';
4983 }
4984
4985 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
4986
4987 A bulk change method to change packages for multiple customers.
4988
4989 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4990 L<FS::part_pkg>) to order for each customer.  Duplicates are of course
4991 permitted.
4992
4993 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
4994 replace.  The services (see L<FS::cust_svc>) are moved to the
4995 new billing items.  An error is returned if this is not possible (see
4996 L<FS::pkg_svc>).
4997
4998 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4999 newly-created cust_pkg objects.
5000
5001 =cut
5002
5003 sub bulk_change {
5004   my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
5005
5006   # Transactionize this whole mess
5007   my $oldAutoCommit = $FS::UID::AutoCommit;
5008   local $FS::UID::AutoCommit = 0;
5009   my $dbh = dbh;
5010
5011   my @errors;
5012   my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5013                          @$remove_pkgnum;
5014
5015   while(scalar(@old_cust_pkg)) {
5016     my @return = ();
5017     my $custnum = $old_cust_pkg[0]->custnum;
5018     my (@remove) = map { $_->pkgnum }
5019                    grep { $_->custnum == $custnum } @old_cust_pkg;
5020     @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
5021
5022     my $error = order $custnum, $pkgparts, \@remove, \@return;
5023
5024     push @errors, $error
5025       if $error;
5026     push @$return_cust_pkg, @return;
5027   }
5028
5029   if (scalar(@errors)) {
5030     $dbh->rollback if $oldAutoCommit;
5031     return join(' / ', @errors);
5032   }
5033
5034   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5035   '';
5036 }
5037
5038 =item forward_emails
5039
5040 Returns a hash of svcnums and corresponding email addresses
5041 for svc_acct services that can be used as source or dest
5042 for svc_forward services provisioned in this package.
5043
5044 Accepts options I<svc_forward> OR I<svcnum> for a svc_forward
5045 service;  if included, will ensure the current values of the
5046 specified service are included in the list, even if for some
5047 other reason they wouldn't be.  If called as a class method
5048 with a specified service, returns only these current values.
5049
5050 Caution: does not actually check if svc_forward services are
5051 available to be provisioned on this package.
5052
5053 =cut
5054
5055 sub forward_emails {
5056   my $self = shift;
5057   my %opt = @_;
5058
5059   #load optional service, thoroughly validated
5060   die "Use svcnum or svc_forward, not both"
5061     if $opt{'svcnum'} && $opt{'svc_forward'};
5062   my $svc_forward = $opt{'svc_forward'};
5063   $svc_forward ||= qsearchs('svc_forward',{ 'svcnum' => $opt{'svcnum'} })
5064     if $opt{'svcnum'};
5065   die "Specified service is not a forward service"
5066     if $svc_forward && (ref($svc_forward) ne 'FS::svc_forward');
5067   die "Specified service not found"
5068     if ($opt{'svcnum'} || $opt{'svc_forward'}) && !$svc_forward;
5069
5070   my %email;
5071
5072   ## everything below was basically copied from httemplate/edit/svc_forward.cgi
5073   ## with minimal refactoring, not sure why we can't just load all svc_accts for this custnum
5074
5075   #add current values from specified service, if there was one
5076   if ($svc_forward) {
5077     foreach my $method (qw( srcsvc_acct dstsvc_acct )) {
5078       my $svc_acct = $svc_forward->$method();
5079       $email{$svc_acct->svcnum} = $svc_acct->email if $svc_acct;
5080     }
5081   }
5082
5083   if (ref($self) eq 'FS::cust_pkg') {
5084
5085     #and including the rest for this customer
5086     my($u_part_svc,@u_acct_svcparts);
5087     foreach $u_part_svc ( qsearch('part_svc',{'svcdb'=>'svc_acct'}) ) {
5088       push @u_acct_svcparts,$u_part_svc->getfield('svcpart');
5089     }
5090
5091     my $custnum = $self->getfield('custnum');
5092     foreach my $i_cust_pkg ( qsearch('cust_pkg',{'custnum'=>$custnum}) ) {
5093       my $cust_pkgnum = $i_cust_pkg->getfield('pkgnum');
5094       #now find the corresponding record(s) in cust_svc (for this pkgnum!)
5095       foreach my $acct_svcpart (@u_acct_svcparts) {
5096         foreach my $i_cust_svc (
5097           qsearch( 'cust_svc', { 'pkgnum'  => $cust_pkgnum,
5098                                  'svcpart' => $acct_svcpart } )
5099         ) {
5100           my $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $i_cust_svc->svcnum } );
5101           $email{$svc_acct->svcnum} = $svc_acct->email;
5102         }
5103       }
5104     }
5105   }
5106
5107   return %email;
5108 }
5109
5110 # Used by FS::Upgrade to migrate to a new database.
5111 sub _upgrade_data {  # class method
5112   my ($class, %opts) = @_;
5113   $class->_upgrade_otaker(%opts);
5114   my @statements = (
5115     # RT#10139, bug resulting in contract_end being set when it shouldn't
5116   'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
5117     # RT#10830, bad calculation of prorate date near end of year
5118     # the date range for bill is December 2009, and we move it forward
5119     # one year if it's before the previous bill date (which it should
5120     # never be)
5121   'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
5122   AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
5123   WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
5124     # RT6628, add order_date to cust_pkg
5125     'update cust_pkg set order_date = (select history_date from h_cust_pkg
5126         where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
5127         history_action = \'insert\') where order_date is null',
5128   );
5129   foreach my $sql (@statements) {
5130     my $sth = dbh->prepare($sql);
5131     $sth->execute or die $sth->errstr;
5132   }
5133
5134   # RT31194: supplemental package links that are deleted don't clean up
5135   # linked records
5136   my @pkglinknums = qsearch({
5137       'select'    => 'DISTINCT cust_pkg.pkglinknum',
5138       'table'     => 'cust_pkg',
5139       'addl_from' => ' LEFT JOIN part_pkg_link USING (pkglinknum) ',
5140       'extra_sql' => ' WHERE cust_pkg.pkglinknum IS NOT NULL
5141                         AND part_pkg_link.pkglinknum IS NULL',
5142   });
5143   foreach (@pkglinknums) {
5144     my $pkglinknum = $_->pkglinknum;
5145     warn "cleaning part_pkg_link #$pkglinknum\n";
5146     my $part_pkg_link = FS::part_pkg_link->new({pkglinknum => $pkglinknum});
5147     my $error = $part_pkg_link->remove_linked;
5148     die $error if $error;
5149   }
5150 }
5151
5152 =back
5153
5154 =head1 BUGS
5155
5156 sub order is not OO.  Perhaps it should be moved to FS::cust_main and made so?
5157
5158 In sub order, the @pkgparts array (passed by reference) is clobbered.
5159
5160 Also in sub order, no money is adjusted.  Once FS::part_pkg defines a standard
5161 method to pass dates to the recur_prog expression, it should do so.
5162
5163 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
5164 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
5165 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
5166 configuration values.  Probably need a subroutine which decides what to do
5167 based on whether or not we've fetched the user yet, rather than a hash.  See
5168 FS::UID and the TODO.
5169
5170 Now that things are transactional should the check in the insert method be
5171 moved to check ?
5172
5173 =head1 SEE ALSO
5174
5175 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
5176 L<FS::pkg_svc>, schema.html from the base documentation
5177
5178 =cut
5179
5180 1;
5181