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 if ( $options{'reason'} ) {
1372 $error = $self->insert_reason( 'reason' => $options{'reason'},
1373 'action' => $date ? 'adjourn' : 'suspend',
1374 'date' => $date ? $date : $suspend_time,
1375 'reason_otaker' => $options{'reason_otaker'},
1378 dbh->rollback if $oldAutoCommit;
1379 return "Error inserting cust_pkg_reason: $error";
1383 # if a reasonnum was passed, get the actual reason object so we can check
1385 # (passing a reason hashref is still allowed, but it can't be used with
1386 # the fancy behavioral options.)
1389 if ($options{'reason'} =~ /^\d+$/) {
1390 $reason = FS::reason->by_key($options{'reason'});
1393 my %hash = $self->hash;
1395 $hash{'adjourn'} = $date;
1397 $hash{'susp'} = $suspend_time;
1400 my $resume_date = $options{'resume_date'} || 0;
1401 if ( $resume_date > ($date || $suspend_time) ) {
1402 $hash{'resume'} = $resume_date;
1405 $options{options} ||= {};
1407 my $new = new FS::cust_pkg ( \%hash );
1408 $error = $new->replace( $self, options => { $self->options,
1409 %{ $options{options} },
1413 $dbh->rollback if $oldAutoCommit;
1417 unless ( $date ) { # then we are suspending now
1419 unless ($options{'from_cancel'}) {
1420 # credit remaining time if appropriate
1421 # (if required by the package def, or the suspend reason)
1422 my $unused_credit = $self->part_pkg->option('unused_credit_suspend',1)
1423 || ( defined($reason) && $reason->unused_credit );
1425 if ( $unused_credit ) {
1426 warn "crediting unused time on pkg#".$self->pkgnum."\n" if $DEBUG;
1427 my $error = $self->credit_remaining('suspend', $suspend_time);
1429 $dbh->rollback if $oldAutoCommit;
1437 foreach my $cust_svc (
1438 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1440 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1442 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1443 $dbh->rollback if $oldAutoCommit;
1444 return "Illegal svcdb value in part_svc!";
1447 require "FS/$svcdb.pm";
1449 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1451 $error = $svc->suspend;
1453 $dbh->rollback if $oldAutoCommit;
1456 my( $label, $value ) = $cust_svc->label;
1457 push @labels, "$label: $value";
1461 my $conf = new FS::Conf;
1462 if ( $conf->config('suspend_email_admin') && !$options{'from_cancel'} ) {
1464 my $error = send_email(
1465 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1466 #invoice_from ??? well as good as any
1467 'to' => $conf->config('suspend_email_admin'),
1468 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1470 "This is an automatic message from your Freeside installation\n",
1471 "informing you that the following customer package has been suspended:\n",
1473 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1474 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1475 ( map { "Service : $_\n" } @labels ),
1477 'custnum' => $self->custnum,
1478 'msgtype' => 'admin'
1482 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1490 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1491 $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1493 $dbh->rollback if $oldAutoCommit;
1494 return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1498 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1503 =item credit_remaining MODE TIME
1505 Generate a credit for this package for the time remaining in the current
1506 billing period. MODE is either "suspend" or "cancel" (determines the
1507 credit type). TIME is the time of suspension/cancellation. Both arguments
1512 # Implementation note:
1514 # If you pkgpart-change a package that has been billed, and it's set to give
1515 # credit on package change, then this method gets called and then the new
1516 # package will have no last_bill date. Therefore the customer will be credited
1517 # only once (per billing period) even if there are multiple package changes.
1519 # If you location-change a package that has been billed, this method will NOT
1520 # be called and the new package WILL have the last bill date of the old
1523 # If the new package is then canceled within the same billing cycle,
1524 # credit_remaining needs to run calc_remain on the OLD package to determine
1525 # the amount of unused time to credit.
1527 sub credit_remaining {
1528 # Add a credit for remaining service
1529 my ($self, $mode, $time) = @_;
1530 die 'credit_remaining requires suspend or cancel'
1531 unless $mode eq 'suspend' or $mode eq 'cancel';
1532 die 'no suspend/cancel time' unless $time > 0;
1534 my $conf = FS::Conf->new;
1535 my $reason_type = $conf->config($mode.'_credit_type');
1537 my $last_bill = $self->getfield('last_bill') || 0;
1538 my $next_bill = $self->getfield('bill') || 0;
1539 if ( $last_bill > 0 # the package has been billed
1540 and $next_bill > 0 # the package has a next bill date
1541 and $next_bill >= $time # which is in the future
1543 my $remaining_value = 0;
1545 my $remain_pkg = $self;
1546 $remaining_value = $remain_pkg->calc_remain('time' => $time);
1548 # we may have to walk back past some package changes to get to the
1549 # one that actually has unused time
1550 while ( $remaining_value == 0 ) {
1551 if ( $remain_pkg->change_pkgnum ) {
1552 $remain_pkg = FS::cust_pkg->by_key($remain_pkg->change_pkgnum);
1554 # the package has really never been billed
1557 $remaining_value = $remain_pkg->calc_remain('time' => $time);
1560 if ( $remaining_value > 0 ) {
1561 warn "Crediting for $remaining_value on package ".$self->pkgnum."\n"
1563 my $error = $self->cust_main->credit(
1565 'Credit for unused time on '. $self->part_pkg->pkg,
1566 'reason_type' => $reason_type,
1568 return "Error crediting customer \$$remaining_value for unused time".
1569 " on ". $self->part_pkg->pkg. ": $error"
1571 } #if $remaining_value
1572 } #if $last_bill, etc.
1576 =item unsuspend [ OPTION => VALUE ... ]
1578 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1579 package, then unsuspends the package itself (clears the susp field and the
1580 adjourn field if it is in the past). If the suspend reason includes an
1581 unsuspension package, that package will be ordered.
1583 Available options are:
1589 Can be set to a date to unsuspend the package in the future (the 'resume'
1592 =item adjust_next_bill
1594 Can be set true to adjust the next bill date forward by
1595 the amount of time the account was inactive. This was set true by default
1596 in the past (from 1.4.2 and 1.5.0pre6 through 1.7.0), but now needs to be
1597 explicitly requested with this option or in the price plan.
1601 If there is an error, returns the error, otherwise returns false.
1606 my( $self, %opt ) = @_;
1609 # pass all suspend/cancel actions to the main package
1610 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1611 return $self->main_pkg->unsuspend(%opt);
1614 local $SIG{HUP} = 'IGNORE';
1615 local $SIG{INT} = 'IGNORE';
1616 local $SIG{QUIT} = 'IGNORE';
1617 local $SIG{TERM} = 'IGNORE';
1618 local $SIG{TSTP} = 'IGNORE';
1619 local $SIG{PIPE} = 'IGNORE';
1621 my $oldAutoCommit = $FS::UID::AutoCommit;
1622 local $FS::UID::AutoCommit = 0;
1625 my $old = $self->select_for_update;
1627 my $pkgnum = $old->pkgnum;
1628 if ( $old->get('cancel') || $self->get('cancel') ) {
1629 $dbh->rollback if $oldAutoCommit;
1630 return "Can't unsuspend cancelled package $pkgnum";
1633 unless ( $old->get('susp') && $self->get('susp') ) {
1634 $dbh->rollback if $oldAutoCommit;
1635 return ""; # no error # complain instead?
1638 # handle the case of setting a future unsuspend (resume) date
1639 # and do not continue to actually unsuspend the package
1640 my $date = $opt{'date'};
1641 if ( $date and $date > time ) { # return an error if $date <= time?
1643 if ( $old->get('expire') && $old->get('expire') < $date ) {
1644 $dbh->rollback if $oldAutoCommit;
1645 return "Package $pkgnum expires before it would be unsuspended.";
1648 my $new = new FS::cust_pkg { $self->hash };
1649 $new->set('resume', $date);
1650 $error = $new->replace($self, options => $self->options);
1653 $dbh->rollback if $oldAutoCommit;
1657 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1663 if (!$self->setup) {
1664 # then this package is being released from on-hold status
1665 $self->set_initial_timers;
1670 foreach my $cust_svc (
1671 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1673 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1675 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1676 $dbh->rollback if $oldAutoCommit;
1677 return "Illegal svcdb value in part_svc!";
1680 require "FS/$svcdb.pm";
1682 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1684 $error = $svc->unsuspend;
1686 $dbh->rollback if $oldAutoCommit;
1689 my( $label, $value ) = $cust_svc->label;
1690 push @labels, "$label: $value";
1695 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1696 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1698 my %hash = $self->hash;
1699 my $inactive = time - $hash{'susp'};
1701 my $conf = new FS::Conf;
1703 # increment next bill date if certain conditions are met:
1704 # - it was due to be billed at some point
1705 # - either the global or local config says to do this
1706 my $adjust_bill = 0;
1709 && ( $hash{'bill'} || $hash{'setup'} )
1710 && ( $opt{'adjust_next_bill'}
1711 || $conf->exists('unsuspend-always_adjust_next_bill_date')
1712 || $self->part_pkg->option('unsuspend_adjust_bill', 1)
1719 # - the package billed during suspension
1720 # - or it was ordered on hold
1721 # - or the customer was credited for the unused time
1723 if ( $self->option('suspend_bill',1)
1724 or ( $self->part_pkg->option('suspend_bill',1)
1725 and ! $self->option('no_suspend_bill',1)
1727 or $hash{'order_date'} == $hash{'susp'}
1732 if ( $adjust_bill ) {
1733 if ( $self->part_pkg->option('unused_credit_suspend')
1734 or ( $reason and $reason->unused_credit ) ) {
1735 # then the customer was credited for the unused time before suspending,
1736 # so their next bill should be immediate.
1737 $hash{'bill'} = time;
1739 # add the length of time suspended to the bill date
1740 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1745 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1746 $hash{'resume'} = '' if !$hash{'adjourn'};
1747 my $new = new FS::cust_pkg ( \%hash );
1748 $error = $new->replace( $self, options => { $self->options } );
1750 $dbh->rollback if $oldAutoCommit;
1756 if ( $reason && $reason->unsuspend_pkgpart ) {
1757 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
1758 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
1760 my $start_date = $self->cust_main->next_bill_date
1761 if $reason->unsuspend_hold;
1764 $unsusp_pkg = FS::cust_pkg->new({
1765 'custnum' => $self->custnum,
1766 'pkgpart' => $reason->unsuspend_pkgpart,
1767 'start_date' => $start_date,
1768 'locationnum' => $self->locationnum,
1769 # discount? probably not...
1772 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
1776 $dbh->rollback if $oldAutoCommit;
1781 if ( $conf->config('unsuspend_email_admin') ) {
1783 my $error = send_email(
1784 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1785 #invoice_from ??? well as good as any
1786 'to' => $conf->config('unsuspend_email_admin'),
1787 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
1788 "This is an automatic message from your Freeside installation\n",
1789 "informing you that the following customer package has been unsuspended:\n",
1791 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1792 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1793 ( map { "Service : $_\n" } @labels ),
1795 "An unsuspension fee was charged: ".
1796 $unsusp_pkg->part_pkg->pkg_comment."\n"
1800 'custnum' => $self->custnum,
1801 'msgtype' => 'admin',
1805 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
1811 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1812 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
1814 $dbh->rollback if $oldAutoCommit;
1815 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1819 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1826 Cancels any pending suspension (sets the adjourn field to null).
1828 If there is an error, returns the error, otherwise returns false.
1833 my( $self, %options ) = @_;
1836 local $SIG{HUP} = 'IGNORE';
1837 local $SIG{INT} = 'IGNORE';
1838 local $SIG{QUIT} = 'IGNORE';
1839 local $SIG{TERM} = 'IGNORE';
1840 local $SIG{TSTP} = 'IGNORE';
1841 local $SIG{PIPE} = 'IGNORE';
1843 my $oldAutoCommit = $FS::UID::AutoCommit;
1844 local $FS::UID::AutoCommit = 0;
1847 my $old = $self->select_for_update;
1849 my $pkgnum = $old->pkgnum;
1850 if ( $old->get('cancel') || $self->get('cancel') ) {
1851 dbh->rollback if $oldAutoCommit;
1852 return "Can't unadjourn cancelled package $pkgnum";
1853 # or at least it's pointless
1856 if ( $old->get('susp') || $self->get('susp') ) {
1857 dbh->rollback if $oldAutoCommit;
1858 return "Can't unadjourn suspended package $pkgnum";
1859 # perhaps this is arbitrary
1862 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1863 dbh->rollback if $oldAutoCommit;
1864 return ""; # no error
1867 my %hash = $self->hash;
1868 $hash{'adjourn'} = '';
1869 $hash{'resume'} = '';
1870 my $new = new FS::cust_pkg ( \%hash );
1871 $error = $new->replace( $self, options => { $self->options } );
1873 $dbh->rollback if $oldAutoCommit;
1877 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1884 =item change HASHREF | OPTION => VALUE ...
1886 Changes this package: cancels it and creates a new one, with a different
1887 pkgpart or locationnum or both. All services are transferred to the new
1888 package (no change will be made if this is not possible).
1890 Options may be passed as a list of key/value pairs or as a hash reference.
1897 New locationnum, to change the location for this package.
1901 New FS::cust_location object, to create a new location and assign it
1906 New FS::cust_main object, to create a new customer and assign the new package
1911 New pkgpart (see L<FS::part_pkg>).
1915 New refnum (see L<FS::part_referral>).
1919 New quantity; if unspecified, the new package will have the same quantity
1924 "New" (existing) FS::cust_pkg object. The package's services and other
1925 attributes will be transferred to this package.
1929 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1930 susp, adjourn, cancel, expire, and contract_end) to the new package.
1932 =item unprotect_svcs
1934 Normally, change() will rollback and return an error if some services
1935 can't be transferred (also see the I<cust_pkg-change_svcpart> config option).
1936 If unprotect_svcs is true, this method will transfer as many services as
1937 it can and then unconditionally cancel the old package.
1941 At least one of locationnum, cust_location, pkgpart, refnum, cust_main, or
1942 cust_pkg must be specified (otherwise, what's the point?)
1944 Returns either the new FS::cust_pkg object or a scalar error.
1948 my $err_or_new_cust_pkg = $old_cust_pkg->change
1952 #some false laziness w/order
1955 my $opt = ref($_[0]) ? shift : { @_ };
1957 my $conf = new FS::Conf;
1959 # Transactionize this whole mess
1960 local $SIG{HUP} = 'IGNORE';
1961 local $SIG{INT} = 'IGNORE';
1962 local $SIG{QUIT} = 'IGNORE';
1963 local $SIG{TERM} = 'IGNORE';
1964 local $SIG{TSTP} = 'IGNORE';
1965 local $SIG{PIPE} = 'IGNORE';
1967 my $oldAutoCommit = $FS::UID::AutoCommit;
1968 local $FS::UID::AutoCommit = 0;
1977 $hash{'setup'} = $time if $self->setup;
1979 $hash{'change_date'} = $time;
1980 $hash{"change_$_"} = $self->$_()
1981 foreach qw( pkgnum pkgpart locationnum );
1983 if ( $opt->{'cust_location'} ) {
1984 $error = $opt->{'cust_location'}->find_or_insert;
1986 $dbh->rollback if $oldAutoCommit;
1987 return "creating location record: $error";
1989 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1992 if ( $opt->{'cust_pkg'} ) {
1993 # treat changing to a package with a different pkgpart as a
1994 # pkgpart change (because it is)
1995 $opt->{'pkgpart'} = $opt->{'cust_pkg'}->pkgpart;
1998 # whether to override pkgpart checking on the new package
1999 my $same_pkgpart = 1;
2000 if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
2004 my $unused_credit = 0;
2005 my $keep_dates = $opt->{'keep_dates'};
2006 # Special case. If the pkgpart is changing, and the customer is
2007 # going to be credited for remaining time, don't keep setup, bill,
2008 # or last_bill dates, and DO pass the flag to cancel() to credit
2010 if ( $opt->{'pkgpart'}
2011 and $opt->{'pkgpart'} != $self->pkgpart
2012 and $self->part_pkg->option('unused_credit_change', 1) ) {
2015 $hash{$_} = '' foreach qw(setup bill last_bill);
2018 if ( $keep_dates ) {
2019 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
2020 resume start_date contract_end ) ) {
2021 $hash{$date} = $self->getfield($date);
2024 # always keep this date, regardless of anything
2025 # (the date of the package change is in a different field)
2026 $hash{'order_date'} = $self->getfield('order_date');
2028 # allow $opt->{'locationnum'} = '' to specifically set it to null
2029 # (i.e. customer default location)
2030 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2032 # usually this doesn't matter. the two cases where it does are:
2033 # 1. unused_credit_change + pkgpart change + setup fee on the new package
2035 # 2. (more importantly) changing a package before it's billed
2036 $hash{'waive_setup'} = $self->waive_setup;
2038 my $custnum = $self->custnum;
2039 if ( $opt->{cust_main} ) {
2040 my $cust_main = $opt->{cust_main};
2041 unless ( $cust_main->custnum ) {
2042 my $error = $cust_main->insert( @{ $opt->{cust_main_insert_args}||[] } );
2044 $dbh->rollback if $oldAutoCommit;
2045 return "inserting customer record: $error";
2048 $custnum = $cust_main->custnum;
2051 $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
2054 if ( $opt->{'cust_pkg'} ) {
2055 # The target package already exists; update it to show that it was
2056 # changed from this package.
2057 $cust_pkg = $opt->{'cust_pkg'};
2059 foreach ( qw( pkgnum pkgpart locationnum ) ) {
2060 $cust_pkg->set("change_$_", $self->get($_));
2062 $cust_pkg->set('change_date', $time);
2063 $error = $cust_pkg->replace;
2066 # Create the new package.
2067 $cust_pkg = new FS::cust_pkg {
2068 custnum => $custnum,
2069 locationnum => $opt->{'locationnum'},
2070 ( map { $_ => ( $opt->{$_} || $self->$_() ) }
2071 qw( pkgpart quantity refnum salesnum )
2075 $error = $cust_pkg->insert( 'change' => 1,
2076 'allow_pkgpart' => $same_pkgpart );
2079 $dbh->rollback if $oldAutoCommit;
2080 return "inserting new package: $error";
2083 # Transfer services and cancel old package.
2084 # Enforce service limits only if this is a pkgpart change.
2085 local $FS::cust_svc::ignore_quantity;
2086 $FS::cust_svc::ignore_quantity = 1 if $same_pkgpart;
2087 $error = $self->transfer($cust_pkg);
2088 if ($error and $error == 0) {
2089 # $old_pkg->transfer failed.
2090 $dbh->rollback if $oldAutoCommit;
2091 return "transferring $error";
2094 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2095 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2096 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
2097 if ($error and $error == 0) {
2098 # $old_pkg->transfer failed.
2099 $dbh->rollback if $oldAutoCommit;
2100 return "converting $error";
2104 # We set unprotect_svcs when executing a "future package change". It's
2105 # not a user-interactive operation, so returning an error means the
2106 # package change will just fail. Rather than have that happen, we'll
2107 # let leftover services be deleted.
2108 if ($error > 0 and !$opt->{'unprotect_svcs'}) {
2109 # Transfers were successful, but we still had services left on the old
2110 # package. We can't change the package under this circumstances, so abort.
2111 $dbh->rollback if $oldAutoCommit;
2112 return "unable to transfer all services";
2115 #reset usage if changing pkgpart
2116 # AND usage rollover is off (otherwise adds twice, now and at package bill)
2117 if ($self->pkgpart != $cust_pkg->pkgpart) {
2118 my $part_pkg = $cust_pkg->part_pkg;
2119 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
2123 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
2126 $dbh->rollback if $oldAutoCommit;
2127 return "setting usage values: $error";
2130 # if NOT changing pkgpart, transfer any usage pools over
2131 foreach my $usage ($self->cust_pkg_usage) {
2132 $usage->set('pkgnum', $cust_pkg->pkgnum);
2133 $error = $usage->replace;
2135 $dbh->rollback if $oldAutoCommit;
2136 return "transferring usage pools: $error";
2141 # transfer discounts, if we're not changing pkgpart
2142 if ( $same_pkgpart ) {
2143 foreach my $old_discount ($self->cust_pkg_discount_active) {
2144 # don't remove the old discount, we may still need to bill that package.
2145 my $new_discount = new FS::cust_pkg_discount {
2146 'pkgnum' => $cust_pkg->pkgnum,
2147 'discountnum' => $old_discount->discountnum,
2148 'months_used' => $old_discount->months_used,
2150 $error = $new_discount->insert;
2152 $dbh->rollback if $oldAutoCommit;
2153 return "transferring discounts: $error";
2158 # transfer (copy) invoice details
2159 foreach my $detail ($self->cust_pkg_detail) {
2160 my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
2161 $new_detail->set('pkgdetailnum', '');
2162 $new_detail->set('pkgnum', $cust_pkg->pkgnum);
2163 $error = $new_detail->insert;
2165 $dbh->rollback if $oldAutoCommit;
2166 return "transferring package notes: $error";
2172 if ( !$opt->{'cust_pkg'} ) {
2173 # Order any supplemental packages.
2174 my $part_pkg = $cust_pkg->part_pkg;
2175 my @old_supp_pkgs = $self->supplemental_pkgs;
2176 foreach my $link ($part_pkg->supp_part_pkg_link) {
2178 foreach (@old_supp_pkgs) {
2179 if ($_->pkgpart == $link->dst_pkgpart) {
2181 $_->pkgpart(0); # so that it can't match more than once
2185 # false laziness with FS::cust_main::Packages::order_pkg
2186 my $new = FS::cust_pkg->new({
2187 pkgpart => $link->dst_pkgpart,
2188 pkglinknum => $link->pkglinknum,
2189 custnum => $custnum,
2190 main_pkgnum => $cust_pkg->pkgnum,
2191 locationnum => $cust_pkg->locationnum,
2192 start_date => $cust_pkg->start_date,
2193 order_date => $cust_pkg->order_date,
2194 expire => $cust_pkg->expire,
2195 adjourn => $cust_pkg->adjourn,
2196 contract_end => $cust_pkg->contract_end,
2197 refnum => $cust_pkg->refnum,
2198 discountnum => $cust_pkg->discountnum,
2199 waive_setup => $cust_pkg->waive_setup,
2201 if ( $old and $opt->{'keep_dates'} ) {
2202 foreach (qw(setup bill last_bill)) {
2203 $new->set($_, $old->get($_));
2206 $error = $new->insert( allow_pkgpart => $same_pkgpart );
2209 $error ||= $old->transfer($new);
2211 if ( $error and $error > 0 ) {
2212 # no reason why this should ever fail, but still...
2213 $error = "Unable to transfer all services from supplemental package ".
2217 $dbh->rollback if $oldAutoCommit;
2220 push @new_supp_pkgs, $new;
2222 } # if !$opt->{'cust_pkg'}
2223 # because if there is one, then supplemental packages would already
2224 # have been created for it.
2226 #Good to go, cancel old package. Notify 'cancel' of whether to credit
2228 #Don't allow billing the package (preceding period packages and/or
2229 #outstanding usage) if we are keeping dates (i.e. location changing),
2230 #because the new package will be billed for the same date range.
2231 #Supplemental packages are also canceled here.
2233 # during scheduled changes, avoid canceling the package we just
2235 $self->set('change_to_pkgnum' => '');
2237 $error = $self->cancel(
2239 unused_credit => $unused_credit,
2240 nobill => $keep_dates,
2241 change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2242 no_delay_cancel => 1,
2245 $dbh->rollback if $oldAutoCommit;
2246 return "canceling old package: $error";
2249 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2251 my $error = $cust_pkg->cust_main->bill(
2252 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2255 $dbh->rollback if $oldAutoCommit;
2256 return "billing new package: $error";
2260 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2266 =item change_later OPTION => VALUE...
2268 Schedule a package change for a later date. This actually orders the new
2269 package immediately, but sets its start date for a future date, and sets
2270 the current package to expire on the same date.
2272 If the package is already scheduled for a change, this can be called with
2273 'start_date' to change the scheduled date, or with pkgpart and/or
2274 locationnum to modify the package change. To cancel the scheduled change
2275 entirely, see C<abort_change>.
2283 The date for the package change. Required, and must be in the future.
2291 The pkgpart. locationnum, and quantity of the new package, with the same
2292 meaning as in C<change>.
2300 my $opt = ref($_[0]) ? shift : { @_ };
2302 my $oldAutoCommit = $FS::UID::AutoCommit;
2303 local $FS::UID::AutoCommit = 0;
2306 my $cust_main = $self->cust_main;
2308 my $date = delete $opt->{'start_date'} or return 'start_date required';
2310 if ( $date <= time ) {
2311 $dbh->rollback if $oldAutoCommit;
2312 return "start_date $date is in the past";
2317 if ( $self->change_to_pkgnum ) {
2318 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
2319 my $new_pkgpart = $opt->{'pkgpart'}
2320 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $change_to->pkgpart;
2321 my $new_locationnum = $opt->{'locationnum'}
2322 if $opt->{'locationnum'} and $opt->{'locationnum'} != $change_to->locationnum;
2323 my $new_quantity = $opt->{'quantity'}
2324 if $opt->{'quantity'} and $opt->{'quantity'} != $change_to->quantity;
2325 if ( $new_pkgpart or $new_locationnum or $new_quantity ) {
2326 # it hasn't been billed yet, so in principle we could just edit
2327 # it in place (w/o a package change), but that's bad form.
2328 # So change the package according to the new options...
2329 my $err_or_pkg = $change_to->change(%$opt);
2330 if ( ref $err_or_pkg ) {
2331 # Then set that package up for a future start.
2332 $self->set('change_to_pkgnum', $err_or_pkg->pkgnum);
2333 $self->set('expire', $date); # in case it's different
2334 $err_or_pkg->set('start_date', $date);
2335 $err_or_pkg->set('change_date', '');
2336 $err_or_pkg->set('change_pkgnum', '');
2338 $error = $self->replace ||
2339 $err_or_pkg->replace ||
2340 $change_to->cancel('no_delay_cancel' => 1) ||
2343 $error = $err_or_pkg;
2345 } else { # change the start date only.
2346 $self->set('expire', $date);
2347 $change_to->set('start_date', $date);
2348 $error = $self->replace || $change_to->replace;
2351 $dbh->rollback if $oldAutoCommit;
2354 $dbh->commit if $oldAutoCommit;
2357 } # if $self->change_to_pkgnum
2359 my $new_pkgpart = $opt->{'pkgpart'}
2360 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2361 my $new_locationnum = $opt->{'locationnum'}
2362 if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2363 my $new_quantity = $opt->{'quantity'}
2364 if $opt->{'quantity'} and $opt->{'quantity'} != $self->quantity;
2366 return '' unless $new_pkgpart or $new_locationnum or $new_quantity; # wouldn't do anything
2368 # allow $opt->{'locationnum'} = '' to specifically set it to null
2369 # (i.e. customer default location)
2370 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2372 my $new = FS::cust_pkg->new( {
2373 custnum => $self->custnum,
2374 locationnum => $opt->{'locationnum'},
2375 start_date => $date,
2376 map { $_ => ( $opt->{$_} || $self->$_() ) }
2377 qw( pkgpart quantity refnum salesnum )
2379 $error = $new->insert('change' => 1,
2380 'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2382 $self->set('change_to_pkgnum', $new->pkgnum);
2383 $self->set('expire', $date);
2384 $error = $self->replace;
2387 $dbh->rollback if $oldAutoCommit;
2389 $dbh->commit if $oldAutoCommit;
2397 Cancels a future package change scheduled by C<change_later>.
2403 my $pkgnum = $self->change_to_pkgnum;
2404 my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
2407 $error = $change_to->cancel || $change_to->delete;
2408 return $error if $error;
2410 $self->set('change_to_pkgnum', '');
2411 $self->set('expire', '');
2415 =item set_quantity QUANTITY
2417 Change the package's quantity field. This is one of the few package properties
2418 that can safely be changed without canceling and reordering the package
2419 (because it doesn't affect tax eligibility). Returns an error or an
2426 $self = $self->replace_old; # just to make sure
2427 $self->quantity(shift);
2431 =item set_salesnum SALESNUM
2433 Change the package's salesnum (sales person) field. This is one of the few
2434 package properties that can safely be changed without canceling and reordering
2435 the package (because it doesn't affect tax eligibility). Returns an error or
2442 $self = $self->replace_old; # just to make sure
2443 $self->salesnum(shift);
2445 # XXX this should probably reassign any credit that's already been given
2448 =item modify_charge OPTIONS
2450 Change the properties of a one-time charge. The following properties can
2451 be changed this way:
2452 - pkg: the package description
2453 - classnum: the package class
2454 - additional: arrayref of additional invoice details to add to this package
2456 and, I<if the charge has not yet been billed>:
2457 - start_date: the date when it will be billed
2458 - amount: the setup fee to be charged
2459 - quantity: the multiplier for the setup fee
2460 - separate_bill: whether to put the charge on a separate invoice
2462 If you pass 'adjust_commission' => 1, and the classnum changes, and there are
2463 commission credits linked to this charge, they will be recalculated.
2470 my $part_pkg = $self->part_pkg;
2471 my $pkgnum = $self->pkgnum;
2474 my $oldAutoCommit = $FS::UID::AutoCommit;
2475 local $FS::UID::AutoCommit = 0;
2477 return "Can't use modify_charge except on one-time charges"
2478 unless $part_pkg->freq eq '0';
2480 if ( length($opt{'pkg'}) and $part_pkg->pkg ne $opt{'pkg'} ) {
2481 $part_pkg->set('pkg', $opt{'pkg'});
2484 my %pkg_opt = $part_pkg->options;
2485 my $pkg_opt_modified = 0;
2487 $opt{'additional'} ||= [];
2490 foreach (grep /^additional/, keys %pkg_opt) {
2491 ($i) = ($_ =~ /^additional_info(\d+)$/);
2492 $old_additional[$i] = $pkg_opt{$_} if $i;
2493 delete $pkg_opt{$_};
2496 for ( $i = 0; exists($opt{'additional'}->[$i]); $i++ ) {
2497 $pkg_opt{ "additional_info$i" } = $opt{'additional'}->[$i];
2498 if (!exists($old_additional[$i])
2499 or $old_additional[$i] ne $opt{'additional'}->[$i])
2501 $pkg_opt_modified = 1;
2504 $pkg_opt_modified = 1 if (scalar(@old_additional) - 1) != $i;
2505 $pkg_opt{'additional_count'} = $i if $i > 0;
2508 if ( exists($opt{'classnum'}) and $part_pkg->classnum ne $opt{'classnum'} )
2511 $old_classnum = $part_pkg->classnum;
2512 $part_pkg->set('classnum', $opt{'classnum'});
2515 if ( !$self->get('setup') ) {
2516 # not yet billed, so allow amount, setup_cost, quantity, start_date,
2519 if ( exists($opt{'amount'})
2520 and $part_pkg->option('setup_fee') != $opt{'amount'}
2521 and $opt{'amount'} > 0 ) {
2523 $pkg_opt{'setup_fee'} = $opt{'amount'};
2524 $pkg_opt_modified = 1;
2527 if ( exists($opt{'setup_cost'})
2528 and $part_pkg->setup_cost != $opt{'setup_cost'}
2529 and $opt{'setup_cost'} > 0 ) {
2531 $part_pkg->set('setup_cost', $opt{'setup_cost'});
2534 if ( exists($opt{'quantity'})
2535 and $opt{'quantity'} != $self->quantity
2536 and $opt{'quantity'} > 0 ) {
2538 $self->set('quantity', $opt{'quantity'});
2541 if ( exists($opt{'start_date'})
2542 and $opt{'start_date'} != $self->start_date ) {
2544 $self->set('start_date', $opt{'start_date'});
2547 if ( exists($opt{'separate_bill'})
2548 and $opt{'separate_bill'} ne $self->separate_bill ) {
2550 $self->set('separate_bill', $opt{'separate_bill'});
2554 } # else simply ignore them; the UI shouldn't allow editing the fields
2556 if ( exists($opt{'taxclass'})
2557 and $part_pkg->taxclass ne $opt{'taxclass'}) {
2559 $part_pkg->set('taxclass', $opt{'taxclass'});
2563 if ( $part_pkg->modified or $pkg_opt_modified ) {
2564 # can we safely modify the package def?
2565 # Yes, if it's not available for purchase, and this is the only instance
2567 if ( $part_pkg->disabled
2568 and FS::cust_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 1
2569 and FS::quotation_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 0
2571 $error = $part_pkg->replace( options => \%pkg_opt );
2574 $part_pkg = $part_pkg->clone;
2575 $part_pkg->set('disabled' => 'Y');
2576 $error = $part_pkg->insert( options => \%pkg_opt );
2577 # and associate this as yet-unbilled package to the new package def
2578 $self->set('pkgpart' => $part_pkg->pkgpart);
2581 $dbh->rollback if $oldAutoCommit;
2586 if ($self->modified) { # for quantity or start_date change, or if we had
2587 # to clone the existing package def
2588 my $error = $self->replace;
2589 return $error if $error;
2591 if (defined $old_classnum) {
2592 # fix invoice grouping records
2593 my $old_catname = $old_classnum
2594 ? FS::pkg_class->by_key($old_classnum)->categoryname
2596 my $new_catname = $opt{'classnum'}
2597 ? $part_pkg->pkg_class->categoryname
2599 if ( $old_catname ne $new_catname ) {
2600 foreach my $cust_bill_pkg ($self->cust_bill_pkg) {
2601 # (there should only be one...)
2602 my @display = qsearch( 'cust_bill_pkg_display', {
2603 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2604 'section' => $old_catname,
2606 foreach (@display) {
2607 $_->set('section', $new_catname);
2608 $error = $_->replace;
2610 $dbh->rollback if $oldAutoCommit;
2614 } # foreach $cust_bill_pkg
2617 if ( $opt{'adjust_commission'} ) {
2618 # fix commission credits...tricky.
2619 foreach my $cust_event ($self->cust_event) {
2620 my $part_event = $cust_event->part_event;
2621 foreach my $table (qw(sales agent)) {
2623 "FS::part_event::Action::Mixin::credit_${table}_pkg_class";
2624 my $credit = qsearchs('cust_credit', {
2625 'eventnum' => $cust_event->eventnum,
2627 if ( $part_event->isa($class) ) {
2628 # Yes, this results in current commission rates being applied
2629 # retroactively to a one-time charge. For accounting purposes
2630 # there ought to be some kind of time limit on doing this.
2631 my $amount = $part_event->_calc_credit($self);
2632 if ( $credit and $credit->amount ne $amount ) {
2633 # Void the old credit.
2634 $error = $credit->void('Package class changed');
2636 $dbh->rollback if $oldAutoCommit;
2637 return "$error (adjusting commission credit)";
2640 # redo the event action to recreate the credit.
2642 eval { $part_event->do_action( $self, $cust_event ) };
2644 $dbh->rollback if $oldAutoCommit;
2647 } # if $part_event->isa($class)
2649 } # foreach $cust_event
2650 } # if $opt{'adjust_commission'}
2651 } # if defined $old_classnum
2653 $dbh->commit if $oldAutoCommit;
2659 use Storable 'thaw';
2662 sub process_bulk_cust_pkg {
2664 my $param = thaw(decode_base64(shift));
2665 warn Dumper($param) if $DEBUG;
2667 my $old_part_pkg = qsearchs('part_pkg',
2668 { pkgpart => $param->{'old_pkgpart'} });
2669 my $new_part_pkg = qsearchs('part_pkg',
2670 { pkgpart => $param->{'new_pkgpart'} });
2671 die "Must select a new package type\n" unless $new_part_pkg;
2672 #my $keep_dates = $param->{'keep_dates'} || 0;
2673 my $keep_dates = 1; # there is no good reason to turn this off
2675 local $SIG{HUP} = 'IGNORE';
2676 local $SIG{INT} = 'IGNORE';
2677 local $SIG{QUIT} = 'IGNORE';
2678 local $SIG{TERM} = 'IGNORE';
2679 local $SIG{TSTP} = 'IGNORE';
2680 local $SIG{PIPE} = 'IGNORE';
2682 my $oldAutoCommit = $FS::UID::AutoCommit;
2683 local $FS::UID::AutoCommit = 0;
2686 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
2689 foreach my $old_cust_pkg ( @cust_pkgs ) {
2691 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
2692 if ( $old_cust_pkg->getfield('cancel') ) {
2693 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
2694 $old_cust_pkg->pkgnum."\n"
2698 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
2700 my $error = $old_cust_pkg->change(
2701 'pkgpart' => $param->{'new_pkgpart'},
2702 'keep_dates' => $keep_dates
2704 if ( !ref($error) ) { # change returns the cust_pkg on success
2706 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
2709 $dbh->commit if $oldAutoCommit;
2715 Returns the last bill date, or if there is no last bill date, the setup date.
2716 Useful for billing metered services.
2722 return $self->setfield('last_bill', $_[0]) if @_;
2723 return $self->getfield('last_bill') if $self->getfield('last_bill');
2724 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
2725 'edate' => $self->bill, } );
2726 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
2729 =item last_cust_pkg_reason ACTION
2731 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
2732 Returns false if there is no reason or the package is not currenly ACTION'd
2733 ACTION is one of adjourn, susp, cancel, or expire.
2737 sub last_cust_pkg_reason {
2738 my ( $self, $action ) = ( shift, shift );
2739 my $date = $self->get($action);
2741 'table' => 'cust_pkg_reason',
2742 'hashref' => { 'pkgnum' => $self->pkgnum,
2743 'action' => substr(uc($action), 0, 1),
2746 'order_by' => 'ORDER BY num DESC LIMIT 1',
2750 =item last_reason ACTION
2752 Returns the most recent ACTION FS::reason associated with the package.
2753 Returns false if there is no reason or the package is not currenly ACTION'd
2754 ACTION is one of adjourn, susp, cancel, or expire.
2759 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
2760 $cust_pkg_reason->reason
2761 if $cust_pkg_reason;
2766 Returns the definition for this billing item, as an FS::part_pkg object (see
2773 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
2774 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
2775 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
2780 Returns the cancelled package this package was changed from, if any.
2786 return '' unless $self->change_pkgnum;
2787 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
2790 =item change_cust_main
2792 Returns the customter this package was detached to, if any.
2796 sub change_cust_main {
2798 return '' unless $self->change_custnum;
2799 qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
2804 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
2811 $self->part_pkg->calc_setup($self, @_);
2816 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
2823 $self->part_pkg->calc_recur($self, @_);
2828 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
2835 $self->part_pkg->base_recur($self, @_);
2840 Calls the I<calc_remain> of the FS::part_pkg object associated with this
2847 $self->part_pkg->calc_remain($self, @_);
2852 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
2859 $self->part_pkg->calc_cancel($self, @_);
2864 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
2870 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
2873 =item cust_pkg_detail [ DETAILTYPE ]
2875 Returns any customer package details for this package (see
2876 L<FS::cust_pkg_detail>).
2878 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2882 sub cust_pkg_detail {
2884 my %hash = ( 'pkgnum' => $self->pkgnum );
2885 $hash{detailtype} = shift if @_;
2887 'table' => 'cust_pkg_detail',
2888 'hashref' => \%hash,
2889 'order_by' => 'ORDER BY weight, pkgdetailnum',
2893 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
2895 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
2897 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2899 If there is an error, returns the error, otherwise returns false.
2903 sub set_cust_pkg_detail {
2904 my( $self, $detailtype, @details ) = @_;
2906 local $SIG{HUP} = 'IGNORE';
2907 local $SIG{INT} = 'IGNORE';
2908 local $SIG{QUIT} = 'IGNORE';
2909 local $SIG{TERM} = 'IGNORE';
2910 local $SIG{TSTP} = 'IGNORE';
2911 local $SIG{PIPE} = 'IGNORE';
2913 my $oldAutoCommit = $FS::UID::AutoCommit;
2914 local $FS::UID::AutoCommit = 0;
2917 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
2918 my $error = $current->delete;
2920 $dbh->rollback if $oldAutoCommit;
2921 return "error removing old detail: $error";
2925 foreach my $detail ( @details ) {
2926 my $cust_pkg_detail = new FS::cust_pkg_detail {
2927 'pkgnum' => $self->pkgnum,
2928 'detailtype' => $detailtype,
2929 'detail' => $detail,
2931 my $error = $cust_pkg_detail->insert;
2933 $dbh->rollback if $oldAutoCommit;
2934 return "error adding new detail: $error";
2939 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2946 Returns the customer billing events (see L<FS::cust_event>) for this invoice.
2950 #false laziness w/cust_bill.pm
2954 'table' => 'cust_event',
2955 'addl_from' => 'JOIN part_event USING ( eventpart )',
2956 'hashref' => { 'tablenum' => $self->pkgnum },
2957 'extra_sql' => " AND eventtable = 'cust_pkg' ",
2961 =item num_cust_event
2963 Returns the number of customer billing events (see L<FS::cust_event>) for this package.
2967 #false laziness w/cust_bill.pm
2968 sub num_cust_event {
2970 my $sql = "SELECT COUNT(*) ". $self->_from_cust_event_where;
2971 $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref->[0];
2974 =item exists_cust_event
2976 Returns true if there are customer billing events (see L<FS::cust_event>) for this package. More efficient than using num_cust_event.
2980 sub exists_cust_event {
2982 my $sql = "SELECT 1 ". $self->_from_cust_event_where. " LIMIT 1";
2983 my $row = $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref;
2984 $row ? $row->[0] : '';
2987 sub _from_cust_event_where {
2989 " FROM cust_event JOIN part_event USING ( eventpart ) ".
2990 " WHERE tablenum = ? AND eventtable = 'cust_pkg' ";
2994 my( $self, $sql, @args ) = @_;
2995 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
2996 $sth->execute(@args) or die $sth->errstr. " executing $sql";
3000 =item cust_svc [ SVCPART ] (old, deprecated usage)
3002 =item cust_svc [ OPTION => VALUE ... ] (current usage)
3004 =item cust_svc_unsorted [ OPTION => VALUE ... ]
3006 Returns the services for this package, as FS::cust_svc objects (see
3007 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
3008 spcififed, returns only the matching services.
3010 As an optimization, use the cust_svc_unsorted version if you are not displaying
3017 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
3018 $self->_sort_cust_svc( $self->cust_svc_unsorted_arrayref(@_) );
3021 sub cust_svc_unsorted {
3023 @{ $self->cust_svc_unsorted_arrayref(@_) };
3026 sub cust_svc_unsorted_arrayref {
3029 return [] unless $self->num_cust_svc(@_);
3032 if ( @_ && $_[0] =~ /^\d+/ ) {
3033 $opt{svcpart} = shift;
3034 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3041 'table' => 'cust_svc',
3042 'hashref' => { 'pkgnum' => $self->pkgnum },
3044 if ( $opt{svcpart} ) {
3045 $search{hashref}->{svcpart} = $opt{'svcpart'};
3047 if ( $opt{'svcdb'} ) {
3048 $search{addl_from} = ' LEFT JOIN part_svc USING ( svcpart ) ';
3049 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{'svcdb'} );
3052 [ qsearch(\%search) ];
3056 =item overlimit [ SVCPART ]
3058 Returns the services for this package which have exceeded their
3059 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
3060 is specified, return only the matching services.
3066 return () unless $self->num_cust_svc(@_);
3067 grep { $_->overlimit } $self->cust_svc(@_);
3070 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3072 Returns historical services for this package created before END TIMESTAMP and
3073 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
3074 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
3075 I<pkg_svc.hidden> flag will be omitted.
3081 warn "$me _h_cust_svc called on $self\n"
3084 my ($end, $start, $mode) = @_;
3085 my @cust_svc = $self->_sort_cust_svc(
3086 [ qsearch( 'h_cust_svc',
3087 { 'pkgnum' => $self->pkgnum, },
3088 FS::h_cust_svc->sql_h_search(@_),
3091 if ( defined($mode) && $mode eq 'I' ) {
3092 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
3093 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
3099 sub _sort_cust_svc {
3100 my( $self, $arrayref ) = @_;
3103 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
3105 my %pkg_svc = map { $_->svcpart => $_ }
3106 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
3111 my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
3113 $pkg_svc ? $pkg_svc->primary_svc : '',
3114 $pkg_svc ? $pkg_svc->quantity : 0,
3121 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
3123 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
3125 Returns the number of services for this package. Available options are svcpart
3126 and svcdb. If either is spcififed, returns only the matching services.
3133 return $self->{'_num_cust_svc'}
3135 && exists($self->{'_num_cust_svc'})
3136 && $self->{'_num_cust_svc'} =~ /\d/;
3138 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
3142 if ( @_ && $_[0] =~ /^\d+/ ) {
3143 $opt{svcpart} = shift;
3144 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3150 my $select = 'SELECT COUNT(*) FROM cust_svc ';
3151 my $where = ' WHERE pkgnum = ? ';
3152 my @param = ($self->pkgnum);
3154 if ( $opt{'svcpart'} ) {
3155 $where .= ' AND svcpart = ? ';
3156 push @param, $opt{'svcpart'};
3158 if ( $opt{'svcdb'} ) {
3159 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
3160 $where .= ' AND svcdb = ? ';
3161 push @param, $opt{'svcdb'};
3164 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
3165 $sth->execute(@param) or die $sth->errstr;
3166 $sth->fetchrow_arrayref->[0];
3169 =item available_part_svc
3171 Returns a list of FS::part_svc objects representing services included in this
3172 package but not yet provisioned. Each FS::part_svc object also has an extra
3173 field, I<num_avail>, which specifies the number of available services.
3177 sub available_part_svc {
3180 my $pkg_quantity = $self->quantity || 1;
3182 grep { $_->num_avail > 0 }
3184 my $part_svc = $_->part_svc;
3185 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
3186 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
3188 # more evil encapsulation breakage
3189 if($part_svc->{'Hash'}{'num_avail'} > 0) {
3190 my @exports = $part_svc->part_export_did;
3191 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
3196 $self->part_pkg->pkg_svc;
3199 =item part_svc [ OPTION => VALUE ... ]
3201 Returns a list of FS::part_svc objects representing provisioned and available
3202 services included in this package. Each FS::part_svc object also has the
3203 following extra fields:
3217 (services) - array reference containing the provisioned services, as cust_svc objects
3221 Accepts two options:
3225 =item summarize_size
3227 If true, will omit the extra cust_pkg_svc option for objects where num_cust_svc
3228 is this size or greater.
3230 =item hide_discontinued
3232 If true, will omit looking for services that are no longer avaialble in the
3240 #label -> ($cust_svc->label)[1]
3246 my $pkg_quantity = $self->quantity || 1;
3248 #XXX some sort of sort order besides numeric by svcpart...
3249 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
3251 my $part_svc = $pkg_svc->part_svc;
3252 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3253 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
3254 $part_svc->{'Hash'}{'num_avail'} =
3255 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
3256 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3257 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
3258 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
3259 && $num_cust_svc >= $opt{summarize_size};
3260 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
3262 } $self->part_pkg->pkg_svc;
3264 unless ( $opt{hide_discontinued} ) {
3266 push @part_svc, map {
3268 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3269 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
3270 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
3271 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3272 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
3274 } $self->extra_part_svc;
3281 =item extra_part_svc
3283 Returns a list of FS::part_svc objects corresponding to services in this
3284 package which are still provisioned but not (any longer) available in the
3289 sub extra_part_svc {
3292 my $pkgnum = $self->pkgnum;
3293 #my $pkgpart = $self->pkgpart;
3296 # 'table' => 'part_svc',
3299 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
3300 # WHERE pkg_svc.svcpart = part_svc.svcpart
3301 # AND pkg_svc.pkgpart = ?
3304 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
3305 # LEFT JOIN cust_pkg USING ( pkgnum )
3306 # WHERE cust_svc.svcpart = part_svc.svcpart
3309 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
3312 #seems to benchmark slightly faster... (or did?)
3314 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
3315 my $pkgparts = join(',', @pkgparts);
3318 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
3319 #MySQL doesn't grok DISINCT ON
3320 'select' => 'DISTINCT part_svc.*',
3321 'table' => 'part_svc',
3323 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
3324 AND pkg_svc.pkgpart IN ($pkgparts)
3327 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
3328 LEFT JOIN cust_pkg USING ( pkgnum )
3331 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
3332 'extra_param' => [ [$self->pkgnum=>'int'] ],
3338 Returns a short status string for this package, currently:
3344 =item not yet billed
3346 =item one-time charge
3361 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
3363 return 'cancelled' if $self->get('cancel');
3364 return 'on hold' if $self->susp && ! $self->setup;
3365 return 'suspended' if $self->susp;
3366 return 'not yet billed' unless $self->setup;
3367 return 'one-time charge' if $freq =~ /^(0|$)/;
3371 =item ucfirst_status
3373 Returns the status with the first character capitalized.
3377 sub ucfirst_status {
3378 ucfirst(shift->status);
3383 Class method that returns the list of possible status strings for packages
3384 (see L<the status method|/status>). For example:
3386 @statuses = FS::cust_pkg->statuses();
3390 tie my %statuscolor, 'Tie::IxHash',
3391 'on hold' => 'FF00F5', #brighter purple!
3392 'not yet billed' => '009999', #teal? cyan?
3393 'one-time charge' => '0000CC', #blue #'000000',
3394 'active' => '00CC00',
3395 'suspended' => 'FF9900',
3396 'cancelled' => 'FF0000',
3400 my $self = shift; #could be class...
3401 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
3402 # # mayble split btw one-time vs. recur
3413 Returns a hex triplet color string for this package's status.
3419 $statuscolor{$self->status};
3422 =item is_status_delay_cancel
3424 Returns true if part_pkg has option delay_cancel,
3425 cust_pkg status is 'suspended' and expire is set
3426 to cancel package within the next day (or however
3427 many days are set in global config part_pkg-delay_cancel-days.
3429 This is not a real status, this only meant for hacking display
3430 values, because otherwise treating the package as suspended is
3431 really the whole point of the delay_cancel option.
3435 sub is_status_delay_cancel {
3437 if ( $self->main_pkgnum and $self->pkglinknum ) {
3438 return $self->main_pkg->is_status_delay_cancel;
3440 return 0 unless $self->part_pkg->option('delay_cancel',1);
3441 return 0 unless $self->status eq 'suspended';
3442 return 0 unless $self->expire;
3443 my $conf = new FS::Conf;
3444 my $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
3445 my $expsecs = 60*60*24*$expdays;
3446 return 0 unless $self->expire < time + $expsecs;
3452 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
3453 "pkg - comment" depending on user preference).
3459 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
3460 $label = $self->pkgnum. ": $label"
3461 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
3465 =item pkg_label_long
3467 Returns a long label for this package, adding the primary service's label to
3472 sub pkg_label_long {
3474 my $label = $self->pkg_label;
3475 my $cust_svc = $self->primary_cust_svc;
3476 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
3482 Returns a customer-localized label for this package.
3488 $self->part_pkg->pkg_locale( $self->cust_main->locale );
3491 =item primary_cust_svc
3493 Returns a primary service (as FS::cust_svc object) if one can be identified.
3497 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
3499 sub primary_cust_svc {
3502 my @cust_svc = $self->cust_svc;
3504 return '' unless @cust_svc; #no serivces - irrelevant then
3506 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
3508 # primary service as specified in the package definition
3509 # or exactly one service definition with quantity one
3510 my $svcpart = $self->part_pkg->svcpart;
3511 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
3512 return $cust_svc[0] if scalar(@cust_svc) == 1;
3514 #couldn't identify one thing..
3520 Returns a list of lists, calling the label method for all services
3521 (see L<FS::cust_svc>) of this billing item.
3527 map { [ $_->label ] } $self->cust_svc;
3530 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3532 Like the labels method, but returns historical information on services that
3533 were active as of END_TIMESTAMP and (optionally) not cancelled before
3534 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
3535 I<pkg_svc.hidden> flag will be omitted.
3537 Returns a list of lists, calling the label method for all (historical) services
3538 (see L<FS::h_cust_svc>) of this billing item.
3544 warn "$me _h_labels called on $self\n"
3546 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
3551 Like labels, except returns a simple flat list, and shortens long
3552 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3553 identical services to one line that lists the service label and the number of
3554 individual services rather than individual items.
3559 shift->_labels_short( 'labels', @_ );
3562 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
3564 Like h_labels, except returns a simple flat list, and shortens long
3565 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3566 identical services to one line that lists the service label and the number of
3567 individual services rather than individual items.
3571 sub h_labels_short {
3572 shift->_labels_short( 'h_labels', @_ );
3576 my( $self, $method ) = ( shift, shift );
3578 warn "$me _labels_short called on $self with $method method\n"
3581 my $conf = new FS::Conf;
3582 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
3584 warn "$me _labels_short populating \%labels\n"
3588 #tie %labels, 'Tie::IxHash';
3589 push @{ $labels{$_->[0]} }, $_->[1]
3590 foreach $self->$method(@_);
3592 warn "$me _labels_short populating \@labels\n"
3596 foreach my $label ( keys %labels ) {
3598 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
3599 my $num = scalar(@values);
3600 warn "$me _labels_short $num items for $label\n"
3603 if ( $num > $max_same_services ) {
3604 warn "$me _labels_short more than $max_same_services, so summarizing\n"
3606 push @labels, "$label ($num)";
3608 if ( $conf->exists('cust_bill-consolidate_services') ) {
3609 warn "$me _labels_short consolidating services\n"
3611 # push @labels, "$label: ". join(', ', @values);
3613 my $detail = "$label: ";
3614 $detail .= shift(@values). ', '
3616 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
3618 push @labels, $detail;
3620 warn "$me _labels_short done consolidating services\n"
3623 warn "$me _labels_short adding service data\n"
3625 push @labels, map { "$label: $_" } @values;
3636 Returns the parent customer object (see L<FS::cust_main>).
3642 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
3647 Returns the balance for this specific package, when using
3648 experimental package balance.
3654 $self->cust_main->balance_pkgnum( $self->pkgnum );
3657 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
3661 Returns the location object, if any (see L<FS::cust_location>).
3663 =item cust_location_or_main
3665 If this package is associated with a location, returns the locaiton (see
3666 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
3668 =item location_label [ OPTION => VALUE ... ]
3670 Returns the label of the location object (see L<FS::cust_location>).
3674 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
3676 =item tax_locationnum
3678 Returns the foreign key to a L<FS::cust_location> object for calculating
3679 tax on this package, as determined by the C<tax-pkg_address> and
3680 C<tax-ship_address> configuration flags.
3684 sub tax_locationnum {
3686 my $conf = FS::Conf->new;
3687 if ( $conf->exists('tax-pkg_address') ) {
3688 return $self->locationnum;
3690 elsif ( $conf->exists('tax-ship_address') ) {
3691 return $self->cust_main->ship_locationnum;
3694 return $self->cust_main->bill_locationnum;
3700 Returns the L<FS::cust_location> object for tax_locationnum.
3706 my $conf = FS::Conf->new;
3707 if ( $conf->exists('tax-pkg_address') and $self->locationnum ) {
3708 return FS::cust_location->by_key($self->locationnum);
3710 elsif ( $conf->exists('tax-ship_address') ) {
3711 return $self->cust_main->ship_location;
3714 return $self->cust_main->bill_location;
3718 =item seconds_since TIMESTAMP
3720 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
3721 package have been online since TIMESTAMP, according to the session monitor.
3723 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
3724 L<Time::Local> and L<Date::Parse> for conversion functions.
3729 my($self, $since) = @_;
3732 foreach my $cust_svc (
3733 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
3735 $seconds += $cust_svc->seconds_since($since);
3742 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
3744 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
3745 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
3748 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3749 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3755 sub seconds_since_sqlradacct {
3756 my($self, $start, $end) = @_;
3760 foreach my $cust_svc (
3762 my $part_svc = $_->part_svc;
3763 $part_svc->svcdb eq 'svc_acct'
3764 && scalar($part_svc->part_export_usage);
3767 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
3774 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
3776 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
3777 in this package for sessions ending between TIMESTAMP_START (inclusive) and
3781 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3782 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3787 sub attribute_since_sqlradacct {
3788 my($self, $start, $end, $attrib) = @_;
3792 foreach my $cust_svc (
3794 my $part_svc = $_->part_svc;
3795 scalar($part_svc->part_export_usage);
3798 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
3810 my( $self, $value ) = @_;
3811 if ( defined($value) ) {
3812 $self->setfield('quantity', $value);
3814 $self->getfield('quantity') || 1;
3817 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
3819 Transfers as many services as possible from this package to another package.
3821 The destination package can be specified by pkgnum by passing an FS::cust_pkg
3822 object. The destination package must already exist.
3824 Services are moved only if the destination allows services with the correct
3825 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
3826 this option with caution! No provision is made for export differences
3827 between the old and new service definitions. Probably only should be used
3828 when your exports for all service definitions of a given svcdb are identical.
3829 (attempt a transfer without it first, to move all possible svcpart-matching
3832 Any services that can't be moved remain in the original package.
3834 Returns an error, if there is one; otherwise, returns the number of services
3835 that couldn't be moved.
3840 my ($self, $dest_pkgnum, %opt) = @_;
3846 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
3847 $dest = $dest_pkgnum;
3848 $dest_pkgnum = $dest->pkgnum;
3850 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
3853 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
3855 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
3856 $target{$pkg_svc->svcpart} = $pkg_svc->quantity * ( $dest->quantity || 1 );
3859 foreach my $cust_svc ($dest->cust_svc) {
3860 $target{$cust_svc->svcpart}--;
3863 my %svcpart2svcparts = ();
3864 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3865 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
3866 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
3867 next if exists $svcpart2svcparts{$svcpart};
3868 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
3869 $svcpart2svcparts{$svcpart} = [
3871 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
3873 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
3874 'svcpart' => $_ } );
3876 $pkg_svc ? $pkg_svc->primary_svc : '',
3877 $pkg_svc ? $pkg_svc->quantity : 0,
3881 grep { $_ != $svcpart }
3883 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
3885 warn "alternates for svcpart $svcpart: ".
3886 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
3892 foreach my $cust_svc ($self->cust_svc) {
3893 my $svcnum = $cust_svc->svcnum;
3894 if($target{$cust_svc->svcpart} > 0
3895 or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
3896 $target{$cust_svc->svcpart}--;
3897 my $new = new FS::cust_svc { $cust_svc->hash };
3898 $new->pkgnum($dest_pkgnum);
3899 $error = $new->replace($cust_svc);
3900 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3902 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
3903 warn "alternates to consider: ".
3904 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
3906 my @alternate = grep {
3907 warn "considering alternate svcpart $_: ".
3908 "$target{$_} available in new package\n"
3911 } @{$svcpart2svcparts{$cust_svc->svcpart}};
3913 warn "alternate(s) found\n" if $DEBUG;
3914 my $change_svcpart = $alternate[0];
3915 $target{$change_svcpart}--;
3916 my $new = new FS::cust_svc { $cust_svc->hash };
3917 $new->svcpart($change_svcpart);
3918 $new->pkgnum($dest_pkgnum);
3919 $error = $new->replace($cust_svc);
3927 my @label = $cust_svc->label;
3928 return "service $label[1]: $error";
3934 =item grab_svcnums SVCNUM, SVCNUM ...
3936 Change the pkgnum for the provided services to this packages. If there is an
3937 error, returns the error, otherwise returns false.
3945 local $SIG{HUP} = 'IGNORE';
3946 local $SIG{INT} = 'IGNORE';
3947 local $SIG{QUIT} = 'IGNORE';
3948 local $SIG{TERM} = 'IGNORE';
3949 local $SIG{TSTP} = 'IGNORE';
3950 local $SIG{PIPE} = 'IGNORE';
3952 my $oldAutoCommit = $FS::UID::AutoCommit;
3953 local $FS::UID::AutoCommit = 0;
3956 foreach my $svcnum (@svcnum) {
3957 my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
3958 $dbh->rollback if $oldAutoCommit;
3959 return "unknown svcnum $svcnum";
3961 $cust_svc->pkgnum( $self->pkgnum );
3962 my $error = $cust_svc->replace;
3964 $dbh->rollback if $oldAutoCommit;
3969 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3976 This method is deprecated. See the I<depend_jobnum> option to the insert and
3977 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
3984 local $SIG{HUP} = 'IGNORE';
3985 local $SIG{INT} = 'IGNORE';
3986 local $SIG{QUIT} = 'IGNORE';
3987 local $SIG{TERM} = 'IGNORE';
3988 local $SIG{TSTP} = 'IGNORE';
3989 local $SIG{PIPE} = 'IGNORE';
3991 my $oldAutoCommit = $FS::UID::AutoCommit;
3992 local $FS::UID::AutoCommit = 0;
3995 foreach my $cust_svc ( $self->cust_svc ) {
3996 #false laziness w/svc_Common::insert
3997 my $svc_x = $cust_svc->svc_x;
3998 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
3999 my $error = $part_export->export_insert($svc_x);
4001 $dbh->rollback if $oldAutoCommit;
4007 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4012 =item export_pkg_change OLD_CUST_PKG
4014 Calls the "pkg_change" export action for all services attached to this package.
4018 sub export_pkg_change {
4019 my( $self, $old ) = ( shift, shift );
4021 local $SIG{HUP} = 'IGNORE';
4022 local $SIG{INT} = 'IGNORE';
4023 local $SIG{QUIT} = 'IGNORE';
4024 local $SIG{TERM} = 'IGNORE';
4025 local $SIG{TSTP} = 'IGNORE';
4026 local $SIG{PIPE} = 'IGNORE';
4028 my $oldAutoCommit = $FS::UID::AutoCommit;
4029 local $FS::UID::AutoCommit = 0;
4032 foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
4033 my $error = $svc_x->export('pkg_change', $self, $old);
4035 $dbh->rollback if $oldAutoCommit;
4040 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4047 Associates this package with a (suspension or cancellation) reason (see
4048 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
4051 Available options are:
4057 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.
4061 the access_user (see L<FS::access_user>) providing the reason
4069 the action (cancel, susp, adjourn, expire) associated with the reason
4073 If there is an error, returns the error, otherwise returns false.
4078 my ($self, %options) = @_;
4080 my $otaker = $options{reason_otaker} ||
4081 $FS::CurrentUser::CurrentUser->username;
4084 if ( $options{'reason'} =~ /^(\d+)$/ ) {
4088 } elsif ( ref($options{'reason'}) ) {
4090 return 'Enter a new reason (or select an existing one)'
4091 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
4093 my $reason = new FS::reason({
4094 'reason_type' => $options{'reason'}->{'typenum'},
4095 'reason' => $options{'reason'}->{'reason'},
4097 my $error = $reason->insert;
4098 return $error if $error;
4100 $reasonnum = $reason->reasonnum;
4103 return "Unparseable reason: ". $options{'reason'};
4106 my $cust_pkg_reason =
4107 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
4108 'reasonnum' => $reasonnum,
4109 'otaker' => $otaker,
4110 'action' => substr(uc($options{'action'}),0,1),
4111 'date' => $options{'date'}
4116 $cust_pkg_reason->insert;
4119 =item insert_discount
4121 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
4122 inserting a new discount on the fly (see L<FS::discount>).
4124 Available options are:
4132 If there is an error, returns the error, otherwise returns false.
4136 sub insert_discount {
4137 #my ($self, %options) = @_;
4140 my $cust_pkg_discount = new FS::cust_pkg_discount {
4141 'pkgnum' => $self->pkgnum,
4142 'discountnum' => $self->discountnum,
4144 'end_date' => '', #XXX
4145 #for the create a new discount case
4146 '_type' => $self->discountnum__type,
4147 'amount' => $self->discountnum_amount,
4148 'percent' => $self->discountnum_percent,
4149 'months' => $self->discountnum_months,
4150 'setup' => $self->discountnum_setup,
4151 #'disabled' => $self->discountnum_disabled,
4154 $cust_pkg_discount->insert;
4157 =item set_usage USAGE_VALUE_HASHREF
4159 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4160 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4161 upbytes, downbytes, and totalbytes are appropriate keys.
4163 All svc_accts which are part of this package have their values reset.
4168 my ($self, $valueref, %opt) = @_;
4170 #only svc_acct can set_usage for now
4171 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4172 my $svc_x = $cust_svc->svc_x;
4173 $svc_x->set_usage($valueref, %opt)
4174 if $svc_x->can("set_usage");
4178 =item recharge USAGE_VALUE_HASHREF
4180 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4181 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4182 upbytes, downbytes, and totalbytes are appropriate keys.
4184 All svc_accts which are part of this package have their values incremented.
4189 my ($self, $valueref) = @_;
4191 #only svc_acct can set_usage for now
4192 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4193 my $svc_x = $cust_svc->svc_x;
4194 $svc_x->recharge($valueref)
4195 if $svc_x->can("recharge");
4199 =item cust_pkg_discount
4203 sub cust_pkg_discount {
4205 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
4208 =item cust_pkg_discount_active
4212 sub cust_pkg_discount_active {
4214 grep { $_->status eq 'active' } $self->cust_pkg_discount;
4217 =item cust_pkg_usage
4219 Returns a list of all voice usage counters attached to this package.
4223 sub cust_pkg_usage {
4225 qsearch('cust_pkg_usage', { pkgnum => $self->pkgnum });
4228 =item apply_usage OPTIONS
4230 Takes the following options:
4231 - cdr: a call detail record (L<FS::cdr>)
4232 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
4233 - minutes: the maximum number of minutes to be charged
4235 Finds available usage minutes for a call of this class, and subtracts
4236 up to that many minutes from the usage pool. If the usage pool is empty,
4237 and the C<cdr-minutes_priority> global config option is set, minutes may
4238 be taken from other calls as well. Either way, an allocation record will
4239 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
4240 number of minutes of usage applied to the call.
4245 my ($self, %opt) = @_;
4246 my $cdr = $opt{cdr};
4247 my $rate_detail = $opt{rate_detail};
4248 my $minutes = $opt{minutes};
4249 my $classnum = $rate_detail->classnum;
4250 my $pkgnum = $self->pkgnum;
4251 my $custnum = $self->custnum;
4253 local $SIG{HUP} = 'IGNORE';
4254 local $SIG{INT} = 'IGNORE';
4255 local $SIG{QUIT} = 'IGNORE';
4256 local $SIG{TERM} = 'IGNORE';
4257 local $SIG{TSTP} = 'IGNORE';
4258 local $SIG{PIPE} = 'IGNORE';
4260 my $oldAutoCommit = $FS::UID::AutoCommit;
4261 local $FS::UID::AutoCommit = 0;
4263 my $order = FS::Conf->new->config('cdr-minutes_priority');
4267 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
4269 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
4271 my @usage_recs = qsearch({
4272 'table' => 'cust_pkg_usage',
4273 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
4274 ' JOIN cust_pkg USING (pkgnum)'.
4275 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
4276 'select' => 'cust_pkg_usage.*',
4277 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
4278 " ( cust_pkg.custnum = $custnum AND ".
4279 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4280 $is_classnum . ' AND '.
4281 " cust_pkg_usage.minutes > 0",
4282 'order_by' => " ORDER BY priority ASC",
4285 my $orig_minutes = $minutes;
4287 while (!$error and $minutes > 0 and @usage_recs) {
4288 my $cust_pkg_usage = shift @usage_recs;
4289 $cust_pkg_usage->select_for_update;
4290 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
4291 pkgusagenum => $cust_pkg_usage->pkgusagenum,
4292 acctid => $cdr->acctid,
4293 minutes => min($cust_pkg_usage->minutes, $minutes),
4295 $cust_pkg_usage->set('minutes',
4296 $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes
4298 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
4299 $minutes -= $cdr_cust_pkg_usage->minutes;
4301 if ( $order and $minutes > 0 and !$error ) {
4302 # then try to steal minutes from another call
4304 'table' => 'cdr_cust_pkg_usage',
4305 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
4306 ' JOIN part_pkg_usage USING (pkgusagepart)'.
4307 ' JOIN cust_pkg USING (pkgnum)'.
4308 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
4309 ' JOIN cdr USING (acctid)',
4310 'select' => 'cdr_cust_pkg_usage.*',
4311 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
4312 " ( cust_pkg.pkgnum = $pkgnum OR ".
4313 " ( cust_pkg.custnum = $custnum AND ".
4314 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4315 " part_pkg_usage_class.classnum = $classnum",
4316 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
4318 if ( $order eq 'time' ) {
4319 # find CDRs that are using minutes, but have a later startdate
4321 my $startdate = $cdr->startdate;
4322 if ($startdate !~ /^\d+$/) {
4323 die "bad cdr startdate '$startdate'";
4325 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
4326 # minimize needless reshuffling
4327 $search{'order_by'} .= ', cdr.startdate DESC';
4329 # XXX may not work correctly with rate_time schedules. Could
4330 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
4332 $search{'addl_from'} .=
4333 ' JOIN rate_detail'.
4334 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
4335 if ( $order eq 'rate_high' ) {
4336 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
4337 $rate_detail->min_charge;
4338 $search{'order_by'} .= ', rate_detail.min_charge ASC';
4339 } elsif ( $order eq 'rate_low' ) {
4340 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
4341 $rate_detail->min_charge;
4342 $search{'order_by'} .= ', rate_detail.min_charge DESC';
4344 # this should really never happen
4345 die "invalid cdr-minutes_priority value '$order'\n";
4348 my @cdr_usage_recs = qsearch(\%search);
4350 while (!$error and @cdr_usage_recs and $minutes > 0) {
4351 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
4352 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
4353 my $old_cdr = $cdr_cust_pkg_usage->cdr;
4354 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
4355 $cdr_cust_pkg_usage->select_for_update;
4356 $old_cdr->select_for_update;
4357 $cust_pkg_usage->select_for_update;
4358 # in case someone else stole the usage from this CDR
4359 # while waiting for the lock...
4360 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
4361 # steal the usage allocation and flag the old CDR for reprocessing
4362 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
4363 # if the allocation is more minutes than we need, adjust it...
4364 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
4366 $cdr_cust_pkg_usage->set('minutes', $minutes);
4367 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
4368 $error = $cust_pkg_usage->replace;
4370 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
4371 $error ||= $cdr_cust_pkg_usage->replace;
4372 # deduct the stolen minutes
4373 $minutes -= $cdr_cust_pkg_usage->minutes;
4375 # after all minute-stealing is done, reset the affected CDRs
4376 foreach (values %reproc_cdrs) {
4377 $error ||= $_->set_status('');
4378 # XXX or should we just call $cdr->rate right here?
4379 # it's not like we can create a loop this way, since the min_charge
4380 # or call time has to go monotonically in one direction.
4381 # we COULD get some very deep recursions going, though...
4383 } # if $order and $minutes
4386 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
4388 $dbh->commit if $oldAutoCommit;
4389 return $orig_minutes - $minutes;
4393 =item supplemental_pkgs
4395 Returns a list of all packages supplemental to this one.
4399 sub supplemental_pkgs {
4401 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
4406 Returns the package that this one is supplemental to, if any.
4412 if ( $self->main_pkgnum ) {
4413 return FS::cust_pkg->by_key($self->main_pkgnum);
4420 =head1 CLASS METHODS
4426 Returns an SQL expression identifying recurring packages.
4430 sub recurring_sql { "
4431 '0' != ( select freq from part_pkg
4432 where cust_pkg.pkgpart = part_pkg.pkgpart )
4437 Returns an SQL expression identifying one-time packages.
4442 '0' = ( select freq from part_pkg
4443 where cust_pkg.pkgpart = part_pkg.pkgpart )
4448 Returns an SQL expression identifying ordered packages (recurring packages not
4454 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
4459 Returns an SQL expression identifying active packages.
4464 $_[0]->recurring_sql. "
4465 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4466 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4467 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4470 =item not_yet_billed_sql
4472 Returns an SQL expression identifying packages which have not yet been billed.
4476 sub not_yet_billed_sql { "
4477 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4478 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4479 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4484 Returns an SQL expression identifying inactive packages (one-time packages
4485 that are otherwise unsuspended/uncancelled).
4489 sub inactive_sql { "
4490 ". $_[0]->onetime_sql(). "
4491 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4492 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4493 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4498 Returns an SQL expression identifying on-hold packages.
4503 #$_[0]->recurring_sql(). ' AND '.
4505 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4506 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4507 AND ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4514 Returns an SQL expression identifying suspended packages.
4518 sub suspended_sql { susp_sql(@_); }
4520 #$_[0]->recurring_sql(). ' AND '.
4522 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4523 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4524 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4531 Returns an SQL exprression identifying cancelled packages.
4535 sub cancelled_sql { cancel_sql(@_); }
4537 #$_[0]->recurring_sql(). ' AND '.
4538 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
4543 Returns an SQL expression to give the package status as a string.
4549 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
4550 WHEN ( cust_pkg.susp IS NOT NULL AND cust_pkg.setup IS NULL ) THEN 'on hold'
4551 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
4552 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
4553 WHEN ".onetime_sql()." THEN 'one-time charge'
4558 =item search HASHREF
4562 Returns a qsearch hash expression to search for parameters specified in HASHREF.
4563 Valid parameters are
4571 on hold, active, inactive (or one-time charge), suspended, canceled (or cancelled)
4575 Equivalent to "status", except that "canceled"/"cancelled" will exclude
4576 packages that were changed into a new package with the same pkgpart (i.e.
4577 location or quantity changes).
4581 boolean selects custom packages
4587 pkgpart or arrayref or hashref of pkgparts
4591 arrayref of beginning and ending epoch date
4595 arrayref of beginning and ending epoch date
4599 arrayref of beginning and ending epoch date
4603 arrayref of beginning and ending epoch date
4607 arrayref of beginning and ending epoch date
4611 arrayref of beginning and ending epoch date
4615 arrayref of beginning and ending epoch date
4619 pkgnum or APKG_pkgnum
4623 a value suited to passing to FS::UI::Web::cust_header
4627 specifies the user for agent virtualization
4631 boolean; if true, returns only packages with more than 0 FCC phone lines.
4633 =item state, country
4635 Limit to packages with a service location in the specified state and country.
4636 For FCC 477 reporting, mostly.
4640 Limit to packages whose service locations are the same as the customer's
4641 default service location.
4643 =item location_nocust
4645 Limit to packages whose service locations are not the customer's default
4648 =item location_census
4650 Limit to packages whose service locations have census tracts.
4652 =item location_nocensus
4654 Limit to packages whose service locations do not have a census tract.
4656 =item location_geocode
4658 Limit to packages whose locations have geocodes.
4660 =item location_geocode
4662 Limit to packages whose locations do not have geocodes.
4666 Limit to packages associated with a svc_broadband, associated with a sector,
4667 associated with this towernum (or any of these, if it's an arrayref) (or NO
4668 towernum, if it's zero). This is an extreme niche case.
4670 =item 477part, 477rownum, date
4672 Limit to packages included in a specific row of one of the FCC 477 reports.
4673 '477part' is the section name (see L<FS::Report::FCC_477> methods), 'date'
4674 is the report as-of date (completely unrelated to the package setup/bill/
4675 other date fields), and '477rownum' is the row number of the report starting
4676 with zero. Row numbers have no inherent meaning, so this is useful only
4677 for explaining a 477 report you've already run.
4684 my ($class, $params) = @_;
4691 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
4693 "cust_main.agentnum = $1";
4700 if ( $params->{'cust_status'} =~ /^([a-z]+)$/ ) {
4701 push @where, FS::cust_main->cust_status_sql . " = '$1' ";
4705 # parse customer sales person
4708 if ( $params->{'cust_main_salesnum'} =~ /^(\d+)$/ ) {
4709 push @where, ($1 > 0) ? "cust_main.salesnum = $1"
4710 : 'cust_main.salesnum IS NULL';
4715 # parse sales person
4718 if ( $params->{'salesnum'} =~ /^(\d+)$/ ) {
4719 push @where, ($1 > 0) ? "cust_pkg.salesnum = $1"
4720 : 'cust_pkg.salesnum IS NULL';
4727 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
4729 "cust_pkg.custnum = $1";
4736 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
4738 "cust_pkg.pkgbatch = '$1'";
4745 if ( $params->{'magic'} eq 'active'
4746 || $params->{'status'} eq 'active' ) {
4748 push @where, FS::cust_pkg->active_sql();
4750 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
4751 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
4753 push @where, FS::cust_pkg->not_yet_billed_sql();
4755 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
4756 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
4758 push @where, FS::cust_pkg->inactive_sql();
4760 } elsif ( $params->{'magic'} =~ /^on[ _]hold$/
4761 || $params->{'status'} =~ /^on[ _]hold$/ ) {
4763 push @where, FS::cust_pkg->on_hold_sql();
4766 } elsif ( $params->{'magic'} eq 'suspended'
4767 || $params->{'status'} eq 'suspended' ) {
4769 push @where, FS::cust_pkg->suspended_sql();
4771 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
4772 || $params->{'status'} =~ /^cancell?ed$/ ) {
4774 push @where, FS::cust_pkg->cancelled_sql();
4778 ### special case: "magic" is used in detail links from browse/part_pkg,
4779 # where "cancelled" has the restriction "and not replaced with a package
4780 # of the same pkgpart". Be consistent with that.
4783 if ( $params->{'magic'} =~ /^cancell?ed$/ ) {
4784 my $new_pkgpart = "SELECT pkgpart FROM cust_pkg AS cust_pkg_next ".
4785 "WHERE cust_pkg_next.change_pkgnum = cust_pkg.pkgnum";
4786 # ...may not exist, if this was just canceled and not changed; in that
4787 # case give it a "new pkgpart" that never equals the old pkgpart
4788 push @where, "COALESCE(($new_pkgpart), 0) != cust_pkg.pkgpart";
4792 # parse package class
4795 if ( exists($params->{'classnum'}) ) {
4798 if ( ref($params->{'classnum'}) ) {
4800 if ( ref($params->{'classnum'}) eq 'HASH' ) {
4801 @classnum = grep $params->{'classnum'}{$_}, keys %{ $params->{'classnum'} };
4802 } elsif ( ref($params->{'classnum'}) eq 'ARRAY' ) {
4803 @classnum = @{ $params->{'classnum'} };
4805 die 'unhandled classnum ref '. $params->{'classnum'};
4809 } elsif ( $params->{'classnum'} =~ /^(\d*)$/ && $1 ne '0' ) {
4816 my @nums = grep $_, @classnum;
4817 push @c_where, 'part_pkg.classnum IN ('. join(',',@nums). ')' if @nums;
4818 my $null = scalar( grep { $_ eq '' } @classnum );
4819 push @c_where, 'part_pkg.classnum IS NULL' if $null;
4821 if ( scalar(@c_where) == 1 ) {
4822 push @where, @c_where;
4823 } elsif ( @c_where ) {
4824 push @where, ' ( '. join(' OR ', @c_where). ' ) ';
4833 # parse refnum (advertising source)
4836 if ( exists($params->{'refnum'}) ) {
4838 if (ref $params->{'refnum'}) {
4839 @refnum = @{ $params->{'refnum'} };
4841 @refnum = ( $params->{'refnum'} );
4843 my $in = join(',', grep /^\d+$/, @refnum);
4844 push @where, "refnum IN($in)" if length $in;
4848 # parse package report options
4851 my @report_option = ();
4852 if ( exists($params->{'report_option'}) ) {
4853 if ( ref($params->{'report_option'}) eq 'ARRAY' ) {
4854 @report_option = @{ $params->{'report_option'} };
4855 } elsif ( $params->{'report_option'} =~ /^([,\d]*)$/ ) {
4856 @report_option = split(',', $1);
4861 if (@report_option) {
4862 # this will result in the empty set for the dangling comma case as it should
4864 map{ "0 < ( SELECT count(*) FROM part_pkg_option
4865 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
4866 AND optionname = 'report_option_$_'
4867 AND optionvalue = '1' )"
4871 foreach my $any ( grep /^report_option_any/, keys %$params ) {
4873 my @report_option_any = ();
4874 if ( ref($params->{$any}) eq 'ARRAY' ) {
4875 @report_option_any = @{ $params->{$any} };
4876 } elsif ( $params->{$any} =~ /^([,\d]*)$/ ) {
4877 @report_option_any = split(',', $1);
4880 if (@report_option_any) {
4881 # this will result in the empty set for the dangling comma case as it should
4882 push @where, ' ( '. join(' OR ',
4883 map{ "0 < ( SELECT count(*) FROM part_pkg_option
4884 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
4885 AND optionname = 'report_option_$_'
4886 AND optionvalue = '1' )"
4887 } @report_option_any
4897 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
4903 push @where, "(part_pkg.fcc_ds0s > 0 OR pkg_class.fcc_ds0s > 0)"
4904 if $params->{fcc_line};
4910 if ( exists($params->{'censustract'}) ) {
4911 $params->{'censustract'} =~ /^([.\d]*)$/;
4912 my $censustract = "cust_location.censustract = '$1'";
4913 $censustract .= ' OR cust_location.censustract is NULL' unless $1;
4914 push @where, "( $censustract )";
4918 # parse censustract2
4920 if ( exists($params->{'censustract2'})
4921 && $params->{'censustract2'} =~ /^(\d*)$/
4925 push @where, "cust_location.censustract LIKE '$1%'";
4928 "( cust_location.censustract = '' OR cust_location.censustract IS NULL )";
4933 # parse country/state/zip
4935 for (qw(state country)) { # parsing rules are the same for these
4936 if ( exists($params->{$_})
4937 && uc($params->{$_}) =~ /^([A-Z]{2})$/ )
4939 # XXX post-2.3 only--before that, state/country may be in cust_main
4940 push @where, "cust_location.$_ = '$1'";
4943 if ( exists($params->{zip}) ) {
4944 push @where, "cust_location.zip = " . dbh->quote($params->{zip});
4950 if ( $params->{location_cust} xor $params->{location_nocust} ) {
4951 my $op = $params->{location_cust} ? '=' : '!=';
4952 push @where, "cust_location.locationnum $op cust_main.ship_locationnum";
4954 if ( $params->{location_census} xor $params->{location_nocensus} ) {
4955 my $op = $params->{location_census} ? "IS NOT NULL" : "IS NULL";
4956 push @where, "cust_location.censustract $op";
4958 if ( $params->{location_geocode} xor $params->{location_nogeocode} ) {
4959 my $op = $params->{location_geocode} ? "IS NOT NULL" : "IS NULL";
4960 push @where, "cust_location.geocode $op";
4967 if ( ref($params->{'pkgpart'}) ) {
4970 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
4971 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
4972 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
4973 @pkgpart = @{ $params->{'pkgpart'} };
4975 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
4978 @pkgpart = grep /^(\d+)$/, @pkgpart;
4980 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
4982 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
4983 push @where, "pkgpart = $1";
4992 #false laziness w/report_cust_pkg.html
4995 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
4996 'active' => { 'susp'=>1, 'cancel'=>1 },
4997 'suspended' => { 'cancel' => 1 },
5002 if( exists($params->{'active'} ) ) {
5003 # This overrides all the other date-related fields, and includes packages
5004 # that were active at some time during the interval. It excludes:
5005 # - packages that were set up after the end of the interval
5006 # - packages that were canceled before the start of the interval
5007 # - packages that were suspended before the start of the interval
5008 # and are still suspended now
5009 my($beginning, $ending) = @{$params->{'active'}};
5011 "cust_pkg.setup IS NOT NULL",
5012 "cust_pkg.setup <= $ending",
5013 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
5014 "(cust_pkg.susp IS NULL OR cust_pkg.susp >= $beginning )",
5015 "NOT (".FS::cust_pkg->onetime_sql . ")";
5018 my $exclude_change_from = 0;
5019 my $exclude_change_to = 0;
5021 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end change_date cancel )) {
5023 next unless exists($params->{$field});
5025 my($beginning, $ending) = @{$params->{$field}};
5027 next if $beginning == 0 && $ending == 4294967295;
5030 "cust_pkg.$field IS NOT NULL",
5031 "cust_pkg.$field >= $beginning",
5032 "cust_pkg.$field <= $ending";
5034 $orderby ||= "ORDER BY cust_pkg.$field";
5036 if ( $field eq 'setup' ) {
5037 $exclude_change_from = 1;
5038 } elsif ( $field eq 'cancel' ) {
5039 $exclude_change_to = 1;
5040 } elsif ( $field eq 'change_date' ) {
5041 # if we are given setup and change_date ranges, and the setup date
5042 # falls in _both_ ranges, then include the package whether it was
5044 $exclude_change_from = 0;
5048 if ($exclude_change_from) {
5049 push @where, "change_pkgnum IS NULL";
5051 if ($exclude_change_to) {
5052 # a join might be more efficient here
5053 push @where, "NOT EXISTS(
5054 SELECT 1 FROM cust_pkg AS changed_to_pkg
5055 WHERE cust_pkg.pkgnum = changed_to_pkg.change_pkgnum
5060 $orderby ||= 'ORDER BY bill';
5063 # parse magic, legacy, etc.
5066 if ( $params->{'magic'} &&
5067 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
5070 $orderby = 'ORDER BY pkgnum';
5072 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
5073 push @where, "pkgpart = $1";
5076 } elsif ( $params->{'query'} eq 'pkgnum' ) {
5078 $orderby = 'ORDER BY pkgnum';
5080 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
5082 $orderby = 'ORDER BY pkgnum';
5085 SELECT count(*) FROM pkg_svc
5086 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
5087 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
5088 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
5089 AND cust_svc.svcpart = pkg_svc.svcpart
5096 # parse the extremely weird 'towernum' param
5099 if ($params->{towernum}) {
5100 my $towernum = $params->{towernum};
5101 $towernum = [ $towernum ] if !ref($towernum);
5102 my $in = join(',', grep /^\d+$/, @$towernum);
5104 # inefficient, but this is an obscure feature
5105 eval "use FS::Report::Table";
5106 FS::Report::Table->_init_tower_pkg_cache; # probably does nothing
5107 push @where, "EXISTS(
5108 SELECT 1 FROM tower_pkg_cache
5109 WHERE tower_pkg_cache.pkgnum = cust_pkg.pkgnum
5110 AND tower_pkg_cache.towernum IN ($in)
5116 # parse the 477 report drill-down options
5119 if ($params->{'477part'} =~ /^([a-z]+)$/) {
5121 my ($date, $rownum, $agentnum);
5122 if ($params->{'date'} =~ /^(\d+)$/) {
5125 if ($params->{'477rownum'} =~ /^(\d+)$/) {
5128 if ($params->{'agentnum'} =~ /^(\d+)$/) {
5131 if ($date and defined($rownum)) {
5132 my $report = FS::Report::FCC_477->report($section,
5134 'agentnum' => $agentnum,
5137 my $pkgnums = $report->{detail}->[$rownum]
5138 or die "row $rownum is past the end of the report";
5139 # '0' so that if there are no pkgnums (empty string) it will create
5140 # a valid query that returns nothing
5141 warn "PKGNUMS:\n$pkgnums\n\n"; # XXX debug
5143 # and this overrides everything
5144 @where = ( "cust_pkg.pkgnum IN($pkgnums)" );
5145 } # else we're missing some params, ignore the whole business
5149 # setup queries, links, subs, etc. for the search
5152 # here is the agent virtualization
5153 if ($params->{CurrentUser}) {
5155 qsearchs('access_user', { username => $params->{CurrentUser} });
5158 push @where, $access_user->agentnums_sql('table'=>'cust_main');
5163 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
5166 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
5168 my $addl_from = 'LEFT JOIN part_pkg USING ( pkgpart ) '.
5169 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) '.
5170 'LEFT JOIN cust_location USING ( locationnum ) '.
5171 FS::UI::Web::join_cust_main('cust_pkg', 'cust_pkg');
5175 if ( $params->{'select_zip5'} ) {
5176 my $zip = 'cust_location.zip';
5178 $select = "DISTINCT substr($zip,1,5) as zip";
5179 $orderby = "ORDER BY substr($zip,1,5)";
5180 $count_query = "SELECT COUNT( DISTINCT substr($zip,1,5) )";
5182 $select = join(', ',
5184 ( map "part_pkg.$_", qw( pkg freq ) ),
5185 'pkg_class.classname',
5186 'cust_main.custnum AS cust_main_custnum',
5187 FS::UI::Web::cust_sql_fields(
5188 $params->{'cust_fields'}
5191 $count_query = 'SELECT COUNT(*)';
5194 $count_query .= " FROM cust_pkg $addl_from $extra_sql";
5197 'table' => 'cust_pkg',
5199 'select' => $select,
5200 'extra_sql' => $extra_sql,
5201 'order_by' => $orderby,
5202 'addl_from' => $addl_from,
5203 'count_query' => $count_query,
5210 Returns a list of two package counts. The first is a count of packages
5211 based on the supplied criteria and the second is the count of residential
5212 packages with those same criteria. Criteria are specified as in the search
5218 my ($class, $params) = @_;
5220 my $sql_query = $class->search( $params );
5222 my $count_sql = delete($sql_query->{'count_query'});
5223 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
5224 or die "couldn't parse count_sql";
5226 my $count_sth = dbh->prepare($count_sql)
5227 or die "Error preparing $count_sql: ". dbh->errstr;
5229 or die "Error executing $count_sql: ". $count_sth->errstr;
5230 my $count_arrayref = $count_sth->fetchrow_arrayref;
5232 return ( @$count_arrayref );
5236 =item tax_locationnum_sql
5238 Returns an SQL expression for the tax location for a package, based
5239 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
5243 sub tax_locationnum_sql {
5244 my $conf = FS::Conf->new;
5245 if ( $conf->exists('tax-pkg_address') ) {
5246 'cust_pkg.locationnum';
5248 elsif ( $conf->exists('tax-ship_address') ) {
5249 'cust_main.ship_locationnum';
5252 'cust_main.bill_locationnum';
5258 Returns a list: the first item is an SQL fragment identifying matching
5259 packages/customers via location (taking into account shipping and package
5260 address taxation, if enabled), and subsequent items are the parameters to
5261 substitute for the placeholders in that fragment.
5266 my($class, %opt) = @_;
5267 my $ornull = $opt{'ornull'};
5269 my $conf = new FS::Conf;
5271 # '?' placeholders in _location_sql_where
5272 my $x = $ornull ? 3 : 2;
5283 if ( $conf->exists('tax-ship_address') ) {
5286 ( ( ship_last IS NULL OR ship_last = '' )
5287 AND ". _location_sql_where('cust_main', '', $ornull ). "
5289 OR ( ship_last IS NOT NULL AND ship_last != ''
5290 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
5293 # AND payby != 'COMP'
5295 @main_param = ( @bill_param, @bill_param );
5299 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
5300 @main_param = @bill_param;
5306 if ( $conf->exists('tax-pkg_address') ) {
5308 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
5311 ( cust_pkg.locationnum IS NULL AND $main_where )
5312 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
5315 @param = ( @main_param, @bill_param );
5319 $where = $main_where;
5320 @param = @main_param;
5328 #subroutine, helper for location_sql
5329 sub _location_sql_where {
5331 my $prefix = @_ ? shift : '';
5332 my $ornull = @_ ? shift : '';
5334 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
5336 $ornull = $ornull ? ' OR ? IS NULL ' : '';
5338 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
5339 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
5340 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
5342 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
5344 # ( $table.${prefix}city = ? $or_empty_city $ornull )
5346 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
5347 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
5348 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
5349 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
5350 AND $table.${prefix}country = ?
5355 my( $self, $what ) = @_;
5357 my $what_show_zero = $what. '_show_zero';
5358 length($self->$what_show_zero())
5359 ? ($self->$what_show_zero() eq 'Y')
5360 : $self->part_pkg->$what_show_zero();
5367 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
5369 Bulk cancel + order subroutine. Perhaps slightly deprecated, only used by the
5370 bulk cancel+order in the web UI and nowhere else (edit/process/cust_pkg.cgi)
5372 CUSTNUM is a customer (see L<FS::cust_main>)
5374 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5375 L<FS::part_pkg>) to order for this customer. Duplicates are of course
5378 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
5379 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
5380 new billing items. An error is returned if this is not possible (see
5381 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
5384 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5385 newly-created cust_pkg objects.
5387 REFNUM, if specified, will specify the FS::pkg_referral record to be created
5388 and inserted. Multiple FS::pkg_referral records can be created by
5389 setting I<refnum> to an array reference of refnums or a hash reference with
5390 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
5391 record will be created corresponding to cust_main.refnum.
5396 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
5398 my $conf = new FS::Conf;
5400 # Transactionize this whole mess
5401 local $SIG{HUP} = 'IGNORE';
5402 local $SIG{INT} = 'IGNORE';
5403 local $SIG{QUIT} = 'IGNORE';
5404 local $SIG{TERM} = 'IGNORE';
5405 local $SIG{TSTP} = 'IGNORE';
5406 local $SIG{PIPE} = 'IGNORE';
5408 my $oldAutoCommit = $FS::UID::AutoCommit;
5409 local $FS::UID::AutoCommit = 0;
5413 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
5414 # return "Customer not found: $custnum" unless $cust_main;
5416 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
5419 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5422 my $change = scalar(@old_cust_pkg) != 0;
5425 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
5427 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
5428 " to pkgpart ". $pkgparts->[0]. "\n"
5431 my $err_or_cust_pkg =
5432 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
5433 'refnum' => $refnum,
5436 unless (ref($err_or_cust_pkg)) {
5437 $dbh->rollback if $oldAutoCommit;
5438 return $err_or_cust_pkg;
5441 push @$return_cust_pkg, $err_or_cust_pkg;
5442 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5447 # Create the new packages.
5448 foreach my $pkgpart (@$pkgparts) {
5450 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
5452 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
5453 pkgpart => $pkgpart,
5457 $error = $cust_pkg->insert( 'change' => $change );
5458 push @$return_cust_pkg, $cust_pkg;
5460 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
5461 my $supp_pkg = FS::cust_pkg->new({
5462 custnum => $custnum,
5463 pkgpart => $link->dst_pkgpart,
5465 main_pkgnum => $cust_pkg->pkgnum,
5468 $error ||= $supp_pkg->insert( 'change' => $change );
5469 push @$return_cust_pkg, $supp_pkg;
5473 $dbh->rollback if $oldAutoCommit;
5478 # $return_cust_pkg now contains refs to all of the newly
5481 # Transfer services and cancel old packages.
5482 foreach my $old_pkg (@old_cust_pkg) {
5484 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
5487 foreach my $new_pkg (@$return_cust_pkg) {
5488 $error = $old_pkg->transfer($new_pkg);
5489 if ($error and $error == 0) {
5490 # $old_pkg->transfer failed.
5491 $dbh->rollback if $oldAutoCommit;
5496 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
5497 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
5498 foreach my $new_pkg (@$return_cust_pkg) {
5499 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
5500 if ($error and $error == 0) {
5501 # $old_pkg->transfer failed.
5502 $dbh->rollback if $oldAutoCommit;
5509 # Transfers were successful, but we went through all of the
5510 # new packages and still had services left on the old package.
5511 # We can't cancel the package under the circumstances, so abort.
5512 $dbh->rollback if $oldAutoCommit;
5513 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
5515 $error = $old_pkg->cancel( quiet=>1, 'no_delay_cancel'=>1 );
5521 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5525 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
5527 A bulk change method to change packages for multiple customers.
5529 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5530 L<FS::part_pkg>) to order for each customer. Duplicates are of course
5533 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
5534 replace. The services (see L<FS::cust_svc>) are moved to the
5535 new billing items. An error is returned if this is not possible (see
5538 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5539 newly-created cust_pkg objects.
5544 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
5546 # Transactionize this whole mess
5547 local $SIG{HUP} = 'IGNORE';
5548 local $SIG{INT} = 'IGNORE';
5549 local $SIG{QUIT} = 'IGNORE';
5550 local $SIG{TERM} = 'IGNORE';
5551 local $SIG{TSTP} = 'IGNORE';
5552 local $SIG{PIPE} = 'IGNORE';
5554 my $oldAutoCommit = $FS::UID::AutoCommit;
5555 local $FS::UID::AutoCommit = 0;
5559 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5562 while(scalar(@old_cust_pkg)) {
5564 my $custnum = $old_cust_pkg[0]->custnum;
5565 my (@remove) = map { $_->pkgnum }
5566 grep { $_->custnum == $custnum } @old_cust_pkg;
5567 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
5569 my $error = order $custnum, $pkgparts, \@remove, \@return;
5571 push @errors, $error
5573 push @$return_cust_pkg, @return;
5576 if (scalar(@errors)) {
5577 $dbh->rollback if $oldAutoCommit;
5578 return join(' / ', @errors);
5581 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5585 # Used by FS::Upgrade to migrate to a new database.
5586 sub _upgrade_data { # class method
5587 my ($class, %opts) = @_;
5588 $class->_upgrade_otaker(%opts);
5590 # RT#10139, bug resulting in contract_end being set when it shouldn't
5591 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
5592 # RT#10830, bad calculation of prorate date near end of year
5593 # the date range for bill is December 2009, and we move it forward
5594 # one year if it's before the previous bill date (which it should
5596 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
5597 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
5598 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
5599 # RT6628, add order_date to cust_pkg
5600 'update cust_pkg set order_date = (select history_date from h_cust_pkg
5601 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
5602 history_action = \'insert\') where order_date is null',
5604 foreach my $sql (@statements) {
5605 my $sth = dbh->prepare($sql);
5606 $sth->execute or die $sth->errstr;
5609 # RT31194: supplemental package links that are deleted don't clean up
5611 my @pkglinknums = qsearch({
5612 'select' => 'DISTINCT cust_pkg.pkglinknum',
5613 'table' => 'cust_pkg',
5614 'addl_from' => ' LEFT JOIN part_pkg_link USING (pkglinknum) ',
5615 'extra_sql' => ' WHERE cust_pkg.pkglinknum IS NOT NULL
5616 AND part_pkg_link.pkglinknum IS NULL',
5618 foreach (@pkglinknums) {
5619 my $pkglinknum = $_->pkglinknum;
5620 warn "cleaning part_pkg_link #$pkglinknum\n";
5621 my $part_pkg_link = FS::part_pkg_link->new({pkglinknum => $pkglinknum});
5622 my $error = $part_pkg_link->remove_linked;
5623 die $error if $error;
5631 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
5633 In sub order, the @pkgparts array (passed by reference) is clobbered.
5635 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
5636 method to pass dates to the recur_prog expression, it should do so.
5638 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
5639 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
5640 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
5641 configuration values. Probably need a subroutine which decides what to do
5642 based on whether or not we've fetched the user yet, rather than a hash. See
5643 FS::UID and the TODO.
5645 Now that things are transactional should the check in the insert method be
5650 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
5651 L<FS::pkg_svc>, schema.html from the base documentation