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',1);
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_numbern('dundate')
610 || $self->ut_enum('no_auto', [ '', 'Y' ])
611 || $self->ut_enum('waive_setup', [ '', 'Y' ])
612 || $self->ut_numbern('agent_pkgid')
613 || $self->ut_enum('recur_show_zero', [ '', 'Y', 'N', ])
614 || $self->ut_enum('setup_show_zero', [ '', 'Y', 'N', ])
616 return $error if $error;
618 return "A package with both start date (future start) and setup date (already started) will never bill"
619 if $self->start_date && $self->setup;
621 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
623 if ( $self->dbdef_table->column('manual_flag') ) {
624 $self->manual_flag('') if $self->manual_flag eq ' ';
625 $self->manual_flag =~ /^([01]?)$/
626 or return "Illegal manual_flag ". $self->manual_flag;
627 $self->manual_flag($1);
640 my $error = $self->ut_numbern('pkgpart');
641 return $error if $error;
643 if ( $self->reg_code ) {
645 unless ( grep { $self->pkgpart == $_->pkgpart }
646 map { $_->reg_code_pkg }
647 qsearchs( 'reg_code', { 'code' => $self->reg_code,
648 'agentnum' => $self->cust_main->agentnum })
650 return "Unknown registration code";
653 } elsif ( $self->promo_code ) {
656 qsearchs('part_pkg', {
657 'pkgpart' => $self->pkgpart,
658 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
660 return 'Unknown promotional code' unless $promo_part_pkg;
664 unless ( $disable_agentcheck ) {
666 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
667 return "agent ". $agent->agentnum. ':'. $agent->agent.
668 " can't purchase pkgpart ". $self->pkgpart
669 unless $agent->pkgpart_hashref->{ $self->pkgpart }
670 || $agent->agentnum == $self->part_pkg->agentnum;
673 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
674 return $error if $error;
682 =item cancel [ OPTION => VALUE ... ]
684 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
685 in this package, then cancels the package itself (sets the cancel field to
688 Available options are:
692 =item quiet - can be set true to supress email cancellation notices.
694 =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.
696 =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.
698 =item date - can be set to a unix style timestamp to specify when to cancel (expire)
700 =item nobill - can be set true to skip billing if it might otherwise be done.
702 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
703 not credit it. This must be set (by change()) when changing the package
704 to a different pkgpart or location, and probably shouldn't be in any other
705 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
710 If there is an error, returns the error, otherwise returns false.
715 my( $self, %options ) = @_;
718 my $conf = new FS::Conf;
720 warn "cust_pkg::cancel called with options".
721 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
724 local $SIG{HUP} = 'IGNORE';
725 local $SIG{INT} = 'IGNORE';
726 local $SIG{QUIT} = 'IGNORE';
727 local $SIG{TERM} = 'IGNORE';
728 local $SIG{TSTP} = 'IGNORE';
729 local $SIG{PIPE} = 'IGNORE';
731 my $oldAutoCommit = $FS::UID::AutoCommit;
732 local $FS::UID::AutoCommit = 0;
735 my $old = $self->select_for_update;
737 if ( $old->get('cancel') || $self->get('cancel') ) {
738 dbh->rollback if $oldAutoCommit;
739 return ""; # no error
742 my $date = $options{date} if $options{date}; # expire/cancel later
743 $date = '' if ($date && $date <= time); # complain instead?
745 #race condition: usage could be ongoing until unprovisioned
746 #resolved by performing a change package instead (which unprovisions) and
748 if ( !$options{nobill} && !$date && $conf->exists('bill_usage_on_cancel') ) {
749 my $copy = $self->new({$self->hash});
751 $copy->cust_main->bill( pkg_list => [ $copy ], cancel => 1 );
752 warn "Error billing during cancel, custnum ".
753 #$self->cust_main->custnum. ": $error"
758 my $cancel_time = $options{'time'} || time;
760 if ( $options{'reason'} ) {
761 $error = $self->insert_reason( 'reason' => $options{'reason'},
762 'action' => $date ? 'expire' : 'cancel',
763 'date' => $date ? $date : $cancel_time,
764 'reason_otaker' => $options{'reason_otaker'},
767 dbh->rollback if $oldAutoCommit;
768 return "Error inserting cust_pkg_reason: $error";
772 my %svc_cancel_opt = ();
773 $svc_cancel_opt{'date'} = $date if $date;
774 foreach my $cust_svc (
777 sort { $a->[1] <=> $b->[1] }
778 map { [ $_, $_->svc_x->table_info->{'cancel_weight'} ]; }
779 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
781 my $part_svc = $cust_svc->part_svc;
782 next if ( defined($part_svc) and $part_svc->preserve );
783 my $error = $cust_svc->cancel( %svc_cancel_opt );
786 $dbh->rollback if $oldAutoCommit;
787 return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
794 # Add a credit for remaining service
795 my $last_bill = $self->getfield('last_bill') || 0;
796 my $next_bill = $self->getfield('bill') || 0;
798 if ( exists($options{'unused_credit'}) ) {
799 $do_credit = $options{'unused_credit'};
802 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
805 and $last_bill > 0 # the package has been billed
806 and $next_bill > 0 # the package has a next bill date
807 and $next_bill >= $cancel_time # which is in the future
809 my $remaining_value = $self->calc_remain('time' => $cancel_time);
810 if ( $remaining_value > 0 ) {
811 my $error = $self->cust_main->credit(
813 'Credit for unused time on '. $self->part_pkg->pkg,
814 'reason_type' => $conf->config('cancel_credit_type'),
817 $dbh->rollback if $oldAutoCommit;
818 return "Error crediting customer \$$remaining_value for unused time".
819 " on ". $self->part_pkg->pkg. ": $error";
821 } #if $remaining_value
826 my %hash = $self->hash;
827 $date ? ($hash{'expire'} = $date) : ($hash{'cancel'} = $cancel_time);
828 my $new = new FS::cust_pkg ( \%hash );
829 $error = $new->replace( $self, options => { $self->options } );
831 $dbh->rollback if $oldAutoCommit;
835 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
836 return '' if $date; #no errors
838 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
839 if ( !$options{'quiet'} &&
840 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
842 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
845 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
846 $error = $msg_template->send( 'cust_main' => $self->cust_main,
851 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
852 'to' => \@invoicing_list,
853 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
854 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
857 #should this do something on errors?
864 =item cancel_if_expired [ NOW_TIMESTAMP ]
866 Cancels this package if its expire date has been reached.
870 sub cancel_if_expired {
872 my $time = shift || time;
873 return '' unless $self->expire && $self->expire <= $time;
874 my $error = $self->cancel;
876 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
877 $self->custnum. ": $error";
884 Cancels any pending expiration (sets the expire field to null).
886 If there is an error, returns the error, otherwise returns false.
891 my( $self, %options ) = @_;
894 local $SIG{HUP} = 'IGNORE';
895 local $SIG{INT} = 'IGNORE';
896 local $SIG{QUIT} = 'IGNORE';
897 local $SIG{TERM} = 'IGNORE';
898 local $SIG{TSTP} = 'IGNORE';
899 local $SIG{PIPE} = 'IGNORE';
901 my $oldAutoCommit = $FS::UID::AutoCommit;
902 local $FS::UID::AutoCommit = 0;
905 my $old = $self->select_for_update;
907 my $pkgnum = $old->pkgnum;
908 if ( $old->get('cancel') || $self->get('cancel') ) {
909 dbh->rollback if $oldAutoCommit;
910 return "Can't unexpire cancelled package $pkgnum";
911 # or at least it's pointless
914 unless ( $old->get('expire') && $self->get('expire') ) {
915 dbh->rollback if $oldAutoCommit;
916 return ""; # no error
919 my %hash = $self->hash;
920 $hash{'expire'} = '';
921 my $new = new FS::cust_pkg ( \%hash );
922 $error = $new->replace( $self, options => { $self->options } );
924 $dbh->rollback if $oldAutoCommit;
928 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
934 =item suspend [ OPTION => VALUE ... ]
936 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
937 package, then suspends the package itself (sets the susp field to now).
939 Available options are:
943 =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.
945 =item date - can be set to a unix style timestamp to specify when to suspend (adjourn)
949 If there is an error, returns the error, otherwise returns false.
954 my( $self, %options ) = @_;
957 local $SIG{HUP} = 'IGNORE';
958 local $SIG{INT} = 'IGNORE';
959 local $SIG{QUIT} = 'IGNORE';
960 local $SIG{TERM} = 'IGNORE';
961 local $SIG{TSTP} = 'IGNORE';
962 local $SIG{PIPE} = 'IGNORE';
964 my $oldAutoCommit = $FS::UID::AutoCommit;
965 local $FS::UID::AutoCommit = 0;
968 my $old = $self->select_for_update;
970 my $pkgnum = $old->pkgnum;
971 if ( $old->get('cancel') || $self->get('cancel') ) {
972 dbh->rollback if $oldAutoCommit;
973 return "Can't suspend cancelled package $pkgnum";
976 if ( $old->get('susp') || $self->get('susp') ) {
977 dbh->rollback if $oldAutoCommit;
978 return ""; # no error # complain on adjourn?
981 my $date = $options{date} if $options{date}; # adjourn/suspend later
982 $date = '' if ($date && $date <= time); # complain instead?
984 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
985 dbh->rollback if $oldAutoCommit;
986 return "Package $pkgnum expires before it would be suspended.";
989 my $suspend_time = $options{'time'} || time;
991 if ( $options{'reason'} ) {
992 $error = $self->insert_reason( 'reason' => $options{'reason'},
993 'action' => $date ? 'adjourn' : 'suspend',
994 'date' => $date ? $date : $suspend_time,
995 'reason_otaker' => $options{'reason_otaker'},
998 dbh->rollback if $oldAutoCommit;
999 return "Error inserting cust_pkg_reason: $error";
1007 foreach my $cust_svc (
1008 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1010 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1012 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1013 $dbh->rollback if $oldAutoCommit;
1014 return "Illegal svcdb value in part_svc!";
1017 require "FS/$svcdb.pm";
1019 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1021 $error = $svc->suspend;
1023 $dbh->rollback if $oldAutoCommit;
1026 my( $label, $value ) = $cust_svc->label;
1027 push @labels, "$label: $value";
1031 my $conf = new FS::Conf;
1032 if ( $conf->config('suspend_email_admin') ) {
1034 my $error = send_email(
1035 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1036 #invoice_from ??? well as good as any
1037 'to' => $conf->config('suspend_email_admin'),
1038 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1040 "This is an automatic message from your Freeside installation\n",
1041 "informing you that the following customer package has been suspended:\n",
1043 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1044 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1045 ( map { "Service : $_\n" } @labels ),
1050 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1058 my %hash = $self->hash;
1060 $hash{'adjourn'} = $date;
1062 $hash{'susp'} = $suspend_time;
1064 my $new = new FS::cust_pkg ( \%hash );
1065 $error = $new->replace( $self, options => { $self->options } );
1067 $dbh->rollback if $oldAutoCommit;
1071 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1076 =item unsuspend [ OPTION => VALUE ... ]
1078 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1079 package, then unsuspends the package itself (clears the susp field and the
1080 adjourn field if it is in the past).
1082 Available options are:
1086 =item adjust_next_bill
1088 Can be set true to adjust the next bill date forward by
1089 the amount of time the account was inactive. This was set true by default
1090 since 1.4.2 and 1.5.0pre6; however, starting with 1.7.0 this needs to be
1091 explicitly requested. Price plans for which this makes sense (anniversary-date
1092 based than prorate or subscription) could have an option to enable this
1097 If there is an error, returns the error, otherwise returns false.
1102 my( $self, %opt ) = @_;
1105 local $SIG{HUP} = 'IGNORE';
1106 local $SIG{INT} = 'IGNORE';
1107 local $SIG{QUIT} = 'IGNORE';
1108 local $SIG{TERM} = 'IGNORE';
1109 local $SIG{TSTP} = 'IGNORE';
1110 local $SIG{PIPE} = 'IGNORE';
1112 my $oldAutoCommit = $FS::UID::AutoCommit;
1113 local $FS::UID::AutoCommit = 0;
1116 my $old = $self->select_for_update;
1118 my $pkgnum = $old->pkgnum;
1119 if ( $old->get('cancel') || $self->get('cancel') ) {
1120 dbh->rollback if $oldAutoCommit;
1121 return "Can't unsuspend cancelled package $pkgnum";
1124 unless ( $old->get('susp') && $self->get('susp') ) {
1125 dbh->rollback if $oldAutoCommit;
1126 return ""; # no error # complain instead?
1129 foreach my $cust_svc (
1130 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1132 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1134 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1135 $dbh->rollback if $oldAutoCommit;
1136 return "Illegal svcdb value in part_svc!";
1139 require "FS/$svcdb.pm";
1141 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1143 $error = $svc->unsuspend;
1145 $dbh->rollback if $oldAutoCommit;
1152 my %hash = $self->hash;
1153 my $inactive = time - $hash{'susp'};
1155 my $conf = new FS::Conf;
1157 if ( $inactive > 0 &&
1158 ( $hash{'bill'} || $hash{'setup'} ) &&
1159 ( $opt{'adjust_next_bill'} ||
1160 $conf->exists('unsuspend-always_adjust_next_bill_date') ||
1161 $self->part_pkg->option('unsuspend_adjust_bill', 1) )
1164 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1169 $hash{'adjourn'} = '' if $hash{'adjourn'} < time;
1170 my $new = new FS::cust_pkg ( \%hash );
1171 $error = $new->replace( $self, options => { $self->options } );
1173 $dbh->rollback if $oldAutoCommit;
1177 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1184 Cancels any pending suspension (sets the adjourn field to null).
1186 If there is an error, returns the error, otherwise returns false.
1191 my( $self, %options ) = @_;
1194 local $SIG{HUP} = 'IGNORE';
1195 local $SIG{INT} = 'IGNORE';
1196 local $SIG{QUIT} = 'IGNORE';
1197 local $SIG{TERM} = 'IGNORE';
1198 local $SIG{TSTP} = 'IGNORE';
1199 local $SIG{PIPE} = 'IGNORE';
1201 my $oldAutoCommit = $FS::UID::AutoCommit;
1202 local $FS::UID::AutoCommit = 0;
1205 my $old = $self->select_for_update;
1207 my $pkgnum = $old->pkgnum;
1208 if ( $old->get('cancel') || $self->get('cancel') ) {
1209 dbh->rollback if $oldAutoCommit;
1210 return "Can't unadjourn cancelled package $pkgnum";
1211 # or at least it's pointless
1214 if ( $old->get('susp') || $self->get('susp') ) {
1215 dbh->rollback if $oldAutoCommit;
1216 return "Can't unadjourn suspended package $pkgnum";
1217 # perhaps this is arbitrary
1220 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1221 dbh->rollback if $oldAutoCommit;
1222 return ""; # no error
1225 my %hash = $self->hash;
1226 $hash{'adjourn'} = '';
1227 my $new = new FS::cust_pkg ( \%hash );
1228 $error = $new->replace( $self, options => { $self->options } );
1230 $dbh->rollback if $oldAutoCommit;
1234 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1241 =item change HASHREF | OPTION => VALUE ...
1243 Changes this package: cancels it and creates a new one, with a different
1244 pkgpart or locationnum or both. All services are transferred to the new
1245 package (no change will be made if this is not possible).
1247 Options may be passed as a list of key/value pairs or as a hash reference.
1254 New locationnum, to change the location for this package.
1258 New FS::cust_location object, to create a new location and assign it
1263 New pkgpart (see L<FS::part_pkg>).
1267 New refnum (see L<FS::part_referral>).
1271 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1272 susp, adjourn, cancel, expire, and contract_end) to the new package.
1276 At least one of locationnum, cust_location, pkgpart, refnum must be specified
1277 (otherwise, what's the point?)
1279 Returns either the new FS::cust_pkg object or a scalar error.
1283 my $err_or_new_cust_pkg = $old_cust_pkg->change
1287 #some false laziness w/order
1290 my $opt = ref($_[0]) ? shift : { @_ };
1292 # my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
1295 my $conf = new FS::Conf;
1297 # Transactionize this whole mess
1298 local $SIG{HUP} = 'IGNORE';
1299 local $SIG{INT} = 'IGNORE';
1300 local $SIG{QUIT} = 'IGNORE';
1301 local $SIG{TERM} = 'IGNORE';
1302 local $SIG{TSTP} = 'IGNORE';
1303 local $SIG{PIPE} = 'IGNORE';
1305 my $oldAutoCommit = $FS::UID::AutoCommit;
1306 local $FS::UID::AutoCommit = 0;
1315 #$hash{$_} = $self->$_() foreach qw( last_bill bill );
1317 #$hash{$_} = $self->$_() foreach qw( setup );
1319 $hash{'setup'} = $time if $self->setup;
1321 $hash{'change_date'} = $time;
1322 $hash{"change_$_"} = $self->$_()
1323 foreach qw( pkgnum pkgpart locationnum );
1325 if ( $opt->{'cust_location'} &&
1326 ( ! $opt->{'locationnum'} || $opt->{'locationnum'} == -1 ) ) {
1327 $error = $opt->{'cust_location'}->insert;
1329 $dbh->rollback if $oldAutoCommit;
1330 return "inserting cust_location (transaction rolled back): $error";
1332 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1335 my $unused_credit = 0;
1336 if ( $opt->{'keep_dates'} ) {
1337 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1338 start_date contract_end ) ) {
1339 $hash{$date} = $self->getfield($date);
1342 # Special case. If the pkgpart is changing, and the customer is
1343 # going to be credited for remaining time, don't keep setup, bill,
1344 # or last_bill dates, and DO pass the flag to cancel() to credit
1346 if ( $opt->{'pkgpart'}
1347 and $opt->{'pkgpart'} != $self->pkgpart
1348 and $self->part_pkg->option('unused_credit_change', 1) ) {
1350 $hash{$_} = '' foreach qw(setup bill last_bill);
1353 # Create the new package.
1354 my $cust_pkg = new FS::cust_pkg {
1355 custnum => $self->custnum,
1356 pkgpart => ( $opt->{'pkgpart'} || $self->pkgpart ),
1357 refnum => ( $opt->{'refnum'} || $self->refnum ),
1358 locationnum => ( $opt->{'locationnum'} || $self->locationnum ),
1362 $error = $cust_pkg->insert( 'change' => 1 );
1364 $dbh->rollback if $oldAutoCommit;
1368 # Transfer services and cancel old package.
1370 $error = $self->transfer($cust_pkg);
1371 if ($error and $error == 0) {
1372 # $old_pkg->transfer failed.
1373 $dbh->rollback if $oldAutoCommit;
1377 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
1378 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
1379 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
1380 if ($error and $error == 0) {
1381 # $old_pkg->transfer failed.
1382 $dbh->rollback if $oldAutoCommit;
1388 # Transfers were successful, but we still had services left on the old
1389 # package. We can't change the package under this circumstances, so abort.
1390 $dbh->rollback if $oldAutoCommit;
1391 return "Unable to transfer all services from package ". $self->pkgnum;
1394 #reset usage if changing pkgpart
1395 # AND usage rollover is off (otherwise adds twice, now and at package bill)
1396 if ($self->pkgpart != $cust_pkg->pkgpart) {
1397 my $part_pkg = $cust_pkg->part_pkg;
1398 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
1402 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
1405 $dbh->rollback if $oldAutoCommit;
1406 return "Error setting usage values: $error";
1410 #Good to go, cancel old package. Notify 'cancel' of whether to credit
1412 $error = $self->cancel( quiet=>1, unused_credit => $unused_credit );
1414 $dbh->rollback if $oldAutoCommit;
1418 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
1420 my $error = $cust_pkg->cust_main->bill( 'pkg_list' => [ $cust_pkg ] );
1422 $dbh->rollback if $oldAutoCommit;
1427 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1433 use Storable 'thaw';
1435 sub process_bulk_cust_pkg {
1437 my $param = thaw(decode_base64(shift));
1438 warn Dumper($param) if $DEBUG;
1440 my $old_part_pkg = qsearchs('part_pkg',
1441 { pkgpart => $param->{'old_pkgpart'} });
1442 my $new_part_pkg = qsearchs('part_pkg',
1443 { pkgpart => $param->{'new_pkgpart'} });
1444 die "Must select a new package type\n" unless $new_part_pkg;
1445 #my $keep_dates = $param->{'keep_dates'} || 0;
1446 my $keep_dates = 1; # there is no good reason to turn this off
1448 local $SIG{HUP} = 'IGNORE';
1449 local $SIG{INT} = 'IGNORE';
1450 local $SIG{QUIT} = 'IGNORE';
1451 local $SIG{TERM} = 'IGNORE';
1452 local $SIG{TSTP} = 'IGNORE';
1453 local $SIG{PIPE} = 'IGNORE';
1455 my $oldAutoCommit = $FS::UID::AutoCommit;
1456 local $FS::UID::AutoCommit = 0;
1459 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
1462 foreach my $old_cust_pkg ( @cust_pkgs ) {
1464 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
1465 if ( $old_cust_pkg->getfield('cancel') ) {
1466 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
1467 $old_cust_pkg->pkgnum."\n"
1471 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
1473 my $error = $old_cust_pkg->change(
1474 'pkgpart' => $param->{'new_pkgpart'},
1475 'keep_dates' => $keep_dates
1477 if ( !ref($error) ) { # change returns the cust_pkg on success
1479 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
1482 $dbh->commit if $oldAutoCommit;
1488 Returns the last bill date, or if there is no last bill date, the setup date.
1489 Useful for billing metered services.
1495 return $self->setfield('last_bill', $_[0]) if @_;
1496 return $self->getfield('last_bill') if $self->getfield('last_bill');
1497 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
1498 'edate' => $self->bill, } );
1499 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
1502 =item last_cust_pkg_reason ACTION
1504 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
1505 Returns false if there is no reason or the package is not currenly ACTION'd
1506 ACTION is one of adjourn, susp, cancel, or expire.
1510 sub last_cust_pkg_reason {
1511 my ( $self, $action ) = ( shift, shift );
1512 my $date = $self->get($action);
1514 'table' => 'cust_pkg_reason',
1515 'hashref' => { 'pkgnum' => $self->pkgnum,
1516 'action' => substr(uc($action), 0, 1),
1519 'order_by' => 'ORDER BY num DESC LIMIT 1',
1523 =item last_reason ACTION
1525 Returns the most recent ACTION FS::reason associated with the package.
1526 Returns false if there is no reason or the package is not currenly ACTION'd
1527 ACTION is one of adjourn, susp, cancel, or expire.
1532 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
1533 $cust_pkg_reason->reason
1534 if $cust_pkg_reason;
1539 Returns the definition for this billing item, as an FS::part_pkg object (see
1546 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
1547 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
1548 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
1553 Returns the cancelled package this package was changed from, if any.
1559 return '' unless $self->change_pkgnum;
1560 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
1565 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
1572 $self->part_pkg->calc_setup($self, @_);
1577 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
1584 $self->part_pkg->calc_recur($self, @_);
1589 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
1596 $self->part_pkg->base_recur($self, @_);
1601 Calls the I<calc_remain> of the FS::part_pkg object associated with this
1608 $self->part_pkg->calc_remain($self, @_);
1613 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
1620 $self->part_pkg->calc_cancel($self, @_);
1625 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
1631 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
1634 =item cust_pkg_detail [ DETAILTYPE ]
1636 Returns any customer package details for this package (see
1637 L<FS::cust_pkg_detail>).
1639 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1643 sub cust_pkg_detail {
1645 my %hash = ( 'pkgnum' => $self->pkgnum );
1646 $hash{detailtype} = shift if @_;
1648 'table' => 'cust_pkg_detail',
1649 'hashref' => \%hash,
1650 'order_by' => 'ORDER BY weight, pkgdetailnum',
1654 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
1656 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
1658 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1660 If there is an error, returns the error, otherwise returns false.
1664 sub set_cust_pkg_detail {
1665 my( $self, $detailtype, @details ) = @_;
1667 local $SIG{HUP} = 'IGNORE';
1668 local $SIG{INT} = 'IGNORE';
1669 local $SIG{QUIT} = 'IGNORE';
1670 local $SIG{TERM} = 'IGNORE';
1671 local $SIG{TSTP} = 'IGNORE';
1672 local $SIG{PIPE} = 'IGNORE';
1674 my $oldAutoCommit = $FS::UID::AutoCommit;
1675 local $FS::UID::AutoCommit = 0;
1678 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
1679 my $error = $current->delete;
1681 $dbh->rollback if $oldAutoCommit;
1682 return "error removing old detail: $error";
1686 foreach my $detail ( @details ) {
1687 my $cust_pkg_detail = new FS::cust_pkg_detail {
1688 'pkgnum' => $self->pkgnum,
1689 'detailtype' => $detailtype,
1690 'detail' => $detail,
1692 my $error = $cust_pkg_detail->insert;
1694 $dbh->rollback if $oldAutoCommit;
1695 return "error adding new detail: $error";
1700 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1707 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
1711 #false laziness w/cust_bill.pm
1715 'table' => 'cust_event',
1716 'addl_from' => 'JOIN part_event USING ( eventpart )',
1717 'hashref' => { 'tablenum' => $self->pkgnum },
1718 'extra_sql' => " AND eventtable = 'cust_pkg' ",
1722 =item num_cust_event
1724 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
1728 #false laziness w/cust_bill.pm
1729 sub num_cust_event {
1732 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
1733 " WHERE tablenum = ? AND eventtable = 'cust_pkg'";
1734 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
1735 $sth->execute($self->pkgnum) or die $sth->errstr. " executing $sql";
1736 $sth->fetchrow_arrayref->[0];
1739 =item cust_svc [ SVCPART ]
1741 Returns the services for this package, as FS::cust_svc objects (see
1742 L<FS::cust_svc>). If a svcpart is specified, return only the matching
1750 return () unless $self->num_cust_svc(@_);
1753 return qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum,
1754 'svcpart' => shift, } );
1757 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
1759 #if ( $self->{'_svcnum'} ) {
1760 # values %{ $self->{'_svcnum'}->cache };
1762 $self->_sort_cust_svc(
1763 [ qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } ) ]
1769 =item overlimit [ SVCPART ]
1771 Returns the services for this package which have exceeded their
1772 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
1773 is specified, return only the matching services.
1779 return () unless $self->num_cust_svc(@_);
1780 grep { $_->overlimit } $self->cust_svc(@_);
1783 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
1785 Returns historical services for this package created before END TIMESTAMP and
1786 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
1787 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
1788 I<pkg_svc.hidden> flag will be omitted.
1794 warn "$me _h_cust_svc called on $self\n"
1797 my ($end, $start, $mode) = @_;
1798 my @cust_svc = $self->_sort_cust_svc(
1799 [ qsearch( 'h_cust_svc',
1800 { 'pkgnum' => $self->pkgnum, },
1801 FS::h_cust_svc->sql_h_search(@_),
1804 if ( defined($mode) && $mode eq 'I' ) {
1805 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
1806 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
1812 sub _sort_cust_svc {
1813 my( $self, $arrayref ) = @_;
1816 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
1821 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $self->pkgpart,
1822 'svcpart' => $_->svcpart } );
1824 $pkg_svc ? $pkg_svc->primary_svc : '',
1825 $pkg_svc ? $pkg_svc->quantity : 0,
1832 =item num_cust_svc [ SVCPART ]
1834 Returns the number of provisioned services for this package. If a svcpart is
1835 specified, counts only the matching services.
1842 return $self->{'_num_cust_svc'}
1844 && exists($self->{'_num_cust_svc'})
1845 && $self->{'_num_cust_svc'} =~ /\d/;
1847 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
1850 my $sql = 'SELECT COUNT(*) FROM cust_svc WHERE pkgnum = ?';
1851 $sql .= ' AND svcpart = ?' if @_;
1853 my $sth = dbh->prepare($sql) or die dbh->errstr;
1854 $sth->execute($self->pkgnum, @_) or die $sth->errstr;
1855 $sth->fetchrow_arrayref->[0];
1858 =item available_part_svc
1860 Returns a list of FS::part_svc objects representing services included in this
1861 package but not yet provisioned. Each FS::part_svc object also has an extra
1862 field, I<num_avail>, which specifies the number of available services.
1866 sub available_part_svc {
1868 grep { $_->num_avail > 0 }
1870 my $part_svc = $_->part_svc;
1871 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
1872 $_->quantity - $self->num_cust_svc($_->svcpart);
1874 # more evil encapsulation breakage
1875 if($part_svc->{'Hash'}{'num_avail'} > 0) {
1876 my @exports = $part_svc->part_export_did;
1877 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
1882 $self->part_pkg->pkg_svc;
1887 Returns a list of FS::part_svc objects representing provisioned and available
1888 services included in this package. Each FS::part_svc object also has the
1889 following extra fields:
1893 =item num_cust_svc (count)
1895 =item num_avail (quantity - count)
1897 =item cust_pkg_svc (services) - array reference containing the provisioned services, as cust_svc objects
1900 label -> ($cust_svc->label)[1]
1909 #XXX some sort of sort order besides numeric by svcpart...
1910 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
1912 my $part_svc = $pkg_svc->part_svc;
1913 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
1914 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
1915 $part_svc->{'Hash'}{'num_avail'} =
1916 max( 0, $pkg_svc->quantity - $num_cust_svc );
1917 $part_svc->{'Hash'}{'cust_pkg_svc'} =
1918 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
1919 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
1921 } $self->part_pkg->pkg_svc;
1924 push @part_svc, map {
1926 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
1927 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
1928 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
1929 $part_svc->{'Hash'}{'cust_pkg_svc'} =
1930 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
1932 } $self->extra_part_svc;
1938 =item extra_part_svc
1940 Returns a list of FS::part_svc objects corresponding to services in this
1941 package which are still provisioned but not (any longer) available in the
1946 sub extra_part_svc {
1949 my $pkgnum = $self->pkgnum;
1950 #my $pkgpart = $self->pkgpart;
1953 # 'table' => 'part_svc',
1956 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
1957 # WHERE pkg_svc.svcpart = part_svc.svcpart
1958 # AND pkg_svc.pkgpart = ?
1961 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
1962 # LEFT JOIN cust_pkg USING ( pkgnum )
1963 # WHERE cust_svc.svcpart = part_svc.svcpart
1966 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
1969 #seems to benchmark slightly faster... (or did?)
1971 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
1972 my $pkgparts = join(',', @pkgparts);
1975 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
1976 #MySQL doesn't grok DISINCT ON
1977 'select' => 'DISTINCT part_svc.*',
1978 'table' => 'part_svc',
1980 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
1981 AND pkg_svc.pkgpart IN ($pkgparts)
1984 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
1985 LEFT JOIN cust_pkg USING ( pkgnum )
1988 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
1989 'extra_param' => [ [$self->pkgnum=>'int'] ],
1995 Returns a short status string for this package, currently:
1999 =item not yet billed
2001 =item one-time charge
2016 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
2018 return 'cancelled' if $self->get('cancel');
2019 return 'suspended' if $self->susp;
2020 return 'not yet billed' unless $self->setup;
2021 return 'one-time charge' if $freq =~ /^(0|$)/;
2025 =item ucfirst_status
2027 Returns the status with the first character capitalized.
2031 sub ucfirst_status {
2032 ucfirst(shift->status);
2037 Class method that returns the list of possible status strings for packages
2038 (see L<the status method|/status>). For example:
2040 @statuses = FS::cust_pkg->statuses();
2044 tie my %statuscolor, 'Tie::IxHash',
2045 'not yet billed' => '009999', #teal? cyan?
2046 'one-time charge' => '000000',
2047 'active' => '00CC00',
2048 'suspended' => 'FF9900',
2049 'cancelled' => 'FF0000',
2053 my $self = shift; #could be class...
2054 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
2055 # # mayble split btw one-time vs. recur
2061 Returns a hex triplet color string for this package's status.
2067 $statuscolor{$self->status};
2072 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
2073 "pkg-comment" depending on user preference).
2079 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
2080 $label = $self->pkgnum. ": $label"
2081 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
2085 =item pkg_label_long
2087 Returns a long label for this package, adding the primary service's label to
2092 sub pkg_label_long {
2094 my $label = $self->pkg_label;
2095 my $cust_svc = $self->primary_cust_svc;
2096 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
2100 =item primary_cust_svc
2102 Returns a primary service (as FS::cust_svc object) if one can be identified.
2106 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
2108 sub primary_cust_svc {
2111 my @cust_svc = $self->cust_svc;
2113 return '' unless @cust_svc; #no serivces - irrelevant then
2115 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
2117 # primary service as specified in the package definition
2118 # or exactly one service definition with quantity one
2119 my $svcpart = $self->part_pkg->svcpart;
2120 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
2121 return $cust_svc[0] if scalar(@cust_svc) == 1;
2123 #couldn't identify one thing..
2129 Returns a list of lists, calling the label method for all services
2130 (see L<FS::cust_svc>) of this billing item.
2136 map { [ $_->label ] } $self->cust_svc;
2139 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2141 Like the labels method, but returns historical information on services that
2142 were active as of END_TIMESTAMP and (optionally) not cancelled before
2143 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
2144 I<pkg_svc.hidden> flag will be omitted.
2146 Returns a list of lists, calling the label method for all (historical) services
2147 (see L<FS::h_cust_svc>) of this billing item.
2153 warn "$me _h_labels called on $self\n"
2155 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
2160 Like labels, except returns a simple flat list, and shortens long
2161 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2162 identical services to one line that lists the service label and the number of
2163 individual services rather than individual items.
2168 shift->_labels_short( 'labels', @_ );
2171 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
2173 Like h_labels, except returns a simple flat list, and shortens long
2174 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2175 identical services to one line that lists the service label and the number of
2176 individual services rather than individual items.
2180 sub h_labels_short {
2181 shift->_labels_short( 'h_labels', @_ );
2185 my( $self, $method ) = ( shift, shift );
2187 warn "$me _labels_short called on $self with $method method\n"
2190 my $conf = new FS::Conf;
2191 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
2193 warn "$me _labels_short populating \%labels\n"
2197 #tie %labels, 'Tie::IxHash';
2198 push @{ $labels{$_->[0]} }, $_->[1]
2199 foreach $self->$method(@_);
2201 warn "$me _labels_short populating \@labels\n"
2205 foreach my $label ( keys %labels ) {
2207 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
2208 my $num = scalar(@values);
2209 warn "$me _labels_short $num items for $label\n"
2212 if ( $num > $max_same_services ) {
2213 warn "$me _labels_short more than $max_same_services, so summarizing\n"
2215 push @labels, "$label ($num)";
2217 if ( $conf->exists('cust_bill-consolidate_services') ) {
2218 warn "$me _labels_short consolidating services\n"
2220 # push @labels, "$label: ". join(', ', @values);
2222 my $detail = "$label: ";
2223 $detail .= shift(@values). ', '
2225 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
2227 push @labels, $detail;
2229 warn "$me _labels_short done consolidating services\n"
2232 warn "$me _labels_short adding service data\n"
2234 push @labels, map { "$label: $_" } @values;
2245 Returns the parent customer object (see L<FS::cust_main>).
2251 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
2254 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
2258 Returns the location object, if any (see L<FS::cust_location>).
2260 =item cust_location_or_main
2262 If this package is associated with a location, returns the locaiton (see
2263 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
2265 =item location_label [ OPTION => VALUE ... ]
2267 Returns the label of the location object (see L<FS::cust_location>).
2271 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
2273 =item seconds_since TIMESTAMP
2275 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
2276 package have been online since TIMESTAMP, according to the session monitor.
2278 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2279 L<Time::Local> and L<Date::Parse> for conversion functions.
2284 my($self, $since) = @_;
2287 foreach my $cust_svc (
2288 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
2290 $seconds += $cust_svc->seconds_since($since);
2297 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
2299 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
2300 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
2303 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2304 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2310 sub seconds_since_sqlradacct {
2311 my($self, $start, $end) = @_;
2315 foreach my $cust_svc (
2317 my $part_svc = $_->part_svc;
2318 $part_svc->svcdb eq 'svc_acct'
2319 && scalar($part_svc->part_export('sqlradius'));
2322 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
2329 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
2331 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
2332 in this package for sessions ending between TIMESTAMP_START (inclusive) and
2336 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2337 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2342 sub attribute_since_sqlradacct {
2343 my($self, $start, $end, $attrib) = @_;
2347 foreach my $cust_svc (
2349 my $part_svc = $_->part_svc;
2350 $part_svc->svcdb eq 'svc_acct'
2351 && scalar($part_svc->part_export('sqlradius'));
2354 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
2366 my( $self, $value ) = @_;
2367 if ( defined($value) ) {
2368 $self->setfield('quantity', $value);
2370 $self->getfield('quantity') || 1;
2373 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
2375 Transfers as many services as possible from this package to another package.
2377 The destination package can be specified by pkgnum by passing an FS::cust_pkg
2378 object. The destination package must already exist.
2380 Services are moved only if the destination allows services with the correct
2381 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
2382 this option with caution! No provision is made for export differences
2383 between the old and new service definitions. Probably only should be used
2384 when your exports for all service definitions of a given svcdb are identical.
2385 (attempt a transfer without it first, to move all possible svcpart-matching
2388 Any services that can't be moved remain in the original package.
2390 Returns an error, if there is one; otherwise, returns the number of services
2391 that couldn't be moved.
2396 my ($self, $dest_pkgnum, %opt) = @_;
2402 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
2403 $dest = $dest_pkgnum;
2404 $dest_pkgnum = $dest->pkgnum;
2406 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
2409 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
2411 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
2412 $target{$pkg_svc->svcpart} = $pkg_svc->quantity;
2415 foreach my $cust_svc ($dest->cust_svc) {
2416 $target{$cust_svc->svcpart}--;
2419 my %svcpart2svcparts = ();
2420 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2421 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
2422 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
2423 next if exists $svcpart2svcparts{$svcpart};
2424 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
2425 $svcpart2svcparts{$svcpart} = [
2427 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
2429 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
2430 'svcpart' => $_ } );
2432 $pkg_svc ? $pkg_svc->primary_svc : '',
2433 $pkg_svc ? $pkg_svc->quantity : 0,
2437 grep { $_ != $svcpart }
2439 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
2441 warn "alternates for svcpart $svcpart: ".
2442 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
2447 foreach my $cust_svc ($self->cust_svc) {
2448 if($target{$cust_svc->svcpart} > 0) {
2449 $target{$cust_svc->svcpart}--;
2450 my $new = new FS::cust_svc { $cust_svc->hash };
2451 $new->pkgnum($dest_pkgnum);
2452 my $error = $new->replace($cust_svc);
2453 return $error if $error;
2454 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2456 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
2457 warn "alternates to consider: ".
2458 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
2460 my @alternate = grep {
2461 warn "considering alternate svcpart $_: ".
2462 "$target{$_} available in new package\n"
2465 } @{$svcpart2svcparts{$cust_svc->svcpart}};
2467 warn "alternate(s) found\n" if $DEBUG;
2468 my $change_svcpart = $alternate[0];
2469 $target{$change_svcpart}--;
2470 my $new = new FS::cust_svc { $cust_svc->hash };
2471 $new->svcpart($change_svcpart);
2472 $new->pkgnum($dest_pkgnum);
2473 my $error = $new->replace($cust_svc);
2474 return $error if $error;
2487 This method is deprecated. See the I<depend_jobnum> option to the insert and
2488 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
2495 local $SIG{HUP} = 'IGNORE';
2496 local $SIG{INT} = 'IGNORE';
2497 local $SIG{QUIT} = 'IGNORE';
2498 local $SIG{TERM} = 'IGNORE';
2499 local $SIG{TSTP} = 'IGNORE';
2500 local $SIG{PIPE} = 'IGNORE';
2502 my $oldAutoCommit = $FS::UID::AutoCommit;
2503 local $FS::UID::AutoCommit = 0;
2506 foreach my $cust_svc ( $self->cust_svc ) {
2507 #false laziness w/svc_Common::insert
2508 my $svc_x = $cust_svc->svc_x;
2509 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
2510 my $error = $part_export->export_insert($svc_x);
2512 $dbh->rollback if $oldAutoCommit;
2518 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2525 Associates this package with a (suspension or cancellation) reason (see
2526 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
2529 Available options are:
2535 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.
2539 the access_user (see L<FS::access_user>) providing the reason
2547 the action (cancel, susp, adjourn, expire) associated with the reason
2551 If there is an error, returns the error, otherwise returns false.
2556 my ($self, %options) = @_;
2558 my $otaker = $options{reason_otaker} ||
2559 $FS::CurrentUser::CurrentUser->username;
2562 if ( $options{'reason'} =~ /^(\d+)$/ ) {
2566 } elsif ( ref($options{'reason'}) ) {
2568 return 'Enter a new reason (or select an existing one)'
2569 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
2571 my $reason = new FS::reason({
2572 'reason_type' => $options{'reason'}->{'typenum'},
2573 'reason' => $options{'reason'}->{'reason'},
2575 my $error = $reason->insert;
2576 return $error if $error;
2578 $reasonnum = $reason->reasonnum;
2581 return "Unparsable reason: ". $options{'reason'};
2584 my $cust_pkg_reason =
2585 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
2586 'reasonnum' => $reasonnum,
2587 'otaker' => $otaker,
2588 'action' => substr(uc($options{'action'}),0,1),
2589 'date' => $options{'date'}
2594 $cust_pkg_reason->insert;
2597 =item insert_discount
2599 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
2600 inserting a new discount on the fly (see L<FS::discount>).
2602 Available options are:
2610 If there is an error, returns the error, otherwise returns false.
2614 sub insert_discount {
2615 #my ($self, %options) = @_;
2618 my $cust_pkg_discount = new FS::cust_pkg_discount {
2619 'pkgnum' => $self->pkgnum,
2620 'discountnum' => $self->discountnum,
2622 'end_date' => '', #XXX
2623 #for the create a new discount case
2624 '_type' => $self->discountnum__type,
2625 'amount' => $self->discountnum_amount,
2626 'percent' => $self->discountnum_percent,
2627 'months' => $self->discountnum_months,
2628 'setup' => $self->discountnum_setup,
2629 #'disabled' => $self->discountnum_disabled,
2632 $cust_pkg_discount->insert;
2635 =item set_usage USAGE_VALUE_HASHREF
2637 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2638 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2639 upbytes, downbytes, and totalbytes are appropriate keys.
2641 All svc_accts which are part of this package have their values reset.
2646 my ($self, $valueref, %opt) = @_;
2648 foreach my $cust_svc ($self->cust_svc){
2649 my $svc_x = $cust_svc->svc_x;
2650 $svc_x->set_usage($valueref, %opt)
2651 if $svc_x->can("set_usage");
2655 =item recharge USAGE_VALUE_HASHREF
2657 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2658 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2659 upbytes, downbytes, and totalbytes are appropriate keys.
2661 All svc_accts which are part of this package have their values incremented.
2666 my ($self, $valueref) = @_;
2668 foreach my $cust_svc ($self->cust_svc){
2669 my $svc_x = $cust_svc->svc_x;
2670 $svc_x->recharge($valueref)
2671 if $svc_x->can("recharge");
2675 =item cust_pkg_discount
2679 sub cust_pkg_discount {
2681 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
2684 =item cust_pkg_discount_active
2688 sub cust_pkg_discount_active {
2690 grep { $_->status eq 'active' } $self->cust_pkg_discount;
2695 =head1 CLASS METHODS
2701 Returns an SQL expression identifying recurring packages.
2705 sub recurring_sql { "
2706 '0' != ( select freq from part_pkg
2707 where cust_pkg.pkgpart = part_pkg.pkgpart )
2712 Returns an SQL expression identifying one-time packages.
2717 '0' = ( select freq from part_pkg
2718 where cust_pkg.pkgpart = part_pkg.pkgpart )
2723 Returns an SQL expression identifying ordered packages (recurring packages not
2729 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
2734 Returns an SQL expression identifying active packages.
2739 $_[0]->recurring_sql. "
2740 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
2741 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2742 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2745 =item not_yet_billed_sql
2747 Returns an SQL expression identifying packages which have not yet been billed.
2751 sub not_yet_billed_sql { "
2752 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
2753 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2754 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2759 Returns an SQL expression identifying inactive packages (one-time packages
2760 that are otherwise unsuspended/uncancelled).
2764 sub inactive_sql { "
2765 ". $_[0]->onetime_sql(). "
2766 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
2767 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2768 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2774 Returns an SQL expression identifying suspended packages.
2778 sub suspended_sql { susp_sql(@_); }
2780 #$_[0]->recurring_sql(). ' AND '.
2782 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2783 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
2790 Returns an SQL exprression identifying cancelled packages.
2794 sub cancelled_sql { cancel_sql(@_); }
2796 #$_[0]->recurring_sql(). ' AND '.
2797 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
2802 Returns an SQL expression to give the package status as a string.
2808 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
2809 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
2810 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
2811 WHEN ".onetime_sql()." THEN 'one-time charge'
2816 =item search HASHREF
2820 Returns a qsearch hash expression to search for parameters specified in HASHREF.
2821 Valid parameters are
2829 active, inactive, suspended, cancel (or cancelled)
2833 active, inactive, suspended, one-time charge, inactive, cancel (or cancelled)
2837 boolean selects custom packages
2843 pkgpart or arrayref or hashref of pkgparts
2847 arrayref of beginning and ending epoch date
2851 arrayref of beginning and ending epoch date
2855 arrayref of beginning and ending epoch date
2859 arrayref of beginning and ending epoch date
2863 arrayref of beginning and ending epoch date
2867 arrayref of beginning and ending epoch date
2871 arrayref of beginning and ending epoch date
2875 pkgnum or APKG_pkgnum
2879 a value suited to passing to FS::UI::Web::cust_header
2883 specifies the user for agent virtualization
2887 boolean selects packages containing fcc form 477 telco lines
2894 my ($class, $params) = @_;
2901 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
2903 "cust_main.agentnum = $1";
2910 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
2912 "cust_pkg.custnum = $1";
2919 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
2921 "cust_pkg.pkgbatch = '$1'";
2928 if ( $params->{'magic'} eq 'active'
2929 || $params->{'status'} eq 'active' ) {
2931 push @where, FS::cust_pkg->active_sql();
2933 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
2934 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
2936 push @where, FS::cust_pkg->not_yet_billed_sql();
2938 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
2939 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
2941 push @where, FS::cust_pkg->inactive_sql();
2943 } elsif ( $params->{'magic'} eq 'suspended'
2944 || $params->{'status'} eq 'suspended' ) {
2946 push @where, FS::cust_pkg->suspended_sql();
2948 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
2949 || $params->{'status'} =~ /^cancell?ed$/ ) {
2951 push @where, FS::cust_pkg->cancelled_sql();
2956 # parse package class
2959 if ( exists($params->{'classnum'}) ) {
2962 if ( ref($params->{'classnum'}) ) {
2964 if ( ref($params->{'classnum'}) eq 'HASH' ) {
2965 @classnum = grep $params->{'classnum'}{$_}, keys %{ $params->{'classnum'} };
2966 } elsif ( ref($params->{'classnum'}) eq 'ARRAY' ) {
2967 @classnum = @{ $params->{'classnum'} };
2969 die 'unhandled classnum ref '. $params->{'classnum'};
2973 } elsif ( $params->{'classnum'} =~ /^(\d*)$/ && $1 ne '0' ) {
2980 my @nums = grep $_, @classnum;
2981 push @c_where, 'part_pkg.classnum IN ('. join(',',@nums). ')' if @nums;
2982 my $null = scalar( grep { $_ eq '' } @classnum );
2983 push @c_where, 'part_pkg.classnum IS NULL' if $null;
2985 if ( scalar(@c_where) == 1 ) {
2986 push @where, @c_where;
2987 } elsif ( @c_where ) {
2988 push @where, ' ( '. join(' OR ', @c_where). ' ) ';
2998 # parse package report options
3001 my @report_option = ();
3002 if ( exists($params->{'report_option'}) ) {
3003 if ( ref($params->{'report_option'}) eq 'ARRAY' ) {
3004 @report_option = @{ $params->{'report_option'} };
3005 } elsif ( $params->{'report_option'} =~ /^([,\d]*)$/ ) {
3006 @report_option = split(',', $1);
3011 if (@report_option) {
3012 # this will result in the empty set for the dangling comma case as it should
3014 map{ "0 < ( SELECT count(*) FROM part_pkg_option
3015 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
3016 AND optionname = 'report_option_$_'
3017 AND optionvalue = '1' )"
3021 foreach my $any ( grep /^report_option_any/, keys %$params ) {
3023 my @report_option_any = ();
3024 if ( ref($params->{$any}) eq 'ARRAY' ) {
3025 @report_option_any = @{ $params->{$any} };
3026 } elsif ( $params->{$any} =~ /^([,\d]*)$/ ) {
3027 @report_option_any = split(',', $1);
3030 if (@report_option_any) {
3031 # this will result in the empty set for the dangling comma case as it should
3032 push @where, ' ( '. join(' OR ',
3033 map{ "0 < ( SELECT count(*) FROM part_pkg_option
3034 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
3035 AND optionname = 'report_option_$_'
3036 AND optionvalue = '1' )"
3037 } @report_option_any
3047 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
3053 push @where, "(part_pkg.fcc_ds0s > 0 OR pkg_class.fcc_ds0s > 0)"
3054 if $params->{fcc_line};
3060 if ( exists($params->{'censustract'}) ) {
3061 $params->{'censustract'} =~ /^([.\d]*)$/;
3062 my $censustract = "cust_main.censustract = '$1'";
3063 $censustract .= ' OR cust_main.censustract is NULL' unless $1;
3064 push @where, "( $censustract )";
3068 # parse censustract2
3070 if ( exists($params->{'censustract2'})
3071 && $params->{'censustract2'} =~ /^(\d*)$/
3075 push @where, "cust_main.censustract LIKE '$1%'";
3078 "( cust_main.censustract = '' OR cust_main.censustract IS NULL )";
3086 if ( ref($params->{'pkgpart'}) ) {
3089 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
3090 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
3091 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
3092 @pkgpart = @{ $params->{'pkgpart'} };
3094 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
3097 @pkgpart = grep /^(\d+)$/, @pkgpart;
3099 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
3101 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
3102 push @where, "pkgpart = $1";
3111 #false laziness w/report_cust_pkg.html
3114 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
3115 'active' => { 'susp'=>1, 'cancel'=>1 },
3116 'suspended' => { 'cancel' => 1 },
3121 if( exists($params->{'active'} ) ) {
3122 # This overrides all the other date-related fields
3123 my($beginning, $ending) = @{$params->{'active'}};
3125 "cust_pkg.setup IS NOT NULL",
3126 "cust_pkg.setup <= $ending",
3127 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
3128 "NOT (".FS::cust_pkg->onetime_sql . ")";
3131 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end cancel )) {
3133 next unless exists($params->{$field});
3135 my($beginning, $ending) = @{$params->{$field}};
3137 next if $beginning == 0 && $ending == 4294967295;
3140 "cust_pkg.$field IS NOT NULL",
3141 "cust_pkg.$field >= $beginning",
3142 "cust_pkg.$field <= $ending";
3144 $orderby ||= "ORDER BY cust_pkg.$field";
3149 $orderby ||= 'ORDER BY bill';
3152 # parse magic, legacy, etc.
3155 if ( $params->{'magic'} &&
3156 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
3159 $orderby = 'ORDER BY pkgnum';
3161 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
3162 push @where, "pkgpart = $1";
3165 } elsif ( $params->{'query'} eq 'pkgnum' ) {
3167 $orderby = 'ORDER BY pkgnum';
3169 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
3171 $orderby = 'ORDER BY pkgnum';
3174 SELECT count(*) FROM pkg_svc
3175 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
3176 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
3177 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
3178 AND cust_svc.svcpart = pkg_svc.svcpart
3185 # setup queries, links, subs, etc. for the search
3188 # here is the agent virtualization
3189 if ($params->{CurrentUser}) {
3191 qsearchs('access_user', { username => $params->{CurrentUser} });
3194 push @where, $access_user->agentnums_sql('table'=>'cust_main');
3199 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
3202 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
3204 my $addl_from = 'LEFT JOIN cust_main USING ( custnum ) '.
3205 'LEFT JOIN part_pkg USING ( pkgpart ) '.
3206 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) ';
3208 my $count_query = "SELECT COUNT(*) FROM cust_pkg $addl_from $extra_sql";
3211 'table' => 'cust_pkg',
3213 'select' => join(', ',
3215 ( map "part_pkg.$_", qw( pkg freq ) ),
3216 'pkg_class.classname',
3217 'cust_main.custnum AS cust_main_custnum',
3218 FS::UI::Web::cust_sql_fields(
3219 $params->{'cust_fields'}
3222 'extra_sql' => "$extra_sql $orderby",
3223 'addl_from' => $addl_from,
3224 'count_query' => $count_query,
3231 Returns a list of two package counts. The first is a count of packages
3232 based on the supplied criteria and the second is the count of residential
3233 packages with those same criteria. Criteria are specified as in the search
3239 my ($class, $params) = @_;
3241 my $sql_query = $class->search( $params );
3243 my $count_sql = delete($sql_query->{'count_query'});
3244 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
3245 or die "couldn't parse count_sql";
3247 my $count_sth = dbh->prepare($count_sql)
3248 or die "Error preparing $count_sql: ". dbh->errstr;
3250 or die "Error executing $count_sql: ". $count_sth->errstr;
3251 my $count_arrayref = $count_sth->fetchrow_arrayref;
3253 return ( @$count_arrayref );
3260 Returns a list: the first item is an SQL fragment identifying matching
3261 packages/customers via location (taking into account shipping and package
3262 address taxation, if enabled), and subsequent items are the parameters to
3263 substitute for the placeholders in that fragment.
3268 my($class, %opt) = @_;
3269 my $ornull = $opt{'ornull'};
3271 my $conf = new FS::Conf;
3273 # '?' placeholders in _location_sql_where
3274 my $x = $ornull ? 3 : 2;
3275 my @bill_param = ( ('city')x3, ('county')x$x, ('state')x$x, 'country' );
3279 if ( $conf->exists('tax-ship_address') ) {
3282 ( ( ship_last IS NULL OR ship_last = '' )
3283 AND ". _location_sql_where('cust_main', '', $ornull ). "
3285 OR ( ship_last IS NOT NULL AND ship_last != ''
3286 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
3289 # AND payby != 'COMP'
3291 @main_param = ( @bill_param, @bill_param );
3295 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
3296 @main_param = @bill_param;
3302 if ( $conf->exists('tax-pkg_address') ) {
3304 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
3307 ( cust_pkg.locationnum IS NULL AND $main_where )
3308 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
3311 @param = ( @main_param, @bill_param );
3315 $where = $main_where;
3316 @param = @main_param;
3324 #subroutine, helper for location_sql
3325 sub _location_sql_where {
3327 my $prefix = @_ ? shift : '';
3328 my $ornull = @_ ? shift : '';
3330 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
3332 $ornull = $ornull ? ' OR ? IS NULL ' : '';
3334 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL ) ";
3335 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL ) ";
3336 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL ) ";
3338 # ( $table.${prefix}city = ? $or_empty_city $ornull )
3340 ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS text) IS NULL )
3341 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
3342 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
3343 AND $table.${prefix}country = ?
3348 my( $self, $what ) = @_;
3350 my $what_show_zero = $what. '_show_zero';
3351 length($self->$what_show_zero())
3352 ? ($self->$what_show_zero() eq 'Y')
3353 : $self->part_pkg->$what_show_zero();
3360 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
3362 CUSTNUM is a customer (see L<FS::cust_main>)
3364 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3365 L<FS::part_pkg>) to order for this customer. Duplicates are of course
3368 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
3369 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
3370 new billing items. An error is returned if this is not possible (see
3371 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
3374 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3375 newly-created cust_pkg objects.
3377 REFNUM, if specified, will specify the FS::pkg_referral record to be created
3378 and inserted. Multiple FS::pkg_referral records can be created by
3379 setting I<refnum> to an array reference of refnums or a hash reference with
3380 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
3381 record will be created corresponding to cust_main.refnum.
3386 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
3388 my $conf = new FS::Conf;
3390 # Transactionize this whole mess
3391 local $SIG{HUP} = 'IGNORE';
3392 local $SIG{INT} = 'IGNORE';
3393 local $SIG{QUIT} = 'IGNORE';
3394 local $SIG{TERM} = 'IGNORE';
3395 local $SIG{TSTP} = 'IGNORE';
3396 local $SIG{PIPE} = 'IGNORE';
3398 my $oldAutoCommit = $FS::UID::AutoCommit;
3399 local $FS::UID::AutoCommit = 0;
3403 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
3404 # return "Customer not found: $custnum" unless $cust_main;
3406 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
3409 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3412 my $change = scalar(@old_cust_pkg) != 0;
3415 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
3417 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
3418 " to pkgpart ". $pkgparts->[0]. "\n"
3421 my $err_or_cust_pkg =
3422 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
3423 'refnum' => $refnum,
3426 unless (ref($err_or_cust_pkg)) {
3427 $dbh->rollback if $oldAutoCommit;
3428 return $err_or_cust_pkg;
3431 push @$return_cust_pkg, $err_or_cust_pkg;
3432 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3437 # Create the new packages.
3438 foreach my $pkgpart (@$pkgparts) {
3440 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
3442 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
3443 pkgpart => $pkgpart,
3447 $error = $cust_pkg->insert( 'change' => $change );
3449 $dbh->rollback if $oldAutoCommit;
3452 push @$return_cust_pkg, $cust_pkg;
3454 # $return_cust_pkg now contains refs to all of the newly
3457 # Transfer services and cancel old packages.
3458 foreach my $old_pkg (@old_cust_pkg) {
3460 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
3463 foreach my $new_pkg (@$return_cust_pkg) {
3464 $error = $old_pkg->transfer($new_pkg);
3465 if ($error and $error == 0) {
3466 # $old_pkg->transfer failed.
3467 $dbh->rollback if $oldAutoCommit;
3472 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
3473 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
3474 foreach my $new_pkg (@$return_cust_pkg) {
3475 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
3476 if ($error and $error == 0) {
3477 # $old_pkg->transfer failed.
3478 $dbh->rollback if $oldAutoCommit;
3485 # Transfers were successful, but we went through all of the
3486 # new packages and still had services left on the old package.
3487 # We can't cancel the package under the circumstances, so abort.
3488 $dbh->rollback if $oldAutoCommit;
3489 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
3491 $error = $old_pkg->cancel( quiet=>1 );
3497 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3501 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
3503 A bulk change method to change packages for multiple customers.
3505 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3506 L<FS::part_pkg>) to order for each customer. Duplicates are of course
3509 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
3510 replace. The services (see L<FS::cust_svc>) are moved to the
3511 new billing items. An error is returned if this is not possible (see
3514 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3515 newly-created cust_pkg objects.
3520 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
3522 # Transactionize this whole mess
3523 local $SIG{HUP} = 'IGNORE';
3524 local $SIG{INT} = 'IGNORE';
3525 local $SIG{QUIT} = 'IGNORE';
3526 local $SIG{TERM} = 'IGNORE';
3527 local $SIG{TSTP} = 'IGNORE';
3528 local $SIG{PIPE} = 'IGNORE';
3530 my $oldAutoCommit = $FS::UID::AutoCommit;
3531 local $FS::UID::AutoCommit = 0;
3535 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3538 while(scalar(@old_cust_pkg)) {
3540 my $custnum = $old_cust_pkg[0]->custnum;
3541 my (@remove) = map { $_->pkgnum }
3542 grep { $_->custnum == $custnum } @old_cust_pkg;
3543 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
3545 my $error = order $custnum, $pkgparts, \@remove, \@return;
3547 push @errors, $error
3549 push @$return_cust_pkg, @return;
3552 if (scalar(@errors)) {
3553 $dbh->rollback if $oldAutoCommit;
3554 return join(' / ', @errors);
3557 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3561 # Used by FS::Upgrade to migrate to a new database.
3562 sub _upgrade_data { # class method
3563 my ($class, %opts) = @_;
3564 $class->_upgrade_otaker(%opts);
3566 # RT#10139, bug resulting in contract_end being set when it shouldn't
3567 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
3568 # RT#10830, bad calculation of prorate date near end of year
3569 # the date range for bill is December 2009, and we move it forward
3570 # one year if it's before the previous bill date (which it should
3572 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
3573 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
3574 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
3575 # RT6628, add order_date to cust_pkg
3576 'update cust_pkg set order_date = (select history_date from h_cust_pkg
3577 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
3578 history_action = \'insert\') where order_date is null',
3580 foreach my $sql (@statements) {
3581 my $sth = dbh->prepare($sql);
3582 $sth->execute or die $sth->errstr;
3590 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
3592 In sub order, the @pkgparts array (passed by reference) is clobbered.
3594 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
3595 method to pass dates to the recur_prog expression, it should do so.
3597 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
3598 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
3599 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
3600 configuration values. Probably need a subroutine which decides what to do
3601 based on whether or not we've fetched the user yet, rather than a hash. See
3602 FS::UID and the TODO.
3604 Now that things are transactional should the check in the insert method be
3609 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
3610 L<FS::pkg_svc>, schema.html from the base documentation