4 use base qw( FS::otaker_Mixin FS::cust_main_Mixin FS::location_Mixin
5 FS::m2m_Common FS::option_Common );
6 use vars qw($disable_agentcheck $DEBUG $me);
8 use Scalar::Util qw( blessed );
9 use List::Util qw(max);
11 use Time::Local qw( timelocal_nocheck );
13 use FS::UID qw( getotaker dbh );
14 use FS::Misc qw( send_email );
15 use FS::Record qw( qsearch qsearchs );
20 use FS::cust_location;
22 use FS::cust_bill_pkg;
23 use FS::cust_pkg_detail;
28 use FS::cust_pkg_reason;
30 use FS::cust_pkg_discount;
34 # need to 'use' these instead of 'require' in sub { cancel, suspend, unsuspend,
36 # because they load configuration by setting FS::UID::callback (see TODO)
42 # for sending cancel emails in sub cancel
46 $me = '[FS::cust_pkg]';
48 $disable_agentcheck = 0;
52 my ( $hashref, $cache ) = @_;
53 #if ( $hashref->{'pkgpart'} ) {
54 if ( $hashref->{'pkg'} ) {
55 # #@{ $self->{'_pkgnum'} } = ();
56 # my $subcache = $cache->subcache('pkgpart', 'part_pkg');
57 # $self->{'_pkgpart'} = $subcache;
58 # #push @{ $self->{'_pkgnum'} },
59 # FS::part_pkg->new_or_cached($hashref, $subcache);
60 $self->{'_pkgpart'} = FS::part_pkg->new($hashref);
62 if ( exists $hashref->{'svcnum'} ) {
63 #@{ $self->{'_pkgnum'} } = ();
64 my $subcache = $cache->subcache('svcnum', 'cust_svc', $hashref->{pkgnum});
65 $self->{'_svcnum'} = $subcache;
66 #push @{ $self->{'_pkgnum'} },
67 FS::cust_svc->new_or_cached($hashref, $subcache) if $hashref->{svcnum};
73 FS::cust_pkg - Object methods for cust_pkg objects
79 $record = new FS::cust_pkg \%hash;
80 $record = new FS::cust_pkg { 'column' => 'value' };
82 $error = $record->insert;
84 $error = $new_record->replace($old_record);
86 $error = $record->delete;
88 $error = $record->check;
90 $error = $record->cancel;
92 $error = $record->suspend;
94 $error = $record->unsuspend;
96 $part_pkg = $record->part_pkg;
98 @labels = $record->labels;
100 $seconds = $record->seconds_since($timestamp);
102 $error = FS::cust_pkg::order( $custnum, \@pkgparts );
103 $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );
107 An FS::cust_pkg object represents a customer billing item. FS::cust_pkg
108 inherits from FS::Record. The following fields are currently supported:
114 Primary key (assigned automatically for new billing items)
118 Customer (see L<FS::cust_main>)
122 Billing item definition (see L<FS::part_pkg>)
126 Optional link to package location (see L<FS::location>)
130 date package was ordered (also remains same on changes)
142 date (next bill date)
170 order taker (see L<FS::access_user>)
174 If this field is set to 1, disables the automatic
175 unsuspension of this package when using the B<unsuspendauto> config option.
179 If not set, defaults to 1
183 Date of change from previous package
193 =item change_locationnum
199 Note: setup, last_bill, bill, adjourn, susp, expire, cancel and change_date
200 are specified as UNIX timestamps; see L<perlfunc/"time">. Also see
201 L<Time::Local> and L<Date::Parse> for conversion functions.
209 Create a new billing item. To add the item to the database, see L<"insert">.
213 sub table { 'cust_pkg'; }
214 sub cust_linked { $_[0]->cust_main_custnum; }
215 sub cust_unlinked_msg {
217 "WARNING: can't find cust_main.custnum ". $self->custnum.
218 ' (cust_pkg.pkgnum '. $self->pkgnum. ')';
221 =item insert [ OPTION => VALUE ... ]
223 Adds this billing item to the database ("Orders" the item). If there is an
224 error, returns the error, otherwise returns false.
226 If the additional field I<promo_code> is defined instead of I<pkgpart>, it
227 will be used to look up the package definition and agent restrictions will be
230 If the additional field I<refnum> is defined, an FS::pkg_referral record will
231 be created and inserted. Multiple FS::pkg_referral records can be created by
232 setting I<refnum> to an array reference of refnums or a hash reference with
233 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
234 record will be created corresponding to cust_main.refnum.
236 The following options are available:
242 If set true, supresses any referral credit to a referring customer.
246 cust_pkg_option records will be created
250 a ticket will be added to this customer with this subject
254 an optional queue name for ticket additions
261 my( $self, %options ) = @_;
263 my $error = $self->check_pkgpart;
264 return $error if $error;
266 if ( $self->part_pkg->option('start_1st', 1) && !$self->start_date ) {
267 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime(time) )[0,1,2,3,4,5];
268 $mon += 1 unless $mday == 1;
269 until ( $mon < 12 ) { $mon -= 12; $year++; }
270 $self->start_date( timelocal_nocheck(0,0,0,1,$mon,$year) );
273 foreach my $action ( qw(expire adjourn contract_end) ) {
274 my $months = $self->part_pkg->option("${action}_months",1);
275 if($months and !$self->$action) {
276 my $start = $self->start_date || $self->setup || time;
277 $self->$action( $self->part_pkg->add_freq($start, $months) );
281 $self->order_date(time);
283 local $SIG{HUP} = 'IGNORE';
284 local $SIG{INT} = 'IGNORE';
285 local $SIG{QUIT} = 'IGNORE';
286 local $SIG{TERM} = 'IGNORE';
287 local $SIG{TSTP} = 'IGNORE';
288 local $SIG{PIPE} = 'IGNORE';
290 my $oldAutoCommit = $FS::UID::AutoCommit;
291 local $FS::UID::AutoCommit = 0;
294 $error = $self->SUPER::insert($options{options} ? %{$options{options}} : ());
296 $dbh->rollback if $oldAutoCommit;
300 $self->refnum($self->cust_main->refnum) unless $self->refnum;
301 $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
302 $self->process_m2m( 'link_table' => 'pkg_referral',
303 'target_table' => 'part_referral',
304 'params' => $self->refnum,
307 if ( $self->discountnum ) {
308 my $error = $self->insert_discount();
310 $dbh->rollback if $oldAutoCommit;
315 #if ( $self->reg_code ) {
316 # my $reg_code = qsearchs('reg_code', { 'code' => $self->reg_code } );
317 # $error = $reg_code->delete;
319 # $dbh->rollback if $oldAutoCommit;
324 my $conf = new FS::Conf;
326 if ( $conf->config('ticket_system') && $options{ticket_subject} ) {
329 # use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
336 use FS::TicketSystem;
337 FS::TicketSystem->init();
339 my $q = new RT::Queue($RT::SystemUser);
340 $q->Load($options{ticket_queue}) if $options{ticket_queue};
341 my $t = new RT::Ticket($RT::SystemUser);
342 my $mime = new MIME::Entity;
343 $mime->build( Type => 'text/plain', Data => $options{ticket_subject} );
344 $t->Create( $options{ticket_queue} ? (Queue => $q) : (),
345 Subject => $options{ticket_subject},
348 $t->AddLink( Type => 'MemberOf',
349 Target => 'freeside://freeside/cust_main/'. $self->custnum,
353 if ($conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
354 my $queue = new FS::queue {
355 'job' => 'FS::cust_main::queueable_print',
357 $error = $queue->insert(
358 'custnum' => $self->custnum,
359 'template' => 'welcome_letter',
363 warn "can't send welcome letter: $error";
368 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
375 This method now works but you probably shouldn't use it.
377 You don't want to delete packages, because there would then be no record
378 the customer ever purchased the package. Instead, see the cancel method and
379 hide cancelled packages.
386 local $SIG{HUP} = 'IGNORE';
387 local $SIG{INT} = 'IGNORE';
388 local $SIG{QUIT} = 'IGNORE';
389 local $SIG{TERM} = 'IGNORE';
390 local $SIG{TSTP} = 'IGNORE';
391 local $SIG{PIPE} = 'IGNORE';
393 my $oldAutoCommit = $FS::UID::AutoCommit;
394 local $FS::UID::AutoCommit = 0;
397 foreach my $cust_pkg_discount ($self->cust_pkg_discount) {
398 my $error = $cust_pkg_discount->delete;
400 $dbh->rollback if $oldAutoCommit;
404 #cust_bill_pkg_discount?
406 foreach my $cust_pkg_detail ($self->cust_pkg_detail) {
407 my $error = $cust_pkg_detail->delete;
409 $dbh->rollback if $oldAutoCommit;
414 foreach my $cust_pkg_reason (
416 'table' => 'cust_pkg_reason',
417 'hashref' => { 'pkgnum' => $self->pkgnum },
421 my $error = $cust_pkg_reason->delete;
423 $dbh->rollback if $oldAutoCommit;
430 my $error = $self->SUPER::delete(@_);
432 $dbh->rollback if $oldAutoCommit;
436 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
442 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
444 Replaces the OLD_RECORD with this one in the database. If there is an error,
445 returns the error, otherwise returns false.
447 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
449 Changing pkgpart may have disasterous effects. See the order subroutine.
451 setup and bill are normally updated by calling the bill method of a customer
452 object (see L<FS::cust_main>).
454 suspend is normally updated by the suspend and unsuspend methods.
456 cancel is normally updated by the cancel method (and also the order subroutine
459 Available options are:
465 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.
469 the access_user (see L<FS::access_user>) providing the reason
473 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
482 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
487 ( ref($_[0]) eq 'HASH' )
491 #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
492 #return "Can't change otaker!" if $old->otaker ne $new->otaker;
495 #return "Can't change setup once it exists!"
496 # if $old->getfield('setup') &&
497 # $old->getfield('setup') != $new->getfield('setup');
499 #some logic for bill, susp, cancel?
501 local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
503 local $SIG{HUP} = 'IGNORE';
504 local $SIG{INT} = 'IGNORE';
505 local $SIG{QUIT} = 'IGNORE';
506 local $SIG{TERM} = 'IGNORE';
507 local $SIG{TSTP} = 'IGNORE';
508 local $SIG{PIPE} = 'IGNORE';
510 my $oldAutoCommit = $FS::UID::AutoCommit;
511 local $FS::UID::AutoCommit = 0;
514 foreach my $method ( qw(adjourn expire) ) { # How many reasons?
515 if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
516 my $error = $new->insert_reason(
517 'reason' => $options->{'reason'},
518 'date' => $new->$method,
520 'reason_otaker' => $options->{'reason_otaker'},
523 dbh->rollback if $oldAutoCommit;
524 return "Error inserting cust_pkg_reason: $error";
529 #save off and freeze RADIUS attributes for any associated svc_acct records
531 if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
533 #also check for specific exports?
534 # to avoid spurious modify export events
535 @svc_acct = map { $_->svc_x }
536 grep { $_->part_svc->svcdb eq 'svc_acct' }
539 $_->snapshot foreach @svc_acct;
543 my $error = $new->SUPER::replace($old,
544 $options->{options} ? $options->{options} : ()
547 $dbh->rollback if $oldAutoCommit;
551 #for prepaid packages,
552 #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
553 foreach my $old_svc_acct ( @svc_acct ) {
554 my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
556 $new_svc_acct->replace( $old_svc_acct,
557 'depend_jobnum' => $options->{depend_jobnum},
560 $dbh->rollback if $oldAutoCommit;
565 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
572 Checks all fields to make sure this is a valid billing item. If there is an
573 error, returns the error, otherwise returns false. Called by the insert and
581 $self->locationnum('') if !$self->locationnum || $self->locationnum == -1;
584 $self->ut_numbern('pkgnum')
585 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
586 || $self->ut_numbern('pkgpart')
587 || $self->check_pkgpart
588 || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
589 || $self->ut_numbern('start_date')
590 || $self->ut_numbern('setup')
591 || $self->ut_numbern('bill')
592 || $self->ut_numbern('susp')
593 || $self->ut_numbern('cancel')
594 || $self->ut_numbern('adjourn')
595 || $self->ut_numbern('expire')
596 || $self->ut_enum('no_auto', [ '', 'Y' ])
597 || $self->ut_numbern('agent_pkgid')
599 return $error if $error;
601 return "A package with both start date (future start) and setup date (already started) will never bill"
602 if $self->start_date && $self->setup;
604 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
606 if ( $self->dbdef_table->column('manual_flag') ) {
607 $self->manual_flag('') if $self->manual_flag eq ' ';
608 $self->manual_flag =~ /^([01]?)$/
609 or return "Illegal manual_flag ". $self->manual_flag;
610 $self->manual_flag($1);
623 my $error = $self->ut_numbern('pkgpart');
624 return $error if $error;
626 if ( $self->reg_code ) {
628 unless ( grep { $self->pkgpart == $_->pkgpart }
629 map { $_->reg_code_pkg }
630 qsearchs( 'reg_code', { 'code' => $self->reg_code,
631 'agentnum' => $self->cust_main->agentnum })
633 return "Unknown registration code";
636 } elsif ( $self->promo_code ) {
639 qsearchs('part_pkg', {
640 'pkgpart' => $self->pkgpart,
641 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
643 return 'Unknown promotional code' unless $promo_part_pkg;
647 unless ( $disable_agentcheck ) {
649 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
650 return "agent ". $agent->agentnum. ':'. $agent->agent.
651 " can't purchase pkgpart ". $self->pkgpart
652 unless $agent->pkgpart_hashref->{ $self->pkgpart }
653 || $agent->agentnum == $self->part_pkg->agentnum;
656 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
657 return $error if $error;
665 =item cancel [ OPTION => VALUE ... ]
667 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
668 in this package, then cancels the package itself (sets the cancel field to
671 Available options are:
675 =item quiet - can be set true to supress email cancellation notices.
677 =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.
679 =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.
681 =item date - can be set to a unix style timestamp to specify when to cancel (expire)
683 =item nobill - can be set true to skip billing if it might otherwise be done.
685 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
686 not credit it. This must be set (by change()) when changing the package
687 to a different pkgpart or location, and probably shouldn't be in any other
688 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
693 If there is an error, returns the error, otherwise returns false.
698 my( $self, %options ) = @_;
701 my $conf = new FS::Conf;
703 warn "cust_pkg::cancel called with options".
704 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
707 local $SIG{HUP} = 'IGNORE';
708 local $SIG{INT} = 'IGNORE';
709 local $SIG{QUIT} = 'IGNORE';
710 local $SIG{TERM} = 'IGNORE';
711 local $SIG{TSTP} = 'IGNORE';
712 local $SIG{PIPE} = 'IGNORE';
714 my $oldAutoCommit = $FS::UID::AutoCommit;
715 local $FS::UID::AutoCommit = 0;
718 my $old = $self->select_for_update;
720 if ( $old->get('cancel') || $self->get('cancel') ) {
721 dbh->rollback if $oldAutoCommit;
722 return ""; # no error
725 my $date = $options{date} if $options{date}; # expire/cancel later
726 $date = '' if ($date && $date <= time); # complain instead?
728 #race condition: usage could be ongoing until unprovisioned
729 #resolved by performing a change package instead (which unprovisions) and
731 if ( !$options{nobill} && !$date && $conf->exists('bill_usage_on_cancel') ) {
732 my $copy = $self->new({$self->hash});
734 $copy->cust_main->bill( pkg_list => [ $copy ], cancel => 1 );
735 warn "Error billing during cancel, custnum ".
736 #$self->cust_main->custnum. ": $error"
741 my $cancel_time = $options{'time'} || time;
743 if ( $options{'reason'} ) {
744 $error = $self->insert_reason( 'reason' => $options{'reason'},
745 'action' => $date ? 'expire' : 'cancel',
746 'date' => $date ? $date : $cancel_time,
747 'reason_otaker' => $options{'reason_otaker'},
750 dbh->rollback if $oldAutoCommit;
751 return "Error inserting cust_pkg_reason: $error";
755 my %svc_cancel_opt = ();
756 $svc_cancel_opt{'date'} = $date if $date;
757 foreach my $cust_svc (
760 sort { $a->[1] <=> $b->[1] }
761 map { [ $_, $_->svc_x->table_info->{'cancel_weight'} ]; }
762 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
764 my $error = $cust_svc->cancel( %svc_cancel_opt );
767 $dbh->rollback if $oldAutoCommit;
768 return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
775 # Add a credit for remaining service
776 my $last_bill = $self->getfield('last_bill') || 0;
777 my $next_bill = $self->getfield('bill') || 0;
779 if ( exists($options{'unused_credit'}) ) {
780 $do_credit = $options{'unused_credit'};
783 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
786 and $last_bill > 0 # the package has been billed
787 and $next_bill > 0 # the package has a next bill date
788 and $next_bill >= $cancel_time # which is in the future
790 my $remaining_value = $self->calc_remain('time' => $cancel_time);
791 if ( $remaining_value > 0 ) {
792 my $error = $self->cust_main->credit(
794 'Credit for unused time on '. $self->part_pkg->pkg,
795 'reason_type' => $conf->config('cancel_credit_type'),
798 $dbh->rollback if $oldAutoCommit;
799 return "Error crediting customer \$$remaining_value for unused time".
800 " on ". $self->part_pkg->pkg. ": $error";
802 } #if $remaining_value
807 my %hash = $self->hash;
808 $date ? ($hash{'expire'} = $date) : ($hash{'cancel'} = $cancel_time);
809 my $new = new FS::cust_pkg ( \%hash );
810 $error = $new->replace( $self, options => { $self->options } );
812 $dbh->rollback if $oldAutoCommit;
816 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
817 return '' if $date; #no errors
819 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
820 if ( !$options{'quiet'} &&
821 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
823 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
826 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
827 $error = $msg_template->send( 'cust_main' => $self->cust_main,
832 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
833 'to' => \@invoicing_list,
834 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
835 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
838 #should this do something on errors?
845 =item cancel_if_expired [ NOW_TIMESTAMP ]
847 Cancels this package if its expire date has been reached.
851 sub cancel_if_expired {
853 my $time = shift || time;
854 return '' unless $self->expire && $self->expire <= $time;
855 my $error = $self->cancel;
857 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
858 $self->custnum. ": $error";
865 Cancels any pending expiration (sets the expire field to null).
867 If there is an error, returns the error, otherwise returns false.
872 my( $self, %options ) = @_;
875 local $SIG{HUP} = 'IGNORE';
876 local $SIG{INT} = 'IGNORE';
877 local $SIG{QUIT} = 'IGNORE';
878 local $SIG{TERM} = 'IGNORE';
879 local $SIG{TSTP} = 'IGNORE';
880 local $SIG{PIPE} = 'IGNORE';
882 my $oldAutoCommit = $FS::UID::AutoCommit;
883 local $FS::UID::AutoCommit = 0;
886 my $old = $self->select_for_update;
888 my $pkgnum = $old->pkgnum;
889 if ( $old->get('cancel') || $self->get('cancel') ) {
890 dbh->rollback if $oldAutoCommit;
891 return "Can't unexpire cancelled package $pkgnum";
892 # or at least it's pointless
895 unless ( $old->get('expire') && $self->get('expire') ) {
896 dbh->rollback if $oldAutoCommit;
897 return ""; # no error
900 my %hash = $self->hash;
901 $hash{'expire'} = '';
902 my $new = new FS::cust_pkg ( \%hash );
903 $error = $new->replace( $self, options => { $self->options } );
905 $dbh->rollback if $oldAutoCommit;
909 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
915 =item suspend [ OPTION => VALUE ... ]
917 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
918 package, then suspends the package itself (sets the susp field to now).
920 Available options are:
924 =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.
926 =item date - can be set to a unix style timestamp to specify when to suspend (adjourn)
930 If there is an error, returns the error, otherwise returns false.
935 my( $self, %options ) = @_;
938 local $SIG{HUP} = 'IGNORE';
939 local $SIG{INT} = 'IGNORE';
940 local $SIG{QUIT} = 'IGNORE';
941 local $SIG{TERM} = 'IGNORE';
942 local $SIG{TSTP} = 'IGNORE';
943 local $SIG{PIPE} = 'IGNORE';
945 my $oldAutoCommit = $FS::UID::AutoCommit;
946 local $FS::UID::AutoCommit = 0;
949 my $old = $self->select_for_update;
951 my $pkgnum = $old->pkgnum;
952 if ( $old->get('cancel') || $self->get('cancel') ) {
953 dbh->rollback if $oldAutoCommit;
954 return "Can't suspend cancelled package $pkgnum";
957 if ( $old->get('susp') || $self->get('susp') ) {
958 dbh->rollback if $oldAutoCommit;
959 return ""; # no error # complain on adjourn?
962 my $date = $options{date} if $options{date}; # adjourn/suspend later
963 $date = '' if ($date && $date <= time); # complain instead?
965 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
966 dbh->rollback if $oldAutoCommit;
967 return "Package $pkgnum expires before it would be suspended.";
970 my $suspend_time = $options{'time'} || time;
972 if ( $options{'reason'} ) {
973 $error = $self->insert_reason( 'reason' => $options{'reason'},
974 'action' => $date ? 'adjourn' : 'suspend',
975 'date' => $date ? $date : $suspend_time,
976 'reason_otaker' => $options{'reason_otaker'},
979 dbh->rollback if $oldAutoCommit;
980 return "Error inserting cust_pkg_reason: $error";
988 foreach my $cust_svc (
989 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
991 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
993 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
994 $dbh->rollback if $oldAutoCommit;
995 return "Illegal svcdb value in part_svc!";
998 require "FS/$svcdb.pm";
1000 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1002 $error = $svc->suspend;
1004 $dbh->rollback if $oldAutoCommit;
1007 my( $label, $value ) = $cust_svc->label;
1008 push @labels, "$label: $value";
1012 my $conf = new FS::Conf;
1013 if ( $conf->config('suspend_email_admin') ) {
1015 my $error = send_email(
1016 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1017 #invoice_from ??? well as good as any
1018 'to' => $conf->config('suspend_email_admin'),
1019 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1021 "This is an automatic message from your Freeside installation\n",
1022 "informing you that the following customer package has been suspended:\n",
1024 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1025 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1026 ( map { "Service : $_\n" } @labels ),
1031 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1039 my %hash = $self->hash;
1041 $hash{'adjourn'} = $date;
1043 $hash{'susp'} = $suspend_time;
1045 my $new = new FS::cust_pkg ( \%hash );
1046 $error = $new->replace( $self, options => { $self->options } );
1048 $dbh->rollback if $oldAutoCommit;
1052 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1057 =item unsuspend [ OPTION => VALUE ... ]
1059 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1060 package, then unsuspends the package itself (clears the susp field and the
1061 adjourn field if it is in the past).
1063 Available options are:
1067 =item adjust_next_bill
1069 Can be set true to adjust the next bill date forward by
1070 the amount of time the account was inactive. This was set true by default
1071 since 1.4.2 and 1.5.0pre6; however, starting with 1.7.0 this needs to be
1072 explicitly requested. Price plans for which this makes sense (anniversary-date
1073 based than prorate or subscription) could have an option to enable this
1078 If there is an error, returns the error, otherwise returns false.
1083 my( $self, %opt ) = @_;
1086 local $SIG{HUP} = 'IGNORE';
1087 local $SIG{INT} = 'IGNORE';
1088 local $SIG{QUIT} = 'IGNORE';
1089 local $SIG{TERM} = 'IGNORE';
1090 local $SIG{TSTP} = 'IGNORE';
1091 local $SIG{PIPE} = 'IGNORE';
1093 my $oldAutoCommit = $FS::UID::AutoCommit;
1094 local $FS::UID::AutoCommit = 0;
1097 my $old = $self->select_for_update;
1099 my $pkgnum = $old->pkgnum;
1100 if ( $old->get('cancel') || $self->get('cancel') ) {
1101 dbh->rollback if $oldAutoCommit;
1102 return "Can't unsuspend cancelled package $pkgnum";
1105 unless ( $old->get('susp') && $self->get('susp') ) {
1106 dbh->rollback if $oldAutoCommit;
1107 return ""; # no error # complain instead?
1110 foreach my $cust_svc (
1111 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1113 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1115 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1116 $dbh->rollback if $oldAutoCommit;
1117 return "Illegal svcdb value in part_svc!";
1120 require "FS/$svcdb.pm";
1122 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1124 $error = $svc->unsuspend;
1126 $dbh->rollback if $oldAutoCommit;
1133 my %hash = $self->hash;
1134 my $inactive = time - $hash{'susp'};
1136 my $conf = new FS::Conf;
1138 if ( $inactive > 0 &&
1139 ( $hash{'bill'} || $hash{'setup'} ) &&
1140 ( $opt{'adjust_next_bill'} ||
1141 $conf->exists('unsuspend-always_adjust_next_bill_date') ||
1142 $self->part_pkg->option('unsuspend_adjust_bill', 1) )
1145 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1150 $hash{'adjourn'} = '' if $hash{'adjourn'} < time;
1151 my $new = new FS::cust_pkg ( \%hash );
1152 $error = $new->replace( $self, options => { $self->options } );
1154 $dbh->rollback if $oldAutoCommit;
1158 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1165 Cancels any pending suspension (sets the adjourn field to null).
1167 If there is an error, returns the error, otherwise returns false.
1172 my( $self, %options ) = @_;
1175 local $SIG{HUP} = 'IGNORE';
1176 local $SIG{INT} = 'IGNORE';
1177 local $SIG{QUIT} = 'IGNORE';
1178 local $SIG{TERM} = 'IGNORE';
1179 local $SIG{TSTP} = 'IGNORE';
1180 local $SIG{PIPE} = 'IGNORE';
1182 my $oldAutoCommit = $FS::UID::AutoCommit;
1183 local $FS::UID::AutoCommit = 0;
1186 my $old = $self->select_for_update;
1188 my $pkgnum = $old->pkgnum;
1189 if ( $old->get('cancel') || $self->get('cancel') ) {
1190 dbh->rollback if $oldAutoCommit;
1191 return "Can't unadjourn cancelled package $pkgnum";
1192 # or at least it's pointless
1195 if ( $old->get('susp') || $self->get('susp') ) {
1196 dbh->rollback if $oldAutoCommit;
1197 return "Can't unadjourn suspended package $pkgnum";
1198 # perhaps this is arbitrary
1201 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1202 dbh->rollback if $oldAutoCommit;
1203 return ""; # no error
1206 my %hash = $self->hash;
1207 $hash{'adjourn'} = '';
1208 my $new = new FS::cust_pkg ( \%hash );
1209 $error = $new->replace( $self, options => { $self->options } );
1211 $dbh->rollback if $oldAutoCommit;
1215 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1222 =item change HASHREF | OPTION => VALUE ...
1224 Changes this package: cancels it and creates a new one, with a different
1225 pkgpart or locationnum or both. All services are transferred to the new
1226 package (no change will be made if this is not possible).
1228 Options may be passed as a list of key/value pairs or as a hash reference.
1235 New locationnum, to change the location for this package.
1239 New FS::cust_location object, to create a new location and assign it
1244 New pkgpart (see L<FS::part_pkg>).
1248 New refnum (see L<FS::part_referral>).
1252 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1253 susp, adjourn, cancel, expire, and contract_end) to the new package.
1257 At least one of locationnum, cust_location, pkgpart, refnum must be specified
1258 (otherwise, what's the point?)
1260 Returns either the new FS::cust_pkg object or a scalar error.
1264 my $err_or_new_cust_pkg = $old_cust_pkg->change
1268 #some false laziness w/order
1271 my $opt = ref($_[0]) ? shift : { @_ };
1273 # my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
1276 my $conf = new FS::Conf;
1278 # Transactionize this whole mess
1279 local $SIG{HUP} = 'IGNORE';
1280 local $SIG{INT} = 'IGNORE';
1281 local $SIG{QUIT} = 'IGNORE';
1282 local $SIG{TERM} = 'IGNORE';
1283 local $SIG{TSTP} = 'IGNORE';
1284 local $SIG{PIPE} = 'IGNORE';
1286 my $oldAutoCommit = $FS::UID::AutoCommit;
1287 local $FS::UID::AutoCommit = 0;
1296 #$hash{$_} = $self->$_() foreach qw( last_bill bill );
1298 #$hash{$_} = $self->$_() foreach qw( setup );
1300 $hash{'setup'} = $time if $self->setup;
1302 $hash{'change_date'} = $time;
1303 $hash{"change_$_"} = $self->$_()
1304 foreach qw( pkgnum pkgpart locationnum );
1306 if ( $opt->{'cust_location'} &&
1307 ( ! $opt->{'locationnum'} || $opt->{'locationnum'} == -1 ) ) {
1308 $error = $opt->{'cust_location'}->insert;
1310 $dbh->rollback if $oldAutoCommit;
1311 return "inserting cust_location (transaction rolled back): $error";
1313 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1316 my $unused_credit = 0;
1317 if ( $opt->{'keep_dates'} ) {
1318 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1319 start_date contract_end ) ) {
1320 $hash{$date} = $self->getfield($date);
1323 # Special case. If the pkgpart is changing, and the customer is
1324 # going to be credited for remaining time, don't keep setup, bill,
1325 # or last_bill dates, and DO pass the flag to cancel() to credit
1327 if ( $opt->{'pkgpart'}
1328 and $opt->{'pkgpart'} != $self->pkgpart
1329 and $self->part_pkg->option('unused_credit_change', 1) ) {
1331 $hash{$_} = '' foreach qw(setup bill last_bill);
1334 # Create the new package.
1335 my $cust_pkg = new FS::cust_pkg {
1336 custnum => $self->custnum,
1337 pkgpart => ( $opt->{'pkgpart'} || $self->pkgpart ),
1338 refnum => ( $opt->{'refnum'} || $self->refnum ),
1339 locationnum => ( $opt->{'locationnum'} || $self->locationnum ),
1343 $error = $cust_pkg->insert( 'change' => 1 );
1345 $dbh->rollback if $oldAutoCommit;
1349 # Transfer services and cancel old package.
1351 $error = $self->transfer($cust_pkg);
1352 if ($error and $error == 0) {
1353 # $old_pkg->transfer failed.
1354 $dbh->rollback if $oldAutoCommit;
1358 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
1359 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
1360 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
1361 if ($error and $error == 0) {
1362 # $old_pkg->transfer failed.
1363 $dbh->rollback if $oldAutoCommit;
1369 # Transfers were successful, but we still had services left on the old
1370 # package. We can't change the package under this circumstances, so abort.
1371 $dbh->rollback if $oldAutoCommit;
1372 return "Unable to transfer all services from package ". $self->pkgnum;
1375 #reset usage if changing pkgpart
1376 # AND usage rollover is off (otherwise adds twice, now and at package bill)
1377 if ($self->pkgpart != $cust_pkg->pkgpart) {
1378 my $part_pkg = $cust_pkg->part_pkg;
1379 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
1383 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
1386 $dbh->rollback if $oldAutoCommit;
1387 return "Error setting usage values: $error";
1391 #Good to go, cancel old package. Notify 'cancel' of whether to credit
1393 $error = $self->cancel( quiet=>1, unused_credit => $unused_credit );
1395 $dbh->rollback if $oldAutoCommit;
1399 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
1401 my $error = $cust_pkg->cust_main->bill( 'pkg_list' => [ $cust_pkg ] );
1403 $dbh->rollback if $oldAutoCommit;
1408 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1415 use Storable 'thaw';
1417 sub process_bulk_cust_pkg {
1419 my $param = thaw(decode_base64(shift));
1420 warn Dumper($param) if $DEBUG;
1422 my $old_part_pkg = qsearchs('part_pkg',
1423 { pkgpart => $param->{'old_pkgpart'} });
1424 my $new_part_pkg = qsearchs('part_pkg',
1425 { pkgpart => $param->{'new_pkgpart'} });
1426 die "Must select a new package type\n" unless $new_part_pkg;
1427 #my $keep_dates = $param->{'keep_dates'} || 0;
1428 my $keep_dates = 1; # there is no good reason to turn this off
1430 local $SIG{HUP} = 'IGNORE';
1431 local $SIG{INT} = 'IGNORE';
1432 local $SIG{QUIT} = 'IGNORE';
1433 local $SIG{TERM} = 'IGNORE';
1434 local $SIG{TSTP} = 'IGNORE';
1435 local $SIG{PIPE} = 'IGNORE';
1437 my $oldAutoCommit = $FS::UID::AutoCommit;
1438 local $FS::UID::AutoCommit = 0;
1441 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
1444 foreach my $old_cust_pkg ( @cust_pkgs ) {
1446 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
1447 if ( $old_cust_pkg->getfield('cancel') ) {
1448 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
1449 $old_cust_pkg->pkgnum."\n"
1453 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
1455 my $error = $old_cust_pkg->change(
1456 'pkgpart' => $param->{'new_pkgpart'},
1457 'keep_dates' => $keep_dates
1459 if ( !ref($error) ) { # change returns the cust_pkg on success
1461 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
1464 $dbh->commit if $oldAutoCommit;
1470 Returns the last bill date, or if there is no last bill date, the setup date.
1471 Useful for billing metered services.
1477 return $self->setfield('last_bill', $_[0]) if @_;
1478 return $self->getfield('last_bill') if $self->getfield('last_bill');
1479 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
1480 'edate' => $self->bill, } );
1481 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
1484 =item last_cust_pkg_reason ACTION
1486 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
1487 Returns false if there is no reason or the package is not currenly ACTION'd
1488 ACTION is one of adjourn, susp, cancel, or expire.
1492 sub last_cust_pkg_reason {
1493 my ( $self, $action ) = ( shift, shift );
1494 my $date = $self->get($action);
1496 'table' => 'cust_pkg_reason',
1497 'hashref' => { 'pkgnum' => $self->pkgnum,
1498 'action' => substr(uc($action), 0, 1),
1501 'order_by' => 'ORDER BY num DESC LIMIT 1',
1505 =item last_reason ACTION
1507 Returns the most recent ACTION FS::reason associated with the package.
1508 Returns false if there is no reason or the package is not currenly ACTION'd
1509 ACTION is one of adjourn, susp, cancel, or expire.
1514 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
1515 $cust_pkg_reason->reason
1516 if $cust_pkg_reason;
1521 Returns the definition for this billing item, as an FS::part_pkg object (see
1528 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
1529 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
1530 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
1535 Returns the cancelled package this package was changed from, if any.
1541 return '' unless $self->change_pkgnum;
1542 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
1547 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
1554 $self->part_pkg->calc_setup($self, @_);
1559 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
1566 $self->part_pkg->calc_recur($self, @_);
1571 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
1578 $self->part_pkg->base_recur($self, @_);
1583 Calls the I<calc_remain> of the FS::part_pkg object associated with this
1590 $self->part_pkg->calc_remain($self, @_);
1595 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
1602 $self->part_pkg->calc_cancel($self, @_);
1607 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
1613 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
1616 =item cust_pkg_detail [ DETAILTYPE ]
1618 Returns any customer package details for this package (see
1619 L<FS::cust_pkg_detail>).
1621 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1625 sub cust_pkg_detail {
1627 my %hash = ( 'pkgnum' => $self->pkgnum );
1628 $hash{detailtype} = shift if @_;
1630 'table' => 'cust_pkg_detail',
1631 'hashref' => \%hash,
1632 'order_by' => 'ORDER BY weight, pkgdetailnum',
1636 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
1638 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
1640 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1642 If there is an error, returns the error, otherwise returns false.
1646 sub set_cust_pkg_detail {
1647 my( $self, $detailtype, @details ) = @_;
1649 local $SIG{HUP} = 'IGNORE';
1650 local $SIG{INT} = 'IGNORE';
1651 local $SIG{QUIT} = 'IGNORE';
1652 local $SIG{TERM} = 'IGNORE';
1653 local $SIG{TSTP} = 'IGNORE';
1654 local $SIG{PIPE} = 'IGNORE';
1656 my $oldAutoCommit = $FS::UID::AutoCommit;
1657 local $FS::UID::AutoCommit = 0;
1660 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
1661 my $error = $current->delete;
1663 $dbh->rollback if $oldAutoCommit;
1664 return "error removing old detail: $error";
1668 foreach my $detail ( @details ) {
1669 my $cust_pkg_detail = new FS::cust_pkg_detail {
1670 'pkgnum' => $self->pkgnum,
1671 'detailtype' => $detailtype,
1672 'detail' => $detail,
1674 my $error = $cust_pkg_detail->insert;
1676 $dbh->rollback if $oldAutoCommit;
1677 return "error adding new detail: $error";
1682 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1689 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
1693 #false laziness w/cust_bill.pm
1697 'table' => 'cust_event',
1698 'addl_from' => 'JOIN part_event USING ( eventpart )',
1699 'hashref' => { 'tablenum' => $self->pkgnum },
1700 'extra_sql' => " AND eventtable = 'cust_pkg' ",
1704 =item num_cust_event
1706 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
1710 #false laziness w/cust_bill.pm
1711 sub num_cust_event {
1714 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
1715 " WHERE tablenum = ? AND eventtable = 'cust_pkg'";
1716 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
1717 $sth->execute($self->pkgnum) or die $sth->errstr. " executing $sql";
1718 $sth->fetchrow_arrayref->[0];
1721 =item cust_svc [ SVCPART ]
1723 Returns the services for this package, as FS::cust_svc objects (see
1724 L<FS::cust_svc>). If a svcpart is specified, return only the matching
1732 return () unless $self->num_cust_svc(@_);
1735 return qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum,
1736 'svcpart' => shift, } );
1739 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
1741 #if ( $self->{'_svcnum'} ) {
1742 # values %{ $self->{'_svcnum'}->cache };
1744 $self->_sort_cust_svc(
1745 [ qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } ) ]
1751 =item overlimit [ SVCPART ]
1753 Returns the services for this package which have exceeded their
1754 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
1755 is specified, return only the matching services.
1761 return () unless $self->num_cust_svc(@_);
1762 grep { $_->overlimit } $self->cust_svc(@_);
1765 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
1767 Returns historical services for this package created before END TIMESTAMP and
1768 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
1769 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
1770 I<pkg_svc.hidden> flag will be omitted.
1776 warn "$me _h_cust_svc called on $self\n"
1779 my ($end, $start, $mode) = @_;
1780 my @cust_svc = $self->_sort_cust_svc(
1781 [ qsearch( 'h_cust_svc',
1782 { 'pkgnum' => $self->pkgnum, },
1783 FS::h_cust_svc->sql_h_search(@_),
1786 if ( $mode eq 'I' ) {
1787 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
1788 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
1794 sub _sort_cust_svc {
1795 my( $self, $arrayref ) = @_;
1798 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
1803 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $self->pkgpart,
1804 'svcpart' => $_->svcpart } );
1806 $pkg_svc ? $pkg_svc->primary_svc : '',
1807 $pkg_svc ? $pkg_svc->quantity : 0,
1814 =item num_cust_svc [ SVCPART ]
1816 Returns the number of provisioned services for this package. If a svcpart is
1817 specified, counts only the matching services.
1824 return $self->{'_num_cust_svc'}
1826 && exists($self->{'_num_cust_svc'})
1827 && $self->{'_num_cust_svc'} =~ /\d/;
1829 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
1832 my $sql = 'SELECT COUNT(*) FROM cust_svc WHERE pkgnum = ?';
1833 $sql .= ' AND svcpart = ?' if @_;
1835 my $sth = dbh->prepare($sql) or die dbh->errstr;
1836 $sth->execute($self->pkgnum, @_) or die $sth->errstr;
1837 $sth->fetchrow_arrayref->[0];
1840 =item available_part_svc
1842 Returns a list of FS::part_svc objects representing services included in this
1843 package but not yet provisioned. Each FS::part_svc object also has an extra
1844 field, I<num_avail>, which specifies the number of available services.
1848 sub available_part_svc {
1850 grep { $_->num_avail > 0 }
1852 my $part_svc = $_->part_svc;
1853 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
1854 $_->quantity - $self->num_cust_svc($_->svcpart);
1856 # more evil encapsulation breakage
1857 if($part_svc->{'Hash'}{'num_avail'} > 0) {
1858 my @exports = $part_svc->part_export_did;
1859 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
1864 $self->part_pkg->pkg_svc;
1869 Returns a list of FS::part_svc objects representing provisioned and available
1870 services included in this package. Each FS::part_svc object also has the
1871 following extra fields:
1875 =item num_cust_svc (count)
1877 =item num_avail (quantity - count)
1879 =item cust_pkg_svc (services) - array reference containing the provisioned services, as cust_svc objects
1882 label -> ($cust_svc->label)[1]
1891 #XXX some sort of sort order besides numeric by svcpart...
1892 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
1894 my $part_svc = $pkg_svc->part_svc;
1895 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
1896 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
1897 $part_svc->{'Hash'}{'num_avail'} =
1898 max( 0, $pkg_svc->quantity - $num_cust_svc );
1899 $part_svc->{'Hash'}{'cust_pkg_svc'} =
1900 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
1901 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
1903 } $self->part_pkg->pkg_svc;
1906 push @part_svc, map {
1908 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
1909 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
1910 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
1911 $part_svc->{'Hash'}{'cust_pkg_svc'} =
1912 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
1914 } $self->extra_part_svc;
1920 =item extra_part_svc
1922 Returns a list of FS::part_svc objects corresponding to services in this
1923 package which are still provisioned but not (any longer) available in the
1928 sub extra_part_svc {
1931 my $pkgnum = $self->pkgnum;
1932 my $pkgpart = $self->pkgpart;
1935 # 'table' => 'part_svc',
1938 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
1939 # WHERE pkg_svc.svcpart = part_svc.svcpart
1940 # AND pkg_svc.pkgpart = ?
1943 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
1944 # LEFT JOIN cust_pkg USING ( pkgnum )
1945 # WHERE cust_svc.svcpart = part_svc.svcpart
1948 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
1951 #seems to benchmark slightly faster...
1953 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
1954 #MySQL doesn't grok DISINCT ON
1955 'select' => 'DISTINCT part_svc.*',
1956 'table' => 'part_svc',
1958 'LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
1959 AND pkg_svc.pkgpart = ?
1962 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
1963 LEFT JOIN cust_pkg USING ( pkgnum )
1966 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
1967 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
1973 Returns a short status string for this package, currently:
1977 =item not yet billed
1979 =item one-time charge
1994 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
1996 return 'cancelled' if $self->get('cancel');
1997 return 'suspended' if $self->susp;
1998 return 'not yet billed' unless $self->setup;
1999 return 'one-time charge' if $freq =~ /^(0|$)/;
2003 =item ucfirst_status
2005 Returns the status with the first character capitalized.
2009 sub ucfirst_status {
2010 ucfirst(shift->status);
2015 Class method that returns the list of possible status strings for packages
2016 (see L<the status method|/status>). For example:
2018 @statuses = FS::cust_pkg->statuses();
2022 tie my %statuscolor, 'Tie::IxHash',
2023 'not yet billed' => '009999', #teal? cyan?
2024 'one-time charge' => '000000',
2025 'active' => '00CC00',
2026 'suspended' => 'FF9900',
2027 'cancelled' => 'FF0000',
2031 my $self = shift; #could be class...
2032 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
2033 # # mayble split btw one-time vs. recur
2039 Returns a hex triplet color string for this package's status.
2045 $statuscolor{$self->status};
2050 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
2051 "pkg-comment" depending on user preference).
2057 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
2058 $label = $self->pkgnum. ": $label"
2059 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
2063 =item pkg_label_long
2065 Returns a long label for this package, adding the primary service's label to
2070 sub pkg_label_long {
2072 my $label = $self->pkg_label;
2073 my $cust_svc = $self->primary_cust_svc;
2074 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
2078 =item primary_cust_svc
2080 Returns a primary service (as FS::cust_svc object) if one can be identified.
2084 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
2086 sub primary_cust_svc {
2089 my @cust_svc = $self->cust_svc;
2091 return '' unless @cust_svc; #no serivces - irrelevant then
2093 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
2095 # primary service as specified in the package definition
2096 # or exactly one service definition with quantity one
2097 my $svcpart = $self->part_pkg->svcpart;
2098 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
2099 return $cust_svc[0] if scalar(@cust_svc) == 1;
2101 #couldn't identify one thing..
2107 Returns a list of lists, calling the label method for all services
2108 (see L<FS::cust_svc>) of this billing item.
2114 map { [ $_->label ] } $self->cust_svc;
2117 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2119 Like the labels method, but returns historical information on services that
2120 were active as of END_TIMESTAMP and (optionally) not cancelled before
2121 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
2122 I<pkg_svc.hidden> flag will be omitted.
2124 Returns a list of lists, calling the label method for all (historical) services
2125 (see L<FS::h_cust_svc>) of this billing item.
2131 warn "$me _h_labels called on $self\n"
2133 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
2138 Like labels, except returns a simple flat list, and shortens long
2139 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2140 identical services to one line that lists the service label and the number of
2141 individual services rather than individual items.
2146 shift->_labels_short( 'labels', @_ );
2149 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
2151 Like h_labels, except returns a simple flat list, and shortens long
2152 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2153 identical services to one line that lists the service label and the number of
2154 individual services rather than individual items.
2158 sub h_labels_short {
2159 shift->_labels_short( 'h_labels', @_ );
2163 my( $self, $method ) = ( shift, shift );
2165 warn "$me _labels_short called on $self with $method method\n"
2168 my $conf = new FS::Conf;
2169 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
2171 warn "$me _labels_short populating \%labels\n"
2175 #tie %labels, 'Tie::IxHash';
2176 push @{ $labels{$_->[0]} }, $_->[1]
2177 foreach $self->$method(@_);
2179 warn "$me _labels_short populating \@labels\n"
2183 foreach my $label ( keys %labels ) {
2185 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
2186 my $num = scalar(@values);
2187 warn "$me _labels_short $num items for $label\n"
2190 if ( $num > $max_same_services ) {
2191 warn "$me _labels_short more than $max_same_services, so summarizing\n"
2193 push @labels, "$label ($num)";
2195 if ( $conf->exists('cust_bill-consolidate_services') ) {
2196 warn "$me _labels_short consolidating services\n"
2198 # push @labels, "$label: ". join(', ', @values);
2200 my $detail = "$label: ";
2201 $detail .= shift(@values). ', '
2203 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
2205 push @labels, $detail;
2207 warn "$me _labels_short done consolidating services\n"
2210 warn "$me _labels_short adding service data\n"
2212 push @labels, map { "$label: $_" } @values;
2223 Returns the parent customer object (see L<FS::cust_main>).
2229 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
2232 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
2236 Returns the location object, if any (see L<FS::cust_location>).
2238 =item cust_location_or_main
2240 If this package is associated with a location, returns the locaiton (see
2241 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
2243 =item location_label [ OPTION => VALUE ... ]
2245 Returns the label of the location object (see L<FS::cust_location>).
2249 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
2251 =item seconds_since TIMESTAMP
2253 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
2254 package have been online since TIMESTAMP, according to the session monitor.
2256 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2257 L<Time::Local> and L<Date::Parse> for conversion functions.
2262 my($self, $since) = @_;
2265 foreach my $cust_svc (
2266 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
2268 $seconds += $cust_svc->seconds_since($since);
2275 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
2277 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
2278 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
2281 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2282 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2288 sub seconds_since_sqlradacct {
2289 my($self, $start, $end) = @_;
2293 foreach my $cust_svc (
2295 my $part_svc = $_->part_svc;
2296 $part_svc->svcdb eq 'svc_acct'
2297 && scalar($part_svc->part_export('sqlradius'));
2300 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
2307 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
2309 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
2310 in this package for sessions ending between TIMESTAMP_START (inclusive) and
2314 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2315 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2320 sub attribute_since_sqlradacct {
2321 my($self, $start, $end, $attrib) = @_;
2325 foreach my $cust_svc (
2327 my $part_svc = $_->part_svc;
2328 $part_svc->svcdb eq 'svc_acct'
2329 && scalar($part_svc->part_export('sqlradius'));
2332 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
2344 my( $self, $value ) = @_;
2345 if ( defined($value) ) {
2346 $self->setfield('quantity', $value);
2348 $self->getfield('quantity') || 1;
2351 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
2353 Transfers as many services as possible from this package to another package.
2355 The destination package can be specified by pkgnum by passing an FS::cust_pkg
2356 object. The destination package must already exist.
2358 Services are moved only if the destination allows services with the correct
2359 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
2360 this option with caution! No provision is made for export differences
2361 between the old and new service definitions. Probably only should be used
2362 when your exports for all service definitions of a given svcdb are identical.
2363 (attempt a transfer without it first, to move all possible svcpart-matching
2366 Any services that can't be moved remain in the original package.
2368 Returns an error, if there is one; otherwise, returns the number of services
2369 that couldn't be moved.
2374 my ($self, $dest_pkgnum, %opt) = @_;
2380 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
2381 $dest = $dest_pkgnum;
2382 $dest_pkgnum = $dest->pkgnum;
2384 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
2387 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
2389 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
2390 $target{$pkg_svc->svcpart} = $pkg_svc->quantity;
2393 foreach my $cust_svc ($dest->cust_svc) {
2394 $target{$cust_svc->svcpart}--;
2397 my %svcpart2svcparts = ();
2398 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2399 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
2400 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
2401 next if exists $svcpart2svcparts{$svcpart};
2402 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
2403 $svcpart2svcparts{$svcpart} = [
2405 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
2407 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
2408 'svcpart' => $_ } );
2410 $pkg_svc ? $pkg_svc->primary_svc : '',
2411 $pkg_svc ? $pkg_svc->quantity : 0,
2415 grep { $_ != $svcpart }
2417 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
2419 warn "alternates for svcpart $svcpart: ".
2420 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
2425 foreach my $cust_svc ($self->cust_svc) {
2426 if($target{$cust_svc->svcpart} > 0) {
2427 $target{$cust_svc->svcpart}--;
2428 my $new = new FS::cust_svc { $cust_svc->hash };
2429 $new->pkgnum($dest_pkgnum);
2430 my $error = $new->replace($cust_svc);
2431 return $error if $error;
2432 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2434 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
2435 warn "alternates to consider: ".
2436 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
2438 my @alternate = grep {
2439 warn "considering alternate svcpart $_: ".
2440 "$target{$_} available in new package\n"
2443 } @{$svcpart2svcparts{$cust_svc->svcpart}};
2445 warn "alternate(s) found\n" if $DEBUG;
2446 my $change_svcpart = $alternate[0];
2447 $target{$change_svcpart}--;
2448 my $new = new FS::cust_svc { $cust_svc->hash };
2449 $new->svcpart($change_svcpart);
2450 $new->pkgnum($dest_pkgnum);
2451 my $error = $new->replace($cust_svc);
2452 return $error if $error;
2465 This method is deprecated. See the I<depend_jobnum> option to the insert and
2466 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
2473 local $SIG{HUP} = 'IGNORE';
2474 local $SIG{INT} = 'IGNORE';
2475 local $SIG{QUIT} = 'IGNORE';
2476 local $SIG{TERM} = 'IGNORE';
2477 local $SIG{TSTP} = 'IGNORE';
2478 local $SIG{PIPE} = 'IGNORE';
2480 my $oldAutoCommit = $FS::UID::AutoCommit;
2481 local $FS::UID::AutoCommit = 0;
2484 foreach my $cust_svc ( $self->cust_svc ) {
2485 #false laziness w/svc_Common::insert
2486 my $svc_x = $cust_svc->svc_x;
2487 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
2488 my $error = $part_export->export_insert($svc_x);
2490 $dbh->rollback if $oldAutoCommit;
2496 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2503 Associates this package with a (suspension or cancellation) reason (see
2504 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
2507 Available options are:
2513 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.
2517 the access_user (see L<FS::access_user>) providing the reason
2525 the action (cancel, susp, adjourn, expire) associated with the reason
2529 If there is an error, returns the error, otherwise returns false.
2534 my ($self, %options) = @_;
2536 my $otaker = $options{reason_otaker} ||
2537 $FS::CurrentUser::CurrentUser->username;
2540 if ( $options{'reason'} =~ /^(\d+)$/ ) {
2544 } elsif ( ref($options{'reason'}) ) {
2546 return 'Enter a new reason (or select an existing one)'
2547 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
2549 my $reason = new FS::reason({
2550 'reason_type' => $options{'reason'}->{'typenum'},
2551 'reason' => $options{'reason'}->{'reason'},
2553 my $error = $reason->insert;
2554 return $error if $error;
2556 $reasonnum = $reason->reasonnum;
2559 return "Unparsable reason: ". $options{'reason'};
2562 my $cust_pkg_reason =
2563 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
2564 'reasonnum' => $reasonnum,
2565 'otaker' => $otaker,
2566 'action' => substr(uc($options{'action'}),0,1),
2567 'date' => $options{'date'}
2572 $cust_pkg_reason->insert;
2575 =item insert_discount
2577 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
2578 inserting a new discount on the fly (see L<FS::discount>).
2580 Available options are:
2588 If there is an error, returns the error, otherwise returns false.
2592 sub insert_discount {
2593 #my ($self, %options) = @_;
2596 my $cust_pkg_discount = new FS::cust_pkg_discount {
2597 'pkgnum' => $self->pkgnum,
2598 'discountnum' => $self->discountnum,
2600 'end_date' => '', #XXX
2601 #for the create a new discount case
2602 '_type' => $self->discountnum__type,
2603 'amount' => $self->discountnum_amount,
2604 'percent' => $self->discountnum_percent,
2605 'months' => $self->discountnum_months,
2606 #'disabled' => $self->discountnum_disabled,
2609 $cust_pkg_discount->insert;
2612 =item set_usage USAGE_VALUE_HASHREF
2614 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2615 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2616 upbytes, downbytes, and totalbytes are appropriate keys.
2618 All svc_accts which are part of this package have their values reset.
2623 my ($self, $valueref, %opt) = @_;
2625 foreach my $cust_svc ($self->cust_svc){
2626 my $svc_x = $cust_svc->svc_x;
2627 $svc_x->set_usage($valueref, %opt)
2628 if $svc_x->can("set_usage");
2632 =item recharge USAGE_VALUE_HASHREF
2634 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2635 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2636 upbytes, downbytes, and totalbytes are appropriate keys.
2638 All svc_accts which are part of this package have their values incremented.
2643 my ($self, $valueref) = @_;
2645 foreach my $cust_svc ($self->cust_svc){
2646 my $svc_x = $cust_svc->svc_x;
2647 $svc_x->recharge($valueref)
2648 if $svc_x->can("recharge");
2652 =item cust_pkg_discount
2656 sub cust_pkg_discount {
2658 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
2661 =item cust_pkg_discount_active
2665 sub cust_pkg_discount_active {
2667 grep { $_->status eq 'active' } $self->cust_pkg_discount;
2672 =head1 CLASS METHODS
2678 Returns an SQL expression identifying recurring packages.
2682 sub recurring_sql { "
2683 '0' != ( select freq from part_pkg
2684 where cust_pkg.pkgpart = part_pkg.pkgpart )
2689 Returns an SQL expression identifying one-time packages.
2694 '0' = ( select freq from part_pkg
2695 where cust_pkg.pkgpart = part_pkg.pkgpart )
2700 Returns an SQL expression identifying ordered packages (recurring packages not
2706 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
2711 Returns an SQL expression identifying active packages.
2716 $_[0]->recurring_sql. "
2717 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
2718 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2719 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2722 =item not_yet_billed_sql
2724 Returns an SQL expression identifying packages which have not yet been billed.
2728 sub not_yet_billed_sql { "
2729 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
2730 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2731 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2736 Returns an SQL expression identifying inactive packages (one-time packages
2737 that are otherwise unsuspended/uncancelled).
2741 sub inactive_sql { "
2742 ". $_[0]->onetime_sql(). "
2743 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
2744 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2745 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2751 Returns an SQL expression identifying suspended packages.
2755 sub suspended_sql { susp_sql(@_); }
2757 #$_[0]->recurring_sql(). ' AND '.
2759 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2760 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
2767 Returns an SQL exprression identifying cancelled packages.
2771 sub cancelled_sql { cancel_sql(@_); }
2773 #$_[0]->recurring_sql(). ' AND '.
2774 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
2779 Returns an SQL expression to give the package status as a string.
2785 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
2786 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
2787 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
2788 WHEN ".onetime_sql()." THEN 'one-time charge'
2793 =item search HASHREF
2797 Returns a qsearch hash expression to search for parameters specified in HASHREF.
2798 Valid parameters are
2806 active, inactive, suspended, cancel (or cancelled)
2810 active, inactive, suspended, one-time charge, inactive, cancel (or cancelled)
2814 boolean selects custom packages
2820 pkgpart or arrayref or hashref of pkgparts
2824 arrayref of beginning and ending epoch date
2828 arrayref of beginning and ending epoch date
2832 arrayref of beginning and ending epoch date
2836 arrayref of beginning and ending epoch date
2840 arrayref of beginning and ending epoch date
2844 arrayref of beginning and ending epoch date
2848 arrayref of beginning and ending epoch date
2852 pkgnum or APKG_pkgnum
2856 a value suited to passing to FS::UI::Web::cust_header
2860 specifies the user for agent virtualization
2864 boolean selects packages containing fcc form 477 telco lines
2871 my ($class, $params) = @_;
2878 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
2880 "cust_main.agentnum = $1";
2887 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
2889 "cust_pkg.custnum = $1";
2896 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
2898 "cust_pkg.pkgbatch = '$1'";
2905 if ( $params->{'magic'} eq 'active'
2906 || $params->{'status'} eq 'active' ) {
2908 push @where, FS::cust_pkg->active_sql();
2910 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
2911 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
2913 push @where, FS::cust_pkg->not_yet_billed_sql();
2915 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
2916 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
2918 push @where, FS::cust_pkg->inactive_sql();
2920 } elsif ( $params->{'magic'} eq 'suspended'
2921 || $params->{'status'} eq 'suspended' ) {
2923 push @where, FS::cust_pkg->suspended_sql();
2925 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
2926 || $params->{'status'} =~ /^cancell?ed$/ ) {
2928 push @where, FS::cust_pkg->cancelled_sql();
2933 # parse package class
2936 #false lazinessish w/graph/cust_bill_pkg.cgi
2939 if ( exists($params->{'classnum'})
2940 && $params->{'classnum'} =~ /^(\d*)$/
2944 if ( $classnum ) { #a specific class
2945 push @where, "part_pkg.classnum = $classnum";
2947 #@pkg_class = ( qsearchs('pkg_class', { 'classnum' => $classnum } ) );
2948 #die "classnum $classnum not found!" unless $pkg_class[0];
2949 #$title .= $pkg_class[0]->classname.' ';
2951 } elsif ( $classnum eq '' ) { #the empty class
2953 push @where, "part_pkg.classnum IS NULL";
2954 #$title .= 'Empty class ';
2955 #@pkg_class = ( '(empty class)' );
2956 } elsif ( $classnum eq '0' ) {
2957 #@pkg_class = qsearch('pkg_class', {} ); # { 'disabled' => '' } );
2958 #push @pkg_class, '(empty class)';
2960 die "illegal classnum";
2966 # parse package report options
2969 my @report_option = ();
2970 if ( exists($params->{'report_option'})
2971 && $params->{'report_option'} =~ /^([,\d]*)$/
2974 @report_option = split(',', $1);
2977 if (@report_option) {
2978 # this will result in the empty set for the dangling comma case as it should
2980 map{ "0 < ( SELECT count(*) FROM part_pkg_option
2981 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
2982 AND optionname = 'report_option_$_'
2983 AND optionvalue = '1' )"
2993 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
2999 push @where, "part_pkg.fcc_ds0s > 0" if $params->{fcc_line};
3005 if ( exists($params->{'censustract'}) ) {
3006 $params->{'censustract'} =~ /^([.\d]*)$/;
3007 my $censustract = "cust_main.censustract = '$1'";
3008 $censustract .= ' OR cust_main.censustract is NULL' unless $1;
3009 push @where, "( $censustract )";
3016 if ( ref($params->{'pkgpart'}) ) {
3019 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
3020 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
3021 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
3022 @pkgpart = @{ $params->{'pkgpart'} };
3024 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
3027 @pkgpart = grep /^(\d+)$/, @pkgpart;
3029 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
3031 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
3032 push @where, "pkgpart = $1";
3041 #false laziness w/report_cust_pkg.html
3044 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
3045 'active' => { 'susp'=>1, 'cancel'=>1 },
3046 'suspended' => { 'cancel' => 1 },
3051 if( exists($params->{'active'} ) ) {
3052 # This overrides all the other date-related fields
3053 my($beginning, $ending) = @{$params->{'active'}};
3055 "cust_pkg.setup IS NOT NULL",
3056 "cust_pkg.setup <= $ending",
3057 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
3058 "NOT (".FS::cust_pkg->onetime_sql . ")";
3061 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end cancel )) {
3063 next unless exists($params->{$field});
3065 my($beginning, $ending) = @{$params->{$field}};
3067 next if $beginning == 0 && $ending == 4294967295;
3070 "cust_pkg.$field IS NOT NULL",
3071 "cust_pkg.$field >= $beginning",
3072 "cust_pkg.$field <= $ending";
3074 $orderby ||= "ORDER BY cust_pkg.$field";
3079 $orderby ||= 'ORDER BY bill';
3082 # parse magic, legacy, etc.
3085 if ( $params->{'magic'} &&
3086 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
3089 $orderby = 'ORDER BY pkgnum';
3091 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
3092 push @where, "pkgpart = $1";
3095 } elsif ( $params->{'query'} eq 'pkgnum' ) {
3097 $orderby = 'ORDER BY pkgnum';
3099 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
3101 $orderby = 'ORDER BY pkgnum';
3104 SELECT count(*) FROM pkg_svc
3105 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
3106 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
3107 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
3108 AND cust_svc.svcpart = pkg_svc.svcpart
3115 # setup queries, links, subs, etc. for the search
3118 # here is the agent virtualization
3119 if ($params->{CurrentUser}) {
3121 qsearchs('access_user', { username => $params->{CurrentUser} });
3124 push @where, $access_user->agentnums_sql('table'=>'cust_main');
3129 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
3132 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
3134 my $addl_from = 'LEFT JOIN cust_main USING ( custnum ) '.
3135 'LEFT JOIN part_pkg USING ( pkgpart ) '.
3136 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) ';
3138 my $count_query = "SELECT COUNT(*) FROM cust_pkg $addl_from $extra_sql";
3141 'table' => 'cust_pkg',
3143 'select' => join(', ',
3145 ( map "part_pkg.$_", qw( pkg freq ) ),
3146 'pkg_class.classname',
3147 'cust_main.custnum AS cust_main_custnum',
3148 FS::UI::Web::cust_sql_fields(
3149 $params->{'cust_fields'}
3152 'extra_sql' => "$extra_sql $orderby",
3153 'addl_from' => $addl_from,
3154 'count_query' => $count_query,
3161 Returns a list of two package counts. The first is a count of packages
3162 based on the supplied criteria and the second is the count of residential
3163 packages with those same criteria. Criteria are specified as in the search
3169 my ($class, $params) = @_;
3171 my $sql_query = $class->search( $params );
3173 my $count_sql = delete($sql_query->{'count_query'});
3174 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
3175 or die "couldn't parse count_sql";
3177 my $count_sth = dbh->prepare($count_sql)
3178 or die "Error preparing $count_sql: ". dbh->errstr;
3180 or die "Error executing $count_sql: ". $count_sth->errstr;
3181 my $count_arrayref = $count_sth->fetchrow_arrayref;
3183 return ( @$count_arrayref );
3190 Returns a list: the first item is an SQL fragment identifying matching
3191 packages/customers via location (taking into account shipping and package
3192 address taxation, if enabled), and subsequent items are the parameters to
3193 substitute for the placeholders in that fragment.
3198 my($class, %opt) = @_;
3199 my $ornull = $opt{'ornull'};
3201 my $conf = new FS::Conf;
3203 # '?' placeholders in _location_sql_where
3204 my $x = $ornull ? 3 : 2;
3205 my @bill_param = ( ('city')x3, ('county')x$x, ('state')x$x, 'country' );
3209 if ( $conf->exists('tax-ship_address') ) {
3212 ( ( ship_last IS NULL OR ship_last = '' )
3213 AND ". _location_sql_where('cust_main', '', $ornull ). "
3215 OR ( ship_last IS NOT NULL AND ship_last != ''
3216 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
3219 # AND payby != 'COMP'
3221 @main_param = ( @bill_param, @bill_param );
3225 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
3226 @main_param = @bill_param;
3232 if ( $conf->exists('tax-pkg_address') ) {
3234 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
3237 ( cust_pkg.locationnum IS NULL AND $main_where )
3238 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
3241 @param = ( @main_param, @bill_param );
3245 $where = $main_where;
3246 @param = @main_param;
3254 #subroutine, helper for location_sql
3255 sub _location_sql_where {
3257 my $prefix = @_ ? shift : '';
3258 my $ornull = @_ ? shift : '';
3260 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
3262 $ornull = $ornull ? ' OR ? IS NULL ' : '';
3264 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL ) ";
3265 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL ) ";
3266 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL ) ";
3268 # ( $table.${prefix}city = ? $or_empty_city $ornull )
3270 ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS text) IS NULL )
3271 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
3272 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
3273 AND $table.${prefix}country = ?
3281 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
3283 CUSTNUM is a customer (see L<FS::cust_main>)
3285 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3286 L<FS::part_pkg>) to order for this customer. Duplicates are of course
3289 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
3290 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
3291 new billing items. An error is returned if this is not possible (see
3292 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
3295 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3296 newly-created cust_pkg objects.
3298 REFNUM, if specified, will specify the FS::pkg_referral record to be created
3299 and inserted. Multiple FS::pkg_referral records can be created by
3300 setting I<refnum> to an array reference of refnums or a hash reference with
3301 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
3302 record will be created corresponding to cust_main.refnum.
3307 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
3309 my $conf = new FS::Conf;
3311 # Transactionize this whole mess
3312 local $SIG{HUP} = 'IGNORE';
3313 local $SIG{INT} = 'IGNORE';
3314 local $SIG{QUIT} = 'IGNORE';
3315 local $SIG{TERM} = 'IGNORE';
3316 local $SIG{TSTP} = 'IGNORE';
3317 local $SIG{PIPE} = 'IGNORE';
3319 my $oldAutoCommit = $FS::UID::AutoCommit;
3320 local $FS::UID::AutoCommit = 0;
3324 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
3325 # return "Customer not found: $custnum" unless $cust_main;
3327 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
3330 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3333 my $change = scalar(@old_cust_pkg) != 0;
3336 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
3338 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
3339 " to pkgpart ". $pkgparts->[0]. "\n"
3342 my $err_or_cust_pkg =
3343 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
3344 'refnum' => $refnum,
3347 unless (ref($err_or_cust_pkg)) {
3348 $dbh->rollback if $oldAutoCommit;
3349 return $err_or_cust_pkg;
3352 push @$return_cust_pkg, $err_or_cust_pkg;
3353 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3358 # Create the new packages.
3359 foreach my $pkgpart (@$pkgparts) {
3361 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
3363 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
3364 pkgpart => $pkgpart,
3368 $error = $cust_pkg->insert( 'change' => $change );
3370 $dbh->rollback if $oldAutoCommit;
3373 push @$return_cust_pkg, $cust_pkg;
3375 # $return_cust_pkg now contains refs to all of the newly
3378 # Transfer services and cancel old packages.
3379 foreach my $old_pkg (@old_cust_pkg) {
3381 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
3384 foreach my $new_pkg (@$return_cust_pkg) {
3385 $error = $old_pkg->transfer($new_pkg);
3386 if ($error and $error == 0) {
3387 # $old_pkg->transfer failed.
3388 $dbh->rollback if $oldAutoCommit;
3393 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
3394 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
3395 foreach my $new_pkg (@$return_cust_pkg) {
3396 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
3397 if ($error and $error == 0) {
3398 # $old_pkg->transfer failed.
3399 $dbh->rollback if $oldAutoCommit;
3406 # Transfers were successful, but we went through all of the
3407 # new packages and still had services left on the old package.
3408 # We can't cancel the package under the circumstances, so abort.
3409 $dbh->rollback if $oldAutoCommit;
3410 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
3412 $error = $old_pkg->cancel( quiet=>1 );
3418 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3422 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
3424 A bulk change method to change packages for multiple customers.
3426 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3427 L<FS::part_pkg>) to order for each customer. Duplicates are of course
3430 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
3431 replace. The services (see L<FS::cust_svc>) are moved to the
3432 new billing items. An error is returned if this is not possible (see
3435 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3436 newly-created cust_pkg objects.
3441 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
3443 # Transactionize this whole mess
3444 local $SIG{HUP} = 'IGNORE';
3445 local $SIG{INT} = 'IGNORE';
3446 local $SIG{QUIT} = 'IGNORE';
3447 local $SIG{TERM} = 'IGNORE';
3448 local $SIG{TSTP} = 'IGNORE';
3449 local $SIG{PIPE} = 'IGNORE';
3451 my $oldAutoCommit = $FS::UID::AutoCommit;
3452 local $FS::UID::AutoCommit = 0;
3456 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3459 while(scalar(@old_cust_pkg)) {
3461 my $custnum = $old_cust_pkg[0]->custnum;
3462 my (@remove) = map { $_->pkgnum }
3463 grep { $_->custnum == $custnum } @old_cust_pkg;
3464 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
3466 my $error = order $custnum, $pkgparts, \@remove, \@return;
3468 push @errors, $error
3470 push @$return_cust_pkg, @return;
3473 if (scalar(@errors)) {
3474 $dbh->rollback if $oldAutoCommit;
3475 return join(' / ', @errors);
3478 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3482 # Used by FS::Upgrade to migrate to a new database.
3483 sub _upgrade_data { # class method
3484 my ($class, %opts) = @_;
3485 $class->_upgrade_otaker(%opts);
3487 # RT#10139, bug resulting in contract_end being set when it shouldn't
3488 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
3489 # RT#10830, bad calculation of prorate date near end of year
3490 # the date range for bill is December 2009, and we move it forward
3491 # one year if it's before the previous bill date (which it should
3493 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
3494 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
3495 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
3496 # RT6628, add order_date to cust_pkg
3497 'update cust_pkg set order_date = (select history_date from h_cust_pkg
3498 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
3499 history_action = \'insert\') where order_date is null',
3501 foreach my $sql (@statements) {
3502 my $sth = dbh->prepare($sql);
3503 $sth->execute or die $sth->errstr;
3511 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
3513 In sub order, the @pkgparts array (passed by reference) is clobbered.
3515 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
3516 method to pass dates to the recur_prog expression, it should do so.
3518 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
3519 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
3520 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
3521 configuration values. Probably need a subroutine which decides what to do
3522 based on whether or not we've fetched the user yet, rather than a hash. See
3523 FS::UID and the TODO.
3525 Now that things are transactional should the check in the insert method be
3530 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
3531 L<FS::pkg_svc>, schema.html from the base documentation