FS/FS/cust_pkg.pm

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