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 any referral credit to a referring customer.
262 cust_pkg_option records will be created
266 a ticket will be added to this customer with this subject
270 an optional queue name for ticket additions
274 Don't check the legality of the package definition. This should be used
275 when performing a package change that doesn't change the pkgpart (i.e.
283 my( $self, %options ) = @_;
286 $error = $self->check_pkgpart unless $options{'allow_pkgpart'};
287 return $error if $error;
289 my $part_pkg = $self->part_pkg;
291 if ( $part_pkg->option('start_1st', 1) && !$self->start_date ) {
292 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime(time) )[0,1,2,3,4,5];
293 $mon += 1 unless $mday == 1;
294 until ( $mon < 12 ) { $mon -= 12; $year++; }
295 $self->start_date( timelocal_nocheck(0,0,0,1,$mon,$year) );
298 foreach my $action ( qw(expire adjourn contract_end) ) {
299 my $months = $part_pkg->option("${action}_months",1);
300 if($months and !$self->$action) {
301 my $start = $self->start_date || $self->setup || time;
302 $self->$action( $part_pkg->add_freq($start, $months) );
306 my $free_days = $part_pkg->option('free_days',1);
307 if ( $free_days && $part_pkg->option('delay_setup',1) ) { #&& !$self->start_date
308 my ($mday,$mon,$year) = (localtime(time) )[3,4,5];
309 #my $start_date = ($self->start_date || timelocal(0,0,0,$mday,$mon,$year)) + 86400 * $free_days;
310 my $start_date = timelocal(0,0,0,$mday,$mon,$year) + 86400 * $free_days;
311 $self->start_date($start_date);
314 $self->order_date(time);
316 local $SIG{HUP} = 'IGNORE';
317 local $SIG{INT} = 'IGNORE';
318 local $SIG{QUIT} = 'IGNORE';
319 local $SIG{TERM} = 'IGNORE';
320 local $SIG{TSTP} = 'IGNORE';
321 local $SIG{PIPE} = 'IGNORE';
323 my $oldAutoCommit = $FS::UID::AutoCommit;
324 local $FS::UID::AutoCommit = 0;
327 $error = $self->SUPER::insert($options{options} ? %{$options{options}} : ());
329 $dbh->rollback if $oldAutoCommit;
333 $self->refnum($self->cust_main->refnum) unless $self->refnum;
334 $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
335 $self->process_m2m( 'link_table' => 'pkg_referral',
336 'target_table' => 'part_referral',
337 'params' => $self->refnum,
340 if ( $self->discountnum ) {
341 my $error = $self->insert_discount();
343 $dbh->rollback if $oldAutoCommit;
348 #if ( $self->reg_code ) {
349 # my $reg_code = qsearchs('reg_code', { 'code' => $self->reg_code } );
350 # $error = $reg_code->delete;
352 # $dbh->rollback if $oldAutoCommit;
357 my $conf = new FS::Conf;
359 if ( $conf->config('ticket_system') && $options{ticket_subject} ) {
361 #this init stuff is still inefficient, but at least its limited to
362 # the small number (any?) folks using ticket emailing on pkg order
365 # use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
372 use FS::TicketSystem;
373 FS::TicketSystem->init();
375 my $q = new RT::Queue($RT::SystemUser);
376 $q->Load($options{ticket_queue}) if $options{ticket_queue};
377 my $t = new RT::Ticket($RT::SystemUser);
378 my $mime = new MIME::Entity;
379 $mime->build( Type => 'text/plain', Data => $options{ticket_subject} );
380 $t->Create( $options{ticket_queue} ? (Queue => $q) : (),
381 Subject => $options{ticket_subject},
384 $t->AddLink( Type => 'MemberOf',
385 Target => 'freeside://freeside/cust_main/'. $self->custnum,
389 if ($conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
390 my $queue = new FS::queue {
391 'job' => 'FS::cust_main::queueable_print',
393 $error = $queue->insert(
394 'custnum' => $self->custnum,
395 'template' => 'welcome_letter',
399 warn "can't send welcome letter: $error";
404 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
411 This method now works but you probably shouldn't use it.
413 You don't want to delete packages, because there would then be no record
414 the customer ever purchased the package. Instead, see the cancel method and
415 hide cancelled packages.
422 local $SIG{HUP} = 'IGNORE';
423 local $SIG{INT} = 'IGNORE';
424 local $SIG{QUIT} = 'IGNORE';
425 local $SIG{TERM} = 'IGNORE';
426 local $SIG{TSTP} = 'IGNORE';
427 local $SIG{PIPE} = 'IGNORE';
429 my $oldAutoCommit = $FS::UID::AutoCommit;
430 local $FS::UID::AutoCommit = 0;
433 foreach my $cust_pkg_discount ($self->cust_pkg_discount) {
434 my $error = $cust_pkg_discount->delete;
436 $dbh->rollback if $oldAutoCommit;
440 #cust_bill_pkg_discount?
442 foreach my $cust_pkg_detail ($self->cust_pkg_detail) {
443 my $error = $cust_pkg_detail->delete;
445 $dbh->rollback if $oldAutoCommit;
450 foreach my $cust_pkg_reason (
452 'table' => 'cust_pkg_reason',
453 'hashref' => { 'pkgnum' => $self->pkgnum },
457 my $error = $cust_pkg_reason->delete;
459 $dbh->rollback if $oldAutoCommit;
466 my $error = $self->SUPER::delete(@_);
468 $dbh->rollback if $oldAutoCommit;
472 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
478 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
480 Replaces the OLD_RECORD with this one in the database. If there is an error,
481 returns the error, otherwise returns false.
483 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
485 Changing pkgpart may have disasterous effects. See the order subroutine.
487 setup and bill are normally updated by calling the bill method of a customer
488 object (see L<FS::cust_main>).
490 suspend is normally updated by the suspend and unsuspend methods.
492 cancel is normally updated by the cancel method (and also the order subroutine
495 Available options are:
501 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.
505 the access_user (see L<FS::access_user>) providing the reason
509 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
518 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
523 ( ref($_[0]) eq 'HASH' )
527 #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
528 #return "Can't change otaker!" if $old->otaker ne $new->otaker;
531 #return "Can't change setup once it exists!"
532 # if $old->getfield('setup') &&
533 # $old->getfield('setup') != $new->getfield('setup');
535 #some logic for bill, susp, cancel?
537 local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
539 local $SIG{HUP} = 'IGNORE';
540 local $SIG{INT} = 'IGNORE';
541 local $SIG{QUIT} = 'IGNORE';
542 local $SIG{TERM} = 'IGNORE';
543 local $SIG{TSTP} = 'IGNORE';
544 local $SIG{PIPE} = 'IGNORE';
546 my $oldAutoCommit = $FS::UID::AutoCommit;
547 local $FS::UID::AutoCommit = 0;
550 foreach my $method ( qw(adjourn expire) ) { # How many reasons?
551 if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
552 my $error = $new->insert_reason(
553 'reason' => $options->{'reason'},
554 'date' => $new->$method,
556 'reason_otaker' => $options->{'reason_otaker'},
559 dbh->rollback if $oldAutoCommit;
560 return "Error inserting cust_pkg_reason: $error";
565 #save off and freeze RADIUS attributes for any associated svc_acct records
567 if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
569 #also check for specific exports?
570 # to avoid spurious modify export events
571 @svc_acct = map { $_->svc_x }
572 grep { $_->part_svc->svcdb eq 'svc_acct' }
575 $_->snapshot foreach @svc_acct;
579 my $error = $new->SUPER::replace($old,
580 $options->{options} ? $options->{options} : ()
583 $dbh->rollback if $oldAutoCommit;
587 #for prepaid packages,
588 #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
589 foreach my $old_svc_acct ( @svc_acct ) {
590 my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
592 $new_svc_acct->replace( $old_svc_acct,
593 'depend_jobnum' => $options->{depend_jobnum},
596 $dbh->rollback if $oldAutoCommit;
601 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
608 Checks all fields to make sure this is a valid billing item. If there is an
609 error, returns the error, otherwise returns false. Called by the insert and
617 if ( !$self->locationnum or $self->locationnum == -1 ) {
618 $self->set('locationnum', $self->cust_main->ship_locationnum);
622 $self->ut_numbern('pkgnum')
623 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
624 || $self->ut_numbern('pkgpart')
625 || $self->ut_foreign_keyn('contactnum', 'contact', 'contactnum' )
626 || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
627 || $self->ut_numbern('start_date')
628 || $self->ut_numbern('setup')
629 || $self->ut_numbern('bill')
630 || $self->ut_numbern('susp')
631 || $self->ut_numbern('cancel')
632 || $self->ut_numbern('adjourn')
633 || $self->ut_numbern('resume')
634 || $self->ut_numbern('expire')
635 || $self->ut_numbern('dundate')
636 || $self->ut_enum('no_auto', [ '', 'Y' ])
637 || $self->ut_enum('waive_setup', [ '', 'Y' ])
638 || $self->ut_numbern('agent_pkgid')
639 || $self->ut_enum('recur_show_zero', [ '', 'Y', 'N', ])
640 || $self->ut_enum('setup_show_zero', [ '', 'Y', 'N', ])
641 || $self->ut_foreign_keyn('main_pkgnum', 'cust_pkg', 'pkgnum')
642 || $self->ut_foreign_keyn('pkglinknum', 'part_pkg_link', 'pkglinknum')
644 return $error if $error;
646 return "A package with both start date (future start) and setup date (already started) will never bill"
647 if $self->start_date && $self->setup;
649 return "A future unsuspend date can only be set for a package with a suspend date"
650 if $self->resume and !$self->susp and !$self->adjourn;
652 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
654 if ( $self->dbdef_table->column('manual_flag') ) {
655 $self->manual_flag('') if $self->manual_flag eq ' ';
656 $self->manual_flag =~ /^([01]?)$/
657 or return "Illegal manual_flag ". $self->manual_flag;
658 $self->manual_flag($1);
666 Check the pkgpart to make sure it's allowed with the reg_code and/or
667 promo_code of the package (if present) and with the customer's agent.
668 Called from C<insert>, unless we are doing a package change that doesn't
676 # my $error = $self->ut_numbern('pkgpart'); # already done
679 if ( $self->reg_code ) {
681 unless ( grep { $self->pkgpart == $_->pkgpart }
682 map { $_->reg_code_pkg }
683 qsearchs( 'reg_code', { 'code' => $self->reg_code,
684 'agentnum' => $self->cust_main->agentnum })
686 return "Unknown registration code";
689 } elsif ( $self->promo_code ) {
692 qsearchs('part_pkg', {
693 'pkgpart' => $self->pkgpart,
694 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
696 return 'Unknown promotional code' unless $promo_part_pkg;
700 unless ( $disable_agentcheck ) {
702 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
703 return "agent ". $agent->agentnum. ':'. $agent->agent.
704 " can't purchase pkgpart ". $self->pkgpart
705 unless $agent->pkgpart_hashref->{ $self->pkgpart }
706 || $agent->agentnum == $self->part_pkg->agentnum;
709 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
710 return $error if $error;
718 =item cancel [ OPTION => VALUE ... ]
720 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
721 in this package, then cancels the package itself (sets the cancel field to
724 Available options are:
728 =item quiet - can be set true to supress email cancellation notices.
730 =item time - can be set to cancel the package based on a specific future or
731 historical date. Using time ensures that the remaining amount is calculated
732 correctly. Note however that this is an immediate cancel and just changes
733 the date. You are PROBABLY looking to expire the account instead of using
736 =item reason - can be set to a cancellation reason (see L<FS:reason>),
737 either a reasonnum of an existing reason, or passing a hashref will create
738 a new reason. The hashref should have the following keys: typenum - Reason
739 type (see L<FS::reason_type>, reason - Text of the new reason.
741 =item date - can be set to a unix style timestamp to specify when to
744 =item nobill - can be set true to skip billing if it might otherwise be done.
746 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
747 not credit it. This must be set (by change()) when changing the package
748 to a different pkgpart or location, and probably shouldn't be in any other
749 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
754 If there is an error, returns the error, otherwise returns false.
759 my( $self, %options ) = @_;
762 # pass all suspend/cancel actions to the main package
763 if ( $self->main_pkgnum and !$options{'from_main'} ) {
764 return $self->main_pkg->cancel(%options);
767 my $conf = new FS::Conf;
769 warn "cust_pkg::cancel called with options".
770 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
773 local $SIG{HUP} = 'IGNORE';
774 local $SIG{INT} = 'IGNORE';
775 local $SIG{QUIT} = 'IGNORE';
776 local $SIG{TERM} = 'IGNORE';
777 local $SIG{TSTP} = 'IGNORE';
778 local $SIG{PIPE} = 'IGNORE';
780 my $oldAutoCommit = $FS::UID::AutoCommit;
781 local $FS::UID::AutoCommit = 0;
784 my $old = $self->select_for_update;
786 if ( $old->get('cancel') || $self->get('cancel') ) {
787 dbh->rollback if $oldAutoCommit;
788 return ""; # no error
791 # XXX possibly set cancel_time to the expire date?
792 my $cancel_time = $options{'time'} || time;
793 my $date = $options{'date'} if $options{'date'}; # expire/cancel later
794 $date = '' if ($date && $date <= $cancel_time); # complain instead?
796 #race condition: usage could be ongoing until unprovisioned
797 #resolved by performing a change package instead (which unprovisions) and
799 if ( !$options{nobill} && !$date ) {
800 # && $conf->exists('bill_usage_on_cancel') ) { #calc_cancel checks this
801 my $copy = $self->new({$self->hash});
803 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
805 'time' => $cancel_time );
806 warn "Error billing during cancel, custnum ".
807 #$self->cust_main->custnum. ": $error"
812 if ( $options{'reason'} ) {
813 $error = $self->insert_reason( 'reason' => $options{'reason'},
814 'action' => $date ? 'expire' : 'cancel',
815 'date' => $date ? $date : $cancel_time,
816 'reason_otaker' => $options{'reason_otaker'},
819 dbh->rollback if $oldAutoCommit;
820 return "Error inserting cust_pkg_reason: $error";
824 my %svc_cancel_opt = ();
825 $svc_cancel_opt{'date'} = $date if $date;
826 foreach my $cust_svc (
829 sort { $a->[1] <=> $b->[1] }
830 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; }
831 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
833 my $part_svc = $cust_svc->part_svc;
834 next if ( defined($part_svc) and $part_svc->preserve );
835 my $error = $cust_svc->cancel( %svc_cancel_opt );
838 $dbh->rollback if $oldAutoCommit;
839 return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
845 # credit remaining time if appropriate
847 if ( exists($options{'unused_credit'}) ) {
848 $do_credit = $options{'unused_credit'};
851 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
854 my $error = $self->credit_remaining('cancel', $cancel_time);
856 $dbh->rollback if $oldAutoCommit;
863 my %hash = $self->hash;
864 $date ? ($hash{'expire'} = $date) : ($hash{'cancel'} = $cancel_time);
865 $hash{'change_custnum'} = $options{'change_custnum'};
866 my $new = new FS::cust_pkg ( \%hash );
867 $error = $new->replace( $self, options => { $self->options } );
869 $dbh->rollback if $oldAutoCommit;
873 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
874 $error = $supp_pkg->cancel(%options, 'from_main' => 1);
876 $dbh->rollback if $oldAutoCommit;
877 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
881 foreach my $usage ( $self->cust_pkg_usage ) {
882 $error = $usage->delete;
884 $dbh->rollback if $oldAutoCommit;
885 return "deleting usage pools: $error";
889 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
890 return '' if $date; #no errors
892 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
893 if ( !$options{'quiet'} &&
894 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
896 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
899 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
900 $error = $msg_template->send( 'cust_main' => $self->cust_main,
905 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
906 'to' => \@invoicing_list,
907 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
908 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
911 #should this do something on errors?
918 =item cancel_if_expired [ NOW_TIMESTAMP ]
920 Cancels this package if its expire date has been reached.
924 sub cancel_if_expired {
926 my $time = shift || time;
927 return '' unless $self->expire && $self->expire <= $time;
928 my $error = $self->cancel;
930 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
931 $self->custnum. ": $error";
938 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
939 locationnum, (other fields?). Attempts to re-provision cancelled services
940 using history information (errors at this stage are not fatal).
942 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
944 svc_fatal: service provisioning errors are fatal
946 svc_errors: pass an array reference, will be filled in with any provisioning errors
948 main_pkgnum: link the package as a supplemental package of this one. For
954 my( $self, %options ) = @_;
956 #in case you try do do $uncancel-date = $cust_pkg->uncacel
957 return '' unless $self->get('cancel');
959 if ( $self->main_pkgnum and !$options{'main_pkgnum'} ) {
960 return $self->main_pkg->uncancel(%options);
967 local $SIG{HUP} = 'IGNORE';
968 local $SIG{INT} = 'IGNORE';
969 local $SIG{QUIT} = 'IGNORE';
970 local $SIG{TERM} = 'IGNORE';
971 local $SIG{TSTP} = 'IGNORE';
972 local $SIG{PIPE} = 'IGNORE';
974 my $oldAutoCommit = $FS::UID::AutoCommit;
975 local $FS::UID::AutoCommit = 0;
979 # insert the new package
982 my $cust_pkg = new FS::cust_pkg {
983 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
984 bill => ( $options{'bill'} || $self->get('bill') ),
986 uncancel_pkgnum => $self->pkgnum,
987 main_pkgnum => ($options{'main_pkgnum'} || ''),
988 map { $_ => $self->get($_) } qw(
989 custnum pkgpart locationnum
991 susp adjourn resume expire start_date contract_end dundate
992 change_date change_pkgpart change_locationnum
993 manual_flag no_auto quantity agent_pkgid recur_show_zero setup_show_zero
997 my $error = $cust_pkg->insert(
998 'change' => 1, #supresses any referral credit to a referring customer
999 'allow_pkgpart' => 1, # allow this even if the package def is disabled
1002 $dbh->rollback if $oldAutoCommit;
1010 #find historical services within this timeframe before the package cancel
1011 # (incompatible with "time" option to cust_pkg->cancel?)
1012 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
1013 # too little? (unprovisioing export delay?)
1014 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
1015 my @h_cust_svc = $self->h_cust_svc( $end, $start );
1018 foreach my $h_cust_svc (@h_cust_svc) {
1019 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
1020 #next unless $h_svc_x; #should this happen?
1021 (my $table = $h_svc_x->table) =~ s/^h_//;
1022 require "FS/$table.pm";
1023 my $class = "FS::$table";
1024 my $svc_x = $class->new( {
1025 'pkgnum' => $cust_pkg->pkgnum,
1026 'svcpart' => $h_cust_svc->svcpart,
1027 map { $_ => $h_svc_x->get($_) } fields($table)
1031 if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
1032 $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
1035 my $svc_error = $svc_x->insert;
1037 if ( $options{svc_fatal} ) {
1038 $dbh->rollback if $oldAutoCommit;
1041 # if we've failed to insert the svc_x object, svc_Common->insert
1042 # will have removed the cust_svc already. if not, then both records
1043 # were inserted but we failed for some other reason (export, most
1044 # likely). in that case, report the error and delete the records.
1045 push @svc_errors, $svc_error;
1046 my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1048 # except if export_insert failed, export_delete probably won't be
1050 local $FS::svc_Common::noexport_hack = 1;
1051 my $cleanup_error = $svc_x->delete; # also deletes cust_svc
1052 if ( $cleanup_error ) { # and if THAT fails, then run away
1053 $dbh->rollback if $oldAutoCommit;
1054 return $cleanup_error;
1059 } #foreach $h_cust_svc
1061 #these are pretty rare, but should handle them
1062 # - dsl_device (mac addresses)
1063 # - phone_device (mac addresses)
1064 # - dsl_note (ikano notes)
1065 # - domain_record (i.e. restore DNS information w/domains)
1066 # - inventory_item(?) (inventory w/un-cancelling service?)
1067 # - nas (svc_broaband nas stuff)
1068 #this stuff is unused in the wild afaik
1069 # - mailinglistmember
1071 # - svc_domain.parent_svcnum?
1072 # - acct_snarf (ancient mail fetching config)
1073 # - cgp_rule (communigate)
1074 # - cust_svc_option (used by our Tron stuff)
1075 # - acct_rt_transaction (used by our time worked stuff)
1078 # also move over any services that didn't unprovision at cancellation
1081 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1082 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1083 my $error = $cust_svc->replace;
1085 $dbh->rollback if $oldAutoCommit;
1091 # Uncancel any supplemental packages, and make them supplemental to the
1095 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1097 $error = $supp_pkg->uncancel(%options, 'main_pkgnum' => $cust_pkg->pkgnum);
1099 $dbh->rollback if $oldAutoCommit;
1100 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1108 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1110 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1111 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1118 Cancels any pending expiration (sets the expire field to null).
1120 If there is an error, returns the error, otherwise returns false.
1125 my( $self, %options ) = @_;
1128 local $SIG{HUP} = 'IGNORE';
1129 local $SIG{INT} = 'IGNORE';
1130 local $SIG{QUIT} = 'IGNORE';
1131 local $SIG{TERM} = 'IGNORE';
1132 local $SIG{TSTP} = 'IGNORE';
1133 local $SIG{PIPE} = 'IGNORE';
1135 my $oldAutoCommit = $FS::UID::AutoCommit;
1136 local $FS::UID::AutoCommit = 0;
1139 my $old = $self->select_for_update;
1141 my $pkgnum = $old->pkgnum;
1142 if ( $old->get('cancel') || $self->get('cancel') ) {
1143 dbh->rollback if $oldAutoCommit;
1144 return "Can't unexpire cancelled package $pkgnum";
1145 # or at least it's pointless
1148 unless ( $old->get('expire') && $self->get('expire') ) {
1149 dbh->rollback if $oldAutoCommit;
1150 return ""; # no error
1153 my %hash = $self->hash;
1154 $hash{'expire'} = '';
1155 my $new = new FS::cust_pkg ( \%hash );
1156 $error = $new->replace( $self, options => { $self->options } );
1158 $dbh->rollback if $oldAutoCommit;
1162 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1168 =item suspend [ OPTION => VALUE ... ]
1170 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1171 package, then suspends the package itself (sets the susp field to now).
1173 Available options are:
1177 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1178 either a reasonnum of an existing reason, or passing a hashref will create
1179 a new reason. The hashref should have the following keys:
1180 - typenum - Reason type (see L<FS::reason_type>
1181 - reason - Text of the new reason.
1183 =item date - can be set to a unix style timestamp to specify when to
1186 =item time - can be set to override the current time, for calculation
1187 of final invoices or unused-time credits
1189 =item resume_date - can be set to a time when the package should be
1190 unsuspended. This may be more convenient than calling C<unsuspend()>
1193 =item from_main - allows a supplemental package to be suspended, rather
1194 than redirecting the method call to its main package. For internal use.
1198 If there is an error, returns the error, otherwise returns false.
1203 my( $self, %options ) = @_;
1206 # pass all suspend/cancel actions to the main package
1207 if ( $self->main_pkgnum and !$options{'from_main'} ) {
1208 return $self->main_pkg->suspend(%options);
1211 local $SIG{HUP} = 'IGNORE';
1212 local $SIG{INT} = 'IGNORE';
1213 local $SIG{QUIT} = 'IGNORE';
1214 local $SIG{TERM} = 'IGNORE';
1215 local $SIG{TSTP} = 'IGNORE';
1216 local $SIG{PIPE} = 'IGNORE';
1218 my $oldAutoCommit = $FS::UID::AutoCommit;
1219 local $FS::UID::AutoCommit = 0;
1222 my $old = $self->select_for_update;
1224 my $pkgnum = $old->pkgnum;
1225 if ( $old->get('cancel') || $self->get('cancel') ) {
1226 dbh->rollback if $oldAutoCommit;
1227 return "Can't suspend cancelled package $pkgnum";
1230 if ( $old->get('susp') || $self->get('susp') ) {
1231 dbh->rollback if $oldAutoCommit;
1232 return ""; # no error # complain on adjourn?
1235 my $suspend_time = $options{'time'} || time;
1236 my $date = $options{date} if $options{date}; # adjourn/suspend later
1237 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1239 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1240 dbh->rollback if $oldAutoCommit;
1241 return "Package $pkgnum expires before it would be suspended.";
1244 # some false laziness with sub cancel
1245 if ( !$options{nobill} && !$date &&
1246 $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1247 # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1248 # make the entire cust_main->bill path recognize 'suspend' and
1249 # 'cancel' separately.
1250 warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1251 my $copy = $self->new({$self->hash});
1253 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1255 'time' => $suspend_time );
1256 warn "Error billing during suspend, custnum ".
1257 #$self->cust_main->custnum. ": $error"
1262 if ( $options{'reason'} ) {
1263 $error = $self->insert_reason( 'reason' => $options{'reason'},
1264 'action' => $date ? 'adjourn' : 'suspend',
1265 'date' => $date ? $date : $suspend_time,
1266 'reason_otaker' => $options{'reason_otaker'},
1269 dbh->rollback if $oldAutoCommit;
1270 return "Error inserting cust_pkg_reason: $error";
1274 my %hash = $self->hash;
1276 $hash{'adjourn'} = $date;
1278 $hash{'susp'} = $suspend_time;
1281 my $resume_date = $options{'resume_date'} || 0;
1282 if ( $resume_date > ($date || $suspend_time) ) {
1283 $hash{'resume'} = $resume_date;
1286 $options{options} ||= {};
1288 my $new = new FS::cust_pkg ( \%hash );
1289 $error = $new->replace( $self, options => { $self->options,
1290 %{ $options{options} },
1294 $dbh->rollback if $oldAutoCommit;
1299 # credit remaining time if appropriate
1300 if ( $self->part_pkg->option('unused_credit_suspend', 1) ) {
1301 my $error = $self->credit_remaining('suspend', $suspend_time);
1303 $dbh->rollback if $oldAutoCommit;
1310 foreach my $cust_svc (
1311 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1313 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1315 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1316 $dbh->rollback if $oldAutoCommit;
1317 return "Illegal svcdb value in part_svc!";
1320 require "FS/$svcdb.pm";
1322 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1324 $error = $svc->suspend;
1326 $dbh->rollback if $oldAutoCommit;
1329 my( $label, $value ) = $cust_svc->label;
1330 push @labels, "$label: $value";
1334 my $conf = new FS::Conf;
1335 if ( $conf->config('suspend_email_admin') ) {
1337 my $error = send_email(
1338 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1339 #invoice_from ??? well as good as any
1340 'to' => $conf->config('suspend_email_admin'),
1341 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1343 "This is an automatic message from your Freeside installation\n",
1344 "informing you that the following customer package has been suspended:\n",
1346 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1347 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1348 ( map { "Service : $_\n" } @labels ),
1353 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1361 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1362 $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1364 $dbh->rollback if $oldAutoCommit;
1365 return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1369 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1374 =item credit_remaining MODE TIME
1376 Generate a credit for this package for the time remaining in the current
1377 billing period. MODE is either "suspend" or "cancel" (determines the
1378 credit type). TIME is the time of suspension/cancellation. Both arguments
1383 sub credit_remaining {
1384 # Add a credit for remaining service
1385 my ($self, $mode, $time) = @_;
1386 die 'credit_remaining requires suspend or cancel'
1387 unless $mode eq 'suspend' or $mode eq 'cancel';
1388 die 'no suspend/cancel time' unless $time > 0;
1390 my $conf = FS::Conf->new;
1391 my $reason_type = $conf->config($mode.'_credit_type');
1393 my $last_bill = $self->getfield('last_bill') || 0;
1394 my $next_bill = $self->getfield('bill') || 0;
1395 if ( $last_bill > 0 # the package has been billed
1396 and $next_bill > 0 # the package has a next bill date
1397 and $next_bill >= $time # which is in the future
1399 my $remaining_value = $self->calc_remain('time' => $time);
1400 if ( $remaining_value > 0 ) {
1401 warn "Crediting for $remaining_value on package ".$self->pkgnum."\n"
1403 my $error = $self->cust_main->credit(
1405 'Credit for unused time on '. $self->part_pkg->pkg,
1406 'reason_type' => $reason_type,
1408 return "Error crediting customer \$$remaining_value for unused time".
1409 " on ". $self->part_pkg->pkg. ": $error"
1411 } #if $remaining_value
1412 } #if $last_bill, etc.
1416 =item unsuspend [ OPTION => VALUE ... ]
1418 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1419 package, then unsuspends the package itself (clears the susp field and the
1420 adjourn field if it is in the past). If the suspend reason includes an
1421 unsuspension package, that package will be ordered.
1423 Available options are:
1429 Can be set to a date to unsuspend the package in the future (the 'resume'
1432 =item adjust_next_bill
1434 Can be set true to adjust the next bill date forward by
1435 the amount of time the account was inactive. This was set true by default
1436 since 1.4.2 and 1.5.0pre6; however, starting with 1.7.0 this needs to be
1437 explicitly requested. Price plans for which this makes sense (anniversary-date
1438 based than prorate or subscription) could have an option to enable this
1443 If there is an error, returns the error, otherwise returns false.
1448 my( $self, %opt ) = @_;
1451 # pass all suspend/cancel actions to the main package
1452 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1453 return $self->main_pkg->unsuspend(%opt);
1456 local $SIG{HUP} = 'IGNORE';
1457 local $SIG{INT} = 'IGNORE';
1458 local $SIG{QUIT} = 'IGNORE';
1459 local $SIG{TERM} = 'IGNORE';
1460 local $SIG{TSTP} = 'IGNORE';
1461 local $SIG{PIPE} = 'IGNORE';
1463 my $oldAutoCommit = $FS::UID::AutoCommit;
1464 local $FS::UID::AutoCommit = 0;
1467 my $old = $self->select_for_update;
1469 my $pkgnum = $old->pkgnum;
1470 if ( $old->get('cancel') || $self->get('cancel') ) {
1471 $dbh->rollback if $oldAutoCommit;
1472 return "Can't unsuspend cancelled package $pkgnum";
1475 unless ( $old->get('susp') && $self->get('susp') ) {
1476 $dbh->rollback if $oldAutoCommit;
1477 return ""; # no error # complain instead?
1480 my $date = $opt{'date'};
1481 if ( $date and $date > time ) { # return an error if $date <= time?
1483 if ( $old->get('expire') && $old->get('expire') < $date ) {
1484 $dbh->rollback if $oldAutoCommit;
1485 return "Package $pkgnum expires before it would be unsuspended.";
1488 my $new = new FS::cust_pkg { $self->hash };
1489 $new->set('resume', $date);
1490 $error = $new->replace($self, options => $self->options);
1493 $dbh->rollback if $oldAutoCommit;
1497 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1505 foreach my $cust_svc (
1506 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1508 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1510 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1511 $dbh->rollback if $oldAutoCommit;
1512 return "Illegal svcdb value in part_svc!";
1515 require "FS/$svcdb.pm";
1517 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1519 $error = $svc->unsuspend;
1521 $dbh->rollback if $oldAutoCommit;
1524 my( $label, $value ) = $cust_svc->label;
1525 push @labels, "$label: $value";
1530 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1531 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1533 my %hash = $self->hash;
1534 my $inactive = time - $hash{'susp'};
1536 my $conf = new FS::Conf;
1538 if ( $inactive > 0 &&
1539 ( $hash{'bill'} || $hash{'setup'} ) &&
1540 ( $opt{'adjust_next_bill'} ||
1541 $conf->exists('unsuspend-always_adjust_next_bill_date') ||
1542 $self->part_pkg->option('unsuspend_adjust_bill', 1) )
1545 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1550 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1551 $hash{'resume'} = '' if !$hash{'adjourn'};
1552 my $new = new FS::cust_pkg ( \%hash );
1553 $error = $new->replace( $self, options => { $self->options } );
1555 $dbh->rollback if $oldAutoCommit;
1561 if ( $reason && $reason->unsuspend_pkgpart ) {
1562 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
1563 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
1565 my $start_date = $self->cust_main->next_bill_date
1566 if $reason->unsuspend_hold;
1569 $unsusp_pkg = FS::cust_pkg->new({
1570 'custnum' => $self->custnum,
1571 'pkgpart' => $reason->unsuspend_pkgpart,
1572 'start_date' => $start_date,
1573 'locationnum' => $self->locationnum,
1574 # discount? probably not...
1577 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
1581 $dbh->rollback if $oldAutoCommit;
1586 if ( $conf->config('unsuspend_email_admin') ) {
1588 my $error = send_email(
1589 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1590 #invoice_from ??? well as good as any
1591 'to' => $conf->config('unsuspend_email_admin'),
1592 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
1593 "This is an automatic message from your Freeside installation\n",
1594 "informing you that the following customer package has been unsuspended:\n",
1596 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1597 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1598 ( map { "Service : $_\n" } @labels ),
1600 "An unsuspension fee was charged: ".
1601 $unsusp_pkg->part_pkg->pkg_comment."\n"
1608 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
1614 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1615 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
1617 $dbh->rollback if $oldAutoCommit;
1618 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1622 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1629 Cancels any pending suspension (sets the adjourn field to null).
1631 If there is an error, returns the error, otherwise returns false.
1636 my( $self, %options ) = @_;
1639 local $SIG{HUP} = 'IGNORE';
1640 local $SIG{INT} = 'IGNORE';
1641 local $SIG{QUIT} = 'IGNORE';
1642 local $SIG{TERM} = 'IGNORE';
1643 local $SIG{TSTP} = 'IGNORE';
1644 local $SIG{PIPE} = 'IGNORE';
1646 my $oldAutoCommit = $FS::UID::AutoCommit;
1647 local $FS::UID::AutoCommit = 0;
1650 my $old = $self->select_for_update;
1652 my $pkgnum = $old->pkgnum;
1653 if ( $old->get('cancel') || $self->get('cancel') ) {
1654 dbh->rollback if $oldAutoCommit;
1655 return "Can't unadjourn cancelled package $pkgnum";
1656 # or at least it's pointless
1659 if ( $old->get('susp') || $self->get('susp') ) {
1660 dbh->rollback if $oldAutoCommit;
1661 return "Can't unadjourn suspended package $pkgnum";
1662 # perhaps this is arbitrary
1665 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1666 dbh->rollback if $oldAutoCommit;
1667 return ""; # no error
1670 my %hash = $self->hash;
1671 $hash{'adjourn'} = '';
1672 $hash{'resume'} = '';
1673 my $new = new FS::cust_pkg ( \%hash );
1674 $error = $new->replace( $self, options => { $self->options } );
1676 $dbh->rollback if $oldAutoCommit;
1680 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1687 =item change HASHREF | OPTION => VALUE ...
1689 Changes this package: cancels it and creates a new one, with a different
1690 pkgpart or locationnum or both. All services are transferred to the new
1691 package (no change will be made if this is not possible).
1693 Options may be passed as a list of key/value pairs or as a hash reference.
1700 New locationnum, to change the location for this package.
1704 New FS::cust_location object, to create a new location and assign it
1709 New FS::cust_main object, to create a new customer and assign the new package
1714 New pkgpart (see L<FS::part_pkg>).
1718 New refnum (see L<FS::part_referral>).
1722 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1723 susp, adjourn, cancel, expire, and contract_end) to the new package.
1727 At least one of locationnum, cust_location, pkgpart, refnum must be specified
1728 (otherwise, what's the point?)
1730 Returns either the new FS::cust_pkg object or a scalar error.
1734 my $err_or_new_cust_pkg = $old_cust_pkg->change
1738 #some false laziness w/order
1741 my $opt = ref($_[0]) ? shift : { @_ };
1743 # my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
1746 my $conf = new FS::Conf;
1748 # Transactionize this whole mess
1749 local $SIG{HUP} = 'IGNORE';
1750 local $SIG{INT} = 'IGNORE';
1751 local $SIG{QUIT} = 'IGNORE';
1752 local $SIG{TERM} = 'IGNORE';
1753 local $SIG{TSTP} = 'IGNORE';
1754 local $SIG{PIPE} = 'IGNORE';
1756 my $oldAutoCommit = $FS::UID::AutoCommit;
1757 local $FS::UID::AutoCommit = 0;
1766 #$hash{$_} = $self->$_() foreach qw( last_bill bill );
1768 #$hash{$_} = $self->$_() foreach qw( setup );
1770 $hash{'setup'} = $time if $self->setup;
1772 $hash{'change_date'} = $time;
1773 $hash{"change_$_"} = $self->$_()
1774 foreach qw( pkgnum pkgpart locationnum );
1776 if ( $opt->{'cust_location'} ) {
1777 $error = $opt->{'cust_location'}->find_or_insert;
1779 $dbh->rollback if $oldAutoCommit;
1780 return "inserting cust_location (transaction rolled back): $error";
1782 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1785 # whether to override pkgpart checking on the new package
1786 my $same_pkgpart = 1;
1787 if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
1791 my $unused_credit = 0;
1792 my $keep_dates = $opt->{'keep_dates'};
1793 # Special case. If the pkgpart is changing, and the customer is
1794 # going to be credited for remaining time, don't keep setup, bill,
1795 # or last_bill dates, and DO pass the flag to cancel() to credit
1797 if ( $opt->{'pkgpart'}
1798 and $opt->{'pkgpart'} != $self->pkgpart
1799 and $self->part_pkg->option('unused_credit_change', 1) ) {
1802 $hash{$_} = '' foreach qw(setup bill last_bill);
1805 if ( $keep_dates ) {
1806 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1807 resume start_date contract_end ) ) {
1808 $hash{$date} = $self->getfield($date);
1811 # allow $opt->{'locationnum'} = '' to specifically set it to null
1812 # (i.e. customer default location)
1813 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
1815 # usually this doesn't matter. the two cases where it does are:
1816 # 1. unused_credit_change + pkgpart change + setup fee on the new package
1818 # 2. (more importantly) changing a package before it's billed
1819 $hash{'waive_setup'} = $self->waive_setup;
1821 my $custnum = $self->custnum;
1822 if ( $opt->{cust_main} ) {
1823 my $cust_main = $opt->{cust_main};
1824 unless ( $cust_main->custnum ) {
1825 my $error = $cust_main->insert;
1827 $dbh->rollback if $oldAutoCommit;
1828 return "inserting cust_main (transaction rolled back): $error";
1831 $custnum = $cust_main->custnum;
1834 $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
1836 # Create the new package.
1837 my $cust_pkg = new FS::cust_pkg {
1838 custnum => $custnum,
1839 pkgpart => ( $opt->{'pkgpart'} || $self->pkgpart ),
1840 refnum => ( $opt->{'refnum'} || $self->refnum ),
1841 locationnum => ( $opt->{'locationnum'} ),
1844 $error = $cust_pkg->insert( 'change' => 1,
1845 'allow_pkgpart' => $same_pkgpart );
1847 $dbh->rollback if $oldAutoCommit;
1851 # Transfer services and cancel old package.
1853 $error = $self->transfer($cust_pkg);
1854 if ($error and $error == 0) {
1855 # $old_pkg->transfer failed.
1856 $dbh->rollback if $oldAutoCommit;
1860 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
1861 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
1862 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
1863 if ($error and $error == 0) {
1864 # $old_pkg->transfer failed.
1865 $dbh->rollback if $oldAutoCommit;
1871 # Transfers were successful, but we still had services left on the old
1872 # package. We can't change the package under this circumstances, so abort.
1873 $dbh->rollback if $oldAutoCommit;
1874 return "Unable to transfer all services from package ". $self->pkgnum;
1877 #reset usage if changing pkgpart
1878 # AND usage rollover is off (otherwise adds twice, now and at package bill)
1879 if ($self->pkgpart != $cust_pkg->pkgpart) {
1880 my $part_pkg = $cust_pkg->part_pkg;
1881 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
1885 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
1888 $dbh->rollback if $oldAutoCommit;
1889 return "Error setting usage values: $error";
1892 # if NOT changing pkgpart, transfer any usage pools over
1893 foreach my $usage ($self->cust_pkg_usage) {
1894 $usage->set('pkgnum', $cust_pkg->pkgnum);
1895 $error = $usage->replace;
1897 $dbh->rollback if $oldAutoCommit;
1898 return "Error transferring usage pools: $error";
1903 # transfer discounts, if we're not changing pkgpart
1904 if ( $same_pkgpart ) {
1905 foreach my $old_discount ($self->cust_pkg_discount_active) {
1906 # don't remove the old discount, we may still need to bill that package.
1907 my $new_discount = new FS::cust_pkg_discount {
1908 'pkgnum' => $cust_pkg->pkgnum,
1909 'discountnum' => $old_discount->discountnum,
1910 'months_used' => $old_discount->months_used,
1912 $error = $new_discount->insert;
1914 $dbh->rollback if $oldAutoCommit;
1915 return "Error transferring discounts: $error";
1920 # Order any supplemental packages.
1921 my $part_pkg = $cust_pkg->part_pkg;
1922 my @old_supp_pkgs = $self->supplemental_pkgs;
1924 foreach my $link ($part_pkg->supp_part_pkg_link) {
1926 foreach (@old_supp_pkgs) {
1927 if ($_->pkgpart == $link->dst_pkgpart) {
1929 $_->pkgpart(0); # so that it can't match more than once
1933 # false laziness with FS::cust_main::Packages::order_pkg
1934 my $new = FS::cust_pkg->new({
1935 pkgpart => $link->dst_pkgpart,
1936 pkglinknum => $link->pkglinknum,
1937 custnum => $custnum,
1938 main_pkgnum => $cust_pkg->pkgnum,
1939 locationnum => $cust_pkg->locationnum,
1940 start_date => $cust_pkg->start_date,
1941 order_date => $cust_pkg->order_date,
1942 expire => $cust_pkg->expire,
1943 adjourn => $cust_pkg->adjourn,
1944 contract_end => $cust_pkg->contract_end,
1945 refnum => $cust_pkg->refnum,
1946 discountnum => $cust_pkg->discountnum,
1947 waive_setup => $cust_pkg->waive_setup,
1949 if ( $old and $opt->{'keep_dates'} ) {
1950 foreach (qw(setup bill last_bill)) {
1951 $new->set($_, $old->get($_));
1954 $error = $new->insert( allow_pkgpart => $same_pkgpart );
1957 $error ||= $old->transfer($new);
1959 if ( $error and $error > 0 ) {
1960 # no reason why this should ever fail, but still...
1961 $error = "Unable to transfer all services from supplemental package ".
1965 $dbh->rollback if $oldAutoCommit;
1968 push @new_supp_pkgs, $new;
1971 #Good to go, cancel old package. Notify 'cancel' of whether to credit
1973 #Don't allow billing the package (preceding period packages and/or
1974 #outstanding usage) if we are keeping dates (i.e. location changing),
1975 #because the new package will be billed for the same date range.
1976 #Supplemental packages are also canceled here.
1977 $error = $self->cancel(
1979 unused_credit => $unused_credit,
1980 nobill => $keep_dates,
1981 change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
1984 $dbh->rollback if $oldAutoCommit;
1988 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
1990 my $error = $cust_pkg->cust_main->bill(
1991 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
1994 $dbh->rollback if $oldAutoCommit;
1999 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2005 =item set_quantity QUANTITY
2007 Change the package's quantity field. This is the one package property
2008 that can safely be changed without canceling and reordering the package
2009 (because it doesn't affect tax eligibility). Returns an error or an
2016 $self = $self->replace_old; # just to make sure
2018 ($qty =~ /^\d+$/ and $qty > 0) or return "bad package quantity $qty";
2019 $self->set('quantity' => $qty);
2023 use Storable 'thaw';
2025 sub process_bulk_cust_pkg {
2027 my $param = thaw(decode_base64(shift));
2028 warn Dumper($param) if $DEBUG;
2030 my $old_part_pkg = qsearchs('part_pkg',
2031 { pkgpart => $param->{'old_pkgpart'} });
2032 my $new_part_pkg = qsearchs('part_pkg',
2033 { pkgpart => $param->{'new_pkgpart'} });
2034 die "Must select a new package type\n" unless $new_part_pkg;
2035 #my $keep_dates = $param->{'keep_dates'} || 0;
2036 my $keep_dates = 1; # there is no good reason to turn this off
2038 local $SIG{HUP} = 'IGNORE';
2039 local $SIG{INT} = 'IGNORE';
2040 local $SIG{QUIT} = 'IGNORE';
2041 local $SIG{TERM} = 'IGNORE';
2042 local $SIG{TSTP} = 'IGNORE';
2043 local $SIG{PIPE} = 'IGNORE';
2045 my $oldAutoCommit = $FS::UID::AutoCommit;
2046 local $FS::UID::AutoCommit = 0;
2049 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
2052 foreach my $old_cust_pkg ( @cust_pkgs ) {
2054 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
2055 if ( $old_cust_pkg->getfield('cancel') ) {
2056 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
2057 $old_cust_pkg->pkgnum."\n"
2061 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
2063 my $error = $old_cust_pkg->change(
2064 'pkgpart' => $param->{'new_pkgpart'},
2065 'keep_dates' => $keep_dates
2067 if ( !ref($error) ) { # change returns the cust_pkg on success
2069 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
2072 $dbh->commit if $oldAutoCommit;
2078 Returns the last bill date, or if there is no last bill date, the setup date.
2079 Useful for billing metered services.
2085 return $self->setfield('last_bill', $_[0]) if @_;
2086 return $self->getfield('last_bill') if $self->getfield('last_bill');
2087 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
2088 'edate' => $self->bill, } );
2089 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
2092 =item last_cust_pkg_reason ACTION
2094 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
2095 Returns false if there is no reason or the package is not currenly ACTION'd
2096 ACTION is one of adjourn, susp, cancel, or expire.
2100 sub last_cust_pkg_reason {
2101 my ( $self, $action ) = ( shift, shift );
2102 my $date = $self->get($action);
2104 'table' => 'cust_pkg_reason',
2105 'hashref' => { 'pkgnum' => $self->pkgnum,
2106 'action' => substr(uc($action), 0, 1),
2109 'order_by' => 'ORDER BY num DESC LIMIT 1',
2113 =item last_reason ACTION
2115 Returns the most recent ACTION FS::reason associated with the package.
2116 Returns false if there is no reason or the package is not currenly ACTION'd
2117 ACTION is one of adjourn, susp, cancel, or expire.
2122 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
2123 $cust_pkg_reason->reason
2124 if $cust_pkg_reason;
2129 Returns the definition for this billing item, as an FS::part_pkg object (see
2136 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
2137 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
2138 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
2143 Returns the cancelled package this package was changed from, if any.
2149 return '' unless $self->change_pkgnum;
2150 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
2153 =item change_cust_main
2155 Returns the customter this package was detached to, if any.
2159 sub change_cust_main {
2161 return '' unless $self->change_custnum;
2162 qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
2167 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
2174 $self->part_pkg->calc_setup($self, @_);
2179 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
2186 $self->part_pkg->calc_recur($self, @_);
2191 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
2198 $self->part_pkg->base_recur($self, @_);
2203 Calls the I<calc_remain> of the FS::part_pkg object associated with this
2210 $self->part_pkg->calc_remain($self, @_);
2215 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
2222 $self->part_pkg->calc_cancel($self, @_);
2227 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
2233 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
2236 =item cust_pkg_detail [ DETAILTYPE ]
2238 Returns any customer package details for this package (see
2239 L<FS::cust_pkg_detail>).
2241 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2245 sub cust_pkg_detail {
2247 my %hash = ( 'pkgnum' => $self->pkgnum );
2248 $hash{detailtype} = shift if @_;
2250 'table' => 'cust_pkg_detail',
2251 'hashref' => \%hash,
2252 'order_by' => 'ORDER BY weight, pkgdetailnum',
2256 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
2258 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
2260 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2262 If there is an error, returns the error, otherwise returns false.
2266 sub set_cust_pkg_detail {
2267 my( $self, $detailtype, @details ) = @_;
2269 local $SIG{HUP} = 'IGNORE';
2270 local $SIG{INT} = 'IGNORE';
2271 local $SIG{QUIT} = 'IGNORE';
2272 local $SIG{TERM} = 'IGNORE';
2273 local $SIG{TSTP} = 'IGNORE';
2274 local $SIG{PIPE} = 'IGNORE';
2276 my $oldAutoCommit = $FS::UID::AutoCommit;
2277 local $FS::UID::AutoCommit = 0;
2280 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
2281 my $error = $current->delete;
2283 $dbh->rollback if $oldAutoCommit;
2284 return "error removing old detail: $error";
2288 foreach my $detail ( @details ) {
2289 my $cust_pkg_detail = new FS::cust_pkg_detail {
2290 'pkgnum' => $self->pkgnum,
2291 'detailtype' => $detailtype,
2292 'detail' => $detail,
2294 my $error = $cust_pkg_detail->insert;
2296 $dbh->rollback if $oldAutoCommit;
2297 return "error adding new detail: $error";
2302 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2309 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
2313 #false laziness w/cust_bill.pm
2317 'table' => 'cust_event',
2318 'addl_from' => 'JOIN part_event USING ( eventpart )',
2319 'hashref' => { 'tablenum' => $self->pkgnum },
2320 'extra_sql' => " AND eventtable = 'cust_pkg' ",
2324 =item num_cust_event
2326 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
2330 #false laziness w/cust_bill.pm
2331 sub num_cust_event {
2334 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
2335 " WHERE tablenum = ? AND eventtable = 'cust_pkg'";
2336 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
2337 $sth->execute($self->pkgnum) or die $sth->errstr. " executing $sql";
2338 $sth->fetchrow_arrayref->[0];
2341 =item cust_svc [ SVCPART ] (old, deprecated usage)
2343 =item cust_svc [ OPTION => VALUE ... ] (current usage)
2345 Returns the services for this package, as FS::cust_svc objects (see
2346 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
2347 spcififed, returns only the matching services.
2354 return () unless $self->num_cust_svc(@_);
2357 if ( @_ && $_[0] =~ /^\d+/ ) {
2358 $opt{svcpart} = shift;
2359 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2366 'table' => 'cust_svc',
2367 'hashref' => { 'pkgnum' => $self->pkgnum },
2369 if ( $opt{svcpart} ) {
2370 $search{hashref}->{svcpart} = $opt{'svcpart'};
2372 if ( $opt{'svcdb'} ) {
2373 $search{addl_from} = ' LEFT JOIN part_svc USING ( svcpart ) ';
2374 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{'svcdb'} );
2377 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
2379 #if ( $self->{'_svcnum'} ) {
2380 # values %{ $self->{'_svcnum'}->cache };
2382 $self->_sort_cust_svc( [ qsearch(\%search) ] );
2387 =item overlimit [ SVCPART ]
2389 Returns the services for this package which have exceeded their
2390 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
2391 is specified, return only the matching services.
2397 return () unless $self->num_cust_svc(@_);
2398 grep { $_->overlimit } $self->cust_svc(@_);
2401 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2403 Returns historical services for this package created before END TIMESTAMP and
2404 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
2405 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
2406 I<pkg_svc.hidden> flag will be omitted.
2412 warn "$me _h_cust_svc called on $self\n"
2415 my ($end, $start, $mode) = @_;
2416 my @cust_svc = $self->_sort_cust_svc(
2417 [ qsearch( 'h_cust_svc',
2418 { 'pkgnum' => $self->pkgnum, },
2419 FS::h_cust_svc->sql_h_search(@_),
2422 if ( defined($mode) && $mode eq 'I' ) {
2423 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
2424 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
2430 sub _sort_cust_svc {
2431 my( $self, $arrayref ) = @_;
2434 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
2439 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $self->pkgpart,
2440 'svcpart' => $_->svcpart } );
2442 $pkg_svc ? $pkg_svc->primary_svc : '',
2443 $pkg_svc ? $pkg_svc->quantity : 0,
2450 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
2452 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
2454 Returns the number of services for this package. Available options are svcpart
2455 and svcdb. If either is spcififed, returns only the matching services.
2462 return $self->{'_num_cust_svc'}
2464 && exists($self->{'_num_cust_svc'})
2465 && $self->{'_num_cust_svc'} =~ /\d/;
2467 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
2471 if ( @_ && $_[0] =~ /^\d+/ ) {
2472 $opt{svcpart} = shift;
2473 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2479 my $select = 'SELECT COUNT(*) FROM cust_svc ';
2480 my $where = ' WHERE pkgnum = ? ';
2481 my @param = ($self->pkgnum);
2483 if ( $opt{'svcpart'} ) {
2484 $where .= ' AND svcpart = ? ';
2485 push @param, $opt{'svcpart'};
2487 if ( $opt{'svcdb'} ) {
2488 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
2489 $where .= ' AND svcdb = ? ';
2490 push @param, $opt{'svcdb'};
2493 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
2494 $sth->execute(@param) or die $sth->errstr;
2495 $sth->fetchrow_arrayref->[0];
2498 =item available_part_svc
2500 Returns a list of FS::part_svc objects representing services included in this
2501 package but not yet provisioned. Each FS::part_svc object also has an extra
2502 field, I<num_avail>, which specifies the number of available services.
2506 sub available_part_svc {
2509 my $pkg_quantity = $self->quantity || 1;
2511 grep { $_->num_avail > 0 }
2513 my $part_svc = $_->part_svc;
2514 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
2515 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
2517 # more evil encapsulation breakage
2518 if($part_svc->{'Hash'}{'num_avail'} > 0) {
2519 my @exports = $part_svc->part_export_did;
2520 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
2525 $self->part_pkg->pkg_svc;
2528 =item part_svc [ OPTION => VALUE ... ]
2530 Returns a list of FS::part_svc objects representing provisioned and available
2531 services included in this package. Each FS::part_svc object also has the
2532 following extra fields:
2536 =item num_cust_svc (count)
2538 =item num_avail (quantity - count)
2540 =item cust_pkg_svc (services) - array reference containing the provisioned services, as cust_svc objects
2544 Accepts one option: summarize_size. If specified and non-zero, will omit the
2545 extra cust_pkg_svc option for objects where num_cust_svc is this size or
2551 #label -> ($cust_svc->label)[1]
2557 my $pkg_quantity = $self->quantity || 1;
2559 #XXX some sort of sort order besides numeric by svcpart...
2560 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
2562 my $part_svc = $pkg_svc->part_svc;
2563 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
2564 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
2565 $part_svc->{'Hash'}{'num_avail'} =
2566 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
2567 $part_svc->{'Hash'}{'cust_pkg_svc'} =
2568 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
2569 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
2570 && $num_cust_svc >= $opt{summarize_size};
2571 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
2573 } $self->part_pkg->pkg_svc;
2576 push @part_svc, map {
2578 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
2579 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
2580 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
2581 $part_svc->{'Hash'}{'cust_pkg_svc'} =
2582 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
2584 } $self->extra_part_svc;
2590 =item extra_part_svc
2592 Returns a list of FS::part_svc objects corresponding to services in this
2593 package which are still provisioned but not (any longer) available in the
2598 sub extra_part_svc {
2601 my $pkgnum = $self->pkgnum;
2602 #my $pkgpart = $self->pkgpart;
2605 # 'table' => 'part_svc',
2608 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
2609 # WHERE pkg_svc.svcpart = part_svc.svcpart
2610 # AND pkg_svc.pkgpart = ?
2613 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
2614 # LEFT JOIN cust_pkg USING ( pkgnum )
2615 # WHERE cust_svc.svcpart = part_svc.svcpart
2618 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
2621 #seems to benchmark slightly faster... (or did?)
2623 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
2624 my $pkgparts = join(',', @pkgparts);
2627 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
2628 #MySQL doesn't grok DISINCT ON
2629 'select' => 'DISTINCT part_svc.*',
2630 'table' => 'part_svc',
2632 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
2633 AND pkg_svc.pkgpart IN ($pkgparts)
2636 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
2637 LEFT JOIN cust_pkg USING ( pkgnum )
2640 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
2641 'extra_param' => [ [$self->pkgnum=>'int'] ],
2647 Returns a short status string for this package, currently:
2651 =item not yet billed
2653 =item one-time charge
2668 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
2670 return 'cancelled' if $self->get('cancel');
2671 return 'suspended' if $self->susp;
2672 return 'not yet billed' unless $self->setup;
2673 return 'one-time charge' if $freq =~ /^(0|$)/;
2677 =item ucfirst_status
2679 Returns the status with the first character capitalized.
2683 sub ucfirst_status {
2684 ucfirst(shift->status);
2689 Class method that returns the list of possible status strings for packages
2690 (see L<the status method|/status>). For example:
2692 @statuses = FS::cust_pkg->statuses();
2696 tie my %statuscolor, 'Tie::IxHash',
2697 'not yet billed' => '009999', #teal? cyan?
2698 'one-time charge' => '000000',
2699 'active' => '00CC00',
2700 'suspended' => 'FF9900',
2701 'cancelled' => 'FF0000',
2705 my $self = shift; #could be class...
2706 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
2707 # # mayble split btw one-time vs. recur
2713 Returns a hex triplet color string for this package's status.
2719 $statuscolor{$self->status};
2724 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
2725 "pkg - comment" depending on user preference).
2731 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
2732 $label = $self->pkgnum. ": $label"
2733 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
2737 =item pkg_label_long
2739 Returns a long label for this package, adding the primary service's label to
2744 sub pkg_label_long {
2746 my $label = $self->pkg_label;
2747 my $cust_svc = $self->primary_cust_svc;
2748 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
2754 Returns a customer-localized label for this package.
2760 $self->part_pkg->pkg_locale( $self->cust_main->locale );
2763 =item primary_cust_svc
2765 Returns a primary service (as FS::cust_svc object) if one can be identified.
2769 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
2771 sub primary_cust_svc {
2774 my @cust_svc = $self->cust_svc;
2776 return '' unless @cust_svc; #no serivces - irrelevant then
2778 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
2780 # primary service as specified in the package definition
2781 # or exactly one service definition with quantity one
2782 my $svcpart = $self->part_pkg->svcpart;
2783 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
2784 return $cust_svc[0] if scalar(@cust_svc) == 1;
2786 #couldn't identify one thing..
2792 Returns a list of lists, calling the label method for all services
2793 (see L<FS::cust_svc>) of this billing item.
2799 map { [ $_->label ] } $self->cust_svc;
2802 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2804 Like the labels method, but returns historical information on services that
2805 were active as of END_TIMESTAMP and (optionally) not cancelled before
2806 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
2807 I<pkg_svc.hidden> flag will be omitted.
2809 Returns a list of lists, calling the label method for all (historical) services
2810 (see L<FS::h_cust_svc>) of this billing item.
2816 warn "$me _h_labels called on $self\n"
2818 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
2823 Like labels, except returns a simple flat list, and shortens long
2824 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2825 identical services to one line that lists the service label and the number of
2826 individual services rather than individual items.
2831 shift->_labels_short( 'labels', @_ );
2834 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
2836 Like h_labels, except returns a simple flat list, and shortens long
2837 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2838 identical services to one line that lists the service label and the number of
2839 individual services rather than individual items.
2843 sub h_labels_short {
2844 shift->_labels_short( 'h_labels', @_ );
2848 my( $self, $method ) = ( shift, shift );
2850 warn "$me _labels_short called on $self with $method method\n"
2853 my $conf = new FS::Conf;
2854 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
2856 warn "$me _labels_short populating \%labels\n"
2860 #tie %labels, 'Tie::IxHash';
2861 push @{ $labels{$_->[0]} }, $_->[1]
2862 foreach $self->$method(@_);
2864 warn "$me _labels_short populating \@labels\n"
2868 foreach my $label ( keys %labels ) {
2870 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
2871 my $num = scalar(@values);
2872 warn "$me _labels_short $num items for $label\n"
2875 if ( $num > $max_same_services ) {
2876 warn "$me _labels_short more than $max_same_services, so summarizing\n"
2878 push @labels, "$label ($num)";
2880 if ( $conf->exists('cust_bill-consolidate_services') ) {
2881 warn "$me _labels_short consolidating services\n"
2883 # push @labels, "$label: ". join(', ', @values);
2885 my $detail = "$label: ";
2886 $detail .= shift(@values). ', '
2888 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
2890 push @labels, $detail;
2892 warn "$me _labels_short done consolidating services\n"
2895 warn "$me _labels_short adding service data\n"
2897 push @labels, map { "$label: $_" } @values;
2908 Returns the parent customer object (see L<FS::cust_main>).
2914 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
2919 Returns the balance for this specific package, when using
2920 experimental package balance.
2926 $self->cust_main->balance_pkgnum( $self->pkgnum );
2929 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
2933 Returns the location object, if any (see L<FS::cust_location>).
2935 =item cust_location_or_main
2937 If this package is associated with a location, returns the locaiton (see
2938 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
2940 =item location_label [ OPTION => VALUE ... ]
2942 Returns the label of the location object (see L<FS::cust_location>).
2946 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
2948 =item tax_locationnum
2950 Returns the foreign key to a L<FS::cust_location> object for calculating
2951 tax on this package, as determined by the C<tax-pkg_address> and
2952 C<tax-ship_address> configuration flags.
2956 sub tax_locationnum {
2958 my $conf = FS::Conf->new;
2959 if ( $conf->exists('tax-pkg_address') ) {
2960 return $self->locationnum;
2962 elsif ( $conf->exists('tax-ship_address') ) {
2963 return $self->cust_main->ship_locationnum;
2966 return $self->cust_main->bill_locationnum;
2972 Returns the L<FS::cust_location> object for tax_locationnum.
2978 FS::cust_location->by_key( $self->tax_locationnum )
2981 =item seconds_since TIMESTAMP
2983 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
2984 package have been online since TIMESTAMP, according to the session monitor.
2986 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2987 L<Time::Local> and L<Date::Parse> for conversion functions.
2992 my($self, $since) = @_;
2995 foreach my $cust_svc (
2996 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
2998 $seconds += $cust_svc->seconds_since($since);
3005 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
3007 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
3008 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
3011 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3012 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3018 sub seconds_since_sqlradacct {
3019 my($self, $start, $end) = @_;
3023 foreach my $cust_svc (
3025 my $part_svc = $_->part_svc;
3026 $part_svc->svcdb eq 'svc_acct'
3027 && scalar($part_svc->part_export_usage);
3030 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
3037 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
3039 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
3040 in this package for sessions ending between TIMESTAMP_START (inclusive) and
3044 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3045 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3050 sub attribute_since_sqlradacct {
3051 my($self, $start, $end, $attrib) = @_;
3055 foreach my $cust_svc (
3057 my $part_svc = $_->part_svc;
3058 $part_svc->svcdb eq 'svc_acct'
3059 && scalar($part_svc->part_export_usage);
3062 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
3074 my( $self, $value ) = @_;
3075 if ( defined($value) ) {
3076 $self->setfield('quantity', $value);
3078 $self->getfield('quantity') || 1;
3081 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
3083 Transfers as many services as possible from this package to another package.
3085 The destination package can be specified by pkgnum by passing an FS::cust_pkg
3086 object. The destination package must already exist.
3088 Services are moved only if the destination allows services with the correct
3089 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
3090 this option with caution! No provision is made for export differences
3091 between the old and new service definitions. Probably only should be used
3092 when your exports for all service definitions of a given svcdb are identical.
3093 (attempt a transfer without it first, to move all possible svcpart-matching
3096 Any services that can't be moved remain in the original package.
3098 Returns an error, if there is one; otherwise, returns the number of services
3099 that couldn't be moved.
3104 my ($self, $dest_pkgnum, %opt) = @_;
3110 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
3111 $dest = $dest_pkgnum;
3112 $dest_pkgnum = $dest->pkgnum;
3114 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
3117 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
3119 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
3120 $target{$pkg_svc->svcpart} = $pkg_svc->quantity;
3123 foreach my $cust_svc ($dest->cust_svc) {
3124 $target{$cust_svc->svcpart}--;
3127 my %svcpart2svcparts = ();
3128 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3129 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
3130 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
3131 next if exists $svcpart2svcparts{$svcpart};
3132 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
3133 $svcpart2svcparts{$svcpart} = [
3135 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
3137 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
3138 'svcpart' => $_ } );
3140 $pkg_svc ? $pkg_svc->primary_svc : '',
3141 $pkg_svc ? $pkg_svc->quantity : 0,
3145 grep { $_ != $svcpart }
3147 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
3149 warn "alternates for svcpart $svcpart: ".
3150 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
3155 foreach my $cust_svc ($self->cust_svc) {
3156 if($target{$cust_svc->svcpart} > 0
3157 or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
3158 $target{$cust_svc->svcpart}--;
3159 my $new = new FS::cust_svc { $cust_svc->hash };
3160 $new->pkgnum($dest_pkgnum);
3161 my $error = $new->replace($cust_svc);
3162 return $error if $error;
3163 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3165 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
3166 warn "alternates to consider: ".
3167 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
3169 my @alternate = grep {
3170 warn "considering alternate svcpart $_: ".
3171 "$target{$_} available in new package\n"
3174 } @{$svcpart2svcparts{$cust_svc->svcpart}};
3176 warn "alternate(s) found\n" if $DEBUG;
3177 my $change_svcpart = $alternate[0];
3178 $target{$change_svcpart}--;
3179 my $new = new FS::cust_svc { $cust_svc->hash };
3180 $new->svcpart($change_svcpart);
3181 $new->pkgnum($dest_pkgnum);
3182 my $error = $new->replace($cust_svc);
3183 return $error if $error;
3196 This method is deprecated. See the I<depend_jobnum> option to the insert and
3197 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
3204 local $SIG{HUP} = 'IGNORE';
3205 local $SIG{INT} = 'IGNORE';
3206 local $SIG{QUIT} = 'IGNORE';
3207 local $SIG{TERM} = 'IGNORE';
3208 local $SIG{TSTP} = 'IGNORE';
3209 local $SIG{PIPE} = 'IGNORE';
3211 my $oldAutoCommit = $FS::UID::AutoCommit;
3212 local $FS::UID::AutoCommit = 0;
3215 foreach my $cust_svc ( $self->cust_svc ) {
3216 #false laziness w/svc_Common::insert
3217 my $svc_x = $cust_svc->svc_x;
3218 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
3219 my $error = $part_export->export_insert($svc_x);
3221 $dbh->rollback if $oldAutoCommit;
3227 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3234 Associates this package with a (suspension or cancellation) reason (see
3235 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
3238 Available options are:
3244 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.
3248 the access_user (see L<FS::access_user>) providing the reason
3256 the action (cancel, susp, adjourn, expire) associated with the reason
3260 If there is an error, returns the error, otherwise returns false.
3265 my ($self, %options) = @_;
3267 my $otaker = $options{reason_otaker} ||
3268 $FS::CurrentUser::CurrentUser->username;
3271 if ( $options{'reason'} =~ /^(\d+)$/ ) {
3275 } elsif ( ref($options{'reason'}) ) {
3277 return 'Enter a new reason (or select an existing one)'
3278 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
3280 my $reason = new FS::reason({
3281 'reason_type' => $options{'reason'}->{'typenum'},
3282 'reason' => $options{'reason'}->{'reason'},
3284 my $error = $reason->insert;
3285 return $error if $error;
3287 $reasonnum = $reason->reasonnum;
3290 return "Unparsable reason: ". $options{'reason'};
3293 my $cust_pkg_reason =
3294 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
3295 'reasonnum' => $reasonnum,
3296 'otaker' => $otaker,
3297 'action' => substr(uc($options{'action'}),0,1),
3298 'date' => $options{'date'}
3303 $cust_pkg_reason->insert;
3306 =item insert_discount
3308 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
3309 inserting a new discount on the fly (see L<FS::discount>).
3311 Available options are:
3319 If there is an error, returns the error, otherwise returns false.
3323 sub insert_discount {
3324 #my ($self, %options) = @_;
3327 my $cust_pkg_discount = new FS::cust_pkg_discount {
3328 'pkgnum' => $self->pkgnum,
3329 'discountnum' => $self->discountnum,
3331 'end_date' => '', #XXX
3332 #for the create a new discount case
3333 '_type' => $self->discountnum__type,
3334 'amount' => $self->discountnum_amount,
3335 'percent' => $self->discountnum_percent,
3336 'months' => $self->discountnum_months,
3337 'setup' => $self->discountnum_setup,
3338 #'disabled' => $self->discountnum_disabled,
3341 $cust_pkg_discount->insert;
3344 =item set_usage USAGE_VALUE_HASHREF
3346 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
3347 to which they should be set (see L<FS::svc_acct>). Currently seconds,
3348 upbytes, downbytes, and totalbytes are appropriate keys.
3350 All svc_accts which are part of this package have their values reset.
3355 my ($self, $valueref, %opt) = @_;
3357 #only svc_acct can set_usage for now
3358 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
3359 my $svc_x = $cust_svc->svc_x;
3360 $svc_x->set_usage($valueref, %opt)
3361 if $svc_x->can("set_usage");
3365 =item recharge USAGE_VALUE_HASHREF
3367 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
3368 to which they should be set (see L<FS::svc_acct>). Currently seconds,
3369 upbytes, downbytes, and totalbytes are appropriate keys.
3371 All svc_accts which are part of this package have their values incremented.
3376 my ($self, $valueref) = @_;
3378 #only svc_acct can set_usage for now
3379 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
3380 my $svc_x = $cust_svc->svc_x;
3381 $svc_x->recharge($valueref)
3382 if $svc_x->can("recharge");
3386 =item cust_pkg_discount
3390 sub cust_pkg_discount {
3392 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
3395 =item cust_pkg_discount_active
3399 sub cust_pkg_discount_active {
3401 grep { $_->status eq 'active' } $self->cust_pkg_discount;
3404 =item cust_pkg_usage
3406 Returns a list of all voice usage counters attached to this package.
3410 sub cust_pkg_usage {
3412 qsearch('cust_pkg_usage', { pkgnum => $self->pkgnum });
3415 =item apply_usage OPTIONS
3417 Takes the following options:
3418 - cdr: a call detail record (L<FS::cdr>)
3419 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
3420 - minutes: the maximum number of minutes to be charged
3422 Finds available usage minutes for a call of this class, and subtracts
3423 up to that many minutes from the usage pool. If the usage pool is empty,
3424 and the C<cdr-minutes_priority> global config option is set, minutes may
3425 be taken from other calls as well. Either way, an allocation record will
3426 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
3427 number of minutes of usage applied to the call.
3432 my ($self, %opt) = @_;
3433 my $cdr = $opt{cdr};
3434 my $rate_detail = $opt{rate_detail};
3435 my $minutes = $opt{minutes};
3436 my $classnum = $rate_detail->classnum;
3437 my $pkgnum = $self->pkgnum;
3438 my $custnum = $self->custnum;
3440 local $SIG{HUP} = 'IGNORE';
3441 local $SIG{INT} = 'IGNORE';
3442 local $SIG{QUIT} = 'IGNORE';
3443 local $SIG{TERM} = 'IGNORE';
3444 local $SIG{TSTP} = 'IGNORE';
3445 local $SIG{PIPE} = 'IGNORE';
3447 my $oldAutoCommit = $FS::UID::AutoCommit;
3448 local $FS::UID::AutoCommit = 0;
3450 my $order = FS::Conf->new->config('cdr-minutes_priority');
3454 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
3456 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
3458 my @usage_recs = qsearch({
3459 'table' => 'cust_pkg_usage',
3460 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
3461 ' JOIN cust_pkg USING (pkgnum)'.
3462 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
3463 'select' => 'cust_pkg_usage.*',
3464 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
3465 " ( cust_pkg.custnum = $custnum AND ".
3466 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
3467 $is_classnum . ' AND '.
3468 " cust_pkg_usage.minutes > 0",
3469 'order_by' => " ORDER BY priority ASC",
3472 my $orig_minutes = $minutes;
3474 while (!$error and $minutes > 0 and @usage_recs) {
3475 my $cust_pkg_usage = shift @usage_recs;
3476 $cust_pkg_usage->select_for_update;
3477 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
3478 pkgusagenum => $cust_pkg_usage->pkgusagenum,
3479 acctid => $cdr->acctid,
3480 minutes => min($cust_pkg_usage->minutes, $minutes),
3482 $cust_pkg_usage->set('minutes',
3483 sprintf('%.0f', $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes)
3485 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
3486 $minutes -= $cdr_cust_pkg_usage->minutes;
3488 if ( $order and $minutes > 0 and !$error ) {
3489 # then try to steal minutes from another call
3491 'table' => 'cdr_cust_pkg_usage',
3492 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
3493 ' JOIN part_pkg_usage USING (pkgusagepart)'.
3494 ' JOIN cust_pkg USING (pkgnum)'.
3495 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
3496 ' JOIN cdr USING (acctid)',
3497 'select' => 'cdr_cust_pkg_usage.*',
3498 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
3499 " ( cust_pkg.pkgnum = $pkgnum OR ".
3500 " ( cust_pkg.custnum = $custnum AND ".
3501 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
3502 " part_pkg_usage_class.classnum = $classnum",
3503 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
3505 if ( $order eq 'time' ) {
3506 # find CDRs that are using minutes, but have a later startdate
3508 my $startdate = $cdr->startdate;
3509 if ($startdate !~ /^\d+$/) {
3510 die "bad cdr startdate '$startdate'";
3512 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
3513 # minimize needless reshuffling
3514 $search{'order_by'} .= ', cdr.startdate DESC';
3516 # XXX may not work correctly with rate_time schedules. Could
3517 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
3519 $search{'addl_from'} .=
3520 ' JOIN rate_detail'.
3521 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
3522 if ( $order eq 'rate_high' ) {
3523 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
3524 $rate_detail->min_charge;
3525 $search{'order_by'} .= ', rate_detail.min_charge ASC';
3526 } elsif ( $order eq 'rate_low' ) {
3527 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
3528 $rate_detail->min_charge;
3529 $search{'order_by'} .= ', rate_detail.min_charge DESC';
3531 # this should really never happen
3532 die "invalid cdr-minutes_priority value '$order'\n";
3535 my @cdr_usage_recs = qsearch(\%search);
3537 while (!$error and @cdr_usage_recs and $minutes > 0) {
3538 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
3539 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
3540 my $old_cdr = $cdr_cust_pkg_usage->cdr;
3541 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
3542 $cdr_cust_pkg_usage->select_for_update;
3543 $old_cdr->select_for_update;
3544 $cust_pkg_usage->select_for_update;
3545 # in case someone else stole the usage from this CDR
3546 # while waiting for the lock...
3547 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
3548 # steal the usage allocation and flag the old CDR for reprocessing
3549 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
3550 # if the allocation is more minutes than we need, adjust it...
3551 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
3553 $cdr_cust_pkg_usage->set('minutes', $minutes);
3554 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
3555 $error = $cust_pkg_usage->replace;
3557 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
3558 $error ||= $cdr_cust_pkg_usage->replace;
3559 # deduct the stolen minutes
3560 $minutes -= $cdr_cust_pkg_usage->minutes;
3562 # after all minute-stealing is done, reset the affected CDRs
3563 foreach (values %reproc_cdrs) {
3564 $error ||= $_->set_status('');
3565 # XXX or should we just call $cdr->rate right here?
3566 # it's not like we can create a loop this way, since the min_charge
3567 # or call time has to go monotonically in one direction.
3568 # we COULD get some very deep recursions going, though...
3570 } # if $order and $minutes
3573 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
3575 $dbh->commit if $oldAutoCommit;
3576 return $orig_minutes - $minutes;
3580 =item supplemental_pkgs
3582 Returns a list of all packages supplemental to this one.
3586 sub supplemental_pkgs {
3588 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
3593 Returns the package that this one is supplemental to, if any.
3599 if ( $self->main_pkgnum ) {
3600 return FS::cust_pkg->by_key($self->main_pkgnum);
3607 =head1 CLASS METHODS
3613 Returns an SQL expression identifying recurring packages.
3617 sub recurring_sql { "
3618 '0' != ( select freq from part_pkg
3619 where cust_pkg.pkgpart = part_pkg.pkgpart )
3624 Returns an SQL expression identifying one-time packages.
3629 '0' = ( select freq from part_pkg
3630 where cust_pkg.pkgpart = part_pkg.pkgpart )
3635 Returns an SQL expression identifying ordered packages (recurring packages not
3641 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
3646 Returns an SQL expression identifying active packages.
3651 $_[0]->recurring_sql. "
3652 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
3653 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3654 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
3657 =item not_yet_billed_sql
3659 Returns an SQL expression identifying packages which have not yet been billed.
3663 sub not_yet_billed_sql { "
3664 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
3665 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3666 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
3671 Returns an SQL expression identifying inactive packages (one-time packages
3672 that are otherwise unsuspended/uncancelled).
3676 sub inactive_sql { "
3677 ". $_[0]->onetime_sql(). "
3678 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
3679 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3680 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
3686 Returns an SQL expression identifying suspended packages.
3690 sub suspended_sql { susp_sql(@_); }
3692 #$_[0]->recurring_sql(). ' AND '.
3694 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3695 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
3702 Returns an SQL exprression identifying cancelled packages.
3706 sub cancelled_sql { cancel_sql(@_); }
3708 #$_[0]->recurring_sql(). ' AND '.
3709 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
3714 Returns an SQL expression to give the package status as a string.
3720 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
3721 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
3722 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
3723 WHEN ".onetime_sql()." THEN 'one-time charge'
3728 =item search HASHREF
3732 Returns a qsearch hash expression to search for parameters specified in HASHREF.
3733 Valid parameters are
3741 active, inactive, suspended, cancel (or cancelled)
3745 active, inactive, suspended, one-time charge, inactive, cancel (or cancelled)
3749 boolean selects custom packages
3755 pkgpart or arrayref or hashref of pkgparts
3759 arrayref of beginning and ending epoch date
3763 arrayref of beginning and ending epoch date
3767 arrayref of beginning and ending epoch date
3771 arrayref of beginning and ending epoch date
3775 arrayref of beginning and ending epoch date
3779 arrayref of beginning and ending epoch date
3783 arrayref of beginning and ending epoch date
3787 pkgnum or APKG_pkgnum
3791 a value suited to passing to FS::UI::Web::cust_header
3795 specifies the user for agent virtualization
3799 boolean; if true, returns only packages with more than 0 FCC phone lines.
3801 =item state, country
3803 Limit to packages with a service location in the specified state and country.
3804 For FCC 477 reporting, mostly.
3811 my ($class, $params) = @_;
3818 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
3820 "cust_main.agentnum = $1";
3827 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
3829 "cust_pkg.custnum = $1";
3836 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
3838 "cust_pkg.pkgbatch = '$1'";
3845 if ( $params->{'magic'} eq 'active'
3846 || $params->{'status'} eq 'active' ) {
3848 push @where, FS::cust_pkg->active_sql();
3850 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
3851 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
3853 push @where, FS::cust_pkg->not_yet_billed_sql();
3855 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
3856 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
3858 push @where, FS::cust_pkg->inactive_sql();
3860 } elsif ( $params->{'magic'} eq 'suspended'
3861 || $params->{'status'} eq 'suspended' ) {
3863 push @where, FS::cust_pkg->suspended_sql();
3865 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
3866 || $params->{'status'} =~ /^cancell?ed$/ ) {
3868 push @where, FS::cust_pkg->cancelled_sql();
3873 # parse package class
3876 if ( exists($params->{'classnum'}) ) {
3879 if ( ref($params->{'classnum'}) ) {
3881 if ( ref($params->{'classnum'}) eq 'HASH' ) {
3882 @classnum = grep $params->{'classnum'}{$_}, keys %{ $params->{'classnum'} };
3883 } elsif ( ref($params->{'classnum'}) eq 'ARRAY' ) {
3884 @classnum = @{ $params->{'classnum'} };
3886 die 'unhandled classnum ref '. $params->{'classnum'};
3890 } elsif ( $params->{'classnum'} =~ /^(\d*)$/ && $1 ne '0' ) {
3897 my @nums = grep $_, @classnum;
3898 push @c_where, 'part_pkg.classnum IN ('. join(',',@nums). ')' if @nums;
3899 my $null = scalar( grep { $_ eq '' } @classnum );
3900 push @c_where, 'part_pkg.classnum IS NULL' if $null;
3902 if ( scalar(@c_where) == 1 ) {
3903 push @where, @c_where;
3904 } elsif ( @c_where ) {
3905 push @where, ' ( '. join(' OR ', @c_where). ' ) ';
3914 # parse package report options
3917 my @report_option = ();
3918 if ( exists($params->{'report_option'}) ) {
3919 if ( ref($params->{'report_option'}) eq 'ARRAY' ) {
3920 @report_option = @{ $params->{'report_option'} };
3921 } elsif ( $params->{'report_option'} =~ /^([,\d]*)$/ ) {
3922 @report_option = split(',', $1);
3927 if (@report_option) {
3928 # this will result in the empty set for the dangling comma case as it should
3930 map{ "0 < ( SELECT count(*) FROM part_pkg_option
3931 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
3932 AND optionname = 'report_option_$_'
3933 AND optionvalue = '1' )"
3937 foreach my $any ( grep /^report_option_any/, keys %$params ) {
3939 my @report_option_any = ();
3940 if ( ref($params->{$any}) eq 'ARRAY' ) {
3941 @report_option_any = @{ $params->{$any} };
3942 } elsif ( $params->{$any} =~ /^([,\d]*)$/ ) {
3943 @report_option_any = split(',', $1);
3946 if (@report_option_any) {
3947 # this will result in the empty set for the dangling comma case as it should
3948 push @where, ' ( '. join(' OR ',
3949 map{ "0 < ( SELECT count(*) FROM part_pkg_option
3950 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
3951 AND optionname = 'report_option_$_'
3952 AND optionvalue = '1' )"
3953 } @report_option_any
3963 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
3969 push @where, "(part_pkg.fcc_ds0s > 0 OR pkg_class.fcc_ds0s > 0)"
3970 if $params->{fcc_line};
3976 if ( exists($params->{'censustract'}) ) {
3977 $params->{'censustract'} =~ /^([.\d]*)$/;
3978 my $censustract = "cust_location.censustract = '$1'";
3979 $censustract .= ' OR cust_location.censustract is NULL' unless $1;
3980 push @where, "( $censustract )";
3984 # parse censustract2
3986 if ( exists($params->{'censustract2'})
3987 && $params->{'censustract2'} =~ /^(\d*)$/
3991 push @where, "cust_location.censustract LIKE '$1%'";
3994 "( cust_location.censustract = '' OR cust_location.censustract IS NULL )";
3999 # parse country/state
4001 for (qw(state country)) { # parsing rules are the same for these
4002 if ( exists($params->{$_})
4003 && uc($params->{$_}) =~ /^([A-Z]{2})$/ )
4005 # XXX post-2.3 only--before that, state/country may be in cust_main
4006 push @where, "cust_location.$_ = '$1'";
4014 if ( ref($params->{'pkgpart'}) ) {
4017 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
4018 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
4019 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
4020 @pkgpart = @{ $params->{'pkgpart'} };
4022 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
4025 @pkgpart = grep /^(\d+)$/, @pkgpart;
4027 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
4029 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
4030 push @where, "pkgpart = $1";
4039 #false laziness w/report_cust_pkg.html
4042 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
4043 'active' => { 'susp'=>1, 'cancel'=>1 },
4044 'suspended' => { 'cancel' => 1 },
4049 if( exists($params->{'active'} ) ) {
4050 # This overrides all the other date-related fields
4051 my($beginning, $ending) = @{$params->{'active'}};
4053 "cust_pkg.setup IS NOT NULL",
4054 "cust_pkg.setup <= $ending",
4055 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
4056 "NOT (".FS::cust_pkg->onetime_sql . ")";
4059 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end change_date cancel )) {
4061 next unless exists($params->{$field});
4063 my($beginning, $ending) = @{$params->{$field}};
4065 next if $beginning == 0 && $ending == 4294967295;
4068 "cust_pkg.$field IS NOT NULL",
4069 "cust_pkg.$field >= $beginning",
4070 "cust_pkg.$field <= $ending";
4072 $orderby ||= "ORDER BY cust_pkg.$field";
4077 $orderby ||= 'ORDER BY bill';
4080 # parse magic, legacy, etc.
4083 if ( $params->{'magic'} &&
4084 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
4087 $orderby = 'ORDER BY pkgnum';
4089 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
4090 push @where, "pkgpart = $1";
4093 } elsif ( $params->{'query'} eq 'pkgnum' ) {
4095 $orderby = 'ORDER BY pkgnum';
4097 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
4099 $orderby = 'ORDER BY pkgnum';
4102 SELECT count(*) FROM pkg_svc
4103 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
4104 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
4105 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
4106 AND cust_svc.svcpart = pkg_svc.svcpart
4113 # setup queries, links, subs, etc. for the search
4116 # here is the agent virtualization
4117 if ($params->{CurrentUser}) {
4119 qsearchs('access_user', { username => $params->{CurrentUser} });
4122 push @where, $access_user->agentnums_sql('table'=>'cust_main');
4127 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
4130 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
4132 my $addl_from = 'LEFT JOIN part_pkg USING ( pkgpart ) '.
4133 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) '.
4134 'LEFT JOIN cust_location USING ( locationnum ) '.
4135 FS::UI::Web::join_cust_main('cust_pkg', 'cust_pkg');
4139 if ( $params->{'select_zip5'} ) {
4140 my $zip = 'cust_location.zip';
4142 $select = "DISTINCT substr($zip,1,5) as zip";
4143 $orderby = "ORDER BY substr($zip,1,5)";
4144 $count_query = "SELECT COUNT( DISTINCT substr($zip,1,5) )";
4146 $select = join(', ',
4148 ( map "part_pkg.$_", qw( pkg freq ) ),
4149 'pkg_class.classname',
4150 'cust_main.custnum AS cust_main_custnum',
4151 FS::UI::Web::cust_sql_fields(
4152 $params->{'cust_fields'}
4155 $count_query = 'SELECT COUNT(*)';
4158 $count_query .= " FROM cust_pkg $addl_from $extra_sql";
4161 'table' => 'cust_pkg',
4163 'select' => $select,
4164 'extra_sql' => $extra_sql,
4165 'order_by' => $orderby,
4166 'addl_from' => $addl_from,
4167 'count_query' => $count_query,
4174 Returns a list of two package counts. The first is a count of packages
4175 based on the supplied criteria and the second is the count of residential
4176 packages with those same criteria. Criteria are specified as in the search
4182 my ($class, $params) = @_;
4184 my $sql_query = $class->search( $params );
4186 my $count_sql = delete($sql_query->{'count_query'});
4187 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
4188 or die "couldn't parse count_sql";
4190 my $count_sth = dbh->prepare($count_sql)
4191 or die "Error preparing $count_sql: ". dbh->errstr;
4193 or die "Error executing $count_sql: ". $count_sth->errstr;
4194 my $count_arrayref = $count_sth->fetchrow_arrayref;
4196 return ( @$count_arrayref );
4200 =item tax_locationnum_sql
4202 Returns an SQL expression for the tax location for a package, based
4203 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
4207 sub tax_locationnum_sql {
4208 my $conf = FS::Conf->new;
4209 if ( $conf->exists('tax-pkg_address') ) {
4210 'cust_pkg.locationnum';
4212 elsif ( $conf->exists('tax-ship_address') ) {
4213 'cust_main.ship_locationnum';
4216 'cust_main.bill_locationnum';
4222 Returns a list: the first item is an SQL fragment identifying matching
4223 packages/customers via location (taking into account shipping and package
4224 address taxation, if enabled), and subsequent items are the parameters to
4225 substitute for the placeholders in that fragment.
4230 my($class, %opt) = @_;
4231 my $ornull = $opt{'ornull'};
4233 my $conf = new FS::Conf;
4235 # '?' placeholders in _location_sql_where
4236 my $x = $ornull ? 3 : 2;
4247 if ( $conf->exists('tax-ship_address') ) {
4250 ( ( ship_last IS NULL OR ship_last = '' )
4251 AND ". _location_sql_where('cust_main', '', $ornull ). "
4253 OR ( ship_last IS NOT NULL AND ship_last != ''
4254 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
4257 # AND payby != 'COMP'
4259 @main_param = ( @bill_param, @bill_param );
4263 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
4264 @main_param = @bill_param;
4270 if ( $conf->exists('tax-pkg_address') ) {
4272 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
4275 ( cust_pkg.locationnum IS NULL AND $main_where )
4276 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
4279 @param = ( @main_param, @bill_param );
4283 $where = $main_where;
4284 @param = @main_param;
4292 #subroutine, helper for location_sql
4293 sub _location_sql_where {
4295 my $prefix = @_ ? shift : '';
4296 my $ornull = @_ ? shift : '';
4298 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
4300 $ornull = $ornull ? ' OR ? IS NULL ' : '';
4302 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
4303 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
4304 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
4306 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
4308 # ( $table.${prefix}city = ? $or_empty_city $ornull )
4310 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4311 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4312 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
4313 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
4314 AND $table.${prefix}country = ?
4319 my( $self, $what ) = @_;
4321 my $what_show_zero = $what. '_show_zero';
4322 length($self->$what_show_zero())
4323 ? ($self->$what_show_zero() eq 'Y')
4324 : $self->part_pkg->$what_show_zero();
4331 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
4333 CUSTNUM is a customer (see L<FS::cust_main>)
4335 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4336 L<FS::part_pkg>) to order for this customer. Duplicates are of course
4339 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
4340 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
4341 new billing items. An error is returned if this is not possible (see
4342 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
4345 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4346 newly-created cust_pkg objects.
4348 REFNUM, if specified, will specify the FS::pkg_referral record to be created
4349 and inserted. Multiple FS::pkg_referral records can be created by
4350 setting I<refnum> to an array reference of refnums or a hash reference with
4351 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
4352 record will be created corresponding to cust_main.refnum.
4357 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
4359 my $conf = new FS::Conf;
4361 # Transactionize this whole mess
4362 local $SIG{HUP} = 'IGNORE';
4363 local $SIG{INT} = 'IGNORE';
4364 local $SIG{QUIT} = 'IGNORE';
4365 local $SIG{TERM} = 'IGNORE';
4366 local $SIG{TSTP} = 'IGNORE';
4367 local $SIG{PIPE} = 'IGNORE';
4369 my $oldAutoCommit = $FS::UID::AutoCommit;
4370 local $FS::UID::AutoCommit = 0;
4374 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
4375 # return "Customer not found: $custnum" unless $cust_main;
4377 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
4380 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4383 my $change = scalar(@old_cust_pkg) != 0;
4386 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
4388 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
4389 " to pkgpart ". $pkgparts->[0]. "\n"
4392 my $err_or_cust_pkg =
4393 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
4394 'refnum' => $refnum,
4397 unless (ref($err_or_cust_pkg)) {
4398 $dbh->rollback if $oldAutoCommit;
4399 return $err_or_cust_pkg;
4402 push @$return_cust_pkg, $err_or_cust_pkg;
4403 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4408 # Create the new packages.
4409 foreach my $pkgpart (@$pkgparts) {
4411 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
4413 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
4414 pkgpart => $pkgpart,
4418 $error = $cust_pkg->insert( 'change' => $change );
4419 push @$return_cust_pkg, $cust_pkg;
4421 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
4422 my $supp_pkg = FS::cust_pkg->new({
4423 custnum => $custnum,
4424 pkgpart => $link->dst_pkgpart,
4426 main_pkgnum => $cust_pkg->pkgnum,
4429 $error ||= $supp_pkg->insert( 'change' => $change );
4430 push @$return_cust_pkg, $supp_pkg;
4434 $dbh->rollback if $oldAutoCommit;
4439 # $return_cust_pkg now contains refs to all of the newly
4442 # Transfer services and cancel old packages.
4443 foreach my $old_pkg (@old_cust_pkg) {
4445 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
4448 foreach my $new_pkg (@$return_cust_pkg) {
4449 $error = $old_pkg->transfer($new_pkg);
4450 if ($error and $error == 0) {
4451 # $old_pkg->transfer failed.
4452 $dbh->rollback if $oldAutoCommit;
4457 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
4458 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
4459 foreach my $new_pkg (@$return_cust_pkg) {
4460 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
4461 if ($error and $error == 0) {
4462 # $old_pkg->transfer failed.
4463 $dbh->rollback if $oldAutoCommit;
4470 # Transfers were successful, but we went through all of the
4471 # new packages and still had services left on the old package.
4472 # We can't cancel the package under the circumstances, so abort.
4473 $dbh->rollback if $oldAutoCommit;
4474 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
4476 $error = $old_pkg->cancel( quiet=>1 );
4482 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4486 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
4488 A bulk change method to change packages for multiple customers.
4490 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4491 L<FS::part_pkg>) to order for each customer. Duplicates are of course
4494 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
4495 replace. The services (see L<FS::cust_svc>) are moved to the
4496 new billing items. An error is returned if this is not possible (see
4499 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4500 newly-created cust_pkg objects.
4505 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
4507 # Transactionize this whole mess
4508 local $SIG{HUP} = 'IGNORE';
4509 local $SIG{INT} = 'IGNORE';
4510 local $SIG{QUIT} = 'IGNORE';
4511 local $SIG{TERM} = 'IGNORE';
4512 local $SIG{TSTP} = 'IGNORE';
4513 local $SIG{PIPE} = 'IGNORE';
4515 my $oldAutoCommit = $FS::UID::AutoCommit;
4516 local $FS::UID::AutoCommit = 0;
4520 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4523 while(scalar(@old_cust_pkg)) {
4525 my $custnum = $old_cust_pkg[0]->custnum;
4526 my (@remove) = map { $_->pkgnum }
4527 grep { $_->custnum == $custnum } @old_cust_pkg;
4528 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
4530 my $error = order $custnum, $pkgparts, \@remove, \@return;
4532 push @errors, $error
4534 push @$return_cust_pkg, @return;
4537 if (scalar(@errors)) {
4538 $dbh->rollback if $oldAutoCommit;
4539 return join(' / ', @errors);
4542 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4546 # Used by FS::Upgrade to migrate to a new database.
4547 sub _upgrade_data { # class method
4548 my ($class, %opts) = @_;
4549 $class->_upgrade_otaker(%opts);
4551 # RT#10139, bug resulting in contract_end being set when it shouldn't
4552 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
4553 # RT#10830, bad calculation of prorate date near end of year
4554 # the date range for bill is December 2009, and we move it forward
4555 # one year if it's before the previous bill date (which it should
4557 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
4558 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
4559 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
4560 # RT6628, add order_date to cust_pkg
4561 'update cust_pkg set order_date = (select history_date from h_cust_pkg
4562 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
4563 history_action = \'insert\') where order_date is null',
4565 foreach my $sql (@statements) {
4566 my $sth = dbh->prepare($sql);
4567 $sth->execute or die $sth->errstr;
4575 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
4577 In sub order, the @pkgparts array (passed by reference) is clobbered.
4579 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
4580 method to pass dates to the recur_prog expression, it should do so.
4582 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
4583 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
4584 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
4585 configuration values. Probably need a subroutine which decides what to do
4586 based on whether or not we've fetched the user yet, rather than a hash. See
4587 FS::UID and the TODO.
4589 Now that things are transactional should the check in the insert method be
4594 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
4595 L<FS::pkg_svc>, schema.html from the base documentation