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( getotaker dbh driver_name );
15 use FS::Misc qw( send_email );
16 use FS::Record qw( qsearch qsearchs fields );
22 use FS::cust_location;
24 use FS::cust_bill_pkg;
25 use FS::cust_pkg_detail;
26 use FS::cust_pkg_usage;
27 use FS::cdr_cust_pkg_usage;
32 use FS::cust_pkg_reason;
34 use FS::cust_pkg_discount;
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 #bulk cancel+order... perhaps slightly deprecated, only used by the bulk
112 # cancel+order in the web UI and nowhere else (edit/process/cust_pkg.cgi)
113 $error = FS::cust_pkg::order( $custnum, \@pkgparts );
114 $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );
118 An FS::cust_pkg object represents a customer billing item. FS::cust_pkg
119 inherits from FS::Record. The following fields are currently supported:
125 Primary key (assigned automatically for new billing items)
129 Customer (see L<FS::cust_main>)
133 Billing item definition (see L<FS::part_pkg>)
137 Optional link to package location (see L<FS::location>)
141 date package was ordered (also remains same on changes)
153 date (next bill date)
181 order taker (see L<FS::access_user>)
185 If this field is set to 1, disables the automatic
186 unsuspension of this package when using the B<unsuspendauto> config option.
190 If not set, defaults to 1
194 Date of change from previous package
204 =item change_locationnum
212 The pkgnum of the package that this package is supplemental to, if any.
216 The package link (L<FS::part_pkg_link>) that defines this supplemental
217 package, if it is one.
219 =item change_to_pkgnum
221 The pkgnum of the package this one will be "changed to" in the future
222 (on its expiration date).
226 Note: setup, last_bill, bill, adjourn, susp, expire, cancel and change_date
227 are specified as UNIX timestamps; see L<perlfunc/"time">. Also see
228 L<Time::Local> and L<Date::Parse> for conversion functions.
236 Create a new billing item. To add the item to the database, see L<"insert">.
240 sub table { 'cust_pkg'; }
241 sub cust_linked { $_[0]->cust_main_custnum || $_[0]->custnum }
242 sub cust_unlinked_msg {
244 "WARNING: can't find cust_main.custnum ". $self->custnum.
245 ' (cust_pkg.pkgnum '. $self->pkgnum. ')';
248 =item set_initial_timers
250 If required by the package definition, sets any automatic expire, adjourn,
251 or contract_end timers to some number of months after the start date
252 (or setup date, if the package has already been setup). If the package has
253 a delayed setup fee after a period of "free days", will also set the
254 start date to the end of that period.
258 sub set_initial_timers {
260 my $part_pkg = $self->part_pkg;
261 foreach my $action ( qw(expire adjourn contract_end) ) {
262 my $months = $part_pkg->option("${action}_months",1);
263 if($months and !$self->get($action)) {
264 my $start = $self->start_date || $self->setup || time;
265 $self->set($action, $part_pkg->add_freq($start, $months) );
269 # if this package has "free days" and delayed setup fee, then
270 # set start date that many days in the future.
271 # (this should have been set in the UI, but enforce it here)
272 if ( $part_pkg->option('free_days',1)
273 && $part_pkg->option('delay_setup',1)
276 $self->start_date( $part_pkg->default_start_date );
281 =item insert [ OPTION => VALUE ... ]
283 Adds this billing item to the database ("Orders" the item). If there is an
284 error, returns the error, otherwise returns false.
286 If the additional field I<promo_code> is defined instead of I<pkgpart>, it
287 will be used to look up the package definition and agent restrictions will be
290 If the additional field I<refnum> is defined, an FS::pkg_referral record will
291 be created and inserted. Multiple FS::pkg_referral records can be created by
292 setting I<refnum> to an array reference of refnums or a hash reference with
293 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
294 record will be created corresponding to cust_main.refnum.
296 The following options are available:
302 If set true, supresses actions that should only be taken for new package
303 orders. (Currently this includes: intro periods when delay_setup is on,
304 auto-adding a 1st start date, auto-adding expiration/adjourn/contract_end dates)
308 cust_pkg_option records will be created
312 a ticket will be added to this customer with this subject
316 an optional queue name for ticket additions
320 Don't check the legality of the package definition. This should be used
321 when performing a package change that doesn't change the pkgpart (i.e.
329 my( $self, %options ) = @_;
332 $error = $self->check_pkgpart unless $options{'allow_pkgpart'};
333 return $error if $error;
335 my $part_pkg = $self->part_pkg;
337 if ( ! $options{'change'} ) {
339 # set order date to now
340 $self->order_date(time);
342 # if the package def says to start only on the first of the month:
343 if ( $part_pkg->option('start_1st', 1) && !$self->start_date ) {
344 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime(time) )[0,1,2,3,4,5];
345 $mon += 1 unless $mday == 1;
346 until ( $mon < 12 ) { $mon -= 12; $year++; }
347 $self->start_date( timelocal_nocheck(0,0,0,1,$mon,$year) );
350 if ($self->susp eq 'now' or $part_pkg->start_on_hold) {
351 # if the package was ordered on hold:
353 # - don't set the start date (it will be started manually)
354 $self->set('susp', $self->order_date);
355 $self->set('start_date', '');
357 # set expire/adjourn/contract_end timers, and free days, if appropriate
358 $self->set_initial_timers;
360 } # else this is a package change, and shouldn't have "new package" behavior
362 local $SIG{HUP} = 'IGNORE';
363 local $SIG{INT} = 'IGNORE';
364 local $SIG{QUIT} = 'IGNORE';
365 local $SIG{TERM} = 'IGNORE';
366 local $SIG{TSTP} = 'IGNORE';
367 local $SIG{PIPE} = 'IGNORE';
369 my $oldAutoCommit = $FS::UID::AutoCommit;
370 local $FS::UID::AutoCommit = 0;
373 $error = $self->SUPER::insert($options{options} ? %{$options{options}} : ());
375 $dbh->rollback if $oldAutoCommit;
379 $self->refnum($self->cust_main->refnum) unless $self->refnum;
380 $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
381 $self->process_m2m( 'link_table' => 'pkg_referral',
382 'target_table' => 'part_referral',
383 'params' => $self->refnum,
386 if ( $self->discountnum ) {
387 my $error = $self->insert_discount();
389 $dbh->rollback if $oldAutoCommit;
394 my $conf = new FS::Conf;
396 if ( $conf->config('ticket_system') && $options{ticket_subject} ) {
398 #this init stuff is still inefficient, but at least its limited to
399 # the small number (any?) folks using ticket emailing on pkg order
402 # use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
409 use FS::TicketSystem;
410 FS::TicketSystem->init();
412 my $q = new RT::Queue($RT::SystemUser);
413 $q->Load($options{ticket_queue}) if $options{ticket_queue};
414 my $t = new RT::Ticket($RT::SystemUser);
415 my $mime = new MIME::Entity;
416 $mime->build( Type => 'text/plain', Data => $options{ticket_subject} );
417 $t->Create( $options{ticket_queue} ? (Queue => $q) : (),
418 Subject => $options{ticket_subject},
421 $t->AddLink( Type => 'MemberOf',
422 Target => 'freeside://freeside/cust_main/'. $self->custnum,
426 if ($conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
427 my $queue = new FS::queue {
428 'job' => 'FS::cust_main::queueable_print',
430 $error = $queue->insert(
431 'custnum' => $self->custnum,
432 'template' => 'welcome_letter',
436 warn "can't send welcome letter: $error";
441 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
448 This method now works but you probably shouldn't use it.
450 You don't want to delete packages, because there would then be no record
451 the customer ever purchased the package. Instead, see the cancel method and
452 hide cancelled packages.
459 local $SIG{HUP} = 'IGNORE';
460 local $SIG{INT} = 'IGNORE';
461 local $SIG{QUIT} = 'IGNORE';
462 local $SIG{TERM} = 'IGNORE';
463 local $SIG{TSTP} = 'IGNORE';
464 local $SIG{PIPE} = 'IGNORE';
466 my $oldAutoCommit = $FS::UID::AutoCommit;
467 local $FS::UID::AutoCommit = 0;
470 foreach my $cust_pkg_discount ($self->cust_pkg_discount) {
471 my $error = $cust_pkg_discount->delete;
473 $dbh->rollback if $oldAutoCommit;
477 #cust_bill_pkg_discount?
479 foreach my $cust_pkg_detail ($self->cust_pkg_detail) {
480 my $error = $cust_pkg_detail->delete;
482 $dbh->rollback if $oldAutoCommit;
487 foreach my $cust_pkg_reason (
489 'table' => 'cust_pkg_reason',
490 'hashref' => { 'pkgnum' => $self->pkgnum },
494 my $error = $cust_pkg_reason->delete;
496 $dbh->rollback if $oldAutoCommit;
503 my $error = $self->SUPER::delete(@_);
505 $dbh->rollback if $oldAutoCommit;
509 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
515 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
517 Replaces the OLD_RECORD with this one in the database. If there is an error,
518 returns the error, otherwise returns false.
520 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
522 Changing pkgpart may have disasterous effects. See the order subroutine.
524 setup and bill are normally updated by calling the bill method of a customer
525 object (see L<FS::cust_main>).
527 suspend is normally updated by the suspend and unsuspend methods.
529 cancel is normally updated by the cancel method (and also the order subroutine
532 Available options are:
538 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.
542 the access_user (see L<FS::access_user>) providing the reason
546 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
555 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
560 ( ref($_[0]) eq 'HASH' )
564 #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
565 #return "Can't change otaker!" if $old->otaker ne $new->otaker;
568 #return "Can't change setup once it exists!"
569 # if $old->getfield('setup') &&
570 # $old->getfield('setup') != $new->getfield('setup');
572 #some logic for bill, susp, cancel?
574 local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
576 local $SIG{HUP} = 'IGNORE';
577 local $SIG{INT} = 'IGNORE';
578 local $SIG{QUIT} = 'IGNORE';
579 local $SIG{TERM} = 'IGNORE';
580 local $SIG{TSTP} = 'IGNORE';
581 local $SIG{PIPE} = 'IGNORE';
583 my $oldAutoCommit = $FS::UID::AutoCommit;
584 local $FS::UID::AutoCommit = 0;
587 foreach my $method ( qw(adjourn expire) ) { # How many reasons?
588 if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
589 my $error = $new->insert_reason(
590 'reason' => $options->{'reason'},
591 'date' => $new->$method,
593 'reason_otaker' => $options->{'reason_otaker'},
596 dbh->rollback if $oldAutoCommit;
597 return "Error inserting cust_pkg_reason: $error";
602 #save off and freeze RADIUS attributes for any associated svc_acct records
604 if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
606 #also check for specific exports?
607 # to avoid spurious modify export events
608 @svc_acct = map { $_->svc_x }
609 grep { $_->part_svc->svcdb eq 'svc_acct' }
612 $_->snapshot foreach @svc_acct;
616 my $error = $new->export_pkg_change($old)
617 || $new->SUPER::replace( $old,
619 ? $options->{options}
623 $dbh->rollback if $oldAutoCommit;
627 #for prepaid packages,
628 #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
629 foreach my $old_svc_acct ( @svc_acct ) {
630 my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
632 $new_svc_acct->replace( $old_svc_acct,
633 'depend_jobnum' => $options->{depend_jobnum},
636 $dbh->rollback if $oldAutoCommit;
641 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
648 Checks all fields to make sure this is a valid billing item. If there is an
649 error, returns the error, otherwise returns false. Called by the insert and
657 if ( !$self->locationnum or $self->locationnum == -1 ) {
658 $self->set('locationnum', $self->cust_main->ship_locationnum);
662 $self->ut_numbern('pkgnum')
663 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
664 || $self->ut_numbern('pkgpart')
665 || $self->ut_foreign_keyn('contactnum', 'contact', 'contactnum' )
666 || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
667 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
668 || $self->ut_numbern('quantity')
669 || $self->ut_numbern('start_date')
670 || $self->ut_numbern('setup')
671 || $self->ut_numbern('bill')
672 || $self->ut_numbern('susp')
673 || $self->ut_numbern('cancel')
674 || $self->ut_numbern('adjourn')
675 || $self->ut_numbern('resume')
676 || $self->ut_numbern('expire')
677 || $self->ut_numbern('dundate')
678 || $self->ut_flag('no_auto', [ '', 'Y' ])
679 || $self->ut_flag('waive_setup', [ '', 'Y' ])
680 || $self->ut_flag('separate_bill')
681 || $self->ut_textn('agent_pkgid')
682 || $self->ut_enum('recur_show_zero', [ '', 'Y', 'N', ])
683 || $self->ut_enum('setup_show_zero', [ '', 'Y', 'N', ])
684 || $self->ut_foreign_keyn('main_pkgnum', 'cust_pkg', 'pkgnum')
685 || $self->ut_foreign_keyn('pkglinknum', 'part_pkg_link', 'pkglinknum')
686 || $self->ut_foreign_keyn('change_to_pkgnum', 'cust_pkg', 'pkgnum')
688 return $error if $error;
690 return "A package with both start date (future start) and setup date (already started) will never bill"
691 if $self->start_date && $self->setup && ! $upgrade;
693 return "A future unsuspend date can only be set for a package with a suspend date"
694 if $self->resume and !$self->susp and !$self->adjourn;
696 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
698 if ( $self->dbdef_table->column('manual_flag') ) {
699 $self->manual_flag('') if $self->manual_flag eq ' ';
700 $self->manual_flag =~ /^([01]?)$/
701 or return "Illegal manual_flag ". $self->manual_flag;
702 $self->manual_flag($1);
710 Check the pkgpart to make sure it's allowed with the reg_code and/or
711 promo_code of the package (if present) and with the customer's agent.
712 Called from C<insert>, unless we are doing a package change that doesn't
720 # my $error = $self->ut_numbern('pkgpart'); # already done
723 if ( $self->reg_code ) {
725 unless ( grep { $self->pkgpart == $_->pkgpart }
726 map { $_->reg_code_pkg }
727 qsearchs( 'reg_code', { 'code' => $self->reg_code,
728 'agentnum' => $self->cust_main->agentnum })
730 return "Unknown registration code";
733 } elsif ( $self->promo_code ) {
736 qsearchs('part_pkg', {
737 'pkgpart' => $self->pkgpart,
738 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
740 return 'Unknown promotional code' unless $promo_part_pkg;
744 unless ( $disable_agentcheck ) {
746 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
747 return "agent ". $agent->agentnum. ':'. $agent->agent.
748 " can't purchase pkgpart ". $self->pkgpart
749 unless $agent->pkgpart_hashref->{ $self->pkgpart }
750 || $agent->agentnum == $self->part_pkg->agentnum;
753 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
754 return $error if $error;
762 =item cancel [ OPTION => VALUE ... ]
764 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
765 in this package, then cancels the package itself (sets the cancel field to
768 Available options are:
772 =item quiet - can be set true to supress email cancellation notices.
774 =item time - can be set to cancel the package based on a specific future or
775 historical date. Using time ensures that the remaining amount is calculated
776 correctly. Note however that this is an immediate cancel and just changes
777 the date. You are PROBABLY looking to expire the account instead of using
780 =item reason - can be set to a cancellation reason (see L<FS:reason>),
781 either a reasonnum of an existing reason, or passing a hashref will create
782 a new reason. The hashref should have the following keys: typenum - Reason
783 type (see L<FS::reason_type>, reason - Text of the new reason.
785 =item date - can be set to a unix style timestamp to specify when to
788 =item nobill - can be set true to skip billing if it might otherwise be done.
790 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
791 not credit it. This must be set (by change()) when changing the package
792 to a different pkgpart or location, and probably shouldn't be in any other
793 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
796 =item no_delay_cancel - prevents delay_cancel behavior
797 no matter what other options say, for use when changing packages (or any
798 other time you're really sure you want an immediate cancel)
802 If there is an error, returns the error, otherwise returns false.
806 #NOT DOCUMENTING - this should only be used when calling recursively
807 #=item delay_cancel - for internal use, to allow proper handling of
808 #supplemental packages when the main package is flagged to suspend
809 #before cancelling, probably shouldn't be used otherwise (set the
810 #corresponding package option instead)
813 my( $self, %options ) = @_;
816 # pass all suspend/cancel actions to the main package
817 # (unless the pkglinknum has been removed, then the link is defunct and
818 # this package can be canceled on its own)
819 if ( $self->main_pkgnum and $self->pkglinknum and !$options{'from_main'} ) {
820 return $self->main_pkg->cancel(%options);
823 my $conf = new FS::Conf;
825 warn "cust_pkg::cancel called with options".
826 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
829 local $SIG{HUP} = 'IGNORE';
830 local $SIG{INT} = 'IGNORE';
831 local $SIG{QUIT} = 'IGNORE';
832 local $SIG{TERM} = 'IGNORE';
833 local $SIG{TSTP} = 'IGNORE';
834 local $SIG{PIPE} = 'IGNORE';
836 my $oldAutoCommit = $FS::UID::AutoCommit;
837 local $FS::UID::AutoCommit = 0;
840 my $old = $self->select_for_update;
842 if ( $old->get('cancel') || $self->get('cancel') ) {
843 dbh->rollback if $oldAutoCommit;
844 return ""; # no error
847 # XXX possibly set cancel_time to the expire date?
848 my $cancel_time = $options{'time'} || time;
849 my $date = $options{'date'} if $options{'date'}; # expire/cancel later
850 $date = '' if ($date && $date <= $cancel_time); # complain instead?
852 my $delay_cancel = $options{'no_delay_cancel'} ? 0 : $options{'delay_cancel'};
853 if ( !$date && $self->part_pkg->option('delay_cancel',1)
854 && (($self->status eq 'active') || ($self->status eq 'suspended'))
855 && !$options{'no_delay_cancel'}
857 my $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
858 my $expsecs = 60*60*24*$expdays;
859 my $suspfor = $self->susp ? $cancel_time - $self->susp : 0;
860 $expsecs = $expsecs - $suspfor if $suspfor;
861 unless ($expsecs <= 0) { #if it's already been suspended long enough, don't re-suspend
863 $date = $cancel_time + $expsecs;
867 #race condition: usage could be ongoing until unprovisioned
868 #resolved by performing a change package instead (which unprovisions) and
870 if ( !$options{nobill} && !$date ) {
871 # && $conf->exists('bill_usage_on_cancel') ) { #calc_cancel checks this
872 my $copy = $self->new({$self->hash});
874 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
876 'time' => $cancel_time );
877 warn "Error billing during cancel, custnum ".
878 #$self->cust_main->custnum. ": $error"
883 if ( $options{'reason'} ) {
884 $error = $self->insert_reason( 'reason' => $options{'reason'},
885 'action' => $date ? 'expire' : 'cancel',
886 'date' => $date ? $date : $cancel_time,
887 'reason_otaker' => $options{'reason_otaker'},
890 dbh->rollback if $oldAutoCommit;
891 return "Error inserting cust_pkg_reason: $error";
895 my %svc_cancel_opt = ();
896 $svc_cancel_opt{'date'} = $date if $date;
897 foreach my $cust_svc (
900 sort { $a->[1] <=> $b->[1] }
901 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; }
902 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
904 my $part_svc = $cust_svc->part_svc;
905 next if ( defined($part_svc) and $part_svc->preserve );
906 my $error = $cust_svc->cancel( %svc_cancel_opt );
909 $dbh->rollback if $oldAutoCommit;
910 return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
916 # credit remaining time if appropriate
918 if ( exists($options{'unused_credit'}) ) {
919 $do_credit = $options{'unused_credit'};
922 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
925 my $error = $self->credit_remaining('cancel', $cancel_time);
927 $dbh->rollback if $oldAutoCommit;
933 my %hash = $self->hash;
935 $hash{'expire'} = $date;
937 # just to be sure these are clear
938 $hash{'adjourn'} = undef;
939 $hash{'resume'} = undef;
942 $hash{'cancel'} = $cancel_time;
944 $hash{'change_custnum'} = $options{'change_custnum'};
946 # if this is a supplemental package that's lost its part_pkg_link, and it's
947 # being canceled for real, unlink it completely
948 if ( !$date and ! $self->pkglinknum ) {
949 $hash{main_pkgnum} = '';
952 my $new = new FS::cust_pkg ( \%hash );
953 $error = $new->replace( $self, options => { $self->options } );
954 if ( $self->change_to_pkgnum ) {
955 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
956 $error ||= $change_to->cancel('no_delay_cancel' => 1) || $change_to->delete;
959 $dbh->rollback if $oldAutoCommit;
963 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
964 $error = $supp_pkg->cancel(%options,
966 'date' => $date, #in case it got changed by delay_cancel
967 'delay_cancel' => $delay_cancel,
970 $dbh->rollback if $oldAutoCommit;
971 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
975 if ($delay_cancel && !$options{'from_main'}) {
976 $error = $new->suspend(
978 'time' => $cancel_time
983 foreach my $usage ( $self->cust_pkg_usage ) {
984 $error = $usage->delete;
986 $dbh->rollback if $oldAutoCommit;
987 return "deleting usage pools: $error";
992 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
993 return '' if $date; #no errors
995 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
996 if ( !$options{'quiet'} &&
997 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
999 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
1002 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
1003 $error = $msg_template->send( 'cust_main' => $self->cust_main,
1004 'object' => $self );
1007 $error = send_email(
1008 'from' => $conf->invoice_from_full( $self->cust_main->agentnum ),
1009 'to' => \@invoicing_list,
1010 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
1011 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
1012 'custnum' => $self->custnum,
1013 'msgtype' => '', #admin?
1016 #should this do something on errors?
1023 =item cancel_if_expired [ NOW_TIMESTAMP ]
1025 Cancels this package if its expire date has been reached.
1029 sub cancel_if_expired {
1031 my $time = shift || time;
1032 return '' unless $self->expire && $self->expire <= $time;
1033 my $error = $self->cancel;
1035 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
1036 $self->custnum. ": $error";
1043 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
1044 locationnum, (other fields?). Attempts to re-provision cancelled services
1045 using history information (errors at this stage are not fatal).
1047 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
1049 svc_fatal: service provisioning errors are fatal
1051 svc_errors: pass an array reference, will be filled in with any provisioning errors
1053 main_pkgnum: link the package as a supplemental package of this one. For
1059 my( $self, %options ) = @_;
1061 #in case you try do do $uncancel-date = $cust_pkg->uncacel
1062 return '' unless $self->get('cancel');
1064 if ( $self->main_pkgnum and !$options{'main_pkgnum'} ) {
1065 return $self->main_pkg->uncancel(%options);
1072 local $SIG{HUP} = 'IGNORE';
1073 local $SIG{INT} = 'IGNORE';
1074 local $SIG{QUIT} = 'IGNORE';
1075 local $SIG{TERM} = 'IGNORE';
1076 local $SIG{TSTP} = 'IGNORE';
1077 local $SIG{PIPE} = 'IGNORE';
1079 my $oldAutoCommit = $FS::UID::AutoCommit;
1080 local $FS::UID::AutoCommit = 0;
1084 # insert the new package
1087 my $cust_pkg = new FS::cust_pkg {
1088 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
1089 bill => ( $options{'bill'} || $self->get('bill') ),
1091 uncancel_pkgnum => $self->pkgnum,
1092 main_pkgnum => ($options{'main_pkgnum'} || ''),
1093 map { $_ => $self->get($_) } qw(
1094 custnum pkgpart locationnum
1096 susp adjourn resume expire start_date contract_end dundate
1097 change_date change_pkgpart change_locationnum
1098 manual_flag no_auto separate_bill quantity agent_pkgid
1099 recur_show_zero setup_show_zero
1103 my $error = $cust_pkg->insert(
1104 'change' => 1, #supresses any referral credit to a referring customer
1105 'allow_pkgpart' => 1, # allow this even if the package def is disabled
1108 $dbh->rollback if $oldAutoCommit;
1116 #find historical services within this timeframe before the package cancel
1117 # (incompatible with "time" option to cust_pkg->cancel?)
1118 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
1119 # too little? (unprovisioing export delay?)
1120 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
1121 my @h_cust_svc = $self->h_cust_svc( $end, $start );
1124 foreach my $h_cust_svc (@h_cust_svc) {
1125 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
1126 #next unless $h_svc_x; #should this happen?
1127 (my $table = $h_svc_x->table) =~ s/^h_//;
1128 require "FS/$table.pm";
1129 my $class = "FS::$table";
1130 my $svc_x = $class->new( {
1131 'pkgnum' => $cust_pkg->pkgnum,
1132 'svcpart' => $h_cust_svc->svcpart,
1133 map { $_ => $h_svc_x->get($_) } fields($table)
1137 if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
1138 $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
1141 my $svc_error = $svc_x->insert;
1143 if ( $options{svc_fatal} ) {
1144 $dbh->rollback if $oldAutoCommit;
1147 # if we've failed to insert the svc_x object, svc_Common->insert
1148 # will have removed the cust_svc already. if not, then both records
1149 # were inserted but we failed for some other reason (export, most
1150 # likely). in that case, report the error and delete the records.
1151 push @svc_errors, $svc_error;
1152 my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1154 # except if export_insert failed, export_delete probably won't be
1156 local $FS::svc_Common::noexport_hack = 1;
1157 my $cleanup_error = $svc_x->delete; # also deletes cust_svc
1158 if ( $cleanup_error ) { # and if THAT fails, then run away
1159 $dbh->rollback if $oldAutoCommit;
1160 return $cleanup_error;
1165 } #foreach $h_cust_svc
1167 #these are pretty rare, but should handle them
1168 # - dsl_device (mac addresses)
1169 # - phone_device (mac addresses)
1170 # - dsl_note (ikano notes)
1171 # - domain_record (i.e. restore DNS information w/domains)
1172 # - inventory_item(?) (inventory w/un-cancelling service?)
1173 # - nas (svc_broaband nas stuff)
1174 #this stuff is unused in the wild afaik
1175 # - mailinglistmember
1177 # - svc_domain.parent_svcnum?
1178 # - acct_snarf (ancient mail fetching config)
1179 # - cgp_rule (communigate)
1180 # - cust_svc_option (used by our Tron stuff)
1181 # - acct_rt_transaction (used by our time worked stuff)
1184 # also move over any services that didn't unprovision at cancellation
1187 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1188 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1189 my $error = $cust_svc->replace;
1191 $dbh->rollback if $oldAutoCommit;
1197 # Uncancel any supplemental packages, and make them supplemental to the
1201 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1203 $error = $supp_pkg->uncancel(%options, 'main_pkgnum' => $cust_pkg->pkgnum);
1205 $dbh->rollback if $oldAutoCommit;
1206 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1214 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1216 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1217 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1224 Cancels any pending expiration (sets the expire field to null).
1226 If there is an error, returns the error, otherwise returns false.
1231 my( $self, %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 unexpire cancelled package $pkgnum";
1251 # or at least it's pointless
1254 unless ( $old->get('expire') && $self->get('expire') ) {
1255 dbh->rollback if $oldAutoCommit;
1256 return ""; # no error
1259 my %hash = $self->hash;
1260 $hash{'expire'} = '';
1261 my $new = new FS::cust_pkg ( \%hash );
1262 $error = $new->replace( $self, options => { $self->options } );
1264 $dbh->rollback if $oldAutoCommit;
1268 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1274 =item suspend [ OPTION => VALUE ... ]
1276 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1277 package, then suspends the package itself (sets the susp field to now).
1279 Available options are:
1283 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1284 either a reasonnum of an existing reason, or passing a hashref will create
1285 a new reason. The hashref should have the following keys:
1286 - typenum - Reason type (see L<FS::reason_type>
1287 - reason - Text of the new reason.
1289 =item date - can be set to a unix style timestamp to specify when to
1292 =item time - can be set to override the current time, for calculation
1293 of final invoices or unused-time credits
1295 =item resume_date - can be set to a time when the package should be
1296 unsuspended. This may be more convenient than calling C<unsuspend()>
1299 =item from_main - allows a supplemental package to be suspended, rather
1300 than redirecting the method call to its main package. For internal use.
1302 =item from_cancel - used when suspending from the cancel method, forces
1303 this to skip everything besides basic suspension. For internal use.
1307 If there is an error, returns the error, otherwise returns false.
1312 my( $self, %options ) = @_;
1315 # pass all suspend/cancel actions to the main package
1316 if ( $self->main_pkgnum and !$options{'from_main'} ) {
1317 return $self->main_pkg->suspend(%options);
1320 local $SIG{HUP} = 'IGNORE';
1321 local $SIG{INT} = 'IGNORE';
1322 local $SIG{QUIT} = 'IGNORE';
1323 local $SIG{TERM} = 'IGNORE';
1324 local $SIG{TSTP} = 'IGNORE';
1325 local $SIG{PIPE} = 'IGNORE';
1327 my $oldAutoCommit = $FS::UID::AutoCommit;
1328 local $FS::UID::AutoCommit = 0;
1331 my $old = $self->select_for_update;
1333 my $pkgnum = $old->pkgnum;
1334 if ( $old->get('cancel') || $self->get('cancel') ) {
1335 dbh->rollback if $oldAutoCommit;
1336 return "Can't suspend cancelled package $pkgnum";
1339 if ( $old->get('susp') || $self->get('susp') ) {
1340 dbh->rollback if $oldAutoCommit;
1341 return ""; # no error # complain on adjourn?
1344 my $suspend_time = $options{'time'} || time;
1345 my $date = $options{date} if $options{date}; # adjourn/suspend later
1346 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1348 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1349 dbh->rollback if $oldAutoCommit;
1350 return "Package $pkgnum expires before it would be suspended.";
1353 # some false laziness with sub cancel
1354 if ( !$options{nobill} && !$date && !$options{'from_cancel'} &&
1355 $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1356 # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1357 # make the entire cust_main->bill path recognize 'suspend' and
1358 # 'cancel' separately.
1359 warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1360 my $copy = $self->new({$self->hash});
1362 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1364 'time' => $suspend_time );
1365 warn "Error billing during suspend, custnum ".
1366 #$self->cust_main->custnum. ": $error"
1371 my $cust_pkg_reason;
1372 if ( $options{'reason'} ) {
1373 $error = $self->insert_reason( 'reason' => $options{'reason'},
1374 'action' => $date ? 'adjourn' : 'suspend',
1375 'date' => $date ? $date : $suspend_time,
1376 'reason_otaker' => $options{'reason_otaker'},
1379 dbh->rollback if $oldAutoCommit;
1380 return "Error inserting cust_pkg_reason: $error";
1382 $cust_pkg_reason = qsearchs('cust_pkg_reason', {
1383 'date' => $date ? $date : $suspend_time,
1384 'action' => $date ? 'A' : 'S',
1385 'pkgnum' => $self->pkgnum,
1389 # if a reasonnum was passed, get the actual reason object so we can check
1391 # (passing a reason hashref is still allowed, but it can't be used with
1392 # the fancy behavioral options.)
1395 if ($options{'reason'} =~ /^\d+$/) {
1396 $reason = FS::reason->by_key($options{'reason'});
1399 my %hash = $self->hash;
1401 $hash{'adjourn'} = $date;
1403 $hash{'susp'} = $suspend_time;
1406 my $resume_date = $options{'resume_date'} || 0;
1407 if ( $resume_date > ($date || $suspend_time) ) {
1408 $hash{'resume'} = $resume_date;
1411 $options{options} ||= {};
1413 my $new = new FS::cust_pkg ( \%hash );
1414 $error = $new->replace( $self, options => { $self->options,
1415 %{ $options{options} },
1419 $dbh->rollback if $oldAutoCommit;
1423 unless ( $date ) { # then we are suspending now
1425 unless ($options{'from_cancel'}) {
1426 # credit remaining time if appropriate
1427 # (if required by the package def, or the suspend reason)
1428 my $unused_credit = $self->part_pkg->option('unused_credit_suspend',1)
1429 || ( defined($reason) && $reason->unused_credit );
1431 if ( $unused_credit ) {
1432 warn "crediting unused time on pkg#".$self->pkgnum."\n" if $DEBUG;
1433 my $error = $self->credit_remaining('suspend', $suspend_time);
1435 $dbh->rollback if $oldAutoCommit;
1443 foreach my $cust_svc (
1444 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1446 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1448 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1449 $dbh->rollback if $oldAutoCommit;
1450 return "Illegal svcdb value in part_svc!";
1453 require "FS/$svcdb.pm";
1455 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1457 $error = $svc->suspend;
1459 $dbh->rollback if $oldAutoCommit;
1462 my( $label, $value ) = $cust_svc->label;
1463 push @labels, "$label: $value";
1467 # suspension fees: if there is a feepart, and it's not an unsuspend fee,
1468 # and this is not a suspend-before-cancel
1469 if ( $cust_pkg_reason ) {
1470 my $reason_obj = $cust_pkg_reason->reason;
1471 if ( $reason_obj->feepart and
1472 ! $reason_obj->fee_on_unsuspend and
1473 ! $options{'from_cancel'} ) {
1475 # register the need to charge a fee, cust_main->bill will do the rest
1476 warn "registering suspend fee: pkgnum ".$self->pkgnum.", feepart ".$reason->feepart."\n"
1478 my $cust_pkg_reason_fee = FS::cust_pkg_reason_fee->new({
1479 'pkgreasonnum' => $cust_pkg_reason->num,
1480 'pkgnum' => $self->pkgnum,
1481 'feepart' => $reason->feepart,
1482 'nextbill' => $reason->fee_hold,
1484 $error ||= $cust_pkg_reason_fee->insert;
1488 my $conf = new FS::Conf;
1489 if ( $conf->config('suspend_email_admin') && !$options{'from_cancel'} ) {
1491 my $error = send_email(
1492 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1493 #invoice_from ??? well as good as any
1494 'to' => $conf->config('suspend_email_admin'),
1495 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1497 "This is an automatic message from your Freeside installation\n",
1498 "informing you that the following customer package has been suspended:\n",
1500 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1501 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1502 ( map { "Service : $_\n" } @labels ),
1504 'custnum' => $self->custnum,
1505 'msgtype' => 'admin'
1509 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1517 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1518 $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1520 $dbh->rollback if $oldAutoCommit;
1521 return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1525 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1530 =item credit_remaining MODE TIME
1532 Generate a credit for this package for the time remaining in the current
1533 billing period. MODE is either "suspend" or "cancel" (determines the
1534 credit type). TIME is the time of suspension/cancellation. Both arguments
1539 # Implementation note:
1541 # If you pkgpart-change a package that has been billed, and it's set to give
1542 # credit on package change, then this method gets called and then the new
1543 # package will have no last_bill date. Therefore the customer will be credited
1544 # only once (per billing period) even if there are multiple package changes.
1546 # If you location-change a package that has been billed, this method will NOT
1547 # be called and the new package WILL have the last bill date of the old
1550 # If the new package is then canceled within the same billing cycle,
1551 # credit_remaining needs to run calc_remain on the OLD package to determine
1552 # the amount of unused time to credit.
1554 sub credit_remaining {
1555 # Add a credit for remaining service
1556 my ($self, $mode, $time) = @_;
1557 die 'credit_remaining requires suspend or cancel'
1558 unless $mode eq 'suspend' or $mode eq 'cancel';
1559 die 'no suspend/cancel time' unless $time > 0;
1561 my $conf = FS::Conf->new;
1562 my $reason_type = $conf->config($mode.'_credit_type');
1564 my $last_bill = $self->getfield('last_bill') || 0;
1565 my $next_bill = $self->getfield('bill') || 0;
1566 if ( $last_bill > 0 # the package has been billed
1567 and $next_bill > 0 # the package has a next bill date
1568 and $next_bill >= $time # which is in the future
1570 my $remaining_value = 0;
1572 my $remain_pkg = $self;
1573 $remaining_value = $remain_pkg->calc_remain('time' => $time);
1575 # we may have to walk back past some package changes to get to the
1576 # one that actually has unused time
1577 while ( $remaining_value == 0 ) {
1578 if ( $remain_pkg->change_pkgnum ) {
1579 $remain_pkg = FS::cust_pkg->by_key($remain_pkg->change_pkgnum);
1581 # the package has really never been billed
1584 $remaining_value = $remain_pkg->calc_remain('time' => $time);
1587 if ( $remaining_value > 0 ) {
1588 warn "Crediting for $remaining_value on package ".$self->pkgnum."\n"
1590 my $error = $self->cust_main->credit(
1592 'Credit for unused time on '. $self->part_pkg->pkg,
1593 'reason_type' => $reason_type,
1595 return "Error crediting customer \$$remaining_value for unused time".
1596 " on ". $self->part_pkg->pkg. ": $error"
1598 } #if $remaining_value
1599 } #if $last_bill, etc.
1603 =item unsuspend [ OPTION => VALUE ... ]
1605 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1606 package, then unsuspends the package itself (clears the susp field and the
1607 adjourn field if it is in the past). If the suspend reason includes an
1608 unsuspension package, that package will be ordered.
1610 Available options are:
1616 Can be set to a date to unsuspend the package in the future (the 'resume'
1619 =item adjust_next_bill
1621 Can be set true to adjust the next bill date forward by
1622 the amount of time the account was inactive. This was set true by default
1623 in the past (from 1.4.2 and 1.5.0pre6 through 1.7.0), but now needs to be
1624 explicitly requested with this option or in the price plan.
1628 If there is an error, returns the error, otherwise returns false.
1633 my( $self, %opt ) = @_;
1636 # pass all suspend/cancel actions to the main package
1637 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1638 return $self->main_pkg->unsuspend(%opt);
1641 local $SIG{HUP} = 'IGNORE';
1642 local $SIG{INT} = 'IGNORE';
1643 local $SIG{QUIT} = 'IGNORE';
1644 local $SIG{TERM} = 'IGNORE';
1645 local $SIG{TSTP} = 'IGNORE';
1646 local $SIG{PIPE} = 'IGNORE';
1648 my $oldAutoCommit = $FS::UID::AutoCommit;
1649 local $FS::UID::AutoCommit = 0;
1652 my $old = $self->select_for_update;
1654 my $pkgnum = $old->pkgnum;
1655 if ( $old->get('cancel') || $self->get('cancel') ) {
1656 $dbh->rollback if $oldAutoCommit;
1657 return "Can't unsuspend cancelled package $pkgnum";
1660 unless ( $old->get('susp') && $self->get('susp') ) {
1661 $dbh->rollback if $oldAutoCommit;
1662 return ""; # no error # complain instead?
1665 # handle the case of setting a future unsuspend (resume) date
1666 # and do not continue to actually unsuspend the package
1667 my $date = $opt{'date'};
1668 if ( $date and $date > time ) { # return an error if $date <= time?
1670 if ( $old->get('expire') && $old->get('expire') < $date ) {
1671 $dbh->rollback if $oldAutoCommit;
1672 return "Package $pkgnum expires before it would be unsuspended.";
1675 my $new = new FS::cust_pkg { $self->hash };
1676 $new->set('resume', $date);
1677 $error = $new->replace($self, options => $self->options);
1680 $dbh->rollback if $oldAutoCommit;
1684 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1690 if (!$self->setup) {
1691 # then this package is being released from on-hold status
1692 $self->set_initial_timers;
1697 foreach my $cust_svc (
1698 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1700 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1702 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1703 $dbh->rollback if $oldAutoCommit;
1704 return "Illegal svcdb value in part_svc!";
1707 require "FS/$svcdb.pm";
1709 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1711 $error = $svc->unsuspend;
1713 $dbh->rollback if $oldAutoCommit;
1716 my( $label, $value ) = $cust_svc->label;
1717 push @labels, "$label: $value";
1722 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1723 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1725 my %hash = $self->hash;
1726 my $inactive = time - $hash{'susp'};
1728 my $conf = new FS::Conf;
1730 # increment next bill date if certain conditions are met:
1731 # - it was due to be billed at some point
1732 # - either the global or local config says to do this
1733 my $adjust_bill = 0;
1736 && ( $hash{'bill'} || $hash{'setup'} )
1737 && ( $opt{'adjust_next_bill'}
1738 || $conf->exists('unsuspend-always_adjust_next_bill_date')
1739 || $self->part_pkg->option('unsuspend_adjust_bill', 1)
1746 # - the package billed during suspension
1747 # - or it was ordered on hold
1748 # - or the customer was credited for the unused time
1750 if ( $self->option('suspend_bill',1)
1751 or ( $self->part_pkg->option('suspend_bill',1)
1752 and ! $self->option('no_suspend_bill',1)
1754 or $hash{'order_date'} == $hash{'susp'}
1759 if ( $adjust_bill ) {
1760 if ( $self->part_pkg->option('unused_credit_suspend')
1761 or ( $reason and $reason->unused_credit ) ) {
1762 # then the customer was credited for the unused time before suspending,
1763 # so their next bill should be immediate.
1764 $hash{'bill'} = time;
1766 # add the length of time suspended to the bill date
1767 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1772 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1773 $hash{'resume'} = '' if !$hash{'adjourn'};
1774 my $new = new FS::cust_pkg ( \%hash );
1775 $error = $new->replace( $self, options => { $self->options } );
1777 $dbh->rollback if $oldAutoCommit;
1784 if ( $reason->unsuspend_pkgpart ) {
1785 #warn "Suspend reason '".$reason->reason."' uses deprecated unsuspend_pkgpart feature.\n"; # in 4.x
1786 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
1787 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
1789 my $start_date = $self->cust_main->next_bill_date
1790 if $reason->unsuspend_hold;
1793 $unsusp_pkg = FS::cust_pkg->new({
1794 'custnum' => $self->custnum,
1795 'pkgpart' => $reason->unsuspend_pkgpart,
1796 'start_date' => $start_date,
1797 'locationnum' => $self->locationnum,
1798 # discount? probably not...
1801 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
1804 # new way, using fees
1805 if ( $reason->feepart and $reason->fee_on_unsuspend ) {
1806 # register the need to charge a fee, cust_main->bill will do the rest
1807 warn "registering unsuspend fee: pkgnum ".$self->pkgnum.", feepart ".$reason->feepart."\n"
1809 my $cust_pkg_reason_fee = FS::cust_pkg_reason_fee->new({
1810 'pkgreasonnum' => $cust_pkg_reason->num,
1811 'pkgnum' => $self->pkgnum,
1812 'feepart' => $reason->feepart,
1813 'nextbill' => $reason->fee_hold,
1815 $error ||= $cust_pkg_reason_fee->insert;
1819 $dbh->rollback if $oldAutoCommit;
1824 if ( $conf->config('unsuspend_email_admin') ) {
1826 my $error = send_email(
1827 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1828 #invoice_from ??? well as good as any
1829 'to' => $conf->config('unsuspend_email_admin'),
1830 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
1831 "This is an automatic message from your Freeside installation\n",
1832 "informing you that the following customer package has been unsuspended:\n",
1834 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1835 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1836 ( map { "Service : $_\n" } @labels ),
1838 "An unsuspension fee was charged: ".
1839 $unsusp_pkg->part_pkg->pkg_comment."\n"
1843 'custnum' => $self->custnum,
1844 'msgtype' => 'admin',
1848 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
1854 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1855 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
1857 $dbh->rollback if $oldAutoCommit;
1858 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1862 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1869 Cancels any pending suspension (sets the adjourn field to null).
1871 If there is an error, returns the error, otherwise returns false.
1876 my( $self, %options ) = @_;
1879 local $SIG{HUP} = 'IGNORE';
1880 local $SIG{INT} = 'IGNORE';
1881 local $SIG{QUIT} = 'IGNORE';
1882 local $SIG{TERM} = 'IGNORE';
1883 local $SIG{TSTP} = 'IGNORE';
1884 local $SIG{PIPE} = 'IGNORE';
1886 my $oldAutoCommit = $FS::UID::AutoCommit;
1887 local $FS::UID::AutoCommit = 0;
1890 my $old = $self->select_for_update;
1892 my $pkgnum = $old->pkgnum;
1893 if ( $old->get('cancel') || $self->get('cancel') ) {
1894 dbh->rollback if $oldAutoCommit;
1895 return "Can't unadjourn cancelled package $pkgnum";
1896 # or at least it's pointless
1899 if ( $old->get('susp') || $self->get('susp') ) {
1900 dbh->rollback if $oldAutoCommit;
1901 return "Can't unadjourn suspended package $pkgnum";
1902 # perhaps this is arbitrary
1905 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1906 dbh->rollback if $oldAutoCommit;
1907 return ""; # no error
1910 my %hash = $self->hash;
1911 $hash{'adjourn'} = '';
1912 $hash{'resume'} = '';
1913 my $new = new FS::cust_pkg ( \%hash );
1914 $error = $new->replace( $self, options => { $self->options } );
1916 $dbh->rollback if $oldAutoCommit;
1920 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1927 =item change HASHREF | OPTION => VALUE ...
1929 Changes this package: cancels it and creates a new one, with a different
1930 pkgpart or locationnum or both. All services are transferred to the new
1931 package (no change will be made if this is not possible).
1933 Options may be passed as a list of key/value pairs or as a hash reference.
1940 New locationnum, to change the location for this package.
1944 New FS::cust_location object, to create a new location and assign it
1949 New FS::cust_main object, to create a new customer and assign the new package
1954 New pkgpart (see L<FS::part_pkg>).
1958 New refnum (see L<FS::part_referral>).
1962 New quantity; if unspecified, the new package will have the same quantity
1967 "New" (existing) FS::cust_pkg object. The package's services and other
1968 attributes will be transferred to this package.
1972 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1973 susp, adjourn, cancel, expire, and contract_end) to the new package.
1975 =item unprotect_svcs
1977 Normally, change() will rollback and return an error if some services
1978 can't be transferred (also see the I<cust_pkg-change_svcpart> config option).
1979 If unprotect_svcs is true, this method will transfer as many services as
1980 it can and then unconditionally cancel the old package.
1984 At least one of locationnum, cust_location, pkgpart, refnum, cust_main, or
1985 cust_pkg must be specified (otherwise, what's the point?)
1987 Returns either the new FS::cust_pkg object or a scalar error.
1991 my $err_or_new_cust_pkg = $old_cust_pkg->change
1995 #some false laziness w/order
1998 my $opt = ref($_[0]) ? shift : { @_ };
2000 my $conf = new FS::Conf;
2002 # Transactionize this whole mess
2003 local $SIG{HUP} = 'IGNORE';
2004 local $SIG{INT} = 'IGNORE';
2005 local $SIG{QUIT} = 'IGNORE';
2006 local $SIG{TERM} = 'IGNORE';
2007 local $SIG{TSTP} = 'IGNORE';
2008 local $SIG{PIPE} = 'IGNORE';
2010 my $oldAutoCommit = $FS::UID::AutoCommit;
2011 local $FS::UID::AutoCommit = 0;
2016 if ( $opt->{'cust_location'} ) {
2017 $error = $opt->{'cust_location'}->find_or_insert;
2019 $dbh->rollback if $oldAutoCommit;
2020 return "creating location record: $error";
2022 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
2025 # Before going any further here: if the package is still in the pre-setup
2026 # state, it's safe to modify it in place. No need to charge/credit for
2027 # partial period, transfer services, transfer usage pools, copy invoice
2028 # details, or change any dates.
2029 if ( ! $self->setup and ! $opt->{cust_pkg} and ! $opt->{cust_main} ) {
2030 foreach ( qw( locationnum pkgpart quantity refnum salesnum ) ) {
2031 if ( length($opt->{$_}) ) {
2032 $self->set($_, $opt->{$_});
2035 # almost. if the new pkgpart specifies start/adjourn/expire timers,
2037 if ( $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart ) {
2038 $self->set_initial_timers;
2040 $error = $self->replace;
2042 $dbh->rollback if $oldAutoCommit;
2043 return "modifying package: $error";
2045 $dbh->commit if $oldAutoCommit;
2054 $hash{'setup'} = $time if $self->setup;
2056 $hash{'change_date'} = $time;
2057 $hash{"change_$_"} = $self->$_()
2058 foreach qw( pkgnum pkgpart locationnum );
2060 if ( $opt->{'cust_pkg'} ) {
2061 # treat changing to a package with a different pkgpart as a
2062 # pkgpart change (because it is)
2063 $opt->{'pkgpart'} = $opt->{'cust_pkg'}->pkgpart;
2066 # whether to override pkgpart checking on the new package
2067 my $same_pkgpart = 1;
2068 if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
2072 my $unused_credit = 0;
2073 my $keep_dates = $opt->{'keep_dates'};
2075 # Special case. If the pkgpart is changing, and the customer is
2076 # going to be credited for remaining time, don't keep setup, bill,
2077 # or last_bill dates, and DO pass the flag to cancel() to credit
2079 if ( $opt->{'pkgpart'}
2080 and $opt->{'pkgpart'} != $self->pkgpart
2081 and $self->part_pkg->option('unused_credit_change', 1) ) {
2084 $hash{$_} = '' foreach qw(setup bill last_bill);
2087 if ( $keep_dates ) {
2088 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
2089 resume start_date contract_end ) ) {
2090 $hash{$date} = $self->getfield($date);
2093 # always keep this date, regardless of anything
2094 # (the date of the package change is in a different field)
2095 $hash{'order_date'} = $self->getfield('order_date');
2097 # allow $opt->{'locationnum'} = '' to specifically set it to null
2098 # (i.e. customer default location)
2099 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2101 # usually this doesn't matter. the two cases where it does are:
2102 # 1. unused_credit_change + pkgpart change + setup fee on the new package
2104 # 2. (more importantly) changing a package before it's billed
2105 $hash{'waive_setup'} = $self->waive_setup;
2107 # if this package is scheduled for a future package change, preserve that
2108 $hash{'change_to_pkgnum'} = $self->change_to_pkgnum;
2110 my $custnum = $self->custnum;
2111 if ( $opt->{cust_main} ) {
2112 my $cust_main = $opt->{cust_main};
2113 unless ( $cust_main->custnum ) {
2114 my $error = $cust_main->insert( @{ $opt->{cust_main_insert_args}||[] } );
2116 $dbh->rollback if $oldAutoCommit;
2117 return "inserting customer record: $error";
2120 $custnum = $cust_main->custnum;
2123 $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
2126 if ( $opt->{'cust_pkg'} ) {
2127 # The target package already exists; update it to show that it was
2128 # changed from this package.
2129 $cust_pkg = $opt->{'cust_pkg'};
2131 foreach ( qw( pkgnum pkgpart locationnum ) ) {
2132 $cust_pkg->set("change_$_", $self->get($_));
2134 $cust_pkg->set('change_date', $time);
2135 $cust_pkg->set('start_date', ''); # it's starting now
2136 # if we are crediting unused time, then create the new package as a new
2137 # package, charge its setup fee, etc. (same as an immediate change)
2138 if (! $unused_credit) {
2139 foreach my $date ( qw(setup bill last_bill susp adjourn resume
2141 $cust_pkg->set($date, $self->getfield($date));
2144 $error = $cust_pkg->replace;
2147 # Create the new package.
2148 $cust_pkg = new FS::cust_pkg {
2149 custnum => $custnum,
2150 locationnum => $opt->{'locationnum'},
2151 ( map { $_ => ( $opt->{$_} || $self->$_() ) }
2152 qw( pkgpart quantity refnum salesnum )
2156 $error = $cust_pkg->insert( 'change' => 1,
2157 'allow_pkgpart' => $same_pkgpart );
2160 $dbh->rollback if $oldAutoCommit;
2161 return "inserting new package: $error";
2164 # Transfer services and cancel old package.
2165 # Enforce service limits only if this is a pkgpart change.
2166 local $FS::cust_svc::ignore_quantity;
2167 $FS::cust_svc::ignore_quantity = 1 if $same_pkgpart;
2168 $error = $self->transfer($cust_pkg);
2169 if ($error and $error == 0) {
2170 # $old_pkg->transfer failed.
2171 $dbh->rollback if $oldAutoCommit;
2172 return "transferring $error";
2175 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2176 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2177 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
2178 if ($error and $error == 0) {
2179 # $old_pkg->transfer failed.
2180 $dbh->rollback if $oldAutoCommit;
2181 return "converting $error";
2185 # We set unprotect_svcs when executing a "future package change". It's
2186 # not a user-interactive operation, so returning an error means the
2187 # package change will just fail. Rather than have that happen, we'll
2188 # let leftover services be deleted.
2189 if ($error > 0 and !$opt->{'unprotect_svcs'}) {
2190 # Transfers were successful, but we still had services left on the old
2191 # package. We can't change the package under this circumstances, so abort.
2192 $dbh->rollback if $oldAutoCommit;
2193 return "unable to transfer all services";
2196 #reset usage if changing pkgpart
2197 # AND usage rollover is off (otherwise adds twice, now and at package bill)
2198 if ($self->pkgpart != $cust_pkg->pkgpart) {
2199 my $part_pkg = $cust_pkg->part_pkg;
2200 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
2204 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
2207 $dbh->rollback if $oldAutoCommit;
2208 return "setting usage values: $error";
2211 # if NOT changing pkgpart, transfer any usage pools over
2212 foreach my $usage ($self->cust_pkg_usage) {
2213 $usage->set('pkgnum', $cust_pkg->pkgnum);
2214 $error = $usage->replace;
2216 $dbh->rollback if $oldAutoCommit;
2217 return "transferring usage pools: $error";
2222 # transfer discounts, if we're not changing pkgpart
2223 if ( $same_pkgpart ) {
2224 foreach my $old_discount ($self->cust_pkg_discount_active) {
2225 # don't remove the old discount, we may still need to bill that package.
2226 my $new_discount = new FS::cust_pkg_discount {
2227 'pkgnum' => $cust_pkg->pkgnum,
2228 'discountnum' => $old_discount->discountnum,
2229 'months_used' => $old_discount->months_used,
2231 $error = $new_discount->insert;
2233 $dbh->rollback if $oldAutoCommit;
2234 return "transferring discounts: $error";
2239 # transfer (copy) invoice details
2240 foreach my $detail ($self->cust_pkg_detail) {
2241 my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
2242 $new_detail->set('pkgdetailnum', '');
2243 $new_detail->set('pkgnum', $cust_pkg->pkgnum);
2244 $error = $new_detail->insert;
2246 $dbh->rollback if $oldAutoCommit;
2247 return "transferring package notes: $error";
2253 if ( !$opt->{'cust_pkg'} ) {
2254 # Order any supplemental packages.
2255 my $part_pkg = $cust_pkg->part_pkg;
2256 my @old_supp_pkgs = $self->supplemental_pkgs;
2257 foreach my $link ($part_pkg->supp_part_pkg_link) {
2259 foreach (@old_supp_pkgs) {
2260 if ($_->pkgpart == $link->dst_pkgpart) {
2262 $_->pkgpart(0); # so that it can't match more than once
2266 # false laziness with FS::cust_main::Packages::order_pkg
2267 my $new = FS::cust_pkg->new({
2268 pkgpart => $link->dst_pkgpart,
2269 pkglinknum => $link->pkglinknum,
2270 custnum => $custnum,
2271 main_pkgnum => $cust_pkg->pkgnum,
2272 locationnum => $cust_pkg->locationnum,
2273 start_date => $cust_pkg->start_date,
2274 order_date => $cust_pkg->order_date,
2275 expire => $cust_pkg->expire,
2276 adjourn => $cust_pkg->adjourn,
2277 contract_end => $cust_pkg->contract_end,
2278 refnum => $cust_pkg->refnum,
2279 discountnum => $cust_pkg->discountnum,
2280 waive_setup => $cust_pkg->waive_setup,
2282 if ( $old and $opt->{'keep_dates'} ) {
2283 foreach (qw(setup bill last_bill)) {
2284 $new->set($_, $old->get($_));
2287 $error = $new->insert( allow_pkgpart => $same_pkgpart );
2290 $error ||= $old->transfer($new);
2292 if ( $error and $error > 0 ) {
2293 # no reason why this should ever fail, but still...
2294 $error = "Unable to transfer all services from supplemental package ".
2298 $dbh->rollback if $oldAutoCommit;
2301 push @new_supp_pkgs, $new;
2303 } # if !$opt->{'cust_pkg'}
2304 # because if there is one, then supplemental packages would already
2305 # have been created for it.
2307 #Good to go, cancel old package. Notify 'cancel' of whether to credit
2309 #Don't allow billing the package (preceding period packages and/or
2310 #outstanding usage) if we are keeping dates (i.e. location changing),
2311 #because the new package will be billed for the same date range.
2312 #Supplemental packages are also canceled here.
2314 # during scheduled changes, avoid canceling the package we just
2316 $self->set('change_to_pkgnum' => '');
2318 $error = $self->cancel(
2320 unused_credit => $unused_credit,
2321 nobill => $keep_dates,
2322 change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2323 no_delay_cancel => 1,
2326 $dbh->rollback if $oldAutoCommit;
2327 return "canceling old package: $error";
2330 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2332 my $error = $cust_pkg->cust_main->bill(
2333 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2336 $dbh->rollback if $oldAutoCommit;
2337 return "billing new package: $error";
2341 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2347 =item change_later OPTION => VALUE...
2349 Schedule a package change for a later date. This actually orders the new
2350 package immediately, but sets its start date for a future date, and sets
2351 the current package to expire on the same date.
2353 If the package is already scheduled for a change, this can be called with
2354 'start_date' to change the scheduled date, or with pkgpart and/or
2355 locationnum to modify the package change. To cancel the scheduled change
2356 entirely, see C<abort_change>.
2364 The date for the package change. Required, and must be in the future.
2372 The pkgpart. locationnum, and quantity of the new package, with the same
2373 meaning as in C<change>.
2381 my $opt = ref($_[0]) ? shift : { @_ };
2383 my $oldAutoCommit = $FS::UID::AutoCommit;
2384 local $FS::UID::AutoCommit = 0;
2387 my $cust_main = $self->cust_main;
2389 my $date = delete $opt->{'start_date'} or return 'start_date required';
2391 if ( $date <= time ) {
2392 $dbh->rollback if $oldAutoCommit;
2393 return "start_date $date is in the past";
2398 if ( $self->change_to_pkgnum ) {
2399 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
2400 my $new_pkgpart = $opt->{'pkgpart'}
2401 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $change_to->pkgpart;
2402 my $new_locationnum = $opt->{'locationnum'}
2403 if $opt->{'locationnum'} and $opt->{'locationnum'} != $change_to->locationnum;
2404 my $new_quantity = $opt->{'quantity'}
2405 if $opt->{'quantity'} and $opt->{'quantity'} != $change_to->quantity;
2406 if ( $new_pkgpart or $new_locationnum or $new_quantity ) {
2407 # it hasn't been billed yet, so in principle we could just edit
2408 # it in place (w/o a package change), but that's bad form.
2409 # So change the package according to the new options...
2410 my $err_or_pkg = $change_to->change(%$opt);
2411 if ( ref $err_or_pkg ) {
2412 # Then set that package up for a future start.
2413 $self->set('change_to_pkgnum', $err_or_pkg->pkgnum);
2414 $self->set('expire', $date); # in case it's different
2415 $err_or_pkg->set('start_date', $date);
2416 $err_or_pkg->set('change_date', '');
2417 $err_or_pkg->set('change_pkgnum', '');
2419 $error = $self->replace ||
2420 $err_or_pkg->replace ||
2421 $change_to->cancel('no_delay_cancel' => 1) ||
2424 $error = $err_or_pkg;
2426 } else { # change the start date only.
2427 $self->set('expire', $date);
2428 $change_to->set('start_date', $date);
2429 $error = $self->replace || $change_to->replace;
2432 $dbh->rollback if $oldAutoCommit;
2435 $dbh->commit if $oldAutoCommit;
2438 } # if $self->change_to_pkgnum
2440 my $new_pkgpart = $opt->{'pkgpart'}
2441 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2442 my $new_locationnum = $opt->{'locationnum'}
2443 if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2444 my $new_quantity = $opt->{'quantity'}
2445 if $opt->{'quantity'} and $opt->{'quantity'} != $self->quantity;
2447 return '' unless $new_pkgpart or $new_locationnum or $new_quantity; # wouldn't do anything
2449 # allow $opt->{'locationnum'} = '' to specifically set it to null
2450 # (i.e. customer default location)
2451 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2453 my $new = FS::cust_pkg->new( {
2454 custnum => $self->custnum,
2455 locationnum => $opt->{'locationnum'},
2456 start_date => $date,
2457 map { $_ => ( $opt->{$_} || $self->$_() ) }
2458 qw( pkgpart quantity refnum salesnum )
2460 $error = $new->insert('change' => 1,
2461 'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2463 $self->set('change_to_pkgnum', $new->pkgnum);
2464 $self->set('expire', $date);
2465 $error = $self->replace;
2468 $dbh->rollback if $oldAutoCommit;
2470 $dbh->commit if $oldAutoCommit;
2478 Cancels a future package change scheduled by C<change_later>.
2484 my $pkgnum = $self->change_to_pkgnum;
2485 my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
2488 $error = $change_to->cancel || $change_to->delete;
2489 return $error if $error;
2491 $self->set('change_to_pkgnum', '');
2492 $self->set('expire', '');
2496 =item set_quantity QUANTITY
2498 Change the package's quantity field. This is one of the few package properties
2499 that can safely be changed without canceling and reordering the package
2500 (because it doesn't affect tax eligibility). Returns an error or an
2507 $self = $self->replace_old; # just to make sure
2508 $self->quantity(shift);
2512 =item set_salesnum SALESNUM
2514 Change the package's salesnum (sales person) field. This is one of the few
2515 package properties that can safely be changed without canceling and reordering
2516 the package (because it doesn't affect tax eligibility). Returns an error or
2523 $self = $self->replace_old; # just to make sure
2524 $self->salesnum(shift);
2526 # XXX this should probably reassign any credit that's already been given
2529 =item modify_charge OPTIONS
2531 Change the properties of a one-time charge. The following properties can
2532 be changed this way:
2533 - pkg: the package description
2534 - classnum: the package class
2535 - additional: arrayref of additional invoice details to add to this package
2537 and, I<if the charge has not yet been billed>:
2538 - start_date: the date when it will be billed
2539 - amount: the setup fee to be charged
2540 - quantity: the multiplier for the setup fee
2541 - separate_bill: whether to put the charge on a separate invoice
2543 If you pass 'adjust_commission' => 1, and the classnum changes, and there are
2544 commission credits linked to this charge, they will be recalculated.
2551 my $part_pkg = $self->part_pkg;
2552 my $pkgnum = $self->pkgnum;
2555 my $oldAutoCommit = $FS::UID::AutoCommit;
2556 local $FS::UID::AutoCommit = 0;
2558 return "Can't use modify_charge except on one-time charges"
2559 unless $part_pkg->freq eq '0';
2561 if ( length($opt{'pkg'}) and $part_pkg->pkg ne $opt{'pkg'} ) {
2562 $part_pkg->set('pkg', $opt{'pkg'});
2565 my %pkg_opt = $part_pkg->options;
2566 my $pkg_opt_modified = 0;
2568 $opt{'additional'} ||= [];
2571 foreach (grep /^additional/, keys %pkg_opt) {
2572 ($i) = ($_ =~ /^additional_info(\d+)$/);
2573 $old_additional[$i] = $pkg_opt{$_} if $i;
2574 delete $pkg_opt{$_};
2577 for ( $i = 0; exists($opt{'additional'}->[$i]); $i++ ) {
2578 $pkg_opt{ "additional_info$i" } = $opt{'additional'}->[$i];
2579 if (!exists($old_additional[$i])
2580 or $old_additional[$i] ne $opt{'additional'}->[$i])
2582 $pkg_opt_modified = 1;
2585 $pkg_opt_modified = 1 if (scalar(@old_additional) - 1) != $i;
2586 $pkg_opt{'additional_count'} = $i if $i > 0;
2589 if ( exists($opt{'classnum'}) and $part_pkg->classnum ne $opt{'classnum'} )
2592 $old_classnum = $part_pkg->classnum;
2593 $part_pkg->set('classnum', $opt{'classnum'});
2596 if ( !$self->get('setup') ) {
2597 # not yet billed, so allow amount, setup_cost, quantity, start_date,
2600 if ( exists($opt{'amount'})
2601 and $part_pkg->option('setup_fee') != $opt{'amount'}
2602 and $opt{'amount'} > 0 ) {
2604 $pkg_opt{'setup_fee'} = $opt{'amount'};
2605 $pkg_opt_modified = 1;
2608 if ( exists($opt{'setup_cost'})
2609 and $part_pkg->setup_cost != $opt{'setup_cost'}
2610 and $opt{'setup_cost'} > 0 ) {
2612 $part_pkg->set('setup_cost', $opt{'setup_cost'});
2615 if ( exists($opt{'quantity'})
2616 and $opt{'quantity'} != $self->quantity
2617 and $opt{'quantity'} > 0 ) {
2619 $self->set('quantity', $opt{'quantity'});
2622 if ( exists($opt{'start_date'})
2623 and $opt{'start_date'} != $self->start_date ) {
2625 $self->set('start_date', $opt{'start_date'});
2628 if ( exists($opt{'separate_bill'})
2629 and $opt{'separate_bill'} ne $self->separate_bill ) {
2631 $self->set('separate_bill', $opt{'separate_bill'});
2635 } # else simply ignore them; the UI shouldn't allow editing the fields
2637 if ( exists($opt{'taxclass'})
2638 and $part_pkg->taxclass ne $opt{'taxclass'}) {
2640 $part_pkg->set('taxclass', $opt{'taxclass'});
2644 if ( $part_pkg->modified or $pkg_opt_modified ) {
2645 # can we safely modify the package def?
2646 # Yes, if it's not available for purchase, and this is the only instance
2648 if ( $part_pkg->disabled
2649 and FS::cust_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 1
2650 and FS::quotation_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 0
2652 $error = $part_pkg->replace( options => \%pkg_opt );
2655 $part_pkg = $part_pkg->clone;
2656 $part_pkg->set('disabled' => 'Y');
2657 $error = $part_pkg->insert( options => \%pkg_opt );
2658 # and associate this as yet-unbilled package to the new package def
2659 $self->set('pkgpart' => $part_pkg->pkgpart);
2662 $dbh->rollback if $oldAutoCommit;
2667 if ($self->modified) { # for quantity or start_date change, or if we had
2668 # to clone the existing package def
2669 my $error = $self->replace;
2670 return $error if $error;
2672 if (defined $old_classnum) {
2673 # fix invoice grouping records
2674 my $old_catname = $old_classnum
2675 ? FS::pkg_class->by_key($old_classnum)->categoryname
2677 my $new_catname = $opt{'classnum'}
2678 ? $part_pkg->pkg_class->categoryname
2680 if ( $old_catname ne $new_catname ) {
2681 foreach my $cust_bill_pkg ($self->cust_bill_pkg) {
2682 # (there should only be one...)
2683 my @display = qsearch( 'cust_bill_pkg_display', {
2684 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2685 'section' => $old_catname,
2687 foreach (@display) {
2688 $_->set('section', $new_catname);
2689 $error = $_->replace;
2691 $dbh->rollback if $oldAutoCommit;
2695 } # foreach $cust_bill_pkg
2698 if ( $opt{'adjust_commission'} ) {
2699 # fix commission credits...tricky.
2700 foreach my $cust_event ($self->cust_event) {
2701 my $part_event = $cust_event->part_event;
2702 foreach my $table (qw(sales agent)) {
2704 "FS::part_event::Action::Mixin::credit_${table}_pkg_class";
2705 my $credit = qsearchs('cust_credit', {
2706 'eventnum' => $cust_event->eventnum,
2708 if ( $part_event->isa($class) ) {
2709 # Yes, this results in current commission rates being applied
2710 # retroactively to a one-time charge. For accounting purposes
2711 # there ought to be some kind of time limit on doing this.
2712 my $amount = $part_event->_calc_credit($self);
2713 if ( $credit and $credit->amount ne $amount ) {
2714 # Void the old credit.
2715 $error = $credit->void('Package class changed');
2717 $dbh->rollback if $oldAutoCommit;
2718 return "$error (adjusting commission credit)";
2721 # redo the event action to recreate the credit.
2723 eval { $part_event->do_action( $self, $cust_event ) };
2725 $dbh->rollback if $oldAutoCommit;
2728 } # if $part_event->isa($class)
2730 } # foreach $cust_event
2731 } # if $opt{'adjust_commission'}
2732 } # if defined $old_classnum
2734 $dbh->commit if $oldAutoCommit;
2740 use Storable 'thaw';
2743 sub process_bulk_cust_pkg {
2745 my $param = thaw(decode_base64(shift));
2746 warn Dumper($param) if $DEBUG;
2748 my $old_part_pkg = qsearchs('part_pkg',
2749 { pkgpart => $param->{'old_pkgpart'} });
2750 my $new_part_pkg = qsearchs('part_pkg',
2751 { pkgpart => $param->{'new_pkgpart'} });
2752 die "Must select a new package type\n" unless $new_part_pkg;
2753 #my $keep_dates = $param->{'keep_dates'} || 0;
2754 my $keep_dates = 1; # there is no good reason to turn this off
2756 local $SIG{HUP} = 'IGNORE';
2757 local $SIG{INT} = 'IGNORE';
2758 local $SIG{QUIT} = 'IGNORE';
2759 local $SIG{TERM} = 'IGNORE';
2760 local $SIG{TSTP} = 'IGNORE';
2761 local $SIG{PIPE} = 'IGNORE';
2763 my $oldAutoCommit = $FS::UID::AutoCommit;
2764 local $FS::UID::AutoCommit = 0;
2767 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
2770 foreach my $old_cust_pkg ( @cust_pkgs ) {
2772 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
2773 if ( $old_cust_pkg->getfield('cancel') ) {
2774 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
2775 $old_cust_pkg->pkgnum."\n"
2779 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
2781 my $error = $old_cust_pkg->change(
2782 'pkgpart' => $param->{'new_pkgpart'},
2783 'keep_dates' => $keep_dates
2785 if ( !ref($error) ) { # change returns the cust_pkg on success
2787 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
2790 $dbh->commit if $oldAutoCommit;
2796 Returns the last bill date, or if there is no last bill date, the setup date.
2797 Useful for billing metered services.
2803 return $self->setfield('last_bill', $_[0]) if @_;
2804 return $self->getfield('last_bill') if $self->getfield('last_bill');
2805 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
2806 'edate' => $self->bill, } );
2807 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
2810 =item last_cust_pkg_reason ACTION
2812 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
2813 Returns false if there is no reason or the package is not currenly ACTION'd
2814 ACTION is one of adjourn, susp, cancel, or expire.
2818 sub last_cust_pkg_reason {
2819 my ( $self, $action ) = ( shift, shift );
2820 my $date = $self->get($action);
2822 'table' => 'cust_pkg_reason',
2823 'hashref' => { 'pkgnum' => $self->pkgnum,
2824 'action' => substr(uc($action), 0, 1),
2827 'order_by' => 'ORDER BY num DESC LIMIT 1',
2831 =item last_reason ACTION
2833 Returns the most recent ACTION FS::reason associated with the package.
2834 Returns false if there is no reason or the package is not currenly ACTION'd
2835 ACTION is one of adjourn, susp, cancel, or expire.
2840 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
2841 $cust_pkg_reason->reason
2842 if $cust_pkg_reason;
2847 Returns the definition for this billing item, as an FS::part_pkg object (see
2854 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
2855 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
2856 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
2861 Returns the cancelled package this package was changed from, if any.
2867 return '' unless $self->change_pkgnum;
2868 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
2871 =item change_cust_main
2873 Returns the customter this package was detached to, if any.
2877 sub change_cust_main {
2879 return '' unless $self->change_custnum;
2880 qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
2885 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
2892 $self->part_pkg->calc_setup($self, @_);
2897 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
2904 $self->part_pkg->calc_recur($self, @_);
2909 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
2916 $self->part_pkg->base_recur($self, @_);
2921 Calls the I<calc_remain> of the FS::part_pkg object associated with this
2928 $self->part_pkg->calc_remain($self, @_);
2933 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
2940 $self->part_pkg->calc_cancel($self, @_);
2945 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
2951 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
2954 =item cust_pkg_detail [ DETAILTYPE ]
2956 Returns any customer package details for this package (see
2957 L<FS::cust_pkg_detail>).
2959 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2963 sub cust_pkg_detail {
2965 my %hash = ( 'pkgnum' => $self->pkgnum );
2966 $hash{detailtype} = shift if @_;
2968 'table' => 'cust_pkg_detail',
2969 'hashref' => \%hash,
2970 'order_by' => 'ORDER BY weight, pkgdetailnum',
2974 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
2976 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
2978 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2980 If there is an error, returns the error, otherwise returns false.
2984 sub set_cust_pkg_detail {
2985 my( $self, $detailtype, @details ) = @_;
2987 local $SIG{HUP} = 'IGNORE';
2988 local $SIG{INT} = 'IGNORE';
2989 local $SIG{QUIT} = 'IGNORE';
2990 local $SIG{TERM} = 'IGNORE';
2991 local $SIG{TSTP} = 'IGNORE';
2992 local $SIG{PIPE} = 'IGNORE';
2994 my $oldAutoCommit = $FS::UID::AutoCommit;
2995 local $FS::UID::AutoCommit = 0;
2998 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
2999 my $error = $current->delete;
3001 $dbh->rollback if $oldAutoCommit;
3002 return "error removing old detail: $error";
3006 foreach my $detail ( @details ) {
3007 my $cust_pkg_detail = new FS::cust_pkg_detail {
3008 'pkgnum' => $self->pkgnum,
3009 'detailtype' => $detailtype,
3010 'detail' => $detail,
3012 my $error = $cust_pkg_detail->insert;
3014 $dbh->rollback if $oldAutoCommit;
3015 return "error adding new detail: $error";
3020 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3027 Returns the customer billing events (see L<FS::cust_event>) for this invoice.
3031 #false laziness w/cust_bill.pm
3035 'table' => 'cust_event',
3036 'addl_from' => 'JOIN part_event USING ( eventpart )',
3037 'hashref' => { 'tablenum' => $self->pkgnum },
3038 'extra_sql' => " AND eventtable = 'cust_pkg' ",
3042 =item num_cust_event
3044 Returns the number of customer billing events (see L<FS::cust_event>) for this package.
3048 #false laziness w/cust_bill.pm
3049 sub num_cust_event {
3051 my $sql = "SELECT COUNT(*) ". $self->_from_cust_event_where;
3052 $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref->[0];
3055 =item exists_cust_event
3057 Returns true if there are customer billing events (see L<FS::cust_event>) for this package. More efficient than using num_cust_event.
3061 sub exists_cust_event {
3063 my $sql = "SELECT 1 ". $self->_from_cust_event_where. " LIMIT 1";
3064 my $row = $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref;
3065 $row ? $row->[0] : '';
3068 sub _from_cust_event_where {
3070 " FROM cust_event JOIN part_event USING ( eventpart ) ".
3071 " WHERE tablenum = ? AND eventtable = 'cust_pkg' ";
3075 my( $self, $sql, @args ) = @_;
3076 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
3077 $sth->execute(@args) or die $sth->errstr. " executing $sql";
3081 =item cust_svc [ SVCPART ] (old, deprecated usage)
3083 =item cust_svc [ OPTION => VALUE ... ] (current usage)
3085 =item cust_svc_unsorted [ OPTION => VALUE ... ]
3087 Returns the services for this package, as FS::cust_svc objects (see
3088 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
3089 spcififed, returns only the matching services.
3091 As an optimization, use the cust_svc_unsorted version if you are not displaying
3098 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
3099 $self->_sort_cust_svc( $self->cust_svc_unsorted_arrayref(@_) );
3102 sub cust_svc_unsorted {
3104 @{ $self->cust_svc_unsorted_arrayref(@_) };
3107 sub cust_svc_unsorted_arrayref {
3110 return [] unless $self->num_cust_svc(@_);
3113 if ( @_ && $_[0] =~ /^\d+/ ) {
3114 $opt{svcpart} = shift;
3115 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3122 'table' => 'cust_svc',
3123 'hashref' => { 'pkgnum' => $self->pkgnum },
3125 if ( $opt{svcpart} ) {
3126 $search{hashref}->{svcpart} = $opt{'svcpart'};
3128 if ( $opt{'svcdb'} ) {
3129 $search{addl_from} = ' LEFT JOIN part_svc USING ( svcpart ) ';
3130 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{'svcdb'} );
3133 [ qsearch(\%search) ];
3137 =item overlimit [ SVCPART ]
3139 Returns the services for this package which have exceeded their
3140 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
3141 is specified, return only the matching services.
3147 return () unless $self->num_cust_svc(@_);
3148 grep { $_->overlimit } $self->cust_svc(@_);
3151 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3153 Returns historical services for this package created before END TIMESTAMP and
3154 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
3155 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
3156 I<pkg_svc.hidden> flag will be omitted.
3162 warn "$me _h_cust_svc called on $self\n"
3165 my ($end, $start, $mode) = @_;
3166 my @cust_svc = $self->_sort_cust_svc(
3167 [ qsearch( 'h_cust_svc',
3168 { 'pkgnum' => $self->pkgnum, },
3169 FS::h_cust_svc->sql_h_search(@_),
3172 if ( defined($mode) && $mode eq 'I' ) {
3173 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
3174 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
3180 sub _sort_cust_svc {
3181 my( $self, $arrayref ) = @_;
3184 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
3186 my %pkg_svc = map { $_->svcpart => $_ }
3187 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
3192 my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
3194 $pkg_svc ? $pkg_svc->primary_svc : '',
3195 $pkg_svc ? $pkg_svc->quantity : 0,
3202 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
3204 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
3206 Returns the number of services for this package. Available options are svcpart
3207 and svcdb. If either is spcififed, returns only the matching services.
3214 return $self->{'_num_cust_svc'}
3216 && exists($self->{'_num_cust_svc'})
3217 && $self->{'_num_cust_svc'} =~ /\d/;
3219 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
3223 if ( @_ && $_[0] =~ /^\d+/ ) {
3224 $opt{svcpart} = shift;
3225 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3231 my $select = 'SELECT COUNT(*) FROM cust_svc ';
3232 my $where = ' WHERE pkgnum = ? ';
3233 my @param = ($self->pkgnum);
3235 if ( $opt{'svcpart'} ) {
3236 $where .= ' AND svcpart = ? ';
3237 push @param, $opt{'svcpart'};
3239 if ( $opt{'svcdb'} ) {
3240 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
3241 $where .= ' AND svcdb = ? ';
3242 push @param, $opt{'svcdb'};
3245 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
3246 $sth->execute(@param) or die $sth->errstr;
3247 $sth->fetchrow_arrayref->[0];
3250 =item available_part_svc
3252 Returns a list of FS::part_svc objects representing services included in this
3253 package but not yet provisioned. Each FS::part_svc object also has an extra
3254 field, I<num_avail>, which specifies the number of available services.
3258 sub available_part_svc {
3261 my $pkg_quantity = $self->quantity || 1;
3263 grep { $_->num_avail > 0 }
3265 my $part_svc = $_->part_svc;
3266 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
3267 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
3269 # more evil encapsulation breakage
3270 if($part_svc->{'Hash'}{'num_avail'} > 0) {
3271 my @exports = $part_svc->part_export_did;
3272 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
3277 $self->part_pkg->pkg_svc;
3280 =item part_svc [ OPTION => VALUE ... ]
3282 Returns a list of FS::part_svc objects representing provisioned and available
3283 services included in this package. Each FS::part_svc object also has the
3284 following extra fields:
3298 (services) - array reference containing the provisioned services, as cust_svc objects
3302 Accepts two options:
3306 =item summarize_size
3308 If true, will omit the extra cust_pkg_svc option for objects where num_cust_svc
3309 is this size or greater.
3311 =item hide_discontinued
3313 If true, will omit looking for services that are no longer avaialble in the
3321 #label -> ($cust_svc->label)[1]
3327 my $pkg_quantity = $self->quantity || 1;
3329 #XXX some sort of sort order besides numeric by svcpart...
3330 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
3332 my $part_svc = $pkg_svc->part_svc;
3333 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3334 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
3335 $part_svc->{'Hash'}{'num_avail'} =
3336 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
3337 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3338 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
3339 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
3340 && $num_cust_svc >= $opt{summarize_size};
3341 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
3343 } $self->part_pkg->pkg_svc;
3345 unless ( $opt{hide_discontinued} ) {
3347 push @part_svc, map {
3349 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3350 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
3351 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
3352 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3353 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
3355 } $self->extra_part_svc;
3362 =item extra_part_svc
3364 Returns a list of FS::part_svc objects corresponding to services in this
3365 package which are still provisioned but not (any longer) available in the
3370 sub extra_part_svc {
3373 my $pkgnum = $self->pkgnum;
3374 #my $pkgpart = $self->pkgpart;
3377 # 'table' => 'part_svc',
3380 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
3381 # WHERE pkg_svc.svcpart = part_svc.svcpart
3382 # AND pkg_svc.pkgpart = ?
3385 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
3386 # LEFT JOIN cust_pkg USING ( pkgnum )
3387 # WHERE cust_svc.svcpart = part_svc.svcpart
3390 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
3393 #seems to benchmark slightly faster... (or did?)
3395 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
3396 my $pkgparts = join(',', @pkgparts);
3399 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
3400 #MySQL doesn't grok DISINCT ON
3401 'select' => 'DISTINCT part_svc.*',
3402 'table' => 'part_svc',
3404 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
3405 AND pkg_svc.pkgpart IN ($pkgparts)
3408 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
3409 LEFT JOIN cust_pkg USING ( pkgnum )
3412 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
3413 'extra_param' => [ [$self->pkgnum=>'int'] ],
3419 Returns a short status string for this package, currently:
3425 =item not yet billed
3427 =item one-time charge
3442 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
3444 return 'cancelled' if $self->get('cancel');
3445 return 'on hold' if $self->susp && ! $self->setup;
3446 return 'suspended' if $self->susp;
3447 return 'not yet billed' unless $self->setup;
3448 return 'one-time charge' if $freq =~ /^(0|$)/;
3452 =item ucfirst_status
3454 Returns the status with the first character capitalized.
3458 sub ucfirst_status {
3459 ucfirst(shift->status);
3464 Class method that returns the list of possible status strings for packages
3465 (see L<the status method|/status>). For example:
3467 @statuses = FS::cust_pkg->statuses();
3471 tie my %statuscolor, 'Tie::IxHash',
3472 'on hold' => 'FF00F5', #brighter purple!
3473 'not yet billed' => '009999', #teal? cyan?
3474 'one-time charge' => '0000CC', #blue #'000000',
3475 'active' => '00CC00',
3476 'suspended' => 'FF9900',
3477 'cancelled' => 'FF0000',
3481 my $self = shift; #could be class...
3482 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
3483 # # mayble split btw one-time vs. recur
3494 Returns a hex triplet color string for this package's status.
3500 $statuscolor{$self->status};
3503 =item is_status_delay_cancel
3505 Returns true if part_pkg has option delay_cancel,
3506 cust_pkg status is 'suspended' and expire is set
3507 to cancel package within the next day (or however
3508 many days are set in global config part_pkg-delay_cancel-days.
3510 This is not a real status, this only meant for hacking display
3511 values, because otherwise treating the package as suspended is
3512 really the whole point of the delay_cancel option.
3516 sub is_status_delay_cancel {
3518 if ( $self->main_pkgnum and $self->pkglinknum ) {
3519 return $self->main_pkg->is_status_delay_cancel;
3521 return 0 unless $self->part_pkg->option('delay_cancel',1);
3522 return 0 unless $self->status eq 'suspended';
3523 return 0 unless $self->expire;
3524 my $conf = new FS::Conf;
3525 my $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
3526 my $expsecs = 60*60*24*$expdays;
3527 return 0 unless $self->expire < time + $expsecs;
3533 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
3534 "pkg - comment" depending on user preference).
3540 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
3541 $label = $self->pkgnum. ": $label"
3542 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
3546 =item pkg_label_long
3548 Returns a long label for this package, adding the primary service's label to
3553 sub pkg_label_long {
3555 my $label = $self->pkg_label;
3556 my $cust_svc = $self->primary_cust_svc;
3557 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
3563 Returns a customer-localized label for this package.
3569 $self->part_pkg->pkg_locale( $self->cust_main->locale );
3572 =item primary_cust_svc
3574 Returns a primary service (as FS::cust_svc object) if one can be identified.
3578 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
3580 sub primary_cust_svc {
3583 my @cust_svc = $self->cust_svc;
3585 return '' unless @cust_svc; #no serivces - irrelevant then
3587 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
3589 # primary service as specified in the package definition
3590 # or exactly one service definition with quantity one
3591 my $svcpart = $self->part_pkg->svcpart;
3592 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
3593 return $cust_svc[0] if scalar(@cust_svc) == 1;
3595 #couldn't identify one thing..
3601 Returns a list of lists, calling the label method for all services
3602 (see L<FS::cust_svc>) of this billing item.
3608 map { [ $_->label ] } $self->cust_svc;
3611 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3613 Like the labels method, but returns historical information on services that
3614 were active as of END_TIMESTAMP and (optionally) not cancelled before
3615 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
3616 I<pkg_svc.hidden> flag will be omitted.
3618 Returns a list of lists, calling the label method for all (historical) services
3619 (see L<FS::h_cust_svc>) of this billing item.
3625 warn "$me _h_labels called on $self\n"
3627 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
3632 Like labels, except returns a simple flat list, and shortens long
3633 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3634 identical services to one line that lists the service label and the number of
3635 individual services rather than individual items.
3640 shift->_labels_short( 'labels', @_ );
3643 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
3645 Like h_labels, except returns a simple flat list, and shortens long
3646 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3647 identical services to one line that lists the service label and the number of
3648 individual services rather than individual items.
3652 sub h_labels_short {
3653 shift->_labels_short( 'h_labels', @_ );
3657 my( $self, $method ) = ( shift, shift );
3659 warn "$me _labels_short called on $self with $method method\n"
3662 my $conf = new FS::Conf;
3663 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
3665 warn "$me _labels_short populating \%labels\n"
3669 #tie %labels, 'Tie::IxHash';
3670 push @{ $labels{$_->[0]} }, $_->[1]
3671 foreach $self->$method(@_);
3673 warn "$me _labels_short populating \@labels\n"
3677 foreach my $label ( keys %labels ) {
3679 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
3680 my $num = scalar(@values);
3681 warn "$me _labels_short $num items for $label\n"
3684 if ( $num > $max_same_services ) {
3685 warn "$me _labels_short more than $max_same_services, so summarizing\n"
3687 push @labels, "$label ($num)";
3689 if ( $conf->exists('cust_bill-consolidate_services') ) {
3690 warn "$me _labels_short consolidating services\n"
3692 # push @labels, "$label: ". join(', ', @values);
3694 my $detail = "$label: ";
3695 $detail .= shift(@values). ', '
3697 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
3699 push @labels, $detail;
3701 warn "$me _labels_short done consolidating services\n"
3704 warn "$me _labels_short adding service data\n"
3706 push @labels, map { "$label: $_" } @values;
3717 Returns the parent customer object (see L<FS::cust_main>).
3723 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
3728 Returns the balance for this specific package, when using
3729 experimental package balance.
3735 $self->cust_main->balance_pkgnum( $self->pkgnum );
3738 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
3742 Returns the location object, if any (see L<FS::cust_location>).
3744 =item cust_location_or_main
3746 If this package is associated with a location, returns the locaiton (see
3747 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
3749 =item location_label [ OPTION => VALUE ... ]
3751 Returns the label of the location object (see L<FS::cust_location>).
3755 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
3757 =item tax_locationnum
3759 Returns the foreign key to a L<FS::cust_location> object for calculating
3760 tax on this package, as determined by the C<tax-pkg_address> and
3761 C<tax-ship_address> configuration flags.
3765 sub tax_locationnum {
3767 my $conf = FS::Conf->new;
3768 if ( $conf->exists('tax-pkg_address') ) {
3769 return $self->locationnum;
3771 elsif ( $conf->exists('tax-ship_address') ) {
3772 return $self->cust_main->ship_locationnum;
3775 return $self->cust_main->bill_locationnum;
3781 Returns the L<FS::cust_location> object for tax_locationnum.
3787 my $conf = FS::Conf->new;
3788 if ( $conf->exists('tax-pkg_address') and $self->locationnum ) {
3789 return FS::cust_location->by_key($self->locationnum);
3791 elsif ( $conf->exists('tax-ship_address') ) {
3792 return $self->cust_main->ship_location;
3795 return $self->cust_main->bill_location;
3799 =item seconds_since TIMESTAMP
3801 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
3802 package have been online since TIMESTAMP, according to the session monitor.
3804 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
3805 L<Time::Local> and L<Date::Parse> for conversion functions.
3810 my($self, $since) = @_;
3813 foreach my $cust_svc (
3814 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
3816 $seconds += $cust_svc->seconds_since($since);
3823 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
3825 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
3826 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
3829 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3830 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3836 sub seconds_since_sqlradacct {
3837 my($self, $start, $end) = @_;
3841 foreach my $cust_svc (
3843 my $part_svc = $_->part_svc;
3844 $part_svc->svcdb eq 'svc_acct'
3845 && scalar($part_svc->part_export_usage);
3848 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
3855 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
3857 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
3858 in this package for sessions ending between TIMESTAMP_START (inclusive) and
3862 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3863 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3868 sub attribute_since_sqlradacct {
3869 my($self, $start, $end, $attrib) = @_;
3873 foreach my $cust_svc (
3875 my $part_svc = $_->part_svc;
3876 scalar($part_svc->part_export_usage);
3879 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
3891 my( $self, $value ) = @_;
3892 if ( defined($value) ) {
3893 $self->setfield('quantity', $value);
3895 $self->getfield('quantity') || 1;
3898 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
3900 Transfers as many services as possible from this package to another package.
3902 The destination package can be specified by pkgnum by passing an FS::cust_pkg
3903 object. The destination package must already exist.
3905 Services are moved only if the destination allows services with the correct
3906 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
3907 this option with caution! No provision is made for export differences
3908 between the old and new service definitions. Probably only should be used
3909 when your exports for all service definitions of a given svcdb are identical.
3910 (attempt a transfer without it first, to move all possible svcpart-matching
3913 Any services that can't be moved remain in the original package.
3915 Returns an error, if there is one; otherwise, returns the number of services
3916 that couldn't be moved.
3921 my ($self, $dest_pkgnum, %opt) = @_;
3927 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
3928 $dest = $dest_pkgnum;
3929 $dest_pkgnum = $dest->pkgnum;
3931 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
3934 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
3936 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
3937 $target{$pkg_svc->svcpart} = $pkg_svc->quantity * ( $dest->quantity || 1 );
3940 foreach my $cust_svc ($dest->cust_svc) {
3941 $target{$cust_svc->svcpart}--;
3944 my %svcpart2svcparts = ();
3945 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3946 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
3947 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
3948 next if exists $svcpart2svcparts{$svcpart};
3949 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
3950 $svcpart2svcparts{$svcpart} = [
3952 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
3954 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
3955 'svcpart' => $_ } );
3957 $pkg_svc ? $pkg_svc->primary_svc : '',
3958 $pkg_svc ? $pkg_svc->quantity : 0,
3962 grep { $_ != $svcpart }
3964 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
3966 warn "alternates for svcpart $svcpart: ".
3967 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
3973 foreach my $cust_svc ($self->cust_svc) {
3974 my $svcnum = $cust_svc->svcnum;
3975 if($target{$cust_svc->svcpart} > 0
3976 or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
3977 $target{$cust_svc->svcpart}--;
3978 my $new = new FS::cust_svc { $cust_svc->hash };
3979 $new->pkgnum($dest_pkgnum);
3980 $error = $new->replace($cust_svc);
3981 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3983 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
3984 warn "alternates to consider: ".
3985 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
3987 my @alternate = grep {
3988 warn "considering alternate svcpart $_: ".
3989 "$target{$_} available in new package\n"
3992 } @{$svcpart2svcparts{$cust_svc->svcpart}};
3994 warn "alternate(s) found\n" if $DEBUG;
3995 my $change_svcpart = $alternate[0];
3996 $target{$change_svcpart}--;
3997 my $new = new FS::cust_svc { $cust_svc->hash };
3998 $new->svcpart($change_svcpart);
3999 $new->pkgnum($dest_pkgnum);
4000 $error = $new->replace($cust_svc);
4008 my @label = $cust_svc->label;
4009 return "service $label[1]: $error";
4015 =item grab_svcnums SVCNUM, SVCNUM ...
4017 Change the pkgnum for the provided services to this packages. If there is an
4018 error, returns the error, otherwise returns false.
4026 local $SIG{HUP} = 'IGNORE';
4027 local $SIG{INT} = 'IGNORE';
4028 local $SIG{QUIT} = 'IGNORE';
4029 local $SIG{TERM} = 'IGNORE';
4030 local $SIG{TSTP} = 'IGNORE';
4031 local $SIG{PIPE} = 'IGNORE';
4033 my $oldAutoCommit = $FS::UID::AutoCommit;
4034 local $FS::UID::AutoCommit = 0;
4037 foreach my $svcnum (@svcnum) {
4038 my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
4039 $dbh->rollback if $oldAutoCommit;
4040 return "unknown svcnum $svcnum";
4042 $cust_svc->pkgnum( $self->pkgnum );
4043 my $error = $cust_svc->replace;
4045 $dbh->rollback if $oldAutoCommit;
4050 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4057 This method is deprecated. See the I<depend_jobnum> option to the insert and
4058 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
4065 local $SIG{HUP} = 'IGNORE';
4066 local $SIG{INT} = 'IGNORE';
4067 local $SIG{QUIT} = 'IGNORE';
4068 local $SIG{TERM} = 'IGNORE';
4069 local $SIG{TSTP} = 'IGNORE';
4070 local $SIG{PIPE} = 'IGNORE';
4072 my $oldAutoCommit = $FS::UID::AutoCommit;
4073 local $FS::UID::AutoCommit = 0;
4076 foreach my $cust_svc ( $self->cust_svc ) {
4077 #false laziness w/svc_Common::insert
4078 my $svc_x = $cust_svc->svc_x;
4079 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
4080 my $error = $part_export->export_insert($svc_x);
4082 $dbh->rollback if $oldAutoCommit;
4088 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4093 =item export_pkg_change OLD_CUST_PKG
4095 Calls the "pkg_change" export action for all services attached to this package.
4099 sub export_pkg_change {
4100 my( $self, $old ) = ( shift, shift );
4102 local $SIG{HUP} = 'IGNORE';
4103 local $SIG{INT} = 'IGNORE';
4104 local $SIG{QUIT} = 'IGNORE';
4105 local $SIG{TERM} = 'IGNORE';
4106 local $SIG{TSTP} = 'IGNORE';
4107 local $SIG{PIPE} = 'IGNORE';
4109 my $oldAutoCommit = $FS::UID::AutoCommit;
4110 local $FS::UID::AutoCommit = 0;
4113 foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
4114 my $error = $svc_x->export('pkg_change', $self, $old);
4116 $dbh->rollback if $oldAutoCommit;
4121 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4128 Associates this package with a (suspension or cancellation) reason (see
4129 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
4132 Available options are:
4138 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.
4142 the access_user (see L<FS::access_user>) providing the reason
4150 the action (cancel, susp, adjourn, expire) associated with the reason
4154 If there is an error, returns the error, otherwise returns false.
4159 my ($self, %options) = @_;
4161 my $otaker = $options{reason_otaker} ||
4162 $FS::CurrentUser::CurrentUser->username;
4165 if ( $options{'reason'} =~ /^(\d+)$/ ) {
4169 } elsif ( ref($options{'reason'}) ) {
4171 return 'Enter a new reason (or select an existing one)'
4172 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
4174 my $reason = new FS::reason({
4175 'reason_type' => $options{'reason'}->{'typenum'},
4176 'reason' => $options{'reason'}->{'reason'},
4178 my $error = $reason->insert;
4179 return $error if $error;
4181 $reasonnum = $reason->reasonnum;
4184 return "Unparseable reason: ". $options{'reason'};
4187 my $cust_pkg_reason =
4188 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
4189 'reasonnum' => $reasonnum,
4190 'otaker' => $otaker,
4191 'action' => substr(uc($options{'action'}),0,1),
4192 'date' => $options{'date'}
4197 $cust_pkg_reason->insert;
4200 =item insert_discount
4202 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
4203 inserting a new discount on the fly (see L<FS::discount>).
4205 Available options are:
4213 If there is an error, returns the error, otherwise returns false.
4217 sub insert_discount {
4218 #my ($self, %options) = @_;
4221 my $cust_pkg_discount = new FS::cust_pkg_discount {
4222 'pkgnum' => $self->pkgnum,
4223 'discountnum' => $self->discountnum,
4225 'end_date' => '', #XXX
4226 #for the create a new discount case
4227 '_type' => $self->discountnum__type,
4228 'amount' => $self->discountnum_amount,
4229 'percent' => $self->discountnum_percent,
4230 'months' => $self->discountnum_months,
4231 'setup' => $self->discountnum_setup,
4232 #'disabled' => $self->discountnum_disabled,
4235 $cust_pkg_discount->insert;
4238 =item set_usage USAGE_VALUE_HASHREF
4240 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4241 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4242 upbytes, downbytes, and totalbytes are appropriate keys.
4244 All svc_accts which are part of this package have their values reset.
4249 my ($self, $valueref, %opt) = @_;
4251 #only svc_acct can set_usage for now
4252 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4253 my $svc_x = $cust_svc->svc_x;
4254 $svc_x->set_usage($valueref, %opt)
4255 if $svc_x->can("set_usage");
4259 =item recharge USAGE_VALUE_HASHREF
4261 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4262 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4263 upbytes, downbytes, and totalbytes are appropriate keys.
4265 All svc_accts which are part of this package have their values incremented.
4270 my ($self, $valueref) = @_;
4272 #only svc_acct can set_usage for now
4273 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4274 my $svc_x = $cust_svc->svc_x;
4275 $svc_x->recharge($valueref)
4276 if $svc_x->can("recharge");
4280 =item cust_pkg_discount
4284 sub cust_pkg_discount {
4286 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
4289 =item cust_pkg_discount_active
4293 sub cust_pkg_discount_active {
4295 grep { $_->status eq 'active' } $self->cust_pkg_discount;
4298 =item cust_pkg_usage
4300 Returns a list of all voice usage counters attached to this package.
4304 sub cust_pkg_usage {
4306 qsearch('cust_pkg_usage', { pkgnum => $self->pkgnum });
4309 =item apply_usage OPTIONS
4311 Takes the following options:
4312 - cdr: a call detail record (L<FS::cdr>)
4313 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
4314 - minutes: the maximum number of minutes to be charged
4316 Finds available usage minutes for a call of this class, and subtracts
4317 up to that many minutes from the usage pool. If the usage pool is empty,
4318 and the C<cdr-minutes_priority> global config option is set, minutes may
4319 be taken from other calls as well. Either way, an allocation record will
4320 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
4321 number of minutes of usage applied to the call.
4326 my ($self, %opt) = @_;
4327 my $cdr = $opt{cdr};
4328 my $rate_detail = $opt{rate_detail};
4329 my $minutes = $opt{minutes};
4330 my $classnum = $rate_detail->classnum;
4331 my $pkgnum = $self->pkgnum;
4332 my $custnum = $self->custnum;
4334 local $SIG{HUP} = 'IGNORE';
4335 local $SIG{INT} = 'IGNORE';
4336 local $SIG{QUIT} = 'IGNORE';
4337 local $SIG{TERM} = 'IGNORE';
4338 local $SIG{TSTP} = 'IGNORE';
4339 local $SIG{PIPE} = 'IGNORE';
4341 my $oldAutoCommit = $FS::UID::AutoCommit;
4342 local $FS::UID::AutoCommit = 0;
4344 my $order = FS::Conf->new->config('cdr-minutes_priority');
4348 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
4350 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
4352 my @usage_recs = qsearch({
4353 'table' => 'cust_pkg_usage',
4354 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
4355 ' JOIN cust_pkg USING (pkgnum)'.
4356 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
4357 'select' => 'cust_pkg_usage.*',
4358 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
4359 " ( cust_pkg.custnum = $custnum AND ".
4360 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4361 $is_classnum . ' AND '.
4362 " cust_pkg_usage.minutes > 0",
4363 'order_by' => " ORDER BY priority ASC",
4366 my $orig_minutes = $minutes;
4368 while (!$error and $minutes > 0 and @usage_recs) {
4369 my $cust_pkg_usage = shift @usage_recs;
4370 $cust_pkg_usage->select_for_update;
4371 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
4372 pkgusagenum => $cust_pkg_usage->pkgusagenum,
4373 acctid => $cdr->acctid,
4374 minutes => min($cust_pkg_usage->minutes, $minutes),
4376 $cust_pkg_usage->set('minutes',
4377 $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes
4379 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
4380 $minutes -= $cdr_cust_pkg_usage->minutes;
4382 if ( $order and $minutes > 0 and !$error ) {
4383 # then try to steal minutes from another call
4385 'table' => 'cdr_cust_pkg_usage',
4386 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
4387 ' JOIN part_pkg_usage USING (pkgusagepart)'.
4388 ' JOIN cust_pkg USING (pkgnum)'.
4389 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
4390 ' JOIN cdr USING (acctid)',
4391 'select' => 'cdr_cust_pkg_usage.*',
4392 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
4393 " ( cust_pkg.pkgnum = $pkgnum OR ".
4394 " ( cust_pkg.custnum = $custnum AND ".
4395 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4396 " part_pkg_usage_class.classnum = $classnum",
4397 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
4399 if ( $order eq 'time' ) {
4400 # find CDRs that are using minutes, but have a later startdate
4402 my $startdate = $cdr->startdate;
4403 if ($startdate !~ /^\d+$/) {
4404 die "bad cdr startdate '$startdate'";
4406 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
4407 # minimize needless reshuffling
4408 $search{'order_by'} .= ', cdr.startdate DESC';
4410 # XXX may not work correctly with rate_time schedules. Could
4411 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
4413 $search{'addl_from'} .=
4414 ' JOIN rate_detail'.
4415 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
4416 if ( $order eq 'rate_high' ) {
4417 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
4418 $rate_detail->min_charge;
4419 $search{'order_by'} .= ', rate_detail.min_charge ASC';
4420 } elsif ( $order eq 'rate_low' ) {
4421 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
4422 $rate_detail->min_charge;
4423 $search{'order_by'} .= ', rate_detail.min_charge DESC';
4425 # this should really never happen
4426 die "invalid cdr-minutes_priority value '$order'\n";
4429 my @cdr_usage_recs = qsearch(\%search);
4431 while (!$error and @cdr_usage_recs and $minutes > 0) {
4432 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
4433 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
4434 my $old_cdr = $cdr_cust_pkg_usage->cdr;
4435 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
4436 $cdr_cust_pkg_usage->select_for_update;
4437 $old_cdr->select_for_update;
4438 $cust_pkg_usage->select_for_update;
4439 # in case someone else stole the usage from this CDR
4440 # while waiting for the lock...
4441 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
4442 # steal the usage allocation and flag the old CDR for reprocessing
4443 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
4444 # if the allocation is more minutes than we need, adjust it...
4445 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
4447 $cdr_cust_pkg_usage->set('minutes', $minutes);
4448 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
4449 $error = $cust_pkg_usage->replace;
4451 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
4452 $error ||= $cdr_cust_pkg_usage->replace;
4453 # deduct the stolen minutes
4454 $minutes -= $cdr_cust_pkg_usage->minutes;
4456 # after all minute-stealing is done, reset the affected CDRs
4457 foreach (values %reproc_cdrs) {
4458 $error ||= $_->set_status('');
4459 # XXX or should we just call $cdr->rate right here?
4460 # it's not like we can create a loop this way, since the min_charge
4461 # or call time has to go monotonically in one direction.
4462 # we COULD get some very deep recursions going, though...
4464 } # if $order and $minutes
4467 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
4469 $dbh->commit if $oldAutoCommit;
4470 return $orig_minutes - $minutes;
4474 =item supplemental_pkgs
4476 Returns a list of all packages supplemental to this one.
4480 sub supplemental_pkgs {
4482 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
4487 Returns the package that this one is supplemental to, if any.
4493 if ( $self->main_pkgnum ) {
4494 return FS::cust_pkg->by_key($self->main_pkgnum);
4501 =head1 CLASS METHODS
4507 Returns an SQL expression identifying recurring packages.
4511 sub recurring_sql { "
4512 '0' != ( select freq from part_pkg
4513 where cust_pkg.pkgpart = part_pkg.pkgpart )
4518 Returns an SQL expression identifying one-time packages.
4523 '0' = ( select freq from part_pkg
4524 where cust_pkg.pkgpart = part_pkg.pkgpart )
4529 Returns an SQL expression identifying ordered packages (recurring packages not
4535 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
4540 Returns an SQL expression identifying active packages.
4545 $_[0]->recurring_sql. "
4546 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4547 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4548 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4551 =item not_yet_billed_sql
4553 Returns an SQL expression identifying packages which have not yet been billed.
4557 sub not_yet_billed_sql { "
4558 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4559 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4560 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4565 Returns an SQL expression identifying inactive packages (one-time packages
4566 that are otherwise unsuspended/uncancelled).
4570 sub inactive_sql { "
4571 ". $_[0]->onetime_sql(). "
4572 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4573 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4574 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4579 Returns an SQL expression identifying on-hold packages.
4584 #$_[0]->recurring_sql(). ' AND '.
4586 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4587 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4588 AND ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4595 Returns an SQL expression identifying suspended packages.
4599 sub suspended_sql { susp_sql(@_); }
4601 #$_[0]->recurring_sql(). ' AND '.
4603 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4604 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4605 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4612 Returns an SQL exprression identifying cancelled packages.
4616 sub cancelled_sql { cancel_sql(@_); }
4618 #$_[0]->recurring_sql(). ' AND '.
4619 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
4624 Returns an SQL expression to give the package status as a string.
4630 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
4631 WHEN ( cust_pkg.susp IS NOT NULL AND cust_pkg.setup IS NULL ) THEN 'on hold'
4632 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
4633 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
4634 WHEN ".onetime_sql()." THEN 'one-time charge'
4639 =item search HASHREF
4643 Returns a qsearch hash expression to search for parameters specified in HASHREF.
4644 Valid parameters are
4652 on hold, active, inactive (or one-time charge), suspended, canceled (or cancelled)
4656 Equivalent to "status", except that "canceled"/"cancelled" will exclude
4657 packages that were changed into a new package with the same pkgpart (i.e.
4658 location or quantity changes).
4662 boolean selects custom packages
4668 pkgpart or arrayref or hashref of pkgparts
4672 arrayref of beginning and ending epoch date
4676 arrayref of beginning and ending epoch date
4680 arrayref of beginning and ending epoch date
4684 arrayref of beginning and ending epoch date
4688 arrayref of beginning and ending epoch date
4692 arrayref of beginning and ending epoch date
4696 arrayref of beginning and ending epoch date
4700 pkgnum or APKG_pkgnum
4704 a value suited to passing to FS::UI::Web::cust_header
4708 specifies the user for agent virtualization
4712 boolean; if true, returns only packages with more than 0 FCC phone lines.
4714 =item state, country
4716 Limit to packages with a service location in the specified state and country.
4717 For FCC 477 reporting, mostly.
4721 Limit to packages whose service locations are the same as the customer's
4722 default service location.
4724 =item location_nocust
4726 Limit to packages whose service locations are not the customer's default
4729 =item location_census
4731 Limit to packages whose service locations have census tracts.
4733 =item location_nocensus
4735 Limit to packages whose service locations do not have a census tract.
4737 =item location_geocode
4739 Limit to packages whose locations have geocodes.
4741 =item location_geocode
4743 Limit to packages whose locations do not have geocodes.
4747 Limit to packages associated with a svc_broadband, associated with a sector,
4748 associated with this towernum (or any of these, if it's an arrayref) (or NO
4749 towernum, if it's zero). This is an extreme niche case.
4751 =item 477part, 477rownum, date
4753 Limit to packages included in a specific row of one of the FCC 477 reports.
4754 '477part' is the section name (see L<FS::Report::FCC_477> methods), 'date'
4755 is the report as-of date (completely unrelated to the package setup/bill/
4756 other date fields), and '477rownum' is the row number of the report starting
4757 with zero. Row numbers have no inherent meaning, so this is useful only
4758 for explaining a 477 report you've already run.
4765 my ($class, $params) = @_;
4772 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
4774 "cust_main.agentnum = $1";
4781 if ( $params->{'cust_status'} =~ /^([a-z]+)$/ ) {
4782 push @where, FS::cust_main->cust_status_sql . " = '$1' ";
4786 # parse customer sales person
4789 if ( $params->{'cust_main_salesnum'} =~ /^(\d+)$/ ) {
4790 push @where, ($1 > 0) ? "cust_main.salesnum = $1"
4791 : 'cust_main.salesnum IS NULL';
4796 # parse sales person
4799 if ( $params->{'salesnum'} =~ /^(\d+)$/ ) {
4800 push @where, ($1 > 0) ? "cust_pkg.salesnum = $1"
4801 : 'cust_pkg.salesnum IS NULL';
4808 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
4810 "cust_pkg.custnum = $1";
4817 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
4819 "cust_pkg.pkgbatch = '$1'";
4826 if ( $params->{'magic'} eq 'active'
4827 || $params->{'status'} eq 'active' ) {
4829 push @where, FS::cust_pkg->active_sql();
4831 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
4832 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
4834 push @where, FS::cust_pkg->not_yet_billed_sql();
4836 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
4837 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
4839 push @where, FS::cust_pkg->inactive_sql();
4841 } elsif ( $params->{'magic'} =~ /^on[ _]hold$/
4842 || $params->{'status'} =~ /^on[ _]hold$/ ) {
4844 push @where, FS::cust_pkg->on_hold_sql();
4847 } elsif ( $params->{'magic'} eq 'suspended'
4848 || $params->{'status'} eq 'suspended' ) {
4850 push @where, FS::cust_pkg->suspended_sql();
4852 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
4853 || $params->{'status'} =~ /^cancell?ed$/ ) {
4855 push @where, FS::cust_pkg->cancelled_sql();
4859 ### special case: "magic" is used in detail links from browse/part_pkg,
4860 # where "cancelled" has the restriction "and not replaced with a package
4861 # of the same pkgpart". Be consistent with that.
4864 if ( $params->{'magic'} =~ /^cancell?ed$/ ) {
4865 my $new_pkgpart = "SELECT pkgpart FROM cust_pkg AS cust_pkg_next ".
4866 "WHERE cust_pkg_next.change_pkgnum = cust_pkg.pkgnum";
4867 # ...may not exist, if this was just canceled and not changed; in that
4868 # case give it a "new pkgpart" that never equals the old pkgpart
4869 push @where, "COALESCE(($new_pkgpart), 0) != cust_pkg.pkgpart";
4873 # parse package class
4876 if ( exists($params->{'classnum'}) ) {
4879 if ( ref($params->{'classnum'}) ) {
4881 if ( ref($params->{'classnum'}) eq 'HASH' ) {
4882 @classnum = grep $params->{'classnum'}{$_}, keys %{ $params->{'classnum'} };
4883 } elsif ( ref($params->{'classnum'}) eq 'ARRAY' ) {
4884 @classnum = @{ $params->{'classnum'} };
4886 die 'unhandled classnum ref '. $params->{'classnum'};
4890 } elsif ( $params->{'classnum'} =~ /^(\d*)$/ && $1 ne '0' ) {
4897 my @nums = grep $_, @classnum;
4898 push @c_where, 'part_pkg.classnum IN ('. join(',',@nums). ')' if @nums;
4899 my $null = scalar( grep { $_ eq '' } @classnum );
4900 push @c_where, 'part_pkg.classnum IS NULL' if $null;
4902 if ( scalar(@c_where) == 1 ) {
4903 push @where, @c_where;
4904 } elsif ( @c_where ) {
4905 push @where, ' ( '. join(' OR ', @c_where). ' ) ';
4914 # parse refnum (advertising source)
4917 if ( exists($params->{'refnum'}) ) {
4919 if (ref $params->{'refnum'}) {
4920 @refnum = @{ $params->{'refnum'} };
4922 @refnum = ( $params->{'refnum'} );
4924 my $in = join(',', grep /^\d+$/, @refnum);
4925 push @where, "refnum IN($in)" if length $in;
4929 # parse package report options
4932 my @report_option = ();
4933 if ( exists($params->{'report_option'}) ) {
4934 if ( ref($params->{'report_option'}) eq 'ARRAY' ) {
4935 @report_option = @{ $params->{'report_option'} };
4936 } elsif ( $params->{'report_option'} =~ /^([,\d]*)$/ ) {
4937 @report_option = split(',', $1);
4942 if (@report_option) {
4943 # this will result in the empty set for the dangling comma case as it should
4945 map{ "0 < ( SELECT count(*) FROM part_pkg_option
4946 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
4947 AND optionname = 'report_option_$_'
4948 AND optionvalue = '1' )"
4952 foreach my $any ( grep /^report_option_any/, keys %$params ) {
4954 my @report_option_any = ();
4955 if ( ref($params->{$any}) eq 'ARRAY' ) {
4956 @report_option_any = @{ $params->{$any} };
4957 } elsif ( $params->{$any} =~ /^([,\d]*)$/ ) {
4958 @report_option_any = split(',', $1);
4961 if (@report_option_any) {
4962 # this will result in the empty set for the dangling comma case as it should
4963 push @where, ' ( '. join(' OR ',
4964 map{ "0 < ( SELECT count(*) FROM part_pkg_option
4965 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
4966 AND optionname = 'report_option_$_'
4967 AND optionvalue = '1' )"
4968 } @report_option_any
4978 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
4984 push @where, "(part_pkg.fcc_ds0s > 0 OR pkg_class.fcc_ds0s > 0)"
4985 if $params->{fcc_line};
4991 if ( exists($params->{'censustract'}) ) {
4992 $params->{'censustract'} =~ /^([.\d]*)$/;
4993 my $censustract = "cust_location.censustract = '$1'";
4994 $censustract .= ' OR cust_location.censustract is NULL' unless $1;
4995 push @where, "( $censustract )";
4999 # parse censustract2
5001 if ( exists($params->{'censustract2'})
5002 && $params->{'censustract2'} =~ /^(\d*)$/
5006 push @where, "cust_location.censustract LIKE '$1%'";
5009 "( cust_location.censustract = '' OR cust_location.censustract IS NULL )";
5014 # parse country/state/zip
5016 for (qw(state country)) { # parsing rules are the same for these
5017 if ( exists($params->{$_})
5018 && uc($params->{$_}) =~ /^([A-Z]{2})$/ )
5020 # XXX post-2.3 only--before that, state/country may be in cust_main
5021 push @where, "cust_location.$_ = '$1'";
5024 if ( exists($params->{zip}) ) {
5025 push @where, "cust_location.zip = " . dbh->quote($params->{zip});
5031 if ( $params->{location_cust} xor $params->{location_nocust} ) {
5032 my $op = $params->{location_cust} ? '=' : '!=';
5033 push @where, "cust_location.locationnum $op cust_main.ship_locationnum";
5035 if ( $params->{location_census} xor $params->{location_nocensus} ) {
5036 my $op = $params->{location_census} ? "IS NOT NULL" : "IS NULL";
5037 push @where, "cust_location.censustract $op";
5039 if ( $params->{location_geocode} xor $params->{location_nogeocode} ) {
5040 my $op = $params->{location_geocode} ? "IS NOT NULL" : "IS NULL";
5041 push @where, "cust_location.geocode $op";
5048 if ( ref($params->{'pkgpart'}) ) {
5051 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
5052 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
5053 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
5054 @pkgpart = @{ $params->{'pkgpart'} };
5056 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
5059 @pkgpart = grep /^(\d+)$/, @pkgpart;
5061 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
5063 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
5064 push @where, "pkgpart = $1";
5073 #false laziness w/report_cust_pkg.html
5076 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
5077 'active' => { 'susp'=>1, 'cancel'=>1 },
5078 'suspended' => { 'cancel' => 1 },
5083 if( exists($params->{'active'} ) ) {
5084 # This overrides all the other date-related fields, and includes packages
5085 # that were active at some time during the interval. It excludes:
5086 # - packages that were set up after the end of the interval
5087 # - packages that were canceled before the start of the interval
5088 # - packages that were suspended before the start of the interval
5089 # and are still suspended now
5090 my($beginning, $ending) = @{$params->{'active'}};
5092 "cust_pkg.setup IS NOT NULL",
5093 "cust_pkg.setup <= $ending",
5094 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
5095 "(cust_pkg.susp IS NULL OR cust_pkg.susp >= $beginning )",
5096 "NOT (".FS::cust_pkg->onetime_sql . ")";
5099 my $exclude_change_from = 0;
5100 my $exclude_change_to = 0;
5102 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end change_date cancel )) {
5104 next unless exists($params->{$field});
5106 my($beginning, $ending) = @{$params->{$field}};
5108 next if $beginning == 0 && $ending == 4294967295;
5111 "cust_pkg.$field IS NOT NULL",
5112 "cust_pkg.$field >= $beginning",
5113 "cust_pkg.$field <= $ending";
5115 $orderby ||= "ORDER BY cust_pkg.$field";
5117 if ( $field eq 'setup' ) {
5118 $exclude_change_from = 1;
5119 } elsif ( $field eq 'cancel' ) {
5120 $exclude_change_to = 1;
5121 } elsif ( $field eq 'change_date' ) {
5122 # if we are given setup and change_date ranges, and the setup date
5123 # falls in _both_ ranges, then include the package whether it was
5125 $exclude_change_from = 0;
5129 if ($exclude_change_from) {
5130 push @where, "change_pkgnum IS NULL";
5132 if ($exclude_change_to) {
5133 # a join might be more efficient here
5134 push @where, "NOT EXISTS(
5135 SELECT 1 FROM cust_pkg AS changed_to_pkg
5136 WHERE cust_pkg.pkgnum = changed_to_pkg.change_pkgnum
5141 $orderby ||= 'ORDER BY bill';
5144 # parse magic, legacy, etc.
5147 if ( $params->{'magic'} &&
5148 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
5151 $orderby = 'ORDER BY pkgnum';
5153 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
5154 push @where, "pkgpart = $1";
5157 } elsif ( $params->{'query'} eq 'pkgnum' ) {
5159 $orderby = 'ORDER BY pkgnum';
5161 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
5163 $orderby = 'ORDER BY pkgnum';
5166 SELECT count(*) FROM pkg_svc
5167 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
5168 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
5169 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
5170 AND cust_svc.svcpart = pkg_svc.svcpart
5177 # parse the extremely weird 'towernum' param
5180 if ($params->{towernum}) {
5181 my $towernum = $params->{towernum};
5182 $towernum = [ $towernum ] if !ref($towernum);
5183 my $in = join(',', grep /^\d+$/, @$towernum);
5185 # inefficient, but this is an obscure feature
5186 eval "use FS::Report::Table";
5187 FS::Report::Table->_init_tower_pkg_cache; # probably does nothing
5188 push @where, "EXISTS(
5189 SELECT 1 FROM tower_pkg_cache
5190 WHERE tower_pkg_cache.pkgnum = cust_pkg.pkgnum
5191 AND tower_pkg_cache.towernum IN ($in)
5197 # parse the 477 report drill-down options
5200 if ($params->{'477part'} =~ /^([a-z]+)$/) {
5202 my ($date, $rownum, $agentnum);
5203 if ($params->{'date'} =~ /^(\d+)$/) {
5206 if ($params->{'477rownum'} =~ /^(\d+)$/) {
5209 if ($params->{'agentnum'} =~ /^(\d+)$/) {
5212 if ($date and defined($rownum)) {
5213 my $report = FS::Report::FCC_477->report($section,
5215 'agentnum' => $agentnum,
5218 my $pkgnums = $report->{detail}->[$rownum]
5219 or die "row $rownum is past the end of the report";
5220 # '0' so that if there are no pkgnums (empty string) it will create
5221 # a valid query that returns nothing
5222 warn "PKGNUMS:\n$pkgnums\n\n"; # XXX debug
5224 # and this overrides everything
5225 @where = ( "cust_pkg.pkgnum IN($pkgnums)" );
5226 } # else we're missing some params, ignore the whole business
5230 # setup queries, links, subs, etc. for the search
5233 # here is the agent virtualization
5234 if ($params->{CurrentUser}) {
5236 qsearchs('access_user', { username => $params->{CurrentUser} });
5239 push @where, $access_user->agentnums_sql('table'=>'cust_main');
5244 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
5247 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
5249 my $addl_from = 'LEFT JOIN part_pkg USING ( pkgpart ) '.
5250 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) '.
5251 'LEFT JOIN cust_location USING ( locationnum ) '.
5252 FS::UI::Web::join_cust_main('cust_pkg', 'cust_pkg');
5256 if ( $params->{'select_zip5'} ) {
5257 my $zip = 'cust_location.zip';
5259 $select = "DISTINCT substr($zip,1,5) as zip";
5260 $orderby = "ORDER BY substr($zip,1,5)";
5261 $count_query = "SELECT COUNT( DISTINCT substr($zip,1,5) )";
5263 $select = join(', ',
5265 ( map "part_pkg.$_", qw( pkg freq ) ),
5266 'pkg_class.classname',
5267 'cust_main.custnum AS cust_main_custnum',
5268 FS::UI::Web::cust_sql_fields(
5269 $params->{'cust_fields'}
5272 $count_query = 'SELECT COUNT(*)';
5275 $count_query .= " FROM cust_pkg $addl_from $extra_sql";
5278 'table' => 'cust_pkg',
5280 'select' => $select,
5281 'extra_sql' => $extra_sql,
5282 'order_by' => $orderby,
5283 'addl_from' => $addl_from,
5284 'count_query' => $count_query,
5291 Returns a list of two package counts. The first is a count of packages
5292 based on the supplied criteria and the second is the count of residential
5293 packages with those same criteria. Criteria are specified as in the search
5299 my ($class, $params) = @_;
5301 my $sql_query = $class->search( $params );
5303 my $count_sql = delete($sql_query->{'count_query'});
5304 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
5305 or die "couldn't parse count_sql";
5307 my $count_sth = dbh->prepare($count_sql)
5308 or die "Error preparing $count_sql: ". dbh->errstr;
5310 or die "Error executing $count_sql: ". $count_sth->errstr;
5311 my $count_arrayref = $count_sth->fetchrow_arrayref;
5313 return ( @$count_arrayref );
5317 =item tax_locationnum_sql
5319 Returns an SQL expression for the tax location for a package, based
5320 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
5324 sub tax_locationnum_sql {
5325 my $conf = FS::Conf->new;
5326 if ( $conf->exists('tax-pkg_address') ) {
5327 'cust_pkg.locationnum';
5329 elsif ( $conf->exists('tax-ship_address') ) {
5330 'cust_main.ship_locationnum';
5333 'cust_main.bill_locationnum';
5339 Returns a list: the first item is an SQL fragment identifying matching
5340 packages/customers via location (taking into account shipping and package
5341 address taxation, if enabled), and subsequent items are the parameters to
5342 substitute for the placeholders in that fragment.
5347 my($class, %opt) = @_;
5348 my $ornull = $opt{'ornull'};
5350 my $conf = new FS::Conf;
5352 # '?' placeholders in _location_sql_where
5353 my $x = $ornull ? 3 : 2;
5364 if ( $conf->exists('tax-ship_address') ) {
5367 ( ( ship_last IS NULL OR ship_last = '' )
5368 AND ". _location_sql_where('cust_main', '', $ornull ). "
5370 OR ( ship_last IS NOT NULL AND ship_last != ''
5371 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
5374 # AND payby != 'COMP'
5376 @main_param = ( @bill_param, @bill_param );
5380 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
5381 @main_param = @bill_param;
5387 if ( $conf->exists('tax-pkg_address') ) {
5389 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
5392 ( cust_pkg.locationnum IS NULL AND $main_where )
5393 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
5396 @param = ( @main_param, @bill_param );
5400 $where = $main_where;
5401 @param = @main_param;
5409 #subroutine, helper for location_sql
5410 sub _location_sql_where {
5412 my $prefix = @_ ? shift : '';
5413 my $ornull = @_ ? shift : '';
5415 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
5417 $ornull = $ornull ? ' OR ? IS NULL ' : '';
5419 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
5420 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
5421 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
5423 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
5425 # ( $table.${prefix}city = ? $or_empty_city $ornull )
5427 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
5428 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
5429 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
5430 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
5431 AND $table.${prefix}country = ?
5436 my( $self, $what ) = @_;
5438 my $what_show_zero = $what. '_show_zero';
5439 length($self->$what_show_zero())
5440 ? ($self->$what_show_zero() eq 'Y')
5441 : $self->part_pkg->$what_show_zero();
5448 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
5450 Bulk cancel + order subroutine. Perhaps slightly deprecated, only used by the
5451 bulk cancel+order in the web UI and nowhere else (edit/process/cust_pkg.cgi)
5453 CUSTNUM is a customer (see L<FS::cust_main>)
5455 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5456 L<FS::part_pkg>) to order for this customer. Duplicates are of course
5459 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
5460 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
5461 new billing items. An error is returned if this is not possible (see
5462 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
5465 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5466 newly-created cust_pkg objects.
5468 REFNUM, if specified, will specify the FS::pkg_referral record to be created
5469 and inserted. Multiple FS::pkg_referral records can be created by
5470 setting I<refnum> to an array reference of refnums or a hash reference with
5471 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
5472 record will be created corresponding to cust_main.refnum.
5477 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
5479 my $conf = new FS::Conf;
5481 # Transactionize this whole mess
5482 local $SIG{HUP} = 'IGNORE';
5483 local $SIG{INT} = 'IGNORE';
5484 local $SIG{QUIT} = 'IGNORE';
5485 local $SIG{TERM} = 'IGNORE';
5486 local $SIG{TSTP} = 'IGNORE';
5487 local $SIG{PIPE} = 'IGNORE';
5489 my $oldAutoCommit = $FS::UID::AutoCommit;
5490 local $FS::UID::AutoCommit = 0;
5494 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
5495 # return "Customer not found: $custnum" unless $cust_main;
5497 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
5500 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5503 my $change = scalar(@old_cust_pkg) != 0;
5506 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
5508 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
5509 " to pkgpart ". $pkgparts->[0]. "\n"
5512 my $err_or_cust_pkg =
5513 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
5514 'refnum' => $refnum,
5517 unless (ref($err_or_cust_pkg)) {
5518 $dbh->rollback if $oldAutoCommit;
5519 return $err_or_cust_pkg;
5522 push @$return_cust_pkg, $err_or_cust_pkg;
5523 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5528 # Create the new packages.
5529 foreach my $pkgpart (@$pkgparts) {
5531 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
5533 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
5534 pkgpart => $pkgpart,
5538 $error = $cust_pkg->insert( 'change' => $change );
5539 push @$return_cust_pkg, $cust_pkg;
5541 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
5542 my $supp_pkg = FS::cust_pkg->new({
5543 custnum => $custnum,
5544 pkgpart => $link->dst_pkgpart,
5546 main_pkgnum => $cust_pkg->pkgnum,
5549 $error ||= $supp_pkg->insert( 'change' => $change );
5550 push @$return_cust_pkg, $supp_pkg;
5554 $dbh->rollback if $oldAutoCommit;
5559 # $return_cust_pkg now contains refs to all of the newly
5562 # Transfer services and cancel old packages.
5563 foreach my $old_pkg (@old_cust_pkg) {
5565 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
5568 foreach my $new_pkg (@$return_cust_pkg) {
5569 $error = $old_pkg->transfer($new_pkg);
5570 if ($error and $error == 0) {
5571 # $old_pkg->transfer failed.
5572 $dbh->rollback if $oldAutoCommit;
5577 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
5578 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
5579 foreach my $new_pkg (@$return_cust_pkg) {
5580 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
5581 if ($error and $error == 0) {
5582 # $old_pkg->transfer failed.
5583 $dbh->rollback if $oldAutoCommit;
5590 # Transfers were successful, but we went through all of the
5591 # new packages and still had services left on the old package.
5592 # We can't cancel the package under the circumstances, so abort.
5593 $dbh->rollback if $oldAutoCommit;
5594 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
5596 $error = $old_pkg->cancel( quiet=>1, 'no_delay_cancel'=>1 );
5602 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5606 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
5608 A bulk change method to change packages for multiple customers.
5610 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5611 L<FS::part_pkg>) to order for each customer. Duplicates are of course
5614 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
5615 replace. The services (see L<FS::cust_svc>) are moved to the
5616 new billing items. An error is returned if this is not possible (see
5619 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5620 newly-created cust_pkg objects.
5625 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
5627 # Transactionize this whole mess
5628 local $SIG{HUP} = 'IGNORE';
5629 local $SIG{INT} = 'IGNORE';
5630 local $SIG{QUIT} = 'IGNORE';
5631 local $SIG{TERM} = 'IGNORE';
5632 local $SIG{TSTP} = 'IGNORE';
5633 local $SIG{PIPE} = 'IGNORE';
5635 my $oldAutoCommit = $FS::UID::AutoCommit;
5636 local $FS::UID::AutoCommit = 0;
5640 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5643 while(scalar(@old_cust_pkg)) {
5645 my $custnum = $old_cust_pkg[0]->custnum;
5646 my (@remove) = map { $_->pkgnum }
5647 grep { $_->custnum == $custnum } @old_cust_pkg;
5648 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
5650 my $error = order $custnum, $pkgparts, \@remove, \@return;
5652 push @errors, $error
5654 push @$return_cust_pkg, @return;
5657 if (scalar(@errors)) {
5658 $dbh->rollback if $oldAutoCommit;
5659 return join(' / ', @errors);
5662 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5666 # Used by FS::Upgrade to migrate to a new database.
5667 sub _upgrade_data { # class method
5668 my ($class, %opts) = @_;
5669 $class->_upgrade_otaker(%opts);
5671 # RT#10139, bug resulting in contract_end being set when it shouldn't
5672 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
5673 # RT#10830, bad calculation of prorate date near end of year
5674 # the date range for bill is December 2009, and we move it forward
5675 # one year if it's before the previous bill date (which it should
5677 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
5678 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
5679 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
5680 # RT6628, add order_date to cust_pkg
5681 'update cust_pkg set order_date = (select history_date from h_cust_pkg
5682 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
5683 history_action = \'insert\') where order_date is null',
5685 foreach my $sql (@statements) {
5686 my $sth = dbh->prepare($sql);
5687 $sth->execute or die $sth->errstr;
5690 # RT31194: supplemental package links that are deleted don't clean up
5692 my @pkglinknums = qsearch({
5693 'select' => 'DISTINCT cust_pkg.pkglinknum',
5694 'table' => 'cust_pkg',
5695 'addl_from' => ' LEFT JOIN part_pkg_link USING (pkglinknum) ',
5696 'extra_sql' => ' WHERE cust_pkg.pkglinknum IS NOT NULL
5697 AND part_pkg_link.pkglinknum IS NULL',
5699 foreach (@pkglinknums) {
5700 my $pkglinknum = $_->pkglinknum;
5701 warn "cleaning part_pkg_link #$pkglinknum\n";
5702 my $part_pkg_link = FS::part_pkg_link->new({pkglinknum => $pkglinknum});
5703 my $error = $part_pkg_link->remove_linked;
5704 die $error if $error;
5712 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
5714 In sub order, the @pkgparts array (passed by reference) is clobbered.
5716 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
5717 method to pass dates to the recur_prog expression, it should do so.
5719 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
5720 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
5721 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
5722 configuration values. Probably need a subroutine which decides what to do
5723 based on whether or not we've fetched the user yet, rather than a hash. See
5724 FS::UID and the TODO.
5726 Now that things are transactional should the check in the insert method be
5731 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
5732 L<FS::pkg_svc>, schema.html from the base documentation