FS/FS/cust_pkg.pm

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