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";
1003 my %hash = $self->hash;
1005 $hash{'adjourn'} = $date;
1007 $hash{'susp'} = $suspend_time;
1009 my $new = new FS::cust_pkg ( \%hash );
1010 $error = $new->replace( $self, options => { $self->options } );
1012 $dbh->rollback if $oldAutoCommit;
1020 foreach my $cust_svc (
1021 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1023 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1025 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1026 $dbh->rollback if $oldAutoCommit;
1027 return "Illegal svcdb value in part_svc!";
1030 require "FS/$svcdb.pm";
1032 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1034 $error = $svc->suspend;
1036 $dbh->rollback if $oldAutoCommit;
1039 my( $label, $value ) = $cust_svc->label;
1040 push @labels, "$label: $value";
1044 my $conf = new FS::Conf;
1045 if ( $conf->config('suspend_email_admin') ) {
1047 my $error = send_email(
1048 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1049 #invoice_from ??? well as good as any
1050 'to' => $conf->config('suspend_email_admin'),
1051 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1053 "This is an automatic message from your Freeside installation\n",
1054 "informing you that the following customer package has been suspended:\n",
1056 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1057 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1058 ( map { "Service : $_\n" } @labels ),
1063 warn "WARNING: can't send suspension admin email (suspending anyway): ".
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;
1885 =item part_svc [ OPTION => VALUE ... ]
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
1901 Accepts one option: summarize_size. If specified and non-zero, will omit the
1902 extra cust_pkg_svc option for objects where num_cust_svc is this size or
1908 #label -> ($cust_svc->label)[1]
1914 #XXX some sort of sort order besides numeric by svcpart...
1915 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
1917 my $part_svc = $pkg_svc->part_svc;
1918 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
1919 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
1920 $part_svc->{'Hash'}{'num_avail'} =
1921 max( 0, $pkg_svc->quantity - $num_cust_svc );
1922 $part_svc->{'Hash'}{'cust_pkg_svc'} =
1923 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
1924 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
1925 && $num_cust_svc >= $opt{summarize_size};
1926 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
1928 } $self->part_pkg->pkg_svc;
1931 push @part_svc, map {
1933 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
1934 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
1935 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
1936 $part_svc->{'Hash'}{'cust_pkg_svc'} =
1937 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
1939 } $self->extra_part_svc;
1945 =item extra_part_svc
1947 Returns a list of FS::part_svc objects corresponding to services in this
1948 package which are still provisioned but not (any longer) available in the
1953 sub extra_part_svc {
1956 my $pkgnum = $self->pkgnum;
1957 #my $pkgpart = $self->pkgpart;
1960 # 'table' => 'part_svc',
1963 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
1964 # WHERE pkg_svc.svcpart = part_svc.svcpart
1965 # AND pkg_svc.pkgpart = ?
1968 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
1969 # LEFT JOIN cust_pkg USING ( pkgnum )
1970 # WHERE cust_svc.svcpart = part_svc.svcpart
1973 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
1976 #seems to benchmark slightly faster... (or did?)
1978 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
1979 my $pkgparts = join(',', @pkgparts);
1982 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
1983 #MySQL doesn't grok DISINCT ON
1984 'select' => 'DISTINCT part_svc.*',
1985 'table' => 'part_svc',
1987 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
1988 AND pkg_svc.pkgpart IN ($pkgparts)
1991 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
1992 LEFT JOIN cust_pkg USING ( pkgnum )
1995 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
1996 'extra_param' => [ [$self->pkgnum=>'int'] ],
2002 Returns a short status string for this package, currently:
2006 =item not yet billed
2008 =item one-time charge
2023 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
2025 return 'cancelled' if $self->get('cancel');
2026 return 'suspended' if $self->susp;
2027 return 'not yet billed' unless $self->setup;
2028 return 'one-time charge' if $freq =~ /^(0|$)/;
2032 =item ucfirst_status
2034 Returns the status with the first character capitalized.
2038 sub ucfirst_status {
2039 ucfirst(shift->status);
2044 Class method that returns the list of possible status strings for packages
2045 (see L<the status method|/status>). For example:
2047 @statuses = FS::cust_pkg->statuses();
2051 tie my %statuscolor, 'Tie::IxHash',
2052 'not yet billed' => '009999', #teal? cyan?
2053 'one-time charge' => '000000',
2054 'active' => '00CC00',
2055 'suspended' => 'FF9900',
2056 'cancelled' => 'FF0000',
2060 my $self = shift; #could be class...
2061 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
2062 # # mayble split btw one-time vs. recur
2068 Returns a hex triplet color string for this package's status.
2074 $statuscolor{$self->status};
2079 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
2080 "pkg-comment" depending on user preference).
2086 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
2087 $label = $self->pkgnum. ": $label"
2088 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
2092 =item pkg_label_long
2094 Returns a long label for this package, adding the primary service's label to
2099 sub pkg_label_long {
2101 my $label = $self->pkg_label;
2102 my $cust_svc = $self->primary_cust_svc;
2103 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
2107 =item primary_cust_svc
2109 Returns a primary service (as FS::cust_svc object) if one can be identified.
2113 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
2115 sub primary_cust_svc {
2118 my @cust_svc = $self->cust_svc;
2120 return '' unless @cust_svc; #no serivces - irrelevant then
2122 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
2124 # primary service as specified in the package definition
2125 # or exactly one service definition with quantity one
2126 my $svcpart = $self->part_pkg->svcpart;
2127 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
2128 return $cust_svc[0] if scalar(@cust_svc) == 1;
2130 #couldn't identify one thing..
2136 Returns a list of lists, calling the label method for all services
2137 (see L<FS::cust_svc>) of this billing item.
2143 map { [ $_->label ] } $self->cust_svc;
2146 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2148 Like the labels method, but returns historical information on services that
2149 were active as of END_TIMESTAMP and (optionally) not cancelled before
2150 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
2151 I<pkg_svc.hidden> flag will be omitted.
2153 Returns a list of lists, calling the label method for all (historical) services
2154 (see L<FS::h_cust_svc>) of this billing item.
2160 warn "$me _h_labels called on $self\n"
2162 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
2167 Like 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.
2175 shift->_labels_short( 'labels', @_ );
2178 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
2180 Like h_labels, except returns a simple flat list, and shortens long
2181 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2182 identical services to one line that lists the service label and the number of
2183 individual services rather than individual items.
2187 sub h_labels_short {
2188 shift->_labels_short( 'h_labels', @_ );
2192 my( $self, $method ) = ( shift, shift );
2194 warn "$me _labels_short called on $self with $method method\n"
2197 my $conf = new FS::Conf;
2198 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
2200 warn "$me _labels_short populating \%labels\n"
2204 #tie %labels, 'Tie::IxHash';
2205 push @{ $labels{$_->[0]} }, $_->[1]
2206 foreach $self->$method(@_);
2208 warn "$me _labels_short populating \@labels\n"
2212 foreach my $label ( keys %labels ) {
2214 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
2215 my $num = scalar(@values);
2216 warn "$me _labels_short $num items for $label\n"
2219 if ( $num > $max_same_services ) {
2220 warn "$me _labels_short more than $max_same_services, so summarizing\n"
2222 push @labels, "$label ($num)";
2224 if ( $conf->exists('cust_bill-consolidate_services') ) {
2225 warn "$me _labels_short consolidating services\n"
2227 # push @labels, "$label: ". join(', ', @values);
2229 my $detail = "$label: ";
2230 $detail .= shift(@values). ', '
2232 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
2234 push @labels, $detail;
2236 warn "$me _labels_short done consolidating services\n"
2239 warn "$me _labels_short adding service data\n"
2241 push @labels, map { "$label: $_" } @values;
2252 Returns the parent customer object (see L<FS::cust_main>).
2258 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
2261 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
2265 Returns the location object, if any (see L<FS::cust_location>).
2267 =item cust_location_or_main
2269 If this package is associated with a location, returns the locaiton (see
2270 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
2272 =item location_label [ OPTION => VALUE ... ]
2274 Returns the label of the location object (see L<FS::cust_location>).
2278 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
2280 =item seconds_since TIMESTAMP
2282 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
2283 package have been online since TIMESTAMP, according to the session monitor.
2285 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2286 L<Time::Local> and L<Date::Parse> for conversion functions.
2291 my($self, $since) = @_;
2294 foreach my $cust_svc (
2295 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
2297 $seconds += $cust_svc->seconds_since($since);
2304 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
2306 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
2307 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
2310 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2311 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2317 sub seconds_since_sqlradacct {
2318 my($self, $start, $end) = @_;
2322 foreach my $cust_svc (
2324 my $part_svc = $_->part_svc;
2325 $part_svc->svcdb eq 'svc_acct'
2326 && scalar($part_svc->part_export('sqlradius'));
2329 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
2336 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
2338 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
2339 in this package for sessions ending between TIMESTAMP_START (inclusive) and
2343 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2344 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2349 sub attribute_since_sqlradacct {
2350 my($self, $start, $end, $attrib) = @_;
2354 foreach my $cust_svc (
2356 my $part_svc = $_->part_svc;
2357 $part_svc->svcdb eq 'svc_acct'
2358 && scalar($part_svc->part_export('sqlradius'));
2361 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
2373 my( $self, $value ) = @_;
2374 if ( defined($value) ) {
2375 $self->setfield('quantity', $value);
2377 $self->getfield('quantity') || 1;
2380 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
2382 Transfers as many services as possible from this package to another package.
2384 The destination package can be specified by pkgnum by passing an FS::cust_pkg
2385 object. The destination package must already exist.
2387 Services are moved only if the destination allows services with the correct
2388 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
2389 this option with caution! No provision is made for export differences
2390 between the old and new service definitions. Probably only should be used
2391 when your exports for all service definitions of a given svcdb are identical.
2392 (attempt a transfer without it first, to move all possible svcpart-matching
2395 Any services that can't be moved remain in the original package.
2397 Returns an error, if there is one; otherwise, returns the number of services
2398 that couldn't be moved.
2403 my ($self, $dest_pkgnum, %opt) = @_;
2409 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
2410 $dest = $dest_pkgnum;
2411 $dest_pkgnum = $dest->pkgnum;
2413 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
2416 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
2418 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
2419 $target{$pkg_svc->svcpart} = $pkg_svc->quantity;
2422 foreach my $cust_svc ($dest->cust_svc) {
2423 $target{$cust_svc->svcpart}--;
2426 my %svcpart2svcparts = ();
2427 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2428 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
2429 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
2430 next if exists $svcpart2svcparts{$svcpart};
2431 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
2432 $svcpart2svcparts{$svcpart} = [
2434 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
2436 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
2437 'svcpart' => $_ } );
2439 $pkg_svc ? $pkg_svc->primary_svc : '',
2440 $pkg_svc ? $pkg_svc->quantity : 0,
2444 grep { $_ != $svcpart }
2446 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
2448 warn "alternates for svcpart $svcpart: ".
2449 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
2454 foreach my $cust_svc ($self->cust_svc) {
2455 if($target{$cust_svc->svcpart} > 0) {
2456 $target{$cust_svc->svcpart}--;
2457 my $new = new FS::cust_svc { $cust_svc->hash };
2458 $new->pkgnum($dest_pkgnum);
2459 my $error = $new->replace($cust_svc);
2460 return $error if $error;
2461 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2463 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
2464 warn "alternates to consider: ".
2465 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
2467 my @alternate = grep {
2468 warn "considering alternate svcpart $_: ".
2469 "$target{$_} available in new package\n"
2472 } @{$svcpart2svcparts{$cust_svc->svcpart}};
2474 warn "alternate(s) found\n" if $DEBUG;
2475 my $change_svcpart = $alternate[0];
2476 $target{$change_svcpart}--;
2477 my $new = new FS::cust_svc { $cust_svc->hash };
2478 $new->svcpart($change_svcpart);
2479 $new->pkgnum($dest_pkgnum);
2480 my $error = $new->replace($cust_svc);
2481 return $error if $error;
2494 This method is deprecated. See the I<depend_jobnum> option to the insert and
2495 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
2502 local $SIG{HUP} = 'IGNORE';
2503 local $SIG{INT} = 'IGNORE';
2504 local $SIG{QUIT} = 'IGNORE';
2505 local $SIG{TERM} = 'IGNORE';
2506 local $SIG{TSTP} = 'IGNORE';
2507 local $SIG{PIPE} = 'IGNORE';
2509 my $oldAutoCommit = $FS::UID::AutoCommit;
2510 local $FS::UID::AutoCommit = 0;
2513 foreach my $cust_svc ( $self->cust_svc ) {
2514 #false laziness w/svc_Common::insert
2515 my $svc_x = $cust_svc->svc_x;
2516 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
2517 my $error = $part_export->export_insert($svc_x);
2519 $dbh->rollback if $oldAutoCommit;
2525 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2532 Associates this package with a (suspension or cancellation) reason (see
2533 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
2536 Available options are:
2542 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.
2546 the access_user (see L<FS::access_user>) providing the reason
2554 the action (cancel, susp, adjourn, expire) associated with the reason
2558 If there is an error, returns the error, otherwise returns false.
2563 my ($self, %options) = @_;
2565 my $otaker = $options{reason_otaker} ||
2566 $FS::CurrentUser::CurrentUser->username;
2569 if ( $options{'reason'} =~ /^(\d+)$/ ) {
2573 } elsif ( ref($options{'reason'}) ) {
2575 return 'Enter a new reason (or select an existing one)'
2576 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
2578 my $reason = new FS::reason({
2579 'reason_type' => $options{'reason'}->{'typenum'},
2580 'reason' => $options{'reason'}->{'reason'},
2582 my $error = $reason->insert;
2583 return $error if $error;
2585 $reasonnum = $reason->reasonnum;
2588 return "Unparsable reason: ". $options{'reason'};
2591 my $cust_pkg_reason =
2592 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
2593 'reasonnum' => $reasonnum,
2594 'otaker' => $otaker,
2595 'action' => substr(uc($options{'action'}),0,1),
2596 'date' => $options{'date'}
2601 $cust_pkg_reason->insert;
2604 =item insert_discount
2606 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
2607 inserting a new discount on the fly (see L<FS::discount>).
2609 Available options are:
2617 If there is an error, returns the error, otherwise returns false.
2621 sub insert_discount {
2622 #my ($self, %options) = @_;
2625 my $cust_pkg_discount = new FS::cust_pkg_discount {
2626 'pkgnum' => $self->pkgnum,
2627 'discountnum' => $self->discountnum,
2629 'end_date' => '', #XXX
2630 #for the create a new discount case
2631 '_type' => $self->discountnum__type,
2632 'amount' => $self->discountnum_amount,
2633 'percent' => $self->discountnum_percent,
2634 'months' => $self->discountnum_months,
2635 'setup' => $self->discountnum_setup,
2636 #'disabled' => $self->discountnum_disabled,
2639 $cust_pkg_discount->insert;
2642 =item set_usage USAGE_VALUE_HASHREF
2644 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2645 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2646 upbytes, downbytes, and totalbytes are appropriate keys.
2648 All svc_accts which are part of this package have their values reset.
2653 my ($self, $valueref, %opt) = @_;
2655 foreach my $cust_svc ($self->cust_svc){
2656 my $svc_x = $cust_svc->svc_x;
2657 $svc_x->set_usage($valueref, %opt)
2658 if $svc_x->can("set_usage");
2662 =item recharge USAGE_VALUE_HASHREF
2664 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2665 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2666 upbytes, downbytes, and totalbytes are appropriate keys.
2668 All svc_accts which are part of this package have their values incremented.
2673 my ($self, $valueref) = @_;
2675 foreach my $cust_svc ($self->cust_svc){
2676 my $svc_x = $cust_svc->svc_x;
2677 $svc_x->recharge($valueref)
2678 if $svc_x->can("recharge");
2682 =item cust_pkg_discount
2686 sub cust_pkg_discount {
2688 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
2691 =item cust_pkg_discount_active
2695 sub cust_pkg_discount_active {
2697 grep { $_->status eq 'active' } $self->cust_pkg_discount;
2702 =head1 CLASS METHODS
2708 Returns an SQL expression identifying recurring packages.
2712 sub recurring_sql { "
2713 '0' != ( select freq from part_pkg
2714 where cust_pkg.pkgpart = part_pkg.pkgpart )
2719 Returns an SQL expression identifying one-time packages.
2724 '0' = ( select freq from part_pkg
2725 where cust_pkg.pkgpart = part_pkg.pkgpart )
2730 Returns an SQL expression identifying ordered packages (recurring packages not
2736 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
2741 Returns an SQL expression identifying active packages.
2746 $_[0]->recurring_sql. "
2747 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
2748 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2749 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2752 =item not_yet_billed_sql
2754 Returns an SQL expression identifying packages which have not yet been billed.
2758 sub not_yet_billed_sql { "
2759 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
2760 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2761 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2766 Returns an SQL expression identifying inactive packages (one-time packages
2767 that are otherwise unsuspended/uncancelled).
2771 sub inactive_sql { "
2772 ". $_[0]->onetime_sql(). "
2773 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
2774 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2775 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2781 Returns an SQL expression identifying suspended packages.
2785 sub suspended_sql { susp_sql(@_); }
2787 #$_[0]->recurring_sql(). ' AND '.
2789 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2790 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
2797 Returns an SQL exprression identifying cancelled packages.
2801 sub cancelled_sql { cancel_sql(@_); }
2803 #$_[0]->recurring_sql(). ' AND '.
2804 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
2809 Returns an SQL expression to give the package status as a string.
2815 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
2816 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
2817 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
2818 WHEN ".onetime_sql()." THEN 'one-time charge'
2823 =item search HASHREF
2827 Returns a qsearch hash expression to search for parameters specified in HASHREF.
2828 Valid parameters are
2836 active, inactive, suspended, cancel (or cancelled)
2840 active, inactive, suspended, one-time charge, inactive, cancel (or cancelled)
2844 boolean selects custom packages
2850 pkgpart or arrayref or hashref of pkgparts
2854 arrayref of beginning and ending epoch date
2858 arrayref of beginning and ending epoch date
2862 arrayref of beginning and ending epoch date
2866 arrayref of beginning and ending epoch date
2870 arrayref of beginning and ending epoch date
2874 arrayref of beginning and ending epoch date
2878 arrayref of beginning and ending epoch date
2882 pkgnum or APKG_pkgnum
2886 a value suited to passing to FS::UI::Web::cust_header
2890 specifies the user for agent virtualization
2894 boolean selects packages containing fcc form 477 telco lines
2901 my ($class, $params) = @_;
2908 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
2910 "cust_main.agentnum = $1";
2917 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
2919 "cust_pkg.custnum = $1";
2926 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
2928 "cust_pkg.pkgbatch = '$1'";
2935 if ( $params->{'magic'} eq 'active'
2936 || $params->{'status'} eq 'active' ) {
2938 push @where, FS::cust_pkg->active_sql();
2940 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
2941 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
2943 push @where, FS::cust_pkg->not_yet_billed_sql();
2945 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
2946 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
2948 push @where, FS::cust_pkg->inactive_sql();
2950 } elsif ( $params->{'magic'} eq 'suspended'
2951 || $params->{'status'} eq 'suspended' ) {
2953 push @where, FS::cust_pkg->suspended_sql();
2955 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
2956 || $params->{'status'} =~ /^cancell?ed$/ ) {
2958 push @where, FS::cust_pkg->cancelled_sql();
2963 # parse package class
2966 if ( exists($params->{'classnum'}) ) {
2969 if ( ref($params->{'classnum'}) ) {
2971 if ( ref($params->{'classnum'}) eq 'HASH' ) {
2972 @classnum = grep $params->{'classnum'}{$_}, keys %{ $params->{'classnum'} };
2973 } elsif ( ref($params->{'classnum'}) eq 'ARRAY' ) {
2974 @classnum = @{ $params->{'classnum'} };
2976 die 'unhandled classnum ref '. $params->{'classnum'};
2980 } elsif ( $params->{'classnum'} =~ /^(\d*)$/ && $1 ne '0' ) {
2987 my @nums = grep $_, @classnum;
2988 push @c_where, 'part_pkg.classnum IN ('. join(',',@nums). ')' if @nums;
2989 my $null = scalar( grep { $_ eq '' } @classnum );
2990 push @c_where, 'part_pkg.classnum IS NULL' if $null;
2992 if ( scalar(@c_where) == 1 ) {
2993 push @where, @c_where;
2994 } elsif ( @c_where ) {
2995 push @where, ' ( '. join(' OR ', @c_where). ' ) ';
3005 # parse package report options
3008 my @report_option = ();
3009 if ( exists($params->{'report_option'}) ) {
3010 if ( ref($params->{'report_option'}) eq 'ARRAY' ) {
3011 @report_option = @{ $params->{'report_option'} };
3012 } elsif ( $params->{'report_option'} =~ /^([,\d]*)$/ ) {
3013 @report_option = split(',', $1);
3018 if (@report_option) {
3019 # this will result in the empty set for the dangling comma case as it should
3021 map{ "0 < ( SELECT count(*) FROM part_pkg_option
3022 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
3023 AND optionname = 'report_option_$_'
3024 AND optionvalue = '1' )"
3028 foreach my $any ( grep /^report_option_any/, keys %$params ) {
3030 my @report_option_any = ();
3031 if ( ref($params->{$any}) eq 'ARRAY' ) {
3032 @report_option_any = @{ $params->{$any} };
3033 } elsif ( $params->{$any} =~ /^([,\d]*)$/ ) {
3034 @report_option_any = split(',', $1);
3037 if (@report_option_any) {
3038 # this will result in the empty set for the dangling comma case as it should
3039 push @where, ' ( '. join(' OR ',
3040 map{ "0 < ( SELECT count(*) FROM part_pkg_option
3041 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
3042 AND optionname = 'report_option_$_'
3043 AND optionvalue = '1' )"
3044 } @report_option_any
3054 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
3060 push @where, "(part_pkg.fcc_ds0s > 0 OR pkg_class.fcc_ds0s > 0)"
3061 if $params->{fcc_line};
3067 if ( exists($params->{'censustract'}) ) {
3068 $params->{'censustract'} =~ /^([.\d]*)$/;
3069 my $censustract = "cust_main.censustract = '$1'";
3070 $censustract .= ' OR cust_main.censustract is NULL' unless $1;
3071 push @where, "( $censustract )";
3075 # parse censustract2
3077 if ( exists($params->{'censustract2'})
3078 && $params->{'censustract2'} =~ /^(\d*)$/
3082 push @where, "cust_main.censustract LIKE '$1%'";
3085 "( cust_main.censustract = '' OR cust_main.censustract IS NULL )";
3093 if ( ref($params->{'pkgpart'}) ) {
3096 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
3097 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
3098 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
3099 @pkgpart = @{ $params->{'pkgpart'} };
3101 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
3104 @pkgpart = grep /^(\d+)$/, @pkgpart;
3106 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
3108 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
3109 push @where, "pkgpart = $1";
3118 #false laziness w/report_cust_pkg.html
3121 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
3122 'active' => { 'susp'=>1, 'cancel'=>1 },
3123 'suspended' => { 'cancel' => 1 },
3128 if( exists($params->{'active'} ) ) {
3129 # This overrides all the other date-related fields
3130 my($beginning, $ending) = @{$params->{'active'}};
3132 "cust_pkg.setup IS NOT NULL",
3133 "cust_pkg.setup <= $ending",
3134 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
3135 "NOT (".FS::cust_pkg->onetime_sql . ")";
3138 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end cancel )) {
3140 next unless exists($params->{$field});
3142 my($beginning, $ending) = @{$params->{$field}};
3144 next if $beginning == 0 && $ending == 4294967295;
3147 "cust_pkg.$field IS NOT NULL",
3148 "cust_pkg.$field >= $beginning",
3149 "cust_pkg.$field <= $ending";
3151 $orderby ||= "ORDER BY cust_pkg.$field";
3156 $orderby ||= 'ORDER BY bill';
3159 # parse magic, legacy, etc.
3162 if ( $params->{'magic'} &&
3163 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
3166 $orderby = 'ORDER BY pkgnum';
3168 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
3169 push @where, "pkgpart = $1";
3172 } elsif ( $params->{'query'} eq 'pkgnum' ) {
3174 $orderby = 'ORDER BY pkgnum';
3176 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
3178 $orderby = 'ORDER BY pkgnum';
3181 SELECT count(*) FROM pkg_svc
3182 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
3183 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
3184 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
3185 AND cust_svc.svcpart = pkg_svc.svcpart
3192 # setup queries, links, subs, etc. for the search
3195 # here is the agent virtualization
3196 if ($params->{CurrentUser}) {
3198 qsearchs('access_user', { username => $params->{CurrentUser} });
3201 push @where, $access_user->agentnums_sql('table'=>'cust_main');
3206 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
3209 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
3211 my $addl_from = 'LEFT JOIN cust_main USING ( custnum ) '.
3212 'LEFT JOIN part_pkg USING ( pkgpart ) '.
3213 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) ';
3215 my $count_query = "SELECT COUNT(*) FROM cust_pkg $addl_from $extra_sql";
3218 'table' => 'cust_pkg',
3220 'select' => join(', ',
3222 ( map "part_pkg.$_", qw( pkg freq ) ),
3223 'pkg_class.classname',
3224 'cust_main.custnum AS cust_main_custnum',
3225 FS::UI::Web::cust_sql_fields(
3226 $params->{'cust_fields'}
3229 'extra_sql' => "$extra_sql $orderby",
3230 'addl_from' => $addl_from,
3231 'count_query' => $count_query,
3238 Returns a list of two package counts. The first is a count of packages
3239 based on the supplied criteria and the second is the count of residential
3240 packages with those same criteria. Criteria are specified as in the search
3246 my ($class, $params) = @_;
3248 my $sql_query = $class->search( $params );
3250 my $count_sql = delete($sql_query->{'count_query'});
3251 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
3252 or die "couldn't parse count_sql";
3254 my $count_sth = dbh->prepare($count_sql)
3255 or die "Error preparing $count_sql: ". dbh->errstr;
3257 or die "Error executing $count_sql: ". $count_sth->errstr;
3258 my $count_arrayref = $count_sth->fetchrow_arrayref;
3260 return ( @$count_arrayref );
3267 Returns a list: the first item is an SQL fragment identifying matching
3268 packages/customers via location (taking into account shipping and package
3269 address taxation, if enabled), and subsequent items are the parameters to
3270 substitute for the placeholders in that fragment.
3275 my($class, %opt) = @_;
3276 my $ornull = $opt{'ornull'};
3278 my $conf = new FS::Conf;
3280 # '?' placeholders in _location_sql_where
3281 my $x = $ornull ? 3 : 2;
3282 my @bill_param = ( ('city')x3, ('county')x$x, ('state')x$x, 'country' );
3286 if ( $conf->exists('tax-ship_address') ) {
3289 ( ( ship_last IS NULL OR ship_last = '' )
3290 AND ". _location_sql_where('cust_main', '', $ornull ). "
3292 OR ( ship_last IS NOT NULL AND ship_last != ''
3293 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
3296 # AND payby != 'COMP'
3298 @main_param = ( @bill_param, @bill_param );
3302 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
3303 @main_param = @bill_param;
3309 if ( $conf->exists('tax-pkg_address') ) {
3311 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
3314 ( cust_pkg.locationnum IS NULL AND $main_where )
3315 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
3318 @param = ( @main_param, @bill_param );
3322 $where = $main_where;
3323 @param = @main_param;
3331 #subroutine, helper for location_sql
3332 sub _location_sql_where {
3334 my $prefix = @_ ? shift : '';
3335 my $ornull = @_ ? shift : '';
3337 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
3339 $ornull = $ornull ? ' OR ? IS NULL ' : '';
3341 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL ) ";
3342 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL ) ";
3343 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL ) ";
3345 # ( $table.${prefix}city = ? $or_empty_city $ornull )
3347 ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS text) IS NULL )
3348 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
3349 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
3350 AND $table.${prefix}country = ?
3355 my( $self, $what ) = @_;
3357 my $what_show_zero = $what. '_show_zero';
3358 length($self->$what_show_zero())
3359 ? ($self->$what_show_zero() eq 'Y')
3360 : $self->part_pkg->$what_show_zero();
3367 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
3369 CUSTNUM is a customer (see L<FS::cust_main>)
3371 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3372 L<FS::part_pkg>) to order for this customer. Duplicates are of course
3375 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
3376 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
3377 new billing items. An error is returned if this is not possible (see
3378 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
3381 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3382 newly-created cust_pkg objects.
3384 REFNUM, if specified, will specify the FS::pkg_referral record to be created
3385 and inserted. Multiple FS::pkg_referral records can be created by
3386 setting I<refnum> to an array reference of refnums or a hash reference with
3387 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
3388 record will be created corresponding to cust_main.refnum.
3393 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
3395 my $conf = new FS::Conf;
3397 # Transactionize this whole mess
3398 local $SIG{HUP} = 'IGNORE';
3399 local $SIG{INT} = 'IGNORE';
3400 local $SIG{QUIT} = 'IGNORE';
3401 local $SIG{TERM} = 'IGNORE';
3402 local $SIG{TSTP} = 'IGNORE';
3403 local $SIG{PIPE} = 'IGNORE';
3405 my $oldAutoCommit = $FS::UID::AutoCommit;
3406 local $FS::UID::AutoCommit = 0;
3410 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
3411 # return "Customer not found: $custnum" unless $cust_main;
3413 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
3416 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3419 my $change = scalar(@old_cust_pkg) != 0;
3422 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
3424 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
3425 " to pkgpart ". $pkgparts->[0]. "\n"
3428 my $err_or_cust_pkg =
3429 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
3430 'refnum' => $refnum,
3433 unless (ref($err_or_cust_pkg)) {
3434 $dbh->rollback if $oldAutoCommit;
3435 return $err_or_cust_pkg;
3438 push @$return_cust_pkg, $err_or_cust_pkg;
3439 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3444 # Create the new packages.
3445 foreach my $pkgpart (@$pkgparts) {
3447 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
3449 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
3450 pkgpart => $pkgpart,
3454 $error = $cust_pkg->insert( 'change' => $change );
3456 $dbh->rollback if $oldAutoCommit;
3459 push @$return_cust_pkg, $cust_pkg;
3461 # $return_cust_pkg now contains refs to all of the newly
3464 # Transfer services and cancel old packages.
3465 foreach my $old_pkg (@old_cust_pkg) {
3467 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
3470 foreach my $new_pkg (@$return_cust_pkg) {
3471 $error = $old_pkg->transfer($new_pkg);
3472 if ($error and $error == 0) {
3473 # $old_pkg->transfer failed.
3474 $dbh->rollback if $oldAutoCommit;
3479 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
3480 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
3481 foreach my $new_pkg (@$return_cust_pkg) {
3482 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
3483 if ($error and $error == 0) {
3484 # $old_pkg->transfer failed.
3485 $dbh->rollback if $oldAutoCommit;
3492 # Transfers were successful, but we went through all of the
3493 # new packages and still had services left on the old package.
3494 # We can't cancel the package under the circumstances, so abort.
3495 $dbh->rollback if $oldAutoCommit;
3496 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
3498 $error = $old_pkg->cancel( quiet=>1 );
3504 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3508 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
3510 A bulk change method to change packages for multiple customers.
3512 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3513 L<FS::part_pkg>) to order for each customer. Duplicates are of course
3516 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
3517 replace. The services (see L<FS::cust_svc>) are moved to the
3518 new billing items. An error is returned if this is not possible (see
3521 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3522 newly-created cust_pkg objects.
3527 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
3529 # Transactionize this whole mess
3530 local $SIG{HUP} = 'IGNORE';
3531 local $SIG{INT} = 'IGNORE';
3532 local $SIG{QUIT} = 'IGNORE';
3533 local $SIG{TERM} = 'IGNORE';
3534 local $SIG{TSTP} = 'IGNORE';
3535 local $SIG{PIPE} = 'IGNORE';
3537 my $oldAutoCommit = $FS::UID::AutoCommit;
3538 local $FS::UID::AutoCommit = 0;
3542 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3545 while(scalar(@old_cust_pkg)) {
3547 my $custnum = $old_cust_pkg[0]->custnum;
3548 my (@remove) = map { $_->pkgnum }
3549 grep { $_->custnum == $custnum } @old_cust_pkg;
3550 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
3552 my $error = order $custnum, $pkgparts, \@remove, \@return;
3554 push @errors, $error
3556 push @$return_cust_pkg, @return;
3559 if (scalar(@errors)) {
3560 $dbh->rollback if $oldAutoCommit;
3561 return join(' / ', @errors);
3564 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3568 # Used by FS::Upgrade to migrate to a new database.
3569 sub _upgrade_data { # class method
3570 my ($class, %opts) = @_;
3571 $class->_upgrade_otaker(%opts);
3573 # RT#10139, bug resulting in contract_end being set when it shouldn't
3574 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
3575 # RT#10830, bad calculation of prorate date near end of year
3576 # the date range for bill is December 2009, and we move it forward
3577 # one year if it's before the previous bill date (which it should
3579 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
3580 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
3581 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
3582 # RT6628, add order_date to cust_pkg
3583 'update cust_pkg set order_date = (select history_date from h_cust_pkg
3584 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
3585 history_action = \'insert\') where order_date is null',
3587 foreach my $sql (@statements) {
3588 my $sth = dbh->prepare($sql);
3589 $sth->execute or die $sth->errstr;
3597 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
3599 In sub order, the @pkgparts array (passed by reference) is clobbered.
3601 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
3602 method to pass dates to the recur_prog expression, it should do so.
3604 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
3605 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
3606 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
3607 configuration values. Probably need a subroutine which decides what to do
3608 based on whether or not we've fetched the user yet, rather than a hash. See
3609 FS::UID and the TODO.
3611 Now that things are transactional should the check in the insert method be
3616 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
3617 L<FS::pkg_svc>, schema.html from the base documentation