4 use base qw( FS::otaker_Mixin FS::cust_main_Mixin
5 FS::contact_Mixin FS::location_Mixin
6 FS::m2m_Common FS::option_Common );
7 use vars qw($disable_agentcheck $DEBUG $me);
9 use Scalar::Util qw( blessed );
10 use List::Util qw(min max);
12 use Time::Local qw( timelocal timelocal_nocheck );
14 use FS::UID qw( getotaker dbh driver_name );
15 use FS::Misc qw( send_email );
16 use FS::Record qw( qsearch qsearchs fields );
22 use FS::cust_location;
24 use FS::cust_bill_pkg;
25 use FS::cust_pkg_detail;
26 use FS::cust_pkg_usage;
27 use FS::cdr_cust_pkg_usage;
32 use FS::cust_pkg_reason;
34 use FS::cust_pkg_discount;
39 # need to 'use' these instead of 'require' in sub { cancel, suspend, unsuspend,
41 # because they load configuration by setting FS::UID::callback (see TODO)
47 # for sending cancel emails in sub cancel
51 $me = '[FS::cust_pkg]';
53 $disable_agentcheck = 0;
57 my ( $hashref, $cache ) = @_;
58 #if ( $hashref->{'pkgpart'} ) {
59 if ( $hashref->{'pkg'} ) {
60 # #@{ $self->{'_pkgnum'} } = ();
61 # my $subcache = $cache->subcache('pkgpart', 'part_pkg');
62 # $self->{'_pkgpart'} = $subcache;
63 # #push @{ $self->{'_pkgnum'} },
64 # FS::part_pkg->new_or_cached($hashref, $subcache);
65 $self->{'_pkgpart'} = FS::part_pkg->new($hashref);
67 if ( exists $hashref->{'svcnum'} ) {
68 #@{ $self->{'_pkgnum'} } = ();
69 my $subcache = $cache->subcache('svcnum', 'cust_svc', $hashref->{pkgnum});
70 $self->{'_svcnum'} = $subcache;
71 #push @{ $self->{'_pkgnum'} },
72 FS::cust_svc->new_or_cached($hashref, $subcache) if $hashref->{svcnum};
78 FS::cust_pkg - Object methods for cust_pkg objects
84 $record = new FS::cust_pkg \%hash;
85 $record = new FS::cust_pkg { 'column' => 'value' };
87 $error = $record->insert;
89 $error = $new_record->replace($old_record);
91 $error = $record->delete;
93 $error = $record->check;
95 $error = $record->cancel;
97 $error = $record->suspend;
99 $error = $record->unsuspend;
101 $part_pkg = $record->part_pkg;
103 @labels = $record->labels;
105 $seconds = $record->seconds_since($timestamp);
107 $error = FS::cust_pkg::order( $custnum, \@pkgparts );
108 $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );
112 An FS::cust_pkg object represents a customer billing item. FS::cust_pkg
113 inherits from FS::Record. The following fields are currently supported:
119 Primary key (assigned automatically for new billing items)
123 Customer (see L<FS::cust_main>)
127 Billing item definition (see L<FS::part_pkg>)
131 Optional link to package location (see L<FS::location>)
135 date package was ordered (also remains same on changes)
147 date (next bill date)
175 order taker (see L<FS::access_user>)
179 If this field is set to 1, disables the automatic
180 unsuspension of this package when using the B<unsuspendauto> config option.
184 If not set, defaults to 1
188 Date of change from previous package
198 =item change_locationnum
206 The pkgnum of the package that this package is supplemental to, if any.
210 The package link (L<FS::part_pkg_link>) that defines this supplemental
211 package, if it is one.
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 since 1.4.2 and 1.5.0pre6; however, starting with 1.7.0 this needs to be
1454 explicitly requested. Price plans for which this makes sense (anniversary-date
1455 based than prorate or subscription) could have an option to enable this
1460 If there is an error, returns the error, otherwise returns false.
1465 my( $self, %opt ) = @_;
1468 # pass all suspend/cancel actions to the main package
1469 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1470 return $self->main_pkg->unsuspend(%opt);
1473 local $SIG{HUP} = 'IGNORE';
1474 local $SIG{INT} = 'IGNORE';
1475 local $SIG{QUIT} = 'IGNORE';
1476 local $SIG{TERM} = 'IGNORE';
1477 local $SIG{TSTP} = 'IGNORE';
1478 local $SIG{PIPE} = 'IGNORE';
1480 my $oldAutoCommit = $FS::UID::AutoCommit;
1481 local $FS::UID::AutoCommit = 0;
1484 my $old = $self->select_for_update;
1486 my $pkgnum = $old->pkgnum;
1487 if ( $old->get('cancel') || $self->get('cancel') ) {
1488 $dbh->rollback if $oldAutoCommit;
1489 return "Can't unsuspend cancelled package $pkgnum";
1492 unless ( $old->get('susp') && $self->get('susp') ) {
1493 $dbh->rollback if $oldAutoCommit;
1494 return ""; # no error # complain instead?
1497 my $date = $opt{'date'};
1498 if ( $date and $date > time ) { # return an error if $date <= time?
1500 if ( $old->get('expire') && $old->get('expire') < $date ) {
1501 $dbh->rollback if $oldAutoCommit;
1502 return "Package $pkgnum expires before it would be unsuspended.";
1505 my $new = new FS::cust_pkg { $self->hash };
1506 $new->set('resume', $date);
1507 $error = $new->replace($self, options => $self->options);
1510 $dbh->rollback if $oldAutoCommit;
1514 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1522 foreach my $cust_svc (
1523 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1525 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1527 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1528 $dbh->rollback if $oldAutoCommit;
1529 return "Illegal svcdb value in part_svc!";
1532 require "FS/$svcdb.pm";
1534 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1536 $error = $svc->unsuspend;
1538 $dbh->rollback if $oldAutoCommit;
1541 my( $label, $value ) = $cust_svc->label;
1542 push @labels, "$label: $value";
1547 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1548 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1550 my %hash = $self->hash;
1551 my $inactive = time - $hash{'susp'};
1553 my $conf = new FS::Conf;
1555 if ( $inactive > 0 &&
1556 ( $hash{'bill'} || $hash{'setup'} ) &&
1557 ( $opt{'adjust_next_bill'} ||
1558 $conf->exists('unsuspend-always_adjust_next_bill_date') ||
1559 $self->part_pkg->option('unsuspend_adjust_bill', 1) )
1562 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1567 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1568 $hash{'resume'} = '' if !$hash{'adjourn'};
1569 my $new = new FS::cust_pkg ( \%hash );
1570 $error = $new->replace( $self, options => { $self->options } );
1572 $dbh->rollback if $oldAutoCommit;
1578 if ( $reason && $reason->unsuspend_pkgpart ) {
1579 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
1580 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
1582 my $start_date = $self->cust_main->next_bill_date
1583 if $reason->unsuspend_hold;
1586 $unsusp_pkg = FS::cust_pkg->new({
1587 'custnum' => $self->custnum,
1588 'pkgpart' => $reason->unsuspend_pkgpart,
1589 'start_date' => $start_date,
1590 'locationnum' => $self->locationnum,
1591 # discount? probably not...
1594 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
1598 $dbh->rollback if $oldAutoCommit;
1603 if ( $conf->config('unsuspend_email_admin') ) {
1605 my $error = send_email(
1606 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1607 #invoice_from ??? well as good as any
1608 'to' => $conf->config('unsuspend_email_admin'),
1609 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
1610 "This is an automatic message from your Freeside installation\n",
1611 "informing you that the following customer package has been unsuspended:\n",
1613 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1614 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1615 ( map { "Service : $_\n" } @labels ),
1617 "An unsuspension fee was charged: ".
1618 $unsusp_pkg->part_pkg->pkg_comment."\n"
1625 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
1631 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1632 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
1634 $dbh->rollback if $oldAutoCommit;
1635 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1639 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1646 Cancels any pending suspension (sets the adjourn field to null).
1648 If there is an error, returns the error, otherwise returns false.
1653 my( $self, %options ) = @_;
1656 local $SIG{HUP} = 'IGNORE';
1657 local $SIG{INT} = 'IGNORE';
1658 local $SIG{QUIT} = 'IGNORE';
1659 local $SIG{TERM} = 'IGNORE';
1660 local $SIG{TSTP} = 'IGNORE';
1661 local $SIG{PIPE} = 'IGNORE';
1663 my $oldAutoCommit = $FS::UID::AutoCommit;
1664 local $FS::UID::AutoCommit = 0;
1667 my $old = $self->select_for_update;
1669 my $pkgnum = $old->pkgnum;
1670 if ( $old->get('cancel') || $self->get('cancel') ) {
1671 dbh->rollback if $oldAutoCommit;
1672 return "Can't unadjourn cancelled package $pkgnum";
1673 # or at least it's pointless
1676 if ( $old->get('susp') || $self->get('susp') ) {
1677 dbh->rollback if $oldAutoCommit;
1678 return "Can't unadjourn suspended package $pkgnum";
1679 # perhaps this is arbitrary
1682 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1683 dbh->rollback if $oldAutoCommit;
1684 return ""; # no error
1687 my %hash = $self->hash;
1688 $hash{'adjourn'} = '';
1689 $hash{'resume'} = '';
1690 my $new = new FS::cust_pkg ( \%hash );
1691 $error = $new->replace( $self, options => { $self->options } );
1693 $dbh->rollback if $oldAutoCommit;
1697 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1704 =item change HASHREF | OPTION => VALUE ...
1706 Changes this package: cancels it and creates a new one, with a different
1707 pkgpart or locationnum or both. All services are transferred to the new
1708 package (no change will be made if this is not possible).
1710 Options may be passed as a list of key/value pairs or as a hash reference.
1717 New locationnum, to change the location for this package.
1721 New FS::cust_location object, to create a new location and assign it
1726 New FS::cust_main object, to create a new customer and assign the new package
1731 New pkgpart (see L<FS::part_pkg>).
1735 New refnum (see L<FS::part_referral>).
1739 "New" (existing) FS::cust_pkg object. The package's services and other
1740 attributes will be transferred to this package.
1744 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1745 susp, adjourn, cancel, expire, and contract_end) to the new package.
1747 =item unprotect_svcs
1749 Normally, change() will rollback and return an error if some services
1750 can't be transferred (also see the I<cust_pkg-change_svcpart> config option).
1751 If unprotect_svcs is true, this method will transfer as many services as
1752 it can and then unconditionally cancel the old package.
1756 At least one of locationnum, cust_location, pkgpart, refnum, cust_main, or
1757 cust_pkg must be specified (otherwise, what's the point?)
1759 Returns either the new FS::cust_pkg object or a scalar error.
1763 my $err_or_new_cust_pkg = $old_cust_pkg->change
1767 #some false laziness w/order
1770 my $opt = ref($_[0]) ? shift : { @_ };
1772 # my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
1775 my $conf = new FS::Conf;
1777 # Transactionize this whole mess
1778 local $SIG{HUP} = 'IGNORE';
1779 local $SIG{INT} = 'IGNORE';
1780 local $SIG{QUIT} = 'IGNORE';
1781 local $SIG{TERM} = 'IGNORE';
1782 local $SIG{TSTP} = 'IGNORE';
1783 local $SIG{PIPE} = 'IGNORE';
1785 my $oldAutoCommit = $FS::UID::AutoCommit;
1786 local $FS::UID::AutoCommit = 0;
1795 #$hash{$_} = $self->$_() foreach qw( last_bill bill );
1797 #$hash{$_} = $self->$_() foreach qw( setup );
1799 $hash{'setup'} = $time if $self->setup;
1801 $hash{'change_date'} = $time;
1802 $hash{"change_$_"} = $self->$_()
1803 foreach qw( pkgnum pkgpart locationnum );
1805 if ( $opt->{'cust_location'} ) {
1806 $error = $opt->{'cust_location'}->find_or_insert;
1808 $dbh->rollback if $oldAutoCommit;
1809 return "inserting cust_location (transaction rolled back): $error";
1811 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1814 if ( $opt->{'cust_pkg'} ) {
1815 # treat changing to a package with a different pkgpart as a
1816 # pkgpart change (because it is)
1817 $opt->{'pkgpart'} = $opt->{'cust_pkg'}->pkgpart;
1820 # whether to override pkgpart checking on the new package
1821 my $same_pkgpart = 1;
1822 if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
1826 my $unused_credit = 0;
1827 my $keep_dates = $opt->{'keep_dates'};
1828 # Special case. If the pkgpart is changing, and the customer is
1829 # going to be credited for remaining time, don't keep setup, bill,
1830 # or last_bill dates, and DO pass the flag to cancel() to credit
1832 if ( $opt->{'pkgpart'}
1833 and $opt->{'pkgpart'} != $self->pkgpart
1834 and $self->part_pkg->option('unused_credit_change', 1) ) {
1837 $hash{$_} = '' foreach qw(setup bill last_bill);
1840 if ( $keep_dates ) {
1841 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1842 resume start_date contract_end ) ) {
1843 $hash{$date} = $self->getfield($date);
1846 # allow $opt->{'locationnum'} = '' to specifically set it to null
1847 # (i.e. customer default location)
1848 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
1850 # usually this doesn't matter. the two cases where it does are:
1851 # 1. unused_credit_change + pkgpart change + setup fee on the new package
1853 # 2. (more importantly) changing a package before it's billed
1854 $hash{'waive_setup'} = $self->waive_setup;
1856 my $custnum = $self->custnum;
1857 if ( $opt->{cust_main} ) {
1858 my $cust_main = $opt->{cust_main};
1859 unless ( $cust_main->custnum ) {
1860 my $error = $cust_main->insert;
1862 $dbh->rollback if $oldAutoCommit;
1863 return "inserting cust_main (transaction rolled back): $error";
1866 $custnum = $cust_main->custnum;
1869 $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
1872 if ( $opt->{'cust_pkg'} ) {
1873 # The target package already exists; update it to show that it was
1874 # changed from this package.
1875 $cust_pkg = $opt->{'cust_pkg'};
1877 foreach ( qw( pkgnum pkgpart locationnum ) ) {
1878 $cust_pkg->set("change_$_", $self->get($_));
1880 $cust_pkg->set('change_date', $time);
1881 $error = $cust_pkg->replace;
1884 # Create the new package.
1885 $cust_pkg = new FS::cust_pkg {
1886 custnum => $custnum,
1887 pkgpart => ( $opt->{'pkgpart'} || $self->pkgpart ),
1888 refnum => ( $opt->{'refnum'} || $self->refnum ),
1889 locationnum => ( $opt->{'locationnum'} ),
1892 $error = $cust_pkg->insert( 'change' => 1,
1893 'allow_pkgpart' => $same_pkgpart );
1896 $dbh->rollback if $oldAutoCommit;
1900 # Transfer services and cancel old package.
1902 $error = $self->transfer($cust_pkg);
1903 if ($error and $error == 0) {
1904 # $old_pkg->transfer failed.
1905 $dbh->rollback if $oldAutoCommit;
1909 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
1910 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
1911 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
1912 if ($error and $error == 0) {
1913 # $old_pkg->transfer failed.
1914 $dbh->rollback if $oldAutoCommit;
1919 # We set unprotect_svcs when executing a "future package change". It's
1920 # not a user-interactive operation, so returning an error means the
1921 # package change will just fail. Rather than have that happen, we'll
1922 # let leftover services be deleted.
1923 if ($error > 0 and !$opt->{'unprotect_svcs'}) {
1924 # Transfers were successful, but we still had services left on the old
1925 # package. We can't change the package under this circumstances, so abort.
1926 $dbh->rollback if $oldAutoCommit;
1927 return "Unable to transfer all services from package ". $self->pkgnum;
1930 #reset usage if changing pkgpart
1931 # AND usage rollover is off (otherwise adds twice, now and at package bill)
1932 if ($self->pkgpart != $cust_pkg->pkgpart) {
1933 my $part_pkg = $cust_pkg->part_pkg;
1934 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
1938 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
1941 $dbh->rollback if $oldAutoCommit;
1942 return "Error setting usage values: $error";
1945 # if NOT changing pkgpart, transfer any usage pools over
1946 foreach my $usage ($self->cust_pkg_usage) {
1947 $usage->set('pkgnum', $cust_pkg->pkgnum);
1948 $error = $usage->replace;
1950 $dbh->rollback if $oldAutoCommit;
1951 return "Error transferring usage pools: $error";
1956 # transfer discounts, if we're not changing pkgpart
1957 if ( $same_pkgpart ) {
1958 foreach my $old_discount ($self->cust_pkg_discount_active) {
1959 # don't remove the old discount, we may still need to bill that package.
1960 my $new_discount = new FS::cust_pkg_discount {
1961 'pkgnum' => $cust_pkg->pkgnum,
1962 'discountnum' => $old_discount->discountnum,
1963 'months_used' => $old_discount->months_used,
1965 $error = $new_discount->insert;
1967 $dbh->rollback if $oldAutoCommit;
1968 return "Error transferring discounts: $error";
1973 # transfer (copy) invoice details
1974 foreach my $detail ($self->cust_pkg_detail) {
1975 my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
1976 $new_detail->set('pkgdetailnum', '');
1977 $new_detail->set('pkgnum', $cust_pkg->pkgnum);
1978 $error = $new_detail->insert;
1980 $dbh->rollback if $oldAutoCommit;
1981 return "Error transferring package notes: $error";
1987 if ( !$opt->{'cust_pkg'} ) {
1988 # Order any supplemental packages.
1989 my $part_pkg = $cust_pkg->part_pkg;
1990 my @old_supp_pkgs = $self->supplemental_pkgs;
1991 foreach my $link ($part_pkg->supp_part_pkg_link) {
1993 foreach (@old_supp_pkgs) {
1994 if ($_->pkgpart == $link->dst_pkgpart) {
1996 $_->pkgpart(0); # so that it can't match more than once
2000 # false laziness with FS::cust_main::Packages::order_pkg
2001 my $new = FS::cust_pkg->new({
2002 pkgpart => $link->dst_pkgpart,
2003 pkglinknum => $link->pkglinknum,
2004 custnum => $custnum,
2005 main_pkgnum => $cust_pkg->pkgnum,
2006 locationnum => $cust_pkg->locationnum,
2007 start_date => $cust_pkg->start_date,
2008 order_date => $cust_pkg->order_date,
2009 expire => $cust_pkg->expire,
2010 adjourn => $cust_pkg->adjourn,
2011 contract_end => $cust_pkg->contract_end,
2012 refnum => $cust_pkg->refnum,
2013 discountnum => $cust_pkg->discountnum,
2014 waive_setup => $cust_pkg->waive_setup,
2016 if ( $old and $opt->{'keep_dates'} ) {
2017 foreach (qw(setup bill last_bill)) {
2018 $new->set($_, $old->get($_));
2021 $error = $new->insert( allow_pkgpart => $same_pkgpart );
2024 $error ||= $old->transfer($new);
2026 if ( $error and $error > 0 ) {
2027 # no reason why this should ever fail, but still...
2028 $error = "Unable to transfer all services from supplemental package ".
2032 $dbh->rollback if $oldAutoCommit;
2035 push @new_supp_pkgs, $new;
2037 } # if !$opt->{'cust_pkg'}
2038 # because if there is one, then supplemental packages would already
2039 # have been created for it.
2041 #Good to go, cancel old package. Notify 'cancel' of whether to credit
2043 #Don't allow billing the package (preceding period packages and/or
2044 #outstanding usage) if we are keeping dates (i.e. location changing),
2045 #because the new package will be billed for the same date range.
2046 #Supplemental packages are also canceled here.
2048 # during scheduled changes, avoid canceling the package we just
2050 $self->set('change_to_pkgnum' => '');
2052 $error = $self->cancel(
2054 unused_credit => $unused_credit,
2055 nobill => $keep_dates,
2056 change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2059 $dbh->rollback if $oldAutoCommit;
2063 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2065 my $error = $cust_pkg->cust_main->bill(
2066 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2069 $dbh->rollback if $oldAutoCommit;
2074 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2080 =item change_later OPTION => VALUE...
2082 Schedule a package change for a later date. This actually orders the new
2083 package immediately, but sets its start date for a future date, and sets
2084 the current package to expire on the same date.
2086 If the package is already scheduled for a change, this can be called with
2087 'start_date' to change the scheduled date, or with pkgpart and/or
2088 locationnum to modify the package change. To cancel the scheduled change
2089 entirely, see C<abort_change>.
2097 The date for the package change. Required, and must be in the future.
2103 The pkgpart and locationnum of the new package, with the same
2104 meaning as in C<change>.
2112 my $opt = ref($_[0]) ? shift : { @_ };
2114 my $oldAutoCommit = $FS::UID::AutoCommit;
2115 local $FS::UID::AutoCommit = 0;
2118 my $cust_main = $self->cust_main;
2120 my $date = delete $opt->{'start_date'} or return 'start_date required';
2122 if ( $date <= time ) {
2123 $dbh->rollback if $oldAutoCommit;
2124 return "start_date $date is in the past";
2129 if ( $self->change_to_pkgnum ) {
2130 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
2131 my $new_pkgpart = $opt->{'pkgpart'}
2132 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $change_to->pkgpart;
2133 my $new_locationnum = $opt->{'locationnum'}
2134 if $opt->{'locationnum'} and $opt->{'locationnum'} != $change_to->locationnum;
2135 if ( $new_pkgpart or $new_locationnum ) {
2136 # it hasn't been billed yet, so in principle we could just edit
2137 # it in place (w/o a package change), but that's bad form.
2138 # So change the package according to the new options...
2139 my $err_or_pkg = $change_to->change(%$opt);
2140 if ( ref $err_or_pkg ) {
2141 # Then set that package up for a future start.
2142 $self->set('change_to_pkgnum', $err_or_pkg->pkgnum);
2143 $self->set('expire', $date); # in case it's different
2144 $err_or_pkg->set('start_date', $date);
2145 $err_or_pkg->set('change_date', '');
2146 $err_or_pkg->set('change_pkgnum', '');
2148 $error = $self->replace ||
2149 $err_or_pkg->replace ||
2150 $change_to->cancel ||
2153 $error = $err_or_pkg;
2155 } else { # change the start date only.
2156 $self->set('expire', $date);
2157 $change_to->set('start_date', $date);
2158 $error = $self->replace || $change_to->replace;
2161 $dbh->rollback if $oldAutoCommit;
2164 $dbh->commit if $oldAutoCommit;
2167 } # if $self->change_to_pkgnum
2169 my $new_pkgpart = $opt->{'pkgpart'}
2170 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2171 my $new_locationnum = $opt->{'locationnum'}
2172 if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2173 return '' unless $new_pkgpart or $new_locationnum; # wouldn't do anything
2176 'custnum' => $self->custnum,
2177 'pkgpart' => ($opt->{'pkgpart'} || $self->pkgpart),
2178 'locationnum' => ($opt->{'locationnum'} || $self->locationnum),
2179 'start_date' => $date,
2181 my $new = FS::cust_pkg->new(\%hash);
2182 $error = $new->insert('change' => 1,
2183 'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2185 $self->set('change_to_pkgnum', $new->pkgnum);
2186 $self->set('expire', $date);
2187 $error = $self->replace;
2190 $dbh->rollback if $oldAutoCommit;
2192 $dbh->commit if $oldAutoCommit;
2200 Cancels a future package change scheduled by C<change_later>.
2206 my $pkgnum = $self->change_to_pkgnum;
2207 my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
2210 $error = $change_to->cancel || $change_to->delete;
2211 return $error if $error;
2213 $self->set('change_to_pkgnum', '');
2214 $self->set('expire', '');
2218 =item set_quantity QUANTITY
2220 Change the package's quantity field. This is the one package property
2221 that can safely be changed without canceling and reordering the package
2222 (because it doesn't affect tax eligibility). Returns an error or an
2229 $self = $self->replace_old; # just to make sure
2231 ($qty =~ /^\d+$/ and $qty > 0) or return "bad package quantity $qty";
2232 $self->set('quantity' => $qty);
2236 use Storable 'thaw';
2238 sub process_bulk_cust_pkg {
2240 my $param = thaw(decode_base64(shift));
2241 warn Dumper($param) if $DEBUG;
2243 my $old_part_pkg = qsearchs('part_pkg',
2244 { pkgpart => $param->{'old_pkgpart'} });
2245 my $new_part_pkg = qsearchs('part_pkg',
2246 { pkgpart => $param->{'new_pkgpart'} });
2247 die "Must select a new package type\n" unless $new_part_pkg;
2248 #my $keep_dates = $param->{'keep_dates'} || 0;
2249 my $keep_dates = 1; # there is no good reason to turn this off
2251 local $SIG{HUP} = 'IGNORE';
2252 local $SIG{INT} = 'IGNORE';
2253 local $SIG{QUIT} = 'IGNORE';
2254 local $SIG{TERM} = 'IGNORE';
2255 local $SIG{TSTP} = 'IGNORE';
2256 local $SIG{PIPE} = 'IGNORE';
2258 my $oldAutoCommit = $FS::UID::AutoCommit;
2259 local $FS::UID::AutoCommit = 0;
2262 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
2265 foreach my $old_cust_pkg ( @cust_pkgs ) {
2267 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
2268 if ( $old_cust_pkg->getfield('cancel') ) {
2269 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
2270 $old_cust_pkg->pkgnum."\n"
2274 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
2276 my $error = $old_cust_pkg->change(
2277 'pkgpart' => $param->{'new_pkgpart'},
2278 'keep_dates' => $keep_dates
2280 if ( !ref($error) ) { # change returns the cust_pkg on success
2282 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
2285 $dbh->commit if $oldAutoCommit;
2291 Returns the last bill date, or if there is no last bill date, the setup date.
2292 Useful for billing metered services.
2298 return $self->setfield('last_bill', $_[0]) if @_;
2299 return $self->getfield('last_bill') if $self->getfield('last_bill');
2300 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
2301 'edate' => $self->bill, } );
2302 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
2305 =item last_cust_pkg_reason ACTION
2307 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
2308 Returns false if there is no reason or the package is not currenly ACTION'd
2309 ACTION is one of adjourn, susp, cancel, or expire.
2313 sub last_cust_pkg_reason {
2314 my ( $self, $action ) = ( shift, shift );
2315 my $date = $self->get($action);
2317 'table' => 'cust_pkg_reason',
2318 'hashref' => { 'pkgnum' => $self->pkgnum,
2319 'action' => substr(uc($action), 0, 1),
2322 'order_by' => 'ORDER BY num DESC LIMIT 1',
2326 =item last_reason ACTION
2328 Returns the most recent ACTION FS::reason associated with the package.
2329 Returns false if there is no reason or the package is not currenly ACTION'd
2330 ACTION is one of adjourn, susp, cancel, or expire.
2335 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
2336 $cust_pkg_reason->reason
2337 if $cust_pkg_reason;
2342 Returns the definition for this billing item, as an FS::part_pkg object (see
2349 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
2350 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
2351 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
2356 Returns the cancelled package this package was changed from, if any.
2362 return '' unless $self->change_pkgnum;
2363 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
2366 =item change_cust_main
2368 Returns the customter this package was detached to, if any.
2372 sub change_cust_main {
2374 return '' unless $self->change_custnum;
2375 qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
2380 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
2387 $self->part_pkg->calc_setup($self, @_);
2392 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
2399 $self->part_pkg->calc_recur($self, @_);
2404 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
2411 $self->part_pkg->base_recur($self, @_);
2416 Calls the I<calc_remain> of the FS::part_pkg object associated with this
2423 $self->part_pkg->calc_remain($self, @_);
2428 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
2435 $self->part_pkg->calc_cancel($self, @_);
2440 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
2446 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
2449 =item cust_pkg_detail [ DETAILTYPE ]
2451 Returns any customer package details for this package (see
2452 L<FS::cust_pkg_detail>).
2454 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2458 sub cust_pkg_detail {
2460 my %hash = ( 'pkgnum' => $self->pkgnum );
2461 $hash{detailtype} = shift if @_;
2463 'table' => 'cust_pkg_detail',
2464 'hashref' => \%hash,
2465 'order_by' => 'ORDER BY weight, pkgdetailnum',
2469 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
2471 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
2473 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2475 If there is an error, returns the error, otherwise returns false.
2479 sub set_cust_pkg_detail {
2480 my( $self, $detailtype, @details ) = @_;
2482 local $SIG{HUP} = 'IGNORE';
2483 local $SIG{INT} = 'IGNORE';
2484 local $SIG{QUIT} = 'IGNORE';
2485 local $SIG{TERM} = 'IGNORE';
2486 local $SIG{TSTP} = 'IGNORE';
2487 local $SIG{PIPE} = 'IGNORE';
2489 my $oldAutoCommit = $FS::UID::AutoCommit;
2490 local $FS::UID::AutoCommit = 0;
2493 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
2494 my $error = $current->delete;
2496 $dbh->rollback if $oldAutoCommit;
2497 return "error removing old detail: $error";
2501 foreach my $detail ( @details ) {
2502 my $cust_pkg_detail = new FS::cust_pkg_detail {
2503 'pkgnum' => $self->pkgnum,
2504 'detailtype' => $detailtype,
2505 'detail' => $detail,
2507 my $error = $cust_pkg_detail->insert;
2509 $dbh->rollback if $oldAutoCommit;
2510 return "error adding new detail: $error";
2515 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2522 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
2526 #false laziness w/cust_bill.pm
2530 'table' => 'cust_event',
2531 'addl_from' => 'JOIN part_event USING ( eventpart )',
2532 'hashref' => { 'tablenum' => $self->pkgnum },
2533 'extra_sql' => " AND eventtable = 'cust_pkg' ",
2537 =item num_cust_event
2539 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
2543 #false laziness w/cust_bill.pm
2544 sub num_cust_event {
2547 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
2548 " WHERE tablenum = ? AND eventtable = 'cust_pkg'";
2549 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
2550 $sth->execute($self->pkgnum) or die $sth->errstr. " executing $sql";
2551 $sth->fetchrow_arrayref->[0];
2554 =item cust_svc [ SVCPART ] (old, deprecated usage)
2556 =item cust_svc [ OPTION => VALUE ... ] (current usage)
2558 Returns the services for this package, as FS::cust_svc objects (see
2559 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
2560 spcififed, returns only the matching services.
2567 return () unless $self->num_cust_svc(@_);
2570 if ( @_ && $_[0] =~ /^\d+/ ) {
2571 $opt{svcpart} = shift;
2572 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2579 'table' => 'cust_svc',
2580 'hashref' => { 'pkgnum' => $self->pkgnum },
2582 if ( $opt{svcpart} ) {
2583 $search{hashref}->{svcpart} = $opt{'svcpart'};
2585 if ( $opt{'svcdb'} ) {
2586 $search{addl_from} = ' LEFT JOIN part_svc USING ( svcpart ) ';
2587 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{'svcdb'} );
2590 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
2592 #if ( $self->{'_svcnum'} ) {
2593 # values %{ $self->{'_svcnum'}->cache };
2595 $self->_sort_cust_svc( [ qsearch(\%search) ] );
2600 =item overlimit [ SVCPART ]
2602 Returns the services for this package which have exceeded their
2603 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
2604 is specified, return only the matching services.
2610 return () unless $self->num_cust_svc(@_);
2611 grep { $_->overlimit } $self->cust_svc(@_);
2614 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2616 Returns historical services for this package created before END TIMESTAMP and
2617 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
2618 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
2619 I<pkg_svc.hidden> flag will be omitted.
2625 warn "$me _h_cust_svc called on $self\n"
2628 my ($end, $start, $mode) = @_;
2629 my @cust_svc = $self->_sort_cust_svc(
2630 [ qsearch( 'h_cust_svc',
2631 { 'pkgnum' => $self->pkgnum, },
2632 FS::h_cust_svc->sql_h_search(@_),
2635 if ( defined($mode) && $mode eq 'I' ) {
2636 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
2637 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
2643 sub _sort_cust_svc {
2644 my( $self, $arrayref ) = @_;
2647 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
2649 my %pkg_svc = map { $_->svcpart => $_ }
2650 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
2655 my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
2657 $pkg_svc ? $pkg_svc->primary_svc : '',
2658 $pkg_svc ? $pkg_svc->quantity : 0,
2665 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
2667 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
2669 Returns the number of services for this package. Available options are svcpart
2670 and svcdb. If either is spcififed, returns only the matching services.
2677 return $self->{'_num_cust_svc'}
2679 && exists($self->{'_num_cust_svc'})
2680 && $self->{'_num_cust_svc'} =~ /\d/;
2682 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
2686 if ( @_ && $_[0] =~ /^\d+/ ) {
2687 $opt{svcpart} = shift;
2688 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2694 my $select = 'SELECT COUNT(*) FROM cust_svc ';
2695 my $where = ' WHERE pkgnum = ? ';
2696 my @param = ($self->pkgnum);
2698 if ( $opt{'svcpart'} ) {
2699 $where .= ' AND svcpart = ? ';
2700 push @param, $opt{'svcpart'};
2702 if ( $opt{'svcdb'} ) {
2703 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
2704 $where .= ' AND svcdb = ? ';
2705 push @param, $opt{'svcdb'};
2708 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
2709 $sth->execute(@param) or die $sth->errstr;
2710 $sth->fetchrow_arrayref->[0];
2713 =item available_part_svc
2715 Returns a list of FS::part_svc objects representing services included in this
2716 package but not yet provisioned. Each FS::part_svc object also has an extra
2717 field, I<num_avail>, which specifies the number of available services.
2721 sub available_part_svc {
2724 my $pkg_quantity = $self->quantity || 1;
2726 grep { $_->num_avail > 0 }
2728 my $part_svc = $_->part_svc;
2729 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
2730 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
2732 # more evil encapsulation breakage
2733 if($part_svc->{'Hash'}{'num_avail'} > 0) {
2734 my @exports = $part_svc->part_export_did;
2735 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
2740 $self->part_pkg->pkg_svc;
2743 =item part_svc [ OPTION => VALUE ... ]
2745 Returns a list of FS::part_svc objects representing provisioned and available
2746 services included in this package. Each FS::part_svc object also has the
2747 following extra fields:
2751 =item num_cust_svc (count)
2753 =item num_avail (quantity - count)
2755 =item cust_pkg_svc (services) - array reference containing the provisioned services, as cust_svc objects
2759 Accepts one option: summarize_size. If specified and non-zero, will omit the
2760 extra cust_pkg_svc option for objects where num_cust_svc is this size or
2766 #label -> ($cust_svc->label)[1]
2772 my $pkg_quantity = $self->quantity || 1;
2774 #XXX some sort of sort order besides numeric by svcpart...
2775 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
2777 my $part_svc = $pkg_svc->part_svc;
2778 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
2779 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
2780 $part_svc->{'Hash'}{'num_avail'} =
2781 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
2782 $part_svc->{'Hash'}{'cust_pkg_svc'} =
2783 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
2784 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
2785 && $num_cust_svc >= $opt{summarize_size};
2786 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
2788 } $self->part_pkg->pkg_svc;
2791 push @part_svc, map {
2793 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
2794 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
2795 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
2796 $part_svc->{'Hash'}{'cust_pkg_svc'} =
2797 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
2799 } $self->extra_part_svc;
2805 =item extra_part_svc
2807 Returns a list of FS::part_svc objects corresponding to services in this
2808 package which are still provisioned but not (any longer) available in the
2813 sub extra_part_svc {
2816 my $pkgnum = $self->pkgnum;
2817 #my $pkgpart = $self->pkgpart;
2820 # 'table' => 'part_svc',
2823 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
2824 # WHERE pkg_svc.svcpart = part_svc.svcpart
2825 # AND pkg_svc.pkgpart = ?
2828 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
2829 # LEFT JOIN cust_pkg USING ( pkgnum )
2830 # WHERE cust_svc.svcpart = part_svc.svcpart
2833 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
2836 #seems to benchmark slightly faster... (or did?)
2838 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
2839 my $pkgparts = join(',', @pkgparts);
2842 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
2843 #MySQL doesn't grok DISINCT ON
2844 'select' => 'DISTINCT part_svc.*',
2845 'table' => 'part_svc',
2847 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
2848 AND pkg_svc.pkgpart IN ($pkgparts)
2851 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
2852 LEFT JOIN cust_pkg USING ( pkgnum )
2855 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
2856 'extra_param' => [ [$self->pkgnum=>'int'] ],
2862 Returns a short status string for this package, currently:
2866 =item not yet billed
2868 =item one-time charge
2883 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
2885 return 'cancelled' if $self->get('cancel');
2886 return 'suspended' if $self->susp;
2887 return 'not yet billed' unless $self->setup;
2888 return 'one-time charge' if $freq =~ /^(0|$)/;
2892 =item ucfirst_status
2894 Returns the status with the first character capitalized.
2898 sub ucfirst_status {
2899 ucfirst(shift->status);
2904 Class method that returns the list of possible status strings for packages
2905 (see L<the status method|/status>). For example:
2907 @statuses = FS::cust_pkg->statuses();
2911 tie my %statuscolor, 'Tie::IxHash',
2912 'not yet billed' => '009999', #teal? cyan?
2913 'one-time charge' => '000000',
2914 'active' => '00CC00',
2915 'suspended' => 'FF9900',
2916 'cancelled' => 'FF0000',
2920 my $self = shift; #could be class...
2921 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
2922 # # mayble split btw one-time vs. recur
2928 Returns a hex triplet color string for this package's status.
2934 $statuscolor{$self->status};
2939 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
2940 "pkg - comment" depending on user preference).
2946 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
2947 $label = $self->pkgnum. ": $label"
2948 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
2952 =item pkg_label_long
2954 Returns a long label for this package, adding the primary service's label to
2959 sub pkg_label_long {
2961 my $label = $self->pkg_label;
2962 my $cust_svc = $self->primary_cust_svc;
2963 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
2969 Returns a customer-localized label for this package.
2975 $self->part_pkg->pkg_locale( $self->cust_main->locale );
2978 =item primary_cust_svc
2980 Returns a primary service (as FS::cust_svc object) if one can be identified.
2984 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
2986 sub primary_cust_svc {
2989 my @cust_svc = $self->cust_svc;
2991 return '' unless @cust_svc; #no serivces - irrelevant then
2993 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
2995 # primary service as specified in the package definition
2996 # or exactly one service definition with quantity one
2997 my $svcpart = $self->part_pkg->svcpart;
2998 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
2999 return $cust_svc[0] if scalar(@cust_svc) == 1;
3001 #couldn't identify one thing..
3007 Returns a list of lists, calling the label method for all services
3008 (see L<FS::cust_svc>) of this billing item.
3014 map { [ $_->label ] } $self->cust_svc;
3017 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3019 Like the labels method, but returns historical information on services that
3020 were active as of END_TIMESTAMP and (optionally) not cancelled before
3021 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
3022 I<pkg_svc.hidden> flag will be omitted.
3024 Returns a list of lists, calling the label method for all (historical) services
3025 (see L<FS::h_cust_svc>) of this billing item.
3031 warn "$me _h_labels called on $self\n"
3033 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
3038 Like labels, except returns a simple flat list, and shortens long
3039 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3040 identical services to one line that lists the service label and the number of
3041 individual services rather than individual items.
3046 shift->_labels_short( 'labels', @_ );
3049 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
3051 Like h_labels, except returns a simple flat list, and shortens long
3052 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3053 identical services to one line that lists the service label and the number of
3054 individual services rather than individual items.
3058 sub h_labels_short {
3059 shift->_labels_short( 'h_labels', @_ );
3063 my( $self, $method ) = ( shift, shift );
3065 warn "$me _labels_short called on $self with $method method\n"
3068 my $conf = new FS::Conf;
3069 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
3071 warn "$me _labels_short populating \%labels\n"
3075 #tie %labels, 'Tie::IxHash';
3076 push @{ $labels{$_->[0]} }, $_->[1]
3077 foreach $self->$method(@_);
3079 warn "$me _labels_short populating \@labels\n"
3083 foreach my $label ( keys %labels ) {
3085 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
3086 my $num = scalar(@values);
3087 warn "$me _labels_short $num items for $label\n"
3090 if ( $num > $max_same_services ) {
3091 warn "$me _labels_short more than $max_same_services, so summarizing\n"
3093 push @labels, "$label ($num)";
3095 if ( $conf->exists('cust_bill-consolidate_services') ) {
3096 warn "$me _labels_short consolidating services\n"
3098 # push @labels, "$label: ". join(', ', @values);
3100 my $detail = "$label: ";
3101 $detail .= shift(@values). ', '
3103 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
3105 push @labels, $detail;
3107 warn "$me _labels_short done consolidating services\n"
3110 warn "$me _labels_short adding service data\n"
3112 push @labels, map { "$label: $_" } @values;
3123 Returns the parent customer object (see L<FS::cust_main>).
3129 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
3134 Returns the balance for this specific package, when using
3135 experimental package balance.
3141 $self->cust_main->balance_pkgnum( $self->pkgnum );
3144 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
3148 Returns the location object, if any (see L<FS::cust_location>).
3150 =item cust_location_or_main
3152 If this package is associated with a location, returns the locaiton (see
3153 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
3155 =item location_label [ OPTION => VALUE ... ]
3157 Returns the label of the location object (see L<FS::cust_location>).
3161 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
3163 =item tax_locationnum
3165 Returns the foreign key to a L<FS::cust_location> object for calculating
3166 tax on this package, as determined by the C<tax-pkg_address> and
3167 C<tax-ship_address> configuration flags.
3171 sub tax_locationnum {
3173 my $conf = FS::Conf->new;
3174 if ( $conf->exists('tax-pkg_address') ) {
3175 return $self->locationnum;
3177 elsif ( $conf->exists('tax-ship_address') ) {
3178 return $self->cust_main->ship_locationnum;
3181 return $self->cust_main->bill_locationnum;
3187 Returns the L<FS::cust_location> object for tax_locationnum.
3193 FS::cust_location->by_key( $self->tax_locationnum )
3196 =item seconds_since TIMESTAMP
3198 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
3199 package have been online since TIMESTAMP, according to the session monitor.
3201 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
3202 L<Time::Local> and L<Date::Parse> for conversion functions.
3207 my($self, $since) = @_;
3210 foreach my $cust_svc (
3211 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
3213 $seconds += $cust_svc->seconds_since($since);
3220 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
3222 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
3223 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
3226 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3227 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3233 sub seconds_since_sqlradacct {
3234 my($self, $start, $end) = @_;
3238 foreach my $cust_svc (
3240 my $part_svc = $_->part_svc;
3241 $part_svc->svcdb eq 'svc_acct'
3242 && scalar($part_svc->part_export_usage);
3245 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
3252 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
3254 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
3255 in this package for sessions ending between TIMESTAMP_START (inclusive) and
3259 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3260 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3265 sub attribute_since_sqlradacct {
3266 my($self, $start, $end, $attrib) = @_;
3270 foreach my $cust_svc (
3272 my $part_svc = $_->part_svc;
3273 $part_svc->svcdb eq 'svc_acct'
3274 && scalar($part_svc->part_export_usage);
3277 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
3289 my( $self, $value ) = @_;
3290 if ( defined($value) ) {
3291 $self->setfield('quantity', $value);
3293 $self->getfield('quantity') || 1;
3296 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
3298 Transfers as many services as possible from this package to another package.
3300 The destination package can be specified by pkgnum by passing an FS::cust_pkg
3301 object. The destination package must already exist.
3303 Services are moved only if the destination allows services with the correct
3304 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
3305 this option with caution! No provision is made for export differences
3306 between the old and new service definitions. Probably only should be used
3307 when your exports for all service definitions of a given svcdb are identical.
3308 (attempt a transfer without it first, to move all possible svcpart-matching
3311 Any services that can't be moved remain in the original package.
3313 Returns an error, if there is one; otherwise, returns the number of services
3314 that couldn't be moved.
3319 my ($self, $dest_pkgnum, %opt) = @_;
3325 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
3326 $dest = $dest_pkgnum;
3327 $dest_pkgnum = $dest->pkgnum;
3329 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
3332 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
3334 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
3335 $target{$pkg_svc->svcpart} = $pkg_svc->quantity;
3338 foreach my $cust_svc ($dest->cust_svc) {
3339 $target{$cust_svc->svcpart}--;
3342 my %svcpart2svcparts = ();
3343 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3344 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
3345 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
3346 next if exists $svcpart2svcparts{$svcpart};
3347 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
3348 $svcpart2svcparts{$svcpart} = [
3350 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
3352 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
3353 'svcpart' => $_ } );
3355 $pkg_svc ? $pkg_svc->primary_svc : '',
3356 $pkg_svc ? $pkg_svc->quantity : 0,
3360 grep { $_ != $svcpart }
3362 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
3364 warn "alternates for svcpart $svcpart: ".
3365 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
3370 foreach my $cust_svc ($self->cust_svc) {
3371 if($target{$cust_svc->svcpart} > 0
3372 or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
3373 $target{$cust_svc->svcpart}--;
3374 my $new = new FS::cust_svc { $cust_svc->hash };
3375 $new->pkgnum($dest_pkgnum);
3376 my $error = $new->replace($cust_svc);
3377 return $error if $error;
3378 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3380 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
3381 warn "alternates to consider: ".
3382 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
3384 my @alternate = grep {
3385 warn "considering alternate svcpart $_: ".
3386 "$target{$_} available in new package\n"
3389 } @{$svcpart2svcparts{$cust_svc->svcpart}};
3391 warn "alternate(s) found\n" if $DEBUG;
3392 my $change_svcpart = $alternate[0];
3393 $target{$change_svcpart}--;
3394 my $new = new FS::cust_svc { $cust_svc->hash };
3395 $new->svcpart($change_svcpart);
3396 $new->pkgnum($dest_pkgnum);
3397 my $error = $new->replace($cust_svc);
3398 return $error if $error;
3409 =item grab_svcnums SVCNUM, SVCNUM ...
3411 Change the pkgnum for the provided services to this packages. If there is an
3412 error, returns the error, otherwise returns false.
3420 local $SIG{HUP} = 'IGNORE';
3421 local $SIG{INT} = 'IGNORE';
3422 local $SIG{QUIT} = 'IGNORE';
3423 local $SIG{TERM} = 'IGNORE';
3424 local $SIG{TSTP} = 'IGNORE';
3425 local $SIG{PIPE} = 'IGNORE';
3427 my $oldAutoCommit = $FS::UID::AutoCommit;
3428 local $FS::UID::AutoCommit = 0;
3431 foreach my $svcnum (@svcnum) {
3432 my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
3433 $dbh->rollback if $oldAutoCommit;
3434 return "unknown svcnum $svcnum";
3436 $cust_svc->pkgnum( $self->pkgnum );
3437 my $error = $cust_svc->replace;
3439 $dbh->rollback if $oldAutoCommit;
3444 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3451 This method is deprecated. See the I<depend_jobnum> option to the insert and
3452 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
3459 local $SIG{HUP} = 'IGNORE';
3460 local $SIG{INT} = 'IGNORE';
3461 local $SIG{QUIT} = 'IGNORE';
3462 local $SIG{TERM} = 'IGNORE';
3463 local $SIG{TSTP} = 'IGNORE';
3464 local $SIG{PIPE} = 'IGNORE';
3466 my $oldAutoCommit = $FS::UID::AutoCommit;
3467 local $FS::UID::AutoCommit = 0;
3470 foreach my $cust_svc ( $self->cust_svc ) {
3471 #false laziness w/svc_Common::insert
3472 my $svc_x = $cust_svc->svc_x;
3473 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
3474 my $error = $part_export->export_insert($svc_x);
3476 $dbh->rollback if $oldAutoCommit;
3482 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3487 =item export_pkg_change OLD_CUST_PKG
3489 Calls the "pkg_change" export action for all services attached to this package.
3493 sub export_pkg_change {
3494 my( $self, $old ) = ( shift, shift );
3496 local $SIG{HUP} = 'IGNORE';
3497 local $SIG{INT} = 'IGNORE';
3498 local $SIG{QUIT} = 'IGNORE';
3499 local $SIG{TERM} = 'IGNORE';
3500 local $SIG{TSTP} = 'IGNORE';
3501 local $SIG{PIPE} = 'IGNORE';
3503 my $oldAutoCommit = $FS::UID::AutoCommit;
3504 local $FS::UID::AutoCommit = 0;
3507 foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
3508 my $error = $svc_x->export('pkg_change', $self, $old);
3510 $dbh->rollback if $oldAutoCommit;
3515 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3522 Associates this package with a (suspension or cancellation) reason (see
3523 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
3526 Available options are:
3532 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.
3536 the access_user (see L<FS::access_user>) providing the reason
3544 the action (cancel, susp, adjourn, expire) associated with the reason
3548 If there is an error, returns the error, otherwise returns false.
3553 my ($self, %options) = @_;
3555 my $otaker = $options{reason_otaker} ||
3556 $FS::CurrentUser::CurrentUser->username;
3559 if ( $options{'reason'} =~ /^(\d+)$/ ) {
3563 } elsif ( ref($options{'reason'}) ) {
3565 return 'Enter a new reason (or select an existing one)'
3566 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
3568 my $reason = new FS::reason({
3569 'reason_type' => $options{'reason'}->{'typenum'},
3570 'reason' => $options{'reason'}->{'reason'},
3572 my $error = $reason->insert;
3573 return $error if $error;
3575 $reasonnum = $reason->reasonnum;
3578 return "Unparsable reason: ". $options{'reason'};
3581 my $cust_pkg_reason =
3582 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
3583 'reasonnum' => $reasonnum,
3584 'otaker' => $otaker,
3585 'action' => substr(uc($options{'action'}),0,1),
3586 'date' => $options{'date'}
3591 $cust_pkg_reason->insert;
3594 =item insert_discount
3596 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
3597 inserting a new discount on the fly (see L<FS::discount>).
3599 Available options are:
3607 If there is an error, returns the error, otherwise returns false.
3611 sub insert_discount {
3612 #my ($self, %options) = @_;
3615 my $cust_pkg_discount = new FS::cust_pkg_discount {
3616 'pkgnum' => $self->pkgnum,
3617 'discountnum' => $self->discountnum,
3619 'end_date' => '', #XXX
3620 #for the create a new discount case
3621 '_type' => $self->discountnum__type,
3622 'amount' => $self->discountnum_amount,
3623 'percent' => $self->discountnum_percent,
3624 'months' => $self->discountnum_months,
3625 'setup' => $self->discountnum_setup,
3626 #'disabled' => $self->discountnum_disabled,
3629 $cust_pkg_discount->insert;
3632 =item set_usage USAGE_VALUE_HASHREF
3634 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
3635 to which they should be set (see L<FS::svc_acct>). Currently seconds,
3636 upbytes, downbytes, and totalbytes are appropriate keys.
3638 All svc_accts which are part of this package have their values reset.
3643 my ($self, $valueref, %opt) = @_;
3645 #only svc_acct can set_usage for now
3646 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
3647 my $svc_x = $cust_svc->svc_x;
3648 $svc_x->set_usage($valueref, %opt)
3649 if $svc_x->can("set_usage");
3653 =item recharge USAGE_VALUE_HASHREF
3655 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
3656 to which they should be set (see L<FS::svc_acct>). Currently seconds,
3657 upbytes, downbytes, and totalbytes are appropriate keys.
3659 All svc_accts which are part of this package have their values incremented.
3664 my ($self, $valueref) = @_;
3666 #only svc_acct can set_usage for now
3667 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
3668 my $svc_x = $cust_svc->svc_x;
3669 $svc_x->recharge($valueref)
3670 if $svc_x->can("recharge");
3674 =item cust_pkg_discount
3678 sub cust_pkg_discount {
3680 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
3683 =item cust_pkg_discount_active
3687 sub cust_pkg_discount_active {
3689 grep { $_->status eq 'active' } $self->cust_pkg_discount;
3692 =item cust_pkg_usage
3694 Returns a list of all voice usage counters attached to this package.
3698 sub cust_pkg_usage {
3700 qsearch('cust_pkg_usage', { pkgnum => $self->pkgnum });
3703 =item apply_usage OPTIONS
3705 Takes the following options:
3706 - cdr: a call detail record (L<FS::cdr>)
3707 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
3708 - minutes: the maximum number of minutes to be charged
3710 Finds available usage minutes for a call of this class, and subtracts
3711 up to that many minutes from the usage pool. If the usage pool is empty,
3712 and the C<cdr-minutes_priority> global config option is set, minutes may
3713 be taken from other calls as well. Either way, an allocation record will
3714 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
3715 number of minutes of usage applied to the call.
3720 my ($self, %opt) = @_;
3721 my $cdr = $opt{cdr};
3722 my $rate_detail = $opt{rate_detail};
3723 my $minutes = $opt{minutes};
3724 my $classnum = $rate_detail->classnum;
3725 my $pkgnum = $self->pkgnum;
3726 my $custnum = $self->custnum;
3728 local $SIG{HUP} = 'IGNORE';
3729 local $SIG{INT} = 'IGNORE';
3730 local $SIG{QUIT} = 'IGNORE';
3731 local $SIG{TERM} = 'IGNORE';
3732 local $SIG{TSTP} = 'IGNORE';
3733 local $SIG{PIPE} = 'IGNORE';
3735 my $oldAutoCommit = $FS::UID::AutoCommit;
3736 local $FS::UID::AutoCommit = 0;
3738 my $order = FS::Conf->new->config('cdr-minutes_priority');
3742 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
3744 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
3746 my @usage_recs = qsearch({
3747 'table' => 'cust_pkg_usage',
3748 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
3749 ' JOIN cust_pkg USING (pkgnum)'.
3750 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
3751 'select' => 'cust_pkg_usage.*',
3752 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
3753 " ( cust_pkg.custnum = $custnum AND ".
3754 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
3755 $is_classnum . ' AND '.
3756 " cust_pkg_usage.minutes > 0",
3757 'order_by' => " ORDER BY priority ASC",
3760 my $orig_minutes = $minutes;
3762 while (!$error and $minutes > 0 and @usage_recs) {
3763 my $cust_pkg_usage = shift @usage_recs;
3764 $cust_pkg_usage->select_for_update;
3765 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
3766 pkgusagenum => $cust_pkg_usage->pkgusagenum,
3767 acctid => $cdr->acctid,
3768 minutes => min($cust_pkg_usage->minutes, $minutes),
3770 $cust_pkg_usage->set('minutes',
3771 sprintf('%.0f', $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes)
3773 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
3774 $minutes -= $cdr_cust_pkg_usage->minutes;
3776 if ( $order and $minutes > 0 and !$error ) {
3777 # then try to steal minutes from another call
3779 'table' => 'cdr_cust_pkg_usage',
3780 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
3781 ' JOIN part_pkg_usage USING (pkgusagepart)'.
3782 ' JOIN cust_pkg USING (pkgnum)'.
3783 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
3784 ' JOIN cdr USING (acctid)',
3785 'select' => 'cdr_cust_pkg_usage.*',
3786 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
3787 " ( cust_pkg.pkgnum = $pkgnum OR ".
3788 " ( cust_pkg.custnum = $custnum AND ".
3789 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
3790 " part_pkg_usage_class.classnum = $classnum",
3791 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
3793 if ( $order eq 'time' ) {
3794 # find CDRs that are using minutes, but have a later startdate
3796 my $startdate = $cdr->startdate;
3797 if ($startdate !~ /^\d+$/) {
3798 die "bad cdr startdate '$startdate'";
3800 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
3801 # minimize needless reshuffling
3802 $search{'order_by'} .= ', cdr.startdate DESC';
3804 # XXX may not work correctly with rate_time schedules. Could
3805 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
3807 $search{'addl_from'} .=
3808 ' JOIN rate_detail'.
3809 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
3810 if ( $order eq 'rate_high' ) {
3811 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
3812 $rate_detail->min_charge;
3813 $search{'order_by'} .= ', rate_detail.min_charge ASC';
3814 } elsif ( $order eq 'rate_low' ) {
3815 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
3816 $rate_detail->min_charge;
3817 $search{'order_by'} .= ', rate_detail.min_charge DESC';
3819 # this should really never happen
3820 die "invalid cdr-minutes_priority value '$order'\n";
3823 my @cdr_usage_recs = qsearch(\%search);
3825 while (!$error and @cdr_usage_recs and $minutes > 0) {
3826 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
3827 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
3828 my $old_cdr = $cdr_cust_pkg_usage->cdr;
3829 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
3830 $cdr_cust_pkg_usage->select_for_update;
3831 $old_cdr->select_for_update;
3832 $cust_pkg_usage->select_for_update;
3833 # in case someone else stole the usage from this CDR
3834 # while waiting for the lock...
3835 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
3836 # steal the usage allocation and flag the old CDR for reprocessing
3837 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
3838 # if the allocation is more minutes than we need, adjust it...
3839 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
3841 $cdr_cust_pkg_usage->set('minutes', $minutes);
3842 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
3843 $error = $cust_pkg_usage->replace;
3845 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
3846 $error ||= $cdr_cust_pkg_usage->replace;
3847 # deduct the stolen minutes
3848 $minutes -= $cdr_cust_pkg_usage->minutes;
3850 # after all minute-stealing is done, reset the affected CDRs
3851 foreach (values %reproc_cdrs) {
3852 $error ||= $_->set_status('');
3853 # XXX or should we just call $cdr->rate right here?
3854 # it's not like we can create a loop this way, since the min_charge
3855 # or call time has to go monotonically in one direction.
3856 # we COULD get some very deep recursions going, though...
3858 } # if $order and $minutes
3861 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
3863 $dbh->commit if $oldAutoCommit;
3864 return $orig_minutes - $minutes;
3868 =item supplemental_pkgs
3870 Returns a list of all packages supplemental to this one.
3874 sub supplemental_pkgs {
3876 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
3881 Returns the package that this one is supplemental to, if any.
3887 if ( $self->main_pkgnum ) {
3888 return FS::cust_pkg->by_key($self->main_pkgnum);
3895 =head1 CLASS METHODS
3901 Returns an SQL expression identifying recurring packages.
3905 sub recurring_sql { "
3906 '0' != ( select freq from part_pkg
3907 where cust_pkg.pkgpart = part_pkg.pkgpart )
3912 Returns an SQL expression identifying one-time packages.
3917 '0' = ( select freq from part_pkg
3918 where cust_pkg.pkgpart = part_pkg.pkgpart )
3923 Returns an SQL expression identifying ordered packages (recurring packages not
3929 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
3934 Returns an SQL expression identifying active packages.
3939 $_[0]->recurring_sql. "
3940 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
3941 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3942 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
3945 =item not_yet_billed_sql
3947 Returns an SQL expression identifying packages which have not yet been billed.
3951 sub not_yet_billed_sql { "
3952 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
3953 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3954 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
3959 Returns an SQL expression identifying inactive packages (one-time packages
3960 that are otherwise unsuspended/uncancelled).
3964 sub inactive_sql { "
3965 ". $_[0]->onetime_sql(). "
3966 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
3967 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3968 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
3974 Returns an SQL expression identifying suspended packages.
3978 sub suspended_sql { susp_sql(@_); }
3980 #$_[0]->recurring_sql(). ' AND '.
3982 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3983 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
3990 Returns an SQL exprression identifying cancelled packages.
3994 sub cancelled_sql { cancel_sql(@_); }
3996 #$_[0]->recurring_sql(). ' AND '.
3997 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
4002 Returns an SQL expression to give the package status as a string.
4008 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
4009 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
4010 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
4011 WHEN ".onetime_sql()." THEN 'one-time charge'
4016 =item search HASHREF
4020 Returns a qsearch hash expression to search for parameters specified in HASHREF.
4021 Valid parameters are
4029 active, inactive, suspended, cancel (or cancelled)
4033 active, inactive, suspended, one-time charge, inactive, cancel (or cancelled)
4037 boolean selects custom packages
4043 pkgpart or arrayref or hashref of pkgparts
4047 arrayref of beginning and ending epoch date
4051 arrayref of beginning and ending epoch date
4055 arrayref of beginning and ending epoch date
4059 arrayref of beginning and ending epoch date
4063 arrayref of beginning and ending epoch date
4067 arrayref of beginning and ending epoch date
4071 arrayref of beginning and ending epoch date
4075 pkgnum or APKG_pkgnum
4079 a value suited to passing to FS::UI::Web::cust_header
4083 specifies the user for agent virtualization
4087 boolean; if true, returns only packages with more than 0 FCC phone lines.
4089 =item state, country
4091 Limit to packages with a service location in the specified state and country.
4092 For FCC 477 reporting, mostly.
4099 my ($class, $params) = @_;
4106 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
4108 "cust_main.agentnum = $1";
4115 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
4117 "cust_pkg.custnum = $1";
4124 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
4126 "cust_pkg.pkgbatch = '$1'";
4133 if ( $params->{'magic'} eq 'active'
4134 || $params->{'status'} eq 'active' ) {
4136 push @where, FS::cust_pkg->active_sql();
4138 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
4139 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
4141 push @where, FS::cust_pkg->not_yet_billed_sql();
4143 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
4144 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
4146 push @where, FS::cust_pkg->inactive_sql();
4148 } elsif ( $params->{'magic'} eq 'suspended'
4149 || $params->{'status'} eq 'suspended' ) {
4151 push @where, FS::cust_pkg->suspended_sql();
4153 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
4154 || $params->{'status'} =~ /^cancell?ed$/ ) {
4156 push @where, FS::cust_pkg->cancelled_sql();
4161 # parse package class
4164 if ( exists($params->{'classnum'}) ) {
4167 if ( ref($params->{'classnum'}) ) {
4169 if ( ref($params->{'classnum'}) eq 'HASH' ) {
4170 @classnum = grep $params->{'classnum'}{$_}, keys %{ $params->{'classnum'} };
4171 } elsif ( ref($params->{'classnum'}) eq 'ARRAY' ) {
4172 @classnum = @{ $params->{'classnum'} };
4174 die 'unhandled classnum ref '. $params->{'classnum'};
4178 } elsif ( $params->{'classnum'} =~ /^(\d*)$/ && $1 ne '0' ) {
4185 my @nums = grep $_, @classnum;
4186 push @c_where, 'part_pkg.classnum IN ('. join(',',@nums). ')' if @nums;
4187 my $null = scalar( grep { $_ eq '' } @classnum );
4188 push @c_where, 'part_pkg.classnum IS NULL' if $null;
4190 if ( scalar(@c_where) == 1 ) {
4191 push @where, @c_where;
4192 } elsif ( @c_where ) {
4193 push @where, ' ( '. join(' OR ', @c_where). ' ) ';
4202 # parse package report options
4205 my @report_option = ();
4206 if ( exists($params->{'report_option'}) ) {
4207 if ( ref($params->{'report_option'}) eq 'ARRAY' ) {
4208 @report_option = @{ $params->{'report_option'} };
4209 } elsif ( $params->{'report_option'} =~ /^([,\d]*)$/ ) {
4210 @report_option = split(',', $1);
4215 if (@report_option) {
4216 # this will result in the empty set for the dangling comma case as it should
4218 map{ "0 < ( SELECT count(*) FROM part_pkg_option
4219 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
4220 AND optionname = 'report_option_$_'
4221 AND optionvalue = '1' )"
4225 foreach my $any ( grep /^report_option_any/, keys %$params ) {
4227 my @report_option_any = ();
4228 if ( ref($params->{$any}) eq 'ARRAY' ) {
4229 @report_option_any = @{ $params->{$any} };
4230 } elsif ( $params->{$any} =~ /^([,\d]*)$/ ) {
4231 @report_option_any = split(',', $1);
4234 if (@report_option_any) {
4235 # this will result in the empty set for the dangling comma case as it should
4236 push @where, ' ( '. join(' OR ',
4237 map{ "0 < ( SELECT count(*) FROM part_pkg_option
4238 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
4239 AND optionname = 'report_option_$_'
4240 AND optionvalue = '1' )"
4241 } @report_option_any
4251 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
4257 push @where, "(part_pkg.fcc_ds0s > 0 OR pkg_class.fcc_ds0s > 0)"
4258 if $params->{fcc_line};
4264 if ( exists($params->{'censustract'}) ) {
4265 $params->{'censustract'} =~ /^([.\d]*)$/;
4266 my $censustract = "cust_location.censustract = '$1'";
4267 $censustract .= ' OR cust_location.censustract is NULL' unless $1;
4268 push @where, "( $censustract )";
4272 # parse censustract2
4274 if ( exists($params->{'censustract2'})
4275 && $params->{'censustract2'} =~ /^(\d*)$/
4279 push @where, "cust_location.censustract LIKE '$1%'";
4282 "( cust_location.censustract = '' OR cust_location.censustract IS NULL )";
4287 # parse country/state
4289 for (qw(state country)) { # parsing rules are the same for these
4290 if ( exists($params->{$_})
4291 && uc($params->{$_}) =~ /^([A-Z]{2})$/ )
4293 # XXX post-2.3 only--before that, state/country may be in cust_main
4294 push @where, "cust_location.$_ = '$1'";
4302 if ( ref($params->{'pkgpart'}) ) {
4305 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
4306 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
4307 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
4308 @pkgpart = @{ $params->{'pkgpart'} };
4310 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
4313 @pkgpart = grep /^(\d+)$/, @pkgpart;
4315 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
4317 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
4318 push @where, "pkgpart = $1";
4327 #false laziness w/report_cust_pkg.html
4330 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
4331 'active' => { 'susp'=>1, 'cancel'=>1 },
4332 'suspended' => { 'cancel' => 1 },
4337 if( exists($params->{'active'} ) ) {
4338 # This overrides all the other date-related fields
4339 my($beginning, $ending) = @{$params->{'active'}};
4341 "cust_pkg.setup IS NOT NULL",
4342 "cust_pkg.setup <= $ending",
4343 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
4344 "NOT (".FS::cust_pkg->onetime_sql . ")";
4347 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end change_date cancel )) {
4349 next unless exists($params->{$field});
4351 my($beginning, $ending) = @{$params->{$field}};
4353 next if $beginning == 0 && $ending == 4294967295;
4356 "cust_pkg.$field IS NOT NULL",
4357 "cust_pkg.$field >= $beginning",
4358 "cust_pkg.$field <= $ending";
4360 $orderby ||= "ORDER BY cust_pkg.$field";
4365 $orderby ||= 'ORDER BY bill';
4368 # parse magic, legacy, etc.
4371 if ( $params->{'magic'} &&
4372 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
4375 $orderby = 'ORDER BY pkgnum';
4377 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
4378 push @where, "pkgpart = $1";
4381 } elsif ( $params->{'query'} eq 'pkgnum' ) {
4383 $orderby = 'ORDER BY pkgnum';
4385 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
4387 $orderby = 'ORDER BY pkgnum';
4390 SELECT count(*) FROM pkg_svc
4391 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
4392 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
4393 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
4394 AND cust_svc.svcpart = pkg_svc.svcpart
4401 # setup queries, links, subs, etc. for the search
4404 # here is the agent virtualization
4405 if ($params->{CurrentUser}) {
4407 qsearchs('access_user', { username => $params->{CurrentUser} });
4410 push @where, $access_user->agentnums_sql('table'=>'cust_main');
4415 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
4418 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
4420 my $addl_from = 'LEFT JOIN part_pkg USING ( pkgpart ) '.
4421 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) '.
4422 'LEFT JOIN cust_location USING ( locationnum ) '.
4423 FS::UI::Web::join_cust_main('cust_pkg', 'cust_pkg');
4427 if ( $params->{'select_zip5'} ) {
4428 my $zip = 'cust_location.zip';
4430 $select = "DISTINCT substr($zip,1,5) as zip";
4431 $orderby = "ORDER BY substr($zip,1,5)";
4432 $count_query = "SELECT COUNT( DISTINCT substr($zip,1,5) )";
4434 $select = join(', ',
4436 ( map "part_pkg.$_", qw( pkg freq ) ),
4437 'pkg_class.classname',
4438 'cust_main.custnum AS cust_main_custnum',
4439 FS::UI::Web::cust_sql_fields(
4440 $params->{'cust_fields'}
4443 $count_query = 'SELECT COUNT(*)';
4446 $count_query .= " FROM cust_pkg $addl_from $extra_sql";
4449 'table' => 'cust_pkg',
4451 'select' => $select,
4452 'extra_sql' => $extra_sql,
4453 'order_by' => $orderby,
4454 'addl_from' => $addl_from,
4455 'count_query' => $count_query,
4462 Returns a list of two package counts. The first is a count of packages
4463 based on the supplied criteria and the second is the count of residential
4464 packages with those same criteria. Criteria are specified as in the search
4470 my ($class, $params) = @_;
4472 my $sql_query = $class->search( $params );
4474 my $count_sql = delete($sql_query->{'count_query'});
4475 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
4476 or die "couldn't parse count_sql";
4478 my $count_sth = dbh->prepare($count_sql)
4479 or die "Error preparing $count_sql: ". dbh->errstr;
4481 or die "Error executing $count_sql: ". $count_sth->errstr;
4482 my $count_arrayref = $count_sth->fetchrow_arrayref;
4484 return ( @$count_arrayref );
4488 =item tax_locationnum_sql
4490 Returns an SQL expression for the tax location for a package, based
4491 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
4495 sub tax_locationnum_sql {
4496 my $conf = FS::Conf->new;
4497 if ( $conf->exists('tax-pkg_address') ) {
4498 'cust_pkg.locationnum';
4500 elsif ( $conf->exists('tax-ship_address') ) {
4501 'cust_main.ship_locationnum';
4504 'cust_main.bill_locationnum';
4510 Returns a list: the first item is an SQL fragment identifying matching
4511 packages/customers via location (taking into account shipping and package
4512 address taxation, if enabled), and subsequent items are the parameters to
4513 substitute for the placeholders in that fragment.
4518 my($class, %opt) = @_;
4519 my $ornull = $opt{'ornull'};
4521 my $conf = new FS::Conf;
4523 # '?' placeholders in _location_sql_where
4524 my $x = $ornull ? 3 : 2;
4535 if ( $conf->exists('tax-ship_address') ) {
4538 ( ( ship_last IS NULL OR ship_last = '' )
4539 AND ". _location_sql_where('cust_main', '', $ornull ). "
4541 OR ( ship_last IS NOT NULL AND ship_last != ''
4542 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
4545 # AND payby != 'COMP'
4547 @main_param = ( @bill_param, @bill_param );
4551 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
4552 @main_param = @bill_param;
4558 if ( $conf->exists('tax-pkg_address') ) {
4560 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
4563 ( cust_pkg.locationnum IS NULL AND $main_where )
4564 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
4567 @param = ( @main_param, @bill_param );
4571 $where = $main_where;
4572 @param = @main_param;
4580 #subroutine, helper for location_sql
4581 sub _location_sql_where {
4583 my $prefix = @_ ? shift : '';
4584 my $ornull = @_ ? shift : '';
4586 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
4588 $ornull = $ornull ? ' OR ? IS NULL ' : '';
4590 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
4591 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
4592 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
4594 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
4596 # ( $table.${prefix}city = ? $or_empty_city $ornull )
4598 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4599 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4600 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
4601 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
4602 AND $table.${prefix}country = ?
4607 my( $self, $what ) = @_;
4609 my $what_show_zero = $what. '_show_zero';
4610 length($self->$what_show_zero())
4611 ? ($self->$what_show_zero() eq 'Y')
4612 : $self->part_pkg->$what_show_zero();
4619 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
4621 CUSTNUM is a customer (see L<FS::cust_main>)
4623 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4624 L<FS::part_pkg>) to order for this customer. Duplicates are of course
4627 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
4628 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
4629 new billing items. An error is returned if this is not possible (see
4630 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
4633 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4634 newly-created cust_pkg objects.
4636 REFNUM, if specified, will specify the FS::pkg_referral record to be created
4637 and inserted. Multiple FS::pkg_referral records can be created by
4638 setting I<refnum> to an array reference of refnums or a hash reference with
4639 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
4640 record will be created corresponding to cust_main.refnum.
4645 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
4647 my $conf = new FS::Conf;
4649 # Transactionize this whole mess
4650 local $SIG{HUP} = 'IGNORE';
4651 local $SIG{INT} = 'IGNORE';
4652 local $SIG{QUIT} = 'IGNORE';
4653 local $SIG{TERM} = 'IGNORE';
4654 local $SIG{TSTP} = 'IGNORE';
4655 local $SIG{PIPE} = 'IGNORE';
4657 my $oldAutoCommit = $FS::UID::AutoCommit;
4658 local $FS::UID::AutoCommit = 0;
4662 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
4663 # return "Customer not found: $custnum" unless $cust_main;
4665 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
4668 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4671 my $change = scalar(@old_cust_pkg) != 0;
4674 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
4676 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
4677 " to pkgpart ". $pkgparts->[0]. "\n"
4680 my $err_or_cust_pkg =
4681 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
4682 'refnum' => $refnum,
4685 unless (ref($err_or_cust_pkg)) {
4686 $dbh->rollback if $oldAutoCommit;
4687 return $err_or_cust_pkg;
4690 push @$return_cust_pkg, $err_or_cust_pkg;
4691 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4696 # Create the new packages.
4697 foreach my $pkgpart (@$pkgparts) {
4699 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
4701 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
4702 pkgpart => $pkgpart,
4706 $error = $cust_pkg->insert( 'change' => $change );
4707 push @$return_cust_pkg, $cust_pkg;
4709 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
4710 my $supp_pkg = FS::cust_pkg->new({
4711 custnum => $custnum,
4712 pkgpart => $link->dst_pkgpart,
4714 main_pkgnum => $cust_pkg->pkgnum,
4717 $error ||= $supp_pkg->insert( 'change' => $change );
4718 push @$return_cust_pkg, $supp_pkg;
4722 $dbh->rollback if $oldAutoCommit;
4727 # $return_cust_pkg now contains refs to all of the newly
4730 # Transfer services and cancel old packages.
4731 foreach my $old_pkg (@old_cust_pkg) {
4733 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
4736 foreach my $new_pkg (@$return_cust_pkg) {
4737 $error = $old_pkg->transfer($new_pkg);
4738 if ($error and $error == 0) {
4739 # $old_pkg->transfer failed.
4740 $dbh->rollback if $oldAutoCommit;
4745 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
4746 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
4747 foreach my $new_pkg (@$return_cust_pkg) {
4748 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
4749 if ($error and $error == 0) {
4750 # $old_pkg->transfer failed.
4751 $dbh->rollback if $oldAutoCommit;
4758 # Transfers were successful, but we went through all of the
4759 # new packages and still had services left on the old package.
4760 # We can't cancel the package under the circumstances, so abort.
4761 $dbh->rollback if $oldAutoCommit;
4762 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
4764 $error = $old_pkg->cancel( quiet=>1 );
4770 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4774 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
4776 A bulk change method to change packages for multiple customers.
4778 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4779 L<FS::part_pkg>) to order for each customer. Duplicates are of course
4782 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
4783 replace. The services (see L<FS::cust_svc>) are moved to the
4784 new billing items. An error is returned if this is not possible (see
4787 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4788 newly-created cust_pkg objects.
4793 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
4795 # Transactionize this whole mess
4796 local $SIG{HUP} = 'IGNORE';
4797 local $SIG{INT} = 'IGNORE';
4798 local $SIG{QUIT} = 'IGNORE';
4799 local $SIG{TERM} = 'IGNORE';
4800 local $SIG{TSTP} = 'IGNORE';
4801 local $SIG{PIPE} = 'IGNORE';
4803 my $oldAutoCommit = $FS::UID::AutoCommit;
4804 local $FS::UID::AutoCommit = 0;
4808 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4811 while(scalar(@old_cust_pkg)) {
4813 my $custnum = $old_cust_pkg[0]->custnum;
4814 my (@remove) = map { $_->pkgnum }
4815 grep { $_->custnum == $custnum } @old_cust_pkg;
4816 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
4818 my $error = order $custnum, $pkgparts, \@remove, \@return;
4820 push @errors, $error
4822 push @$return_cust_pkg, @return;
4825 if (scalar(@errors)) {
4826 $dbh->rollback if $oldAutoCommit;
4827 return join(' / ', @errors);
4830 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4834 # Used by FS::Upgrade to migrate to a new database.
4835 sub _upgrade_data { # class method
4836 my ($class, %opts) = @_;
4837 $class->_upgrade_otaker(%opts);
4839 # RT#10139, bug resulting in contract_end being set when it shouldn't
4840 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
4841 # RT#10830, bad calculation of prorate date near end of year
4842 # the date range for bill is December 2009, and we move it forward
4843 # one year if it's before the previous bill date (which it should
4845 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
4846 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
4847 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
4848 # RT6628, add order_date to cust_pkg
4849 'update cust_pkg set order_date = (select history_date from h_cust_pkg
4850 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
4851 history_action = \'insert\') where order_date is null',
4853 foreach my $sql (@statements) {
4854 my $sth = dbh->prepare($sql);
4855 $sth->execute or die $sth->errstr;
4863 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
4865 In sub order, the @pkgparts array (passed by reference) is clobbered.
4867 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
4868 method to pass dates to the recur_prog expression, it should do so.
4870 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
4871 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
4872 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
4873 configuration values. Probably need a subroutine which decides what to do
4874 based on whether or not we've fetched the user yet, rather than a hash. See
4875 FS::UID and the TODO.
4877 Now that things are transactional should the check in the insert method be
4882 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
4883 L<FS::pkg_svc>, schema.html from the base documentation