4 use base qw( FS::otaker_Mixin FS::cust_main_Mixin FS::location_Mixin
5 FS::m2m_Common FS::option_Common );
6 use vars qw($disable_agentcheck $DEBUG $me);
8 use Scalar::Util qw( blessed );
9 use List::Util qw(max);
11 use Time::Local qw( timelocal_nocheck );
13 use FS::UID qw( getotaker dbh );
14 use FS::Misc qw( send_email );
15 use FS::Record qw( qsearch qsearchs );
20 use FS::cust_location;
22 use FS::cust_bill_pkg;
23 use FS::cust_pkg_detail;
28 use FS::cust_pkg_reason;
30 use FS::cust_pkg_discount;
34 # need to 'use' these instead of 'require' in sub { cancel, suspend, unsuspend,
36 # because they load configuration by setting FS::UID::callback (see TODO)
42 # for sending cancel emails in sub cancel
46 $me = '[FS::cust_pkg]';
48 $disable_agentcheck = 0;
52 my ( $hashref, $cache ) = @_;
53 #if ( $hashref->{'pkgpart'} ) {
54 if ( $hashref->{'pkg'} ) {
55 # #@{ $self->{'_pkgnum'} } = ();
56 # my $subcache = $cache->subcache('pkgpart', 'part_pkg');
57 # $self->{'_pkgpart'} = $subcache;
58 # #push @{ $self->{'_pkgnum'} },
59 # FS::part_pkg->new_or_cached($hashref, $subcache);
60 $self->{'_pkgpart'} = FS::part_pkg->new($hashref);
62 if ( exists $hashref->{'svcnum'} ) {
63 #@{ $self->{'_pkgnum'} } = ();
64 my $subcache = $cache->subcache('svcnum', 'cust_svc', $hashref->{pkgnum});
65 $self->{'_svcnum'} = $subcache;
66 #push @{ $self->{'_pkgnum'} },
67 FS::cust_svc->new_or_cached($hashref, $subcache) if $hashref->{svcnum};
73 FS::cust_pkg - Object methods for cust_pkg objects
79 $record = new FS::cust_pkg \%hash;
80 $record = new FS::cust_pkg { 'column' => 'value' };
82 $error = $record->insert;
84 $error = $new_record->replace($old_record);
86 $error = $record->delete;
88 $error = $record->check;
90 $error = $record->cancel;
92 $error = $record->suspend;
94 $error = $record->unsuspend;
96 $part_pkg = $record->part_pkg;
98 @labels = $record->labels;
100 $seconds = $record->seconds_since($timestamp);
102 $error = FS::cust_pkg::order( $custnum, \@pkgparts );
103 $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );
107 An FS::cust_pkg object represents a customer billing item. FS::cust_pkg
108 inherits from FS::Record. The following fields are currently supported:
114 Primary key (assigned automatically for new billing items)
118 Customer (see L<FS::cust_main>)
122 Billing item definition (see L<FS::part_pkg>)
126 Optional link to package location (see L<FS::location>)
130 date package was ordered (also remains same on changes)
142 date (next bill date)
170 order taker (see L<FS::access_user>)
174 If this field is set to 1, disables the automatic
175 unsuspension of this package when using the B<unsuspendauto> config option.
179 If not set, defaults to 1
183 Date of change from previous package
193 =item change_locationnum
199 Note: setup, last_bill, bill, adjourn, susp, expire, cancel and change_date
200 are specified as UNIX timestamps; see L<perlfunc/"time">. Also see
201 L<Time::Local> and L<Date::Parse> for conversion functions.
209 Create a new billing item. To add the item to the database, see L<"insert">.
213 sub table { 'cust_pkg'; }
214 sub cust_linked { $_[0]->cust_main_custnum; }
215 sub cust_unlinked_msg {
217 "WARNING: can't find cust_main.custnum ". $self->custnum.
218 ' (cust_pkg.pkgnum '. $self->pkgnum. ')';
221 =item insert [ OPTION => VALUE ... ]
223 Adds this billing item to the database ("Orders" the item). If there is an
224 error, returns the error, otherwise returns false.
226 If the additional field I<promo_code> is defined instead of I<pkgpart>, it
227 will be used to look up the package definition and agent restrictions will be
230 If the additional field I<refnum> is defined, an FS::pkg_referral record will
231 be created and inserted. Multiple FS::pkg_referral records can be created by
232 setting I<refnum> to an array reference of refnums or a hash reference with
233 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
234 record will be created corresponding to cust_main.refnum.
236 The following options are available:
242 If set true, supresses any referral credit to a referring customer.
246 cust_pkg_option records will be created
250 a ticket will be added to this customer with this subject
254 an optional queue name for ticket additions
261 my( $self, %options ) = @_;
263 if ( $self->part_pkg->option('start_1st', 1) && !$self->start_date ) {
264 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime(time) )[0,1,2,3,4,5];
265 $mon += 1 unless $mday == 1;
266 until ( $mon < 12 ) { $mon -= 12; $year++; }
267 $self->start_date( timelocal_nocheck(0,0,0,1,$mon,$year) );
270 foreach my $action ( qw(expire adjourn contract_end) ) {
271 my $months = $self->part_pkg->option("${action}_months",1);
272 if($months and !$self->$action) {
273 my $start = $self->start_date || $self->setup || time;
274 $self->$action( $self->part_pkg->add_freq($start, $months) );
278 $self->order_date(time);
280 local $SIG{HUP} = 'IGNORE';
281 local $SIG{INT} = 'IGNORE';
282 local $SIG{QUIT} = 'IGNORE';
283 local $SIG{TERM} = 'IGNORE';
284 local $SIG{TSTP} = 'IGNORE';
285 local $SIG{PIPE} = 'IGNORE';
287 my $oldAutoCommit = $FS::UID::AutoCommit;
288 local $FS::UID::AutoCommit = 0;
291 my $error = $self->SUPER::insert($options{options} ? %{$options{options}} : ());
293 $dbh->rollback if $oldAutoCommit;
297 $self->refnum($self->cust_main->refnum) unless $self->refnum;
298 $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
299 $self->process_m2m( 'link_table' => 'pkg_referral',
300 'target_table' => 'part_referral',
301 'params' => $self->refnum,
304 if ( $self->discountnum ) {
305 my $error = $self->insert_discount();
307 $dbh->rollback if $oldAutoCommit;
312 #if ( $self->reg_code ) {
313 # my $reg_code = qsearchs('reg_code', { 'code' => $self->reg_code } );
314 # $error = $reg_code->delete;
316 # $dbh->rollback if $oldAutoCommit;
321 my $conf = new FS::Conf;
323 if ( $conf->config('ticket_system') && $options{ticket_subject} ) {
326 # use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
333 use FS::TicketSystem;
334 FS::TicketSystem->init();
336 my $q = new RT::Queue($RT::SystemUser);
337 $q->Load($options{ticket_queue}) if $options{ticket_queue};
338 my $t = new RT::Ticket($RT::SystemUser);
339 my $mime = new MIME::Entity;
340 $mime->build( Type => 'text/plain', Data => $options{ticket_subject} );
341 $t->Create( $options{ticket_queue} ? (Queue => $q) : (),
342 Subject => $options{ticket_subject},
345 $t->AddLink( Type => 'MemberOf',
346 Target => 'freeside://freeside/cust_main/'. $self->custnum,
350 if ($conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
351 my $queue = new FS::queue {
352 'job' => 'FS::cust_main::queueable_print',
354 $error = $queue->insert(
355 'custnum' => $self->custnum,
356 'template' => 'welcome_letter',
360 warn "can't send welcome letter: $error";
365 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
372 This method now works but you probably shouldn't use it.
374 You don't want to delete billing items, because there would then be no record
375 the customer ever purchased the item. Instead, see the cancel method.
380 # return "Can't delete cust_pkg records!";
383 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
385 Replaces the OLD_RECORD with this one in the database. If there is an error,
386 returns the error, otherwise returns false.
388 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
390 Changing pkgpart may have disasterous effects. See the order subroutine.
392 setup and bill are normally updated by calling the bill method of a customer
393 object (see L<FS::cust_main>).
395 suspend is normally updated by the suspend and unsuspend methods.
397 cancel is normally updated by the cancel method (and also the order subroutine
400 Available options are:
406 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.
410 the access_user (see L<FS::access_user>) providing the reason
414 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
423 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
428 ( ref($_[0]) eq 'HASH' )
432 #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
433 #return "Can't change otaker!" if $old->otaker ne $new->otaker;
436 #return "Can't change setup once it exists!"
437 # if $old->getfield('setup') &&
438 # $old->getfield('setup') != $new->getfield('setup');
440 #some logic for bill, susp, cancel?
442 local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
444 local $SIG{HUP} = 'IGNORE';
445 local $SIG{INT} = 'IGNORE';
446 local $SIG{QUIT} = 'IGNORE';
447 local $SIG{TERM} = 'IGNORE';
448 local $SIG{TSTP} = 'IGNORE';
449 local $SIG{PIPE} = 'IGNORE';
451 my $oldAutoCommit = $FS::UID::AutoCommit;
452 local $FS::UID::AutoCommit = 0;
455 foreach my $method ( qw(adjourn expire) ) { # How many reasons?
456 if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
457 my $error = $new->insert_reason(
458 'reason' => $options->{'reason'},
459 'date' => $new->$method,
461 'reason_otaker' => $options->{'reason_otaker'},
464 dbh->rollback if $oldAutoCommit;
465 return "Error inserting cust_pkg_reason: $error";
470 #save off and freeze RADIUS attributes for any associated svc_acct records
472 if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
474 #also check for specific exports?
475 # to avoid spurious modify export events
476 @svc_acct = map { $_->svc_x }
477 grep { $_->part_svc->svcdb eq 'svc_acct' }
480 $_->snapshot foreach @svc_acct;
484 my $error = $new->SUPER::replace($old,
485 $options->{options} ? $options->{options} : ()
488 $dbh->rollback if $oldAutoCommit;
492 #for prepaid packages,
493 #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
494 foreach my $old_svc_acct ( @svc_acct ) {
495 my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
497 $new_svc_acct->replace( $old_svc_acct,
498 'depend_jobnum' => $options->{depend_jobnum},
501 $dbh->rollback if $oldAutoCommit;
506 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
513 Checks all fields to make sure this is a valid billing item. If there is an
514 error, returns the error, otherwise returns false. Called by the insert and
522 $self->locationnum('') if !$self->locationnum || $self->locationnum == -1;
525 $self->ut_numbern('pkgnum')
526 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
527 || $self->ut_numbern('pkgpart')
528 || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
529 || $self->ut_numbern('start_date')
530 || $self->ut_numbern('setup')
531 || $self->ut_numbern('bill')
532 || $self->ut_numbern('susp')
533 || $self->ut_numbern('cancel')
534 || $self->ut_numbern('adjourn')
535 || $self->ut_numbern('expire')
536 || $self->ut_enum('no_auto', [ '', 'Y' ])
538 return $error if $error;
540 if ( $self->reg_code ) {
542 unless ( grep { $self->pkgpart == $_->pkgpart }
543 map { $_->reg_code_pkg }
544 qsearchs( 'reg_code', { 'code' => $self->reg_code,
545 'agentnum' => $self->cust_main->agentnum })
547 return "Unknown registration code";
550 } elsif ( $self->promo_code ) {
553 qsearchs('part_pkg', {
554 'pkgpart' => $self->pkgpart,
555 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
557 return 'Unknown promotional code' unless $promo_part_pkg;
561 unless ( $disable_agentcheck ) {
563 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
564 return "agent ". $agent->agentnum. ':'. $agent->agent.
565 " can't purchase pkgpart ". $self->pkgpart
566 unless $agent->pkgpart_hashref->{ $self->pkgpart }
567 || $agent->agentnum == $self->part_pkg->agentnum;
570 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
571 return $error if $error;
575 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
577 if ( $self->dbdef_table->column('manual_flag') ) {
578 $self->manual_flag('') if $self->manual_flag eq ' ';
579 $self->manual_flag =~ /^([01]?)$/
580 or return "Illegal manual_flag ". $self->manual_flag;
581 $self->manual_flag($1);
587 =item cancel [ OPTION => VALUE ... ]
589 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
590 in this package, then cancels the package itself (sets the cancel field to
593 Available options are:
597 =item quiet - can be set true to supress email cancellation notices.
599 =item time - can be set to cancel the package based on a specific future or historical date. Using time ensures that the remaining amount is calculated correctly. Note however that this is an immediate cancel and just changes the date. You are PROBABLY looking to expire the account instead of using this.
601 =item reason - 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.
603 =item date - can be set to a unix style timestamp to specify when to cancel (expire)
605 =item nobill - can be set true to skip billing if it might otherwise be done.
607 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
608 not credit it. This must be set (by change()) when changing the package
609 to a different pkgpart or location, and probably shouldn't be in any other
610 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
615 If there is an error, returns the error, otherwise returns false.
620 my( $self, %options ) = @_;
623 my $conf = new FS::Conf;
625 warn "cust_pkg::cancel called with options".
626 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
629 local $SIG{HUP} = 'IGNORE';
630 local $SIG{INT} = 'IGNORE';
631 local $SIG{QUIT} = 'IGNORE';
632 local $SIG{TERM} = 'IGNORE';
633 local $SIG{TSTP} = 'IGNORE';
634 local $SIG{PIPE} = 'IGNORE';
636 my $oldAutoCommit = $FS::UID::AutoCommit;
637 local $FS::UID::AutoCommit = 0;
640 my $old = $self->select_for_update;
642 if ( $old->get('cancel') || $self->get('cancel') ) {
643 dbh->rollback if $oldAutoCommit;
644 return ""; # no error
647 my $date = $options{date} if $options{date}; # expire/cancel later
648 $date = '' if ($date && $date <= time); # complain instead?
650 #race condition: usage could be ongoing until unprovisioned
651 #resolved by performing a change package instead (which unprovisions) and
653 if ( !$options{nobill} && !$date && $conf->exists('bill_usage_on_cancel') ) {
654 my $copy = $self->new({$self->hash});
656 $copy->cust_main->bill( pkg_list => [ $copy ], cancel => 1 );
657 warn "Error billing during cancel, custnum ".
658 #$self->cust_main->custnum. ": $error"
663 my $cancel_time = $options{'time'} || time;
665 if ( $options{'reason'} ) {
666 $error = $self->insert_reason( 'reason' => $options{'reason'},
667 'action' => $date ? 'expire' : 'cancel',
668 'date' => $date ? $date : $cancel_time,
669 'reason_otaker' => $options{'reason_otaker'},
672 dbh->rollback if $oldAutoCommit;
673 return "Error inserting cust_pkg_reason: $error";
680 foreach my $cust_svc (
683 sort { $a->[1] <=> $b->[1] }
684 map { [ $_, $_->svc_x->table_info->{'cancel_weight'} ]; }
685 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
687 my $error = $cust_svc->cancel( ('date' => $date) );
690 $dbh->rollback if $oldAutoCommit;
691 return "Error expiring cust_svc: $error";
695 foreach my $cust_svc (
698 sort { $a->[1] <=> $b->[1] }
699 map { [ $_, $_->svc_x->table_info->{'cancel_weight'} ]; }
700 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
702 my $error = $cust_svc->cancel;
705 $dbh->rollback if $oldAutoCommit;
706 return "Error cancelling cust_svc: $error";
711 # Add a credit for remaining service
712 my $last_bill = $self->getfield('last_bill') || 0;
713 my $next_bill = $self->getfield('bill') || 0;
715 if ( exists($options{'unused_credit'}) ) {
716 $do_credit = $options{'unused_credit'};
719 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
722 and $last_bill > 0 # the package has been billed
723 and $next_bill > 0 # the package has a next bill date
724 and $next_bill >= $cancel_time # which is in the future
726 my $remaining_value = $self->calc_remain('time' => $cancel_time);
727 if ( $remaining_value > 0 ) {
728 # && !$options{'no_credit'} ) {
729 # Undocumented, unused option.
730 # part_pkg configuration should decide this anyway.
731 my $error = $self->cust_main->credit(
733 'Credit for unused time on '. $self->part_pkg->pkg,
734 'reason_type' => $conf->config('cancel_credit_type'),
737 $dbh->rollback if $oldAutoCommit;
738 return "Error crediting customer \$$remaining_value for unused time on".
739 $self->part_pkg->pkg. ": $error";
741 } #if $remaining_value
744 my %hash = $self->hash;
745 $date ? ($hash{'expire'} = $date) : ($hash{'cancel'} = $cancel_time);
746 my $new = new FS::cust_pkg ( \%hash );
747 $error = $new->replace( $self, options => { $self->options } );
749 $dbh->rollback if $oldAutoCommit;
753 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
754 return '' if $date; #no errors
756 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
757 if ( !$options{'quiet'} &&
758 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
760 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
763 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
764 $error = $msg_template->send( 'cust_main' => $self->cust_main,
769 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
770 'to' => \@invoicing_list,
771 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
772 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
775 #should this do something on errors?
782 =item cancel_if_expired [ NOW_TIMESTAMP ]
784 Cancels this package if its expire date has been reached.
788 sub cancel_if_expired {
790 my $time = shift || time;
791 return '' unless $self->expire && $self->expire <= $time;
792 my $error = $self->cancel;
794 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
795 $self->custnum. ": $error";
802 Cancels any pending expiration (sets the expire field to null).
804 If there is an error, returns the error, otherwise returns false.
809 my( $self, %options ) = @_;
812 local $SIG{HUP} = 'IGNORE';
813 local $SIG{INT} = 'IGNORE';
814 local $SIG{QUIT} = 'IGNORE';
815 local $SIG{TERM} = 'IGNORE';
816 local $SIG{TSTP} = 'IGNORE';
817 local $SIG{PIPE} = 'IGNORE';
819 my $oldAutoCommit = $FS::UID::AutoCommit;
820 local $FS::UID::AutoCommit = 0;
823 my $old = $self->select_for_update;
825 my $pkgnum = $old->pkgnum;
826 if ( $old->get('cancel') || $self->get('cancel') ) {
827 dbh->rollback if $oldAutoCommit;
828 return "Can't unexpire cancelled package $pkgnum";
829 # or at least it's pointless
832 unless ( $old->get('expire') && $self->get('expire') ) {
833 dbh->rollback if $oldAutoCommit;
834 return ""; # no error
837 my %hash = $self->hash;
838 $hash{'expire'} = '';
839 my $new = new FS::cust_pkg ( \%hash );
840 $error = $new->replace( $self, options => { $self->options } );
842 $dbh->rollback if $oldAutoCommit;
846 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
852 =item suspend [ OPTION => VALUE ... ]
854 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
855 package, then suspends the package itself (sets the susp field to now).
857 Available options are:
861 =item reason - 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.
863 =item date - can be set to a unix style timestamp to specify when to suspend (adjourn)
867 If there is an error, returns the error, otherwise returns false.
872 my( $self, %options ) = @_;
875 local $SIG{HUP} = 'IGNORE';
876 local $SIG{INT} = 'IGNORE';
877 local $SIG{QUIT} = 'IGNORE';
878 local $SIG{TERM} = 'IGNORE';
879 local $SIG{TSTP} = 'IGNORE';
880 local $SIG{PIPE} = 'IGNORE';
882 my $oldAutoCommit = $FS::UID::AutoCommit;
883 local $FS::UID::AutoCommit = 0;
886 my $old = $self->select_for_update;
888 my $pkgnum = $old->pkgnum;
889 if ( $old->get('cancel') || $self->get('cancel') ) {
890 dbh->rollback if $oldAutoCommit;
891 return "Can't suspend cancelled package $pkgnum";
894 if ( $old->get('susp') || $self->get('susp') ) {
895 dbh->rollback if $oldAutoCommit;
896 return ""; # no error # complain on adjourn?
899 my $date = $options{date} if $options{date}; # adjourn/suspend later
900 $date = '' if ($date && $date <= time); # complain instead?
902 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
903 dbh->rollback if $oldAutoCommit;
904 return "Package $pkgnum expires before it would be suspended.";
907 my $suspend_time = $options{'time'} || time;
909 if ( $options{'reason'} ) {
910 $error = $self->insert_reason( 'reason' => $options{'reason'},
911 'action' => $date ? 'adjourn' : 'suspend',
912 'date' => $date ? $date : $suspend_time,
913 'reason_otaker' => $options{'reason_otaker'},
916 dbh->rollback if $oldAutoCommit;
917 return "Error inserting cust_pkg_reason: $error";
925 foreach my $cust_svc (
926 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
928 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
930 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
931 $dbh->rollback if $oldAutoCommit;
932 return "Illegal svcdb value in part_svc!";
935 require "FS/$svcdb.pm";
937 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
939 $error = $svc->suspend;
941 $dbh->rollback if $oldAutoCommit;
944 my( $label, $value ) = $cust_svc->label;
945 push @labels, "$label: $value";
949 my $conf = new FS::Conf;
950 if ( $conf->config('suspend_email_admin') ) {
952 my $error = send_email(
953 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
954 #invoice_from ??? well as good as any
955 'to' => $conf->config('suspend_email_admin'),
956 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
958 "This is an automatic message from your Freeside installation\n",
959 "informing you that the following customer package has been suspended:\n",
961 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
962 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
963 ( map { "Service : $_\n" } @labels ),
968 warn "WARNING: can't send suspension admin email (suspending anyway): ".
976 my %hash = $self->hash;
978 $hash{'adjourn'} = $date;
980 $hash{'susp'} = $suspend_time;
982 my $new = new FS::cust_pkg ( \%hash );
983 $error = $new->replace( $self, options => { $self->options } );
985 $dbh->rollback if $oldAutoCommit;
989 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
994 =item unsuspend [ OPTION => VALUE ... ]
996 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
997 package, then unsuspends the package itself (clears the susp field and the
998 adjourn field if it is in the past).
1000 Available options are:
1004 =item adjust_next_bill
1006 Can be set true to adjust the next bill date forward by
1007 the amount of time the account was inactive. This was set true by default
1008 since 1.4.2 and 1.5.0pre6; however, starting with 1.7.0 this needs to be
1009 explicitly requested. Price plans for which this makes sense (anniversary-date
1010 based than prorate or subscription) could have an option to enable this
1015 If there is an error, returns the error, otherwise returns false.
1020 my( $self, %opt ) = @_;
1023 local $SIG{HUP} = 'IGNORE';
1024 local $SIG{INT} = 'IGNORE';
1025 local $SIG{QUIT} = 'IGNORE';
1026 local $SIG{TERM} = 'IGNORE';
1027 local $SIG{TSTP} = 'IGNORE';
1028 local $SIG{PIPE} = 'IGNORE';
1030 my $oldAutoCommit = $FS::UID::AutoCommit;
1031 local $FS::UID::AutoCommit = 0;
1034 my $old = $self->select_for_update;
1036 my $pkgnum = $old->pkgnum;
1037 if ( $old->get('cancel') || $self->get('cancel') ) {
1038 dbh->rollback if $oldAutoCommit;
1039 return "Can't unsuspend cancelled package $pkgnum";
1042 unless ( $old->get('susp') && $self->get('susp') ) {
1043 dbh->rollback if $oldAutoCommit;
1044 return ""; # no error # complain instead?
1047 foreach my $cust_svc (
1048 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1050 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1052 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1053 $dbh->rollback if $oldAutoCommit;
1054 return "Illegal svcdb value in part_svc!";
1057 require "FS/$svcdb.pm";
1059 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1061 $error = $svc->unsuspend;
1063 $dbh->rollback if $oldAutoCommit;
1070 my %hash = $self->hash;
1071 my $inactive = time - $hash{'susp'};
1073 my $conf = new FS::Conf;
1075 if ( $inactive > 0 &&
1076 ( $hash{'bill'} || $hash{'setup'} ) &&
1077 ( $opt{'adjust_next_bill'} ||
1078 $conf->exists('unsuspend-always_adjust_next_bill_date') ||
1079 $self->part_pkg->option('unsuspend_adjust_bill', 1) )
1082 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1087 $hash{'adjourn'} = '' if $hash{'adjourn'} < time;
1088 my $new = new FS::cust_pkg ( \%hash );
1089 $error = $new->replace( $self, options => { $self->options } );
1091 $dbh->rollback if $oldAutoCommit;
1095 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1102 Cancels any pending suspension (sets the adjourn field to null).
1104 If there is an error, returns the error, otherwise returns false.
1109 my( $self, %options ) = @_;
1112 local $SIG{HUP} = 'IGNORE';
1113 local $SIG{INT} = 'IGNORE';
1114 local $SIG{QUIT} = 'IGNORE';
1115 local $SIG{TERM} = 'IGNORE';
1116 local $SIG{TSTP} = 'IGNORE';
1117 local $SIG{PIPE} = 'IGNORE';
1119 my $oldAutoCommit = $FS::UID::AutoCommit;
1120 local $FS::UID::AutoCommit = 0;
1123 my $old = $self->select_for_update;
1125 my $pkgnum = $old->pkgnum;
1126 if ( $old->get('cancel') || $self->get('cancel') ) {
1127 dbh->rollback if $oldAutoCommit;
1128 return "Can't unadjourn cancelled package $pkgnum";
1129 # or at least it's pointless
1132 if ( $old->get('susp') || $self->get('susp') ) {
1133 dbh->rollback if $oldAutoCommit;
1134 return "Can't unadjourn suspended package $pkgnum";
1135 # perhaps this is arbitrary
1138 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1139 dbh->rollback if $oldAutoCommit;
1140 return ""; # no error
1143 my %hash = $self->hash;
1144 $hash{'adjourn'} = '';
1145 my $new = new FS::cust_pkg ( \%hash );
1146 $error = $new->replace( $self, options => { $self->options } );
1148 $dbh->rollback if $oldAutoCommit;
1152 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1159 =item change HASHREF | OPTION => VALUE ...
1161 Changes this package: cancels it and creates a new one, with a different
1162 pkgpart or locationnum or both. All services are transferred to the new
1163 package (no change will be made if this is not possible).
1165 Options may be passed as a list of key/value pairs or as a hash reference.
1172 New locationnum, to change the location for this package.
1176 New FS::cust_location object, to create a new location and assign it
1181 New pkgpart (see L<FS::part_pkg>).
1185 New refnum (see L<FS::part_referral>).
1189 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1190 susp, adjourn, cancel, expire, and contract_end) to the new package.
1194 At least one of locationnum, cust_location, pkgpart, refnum must be specified
1195 (otherwise, what's the point?)
1197 Returns either the new FS::cust_pkg object or a scalar error.
1201 my $err_or_new_cust_pkg = $old_cust_pkg->change
1205 #some false laziness w/order
1208 my $opt = ref($_[0]) ? shift : { @_ };
1210 # my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
1213 my $conf = new FS::Conf;
1215 # Transactionize this whole mess
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';
1223 my $oldAutoCommit = $FS::UID::AutoCommit;
1224 local $FS::UID::AutoCommit = 0;
1233 #$hash{$_} = $self->$_() foreach qw( last_bill bill );
1235 #$hash{$_} = $self->$_() foreach qw( setup );
1237 $hash{'setup'} = $time if $self->setup;
1239 $hash{'change_date'} = $time;
1240 $hash{"change_$_"} = $self->$_()
1241 foreach qw( pkgnum pkgpart locationnum );
1243 if ( $opt->{'cust_location'} &&
1244 ( ! $opt->{'locationnum'} || $opt->{'locationnum'} == -1 ) ) {
1245 $error = $opt->{'cust_location'}->insert;
1247 $dbh->rollback if $oldAutoCommit;
1248 return "inserting cust_location (transaction rolled back): $error";
1250 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1253 my $unused_credit = 0;
1254 if ( $opt->{'keep_dates'} ) {
1255 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1256 start_date contract_end ) ) {
1257 $hash{$date} = $self->getfield($date);
1260 # Special case. If the pkgpart is changing, and the customer is
1261 # going to be credited for remaining time, don't keep setup, bill,
1262 # or last_bill dates, and DO pass the flag to cancel() to credit
1264 if ( $opt->{'pkgpart'}
1265 and $opt->{'pkgpart'} != $self->pkgpart
1266 and $self->part_pkg->option('unused_credit_change', 1) ) {
1268 $hash{$_} = '' foreach qw(setup bill last_bill);
1271 # Create the new package.
1272 my $cust_pkg = new FS::cust_pkg {
1273 custnum => $self->custnum,
1274 pkgpart => ( $opt->{'pkgpart'} || $self->pkgpart ),
1275 refnum => ( $opt->{'refnum'} || $self->refnum ),
1276 locationnum => ( $opt->{'locationnum'} || $self->locationnum ),
1280 $error = $cust_pkg->insert( 'change' => 1 );
1282 $dbh->rollback if $oldAutoCommit;
1286 # Transfer services and cancel old package.
1288 $error = $self->transfer($cust_pkg);
1289 if ($error and $error == 0) {
1290 # $old_pkg->transfer failed.
1291 $dbh->rollback if $oldAutoCommit;
1295 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
1296 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
1297 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
1298 if ($error and $error == 0) {
1299 # $old_pkg->transfer failed.
1300 $dbh->rollback if $oldAutoCommit;
1306 # Transfers were successful, but we still had services left on the old
1307 # package. We can't change the package under this circumstances, so abort.
1308 $dbh->rollback if $oldAutoCommit;
1309 return "Unable to transfer all services from package ". $self->pkgnum;
1312 #reset usage if changing pkgpart
1313 # AND usage rollover is off (otherwise adds twice, now and at package bill)
1314 if ($self->pkgpart != $cust_pkg->pkgpart) {
1315 my $part_pkg = $cust_pkg->part_pkg;
1316 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
1320 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
1323 $dbh->rollback if $oldAutoCommit;
1324 return "Error setting usage values: $error";
1328 #Good to go, cancel old package. Notify 'cancel' of whether to credit
1330 $error = $self->cancel( quiet=>1, unused_credit => $unused_credit );
1332 $dbh->rollback if $oldAutoCommit;
1336 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
1338 my $error = $cust_pkg->cust_main->bill( 'pkg_list' => [ $cust_pkg ] );
1340 $dbh->rollback if $oldAutoCommit;
1345 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1352 use Storable 'thaw';
1354 sub process_bulk_cust_pkg {
1356 my $param = thaw(decode_base64(shift));
1357 warn Dumper($param) if $DEBUG;
1359 my $old_part_pkg = qsearchs('part_pkg',
1360 { pkgpart => $param->{'old_pkgpart'} });
1361 my $new_part_pkg = qsearchs('part_pkg',
1362 { pkgpart => $param->{'new_pkgpart'} });
1363 die "Must select a new package type\n" unless $new_part_pkg;
1364 #my $keep_dates = $param->{'keep_dates'} || 0;
1365 my $keep_dates = 1; # there is no good reason to turn this off
1367 local $SIG{HUP} = 'IGNORE';
1368 local $SIG{INT} = 'IGNORE';
1369 local $SIG{QUIT} = 'IGNORE';
1370 local $SIG{TERM} = 'IGNORE';
1371 local $SIG{TSTP} = 'IGNORE';
1372 local $SIG{PIPE} = 'IGNORE';
1374 my $oldAutoCommit = $FS::UID::AutoCommit;
1375 local $FS::UID::AutoCommit = 0;
1378 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
1381 foreach my $old_cust_pkg ( @cust_pkgs ) {
1383 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
1384 if ( $old_cust_pkg->getfield('cancel') ) {
1385 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
1386 $old_cust_pkg->pkgnum."\n"
1390 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
1392 my $error = $old_cust_pkg->change(
1393 'pkgpart' => $param->{'new_pkgpart'},
1394 'keep_dates' => $keep_dates
1396 if ( !ref($error) ) { # change returns the cust_pkg on success
1398 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
1401 $dbh->commit if $oldAutoCommit;
1407 Returns the last bill date, or if there is no last bill date, the setup date.
1408 Useful for billing metered services.
1414 return $self->setfield('last_bill', $_[0]) if @_;
1415 return $self->getfield('last_bill') if $self->getfield('last_bill');
1416 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
1417 'edate' => $self->bill, } );
1418 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
1421 =item last_cust_pkg_reason ACTION
1423 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
1424 Returns false if there is no reason or the package is not currenly ACTION'd
1425 ACTION is one of adjourn, susp, cancel, or expire.
1429 sub last_cust_pkg_reason {
1430 my ( $self, $action ) = ( shift, shift );
1431 my $date = $self->get($action);
1433 'table' => 'cust_pkg_reason',
1434 'hashref' => { 'pkgnum' => $self->pkgnum,
1435 'action' => substr(uc($action), 0, 1),
1438 'order_by' => 'ORDER BY num DESC LIMIT 1',
1442 =item last_reason ACTION
1444 Returns the most recent ACTION FS::reason associated with the package.
1445 Returns false if there is no reason or the package is not currenly ACTION'd
1446 ACTION is one of adjourn, susp, cancel, or expire.
1451 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
1452 $cust_pkg_reason->reason
1453 if $cust_pkg_reason;
1458 Returns the definition for this billing item, as an FS::part_pkg object (see
1465 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
1466 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
1467 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
1472 Returns the cancelled package this package was changed from, if any.
1478 return '' unless $self->change_pkgnum;
1479 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
1484 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
1491 $self->part_pkg->calc_setup($self, @_);
1496 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
1503 $self->part_pkg->calc_recur($self, @_);
1508 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
1515 $self->part_pkg->base_recur($self, @_);
1520 Calls the I<calc_remain> of the FS::part_pkg object associated with this
1527 $self->part_pkg->calc_remain($self, @_);
1532 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
1539 $self->part_pkg->calc_cancel($self, @_);
1544 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
1550 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
1553 =item cust_pkg_detail [ DETAILTYPE ]
1555 Returns any customer package details for this package (see
1556 L<FS::cust_pkg_detail>).
1558 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1562 sub cust_pkg_detail {
1564 my %hash = ( 'pkgnum' => $self->pkgnum );
1565 $hash{detailtype} = shift if @_;
1567 'table' => 'cust_pkg_detail',
1568 'hashref' => \%hash,
1569 'order_by' => 'ORDER BY weight, pkgdetailnum',
1573 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
1575 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
1577 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1579 If there is an error, returns the error, otherwise returns false.
1583 sub set_cust_pkg_detail {
1584 my( $self, $detailtype, @details ) = @_;
1586 local $SIG{HUP} = 'IGNORE';
1587 local $SIG{INT} = 'IGNORE';
1588 local $SIG{QUIT} = 'IGNORE';
1589 local $SIG{TERM} = 'IGNORE';
1590 local $SIG{TSTP} = 'IGNORE';
1591 local $SIG{PIPE} = 'IGNORE';
1593 my $oldAutoCommit = $FS::UID::AutoCommit;
1594 local $FS::UID::AutoCommit = 0;
1597 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
1598 my $error = $current->delete;
1600 $dbh->rollback if $oldAutoCommit;
1601 return "error removing old detail: $error";
1605 foreach my $detail ( @details ) {
1606 my $cust_pkg_detail = new FS::cust_pkg_detail {
1607 'pkgnum' => $self->pkgnum,
1608 'detailtype' => $detailtype,
1609 'detail' => $detail,
1611 my $error = $cust_pkg_detail->insert;
1613 $dbh->rollback if $oldAutoCommit;
1614 return "error adding new detail: $error";
1619 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1626 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
1630 #false laziness w/cust_bill.pm
1634 'table' => 'cust_event',
1635 'addl_from' => 'JOIN part_event USING ( eventpart )',
1636 'hashref' => { 'tablenum' => $self->pkgnum },
1637 'extra_sql' => " AND eventtable = 'cust_pkg' ",
1641 =item num_cust_event
1643 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
1647 #false laziness w/cust_bill.pm
1648 sub num_cust_event {
1651 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
1652 " WHERE tablenum = ? AND eventtable = 'cust_pkg'";
1653 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
1654 $sth->execute($self->pkgnum) or die $sth->errstr. " executing $sql";
1655 $sth->fetchrow_arrayref->[0];
1658 =item cust_svc [ SVCPART ]
1660 Returns the services for this package, as FS::cust_svc objects (see
1661 L<FS::cust_svc>). If a svcpart is specified, return only the matching
1669 return () unless $self->num_cust_svc(@_);
1672 return qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum,
1673 'svcpart' => shift, } );
1676 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
1678 #if ( $self->{'_svcnum'} ) {
1679 # values %{ $self->{'_svcnum'}->cache };
1681 $self->_sort_cust_svc(
1682 [ qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } ) ]
1688 =item overlimit [ SVCPART ]
1690 Returns the services for this package which have exceeded their
1691 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
1692 is specified, return only the matching services.
1698 return () unless $self->num_cust_svc(@_);
1699 grep { $_->overlimit } $self->cust_svc(@_);
1702 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
1704 Returns historical services for this package created before END TIMESTAMP and
1705 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
1706 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
1707 I<pkg_svc.hidden> flag will be omitted.
1713 my ($end, $start, $mode) = @_;
1714 my @cust_svc = $self->_sort_cust_svc(
1715 [ qsearch( 'h_cust_svc',
1716 { 'pkgnum' => $self->pkgnum, },
1717 FS::h_cust_svc->sql_h_search(@_),
1720 if ( $mode eq 'I' ) {
1721 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
1722 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
1729 sub _sort_cust_svc {
1730 my( $self, $arrayref ) = @_;
1733 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
1738 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $self->pkgpart,
1739 'svcpart' => $_->svcpart } );
1741 $pkg_svc ? $pkg_svc->primary_svc : '',
1742 $pkg_svc ? $pkg_svc->quantity : 0,
1749 =item num_cust_svc [ SVCPART ]
1751 Returns the number of provisioned services for this package. If a svcpart is
1752 specified, counts only the matching services.
1759 return $self->{'_num_cust_svc'}
1761 && exists($self->{'_num_cust_svc'})
1762 && $self->{'_num_cust_svc'} =~ /\d/;
1764 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
1767 my $sql = 'SELECT COUNT(*) FROM cust_svc WHERE pkgnum = ?';
1768 $sql .= ' AND svcpart = ?' if @_;
1770 my $sth = dbh->prepare($sql) or die dbh->errstr;
1771 $sth->execute($self->pkgnum, @_) or die $sth->errstr;
1772 $sth->fetchrow_arrayref->[0];
1775 =item available_part_svc
1777 Returns a list of FS::part_svc objects representing services included in this
1778 package but not yet provisioned. Each FS::part_svc object also has an extra
1779 field, I<num_avail>, which specifies the number of available services.
1783 sub available_part_svc {
1785 grep { $_->num_avail > 0 }
1787 my $part_svc = $_->part_svc;
1788 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
1789 $_->quantity - $self->num_cust_svc($_->svcpart);
1791 # more evil encapsulation breakage
1792 if($part_svc->{'Hash'}{'num_avail'} > 0) {
1793 my @exports = $part_svc->part_export_did;
1794 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
1799 $self->part_pkg->pkg_svc;
1804 Returns a list of FS::part_svc objects representing provisioned and available
1805 services included in this package. Each FS::part_svc object also has the
1806 following extra fields:
1810 =item num_cust_svc (count)
1812 =item num_avail (quantity - count)
1814 =item cust_pkg_svc (services) - array reference containing the provisioned services, as cust_svc objects
1817 label -> ($cust_svc->label)[1]
1826 #XXX some sort of sort order besides numeric by svcpart...
1827 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
1829 my $part_svc = $pkg_svc->part_svc;
1830 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
1831 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
1832 $part_svc->{'Hash'}{'num_avail'} =
1833 max( 0, $pkg_svc->quantity - $num_cust_svc );
1834 $part_svc->{'Hash'}{'cust_pkg_svc'} =
1835 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
1836 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
1838 } $self->part_pkg->pkg_svc;
1841 push @part_svc, map {
1843 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
1844 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
1845 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
1846 $part_svc->{'Hash'}{'cust_pkg_svc'} =
1847 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
1849 } $self->extra_part_svc;
1855 =item extra_part_svc
1857 Returns a list of FS::part_svc objects corresponding to services in this
1858 package which are still provisioned but not (any longer) available in the
1863 sub extra_part_svc {
1866 my $pkgnum = $self->pkgnum;
1867 my $pkgpart = $self->pkgpart;
1870 # 'table' => 'part_svc',
1873 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
1874 # WHERE pkg_svc.svcpart = part_svc.svcpart
1875 # AND pkg_svc.pkgpart = ?
1878 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
1879 # LEFT JOIN cust_pkg USING ( pkgnum )
1880 # WHERE cust_svc.svcpart = part_svc.svcpart
1883 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
1886 #seems to benchmark slightly faster...
1888 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
1889 #MySQL doesn't grok DISINCT ON
1890 'select' => 'DISTINCT part_svc.*',
1891 'table' => 'part_svc',
1893 'LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
1894 AND pkg_svc.pkgpart = ?
1897 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
1898 LEFT JOIN cust_pkg USING ( pkgnum )
1901 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
1902 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
1908 Returns a short status string for this package, currently:
1912 =item not yet billed
1914 =item one-time charge
1929 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
1931 return 'cancelled' if $self->get('cancel');
1932 return 'suspended' if $self->susp;
1933 return 'not yet billed' unless $self->setup;
1934 return 'one-time charge' if $freq =~ /^(0|$)/;
1938 =item ucfirst_status
1940 Returns the status with the first character capitalized.
1944 sub ucfirst_status {
1945 ucfirst(shift->status);
1950 Class method that returns the list of possible status strings for packages
1951 (see L<the status method|/status>). For example:
1953 @statuses = FS::cust_pkg->statuses();
1957 tie my %statuscolor, 'Tie::IxHash',
1958 'not yet billed' => '009999', #teal? cyan?
1959 'one-time charge' => '000000',
1960 'active' => '00CC00',
1961 'suspended' => 'FF9900',
1962 'cancelled' => 'FF0000',
1966 my $self = shift; #could be class...
1967 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
1968 # # mayble split btw one-time vs. recur
1974 Returns a hex triplet color string for this package's status.
1980 $statuscolor{$self->status};
1985 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
1986 "pkg-comment" depending on user preference).
1992 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
1993 $label = $self->pkgnum. ": $label"
1994 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
1998 =item pkg_label_long
2000 Returns a long label for this package, adding the primary service's label to
2005 sub pkg_label_long {
2007 my $label = $self->pkg_label;
2008 my $cust_svc = $self->primary_cust_svc;
2009 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
2013 =item primary_cust_svc
2015 Returns a primary service (as FS::cust_svc object) if one can be identified.
2019 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
2021 sub primary_cust_svc {
2024 my @cust_svc = $self->cust_svc;
2026 return '' unless @cust_svc; #no serivces - irrelevant then
2028 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
2030 # primary service as specified in the package definition
2031 # or exactly one service definition with quantity one
2032 my $svcpart = $self->part_pkg->svcpart;
2033 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
2034 return $cust_svc[0] if scalar(@cust_svc) == 1;
2036 #couldn't identify one thing..
2042 Returns a list of lists, calling the label method for all services
2043 (see L<FS::cust_svc>) of this billing item.
2049 map { [ $_->label ] } $self->cust_svc;
2052 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2054 Like the labels method, but returns historical information on services that
2055 were active as of END_TIMESTAMP and (optionally) not cancelled before
2056 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
2057 I<pkg_svc.hidden> flag will be omitted.
2059 Returns a list of lists, calling the label method for all (historical) services
2060 (see L<FS::h_cust_svc>) of this billing item.
2066 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
2071 Like labels, except returns a simple flat list, and shortens long
2072 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2073 identical services to one line that lists the service label and the number of
2074 individual services rather than individual items.
2079 shift->_labels_short( 'labels', @_ );
2082 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
2084 Like h_labels, except returns a simple flat list, and shortens long
2085 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2086 identical services to one line that lists the service label and the number of
2087 individual services rather than individual items.
2091 sub h_labels_short {
2092 shift->_labels_short( 'h_labels', @_ );
2096 my( $self, $method ) = ( shift, shift );
2098 my $conf = new FS::Conf;
2099 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
2102 #tie %labels, 'Tie::IxHash';
2103 push @{ $labels{$_->[0]} }, $_->[1]
2104 foreach $self->$method(@_);
2106 foreach my $label ( keys %labels ) {
2108 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
2109 my $num = scalar(@values);
2110 if ( $num > $max_same_services ) {
2111 push @labels, "$label ($num)";
2113 if ( $conf->exists('cust_bill-consolidate_services') ) {
2114 # push @labels, "$label: ". join(', ', @values);
2116 my $detail = "$label: ";
2117 $detail .= shift(@values). ', '
2118 while @values && length($detail.$values[0]) < 78;
2120 push @labels, $detail;
2123 push @labels, map { "$label: $_" } @values;
2134 Returns the parent customer object (see L<FS::cust_main>).
2140 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
2143 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
2147 Returns the location object, if any (see L<FS::cust_location>).
2149 =item cust_location_or_main
2151 If this package is associated with a location, returns the locaiton (see
2152 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
2154 =item location_label [ OPTION => VALUE ... ]
2156 Returns the label of the location object (see L<FS::cust_location>).
2160 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
2162 =item seconds_since TIMESTAMP
2164 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
2165 package have been online since TIMESTAMP, according to the session monitor.
2167 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2168 L<Time::Local> and L<Date::Parse> for conversion functions.
2173 my($self, $since) = @_;
2176 foreach my $cust_svc (
2177 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
2179 $seconds += $cust_svc->seconds_since($since);
2186 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
2188 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
2189 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
2192 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2193 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2199 sub seconds_since_sqlradacct {
2200 my($self, $start, $end) = @_;
2204 foreach my $cust_svc (
2206 my $part_svc = $_->part_svc;
2207 $part_svc->svcdb eq 'svc_acct'
2208 && scalar($part_svc->part_export('sqlradius'));
2211 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
2218 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
2220 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
2221 in this package for sessions ending between TIMESTAMP_START (inclusive) and
2225 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2226 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2231 sub attribute_since_sqlradacct {
2232 my($self, $start, $end, $attrib) = @_;
2236 foreach my $cust_svc (
2238 my $part_svc = $_->part_svc;
2239 $part_svc->svcdb eq 'svc_acct'
2240 && scalar($part_svc->part_export('sqlradius'));
2243 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
2255 my( $self, $value ) = @_;
2256 if ( defined($value) ) {
2257 $self->setfield('quantity', $value);
2259 $self->getfield('quantity') || 1;
2262 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
2264 Transfers as many services as possible from this package to another package.
2266 The destination package can be specified by pkgnum by passing an FS::cust_pkg
2267 object. The destination package must already exist.
2269 Services are moved only if the destination allows services with the correct
2270 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
2271 this option with caution! No provision is made for export differences
2272 between the old and new service definitions. Probably only should be used
2273 when your exports for all service definitions of a given svcdb are identical.
2274 (attempt a transfer without it first, to move all possible svcpart-matching
2277 Any services that can't be moved remain in the original package.
2279 Returns an error, if there is one; otherwise, returns the number of services
2280 that couldn't be moved.
2285 my ($self, $dest_pkgnum, %opt) = @_;
2291 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
2292 $dest = $dest_pkgnum;
2293 $dest_pkgnum = $dest->pkgnum;
2295 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
2298 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
2300 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
2301 $target{$pkg_svc->svcpart} = $pkg_svc->quantity;
2304 foreach my $cust_svc ($dest->cust_svc) {
2305 $target{$cust_svc->svcpart}--;
2308 my %svcpart2svcparts = ();
2309 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2310 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
2311 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
2312 next if exists $svcpart2svcparts{$svcpart};
2313 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
2314 $svcpart2svcparts{$svcpart} = [
2316 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
2318 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
2319 'svcpart' => $_ } );
2321 $pkg_svc ? $pkg_svc->primary_svc : '',
2322 $pkg_svc ? $pkg_svc->quantity : 0,
2326 grep { $_ != $svcpart }
2328 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
2330 warn "alternates for svcpart $svcpart: ".
2331 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
2336 foreach my $cust_svc ($self->cust_svc) {
2337 if($target{$cust_svc->svcpart} > 0) {
2338 $target{$cust_svc->svcpart}--;
2339 my $new = new FS::cust_svc { $cust_svc->hash };
2340 $new->pkgnum($dest_pkgnum);
2341 my $error = $new->replace($cust_svc);
2342 return $error if $error;
2343 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2345 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
2346 warn "alternates to consider: ".
2347 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
2349 my @alternate = grep {
2350 warn "considering alternate svcpart $_: ".
2351 "$target{$_} available in new package\n"
2354 } @{$svcpart2svcparts{$cust_svc->svcpart}};
2356 warn "alternate(s) found\n" if $DEBUG;
2357 my $change_svcpart = $alternate[0];
2358 $target{$change_svcpart}--;
2359 my $new = new FS::cust_svc { $cust_svc->hash };
2360 $new->svcpart($change_svcpart);
2361 $new->pkgnum($dest_pkgnum);
2362 my $error = $new->replace($cust_svc);
2363 return $error if $error;
2376 This method is deprecated. See the I<depend_jobnum> option to the insert and
2377 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
2384 local $SIG{HUP} = 'IGNORE';
2385 local $SIG{INT} = 'IGNORE';
2386 local $SIG{QUIT} = 'IGNORE';
2387 local $SIG{TERM} = 'IGNORE';
2388 local $SIG{TSTP} = 'IGNORE';
2389 local $SIG{PIPE} = 'IGNORE';
2391 my $oldAutoCommit = $FS::UID::AutoCommit;
2392 local $FS::UID::AutoCommit = 0;
2395 foreach my $cust_svc ( $self->cust_svc ) {
2396 #false laziness w/svc_Common::insert
2397 my $svc_x = $cust_svc->svc_x;
2398 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
2399 my $error = $part_export->export_insert($svc_x);
2401 $dbh->rollback if $oldAutoCommit;
2407 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2414 Associates this package with a (suspension or cancellation) reason (see
2415 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
2418 Available options are:
2424 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.
2428 the access_user (see L<FS::access_user>) providing the reason
2436 the action (cancel, susp, adjourn, expire) associated with the reason
2440 If there is an error, returns the error, otherwise returns false.
2445 my ($self, %options) = @_;
2447 my $otaker = $options{reason_otaker} ||
2448 $FS::CurrentUser::CurrentUser->username;
2451 if ( $options{'reason'} =~ /^(\d+)$/ ) {
2455 } elsif ( ref($options{'reason'}) ) {
2457 return 'Enter a new reason (or select an existing one)'
2458 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
2460 my $reason = new FS::reason({
2461 'reason_type' => $options{'reason'}->{'typenum'},
2462 'reason' => $options{'reason'}->{'reason'},
2464 my $error = $reason->insert;
2465 return $error if $error;
2467 $reasonnum = $reason->reasonnum;
2470 return "Unparsable reason: ". $options{'reason'};
2473 my $cust_pkg_reason =
2474 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
2475 'reasonnum' => $reasonnum,
2476 'otaker' => $otaker,
2477 'action' => substr(uc($options{'action'}),0,1),
2478 'date' => $options{'date'}
2483 $cust_pkg_reason->insert;
2486 =item insert_discount
2488 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
2489 inserting a new discount on the fly (see L<FS::discount>).
2491 Available options are:
2499 If there is an error, returns the error, otherwise returns false.
2503 sub insert_discount {
2504 #my ($self, %options) = @_;
2507 my $cust_pkg_discount = new FS::cust_pkg_discount {
2508 'pkgnum' => $self->pkgnum,
2509 'discountnum' => $self->discountnum,
2511 'end_date' => '', #XXX
2512 #for the create a new discount case
2513 '_type' => $self->discountnum__type,
2514 'amount' => $self->discountnum_amount,
2515 'percent' => $self->discountnum_percent,
2516 'months' => $self->discountnum_months,
2517 #'disabled' => $self->discountnum_disabled,
2520 $cust_pkg_discount->insert;
2523 =item set_usage USAGE_VALUE_HASHREF
2525 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2526 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2527 upbytes, downbytes, and totalbytes are appropriate keys.
2529 All svc_accts which are part of this package have their values reset.
2534 my ($self, $valueref, %opt) = @_;
2536 foreach my $cust_svc ($self->cust_svc){
2537 my $svc_x = $cust_svc->svc_x;
2538 $svc_x->set_usage($valueref, %opt)
2539 if $svc_x->can("set_usage");
2543 =item recharge USAGE_VALUE_HASHREF
2545 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2546 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2547 upbytes, downbytes, and totalbytes are appropriate keys.
2549 All svc_accts which are part of this package have their values incremented.
2554 my ($self, $valueref) = @_;
2556 foreach my $cust_svc ($self->cust_svc){
2557 my $svc_x = $cust_svc->svc_x;
2558 $svc_x->recharge($valueref)
2559 if $svc_x->can("recharge");
2563 =item cust_pkg_discount
2567 sub cust_pkg_discount {
2569 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
2572 =item cust_pkg_discount_active
2576 sub cust_pkg_discount_active {
2578 grep { $_->status eq 'active' } $self->cust_pkg_discount;
2583 =head1 CLASS METHODS
2589 Returns an SQL expression identifying recurring packages.
2593 sub recurring_sql { "
2594 '0' != ( select freq from part_pkg
2595 where cust_pkg.pkgpart = part_pkg.pkgpart )
2600 Returns an SQL expression identifying one-time packages.
2605 '0' = ( select freq from part_pkg
2606 where cust_pkg.pkgpart = part_pkg.pkgpart )
2611 Returns an SQL expression identifying ordered packages (recurring packages not
2617 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
2622 Returns an SQL expression identifying active packages.
2627 $_[0]->recurring_sql. "
2628 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
2629 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2630 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2633 =item not_yet_billed_sql
2635 Returns an SQL expression identifying packages which have not yet been billed.
2639 sub not_yet_billed_sql { "
2640 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
2641 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2642 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2647 Returns an SQL expression identifying inactive packages (one-time packages
2648 that are otherwise unsuspended/uncancelled).
2652 sub inactive_sql { "
2653 ". $_[0]->onetime_sql(). "
2654 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
2655 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2656 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2662 Returns an SQL expression identifying suspended packages.
2666 sub suspended_sql { susp_sql(@_); }
2668 #$_[0]->recurring_sql(). ' AND '.
2670 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2671 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
2678 Returns an SQL exprression identifying cancelled packages.
2682 sub cancelled_sql { cancel_sql(@_); }
2684 #$_[0]->recurring_sql(). ' AND '.
2685 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
2690 Returns an SQL expression to give the package status as a string.
2696 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
2697 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
2698 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
2699 WHEN ".onetime_sql()." THEN 'one-time charge'
2704 =item search HASHREF
2708 Returns a qsearch hash expression to search for parameters specified in HASHREF.
2709 Valid parameters are
2717 active, inactive, suspended, cancel (or cancelled)
2721 active, inactive, suspended, one-time charge, inactive, cancel (or cancelled)
2725 boolean selects custom packages
2731 pkgpart or arrayref or hashref of pkgparts
2735 arrayref of beginning and ending epoch date
2739 arrayref of beginning and ending epoch date
2743 arrayref of beginning and ending epoch date
2747 arrayref of beginning and ending epoch date
2751 arrayref of beginning and ending epoch date
2755 arrayref of beginning and ending epoch date
2759 arrayref of beginning and ending epoch date
2763 pkgnum or APKG_pkgnum
2767 a value suited to passing to FS::UI::Web::cust_header
2771 specifies the user for agent virtualization
2775 boolean selects packages containing fcc form 477 telco lines
2782 my ($class, $params) = @_;
2789 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
2791 "cust_main.agentnum = $1";
2798 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
2800 "cust_pkg.custnum = $1";
2807 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
2809 "cust_pkg.pkgbatch = '$1'";
2816 if ( $params->{'magic'} eq 'active'
2817 || $params->{'status'} eq 'active' ) {
2819 push @where, FS::cust_pkg->active_sql();
2821 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
2822 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
2824 push @where, FS::cust_pkg->not_yet_billed_sql();
2826 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
2827 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
2829 push @where, FS::cust_pkg->inactive_sql();
2831 } elsif ( $params->{'magic'} eq 'suspended'
2832 || $params->{'status'} eq 'suspended' ) {
2834 push @where, FS::cust_pkg->suspended_sql();
2836 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
2837 || $params->{'status'} =~ /^cancell?ed$/ ) {
2839 push @where, FS::cust_pkg->cancelled_sql();
2844 # parse package class
2847 #false lazinessish w/graph/cust_bill_pkg.cgi
2850 if ( exists($params->{'classnum'})
2851 && $params->{'classnum'} =~ /^(\d*)$/
2855 if ( $classnum ) { #a specific class
2856 push @where, "part_pkg.classnum = $classnum";
2858 #@pkg_class = ( qsearchs('pkg_class', { 'classnum' => $classnum } ) );
2859 #die "classnum $classnum not found!" unless $pkg_class[0];
2860 #$title .= $pkg_class[0]->classname.' ';
2862 } elsif ( $classnum eq '' ) { #the empty class
2864 push @where, "part_pkg.classnum IS NULL";
2865 #$title .= 'Empty class ';
2866 #@pkg_class = ( '(empty class)' );
2867 } elsif ( $classnum eq '0' ) {
2868 #@pkg_class = qsearch('pkg_class', {} ); # { 'disabled' => '' } );
2869 #push @pkg_class, '(empty class)';
2871 die "illegal classnum";
2877 # parse package report options
2880 my @report_option = ();
2881 if ( exists($params->{'report_option'})
2882 && $params->{'report_option'} =~ /^([,\d]*)$/
2885 @report_option = split(',', $1);
2888 if (@report_option) {
2889 # this will result in the empty set for the dangling comma case as it should
2891 map{ "0 < ( SELECT count(*) FROM part_pkg_option
2892 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
2893 AND optionname = 'report_option_$_'
2894 AND optionvalue = '1' )"
2904 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
2910 push @where, "part_pkg.fcc_ds0s > 0" if $params->{fcc_line};
2916 if ( exists($params->{'censustract'}) ) {
2917 $params->{'censustract'} =~ /^([.\d]*)$/;
2918 my $censustract = "cust_main.censustract = '$1'";
2919 $censustract .= ' OR cust_main.censustract is NULL' unless $1;
2920 push @where, "( $censustract )";
2927 if ( ref($params->{'pkgpart'}) ) {
2930 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
2931 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
2932 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
2933 @pkgpart = @{ $params->{'pkgpart'} };
2935 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
2938 @pkgpart = grep /^(\d+)$/, @pkgpart;
2940 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
2942 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
2943 push @where, "pkgpart = $1";
2952 #false laziness w/report_cust_pkg.html
2955 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
2956 'active' => { 'susp'=>1, 'cancel'=>1 },
2957 'suspended' => { 'cancel' => 1 },
2962 if( exists($params->{'active'} ) ) {
2963 # This overrides all the other date-related fields
2964 my($beginning, $ending) = @{$params->{'active'}};
2966 "cust_pkg.setup IS NOT NULL",
2967 "cust_pkg.setup <= $ending",
2968 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
2969 "NOT (".FS::cust_pkg->onetime_sql . ")";
2972 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end cancel )) {
2974 next unless exists($params->{$field});
2976 my($beginning, $ending) = @{$params->{$field}};
2978 next if $beginning == 0 && $ending == 4294967295;
2981 "cust_pkg.$field IS NOT NULL",
2982 "cust_pkg.$field >= $beginning",
2983 "cust_pkg.$field <= $ending";
2985 $orderby ||= "ORDER BY cust_pkg.$field";
2990 $orderby ||= 'ORDER BY bill';
2993 # parse magic, legacy, etc.
2996 if ( $params->{'magic'} &&
2997 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
3000 $orderby = 'ORDER BY pkgnum';
3002 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
3003 push @where, "pkgpart = $1";
3006 } elsif ( $params->{'query'} eq 'pkgnum' ) {
3008 $orderby = 'ORDER BY pkgnum';
3010 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
3012 $orderby = 'ORDER BY pkgnum';
3015 SELECT count(*) FROM pkg_svc
3016 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
3017 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
3018 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
3019 AND cust_svc.svcpart = pkg_svc.svcpart
3026 # setup queries, links, subs, etc. for the search
3029 # here is the agent virtualization
3030 if ($params->{CurrentUser}) {
3032 qsearchs('access_user', { username => $params->{CurrentUser} });
3035 push @where, $access_user->agentnums_sql('table'=>'cust_main');
3040 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
3043 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
3045 my $addl_from = 'LEFT JOIN cust_main USING ( custnum ) '.
3046 'LEFT JOIN part_pkg USING ( pkgpart ) '.
3047 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) ';
3049 my $count_query = "SELECT COUNT(*) FROM cust_pkg $addl_from $extra_sql";
3052 'table' => 'cust_pkg',
3054 'select' => join(', ',
3056 ( map "part_pkg.$_", qw( pkg freq ) ),
3057 'pkg_class.classname',
3058 'cust_main.custnum AS cust_main_custnum',
3059 FS::UI::Web::cust_sql_fields(
3060 $params->{'cust_fields'}
3063 'extra_sql' => "$extra_sql $orderby",
3064 'addl_from' => $addl_from,
3065 'count_query' => $count_query,
3072 Returns a list of two package counts. The first is a count of packages
3073 based on the supplied criteria and the second is the count of residential
3074 packages with those same criteria. Criteria are specified as in the search
3080 my ($class, $params) = @_;
3082 my $sql_query = $class->search( $params );
3084 my $count_sql = delete($sql_query->{'count_query'});
3085 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
3086 or die "couldn't parse count_sql";
3088 my $count_sth = dbh->prepare($count_sql)
3089 or die "Error preparing $count_sql: ". dbh->errstr;
3091 or die "Error executing $count_sql: ". $count_sth->errstr;
3092 my $count_arrayref = $count_sth->fetchrow_arrayref;
3094 return ( @$count_arrayref );
3101 Returns a list: the first item is an SQL fragment identifying matching
3102 packages/customers via location (taking into account shipping and package
3103 address taxation, if enabled), and subsequent items are the parameters to
3104 substitute for the placeholders in that fragment.
3109 my($class, %opt) = @_;
3110 my $ornull = $opt{'ornull'};
3112 my $conf = new FS::Conf;
3114 # '?' placeholders in _location_sql_where
3115 my $x = $ornull ? 3 : 2;
3116 my @bill_param = ( ('city')x3, ('county')x$x, ('state')x$x, 'country' );
3120 if ( $conf->exists('tax-ship_address') ) {
3123 ( ( ship_last IS NULL OR ship_last = '' )
3124 AND ". _location_sql_where('cust_main', '', $ornull ). "
3126 OR ( ship_last IS NOT NULL AND ship_last != ''
3127 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
3130 # AND payby != 'COMP'
3132 @main_param = ( @bill_param, @bill_param );
3136 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
3137 @main_param = @bill_param;
3143 if ( $conf->exists('tax-pkg_address') ) {
3145 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
3148 ( cust_pkg.locationnum IS NULL AND $main_where )
3149 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
3152 @param = ( @main_param, @bill_param );
3156 $where = $main_where;
3157 @param = @main_param;
3165 #subroutine, helper for location_sql
3166 sub _location_sql_where {
3168 my $prefix = @_ ? shift : '';
3169 my $ornull = @_ ? shift : '';
3171 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
3173 $ornull = $ornull ? ' OR ? IS NULL ' : '';
3175 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL ) ";
3176 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL ) ";
3177 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL ) ";
3179 # ( $table.${prefix}city = ? $or_empty_city $ornull )
3181 ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS text) IS NULL )
3182 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
3183 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
3184 AND $table.${prefix}country = ?
3192 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
3194 CUSTNUM is a customer (see L<FS::cust_main>)
3196 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3197 L<FS::part_pkg>) to order for this customer. Duplicates are of course
3200 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
3201 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
3202 new billing items. An error is returned if this is not possible (see
3203 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
3206 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3207 newly-created cust_pkg objects.
3209 REFNUM, if specified, will specify the FS::pkg_referral record to be created
3210 and inserted. Multiple FS::pkg_referral records can be created by
3211 setting I<refnum> to an array reference of refnums or a hash reference with
3212 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
3213 record will be created corresponding to cust_main.refnum.
3218 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
3220 my $conf = new FS::Conf;
3222 # Transactionize this whole mess
3223 local $SIG{HUP} = 'IGNORE';
3224 local $SIG{INT} = 'IGNORE';
3225 local $SIG{QUIT} = 'IGNORE';
3226 local $SIG{TERM} = 'IGNORE';
3227 local $SIG{TSTP} = 'IGNORE';
3228 local $SIG{PIPE} = 'IGNORE';
3230 my $oldAutoCommit = $FS::UID::AutoCommit;
3231 local $FS::UID::AutoCommit = 0;
3235 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
3236 # return "Customer not found: $custnum" unless $cust_main;
3238 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
3241 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3244 my $change = scalar(@old_cust_pkg) != 0;
3247 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
3249 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
3250 " to pkgpart ". $pkgparts->[0]. "\n"
3253 my $err_or_cust_pkg =
3254 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
3255 'refnum' => $refnum,
3258 unless (ref($err_or_cust_pkg)) {
3259 $dbh->rollback if $oldAutoCommit;
3260 return $err_or_cust_pkg;
3263 push @$return_cust_pkg, $err_or_cust_pkg;
3264 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3269 # Create the new packages.
3270 foreach my $pkgpart (@$pkgparts) {
3272 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
3274 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
3275 pkgpart => $pkgpart,
3279 $error = $cust_pkg->insert( 'change' => $change );
3281 $dbh->rollback if $oldAutoCommit;
3284 push @$return_cust_pkg, $cust_pkg;
3286 # $return_cust_pkg now contains refs to all of the newly
3289 # Transfer services and cancel old packages.
3290 foreach my $old_pkg (@old_cust_pkg) {
3292 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
3295 foreach my $new_pkg (@$return_cust_pkg) {
3296 $error = $old_pkg->transfer($new_pkg);
3297 if ($error and $error == 0) {
3298 # $old_pkg->transfer failed.
3299 $dbh->rollback if $oldAutoCommit;
3304 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
3305 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
3306 foreach my $new_pkg (@$return_cust_pkg) {
3307 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
3308 if ($error and $error == 0) {
3309 # $old_pkg->transfer failed.
3310 $dbh->rollback if $oldAutoCommit;
3317 # Transfers were successful, but we went through all of the
3318 # new packages and still had services left on the old package.
3319 # We can't cancel the package under the circumstances, so abort.
3320 $dbh->rollback if $oldAutoCommit;
3321 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
3323 $error = $old_pkg->cancel( quiet=>1 );
3329 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3333 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
3335 A bulk change method to change packages for multiple customers.
3337 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3338 L<FS::part_pkg>) to order for each customer. Duplicates are of course
3341 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
3342 replace. The services (see L<FS::cust_svc>) are moved to the
3343 new billing items. An error is returned if this is not possible (see
3346 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3347 newly-created cust_pkg objects.
3352 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
3354 # Transactionize this whole mess
3355 local $SIG{HUP} = 'IGNORE';
3356 local $SIG{INT} = 'IGNORE';
3357 local $SIG{QUIT} = 'IGNORE';
3358 local $SIG{TERM} = 'IGNORE';
3359 local $SIG{TSTP} = 'IGNORE';
3360 local $SIG{PIPE} = 'IGNORE';
3362 my $oldAutoCommit = $FS::UID::AutoCommit;
3363 local $FS::UID::AutoCommit = 0;
3367 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3370 while(scalar(@old_cust_pkg)) {
3372 my $custnum = $old_cust_pkg[0]->custnum;
3373 my (@remove) = map { $_->pkgnum }
3374 grep { $_->custnum == $custnum } @old_cust_pkg;
3375 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
3377 my $error = order $custnum, $pkgparts, \@remove, \@return;
3379 push @errors, $error
3381 push @$return_cust_pkg, @return;
3384 if (scalar(@errors)) {
3385 $dbh->rollback if $oldAutoCommit;
3386 return join(' / ', @errors);
3389 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3393 # Used by FS::Upgrade to migrate to a new database.
3394 sub _upgrade_data { # class method
3395 my ($class, %opts) = @_;
3396 $class->_upgrade_otaker(%opts);
3398 # RT#10139, bug resulting in contract_end being set when it shouldn't
3399 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
3400 # RT#10830, bad calculation of prorate date near end of year
3401 # the date range for bill is December 2009, and we move it forward
3402 # one year if it's before the previous bill date (which it should
3404 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
3405 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
3406 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
3407 # RT6628, add order_date to cust_pkg
3408 'update cust_pkg set order_date = (select history_date from h_cust_pkg
3409 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
3410 history_action = \'insert\') where order_date is null',
3412 foreach my $sql (@statements) {
3413 my $sth = dbh->prepare($sql);
3414 $sth->execute or die $sth->errstr;
3422 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
3424 In sub order, the @pkgparts array (passed by reference) is clobbered.
3426 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
3427 method to pass dates to the recur_prog expression, it should do so.
3429 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
3430 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
3431 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
3432 configuration values. Probably need a subroutine which decides what to do
3433 based on whether or not we've fetched the user yet, rather than a hash. See
3434 FS::UID and the TODO.
3436 Now that things are transactional should the check in the insert method be
3441 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
3442 L<FS::pkg_svc>, schema.html from the base documentation