4 use base qw( FS::otaker_Mixin FS::cust_main_Mixin
5 FS::contact_Mixin FS::location_Mixin
6 FS::m2m_Common FS::option_Common );
7 use vars qw($disable_agentcheck $DEBUG $me);
9 use Scalar::Util qw( blessed );
10 use List::Util qw(min max);
12 use Time::Local qw( timelocal timelocal_nocheck );
14 use FS::UID qw( getotaker dbh driver_name );
15 use FS::Misc qw( send_email );
16 use FS::Record qw( qsearch qsearchs fields );
22 use FS::cust_location;
24 use FS::cust_bill_pkg;
25 use FS::cust_pkg_detail;
26 use FS::cust_pkg_usage;
27 use FS::cdr_cust_pkg_usage;
32 use FS::cust_pkg_reason;
34 use FS::cust_pkg_discount;
39 # need to 'use' these instead of 'require' in sub { cancel, suspend, unsuspend,
41 # because they load configuration by setting FS::UID::callback (see TODO)
47 # for sending cancel emails in sub cancel
51 $me = '[FS::cust_pkg]';
53 $disable_agentcheck = 0;
57 my ( $hashref, $cache ) = @_;
58 #if ( $hashref->{'pkgpart'} ) {
59 if ( $hashref->{'pkg'} ) {
60 # #@{ $self->{'_pkgnum'} } = ();
61 # my $subcache = $cache->subcache('pkgpart', 'part_pkg');
62 # $self->{'_pkgpart'} = $subcache;
63 # #push @{ $self->{'_pkgnum'} },
64 # FS::part_pkg->new_or_cached($hashref, $subcache);
65 $self->{'_pkgpart'} = FS::part_pkg->new($hashref);
67 if ( exists $hashref->{'svcnum'} ) {
68 #@{ $self->{'_pkgnum'} } = ();
69 my $subcache = $cache->subcache('svcnum', 'cust_svc', $hashref->{pkgnum});
70 $self->{'_svcnum'} = $subcache;
71 #push @{ $self->{'_pkgnum'} },
72 FS::cust_svc->new_or_cached($hashref, $subcache) if $hashref->{svcnum};
78 FS::cust_pkg - Object methods for cust_pkg objects
84 $record = new FS::cust_pkg \%hash;
85 $record = new FS::cust_pkg { 'column' => 'value' };
87 $error = $record->insert;
89 $error = $new_record->replace($old_record);
91 $error = $record->delete;
93 $error = $record->check;
95 $error = $record->cancel;
97 $error = $record->suspend;
99 $error = $record->unsuspend;
101 $part_pkg = $record->part_pkg;
103 @labels = $record->labels;
105 $seconds = $record->seconds_since($timestamp);
107 $error = FS::cust_pkg::order( $custnum, \@pkgparts );
108 $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );
112 An FS::cust_pkg object represents a customer billing item. FS::cust_pkg
113 inherits from FS::Record. The following fields are currently supported:
119 Primary key (assigned automatically for new billing items)
123 Customer (see L<FS::cust_main>)
127 Billing item definition (see L<FS::part_pkg>)
131 Optional link to package location (see L<FS::location>)
135 date package was ordered (also remains same on changes)
147 date (next bill date)
175 order taker (see L<FS::access_user>)
179 If this field is set to 1, disables the automatic
180 unsuspension of this package when using the B<unsuspendauto> config option.
184 If not set, defaults to 1
188 Date of change from previous package
198 =item change_locationnum
206 The pkgnum of the package that this package is supplemental to, if any.
210 The package link (L<FS::part_pkg_link>) that defines this supplemental
211 package, if it is one.
215 Note: setup, last_bill, bill, adjourn, susp, expire, cancel and change_date
216 are specified as UNIX timestamps; see L<perlfunc/"time">. Also see
217 L<Time::Local> and L<Date::Parse> for conversion functions.
225 Create a new billing item. To add the item to the database, see L<"insert">.
229 sub table { 'cust_pkg'; }
230 sub cust_linked { $_[0]->cust_main_custnum || $_[0]->custnum }
231 sub cust_unlinked_msg {
233 "WARNING: can't find cust_main.custnum ". $self->custnum.
234 ' (cust_pkg.pkgnum '. $self->pkgnum. ')';
237 =item insert [ OPTION => VALUE ... ]
239 Adds this billing item to the database ("Orders" the item). If there is an
240 error, returns the error, otherwise returns false.
242 If the additional field I<promo_code> is defined instead of I<pkgpart>, it
243 will be used to look up the package definition and agent restrictions will be
246 If the additional field I<refnum> is defined, an FS::pkg_referral record will
247 be created and inserted. Multiple FS::pkg_referral records can be created by
248 setting I<refnum> to an array reference of refnums or a hash reference with
249 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
250 record will be created corresponding to cust_main.refnum.
252 The following options are available:
258 If set true, supresses actions that should only be taken for new package
259 orders. (Currently this includes: intro periods when delay_setup is on.)
263 cust_pkg_option records will be created
267 a ticket will be added to this customer with this subject
271 an optional queue name for ticket additions
275 Don't check the legality of the package definition. This should be used
276 when performing a package change that doesn't change the pkgpart (i.e.
284 my( $self, %options ) = @_;
287 $error = $self->check_pkgpart unless $options{'allow_pkgpart'};
288 return $error if $error;
290 my $part_pkg = $self->part_pkg;
292 if ( $part_pkg->option('start_1st', 1) && !$self->start_date ) {
293 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime(time) )[0,1,2,3,4,5];
294 $mon += 1 unless $mday == 1;
295 until ( $mon < 12 ) { $mon -= 12; $year++; }
296 $self->start_date( timelocal_nocheck(0,0,0,1,$mon,$year) );
299 foreach my $action ( qw(expire adjourn contract_end) ) {
300 my $months = $part_pkg->option("${action}_months",1);
301 if($months and !$self->$action) {
302 my $start = $self->start_date || $self->setup || time;
303 $self->$action( $part_pkg->add_freq($start, $months) );
307 if ( ! $options{'change'}
308 && ( my $free_days = $part_pkg->option('free_days',1) )
309 && $part_pkg->option('delay_setup',1)
310 #&& ! $self->start_date
313 my ($mday,$mon,$year) = (localtime(time) )[3,4,5];
314 #my $start_date = ($self->start_date || timelocal(0,0,0,$mday,$mon,$year)) + 86400 * $free_days;
315 my $start_date = timelocal(0,0,0,$mday,$mon,$year) + 86400 * $free_days;
316 $self->start_date($start_date);
319 $self->order_date(time);
321 local $SIG{HUP} = 'IGNORE';
322 local $SIG{INT} = 'IGNORE';
323 local $SIG{QUIT} = 'IGNORE';
324 local $SIG{TERM} = 'IGNORE';
325 local $SIG{TSTP} = 'IGNORE';
326 local $SIG{PIPE} = 'IGNORE';
328 my $oldAutoCommit = $FS::UID::AutoCommit;
329 local $FS::UID::AutoCommit = 0;
332 $error = $self->SUPER::insert($options{options} ? %{$options{options}} : ());
334 $dbh->rollback if $oldAutoCommit;
338 $self->refnum($self->cust_main->refnum) unless $self->refnum;
339 $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
340 $self->process_m2m( 'link_table' => 'pkg_referral',
341 'target_table' => 'part_referral',
342 'params' => $self->refnum,
345 if ( $self->discountnum ) {
346 my $error = $self->insert_discount();
348 $dbh->rollback if $oldAutoCommit;
353 #if ( $self->reg_code ) {
354 # my $reg_code = qsearchs('reg_code', { 'code' => $self->reg_code } );
355 # $error = $reg_code->delete;
357 # $dbh->rollback if $oldAutoCommit;
362 my $conf = new FS::Conf;
364 if ( $conf->config('ticket_system') && $options{ticket_subject} ) {
366 #this init stuff is still inefficient, but at least its limited to
367 # the small number (any?) folks using ticket emailing on pkg order
370 # use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
377 use FS::TicketSystem;
378 FS::TicketSystem->init();
380 my $q = new RT::Queue($RT::SystemUser);
381 $q->Load($options{ticket_queue}) if $options{ticket_queue};
382 my $t = new RT::Ticket($RT::SystemUser);
383 my $mime = new MIME::Entity;
384 $mime->build( Type => 'text/plain', Data => $options{ticket_subject} );
385 $t->Create( $options{ticket_queue} ? (Queue => $q) : (),
386 Subject => $options{ticket_subject},
389 $t->AddLink( Type => 'MemberOf',
390 Target => 'freeside://freeside/cust_main/'. $self->custnum,
394 if ($conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
395 my $queue = new FS::queue {
396 'job' => 'FS::cust_main::queueable_print',
398 $error = $queue->insert(
399 'custnum' => $self->custnum,
400 'template' => 'welcome_letter',
404 warn "can't send welcome letter: $error";
409 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
416 This method now works but you probably shouldn't use it.
418 You don't want to delete packages, because there would then be no record
419 the customer ever purchased the package. Instead, see the cancel method and
420 hide cancelled packages.
427 local $SIG{HUP} = 'IGNORE';
428 local $SIG{INT} = 'IGNORE';
429 local $SIG{QUIT} = 'IGNORE';
430 local $SIG{TERM} = 'IGNORE';
431 local $SIG{TSTP} = 'IGNORE';
432 local $SIG{PIPE} = 'IGNORE';
434 my $oldAutoCommit = $FS::UID::AutoCommit;
435 local $FS::UID::AutoCommit = 0;
438 foreach my $cust_pkg_discount ($self->cust_pkg_discount) {
439 my $error = $cust_pkg_discount->delete;
441 $dbh->rollback if $oldAutoCommit;
445 #cust_bill_pkg_discount?
447 foreach my $cust_pkg_detail ($self->cust_pkg_detail) {
448 my $error = $cust_pkg_detail->delete;
450 $dbh->rollback if $oldAutoCommit;
455 foreach my $cust_pkg_reason (
457 'table' => 'cust_pkg_reason',
458 'hashref' => { 'pkgnum' => $self->pkgnum },
462 my $error = $cust_pkg_reason->delete;
464 $dbh->rollback if $oldAutoCommit;
471 my $error = $self->SUPER::delete(@_);
473 $dbh->rollback if $oldAutoCommit;
477 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
483 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
485 Replaces the OLD_RECORD with this one in the database. If there is an error,
486 returns the error, otherwise returns false.
488 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
490 Changing pkgpart may have disasterous effects. See the order subroutine.
492 setup and bill are normally updated by calling the bill method of a customer
493 object (see L<FS::cust_main>).
495 suspend is normally updated by the suspend and unsuspend methods.
497 cancel is normally updated by the cancel method (and also the order subroutine
500 Available options are:
506 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.
510 the access_user (see L<FS::access_user>) providing the reason
514 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
523 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
528 ( ref($_[0]) eq 'HASH' )
532 #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
533 #return "Can't change otaker!" if $old->otaker ne $new->otaker;
536 #return "Can't change setup once it exists!"
537 # if $old->getfield('setup') &&
538 # $old->getfield('setup') != $new->getfield('setup');
540 #some logic for bill, susp, cancel?
542 local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
544 local $SIG{HUP} = 'IGNORE';
545 local $SIG{INT} = 'IGNORE';
546 local $SIG{QUIT} = 'IGNORE';
547 local $SIG{TERM} = 'IGNORE';
548 local $SIG{TSTP} = 'IGNORE';
549 local $SIG{PIPE} = 'IGNORE';
551 my $oldAutoCommit = $FS::UID::AutoCommit;
552 local $FS::UID::AutoCommit = 0;
555 foreach my $method ( qw(adjourn expire) ) { # How many reasons?
556 if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
557 my $error = $new->insert_reason(
558 'reason' => $options->{'reason'},
559 'date' => $new->$method,
561 'reason_otaker' => $options->{'reason_otaker'},
564 dbh->rollback if $oldAutoCommit;
565 return "Error inserting cust_pkg_reason: $error";
570 #save off and freeze RADIUS attributes for any associated svc_acct records
572 if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
574 #also check for specific exports?
575 # to avoid spurious modify export events
576 @svc_acct = map { $_->svc_x }
577 grep { $_->part_svc->svcdb eq 'svc_acct' }
580 $_->snapshot foreach @svc_acct;
584 my $error = $new->export_pkg_change($old)
585 || $new->SUPER::replace( $old,
587 ? $options->{options}
591 $dbh->rollback if $oldAutoCommit;
595 #for prepaid packages,
596 #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
597 foreach my $old_svc_acct ( @svc_acct ) {
598 my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
600 $new_svc_acct->replace( $old_svc_acct,
601 'depend_jobnum' => $options->{depend_jobnum},
604 $dbh->rollback if $oldAutoCommit;
609 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
616 Checks all fields to make sure this is a valid billing item. If there is an
617 error, returns the error, otherwise returns false. Called by the insert and
625 if ( !$self->locationnum or $self->locationnum == -1 ) {
626 $self->set('locationnum', $self->cust_main->ship_locationnum);
630 $self->ut_numbern('pkgnum')
631 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
632 || $self->ut_numbern('pkgpart')
633 || $self->ut_foreign_keyn('contactnum', 'contact', 'contactnum' )
634 || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
635 || $self->ut_numbern('start_date')
636 || $self->ut_numbern('setup')
637 || $self->ut_numbern('bill')
638 || $self->ut_numbern('susp')
639 || $self->ut_numbern('cancel')
640 || $self->ut_numbern('adjourn')
641 || $self->ut_numbern('resume')
642 || $self->ut_numbern('expire')
643 || $self->ut_numbern('dundate')
644 || $self->ut_enum('no_auto', [ '', 'Y' ])
645 || $self->ut_enum('waive_setup', [ '', 'Y' ])
646 || $self->ut_numbern('agent_pkgid')
647 || $self->ut_enum('recur_show_zero', [ '', 'Y', 'N', ])
648 || $self->ut_enum('setup_show_zero', [ '', 'Y', 'N', ])
649 || $self->ut_foreign_keyn('main_pkgnum', 'cust_pkg', 'pkgnum')
650 || $self->ut_foreign_keyn('pkglinknum', 'part_pkg_link', 'pkglinknum')
652 return $error if $error;
654 return "A package with both start date (future start) and setup date (already started) will never bill"
655 if $self->start_date && $self->setup;
657 return "A future unsuspend date can only be set for a package with a suspend date"
658 if $self->resume and !$self->susp and !$self->adjourn;
660 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
662 if ( $self->dbdef_table->column('manual_flag') ) {
663 $self->manual_flag('') if $self->manual_flag eq ' ';
664 $self->manual_flag =~ /^([01]?)$/
665 or return "Illegal manual_flag ". $self->manual_flag;
666 $self->manual_flag($1);
674 Check the pkgpart to make sure it's allowed with the reg_code and/or
675 promo_code of the package (if present) and with the customer's agent.
676 Called from C<insert>, unless we are doing a package change that doesn't
684 # my $error = $self->ut_numbern('pkgpart'); # already done
687 if ( $self->reg_code ) {
689 unless ( grep { $self->pkgpart == $_->pkgpart }
690 map { $_->reg_code_pkg }
691 qsearchs( 'reg_code', { 'code' => $self->reg_code,
692 'agentnum' => $self->cust_main->agentnum })
694 return "Unknown registration code";
697 } elsif ( $self->promo_code ) {
700 qsearchs('part_pkg', {
701 'pkgpart' => $self->pkgpart,
702 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
704 return 'Unknown promotional code' unless $promo_part_pkg;
708 unless ( $disable_agentcheck ) {
710 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
711 return "agent ". $agent->agentnum. ':'. $agent->agent.
712 " can't purchase pkgpart ". $self->pkgpart
713 unless $agent->pkgpart_hashref->{ $self->pkgpart }
714 || $agent->agentnum == $self->part_pkg->agentnum;
717 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
718 return $error if $error;
726 =item cancel [ OPTION => VALUE ... ]
728 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
729 in this package, then cancels the package itself (sets the cancel field to
732 Available options are:
736 =item quiet - can be set true to supress email cancellation notices.
738 =item time - can be set to cancel the package based on a specific future or
739 historical date. Using time ensures that the remaining amount is calculated
740 correctly. Note however that this is an immediate cancel and just changes
741 the date. You are PROBABLY looking to expire the account instead of using
744 =item reason - can be set to a cancellation reason (see L<FS:reason>),
745 either a reasonnum of an existing reason, or passing a hashref will create
746 a new reason. The hashref should have the following keys: typenum - Reason
747 type (see L<FS::reason_type>, reason - Text of the new reason.
749 =item date - can be set to a unix style timestamp to specify when to
752 =item nobill - can be set true to skip billing if it might otherwise be done.
754 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
755 not credit it. This must be set (by change()) when changing the package
756 to a different pkgpart or location, and probably shouldn't be in any other
757 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
762 If there is an error, returns the error, otherwise returns false.
767 my( $self, %options ) = @_;
770 # pass all suspend/cancel actions to the main package
771 if ( $self->main_pkgnum and !$options{'from_main'} ) {
772 return $self->main_pkg->cancel(%options);
775 my $conf = new FS::Conf;
777 warn "cust_pkg::cancel called with options".
778 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
781 local $SIG{HUP} = 'IGNORE';
782 local $SIG{INT} = 'IGNORE';
783 local $SIG{QUIT} = 'IGNORE';
784 local $SIG{TERM} = 'IGNORE';
785 local $SIG{TSTP} = 'IGNORE';
786 local $SIG{PIPE} = 'IGNORE';
788 my $oldAutoCommit = $FS::UID::AutoCommit;
789 local $FS::UID::AutoCommit = 0;
792 my $old = $self->select_for_update;
794 if ( $old->get('cancel') || $self->get('cancel') ) {
795 dbh->rollback if $oldAutoCommit;
796 return ""; # no error
799 # XXX possibly set cancel_time to the expire date?
800 my $cancel_time = $options{'time'} || time;
801 my $date = $options{'date'} if $options{'date'}; # expire/cancel later
802 $date = '' if ($date && $date <= $cancel_time); # complain instead?
804 #race condition: usage could be ongoing until unprovisioned
805 #resolved by performing a change package instead (which unprovisions) and
807 if ( !$options{nobill} && !$date ) {
808 # && $conf->exists('bill_usage_on_cancel') ) { #calc_cancel checks this
809 my $copy = $self->new({$self->hash});
811 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
813 'time' => $cancel_time );
814 warn "Error billing during cancel, custnum ".
815 #$self->cust_main->custnum. ": $error"
820 if ( $options{'reason'} ) {
821 $error = $self->insert_reason( 'reason' => $options{'reason'},
822 'action' => $date ? 'expire' : 'cancel',
823 'date' => $date ? $date : $cancel_time,
824 'reason_otaker' => $options{'reason_otaker'},
827 dbh->rollback if $oldAutoCommit;
828 return "Error inserting cust_pkg_reason: $error";
832 my %svc_cancel_opt = ();
833 $svc_cancel_opt{'date'} = $date if $date;
834 foreach my $cust_svc (
837 sort { $a->[1] <=> $b->[1] }
838 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; }
839 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
841 my $part_svc = $cust_svc->part_svc;
842 next if ( defined($part_svc) and $part_svc->preserve );
843 my $error = $cust_svc->cancel( %svc_cancel_opt );
846 $dbh->rollback if $oldAutoCommit;
847 return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
853 # credit remaining time if appropriate
855 if ( exists($options{'unused_credit'}) ) {
856 $do_credit = $options{'unused_credit'};
859 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
862 my $error = $self->credit_remaining('cancel', $cancel_time);
864 $dbh->rollback if $oldAutoCommit;
871 my %hash = $self->hash;
872 $date ? ($hash{'expire'} = $date) : ($hash{'cancel'} = $cancel_time);
873 $hash{'change_custnum'} = $options{'change_custnum'};
874 my $new = new FS::cust_pkg ( \%hash );
875 $error = $new->replace( $self, options => { $self->options } );
877 $dbh->rollback if $oldAutoCommit;
881 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
882 $error = $supp_pkg->cancel(%options, 'from_main' => 1);
884 $dbh->rollback if $oldAutoCommit;
885 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
889 foreach my $usage ( $self->cust_pkg_usage ) {
890 $error = $usage->delete;
892 $dbh->rollback if $oldAutoCommit;
893 return "deleting usage pools: $error";
897 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
898 return '' if $date; #no errors
900 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
901 if ( !$options{'quiet'} &&
902 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
904 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
907 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
908 $error = $msg_template->send( 'cust_main' => $self->cust_main,
913 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
914 'to' => \@invoicing_list,
915 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
916 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
919 #should this do something on errors?
926 =item cancel_if_expired [ NOW_TIMESTAMP ]
928 Cancels this package if its expire date has been reached.
932 sub cancel_if_expired {
934 my $time = shift || time;
935 return '' unless $self->expire && $self->expire <= $time;
936 my $error = $self->cancel;
938 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
939 $self->custnum. ": $error";
946 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
947 locationnum, (other fields?). Attempts to re-provision cancelled services
948 using history information (errors at this stage are not fatal).
950 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
952 svc_fatal: service provisioning errors are fatal
954 svc_errors: pass an array reference, will be filled in with any provisioning errors
956 main_pkgnum: link the package as a supplemental package of this one. For
962 my( $self, %options ) = @_;
964 #in case you try do do $uncancel-date = $cust_pkg->uncacel
965 return '' unless $self->get('cancel');
967 if ( $self->main_pkgnum and !$options{'main_pkgnum'} ) {
968 return $self->main_pkg->uncancel(%options);
975 local $SIG{HUP} = 'IGNORE';
976 local $SIG{INT} = 'IGNORE';
977 local $SIG{QUIT} = 'IGNORE';
978 local $SIG{TERM} = 'IGNORE';
979 local $SIG{TSTP} = 'IGNORE';
980 local $SIG{PIPE} = 'IGNORE';
982 my $oldAutoCommit = $FS::UID::AutoCommit;
983 local $FS::UID::AutoCommit = 0;
987 # insert the new package
990 my $cust_pkg = new FS::cust_pkg {
991 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
992 bill => ( $options{'bill'} || $self->get('bill') ),
994 uncancel_pkgnum => $self->pkgnum,
995 main_pkgnum => ($options{'main_pkgnum'} || ''),
996 map { $_ => $self->get($_) } qw(
997 custnum pkgpart locationnum
999 susp adjourn resume expire start_date contract_end dundate
1000 change_date change_pkgpart change_locationnum
1001 manual_flag no_auto quantity agent_pkgid recur_show_zero setup_show_zero
1005 my $error = $cust_pkg->insert(
1006 'change' => 1, #supresses any referral credit to a referring customer
1007 'allow_pkgpart' => 1, # allow this even if the package def is disabled
1010 $dbh->rollback if $oldAutoCommit;
1018 #find historical services within this timeframe before the package cancel
1019 # (incompatible with "time" option to cust_pkg->cancel?)
1020 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
1021 # too little? (unprovisioing export delay?)
1022 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
1023 my @h_cust_svc = $self->h_cust_svc( $end, $start );
1026 foreach my $h_cust_svc (@h_cust_svc) {
1027 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
1028 #next unless $h_svc_x; #should this happen?
1029 (my $table = $h_svc_x->table) =~ s/^h_//;
1030 require "FS/$table.pm";
1031 my $class = "FS::$table";
1032 my $svc_x = $class->new( {
1033 'pkgnum' => $cust_pkg->pkgnum,
1034 'svcpart' => $h_cust_svc->svcpart,
1035 map { $_ => $h_svc_x->get($_) } fields($table)
1039 if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
1040 $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
1043 my $svc_error = $svc_x->insert;
1045 if ( $options{svc_fatal} ) {
1046 $dbh->rollback if $oldAutoCommit;
1049 # if we've failed to insert the svc_x object, svc_Common->insert
1050 # will have removed the cust_svc already. if not, then both records
1051 # were inserted but we failed for some other reason (export, most
1052 # likely). in that case, report the error and delete the records.
1053 push @svc_errors, $svc_error;
1054 my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1056 # except if export_insert failed, export_delete probably won't be
1058 local $FS::svc_Common::noexport_hack = 1;
1059 my $cleanup_error = $svc_x->delete; # also deletes cust_svc
1060 if ( $cleanup_error ) { # and if THAT fails, then run away
1061 $dbh->rollback if $oldAutoCommit;
1062 return $cleanup_error;
1067 } #foreach $h_cust_svc
1069 #these are pretty rare, but should handle them
1070 # - dsl_device (mac addresses)
1071 # - phone_device (mac addresses)
1072 # - dsl_note (ikano notes)
1073 # - domain_record (i.e. restore DNS information w/domains)
1074 # - inventory_item(?) (inventory w/un-cancelling service?)
1075 # - nas (svc_broaband nas stuff)
1076 #this stuff is unused in the wild afaik
1077 # - mailinglistmember
1079 # - svc_domain.parent_svcnum?
1080 # - acct_snarf (ancient mail fetching config)
1081 # - cgp_rule (communigate)
1082 # - cust_svc_option (used by our Tron stuff)
1083 # - acct_rt_transaction (used by our time worked stuff)
1086 # also move over any services that didn't unprovision at cancellation
1089 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1090 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1091 my $error = $cust_svc->replace;
1093 $dbh->rollback if $oldAutoCommit;
1099 # Uncancel any supplemental packages, and make them supplemental to the
1103 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1105 $error = $supp_pkg->uncancel(%options, 'main_pkgnum' => $cust_pkg->pkgnum);
1107 $dbh->rollback if $oldAutoCommit;
1108 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1116 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1118 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1119 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1126 Cancels any pending expiration (sets the expire field to null).
1128 If there is an error, returns the error, otherwise returns false.
1133 my( $self, %options ) = @_;
1136 local $SIG{HUP} = 'IGNORE';
1137 local $SIG{INT} = 'IGNORE';
1138 local $SIG{QUIT} = 'IGNORE';
1139 local $SIG{TERM} = 'IGNORE';
1140 local $SIG{TSTP} = 'IGNORE';
1141 local $SIG{PIPE} = 'IGNORE';
1143 my $oldAutoCommit = $FS::UID::AutoCommit;
1144 local $FS::UID::AutoCommit = 0;
1147 my $old = $self->select_for_update;
1149 my $pkgnum = $old->pkgnum;
1150 if ( $old->get('cancel') || $self->get('cancel') ) {
1151 dbh->rollback if $oldAutoCommit;
1152 return "Can't unexpire cancelled package $pkgnum";
1153 # or at least it's pointless
1156 unless ( $old->get('expire') && $self->get('expire') ) {
1157 dbh->rollback if $oldAutoCommit;
1158 return ""; # no error
1161 my %hash = $self->hash;
1162 $hash{'expire'} = '';
1163 my $new = new FS::cust_pkg ( \%hash );
1164 $error = $new->replace( $self, options => { $self->options } );
1166 $dbh->rollback if $oldAutoCommit;
1170 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1176 =item suspend [ OPTION => VALUE ... ]
1178 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1179 package, then suspends the package itself (sets the susp field to now).
1181 Available options are:
1185 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1186 either a reasonnum of an existing reason, or passing a hashref will create
1187 a new reason. The hashref should have the following keys:
1188 - typenum - Reason type (see L<FS::reason_type>
1189 - reason - Text of the new reason.
1191 =item date - can be set to a unix style timestamp to specify when to
1194 =item time - can be set to override the current time, for calculation
1195 of final invoices or unused-time credits
1197 =item resume_date - can be set to a time when the package should be
1198 unsuspended. This may be more convenient than calling C<unsuspend()>
1201 =item from_main - allows a supplemental package to be suspended, rather
1202 than redirecting the method call to its main package. For internal use.
1206 If there is an error, returns the error, otherwise returns false.
1211 my( $self, %options ) = @_;
1214 # pass all suspend/cancel actions to the main package
1215 if ( $self->main_pkgnum and !$options{'from_main'} ) {
1216 return $self->main_pkg->suspend(%options);
1219 local $SIG{HUP} = 'IGNORE';
1220 local $SIG{INT} = 'IGNORE';
1221 local $SIG{QUIT} = 'IGNORE';
1222 local $SIG{TERM} = 'IGNORE';
1223 local $SIG{TSTP} = 'IGNORE';
1224 local $SIG{PIPE} = 'IGNORE';
1226 my $oldAutoCommit = $FS::UID::AutoCommit;
1227 local $FS::UID::AutoCommit = 0;
1230 my $old = $self->select_for_update;
1232 my $pkgnum = $old->pkgnum;
1233 if ( $old->get('cancel') || $self->get('cancel') ) {
1234 dbh->rollback if $oldAutoCommit;
1235 return "Can't suspend cancelled package $pkgnum";
1238 if ( $old->get('susp') || $self->get('susp') ) {
1239 dbh->rollback if $oldAutoCommit;
1240 return ""; # no error # complain on adjourn?
1243 my $suspend_time = $options{'time'} || time;
1244 my $date = $options{date} if $options{date}; # adjourn/suspend later
1245 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1247 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1248 dbh->rollback if $oldAutoCommit;
1249 return "Package $pkgnum expires before it would be suspended.";
1252 # some false laziness with sub cancel
1253 if ( !$options{nobill} && !$date &&
1254 $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1255 # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1256 # make the entire cust_main->bill path recognize 'suspend' and
1257 # 'cancel' separately.
1258 warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1259 my $copy = $self->new({$self->hash});
1261 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1263 'time' => $suspend_time );
1264 warn "Error billing during suspend, custnum ".
1265 #$self->cust_main->custnum. ": $error"
1270 if ( $options{'reason'} ) {
1271 $error = $self->insert_reason( 'reason' => $options{'reason'},
1272 'action' => $date ? 'adjourn' : 'suspend',
1273 'date' => $date ? $date : $suspend_time,
1274 'reason_otaker' => $options{'reason_otaker'},
1277 dbh->rollback if $oldAutoCommit;
1278 return "Error inserting cust_pkg_reason: $error";
1282 my %hash = $self->hash;
1284 $hash{'adjourn'} = $date;
1286 $hash{'susp'} = $suspend_time;
1289 my $resume_date = $options{'resume_date'} || 0;
1290 if ( $resume_date > ($date || $suspend_time) ) {
1291 $hash{'resume'} = $resume_date;
1294 $options{options} ||= {};
1296 my $new = new FS::cust_pkg ( \%hash );
1297 $error = $new->replace( $self, options => { $self->options,
1298 %{ $options{options} },
1302 $dbh->rollback if $oldAutoCommit;
1307 # credit remaining time if appropriate
1308 if ( $self->part_pkg->option('unused_credit_suspend', 1) ) {
1309 my $error = $self->credit_remaining('suspend', $suspend_time);
1311 $dbh->rollback if $oldAutoCommit;
1318 foreach my $cust_svc (
1319 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1321 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1323 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1324 $dbh->rollback if $oldAutoCommit;
1325 return "Illegal svcdb value in part_svc!";
1328 require "FS/$svcdb.pm";
1330 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1332 $error = $svc->suspend;
1334 $dbh->rollback if $oldAutoCommit;
1337 my( $label, $value ) = $cust_svc->label;
1338 push @labels, "$label: $value";
1342 my $conf = new FS::Conf;
1343 if ( $conf->config('suspend_email_admin') ) {
1345 my $error = send_email(
1346 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1347 #invoice_from ??? well as good as any
1348 'to' => $conf->config('suspend_email_admin'),
1349 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1351 "This is an automatic message from your Freeside installation\n",
1352 "informing you that the following customer package has been suspended:\n",
1354 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1355 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1356 ( map { "Service : $_\n" } @labels ),
1361 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1369 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1370 $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1372 $dbh->rollback if $oldAutoCommit;
1373 return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1377 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1382 =item credit_remaining MODE TIME
1384 Generate a credit for this package for the time remaining in the current
1385 billing period. MODE is either "suspend" or "cancel" (determines the
1386 credit type). TIME is the time of suspension/cancellation. Both arguments
1391 sub credit_remaining {
1392 # Add a credit for remaining service
1393 my ($self, $mode, $time) = @_;
1394 die 'credit_remaining requires suspend or cancel'
1395 unless $mode eq 'suspend' or $mode eq 'cancel';
1396 die 'no suspend/cancel time' unless $time > 0;
1398 my $conf = FS::Conf->new;
1399 my $reason_type = $conf->config($mode.'_credit_type');
1401 my $last_bill = $self->getfield('last_bill') || 0;
1402 my $next_bill = $self->getfield('bill') || 0;
1403 if ( $last_bill > 0 # the package has been billed
1404 and $next_bill > 0 # the package has a next bill date
1405 and $next_bill >= $time # which is in the future
1407 my $remaining_value = $self->calc_remain('time' => $time);
1408 if ( $remaining_value > 0 ) {
1409 warn "Crediting for $remaining_value on package ".$self->pkgnum."\n"
1411 my $error = $self->cust_main->credit(
1413 'Credit for unused time on '. $self->part_pkg->pkg,
1414 'reason_type' => $reason_type,
1416 return "Error crediting customer \$$remaining_value for unused time".
1417 " on ". $self->part_pkg->pkg. ": $error"
1419 } #if $remaining_value
1420 } #if $last_bill, etc.
1424 =item unsuspend [ OPTION => VALUE ... ]
1426 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1427 package, then unsuspends the package itself (clears the susp field and the
1428 adjourn field if it is in the past). If the suspend reason includes an
1429 unsuspension package, that package will be ordered.
1431 Available options are:
1437 Can be set to a date to unsuspend the package in the future (the 'resume'
1440 =item adjust_next_bill
1442 Can be set true to adjust the next bill date forward by
1443 the amount of time the account was inactive. This was set true by default
1444 since 1.4.2 and 1.5.0pre6; however, starting with 1.7.0 this needs to be
1445 explicitly requested. Price plans for which this makes sense (anniversary-date
1446 based than prorate or subscription) could have an option to enable this
1451 If there is an error, returns the error, otherwise returns false.
1456 my( $self, %opt ) = @_;
1459 # pass all suspend/cancel actions to the main package
1460 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1461 return $self->main_pkg->unsuspend(%opt);
1464 local $SIG{HUP} = 'IGNORE';
1465 local $SIG{INT} = 'IGNORE';
1466 local $SIG{QUIT} = 'IGNORE';
1467 local $SIG{TERM} = 'IGNORE';
1468 local $SIG{TSTP} = 'IGNORE';
1469 local $SIG{PIPE} = 'IGNORE';
1471 my $oldAutoCommit = $FS::UID::AutoCommit;
1472 local $FS::UID::AutoCommit = 0;
1475 my $old = $self->select_for_update;
1477 my $pkgnum = $old->pkgnum;
1478 if ( $old->get('cancel') || $self->get('cancel') ) {
1479 $dbh->rollback if $oldAutoCommit;
1480 return "Can't unsuspend cancelled package $pkgnum";
1483 unless ( $old->get('susp') && $self->get('susp') ) {
1484 $dbh->rollback if $oldAutoCommit;
1485 return ""; # no error # complain instead?
1488 my $date = $opt{'date'};
1489 if ( $date and $date > time ) { # return an error if $date <= time?
1491 if ( $old->get('expire') && $old->get('expire') < $date ) {
1492 $dbh->rollback if $oldAutoCommit;
1493 return "Package $pkgnum expires before it would be unsuspended.";
1496 my $new = new FS::cust_pkg { $self->hash };
1497 $new->set('resume', $date);
1498 $error = $new->replace($self, options => $self->options);
1501 $dbh->rollback if $oldAutoCommit;
1505 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1513 foreach my $cust_svc (
1514 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1516 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1518 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1519 $dbh->rollback if $oldAutoCommit;
1520 return "Illegal svcdb value in part_svc!";
1523 require "FS/$svcdb.pm";
1525 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1527 $error = $svc->unsuspend;
1529 $dbh->rollback if $oldAutoCommit;
1532 my( $label, $value ) = $cust_svc->label;
1533 push @labels, "$label: $value";
1538 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1539 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1541 my %hash = $self->hash;
1542 my $inactive = time - $hash{'susp'};
1544 my $conf = new FS::Conf;
1546 if ( $inactive > 0 &&
1547 ( $hash{'bill'} || $hash{'setup'} ) &&
1548 ( $opt{'adjust_next_bill'} ||
1549 $conf->exists('unsuspend-always_adjust_next_bill_date') ||
1550 $self->part_pkg->option('unsuspend_adjust_bill', 1) )
1553 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1558 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1559 $hash{'resume'} = '' if !$hash{'adjourn'};
1560 my $new = new FS::cust_pkg ( \%hash );
1561 $error = $new->replace( $self, options => { $self->options } );
1563 $dbh->rollback if $oldAutoCommit;
1569 if ( $reason && $reason->unsuspend_pkgpart ) {
1570 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
1571 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
1573 my $start_date = $self->cust_main->next_bill_date
1574 if $reason->unsuspend_hold;
1577 $unsusp_pkg = FS::cust_pkg->new({
1578 'custnum' => $self->custnum,
1579 'pkgpart' => $reason->unsuspend_pkgpart,
1580 'start_date' => $start_date,
1581 'locationnum' => $self->locationnum,
1582 # discount? probably not...
1585 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
1589 $dbh->rollback if $oldAutoCommit;
1594 if ( $conf->config('unsuspend_email_admin') ) {
1596 my $error = send_email(
1597 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1598 #invoice_from ??? well as good as any
1599 'to' => $conf->config('unsuspend_email_admin'),
1600 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
1601 "This is an automatic message from your Freeside installation\n",
1602 "informing you that the following customer package has been unsuspended:\n",
1604 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1605 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1606 ( map { "Service : $_\n" } @labels ),
1608 "An unsuspension fee was charged: ".
1609 $unsusp_pkg->part_pkg->pkg_comment."\n"
1616 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
1622 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1623 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
1625 $dbh->rollback if $oldAutoCommit;
1626 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1630 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1637 Cancels any pending suspension (sets the adjourn field to null).
1639 If there is an error, returns the error, otherwise returns false.
1644 my( $self, %options ) = @_;
1647 local $SIG{HUP} = 'IGNORE';
1648 local $SIG{INT} = 'IGNORE';
1649 local $SIG{QUIT} = 'IGNORE';
1650 local $SIG{TERM} = 'IGNORE';
1651 local $SIG{TSTP} = 'IGNORE';
1652 local $SIG{PIPE} = 'IGNORE';
1654 my $oldAutoCommit = $FS::UID::AutoCommit;
1655 local $FS::UID::AutoCommit = 0;
1658 my $old = $self->select_for_update;
1660 my $pkgnum = $old->pkgnum;
1661 if ( $old->get('cancel') || $self->get('cancel') ) {
1662 dbh->rollback if $oldAutoCommit;
1663 return "Can't unadjourn cancelled package $pkgnum";
1664 # or at least it's pointless
1667 if ( $old->get('susp') || $self->get('susp') ) {
1668 dbh->rollback if $oldAutoCommit;
1669 return "Can't unadjourn suspended package $pkgnum";
1670 # perhaps this is arbitrary
1673 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1674 dbh->rollback if $oldAutoCommit;
1675 return ""; # no error
1678 my %hash = $self->hash;
1679 $hash{'adjourn'} = '';
1680 $hash{'resume'} = '';
1681 my $new = new FS::cust_pkg ( \%hash );
1682 $error = $new->replace( $self, options => { $self->options } );
1684 $dbh->rollback if $oldAutoCommit;
1688 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1695 =item change HASHREF | OPTION => VALUE ...
1697 Changes this package: cancels it and creates a new one, with a different
1698 pkgpart or locationnum or both. All services are transferred to the new
1699 package (no change will be made if this is not possible).
1701 Options may be passed as a list of key/value pairs or as a hash reference.
1708 New locationnum, to change the location for this package.
1712 New FS::cust_location object, to create a new location and assign it
1717 New FS::cust_main object, to create a new customer and assign the new package
1722 New pkgpart (see L<FS::part_pkg>).
1726 New refnum (see L<FS::part_referral>).
1730 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1731 susp, adjourn, cancel, expire, and contract_end) to the new package.
1735 At least one of locationnum, cust_location, pkgpart, refnum must be specified
1736 (otherwise, what's the point?)
1738 Returns either the new FS::cust_pkg object or a scalar error.
1742 my $err_or_new_cust_pkg = $old_cust_pkg->change
1746 #some false laziness w/order
1749 my $opt = ref($_[0]) ? shift : { @_ };
1751 # my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
1754 my $conf = new FS::Conf;
1756 # Transactionize this whole mess
1757 local $SIG{HUP} = 'IGNORE';
1758 local $SIG{INT} = 'IGNORE';
1759 local $SIG{QUIT} = 'IGNORE';
1760 local $SIG{TERM} = 'IGNORE';
1761 local $SIG{TSTP} = 'IGNORE';
1762 local $SIG{PIPE} = 'IGNORE';
1764 my $oldAutoCommit = $FS::UID::AutoCommit;
1765 local $FS::UID::AutoCommit = 0;
1774 #$hash{$_} = $self->$_() foreach qw( last_bill bill );
1776 #$hash{$_} = $self->$_() foreach qw( setup );
1778 $hash{'setup'} = $time if $self->setup;
1780 $hash{'change_date'} = $time;
1781 $hash{"change_$_"} = $self->$_()
1782 foreach qw( pkgnum pkgpart locationnum );
1784 if ( $opt->{'cust_location'} ) {
1785 $error = $opt->{'cust_location'}->find_or_insert;
1787 $dbh->rollback if $oldAutoCommit;
1788 return "inserting cust_location (transaction rolled back): $error";
1790 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1793 # whether to override pkgpart checking on the new package
1794 my $same_pkgpart = 1;
1795 if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
1799 my $unused_credit = 0;
1800 my $keep_dates = $opt->{'keep_dates'};
1801 # Special case. If the pkgpart is changing, and the customer is
1802 # going to be credited for remaining time, don't keep setup, bill,
1803 # or last_bill dates, and DO pass the flag to cancel() to credit
1805 if ( $opt->{'pkgpart'}
1806 and $opt->{'pkgpart'} != $self->pkgpart
1807 and $self->part_pkg->option('unused_credit_change', 1) ) {
1810 $hash{$_} = '' foreach qw(setup bill last_bill);
1813 if ( $keep_dates ) {
1814 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1815 resume start_date contract_end ) ) {
1816 $hash{$date} = $self->getfield($date);
1819 # allow $opt->{'locationnum'} = '' to specifically set it to null
1820 # (i.e. customer default location)
1821 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
1823 # usually this doesn't matter. the two cases where it does are:
1824 # 1. unused_credit_change + pkgpart change + setup fee on the new package
1826 # 2. (more importantly) changing a package before it's billed
1827 $hash{'waive_setup'} = $self->waive_setup;
1829 my $custnum = $self->custnum;
1830 if ( $opt->{cust_main} ) {
1831 my $cust_main = $opt->{cust_main};
1832 unless ( $cust_main->custnum ) {
1833 my $error = $cust_main->insert;
1835 $dbh->rollback if $oldAutoCommit;
1836 return "inserting cust_main (transaction rolled back): $error";
1839 $custnum = $cust_main->custnum;
1842 $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
1844 # Create the new package.
1845 my $cust_pkg = new FS::cust_pkg {
1846 custnum => $custnum,
1847 pkgpart => ( $opt->{'pkgpart'} || $self->pkgpart ),
1848 refnum => ( $opt->{'refnum'} || $self->refnum ),
1849 locationnum => ( $opt->{'locationnum'} ),
1852 $error = $cust_pkg->insert( 'change' => 1,
1853 'allow_pkgpart' => $same_pkgpart );
1855 $dbh->rollback if $oldAutoCommit;
1859 # Transfer services and cancel old package.
1861 $error = $self->transfer($cust_pkg);
1862 if ($error and $error == 0) {
1863 # $old_pkg->transfer failed.
1864 $dbh->rollback if $oldAutoCommit;
1868 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
1869 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
1870 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
1871 if ($error and $error == 0) {
1872 # $old_pkg->transfer failed.
1873 $dbh->rollback if $oldAutoCommit;
1879 # Transfers were successful, but we still had services left on the old
1880 # package. We can't change the package under this circumstances, so abort.
1881 $dbh->rollback if $oldAutoCommit;
1882 return "Unable to transfer all services from package ". $self->pkgnum;
1885 #reset usage if changing pkgpart
1886 # AND usage rollover is off (otherwise adds twice, now and at package bill)
1887 if ($self->pkgpart != $cust_pkg->pkgpart) {
1888 my $part_pkg = $cust_pkg->part_pkg;
1889 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
1893 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
1896 $dbh->rollback if $oldAutoCommit;
1897 return "Error setting usage values: $error";
1900 # if NOT changing pkgpart, transfer any usage pools over
1901 foreach my $usage ($self->cust_pkg_usage) {
1902 $usage->set('pkgnum', $cust_pkg->pkgnum);
1903 $error = $usage->replace;
1905 $dbh->rollback if $oldAutoCommit;
1906 return "Error transferring usage pools: $error";
1911 # transfer discounts, if we're not changing pkgpart
1912 if ( $same_pkgpart ) {
1913 foreach my $old_discount ($self->cust_pkg_discount_active) {
1914 # don't remove the old discount, we may still need to bill that package.
1915 my $new_discount = new FS::cust_pkg_discount {
1916 'pkgnum' => $cust_pkg->pkgnum,
1917 'discountnum' => $old_discount->discountnum,
1918 'months_used' => $old_discount->months_used,
1920 $error = $new_discount->insert;
1922 $dbh->rollback if $oldAutoCommit;
1923 return "Error transferring discounts: $error";
1928 # transfer (copy) invoice details
1929 foreach my $detail ($self->cust_pkg_detail) {
1930 my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
1931 $new_detail->set('pkgdetailnum', '');
1932 $new_detail->set('pkgnum', $cust_pkg->pkgnum);
1933 $error = $new_detail->insert;
1935 $dbh->rollback if $oldAutoCommit;
1936 return "Error transferring package notes: $error";
1940 # Order any supplemental packages.
1941 my $part_pkg = $cust_pkg->part_pkg;
1942 my @old_supp_pkgs = $self->supplemental_pkgs;
1944 foreach my $link ($part_pkg->supp_part_pkg_link) {
1946 foreach (@old_supp_pkgs) {
1947 if ($_->pkgpart == $link->dst_pkgpart) {
1949 $_->pkgpart(0); # so that it can't match more than once
1953 # false laziness with FS::cust_main::Packages::order_pkg
1954 my $new = FS::cust_pkg->new({
1955 pkgpart => $link->dst_pkgpart,
1956 pkglinknum => $link->pkglinknum,
1957 custnum => $custnum,
1958 main_pkgnum => $cust_pkg->pkgnum,
1959 locationnum => $cust_pkg->locationnum,
1960 start_date => $cust_pkg->start_date,
1961 order_date => $cust_pkg->order_date,
1962 expire => $cust_pkg->expire,
1963 adjourn => $cust_pkg->adjourn,
1964 contract_end => $cust_pkg->contract_end,
1965 refnum => $cust_pkg->refnum,
1966 discountnum => $cust_pkg->discountnum,
1967 waive_setup => $cust_pkg->waive_setup,
1969 if ( $old and $opt->{'keep_dates'} ) {
1970 foreach (qw(setup bill last_bill)) {
1971 $new->set($_, $old->get($_));
1974 $error = $new->insert( allow_pkgpart => $same_pkgpart );
1977 $error ||= $old->transfer($new);
1979 if ( $error and $error > 0 ) {
1980 # no reason why this should ever fail, but still...
1981 $error = "Unable to transfer all services from supplemental package ".
1985 $dbh->rollback if $oldAutoCommit;
1988 push @new_supp_pkgs, $new;
1991 #Good to go, cancel old package. Notify 'cancel' of whether to credit
1993 #Don't allow billing the package (preceding period packages and/or
1994 #outstanding usage) if we are keeping dates (i.e. location changing),
1995 #because the new package will be billed for the same date range.
1996 #Supplemental packages are also canceled here.
1997 $error = $self->cancel(
1999 unused_credit => $unused_credit,
2000 nobill => $keep_dates,
2001 change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2004 $dbh->rollback if $oldAutoCommit;
2008 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2010 my $error = $cust_pkg->cust_main->bill(
2011 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2014 $dbh->rollback if $oldAutoCommit;
2019 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2025 =item set_quantity QUANTITY
2027 Change the package's quantity field. This is the one package property
2028 that can safely be changed without canceling and reordering the package
2029 (because it doesn't affect tax eligibility). Returns an error or an
2036 $self = $self->replace_old; # just to make sure
2038 ($qty =~ /^\d+$/ and $qty > 0) or return "bad package quantity $qty";
2039 $self->set('quantity' => $qty);
2043 use Storable 'thaw';
2045 sub process_bulk_cust_pkg {
2047 my $param = thaw(decode_base64(shift));
2048 warn Dumper($param) if $DEBUG;
2050 my $old_part_pkg = qsearchs('part_pkg',
2051 { pkgpart => $param->{'old_pkgpart'} });
2052 my $new_part_pkg = qsearchs('part_pkg',
2053 { pkgpart => $param->{'new_pkgpart'} });
2054 die "Must select a new package type\n" unless $new_part_pkg;
2055 #my $keep_dates = $param->{'keep_dates'} || 0;
2056 my $keep_dates = 1; # there is no good reason to turn this off
2058 local $SIG{HUP} = 'IGNORE';
2059 local $SIG{INT} = 'IGNORE';
2060 local $SIG{QUIT} = 'IGNORE';
2061 local $SIG{TERM} = 'IGNORE';
2062 local $SIG{TSTP} = 'IGNORE';
2063 local $SIG{PIPE} = 'IGNORE';
2065 my $oldAutoCommit = $FS::UID::AutoCommit;
2066 local $FS::UID::AutoCommit = 0;
2069 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
2072 foreach my $old_cust_pkg ( @cust_pkgs ) {
2074 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
2075 if ( $old_cust_pkg->getfield('cancel') ) {
2076 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
2077 $old_cust_pkg->pkgnum."\n"
2081 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
2083 my $error = $old_cust_pkg->change(
2084 'pkgpart' => $param->{'new_pkgpart'},
2085 'keep_dates' => $keep_dates
2087 if ( !ref($error) ) { # change returns the cust_pkg on success
2089 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
2092 $dbh->commit if $oldAutoCommit;
2098 Returns the last bill date, or if there is no last bill date, the setup date.
2099 Useful for billing metered services.
2105 return $self->setfield('last_bill', $_[0]) if @_;
2106 return $self->getfield('last_bill') if $self->getfield('last_bill');
2107 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
2108 'edate' => $self->bill, } );
2109 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
2112 =item last_cust_pkg_reason ACTION
2114 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
2115 Returns false if there is no reason or the package is not currenly ACTION'd
2116 ACTION is one of adjourn, susp, cancel, or expire.
2120 sub last_cust_pkg_reason {
2121 my ( $self, $action ) = ( shift, shift );
2122 my $date = $self->get($action);
2124 'table' => 'cust_pkg_reason',
2125 'hashref' => { 'pkgnum' => $self->pkgnum,
2126 'action' => substr(uc($action), 0, 1),
2129 'order_by' => 'ORDER BY num DESC LIMIT 1',
2133 =item last_reason ACTION
2135 Returns the most recent ACTION FS::reason associated with the package.
2136 Returns false if there is no reason or the package is not currenly ACTION'd
2137 ACTION is one of adjourn, susp, cancel, or expire.
2142 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
2143 $cust_pkg_reason->reason
2144 if $cust_pkg_reason;
2149 Returns the definition for this billing item, as an FS::part_pkg object (see
2156 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
2157 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
2158 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
2163 Returns the cancelled package this package was changed from, if any.
2169 return '' unless $self->change_pkgnum;
2170 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
2173 =item change_cust_main
2175 Returns the customter this package was detached to, if any.
2179 sub change_cust_main {
2181 return '' unless $self->change_custnum;
2182 qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
2187 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
2194 $self->part_pkg->calc_setup($self, @_);
2199 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
2206 $self->part_pkg->calc_recur($self, @_);
2211 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
2218 $self->part_pkg->base_recur($self, @_);
2223 Calls the I<calc_remain> of the FS::part_pkg object associated with this
2230 $self->part_pkg->calc_remain($self, @_);
2235 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
2242 $self->part_pkg->calc_cancel($self, @_);
2247 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
2253 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
2256 =item cust_pkg_detail [ DETAILTYPE ]
2258 Returns any customer package details for this package (see
2259 L<FS::cust_pkg_detail>).
2261 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2265 sub cust_pkg_detail {
2267 my %hash = ( 'pkgnum' => $self->pkgnum );
2268 $hash{detailtype} = shift if @_;
2270 'table' => 'cust_pkg_detail',
2271 'hashref' => \%hash,
2272 'order_by' => 'ORDER BY weight, pkgdetailnum',
2276 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
2278 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
2280 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2282 If there is an error, returns the error, otherwise returns false.
2286 sub set_cust_pkg_detail {
2287 my( $self, $detailtype, @details ) = @_;
2289 local $SIG{HUP} = 'IGNORE';
2290 local $SIG{INT} = 'IGNORE';
2291 local $SIG{QUIT} = 'IGNORE';
2292 local $SIG{TERM} = 'IGNORE';
2293 local $SIG{TSTP} = 'IGNORE';
2294 local $SIG{PIPE} = 'IGNORE';
2296 my $oldAutoCommit = $FS::UID::AutoCommit;
2297 local $FS::UID::AutoCommit = 0;
2300 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
2301 my $error = $current->delete;
2303 $dbh->rollback if $oldAutoCommit;
2304 return "error removing old detail: $error";
2308 foreach my $detail ( @details ) {
2309 my $cust_pkg_detail = new FS::cust_pkg_detail {
2310 'pkgnum' => $self->pkgnum,
2311 'detailtype' => $detailtype,
2312 'detail' => $detail,
2314 my $error = $cust_pkg_detail->insert;
2316 $dbh->rollback if $oldAutoCommit;
2317 return "error adding new detail: $error";
2322 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2329 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
2333 #false laziness w/cust_bill.pm
2337 'table' => 'cust_event',
2338 'addl_from' => 'JOIN part_event USING ( eventpart )',
2339 'hashref' => { 'tablenum' => $self->pkgnum },
2340 'extra_sql' => " AND eventtable = 'cust_pkg' ",
2344 =item num_cust_event
2346 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
2350 #false laziness w/cust_bill.pm
2351 sub num_cust_event {
2354 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
2355 " WHERE tablenum = ? AND eventtable = 'cust_pkg'";
2356 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
2357 $sth->execute($self->pkgnum) or die $sth->errstr. " executing $sql";
2358 $sth->fetchrow_arrayref->[0];
2361 =item cust_svc [ SVCPART ] (old, deprecated usage)
2363 =item cust_svc [ OPTION => VALUE ... ] (current usage)
2365 Returns the services for this package, as FS::cust_svc objects (see
2366 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
2367 spcififed, returns only the matching services.
2374 return () unless $self->num_cust_svc(@_);
2377 if ( @_ && $_[0] =~ /^\d+/ ) {
2378 $opt{svcpart} = shift;
2379 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2386 'table' => 'cust_svc',
2387 'hashref' => { 'pkgnum' => $self->pkgnum },
2389 if ( $opt{svcpart} ) {
2390 $search{hashref}->{svcpart} = $opt{'svcpart'};
2392 if ( $opt{'svcdb'} ) {
2393 $search{addl_from} = ' LEFT JOIN part_svc USING ( svcpart ) ';
2394 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{'svcdb'} );
2397 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
2399 #if ( $self->{'_svcnum'} ) {
2400 # values %{ $self->{'_svcnum'}->cache };
2402 $self->_sort_cust_svc( [ qsearch(\%search) ] );
2407 =item overlimit [ SVCPART ]
2409 Returns the services for this package which have exceeded their
2410 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
2411 is specified, return only the matching services.
2417 return () unless $self->num_cust_svc(@_);
2418 grep { $_->overlimit } $self->cust_svc(@_);
2421 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2423 Returns historical services for this package created before END TIMESTAMP and
2424 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
2425 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
2426 I<pkg_svc.hidden> flag will be omitted.
2432 warn "$me _h_cust_svc called on $self\n"
2435 my ($end, $start, $mode) = @_;
2436 my @cust_svc = $self->_sort_cust_svc(
2437 [ qsearch( 'h_cust_svc',
2438 { 'pkgnum' => $self->pkgnum, },
2439 FS::h_cust_svc->sql_h_search(@_),
2442 if ( defined($mode) && $mode eq 'I' ) {
2443 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
2444 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
2450 sub _sort_cust_svc {
2451 my( $self, $arrayref ) = @_;
2454 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
2459 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $self->pkgpart,
2460 'svcpart' => $_->svcpart } );
2462 $pkg_svc ? $pkg_svc->primary_svc : '',
2463 $pkg_svc ? $pkg_svc->quantity : 0,
2470 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
2472 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
2474 Returns the number of services for this package. Available options are svcpart
2475 and svcdb. If either is spcififed, returns only the matching services.
2482 return $self->{'_num_cust_svc'}
2484 && exists($self->{'_num_cust_svc'})
2485 && $self->{'_num_cust_svc'} =~ /\d/;
2487 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
2491 if ( @_ && $_[0] =~ /^\d+/ ) {
2492 $opt{svcpart} = shift;
2493 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2499 my $select = 'SELECT COUNT(*) FROM cust_svc ';
2500 my $where = ' WHERE pkgnum = ? ';
2501 my @param = ($self->pkgnum);
2503 if ( $opt{'svcpart'} ) {
2504 $where .= ' AND svcpart = ? ';
2505 push @param, $opt{'svcpart'};
2507 if ( $opt{'svcdb'} ) {
2508 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
2509 $where .= ' AND svcdb = ? ';
2510 push @param, $opt{'svcdb'};
2513 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
2514 $sth->execute(@param) or die $sth->errstr;
2515 $sth->fetchrow_arrayref->[0];
2518 =item available_part_svc
2520 Returns a list of FS::part_svc objects representing services included in this
2521 package but not yet provisioned. Each FS::part_svc object also has an extra
2522 field, I<num_avail>, which specifies the number of available services.
2526 sub available_part_svc {
2529 my $pkg_quantity = $self->quantity || 1;
2531 grep { $_->num_avail > 0 }
2533 my $part_svc = $_->part_svc;
2534 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
2535 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
2537 # more evil encapsulation breakage
2538 if($part_svc->{'Hash'}{'num_avail'} > 0) {
2539 my @exports = $part_svc->part_export_did;
2540 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
2545 $self->part_pkg->pkg_svc;
2548 =item part_svc [ OPTION => VALUE ... ]
2550 Returns a list of FS::part_svc objects representing provisioned and available
2551 services included in this package. Each FS::part_svc object also has the
2552 following extra fields:
2556 =item num_cust_svc (count)
2558 =item num_avail (quantity - count)
2560 =item cust_pkg_svc (services) - array reference containing the provisioned services, as cust_svc objects
2564 Accepts one option: summarize_size. If specified and non-zero, will omit the
2565 extra cust_pkg_svc option for objects where num_cust_svc is this size or
2571 #label -> ($cust_svc->label)[1]
2577 my $pkg_quantity = $self->quantity || 1;
2579 #XXX some sort of sort order besides numeric by svcpart...
2580 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
2582 my $part_svc = $pkg_svc->part_svc;
2583 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
2584 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
2585 $part_svc->{'Hash'}{'num_avail'} =
2586 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
2587 $part_svc->{'Hash'}{'cust_pkg_svc'} =
2588 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
2589 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
2590 && $num_cust_svc >= $opt{summarize_size};
2591 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
2593 } $self->part_pkg->pkg_svc;
2596 push @part_svc, map {
2598 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
2599 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
2600 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
2601 $part_svc->{'Hash'}{'cust_pkg_svc'} =
2602 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
2604 } $self->extra_part_svc;
2610 =item extra_part_svc
2612 Returns a list of FS::part_svc objects corresponding to services in this
2613 package which are still provisioned but not (any longer) available in the
2618 sub extra_part_svc {
2621 my $pkgnum = $self->pkgnum;
2622 #my $pkgpart = $self->pkgpart;
2625 # 'table' => 'part_svc',
2628 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
2629 # WHERE pkg_svc.svcpart = part_svc.svcpart
2630 # AND pkg_svc.pkgpart = ?
2633 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
2634 # LEFT JOIN cust_pkg USING ( pkgnum )
2635 # WHERE cust_svc.svcpart = part_svc.svcpart
2638 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
2641 #seems to benchmark slightly faster... (or did?)
2643 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
2644 my $pkgparts = join(',', @pkgparts);
2647 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
2648 #MySQL doesn't grok DISINCT ON
2649 'select' => 'DISTINCT part_svc.*',
2650 'table' => 'part_svc',
2652 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
2653 AND pkg_svc.pkgpart IN ($pkgparts)
2656 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
2657 LEFT JOIN cust_pkg USING ( pkgnum )
2660 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
2661 'extra_param' => [ [$self->pkgnum=>'int'] ],
2667 Returns a short status string for this package, currently:
2671 =item not yet billed
2673 =item one-time charge
2688 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
2690 return 'cancelled' if $self->get('cancel');
2691 return 'suspended' if $self->susp;
2692 return 'not yet billed' unless $self->setup;
2693 return 'one-time charge' if $freq =~ /^(0|$)/;
2697 =item ucfirst_status
2699 Returns the status with the first character capitalized.
2703 sub ucfirst_status {
2704 ucfirst(shift->status);
2709 Class method that returns the list of possible status strings for packages
2710 (see L<the status method|/status>). For example:
2712 @statuses = FS::cust_pkg->statuses();
2716 tie my %statuscolor, 'Tie::IxHash',
2717 'not yet billed' => '009999', #teal? cyan?
2718 'one-time charge' => '000000',
2719 'active' => '00CC00',
2720 'suspended' => 'FF9900',
2721 'cancelled' => 'FF0000',
2725 my $self = shift; #could be class...
2726 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
2727 # # mayble split btw one-time vs. recur
2733 Returns a hex triplet color string for this package's status.
2739 $statuscolor{$self->status};
2744 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
2745 "pkg - comment" depending on user preference).
2751 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
2752 $label = $self->pkgnum. ": $label"
2753 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
2757 =item pkg_label_long
2759 Returns a long label for this package, adding the primary service's label to
2764 sub pkg_label_long {
2766 my $label = $self->pkg_label;
2767 my $cust_svc = $self->primary_cust_svc;
2768 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
2774 Returns a customer-localized label for this package.
2780 $self->part_pkg->pkg_locale( $self->cust_main->locale );
2783 =item primary_cust_svc
2785 Returns a primary service (as FS::cust_svc object) if one can be identified.
2789 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
2791 sub primary_cust_svc {
2794 my @cust_svc = $self->cust_svc;
2796 return '' unless @cust_svc; #no serivces - irrelevant then
2798 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
2800 # primary service as specified in the package definition
2801 # or exactly one service definition with quantity one
2802 my $svcpart = $self->part_pkg->svcpart;
2803 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
2804 return $cust_svc[0] if scalar(@cust_svc) == 1;
2806 #couldn't identify one thing..
2812 Returns a list of lists, calling the label method for all services
2813 (see L<FS::cust_svc>) of this billing item.
2819 map { [ $_->label ] } $self->cust_svc;
2822 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2824 Like the labels method, but returns historical information on services that
2825 were active as of END_TIMESTAMP and (optionally) not cancelled before
2826 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
2827 I<pkg_svc.hidden> flag will be omitted.
2829 Returns a list of lists, calling the label method for all (historical) services
2830 (see L<FS::h_cust_svc>) of this billing item.
2836 warn "$me _h_labels called on $self\n"
2838 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
2843 Like labels, except returns a simple flat list, and shortens long
2844 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2845 identical services to one line that lists the service label and the number of
2846 individual services rather than individual items.
2851 shift->_labels_short( 'labels', @_ );
2854 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
2856 Like h_labels, except returns a simple flat list, and shortens long
2857 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2858 identical services to one line that lists the service label and the number of
2859 individual services rather than individual items.
2863 sub h_labels_short {
2864 shift->_labels_short( 'h_labels', @_ );
2868 my( $self, $method ) = ( shift, shift );
2870 warn "$me _labels_short called on $self with $method method\n"
2873 my $conf = new FS::Conf;
2874 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
2876 warn "$me _labels_short populating \%labels\n"
2880 #tie %labels, 'Tie::IxHash';
2881 push @{ $labels{$_->[0]} }, $_->[1]
2882 foreach $self->$method(@_);
2884 warn "$me _labels_short populating \@labels\n"
2888 foreach my $label ( keys %labels ) {
2890 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
2891 my $num = scalar(@values);
2892 warn "$me _labels_short $num items for $label\n"
2895 if ( $num > $max_same_services ) {
2896 warn "$me _labels_short more than $max_same_services, so summarizing\n"
2898 push @labels, "$label ($num)";
2900 if ( $conf->exists('cust_bill-consolidate_services') ) {
2901 warn "$me _labels_short consolidating services\n"
2903 # push @labels, "$label: ". join(', ', @values);
2905 my $detail = "$label: ";
2906 $detail .= shift(@values). ', '
2908 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
2910 push @labels, $detail;
2912 warn "$me _labels_short done consolidating services\n"
2915 warn "$me _labels_short adding service data\n"
2917 push @labels, map { "$label: $_" } @values;
2928 Returns the parent customer object (see L<FS::cust_main>).
2934 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
2939 Returns the balance for this specific package, when using
2940 experimental package balance.
2946 $self->cust_main->balance_pkgnum( $self->pkgnum );
2949 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
2953 Returns the location object, if any (see L<FS::cust_location>).
2955 =item cust_location_or_main
2957 If this package is associated with a location, returns the locaiton (see
2958 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
2960 =item location_label [ OPTION => VALUE ... ]
2962 Returns the label of the location object (see L<FS::cust_location>).
2966 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
2968 =item tax_locationnum
2970 Returns the foreign key to a L<FS::cust_location> object for calculating
2971 tax on this package, as determined by the C<tax-pkg_address> and
2972 C<tax-ship_address> configuration flags.
2976 sub tax_locationnum {
2978 my $conf = FS::Conf->new;
2979 if ( $conf->exists('tax-pkg_address') ) {
2980 return $self->locationnum;
2982 elsif ( $conf->exists('tax-ship_address') ) {
2983 return $self->cust_main->ship_locationnum;
2986 return $self->cust_main->bill_locationnum;
2992 Returns the L<FS::cust_location> object for tax_locationnum.
2998 FS::cust_location->by_key( $self->tax_locationnum )
3001 =item seconds_since TIMESTAMP
3003 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
3004 package have been online since TIMESTAMP, according to the session monitor.
3006 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
3007 L<Time::Local> and L<Date::Parse> for conversion functions.
3012 my($self, $since) = @_;
3015 foreach my $cust_svc (
3016 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
3018 $seconds += $cust_svc->seconds_since($since);
3025 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
3027 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
3028 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
3031 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3032 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3038 sub seconds_since_sqlradacct {
3039 my($self, $start, $end) = @_;
3043 foreach my $cust_svc (
3045 my $part_svc = $_->part_svc;
3046 $part_svc->svcdb eq 'svc_acct'
3047 && scalar($part_svc->part_export_usage);
3050 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
3057 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
3059 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
3060 in this package for sessions ending between TIMESTAMP_START (inclusive) and
3064 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3065 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3070 sub attribute_since_sqlradacct {
3071 my($self, $start, $end, $attrib) = @_;
3075 foreach my $cust_svc (
3077 my $part_svc = $_->part_svc;
3078 $part_svc->svcdb eq 'svc_acct'
3079 && scalar($part_svc->part_export_usage);
3082 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
3094 my( $self, $value ) = @_;
3095 if ( defined($value) ) {
3096 $self->setfield('quantity', $value);
3098 $self->getfield('quantity') || 1;
3101 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
3103 Transfers as many services as possible from this package to another package.
3105 The destination package can be specified by pkgnum by passing an FS::cust_pkg
3106 object. The destination package must already exist.
3108 Services are moved only if the destination allows services with the correct
3109 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
3110 this option with caution! No provision is made for export differences
3111 between the old and new service definitions. Probably only should be used
3112 when your exports for all service definitions of a given svcdb are identical.
3113 (attempt a transfer without it first, to move all possible svcpart-matching
3116 Any services that can't be moved remain in the original package.
3118 Returns an error, if there is one; otherwise, returns the number of services
3119 that couldn't be moved.
3124 my ($self, $dest_pkgnum, %opt) = @_;
3130 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
3131 $dest = $dest_pkgnum;
3132 $dest_pkgnum = $dest->pkgnum;
3134 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
3137 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
3139 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
3140 $target{$pkg_svc->svcpart} = $pkg_svc->quantity;
3143 foreach my $cust_svc ($dest->cust_svc) {
3144 $target{$cust_svc->svcpart}--;
3147 my %svcpart2svcparts = ();
3148 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3149 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
3150 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
3151 next if exists $svcpart2svcparts{$svcpart};
3152 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
3153 $svcpart2svcparts{$svcpart} = [
3155 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
3157 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
3158 'svcpart' => $_ } );
3160 $pkg_svc ? $pkg_svc->primary_svc : '',
3161 $pkg_svc ? $pkg_svc->quantity : 0,
3165 grep { $_ != $svcpart }
3167 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
3169 warn "alternates for svcpart $svcpart: ".
3170 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
3175 foreach my $cust_svc ($self->cust_svc) {
3176 if($target{$cust_svc->svcpart} > 0
3177 or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
3178 $target{$cust_svc->svcpart}--;
3179 my $new = new FS::cust_svc { $cust_svc->hash };
3180 $new->pkgnum($dest_pkgnum);
3181 my $error = $new->replace($cust_svc);
3182 return $error if $error;
3183 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3185 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
3186 warn "alternates to consider: ".
3187 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
3189 my @alternate = grep {
3190 warn "considering alternate svcpart $_: ".
3191 "$target{$_} available in new package\n"
3194 } @{$svcpart2svcparts{$cust_svc->svcpart}};
3196 warn "alternate(s) found\n" if $DEBUG;
3197 my $change_svcpart = $alternate[0];
3198 $target{$change_svcpart}--;
3199 my $new = new FS::cust_svc { $cust_svc->hash };
3200 $new->svcpart($change_svcpart);
3201 $new->pkgnum($dest_pkgnum);
3202 my $error = $new->replace($cust_svc);
3203 return $error if $error;
3214 =item grab_svcnums SVCNUM, SVCNUM ...
3216 Change the pkgnum for the provided services to this packages. If there is an
3217 error, returns the error, otherwise returns false.
3225 local $SIG{HUP} = 'IGNORE';
3226 local $SIG{INT} = 'IGNORE';
3227 local $SIG{QUIT} = 'IGNORE';
3228 local $SIG{TERM} = 'IGNORE';
3229 local $SIG{TSTP} = 'IGNORE';
3230 local $SIG{PIPE} = 'IGNORE';
3232 my $oldAutoCommit = $FS::UID::AutoCommit;
3233 local $FS::UID::AutoCommit = 0;
3236 foreach my $svcnum (@svcnum) {
3237 my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
3238 $dbh->rollback if $oldAutoCommit;
3239 return "unknown svcnum $svcnum";
3241 $cust_svc->pkgnum( $self->pkgnum );
3242 my $error = $cust_svc->replace;
3244 $dbh->rollback if $oldAutoCommit;
3249 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3256 This method is deprecated. See the I<depend_jobnum> option to the insert and
3257 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
3264 local $SIG{HUP} = 'IGNORE';
3265 local $SIG{INT} = 'IGNORE';
3266 local $SIG{QUIT} = 'IGNORE';
3267 local $SIG{TERM} = 'IGNORE';
3268 local $SIG{TSTP} = 'IGNORE';
3269 local $SIG{PIPE} = 'IGNORE';
3271 my $oldAutoCommit = $FS::UID::AutoCommit;
3272 local $FS::UID::AutoCommit = 0;
3275 foreach my $cust_svc ( $self->cust_svc ) {
3276 #false laziness w/svc_Common::insert
3277 my $svc_x = $cust_svc->svc_x;
3278 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
3279 my $error = $part_export->export_insert($svc_x);
3281 $dbh->rollback if $oldAutoCommit;
3287 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3292 =item export_pkg_change OLD_CUST_PKG
3294 Calls the "pkg_change" export action for all services attached to this package.
3298 sub export_pkg_change {
3299 my( $self, $old ) = ( shift, shift );
3301 local $SIG{HUP} = 'IGNORE';
3302 local $SIG{INT} = 'IGNORE';
3303 local $SIG{QUIT} = 'IGNORE';
3304 local $SIG{TERM} = 'IGNORE';
3305 local $SIG{TSTP} = 'IGNORE';
3306 local $SIG{PIPE} = 'IGNORE';
3308 my $oldAutoCommit = $FS::UID::AutoCommit;
3309 local $FS::UID::AutoCommit = 0;
3312 foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
3313 my $error = $svc_x->export('pkg_change', $self, $old);
3315 $dbh->rollback if $oldAutoCommit;
3320 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3327 Associates this package with a (suspension or cancellation) reason (see
3328 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
3331 Available options are:
3337 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.
3341 the access_user (see L<FS::access_user>) providing the reason
3349 the action (cancel, susp, adjourn, expire) associated with the reason
3353 If there is an error, returns the error, otherwise returns false.
3358 my ($self, %options) = @_;
3360 my $otaker = $options{reason_otaker} ||
3361 $FS::CurrentUser::CurrentUser->username;
3364 if ( $options{'reason'} =~ /^(\d+)$/ ) {
3368 } elsif ( ref($options{'reason'}) ) {
3370 return 'Enter a new reason (or select an existing one)'
3371 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
3373 my $reason = new FS::reason({
3374 'reason_type' => $options{'reason'}->{'typenum'},
3375 'reason' => $options{'reason'}->{'reason'},
3377 my $error = $reason->insert;
3378 return $error if $error;
3380 $reasonnum = $reason->reasonnum;
3383 return "Unparsable reason: ". $options{'reason'};
3386 my $cust_pkg_reason =
3387 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
3388 'reasonnum' => $reasonnum,
3389 'otaker' => $otaker,
3390 'action' => substr(uc($options{'action'}),0,1),
3391 'date' => $options{'date'}
3396 $cust_pkg_reason->insert;
3399 =item insert_discount
3401 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
3402 inserting a new discount on the fly (see L<FS::discount>).
3404 Available options are:
3412 If there is an error, returns the error, otherwise returns false.
3416 sub insert_discount {
3417 #my ($self, %options) = @_;
3420 my $cust_pkg_discount = new FS::cust_pkg_discount {
3421 'pkgnum' => $self->pkgnum,
3422 'discountnum' => $self->discountnum,
3424 'end_date' => '', #XXX
3425 #for the create a new discount case
3426 '_type' => $self->discountnum__type,
3427 'amount' => $self->discountnum_amount,
3428 'percent' => $self->discountnum_percent,
3429 'months' => $self->discountnum_months,
3430 'setup' => $self->discountnum_setup,
3431 #'disabled' => $self->discountnum_disabled,
3434 $cust_pkg_discount->insert;
3437 =item set_usage USAGE_VALUE_HASHREF
3439 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
3440 to which they should be set (see L<FS::svc_acct>). Currently seconds,
3441 upbytes, downbytes, and totalbytes are appropriate keys.
3443 All svc_accts which are part of this package have their values reset.
3448 my ($self, $valueref, %opt) = @_;
3450 #only svc_acct can set_usage for now
3451 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
3452 my $svc_x = $cust_svc->svc_x;
3453 $svc_x->set_usage($valueref, %opt)
3454 if $svc_x->can("set_usage");
3458 =item recharge USAGE_VALUE_HASHREF
3460 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
3461 to which they should be set (see L<FS::svc_acct>). Currently seconds,
3462 upbytes, downbytes, and totalbytes are appropriate keys.
3464 All svc_accts which are part of this package have their values incremented.
3469 my ($self, $valueref) = @_;
3471 #only svc_acct can set_usage for now
3472 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
3473 my $svc_x = $cust_svc->svc_x;
3474 $svc_x->recharge($valueref)
3475 if $svc_x->can("recharge");
3479 =item cust_pkg_discount
3483 sub cust_pkg_discount {
3485 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
3488 =item cust_pkg_discount_active
3492 sub cust_pkg_discount_active {
3494 grep { $_->status eq 'active' } $self->cust_pkg_discount;
3497 =item cust_pkg_usage
3499 Returns a list of all voice usage counters attached to this package.
3503 sub cust_pkg_usage {
3505 qsearch('cust_pkg_usage', { pkgnum => $self->pkgnum });
3508 =item apply_usage OPTIONS
3510 Takes the following options:
3511 - cdr: a call detail record (L<FS::cdr>)
3512 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
3513 - minutes: the maximum number of minutes to be charged
3515 Finds available usage minutes for a call of this class, and subtracts
3516 up to that many minutes from the usage pool. If the usage pool is empty,
3517 and the C<cdr-minutes_priority> global config option is set, minutes may
3518 be taken from other calls as well. Either way, an allocation record will
3519 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
3520 number of minutes of usage applied to the call.
3525 my ($self, %opt) = @_;
3526 my $cdr = $opt{cdr};
3527 my $rate_detail = $opt{rate_detail};
3528 my $minutes = $opt{minutes};
3529 my $classnum = $rate_detail->classnum;
3530 my $pkgnum = $self->pkgnum;
3531 my $custnum = $self->custnum;
3533 local $SIG{HUP} = 'IGNORE';
3534 local $SIG{INT} = 'IGNORE';
3535 local $SIG{QUIT} = 'IGNORE';
3536 local $SIG{TERM} = 'IGNORE';
3537 local $SIG{TSTP} = 'IGNORE';
3538 local $SIG{PIPE} = 'IGNORE';
3540 my $oldAutoCommit = $FS::UID::AutoCommit;
3541 local $FS::UID::AutoCommit = 0;
3543 my $order = FS::Conf->new->config('cdr-minutes_priority');
3547 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
3549 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
3551 my @usage_recs = qsearch({
3552 'table' => 'cust_pkg_usage',
3553 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
3554 ' JOIN cust_pkg USING (pkgnum)'.
3555 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
3556 'select' => 'cust_pkg_usage.*',
3557 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
3558 " ( cust_pkg.custnum = $custnum AND ".
3559 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
3560 $is_classnum . ' AND '.
3561 " cust_pkg_usage.minutes > 0",
3562 'order_by' => " ORDER BY priority ASC",
3565 my $orig_minutes = $minutes;
3567 while (!$error and $minutes > 0 and @usage_recs) {
3568 my $cust_pkg_usage = shift @usage_recs;
3569 $cust_pkg_usage->select_for_update;
3570 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
3571 pkgusagenum => $cust_pkg_usage->pkgusagenum,
3572 acctid => $cdr->acctid,
3573 minutes => min($cust_pkg_usage->minutes, $minutes),
3575 $cust_pkg_usage->set('minutes',
3576 sprintf('%.0f', $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes)
3578 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
3579 $minutes -= $cdr_cust_pkg_usage->minutes;
3581 if ( $order and $minutes > 0 and !$error ) {
3582 # then try to steal minutes from another call
3584 'table' => 'cdr_cust_pkg_usage',
3585 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
3586 ' JOIN part_pkg_usage USING (pkgusagepart)'.
3587 ' JOIN cust_pkg USING (pkgnum)'.
3588 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
3589 ' JOIN cdr USING (acctid)',
3590 'select' => 'cdr_cust_pkg_usage.*',
3591 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
3592 " ( cust_pkg.pkgnum = $pkgnum OR ".
3593 " ( cust_pkg.custnum = $custnum AND ".
3594 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
3595 " part_pkg_usage_class.classnum = $classnum",
3596 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
3598 if ( $order eq 'time' ) {
3599 # find CDRs that are using minutes, but have a later startdate
3601 my $startdate = $cdr->startdate;
3602 if ($startdate !~ /^\d+$/) {
3603 die "bad cdr startdate '$startdate'";
3605 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
3606 # minimize needless reshuffling
3607 $search{'order_by'} .= ', cdr.startdate DESC';
3609 # XXX may not work correctly with rate_time schedules. Could
3610 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
3612 $search{'addl_from'} .=
3613 ' JOIN rate_detail'.
3614 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
3615 if ( $order eq 'rate_high' ) {
3616 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
3617 $rate_detail->min_charge;
3618 $search{'order_by'} .= ', rate_detail.min_charge ASC';
3619 } elsif ( $order eq 'rate_low' ) {
3620 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
3621 $rate_detail->min_charge;
3622 $search{'order_by'} .= ', rate_detail.min_charge DESC';
3624 # this should really never happen
3625 die "invalid cdr-minutes_priority value '$order'\n";
3628 my @cdr_usage_recs = qsearch(\%search);
3630 while (!$error and @cdr_usage_recs and $minutes > 0) {
3631 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
3632 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
3633 my $old_cdr = $cdr_cust_pkg_usage->cdr;
3634 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
3635 $cdr_cust_pkg_usage->select_for_update;
3636 $old_cdr->select_for_update;
3637 $cust_pkg_usage->select_for_update;
3638 # in case someone else stole the usage from this CDR
3639 # while waiting for the lock...
3640 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
3641 # steal the usage allocation and flag the old CDR for reprocessing
3642 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
3643 # if the allocation is more minutes than we need, adjust it...
3644 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
3646 $cdr_cust_pkg_usage->set('minutes', $minutes);
3647 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
3648 $error = $cust_pkg_usage->replace;
3650 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
3651 $error ||= $cdr_cust_pkg_usage->replace;
3652 # deduct the stolen minutes
3653 $minutes -= $cdr_cust_pkg_usage->minutes;
3655 # after all minute-stealing is done, reset the affected CDRs
3656 foreach (values %reproc_cdrs) {
3657 $error ||= $_->set_status('');
3658 # XXX or should we just call $cdr->rate right here?
3659 # it's not like we can create a loop this way, since the min_charge
3660 # or call time has to go monotonically in one direction.
3661 # we COULD get some very deep recursions going, though...
3663 } # if $order and $minutes
3666 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
3668 $dbh->commit if $oldAutoCommit;
3669 return $orig_minutes - $minutes;
3673 =item supplemental_pkgs
3675 Returns a list of all packages supplemental to this one.
3679 sub supplemental_pkgs {
3681 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
3686 Returns the package that this one is supplemental to, if any.
3692 if ( $self->main_pkgnum ) {
3693 return FS::cust_pkg->by_key($self->main_pkgnum);
3700 =head1 CLASS METHODS
3706 Returns an SQL expression identifying recurring packages.
3710 sub recurring_sql { "
3711 '0' != ( select freq from part_pkg
3712 where cust_pkg.pkgpart = part_pkg.pkgpart )
3717 Returns an SQL expression identifying one-time packages.
3722 '0' = ( select freq from part_pkg
3723 where cust_pkg.pkgpart = part_pkg.pkgpart )
3728 Returns an SQL expression identifying ordered packages (recurring packages not
3734 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
3739 Returns an SQL expression identifying active packages.
3744 $_[0]->recurring_sql. "
3745 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
3746 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3747 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
3750 =item not_yet_billed_sql
3752 Returns an SQL expression identifying packages which have not yet been billed.
3756 sub not_yet_billed_sql { "
3757 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
3758 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3759 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
3764 Returns an SQL expression identifying inactive packages (one-time packages
3765 that are otherwise unsuspended/uncancelled).
3769 sub inactive_sql { "
3770 ". $_[0]->onetime_sql(). "
3771 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
3772 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3773 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
3779 Returns an SQL expression identifying suspended packages.
3783 sub suspended_sql { susp_sql(@_); }
3785 #$_[0]->recurring_sql(). ' AND '.
3787 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3788 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
3795 Returns an SQL exprression identifying cancelled packages.
3799 sub cancelled_sql { cancel_sql(@_); }
3801 #$_[0]->recurring_sql(). ' AND '.
3802 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
3807 Returns an SQL expression to give the package status as a string.
3813 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
3814 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
3815 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
3816 WHEN ".onetime_sql()." THEN 'one-time charge'
3821 =item search HASHREF
3825 Returns a qsearch hash expression to search for parameters specified in HASHREF.
3826 Valid parameters are
3834 active, inactive, suspended, cancel (or cancelled)
3838 active, inactive, suspended, one-time charge, inactive, cancel (or cancelled)
3842 boolean selects custom packages
3848 pkgpart or arrayref or hashref of pkgparts
3852 arrayref of beginning and ending epoch date
3856 arrayref of beginning and ending epoch date
3860 arrayref of beginning and ending epoch date
3864 arrayref of beginning and ending epoch date
3868 arrayref of beginning and ending epoch date
3872 arrayref of beginning and ending epoch date
3876 arrayref of beginning and ending epoch date
3880 pkgnum or APKG_pkgnum
3884 a value suited to passing to FS::UI::Web::cust_header
3888 specifies the user for agent virtualization
3892 boolean; if true, returns only packages with more than 0 FCC phone lines.
3894 =item state, country
3896 Limit to packages with a service location in the specified state and country.
3897 For FCC 477 reporting, mostly.
3904 my ($class, $params) = @_;
3911 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
3913 "cust_main.agentnum = $1";
3920 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
3922 "cust_pkg.custnum = $1";
3929 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
3931 "cust_pkg.pkgbatch = '$1'";
3938 if ( $params->{'magic'} eq 'active'
3939 || $params->{'status'} eq 'active' ) {
3941 push @where, FS::cust_pkg->active_sql();
3943 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
3944 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
3946 push @where, FS::cust_pkg->not_yet_billed_sql();
3948 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
3949 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
3951 push @where, FS::cust_pkg->inactive_sql();
3953 } elsif ( $params->{'magic'} eq 'suspended'
3954 || $params->{'status'} eq 'suspended' ) {
3956 push @where, FS::cust_pkg->suspended_sql();
3958 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
3959 || $params->{'status'} =~ /^cancell?ed$/ ) {
3961 push @where, FS::cust_pkg->cancelled_sql();
3966 # parse package class
3969 if ( exists($params->{'classnum'}) ) {
3972 if ( ref($params->{'classnum'}) ) {
3974 if ( ref($params->{'classnum'}) eq 'HASH' ) {
3975 @classnum = grep $params->{'classnum'}{$_}, keys %{ $params->{'classnum'} };
3976 } elsif ( ref($params->{'classnum'}) eq 'ARRAY' ) {
3977 @classnum = @{ $params->{'classnum'} };
3979 die 'unhandled classnum ref '. $params->{'classnum'};
3983 } elsif ( $params->{'classnum'} =~ /^(\d*)$/ && $1 ne '0' ) {
3990 my @nums = grep $_, @classnum;
3991 push @c_where, 'part_pkg.classnum IN ('. join(',',@nums). ')' if @nums;
3992 my $null = scalar( grep { $_ eq '' } @classnum );
3993 push @c_where, 'part_pkg.classnum IS NULL' if $null;
3995 if ( scalar(@c_where) == 1 ) {
3996 push @where, @c_where;
3997 } elsif ( @c_where ) {
3998 push @where, ' ( '. join(' OR ', @c_where). ' ) ';
4007 # parse package report options
4010 my @report_option = ();
4011 if ( exists($params->{'report_option'}) ) {
4012 if ( ref($params->{'report_option'}) eq 'ARRAY' ) {
4013 @report_option = @{ $params->{'report_option'} };
4014 } elsif ( $params->{'report_option'} =~ /^([,\d]*)$/ ) {
4015 @report_option = split(',', $1);
4020 if (@report_option) {
4021 # this will result in the empty set for the dangling comma case as it should
4023 map{ "0 < ( SELECT count(*) FROM part_pkg_option
4024 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
4025 AND optionname = 'report_option_$_'
4026 AND optionvalue = '1' )"
4030 foreach my $any ( grep /^report_option_any/, keys %$params ) {
4032 my @report_option_any = ();
4033 if ( ref($params->{$any}) eq 'ARRAY' ) {
4034 @report_option_any = @{ $params->{$any} };
4035 } elsif ( $params->{$any} =~ /^([,\d]*)$/ ) {
4036 @report_option_any = split(',', $1);
4039 if (@report_option_any) {
4040 # this will result in the empty set for the dangling comma case as it should
4041 push @where, ' ( '. join(' OR ',
4042 map{ "0 < ( SELECT count(*) FROM part_pkg_option
4043 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
4044 AND optionname = 'report_option_$_'
4045 AND optionvalue = '1' )"
4046 } @report_option_any
4056 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
4062 push @where, "(part_pkg.fcc_ds0s > 0 OR pkg_class.fcc_ds0s > 0)"
4063 if $params->{fcc_line};
4069 if ( exists($params->{'censustract'}) ) {
4070 $params->{'censustract'} =~ /^([.\d]*)$/;
4071 my $censustract = "cust_location.censustract = '$1'";
4072 $censustract .= ' OR cust_location.censustract is NULL' unless $1;
4073 push @where, "( $censustract )";
4077 # parse censustract2
4079 if ( exists($params->{'censustract2'})
4080 && $params->{'censustract2'} =~ /^(\d*)$/
4084 push @where, "cust_location.censustract LIKE '$1%'";
4087 "( cust_location.censustract = '' OR cust_location.censustract IS NULL )";
4092 # parse country/state
4094 for (qw(state country)) { # parsing rules are the same for these
4095 if ( exists($params->{$_})
4096 && uc($params->{$_}) =~ /^([A-Z]{2})$/ )
4098 # XXX post-2.3 only--before that, state/country may be in cust_main
4099 push @where, "cust_location.$_ = '$1'";
4107 if ( ref($params->{'pkgpart'}) ) {
4110 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
4111 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
4112 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
4113 @pkgpart = @{ $params->{'pkgpart'} };
4115 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
4118 @pkgpart = grep /^(\d+)$/, @pkgpart;
4120 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
4122 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
4123 push @where, "pkgpart = $1";
4132 #false laziness w/report_cust_pkg.html
4135 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
4136 'active' => { 'susp'=>1, 'cancel'=>1 },
4137 'suspended' => { 'cancel' => 1 },
4142 if( exists($params->{'active'} ) ) {
4143 # This overrides all the other date-related fields
4144 my($beginning, $ending) = @{$params->{'active'}};
4146 "cust_pkg.setup IS NOT NULL",
4147 "cust_pkg.setup <= $ending",
4148 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
4149 "NOT (".FS::cust_pkg->onetime_sql . ")";
4152 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end change_date cancel )) {
4154 next unless exists($params->{$field});
4156 my($beginning, $ending) = @{$params->{$field}};
4158 next if $beginning == 0 && $ending == 4294967295;
4161 "cust_pkg.$field IS NOT NULL",
4162 "cust_pkg.$field >= $beginning",
4163 "cust_pkg.$field <= $ending";
4165 $orderby ||= "ORDER BY cust_pkg.$field";
4170 $orderby ||= 'ORDER BY bill';
4173 # parse magic, legacy, etc.
4176 if ( $params->{'magic'} &&
4177 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
4180 $orderby = 'ORDER BY pkgnum';
4182 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
4183 push @where, "pkgpart = $1";
4186 } elsif ( $params->{'query'} eq 'pkgnum' ) {
4188 $orderby = 'ORDER BY pkgnum';
4190 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
4192 $orderby = 'ORDER BY pkgnum';
4195 SELECT count(*) FROM pkg_svc
4196 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
4197 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
4198 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
4199 AND cust_svc.svcpart = pkg_svc.svcpart
4206 # setup queries, links, subs, etc. for the search
4209 # here is the agent virtualization
4210 if ($params->{CurrentUser}) {
4212 qsearchs('access_user', { username => $params->{CurrentUser} });
4215 push @where, $access_user->agentnums_sql('table'=>'cust_main');
4220 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
4223 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
4225 my $addl_from = 'LEFT JOIN part_pkg USING ( pkgpart ) '.
4226 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) '.
4227 'LEFT JOIN cust_location USING ( locationnum ) '.
4228 FS::UI::Web::join_cust_main('cust_pkg', 'cust_pkg');
4232 if ( $params->{'select_zip5'} ) {
4233 my $zip = 'cust_location.zip';
4235 $select = "DISTINCT substr($zip,1,5) as zip";
4236 $orderby = "ORDER BY substr($zip,1,5)";
4237 $count_query = "SELECT COUNT( DISTINCT substr($zip,1,5) )";
4239 $select = join(', ',
4241 ( map "part_pkg.$_", qw( pkg freq ) ),
4242 'pkg_class.classname',
4243 'cust_main.custnum AS cust_main_custnum',
4244 FS::UI::Web::cust_sql_fields(
4245 $params->{'cust_fields'}
4248 $count_query = 'SELECT COUNT(*)';
4251 $count_query .= " FROM cust_pkg $addl_from $extra_sql";
4254 'table' => 'cust_pkg',
4256 'select' => $select,
4257 'extra_sql' => $extra_sql,
4258 'order_by' => $orderby,
4259 'addl_from' => $addl_from,
4260 'count_query' => $count_query,
4267 Returns a list of two package counts. The first is a count of packages
4268 based on the supplied criteria and the second is the count of residential
4269 packages with those same criteria. Criteria are specified as in the search
4275 my ($class, $params) = @_;
4277 my $sql_query = $class->search( $params );
4279 my $count_sql = delete($sql_query->{'count_query'});
4280 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
4281 or die "couldn't parse count_sql";
4283 my $count_sth = dbh->prepare($count_sql)
4284 or die "Error preparing $count_sql: ". dbh->errstr;
4286 or die "Error executing $count_sql: ". $count_sth->errstr;
4287 my $count_arrayref = $count_sth->fetchrow_arrayref;
4289 return ( @$count_arrayref );
4293 =item tax_locationnum_sql
4295 Returns an SQL expression for the tax location for a package, based
4296 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
4300 sub tax_locationnum_sql {
4301 my $conf = FS::Conf->new;
4302 if ( $conf->exists('tax-pkg_address') ) {
4303 'cust_pkg.locationnum';
4305 elsif ( $conf->exists('tax-ship_address') ) {
4306 'cust_main.ship_locationnum';
4309 'cust_main.bill_locationnum';
4315 Returns a list: the first item is an SQL fragment identifying matching
4316 packages/customers via location (taking into account shipping and package
4317 address taxation, if enabled), and subsequent items are the parameters to
4318 substitute for the placeholders in that fragment.
4323 my($class, %opt) = @_;
4324 my $ornull = $opt{'ornull'};
4326 my $conf = new FS::Conf;
4328 # '?' placeholders in _location_sql_where
4329 my $x = $ornull ? 3 : 2;
4340 if ( $conf->exists('tax-ship_address') ) {
4343 ( ( ship_last IS NULL OR ship_last = '' )
4344 AND ". _location_sql_where('cust_main', '', $ornull ). "
4346 OR ( ship_last IS NOT NULL AND ship_last != ''
4347 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
4350 # AND payby != 'COMP'
4352 @main_param = ( @bill_param, @bill_param );
4356 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
4357 @main_param = @bill_param;
4363 if ( $conf->exists('tax-pkg_address') ) {
4365 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
4368 ( cust_pkg.locationnum IS NULL AND $main_where )
4369 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
4372 @param = ( @main_param, @bill_param );
4376 $where = $main_where;
4377 @param = @main_param;
4385 #subroutine, helper for location_sql
4386 sub _location_sql_where {
4388 my $prefix = @_ ? shift : '';
4389 my $ornull = @_ ? shift : '';
4391 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
4393 $ornull = $ornull ? ' OR ? IS NULL ' : '';
4395 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
4396 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
4397 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
4399 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
4401 # ( $table.${prefix}city = ? $or_empty_city $ornull )
4403 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4404 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4405 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
4406 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
4407 AND $table.${prefix}country = ?
4412 my( $self, $what ) = @_;
4414 my $what_show_zero = $what. '_show_zero';
4415 length($self->$what_show_zero())
4416 ? ($self->$what_show_zero() eq 'Y')
4417 : $self->part_pkg->$what_show_zero();
4424 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
4426 CUSTNUM is a customer (see L<FS::cust_main>)
4428 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4429 L<FS::part_pkg>) to order for this customer. Duplicates are of course
4432 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
4433 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
4434 new billing items. An error is returned if this is not possible (see
4435 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
4438 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4439 newly-created cust_pkg objects.
4441 REFNUM, if specified, will specify the FS::pkg_referral record to be created
4442 and inserted. Multiple FS::pkg_referral records can be created by
4443 setting I<refnum> to an array reference of refnums or a hash reference with
4444 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
4445 record will be created corresponding to cust_main.refnum.
4450 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
4452 my $conf = new FS::Conf;
4454 # Transactionize this whole mess
4455 local $SIG{HUP} = 'IGNORE';
4456 local $SIG{INT} = 'IGNORE';
4457 local $SIG{QUIT} = 'IGNORE';
4458 local $SIG{TERM} = 'IGNORE';
4459 local $SIG{TSTP} = 'IGNORE';
4460 local $SIG{PIPE} = 'IGNORE';
4462 my $oldAutoCommit = $FS::UID::AutoCommit;
4463 local $FS::UID::AutoCommit = 0;
4467 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
4468 # return "Customer not found: $custnum" unless $cust_main;
4470 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
4473 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4476 my $change = scalar(@old_cust_pkg) != 0;
4479 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
4481 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
4482 " to pkgpart ". $pkgparts->[0]. "\n"
4485 my $err_or_cust_pkg =
4486 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
4487 'refnum' => $refnum,
4490 unless (ref($err_or_cust_pkg)) {
4491 $dbh->rollback if $oldAutoCommit;
4492 return $err_or_cust_pkg;
4495 push @$return_cust_pkg, $err_or_cust_pkg;
4496 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4501 # Create the new packages.
4502 foreach my $pkgpart (@$pkgparts) {
4504 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
4506 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
4507 pkgpart => $pkgpart,
4511 $error = $cust_pkg->insert( 'change' => $change );
4512 push @$return_cust_pkg, $cust_pkg;
4514 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
4515 my $supp_pkg = FS::cust_pkg->new({
4516 custnum => $custnum,
4517 pkgpart => $link->dst_pkgpart,
4519 main_pkgnum => $cust_pkg->pkgnum,
4522 $error ||= $supp_pkg->insert( 'change' => $change );
4523 push @$return_cust_pkg, $supp_pkg;
4527 $dbh->rollback if $oldAutoCommit;
4532 # $return_cust_pkg now contains refs to all of the newly
4535 # Transfer services and cancel old packages.
4536 foreach my $old_pkg (@old_cust_pkg) {
4538 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
4541 foreach my $new_pkg (@$return_cust_pkg) {
4542 $error = $old_pkg->transfer($new_pkg);
4543 if ($error and $error == 0) {
4544 # $old_pkg->transfer failed.
4545 $dbh->rollback if $oldAutoCommit;
4550 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
4551 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
4552 foreach my $new_pkg (@$return_cust_pkg) {
4553 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
4554 if ($error and $error == 0) {
4555 # $old_pkg->transfer failed.
4556 $dbh->rollback if $oldAutoCommit;
4563 # Transfers were successful, but we went through all of the
4564 # new packages and still had services left on the old package.
4565 # We can't cancel the package under the circumstances, so abort.
4566 $dbh->rollback if $oldAutoCommit;
4567 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
4569 $error = $old_pkg->cancel( quiet=>1 );
4575 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4579 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
4581 A bulk change method to change packages for multiple customers.
4583 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4584 L<FS::part_pkg>) to order for each customer. Duplicates are of course
4587 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
4588 replace. The services (see L<FS::cust_svc>) are moved to the
4589 new billing items. An error is returned if this is not possible (see
4592 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4593 newly-created cust_pkg objects.
4598 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
4600 # Transactionize this whole mess
4601 local $SIG{HUP} = 'IGNORE';
4602 local $SIG{INT} = 'IGNORE';
4603 local $SIG{QUIT} = 'IGNORE';
4604 local $SIG{TERM} = 'IGNORE';
4605 local $SIG{TSTP} = 'IGNORE';
4606 local $SIG{PIPE} = 'IGNORE';
4608 my $oldAutoCommit = $FS::UID::AutoCommit;
4609 local $FS::UID::AutoCommit = 0;
4613 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4616 while(scalar(@old_cust_pkg)) {
4618 my $custnum = $old_cust_pkg[0]->custnum;
4619 my (@remove) = map { $_->pkgnum }
4620 grep { $_->custnum == $custnum } @old_cust_pkg;
4621 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
4623 my $error = order $custnum, $pkgparts, \@remove, \@return;
4625 push @errors, $error
4627 push @$return_cust_pkg, @return;
4630 if (scalar(@errors)) {
4631 $dbh->rollback if $oldAutoCommit;
4632 return join(' / ', @errors);
4635 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4639 # Used by FS::Upgrade to migrate to a new database.
4640 sub _upgrade_data { # class method
4641 my ($class, %opts) = @_;
4642 $class->_upgrade_otaker(%opts);
4644 # RT#10139, bug resulting in contract_end being set when it shouldn't
4645 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
4646 # RT#10830, bad calculation of prorate date near end of year
4647 # the date range for bill is December 2009, and we move it forward
4648 # one year if it's before the previous bill date (which it should
4650 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
4651 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
4652 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
4653 # RT6628, add order_date to cust_pkg
4654 'update cust_pkg set order_date = (select history_date from h_cust_pkg
4655 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
4656 history_action = \'insert\') where order_date is null',
4658 foreach my $sql (@statements) {
4659 my $sth = dbh->prepare($sql);
4660 $sth->execute or die $sth->errstr;
4668 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
4670 In sub order, the @pkgparts array (passed by reference) is clobbered.
4672 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
4673 method to pass dates to the recur_prog expression, it should do so.
4675 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
4676 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
4677 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
4678 configuration values. Probably need a subroutine which decides what to do
4679 based on whether or not we've fetched the user yet, rather than a hash. See
4680 FS::UID and the TODO.
4682 Now that things are transactional should the check in the insert method be
4687 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
4688 L<FS::pkg_svc>, schema.html from the base documentation