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 cust_svc [ SVCPART ] (old, deprecated usage)
2347
2348 =item cust_svc [ OPTION => VALUE ... ] (current usage)
2349
2350 Returns the services for this package, as FS::cust_svc objects (see
2351 L<FS::cust_svc>).  Available options are svcpart and svcdb.  If either is
2352 spcififed, returns only the matching services.
2353
2354 =cut
2355
2356 sub cust_svc {
2357   my $self = shift;
2358
2359   return () unless $self->num_cust_svc(@_);
2360
2361   my %opt = ();
2362   if ( @_ && $_[0] =~ /^\d+/ ) {
2363     $opt{svcpart} = shift;
2364   } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2365     %opt = %{ $_[0] };
2366   } elsif ( @_ ) {
2367     %opt = @_;
2368   }
2369
2370   my %search = (
2371     'table'   => 'cust_svc',
2372     'hashref' => { 'pkgnum' => $self->pkgnum },
2373   );
2374   if ( $opt{svcpart} ) {
2375     $search{hashref}->{svcpart} = $opt{'svcpart'};
2376   }
2377   if ( $opt{'svcdb'} ) {
2378     $search{addl_from} = ' LEFT JOIN part_svc USING ( svcpart ) ';
2379     $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{'svcdb'} );
2380   }
2381
2382   cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
2383
2384   #if ( $self->{'_svcnum'} ) {
2385   #  values %{ $self->{'_svcnum'}->cache };
2386   #} else {
2387     $self->_sort_cust_svc( [ qsearch(\%search) ] );
2388   #}
2389
2390 }
2391
2392 =item overlimit [ SVCPART ]
2393
2394 Returns the services for this package which have exceeded their
2395 usage limit as FS::cust_svc objects (see L<FS::cust_svc>).  If a svcpart
2396 is specified, return only the matching services.
2397
2398 =cut
2399
2400 sub overlimit {
2401   my $self = shift;
2402   return () unless $self->num_cust_svc(@_);
2403   grep { $_->overlimit } $self->cust_svc(@_);
2404 }
2405
2406 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2407
2408 Returns historical services for this package created before END TIMESTAMP and
2409 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
2410 (see L<FS::h_cust_svc>).  If MODE is 'I' (for 'invoice'), services with the
2411 I<pkg_svc.hidden> flag will be omitted.
2412
2413 =cut
2414
2415 sub h_cust_svc {
2416   my $self = shift;
2417   warn "$me _h_cust_svc called on $self\n"
2418     if $DEBUG;
2419
2420   my ($end, $start, $mode) = @_;
2421   my @cust_svc = $self->_sort_cust_svc(
2422     [ qsearch( 'h_cust_svc',
2423       { 'pkgnum' => $self->pkgnum, },
2424       FS::h_cust_svc->sql_h_search(@_),
2425     ) ]
2426   );
2427   if ( defined($mode) && $mode eq 'I' ) {
2428     my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
2429     return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
2430   } else {
2431     return @cust_svc;
2432   }
2433 }
2434
2435 sub _sort_cust_svc {
2436   my( $self, $arrayref ) = @_;
2437
2438   my $sort =
2439     sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1]  or  $a->[2] <=> $b->[2] };
2440
2441   map  { $_->[0] }
2442   sort $sort
2443   map {
2444         my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $self->pkgpart,
2445                                              'svcpart' => $_->svcpart     } );
2446         [ $_,
2447           $pkg_svc ? $pkg_svc->primary_svc : '',
2448           $pkg_svc ? $pkg_svc->quantity : 0,
2449         ];
2450       }
2451   @$arrayref;
2452
2453 }
2454
2455 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
2456
2457 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
2458
2459 Returns the number of services for this package.  Available options are svcpart
2460 and svcdb.  If either is spcififed, returns only the matching services.
2461
2462 =cut
2463
2464 sub num_cust_svc {
2465   my $self = shift;
2466
2467   return $self->{'_num_cust_svc'}
2468     if !scalar(@_)
2469        && exists($self->{'_num_cust_svc'})
2470        && $self->{'_num_cust_svc'} =~ /\d/;
2471
2472   cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
2473     if $DEBUG > 2;
2474
2475   my %opt = ();
2476   if ( @_ && $_[0] =~ /^\d+/ ) {
2477     $opt{svcpart} = shift;
2478   } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2479     %opt = %{ $_[0] };
2480   } elsif ( @_ ) {
2481     %opt = @_;
2482   }
2483
2484   my $select = 'SELECT COUNT(*) FROM cust_svc ';
2485   my $where = ' WHERE pkgnum = ? ';
2486   my @param = ($self->pkgnum);
2487
2488   if ( $opt{'svcpart'} ) {
2489     $where .= ' AND svcpart = ? ';
2490     push @param, $opt{'svcpart'};
2491   }
2492   if ( $opt{'svcdb'} ) {
2493     $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
2494     $where .= ' AND svcdb = ? ';
2495     push @param, $opt{'svcdb'};
2496   }
2497
2498   my $sth = dbh->prepare("$select $where") or die  dbh->errstr;
2499   $sth->execute(@param) or die $sth->errstr;
2500   $sth->fetchrow_arrayref->[0];
2501 }
2502
2503 =item available_part_svc
2504
2505 Returns a list of FS::part_svc objects representing services included in this
2506 package but not yet provisioned.  Each FS::part_svc object also has an extra
2507 field, I<num_avail>, which specifies the number of available services.
2508
2509 =cut
2510
2511 sub available_part_svc {
2512   my $self = shift;
2513
2514   my $pkg_quantity = $self->quantity || 1;
2515
2516   grep { $_->num_avail > 0 }
2517     map {
2518           my $part_svc = $_->part_svc;
2519           $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
2520             $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
2521
2522           # more evil encapsulation breakage
2523           if($part_svc->{'Hash'}{'num_avail'} > 0) {
2524             my @exports = $part_svc->part_export_did;
2525             $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
2526           }
2527
2528           $part_svc;
2529         }
2530       $self->part_pkg->pkg_svc;
2531 }
2532
2533 =item part_svc [ OPTION => VALUE ... ]
2534
2535 Returns a list of FS::part_svc objects representing provisioned and available
2536 services included in this package.  Each FS::part_svc object also has the
2537 following extra fields:
2538
2539 =over 4
2540
2541 =item num_cust_svc  (count)
2542
2543 =item num_avail     (quantity - count)
2544
2545 =item cust_pkg_svc (services) - array reference containing the provisioned services, as cust_svc objects
2546
2547 =back
2548
2549 Accepts one option: summarize_size.  If specified and non-zero, will omit the
2550 extra cust_pkg_svc option for objects where num_cust_svc is this size or
2551 greater.
2552
2553 =cut
2554
2555 #svcnum
2556 #label -> ($cust_svc->label)[1]
2557
2558 sub part_svc {
2559   my $self = shift;
2560   my %opt = @_;
2561
2562   my $pkg_quantity = $self->quantity || 1;
2563
2564   #XXX some sort of sort order besides numeric by svcpart...
2565   my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
2566     my $pkg_svc = $_;
2567     my $part_svc = $pkg_svc->part_svc;
2568     my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
2569     $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
2570     $part_svc->{'Hash'}{'num_avail'}    =
2571       max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
2572     $part_svc->{'Hash'}{'cust_pkg_svc'} =
2573         $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
2574       unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
2575           && $num_cust_svc >= $opt{summarize_size};
2576     $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
2577     $part_svc;
2578   } $self->part_pkg->pkg_svc;
2579
2580   #extras
2581   push @part_svc, map {
2582     my $part_svc = $_;
2583     my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
2584     $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
2585     $part_svc->{'Hash'}{'num_avail'}    = 0; #0-$num_cust_svc ?
2586     $part_svc->{'Hash'}{'cust_pkg_svc'} =
2587       $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
2588     $part_svc;
2589   } $self->extra_part_svc;
2590
2591   @part_svc;
2592
2593 }
2594
2595 =item extra_part_svc
2596
2597 Returns a list of FS::part_svc objects corresponding to services in this
2598 package which are still provisioned but not (any longer) available in the
2599 package definition.
2600
2601 =cut
2602
2603 sub extra_part_svc {
2604   my $self = shift;
2605
2606   my $pkgnum  = $self->pkgnum;
2607   #my $pkgpart = $self->pkgpart;
2608
2609 #  qsearch( {
2610 #    'table'     => 'part_svc',
2611 #    'hashref'   => {},
2612 #    'extra_sql' =>
2613 #      "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
2614 #                     WHERE pkg_svc.svcpart = part_svc.svcpart
2615 #                       AND pkg_svc.pkgpart = ?
2616 #                       AND quantity > 0
2617 #                 )
2618 #        AND 0 < ( SELECT COUNT(*) FROM cust_svc
2619 #                       LEFT JOIN cust_pkg USING ( pkgnum )
2620 #                     WHERE cust_svc.svcpart = part_svc.svcpart
2621 #                       AND pkgnum = ?
2622 #                 )",
2623 #    'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
2624 #  } );
2625
2626 #seems to benchmark slightly faster... (or did?)
2627
2628   my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
2629   my $pkgparts = join(',', @pkgparts);
2630
2631   qsearch( {
2632     #'select'      => 'DISTINCT ON (svcpart) part_svc.*',
2633     #MySQL doesn't grok DISINCT ON
2634     'select'      => 'DISTINCT part_svc.*',
2635     'table'       => 'part_svc',
2636     'addl_from'   =>
2637       "LEFT JOIN pkg_svc  ON (     pkg_svc.svcpart   = part_svc.svcpart
2638                                AND pkg_svc.pkgpart IN ($pkgparts)
2639                                AND quantity > 0
2640                              )
2641        LEFT JOIN cust_svc ON (     cust_svc.svcpart = part_svc.svcpart )
2642        LEFT JOIN cust_pkg USING ( pkgnum )
2643       ",
2644     'hashref'     => {},
2645     'extra_sql'   => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
2646     'extra_param' => [ [$self->pkgnum=>'int'] ],
2647   } );
2648 }
2649
2650 =item status
2651
2652 Returns a short status string for this package, currently:
2653
2654 =over 4
2655
2656 =item not yet billed
2657
2658 =item one-time charge
2659
2660 =item active
2661
2662 =item suspended
2663
2664 =item cancelled
2665
2666 =back
2667
2668 =cut
2669
2670 sub status {
2671   my $self = shift;
2672
2673   my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
2674
2675   return 'cancelled' if $self->get('cancel');
2676   return 'suspended' if $self->susp;
2677   return 'not yet billed' unless $self->setup;
2678   return 'one-time charge' if $freq =~ /^(0|$)/;
2679   return 'active';
2680 }
2681
2682 =item ucfirst_status
2683
2684 Returns the status with the first character capitalized.
2685
2686 =cut
2687
2688 sub ucfirst_status {
2689   ucfirst(shift->status);
2690 }
2691
2692 =item statuses
2693
2694 Class method that returns the list of possible status strings for packages
2695 (see L<the status method|/status>).  For example:
2696
2697   @statuses = FS::cust_pkg->statuses();
2698
2699 =cut
2700
2701 tie my %statuscolor, 'Tie::IxHash',
2702   'not yet billed'  => '009999', #teal? cyan?
2703   'one-time charge' => '000000',
2704   'active'          => '00CC00',
2705   'suspended'       => 'FF9900',
2706   'cancelled'       => 'FF0000',
2707 ;
2708
2709 sub statuses {
2710   my $self = shift; #could be class...
2711   #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
2712   #                                    # mayble split btw one-time vs. recur
2713     keys %statuscolor;
2714 }
2715
2716 =item statuscolor
2717
2718 Returns a hex triplet color string for this package's status.
2719
2720 =cut
2721
2722 sub statuscolor {
2723   my $self = shift;
2724   $statuscolor{$self->status};
2725 }
2726
2727 =item pkg_label
2728
2729 Returns a label for this package.  (Currently "pkgnum: pkg - comment" or
2730 "pkg - comment" depending on user preference).
2731
2732 =cut
2733
2734 sub pkg_label {
2735   my $self = shift;
2736   my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
2737   $label = $self->pkgnum. ": $label"
2738     if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
2739   $label;
2740 }
2741
2742 =item pkg_label_long
2743
2744 Returns a long label for this package, adding the primary service's label to
2745 pkg_label.
2746
2747 =cut
2748
2749 sub pkg_label_long {
2750   my $self = shift;
2751   my $label = $self->pkg_label;
2752   my $cust_svc = $self->primary_cust_svc;
2753   $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
2754   $label;
2755 }
2756
2757 =item pkg_locale
2758
2759 Returns a customer-localized label for this package.
2760
2761 =cut
2762
2763 sub pkg_locale {
2764   my $self = shift;
2765   $self->part_pkg->pkg_locale( $self->cust_main->locale );
2766 }
2767
2768 =item primary_cust_svc
2769
2770 Returns a primary service (as FS::cust_svc object) if one can be identified.
2771
2772 =cut
2773
2774 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
2775
2776 sub primary_cust_svc {
2777   my $self = shift;
2778
2779   my @cust_svc = $self->cust_svc;
2780
2781   return '' unless @cust_svc; #no serivces - irrelevant then
2782
2783   return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
2784
2785   # primary service as specified in the package definition
2786   # or exactly one service definition with quantity one
2787   my $svcpart = $self->part_pkg->svcpart;
2788   @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
2789   return $cust_svc[0] if scalar(@cust_svc) == 1;
2790
2791   #couldn't identify one thing..
2792   return '';
2793 }
2794
2795 =item labels
2796
2797 Returns a list of lists, calling the label method for all services
2798 (see L<FS::cust_svc>) of this billing item.
2799
2800 =cut
2801
2802 sub labels {
2803   my $self = shift;
2804   map { [ $_->label ] } $self->cust_svc;
2805 }
2806
2807 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2808
2809 Like the labels method, but returns historical information on services that
2810 were active as of END_TIMESTAMP and (optionally) not cancelled before
2811 START_TIMESTAMP.  If MODE is 'I' (for 'invoice'), services with the
2812 I<pkg_svc.hidden> flag will be omitted.
2813
2814 Returns a list of lists, calling the label method for all (historical) services
2815 (see L<FS::h_cust_svc>) of this billing item.
2816
2817 =cut
2818
2819 sub h_labels {
2820   my $self = shift;
2821   warn "$me _h_labels called on $self\n"
2822     if $DEBUG;
2823   map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
2824 }
2825
2826 =item labels_short
2827
2828 Like labels, except returns a simple flat list, and shortens long
2829 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2830 identical services to one line that lists the service label and the number of
2831 individual services rather than individual items.
2832
2833 =cut
2834
2835 sub labels_short {
2836   shift->_labels_short( 'labels', @_ );
2837 }
2838
2839 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
2840
2841 Like h_labels, except returns a simple flat list, and shortens long
2842 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2843 identical services to one line that lists the service label and the number of
2844 individual services rather than individual items.
2845
2846 =cut
2847
2848 sub h_labels_short {
2849   shift->_labels_short( 'h_labels', @_ );
2850 }
2851
2852 sub _labels_short {
2853   my( $self, $method ) = ( shift, shift );
2854
2855   warn "$me _labels_short called on $self with $method method\n"
2856     if $DEBUG;
2857
2858   my $conf = new FS::Conf;
2859   my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
2860
2861   warn "$me _labels_short populating \%labels\n"
2862     if $DEBUG;
2863
2864   my %labels;
2865   #tie %labels, 'Tie::IxHash';
2866   push @{ $labels{$_->[0]} }, $_->[1]
2867     foreach $self->$method(@_);
2868
2869   warn "$me _labels_short populating \@labels\n"
2870     if $DEBUG;
2871
2872   my @labels;
2873   foreach my $label ( keys %labels ) {
2874     my %seen = ();
2875     my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
2876     my $num = scalar(@values);
2877     warn "$me _labels_short $num items for $label\n"
2878       if $DEBUG;
2879
2880     if ( $num > $max_same_services ) {
2881       warn "$me _labels_short   more than $max_same_services, so summarizing\n"
2882         if $DEBUG;
2883       push @labels, "$label ($num)";
2884     } else {
2885       if ( $conf->exists('cust_bill-consolidate_services') ) {
2886         warn "$me _labels_short   consolidating services\n"
2887           if $DEBUG;
2888         # push @labels, "$label: ". join(', ', @values);
2889         while ( @values ) {
2890           my $detail = "$label: ";
2891           $detail .= shift(@values). ', '
2892             while @values
2893                && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
2894           $detail =~ s/, $//;
2895           push @labels, $detail;
2896         }
2897         warn "$me _labels_short   done consolidating services\n"
2898           if $DEBUG;
2899       } else {
2900         warn "$me _labels_short   adding service data\n"
2901           if $DEBUG;
2902         push @labels, map { "$label: $_" } @values;
2903       }
2904     }
2905   }
2906
2907  @labels;
2908
2909 }
2910
2911 =item cust_main
2912
2913 Returns the parent customer object (see L<FS::cust_main>).
2914
2915 =cut
2916
2917 sub cust_main {
2918   my $self = shift;
2919   qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
2920 }
2921
2922 =item balance
2923
2924 Returns the balance for this specific package, when using
2925 experimental package balance.
2926
2927 =cut
2928
2929 sub balance {
2930   my $self = shift;
2931   $self->cust_main->balance_pkgnum( $self->pkgnum );
2932 }
2933
2934 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
2935
2936 =item cust_location
2937
2938 Returns the location object, if any (see L<FS::cust_location>).
2939
2940 =item cust_location_or_main
2941
2942 If this package is associated with a location, returns the locaiton (see
2943 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
2944
2945 =item location_label [ OPTION => VALUE ... ]
2946
2947 Returns the label of the location object (see L<FS::cust_location>).
2948
2949 =cut
2950
2951 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
2952
2953 =item tax_locationnum
2954
2955 Returns the foreign key to a L<FS::cust_location> object for calculating
2956 tax on this package, as determined by the C<tax-pkg_address> and
2957 C<tax-ship_address> configuration flags.
2958
2959 =cut
2960
2961 sub tax_locationnum {
2962   my $self = shift;
2963   my $conf = FS::Conf->new;
2964   if ( $conf->exists('tax-pkg_address') ) {
2965     return $self->locationnum;
2966   }
2967   elsif ( $conf->exists('tax-ship_address') ) {
2968     return $self->cust_main->ship_locationnum;
2969   }
2970   else {
2971     return $self->cust_main->bill_locationnum;
2972   }
2973 }
2974
2975 =item tax_location
2976
2977 Returns the L<FS::cust_location> object for tax_locationnum.
2978
2979 =cut
2980
2981 sub tax_location {
2982   my $self = shift;
2983   FS::cust_location->by_key( $self->tax_locationnum )
2984 }
2985
2986 =item seconds_since TIMESTAMP
2987
2988 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
2989 package have been online since TIMESTAMP, according to the session monitor.
2990
2991 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
2992 L<Time::Local> and L<Date::Parse> for conversion functions.
2993
2994 =cut
2995
2996 sub seconds_since {
2997   my($self, $since) = @_;
2998   my $seconds = 0;
2999
3000   foreach my $cust_svc (
3001     grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
3002   ) {
3003     $seconds += $cust_svc->seconds_since($since);
3004   }
3005
3006   $seconds;
3007
3008 }
3009
3010 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
3011
3012 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
3013 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
3014 (exclusive).
3015
3016 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3017 L<perlfunc/"time">.  Also see L<Time::Local> and L<Date::Parse> for conversion
3018 functions.
3019
3020
3021 =cut
3022
3023 sub seconds_since_sqlradacct {
3024   my($self, $start, $end) = @_;
3025
3026   my $seconds = 0;
3027
3028   foreach my $cust_svc (
3029     grep {
3030       my $part_svc = $_->part_svc;
3031       $part_svc->svcdb eq 'svc_acct'
3032         && scalar($part_svc->part_export_usage);
3033     } $self->cust_svc
3034   ) {
3035     $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
3036   }
3037
3038   $seconds;
3039
3040 }
3041
3042 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
3043
3044 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
3045 in this package for sessions ending between TIMESTAMP_START (inclusive) and
3046 TIMESTAMP_END
3047 (exclusive).
3048
3049 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3050 L<perlfunc/"time">.  Also see L<Time::Local> and L<Date::Parse> for conversion
3051 functions.
3052
3053 =cut
3054
3055 sub attribute_since_sqlradacct {
3056   my($self, $start, $end, $attrib) = @_;
3057
3058   my $sum = 0;
3059
3060   foreach my $cust_svc (
3061     grep {
3062       my $part_svc = $_->part_svc;
3063       $part_svc->svcdb eq 'svc_acct'
3064         && scalar($part_svc->part_export_usage);
3065     } $self->cust_svc
3066   ) {
3067     $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
3068   }
3069
3070   $sum;
3071
3072 }
3073
3074 =item quantity
3075
3076 =cut
3077
3078 sub quantity {
3079   my( $self, $value ) = @_;
3080   if ( defined($value) ) {
3081     $self->setfield('quantity', $value);
3082   }
3083   $self->getfield('quantity') || 1;
3084 }
3085
3086 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
3087
3088 Transfers as many services as possible from this package to another package.
3089
3090 The destination package can be specified by pkgnum by passing an FS::cust_pkg
3091 object.  The destination package must already exist.
3092
3093 Services are moved only if the destination allows services with the correct
3094 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true.  Use
3095 this option with caution!  No provision is made for export differences
3096 between the old and new service definitions.  Probably only should be used
3097 when your exports for all service definitions of a given svcdb are identical.
3098 (attempt a transfer without it first, to move all possible svcpart-matching
3099 services)
3100
3101 Any services that can't be moved remain in the original package.
3102
3103 Returns an error, if there is one; otherwise, returns the number of services
3104 that couldn't be moved.
3105
3106 =cut
3107
3108 sub transfer {
3109   my ($self, $dest_pkgnum, %opt) = @_;
3110
3111   my $remaining = 0;
3112   my $dest;
3113   my %target;
3114
3115   if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
3116     $dest = $dest_pkgnum;
3117     $dest_pkgnum = $dest->pkgnum;
3118   } else {
3119     $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
3120   }
3121
3122   return ('Package does not exist: '.$dest_pkgnum) unless $dest;
3123
3124   foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
3125     $target{$pkg_svc->svcpart} = $pkg_svc->quantity;
3126   }
3127
3128   foreach my $cust_svc ($dest->cust_svc) {
3129     $target{$cust_svc->svcpart}--;
3130   }
3131
3132   my %svcpart2svcparts = ();
3133   if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3134     warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
3135     foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
3136       next if exists $svcpart2svcparts{$svcpart};
3137       my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
3138       $svcpart2svcparts{$svcpart} = [
3139         map  { $_->[0] }
3140         sort { $b->[1] cmp $a->[1]  or  $a->[2] <=> $b->[2] }
3141         map {
3142               my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
3143                                                    'svcpart' => $_          } );
3144               [ $_,
3145                 $pkg_svc ? $pkg_svc->primary_svc : '',
3146                 $pkg_svc ? $pkg_svc->quantity : 0,
3147               ];
3148             }
3149
3150         grep { $_ != $svcpart }
3151         map  { $_->svcpart }
3152         qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
3153       ];
3154       warn "alternates for svcpart $svcpart: ".
3155            join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
3156         if $DEBUG;
3157     }
3158   }
3159
3160   foreach my $cust_svc ($self->cust_svc) {
3161     if($target{$cust_svc->svcpart} > 0
3162        or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
3163       $target{$cust_svc->svcpart}--;
3164       my $new = new FS::cust_svc { $cust_svc->hash };
3165       $new->pkgnum($dest_pkgnum);
3166       my $error = $new->replace($cust_svc);
3167       return $error if $error;
3168     } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3169       if ( $DEBUG ) {
3170         warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
3171         warn "alternates to consider: ".
3172              join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
3173       }
3174       my @alternate = grep {
3175                              warn "considering alternate svcpart $_: ".
3176                                   "$target{$_} available in new package\n"
3177                                if $DEBUG;
3178                              $target{$_} > 0;
3179                            } @{$svcpart2svcparts{$cust_svc->svcpart}};
3180       if ( @alternate ) {
3181         warn "alternate(s) found\n" if $DEBUG;
3182         my $change_svcpart = $alternate[0];
3183         $target{$change_svcpart}--;
3184         my $new = new FS::cust_svc { $cust_svc->hash };
3185         $new->svcpart($change_svcpart);
3186         $new->pkgnum($dest_pkgnum);
3187         my $error = $new->replace($cust_svc);
3188         return $error if $error;
3189       } else {
3190         $remaining++;
3191       }
3192     } else {
3193       $remaining++
3194     }
3195   }
3196   return $remaining;
3197 }
3198
3199 =item grab_svcnums SVCNUM, SVCNUM ...
3200
3201 Change the pkgnum for the provided services to this packages.  If there is an
3202 error, returns the error, otherwise returns false.
3203
3204 =cut
3205
3206 sub grab_svcnums {
3207   my $self = shift;
3208   my @svcnum = @_;
3209
3210   local $SIG{HUP} = 'IGNORE';
3211   local $SIG{INT} = 'IGNORE';
3212   local $SIG{QUIT} = 'IGNORE';
3213   local $SIG{TERM} = 'IGNORE';
3214   local $SIG{TSTP} = 'IGNORE';
3215   local $SIG{PIPE} = 'IGNORE';
3216
3217   my $oldAutoCommit = $FS::UID::AutoCommit;
3218   local $FS::UID::AutoCommit = 0;
3219   my $dbh = dbh;
3220
3221   foreach my $svcnum (@svcnum) {
3222     my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
3223       $dbh->rollback if $oldAutoCommit;
3224       return "unknown svcnum $svcnum";
3225     };
3226     $cust_svc->pkgnum( $self->pkgnum );
3227     my $error = $cust_svc->replace;
3228     if ( $error ) {
3229       $dbh->rollback if $oldAutoCommit;
3230       return $error;
3231     }
3232   }
3233
3234   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3235   '';
3236
3237 }
3238
3239 =item reexport
3240
3241 This method is deprecated.  See the I<depend_jobnum> option to the insert and
3242 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
3243
3244 =cut
3245
3246 sub reexport {
3247   my $self = shift;
3248
3249   local $SIG{HUP} = 'IGNORE';
3250   local $SIG{INT} = 'IGNORE';
3251   local $SIG{QUIT} = 'IGNORE';
3252   local $SIG{TERM} = 'IGNORE';
3253   local $SIG{TSTP} = 'IGNORE';
3254   local $SIG{PIPE} = 'IGNORE';
3255
3256   my $oldAutoCommit = $FS::UID::AutoCommit;
3257   local $FS::UID::AutoCommit = 0;
3258   my $dbh = dbh;
3259
3260   foreach my $cust_svc ( $self->cust_svc ) {
3261     #false laziness w/svc_Common::insert
3262     my $svc_x = $cust_svc->svc_x;
3263     foreach my $part_export ( $cust_svc->part_svc->part_export ) {
3264       my $error = $part_export->export_insert($svc_x);
3265       if ( $error ) {
3266         $dbh->rollback if $oldAutoCommit;
3267         return $error;
3268       }
3269     }
3270   }
3271
3272   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3273   '';
3274
3275 }
3276
3277 =item insert_reason
3278
3279 Associates this package with a (suspension or cancellation) reason (see
3280 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
3281 L<FS::reason>).
3282
3283 Available options are:
3284
3285 =over 4
3286
3287 =item reason
3288
3289 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.
3290
3291 =item reason_otaker
3292
3293 the access_user (see L<FS::access_user>) providing the reason
3294
3295 =item date
3296
3297 a unix timestamp
3298
3299 =item action
3300
3301 the action (cancel, susp, adjourn, expire) associated with the reason
3302
3303 =back
3304
3305 If there is an error, returns the error, otherwise returns false.
3306
3307 =cut
3308
3309 sub insert_reason {
3310   my ($self, %options) = @_;
3311
3312   my $otaker = $options{reason_otaker} ||
3313                $FS::CurrentUser::CurrentUser->username;
3314
3315   my $reasonnum;
3316   if ( $options{'reason'} =~ /^(\d+)$/ ) {
3317
3318     $reasonnum = $1;
3319
3320   } elsif ( ref($options{'reason'}) ) {
3321
3322     return 'Enter a new reason (or select an existing one)'
3323       unless $options{'reason'}->{'reason'} !~ /^\s*$/;
3324
3325     my $reason = new FS::reason({
3326       'reason_type' => $options{'reason'}->{'typenum'},
3327       'reason'      => $options{'reason'}->{'reason'},
3328     });
3329     my $error = $reason->insert;
3330     return $error if $error;
3331
3332     $reasonnum = $reason->reasonnum;
3333
3334   } else {
3335     return "Unparsable reason: ". $options{'reason'};
3336   }
3337
3338   my $cust_pkg_reason =
3339     new FS::cust_pkg_reason({ 'pkgnum'    => $self->pkgnum,
3340                               'reasonnum' => $reasonnum,
3341                               'otaker'    => $otaker,
3342                               'action'    => substr(uc($options{'action'}),0,1),
3343                               'date'      => $options{'date'}
3344                                                ? $options{'date'}
3345                                                : time,
3346                             });
3347
3348   $cust_pkg_reason->insert;
3349 }
3350
3351 =item insert_discount
3352
3353 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
3354 inserting a new discount on the fly (see L<FS::discount>).
3355
3356 Available options are:
3357
3358 =over 4
3359
3360 =item discountnum
3361
3362 =back
3363
3364 If there is an error, returns the error, otherwise returns false.
3365
3366 =cut
3367
3368 sub insert_discount {
3369   #my ($self, %options) = @_;
3370   my $self = shift;
3371
3372   my $cust_pkg_discount = new FS::cust_pkg_discount {
3373     'pkgnum'      => $self->pkgnum,
3374     'discountnum' => $self->discountnum,
3375     'months_used' => 0,
3376     'end_date'    => '', #XXX
3377     #for the create a new discount case
3378     '_type'       => $self->discountnum__type,
3379     'amount'      => $self->discountnum_amount,
3380     'percent'     => $self->discountnum_percent,
3381     'months'      => $self->discountnum_months,
3382     'setup'      => $self->discountnum_setup,
3383     #'disabled'    => $self->discountnum_disabled,
3384   };
3385
3386   $cust_pkg_discount->insert;
3387 }
3388
3389 =item set_usage USAGE_VALUE_HASHREF
3390
3391 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
3392 to which they should be set (see L<FS::svc_acct>).  Currently seconds,
3393 upbytes, downbytes, and totalbytes are appropriate keys.
3394
3395 All svc_accts which are part of this package have their values reset.
3396
3397 =cut
3398
3399 sub set_usage {
3400   my ($self, $valueref, %opt) = @_;
3401
3402   #only svc_acct can set_usage for now
3403   foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
3404     my $svc_x = $cust_svc->svc_x;
3405     $svc_x->set_usage($valueref, %opt)
3406       if $svc_x->can("set_usage");
3407   }
3408 }
3409
3410 =item recharge USAGE_VALUE_HASHREF
3411
3412 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
3413 to which they should be set (see L<FS::svc_acct>).  Currently seconds,
3414 upbytes, downbytes, and totalbytes are appropriate keys.
3415
3416 All svc_accts which are part of this package have their values incremented.
3417
3418 =cut
3419
3420 sub recharge {
3421   my ($self, $valueref) = @_;
3422
3423   #only svc_acct can set_usage for now
3424   foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
3425     my $svc_x = $cust_svc->svc_x;
3426     $svc_x->recharge($valueref)
3427       if $svc_x->can("recharge");
3428   }
3429 }
3430
3431 =item cust_pkg_discount
3432
3433 =cut
3434
3435 sub cust_pkg_discount {
3436   my $self = shift;
3437   qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
3438 }
3439
3440 =item cust_pkg_discount_active
3441
3442 =cut
3443
3444 sub cust_pkg_discount_active {
3445   my $self = shift;
3446   grep { $_->status eq 'active' } $self->cust_pkg_discount;
3447 }
3448
3449 =item cust_pkg_usage
3450
3451 Returns a list of all voice usage counters attached to this package.
3452
3453 =cut
3454
3455 sub cust_pkg_usage {
3456   my $self = shift;
3457   qsearch('cust_pkg_usage', { pkgnum => $self->pkgnum });
3458 }
3459
3460 =item apply_usage OPTIONS
3461
3462 Takes the following options:
3463 - cdr: a call detail record (L<FS::cdr>)
3464 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
3465 - minutes: the maximum number of minutes to be charged
3466
3467 Finds available usage minutes for a call of this class, and subtracts
3468 up to that many minutes from the usage pool.  If the usage pool is empty,
3469 and the C<cdr-minutes_priority> global config option is set, minutes may
3470 be taken from other calls as well.  Either way, an allocation record will
3471 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
3472 number of minutes of usage applied to the call.
3473
3474 =cut
3475
3476 sub apply_usage {
3477   my ($self, %opt) = @_;
3478   my $cdr = $opt{cdr};
3479   my $rate_detail = $opt{rate_detail};
3480   my $minutes = $opt{minutes};
3481   my $classnum = $rate_detail->classnum;
3482   my $pkgnum = $self->pkgnum;
3483   my $custnum = $self->custnum;
3484
3485   local $SIG{HUP} = 'IGNORE';
3486   local $SIG{INT} = 'IGNORE';
3487   local $SIG{QUIT} = 'IGNORE';
3488   local $SIG{TERM} = 'IGNORE';
3489   local $SIG{TSTP} = 'IGNORE';
3490   local $SIG{PIPE} = 'IGNORE';
3491
3492   my $oldAutoCommit = $FS::UID::AutoCommit;
3493   local $FS::UID::AutoCommit = 0;
3494   my $dbh = dbh;
3495   my $order = FS::Conf->new->config('cdr-minutes_priority');
3496
3497   my $is_classnum;
3498   if ( $classnum ) {
3499     $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
3500   } else {
3501     $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
3502   }
3503   my @usage_recs = qsearch({
3504       'table'     => 'cust_pkg_usage',
3505       'addl_from' => ' JOIN part_pkg_usage       USING (pkgusagepart)'.
3506                      ' JOIN cust_pkg             USING (pkgnum)'.
3507                      ' JOIN part_pkg_usage_class USING (pkgusagepart)',
3508       'select'    => 'cust_pkg_usage.*',
3509       'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
3510                      " ( cust_pkg.custnum = $custnum AND ".
3511                      " part_pkg_usage.shared IS NOT NULL ) ) AND ".
3512                      $is_classnum . ' AND '.
3513                      " cust_pkg_usage.minutes > 0",
3514       'order_by'  => " ORDER BY priority ASC",
3515   });
3516
3517   my $orig_minutes = $minutes;
3518   my $error;
3519   while (!$error and $minutes > 0 and @usage_recs) {
3520     my $cust_pkg_usage = shift @usage_recs;
3521     $cust_pkg_usage->select_for_update;
3522     my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
3523         pkgusagenum => $cust_pkg_usage->pkgusagenum,
3524         acctid      => $cdr->acctid,
3525         minutes     => min($cust_pkg_usage->minutes, $minutes),
3526     });
3527     $cust_pkg_usage->set('minutes',
3528       sprintf('%.0f', $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes)
3529     );
3530     $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
3531     $minutes -= $cdr_cust_pkg_usage->minutes;
3532   }
3533   if ( $order and $minutes > 0 and !$error ) {
3534     # then try to steal minutes from another call
3535     my %search = (
3536         'table'     => 'cdr_cust_pkg_usage',
3537         'addl_from' => ' JOIN cust_pkg_usage        USING (pkgusagenum)'.
3538                        ' JOIN part_pkg_usage        USING (pkgusagepart)'.
3539                        ' JOIN cust_pkg              USING (pkgnum)'.
3540                        ' JOIN part_pkg_usage_class  USING (pkgusagepart)'.
3541                        ' JOIN cdr                   USING (acctid)',
3542         'select'    => 'cdr_cust_pkg_usage.*',
3543         'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
3544                        " ( cust_pkg.pkgnum = $pkgnum OR ".
3545                        " ( cust_pkg.custnum = $custnum AND ".
3546                        " part_pkg_usage.shared IS NOT NULL ) ) AND ".
3547                        " part_pkg_usage_class.classnum = $classnum",
3548         'order_by'  => ' ORDER BY part_pkg_usage.priority ASC',
3549     );
3550     if ( $order eq 'time' ) {
3551       # find CDRs that are using minutes, but have a later startdate
3552       # than this call
3553       my $startdate = $cdr->startdate;
3554       if ($startdate !~ /^\d+$/) {
3555         die "bad cdr startdate '$startdate'";
3556       }
3557       $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
3558       # minimize needless reshuffling
3559       $search{'order_by'} .= ', cdr.startdate DESC';
3560     } else {
3561       # XXX may not work correctly with rate_time schedules.  Could
3562       # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
3563       # think...
3564       $search{'addl_from'} .=
3565         ' JOIN rate_detail'.
3566         ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
3567       if ( $order eq 'rate_high' ) {
3568         $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
3569                                 $rate_detail->min_charge;
3570         $search{'order_by'} .= ', rate_detail.min_charge ASC';
3571       } elsif ( $order eq 'rate_low' ) {
3572         $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
3573                                 $rate_detail->min_charge;
3574         $search{'order_by'} .= ', rate_detail.min_charge DESC';
3575       } else {
3576         #  this should really never happen
3577         die "invalid cdr-minutes_priority value '$order'\n";
3578       }
3579     }
3580     my @cdr_usage_recs = qsearch(\%search);
3581     my %reproc_cdrs;
3582     while (!$error and @cdr_usage_recs and $minutes > 0) {
3583       my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
3584       my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
3585       my $old_cdr = $cdr_cust_pkg_usage->cdr;
3586       $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
3587       $cdr_cust_pkg_usage->select_for_update;
3588       $old_cdr->select_for_update;
3589       $cust_pkg_usage->select_for_update;
3590       # in case someone else stole the usage from this CDR
3591       # while waiting for the lock...
3592       next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
3593       # steal the usage allocation and flag the old CDR for reprocessing
3594       $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
3595       # if the allocation is more minutes than we need, adjust it...
3596       my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
3597       if ( $delta > 0 ) {
3598         $cdr_cust_pkg_usage->set('minutes', $minutes);
3599         $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
3600         $error = $cust_pkg_usage->replace;
3601       }
3602       #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
3603       $error ||= $cdr_cust_pkg_usage->replace;
3604       # deduct the stolen minutes
3605       $minutes -= $cdr_cust_pkg_usage->minutes;
3606     }
3607     # after all minute-stealing is done, reset the affected CDRs
3608     foreach (values %reproc_cdrs) {
3609       $error ||= $_->set_status('');
3610       # XXX or should we just call $cdr->rate right here?
3611       # it's not like we can create a loop this way, since the min_charge
3612       # or call time has to go monotonically in one direction.
3613       # we COULD get some very deep recursions going, though...
3614     }
3615   } # if $order and $minutes
3616   if ( $error ) {
3617     $dbh->rollback;
3618     die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
3619   } else {
3620     $dbh->commit if $oldAutoCommit;
3621     return $orig_minutes - $minutes;
3622   }
3623 }
3624
3625 =item supplemental_pkgs
3626
3627 Returns a list of all packages supplemental to this one.
3628
3629 =cut
3630
3631 sub supplemental_pkgs {
3632   my $self = shift;
3633   qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
3634 }
3635
3636 =item main_pkg
3637
3638 Returns the package that this one is supplemental to, if any.
3639
3640 =cut
3641
3642 sub main_pkg {
3643   my $self = shift;
3644   if ( $self->main_pkgnum ) {
3645     return FS::cust_pkg->by_key($self->main_pkgnum);
3646   }
3647   return;
3648 }
3649
3650 =back
3651
3652 =head1 CLASS METHODS
3653
3654 =over 4
3655
3656 =item recurring_sql
3657
3658 Returns an SQL expression identifying recurring packages.
3659
3660 =cut
3661
3662 sub recurring_sql { "
3663   '0' != ( select freq from part_pkg
3664              where cust_pkg.pkgpart = part_pkg.pkgpart )
3665 "; }
3666
3667 =item onetime_sql
3668
3669 Returns an SQL expression identifying one-time packages.
3670
3671 =cut
3672
3673 sub onetime_sql { "
3674   '0' = ( select freq from part_pkg
3675             where cust_pkg.pkgpart = part_pkg.pkgpart )
3676 "; }
3677
3678 =item ordered_sql
3679
3680 Returns an SQL expression identifying ordered packages (recurring packages not
3681 yet billed).
3682
3683 =cut
3684
3685 sub ordered_sql {
3686    $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
3687 }
3688
3689 =item active_sql
3690
3691 Returns an SQL expression identifying active packages.
3692
3693 =cut
3694
3695 sub active_sql {
3696   $_[0]->recurring_sql. "
3697   AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
3698   AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3699   AND ( cust_pkg.susp   IS NULL OR cust_pkg.susp   = 0 )
3700 "; }
3701
3702 =item not_yet_billed_sql
3703
3704 Returns an SQL expression identifying packages which have not yet been billed.
3705
3706 =cut
3707
3708 sub not_yet_billed_sql { "
3709       ( cust_pkg.setup  IS NULL OR cust_pkg.setup  = 0 )
3710   AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3711   AND ( cust_pkg.susp   IS NULL OR cust_pkg.susp   = 0 )
3712 "; }
3713
3714 =item inactive_sql
3715
3716 Returns an SQL expression identifying inactive packages (one-time packages
3717 that are otherwise unsuspended/uncancelled).
3718
3719 =cut
3720
3721 sub inactive_sql { "
3722   ". $_[0]->onetime_sql(). "
3723   AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
3724   AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3725   AND ( cust_pkg.susp   IS NULL OR cust_pkg.susp   = 0 )
3726 "; }
3727
3728 =item susp_sql
3729 =item suspended_sql
3730
3731 Returns an SQL expression identifying suspended packages.
3732
3733 =cut
3734
3735 sub suspended_sql { susp_sql(@_); }
3736 sub susp_sql {
3737   #$_[0]->recurring_sql(). ' AND '.
3738   "
3739         ( cust_pkg.cancel IS     NULL  OR cust_pkg.cancel = 0 )
3740     AND   cust_pkg.susp   IS NOT NULL AND cust_pkg.susp  != 0
3741   ";
3742 }
3743
3744 =item cancel_sql
3745 =item cancelled_sql
3746
3747 Returns an SQL exprression identifying cancelled packages.
3748
3749 =cut
3750
3751 sub cancelled_sql { cancel_sql(@_); }
3752 sub cancel_sql {
3753   #$_[0]->recurring_sql(). ' AND '.
3754   "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
3755 }
3756
3757 =item status_sql
3758
3759 Returns an SQL expression to give the package status as a string.
3760
3761 =cut
3762
3763 sub status_sql {
3764 "CASE
3765   WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
3766   WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
3767   WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
3768   WHEN ".onetime_sql()." THEN 'one-time charge'
3769   ELSE 'active'
3770 END"
3771 }
3772
3773 =item search HASHREF
3774
3775 (Class method)
3776
3777 Returns a qsearch hash expression to search for parameters specified in HASHREF.
3778 Valid parameters are
3779
3780 =over 4
3781
3782 =item agentnum
3783
3784 =item magic
3785
3786 active, inactive, suspended, cancel (or cancelled)
3787
3788 =item status
3789
3790 active, inactive, suspended, one-time charge, inactive, cancel (or cancelled)
3791
3792 =item custom
3793
3794  boolean selects custom packages
3795
3796 =item classnum
3797
3798 =item pkgpart
3799
3800 pkgpart or arrayref or hashref of pkgparts
3801
3802 =item setup
3803
3804 arrayref of beginning and ending epoch date
3805
3806 =item last_bill
3807
3808 arrayref of beginning and ending epoch date
3809
3810 =item bill
3811
3812 arrayref of beginning and ending epoch date
3813
3814 =item adjourn
3815
3816 arrayref of beginning and ending epoch date
3817
3818 =item susp
3819
3820 arrayref of beginning and ending epoch date
3821
3822 =item expire
3823
3824 arrayref of beginning and ending epoch date
3825
3826 =item cancel
3827
3828 arrayref of beginning and ending epoch date
3829
3830 =item query
3831
3832 pkgnum or APKG_pkgnum
3833
3834 =item cust_fields
3835
3836 a value suited to passing to FS::UI::Web::cust_header
3837
3838 =item CurrentUser
3839
3840 specifies the user for agent virtualization
3841
3842 =item fcc_line
3843
3844 boolean; if true, returns only packages with more than 0 FCC phone lines.
3845
3846 =item state, country
3847
3848 Limit to packages with a service location in the specified state and country.
3849 For FCC 477 reporting, mostly.
3850
3851 =back
3852
3853 =cut
3854
3855 sub search {
3856   my ($class, $params) = @_;
3857   my @where = ();
3858
3859   ##
3860   # parse agent
3861   ##
3862
3863   if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
3864     push @where,
3865       "cust_main.agentnum = $1";
3866   }
3867
3868   ##
3869   # parse custnum
3870   ##
3871
3872   if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
3873     push @where,
3874       "cust_pkg.custnum = $1";
3875   }
3876
3877   ##
3878   # custbatch
3879   ##
3880
3881   if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
3882     push @where,
3883       "cust_pkg.pkgbatch = '$1'";
3884   }
3885
3886   ##
3887   # parse status
3888   ##
3889
3890   if (    $params->{'magic'}  eq 'active'
3891        || $params->{'status'} eq 'active' ) {
3892
3893     push @where, FS::cust_pkg->active_sql();
3894
3895   } elsif (    $params->{'magic'}  =~ /^not[ _]yet[ _]billed$/
3896             || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
3897
3898     push @where, FS::cust_pkg->not_yet_billed_sql();
3899
3900   } elsif (    $params->{'magic'}  =~ /^(one-time charge|inactive)/
3901             || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
3902
3903     push @where, FS::cust_pkg->inactive_sql();
3904
3905   } elsif (    $params->{'magic'}  eq 'suspended'
3906             || $params->{'status'} eq 'suspended'  ) {
3907
3908     push @where, FS::cust_pkg->suspended_sql();
3909
3910   } elsif (    $params->{'magic'}  =~ /^cancell?ed$/
3911             || $params->{'status'} =~ /^cancell?ed$/ ) {
3912
3913     push @where, FS::cust_pkg->cancelled_sql();
3914
3915   }
3916
3917   ###
3918   # parse package class
3919   ###
3920
3921   if ( exists($params->{'classnum'}) ) {
3922
3923     my @classnum = ();
3924     if ( ref($params->{'classnum'}) ) {
3925
3926       if ( ref($params->{'classnum'}) eq 'HASH' ) {
3927         @classnum = grep $params->{'classnum'}{$_}, keys %{ $params->{'classnum'} };
3928       } elsif ( ref($params->{'classnum'}) eq 'ARRAY' ) {
3929         @classnum = @{ $params->{'classnum'} };
3930       } else {
3931         die 'unhandled classnum ref '. $params->{'classnum'};
3932       }
3933
3934
3935     } elsif ( $params->{'classnum'} =~ /^(\d*)$/ && $1 ne '0' ) {
3936       @classnum = ( $1 );
3937     }
3938
3939     if ( @classnum ) {
3940
3941       my @c_where = ();
3942       my @nums = grep $_, @classnum;
3943       push @c_where, 'part_pkg.classnum IN ('. join(',',@nums). ')' if @nums;
3944       my $null = scalar( grep { $_ eq '' } @classnum );
3945       push @c_where, 'part_pkg.classnum IS NULL' if $null;
3946
3947       if ( scalar(@c_where) == 1 ) {
3948         push @where, @c_where;
3949       } elsif ( @c_where ) {
3950         push @where, ' ( '. join(' OR ', @c_where). ' ) ';
3951       }
3952
3953     }
3954
3955
3956   }
3957
3958   ###
3959   # parse package report options
3960   ###
3961
3962   my @report_option = ();
3963   if ( exists($params->{'report_option'}) ) {
3964     if ( ref($params->{'report_option'}) eq 'ARRAY' ) {
3965       @report_option = @{ $params->{'report_option'} };
3966     } elsif ( $params->{'report_option'} =~ /^([,\d]*)$/ ) {
3967       @report_option = split(',', $1);
3968     }
3969
3970   }
3971
3972   if (@report_option) {
3973     # this will result in the empty set for the dangling comma case as it should
3974     push @where,
3975       map{ "0 < ( SELECT count(*) FROM part_pkg_option
3976                     WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
3977                     AND optionname = 'report_option_$_'
3978                     AND optionvalue = '1' )"
3979          } @report_option;
3980   }
3981
3982   foreach my $any ( grep /^report_option_any/, keys %$params ) {
3983
3984     my @report_option_any = ();
3985     if ( ref($params->{$any}) eq 'ARRAY' ) {
3986       @report_option_any = @{ $params->{$any} };
3987     } elsif ( $params->{$any} =~ /^([,\d]*)$/ ) {
3988       @report_option_any = split(',', $1);
3989     }
3990
3991     if (@report_option_any) {
3992       # this will result in the empty set for the dangling comma case as it should
3993       push @where, ' ( '. join(' OR ',
3994         map{ "0 < ( SELECT count(*) FROM part_pkg_option
3995                       WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
3996                       AND optionname = 'report_option_$_'
3997                       AND optionvalue = '1' )"
3998            } @report_option_any
3999       ). ' ) ';
4000     }
4001
4002   }
4003
4004   ###
4005   # parse custom
4006   ###
4007
4008   push @where,  "part_pkg.custom = 'Y'" if $params->{custom};
4009
4010   ###
4011   # parse fcc_line
4012   ###
4013
4014   push @where,  "(part_pkg.fcc_ds0s > 0 OR pkg_class.fcc_ds0s > 0)"
4015                                                         if $params->{fcc_line};
4016
4017   ###
4018   # parse censustract
4019   ###
4020
4021   if ( exists($params->{'censustract'}) ) {
4022     $params->{'censustract'} =~ /^([.\d]*)$/;
4023     my $censustract = "cust_location.censustract = '$1'";
4024     $censustract .= ' OR cust_location.censustract is NULL' unless $1;
4025     push @where,  "( $censustract )";
4026   }
4027
4028   ###
4029   # parse censustract2
4030   ###
4031   if ( exists($params->{'censustract2'})
4032        && $params->{'censustract2'} =~ /^(\d*)$/
4033      )
4034   {
4035     if ($1) {
4036       push @where, "cust_location.censustract LIKE '$1%'";
4037     } else {
4038       push @where,
4039         "( cust_location.censustract = '' OR cust_location.censustract IS NULL )";
4040     }
4041   }
4042
4043   ###
4044   # parse country/state
4045   ###
4046   for (qw(state country)) { # parsing rules are the same for these
4047   if ( exists($params->{$_})
4048     && uc($params->{$_}) =~ /^([A-Z]{2})$/ )
4049     {
4050       # XXX post-2.3 only--before that, state/country may be in cust_main
4051       push @where, "cust_location.$_ = '$1'";
4052     }
4053   }
4054
4055   ###
4056   # parse part_pkg
4057   ###
4058
4059   if ( ref($params->{'pkgpart'}) ) {
4060
4061     my @pkgpart = ();
4062     if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
4063       @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
4064     } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
4065       @pkgpart = @{ $params->{'pkgpart'} };
4066     } else {
4067       die 'unhandled pkgpart ref '. $params->{'pkgpart'};
4068     }
4069
4070     @pkgpart = grep /^(\d+)$/, @pkgpart;
4071
4072     push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
4073
4074   } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
4075     push @where, "pkgpart = $1";
4076   }
4077
4078   ###
4079   # parse dates
4080   ###
4081
4082   my $orderby = '';
4083
4084   #false laziness w/report_cust_pkg.html
4085   my %disable = (
4086     'all'             => {},
4087     'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
4088     'active'          => { 'susp'=>1, 'cancel'=>1 },
4089     'suspended'       => { 'cancel' => 1 },
4090     'cancelled'       => {},
4091     ''                => {},
4092   );
4093
4094   if( exists($params->{'active'} ) ) {
4095     # This overrides all the other date-related fields
4096     my($beginning, $ending) = @{$params->{'active'}};
4097     push @where,
4098       "cust_pkg.setup IS NOT NULL",
4099       "cust_pkg.setup <= $ending",
4100       "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
4101       "NOT (".FS::cust_pkg->onetime_sql . ")";
4102   }
4103   else {
4104     foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end change_date cancel )) {
4105
4106       next unless exists($params->{$field});
4107
4108       my($beginning, $ending) = @{$params->{$field}};
4109
4110       next if $beginning == 0 && $ending == 4294967295;
4111
4112       push @where,
4113         "cust_pkg.$field IS NOT NULL",
4114         "cust_pkg.$field >= $beginning",
4115         "cust_pkg.$field <= $ending";
4116
4117       $orderby ||= "ORDER BY cust_pkg.$field";
4118
4119     }
4120   }
4121
4122   $orderby ||= 'ORDER BY bill';
4123
4124   ###
4125   # parse magic, legacy, etc.
4126   ###
4127
4128   if ( $params->{'magic'} &&
4129        $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
4130   ) {
4131
4132     $orderby = 'ORDER BY pkgnum';
4133
4134     if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
4135       push @where, "pkgpart = $1";
4136     }
4137
4138   } elsif ( $params->{'query'} eq 'pkgnum' ) {
4139
4140     $orderby = 'ORDER BY pkgnum';
4141
4142   } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
4143
4144     $orderby = 'ORDER BY pkgnum';
4145
4146     push @where, '0 < (
4147       SELECT count(*) FROM pkg_svc
4148        WHERE pkg_svc.pkgpart =  cust_pkg.pkgpart
4149          AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
4150                                    WHERE cust_svc.pkgnum  = cust_pkg.pkgnum
4151                                      AND cust_svc.svcpart = pkg_svc.svcpart
4152                                 )
4153     )';
4154
4155   }
4156
4157   ##
4158   # setup queries, links, subs, etc. for the search
4159   ##
4160
4161   # here is the agent virtualization
4162   if ($params->{CurrentUser}) {
4163     my $access_user =
4164       qsearchs('access_user', { username => $params->{CurrentUser} });
4165
4166     if ($access_user) {
4167       push @where, $access_user->agentnums_sql('table'=>'cust_main');
4168     } else {
4169       push @where, "1=0";
4170     }
4171   } else {
4172     push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
4173   }
4174
4175   my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
4176
4177   my $addl_from = 'LEFT JOIN part_pkg  USING ( pkgpart  ) '.
4178                   'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) '.
4179                   'LEFT JOIN cust_location USING ( locationnum ) '.
4180                   FS::UI::Web::join_cust_main('cust_pkg', 'cust_pkg');
4181
4182   my $select;
4183   my $count_query;
4184   if ( $params->{'select_zip5'} ) {
4185     my $zip = 'cust_location.zip';
4186
4187     $select = "DISTINCT substr($zip,1,5) as zip";
4188     $orderby = "ORDER BY substr($zip,1,5)";
4189     $count_query = "SELECT COUNT( DISTINCT substr($zip,1,5) )";
4190   } else {
4191     $select = join(', ',
4192                          'cust_pkg.*',
4193                          ( map "part_pkg.$_", qw( pkg freq ) ),
4194                          'pkg_class.classname',
4195                          'cust_main.custnum AS cust_main_custnum',
4196                          FS::UI::Web::cust_sql_fields(
4197                            $params->{'cust_fields'}
4198                          ),
4199                   );
4200     $count_query = 'SELECT COUNT(*)';
4201   }
4202
4203   $count_query .= " FROM cust_pkg $addl_from $extra_sql";
4204
4205   my $sql_query = {
4206     'table'       => 'cust_pkg',
4207     'hashref'     => {},
4208     'select'      => $select,
4209     'extra_sql'   => $extra_sql,
4210     'order_by'    => $orderby,
4211     'addl_from'   => $addl_from,
4212     'count_query' => $count_query,
4213   };
4214
4215 }
4216
4217 =item fcc_477_count
4218
4219 Returns a list of two package counts.  The first is a count of packages
4220 based on the supplied criteria and the second is the count of residential
4221 packages with those same criteria.  Criteria are specified as in the search
4222 method.
4223
4224 =cut
4225
4226 sub fcc_477_count {
4227   my ($class, $params) = @_;
4228
4229   my $sql_query = $class->search( $params );
4230
4231   my $count_sql = delete($sql_query->{'count_query'});
4232   $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
4233     or die "couldn't parse count_sql";
4234
4235   my $count_sth = dbh->prepare($count_sql)
4236     or die "Error preparing $count_sql: ". dbh->errstr;
4237   $count_sth->execute
4238     or die "Error executing $count_sql: ". $count_sth->errstr;
4239   my $count_arrayref = $count_sth->fetchrow_arrayref;
4240
4241   return ( @$count_arrayref );
4242
4243 }
4244
4245 =item tax_locationnum_sql
4246
4247 Returns an SQL expression for the tax location for a package, based
4248 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
4249
4250 =cut
4251
4252 sub tax_locationnum_sql {
4253   my $conf = FS::Conf->new;
4254   if ( $conf->exists('tax-pkg_address') ) {
4255     'cust_pkg.locationnum';
4256   }
4257   elsif ( $conf->exists('tax-ship_address') ) {
4258     'cust_main.ship_locationnum';
4259   }
4260   else {
4261     'cust_main.bill_locationnum';
4262   }
4263 }
4264
4265 =item location_sql
4266
4267 Returns a list: the first item is an SQL fragment identifying matching
4268 packages/customers via location (taking into account shipping and package
4269 address taxation, if enabled), and subsequent items are the parameters to
4270 substitute for the placeholders in that fragment.
4271
4272 =cut
4273
4274 sub location_sql {
4275   my($class, %opt) = @_;
4276   my $ornull = $opt{'ornull'};
4277
4278   my $conf = new FS::Conf;
4279
4280   # '?' placeholders in _location_sql_where
4281   my $x = $ornull ? 3 : 2;
4282   my @bill_param = (
4283     ('district')x3,
4284     ('city')x3,
4285     ('county')x$x,
4286     ('state')x$x,
4287     'country'
4288   );
4289
4290   my $main_where;
4291   my @main_param;
4292   if ( $conf->exists('tax-ship_address') ) {
4293
4294     $main_where = "(
4295          (     ( ship_last IS NULL     OR  ship_last  = '' )
4296            AND ". _location_sql_where('cust_main', '', $ornull ). "
4297          )
4298       OR (       ship_last IS NOT NULL AND ship_last != ''
4299            AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
4300          )
4301     )";
4302     #    AND payby != 'COMP'
4303
4304     @main_param = ( @bill_param, @bill_param );
4305
4306   } else {
4307
4308     $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
4309     @main_param = @bill_param;
4310
4311   }
4312
4313   my $where;
4314   my @param;
4315   if ( $conf->exists('tax-pkg_address') ) {
4316
4317     my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
4318
4319     $where = " (
4320                     ( cust_pkg.locationnum IS     NULL AND $main_where )
4321                  OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where  )
4322                )
4323              ";
4324     @param = ( @main_param, @bill_param );
4325
4326   } else {
4327
4328     $where = $main_where;
4329     @param = @main_param;
4330
4331   }
4332
4333   ( $where, @param );
4334
4335 }
4336
4337 #subroutine, helper for location_sql
4338 sub _location_sql_where {
4339   my $table  = shift;
4340   my $prefix = @_ ? shift : '';
4341   my $ornull = @_ ? shift : '';
4342
4343 #  $ornull             = $ornull          ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
4344
4345   $ornull = $ornull ? ' OR ? IS NULL ' : '';
4346
4347   my $or_empty_city     = " OR ( ? = '' AND $table.${prefix}city     IS NULL )";
4348   my $or_empty_county   = " OR ( ? = '' AND $table.${prefix}county   IS NULL )";
4349   my $or_empty_state    = " OR ( ? = '' AND $table.${prefix}state    IS NULL )";
4350
4351   my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
4352
4353 #        ( $table.${prefix}city    = ? $or_empty_city   $ornull )
4354   "
4355         ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4356     AND ( $table.${prefix}city     = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4357     AND ( $table.${prefix}county   = ? $or_empty_county $ornull )
4358     AND ( $table.${prefix}state    = ? $or_empty_state  $ornull )
4359     AND   $table.${prefix}country  = ?
4360   ";
4361 }
4362
4363 sub _X_show_zero {
4364   my( $self, $what ) = @_;
4365
4366   my $what_show_zero = $what. '_show_zero';
4367   length($self->$what_show_zero())
4368     ? ($self->$what_show_zero() eq 'Y')
4369     : $self->part_pkg->$what_show_zero();
4370 }
4371
4372 =head1 SUBROUTINES
4373
4374 =over 4
4375
4376 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
4377
4378 CUSTNUM is a customer (see L<FS::cust_main>)
4379
4380 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4381 L<FS::part_pkg>) to order for this customer.  Duplicates are of course
4382 permitted.
4383
4384 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
4385 remove for this customer.  The services (see L<FS::cust_svc>) are moved to the
4386 new billing items.  An error is returned if this is not possible (see
4387 L<FS::pkg_svc>).  An empty arrayref is equivalent to not specifying this
4388 parameter.
4389
4390 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4391 newly-created cust_pkg objects.
4392
4393 REFNUM, if specified, will specify the FS::pkg_referral record to be created
4394 and inserted.  Multiple FS::pkg_referral records can be created by
4395 setting I<refnum> to an array reference of refnums or a hash reference with
4396 refnums as keys.  If no I<refnum> is defined, a default FS::pkg_referral
4397 record will be created corresponding to cust_main.refnum.
4398
4399 =cut
4400
4401 sub order {
4402   my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
4403
4404   my $conf = new FS::Conf;
4405
4406   # Transactionize this whole mess
4407   local $SIG{HUP} = 'IGNORE';
4408   local $SIG{INT} = 'IGNORE';
4409   local $SIG{QUIT} = 'IGNORE';
4410   local $SIG{TERM} = 'IGNORE';
4411   local $SIG{TSTP} = 'IGNORE';
4412   local $SIG{PIPE} = 'IGNORE';
4413
4414   my $oldAutoCommit = $FS::UID::AutoCommit;
4415   local $FS::UID::AutoCommit = 0;
4416   my $dbh = dbh;
4417
4418   my $error;
4419 #  my $cust_main = qsearchs('cust_main', { custnum => $custnum });
4420 #  return "Customer not found: $custnum" unless $cust_main;
4421
4422   warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
4423     if $DEBUG;
4424
4425   my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4426                          @$remove_pkgnum;
4427
4428   my $change = scalar(@old_cust_pkg) != 0;
4429
4430   my %hash = ();
4431   if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
4432
4433     warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
4434          " to pkgpart ". $pkgparts->[0]. "\n"
4435       if $DEBUG;
4436
4437     my $err_or_cust_pkg =
4438       $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
4439                                 'refnum'  => $refnum,
4440                               );
4441
4442     unless (ref($err_or_cust_pkg)) {
4443       $dbh->rollback if $oldAutoCommit;
4444       return $err_or_cust_pkg;
4445     }
4446
4447     push @$return_cust_pkg, $err_or_cust_pkg;
4448     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4449     return '';
4450
4451   }
4452
4453   # Create the new packages.
4454   foreach my $pkgpart (@$pkgparts) {
4455
4456     warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
4457
4458     my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
4459                                       pkgpart => $pkgpart,
4460                                       refnum  => $refnum,
4461                                       %hash,
4462                                     };
4463     $error = $cust_pkg->insert( 'change' => $change );
4464     push @$return_cust_pkg, $cust_pkg;
4465
4466     foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
4467       my $supp_pkg = FS::cust_pkg->new({
4468           custnum => $custnum,
4469           pkgpart => $link->dst_pkgpart,
4470           refnum  => $refnum,
4471           main_pkgnum => $cust_pkg->pkgnum,
4472           %hash,
4473       });
4474       $error ||= $supp_pkg->insert( 'change' => $change );
4475       push @$return_cust_pkg, $supp_pkg;
4476     }
4477
4478     if ($error) {
4479       $dbh->rollback if $oldAutoCommit;
4480       return $error;
4481     }
4482
4483   }
4484   # $return_cust_pkg now contains refs to all of the newly
4485   # created packages.
4486
4487   # Transfer services and cancel old packages.
4488   foreach my $old_pkg (@old_cust_pkg) {
4489
4490     warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
4491       if $DEBUG;
4492
4493     foreach my $new_pkg (@$return_cust_pkg) {
4494       $error = $old_pkg->transfer($new_pkg);
4495       if ($error and $error == 0) {
4496         # $old_pkg->transfer failed.
4497         $dbh->rollback if $oldAutoCommit;
4498         return $error;
4499       }
4500     }
4501
4502     if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
4503       warn "trying transfer again with change_svcpart option\n" if $DEBUG;
4504       foreach my $new_pkg (@$return_cust_pkg) {
4505         $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
4506         if ($error and $error == 0) {
4507           # $old_pkg->transfer failed.
4508         $dbh->rollback if $oldAutoCommit;
4509         return $error;
4510         }
4511       }
4512     }
4513
4514     if ($error > 0) {
4515       # Transfers were successful, but we went through all of the
4516       # new packages and still had services left on the old package.
4517       # We can't cancel the package under the circumstances, so abort.
4518       $dbh->rollback if $oldAutoCommit;
4519       return "Unable to transfer all services from package ".$old_pkg->pkgnum;
4520     }
4521     $error = $old_pkg->cancel( quiet=>1 );
4522     if ($error) {
4523       $dbh->rollback;
4524       return $error;
4525     }
4526   }
4527   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4528   '';
4529 }
4530
4531 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
4532
4533 A bulk change method to change packages for multiple customers.
4534
4535 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4536 L<FS::part_pkg>) to order for each customer.  Duplicates are of course
4537 permitted.
4538
4539 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
4540 replace.  The services (see L<FS::cust_svc>) are moved to the
4541 new billing items.  An error is returned if this is not possible (see
4542 L<FS::pkg_svc>).
4543
4544 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4545 newly-created cust_pkg objects.
4546
4547 =cut
4548
4549 sub bulk_change {
4550   my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
4551
4552   # Transactionize this whole mess
4553   local $SIG{HUP} = 'IGNORE';
4554   local $SIG{INT} = 'IGNORE';
4555   local $SIG{QUIT} = 'IGNORE';
4556   local $SIG{TERM} = 'IGNORE';
4557   local $SIG{TSTP} = 'IGNORE';
4558   local $SIG{PIPE} = 'IGNORE';
4559
4560   my $oldAutoCommit = $FS::UID::AutoCommit;
4561   local $FS::UID::AutoCommit = 0;
4562   my $dbh = dbh;
4563
4564   my @errors;
4565   my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4566                          @$remove_pkgnum;
4567
4568   while(scalar(@old_cust_pkg)) {
4569     my @return = ();
4570     my $custnum = $old_cust_pkg[0]->custnum;
4571     my (@remove) = map { $_->pkgnum }
4572                    grep { $_->custnum == $custnum } @old_cust_pkg;
4573     @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
4574
4575     my $error = order $custnum, $pkgparts, \@remove, \@return;
4576
4577     push @errors, $error
4578       if $error;
4579     push @$return_cust_pkg, @return;
4580   }
4581
4582   if (scalar(@errors)) {
4583     $dbh->rollback if $oldAutoCommit;
4584     return join(' / ', @errors);
4585   }
4586
4587   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4588   '';
4589 }
4590
4591 # Used by FS::Upgrade to migrate to a new database.
4592 sub _upgrade_data {  # class method
4593   my ($class, %opts) = @_;
4594   $class->_upgrade_otaker(%opts);
4595   my @statements = (
4596     # RT#10139, bug resulting in contract_end being set when it shouldn't
4597   'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
4598     # RT#10830, bad calculation of prorate date near end of year
4599     # the date range for bill is December 2009, and we move it forward
4600     # one year if it's before the previous bill date (which it should
4601     # never be)
4602   'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
4603   AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
4604   WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
4605     # RT6628, add order_date to cust_pkg
4606     'update cust_pkg set order_date = (select history_date from h_cust_pkg
4607         where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
4608         history_action = \'insert\') where order_date is null',
4609   );
4610   foreach my $sql (@statements) {
4611     my $sth = dbh->prepare($sql);
4612     $sth->execute or die $sth->errstr;
4613   }
4614 }
4615
4616 =back
4617
4618 =head1 BUGS
4619
4620 sub order is not OO.  Perhaps it should be moved to FS::cust_main and made so?
4621
4622 In sub order, the @pkgparts array (passed by reference) is clobbered.
4623
4624 Also in sub order, no money is adjusted.  Once FS::part_pkg defines a standard
4625 method to pass dates to the recur_prog expression, it should do so.
4626
4627 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
4628 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
4629 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
4630 configuration values.  Probably need a subroutine which decides what to do
4631 based on whether or not we've fetched the user yet, rather than a hash.  See
4632 FS::UID and the TODO.
4633
4634 Now that things are transactional should the check in the insert method be
4635 moved to check ?
4636
4637 =head1 SEE ALSO
4638
4639 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
4640 L<FS::pkg_svc>, schema.html from the base documentation
4641
4642 =cut
4643
4644 1;
4645