4 use base qw( FS::otaker_Mixin FS::cust_main_Mixin
5 FS::contact_Mixin FS::location_Mixin
6 FS::m2m_Common FS::option_Common );
7 use vars qw($disable_agentcheck $DEBUG $me);
9 use Scalar::Util qw( blessed );
10 use List::Util qw(min max);
12 use Time::Local qw( timelocal timelocal_nocheck );
14 use FS::UID qw( dbh driver_name );
15 use FS::Misc qw( send_email );
16 use FS::Record qw( qsearch qsearchs fields );
22 use FS::cust_location;
24 use FS::cust_bill_pkg;
25 use FS::cust_pkg_detail;
26 use FS::cust_pkg_usage;
27 use FS::cdr_cust_pkg_usage;
32 use FS::cust_pkg_reason;
34 use FS::cust_pkg_discount;
39 # need to 'use' these instead of 'require' in sub { cancel, suspend, unsuspend,
41 # because they load configuration by setting FS::UID::callback (see TODO)
47 # for sending cancel emails in sub cancel
51 $me = '[FS::cust_pkg]';
53 $disable_agentcheck = 0;
57 my ( $hashref, $cache ) = @_;
58 #if ( $hashref->{'pkgpart'} ) {
59 if ( $hashref->{'pkg'} ) {
60 # #@{ $self->{'_pkgnum'} } = ();
61 # my $subcache = $cache->subcache('pkgpart', 'part_pkg');
62 # $self->{'_pkgpart'} = $subcache;
63 # #push @{ $self->{'_pkgnum'} },
64 # FS::part_pkg->new_or_cached($hashref, $subcache);
65 $self->{'_pkgpart'} = FS::part_pkg->new($hashref);
67 if ( exists $hashref->{'svcnum'} ) {
68 #@{ $self->{'_pkgnum'} } = ();
69 my $subcache = $cache->subcache('svcnum', 'cust_svc', $hashref->{pkgnum});
70 $self->{'_svcnum'} = $subcache;
71 #push @{ $self->{'_pkgnum'} },
72 FS::cust_svc->new_or_cached($hashref, $subcache) if $hashref->{svcnum};
78 FS::cust_pkg - Object methods for cust_pkg objects
84 $record = new FS::cust_pkg \%hash;
85 $record = new FS::cust_pkg { 'column' => 'value' };
87 $error = $record->insert;
89 $error = $new_record->replace($old_record);
91 $error = $record->delete;
93 $error = $record->check;
95 $error = $record->cancel;
97 $error = $record->suspend;
99 $error = $record->unsuspend;
101 $part_pkg = $record->part_pkg;
103 @labels = $record->labels;
105 $seconds = $record->seconds_since($timestamp);
107 $error = FS::cust_pkg::order( $custnum, \@pkgparts );
108 $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );
112 An FS::cust_pkg object represents a customer billing item. FS::cust_pkg
113 inherits from FS::Record. The following fields are currently supported:
119 Primary key (assigned automatically for new billing items)
123 Customer (see L<FS::cust_main>)
127 Billing item definition (see L<FS::part_pkg>)
131 Optional link to package location (see L<FS::location>)
135 date package was ordered (also remains same on changes)
147 date (next bill date)
175 order taker (see L<FS::access_user>)
179 If this field is set to 1, disables the automatic
180 unsuspension of this package when using the B<unsuspendauto> config option.
184 If not set, defaults to 1
188 Date of change from previous package
198 =item change_locationnum
206 The pkgnum of the package that this package is supplemental to, if any.
210 The package link (L<FS::part_pkg_link>) that defines this supplemental
211 package, if it is one.
215 Note: setup, last_bill, bill, adjourn, susp, expire, cancel and change_date
216 are specified as UNIX timestamps; see L<perlfunc/"time">. Also see
217 L<Time::Local> and L<Date::Parse> for conversion functions.
225 Create a new billing item. To add the item to the database, see L<"insert">.
229 sub table { 'cust_pkg'; }
230 sub cust_linked { $_[0]->cust_main_custnum || $_[0]->custnum }
231 sub cust_unlinked_msg {
233 "WARNING: can't find cust_main.custnum ". $self->custnum.
234 ' (cust_pkg.pkgnum '. $self->pkgnum. ')';
237 =item insert [ OPTION => VALUE ... ]
239 Adds this billing item to the database ("Orders" the item). If there is an
240 error, returns the error, otherwise returns false.
242 If the additional field I<promo_code> is defined instead of I<pkgpart>, it
243 will be used to look up the package definition and agent restrictions will be
246 If the additional field I<refnum> is defined, an FS::pkg_referral record will
247 be created and inserted. Multiple FS::pkg_referral records can be created by
248 setting I<refnum> to an array reference of refnums or a hash reference with
249 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
250 record will be created corresponding to cust_main.refnum.
252 The following options are available:
258 If set true, supresses actions that should only be taken for new package
259 orders. (Currently this includes: intro periods when delay_setup is on.)
263 cust_pkg_option records will be created
267 a ticket will be added to this customer with this subject
271 an optional queue name for ticket additions
275 Don't check the legality of the package definition. This should be used
276 when performing a package change that doesn't change the pkgpart (i.e.
284 my( $self, %options ) = @_;
287 $error = $self->check_pkgpart unless $options{'allow_pkgpart'};
288 return $error if $error;
290 my $part_pkg = $self->part_pkg;
292 if ( $part_pkg->option('start_1st', 1) && !$self->start_date ) {
293 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime(time) )[0,1,2,3,4,5];
294 $mon += 1 unless $mday == 1;
295 until ( $mon < 12 ) { $mon -= 12; $year++; }
296 $self->start_date( timelocal_nocheck(0,0,0,1,$mon,$year) );
299 foreach my $action ( qw(expire adjourn contract_end) ) {
300 my $months = $part_pkg->option("${action}_months",1);
301 if($months and !$self->$action) {
302 my $start = $self->start_date || $self->setup || time;
303 $self->$action( $part_pkg->add_freq($start, $months) );
307 if ( ! $options{'change'}
308 && ( my $free_days = $part_pkg->option('free_days',1) )
309 && $part_pkg->option('delay_setup',1)
310 #&& ! $self->start_date
313 my ($mday,$mon,$year) = (localtime(time) )[3,4,5];
314 #my $start_date = ($self->start_date || timelocal(0,0,0,$mday,$mon,$year)) + 86400 * $free_days;
315 my $start_date = timelocal(0,0,0,$mday,$mon,$year) + 86400 * $free_days;
316 $self->start_date($start_date);
319 $self->order_date(time);
321 local $SIG{HUP} = 'IGNORE';
322 local $SIG{INT} = 'IGNORE';
323 local $SIG{QUIT} = 'IGNORE';
324 local $SIG{TERM} = 'IGNORE';
325 local $SIG{TSTP} = 'IGNORE';
326 local $SIG{PIPE} = 'IGNORE';
328 my $oldAutoCommit = $FS::UID::AutoCommit;
329 local $FS::UID::AutoCommit = 0;
332 $error = $self->SUPER::insert($options{options} ? %{$options{options}} : ());
334 $dbh->rollback if $oldAutoCommit;
338 $self->refnum($self->cust_main->refnum) unless $self->refnum;
339 $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
340 $self->process_m2m( 'link_table' => 'pkg_referral',
341 'target_table' => 'part_referral',
342 'params' => $self->refnum,
345 if ( $self->discountnum ) {
346 my $error = $self->insert_discount();
348 $dbh->rollback if $oldAutoCommit;
353 #if ( $self->reg_code ) {
354 # my $reg_code = qsearchs('reg_code', { 'code' => $self->reg_code } );
355 # $error = $reg_code->delete;
357 # $dbh->rollback if $oldAutoCommit;
362 my $conf = new FS::Conf;
364 if ( $conf->config('ticket_system') && $options{ticket_subject} ) {
366 #this init stuff is still inefficient, but at least its limited to
367 # the small number (any?) folks using ticket emailing on pkg order
370 # use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
377 use FS::TicketSystem;
378 FS::TicketSystem->init();
380 my $q = new RT::Queue($RT::SystemUser);
381 $q->Load($options{ticket_queue}) if $options{ticket_queue};
382 my $t = new RT::Ticket($RT::SystemUser);
383 my $mime = new MIME::Entity;
384 $mime->build( Type => 'text/plain', Data => $options{ticket_subject} );
385 $t->Create( $options{ticket_queue} ? (Queue => $q) : (),
386 Subject => $options{ticket_subject},
389 $t->AddLink( Type => 'MemberOf',
390 Target => 'freeside://freeside/cust_main/'. $self->custnum,
394 if ($conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
395 my $queue = new FS::queue {
396 'job' => 'FS::cust_main::queueable_print',
398 $error = $queue->insert(
399 'custnum' => $self->custnum,
400 'template' => 'welcome_letter',
404 warn "can't send welcome letter: $error";
409 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
416 This method now works but you probably shouldn't use it.
418 You don't want to delete packages, because there would then be no record
419 the customer ever purchased the package. Instead, see the cancel method and
420 hide cancelled packages.
427 local $SIG{HUP} = 'IGNORE';
428 local $SIG{INT} = 'IGNORE';
429 local $SIG{QUIT} = 'IGNORE';
430 local $SIG{TERM} = 'IGNORE';
431 local $SIG{TSTP} = 'IGNORE';
432 local $SIG{PIPE} = 'IGNORE';
434 my $oldAutoCommit = $FS::UID::AutoCommit;
435 local $FS::UID::AutoCommit = 0;
438 foreach my $cust_pkg_discount ($self->cust_pkg_discount) {
439 my $error = $cust_pkg_discount->delete;
441 $dbh->rollback if $oldAutoCommit;
445 #cust_bill_pkg_discount?
447 foreach my $cust_pkg_detail ($self->cust_pkg_detail) {
448 my $error = $cust_pkg_detail->delete;
450 $dbh->rollback if $oldAutoCommit;
455 foreach my $cust_pkg_reason (
457 'table' => 'cust_pkg_reason',
458 'hashref' => { 'pkgnum' => $self->pkgnum },
462 my $error = $cust_pkg_reason->delete;
464 $dbh->rollback if $oldAutoCommit;
471 my $error = $self->SUPER::delete(@_);
473 $dbh->rollback if $oldAutoCommit;
477 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
483 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
485 Replaces the OLD_RECORD with this one in the database. If there is an error,
486 returns the error, otherwise returns false.
488 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
490 Changing pkgpart may have disasterous effects. See the order subroutine.
492 setup and bill are normally updated by calling the bill method of a customer
493 object (see L<FS::cust_main>).
495 suspend is normally updated by the suspend and unsuspend methods.
497 cancel is normally updated by the cancel method (and also the order subroutine
500 Available options are:
506 can be set to a cancellation reason (see L<FS:reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason. The hashref should have the following keys: typenum - Reason type (see L<FS::reason_type>, reason - Text of the new reason.
510 the access_user (see L<FS::access_user>) providing the reason
514 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
523 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
528 ( ref($_[0]) eq 'HASH' )
532 #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
533 #return "Can't change otaker!" if $old->otaker ne $new->otaker;
536 #return "Can't change setup once it exists!"
537 # if $old->getfield('setup') &&
538 # $old->getfield('setup') != $new->getfield('setup');
540 #some logic for bill, susp, cancel?
542 local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
544 local $SIG{HUP} = 'IGNORE';
545 local $SIG{INT} = 'IGNORE';
546 local $SIG{QUIT} = 'IGNORE';
547 local $SIG{TERM} = 'IGNORE';
548 local $SIG{TSTP} = 'IGNORE';
549 local $SIG{PIPE} = 'IGNORE';
551 my $oldAutoCommit = $FS::UID::AutoCommit;
552 local $FS::UID::AutoCommit = 0;
555 foreach my $method ( qw(adjourn expire) ) { # How many reasons?
556 if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
557 my $error = $new->insert_reason(
558 'reason' => $options->{'reason'},
559 'date' => $new->$method,
561 'reason_otaker' => $options->{'reason_otaker'},
564 dbh->rollback if $oldAutoCommit;
565 return "Error inserting cust_pkg_reason: $error";
570 #save off and freeze RADIUS attributes for any associated svc_acct records
572 if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
574 #also check for specific exports?
575 # to avoid spurious modify export events
576 @svc_acct = map { $_->svc_x }
577 grep { $_->part_svc->svcdb eq 'svc_acct' }
580 $_->snapshot foreach @svc_acct;
584 my $error = $new->SUPER::replace($old,
585 $options->{options} ? $options->{options} : ()
588 $dbh->rollback if $oldAutoCommit;
592 #for prepaid packages,
593 #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
594 foreach my $old_svc_acct ( @svc_acct ) {
595 my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
597 $new_svc_acct->replace( $old_svc_acct,
598 'depend_jobnum' => $options->{depend_jobnum},
601 $dbh->rollback if $oldAutoCommit;
606 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
613 Checks all fields to make sure this is a valid billing item. If there is an
614 error, returns the error, otherwise returns false. Called by the insert and
622 if ( !$self->locationnum or $self->locationnum == -1 ) {
623 $self->set('locationnum', $self->cust_main->ship_locationnum);
627 $self->ut_numbern('pkgnum')
628 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
629 || $self->ut_numbern('pkgpart')
630 || $self->ut_foreign_keyn('contactnum', 'contact', 'contactnum' )
631 || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
632 || $self->ut_numbern('start_date')
633 || $self->ut_numbern('setup')
634 || $self->ut_numbern('bill')
635 || $self->ut_numbern('susp')
636 || $self->ut_numbern('cancel')
637 || $self->ut_numbern('adjourn')
638 || $self->ut_numbern('resume')
639 || $self->ut_numbern('expire')
640 || $self->ut_numbern('dundate')
641 || $self->ut_enum('no_auto', [ '', 'Y' ])
642 || $self->ut_enum('waive_setup', [ '', 'Y' ])
643 || $self->ut_numbern('agent_pkgid')
644 || $self->ut_enum('recur_show_zero', [ '', 'Y', 'N', ])
645 || $self->ut_enum('setup_show_zero', [ '', 'Y', 'N', ])
646 || $self->ut_foreign_keyn('main_pkgnum', 'cust_pkg', 'pkgnum')
647 || $self->ut_foreign_keyn('pkglinknum', 'part_pkg_link', 'pkglinknum')
649 return $error if $error;
651 return "A package with both start date (future start) and setup date (already started) will never bill"
652 if $self->start_date && $self->setup;
654 return "A future unsuspend date can only be set for a package with a suspend date"
655 if $self->resume and !$self->susp and !$self->adjourn;
657 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
659 if ( $self->dbdef_table->column('manual_flag') ) {
660 $self->manual_flag('') if $self->manual_flag eq ' ';
661 $self->manual_flag =~ /^([01]?)$/
662 or return "Illegal manual_flag ". $self->manual_flag;
663 $self->manual_flag($1);
671 Check the pkgpart to make sure it's allowed with the reg_code and/or
672 promo_code of the package (if present) and with the customer's agent.
673 Called from C<insert>, unless we are doing a package change that doesn't
681 # my $error = $self->ut_numbern('pkgpart'); # already done
684 if ( $self->reg_code ) {
686 unless ( grep { $self->pkgpart == $_->pkgpart }
687 map { $_->reg_code_pkg }
688 qsearchs( 'reg_code', { 'code' => $self->reg_code,
689 'agentnum' => $self->cust_main->agentnum })
691 return "Unknown registration code";
694 } elsif ( $self->promo_code ) {
697 qsearchs('part_pkg', {
698 'pkgpart' => $self->pkgpart,
699 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
701 return 'Unknown promotional code' unless $promo_part_pkg;
705 unless ( $disable_agentcheck ) {
707 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
708 return "agent ". $agent->agentnum. ':'. $agent->agent.
709 " can't purchase pkgpart ". $self->pkgpart
710 unless $agent->pkgpart_hashref->{ $self->pkgpart }
711 || $agent->agentnum == $self->part_pkg->agentnum;
714 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
715 return $error if $error;
723 =item cancel [ OPTION => VALUE ... ]
725 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
726 in this package, then cancels the package itself (sets the cancel field to
729 Available options are:
733 =item quiet - can be set true to supress email cancellation notices.
735 =item time - can be set to cancel the package based on a specific future or
736 historical date. Using time ensures that the remaining amount is calculated
737 correctly. Note however that this is an immediate cancel and just changes
738 the date. You are PROBABLY looking to expire the account instead of using
741 =item reason - can be set to a cancellation reason (see L<FS:reason>),
742 either a reasonnum of an existing reason, or passing a hashref will create
743 a new reason. The hashref should have the following keys: typenum - Reason
744 type (see L<FS::reason_type>, reason - Text of the new reason.
746 =item date - can be set to a unix style timestamp to specify when to
749 =item nobill - can be set true to skip billing if it might otherwise be done.
751 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
752 not credit it. This must be set (by change()) when changing the package
753 to a different pkgpart or location, and probably shouldn't be in any other
754 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
759 If there is an error, returns the error, otherwise returns false.
764 my( $self, %options ) = @_;
767 # pass all suspend/cancel actions to the main package
768 if ( $self->main_pkgnum and !$options{'from_main'} ) {
769 return $self->main_pkg->cancel(%options);
772 my $conf = new FS::Conf;
774 warn "cust_pkg::cancel called with options".
775 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
778 local $SIG{HUP} = 'IGNORE';
779 local $SIG{INT} = 'IGNORE';
780 local $SIG{QUIT} = 'IGNORE';
781 local $SIG{TERM} = 'IGNORE';
782 local $SIG{TSTP} = 'IGNORE';
783 local $SIG{PIPE} = 'IGNORE';
785 my $oldAutoCommit = $FS::UID::AutoCommit;
786 local $FS::UID::AutoCommit = 0;
789 my $old = $self->select_for_update;
791 if ( $old->get('cancel') || $self->get('cancel') ) {
792 dbh->rollback if $oldAutoCommit;
793 return ""; # no error
796 # XXX possibly set cancel_time to the expire date?
797 my $cancel_time = $options{'time'} || time;
798 my $date = $options{'date'} if $options{'date'}; # expire/cancel later
799 $date = '' if ($date && $date <= $cancel_time); # complain instead?
801 #race condition: usage could be ongoing until unprovisioned
802 #resolved by performing a change package instead (which unprovisions) and
804 if ( !$options{nobill} && !$date ) {
805 # && $conf->exists('bill_usage_on_cancel') ) { #calc_cancel checks this
806 my $copy = $self->new({$self->hash});
808 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
810 'time' => $cancel_time );
811 warn "Error billing during cancel, custnum ".
812 #$self->cust_main->custnum. ": $error"
817 if ( $options{'reason'} ) {
818 $error = $self->insert_reason( 'reason' => $options{'reason'},
819 'action' => $date ? 'expire' : 'cancel',
820 'date' => $date ? $date : $cancel_time,
821 'reason_otaker' => $options{'reason_otaker'},
824 dbh->rollback if $oldAutoCommit;
825 return "Error inserting cust_pkg_reason: $error";
829 my %svc_cancel_opt = ();
830 $svc_cancel_opt{'date'} = $date if $date;
831 foreach my $cust_svc (
834 sort { $a->[1] <=> $b->[1] }
835 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; }
836 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
838 my $part_svc = $cust_svc->part_svc;
839 next if ( defined($part_svc) and $part_svc->preserve );
840 my $error = $cust_svc->cancel( %svc_cancel_opt );
843 $dbh->rollback if $oldAutoCommit;
844 return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
850 # credit remaining time if appropriate
852 if ( exists($options{'unused_credit'}) ) {
853 $do_credit = $options{'unused_credit'};
856 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
859 my $error = $self->credit_remaining('cancel', $cancel_time);
861 $dbh->rollback if $oldAutoCommit;
868 my %hash = $self->hash;
869 $date ? ($hash{'expire'} = $date) : ($hash{'cancel'} = $cancel_time);
870 $hash{'change_custnum'} = $options{'change_custnum'};
871 my $new = new FS::cust_pkg ( \%hash );
872 $error = $new->replace( $self, options => { $self->options } );
874 $dbh->rollback if $oldAutoCommit;
878 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
879 $error = $supp_pkg->cancel(%options, 'from_main' => 1);
881 $dbh->rollback if $oldAutoCommit;
882 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
886 foreach my $usage ( $self->cust_pkg_usage ) {
887 $error = $usage->delete;
889 $dbh->rollback if $oldAutoCommit;
890 return "deleting usage pools: $error";
894 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
895 return '' if $date; #no errors
897 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
898 if ( !$options{'quiet'} &&
899 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
901 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
904 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
905 $error = $msg_template->send( 'cust_main' => $self->cust_main,
910 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
911 'to' => \@invoicing_list,
912 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
913 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
916 #should this do something on errors?
923 =item cancel_if_expired [ NOW_TIMESTAMP ]
925 Cancels this package if its expire date has been reached.
929 sub cancel_if_expired {
931 my $time = shift || time;
932 return '' unless $self->expire && $self->expire <= $time;
933 my $error = $self->cancel;
935 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
936 $self->custnum. ": $error";
943 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
944 locationnum, (other fields?). Attempts to re-provision cancelled services
945 using history information (errors at this stage are not fatal).
947 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
949 svc_fatal: service provisioning errors are fatal
951 svc_errors: pass an array reference, will be filled in with any provisioning errors
953 main_pkgnum: link the package as a supplemental package of this one. For
959 my( $self, %options ) = @_;
961 #in case you try do do $uncancel-date = $cust_pkg->uncacel
962 return '' unless $self->get('cancel');
964 if ( $self->main_pkgnum and !$options{'main_pkgnum'} ) {
965 return $self->main_pkg->uncancel(%options);
972 local $SIG{HUP} = 'IGNORE';
973 local $SIG{INT} = 'IGNORE';
974 local $SIG{QUIT} = 'IGNORE';
975 local $SIG{TERM} = 'IGNORE';
976 local $SIG{TSTP} = 'IGNORE';
977 local $SIG{PIPE} = 'IGNORE';
979 my $oldAutoCommit = $FS::UID::AutoCommit;
980 local $FS::UID::AutoCommit = 0;
984 # insert the new package
987 my $cust_pkg = new FS::cust_pkg {
988 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
989 bill => ( $options{'bill'} || $self->get('bill') ),
991 uncancel_pkgnum => $self->pkgnum,
992 main_pkgnum => ($options{'main_pkgnum'} || ''),
993 map { $_ => $self->get($_) } qw(
994 custnum pkgpart locationnum
996 susp adjourn resume expire start_date contract_end dundate
997 change_date change_pkgpart change_locationnum
998 manual_flag no_auto quantity agent_pkgid recur_show_zero setup_show_zero
1002 my $error = $cust_pkg->insert(
1003 'change' => 1, #supresses any referral credit to a referring customer
1004 'allow_pkgpart' => 1, # allow this even if the package def is disabled
1007 $dbh->rollback if $oldAutoCommit;
1015 #find historical services within this timeframe before the package cancel
1016 # (incompatible with "time" option to cust_pkg->cancel?)
1017 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
1018 # too little? (unprovisioing export delay?)
1019 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
1020 my @h_cust_svc = $self->h_cust_svc( $end, $start );
1023 foreach my $h_cust_svc (@h_cust_svc) {
1024 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
1025 #next unless $h_svc_x; #should this happen?
1026 (my $table = $h_svc_x->table) =~ s/^h_//;
1027 require "FS/$table.pm";
1028 my $class = "FS::$table";
1029 my $svc_x = $class->new( {
1030 'pkgnum' => $cust_pkg->pkgnum,
1031 'svcpart' => $h_cust_svc->svcpart,
1032 map { $_ => $h_svc_x->get($_) } fields($table)
1036 if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
1037 $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
1040 my $svc_error = $svc_x->insert;
1042 if ( $options{svc_fatal} ) {
1043 $dbh->rollback if $oldAutoCommit;
1046 # if we've failed to insert the svc_x object, svc_Common->insert
1047 # will have removed the cust_svc already. if not, then both records
1048 # were inserted but we failed for some other reason (export, most
1049 # likely). in that case, report the error and delete the records.
1050 push @svc_errors, $svc_error;
1051 my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1053 # except if export_insert failed, export_delete probably won't be
1055 local $FS::svc_Common::noexport_hack = 1;
1056 my $cleanup_error = $svc_x->delete; # also deletes cust_svc
1057 if ( $cleanup_error ) { # and if THAT fails, then run away
1058 $dbh->rollback if $oldAutoCommit;
1059 return $cleanup_error;
1064 } #foreach $h_cust_svc
1066 #these are pretty rare, but should handle them
1067 # - dsl_device (mac addresses)
1068 # - phone_device (mac addresses)
1069 # - dsl_note (ikano notes)
1070 # - domain_record (i.e. restore DNS information w/domains)
1071 # - inventory_item(?) (inventory w/un-cancelling service?)
1072 # - nas (svc_broaband nas stuff)
1073 #this stuff is unused in the wild afaik
1074 # - mailinglistmember
1076 # - svc_domain.parent_svcnum?
1077 # - acct_snarf (ancient mail fetching config)
1078 # - cgp_rule (communigate)
1079 # - cust_svc_option (used by our Tron stuff)
1080 # - acct_rt_transaction (used by our time worked stuff)
1083 # also move over any services that didn't unprovision at cancellation
1086 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1087 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1088 my $error = $cust_svc->replace;
1090 $dbh->rollback if $oldAutoCommit;
1096 # Uncancel any supplemental packages, and make them supplemental to the
1100 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1102 $error = $supp_pkg->uncancel(%options, 'main_pkgnum' => $cust_pkg->pkgnum);
1104 $dbh->rollback if $oldAutoCommit;
1105 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1113 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1115 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1116 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1123 Cancels any pending expiration (sets the expire field to null).
1125 If there is an error, returns the error, otherwise returns false.
1130 my( $self, %options ) = @_;
1133 local $SIG{HUP} = 'IGNORE';
1134 local $SIG{INT} = 'IGNORE';
1135 local $SIG{QUIT} = 'IGNORE';
1136 local $SIG{TERM} = 'IGNORE';
1137 local $SIG{TSTP} = 'IGNORE';
1138 local $SIG{PIPE} = 'IGNORE';
1140 my $oldAutoCommit = $FS::UID::AutoCommit;
1141 local $FS::UID::AutoCommit = 0;
1144 my $old = $self->select_for_update;
1146 my $pkgnum = $old->pkgnum;
1147 if ( $old->get('cancel') || $self->get('cancel') ) {
1148 dbh->rollback if $oldAutoCommit;
1149 return "Can't unexpire cancelled package $pkgnum";
1150 # or at least it's pointless
1153 unless ( $old->get('expire') && $self->get('expire') ) {
1154 dbh->rollback if $oldAutoCommit;
1155 return ""; # no error
1158 my %hash = $self->hash;
1159 $hash{'expire'} = '';
1160 my $new = new FS::cust_pkg ( \%hash );
1161 $error = $new->replace( $self, options => { $self->options } );
1163 $dbh->rollback if $oldAutoCommit;
1167 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1173 =item suspend [ OPTION => VALUE ... ]
1175 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1176 package, then suspends the package itself (sets the susp field to now).
1178 Available options are:
1182 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1183 either a reasonnum of an existing reason, or passing a hashref will create
1184 a new reason. The hashref should have the following keys:
1185 - typenum - Reason type (see L<FS::reason_type>
1186 - reason - Text of the new reason.
1188 =item date - can be set to a unix style timestamp to specify when to
1191 =item time - can be set to override the current time, for calculation
1192 of final invoices or unused-time credits
1194 =item resume_date - can be set to a time when the package should be
1195 unsuspended. This may be more convenient than calling C<unsuspend()>
1198 =item from_main - allows a supplemental package to be suspended, rather
1199 than redirecting the method call to its main package. For internal use.
1203 If there is an error, returns the error, otherwise returns false.
1208 my( $self, %options ) = @_;
1211 # pass all suspend/cancel actions to the main package
1212 if ( $self->main_pkgnum and !$options{'from_main'} ) {
1213 return $self->main_pkg->suspend(%options);
1216 local $SIG{HUP} = 'IGNORE';
1217 local $SIG{INT} = 'IGNORE';
1218 local $SIG{QUIT} = 'IGNORE';
1219 local $SIG{TERM} = 'IGNORE';
1220 local $SIG{TSTP} = 'IGNORE';
1221 local $SIG{PIPE} = 'IGNORE';
1223 my $oldAutoCommit = $FS::UID::AutoCommit;
1224 local $FS::UID::AutoCommit = 0;
1227 my $old = $self->select_for_update;
1229 my $pkgnum = $old->pkgnum;
1230 if ( $old->get('cancel') || $self->get('cancel') ) {
1231 dbh->rollback if $oldAutoCommit;
1232 return "Can't suspend cancelled package $pkgnum";
1235 if ( $old->get('susp') || $self->get('susp') ) {
1236 dbh->rollback if $oldAutoCommit;
1237 return ""; # no error # complain on adjourn?
1240 my $suspend_time = $options{'time'} || time;
1241 my $date = $options{date} if $options{date}; # adjourn/suspend later
1242 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1244 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1245 dbh->rollback if $oldAutoCommit;
1246 return "Package $pkgnum expires before it would be suspended.";
1249 # some false laziness with sub cancel
1250 if ( !$options{nobill} && !$date &&
1251 $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1252 # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1253 # make the entire cust_main->bill path recognize 'suspend' and
1254 # 'cancel' separately.
1255 warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1256 my $copy = $self->new({$self->hash});
1258 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1260 'time' => $suspend_time );
1261 warn "Error billing during suspend, custnum ".
1262 #$self->cust_main->custnum. ": $error"
1267 if ( $options{'reason'} ) {
1268 $error = $self->insert_reason( 'reason' => $options{'reason'},
1269 'action' => $date ? 'adjourn' : 'suspend',
1270 'date' => $date ? $date : $suspend_time,
1271 'reason_otaker' => $options{'reason_otaker'},
1274 dbh->rollback if $oldAutoCommit;
1275 return "Error inserting cust_pkg_reason: $error";
1279 my %hash = $self->hash;
1281 $hash{'adjourn'} = $date;
1283 $hash{'susp'} = $suspend_time;
1286 my $resume_date = $options{'resume_date'} || 0;
1287 if ( $resume_date > ($date || $suspend_time) ) {
1288 $hash{'resume'} = $resume_date;
1291 $options{options} ||= {};
1293 my $new = new FS::cust_pkg ( \%hash );
1294 $error = $new->replace( $self, options => { $self->options,
1295 %{ $options{options} },
1299 $dbh->rollback if $oldAutoCommit;
1304 # credit remaining time if appropriate
1305 if ( $self->part_pkg->option('unused_credit_suspend', 1) ) {
1306 my $error = $self->credit_remaining('suspend', $suspend_time);
1308 $dbh->rollback if $oldAutoCommit;
1315 foreach my $cust_svc (
1316 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1318 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1320 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1321 $dbh->rollback if $oldAutoCommit;
1322 return "Illegal svcdb value in part_svc!";
1325 require "FS/$svcdb.pm";
1327 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1329 $error = $svc->suspend;
1331 $dbh->rollback if $oldAutoCommit;
1334 my( $label, $value ) = $cust_svc->label;
1335 push @labels, "$label: $value";
1339 my $conf = new FS::Conf;
1340 if ( $conf->config('suspend_email_admin') ) {
1342 my $error = send_email(
1343 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1344 #invoice_from ??? well as good as any
1345 'to' => $conf->config('suspend_email_admin'),
1346 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1348 "This is an automatic message from your Freeside installation\n",
1349 "informing you that the following customer package has been suspended:\n",
1351 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1352 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1353 ( map { "Service : $_\n" } @labels ),
1358 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1366 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1367 $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1369 $dbh->rollback if $oldAutoCommit;
1370 return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1374 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1379 =item credit_remaining MODE TIME
1381 Generate a credit for this package for the time remaining in the current
1382 billing period. MODE is either "suspend" or "cancel" (determines the
1383 credit type). TIME is the time of suspension/cancellation. Both arguments
1388 sub credit_remaining {
1389 # Add a credit for remaining service
1390 my ($self, $mode, $time) = @_;
1391 die 'credit_remaining requires suspend or cancel'
1392 unless $mode eq 'suspend' or $mode eq 'cancel';
1393 die 'no suspend/cancel time' unless $time > 0;
1395 my $conf = FS::Conf->new;
1396 my $reason_type = $conf->config($mode.'_credit_type');
1398 my $last_bill = $self->getfield('last_bill') || 0;
1399 my $next_bill = $self->getfield('bill') || 0;
1400 if ( $last_bill > 0 # the package has been billed
1401 and $next_bill > 0 # the package has a next bill date
1402 and $next_bill >= $time # which is in the future
1404 my $remaining_value = $self->calc_remain('time' => $time);
1405 if ( $remaining_value > 0 ) {
1406 warn "Crediting for $remaining_value on package ".$self->pkgnum."\n"
1408 my $error = $self->cust_main->credit(
1410 'Credit for unused time on '. $self->part_pkg->pkg,
1411 'reason_type' => $reason_type,
1413 return "Error crediting customer \$$remaining_value for unused time".
1414 " on ". $self->part_pkg->pkg. ": $error"
1416 } #if $remaining_value
1417 } #if $last_bill, etc.
1421 =item unsuspend [ OPTION => VALUE ... ]
1423 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1424 package, then unsuspends the package itself (clears the susp field and the
1425 adjourn field if it is in the past). If the suspend reason includes an
1426 unsuspension package, that package will be ordered.
1428 Available options are:
1434 Can be set to a date to unsuspend the package in the future (the 'resume'
1437 =item adjust_next_bill
1439 Can be set true to adjust the next bill date forward by
1440 the amount of time the account was inactive. This was set true by default
1441 since 1.4.2 and 1.5.0pre6; however, starting with 1.7.0 this needs to be
1442 explicitly requested. Price plans for which this makes sense (anniversary-date
1443 based than prorate or subscription) could have an option to enable this
1448 If there is an error, returns the error, otherwise returns false.
1453 my( $self, %opt ) = @_;
1456 # pass all suspend/cancel actions to the main package
1457 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1458 return $self->main_pkg->unsuspend(%opt);
1461 local $SIG{HUP} = 'IGNORE';
1462 local $SIG{INT} = 'IGNORE';
1463 local $SIG{QUIT} = 'IGNORE';
1464 local $SIG{TERM} = 'IGNORE';
1465 local $SIG{TSTP} = 'IGNORE';
1466 local $SIG{PIPE} = 'IGNORE';
1468 my $oldAutoCommit = $FS::UID::AutoCommit;
1469 local $FS::UID::AutoCommit = 0;
1472 my $old = $self->select_for_update;
1474 my $pkgnum = $old->pkgnum;
1475 if ( $old->get('cancel') || $self->get('cancel') ) {
1476 $dbh->rollback if $oldAutoCommit;
1477 return "Can't unsuspend cancelled package $pkgnum";
1480 unless ( $old->get('susp') && $self->get('susp') ) {
1481 $dbh->rollback if $oldAutoCommit;
1482 return ""; # no error # complain instead?
1485 my $date = $opt{'date'};
1486 if ( $date and $date > time ) { # return an error if $date <= time?
1488 if ( $old->get('expire') && $old->get('expire') < $date ) {
1489 $dbh->rollback if $oldAutoCommit;
1490 return "Package $pkgnum expires before it would be unsuspended.";
1493 my $new = new FS::cust_pkg { $self->hash };
1494 $new->set('resume', $date);
1495 $error = $new->replace($self, options => $self->options);
1498 $dbh->rollback if $oldAutoCommit;
1502 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1510 foreach my $cust_svc (
1511 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1513 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1515 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1516 $dbh->rollback if $oldAutoCommit;
1517 return "Illegal svcdb value in part_svc!";
1520 require "FS/$svcdb.pm";
1522 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1524 $error = $svc->unsuspend;
1526 $dbh->rollback if $oldAutoCommit;
1529 my( $label, $value ) = $cust_svc->label;
1530 push @labels, "$label: $value";
1535 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1536 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1538 my %hash = $self->hash;
1539 my $inactive = time - $hash{'susp'};
1541 my $conf = new FS::Conf;
1543 if ( $inactive > 0 &&
1544 ( $hash{'bill'} || $hash{'setup'} ) &&
1545 ( $opt{'adjust_next_bill'} ||
1546 $conf->exists('unsuspend-always_adjust_next_bill_date') ||
1547 $self->part_pkg->option('unsuspend_adjust_bill', 1) )
1550 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1555 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1556 $hash{'resume'} = '' if !$hash{'adjourn'};
1557 my $new = new FS::cust_pkg ( \%hash );
1558 $error = $new->replace( $self, options => { $self->options } );
1560 $dbh->rollback if $oldAutoCommit;
1566 if ( $reason && $reason->unsuspend_pkgpart ) {
1567 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
1568 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
1570 my $start_date = $self->cust_main->next_bill_date
1571 if $reason->unsuspend_hold;
1574 $unsusp_pkg = FS::cust_pkg->new({
1575 'custnum' => $self->custnum,
1576 'pkgpart' => $reason->unsuspend_pkgpart,
1577 'start_date' => $start_date,
1578 'locationnum' => $self->locationnum,
1579 # discount? probably not...
1582 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
1586 $dbh->rollback if $oldAutoCommit;
1591 if ( $conf->config('unsuspend_email_admin') ) {
1593 my $error = send_email(
1594 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1595 #invoice_from ??? well as good as any
1596 'to' => $conf->config('unsuspend_email_admin'),
1597 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
1598 "This is an automatic message from your Freeside installation\n",
1599 "informing you that the following customer package has been unsuspended:\n",
1601 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1602 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1603 ( map { "Service : $_\n" } @labels ),
1605 "An unsuspension fee was charged: ".
1606 $unsusp_pkg->part_pkg->pkg_comment."\n"
1613 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
1619 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1620 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
1622 $dbh->rollback if $oldAutoCommit;
1623 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1627 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1634 Cancels any pending suspension (sets the adjourn field to null).
1636 If there is an error, returns the error, otherwise returns false.
1641 my( $self, %options ) = @_;
1644 local $SIG{HUP} = 'IGNORE';
1645 local $SIG{INT} = 'IGNORE';
1646 local $SIG{QUIT} = 'IGNORE';
1647 local $SIG{TERM} = 'IGNORE';
1648 local $SIG{TSTP} = 'IGNORE';
1649 local $SIG{PIPE} = 'IGNORE';
1651 my $oldAutoCommit = $FS::UID::AutoCommit;
1652 local $FS::UID::AutoCommit = 0;
1655 my $old = $self->select_for_update;
1657 my $pkgnum = $old->pkgnum;
1658 if ( $old->get('cancel') || $self->get('cancel') ) {
1659 dbh->rollback if $oldAutoCommit;
1660 return "Can't unadjourn cancelled package $pkgnum";
1661 # or at least it's pointless
1664 if ( $old->get('susp') || $self->get('susp') ) {
1665 dbh->rollback if $oldAutoCommit;
1666 return "Can't unadjourn suspended package $pkgnum";
1667 # perhaps this is arbitrary
1670 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1671 dbh->rollback if $oldAutoCommit;
1672 return ""; # no error
1675 my %hash = $self->hash;
1676 $hash{'adjourn'} = '';
1677 $hash{'resume'} = '';
1678 my $new = new FS::cust_pkg ( \%hash );
1679 $error = $new->replace( $self, options => { $self->options } );
1681 $dbh->rollback if $oldAutoCommit;
1685 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1692 =item change HASHREF | OPTION => VALUE ...
1694 Changes this package: cancels it and creates a new one, with a different
1695 pkgpart or locationnum or both. All services are transferred to the new
1696 package (no change will be made if this is not possible).
1698 Options may be passed as a list of key/value pairs or as a hash reference.
1705 New locationnum, to change the location for this package.
1709 New FS::cust_location object, to create a new location and assign it
1714 New FS::cust_main object, to create a new customer and assign the new package
1719 New pkgpart (see L<FS::part_pkg>).
1723 New refnum (see L<FS::part_referral>).
1727 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1728 susp, adjourn, cancel, expire, and contract_end) to the new package.
1732 At least one of locationnum, cust_location, pkgpart, refnum must be specified
1733 (otherwise, what's the point?)
1735 Returns either the new FS::cust_pkg object or a scalar error.
1739 my $err_or_new_cust_pkg = $old_cust_pkg->change
1743 #some false laziness w/order
1746 my $opt = ref($_[0]) ? shift : { @_ };
1748 # my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
1751 my $conf = new FS::Conf;
1753 # Transactionize this whole mess
1754 local $SIG{HUP} = 'IGNORE';
1755 local $SIG{INT} = 'IGNORE';
1756 local $SIG{QUIT} = 'IGNORE';
1757 local $SIG{TERM} = 'IGNORE';
1758 local $SIG{TSTP} = 'IGNORE';
1759 local $SIG{PIPE} = 'IGNORE';
1761 my $oldAutoCommit = $FS::UID::AutoCommit;
1762 local $FS::UID::AutoCommit = 0;
1771 #$hash{$_} = $self->$_() foreach qw( last_bill bill );
1773 #$hash{$_} = $self->$_() foreach qw( setup );
1775 $hash{'setup'} = $time if $self->setup;
1777 $hash{'change_date'} = $time;
1778 $hash{"change_$_"} = $self->$_()
1779 foreach qw( pkgnum pkgpart locationnum );
1781 if ( $opt->{'cust_location'} ) {
1782 $error = $opt->{'cust_location'}->find_or_insert;
1784 $dbh->rollback if $oldAutoCommit;
1785 return "inserting cust_location (transaction rolled back): $error";
1787 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1790 # whether to override pkgpart checking on the new package
1791 my $same_pkgpart = 1;
1792 if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
1796 my $unused_credit = 0;
1797 my $keep_dates = $opt->{'keep_dates'};
1798 # Special case. If the pkgpart is changing, and the customer is
1799 # going to be credited for remaining time, don't keep setup, bill,
1800 # or last_bill dates, and DO pass the flag to cancel() to credit
1802 if ( $opt->{'pkgpart'}
1803 and $opt->{'pkgpart'} != $self->pkgpart
1804 and $self->part_pkg->option('unused_credit_change', 1) ) {
1807 $hash{$_} = '' foreach qw(setup bill last_bill);
1810 if ( $keep_dates ) {
1811 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1812 resume start_date contract_end ) ) {
1813 $hash{$date} = $self->getfield($date);
1816 # allow $opt->{'locationnum'} = '' to specifically set it to null
1817 # (i.e. customer default location)
1818 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
1820 # usually this doesn't matter. the two cases where it does are:
1821 # 1. unused_credit_change + pkgpart change + setup fee on the new package
1823 # 2. (more importantly) changing a package before it's billed
1824 $hash{'waive_setup'} = $self->waive_setup;
1826 my $custnum = $self->custnum;
1827 if ( $opt->{cust_main} ) {
1828 my $cust_main = $opt->{cust_main};
1829 unless ( $cust_main->custnum ) {
1830 my $error = $cust_main->insert;
1832 $dbh->rollback if $oldAutoCommit;
1833 return "inserting cust_main (transaction rolled back): $error";
1836 $custnum = $cust_main->custnum;
1839 $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
1841 # Create the new package.
1842 my $cust_pkg = new FS::cust_pkg {
1843 custnum => $custnum,
1844 pkgpart => ( $opt->{'pkgpart'} || $self->pkgpart ),
1845 refnum => ( $opt->{'refnum'} || $self->refnum ),
1846 locationnum => ( $opt->{'locationnum'} ),
1849 $error = $cust_pkg->insert( 'change' => 1,
1850 'allow_pkgpart' => $same_pkgpart );
1852 $dbh->rollback if $oldAutoCommit;
1856 # Transfer services and cancel old package.
1858 $error = $self->transfer($cust_pkg);
1859 if ($error and $error == 0) {
1860 # $old_pkg->transfer failed.
1861 $dbh->rollback if $oldAutoCommit;
1865 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
1866 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
1867 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
1868 if ($error and $error == 0) {
1869 # $old_pkg->transfer failed.
1870 $dbh->rollback if $oldAutoCommit;
1876 # Transfers were successful, but we still had services left on the old
1877 # package. We can't change the package under this circumstances, so abort.
1878 $dbh->rollback if $oldAutoCommit;
1879 return "Unable to transfer all services from package ". $self->pkgnum;
1882 #reset usage if changing pkgpart
1883 # AND usage rollover is off (otherwise adds twice, now and at package bill)
1884 if ($self->pkgpart != $cust_pkg->pkgpart) {
1885 my $part_pkg = $cust_pkg->part_pkg;
1886 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
1890 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
1893 $dbh->rollback if $oldAutoCommit;
1894 return "Error setting usage values: $error";
1897 # if NOT changing pkgpart, transfer any usage pools over
1898 foreach my $usage ($self->cust_pkg_usage) {
1899 $usage->set('pkgnum', $cust_pkg->pkgnum);
1900 $error = $usage->replace;
1902 $dbh->rollback if $oldAutoCommit;
1903 return "Error transferring usage pools: $error";
1908 # transfer discounts, if we're not changing pkgpart
1909 if ( $same_pkgpart ) {
1910 foreach my $old_discount ($self->cust_pkg_discount_active) {
1911 # don't remove the old discount, we may still need to bill that package.
1912 my $new_discount = new FS::cust_pkg_discount {
1913 'pkgnum' => $cust_pkg->pkgnum,
1914 'discountnum' => $old_discount->discountnum,
1915 'months_used' => $old_discount->months_used,
1917 $error = $new_discount->insert;
1919 $dbh->rollback if $oldAutoCommit;
1920 return "Error transferring discounts: $error";
1925 # Order any supplemental packages.
1926 my $part_pkg = $cust_pkg->part_pkg;
1927 my @old_supp_pkgs = $self->supplemental_pkgs;
1929 foreach my $link ($part_pkg->supp_part_pkg_link) {
1931 foreach (@old_supp_pkgs) {
1932 if ($_->pkgpart == $link->dst_pkgpart) {
1934 $_->pkgpart(0); # so that it can't match more than once
1938 # false laziness with FS::cust_main::Packages::order_pkg
1939 my $new = FS::cust_pkg->new({
1940 pkgpart => $link->dst_pkgpart,
1941 pkglinknum => $link->pkglinknum,
1942 custnum => $custnum,
1943 main_pkgnum => $cust_pkg->pkgnum,
1944 locationnum => $cust_pkg->locationnum,
1945 start_date => $cust_pkg->start_date,
1946 order_date => $cust_pkg->order_date,
1947 expire => $cust_pkg->expire,
1948 adjourn => $cust_pkg->adjourn,
1949 contract_end => $cust_pkg->contract_end,
1950 refnum => $cust_pkg->refnum,
1951 discountnum => $cust_pkg->discountnum,
1952 waive_setup => $cust_pkg->waive_setup,
1954 if ( $old and $opt->{'keep_dates'} ) {
1955 foreach (qw(setup bill last_bill)) {
1956 $new->set($_, $old->get($_));
1959 $error = $new->insert( allow_pkgpart => $same_pkgpart );
1962 $error ||= $old->transfer($new);
1964 if ( $error and $error > 0 ) {
1965 # no reason why this should ever fail, but still...
1966 $error = "Unable to transfer all services from supplemental package ".
1970 $dbh->rollback if $oldAutoCommit;
1973 push @new_supp_pkgs, $new;
1976 #Good to go, cancel old package. Notify 'cancel' of whether to credit
1978 #Don't allow billing the package (preceding period packages and/or
1979 #outstanding usage) if we are keeping dates (i.e. location changing),
1980 #because the new package will be billed for the same date range.
1981 #Supplemental packages are also canceled here.
1982 $error = $self->cancel(
1984 unused_credit => $unused_credit,
1985 nobill => $keep_dates,
1986 change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
1989 $dbh->rollback if $oldAutoCommit;
1993 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
1995 my $error = $cust_pkg->cust_main->bill(
1996 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
1999 $dbh->rollback if $oldAutoCommit;
2004 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2010 =item set_quantity QUANTITY
2012 Change the package's quantity field. This is the one package property
2013 that can safely be changed without canceling and reordering the package
2014 (because it doesn't affect tax eligibility). Returns an error or an
2021 $self = $self->replace_old; # just to make sure
2023 ($qty =~ /^\d+$/ and $qty > 0) or return "bad package quantity $qty";
2024 $self->set('quantity' => $qty);
2028 use Storable 'thaw';
2030 sub process_bulk_cust_pkg {
2032 my $param = thaw(decode_base64(shift));
2033 warn Dumper($param) if $DEBUG;
2035 my $old_part_pkg = qsearchs('part_pkg',
2036 { pkgpart => $param->{'old_pkgpart'} });
2037 my $new_part_pkg = qsearchs('part_pkg',
2038 { pkgpart => $param->{'new_pkgpart'} });
2039 die "Must select a new package type\n" unless $new_part_pkg;
2040 #my $keep_dates = $param->{'keep_dates'} || 0;
2041 my $keep_dates = 1; # there is no good reason to turn this off
2043 local $SIG{HUP} = 'IGNORE';
2044 local $SIG{INT} = 'IGNORE';
2045 local $SIG{QUIT} = 'IGNORE';
2046 local $SIG{TERM} = 'IGNORE';
2047 local $SIG{TSTP} = 'IGNORE';
2048 local $SIG{PIPE} = 'IGNORE';
2050 my $oldAutoCommit = $FS::UID::AutoCommit;
2051 local $FS::UID::AutoCommit = 0;
2054 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
2057 foreach my $old_cust_pkg ( @cust_pkgs ) {
2059 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
2060 if ( $old_cust_pkg->getfield('cancel') ) {
2061 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
2062 $old_cust_pkg->pkgnum."\n"
2066 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
2068 my $error = $old_cust_pkg->change(
2069 'pkgpart' => $param->{'new_pkgpart'},
2070 'keep_dates' => $keep_dates
2072 if ( !ref($error) ) { # change returns the cust_pkg on success
2074 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
2077 $dbh->commit if $oldAutoCommit;
2083 Returns the last bill date, or if there is no last bill date, the setup date.
2084 Useful for billing metered services.
2090 return $self->setfield('last_bill', $_[0]) if @_;
2091 return $self->getfield('last_bill') if $self->getfield('last_bill');
2092 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
2093 'edate' => $self->bill, } );
2094 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
2097 =item last_cust_pkg_reason ACTION
2099 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
2100 Returns false if there is no reason or the package is not currenly ACTION'd
2101 ACTION is one of adjourn, susp, cancel, or expire.
2105 sub last_cust_pkg_reason {
2106 my ( $self, $action ) = ( shift, shift );
2107 my $date = $self->get($action);
2109 'table' => 'cust_pkg_reason',
2110 'hashref' => { 'pkgnum' => $self->pkgnum,
2111 'action' => substr(uc($action), 0, 1),
2114 'order_by' => 'ORDER BY num DESC LIMIT 1',
2118 =item last_reason ACTION
2120 Returns the most recent ACTION FS::reason associated with the package.
2121 Returns false if there is no reason or the package is not currenly ACTION'd
2122 ACTION is one of adjourn, susp, cancel, or expire.
2127 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
2128 $cust_pkg_reason->reason
2129 if $cust_pkg_reason;
2134 Returns the definition for this billing item, as an FS::part_pkg object (see
2141 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
2142 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
2143 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
2148 Returns the cancelled package this package was changed from, if any.
2154 return '' unless $self->change_pkgnum;
2155 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
2158 =item change_cust_main
2160 Returns the customter this package was detached to, if any.
2164 sub change_cust_main {
2166 return '' unless $self->change_custnum;
2167 qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
2172 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
2179 $self->part_pkg->calc_setup($self, @_);
2184 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
2191 $self->part_pkg->calc_recur($self, @_);
2196 Calls the I<base_setup> of the FS::part_pkg object associated with this billing
2203 $self->part_pkg->base_setup($self, @_);
2208 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
2215 $self->part_pkg->base_recur($self, @_);
2220 Calls the I<calc_remain> of the FS::part_pkg object associated with this
2227 $self->part_pkg->calc_remain($self, @_);
2232 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
2239 $self->part_pkg->calc_cancel($self, @_);
2244 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
2250 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
2253 =item cust_pkg_detail [ DETAILTYPE ]
2255 Returns any customer package details for this package (see
2256 L<FS::cust_pkg_detail>).
2258 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2262 sub cust_pkg_detail {
2264 my %hash = ( 'pkgnum' => $self->pkgnum );
2265 $hash{detailtype} = shift if @_;
2267 'table' => 'cust_pkg_detail',
2268 'hashref' => \%hash,
2269 'order_by' => 'ORDER BY weight, pkgdetailnum',
2273 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
2275 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
2277 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2279 If there is an error, returns the error, otherwise returns false.
2283 sub set_cust_pkg_detail {
2284 my( $self, $detailtype, @details ) = @_;
2286 local $SIG{HUP} = 'IGNORE';
2287 local $SIG{INT} = 'IGNORE';
2288 local $SIG{QUIT} = 'IGNORE';
2289 local $SIG{TERM} = 'IGNORE';
2290 local $SIG{TSTP} = 'IGNORE';
2291 local $SIG{PIPE} = 'IGNORE';
2293 my $oldAutoCommit = $FS::UID::AutoCommit;
2294 local $FS::UID::AutoCommit = 0;
2297 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
2298 my $error = $current->delete;
2300 $dbh->rollback if $oldAutoCommit;
2301 return "error removing old detail: $error";
2305 foreach my $detail ( @details ) {
2306 my $cust_pkg_detail = new FS::cust_pkg_detail {
2307 'pkgnum' => $self->pkgnum,
2308 'detailtype' => $detailtype,
2309 'detail' => $detail,
2311 my $error = $cust_pkg_detail->insert;
2313 $dbh->rollback if $oldAutoCommit;
2314 return "error adding new detail: $error";
2319 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2326 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
2330 #false laziness w/cust_bill.pm
2334 'table' => 'cust_event',
2335 'addl_from' => 'JOIN part_event USING ( eventpart )',
2336 'hashref' => { 'tablenum' => $self->pkgnum },
2337 'extra_sql' => " AND eventtable = 'cust_pkg' ",
2341 =item num_cust_event
2343 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
2347 #false laziness w/cust_bill.pm
2348 sub num_cust_event {
2351 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
2352 " WHERE tablenum = ? AND eventtable = 'cust_pkg'";
2353 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
2354 $sth->execute($self->pkgnum) or die $sth->errstr. " executing $sql";
2355 $sth->fetchrow_arrayref->[0];
2358 =item part_pkg_currency_option OPTIONNAME
2360 Returns a two item list consisting of the currency of this customer, if any,
2361 and a value for the provided option. If the customer has a currency, the value
2362 is the option value the given name and the currency (see
2363 L<FS::part_pkg_currency>). Otherwise, if the customer has no currency, is the
2364 regular option value for the given name (see L<FS::part_pkg_option>).
2368 sub part_pkg_currency_option {
2369 my( $self, $optionname ) = @_;
2370 my $part_pkg = $self->part_pkg;
2371 if ( my $currency = $self->cust_main->currency ) {
2372 ($currency, $part_pkg->part_pkg_currency_option($currency, $optionname) );
2374 ('', $part_pkg->option($optionname) );
2378 =item cust_svc [ SVCPART ] (old, deprecated usage)
2380 =item cust_svc [ OPTION => VALUE ... ] (current usage)
2382 Returns the services for this package, as FS::cust_svc objects (see
2383 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
2384 spcififed, returns only the matching services.
2391 return () unless $self->num_cust_svc(@_);
2394 if ( @_ && $_[0] =~ /^\d+/ ) {
2395 $opt{svcpart} = shift;
2396 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2403 'table' => 'cust_svc',
2404 'hashref' => { 'pkgnum' => $self->pkgnum },
2406 if ( $opt{svcpart} ) {
2407 $search{hashref}->{svcpart} = $opt{'svcpart'};
2409 if ( $opt{'svcdb'} ) {
2410 $search{addl_from} = ' LEFT JOIN part_svc USING ( svcpart ) ';
2411 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{'svcdb'} );
2414 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
2416 #if ( $self->{'_svcnum'} ) {
2417 # values %{ $self->{'_svcnum'}->cache };
2419 $self->_sort_cust_svc( [ qsearch(\%search) ] );
2424 =item overlimit [ SVCPART ]
2426 Returns the services for this package which have exceeded their
2427 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
2428 is specified, return only the matching services.
2434 return () unless $self->num_cust_svc(@_);
2435 grep { $_->overlimit } $self->cust_svc(@_);
2438 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2440 Returns historical services for this package created before END TIMESTAMP and
2441 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
2442 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
2443 I<pkg_svc.hidden> flag will be omitted.
2449 warn "$me _h_cust_svc called on $self\n"
2452 my ($end, $start, $mode) = @_;
2453 my @cust_svc = $self->_sort_cust_svc(
2454 [ qsearch( 'h_cust_svc',
2455 { 'pkgnum' => $self->pkgnum, },
2456 FS::h_cust_svc->sql_h_search(@_),
2459 if ( defined($mode) && $mode eq 'I' ) {
2460 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
2461 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
2467 sub _sort_cust_svc {
2468 my( $self, $arrayref ) = @_;
2471 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
2476 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $self->pkgpart,
2477 'svcpart' => $_->svcpart } );
2479 $pkg_svc ? $pkg_svc->primary_svc : '',
2480 $pkg_svc ? $pkg_svc->quantity : 0,
2487 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
2489 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
2491 Returns the number of services for this package. Available options are svcpart
2492 and svcdb. If either is spcififed, returns only the matching services.
2499 return $self->{'_num_cust_svc'}
2501 && exists($self->{'_num_cust_svc'})
2502 && $self->{'_num_cust_svc'} =~ /\d/;
2504 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
2508 if ( @_ && $_[0] =~ /^\d+/ ) {
2509 $opt{svcpart} = shift;
2510 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2516 my $select = 'SELECT COUNT(*) FROM cust_svc ';
2517 my $where = ' WHERE pkgnum = ? ';
2518 my @param = ($self->pkgnum);
2520 if ( $opt{'svcpart'} ) {
2521 $where .= ' AND svcpart = ? ';
2522 push @param, $opt{'svcpart'};
2524 if ( $opt{'svcdb'} ) {
2525 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
2526 $where .= ' AND svcdb = ? ';
2527 push @param, $opt{'svcdb'};
2530 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
2531 $sth->execute(@param) or die $sth->errstr;
2532 $sth->fetchrow_arrayref->[0];
2535 =item available_part_svc
2537 Returns a list of FS::part_svc objects representing services included in this
2538 package but not yet provisioned. Each FS::part_svc object also has an extra
2539 field, I<num_avail>, which specifies the number of available services.
2543 sub available_part_svc {
2546 my $pkg_quantity = $self->quantity || 1;
2548 grep { $_->num_avail > 0 }
2550 my $part_svc = $_->part_svc;
2551 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
2552 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
2554 # more evil encapsulation breakage
2555 if($part_svc->{'Hash'}{'num_avail'} > 0) {
2556 my @exports = $part_svc->part_export_did;
2557 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
2562 $self->part_pkg->pkg_svc;
2565 =item part_svc [ OPTION => VALUE ... ]
2567 Returns a list of FS::part_svc objects representing provisioned and available
2568 services included in this package. Each FS::part_svc object also has the
2569 following extra fields:
2573 =item num_cust_svc (count)
2575 =item num_avail (quantity - count)
2577 =item cust_pkg_svc (services) - array reference containing the provisioned services, as cust_svc objects
2581 Accepts one option: summarize_size. If specified and non-zero, will omit the
2582 extra cust_pkg_svc option for objects where num_cust_svc is this size or
2588 #label -> ($cust_svc->label)[1]
2594 my $pkg_quantity = $self->quantity || 1;
2596 #XXX some sort of sort order besides numeric by svcpart...
2597 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
2599 my $part_svc = $pkg_svc->part_svc;
2600 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
2601 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
2602 $part_svc->{'Hash'}{'num_avail'} =
2603 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
2604 $part_svc->{'Hash'}{'cust_pkg_svc'} =
2605 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
2606 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
2607 && $num_cust_svc >= $opt{summarize_size};
2608 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
2610 } $self->part_pkg->pkg_svc;
2613 push @part_svc, map {
2615 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
2616 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
2617 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
2618 $part_svc->{'Hash'}{'cust_pkg_svc'} =
2619 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
2621 } $self->extra_part_svc;
2627 =item extra_part_svc
2629 Returns a list of FS::part_svc objects corresponding to services in this
2630 package which are still provisioned but not (any longer) available in the
2635 sub extra_part_svc {
2638 my $pkgnum = $self->pkgnum;
2639 #my $pkgpart = $self->pkgpart;
2642 # 'table' => 'part_svc',
2645 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
2646 # WHERE pkg_svc.svcpart = part_svc.svcpart
2647 # AND pkg_svc.pkgpart = ?
2650 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
2651 # LEFT JOIN cust_pkg USING ( pkgnum )
2652 # WHERE cust_svc.svcpart = part_svc.svcpart
2655 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
2658 #seems to benchmark slightly faster... (or did?)
2660 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
2661 my $pkgparts = join(',', @pkgparts);
2664 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
2665 #MySQL doesn't grok DISINCT ON
2666 'select' => 'DISTINCT part_svc.*',
2667 'table' => 'part_svc',
2669 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
2670 AND pkg_svc.pkgpart IN ($pkgparts)
2673 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
2674 LEFT JOIN cust_pkg USING ( pkgnum )
2677 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
2678 'extra_param' => [ [$self->pkgnum=>'int'] ],
2684 Returns a short status string for this package, currently:
2688 =item not yet billed
2690 =item one-time charge
2705 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
2707 return 'cancelled' if $self->get('cancel');
2708 return 'suspended' if $self->susp;
2709 return 'not yet billed' unless $self->setup;
2710 return 'one-time charge' if $freq =~ /^(0|$)/;
2714 =item ucfirst_status
2716 Returns the status with the first character capitalized.
2720 sub ucfirst_status {
2721 ucfirst(shift->status);
2726 Class method that returns the list of possible status strings for packages
2727 (see L<the status method|/status>). For example:
2729 @statuses = FS::cust_pkg->statuses();
2733 tie my %statuscolor, 'Tie::IxHash',
2734 'not yet billed' => '009999', #teal? cyan?
2735 'one-time charge' => '000000',
2736 'active' => '00CC00',
2737 'suspended' => 'FF9900',
2738 'cancelled' => 'FF0000',
2742 my $self = shift; #could be class...
2743 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
2744 # # mayble split btw one-time vs. recur
2750 Returns a hex triplet color string for this package's status.
2756 $statuscolor{$self->status};
2761 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
2762 "pkg - comment" depending on user preference).
2768 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
2769 $label = $self->pkgnum. ": $label"
2770 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
2774 =item pkg_label_long
2776 Returns a long label for this package, adding the primary service's label to
2781 sub pkg_label_long {
2783 my $label = $self->pkg_label;
2784 my $cust_svc = $self->primary_cust_svc;
2785 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
2791 Returns a customer-localized label for this package.
2797 $self->part_pkg->pkg_locale( $self->cust_main->locale );
2800 =item primary_cust_svc
2802 Returns a primary service (as FS::cust_svc object) if one can be identified.
2806 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
2808 sub primary_cust_svc {
2811 my @cust_svc = $self->cust_svc;
2813 return '' unless @cust_svc; #no serivces - irrelevant then
2815 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
2817 # primary service as specified in the package definition
2818 # or exactly one service definition with quantity one
2819 my $svcpart = $self->part_pkg->svcpart;
2820 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
2821 return $cust_svc[0] if scalar(@cust_svc) == 1;
2823 #couldn't identify one thing..
2829 Returns a list of lists, calling the label method for all services
2830 (see L<FS::cust_svc>) of this billing item.
2836 map { [ $_->label ] } $self->cust_svc;
2839 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2841 Like the labels method, but returns historical information on services that
2842 were active as of END_TIMESTAMP and (optionally) not cancelled before
2843 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
2844 I<pkg_svc.hidden> flag will be omitted.
2846 Returns a list of lists, calling the label method for all (historical) services
2847 (see L<FS::h_cust_svc>) of this billing item.
2853 warn "$me _h_labels called on $self\n"
2855 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
2860 Like labels, except returns a simple flat list, and shortens long
2861 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2862 identical services to one line that lists the service label and the number of
2863 individual services rather than individual items.
2868 shift->_labels_short( 'labels', @_ );
2871 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
2873 Like h_labels, except returns a simple flat list, and shortens long
2874 (currently >5 or the cust_bill-max_same_services configuration value) lists of
2875 identical services to one line that lists the service label and the number of
2876 individual services rather than individual items.
2880 sub h_labels_short {
2881 shift->_labels_short( 'h_labels', @_ );
2885 my( $self, $method ) = ( shift, shift );
2887 warn "$me _labels_short called on $self with $method method\n"
2890 my $conf = new FS::Conf;
2891 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
2893 warn "$me _labels_short populating \%labels\n"
2897 #tie %labels, 'Tie::IxHash';
2898 push @{ $labels{$_->[0]} }, $_->[1]
2899 foreach $self->$method(@_);
2901 warn "$me _labels_short populating \@labels\n"
2905 foreach my $label ( keys %labels ) {
2907 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
2908 my $num = scalar(@values);
2909 warn "$me _labels_short $num items for $label\n"
2912 if ( $num > $max_same_services ) {
2913 warn "$me _labels_short more than $max_same_services, so summarizing\n"
2915 push @labels, "$label ($num)";
2917 if ( $conf->exists('cust_bill-consolidate_services') ) {
2918 warn "$me _labels_short consolidating services\n"
2920 # push @labels, "$label: ". join(', ', @values);
2922 my $detail = "$label: ";
2923 $detail .= shift(@values). ', '
2925 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
2927 push @labels, $detail;
2929 warn "$me _labels_short done consolidating services\n"
2932 warn "$me _labels_short adding service data\n"
2934 push @labels, map { "$label: $_" } @values;
2945 Returns the parent customer object (see L<FS::cust_main>).
2951 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
2956 Returns the balance for this specific package, when using
2957 experimental package balance.
2963 $self->cust_main->balance_pkgnum( $self->pkgnum );
2966 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
2970 Returns the location object, if any (see L<FS::cust_location>).
2972 =item cust_location_or_main
2974 If this package is associated with a location, returns the locaiton (see
2975 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
2977 =item location_label [ OPTION => VALUE ... ]
2979 Returns the label of the location object (see L<FS::cust_location>).
2983 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
2985 =item tax_locationnum
2987 Returns the foreign key to a L<FS::cust_location> object for calculating
2988 tax on this package, as determined by the C<tax-pkg_address> and
2989 C<tax-ship_address> configuration flags.
2993 sub tax_locationnum {
2995 my $conf = FS::Conf->new;
2996 if ( $conf->exists('tax-pkg_address') ) {
2997 return $self->locationnum;
2999 elsif ( $conf->exists('tax-ship_address') ) {
3000 return $self->cust_main->ship_locationnum;
3003 return $self->cust_main->bill_locationnum;
3009 Returns the L<FS::cust_location> object for tax_locationnum.
3015 FS::cust_location->by_key( $self->tax_locationnum )
3018 =item seconds_since TIMESTAMP
3020 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
3021 package have been online since TIMESTAMP, according to the session monitor.
3023 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
3024 L<Time::Local> and L<Date::Parse> for conversion functions.
3029 my($self, $since) = @_;
3032 foreach my $cust_svc (
3033 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
3035 $seconds += $cust_svc->seconds_since($since);
3042 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
3044 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
3045 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
3048 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3049 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3055 sub seconds_since_sqlradacct {
3056 my($self, $start, $end) = @_;
3060 foreach my $cust_svc (
3062 my $part_svc = $_->part_svc;
3063 $part_svc->svcdb eq 'svc_acct'
3064 && scalar($part_svc->part_export_usage);
3067 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
3074 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
3076 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
3077 in this package for sessions ending between TIMESTAMP_START (inclusive) and
3081 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3082 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3087 sub attribute_since_sqlradacct {
3088 my($self, $start, $end, $attrib) = @_;
3092 foreach my $cust_svc (
3094 my $part_svc = $_->part_svc;
3095 $part_svc->svcdb eq 'svc_acct'
3096 && scalar($part_svc->part_export_usage);
3099 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
3111 my( $self, $value ) = @_;
3112 if ( defined($value) ) {
3113 $self->setfield('quantity', $value);
3115 $self->getfield('quantity') || 1;
3118 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
3120 Transfers as many services as possible from this package to another package.
3122 The destination package can be specified by pkgnum by passing an FS::cust_pkg
3123 object. The destination package must already exist.
3125 Services are moved only if the destination allows services with the correct
3126 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
3127 this option with caution! No provision is made for export differences
3128 between the old and new service definitions. Probably only should be used
3129 when your exports for all service definitions of a given svcdb are identical.
3130 (attempt a transfer without it first, to move all possible svcpart-matching
3133 Any services that can't be moved remain in the original package.
3135 Returns an error, if there is one; otherwise, returns the number of services
3136 that couldn't be moved.
3141 my ($self, $dest_pkgnum, %opt) = @_;
3147 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
3148 $dest = $dest_pkgnum;
3149 $dest_pkgnum = $dest->pkgnum;
3151 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
3154 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
3156 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
3157 $target{$pkg_svc->svcpart} = $pkg_svc->quantity;
3160 foreach my $cust_svc ($dest->cust_svc) {
3161 $target{$cust_svc->svcpart}--;
3164 my %svcpart2svcparts = ();
3165 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3166 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
3167 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
3168 next if exists $svcpart2svcparts{$svcpart};
3169 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
3170 $svcpart2svcparts{$svcpart} = [
3172 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
3174 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
3175 'svcpart' => $_ } );
3177 $pkg_svc ? $pkg_svc->primary_svc : '',
3178 $pkg_svc ? $pkg_svc->quantity : 0,
3182 grep { $_ != $svcpart }
3184 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
3186 warn "alternates for svcpart $svcpart: ".
3187 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
3192 foreach my $cust_svc ($self->cust_svc) {
3193 if($target{$cust_svc->svcpart} > 0
3194 or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
3195 $target{$cust_svc->svcpart}--;
3196 my $new = new FS::cust_svc { $cust_svc->hash };
3197 $new->pkgnum($dest_pkgnum);
3198 my $error = $new->replace($cust_svc);
3199 return $error if $error;
3200 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3202 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
3203 warn "alternates to consider: ".
3204 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
3206 my @alternate = grep {
3207 warn "considering alternate svcpart $_: ".
3208 "$target{$_} available in new package\n"
3211 } @{$svcpart2svcparts{$cust_svc->svcpart}};
3213 warn "alternate(s) found\n" if $DEBUG;
3214 my $change_svcpart = $alternate[0];
3215 $target{$change_svcpart}--;
3216 my $new = new FS::cust_svc { $cust_svc->hash };
3217 $new->svcpart($change_svcpart);
3218 $new->pkgnum($dest_pkgnum);
3219 my $error = $new->replace($cust_svc);
3220 return $error if $error;
3231 =item grab_svcnums SVCNUM, SVCNUM ...
3233 Change the pkgnum for the provided services to this packages. If there is an
3234 error, returns the error, otherwise returns false.
3242 local $SIG{HUP} = 'IGNORE';
3243 local $SIG{INT} = 'IGNORE';
3244 local $SIG{QUIT} = 'IGNORE';
3245 local $SIG{TERM} = 'IGNORE';
3246 local $SIG{TSTP} = 'IGNORE';
3247 local $SIG{PIPE} = 'IGNORE';
3249 my $oldAutoCommit = $FS::UID::AutoCommit;
3250 local $FS::UID::AutoCommit = 0;
3253 foreach my $svcnum (@svcnum) {
3254 my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
3255 $dbh->rollback if $oldAutoCommit;
3256 return "unknown svcnum $svcnum";
3258 $cust_svc->pkgnum( $self->pkgnum );
3259 my $error = $cust_svc->replace;
3261 $dbh->rollback if $oldAutoCommit;
3266 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3273 This method is deprecated. See the I<depend_jobnum> option to the insert and
3274 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
3278 #looks like this is still used by the order_pkg and change_pkg methods in
3279 # ClientAPI/MyAccount, need to look into those before removing
3283 local $SIG{HUP} = 'IGNORE';
3284 local $SIG{INT} = 'IGNORE';
3285 local $SIG{QUIT} = 'IGNORE';
3286 local $SIG{TERM} = 'IGNORE';
3287 local $SIG{TSTP} = 'IGNORE';
3288 local $SIG{PIPE} = 'IGNORE';
3290 my $oldAutoCommit = $FS::UID::AutoCommit;
3291 local $FS::UID::AutoCommit = 0;
3294 foreach my $cust_svc ( $self->cust_svc ) {
3295 #false laziness w/svc_Common::insert
3296 my $svc_x = $cust_svc->svc_x;
3297 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
3298 my $error = $part_export->export_insert($svc_x);
3300 $dbh->rollback if $oldAutoCommit;
3306 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3313 Associates this package with a (suspension or cancellation) reason (see
3314 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
3317 Available options are:
3323 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.
3327 the access_user (see L<FS::access_user>) providing the reason
3335 the action (cancel, susp, adjourn, expire) associated with the reason
3339 If there is an error, returns the error, otherwise returns false.
3344 my ($self, %options) = @_;
3346 my $otaker = $options{reason_otaker} ||
3347 $FS::CurrentUser::CurrentUser->username;
3350 if ( $options{'reason'} =~ /^(\d+)$/ ) {
3354 } elsif ( ref($options{'reason'}) ) {
3356 return 'Enter a new reason (or select an existing one)'
3357 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
3359 my $reason = new FS::reason({
3360 'reason_type' => $options{'reason'}->{'typenum'},
3361 'reason' => $options{'reason'}->{'reason'},
3363 my $error = $reason->insert;
3364 return $error if $error;
3366 $reasonnum = $reason->reasonnum;
3369 return "Unparsable reason: ". $options{'reason'};
3372 my $cust_pkg_reason =
3373 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
3374 'reasonnum' => $reasonnum,
3375 'otaker' => $otaker,
3376 'action' => substr(uc($options{'action'}),0,1),
3377 'date' => $options{'date'}
3382 $cust_pkg_reason->insert;
3385 =item insert_discount
3387 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
3388 inserting a new discount on the fly (see L<FS::discount>).
3390 Available options are:
3398 If there is an error, returns the error, otherwise returns false.
3402 sub insert_discount {
3403 #my ($self, %options) = @_;
3406 my $cust_pkg_discount = new FS::cust_pkg_discount {
3407 'pkgnum' => $self->pkgnum,
3408 'discountnum' => $self->discountnum,
3410 'end_date' => '', #XXX
3411 #for the create a new discount case
3412 '_type' => $self->discountnum__type,
3413 'amount' => $self->discountnum_amount,
3414 'percent' => $self->discountnum_percent,
3415 'months' => $self->discountnum_months,
3416 'setup' => $self->discountnum_setup,
3417 #'disabled' => $self->discountnum_disabled,
3420 $cust_pkg_discount->insert;
3423 =item set_usage USAGE_VALUE_HASHREF
3425 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
3426 to which they should be set (see L<FS::svc_acct>). Currently seconds,
3427 upbytes, downbytes, and totalbytes are appropriate keys.
3429 All svc_accts which are part of this package have their values reset.
3434 my ($self, $valueref, %opt) = @_;
3436 #only svc_acct can set_usage for now
3437 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
3438 my $svc_x = $cust_svc->svc_x;
3439 $svc_x->set_usage($valueref, %opt)
3440 if $svc_x->can("set_usage");
3444 =item recharge USAGE_VALUE_HASHREF
3446 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
3447 to which they should be set (see L<FS::svc_acct>). Currently seconds,
3448 upbytes, downbytes, and totalbytes are appropriate keys.
3450 All svc_accts which are part of this package have their values incremented.
3455 my ($self, $valueref) = @_;
3457 #only svc_acct can set_usage for now
3458 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
3459 my $svc_x = $cust_svc->svc_x;
3460 $svc_x->recharge($valueref)
3461 if $svc_x->can("recharge");
3465 =item cust_pkg_discount
3469 sub cust_pkg_discount {
3471 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
3474 =item cust_pkg_discount_active
3478 sub cust_pkg_discount_active {
3480 grep { $_->status eq 'active' } $self->cust_pkg_discount;
3483 =item cust_pkg_usage
3485 Returns a list of all voice usage counters attached to this package.
3489 sub cust_pkg_usage {
3491 qsearch('cust_pkg_usage', { pkgnum => $self->pkgnum });
3494 =item apply_usage OPTIONS
3496 Takes the following options:
3497 - cdr: a call detail record (L<FS::cdr>)
3498 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
3499 - minutes: the maximum number of minutes to be charged
3501 Finds available usage minutes for a call of this class, and subtracts
3502 up to that many minutes from the usage pool. If the usage pool is empty,
3503 and the C<cdr-minutes_priority> global config option is set, minutes may
3504 be taken from other calls as well. Either way, an allocation record will
3505 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
3506 number of minutes of usage applied to the call.
3511 my ($self, %opt) = @_;
3512 my $cdr = $opt{cdr};
3513 my $rate_detail = $opt{rate_detail};
3514 my $minutes = $opt{minutes};
3515 my $classnum = $rate_detail->classnum;
3516 my $pkgnum = $self->pkgnum;
3517 my $custnum = $self->custnum;
3519 local $SIG{HUP} = 'IGNORE';
3520 local $SIG{INT} = 'IGNORE';
3521 local $SIG{QUIT} = 'IGNORE';
3522 local $SIG{TERM} = 'IGNORE';
3523 local $SIG{TSTP} = 'IGNORE';
3524 local $SIG{PIPE} = 'IGNORE';
3526 my $oldAutoCommit = $FS::UID::AutoCommit;
3527 local $FS::UID::AutoCommit = 0;
3529 my $order = FS::Conf->new->config('cdr-minutes_priority');
3533 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
3535 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
3537 my @usage_recs = qsearch({
3538 'table' => 'cust_pkg_usage',
3539 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
3540 ' JOIN cust_pkg USING (pkgnum)'.
3541 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
3542 'select' => 'cust_pkg_usage.*',
3543 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
3544 " ( cust_pkg.custnum = $custnum AND ".
3545 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
3546 $is_classnum . ' AND '.
3547 " cust_pkg_usage.minutes > 0",
3548 'order_by' => " ORDER BY priority ASC",
3551 my $orig_minutes = $minutes;
3553 while (!$error and $minutes > 0 and @usage_recs) {
3554 my $cust_pkg_usage = shift @usage_recs;
3555 $cust_pkg_usage->select_for_update;
3556 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
3557 pkgusagenum => $cust_pkg_usage->pkgusagenum,
3558 acctid => $cdr->acctid,
3559 minutes => min($cust_pkg_usage->minutes, $minutes),
3561 $cust_pkg_usage->set('minutes',
3562 sprintf('%.0f', $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes)
3564 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
3565 $minutes -= $cdr_cust_pkg_usage->minutes;
3567 if ( $order and $minutes > 0 and !$error ) {
3568 # then try to steal minutes from another call
3570 'table' => 'cdr_cust_pkg_usage',
3571 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
3572 ' JOIN part_pkg_usage USING (pkgusagepart)'.
3573 ' JOIN cust_pkg USING (pkgnum)'.
3574 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
3575 ' JOIN cdr USING (acctid)',
3576 'select' => 'cdr_cust_pkg_usage.*',
3577 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
3578 " ( cust_pkg.pkgnum = $pkgnum OR ".
3579 " ( cust_pkg.custnum = $custnum AND ".
3580 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
3581 " part_pkg_usage_class.classnum = $classnum",
3582 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
3584 if ( $order eq 'time' ) {
3585 # find CDRs that are using minutes, but have a later startdate
3587 my $startdate = $cdr->startdate;
3588 if ($startdate !~ /^\d+$/) {
3589 die "bad cdr startdate '$startdate'";
3591 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
3592 # minimize needless reshuffling
3593 $search{'order_by'} .= ', cdr.startdate DESC';
3595 # XXX may not work correctly with rate_time schedules. Could
3596 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
3598 $search{'addl_from'} .=
3599 ' JOIN rate_detail'.
3600 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
3601 if ( $order eq 'rate_high' ) {
3602 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
3603 $rate_detail->min_charge;
3604 $search{'order_by'} .= ', rate_detail.min_charge ASC';
3605 } elsif ( $order eq 'rate_low' ) {
3606 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
3607 $rate_detail->min_charge;
3608 $search{'order_by'} .= ', rate_detail.min_charge DESC';
3610 # this should really never happen
3611 die "invalid cdr-minutes_priority value '$order'\n";
3614 my @cdr_usage_recs = qsearch(\%search);
3616 while (!$error and @cdr_usage_recs and $minutes > 0) {
3617 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
3618 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
3619 my $old_cdr = $cdr_cust_pkg_usage->cdr;
3620 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
3621 $cdr_cust_pkg_usage->select_for_update;
3622 $old_cdr->select_for_update;
3623 $cust_pkg_usage->select_for_update;
3624 # in case someone else stole the usage from this CDR
3625 # while waiting for the lock...
3626 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
3627 # steal the usage allocation and flag the old CDR for reprocessing
3628 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
3629 # if the allocation is more minutes than we need, adjust it...
3630 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
3632 $cdr_cust_pkg_usage->set('minutes', $minutes);
3633 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
3634 $error = $cust_pkg_usage->replace;
3636 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
3637 $error ||= $cdr_cust_pkg_usage->replace;
3638 # deduct the stolen minutes
3639 $minutes -= $cdr_cust_pkg_usage->minutes;
3641 # after all minute-stealing is done, reset the affected CDRs
3642 foreach (values %reproc_cdrs) {
3643 $error ||= $_->set_status('');
3644 # XXX or should we just call $cdr->rate right here?
3645 # it's not like we can create a loop this way, since the min_charge
3646 # or call time has to go monotonically in one direction.
3647 # we COULD get some very deep recursions going, though...
3649 } # if $order and $minutes
3652 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
3654 $dbh->commit if $oldAutoCommit;
3655 return $orig_minutes - $minutes;
3659 =item supplemental_pkgs
3661 Returns a list of all packages supplemental to this one.
3665 sub supplemental_pkgs {
3667 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
3672 Returns the package that this one is supplemental to, if any.
3678 if ( $self->main_pkgnum ) {
3679 return FS::cust_pkg->by_key($self->main_pkgnum);
3686 =head1 CLASS METHODS
3692 Returns an SQL expression identifying recurring packages.
3696 sub recurring_sql { "
3697 '0' != ( select freq from part_pkg
3698 where cust_pkg.pkgpart = part_pkg.pkgpart )
3703 Returns an SQL expression identifying one-time packages.
3708 '0' = ( select freq from part_pkg
3709 where cust_pkg.pkgpart = part_pkg.pkgpart )
3714 Returns an SQL expression identifying ordered packages (recurring packages not
3720 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
3725 Returns an SQL expression identifying active packages.
3730 $_[0]->recurring_sql. "
3731 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
3732 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3733 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
3736 =item not_yet_billed_sql
3738 Returns an SQL expression identifying packages which have not yet been billed.
3742 sub not_yet_billed_sql { "
3743 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
3744 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3745 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
3750 Returns an SQL expression identifying inactive packages (one-time packages
3751 that are otherwise unsuspended/uncancelled).
3755 sub inactive_sql { "
3756 ". $_[0]->onetime_sql(). "
3757 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
3758 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3759 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
3765 Returns an SQL expression identifying suspended packages.
3769 sub suspended_sql { susp_sql(@_); }
3771 #$_[0]->recurring_sql(). ' AND '.
3773 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3774 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
3781 Returns an SQL exprression identifying cancelled packages.
3785 sub cancelled_sql { cancel_sql(@_); }
3787 #$_[0]->recurring_sql(). ' AND '.
3788 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
3793 Returns an SQL expression to give the package status as a string.
3799 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
3800 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
3801 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
3802 WHEN ".onetime_sql()." THEN 'one-time charge'
3807 =item search HASHREF
3811 Returns a qsearch hash expression to search for parameters specified in HASHREF.
3812 Valid parameters are
3820 active, inactive, suspended, cancel (or cancelled)
3824 active, inactive, suspended, one-time charge, inactive, cancel (or cancelled)
3828 boolean selects custom packages
3834 pkgpart or arrayref or hashref of pkgparts
3838 arrayref of beginning and ending epoch date
3842 arrayref of beginning and ending epoch date
3846 arrayref of beginning and ending epoch date
3850 arrayref of beginning and ending epoch date
3854 arrayref of beginning and ending epoch date
3858 arrayref of beginning and ending epoch date
3862 arrayref of beginning and ending epoch date
3866 pkgnum or APKG_pkgnum
3870 a value suited to passing to FS::UI::Web::cust_header
3874 specifies the user for agent virtualization
3878 boolean; if true, returns only packages with more than 0 FCC phone lines.
3880 =item state, country
3882 Limit to packages with a service location in the specified state and country.
3883 For FCC 477 reporting, mostly.
3890 my ($class, $params) = @_;
3897 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
3899 "cust_main.agentnum = $1";
3906 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
3908 "cust_pkg.custnum = $1";
3915 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
3917 "cust_pkg.pkgbatch = '$1'";
3924 if ( $params->{'magic'} eq 'active'
3925 || $params->{'status'} eq 'active' ) {
3927 push @where, FS::cust_pkg->active_sql();
3929 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
3930 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
3932 push @where, FS::cust_pkg->not_yet_billed_sql();
3934 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
3935 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
3937 push @where, FS::cust_pkg->inactive_sql();
3939 } elsif ( $params->{'magic'} eq 'suspended'
3940 || $params->{'status'} eq 'suspended' ) {
3942 push @where, FS::cust_pkg->suspended_sql();
3944 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
3945 || $params->{'status'} =~ /^cancell?ed$/ ) {
3947 push @where, FS::cust_pkg->cancelled_sql();
3952 # parse package class
3955 if ( exists($params->{'classnum'}) ) {
3958 if ( ref($params->{'classnum'}) ) {
3960 if ( ref($params->{'classnum'}) eq 'HASH' ) {
3961 @classnum = grep $params->{'classnum'}{$_}, keys %{ $params->{'classnum'} };
3962 } elsif ( ref($params->{'classnum'}) eq 'ARRAY' ) {
3963 @classnum = @{ $params->{'classnum'} };
3965 die 'unhandled classnum ref '. $params->{'classnum'};
3969 } elsif ( $params->{'classnum'} =~ /^(\d*)$/ && $1 ne '0' ) {
3976 my @nums = grep $_, @classnum;
3977 push @c_where, 'part_pkg.classnum IN ('. join(',',@nums). ')' if @nums;
3978 my $null = scalar( grep { $_ eq '' } @classnum );
3979 push @c_where, 'part_pkg.classnum IS NULL' if $null;
3981 if ( scalar(@c_where) == 1 ) {
3982 push @where, @c_where;
3983 } elsif ( @c_where ) {
3984 push @where, ' ( '. join(' OR ', @c_where). ' ) ';
3993 # parse package report options
3996 my @report_option = ();
3997 if ( exists($params->{'report_option'}) ) {
3998 if ( ref($params->{'report_option'}) eq 'ARRAY' ) {
3999 @report_option = @{ $params->{'report_option'} };
4000 } elsif ( $params->{'report_option'} =~ /^([,\d]*)$/ ) {
4001 @report_option = split(',', $1);
4006 if (@report_option) {
4007 # this will result in the empty set for the dangling comma case as it should
4009 map{ "0 < ( SELECT count(*) FROM part_pkg_option
4010 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
4011 AND optionname = 'report_option_$_'
4012 AND optionvalue = '1' )"
4016 foreach my $any ( grep /^report_option_any/, keys %$params ) {
4018 my @report_option_any = ();
4019 if ( ref($params->{$any}) eq 'ARRAY' ) {
4020 @report_option_any = @{ $params->{$any} };
4021 } elsif ( $params->{$any} =~ /^([,\d]*)$/ ) {
4022 @report_option_any = split(',', $1);
4025 if (@report_option_any) {
4026 # this will result in the empty set for the dangling comma case as it should
4027 push @where, ' ( '. join(' OR ',
4028 map{ "0 < ( SELECT count(*) FROM part_pkg_option
4029 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
4030 AND optionname = 'report_option_$_'
4031 AND optionvalue = '1' )"
4032 } @report_option_any
4042 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
4048 push @where, "(part_pkg.fcc_ds0s > 0 OR pkg_class.fcc_ds0s > 0)"
4049 if $params->{fcc_line};
4055 if ( exists($params->{'censustract'}) ) {
4056 $params->{'censustract'} =~ /^([.\d]*)$/;
4057 my $censustract = "cust_location.censustract = '$1'";
4058 $censustract .= ' OR cust_location.censustract is NULL' unless $1;
4059 push @where, "( $censustract )";
4063 # parse censustract2
4065 if ( exists($params->{'censustract2'})
4066 && $params->{'censustract2'} =~ /^(\d*)$/
4070 push @where, "cust_location.censustract LIKE '$1%'";
4073 "( cust_location.censustract = '' OR cust_location.censustract IS NULL )";
4078 # parse country/state
4080 for (qw(state country)) { # parsing rules are the same for these
4081 if ( exists($params->{$_})
4082 && uc($params->{$_}) =~ /^([A-Z]{2})$/ )
4084 # XXX post-2.3 only--before that, state/country may be in cust_main
4085 push @where, "cust_location.$_ = '$1'";
4093 if ( ref($params->{'pkgpart'}) ) {
4096 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
4097 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
4098 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
4099 @pkgpart = @{ $params->{'pkgpart'} };
4101 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
4104 @pkgpart = grep /^(\d+)$/, @pkgpart;
4106 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
4108 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
4109 push @where, "pkgpart = $1";
4118 #false laziness w/report_cust_pkg.html
4121 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
4122 'active' => { 'susp'=>1, 'cancel'=>1 },
4123 'suspended' => { 'cancel' => 1 },
4128 if( exists($params->{'active'} ) ) {
4129 # This overrides all the other date-related fields
4130 my($beginning, $ending) = @{$params->{'active'}};
4132 "cust_pkg.setup IS NOT NULL",
4133 "cust_pkg.setup <= $ending",
4134 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
4135 "NOT (".FS::cust_pkg->onetime_sql . ")";
4138 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end change_date cancel )) {
4140 next unless exists($params->{$field});
4142 my($beginning, $ending) = @{$params->{$field}};
4144 next if $beginning == 0 && $ending == 4294967295;
4147 "cust_pkg.$field IS NOT NULL",
4148 "cust_pkg.$field >= $beginning",
4149 "cust_pkg.$field <= $ending";
4151 $orderby ||= "ORDER BY cust_pkg.$field";
4156 $orderby ||= 'ORDER BY bill';
4159 # parse magic, legacy, etc.
4162 if ( $params->{'magic'} &&
4163 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
4166 $orderby = 'ORDER BY pkgnum';
4168 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
4169 push @where, "pkgpart = $1";
4172 } elsif ( $params->{'query'} eq 'pkgnum' ) {
4174 $orderby = 'ORDER BY pkgnum';
4176 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
4178 $orderby = 'ORDER BY pkgnum';
4181 SELECT count(*) FROM pkg_svc
4182 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
4183 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
4184 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
4185 AND cust_svc.svcpart = pkg_svc.svcpart
4192 # setup queries, links, subs, etc. for the search
4195 # here is the agent virtualization
4196 if ($params->{CurrentUser}) {
4198 qsearchs('access_user', { username => $params->{CurrentUser} });
4201 push @where, $access_user->agentnums_sql('table'=>'cust_main');
4206 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
4209 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
4211 my $addl_from = 'LEFT JOIN part_pkg USING ( pkgpart ) '.
4212 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) '.
4213 'LEFT JOIN cust_location USING ( locationnum ) '.
4214 FS::UI::Web::join_cust_main('cust_pkg', 'cust_pkg');
4218 if ( $params->{'select_zip5'} ) {
4219 my $zip = 'cust_location.zip';
4221 $select = "DISTINCT substr($zip,1,5) as zip";
4222 $orderby = "ORDER BY substr($zip,1,5)";
4223 $count_query = "SELECT COUNT( DISTINCT substr($zip,1,5) )";
4225 $select = join(', ',
4227 ( map "part_pkg.$_", qw( pkg freq ) ),
4228 'pkg_class.classname',
4229 'cust_main.custnum AS cust_main_custnum',
4230 FS::UI::Web::cust_sql_fields(
4231 $params->{'cust_fields'}
4234 $count_query = 'SELECT COUNT(*)';
4237 $count_query .= " FROM cust_pkg $addl_from $extra_sql";
4240 'table' => 'cust_pkg',
4242 'select' => $select,
4243 'extra_sql' => $extra_sql,
4244 'order_by' => $orderby,
4245 'addl_from' => $addl_from,
4246 'count_query' => $count_query,
4253 Returns a list of two package counts. The first is a count of packages
4254 based on the supplied criteria and the second is the count of residential
4255 packages with those same criteria. Criteria are specified as in the search
4261 my ($class, $params) = @_;
4263 my $sql_query = $class->search( $params );
4265 my $count_sql = delete($sql_query->{'count_query'});
4266 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
4267 or die "couldn't parse count_sql";
4269 my $count_sth = dbh->prepare($count_sql)
4270 or die "Error preparing $count_sql: ". dbh->errstr;
4272 or die "Error executing $count_sql: ". $count_sth->errstr;
4273 my $count_arrayref = $count_sth->fetchrow_arrayref;
4275 return ( @$count_arrayref );
4279 =item tax_locationnum_sql
4281 Returns an SQL expression for the tax location for a package, based
4282 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
4286 sub tax_locationnum_sql {
4287 my $conf = FS::Conf->new;
4288 if ( $conf->exists('tax-pkg_address') ) {
4289 'cust_pkg.locationnum';
4291 elsif ( $conf->exists('tax-ship_address') ) {
4292 'cust_main.ship_locationnum';
4295 'cust_main.bill_locationnum';
4301 Returns a list: the first item is an SQL fragment identifying matching
4302 packages/customers via location (taking into account shipping and package
4303 address taxation, if enabled), and subsequent items are the parameters to
4304 substitute for the placeholders in that fragment.
4309 my($class, %opt) = @_;
4310 my $ornull = $opt{'ornull'};
4312 my $conf = new FS::Conf;
4314 # '?' placeholders in _location_sql_where
4315 my $x = $ornull ? 3 : 2;
4326 if ( $conf->exists('tax-ship_address') ) {
4329 ( ( ship_last IS NULL OR ship_last = '' )
4330 AND ". _location_sql_where('cust_main', '', $ornull ). "
4332 OR ( ship_last IS NOT NULL AND ship_last != ''
4333 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
4336 # AND payby != 'COMP'
4338 @main_param = ( @bill_param, @bill_param );
4342 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
4343 @main_param = @bill_param;
4349 if ( $conf->exists('tax-pkg_address') ) {
4351 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
4354 ( cust_pkg.locationnum IS NULL AND $main_where )
4355 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
4358 @param = ( @main_param, @bill_param );
4362 $where = $main_where;
4363 @param = @main_param;
4371 #subroutine, helper for location_sql
4372 sub _location_sql_where {
4374 my $prefix = @_ ? shift : '';
4375 my $ornull = @_ ? shift : '';
4377 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
4379 $ornull = $ornull ? ' OR ? IS NULL ' : '';
4381 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
4382 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
4383 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
4385 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
4387 # ( $table.${prefix}city = ? $or_empty_city $ornull )
4389 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4390 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4391 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
4392 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
4393 AND $table.${prefix}country = ?
4398 my( $self, $what ) = @_;
4400 my $what_show_zero = $what. '_show_zero';
4401 length($self->$what_show_zero())
4402 ? ($self->$what_show_zero() eq 'Y')
4403 : $self->part_pkg->$what_show_zero();
4410 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
4412 CUSTNUM is a customer (see L<FS::cust_main>)
4414 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4415 L<FS::part_pkg>) to order for this customer. Duplicates are of course
4418 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
4419 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
4420 new billing items. An error is returned if this is not possible (see
4421 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
4424 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4425 newly-created cust_pkg objects.
4427 REFNUM, if specified, will specify the FS::pkg_referral record to be created
4428 and inserted. Multiple FS::pkg_referral records can be created by
4429 setting I<refnum> to an array reference of refnums or a hash reference with
4430 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
4431 record will be created corresponding to cust_main.refnum.
4436 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
4438 my $conf = new FS::Conf;
4440 # Transactionize this whole mess
4441 local $SIG{HUP} = 'IGNORE';
4442 local $SIG{INT} = 'IGNORE';
4443 local $SIG{QUIT} = 'IGNORE';
4444 local $SIG{TERM} = 'IGNORE';
4445 local $SIG{TSTP} = 'IGNORE';
4446 local $SIG{PIPE} = 'IGNORE';
4448 my $oldAutoCommit = $FS::UID::AutoCommit;
4449 local $FS::UID::AutoCommit = 0;
4453 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
4454 # return "Customer not found: $custnum" unless $cust_main;
4456 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
4459 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4462 my $change = scalar(@old_cust_pkg) != 0;
4465 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
4467 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
4468 " to pkgpart ". $pkgparts->[0]. "\n"
4471 my $err_or_cust_pkg =
4472 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
4473 'refnum' => $refnum,
4476 unless (ref($err_or_cust_pkg)) {
4477 $dbh->rollback if $oldAutoCommit;
4478 return $err_or_cust_pkg;
4481 push @$return_cust_pkg, $err_or_cust_pkg;
4482 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4487 # Create the new packages.
4488 foreach my $pkgpart (@$pkgparts) {
4490 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
4492 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
4493 pkgpart => $pkgpart,
4497 $error = $cust_pkg->insert( 'change' => $change );
4498 push @$return_cust_pkg, $cust_pkg;
4500 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
4501 my $supp_pkg = FS::cust_pkg->new({
4502 custnum => $custnum,
4503 pkgpart => $link->dst_pkgpart,
4505 main_pkgnum => $cust_pkg->pkgnum,
4508 $error ||= $supp_pkg->insert( 'change' => $change );
4509 push @$return_cust_pkg, $supp_pkg;
4513 $dbh->rollback if $oldAutoCommit;
4518 # $return_cust_pkg now contains refs to all of the newly
4521 # Transfer services and cancel old packages.
4522 foreach my $old_pkg (@old_cust_pkg) {
4524 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
4527 foreach my $new_pkg (@$return_cust_pkg) {
4528 $error = $old_pkg->transfer($new_pkg);
4529 if ($error and $error == 0) {
4530 # $old_pkg->transfer failed.
4531 $dbh->rollback if $oldAutoCommit;
4536 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
4537 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
4538 foreach my $new_pkg (@$return_cust_pkg) {
4539 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
4540 if ($error and $error == 0) {
4541 # $old_pkg->transfer failed.
4542 $dbh->rollback if $oldAutoCommit;
4549 # Transfers were successful, but we went through all of the
4550 # new packages and still had services left on the old package.
4551 # We can't cancel the package under the circumstances, so abort.
4552 $dbh->rollback if $oldAutoCommit;
4553 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
4555 $error = $old_pkg->cancel( quiet=>1 );
4561 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4565 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
4567 A bulk change method to change packages for multiple customers.
4569 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4570 L<FS::part_pkg>) to order for each customer. Duplicates are of course
4573 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
4574 replace. The services (see L<FS::cust_svc>) are moved to the
4575 new billing items. An error is returned if this is not possible (see
4578 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4579 newly-created cust_pkg objects.
4584 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
4586 # Transactionize this whole mess
4587 local $SIG{HUP} = 'IGNORE';
4588 local $SIG{INT} = 'IGNORE';
4589 local $SIG{QUIT} = 'IGNORE';
4590 local $SIG{TERM} = 'IGNORE';
4591 local $SIG{TSTP} = 'IGNORE';
4592 local $SIG{PIPE} = 'IGNORE';
4594 my $oldAutoCommit = $FS::UID::AutoCommit;
4595 local $FS::UID::AutoCommit = 0;
4599 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4602 while(scalar(@old_cust_pkg)) {
4604 my $custnum = $old_cust_pkg[0]->custnum;
4605 my (@remove) = map { $_->pkgnum }
4606 grep { $_->custnum == $custnum } @old_cust_pkg;
4607 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
4609 my $error = order $custnum, $pkgparts, \@remove, \@return;
4611 push @errors, $error
4613 push @$return_cust_pkg, @return;
4616 if (scalar(@errors)) {
4617 $dbh->rollback if $oldAutoCommit;
4618 return join(' / ', @errors);
4621 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4625 # Used by FS::Upgrade to migrate to a new database.
4626 sub _upgrade_data { # class method
4627 my ($class, %opts) = @_;
4628 $class->_upgrade_otaker(%opts);
4630 # RT#10139, bug resulting in contract_end being set when it shouldn't
4631 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
4632 # RT#10830, bad calculation of prorate date near end of year
4633 # the date range for bill is December 2009, and we move it forward
4634 # one year if it's before the previous bill date (which it should
4636 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
4637 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
4638 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
4639 # RT6628, add order_date to cust_pkg
4640 'update cust_pkg set order_date = (select history_date from h_cust_pkg
4641 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
4642 history_action = \'insert\') where order_date is null',
4644 foreach my $sql (@statements) {
4645 my $sth = dbh->prepare($sql);
4646 $sth->execute or die $sth->errstr;
4654 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
4656 In sub order, the @pkgparts array (passed by reference) is clobbered.
4658 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
4659 method to pass dates to the recur_prog expression, it should do so.
4661 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
4662 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
4663 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
4664 configuration values. Probably need a subroutine which decides what to do
4665 based on whether or not we've fetched the user yet, rather than a hash. See
4666 FS::UID and the TODO.
4668 Now that things are transactional should the check in the insert method be
4673 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
4674 L<FS::pkg_svc>, schema.html from the base documentation