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' ])
598 return $error if $error;
600 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
602 if ( $self->dbdef_table->column('manual_flag') ) {
603 $self->manual_flag('') if $self->manual_flag eq ' ';
604 $self->manual_flag =~ /^([01]?)$/
605 or return "Illegal manual_flag ". $self->manual_flag;
606 $self->manual_flag($1);
619 my $error = $self->ut_numbern('pkgpart');
620 return $error if $error;
622 if ( $self->reg_code ) {
624 unless ( grep { $self->pkgpart == $_->pkgpart }
625 map { $_->reg_code_pkg }
626 qsearchs( 'reg_code', { 'code' => $self->reg_code,
627 'agentnum' => $self->cust_main->agentnum })
629 return "Unknown registration code";
632 } elsif ( $self->promo_code ) {
635 qsearchs('part_pkg', {
636 'pkgpart' => $self->pkgpart,
637 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
639 return 'Unknown promotional code' unless $promo_part_pkg;
643 unless ( $disable_agentcheck ) {
645 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
646 return "agent ". $agent->agentnum. ':'. $agent->agent.
647 " can't purchase pkgpart ". $self->pkgpart
648 unless $agent->pkgpart_hashref->{ $self->pkgpart }
649 || $agent->agentnum == $self->part_pkg->agentnum;
652 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
653 return $error if $error;
661 =item cancel [ OPTION => VALUE ... ]
663 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
664 in this package, then cancels the package itself (sets the cancel field to
667 Available options are:
671 =item quiet - can be set true to supress email cancellation notices.
673 =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.
675 =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.
677 =item date - can be set to a unix style timestamp to specify when to cancel (expire)
679 =item nobill - can be set true to skip billing if it might otherwise be done.
681 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
682 not credit it. This must be set (by change()) when changing the package
683 to a different pkgpart or location, and probably shouldn't be in any other
684 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
689 If there is an error, returns the error, otherwise returns false.
694 my( $self, %options ) = @_;
697 my $conf = new FS::Conf;
699 warn "cust_pkg::cancel called with options".
700 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
703 local $SIG{HUP} = 'IGNORE';
704 local $SIG{INT} = 'IGNORE';
705 local $SIG{QUIT} = 'IGNORE';
706 local $SIG{TERM} = 'IGNORE';
707 local $SIG{TSTP} = 'IGNORE';
708 local $SIG{PIPE} = 'IGNORE';
710 my $oldAutoCommit = $FS::UID::AutoCommit;
711 local $FS::UID::AutoCommit = 0;
714 my $old = $self->select_for_update;
716 if ( $old->get('cancel') || $self->get('cancel') ) {
717 dbh->rollback if $oldAutoCommit;
718 return ""; # no error
721 my $date = $options{date} if $options{date}; # expire/cancel later
722 $date = '' if ($date && $date <= time); # complain instead?
724 #race condition: usage could be ongoing until unprovisioned
725 #resolved by performing a change package instead (which unprovisions) and
727 if ( !$options{nobill} && !$date && $conf->exists('bill_usage_on_cancel') ) {
728 my $copy = $self->new({$self->hash});
730 $copy->cust_main->bill( pkg_list => [ $copy ], cancel => 1 );
731 warn "Error billing during cancel, custnum ".
732 #$self->cust_main->custnum. ": $error"
737 my $cancel_time = $options{'time'} || time;
739 if ( $options{'reason'} ) {
740 $error = $self->insert_reason( 'reason' => $options{'reason'},
741 'action' => $date ? 'expire' : 'cancel',
742 'date' => $date ? $date : $cancel_time,
743 'reason_otaker' => $options{'reason_otaker'},
746 dbh->rollback if $oldAutoCommit;
747 return "Error inserting cust_pkg_reason: $error";
753 foreach my $cust_svc (
756 sort { $a->[1] <=> $b->[1] }
757 map { [ $_, $_->svc_x->table_info->{'cancel_weight'} ]; }
758 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
760 my $error = $cust_svc->cancel;
763 $dbh->rollback if $oldAutoCommit;
764 return "Error cancelling cust_svc: $error";
768 # Add a credit for remaining service
769 my $last_bill = $self->getfield('last_bill') || 0;
770 my $next_bill = $self->getfield('bill') || 0;
772 if ( exists($options{'unused_credit'}) ) {
773 $do_credit = $options{'unused_credit'};
776 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
779 and $last_bill > 0 # the package has been billed
780 and $next_bill > 0 # the package has a next bill date
781 and $next_bill >= $cancel_time # which is in the future
783 my $remaining_value = $self->calc_remain('time' => $cancel_time);
784 if ( $remaining_value > 0 ) {
785 my $error = $self->cust_main->credit(
787 'Credit for unused time on '. $self->part_pkg->pkg,
788 'reason_type' => $conf->config('cancel_credit_type'),
791 $dbh->rollback if $oldAutoCommit;
792 return "Error crediting customer \$$remaining_value for unused time".
793 " on ". $self->part_pkg->pkg. ": $error";
795 } #if $remaining_value
800 my %hash = $self->hash;
801 $date ? ($hash{'expire'} = $date) : ($hash{'cancel'} = $cancel_time);
802 my $new = new FS::cust_pkg ( \%hash );
803 $error = $new->replace( $self, options => { $self->options } );
805 $dbh->rollback if $oldAutoCommit;
809 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
810 return '' if $date; #no errors
812 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
813 if ( !$options{'quiet'} &&
814 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
816 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
819 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
820 $error = $msg_template->send( 'cust_main' => $self->cust_main,
825 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
826 'to' => \@invoicing_list,
827 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
828 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
831 #should this do something on errors?
838 =item cancel_if_expired [ NOW_TIMESTAMP ]
840 Cancels this package if its expire date has been reached.
844 sub cancel_if_expired {
846 my $time = shift || time;
847 return '' unless $self->expire && $self->expire <= $time;
848 my $error = $self->cancel;
850 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
851 $self->custnum. ": $error";
858 Cancels any pending expiration (sets the expire field to null).
860 If there is an error, returns the error, otherwise returns false.
865 my( $self, %options ) = @_;
868 local $SIG{HUP} = 'IGNORE';
869 local $SIG{INT} = 'IGNORE';
870 local $SIG{QUIT} = 'IGNORE';
871 local $SIG{TERM} = 'IGNORE';
872 local $SIG{TSTP} = 'IGNORE';
873 local $SIG{PIPE} = 'IGNORE';
875 my $oldAutoCommit = $FS::UID::AutoCommit;
876 local $FS::UID::AutoCommit = 0;
879 my $old = $self->select_for_update;
881 my $pkgnum = $old->pkgnum;
882 if ( $old->get('cancel') || $self->get('cancel') ) {
883 dbh->rollback if $oldAutoCommit;
884 return "Can't unexpire cancelled package $pkgnum";
885 # or at least it's pointless
888 unless ( $old->get('expire') && $self->get('expire') ) {
889 dbh->rollback if $oldAutoCommit;
890 return ""; # no error
893 my %hash = $self->hash;
894 $hash{'expire'} = '';
895 my $new = new FS::cust_pkg ( \%hash );
896 $error = $new->replace( $self, options => { $self->options } );
898 $dbh->rollback if $oldAutoCommit;
902 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
908 =item suspend [ OPTION => VALUE ... ]
910 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
911 package, then suspends the package itself (sets the susp field to now).
913 Available options are:
917 =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.
919 =item date - can be set to a unix style timestamp to specify when to suspend (adjourn)
923 If there is an error, returns the error, otherwise returns false.
928 my( $self, %options ) = @_;
931 local $SIG{HUP} = 'IGNORE';
932 local $SIG{INT} = 'IGNORE';
933 local $SIG{QUIT} = 'IGNORE';
934 local $SIG{TERM} = 'IGNORE';
935 local $SIG{TSTP} = 'IGNORE';
936 local $SIG{PIPE} = 'IGNORE';
938 my $oldAutoCommit = $FS::UID::AutoCommit;
939 local $FS::UID::AutoCommit = 0;
942 my $old = $self->select_for_update;
944 my $pkgnum = $old->pkgnum;
945 if ( $old->get('cancel') || $self->get('cancel') ) {
946 dbh->rollback if $oldAutoCommit;
947 return "Can't suspend cancelled package $pkgnum";
950 if ( $old->get('susp') || $self->get('susp') ) {
951 dbh->rollback if $oldAutoCommit;
952 return ""; # no error # complain on adjourn?
955 my $date = $options{date} if $options{date}; # adjourn/suspend later
956 $date = '' if ($date && $date <= time); # complain instead?
958 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
959 dbh->rollback if $oldAutoCommit;
960 return "Package $pkgnum expires before it would be suspended.";
963 my $suspend_time = $options{'time'} || time;
965 if ( $options{'reason'} ) {
966 $error = $self->insert_reason( 'reason' => $options{'reason'},
967 'action' => $date ? 'adjourn' : 'suspend',
968 'date' => $date ? $date : $suspend_time,
969 'reason_otaker' => $options{'reason_otaker'},
972 dbh->rollback if $oldAutoCommit;
973 return "Error inserting cust_pkg_reason: $error";
981 foreach my $cust_svc (
982 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
984 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
986 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
987 $dbh->rollback if $oldAutoCommit;
988 return "Illegal svcdb value in part_svc!";
991 require "FS/$svcdb.pm";
993 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
995 $error = $svc->suspend;
997 $dbh->rollback if $oldAutoCommit;
1000 my( $label, $value ) = $cust_svc->label;
1001 push @labels, "$label: $value";
1005 my $conf = new FS::Conf;
1006 if ( $conf->config('suspend_email_admin') ) {
1008 my $error = send_email(
1009 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1010 #invoice_from ??? well as good as any
1011 'to' => $conf->config('suspend_email_admin'),
1012 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1014 "This is an automatic message from your Freeside installation\n",
1015 "informing you that the following customer package has been suspended:\n",
1017 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1018 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1019 ( map { "Service : $_\n" } @labels ),
1024 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1032 my %hash = $self->hash;
1034 $hash{'adjourn'} = $date;
1036 $hash{'susp'} = $suspend_time;
1038 my $new = new FS::cust_pkg ( \%hash );
1039 $error = $new->replace( $self, options => { $self->options } );
1041 $dbh->rollback if $oldAutoCommit;
1045 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1050 =item unsuspend [ OPTION => VALUE ... ]
1052 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1053 package, then unsuspends the package itself (clears the susp field and the
1054 adjourn field if it is in the past).
1056 Available options are:
1060 =item adjust_next_bill
1062 Can be set true to adjust the next bill date forward by
1063 the amount of time the account was inactive. This was set true by default
1064 since 1.4.2 and 1.5.0pre6; however, starting with 1.7.0 this needs to be
1065 explicitly requested. Price plans for which this makes sense (anniversary-date
1066 based than prorate or subscription) could have an option to enable this
1071 If there is an error, returns the error, otherwise returns false.
1076 my( $self, %opt ) = @_;
1079 local $SIG{HUP} = 'IGNORE';
1080 local $SIG{INT} = 'IGNORE';
1081 local $SIG{QUIT} = 'IGNORE';
1082 local $SIG{TERM} = 'IGNORE';
1083 local $SIG{TSTP} = 'IGNORE';
1084 local $SIG{PIPE} = 'IGNORE';
1086 my $oldAutoCommit = $FS::UID::AutoCommit;
1087 local $FS::UID::AutoCommit = 0;
1090 my $old = $self->select_for_update;
1092 my $pkgnum = $old->pkgnum;
1093 if ( $old->get('cancel') || $self->get('cancel') ) {
1094 dbh->rollback if $oldAutoCommit;
1095 return "Can't unsuspend cancelled package $pkgnum";
1098 unless ( $old->get('susp') && $self->get('susp') ) {
1099 dbh->rollback if $oldAutoCommit;
1100 return ""; # no error # complain instead?
1103 foreach my $cust_svc (
1104 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1106 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1108 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1109 $dbh->rollback if $oldAutoCommit;
1110 return "Illegal svcdb value in part_svc!";
1113 require "FS/$svcdb.pm";
1115 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1117 $error = $svc->unsuspend;
1119 $dbh->rollback if $oldAutoCommit;
1126 my %hash = $self->hash;
1127 my $inactive = time - $hash{'susp'};
1129 my $conf = new FS::Conf;
1131 if ( $inactive > 0 &&
1132 ( $hash{'bill'} || $hash{'setup'} ) &&
1133 ( $opt{'adjust_next_bill'} ||
1134 $conf->exists('unsuspend-always_adjust_next_bill_date') ||
1135 $self->part_pkg->option('unsuspend_adjust_bill', 1) )
1138 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1143 $hash{'adjourn'} = '' if $hash{'adjourn'} < time;
1144 my $new = new FS::cust_pkg ( \%hash );
1145 $error = $new->replace( $self, options => { $self->options } );
1147 $dbh->rollback if $oldAutoCommit;
1151 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1158 Cancels any pending suspension (sets the adjourn field to null).
1160 If there is an error, returns the error, otherwise returns false.
1165 my( $self, %options ) = @_;
1168 local $SIG{HUP} = 'IGNORE';
1169 local $SIG{INT} = 'IGNORE';
1170 local $SIG{QUIT} = 'IGNORE';
1171 local $SIG{TERM} = 'IGNORE';
1172 local $SIG{TSTP} = 'IGNORE';
1173 local $SIG{PIPE} = 'IGNORE';
1175 my $oldAutoCommit = $FS::UID::AutoCommit;
1176 local $FS::UID::AutoCommit = 0;
1179 my $old = $self->select_for_update;
1181 my $pkgnum = $old->pkgnum;
1182 if ( $old->get('cancel') || $self->get('cancel') ) {
1183 dbh->rollback if $oldAutoCommit;
1184 return "Can't unadjourn cancelled package $pkgnum";
1185 # or at least it's pointless
1188 if ( $old->get('susp') || $self->get('susp') ) {
1189 dbh->rollback if $oldAutoCommit;
1190 return "Can't unadjourn suspended package $pkgnum";
1191 # perhaps this is arbitrary
1194 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1195 dbh->rollback if $oldAutoCommit;
1196 return ""; # no error
1199 my %hash = $self->hash;
1200 $hash{'adjourn'} = '';
1201 my $new = new FS::cust_pkg ( \%hash );
1202 $error = $new->replace( $self, options => { $self->options } );
1204 $dbh->rollback if $oldAutoCommit;
1208 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1215 =item change HASHREF | OPTION => VALUE ...
1217 Changes this package: cancels it and creates a new one, with a different
1218 pkgpart or locationnum or both. All services are transferred to the new
1219 package (no change will be made if this is not possible).
1221 Options may be passed as a list of key/value pairs or as a hash reference.
1228 New locationnum, to change the location for this package.
1232 New FS::cust_location object, to create a new location and assign it
1237 New pkgpart (see L<FS::part_pkg>).
1241 New refnum (see L<FS::part_referral>).
1245 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1246 susp, adjourn, cancel, expire, and contract_end) to the new package.
1250 At least one of locationnum, cust_location, pkgpart, refnum must be specified
1251 (otherwise, what's the point?)
1253 Returns either the new FS::cust_pkg object or a scalar error.
1257 my $err_or_new_cust_pkg = $old_cust_pkg->change
1261 #some false laziness w/order
1264 my $opt = ref($_[0]) ? shift : { @_ };
1266 # my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
1269 my $conf = new FS::Conf;
1271 # Transactionize this whole mess
1272 local $SIG{HUP} = 'IGNORE';
1273 local $SIG{INT} = 'IGNORE';
1274 local $SIG{QUIT} = 'IGNORE';
1275 local $SIG{TERM} = 'IGNORE';
1276 local $SIG{TSTP} = 'IGNORE';
1277 local $SIG{PIPE} = 'IGNORE';
1279 my $oldAutoCommit = $FS::UID::AutoCommit;
1280 local $FS::UID::AutoCommit = 0;
1289 #$hash{$_} = $self->$_() foreach qw( last_bill bill );
1291 #$hash{$_} = $self->$_() foreach qw( setup );
1293 $hash{'setup'} = $time if $self->setup;
1295 $hash{'change_date'} = $time;
1296 $hash{"change_$_"} = $self->$_()
1297 foreach qw( pkgnum pkgpart locationnum );
1299 if ( $opt->{'cust_location'} &&
1300 ( ! $opt->{'locationnum'} || $opt->{'locationnum'} == -1 ) ) {
1301 $error = $opt->{'cust_location'}->insert;
1303 $dbh->rollback if $oldAutoCommit;
1304 return "inserting cust_location (transaction rolled back): $error";
1306 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1309 my $unused_credit = 0;
1310 if ( $opt->{'keep_dates'} ) {
1311 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1312 start_date contract_end ) ) {
1313 $hash{$date} = $self->getfield($date);
1316 # Special case. If the pkgpart is changing, and the customer is
1317 # going to be credited for remaining time, don't keep setup, bill,
1318 # or last_bill dates, and DO pass the flag to cancel() to credit
1320 if ( $opt->{'pkgpart'}
1321 and $opt->{'pkgpart'} != $self->pkgpart
1322 and $self->part_pkg->option('unused_credit_change', 1) ) {
1324 $hash{$_} = '' foreach qw(setup bill last_bill);
1327 # Create the new package.
1328 my $cust_pkg = new FS::cust_pkg {
1329 custnum => $self->custnum,
1330 pkgpart => ( $opt->{'pkgpart'} || $self->pkgpart ),
1331 refnum => ( $opt->{'refnum'} || $self->refnum ),
1332 locationnum => ( $opt->{'locationnum'} || $self->locationnum ),
1336 $error = $cust_pkg->insert( 'change' => 1 );
1338 $dbh->rollback if $oldAutoCommit;
1342 # Transfer services and cancel old package.
1344 $error = $self->transfer($cust_pkg);
1345 if ($error and $error == 0) {
1346 # $old_pkg->transfer failed.
1347 $dbh->rollback if $oldAutoCommit;
1351 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
1352 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
1353 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
1354 if ($error and $error == 0) {
1355 # $old_pkg->transfer failed.
1356 $dbh->rollback if $oldAutoCommit;
1362 # Transfers were successful, but we still had services left on the old
1363 # package. We can't change the package under this circumstances, so abort.
1364 $dbh->rollback if $oldAutoCommit;
1365 return "Unable to transfer all services from package ". $self->pkgnum;
1368 #reset usage if changing pkgpart
1369 # AND usage rollover is off (otherwise adds twice, now and at package bill)
1370 if ($self->pkgpart != $cust_pkg->pkgpart) {
1371 my $part_pkg = $cust_pkg->part_pkg;
1372 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
1376 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
1379 $dbh->rollback if $oldAutoCommit;
1380 return "Error setting usage values: $error";
1384 #Good to go, cancel old package. Notify 'cancel' of whether to credit
1386 $error = $self->cancel( quiet=>1, unused_credit => $unused_credit );
1388 $dbh->rollback if $oldAutoCommit;
1392 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
1394 my $error = $cust_pkg->cust_main->bill( 'pkg_list' => [ $cust_pkg ] );
1396 $dbh->rollback if $oldAutoCommit;
1401 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1408 use Storable 'thaw';
1410 sub process_bulk_cust_pkg {
1412 my $param = thaw(decode_base64(shift));
1413 warn Dumper($param) if $DEBUG;
1415 my $old_part_pkg = qsearchs('part_pkg',
1416 { pkgpart => $param->{'old_pkgpart'} });
1417 my $new_part_pkg = qsearchs('part_pkg',
1418 { pkgpart => $param->{'new_pkgpart'} });
1419 die "Must select a new package type\n" unless $new_part_pkg;
1420 #my $keep_dates = $param->{'keep_dates'} || 0;
1421 my $keep_dates = 1; # there is no good reason to turn this off
1423 local $SIG{HUP} = 'IGNORE';
1424 local $SIG{INT} = 'IGNORE';
1425 local $SIG{QUIT} = 'IGNORE';
1426 local $SIG{TERM} = 'IGNORE';
1427 local $SIG{TSTP} = 'IGNORE';
1428 local $SIG{PIPE} = 'IGNORE';
1430 my $oldAutoCommit = $FS::UID::AutoCommit;
1431 local $FS::UID::AutoCommit = 0;
1434 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
1437 foreach my $old_cust_pkg ( @cust_pkgs ) {
1439 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
1440 if ( $old_cust_pkg->getfield('cancel') ) {
1441 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
1442 $old_cust_pkg->pkgnum."\n"
1446 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
1448 my $error = $old_cust_pkg->change(
1449 'pkgpart' => $param->{'new_pkgpart'},
1450 'keep_dates' => $keep_dates
1452 if ( !ref($error) ) { # change returns the cust_pkg on success
1454 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
1457 $dbh->commit if $oldAutoCommit;
1463 Returns the last bill date, or if there is no last bill date, the setup date.
1464 Useful for billing metered services.
1470 return $self->setfield('last_bill', $_[0]) if @_;
1471 return $self->getfield('last_bill') if $self->getfield('last_bill');
1472 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
1473 'edate' => $self->bill, } );
1474 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
1477 =item last_cust_pkg_reason ACTION
1479 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
1480 Returns false if there is no reason or the package is not currenly ACTION'd
1481 ACTION is one of adjourn, susp, cancel, or expire.
1485 sub last_cust_pkg_reason {
1486 my ( $self, $action ) = ( shift, shift );
1487 my $date = $self->get($action);
1489 'table' => 'cust_pkg_reason',
1490 'hashref' => { 'pkgnum' => $self->pkgnum,
1491 'action' => substr(uc($action), 0, 1),
1494 'order_by' => 'ORDER BY num DESC LIMIT 1',
1498 =item last_reason ACTION
1500 Returns the most recent ACTION FS::reason associated with the package.
1501 Returns false if there is no reason or the package is not currenly ACTION'd
1502 ACTION is one of adjourn, susp, cancel, or expire.
1507 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
1508 $cust_pkg_reason->reason
1509 if $cust_pkg_reason;
1514 Returns the definition for this billing item, as an FS::part_pkg object (see
1521 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
1522 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
1523 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
1528 Returns the cancelled package this package was changed from, if any.
1534 return '' unless $self->change_pkgnum;
1535 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
1540 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
1547 $self->part_pkg->calc_setup($self, @_);
1552 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
1559 $self->part_pkg->calc_recur($self, @_);
1564 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
1571 $self->part_pkg->base_recur($self, @_);
1576 Calls the I<calc_remain> of the FS::part_pkg object associated with this
1583 $self->part_pkg->calc_remain($self, @_);
1588 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
1595 $self->part_pkg->calc_cancel($self, @_);
1600 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
1606 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
1609 =item cust_pkg_detail [ DETAILTYPE ]
1611 Returns any customer package details for this package (see
1612 L<FS::cust_pkg_detail>).
1614 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1618 sub cust_pkg_detail {
1620 my %hash = ( 'pkgnum' => $self->pkgnum );
1621 $hash{detailtype} = shift if @_;
1623 'table' => 'cust_pkg_detail',
1624 'hashref' => \%hash,
1625 'order_by' => 'ORDER BY weight, pkgdetailnum',
1629 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
1631 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
1633 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1635 If there is an error, returns the error, otherwise returns false.
1639 sub set_cust_pkg_detail {
1640 my( $self, $detailtype, @details ) = @_;
1642 local $SIG{HUP} = 'IGNORE';
1643 local $SIG{INT} = 'IGNORE';
1644 local $SIG{QUIT} = 'IGNORE';
1645 local $SIG{TERM} = 'IGNORE';
1646 local $SIG{TSTP} = 'IGNORE';
1647 local $SIG{PIPE} = 'IGNORE';
1649 my $oldAutoCommit = $FS::UID::AutoCommit;
1650 local $FS::UID::AutoCommit = 0;
1653 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
1654 my $error = $current->delete;
1656 $dbh->rollback if $oldAutoCommit;
1657 return "error removing old detail: $error";
1661 foreach my $detail ( @details ) {
1662 my $cust_pkg_detail = new FS::cust_pkg_detail {
1663 'pkgnum' => $self->pkgnum,
1664 'detailtype' => $detailtype,
1665 'detail' => $detail,
1667 my $error = $cust_pkg_detail->insert;
1669 $dbh->rollback if $oldAutoCommit;
1670 return "error adding new detail: $error";
1675 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1682 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
1686 #false laziness w/cust_bill.pm
1690 'table' => 'cust_event',
1691 'addl_from' => 'JOIN part_event USING ( eventpart )',
1692 'hashref' => { 'tablenum' => $self->pkgnum },
1693 'extra_sql' => " AND eventtable = 'cust_pkg' ",
1697 =item num_cust_event
1699 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
1703 #false laziness w/cust_bill.pm
1704 sub num_cust_event {
1707 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
1708 " WHERE tablenum = ? AND eventtable = 'cust_pkg'";
1709 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
1710 $sth->execute($self->pkgnum) or die $sth->errstr. " executing $sql";
1711 $sth->fetchrow_arrayref->[0];
1714 =item cust_svc [ SVCPART ]
1716 Returns the services for this package, as FS::cust_svc objects (see
1717 L<FS::cust_svc>). If a svcpart is specified, return only the matching
1725 return () unless $self->num_cust_svc(@_);
1728 return qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum,
1729 'svcpart' => shift, } );
1732 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
1734 #if ( $self->{'_svcnum'} ) {
1735 # values %{ $self->{'_svcnum'}->cache };
1737 $self->_sort_cust_svc(
1738 [ qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } ) ]
1744 =item overlimit [ SVCPART ]
1746 Returns the services for this package which have exceeded their
1747 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
1748 is specified, return only the matching services.
1754 return () unless $self->num_cust_svc(@_);
1755 grep { $_->overlimit } $self->cust_svc(@_);
1758 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
1760 Returns historical services for this package created before END TIMESTAMP and
1761 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
1762 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
1763 I<pkg_svc.hidden> flag will be omitted.
1769 my ($end, $start, $mode) = @_;
1770 my @cust_svc = $self->_sort_cust_svc(
1771 [ qsearch( 'h_cust_svc',
1772 { 'pkgnum' => $self->pkgnum, },
1773 FS::h_cust_svc->sql_h_search(@_),
1776 if ( $mode eq 'I' ) {
1777 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
1778 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
1785 sub _sort_cust_svc {
1786 my( $self, $arrayref ) = @_;
1789 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
1794 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $self->pkgpart,
1795 'svcpart' => $_->svcpart } );
1797 $pkg_svc ? $pkg_svc->primary_svc : '',
1798 $pkg_svc ? $pkg_svc->quantity : 0,
1805 =item num_cust_svc [ SVCPART ]
1807 Returns the number of provisioned services for this package. If a svcpart is
1808 specified, counts only the matching services.
1815 return $self->{'_num_cust_svc'}
1817 && exists($self->{'_num_cust_svc'})
1818 && $self->{'_num_cust_svc'} =~ /\d/;
1820 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
1823 my $sql = 'SELECT COUNT(*) FROM cust_svc WHERE pkgnum = ?';
1824 $sql .= ' AND svcpart = ?' if @_;
1826 my $sth = dbh->prepare($sql) or die dbh->errstr;
1827 $sth->execute($self->pkgnum, @_) or die $sth->errstr;
1828 $sth->fetchrow_arrayref->[0];
1831 =item available_part_svc
1833 Returns a list of FS::part_svc objects representing services included in this
1834 package but not yet provisioned. Each FS::part_svc object also has an extra
1835 field, I<num_avail>, which specifies the number of available services.
1839 sub available_part_svc {
1841 grep { $_->num_avail > 0 }
1843 my $part_svc = $_->part_svc;
1844 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
1845 $_->quantity - $self->num_cust_svc($_->svcpart);
1847 # more evil encapsulation breakage
1848 if($part_svc->{'Hash'}{'num_avail'} > 0) {
1849 my @exports = $part_svc->part_export_did;
1850 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
1855 $self->part_pkg->pkg_svc;
1860 Returns a list of FS::part_svc objects representing provisioned and available
1861 services included in this package. Each FS::part_svc object also has the
1862 following extra fields:
1866 =item num_cust_svc (count)
1868 =item num_avail (quantity - count)
1870 =item cust_pkg_svc (services) - array reference containing the provisioned services, as cust_svc objects
1873 label -> ($cust_svc->label)[1]
1882 #XXX some sort of sort order besides numeric by svcpart...
1883 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
1885 my $part_svc = $pkg_svc->part_svc;
1886 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
1887 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
1888 $part_svc->{'Hash'}{'num_avail'} =
1889 max( 0, $pkg_svc->quantity - $num_cust_svc );
1890 $part_svc->{'Hash'}{'cust_pkg_svc'} =
1891 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
1892 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
1894 } $self->part_pkg->pkg_svc;
1897 push @part_svc, map {
1899 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
1900 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
1901 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
1902 $part_svc->{'Hash'}{'cust_pkg_svc'} =
1903 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
1905 } $self->extra_part_svc;
1911 =item extra_part_svc
1913 Returns a list of FS::part_svc objects corresponding to services in this
1914 package which are still provisioned but not (any longer) available in the
1919 sub extra_part_svc {
1922 my $pkgnum = $self->pkgnum;
1923 my $pkgpart = $self->pkgpart;
1926 # 'table' => 'part_svc',
1929 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
1930 # WHERE pkg_svc.svcpart = part_svc.svcpart
1931 # AND pkg_svc.pkgpart = ?
1934 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
1935 # LEFT JOIN cust_pkg USING ( pkgnum )
1936 # WHERE cust_svc.svcpart = part_svc.svcpart
1939 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
1942 #seems to benchmark slightly faster...
1944 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
1945 #MySQL doesn't grok DISINCT ON
1946 'select' => 'DISTINCT part_svc.*',
1947 'table' => 'part_svc',
1949 'LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
1950 AND pkg_svc.pkgpart = ?
1953 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
1954 LEFT JOIN cust_pkg USING ( pkgnum )
1957 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
1958 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
1964 Returns a short status string for this package, currently:
1968 =item not yet billed
1970 =item one-time charge
1985 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
1987 return 'cancelled' if $self->get('cancel');
1988 return 'suspended' if $self->susp;
1989 return 'not yet billed' unless $self->setup;
1990 return 'one-time charge' if $freq =~ /^(0|$)/;
1994 =item ucfirst_status
1996 Returns the status with the first character capitalized.
2000 sub ucfirst_status {
2001 ucfirst(shift->status);
2006 Class method that returns the list of possible status strings for packages
2007 (see L<the status method|/status>). For example:
2009 @statuses = FS::cust_pkg->statuses();
2013 tie my %statuscolor, 'Tie::IxHash',
2014 'not yet billed' => '009999', #teal? cyan?
2015 'one-time charge' => '000000',
2016 'active' => '00CC00',
2017 'suspended' => 'FF9900',
2018 'cancelled' => 'FF0000',
2022 my $self = shift; #could be class...
2023 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
2024 # # mayble split btw one-time vs. recur
2030 Returns a hex triplet color string for this package's status.
2036 $statuscolor{$self->status};
2041 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
2042 "pkg-comment" depending on user preference).
2048 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
2049 $label = $self->pkgnum. ": $label"
2050 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
2054 =item pkg_label_long
2056 Returns a long label for this package, adding the primary service's label to
2061 sub pkg_label_long {
2063 my $label = $self->pkg_label;
2064 my $cust_svc = $self->primary_cust_svc;
2065 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
2069 =item primary_cust_svc
2071 Returns a primary service (as FS::cust_svc object) if one can be identified.
2075 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
2077 sub primary_cust_svc {
2080 my @cust_svc = $self->cust_svc;
2082 return '' unless @cust_svc; #no serivces - irrelevant then
2084 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
2086 # primary service as specified in the package definition
2087 # or exactly one service definition with quantity one
2088 my $svcpart = $self->part_pkg->svcpart;
2089 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
2090 return $cust_svc[0] if scalar(@cust_svc) == 1;
2092 #couldn't identify one thing..
2098 Returns a list of lists, calling the label method for all services
2099 (see L<FS::cust_svc>) of this billing item.
2105 map { [ $_->label ] } $self->cust_svc;
2108 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2110 Like the labels method, but returns historical information on services that
2111 were active as of END_TIMESTAMP and (optionally) not cancelled before
2112 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
2113 I<pkg_svc.hidden> flag will be omitted.
2115 Returns a list of lists, calling the label method for all (historical) services
2116 (see L<FS::h_cust_svc>) of this billing item.
2122 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
2127 Like labels, except returns a simple flat list, and shortens long
2128 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2129 identical services to one line that lists the service label and the number of
2130 individual services rather than individual items.
2135 shift->_labels_short( 'labels', @_ );
2138 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
2140 Like h_labels, except returns a simple flat list, and shortens long
2141 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2142 identical services to one line that lists the service label and the number of
2143 individual services rather than individual items.
2147 sub h_labels_short {
2148 shift->_labels_short( 'h_labels', @_ );
2152 my( $self, $method ) = ( shift, shift );
2154 my $conf = new FS::Conf;
2155 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
2158 #tie %labels, 'Tie::IxHash';
2159 push @{ $labels{$_->[0]} }, $_->[1]
2160 foreach $self->$method(@_);
2162 foreach my $label ( keys %labels ) {
2164 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
2165 my $num = scalar(@values);
2166 if ( $num > $max_same_services ) {
2167 push @labels, "$label ($num)";
2169 if ( $conf->exists('cust_bill-consolidate_services') ) {
2170 # push @labels, "$label: ". join(', ', @values);
2172 my $detail = "$label: ";
2173 $detail .= shift(@values). ', '
2174 while @values && length($detail.$values[0]) < 78;
2176 push @labels, $detail;
2179 push @labels, map { "$label: $_" } @values;
2190 Returns the parent customer object (see L<FS::cust_main>).
2196 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
2199 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
2203 Returns the location object, if any (see L<FS::cust_location>).
2205 =item cust_location_or_main
2207 If this package is associated with a location, returns the locaiton (see
2208 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
2210 =item location_label [ OPTION => VALUE ... ]
2212 Returns the label of the location object (see L<FS::cust_location>).
2216 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
2218 =item seconds_since TIMESTAMP
2220 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
2221 package have been online since TIMESTAMP, according to the session monitor.
2223 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2224 L<Time::Local> and L<Date::Parse> for conversion functions.
2229 my($self, $since) = @_;
2232 foreach my $cust_svc (
2233 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
2235 $seconds += $cust_svc->seconds_since($since);
2242 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
2244 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
2245 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
2248 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2249 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2255 sub seconds_since_sqlradacct {
2256 my($self, $start, $end) = @_;
2260 foreach my $cust_svc (
2262 my $part_svc = $_->part_svc;
2263 $part_svc->svcdb eq 'svc_acct'
2264 && scalar($part_svc->part_export('sqlradius'));
2267 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
2274 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
2276 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
2277 in this package for sessions ending between TIMESTAMP_START (inclusive) and
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
2287 sub attribute_since_sqlradacct {
2288 my($self, $start, $end, $attrib) = @_;
2292 foreach my $cust_svc (
2294 my $part_svc = $_->part_svc;
2295 $part_svc->svcdb eq 'svc_acct'
2296 && scalar($part_svc->part_export('sqlradius'));
2299 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
2311 my( $self, $value ) = @_;
2312 if ( defined($value) ) {
2313 $self->setfield('quantity', $value);
2315 $self->getfield('quantity') || 1;
2318 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
2320 Transfers as many services as possible from this package to another package.
2322 The destination package can be specified by pkgnum by passing an FS::cust_pkg
2323 object. The destination package must already exist.
2325 Services are moved only if the destination allows services with the correct
2326 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
2327 this option with caution! No provision is made for export differences
2328 between the old and new service definitions. Probably only should be used
2329 when your exports for all service definitions of a given svcdb are identical.
2330 (attempt a transfer without it first, to move all possible svcpart-matching
2333 Any services that can't be moved remain in the original package.
2335 Returns an error, if there is one; otherwise, returns the number of services
2336 that couldn't be moved.
2341 my ($self, $dest_pkgnum, %opt) = @_;
2347 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
2348 $dest = $dest_pkgnum;
2349 $dest_pkgnum = $dest->pkgnum;
2351 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
2354 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
2356 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
2357 $target{$pkg_svc->svcpart} = $pkg_svc->quantity;
2360 foreach my $cust_svc ($dest->cust_svc) {
2361 $target{$cust_svc->svcpart}--;
2364 my %svcpart2svcparts = ();
2365 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2366 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
2367 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
2368 next if exists $svcpart2svcparts{$svcpart};
2369 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
2370 $svcpart2svcparts{$svcpart} = [
2372 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
2374 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
2375 'svcpart' => $_ } );
2377 $pkg_svc ? $pkg_svc->primary_svc : '',
2378 $pkg_svc ? $pkg_svc->quantity : 0,
2382 grep { $_ != $svcpart }
2384 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
2386 warn "alternates for svcpart $svcpart: ".
2387 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
2392 foreach my $cust_svc ($self->cust_svc) {
2393 if($target{$cust_svc->svcpart} > 0) {
2394 $target{$cust_svc->svcpart}--;
2395 my $new = new FS::cust_svc { $cust_svc->hash };
2396 $new->pkgnum($dest_pkgnum);
2397 my $error = $new->replace($cust_svc);
2398 return $error if $error;
2399 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2401 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
2402 warn "alternates to consider: ".
2403 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
2405 my @alternate = grep {
2406 warn "considering alternate svcpart $_: ".
2407 "$target{$_} available in new package\n"
2410 } @{$svcpart2svcparts{$cust_svc->svcpart}};
2412 warn "alternate(s) found\n" if $DEBUG;
2413 my $change_svcpart = $alternate[0];
2414 $target{$change_svcpart}--;
2415 my $new = new FS::cust_svc { $cust_svc->hash };
2416 $new->svcpart($change_svcpart);
2417 $new->pkgnum($dest_pkgnum);
2418 my $error = $new->replace($cust_svc);
2419 return $error if $error;
2432 This method is deprecated. See the I<depend_jobnum> option to the insert and
2433 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
2440 local $SIG{HUP} = 'IGNORE';
2441 local $SIG{INT} = 'IGNORE';
2442 local $SIG{QUIT} = 'IGNORE';
2443 local $SIG{TERM} = 'IGNORE';
2444 local $SIG{TSTP} = 'IGNORE';
2445 local $SIG{PIPE} = 'IGNORE';
2447 my $oldAutoCommit = $FS::UID::AutoCommit;
2448 local $FS::UID::AutoCommit = 0;
2451 foreach my $cust_svc ( $self->cust_svc ) {
2452 #false laziness w/svc_Common::insert
2453 my $svc_x = $cust_svc->svc_x;
2454 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
2455 my $error = $part_export->export_insert($svc_x);
2457 $dbh->rollback if $oldAutoCommit;
2463 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2470 Associates this package with a (suspension or cancellation) reason (see
2471 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
2474 Available options are:
2480 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.
2484 the access_user (see L<FS::access_user>) providing the reason
2492 the action (cancel, susp, adjourn, expire) associated with the reason
2496 If there is an error, returns the error, otherwise returns false.
2501 my ($self, %options) = @_;
2503 my $otaker = $options{reason_otaker} ||
2504 $FS::CurrentUser::CurrentUser->username;
2507 if ( $options{'reason'} =~ /^(\d+)$/ ) {
2511 } elsif ( ref($options{'reason'}) ) {
2513 return 'Enter a new reason (or select an existing one)'
2514 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
2516 my $reason = new FS::reason({
2517 'reason_type' => $options{'reason'}->{'typenum'},
2518 'reason' => $options{'reason'}->{'reason'},
2520 my $error = $reason->insert;
2521 return $error if $error;
2523 $reasonnum = $reason->reasonnum;
2526 return "Unparsable reason: ". $options{'reason'};
2529 my $cust_pkg_reason =
2530 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
2531 'reasonnum' => $reasonnum,
2532 'otaker' => $otaker,
2533 'action' => substr(uc($options{'action'}),0,1),
2534 'date' => $options{'date'}
2539 $cust_pkg_reason->insert;
2542 =item insert_discount
2544 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
2545 inserting a new discount on the fly (see L<FS::discount>).
2547 Available options are:
2555 If there is an error, returns the error, otherwise returns false.
2559 sub insert_discount {
2560 #my ($self, %options) = @_;
2563 my $cust_pkg_discount = new FS::cust_pkg_discount {
2564 'pkgnum' => $self->pkgnum,
2565 'discountnum' => $self->discountnum,
2567 'end_date' => '', #XXX
2568 #for the create a new discount case
2569 '_type' => $self->discountnum__type,
2570 'amount' => $self->discountnum_amount,
2571 'percent' => $self->discountnum_percent,
2572 'months' => $self->discountnum_months,
2573 #'disabled' => $self->discountnum_disabled,
2576 $cust_pkg_discount->insert;
2579 =item set_usage USAGE_VALUE_HASHREF
2581 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2582 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2583 upbytes, downbytes, and totalbytes are appropriate keys.
2585 All svc_accts which are part of this package have their values reset.
2590 my ($self, $valueref, %opt) = @_;
2592 foreach my $cust_svc ($self->cust_svc){
2593 my $svc_x = $cust_svc->svc_x;
2594 $svc_x->set_usage($valueref, %opt)
2595 if $svc_x->can("set_usage");
2599 =item recharge USAGE_VALUE_HASHREF
2601 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2602 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2603 upbytes, downbytes, and totalbytes are appropriate keys.
2605 All svc_accts which are part of this package have their values incremented.
2610 my ($self, $valueref) = @_;
2612 foreach my $cust_svc ($self->cust_svc){
2613 my $svc_x = $cust_svc->svc_x;
2614 $svc_x->recharge($valueref)
2615 if $svc_x->can("recharge");
2619 =item cust_pkg_discount
2623 sub cust_pkg_discount {
2625 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
2628 =item cust_pkg_discount_active
2632 sub cust_pkg_discount_active {
2634 grep { $_->status eq 'active' } $self->cust_pkg_discount;
2639 =head1 CLASS METHODS
2645 Returns an SQL expression identifying recurring packages.
2649 sub recurring_sql { "
2650 '0' != ( select freq from part_pkg
2651 where cust_pkg.pkgpart = part_pkg.pkgpart )
2656 Returns an SQL expression identifying one-time packages.
2661 '0' = ( select freq from part_pkg
2662 where cust_pkg.pkgpart = part_pkg.pkgpart )
2667 Returns an SQL expression identifying ordered packages (recurring packages not
2673 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
2678 Returns an SQL expression identifying active packages.
2683 $_[0]->recurring_sql. "
2684 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
2685 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2686 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2689 =item not_yet_billed_sql
2691 Returns an SQL expression identifying packages which have not yet been billed.
2695 sub not_yet_billed_sql { "
2696 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
2697 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2698 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2703 Returns an SQL expression identifying inactive packages (one-time packages
2704 that are otherwise unsuspended/uncancelled).
2708 sub inactive_sql { "
2709 ". $_[0]->onetime_sql(). "
2710 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
2711 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2712 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2718 Returns an SQL expression identifying suspended packages.
2722 sub suspended_sql { susp_sql(@_); }
2724 #$_[0]->recurring_sql(). ' AND '.
2726 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2727 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
2734 Returns an SQL exprression identifying cancelled packages.
2738 sub cancelled_sql { cancel_sql(@_); }
2740 #$_[0]->recurring_sql(). ' AND '.
2741 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
2746 Returns an SQL expression to give the package status as a string.
2752 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
2753 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
2754 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
2755 WHEN ".onetime_sql()." THEN 'one-time charge'
2760 =item search HASHREF
2764 Returns a qsearch hash expression to search for parameters specified in HASHREF.
2765 Valid parameters are
2773 active, inactive, suspended, cancel (or cancelled)
2777 active, inactive, suspended, one-time charge, inactive, cancel (or cancelled)
2781 boolean selects custom packages
2787 pkgpart or arrayref or hashref of pkgparts
2791 arrayref of beginning and ending epoch date
2795 arrayref of beginning and ending epoch date
2799 arrayref of beginning and ending epoch date
2803 arrayref of beginning and ending epoch date
2807 arrayref of beginning and ending epoch date
2811 arrayref of beginning and ending epoch date
2815 arrayref of beginning and ending epoch date
2819 pkgnum or APKG_pkgnum
2823 a value suited to passing to FS::UI::Web::cust_header
2827 specifies the user for agent virtualization
2831 boolean selects packages containing fcc form 477 telco lines
2838 my ($class, $params) = @_;
2845 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
2847 "cust_main.agentnum = $1";
2854 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
2856 "cust_pkg.custnum = $1";
2863 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
2865 "cust_pkg.pkgbatch = '$1'";
2872 if ( $params->{'magic'} eq 'active'
2873 || $params->{'status'} eq 'active' ) {
2875 push @where, FS::cust_pkg->active_sql();
2877 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
2878 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
2880 push @where, FS::cust_pkg->not_yet_billed_sql();
2882 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
2883 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
2885 push @where, FS::cust_pkg->inactive_sql();
2887 } elsif ( $params->{'magic'} eq 'suspended'
2888 || $params->{'status'} eq 'suspended' ) {
2890 push @where, FS::cust_pkg->suspended_sql();
2892 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
2893 || $params->{'status'} =~ /^cancell?ed$/ ) {
2895 push @where, FS::cust_pkg->cancelled_sql();
2900 # parse package class
2903 #false lazinessish w/graph/cust_bill_pkg.cgi
2906 if ( exists($params->{'classnum'})
2907 && $params->{'classnum'} =~ /^(\d*)$/
2911 if ( $classnum ) { #a specific class
2912 push @where, "part_pkg.classnum = $classnum";
2914 #@pkg_class = ( qsearchs('pkg_class', { 'classnum' => $classnum } ) );
2915 #die "classnum $classnum not found!" unless $pkg_class[0];
2916 #$title .= $pkg_class[0]->classname.' ';
2918 } elsif ( $classnum eq '' ) { #the empty class
2920 push @where, "part_pkg.classnum IS NULL";
2921 #$title .= 'Empty class ';
2922 #@pkg_class = ( '(empty class)' );
2923 } elsif ( $classnum eq '0' ) {
2924 #@pkg_class = qsearch('pkg_class', {} ); # { 'disabled' => '' } );
2925 #push @pkg_class, '(empty class)';
2927 die "illegal classnum";
2933 # parse package report options
2936 my @report_option = ();
2937 if ( exists($params->{'report_option'})
2938 && $params->{'report_option'} =~ /^([,\d]*)$/
2941 @report_option = split(',', $1);
2944 if (@report_option) {
2945 # this will result in the empty set for the dangling comma case as it should
2947 map{ "0 < ( SELECT count(*) FROM part_pkg_option
2948 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
2949 AND optionname = 'report_option_$_'
2950 AND optionvalue = '1' )"
2960 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
2966 push @where, "part_pkg.fcc_ds0s > 0" if $params->{fcc_line};
2972 if ( exists($params->{'censustract'}) ) {
2973 $params->{'censustract'} =~ /^([.\d]*)$/;
2974 my $censustract = "cust_main.censustract = '$1'";
2975 $censustract .= ' OR cust_main.censustract is NULL' unless $1;
2976 push @where, "( $censustract )";
2983 if ( ref($params->{'pkgpart'}) ) {
2986 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
2987 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
2988 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
2989 @pkgpart = @{ $params->{'pkgpart'} };
2991 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
2994 @pkgpart = grep /^(\d+)$/, @pkgpart;
2996 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
2998 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
2999 push @where, "pkgpart = $1";
3008 #false laziness w/report_cust_pkg.html
3011 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
3012 'active' => { 'susp'=>1, 'cancel'=>1 },
3013 'suspended' => { 'cancel' => 1 },
3018 if( exists($params->{'active'} ) ) {
3019 # This overrides all the other date-related fields
3020 my($beginning, $ending) = @{$params->{'active'}};
3022 "cust_pkg.setup IS NOT NULL",
3023 "cust_pkg.setup <= $ending",
3024 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
3025 "NOT (".FS::cust_pkg->onetime_sql . ")";
3028 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end cancel )) {
3030 next unless exists($params->{$field});
3032 my($beginning, $ending) = @{$params->{$field}};
3034 next if $beginning == 0 && $ending == 4294967295;
3037 "cust_pkg.$field IS NOT NULL",
3038 "cust_pkg.$field >= $beginning",
3039 "cust_pkg.$field <= $ending";
3041 $orderby ||= "ORDER BY cust_pkg.$field";
3046 $orderby ||= 'ORDER BY bill';
3049 # parse magic, legacy, etc.
3052 if ( $params->{'magic'} &&
3053 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
3056 $orderby = 'ORDER BY pkgnum';
3058 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
3059 push @where, "pkgpart = $1";
3062 } elsif ( $params->{'query'} eq 'pkgnum' ) {
3064 $orderby = 'ORDER BY pkgnum';
3066 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
3068 $orderby = 'ORDER BY pkgnum';
3071 SELECT count(*) FROM pkg_svc
3072 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
3073 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
3074 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
3075 AND cust_svc.svcpart = pkg_svc.svcpart
3082 # setup queries, links, subs, etc. for the search
3085 # here is the agent virtualization
3086 if ($params->{CurrentUser}) {
3088 qsearchs('access_user', { username => $params->{CurrentUser} });
3091 push @where, $access_user->agentnums_sql('table'=>'cust_main');
3096 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
3099 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
3101 my $addl_from = 'LEFT JOIN cust_main USING ( custnum ) '.
3102 'LEFT JOIN part_pkg USING ( pkgpart ) '.
3103 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) ';
3105 my $count_query = "SELECT COUNT(*) FROM cust_pkg $addl_from $extra_sql";
3108 'table' => 'cust_pkg',
3110 'select' => join(', ',
3112 ( map "part_pkg.$_", qw( pkg freq ) ),
3113 'pkg_class.classname',
3114 'cust_main.custnum AS cust_main_custnum',
3115 FS::UI::Web::cust_sql_fields(
3116 $params->{'cust_fields'}
3119 'extra_sql' => "$extra_sql $orderby",
3120 'addl_from' => $addl_from,
3121 'count_query' => $count_query,
3128 Returns a list of two package counts. The first is a count of packages
3129 based on the supplied criteria and the second is the count of residential
3130 packages with those same criteria. Criteria are specified as in the search
3136 my ($class, $params) = @_;
3138 my $sql_query = $class->search( $params );
3140 my $count_sql = delete($sql_query->{'count_query'});
3141 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
3142 or die "couldn't parse count_sql";
3144 my $count_sth = dbh->prepare($count_sql)
3145 or die "Error preparing $count_sql: ". dbh->errstr;
3147 or die "Error executing $count_sql: ". $count_sth->errstr;
3148 my $count_arrayref = $count_sth->fetchrow_arrayref;
3150 return ( @$count_arrayref );
3157 Returns a list: the first item is an SQL fragment identifying matching
3158 packages/customers via location (taking into account shipping and package
3159 address taxation, if enabled), and subsequent items are the parameters to
3160 substitute for the placeholders in that fragment.
3165 my($class, %opt) = @_;
3166 my $ornull = $opt{'ornull'};
3168 my $conf = new FS::Conf;
3170 # '?' placeholders in _location_sql_where
3171 my $x = $ornull ? 3 : 2;
3172 my @bill_param = ( ('city')x3, ('county')x$x, ('state')x$x, 'country' );
3176 if ( $conf->exists('tax-ship_address') ) {
3179 ( ( ship_last IS NULL OR ship_last = '' )
3180 AND ". _location_sql_where('cust_main', '', $ornull ). "
3182 OR ( ship_last IS NOT NULL AND ship_last != ''
3183 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
3186 # AND payby != 'COMP'
3188 @main_param = ( @bill_param, @bill_param );
3192 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
3193 @main_param = @bill_param;
3199 if ( $conf->exists('tax-pkg_address') ) {
3201 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
3204 ( cust_pkg.locationnum IS NULL AND $main_where )
3205 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
3208 @param = ( @main_param, @bill_param );
3212 $where = $main_where;
3213 @param = @main_param;
3221 #subroutine, helper for location_sql
3222 sub _location_sql_where {
3224 my $prefix = @_ ? shift : '';
3225 my $ornull = @_ ? shift : '';
3227 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
3229 $ornull = $ornull ? ' OR ? IS NULL ' : '';
3231 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL ) ";
3232 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL ) ";
3233 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL ) ";
3235 # ( $table.${prefix}city = ? $or_empty_city $ornull )
3237 ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS text) IS NULL )
3238 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
3239 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
3240 AND $table.${prefix}country = ?
3248 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
3250 CUSTNUM is a customer (see L<FS::cust_main>)
3252 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3253 L<FS::part_pkg>) to order for this customer. Duplicates are of course
3256 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
3257 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
3258 new billing items. An error is returned if this is not possible (see
3259 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
3262 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3263 newly-created cust_pkg objects.
3265 REFNUM, if specified, will specify the FS::pkg_referral record to be created
3266 and inserted. Multiple FS::pkg_referral records can be created by
3267 setting I<refnum> to an array reference of refnums or a hash reference with
3268 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
3269 record will be created corresponding to cust_main.refnum.
3274 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
3276 my $conf = new FS::Conf;
3278 # Transactionize this whole mess
3279 local $SIG{HUP} = 'IGNORE';
3280 local $SIG{INT} = 'IGNORE';
3281 local $SIG{QUIT} = 'IGNORE';
3282 local $SIG{TERM} = 'IGNORE';
3283 local $SIG{TSTP} = 'IGNORE';
3284 local $SIG{PIPE} = 'IGNORE';
3286 my $oldAutoCommit = $FS::UID::AutoCommit;
3287 local $FS::UID::AutoCommit = 0;
3291 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
3292 # return "Customer not found: $custnum" unless $cust_main;
3294 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
3297 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3300 my $change = scalar(@old_cust_pkg) != 0;
3303 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
3305 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
3306 " to pkgpart ". $pkgparts->[0]. "\n"
3309 my $err_or_cust_pkg =
3310 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
3311 'refnum' => $refnum,
3314 unless (ref($err_or_cust_pkg)) {
3315 $dbh->rollback if $oldAutoCommit;
3316 return $err_or_cust_pkg;
3319 push @$return_cust_pkg, $err_or_cust_pkg;
3320 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3325 # Create the new packages.
3326 foreach my $pkgpart (@$pkgparts) {
3328 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
3330 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
3331 pkgpart => $pkgpart,
3335 $error = $cust_pkg->insert( 'change' => $change );
3337 $dbh->rollback if $oldAutoCommit;
3340 push @$return_cust_pkg, $cust_pkg;
3342 # $return_cust_pkg now contains refs to all of the newly
3345 # Transfer services and cancel old packages.
3346 foreach my $old_pkg (@old_cust_pkg) {
3348 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
3351 foreach my $new_pkg (@$return_cust_pkg) {
3352 $error = $old_pkg->transfer($new_pkg);
3353 if ($error and $error == 0) {
3354 # $old_pkg->transfer failed.
3355 $dbh->rollback if $oldAutoCommit;
3360 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
3361 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
3362 foreach my $new_pkg (@$return_cust_pkg) {
3363 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
3364 if ($error and $error == 0) {
3365 # $old_pkg->transfer failed.
3366 $dbh->rollback if $oldAutoCommit;
3373 # Transfers were successful, but we went through all of the
3374 # new packages and still had services left on the old package.
3375 # We can't cancel the package under the circumstances, so abort.
3376 $dbh->rollback if $oldAutoCommit;
3377 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
3379 $error = $old_pkg->cancel( quiet=>1 );
3385 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3389 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
3391 A bulk change method to change packages for multiple customers.
3393 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3394 L<FS::part_pkg>) to order for each customer. Duplicates are of course
3397 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
3398 replace. The services (see L<FS::cust_svc>) are moved to the
3399 new billing items. An error is returned if this is not possible (see
3402 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3403 newly-created cust_pkg objects.
3408 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
3410 # Transactionize this whole mess
3411 local $SIG{HUP} = 'IGNORE';
3412 local $SIG{INT} = 'IGNORE';
3413 local $SIG{QUIT} = 'IGNORE';
3414 local $SIG{TERM} = 'IGNORE';
3415 local $SIG{TSTP} = 'IGNORE';
3416 local $SIG{PIPE} = 'IGNORE';
3418 my $oldAutoCommit = $FS::UID::AutoCommit;
3419 local $FS::UID::AutoCommit = 0;
3423 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3426 while(scalar(@old_cust_pkg)) {
3428 my $custnum = $old_cust_pkg[0]->custnum;
3429 my (@remove) = map { $_->pkgnum }
3430 grep { $_->custnum == $custnum } @old_cust_pkg;
3431 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
3433 my $error = order $custnum, $pkgparts, \@remove, \@return;
3435 push @errors, $error
3437 push @$return_cust_pkg, @return;
3440 if (scalar(@errors)) {
3441 $dbh->rollback if $oldAutoCommit;
3442 return join(' / ', @errors);
3445 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3449 # Used by FS::Upgrade to migrate to a new database.
3450 sub _upgrade_data { # class method
3451 my ($class, %opts) = @_;
3452 $class->_upgrade_otaker(%opts);
3454 # RT#10139, bug resulting in contract_end being set when it shouldn't
3455 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
3456 # RT#10830, bad calculation of prorate date near end of year
3457 # the date range for bill is December 2009, and we move it forward
3458 # one year if it's before the previous bill date (which it should
3460 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
3461 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
3462 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
3463 # RT6628, add order_date to cust_pkg
3464 'update cust_pkg set order_date = (select history_date from h_cust_pkg
3465 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
3466 history_action = \'insert\') where order_date is null',
3468 foreach my $sql (@statements) {
3469 my $sth = dbh->prepare($sql);
3470 $sth->execute or die $sth->errstr;
3478 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
3480 In sub order, the @pkgparts array (passed by reference) is clobbered.
3482 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
3483 method to pass dates to the recur_prog expression, it should do so.
3485 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
3486 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
3487 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
3488 configuration values. Probably need a subroutine which decides what to do
3489 based on whether or not we've fetched the user yet, rather than a hash. See
3490 FS::UID and the TODO.
3492 Now that things are transactional should the check in the insert method be
3497 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
3498 L<FS::pkg_svc>, schema.html from the base documentation