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_enum('no_auto', [ '', 'Y' ])
600 || $self->ut_enum('waive_setup', [ '', 'Y' ])
601 || $self->ut_numbern('agent_pkgid')
603 return $error if $error;
605 return "A package with both start date (future start) and setup date (already started) will never bill"
606 if $self->start_date && $self->setup;
608 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
610 if ( $self->dbdef_table->column('manual_flag') ) {
611 $self->manual_flag('') if $self->manual_flag eq ' ';
612 $self->manual_flag =~ /^([01]?)$/
613 or return "Illegal manual_flag ". $self->manual_flag;
614 $self->manual_flag($1);
627 my $error = $self->ut_numbern('pkgpart');
628 return $error if $error;
630 if ( $self->reg_code ) {
632 unless ( grep { $self->pkgpart == $_->pkgpart }
633 map { $_->reg_code_pkg }
634 qsearchs( 'reg_code', { 'code' => $self->reg_code,
635 'agentnum' => $self->cust_main->agentnum })
637 return "Unknown registration code";
640 } elsif ( $self->promo_code ) {
643 qsearchs('part_pkg', {
644 'pkgpart' => $self->pkgpart,
645 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
647 return 'Unknown promotional code' unless $promo_part_pkg;
651 unless ( $disable_agentcheck ) {
653 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
654 return "agent ". $agent->agentnum. ':'. $agent->agent.
655 " can't purchase pkgpart ". $self->pkgpart
656 unless $agent->pkgpart_hashref->{ $self->pkgpart }
657 || $agent->agentnum == $self->part_pkg->agentnum;
660 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
661 return $error if $error;
669 =item cancel [ OPTION => VALUE ... ]
671 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
672 in this package, then cancels the package itself (sets the cancel field to
675 Available options are:
679 =item quiet - can be set true to supress email cancellation notices.
681 =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.
683 =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.
685 =item date - can be set to a unix style timestamp to specify when to cancel (expire)
687 =item nobill - can be set true to skip billing if it might otherwise be done.
689 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
690 not credit it. This must be set (by change()) when changing the package
691 to a different pkgpart or location, and probably shouldn't be in any other
692 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
697 If there is an error, returns the error, otherwise returns false.
702 my( $self, %options ) = @_;
705 my $conf = new FS::Conf;
707 warn "cust_pkg::cancel called with options".
708 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
711 local $SIG{HUP} = 'IGNORE';
712 local $SIG{INT} = 'IGNORE';
713 local $SIG{QUIT} = 'IGNORE';
714 local $SIG{TERM} = 'IGNORE';
715 local $SIG{TSTP} = 'IGNORE';
716 local $SIG{PIPE} = 'IGNORE';
718 my $oldAutoCommit = $FS::UID::AutoCommit;
719 local $FS::UID::AutoCommit = 0;
722 my $old = $self->select_for_update;
724 if ( $old->get('cancel') || $self->get('cancel') ) {
725 dbh->rollback if $oldAutoCommit;
726 return ""; # no error
729 my $date = $options{date} if $options{date}; # expire/cancel later
730 $date = '' if ($date && $date <= time); # complain instead?
732 #race condition: usage could be ongoing until unprovisioned
733 #resolved by performing a change package instead (which unprovisions) and
735 if ( !$options{nobill} && !$date && $conf->exists('bill_usage_on_cancel') ) {
736 my $copy = $self->new({$self->hash});
738 $copy->cust_main->bill( pkg_list => [ $copy ], cancel => 1 );
739 warn "Error billing during cancel, custnum ".
740 #$self->cust_main->custnum. ": $error"
745 my $cancel_time = $options{'time'} || time;
747 if ( $options{'reason'} ) {
748 $error = $self->insert_reason( 'reason' => $options{'reason'},
749 'action' => $date ? 'expire' : 'cancel',
750 'date' => $date ? $date : $cancel_time,
751 'reason_otaker' => $options{'reason_otaker'},
754 dbh->rollback if $oldAutoCommit;
755 return "Error inserting cust_pkg_reason: $error";
761 foreach my $cust_svc (
764 sort { $a->[1] <=> $b->[1] }
765 map { [ $_, $_->svc_x->table_info->{'cancel_weight'} ]; }
766 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
768 my $error = $cust_svc->cancel;
771 $dbh->rollback if $oldAutoCommit;
772 return "Error cancelling cust_svc: $error";
776 # Add a credit for remaining service
777 my $last_bill = $self->getfield('last_bill') || 0;
778 my $next_bill = $self->getfield('bill') || 0;
780 if ( exists($options{'unused_credit'}) ) {
781 $do_credit = $options{'unused_credit'};
784 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
787 and $last_bill > 0 # the package has been billed
788 and $next_bill > 0 # the package has a next bill date
789 and $next_bill >= $cancel_time # which is in the future
791 my $remaining_value = $self->calc_remain('time' => $cancel_time);
792 if ( $remaining_value > 0 ) {
793 my $error = $self->cust_main->credit(
795 'Credit for unused time on '. $self->part_pkg->pkg,
796 'reason_type' => $conf->config('cancel_credit_type'),
799 $dbh->rollback if $oldAutoCommit;
800 return "Error crediting customer \$$remaining_value for unused time".
801 " on ". $self->part_pkg->pkg. ": $error";
803 } #if $remaining_value
808 my %hash = $self->hash;
809 $date ? ($hash{'expire'} = $date) : ($hash{'cancel'} = $cancel_time);
810 my $new = new FS::cust_pkg ( \%hash );
811 $error = $new->replace( $self, options => { $self->options } );
813 $dbh->rollback if $oldAutoCommit;
817 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
818 return '' if $date; #no errors
820 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
821 if ( !$options{'quiet'} &&
822 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
824 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
827 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
828 $error = $msg_template->send( 'cust_main' => $self->cust_main,
833 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
834 'to' => \@invoicing_list,
835 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
836 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
839 #should this do something on errors?
846 =item cancel_if_expired [ NOW_TIMESTAMP ]
848 Cancels this package if its expire date has been reached.
852 sub cancel_if_expired {
854 my $time = shift || time;
855 return '' unless $self->expire && $self->expire <= $time;
856 my $error = $self->cancel;
858 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
859 $self->custnum. ": $error";
866 Cancels any pending expiration (sets the expire field to null).
868 If there is an error, returns the error, otherwise returns false.
873 my( $self, %options ) = @_;
876 local $SIG{HUP} = 'IGNORE';
877 local $SIG{INT} = 'IGNORE';
878 local $SIG{QUIT} = 'IGNORE';
879 local $SIG{TERM} = 'IGNORE';
880 local $SIG{TSTP} = 'IGNORE';
881 local $SIG{PIPE} = 'IGNORE';
883 my $oldAutoCommit = $FS::UID::AutoCommit;
884 local $FS::UID::AutoCommit = 0;
887 my $old = $self->select_for_update;
889 my $pkgnum = $old->pkgnum;
890 if ( $old->get('cancel') || $self->get('cancel') ) {
891 dbh->rollback if $oldAutoCommit;
892 return "Can't unexpire cancelled package $pkgnum";
893 # or at least it's pointless
896 unless ( $old->get('expire') && $self->get('expire') ) {
897 dbh->rollback if $oldAutoCommit;
898 return ""; # no error
901 my %hash = $self->hash;
902 $hash{'expire'} = '';
903 my $new = new FS::cust_pkg ( \%hash );
904 $error = $new->replace( $self, options => { $self->options } );
906 $dbh->rollback if $oldAutoCommit;
910 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
916 =item suspend [ OPTION => VALUE ... ]
918 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
919 package, then suspends the package itself (sets the susp field to now).
921 Available options are:
925 =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.
927 =item date - can be set to a unix style timestamp to specify when to suspend (adjourn)
931 If there is an error, returns the error, otherwise returns false.
936 my( $self, %options ) = @_;
939 local $SIG{HUP} = 'IGNORE';
940 local $SIG{INT} = 'IGNORE';
941 local $SIG{QUIT} = 'IGNORE';
942 local $SIG{TERM} = 'IGNORE';
943 local $SIG{TSTP} = 'IGNORE';
944 local $SIG{PIPE} = 'IGNORE';
946 my $oldAutoCommit = $FS::UID::AutoCommit;
947 local $FS::UID::AutoCommit = 0;
950 my $old = $self->select_for_update;
952 my $pkgnum = $old->pkgnum;
953 if ( $old->get('cancel') || $self->get('cancel') ) {
954 dbh->rollback if $oldAutoCommit;
955 return "Can't suspend cancelled package $pkgnum";
958 if ( $old->get('susp') || $self->get('susp') ) {
959 dbh->rollback if $oldAutoCommit;
960 return ""; # no error # complain on adjourn?
963 my $date = $options{date} if $options{date}; # adjourn/suspend later
964 $date = '' if ($date && $date <= time); # complain instead?
966 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
967 dbh->rollback if $oldAutoCommit;
968 return "Package $pkgnum expires before it would be suspended.";
971 my $suspend_time = $options{'time'} || time;
973 if ( $options{'reason'} ) {
974 $error = $self->insert_reason( 'reason' => $options{'reason'},
975 'action' => $date ? 'adjourn' : 'suspend',
976 'date' => $date ? $date : $suspend_time,
977 'reason_otaker' => $options{'reason_otaker'},
980 dbh->rollback if $oldAutoCommit;
981 return "Error inserting cust_pkg_reason: $error";
989 foreach my $cust_svc (
990 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
992 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
994 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
995 $dbh->rollback if $oldAutoCommit;
996 return "Illegal svcdb value in part_svc!";
999 require "FS/$svcdb.pm";
1001 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1003 $error = $svc->suspend;
1005 $dbh->rollback if $oldAutoCommit;
1008 my( $label, $value ) = $cust_svc->label;
1009 push @labels, "$label: $value";
1013 my $conf = new FS::Conf;
1014 if ( $conf->config('suspend_email_admin') ) {
1016 my $error = send_email(
1017 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1018 #invoice_from ??? well as good as any
1019 'to' => $conf->config('suspend_email_admin'),
1020 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1022 "This is an automatic message from your Freeside installation\n",
1023 "informing you that the following customer package has been suspended:\n",
1025 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1026 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1027 ( map { "Service : $_\n" } @labels ),
1032 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1040 my %hash = $self->hash;
1042 $hash{'adjourn'} = $date;
1044 $hash{'susp'} = $suspend_time;
1046 my $new = new FS::cust_pkg ( \%hash );
1047 $error = $new->replace( $self, options => { $self->options } );
1049 $dbh->rollback if $oldAutoCommit;
1053 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1058 =item unsuspend [ OPTION => VALUE ... ]
1060 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1061 package, then unsuspends the package itself (clears the susp field and the
1062 adjourn field if it is in the past).
1064 Available options are:
1068 =item adjust_next_bill
1070 Can be set true to adjust the next bill date forward by
1071 the amount of time the account was inactive. This was set true by default
1072 since 1.4.2 and 1.5.0pre6; however, starting with 1.7.0 this needs to be
1073 explicitly requested. Price plans for which this makes sense (anniversary-date
1074 based than prorate or subscription) could have an option to enable this
1079 If there is an error, returns the error, otherwise returns false.
1084 my( $self, %opt ) = @_;
1087 local $SIG{HUP} = 'IGNORE';
1088 local $SIG{INT} = 'IGNORE';
1089 local $SIG{QUIT} = 'IGNORE';
1090 local $SIG{TERM} = 'IGNORE';
1091 local $SIG{TSTP} = 'IGNORE';
1092 local $SIG{PIPE} = 'IGNORE';
1094 my $oldAutoCommit = $FS::UID::AutoCommit;
1095 local $FS::UID::AutoCommit = 0;
1098 my $old = $self->select_for_update;
1100 my $pkgnum = $old->pkgnum;
1101 if ( $old->get('cancel') || $self->get('cancel') ) {
1102 dbh->rollback if $oldAutoCommit;
1103 return "Can't unsuspend cancelled package $pkgnum";
1106 unless ( $old->get('susp') && $self->get('susp') ) {
1107 dbh->rollback if $oldAutoCommit;
1108 return ""; # no error # complain instead?
1111 foreach my $cust_svc (
1112 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1114 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1116 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1117 $dbh->rollback if $oldAutoCommit;
1118 return "Illegal svcdb value in part_svc!";
1121 require "FS/$svcdb.pm";
1123 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1125 $error = $svc->unsuspend;
1127 $dbh->rollback if $oldAutoCommit;
1134 my %hash = $self->hash;
1135 my $inactive = time - $hash{'susp'};
1137 my $conf = new FS::Conf;
1139 if ( $inactive > 0 &&
1140 ( $hash{'bill'} || $hash{'setup'} ) &&
1141 ( $opt{'adjust_next_bill'} ||
1142 $conf->exists('unsuspend-always_adjust_next_bill_date') ||
1143 $self->part_pkg->option('unsuspend_adjust_bill', 1) )
1146 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1151 $hash{'adjourn'} = '' if $hash{'adjourn'} < time;
1152 my $new = new FS::cust_pkg ( \%hash );
1153 $error = $new->replace( $self, options => { $self->options } );
1155 $dbh->rollback if $oldAutoCommit;
1159 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1166 Cancels any pending suspension (sets the adjourn field to null).
1168 If there is an error, returns the error, otherwise returns false.
1173 my( $self, %options ) = @_;
1176 local $SIG{HUP} = 'IGNORE';
1177 local $SIG{INT} = 'IGNORE';
1178 local $SIG{QUIT} = 'IGNORE';
1179 local $SIG{TERM} = 'IGNORE';
1180 local $SIG{TSTP} = 'IGNORE';
1181 local $SIG{PIPE} = 'IGNORE';
1183 my $oldAutoCommit = $FS::UID::AutoCommit;
1184 local $FS::UID::AutoCommit = 0;
1187 my $old = $self->select_for_update;
1189 my $pkgnum = $old->pkgnum;
1190 if ( $old->get('cancel') || $self->get('cancel') ) {
1191 dbh->rollback if $oldAutoCommit;
1192 return "Can't unadjourn cancelled package $pkgnum";
1193 # or at least it's pointless
1196 if ( $old->get('susp') || $self->get('susp') ) {
1197 dbh->rollback if $oldAutoCommit;
1198 return "Can't unadjourn suspended package $pkgnum";
1199 # perhaps this is arbitrary
1202 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1203 dbh->rollback if $oldAutoCommit;
1204 return ""; # no error
1207 my %hash = $self->hash;
1208 $hash{'adjourn'} = '';
1209 my $new = new FS::cust_pkg ( \%hash );
1210 $error = $new->replace( $self, options => { $self->options } );
1212 $dbh->rollback if $oldAutoCommit;
1216 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1223 =item change HASHREF | OPTION => VALUE ...
1225 Changes this package: cancels it and creates a new one, with a different
1226 pkgpart or locationnum or both. All services are transferred to the new
1227 package (no change will be made if this is not possible).
1229 Options may be passed as a list of key/value pairs or as a hash reference.
1236 New locationnum, to change the location for this package.
1240 New FS::cust_location object, to create a new location and assign it
1245 New pkgpart (see L<FS::part_pkg>).
1249 New refnum (see L<FS::part_referral>).
1253 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1254 susp, adjourn, cancel, expire, and contract_end) to the new package.
1258 At least one of locationnum, cust_location, pkgpart, refnum must be specified
1259 (otherwise, what's the point?)
1261 Returns either the new FS::cust_pkg object or a scalar error.
1265 my $err_or_new_cust_pkg = $old_cust_pkg->change
1269 #some false laziness w/order
1272 my $opt = ref($_[0]) ? shift : { @_ };
1274 # my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
1277 my $conf = new FS::Conf;
1279 # Transactionize this whole mess
1280 local $SIG{HUP} = 'IGNORE';
1281 local $SIG{INT} = 'IGNORE';
1282 local $SIG{QUIT} = 'IGNORE';
1283 local $SIG{TERM} = 'IGNORE';
1284 local $SIG{TSTP} = 'IGNORE';
1285 local $SIG{PIPE} = 'IGNORE';
1287 my $oldAutoCommit = $FS::UID::AutoCommit;
1288 local $FS::UID::AutoCommit = 0;
1297 #$hash{$_} = $self->$_() foreach qw( last_bill bill );
1299 #$hash{$_} = $self->$_() foreach qw( setup );
1301 $hash{'setup'} = $time if $self->setup;
1303 $hash{'change_date'} = $time;
1304 $hash{"change_$_"} = $self->$_()
1305 foreach qw( pkgnum pkgpart locationnum );
1307 if ( $opt->{'cust_location'} &&
1308 ( ! $opt->{'locationnum'} || $opt->{'locationnum'} == -1 ) ) {
1309 $error = $opt->{'cust_location'}->insert;
1311 $dbh->rollback if $oldAutoCommit;
1312 return "inserting cust_location (transaction rolled back): $error";
1314 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1317 my $unused_credit = 0;
1318 if ( $opt->{'keep_dates'} ) {
1319 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1320 start_date contract_end ) ) {
1321 $hash{$date} = $self->getfield($date);
1324 # Special case. If the pkgpart is changing, and the customer is
1325 # going to be credited for remaining time, don't keep setup, bill,
1326 # or last_bill dates, and DO pass the flag to cancel() to credit
1328 if ( $opt->{'pkgpart'}
1329 and $opt->{'pkgpart'} != $self->pkgpart
1330 and $self->part_pkg->option('unused_credit_change', 1) ) {
1332 $hash{$_} = '' foreach qw(setup bill last_bill);
1335 # Create the new package.
1336 my $cust_pkg = new FS::cust_pkg {
1337 custnum => $self->custnum,
1338 pkgpart => ( $opt->{'pkgpart'} || $self->pkgpart ),
1339 refnum => ( $opt->{'refnum'} || $self->refnum ),
1340 locationnum => ( $opt->{'locationnum'} || $self->locationnum ),
1344 $error = $cust_pkg->insert( 'change' => 1 );
1346 $dbh->rollback if $oldAutoCommit;
1350 # Transfer services and cancel old package.
1352 $error = $self->transfer($cust_pkg);
1353 if ($error and $error == 0) {
1354 # $old_pkg->transfer failed.
1355 $dbh->rollback if $oldAutoCommit;
1359 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
1360 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
1361 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
1362 if ($error and $error == 0) {
1363 # $old_pkg->transfer failed.
1364 $dbh->rollback if $oldAutoCommit;
1370 # Transfers were successful, but we still had services left on the old
1371 # package. We can't change the package under this circumstances, so abort.
1372 $dbh->rollback if $oldAutoCommit;
1373 return "Unable to transfer all services from package ". $self->pkgnum;
1376 #reset usage if changing pkgpart
1377 # AND usage rollover is off (otherwise adds twice, now and at package bill)
1378 if ($self->pkgpart != $cust_pkg->pkgpart) {
1379 my $part_pkg = $cust_pkg->part_pkg;
1380 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
1384 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
1387 $dbh->rollback if $oldAutoCommit;
1388 return "Error setting usage values: $error";
1392 #Good to go, cancel old package. Notify 'cancel' of whether to credit
1394 $error = $self->cancel( quiet=>1, unused_credit => $unused_credit );
1396 $dbh->rollback if $oldAutoCommit;
1400 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
1402 my $error = $cust_pkg->cust_main->bill( 'pkg_list' => [ $cust_pkg ] );
1404 $dbh->rollback if $oldAutoCommit;
1409 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1415 use Storable 'thaw';
1417 sub process_bulk_cust_pkg {
1419 my $param = thaw(decode_base64(shift));
1420 warn Dumper($param) if $DEBUG;
1422 my $old_part_pkg = qsearchs('part_pkg',
1423 { pkgpart => $param->{'old_pkgpart'} });
1424 my $new_part_pkg = qsearchs('part_pkg',
1425 { pkgpart => $param->{'new_pkgpart'} });
1426 die "Must select a new package type\n" unless $new_part_pkg;
1427 #my $keep_dates = $param->{'keep_dates'} || 0;
1428 my $keep_dates = 1; # there is no good reason to turn this off
1430 local $SIG{HUP} = 'IGNORE';
1431 local $SIG{INT} = 'IGNORE';
1432 local $SIG{QUIT} = 'IGNORE';
1433 local $SIG{TERM} = 'IGNORE';
1434 local $SIG{TSTP} = 'IGNORE';
1435 local $SIG{PIPE} = 'IGNORE';
1437 my $oldAutoCommit = $FS::UID::AutoCommit;
1438 local $FS::UID::AutoCommit = 0;
1441 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
1444 foreach my $old_cust_pkg ( @cust_pkgs ) {
1446 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
1447 if ( $old_cust_pkg->getfield('cancel') ) {
1448 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
1449 $old_cust_pkg->pkgnum."\n"
1453 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
1455 my $error = $old_cust_pkg->change(
1456 'pkgpart' => $param->{'new_pkgpart'},
1457 'keep_dates' => $keep_dates
1459 if ( !ref($error) ) { # change returns the cust_pkg on success
1461 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
1464 $dbh->commit if $oldAutoCommit;
1470 Returns the last bill date, or if there is no last bill date, the setup date.
1471 Useful for billing metered services.
1477 return $self->setfield('last_bill', $_[0]) if @_;
1478 return $self->getfield('last_bill') if $self->getfield('last_bill');
1479 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
1480 'edate' => $self->bill, } );
1481 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
1484 =item last_cust_pkg_reason ACTION
1486 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
1487 Returns false if there is no reason or the package is not currenly ACTION'd
1488 ACTION is one of adjourn, susp, cancel, or expire.
1492 sub last_cust_pkg_reason {
1493 my ( $self, $action ) = ( shift, shift );
1494 my $date = $self->get($action);
1496 'table' => 'cust_pkg_reason',
1497 'hashref' => { 'pkgnum' => $self->pkgnum,
1498 'action' => substr(uc($action), 0, 1),
1501 'order_by' => 'ORDER BY num DESC LIMIT 1',
1505 =item last_reason ACTION
1507 Returns the most recent ACTION FS::reason associated with the package.
1508 Returns false if there is no reason or the package is not currenly ACTION'd
1509 ACTION is one of adjourn, susp, cancel, or expire.
1514 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
1515 $cust_pkg_reason->reason
1516 if $cust_pkg_reason;
1521 Returns the definition for this billing item, as an FS::part_pkg object (see
1528 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
1529 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
1530 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
1535 Returns the cancelled package this package was changed from, if any.
1541 return '' unless $self->change_pkgnum;
1542 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
1547 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
1554 $self->part_pkg->calc_setup($self, @_);
1559 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
1566 $self->part_pkg->calc_recur($self, @_);
1571 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
1578 $self->part_pkg->base_recur($self, @_);
1583 Calls the I<calc_remain> of the FS::part_pkg object associated with this
1590 $self->part_pkg->calc_remain($self, @_);
1595 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
1602 $self->part_pkg->calc_cancel($self, @_);
1607 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
1613 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
1616 =item cust_pkg_detail [ DETAILTYPE ]
1618 Returns any customer package details for this package (see
1619 L<FS::cust_pkg_detail>).
1621 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1625 sub cust_pkg_detail {
1627 my %hash = ( 'pkgnum' => $self->pkgnum );
1628 $hash{detailtype} = shift if @_;
1630 'table' => 'cust_pkg_detail',
1631 'hashref' => \%hash,
1632 'order_by' => 'ORDER BY weight, pkgdetailnum',
1636 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
1638 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
1640 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
1642 If there is an error, returns the error, otherwise returns false.
1646 sub set_cust_pkg_detail {
1647 my( $self, $detailtype, @details ) = @_;
1649 local $SIG{HUP} = 'IGNORE';
1650 local $SIG{INT} = 'IGNORE';
1651 local $SIG{QUIT} = 'IGNORE';
1652 local $SIG{TERM} = 'IGNORE';
1653 local $SIG{TSTP} = 'IGNORE';
1654 local $SIG{PIPE} = 'IGNORE';
1656 my $oldAutoCommit = $FS::UID::AutoCommit;
1657 local $FS::UID::AutoCommit = 0;
1660 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
1661 my $error = $current->delete;
1663 $dbh->rollback if $oldAutoCommit;
1664 return "error removing old detail: $error";
1668 foreach my $detail ( @details ) {
1669 my $cust_pkg_detail = new FS::cust_pkg_detail {
1670 'pkgnum' => $self->pkgnum,
1671 'detailtype' => $detailtype,
1672 'detail' => $detail,
1674 my $error = $cust_pkg_detail->insert;
1676 $dbh->rollback if $oldAutoCommit;
1677 return "error adding new detail: $error";
1682 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1689 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
1693 #false laziness w/cust_bill.pm
1697 'table' => 'cust_event',
1698 'addl_from' => 'JOIN part_event USING ( eventpart )',
1699 'hashref' => { 'tablenum' => $self->pkgnum },
1700 'extra_sql' => " AND eventtable = 'cust_pkg' ",
1704 =item num_cust_event
1706 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
1710 #false laziness w/cust_bill.pm
1711 sub num_cust_event {
1714 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
1715 " WHERE tablenum = ? AND eventtable = 'cust_pkg'";
1716 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
1717 $sth->execute($self->pkgnum) or die $sth->errstr. " executing $sql";
1718 $sth->fetchrow_arrayref->[0];
1721 =item cust_svc [ SVCPART ]
1723 Returns the services for this package, as FS::cust_svc objects (see
1724 L<FS::cust_svc>). If a svcpart is specified, return only the matching
1732 return () unless $self->num_cust_svc(@_);
1735 return qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum,
1736 'svcpart' => shift, } );
1739 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
1741 #if ( $self->{'_svcnum'} ) {
1742 # values %{ $self->{'_svcnum'}->cache };
1744 $self->_sort_cust_svc(
1745 [ qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } ) ]
1751 =item overlimit [ SVCPART ]
1753 Returns the services for this package which have exceeded their
1754 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
1755 is specified, return only the matching services.
1761 return () unless $self->num_cust_svc(@_);
1762 grep { $_->overlimit } $self->cust_svc(@_);
1765 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
1767 Returns historical services for this package created before END TIMESTAMP and
1768 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
1769 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
1770 I<pkg_svc.hidden> flag will be omitted.
1776 warn "$me _h_cust_svc called on $self\n"
1779 my ($end, $start, $mode) = @_;
1780 my @cust_svc = $self->_sort_cust_svc(
1781 [ qsearch( 'h_cust_svc',
1782 { 'pkgnum' => $self->pkgnum, },
1783 FS::h_cust_svc->sql_h_search(@_),
1786 if ( $mode eq 'I' ) {
1787 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
1788 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
1794 sub _sort_cust_svc {
1795 my( $self, $arrayref ) = @_;
1798 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
1803 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $self->pkgpart,
1804 'svcpart' => $_->svcpart } );
1806 $pkg_svc ? $pkg_svc->primary_svc : '',
1807 $pkg_svc ? $pkg_svc->quantity : 0,
1814 =item num_cust_svc [ SVCPART ]
1816 Returns the number of provisioned services for this package. If a svcpart is
1817 specified, counts only the matching services.
1824 return $self->{'_num_cust_svc'}
1826 && exists($self->{'_num_cust_svc'})
1827 && $self->{'_num_cust_svc'} =~ /\d/;
1829 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
1832 my $sql = 'SELECT COUNT(*) FROM cust_svc WHERE pkgnum = ?';
1833 $sql .= ' AND svcpart = ?' if @_;
1835 my $sth = dbh->prepare($sql) or die dbh->errstr;
1836 $sth->execute($self->pkgnum, @_) or die $sth->errstr;
1837 $sth->fetchrow_arrayref->[0];
1840 =item available_part_svc
1842 Returns a list of FS::part_svc objects representing services included in this
1843 package but not yet provisioned. Each FS::part_svc object also has an extra
1844 field, I<num_avail>, which specifies the number of available services.
1848 sub available_part_svc {
1850 grep { $_->num_avail > 0 }
1852 my $part_svc = $_->part_svc;
1853 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
1854 $_->quantity - $self->num_cust_svc($_->svcpart);
1856 # more evil encapsulation breakage
1857 if($part_svc->{'Hash'}{'num_avail'} > 0) {
1858 my @exports = $part_svc->part_export_did;
1859 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
1864 $self->part_pkg->pkg_svc;
1869 Returns a list of FS::part_svc objects representing provisioned and available
1870 services included in this package. Each FS::part_svc object also has the
1871 following extra fields:
1875 =item num_cust_svc (count)
1877 =item num_avail (quantity - count)
1879 =item cust_pkg_svc (services) - array reference containing the provisioned services, as cust_svc objects
1882 label -> ($cust_svc->label)[1]
1891 #XXX some sort of sort order besides numeric by svcpart...
1892 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
1894 my $part_svc = $pkg_svc->part_svc;
1895 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
1896 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
1897 $part_svc->{'Hash'}{'num_avail'} =
1898 max( 0, $pkg_svc->quantity - $num_cust_svc );
1899 $part_svc->{'Hash'}{'cust_pkg_svc'} =
1900 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
1901 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
1903 } $self->part_pkg->pkg_svc;
1906 push @part_svc, map {
1908 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
1909 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
1910 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
1911 $part_svc->{'Hash'}{'cust_pkg_svc'} =
1912 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
1914 } $self->extra_part_svc;
1920 =item extra_part_svc
1922 Returns a list of FS::part_svc objects corresponding to services in this
1923 package which are still provisioned but not (any longer) available in the
1928 sub extra_part_svc {
1931 my $pkgnum = $self->pkgnum;
1932 my $pkgpart = $self->pkgpart;
1935 # 'table' => 'part_svc',
1938 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
1939 # WHERE pkg_svc.svcpart = part_svc.svcpart
1940 # AND pkg_svc.pkgpart = ?
1943 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
1944 # LEFT JOIN cust_pkg USING ( pkgnum )
1945 # WHERE cust_svc.svcpart = part_svc.svcpart
1948 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
1951 #seems to benchmark slightly faster...
1953 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
1954 #MySQL doesn't grok DISINCT ON
1955 'select' => 'DISTINCT part_svc.*',
1956 'table' => 'part_svc',
1958 'LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
1959 AND pkg_svc.pkgpart = ?
1962 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
1963 LEFT JOIN cust_pkg USING ( pkgnum )
1966 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
1967 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
1973 Returns a short status string for this package, currently:
1977 =item not yet billed
1979 =item one-time charge
1994 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
1996 return 'cancelled' if $self->get('cancel');
1997 return 'suspended' if $self->susp;
1998 return 'not yet billed' unless $self->setup;
1999 return 'one-time charge' if $freq =~ /^(0|$)/;
2003 =item ucfirst_status
2005 Returns the status with the first character capitalized.
2009 sub ucfirst_status {
2010 ucfirst(shift->status);
2015 Class method that returns the list of possible status strings for packages
2016 (see L<the status method|/status>). For example:
2018 @statuses = FS::cust_pkg->statuses();
2022 tie my %statuscolor, 'Tie::IxHash',
2023 'not yet billed' => '009999', #teal? cyan?
2024 'one-time charge' => '000000',
2025 'active' => '00CC00',
2026 'suspended' => 'FF9900',
2027 'cancelled' => 'FF0000',
2031 my $self = shift; #could be class...
2032 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
2033 # # mayble split btw one-time vs. recur
2039 Returns a hex triplet color string for this package's status.
2045 $statuscolor{$self->status};
2050 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
2051 "pkg-comment" depending on user preference).
2057 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
2058 $label = $self->pkgnum. ": $label"
2059 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
2063 =item pkg_label_long
2065 Returns a long label for this package, adding the primary service's label to
2070 sub pkg_label_long {
2072 my $label = $self->pkg_label;
2073 my $cust_svc = $self->primary_cust_svc;
2074 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
2078 =item primary_cust_svc
2080 Returns a primary service (as FS::cust_svc object) if one can be identified.
2084 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
2086 sub primary_cust_svc {
2089 my @cust_svc = $self->cust_svc;
2091 return '' unless @cust_svc; #no serivces - irrelevant then
2093 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
2095 # primary service as specified in the package definition
2096 # or exactly one service definition with quantity one
2097 my $svcpart = $self->part_pkg->svcpart;
2098 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
2099 return $cust_svc[0] if scalar(@cust_svc) == 1;
2101 #couldn't identify one thing..
2107 Returns a list of lists, calling the label method for all services
2108 (see L<FS::cust_svc>) of this billing item.
2114 map { [ $_->label ] } $self->cust_svc;
2117 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2119 Like the labels method, but returns historical information on services that
2120 were active as of END_TIMESTAMP and (optionally) not cancelled before
2121 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
2122 I<pkg_svc.hidden> flag will be omitted.
2124 Returns a list of lists, calling the label method for all (historical) services
2125 (see L<FS::h_cust_svc>) of this billing item.
2131 warn "$me _h_labels called on $self\n"
2133 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
2138 Like labels, except returns a simple flat list, and shortens long
2139 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2140 identical services to one line that lists the service label and the number of
2141 individual services rather than individual items.
2146 shift->_labels_short( 'labels', @_ );
2149 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
2151 Like h_labels, except returns a simple flat list, and shortens long
2152 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2153 identical services to one line that lists the service label and the number of
2154 individual services rather than individual items.
2158 sub h_labels_short {
2159 shift->_labels_short( 'h_labels', @_ );
2163 my( $self, $method ) = ( shift, shift );
2165 warn "$me _labels_short called on $self with $method method\n"
2168 my $conf = new FS::Conf;
2169 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
2171 warn "$me _labels_short populating \%labels\n"
2175 #tie %labels, 'Tie::IxHash';
2176 push @{ $labels{$_->[0]} }, $_->[1]
2177 foreach $self->$method(@_);
2179 warn "$me _labels_short populating \@labels\n"
2183 foreach my $label ( keys %labels ) {
2185 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
2186 my $num = scalar(@values);
2187 warn "$me _labels_short $num items for $label\n"
2190 if ( $num > $max_same_services ) {
2191 warn "$me _labels_short more than $max_same_services, so summarizing\n"
2193 push @labels, "$label ($num)";
2195 if ( $conf->exists('cust_bill-consolidate_services') ) {
2196 warn "$me _labels_short consolidating services\n"
2198 # push @labels, "$label: ". join(', ', @values);
2200 my $detail = "$label: ";
2201 $detail .= shift(@values). ', '
2203 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
2205 push @labels, $detail;
2207 warn "$me _labels_short done consolidating services\n"
2210 warn "$me _labels_short adding service data\n"
2212 push @labels, map { "$label: $_" } @values;
2223 Returns the parent customer object (see L<FS::cust_main>).
2229 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
2232 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
2236 Returns the location object, if any (see L<FS::cust_location>).
2238 =item cust_location_or_main
2240 If this package is associated with a location, returns the locaiton (see
2241 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
2243 =item location_label [ OPTION => VALUE ... ]
2245 Returns the label of the location object (see L<FS::cust_location>).
2249 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
2251 =item seconds_since TIMESTAMP
2253 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
2254 package have been online since TIMESTAMP, according to the session monitor.
2256 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2257 L<Time::Local> and L<Date::Parse> for conversion functions.
2262 my($self, $since) = @_;
2265 foreach my $cust_svc (
2266 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
2268 $seconds += $cust_svc->seconds_since($since);
2275 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
2277 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
2278 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
2281 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2282 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2288 sub seconds_since_sqlradacct {
2289 my($self, $start, $end) = @_;
2293 foreach my $cust_svc (
2295 my $part_svc = $_->part_svc;
2296 $part_svc->svcdb eq 'svc_acct'
2297 && scalar($part_svc->part_export('sqlradius'));
2300 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
2307 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
2309 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
2310 in this package for sessions ending between TIMESTAMP_START (inclusive) and
2314 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2315 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2320 sub attribute_since_sqlradacct {
2321 my($self, $start, $end, $attrib) = @_;
2325 foreach my $cust_svc (
2327 my $part_svc = $_->part_svc;
2328 $part_svc->svcdb eq 'svc_acct'
2329 && scalar($part_svc->part_export('sqlradius'));
2332 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
2344 my( $self, $value ) = @_;
2345 if ( defined($value) ) {
2346 $self->setfield('quantity', $value);
2348 $self->getfield('quantity') || 1;
2351 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
2353 Transfers as many services as possible from this package to another package.
2355 The destination package can be specified by pkgnum by passing an FS::cust_pkg
2356 object. The destination package must already exist.
2358 Services are moved only if the destination allows services with the correct
2359 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
2360 this option with caution! No provision is made for export differences
2361 between the old and new service definitions. Probably only should be used
2362 when your exports for all service definitions of a given svcdb are identical.
2363 (attempt a transfer without it first, to move all possible svcpart-matching
2366 Any services that can't be moved remain in the original package.
2368 Returns an error, if there is one; otherwise, returns the number of services
2369 that couldn't be moved.
2374 my ($self, $dest_pkgnum, %opt) = @_;
2380 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
2381 $dest = $dest_pkgnum;
2382 $dest_pkgnum = $dest->pkgnum;
2384 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
2387 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
2389 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
2390 $target{$pkg_svc->svcpart} = $pkg_svc->quantity;
2393 foreach my $cust_svc ($dest->cust_svc) {
2394 $target{$cust_svc->svcpart}--;
2397 my %svcpart2svcparts = ();
2398 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2399 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
2400 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
2401 next if exists $svcpart2svcparts{$svcpart};
2402 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
2403 $svcpart2svcparts{$svcpart} = [
2405 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
2407 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
2408 'svcpart' => $_ } );
2410 $pkg_svc ? $pkg_svc->primary_svc : '',
2411 $pkg_svc ? $pkg_svc->quantity : 0,
2415 grep { $_ != $svcpart }
2417 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
2419 warn "alternates for svcpart $svcpart: ".
2420 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
2425 foreach my $cust_svc ($self->cust_svc) {
2426 if($target{$cust_svc->svcpart} > 0) {
2427 $target{$cust_svc->svcpart}--;
2428 my $new = new FS::cust_svc { $cust_svc->hash };
2429 $new->pkgnum($dest_pkgnum);
2430 my $error = $new->replace($cust_svc);
2431 return $error if $error;
2432 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
2434 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
2435 warn "alternates to consider: ".
2436 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
2438 my @alternate = grep {
2439 warn "considering alternate svcpart $_: ".
2440 "$target{$_} available in new package\n"
2443 } @{$svcpart2svcparts{$cust_svc->svcpart}};
2445 warn "alternate(s) found\n" if $DEBUG;
2446 my $change_svcpart = $alternate[0];
2447 $target{$change_svcpart}--;
2448 my $new = new FS::cust_svc { $cust_svc->hash };
2449 $new->svcpart($change_svcpart);
2450 $new->pkgnum($dest_pkgnum);
2451 my $error = $new->replace($cust_svc);
2452 return $error if $error;
2465 This method is deprecated. See the I<depend_jobnum> option to the insert and
2466 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
2473 local $SIG{HUP} = 'IGNORE';
2474 local $SIG{INT} = 'IGNORE';
2475 local $SIG{QUIT} = 'IGNORE';
2476 local $SIG{TERM} = 'IGNORE';
2477 local $SIG{TSTP} = 'IGNORE';
2478 local $SIG{PIPE} = 'IGNORE';
2480 my $oldAutoCommit = $FS::UID::AutoCommit;
2481 local $FS::UID::AutoCommit = 0;
2484 foreach my $cust_svc ( $self->cust_svc ) {
2485 #false laziness w/svc_Common::insert
2486 my $svc_x = $cust_svc->svc_x;
2487 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
2488 my $error = $part_export->export_insert($svc_x);
2490 $dbh->rollback if $oldAutoCommit;
2496 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2503 Associates this package with a (suspension or cancellation) reason (see
2504 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
2507 Available options are:
2513 can be set to a cancellation reason (see L<FS:reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason. The hashref should have the following keys: typenum - Reason type (see L<FS::reason_type>, reason - Text of the new reason.
2517 the access_user (see L<FS::access_user>) providing the reason
2525 the action (cancel, susp, adjourn, expire) associated with the reason
2529 If there is an error, returns the error, otherwise returns false.
2534 my ($self, %options) = @_;
2536 my $otaker = $options{reason_otaker} ||
2537 $FS::CurrentUser::CurrentUser->username;
2540 if ( $options{'reason'} =~ /^(\d+)$/ ) {
2544 } elsif ( ref($options{'reason'}) ) {
2546 return 'Enter a new reason (or select an existing one)'
2547 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
2549 my $reason = new FS::reason({
2550 'reason_type' => $options{'reason'}->{'typenum'},
2551 'reason' => $options{'reason'}->{'reason'},
2553 my $error = $reason->insert;
2554 return $error if $error;
2556 $reasonnum = $reason->reasonnum;
2559 return "Unparsable reason: ". $options{'reason'};
2562 my $cust_pkg_reason =
2563 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
2564 'reasonnum' => $reasonnum,
2565 'otaker' => $otaker,
2566 'action' => substr(uc($options{'action'}),0,1),
2567 'date' => $options{'date'}
2572 $cust_pkg_reason->insert;
2575 =item insert_discount
2577 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
2578 inserting a new discount on the fly (see L<FS::discount>).
2580 Available options are:
2588 If there is an error, returns the error, otherwise returns false.
2592 sub insert_discount {
2593 #my ($self, %options) = @_;
2596 my $cust_pkg_discount = new FS::cust_pkg_discount {
2597 'pkgnum' => $self->pkgnum,
2598 'discountnum' => $self->discountnum,
2600 'end_date' => '', #XXX
2601 #for the create a new discount case
2602 '_type' => $self->discountnum__type,
2603 'amount' => $self->discountnum_amount,
2604 'percent' => $self->discountnum_percent,
2605 'months' => $self->discountnum_months,
2606 'setup' => $self->discountnum_setup,
2607 #'disabled' => $self->discountnum_disabled,
2610 $cust_pkg_discount->insert;
2613 =item set_usage USAGE_VALUE_HASHREF
2615 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2616 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2617 upbytes, downbytes, and totalbytes are appropriate keys.
2619 All svc_accts which are part of this package have their values reset.
2624 my ($self, $valueref, %opt) = @_;
2626 foreach my $cust_svc ($self->cust_svc){
2627 my $svc_x = $cust_svc->svc_x;
2628 $svc_x->set_usage($valueref, %opt)
2629 if $svc_x->can("set_usage");
2633 =item recharge USAGE_VALUE_HASHREF
2635 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
2636 to which they should be set (see L<FS::svc_acct>). Currently seconds,
2637 upbytes, downbytes, and totalbytes are appropriate keys.
2639 All svc_accts which are part of this package have their values incremented.
2644 my ($self, $valueref) = @_;
2646 foreach my $cust_svc ($self->cust_svc){
2647 my $svc_x = $cust_svc->svc_x;
2648 $svc_x->recharge($valueref)
2649 if $svc_x->can("recharge");
2653 =item cust_pkg_discount
2657 sub cust_pkg_discount {
2659 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
2662 =item cust_pkg_discount_active
2666 sub cust_pkg_discount_active {
2668 grep { $_->status eq 'active' } $self->cust_pkg_discount;
2673 =head1 CLASS METHODS
2679 Returns an SQL expression identifying recurring packages.
2683 sub recurring_sql { "
2684 '0' != ( select freq from part_pkg
2685 where cust_pkg.pkgpart = part_pkg.pkgpart )
2690 Returns an SQL expression identifying one-time packages.
2695 '0' = ( select freq from part_pkg
2696 where cust_pkg.pkgpart = part_pkg.pkgpart )
2701 Returns an SQL expression identifying ordered packages (recurring packages not
2707 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
2712 Returns an SQL expression identifying active packages.
2717 $_[0]->recurring_sql. "
2718 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
2719 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2720 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2723 =item not_yet_billed_sql
2725 Returns an SQL expression identifying packages which have not yet been billed.
2729 sub not_yet_billed_sql { "
2730 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
2731 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2732 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2737 Returns an SQL expression identifying inactive packages (one-time packages
2738 that are otherwise unsuspended/uncancelled).
2742 sub inactive_sql { "
2743 ". $_[0]->onetime_sql(). "
2744 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
2745 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2746 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
2752 Returns an SQL expression identifying suspended packages.
2756 sub suspended_sql { susp_sql(@_); }
2758 #$_[0]->recurring_sql(). ' AND '.
2760 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
2761 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
2768 Returns an SQL exprression identifying cancelled packages.
2772 sub cancelled_sql { cancel_sql(@_); }
2774 #$_[0]->recurring_sql(). ' AND '.
2775 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
2780 Returns an SQL expression to give the package status as a string.
2786 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
2787 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
2788 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
2789 WHEN ".onetime_sql()." THEN 'one-time charge'
2794 =item search HASHREF
2798 Returns a qsearch hash expression to search for parameters specified in HASHREF.
2799 Valid parameters are
2807 active, inactive, suspended, cancel (or cancelled)
2811 active, inactive, suspended, one-time charge, inactive, cancel (or cancelled)
2815 boolean selects custom packages
2821 pkgpart or arrayref or hashref of pkgparts
2825 arrayref of beginning and ending epoch date
2829 arrayref of beginning and ending epoch date
2833 arrayref of beginning and ending epoch date
2837 arrayref of beginning and ending epoch date
2841 arrayref of beginning and ending epoch date
2845 arrayref of beginning and ending epoch date
2849 arrayref of beginning and ending epoch date
2853 pkgnum or APKG_pkgnum
2857 a value suited to passing to FS::UI::Web::cust_header
2861 specifies the user for agent virtualization
2865 boolean selects packages containing fcc form 477 telco lines
2872 my ($class, $params) = @_;
2879 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
2881 "cust_main.agentnum = $1";
2888 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
2890 "cust_pkg.custnum = $1";
2897 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
2899 "cust_pkg.pkgbatch = '$1'";
2906 if ( $params->{'magic'} eq 'active'
2907 || $params->{'status'} eq 'active' ) {
2909 push @where, FS::cust_pkg->active_sql();
2911 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
2912 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
2914 push @where, FS::cust_pkg->not_yet_billed_sql();
2916 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
2917 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
2919 push @where, FS::cust_pkg->inactive_sql();
2921 } elsif ( $params->{'magic'} eq 'suspended'
2922 || $params->{'status'} eq 'suspended' ) {
2924 push @where, FS::cust_pkg->suspended_sql();
2926 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
2927 || $params->{'status'} =~ /^cancell?ed$/ ) {
2929 push @where, FS::cust_pkg->cancelled_sql();
2934 # parse package class
2937 #false lazinessish w/graph/cust_bill_pkg.cgi
2940 if ( exists($params->{'classnum'})
2941 && $params->{'classnum'} =~ /^(\d*)$/
2945 if ( $classnum ) { #a specific class
2946 push @where, "part_pkg.classnum = $classnum";
2948 #@pkg_class = ( qsearchs('pkg_class', { 'classnum' => $classnum } ) );
2949 #die "classnum $classnum not found!" unless $pkg_class[0];
2950 #$title .= $pkg_class[0]->classname.' ';
2952 } elsif ( $classnum eq '' ) { #the empty class
2954 push @where, "part_pkg.classnum IS NULL";
2955 #$title .= 'Empty class ';
2956 #@pkg_class = ( '(empty class)' );
2957 } elsif ( $classnum eq '0' ) {
2958 #@pkg_class = qsearch('pkg_class', {} ); # { 'disabled' => '' } );
2959 #push @pkg_class, '(empty class)';
2961 die "illegal classnum";
2967 # parse package report options
2970 my @report_option = ();
2971 if ( exists($params->{'report_option'})
2972 && $params->{'report_option'} =~ /^([,\d]*)$/
2975 @report_option = split(',', $1);
2978 if (@report_option) {
2979 # this will result in the empty set for the dangling comma case as it should
2981 map{ "0 < ( SELECT count(*) FROM part_pkg_option
2982 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
2983 AND optionname = 'report_option_$_'
2984 AND optionvalue = '1' )"
2994 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
3000 push @where, "part_pkg.fcc_ds0s > 0" if $params->{fcc_line};
3006 if ( exists($params->{'censustract'}) ) {
3007 $params->{'censustract'} =~ /^([.\d]*)$/;
3008 my $censustract = "cust_main.censustract = '$1'";
3009 $censustract .= ' OR cust_main.censustract is NULL' unless $1;
3010 push @where, "( $censustract )";
3017 if ( ref($params->{'pkgpart'}) ) {
3020 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
3021 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
3022 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
3023 @pkgpart = @{ $params->{'pkgpart'} };
3025 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
3028 @pkgpart = grep /^(\d+)$/, @pkgpart;
3030 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
3032 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
3033 push @where, "pkgpart = $1";
3042 #false laziness w/report_cust_pkg.html
3045 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
3046 'active' => { 'susp'=>1, 'cancel'=>1 },
3047 'suspended' => { 'cancel' => 1 },
3052 if( exists($params->{'active'} ) ) {
3053 # This overrides all the other date-related fields
3054 my($beginning, $ending) = @{$params->{'active'}};
3056 "cust_pkg.setup IS NOT NULL",
3057 "cust_pkg.setup <= $ending",
3058 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
3059 "NOT (".FS::cust_pkg->onetime_sql . ")";
3062 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end cancel )) {
3064 next unless exists($params->{$field});
3066 my($beginning, $ending) = @{$params->{$field}};
3068 next if $beginning == 0 && $ending == 4294967295;
3071 "cust_pkg.$field IS NOT NULL",
3072 "cust_pkg.$field >= $beginning",
3073 "cust_pkg.$field <= $ending";
3075 $orderby ||= "ORDER BY cust_pkg.$field";
3080 $orderby ||= 'ORDER BY bill';
3083 # parse magic, legacy, etc.
3086 if ( $params->{'magic'} &&
3087 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
3090 $orderby = 'ORDER BY pkgnum';
3092 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
3093 push @where, "pkgpart = $1";
3096 } elsif ( $params->{'query'} eq 'pkgnum' ) {
3098 $orderby = 'ORDER BY pkgnum';
3100 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
3102 $orderby = 'ORDER BY pkgnum';
3105 SELECT count(*) FROM pkg_svc
3106 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
3107 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
3108 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
3109 AND cust_svc.svcpart = pkg_svc.svcpart
3116 # setup queries, links, subs, etc. for the search
3119 # here is the agent virtualization
3120 if ($params->{CurrentUser}) {
3122 qsearchs('access_user', { username => $params->{CurrentUser} });
3125 push @where, $access_user->agentnums_sql('table'=>'cust_main');
3130 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
3133 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
3135 my $addl_from = 'LEFT JOIN cust_main USING ( custnum ) '.
3136 'LEFT JOIN part_pkg USING ( pkgpart ) '.
3137 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) ';
3139 my $count_query = "SELECT COUNT(*) FROM cust_pkg $addl_from $extra_sql";
3142 'table' => 'cust_pkg',
3144 'select' => join(', ',
3146 ( map "part_pkg.$_", qw( pkg freq ) ),
3147 'pkg_class.classname',
3148 'cust_main.custnum AS cust_main_custnum',
3149 FS::UI::Web::cust_sql_fields(
3150 $params->{'cust_fields'}
3153 'extra_sql' => "$extra_sql $orderby",
3154 'addl_from' => $addl_from,
3155 'count_query' => $count_query,
3162 Returns a list of two package counts. The first is a count of packages
3163 based on the supplied criteria and the second is the count of residential
3164 packages with those same criteria. Criteria are specified as in the search
3170 my ($class, $params) = @_;
3172 my $sql_query = $class->search( $params );
3174 my $count_sql = delete($sql_query->{'count_query'});
3175 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
3176 or die "couldn't parse count_sql";
3178 my $count_sth = dbh->prepare($count_sql)
3179 or die "Error preparing $count_sql: ". dbh->errstr;
3181 or die "Error executing $count_sql: ". $count_sth->errstr;
3182 my $count_arrayref = $count_sth->fetchrow_arrayref;
3184 return ( @$count_arrayref );
3191 Returns a list: the first item is an SQL fragment identifying matching
3192 packages/customers via location (taking into account shipping and package
3193 address taxation, if enabled), and subsequent items are the parameters to
3194 substitute for the placeholders in that fragment.
3199 my($class, %opt) = @_;
3200 my $ornull = $opt{'ornull'};
3202 my $conf = new FS::Conf;
3204 # '?' placeholders in _location_sql_where
3205 my $x = $ornull ? 3 : 2;
3206 my @bill_param = ( ('city')x3, ('county')x$x, ('state')x$x, 'country' );
3210 if ( $conf->exists('tax-ship_address') ) {
3213 ( ( ship_last IS NULL OR ship_last = '' )
3214 AND ". _location_sql_where('cust_main', '', $ornull ). "
3216 OR ( ship_last IS NOT NULL AND ship_last != ''
3217 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
3220 # AND payby != 'COMP'
3222 @main_param = ( @bill_param, @bill_param );
3226 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
3227 @main_param = @bill_param;
3233 if ( $conf->exists('tax-pkg_address') ) {
3235 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
3238 ( cust_pkg.locationnum IS NULL AND $main_where )
3239 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
3242 @param = ( @main_param, @bill_param );
3246 $where = $main_where;
3247 @param = @main_param;
3255 #subroutine, helper for location_sql
3256 sub _location_sql_where {
3258 my $prefix = @_ ? shift : '';
3259 my $ornull = @_ ? shift : '';
3261 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
3263 $ornull = $ornull ? ' OR ? IS NULL ' : '';
3265 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL ) ";
3266 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL ) ";
3267 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL ) ";
3269 # ( $table.${prefix}city = ? $or_empty_city $ornull )
3271 ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS text) IS NULL )
3272 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
3273 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
3274 AND $table.${prefix}country = ?
3282 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
3284 CUSTNUM is a customer (see L<FS::cust_main>)
3286 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3287 L<FS::part_pkg>) to order for this customer. Duplicates are of course
3290 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
3291 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
3292 new billing items. An error is returned if this is not possible (see
3293 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
3296 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3297 newly-created cust_pkg objects.
3299 REFNUM, if specified, will specify the FS::pkg_referral record to be created
3300 and inserted. Multiple FS::pkg_referral records can be created by
3301 setting I<refnum> to an array reference of refnums or a hash reference with
3302 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
3303 record will be created corresponding to cust_main.refnum.
3308 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
3310 my $conf = new FS::Conf;
3312 # Transactionize this whole mess
3313 local $SIG{HUP} = 'IGNORE';
3314 local $SIG{INT} = 'IGNORE';
3315 local $SIG{QUIT} = 'IGNORE';
3316 local $SIG{TERM} = 'IGNORE';
3317 local $SIG{TSTP} = 'IGNORE';
3318 local $SIG{PIPE} = 'IGNORE';
3320 my $oldAutoCommit = $FS::UID::AutoCommit;
3321 local $FS::UID::AutoCommit = 0;
3325 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
3326 # return "Customer not found: $custnum" unless $cust_main;
3328 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
3331 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3334 my $change = scalar(@old_cust_pkg) != 0;
3337 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
3339 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
3340 " to pkgpart ". $pkgparts->[0]. "\n"
3343 my $err_or_cust_pkg =
3344 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
3345 'refnum' => $refnum,
3348 unless (ref($err_or_cust_pkg)) {
3349 $dbh->rollback if $oldAutoCommit;
3350 return $err_or_cust_pkg;
3353 push @$return_cust_pkg, $err_or_cust_pkg;
3354 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3359 # Create the new packages.
3360 foreach my $pkgpart (@$pkgparts) {
3362 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
3364 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
3365 pkgpart => $pkgpart,
3369 $error = $cust_pkg->insert( 'change' => $change );
3371 $dbh->rollback if $oldAutoCommit;
3374 push @$return_cust_pkg, $cust_pkg;
3376 # $return_cust_pkg now contains refs to all of the newly
3379 # Transfer services and cancel old packages.
3380 foreach my $old_pkg (@old_cust_pkg) {
3382 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
3385 foreach my $new_pkg (@$return_cust_pkg) {
3386 $error = $old_pkg->transfer($new_pkg);
3387 if ($error and $error == 0) {
3388 # $old_pkg->transfer failed.
3389 $dbh->rollback if $oldAutoCommit;
3394 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
3395 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
3396 foreach my $new_pkg (@$return_cust_pkg) {
3397 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
3398 if ($error and $error == 0) {
3399 # $old_pkg->transfer failed.
3400 $dbh->rollback if $oldAutoCommit;
3407 # Transfers were successful, but we went through all of the
3408 # new packages and still had services left on the old package.
3409 # We can't cancel the package under the circumstances, so abort.
3410 $dbh->rollback if $oldAutoCommit;
3411 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
3413 $error = $old_pkg->cancel( quiet=>1 );
3419 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3423 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
3425 A bulk change method to change packages for multiple customers.
3427 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
3428 L<FS::part_pkg>) to order for each customer. Duplicates are of course
3431 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
3432 replace. The services (see L<FS::cust_svc>) are moved to the
3433 new billing items. An error is returned if this is not possible (see
3436 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
3437 newly-created cust_pkg objects.
3442 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
3444 # Transactionize this whole mess
3445 local $SIG{HUP} = 'IGNORE';
3446 local $SIG{INT} = 'IGNORE';
3447 local $SIG{QUIT} = 'IGNORE';
3448 local $SIG{TERM} = 'IGNORE';
3449 local $SIG{TSTP} = 'IGNORE';
3450 local $SIG{PIPE} = 'IGNORE';
3452 my $oldAutoCommit = $FS::UID::AutoCommit;
3453 local $FS::UID::AutoCommit = 0;
3457 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
3460 while(scalar(@old_cust_pkg)) {
3462 my $custnum = $old_cust_pkg[0]->custnum;
3463 my (@remove) = map { $_->pkgnum }
3464 grep { $_->custnum == $custnum } @old_cust_pkg;
3465 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
3467 my $error = order $custnum, $pkgparts, \@remove, \@return;
3469 push @errors, $error
3471 push @$return_cust_pkg, @return;
3474 if (scalar(@errors)) {
3475 $dbh->rollback if $oldAutoCommit;
3476 return join(' / ', @errors);
3479 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3483 # Used by FS::Upgrade to migrate to a new database.
3484 sub _upgrade_data { # class method
3485 my ($class, %opts) = @_;
3486 $class->_upgrade_otaker(%opts);
3488 # RT#10139, bug resulting in contract_end being set when it shouldn't
3489 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
3490 # RT#10830, bad calculation of prorate date near end of year
3491 # the date range for bill is December 2009, and we move it forward
3492 # one year if it's before the previous bill date (which it should
3494 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
3495 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
3496 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
3497 # RT6628, add order_date to cust_pkg
3498 'update cust_pkg set order_date = (select history_date from h_cust_pkg
3499 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
3500 history_action = \'insert\') where order_date is null',
3502 foreach my $sql (@statements) {
3503 my $sth = dbh->prepare($sql);
3504 $sth->execute or die $sth->errstr;
3512 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
3514 In sub order, the @pkgparts array (passed by reference) is clobbered.
3516 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
3517 method to pass dates to the recur_prog expression, it should do so.
3519 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
3520 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
3521 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
3522 configuration values. Probably need a subroutine which decides what to do
3523 based on whether or not we've fetched the user yet, rather than a hash. See
3524 FS::UID and the TODO.
3526 Now that things are transactional should the check in the insert method be
3531 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
3532 L<FS::pkg_svc>, schema.html from the base documentation