4 use base qw( FS::otaker_Mixin FS::cust_main_Mixin FS::location_Mixin
5 FS::m2m_Common FS::option_Common );
6 use vars qw($disable_agentcheck $DEBUG $me);
8 use Scalar::Util qw( blessed );
9 use List::Util qw(min max);
11 use Time::Local qw( timelocal timelocal_nocheck );
13 use FS::UID qw( getotaker dbh driver_name );
14 use FS::Misc qw( send_email );
15 use FS::Record qw( qsearch qsearchs fields );
20 use FS::cust_location;
22 use FS::cust_bill_pkg;
23 use FS::cust_pkg_detail;
24 use FS::cust_pkg_usage;
25 use FS::cdr_cust_pkg_usage;
30 use FS::cust_pkg_reason;
32 use FS::cust_pkg_discount;
37 # need to 'use' these instead of 'require' in sub { cancel, suspend, unsuspend,
39 # because they load configuration by setting FS::UID::callback (see TODO)
45 # for sending cancel emails in sub cancel
49 $me = '[FS::cust_pkg]';
51 $disable_agentcheck = 0;
55 my ( $hashref, $cache ) = @_;
56 #if ( $hashref->{'pkgpart'} ) {
57 if ( $hashref->{'pkg'} ) {
58 # #@{ $self->{'_pkgnum'} } = ();
59 # my $subcache = $cache->subcache('pkgpart', 'part_pkg');
60 # $self->{'_pkgpart'} = $subcache;
61 # #push @{ $self->{'_pkgnum'} },
62 # FS::part_pkg->new_or_cached($hashref, $subcache);
63 $self->{'_pkgpart'} = FS::part_pkg->new($hashref);
65 if ( exists $hashref->{'svcnum'} ) {
66 #@{ $self->{'_pkgnum'} } = ();
67 my $subcache = $cache->subcache('svcnum', 'cust_svc', $hashref->{pkgnum});
68 $self->{'_svcnum'} = $subcache;
69 #push @{ $self->{'_pkgnum'} },
70 FS::cust_svc->new_or_cached($hashref, $subcache) if $hashref->{svcnum};
76 FS::cust_pkg - Object methods for cust_pkg objects
82 $record = new FS::cust_pkg \%hash;
83 $record = new FS::cust_pkg { 'column' => 'value' };
85 $error = $record->insert;
87 $error = $new_record->replace($old_record);
89 $error = $record->delete;
91 $error = $record->check;
93 $error = $record->cancel;
95 $error = $record->suspend;
97 $error = $record->unsuspend;
99 $part_pkg = $record->part_pkg;
101 @labels = $record->labels;
103 $seconds = $record->seconds_since($timestamp);
105 $error = FS::cust_pkg::order( $custnum, \@pkgparts );
106 $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );
110 An FS::cust_pkg object represents a customer billing item. FS::cust_pkg
111 inherits from FS::Record. The following fields are currently supported:
117 Primary key (assigned automatically for new billing items)
121 Customer (see L<FS::cust_main>)
125 Billing item definition (see L<FS::part_pkg>)
129 Optional link to package location (see L<FS::location>)
133 date package was ordered (also remains same on changes)
145 date (next bill date)
173 order taker (see L<FS::access_user>)
177 If this field is set to 1, disables the automatic
178 unsuspension of this package when using the B<unsuspendauto> config option.
182 If not set, defaults to 1
186 Date of change from previous package
196 =item change_locationnum
204 The pkgnum of the package that this package is supplemental to, if any.
208 The package link (L<FS::part_pkg_link>) that defines this supplemental
209 package, if it is one.
213 Note: setup, last_bill, bill, adjourn, susp, expire, cancel and change_date
214 are specified as UNIX timestamps; see L<perlfunc/"time">. Also see
215 L<Time::Local> and L<Date::Parse> for conversion functions.
223 Create a new billing item. To add the item to the database, see L<"insert">.
227 sub table { 'cust_pkg'; }
228 sub cust_linked { $_[0]->cust_main_custnum; }
229 sub cust_unlinked_msg {
231 "WARNING: can't find cust_main.custnum ". $self->custnum.
232 ' (cust_pkg.pkgnum '. $self->pkgnum. ')';
235 =item insert [ OPTION => VALUE ... ]
237 Adds this billing item to the database ("Orders" the item). If there is an
238 error, returns the error, otherwise returns false.
240 If the additional field I<promo_code> is defined instead of I<pkgpart>, it
241 will be used to look up the package definition and agent restrictions will be
244 If the additional field I<refnum> is defined, an FS::pkg_referral record will
245 be created and inserted. Multiple FS::pkg_referral records can be created by
246 setting I<refnum> to an array reference of refnums or a hash reference with
247 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
248 record will be created corresponding to cust_main.refnum.
250 The following options are available:
256 If set true, supresses any referral credit to a referring customer.
260 cust_pkg_option records will be created
264 a ticket will be added to this customer with this subject
268 an optional queue name for ticket additions
275 my( $self, %options ) = @_;
277 my $error = $self->check_pkgpart;
278 return $error if $error;
280 my $part_pkg = $self->part_pkg;
282 if ( $part_pkg->option('start_1st', 1) && !$self->start_date ) {
283 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime(time) )[0,1,2,3,4,5];
284 $mon += 1 unless $mday == 1;
285 until ( $mon < 12 ) { $mon -= 12; $year++; }
286 $self->start_date( timelocal_nocheck(0,0,0,1,$mon,$year) );
289 foreach my $action ( qw(expire adjourn contract_end) ) {
290 my $months = $part_pkg->option("${action}_months",1);
291 if($months and !$self->$action) {
292 my $start = $self->start_date || $self->setup || time;
293 $self->$action( $part_pkg->add_freq($start, $months) );
297 my $free_days = $part_pkg->option('free_days',1);
298 if ( $free_days && $part_pkg->option('delay_setup',1) ) { #&& !$self->start_date
299 my ($mday,$mon,$year) = (localtime(time) )[3,4,5];
300 #my $start_date = ($self->start_date || timelocal(0,0,0,$mday,$mon,$year)) + 86400 * $free_days;
301 my $start_date = timelocal(0,0,0,$mday,$mon,$year) + 86400 * $free_days;
302 $self->start_date($start_date);
305 $self->order_date(time);
307 local $SIG{HUP} = 'IGNORE';
308 local $SIG{INT} = 'IGNORE';
309 local $SIG{QUIT} = 'IGNORE';
310 local $SIG{TERM} = 'IGNORE';
311 local $SIG{TSTP} = 'IGNORE';
312 local $SIG{PIPE} = 'IGNORE';
314 my $oldAutoCommit = $FS::UID::AutoCommit;
315 local $FS::UID::AutoCommit = 0;
318 $error = $self->SUPER::insert($options{options} ? %{$options{options}} : ());
320 $dbh->rollback if $oldAutoCommit;
324 $self->refnum($self->cust_main->refnum) unless $self->refnum;
325 $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
326 $self->process_m2m( 'link_table' => 'pkg_referral',
327 'target_table' => 'part_referral',
328 'params' => $self->refnum,
331 if ( $self->discountnum ) {
332 my $error = $self->insert_discount();
334 $dbh->rollback if $oldAutoCommit;
339 #if ( $self->reg_code ) {
340 # my $reg_code = qsearchs('reg_code', { 'code' => $self->reg_code } );
341 # $error = $reg_code->delete;
343 # $dbh->rollback if $oldAutoCommit;
348 my $conf = new FS::Conf;
350 if ( $conf->config('ticket_system') && $options{ticket_subject} ) {
352 #this init stuff is still inefficient, but at least its limited to
353 # the small number (any?) folks using ticket emailing on pkg order
356 # use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
363 use FS::TicketSystem;
364 FS::TicketSystem->init();
366 my $q = new RT::Queue($RT::SystemUser);
367 $q->Load($options{ticket_queue}) if $options{ticket_queue};
368 my $t = new RT::Ticket($RT::SystemUser);
369 my $mime = new MIME::Entity;
370 $mime->build( Type => 'text/plain', Data => $options{ticket_subject} );
371 $t->Create( $options{ticket_queue} ? (Queue => $q) : (),
372 Subject => $options{ticket_subject},
375 $t->AddLink( Type => 'MemberOf',
376 Target => 'freeside://freeside/cust_main/'. $self->custnum,
380 if ($conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
381 my $queue = new FS::queue {
382 'job' => 'FS::cust_main::queueable_print',
384 $error = $queue->insert(
385 'custnum' => $self->custnum,
386 'template' => 'welcome_letter',
390 warn "can't send welcome letter: $error";
395 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
402 This method now works but you probably shouldn't use it.
404 You don't want to delete packages, because there would then be no record
405 the customer ever purchased the package. Instead, see the cancel method and
406 hide cancelled packages.
413 local $SIG{HUP} = 'IGNORE';
414 local $SIG{INT} = 'IGNORE';
415 local $SIG{QUIT} = 'IGNORE';
416 local $SIG{TERM} = 'IGNORE';
417 local $SIG{TSTP} = 'IGNORE';
418 local $SIG{PIPE} = 'IGNORE';
420 my $oldAutoCommit = $FS::UID::AutoCommit;
421 local $FS::UID::AutoCommit = 0;
424 foreach my $cust_pkg_discount ($self->cust_pkg_discount) {
425 my $error = $cust_pkg_discount->delete;
427 $dbh->rollback if $oldAutoCommit;
431 #cust_bill_pkg_discount?
433 foreach my $cust_pkg_detail ($self->cust_pkg_detail) {
434 my $error = $cust_pkg_detail->delete;
436 $dbh->rollback if $oldAutoCommit;
441 foreach my $cust_pkg_reason (
443 'table' => 'cust_pkg_reason',
444 'hashref' => { 'pkgnum' => $self->pkgnum },
448 my $error = $cust_pkg_reason->delete;
450 $dbh->rollback if $oldAutoCommit;
457 my $error = $self->SUPER::delete(@_);
459 $dbh->rollback if $oldAutoCommit;
463 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
469 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
471 Replaces the OLD_RECORD with this one in the database. If there is an error,
472 returns the error, otherwise returns false.
474 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
476 Changing pkgpart may have disasterous effects. See the order subroutine.
478 setup and bill are normally updated by calling the bill method of a customer
479 object (see L<FS::cust_main>).
481 suspend is normally updated by the suspend and unsuspend methods.
483 cancel is normally updated by the cancel method (and also the order subroutine
486 Available options are:
492 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.
496 the access_user (see L<FS::access_user>) providing the reason
500 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
509 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
514 ( ref($_[0]) eq 'HASH' )
518 #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
519 #return "Can't change otaker!" if $old->otaker ne $new->otaker;
522 #return "Can't change setup once it exists!"
523 # if $old->getfield('setup') &&
524 # $old->getfield('setup') != $new->getfield('setup');
526 #some logic for bill, susp, cancel?
528 local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
530 local $SIG{HUP} = 'IGNORE';
531 local $SIG{INT} = 'IGNORE';
532 local $SIG{QUIT} = 'IGNORE';
533 local $SIG{TERM} = 'IGNORE';
534 local $SIG{TSTP} = 'IGNORE';
535 local $SIG{PIPE} = 'IGNORE';
537 my $oldAutoCommit = $FS::UID::AutoCommit;
538 local $FS::UID::AutoCommit = 0;
541 foreach my $method ( qw(adjourn expire) ) { # How many reasons?
542 if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
543 my $error = $new->insert_reason(
544 'reason' => $options->{'reason'},
545 'date' => $new->$method,
547 'reason_otaker' => $options->{'reason_otaker'},
550 dbh->rollback if $oldAutoCommit;
551 return "Error inserting cust_pkg_reason: $error";
556 #save off and freeze RADIUS attributes for any associated svc_acct records
558 if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
560 #also check for specific exports?
561 # to avoid spurious modify export events
562 @svc_acct = map { $_->svc_x }
563 grep { $_->part_svc->svcdb eq 'svc_acct' }
566 $_->snapshot foreach @svc_acct;
570 my $error = $new->SUPER::replace($old,
571 $options->{options} ? $options->{options} : ()
574 $dbh->rollback if $oldAutoCommit;
578 #for prepaid packages,
579 #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
580 foreach my $old_svc_acct ( @svc_acct ) {
581 my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
583 $new_svc_acct->replace( $old_svc_acct,
584 'depend_jobnum' => $options->{depend_jobnum},
587 $dbh->rollback if $oldAutoCommit;
592 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
599 Checks all fields to make sure this is a valid billing item. If there is an
600 error, returns the error, otherwise returns false. Called by the insert and
608 if ( !$self->locationnum or $self->locationnum == -1 ) {
609 $self->set('locationnum', $self->cust_main->ship_locationnum);
613 $self->ut_numbern('pkgnum')
614 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
615 || $self->ut_numbern('pkgpart')
616 || $self->check_pkgpart
617 || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
618 || $self->ut_numbern('start_date')
619 || $self->ut_numbern('setup')
620 || $self->ut_numbern('bill')
621 || $self->ut_numbern('susp')
622 || $self->ut_numbern('cancel')
623 || $self->ut_numbern('adjourn')
624 || $self->ut_numbern('resume')
625 || $self->ut_numbern('expire')
626 || $self->ut_numbern('dundate')
627 || $self->ut_enum('no_auto', [ '', 'Y' ])
628 || $self->ut_enum('waive_setup', [ '', 'Y' ])
629 || $self->ut_numbern('agent_pkgid')
630 || $self->ut_enum('recur_show_zero', [ '', 'Y', 'N', ])
631 || $self->ut_enum('setup_show_zero', [ '', 'Y', 'N', ])
632 || $self->ut_foreign_keyn('main_pkgnum', 'cust_pkg', 'pkgnum')
633 || $self->ut_foreign_keyn('pkglinknum', 'part_pkg_link', 'pkglinknum')
635 return $error if $error;
637 return "A package with both start date (future start) and setup date (already started) will never bill"
638 if $self->start_date && $self->setup;
640 return "A future unsuspend date can only be set for a package with a suspend date"
641 if $self->resume and !$self->susp and !$self->adjourn;
643 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
645 if ( $self->dbdef_table->column('manual_flag') ) {
646 $self->manual_flag('') if $self->manual_flag eq ' ';
647 $self->manual_flag =~ /^([01]?)$/
648 or return "Illegal manual_flag ". $self->manual_flag;
649 $self->manual_flag($1);
662 my $error = $self->ut_numbern('pkgpart');
663 return $error if $error;
665 if ( $self->reg_code ) {
667 unless ( grep { $self->pkgpart == $_->pkgpart }
668 map { $_->reg_code_pkg }
669 qsearchs( 'reg_code', { 'code' => $self->reg_code,
670 'agentnum' => $self->cust_main->agentnum })
672 return "Unknown registration code";
675 } elsif ( $self->promo_code ) {
678 qsearchs('part_pkg', {
679 'pkgpart' => $self->pkgpart,
680 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
682 return 'Unknown promotional code' unless $promo_part_pkg;
686 unless ( $disable_agentcheck ) {
688 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
689 return "agent ". $agent->agentnum. ':'. $agent->agent.
690 " can't purchase pkgpart ". $self->pkgpart
691 unless $agent->pkgpart_hashref->{ $self->pkgpart }
692 || $agent->agentnum == $self->part_pkg->agentnum;
695 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
696 return $error if $error;
704 =item cancel [ OPTION => VALUE ... ]
706 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
707 in this package, then cancels the package itself (sets the cancel field to
710 Available options are:
714 =item quiet - can be set true to supress email cancellation notices.
716 =item time - can be set to cancel the package based on a specific future or
717 historical date. Using time ensures that the remaining amount is calculated
718 correctly. Note however that this is an immediate cancel and just changes
719 the date. You are PROBABLY looking to expire the account instead of using
722 =item reason - can be set to a cancellation reason (see L<FS:reason>),
723 either a reasonnum of an existing reason, or passing a hashref will create
724 a new reason. The hashref should have the following keys: typenum - Reason
725 type (see L<FS::reason_type>, reason - Text of the new reason.
727 =item date - can be set to a unix style timestamp to specify when to
730 =item nobill - can be set true to skip billing if it might otherwise be done.
732 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
733 not credit it. This must be set (by change()) when changing the package
734 to a different pkgpart or location, and probably shouldn't be in any other
735 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
740 If there is an error, returns the error, otherwise returns false.
745 my( $self, %options ) = @_;
748 # pass all suspend/cancel actions to the main package
749 if ( $self->main_pkgnum and !$options{'from_main'} ) {
750 return $self->main_pkg->cancel(%options);
753 my $conf = new FS::Conf;
755 warn "cust_pkg::cancel called with options".
756 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
759 local $SIG{HUP} = 'IGNORE';
760 local $SIG{INT} = 'IGNORE';
761 local $SIG{QUIT} = 'IGNORE';
762 local $SIG{TERM} = 'IGNORE';
763 local $SIG{TSTP} = 'IGNORE';
764 local $SIG{PIPE} = 'IGNORE';
766 my $oldAutoCommit = $FS::UID::AutoCommit;
767 local $FS::UID::AutoCommit = 0;
770 my $old = $self->select_for_update;
772 if ( $old->get('cancel') || $self->get('cancel') ) {
773 dbh->rollback if $oldAutoCommit;
774 return ""; # no error
777 # XXX possibly set cancel_time to the expire date?
778 my $cancel_time = $options{'time'} || time;
779 my $date = $options{'date'} if $options{'date'}; # expire/cancel later
780 $date = '' if ($date && $date <= $cancel_time); # complain instead?
782 #race condition: usage could be ongoing until unprovisioned
783 #resolved by performing a change package instead (which unprovisions) and
785 if ( !$options{nobill} && !$date ) {
786 # && $conf->exists('bill_usage_on_cancel') ) { #calc_cancel checks this
787 my $copy = $self->new({$self->hash});
789 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
791 'time' => $cancel_time );
792 warn "Error billing during cancel, custnum ".
793 #$self->cust_main->custnum. ": $error"
798 if ( $options{'reason'} ) {
799 $error = $self->insert_reason( 'reason' => $options{'reason'},
800 'action' => $date ? 'expire' : 'cancel',
801 'date' => $date ? $date : $cancel_time,
802 'reason_otaker' => $options{'reason_otaker'},
805 dbh->rollback if $oldAutoCommit;
806 return "Error inserting cust_pkg_reason: $error";
810 my %svc_cancel_opt = ();
811 $svc_cancel_opt{'date'} = $date if $date;
812 foreach my $cust_svc (
815 sort { $a->[1] <=> $b->[1] }
816 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; }
817 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
819 my $part_svc = $cust_svc->part_svc;
820 next if ( defined($part_svc) and $part_svc->preserve );
821 my $error = $cust_svc->cancel( %svc_cancel_opt );
824 $dbh->rollback if $oldAutoCommit;
825 return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
831 # credit remaining time if appropriate
833 if ( exists($options{'unused_credit'}) ) {
834 $do_credit = $options{'unused_credit'};
837 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
840 my $error = $self->credit_remaining('cancel', $cancel_time);
842 $dbh->rollback if $oldAutoCommit;
849 my %hash = $self->hash;
850 $date ? ($hash{'expire'} = $date) : ($hash{'cancel'} = $cancel_time);
851 my $new = new FS::cust_pkg ( \%hash );
852 $error = $new->replace( $self, options => { $self->options } );
854 $dbh->rollback if $oldAutoCommit;
858 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
859 $error = $supp_pkg->cancel(%options, 'from_main' => 1);
861 $dbh->rollback if $oldAutoCommit;
862 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
866 foreach my $usage ( $self->cust_pkg_usage ) {
867 $error = $usage->delete;
869 $dbh->rollback if $oldAutoCommit;
870 return "deleting usage pools: $error";
874 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
875 return '' if $date; #no errors
877 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
878 if ( !$options{'quiet'} &&
879 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
881 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
884 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
885 $error = $msg_template->send( 'cust_main' => $self->cust_main,
890 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
891 'to' => \@invoicing_list,
892 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
893 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
896 #should this do something on errors?
903 =item cancel_if_expired [ NOW_TIMESTAMP ]
905 Cancels this package if its expire date has been reached.
909 sub cancel_if_expired {
911 my $time = shift || time;
912 return '' unless $self->expire && $self->expire <= $time;
913 my $error = $self->cancel;
915 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
916 $self->custnum. ": $error";
923 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
924 locationnum, (other fields?). Attempts to re-provision cancelled services
925 using history information (errors at this stage are not fatal).
927 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
929 svc_fatal: service provisioning errors are fatal
931 svc_errors: pass an array reference, will be filled in with any provisioning errors
933 main_pkgnum: link the package as a supplemental package of this one. For
939 my( $self, %options ) = @_;
941 #in case you try do do $uncancel-date = $cust_pkg->uncacel
942 return '' unless $self->get('cancel');
944 if ( $self->main_pkgnum and !$options{'main_pkgnum'} ) {
945 return $self->main_pkg->uncancel(%options);
952 local $SIG{HUP} = 'IGNORE';
953 local $SIG{INT} = 'IGNORE';
954 local $SIG{QUIT} = 'IGNORE';
955 local $SIG{TERM} = 'IGNORE';
956 local $SIG{TSTP} = 'IGNORE';
957 local $SIG{PIPE} = 'IGNORE';
959 my $oldAutoCommit = $FS::UID::AutoCommit;
960 local $FS::UID::AutoCommit = 0;
964 # insert the new package
967 my $cust_pkg = new FS::cust_pkg {
968 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
969 bill => ( $options{'bill'} || $self->get('bill') ),
971 uncancel_pkgnum => $self->pkgnum,
972 main_pkgnum => ($options{'main_pkgnum'} || ''),
973 map { $_ => $self->get($_) } qw(
974 custnum pkgpart locationnum
976 susp adjourn resume expire start_date contract_end dundate
977 change_date change_pkgpart change_locationnum
978 manual_flag no_auto quantity agent_pkgid recur_show_zero setup_show_zero
982 my $error = $cust_pkg->insert(
983 'change' => 1, #supresses any referral credit to a referring customer
986 $dbh->rollback if $oldAutoCommit;
994 #find historical services within this timeframe before the package cancel
995 # (incompatible with "time" option to cust_pkg->cancel?)
996 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
997 # too little? (unprovisioing export delay?)
998 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
999 my @h_cust_svc = $self->h_cust_svc( $end, $start );
1002 foreach my $h_cust_svc (@h_cust_svc) {
1003 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
1004 #next unless $h_svc_x; #should this happen?
1005 (my $table = $h_svc_x->table) =~ s/^h_//;
1006 require "FS/$table.pm";
1007 my $class = "FS::$table";
1008 my $svc_x = $class->new( {
1009 'pkgnum' => $cust_pkg->pkgnum,
1010 'svcpart' => $h_cust_svc->svcpart,
1011 map { $_ => $h_svc_x->get($_) } fields($table)
1015 if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
1016 $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
1019 my $svc_error = $svc_x->insert;
1021 if ( $options{svc_fatal} ) {
1022 $dbh->rollback if $oldAutoCommit;
1025 push @svc_errors, $svc_error;
1026 # is this necessary? svc_Common::insert already deletes the
1027 # cust_svc if inserting svc_x fails.
1028 my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1030 my $cs_error = $cust_svc->delete;
1032 $dbh->rollback if $oldAutoCommit;
1038 } #foreach $h_cust_svc
1040 #these are pretty rare, but should handle them
1041 # - dsl_device (mac addresses)
1042 # - phone_device (mac addresses)
1043 # - dsl_note (ikano notes)
1044 # - domain_record (i.e. restore DNS information w/domains)
1045 # - inventory_item(?) (inventory w/un-cancelling service?)
1046 # - nas (svc_broaband nas stuff)
1047 #this stuff is unused in the wild afaik
1048 # - mailinglistmember
1050 # - svc_domain.parent_svcnum?
1051 # - acct_snarf (ancient mail fetching config)
1052 # - cgp_rule (communigate)
1053 # - cust_svc_option (used by our Tron stuff)
1054 # - acct_rt_transaction (used by our time worked stuff)
1057 # also move over any services that didn't unprovision at cancellation
1060 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1061 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1062 my $error = $cust_svc->replace;
1064 $dbh->rollback if $oldAutoCommit;
1070 # Uncancel any supplemental packages, and make them supplemental to the
1074 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1076 $error = $supp_pkg->uncancel(%options, 'main_pkgnum' => $cust_pkg->pkgnum);
1078 $dbh->rollback if $oldAutoCommit;
1079 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1087 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1089 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1090 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1097 Cancels any pending expiration (sets the expire field to null).
1099 If there is an error, returns the error, otherwise returns false.
1104 my( $self, %options ) = @_;
1107 local $SIG{HUP} = 'IGNORE';
1108 local $SIG{INT} = 'IGNORE';
1109 local $SIG{QUIT} = 'IGNORE';
1110 local $SIG{TERM} = 'IGNORE';
1111 local $SIG{TSTP} = 'IGNORE';
1112 local $SIG{PIPE} = 'IGNORE';
1114 my $oldAutoCommit = $FS::UID::AutoCommit;
1115 local $FS::UID::AutoCommit = 0;
1118 my $old = $self->select_for_update;
1120 my $pkgnum = $old->pkgnum;
1121 if ( $old->get('cancel') || $self->get('cancel') ) {
1122 dbh->rollback if $oldAutoCommit;
1123 return "Can't unexpire cancelled package $pkgnum";
1124 # or at least it's pointless
1127 unless ( $old->get('expire') && $self->get('expire') ) {
1128 dbh->rollback if $oldAutoCommit;
1129 return ""; # no error
1132 my %hash = $self->hash;
1133 $hash{'expire'} = '';
1134 my $new = new FS::cust_pkg ( \%hash );
1135 $error = $new->replace( $self, options => { $self->options } );
1137 $dbh->rollback if $oldAutoCommit;
1141 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1147 =item suspend [ OPTION => VALUE ... ]
1149 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1150 package, then suspends the package itself (sets the susp field to now).
1152 Available options are:
1156 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1157 either a reasonnum of an existing reason, or passing a hashref will create
1158 a new reason. The hashref should have the following keys:
1159 - typenum - Reason type (see L<FS::reason_type>
1160 - reason - Text of the new reason.
1162 =item date - can be set to a unix style timestamp to specify when to
1165 =item time - can be set to override the current time, for calculation
1166 of final invoices or unused-time credits
1168 =item resume_date - can be set to a time when the package should be
1169 unsuspended. This may be more convenient than calling C<unsuspend()>
1172 =item from_main - allows a supplemental package to be suspended, rather
1173 than redirecting the method call to its main package. For internal use.
1177 If there is an error, returns the error, otherwise returns false.
1182 my( $self, %options ) = @_;
1185 # pass all suspend/cancel actions to the main package
1186 if ( $self->main_pkgnum and !$options{'from_main'} ) {
1187 return $self->main_pkg->suspend(%options);
1190 local $SIG{HUP} = 'IGNORE';
1191 local $SIG{INT} = 'IGNORE';
1192 local $SIG{QUIT} = 'IGNORE';
1193 local $SIG{TERM} = 'IGNORE';
1194 local $SIG{TSTP} = 'IGNORE';
1195 local $SIG{PIPE} = 'IGNORE';
1197 my $oldAutoCommit = $FS::UID::AutoCommit;
1198 local $FS::UID::AutoCommit = 0;
1201 my $old = $self->select_for_update;
1203 my $pkgnum = $old->pkgnum;
1204 if ( $old->get('cancel') || $self->get('cancel') ) {
1205 dbh->rollback if $oldAutoCommit;
1206 return "Can't suspend cancelled package $pkgnum";
1209 if ( $old->get('susp') || $self->get('susp') ) {
1210 dbh->rollback if $oldAutoCommit;
1211 return ""; # no error # complain on adjourn?
1214 my $suspend_time = $options{'time'} || time;
1215 my $date = $options{date} if $options{date}; # adjourn/suspend later
1216 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1218 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1219 dbh->rollback if $oldAutoCommit;
1220 return "Package $pkgnum expires before it would be suspended.";
1223 # some false laziness with sub cancel
1224 if ( !$options{nobill} && !$date &&
1225 $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1226 # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1227 # make the entire cust_main->bill path recognize 'suspend' and
1228 # 'cancel' separately.
1229 warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1230 my $copy = $self->new({$self->hash});
1232 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1234 'time' => $suspend_time );
1235 warn "Error billing during suspend, custnum ".
1236 #$self->cust_main->custnum. ": $error"
1241 if ( $options{'reason'} ) {
1242 $error = $self->insert_reason( 'reason' => $options{'reason'},
1243 'action' => $date ? 'adjourn' : 'suspend',
1244 'date' => $date ? $date : $suspend_time,
1245 'reason_otaker' => $options{'reason_otaker'},
1248 dbh->rollback if $oldAutoCommit;
1249 return "Error inserting cust_pkg_reason: $error";
1253 my %hash = $self->hash;
1255 $hash{'adjourn'} = $date;
1257 $hash{'susp'} = $suspend_time;
1260 my $resume_date = $options{'resume_date'} || 0;
1261 if ( $resume_date > ($date || $suspend_time) ) {
1262 $hash{'resume'} = $resume_date;
1265 $options{options} ||= {};
1267 my $new = new FS::cust_pkg ( \%hash );
1268 $error = $new->replace( $self, options => { $self->options,
1269 %{ $options{options} },
1273 $dbh->rollback if $oldAutoCommit;
1278 # credit remaining time if appropriate
1279 if ( $self->part_pkg->option('unused_credit_suspend', 1) ) {
1280 my $error = $self->credit_remaining('suspend', $suspend_time);
1282 $dbh->rollback if $oldAutoCommit;
1289 foreach my $cust_svc (
1290 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1292 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1294 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1295 $dbh->rollback if $oldAutoCommit;
1296 return "Illegal svcdb value in part_svc!";
1299 require "FS/$svcdb.pm";
1301 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1303 $error = $svc->suspend;
1305 $dbh->rollback if $oldAutoCommit;
1308 my( $label, $value ) = $cust_svc->label;
1309 push @labels, "$label: $value";
1313 my $conf = new FS::Conf;
1314 if ( $conf->config('suspend_email_admin') ) {
1316 my $error = send_email(
1317 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1318 #invoice_from ??? well as good as any
1319 'to' => $conf->config('suspend_email_admin'),
1320 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1322 "This is an automatic message from your Freeside installation\n",
1323 "informing you that the following customer package has been suspended:\n",
1325 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1326 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1327 ( map { "Service : $_\n" } @labels ),
1332 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1340 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1341 $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1343 $dbh->rollback if $oldAutoCommit;
1344 return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1348 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1353 =item credit_remaining MODE TIME
1355 Generate a credit for this package for the time remaining in the current
1356 billing period. MODE is either "suspend" or "cancel" (determines the
1357 credit type). TIME is the time of suspension/cancellation. Both arguments
1362 sub credit_remaining {
1363 # Add a credit for remaining service
1364 my ($self, $mode, $time) = @_;
1365 die 'credit_remaining requires suspend or cancel'
1366 unless $mode eq 'suspend' or $mode eq 'cancel';
1367 die 'no suspend/cancel time' unless $time > 0;
1369 my $conf = FS::Conf->new;
1370 my $reason_type = $conf->config($mode.'_credit_type');
1372 my $last_bill = $self->getfield('last_bill') || 0;
1373 my $next_bill = $self->getfield('bill') || 0;
1374 if ( $last_bill > 0 # the package has been billed
1375 and $next_bill > 0 # the package has a next bill date
1376 and $next_bill >= $time # which is in the future
1378 my $remaining_value = $self->calc_remain('time' => $time);
1379 if ( $remaining_value > 0 ) {
1380 warn "Crediting for $remaining_value on package ".$self->pkgnum."\n"
1382 my $error = $self->cust_main->credit(
1384 'Credit for unused time on '. $self->part_pkg->pkg,
1385 'reason_type' => $reason_type,
1387 return "Error crediting customer \$$remaining_value for unused time".
1388 " on ". $self->part_pkg->pkg. ": $error"
1390 } #if $remaining_value
1391 } #if $last_bill, etc.
1395 =item unsuspend [ OPTION => VALUE ... ]
1397 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1398 package, then unsuspends the package itself (clears the susp field and the
1399 adjourn field if it is in the past). If the suspend reason includes an
1400 unsuspension package, that package will be ordered.
1402 Available options are:
1408 Can be set to a date to unsuspend the package in the future (the 'resume'
1411 =item adjust_next_bill
1413 Can be set true to adjust the next bill date forward by
1414 the amount of time the account was inactive. This was set true by default
1415 since 1.4.2 and 1.5.0pre6; however, starting with 1.7.0 this needs to be
1416 explicitly requested. Price plans for which this makes sense (anniversary-date
1417 based than prorate or subscription) could have an option to enable this
1422 If there is an error, returns the error, otherwise returns false.
1427 my( $self, %opt ) = @_;
1430 # pass all suspend/cancel actions to the main package
1431 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1432 return $self->main_pkg->unsuspend(%opt);
1435 local $SIG{HUP} = 'IGNORE';
1436 local $SIG{INT} = 'IGNORE';
1437 local $SIG{QUIT} = 'IGNORE';
1438 local $SIG{TERM} = 'IGNORE';
1439 local $SIG{TSTP} = 'IGNORE';
1440 local $SIG{PIPE} = 'IGNORE';
1442 my $oldAutoCommit = $FS::UID::AutoCommit;
1443 local $FS::UID::AutoCommit = 0;
1446 my $old = $self->select_for_update;
1448 my $pkgnum = $old->pkgnum;
1449 if ( $old->get('cancel') || $self->get('cancel') ) {
1450 $dbh->rollback if $oldAutoCommit;
1451 return "Can't unsuspend cancelled package $pkgnum";
1454 unless ( $old->get('susp') && $self->get('susp') ) {
1455 $dbh->rollback if $oldAutoCommit;
1456 return ""; # no error # complain instead?
1459 my $date = $opt{'date'};
1460 if ( $date and $date > time ) { # return an error if $date <= time?
1462 if ( $old->get('expire') && $old->get('expire') < $date ) {
1463 $dbh->rollback if $oldAutoCommit;
1464 return "Package $pkgnum expires before it would be unsuspended.";
1467 my $new = new FS::cust_pkg { $self->hash };
1468 $new->set('resume', $date);
1469 $error = $new->replace($self, options => $self->options);
1472 $dbh->rollback if $oldAutoCommit;
1476 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1484 foreach my $cust_svc (
1485 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1487 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1489 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1490 $dbh->rollback if $oldAutoCommit;
1491 return "Illegal svcdb value in part_svc!";
1494 require "FS/$svcdb.pm";
1496 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1498 $error = $svc->unsuspend;
1500 $dbh->rollback if $oldAutoCommit;
1503 my( $label, $value ) = $cust_svc->label;
1504 push @labels, "$label: $value";
1509 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1510 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1512 my %hash = $self->hash;
1513 my $inactive = time - $hash{'susp'};
1515 my $conf = new FS::Conf;
1517 if ( $inactive > 0 &&
1518 ( $hash{'bill'} || $hash{'setup'} ) &&
1519 ( $opt{'adjust_next_bill'} ||
1520 $conf->exists('unsuspend-always_adjust_next_bill_date') ||
1521 $self->part_pkg->option('unsuspend_adjust_bill', 1) )
1524 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1529 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1530 $hash{'resume'} = '' if !$hash{'adjourn'};
1531 my $new = new FS::cust_pkg ( \%hash );
1532 $error = $new->replace( $self, options => { $self->options } );
1534 $dbh->rollback if $oldAutoCommit;
1540 if ( $reason && $reason->unsuspend_pkgpart ) {
1541 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
1542 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
1544 my $start_date = $self->cust_main->next_bill_date
1545 if $reason->unsuspend_hold;
1548 $unsusp_pkg = FS::cust_pkg->new({
1549 'custnum' => $self->custnum,
1550 'pkgpart' => $reason->unsuspend_pkgpart,
1551 'start_date' => $start_date,
1552 'locationnum' => $self->locationnum,
1553 # discount? probably not...
1556 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
1560 $dbh->rollback if $oldAutoCommit;
1565 if ( $conf->config('unsuspend_email_admin') ) {
1567 my $error = send_email(
1568 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1569 #invoice_from ??? well as good as any
1570 'to' => $conf->config('unsuspend_email_admin'),
1571 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
1572 "This is an automatic message from your Freeside installation\n",
1573 "informing you that the following customer package has been unsuspended:\n",
1575 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1576 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1577 ( map { "Service : $_\n" } @labels ),
1579 "An unsuspension fee was charged: ".
1580 $unsusp_pkg->part_pkg->pkg_comment."\n"
1587 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
1593 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1594 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
1596 $dbh->rollback if $oldAutoCommit;
1597 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1601 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1608 Cancels any pending suspension (sets the adjourn field to null).
1610 If there is an error, returns the error, otherwise returns false.
1615 my( $self, %options ) = @_;
1618 local $SIG{HUP} = 'IGNORE';
1619 local $SIG{INT} = 'IGNORE';
1620 local $SIG{QUIT} = 'IGNORE';
1621 local $SIG{TERM} = 'IGNORE';
1622 local $SIG{TSTP} = 'IGNORE';
1623 local $SIG{PIPE} = 'IGNORE';
1625 my $oldAutoCommit = $FS::UID::AutoCommit;
1626 local $FS::UID::AutoCommit = 0;
1629 my $old = $self->select_for_update;
1631 my $pkgnum = $old->pkgnum;
1632 if ( $old->get('cancel') || $self->get('cancel') ) {
1633 dbh->rollback if $oldAutoCommit;
1634 return "Can't unadjourn cancelled package $pkgnum";
1635 # or at least it's pointless
1638 if ( $old->get('susp') || $self->get('susp') ) {
1639 dbh->rollback if $oldAutoCommit;
1640 return "Can't unadjourn suspended package $pkgnum";
1641 # perhaps this is arbitrary
1644 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1645 dbh->rollback if $oldAutoCommit;
1646 return ""; # no error
1649 my %hash = $self->hash;
1650 $hash{'adjourn'} = '';
1651 $hash{'resume'} = '';
1652 my $new = new FS::cust_pkg ( \%hash );
1653 $error = $new->replace( $self, options => { $self->options } );
1655 $dbh->rollback if $oldAutoCommit;
1659 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1666 =item change HASHREF | OPTION => VALUE ...
1668 Changes this package: cancels it and creates a new one, with a different
1669 pkgpart or locationnum or both. All services are transferred to the new
1670 package (no change will be made if this is not possible).
1672 Options may be passed as a list of key/value pairs or as a hash reference.
1679 New locationnum, to change the location for this package.
1683 New FS::cust_location object, to create a new location and assign it
1688 New pkgpart (see L<FS::part_pkg>).
1692 New refnum (see L<FS::part_referral>).
1696 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1697 susp, adjourn, cancel, expire, and contract_end) to the new package.
1701 At least one of locationnum, cust_location, pkgpart, refnum must be specified
1702 (otherwise, what's the point?)
1704 Returns either the new FS::cust_pkg object or a scalar error.
1708 my $err_or_new_cust_pkg = $old_cust_pkg->change
1712 #some false laziness w/order
1715 my $opt = ref($_[0]) ? shift : { @_ };
1717 # my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
1720 my $conf = new FS::Conf;
1722 # Transactionize this whole mess
1723 local $SIG{HUP} = 'IGNORE';
1724 local $SIG{INT} = 'IGNORE';
1725 local $SIG{QUIT} = 'IGNORE';
1726 local $SIG{TERM} = 'IGNORE';
1727 local $SIG{TSTP} = 'IGNORE';
1728 local $SIG{PIPE} = 'IGNORE';
1730 my $oldAutoCommit = $FS::UID::AutoCommit;
1731 local $FS::UID::AutoCommit = 0;
1740 #$hash{$_} = $self->$_() foreach qw( last_bill bill );
1742 #$hash{$_} = $self->$_() foreach qw( setup );
1744 $hash{'setup'} = $time if $self->setup;
1746 $hash{'change_date'} = $time;
1747 $hash{"change_$_"} = $self->$_()
1748 foreach qw( pkgnum pkgpart locationnum );
1750 if ( $opt->{'cust_location'} &&
1751 ( ! $opt->{'locationnum'} || $opt->{'locationnum'} == -1 ) ) {
1752 $error = $opt->{'cust_location'}->insert;
1754 $dbh->rollback if $oldAutoCommit;
1755 return "inserting cust_location (transaction rolled back): $error";
1757 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1760 my $unused_credit = 0;
1761 my $keep_dates = $opt->{'keep_dates'};
1762 # Special case. If the pkgpart is changing, and the customer is
1763 # going to be credited for remaining time, don't keep setup, bill,
1764 # or last_bill dates, and DO pass the flag to cancel() to credit
1766 if ( $opt->{'pkgpart'}
1767 and $opt->{'pkgpart'} != $self->pkgpart
1768 and $self->part_pkg->option('unused_credit_change', 1) ) {
1771 $hash{$_} = '' foreach qw(setup bill last_bill);
1774 if ( $keep_dates ) {
1775 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1776 resume start_date contract_end ) ) {
1777 $hash{$date} = $self->getfield($date);
1780 # allow $opt->{'locationnum'} = '' to specifically set it to null
1781 # (i.e. customer default location)
1782 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
1784 # usually this doesn't matter. the two cases where it does are:
1785 # 1. unused_credit_change + pkgpart change + setup fee on the new package
1787 # 2. (more importantly) changing a package before it's billed
1788 $hash{'waive_setup'} = $self->waive_setup;
1790 # Create the new package.
1791 my $cust_pkg = new FS::cust_pkg {
1792 custnum => $self->custnum,
1793 pkgpart => ( $opt->{'pkgpart'} || $self->pkgpart ),
1794 refnum => ( $opt->{'refnum'} || $self->refnum ),
1795 locationnum => ( $opt->{'locationnum'} ),
1798 $error = $cust_pkg->insert( 'change' => 1 );
1800 $dbh->rollback if $oldAutoCommit;
1804 # Transfer services and cancel old package.
1806 $error = $self->transfer($cust_pkg);
1807 if ($error and $error == 0) {
1808 # $old_pkg->transfer failed.
1809 $dbh->rollback if $oldAutoCommit;
1813 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
1814 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
1815 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
1816 if ($error and $error == 0) {
1817 # $old_pkg->transfer failed.
1818 $dbh->rollback if $oldAutoCommit;
1824 # Transfers were successful, but we still had services left on the old
1825 # package. We can't change the package under this circumstances, so abort.
1826 $dbh->rollback if $oldAutoCommit;
1827 return "Unable to transfer all services from package ". $self->pkgnum;
1830 #reset usage if changing pkgpart
1831 # AND usage rollover is off (otherwise adds twice, now and at package bill)
1832 if ($self->pkgpart != $cust_pkg->pkgpart) {
1833 my $part_pkg = $cust_pkg->part_pkg;
1834 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
1838 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
1841 $dbh->rollback if $oldAutoCommit;
1842 return "Error setting usage values: $error";
1845 # if NOT changing pkgpart, transfer any usage pools over
1846 foreach my $usage ($self->cust_pkg_usage) {
1847 $usage->set('pkgnum', $cust_pkg->pkgnum);
1848 $error = $usage->replace;
1850 $dbh->rollback if $oldAutoCommit;
1851 return "Error transferring usage pools: $error";
1856 # Order any supplemental packages.
1857 my $part_pkg = $cust_pkg->part_pkg;
1858 my @old_supp_pkgs = $self->supplemental_pkgs;
1860 foreach my $link ($part_pkg->supp_part_pkg_link) {
1862 foreach (@old_supp_pkgs) {
1863 if ($_->pkgpart == $link->dst_pkgpart) {
1865 $_->pkgpart(0); # so that it can't match more than once
1869 # false laziness with FS::cust_main::Packages::order_pkg
1870 my $new = FS::cust_pkg->new({
1871 pkgpart => $link->dst_pkgpart,
1872 pkglinknum => $link->pkglinknum,
1873 custnum => $self->custnum,
1874 main_pkgnum => $cust_pkg->pkgnum,
1875 locationnum => $cust_pkg->locationnum,
1876 start_date => $cust_pkg->start_date,
1877 order_date => $cust_pkg->order_date,
1878 expire => $cust_pkg->expire,
1879 adjourn => $cust_pkg->adjourn,
1880 contract_end => $cust_pkg->contract_end,
1881 refnum => $cust_pkg->refnum,
1882 discountnum => $cust_pkg->discountnum,
1883 waive_setup => $cust_pkg->waive_setup
1885 if ( $old and $opt->{'keep_dates'} ) {
1886 foreach (qw(setup bill last_bill)) {
1887 $new->set($_, $old->get($_));
1890 $error = $new->insert;
1893 $error ||= $old->transfer($new);
1895 if ( $error and $error > 0 ) {
1896 # no reason why this should ever fail, but still...
1897 $error = "Unable to transfer all services from supplemental package ".
1901 $dbh->rollback if $oldAutoCommit;
1904 push @new_supp_pkgs, $new;
1907 #Good to go, cancel old package. Notify 'cancel' of whether to credit
1909 #Don't allow billing the package (preceding period packages and/or
1910 #outstanding usage) if we are keeping dates (i.e. location changing),
1911 #because the new package will be billed for the same date range.
1912 #Supplemental packages are also canceled here.
1913 $error = $self->cancel(
1915 unused_credit => $unused_credit,
1916 nobill => $keep_dates
1919 $dbh->rollback if $oldAutoCommit;
1923 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
1925 my $error = $cust_pkg->cust_main->bill(
1926 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
1929 $dbh->rollback if $oldAutoCommit;
1934 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1940 =item set_quantity QUANTITY
1942 Change the package's quantity field. This is the one package property
1943 that can safely be changed without canceling and reordering the package
1944 (because it doesn't affect tax eligibility). Returns an error or an
1951 $self = $self->replace_old; # just to make sure
1953 ($qty =~ /^\d+$/ and $qty > 0) or return "bad package quantity $qty";
1954 $self->set('quantity' => $qty);
1958 use Storable 'thaw';
1960 sub process_bulk_cust_pkg {
1962 my $param = thaw(decode_base64(shift));
1963 warn Dumper($param) if $DEBUG;
1965 my $old_part_pkg = qsearchs('part_pkg',
1966 { pkgpart => $param->{'old_pkgpart'} });
1967 my $new_part_pkg = qsearchs('part_pkg',
1968 { pkgpart => $param->{'new_pkgpart'} });
1969 die "Must select a new package type\n" unless $new_part_pkg;
1970 #my $keep_dates = $param->{'keep_dates'} || 0;
1971 my $keep_dates = 1; # there is no good reason to turn this off
1973 local $SIG{HUP} = 'IGNORE';
1974 local $SIG{INT} = 'IGNORE';
1975 local $SIG{QUIT} = 'IGNORE';
1976 local $SIG{TERM} = 'IGNORE';
1977 local $SIG{TSTP} = 'IGNORE';
1978 local $SIG{PIPE} = 'IGNORE';
1980 my $oldAutoCommit = $FS::UID::AutoCommit;
1981 local $FS::UID::AutoCommit = 0;
1984 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
1987 foreach my $old_cust_pkg ( @cust_pkgs ) {
1989 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
1990 if ( $old_cust_pkg->getfield('cancel') ) {
1991 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
1992 $old_cust_pkg->pkgnum."\n"
1996 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
1998 my $error = $old_cust_pkg->change(
1999 'pkgpart' => $param->{'new_pkgpart'},
2000 'keep_dates' => $keep_dates
2002 if ( !ref($error) ) { # change returns the cust_pkg on success
2004 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
2007 $dbh->commit if $oldAutoCommit;
2013 Returns the last bill date, or if there is no last bill date, the setup date.
2014 Useful for billing metered services.
2020 return $self->setfield('last_bill', $_[0]) if @_;
2021 return $self->getfield('last_bill') if $self->getfield('last_bill');
2022 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
2023 'edate' => $self->bill, } );
2024 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
2027 =item last_cust_pkg_reason ACTION
2029 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
2030 Returns false if there is no reason or the package is not currenly ACTION'd
2031 ACTION is one of adjourn, susp, cancel, or expire.
2035 sub last_cust_pkg_reason {
2036 my ( $self, $action ) = ( shift, shift );
2037 my $date = $self->get($action);
2039 'table' => 'cust_pkg_reason',
2040 'hashref' => { 'pkgnum' => $self->pkgnum,
2041 'action' => substr(uc($action), 0, 1),
2044 'order_by' => 'ORDER BY num DESC LIMIT 1',
2048 =item last_reason ACTION
2050 Returns the most recent ACTION FS::reason associated with the package.
2051 Returns false if there is no reason or the package is not currenly ACTION'd
2052 ACTION is one of adjourn, susp, cancel, or expire.
2057 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
2058 $cust_pkg_reason->reason
2059 if $cust_pkg_reason;
2064 Returns the definition for this billing item, as an FS::part_pkg object (see
2071 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
2072 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
2073 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
2078 Returns the cancelled package this package was changed from, if any.
2084 return '' unless $self->change_pkgnum;
2085 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
2090 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
2097 $self->part_pkg->calc_setup($self, @_);
2102 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
2109 $self->part_pkg->calc_recur($self, @_);
2114 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
2121 $self->part_pkg->base_recur($self, @_);
2126 Calls the I<calc_remain> of the FS::part_pkg object associated with this
2133 $self->part_pkg->calc_remain($self, @_);
2138 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
2145 $self->part_pkg->calc_cancel($self, @_);
2150 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
2156 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
2159 =item cust_pkg_detail [ DETAILTYPE ]
2161 Returns any customer package details for this package (see
2162 L<FS::cust_pkg_detail>).
2164 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2168 sub cust_pkg_detail {
2170 my %hash = ( 'pkgnum' => $self->pkgnum );
2171 $hash{detailtype} = shift if @_;
2173 'table' => 'cust_pkg_detail',
2174 'hashref' => \%hash,
2175 'order_by' => 'ORDER BY weight, pkgdetailnum',
2179 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
2181 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
2183 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2185 If there is an error, returns the error, otherwise returns false.
2189 sub set_cust_pkg_detail {
2190 my( $self, $detailtype, @details ) = @_;
2192 local $SIG{HUP} = 'IGNORE';
2193 local $SIG{INT} = 'IGNORE';
2194 local $SIG{QUIT} = 'IGNORE';
2195 local $SIG{TERM} = 'IGNORE';
2196 local $SIG{TSTP} = 'IGNORE';
2197 local $SIG{PIPE} = 'IGNORE';
2199 my $oldAutoCommit = $FS::UID::AutoCommit;
2200 local $FS::UID::AutoCommit = 0;
2203 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
2204 my $error = $current->delete;
2206 $dbh->rollback if $oldAutoCommit;
2207 return "error removing old detail: $error";
2211 foreach my $detail ( @details ) {
2212 my $cust_pkg_detail = new FS::cust_pkg_detail {
2213 'pkgnum' => $self->pkgnum,
2214 'detailtype' => $detailtype,
2215 'detail' => $detail,
2217 my $error = $cust_pkg_detail->insert;
2219 $dbh->rollback if $oldAutoCommit;
2220 return "error adding new detail: $error";
2225 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2232 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
2236 #false laziness w/cust_bill.pm
2240 'table' => 'cust_event',
2241 'addl_from' => 'JOIN part_event USING ( eventpart )',
2242 'hashref' => { 'tablenum' => $self->pkgnum },
2243 'extra_sql' => " AND eventtable = 'cust_pkg' ",
2247 =item num_cust_event
2249 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
2253 #false laziness w/cust_bill.pm
2254 sub num_cust_event {
2257 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
2258 " WHERE tablenum = ? AND eventtable = 'cust_pkg'";
2259 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
2260 $sth->execute($self->pkgnum) or die $sth->errstr. " executing $sql";
2261 $sth->fetchrow_arrayref->[0];
2264 =item cust_svc [ SVCPART ] (old, deprecated usage)
2266 =item cust_svc [ OPTION => VALUE ... ] (current usage)
2268 Returns the services for this package, as FS::cust_svc objects (see
2269 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
2270 spcififed, returns only the matching services.
2277 return () unless $self->num_cust_svc(@_);
2280 if ( @_ && $_[0] =~ /^\d+/ ) {
2281 $opt{svcpart} = shift;
2282 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2289 'table' => 'cust_svc',
2290 'hashref' => { 'pkgnum' => $self->pkgnum },
2292 if ( $opt{svcpart} ) {
2293 $search{hashref}->{svcpart} = $opt{'svcpart'};
2295 if ( $opt{'svcdb'} ) {
2296 $search{addl_from} = ' LEFT JOIN part_svc USING ( svcpart ) ';
2297 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{'svcdb'} );
2300 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
2302 #if ( $self->{'_svcnum'} ) {
2303 # values %{ $self->{'_svcnum'}->cache };
2305 $self->_sort_cust_svc( [ qsearch(\%search) ] );
2310 =item overlimit [ SVCPART ]
2312 Returns the services for this package which have exceeded their
2313 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
2314 is specified, return only the matching services.
2320 return () unless $self->num_cust_svc(@_);
2321 grep { $_->overlimit } $self->cust_svc(@_);
2324 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2326 Returns historical services for this package created before END TIMESTAMP and
2327 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
2328 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
2329 I<pkg_svc.hidden> flag will be omitted.
2335 warn "$me _h_cust_svc called on $self\n"
2338 my ($end, $start, $mode) = @_;
2339 my @cust_svc = $self->_sort_cust_svc(
2340 [ qsearch( 'h_cust_svc',
2341 { 'pkgnum' => $self->pkgnum, },
2342 FS::h_cust_svc->sql_h_search(@_),
2345 if ( defined($mode) && $mode eq 'I' ) {
2346 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
2347 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
2353 sub _sort_cust_svc {
2354 my( $self, $arrayref ) = @_;
2357 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
2362 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $self->pkgpart,
2363 'svcpart' => $_->svcpart } );
2365 $pkg_svc ? $pkg_svc->primary_svc : '',
2366 $pkg_svc ? $pkg_svc->quantity : 0,
2373 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
2375 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
2377 Returns the number of services for this package. Available options are svcpart
2378 and svcdb. If either is spcififed, returns only the matching services.
2385 return $self->{'_num_cust_svc'}
2387 && exists($self->{'_num_cust_svc'})
2388 && $self->{'_num_cust_svc'} =~ /\d/;
2390 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
2394 if ( @_ && $_[0] =~ /^\d+/ ) {
2395 $opt{svcpart} = shift;
2396 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2402 my $select = 'SELECT COUNT(*) FROM cust_svc ';
2403 my $where = ' WHERE pkgnum = ? ';
2404 my @param = ($self->pkgnum);
2406 if ( $opt{'svcpart'} ) {
2407 $where .= ' AND svcpart = ? ';
2408 push @param, $opt{'svcpart'};
2410 if ( $opt{'svcdb'} ) {
2411 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
2412 $where .= ' AND svcdb = ? ';
2413 push @param, $opt{'svcdb'};
2416 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
2417 $sth->execute(@param) or die $sth->errstr;
2418 $sth->fetchrow_arrayref->[0];
2421 =item available_part_svc
2423 Returns a list of FS::part_svc objects representing services included in this
2424 package but not yet provisioned. Each FS::part_svc object also has an extra
2425 field, I<num_avail>, which specifies the number of available services.
2429 sub available_part_svc {
2432 my $pkg_quantity = $self->quantity || 1;
2434 grep { $_->num_avail > 0 }
2436 my $part_svc = $_->part_svc;
2437 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
2438 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
2440 # more evil encapsulation breakage
2441 if($part_svc->{'Hash'}{'num_avail'} > 0) {
2442 my @exports = $part_svc->part_export_did;
2443 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
2448 $self->part_pkg->pkg_svc;
2451 =item part_svc [ OPTION => VALUE ... ]
2453 Returns a list of FS::part_svc objects representing provisioned and available
2454 services included in this package. Each FS::part_svc object also has the
2455 following extra fields:
2459 =item num_cust_svc (count)
2461 =item num_avail (quantity - count)
2463 =item cust_pkg_svc (services) - array reference containing the provisioned services, as cust_svc objects
2467 Accepts one option: summarize_size. If specified and non-zero, will omit the
2468 extra cust_pkg_svc option for objects where num_cust_svc is this size or
2474 #label -> ($cust_svc->label)[1]
2480 my $pkg_quantity = $self->quantity || 1;
2482 #XXX some sort of sort order besides numeric by svcpart...
2483 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
2485 my $part_svc = $pkg_svc->part_svc;
2486 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
2487 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
2488 $part_svc->{'Hash'}{'num_avail'} =
2489 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
2490 $part_svc->{'Hash'}{'cust_pkg_svc'} =
2491 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
2492 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
2493 && $num_cust_svc >= $opt{summarize_size};
2494 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
2496 } $self->part_pkg->pkg_svc;
2499 push @part_svc, map {
2501 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
2502 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
2503 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
2504 $part_svc->{'Hash'}{'cust_pkg_svc'} =
2505 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
2507 } $self->extra_part_svc;
2513 =item extra_part_svc
2515 Returns a list of FS::part_svc objects corresponding to services in this
2516 package which are still provisioned but not (any longer) available in the
2521 sub extra_part_svc {
2524 my $pkgnum = $self->pkgnum;
2525 #my $pkgpart = $self->pkgpart;
2528 # 'table' => 'part_svc',
2531 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
2532 # WHERE pkg_svc.svcpart = part_svc.svcpart
2533 # AND pkg_svc.pkgpart = ?
2536 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
2537 # LEFT JOIN cust_pkg USING ( pkgnum )
2538 # WHERE cust_svc.svcpart = part_svc.svcpart
2541 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
2544 #seems to benchmark slightly faster... (or did?)
2546 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
2547 my $pkgparts = join(',', @pkgparts);
2550 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
2551 #MySQL doesn't grok DISINCT ON
2552 'select' => 'DISTINCT part_svc.*',
2553 'table' => 'part_svc',
2555 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
2556 AND pkg_svc.pkgpart IN ($pkgparts)
2559 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
2560 LEFT JOIN cust_pkg USING ( pkgnum )
2563 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
2564 'extra_param' => [ [$self->pkgnum=>'int'] ],
2570 Returns a short status string for this package, currently:
2574 =item not yet billed
2576 =item one-time charge
2591 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
2593 return 'cancelled' if $self->get('cancel');
2594 return 'suspended' if $self->susp;
2595 return 'not yet billed' unless $self->setup;
2596 return 'one-time charge' if $freq =~ /^(0|$)/;
2600 =item ucfirst_status
2602 Returns the status with the first character capitalized.
2606 sub ucfirst_status {
2607 ucfirst(shift->status);
2612 Class method that returns the list of possible status strings for packages
2613 (see L<the status method|/status>). For example:
2615 @statuses = FS::cust_pkg->statuses();
2619 tie my %statuscolor, 'Tie::IxHash',
2620 'not yet billed' => '009999', #teal? cyan?
2621 'one-time charge' => '000000',
2622 'active' => '00CC00',
2623 'suspended' => 'FF9900',
2624 'cancelled' => 'FF0000',
2628 my $self = shift; #could be class...
2629 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
2630 # # mayble split btw one-time vs. recur
2636 Returns a hex triplet color string for this package's status.
2642 $statuscolor{$self->status};
2647 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
2648 "pkg-comment" depending on user preference).
2654 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
2655 $label = $self->pkgnum. ": $label"
2656 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
2660 =item pkg_label_long
2662 Returns a long label for this package, adding the primary service's label to
2667 sub pkg_label_long {
2669 my $label = $self->pkg_label;
2670 my $cust_svc = $self->primary_cust_svc;
2671 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
2675 =item primary_cust_svc
2677 Returns a primary service (as FS::cust_svc object) if one can be identified.
2681 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
2683 sub primary_cust_svc {
2686 my @cust_svc = $self->cust_svc;
2688 return '' unless @cust_svc; #no serivces - irrelevant then
2690 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
2692 # primary service as specified in the package definition
2693 # or exactly one service definition with quantity one
2694 my $svcpart = $self->part_pkg->svcpart;
2695 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
2696 return $cust_svc[0] if scalar(@cust_svc) == 1;
2698 #couldn't identify one thing..
2704 Returns a list of lists, calling the label method for all services
2705 (see L<FS::cust_svc>) of this billing item.
2711 map { [ $_->label ] } $self->cust_svc;
2714 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2716 Like the labels method, but returns historical information on services that
2717 were active as of END_TIMESTAMP and (optionally) not cancelled before
2718 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
2719 I<pkg_svc.hidden> flag will be omitted.
2721 Returns a list of lists, calling the label method for all (historical) services
2722 (see L<FS::h_cust_svc>) of this billing item.
2728 warn "$me _h_labels called on $self\n"
2730 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
2735 Like labels, except returns a simple flat list, and shortens long
2736 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2737 identical services to one line that lists the service label and the number of
2738 individual services rather than individual items.
2743 shift->_labels_short( 'labels', @_ );
2746 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
2748 Like h_labels, except returns a simple flat list, and shortens long
2749 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2750 identical services to one line that lists the service label and the number of
2751 individual services rather than individual items.
2755 sub h_labels_short {
2756 shift->_labels_short( 'h_labels', @_ );
2760 my( $self, $method ) = ( shift, shift );
2762 warn "$me _labels_short called on $self with $method method\n"
2765 my $conf = new FS::Conf;
2766 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
2768 warn "$me _labels_short populating \%labels\n"
2772 #tie %labels, 'Tie::IxHash';
2773 push @{ $labels{$_->[0]} }, $_->[1]
2774 foreach $self->$method(@_);
2776 warn "$me _labels_short populating \@labels\n"
2780 foreach my $label ( keys %labels ) {
2782 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
2783 my $num = scalar(@values);
2784 warn "$me _labels_short $num items for $label\n"
2787 if ( $num > $max_same_services ) {
2788 warn "$me _labels_short more than $max_same_services, so summarizing\n"
2790 push @labels, "$label ($num)";
2792 if ( $conf->exists('cust_bill-consolidate_services') ) {
2793 warn "$me _labels_short consolidating services\n"
2795 # push @labels, "$label: ". join(', ', @values);
2797 my $detail = "$label: ";
2798 $detail .= shift(@values). ', '
2800 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
2802 push @labels, $detail;
2804 warn "$me _labels_short done consolidating services\n"
2807 warn "$me _labels_short adding service data\n"
2809 push @labels, map { "$label: $_" } @values;
2820 Returns the parent customer object (see L<FS::cust_main>).
2826 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
2831 Returns the balance for this specific package, when using
2832 experimental package balance.
2838 $self->cust_main->balance_pkgnum( $self->pkgnum );
2841 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
2845 Returns the location object, if any (see L<FS::cust_location>).
2847 =item cust_location_or_main
2849 If this package is associated with a location, returns the locaiton (see
2850 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
2852 =item location_label [ OPTION => VALUE ... ]
2854 Returns the label of the location object (see L<FS::cust_location>).
2858 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
2860 =item tax_locationnum
2862 Returns the foreign key to a L<FS::cust_location> object for calculating
2863 tax on this package, as determined by the C<tax-pkg_address> and
2864 C<tax-ship_address> configuration flags.
2868 sub tax_locationnum {
2870 my $conf = FS::Conf->new;
2871 if ( $conf->exists('tax-pkg_address') ) {
2872 return $self->locationnum;
2874 elsif ( $conf->exists('tax-ship_address') ) {
2875 return $self->cust_main->ship_locationnum;
2878 return $self->cust_main->bill_locationnum;
2884 Returns the L<FS::cust_location> object for tax_locationnum.
2890 FS::cust_location->by_key( $self->tax_locationnum )
2893 =item seconds_since TIMESTAMP
2895 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
2896 package have been online since TIMESTAMP, according to the session monitor.
2898 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
2899 L<Time::Local> and L<Date::Parse> for conversion functions.
2904 my($self, $since) = @_;
2907 foreach my $cust_svc (
2908 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
2910 $seconds += $cust_svc->seconds_since($since);
2917 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
2919 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
2920 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
2923 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2924 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2930 sub seconds_since_sqlradacct {
2931 my($self, $start, $end) = @_;
2935 foreach my $cust_svc (
2937 my $part_svc = $_->part_svc;
2938 $part_svc->svcdb eq 'svc_acct'
2939 && scalar($part_svc->part_export_usage);
2942 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
2949 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
2951 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
2952 in this package for sessions ending between TIMESTAMP_START (inclusive) and
2956 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
2957 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
2962 sub attribute_since_sqlradacct {
2963 my($self, $start, $end, $attrib) = @_;
2967 foreach my $cust_svc (
2969 my $part_svc = $_->part_svc;
2970 $part_svc->svcdb eq 'svc_acct'
2971 && scalar($part_svc->part_export_usage);
2974 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
2986 my( $self, $value ) = @_;
2987 if ( defined($value) ) {
2988 $self->setfield('quantity', $value);
2990 $self->getfield('quantity') || 1;
2993 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
2995 Transfers as many services as possible from this package to another package.
2997 The destination package can be specified by pkgnum by passing an FS::cust_pkg
2998 object. The destination package must already exist.
3000 Services are moved only if the destination allows services with the correct
3001 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
3002 this option with caution! No provision is made for export differences
3003 between the old and new service definitions. Probably only should be used
3004 when your exports for all service definitions of a given svcdb are identical.
3005 (attempt a transfer without it first, to move all possible svcpart-matching
3008 Any services that can't be moved remain in the original package.
3010 Returns an error, if there is one; otherwise, returns the number of services
3011 that couldn't be moved.
3016 my ($self, $dest_pkgnum, %opt) = @_;
3022 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
3023 $dest = $dest_pkgnum;
3024 $dest_pkgnum = $dest->pkgnum;
3026 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
3029 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
3031 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
3032 $target{$pkg_svc->svcpart} = $pkg_svc->quantity;
3035 foreach my $cust_svc ($dest->cust_svc) {
3036 $target{$cust_svc->svcpart}--;
3039 my %svcpart2svcparts = ();
3040 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3041 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
3042 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
3043 next if exists $svcpart2svcparts{$svcpart};
3044 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
3045 $svcpart2svcparts{$svcpart} = [
3047 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
3049 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
3050 'svcpart' => $_ } );
3052 $pkg_svc ? $pkg_svc->primary_svc : '',
3053 $pkg_svc ? $pkg_svc->quantity : 0,
3057 grep { $_ != $svcpart }
3059 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
3061 warn "alternates for svcpart $svcpart: ".
3062 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
3067 foreach my $cust_svc ($self->cust_svc) {
3068 if($target{$cust_svc->svcpart} > 0
3069 or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
3070 $target{$cust_svc->svcpart}--;
3071 my $new = new FS::cust_svc { $cust_svc->hash };
3072 $new->pkgnum($dest_pkgnum);
3073 my $error = $new->replace($cust_svc);
3074 return $error if $error;
3075 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3077 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
3078 warn "alternates to consider: ".
3079 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
3081 my @alternate = grep {
3082 warn "considering alternate svcpart $_: ".
3083 "$target{$_} available in new package\n"
3086 } @{$svcpart2svcparts{$cust_svc->svcpart}};
3088 warn "alternate(s) found\n" if $DEBUG;
3089 my $change_svcpart = $alternate[0];
3090 $target{$change_svcpart}--;
3091 my $new = new FS::cust_svc { $cust_svc->hash };
3092 $new->svcpart($change_svcpart);
3093 $new->pkgnum($dest_pkgnum);
3094 my $error = $new->replace($cust_svc);
3095 return $error if $error;
3108 This method is deprecated. See the I<depend_jobnum> option to the insert and
3109 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
3116 local $SIG{HUP} = 'IGNORE';
3117 local $SIG{INT} = 'IGNORE';
3118 local $SIG{QUIT} = 'IGNORE';
3119 local $SIG{TERM} = 'IGNORE';
3120 local $SIG{TSTP} = 'IGNORE';
3121 local $SIG{PIPE} = 'IGNORE';
3123 my $oldAutoCommit = $FS::UID::AutoCommit;
3124 local $FS::UID::AutoCommit = 0;
3127 foreach my $cust_svc ( $self->cust_svc ) {
3128 #false laziness w/svc_Common::insert
3129 my $svc_x = $cust_svc->svc_x;
3130 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
3131 my $error = $part_export->export_insert($svc_x);
3133 $dbh->rollback if $oldAutoCommit;
3139 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3146 Associates this package with a (suspension or cancellation) reason (see
3147 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
3150 Available options are:
3156 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.
3160 the access_user (see L<FS::access_user>) providing the reason
3168 the action (cancel, susp, adjourn, expire) associated with the reason
3172 If there is an error, returns the error, otherwise returns false.
3177 my ($self, %options) = @_;
3179 my $otaker = $options{reason_otaker} ||
3180 $FS::CurrentUser::CurrentUser->username;
3183 if ( $options{'reason'} =~ /^(\d+)$/ ) {
3187 } elsif ( ref($options{'reason'}) ) {
3189 return 'Enter a new reason (or select an existing one)'
3190 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
3192 my $reason = new FS::reason({
3193 'reason_type' => $options{'reason'}->{'typenum'},
3194 'reason' => $options{'reason'}->{'reason'},
3196 my $error = $reason->insert;
3197 return $error if $error;
3199 $reasonnum = $reason->reasonnum;
3202 return "Unparsable reason: ". $options{'reason'};
3205 my $cust_pkg_reason =
3206 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
3207 'reasonnum' => $reasonnum,
3208 'otaker' => $otaker,
3209 'action' => substr(uc($options{'action'}),0,1),
3210 'date' => $options{'date'}
3215 $cust_pkg_reason->insert;
3218 =item insert_discount
3220 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
3221 inserting a new discount on the fly (see L<FS::discount>).
3223 Available options are:
3231 If there is an error, returns the error, otherwise returns false.
3235 sub insert_discount {
3236 #my ($self, %options) = @_;
3239 my $cust_pkg_discount = new FS::cust_pkg_discount {
3240 'pkgnum' => $self->pkgnum,
3241 'discountnum' => $self->discountnum,
3243 'end_date' => '', #XXX
3244 #for the create a new discount case
3245 '_type' => $self->discountnum__type,
3246 'amount' => $self->discountnum_amount,
3247 'percent' => $self->discountnum_percent,
3248 'months' => $self->discountnum_months,
3249 'setup' => $self->discountnum_setup,
3250 #'disabled' => $self->discountnum_disabled,
3253 $cust_pkg_discount->insert;
3256 =item set_usage USAGE_VALUE_HASHREF
3258 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
3259 to which they should be set (see L<FS::svc_acct>). Currently seconds,
3260 upbytes, downbytes, and totalbytes are appropriate keys.
3262 All svc_accts which are part of this package have their values reset.
3267 my ($self, $valueref, %opt) = @_;
3269 #only svc_acct can set_usage for now
3270 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
3271 my $svc_x = $cust_svc->svc_x;
3272 $svc_x->set_usage($valueref, %opt)
3273 if $svc_x->can("set_usage");
3277 =item recharge USAGE_VALUE_HASHREF
3279 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
3280 to which they should be set (see L<FS::svc_acct>). Currently seconds,
3281 upbytes, downbytes, and totalbytes are appropriate keys.
3283 All svc_accts which are part of this package have their values incremented.
3288 my ($self, $valueref) = @_;
3290 #only svc_acct can set_usage for now
3291 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
3292 my $svc_x = $cust_svc->svc_x;
3293 $svc_x->recharge($valueref)
3294 if $svc_x->can("recharge");
3298 =item cust_pkg_discount
3302 sub cust_pkg_discount {
3304 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
3307 =item cust_pkg_discount_active
3311 sub cust_pkg_discount_active {
3313 grep { $_->status eq 'active' } $self->cust_pkg_discount;
3316 =item cust_pkg_usage
3318 Returns a list of all voice usage counters attached to this package.
3322 sub cust_pkg_usage {
3324 qsearch('cust_pkg_usage', { pkgnum => $self->pkgnum });
3327 =item apply_usage OPTIONS
3329 Takes the following options:
3330 - cdr: a call detail record (L<FS::cdr>)
3331 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
3332 - minutes: the maximum number of minutes to be charged
3334 Finds available usage minutes for a call of this class, and subtracts
3335 up to that many minutes from the usage pool. If the usage pool is empty,
3336 and the C<cdr-minutes_priority> global config option is set, minutes may
3337 be taken from other calls as well. Either way, an allocation record will
3338 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
3339 number of minutes of usage applied to the call.
3344 my ($self, %opt) = @_;
3345 my $cdr = $opt{cdr};
3346 my $rate_detail = $opt{rate_detail};
3347 my $minutes = $opt{minutes};
3348 my $classnum = $rate_detail->classnum;
3349 my $pkgnum = $self->pkgnum;
3350 my $custnum = $self->custnum;
3352 local $SIG{HUP} = 'IGNORE';
3353 local $SIG{INT} = 'IGNORE';
3354 local $SIG{QUIT} = 'IGNORE';
3355 local $SIG{TERM} = 'IGNORE';
3356 local $SIG{TSTP} = 'IGNORE';
3357 local $SIG{PIPE} = 'IGNORE';
3359 my $oldAutoCommit = $FS::UID::AutoCommit;
3360 local $FS::UID::AutoCommit = 0;
3362 my $order = FS::Conf->new->config('cdr-minutes_priority');
3366 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
3368 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
3370 my @usage_recs = qsearch({
3371 'table' => 'cust_pkg_usage',
3372 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
3373 ' JOIN cust_pkg USING (pkgnum)'.
3374 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
3375 'select' => 'cust_pkg_usage.*',
3376 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
3377 " ( cust_pkg.custnum = $custnum AND ".
3378 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
3379 $is_classnum . ' AND '.
3380 " cust_pkg_usage.minutes > 0",
3381 'order_by' => " ORDER BY priority ASC",
3384 my $orig_minutes = $minutes;
3386 while (!$error and $minutes > 0 and @usage_recs) {
3387 my $cust_pkg_usage = shift @usage_recs;
3388 $cust_pkg_usage->select_for_update;
3389 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
3390 pkgusagenum => $cust_pkg_usage->pkgusagenum,
3391 acctid => $cdr->acctid,
3392 minutes => min($cust_pkg_usage->minutes, $minutes),
3394 $cust_pkg_usage->set('minutes',
3395 sprintf('%.0f', $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes)
3397 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
3398 $minutes -= $cdr_cust_pkg_usage->minutes;
3400 if ( $order and $minutes > 0 and !$error ) {
3401 # then try to steal minutes from another call
3403 'table' => 'cdr_cust_pkg_usage',
3404 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
3405 ' JOIN part_pkg_usage USING (pkgusagepart)'.
3406 ' JOIN cust_pkg USING (pkgnum)'.
3407 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
3408 ' JOIN cdr USING (acctid)',
3409 'select' => 'cdr_cust_pkg_usage.*',
3410 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
3411 " ( cust_pkg.pkgnum = $pkgnum OR ".
3412 " ( cust_pkg.custnum = $custnum AND ".
3413 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
3414 " part_pkg_usage_class.classnum = $classnum",
3415 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
3417 if ( $order eq 'time' ) {
3418 # find CDRs that are using minutes, but have a later startdate
3420 my $startdate = $cdr->startdate;
3421 if ($startdate !~ /^\d+$/) {
3422 die "bad cdr startdate '$startdate'";
3424 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
3425 # minimize needless reshuffling
3426 $search{'order_by'} .= ', cdr.startdate DESC';
3428 # XXX may not work correctly with rate_time schedules. Could
3429 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
3431 $search{'addl_from'} .=
3432 ' JOIN rate_detail'.
3433 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
3434 if ( $order eq 'rate_high' ) {
3435 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
3436 $rate_detail->min_charge;
3437 $search{'order_by'} .= ', rate_detail.min_charge ASC';
3438 } elsif ( $order eq 'rate_low' ) {
3439 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
3440 $rate_detail->min_charge;
3441 $search{'order_by'} .= ', rate_detail.min_charge DESC';
3443 # this should really never happen
3444 die "invalid cdr-minutes_priority value '$order'\n";
3447 my @cdr_usage_recs = qsearch(\%search);
3449 while (!$error and @cdr_usage_recs and $minutes > 0) {
3450 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
3451 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
3452 my $old_cdr = $cdr_cust_pkg_usage->cdr;
3453 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
3454 $cdr_cust_pkg_usage->select_for_update;
3455 $old_cdr->select_for_update;
3456 $cust_pkg_usage->select_for_update;
3457 # in case someone else stole the usage from this CDR
3458 # while waiting for the lock...
3459 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
3460 # steal the usage allocation and flag the old CDR for reprocessing
3461 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
3462 # if the allocation is more minutes than we need, adjust it...
3463 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
3465 $cdr_cust_pkg_usage->set('minutes', $minutes);
3466 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
3467 $error = $cust_pkg_usage->replace;
3469 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
3470 $error ||= $cdr_cust_pkg_usage->replace;
3471 # deduct the stolen minutes
3472 $minutes -= $cdr_cust_pkg_usage->minutes;
3474 # after all minute-stealing is done, reset the affected CDRs
3475 foreach (values %reproc_cdrs) {
3476 $error ||= $_->set_status('');
3477 # XXX or should we just call $cdr->rate right here?
3478 # it's not like we can create a loop this way, since the min_charge
3479 # or call time has to go monotonically in one direction.
3480 # we COULD get some very deep recursions going, though...
3482 } # if $order and $minutes
3485 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
3487 $dbh->commit if $oldAutoCommit;
3488 return $orig_minutes - $minutes;
3492 =item supplemental_pkgs
3494 Returns a list of all packages supplemental to this one.
3498 sub supplemental_pkgs {
3500 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
3505 Returns the package that this one is supplemental to, if any.
3511 if ( $self->main_pkgnum ) {
3512 return FS::cust_pkg->by_key($self->main_pkgnum);
3519 =head1 CLASS METHODS
3525 Returns an SQL expression identifying recurring packages.
3529 sub recurring_sql { "
3530 '0' != ( select freq from part_pkg
3531 where cust_pkg.pkgpart = part_pkg.pkgpart )
3536 Returns an SQL expression identifying one-time packages.
3541 '0' = ( select freq from part_pkg
3542 where cust_pkg.pkgpart = part_pkg.pkgpart )
3547 Returns an SQL expression identifying ordered packages (recurring packages not
3553 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
3558 Returns an SQL expression identifying active packages.
3563 $_[0]->recurring_sql. "
3564 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
3565 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3566 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
3569 =item not_yet_billed_sql
3571 Returns an SQL expression identifying packages which have not yet been billed.
3575 sub not_yet_billed_sql { "
3576 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
3577 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3578 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
3583 Returns an SQL expression identifying inactive packages (one-time packages
3584 that are otherwise unsuspended/uncancelled).
3588 sub inactive_sql { "
3589 ". $_[0]->onetime_sql(). "
3590 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
3591 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3592 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
3598 Returns an SQL expression identifying suspended packages.
3602 sub suspended_sql { susp_sql(@_); }
3604 #$_[0]->recurring_sql(). ' AND '.
3606 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3607 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
3614 Returns an SQL exprression identifying cancelled packages.
3618 sub cancelled_sql { cancel_sql(@_); }
3620 #$_[0]->recurring_sql(). ' AND '.
3621 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
3626 Returns an SQL expression to give the package status as a string.
3632 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
3633 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
3634 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
3635 WHEN ".onetime_sql()." THEN 'one-time charge'
3640 =item search HASHREF
3644 Returns a qsearch hash expression to search for parameters specified in HASHREF.
3645 Valid parameters are
3653 active, inactive, suspended, cancel (or cancelled)
3657 active, inactive, suspended, one-time charge, inactive, cancel (or cancelled)
3661 boolean selects custom packages
3667 pkgpart or arrayref or hashref of pkgparts
3671 arrayref of beginning and ending epoch date
3675 arrayref of beginning and ending epoch date
3679 arrayref of beginning and ending epoch date
3683 arrayref of beginning and ending epoch date
3687 arrayref of beginning and ending epoch date
3691 arrayref of beginning and ending epoch date
3695 arrayref of beginning and ending epoch date
3699 pkgnum or APKG_pkgnum
3703 a value suited to passing to FS::UI::Web::cust_header
3707 specifies the user for agent virtualization
3711 boolean; if true, returns only packages with more than 0 FCC phone lines.
3713 =item state, country
3715 Limit to packages with a service location in the specified state and country.
3716 For FCC 477 reporting, mostly.
3723 my ($class, $params) = @_;
3730 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
3732 "cust_main.agentnum = $1";
3739 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
3741 "cust_pkg.custnum = $1";
3748 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
3750 "cust_pkg.pkgbatch = '$1'";
3757 if ( $params->{'magic'} eq 'active'
3758 || $params->{'status'} eq 'active' ) {
3760 push @where, FS::cust_pkg->active_sql();
3762 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
3763 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
3765 push @where, FS::cust_pkg->not_yet_billed_sql();
3767 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
3768 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
3770 push @where, FS::cust_pkg->inactive_sql();
3772 } elsif ( $params->{'magic'} eq 'suspended'
3773 || $params->{'status'} eq 'suspended' ) {
3775 push @where, FS::cust_pkg->suspended_sql();
3777 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
3778 || $params->{'status'} =~ /^cancell?ed$/ ) {
3780 push @where, FS::cust_pkg->cancelled_sql();
3785 # parse package class
3788 if ( exists($params->{'classnum'}) ) {
3791 if ( ref($params->{'classnum'}) ) {
3793 if ( ref($params->{'classnum'}) eq 'HASH' ) {
3794 @classnum = grep $params->{'classnum'}{$_}, keys %{ $params->{'classnum'} };
3795 } elsif ( ref($params->{'classnum'}) eq 'ARRAY' ) {
3796 @classnum = @{ $params->{'classnum'} };
3798 die 'unhandled classnum ref '. $params->{'classnum'};
3802 } elsif ( $params->{'classnum'} =~ /^(\d*)$/ && $1 ne '0' ) {
3809 my @nums = grep $_, @classnum;
3810 push @c_where, 'part_pkg.classnum IN ('. join(',',@nums). ')' if @nums;
3811 my $null = scalar( grep { $_ eq '' } @classnum );
3812 push @c_where, 'part_pkg.classnum IS NULL' if $null;
3814 if ( scalar(@c_where) == 1 ) {
3815 push @where, @c_where;
3816 } elsif ( @c_where ) {
3817 push @where, ' ( '. join(' OR ', @c_where). ' ) ';
3826 # parse package report options
3829 my @report_option = ();
3830 if ( exists($params->{'report_option'}) ) {
3831 if ( ref($params->{'report_option'}) eq 'ARRAY' ) {
3832 @report_option = @{ $params->{'report_option'} };
3833 } elsif ( $params->{'report_option'} =~ /^([,\d]*)$/ ) {
3834 @report_option = split(',', $1);
3839 if (@report_option) {
3840 # this will result in the empty set for the dangling comma case as it should
3842 map{ "0 < ( SELECT count(*) FROM part_pkg_option
3843 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
3844 AND optionname = 'report_option_$_'
3845 AND optionvalue = '1' )"
3849 foreach my $any ( grep /^report_option_any/, keys %$params ) {
3851 my @report_option_any = ();
3852 if ( ref($params->{$any}) eq 'ARRAY' ) {
3853 @report_option_any = @{ $params->{$any} };
3854 } elsif ( $params->{$any} =~ /^([,\d]*)$/ ) {
3855 @report_option_any = split(',', $1);
3858 if (@report_option_any) {
3859 # this will result in the empty set for the dangling comma case as it should
3860 push @where, ' ( '. join(' OR ',
3861 map{ "0 < ( SELECT count(*) FROM part_pkg_option
3862 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
3863 AND optionname = 'report_option_$_'
3864 AND optionvalue = '1' )"
3865 } @report_option_any
3875 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
3881 push @where, "(part_pkg.fcc_ds0s > 0 OR pkg_class.fcc_ds0s > 0)"
3882 if $params->{fcc_line};
3888 if ( exists($params->{'censustract'}) ) {
3889 $params->{'censustract'} =~ /^([.\d]*)$/;
3890 my $censustract = "cust_location.censustract = '$1'";
3891 $censustract .= ' OR cust_location.censustract is NULL' unless $1;
3892 push @where, "( $censustract )";
3896 # parse censustract2
3898 if ( exists($params->{'censustract2'})
3899 && $params->{'censustract2'} =~ /^(\d*)$/
3903 push @where, "cust_location.censustract LIKE '$1%'";
3906 "( cust_location.censustract = '' OR cust_location.censustract IS NULL )";
3911 # parse country/state
3913 for (qw(state country)) { # parsing rules are the same for these
3914 if ( exists($params->{$_})
3915 && uc($params->{$_}) =~ /^([A-Z]{2})$/ )
3917 # XXX post-2.3 only--before that, state/country may be in cust_main
3918 push @where, "cust_location.$_ = '$1'";
3926 if ( ref($params->{'pkgpart'}) ) {
3929 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
3930 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
3931 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
3932 @pkgpart = @{ $params->{'pkgpart'} };
3934 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
3937 @pkgpart = grep /^(\d+)$/, @pkgpart;
3939 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
3941 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
3942 push @where, "pkgpart = $1";
3951 #false laziness w/report_cust_pkg.html
3954 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
3955 'active' => { 'susp'=>1, 'cancel'=>1 },
3956 'suspended' => { 'cancel' => 1 },
3961 if( exists($params->{'active'} ) ) {
3962 # This overrides all the other date-related fields
3963 my($beginning, $ending) = @{$params->{'active'}};
3965 "cust_pkg.setup IS NOT NULL",
3966 "cust_pkg.setup <= $ending",
3967 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
3968 "NOT (".FS::cust_pkg->onetime_sql . ")";
3971 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end change_date cancel )) {
3973 next unless exists($params->{$field});
3975 my($beginning, $ending) = @{$params->{$field}};
3977 next if $beginning == 0 && $ending == 4294967295;
3980 "cust_pkg.$field IS NOT NULL",
3981 "cust_pkg.$field >= $beginning",
3982 "cust_pkg.$field <= $ending";
3984 $orderby ||= "ORDER BY cust_pkg.$field";
3989 $orderby ||= 'ORDER BY bill';
3992 # parse magic, legacy, etc.
3995 if ( $params->{'magic'} &&
3996 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
3999 $orderby = 'ORDER BY pkgnum';
4001 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
4002 push @where, "pkgpart = $1";
4005 } elsif ( $params->{'query'} eq 'pkgnum' ) {
4007 $orderby = 'ORDER BY pkgnum';
4009 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
4011 $orderby = 'ORDER BY pkgnum';
4014 SELECT count(*) FROM pkg_svc
4015 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
4016 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
4017 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
4018 AND cust_svc.svcpart = pkg_svc.svcpart
4025 # setup queries, links, subs, etc. for the search
4028 # here is the agent virtualization
4029 if ($params->{CurrentUser}) {
4031 qsearchs('access_user', { username => $params->{CurrentUser} });
4034 push @where, $access_user->agentnums_sql('table'=>'cust_main');
4039 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
4042 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
4044 my $addl_from = 'LEFT JOIN part_pkg USING ( pkgpart ) '.
4045 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) '.
4046 'LEFT JOIN cust_location USING ( locationnum ) '.
4047 FS::UI::Web::join_cust_main('cust_pkg', 'cust_pkg');
4051 if ( $params->{'select_zip5'} ) {
4052 my $zip = 'cust_location.zip';
4054 $select = "DISTINCT substr($zip,1,5) as zip";
4055 $orderby = "ORDER BY substr($zip,1,5)";
4056 $count_query = "SELECT COUNT( DISTINCT substr($zip,1,5) )";
4058 $select = join(', ',
4060 ( map "part_pkg.$_", qw( pkg freq ) ),
4061 'pkg_class.classname',
4062 'cust_main.custnum AS cust_main_custnum',
4063 FS::UI::Web::cust_sql_fields(
4064 $params->{'cust_fields'}
4067 $count_query = 'SELECT COUNT(*)';
4070 $count_query .= " FROM cust_pkg $addl_from $extra_sql";
4073 'table' => 'cust_pkg',
4075 'select' => $select,
4076 'extra_sql' => $extra_sql,
4077 'order_by' => $orderby,
4078 'addl_from' => $addl_from,
4079 'count_query' => $count_query,
4086 Returns a list of two package counts. The first is a count of packages
4087 based on the supplied criteria and the second is the count of residential
4088 packages with those same criteria. Criteria are specified as in the search
4094 my ($class, $params) = @_;
4096 my $sql_query = $class->search( $params );
4098 my $count_sql = delete($sql_query->{'count_query'});
4099 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
4100 or die "couldn't parse count_sql";
4102 my $count_sth = dbh->prepare($count_sql)
4103 or die "Error preparing $count_sql: ". dbh->errstr;
4105 or die "Error executing $count_sql: ". $count_sth->errstr;
4106 my $count_arrayref = $count_sth->fetchrow_arrayref;
4108 return ( @$count_arrayref );
4112 =item tax_locationnum_sql
4114 Returns an SQL expression for the tax location for a package, based
4115 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
4119 sub tax_locationnum_sql {
4120 my $conf = FS::Conf->new;
4121 if ( $conf->exists('tax-pkg_address') ) {
4122 'cust_pkg.locationnum';
4124 elsif ( $conf->exists('tax-ship_address') ) {
4125 'cust_main.ship_locationnum';
4128 'cust_main.bill_locationnum';
4134 Returns a list: the first item is an SQL fragment identifying matching
4135 packages/customers via location (taking into account shipping and package
4136 address taxation, if enabled), and subsequent items are the parameters to
4137 substitute for the placeholders in that fragment.
4142 my($class, %opt) = @_;
4143 my $ornull = $opt{'ornull'};
4145 my $conf = new FS::Conf;
4147 # '?' placeholders in _location_sql_where
4148 my $x = $ornull ? 3 : 2;
4159 if ( $conf->exists('tax-ship_address') ) {
4162 ( ( ship_last IS NULL OR ship_last = '' )
4163 AND ". _location_sql_where('cust_main', '', $ornull ). "
4165 OR ( ship_last IS NOT NULL AND ship_last != ''
4166 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
4169 # AND payby != 'COMP'
4171 @main_param = ( @bill_param, @bill_param );
4175 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
4176 @main_param = @bill_param;
4182 if ( $conf->exists('tax-pkg_address') ) {
4184 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
4187 ( cust_pkg.locationnum IS NULL AND $main_where )
4188 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
4191 @param = ( @main_param, @bill_param );
4195 $where = $main_where;
4196 @param = @main_param;
4204 #subroutine, helper for location_sql
4205 sub _location_sql_where {
4207 my $prefix = @_ ? shift : '';
4208 my $ornull = @_ ? shift : '';
4210 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
4212 $ornull = $ornull ? ' OR ? IS NULL ' : '';
4214 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
4215 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
4216 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
4218 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
4220 # ( $table.${prefix}city = ? $or_empty_city $ornull )
4222 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4223 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4224 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
4225 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
4226 AND $table.${prefix}country = ?
4231 my( $self, $what ) = @_;
4233 my $what_show_zero = $what. '_show_zero';
4234 length($self->$what_show_zero())
4235 ? ($self->$what_show_zero() eq 'Y')
4236 : $self->part_pkg->$what_show_zero();
4243 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
4245 CUSTNUM is a customer (see L<FS::cust_main>)
4247 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4248 L<FS::part_pkg>) to order for this customer. Duplicates are of course
4251 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
4252 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
4253 new billing items. An error is returned if this is not possible (see
4254 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
4257 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4258 newly-created cust_pkg objects.
4260 REFNUM, if specified, will specify the FS::pkg_referral record to be created
4261 and inserted. Multiple FS::pkg_referral records can be created by
4262 setting I<refnum> to an array reference of refnums or a hash reference with
4263 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
4264 record will be created corresponding to cust_main.refnum.
4269 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
4271 my $conf = new FS::Conf;
4273 # Transactionize this whole mess
4274 local $SIG{HUP} = 'IGNORE';
4275 local $SIG{INT} = 'IGNORE';
4276 local $SIG{QUIT} = 'IGNORE';
4277 local $SIG{TERM} = 'IGNORE';
4278 local $SIG{TSTP} = 'IGNORE';
4279 local $SIG{PIPE} = 'IGNORE';
4281 my $oldAutoCommit = $FS::UID::AutoCommit;
4282 local $FS::UID::AutoCommit = 0;
4286 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
4287 # return "Customer not found: $custnum" unless $cust_main;
4289 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
4292 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4295 my $change = scalar(@old_cust_pkg) != 0;
4298 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
4300 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
4301 " to pkgpart ". $pkgparts->[0]. "\n"
4304 my $err_or_cust_pkg =
4305 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
4306 'refnum' => $refnum,
4309 unless (ref($err_or_cust_pkg)) {
4310 $dbh->rollback if $oldAutoCommit;
4311 return $err_or_cust_pkg;
4314 push @$return_cust_pkg, $err_or_cust_pkg;
4315 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4320 # Create the new packages.
4321 foreach my $pkgpart (@$pkgparts) {
4323 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
4325 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
4326 pkgpart => $pkgpart,
4330 $error = $cust_pkg->insert( 'change' => $change );
4331 push @$return_cust_pkg, $cust_pkg;
4333 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
4334 my $supp_pkg = FS::cust_pkg->new({
4335 custnum => $custnum,
4336 pkgpart => $link->dst_pkgpart,
4338 main_pkgnum => $cust_pkg->pkgnum,
4341 $error ||= $supp_pkg->insert( 'change' => $change );
4342 push @$return_cust_pkg, $supp_pkg;
4346 $dbh->rollback if $oldAutoCommit;
4351 # $return_cust_pkg now contains refs to all of the newly
4354 # Transfer services and cancel old packages.
4355 foreach my $old_pkg (@old_cust_pkg) {
4357 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
4360 foreach my $new_pkg (@$return_cust_pkg) {
4361 $error = $old_pkg->transfer($new_pkg);
4362 if ($error and $error == 0) {
4363 # $old_pkg->transfer failed.
4364 $dbh->rollback if $oldAutoCommit;
4369 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
4370 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
4371 foreach my $new_pkg (@$return_cust_pkg) {
4372 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
4373 if ($error and $error == 0) {
4374 # $old_pkg->transfer failed.
4375 $dbh->rollback if $oldAutoCommit;
4382 # Transfers were successful, but we went through all of the
4383 # new packages and still had services left on the old package.
4384 # We can't cancel the package under the circumstances, so abort.
4385 $dbh->rollback if $oldAutoCommit;
4386 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
4388 $error = $old_pkg->cancel( quiet=>1 );
4394 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4398 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
4400 A bulk change method to change packages for multiple customers.
4402 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4403 L<FS::part_pkg>) to order for each customer. Duplicates are of course
4406 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
4407 replace. The services (see L<FS::cust_svc>) are moved to the
4408 new billing items. An error is returned if this is not possible (see
4411 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4412 newly-created cust_pkg objects.
4417 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
4419 # Transactionize this whole mess
4420 local $SIG{HUP} = 'IGNORE';
4421 local $SIG{INT} = 'IGNORE';
4422 local $SIG{QUIT} = 'IGNORE';
4423 local $SIG{TERM} = 'IGNORE';
4424 local $SIG{TSTP} = 'IGNORE';
4425 local $SIG{PIPE} = 'IGNORE';
4427 my $oldAutoCommit = $FS::UID::AutoCommit;
4428 local $FS::UID::AutoCommit = 0;
4432 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4435 while(scalar(@old_cust_pkg)) {
4437 my $custnum = $old_cust_pkg[0]->custnum;
4438 my (@remove) = map { $_->pkgnum }
4439 grep { $_->custnum == $custnum } @old_cust_pkg;
4440 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
4442 my $error = order $custnum, $pkgparts, \@remove, \@return;
4444 push @errors, $error
4446 push @$return_cust_pkg, @return;
4449 if (scalar(@errors)) {
4450 $dbh->rollback if $oldAutoCommit;
4451 return join(' / ', @errors);
4454 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4458 # Used by FS::Upgrade to migrate to a new database.
4459 sub _upgrade_data { # class method
4460 my ($class, %opts) = @_;
4461 $class->_upgrade_otaker(%opts);
4463 # RT#10139, bug resulting in contract_end being set when it shouldn't
4464 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
4465 # RT#10830, bad calculation of prorate date near end of year
4466 # the date range for bill is December 2009, and we move it forward
4467 # one year if it's before the previous bill date (which it should
4469 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
4470 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
4471 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
4472 # RT6628, add order_date to cust_pkg
4473 'update cust_pkg set order_date = (select history_date from h_cust_pkg
4474 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
4475 history_action = \'insert\') where order_date is null',
4477 foreach my $sql (@statements) {
4478 my $sth = dbh->prepare($sql);
4479 $sth->execute or die $sth->errstr;
4487 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
4489 In sub order, the @pkgparts array (passed by reference) is clobbered.
4491 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
4492 method to pass dates to the recur_prog expression, it should do so.
4494 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
4495 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
4496 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
4497 configuration values. Probably need a subroutine which decides what to do
4498 based on whether or not we've fetched the user yet, rather than a hash. See
4499 FS::UID and the TODO.
4501 Now that things are transactional should the check in the insert method be
4506 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
4507 L<FS::pkg_svc>, schema.html from the base documentation