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 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;
35 # need to 'use' these instead of 'require' in sub { cancel, suspend, unsuspend,
37 # because they load configuration by setting FS::UID::callback (see TODO)
43 # for sending cancel emails in sub cancel
47 $me = '[FS::cust_pkg]';
49 $disable_agentcheck = 0;
53 my ( $hashref, $cache ) = @_;
54 #if ( $hashref->{'pkgpart'} ) {
55 if ( $hashref->{'pkg'} ) {
56 # #@{ $self->{'_pkgnum'} } = ();
57 # my $subcache = $cache->subcache('pkgpart', 'part_pkg');
58 # $self->{'_pkgpart'} = $subcache;
59 # #push @{ $self->{'_pkgnum'} },
60 # FS::part_pkg->new_or_cached($hashref, $subcache);
61 $self->{'_pkgpart'} = FS::part_pkg->new($hashref);
63 if ( exists $hashref->{'svcnum'} ) {
64 #@{ $self->{'_pkgnum'} } = ();
65 my $subcache = $cache->subcache('svcnum', 'cust_svc', $hashref->{pkgnum});
66 $self->{'_svcnum'} = $subcache;
67 #push @{ $self->{'_pkgnum'} },
68 FS::cust_svc->new_or_cached($hashref, $subcache) if $hashref->{svcnum};
74 FS::cust_pkg - Object methods for cust_pkg objects
80 $record = new FS::cust_pkg \%hash;
81 $record = new FS::cust_pkg { 'column' => 'value' };
83 $error = $record->insert;
85 $error = $new_record->replace($old_record);
87 $error = $record->delete;
89 $error = $record->check;
91 $error = $record->cancel;
93 $error = $record->suspend;
95 $error = $record->unsuspend;
97 $part_pkg = $record->part_pkg;
99 @labels = $record->labels;
101 $seconds = $record->seconds_since($timestamp);
103 $error = FS::cust_pkg::order( $custnum, \@pkgparts );
104 $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );
108 An FS::cust_pkg object represents a customer billing item. FS::cust_pkg
109 inherits from FS::Record. The following fields are currently supported:
115 Primary key (assigned automatically for new billing items)
119 Customer (see L<FS::cust_main>)
123 Billing item definition (see L<FS::part_pkg>)
127 Optional link to package location (see L<FS::location>)
131 date package was ordered (also remains same on changes)
143 date (next bill date)
171 order taker (see L<FS::access_user>)
175 If this field is set to 1, disables the automatic
176 unsuspension of this package when using the B<unsuspendauto> config option.
180 If not set, defaults to 1
184 Date of change from previous package
194 =item change_locationnum
202 Note: setup, last_bill, bill, adjourn, susp, expire, cancel and change_date
203 are specified as UNIX timestamps; see L<perlfunc/"time">. Also see
204 L<Time::Local> and L<Date::Parse> for conversion functions.
212 Create a new billing item. To add the item to the database, see L<"insert">.
216 sub table { 'cust_pkg'; }
217 sub cust_linked { $_[0]->cust_main_custnum; }
218 sub cust_unlinked_msg {
220 "WARNING: can't find cust_main.custnum ". $self->custnum.
221 ' (cust_pkg.pkgnum '. $self->pkgnum. ')';
224 =item insert [ OPTION => VALUE ... ]
226 Adds this billing item to the database ("Orders" the item). If there is an
227 error, returns the error, otherwise returns false.
229 If the additional field I<promo_code> is defined instead of I<pkgpart>, it
230 will be used to look up the package definition and agent restrictions will be
233 If the additional field I<refnum> is defined, an FS::pkg_referral record will
234 be created and inserted. Multiple FS::pkg_referral records can be created by
235 setting I<refnum> to an array reference of refnums or a hash reference with
236 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
237 record will be created corresponding to cust_main.refnum.
239 The following options are available:
245 If set true, supresses any referral credit to a referring customer.
249 cust_pkg_option records will be created
253 a ticket will be added to this customer with this subject
257 an optional queue name for ticket additions
264 my( $self, %options ) = @_;
266 my $error = $self->check_pkgpart;
267 return $error if $error;
269 my $part_pkg = $self->part_pkg;
271 if ( $part_pkg->option('start_1st', 1) && !$self->start_date ) {
272 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime(time) )[0,1,2,3,4,5];
273 $mon += 1 unless $mday == 1;
274 until ( $mon < 12 ) { $mon -= 12; $year++; }
275 $self->start_date( timelocal_nocheck(0,0,0,1,$mon,$year) );
278 foreach my $action ( qw(expire adjourn contract_end) ) {
279 my $months = $part_pkg->option("${action}_months",1);
280 if($months and !$self->$action) {
281 my $start = $self->start_date || $self->setup || time;
282 $self->$action( $part_pkg->add_freq($start, $months) );
286 my $free_days = $part_pkg->option('free_days');
287 if ( $free_days && $part_pkg->option('delay_setup',1) ) { #&& !$self->start_date
288 my ($mday,$mon,$year) = (localtime(time) )[3,4,5];
289 #my $start_date = ($self->start_date || timelocal(0,0,0,$mday,$mon,$year)) + 86400 * $free_days;
290 my $start_date = timelocal(0,0,0,$mday,$mon,$year) + 86400 * $free_days;
291 $self->start_date($start_date);
294 $self->order_date(time);
296 local $SIG{HUP} = 'IGNORE';
297 local $SIG{INT} = 'IGNORE';
298 local $SIG{QUIT} = 'IGNORE';
299 local $SIG{TERM} = 'IGNORE';
300 local $SIG{TSTP} = 'IGNORE';
301 local $SIG{PIPE} = 'IGNORE';
303 my $oldAutoCommit = $FS::UID::AutoCommit;
304 local $FS::UID::AutoCommit = 0;
307 $error = $self->SUPER::insert($options{options} ? %{$options{options}} : ());
309 $dbh->rollback if $oldAutoCommit;
313 $self->refnum($self->cust_main->refnum) unless $self->refnum;
314 $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
315 $self->process_m2m( 'link_table' => 'pkg_referral',
316 'target_table' => 'part_referral',
317 'params' => $self->refnum,
320 if ( $self->discountnum ) {
321 my $error = $self->insert_discount();
323 $dbh->rollback if $oldAutoCommit;
328 #if ( $self->reg_code ) {
329 # my $reg_code = qsearchs('reg_code', { 'code' => $self->reg_code } );
330 # $error = $reg_code->delete;
332 # $dbh->rollback if $oldAutoCommit;
337 my $conf = new FS::Conf;
339 if ( $conf->config('ticket_system') && $options{ticket_subject} ) {
342 # use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
349 use FS::TicketSystem;
350 FS::TicketSystem->init();
352 my $q = new RT::Queue($RT::SystemUser);
353 $q->Load($options{ticket_queue}) if $options{ticket_queue};
354 my $t = new RT::Ticket($RT::SystemUser);
355 my $mime = new MIME::Entity;
356 $mime->build( Type => 'text/plain', Data => $options{ticket_subject} );
357 $t->Create( $options{ticket_queue} ? (Queue => $q) : (),
358 Subject => $options{ticket_subject},
361 $t->AddLink( Type => 'MemberOf',
362 Target => 'freeside://freeside/cust_main/'. $self->custnum,
366 if ($conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
367 my $queue = new FS::queue {
368 'job' => 'FS::cust_main::queueable_print',
370 $error = $queue->insert(
371 'custnum' => $self->custnum,
372 'template' => 'welcome_letter',
376 warn "can't send welcome letter: $error";
381 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
388 This method now works but you probably shouldn't use it.
390 You don't want to delete packages, because there would then be no record
391 the customer ever purchased the package. Instead, see the cancel method and
392 hide cancelled packages.
399 local $SIG{HUP} = 'IGNORE';
400 local $SIG{INT} = 'IGNORE';
401 local $SIG{QUIT} = 'IGNORE';
402 local $SIG{TERM} = 'IGNORE';
403 local $SIG{TSTP} = 'IGNORE';
404 local $SIG{PIPE} = 'IGNORE';
406 my $oldAutoCommit = $FS::UID::AutoCommit;
407 local $FS::UID::AutoCommit = 0;
410 foreach my $cust_pkg_discount ($self->cust_pkg_discount) {
411 my $error = $cust_pkg_discount->delete;
413 $dbh->rollback if $oldAutoCommit;
417 #cust_bill_pkg_discount?
419 foreach my $cust_pkg_detail ($self->cust_pkg_detail) {
420 my $error = $cust_pkg_detail->delete;
422 $dbh->rollback if $oldAutoCommit;
427 foreach my $cust_pkg_reason (
429 'table' => 'cust_pkg_reason',
430 'hashref' => { 'pkgnum' => $self->pkgnum },
434 my $error = $cust_pkg_reason->delete;
436 $dbh->rollback if $oldAutoCommit;
443 my $error = $self->SUPER::delete(@_);
445 $dbh->rollback if $oldAutoCommit;
449 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
455 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
457 Replaces the OLD_RECORD with this one in the database. If there is an error,
458 returns the error, otherwise returns false.
460 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
462 Changing pkgpart may have disasterous effects. See the order subroutine.
464 setup and bill are normally updated by calling the bill method of a customer
465 object (see L<FS::cust_main>).
467 suspend is normally updated by the suspend and unsuspend methods.
469 cancel is normally updated by the cancel method (and also the order subroutine
472 Available options are:
478 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.
482 the access_user (see L<FS::access_user>) providing the reason
486 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
495 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
500 ( ref($_[0]) eq 'HASH' )
504 #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
505 #return "Can't change otaker!" if $old->otaker ne $new->otaker;
508 #return "Can't change setup once it exists!"
509 # if $old->getfield('setup') &&
510 # $old->getfield('setup') != $new->getfield('setup');
512 #some logic for bill, susp, cancel?
514 local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
516 local $SIG{HUP} = 'IGNORE';
517 local $SIG{INT} = 'IGNORE';
518 local $SIG{QUIT} = 'IGNORE';
519 local $SIG{TERM} = 'IGNORE';
520 local $SIG{TSTP} = 'IGNORE';
521 local $SIG{PIPE} = 'IGNORE';
523 my $oldAutoCommit = $FS::UID::AutoCommit;
524 local $FS::UID::AutoCommit = 0;
527 foreach my $method ( qw(adjourn expire) ) { # How many reasons?
528 if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
529 my $error = $new->insert_reason(
530 'reason' => $options->{'reason'},
531 'date' => $new->$method,
533 'reason_otaker' => $options->{'reason_otaker'},
536 dbh->rollback if $oldAutoCommit;
537 return "Error inserting cust_pkg_reason: $error";
542 #save off and freeze RADIUS attributes for any associated svc_acct records
544 if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
546 #also check for specific exports?
547 # to avoid spurious modify export events
548 @svc_acct = map { $_->svc_x }
549 grep { $_->part_svc->svcdb eq 'svc_acct' }
552 $_->snapshot foreach @svc_acct;
556 my $error = $new->SUPER::replace($old,
557 $options->{options} ? $options->{options} : ()
560 $dbh->rollback if $oldAutoCommit;
564 #for prepaid packages,
565 #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
566 foreach my $old_svc_acct ( @svc_acct ) {
567 my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
569 $new_svc_acct->replace( $old_svc_acct,
570 'depend_jobnum' => $options->{depend_jobnum},
573 $dbh->rollback if $oldAutoCommit;
578 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
585 Checks all fields to make sure this is a valid billing item. If there is an
586 error, returns the error, otherwise returns false. Called by the insert and
594 $self->locationnum('') if !$self->locationnum || $self->locationnum == -1;
597 $self->ut_numbern('pkgnum')
598 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
599 || $self->ut_numbern('pkgpart')
600 || $self->check_pkgpart
601 || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
602 || $self->ut_numbern('start_date')
603 || $self->ut_numbern('setup')
604 || $self->ut_numbern('bill')
605 || $self->ut_numbern('susp')
606 || $self->ut_numbern('cancel')
607 || $self->ut_numbern('adjourn')
608 || $self->ut_numbern('expire')
609 || $self->ut_enum('no_auto', [ '', 'Y' ])
610 || $self->ut_enum('waive_setup', [ '', 'Y' ])
611 || $self->ut_numbern('agent_pkgid')
612 || $self->ut_enum('recur_show_zero', [ '', 'Y', 'N', ])
613 || $self->ut_enum('setup_show_zero', [ '', 'Y', 'N', ])
615 return $error if $error;
617 return "A package with both start date (future start) and setup date (already started) will never bill"
618 if $self->start_date && $self->setup;
620 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
622 if ( $self->dbdef_table->column('manual_flag') ) {
623 $self->manual_flag('') if $self->manual_flag eq ' ';
624 $self->manual_flag =~ /^([01]?)$/
625 or return "Illegal manual_flag ". $self->manual_flag;
626 $self->manual_flag($1);
639 my $error = $self->ut_numbern('pkgpart');
640 return $error if $error;
642 if ( $self->reg_code ) {
644 unless ( grep { $self->pkgpart == $_->pkgpart }
645 map { $_->reg_code_pkg }
646 qsearchs( 'reg_code', { 'code' => $self->reg_code,
647 'agentnum' => $self->cust_main->agentnum })
649 return "Unknown registration code";
652 } elsif ( $self->promo_code ) {
655 qsearchs('part_pkg', {
656 'pkgpart' => $self->pkgpart,
657 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
659 return 'Unknown promotional code' unless $promo_part_pkg;
663 unless ( $disable_agentcheck ) {
665 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
666 return "agent ". $agent->agentnum. ':'. $agent->agent.
667 " can't purchase pkgpart ". $self->pkgpart
668 unless $agent->pkgpart_hashref->{ $self->pkgpart }
669 || $agent->agentnum == $self->part_pkg->agentnum;
672 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
673 return $error if $error;
681 =item cancel [ OPTION => VALUE ... ]
683 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
684 in this package, then cancels the package itself (sets the cancel field to
687 Available options are:
691 =item quiet - can be set true to supress email cancellation notices.
693 =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.
695 =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.
697 =item date - can be set to a unix style timestamp to specify when to cancel (expire)
699 =item nobill - can be set true to skip billing if it might otherwise be done.
701 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
702 not credit it. This must be set (by change()) when changing the package
703 to a different pkgpart or location, and probably shouldn't be in any other
704 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
709 If there is an error, returns the error, otherwise returns false.
714 my( $self, %options ) = @_;
717 my $conf = new FS::Conf;
719 warn "cust_pkg::cancel called with options".
720 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
723 local $SIG{HUP} = 'IGNORE';
724 local $SIG{INT} = 'IGNORE';
725 local $SIG{QUIT} = 'IGNORE';
726 local $SIG{TERM} = 'IGNORE';
727 local $SIG{TSTP} = 'IGNORE';
728 local $SIG{PIPE} = 'IGNORE';
730 my $oldAutoCommit = $FS::UID::AutoCommit;
731 local $FS::UID::AutoCommit = 0;
734 my $old = $self->select_for_update;
736 if ( $old->get('cancel') || $self->get('cancel') ) {
737 dbh->rollback if $oldAutoCommit;
738 return ""; # no error
741 my $date = $options{date} if $options{date}; # expire/cancel later
742 $date = '' if ($date && $date <= time); # complain instead?
744 #race condition: usage could be ongoing until unprovisioned
745 #resolved by performing a change package instead (which unprovisions) and
747 if ( !$options{nobill} && !$date && $conf->exists('bill_usage_on_cancel') ) {
748 my $copy = $self->new({$self->hash});
750 $copy->cust_main->bill( pkg_list => [ $copy ], cancel => 1 );
751 warn "Error billing during cancel, custnum ".
752 #$self->cust_main->custnum. ": $error"
757 my $cancel_time = $options{'time'} || time;
759 if ( $options{'reason'} ) {
760 $error = $self->insert_reason( 'reason' => $options{'reason'},
761 'action' => $date ? 'expire' : 'cancel',
762 'date' => $date ? $date : $cancel_time,
763 'reason_otaker' => $options{'reason_otaker'},
766 dbh->rollback if $oldAutoCommit;
767 return "Error inserting cust_pkg_reason: $error";
773 foreach my $cust_svc (
776 sort { $a->[1] <=> $b->[1] }
777 map { [ $_, $_->svc_x->table_info->{'cancel_weight'} ]; }
778 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
780 my $error = $cust_svc->cancel;
783 $dbh->rollback if $oldAutoCommit;
784 return "Error cancelling cust_svc: $error";
788 # Add a credit for remaining service
789 my $last_bill = $self->getfield('last_bill') || 0;
790 my $next_bill = $self->getfield('bill') || 0;
792 if ( exists($options{'unused_credit'}) ) {
793 $do_credit = $options{'unused_credit'};
796 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
799 and $last_bill > 0 # the package has been billed
800 and $next_bill > 0 # the package has a next bill date
801 and $next_bill >= $cancel_time # which is in the future
803 my $remaining_value = $self->calc_remain('time' => $cancel_time);
804 if ( $remaining_value > 0 ) {
805 my $error = $self->cust_main->credit(
807 'Credit for unused time on '. $self->part_pkg->pkg,
808 'reason_type' => $conf->config('cancel_credit_type'),
811 $dbh->rollback if $oldAutoCommit;
812 return "Error crediting customer \$$remaining_value for unused time".
813 " on ". $self->part_pkg->pkg. ": $error";
815 } #if $remaining_value
820 my %hash = $self->hash;
821 $date ? ($hash{'expire'} = $date) : ($hash{'cancel'} = $cancel_time);
822 my $new = new FS::cust_pkg ( \%hash );
823 $error = $new->replace( $self, options => { $self->options } );
825 $dbh->rollback if $oldAutoCommit;
829 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
830 return '' if $date; #no errors
832 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
833 if ( !$options{'quiet'} &&
834 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
836 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
839 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
840 $error = $msg_template->send( 'cust_main' => $self->cust_main,
845 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
846 'to' => \@invoicing_list,
847 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
848 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
851 #should this do something on errors?
858 =item cancel_if_expired [ NOW_TIMESTAMP ]
860 Cancels this package if its expire date has been reached.
864 sub cancel_if_expired {
866 my $time = shift || time;
867 return '' unless $self->expire && $self->expire <= $time;
868 my $error = $self->cancel;
870 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
871 $self->custnum. ": $error";
878 Cancels any pending expiration (sets the expire field to null).
880 If there is an error, returns the error, otherwise returns false.
885 my( $self, %options ) = @_;
888 local $SIG{HUP} = 'IGNORE';
889 local $SIG{INT} = 'IGNORE';
890 local $SIG{QUIT} = 'IGNORE';
891 local $SIG{TERM} = 'IGNORE';
892 local $SIG{TSTP} = 'IGNORE';
893 local $SIG{PIPE} = 'IGNORE';
895 my $oldAutoCommit = $FS::UID::AutoCommit;
896 local $FS::UID::AutoCommit = 0;
899 my $old = $self->select_for_update;
901 my $pkgnum = $old->pkgnum;
902 if ( $old->get('cancel') || $self->get('cancel') ) {
903 dbh->rollback if $oldAutoCommit;
904 return "Can't unexpire cancelled package $pkgnum";
905 # or at least it's pointless
908 unless ( $old->get('expire') && $self->get('expire') ) {
909 dbh->rollback if $oldAutoCommit;
910 return ""; # no error
913 my %hash = $self->hash;
914 $hash{'expire'} = '';
915 my $new = new FS::cust_pkg ( \%hash );
916 $error = $new->replace( $self, options => { $self->options } );
918 $dbh->rollback if $oldAutoCommit;
922 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
928 =item suspend [ OPTION => VALUE ... ]
930 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
931 package, then suspends the package itself (sets the susp field to now).
933 Available options are:
937 =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.
939 =item date - can be set to a unix style timestamp to specify when to suspend (adjourn)
943 If there is an error, returns the error, otherwise returns false.
948 my( $self, %options ) = @_;
951 local $SIG{HUP} = 'IGNORE';
952 local $SIG{INT} = 'IGNORE';
953 local $SIG{QUIT} = 'IGNORE';
954 local $SIG{TERM} = 'IGNORE';
955 local $SIG{TSTP} = 'IGNORE';
956 local $SIG{PIPE} = 'IGNORE';
958 my $oldAutoCommit = $FS::UID::AutoCommit;
959 local $FS::UID::AutoCommit = 0;
962 my $old = $self->select_for_update;
964 my $pkgnum = $old->pkgnum;
965 if ( $old->get('cancel') || $self->get('cancel') ) {
966 dbh->rollback if $oldAutoCommit;
967 return "Can't suspend cancelled package $pkgnum";
970 if ( $old->get('susp') || $self->get('susp') ) {
971 dbh->rollback if $oldAutoCommit;
972 return ""; # no error # complain on adjourn?
975 my $date = $options{date} if $options{date}; # adjourn/suspend later
976 $date = '' if ($date && $date <= time); # complain instead?
978 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
979 dbh->rollback if $oldAutoCommit;
980 return "Package $pkgnum expires before it would be suspended.";
983 my $suspend_time = $options{'time'} || time;
985 if ( $options{'reason'} ) {
986 $error = $self->insert_reason( 'reason' => $options{'reason'},
987 'action' => $date ? 'adjourn' : 'suspend',
988 'date' => $date ? $date : $suspend_time,
989 'reason_otaker' => $options{'reason_otaker'},
992 dbh->rollback if $oldAutoCommit;
993 return "Error inserting cust_pkg_reason: $error";
1001 foreach my $cust_svc (
1002 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1004 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1006 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1007 $dbh->rollback if $oldAutoCommit;
1008 return "Illegal svcdb value in part_svc!";
1011 require "FS/$svcdb.pm";
1013 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1015 $error = $svc->suspend;
1017 $dbh->rollback if $oldAutoCommit;
1020 my( $label, $value ) = $cust_svc->label;
1021 push @labels, "$label: $value";
1025 my $conf = new FS::Conf;
1026 if ( $conf->config('suspend_email_admin') ) {
1028 my $error = send_email(
1029 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1030 #invoice_from ??? well as good as any
1031 'to' => $conf->config('suspend_email_admin'),
1032 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1034 "This is an automatic message from your Freeside installation\n",
1035 "informing you that the following customer package has been suspended:\n",
1037 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1038 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1039 ( map { "Service : $_\n" } @labels ),
1044 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1052 my %hash = $self->hash;
1054 $hash{'adjourn'} = $date;
1056 $hash{'susp'} = $suspend_time;
1058 my $new = new FS::cust_pkg ( \%hash );
1059 $error = $new->replace( $self, options => { $self->options } );
1061 $dbh->rollback if $oldAutoCommit;
1065 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1070 =item unsuspend [ OPTION => VALUE ... ]
1072 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1073 package, then unsuspends the package itself (clears the susp field and the
1074 adjourn field if it is in the past).
1076 Available options are:
1080 =item adjust_next_bill
1082 Can be set true to adjust the next bill date forward by
1083 the amount of time the account was inactive. This was set true by default
1084 since 1.4.2 and 1.5.0pre6; however, starting with 1.7.0 this needs to be
1085 explicitly requested. Price plans for which this makes sense (anniversary-date
1086 based than prorate or subscription) could have an option to enable this
1091 If there is an error, returns the error, otherwise returns false.
1096 my( $self, %opt ) = @_;
1099 local $SIG{HUP} = 'IGNORE';
1100 local $SIG{INT} = 'IGNORE';
1101 local $SIG{QUIT} = 'IGNORE';
1102 local $SIG{TERM} = 'IGNORE';
1103 local $SIG{TSTP} = 'IGNORE';
1104 local $SIG{PIPE} = 'IGNORE';
1106 my $oldAutoCommit = $FS::UID::AutoCommit;
1107 local $FS::UID::AutoCommit = 0;
1110 my $old = $self->select_for_update;
1112 my $pkgnum = $old->pkgnum;
1113 if ( $old->get('cancel') || $self->get('cancel') ) {
1114 dbh->rollback if $oldAutoCommit;
1115 return "Can't unsuspend cancelled package $pkgnum";
1118 unless ( $old->get('susp') && $self->get('susp') ) {
1119 dbh->rollback if $oldAutoCommit;
1120 return ""; # no error # complain instead?
1123 foreach my $cust_svc (
1124 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1126 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1128 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1129 $dbh->rollback if $oldAutoCommit;
1130 return "Illegal svcdb value in part_svc!";
1133 require "FS/$svcdb.pm";
1135 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1137 $error = $svc->unsuspend;
1139 $dbh->rollback if $oldAutoCommit;
1146 my %hash = $self->hash;
1147 my $inactive = time - $hash{'susp'};
1149 my $conf = new FS::Conf;
1151 if ( $inactive > 0 &&
1152 ( $hash{'bill'} || $hash{'setup'} ) &&
1153 ( $opt{'adjust_next_bill'} ||
1154 $conf->exists('unsuspend-always_adjust_next_bill_date') ||
1155 $self->part_pkg->option('unsuspend_adjust_bill', 1) )
1158 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1163 $hash{'adjourn'} = '' if $hash{'adjourn'} < time;
1164 my $new = new FS::cust_pkg ( \%hash );
1165 $error = $new->replace( $self, options => { $self->options } );
1167 $dbh->rollback if $oldAutoCommit;
1171 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1178 Cancels any pending suspension (sets the adjourn field to null).
1180 If there is an error, returns the error, otherwise returns false.
1185 my( $self, %options ) = @_;
1188 local $SIG{HUP} = 'IGNORE';
1189 local $SIG{INT} = 'IGNORE';
1190 local $SIG{QUIT} = 'IGNORE';
1191 local $SIG{TERM} = 'IGNORE';
1192 local $SIG{TSTP} = 'IGNORE';
1193 local $SIG{PIPE} = 'IGNORE';
1195 my $oldAutoCommit = $FS::UID::AutoCommit;
1196 local $FS::UID::AutoCommit = 0;
1199 my $old = $self->select_for_update;
1201 my $pkgnum = $old->pkgnum;
1202 if ( $old->get('cancel') || $self->get('cancel') ) {
1203 dbh->rollback if $oldAutoCommit;
1204 return "Can't unadjourn cancelled package $pkgnum";
1205 # or at least it's pointless
1208 if ( $old->get('susp') || $self->get('susp') ) {
1209 dbh->rollback if $oldAutoCommit;
1210 return "Can't unadjourn suspended package $pkgnum";
1211 # perhaps this is arbitrary
1214 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1215 dbh->rollback if $oldAutoCommit;
1216 return ""; # no error
1219 my %hash = $self->hash;
1220 $hash{'adjourn'} = '';
1221 my $new = new FS::cust_pkg ( \%hash );
1222 $error = $new->replace( $self, options => { $self->options } );
1224 $dbh->rollback if $oldAutoCommit;
1228 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1235 =item change HASHREF | OPTION => VALUE ...
1237 Changes this package: cancels it and creates a new one, with a different
1238 pkgpart or locationnum or both. All services are transferred to the new
1239 package (no change will be made if this is not possible).
1241 Options may be passed as a list of key/value pairs or as a hash reference.
1248 New locationnum, to change the location for this package.
1252 New FS::cust_location object, to create a new location and assign it
1257 New pkgpart (see L<FS::part_pkg>).
1261 New refnum (see L<FS::part_referral>).
1265 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1266 susp, adjourn, cancel, expire, and contract_end) to the new package.
1270 At least one of locationnum, cust_location, pkgpart, refnum must be specified
1271 (otherwise, what's the point?)
1273 Returns either the new FS::cust_pkg object or a scalar error.
1277 my $err_or_new_cust_pkg = $old_cust_pkg->change
1281 #some false laziness w/order
1284 my $opt = ref($_[0]) ? shift : { @_ };
1286 # my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
1289 my $conf = new FS::Conf;
1291 # Transactionize this whole mess
1292 local $SIG{HUP} = 'IGNORE';
1293 local $SIG{INT} = 'IGNORE';
1294 local $SIG{QUIT} = 'IGNORE';
1295 local $SIG{TERM} = 'IGNORE';
1296 local $SIG{TSTP} = 'IGNORE';
1297 local $SIG{PIPE} = 'IGNORE';
1299 my $oldAutoCommit = $FS::UID::AutoCommit;
1300 local $FS::UID::AutoCommit = 0;
1309 #$hash{$_} = $self->$_() foreach qw( last_bill bill );
1311 #$hash{$_} = $self->$_() foreach qw( setup );
1313 $hash{'setup'} = $time if $self->setup;
1315 $hash{'change_date'} = $time;
1316 $hash{"change_$_"} = $self->$_()
1317 foreach qw( pkgnum pkgpart locationnum );
1319 if ( $opt->{'cust_location'} &&
1320 ( ! $opt->{'locationnum'} || $opt->{'locationnum'} == -1 ) ) {
1321 $error = $opt->{'cust_location'}->insert;
1323 $dbh->rollback if $oldAutoCommit;
1324 return "inserting cust_location (transaction rolled back): $error";
1326 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1329 my $unused_credit = 0;
1330 if ( $opt->{'keep_dates'} ) {
1331 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1332 start_date contract_end ) ) {
1333 $hash{$date} = $self->getfield($date);
1336 # Special case. If the pkgpart is changing, and the customer is
1337 # going to be credited for remaining time, don't keep setup, bill,
1338 # or last_bill dates, and DO pass the flag to cancel() to credit
1340 if ( $opt->{'pkgpart'}
1341 and $opt->{'pkgpart'} != $self->pkgpart
1342 and $self->part_pkg->option('unused_credit_change', 1) ) {
1344 $hash{$_} = '' foreach qw(setup bill last_bill);
1347 # Create the new package.
1348 my $cust_pkg = new FS::cust_pkg {
1349 custnum => $self->custnum,
1350 pkgpart => ( $opt->{'pkgpart'} || $self->pkgpart ),
1351 refnum => ( $opt->{'refnum'} || $self->refnum ),
1352 locationnum => ( $opt->{'locationnum'} || $self->locationnum ),
1356 $error = $cust_pkg->insert( 'change' => 1 );
1358 $dbh->rollback if $oldAutoCommit;
1362 # Transfer services and cancel old package.
1364 $error = $self->transfer($cust_pkg);
1365 if ($error and $error == 0) {
1366 # $old_pkg->transfer failed.
1367 $dbh->rollback if $oldAutoCommit;
1371 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
1372 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
1373 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
1374 if ($error and $error == 0) {
1375 # $old_pkg->transfer failed.
1376 $dbh->rollback if $oldAutoCommit;
1382 # Transfers were successful, but we still had services left on the old
1383 # package. We can't change the package under this circumstances, so abort.
1384 $dbh->rollback if $oldAutoCommit;
1385 return "Unable to transfer all services from package ". $self->pkgnum;
1388 #reset usage if changing pkgpart
1389 # AND usage rollover is off (otherwise adds twice, now and at package bill)
1390 if ($self->pkgpart != $cust_pkg->pkgpart) {
1391 my $part_pkg = $cust_pkg->part_pkg;
1392 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
1396 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
1399 $dbh->rollback if $oldAutoCommit;
1400 return "Error setting usage values: $error";
1404 #Good to go, cancel old package. Notify 'cancel' of whether to credit
1406 $error = $self->cancel( quiet=>1, unused_credit => $unused_credit );
1408 $dbh->rollback if $oldAutoCommit;
1412 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
1414 my $error = $cust_pkg->cust_main->bill( 'pkg_list' => [ $cust_pkg ] );
1416 $dbh->rollback if $oldAutoCommit;
1421 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1427 use Storable 'thaw';
1429 sub process_bulk_cust_pkg {
1431 my $param = thaw(decode_base64(shift));
1432 warn Dumper($param) if $DEBUG;
1434 my $old_part_pkg = qsearchs('part_pkg',
1435 { pkgpart => $param->{'old_pkgpart'} });
1436 my $new_part_pkg = qsearchs('part_pkg',
1437 { pkgpart => $param->{'new_pkgpart'} });
1438 die "Must select a new package type\n" unless $new_part_pkg;
1439 #my $keep_dates = $param->{'keep_dates'} || 0;
1440 my $keep_dates = 1; # there is no good reason to turn this off
1442 local $SIG{HUP} = 'IGNORE';
1443 local $SIG{INT} = 'IGNORE';
1444 local $SIG{QUIT} = 'IGNORE';
1445 local $SIG{TERM} = 'IGNORE';
1446 local $SIG{TSTP} = 'IGNORE';
1447 local $SIG{PIPE} = 'IGNORE';
1449 my $oldAutoCommit = $FS::UID::AutoCommit;
1450 local $FS::UID::AutoCommit = 0;
1453 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
1456 foreach my $old_cust_pkg ( @cust_pkgs ) {
1458 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
1459 if ( $old_cust_pkg->getfield('cancel') ) {
1460 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
1461 $old_cust_pkg->pkgnum."\n"
1465 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
1467 my $error = $old_cust_pkg->change(
1468 'pkgpart' => $param->{'new_pkgpart'},
1469 'keep_dates' => $keep_dates
1471 if ( !ref($error) ) { # change returns the cust_pkg on success
1473 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
1476 $dbh->commit if $oldAutoCommit;
1482 Returns the last bill date, or if there is no last bill date, the setup date.
1483 Useful for billing metered services.
1489 return $self->setfield('last_bill', $_[0]) if @_;
1490 return $self->getfield('last_bill') if $self->getfield('last_bill');
1491 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
1492 'edate' => $self->bill, } );
1493 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
1496 =item last_cust_pkg_reason ACTION
1498 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
1499 Returns false if there is no reason or the package is not currenly ACTION'd
1500 ACTION is one of adjourn, susp, cancel, or expire.
1504 sub last_cust_pkg_reason {
1505 my ( $self, $action ) = ( shift, shift );
1506 my $date = $self->get($action);
1508 'table' => 'cust_pkg_reason',
1509 'hashref' => { 'pkgnum' => $self->pkgnum,
1510 'action' => substr(uc($action), 0, 1),
1513 'order_by' => 'ORDER BY num DESC LIMIT 1',
1517 =item last_reason ACTION
1519 Returns the most recent ACTION FS::reason associated with the package.
1520 Returns false if there is no reason or the package is not currenly ACTION'd
1521 ACTION is one of adjourn, susp, cancel, or expire.
1526 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
1527 $cust_pkg_reason->reason
1528 if $cust_pkg_reason;
1533 Returns the definition for this billing item, as an FS::part_pkg object (see
1540 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
1541 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
1542 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
1547 Returns the cancelled package this package was changed from, if any.
1553 return '' unless $self->change_pkgnum;
1554 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
1559 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
1566 $self->part_pkg->calc_setup($self, @_);
1571 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
1578 $self->part_pkg->calc_recur($self, @_);
1583 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
1590 $self->part_pkg->base_recur($self, @_);
1595 Calls the I<calc_remain> of the FS::part_pkg object associated with this
1602 $self->part_pkg->calc_remain($self, @_);
1607 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
1614 $self->part_pkg->calc_cancel($self, @_);
1619 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
1625 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
1628 =item cust_pkg_detail [ DETAILTYPE ]
1630 Returns any customer package details for this package (see
1631 L<FS::cust_pkg_detail>).
1633 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1637 sub cust_pkg_detail {
1639 my %hash = ( 'pkgnum' => $self->pkgnum );
1640 $hash{detailtype} = shift if @_;
1642 'table' => 'cust_pkg_detail',
1643 'hashref' => \%hash,
1644 'order_by' => 'ORDER BY weight, pkgdetailnum',
1648 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
1650 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
1652 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1654 If there is an error, returns the error, otherwise returns false.
1658 sub set_cust_pkg_detail {
1659 my( $self, $detailtype, @details ) = @_;
1661 local $SIG{HUP} = 'IGNORE';
1662 local $SIG{INT} = 'IGNORE';
1663 local $SIG{QUIT} = 'IGNORE';
1664 local $SIG{TERM} = 'IGNORE';
1665 local $SIG{TSTP} = 'IGNORE';
1666 local $SIG{PIPE} = 'IGNORE';
1668 my $oldAutoCommit = $FS::UID::AutoCommit;
1669 local $FS::UID::AutoCommit = 0;
1672 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
1673 my $error = $current->delete;
1675 $dbh->rollback if $oldAutoCommit;
1676 return "error removing old detail: $error";
1680 foreach my $detail ( @details ) {
1681 my $cust_pkg_detail = new FS::cust_pkg_detail {
1682 'pkgnum' => $self->pkgnum,
1683 'detailtype' => $detailtype,
1684 'detail' => $detail,
1686 my $error = $cust_pkg_detail->insert;
1688 $dbh->rollback if $oldAutoCommit;
1689 return "error adding new detail: $error";
1694 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1701 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
1705 #false laziness w/cust_bill.pm
1709 'table' => 'cust_event',
1710 'addl_from' => 'JOIN part_event USING ( eventpart )',
1711 'hashref' => { 'tablenum' => $self->pkgnum },
1712 'extra_sql' => " AND eventtable = 'cust_pkg' ",
1716 =item num_cust_event
1718 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
1722 #false laziness w/cust_bill.pm
1723 sub num_cust_event {
1726 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
1727 " WHERE tablenum = ? AND eventtable = 'cust_pkg'";
1728 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
1729 $sth->execute($self->pkgnum) or die $sth->errstr. " executing $sql";
1730 $sth->fetchrow_arrayref->[0];
1733 =item cust_svc [ SVCPART ]
1735 Returns the services for this package, as FS::cust_svc objects (see
1736 L<FS::cust_svc>). If a svcpart is specified, return only the matching
1744 return () unless $self->num_cust_svc(@_);
1747 return qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum,
1748 'svcpart' => shift, } );
1751 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
1753 #if ( $self->{'_svcnum'} ) {
1754 # values %{ $self->{'_svcnum'}->cache };
1756 $self->_sort_cust_svc(
1757 [ qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } ) ]
1763 =item overlimit [ SVCPART ]
1765 Returns the services for this package which have exceeded their
1766 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
1767 is specified, return only the matching services.
1773 return () unless $self->num_cust_svc(@_);
1774 grep { $_->overlimit } $self->cust_svc(@_);
1777 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
1779 Returns historical services for this package created before END TIMESTAMP and
1780 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
1781 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
1782 I<pkg_svc.hidden> flag will be omitted.
1788 warn "$me _h_cust_svc called on $self\n"
1791 my ($end, $start, $mode) = @_;
1792 my @cust_svc = $self->_sort_cust_svc(
1793 [ qsearch( 'h_cust_svc',
1794 { 'pkgnum' => $self->pkgnum, },
1795 FS::h_cust_svc->sql_h_search(@_),
1798 if ( defined($mode) && $mode eq 'I' ) {
1799 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
1800 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
1806 sub _sort_cust_svc {
1807 my( $self, $arrayref ) = @_;
1810 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
1815 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $self->pkgpart,
1816 'svcpart' => $_->svcpart } );
1818 $pkg_svc ? $pkg_svc->primary_svc : '',
1819 $pkg_svc ? $pkg_svc->quantity : 0,
1826 =item num_cust_svc [ SVCPART ]
1828 Returns the number of provisioned services for this package. If a svcpart is
1829 specified, counts only the matching services.
1836 return $self->{'_num_cust_svc'}
1838 && exists($self->{'_num_cust_svc'})
1839 && $self->{'_num_cust_svc'} =~ /\d/;
1841 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
1844 my $sql = 'SELECT COUNT(*) FROM cust_svc WHERE pkgnum = ?';
1845 $sql .= ' AND svcpart = ?' if @_;
1847 my $sth = dbh->prepare($sql) or die dbh->errstr;
1848 $sth->execute($self->pkgnum, @_) or die $sth->errstr;
1849 $sth->fetchrow_arrayref->[0];
1852 =item available_part_svc
1854 Returns a list of FS::part_svc objects representing services included in this
1855 package but not yet provisioned. Each FS::part_svc object also has an extra
1856 field, I<num_avail>, which specifies the number of available services.
1860 sub available_part_svc {
1862 grep { $_->num_avail > 0 }
1864 my $part_svc = $_->part_svc;
1865 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
1866 $_->quantity - $self->num_cust_svc($_->svcpart);
1868 # more evil encapsulation breakage
1869 if($part_svc->{'Hash'}{'num_avail'} > 0) {
1870 my @exports = $part_svc->part_export_did;
1871 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
1876 $self->part_pkg->pkg_svc;
1881 Returns a list of FS::part_svc objects representing provisioned and available
1882 services included in this package. Each FS::part_svc object also has the
1883 following extra fields:
1887 =item num_cust_svc (count)
1889 =item num_avail (quantity - count)
1891 =item cust_pkg_svc (services) - array reference containing the provisioned services, as cust_svc objects
1894 label -> ($cust_svc->label)[1]
1903 #XXX some sort of sort order besides numeric by svcpart...
1904 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
1906 my $part_svc = $pkg_svc->part_svc;
1907 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
1908 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
1909 $part_svc->{'Hash'}{'num_avail'} =
1910 max( 0, $pkg_svc->quantity - $num_cust_svc );
1911 $part_svc->{'Hash'}{'cust_pkg_svc'} =
1912 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
1913 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
1915 } $self->part_pkg->pkg_svc;
1918 push @part_svc, map {
1920 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
1921 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
1922 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
1923 $part_svc->{'Hash'}{'cust_pkg_svc'} =
1924 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
1926 } $self->extra_part_svc;
1932 =item extra_part_svc
1934 Returns a list of FS::part_svc objects corresponding to services in this
1935 package which are still provisioned but not (any longer) available in the
1940 sub extra_part_svc {
1943 my $pkgnum = $self->pkgnum;
1944 #my $pkgpart = $self->pkgpart;
1947 # 'table' => 'part_svc',
1950 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
1951 # WHERE pkg_svc.svcpart = part_svc.svcpart
1952 # AND pkg_svc.pkgpart = ?
1955 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
1956 # LEFT JOIN cust_pkg USING ( pkgnum )
1957 # WHERE cust_svc.svcpart = part_svc.svcpart
1960 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
1963 #seems to benchmark slightly faster... (or did?)
1965 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
1966 my $pkgparts = join(',', @pkgparts);
1969 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
1970 #MySQL doesn't grok DISINCT ON
1971 'select' => 'DISTINCT part_svc.*',
1972 'table' => 'part_svc',
1974 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
1975 AND pkg_svc.pkgpart IN ($pkgparts)
1978 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
1979 LEFT JOIN cust_pkg USING ( pkgnum )
1982 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
1983 'extra_param' => [ [$self->pkgnum=>'int'] ],
1989 Returns a short status string for this package, currently:
1993 =item not yet billed
1995 =item one-time charge
2010 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
2012 return 'cancelled' if $self->get('cancel');
2013 return 'suspended' if $self->susp;
2014 return 'not yet billed' unless $self->setup;
2015 return 'one-time charge' if $freq =~ /^(0|$)/;
2019 =item ucfirst_status
2021 Returns the status with the first character capitalized.
2025 sub ucfirst_status {
2026 ucfirst(shift->status);
2031 Class method that returns the list of possible status strings for packages
2032 (see L<the status method|/status>). For example:
2034 @statuses = FS::cust_pkg->statuses();
2038 tie my %statuscolor, 'Tie::IxHash',
2039 'not yet billed' => '009999', #teal? cyan?
2040 'one-time charge' => '000000',
2041 'active' => '00CC00',
2042 'suspended' => 'FF9900',
2043 'cancelled' => 'FF0000',
2047 my $self = shift; #could be class...
2048 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
2049 # # mayble split btw one-time vs. recur
2055 Returns a hex triplet color string for this package's status.
2061 $statuscolor{$self->status};
2066 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
2067 "pkg-comment" depending on user preference).
2073 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
2074 $label = $self->pkgnum. ": $label"
2075 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
2079 =item pkg_label_long
2081 Returns a long label for this package, adding the primary service's label to
2086 sub pkg_label_long {
2088 my $label = $self->pkg_label;
2089 my $cust_svc = $self->primary_cust_svc;
2090 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
2094 =item primary_cust_svc
2096 Returns a primary service (as FS::cust_svc object) if one can be identified.
2100 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
2102 sub primary_cust_svc {
2105 my @cust_svc = $self->cust_svc;
2107 return '' unless @cust_svc; #no serivces - irrelevant then
2109 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
2111 # primary service as specified in the package definition
2112 # or exactly one service definition with quantity one
2113 my $svcpart = $self->part_pkg->svcpart;
2114 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
2115 return $cust_svc[0] if scalar(@cust_svc) == 1;
2117 #couldn't identify one thing..
2123 Returns a list of lists, calling the label method for all services
2124 (see L<FS::cust_svc>) of this billing item.
2130 map { [ $_->label ] } $self->cust_svc;
2133 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2135 Like the labels method, but returns historical information on services that
2136 were active as of END_TIMESTAMP and (optionally) not cancelled before
2137 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
2138 I<pkg_svc.hidden> flag will be omitted.
2140 Returns a list of lists, calling the label method for all (historical) services
2141 (see L<FS::h_cust_svc>) of this billing item.
2147 warn "$me _h_labels called on $self\n"
2149 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
2154 Like labels, except returns a simple flat list, and shortens long
2155 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2156 identical services to one line that lists the service label and the number of
2157 individual services rather than individual items.
2162 shift->_labels_short( 'labels', @_ );
2165 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
2167 Like h_labels, except returns a simple flat list, and shortens long
2168 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2169 identical services to one line that lists the service label and the number of
2170 individual services rather than individual items.
2174 sub h_labels_short {
2175 shift->_labels_short( 'h_labels', @_ );
2179 my( $self, $method ) = ( shift, shift );
2181 warn "$me _labels_short called on $self with $method method\n"
2184 my $conf = new FS::Conf;
2185 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
2187 warn "$me _labels_short populating \%labels\n"
2191 #tie %labels, 'Tie::IxHash';
2192 push @{ $labels{$_->[0]} }, $_->[1]
2193 foreach $self->$method(@_);
2195 warn "$me _labels_short populating \@labels\n"
2199 foreach my $label ( keys %labels ) {
2201 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
2202 my $num = scalar(@values);
2203 warn "$me _labels_short $num items for $label\n"
2206 if ( $num > $max_same_services ) {
2207 warn "$me _labels_short more than $max_same_services, so summarizing\n"
2209 push @labels, "$label ($num)";
2211 if ( $conf->exists('cust_bill-consolidate_services') ) {
2212 warn "$me _labels_short consolidating services\n"
2214 # push @labels, "$label: ". join(', ', @values);
2216 my $detail = "$label: ";
2217 $detail .= shift(@values). ', '
2219 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
2221 push @labels, $detail;
2223 warn "$me _labels_short done consolidating services\n"
2226 warn "$me _labels_short adding service data\n"
2228 push @labels, map { "$label: $_" } @values;
2239 Returns the parent customer object (see L<FS::cust_main>).
2245 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
2248 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
2252 Returns the location object, if any (see L<FS::cust_location>).
2254 =item cust_location_or_main
2256 If this package is associated with a location, returns the locaiton (see
2257 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
2259 =item location_label [ OPTION => VALUE ... ]
2261 Returns the label of the location object (see L<FS::cust_location>).
2265 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
2267 =item seconds_since TIMESTAMP
2269 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
2270 package have been online since TIMESTAMP, according to the session monitor.
2272 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2273 L<Time::Local> and L<Date::Parse> for conversion functions.
2278 my($self, $since) = @_;
2281 foreach my $cust_svc (
2282 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
2284 $seconds += $cust_svc->seconds_since($since);
2291 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
2293 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
2294 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
2297 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2298 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2304 sub seconds_since_sqlradacct {
2305 my($self, $start, $end) = @_;
2309 foreach my $cust_svc (
2311 my $part_svc = $_->part_svc;
2312 $part_svc->svcdb eq 'svc_acct'
2313 && scalar($part_svc->part_export('sqlradius'));
2316 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
2323 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
2325 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
2326 in this package for sessions ending between TIMESTAMP_START (inclusive) and
2330 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2331 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2336 sub attribute_since_sqlradacct {
2337 my($self, $start, $end, $attrib) = @_;
2341 foreach my $cust_svc (
2343 my $part_svc = $_->part_svc;
2344 $part_svc->svcdb eq 'svc_acct'
2345 && scalar($part_svc->part_export('sqlradius'));
2348 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
2360 my( $self, $value ) = @_;
2361 if ( defined($value) ) {
2362 $self->setfield('quantity', $value);
2364 $self->getfield('quantity') || 1;
2367 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
2369 Transfers as many services as possible from this package to another package.
2371 The destination package can be specified by pkgnum by passing an FS::cust_pkg
2372 object. The destination package must already exist.
2374 Services are moved only if the destination allows services with the correct
2375 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
2376 this option with caution! No provision is made for export differences
2377 between the old and new service definitions. Probably only should be used
2378 when your exports for all service definitions of a given svcdb are identical.
2379 (attempt a transfer without it first, to move all possible svcpart-matching
2382 Any services that can't be moved remain in the original package.
2384 Returns an error, if there is one; otherwise, returns the number of services
2385 that couldn't be moved.
2390 my ($self, $dest_pkgnum, %opt) = @_;
2396 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
2397 $dest = $dest_pkgnum;
2398 $dest_pkgnum = $dest->pkgnum;
2400 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
2403 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
2405 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
2406 $target{$pkg_svc->svcpart} = $pkg_svc->quantity;
2409 foreach my $cust_svc ($dest->cust_svc) {
2410 $target{$cust_svc->svcpart}--;
2413 my %svcpart2svcparts = ();
2414 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2415 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
2416 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
2417 next if exists $svcpart2svcparts{$svcpart};
2418 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
2419 $svcpart2svcparts{$svcpart} = [
2421 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
2423 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
2424 'svcpart' => $_ } );
2426 $pkg_svc ? $pkg_svc->primary_svc : '',
2427 $pkg_svc ? $pkg_svc->quantity : 0,
2431 grep { $_ != $svcpart }
2433 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
2435 warn "alternates for svcpart $svcpart: ".
2436 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
2441 foreach my $cust_svc ($self->cust_svc) {
2442 if($target{$cust_svc->svcpart} > 0) {
2443 $target{$cust_svc->svcpart}--;
2444 my $new = new FS::cust_svc { $cust_svc->hash };
2445 $new->pkgnum($dest_pkgnum);
2446 my $error = $new->replace($cust_svc);
2447 return $error if $error;
2448 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2450 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
2451 warn "alternates to consider: ".
2452 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
2454 my @alternate = grep {
2455 warn "considering alternate svcpart $_: ".
2456 "$target{$_} available in new package\n"
2459 } @{$svcpart2svcparts{$cust_svc->svcpart}};
2461 warn "alternate(s) found\n" if $DEBUG;
2462 my $change_svcpart = $alternate[0];
2463 $target{$change_svcpart}--;
2464 my $new = new FS::cust_svc { $cust_svc->hash };
2465 $new->svcpart($change_svcpart);
2466 $new->pkgnum($dest_pkgnum);
2467 my $error = $new->replace($cust_svc);
2468 return $error if $error;
2481 This method is deprecated. See the I<depend_jobnum> option to the insert and
2482 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
2489 local $SIG{HUP} = 'IGNORE';
2490 local $SIG{INT} = 'IGNORE';
2491 local $SIG{QUIT} = 'IGNORE';
2492 local $SIG{TERM} = 'IGNORE';
2493 local $SIG{TSTP} = 'IGNORE';
2494 local $SIG{PIPE} = 'IGNORE';
2496 my $oldAutoCommit = $FS::UID::AutoCommit;
2497 local $FS::UID::AutoCommit = 0;
2500 foreach my $cust_svc ( $self->cust_svc ) {
2501 #false laziness w/svc_Common::insert
2502 my $svc_x = $cust_svc->svc_x;
2503 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
2504 my $error = $part_export->export_insert($svc_x);
2506 $dbh->rollback if $oldAutoCommit;
2512 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2519 Associates this package with a (suspension or cancellation) reason (see
2520 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
2523 Available options are:
2529 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.
2533 the access_user (see L<FS::access_user>) providing the reason
2541 the action (cancel, susp, adjourn, expire) associated with the reason
2545 If there is an error, returns the error, otherwise returns false.
2550 my ($self, %options) = @_;
2552 my $otaker = $options{reason_otaker} ||
2553 $FS::CurrentUser::CurrentUser->username;
2556 if ( $options{'reason'} =~ /^(\d+)$/ ) {
2560 } elsif ( ref($options{'reason'}) ) {
2562 return 'Enter a new reason (or select an existing one)'
2563 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
2565 my $reason = new FS::reason({
2566 'reason_type' => $options{'reason'}->{'typenum'},
2567 'reason' => $options{'reason'}->{'reason'},
2569 my $error = $reason->insert;
2570 return $error if $error;
2572 $reasonnum = $reason->reasonnum;
2575 return "Unparsable reason: ". $options{'reason'};
2578 my $cust_pkg_reason =
2579 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
2580 'reasonnum' => $reasonnum,
2581 'otaker' => $otaker,
2582 'action' => substr(uc($options{'action'}),0,1),
2583 'date' => $options{'date'}
2588 $cust_pkg_reason->insert;
2591 =item insert_discount
2593 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
2594 inserting a new discount on the fly (see L<FS::discount>).
2596 Available options are:
2604 If there is an error, returns the error, otherwise returns false.
2608 sub insert_discount {
2609 #my ($self, %options) = @_;
2612 my $cust_pkg_discount = new FS::cust_pkg_discount {
2613 'pkgnum' => $self->pkgnum,
2614 'discountnum' => $self->discountnum,
2616 'end_date' => '', #XXX
2617 #for the create a new discount case
2618 '_type' => $self->discountnum__type,
2619 'amount' => $self->discountnum_amount,
2620 'percent' => $self->discountnum_percent,
2621 'months' => $self->discountnum_months,
2622 'setup' => $self->discountnum_setup,
2623 #'disabled' => $self->discountnum_disabled,
2626 $cust_pkg_discount->insert;
2629 =item set_usage USAGE_VALUE_HASHREF
2631 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2632 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2633 upbytes, downbytes, and totalbytes are appropriate keys.
2635 All svc_accts which are part of this package have their values reset.
2640 my ($self, $valueref, %opt) = @_;
2642 foreach my $cust_svc ($self->cust_svc){
2643 my $svc_x = $cust_svc->svc_x;
2644 $svc_x->set_usage($valueref, %opt)
2645 if $svc_x->can("set_usage");
2649 =item recharge USAGE_VALUE_HASHREF
2651 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2652 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2653 upbytes, downbytes, and totalbytes are appropriate keys.
2655 All svc_accts which are part of this package have their values incremented.
2660 my ($self, $valueref) = @_;
2662 foreach my $cust_svc ($self->cust_svc){
2663 my $svc_x = $cust_svc->svc_x;
2664 $svc_x->recharge($valueref)
2665 if $svc_x->can("recharge");
2669 =item cust_pkg_discount
2673 sub cust_pkg_discount {
2675 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
2678 =item cust_pkg_discount_active
2682 sub cust_pkg_discount_active {
2684 grep { $_->status eq 'active' } $self->cust_pkg_discount;
2689 =head1 CLASS METHODS
2695 Returns an SQL expression identifying recurring packages.
2699 sub recurring_sql { "
2700 '0' != ( select freq from part_pkg
2701 where cust_pkg.pkgpart = part_pkg.pkgpart )
2706 Returns an SQL expression identifying one-time packages.
2711 '0' = ( select freq from part_pkg
2712 where cust_pkg.pkgpart = part_pkg.pkgpart )
2717 Returns an SQL expression identifying ordered packages (recurring packages not
2723 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
2728 Returns an SQL expression identifying active packages.
2733 $_[0]->recurring_sql. "
2734 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
2735 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2736 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2739 =item not_yet_billed_sql
2741 Returns an SQL expression identifying packages which have not yet been billed.
2745 sub not_yet_billed_sql { "
2746 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
2747 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2748 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2753 Returns an SQL expression identifying inactive packages (one-time packages
2754 that are otherwise unsuspended/uncancelled).
2758 sub inactive_sql { "
2759 ". $_[0]->onetime_sql(). "
2760 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
2761 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2762 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2768 Returns an SQL expression identifying suspended packages.
2772 sub suspended_sql { susp_sql(@_); }
2774 #$_[0]->recurring_sql(). ' AND '.
2776 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2777 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
2784 Returns an SQL exprression identifying cancelled packages.
2788 sub cancelled_sql { cancel_sql(@_); }
2790 #$_[0]->recurring_sql(). ' AND '.
2791 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
2796 Returns an SQL expression to give the package status as a string.
2802 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
2803 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
2804 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
2805 WHEN ".onetime_sql()." THEN 'one-time charge'
2810 =item search HASHREF
2814 Returns a qsearch hash expression to search for parameters specified in HASHREF.
2815 Valid parameters are
2823 active, inactive, suspended, cancel (or cancelled)
2827 active, inactive, suspended, one-time charge, inactive, cancel (or cancelled)
2831 boolean selects custom packages
2837 pkgpart or arrayref or hashref of pkgparts
2841 arrayref of beginning and ending epoch date
2845 arrayref of beginning and ending epoch date
2849 arrayref of beginning and ending epoch date
2853 arrayref of beginning and ending epoch date
2857 arrayref of beginning and ending epoch date
2861 arrayref of beginning and ending epoch date
2865 arrayref of beginning and ending epoch date
2869 pkgnum or APKG_pkgnum
2873 a value suited to passing to FS::UI::Web::cust_header
2877 specifies the user for agent virtualization
2881 boolean selects packages containing fcc form 477 telco lines
2888 my ($class, $params) = @_;
2895 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
2897 "cust_main.agentnum = $1";
2904 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
2906 "cust_pkg.custnum = $1";
2913 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
2915 "cust_pkg.pkgbatch = '$1'";
2922 if ( $params->{'magic'} eq 'active'
2923 || $params->{'status'} eq 'active' ) {
2925 push @where, FS::cust_pkg->active_sql();
2927 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
2928 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
2930 push @where, FS::cust_pkg->not_yet_billed_sql();
2932 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
2933 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
2935 push @where, FS::cust_pkg->inactive_sql();
2937 } elsif ( $params->{'magic'} eq 'suspended'
2938 || $params->{'status'} eq 'suspended' ) {
2940 push @where, FS::cust_pkg->suspended_sql();
2942 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
2943 || $params->{'status'} =~ /^cancell?ed$/ ) {
2945 push @where, FS::cust_pkg->cancelled_sql();
2950 # parse package class
2953 if ( exists($params->{'classnum'}) ) {
2956 if ( ref($params->{'classnum'}) ) {
2958 if ( ref($params->{'classnum'}) eq 'HASH' ) {
2959 @classnum = grep $params->{'classnum'}{$_}, keys %{ $params->{'classnum'} };
2960 } elsif ( ref($params->{'classnum'}) eq 'ARRAY' ) {
2961 @classnum = @{ $params->{'classnum'} };
2963 die 'unhandled classnum ref '. $params->{'classnum'};
2967 } elsif ( $params->{'classnum'} =~ /^(\d*)$/ && $1 ne '0' ) {
2974 my @nums = grep $_, @classnum;
2975 push @c_where, 'part_pkg.classnum IN ('. join(',',@nums). ')' if @nums;
2976 my $null = scalar( grep { $_ eq '' } @classnum );
2977 push @c_where, 'part_pkg.classnum IS NULL' if $null;
2979 if ( scalar(@c_where) == 1 ) {
2980 push @where, @c_where;
2981 } elsif ( @c_where ) {
2982 push @where, ' ( '. join(' OR ', @c_where). ' ) ';
2991 # parse package report options
2994 my @report_option = ();
2995 if ( exists($params->{'report_option'})
2996 && $params->{'report_option'} =~ /^([,\d]*)$/
2999 @report_option = split(',', $1);
3002 if (@report_option) {
3003 # this will result in the empty set for the dangling comma case as it should
3005 map{ "0 < ( SELECT count(*) FROM part_pkg_option
3006 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
3007 AND optionname = 'report_option_$_'
3008 AND optionvalue = '1' )"
3018 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
3024 push @where, "(part_pkg.fcc_ds0s > 0 OR pkg_class.fcc_ds0s > 0)"
3025 if $params->{fcc_line};
3031 if ( exists($params->{'censustract'}) ) {
3032 $params->{'censustract'} =~ /^([.\d]*)$/;
3033 my $censustract = "cust_main.censustract = '$1'";
3034 $censustract .= ' OR cust_main.censustract is NULL' unless $1;
3035 push @where, "( $censustract )";
3039 # parse censustract2
3041 if ( exists($params->{'censustract2'}) =~ /^(\d*)$/ ) {
3043 push @where, "cust_main.censustract LIKE '$1%'";
3046 "( cust_main.censustract = '' OR cust_main.censustract IS NULL )";
3054 if ( ref($params->{'pkgpart'}) ) {
3057 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
3058 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
3059 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
3060 @pkgpart = @{ $params->{'pkgpart'} };
3062 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
3065 @pkgpart = grep /^(\d+)$/, @pkgpart;
3067 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
3069 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
3070 push @where, "pkgpart = $1";
3079 #false laziness w/report_cust_pkg.html
3082 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
3083 'active' => { 'susp'=>1, 'cancel'=>1 },
3084 'suspended' => { 'cancel' => 1 },
3089 if( exists($params->{'active'} ) ) {
3090 # This overrides all the other date-related fields
3091 my($beginning, $ending) = @{$params->{'active'}};
3093 "cust_pkg.setup IS NOT NULL",
3094 "cust_pkg.setup <= $ending",
3095 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
3096 "NOT (".FS::cust_pkg->onetime_sql . ")";
3099 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end cancel )) {
3101 next unless exists($params->{$field});
3103 my($beginning, $ending) = @{$params->{$field}};
3105 next if $beginning == 0 && $ending == 4294967295;
3108 "cust_pkg.$field IS NOT NULL",
3109 "cust_pkg.$field >= $beginning",
3110 "cust_pkg.$field <= $ending";
3112 $orderby ||= "ORDER BY cust_pkg.$field";
3117 $orderby ||= 'ORDER BY bill';
3120 # parse magic, legacy, etc.
3123 if ( $params->{'magic'} &&
3124 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
3127 $orderby = 'ORDER BY pkgnum';
3129 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
3130 push @where, "pkgpart = $1";
3133 } elsif ( $params->{'query'} eq 'pkgnum' ) {
3135 $orderby = 'ORDER BY pkgnum';
3137 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
3139 $orderby = 'ORDER BY pkgnum';
3142 SELECT count(*) FROM pkg_svc
3143 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
3144 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
3145 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
3146 AND cust_svc.svcpart = pkg_svc.svcpart
3153 # setup queries, links, subs, etc. for the search
3156 # here is the agent virtualization
3157 if ($params->{CurrentUser}) {
3159 qsearchs('access_user', { username => $params->{CurrentUser} });
3162 push @where, $access_user->agentnums_sql('table'=>'cust_main');
3167 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
3170 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
3172 my $addl_from = 'LEFT JOIN cust_main USING ( custnum ) '.
3173 'LEFT JOIN part_pkg USING ( pkgpart ) '.
3174 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) ';
3176 my $count_query = "SELECT COUNT(*) FROM cust_pkg $addl_from $extra_sql";
3179 'table' => 'cust_pkg',
3181 'select' => join(', ',
3183 ( map "part_pkg.$_", qw( pkg freq ) ),
3184 'pkg_class.classname',
3185 'cust_main.custnum AS cust_main_custnum',
3186 FS::UI::Web::cust_sql_fields(
3187 $params->{'cust_fields'}
3190 'extra_sql' => "$extra_sql $orderby",
3191 'addl_from' => $addl_from,
3192 'count_query' => $count_query,
3199 Returns a list of two package counts. The first is a count of packages
3200 based on the supplied criteria and the second is the count of residential
3201 packages with those same criteria. Criteria are specified as in the search
3207 my ($class, $params) = @_;
3209 my $sql_query = $class->search( $params );
3211 my $count_sql = delete($sql_query->{'count_query'});
3212 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
3213 or die "couldn't parse count_sql";
3215 my $count_sth = dbh->prepare($count_sql)
3216 or die "Error preparing $count_sql: ". dbh->errstr;
3218 or die "Error executing $count_sql: ". $count_sth->errstr;
3219 my $count_arrayref = $count_sth->fetchrow_arrayref;
3221 return ( @$count_arrayref );
3228 Returns a list: the first item is an SQL fragment identifying matching
3229 packages/customers via location (taking into account shipping and package
3230 address taxation, if enabled), and subsequent items are the parameters to
3231 substitute for the placeholders in that fragment.
3236 my($class, %opt) = @_;
3237 my $ornull = $opt{'ornull'};
3239 my $conf = new FS::Conf;
3241 # '?' placeholders in _location_sql_where
3242 my $x = $ornull ? 3 : 2;
3243 my @bill_param = ( ('city')x3, ('county')x$x, ('state')x$x, 'country' );
3247 if ( $conf->exists('tax-ship_address') ) {
3250 ( ( ship_last IS NULL OR ship_last = '' )
3251 AND ". _location_sql_where('cust_main', '', $ornull ). "
3253 OR ( ship_last IS NOT NULL AND ship_last != ''
3254 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
3257 # AND payby != 'COMP'
3259 @main_param = ( @bill_param, @bill_param );
3263 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
3264 @main_param = @bill_param;
3270 if ( $conf->exists('tax-pkg_address') ) {
3272 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
3275 ( cust_pkg.locationnum IS NULL AND $main_where )
3276 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
3279 @param = ( @main_param, @bill_param );
3283 $where = $main_where;
3284 @param = @main_param;
3292 #subroutine, helper for location_sql
3293 sub _location_sql_where {
3295 my $prefix = @_ ? shift : '';
3296 my $ornull = @_ ? shift : '';
3298 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
3300 $ornull = $ornull ? ' OR ? IS NULL ' : '';
3302 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL ) ";
3303 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL ) ";
3304 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL ) ";
3306 # ( $table.${prefix}city = ? $or_empty_city $ornull )
3308 ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS text) IS NULL )
3309 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
3310 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
3311 AND $table.${prefix}country = ?
3316 my( $self, $what ) = @_;
3318 my $what_show_zero = $what. '_show_zero';
3319 length($self->$what_show_zero())
3320 ? ($self->$what_show_zero() eq 'Y')
3321 : $self->part_pkg->$what_show_zero();
3328 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
3330 CUSTNUM is a customer (see L<FS::cust_main>)
3332 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3333 L<FS::part_pkg>) to order for this customer. Duplicates are of course
3336 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
3337 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
3338 new billing items. An error is returned if this is not possible (see
3339 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
3342 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3343 newly-created cust_pkg objects.
3345 REFNUM, if specified, will specify the FS::pkg_referral record to be created
3346 and inserted. Multiple FS::pkg_referral records can be created by
3347 setting I<refnum> to an array reference of refnums or a hash reference with
3348 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
3349 record will be created corresponding to cust_main.refnum.
3354 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
3356 my $conf = new FS::Conf;
3358 # Transactionize this whole mess
3359 local $SIG{HUP} = 'IGNORE';
3360 local $SIG{INT} = 'IGNORE';
3361 local $SIG{QUIT} = 'IGNORE';
3362 local $SIG{TERM} = 'IGNORE';
3363 local $SIG{TSTP} = 'IGNORE';
3364 local $SIG{PIPE} = 'IGNORE';
3366 my $oldAutoCommit = $FS::UID::AutoCommit;
3367 local $FS::UID::AutoCommit = 0;
3371 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
3372 # return "Customer not found: $custnum" unless $cust_main;
3374 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
3377 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3380 my $change = scalar(@old_cust_pkg) != 0;
3383 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
3385 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
3386 " to pkgpart ". $pkgparts->[0]. "\n"
3389 my $err_or_cust_pkg =
3390 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
3391 'refnum' => $refnum,
3394 unless (ref($err_or_cust_pkg)) {
3395 $dbh->rollback if $oldAutoCommit;
3396 return $err_or_cust_pkg;
3399 push @$return_cust_pkg, $err_or_cust_pkg;
3400 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3405 # Create the new packages.
3406 foreach my $pkgpart (@$pkgparts) {
3408 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
3410 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
3411 pkgpart => $pkgpart,
3415 $error = $cust_pkg->insert( 'change' => $change );
3417 $dbh->rollback if $oldAutoCommit;
3420 push @$return_cust_pkg, $cust_pkg;
3422 # $return_cust_pkg now contains refs to all of the newly
3425 # Transfer services and cancel old packages.
3426 foreach my $old_pkg (@old_cust_pkg) {
3428 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
3431 foreach my $new_pkg (@$return_cust_pkg) {
3432 $error = $old_pkg->transfer($new_pkg);
3433 if ($error and $error == 0) {
3434 # $old_pkg->transfer failed.
3435 $dbh->rollback if $oldAutoCommit;
3440 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
3441 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
3442 foreach my $new_pkg (@$return_cust_pkg) {
3443 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
3444 if ($error and $error == 0) {
3445 # $old_pkg->transfer failed.
3446 $dbh->rollback if $oldAutoCommit;
3453 # Transfers were successful, but we went through all of the
3454 # new packages and still had services left on the old package.
3455 # We can't cancel the package under the circumstances, so abort.
3456 $dbh->rollback if $oldAutoCommit;
3457 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
3459 $error = $old_pkg->cancel( quiet=>1 );
3465 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3469 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
3471 A bulk change method to change packages for multiple customers.
3473 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3474 L<FS::part_pkg>) to order for each customer. Duplicates are of course
3477 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
3478 replace. The services (see L<FS::cust_svc>) are moved to the
3479 new billing items. An error is returned if this is not possible (see
3482 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3483 newly-created cust_pkg objects.
3488 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
3490 # Transactionize this whole mess
3491 local $SIG{HUP} = 'IGNORE';
3492 local $SIG{INT} = 'IGNORE';
3493 local $SIG{QUIT} = 'IGNORE';
3494 local $SIG{TERM} = 'IGNORE';
3495 local $SIG{TSTP} = 'IGNORE';
3496 local $SIG{PIPE} = 'IGNORE';
3498 my $oldAutoCommit = $FS::UID::AutoCommit;
3499 local $FS::UID::AutoCommit = 0;
3503 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3506 while(scalar(@old_cust_pkg)) {
3508 my $custnum = $old_cust_pkg[0]->custnum;
3509 my (@remove) = map { $_->pkgnum }
3510 grep { $_->custnum == $custnum } @old_cust_pkg;
3511 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
3513 my $error = order $custnum, $pkgparts, \@remove, \@return;
3515 push @errors, $error
3517 push @$return_cust_pkg, @return;
3520 if (scalar(@errors)) {
3521 $dbh->rollback if $oldAutoCommit;
3522 return join(' / ', @errors);
3525 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3529 # Used by FS::Upgrade to migrate to a new database.
3530 sub _upgrade_data { # class method
3531 my ($class, %opts) = @_;
3532 $class->_upgrade_otaker(%opts);
3534 # RT#10139, bug resulting in contract_end being set when it shouldn't
3535 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
3536 # RT#10830, bad calculation of prorate date near end of year
3537 # the date range for bill is December 2009, and we move it forward
3538 # one year if it's before the previous bill date (which it should
3540 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
3541 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
3542 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
3543 # RT6628, add order_date to cust_pkg
3544 'update cust_pkg set order_date = (select history_date from h_cust_pkg
3545 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
3546 history_action = \'insert\') where order_date is null',
3548 foreach my $sql (@statements) {
3549 my $sth = dbh->prepare($sql);
3550 $sth->execute or die $sth->errstr;
3558 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
3560 In sub order, the @pkgparts array (passed by reference) is clobbered.
3562 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
3563 method to pass dates to the recur_prog expression, it should do so.
3565 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
3566 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
3567 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
3568 configuration values. Probably need a subroutine which decides what to do
3569 based on whether or not we've fetched the user yet, rather than a hash. See
3570 FS::UID and the TODO.
3572 Now that things are transactional should the check in the insert method be
3577 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
3578 L<FS::pkg_svc>, schema.html from the base documentation