2 use base qw( FS::otaker_Mixin FS::cust_main_Mixin FS::Sales_Mixin
3 FS::contact_Mixin FS::location_Mixin
4 FS::m2m_Common FS::option_Common );
7 use vars qw( $disable_agentcheck $DEBUG $me $upgrade );
9 use Scalar::Util qw( blessed );
10 use List::Util qw(min max);
12 use Time::Local qw( timelocal timelocal_nocheck );
14 use FS::UID qw( dbh driver_name );
15 use FS::Misc qw( send_email );
16 use FS::Record qw( qsearch qsearchs fields );
22 use FS::cust_location;
24 use FS::cust_bill_pkg;
25 use FS::cust_pkg_detail;
26 use FS::cust_pkg_usage;
27 use FS::cdr_cust_pkg_usage;
32 use FS::cust_pkg_reason;
34 use FS::cust_pkg_discount;
41 # need to 'use' these instead of 'require' in sub { cancel, suspend, unsuspend,
43 # because they load configuration by setting FS::UID::callback (see TODO)
49 # for sending cancel emails in sub cancel
53 $me = '[FS::cust_pkg]';
55 $disable_agentcheck = 0;
57 $upgrade = 0; #go away after setup+start dates cleaned up for old customers
61 my ( $hashref, $cache ) = @_;
62 #if ( $hashref->{'pkgpart'} ) {
63 if ( $hashref->{'pkg'} ) {
64 # #@{ $self->{'_pkgnum'} } = ();
65 # my $subcache = $cache->subcache('pkgpart', 'part_pkg');
66 # $self->{'_pkgpart'} = $subcache;
67 # #push @{ $self->{'_pkgnum'} },
68 # FS::part_pkg->new_or_cached($hashref, $subcache);
69 $self->{'_pkgpart'} = FS::part_pkg->new($hashref);
71 if ( exists $hashref->{'svcnum'} ) {
72 #@{ $self->{'_pkgnum'} } = ();
73 my $subcache = $cache->subcache('svcnum', 'cust_svc', $hashref->{pkgnum});
74 $self->{'_svcnum'} = $subcache;
75 #push @{ $self->{'_pkgnum'} },
76 FS::cust_svc->new_or_cached($hashref, $subcache) if $hashref->{svcnum};
82 FS::cust_pkg - Object methods for cust_pkg objects
88 $record = new FS::cust_pkg \%hash;
89 $record = new FS::cust_pkg { 'column' => 'value' };
91 $error = $record->insert;
93 $error = $new_record->replace($old_record);
95 $error = $record->delete;
97 $error = $record->check;
99 $error = $record->cancel;
101 $error = $record->suspend;
103 $error = $record->unsuspend;
105 $part_pkg = $record->part_pkg;
107 @labels = $record->labels;
109 $seconds = $record->seconds_since($timestamp);
111 $error = FS::cust_pkg::order( $custnum, \@pkgparts );
112 $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );
116 An FS::cust_pkg object represents a customer billing item. FS::cust_pkg
117 inherits from FS::Record. The following fields are currently supported:
123 Primary key (assigned automatically for new billing items)
127 Customer (see L<FS::cust_main>)
131 Billing item definition (see L<FS::part_pkg>)
135 Optional link to package location (see L<FS::location>)
139 date package was ordered (also remains same on changes)
151 date (next bill date)
179 order taker (see L<FS::access_user>)
183 If this field is set to 1, disables the automatic
184 unsuspension of this package when using the B<unsuspendauto> config option.
188 If not set, defaults to 1
192 Date of change from previous package
202 =item change_locationnum
210 The pkgnum of the package that this package is supplemental to, if any.
214 The package link (L<FS::part_pkg_link>) that defines this supplemental
215 package, if it is one.
217 =item change_to_pkgnum
219 The pkgnum of the package this one will be "changed to" in the future
220 (on its expiration date).
224 Note: setup, last_bill, bill, adjourn, susp, expire, cancel and change_date
225 are specified as UNIX timestamps; see L<perlfunc/"time">. Also see
226 L<Time::Local> and L<Date::Parse> for conversion functions.
234 Create a new billing item. To add the item to the database, see L<"insert">.
238 sub table { 'cust_pkg'; }
239 sub cust_linked { $_[0]->cust_main_custnum || $_[0]->custnum }
240 sub cust_unlinked_msg {
242 "WARNING: can't find cust_main.custnum ". $self->custnum.
243 ' (cust_pkg.pkgnum '. $self->pkgnum. ')';
246 =item insert [ OPTION => VALUE ... ]
248 Adds this billing item to the database ("Orders" the item). If there is an
249 error, returns the error, otherwise returns false.
251 If the additional field I<promo_code> is defined instead of I<pkgpart>, it
252 will be used to look up the package definition and agent restrictions will be
255 If the additional field I<refnum> is defined, an FS::pkg_referral record will
256 be created and inserted. Multiple FS::pkg_referral records can be created by
257 setting I<refnum> to an array reference of refnums or a hash reference with
258 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
259 record will be created corresponding to cust_main.refnum.
261 The following options are available:
267 If set true, supresses actions that should only be taken for new package
268 orders. (Currently this includes: intro periods when delay_setup is on.)
272 cust_pkg_option records will be created
276 a ticket will be added to this customer with this subject
280 an optional queue name for ticket additions
284 Don't check the legality of the package definition. This should be used
285 when performing a package change that doesn't change the pkgpart (i.e.
293 my( $self, %options ) = @_;
296 $error = $self->check_pkgpart unless $options{'allow_pkgpart'};
297 return $error if $error;
299 my $part_pkg = $self->part_pkg;
301 # if the package def says to start only on the first of the month:
302 if ( $part_pkg->option('start_1st', 1) && !$self->start_date ) {
303 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime(time) )[0,1,2,3,4,5];
304 $mon += 1 unless $mday == 1;
305 until ( $mon < 12 ) { $mon -= 12; $year++; }
306 $self->start_date( timelocal_nocheck(0,0,0,1,$mon,$year) );
309 # set up any automatic expire/adjourn/contract_end timers
310 # based on the start date
311 foreach my $action ( qw(expire adjourn contract_end) ) {
312 my $months = $part_pkg->option("${action}_months",1);
313 if($months and !$self->$action) {
314 my $start = $self->start_date || $self->setup || time;
315 $self->$action( $part_pkg->add_freq($start, $months) );
319 # if this package has "free days" and delayed setup fee, tehn
320 # set start date that many days in the future.
321 # (this should have been set in the UI, but enforce it here)
322 if ( ! $options{'change'}
323 && ( my $free_days = $part_pkg->option('free_days',1) )
324 && $part_pkg->option('delay_setup',1)
325 #&& ! $self->start_date
328 $self->start_date( $part_pkg->default_start_date );
331 $self->order_date(time);
333 local $SIG{HUP} = 'IGNORE';
334 local $SIG{INT} = 'IGNORE';
335 local $SIG{QUIT} = 'IGNORE';
336 local $SIG{TERM} = 'IGNORE';
337 local $SIG{TSTP} = 'IGNORE';
338 local $SIG{PIPE} = 'IGNORE';
340 my $oldAutoCommit = $FS::UID::AutoCommit;
341 local $FS::UID::AutoCommit = 0;
344 $error = $self->SUPER::insert($options{options} ? %{$options{options}} : ());
346 $dbh->rollback if $oldAutoCommit;
350 $self->refnum($self->cust_main->refnum) unless $self->refnum;
351 $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
352 $self->process_m2m( 'link_table' => 'pkg_referral',
353 'target_table' => 'part_referral',
354 'params' => $self->refnum,
357 if ( $self->discountnum ) {
358 my $error = $self->insert_discount();
360 $dbh->rollback if $oldAutoCommit;
365 my $conf = new FS::Conf;
367 if ( $conf->config('ticket_system') && $options{ticket_subject} ) {
369 #this init stuff is still inefficient, but at least its limited to
370 # the small number (any?) folks using ticket emailing on pkg order
373 # use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
380 use FS::TicketSystem;
381 FS::TicketSystem->init();
383 my $q = new RT::Queue($RT::SystemUser);
384 $q->Load($options{ticket_queue}) if $options{ticket_queue};
385 my $t = new RT::Ticket($RT::SystemUser);
386 my $mime = new MIME::Entity;
387 $mime->build( Type => 'text/plain', Data => $options{ticket_subject} );
388 $t->Create( $options{ticket_queue} ? (Queue => $q) : (),
389 Subject => $options{ticket_subject},
392 $t->AddLink( Type => 'MemberOf',
393 Target => 'freeside://freeside/cust_main/'. $self->custnum,
397 if ($conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
398 my $queue = new FS::queue {
399 'job' => 'FS::cust_main::queueable_print',
401 $error = $queue->insert(
402 'custnum' => $self->custnum,
403 'template' => 'welcome_letter',
407 warn "can't send welcome letter: $error";
412 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
419 This method now works but you probably shouldn't use it.
421 You don't want to delete packages, because there would then be no record
422 the customer ever purchased the package. Instead, see the cancel method and
423 hide cancelled packages.
430 local $SIG{HUP} = 'IGNORE';
431 local $SIG{INT} = 'IGNORE';
432 local $SIG{QUIT} = 'IGNORE';
433 local $SIG{TERM} = 'IGNORE';
434 local $SIG{TSTP} = 'IGNORE';
435 local $SIG{PIPE} = 'IGNORE';
437 my $oldAutoCommit = $FS::UID::AutoCommit;
438 local $FS::UID::AutoCommit = 0;
441 foreach my $cust_pkg_discount ($self->cust_pkg_discount) {
442 my $error = $cust_pkg_discount->delete;
444 $dbh->rollback if $oldAutoCommit;
448 #cust_bill_pkg_discount?
450 foreach my $cust_pkg_detail ($self->cust_pkg_detail) {
451 my $error = $cust_pkg_detail->delete;
453 $dbh->rollback if $oldAutoCommit;
458 foreach my $cust_pkg_reason (
460 'table' => 'cust_pkg_reason',
461 'hashref' => { 'pkgnum' => $self->pkgnum },
465 my $error = $cust_pkg_reason->delete;
467 $dbh->rollback if $oldAutoCommit;
474 my $error = $self->SUPER::delete(@_);
476 $dbh->rollback if $oldAutoCommit;
480 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
486 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
488 Replaces the OLD_RECORD with this one in the database. If there is an error,
489 returns the error, otherwise returns false.
491 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
493 Changing pkgpart may have disasterous effects. See the order subroutine.
495 setup and bill are normally updated by calling the bill method of a customer
496 object (see L<FS::cust_main>).
498 suspend is normally updated by the suspend and unsuspend methods.
500 cancel is normally updated by the cancel method (and also the order subroutine
503 Available options are:
509 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.
513 the access_user (see L<FS::access_user>) providing the reason
517 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
526 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
531 ( ref($_[0]) eq 'HASH' )
535 #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
536 #return "Can't change otaker!" if $old->otaker ne $new->otaker;
539 #return "Can't change setup once it exists!"
540 # if $old->getfield('setup') &&
541 # $old->getfield('setup') != $new->getfield('setup');
543 #some logic for bill, susp, cancel?
545 local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
547 local $SIG{HUP} = 'IGNORE';
548 local $SIG{INT} = 'IGNORE';
549 local $SIG{QUIT} = 'IGNORE';
550 local $SIG{TERM} = 'IGNORE';
551 local $SIG{TSTP} = 'IGNORE';
552 local $SIG{PIPE} = 'IGNORE';
554 my $oldAutoCommit = $FS::UID::AutoCommit;
555 local $FS::UID::AutoCommit = 0;
558 foreach my $method ( qw(adjourn expire) ) { # How many reasons?
559 if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
560 my $error = $new->insert_reason(
561 'reason' => $options->{'reason'},
562 'date' => $new->$method,
564 'reason_otaker' => $options->{'reason_otaker'},
567 dbh->rollback if $oldAutoCommit;
568 return "Error inserting cust_pkg_reason: $error";
573 #save off and freeze RADIUS attributes for any associated svc_acct records
575 if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
577 #also check for specific exports?
578 # to avoid spurious modify export events
579 @svc_acct = map { $_->svc_x }
580 grep { $_->part_svc->svcdb eq 'svc_acct' }
583 $_->snapshot foreach @svc_acct;
587 my $error = $new->export_pkg_change($old)
588 || $new->SUPER::replace( $old,
590 ? $options->{options}
594 $dbh->rollback if $oldAutoCommit;
598 #for prepaid packages,
599 #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
600 foreach my $old_svc_acct ( @svc_acct ) {
601 my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
603 $new_svc_acct->replace( $old_svc_acct,
604 'depend_jobnum' => $options->{depend_jobnum},
607 $dbh->rollback if $oldAutoCommit;
612 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
619 Checks all fields to make sure this is a valid billing item. If there is an
620 error, returns the error, otherwise returns false. Called by the insert and
628 if ( !$self->locationnum or $self->locationnum == -1 ) {
629 $self->set('locationnum', $self->cust_main->ship_locationnum);
633 $self->ut_numbern('pkgnum')
634 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
635 || $self->ut_numbern('pkgpart')
636 || $self->ut_foreign_keyn('contactnum', 'contact', 'contactnum' )
637 || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
638 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
639 || $self->ut_numbern('quantity')
640 || $self->ut_numbern('start_date')
641 || $self->ut_numbern('setup')
642 || $self->ut_numbern('bill')
643 || $self->ut_numbern('susp')
644 || $self->ut_numbern('cancel')
645 || $self->ut_numbern('adjourn')
646 || $self->ut_numbern('resume')
647 || $self->ut_numbern('expire')
648 || $self->ut_numbern('dundate')
649 || $self->ut_enum('no_auto', [ '', 'Y' ])
650 || $self->ut_enum('waive_setup', [ '', 'Y' ])
651 || $self->ut_numbern('agent_pkgid')
652 || $self->ut_enum('recur_show_zero', [ '', 'Y', 'N', ])
653 || $self->ut_enum('setup_show_zero', [ '', 'Y', 'N', ])
654 || $self->ut_foreign_keyn('main_pkgnum', 'cust_pkg', 'pkgnum')
655 || $self->ut_foreign_keyn('pkglinknum', 'part_pkg_link', 'pkglinknum')
656 || $self->ut_foreign_keyn('change_to_pkgnum', 'cust_pkg', 'pkgnum')
658 return $error if $error;
660 return "A package with both start date (future start) and setup date (already started) will never bill"
661 if $self->start_date && $self->setup && ! $upgrade;
663 return "A future unsuspend date can only be set for a package with a suspend date"
664 if $self->resume and !$self->susp and !$self->adjourn;
666 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
668 if ( $self->dbdef_table->column('manual_flag') ) {
669 $self->manual_flag('') if $self->manual_flag eq ' ';
670 $self->manual_flag =~ /^([01]?)$/
671 or return "Illegal manual_flag ". $self->manual_flag;
672 $self->manual_flag($1);
680 Check the pkgpart to make sure it's allowed with the reg_code and/or
681 promo_code of the package (if present) and with the customer's agent.
682 Called from C<insert>, unless we are doing a package change that doesn't
690 # my $error = $self->ut_numbern('pkgpart'); # already done
693 if ( $self->reg_code ) {
695 unless ( grep { $self->pkgpart == $_->pkgpart }
696 map { $_->reg_code_pkg }
697 qsearchs( 'reg_code', { 'code' => $self->reg_code,
698 'agentnum' => $self->cust_main->agentnum })
700 return "Unknown registration code";
703 } elsif ( $self->promo_code ) {
706 qsearchs('part_pkg', {
707 'pkgpart' => $self->pkgpart,
708 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
710 return 'Unknown promotional code' unless $promo_part_pkg;
714 unless ( $disable_agentcheck ) {
716 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
717 return "agent ". $agent->agentnum. ':'. $agent->agent.
718 " can't purchase pkgpart ". $self->pkgpart
719 unless $agent->pkgpart_hashref->{ $self->pkgpart }
720 || $agent->agentnum == $self->part_pkg->agentnum;
723 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
724 return $error if $error;
732 =item cancel [ OPTION => VALUE ... ]
734 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
735 in this package, then cancels the package itself (sets the cancel field to
738 Available options are:
742 =item quiet - can be set true to supress email cancellation notices.
744 =item time - can be set to cancel the package based on a specific future or
745 historical date. Using time ensures that the remaining amount is calculated
746 correctly. Note however that this is an immediate cancel and just changes
747 the date. You are PROBABLY looking to expire the account instead of using
750 =item reason - can be set to a cancellation reason (see L<FS:reason>),
751 either a reasonnum of an existing reason, or passing a hashref will create
752 a new reason. The hashref should have the following keys: typenum - Reason
753 type (see L<FS::reason_type>, reason - Text of the new reason.
755 =item date - can be set to a unix style timestamp to specify when to
758 =item nobill - can be set true to skip billing if it might otherwise be done.
760 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
761 not credit it. This must be set (by change()) when changing the package
762 to a different pkgpart or location, and probably shouldn't be in any other
763 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
768 If there is an error, returns the error, otherwise returns false.
773 my( $self, %options ) = @_;
776 # pass all suspend/cancel actions to the main package
777 if ( $self->main_pkgnum and !$options{'from_main'} ) {
778 return $self->main_pkg->cancel(%options);
781 my $conf = new FS::Conf;
783 warn "cust_pkg::cancel called with options".
784 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
787 local $SIG{HUP} = 'IGNORE';
788 local $SIG{INT} = 'IGNORE';
789 local $SIG{QUIT} = 'IGNORE';
790 local $SIG{TERM} = 'IGNORE';
791 local $SIG{TSTP} = 'IGNORE';
792 local $SIG{PIPE} = 'IGNORE';
794 my $oldAutoCommit = $FS::UID::AutoCommit;
795 local $FS::UID::AutoCommit = 0;
798 my $old = $self->select_for_update;
800 if ( $old->get('cancel') || $self->get('cancel') ) {
801 dbh->rollback if $oldAutoCommit;
802 return ""; # no error
805 # XXX possibly set cancel_time to the expire date?
806 my $cancel_time = $options{'time'} || time;
807 my $date = $options{'date'} if $options{'date'}; # expire/cancel later
808 $date = '' if ($date && $date <= $cancel_time); # complain instead?
810 #race condition: usage could be ongoing until unprovisioned
811 #resolved by performing a change package instead (which unprovisions) and
813 if ( !$options{nobill} && !$date ) {
814 # && $conf->exists('bill_usage_on_cancel') ) { #calc_cancel checks this
815 my $copy = $self->new({$self->hash});
817 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
819 'time' => $cancel_time );
820 warn "Error billing during cancel, custnum ".
821 #$self->cust_main->custnum. ": $error"
826 if ( $options{'reason'} ) {
827 $error = $self->insert_reason( 'reason' => $options{'reason'},
828 'action' => $date ? 'expire' : 'cancel',
829 'date' => $date ? $date : $cancel_time,
830 'reason_otaker' => $options{'reason_otaker'},
833 dbh->rollback if $oldAutoCommit;
834 return "Error inserting cust_pkg_reason: $error";
838 my %svc_cancel_opt = ();
839 $svc_cancel_opt{'date'} = $date if $date;
840 foreach my $cust_svc (
843 sort { $a->[1] <=> $b->[1] }
844 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; }
845 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
847 my $part_svc = $cust_svc->part_svc;
848 next if ( defined($part_svc) and $part_svc->preserve );
849 my $error = $cust_svc->cancel( %svc_cancel_opt );
852 $dbh->rollback if $oldAutoCommit;
853 return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
859 # credit remaining time if appropriate
861 if ( exists($options{'unused_credit'}) ) {
862 $do_credit = $options{'unused_credit'};
865 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
868 my $error = $self->credit_remaining('cancel', $cancel_time);
870 $dbh->rollback if $oldAutoCommit;
877 my %hash = $self->hash;
879 $hash{'expire'} = $date;
881 $hash{'cancel'} = $cancel_time;
883 $hash{'change_custnum'} = $options{'change_custnum'};
885 my $new = new FS::cust_pkg ( \%hash );
886 $error = $new->replace( $self, options => { $self->options } );
887 if ( $self->change_to_pkgnum ) {
888 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
889 $error ||= $change_to->cancel || $change_to->delete;
892 $dbh->rollback if $oldAutoCommit;
896 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
897 $error = $supp_pkg->cancel(%options, 'from_main' => 1);
899 $dbh->rollback if $oldAutoCommit;
900 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
904 foreach my $usage ( $self->cust_pkg_usage ) {
905 $error = $usage->delete;
907 $dbh->rollback if $oldAutoCommit;
908 return "deleting usage pools: $error";
912 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
913 return '' if $date; #no errors
915 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
916 if ( !$options{'quiet'} &&
917 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
919 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
922 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
923 $error = $msg_template->send( 'cust_main' => $self->cust_main,
928 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
929 'to' => \@invoicing_list,
930 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
931 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
934 #should this do something on errors?
941 =item cancel_if_expired [ NOW_TIMESTAMP ]
943 Cancels this package if its expire date has been reached.
947 sub cancel_if_expired {
949 my $time = shift || time;
950 return '' unless $self->expire && $self->expire <= $time;
951 my $error = $self->cancel;
953 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
954 $self->custnum. ": $error";
961 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
962 locationnum, (other fields?). Attempts to re-provision cancelled services
963 using history information (errors at this stage are not fatal).
965 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
967 svc_fatal: service provisioning errors are fatal
969 svc_errors: pass an array reference, will be filled in with any provisioning errors
971 main_pkgnum: link the package as a supplemental package of this one. For
977 my( $self, %options ) = @_;
979 #in case you try do do $uncancel-date = $cust_pkg->uncacel
980 return '' unless $self->get('cancel');
982 if ( $self->main_pkgnum and !$options{'main_pkgnum'} ) {
983 return $self->main_pkg->uncancel(%options);
990 local $SIG{HUP} = 'IGNORE';
991 local $SIG{INT} = 'IGNORE';
992 local $SIG{QUIT} = 'IGNORE';
993 local $SIG{TERM} = 'IGNORE';
994 local $SIG{TSTP} = 'IGNORE';
995 local $SIG{PIPE} = 'IGNORE';
997 my $oldAutoCommit = $FS::UID::AutoCommit;
998 local $FS::UID::AutoCommit = 0;
1002 # insert the new package
1005 my $cust_pkg = new FS::cust_pkg {
1006 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
1007 bill => ( $options{'bill'} || $self->get('bill') ),
1009 uncancel_pkgnum => $self->pkgnum,
1010 main_pkgnum => ($options{'main_pkgnum'} || ''),
1011 map { $_ => $self->get($_) } qw(
1012 custnum pkgpart locationnum
1014 susp adjourn resume expire start_date contract_end dundate
1015 change_date change_pkgpart change_locationnum
1016 manual_flag no_auto quantity agent_pkgid recur_show_zero setup_show_zero
1020 my $error = $cust_pkg->insert(
1021 'change' => 1, #supresses any referral credit to a referring customer
1022 'allow_pkgpart' => 1, # allow this even if the package def is disabled
1025 $dbh->rollback if $oldAutoCommit;
1033 #find historical services within this timeframe before the package cancel
1034 # (incompatible with "time" option to cust_pkg->cancel?)
1035 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
1036 # too little? (unprovisioing export delay?)
1037 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
1038 my @h_cust_svc = $self->h_cust_svc( $end, $start );
1041 foreach my $h_cust_svc (@h_cust_svc) {
1042 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
1043 #next unless $h_svc_x; #should this happen?
1044 (my $table = $h_svc_x->table) =~ s/^h_//;
1045 require "FS/$table.pm";
1046 my $class = "FS::$table";
1047 my $svc_x = $class->new( {
1048 'pkgnum' => $cust_pkg->pkgnum,
1049 'svcpart' => $h_cust_svc->svcpart,
1050 map { $_ => $h_svc_x->get($_) } fields($table)
1054 if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
1055 $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
1058 my $svc_error = $svc_x->insert;
1060 if ( $options{svc_fatal} ) {
1061 $dbh->rollback if $oldAutoCommit;
1064 # if we've failed to insert the svc_x object, svc_Common->insert
1065 # will have removed the cust_svc already. if not, then both records
1066 # were inserted but we failed for some other reason (export, most
1067 # likely). in that case, report the error and delete the records.
1068 push @svc_errors, $svc_error;
1069 my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1071 # except if export_insert failed, export_delete probably won't be
1073 local $FS::svc_Common::noexport_hack = 1;
1074 my $cleanup_error = $svc_x->delete; # also deletes cust_svc
1075 if ( $cleanup_error ) { # and if THAT fails, then run away
1076 $dbh->rollback if $oldAutoCommit;
1077 return $cleanup_error;
1082 } #foreach $h_cust_svc
1084 #these are pretty rare, but should handle them
1085 # - dsl_device (mac addresses)
1086 # - phone_device (mac addresses)
1087 # - dsl_note (ikano notes)
1088 # - domain_record (i.e. restore DNS information w/domains)
1089 # - inventory_item(?) (inventory w/un-cancelling service?)
1090 # - nas (svc_broaband nas stuff)
1091 #this stuff is unused in the wild afaik
1092 # - mailinglistmember
1094 # - svc_domain.parent_svcnum?
1095 # - acct_snarf (ancient mail fetching config)
1096 # - cgp_rule (communigate)
1097 # - cust_svc_option (used by our Tron stuff)
1098 # - acct_rt_transaction (used by our time worked stuff)
1101 # also move over any services that didn't unprovision at cancellation
1104 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1105 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1106 my $error = $cust_svc->replace;
1108 $dbh->rollback if $oldAutoCommit;
1114 # Uncancel any supplemental packages, and make them supplemental to the
1118 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1120 $error = $supp_pkg->uncancel(%options, 'main_pkgnum' => $cust_pkg->pkgnum);
1122 $dbh->rollback if $oldAutoCommit;
1123 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1131 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1133 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1134 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1141 Cancels any pending expiration (sets the expire field to null).
1143 If there is an error, returns the error, otherwise returns false.
1148 my( $self, %options ) = @_;
1151 local $SIG{HUP} = 'IGNORE';
1152 local $SIG{INT} = 'IGNORE';
1153 local $SIG{QUIT} = 'IGNORE';
1154 local $SIG{TERM} = 'IGNORE';
1155 local $SIG{TSTP} = 'IGNORE';
1156 local $SIG{PIPE} = 'IGNORE';
1158 my $oldAutoCommit = $FS::UID::AutoCommit;
1159 local $FS::UID::AutoCommit = 0;
1162 my $old = $self->select_for_update;
1164 my $pkgnum = $old->pkgnum;
1165 if ( $old->get('cancel') || $self->get('cancel') ) {
1166 dbh->rollback if $oldAutoCommit;
1167 return "Can't unexpire cancelled package $pkgnum";
1168 # or at least it's pointless
1171 unless ( $old->get('expire') && $self->get('expire') ) {
1172 dbh->rollback if $oldAutoCommit;
1173 return ""; # no error
1176 my %hash = $self->hash;
1177 $hash{'expire'} = '';
1178 my $new = new FS::cust_pkg ( \%hash );
1179 $error = $new->replace( $self, options => { $self->options } );
1181 $dbh->rollback if $oldAutoCommit;
1185 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1191 =item suspend [ OPTION => VALUE ... ]
1193 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1194 package, then suspends the package itself (sets the susp field to now).
1196 Available options are:
1200 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1201 either a reasonnum of an existing reason, or passing a hashref will create
1202 a new reason. The hashref should have the following keys:
1203 - typenum - Reason type (see L<FS::reason_type>
1204 - reason - Text of the new reason.
1206 =item date - can be set to a unix style timestamp to specify when to
1209 =item time - can be set to override the current time, for calculation
1210 of final invoices or unused-time credits
1212 =item resume_date - can be set to a time when the package should be
1213 unsuspended. This may be more convenient than calling C<unsuspend()>
1216 =item from_main - allows a supplemental package to be suspended, rather
1217 than redirecting the method call to its main package. For internal use.
1221 If there is an error, returns the error, otherwise returns false.
1226 my( $self, %options ) = @_;
1229 # pass all suspend/cancel actions to the main package
1230 if ( $self->main_pkgnum and !$options{'from_main'} ) {
1231 return $self->main_pkg->suspend(%options);
1234 local $SIG{HUP} = 'IGNORE';
1235 local $SIG{INT} = 'IGNORE';
1236 local $SIG{QUIT} = 'IGNORE';
1237 local $SIG{TERM} = 'IGNORE';
1238 local $SIG{TSTP} = 'IGNORE';
1239 local $SIG{PIPE} = 'IGNORE';
1241 my $oldAutoCommit = $FS::UID::AutoCommit;
1242 local $FS::UID::AutoCommit = 0;
1245 my $old = $self->select_for_update;
1247 my $pkgnum = $old->pkgnum;
1248 if ( $old->get('cancel') || $self->get('cancel') ) {
1249 dbh->rollback if $oldAutoCommit;
1250 return "Can't suspend cancelled package $pkgnum";
1253 if ( $old->get('susp') || $self->get('susp') ) {
1254 dbh->rollback if $oldAutoCommit;
1255 return ""; # no error # complain on adjourn?
1258 my $suspend_time = $options{'time'} || time;
1259 my $date = $options{date} if $options{date}; # adjourn/suspend later
1260 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1262 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1263 dbh->rollback if $oldAutoCommit;
1264 return "Package $pkgnum expires before it would be suspended.";
1267 # some false laziness with sub cancel
1268 if ( !$options{nobill} && !$date &&
1269 $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1270 # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1271 # make the entire cust_main->bill path recognize 'suspend' and
1272 # 'cancel' separately.
1273 warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1274 my $copy = $self->new({$self->hash});
1276 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1278 'time' => $suspend_time );
1279 warn "Error billing during suspend, custnum ".
1280 #$self->cust_main->custnum. ": $error"
1285 if ( $options{'reason'} ) {
1286 $error = $self->insert_reason( 'reason' => $options{'reason'},
1287 'action' => $date ? 'adjourn' : 'suspend',
1288 'date' => $date ? $date : $suspend_time,
1289 'reason_otaker' => $options{'reason_otaker'},
1292 dbh->rollback if $oldAutoCommit;
1293 return "Error inserting cust_pkg_reason: $error";
1297 my %hash = $self->hash;
1299 $hash{'adjourn'} = $date;
1301 $hash{'susp'} = $suspend_time;
1304 my $resume_date = $options{'resume_date'} || 0;
1305 if ( $resume_date > ($date || $suspend_time) ) {
1306 $hash{'resume'} = $resume_date;
1309 $options{options} ||= {};
1311 my $new = new FS::cust_pkg ( \%hash );
1312 $error = $new->replace( $self, options => { $self->options,
1313 %{ $options{options} },
1317 $dbh->rollback if $oldAutoCommit;
1322 # credit remaining time if appropriate
1323 if ( $self->part_pkg->option('unused_credit_suspend', 1) ) {
1324 my $error = $self->credit_remaining('suspend', $suspend_time);
1326 $dbh->rollback if $oldAutoCommit;
1333 foreach my $cust_svc (
1334 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1336 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1338 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1339 $dbh->rollback if $oldAutoCommit;
1340 return "Illegal svcdb value in part_svc!";
1343 require "FS/$svcdb.pm";
1345 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1347 $error = $svc->suspend;
1349 $dbh->rollback if $oldAutoCommit;
1352 my( $label, $value ) = $cust_svc->label;
1353 push @labels, "$label: $value";
1357 my $conf = new FS::Conf;
1358 if ( $conf->config('suspend_email_admin') ) {
1360 my $error = send_email(
1361 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1362 #invoice_from ??? well as good as any
1363 'to' => $conf->config('suspend_email_admin'),
1364 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1366 "This is an automatic message from your Freeside installation\n",
1367 "informing you that the following customer package has been suspended:\n",
1369 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1370 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1371 ( map { "Service : $_\n" } @labels ),
1376 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1384 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1385 $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1387 $dbh->rollback if $oldAutoCommit;
1388 return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1392 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1397 =item credit_remaining MODE TIME
1399 Generate a credit for this package for the time remaining in the current
1400 billing period. MODE is either "suspend" or "cancel" (determines the
1401 credit type). TIME is the time of suspension/cancellation. Both arguments
1406 sub credit_remaining {
1407 # Add a credit for remaining service
1408 my ($self, $mode, $time) = @_;
1409 die 'credit_remaining requires suspend or cancel'
1410 unless $mode eq 'suspend' or $mode eq 'cancel';
1411 die 'no suspend/cancel time' unless $time > 0;
1413 my $conf = FS::Conf->new;
1414 my $reason_type = $conf->config($mode.'_credit_type');
1416 my $last_bill = $self->getfield('last_bill') || 0;
1417 my $next_bill = $self->getfield('bill') || 0;
1418 if ( $last_bill > 0 # the package has been billed
1419 and $next_bill > 0 # the package has a next bill date
1420 and $next_bill >= $time # which is in the future
1422 my $remaining_value = $self->calc_remain('time' => $time);
1423 if ( $remaining_value > 0 ) {
1424 warn "Crediting for $remaining_value on package ".$self->pkgnum."\n"
1426 my $error = $self->cust_main->credit(
1428 'Credit for unused time on '. $self->part_pkg->pkg,
1429 'reason_type' => $reason_type,
1431 return "Error crediting customer \$$remaining_value for unused time".
1432 " on ". $self->part_pkg->pkg. ": $error"
1434 } #if $remaining_value
1435 } #if $last_bill, etc.
1439 =item unsuspend [ OPTION => VALUE ... ]
1441 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1442 package, then unsuspends the package itself (clears the susp field and the
1443 adjourn field if it is in the past). If the suspend reason includes an
1444 unsuspension package, that package will be ordered.
1446 Available options are:
1452 Can be set to a date to unsuspend the package in the future (the 'resume'
1455 =item adjust_next_bill
1457 Can be set true to adjust the next bill date forward by
1458 the amount of time the account was inactive. This was set true by default
1459 in the past (from 1.4.2 and 1.5.0pre6 through 1.7.0), but now needs to be
1460 explicitly requested with this option or in the price plan.
1464 If there is an error, returns the error, otherwise returns false.
1469 my( $self, %opt ) = @_;
1472 # pass all suspend/cancel actions to the main package
1473 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1474 return $self->main_pkg->unsuspend(%opt);
1477 local $SIG{HUP} = 'IGNORE';
1478 local $SIG{INT} = 'IGNORE';
1479 local $SIG{QUIT} = 'IGNORE';
1480 local $SIG{TERM} = 'IGNORE';
1481 local $SIG{TSTP} = 'IGNORE';
1482 local $SIG{PIPE} = 'IGNORE';
1484 my $oldAutoCommit = $FS::UID::AutoCommit;
1485 local $FS::UID::AutoCommit = 0;
1488 my $old = $self->select_for_update;
1490 my $pkgnum = $old->pkgnum;
1491 if ( $old->get('cancel') || $self->get('cancel') ) {
1492 $dbh->rollback if $oldAutoCommit;
1493 return "Can't unsuspend cancelled package $pkgnum";
1496 unless ( $old->get('susp') && $self->get('susp') ) {
1497 $dbh->rollback if $oldAutoCommit;
1498 return ""; # no error # complain instead?
1501 my $date = $opt{'date'};
1502 if ( $date and $date > time ) { # return an error if $date <= time?
1504 if ( $old->get('expire') && $old->get('expire') < $date ) {
1505 $dbh->rollback if $oldAutoCommit;
1506 return "Package $pkgnum expires before it would be unsuspended.";
1509 my $new = new FS::cust_pkg { $self->hash };
1510 $new->set('resume', $date);
1511 $error = $new->replace($self, options => $self->options);
1514 $dbh->rollback if $oldAutoCommit;
1518 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1526 foreach my $cust_svc (
1527 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1529 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1531 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1532 $dbh->rollback if $oldAutoCommit;
1533 return "Illegal svcdb value in part_svc!";
1536 require "FS/$svcdb.pm";
1538 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1540 $error = $svc->unsuspend;
1542 $dbh->rollback if $oldAutoCommit;
1545 my( $label, $value ) = $cust_svc->label;
1546 push @labels, "$label: $value";
1551 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1552 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1554 my %hash = $self->hash;
1555 my $inactive = time - $hash{'susp'};
1557 my $conf = new FS::Conf;
1559 if ( $inactive > 0 &&
1560 ( $hash{'bill'} || $hash{'setup'} ) &&
1561 ( $opt{'adjust_next_bill'} ||
1562 $conf->exists('unsuspend-always_adjust_next_bill_date') ||
1563 $self->part_pkg->option('unsuspend_adjust_bill', 1) )
1566 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1571 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1572 $hash{'resume'} = '' if !$hash{'adjourn'};
1573 my $new = new FS::cust_pkg ( \%hash );
1574 $error = $new->replace( $self, options => { $self->options } );
1576 $dbh->rollback if $oldAutoCommit;
1582 if ( $reason && $reason->unsuspend_pkgpart ) {
1583 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
1584 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
1586 my $start_date = $self->cust_main->next_bill_date
1587 if $reason->unsuspend_hold;
1590 $unsusp_pkg = FS::cust_pkg->new({
1591 'custnum' => $self->custnum,
1592 'pkgpart' => $reason->unsuspend_pkgpart,
1593 'start_date' => $start_date,
1594 'locationnum' => $self->locationnum,
1595 # discount? probably not...
1598 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
1602 $dbh->rollback if $oldAutoCommit;
1607 if ( $conf->config('unsuspend_email_admin') ) {
1609 my $error = send_email(
1610 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1611 #invoice_from ??? well as good as any
1612 'to' => $conf->config('unsuspend_email_admin'),
1613 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
1614 "This is an automatic message from your Freeside installation\n",
1615 "informing you that the following customer package has been unsuspended:\n",
1617 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1618 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1619 ( map { "Service : $_\n" } @labels ),
1621 "An unsuspension fee was charged: ".
1622 $unsusp_pkg->part_pkg->pkg_comment."\n"
1629 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
1635 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1636 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
1638 $dbh->rollback if $oldAutoCommit;
1639 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1643 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1650 Cancels any pending suspension (sets the adjourn field to null).
1652 If there is an error, returns the error, otherwise returns false.
1657 my( $self, %options ) = @_;
1660 local $SIG{HUP} = 'IGNORE';
1661 local $SIG{INT} = 'IGNORE';
1662 local $SIG{QUIT} = 'IGNORE';
1663 local $SIG{TERM} = 'IGNORE';
1664 local $SIG{TSTP} = 'IGNORE';
1665 local $SIG{PIPE} = 'IGNORE';
1667 my $oldAutoCommit = $FS::UID::AutoCommit;
1668 local $FS::UID::AutoCommit = 0;
1671 my $old = $self->select_for_update;
1673 my $pkgnum = $old->pkgnum;
1674 if ( $old->get('cancel') || $self->get('cancel') ) {
1675 dbh->rollback if $oldAutoCommit;
1676 return "Can't unadjourn cancelled package $pkgnum";
1677 # or at least it's pointless
1680 if ( $old->get('susp') || $self->get('susp') ) {
1681 dbh->rollback if $oldAutoCommit;
1682 return "Can't unadjourn suspended package $pkgnum";
1683 # perhaps this is arbitrary
1686 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1687 dbh->rollback if $oldAutoCommit;
1688 return ""; # no error
1691 my %hash = $self->hash;
1692 $hash{'adjourn'} = '';
1693 $hash{'resume'} = '';
1694 my $new = new FS::cust_pkg ( \%hash );
1695 $error = $new->replace( $self, options => { $self->options } );
1697 $dbh->rollback if $oldAutoCommit;
1701 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1708 =item change HASHREF | OPTION => VALUE ...
1710 Changes this package: cancels it and creates a new one, with a different
1711 pkgpart or locationnum or both. All services are transferred to the new
1712 package (no change will be made if this is not possible).
1714 Options may be passed as a list of key/value pairs or as a hash reference.
1721 New locationnum, to change the location for this package.
1725 New FS::cust_location object, to create a new location and assign it
1730 New FS::cust_main object, to create a new customer and assign the new package
1735 New pkgpart (see L<FS::part_pkg>).
1739 New refnum (see L<FS::part_referral>).
1743 New quantity; if unspecified, the new package will have the same quantity
1748 "New" (existing) FS::cust_pkg object. The package's services and other
1749 attributes will be transferred to this package.
1753 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1754 susp, adjourn, cancel, expire, and contract_end) to the new package.
1756 =item unprotect_svcs
1758 Normally, change() will rollback and return an error if some services
1759 can't be transferred (also see the I<cust_pkg-change_svcpart> config option).
1760 If unprotect_svcs is true, this method will transfer as many services as
1761 it can and then unconditionally cancel the old package.
1765 At least one of locationnum, cust_location, pkgpart, refnum, cust_main, or
1766 cust_pkg must be specified (otherwise, what's the point?)
1768 Returns either the new FS::cust_pkg object or a scalar error.
1772 my $err_or_new_cust_pkg = $old_cust_pkg->change
1776 #some false laziness w/order
1779 my $opt = ref($_[0]) ? shift : { @_ };
1781 my $conf = new FS::Conf;
1783 # Transactionize this whole mess
1784 local $SIG{HUP} = 'IGNORE';
1785 local $SIG{INT} = 'IGNORE';
1786 local $SIG{QUIT} = 'IGNORE';
1787 local $SIG{TERM} = 'IGNORE';
1788 local $SIG{TSTP} = 'IGNORE';
1789 local $SIG{PIPE} = 'IGNORE';
1791 my $oldAutoCommit = $FS::UID::AutoCommit;
1792 local $FS::UID::AutoCommit = 0;
1801 $hash{'setup'} = $time if $self->setup;
1803 $hash{'change_date'} = $time;
1804 $hash{"change_$_"} = $self->$_()
1805 foreach qw( pkgnum pkgpart locationnum );
1807 if ( $opt->{'cust_location'} ) {
1808 $error = $opt->{'cust_location'}->find_or_insert;
1810 $dbh->rollback if $oldAutoCommit;
1811 return "inserting cust_location (transaction rolled back): $error";
1813 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1816 if ( $opt->{'cust_pkg'} ) {
1817 # treat changing to a package with a different pkgpart as a
1818 # pkgpart change (because it is)
1819 $opt->{'pkgpart'} = $opt->{'cust_pkg'}->pkgpart;
1822 # whether to override pkgpart checking on the new package
1823 my $same_pkgpart = 1;
1824 if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
1828 my $unused_credit = 0;
1829 my $keep_dates = $opt->{'keep_dates'};
1830 # Special case. If the pkgpart is changing, and the customer is
1831 # going to be credited for remaining time, don't keep setup, bill,
1832 # or last_bill dates, and DO pass the flag to cancel() to credit
1834 if ( $opt->{'pkgpart'}
1835 and $opt->{'pkgpart'} != $self->pkgpart
1836 and $self->part_pkg->option('unused_credit_change', 1) ) {
1839 $hash{$_} = '' foreach qw(setup bill last_bill);
1842 if ( $keep_dates ) {
1843 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1844 resume start_date contract_end ) ) {
1845 $hash{$date} = $self->getfield($date);
1849 # allow $opt->{'locationnum'} = '' to specifically set it to null
1850 # (i.e. customer default location)
1851 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
1853 # usually this doesn't matter. the two cases where it does are:
1854 # 1. unused_credit_change + pkgpart change + setup fee on the new package
1856 # 2. (more importantly) changing a package before it's billed
1857 $hash{'waive_setup'} = $self->waive_setup;
1859 my $custnum = $self->custnum;
1860 if ( $opt->{cust_main} ) {
1861 my $cust_main = $opt->{cust_main};
1862 unless ( $cust_main->custnum ) {
1863 my $error = $cust_main->insert;
1865 $dbh->rollback if $oldAutoCommit;
1866 return "inserting cust_main (transaction rolled back): $error";
1869 $custnum = $cust_main->custnum;
1872 $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
1875 if ( $opt->{'cust_pkg'} ) {
1876 # The target package already exists; update it to show that it was
1877 # changed from this package.
1878 $cust_pkg = $opt->{'cust_pkg'};
1880 foreach ( qw( pkgnum pkgpart locationnum ) ) {
1881 $cust_pkg->set("change_$_", $self->get($_));
1883 $cust_pkg->set('change_date', $time);
1884 $error = $cust_pkg->replace;
1887 # Create the new package.
1888 $cust_pkg = new FS::cust_pkg {
1889 custnum => $custnum,
1890 locationnum => $opt->{'locationnum'},
1891 ( map { $_ => ( $opt->{$_} || $self->$_() ) }
1892 qw( pkgpart quantity refnum salesnum )
1896 $error = $cust_pkg->insert( 'change' => 1,
1897 'allow_pkgpart' => $same_pkgpart );
1900 $dbh->rollback if $oldAutoCommit;
1904 # Transfer services and cancel old package.
1906 $error = $self->transfer($cust_pkg);
1907 if ($error and $error == 0) {
1908 # $old_pkg->transfer failed.
1909 $dbh->rollback if $oldAutoCommit;
1913 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
1914 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
1915 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
1916 if ($error and $error == 0) {
1917 # $old_pkg->transfer failed.
1918 $dbh->rollback if $oldAutoCommit;
1923 # We set unprotect_svcs when executing a "future package change". It's
1924 # not a user-interactive operation, so returning an error means the
1925 # package change will just fail. Rather than have that happen, we'll
1926 # let leftover services be deleted.
1927 if ($error > 0 and !$opt->{'unprotect_svcs'}) {
1928 # Transfers were successful, but we still had services left on the old
1929 # package. We can't change the package under this circumstances, so abort.
1930 $dbh->rollback if $oldAutoCommit;
1931 return "Unable to transfer all services from package ". $self->pkgnum;
1934 #reset usage if changing pkgpart
1935 # AND usage rollover is off (otherwise adds twice, now and at package bill)
1936 if ($self->pkgpart != $cust_pkg->pkgpart) {
1937 my $part_pkg = $cust_pkg->part_pkg;
1938 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
1942 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
1945 $dbh->rollback if $oldAutoCommit;
1946 return "Error setting usage values: $error";
1949 # if NOT changing pkgpart, transfer any usage pools over
1950 foreach my $usage ($self->cust_pkg_usage) {
1951 $usage->set('pkgnum', $cust_pkg->pkgnum);
1952 $error = $usage->replace;
1954 $dbh->rollback if $oldAutoCommit;
1955 return "Error transferring usage pools: $error";
1960 # transfer discounts, if we're not changing pkgpart
1961 if ( $same_pkgpart ) {
1962 foreach my $old_discount ($self->cust_pkg_discount_active) {
1963 # don't remove the old discount, we may still need to bill that package.
1964 my $new_discount = new FS::cust_pkg_discount {
1965 'pkgnum' => $cust_pkg->pkgnum,
1966 'discountnum' => $old_discount->discountnum,
1967 'months_used' => $old_discount->months_used,
1969 $error = $new_discount->insert;
1971 $dbh->rollback if $oldAutoCommit;
1972 return "Error transferring discounts: $error";
1977 # transfer (copy) invoice details
1978 foreach my $detail ($self->cust_pkg_detail) {
1979 my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
1980 $new_detail->set('pkgdetailnum', '');
1981 $new_detail->set('pkgnum', $cust_pkg->pkgnum);
1982 $error = $new_detail->insert;
1984 $dbh->rollback if $oldAutoCommit;
1985 return "Error transferring package notes: $error";
1991 if ( !$opt->{'cust_pkg'} ) {
1992 # Order any supplemental packages.
1993 my $part_pkg = $cust_pkg->part_pkg;
1994 my @old_supp_pkgs = $self->supplemental_pkgs;
1995 foreach my $link ($part_pkg->supp_part_pkg_link) {
1997 foreach (@old_supp_pkgs) {
1998 if ($_->pkgpart == $link->dst_pkgpart) {
2000 $_->pkgpart(0); # so that it can't match more than once
2004 # false laziness with FS::cust_main::Packages::order_pkg
2005 my $new = FS::cust_pkg->new({
2006 pkgpart => $link->dst_pkgpart,
2007 pkglinknum => $link->pkglinknum,
2008 custnum => $custnum,
2009 main_pkgnum => $cust_pkg->pkgnum,
2010 locationnum => $cust_pkg->locationnum,
2011 start_date => $cust_pkg->start_date,
2012 order_date => $cust_pkg->order_date,
2013 expire => $cust_pkg->expire,
2014 adjourn => $cust_pkg->adjourn,
2015 contract_end => $cust_pkg->contract_end,
2016 refnum => $cust_pkg->refnum,
2017 discountnum => $cust_pkg->discountnum,
2018 waive_setup => $cust_pkg->waive_setup,
2020 if ( $old and $opt->{'keep_dates'} ) {
2021 foreach (qw(setup bill last_bill)) {
2022 $new->set($_, $old->get($_));
2025 $error = $new->insert( allow_pkgpart => $same_pkgpart );
2028 $error ||= $old->transfer($new);
2030 if ( $error and $error > 0 ) {
2031 # no reason why this should ever fail, but still...
2032 $error = "Unable to transfer all services from supplemental package ".
2036 $dbh->rollback if $oldAutoCommit;
2039 push @new_supp_pkgs, $new;
2041 } # if !$opt->{'cust_pkg'}
2042 # because if there is one, then supplemental packages would already
2043 # have been created for it.
2045 #Good to go, cancel old package. Notify 'cancel' of whether to credit
2047 #Don't allow billing the package (preceding period packages and/or
2048 #outstanding usage) if we are keeping dates (i.e. location changing),
2049 #because the new package will be billed for the same date range.
2050 #Supplemental packages are also canceled here.
2052 # during scheduled changes, avoid canceling the package we just
2054 $self->set('change_to_pkgnum' => '');
2056 $error = $self->cancel(
2058 unused_credit => $unused_credit,
2059 nobill => $keep_dates,
2060 change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2063 $dbh->rollback if $oldAutoCommit;
2067 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2069 my $error = $cust_pkg->cust_main->bill(
2070 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2073 $dbh->rollback if $oldAutoCommit;
2078 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2084 =item change_later OPTION => VALUE...
2086 Schedule a package change for a later date. This actually orders the new
2087 package immediately, but sets its start date for a future date, and sets
2088 the current package to expire on the same date.
2090 If the package is already scheduled for a change, this can be called with
2091 'start_date' to change the scheduled date, or with pkgpart and/or
2092 locationnum to modify the package change. To cancel the scheduled change
2093 entirely, see C<abort_change>.
2101 The date for the package change. Required, and must be in the future.
2109 The pkgpart. locationnum, and quantity of the new package, with the same
2110 meaning as in C<change>.
2118 my $opt = ref($_[0]) ? shift : { @_ };
2120 my $oldAutoCommit = $FS::UID::AutoCommit;
2121 local $FS::UID::AutoCommit = 0;
2124 my $cust_main = $self->cust_main;
2126 my $date = delete $opt->{'start_date'} or return 'start_date required';
2128 if ( $date <= time ) {
2129 $dbh->rollback if $oldAutoCommit;
2130 return "start_date $date is in the past";
2135 if ( $self->change_to_pkgnum ) {
2136 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
2137 my $new_pkgpart = $opt->{'pkgpart'}
2138 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $change_to->pkgpart;
2139 my $new_locationnum = $opt->{'locationnum'}
2140 if $opt->{'locationnum'} and $opt->{'locationnum'} != $change_to->locationnum;
2141 my $new_quantity = $opt->{'quantity'}
2142 if $opt->{'quantity'} and $opt->{'quantity'} != $change_to->quantity;
2143 if ( $new_pkgpart or $new_locationnum or $new_quantity ) {
2144 # it hasn't been billed yet, so in principle we could just edit
2145 # it in place (w/o a package change), but that's bad form.
2146 # So change the package according to the new options...
2147 my $err_or_pkg = $change_to->change(%$opt);
2148 if ( ref $err_or_pkg ) {
2149 # Then set that package up for a future start.
2150 $self->set('change_to_pkgnum', $err_or_pkg->pkgnum);
2151 $self->set('expire', $date); # in case it's different
2152 $err_or_pkg->set('start_date', $date);
2153 $err_or_pkg->set('change_date', '');
2154 $err_or_pkg->set('change_pkgnum', '');
2156 $error = $self->replace ||
2157 $err_or_pkg->replace ||
2158 $change_to->cancel ||
2161 $error = $err_or_pkg;
2163 } else { # change the start date only.
2164 $self->set('expire', $date);
2165 $change_to->set('start_date', $date);
2166 $error = $self->replace || $change_to->replace;
2169 $dbh->rollback if $oldAutoCommit;
2172 $dbh->commit if $oldAutoCommit;
2175 } # if $self->change_to_pkgnum
2177 my $new_pkgpart = $opt->{'pkgpart'}
2178 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2179 my $new_locationnum = $opt->{'locationnum'}
2180 if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2181 my $new_quantity = $opt->{'quantity'}
2182 if $opt->{'quantity'} and $opt->{'quantity'} != $self->quantity;
2184 return '' unless $new_pkgpart or $new_locationnum or $new_quantity; # wouldn't do anything
2186 # allow $opt->{'locationnum'} = '' to specifically set it to null
2187 # (i.e. customer default location)
2188 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2190 my $new = FS::cust_pkg->new( {
2191 custnum => $self->custnum,
2192 locationnum => $opt->{'locationnum'},
2193 start_date => $date,
2194 map { $_ => ( $opt->{$_} || $self->$_() ) }
2195 qw( pkgpart quantity refnum salesnum )
2197 $error = $new->insert('change' => 1,
2198 'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2200 $self->set('change_to_pkgnum', $new->pkgnum);
2201 $self->set('expire', $date);
2202 $error = $self->replace;
2205 $dbh->rollback if $oldAutoCommit;
2207 $dbh->commit if $oldAutoCommit;
2215 Cancels a future package change scheduled by C<change_later>.
2221 my $pkgnum = $self->change_to_pkgnum;
2222 my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
2225 $error = $change_to->cancel || $change_to->delete;
2226 return $error if $error;
2228 $self->set('change_to_pkgnum', '');
2229 $self->set('expire', '');
2233 =item set_quantity QUANTITY
2235 Change the package's quantity field. This is one of the few package properties
2236 that can safely be changed without canceling and reordering the package
2237 (because it doesn't affect tax eligibility). Returns an error or an
2244 $self = $self->replace_old; # just to make sure
2245 $self->quantity(shift);
2249 =item set_salesnum SALESNUM
2251 Change the package's salesnum (sales person) field. This is one of the few
2252 package properties that can safely be changed without canceling and reordering
2253 the package (because it doesn't affect tax eligibility). Returns an error or
2260 $self = $self->replace_old; # just to make sure
2261 $self->salesnum(shift);
2263 # XXX this should probably reassign any credit that's already been given
2266 =item modify_charge OPTIONS
2268 Change the properties of a one-time charge. Currently the only properties
2269 that can be changed this way are those that have no impact on billing
2271 - pkg: the package description
2272 - classnum: the package class
2273 - additional: arrayref of additional invoice details to add to this package
2275 If you pass 'adjust_commission' => 1, and the classnum changes, and there are
2276 commission credits linked to this charge, they will be recalculated.
2283 my $part_pkg = $self->part_pkg;
2284 my $pkgnum = $self->pkgnum;
2287 my $oldAutoCommit = $FS::UID::AutoCommit;
2288 local $FS::UID::AutoCommit = 0;
2290 return "Can't use modify_charge except on one-time charges"
2291 unless $part_pkg->freq eq '0';
2293 if ( length($opt{'pkg'}) and $part_pkg->pkg ne $opt{'pkg'} ) {
2294 $part_pkg->set('pkg', $opt{'pkg'});
2297 my %pkg_opt = $part_pkg->options;
2298 if ( ref($opt{'additional'}) ) {
2299 delete $pkg_opt{$_} foreach grep /^additional/, keys %pkg_opt;
2301 for ( $i = 0; exists($opt{'additional'}->[$i]); $i++ ) {
2302 $pkg_opt{ "additional_info$i" } = $opt{'additional'}->[$i];
2304 $pkg_opt{'additional_count'} = $i if $i > 0;
2308 if ( exists($opt{'classnum'}) and $part_pkg->classnum ne $opt{'classnum'} ) {
2310 $old_classnum = $part_pkg->classnum;
2311 $part_pkg->set('classnum', $opt{'classnum'});
2314 my $error = $part_pkg->replace( options => \%pkg_opt );
2315 return $error if $error;
2317 if (defined $old_classnum) {
2318 # fix invoice grouping records
2319 my $old_catname = $old_classnum
2320 ? FS::pkg_class->by_key($old_classnum)->categoryname
2322 my $new_catname = $opt{'classnum'}
2323 ? $part_pkg->pkg_class->categoryname
2325 if ( $old_catname ne $new_catname ) {
2326 foreach my $cust_bill_pkg ($self->cust_bill_pkg) {
2327 # (there should only be one...)
2328 my @display = qsearch( 'cust_bill_pkg_display', {
2329 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2330 'section' => $old_catname,
2332 foreach (@display) {
2333 $_->set('section', $new_catname);
2334 $error = $_->replace;
2336 $dbh->rollback if $oldAutoCommit;
2340 } # foreach $cust_bill_pkg
2343 if ( $opt{'adjust_commission'} ) {
2344 # fix commission credits...tricky.
2345 foreach my $cust_event ($self->cust_event) {
2346 my $part_event = $cust_event->part_event;
2347 foreach my $table (qw(sales agent)) {
2349 "FS::part_event::Action::Mixin::credit_${table}_pkg_class";
2350 my $credit = qsearchs('cust_credit', {
2351 'eventnum' => $cust_event->eventnum,
2353 if ( $part_event->isa($class) ) {
2354 # Yes, this results in current commission rates being applied
2355 # retroactively to a one-time charge. For accounting purposes
2356 # there ought to be some kind of time limit on doing this.
2357 my $amount = $part_event->_calc_credit($self);
2358 if ( $credit and $credit->amount ne $amount ) {
2359 # Void the old credit.
2360 $error = $credit->void('Package class changed');
2362 $dbh->rollback if $oldAutoCommit;
2363 return "$error (adjusting commission credit)";
2366 # redo the event action to recreate the credit.
2368 eval { $part_event->do_action( $self, $cust_event ) };
2370 $dbh->rollback if $oldAutoCommit;
2373 } # if $part_event->isa($class)
2375 } # foreach $cust_event
2376 } # if $opt{'adjust_commission'}
2377 } # if defined $old_classnum
2379 $dbh->commit if $oldAutoCommit;
2385 use Storable 'thaw';
2388 sub process_bulk_cust_pkg {
2390 my $param = thaw(decode_base64(shift));
2391 warn Dumper($param) if $DEBUG;
2393 my $old_part_pkg = qsearchs('part_pkg',
2394 { pkgpart => $param->{'old_pkgpart'} });
2395 my $new_part_pkg = qsearchs('part_pkg',
2396 { pkgpart => $param->{'new_pkgpart'} });
2397 die "Must select a new package type\n" unless $new_part_pkg;
2398 #my $keep_dates = $param->{'keep_dates'} || 0;
2399 my $keep_dates = 1; # there is no good reason to turn this off
2401 local $SIG{HUP} = 'IGNORE';
2402 local $SIG{INT} = 'IGNORE';
2403 local $SIG{QUIT} = 'IGNORE';
2404 local $SIG{TERM} = 'IGNORE';
2405 local $SIG{TSTP} = 'IGNORE';
2406 local $SIG{PIPE} = 'IGNORE';
2408 my $oldAutoCommit = $FS::UID::AutoCommit;
2409 local $FS::UID::AutoCommit = 0;
2412 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
2415 foreach my $old_cust_pkg ( @cust_pkgs ) {
2417 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
2418 if ( $old_cust_pkg->getfield('cancel') ) {
2419 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
2420 $old_cust_pkg->pkgnum."\n"
2424 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
2426 my $error = $old_cust_pkg->change(
2427 'pkgpart' => $param->{'new_pkgpart'},
2428 'keep_dates' => $keep_dates
2430 if ( !ref($error) ) { # change returns the cust_pkg on success
2432 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
2435 $dbh->commit if $oldAutoCommit;
2441 Returns the last bill date, or if there is no last bill date, the setup date.
2442 Useful for billing metered services.
2448 return $self->setfield('last_bill', $_[0]) if @_;
2449 return $self->getfield('last_bill') if $self->getfield('last_bill');
2450 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
2451 'edate' => $self->bill, } );
2452 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
2455 =item last_cust_pkg_reason ACTION
2457 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
2458 Returns false if there is no reason or the package is not currenly ACTION'd
2459 ACTION is one of adjourn, susp, cancel, or expire.
2463 sub last_cust_pkg_reason {
2464 my ( $self, $action ) = ( shift, shift );
2465 my $date = $self->get($action);
2467 'table' => 'cust_pkg_reason',
2468 'hashref' => { 'pkgnum' => $self->pkgnum,
2469 'action' => substr(uc($action), 0, 1),
2472 'order_by' => 'ORDER BY num DESC LIMIT 1',
2476 =item last_reason ACTION
2478 Returns the most recent ACTION FS::reason associated with the package.
2479 Returns false if there is no reason or the package is not currenly ACTION'd
2480 ACTION is one of adjourn, susp, cancel, or expire.
2485 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
2486 $cust_pkg_reason->reason
2487 if $cust_pkg_reason;
2492 Returns the definition for this billing item, as an FS::part_pkg object (see
2499 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
2500 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
2501 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
2506 Returns the cancelled package this package was changed from, if any.
2512 return '' unless $self->change_pkgnum;
2513 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
2516 =item change_cust_main
2518 Returns the customter this package was detached to, if any.
2522 sub change_cust_main {
2524 return '' unless $self->change_custnum;
2525 qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
2530 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
2537 $self->part_pkg->calc_setup($self, @_);
2542 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
2549 $self->part_pkg->calc_recur($self, @_);
2554 Calls the I<base_setup> of the FS::part_pkg object associated with this billing
2561 $self->part_pkg->base_setup($self, @_);
2566 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
2573 $self->part_pkg->base_recur($self, @_);
2578 Calls the I<calc_remain> of the FS::part_pkg object associated with this
2585 $self->part_pkg->calc_remain($self, @_);
2590 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
2597 $self->part_pkg->calc_cancel($self, @_);
2602 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
2608 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
2611 =item cust_pkg_detail [ DETAILTYPE ]
2613 Returns any customer package details for this package (see
2614 L<FS::cust_pkg_detail>).
2616 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2620 sub cust_pkg_detail {
2622 my %hash = ( 'pkgnum' => $self->pkgnum );
2623 $hash{detailtype} = shift if @_;
2625 'table' => 'cust_pkg_detail',
2626 'hashref' => \%hash,
2627 'order_by' => 'ORDER BY weight, pkgdetailnum',
2631 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
2633 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
2635 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2637 If there is an error, returns the error, otherwise returns false.
2641 sub set_cust_pkg_detail {
2642 my( $self, $detailtype, @details ) = @_;
2644 local $SIG{HUP} = 'IGNORE';
2645 local $SIG{INT} = 'IGNORE';
2646 local $SIG{QUIT} = 'IGNORE';
2647 local $SIG{TERM} = 'IGNORE';
2648 local $SIG{TSTP} = 'IGNORE';
2649 local $SIG{PIPE} = 'IGNORE';
2651 my $oldAutoCommit = $FS::UID::AutoCommit;
2652 local $FS::UID::AutoCommit = 0;
2655 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
2656 my $error = $current->delete;
2658 $dbh->rollback if $oldAutoCommit;
2659 return "error removing old detail: $error";
2663 foreach my $detail ( @details ) {
2664 my $cust_pkg_detail = new FS::cust_pkg_detail {
2665 'pkgnum' => $self->pkgnum,
2666 'detailtype' => $detailtype,
2667 'detail' => $detail,
2669 my $error = $cust_pkg_detail->insert;
2671 $dbh->rollback if $oldAutoCommit;
2672 return "error adding new detail: $error";
2677 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2684 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
2688 #false laziness w/cust_bill.pm
2692 'table' => 'cust_event',
2693 'addl_from' => 'JOIN part_event USING ( eventpart )',
2694 'hashref' => { 'tablenum' => $self->pkgnum },
2695 'extra_sql' => " AND eventtable = 'cust_pkg' ",
2699 =item num_cust_event
2701 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
2705 #false laziness w/cust_bill.pm
2706 sub num_cust_event {
2709 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
2710 " WHERE tablenum = ? AND eventtable = 'cust_pkg'";
2711 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
2712 $sth->execute($self->pkgnum) or die $sth->errstr. " executing $sql";
2713 $sth->fetchrow_arrayref->[0];
2716 =item part_pkg_currency_option OPTIONNAME
2718 Returns a two item list consisting of the currency of this customer, if any,
2719 and a value for the provided option. If the customer has a currency, the value
2720 is the option value the given name and the currency (see
2721 L<FS::part_pkg_currency>). Otherwise, if the customer has no currency, is the
2722 regular option value for the given name (see L<FS::part_pkg_option>).
2726 sub part_pkg_currency_option {
2727 my( $self, $optionname ) = @_;
2728 my $part_pkg = $self->part_pkg;
2729 if ( my $currency = $self->cust_main->currency ) {
2730 ($currency, $part_pkg->part_pkg_currency_option($currency, $optionname) );
2732 ('', $part_pkg->option($optionname) );
2736 =item cust_svc [ SVCPART ] (old, deprecated usage)
2738 =item cust_svc [ OPTION => VALUE ... ] (current usage)
2740 =item cust_svc_unsorted [ OPTION => VALUE ... ]
2742 Returns the services for this package, as FS::cust_svc objects (see
2743 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
2744 spcififed, returns only the matching services.
2746 As an optimization, use the cust_svc_unsorted version if you are not displaying
2753 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
2754 $self->_sort_cust_svc( $self->cust_svc_unsorted_arrayref );
2757 sub cust_svc_unsorted {
2759 @{ $self->cust_svc_unsorted_arrayref };
2762 sub cust_svc_unsorted_arrayref {
2765 return () unless $self->num_cust_svc(@_);
2768 if ( @_ && $_[0] =~ /^\d+/ ) {
2769 $opt{svcpart} = shift;
2770 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2777 'table' => 'cust_svc',
2778 'hashref' => { 'pkgnum' => $self->pkgnum },
2780 if ( $opt{svcpart} ) {
2781 $search{hashref}->{svcpart} = $opt{'svcpart'};
2783 if ( $opt{'svcdb'} ) {
2784 $search{addl_from} = ' LEFT JOIN part_svc USING ( svcpart ) ';
2785 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{'svcdb'} );
2788 [ qsearch(\%search) ];
2792 =item overlimit [ SVCPART ]
2794 Returns the services for this package which have exceeded their
2795 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
2796 is specified, return only the matching services.
2802 return () unless $self->num_cust_svc(@_);
2803 grep { $_->overlimit } $self->cust_svc(@_);
2806 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2808 Returns historical services for this package created before END TIMESTAMP and
2809 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
2810 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
2811 I<pkg_svc.hidden> flag will be omitted.
2817 warn "$me _h_cust_svc called on $self\n"
2820 my ($end, $start, $mode) = @_;
2821 my @cust_svc = $self->_sort_cust_svc(
2822 [ qsearch( 'h_cust_svc',
2823 { 'pkgnum' => $self->pkgnum, },
2824 FS::h_cust_svc->sql_h_search(@_),
2827 if ( defined($mode) && $mode eq 'I' ) {
2828 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
2829 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
2835 sub _sort_cust_svc {
2836 my( $self, $arrayref ) = @_;
2839 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
2841 my %pkg_svc = map { $_->svcpart => $_ }
2842 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
2847 my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
2849 $pkg_svc ? $pkg_svc->primary_svc : '',
2850 $pkg_svc ? $pkg_svc->quantity : 0,
2857 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
2859 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
2861 Returns the number of services for this package. Available options are svcpart
2862 and svcdb. If either is spcififed, returns only the matching services.
2869 return $self->{'_num_cust_svc'}
2871 && exists($self->{'_num_cust_svc'})
2872 && $self->{'_num_cust_svc'} =~ /\d/;
2874 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
2878 if ( @_ && $_[0] =~ /^\d+/ ) {
2879 $opt{svcpart} = shift;
2880 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2886 my $select = 'SELECT COUNT(*) FROM cust_svc ';
2887 my $where = ' WHERE pkgnum = ? ';
2888 my @param = ($self->pkgnum);
2890 if ( $opt{'svcpart'} ) {
2891 $where .= ' AND svcpart = ? ';
2892 push @param, $opt{'svcpart'};
2894 if ( $opt{'svcdb'} ) {
2895 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
2896 $where .= ' AND svcdb = ? ';
2897 push @param, $opt{'svcdb'};
2900 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
2901 $sth->execute(@param) or die $sth->errstr;
2902 $sth->fetchrow_arrayref->[0];
2905 =item available_part_svc
2907 Returns a list of FS::part_svc objects representing services included in this
2908 package but not yet provisioned. Each FS::part_svc object also has an extra
2909 field, I<num_avail>, which specifies the number of available services.
2913 sub available_part_svc {
2916 my $pkg_quantity = $self->quantity || 1;
2918 grep { $_->num_avail > 0 }
2920 my $part_svc = $_->part_svc;
2921 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
2922 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
2924 # more evil encapsulation breakage
2925 if($part_svc->{'Hash'}{'num_avail'} > 0) {
2926 my @exports = $part_svc->part_export_did;
2927 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
2932 $self->part_pkg->pkg_svc;
2935 =item part_svc [ OPTION => VALUE ... ]
2937 Returns a list of FS::part_svc objects representing provisioned and available
2938 services included in this package. Each FS::part_svc object also has the
2939 following extra fields:
2943 =item num_cust_svc (count)
2945 =item num_avail (quantity - count)
2947 =item cust_pkg_svc (services) - array reference containing the provisioned services, as cust_svc objects
2951 Accepts one option: summarize_size. If specified and non-zero, will omit the
2952 extra cust_pkg_svc option for objects where num_cust_svc is this size or
2958 #label -> ($cust_svc->label)[1]
2964 my $pkg_quantity = $self->quantity || 1;
2966 #XXX some sort of sort order besides numeric by svcpart...
2967 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
2969 my $part_svc = $pkg_svc->part_svc;
2970 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
2971 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
2972 $part_svc->{'Hash'}{'num_avail'} =
2973 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
2974 $part_svc->{'Hash'}{'cust_pkg_svc'} =
2975 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
2976 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
2977 && $num_cust_svc >= $opt{summarize_size};
2978 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
2980 } $self->part_pkg->pkg_svc;
2983 push @part_svc, map {
2985 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
2986 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
2987 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
2988 $part_svc->{'Hash'}{'cust_pkg_svc'} =
2989 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
2991 } $self->extra_part_svc;
2997 =item extra_part_svc
2999 Returns a list of FS::part_svc objects corresponding to services in this
3000 package which are still provisioned but not (any longer) available in the
3005 sub extra_part_svc {
3008 my $pkgnum = $self->pkgnum;
3009 #my $pkgpart = $self->pkgpart;
3012 # 'table' => 'part_svc',
3015 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
3016 # WHERE pkg_svc.svcpart = part_svc.svcpart
3017 # AND pkg_svc.pkgpart = ?
3020 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
3021 # LEFT JOIN cust_pkg USING ( pkgnum )
3022 # WHERE cust_svc.svcpart = part_svc.svcpart
3025 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
3028 #seems to benchmark slightly faster... (or did?)
3030 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
3031 my $pkgparts = join(',', @pkgparts);
3034 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
3035 #MySQL doesn't grok DISINCT ON
3036 'select' => 'DISTINCT part_svc.*',
3037 'table' => 'part_svc',
3039 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
3040 AND pkg_svc.pkgpart IN ($pkgparts)
3043 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
3044 LEFT JOIN cust_pkg USING ( pkgnum )
3047 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
3048 'extra_param' => [ [$self->pkgnum=>'int'] ],
3054 Returns a short status string for this package, currently:
3058 =item not yet billed
3060 =item one-time charge
3075 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
3077 return 'cancelled' if $self->get('cancel');
3078 return 'suspended' if $self->susp;
3079 return 'not yet billed' unless $self->setup;
3080 return 'one-time charge' if $freq =~ /^(0|$)/;
3084 =item ucfirst_status
3086 Returns the status with the first character capitalized.
3090 sub ucfirst_status {
3091 ucfirst(shift->status);
3096 Class method that returns the list of possible status strings for packages
3097 (see L<the status method|/status>). For example:
3099 @statuses = FS::cust_pkg->statuses();
3103 tie my %statuscolor, 'Tie::IxHash',
3104 'not yet billed' => '009999', #teal? cyan?
3105 'one-time charge' => '000000',
3106 'active' => '00CC00',
3107 'suspended' => 'FF9900',
3108 'cancelled' => 'FF0000',
3112 my $self = shift; #could be class...
3113 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
3114 # # mayble split btw one-time vs. recur
3120 Returns a hex triplet color string for this package's status.
3126 $statuscolor{$self->status};
3131 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
3132 "pkg - comment" depending on user preference).
3138 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
3139 $label = $self->pkgnum. ": $label"
3140 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
3144 =item pkg_label_long
3146 Returns a long label for this package, adding the primary service's label to
3151 sub pkg_label_long {
3153 my $label = $self->pkg_label;
3154 my $cust_svc = $self->primary_cust_svc;
3155 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
3161 Returns a customer-localized label for this package.
3167 $self->part_pkg->pkg_locale( $self->cust_main->locale );
3170 =item primary_cust_svc
3172 Returns a primary service (as FS::cust_svc object) if one can be identified.
3176 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
3178 sub primary_cust_svc {
3181 my @cust_svc = $self->cust_svc;
3183 return '' unless @cust_svc; #no serivces - irrelevant then
3185 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
3187 # primary service as specified in the package definition
3188 # or exactly one service definition with quantity one
3189 my $svcpart = $self->part_pkg->svcpart;
3190 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
3191 return $cust_svc[0] if scalar(@cust_svc) == 1;
3193 #couldn't identify one thing..
3199 Returns a list of lists, calling the label method for all services
3200 (see L<FS::cust_svc>) of this billing item.
3206 map { [ $_->label ] } $self->cust_svc;
3209 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3211 Like the labels method, but returns historical information on services that
3212 were active as of END_TIMESTAMP and (optionally) not cancelled before
3213 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
3214 I<pkg_svc.hidden> flag will be omitted.
3216 Returns a list of lists, calling the label method for all (historical) services
3217 (see L<FS::h_cust_svc>) of this billing item.
3223 warn "$me _h_labels called on $self\n"
3225 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
3230 Like labels, except returns a simple flat list, and shortens long
3231 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3232 identical services to one line that lists the service label and the number of
3233 individual services rather than individual items.
3238 shift->_labels_short( 'labels', @_ );
3241 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
3243 Like h_labels, except returns a simple flat list, and shortens long
3244 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3245 identical services to one line that lists the service label and the number of
3246 individual services rather than individual items.
3250 sub h_labels_short {
3251 shift->_labels_short( 'h_labels', @_ );
3255 my( $self, $method ) = ( shift, shift );
3257 warn "$me _labels_short called on $self with $method method\n"
3260 my $conf = new FS::Conf;
3261 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
3263 warn "$me _labels_short populating \%labels\n"
3267 #tie %labels, 'Tie::IxHash';
3268 push @{ $labels{$_->[0]} }, $_->[1]
3269 foreach $self->$method(@_);
3271 warn "$me _labels_short populating \@labels\n"
3275 foreach my $label ( keys %labels ) {
3277 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
3278 my $num = scalar(@values);
3279 warn "$me _labels_short $num items for $label\n"
3282 if ( $num > $max_same_services ) {
3283 warn "$me _labels_short more than $max_same_services, so summarizing\n"
3285 push @labels, "$label ($num)";
3287 if ( $conf->exists('cust_bill-consolidate_services') ) {
3288 warn "$me _labels_short consolidating services\n"
3290 # push @labels, "$label: ". join(', ', @values);
3292 my $detail = "$label: ";
3293 $detail .= shift(@values). ', '
3295 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
3297 push @labels, $detail;
3299 warn "$me _labels_short done consolidating services\n"
3302 warn "$me _labels_short adding service data\n"
3304 push @labels, map { "$label: $_" } @values;
3315 Returns the parent customer object (see L<FS::cust_main>).
3321 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
3326 Returns the balance for this specific package, when using
3327 experimental package balance.
3333 $self->cust_main->balance_pkgnum( $self->pkgnum );
3336 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
3340 Returns the location object, if any (see L<FS::cust_location>).
3342 =item cust_location_or_main
3344 If this package is associated with a location, returns the locaiton (see
3345 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
3347 =item location_label [ OPTION => VALUE ... ]
3349 Returns the label of the location object (see L<FS::cust_location>).
3353 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
3355 =item tax_locationnum
3357 Returns the foreign key to a L<FS::cust_location> object for calculating
3358 tax on this package, as determined by the C<tax-pkg_address> and
3359 C<tax-ship_address> configuration flags.
3363 sub tax_locationnum {
3365 my $conf = FS::Conf->new;
3366 if ( $conf->exists('tax-pkg_address') ) {
3367 return $self->locationnum;
3369 elsif ( $conf->exists('tax-ship_address') ) {
3370 return $self->cust_main->ship_locationnum;
3373 return $self->cust_main->bill_locationnum;
3379 Returns the L<FS::cust_location> object for tax_locationnum.
3385 FS::cust_location->by_key( $self->tax_locationnum )
3388 =item seconds_since TIMESTAMP
3390 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
3391 package have been online since TIMESTAMP, according to the session monitor.
3393 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
3394 L<Time::Local> and L<Date::Parse> for conversion functions.
3399 my($self, $since) = @_;
3402 foreach my $cust_svc (
3403 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
3405 $seconds += $cust_svc->seconds_since($since);
3412 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
3414 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
3415 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
3418 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3419 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3425 sub seconds_since_sqlradacct {
3426 my($self, $start, $end) = @_;
3430 foreach my $cust_svc (
3432 my $part_svc = $_->part_svc;
3433 $part_svc->svcdb eq 'svc_acct'
3434 && scalar($part_svc->part_export_usage);
3437 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
3444 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
3446 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
3447 in this package for sessions ending between TIMESTAMP_START (inclusive) and
3451 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3452 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3457 sub attribute_since_sqlradacct {
3458 my($self, $start, $end, $attrib) = @_;
3462 foreach my $cust_svc (
3464 my $part_svc = $_->part_svc;
3465 scalar($part_svc->part_export_usage);
3468 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
3480 my( $self, $value ) = @_;
3481 if ( defined($value) ) {
3482 $self->setfield('quantity', $value);
3484 $self->getfield('quantity') || 1;
3487 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
3489 Transfers as many services as possible from this package to another package.
3491 The destination package can be specified by pkgnum by passing an FS::cust_pkg
3492 object. The destination package must already exist.
3494 Services are moved only if the destination allows services with the correct
3495 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
3496 this option with caution! No provision is made for export differences
3497 between the old and new service definitions. Probably only should be used
3498 when your exports for all service definitions of a given svcdb are identical.
3499 (attempt a transfer without it first, to move all possible svcpart-matching
3502 Any services that can't be moved remain in the original package.
3504 Returns an error, if there is one; otherwise, returns the number of services
3505 that couldn't be moved.
3510 my ($self, $dest_pkgnum, %opt) = @_;
3516 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
3517 $dest = $dest_pkgnum;
3518 $dest_pkgnum = $dest->pkgnum;
3520 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
3523 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
3525 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
3526 $target{$pkg_svc->svcpart} = $pkg_svc->quantity;
3529 foreach my $cust_svc ($dest->cust_svc) {
3530 $target{$cust_svc->svcpart}--;
3533 my %svcpart2svcparts = ();
3534 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3535 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
3536 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
3537 next if exists $svcpart2svcparts{$svcpart};
3538 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
3539 $svcpart2svcparts{$svcpart} = [
3541 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
3543 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
3544 'svcpart' => $_ } );
3546 $pkg_svc ? $pkg_svc->primary_svc : '',
3547 $pkg_svc ? $pkg_svc->quantity : 0,
3551 grep { $_ != $svcpart }
3553 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
3555 warn "alternates for svcpart $svcpart: ".
3556 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
3561 foreach my $cust_svc ($self->cust_svc) {
3562 if($target{$cust_svc->svcpart} > 0
3563 or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
3564 $target{$cust_svc->svcpart}--;
3565 my $new = new FS::cust_svc { $cust_svc->hash };
3566 $new->pkgnum($dest_pkgnum);
3567 my $error = $new->replace($cust_svc);
3568 return $error if $error;
3569 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3571 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
3572 warn "alternates to consider: ".
3573 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
3575 my @alternate = grep {
3576 warn "considering alternate svcpart $_: ".
3577 "$target{$_} available in new package\n"
3580 } @{$svcpart2svcparts{$cust_svc->svcpart}};
3582 warn "alternate(s) found\n" if $DEBUG;
3583 my $change_svcpart = $alternate[0];
3584 $target{$change_svcpart}--;
3585 my $new = new FS::cust_svc { $cust_svc->hash };
3586 $new->svcpart($change_svcpart);
3587 $new->pkgnum($dest_pkgnum);
3588 my $error = $new->replace($cust_svc);
3589 return $error if $error;
3600 =item grab_svcnums SVCNUM, SVCNUM ...
3602 Change the pkgnum for the provided services to this packages. If there is an
3603 error, returns the error, otherwise returns false.
3611 local $SIG{HUP} = 'IGNORE';
3612 local $SIG{INT} = 'IGNORE';
3613 local $SIG{QUIT} = 'IGNORE';
3614 local $SIG{TERM} = 'IGNORE';
3615 local $SIG{TSTP} = 'IGNORE';
3616 local $SIG{PIPE} = 'IGNORE';
3618 my $oldAutoCommit = $FS::UID::AutoCommit;
3619 local $FS::UID::AutoCommit = 0;
3622 foreach my $svcnum (@svcnum) {
3623 my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
3624 $dbh->rollback if $oldAutoCommit;
3625 return "unknown svcnum $svcnum";
3627 $cust_svc->pkgnum( $self->pkgnum );
3628 my $error = $cust_svc->replace;
3630 $dbh->rollback if $oldAutoCommit;
3635 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3642 This method is deprecated. See the I<depend_jobnum> option to the insert and
3643 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
3647 #looks like this is still used by the order_pkg and change_pkg methods in
3648 # ClientAPI/MyAccount, need to look into those before removing
3652 local $SIG{HUP} = 'IGNORE';
3653 local $SIG{INT} = 'IGNORE';
3654 local $SIG{QUIT} = 'IGNORE';
3655 local $SIG{TERM} = 'IGNORE';
3656 local $SIG{TSTP} = 'IGNORE';
3657 local $SIG{PIPE} = 'IGNORE';
3659 my $oldAutoCommit = $FS::UID::AutoCommit;
3660 local $FS::UID::AutoCommit = 0;
3663 foreach my $cust_svc ( $self->cust_svc ) {
3664 #false laziness w/svc_Common::insert
3665 my $svc_x = $cust_svc->svc_x;
3666 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
3667 my $error = $part_export->export_insert($svc_x);
3669 $dbh->rollback if $oldAutoCommit;
3675 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3680 =item export_pkg_change OLD_CUST_PKG
3682 Calls the "pkg_change" export action for all services attached to this package.
3686 sub export_pkg_change {
3687 my( $self, $old ) = ( shift, shift );
3689 local $SIG{HUP} = 'IGNORE';
3690 local $SIG{INT} = 'IGNORE';
3691 local $SIG{QUIT} = 'IGNORE';
3692 local $SIG{TERM} = 'IGNORE';
3693 local $SIG{TSTP} = 'IGNORE';
3694 local $SIG{PIPE} = 'IGNORE';
3696 my $oldAutoCommit = $FS::UID::AutoCommit;
3697 local $FS::UID::AutoCommit = 0;
3700 foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
3701 my $error = $svc_x->export('pkg_change', $self, $old);
3703 $dbh->rollback if $oldAutoCommit;
3708 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3715 Associates this package with a (suspension or cancellation) reason (see
3716 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
3719 Available options are:
3725 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.
3729 the access_user (see L<FS::access_user>) providing the reason
3737 the action (cancel, susp, adjourn, expire) associated with the reason
3741 If there is an error, returns the error, otherwise returns false.
3746 my ($self, %options) = @_;
3748 my $otaker = $options{reason_otaker} ||
3749 $FS::CurrentUser::CurrentUser->username;
3752 if ( $options{'reason'} =~ /^(\d+)$/ ) {
3756 } elsif ( ref($options{'reason'}) ) {
3758 return 'Enter a new reason (or select an existing one)'
3759 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
3761 my $reason = new FS::reason({
3762 'reason_type' => $options{'reason'}->{'typenum'},
3763 'reason' => $options{'reason'}->{'reason'},
3765 my $error = $reason->insert;
3766 return $error if $error;
3768 $reasonnum = $reason->reasonnum;
3771 return "Unparsable reason: ". $options{'reason'};
3774 my $cust_pkg_reason =
3775 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
3776 'reasonnum' => $reasonnum,
3777 'otaker' => $otaker,
3778 'action' => substr(uc($options{'action'}),0,1),
3779 'date' => $options{'date'}
3784 $cust_pkg_reason->insert;
3787 =item insert_discount
3789 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
3790 inserting a new discount on the fly (see L<FS::discount>).
3792 Available options are:
3800 If there is an error, returns the error, otherwise returns false.
3804 sub insert_discount {
3805 #my ($self, %options) = @_;
3808 my $cust_pkg_discount = new FS::cust_pkg_discount {
3809 'pkgnum' => $self->pkgnum,
3810 'discountnum' => $self->discountnum,
3812 'end_date' => '', #XXX
3813 #for the create a new discount case
3814 '_type' => $self->discountnum__type,
3815 'amount' => $self->discountnum_amount,
3816 'percent' => $self->discountnum_percent,
3817 'months' => $self->discountnum_months,
3818 'setup' => $self->discountnum_setup,
3819 #'disabled' => $self->discountnum_disabled,
3822 $cust_pkg_discount->insert;
3825 =item set_usage USAGE_VALUE_HASHREF
3827 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
3828 to which they should be set (see L<FS::svc_acct>). Currently seconds,
3829 upbytes, downbytes, and totalbytes are appropriate keys.
3831 All svc_accts which are part of this package have their values reset.
3836 my ($self, $valueref, %opt) = @_;
3838 #only svc_acct can set_usage for now
3839 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
3840 my $svc_x = $cust_svc->svc_x;
3841 $svc_x->set_usage($valueref, %opt)
3842 if $svc_x->can("set_usage");
3846 =item recharge USAGE_VALUE_HASHREF
3848 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
3849 to which they should be set (see L<FS::svc_acct>). Currently seconds,
3850 upbytes, downbytes, and totalbytes are appropriate keys.
3852 All svc_accts which are part of this package have their values incremented.
3857 my ($self, $valueref) = @_;
3859 #only svc_acct can set_usage for now
3860 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
3861 my $svc_x = $cust_svc->svc_x;
3862 $svc_x->recharge($valueref)
3863 if $svc_x->can("recharge");
3867 =item cust_pkg_discount
3871 sub cust_pkg_discount {
3873 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
3876 =item cust_pkg_discount_active
3880 sub cust_pkg_discount_active {
3882 grep { $_->status eq 'active' } $self->cust_pkg_discount;
3885 =item cust_pkg_usage
3887 Returns a list of all voice usage counters attached to this package.
3891 sub cust_pkg_usage {
3893 qsearch('cust_pkg_usage', { pkgnum => $self->pkgnum });
3896 =item apply_usage OPTIONS
3898 Takes the following options:
3899 - cdr: a call detail record (L<FS::cdr>)
3900 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
3901 - minutes: the maximum number of minutes to be charged
3903 Finds available usage minutes for a call of this class, and subtracts
3904 up to that many minutes from the usage pool. If the usage pool is empty,
3905 and the C<cdr-minutes_priority> global config option is set, minutes may
3906 be taken from other calls as well. Either way, an allocation record will
3907 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
3908 number of minutes of usage applied to the call.
3913 my ($self, %opt) = @_;
3914 my $cdr = $opt{cdr};
3915 my $rate_detail = $opt{rate_detail};
3916 my $minutes = $opt{minutes};
3917 my $classnum = $rate_detail->classnum;
3918 my $pkgnum = $self->pkgnum;
3919 my $custnum = $self->custnum;
3921 local $SIG{HUP} = 'IGNORE';
3922 local $SIG{INT} = 'IGNORE';
3923 local $SIG{QUIT} = 'IGNORE';
3924 local $SIG{TERM} = 'IGNORE';
3925 local $SIG{TSTP} = 'IGNORE';
3926 local $SIG{PIPE} = 'IGNORE';
3928 my $oldAutoCommit = $FS::UID::AutoCommit;
3929 local $FS::UID::AutoCommit = 0;
3931 my $order = FS::Conf->new->config('cdr-minutes_priority');
3935 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
3937 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
3939 my @usage_recs = qsearch({
3940 'table' => 'cust_pkg_usage',
3941 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
3942 ' JOIN cust_pkg USING (pkgnum)'.
3943 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
3944 'select' => 'cust_pkg_usage.*',
3945 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
3946 " ( cust_pkg.custnum = $custnum AND ".
3947 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
3948 $is_classnum . ' AND '.
3949 " cust_pkg_usage.minutes > 0",
3950 'order_by' => " ORDER BY priority ASC",
3953 my $orig_minutes = $minutes;
3955 while (!$error and $minutes > 0 and @usage_recs) {
3956 my $cust_pkg_usage = shift @usage_recs;
3957 $cust_pkg_usage->select_for_update;
3958 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
3959 pkgusagenum => $cust_pkg_usage->pkgusagenum,
3960 acctid => $cdr->acctid,
3961 minutes => min($cust_pkg_usage->minutes, $minutes),
3963 $cust_pkg_usage->set('minutes',
3964 sprintf('%.0f', $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes)
3966 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
3967 $minutes -= $cdr_cust_pkg_usage->minutes;
3969 if ( $order and $minutes > 0 and !$error ) {
3970 # then try to steal minutes from another call
3972 'table' => 'cdr_cust_pkg_usage',
3973 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
3974 ' JOIN part_pkg_usage USING (pkgusagepart)'.
3975 ' JOIN cust_pkg USING (pkgnum)'.
3976 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
3977 ' JOIN cdr USING (acctid)',
3978 'select' => 'cdr_cust_pkg_usage.*',
3979 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
3980 " ( cust_pkg.pkgnum = $pkgnum OR ".
3981 " ( cust_pkg.custnum = $custnum AND ".
3982 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
3983 " part_pkg_usage_class.classnum = $classnum",
3984 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
3986 if ( $order eq 'time' ) {
3987 # find CDRs that are using minutes, but have a later startdate
3989 my $startdate = $cdr->startdate;
3990 if ($startdate !~ /^\d+$/) {
3991 die "bad cdr startdate '$startdate'";
3993 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
3994 # minimize needless reshuffling
3995 $search{'order_by'} .= ', cdr.startdate DESC';
3997 # XXX may not work correctly with rate_time schedules. Could
3998 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
4000 $search{'addl_from'} .=
4001 ' JOIN rate_detail'.
4002 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
4003 if ( $order eq 'rate_high' ) {
4004 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
4005 $rate_detail->min_charge;
4006 $search{'order_by'} .= ', rate_detail.min_charge ASC';
4007 } elsif ( $order eq 'rate_low' ) {
4008 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
4009 $rate_detail->min_charge;
4010 $search{'order_by'} .= ', rate_detail.min_charge DESC';
4012 # this should really never happen
4013 die "invalid cdr-minutes_priority value '$order'\n";
4016 my @cdr_usage_recs = qsearch(\%search);
4018 while (!$error and @cdr_usage_recs and $minutes > 0) {
4019 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
4020 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
4021 my $old_cdr = $cdr_cust_pkg_usage->cdr;
4022 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
4023 $cdr_cust_pkg_usage->select_for_update;
4024 $old_cdr->select_for_update;
4025 $cust_pkg_usage->select_for_update;
4026 # in case someone else stole the usage from this CDR
4027 # while waiting for the lock...
4028 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
4029 # steal the usage allocation and flag the old CDR for reprocessing
4030 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
4031 # if the allocation is more minutes than we need, adjust it...
4032 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
4034 $cdr_cust_pkg_usage->set('minutes', $minutes);
4035 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
4036 $error = $cust_pkg_usage->replace;
4038 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
4039 $error ||= $cdr_cust_pkg_usage->replace;
4040 # deduct the stolen minutes
4041 $minutes -= $cdr_cust_pkg_usage->minutes;
4043 # after all minute-stealing is done, reset the affected CDRs
4044 foreach (values %reproc_cdrs) {
4045 $error ||= $_->set_status('');
4046 # XXX or should we just call $cdr->rate right here?
4047 # it's not like we can create a loop this way, since the min_charge
4048 # or call time has to go monotonically in one direction.
4049 # we COULD get some very deep recursions going, though...
4051 } # if $order and $minutes
4054 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
4056 $dbh->commit if $oldAutoCommit;
4057 return $orig_minutes - $minutes;
4061 =item supplemental_pkgs
4063 Returns a list of all packages supplemental to this one.
4067 sub supplemental_pkgs {
4069 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
4074 Returns the package that this one is supplemental to, if any.
4080 if ( $self->main_pkgnum ) {
4081 return FS::cust_pkg->by_key($self->main_pkgnum);
4088 =head1 CLASS METHODS
4094 Returns an SQL expression identifying recurring packages.
4098 sub recurring_sql { "
4099 '0' != ( select freq from part_pkg
4100 where cust_pkg.pkgpart = part_pkg.pkgpart )
4105 Returns an SQL expression identifying one-time packages.
4110 '0' = ( select freq from part_pkg
4111 where cust_pkg.pkgpart = part_pkg.pkgpart )
4116 Returns an SQL expression identifying ordered packages (recurring packages not
4122 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
4127 Returns an SQL expression identifying active packages.
4132 $_[0]->recurring_sql. "
4133 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4134 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4135 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4138 =item not_yet_billed_sql
4140 Returns an SQL expression identifying packages which have not yet been billed.
4144 sub not_yet_billed_sql { "
4145 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4146 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4147 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4152 Returns an SQL expression identifying inactive packages (one-time packages
4153 that are otherwise unsuspended/uncancelled).
4157 sub inactive_sql { "
4158 ". $_[0]->onetime_sql(). "
4159 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4160 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4161 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4167 Returns an SQL expression identifying suspended packages.
4171 sub suspended_sql { susp_sql(@_); }
4173 #$_[0]->recurring_sql(). ' AND '.
4175 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4176 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4183 Returns an SQL exprression identifying cancelled packages.
4187 sub cancelled_sql { cancel_sql(@_); }
4189 #$_[0]->recurring_sql(). ' AND '.
4190 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
4195 Returns an SQL expression to give the package status as a string.
4201 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
4202 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
4203 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
4204 WHEN ".onetime_sql()." THEN 'one-time charge'
4209 =item search HASHREF
4213 Returns a qsearch hash expression to search for parameters specified in HASHREF.
4214 Valid parameters are
4222 active, inactive, suspended, cancel (or cancelled)
4226 active, inactive, suspended, one-time charge, inactive, cancel (or cancelled)
4230 boolean selects custom packages
4236 pkgpart or arrayref or hashref of pkgparts
4240 arrayref of beginning and ending epoch date
4244 arrayref of beginning and ending epoch date
4248 arrayref of beginning and ending epoch date
4252 arrayref of beginning and ending epoch date
4256 arrayref of beginning and ending epoch date
4260 arrayref of beginning and ending epoch date
4264 arrayref of beginning and ending epoch date
4268 pkgnum or APKG_pkgnum
4272 a value suited to passing to FS::UI::Web::cust_header
4276 specifies the user for agent virtualization
4280 boolean; if true, returns only packages with more than 0 FCC phone lines.
4282 =item state, country
4284 Limit to packages with a service location in the specified state and country.
4285 For FCC 477 reporting, mostly.
4289 Limit to packages whose service locations are the same as the customer's
4290 default service location.
4292 =item location_nocust
4294 Limit to packages whose service locations are not the customer's default
4297 =item location_census
4299 Limit to packages whose service locations have census tracts.
4301 =item location_nocensus
4303 Limit to packages whose service locations do not have a census tract.
4305 =item location_geocode
4307 Limit to packages whose locations have geocodes.
4309 =item location_geocode
4311 Limit to packages whose locations do not have geocodes.
4318 my ($class, $params) = @_;
4325 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
4327 "cust_main.agentnum = $1";
4334 if ( $params->{'cust_status'} =~ /^([a-z]+)$/ ) {
4335 push @where, FS::cust_main->cust_status_sql . " = '$1' ";
4339 # parse customer sales person
4342 if ( $params->{'cust_main_salesnum'} =~ /^(\d+)$/ ) {
4343 push @where, ($1 > 0) ? "cust_main.salesnum = $1"
4344 : 'cust_main.salesnum IS NULL';
4349 # parse sales person
4352 if ( $params->{'salesnum'} =~ /^(\d+)$/ ) {
4353 push @where, ($1 > 0) ? "cust_pkg.salesnum = $1"
4354 : 'cust_pkg.salesnum IS NULL';
4361 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
4363 "cust_pkg.custnum = $1";
4370 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
4372 "cust_pkg.pkgbatch = '$1'";
4379 if ( $params->{'magic'} eq 'active'
4380 || $params->{'status'} eq 'active' ) {
4382 push @where, FS::cust_pkg->active_sql();
4384 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
4385 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
4387 push @where, FS::cust_pkg->not_yet_billed_sql();
4389 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
4390 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
4392 push @where, FS::cust_pkg->inactive_sql();
4394 } elsif ( $params->{'magic'} eq 'suspended'
4395 || $params->{'status'} eq 'suspended' ) {
4397 push @where, FS::cust_pkg->suspended_sql();
4399 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
4400 || $params->{'status'} =~ /^cancell?ed$/ ) {
4402 push @where, FS::cust_pkg->cancelled_sql();
4407 # parse package class
4410 if ( exists($params->{'classnum'}) ) {
4413 if ( ref($params->{'classnum'}) ) {
4415 if ( ref($params->{'classnum'}) eq 'HASH' ) {
4416 @classnum = grep $params->{'classnum'}{$_}, keys %{ $params->{'classnum'} };
4417 } elsif ( ref($params->{'classnum'}) eq 'ARRAY' ) {
4418 @classnum = @{ $params->{'classnum'} };
4420 die 'unhandled classnum ref '. $params->{'classnum'};
4424 } elsif ( $params->{'classnum'} =~ /^(\d*)$/ && $1 ne '0' ) {
4431 my @nums = grep $_, @classnum;
4432 push @c_where, 'part_pkg.classnum IN ('. join(',',@nums). ')' if @nums;
4433 my $null = scalar( grep { $_ eq '' } @classnum );
4434 push @c_where, 'part_pkg.classnum IS NULL' if $null;
4436 if ( scalar(@c_where) == 1 ) {
4437 push @where, @c_where;
4438 } elsif ( @c_where ) {
4439 push @where, ' ( '. join(' OR ', @c_where). ' ) ';
4448 # parse package report options
4451 my @report_option = ();
4452 if ( exists($params->{'report_option'}) ) {
4453 if ( ref($params->{'report_option'}) eq 'ARRAY' ) {
4454 @report_option = @{ $params->{'report_option'} };
4455 } elsif ( $params->{'report_option'} =~ /^([,\d]*)$/ ) {
4456 @report_option = split(',', $1);
4461 if (@report_option) {
4462 # this will result in the empty set for the dangling comma case as it should
4464 map{ "0 < ( SELECT count(*) FROM part_pkg_option
4465 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
4466 AND optionname = 'report_option_$_'
4467 AND optionvalue = '1' )"
4471 foreach my $any ( grep /^report_option_any/, keys %$params ) {
4473 my @report_option_any = ();
4474 if ( ref($params->{$any}) eq 'ARRAY' ) {
4475 @report_option_any = @{ $params->{$any} };
4476 } elsif ( $params->{$any} =~ /^([,\d]*)$/ ) {
4477 @report_option_any = split(',', $1);
4480 if (@report_option_any) {
4481 # this will result in the empty set for the dangling comma case as it should
4482 push @where, ' ( '. join(' OR ',
4483 map{ "0 < ( SELECT count(*) FROM part_pkg_option
4484 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
4485 AND optionname = 'report_option_$_'
4486 AND optionvalue = '1' )"
4487 } @report_option_any
4497 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
4503 push @where, "(part_pkg.fcc_ds0s > 0 OR pkg_class.fcc_ds0s > 0)"
4504 if $params->{fcc_line};
4510 if ( exists($params->{'censustract'}) ) {
4511 $params->{'censustract'} =~ /^([.\d]*)$/;
4512 my $censustract = "cust_location.censustract = '$1'";
4513 $censustract .= ' OR cust_location.censustract is NULL' unless $1;
4514 push @where, "( $censustract )";
4518 # parse censustract2
4520 if ( exists($params->{'censustract2'})
4521 && $params->{'censustract2'} =~ /^(\d*)$/
4525 push @where, "cust_location.censustract LIKE '$1%'";
4528 "( cust_location.censustract = '' OR cust_location.censustract IS NULL )";
4533 # parse country/state
4535 for (qw(state country)) { # parsing rules are the same for these
4536 if ( exists($params->{$_})
4537 && uc($params->{$_}) =~ /^([A-Z]{2})$/ )
4539 # XXX post-2.3 only--before that, state/country may be in cust_main
4540 push @where, "cust_location.$_ = '$1'";
4547 if ( $params->{location_cust} xor $params->{location_nocust} ) {
4548 my $op = $params->{location_cust} ? '=' : '!=';
4549 push @where, "cust_location.locationnum $op cust_main.ship_locationnum";
4551 if ( $params->{location_census} xor $params->{location_nocensus} ) {
4552 my $op = $params->{location_census} ? "IS NOT NULL" : "IS NULL";
4553 push @where, "cust_location.censustract $op";
4555 if ( $params->{location_geocode} xor $params->{location_nogeocode} ) {
4556 my $op = $params->{location_geocode} ? "IS NOT NULL" : "IS NULL";
4557 push @where, "cust_location.geocode $op";
4564 if ( ref($params->{'pkgpart'}) ) {
4567 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
4568 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
4569 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
4570 @pkgpart = @{ $params->{'pkgpart'} };
4572 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
4575 @pkgpart = grep /^(\d+)$/, @pkgpart;
4577 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
4579 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
4580 push @where, "pkgpart = $1";
4589 #false laziness w/report_cust_pkg.html
4592 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
4593 'active' => { 'susp'=>1, 'cancel'=>1 },
4594 'suspended' => { 'cancel' => 1 },
4599 if( exists($params->{'active'} ) ) {
4600 # This overrides all the other date-related fields
4601 my($beginning, $ending) = @{$params->{'active'}};
4603 "cust_pkg.setup IS NOT NULL",
4604 "cust_pkg.setup <= $ending",
4605 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
4606 "NOT (".FS::cust_pkg->onetime_sql . ")";
4609 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end change_date cancel )) {
4611 next unless exists($params->{$field});
4613 my($beginning, $ending) = @{$params->{$field}};
4615 next if $beginning == 0 && $ending == 4294967295;
4618 "cust_pkg.$field IS NOT NULL",
4619 "cust_pkg.$field >= $beginning",
4620 "cust_pkg.$field <= $ending";
4622 $orderby ||= "ORDER BY cust_pkg.$field";
4627 $orderby ||= 'ORDER BY bill';
4630 # parse magic, legacy, etc.
4633 if ( $params->{'magic'} &&
4634 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
4637 $orderby = 'ORDER BY pkgnum';
4639 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
4640 push @where, "pkgpart = $1";
4643 } elsif ( $params->{'query'} eq 'pkgnum' ) {
4645 $orderby = 'ORDER BY pkgnum';
4647 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
4649 $orderby = 'ORDER BY pkgnum';
4652 SELECT count(*) FROM pkg_svc
4653 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
4654 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
4655 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
4656 AND cust_svc.svcpart = pkg_svc.svcpart
4663 # setup queries, links, subs, etc. for the search
4666 # here is the agent virtualization
4667 if ($params->{CurrentUser}) {
4669 qsearchs('access_user', { username => $params->{CurrentUser} });
4672 push @where, $access_user->agentnums_sql('table'=>'cust_main');
4677 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
4680 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
4682 my $addl_from = 'LEFT JOIN part_pkg USING ( pkgpart ) '.
4683 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) '.
4684 'LEFT JOIN cust_location USING ( locationnum ) '.
4685 FS::UI::Web::join_cust_main('cust_pkg', 'cust_pkg');
4689 if ( $params->{'select_zip5'} ) {
4690 my $zip = 'cust_location.zip';
4692 $select = "DISTINCT substr($zip,1,5) as zip";
4693 $orderby = "ORDER BY substr($zip,1,5)";
4694 $count_query = "SELECT COUNT( DISTINCT substr($zip,1,5) )";
4696 $select = join(', ',
4698 ( map "part_pkg.$_", qw( pkg freq ) ),
4699 'pkg_class.classname',
4700 'cust_main.custnum AS cust_main_custnum',
4701 FS::UI::Web::cust_sql_fields(
4702 $params->{'cust_fields'}
4705 $count_query = 'SELECT COUNT(*)';
4708 $count_query .= " FROM cust_pkg $addl_from $extra_sql";
4711 'table' => 'cust_pkg',
4713 'select' => $select,
4714 'extra_sql' => $extra_sql,
4715 'order_by' => $orderby,
4716 'addl_from' => $addl_from,
4717 'count_query' => $count_query,
4724 Returns a list of two package counts. The first is a count of packages
4725 based on the supplied criteria and the second is the count of residential
4726 packages with those same criteria. Criteria are specified as in the search
4732 my ($class, $params) = @_;
4734 my $sql_query = $class->search( $params );
4736 my $count_sql = delete($sql_query->{'count_query'});
4737 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
4738 or die "couldn't parse count_sql";
4740 my $count_sth = dbh->prepare($count_sql)
4741 or die "Error preparing $count_sql: ". dbh->errstr;
4743 or die "Error executing $count_sql: ". $count_sth->errstr;
4744 my $count_arrayref = $count_sth->fetchrow_arrayref;
4746 return ( @$count_arrayref );
4750 =item tax_locationnum_sql
4752 Returns an SQL expression for the tax location for a package, based
4753 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
4757 sub tax_locationnum_sql {
4758 my $conf = FS::Conf->new;
4759 if ( $conf->exists('tax-pkg_address') ) {
4760 'cust_pkg.locationnum';
4762 elsif ( $conf->exists('tax-ship_address') ) {
4763 'cust_main.ship_locationnum';
4766 'cust_main.bill_locationnum';
4772 Returns a list: the first item is an SQL fragment identifying matching
4773 packages/customers via location (taking into account shipping and package
4774 address taxation, if enabled), and subsequent items are the parameters to
4775 substitute for the placeholders in that fragment.
4780 my($class, %opt) = @_;
4781 my $ornull = $opt{'ornull'};
4783 my $conf = new FS::Conf;
4785 # '?' placeholders in _location_sql_where
4786 my $x = $ornull ? 3 : 2;
4797 if ( $conf->exists('tax-ship_address') ) {
4800 ( ( ship_last IS NULL OR ship_last = '' )
4801 AND ". _location_sql_where('cust_main', '', $ornull ). "
4803 OR ( ship_last IS NOT NULL AND ship_last != ''
4804 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
4807 # AND payby != 'COMP'
4809 @main_param = ( @bill_param, @bill_param );
4813 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
4814 @main_param = @bill_param;
4820 if ( $conf->exists('tax-pkg_address') ) {
4822 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
4825 ( cust_pkg.locationnum IS NULL AND $main_where )
4826 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
4829 @param = ( @main_param, @bill_param );
4833 $where = $main_where;
4834 @param = @main_param;
4842 #subroutine, helper for location_sql
4843 sub _location_sql_where {
4845 my $prefix = @_ ? shift : '';
4846 my $ornull = @_ ? shift : '';
4848 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
4850 $ornull = $ornull ? ' OR ? IS NULL ' : '';
4852 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
4853 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
4854 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
4856 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
4858 # ( $table.${prefix}city = ? $or_empty_city $ornull )
4860 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4861 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4862 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
4863 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
4864 AND $table.${prefix}country = ?
4869 my( $self, $what ) = @_;
4871 my $what_show_zero = $what. '_show_zero';
4872 length($self->$what_show_zero())
4873 ? ($self->$what_show_zero() eq 'Y')
4874 : $self->part_pkg->$what_show_zero();
4881 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
4883 CUSTNUM is a customer (see L<FS::cust_main>)
4885 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4886 L<FS::part_pkg>) to order for this customer. Duplicates are of course
4889 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
4890 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
4891 new billing items. An error is returned if this is not possible (see
4892 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
4895 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4896 newly-created cust_pkg objects.
4898 REFNUM, if specified, will specify the FS::pkg_referral record to be created
4899 and inserted. Multiple FS::pkg_referral records can be created by
4900 setting I<refnum> to an array reference of refnums or a hash reference with
4901 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
4902 record will be created corresponding to cust_main.refnum.
4907 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
4909 my $conf = new FS::Conf;
4911 # Transactionize this whole mess
4912 local $SIG{HUP} = 'IGNORE';
4913 local $SIG{INT} = 'IGNORE';
4914 local $SIG{QUIT} = 'IGNORE';
4915 local $SIG{TERM} = 'IGNORE';
4916 local $SIG{TSTP} = 'IGNORE';
4917 local $SIG{PIPE} = 'IGNORE';
4919 my $oldAutoCommit = $FS::UID::AutoCommit;
4920 local $FS::UID::AutoCommit = 0;
4924 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
4925 # return "Customer not found: $custnum" unless $cust_main;
4927 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
4930 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4933 my $change = scalar(@old_cust_pkg) != 0;
4936 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
4938 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
4939 " to pkgpart ". $pkgparts->[0]. "\n"
4942 my $err_or_cust_pkg =
4943 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
4944 'refnum' => $refnum,
4947 unless (ref($err_or_cust_pkg)) {
4948 $dbh->rollback if $oldAutoCommit;
4949 return $err_or_cust_pkg;
4952 push @$return_cust_pkg, $err_or_cust_pkg;
4953 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4958 # Create the new packages.
4959 foreach my $pkgpart (@$pkgparts) {
4961 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
4963 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
4964 pkgpart => $pkgpart,
4968 $error = $cust_pkg->insert( 'change' => $change );
4969 push @$return_cust_pkg, $cust_pkg;
4971 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
4972 my $supp_pkg = FS::cust_pkg->new({
4973 custnum => $custnum,
4974 pkgpart => $link->dst_pkgpart,
4976 main_pkgnum => $cust_pkg->pkgnum,
4979 $error ||= $supp_pkg->insert( 'change' => $change );
4980 push @$return_cust_pkg, $supp_pkg;
4984 $dbh->rollback if $oldAutoCommit;
4989 # $return_cust_pkg now contains refs to all of the newly
4992 # Transfer services and cancel old packages.
4993 foreach my $old_pkg (@old_cust_pkg) {
4995 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
4998 foreach my $new_pkg (@$return_cust_pkg) {
4999 $error = $old_pkg->transfer($new_pkg);
5000 if ($error and $error == 0) {
5001 # $old_pkg->transfer failed.
5002 $dbh->rollback if $oldAutoCommit;
5007 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
5008 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
5009 foreach my $new_pkg (@$return_cust_pkg) {
5010 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
5011 if ($error and $error == 0) {
5012 # $old_pkg->transfer failed.
5013 $dbh->rollback if $oldAutoCommit;
5020 # Transfers were successful, but we went through all of the
5021 # new packages and still had services left on the old package.
5022 # We can't cancel the package under the circumstances, so abort.
5023 $dbh->rollback if $oldAutoCommit;
5024 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
5026 $error = $old_pkg->cancel( quiet=>1 );
5032 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5036 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
5038 A bulk change method to change packages for multiple customers.
5040 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5041 L<FS::part_pkg>) to order for each customer. Duplicates are of course
5044 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
5045 replace. The services (see L<FS::cust_svc>) are moved to the
5046 new billing items. An error is returned if this is not possible (see
5049 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5050 newly-created cust_pkg objects.
5055 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
5057 # Transactionize this whole mess
5058 local $SIG{HUP} = 'IGNORE';
5059 local $SIG{INT} = 'IGNORE';
5060 local $SIG{QUIT} = 'IGNORE';
5061 local $SIG{TERM} = 'IGNORE';
5062 local $SIG{TSTP} = 'IGNORE';
5063 local $SIG{PIPE} = 'IGNORE';
5065 my $oldAutoCommit = $FS::UID::AutoCommit;
5066 local $FS::UID::AutoCommit = 0;
5070 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5073 while(scalar(@old_cust_pkg)) {
5075 my $custnum = $old_cust_pkg[0]->custnum;
5076 my (@remove) = map { $_->pkgnum }
5077 grep { $_->custnum == $custnum } @old_cust_pkg;
5078 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
5080 my $error = order $custnum, $pkgparts, \@remove, \@return;
5082 push @errors, $error
5084 push @$return_cust_pkg, @return;
5087 if (scalar(@errors)) {
5088 $dbh->rollback if $oldAutoCommit;
5089 return join(' / ', @errors);
5092 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5096 # Used by FS::Upgrade to migrate to a new database.
5097 sub _upgrade_data { # class method
5098 my ($class, %opts) = @_;
5099 $class->_upgrade_otaker(%opts);
5101 # RT#10139, bug resulting in contract_end being set when it shouldn't
5102 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
5103 # RT#10830, bad calculation of prorate date near end of year
5104 # the date range for bill is December 2009, and we move it forward
5105 # one year if it's before the previous bill date (which it should
5107 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
5108 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
5109 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
5110 # RT6628, add order_date to cust_pkg
5111 'update cust_pkg set order_date = (select history_date from h_cust_pkg
5112 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
5113 history_action = \'insert\') where order_date is null',
5115 foreach my $sql (@statements) {
5116 my $sth = dbh->prepare($sql);
5117 $sth->execute or die $sth->errstr;
5125 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
5127 In sub order, the @pkgparts array (passed by reference) is clobbered.
5129 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
5130 method to pass dates to the recur_prog expression, it should do so.
5132 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
5133 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
5134 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
5135 configuration values. Probably need a subroutine which decides what to do
5136 based on whether or not we've fetched the user yet, rather than a hash. See
5137 FS::UID and the TODO.
5139 Now that things are transactional should the check in the insert method be
5144 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
5145 L<FS::pkg_svc>, schema.html from the base documentation