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.
213 =item change_to_pkgnum
215 The pkgnum of the package this one will be "changed to" in the future
216 (on its expiration date).
220 Note: setup, last_bill, bill, adjourn, susp, expire, cancel and change_date
221 are specified as UNIX timestamps; see L<perlfunc/"time">. Also see
222 L<Time::Local> and L<Date::Parse> for conversion functions.
230 Create a new billing item. To add the item to the database, see L<"insert">.
234 sub table { 'cust_pkg'; }
235 sub cust_linked { $_[0]->cust_main_custnum || $_[0]->custnum }
236 sub cust_unlinked_msg {
238 "WARNING: can't find cust_main.custnum ". $self->custnum.
239 ' (cust_pkg.pkgnum '. $self->pkgnum. ')';
242 =item insert [ OPTION => VALUE ... ]
244 Adds this billing item to the database ("Orders" the item). If there is an
245 error, returns the error, otherwise returns false.
247 If the additional field I<promo_code> is defined instead of I<pkgpart>, it
248 will be used to look up the package definition and agent restrictions will be
251 If the additional field I<refnum> is defined, an FS::pkg_referral record will
252 be created and inserted. Multiple FS::pkg_referral records can be created by
253 setting I<refnum> to an array reference of refnums or a hash reference with
254 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
255 record will be created corresponding to cust_main.refnum.
257 The following options are available:
263 If set true, supresses actions that should only be taken for new package
264 orders. (Currently this includes: intro periods when delay_setup is on.)
268 cust_pkg_option records will be created
272 a ticket will be added to this customer with this subject
276 an optional queue name for ticket additions
280 Don't check the legality of the package definition. This should be used
281 when performing a package change that doesn't change the pkgpart (i.e.
289 my( $self, %options ) = @_;
292 $error = $self->check_pkgpart unless $options{'allow_pkgpart'};
293 return $error if $error;
295 my $part_pkg = $self->part_pkg;
297 # if the package def says to start only on the first of the month:
298 if ( $part_pkg->option('start_1st', 1) && !$self->start_date ) {
299 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime(time) )[0,1,2,3,4,5];
300 $mon += 1 unless $mday == 1;
301 until ( $mon < 12 ) { $mon -= 12; $year++; }
302 $self->start_date( timelocal_nocheck(0,0,0,1,$mon,$year) );
305 # set up any automatic expire/adjourn/contract_end timers
306 # based on the start date
307 foreach my $action ( qw(expire adjourn contract_end) ) {
308 my $months = $part_pkg->option("${action}_months",1);
309 if($months and !$self->$action) {
310 my $start = $self->start_date || $self->setup || time;
311 $self->$action( $part_pkg->add_freq($start, $months) );
315 # if this package has "free days" and delayed setup fee, tehn
316 # set start date that many days in the future.
317 # (this should have been set in the UI, but enforce it here)
318 if ( ! $options{'change'}
319 && ( my $free_days = $part_pkg->option('free_days',1) )
320 && $part_pkg->option('delay_setup',1)
321 #&& ! $self->start_date
324 $self->start_date( $part_pkg->default_start_date );
327 $self->order_date(time);
329 local $SIG{HUP} = 'IGNORE';
330 local $SIG{INT} = 'IGNORE';
331 local $SIG{QUIT} = 'IGNORE';
332 local $SIG{TERM} = 'IGNORE';
333 local $SIG{TSTP} = 'IGNORE';
334 local $SIG{PIPE} = 'IGNORE';
336 my $oldAutoCommit = $FS::UID::AutoCommit;
337 local $FS::UID::AutoCommit = 0;
340 $error = $self->SUPER::insert($options{options} ? %{$options{options}} : ());
342 $dbh->rollback if $oldAutoCommit;
346 $self->refnum($self->cust_main->refnum) unless $self->refnum;
347 $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
348 $self->process_m2m( 'link_table' => 'pkg_referral',
349 'target_table' => 'part_referral',
350 'params' => $self->refnum,
353 if ( $self->discountnum ) {
354 my $error = $self->insert_discount();
356 $dbh->rollback if $oldAutoCommit;
361 my $conf = new FS::Conf;
363 if ( $conf->config('ticket_system') && $options{ticket_subject} ) {
365 #this init stuff is still inefficient, but at least its limited to
366 # the small number (any?) folks using ticket emailing on pkg order
369 # use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
376 use FS::TicketSystem;
377 FS::TicketSystem->init();
379 my $q = new RT::Queue($RT::SystemUser);
380 $q->Load($options{ticket_queue}) if $options{ticket_queue};
381 my $t = new RT::Ticket($RT::SystemUser);
382 my $mime = new MIME::Entity;
383 $mime->build( Type => 'text/plain', Data => $options{ticket_subject} );
384 $t->Create( $options{ticket_queue} ? (Queue => $q) : (),
385 Subject => $options{ticket_subject},
388 $t->AddLink( Type => 'MemberOf',
389 Target => 'freeside://freeside/cust_main/'. $self->custnum,
393 if ($conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
394 my $queue = new FS::queue {
395 'job' => 'FS::cust_main::queueable_print',
397 $error = $queue->insert(
398 'custnum' => $self->custnum,
399 'template' => 'welcome_letter',
403 warn "can't send welcome letter: $error";
408 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
415 This method now works but you probably shouldn't use it.
417 You don't want to delete packages, because there would then be no record
418 the customer ever purchased the package. Instead, see the cancel method and
419 hide cancelled packages.
426 local $SIG{HUP} = 'IGNORE';
427 local $SIG{INT} = 'IGNORE';
428 local $SIG{QUIT} = 'IGNORE';
429 local $SIG{TERM} = 'IGNORE';
430 local $SIG{TSTP} = 'IGNORE';
431 local $SIG{PIPE} = 'IGNORE';
433 my $oldAutoCommit = $FS::UID::AutoCommit;
434 local $FS::UID::AutoCommit = 0;
437 foreach my $cust_pkg_discount ($self->cust_pkg_discount) {
438 my $error = $cust_pkg_discount->delete;
440 $dbh->rollback if $oldAutoCommit;
444 #cust_bill_pkg_discount?
446 foreach my $cust_pkg_detail ($self->cust_pkg_detail) {
447 my $error = $cust_pkg_detail->delete;
449 $dbh->rollback if $oldAutoCommit;
454 foreach my $cust_pkg_reason (
456 'table' => 'cust_pkg_reason',
457 'hashref' => { 'pkgnum' => $self->pkgnum },
461 my $error = $cust_pkg_reason->delete;
463 $dbh->rollback if $oldAutoCommit;
470 my $error = $self->SUPER::delete(@_);
472 $dbh->rollback if $oldAutoCommit;
476 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
482 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
484 Replaces the OLD_RECORD with this one in the database. If there is an error,
485 returns the error, otherwise returns false.
487 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
489 Changing pkgpart may have disasterous effects. See the order subroutine.
491 setup and bill are normally updated by calling the bill method of a customer
492 object (see L<FS::cust_main>).
494 suspend is normally updated by the suspend and unsuspend methods.
496 cancel is normally updated by the cancel method (and also the order subroutine
499 Available options are:
505 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.
509 the access_user (see L<FS::access_user>) providing the reason
513 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
522 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
527 ( ref($_[0]) eq 'HASH' )
531 #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
532 #return "Can't change otaker!" if $old->otaker ne $new->otaker;
535 #return "Can't change setup once it exists!"
536 # if $old->getfield('setup') &&
537 # $old->getfield('setup') != $new->getfield('setup');
539 #some logic for bill, susp, cancel?
541 local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
543 local $SIG{HUP} = 'IGNORE';
544 local $SIG{INT} = 'IGNORE';
545 local $SIG{QUIT} = 'IGNORE';
546 local $SIG{TERM} = 'IGNORE';
547 local $SIG{TSTP} = 'IGNORE';
548 local $SIG{PIPE} = 'IGNORE';
550 my $oldAutoCommit = $FS::UID::AutoCommit;
551 local $FS::UID::AutoCommit = 0;
554 foreach my $method ( qw(adjourn expire) ) { # How many reasons?
555 if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
556 my $error = $new->insert_reason(
557 'reason' => $options->{'reason'},
558 'date' => $new->$method,
560 'reason_otaker' => $options->{'reason_otaker'},
563 dbh->rollback if $oldAutoCommit;
564 return "Error inserting cust_pkg_reason: $error";
569 #save off and freeze RADIUS attributes for any associated svc_acct records
571 if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
573 #also check for specific exports?
574 # to avoid spurious modify export events
575 @svc_acct = map { $_->svc_x }
576 grep { $_->part_svc->svcdb eq 'svc_acct' }
579 $_->snapshot foreach @svc_acct;
583 my $error = $new->export_pkg_change($old)
584 || $new->SUPER::replace( $old,
586 ? $options->{options}
590 $dbh->rollback if $oldAutoCommit;
594 #for prepaid packages,
595 #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
596 foreach my $old_svc_acct ( @svc_acct ) {
597 my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
599 $new_svc_acct->replace( $old_svc_acct,
600 'depend_jobnum' => $options->{depend_jobnum},
603 $dbh->rollback if $oldAutoCommit;
608 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
615 Checks all fields to make sure this is a valid billing item. If there is an
616 error, returns the error, otherwise returns false. Called by the insert and
624 if ( !$self->locationnum or $self->locationnum == -1 ) {
625 $self->set('locationnum', $self->cust_main->ship_locationnum);
629 $self->ut_numbern('pkgnum')
630 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
631 || $self->ut_numbern('pkgpart')
632 || $self->ut_foreign_keyn('contactnum', 'contact', 'contactnum' )
633 || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
634 || $self->ut_numbern('start_date')
635 || $self->ut_numbern('setup')
636 || $self->ut_numbern('bill')
637 || $self->ut_numbern('susp')
638 || $self->ut_numbern('cancel')
639 || $self->ut_numbern('adjourn')
640 || $self->ut_numbern('resume')
641 || $self->ut_numbern('expire')
642 || $self->ut_numbern('dundate')
643 || $self->ut_enum('no_auto', [ '', 'Y' ])
644 || $self->ut_enum('waive_setup', [ '', 'Y' ])
645 || $self->ut_numbern('agent_pkgid')
646 || $self->ut_enum('recur_show_zero', [ '', 'Y', 'N', ])
647 || $self->ut_enum('setup_show_zero', [ '', 'Y', 'N', ])
648 || $self->ut_foreign_keyn('main_pkgnum', 'cust_pkg', 'pkgnum')
649 || $self->ut_foreign_keyn('pkglinknum', 'part_pkg_link', 'pkglinknum')
650 || $self->ut_foreign_keyn('change_to_pkgnum', 'cust_pkg', 'pkgnum')
652 return $error if $error;
654 return "A package with both start date (future start) and setup date (already started) will never bill"
655 if $self->start_date && $self->setup;
657 return "A future unsuspend date can only be set for a package with a suspend date"
658 if $self->resume and !$self->susp and !$self->adjourn;
660 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
662 if ( $self->dbdef_table->column('manual_flag') ) {
663 $self->manual_flag('') if $self->manual_flag eq ' ';
664 $self->manual_flag =~ /^([01]?)$/
665 or return "Illegal manual_flag ". $self->manual_flag;
666 $self->manual_flag($1);
674 Check the pkgpart to make sure it's allowed with the reg_code and/or
675 promo_code of the package (if present) and with the customer's agent.
676 Called from C<insert>, unless we are doing a package change that doesn't
684 # my $error = $self->ut_numbern('pkgpart'); # already done
687 if ( $self->reg_code ) {
689 unless ( grep { $self->pkgpart == $_->pkgpart }
690 map { $_->reg_code_pkg }
691 qsearchs( 'reg_code', { 'code' => $self->reg_code,
692 'agentnum' => $self->cust_main->agentnum })
694 return "Unknown registration code";
697 } elsif ( $self->promo_code ) {
700 qsearchs('part_pkg', {
701 'pkgpart' => $self->pkgpart,
702 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
704 return 'Unknown promotional code' unless $promo_part_pkg;
708 unless ( $disable_agentcheck ) {
710 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
711 return "agent ". $agent->agentnum. ':'. $agent->agent.
712 " can't purchase pkgpart ". $self->pkgpart
713 unless $agent->pkgpart_hashref->{ $self->pkgpart }
714 || $agent->agentnum == $self->part_pkg->agentnum;
717 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
718 return $error if $error;
726 =item cancel [ OPTION => VALUE ... ]
728 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
729 in this package, then cancels the package itself (sets the cancel field to
732 Available options are:
736 =item quiet - can be set true to supress email cancellation notices.
738 =item time - can be set to cancel the package based on a specific future or
739 historical date. Using time ensures that the remaining amount is calculated
740 correctly. Note however that this is an immediate cancel and just changes
741 the date. You are PROBABLY looking to expire the account instead of using
744 =item reason - can be set to a cancellation reason (see L<FS:reason>),
745 either a reasonnum of an existing reason, or passing a hashref will create
746 a new reason. The hashref should have the following keys: typenum - Reason
747 type (see L<FS::reason_type>, reason - Text of the new reason.
749 =item date - can be set to a unix style timestamp to specify when to
752 =item nobill - can be set true to skip billing if it might otherwise be done.
754 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
755 not credit it. This must be set (by change()) when changing the package
756 to a different pkgpart or location, and probably shouldn't be in any other
757 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
762 If there is an error, returns the error, otherwise returns false.
767 my( $self, %options ) = @_;
770 # pass all suspend/cancel actions to the main package
771 if ( $self->main_pkgnum and !$options{'from_main'} ) {
772 return $self->main_pkg->cancel(%options);
775 my $conf = new FS::Conf;
777 warn "cust_pkg::cancel called with options".
778 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
781 local $SIG{HUP} = 'IGNORE';
782 local $SIG{INT} = 'IGNORE';
783 local $SIG{QUIT} = 'IGNORE';
784 local $SIG{TERM} = 'IGNORE';
785 local $SIG{TSTP} = 'IGNORE';
786 local $SIG{PIPE} = 'IGNORE';
788 my $oldAutoCommit = $FS::UID::AutoCommit;
789 local $FS::UID::AutoCommit = 0;
792 my $old = $self->select_for_update;
794 if ( $old->get('cancel') || $self->get('cancel') ) {
795 dbh->rollback if $oldAutoCommit;
796 return ""; # no error
799 # XXX possibly set cancel_time to the expire date?
800 my $cancel_time = $options{'time'} || time;
801 my $date = $options{'date'} if $options{'date'}; # expire/cancel later
802 $date = '' if ($date && $date <= $cancel_time); # complain instead?
804 #race condition: usage could be ongoing until unprovisioned
805 #resolved by performing a change package instead (which unprovisions) and
807 if ( !$options{nobill} && !$date ) {
808 # && $conf->exists('bill_usage_on_cancel') ) { #calc_cancel checks this
809 my $copy = $self->new({$self->hash});
811 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
813 'time' => $cancel_time );
814 warn "Error billing during cancel, custnum ".
815 #$self->cust_main->custnum. ": $error"
820 if ( $options{'reason'} ) {
821 $error = $self->insert_reason( 'reason' => $options{'reason'},
822 'action' => $date ? 'expire' : 'cancel',
823 'date' => $date ? $date : $cancel_time,
824 'reason_otaker' => $options{'reason_otaker'},
827 dbh->rollback if $oldAutoCommit;
828 return "Error inserting cust_pkg_reason: $error";
832 my %svc_cancel_opt = ();
833 $svc_cancel_opt{'date'} = $date if $date;
834 foreach my $cust_svc (
837 sort { $a->[1] <=> $b->[1] }
838 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; }
839 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
841 my $part_svc = $cust_svc->part_svc;
842 next if ( defined($part_svc) and $part_svc->preserve );
843 my $error = $cust_svc->cancel( %svc_cancel_opt );
846 $dbh->rollback if $oldAutoCommit;
847 return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
853 # credit remaining time if appropriate
855 if ( exists($options{'unused_credit'}) ) {
856 $do_credit = $options{'unused_credit'};
859 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
862 my $error = $self->credit_remaining('cancel', $cancel_time);
864 $dbh->rollback if $oldAutoCommit;
871 my %hash = $self->hash;
873 $hash{'expire'} = $date;
875 $hash{'cancel'} = $cancel_time;
877 $hash{'change_custnum'} = $options{'change_custnum'};
879 my $new = new FS::cust_pkg ( \%hash );
880 $error = $new->replace( $self, options => { $self->options } );
881 if ( $self->change_to_pkgnum ) {
882 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
883 $error ||= $change_to->cancel || $change_to->delete;
886 $dbh->rollback if $oldAutoCommit;
890 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
891 $error = $supp_pkg->cancel(%options, 'from_main' => 1);
893 $dbh->rollback if $oldAutoCommit;
894 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
898 foreach my $usage ( $self->cust_pkg_usage ) {
899 $error = $usage->delete;
901 $dbh->rollback if $oldAutoCommit;
902 return "deleting usage pools: $error";
906 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
907 return '' if $date; #no errors
909 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
910 if ( !$options{'quiet'} &&
911 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
913 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
916 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
917 $error = $msg_template->send( 'cust_main' => $self->cust_main,
922 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
923 'to' => \@invoicing_list,
924 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
925 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
928 #should this do something on errors?
935 =item cancel_if_expired [ NOW_TIMESTAMP ]
937 Cancels this package if its expire date has been reached.
941 sub cancel_if_expired {
943 my $time = shift || time;
944 return '' unless $self->expire && $self->expire <= $time;
945 my $error = $self->cancel;
947 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
948 $self->custnum. ": $error";
955 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
956 locationnum, (other fields?). Attempts to re-provision cancelled services
957 using history information (errors at this stage are not fatal).
959 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
961 svc_fatal: service provisioning errors are fatal
963 svc_errors: pass an array reference, will be filled in with any provisioning errors
965 main_pkgnum: link the package as a supplemental package of this one. For
971 my( $self, %options ) = @_;
973 #in case you try do do $uncancel-date = $cust_pkg->uncacel
974 return '' unless $self->get('cancel');
976 if ( $self->main_pkgnum and !$options{'main_pkgnum'} ) {
977 return $self->main_pkg->uncancel(%options);
984 local $SIG{HUP} = 'IGNORE';
985 local $SIG{INT} = 'IGNORE';
986 local $SIG{QUIT} = 'IGNORE';
987 local $SIG{TERM} = 'IGNORE';
988 local $SIG{TSTP} = 'IGNORE';
989 local $SIG{PIPE} = 'IGNORE';
991 my $oldAutoCommit = $FS::UID::AutoCommit;
992 local $FS::UID::AutoCommit = 0;
996 # insert the new package
999 my $cust_pkg = new FS::cust_pkg {
1000 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
1001 bill => ( $options{'bill'} || $self->get('bill') ),
1003 uncancel_pkgnum => $self->pkgnum,
1004 main_pkgnum => ($options{'main_pkgnum'} || ''),
1005 map { $_ => $self->get($_) } qw(
1006 custnum pkgpart locationnum
1008 susp adjourn resume expire start_date contract_end dundate
1009 change_date change_pkgpart change_locationnum
1010 manual_flag no_auto quantity agent_pkgid recur_show_zero setup_show_zero
1014 my $error = $cust_pkg->insert(
1015 'change' => 1, #supresses any referral credit to a referring customer
1016 'allow_pkgpart' => 1, # allow this even if the package def is disabled
1019 $dbh->rollback if $oldAutoCommit;
1027 #find historical services within this timeframe before the package cancel
1028 # (incompatible with "time" option to cust_pkg->cancel?)
1029 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
1030 # too little? (unprovisioing export delay?)
1031 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
1032 my @h_cust_svc = $self->h_cust_svc( $end, $start );
1035 foreach my $h_cust_svc (@h_cust_svc) {
1036 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
1037 #next unless $h_svc_x; #should this happen?
1038 (my $table = $h_svc_x->table) =~ s/^h_//;
1039 require "FS/$table.pm";
1040 my $class = "FS::$table";
1041 my $svc_x = $class->new( {
1042 'pkgnum' => $cust_pkg->pkgnum,
1043 'svcpart' => $h_cust_svc->svcpart,
1044 map { $_ => $h_svc_x->get($_) } fields($table)
1048 if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
1049 $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
1052 my $svc_error = $svc_x->insert;
1054 if ( $options{svc_fatal} ) {
1055 $dbh->rollback if $oldAutoCommit;
1058 # if we've failed to insert the svc_x object, svc_Common->insert
1059 # will have removed the cust_svc already. if not, then both records
1060 # were inserted but we failed for some other reason (export, most
1061 # likely). in that case, report the error and delete the records.
1062 push @svc_errors, $svc_error;
1063 my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1065 # except if export_insert failed, export_delete probably won't be
1067 local $FS::svc_Common::noexport_hack = 1;
1068 my $cleanup_error = $svc_x->delete; # also deletes cust_svc
1069 if ( $cleanup_error ) { # and if THAT fails, then run away
1070 $dbh->rollback if $oldAutoCommit;
1071 return $cleanup_error;
1076 } #foreach $h_cust_svc
1078 #these are pretty rare, but should handle them
1079 # - dsl_device (mac addresses)
1080 # - phone_device (mac addresses)
1081 # - dsl_note (ikano notes)
1082 # - domain_record (i.e. restore DNS information w/domains)
1083 # - inventory_item(?) (inventory w/un-cancelling service?)
1084 # - nas (svc_broaband nas stuff)
1085 #this stuff is unused in the wild afaik
1086 # - mailinglistmember
1088 # - svc_domain.parent_svcnum?
1089 # - acct_snarf (ancient mail fetching config)
1090 # - cgp_rule (communigate)
1091 # - cust_svc_option (used by our Tron stuff)
1092 # - acct_rt_transaction (used by our time worked stuff)
1095 # also move over any services that didn't unprovision at cancellation
1098 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1099 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1100 my $error = $cust_svc->replace;
1102 $dbh->rollback if $oldAutoCommit;
1108 # Uncancel any supplemental packages, and make them supplemental to the
1112 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1114 $error = $supp_pkg->uncancel(%options, 'main_pkgnum' => $cust_pkg->pkgnum);
1116 $dbh->rollback if $oldAutoCommit;
1117 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1125 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1127 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1128 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1135 Cancels any pending expiration (sets the expire field to null).
1137 If there is an error, returns the error, otherwise returns false.
1142 my( $self, %options ) = @_;
1145 local $SIG{HUP} = 'IGNORE';
1146 local $SIG{INT} = 'IGNORE';
1147 local $SIG{QUIT} = 'IGNORE';
1148 local $SIG{TERM} = 'IGNORE';
1149 local $SIG{TSTP} = 'IGNORE';
1150 local $SIG{PIPE} = 'IGNORE';
1152 my $oldAutoCommit = $FS::UID::AutoCommit;
1153 local $FS::UID::AutoCommit = 0;
1156 my $old = $self->select_for_update;
1158 my $pkgnum = $old->pkgnum;
1159 if ( $old->get('cancel') || $self->get('cancel') ) {
1160 dbh->rollback if $oldAutoCommit;
1161 return "Can't unexpire cancelled package $pkgnum";
1162 # or at least it's pointless
1165 unless ( $old->get('expire') && $self->get('expire') ) {
1166 dbh->rollback if $oldAutoCommit;
1167 return ""; # no error
1170 my %hash = $self->hash;
1171 $hash{'expire'} = '';
1172 my $new = new FS::cust_pkg ( \%hash );
1173 $error = $new->replace( $self, options => { $self->options } );
1175 $dbh->rollback if $oldAutoCommit;
1179 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1185 =item suspend [ OPTION => VALUE ... ]
1187 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1188 package, then suspends the package itself (sets the susp field to now).
1190 Available options are:
1194 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1195 either a reasonnum of an existing reason, or passing a hashref will create
1196 a new reason. The hashref should have the following keys:
1197 - typenum - Reason type (see L<FS::reason_type>
1198 - reason - Text of the new reason.
1200 =item date - can be set to a unix style timestamp to specify when to
1203 =item time - can be set to override the current time, for calculation
1204 of final invoices or unused-time credits
1206 =item resume_date - can be set to a time when the package should be
1207 unsuspended. This may be more convenient than calling C<unsuspend()>
1210 =item from_main - allows a supplemental package to be suspended, rather
1211 than redirecting the method call to its main package. For internal use.
1215 If there is an error, returns the error, otherwise returns false.
1220 my( $self, %options ) = @_;
1223 # pass all suspend/cancel actions to the main package
1224 if ( $self->main_pkgnum and !$options{'from_main'} ) {
1225 return $self->main_pkg->suspend(%options);
1228 local $SIG{HUP} = 'IGNORE';
1229 local $SIG{INT} = 'IGNORE';
1230 local $SIG{QUIT} = 'IGNORE';
1231 local $SIG{TERM} = 'IGNORE';
1232 local $SIG{TSTP} = 'IGNORE';
1233 local $SIG{PIPE} = 'IGNORE';
1235 my $oldAutoCommit = $FS::UID::AutoCommit;
1236 local $FS::UID::AutoCommit = 0;
1239 my $old = $self->select_for_update;
1241 my $pkgnum = $old->pkgnum;
1242 if ( $old->get('cancel') || $self->get('cancel') ) {
1243 dbh->rollback if $oldAutoCommit;
1244 return "Can't suspend cancelled package $pkgnum";
1247 if ( $old->get('susp') || $self->get('susp') ) {
1248 dbh->rollback if $oldAutoCommit;
1249 return ""; # no error # complain on adjourn?
1252 my $suspend_time = $options{'time'} || time;
1253 my $date = $options{date} if $options{date}; # adjourn/suspend later
1254 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1256 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1257 dbh->rollback if $oldAutoCommit;
1258 return "Package $pkgnum expires before it would be suspended.";
1261 # some false laziness with sub cancel
1262 if ( !$options{nobill} && !$date &&
1263 $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1264 # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1265 # make the entire cust_main->bill path recognize 'suspend' and
1266 # 'cancel' separately.
1267 warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1268 my $copy = $self->new({$self->hash});
1270 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1272 'time' => $suspend_time );
1273 warn "Error billing during suspend, custnum ".
1274 #$self->cust_main->custnum. ": $error"
1279 if ( $options{'reason'} ) {
1280 $error = $self->insert_reason( 'reason' => $options{'reason'},
1281 'action' => $date ? 'adjourn' : 'suspend',
1282 'date' => $date ? $date : $suspend_time,
1283 'reason_otaker' => $options{'reason_otaker'},
1286 dbh->rollback if $oldAutoCommit;
1287 return "Error inserting cust_pkg_reason: $error";
1291 my %hash = $self->hash;
1293 $hash{'adjourn'} = $date;
1295 $hash{'susp'} = $suspend_time;
1298 my $resume_date = $options{'resume_date'} || 0;
1299 if ( $resume_date > ($date || $suspend_time) ) {
1300 $hash{'resume'} = $resume_date;
1303 $options{options} ||= {};
1305 my $new = new FS::cust_pkg ( \%hash );
1306 $error = $new->replace( $self, options => { $self->options,
1307 %{ $options{options} },
1311 $dbh->rollback if $oldAutoCommit;
1316 # credit remaining time if appropriate
1317 if ( $self->part_pkg->option('unused_credit_suspend', 1) ) {
1318 my $error = $self->credit_remaining('suspend', $suspend_time);
1320 $dbh->rollback if $oldAutoCommit;
1327 foreach my $cust_svc (
1328 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1330 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1332 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1333 $dbh->rollback if $oldAutoCommit;
1334 return "Illegal svcdb value in part_svc!";
1337 require "FS/$svcdb.pm";
1339 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1341 $error = $svc->suspend;
1343 $dbh->rollback if $oldAutoCommit;
1346 my( $label, $value ) = $cust_svc->label;
1347 push @labels, "$label: $value";
1351 my $conf = new FS::Conf;
1352 if ( $conf->config('suspend_email_admin') ) {
1354 my $error = send_email(
1355 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1356 #invoice_from ??? well as good as any
1357 'to' => $conf->config('suspend_email_admin'),
1358 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1360 "This is an automatic message from your Freeside installation\n",
1361 "informing you that the following customer package has been suspended:\n",
1363 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1364 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1365 ( map { "Service : $_\n" } @labels ),
1370 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1378 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1379 $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1381 $dbh->rollback if $oldAutoCommit;
1382 return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1386 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1391 =item credit_remaining MODE TIME
1393 Generate a credit for this package for the time remaining in the current
1394 billing period. MODE is either "suspend" or "cancel" (determines the
1395 credit type). TIME is the time of suspension/cancellation. Both arguments
1400 sub credit_remaining {
1401 # Add a credit for remaining service
1402 my ($self, $mode, $time) = @_;
1403 die 'credit_remaining requires suspend or cancel'
1404 unless $mode eq 'suspend' or $mode eq 'cancel';
1405 die 'no suspend/cancel time' unless $time > 0;
1407 my $conf = FS::Conf->new;
1408 my $reason_type = $conf->config($mode.'_credit_type');
1410 my $last_bill = $self->getfield('last_bill') || 0;
1411 my $next_bill = $self->getfield('bill') || 0;
1412 if ( $last_bill > 0 # the package has been billed
1413 and $next_bill > 0 # the package has a next bill date
1414 and $next_bill >= $time # which is in the future
1416 my $remaining_value = $self->calc_remain('time' => $time);
1417 if ( $remaining_value > 0 ) {
1418 warn "Crediting for $remaining_value on package ".$self->pkgnum."\n"
1420 my $error = $self->cust_main->credit(
1422 'Credit for unused time on '. $self->part_pkg->pkg,
1423 'reason_type' => $reason_type,
1425 return "Error crediting customer \$$remaining_value for unused time".
1426 " on ". $self->part_pkg->pkg. ": $error"
1428 } #if $remaining_value
1429 } #if $last_bill, etc.
1433 =item unsuspend [ OPTION => VALUE ... ]
1435 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1436 package, then unsuspends the package itself (clears the susp field and the
1437 adjourn field if it is in the past). If the suspend reason includes an
1438 unsuspension package, that package will be ordered.
1440 Available options are:
1446 Can be set to a date to unsuspend the package in the future (the 'resume'
1449 =item adjust_next_bill
1451 Can be set true to adjust the next bill date forward by
1452 the amount of time the account was inactive. This was set true by default
1453 in the past (from 1.4.2 and 1.5.0pre6 through 1.7.0), but now needs to be
1454 explicitly requested with this option or in the price plan.
1458 If there is an error, returns the error, otherwise returns false.
1463 my( $self, %opt ) = @_;
1466 # pass all suspend/cancel actions to the main package
1467 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1468 return $self->main_pkg->unsuspend(%opt);
1471 local $SIG{HUP} = 'IGNORE';
1472 local $SIG{INT} = 'IGNORE';
1473 local $SIG{QUIT} = 'IGNORE';
1474 local $SIG{TERM} = 'IGNORE';
1475 local $SIG{TSTP} = 'IGNORE';
1476 local $SIG{PIPE} = 'IGNORE';
1478 my $oldAutoCommit = $FS::UID::AutoCommit;
1479 local $FS::UID::AutoCommit = 0;
1482 my $old = $self->select_for_update;
1484 my $pkgnum = $old->pkgnum;
1485 if ( $old->get('cancel') || $self->get('cancel') ) {
1486 $dbh->rollback if $oldAutoCommit;
1487 return "Can't unsuspend cancelled package $pkgnum";
1490 unless ( $old->get('susp') && $self->get('susp') ) {
1491 $dbh->rollback if $oldAutoCommit;
1492 return ""; # no error # complain instead?
1495 my $date = $opt{'date'};
1496 if ( $date and $date > time ) { # return an error if $date <= time?
1498 if ( $old->get('expire') && $old->get('expire') < $date ) {
1499 $dbh->rollback if $oldAutoCommit;
1500 return "Package $pkgnum expires before it would be unsuspended.";
1503 my $new = new FS::cust_pkg { $self->hash };
1504 $new->set('resume', $date);
1505 $error = $new->replace($self, options => $self->options);
1508 $dbh->rollback if $oldAutoCommit;
1512 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1520 foreach my $cust_svc (
1521 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1523 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1525 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1526 $dbh->rollback if $oldAutoCommit;
1527 return "Illegal svcdb value in part_svc!";
1530 require "FS/$svcdb.pm";
1532 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1534 $error = $svc->unsuspend;
1536 $dbh->rollback if $oldAutoCommit;
1539 my( $label, $value ) = $cust_svc->label;
1540 push @labels, "$label: $value";
1545 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1546 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1548 my %hash = $self->hash;
1549 my $inactive = time - $hash{'susp'};
1551 my $conf = new FS::Conf;
1553 if ( $inactive > 0 &&
1554 ( $hash{'bill'} || $hash{'setup'} ) &&
1555 ( $opt{'adjust_next_bill'} ||
1556 $conf->exists('unsuspend-always_adjust_next_bill_date') ||
1557 $self->part_pkg->option('unsuspend_adjust_bill', 1) )
1560 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1565 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1566 $hash{'resume'} = '' if !$hash{'adjourn'};
1567 my $new = new FS::cust_pkg ( \%hash );
1568 $error = $new->replace( $self, options => { $self->options } );
1570 $dbh->rollback if $oldAutoCommit;
1576 if ( $reason && $reason->unsuspend_pkgpart ) {
1577 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
1578 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
1580 my $start_date = $self->cust_main->next_bill_date
1581 if $reason->unsuspend_hold;
1584 $unsusp_pkg = FS::cust_pkg->new({
1585 'custnum' => $self->custnum,
1586 'pkgpart' => $reason->unsuspend_pkgpart,
1587 'start_date' => $start_date,
1588 'locationnum' => $self->locationnum,
1589 # discount? probably not...
1592 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
1596 $dbh->rollback if $oldAutoCommit;
1601 if ( $conf->config('unsuspend_email_admin') ) {
1603 my $error = send_email(
1604 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1605 #invoice_from ??? well as good as any
1606 'to' => $conf->config('unsuspend_email_admin'),
1607 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
1608 "This is an automatic message from your Freeside installation\n",
1609 "informing you that the following customer package has been unsuspended:\n",
1611 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1612 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1613 ( map { "Service : $_\n" } @labels ),
1615 "An unsuspension fee was charged: ".
1616 $unsusp_pkg->part_pkg->pkg_comment."\n"
1623 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
1629 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1630 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
1632 $dbh->rollback if $oldAutoCommit;
1633 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1637 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1644 Cancels any pending suspension (sets the adjourn field to null).
1646 If there is an error, returns the error, otherwise returns false.
1651 my( $self, %options ) = @_;
1654 local $SIG{HUP} = 'IGNORE';
1655 local $SIG{INT} = 'IGNORE';
1656 local $SIG{QUIT} = 'IGNORE';
1657 local $SIG{TERM} = 'IGNORE';
1658 local $SIG{TSTP} = 'IGNORE';
1659 local $SIG{PIPE} = 'IGNORE';
1661 my $oldAutoCommit = $FS::UID::AutoCommit;
1662 local $FS::UID::AutoCommit = 0;
1665 my $old = $self->select_for_update;
1667 my $pkgnum = $old->pkgnum;
1668 if ( $old->get('cancel') || $self->get('cancel') ) {
1669 dbh->rollback if $oldAutoCommit;
1670 return "Can't unadjourn cancelled package $pkgnum";
1671 # or at least it's pointless
1674 if ( $old->get('susp') || $self->get('susp') ) {
1675 dbh->rollback if $oldAutoCommit;
1676 return "Can't unadjourn suspended package $pkgnum";
1677 # perhaps this is arbitrary
1680 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1681 dbh->rollback if $oldAutoCommit;
1682 return ""; # no error
1685 my %hash = $self->hash;
1686 $hash{'adjourn'} = '';
1687 $hash{'resume'} = '';
1688 my $new = new FS::cust_pkg ( \%hash );
1689 $error = $new->replace( $self, options => { $self->options } );
1691 $dbh->rollback if $oldAutoCommit;
1695 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1702 =item change HASHREF | OPTION => VALUE ...
1704 Changes this package: cancels it and creates a new one, with a different
1705 pkgpart or locationnum or both. All services are transferred to the new
1706 package (no change will be made if this is not possible).
1708 Options may be passed as a list of key/value pairs or as a hash reference.
1715 New locationnum, to change the location for this package.
1719 New FS::cust_location object, to create a new location and assign it
1724 New FS::cust_main object, to create a new customer and assign the new package
1729 New pkgpart (see L<FS::part_pkg>).
1733 New refnum (see L<FS::part_referral>).
1737 "New" (existing) FS::cust_pkg object. The package's services and other
1738 attributes will be transferred to this package.
1742 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1743 susp, adjourn, cancel, expire, and contract_end) to the new package.
1745 =item unprotect_svcs
1747 Normally, change() will rollback and return an error if some services
1748 can't be transferred (also see the I<cust_pkg-change_svcpart> config option).
1749 If unprotect_svcs is true, this method will transfer as many services as
1750 it can and then unconditionally cancel the old package.
1754 At least one of locationnum, cust_location, pkgpart, refnum, cust_main, or
1755 cust_pkg must be specified (otherwise, what's the point?)
1757 Returns either the new FS::cust_pkg object or a scalar error.
1761 my $err_or_new_cust_pkg = $old_cust_pkg->change
1765 #some false laziness w/order
1768 my $opt = ref($_[0]) ? shift : { @_ };
1770 # my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
1773 my $conf = new FS::Conf;
1775 # Transactionize this whole mess
1776 local $SIG{HUP} = 'IGNORE';
1777 local $SIG{INT} = 'IGNORE';
1778 local $SIG{QUIT} = 'IGNORE';
1779 local $SIG{TERM} = 'IGNORE';
1780 local $SIG{TSTP} = 'IGNORE';
1781 local $SIG{PIPE} = 'IGNORE';
1783 my $oldAutoCommit = $FS::UID::AutoCommit;
1784 local $FS::UID::AutoCommit = 0;
1793 #$hash{$_} = $self->$_() foreach qw( last_bill bill );
1795 #$hash{$_} = $self->$_() foreach qw( setup );
1797 $hash{'setup'} = $time if $self->setup;
1799 $hash{'change_date'} = $time;
1800 $hash{"change_$_"} = $self->$_()
1801 foreach qw( pkgnum pkgpart locationnum );
1803 if ( $opt->{'cust_location'} ) {
1804 $error = $opt->{'cust_location'}->find_or_insert;
1806 $dbh->rollback if $oldAutoCommit;
1807 return "inserting cust_location (transaction rolled back): $error";
1809 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1812 if ( $opt->{'cust_pkg'} ) {
1813 # treat changing to a package with a different pkgpart as a
1814 # pkgpart change (because it is)
1815 $opt->{'pkgpart'} = $opt->{'cust_pkg'}->pkgpart;
1818 # whether to override pkgpart checking on the new package
1819 my $same_pkgpart = 1;
1820 if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
1824 my $unused_credit = 0;
1825 my $keep_dates = $opt->{'keep_dates'};
1826 # Special case. If the pkgpart is changing, and the customer is
1827 # going to be credited for remaining time, don't keep setup, bill,
1828 # or last_bill dates, and DO pass the flag to cancel() to credit
1830 if ( $opt->{'pkgpart'}
1831 and $opt->{'pkgpart'} != $self->pkgpart
1832 and $self->part_pkg->option('unused_credit_change', 1) ) {
1835 $hash{$_} = '' foreach qw(setup bill last_bill);
1838 if ( $keep_dates ) {
1839 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1840 resume start_date contract_end ) ) {
1841 $hash{$date} = $self->getfield($date);
1844 # allow $opt->{'locationnum'} = '' to specifically set it to null
1845 # (i.e. customer default location)
1846 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
1848 # usually this doesn't matter. the two cases where it does are:
1849 # 1. unused_credit_change + pkgpart change + setup fee on the new package
1851 # 2. (more importantly) changing a package before it's billed
1852 $hash{'waive_setup'} = $self->waive_setup;
1854 my $custnum = $self->custnum;
1855 if ( $opt->{cust_main} ) {
1856 my $cust_main = $opt->{cust_main};
1857 unless ( $cust_main->custnum ) {
1858 my $error = $cust_main->insert;
1860 $dbh->rollback if $oldAutoCommit;
1861 return "inserting cust_main (transaction rolled back): $error";
1864 $custnum = $cust_main->custnum;
1867 $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
1870 if ( $opt->{'cust_pkg'} ) {
1871 # The target package already exists; update it to show that it was
1872 # changed from this package.
1873 $cust_pkg = $opt->{'cust_pkg'};
1875 foreach ( qw( pkgnum pkgpart locationnum ) ) {
1876 $cust_pkg->set("change_$_", $self->get($_));
1878 $cust_pkg->set('change_date', $time);
1879 $error = $cust_pkg->replace;
1882 # Create the new package.
1883 $cust_pkg = new FS::cust_pkg {
1884 custnum => $custnum,
1885 pkgpart => ( $opt->{'pkgpart'} || $self->pkgpart ),
1886 refnum => ( $opt->{'refnum'} || $self->refnum ),
1887 locationnum => ( $opt->{'locationnum'} ),
1890 $error = $cust_pkg->insert( 'change' => 1,
1891 'allow_pkgpart' => $same_pkgpart );
1894 $dbh->rollback if $oldAutoCommit;
1898 # Transfer services and cancel old package.
1900 $error = $self->transfer($cust_pkg);
1901 if ($error and $error == 0) {
1902 # $old_pkg->transfer failed.
1903 $dbh->rollback if $oldAutoCommit;
1907 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
1908 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
1909 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
1910 if ($error and $error == 0) {
1911 # $old_pkg->transfer failed.
1912 $dbh->rollback if $oldAutoCommit;
1917 # We set unprotect_svcs when executing a "future package change". It's
1918 # not a user-interactive operation, so returning an error means the
1919 # package change will just fail. Rather than have that happen, we'll
1920 # let leftover services be deleted.
1921 if ($error > 0 and !$opt->{'unprotect_svcs'}) {
1922 # Transfers were successful, but we still had services left on the old
1923 # package. We can't change the package under this circumstances, so abort.
1924 $dbh->rollback if $oldAutoCommit;
1925 return "Unable to transfer all services from package ". $self->pkgnum;
1928 #reset usage if changing pkgpart
1929 # AND usage rollover is off (otherwise adds twice, now and at package bill)
1930 if ($self->pkgpart != $cust_pkg->pkgpart) {
1931 my $part_pkg = $cust_pkg->part_pkg;
1932 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
1936 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
1939 $dbh->rollback if $oldAutoCommit;
1940 return "Error setting usage values: $error";
1943 # if NOT changing pkgpart, transfer any usage pools over
1944 foreach my $usage ($self->cust_pkg_usage) {
1945 $usage->set('pkgnum', $cust_pkg->pkgnum);
1946 $error = $usage->replace;
1948 $dbh->rollback if $oldAutoCommit;
1949 return "Error transferring usage pools: $error";
1954 # transfer discounts, if we're not changing pkgpart
1955 if ( $same_pkgpart ) {
1956 foreach my $old_discount ($self->cust_pkg_discount_active) {
1957 # don't remove the old discount, we may still need to bill that package.
1958 my $new_discount = new FS::cust_pkg_discount {
1959 'pkgnum' => $cust_pkg->pkgnum,
1960 'discountnum' => $old_discount->discountnum,
1961 'months_used' => $old_discount->months_used,
1963 $error = $new_discount->insert;
1965 $dbh->rollback if $oldAutoCommit;
1966 return "Error transferring discounts: $error";
1971 # transfer (copy) invoice details
1972 foreach my $detail ($self->cust_pkg_detail) {
1973 my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
1974 $new_detail->set('pkgdetailnum', '');
1975 $new_detail->set('pkgnum', $cust_pkg->pkgnum);
1976 $error = $new_detail->insert;
1978 $dbh->rollback if $oldAutoCommit;
1979 return "Error transferring package notes: $error";
1985 if ( !$opt->{'cust_pkg'} ) {
1986 # Order any supplemental packages.
1987 my $part_pkg = $cust_pkg->part_pkg;
1988 my @old_supp_pkgs = $self->supplemental_pkgs;
1989 foreach my $link ($part_pkg->supp_part_pkg_link) {
1991 foreach (@old_supp_pkgs) {
1992 if ($_->pkgpart == $link->dst_pkgpart) {
1994 $_->pkgpart(0); # so that it can't match more than once
1998 # false laziness with FS::cust_main::Packages::order_pkg
1999 my $new = FS::cust_pkg->new({
2000 pkgpart => $link->dst_pkgpart,
2001 pkglinknum => $link->pkglinknum,
2002 custnum => $custnum,
2003 main_pkgnum => $cust_pkg->pkgnum,
2004 locationnum => $cust_pkg->locationnum,
2005 start_date => $cust_pkg->start_date,
2006 order_date => $cust_pkg->order_date,
2007 expire => $cust_pkg->expire,
2008 adjourn => $cust_pkg->adjourn,
2009 contract_end => $cust_pkg->contract_end,
2010 refnum => $cust_pkg->refnum,
2011 discountnum => $cust_pkg->discountnum,
2012 waive_setup => $cust_pkg->waive_setup,
2014 if ( $old and $opt->{'keep_dates'} ) {
2015 foreach (qw(setup bill last_bill)) {
2016 $new->set($_, $old->get($_));
2019 $error = $new->insert( allow_pkgpart => $same_pkgpart );
2022 $error ||= $old->transfer($new);
2024 if ( $error and $error > 0 ) {
2025 # no reason why this should ever fail, but still...
2026 $error = "Unable to transfer all services from supplemental package ".
2030 $dbh->rollback if $oldAutoCommit;
2033 push @new_supp_pkgs, $new;
2035 } # if !$opt->{'cust_pkg'}
2036 # because if there is one, then supplemental packages would already
2037 # have been created for it.
2039 #Good to go, cancel old package. Notify 'cancel' of whether to credit
2041 #Don't allow billing the package (preceding period packages and/or
2042 #outstanding usage) if we are keeping dates (i.e. location changing),
2043 #because the new package will be billed for the same date range.
2044 #Supplemental packages are also canceled here.
2046 # during scheduled changes, avoid canceling the package we just
2048 $self->set('change_to_pkgnum' => '');
2050 $error = $self->cancel(
2052 unused_credit => $unused_credit,
2053 nobill => $keep_dates,
2054 change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2057 $dbh->rollback if $oldAutoCommit;
2061 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2063 my $error = $cust_pkg->cust_main->bill(
2064 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2067 $dbh->rollback if $oldAutoCommit;
2072 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2078 =item change_later OPTION => VALUE...
2080 Schedule a package change for a later date. This actually orders the new
2081 package immediately, but sets its start date for a future date, and sets
2082 the current package to expire on the same date.
2084 If the package is already scheduled for a change, this can be called with
2085 'start_date' to change the scheduled date, or with pkgpart and/or
2086 locationnum to modify the package change. To cancel the scheduled change
2087 entirely, see C<abort_change>.
2095 The date for the package change. Required, and must be in the future.
2101 The pkgpart and locationnum of the new package, with the same
2102 meaning as in C<change>.
2110 my $opt = ref($_[0]) ? shift : { @_ };
2112 my $oldAutoCommit = $FS::UID::AutoCommit;
2113 local $FS::UID::AutoCommit = 0;
2116 my $cust_main = $self->cust_main;
2118 my $date = delete $opt->{'start_date'} or return 'start_date required';
2120 if ( $date <= time ) {
2121 $dbh->rollback if $oldAutoCommit;
2122 return "start_date $date is in the past";
2127 if ( $self->change_to_pkgnum ) {
2128 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
2129 my $new_pkgpart = $opt->{'pkgpart'}
2130 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $change_to->pkgpart;
2131 my $new_locationnum = $opt->{'locationnum'}
2132 if $opt->{'locationnum'} and $opt->{'locationnum'} != $change_to->locationnum;
2133 if ( $new_pkgpart or $new_locationnum ) {
2134 # it hasn't been billed yet, so in principle we could just edit
2135 # it in place (w/o a package change), but that's bad form.
2136 # So change the package according to the new options...
2137 my $err_or_pkg = $change_to->change(%$opt);
2138 if ( ref $err_or_pkg ) {
2139 # Then set that package up for a future start.
2140 $self->set('change_to_pkgnum', $err_or_pkg->pkgnum);
2141 $self->set('expire', $date); # in case it's different
2142 $err_or_pkg->set('start_date', $date);
2143 $err_or_pkg->set('change_date', '');
2144 $err_or_pkg->set('change_pkgnum', '');
2146 $error = $self->replace ||
2147 $err_or_pkg->replace ||
2148 $change_to->cancel ||
2151 $error = $err_or_pkg;
2153 } else { # change the start date only.
2154 $self->set('expire', $date);
2155 $change_to->set('start_date', $date);
2156 $error = $self->replace || $change_to->replace;
2159 $dbh->rollback if $oldAutoCommit;
2162 $dbh->commit if $oldAutoCommit;
2165 } # if $self->change_to_pkgnum
2167 my $new_pkgpart = $opt->{'pkgpart'}
2168 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2169 my $new_locationnum = $opt->{'locationnum'}
2170 if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2171 return '' unless $new_pkgpart or $new_locationnum; # wouldn't do anything
2174 'custnum' => $self->custnum,
2175 'pkgpart' => ($opt->{'pkgpart'} || $self->pkgpart),
2176 'locationnum' => ($opt->{'locationnum'} || $self->locationnum),
2177 'start_date' => $date,
2179 my $new = FS::cust_pkg->new(\%hash);
2180 $error = $new->insert('change' => 1,
2181 'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2183 $self->set('change_to_pkgnum', $new->pkgnum);
2184 $self->set('expire', $date);
2185 $error = $self->replace;
2188 $dbh->rollback if $oldAutoCommit;
2190 $dbh->commit if $oldAutoCommit;
2198 Cancels a future package change scheduled by C<change_later>.
2204 my $pkgnum = $self->change_to_pkgnum;
2205 my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
2208 $error = $change_to->cancel || $change_to->delete;
2209 return $error if $error;
2211 $self->set('change_to_pkgnum', '');
2212 $self->set('expire', '');
2216 =item set_quantity QUANTITY
2218 Change the package's quantity field. This is the one package property
2219 that can safely be changed without canceling and reordering the package
2220 (because it doesn't affect tax eligibility). Returns an error or an
2227 $self = $self->replace_old; # just to make sure
2229 ($qty =~ /^\d+$/ and $qty > 0) or return "bad package quantity $qty";
2230 $self->set('quantity' => $qty);
2234 use Storable 'thaw';
2236 sub process_bulk_cust_pkg {
2238 my $param = thaw(decode_base64(shift));
2239 warn Dumper($param) if $DEBUG;
2241 my $old_part_pkg = qsearchs('part_pkg',
2242 { pkgpart => $param->{'old_pkgpart'} });
2243 my $new_part_pkg = qsearchs('part_pkg',
2244 { pkgpart => $param->{'new_pkgpart'} });
2245 die "Must select a new package type\n" unless $new_part_pkg;
2246 #my $keep_dates = $param->{'keep_dates'} || 0;
2247 my $keep_dates = 1; # there is no good reason to turn this off
2249 local $SIG{HUP} = 'IGNORE';
2250 local $SIG{INT} = 'IGNORE';
2251 local $SIG{QUIT} = 'IGNORE';
2252 local $SIG{TERM} = 'IGNORE';
2253 local $SIG{TSTP} = 'IGNORE';
2254 local $SIG{PIPE} = 'IGNORE';
2256 my $oldAutoCommit = $FS::UID::AutoCommit;
2257 local $FS::UID::AutoCommit = 0;
2260 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
2263 foreach my $old_cust_pkg ( @cust_pkgs ) {
2265 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
2266 if ( $old_cust_pkg->getfield('cancel') ) {
2267 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
2268 $old_cust_pkg->pkgnum."\n"
2272 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
2274 my $error = $old_cust_pkg->change(
2275 'pkgpart' => $param->{'new_pkgpart'},
2276 'keep_dates' => $keep_dates
2278 if ( !ref($error) ) { # change returns the cust_pkg on success
2280 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
2283 $dbh->commit if $oldAutoCommit;
2289 Returns the last bill date, or if there is no last bill date, the setup date.
2290 Useful for billing metered services.
2296 return $self->setfield('last_bill', $_[0]) if @_;
2297 return $self->getfield('last_bill') if $self->getfield('last_bill');
2298 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
2299 'edate' => $self->bill, } );
2300 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
2303 =item last_cust_pkg_reason ACTION
2305 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
2306 Returns false if there is no reason or the package is not currenly ACTION'd
2307 ACTION is one of adjourn, susp, cancel, or expire.
2311 sub last_cust_pkg_reason {
2312 my ( $self, $action ) = ( shift, shift );
2313 my $date = $self->get($action);
2315 'table' => 'cust_pkg_reason',
2316 'hashref' => { 'pkgnum' => $self->pkgnum,
2317 'action' => substr(uc($action), 0, 1),
2320 'order_by' => 'ORDER BY num DESC LIMIT 1',
2324 =item last_reason ACTION
2326 Returns the most recent ACTION FS::reason associated with the package.
2327 Returns false if there is no reason or the package is not currenly ACTION'd
2328 ACTION is one of adjourn, susp, cancel, or expire.
2333 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
2334 $cust_pkg_reason->reason
2335 if $cust_pkg_reason;
2340 Returns the definition for this billing item, as an FS::part_pkg object (see
2347 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
2348 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
2349 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
2354 Returns the cancelled package this package was changed from, if any.
2360 return '' unless $self->change_pkgnum;
2361 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
2364 =item change_cust_main
2366 Returns the customter this package was detached to, if any.
2370 sub change_cust_main {
2372 return '' unless $self->change_custnum;
2373 qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
2378 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
2385 $self->part_pkg->calc_setup($self, @_);
2390 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
2397 $self->part_pkg->calc_recur($self, @_);
2402 Calls the I<base_setup> of the FS::part_pkg object associated with this billing
2409 $self->part_pkg->base_setup($self, @_);
2414 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
2421 $self->part_pkg->base_recur($self, @_);
2426 Calls the I<calc_remain> of the FS::part_pkg object associated with this
2433 $self->part_pkg->calc_remain($self, @_);
2438 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
2445 $self->part_pkg->calc_cancel($self, @_);
2450 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
2456 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
2459 =item cust_pkg_detail [ DETAILTYPE ]
2461 Returns any customer package details for this package (see
2462 L<FS::cust_pkg_detail>).
2464 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2468 sub cust_pkg_detail {
2470 my %hash = ( 'pkgnum' => $self->pkgnum );
2471 $hash{detailtype} = shift if @_;
2473 'table' => 'cust_pkg_detail',
2474 'hashref' => \%hash,
2475 'order_by' => 'ORDER BY weight, pkgdetailnum',
2479 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
2481 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
2483 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2485 If there is an error, returns the error, otherwise returns false.
2489 sub set_cust_pkg_detail {
2490 my( $self, $detailtype, @details ) = @_;
2492 local $SIG{HUP} = 'IGNORE';
2493 local $SIG{INT} = 'IGNORE';
2494 local $SIG{QUIT} = 'IGNORE';
2495 local $SIG{TERM} = 'IGNORE';
2496 local $SIG{TSTP} = 'IGNORE';
2497 local $SIG{PIPE} = 'IGNORE';
2499 my $oldAutoCommit = $FS::UID::AutoCommit;
2500 local $FS::UID::AutoCommit = 0;
2503 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
2504 my $error = $current->delete;
2506 $dbh->rollback if $oldAutoCommit;
2507 return "error removing old detail: $error";
2511 foreach my $detail ( @details ) {
2512 my $cust_pkg_detail = new FS::cust_pkg_detail {
2513 'pkgnum' => $self->pkgnum,
2514 'detailtype' => $detailtype,
2515 'detail' => $detail,
2517 my $error = $cust_pkg_detail->insert;
2519 $dbh->rollback if $oldAutoCommit;
2520 return "error adding new detail: $error";
2525 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2532 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
2536 #false laziness w/cust_bill.pm
2540 'table' => 'cust_event',
2541 'addl_from' => 'JOIN part_event USING ( eventpart )',
2542 'hashref' => { 'tablenum' => $self->pkgnum },
2543 'extra_sql' => " AND eventtable = 'cust_pkg' ",
2547 =item num_cust_event
2549 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
2553 #false laziness w/cust_bill.pm
2554 sub num_cust_event {
2557 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
2558 " WHERE tablenum = ? AND eventtable = 'cust_pkg'";
2559 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
2560 $sth->execute($self->pkgnum) or die $sth->errstr. " executing $sql";
2561 $sth->fetchrow_arrayref->[0];
2564 =item part_pkg_currency_option OPTIONNAME
2566 Returns a two item list consisting of the currency of this customer, if any,
2567 and a value for the provided option. If the customer has a currency, the value
2568 is the option value the given name and the currency (see
2569 L<FS::part_pkg_currency>). Otherwise, if the customer has no currency, is the
2570 regular option value for the given name (see L<FS::part_pkg_option>).
2574 sub part_pkg_currency_option {
2575 my( $self, $optionname ) = @_;
2576 my $part_pkg = $self->part_pkg;
2577 if ( my $currency = $self->cust_main->currency ) {
2578 ($currency, $part_pkg->part_pkg_currency_option($currency, $optionname) );
2580 ('', $part_pkg->option($optionname) );
2584 =item cust_svc [ SVCPART ] (old, deprecated usage)
2586 =item cust_svc [ OPTION => VALUE ... ] (current usage)
2588 Returns the services for this package, as FS::cust_svc objects (see
2589 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
2590 spcififed, returns only the matching services.
2597 return () unless $self->num_cust_svc(@_);
2600 if ( @_ && $_[0] =~ /^\d+/ ) {
2601 $opt{svcpart} = shift;
2602 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2609 'table' => 'cust_svc',
2610 'hashref' => { 'pkgnum' => $self->pkgnum },
2612 if ( $opt{svcpart} ) {
2613 $search{hashref}->{svcpart} = $opt{'svcpart'};
2615 if ( $opt{'svcdb'} ) {
2616 $search{addl_from} = ' LEFT JOIN part_svc USING ( svcpart ) ';
2617 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{'svcdb'} );
2620 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
2622 #if ( $self->{'_svcnum'} ) {
2623 # values %{ $self->{'_svcnum'}->cache };
2625 $self->_sort_cust_svc( [ qsearch(\%search) ] );
2630 =item overlimit [ SVCPART ]
2632 Returns the services for this package which have exceeded their
2633 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
2634 is specified, return only the matching services.
2640 return () unless $self->num_cust_svc(@_);
2641 grep { $_->overlimit } $self->cust_svc(@_);
2644 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2646 Returns historical services for this package created before END TIMESTAMP and
2647 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
2648 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
2649 I<pkg_svc.hidden> flag will be omitted.
2655 warn "$me _h_cust_svc called on $self\n"
2658 my ($end, $start, $mode) = @_;
2659 my @cust_svc = $self->_sort_cust_svc(
2660 [ qsearch( 'h_cust_svc',
2661 { 'pkgnum' => $self->pkgnum, },
2662 FS::h_cust_svc->sql_h_search(@_),
2665 if ( defined($mode) && $mode eq 'I' ) {
2666 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
2667 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
2673 sub _sort_cust_svc {
2674 my( $self, $arrayref ) = @_;
2677 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
2679 my %pkg_svc = map { $_->svcpart => $_ }
2680 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
2685 my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
2687 $pkg_svc ? $pkg_svc->primary_svc : '',
2688 $pkg_svc ? $pkg_svc->quantity : 0,
2695 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
2697 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
2699 Returns the number of services for this package. Available options are svcpart
2700 and svcdb. If either is spcififed, returns only the matching services.
2707 return $self->{'_num_cust_svc'}
2709 && exists($self->{'_num_cust_svc'})
2710 && $self->{'_num_cust_svc'} =~ /\d/;
2712 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
2716 if ( @_ && $_[0] =~ /^\d+/ ) {
2717 $opt{svcpart} = shift;
2718 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2724 my $select = 'SELECT COUNT(*) FROM cust_svc ';
2725 my $where = ' WHERE pkgnum = ? ';
2726 my @param = ($self->pkgnum);
2728 if ( $opt{'svcpart'} ) {
2729 $where .= ' AND svcpart = ? ';
2730 push @param, $opt{'svcpart'};
2732 if ( $opt{'svcdb'} ) {
2733 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
2734 $where .= ' AND svcdb = ? ';
2735 push @param, $opt{'svcdb'};
2738 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
2739 $sth->execute(@param) or die $sth->errstr;
2740 $sth->fetchrow_arrayref->[0];
2743 =item available_part_svc
2745 Returns a list of FS::part_svc objects representing services included in this
2746 package but not yet provisioned. Each FS::part_svc object also has an extra
2747 field, I<num_avail>, which specifies the number of available services.
2751 sub available_part_svc {
2754 my $pkg_quantity = $self->quantity || 1;
2756 grep { $_->num_avail > 0 }
2758 my $part_svc = $_->part_svc;
2759 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
2760 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
2762 # more evil encapsulation breakage
2763 if($part_svc->{'Hash'}{'num_avail'} > 0) {
2764 my @exports = $part_svc->part_export_did;
2765 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
2770 $self->part_pkg->pkg_svc;
2773 =item part_svc [ OPTION => VALUE ... ]
2775 Returns a list of FS::part_svc objects representing provisioned and available
2776 services included in this package. Each FS::part_svc object also has the
2777 following extra fields:
2781 =item num_cust_svc (count)
2783 =item num_avail (quantity - count)
2785 =item cust_pkg_svc (services) - array reference containing the provisioned services, as cust_svc objects
2789 Accepts one option: summarize_size. If specified and non-zero, will omit the
2790 extra cust_pkg_svc option for objects where num_cust_svc is this size or
2796 #label -> ($cust_svc->label)[1]
2802 my $pkg_quantity = $self->quantity || 1;
2804 #XXX some sort of sort order besides numeric by svcpart...
2805 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
2807 my $part_svc = $pkg_svc->part_svc;
2808 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
2809 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
2810 $part_svc->{'Hash'}{'num_avail'} =
2811 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
2812 $part_svc->{'Hash'}{'cust_pkg_svc'} =
2813 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
2814 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
2815 && $num_cust_svc >= $opt{summarize_size};
2816 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
2818 } $self->part_pkg->pkg_svc;
2821 push @part_svc, map {
2823 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
2824 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
2825 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
2826 $part_svc->{'Hash'}{'cust_pkg_svc'} =
2827 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
2829 } $self->extra_part_svc;
2835 =item extra_part_svc
2837 Returns a list of FS::part_svc objects corresponding to services in this
2838 package which are still provisioned but not (any longer) available in the
2843 sub extra_part_svc {
2846 my $pkgnum = $self->pkgnum;
2847 #my $pkgpart = $self->pkgpart;
2850 # 'table' => 'part_svc',
2853 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
2854 # WHERE pkg_svc.svcpart = part_svc.svcpart
2855 # AND pkg_svc.pkgpart = ?
2858 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
2859 # LEFT JOIN cust_pkg USING ( pkgnum )
2860 # WHERE cust_svc.svcpart = part_svc.svcpart
2863 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
2866 #seems to benchmark slightly faster... (or did?)
2868 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
2869 my $pkgparts = join(',', @pkgparts);
2872 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
2873 #MySQL doesn't grok DISINCT ON
2874 'select' => 'DISTINCT part_svc.*',
2875 'table' => 'part_svc',
2877 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
2878 AND pkg_svc.pkgpart IN ($pkgparts)
2881 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
2882 LEFT JOIN cust_pkg USING ( pkgnum )
2885 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
2886 'extra_param' => [ [$self->pkgnum=>'int'] ],
2892 Returns a short status string for this package, currently:
2896 =item not yet billed
2898 =item one-time charge
2913 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
2915 return 'cancelled' if $self->get('cancel');
2916 return 'suspended' if $self->susp;
2917 return 'not yet billed' unless $self->setup;
2918 return 'one-time charge' if $freq =~ /^(0|$)/;
2922 =item ucfirst_status
2924 Returns the status with the first character capitalized.
2928 sub ucfirst_status {
2929 ucfirst(shift->status);
2934 Class method that returns the list of possible status strings for packages
2935 (see L<the status method|/status>). For example:
2937 @statuses = FS::cust_pkg->statuses();
2941 tie my %statuscolor, 'Tie::IxHash',
2942 'not yet billed' => '009999', #teal? cyan?
2943 'one-time charge' => '000000',
2944 'active' => '00CC00',
2945 'suspended' => 'FF9900',
2946 'cancelled' => 'FF0000',
2950 my $self = shift; #could be class...
2951 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
2952 # # mayble split btw one-time vs. recur
2958 Returns a hex triplet color string for this package's status.
2964 $statuscolor{$self->status};
2969 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
2970 "pkg - comment" depending on user preference).
2976 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
2977 $label = $self->pkgnum. ": $label"
2978 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
2982 =item pkg_label_long
2984 Returns a long label for this package, adding the primary service's label to
2989 sub pkg_label_long {
2991 my $label = $self->pkg_label;
2992 my $cust_svc = $self->primary_cust_svc;
2993 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
2999 Returns a customer-localized label for this package.
3005 $self->part_pkg->pkg_locale( $self->cust_main->locale );
3008 =item primary_cust_svc
3010 Returns a primary service (as FS::cust_svc object) if one can be identified.
3014 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
3016 sub primary_cust_svc {
3019 my @cust_svc = $self->cust_svc;
3021 return '' unless @cust_svc; #no serivces - irrelevant then
3023 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
3025 # primary service as specified in the package definition
3026 # or exactly one service definition with quantity one
3027 my $svcpart = $self->part_pkg->svcpart;
3028 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
3029 return $cust_svc[0] if scalar(@cust_svc) == 1;
3031 #couldn't identify one thing..
3037 Returns a list of lists, calling the label method for all services
3038 (see L<FS::cust_svc>) of this billing item.
3044 map { [ $_->label ] } $self->cust_svc;
3047 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3049 Like the labels method, but returns historical information on services that
3050 were active as of END_TIMESTAMP and (optionally) not cancelled before
3051 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
3052 I<pkg_svc.hidden> flag will be omitted.
3054 Returns a list of lists, calling the label method for all (historical) services
3055 (see L<FS::h_cust_svc>) of this billing item.
3061 warn "$me _h_labels called on $self\n"
3063 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
3068 Like labels, except returns a simple flat list, and shortens long
3069 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3070 identical services to one line that lists the service label and the number of
3071 individual services rather than individual items.
3076 shift->_labels_short( 'labels', @_ );
3079 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
3081 Like h_labels, except returns a simple flat list, and shortens long
3082 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3083 identical services to one line that lists the service label and the number of
3084 individual services rather than individual items.
3088 sub h_labels_short {
3089 shift->_labels_short( 'h_labels', @_ );
3093 my( $self, $method ) = ( shift, shift );
3095 warn "$me _labels_short called on $self with $method method\n"
3098 my $conf = new FS::Conf;
3099 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
3101 warn "$me _labels_short populating \%labels\n"
3105 #tie %labels, 'Tie::IxHash';
3106 push @{ $labels{$_->[0]} }, $_->[1]
3107 foreach $self->$method(@_);
3109 warn "$me _labels_short populating \@labels\n"
3113 foreach my $label ( keys %labels ) {
3115 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
3116 my $num = scalar(@values);
3117 warn "$me _labels_short $num items for $label\n"
3120 if ( $num > $max_same_services ) {
3121 warn "$me _labels_short more than $max_same_services, so summarizing\n"
3123 push @labels, "$label ($num)";
3125 if ( $conf->exists('cust_bill-consolidate_services') ) {
3126 warn "$me _labels_short consolidating services\n"
3128 # push @labels, "$label: ". join(', ', @values);
3130 my $detail = "$label: ";
3131 $detail .= shift(@values). ', '
3133 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
3135 push @labels, $detail;
3137 warn "$me _labels_short done consolidating services\n"
3140 warn "$me _labels_short adding service data\n"
3142 push @labels, map { "$label: $_" } @values;
3153 Returns the parent customer object (see L<FS::cust_main>).
3159 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
3164 Returns the balance for this specific package, when using
3165 experimental package balance.
3171 $self->cust_main->balance_pkgnum( $self->pkgnum );
3174 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
3178 Returns the location object, if any (see L<FS::cust_location>).
3180 =item cust_location_or_main
3182 If this package is associated with a location, returns the locaiton (see
3183 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
3185 =item location_label [ OPTION => VALUE ... ]
3187 Returns the label of the location object (see L<FS::cust_location>).
3191 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
3193 =item tax_locationnum
3195 Returns the foreign key to a L<FS::cust_location> object for calculating
3196 tax on this package, as determined by the C<tax-pkg_address> and
3197 C<tax-ship_address> configuration flags.
3201 sub tax_locationnum {
3203 my $conf = FS::Conf->new;
3204 if ( $conf->exists('tax-pkg_address') ) {
3205 return $self->locationnum;
3207 elsif ( $conf->exists('tax-ship_address') ) {
3208 return $self->cust_main->ship_locationnum;
3211 return $self->cust_main->bill_locationnum;
3217 Returns the L<FS::cust_location> object for tax_locationnum.
3223 FS::cust_location->by_key( $self->tax_locationnum )
3226 =item seconds_since TIMESTAMP
3228 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
3229 package have been online since TIMESTAMP, according to the session monitor.
3231 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
3232 L<Time::Local> and L<Date::Parse> for conversion functions.
3237 my($self, $since) = @_;
3240 foreach my $cust_svc (
3241 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
3243 $seconds += $cust_svc->seconds_since($since);
3250 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
3252 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
3253 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
3256 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3257 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3263 sub seconds_since_sqlradacct {
3264 my($self, $start, $end) = @_;
3268 foreach my $cust_svc (
3270 my $part_svc = $_->part_svc;
3271 $part_svc->svcdb eq 'svc_acct'
3272 && scalar($part_svc->part_export_usage);
3275 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
3282 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
3284 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
3285 in this package for sessions ending between TIMESTAMP_START (inclusive) and
3289 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3290 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3295 sub attribute_since_sqlradacct {
3296 my($self, $start, $end, $attrib) = @_;
3300 foreach my $cust_svc (
3302 my $part_svc = $_->part_svc;
3303 $part_svc->svcdb eq 'svc_acct'
3304 && scalar($part_svc->part_export_usage);
3307 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
3319 my( $self, $value ) = @_;
3320 if ( defined($value) ) {
3321 $self->setfield('quantity', $value);
3323 $self->getfield('quantity') || 1;
3326 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
3328 Transfers as many services as possible from this package to another package.
3330 The destination package can be specified by pkgnum by passing an FS::cust_pkg
3331 object. The destination package must already exist.
3333 Services are moved only if the destination allows services with the correct
3334 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
3335 this option with caution! No provision is made for export differences
3336 between the old and new service definitions. Probably only should be used
3337 when your exports for all service definitions of a given svcdb are identical.
3338 (attempt a transfer without it first, to move all possible svcpart-matching
3341 Any services that can't be moved remain in the original package.
3343 Returns an error, if there is one; otherwise, returns the number of services
3344 that couldn't be moved.
3349 my ($self, $dest_pkgnum, %opt) = @_;
3355 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
3356 $dest = $dest_pkgnum;
3357 $dest_pkgnum = $dest->pkgnum;
3359 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
3362 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
3364 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
3365 $target{$pkg_svc->svcpart} = $pkg_svc->quantity;
3368 foreach my $cust_svc ($dest->cust_svc) {
3369 $target{$cust_svc->svcpart}--;
3372 my %svcpart2svcparts = ();
3373 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3374 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
3375 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
3376 next if exists $svcpart2svcparts{$svcpart};
3377 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
3378 $svcpart2svcparts{$svcpart} = [
3380 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
3382 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
3383 'svcpart' => $_ } );
3385 $pkg_svc ? $pkg_svc->primary_svc : '',
3386 $pkg_svc ? $pkg_svc->quantity : 0,
3390 grep { $_ != $svcpart }
3392 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
3394 warn "alternates for svcpart $svcpart: ".
3395 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
3400 foreach my $cust_svc ($self->cust_svc) {
3401 if($target{$cust_svc->svcpart} > 0
3402 or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
3403 $target{$cust_svc->svcpart}--;
3404 my $new = new FS::cust_svc { $cust_svc->hash };
3405 $new->pkgnum($dest_pkgnum);
3406 my $error = $new->replace($cust_svc);
3407 return $error if $error;
3408 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3410 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
3411 warn "alternates to consider: ".
3412 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
3414 my @alternate = grep {
3415 warn "considering alternate svcpart $_: ".
3416 "$target{$_} available in new package\n"
3419 } @{$svcpart2svcparts{$cust_svc->svcpart}};
3421 warn "alternate(s) found\n" if $DEBUG;
3422 my $change_svcpart = $alternate[0];
3423 $target{$change_svcpart}--;
3424 my $new = new FS::cust_svc { $cust_svc->hash };
3425 $new->svcpart($change_svcpart);
3426 $new->pkgnum($dest_pkgnum);
3427 my $error = $new->replace($cust_svc);
3428 return $error if $error;
3439 =item grab_svcnums SVCNUM, SVCNUM ...
3441 Change the pkgnum for the provided services to this packages. If there is an
3442 error, returns the error, otherwise returns false.
3450 local $SIG{HUP} = 'IGNORE';
3451 local $SIG{INT} = 'IGNORE';
3452 local $SIG{QUIT} = 'IGNORE';
3453 local $SIG{TERM} = 'IGNORE';
3454 local $SIG{TSTP} = 'IGNORE';
3455 local $SIG{PIPE} = 'IGNORE';
3457 my $oldAutoCommit = $FS::UID::AutoCommit;
3458 local $FS::UID::AutoCommit = 0;
3461 foreach my $svcnum (@svcnum) {
3462 my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
3463 $dbh->rollback if $oldAutoCommit;
3464 return "unknown svcnum $svcnum";
3466 $cust_svc->pkgnum( $self->pkgnum );
3467 my $error = $cust_svc->replace;
3469 $dbh->rollback if $oldAutoCommit;
3474 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3481 This method is deprecated. See the I<depend_jobnum> option to the insert and
3482 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
3486 #looks like this is still used by the order_pkg and change_pkg methods in
3487 # ClientAPI/MyAccount, need to look into those before removing
3491 local $SIG{HUP} = 'IGNORE';
3492 local $SIG{INT} = 'IGNORE';
3493 local $SIG{QUIT} = 'IGNORE';
3494 local $SIG{TERM} = 'IGNORE';
3495 local $SIG{TSTP} = 'IGNORE';
3496 local $SIG{PIPE} = 'IGNORE';
3498 my $oldAutoCommit = $FS::UID::AutoCommit;
3499 local $FS::UID::AutoCommit = 0;
3502 foreach my $cust_svc ( $self->cust_svc ) {
3503 #false laziness w/svc_Common::insert
3504 my $svc_x = $cust_svc->svc_x;
3505 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
3506 my $error = $part_export->export_insert($svc_x);
3508 $dbh->rollback if $oldAutoCommit;
3514 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3519 =item export_pkg_change OLD_CUST_PKG
3521 Calls the "pkg_change" export action for all services attached to this package.
3525 sub export_pkg_change {
3526 my( $self, $old ) = ( shift, shift );
3528 local $SIG{HUP} = 'IGNORE';
3529 local $SIG{INT} = 'IGNORE';
3530 local $SIG{QUIT} = 'IGNORE';
3531 local $SIG{TERM} = 'IGNORE';
3532 local $SIG{TSTP} = 'IGNORE';
3533 local $SIG{PIPE} = 'IGNORE';
3535 my $oldAutoCommit = $FS::UID::AutoCommit;
3536 local $FS::UID::AutoCommit = 0;
3539 foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
3540 my $error = $svc_x->export('pkg_change', $self, $old);
3542 $dbh->rollback if $oldAutoCommit;
3547 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3554 Associates this package with a (suspension or cancellation) reason (see
3555 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
3558 Available options are:
3564 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.
3568 the access_user (see L<FS::access_user>) providing the reason
3576 the action (cancel, susp, adjourn, expire) associated with the reason
3580 If there is an error, returns the error, otherwise returns false.
3585 my ($self, %options) = @_;
3587 my $otaker = $options{reason_otaker} ||
3588 $FS::CurrentUser::CurrentUser->username;
3591 if ( $options{'reason'} =~ /^(\d+)$/ ) {
3595 } elsif ( ref($options{'reason'}) ) {
3597 return 'Enter a new reason (or select an existing one)'
3598 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
3600 my $reason = new FS::reason({
3601 'reason_type' => $options{'reason'}->{'typenum'},
3602 'reason' => $options{'reason'}->{'reason'},
3604 my $error = $reason->insert;
3605 return $error if $error;
3607 $reasonnum = $reason->reasonnum;
3610 return "Unparsable reason: ". $options{'reason'};
3613 my $cust_pkg_reason =
3614 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
3615 'reasonnum' => $reasonnum,
3616 'otaker' => $otaker,
3617 'action' => substr(uc($options{'action'}),0,1),
3618 'date' => $options{'date'}
3623 $cust_pkg_reason->insert;
3626 =item insert_discount
3628 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
3629 inserting a new discount on the fly (see L<FS::discount>).
3631 Available options are:
3639 If there is an error, returns the error, otherwise returns false.
3643 sub insert_discount {
3644 #my ($self, %options) = @_;
3647 my $cust_pkg_discount = new FS::cust_pkg_discount {
3648 'pkgnum' => $self->pkgnum,
3649 'discountnum' => $self->discountnum,
3651 'end_date' => '', #XXX
3652 #for the create a new discount case
3653 '_type' => $self->discountnum__type,
3654 'amount' => $self->discountnum_amount,
3655 'percent' => $self->discountnum_percent,
3656 'months' => $self->discountnum_months,
3657 'setup' => $self->discountnum_setup,
3658 #'disabled' => $self->discountnum_disabled,
3661 $cust_pkg_discount->insert;
3664 =item set_usage USAGE_VALUE_HASHREF
3666 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
3667 to which they should be set (see L<FS::svc_acct>). Currently seconds,
3668 upbytes, downbytes, and totalbytes are appropriate keys.
3670 All svc_accts which are part of this package have their values reset.
3675 my ($self, $valueref, %opt) = @_;
3677 #only svc_acct can set_usage for now
3678 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
3679 my $svc_x = $cust_svc->svc_x;
3680 $svc_x->set_usage($valueref, %opt)
3681 if $svc_x->can("set_usage");
3685 =item recharge USAGE_VALUE_HASHREF
3687 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
3688 to which they should be set (see L<FS::svc_acct>). Currently seconds,
3689 upbytes, downbytes, and totalbytes are appropriate keys.
3691 All svc_accts which are part of this package have their values incremented.
3696 my ($self, $valueref) = @_;
3698 #only svc_acct can set_usage for now
3699 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
3700 my $svc_x = $cust_svc->svc_x;
3701 $svc_x->recharge($valueref)
3702 if $svc_x->can("recharge");
3706 =item cust_pkg_discount
3710 sub cust_pkg_discount {
3712 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
3715 =item cust_pkg_discount_active
3719 sub cust_pkg_discount_active {
3721 grep { $_->status eq 'active' } $self->cust_pkg_discount;
3724 =item cust_pkg_usage
3726 Returns a list of all voice usage counters attached to this package.
3730 sub cust_pkg_usage {
3732 qsearch('cust_pkg_usage', { pkgnum => $self->pkgnum });
3735 =item apply_usage OPTIONS
3737 Takes the following options:
3738 - cdr: a call detail record (L<FS::cdr>)
3739 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
3740 - minutes: the maximum number of minutes to be charged
3742 Finds available usage minutes for a call of this class, and subtracts
3743 up to that many minutes from the usage pool. If the usage pool is empty,
3744 and the C<cdr-minutes_priority> global config option is set, minutes may
3745 be taken from other calls as well. Either way, an allocation record will
3746 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
3747 number of minutes of usage applied to the call.
3752 my ($self, %opt) = @_;
3753 my $cdr = $opt{cdr};
3754 my $rate_detail = $opt{rate_detail};
3755 my $minutes = $opt{minutes};
3756 my $classnum = $rate_detail->classnum;
3757 my $pkgnum = $self->pkgnum;
3758 my $custnum = $self->custnum;
3760 local $SIG{HUP} = 'IGNORE';
3761 local $SIG{INT} = 'IGNORE';
3762 local $SIG{QUIT} = 'IGNORE';
3763 local $SIG{TERM} = 'IGNORE';
3764 local $SIG{TSTP} = 'IGNORE';
3765 local $SIG{PIPE} = 'IGNORE';
3767 my $oldAutoCommit = $FS::UID::AutoCommit;
3768 local $FS::UID::AutoCommit = 0;
3770 my $order = FS::Conf->new->config('cdr-minutes_priority');
3774 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
3776 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
3778 my @usage_recs = qsearch({
3779 'table' => 'cust_pkg_usage',
3780 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
3781 ' JOIN cust_pkg USING (pkgnum)'.
3782 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
3783 'select' => 'cust_pkg_usage.*',
3784 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
3785 " ( cust_pkg.custnum = $custnum AND ".
3786 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
3787 $is_classnum . ' AND '.
3788 " cust_pkg_usage.minutes > 0",
3789 'order_by' => " ORDER BY priority ASC",
3792 my $orig_minutes = $minutes;
3794 while (!$error and $minutes > 0 and @usage_recs) {
3795 my $cust_pkg_usage = shift @usage_recs;
3796 $cust_pkg_usage->select_for_update;
3797 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
3798 pkgusagenum => $cust_pkg_usage->pkgusagenum,
3799 acctid => $cdr->acctid,
3800 minutes => min($cust_pkg_usage->minutes, $minutes),
3802 $cust_pkg_usage->set('minutes',
3803 sprintf('%.0f', $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes)
3805 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
3806 $minutes -= $cdr_cust_pkg_usage->minutes;
3808 if ( $order and $minutes > 0 and !$error ) {
3809 # then try to steal minutes from another call
3811 'table' => 'cdr_cust_pkg_usage',
3812 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
3813 ' JOIN part_pkg_usage USING (pkgusagepart)'.
3814 ' JOIN cust_pkg USING (pkgnum)'.
3815 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
3816 ' JOIN cdr USING (acctid)',
3817 'select' => 'cdr_cust_pkg_usage.*',
3818 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
3819 " ( cust_pkg.pkgnum = $pkgnum OR ".
3820 " ( cust_pkg.custnum = $custnum AND ".
3821 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
3822 " part_pkg_usage_class.classnum = $classnum",
3823 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
3825 if ( $order eq 'time' ) {
3826 # find CDRs that are using minutes, but have a later startdate
3828 my $startdate = $cdr->startdate;
3829 if ($startdate !~ /^\d+$/) {
3830 die "bad cdr startdate '$startdate'";
3832 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
3833 # minimize needless reshuffling
3834 $search{'order_by'} .= ', cdr.startdate DESC';
3836 # XXX may not work correctly with rate_time schedules. Could
3837 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
3839 $search{'addl_from'} .=
3840 ' JOIN rate_detail'.
3841 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
3842 if ( $order eq 'rate_high' ) {
3843 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
3844 $rate_detail->min_charge;
3845 $search{'order_by'} .= ', rate_detail.min_charge ASC';
3846 } elsif ( $order eq 'rate_low' ) {
3847 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
3848 $rate_detail->min_charge;
3849 $search{'order_by'} .= ', rate_detail.min_charge DESC';
3851 # this should really never happen
3852 die "invalid cdr-minutes_priority value '$order'\n";
3855 my @cdr_usage_recs = qsearch(\%search);
3857 while (!$error and @cdr_usage_recs and $minutes > 0) {
3858 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
3859 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
3860 my $old_cdr = $cdr_cust_pkg_usage->cdr;
3861 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
3862 $cdr_cust_pkg_usage->select_for_update;
3863 $old_cdr->select_for_update;
3864 $cust_pkg_usage->select_for_update;
3865 # in case someone else stole the usage from this CDR
3866 # while waiting for the lock...
3867 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
3868 # steal the usage allocation and flag the old CDR for reprocessing
3869 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
3870 # if the allocation is more minutes than we need, adjust it...
3871 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
3873 $cdr_cust_pkg_usage->set('minutes', $minutes);
3874 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
3875 $error = $cust_pkg_usage->replace;
3877 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
3878 $error ||= $cdr_cust_pkg_usage->replace;
3879 # deduct the stolen minutes
3880 $minutes -= $cdr_cust_pkg_usage->minutes;
3882 # after all minute-stealing is done, reset the affected CDRs
3883 foreach (values %reproc_cdrs) {
3884 $error ||= $_->set_status('');
3885 # XXX or should we just call $cdr->rate right here?
3886 # it's not like we can create a loop this way, since the min_charge
3887 # or call time has to go monotonically in one direction.
3888 # we COULD get some very deep recursions going, though...
3890 } # if $order and $minutes
3893 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
3895 $dbh->commit if $oldAutoCommit;
3896 return $orig_minutes - $minutes;
3900 =item supplemental_pkgs
3902 Returns a list of all packages supplemental to this one.
3906 sub supplemental_pkgs {
3908 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
3913 Returns the package that this one is supplemental to, if any.
3919 if ( $self->main_pkgnum ) {
3920 return FS::cust_pkg->by_key($self->main_pkgnum);
3927 =head1 CLASS METHODS
3933 Returns an SQL expression identifying recurring packages.
3937 sub recurring_sql { "
3938 '0' != ( select freq from part_pkg
3939 where cust_pkg.pkgpart = part_pkg.pkgpart )
3944 Returns an SQL expression identifying one-time packages.
3949 '0' = ( select freq from part_pkg
3950 where cust_pkg.pkgpart = part_pkg.pkgpart )
3955 Returns an SQL expression identifying ordered packages (recurring packages not
3961 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
3966 Returns an SQL expression identifying active packages.
3971 $_[0]->recurring_sql. "
3972 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
3973 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3974 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
3977 =item not_yet_billed_sql
3979 Returns an SQL expression identifying packages which have not yet been billed.
3983 sub not_yet_billed_sql { "
3984 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
3985 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3986 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
3991 Returns an SQL expression identifying inactive packages (one-time packages
3992 that are otherwise unsuspended/uncancelled).
3996 sub inactive_sql { "
3997 ". $_[0]->onetime_sql(). "
3998 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
3999 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4000 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4006 Returns an SQL expression identifying suspended packages.
4010 sub suspended_sql { susp_sql(@_); }
4012 #$_[0]->recurring_sql(). ' AND '.
4014 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4015 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4022 Returns an SQL exprression identifying cancelled packages.
4026 sub cancelled_sql { cancel_sql(@_); }
4028 #$_[0]->recurring_sql(). ' AND '.
4029 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
4034 Returns an SQL expression to give the package status as a string.
4040 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
4041 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
4042 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
4043 WHEN ".onetime_sql()." THEN 'one-time charge'
4048 =item search HASHREF
4052 Returns a qsearch hash expression to search for parameters specified in HASHREF.
4053 Valid parameters are
4061 active, inactive, suspended, cancel (or cancelled)
4065 active, inactive, suspended, one-time charge, inactive, cancel (or cancelled)
4069 boolean selects custom packages
4075 pkgpart or arrayref or hashref of pkgparts
4079 arrayref of beginning and ending epoch date
4083 arrayref of beginning and ending epoch date
4087 arrayref of beginning and ending epoch date
4091 arrayref of beginning and ending epoch date
4095 arrayref of beginning and ending epoch date
4099 arrayref of beginning and ending epoch date
4103 arrayref of beginning and ending epoch date
4107 pkgnum or APKG_pkgnum
4111 a value suited to passing to FS::UI::Web::cust_header
4115 specifies the user for agent virtualization
4119 boolean; if true, returns only packages with more than 0 FCC phone lines.
4121 =item state, country
4123 Limit to packages with a service location in the specified state and country.
4124 For FCC 477 reporting, mostly.
4131 my ($class, $params) = @_;
4138 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
4140 "cust_main.agentnum = $1";
4147 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
4149 "cust_pkg.custnum = $1";
4156 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
4158 "cust_pkg.pkgbatch = '$1'";
4165 if ( $params->{'magic'} eq 'active'
4166 || $params->{'status'} eq 'active' ) {
4168 push @where, FS::cust_pkg->active_sql();
4170 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
4171 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
4173 push @where, FS::cust_pkg->not_yet_billed_sql();
4175 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
4176 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
4178 push @where, FS::cust_pkg->inactive_sql();
4180 } elsif ( $params->{'magic'} eq 'suspended'
4181 || $params->{'status'} eq 'suspended' ) {
4183 push @where, FS::cust_pkg->suspended_sql();
4185 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
4186 || $params->{'status'} =~ /^cancell?ed$/ ) {
4188 push @where, FS::cust_pkg->cancelled_sql();
4193 # parse package class
4196 if ( exists($params->{'classnum'}) ) {
4199 if ( ref($params->{'classnum'}) ) {
4201 if ( ref($params->{'classnum'}) eq 'HASH' ) {
4202 @classnum = grep $params->{'classnum'}{$_}, keys %{ $params->{'classnum'} };
4203 } elsif ( ref($params->{'classnum'}) eq 'ARRAY' ) {
4204 @classnum = @{ $params->{'classnum'} };
4206 die 'unhandled classnum ref '. $params->{'classnum'};
4210 } elsif ( $params->{'classnum'} =~ /^(\d*)$/ && $1 ne '0' ) {
4217 my @nums = grep $_, @classnum;
4218 push @c_where, 'part_pkg.classnum IN ('. join(',',@nums). ')' if @nums;
4219 my $null = scalar( grep { $_ eq '' } @classnum );
4220 push @c_where, 'part_pkg.classnum IS NULL' if $null;
4222 if ( scalar(@c_where) == 1 ) {
4223 push @where, @c_where;
4224 } elsif ( @c_where ) {
4225 push @where, ' ( '. join(' OR ', @c_where). ' ) ';
4234 # parse package report options
4237 my @report_option = ();
4238 if ( exists($params->{'report_option'}) ) {
4239 if ( ref($params->{'report_option'}) eq 'ARRAY' ) {
4240 @report_option = @{ $params->{'report_option'} };
4241 } elsif ( $params->{'report_option'} =~ /^([,\d]*)$/ ) {
4242 @report_option = split(',', $1);
4247 if (@report_option) {
4248 # this will result in the empty set for the dangling comma case as it should
4250 map{ "0 < ( SELECT count(*) FROM part_pkg_option
4251 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
4252 AND optionname = 'report_option_$_'
4253 AND optionvalue = '1' )"
4257 foreach my $any ( grep /^report_option_any/, keys %$params ) {
4259 my @report_option_any = ();
4260 if ( ref($params->{$any}) eq 'ARRAY' ) {
4261 @report_option_any = @{ $params->{$any} };
4262 } elsif ( $params->{$any} =~ /^([,\d]*)$/ ) {
4263 @report_option_any = split(',', $1);
4266 if (@report_option_any) {
4267 # this will result in the empty set for the dangling comma case as it should
4268 push @where, ' ( '. join(' OR ',
4269 map{ "0 < ( SELECT count(*) FROM part_pkg_option
4270 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
4271 AND optionname = 'report_option_$_'
4272 AND optionvalue = '1' )"
4273 } @report_option_any
4283 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
4289 push @where, "(part_pkg.fcc_ds0s > 0 OR pkg_class.fcc_ds0s > 0)"
4290 if $params->{fcc_line};
4296 if ( exists($params->{'censustract'}) ) {
4297 $params->{'censustract'} =~ /^([.\d]*)$/;
4298 my $censustract = "cust_location.censustract = '$1'";
4299 $censustract .= ' OR cust_location.censustract is NULL' unless $1;
4300 push @where, "( $censustract )";
4304 # parse censustract2
4306 if ( exists($params->{'censustract2'})
4307 && $params->{'censustract2'} =~ /^(\d*)$/
4311 push @where, "cust_location.censustract LIKE '$1%'";
4314 "( cust_location.censustract = '' OR cust_location.censustract IS NULL )";
4319 # parse country/state
4321 for (qw(state country)) { # parsing rules are the same for these
4322 if ( exists($params->{$_})
4323 && uc($params->{$_}) =~ /^([A-Z]{2})$/ )
4325 # XXX post-2.3 only--before that, state/country may be in cust_main
4326 push @where, "cust_location.$_ = '$1'";
4334 if ( ref($params->{'pkgpart'}) ) {
4337 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
4338 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
4339 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
4340 @pkgpart = @{ $params->{'pkgpart'} };
4342 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
4345 @pkgpart = grep /^(\d+)$/, @pkgpart;
4347 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
4349 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
4350 push @where, "pkgpart = $1";
4359 #false laziness w/report_cust_pkg.html
4362 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
4363 'active' => { 'susp'=>1, 'cancel'=>1 },
4364 'suspended' => { 'cancel' => 1 },
4369 if( exists($params->{'active'} ) ) {
4370 # This overrides all the other date-related fields
4371 my($beginning, $ending) = @{$params->{'active'}};
4373 "cust_pkg.setup IS NOT NULL",
4374 "cust_pkg.setup <= $ending",
4375 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
4376 "NOT (".FS::cust_pkg->onetime_sql . ")";
4379 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end change_date cancel )) {
4381 next unless exists($params->{$field});
4383 my($beginning, $ending) = @{$params->{$field}};
4385 next if $beginning == 0 && $ending == 4294967295;
4388 "cust_pkg.$field IS NOT NULL",
4389 "cust_pkg.$field >= $beginning",
4390 "cust_pkg.$field <= $ending";
4392 $orderby ||= "ORDER BY cust_pkg.$field";
4397 $orderby ||= 'ORDER BY bill';
4400 # parse magic, legacy, etc.
4403 if ( $params->{'magic'} &&
4404 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
4407 $orderby = 'ORDER BY pkgnum';
4409 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
4410 push @where, "pkgpart = $1";
4413 } elsif ( $params->{'query'} eq 'pkgnum' ) {
4415 $orderby = 'ORDER BY pkgnum';
4417 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
4419 $orderby = 'ORDER BY pkgnum';
4422 SELECT count(*) FROM pkg_svc
4423 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
4424 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
4425 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
4426 AND cust_svc.svcpart = pkg_svc.svcpart
4433 # setup queries, links, subs, etc. for the search
4436 # here is the agent virtualization
4437 if ($params->{CurrentUser}) {
4439 qsearchs('access_user', { username => $params->{CurrentUser} });
4442 push @where, $access_user->agentnums_sql('table'=>'cust_main');
4447 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
4450 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
4452 my $addl_from = 'LEFT JOIN part_pkg USING ( pkgpart ) '.
4453 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) '.
4454 'LEFT JOIN cust_location USING ( locationnum ) '.
4455 FS::UI::Web::join_cust_main('cust_pkg', 'cust_pkg');
4459 if ( $params->{'select_zip5'} ) {
4460 my $zip = 'cust_location.zip';
4462 $select = "DISTINCT substr($zip,1,5) as zip";
4463 $orderby = "ORDER BY substr($zip,1,5)";
4464 $count_query = "SELECT COUNT( DISTINCT substr($zip,1,5) )";
4466 $select = join(', ',
4468 ( map "part_pkg.$_", qw( pkg freq ) ),
4469 'pkg_class.classname',
4470 'cust_main.custnum AS cust_main_custnum',
4471 FS::UI::Web::cust_sql_fields(
4472 $params->{'cust_fields'}
4475 $count_query = 'SELECT COUNT(*)';
4478 $count_query .= " FROM cust_pkg $addl_from $extra_sql";
4481 'table' => 'cust_pkg',
4483 'select' => $select,
4484 'extra_sql' => $extra_sql,
4485 'order_by' => $orderby,
4486 'addl_from' => $addl_from,
4487 'count_query' => $count_query,
4494 Returns a list of two package counts. The first is a count of packages
4495 based on the supplied criteria and the second is the count of residential
4496 packages with those same criteria. Criteria are specified as in the search
4502 my ($class, $params) = @_;
4504 my $sql_query = $class->search( $params );
4506 my $count_sql = delete($sql_query->{'count_query'});
4507 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
4508 or die "couldn't parse count_sql";
4510 my $count_sth = dbh->prepare($count_sql)
4511 or die "Error preparing $count_sql: ". dbh->errstr;
4513 or die "Error executing $count_sql: ". $count_sth->errstr;
4514 my $count_arrayref = $count_sth->fetchrow_arrayref;
4516 return ( @$count_arrayref );
4520 =item tax_locationnum_sql
4522 Returns an SQL expression for the tax location for a package, based
4523 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
4527 sub tax_locationnum_sql {
4528 my $conf = FS::Conf->new;
4529 if ( $conf->exists('tax-pkg_address') ) {
4530 'cust_pkg.locationnum';
4532 elsif ( $conf->exists('tax-ship_address') ) {
4533 'cust_main.ship_locationnum';
4536 'cust_main.bill_locationnum';
4542 Returns a list: the first item is an SQL fragment identifying matching
4543 packages/customers via location (taking into account shipping and package
4544 address taxation, if enabled), and subsequent items are the parameters to
4545 substitute for the placeholders in that fragment.
4550 my($class, %opt) = @_;
4551 my $ornull = $opt{'ornull'};
4553 my $conf = new FS::Conf;
4555 # '?' placeholders in _location_sql_where
4556 my $x = $ornull ? 3 : 2;
4567 if ( $conf->exists('tax-ship_address') ) {
4570 ( ( ship_last IS NULL OR ship_last = '' )
4571 AND ". _location_sql_where('cust_main', '', $ornull ). "
4573 OR ( ship_last IS NOT NULL AND ship_last != ''
4574 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
4577 # AND payby != 'COMP'
4579 @main_param = ( @bill_param, @bill_param );
4583 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
4584 @main_param = @bill_param;
4590 if ( $conf->exists('tax-pkg_address') ) {
4592 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
4595 ( cust_pkg.locationnum IS NULL AND $main_where )
4596 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
4599 @param = ( @main_param, @bill_param );
4603 $where = $main_where;
4604 @param = @main_param;
4612 #subroutine, helper for location_sql
4613 sub _location_sql_where {
4615 my $prefix = @_ ? shift : '';
4616 my $ornull = @_ ? shift : '';
4618 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
4620 $ornull = $ornull ? ' OR ? IS NULL ' : '';
4622 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
4623 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
4624 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
4626 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
4628 # ( $table.${prefix}city = ? $or_empty_city $ornull )
4630 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4631 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4632 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
4633 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
4634 AND $table.${prefix}country = ?
4639 my( $self, $what ) = @_;
4641 my $what_show_zero = $what. '_show_zero';
4642 length($self->$what_show_zero())
4643 ? ($self->$what_show_zero() eq 'Y')
4644 : $self->part_pkg->$what_show_zero();
4651 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
4653 CUSTNUM is a customer (see L<FS::cust_main>)
4655 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4656 L<FS::part_pkg>) to order for this customer. Duplicates are of course
4659 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
4660 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
4661 new billing items. An error is returned if this is not possible (see
4662 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
4665 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4666 newly-created cust_pkg objects.
4668 REFNUM, if specified, will specify the FS::pkg_referral record to be created
4669 and inserted. Multiple FS::pkg_referral records can be created by
4670 setting I<refnum> to an array reference of refnums or a hash reference with
4671 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
4672 record will be created corresponding to cust_main.refnum.
4677 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
4679 my $conf = new FS::Conf;
4681 # Transactionize this whole mess
4682 local $SIG{HUP} = 'IGNORE';
4683 local $SIG{INT} = 'IGNORE';
4684 local $SIG{QUIT} = 'IGNORE';
4685 local $SIG{TERM} = 'IGNORE';
4686 local $SIG{TSTP} = 'IGNORE';
4687 local $SIG{PIPE} = 'IGNORE';
4689 my $oldAutoCommit = $FS::UID::AutoCommit;
4690 local $FS::UID::AutoCommit = 0;
4694 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
4695 # return "Customer not found: $custnum" unless $cust_main;
4697 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
4700 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4703 my $change = scalar(@old_cust_pkg) != 0;
4706 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
4708 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
4709 " to pkgpart ". $pkgparts->[0]. "\n"
4712 my $err_or_cust_pkg =
4713 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
4714 'refnum' => $refnum,
4717 unless (ref($err_or_cust_pkg)) {
4718 $dbh->rollback if $oldAutoCommit;
4719 return $err_or_cust_pkg;
4722 push @$return_cust_pkg, $err_or_cust_pkg;
4723 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4728 # Create the new packages.
4729 foreach my $pkgpart (@$pkgparts) {
4731 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
4733 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
4734 pkgpart => $pkgpart,
4738 $error = $cust_pkg->insert( 'change' => $change );
4739 push @$return_cust_pkg, $cust_pkg;
4741 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
4742 my $supp_pkg = FS::cust_pkg->new({
4743 custnum => $custnum,
4744 pkgpart => $link->dst_pkgpart,
4746 main_pkgnum => $cust_pkg->pkgnum,
4749 $error ||= $supp_pkg->insert( 'change' => $change );
4750 push @$return_cust_pkg, $supp_pkg;
4754 $dbh->rollback if $oldAutoCommit;
4759 # $return_cust_pkg now contains refs to all of the newly
4762 # Transfer services and cancel old packages.
4763 foreach my $old_pkg (@old_cust_pkg) {
4765 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
4768 foreach my $new_pkg (@$return_cust_pkg) {
4769 $error = $old_pkg->transfer($new_pkg);
4770 if ($error and $error == 0) {
4771 # $old_pkg->transfer failed.
4772 $dbh->rollback if $oldAutoCommit;
4777 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
4778 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
4779 foreach my $new_pkg (@$return_cust_pkg) {
4780 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
4781 if ($error and $error == 0) {
4782 # $old_pkg->transfer failed.
4783 $dbh->rollback if $oldAutoCommit;
4790 # Transfers were successful, but we went through all of the
4791 # new packages and still had services left on the old package.
4792 # We can't cancel the package under the circumstances, so abort.
4793 $dbh->rollback if $oldAutoCommit;
4794 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
4796 $error = $old_pkg->cancel( quiet=>1 );
4802 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4806 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
4808 A bulk change method to change packages for multiple customers.
4810 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4811 L<FS::part_pkg>) to order for each customer. Duplicates are of course
4814 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
4815 replace. The services (see L<FS::cust_svc>) are moved to the
4816 new billing items. An error is returned if this is not possible (see
4819 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4820 newly-created cust_pkg objects.
4825 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
4827 # Transactionize this whole mess
4828 local $SIG{HUP} = 'IGNORE';
4829 local $SIG{INT} = 'IGNORE';
4830 local $SIG{QUIT} = 'IGNORE';
4831 local $SIG{TERM} = 'IGNORE';
4832 local $SIG{TSTP} = 'IGNORE';
4833 local $SIG{PIPE} = 'IGNORE';
4835 my $oldAutoCommit = $FS::UID::AutoCommit;
4836 local $FS::UID::AutoCommit = 0;
4840 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4843 while(scalar(@old_cust_pkg)) {
4845 my $custnum = $old_cust_pkg[0]->custnum;
4846 my (@remove) = map { $_->pkgnum }
4847 grep { $_->custnum == $custnum } @old_cust_pkg;
4848 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
4850 my $error = order $custnum, $pkgparts, \@remove, \@return;
4852 push @errors, $error
4854 push @$return_cust_pkg, @return;
4857 if (scalar(@errors)) {
4858 $dbh->rollback if $oldAutoCommit;
4859 return join(' / ', @errors);
4862 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4866 # Used by FS::Upgrade to migrate to a new database.
4867 sub _upgrade_data { # class method
4868 my ($class, %opts) = @_;
4869 $class->_upgrade_otaker(%opts);
4871 # RT#10139, bug resulting in contract_end being set when it shouldn't
4872 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
4873 # RT#10830, bad calculation of prorate date near end of year
4874 # the date range for bill is December 2009, and we move it forward
4875 # one year if it's before the previous bill date (which it should
4877 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
4878 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
4879 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
4880 # RT6628, add order_date to cust_pkg
4881 'update cust_pkg set order_date = (select history_date from h_cust_pkg
4882 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
4883 history_action = \'insert\') where order_date is null',
4885 foreach my $sql (@statements) {
4886 my $sth = dbh->prepare($sql);
4887 $sth->execute or die $sth->errstr;
4895 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
4897 In sub order, the @pkgparts array (passed by reference) is clobbered.
4899 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
4900 method to pass dates to the recur_prog expression, it should do so.
4902 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
4903 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
4904 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
4905 configuration values. Probably need a subroutine which decides what to do
4906 based on whether or not we've fetched the user yet, rather than a hash. See
4907 FS::UID and the TODO.
4909 Now that things are transactional should the check in the insert method be
4914 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
4915 L<FS::pkg_svc>, schema.html from the base documentation