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 $error = FS::cust_pkg::order( $custnum, \@pkgparts );
112 $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );
116 An FS::cust_pkg object represents a customer billing item. FS::cust_pkg
117 inherits from FS::Record. The following fields are currently supported:
123 Primary key (assigned automatically for new billing items)
127 Customer (see L<FS::cust_main>)
131 Billing item definition (see L<FS::part_pkg>)
135 Optional link to package location (see L<FS::location>)
139 date package was ordered (also remains same on changes)
151 date (next bill date)
179 order taker (see L<FS::access_user>)
183 If this field is set to 1, disables the automatic
184 unsuspension of this package when using the B<unsuspendauto> config option.
188 If not set, defaults to 1
192 Date of change from previous package
202 =item change_locationnum
210 The pkgnum of the package that this package is supplemental to, if any.
214 The package link (L<FS::part_pkg_link>) that defines this supplemental
215 package, if it is one.
217 =item change_to_pkgnum
219 The pkgnum of the package this one will be "changed to" in the future
220 (on its expiration date).
224 Note: setup, last_bill, bill, adjourn, susp, expire, cancel and change_date
225 are specified as UNIX timestamps; see L<perlfunc/"time">. Also see
226 L<Time::Local> and L<Date::Parse> for conversion functions.
234 Create a new billing item. To add the item to the database, see L<"insert">.
238 sub table { 'cust_pkg'; }
239 sub cust_linked { $_[0]->cust_main_custnum || $_[0]->custnum }
240 sub cust_unlinked_msg {
242 "WARNING: can't find cust_main.custnum ". $self->custnum.
243 ' (cust_pkg.pkgnum '. $self->pkgnum. ')';
246 =item set_initial_timers
248 If required by the package definition, sets any automatic expire, adjourn,
249 or contract_end timers to some number of months after the start date
250 (or setup date, if the package has already been setup). If the package has
251 a delayed setup fee after a period of "free days", will also set the
252 start date to the end of that period.
256 sub set_initial_timers {
258 my $part_pkg = $self->part_pkg;
259 foreach my $action ( qw(expire adjourn contract_end) ) {
260 my $months = $part_pkg->option("${action}_months",1);
261 if($months and !$self->get($action)) {
262 my $start = $self->start_date || $self->setup || time;
263 $self->set($action, $part_pkg->add_freq($start, $months) );
267 # if this package has "free days" and delayed setup fee, then
268 # set start date that many days in the future.
269 # (this should have been set in the UI, but enforce it here)
270 if ( $part_pkg->option('free_days',1)
271 && $part_pkg->option('delay_setup',1)
274 $self->start_date( $part_pkg->default_start_date );
279 =item insert [ OPTION => VALUE ... ]
281 Adds this billing item to the database ("Orders" the item). If there is an
282 error, returns the error, otherwise returns false.
284 If the additional field I<promo_code> is defined instead of I<pkgpart>, it
285 will be used to look up the package definition and agent restrictions will be
288 If the additional field I<refnum> is defined, an FS::pkg_referral record will
289 be created and inserted. Multiple FS::pkg_referral records can be created by
290 setting I<refnum> to an array reference of refnums or a hash reference with
291 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
292 record will be created corresponding to cust_main.refnum.
294 The following options are available:
300 If set true, supresses actions that should only be taken for new package
301 orders. (Currently this includes: intro periods when delay_setup is on,
302 auto-adding a 1st start date, auto-adding expiration/adjourn/contract_end dates)
306 cust_pkg_option records will be created
310 a ticket will be added to this customer with this subject
314 an optional queue name for ticket additions
318 Don't check the legality of the package definition. This should be used
319 when performing a package change that doesn't change the pkgpart (i.e.
327 my( $self, %options ) = @_;
330 $error = $self->check_pkgpart unless $options{'allow_pkgpart'};
331 return $error if $error;
333 my $part_pkg = $self->part_pkg;
335 if ( ! $options{'change'} ) {
337 # set order date to now
338 $self->order_date(time);
340 # if the package def says to start only on the first of the month:
341 if ( $part_pkg->option('start_1st', 1) && !$self->start_date ) {
342 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime(time) )[0,1,2,3,4,5];
343 $mon += 1 unless $mday == 1;
344 until ( $mon < 12 ) { $mon -= 12; $year++; }
345 $self->start_date( timelocal_nocheck(0,0,0,1,$mon,$year) );
348 if ($self->susp eq 'now' or $part_pkg->start_on_hold) {
349 # if the package was ordered on hold:
351 # - don't set the start date (it will be started manually)
352 $self->set('susp', $self->order_date);
353 $self->set('start_date', '');
355 # set expire/adjourn/contract_end timers, and free days, if appropriate
356 $self->set_initial_timers;
358 } # else this is a package change, and shouldn't have "new package" behavior
360 local $SIG{HUP} = 'IGNORE';
361 local $SIG{INT} = 'IGNORE';
362 local $SIG{QUIT} = 'IGNORE';
363 local $SIG{TERM} = 'IGNORE';
364 local $SIG{TSTP} = 'IGNORE';
365 local $SIG{PIPE} = 'IGNORE';
367 my $oldAutoCommit = $FS::UID::AutoCommit;
368 local $FS::UID::AutoCommit = 0;
371 $error = $self->SUPER::insert($options{options} ? %{$options{options}} : ());
373 $dbh->rollback if $oldAutoCommit;
377 $self->refnum($self->cust_main->refnum) unless $self->refnum;
378 $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
379 $self->process_m2m( 'link_table' => 'pkg_referral',
380 'target_table' => 'part_referral',
381 'params' => $self->refnum,
384 if ( $self->discountnum ) {
385 my $error = $self->insert_discount();
387 $dbh->rollback if $oldAutoCommit;
392 my $conf = new FS::Conf;
394 if ( $conf->config('ticket_system') && $options{ticket_subject} ) {
396 #this init stuff is still inefficient, but at least its limited to
397 # the small number (any?) folks using ticket emailing on pkg order
400 # use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
407 use FS::TicketSystem;
408 FS::TicketSystem->init();
410 my $q = new RT::Queue($RT::SystemUser);
411 $q->Load($options{ticket_queue}) if $options{ticket_queue};
412 my $t = new RT::Ticket($RT::SystemUser);
413 my $mime = new MIME::Entity;
414 $mime->build( Type => 'text/plain', Data => $options{ticket_subject} );
415 $t->Create( $options{ticket_queue} ? (Queue => $q) : (),
416 Subject => $options{ticket_subject},
419 $t->AddLink( Type => 'MemberOf',
420 Target => 'freeside://freeside/cust_main/'. $self->custnum,
424 if ($conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
425 my $queue = new FS::queue {
426 'job' => 'FS::cust_main::queueable_print',
428 $error = $queue->insert(
429 'custnum' => $self->custnum,
430 'template' => 'welcome_letter',
434 warn "can't send welcome letter: $error";
439 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
446 This method now works but you probably shouldn't use it.
448 You don't want to delete packages, because there would then be no record
449 the customer ever purchased the package. Instead, see the cancel method and
450 hide cancelled packages.
457 local $SIG{HUP} = 'IGNORE';
458 local $SIG{INT} = 'IGNORE';
459 local $SIG{QUIT} = 'IGNORE';
460 local $SIG{TERM} = 'IGNORE';
461 local $SIG{TSTP} = 'IGNORE';
462 local $SIG{PIPE} = 'IGNORE';
464 my $oldAutoCommit = $FS::UID::AutoCommit;
465 local $FS::UID::AutoCommit = 0;
468 foreach my $cust_pkg_discount ($self->cust_pkg_discount) {
469 my $error = $cust_pkg_discount->delete;
471 $dbh->rollback if $oldAutoCommit;
475 #cust_bill_pkg_discount?
477 foreach my $cust_pkg_detail ($self->cust_pkg_detail) {
478 my $error = $cust_pkg_detail->delete;
480 $dbh->rollback if $oldAutoCommit;
485 foreach my $cust_pkg_reason (
487 'table' => 'cust_pkg_reason',
488 'hashref' => { 'pkgnum' => $self->pkgnum },
492 my $error = $cust_pkg_reason->delete;
494 $dbh->rollback if $oldAutoCommit;
501 my $error = $self->SUPER::delete(@_);
503 $dbh->rollback if $oldAutoCommit;
507 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
513 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
515 Replaces the OLD_RECORD with this one in the database. If there is an error,
516 returns the error, otherwise returns false.
518 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
520 Changing pkgpart may have disasterous effects. See the order subroutine.
522 setup and bill are normally updated by calling the bill method of a customer
523 object (see L<FS::cust_main>).
525 suspend is normally updated by the suspend and unsuspend methods.
527 cancel is normally updated by the cancel method (and also the order subroutine
530 Available options are:
536 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.
540 the access_user (see L<FS::access_user>) providing the reason
544 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
553 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
558 ( ref($_[0]) eq 'HASH' )
562 #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
563 #return "Can't change otaker!" if $old->otaker ne $new->otaker;
566 #return "Can't change setup once it exists!"
567 # if $old->getfield('setup') &&
568 # $old->getfield('setup') != $new->getfield('setup');
570 #some logic for bill, susp, cancel?
572 local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
574 local $SIG{HUP} = 'IGNORE';
575 local $SIG{INT} = 'IGNORE';
576 local $SIG{QUIT} = 'IGNORE';
577 local $SIG{TERM} = 'IGNORE';
578 local $SIG{TSTP} = 'IGNORE';
579 local $SIG{PIPE} = 'IGNORE';
581 my $oldAutoCommit = $FS::UID::AutoCommit;
582 local $FS::UID::AutoCommit = 0;
585 foreach my $method ( qw(adjourn expire) ) { # How many reasons?
586 if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
587 my $error = $new->insert_reason(
588 'reason' => $options->{'reason'},
589 'date' => $new->$method,
591 'reason_otaker' => $options->{'reason_otaker'},
594 dbh->rollback if $oldAutoCommit;
595 return "Error inserting cust_pkg_reason: $error";
600 #save off and freeze RADIUS attributes for any associated svc_acct records
602 if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
604 #also check for specific exports?
605 # to avoid spurious modify export events
606 @svc_acct = map { $_->svc_x }
607 grep { $_->part_svc->svcdb eq 'svc_acct' }
610 $_->snapshot foreach @svc_acct;
614 my $error = $new->export_pkg_change($old)
615 || $new->SUPER::replace( $old,
617 ? $options->{options}
621 $dbh->rollback if $oldAutoCommit;
625 #for prepaid packages,
626 #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
627 foreach my $old_svc_acct ( @svc_acct ) {
628 my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
630 $new_svc_acct->replace( $old_svc_acct,
631 'depend_jobnum' => $options->{depend_jobnum},
634 $dbh->rollback if $oldAutoCommit;
639 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
646 Checks all fields to make sure this is a valid billing item. If there is an
647 error, returns the error, otherwise returns false. Called by the insert and
655 if ( !$self->locationnum or $self->locationnum == -1 ) {
656 $self->set('locationnum', $self->cust_main->ship_locationnum);
660 $self->ut_numbern('pkgnum')
661 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
662 || $self->ut_numbern('pkgpart')
663 || $self->ut_foreign_keyn('contactnum', 'contact', 'contactnum' )
664 || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
665 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
666 || $self->ut_numbern('quantity')
667 || $self->ut_numbern('start_date')
668 || $self->ut_numbern('setup')
669 || $self->ut_numbern('bill')
670 || $self->ut_numbern('susp')
671 || $self->ut_numbern('cancel')
672 || $self->ut_numbern('adjourn')
673 || $self->ut_numbern('resume')
674 || $self->ut_numbern('expire')
675 || $self->ut_numbern('dundate')
676 || $self->ut_enum('no_auto', [ '', 'Y' ])
677 || $self->ut_enum('waive_setup', [ '', 'Y' ])
678 || $self->ut_textn('agent_pkgid')
679 || $self->ut_enum('recur_show_zero', [ '', 'Y', 'N', ])
680 || $self->ut_enum('setup_show_zero', [ '', 'Y', 'N', ])
681 || $self->ut_foreign_keyn('main_pkgnum', 'cust_pkg', 'pkgnum')
682 || $self->ut_foreign_keyn('pkglinknum', 'part_pkg_link', 'pkglinknum')
683 || $self->ut_foreign_keyn('change_to_pkgnum', 'cust_pkg', 'pkgnum')
685 return $error if $error;
687 return "A package with both start date (future start) and setup date (already started) will never bill"
688 if $self->start_date && $self->setup && ! $upgrade;
690 return "A future unsuspend date can only be set for a package with a suspend date"
691 if $self->resume and !$self->susp and !$self->adjourn;
693 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
695 if ( $self->dbdef_table->column('manual_flag') ) {
696 $self->manual_flag('') if $self->manual_flag eq ' ';
697 $self->manual_flag =~ /^([01]?)$/
698 or return "Illegal manual_flag ". $self->manual_flag;
699 $self->manual_flag($1);
707 Check the pkgpart to make sure it's allowed with the reg_code and/or
708 promo_code of the package (if present) and with the customer's agent.
709 Called from C<insert>, unless we are doing a package change that doesn't
717 # my $error = $self->ut_numbern('pkgpart'); # already done
720 if ( $self->reg_code ) {
722 unless ( grep { $self->pkgpart == $_->pkgpart }
723 map { $_->reg_code_pkg }
724 qsearchs( 'reg_code', { 'code' => $self->reg_code,
725 'agentnum' => $self->cust_main->agentnum })
727 return "Unknown registration code";
730 } elsif ( $self->promo_code ) {
733 qsearchs('part_pkg', {
734 'pkgpart' => $self->pkgpart,
735 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
737 return 'Unknown promotional code' unless $promo_part_pkg;
741 unless ( $disable_agentcheck ) {
743 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
744 return "agent ". $agent->agentnum. ':'. $agent->agent.
745 " can't purchase pkgpart ". $self->pkgpart
746 unless $agent->pkgpart_hashref->{ $self->pkgpart }
747 || $agent->agentnum == $self->part_pkg->agentnum;
750 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
751 return $error if $error;
759 =item cancel [ OPTION => VALUE ... ]
761 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
762 in this package, then cancels the package itself (sets the cancel field to
765 Available options are:
769 =item quiet - can be set true to supress email cancellation notices.
771 =item time - can be set to cancel the package based on a specific future or
772 historical date. Using time ensures that the remaining amount is calculated
773 correctly. Note however that this is an immediate cancel and just changes
774 the date. You are PROBABLY looking to expire the account instead of using
777 =item reason - can be set to a cancellation reason (see L<FS:reason>),
778 either a reasonnum of an existing reason, or passing a hashref will create
779 a new reason. The hashref should have the following keys: typenum - Reason
780 type (see L<FS::reason_type>, reason - Text of the new reason.
782 =item date - can be set to a unix style timestamp to specify when to
785 =item nobill - can be set true to skip billing if it might otherwise be done.
787 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
788 not credit it. This must be set (by change()) when changing the package
789 to a different pkgpart or location, and probably shouldn't be in any other
790 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
795 If there is an error, returns the error, otherwise returns false.
800 my( $self, %options ) = @_;
803 # pass all suspend/cancel actions to the main package
804 # (unless the pkglinknum has been removed, then the link is defunct and
805 # this package can be canceled on its own)
806 if ( $self->main_pkgnum and $self->pkglinknum and !$options{'from_main'} ) {
807 return $self->main_pkg->cancel(%options);
810 my $conf = new FS::Conf;
812 warn "cust_pkg::cancel called with options".
813 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
816 local $SIG{HUP} = 'IGNORE';
817 local $SIG{INT} = 'IGNORE';
818 local $SIG{QUIT} = 'IGNORE';
819 local $SIG{TERM} = 'IGNORE';
820 local $SIG{TSTP} = 'IGNORE';
821 local $SIG{PIPE} = 'IGNORE';
823 my $oldAutoCommit = $FS::UID::AutoCommit;
824 local $FS::UID::AutoCommit = 0;
827 my $old = $self->select_for_update;
829 if ( $old->get('cancel') || $self->get('cancel') ) {
830 dbh->rollback if $oldAutoCommit;
831 return ""; # no error
834 # XXX possibly set cancel_time to the expire date?
835 my $cancel_time = $options{'time'} || time;
836 my $date = $options{'date'} if $options{'date'}; # expire/cancel later
837 $date = '' if ($date && $date <= $cancel_time); # complain instead?
839 #race condition: usage could be ongoing until unprovisioned
840 #resolved by performing a change package instead (which unprovisions) and
842 if ( !$options{nobill} && !$date ) {
843 # && $conf->exists('bill_usage_on_cancel') ) { #calc_cancel checks this
844 my $copy = $self->new({$self->hash});
846 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
848 'time' => $cancel_time );
849 warn "Error billing during cancel, custnum ".
850 #$self->cust_main->custnum. ": $error"
855 if ( $options{'reason'} ) {
856 $error = $self->insert_reason( 'reason' => $options{'reason'},
857 'action' => $date ? 'expire' : 'cancel',
858 'date' => $date ? $date : $cancel_time,
859 'reason_otaker' => $options{'reason_otaker'},
862 dbh->rollback if $oldAutoCommit;
863 return "Error inserting cust_pkg_reason: $error";
867 my %svc_cancel_opt = ();
868 $svc_cancel_opt{'date'} = $date if $date;
869 foreach my $cust_svc (
872 sort { $a->[1] <=> $b->[1] }
873 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; }
874 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
876 my $part_svc = $cust_svc->part_svc;
877 next if ( defined($part_svc) and $part_svc->preserve );
878 my $error = $cust_svc->cancel( %svc_cancel_opt );
881 $dbh->rollback if $oldAutoCommit;
882 return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
888 # credit remaining time if appropriate
890 if ( exists($options{'unused_credit'}) ) {
891 $do_credit = $options{'unused_credit'};
894 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
897 my $error = $self->credit_remaining('cancel', $cancel_time);
899 $dbh->rollback if $oldAutoCommit;
906 my %hash = $self->hash;
908 $hash{'expire'} = $date;
910 $hash{'cancel'} = $cancel_time;
912 $hash{'change_custnum'} = $options{'change_custnum'};
914 # if this is a supplemental package that's lost its part_pkg_link, and it's
915 # being canceled for real, unlink it completely
916 if ( !$date and ! $self->pkglinknum ) {
917 $hash{main_pkgnum} = '';
920 my $new = new FS::cust_pkg ( \%hash );
921 $error = $new->replace( $self, options => { $self->options } );
922 if ( $self->change_to_pkgnum ) {
923 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
924 $error ||= $change_to->cancel || $change_to->delete;
927 $dbh->rollback if $oldAutoCommit;
931 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
932 $error = $supp_pkg->cancel(%options, 'from_main' => 1);
934 $dbh->rollback if $oldAutoCommit;
935 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
939 foreach my $usage ( $self->cust_pkg_usage ) {
940 $error = $usage->delete;
942 $dbh->rollback if $oldAutoCommit;
943 return "deleting usage pools: $error";
947 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
948 return '' if $date; #no errors
950 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
951 if ( !$options{'quiet'} &&
952 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
954 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
957 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
958 $error = $msg_template->send( 'cust_main' => $self->cust_main,
963 'from' => $conf->invoice_from_full( $self->cust_main->agentnum ),
964 'to' => \@invoicing_list,
965 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
966 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
967 'custnum' => $self->custnum,
968 'msgtype' => '', #admin?
971 #should this do something on errors?
978 =item cancel_if_expired [ NOW_TIMESTAMP ]
980 Cancels this package if its expire date has been reached.
984 sub cancel_if_expired {
986 my $time = shift || time;
987 return '' unless $self->expire && $self->expire <= $time;
988 my $error = $self->cancel;
990 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
991 $self->custnum. ": $error";
998 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
999 locationnum, (other fields?). Attempts to re-provision cancelled services
1000 using history information (errors at this stage are not fatal).
1002 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
1004 svc_fatal: service provisioning errors are fatal
1006 svc_errors: pass an array reference, will be filled in with any provisioning errors
1008 main_pkgnum: link the package as a supplemental package of this one. For
1014 my( $self, %options ) = @_;
1016 #in case you try do do $uncancel-date = $cust_pkg->uncacel
1017 return '' unless $self->get('cancel');
1019 if ( $self->main_pkgnum and !$options{'main_pkgnum'} ) {
1020 return $self->main_pkg->uncancel(%options);
1027 local $SIG{HUP} = 'IGNORE';
1028 local $SIG{INT} = 'IGNORE';
1029 local $SIG{QUIT} = 'IGNORE';
1030 local $SIG{TERM} = 'IGNORE';
1031 local $SIG{TSTP} = 'IGNORE';
1032 local $SIG{PIPE} = 'IGNORE';
1034 my $oldAutoCommit = $FS::UID::AutoCommit;
1035 local $FS::UID::AutoCommit = 0;
1039 # insert the new package
1042 my $cust_pkg = new FS::cust_pkg {
1043 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
1044 bill => ( $options{'bill'} || $self->get('bill') ),
1046 uncancel_pkgnum => $self->pkgnum,
1047 main_pkgnum => ($options{'main_pkgnum'} || ''),
1048 map { $_ => $self->get($_) } qw(
1049 custnum pkgpart locationnum
1051 susp adjourn resume expire start_date contract_end dundate
1052 change_date change_pkgpart change_locationnum
1053 manual_flag no_auto quantity agent_pkgid recur_show_zero setup_show_zero
1057 my $error = $cust_pkg->insert(
1058 'change' => 1, #supresses any referral credit to a referring customer
1059 'allow_pkgpart' => 1, # allow this even if the package def is disabled
1062 $dbh->rollback if $oldAutoCommit;
1070 #find historical services within this timeframe before the package cancel
1071 # (incompatible with "time" option to cust_pkg->cancel?)
1072 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
1073 # too little? (unprovisioing export delay?)
1074 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
1075 my @h_cust_svc = $self->h_cust_svc( $end, $start );
1078 foreach my $h_cust_svc (@h_cust_svc) {
1079 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
1080 #next unless $h_svc_x; #should this happen?
1081 (my $table = $h_svc_x->table) =~ s/^h_//;
1082 require "FS/$table.pm";
1083 my $class = "FS::$table";
1084 my $svc_x = $class->new( {
1085 'pkgnum' => $cust_pkg->pkgnum,
1086 'svcpart' => $h_cust_svc->svcpart,
1087 map { $_ => $h_svc_x->get($_) } fields($table)
1091 if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
1092 $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
1095 my $svc_error = $svc_x->insert;
1097 if ( $options{svc_fatal} ) {
1098 $dbh->rollback if $oldAutoCommit;
1101 # if we've failed to insert the svc_x object, svc_Common->insert
1102 # will have removed the cust_svc already. if not, then both records
1103 # were inserted but we failed for some other reason (export, most
1104 # likely). in that case, report the error and delete the records.
1105 push @svc_errors, $svc_error;
1106 my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1108 # except if export_insert failed, export_delete probably won't be
1110 local $FS::svc_Common::noexport_hack = 1;
1111 my $cleanup_error = $svc_x->delete; # also deletes cust_svc
1112 if ( $cleanup_error ) { # and if THAT fails, then run away
1113 $dbh->rollback if $oldAutoCommit;
1114 return $cleanup_error;
1119 } #foreach $h_cust_svc
1121 #these are pretty rare, but should handle them
1122 # - dsl_device (mac addresses)
1123 # - phone_device (mac addresses)
1124 # - dsl_note (ikano notes)
1125 # - domain_record (i.e. restore DNS information w/domains)
1126 # - inventory_item(?) (inventory w/un-cancelling service?)
1127 # - nas (svc_broaband nas stuff)
1128 #this stuff is unused in the wild afaik
1129 # - mailinglistmember
1131 # - svc_domain.parent_svcnum?
1132 # - acct_snarf (ancient mail fetching config)
1133 # - cgp_rule (communigate)
1134 # - cust_svc_option (used by our Tron stuff)
1135 # - acct_rt_transaction (used by our time worked stuff)
1138 # also move over any services that didn't unprovision at cancellation
1141 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1142 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1143 my $error = $cust_svc->replace;
1145 $dbh->rollback if $oldAutoCommit;
1151 # Uncancel any supplemental packages, and make them supplemental to the
1155 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1157 $error = $supp_pkg->uncancel(%options, 'main_pkgnum' => $cust_pkg->pkgnum);
1159 $dbh->rollback if $oldAutoCommit;
1160 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1168 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1170 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1171 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1178 Cancels any pending expiration (sets the expire field to null).
1180 If there is an error, returns the error, otherwise returns false.
1185 my( $self, %options ) = @_;
1188 local $SIG{HUP} = 'IGNORE';
1189 local $SIG{INT} = 'IGNORE';
1190 local $SIG{QUIT} = 'IGNORE';
1191 local $SIG{TERM} = 'IGNORE';
1192 local $SIG{TSTP} = 'IGNORE';
1193 local $SIG{PIPE} = 'IGNORE';
1195 my $oldAutoCommit = $FS::UID::AutoCommit;
1196 local $FS::UID::AutoCommit = 0;
1199 my $old = $self->select_for_update;
1201 my $pkgnum = $old->pkgnum;
1202 if ( $old->get('cancel') || $self->get('cancel') ) {
1203 dbh->rollback if $oldAutoCommit;
1204 return "Can't unexpire cancelled package $pkgnum";
1205 # or at least it's pointless
1208 unless ( $old->get('expire') && $self->get('expire') ) {
1209 dbh->rollback if $oldAutoCommit;
1210 return ""; # no error
1213 my %hash = $self->hash;
1214 $hash{'expire'} = '';
1215 my $new = new FS::cust_pkg ( \%hash );
1216 $error = $new->replace( $self, options => { $self->options } );
1218 $dbh->rollback if $oldAutoCommit;
1222 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1228 =item suspend [ OPTION => VALUE ... ]
1230 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1231 package, then suspends the package itself (sets the susp field to now).
1233 Available options are:
1237 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1238 either a reasonnum of an existing reason, or passing a hashref will create
1239 a new reason. The hashref should have the following keys:
1240 - typenum - Reason type (see L<FS::reason_type>
1241 - reason - Text of the new reason.
1243 =item date - can be set to a unix style timestamp to specify when to
1246 =item time - can be set to override the current time, for calculation
1247 of final invoices or unused-time credits
1249 =item resume_date - can be set to a time when the package should be
1250 unsuspended. This may be more convenient than calling C<unsuspend()>
1253 =item from_main - allows a supplemental package to be suspended, rather
1254 than redirecting the method call to its main package. For internal use.
1258 If there is an error, returns the error, otherwise returns false.
1263 my( $self, %options ) = @_;
1266 # pass all suspend/cancel actions to the main package
1267 if ( $self->main_pkgnum and !$options{'from_main'} ) {
1268 return $self->main_pkg->suspend(%options);
1271 local $SIG{HUP} = 'IGNORE';
1272 local $SIG{INT} = 'IGNORE';
1273 local $SIG{QUIT} = 'IGNORE';
1274 local $SIG{TERM} = 'IGNORE';
1275 local $SIG{TSTP} = 'IGNORE';
1276 local $SIG{PIPE} = 'IGNORE';
1278 my $oldAutoCommit = $FS::UID::AutoCommit;
1279 local $FS::UID::AutoCommit = 0;
1282 my $old = $self->select_for_update;
1284 my $pkgnum = $old->pkgnum;
1285 if ( $old->get('cancel') || $self->get('cancel') ) {
1286 dbh->rollback if $oldAutoCommit;
1287 return "Can't suspend cancelled package $pkgnum";
1290 if ( $old->get('susp') || $self->get('susp') ) {
1291 dbh->rollback if $oldAutoCommit;
1292 return ""; # no error # complain on adjourn?
1295 my $suspend_time = $options{'time'} || time;
1296 my $date = $options{date} if $options{date}; # adjourn/suspend later
1297 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1299 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1300 dbh->rollback if $oldAutoCommit;
1301 return "Package $pkgnum expires before it would be suspended.";
1304 # some false laziness with sub cancel
1305 if ( !$options{nobill} && !$date &&
1306 $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1307 # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1308 # make the entire cust_main->bill path recognize 'suspend' and
1309 # 'cancel' separately.
1310 warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1311 my $copy = $self->new({$self->hash});
1313 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1315 'time' => $suspend_time );
1316 warn "Error billing during suspend, custnum ".
1317 #$self->cust_main->custnum. ": $error"
1322 if ( $options{'reason'} ) {
1323 $error = $self->insert_reason( 'reason' => $options{'reason'},
1324 'action' => $date ? 'adjourn' : 'suspend',
1325 'date' => $date ? $date : $suspend_time,
1326 'reason_otaker' => $options{'reason_otaker'},
1329 dbh->rollback if $oldAutoCommit;
1330 return "Error inserting cust_pkg_reason: $error";
1334 # if a reasonnum was passed, get the actual reason object so we can check
1336 # (passing a reason hashref is still allowed, but it can't be used with
1337 # the fancy behavioral options.)
1340 if ($options{'reason'} =~ /^\d+$/) {
1341 $reason = FS::reason->by_key($options{'reason'});
1344 my %hash = $self->hash;
1346 $hash{'adjourn'} = $date;
1348 $hash{'susp'} = $suspend_time;
1351 my $resume_date = $options{'resume_date'} || 0;
1352 if ( $resume_date > ($date || $suspend_time) ) {
1353 $hash{'resume'} = $resume_date;
1356 $options{options} ||= {};
1358 my $new = new FS::cust_pkg ( \%hash );
1359 $error = $new->replace( $self, options => { $self->options,
1360 %{ $options{options} },
1364 $dbh->rollback if $oldAutoCommit;
1368 unless ( $date ) { # then we are suspending now
1370 # credit remaining time if appropriate
1371 # (if required by the package def, or the suspend reason)
1372 my $unused_credit = $self->part_pkg->option('unused_credit_suspend',1)
1373 || ( defined($reason) && $reason->unused_credit );
1375 if ( $unused_credit ) {
1376 warn "crediting unused time on pkg#".$self->pkgnum."\n" if $DEBUG;
1377 my $error = $self->credit_remaining('suspend', $suspend_time);
1379 $dbh->rollback if $oldAutoCommit;
1386 foreach my $cust_svc (
1387 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1389 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1391 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1392 $dbh->rollback if $oldAutoCommit;
1393 return "Illegal svcdb value in part_svc!";
1396 require "FS/$svcdb.pm";
1398 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1400 $error = $svc->suspend;
1402 $dbh->rollback if $oldAutoCommit;
1405 my( $label, $value ) = $cust_svc->label;
1406 push @labels, "$label: $value";
1410 my $conf = new FS::Conf;
1411 if ( $conf->config('suspend_email_admin') ) {
1413 my $error = send_email(
1414 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1415 #invoice_from ??? well as good as any
1416 'to' => $conf->config('suspend_email_admin'),
1417 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1419 "This is an automatic message from your Freeside installation\n",
1420 "informing you that the following customer package has been suspended:\n",
1422 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1423 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1424 ( map { "Service : $_\n" } @labels ),
1426 'custnum' => $self->custnum,
1427 'msgtype' => 'admin'
1431 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1439 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1440 $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1442 $dbh->rollback if $oldAutoCommit;
1443 return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1447 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1452 =item credit_remaining MODE TIME
1454 Generate a credit for this package for the time remaining in the current
1455 billing period. MODE is either "suspend" or "cancel" (determines the
1456 credit type). TIME is the time of suspension/cancellation. Both arguments
1461 # Implementation note:
1463 # If you pkgpart-change a package that has been billed, and it's set to give
1464 # credit on package change, then this method gets called and then the new
1465 # package will have no last_bill date. Therefore the customer will be credited
1466 # only once (per billing period) even if there are multiple package changes.
1468 # If you location-change a package that has been billed, this method will NOT
1469 # be called and the new package WILL have the last bill date of the old
1472 # If the new package is then canceled within the same billing cycle,
1473 # credit_remaining needs to run calc_remain on the OLD package to determine
1474 # the amount of unused time to credit.
1476 sub credit_remaining {
1477 # Add a credit for remaining service
1478 my ($self, $mode, $time) = @_;
1479 die 'credit_remaining requires suspend or cancel'
1480 unless $mode eq 'suspend' or $mode eq 'cancel';
1481 die 'no suspend/cancel time' unless $time > 0;
1483 my $conf = FS::Conf->new;
1484 my $reason_type = $conf->config($mode.'_credit_type');
1486 my $last_bill = $self->getfield('last_bill') || 0;
1487 my $next_bill = $self->getfield('bill') || 0;
1488 if ( $last_bill > 0 # the package has been billed
1489 and $next_bill > 0 # the package has a next bill date
1490 and $next_bill >= $time # which is in the future
1492 my $remaining_value = 0;
1494 my $remain_pkg = $self;
1495 $remaining_value = $remain_pkg->calc_remain('time' => $time);
1497 # we may have to walk back past some package changes to get to the
1498 # one that actually has unused time
1499 while ( $remaining_value == 0 ) {
1500 if ( $remain_pkg->change_pkgnum ) {
1501 $remain_pkg = FS::cust_pkg->by_key($remain_pkg->change_pkgnum);
1503 # the package has really never been billed
1506 $remaining_value = $remain_pkg->calc_remain('time' => $time);
1509 if ( $remaining_value > 0 ) {
1510 warn "Crediting for $remaining_value on package ".$self->pkgnum."\n"
1512 my $error = $self->cust_main->credit(
1514 'Credit for unused time on '. $self->part_pkg->pkg,
1515 'reason_type' => $reason_type,
1517 return "Error crediting customer \$$remaining_value for unused time".
1518 " on ". $self->part_pkg->pkg. ": $error"
1520 } #if $remaining_value
1521 } #if $last_bill, etc.
1525 =item unsuspend [ OPTION => VALUE ... ]
1527 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1528 package, then unsuspends the package itself (clears the susp field and the
1529 adjourn field if it is in the past). If the suspend reason includes an
1530 unsuspension package, that package will be ordered.
1532 Available options are:
1538 Can be set to a date to unsuspend the package in the future (the 'resume'
1541 =item adjust_next_bill
1543 Can be set true to adjust the next bill date forward by
1544 the amount of time the account was inactive. This was set true by default
1545 in the past (from 1.4.2 and 1.5.0pre6 through 1.7.0), but now needs to be
1546 explicitly requested with this option or in the price plan.
1550 If there is an error, returns the error, otherwise returns false.
1555 my( $self, %opt ) = @_;
1558 # pass all suspend/cancel actions to the main package
1559 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1560 return $self->main_pkg->unsuspend(%opt);
1563 local $SIG{HUP} = 'IGNORE';
1564 local $SIG{INT} = 'IGNORE';
1565 local $SIG{QUIT} = 'IGNORE';
1566 local $SIG{TERM} = 'IGNORE';
1567 local $SIG{TSTP} = 'IGNORE';
1568 local $SIG{PIPE} = 'IGNORE';
1570 my $oldAutoCommit = $FS::UID::AutoCommit;
1571 local $FS::UID::AutoCommit = 0;
1574 my $old = $self->select_for_update;
1576 my $pkgnum = $old->pkgnum;
1577 if ( $old->get('cancel') || $self->get('cancel') ) {
1578 $dbh->rollback if $oldAutoCommit;
1579 return "Can't unsuspend cancelled package $pkgnum";
1582 unless ( $old->get('susp') && $self->get('susp') ) {
1583 $dbh->rollback if $oldAutoCommit;
1584 return ""; # no error # complain instead?
1587 # handle the case of setting a future unsuspend (resume) date
1588 # and do not continue to actually unsuspend the package
1589 my $date = $opt{'date'};
1590 if ( $date and $date > time ) { # return an error if $date <= time?
1592 if ( $old->get('expire') && $old->get('expire') < $date ) {
1593 $dbh->rollback if $oldAutoCommit;
1594 return "Package $pkgnum expires before it would be unsuspended.";
1597 my $new = new FS::cust_pkg { $self->hash };
1598 $new->set('resume', $date);
1599 $error = $new->replace($self, options => $self->options);
1602 $dbh->rollback if $oldAutoCommit;
1606 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1612 if (!$self->setup) {
1613 # then this package is being released from on-hold status
1614 $self->set_initial_timers;
1619 foreach my $cust_svc (
1620 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1622 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1624 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1625 $dbh->rollback if $oldAutoCommit;
1626 return "Illegal svcdb value in part_svc!";
1629 require "FS/$svcdb.pm";
1631 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1633 $error = $svc->unsuspend;
1635 $dbh->rollback if $oldAutoCommit;
1638 my( $label, $value ) = $cust_svc->label;
1639 push @labels, "$label: $value";
1644 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1645 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1647 my %hash = $self->hash;
1648 my $inactive = time - $hash{'susp'};
1650 my $conf = new FS::Conf;
1652 # increment next bill date if certain conditions are met:
1653 # - it was due to be billed at some point
1654 # - either the global or local config says to do this
1655 my $adjust_bill = 0;
1658 && ( $hash{'bill'} || $hash{'setup'} )
1659 && ( $opt{'adjust_next_bill'}
1660 || $conf->exists('unsuspend-always_adjust_next_bill_date')
1661 || $self->part_pkg->option('unsuspend_adjust_bill', 1)
1668 # - the package billed during suspension
1669 # - or it was ordered on hold
1670 # - or the customer was credited for the unused time
1672 if ( $self->option('suspend_bill',1)
1673 or ( $self->part_pkg->option('suspend_bill',1)
1674 and ! $self->option('no_suspend_bill',1)
1676 or $hash{'order_date'} == $hash{'susp'}
1677 or $self->part_pkg->option('unused_credit_suspend')
1678 or ( defined($reason) and $reason->unused_credit )
1683 # then add the length of time suspended to the bill date
1684 if ( $adjust_bill ) {
1685 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive
1689 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1690 $hash{'resume'} = '' if !$hash{'adjourn'};
1691 my $new = new FS::cust_pkg ( \%hash );
1692 $error = $new->replace( $self, options => { $self->options } );
1694 $dbh->rollback if $oldAutoCommit;
1700 if ( $reason && $reason->unsuspend_pkgpart ) {
1701 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
1702 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
1704 my $start_date = $self->cust_main->next_bill_date
1705 if $reason->unsuspend_hold;
1708 $unsusp_pkg = FS::cust_pkg->new({
1709 'custnum' => $self->custnum,
1710 'pkgpart' => $reason->unsuspend_pkgpart,
1711 'start_date' => $start_date,
1712 'locationnum' => $self->locationnum,
1713 # discount? probably not...
1716 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
1720 $dbh->rollback if $oldAutoCommit;
1725 if ( $conf->config('unsuspend_email_admin') ) {
1727 my $error = send_email(
1728 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1729 #invoice_from ??? well as good as any
1730 'to' => $conf->config('unsuspend_email_admin'),
1731 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
1732 "This is an automatic message from your Freeside installation\n",
1733 "informing you that the following customer package has been unsuspended:\n",
1735 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1736 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1737 ( map { "Service : $_\n" } @labels ),
1739 "An unsuspension fee was charged: ".
1740 $unsusp_pkg->part_pkg->pkg_comment."\n"
1744 'custnum' => $self->custnum,
1745 'msgtype' => 'admin',
1749 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
1755 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1756 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
1758 $dbh->rollback if $oldAutoCommit;
1759 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1763 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1770 Cancels any pending suspension (sets the adjourn field to null).
1772 If there is an error, returns the error, otherwise returns false.
1777 my( $self, %options ) = @_;
1780 local $SIG{HUP} = 'IGNORE';
1781 local $SIG{INT} = 'IGNORE';
1782 local $SIG{QUIT} = 'IGNORE';
1783 local $SIG{TERM} = 'IGNORE';
1784 local $SIG{TSTP} = 'IGNORE';
1785 local $SIG{PIPE} = 'IGNORE';
1787 my $oldAutoCommit = $FS::UID::AutoCommit;
1788 local $FS::UID::AutoCommit = 0;
1791 my $old = $self->select_for_update;
1793 my $pkgnum = $old->pkgnum;
1794 if ( $old->get('cancel') || $self->get('cancel') ) {
1795 dbh->rollback if $oldAutoCommit;
1796 return "Can't unadjourn cancelled package $pkgnum";
1797 # or at least it's pointless
1800 if ( $old->get('susp') || $self->get('susp') ) {
1801 dbh->rollback if $oldAutoCommit;
1802 return "Can't unadjourn suspended package $pkgnum";
1803 # perhaps this is arbitrary
1806 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1807 dbh->rollback if $oldAutoCommit;
1808 return ""; # no error
1811 my %hash = $self->hash;
1812 $hash{'adjourn'} = '';
1813 $hash{'resume'} = '';
1814 my $new = new FS::cust_pkg ( \%hash );
1815 $error = $new->replace( $self, options => { $self->options } );
1817 $dbh->rollback if $oldAutoCommit;
1821 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1828 =item change HASHREF | OPTION => VALUE ...
1830 Changes this package: cancels it and creates a new one, with a different
1831 pkgpart or locationnum or both. All services are transferred to the new
1832 package (no change will be made if this is not possible).
1834 Options may be passed as a list of key/value pairs or as a hash reference.
1841 New locationnum, to change the location for this package.
1845 New FS::cust_location object, to create a new location and assign it
1850 New FS::cust_main object, to create a new customer and assign the new package
1855 New pkgpart (see L<FS::part_pkg>).
1859 New refnum (see L<FS::part_referral>).
1863 New quantity; if unspecified, the new package will have the same quantity
1868 "New" (existing) FS::cust_pkg object. The package's services and other
1869 attributes will be transferred to this package.
1873 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1874 susp, adjourn, cancel, expire, and contract_end) to the new package.
1876 =item unprotect_svcs
1878 Normally, change() will rollback and return an error if some services
1879 can't be transferred (also see the I<cust_pkg-change_svcpart> config option).
1880 If unprotect_svcs is true, this method will transfer as many services as
1881 it can and then unconditionally cancel the old package.
1885 At least one of locationnum, cust_location, pkgpart, refnum, cust_main, or
1886 cust_pkg must be specified (otherwise, what's the point?)
1888 Returns either the new FS::cust_pkg object or a scalar error.
1892 my $err_or_new_cust_pkg = $old_cust_pkg->change
1896 #some false laziness w/order
1899 my $opt = ref($_[0]) ? shift : { @_ };
1901 my $conf = new FS::Conf;
1903 # Transactionize this whole mess
1904 local $SIG{HUP} = 'IGNORE';
1905 local $SIG{INT} = 'IGNORE';
1906 local $SIG{QUIT} = 'IGNORE';
1907 local $SIG{TERM} = 'IGNORE';
1908 local $SIG{TSTP} = 'IGNORE';
1909 local $SIG{PIPE} = 'IGNORE';
1911 my $oldAutoCommit = $FS::UID::AutoCommit;
1912 local $FS::UID::AutoCommit = 0;
1921 $hash{'setup'} = $time if $self->setup;
1923 $hash{'change_date'} = $time;
1924 $hash{"change_$_"} = $self->$_()
1925 foreach qw( pkgnum pkgpart locationnum );
1927 if ( $opt->{'cust_location'} ) {
1928 $error = $opt->{'cust_location'}->find_or_insert;
1930 $dbh->rollback if $oldAutoCommit;
1931 return "creating location record: $error";
1933 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1936 if ( $opt->{'cust_pkg'} ) {
1937 # treat changing to a package with a different pkgpart as a
1938 # pkgpart change (because it is)
1939 $opt->{'pkgpart'} = $opt->{'cust_pkg'}->pkgpart;
1942 # whether to override pkgpart checking on the new package
1943 my $same_pkgpart = 1;
1944 if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
1948 my $unused_credit = 0;
1949 my $keep_dates = $opt->{'keep_dates'};
1950 # Special case. If the pkgpart is changing, and the customer is
1951 # going to be credited for remaining time, don't keep setup, bill,
1952 # or last_bill dates, and DO pass the flag to cancel() to credit
1954 if ( $opt->{'pkgpart'}
1955 and $opt->{'pkgpart'} != $self->pkgpart
1956 and $self->part_pkg->option('unused_credit_change', 1) ) {
1959 $hash{$_} = '' foreach qw(setup bill last_bill);
1962 if ( $keep_dates ) {
1963 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1964 resume start_date contract_end ) ) {
1965 $hash{$date} = $self->getfield($date);
1968 # always keep this date, regardless of anything
1969 # (the date of the package change is in a different field)
1970 $hash{'order_date'} = $self->getfield('order_date');
1972 # allow $opt->{'locationnum'} = '' to specifically set it to null
1973 # (i.e. customer default location)
1974 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
1976 # usually this doesn't matter. the two cases where it does are:
1977 # 1. unused_credit_change + pkgpart change + setup fee on the new package
1979 # 2. (more importantly) changing a package before it's billed
1980 $hash{'waive_setup'} = $self->waive_setup;
1982 my $custnum = $self->custnum;
1983 if ( $opt->{cust_main} ) {
1984 my $cust_main = $opt->{cust_main};
1985 unless ( $cust_main->custnum ) {
1986 my $error = $cust_main->insert( @{ $opt->{cust_main_insert_args}||[] } );
1988 $dbh->rollback if $oldAutoCommit;
1989 return "inserting customer record: $error";
1992 $custnum = $cust_main->custnum;
1995 $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
1998 if ( $opt->{'cust_pkg'} ) {
1999 # The target package already exists; update it to show that it was
2000 # changed from this package.
2001 $cust_pkg = $opt->{'cust_pkg'};
2003 foreach ( qw( pkgnum pkgpart locationnum ) ) {
2004 $cust_pkg->set("change_$_", $self->get($_));
2006 $cust_pkg->set('change_date', $time);
2007 $error = $cust_pkg->replace;
2010 # Create the new package.
2011 $cust_pkg = new FS::cust_pkg {
2012 custnum => $custnum,
2013 locationnum => $opt->{'locationnum'},
2014 ( map { $_ => ( $opt->{$_} || $self->$_() ) }
2015 qw( pkgpart quantity refnum salesnum )
2019 $error = $cust_pkg->insert( 'change' => 1,
2020 'allow_pkgpart' => $same_pkgpart );
2023 $dbh->rollback if $oldAutoCommit;
2024 return "inserting new package: $error";
2027 # Transfer services and cancel old package.
2029 $error = $self->transfer($cust_pkg);
2030 if ($error and $error == 0) {
2031 # $old_pkg->transfer failed.
2032 $dbh->rollback if $oldAutoCommit;
2033 return "transferring $error";
2036 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2037 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2038 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
2039 if ($error and $error == 0) {
2040 # $old_pkg->transfer failed.
2041 $dbh->rollback if $oldAutoCommit;
2042 return "converting $error";
2046 # We set unprotect_svcs when executing a "future package change". It's
2047 # not a user-interactive operation, so returning an error means the
2048 # package change will just fail. Rather than have that happen, we'll
2049 # let leftover services be deleted.
2050 if ($error > 0 and !$opt->{'unprotect_svcs'}) {
2051 # Transfers were successful, but we still had services left on the old
2052 # package. We can't change the package under this circumstances, so abort.
2053 $dbh->rollback if $oldAutoCommit;
2054 return "unable to transfer all services";
2057 #reset usage if changing pkgpart
2058 # AND usage rollover is off (otherwise adds twice, now and at package bill)
2059 if ($self->pkgpart != $cust_pkg->pkgpart) {
2060 my $part_pkg = $cust_pkg->part_pkg;
2061 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
2065 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
2068 $dbh->rollback if $oldAutoCommit;
2069 return "setting usage values: $error";
2072 # if NOT changing pkgpart, transfer any usage pools over
2073 foreach my $usage ($self->cust_pkg_usage) {
2074 $usage->set('pkgnum', $cust_pkg->pkgnum);
2075 $error = $usage->replace;
2077 $dbh->rollback if $oldAutoCommit;
2078 return "transferring usage pools: $error";
2083 # transfer discounts, if we're not changing pkgpart
2084 if ( $same_pkgpart ) {
2085 foreach my $old_discount ($self->cust_pkg_discount_active) {
2086 # don't remove the old discount, we may still need to bill that package.
2087 my $new_discount = new FS::cust_pkg_discount {
2088 'pkgnum' => $cust_pkg->pkgnum,
2089 'discountnum' => $old_discount->discountnum,
2090 'months_used' => $old_discount->months_used,
2092 $error = $new_discount->insert;
2094 $dbh->rollback if $oldAutoCommit;
2095 return "transferring discounts: $error";
2100 # transfer (copy) invoice details
2101 foreach my $detail ($self->cust_pkg_detail) {
2102 my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
2103 $new_detail->set('pkgdetailnum', '');
2104 $new_detail->set('pkgnum', $cust_pkg->pkgnum);
2105 $error = $new_detail->insert;
2107 $dbh->rollback if $oldAutoCommit;
2108 return "transferring package notes: $error";
2114 if ( !$opt->{'cust_pkg'} ) {
2115 # Order any supplemental packages.
2116 my $part_pkg = $cust_pkg->part_pkg;
2117 my @old_supp_pkgs = $self->supplemental_pkgs;
2118 foreach my $link ($part_pkg->supp_part_pkg_link) {
2120 foreach (@old_supp_pkgs) {
2121 if ($_->pkgpart == $link->dst_pkgpart) {
2123 $_->pkgpart(0); # so that it can't match more than once
2127 # false laziness with FS::cust_main::Packages::order_pkg
2128 my $new = FS::cust_pkg->new({
2129 pkgpart => $link->dst_pkgpart,
2130 pkglinknum => $link->pkglinknum,
2131 custnum => $custnum,
2132 main_pkgnum => $cust_pkg->pkgnum,
2133 locationnum => $cust_pkg->locationnum,
2134 start_date => $cust_pkg->start_date,
2135 order_date => $cust_pkg->order_date,
2136 expire => $cust_pkg->expire,
2137 adjourn => $cust_pkg->adjourn,
2138 contract_end => $cust_pkg->contract_end,
2139 refnum => $cust_pkg->refnum,
2140 discountnum => $cust_pkg->discountnum,
2141 waive_setup => $cust_pkg->waive_setup,
2143 if ( $old and $opt->{'keep_dates'} ) {
2144 foreach (qw(setup bill last_bill)) {
2145 $new->set($_, $old->get($_));
2148 $error = $new->insert( allow_pkgpart => $same_pkgpart );
2151 $error ||= $old->transfer($new);
2153 if ( $error and $error > 0 ) {
2154 # no reason why this should ever fail, but still...
2155 $error = "Unable to transfer all services from supplemental package ".
2159 $dbh->rollback if $oldAutoCommit;
2162 push @new_supp_pkgs, $new;
2164 } # if !$opt->{'cust_pkg'}
2165 # because if there is one, then supplemental packages would already
2166 # have been created for it.
2168 #Good to go, cancel old package. Notify 'cancel' of whether to credit
2170 #Don't allow billing the package (preceding period packages and/or
2171 #outstanding usage) if we are keeping dates (i.e. location changing),
2172 #because the new package will be billed for the same date range.
2173 #Supplemental packages are also canceled here.
2175 # during scheduled changes, avoid canceling the package we just
2177 $self->set('change_to_pkgnum' => '');
2179 $error = $self->cancel(
2181 unused_credit => $unused_credit,
2182 nobill => $keep_dates,
2183 change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2186 $dbh->rollback if $oldAutoCommit;
2187 return "canceling old package: $error";
2190 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2192 my $error = $cust_pkg->cust_main->bill(
2193 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2196 $dbh->rollback if $oldAutoCommit;
2197 return "billing new package: $error";
2201 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2207 =item change_later OPTION => VALUE...
2209 Schedule a package change for a later date. This actually orders the new
2210 package immediately, but sets its start date for a future date, and sets
2211 the current package to expire on the same date.
2213 If the package is already scheduled for a change, this can be called with
2214 'start_date' to change the scheduled date, or with pkgpart and/or
2215 locationnum to modify the package change. To cancel the scheduled change
2216 entirely, see C<abort_change>.
2224 The date for the package change. Required, and must be in the future.
2232 The pkgpart. locationnum, and quantity of the new package, with the same
2233 meaning as in C<change>.
2241 my $opt = ref($_[0]) ? shift : { @_ };
2243 my $oldAutoCommit = $FS::UID::AutoCommit;
2244 local $FS::UID::AutoCommit = 0;
2247 my $cust_main = $self->cust_main;
2249 my $date = delete $opt->{'start_date'} or return 'start_date required';
2251 if ( $date <= time ) {
2252 $dbh->rollback if $oldAutoCommit;
2253 return "start_date $date is in the past";
2258 if ( $self->change_to_pkgnum ) {
2259 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
2260 my $new_pkgpart = $opt->{'pkgpart'}
2261 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $change_to->pkgpart;
2262 my $new_locationnum = $opt->{'locationnum'}
2263 if $opt->{'locationnum'} and $opt->{'locationnum'} != $change_to->locationnum;
2264 my $new_quantity = $opt->{'quantity'}
2265 if $opt->{'quantity'} and $opt->{'quantity'} != $change_to->quantity;
2266 if ( $new_pkgpart or $new_locationnum or $new_quantity ) {
2267 # it hasn't been billed yet, so in principle we could just edit
2268 # it in place (w/o a package change), but that's bad form.
2269 # So change the package according to the new options...
2270 my $err_or_pkg = $change_to->change(%$opt);
2271 if ( ref $err_or_pkg ) {
2272 # Then set that package up for a future start.
2273 $self->set('change_to_pkgnum', $err_or_pkg->pkgnum);
2274 $self->set('expire', $date); # in case it's different
2275 $err_or_pkg->set('start_date', $date);
2276 $err_or_pkg->set('change_date', '');
2277 $err_or_pkg->set('change_pkgnum', '');
2279 $error = $self->replace ||
2280 $err_or_pkg->replace ||
2281 $change_to->cancel ||
2284 $error = $err_or_pkg;
2286 } else { # change the start date only.
2287 $self->set('expire', $date);
2288 $change_to->set('start_date', $date);
2289 $error = $self->replace || $change_to->replace;
2292 $dbh->rollback if $oldAutoCommit;
2295 $dbh->commit if $oldAutoCommit;
2298 } # if $self->change_to_pkgnum
2300 my $new_pkgpart = $opt->{'pkgpart'}
2301 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2302 my $new_locationnum = $opt->{'locationnum'}
2303 if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2304 my $new_quantity = $opt->{'quantity'}
2305 if $opt->{'quantity'} and $opt->{'quantity'} != $self->quantity;
2307 return '' unless $new_pkgpart or $new_locationnum or $new_quantity; # wouldn't do anything
2309 # allow $opt->{'locationnum'} = '' to specifically set it to null
2310 # (i.e. customer default location)
2311 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2313 my $new = FS::cust_pkg->new( {
2314 custnum => $self->custnum,
2315 locationnum => $opt->{'locationnum'},
2316 start_date => $date,
2317 map { $_ => ( $opt->{$_} || $self->$_() ) }
2318 qw( pkgpart quantity refnum salesnum )
2320 $error = $new->insert('change' => 1,
2321 'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2323 $self->set('change_to_pkgnum', $new->pkgnum);
2324 $self->set('expire', $date);
2325 $error = $self->replace;
2328 $dbh->rollback if $oldAutoCommit;
2330 $dbh->commit if $oldAutoCommit;
2338 Cancels a future package change scheduled by C<change_later>.
2344 my $pkgnum = $self->change_to_pkgnum;
2345 my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
2348 $error = $change_to->cancel || $change_to->delete;
2349 return $error if $error;
2351 $self->set('change_to_pkgnum', '');
2352 $self->set('expire', '');
2356 =item set_quantity QUANTITY
2358 Change the package's quantity field. This is one of the few package properties
2359 that can safely be changed without canceling and reordering the package
2360 (because it doesn't affect tax eligibility). Returns an error or an
2367 $self = $self->replace_old; # just to make sure
2368 $self->quantity(shift);
2372 =item set_salesnum SALESNUM
2374 Change the package's salesnum (sales person) field. This is one of the few
2375 package properties that can safely be changed without canceling and reordering
2376 the package (because it doesn't affect tax eligibility). Returns an error or
2383 $self = $self->replace_old; # just to make sure
2384 $self->salesnum(shift);
2386 # XXX this should probably reassign any credit that's already been given
2389 =item modify_charge OPTIONS
2391 Change the properties of a one-time charge. The following properties can
2392 be changed this way:
2393 - pkg: the package description
2394 - classnum: the package class
2395 - additional: arrayref of additional invoice details to add to this package
2397 and, I<if the charge has not yet been billed>:
2398 - start_date: the date when it will be billed
2399 - amount: the setup fee to be charged
2400 - quantity: the multiplier for the setup fee
2402 If you pass 'adjust_commission' => 1, and the classnum changes, and there are
2403 commission credits linked to this charge, they will be recalculated.
2410 my $part_pkg = $self->part_pkg;
2411 my $pkgnum = $self->pkgnum;
2414 my $oldAutoCommit = $FS::UID::AutoCommit;
2415 local $FS::UID::AutoCommit = 0;
2417 return "Can't use modify_charge except on one-time charges"
2418 unless $part_pkg->freq eq '0';
2420 if ( length($opt{'pkg'}) and $part_pkg->pkg ne $opt{'pkg'} ) {
2421 $part_pkg->set('pkg', $opt{'pkg'});
2424 my %pkg_opt = $part_pkg->options;
2425 my $pkg_opt_modified = 0;
2427 $opt{'additional'} ||= [];
2430 foreach (grep /^additional/, keys %pkg_opt) {
2431 ($i) = ($_ =~ /^additional_info(\d+)$/);
2432 $old_additional[$i] = $pkg_opt{$_} if $i;
2433 delete $pkg_opt{$_};
2436 for ( $i = 0; exists($opt{'additional'}->[$i]); $i++ ) {
2437 $pkg_opt{ "additional_info$i" } = $opt{'additional'}->[$i];
2438 if (!exists($old_additional[$i])
2439 or $old_additional[$i] ne $opt{'additional'}->[$i])
2441 $pkg_opt_modified = 1;
2444 $pkg_opt_modified = 1 if (scalar(@old_additional) - 1) != $i;
2445 $pkg_opt{'additional_count'} = $i if $i > 0;
2448 if ( exists($opt{'classnum'}) and $part_pkg->classnum ne $opt{'classnum'} )
2451 $old_classnum = $part_pkg->classnum;
2452 $part_pkg->set('classnum', $opt{'classnum'});
2455 if ( !$self->get('setup') ) {
2456 # not yet billed, so allow amount, setup_cost, quantity and start_date
2458 if ( exists($opt{'amount'})
2459 and $part_pkg->option('setup_fee') != $opt{'amount'}
2460 and $opt{'amount'} > 0 ) {
2462 $pkg_opt{'setup_fee'} = $opt{'amount'};
2463 $pkg_opt_modified = 1;
2466 if ( exists($opt{'setup_cost'})
2467 and $part_pkg->setup_cost != $opt{'setup_cost'}
2468 and $opt{'setup_cost'} > 0 ) {
2470 $part_pkg->set('setup_cost', $opt{'setup_cost'});
2473 if ( exists($opt{'quantity'})
2474 and $opt{'quantity'} != $self->quantity
2475 and $opt{'quantity'} > 0 ) {
2477 $self->set('quantity', $opt{'quantity'});
2480 if ( exists($opt{'start_date'})
2481 and $opt{'start_date'} != $self->start_date ) {
2483 $self->set('start_date', $opt{'start_date'});
2487 } # else simply ignore them; the UI shouldn't allow editing the fields
2489 if ( exists($opt{'taxclass'})
2490 and $part_pkg->taxclass ne $opt{'taxclass'}) {
2492 $part_pkg->set('taxclass', $opt{'taxclass'});
2496 if ( $part_pkg->modified or $pkg_opt_modified ) {
2497 # can we safely modify the package def?
2498 # Yes, if it's not available for purchase, and this is the only instance
2500 if ( $part_pkg->disabled
2501 and FS::cust_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 1
2502 and FS::quotation_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 0
2504 $error = $part_pkg->replace( options => \%pkg_opt );
2507 $part_pkg = $part_pkg->clone;
2508 $part_pkg->set('disabled' => 'Y');
2509 $error = $part_pkg->insert( options => \%pkg_opt );
2510 # and associate this as yet-unbilled package to the new package def
2511 $self->set('pkgpart' => $part_pkg->pkgpart);
2514 $dbh->rollback if $oldAutoCommit;
2519 if ($self->modified) { # for quantity or start_date change, or if we had
2520 # to clone the existing package def
2521 my $error = $self->replace;
2522 return $error if $error;
2524 if (defined $old_classnum) {
2525 # fix invoice grouping records
2526 my $old_catname = $old_classnum
2527 ? FS::pkg_class->by_key($old_classnum)->categoryname
2529 my $new_catname = $opt{'classnum'}
2530 ? $part_pkg->pkg_class->categoryname
2532 if ( $old_catname ne $new_catname ) {
2533 foreach my $cust_bill_pkg ($self->cust_bill_pkg) {
2534 # (there should only be one...)
2535 my @display = qsearch( 'cust_bill_pkg_display', {
2536 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2537 'section' => $old_catname,
2539 foreach (@display) {
2540 $_->set('section', $new_catname);
2541 $error = $_->replace;
2543 $dbh->rollback if $oldAutoCommit;
2547 } # foreach $cust_bill_pkg
2550 if ( $opt{'adjust_commission'} ) {
2551 # fix commission credits...tricky.
2552 foreach my $cust_event ($self->cust_event) {
2553 my $part_event = $cust_event->part_event;
2554 foreach my $table (qw(sales agent)) {
2556 "FS::part_event::Action::Mixin::credit_${table}_pkg_class";
2557 my $credit = qsearchs('cust_credit', {
2558 'eventnum' => $cust_event->eventnum,
2560 if ( $part_event->isa($class) ) {
2561 # Yes, this results in current commission rates being applied
2562 # retroactively to a one-time charge. For accounting purposes
2563 # there ought to be some kind of time limit on doing this.
2564 my $amount = $part_event->_calc_credit($self);
2565 if ( $credit and $credit->amount ne $amount ) {
2566 # Void the old credit.
2567 $error = $credit->void('Package class changed');
2569 $dbh->rollback if $oldAutoCommit;
2570 return "$error (adjusting commission credit)";
2573 # redo the event action to recreate the credit.
2575 eval { $part_event->do_action( $self, $cust_event ) };
2577 $dbh->rollback if $oldAutoCommit;
2580 } # if $part_event->isa($class)
2582 } # foreach $cust_event
2583 } # if $opt{'adjust_commission'}
2584 } # if defined $old_classnum
2586 $dbh->commit if $oldAutoCommit;
2592 use Storable 'thaw';
2595 sub process_bulk_cust_pkg {
2597 my $param = thaw(decode_base64(shift));
2598 warn Dumper($param) if $DEBUG;
2600 my $old_part_pkg = qsearchs('part_pkg',
2601 { pkgpart => $param->{'old_pkgpart'} });
2602 my $new_part_pkg = qsearchs('part_pkg',
2603 { pkgpart => $param->{'new_pkgpart'} });
2604 die "Must select a new package type\n" unless $new_part_pkg;
2605 #my $keep_dates = $param->{'keep_dates'} || 0;
2606 my $keep_dates = 1; # there is no good reason to turn this off
2608 local $SIG{HUP} = 'IGNORE';
2609 local $SIG{INT} = 'IGNORE';
2610 local $SIG{QUIT} = 'IGNORE';
2611 local $SIG{TERM} = 'IGNORE';
2612 local $SIG{TSTP} = 'IGNORE';
2613 local $SIG{PIPE} = 'IGNORE';
2615 my $oldAutoCommit = $FS::UID::AutoCommit;
2616 local $FS::UID::AutoCommit = 0;
2619 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
2622 foreach my $old_cust_pkg ( @cust_pkgs ) {
2624 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
2625 if ( $old_cust_pkg->getfield('cancel') ) {
2626 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
2627 $old_cust_pkg->pkgnum."\n"
2631 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
2633 my $error = $old_cust_pkg->change(
2634 'pkgpart' => $param->{'new_pkgpart'},
2635 'keep_dates' => $keep_dates
2637 if ( !ref($error) ) { # change returns the cust_pkg on success
2639 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
2642 $dbh->commit if $oldAutoCommit;
2648 Returns the last bill date, or if there is no last bill date, the setup date.
2649 Useful for billing metered services.
2655 return $self->setfield('last_bill', $_[0]) if @_;
2656 return $self->getfield('last_bill') if $self->getfield('last_bill');
2657 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
2658 'edate' => $self->bill, } );
2659 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
2662 =item last_cust_pkg_reason ACTION
2664 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
2665 Returns false if there is no reason or the package is not currenly ACTION'd
2666 ACTION is one of adjourn, susp, cancel, or expire.
2670 sub last_cust_pkg_reason {
2671 my ( $self, $action ) = ( shift, shift );
2672 my $date = $self->get($action);
2674 'table' => 'cust_pkg_reason',
2675 'hashref' => { 'pkgnum' => $self->pkgnum,
2676 'action' => substr(uc($action), 0, 1),
2679 'order_by' => 'ORDER BY num DESC LIMIT 1',
2683 =item last_reason ACTION
2685 Returns the most recent ACTION FS::reason associated with the package.
2686 Returns false if there is no reason or the package is not currenly ACTION'd
2687 ACTION is one of adjourn, susp, cancel, or expire.
2692 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
2693 $cust_pkg_reason->reason
2694 if $cust_pkg_reason;
2699 Returns the definition for this billing item, as an FS::part_pkg object (see
2706 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
2707 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
2708 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
2713 Returns the cancelled package this package was changed from, if any.
2719 return '' unless $self->change_pkgnum;
2720 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
2723 =item change_cust_main
2725 Returns the customter this package was detached to, if any.
2729 sub change_cust_main {
2731 return '' unless $self->change_custnum;
2732 qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
2737 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
2744 $self->part_pkg->calc_setup($self, @_);
2749 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
2756 $self->part_pkg->calc_recur($self, @_);
2761 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
2768 $self->part_pkg->base_recur($self, @_);
2773 Calls the I<calc_remain> of the FS::part_pkg object associated with this
2780 $self->part_pkg->calc_remain($self, @_);
2785 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
2792 $self->part_pkg->calc_cancel($self, @_);
2797 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
2803 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
2806 =item cust_pkg_detail [ DETAILTYPE ]
2808 Returns any customer package details for this package (see
2809 L<FS::cust_pkg_detail>).
2811 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2815 sub cust_pkg_detail {
2817 my %hash = ( 'pkgnum' => $self->pkgnum );
2818 $hash{detailtype} = shift if @_;
2820 'table' => 'cust_pkg_detail',
2821 'hashref' => \%hash,
2822 'order_by' => 'ORDER BY weight, pkgdetailnum',
2826 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
2828 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
2830 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2832 If there is an error, returns the error, otherwise returns false.
2836 sub set_cust_pkg_detail {
2837 my( $self, $detailtype, @details ) = @_;
2839 local $SIG{HUP} = 'IGNORE';
2840 local $SIG{INT} = 'IGNORE';
2841 local $SIG{QUIT} = 'IGNORE';
2842 local $SIG{TERM} = 'IGNORE';
2843 local $SIG{TSTP} = 'IGNORE';
2844 local $SIG{PIPE} = 'IGNORE';
2846 my $oldAutoCommit = $FS::UID::AutoCommit;
2847 local $FS::UID::AutoCommit = 0;
2850 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
2851 my $error = $current->delete;
2853 $dbh->rollback if $oldAutoCommit;
2854 return "error removing old detail: $error";
2858 foreach my $detail ( @details ) {
2859 my $cust_pkg_detail = new FS::cust_pkg_detail {
2860 'pkgnum' => $self->pkgnum,
2861 'detailtype' => $detailtype,
2862 'detail' => $detail,
2864 my $error = $cust_pkg_detail->insert;
2866 $dbh->rollback if $oldAutoCommit;
2867 return "error adding new detail: $error";
2872 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2879 Returns the customer billing events (see L<FS::cust_event>) for this invoice.
2883 #false laziness w/cust_bill.pm
2887 'table' => 'cust_event',
2888 'addl_from' => 'JOIN part_event USING ( eventpart )',
2889 'hashref' => { 'tablenum' => $self->pkgnum },
2890 'extra_sql' => " AND eventtable = 'cust_pkg' ",
2894 =item num_cust_event
2896 Returns the number of customer billing events (see L<FS::cust_event>) for this package.
2900 #false laziness w/cust_bill.pm
2901 sub num_cust_event {
2903 my $sql = "SELECT COUNT(*) ". $self->_from_cust_event_where;
2904 $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref->[0];
2907 =item exists_cust_event
2909 Returns true if there are customer billing events (see L<FS::cust_event>) for this package. More efficient than using num_cust_event.
2913 sub exists_cust_event {
2915 my $sql = "SELECT 1 ". $self->_from_cust_event_where. " LIMIT 1";
2916 my $row = $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref;
2917 $row ? $row->[0] : '';
2920 sub _from_cust_event_where {
2922 " FROM cust_event JOIN part_event USING ( eventpart ) ".
2923 " WHERE tablenum = ? AND eventtable = 'cust_pkg' ";
2927 my( $self, $sql, @args ) = @_;
2928 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
2929 $sth->execute(@args) or die $sth->errstr. " executing $sql";
2933 =item cust_svc [ SVCPART ] (old, deprecated usage)
2935 =item cust_svc [ OPTION => VALUE ... ] (current usage)
2937 =item cust_svc_unsorted [ OPTION => VALUE ... ]
2939 Returns the services for this package, as FS::cust_svc objects (see
2940 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
2941 spcififed, returns only the matching services.
2943 As an optimization, use the cust_svc_unsorted version if you are not displaying
2950 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
2951 $self->_sort_cust_svc( $self->cust_svc_unsorted_arrayref(@_) );
2954 sub cust_svc_unsorted {
2956 @{ $self->cust_svc_unsorted_arrayref(@_) };
2959 sub cust_svc_unsorted_arrayref {
2962 return [] unless $self->num_cust_svc(@_);
2965 if ( @_ && $_[0] =~ /^\d+/ ) {
2966 $opt{svcpart} = shift;
2967 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2974 'table' => 'cust_svc',
2975 'hashref' => { 'pkgnum' => $self->pkgnum },
2977 if ( $opt{svcpart} ) {
2978 $search{hashref}->{svcpart} = $opt{'svcpart'};
2980 if ( $opt{'svcdb'} ) {
2981 $search{addl_from} = ' LEFT JOIN part_svc USING ( svcpart ) ';
2982 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{'svcdb'} );
2985 [ qsearch(\%search) ];
2989 =item overlimit [ SVCPART ]
2991 Returns the services for this package which have exceeded their
2992 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
2993 is specified, return only the matching services.
2999 return () unless $self->num_cust_svc(@_);
3000 grep { $_->overlimit } $self->cust_svc(@_);
3003 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3005 Returns historical services for this package created before END TIMESTAMP and
3006 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
3007 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
3008 I<pkg_svc.hidden> flag will be omitted.
3014 warn "$me _h_cust_svc called on $self\n"
3017 my ($end, $start, $mode) = @_;
3018 my @cust_svc = $self->_sort_cust_svc(
3019 [ qsearch( 'h_cust_svc',
3020 { 'pkgnum' => $self->pkgnum, },
3021 FS::h_cust_svc->sql_h_search(@_),
3024 if ( defined($mode) && $mode eq 'I' ) {
3025 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
3026 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
3032 sub _sort_cust_svc {
3033 my( $self, $arrayref ) = @_;
3036 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
3038 my %pkg_svc = map { $_->svcpart => $_ }
3039 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
3044 my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
3046 $pkg_svc ? $pkg_svc->primary_svc : '',
3047 $pkg_svc ? $pkg_svc->quantity : 0,
3054 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
3056 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
3058 Returns the number of services for this package. Available options are svcpart
3059 and svcdb. If either is spcififed, returns only the matching services.
3066 return $self->{'_num_cust_svc'}
3068 && exists($self->{'_num_cust_svc'})
3069 && $self->{'_num_cust_svc'} =~ /\d/;
3071 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
3075 if ( @_ && $_[0] =~ /^\d+/ ) {
3076 $opt{svcpart} = shift;
3077 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3083 my $select = 'SELECT COUNT(*) FROM cust_svc ';
3084 my $where = ' WHERE pkgnum = ? ';
3085 my @param = ($self->pkgnum);
3087 if ( $opt{'svcpart'} ) {
3088 $where .= ' AND svcpart = ? ';
3089 push @param, $opt{'svcpart'};
3091 if ( $opt{'svcdb'} ) {
3092 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
3093 $where .= ' AND svcdb = ? ';
3094 push @param, $opt{'svcdb'};
3097 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
3098 $sth->execute(@param) or die $sth->errstr;
3099 $sth->fetchrow_arrayref->[0];
3102 =item available_part_svc
3104 Returns a list of FS::part_svc objects representing services included in this
3105 package but not yet provisioned. Each FS::part_svc object also has an extra
3106 field, I<num_avail>, which specifies the number of available services.
3110 sub available_part_svc {
3113 my $pkg_quantity = $self->quantity || 1;
3115 grep { $_->num_avail > 0 }
3117 my $part_svc = $_->part_svc;
3118 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
3119 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
3121 # more evil encapsulation breakage
3122 if($part_svc->{'Hash'}{'num_avail'} > 0) {
3123 my @exports = $part_svc->part_export_did;
3124 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
3129 $self->part_pkg->pkg_svc;
3132 =item part_svc [ OPTION => VALUE ... ]
3134 Returns a list of FS::part_svc objects representing provisioned and available
3135 services included in this package. Each FS::part_svc object also has the
3136 following extra fields:
3150 (services) - array reference containing the provisioned services, as cust_svc objects
3154 Accepts two options:
3158 =item summarize_size
3160 If true, will omit the extra cust_pkg_svc option for objects where num_cust_svc
3161 is this size or greater.
3163 =item hide_discontinued
3165 If true, will omit looking for services that are no longer avaialble in the
3173 #label -> ($cust_svc->label)[1]
3179 my $pkg_quantity = $self->quantity || 1;
3181 #XXX some sort of sort order besides numeric by svcpart...
3182 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
3184 my $part_svc = $pkg_svc->part_svc;
3185 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3186 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
3187 $part_svc->{'Hash'}{'num_avail'} =
3188 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
3189 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3190 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
3191 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
3192 && $num_cust_svc >= $opt{summarize_size};
3193 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
3195 } $self->part_pkg->pkg_svc;
3197 unless ( $opt{hide_discontinued} ) {
3199 push @part_svc, map {
3201 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3202 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
3203 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
3204 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3205 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
3207 } $self->extra_part_svc;
3214 =item extra_part_svc
3216 Returns a list of FS::part_svc objects corresponding to services in this
3217 package which are still provisioned but not (any longer) available in the
3222 sub extra_part_svc {
3225 my $pkgnum = $self->pkgnum;
3226 #my $pkgpart = $self->pkgpart;
3229 # 'table' => 'part_svc',
3232 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
3233 # WHERE pkg_svc.svcpart = part_svc.svcpart
3234 # AND pkg_svc.pkgpart = ?
3237 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
3238 # LEFT JOIN cust_pkg USING ( pkgnum )
3239 # WHERE cust_svc.svcpart = part_svc.svcpart
3242 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
3245 #seems to benchmark slightly faster... (or did?)
3247 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
3248 my $pkgparts = join(',', @pkgparts);
3251 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
3252 #MySQL doesn't grok DISINCT ON
3253 'select' => 'DISTINCT part_svc.*',
3254 'table' => 'part_svc',
3256 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
3257 AND pkg_svc.pkgpart IN ($pkgparts)
3260 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
3261 LEFT JOIN cust_pkg USING ( pkgnum )
3264 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
3265 'extra_param' => [ [$self->pkgnum=>'int'] ],
3271 Returns a short status string for this package, currently:
3277 =item not yet billed
3279 =item one-time charge
3294 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
3296 return 'cancelled' if $self->get('cancel');
3297 return 'on hold' if $self->susp && ! $self->setup;
3298 return 'suspended' if $self->susp;
3299 return 'not yet billed' unless $self->setup;
3300 return 'one-time charge' if $freq =~ /^(0|$)/;
3304 =item ucfirst_status
3306 Returns the status with the first character capitalized.
3310 sub ucfirst_status {
3311 ucfirst(shift->status);
3316 Class method that returns the list of possible status strings for packages
3317 (see L<the status method|/status>). For example:
3319 @statuses = FS::cust_pkg->statuses();
3323 tie my %statuscolor, 'Tie::IxHash',
3324 'on hold' => '7E0079', #purple!
3325 'not yet billed' => '009999', #teal? cyan?
3326 'one-time charge' => '0000CC', #blue #'000000',
3327 'active' => '00CC00',
3328 'suspended' => 'FF9900',
3329 'cancelled' => 'FF0000',
3333 my $self = shift; #could be class...
3334 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
3335 # # mayble split btw one-time vs. recur
3346 Returns a hex triplet color string for this package's status.
3352 $statuscolor{$self->status};
3357 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
3358 "pkg - comment" depending on user preference).
3364 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
3365 $label = $self->pkgnum. ": $label"
3366 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
3370 =item pkg_label_long
3372 Returns a long label for this package, adding the primary service's label to
3377 sub pkg_label_long {
3379 my $label = $self->pkg_label;
3380 my $cust_svc = $self->primary_cust_svc;
3381 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
3387 Returns a customer-localized label for this package.
3393 $self->part_pkg->pkg_locale( $self->cust_main->locale );
3396 =item primary_cust_svc
3398 Returns a primary service (as FS::cust_svc object) if one can be identified.
3402 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
3404 sub primary_cust_svc {
3407 my @cust_svc = $self->cust_svc;
3409 return '' unless @cust_svc; #no serivces - irrelevant then
3411 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
3413 # primary service as specified in the package definition
3414 # or exactly one service definition with quantity one
3415 my $svcpart = $self->part_pkg->svcpart;
3416 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
3417 return $cust_svc[0] if scalar(@cust_svc) == 1;
3419 #couldn't identify one thing..
3425 Returns a list of lists, calling the label method for all services
3426 (see L<FS::cust_svc>) of this billing item.
3432 map { [ $_->label ] } $self->cust_svc;
3435 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3437 Like the labels method, but returns historical information on services that
3438 were active as of END_TIMESTAMP and (optionally) not cancelled before
3439 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
3440 I<pkg_svc.hidden> flag will be omitted.
3442 Returns a list of lists, calling the label method for all (historical) services
3443 (see L<FS::h_cust_svc>) of this billing item.
3449 warn "$me _h_labels called on $self\n"
3451 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
3456 Like labels, except returns a simple flat list, and shortens long
3457 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3458 identical services to one line that lists the service label and the number of
3459 individual services rather than individual items.
3464 shift->_labels_short( 'labels', @_ );
3467 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
3469 Like h_labels, except returns a simple flat list, and shortens long
3470 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3471 identical services to one line that lists the service label and the number of
3472 individual services rather than individual items.
3476 sub h_labels_short {
3477 shift->_labels_short( 'h_labels', @_ );
3481 my( $self, $method ) = ( shift, shift );
3483 warn "$me _labels_short called on $self with $method method\n"
3486 my $conf = new FS::Conf;
3487 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
3489 warn "$me _labels_short populating \%labels\n"
3493 #tie %labels, 'Tie::IxHash';
3494 push @{ $labels{$_->[0]} }, $_->[1]
3495 foreach $self->$method(@_);
3497 warn "$me _labels_short populating \@labels\n"
3501 foreach my $label ( keys %labels ) {
3503 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
3504 my $num = scalar(@values);
3505 warn "$me _labels_short $num items for $label\n"
3508 if ( $num > $max_same_services ) {
3509 warn "$me _labels_short more than $max_same_services, so summarizing\n"
3511 push @labels, "$label ($num)";
3513 if ( $conf->exists('cust_bill-consolidate_services') ) {
3514 warn "$me _labels_short consolidating services\n"
3516 # push @labels, "$label: ". join(', ', @values);
3518 my $detail = "$label: ";
3519 $detail .= shift(@values). ', '
3521 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
3523 push @labels, $detail;
3525 warn "$me _labels_short done consolidating services\n"
3528 warn "$me _labels_short adding service data\n"
3530 push @labels, map { "$label: $_" } @values;
3541 Returns the parent customer object (see L<FS::cust_main>).
3547 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
3552 Returns the balance for this specific package, when using
3553 experimental package balance.
3559 $self->cust_main->balance_pkgnum( $self->pkgnum );
3562 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
3566 Returns the location object, if any (see L<FS::cust_location>).
3568 =item cust_location_or_main
3570 If this package is associated with a location, returns the locaiton (see
3571 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
3573 =item location_label [ OPTION => VALUE ... ]
3575 Returns the label of the location object (see L<FS::cust_location>).
3579 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
3581 =item tax_locationnum
3583 Returns the foreign key to a L<FS::cust_location> object for calculating
3584 tax on this package, as determined by the C<tax-pkg_address> and
3585 C<tax-ship_address> configuration flags.
3589 sub tax_locationnum {
3591 my $conf = FS::Conf->new;
3592 if ( $conf->exists('tax-pkg_address') ) {
3593 return $self->locationnum;
3595 elsif ( $conf->exists('tax-ship_address') ) {
3596 return $self->cust_main->ship_locationnum;
3599 return $self->cust_main->bill_locationnum;
3605 Returns the L<FS::cust_location> object for tax_locationnum.
3611 my $conf = FS::Conf->new;
3612 if ( $conf->exists('tax-pkg_address') and $self->locationnum ) {
3613 return FS::cust_location->by_key($self->locationnum);
3615 elsif ( $conf->exists('tax-ship_address') ) {
3616 return $self->cust_main->ship_location;
3619 return $self->cust_main->bill_location;
3623 =item seconds_since TIMESTAMP
3625 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
3626 package have been online since TIMESTAMP, according to the session monitor.
3628 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
3629 L<Time::Local> and L<Date::Parse> for conversion functions.
3634 my($self, $since) = @_;
3637 foreach my $cust_svc (
3638 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
3640 $seconds += $cust_svc->seconds_since($since);
3647 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
3649 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
3650 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
3653 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3654 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3660 sub seconds_since_sqlradacct {
3661 my($self, $start, $end) = @_;
3665 foreach my $cust_svc (
3667 my $part_svc = $_->part_svc;
3668 $part_svc->svcdb eq 'svc_acct'
3669 && scalar($part_svc->part_export_usage);
3672 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
3679 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
3681 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
3682 in this package for sessions ending between TIMESTAMP_START (inclusive) and
3686 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3687 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3692 sub attribute_since_sqlradacct {
3693 my($self, $start, $end, $attrib) = @_;
3697 foreach my $cust_svc (
3699 my $part_svc = $_->part_svc;
3700 scalar($part_svc->part_export_usage);
3703 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
3715 my( $self, $value ) = @_;
3716 if ( defined($value) ) {
3717 $self->setfield('quantity', $value);
3719 $self->getfield('quantity') || 1;
3722 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
3724 Transfers as many services as possible from this package to another package.
3726 The destination package can be specified by pkgnum by passing an FS::cust_pkg
3727 object. The destination package must already exist.
3729 Services are moved only if the destination allows services with the correct
3730 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
3731 this option with caution! No provision is made for export differences
3732 between the old and new service definitions. Probably only should be used
3733 when your exports for all service definitions of a given svcdb are identical.
3734 (attempt a transfer without it first, to move all possible svcpart-matching
3737 Any services that can't be moved remain in the original package.
3739 Returns an error, if there is one; otherwise, returns the number of services
3740 that couldn't be moved.
3745 my ($self, $dest_pkgnum, %opt) = @_;
3751 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
3752 $dest = $dest_pkgnum;
3753 $dest_pkgnum = $dest->pkgnum;
3755 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
3758 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
3760 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
3761 $target{$pkg_svc->svcpart} = $pkg_svc->quantity * ( $dest->quantity || 1 );
3764 foreach my $cust_svc ($dest->cust_svc) {
3765 $target{$cust_svc->svcpart}--;
3768 my %svcpart2svcparts = ();
3769 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3770 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
3771 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
3772 next if exists $svcpart2svcparts{$svcpart};
3773 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
3774 $svcpart2svcparts{$svcpart} = [
3776 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
3778 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
3779 'svcpart' => $_ } );
3781 $pkg_svc ? $pkg_svc->primary_svc : '',
3782 $pkg_svc ? $pkg_svc->quantity : 0,
3786 grep { $_ != $svcpart }
3788 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
3790 warn "alternates for svcpart $svcpart: ".
3791 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
3797 foreach my $cust_svc ($self->cust_svc) {
3798 my $svcnum = $cust_svc->svcnum;
3799 if($target{$cust_svc->svcpart} > 0
3800 or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
3801 $target{$cust_svc->svcpart}--;
3802 my $new = new FS::cust_svc { $cust_svc->hash };
3803 $new->pkgnum($dest_pkgnum);
3804 $error = $new->replace($cust_svc);
3805 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3807 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
3808 warn "alternates to consider: ".
3809 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
3811 my @alternate = grep {
3812 warn "considering alternate svcpart $_: ".
3813 "$target{$_} available in new package\n"
3816 } @{$svcpart2svcparts{$cust_svc->svcpart}};
3818 warn "alternate(s) found\n" if $DEBUG;
3819 my $change_svcpart = $alternate[0];
3820 $target{$change_svcpart}--;
3821 my $new = new FS::cust_svc { $cust_svc->hash };
3822 $new->svcpart($change_svcpart);
3823 $new->pkgnum($dest_pkgnum);
3824 $error = $new->replace($cust_svc);
3832 my @label = $cust_svc->label;
3833 return "service $label[1]: $error";
3839 =item grab_svcnums SVCNUM, SVCNUM ...
3841 Change the pkgnum for the provided services to this packages. If there is an
3842 error, returns the error, otherwise returns false.
3850 local $SIG{HUP} = 'IGNORE';
3851 local $SIG{INT} = 'IGNORE';
3852 local $SIG{QUIT} = 'IGNORE';
3853 local $SIG{TERM} = 'IGNORE';
3854 local $SIG{TSTP} = 'IGNORE';
3855 local $SIG{PIPE} = 'IGNORE';
3857 my $oldAutoCommit = $FS::UID::AutoCommit;
3858 local $FS::UID::AutoCommit = 0;
3861 foreach my $svcnum (@svcnum) {
3862 my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
3863 $dbh->rollback if $oldAutoCommit;
3864 return "unknown svcnum $svcnum";
3866 $cust_svc->pkgnum( $self->pkgnum );
3867 my $error = $cust_svc->replace;
3869 $dbh->rollback if $oldAutoCommit;
3874 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3881 This method is deprecated. See the I<depend_jobnum> option to the insert and
3882 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
3889 local $SIG{HUP} = 'IGNORE';
3890 local $SIG{INT} = 'IGNORE';
3891 local $SIG{QUIT} = 'IGNORE';
3892 local $SIG{TERM} = 'IGNORE';
3893 local $SIG{TSTP} = 'IGNORE';
3894 local $SIG{PIPE} = 'IGNORE';
3896 my $oldAutoCommit = $FS::UID::AutoCommit;
3897 local $FS::UID::AutoCommit = 0;
3900 foreach my $cust_svc ( $self->cust_svc ) {
3901 #false laziness w/svc_Common::insert
3902 my $svc_x = $cust_svc->svc_x;
3903 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
3904 my $error = $part_export->export_insert($svc_x);
3906 $dbh->rollback if $oldAutoCommit;
3912 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3917 =item export_pkg_change OLD_CUST_PKG
3919 Calls the "pkg_change" export action for all services attached to this package.
3923 sub export_pkg_change {
3924 my( $self, $old ) = ( shift, shift );
3926 local $SIG{HUP} = 'IGNORE';
3927 local $SIG{INT} = 'IGNORE';
3928 local $SIG{QUIT} = 'IGNORE';
3929 local $SIG{TERM} = 'IGNORE';
3930 local $SIG{TSTP} = 'IGNORE';
3931 local $SIG{PIPE} = 'IGNORE';
3933 my $oldAutoCommit = $FS::UID::AutoCommit;
3934 local $FS::UID::AutoCommit = 0;
3937 foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
3938 my $error = $svc_x->export('pkg_change', $self, $old);
3940 $dbh->rollback if $oldAutoCommit;
3945 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3952 Associates this package with a (suspension or cancellation) reason (see
3953 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
3956 Available options are:
3962 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.
3966 the access_user (see L<FS::access_user>) providing the reason
3974 the action (cancel, susp, adjourn, expire) associated with the reason
3978 If there is an error, returns the error, otherwise returns false.
3983 my ($self, %options) = @_;
3985 my $otaker = $options{reason_otaker} ||
3986 $FS::CurrentUser::CurrentUser->username;
3989 if ( $options{'reason'} =~ /^(\d+)$/ ) {
3993 } elsif ( ref($options{'reason'}) ) {
3995 return 'Enter a new reason (or select an existing one)'
3996 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
3998 my $reason = new FS::reason({
3999 'reason_type' => $options{'reason'}->{'typenum'},
4000 'reason' => $options{'reason'}->{'reason'},
4002 my $error = $reason->insert;
4003 return $error if $error;
4005 $reasonnum = $reason->reasonnum;
4008 return "Unparseable reason: ". $options{'reason'};
4011 my $cust_pkg_reason =
4012 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
4013 'reasonnum' => $reasonnum,
4014 'otaker' => $otaker,
4015 'action' => substr(uc($options{'action'}),0,1),
4016 'date' => $options{'date'}
4021 $cust_pkg_reason->insert;
4024 =item insert_discount
4026 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
4027 inserting a new discount on the fly (see L<FS::discount>).
4029 Available options are:
4037 If there is an error, returns the error, otherwise returns false.
4041 sub insert_discount {
4042 #my ($self, %options) = @_;
4045 my $cust_pkg_discount = new FS::cust_pkg_discount {
4046 'pkgnum' => $self->pkgnum,
4047 'discountnum' => $self->discountnum,
4049 'end_date' => '', #XXX
4050 #for the create a new discount case
4051 '_type' => $self->discountnum__type,
4052 'amount' => $self->discountnum_amount,
4053 'percent' => $self->discountnum_percent,
4054 'months' => $self->discountnum_months,
4055 'setup' => $self->discountnum_setup,
4056 #'disabled' => $self->discountnum_disabled,
4059 $cust_pkg_discount->insert;
4062 =item set_usage USAGE_VALUE_HASHREF
4064 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4065 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4066 upbytes, downbytes, and totalbytes are appropriate keys.
4068 All svc_accts which are part of this package have their values reset.
4073 my ($self, $valueref, %opt) = @_;
4075 #only svc_acct can set_usage for now
4076 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4077 my $svc_x = $cust_svc->svc_x;
4078 $svc_x->set_usage($valueref, %opt)
4079 if $svc_x->can("set_usage");
4083 =item recharge USAGE_VALUE_HASHREF
4085 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4086 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4087 upbytes, downbytes, and totalbytes are appropriate keys.
4089 All svc_accts which are part of this package have their values incremented.
4094 my ($self, $valueref) = @_;
4096 #only svc_acct can set_usage for now
4097 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4098 my $svc_x = $cust_svc->svc_x;
4099 $svc_x->recharge($valueref)
4100 if $svc_x->can("recharge");
4104 =item cust_pkg_discount
4108 sub cust_pkg_discount {
4110 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
4113 =item cust_pkg_discount_active
4117 sub cust_pkg_discount_active {
4119 grep { $_->status eq 'active' } $self->cust_pkg_discount;
4122 =item cust_pkg_usage
4124 Returns a list of all voice usage counters attached to this package.
4128 sub cust_pkg_usage {
4130 qsearch('cust_pkg_usage', { pkgnum => $self->pkgnum });
4133 =item apply_usage OPTIONS
4135 Takes the following options:
4136 - cdr: a call detail record (L<FS::cdr>)
4137 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
4138 - minutes: the maximum number of minutes to be charged
4140 Finds available usage minutes for a call of this class, and subtracts
4141 up to that many minutes from the usage pool. If the usage pool is empty,
4142 and the C<cdr-minutes_priority> global config option is set, minutes may
4143 be taken from other calls as well. Either way, an allocation record will
4144 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
4145 number of minutes of usage applied to the call.
4150 my ($self, %opt) = @_;
4151 my $cdr = $opt{cdr};
4152 my $rate_detail = $opt{rate_detail};
4153 my $minutes = $opt{minutes};
4154 my $classnum = $rate_detail->classnum;
4155 my $pkgnum = $self->pkgnum;
4156 my $custnum = $self->custnum;
4158 local $SIG{HUP} = 'IGNORE';
4159 local $SIG{INT} = 'IGNORE';
4160 local $SIG{QUIT} = 'IGNORE';
4161 local $SIG{TERM} = 'IGNORE';
4162 local $SIG{TSTP} = 'IGNORE';
4163 local $SIG{PIPE} = 'IGNORE';
4165 my $oldAutoCommit = $FS::UID::AutoCommit;
4166 local $FS::UID::AutoCommit = 0;
4168 my $order = FS::Conf->new->config('cdr-minutes_priority');
4172 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
4174 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
4176 my @usage_recs = qsearch({
4177 'table' => 'cust_pkg_usage',
4178 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
4179 ' JOIN cust_pkg USING (pkgnum)'.
4180 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
4181 'select' => 'cust_pkg_usage.*',
4182 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
4183 " ( cust_pkg.custnum = $custnum AND ".
4184 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4185 $is_classnum . ' AND '.
4186 " cust_pkg_usage.minutes > 0",
4187 'order_by' => " ORDER BY priority ASC",
4190 my $orig_minutes = $minutes;
4192 while (!$error and $minutes > 0 and @usage_recs) {
4193 my $cust_pkg_usage = shift @usage_recs;
4194 $cust_pkg_usage->select_for_update;
4195 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
4196 pkgusagenum => $cust_pkg_usage->pkgusagenum,
4197 acctid => $cdr->acctid,
4198 minutes => min($cust_pkg_usage->minutes, $minutes),
4200 $cust_pkg_usage->set('minutes',
4201 $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes
4203 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
4204 $minutes -= $cdr_cust_pkg_usage->minutes;
4206 if ( $order and $minutes > 0 and !$error ) {
4207 # then try to steal minutes from another call
4209 'table' => 'cdr_cust_pkg_usage',
4210 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
4211 ' JOIN part_pkg_usage USING (pkgusagepart)'.
4212 ' JOIN cust_pkg USING (pkgnum)'.
4213 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
4214 ' JOIN cdr USING (acctid)',
4215 'select' => 'cdr_cust_pkg_usage.*',
4216 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
4217 " ( cust_pkg.pkgnum = $pkgnum OR ".
4218 " ( cust_pkg.custnum = $custnum AND ".
4219 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4220 " part_pkg_usage_class.classnum = $classnum",
4221 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
4223 if ( $order eq 'time' ) {
4224 # find CDRs that are using minutes, but have a later startdate
4226 my $startdate = $cdr->startdate;
4227 if ($startdate !~ /^\d+$/) {
4228 die "bad cdr startdate '$startdate'";
4230 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
4231 # minimize needless reshuffling
4232 $search{'order_by'} .= ', cdr.startdate DESC';
4234 # XXX may not work correctly with rate_time schedules. Could
4235 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
4237 $search{'addl_from'} .=
4238 ' JOIN rate_detail'.
4239 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
4240 if ( $order eq 'rate_high' ) {
4241 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
4242 $rate_detail->min_charge;
4243 $search{'order_by'} .= ', rate_detail.min_charge ASC';
4244 } elsif ( $order eq 'rate_low' ) {
4245 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
4246 $rate_detail->min_charge;
4247 $search{'order_by'} .= ', rate_detail.min_charge DESC';
4249 # this should really never happen
4250 die "invalid cdr-minutes_priority value '$order'\n";
4253 my @cdr_usage_recs = qsearch(\%search);
4255 while (!$error and @cdr_usage_recs and $minutes > 0) {
4256 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
4257 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
4258 my $old_cdr = $cdr_cust_pkg_usage->cdr;
4259 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
4260 $cdr_cust_pkg_usage->select_for_update;
4261 $old_cdr->select_for_update;
4262 $cust_pkg_usage->select_for_update;
4263 # in case someone else stole the usage from this CDR
4264 # while waiting for the lock...
4265 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
4266 # steal the usage allocation and flag the old CDR for reprocessing
4267 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
4268 # if the allocation is more minutes than we need, adjust it...
4269 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
4271 $cdr_cust_pkg_usage->set('minutes', $minutes);
4272 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
4273 $error = $cust_pkg_usage->replace;
4275 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
4276 $error ||= $cdr_cust_pkg_usage->replace;
4277 # deduct the stolen minutes
4278 $minutes -= $cdr_cust_pkg_usage->minutes;
4280 # after all minute-stealing is done, reset the affected CDRs
4281 foreach (values %reproc_cdrs) {
4282 $error ||= $_->set_status('');
4283 # XXX or should we just call $cdr->rate right here?
4284 # it's not like we can create a loop this way, since the min_charge
4285 # or call time has to go monotonically in one direction.
4286 # we COULD get some very deep recursions going, though...
4288 } # if $order and $minutes
4291 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
4293 $dbh->commit if $oldAutoCommit;
4294 return $orig_minutes - $minutes;
4298 =item supplemental_pkgs
4300 Returns a list of all packages supplemental to this one.
4304 sub supplemental_pkgs {
4306 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
4311 Returns the package that this one is supplemental to, if any.
4317 if ( $self->main_pkgnum ) {
4318 return FS::cust_pkg->by_key($self->main_pkgnum);
4325 =head1 CLASS METHODS
4331 Returns an SQL expression identifying recurring packages.
4335 sub recurring_sql { "
4336 '0' != ( select freq from part_pkg
4337 where cust_pkg.pkgpart = part_pkg.pkgpart )
4342 Returns an SQL expression identifying one-time packages.
4347 '0' = ( select freq from part_pkg
4348 where cust_pkg.pkgpart = part_pkg.pkgpart )
4353 Returns an SQL expression identifying ordered packages (recurring packages not
4359 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
4364 Returns an SQL expression identifying active packages.
4369 $_[0]->recurring_sql. "
4370 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4371 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4372 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4375 =item not_yet_billed_sql
4377 Returns an SQL expression identifying packages which have not yet been billed.
4381 sub not_yet_billed_sql { "
4382 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4383 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4384 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4389 Returns an SQL expression identifying inactive packages (one-time packages
4390 that are otherwise unsuspended/uncancelled).
4394 sub inactive_sql { "
4395 ". $_[0]->onetime_sql(). "
4396 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4397 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4398 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4403 Returns an SQL expression identifying on-hold packages.
4408 #$_[0]->recurring_sql(). ' AND '.
4410 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4411 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4412 AND ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4419 Returns an SQL expression identifying suspended packages.
4423 sub suspended_sql { susp_sql(@_); }
4425 #$_[0]->recurring_sql(). ' AND '.
4427 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4428 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4429 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4436 Returns an SQL exprression identifying cancelled packages.
4440 sub cancelled_sql { cancel_sql(@_); }
4442 #$_[0]->recurring_sql(). ' AND '.
4443 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
4448 Returns an SQL expression to give the package status as a string.
4454 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
4455 WHEN ( cust_pkg.susp IS NOT NULL AND cust_pkg.setup IS NULL ) THEN 'on hold'
4456 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
4457 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
4458 WHEN ".onetime_sql()." THEN 'one-time charge'
4463 =item search HASHREF
4467 Returns a qsearch hash expression to search for parameters specified in HASHREF.
4468 Valid parameters are
4476 on hold, active, inactive (or one-time charge), suspended, canceled (or cancelled)
4480 Equivalent to "status", except that "canceled"/"cancelled" will exclude
4481 packages that were changed into a new package with the same pkgpart (i.e.
4482 location or quantity changes).
4486 boolean selects custom packages
4492 pkgpart or arrayref or hashref of pkgparts
4496 arrayref of beginning and ending epoch date
4500 arrayref of beginning and ending epoch date
4504 arrayref of beginning and ending epoch date
4508 arrayref of beginning and ending epoch date
4512 arrayref of beginning and ending epoch date
4516 arrayref of beginning and ending epoch date
4520 arrayref of beginning and ending epoch date
4524 pkgnum or APKG_pkgnum
4528 a value suited to passing to FS::UI::Web::cust_header
4532 specifies the user for agent virtualization
4536 boolean; if true, returns only packages with more than 0 FCC phone lines.
4538 =item state, country
4540 Limit to packages with a service location in the specified state and country.
4541 For FCC 477 reporting, mostly.
4545 Limit to packages whose service locations are the same as the customer's
4546 default service location.
4548 =item location_nocust
4550 Limit to packages whose service locations are not the customer's default
4553 =item location_census
4555 Limit to packages whose service locations have census tracts.
4557 =item location_nocensus
4559 Limit to packages whose service locations do not have a census tract.
4561 =item location_geocode
4563 Limit to packages whose locations have geocodes.
4565 =item location_geocode
4567 Limit to packages whose locations do not have geocodes.
4571 Limit to packages associated with a svc_broadband, associated with a sector,
4572 associated with this towernum (or any of these, if it's an arrayref) (or NO
4573 towernum, if it's zero). This is an extreme niche case.
4575 =item 477part, 477rownum, date
4577 Limit to packages included in a specific row of one of the FCC 477 reports.
4578 '477part' is the section name (see L<FS::Report::FCC_477> methods), 'date'
4579 is the report as-of date (completely unrelated to the package setup/bill/
4580 other date fields), and '477rownum' is the row number of the report starting
4581 with zero. Row numbers have no inherent meaning, so this is useful only
4582 for explaining a 477 report you've already run.
4589 my ($class, $params) = @_;
4596 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
4598 "cust_main.agentnum = $1";
4605 if ( $params->{'cust_status'} =~ /^([a-z]+)$/ ) {
4606 push @where, FS::cust_main->cust_status_sql . " = '$1' ";
4610 # parse customer sales person
4613 if ( $params->{'cust_main_salesnum'} =~ /^(\d+)$/ ) {
4614 push @where, ($1 > 0) ? "cust_main.salesnum = $1"
4615 : 'cust_main.salesnum IS NULL';
4620 # parse sales person
4623 if ( $params->{'salesnum'} =~ /^(\d+)$/ ) {
4624 push @where, ($1 > 0) ? "cust_pkg.salesnum = $1"
4625 : 'cust_pkg.salesnum IS NULL';
4632 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
4634 "cust_pkg.custnum = $1";
4641 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
4643 "cust_pkg.pkgbatch = '$1'";
4650 if ( $params->{'magic'} eq 'active'
4651 || $params->{'status'} eq 'active' ) {
4653 push @where, FS::cust_pkg->active_sql();
4655 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
4656 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
4658 push @where, FS::cust_pkg->not_yet_billed_sql();
4660 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
4661 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
4663 push @where, FS::cust_pkg->inactive_sql();
4665 } elsif ( $params->{'magic'} =~ /^on[ _]hold$/
4666 || $params->{'status'} =~ /^on[ _]hold$/ ) {
4668 push @where, FS::cust_pkg->on_hold_sql();
4671 } elsif ( $params->{'magic'} eq 'suspended'
4672 || $params->{'status'} eq 'suspended' ) {
4674 push @where, FS::cust_pkg->suspended_sql();
4676 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
4677 || $params->{'status'} =~ /^cancell?ed$/ ) {
4679 push @where, FS::cust_pkg->cancelled_sql();
4683 ### special case: "magic" is used in detail links from browse/part_pkg,
4684 # where "cancelled" has the restriction "and not replaced with a package
4685 # of the same pkgpart". Be consistent with that.
4688 if ( $params->{'magic'} =~ /^cancell?ed$/ ) {
4689 my $new_pkgpart = "SELECT pkgpart FROM cust_pkg AS cust_pkg_next ".
4690 "WHERE cust_pkg_next.change_pkgnum = cust_pkg.pkgnum";
4691 # ...may not exist, if this was just canceled and not changed; in that
4692 # case give it a "new pkgpart" that never equals the old pkgpart
4693 push @where, "COALESCE(($new_pkgpart), 0) != cust_pkg.pkgpart";
4697 # parse package class
4700 if ( exists($params->{'classnum'}) ) {
4703 if ( ref($params->{'classnum'}) ) {
4705 if ( ref($params->{'classnum'}) eq 'HASH' ) {
4706 @classnum = grep $params->{'classnum'}{$_}, keys %{ $params->{'classnum'} };
4707 } elsif ( ref($params->{'classnum'}) eq 'ARRAY' ) {
4708 @classnum = @{ $params->{'classnum'} };
4710 die 'unhandled classnum ref '. $params->{'classnum'};
4714 } elsif ( $params->{'classnum'} =~ /^(\d*)$/ && $1 ne '0' ) {
4721 my @nums = grep $_, @classnum;
4722 push @c_where, 'part_pkg.classnum IN ('. join(',',@nums). ')' if @nums;
4723 my $null = scalar( grep { $_ eq '' } @classnum );
4724 push @c_where, 'part_pkg.classnum IS NULL' if $null;
4726 if ( scalar(@c_where) == 1 ) {
4727 push @where, @c_where;
4728 } elsif ( @c_where ) {
4729 push @where, ' ( '. join(' OR ', @c_where). ' ) ';
4738 # parse refnum (advertising source)
4741 if ( exists($params->{'refnum'}) ) {
4743 if (ref $params->{'refnum'}) {
4744 @refnum = @{ $params->{'refnum'} };
4746 @refnum = ( $params->{'refnum'} );
4748 my $in = join(',', grep /^\d+$/, @refnum);
4749 push @where, "refnum IN($in)" if length $in;
4753 # parse package report options
4756 my @report_option = ();
4757 if ( exists($params->{'report_option'}) ) {
4758 if ( ref($params->{'report_option'}) eq 'ARRAY' ) {
4759 @report_option = @{ $params->{'report_option'} };
4760 } elsif ( $params->{'report_option'} =~ /^([,\d]*)$/ ) {
4761 @report_option = split(',', $1);
4766 if (@report_option) {
4767 # this will result in the empty set for the dangling comma case as it should
4769 map{ "0 < ( SELECT count(*) FROM part_pkg_option
4770 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
4771 AND optionname = 'report_option_$_'
4772 AND optionvalue = '1' )"
4776 foreach my $any ( grep /^report_option_any/, keys %$params ) {
4778 my @report_option_any = ();
4779 if ( ref($params->{$any}) eq 'ARRAY' ) {
4780 @report_option_any = @{ $params->{$any} };
4781 } elsif ( $params->{$any} =~ /^([,\d]*)$/ ) {
4782 @report_option_any = split(',', $1);
4785 if (@report_option_any) {
4786 # this will result in the empty set for the dangling comma case as it should
4787 push @where, ' ( '. join(' OR ',
4788 map{ "0 < ( SELECT count(*) FROM part_pkg_option
4789 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
4790 AND optionname = 'report_option_$_'
4791 AND optionvalue = '1' )"
4792 } @report_option_any
4802 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
4808 push @where, "(part_pkg.fcc_ds0s > 0 OR pkg_class.fcc_ds0s > 0)"
4809 if $params->{fcc_line};
4815 if ( exists($params->{'censustract'}) ) {
4816 $params->{'censustract'} =~ /^([.\d]*)$/;
4817 my $censustract = "cust_location.censustract = '$1'";
4818 $censustract .= ' OR cust_location.censustract is NULL' unless $1;
4819 push @where, "( $censustract )";
4823 # parse censustract2
4825 if ( exists($params->{'censustract2'})
4826 && $params->{'censustract2'} =~ /^(\d*)$/
4830 push @where, "cust_location.censustract LIKE '$1%'";
4833 "( cust_location.censustract = '' OR cust_location.censustract IS NULL )";
4838 # parse country/state/zip
4840 for (qw(state country)) { # parsing rules are the same for these
4841 if ( exists($params->{$_})
4842 && uc($params->{$_}) =~ /^([A-Z]{2})$/ )
4844 # XXX post-2.3 only--before that, state/country may be in cust_main
4845 push @where, "cust_location.$_ = '$1'";
4848 if ( exists($params->{zip}) ) {
4849 push @where, "cust_location.zip = " . dbh->quote($params->{zip});
4855 if ( $params->{location_cust} xor $params->{location_nocust} ) {
4856 my $op = $params->{location_cust} ? '=' : '!=';
4857 push @where, "cust_location.locationnum $op cust_main.ship_locationnum";
4859 if ( $params->{location_census} xor $params->{location_nocensus} ) {
4860 my $op = $params->{location_census} ? "IS NOT NULL" : "IS NULL";
4861 push @where, "cust_location.censustract $op";
4863 if ( $params->{location_geocode} xor $params->{location_nogeocode} ) {
4864 my $op = $params->{location_geocode} ? "IS NOT NULL" : "IS NULL";
4865 push @where, "cust_location.geocode $op";
4872 if ( ref($params->{'pkgpart'}) ) {
4875 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
4876 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
4877 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
4878 @pkgpart = @{ $params->{'pkgpart'} };
4880 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
4883 @pkgpart = grep /^(\d+)$/, @pkgpart;
4885 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
4887 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
4888 push @where, "pkgpart = $1";
4897 #false laziness w/report_cust_pkg.html
4900 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
4901 'active' => { 'susp'=>1, 'cancel'=>1 },
4902 'suspended' => { 'cancel' => 1 },
4907 if( exists($params->{'active'} ) ) {
4908 # This overrides all the other date-related fields, and includes packages
4909 # that were active at some time during the interval. It excludes:
4910 # - packages that were set up after the end of the interval
4911 # - packages that were canceled before the start of the interval
4912 # - packages that were suspended before the start of the interval
4913 # and are still suspended now
4914 my($beginning, $ending) = @{$params->{'active'}};
4916 "cust_pkg.setup IS NOT NULL",
4917 "cust_pkg.setup <= $ending",
4918 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
4919 "(cust_pkg.susp IS NULL OR cust_pkg.susp >= $beginning )",
4920 "NOT (".FS::cust_pkg->onetime_sql . ")";
4923 my $exclude_change_from = 0;
4924 my $exclude_change_to = 0;
4926 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end change_date cancel )) {
4928 next unless exists($params->{$field});
4930 my($beginning, $ending) = @{$params->{$field}};
4932 next if $beginning == 0 && $ending == 4294967295;
4935 "cust_pkg.$field IS NOT NULL",
4936 "cust_pkg.$field >= $beginning",
4937 "cust_pkg.$field <= $ending";
4939 $orderby ||= "ORDER BY cust_pkg.$field";
4941 if ( $field eq 'setup' ) {
4942 $exclude_change_from = 1;
4943 } elsif ( $field eq 'cancel' ) {
4944 $exclude_change_to = 1;
4945 } elsif ( $field eq 'change_date' ) {
4946 # if we are given setup and change_date ranges, and the setup date
4947 # falls in _both_ ranges, then include the package whether it was
4949 $exclude_change_from = 0;
4953 if ($exclude_change_from) {
4954 push @where, "change_pkgnum IS NULL";
4956 if ($exclude_change_to) {
4957 # a join might be more efficient here
4958 push @where, "NOT EXISTS(
4959 SELECT 1 FROM cust_pkg AS changed_to_pkg
4960 WHERE cust_pkg.pkgnum = changed_to_pkg.change_pkgnum
4965 $orderby ||= 'ORDER BY bill';
4968 # parse magic, legacy, etc.
4971 if ( $params->{'magic'} &&
4972 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
4975 $orderby = 'ORDER BY pkgnum';
4977 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
4978 push @where, "pkgpart = $1";
4981 } elsif ( $params->{'query'} eq 'pkgnum' ) {
4983 $orderby = 'ORDER BY pkgnum';
4985 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
4987 $orderby = 'ORDER BY pkgnum';
4990 SELECT count(*) FROM pkg_svc
4991 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
4992 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
4993 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
4994 AND cust_svc.svcpart = pkg_svc.svcpart
5001 # parse the extremely weird 'towernum' param
5004 if ($params->{towernum}) {
5005 my $towernum = $params->{towernum};
5006 $towernum = [ $towernum ] if !ref($towernum);
5007 my $in = join(',', grep /^\d+$/, @$towernum);
5009 # inefficient, but this is an obscure feature
5010 eval "use FS::Report::Table";
5011 FS::Report::Table->_init_tower_pkg_cache; # probably does nothing
5012 push @where, "EXISTS(
5013 SELECT 1 FROM tower_pkg_cache
5014 WHERE tower_pkg_cache.pkgnum = cust_pkg.pkgnum
5015 AND tower_pkg_cache.towernum IN ($in)
5021 # parse the 477 report drill-down options
5024 if ($params->{'477part'} =~ /^([a-z]+)$/) {
5026 my ($date, $rownum, $agentnum);
5027 if ($params->{'date'} =~ /^(\d+)$/) {
5030 if ($params->{'477rownum'} =~ /^(\d+)$/) {
5033 if ($params->{'agentnum'} =~ /^(\d+)$/) {
5036 if ($date and defined($rownum)) {
5037 my $report = FS::Report::FCC_477->report($section,
5039 'agentnum' => $agentnum,
5042 my $pkgnums = $report->{detail}->[$rownum]
5043 or die "row $rownum is past the end of the report";
5044 # '0' so that if there are no pkgnums (empty string) it will create
5045 # a valid query that returns nothing
5046 warn "PKGNUMS:\n$pkgnums\n\n"; # XXX debug
5048 # and this overrides everything
5049 @where = ( "cust_pkg.pkgnum IN($pkgnums)" );
5050 } # else we're missing some params, ignore the whole business
5054 # setup queries, links, subs, etc. for the search
5057 # here is the agent virtualization
5058 if ($params->{CurrentUser}) {
5060 qsearchs('access_user', { username => $params->{CurrentUser} });
5063 push @where, $access_user->agentnums_sql('table'=>'cust_main');
5068 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
5071 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
5073 my $addl_from = 'LEFT JOIN part_pkg USING ( pkgpart ) '.
5074 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) '.
5075 'LEFT JOIN cust_location USING ( locationnum ) '.
5076 FS::UI::Web::join_cust_main('cust_pkg', 'cust_pkg');
5080 if ( $params->{'select_zip5'} ) {
5081 my $zip = 'cust_location.zip';
5083 $select = "DISTINCT substr($zip,1,5) as zip";
5084 $orderby = "ORDER BY substr($zip,1,5)";
5085 $count_query = "SELECT COUNT( DISTINCT substr($zip,1,5) )";
5087 $select = join(', ',
5089 ( map "part_pkg.$_", qw( pkg freq ) ),
5090 'pkg_class.classname',
5091 'cust_main.custnum AS cust_main_custnum',
5092 FS::UI::Web::cust_sql_fields(
5093 $params->{'cust_fields'}
5096 $count_query = 'SELECT COUNT(*)';
5099 $count_query .= " FROM cust_pkg $addl_from $extra_sql";
5102 'table' => 'cust_pkg',
5104 'select' => $select,
5105 'extra_sql' => $extra_sql,
5106 'order_by' => $orderby,
5107 'addl_from' => $addl_from,
5108 'count_query' => $count_query,
5115 Returns a list of two package counts. The first is a count of packages
5116 based on the supplied criteria and the second is the count of residential
5117 packages with those same criteria. Criteria are specified as in the search
5123 my ($class, $params) = @_;
5125 my $sql_query = $class->search( $params );
5127 my $count_sql = delete($sql_query->{'count_query'});
5128 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
5129 or die "couldn't parse count_sql";
5131 my $count_sth = dbh->prepare($count_sql)
5132 or die "Error preparing $count_sql: ". dbh->errstr;
5134 or die "Error executing $count_sql: ". $count_sth->errstr;
5135 my $count_arrayref = $count_sth->fetchrow_arrayref;
5137 return ( @$count_arrayref );
5141 =item tax_locationnum_sql
5143 Returns an SQL expression for the tax location for a package, based
5144 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
5148 sub tax_locationnum_sql {
5149 my $conf = FS::Conf->new;
5150 if ( $conf->exists('tax-pkg_address') ) {
5151 'cust_pkg.locationnum';
5153 elsif ( $conf->exists('tax-ship_address') ) {
5154 'cust_main.ship_locationnum';
5157 'cust_main.bill_locationnum';
5163 Returns a list: the first item is an SQL fragment identifying matching
5164 packages/customers via location (taking into account shipping and package
5165 address taxation, if enabled), and subsequent items are the parameters to
5166 substitute for the placeholders in that fragment.
5171 my($class, %opt) = @_;
5172 my $ornull = $opt{'ornull'};
5174 my $conf = new FS::Conf;
5176 # '?' placeholders in _location_sql_where
5177 my $x = $ornull ? 3 : 2;
5188 if ( $conf->exists('tax-ship_address') ) {
5191 ( ( ship_last IS NULL OR ship_last = '' )
5192 AND ". _location_sql_where('cust_main', '', $ornull ). "
5194 OR ( ship_last IS NOT NULL AND ship_last != ''
5195 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
5198 # AND payby != 'COMP'
5200 @main_param = ( @bill_param, @bill_param );
5204 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
5205 @main_param = @bill_param;
5211 if ( $conf->exists('tax-pkg_address') ) {
5213 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
5216 ( cust_pkg.locationnum IS NULL AND $main_where )
5217 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
5220 @param = ( @main_param, @bill_param );
5224 $where = $main_where;
5225 @param = @main_param;
5233 #subroutine, helper for location_sql
5234 sub _location_sql_where {
5236 my $prefix = @_ ? shift : '';
5237 my $ornull = @_ ? shift : '';
5239 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
5241 $ornull = $ornull ? ' OR ? IS NULL ' : '';
5243 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
5244 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
5245 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
5247 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
5249 # ( $table.${prefix}city = ? $or_empty_city $ornull )
5251 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
5252 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
5253 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
5254 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
5255 AND $table.${prefix}country = ?
5260 my( $self, $what ) = @_;
5262 my $what_show_zero = $what. '_show_zero';
5263 length($self->$what_show_zero())
5264 ? ($self->$what_show_zero() eq 'Y')
5265 : $self->part_pkg->$what_show_zero();
5272 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
5274 CUSTNUM is a customer (see L<FS::cust_main>)
5276 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5277 L<FS::part_pkg>) to order for this customer. Duplicates are of course
5280 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
5281 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
5282 new billing items. An error is returned if this is not possible (see
5283 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
5286 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5287 newly-created cust_pkg objects.
5289 REFNUM, if specified, will specify the FS::pkg_referral record to be created
5290 and inserted. Multiple FS::pkg_referral records can be created by
5291 setting I<refnum> to an array reference of refnums or a hash reference with
5292 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
5293 record will be created corresponding to cust_main.refnum.
5298 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
5300 my $conf = new FS::Conf;
5302 # Transactionize this whole mess
5303 local $SIG{HUP} = 'IGNORE';
5304 local $SIG{INT} = 'IGNORE';
5305 local $SIG{QUIT} = 'IGNORE';
5306 local $SIG{TERM} = 'IGNORE';
5307 local $SIG{TSTP} = 'IGNORE';
5308 local $SIG{PIPE} = 'IGNORE';
5310 my $oldAutoCommit = $FS::UID::AutoCommit;
5311 local $FS::UID::AutoCommit = 0;
5315 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
5316 # return "Customer not found: $custnum" unless $cust_main;
5318 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
5321 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5324 my $change = scalar(@old_cust_pkg) != 0;
5327 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
5329 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
5330 " to pkgpart ". $pkgparts->[0]. "\n"
5333 my $err_or_cust_pkg =
5334 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
5335 'refnum' => $refnum,
5338 unless (ref($err_or_cust_pkg)) {
5339 $dbh->rollback if $oldAutoCommit;
5340 return $err_or_cust_pkg;
5343 push @$return_cust_pkg, $err_or_cust_pkg;
5344 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5349 # Create the new packages.
5350 foreach my $pkgpart (@$pkgparts) {
5352 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
5354 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
5355 pkgpart => $pkgpart,
5359 $error = $cust_pkg->insert( 'change' => $change );
5360 push @$return_cust_pkg, $cust_pkg;
5362 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
5363 my $supp_pkg = FS::cust_pkg->new({
5364 custnum => $custnum,
5365 pkgpart => $link->dst_pkgpart,
5367 main_pkgnum => $cust_pkg->pkgnum,
5370 $error ||= $supp_pkg->insert( 'change' => $change );
5371 push @$return_cust_pkg, $supp_pkg;
5375 $dbh->rollback if $oldAutoCommit;
5380 # $return_cust_pkg now contains refs to all of the newly
5383 # Transfer services and cancel old packages.
5384 foreach my $old_pkg (@old_cust_pkg) {
5386 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
5389 foreach my $new_pkg (@$return_cust_pkg) {
5390 $error = $old_pkg->transfer($new_pkg);
5391 if ($error and $error == 0) {
5392 # $old_pkg->transfer failed.
5393 $dbh->rollback if $oldAutoCommit;
5398 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
5399 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
5400 foreach my $new_pkg (@$return_cust_pkg) {
5401 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
5402 if ($error and $error == 0) {
5403 # $old_pkg->transfer failed.
5404 $dbh->rollback if $oldAutoCommit;
5411 # Transfers were successful, but we went through all of the
5412 # new packages and still had services left on the old package.
5413 # We can't cancel the package under the circumstances, so abort.
5414 $dbh->rollback if $oldAutoCommit;
5415 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
5417 $error = $old_pkg->cancel( quiet=>1 );
5423 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5427 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
5429 A bulk change method to change packages for multiple customers.
5431 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5432 L<FS::part_pkg>) to order for each customer. Duplicates are of course
5435 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
5436 replace. The services (see L<FS::cust_svc>) are moved to the
5437 new billing items. An error is returned if this is not possible (see
5440 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5441 newly-created cust_pkg objects.
5446 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
5448 # Transactionize this whole mess
5449 local $SIG{HUP} = 'IGNORE';
5450 local $SIG{INT} = 'IGNORE';
5451 local $SIG{QUIT} = 'IGNORE';
5452 local $SIG{TERM} = 'IGNORE';
5453 local $SIG{TSTP} = 'IGNORE';
5454 local $SIG{PIPE} = 'IGNORE';
5456 my $oldAutoCommit = $FS::UID::AutoCommit;
5457 local $FS::UID::AutoCommit = 0;
5461 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5464 while(scalar(@old_cust_pkg)) {
5466 my $custnum = $old_cust_pkg[0]->custnum;
5467 my (@remove) = map { $_->pkgnum }
5468 grep { $_->custnum == $custnum } @old_cust_pkg;
5469 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
5471 my $error = order $custnum, $pkgparts, \@remove, \@return;
5473 push @errors, $error
5475 push @$return_cust_pkg, @return;
5478 if (scalar(@errors)) {
5479 $dbh->rollback if $oldAutoCommit;
5480 return join(' / ', @errors);
5483 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5487 # Used by FS::Upgrade to migrate to a new database.
5488 sub _upgrade_data { # class method
5489 my ($class, %opts) = @_;
5490 $class->_upgrade_otaker(%opts);
5492 # RT#10139, bug resulting in contract_end being set when it shouldn't
5493 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
5494 # RT#10830, bad calculation of prorate date near end of year
5495 # the date range for bill is December 2009, and we move it forward
5496 # one year if it's before the previous bill date (which it should
5498 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
5499 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
5500 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
5501 # RT6628, add order_date to cust_pkg
5502 'update cust_pkg set order_date = (select history_date from h_cust_pkg
5503 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
5504 history_action = \'insert\') where order_date is null',
5506 foreach my $sql (@statements) {
5507 my $sth = dbh->prepare($sql);
5508 $sth->execute or die $sth->errstr;
5511 # RT31194: supplemental package links that are deleted don't clean up
5513 my @pkglinknums = qsearch({
5514 'select' => 'DISTINCT cust_pkg.pkglinknum',
5515 'table' => 'cust_pkg',
5516 'addl_from' => ' LEFT JOIN part_pkg_link USING (pkglinknum) ',
5517 'extra_sql' => ' WHERE cust_pkg.pkglinknum IS NOT NULL
5518 AND part_pkg_link.pkglinknum IS NULL',
5520 foreach (@pkglinknums) {
5521 my $pkglinknum = $_->pkglinknum;
5522 warn "cleaning part_pkg_link #$pkglinknum\n";
5523 my $part_pkg_link = FS::part_pkg_link->new({pkglinknum => $pkglinknum});
5524 my $error = $part_pkg_link->remove_linked;
5525 die $error if $error;
5533 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
5535 In sub order, the @pkgparts array (passed by reference) is clobbered.
5537 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
5538 method to pass dates to the recur_prog expression, it should do so.
5540 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
5541 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
5542 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
5543 configuration values. Probably need a subroutine which decides what to do
5544 based on whether or not we've fetched the user yet, rather than a hash. See
5545 FS::UID and the TODO.
5547 Now that things are transactional should the check in the insert method be
5552 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
5553 L<FS::pkg_svc>, schema.html from the base documentation