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";
754 foreach my $cust_svc (
757 sort { $a->[1] <=> $b->[1] }
758 map { [ $_, $_->svc_x->table_info->{'cancel_weight'} ]; }
759 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
761 my $error = $cust_svc->cancel;
764 $dbh->rollback if $oldAutoCommit;
765 return "Error cancelling cust_svc: $error";
769 # Add a credit for remaining service
770 my $last_bill = $self->getfield('last_bill') || 0;
771 my $next_bill = $self->getfield('bill') || 0;
773 if ( exists($options{'unused_credit'}) ) {
774 $do_credit = $options{'unused_credit'};
777 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
780 and $last_bill > 0 # the package has been billed
781 and $next_bill > 0 # the package has a next bill date
782 and $next_bill >= $cancel_time # which is in the future
784 my $remaining_value = $self->calc_remain('time' => $cancel_time);
785 if ( $remaining_value > 0 ) {
786 # && !$options{'no_credit'} ) {
787 # Undocumented, unused option.
788 # part_pkg configuration should decide this anyway.
789 my $error = $self->cust_main->credit(
791 'Credit for unused time on '. $self->part_pkg->pkg,
792 'reason_type' => $conf->config('cancel_credit_type'),
795 $dbh->rollback if $oldAutoCommit;
796 return "Error crediting customer \$$remaining_value for unused time".
797 " on ". $self->part_pkg->pkg. ": $error";
799 } #if $remaining_value
804 my %hash = $self->hash;
805 $date ? ($hash{'expire'} = $date) : ($hash{'cancel'} = $cancel_time);
806 my $new = new FS::cust_pkg ( \%hash );
807 $error = $new->replace( $self, options => { $self->options } );
809 $dbh->rollback if $oldAutoCommit;
813 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
814 return '' if $date; #no errors
816 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
817 if ( !$options{'quiet'} &&
818 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
820 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
823 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
824 $error = $msg_template->send( 'cust_main' => $self->cust_main,
829 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
830 'to' => \@invoicing_list,
831 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
832 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
835 #should this do something on errors?
842 =item cancel_if_expired [ NOW_TIMESTAMP ]
844 Cancels this package if its expire date has been reached.
848 sub cancel_if_expired {
850 my $time = shift || time;
851 return '' unless $self->expire && $self->expire <= $time;
852 my $error = $self->cancel;
854 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
855 $self->custnum. ": $error";
862 Cancels any pending expiration (sets the expire field to null).
864 If there is an error, returns the error, otherwise returns false.
869 my( $self, %options ) = @_;
872 local $SIG{HUP} = 'IGNORE';
873 local $SIG{INT} = 'IGNORE';
874 local $SIG{QUIT} = 'IGNORE';
875 local $SIG{TERM} = 'IGNORE';
876 local $SIG{TSTP} = 'IGNORE';
877 local $SIG{PIPE} = 'IGNORE';
879 my $oldAutoCommit = $FS::UID::AutoCommit;
880 local $FS::UID::AutoCommit = 0;
883 my $old = $self->select_for_update;
885 my $pkgnum = $old->pkgnum;
886 if ( $old->get('cancel') || $self->get('cancel') ) {
887 dbh->rollback if $oldAutoCommit;
888 return "Can't unexpire cancelled package $pkgnum";
889 # or at least it's pointless
892 unless ( $old->get('expire') && $self->get('expire') ) {
893 dbh->rollback if $oldAutoCommit;
894 return ""; # no error
897 my %hash = $self->hash;
898 $hash{'expire'} = '';
899 my $new = new FS::cust_pkg ( \%hash );
900 $error = $new->replace( $self, options => { $self->options } );
902 $dbh->rollback if $oldAutoCommit;
906 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
912 =item suspend [ OPTION => VALUE ... ]
914 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
915 package, then suspends the package itself (sets the susp field to now).
917 Available options are:
921 =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.
923 =item date - can be set to a unix style timestamp to specify when to suspend (adjourn)
927 If there is an error, returns the error, otherwise returns false.
932 my( $self, %options ) = @_;
935 local $SIG{HUP} = 'IGNORE';
936 local $SIG{INT} = 'IGNORE';
937 local $SIG{QUIT} = 'IGNORE';
938 local $SIG{TERM} = 'IGNORE';
939 local $SIG{TSTP} = 'IGNORE';
940 local $SIG{PIPE} = 'IGNORE';
942 my $oldAutoCommit = $FS::UID::AutoCommit;
943 local $FS::UID::AutoCommit = 0;
946 my $old = $self->select_for_update;
948 my $pkgnum = $old->pkgnum;
949 if ( $old->get('cancel') || $self->get('cancel') ) {
950 dbh->rollback if $oldAutoCommit;
951 return "Can't suspend cancelled package $pkgnum";
954 if ( $old->get('susp') || $self->get('susp') ) {
955 dbh->rollback if $oldAutoCommit;
956 return ""; # no error # complain on adjourn?
959 my $date = $options{date} if $options{date}; # adjourn/suspend later
960 $date = '' if ($date && $date <= time); # complain instead?
962 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
963 dbh->rollback if $oldAutoCommit;
964 return "Package $pkgnum expires before it would be suspended.";
967 my $suspend_time = $options{'time'} || time;
969 if ( $options{'reason'} ) {
970 $error = $self->insert_reason( 'reason' => $options{'reason'},
971 'action' => $date ? 'adjourn' : 'suspend',
972 'date' => $date ? $date : $suspend_time,
973 'reason_otaker' => $options{'reason_otaker'},
976 dbh->rollback if $oldAutoCommit;
977 return "Error inserting cust_pkg_reason: $error";
985 foreach my $cust_svc (
986 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
988 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
990 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
991 $dbh->rollback if $oldAutoCommit;
992 return "Illegal svcdb value in part_svc!";
995 require "FS/$svcdb.pm";
997 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
999 $error = $svc->suspend;
1001 $dbh->rollback if $oldAutoCommit;
1004 my( $label, $value ) = $cust_svc->label;
1005 push @labels, "$label: $value";
1009 my $conf = new FS::Conf;
1010 if ( $conf->config('suspend_email_admin') ) {
1012 my $error = send_email(
1013 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1014 #invoice_from ??? well as good as any
1015 'to' => $conf->config('suspend_email_admin'),
1016 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1018 "This is an automatic message from your Freeside installation\n",
1019 "informing you that the following customer package has been suspended:\n",
1021 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1022 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1023 ( map { "Service : $_\n" } @labels ),
1028 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1036 my %hash = $self->hash;
1038 $hash{'adjourn'} = $date;
1040 $hash{'susp'} = $suspend_time;
1042 my $new = new FS::cust_pkg ( \%hash );
1043 $error = $new->replace( $self, options => { $self->options } );
1045 $dbh->rollback if $oldAutoCommit;
1049 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1054 =item unsuspend [ OPTION => VALUE ... ]
1056 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1057 package, then unsuspends the package itself (clears the susp field and the
1058 adjourn field if it is in the past).
1060 Available options are:
1064 =item adjust_next_bill
1066 Can be set true to adjust the next bill date forward by
1067 the amount of time the account was inactive. This was set true by default
1068 since 1.4.2 and 1.5.0pre6; however, starting with 1.7.0 this needs to be
1069 explicitly requested. Price plans for which this makes sense (anniversary-date
1070 based than prorate or subscription) could have an option to enable this
1075 If there is an error, returns the error, otherwise returns false.
1080 my( $self, %opt ) = @_;
1083 local $SIG{HUP} = 'IGNORE';
1084 local $SIG{INT} = 'IGNORE';
1085 local $SIG{QUIT} = 'IGNORE';
1086 local $SIG{TERM} = 'IGNORE';
1087 local $SIG{TSTP} = 'IGNORE';
1088 local $SIG{PIPE} = 'IGNORE';
1090 my $oldAutoCommit = $FS::UID::AutoCommit;
1091 local $FS::UID::AutoCommit = 0;
1094 my $old = $self->select_for_update;
1096 my $pkgnum = $old->pkgnum;
1097 if ( $old->get('cancel') || $self->get('cancel') ) {
1098 dbh->rollback if $oldAutoCommit;
1099 return "Can't unsuspend cancelled package $pkgnum";
1102 unless ( $old->get('susp') && $self->get('susp') ) {
1103 dbh->rollback if $oldAutoCommit;
1104 return ""; # no error # complain instead?
1107 foreach my $cust_svc (
1108 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1110 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1112 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1113 $dbh->rollback if $oldAutoCommit;
1114 return "Illegal svcdb value in part_svc!";
1117 require "FS/$svcdb.pm";
1119 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1121 $error = $svc->unsuspend;
1123 $dbh->rollback if $oldAutoCommit;
1130 my %hash = $self->hash;
1131 my $inactive = time - $hash{'susp'};
1133 my $conf = new FS::Conf;
1135 if ( $inactive > 0 &&
1136 ( $hash{'bill'} || $hash{'setup'} ) &&
1137 ( $opt{'adjust_next_bill'} ||
1138 $conf->exists('unsuspend-always_adjust_next_bill_date') ||
1139 $self->part_pkg->option('unsuspend_adjust_bill', 1) )
1142 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1147 $hash{'adjourn'} = '' if $hash{'adjourn'} < time;
1148 my $new = new FS::cust_pkg ( \%hash );
1149 $error = $new->replace( $self, options => { $self->options } );
1151 $dbh->rollback if $oldAutoCommit;
1155 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1162 Cancels any pending suspension (sets the adjourn field to null).
1164 If there is an error, returns the error, otherwise returns false.
1169 my( $self, %options ) = @_;
1172 local $SIG{HUP} = 'IGNORE';
1173 local $SIG{INT} = 'IGNORE';
1174 local $SIG{QUIT} = 'IGNORE';
1175 local $SIG{TERM} = 'IGNORE';
1176 local $SIG{TSTP} = 'IGNORE';
1177 local $SIG{PIPE} = 'IGNORE';
1179 my $oldAutoCommit = $FS::UID::AutoCommit;
1180 local $FS::UID::AutoCommit = 0;
1183 my $old = $self->select_for_update;
1185 my $pkgnum = $old->pkgnum;
1186 if ( $old->get('cancel') || $self->get('cancel') ) {
1187 dbh->rollback if $oldAutoCommit;
1188 return "Can't unadjourn cancelled package $pkgnum";
1189 # or at least it's pointless
1192 if ( $old->get('susp') || $self->get('susp') ) {
1193 dbh->rollback if $oldAutoCommit;
1194 return "Can't unadjourn suspended package $pkgnum";
1195 # perhaps this is arbitrary
1198 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1199 dbh->rollback if $oldAutoCommit;
1200 return ""; # no error
1203 my %hash = $self->hash;
1204 $hash{'adjourn'} = '';
1205 my $new = new FS::cust_pkg ( \%hash );
1206 $error = $new->replace( $self, options => { $self->options } );
1208 $dbh->rollback if $oldAutoCommit;
1212 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1219 =item change HASHREF | OPTION => VALUE ...
1221 Changes this package: cancels it and creates a new one, with a different
1222 pkgpart or locationnum or both. All services are transferred to the new
1223 package (no change will be made if this is not possible).
1225 Options may be passed as a list of key/value pairs or as a hash reference.
1232 New locationnum, to change the location for this package.
1236 New FS::cust_location object, to create a new location and assign it
1241 New pkgpart (see L<FS::part_pkg>).
1245 New refnum (see L<FS::part_referral>).
1249 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1250 susp, adjourn, cancel, expire, and contract_end) to the new package.
1254 At least one of locationnum, cust_location, pkgpart, refnum must be specified
1255 (otherwise, what's the point?)
1257 Returns either the new FS::cust_pkg object or a scalar error.
1261 my $err_or_new_cust_pkg = $old_cust_pkg->change
1265 #some false laziness w/order
1268 my $opt = ref($_[0]) ? shift : { @_ };
1270 # my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
1273 my $conf = new FS::Conf;
1275 # Transactionize this whole mess
1276 local $SIG{HUP} = 'IGNORE';
1277 local $SIG{INT} = 'IGNORE';
1278 local $SIG{QUIT} = 'IGNORE';
1279 local $SIG{TERM} = 'IGNORE';
1280 local $SIG{TSTP} = 'IGNORE';
1281 local $SIG{PIPE} = 'IGNORE';
1283 my $oldAutoCommit = $FS::UID::AutoCommit;
1284 local $FS::UID::AutoCommit = 0;
1293 #$hash{$_} = $self->$_() foreach qw( last_bill bill );
1295 #$hash{$_} = $self->$_() foreach qw( setup );
1297 $hash{'setup'} = $time if $self->setup;
1299 $hash{'change_date'} = $time;
1300 $hash{"change_$_"} = $self->$_()
1301 foreach qw( pkgnum pkgpart locationnum );
1303 if ( $opt->{'cust_location'} &&
1304 ( ! $opt->{'locationnum'} || $opt->{'locationnum'} == -1 ) ) {
1305 $error = $opt->{'cust_location'}->insert;
1307 $dbh->rollback if $oldAutoCommit;
1308 return "inserting cust_location (transaction rolled back): $error";
1310 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1313 my $unused_credit = 0;
1314 if ( $opt->{'keep_dates'} ) {
1315 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1316 start_date contract_end ) ) {
1317 $hash{$date} = $self->getfield($date);
1320 # Special case. If the pkgpart is changing, and the customer is
1321 # going to be credited for remaining time, don't keep setup, bill,
1322 # or last_bill dates, and DO pass the flag to cancel() to credit
1324 if ( $opt->{'pkgpart'}
1325 and $opt->{'pkgpart'} != $self->pkgpart
1326 and $self->part_pkg->option('unused_credit_change', 1) ) {
1328 $hash{$_} = '' foreach qw(setup bill last_bill);
1331 # Create the new package.
1332 my $cust_pkg = new FS::cust_pkg {
1333 custnum => $self->custnum,
1334 pkgpart => ( $opt->{'pkgpart'} || $self->pkgpart ),
1335 refnum => ( $opt->{'refnum'} || $self->refnum ),
1336 locationnum => ( $opt->{'locationnum'} || $self->locationnum ),
1340 $error = $cust_pkg->insert( 'change' => 1 );
1342 $dbh->rollback if $oldAutoCommit;
1346 # Transfer services and cancel old package.
1348 $error = $self->transfer($cust_pkg);
1349 if ($error and $error == 0) {
1350 # $old_pkg->transfer failed.
1351 $dbh->rollback if $oldAutoCommit;
1355 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
1356 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
1357 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
1358 if ($error and $error == 0) {
1359 # $old_pkg->transfer failed.
1360 $dbh->rollback if $oldAutoCommit;
1366 # Transfers were successful, but we still had services left on the old
1367 # package. We can't change the package under this circumstances, so abort.
1368 $dbh->rollback if $oldAutoCommit;
1369 return "Unable to transfer all services from package ". $self->pkgnum;
1372 #reset usage if changing pkgpart
1373 # AND usage rollover is off (otherwise adds twice, now and at package bill)
1374 if ($self->pkgpart != $cust_pkg->pkgpart) {
1375 my $part_pkg = $cust_pkg->part_pkg;
1376 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
1380 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
1383 $dbh->rollback if $oldAutoCommit;
1384 return "Error setting usage values: $error";
1388 #Good to go, cancel old package. Notify 'cancel' of whether to credit
1390 $error = $self->cancel( quiet=>1, unused_credit => $unused_credit );
1392 $dbh->rollback if $oldAutoCommit;
1396 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
1398 my $error = $cust_pkg->cust_main->bill( 'pkg_list' => [ $cust_pkg ] );
1400 $dbh->rollback if $oldAutoCommit;
1405 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1412 use Storable 'thaw';
1414 sub process_bulk_cust_pkg {
1416 my $param = thaw(decode_base64(shift));
1417 warn Dumper($param) if $DEBUG;
1419 my $old_part_pkg = qsearchs('part_pkg',
1420 { pkgpart => $param->{'old_pkgpart'} });
1421 my $new_part_pkg = qsearchs('part_pkg',
1422 { pkgpart => $param->{'new_pkgpart'} });
1423 die "Must select a new package type\n" unless $new_part_pkg;
1424 #my $keep_dates = $param->{'keep_dates'} || 0;
1425 my $keep_dates = 1; # there is no good reason to turn this off
1427 local $SIG{HUP} = 'IGNORE';
1428 local $SIG{INT} = 'IGNORE';
1429 local $SIG{QUIT} = 'IGNORE';
1430 local $SIG{TERM} = 'IGNORE';
1431 local $SIG{TSTP} = 'IGNORE';
1432 local $SIG{PIPE} = 'IGNORE';
1434 my $oldAutoCommit = $FS::UID::AutoCommit;
1435 local $FS::UID::AutoCommit = 0;
1438 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
1441 foreach my $old_cust_pkg ( @cust_pkgs ) {
1443 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
1444 if ( $old_cust_pkg->getfield('cancel') ) {
1445 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
1446 $old_cust_pkg->pkgnum."\n"
1450 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
1452 my $error = $old_cust_pkg->change(
1453 'pkgpart' => $param->{'new_pkgpart'},
1454 'keep_dates' => $keep_dates
1456 if ( !ref($error) ) { # change returns the cust_pkg on success
1458 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
1461 $dbh->commit if $oldAutoCommit;
1467 Returns the last bill date, or if there is no last bill date, the setup date.
1468 Useful for billing metered services.
1474 return $self->setfield('last_bill', $_[0]) if @_;
1475 return $self->getfield('last_bill') if $self->getfield('last_bill');
1476 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
1477 'edate' => $self->bill, } );
1478 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
1481 =item last_cust_pkg_reason ACTION
1483 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
1484 Returns false if there is no reason or the package is not currenly ACTION'd
1485 ACTION is one of adjourn, susp, cancel, or expire.
1489 sub last_cust_pkg_reason {
1490 my ( $self, $action ) = ( shift, shift );
1491 my $date = $self->get($action);
1493 'table' => 'cust_pkg_reason',
1494 'hashref' => { 'pkgnum' => $self->pkgnum,
1495 'action' => substr(uc($action), 0, 1),
1498 'order_by' => 'ORDER BY num DESC LIMIT 1',
1502 =item last_reason ACTION
1504 Returns the most recent ACTION FS::reason associated with the package.
1505 Returns false if there is no reason or the package is not currenly ACTION'd
1506 ACTION is one of adjourn, susp, cancel, or expire.
1511 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
1512 $cust_pkg_reason->reason
1513 if $cust_pkg_reason;
1518 Returns the definition for this billing item, as an FS::part_pkg object (see
1525 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
1526 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
1527 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
1532 Returns the cancelled package this package was changed from, if any.
1538 return '' unless $self->change_pkgnum;
1539 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
1544 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
1551 $self->part_pkg->calc_setup($self, @_);
1556 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
1563 $self->part_pkg->calc_recur($self, @_);
1568 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
1575 $self->part_pkg->base_recur($self, @_);
1580 Calls the I<calc_remain> of the FS::part_pkg object associated with this
1587 $self->part_pkg->calc_remain($self, @_);
1592 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
1599 $self->part_pkg->calc_cancel($self, @_);
1604 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
1610 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
1613 =item cust_pkg_detail [ DETAILTYPE ]
1615 Returns any customer package details for this package (see
1616 L<FS::cust_pkg_detail>).
1618 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1622 sub cust_pkg_detail {
1624 my %hash = ( 'pkgnum' => $self->pkgnum );
1625 $hash{detailtype} = shift if @_;
1627 'table' => 'cust_pkg_detail',
1628 'hashref' => \%hash,
1629 'order_by' => 'ORDER BY weight, pkgdetailnum',
1633 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
1635 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
1637 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1639 If there is an error, returns the error, otherwise returns false.
1643 sub set_cust_pkg_detail {
1644 my( $self, $detailtype, @details ) = @_;
1646 local $SIG{HUP} = 'IGNORE';
1647 local $SIG{INT} = 'IGNORE';
1648 local $SIG{QUIT} = 'IGNORE';
1649 local $SIG{TERM} = 'IGNORE';
1650 local $SIG{TSTP} = 'IGNORE';
1651 local $SIG{PIPE} = 'IGNORE';
1653 my $oldAutoCommit = $FS::UID::AutoCommit;
1654 local $FS::UID::AutoCommit = 0;
1657 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
1658 my $error = $current->delete;
1660 $dbh->rollback if $oldAutoCommit;
1661 return "error removing old detail: $error";
1665 foreach my $detail ( @details ) {
1666 my $cust_pkg_detail = new FS::cust_pkg_detail {
1667 'pkgnum' => $self->pkgnum,
1668 'detailtype' => $detailtype,
1669 'detail' => $detail,
1671 my $error = $cust_pkg_detail->insert;
1673 $dbh->rollback if $oldAutoCommit;
1674 return "error adding new detail: $error";
1679 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1686 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
1690 #false laziness w/cust_bill.pm
1694 'table' => 'cust_event',
1695 'addl_from' => 'JOIN part_event USING ( eventpart )',
1696 'hashref' => { 'tablenum' => $self->pkgnum },
1697 'extra_sql' => " AND eventtable = 'cust_pkg' ",
1701 =item num_cust_event
1703 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
1707 #false laziness w/cust_bill.pm
1708 sub num_cust_event {
1711 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
1712 " WHERE tablenum = ? AND eventtable = 'cust_pkg'";
1713 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
1714 $sth->execute($self->pkgnum) or die $sth->errstr. " executing $sql";
1715 $sth->fetchrow_arrayref->[0];
1718 =item cust_svc [ SVCPART ]
1720 Returns the services for this package, as FS::cust_svc objects (see
1721 L<FS::cust_svc>). If a svcpart is specified, return only the matching
1729 return () unless $self->num_cust_svc(@_);
1732 return qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum,
1733 'svcpart' => shift, } );
1736 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
1738 #if ( $self->{'_svcnum'} ) {
1739 # values %{ $self->{'_svcnum'}->cache };
1741 $self->_sort_cust_svc(
1742 [ qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } ) ]
1748 =item overlimit [ SVCPART ]
1750 Returns the services for this package which have exceeded their
1751 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
1752 is specified, return only the matching services.
1758 return () unless $self->num_cust_svc(@_);
1759 grep { $_->overlimit } $self->cust_svc(@_);
1762 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
1764 Returns historical services for this package created before END TIMESTAMP and
1765 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
1766 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
1767 I<pkg_svc.hidden> flag will be omitted.
1773 my ($end, $start, $mode) = @_;
1774 my @cust_svc = $self->_sort_cust_svc(
1775 [ qsearch( 'h_cust_svc',
1776 { 'pkgnum' => $self->pkgnum, },
1777 FS::h_cust_svc->sql_h_search(@_),
1780 if ( $mode eq 'I' ) {
1781 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
1782 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
1789 sub _sort_cust_svc {
1790 my( $self, $arrayref ) = @_;
1793 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
1798 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $self->pkgpart,
1799 'svcpart' => $_->svcpart } );
1801 $pkg_svc ? $pkg_svc->primary_svc : '',
1802 $pkg_svc ? $pkg_svc->quantity : 0,
1809 =item num_cust_svc [ SVCPART ]
1811 Returns the number of provisioned services for this package. If a svcpart is
1812 specified, counts only the matching services.
1819 return $self->{'_num_cust_svc'}
1821 && exists($self->{'_num_cust_svc'})
1822 && $self->{'_num_cust_svc'} =~ /\d/;
1824 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
1827 my $sql = 'SELECT COUNT(*) FROM cust_svc WHERE pkgnum = ?';
1828 $sql .= ' AND svcpart = ?' if @_;
1830 my $sth = dbh->prepare($sql) or die dbh->errstr;
1831 $sth->execute($self->pkgnum, @_) or die $sth->errstr;
1832 $sth->fetchrow_arrayref->[0];
1835 =item available_part_svc
1837 Returns a list of FS::part_svc objects representing services included in this
1838 package but not yet provisioned. Each FS::part_svc object also has an extra
1839 field, I<num_avail>, which specifies the number of available services.
1843 sub available_part_svc {
1845 grep { $_->num_avail > 0 }
1847 my $part_svc = $_->part_svc;
1848 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
1849 $_->quantity - $self->num_cust_svc($_->svcpart);
1851 # more evil encapsulation breakage
1852 if($part_svc->{'Hash'}{'num_avail'} > 0) {
1853 my @exports = $part_svc->part_export_did;
1854 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
1859 $self->part_pkg->pkg_svc;
1864 Returns a list of FS::part_svc objects representing provisioned and available
1865 services included in this package. Each FS::part_svc object also has the
1866 following extra fields:
1870 =item num_cust_svc (count)
1872 =item num_avail (quantity - count)
1874 =item cust_pkg_svc (services) - array reference containing the provisioned services, as cust_svc objects
1877 label -> ($cust_svc->label)[1]
1886 #XXX some sort of sort order besides numeric by svcpart...
1887 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
1889 my $part_svc = $pkg_svc->part_svc;
1890 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
1891 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
1892 $part_svc->{'Hash'}{'num_avail'} =
1893 max( 0, $pkg_svc->quantity - $num_cust_svc );
1894 $part_svc->{'Hash'}{'cust_pkg_svc'} =
1895 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
1896 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
1898 } $self->part_pkg->pkg_svc;
1901 push @part_svc, map {
1903 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
1904 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
1905 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
1906 $part_svc->{'Hash'}{'cust_pkg_svc'} =
1907 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
1909 } $self->extra_part_svc;
1915 =item extra_part_svc
1917 Returns a list of FS::part_svc objects corresponding to services in this
1918 package which are still provisioned but not (any longer) available in the
1923 sub extra_part_svc {
1926 my $pkgnum = $self->pkgnum;
1927 my $pkgpart = $self->pkgpart;
1930 # 'table' => 'part_svc',
1933 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
1934 # WHERE pkg_svc.svcpart = part_svc.svcpart
1935 # AND pkg_svc.pkgpart = ?
1938 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
1939 # LEFT JOIN cust_pkg USING ( pkgnum )
1940 # WHERE cust_svc.svcpart = part_svc.svcpart
1943 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
1946 #seems to benchmark slightly faster...
1948 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
1949 #MySQL doesn't grok DISINCT ON
1950 'select' => 'DISTINCT part_svc.*',
1951 'table' => 'part_svc',
1953 'LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
1954 AND pkg_svc.pkgpart = ?
1957 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
1958 LEFT JOIN cust_pkg USING ( pkgnum )
1961 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
1962 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
1968 Returns a short status string for this package, currently:
1972 =item not yet billed
1974 =item one-time charge
1989 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
1991 return 'cancelled' if $self->get('cancel');
1992 return 'suspended' if $self->susp;
1993 return 'not yet billed' unless $self->setup;
1994 return 'one-time charge' if $freq =~ /^(0|$)/;
1998 =item ucfirst_status
2000 Returns the status with the first character capitalized.
2004 sub ucfirst_status {
2005 ucfirst(shift->status);
2010 Class method that returns the list of possible status strings for packages
2011 (see L<the status method|/status>). For example:
2013 @statuses = FS::cust_pkg->statuses();
2017 tie my %statuscolor, 'Tie::IxHash',
2018 'not yet billed' => '009999', #teal? cyan?
2019 'one-time charge' => '000000',
2020 'active' => '00CC00',
2021 'suspended' => 'FF9900',
2022 'cancelled' => 'FF0000',
2026 my $self = shift; #could be class...
2027 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
2028 # # mayble split btw one-time vs. recur
2034 Returns a hex triplet color string for this package's status.
2040 $statuscolor{$self->status};
2045 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
2046 "pkg-comment" depending on user preference).
2052 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
2053 $label = $self->pkgnum. ": $label"
2054 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
2058 =item pkg_label_long
2060 Returns a long label for this package, adding the primary service's label to
2065 sub pkg_label_long {
2067 my $label = $self->pkg_label;
2068 my $cust_svc = $self->primary_cust_svc;
2069 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
2073 =item primary_cust_svc
2075 Returns a primary service (as FS::cust_svc object) if one can be identified.
2079 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
2081 sub primary_cust_svc {
2084 my @cust_svc = $self->cust_svc;
2086 return '' unless @cust_svc; #no serivces - irrelevant then
2088 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
2090 # primary service as specified in the package definition
2091 # or exactly one service definition with quantity one
2092 my $svcpart = $self->part_pkg->svcpart;
2093 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
2094 return $cust_svc[0] if scalar(@cust_svc) == 1;
2096 #couldn't identify one thing..
2102 Returns a list of lists, calling the label method for all services
2103 (see L<FS::cust_svc>) of this billing item.
2109 map { [ $_->label ] } $self->cust_svc;
2112 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2114 Like the labels method, but returns historical information on services that
2115 were active as of END_TIMESTAMP and (optionally) not cancelled before
2116 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
2117 I<pkg_svc.hidden> flag will be omitted.
2119 Returns a list of lists, calling the label method for all (historical) services
2120 (see L<FS::h_cust_svc>) of this billing item.
2126 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
2131 Like labels, except returns a simple flat list, and shortens long
2132 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2133 identical services to one line that lists the service label and the number of
2134 individual services rather than individual items.
2139 shift->_labels_short( 'labels', @_ );
2142 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
2144 Like h_labels, except returns a simple flat list, and shortens long
2145 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2146 identical services to one line that lists the service label and the number of
2147 individual services rather than individual items.
2151 sub h_labels_short {
2152 shift->_labels_short( 'h_labels', @_ );
2156 my( $self, $method ) = ( shift, shift );
2158 my $conf = new FS::Conf;
2159 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
2162 #tie %labels, 'Tie::IxHash';
2163 push @{ $labels{$_->[0]} }, $_->[1]
2164 foreach $self->$method(@_);
2166 foreach my $label ( keys %labels ) {
2168 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
2169 my $num = scalar(@values);
2170 if ( $num > $max_same_services ) {
2171 push @labels, "$label ($num)";
2173 if ( $conf->exists('cust_bill-consolidate_services') ) {
2174 # push @labels, "$label: ". join(', ', @values);
2176 my $detail = "$label: ";
2177 $detail .= shift(@values). ', '
2178 while @values && length($detail.$values[0]) < 78;
2180 push @labels, $detail;
2183 push @labels, map { "$label: $_" } @values;
2194 Returns the parent customer object (see L<FS::cust_main>).
2200 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
2203 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
2207 Returns the location object, if any (see L<FS::cust_location>).
2209 =item cust_location_or_main
2211 If this package is associated with a location, returns the locaiton (see
2212 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
2214 =item location_label [ OPTION => VALUE ... ]
2216 Returns the label of the location object (see L<FS::cust_location>).
2220 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
2222 =item seconds_since TIMESTAMP
2224 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
2225 package have been online since TIMESTAMP, according to the session monitor.
2227 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2228 L<Time::Local> and L<Date::Parse> for conversion functions.
2233 my($self, $since) = @_;
2236 foreach my $cust_svc (
2237 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
2239 $seconds += $cust_svc->seconds_since($since);
2246 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
2248 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
2249 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
2252 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2253 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2259 sub seconds_since_sqlradacct {
2260 my($self, $start, $end) = @_;
2264 foreach my $cust_svc (
2266 my $part_svc = $_->part_svc;
2267 $part_svc->svcdb eq 'svc_acct'
2268 && scalar($part_svc->part_export('sqlradius'));
2271 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
2278 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
2280 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
2281 in this package for sessions ending between TIMESTAMP_START (inclusive) and
2285 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2286 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2291 sub attribute_since_sqlradacct {
2292 my($self, $start, $end, $attrib) = @_;
2296 foreach my $cust_svc (
2298 my $part_svc = $_->part_svc;
2299 $part_svc->svcdb eq 'svc_acct'
2300 && scalar($part_svc->part_export('sqlradius'));
2303 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
2315 my( $self, $value ) = @_;
2316 if ( defined($value) ) {
2317 $self->setfield('quantity', $value);
2319 $self->getfield('quantity') || 1;
2322 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
2324 Transfers as many services as possible from this package to another package.
2326 The destination package can be specified by pkgnum by passing an FS::cust_pkg
2327 object. The destination package must already exist.
2329 Services are moved only if the destination allows services with the correct
2330 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
2331 this option with caution! No provision is made for export differences
2332 between the old and new service definitions. Probably only should be used
2333 when your exports for all service definitions of a given svcdb are identical.
2334 (attempt a transfer without it first, to move all possible svcpart-matching
2337 Any services that can't be moved remain in the original package.
2339 Returns an error, if there is one; otherwise, returns the number of services
2340 that couldn't be moved.
2345 my ($self, $dest_pkgnum, %opt) = @_;
2351 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
2352 $dest = $dest_pkgnum;
2353 $dest_pkgnum = $dest->pkgnum;
2355 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
2358 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
2360 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
2361 $target{$pkg_svc->svcpart} = $pkg_svc->quantity;
2364 foreach my $cust_svc ($dest->cust_svc) {
2365 $target{$cust_svc->svcpart}--;
2368 my %svcpart2svcparts = ();
2369 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2370 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
2371 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
2372 next if exists $svcpart2svcparts{$svcpart};
2373 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
2374 $svcpart2svcparts{$svcpart} = [
2376 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
2378 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
2379 'svcpart' => $_ } );
2381 $pkg_svc ? $pkg_svc->primary_svc : '',
2382 $pkg_svc ? $pkg_svc->quantity : 0,
2386 grep { $_ != $svcpart }
2388 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
2390 warn "alternates for svcpart $svcpart: ".
2391 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
2396 foreach my $cust_svc ($self->cust_svc) {
2397 if($target{$cust_svc->svcpart} > 0) {
2398 $target{$cust_svc->svcpart}--;
2399 my $new = new FS::cust_svc { $cust_svc->hash };
2400 $new->pkgnum($dest_pkgnum);
2401 my $error = $new->replace($cust_svc);
2402 return $error if $error;
2403 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2405 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
2406 warn "alternates to consider: ".
2407 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
2409 my @alternate = grep {
2410 warn "considering alternate svcpart $_: ".
2411 "$target{$_} available in new package\n"
2414 } @{$svcpart2svcparts{$cust_svc->svcpart}};
2416 warn "alternate(s) found\n" if $DEBUG;
2417 my $change_svcpart = $alternate[0];
2418 $target{$change_svcpart}--;
2419 my $new = new FS::cust_svc { $cust_svc->hash };
2420 $new->svcpart($change_svcpart);
2421 $new->pkgnum($dest_pkgnum);
2422 my $error = $new->replace($cust_svc);
2423 return $error if $error;
2436 This method is deprecated. See the I<depend_jobnum> option to the insert and
2437 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
2444 local $SIG{HUP} = 'IGNORE';
2445 local $SIG{INT} = 'IGNORE';
2446 local $SIG{QUIT} = 'IGNORE';
2447 local $SIG{TERM} = 'IGNORE';
2448 local $SIG{TSTP} = 'IGNORE';
2449 local $SIG{PIPE} = 'IGNORE';
2451 my $oldAutoCommit = $FS::UID::AutoCommit;
2452 local $FS::UID::AutoCommit = 0;
2455 foreach my $cust_svc ( $self->cust_svc ) {
2456 #false laziness w/svc_Common::insert
2457 my $svc_x = $cust_svc->svc_x;
2458 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
2459 my $error = $part_export->export_insert($svc_x);
2461 $dbh->rollback if $oldAutoCommit;
2467 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2474 Associates this package with a (suspension or cancellation) reason (see
2475 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
2478 Available options are:
2484 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.
2488 the access_user (see L<FS::access_user>) providing the reason
2496 the action (cancel, susp, adjourn, expire) associated with the reason
2500 If there is an error, returns the error, otherwise returns false.
2505 my ($self, %options) = @_;
2507 my $otaker = $options{reason_otaker} ||
2508 $FS::CurrentUser::CurrentUser->username;
2511 if ( $options{'reason'} =~ /^(\d+)$/ ) {
2515 } elsif ( ref($options{'reason'}) ) {
2517 return 'Enter a new reason (or select an existing one)'
2518 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
2520 my $reason = new FS::reason({
2521 'reason_type' => $options{'reason'}->{'typenum'},
2522 'reason' => $options{'reason'}->{'reason'},
2524 my $error = $reason->insert;
2525 return $error if $error;
2527 $reasonnum = $reason->reasonnum;
2530 return "Unparsable reason: ". $options{'reason'};
2533 my $cust_pkg_reason =
2534 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
2535 'reasonnum' => $reasonnum,
2536 'otaker' => $otaker,
2537 'action' => substr(uc($options{'action'}),0,1),
2538 'date' => $options{'date'}
2543 $cust_pkg_reason->insert;
2546 =item insert_discount
2548 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
2549 inserting a new discount on the fly (see L<FS::discount>).
2551 Available options are:
2559 If there is an error, returns the error, otherwise returns false.
2563 sub insert_discount {
2564 #my ($self, %options) = @_;
2567 my $cust_pkg_discount = new FS::cust_pkg_discount {
2568 'pkgnum' => $self->pkgnum,
2569 'discountnum' => $self->discountnum,
2571 'end_date' => '', #XXX
2572 #for the create a new discount case
2573 '_type' => $self->discountnum__type,
2574 'amount' => $self->discountnum_amount,
2575 'percent' => $self->discountnum_percent,
2576 'months' => $self->discountnum_months,
2577 #'disabled' => $self->discountnum_disabled,
2580 $cust_pkg_discount->insert;
2583 =item set_usage USAGE_VALUE_HASHREF
2585 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2586 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2587 upbytes, downbytes, and totalbytes are appropriate keys.
2589 All svc_accts which are part of this package have their values reset.
2594 my ($self, $valueref, %opt) = @_;
2596 foreach my $cust_svc ($self->cust_svc){
2597 my $svc_x = $cust_svc->svc_x;
2598 $svc_x->set_usage($valueref, %opt)
2599 if $svc_x->can("set_usage");
2603 =item recharge USAGE_VALUE_HASHREF
2605 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2606 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2607 upbytes, downbytes, and totalbytes are appropriate keys.
2609 All svc_accts which are part of this package have their values incremented.
2614 my ($self, $valueref) = @_;
2616 foreach my $cust_svc ($self->cust_svc){
2617 my $svc_x = $cust_svc->svc_x;
2618 $svc_x->recharge($valueref)
2619 if $svc_x->can("recharge");
2623 =item cust_pkg_discount
2627 sub cust_pkg_discount {
2629 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
2632 =item cust_pkg_discount_active
2636 sub cust_pkg_discount_active {
2638 grep { $_->status eq 'active' } $self->cust_pkg_discount;
2643 =head1 CLASS METHODS
2649 Returns an SQL expression identifying recurring packages.
2653 sub recurring_sql { "
2654 '0' != ( select freq from part_pkg
2655 where cust_pkg.pkgpart = part_pkg.pkgpart )
2660 Returns an SQL expression identifying one-time packages.
2665 '0' = ( select freq from part_pkg
2666 where cust_pkg.pkgpart = part_pkg.pkgpart )
2671 Returns an SQL expression identifying ordered packages (recurring packages not
2677 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
2682 Returns an SQL expression identifying active packages.
2687 $_[0]->recurring_sql. "
2688 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
2689 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2690 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2693 =item not_yet_billed_sql
2695 Returns an SQL expression identifying packages which have not yet been billed.
2699 sub not_yet_billed_sql { "
2700 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
2701 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2702 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2707 Returns an SQL expression identifying inactive packages (one-time packages
2708 that are otherwise unsuspended/uncancelled).
2712 sub inactive_sql { "
2713 ". $_[0]->onetime_sql(). "
2714 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
2715 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2716 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2722 Returns an SQL expression identifying suspended packages.
2726 sub suspended_sql { susp_sql(@_); }
2728 #$_[0]->recurring_sql(). ' AND '.
2730 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2731 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
2738 Returns an SQL exprression identifying cancelled packages.
2742 sub cancelled_sql { cancel_sql(@_); }
2744 #$_[0]->recurring_sql(). ' AND '.
2745 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
2750 Returns an SQL expression to give the package status as a string.
2756 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
2757 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
2758 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
2759 WHEN ".onetime_sql()." THEN 'one-time charge'
2764 =item search HASHREF
2768 Returns a qsearch hash expression to search for parameters specified in HASHREF.
2769 Valid parameters are
2777 active, inactive, suspended, cancel (or cancelled)
2781 active, inactive, suspended, one-time charge, inactive, cancel (or cancelled)
2785 boolean selects custom packages
2791 pkgpart or arrayref or hashref of pkgparts
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 arrayref of beginning and ending epoch date
2823 pkgnum or APKG_pkgnum
2827 a value suited to passing to FS::UI::Web::cust_header
2831 specifies the user for agent virtualization
2835 boolean selects packages containing fcc form 477 telco lines
2842 my ($class, $params) = @_;
2849 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
2851 "cust_main.agentnum = $1";
2858 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
2860 "cust_pkg.custnum = $1";
2867 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
2869 "cust_pkg.pkgbatch = '$1'";
2876 if ( $params->{'magic'} eq 'active'
2877 || $params->{'status'} eq 'active' ) {
2879 push @where, FS::cust_pkg->active_sql();
2881 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
2882 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
2884 push @where, FS::cust_pkg->not_yet_billed_sql();
2886 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
2887 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
2889 push @where, FS::cust_pkg->inactive_sql();
2891 } elsif ( $params->{'magic'} eq 'suspended'
2892 || $params->{'status'} eq 'suspended' ) {
2894 push @where, FS::cust_pkg->suspended_sql();
2896 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
2897 || $params->{'status'} =~ /^cancell?ed$/ ) {
2899 push @where, FS::cust_pkg->cancelled_sql();
2904 # parse package class
2907 #false lazinessish w/graph/cust_bill_pkg.cgi
2910 if ( exists($params->{'classnum'})
2911 && $params->{'classnum'} =~ /^(\d*)$/
2915 if ( $classnum ) { #a specific class
2916 push @where, "part_pkg.classnum = $classnum";
2918 #@pkg_class = ( qsearchs('pkg_class', { 'classnum' => $classnum } ) );
2919 #die "classnum $classnum not found!" unless $pkg_class[0];
2920 #$title .= $pkg_class[0]->classname.' ';
2922 } elsif ( $classnum eq '' ) { #the empty class
2924 push @where, "part_pkg.classnum IS NULL";
2925 #$title .= 'Empty class ';
2926 #@pkg_class = ( '(empty class)' );
2927 } elsif ( $classnum eq '0' ) {
2928 #@pkg_class = qsearch('pkg_class', {} ); # { 'disabled' => '' } );
2929 #push @pkg_class, '(empty class)';
2931 die "illegal classnum";
2937 # parse package report options
2940 my @report_option = ();
2941 if ( exists($params->{'report_option'})
2942 && $params->{'report_option'} =~ /^([,\d]*)$/
2945 @report_option = split(',', $1);
2948 if (@report_option) {
2949 # this will result in the empty set for the dangling comma case as it should
2951 map{ "0 < ( SELECT count(*) FROM part_pkg_option
2952 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
2953 AND optionname = 'report_option_$_'
2954 AND optionvalue = '1' )"
2964 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
2970 push @where, "part_pkg.fcc_ds0s > 0" if $params->{fcc_line};
2976 if ( exists($params->{'censustract'}) ) {
2977 $params->{'censustract'} =~ /^([.\d]*)$/;
2978 my $censustract = "cust_main.censustract = '$1'";
2979 $censustract .= ' OR cust_main.censustract is NULL' unless $1;
2980 push @where, "( $censustract )";
2987 if ( ref($params->{'pkgpart'}) ) {
2990 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
2991 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
2992 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
2993 @pkgpart = @{ $params->{'pkgpart'} };
2995 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
2998 @pkgpart = grep /^(\d+)$/, @pkgpart;
3000 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
3002 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
3003 push @where, "pkgpart = $1";
3012 #false laziness w/report_cust_pkg.html
3015 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
3016 'active' => { 'susp'=>1, 'cancel'=>1 },
3017 'suspended' => { 'cancel' => 1 },
3022 if( exists($params->{'active'} ) ) {
3023 # This overrides all the other date-related fields
3024 my($beginning, $ending) = @{$params->{'active'}};
3026 "cust_pkg.setup IS NOT NULL",
3027 "cust_pkg.setup <= $ending",
3028 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
3029 "NOT (".FS::cust_pkg->onetime_sql . ")";
3032 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end cancel )) {
3034 next unless exists($params->{$field});
3036 my($beginning, $ending) = @{$params->{$field}};
3038 next if $beginning == 0 && $ending == 4294967295;
3041 "cust_pkg.$field IS NOT NULL",
3042 "cust_pkg.$field >= $beginning",
3043 "cust_pkg.$field <= $ending";
3045 $orderby ||= "ORDER BY cust_pkg.$field";
3050 $orderby ||= 'ORDER BY bill';
3053 # parse magic, legacy, etc.
3056 if ( $params->{'magic'} &&
3057 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
3060 $orderby = 'ORDER BY pkgnum';
3062 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
3063 push @where, "pkgpart = $1";
3066 } elsif ( $params->{'query'} eq 'pkgnum' ) {
3068 $orderby = 'ORDER BY pkgnum';
3070 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
3072 $orderby = 'ORDER BY pkgnum';
3075 SELECT count(*) FROM pkg_svc
3076 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
3077 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
3078 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
3079 AND cust_svc.svcpart = pkg_svc.svcpart
3086 # setup queries, links, subs, etc. for the search
3089 # here is the agent virtualization
3090 if ($params->{CurrentUser}) {
3092 qsearchs('access_user', { username => $params->{CurrentUser} });
3095 push @where, $access_user->agentnums_sql('table'=>'cust_main');
3100 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
3103 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
3105 my $addl_from = 'LEFT JOIN cust_main USING ( custnum ) '.
3106 'LEFT JOIN part_pkg USING ( pkgpart ) '.
3107 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) ';
3109 my $count_query = "SELECT COUNT(*) FROM cust_pkg $addl_from $extra_sql";
3112 'table' => 'cust_pkg',
3114 'select' => join(', ',
3116 ( map "part_pkg.$_", qw( pkg freq ) ),
3117 'pkg_class.classname',
3118 'cust_main.custnum AS cust_main_custnum',
3119 FS::UI::Web::cust_sql_fields(
3120 $params->{'cust_fields'}
3123 'extra_sql' => "$extra_sql $orderby",
3124 'addl_from' => $addl_from,
3125 'count_query' => $count_query,
3132 Returns a list of two package counts. The first is a count of packages
3133 based on the supplied criteria and the second is the count of residential
3134 packages with those same criteria. Criteria are specified as in the search
3140 my ($class, $params) = @_;
3142 my $sql_query = $class->search( $params );
3144 my $count_sql = delete($sql_query->{'count_query'});
3145 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
3146 or die "couldn't parse count_sql";
3148 my $count_sth = dbh->prepare($count_sql)
3149 or die "Error preparing $count_sql: ". dbh->errstr;
3151 or die "Error executing $count_sql: ". $count_sth->errstr;
3152 my $count_arrayref = $count_sth->fetchrow_arrayref;
3154 return ( @$count_arrayref );
3161 Returns a list: the first item is an SQL fragment identifying matching
3162 packages/customers via location (taking into account shipping and package
3163 address taxation, if enabled), and subsequent items are the parameters to
3164 substitute for the placeholders in that fragment.
3169 my($class, %opt) = @_;
3170 my $ornull = $opt{'ornull'};
3172 my $conf = new FS::Conf;
3174 # '?' placeholders in _location_sql_where
3175 my $x = $ornull ? 3 : 2;
3176 my @bill_param = ( ('city')x3, ('county')x$x, ('state')x$x, 'country' );
3180 if ( $conf->exists('tax-ship_address') ) {
3183 ( ( ship_last IS NULL OR ship_last = '' )
3184 AND ". _location_sql_where('cust_main', '', $ornull ). "
3186 OR ( ship_last IS NOT NULL AND ship_last != ''
3187 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
3190 # AND payby != 'COMP'
3192 @main_param = ( @bill_param, @bill_param );
3196 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
3197 @main_param = @bill_param;
3203 if ( $conf->exists('tax-pkg_address') ) {
3205 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
3208 ( cust_pkg.locationnum IS NULL AND $main_where )
3209 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
3212 @param = ( @main_param, @bill_param );
3216 $where = $main_where;
3217 @param = @main_param;
3225 #subroutine, helper for location_sql
3226 sub _location_sql_where {
3228 my $prefix = @_ ? shift : '';
3229 my $ornull = @_ ? shift : '';
3231 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
3233 $ornull = $ornull ? ' OR ? IS NULL ' : '';
3235 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL ) ";
3236 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL ) ";
3237 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL ) ";
3239 # ( $table.${prefix}city = ? $or_empty_city $ornull )
3241 ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS text) IS NULL )
3242 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
3243 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
3244 AND $table.${prefix}country = ?
3252 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
3254 CUSTNUM is a customer (see L<FS::cust_main>)
3256 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3257 L<FS::part_pkg>) to order for this customer. Duplicates are of course
3260 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
3261 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
3262 new billing items. An error is returned if this is not possible (see
3263 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
3266 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3267 newly-created cust_pkg objects.
3269 REFNUM, if specified, will specify the FS::pkg_referral record to be created
3270 and inserted. Multiple FS::pkg_referral records can be created by
3271 setting I<refnum> to an array reference of refnums or a hash reference with
3272 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
3273 record will be created corresponding to cust_main.refnum.
3278 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
3280 my $conf = new FS::Conf;
3282 # Transactionize this whole mess
3283 local $SIG{HUP} = 'IGNORE';
3284 local $SIG{INT} = 'IGNORE';
3285 local $SIG{QUIT} = 'IGNORE';
3286 local $SIG{TERM} = 'IGNORE';
3287 local $SIG{TSTP} = 'IGNORE';
3288 local $SIG{PIPE} = 'IGNORE';
3290 my $oldAutoCommit = $FS::UID::AutoCommit;
3291 local $FS::UID::AutoCommit = 0;
3295 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
3296 # return "Customer not found: $custnum" unless $cust_main;
3298 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
3301 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3304 my $change = scalar(@old_cust_pkg) != 0;
3307 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
3309 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
3310 " to pkgpart ". $pkgparts->[0]. "\n"
3313 my $err_or_cust_pkg =
3314 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
3315 'refnum' => $refnum,
3318 unless (ref($err_or_cust_pkg)) {
3319 $dbh->rollback if $oldAutoCommit;
3320 return $err_or_cust_pkg;
3323 push @$return_cust_pkg, $err_or_cust_pkg;
3324 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3329 # Create the new packages.
3330 foreach my $pkgpart (@$pkgparts) {
3332 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
3334 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
3335 pkgpart => $pkgpart,
3339 $error = $cust_pkg->insert( 'change' => $change );
3341 $dbh->rollback if $oldAutoCommit;
3344 push @$return_cust_pkg, $cust_pkg;
3346 # $return_cust_pkg now contains refs to all of the newly
3349 # Transfer services and cancel old packages.
3350 foreach my $old_pkg (@old_cust_pkg) {
3352 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
3355 foreach my $new_pkg (@$return_cust_pkg) {
3356 $error = $old_pkg->transfer($new_pkg);
3357 if ($error and $error == 0) {
3358 # $old_pkg->transfer failed.
3359 $dbh->rollback if $oldAutoCommit;
3364 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
3365 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
3366 foreach my $new_pkg (@$return_cust_pkg) {
3367 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
3368 if ($error and $error == 0) {
3369 # $old_pkg->transfer failed.
3370 $dbh->rollback if $oldAutoCommit;
3377 # Transfers were successful, but we went through all of the
3378 # new packages and still had services left on the old package.
3379 # We can't cancel the package under the circumstances, so abort.
3380 $dbh->rollback if $oldAutoCommit;
3381 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
3383 $error = $old_pkg->cancel( quiet=>1 );
3389 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3393 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
3395 A bulk change method to change packages for multiple customers.
3397 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3398 L<FS::part_pkg>) to order for each customer. Duplicates are of course
3401 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
3402 replace. The services (see L<FS::cust_svc>) are moved to the
3403 new billing items. An error is returned if this is not possible (see
3406 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3407 newly-created cust_pkg objects.
3412 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
3414 # Transactionize this whole mess
3415 local $SIG{HUP} = 'IGNORE';
3416 local $SIG{INT} = 'IGNORE';
3417 local $SIG{QUIT} = 'IGNORE';
3418 local $SIG{TERM} = 'IGNORE';
3419 local $SIG{TSTP} = 'IGNORE';
3420 local $SIG{PIPE} = 'IGNORE';
3422 my $oldAutoCommit = $FS::UID::AutoCommit;
3423 local $FS::UID::AutoCommit = 0;
3427 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3430 while(scalar(@old_cust_pkg)) {
3432 my $custnum = $old_cust_pkg[0]->custnum;
3433 my (@remove) = map { $_->pkgnum }
3434 grep { $_->custnum == $custnum } @old_cust_pkg;
3435 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
3437 my $error = order $custnum, $pkgparts, \@remove, \@return;
3439 push @errors, $error
3441 push @$return_cust_pkg, @return;
3444 if (scalar(@errors)) {
3445 $dbh->rollback if $oldAutoCommit;
3446 return join(' / ', @errors);
3449 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3453 # Used by FS::Upgrade to migrate to a new database.
3454 sub _upgrade_data { # class method
3455 my ($class, %opts) = @_;
3456 $class->_upgrade_otaker(%opts);
3458 # RT#10139, bug resulting in contract_end being set when it shouldn't
3459 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
3460 # RT#10830, bad calculation of prorate date near end of year
3461 # the date range for bill is December 2009, and we move it forward
3462 # one year if it's before the previous bill date (which it should
3464 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
3465 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
3466 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
3467 # RT6628, add order_date to cust_pkg
3468 'update cust_pkg set order_date = (select history_date from h_cust_pkg
3469 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
3470 history_action = \'insert\') where order_date is null',
3472 foreach my $sql (@statements) {
3473 my $sth = dbh->prepare($sql);
3474 $sth->execute or die $sth->errstr;
3482 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
3484 In sub order, the @pkgparts array (passed by reference) is clobbered.
3486 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
3487 method to pass dates to the recur_prog expression, it should do so.
3489 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
3490 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
3491 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
3492 configuration values. Probably need a subroutine which decides what to do
3493 based on whether or not we've fetched the user yet, rather than a hash. See
3494 FS::UID and the TODO.
3496 Now that things are transactional should the check in the insert method be
3501 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
3502 L<FS::pkg_svc>, schema.html from the base documentation