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;
35 # need to 'use' these instead of 'require' in sub { cancel, suspend, unsuspend,
37 # because they load configuration by setting FS::UID::callback (see TODO)
43 # for sending cancel emails in sub cancel
47 $me = '[FS::cust_pkg]';
49 $disable_agentcheck = 0;
53 my ( $hashref, $cache ) = @_;
54 #if ( $hashref->{'pkgpart'} ) {
55 if ( $hashref->{'pkg'} ) {
56 # #@{ $self->{'_pkgnum'} } = ();
57 # my $subcache = $cache->subcache('pkgpart', 'part_pkg');
58 # $self->{'_pkgpart'} = $subcache;
59 # #push @{ $self->{'_pkgnum'} },
60 # FS::part_pkg->new_or_cached($hashref, $subcache);
61 $self->{'_pkgpart'} = FS::part_pkg->new($hashref);
63 if ( exists $hashref->{'svcnum'} ) {
64 #@{ $self->{'_pkgnum'} } = ();
65 my $subcache = $cache->subcache('svcnum', 'cust_svc', $hashref->{pkgnum});
66 $self->{'_svcnum'} = $subcache;
67 #push @{ $self->{'_pkgnum'} },
68 FS::cust_svc->new_or_cached($hashref, $subcache) if $hashref->{svcnum};
74 FS::cust_pkg - Object methods for cust_pkg objects
80 $record = new FS::cust_pkg \%hash;
81 $record = new FS::cust_pkg { 'column' => 'value' };
83 $error = $record->insert;
85 $error = $new_record->replace($old_record);
87 $error = $record->delete;
89 $error = $record->check;
91 $error = $record->cancel;
93 $error = $record->suspend;
95 $error = $record->unsuspend;
97 $part_pkg = $record->part_pkg;
99 @labels = $record->labels;
101 $seconds = $record->seconds_since($timestamp);
103 $error = FS::cust_pkg::order( $custnum, \@pkgparts );
104 $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );
108 An FS::cust_pkg object represents a customer billing item. FS::cust_pkg
109 inherits from FS::Record. The following fields are currently supported:
115 Primary key (assigned automatically for new billing items)
119 Customer (see L<FS::cust_main>)
123 Billing item definition (see L<FS::part_pkg>)
127 Optional link to package location (see L<FS::location>)
131 date package was ordered (also remains same on changes)
143 date (next bill date)
171 order taker (see L<FS::access_user>)
175 If this field is set to 1, disables the automatic
176 unsuspension of this package when using the B<unsuspendauto> config option.
180 If not set, defaults to 1
184 Date of change from previous package
194 =item change_locationnum
202 Note: setup, last_bill, bill, adjourn, susp, expire, cancel and change_date
203 are specified as UNIX timestamps; see L<perlfunc/"time">. Also see
204 L<Time::Local> and L<Date::Parse> for conversion functions.
212 Create a new billing item. To add the item to the database, see L<"insert">.
216 sub table { 'cust_pkg'; }
217 sub cust_linked { $_[0]->cust_main_custnum; }
218 sub cust_unlinked_msg {
220 "WARNING: can't find cust_main.custnum ". $self->custnum.
221 ' (cust_pkg.pkgnum '. $self->pkgnum. ')';
224 =item insert [ OPTION => VALUE ... ]
226 Adds this billing item to the database ("Orders" the item). If there is an
227 error, returns the error, otherwise returns false.
229 If the additional field I<promo_code> is defined instead of I<pkgpart>, it
230 will be used to look up the package definition and agent restrictions will be
233 If the additional field I<refnum> is defined, an FS::pkg_referral record will
234 be created and inserted. Multiple FS::pkg_referral records can be created by
235 setting I<refnum> to an array reference of refnums or a hash reference with
236 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
237 record will be created corresponding to cust_main.refnum.
239 The following options are available:
245 If set true, supresses any referral credit to a referring customer.
249 cust_pkg_option records will be created
253 a ticket will be added to this customer with this subject
257 an optional queue name for ticket additions
264 my( $self, %options ) = @_;
266 my $error = $self->check_pkgpart;
267 return $error if $error;
269 if ( $self->part_pkg->option('start_1st', 1) && !$self->start_date ) {
270 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime(time) )[0,1,2,3,4,5];
271 $mon += 1 unless $mday == 1;
272 until ( $mon < 12 ) { $mon -= 12; $year++; }
273 $self->start_date( timelocal_nocheck(0,0,0,1,$mon,$year) );
276 foreach my $action ( qw(expire adjourn contract_end) ) {
277 my $months = $self->part_pkg->option("${action}_months",1);
278 if($months and !$self->$action) {
279 my $start = $self->start_date || $self->setup || time;
280 $self->$action( $self->part_pkg->add_freq($start, $months) );
284 $self->order_date(time);
286 local $SIG{HUP} = 'IGNORE';
287 local $SIG{INT} = 'IGNORE';
288 local $SIG{QUIT} = 'IGNORE';
289 local $SIG{TERM} = 'IGNORE';
290 local $SIG{TSTP} = 'IGNORE';
291 local $SIG{PIPE} = 'IGNORE';
293 my $oldAutoCommit = $FS::UID::AutoCommit;
294 local $FS::UID::AutoCommit = 0;
297 $error = $self->SUPER::insert($options{options} ? %{$options{options}} : ());
299 $dbh->rollback if $oldAutoCommit;
303 $self->refnum($self->cust_main->refnum) unless $self->refnum;
304 $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
305 $self->process_m2m( 'link_table' => 'pkg_referral',
306 'target_table' => 'part_referral',
307 'params' => $self->refnum,
310 if ( $self->discountnum ) {
311 my $error = $self->insert_discount();
313 $dbh->rollback if $oldAutoCommit;
318 #if ( $self->reg_code ) {
319 # my $reg_code = qsearchs('reg_code', { 'code' => $self->reg_code } );
320 # $error = $reg_code->delete;
322 # $dbh->rollback if $oldAutoCommit;
327 my $conf = new FS::Conf;
329 if ( $conf->config('ticket_system') && $options{ticket_subject} ) {
332 # use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
339 use FS::TicketSystem;
340 FS::TicketSystem->init();
342 my $q = new RT::Queue($RT::SystemUser);
343 $q->Load($options{ticket_queue}) if $options{ticket_queue};
344 my $t = new RT::Ticket($RT::SystemUser);
345 my $mime = new MIME::Entity;
346 $mime->build( Type => 'text/plain', Data => $options{ticket_subject} );
347 $t->Create( $options{ticket_queue} ? (Queue => $q) : (),
348 Subject => $options{ticket_subject},
351 $t->AddLink( Type => 'MemberOf',
352 Target => 'freeside://freeside/cust_main/'. $self->custnum,
356 if ($conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
357 my $queue = new FS::queue {
358 'job' => 'FS::cust_main::queueable_print',
360 $error = $queue->insert(
361 'custnum' => $self->custnum,
362 'template' => 'welcome_letter',
366 warn "can't send welcome letter: $error";
371 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
378 This method now works but you probably shouldn't use it.
380 You don't want to delete packages, because there would then be no record
381 the customer ever purchased the package. Instead, see the cancel method and
382 hide cancelled packages.
389 local $SIG{HUP} = 'IGNORE';
390 local $SIG{INT} = 'IGNORE';
391 local $SIG{QUIT} = 'IGNORE';
392 local $SIG{TERM} = 'IGNORE';
393 local $SIG{TSTP} = 'IGNORE';
394 local $SIG{PIPE} = 'IGNORE';
396 my $oldAutoCommit = $FS::UID::AutoCommit;
397 local $FS::UID::AutoCommit = 0;
400 foreach my $cust_pkg_discount ($self->cust_pkg_discount) {
401 my $error = $cust_pkg_discount->delete;
403 $dbh->rollback if $oldAutoCommit;
407 #cust_bill_pkg_discount?
409 foreach my $cust_pkg_detail ($self->cust_pkg_detail) {
410 my $error = $cust_pkg_detail->delete;
412 $dbh->rollback if $oldAutoCommit;
417 foreach my $cust_pkg_reason (
419 'table' => 'cust_pkg_reason',
420 'hashref' => { 'pkgnum' => $self->pkgnum },
424 my $error = $cust_pkg_reason->delete;
426 $dbh->rollback if $oldAutoCommit;
433 my $error = $self->SUPER::delete(@_);
435 $dbh->rollback if $oldAutoCommit;
439 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
445 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
447 Replaces the OLD_RECORD with this one in the database. If there is an error,
448 returns the error, otherwise returns false.
450 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
452 Changing pkgpart may have disasterous effects. See the order subroutine.
454 setup and bill are normally updated by calling the bill method of a customer
455 object (see L<FS::cust_main>).
457 suspend is normally updated by the suspend and unsuspend methods.
459 cancel is normally updated by the cancel method (and also the order subroutine
462 Available options are:
468 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.
472 the access_user (see L<FS::access_user>) providing the reason
476 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
485 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
490 ( ref($_[0]) eq 'HASH' )
494 #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
495 #return "Can't change otaker!" if $old->otaker ne $new->otaker;
498 #return "Can't change setup once it exists!"
499 # if $old->getfield('setup') &&
500 # $old->getfield('setup') != $new->getfield('setup');
502 #some logic for bill, susp, cancel?
504 local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
506 local $SIG{HUP} = 'IGNORE';
507 local $SIG{INT} = 'IGNORE';
508 local $SIG{QUIT} = 'IGNORE';
509 local $SIG{TERM} = 'IGNORE';
510 local $SIG{TSTP} = 'IGNORE';
511 local $SIG{PIPE} = 'IGNORE';
513 my $oldAutoCommit = $FS::UID::AutoCommit;
514 local $FS::UID::AutoCommit = 0;
517 foreach my $method ( qw(adjourn expire) ) { # How many reasons?
518 if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
519 my $error = $new->insert_reason(
520 'reason' => $options->{'reason'},
521 'date' => $new->$method,
523 'reason_otaker' => $options->{'reason_otaker'},
526 dbh->rollback if $oldAutoCommit;
527 return "Error inserting cust_pkg_reason: $error";
532 #save off and freeze RADIUS attributes for any associated svc_acct records
534 if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
536 #also check for specific exports?
537 # to avoid spurious modify export events
538 @svc_acct = map { $_->svc_x }
539 grep { $_->part_svc->svcdb eq 'svc_acct' }
542 $_->snapshot foreach @svc_acct;
546 my $error = $new->SUPER::replace($old,
547 $options->{options} ? $options->{options} : ()
550 $dbh->rollback if $oldAutoCommit;
554 #for prepaid packages,
555 #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
556 foreach my $old_svc_acct ( @svc_acct ) {
557 my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
559 $new_svc_acct->replace( $old_svc_acct,
560 'depend_jobnum' => $options->{depend_jobnum},
563 $dbh->rollback if $oldAutoCommit;
568 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
575 Checks all fields to make sure this is a valid billing item. If there is an
576 error, returns the error, otherwise returns false. Called by the insert and
584 $self->locationnum('') if !$self->locationnum || $self->locationnum == -1;
587 $self->ut_numbern('pkgnum')
588 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
589 || $self->ut_numbern('pkgpart')
590 || $self->check_pkgpart
591 || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
592 || $self->ut_numbern('start_date')
593 || $self->ut_numbern('setup')
594 || $self->ut_numbern('bill')
595 || $self->ut_numbern('susp')
596 || $self->ut_numbern('cancel')
597 || $self->ut_numbern('adjourn')
598 || $self->ut_numbern('expire')
599 || $self->ut_numbern('dundate')
600 || $self->ut_enum('no_auto', [ '', 'Y' ])
601 || $self->ut_enum('waive_setup', [ '', 'Y' ])
602 || $self->ut_numbern('agent_pkgid')
604 return $error if $error;
606 return "A package with both start date (future start) and setup date (already started) will never bill"
607 if $self->start_date && $self->setup;
609 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
611 if ( $self->dbdef_table->column('manual_flag') ) {
612 $self->manual_flag('') if $self->manual_flag eq ' ';
613 $self->manual_flag =~ /^([01]?)$/
614 or return "Illegal manual_flag ". $self->manual_flag;
615 $self->manual_flag($1);
628 my $error = $self->ut_numbern('pkgpart');
629 return $error if $error;
631 if ( $self->reg_code ) {
633 unless ( grep { $self->pkgpart == $_->pkgpart }
634 map { $_->reg_code_pkg }
635 qsearchs( 'reg_code', { 'code' => $self->reg_code,
636 'agentnum' => $self->cust_main->agentnum })
638 return "Unknown registration code";
641 } elsif ( $self->promo_code ) {
644 qsearchs('part_pkg', {
645 'pkgpart' => $self->pkgpart,
646 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
648 return 'Unknown promotional code' unless $promo_part_pkg;
652 unless ( $disable_agentcheck ) {
654 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
655 return "agent ". $agent->agentnum. ':'. $agent->agent.
656 " can't purchase pkgpart ". $self->pkgpart
657 unless $agent->pkgpart_hashref->{ $self->pkgpart }
658 || $agent->agentnum == $self->part_pkg->agentnum;
661 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
662 return $error if $error;
670 =item cancel [ OPTION => VALUE ... ]
672 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
673 in this package, then cancels the package itself (sets the cancel field to
676 Available options are:
680 =item quiet - can be set true to supress email cancellation notices.
682 =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.
684 =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.
686 =item date - can be set to a unix style timestamp to specify when to cancel (expire)
688 =item nobill - can be set true to skip billing if it might otherwise be done.
690 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
691 not credit it. This must be set (by change()) when changing the package
692 to a different pkgpart or location, and probably shouldn't be in any other
693 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
698 If there is an error, returns the error, otherwise returns false.
703 my( $self, %options ) = @_;
706 my $conf = new FS::Conf;
708 warn "cust_pkg::cancel called with options".
709 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
712 local $SIG{HUP} = 'IGNORE';
713 local $SIG{INT} = 'IGNORE';
714 local $SIG{QUIT} = 'IGNORE';
715 local $SIG{TERM} = 'IGNORE';
716 local $SIG{TSTP} = 'IGNORE';
717 local $SIG{PIPE} = 'IGNORE';
719 my $oldAutoCommit = $FS::UID::AutoCommit;
720 local $FS::UID::AutoCommit = 0;
723 my $old = $self->select_for_update;
725 if ( $old->get('cancel') || $self->get('cancel') ) {
726 dbh->rollback if $oldAutoCommit;
727 return ""; # no error
730 my $date = $options{date} if $options{date}; # expire/cancel later
731 $date = '' if ($date && $date <= time); # complain instead?
733 #race condition: usage could be ongoing until unprovisioned
734 #resolved by performing a change package instead (which unprovisions) and
736 if ( !$options{nobill} && !$date && $conf->exists('bill_usage_on_cancel') ) {
737 my $copy = $self->new({$self->hash});
739 $copy->cust_main->bill( pkg_list => [ $copy ], cancel => 1 );
740 warn "Error billing during cancel, custnum ".
741 #$self->cust_main->custnum. ": $error"
746 my $cancel_time = $options{'time'} || time;
748 if ( $options{'reason'} ) {
749 $error = $self->insert_reason( 'reason' => $options{'reason'},
750 'action' => $date ? 'expire' : 'cancel',
751 'date' => $date ? $date : $cancel_time,
752 'reason_otaker' => $options{'reason_otaker'},
755 dbh->rollback if $oldAutoCommit;
756 return "Error inserting cust_pkg_reason: $error";
760 my %svc_cancel_opt = ();
761 $svc_cancel_opt{'date'} = $date if $date;
762 foreach my $cust_svc (
765 sort { $a->[1] <=> $b->[1] }
766 map { [ $_, $_->svc_x->table_info->{'cancel_weight'} ]; }
767 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
769 my $part_svc = $cust_svc->part_svc;
770 next if ( defined($part_svc) and $part_svc->preserve );
771 my $error = $cust_svc->cancel( %svc_cancel_opt );
774 $dbh->rollback if $oldAutoCommit;
775 return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
782 # Add a credit for remaining service
783 my $last_bill = $self->getfield('last_bill') || 0;
784 my $next_bill = $self->getfield('bill') || 0;
786 if ( exists($options{'unused_credit'}) ) {
787 $do_credit = $options{'unused_credit'};
790 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
793 and $last_bill > 0 # the package has been billed
794 and $next_bill > 0 # the package has a next bill date
795 and $next_bill >= $cancel_time # which is in the future
797 my $remaining_value = $self->calc_remain('time' => $cancel_time);
798 if ( $remaining_value > 0 ) {
799 my $error = $self->cust_main->credit(
801 'Credit for unused time on '. $self->part_pkg->pkg,
802 'reason_type' => $conf->config('cancel_credit_type'),
805 $dbh->rollback if $oldAutoCommit;
806 return "Error crediting customer \$$remaining_value for unused time".
807 " on ". $self->part_pkg->pkg. ": $error";
809 } #if $remaining_value
814 my %hash = $self->hash;
815 $date ? ($hash{'expire'} = $date) : ($hash{'cancel'} = $cancel_time);
816 my $new = new FS::cust_pkg ( \%hash );
817 $error = $new->replace( $self, options => { $self->options } );
819 $dbh->rollback if $oldAutoCommit;
823 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
824 return '' if $date; #no errors
826 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
827 if ( !$options{'quiet'} &&
828 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
830 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
833 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
834 $error = $msg_template->send( 'cust_main' => $self->cust_main,
839 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
840 'to' => \@invoicing_list,
841 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
842 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
845 #should this do something on errors?
852 =item cancel_if_expired [ NOW_TIMESTAMP ]
854 Cancels this package if its expire date has been reached.
858 sub cancel_if_expired {
860 my $time = shift || time;
861 return '' unless $self->expire && $self->expire <= $time;
862 my $error = $self->cancel;
864 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
865 $self->custnum. ": $error";
872 Cancels any pending expiration (sets the expire field to null).
874 If there is an error, returns the error, otherwise returns false.
879 my( $self, %options ) = @_;
882 local $SIG{HUP} = 'IGNORE';
883 local $SIG{INT} = 'IGNORE';
884 local $SIG{QUIT} = 'IGNORE';
885 local $SIG{TERM} = 'IGNORE';
886 local $SIG{TSTP} = 'IGNORE';
887 local $SIG{PIPE} = 'IGNORE';
889 my $oldAutoCommit = $FS::UID::AutoCommit;
890 local $FS::UID::AutoCommit = 0;
893 my $old = $self->select_for_update;
895 my $pkgnum = $old->pkgnum;
896 if ( $old->get('cancel') || $self->get('cancel') ) {
897 dbh->rollback if $oldAutoCommit;
898 return "Can't unexpire cancelled package $pkgnum";
899 # or at least it's pointless
902 unless ( $old->get('expire') && $self->get('expire') ) {
903 dbh->rollback if $oldAutoCommit;
904 return ""; # no error
907 my %hash = $self->hash;
908 $hash{'expire'} = '';
909 my $new = new FS::cust_pkg ( \%hash );
910 $error = $new->replace( $self, options => { $self->options } );
912 $dbh->rollback if $oldAutoCommit;
916 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
922 =item suspend [ OPTION => VALUE ... ]
924 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
925 package, then suspends the package itself (sets the susp field to now).
927 Available options are:
931 =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.
933 =item date - can be set to a unix style timestamp to specify when to suspend (adjourn)
937 If there is an error, returns the error, otherwise returns false.
942 my( $self, %options ) = @_;
945 local $SIG{HUP} = 'IGNORE';
946 local $SIG{INT} = 'IGNORE';
947 local $SIG{QUIT} = 'IGNORE';
948 local $SIG{TERM} = 'IGNORE';
949 local $SIG{TSTP} = 'IGNORE';
950 local $SIG{PIPE} = 'IGNORE';
952 my $oldAutoCommit = $FS::UID::AutoCommit;
953 local $FS::UID::AutoCommit = 0;
956 my $old = $self->select_for_update;
958 my $pkgnum = $old->pkgnum;
959 if ( $old->get('cancel') || $self->get('cancel') ) {
960 dbh->rollback if $oldAutoCommit;
961 return "Can't suspend cancelled package $pkgnum";
964 if ( $old->get('susp') || $self->get('susp') ) {
965 dbh->rollback if $oldAutoCommit;
966 return ""; # no error # complain on adjourn?
969 my $date = $options{date} if $options{date}; # adjourn/suspend later
970 $date = '' if ($date && $date <= time); # complain instead?
972 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
973 dbh->rollback if $oldAutoCommit;
974 return "Package $pkgnum expires before it would be suspended.";
977 my $suspend_time = $options{'time'} || time;
979 if ( $options{'reason'} ) {
980 $error = $self->insert_reason( 'reason' => $options{'reason'},
981 'action' => $date ? 'adjourn' : 'suspend',
982 'date' => $date ? $date : $suspend_time,
983 'reason_otaker' => $options{'reason_otaker'},
986 dbh->rollback if $oldAutoCommit;
987 return "Error inserting cust_pkg_reason: $error";
995 foreach my $cust_svc (
996 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
998 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1000 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1001 $dbh->rollback if $oldAutoCommit;
1002 return "Illegal svcdb value in part_svc!";
1005 require "FS/$svcdb.pm";
1007 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1009 $error = $svc->suspend;
1011 $dbh->rollback if $oldAutoCommit;
1014 my( $label, $value ) = $cust_svc->label;
1015 push @labels, "$label: $value";
1019 my $conf = new FS::Conf;
1020 if ( $conf->config('suspend_email_admin') ) {
1022 my $error = send_email(
1023 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1024 #invoice_from ??? well as good as any
1025 'to' => $conf->config('suspend_email_admin'),
1026 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1028 "This is an automatic message from your Freeside installation\n",
1029 "informing you that the following customer package has been suspended:\n",
1031 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1032 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1033 ( map { "Service : $_\n" } @labels ),
1038 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1046 my %hash = $self->hash;
1048 $hash{'adjourn'} = $date;
1050 $hash{'susp'} = $suspend_time;
1052 my $new = new FS::cust_pkg ( \%hash );
1053 $error = $new->replace( $self, options => { $self->options } );
1055 $dbh->rollback if $oldAutoCommit;
1059 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1064 =item unsuspend [ OPTION => VALUE ... ]
1066 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1067 package, then unsuspends the package itself (clears the susp field and the
1068 adjourn field if it is in the past).
1070 Available options are:
1074 =item adjust_next_bill
1076 Can be set true to adjust the next bill date forward by
1077 the amount of time the account was inactive. This was set true by default
1078 since 1.4.2 and 1.5.0pre6; however, starting with 1.7.0 this needs to be
1079 explicitly requested. Price plans for which this makes sense (anniversary-date
1080 based than prorate or subscription) could have an option to enable this
1085 If there is an error, returns the error, otherwise returns false.
1090 my( $self, %opt ) = @_;
1093 local $SIG{HUP} = 'IGNORE';
1094 local $SIG{INT} = 'IGNORE';
1095 local $SIG{QUIT} = 'IGNORE';
1096 local $SIG{TERM} = 'IGNORE';
1097 local $SIG{TSTP} = 'IGNORE';
1098 local $SIG{PIPE} = 'IGNORE';
1100 my $oldAutoCommit = $FS::UID::AutoCommit;
1101 local $FS::UID::AutoCommit = 0;
1104 my $old = $self->select_for_update;
1106 my $pkgnum = $old->pkgnum;
1107 if ( $old->get('cancel') || $self->get('cancel') ) {
1108 dbh->rollback if $oldAutoCommit;
1109 return "Can't unsuspend cancelled package $pkgnum";
1112 unless ( $old->get('susp') && $self->get('susp') ) {
1113 dbh->rollback if $oldAutoCommit;
1114 return ""; # no error # complain instead?
1117 foreach my $cust_svc (
1118 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1120 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1122 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1123 $dbh->rollback if $oldAutoCommit;
1124 return "Illegal svcdb value in part_svc!";
1127 require "FS/$svcdb.pm";
1129 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1131 $error = $svc->unsuspend;
1133 $dbh->rollback if $oldAutoCommit;
1140 my %hash = $self->hash;
1141 my $inactive = time - $hash{'susp'};
1143 my $conf = new FS::Conf;
1145 if ( $inactive > 0 &&
1146 ( $hash{'bill'} || $hash{'setup'} ) &&
1147 ( $opt{'adjust_next_bill'} ||
1148 $conf->exists('unsuspend-always_adjust_next_bill_date') ||
1149 $self->part_pkg->option('unsuspend_adjust_bill', 1) )
1152 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1157 $hash{'adjourn'} = '' if $hash{'adjourn'} < time;
1158 my $new = new FS::cust_pkg ( \%hash );
1159 $error = $new->replace( $self, options => { $self->options } );
1161 $dbh->rollback if $oldAutoCommit;
1165 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1172 Cancels any pending suspension (sets the adjourn field to null).
1174 If there is an error, returns the error, otherwise returns false.
1179 my( $self, %options ) = @_;
1182 local $SIG{HUP} = 'IGNORE';
1183 local $SIG{INT} = 'IGNORE';
1184 local $SIG{QUIT} = 'IGNORE';
1185 local $SIG{TERM} = 'IGNORE';
1186 local $SIG{TSTP} = 'IGNORE';
1187 local $SIG{PIPE} = 'IGNORE';
1189 my $oldAutoCommit = $FS::UID::AutoCommit;
1190 local $FS::UID::AutoCommit = 0;
1193 my $old = $self->select_for_update;
1195 my $pkgnum = $old->pkgnum;
1196 if ( $old->get('cancel') || $self->get('cancel') ) {
1197 dbh->rollback if $oldAutoCommit;
1198 return "Can't unadjourn cancelled package $pkgnum";
1199 # or at least it's pointless
1202 if ( $old->get('susp') || $self->get('susp') ) {
1203 dbh->rollback if $oldAutoCommit;
1204 return "Can't unadjourn suspended package $pkgnum";
1205 # perhaps this is arbitrary
1208 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1209 dbh->rollback if $oldAutoCommit;
1210 return ""; # no error
1213 my %hash = $self->hash;
1214 $hash{'adjourn'} = '';
1215 my $new = new FS::cust_pkg ( \%hash );
1216 $error = $new->replace( $self, options => { $self->options } );
1218 $dbh->rollback if $oldAutoCommit;
1222 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1229 =item change HASHREF | OPTION => VALUE ...
1231 Changes this package: cancels it and creates a new one, with a different
1232 pkgpart or locationnum or both. All services are transferred to the new
1233 package (no change will be made if this is not possible).
1235 Options may be passed as a list of key/value pairs or as a hash reference.
1242 New locationnum, to change the location for this package.
1246 New FS::cust_location object, to create a new location and assign it
1251 New pkgpart (see L<FS::part_pkg>).
1255 New refnum (see L<FS::part_referral>).
1259 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1260 susp, adjourn, cancel, expire, and contract_end) to the new package.
1264 At least one of locationnum, cust_location, pkgpart, refnum must be specified
1265 (otherwise, what's the point?)
1267 Returns either the new FS::cust_pkg object or a scalar error.
1271 my $err_or_new_cust_pkg = $old_cust_pkg->change
1275 #some false laziness w/order
1278 my $opt = ref($_[0]) ? shift : { @_ };
1280 # my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
1283 my $conf = new FS::Conf;
1285 # Transactionize this whole mess
1286 local $SIG{HUP} = 'IGNORE';
1287 local $SIG{INT} = 'IGNORE';
1288 local $SIG{QUIT} = 'IGNORE';
1289 local $SIG{TERM} = 'IGNORE';
1290 local $SIG{TSTP} = 'IGNORE';
1291 local $SIG{PIPE} = 'IGNORE';
1293 my $oldAutoCommit = $FS::UID::AutoCommit;
1294 local $FS::UID::AutoCommit = 0;
1303 #$hash{$_} = $self->$_() foreach qw( last_bill bill );
1305 #$hash{$_} = $self->$_() foreach qw( setup );
1307 $hash{'setup'} = $time if $self->setup;
1309 $hash{'change_date'} = $time;
1310 $hash{"change_$_"} = $self->$_()
1311 foreach qw( pkgnum pkgpart locationnum );
1313 if ( $opt->{'cust_location'} &&
1314 ( ! $opt->{'locationnum'} || $opt->{'locationnum'} == -1 ) ) {
1315 $error = $opt->{'cust_location'}->insert;
1317 $dbh->rollback if $oldAutoCommit;
1318 return "inserting cust_location (transaction rolled back): $error";
1320 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1323 my $unused_credit = 0;
1324 if ( $opt->{'keep_dates'} ) {
1325 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1326 start_date contract_end ) ) {
1327 $hash{$date} = $self->getfield($date);
1330 # Special case. If the pkgpart is changing, and the customer is
1331 # going to be credited for remaining time, don't keep setup, bill,
1332 # or last_bill dates, and DO pass the flag to cancel() to credit
1334 if ( $opt->{'pkgpart'}
1335 and $opt->{'pkgpart'} != $self->pkgpart
1336 and $self->part_pkg->option('unused_credit_change', 1) ) {
1338 $hash{$_} = '' foreach qw(setup bill last_bill);
1341 # Create the new package.
1342 my $cust_pkg = new FS::cust_pkg {
1343 custnum => $self->custnum,
1344 pkgpart => ( $opt->{'pkgpart'} || $self->pkgpart ),
1345 refnum => ( $opt->{'refnum'} || $self->refnum ),
1346 locationnum => ( $opt->{'locationnum'} || $self->locationnum ),
1350 $error = $cust_pkg->insert( 'change' => 1 );
1352 $dbh->rollback if $oldAutoCommit;
1356 # Transfer services and cancel old package.
1358 $error = $self->transfer($cust_pkg);
1359 if ($error and $error == 0) {
1360 # $old_pkg->transfer failed.
1361 $dbh->rollback if $oldAutoCommit;
1365 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
1366 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
1367 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
1368 if ($error and $error == 0) {
1369 # $old_pkg->transfer failed.
1370 $dbh->rollback if $oldAutoCommit;
1376 # Transfers were successful, but we still had services left on the old
1377 # package. We can't change the package under this circumstances, so abort.
1378 $dbh->rollback if $oldAutoCommit;
1379 return "Unable to transfer all services from package ". $self->pkgnum;
1382 #reset usage if changing pkgpart
1383 # AND usage rollover is off (otherwise adds twice, now and at package bill)
1384 if ($self->pkgpart != $cust_pkg->pkgpart) {
1385 my $part_pkg = $cust_pkg->part_pkg;
1386 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
1390 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
1393 $dbh->rollback if $oldAutoCommit;
1394 return "Error setting usage values: $error";
1398 #Good to go, cancel old package. Notify 'cancel' of whether to credit
1400 $error = $self->cancel( quiet=>1, unused_credit => $unused_credit );
1402 $dbh->rollback if $oldAutoCommit;
1406 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
1408 my $error = $cust_pkg->cust_main->bill( 'pkg_list' => [ $cust_pkg ] );
1410 $dbh->rollback if $oldAutoCommit;
1415 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1421 use Storable 'thaw';
1423 sub process_bulk_cust_pkg {
1425 my $param = thaw(decode_base64(shift));
1426 warn Dumper($param) if $DEBUG;
1428 my $old_part_pkg = qsearchs('part_pkg',
1429 { pkgpart => $param->{'old_pkgpart'} });
1430 my $new_part_pkg = qsearchs('part_pkg',
1431 { pkgpart => $param->{'new_pkgpart'} });
1432 die "Must select a new package type\n" unless $new_part_pkg;
1433 #my $keep_dates = $param->{'keep_dates'} || 0;
1434 my $keep_dates = 1; # there is no good reason to turn this off
1436 local $SIG{HUP} = 'IGNORE';
1437 local $SIG{INT} = 'IGNORE';
1438 local $SIG{QUIT} = 'IGNORE';
1439 local $SIG{TERM} = 'IGNORE';
1440 local $SIG{TSTP} = 'IGNORE';
1441 local $SIG{PIPE} = 'IGNORE';
1443 my $oldAutoCommit = $FS::UID::AutoCommit;
1444 local $FS::UID::AutoCommit = 0;
1447 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
1450 foreach my $old_cust_pkg ( @cust_pkgs ) {
1452 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
1453 if ( $old_cust_pkg->getfield('cancel') ) {
1454 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
1455 $old_cust_pkg->pkgnum."\n"
1459 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
1461 my $error = $old_cust_pkg->change(
1462 'pkgpart' => $param->{'new_pkgpart'},
1463 'keep_dates' => $keep_dates
1465 if ( !ref($error) ) { # change returns the cust_pkg on success
1467 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
1470 $dbh->commit if $oldAutoCommit;
1476 Returns the last bill date, or if there is no last bill date, the setup date.
1477 Useful for billing metered services.
1483 return $self->setfield('last_bill', $_[0]) if @_;
1484 return $self->getfield('last_bill') if $self->getfield('last_bill');
1485 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
1486 'edate' => $self->bill, } );
1487 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
1490 =item last_cust_pkg_reason ACTION
1492 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
1493 Returns false if there is no reason or the package is not currenly ACTION'd
1494 ACTION is one of adjourn, susp, cancel, or expire.
1498 sub last_cust_pkg_reason {
1499 my ( $self, $action ) = ( shift, shift );
1500 my $date = $self->get($action);
1502 'table' => 'cust_pkg_reason',
1503 'hashref' => { 'pkgnum' => $self->pkgnum,
1504 'action' => substr(uc($action), 0, 1),
1507 'order_by' => 'ORDER BY num DESC LIMIT 1',
1511 =item last_reason ACTION
1513 Returns the most recent ACTION FS::reason associated with the package.
1514 Returns false if there is no reason or the package is not currenly ACTION'd
1515 ACTION is one of adjourn, susp, cancel, or expire.
1520 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
1521 $cust_pkg_reason->reason
1522 if $cust_pkg_reason;
1527 Returns the definition for this billing item, as an FS::part_pkg object (see
1534 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
1535 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
1536 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
1541 Returns the cancelled package this package was changed from, if any.
1547 return '' unless $self->change_pkgnum;
1548 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
1553 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
1560 $self->part_pkg->calc_setup($self, @_);
1565 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
1572 $self->part_pkg->calc_recur($self, @_);
1577 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
1584 $self->part_pkg->base_recur($self, @_);
1589 Calls the I<calc_remain> of the FS::part_pkg object associated with this
1596 $self->part_pkg->calc_remain($self, @_);
1601 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
1608 $self->part_pkg->calc_cancel($self, @_);
1613 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
1619 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
1622 =item cust_pkg_detail [ DETAILTYPE ]
1624 Returns any customer package details for this package (see
1625 L<FS::cust_pkg_detail>).
1627 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1631 sub cust_pkg_detail {
1633 my %hash = ( 'pkgnum' => $self->pkgnum );
1634 $hash{detailtype} = shift if @_;
1636 'table' => 'cust_pkg_detail',
1637 'hashref' => \%hash,
1638 'order_by' => 'ORDER BY weight, pkgdetailnum',
1642 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
1644 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
1646 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1648 If there is an error, returns the error, otherwise returns false.
1652 sub set_cust_pkg_detail {
1653 my( $self, $detailtype, @details ) = @_;
1655 local $SIG{HUP} = 'IGNORE';
1656 local $SIG{INT} = 'IGNORE';
1657 local $SIG{QUIT} = 'IGNORE';
1658 local $SIG{TERM} = 'IGNORE';
1659 local $SIG{TSTP} = 'IGNORE';
1660 local $SIG{PIPE} = 'IGNORE';
1662 my $oldAutoCommit = $FS::UID::AutoCommit;
1663 local $FS::UID::AutoCommit = 0;
1666 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
1667 my $error = $current->delete;
1669 $dbh->rollback if $oldAutoCommit;
1670 return "error removing old detail: $error";
1674 foreach my $detail ( @details ) {
1675 my $cust_pkg_detail = new FS::cust_pkg_detail {
1676 'pkgnum' => $self->pkgnum,
1677 'detailtype' => $detailtype,
1678 'detail' => $detail,
1680 my $error = $cust_pkg_detail->insert;
1682 $dbh->rollback if $oldAutoCommit;
1683 return "error adding new detail: $error";
1688 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1695 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
1699 #false laziness w/cust_bill.pm
1703 'table' => 'cust_event',
1704 'addl_from' => 'JOIN part_event USING ( eventpart )',
1705 'hashref' => { 'tablenum' => $self->pkgnum },
1706 'extra_sql' => " AND eventtable = 'cust_pkg' ",
1710 =item num_cust_event
1712 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
1716 #false laziness w/cust_bill.pm
1717 sub num_cust_event {
1720 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
1721 " WHERE tablenum = ? AND eventtable = 'cust_pkg'";
1722 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
1723 $sth->execute($self->pkgnum) or die $sth->errstr. " executing $sql";
1724 $sth->fetchrow_arrayref->[0];
1727 =item cust_svc [ SVCPART ]
1729 Returns the services for this package, as FS::cust_svc objects (see
1730 L<FS::cust_svc>). If a svcpart is specified, return only the matching
1738 return () unless $self->num_cust_svc(@_);
1741 return qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum,
1742 'svcpart' => shift, } );
1745 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
1747 #if ( $self->{'_svcnum'} ) {
1748 # values %{ $self->{'_svcnum'}->cache };
1750 $self->_sort_cust_svc(
1751 [ qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } ) ]
1757 =item overlimit [ SVCPART ]
1759 Returns the services for this package which have exceeded their
1760 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
1761 is specified, return only the matching services.
1767 return () unless $self->num_cust_svc(@_);
1768 grep { $_->overlimit } $self->cust_svc(@_);
1771 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
1773 Returns historical services for this package created before END TIMESTAMP and
1774 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
1775 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
1776 I<pkg_svc.hidden> flag will be omitted.
1782 warn "$me _h_cust_svc called on $self\n"
1785 my ($end, $start, $mode) = @_;
1786 my @cust_svc = $self->_sort_cust_svc(
1787 [ qsearch( 'h_cust_svc',
1788 { 'pkgnum' => $self->pkgnum, },
1789 FS::h_cust_svc->sql_h_search(@_),
1792 if ( $mode eq 'I' ) {
1793 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
1794 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
1800 sub _sort_cust_svc {
1801 my( $self, $arrayref ) = @_;
1804 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
1809 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $self->pkgpart,
1810 'svcpart' => $_->svcpart } );
1812 $pkg_svc ? $pkg_svc->primary_svc : '',
1813 $pkg_svc ? $pkg_svc->quantity : 0,
1820 =item num_cust_svc [ SVCPART ]
1822 Returns the number of provisioned services for this package. If a svcpart is
1823 specified, counts only the matching services.
1830 return $self->{'_num_cust_svc'}
1832 && exists($self->{'_num_cust_svc'})
1833 && $self->{'_num_cust_svc'} =~ /\d/;
1835 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
1838 my $sql = 'SELECT COUNT(*) FROM cust_svc WHERE pkgnum = ?';
1839 $sql .= ' AND svcpart = ?' if @_;
1841 my $sth = dbh->prepare($sql) or die dbh->errstr;
1842 $sth->execute($self->pkgnum, @_) or die $sth->errstr;
1843 $sth->fetchrow_arrayref->[0];
1846 =item available_part_svc
1848 Returns a list of FS::part_svc objects representing services included in this
1849 package but not yet provisioned. Each FS::part_svc object also has an extra
1850 field, I<num_avail>, which specifies the number of available services.
1854 sub available_part_svc {
1856 grep { $_->num_avail > 0 }
1858 my $part_svc = $_->part_svc;
1859 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
1860 $_->quantity - $self->num_cust_svc($_->svcpart);
1862 # more evil encapsulation breakage
1863 if($part_svc->{'Hash'}{'num_avail'} > 0) {
1864 my @exports = $part_svc->part_export_did;
1865 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
1870 $self->part_pkg->pkg_svc;
1875 Returns a list of FS::part_svc objects representing provisioned and available
1876 services included in this package. Each FS::part_svc object also has the
1877 following extra fields:
1881 =item num_cust_svc (count)
1883 =item num_avail (quantity - count)
1885 =item cust_pkg_svc (services) - array reference containing the provisioned services, as cust_svc objects
1888 label -> ($cust_svc->label)[1]
1897 #XXX some sort of sort order besides numeric by svcpart...
1898 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
1900 my $part_svc = $pkg_svc->part_svc;
1901 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
1902 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
1903 $part_svc->{'Hash'}{'num_avail'} =
1904 max( 0, $pkg_svc->quantity - $num_cust_svc );
1905 $part_svc->{'Hash'}{'cust_pkg_svc'} =
1906 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
1907 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
1909 } $self->part_pkg->pkg_svc;
1912 push @part_svc, map {
1914 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
1915 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
1916 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
1917 $part_svc->{'Hash'}{'cust_pkg_svc'} =
1918 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
1920 } $self->extra_part_svc;
1926 =item extra_part_svc
1928 Returns a list of FS::part_svc objects corresponding to services in this
1929 package which are still provisioned but not (any longer) available in the
1934 sub extra_part_svc {
1937 my $pkgnum = $self->pkgnum;
1938 my $pkgpart = $self->pkgpart;
1941 # 'table' => 'part_svc',
1944 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
1945 # WHERE pkg_svc.svcpart = part_svc.svcpart
1946 # AND pkg_svc.pkgpart = ?
1949 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
1950 # LEFT JOIN cust_pkg USING ( pkgnum )
1951 # WHERE cust_svc.svcpart = part_svc.svcpart
1954 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
1957 #seems to benchmark slightly faster...
1959 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
1960 #MySQL doesn't grok DISINCT ON
1961 'select' => 'DISTINCT part_svc.*',
1962 'table' => 'part_svc',
1964 'LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
1965 AND pkg_svc.pkgpart = ?
1968 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
1969 LEFT JOIN cust_pkg USING ( pkgnum )
1972 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
1973 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
1979 Returns a short status string for this package, currently:
1983 =item not yet billed
1985 =item one-time charge
2000 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
2002 return 'cancelled' if $self->get('cancel');
2003 return 'suspended' if $self->susp;
2004 return 'not yet billed' unless $self->setup;
2005 return 'one-time charge' if $freq =~ /^(0|$)/;
2009 =item ucfirst_status
2011 Returns the status with the first character capitalized.
2015 sub ucfirst_status {
2016 ucfirst(shift->status);
2021 Class method that returns the list of possible status strings for packages
2022 (see L<the status method|/status>). For example:
2024 @statuses = FS::cust_pkg->statuses();
2028 tie my %statuscolor, 'Tie::IxHash',
2029 'not yet billed' => '009999', #teal? cyan?
2030 'one-time charge' => '000000',
2031 'active' => '00CC00',
2032 'suspended' => 'FF9900',
2033 'cancelled' => 'FF0000',
2037 my $self = shift; #could be class...
2038 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
2039 # # mayble split btw one-time vs. recur
2045 Returns a hex triplet color string for this package's status.
2051 $statuscolor{$self->status};
2056 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
2057 "pkg-comment" depending on user preference).
2063 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
2064 $label = $self->pkgnum. ": $label"
2065 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
2069 =item pkg_label_long
2071 Returns a long label for this package, adding the primary service's label to
2076 sub pkg_label_long {
2078 my $label = $self->pkg_label;
2079 my $cust_svc = $self->primary_cust_svc;
2080 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
2084 =item primary_cust_svc
2086 Returns a primary service (as FS::cust_svc object) if one can be identified.
2090 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
2092 sub primary_cust_svc {
2095 my @cust_svc = $self->cust_svc;
2097 return '' unless @cust_svc; #no serivces - irrelevant then
2099 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
2101 # primary service as specified in the package definition
2102 # or exactly one service definition with quantity one
2103 my $svcpart = $self->part_pkg->svcpart;
2104 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
2105 return $cust_svc[0] if scalar(@cust_svc) == 1;
2107 #couldn't identify one thing..
2113 Returns a list of lists, calling the label method for all services
2114 (see L<FS::cust_svc>) of this billing item.
2120 map { [ $_->label ] } $self->cust_svc;
2123 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2125 Like the labels method, but returns historical information on services that
2126 were active as of END_TIMESTAMP and (optionally) not cancelled before
2127 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
2128 I<pkg_svc.hidden> flag will be omitted.
2130 Returns a list of lists, calling the label method for all (historical) services
2131 (see L<FS::h_cust_svc>) of this billing item.
2137 warn "$me _h_labels called on $self\n"
2139 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
2144 Like 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.
2152 shift->_labels_short( 'labels', @_ );
2155 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
2157 Like h_labels, except returns a simple flat list, and shortens long
2158 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2159 identical services to one line that lists the service label and the number of
2160 individual services rather than individual items.
2164 sub h_labels_short {
2165 shift->_labels_short( 'h_labels', @_ );
2169 my( $self, $method ) = ( shift, shift );
2171 warn "$me _labels_short called on $self with $method method\n"
2174 my $conf = new FS::Conf;
2175 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
2177 warn "$me _labels_short populating \%labels\n"
2181 #tie %labels, 'Tie::IxHash';
2182 push @{ $labels{$_->[0]} }, $_->[1]
2183 foreach $self->$method(@_);
2185 warn "$me _labels_short populating \@labels\n"
2189 foreach my $label ( keys %labels ) {
2191 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
2192 my $num = scalar(@values);
2193 warn "$me _labels_short $num items for $label\n"
2196 if ( $num > $max_same_services ) {
2197 warn "$me _labels_short more than $max_same_services, so summarizing\n"
2199 push @labels, "$label ($num)";
2201 if ( $conf->exists('cust_bill-consolidate_services') ) {
2202 warn "$me _labels_short consolidating services\n"
2204 # push @labels, "$label: ". join(', ', @values);
2206 my $detail = "$label: ";
2207 $detail .= shift(@values). ', '
2209 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
2211 push @labels, $detail;
2213 warn "$me _labels_short done consolidating services\n"
2216 warn "$me _labels_short adding service data\n"
2218 push @labels, map { "$label: $_" } @values;
2229 Returns the parent customer object (see L<FS::cust_main>).
2235 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
2238 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
2242 Returns the location object, if any (see L<FS::cust_location>).
2244 =item cust_location_or_main
2246 If this package is associated with a location, returns the locaiton (see
2247 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
2249 =item location_label [ OPTION => VALUE ... ]
2251 Returns the label of the location object (see L<FS::cust_location>).
2255 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
2257 =item seconds_since TIMESTAMP
2259 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
2260 package have been online since TIMESTAMP, according to the session monitor.
2262 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2263 L<Time::Local> and L<Date::Parse> for conversion functions.
2268 my($self, $since) = @_;
2271 foreach my $cust_svc (
2272 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
2274 $seconds += $cust_svc->seconds_since($since);
2281 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
2283 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
2284 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
2287 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2288 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2294 sub seconds_since_sqlradacct {
2295 my($self, $start, $end) = @_;
2299 foreach my $cust_svc (
2301 my $part_svc = $_->part_svc;
2302 $part_svc->svcdb eq 'svc_acct'
2303 && scalar($part_svc->part_export('sqlradius'));
2306 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
2313 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
2315 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
2316 in this package for sessions ending between TIMESTAMP_START (inclusive) and
2320 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2321 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2326 sub attribute_since_sqlradacct {
2327 my($self, $start, $end, $attrib) = @_;
2331 foreach my $cust_svc (
2333 my $part_svc = $_->part_svc;
2334 $part_svc->svcdb eq 'svc_acct'
2335 && scalar($part_svc->part_export('sqlradius'));
2338 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
2350 my( $self, $value ) = @_;
2351 if ( defined($value) ) {
2352 $self->setfield('quantity', $value);
2354 $self->getfield('quantity') || 1;
2357 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
2359 Transfers as many services as possible from this package to another package.
2361 The destination package can be specified by pkgnum by passing an FS::cust_pkg
2362 object. The destination package must already exist.
2364 Services are moved only if the destination allows services with the correct
2365 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
2366 this option with caution! No provision is made for export differences
2367 between the old and new service definitions. Probably only should be used
2368 when your exports for all service definitions of a given svcdb are identical.
2369 (attempt a transfer without it first, to move all possible svcpart-matching
2372 Any services that can't be moved remain in the original package.
2374 Returns an error, if there is one; otherwise, returns the number of services
2375 that couldn't be moved.
2380 my ($self, $dest_pkgnum, %opt) = @_;
2386 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
2387 $dest = $dest_pkgnum;
2388 $dest_pkgnum = $dest->pkgnum;
2390 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
2393 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
2395 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
2396 $target{$pkg_svc->svcpart} = $pkg_svc->quantity;
2399 foreach my $cust_svc ($dest->cust_svc) {
2400 $target{$cust_svc->svcpart}--;
2403 my %svcpart2svcparts = ();
2404 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2405 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
2406 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
2407 next if exists $svcpart2svcparts{$svcpart};
2408 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
2409 $svcpart2svcparts{$svcpart} = [
2411 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
2413 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
2414 'svcpart' => $_ } );
2416 $pkg_svc ? $pkg_svc->primary_svc : '',
2417 $pkg_svc ? $pkg_svc->quantity : 0,
2421 grep { $_ != $svcpart }
2423 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
2425 warn "alternates for svcpart $svcpart: ".
2426 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
2431 foreach my $cust_svc ($self->cust_svc) {
2432 if($target{$cust_svc->svcpart} > 0) {
2433 $target{$cust_svc->svcpart}--;
2434 my $new = new FS::cust_svc { $cust_svc->hash };
2435 $new->pkgnum($dest_pkgnum);
2436 my $error = $new->replace($cust_svc);
2437 return $error if $error;
2438 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2440 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
2441 warn "alternates to consider: ".
2442 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
2444 my @alternate = grep {
2445 warn "considering alternate svcpart $_: ".
2446 "$target{$_} available in new package\n"
2449 } @{$svcpart2svcparts{$cust_svc->svcpart}};
2451 warn "alternate(s) found\n" if $DEBUG;
2452 my $change_svcpart = $alternate[0];
2453 $target{$change_svcpart}--;
2454 my $new = new FS::cust_svc { $cust_svc->hash };
2455 $new->svcpart($change_svcpart);
2456 $new->pkgnum($dest_pkgnum);
2457 my $error = $new->replace($cust_svc);
2458 return $error if $error;
2471 This method is deprecated. See the I<depend_jobnum> option to the insert and
2472 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
2479 local $SIG{HUP} = 'IGNORE';
2480 local $SIG{INT} = 'IGNORE';
2481 local $SIG{QUIT} = 'IGNORE';
2482 local $SIG{TERM} = 'IGNORE';
2483 local $SIG{TSTP} = 'IGNORE';
2484 local $SIG{PIPE} = 'IGNORE';
2486 my $oldAutoCommit = $FS::UID::AutoCommit;
2487 local $FS::UID::AutoCommit = 0;
2490 foreach my $cust_svc ( $self->cust_svc ) {
2491 #false laziness w/svc_Common::insert
2492 my $svc_x = $cust_svc->svc_x;
2493 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
2494 my $error = $part_export->export_insert($svc_x);
2496 $dbh->rollback if $oldAutoCommit;
2502 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2509 Associates this package with a (suspension or cancellation) reason (see
2510 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
2513 Available options are:
2519 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.
2523 the access_user (see L<FS::access_user>) providing the reason
2531 the action (cancel, susp, adjourn, expire) associated with the reason
2535 If there is an error, returns the error, otherwise returns false.
2540 my ($self, %options) = @_;
2542 my $otaker = $options{reason_otaker} ||
2543 $FS::CurrentUser::CurrentUser->username;
2546 if ( $options{'reason'} =~ /^(\d+)$/ ) {
2550 } elsif ( ref($options{'reason'}) ) {
2552 return 'Enter a new reason (or select an existing one)'
2553 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
2555 my $reason = new FS::reason({
2556 'reason_type' => $options{'reason'}->{'typenum'},
2557 'reason' => $options{'reason'}->{'reason'},
2559 my $error = $reason->insert;
2560 return $error if $error;
2562 $reasonnum = $reason->reasonnum;
2565 return "Unparsable reason: ". $options{'reason'};
2568 my $cust_pkg_reason =
2569 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
2570 'reasonnum' => $reasonnum,
2571 'otaker' => $otaker,
2572 'action' => substr(uc($options{'action'}),0,1),
2573 'date' => $options{'date'}
2578 $cust_pkg_reason->insert;
2581 =item insert_discount
2583 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
2584 inserting a new discount on the fly (see L<FS::discount>).
2586 Available options are:
2594 If there is an error, returns the error, otherwise returns false.
2598 sub insert_discount {
2599 #my ($self, %options) = @_;
2602 my $cust_pkg_discount = new FS::cust_pkg_discount {
2603 'pkgnum' => $self->pkgnum,
2604 'discountnum' => $self->discountnum,
2606 'end_date' => '', #XXX
2607 #for the create a new discount case
2608 '_type' => $self->discountnum__type,
2609 'amount' => $self->discountnum_amount,
2610 'percent' => $self->discountnum_percent,
2611 'months' => $self->discountnum_months,
2612 'setup' => $self->discountnum_setup,
2613 #'disabled' => $self->discountnum_disabled,
2616 $cust_pkg_discount->insert;
2619 =item set_usage USAGE_VALUE_HASHREF
2621 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2622 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2623 upbytes, downbytes, and totalbytes are appropriate keys.
2625 All svc_accts which are part of this package have their values reset.
2630 my ($self, $valueref, %opt) = @_;
2632 foreach my $cust_svc ($self->cust_svc){
2633 my $svc_x = $cust_svc->svc_x;
2634 $svc_x->set_usage($valueref, %opt)
2635 if $svc_x->can("set_usage");
2639 =item recharge USAGE_VALUE_HASHREF
2641 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2642 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2643 upbytes, downbytes, and totalbytes are appropriate keys.
2645 All svc_accts which are part of this package have their values incremented.
2650 my ($self, $valueref) = @_;
2652 foreach my $cust_svc ($self->cust_svc){
2653 my $svc_x = $cust_svc->svc_x;
2654 $svc_x->recharge($valueref)
2655 if $svc_x->can("recharge");
2659 =item cust_pkg_discount
2663 sub cust_pkg_discount {
2665 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
2668 =item cust_pkg_discount_active
2672 sub cust_pkg_discount_active {
2674 grep { $_->status eq 'active' } $self->cust_pkg_discount;
2679 =head1 CLASS METHODS
2685 Returns an SQL expression identifying recurring packages.
2689 sub recurring_sql { "
2690 '0' != ( select freq from part_pkg
2691 where cust_pkg.pkgpart = part_pkg.pkgpart )
2696 Returns an SQL expression identifying one-time packages.
2701 '0' = ( select freq from part_pkg
2702 where cust_pkg.pkgpart = part_pkg.pkgpart )
2707 Returns an SQL expression identifying ordered packages (recurring packages not
2713 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
2718 Returns an SQL expression identifying active packages.
2723 $_[0]->recurring_sql. "
2724 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
2725 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2726 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2729 =item not_yet_billed_sql
2731 Returns an SQL expression identifying packages which have not yet been billed.
2735 sub not_yet_billed_sql { "
2736 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
2737 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2738 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2743 Returns an SQL expression identifying inactive packages (one-time packages
2744 that are otherwise unsuspended/uncancelled).
2748 sub inactive_sql { "
2749 ". $_[0]->onetime_sql(). "
2750 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
2751 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2752 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2758 Returns an SQL expression identifying suspended packages.
2762 sub suspended_sql { susp_sql(@_); }
2764 #$_[0]->recurring_sql(). ' AND '.
2766 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2767 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
2774 Returns an SQL exprression identifying cancelled packages.
2778 sub cancelled_sql { cancel_sql(@_); }
2780 #$_[0]->recurring_sql(). ' AND '.
2781 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
2786 Returns an SQL expression to give the package status as a string.
2792 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
2793 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
2794 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
2795 WHEN ".onetime_sql()." THEN 'one-time charge'
2800 =item search HASHREF
2804 Returns a qsearch hash expression to search for parameters specified in HASHREF.
2805 Valid parameters are
2813 active, inactive, suspended, cancel (or cancelled)
2817 active, inactive, suspended, one-time charge, inactive, cancel (or cancelled)
2821 boolean selects custom packages
2827 pkgpart or arrayref or hashref of pkgparts
2831 arrayref of beginning and ending epoch date
2835 arrayref of beginning and ending epoch date
2839 arrayref of beginning and ending epoch date
2843 arrayref of beginning and ending epoch date
2847 arrayref of beginning and ending epoch date
2851 arrayref of beginning and ending epoch date
2855 arrayref of beginning and ending epoch date
2859 pkgnum or APKG_pkgnum
2863 a value suited to passing to FS::UI::Web::cust_header
2867 specifies the user for agent virtualization
2871 boolean selects packages containing fcc form 477 telco lines
2878 my ($class, $params) = @_;
2885 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
2887 "cust_main.agentnum = $1";
2894 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
2896 "cust_pkg.custnum = $1";
2903 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
2905 "cust_pkg.pkgbatch = '$1'";
2912 if ( $params->{'magic'} eq 'active'
2913 || $params->{'status'} eq 'active' ) {
2915 push @where, FS::cust_pkg->active_sql();
2917 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
2918 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
2920 push @where, FS::cust_pkg->not_yet_billed_sql();
2922 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
2923 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
2925 push @where, FS::cust_pkg->inactive_sql();
2927 } elsif ( $params->{'magic'} eq 'suspended'
2928 || $params->{'status'} eq 'suspended' ) {
2930 push @where, FS::cust_pkg->suspended_sql();
2932 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
2933 || $params->{'status'} =~ /^cancell?ed$/ ) {
2935 push @where, FS::cust_pkg->cancelled_sql();
2940 # parse package class
2943 #false lazinessish w/graph/cust_bill_pkg.cgi
2946 if ( exists($params->{'classnum'})
2947 && $params->{'classnum'} =~ /^(\d*)$/
2951 if ( $classnum ) { #a specific class
2952 push @where, "part_pkg.classnum = $classnum";
2954 #@pkg_class = ( qsearchs('pkg_class', { 'classnum' => $classnum } ) );
2955 #die "classnum $classnum not found!" unless $pkg_class[0];
2956 #$title .= $pkg_class[0]->classname.' ';
2958 } elsif ( $classnum eq '' ) { #the empty class
2960 push @where, "part_pkg.classnum IS NULL";
2961 #$title .= 'Empty class ';
2962 #@pkg_class = ( '(empty class)' );
2963 } elsif ( $classnum eq '0' ) {
2964 #@pkg_class = qsearch('pkg_class', {} ); # { 'disabled' => '' } );
2965 #push @pkg_class, '(empty class)';
2967 die "illegal classnum";
2973 # parse package report options
2976 my @report_option = ();
2977 if ( exists($params->{'report_option'})
2978 && $params->{'report_option'} =~ /^([,\d]*)$/
2981 @report_option = split(',', $1);
2984 if (@report_option) {
2985 # this will result in the empty set for the dangling comma case as it should
2987 map{ "0 < ( SELECT count(*) FROM part_pkg_option
2988 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
2989 AND optionname = 'report_option_$_'
2990 AND optionvalue = '1' )"
3000 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
3006 push @where, "part_pkg.fcc_ds0s > 0" if $params->{fcc_line};
3012 if ( exists($params->{'censustract'}) ) {
3013 $params->{'censustract'} =~ /^([.\d]*)$/;
3014 my $censustract = "cust_main.censustract = '$1'";
3015 $censustract .= ' OR cust_main.censustract is NULL' unless $1;
3016 push @where, "( $censustract )";
3023 if ( ref($params->{'pkgpart'}) ) {
3026 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
3027 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
3028 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
3029 @pkgpart = @{ $params->{'pkgpart'} };
3031 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
3034 @pkgpart = grep /^(\d+)$/, @pkgpart;
3036 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
3038 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
3039 push @where, "pkgpart = $1";
3048 #false laziness w/report_cust_pkg.html
3051 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
3052 'active' => { 'susp'=>1, 'cancel'=>1 },
3053 'suspended' => { 'cancel' => 1 },
3058 if( exists($params->{'active'} ) ) {
3059 # This overrides all the other date-related fields
3060 my($beginning, $ending) = @{$params->{'active'}};
3062 "cust_pkg.setup IS NOT NULL",
3063 "cust_pkg.setup <= $ending",
3064 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
3065 "NOT (".FS::cust_pkg->onetime_sql . ")";
3068 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end cancel )) {
3070 next unless exists($params->{$field});
3072 my($beginning, $ending) = @{$params->{$field}};
3074 next if $beginning == 0 && $ending == 4294967295;
3077 "cust_pkg.$field IS NOT NULL",
3078 "cust_pkg.$field >= $beginning",
3079 "cust_pkg.$field <= $ending";
3081 $orderby ||= "ORDER BY cust_pkg.$field";
3086 $orderby ||= 'ORDER BY bill';
3089 # parse magic, legacy, etc.
3092 if ( $params->{'magic'} &&
3093 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
3096 $orderby = 'ORDER BY pkgnum';
3098 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
3099 push @where, "pkgpart = $1";
3102 } elsif ( $params->{'query'} eq 'pkgnum' ) {
3104 $orderby = 'ORDER BY pkgnum';
3106 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
3108 $orderby = 'ORDER BY pkgnum';
3111 SELECT count(*) FROM pkg_svc
3112 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
3113 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
3114 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
3115 AND cust_svc.svcpart = pkg_svc.svcpart
3122 # setup queries, links, subs, etc. for the search
3125 # here is the agent virtualization
3126 if ($params->{CurrentUser}) {
3128 qsearchs('access_user', { username => $params->{CurrentUser} });
3131 push @where, $access_user->agentnums_sql('table'=>'cust_main');
3136 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
3139 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
3141 my $addl_from = 'LEFT JOIN cust_main USING ( custnum ) '.
3142 'LEFT JOIN part_pkg USING ( pkgpart ) '.
3143 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) ';
3145 my $count_query = "SELECT COUNT(*) FROM cust_pkg $addl_from $extra_sql";
3148 'table' => 'cust_pkg',
3150 'select' => join(', ',
3152 ( map "part_pkg.$_", qw( pkg freq ) ),
3153 'pkg_class.classname',
3154 'cust_main.custnum AS cust_main_custnum',
3155 FS::UI::Web::cust_sql_fields(
3156 $params->{'cust_fields'}
3159 'extra_sql' => "$extra_sql $orderby",
3160 'addl_from' => $addl_from,
3161 'count_query' => $count_query,
3168 Returns a list of two package counts. The first is a count of packages
3169 based on the supplied criteria and the second is the count of residential
3170 packages with those same criteria. Criteria are specified as in the search
3176 my ($class, $params) = @_;
3178 my $sql_query = $class->search( $params );
3180 my $count_sql = delete($sql_query->{'count_query'});
3181 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
3182 or die "couldn't parse count_sql";
3184 my $count_sth = dbh->prepare($count_sql)
3185 or die "Error preparing $count_sql: ". dbh->errstr;
3187 or die "Error executing $count_sql: ". $count_sth->errstr;
3188 my $count_arrayref = $count_sth->fetchrow_arrayref;
3190 return ( @$count_arrayref );
3197 Returns a list: the first item is an SQL fragment identifying matching
3198 packages/customers via location (taking into account shipping and package
3199 address taxation, if enabled), and subsequent items are the parameters to
3200 substitute for the placeholders in that fragment.
3205 my($class, %opt) = @_;
3206 my $ornull = $opt{'ornull'};
3208 my $conf = new FS::Conf;
3210 # '?' placeholders in _location_sql_where
3211 my $x = $ornull ? 3 : 2;
3212 my @bill_param = ( ('city')x3, ('county')x$x, ('state')x$x, 'country' );
3216 if ( $conf->exists('tax-ship_address') ) {
3219 ( ( ship_last IS NULL OR ship_last = '' )
3220 AND ". _location_sql_where('cust_main', '', $ornull ). "
3222 OR ( ship_last IS NOT NULL AND ship_last != ''
3223 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
3226 # AND payby != 'COMP'
3228 @main_param = ( @bill_param, @bill_param );
3232 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
3233 @main_param = @bill_param;
3239 if ( $conf->exists('tax-pkg_address') ) {
3241 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
3244 ( cust_pkg.locationnum IS NULL AND $main_where )
3245 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
3248 @param = ( @main_param, @bill_param );
3252 $where = $main_where;
3253 @param = @main_param;
3261 #subroutine, helper for location_sql
3262 sub _location_sql_where {
3264 my $prefix = @_ ? shift : '';
3265 my $ornull = @_ ? shift : '';
3267 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
3269 $ornull = $ornull ? ' OR ? IS NULL ' : '';
3271 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL ) ";
3272 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL ) ";
3273 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL ) ";
3275 # ( $table.${prefix}city = ? $or_empty_city $ornull )
3277 ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS text) IS NULL )
3278 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
3279 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
3280 AND $table.${prefix}country = ?
3288 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
3290 CUSTNUM is a customer (see L<FS::cust_main>)
3292 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3293 L<FS::part_pkg>) to order for this customer. Duplicates are of course
3296 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
3297 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
3298 new billing items. An error is returned if this is not possible (see
3299 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
3302 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3303 newly-created cust_pkg objects.
3305 REFNUM, if specified, will specify the FS::pkg_referral record to be created
3306 and inserted. Multiple FS::pkg_referral records can be created by
3307 setting I<refnum> to an array reference of refnums or a hash reference with
3308 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
3309 record will be created corresponding to cust_main.refnum.
3314 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
3316 my $conf = new FS::Conf;
3318 # Transactionize this whole mess
3319 local $SIG{HUP} = 'IGNORE';
3320 local $SIG{INT} = 'IGNORE';
3321 local $SIG{QUIT} = 'IGNORE';
3322 local $SIG{TERM} = 'IGNORE';
3323 local $SIG{TSTP} = 'IGNORE';
3324 local $SIG{PIPE} = 'IGNORE';
3326 my $oldAutoCommit = $FS::UID::AutoCommit;
3327 local $FS::UID::AutoCommit = 0;
3331 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
3332 # return "Customer not found: $custnum" unless $cust_main;
3334 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
3337 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3340 my $change = scalar(@old_cust_pkg) != 0;
3343 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
3345 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
3346 " to pkgpart ". $pkgparts->[0]. "\n"
3349 my $err_or_cust_pkg =
3350 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
3351 'refnum' => $refnum,
3354 unless (ref($err_or_cust_pkg)) {
3355 $dbh->rollback if $oldAutoCommit;
3356 return $err_or_cust_pkg;
3359 push @$return_cust_pkg, $err_or_cust_pkg;
3360 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3365 # Create the new packages.
3366 foreach my $pkgpart (@$pkgparts) {
3368 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
3370 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
3371 pkgpart => $pkgpart,
3375 $error = $cust_pkg->insert( 'change' => $change );
3377 $dbh->rollback if $oldAutoCommit;
3380 push @$return_cust_pkg, $cust_pkg;
3382 # $return_cust_pkg now contains refs to all of the newly
3385 # Transfer services and cancel old packages.
3386 foreach my $old_pkg (@old_cust_pkg) {
3388 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
3391 foreach my $new_pkg (@$return_cust_pkg) {
3392 $error = $old_pkg->transfer($new_pkg);
3393 if ($error and $error == 0) {
3394 # $old_pkg->transfer failed.
3395 $dbh->rollback if $oldAutoCommit;
3400 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
3401 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
3402 foreach my $new_pkg (@$return_cust_pkg) {
3403 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
3404 if ($error and $error == 0) {
3405 # $old_pkg->transfer failed.
3406 $dbh->rollback if $oldAutoCommit;
3413 # Transfers were successful, but we went through all of the
3414 # new packages and still had services left on the old package.
3415 # We can't cancel the package under the circumstances, so abort.
3416 $dbh->rollback if $oldAutoCommit;
3417 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
3419 $error = $old_pkg->cancel( quiet=>1 );
3425 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3429 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
3431 A bulk change method to change packages for multiple customers.
3433 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3434 L<FS::part_pkg>) to order for each customer. Duplicates are of course
3437 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
3438 replace. The services (see L<FS::cust_svc>) are moved to the
3439 new billing items. An error is returned if this is not possible (see
3442 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3443 newly-created cust_pkg objects.
3448 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
3450 # Transactionize this whole mess
3451 local $SIG{HUP} = 'IGNORE';
3452 local $SIG{INT} = 'IGNORE';
3453 local $SIG{QUIT} = 'IGNORE';
3454 local $SIG{TERM} = 'IGNORE';
3455 local $SIG{TSTP} = 'IGNORE';
3456 local $SIG{PIPE} = 'IGNORE';
3458 my $oldAutoCommit = $FS::UID::AutoCommit;
3459 local $FS::UID::AutoCommit = 0;
3463 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3466 while(scalar(@old_cust_pkg)) {
3468 my $custnum = $old_cust_pkg[0]->custnum;
3469 my (@remove) = map { $_->pkgnum }
3470 grep { $_->custnum == $custnum } @old_cust_pkg;
3471 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
3473 my $error = order $custnum, $pkgparts, \@remove, \@return;
3475 push @errors, $error
3477 push @$return_cust_pkg, @return;
3480 if (scalar(@errors)) {
3481 $dbh->rollback if $oldAutoCommit;
3482 return join(' / ', @errors);
3485 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3489 # Used by FS::Upgrade to migrate to a new database.
3490 sub _upgrade_data { # class method
3491 my ($class, %opts) = @_;
3492 $class->_upgrade_otaker(%opts);
3494 # RT#10139, bug resulting in contract_end being set when it shouldn't
3495 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
3496 # RT#10830, bad calculation of prorate date near end of year
3497 # the date range for bill is December 2009, and we move it forward
3498 # one year if it's before the previous bill date (which it should
3500 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
3501 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
3502 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
3503 # RT6628, add order_date to cust_pkg
3504 'update cust_pkg set order_date = (select history_date from h_cust_pkg
3505 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
3506 history_action = \'insert\') where order_date is null',
3508 foreach my $sql (@statements) {
3509 my $sth = dbh->prepare($sql);
3510 $sth->execute or die $sth->errstr;
3518 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
3520 In sub order, the @pkgparts array (passed by reference) is clobbered.
3522 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
3523 method to pass dates to the recur_prog expression, it should do so.
3525 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
3526 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
3527 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
3528 configuration values. Probably need a subroutine which decides what to do
3529 based on whether or not we've fetched the user yet, rather than a hash. See
3530 FS::UID and the TODO.
3532 Now that things are transactional should the check in the insert method be
3537 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
3538 L<FS::pkg_svc>, schema.html from the base documentation