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->config('invoice_from_name', $self->cust_main->agentnum) ?
964 $conf->config('invoice_from_name', $self->cust_main->agentnum) . ' <' .
965 $conf->config('invoice_from', $self->cust_main->agentnum) . '>' :
966 $conf->config('invoice_from', $self->cust_main->agentnum),
967 'to' => \@invoicing_list,
968 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
969 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
970 'custnum' => $self->custnum,
971 'msgtype' => '', #admin?
974 #should this do something on errors?
981 =item cancel_if_expired [ NOW_TIMESTAMP ]
983 Cancels this package if its expire date has been reached.
987 sub cancel_if_expired {
989 my $time = shift || time;
990 return '' unless $self->expire && $self->expire <= $time;
991 my $error = $self->cancel;
993 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
994 $self->custnum. ": $error";
1001 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
1002 locationnum, (other fields?). Attempts to re-provision cancelled services
1003 using history information (errors at this stage are not fatal).
1005 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
1007 svc_fatal: service provisioning errors are fatal
1009 svc_errors: pass an array reference, will be filled in with any provisioning errors
1011 main_pkgnum: link the package as a supplemental package of this one. For
1017 my( $self, %options ) = @_;
1019 #in case you try do do $uncancel-date = $cust_pkg->uncacel
1020 return '' unless $self->get('cancel');
1022 if ( $self->main_pkgnum and !$options{'main_pkgnum'} ) {
1023 return $self->main_pkg->uncancel(%options);
1030 local $SIG{HUP} = 'IGNORE';
1031 local $SIG{INT} = 'IGNORE';
1032 local $SIG{QUIT} = 'IGNORE';
1033 local $SIG{TERM} = 'IGNORE';
1034 local $SIG{TSTP} = 'IGNORE';
1035 local $SIG{PIPE} = 'IGNORE';
1037 my $oldAutoCommit = $FS::UID::AutoCommit;
1038 local $FS::UID::AutoCommit = 0;
1042 # insert the new package
1045 my $cust_pkg = new FS::cust_pkg {
1046 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
1047 bill => ( $options{'bill'} || $self->get('bill') ),
1049 uncancel_pkgnum => $self->pkgnum,
1050 main_pkgnum => ($options{'main_pkgnum'} || ''),
1051 map { $_ => $self->get($_) } qw(
1052 custnum pkgpart locationnum
1054 susp adjourn resume expire start_date contract_end dundate
1055 change_date change_pkgpart change_locationnum
1056 manual_flag no_auto quantity agent_pkgid recur_show_zero setup_show_zero
1060 my $error = $cust_pkg->insert(
1061 'change' => 1, #supresses any referral credit to a referring customer
1062 'allow_pkgpart' => 1, # allow this even if the package def is disabled
1065 $dbh->rollback if $oldAutoCommit;
1073 #find historical services within this timeframe before the package cancel
1074 # (incompatible with "time" option to cust_pkg->cancel?)
1075 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
1076 # too little? (unprovisioing export delay?)
1077 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
1078 my @h_cust_svc = $self->h_cust_svc( $end, $start );
1081 foreach my $h_cust_svc (@h_cust_svc) {
1082 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
1083 #next unless $h_svc_x; #should this happen?
1084 (my $table = $h_svc_x->table) =~ s/^h_//;
1085 require "FS/$table.pm";
1086 my $class = "FS::$table";
1087 my $svc_x = $class->new( {
1088 'pkgnum' => $cust_pkg->pkgnum,
1089 'svcpart' => $h_cust_svc->svcpart,
1090 map { $_ => $h_svc_x->get($_) } fields($table)
1094 if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
1095 $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
1098 my $svc_error = $svc_x->insert;
1100 if ( $options{svc_fatal} ) {
1101 $dbh->rollback if $oldAutoCommit;
1104 # if we've failed to insert the svc_x object, svc_Common->insert
1105 # will have removed the cust_svc already. if not, then both records
1106 # were inserted but we failed for some other reason (export, most
1107 # likely). in that case, report the error and delete the records.
1108 push @svc_errors, $svc_error;
1109 my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1111 # except if export_insert failed, export_delete probably won't be
1113 local $FS::svc_Common::noexport_hack = 1;
1114 my $cleanup_error = $svc_x->delete; # also deletes cust_svc
1115 if ( $cleanup_error ) { # and if THAT fails, then run away
1116 $dbh->rollback if $oldAutoCommit;
1117 return $cleanup_error;
1122 } #foreach $h_cust_svc
1124 #these are pretty rare, but should handle them
1125 # - dsl_device (mac addresses)
1126 # - phone_device (mac addresses)
1127 # - dsl_note (ikano notes)
1128 # - domain_record (i.e. restore DNS information w/domains)
1129 # - inventory_item(?) (inventory w/un-cancelling service?)
1130 # - nas (svc_broaband nas stuff)
1131 #this stuff is unused in the wild afaik
1132 # - mailinglistmember
1134 # - svc_domain.parent_svcnum?
1135 # - acct_snarf (ancient mail fetching config)
1136 # - cgp_rule (communigate)
1137 # - cust_svc_option (used by our Tron stuff)
1138 # - acct_rt_transaction (used by our time worked stuff)
1141 # also move over any services that didn't unprovision at cancellation
1144 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1145 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1146 my $error = $cust_svc->replace;
1148 $dbh->rollback if $oldAutoCommit;
1154 # Uncancel any supplemental packages, and make them supplemental to the
1158 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1160 $error = $supp_pkg->uncancel(%options, 'main_pkgnum' => $cust_pkg->pkgnum);
1162 $dbh->rollback if $oldAutoCommit;
1163 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1171 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1173 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1174 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1181 Cancels any pending expiration (sets the expire field to null).
1183 If there is an error, returns the error, otherwise returns false.
1188 my( $self, %options ) = @_;
1191 local $SIG{HUP} = 'IGNORE';
1192 local $SIG{INT} = 'IGNORE';
1193 local $SIG{QUIT} = 'IGNORE';
1194 local $SIG{TERM} = 'IGNORE';
1195 local $SIG{TSTP} = 'IGNORE';
1196 local $SIG{PIPE} = 'IGNORE';
1198 my $oldAutoCommit = $FS::UID::AutoCommit;
1199 local $FS::UID::AutoCommit = 0;
1202 my $old = $self->select_for_update;
1204 my $pkgnum = $old->pkgnum;
1205 if ( $old->get('cancel') || $self->get('cancel') ) {
1206 dbh->rollback if $oldAutoCommit;
1207 return "Can't unexpire cancelled package $pkgnum";
1208 # or at least it's pointless
1211 unless ( $old->get('expire') && $self->get('expire') ) {
1212 dbh->rollback if $oldAutoCommit;
1213 return ""; # no error
1216 my %hash = $self->hash;
1217 $hash{'expire'} = '';
1218 my $new = new FS::cust_pkg ( \%hash );
1219 $error = $new->replace( $self, options => { $self->options } );
1221 $dbh->rollback if $oldAutoCommit;
1225 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1231 =item suspend [ OPTION => VALUE ... ]
1233 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1234 package, then suspends the package itself (sets the susp field to now).
1236 Available options are:
1240 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1241 either a reasonnum of an existing reason, or passing a hashref will create
1242 a new reason. The hashref should have the following keys:
1243 - typenum - Reason type (see L<FS::reason_type>
1244 - reason - Text of the new reason.
1246 =item date - can be set to a unix style timestamp to specify when to
1249 =item time - can be set to override the current time, for calculation
1250 of final invoices or unused-time credits
1252 =item resume_date - can be set to a time when the package should be
1253 unsuspended. This may be more convenient than calling C<unsuspend()>
1256 =item from_main - allows a supplemental package to be suspended, rather
1257 than redirecting the method call to its main package. For internal use.
1261 If there is an error, returns the error, otherwise returns false.
1266 my( $self, %options ) = @_;
1269 # pass all suspend/cancel actions to the main package
1270 if ( $self->main_pkgnum and !$options{'from_main'} ) {
1271 return $self->main_pkg->suspend(%options);
1274 local $SIG{HUP} = 'IGNORE';
1275 local $SIG{INT} = 'IGNORE';
1276 local $SIG{QUIT} = 'IGNORE';
1277 local $SIG{TERM} = 'IGNORE';
1278 local $SIG{TSTP} = 'IGNORE';
1279 local $SIG{PIPE} = 'IGNORE';
1281 my $oldAutoCommit = $FS::UID::AutoCommit;
1282 local $FS::UID::AutoCommit = 0;
1285 my $old = $self->select_for_update;
1287 my $pkgnum = $old->pkgnum;
1288 if ( $old->get('cancel') || $self->get('cancel') ) {
1289 dbh->rollback if $oldAutoCommit;
1290 return "Can't suspend cancelled package $pkgnum";
1293 if ( $old->get('susp') || $self->get('susp') ) {
1294 dbh->rollback if $oldAutoCommit;
1295 return ""; # no error # complain on adjourn?
1298 my $suspend_time = $options{'time'} || time;
1299 my $date = $options{date} if $options{date}; # adjourn/suspend later
1300 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1302 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1303 dbh->rollback if $oldAutoCommit;
1304 return "Package $pkgnum expires before it would be suspended.";
1307 # some false laziness with sub cancel
1308 if ( !$options{nobill} && !$date &&
1309 $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1310 # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1311 # make the entire cust_main->bill path recognize 'suspend' and
1312 # 'cancel' separately.
1313 warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1314 my $copy = $self->new({$self->hash});
1316 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1318 'time' => $suspend_time );
1319 warn "Error billing during suspend, custnum ".
1320 #$self->cust_main->custnum. ": $error"
1325 if ( $options{'reason'} ) {
1326 $error = $self->insert_reason( 'reason' => $options{'reason'},
1327 'action' => $date ? 'adjourn' : 'suspend',
1328 'date' => $date ? $date : $suspend_time,
1329 'reason_otaker' => $options{'reason_otaker'},
1332 dbh->rollback if $oldAutoCommit;
1333 return "Error inserting cust_pkg_reason: $error";
1337 # if a reasonnum was passed, get the actual reason object so we can check
1339 # (passing a reason hashref is still allowed, but it can't be used with
1340 # the fancy behavioral options.)
1343 if ($options{'reason'} =~ /^\d+$/) {
1344 $reason = FS::reason->by_key($options{'reason'});
1347 my %hash = $self->hash;
1349 $hash{'adjourn'} = $date;
1351 $hash{'susp'} = $suspend_time;
1354 my $resume_date = $options{'resume_date'} || 0;
1355 if ( $resume_date > ($date || $suspend_time) ) {
1356 $hash{'resume'} = $resume_date;
1359 $options{options} ||= {};
1361 my $new = new FS::cust_pkg ( \%hash );
1362 $error = $new->replace( $self, options => { $self->options,
1363 %{ $options{options} },
1367 $dbh->rollback if $oldAutoCommit;
1371 unless ( $date ) { # then we are suspending now
1373 # credit remaining time if appropriate
1374 # (if required by the package def, or the suspend reason)
1375 my $unused_credit = $self->part_pkg->option('unused_credit_suspend',1)
1376 || ( defined($reason) && $reason->unused_credit );
1378 if ( $unused_credit ) {
1379 warn "crediting unused time on pkg#".$self->pkgnum."\n" if $DEBUG;
1380 my $error = $self->credit_remaining('suspend', $suspend_time);
1382 $dbh->rollback if $oldAutoCommit;
1389 foreach my $cust_svc (
1390 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1392 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1394 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1395 $dbh->rollback if $oldAutoCommit;
1396 return "Illegal svcdb value in part_svc!";
1399 require "FS/$svcdb.pm";
1401 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1403 $error = $svc->suspend;
1405 $dbh->rollback if $oldAutoCommit;
1408 my( $label, $value ) = $cust_svc->label;
1409 push @labels, "$label: $value";
1413 my $conf = new FS::Conf;
1414 if ( $conf->config('suspend_email_admin') ) {
1416 my $error = send_email(
1417 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1418 #invoice_from ??? well as good as any
1419 'to' => $conf->config('suspend_email_admin'),
1420 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1422 "This is an automatic message from your Freeside installation\n",
1423 "informing you that the following customer package has been suspended:\n",
1425 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1426 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1427 ( map { "Service : $_\n" } @labels ),
1429 'custnum' => $self->custnum,
1430 'msgtype' => 'admin'
1434 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1442 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1443 $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1445 $dbh->rollback if $oldAutoCommit;
1446 return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1450 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1455 =item credit_remaining MODE TIME
1457 Generate a credit for this package for the time remaining in the current
1458 billing period. MODE is either "suspend" or "cancel" (determines the
1459 credit type). TIME is the time of suspension/cancellation. Both arguments
1464 # Implementation note:
1466 # If you pkgpart-change a package that has been billed, and it's set to give
1467 # credit on package change, then this method gets called and then the new
1468 # package will have no last_bill date. Therefore the customer will be credited
1469 # only once (per billing period) even if there are multiple package changes.
1471 # If you location-change a package that has been billed, this method will NOT
1472 # be called and the new package WILL have the last bill date of the old
1475 # If the new package is then canceled within the same billing cycle,
1476 # credit_remaining needs to run calc_remain on the OLD package to determine
1477 # the amount of unused time to credit.
1479 sub credit_remaining {
1480 # Add a credit for remaining service
1481 my ($self, $mode, $time) = @_;
1482 die 'credit_remaining requires suspend or cancel'
1483 unless $mode eq 'suspend' or $mode eq 'cancel';
1484 die 'no suspend/cancel time' unless $time > 0;
1486 my $conf = FS::Conf->new;
1487 my $reason_type = $conf->config($mode.'_credit_type');
1489 my $last_bill = $self->getfield('last_bill') || 0;
1490 my $next_bill = $self->getfield('bill') || 0;
1491 if ( $last_bill > 0 # the package has been billed
1492 and $next_bill > 0 # the package has a next bill date
1493 and $next_bill >= $time # which is in the future
1495 my $remaining_value = 0;
1497 my $remain_pkg = $self;
1498 $remaining_value = $remain_pkg->calc_remain('time' => $time);
1500 # we may have to walk back past some package changes to get to the
1501 # one that actually has unused time
1502 while ( $remaining_value == 0 ) {
1503 if ( $remain_pkg->change_pkgnum ) {
1504 $remain_pkg = FS::cust_pkg->by_key($remain_pkg->change_pkgnum);
1506 # the package has really never been billed
1509 $remaining_value = $remain_pkg->calc_remain('time' => $time);
1512 if ( $remaining_value > 0 ) {
1513 warn "Crediting for $remaining_value on package ".$self->pkgnum."\n"
1515 my $error = $self->cust_main->credit(
1517 'Credit for unused time on '. $self->part_pkg->pkg,
1518 'reason_type' => $reason_type,
1520 return "Error crediting customer \$$remaining_value for unused time".
1521 " on ". $self->part_pkg->pkg. ": $error"
1523 } #if $remaining_value
1524 } #if $last_bill, etc.
1528 =item unsuspend [ OPTION => VALUE ... ]
1530 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1531 package, then unsuspends the package itself (clears the susp field and the
1532 adjourn field if it is in the past). If the suspend reason includes an
1533 unsuspension package, that package will be ordered.
1535 Available options are:
1541 Can be set to a date to unsuspend the package in the future (the 'resume'
1544 =item adjust_next_bill
1546 Can be set true to adjust the next bill date forward by
1547 the amount of time the account was inactive. This was set true by default
1548 in the past (from 1.4.2 and 1.5.0pre6 through 1.7.0), but now needs to be
1549 explicitly requested with this option or in the price plan.
1553 If there is an error, returns the error, otherwise returns false.
1558 my( $self, %opt ) = @_;
1561 # pass all suspend/cancel actions to the main package
1562 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1563 return $self->main_pkg->unsuspend(%opt);
1566 local $SIG{HUP} = 'IGNORE';
1567 local $SIG{INT} = 'IGNORE';
1568 local $SIG{QUIT} = 'IGNORE';
1569 local $SIG{TERM} = 'IGNORE';
1570 local $SIG{TSTP} = 'IGNORE';
1571 local $SIG{PIPE} = 'IGNORE';
1573 my $oldAutoCommit = $FS::UID::AutoCommit;
1574 local $FS::UID::AutoCommit = 0;
1577 my $old = $self->select_for_update;
1579 my $pkgnum = $old->pkgnum;
1580 if ( $old->get('cancel') || $self->get('cancel') ) {
1581 $dbh->rollback if $oldAutoCommit;
1582 return "Can't unsuspend cancelled package $pkgnum";
1585 unless ( $old->get('susp') && $self->get('susp') ) {
1586 $dbh->rollback if $oldAutoCommit;
1587 return ""; # no error # complain instead?
1590 # handle the case of setting a future unsuspend (resume) date
1591 # and do not continue to actually unsuspend the package
1592 my $date = $opt{'date'};
1593 if ( $date and $date > time ) { # return an error if $date <= time?
1595 if ( $old->get('expire') && $old->get('expire') < $date ) {
1596 $dbh->rollback if $oldAutoCommit;
1597 return "Package $pkgnum expires before it would be unsuspended.";
1600 my $new = new FS::cust_pkg { $self->hash };
1601 $new->set('resume', $date);
1602 $error = $new->replace($self, options => $self->options);
1605 $dbh->rollback if $oldAutoCommit;
1609 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1615 if (!$self->setup) {
1616 # then this package is being released from on-hold status
1617 $self->set_initial_timers;
1622 foreach my $cust_svc (
1623 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1625 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1627 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1628 $dbh->rollback if $oldAutoCommit;
1629 return "Illegal svcdb value in part_svc!";
1632 require "FS/$svcdb.pm";
1634 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1636 $error = $svc->unsuspend;
1638 $dbh->rollback if $oldAutoCommit;
1641 my( $label, $value ) = $cust_svc->label;
1642 push @labels, "$label: $value";
1647 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1648 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1650 my %hash = $self->hash;
1651 my $inactive = time - $hash{'susp'};
1653 my $conf = new FS::Conf;
1655 # increment next bill date if certain conditions are met:
1656 # - it was due to be billed at some point
1657 # - either the global or local config says to do this
1658 my $adjust_bill = 0;
1661 && ( $hash{'bill'} || $hash{'setup'} )
1662 && ( $opt{'adjust_next_bill'}
1663 || $conf->exists('unsuspend-always_adjust_next_bill_date')
1664 || $self->part_pkg->option('unsuspend_adjust_bill', 1)
1671 # - the package billed during suspension
1672 # - or it was ordered on hold
1673 # - or the customer was credited for the unused time
1675 if ( $self->option('suspend_bill',1)
1676 or ( $self->part_pkg->option('suspend_bill',1)
1677 and ! $self->option('no_suspend_bill',1)
1679 or $hash{'order_date'} == $hash{'susp'}
1680 or $self->part_pkg->option('unused_credit_suspend')
1681 or ( defined($reason) and $reason->unused_credit )
1686 # then add the length of time suspended to the bill date
1687 if ( $adjust_bill ) {
1688 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive
1692 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1693 $hash{'resume'} = '' if !$hash{'adjourn'};
1694 my $new = new FS::cust_pkg ( \%hash );
1695 $error = $new->replace( $self, options => { $self->options } );
1697 $dbh->rollback if $oldAutoCommit;
1703 if ( $reason && $reason->unsuspend_pkgpart ) {
1704 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
1705 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
1707 my $start_date = $self->cust_main->next_bill_date
1708 if $reason->unsuspend_hold;
1711 $unsusp_pkg = FS::cust_pkg->new({
1712 'custnum' => $self->custnum,
1713 'pkgpart' => $reason->unsuspend_pkgpart,
1714 'start_date' => $start_date,
1715 'locationnum' => $self->locationnum,
1716 # discount? probably not...
1719 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
1723 $dbh->rollback if $oldAutoCommit;
1728 if ( $conf->config('unsuspend_email_admin') ) {
1730 my $error = send_email(
1731 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1732 #invoice_from ??? well as good as any
1733 'to' => $conf->config('unsuspend_email_admin'),
1734 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
1735 "This is an automatic message from your Freeside installation\n",
1736 "informing you that the following customer package has been unsuspended:\n",
1738 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1739 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1740 ( map { "Service : $_\n" } @labels ),
1742 "An unsuspension fee was charged: ".
1743 $unsusp_pkg->part_pkg->pkg_comment."\n"
1747 'custnum' => $self->custnum,
1748 'msgtype' => 'admin',
1752 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
1758 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1759 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
1761 $dbh->rollback if $oldAutoCommit;
1762 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1766 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1773 Cancels any pending suspension (sets the adjourn field to null).
1775 If there is an error, returns the error, otherwise returns false.
1780 my( $self, %options ) = @_;
1783 local $SIG{HUP} = 'IGNORE';
1784 local $SIG{INT} = 'IGNORE';
1785 local $SIG{QUIT} = 'IGNORE';
1786 local $SIG{TERM} = 'IGNORE';
1787 local $SIG{TSTP} = 'IGNORE';
1788 local $SIG{PIPE} = 'IGNORE';
1790 my $oldAutoCommit = $FS::UID::AutoCommit;
1791 local $FS::UID::AutoCommit = 0;
1794 my $old = $self->select_for_update;
1796 my $pkgnum = $old->pkgnum;
1797 if ( $old->get('cancel') || $self->get('cancel') ) {
1798 dbh->rollback if $oldAutoCommit;
1799 return "Can't unadjourn cancelled package $pkgnum";
1800 # or at least it's pointless
1803 if ( $old->get('susp') || $self->get('susp') ) {
1804 dbh->rollback if $oldAutoCommit;
1805 return "Can't unadjourn suspended package $pkgnum";
1806 # perhaps this is arbitrary
1809 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1810 dbh->rollback if $oldAutoCommit;
1811 return ""; # no error
1814 my %hash = $self->hash;
1815 $hash{'adjourn'} = '';
1816 $hash{'resume'} = '';
1817 my $new = new FS::cust_pkg ( \%hash );
1818 $error = $new->replace( $self, options => { $self->options } );
1820 $dbh->rollback if $oldAutoCommit;
1824 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1831 =item change HASHREF | OPTION => VALUE ...
1833 Changes this package: cancels it and creates a new one, with a different
1834 pkgpart or locationnum or both. All services are transferred to the new
1835 package (no change will be made if this is not possible).
1837 Options may be passed as a list of key/value pairs or as a hash reference.
1844 New locationnum, to change the location for this package.
1848 New FS::cust_location object, to create a new location and assign it
1853 New FS::cust_main object, to create a new customer and assign the new package
1858 New pkgpart (see L<FS::part_pkg>).
1862 New refnum (see L<FS::part_referral>).
1866 New quantity; if unspecified, the new package will have the same quantity
1871 "New" (existing) FS::cust_pkg object. The package's services and other
1872 attributes will be transferred to this package.
1876 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1877 susp, adjourn, cancel, expire, and contract_end) to the new package.
1879 =item unprotect_svcs
1881 Normally, change() will rollback and return an error if some services
1882 can't be transferred (also see the I<cust_pkg-change_svcpart> config option).
1883 If unprotect_svcs is true, this method will transfer as many services as
1884 it can and then unconditionally cancel the old package.
1888 At least one of locationnum, cust_location, pkgpart, refnum, cust_main, or
1889 cust_pkg must be specified (otherwise, what's the point?)
1891 Returns either the new FS::cust_pkg object or a scalar error.
1895 my $err_or_new_cust_pkg = $old_cust_pkg->change
1899 #some false laziness w/order
1902 my $opt = ref($_[0]) ? shift : { @_ };
1904 my $conf = new FS::Conf;
1906 # Transactionize this whole mess
1907 local $SIG{HUP} = 'IGNORE';
1908 local $SIG{INT} = 'IGNORE';
1909 local $SIG{QUIT} = 'IGNORE';
1910 local $SIG{TERM} = 'IGNORE';
1911 local $SIG{TSTP} = 'IGNORE';
1912 local $SIG{PIPE} = 'IGNORE';
1914 my $oldAutoCommit = $FS::UID::AutoCommit;
1915 local $FS::UID::AutoCommit = 0;
1924 $hash{'setup'} = $time if $self->setup;
1926 $hash{'change_date'} = $time;
1927 $hash{"change_$_"} = $self->$_()
1928 foreach qw( pkgnum pkgpart locationnum );
1930 if ( $opt->{'cust_location'} ) {
1931 $error = $opt->{'cust_location'}->find_or_insert;
1933 $dbh->rollback if $oldAutoCommit;
1934 return "creating location record: $error";
1936 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1939 if ( $opt->{'cust_pkg'} ) {
1940 # treat changing to a package with a different pkgpart as a
1941 # pkgpart change (because it is)
1942 $opt->{'pkgpart'} = $opt->{'cust_pkg'}->pkgpart;
1945 # whether to override pkgpart checking on the new package
1946 my $same_pkgpart = 1;
1947 if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
1951 my $unused_credit = 0;
1952 my $keep_dates = $opt->{'keep_dates'};
1953 # Special case. If the pkgpart is changing, and the customer is
1954 # going to be credited for remaining time, don't keep setup, bill,
1955 # or last_bill dates, and DO pass the flag to cancel() to credit
1957 if ( $opt->{'pkgpart'}
1958 and $opt->{'pkgpart'} != $self->pkgpart
1959 and $self->part_pkg->option('unused_credit_change', 1) ) {
1962 $hash{$_} = '' foreach qw(setup bill last_bill);
1965 if ( $keep_dates ) {
1966 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1967 resume start_date contract_end ) ) {
1968 $hash{$date} = $self->getfield($date);
1971 # always keep this date, regardless of anything
1972 # (the date of the package change is in a different field)
1973 $hash{'order_date'} = $self->getfield('order_date');
1975 # allow $opt->{'locationnum'} = '' to specifically set it to null
1976 # (i.e. customer default location)
1977 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
1979 # usually this doesn't matter. the two cases where it does are:
1980 # 1. unused_credit_change + pkgpart change + setup fee on the new package
1982 # 2. (more importantly) changing a package before it's billed
1983 $hash{'waive_setup'} = $self->waive_setup;
1985 my $custnum = $self->custnum;
1986 if ( $opt->{cust_main} ) {
1987 my $cust_main = $opt->{cust_main};
1988 unless ( $cust_main->custnum ) {
1989 my $error = $cust_main->insert( @{ $opt->{cust_main_insert_args}||[] } );
1991 $dbh->rollback if $oldAutoCommit;
1992 return "inserting customer record: $error";
1995 $custnum = $cust_main->custnum;
1998 $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
2001 if ( $opt->{'cust_pkg'} ) {
2002 # The target package already exists; update it to show that it was
2003 # changed from this package.
2004 $cust_pkg = $opt->{'cust_pkg'};
2006 foreach ( qw( pkgnum pkgpart locationnum ) ) {
2007 $cust_pkg->set("change_$_", $self->get($_));
2009 $cust_pkg->set('change_date', $time);
2010 $error = $cust_pkg->replace;
2013 # Create the new package.
2014 $cust_pkg = new FS::cust_pkg {
2015 custnum => $custnum,
2016 locationnum => $opt->{'locationnum'},
2017 ( map { $_ => ( $opt->{$_} || $self->$_() ) }
2018 qw( pkgpart quantity refnum salesnum )
2022 $error = $cust_pkg->insert( 'change' => 1,
2023 'allow_pkgpart' => $same_pkgpart );
2026 $dbh->rollback if $oldAutoCommit;
2027 return "inserting new package: $error";
2030 # Transfer services and cancel old package.
2032 $error = $self->transfer($cust_pkg);
2033 if ($error and $error == 0) {
2034 # $old_pkg->transfer failed.
2035 $dbh->rollback if $oldAutoCommit;
2036 return "transferring $error";
2039 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2040 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2041 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
2042 if ($error and $error == 0) {
2043 # $old_pkg->transfer failed.
2044 $dbh->rollback if $oldAutoCommit;
2045 return "converting $error";
2049 # We set unprotect_svcs when executing a "future package change". It's
2050 # not a user-interactive operation, so returning an error means the
2051 # package change will just fail. Rather than have that happen, we'll
2052 # let leftover services be deleted.
2053 if ($error > 0 and !$opt->{'unprotect_svcs'}) {
2054 # Transfers were successful, but we still had services left on the old
2055 # package. We can't change the package under this circumstances, so abort.
2056 $dbh->rollback if $oldAutoCommit;
2057 return "unable to transfer all services";
2060 #reset usage if changing pkgpart
2061 # AND usage rollover is off (otherwise adds twice, now and at package bill)
2062 if ($self->pkgpart != $cust_pkg->pkgpart) {
2063 my $part_pkg = $cust_pkg->part_pkg;
2064 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
2068 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
2071 $dbh->rollback if $oldAutoCommit;
2072 return "setting usage values: $error";
2075 # if NOT changing pkgpart, transfer any usage pools over
2076 foreach my $usage ($self->cust_pkg_usage) {
2077 $usage->set('pkgnum', $cust_pkg->pkgnum);
2078 $error = $usage->replace;
2080 $dbh->rollback if $oldAutoCommit;
2081 return "transferring usage pools: $error";
2086 # transfer discounts, if we're not changing pkgpart
2087 if ( $same_pkgpart ) {
2088 foreach my $old_discount ($self->cust_pkg_discount_active) {
2089 # don't remove the old discount, we may still need to bill that package.
2090 my $new_discount = new FS::cust_pkg_discount {
2091 'pkgnum' => $cust_pkg->pkgnum,
2092 'discountnum' => $old_discount->discountnum,
2093 'months_used' => $old_discount->months_used,
2095 $error = $new_discount->insert;
2097 $dbh->rollback if $oldAutoCommit;
2098 return "transferring discounts: $error";
2103 # transfer (copy) invoice details
2104 foreach my $detail ($self->cust_pkg_detail) {
2105 my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
2106 $new_detail->set('pkgdetailnum', '');
2107 $new_detail->set('pkgnum', $cust_pkg->pkgnum);
2108 $error = $new_detail->insert;
2110 $dbh->rollback if $oldAutoCommit;
2111 return "transferring package notes: $error";
2117 if ( !$opt->{'cust_pkg'} ) {
2118 # Order any supplemental packages.
2119 my $part_pkg = $cust_pkg->part_pkg;
2120 my @old_supp_pkgs = $self->supplemental_pkgs;
2121 foreach my $link ($part_pkg->supp_part_pkg_link) {
2123 foreach (@old_supp_pkgs) {
2124 if ($_->pkgpart == $link->dst_pkgpart) {
2126 $_->pkgpart(0); # so that it can't match more than once
2130 # false laziness with FS::cust_main::Packages::order_pkg
2131 my $new = FS::cust_pkg->new({
2132 pkgpart => $link->dst_pkgpart,
2133 pkglinknum => $link->pkglinknum,
2134 custnum => $custnum,
2135 main_pkgnum => $cust_pkg->pkgnum,
2136 locationnum => $cust_pkg->locationnum,
2137 start_date => $cust_pkg->start_date,
2138 order_date => $cust_pkg->order_date,
2139 expire => $cust_pkg->expire,
2140 adjourn => $cust_pkg->adjourn,
2141 contract_end => $cust_pkg->contract_end,
2142 refnum => $cust_pkg->refnum,
2143 discountnum => $cust_pkg->discountnum,
2144 waive_setup => $cust_pkg->waive_setup,
2146 if ( $old and $opt->{'keep_dates'} ) {
2147 foreach (qw(setup bill last_bill)) {
2148 $new->set($_, $old->get($_));
2151 $error = $new->insert( allow_pkgpart => $same_pkgpart );
2154 $error ||= $old->transfer($new);
2156 if ( $error and $error > 0 ) {
2157 # no reason why this should ever fail, but still...
2158 $error = "Unable to transfer all services from supplemental package ".
2162 $dbh->rollback if $oldAutoCommit;
2165 push @new_supp_pkgs, $new;
2167 } # if !$opt->{'cust_pkg'}
2168 # because if there is one, then supplemental packages would already
2169 # have been created for it.
2171 #Good to go, cancel old package. Notify 'cancel' of whether to credit
2173 #Don't allow billing the package (preceding period packages and/or
2174 #outstanding usage) if we are keeping dates (i.e. location changing),
2175 #because the new package will be billed for the same date range.
2176 #Supplemental packages are also canceled here.
2178 # during scheduled changes, avoid canceling the package we just
2180 $self->set('change_to_pkgnum' => '');
2182 $error = $self->cancel(
2184 unused_credit => $unused_credit,
2185 nobill => $keep_dates,
2186 change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2189 $dbh->rollback if $oldAutoCommit;
2190 return "canceling old package: $error";
2193 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2195 my $error = $cust_pkg->cust_main->bill(
2196 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2199 $dbh->rollback if $oldAutoCommit;
2200 return "billing new package: $error";
2204 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2210 =item change_later OPTION => VALUE...
2212 Schedule a package change for a later date. This actually orders the new
2213 package immediately, but sets its start date for a future date, and sets
2214 the current package to expire on the same date.
2216 If the package is already scheduled for a change, this can be called with
2217 'start_date' to change the scheduled date, or with pkgpart and/or
2218 locationnum to modify the package change. To cancel the scheduled change
2219 entirely, see C<abort_change>.
2227 The date for the package change. Required, and must be in the future.
2235 The pkgpart. locationnum, and quantity of the new package, with the same
2236 meaning as in C<change>.
2244 my $opt = ref($_[0]) ? shift : { @_ };
2246 my $oldAutoCommit = $FS::UID::AutoCommit;
2247 local $FS::UID::AutoCommit = 0;
2250 my $cust_main = $self->cust_main;
2252 my $date = delete $opt->{'start_date'} or return 'start_date required';
2254 if ( $date <= time ) {
2255 $dbh->rollback if $oldAutoCommit;
2256 return "start_date $date is in the past";
2261 if ( $self->change_to_pkgnum ) {
2262 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
2263 my $new_pkgpart = $opt->{'pkgpart'}
2264 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $change_to->pkgpart;
2265 my $new_locationnum = $opt->{'locationnum'}
2266 if $opt->{'locationnum'} and $opt->{'locationnum'} != $change_to->locationnum;
2267 my $new_quantity = $opt->{'quantity'}
2268 if $opt->{'quantity'} and $opt->{'quantity'} != $change_to->quantity;
2269 if ( $new_pkgpart or $new_locationnum or $new_quantity ) {
2270 # it hasn't been billed yet, so in principle we could just edit
2271 # it in place (w/o a package change), but that's bad form.
2272 # So change the package according to the new options...
2273 my $err_or_pkg = $change_to->change(%$opt);
2274 if ( ref $err_or_pkg ) {
2275 # Then set that package up for a future start.
2276 $self->set('change_to_pkgnum', $err_or_pkg->pkgnum);
2277 $self->set('expire', $date); # in case it's different
2278 $err_or_pkg->set('start_date', $date);
2279 $err_or_pkg->set('change_date', '');
2280 $err_or_pkg->set('change_pkgnum', '');
2282 $error = $self->replace ||
2283 $err_or_pkg->replace ||
2284 $change_to->cancel ||
2287 $error = $err_or_pkg;
2289 } else { # change the start date only.
2290 $self->set('expire', $date);
2291 $change_to->set('start_date', $date);
2292 $error = $self->replace || $change_to->replace;
2295 $dbh->rollback if $oldAutoCommit;
2298 $dbh->commit if $oldAutoCommit;
2301 } # if $self->change_to_pkgnum
2303 my $new_pkgpart = $opt->{'pkgpart'}
2304 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2305 my $new_locationnum = $opt->{'locationnum'}
2306 if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2307 my $new_quantity = $opt->{'quantity'}
2308 if $opt->{'quantity'} and $opt->{'quantity'} != $self->quantity;
2310 return '' unless $new_pkgpart or $new_locationnum or $new_quantity; # wouldn't do anything
2312 # allow $opt->{'locationnum'} = '' to specifically set it to null
2313 # (i.e. customer default location)
2314 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2316 my $new = FS::cust_pkg->new( {
2317 custnum => $self->custnum,
2318 locationnum => $opt->{'locationnum'},
2319 start_date => $date,
2320 map { $_ => ( $opt->{$_} || $self->$_() ) }
2321 qw( pkgpart quantity refnum salesnum )
2323 $error = $new->insert('change' => 1,
2324 'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2326 $self->set('change_to_pkgnum', $new->pkgnum);
2327 $self->set('expire', $date);
2328 $error = $self->replace;
2331 $dbh->rollback if $oldAutoCommit;
2333 $dbh->commit if $oldAutoCommit;
2341 Cancels a future package change scheduled by C<change_later>.
2347 my $pkgnum = $self->change_to_pkgnum;
2348 my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
2351 $error = $change_to->cancel || $change_to->delete;
2352 return $error if $error;
2354 $self->set('change_to_pkgnum', '');
2355 $self->set('expire', '');
2359 =item set_quantity QUANTITY
2361 Change the package's quantity field. This is one of the few package properties
2362 that can safely be changed without canceling and reordering the package
2363 (because it doesn't affect tax eligibility). Returns an error or an
2370 $self = $self->replace_old; # just to make sure
2371 $self->quantity(shift);
2375 =item set_salesnum SALESNUM
2377 Change the package's salesnum (sales person) field. This is one of the few
2378 package properties that can safely be changed without canceling and reordering
2379 the package (because it doesn't affect tax eligibility). Returns an error or
2386 $self = $self->replace_old; # just to make sure
2387 $self->salesnum(shift);
2389 # XXX this should probably reassign any credit that's already been given
2392 =item modify_charge OPTIONS
2394 Change the properties of a one-time charge. The following properties can
2395 be changed this way:
2396 - pkg: the package description
2397 - classnum: the package class
2398 - additional: arrayref of additional invoice details to add to this package
2400 and, I<if the charge has not yet been billed>:
2401 - start_date: the date when it will be billed
2402 - amount: the setup fee to be charged
2403 - quantity: the multiplier for the setup fee
2405 If you pass 'adjust_commission' => 1, and the classnum changes, and there are
2406 commission credits linked to this charge, they will be recalculated.
2413 my $part_pkg = $self->part_pkg;
2414 my $pkgnum = $self->pkgnum;
2417 my $oldAutoCommit = $FS::UID::AutoCommit;
2418 local $FS::UID::AutoCommit = 0;
2420 return "Can't use modify_charge except on one-time charges"
2421 unless $part_pkg->freq eq '0';
2423 if ( length($opt{'pkg'}) and $part_pkg->pkg ne $opt{'pkg'} ) {
2424 $part_pkg->set('pkg', $opt{'pkg'});
2427 my %pkg_opt = $part_pkg->options;
2428 my $pkg_opt_modified = 0;
2430 $opt{'additional'} ||= [];
2433 foreach (grep /^additional/, keys %pkg_opt) {
2434 ($i) = ($_ =~ /^additional_info(\d+)$/);
2435 $old_additional[$i] = $pkg_opt{$_} if $i;
2436 delete $pkg_opt{$_};
2439 for ( $i = 0; exists($opt{'additional'}->[$i]); $i++ ) {
2440 $pkg_opt{ "additional_info$i" } = $opt{'additional'}->[$i];
2441 if (!exists($old_additional[$i])
2442 or $old_additional[$i] ne $opt{'additional'}->[$i])
2444 $pkg_opt_modified = 1;
2447 $pkg_opt_modified = 1 if (scalar(@old_additional) - 1) != $i;
2448 $pkg_opt{'additional_count'} = $i if $i > 0;
2451 if ( exists($opt{'classnum'}) and $part_pkg->classnum ne $opt{'classnum'} )
2454 $old_classnum = $part_pkg->classnum;
2455 $part_pkg->set('classnum', $opt{'classnum'});
2458 if ( !$self->get('setup') ) {
2459 # not yet billed, so allow amount, setup_cost, quantity and start_date
2461 if ( exists($opt{'amount'})
2462 and $part_pkg->option('setup_fee') != $opt{'amount'}
2463 and $opt{'amount'} > 0 ) {
2465 $pkg_opt{'setup_fee'} = $opt{'amount'};
2466 $pkg_opt_modified = 1;
2469 if ( exists($opt{'setup_cost'})
2470 and $part_pkg->setup_cost != $opt{'setup_cost'}
2471 and $opt{'setup_cost'} > 0 ) {
2473 $part_pkg->set('setup_cost', $opt{'setup_cost'});
2476 if ( exists($opt{'quantity'})
2477 and $opt{'quantity'} != $self->quantity
2478 and $opt{'quantity'} > 0 ) {
2480 $self->set('quantity', $opt{'quantity'});
2483 if ( exists($opt{'start_date'})
2484 and $opt{'start_date'} != $self->start_date ) {
2486 $self->set('start_date', $opt{'start_date'});
2490 } # else simply ignore them; the UI shouldn't allow editing the fields
2493 if ( $part_pkg->modified or $pkg_opt_modified ) {
2494 # can we safely modify the package def?
2495 # Yes, if it's not available for purchase, and this is the only instance
2497 if ( $part_pkg->disabled
2498 and FS::cust_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 1
2499 and FS::quotation_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 0
2501 $error = $part_pkg->replace( options => \%pkg_opt );
2504 $part_pkg = $part_pkg->clone;
2505 $part_pkg->set('disabled' => 'Y');
2506 $error = $part_pkg->insert( options => \%pkg_opt );
2507 # and associate this as yet-unbilled package to the new package def
2508 $self->set('pkgpart' => $part_pkg->pkgpart);
2511 $dbh->rollback if $oldAutoCommit;
2516 if ($self->modified) { # for quantity or start_date change, or if we had
2517 # to clone the existing package def
2518 my $error = $self->replace;
2519 return $error if $error;
2521 if (defined $old_classnum) {
2522 # fix invoice grouping records
2523 my $old_catname = $old_classnum
2524 ? FS::pkg_class->by_key($old_classnum)->categoryname
2526 my $new_catname = $opt{'classnum'}
2527 ? $part_pkg->pkg_class->categoryname
2529 if ( $old_catname ne $new_catname ) {
2530 foreach my $cust_bill_pkg ($self->cust_bill_pkg) {
2531 # (there should only be one...)
2532 my @display = qsearch( 'cust_bill_pkg_display', {
2533 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2534 'section' => $old_catname,
2536 foreach (@display) {
2537 $_->set('section', $new_catname);
2538 $error = $_->replace;
2540 $dbh->rollback if $oldAutoCommit;
2544 } # foreach $cust_bill_pkg
2547 if ( $opt{'adjust_commission'} ) {
2548 # fix commission credits...tricky.
2549 foreach my $cust_event ($self->cust_event) {
2550 my $part_event = $cust_event->part_event;
2551 foreach my $table (qw(sales agent)) {
2553 "FS::part_event::Action::Mixin::credit_${table}_pkg_class";
2554 my $credit = qsearchs('cust_credit', {
2555 'eventnum' => $cust_event->eventnum,
2557 if ( $part_event->isa($class) ) {
2558 # Yes, this results in current commission rates being applied
2559 # retroactively to a one-time charge. For accounting purposes
2560 # there ought to be some kind of time limit on doing this.
2561 my $amount = $part_event->_calc_credit($self);
2562 if ( $credit and $credit->amount ne $amount ) {
2563 # Void the old credit.
2564 $error = $credit->void('Package class changed');
2566 $dbh->rollback if $oldAutoCommit;
2567 return "$error (adjusting commission credit)";
2570 # redo the event action to recreate the credit.
2572 eval { $part_event->do_action( $self, $cust_event ) };
2574 $dbh->rollback if $oldAutoCommit;
2577 } # if $part_event->isa($class)
2579 } # foreach $cust_event
2580 } # if $opt{'adjust_commission'}
2581 } # if defined $old_classnum
2583 $dbh->commit if $oldAutoCommit;
2589 use Storable 'thaw';
2592 sub process_bulk_cust_pkg {
2594 my $param = thaw(decode_base64(shift));
2595 warn Dumper($param) if $DEBUG;
2597 my $old_part_pkg = qsearchs('part_pkg',
2598 { pkgpart => $param->{'old_pkgpart'} });
2599 my $new_part_pkg = qsearchs('part_pkg',
2600 { pkgpart => $param->{'new_pkgpart'} });
2601 die "Must select a new package type\n" unless $new_part_pkg;
2602 #my $keep_dates = $param->{'keep_dates'} || 0;
2603 my $keep_dates = 1; # there is no good reason to turn this off
2605 local $SIG{HUP} = 'IGNORE';
2606 local $SIG{INT} = 'IGNORE';
2607 local $SIG{QUIT} = 'IGNORE';
2608 local $SIG{TERM} = 'IGNORE';
2609 local $SIG{TSTP} = 'IGNORE';
2610 local $SIG{PIPE} = 'IGNORE';
2612 my $oldAutoCommit = $FS::UID::AutoCommit;
2613 local $FS::UID::AutoCommit = 0;
2616 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
2619 foreach my $old_cust_pkg ( @cust_pkgs ) {
2621 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
2622 if ( $old_cust_pkg->getfield('cancel') ) {
2623 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
2624 $old_cust_pkg->pkgnum."\n"
2628 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
2630 my $error = $old_cust_pkg->change(
2631 'pkgpart' => $param->{'new_pkgpart'},
2632 'keep_dates' => $keep_dates
2634 if ( !ref($error) ) { # change returns the cust_pkg on success
2636 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
2639 $dbh->commit if $oldAutoCommit;
2645 Returns the last bill date, or if there is no last bill date, the setup date.
2646 Useful for billing metered services.
2652 return $self->setfield('last_bill', $_[0]) if @_;
2653 return $self->getfield('last_bill') if $self->getfield('last_bill');
2654 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
2655 'edate' => $self->bill, } );
2656 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
2659 =item last_cust_pkg_reason ACTION
2661 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
2662 Returns false if there is no reason or the package is not currenly ACTION'd
2663 ACTION is one of adjourn, susp, cancel, or expire.
2667 sub last_cust_pkg_reason {
2668 my ( $self, $action ) = ( shift, shift );
2669 my $date = $self->get($action);
2671 'table' => 'cust_pkg_reason',
2672 'hashref' => { 'pkgnum' => $self->pkgnum,
2673 'action' => substr(uc($action), 0, 1),
2676 'order_by' => 'ORDER BY num DESC LIMIT 1',
2680 =item last_reason ACTION
2682 Returns the most recent ACTION FS::reason associated with the package.
2683 Returns false if there is no reason or the package is not currenly ACTION'd
2684 ACTION is one of adjourn, susp, cancel, or expire.
2689 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
2690 $cust_pkg_reason->reason
2691 if $cust_pkg_reason;
2696 Returns the definition for this billing item, as an FS::part_pkg object (see
2703 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
2704 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
2705 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
2710 Returns the cancelled package this package was changed from, if any.
2716 return '' unless $self->change_pkgnum;
2717 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
2720 =item change_cust_main
2722 Returns the customter this package was detached to, if any.
2726 sub change_cust_main {
2728 return '' unless $self->change_custnum;
2729 qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
2734 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
2741 $self->part_pkg->calc_setup($self, @_);
2746 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
2753 $self->part_pkg->calc_recur($self, @_);
2758 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
2765 $self->part_pkg->base_recur($self, @_);
2770 Calls the I<calc_remain> of the FS::part_pkg object associated with this
2777 $self->part_pkg->calc_remain($self, @_);
2782 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
2789 $self->part_pkg->calc_cancel($self, @_);
2794 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
2800 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
2803 =item cust_pkg_detail [ DETAILTYPE ]
2805 Returns any customer package details for this package (see
2806 L<FS::cust_pkg_detail>).
2808 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2812 sub cust_pkg_detail {
2814 my %hash = ( 'pkgnum' => $self->pkgnum );
2815 $hash{detailtype} = shift if @_;
2817 'table' => 'cust_pkg_detail',
2818 'hashref' => \%hash,
2819 'order_by' => 'ORDER BY weight, pkgdetailnum',
2823 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
2825 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
2827 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2829 If there is an error, returns the error, otherwise returns false.
2833 sub set_cust_pkg_detail {
2834 my( $self, $detailtype, @details ) = @_;
2836 local $SIG{HUP} = 'IGNORE';
2837 local $SIG{INT} = 'IGNORE';
2838 local $SIG{QUIT} = 'IGNORE';
2839 local $SIG{TERM} = 'IGNORE';
2840 local $SIG{TSTP} = 'IGNORE';
2841 local $SIG{PIPE} = 'IGNORE';
2843 my $oldAutoCommit = $FS::UID::AutoCommit;
2844 local $FS::UID::AutoCommit = 0;
2847 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
2848 my $error = $current->delete;
2850 $dbh->rollback if $oldAutoCommit;
2851 return "error removing old detail: $error";
2855 foreach my $detail ( @details ) {
2856 my $cust_pkg_detail = new FS::cust_pkg_detail {
2857 'pkgnum' => $self->pkgnum,
2858 'detailtype' => $detailtype,
2859 'detail' => $detail,
2861 my $error = $cust_pkg_detail->insert;
2863 $dbh->rollback if $oldAutoCommit;
2864 return "error adding new detail: $error";
2869 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2876 Returns the customer billing events (see L<FS::cust_event>) for this invoice.
2880 #false laziness w/cust_bill.pm
2884 'table' => 'cust_event',
2885 'addl_from' => 'JOIN part_event USING ( eventpart )',
2886 'hashref' => { 'tablenum' => $self->pkgnum },
2887 'extra_sql' => " AND eventtable = 'cust_pkg' ",
2891 =item num_cust_event
2893 Returns the number of customer billing events (see L<FS::cust_event>) for this package.
2897 #false laziness w/cust_bill.pm
2898 sub num_cust_event {
2900 my $sql = "SELECT COUNT(*) ". $self->_from_cust_event_where;
2901 $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref->[0];
2904 =item exists_cust_event
2906 Returns true if there are customer billing events (see L<FS::cust_event>) for this package. More efficient than using num_cust_event.
2910 sub exists_cust_event {
2912 my $sql = "SELECT 1 ". $self->_from_cust_event_where. " LIMIT 1";
2913 my $row = $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref;
2914 $row ? $row->[0] : '';
2917 sub _from_cust_event_where {
2919 " FROM cust_event JOIN part_event USING ( eventpart ) ".
2920 " WHERE tablenum = ? AND eventtable = 'cust_pkg' ";
2924 my( $self, $sql, @args ) = @_;
2925 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
2926 $sth->execute(@args) or die $sth->errstr. " executing $sql";
2930 =item cust_svc [ SVCPART ] (old, deprecated usage)
2932 =item cust_svc [ OPTION => VALUE ... ] (current usage)
2934 =item cust_svc_unsorted [ OPTION => VALUE ... ]
2936 Returns the services for this package, as FS::cust_svc objects (see
2937 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
2938 spcififed, returns only the matching services.
2940 As an optimization, use the cust_svc_unsorted version if you are not displaying
2947 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
2948 $self->_sort_cust_svc( $self->cust_svc_unsorted_arrayref(@_) );
2951 sub cust_svc_unsorted {
2953 @{ $self->cust_svc_unsorted_arrayref(@_) };
2956 sub cust_svc_unsorted_arrayref {
2959 return [] unless $self->num_cust_svc(@_);
2962 if ( @_ && $_[0] =~ /^\d+/ ) {
2963 $opt{svcpart} = shift;
2964 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2971 'table' => 'cust_svc',
2972 'hashref' => { 'pkgnum' => $self->pkgnum },
2974 if ( $opt{svcpart} ) {
2975 $search{hashref}->{svcpart} = $opt{'svcpart'};
2977 if ( $opt{'svcdb'} ) {
2978 $search{addl_from} = ' LEFT JOIN part_svc USING ( svcpart ) ';
2979 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{'svcdb'} );
2982 [ qsearch(\%search) ];
2986 =item overlimit [ SVCPART ]
2988 Returns the services for this package which have exceeded their
2989 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
2990 is specified, return only the matching services.
2996 return () unless $self->num_cust_svc(@_);
2997 grep { $_->overlimit } $self->cust_svc(@_);
3000 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3002 Returns historical services for this package created before END TIMESTAMP and
3003 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
3004 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
3005 I<pkg_svc.hidden> flag will be omitted.
3011 warn "$me _h_cust_svc called on $self\n"
3014 my ($end, $start, $mode) = @_;
3015 my @cust_svc = $self->_sort_cust_svc(
3016 [ qsearch( 'h_cust_svc',
3017 { 'pkgnum' => $self->pkgnum, },
3018 FS::h_cust_svc->sql_h_search(@_),
3021 if ( defined($mode) && $mode eq 'I' ) {
3022 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
3023 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
3029 sub _sort_cust_svc {
3030 my( $self, $arrayref ) = @_;
3033 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
3035 my %pkg_svc = map { $_->svcpart => $_ }
3036 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
3041 my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
3043 $pkg_svc ? $pkg_svc->primary_svc : '',
3044 $pkg_svc ? $pkg_svc->quantity : 0,
3051 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
3053 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
3055 Returns the number of services for this package. Available options are svcpart
3056 and svcdb. If either is spcififed, returns only the matching services.
3063 return $self->{'_num_cust_svc'}
3065 && exists($self->{'_num_cust_svc'})
3066 && $self->{'_num_cust_svc'} =~ /\d/;
3068 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
3072 if ( @_ && $_[0] =~ /^\d+/ ) {
3073 $opt{svcpart} = shift;
3074 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3080 my $select = 'SELECT COUNT(*) FROM cust_svc ';
3081 my $where = ' WHERE pkgnum = ? ';
3082 my @param = ($self->pkgnum);
3084 if ( $opt{'svcpart'} ) {
3085 $where .= ' AND svcpart = ? ';
3086 push @param, $opt{'svcpart'};
3088 if ( $opt{'svcdb'} ) {
3089 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
3090 $where .= ' AND svcdb = ? ';
3091 push @param, $opt{'svcdb'};
3094 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
3095 $sth->execute(@param) or die $sth->errstr;
3096 $sth->fetchrow_arrayref->[0];
3099 =item available_part_svc
3101 Returns a list of FS::part_svc objects representing services included in this
3102 package but not yet provisioned. Each FS::part_svc object also has an extra
3103 field, I<num_avail>, which specifies the number of available services.
3107 sub available_part_svc {
3110 my $pkg_quantity = $self->quantity || 1;
3112 grep { $_->num_avail > 0 }
3114 my $part_svc = $_->part_svc;
3115 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
3116 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
3118 # more evil encapsulation breakage
3119 if($part_svc->{'Hash'}{'num_avail'} > 0) {
3120 my @exports = $part_svc->part_export_did;
3121 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
3126 $self->part_pkg->pkg_svc;
3129 =item part_svc [ OPTION => VALUE ... ]
3131 Returns a list of FS::part_svc objects representing provisioned and available
3132 services included in this package. Each FS::part_svc object also has the
3133 following extra fields:
3147 (services) - array reference containing the provisioned services, as cust_svc objects
3151 Accepts two options:
3155 =item summarize_size
3157 If true, will omit the extra cust_pkg_svc option for objects where num_cust_svc
3158 is this size or greater.
3160 =item hide_discontinued
3162 If true, will omit looking for services that are no longer avaialble in the
3170 #label -> ($cust_svc->label)[1]
3176 my $pkg_quantity = $self->quantity || 1;
3178 #XXX some sort of sort order besides numeric by svcpart...
3179 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
3181 my $part_svc = $pkg_svc->part_svc;
3182 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3183 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
3184 $part_svc->{'Hash'}{'num_avail'} =
3185 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
3186 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3187 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
3188 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
3189 && $num_cust_svc >= $opt{summarize_size};
3190 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
3192 } $self->part_pkg->pkg_svc;
3194 unless ( $opt{hide_discontinued} ) {
3196 push @part_svc, map {
3198 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3199 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
3200 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
3201 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3202 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
3204 } $self->extra_part_svc;
3211 =item extra_part_svc
3213 Returns a list of FS::part_svc objects corresponding to services in this
3214 package which are still provisioned but not (any longer) available in the
3219 sub extra_part_svc {
3222 my $pkgnum = $self->pkgnum;
3223 #my $pkgpart = $self->pkgpart;
3226 # 'table' => 'part_svc',
3229 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
3230 # WHERE pkg_svc.svcpart = part_svc.svcpart
3231 # AND pkg_svc.pkgpart = ?
3234 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
3235 # LEFT JOIN cust_pkg USING ( pkgnum )
3236 # WHERE cust_svc.svcpart = part_svc.svcpart
3239 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
3242 #seems to benchmark slightly faster... (or did?)
3244 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
3245 my $pkgparts = join(',', @pkgparts);
3248 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
3249 #MySQL doesn't grok DISINCT ON
3250 'select' => 'DISTINCT part_svc.*',
3251 'table' => 'part_svc',
3253 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
3254 AND pkg_svc.pkgpart IN ($pkgparts)
3257 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
3258 LEFT JOIN cust_pkg USING ( pkgnum )
3261 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
3262 'extra_param' => [ [$self->pkgnum=>'int'] ],
3268 Returns a short status string for this package, currently:
3274 =item not yet billed
3276 =item one-time charge
3291 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
3293 return 'cancelled' if $self->get('cancel');
3294 return 'on hold' if $self->susp && ! $self->setup;
3295 return 'suspended' if $self->susp;
3296 return 'not yet billed' unless $self->setup;
3297 return 'one-time charge' if $freq =~ /^(0|$)/;
3301 =item ucfirst_status
3303 Returns the status with the first character capitalized.
3307 sub ucfirst_status {
3308 ucfirst(shift->status);
3313 Class method that returns the list of possible status strings for packages
3314 (see L<the status method|/status>). For example:
3316 @statuses = FS::cust_pkg->statuses();
3320 tie my %statuscolor, 'Tie::IxHash',
3321 'on hold' => '7E0079', #purple!
3322 'not yet billed' => '009999', #teal? cyan?
3323 'one-time charge' => '0000CC', #blue #'000000',
3324 'active' => '00CC00',
3325 'suspended' => 'FF9900',
3326 'cancelled' => 'FF0000',
3330 my $self = shift; #could be class...
3331 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
3332 # # mayble split btw one-time vs. recur
3343 Returns a hex triplet color string for this package's status.
3349 $statuscolor{$self->status};
3354 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
3355 "pkg - comment" depending on user preference).
3361 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
3362 $label = $self->pkgnum. ": $label"
3363 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
3367 =item pkg_label_long
3369 Returns a long label for this package, adding the primary service's label to
3374 sub pkg_label_long {
3376 my $label = $self->pkg_label;
3377 my $cust_svc = $self->primary_cust_svc;
3378 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
3384 Returns a customer-localized label for this package.
3390 $self->part_pkg->pkg_locale( $self->cust_main->locale );
3393 =item primary_cust_svc
3395 Returns a primary service (as FS::cust_svc object) if one can be identified.
3399 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
3401 sub primary_cust_svc {
3404 my @cust_svc = $self->cust_svc;
3406 return '' unless @cust_svc; #no serivces - irrelevant then
3408 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
3410 # primary service as specified in the package definition
3411 # or exactly one service definition with quantity one
3412 my $svcpart = $self->part_pkg->svcpart;
3413 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
3414 return $cust_svc[0] if scalar(@cust_svc) == 1;
3416 #couldn't identify one thing..
3422 Returns a list of lists, calling the label method for all services
3423 (see L<FS::cust_svc>) of this billing item.
3429 map { [ $_->label ] } $self->cust_svc;
3432 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3434 Like the labels method, but returns historical information on services that
3435 were active as of END_TIMESTAMP and (optionally) not cancelled before
3436 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
3437 I<pkg_svc.hidden> flag will be omitted.
3439 Returns a list of lists, calling the label method for all (historical) services
3440 (see L<FS::h_cust_svc>) of this billing item.
3446 warn "$me _h_labels called on $self\n"
3448 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
3453 Like labels, except returns a simple flat list, and shortens long
3454 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3455 identical services to one line that lists the service label and the number of
3456 individual services rather than individual items.
3461 shift->_labels_short( 'labels', @_ );
3464 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
3466 Like h_labels, except returns a simple flat list, and shortens long
3467 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3468 identical services to one line that lists the service label and the number of
3469 individual services rather than individual items.
3473 sub h_labels_short {
3474 shift->_labels_short( 'h_labels', @_ );
3478 my( $self, $method ) = ( shift, shift );
3480 warn "$me _labels_short called on $self with $method method\n"
3483 my $conf = new FS::Conf;
3484 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
3486 warn "$me _labels_short populating \%labels\n"
3490 #tie %labels, 'Tie::IxHash';
3491 push @{ $labels{$_->[0]} }, $_->[1]
3492 foreach $self->$method(@_);
3494 warn "$me _labels_short populating \@labels\n"
3498 foreach my $label ( keys %labels ) {
3500 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
3501 my $num = scalar(@values);
3502 warn "$me _labels_short $num items for $label\n"
3505 if ( $num > $max_same_services ) {
3506 warn "$me _labels_short more than $max_same_services, so summarizing\n"
3508 push @labels, "$label ($num)";
3510 if ( $conf->exists('cust_bill-consolidate_services') ) {
3511 warn "$me _labels_short consolidating services\n"
3513 # push @labels, "$label: ". join(', ', @values);
3515 my $detail = "$label: ";
3516 $detail .= shift(@values). ', '
3518 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
3520 push @labels, $detail;
3522 warn "$me _labels_short done consolidating services\n"
3525 warn "$me _labels_short adding service data\n"
3527 push @labels, map { "$label: $_" } @values;
3538 Returns the parent customer object (see L<FS::cust_main>).
3544 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
3549 Returns the balance for this specific package, when using
3550 experimental package balance.
3556 $self->cust_main->balance_pkgnum( $self->pkgnum );
3559 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
3563 Returns the location object, if any (see L<FS::cust_location>).
3565 =item cust_location_or_main
3567 If this package is associated with a location, returns the locaiton (see
3568 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
3570 =item location_label [ OPTION => VALUE ... ]
3572 Returns the label of the location object (see L<FS::cust_location>).
3576 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
3578 =item tax_locationnum
3580 Returns the foreign key to a L<FS::cust_location> object for calculating
3581 tax on this package, as determined by the C<tax-pkg_address> and
3582 C<tax-ship_address> configuration flags.
3586 sub tax_locationnum {
3588 my $conf = FS::Conf->new;
3589 if ( $conf->exists('tax-pkg_address') ) {
3590 return $self->locationnum;
3592 elsif ( $conf->exists('tax-ship_address') ) {
3593 return $self->cust_main->ship_locationnum;
3596 return $self->cust_main->bill_locationnum;
3602 Returns the L<FS::cust_location> object for tax_locationnum.
3608 my $conf = FS::Conf->new;
3609 if ( $conf->exists('tax-pkg_address') and $self->locationnum ) {
3610 return FS::cust_location->by_key($self->locationnum);
3612 elsif ( $conf->exists('tax-ship_address') ) {
3613 return $self->cust_main->ship_location;
3616 return $self->cust_main->bill_location;
3620 =item seconds_since TIMESTAMP
3622 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
3623 package have been online since TIMESTAMP, according to the session monitor.
3625 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
3626 L<Time::Local> and L<Date::Parse> for conversion functions.
3631 my($self, $since) = @_;
3634 foreach my $cust_svc (
3635 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
3637 $seconds += $cust_svc->seconds_since($since);
3644 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
3646 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
3647 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
3650 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3651 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3657 sub seconds_since_sqlradacct {
3658 my($self, $start, $end) = @_;
3662 foreach my $cust_svc (
3664 my $part_svc = $_->part_svc;
3665 $part_svc->svcdb eq 'svc_acct'
3666 && scalar($part_svc->part_export_usage);
3669 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
3676 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
3678 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
3679 in this package for sessions ending between TIMESTAMP_START (inclusive) and
3683 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3684 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3689 sub attribute_since_sqlradacct {
3690 my($self, $start, $end, $attrib) = @_;
3694 foreach my $cust_svc (
3696 my $part_svc = $_->part_svc;
3697 scalar($part_svc->part_export_usage);
3700 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
3712 my( $self, $value ) = @_;
3713 if ( defined($value) ) {
3714 $self->setfield('quantity', $value);
3716 $self->getfield('quantity') || 1;
3719 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
3721 Transfers as many services as possible from this package to another package.
3723 The destination package can be specified by pkgnum by passing an FS::cust_pkg
3724 object. The destination package must already exist.
3726 Services are moved only if the destination allows services with the correct
3727 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
3728 this option with caution! No provision is made for export differences
3729 between the old and new service definitions. Probably only should be used
3730 when your exports for all service definitions of a given svcdb are identical.
3731 (attempt a transfer without it first, to move all possible svcpart-matching
3734 Any services that can't be moved remain in the original package.
3736 Returns an error, if there is one; otherwise, returns the number of services
3737 that couldn't be moved.
3742 my ($self, $dest_pkgnum, %opt) = @_;
3748 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
3749 $dest = $dest_pkgnum;
3750 $dest_pkgnum = $dest->pkgnum;
3752 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
3755 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
3757 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
3758 $target{$pkg_svc->svcpart} = $pkg_svc->quantity * ( $dest->quantity || 1 );
3761 foreach my $cust_svc ($dest->cust_svc) {
3762 $target{$cust_svc->svcpart}--;
3765 my %svcpart2svcparts = ();
3766 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3767 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
3768 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
3769 next if exists $svcpart2svcparts{$svcpart};
3770 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
3771 $svcpart2svcparts{$svcpart} = [
3773 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
3775 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
3776 'svcpart' => $_ } );
3778 $pkg_svc ? $pkg_svc->primary_svc : '',
3779 $pkg_svc ? $pkg_svc->quantity : 0,
3783 grep { $_ != $svcpart }
3785 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
3787 warn "alternates for svcpart $svcpart: ".
3788 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
3794 foreach my $cust_svc ($self->cust_svc) {
3795 my $svcnum = $cust_svc->svcnum;
3796 if($target{$cust_svc->svcpart} > 0
3797 or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
3798 $target{$cust_svc->svcpart}--;
3799 my $new = new FS::cust_svc { $cust_svc->hash };
3800 $new->pkgnum($dest_pkgnum);
3801 $error = $new->replace($cust_svc);
3802 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3804 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
3805 warn "alternates to consider: ".
3806 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
3808 my @alternate = grep {
3809 warn "considering alternate svcpart $_: ".
3810 "$target{$_} available in new package\n"
3813 } @{$svcpart2svcparts{$cust_svc->svcpart}};
3815 warn "alternate(s) found\n" if $DEBUG;
3816 my $change_svcpart = $alternate[0];
3817 $target{$change_svcpart}--;
3818 my $new = new FS::cust_svc { $cust_svc->hash };
3819 $new->svcpart($change_svcpart);
3820 $new->pkgnum($dest_pkgnum);
3821 $error = $new->replace($cust_svc);
3829 my @label = $cust_svc->label;
3830 return "service $label[1]: $error";
3836 =item grab_svcnums SVCNUM, SVCNUM ...
3838 Change the pkgnum for the provided services to this packages. If there is an
3839 error, returns the error, otherwise returns false.
3847 local $SIG{HUP} = 'IGNORE';
3848 local $SIG{INT} = 'IGNORE';
3849 local $SIG{QUIT} = 'IGNORE';
3850 local $SIG{TERM} = 'IGNORE';
3851 local $SIG{TSTP} = 'IGNORE';
3852 local $SIG{PIPE} = 'IGNORE';
3854 my $oldAutoCommit = $FS::UID::AutoCommit;
3855 local $FS::UID::AutoCommit = 0;
3858 foreach my $svcnum (@svcnum) {
3859 my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
3860 $dbh->rollback if $oldAutoCommit;
3861 return "unknown svcnum $svcnum";
3863 $cust_svc->pkgnum( $self->pkgnum );
3864 my $error = $cust_svc->replace;
3866 $dbh->rollback if $oldAutoCommit;
3871 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3878 This method is deprecated. See the I<depend_jobnum> option to the insert and
3879 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
3886 local $SIG{HUP} = 'IGNORE';
3887 local $SIG{INT} = 'IGNORE';
3888 local $SIG{QUIT} = 'IGNORE';
3889 local $SIG{TERM} = 'IGNORE';
3890 local $SIG{TSTP} = 'IGNORE';
3891 local $SIG{PIPE} = 'IGNORE';
3893 my $oldAutoCommit = $FS::UID::AutoCommit;
3894 local $FS::UID::AutoCommit = 0;
3897 foreach my $cust_svc ( $self->cust_svc ) {
3898 #false laziness w/svc_Common::insert
3899 my $svc_x = $cust_svc->svc_x;
3900 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
3901 my $error = $part_export->export_insert($svc_x);
3903 $dbh->rollback if $oldAutoCommit;
3909 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3914 =item export_pkg_change OLD_CUST_PKG
3916 Calls the "pkg_change" export action for all services attached to this package.
3920 sub export_pkg_change {
3921 my( $self, $old ) = ( shift, shift );
3923 local $SIG{HUP} = 'IGNORE';
3924 local $SIG{INT} = 'IGNORE';
3925 local $SIG{QUIT} = 'IGNORE';
3926 local $SIG{TERM} = 'IGNORE';
3927 local $SIG{TSTP} = 'IGNORE';
3928 local $SIG{PIPE} = 'IGNORE';
3930 my $oldAutoCommit = $FS::UID::AutoCommit;
3931 local $FS::UID::AutoCommit = 0;
3934 foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
3935 my $error = $svc_x->export('pkg_change', $self, $old);
3937 $dbh->rollback if $oldAutoCommit;
3942 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3949 Associates this package with a (suspension or cancellation) reason (see
3950 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
3953 Available options are:
3959 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.
3963 the access_user (see L<FS::access_user>) providing the reason
3971 the action (cancel, susp, adjourn, expire) associated with the reason
3975 If there is an error, returns the error, otherwise returns false.
3980 my ($self, %options) = @_;
3982 my $otaker = $options{reason_otaker} ||
3983 $FS::CurrentUser::CurrentUser->username;
3986 if ( $options{'reason'} =~ /^(\d+)$/ ) {
3990 } elsif ( ref($options{'reason'}) ) {
3992 return 'Enter a new reason (or select an existing one)'
3993 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
3995 my $reason = new FS::reason({
3996 'reason_type' => $options{'reason'}->{'typenum'},
3997 'reason' => $options{'reason'}->{'reason'},
3999 my $error = $reason->insert;
4000 return $error if $error;
4002 $reasonnum = $reason->reasonnum;
4005 return "Unparseable reason: ". $options{'reason'};
4008 my $cust_pkg_reason =
4009 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
4010 'reasonnum' => $reasonnum,
4011 'otaker' => $otaker,
4012 'action' => substr(uc($options{'action'}),0,1),
4013 'date' => $options{'date'}
4018 $cust_pkg_reason->insert;
4021 =item insert_discount
4023 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
4024 inserting a new discount on the fly (see L<FS::discount>).
4026 Available options are:
4034 If there is an error, returns the error, otherwise returns false.
4038 sub insert_discount {
4039 #my ($self, %options) = @_;
4042 my $cust_pkg_discount = new FS::cust_pkg_discount {
4043 'pkgnum' => $self->pkgnum,
4044 'discountnum' => $self->discountnum,
4046 'end_date' => '', #XXX
4047 #for the create a new discount case
4048 '_type' => $self->discountnum__type,
4049 'amount' => $self->discountnum_amount,
4050 'percent' => $self->discountnum_percent,
4051 'months' => $self->discountnum_months,
4052 'setup' => $self->discountnum_setup,
4053 #'disabled' => $self->discountnum_disabled,
4056 $cust_pkg_discount->insert;
4059 =item set_usage USAGE_VALUE_HASHREF
4061 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4062 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4063 upbytes, downbytes, and totalbytes are appropriate keys.
4065 All svc_accts which are part of this package have their values reset.
4070 my ($self, $valueref, %opt) = @_;
4072 #only svc_acct can set_usage for now
4073 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4074 my $svc_x = $cust_svc->svc_x;
4075 $svc_x->set_usage($valueref, %opt)
4076 if $svc_x->can("set_usage");
4080 =item recharge USAGE_VALUE_HASHREF
4082 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4083 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4084 upbytes, downbytes, and totalbytes are appropriate keys.
4086 All svc_accts which are part of this package have their values incremented.
4091 my ($self, $valueref) = @_;
4093 #only svc_acct can set_usage for now
4094 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4095 my $svc_x = $cust_svc->svc_x;
4096 $svc_x->recharge($valueref)
4097 if $svc_x->can("recharge");
4101 =item cust_pkg_discount
4105 sub cust_pkg_discount {
4107 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
4110 =item cust_pkg_discount_active
4114 sub cust_pkg_discount_active {
4116 grep { $_->status eq 'active' } $self->cust_pkg_discount;
4119 =item cust_pkg_usage
4121 Returns a list of all voice usage counters attached to this package.
4125 sub cust_pkg_usage {
4127 qsearch('cust_pkg_usage', { pkgnum => $self->pkgnum });
4130 =item apply_usage OPTIONS
4132 Takes the following options:
4133 - cdr: a call detail record (L<FS::cdr>)
4134 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
4135 - minutes: the maximum number of minutes to be charged
4137 Finds available usage minutes for a call of this class, and subtracts
4138 up to that many minutes from the usage pool. If the usage pool is empty,
4139 and the C<cdr-minutes_priority> global config option is set, minutes may
4140 be taken from other calls as well. Either way, an allocation record will
4141 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
4142 number of minutes of usage applied to the call.
4147 my ($self, %opt) = @_;
4148 my $cdr = $opt{cdr};
4149 my $rate_detail = $opt{rate_detail};
4150 my $minutes = $opt{minutes};
4151 my $classnum = $rate_detail->classnum;
4152 my $pkgnum = $self->pkgnum;
4153 my $custnum = $self->custnum;
4155 local $SIG{HUP} = 'IGNORE';
4156 local $SIG{INT} = 'IGNORE';
4157 local $SIG{QUIT} = 'IGNORE';
4158 local $SIG{TERM} = 'IGNORE';
4159 local $SIG{TSTP} = 'IGNORE';
4160 local $SIG{PIPE} = 'IGNORE';
4162 my $oldAutoCommit = $FS::UID::AutoCommit;
4163 local $FS::UID::AutoCommit = 0;
4165 my $order = FS::Conf->new->config('cdr-minutes_priority');
4169 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
4171 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
4173 my @usage_recs = qsearch({
4174 'table' => 'cust_pkg_usage',
4175 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
4176 ' JOIN cust_pkg USING (pkgnum)'.
4177 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
4178 'select' => 'cust_pkg_usage.*',
4179 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
4180 " ( cust_pkg.custnum = $custnum AND ".
4181 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4182 $is_classnum . ' AND '.
4183 " cust_pkg_usage.minutes > 0",
4184 'order_by' => " ORDER BY priority ASC",
4187 my $orig_minutes = $minutes;
4189 while (!$error and $minutes > 0 and @usage_recs) {
4190 my $cust_pkg_usage = shift @usage_recs;
4191 $cust_pkg_usage->select_for_update;
4192 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
4193 pkgusagenum => $cust_pkg_usage->pkgusagenum,
4194 acctid => $cdr->acctid,
4195 minutes => min($cust_pkg_usage->minutes, $minutes),
4197 $cust_pkg_usage->set('minutes',
4198 $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes
4200 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
4201 $minutes -= $cdr_cust_pkg_usage->minutes;
4203 if ( $order and $minutes > 0 and !$error ) {
4204 # then try to steal minutes from another call
4206 'table' => 'cdr_cust_pkg_usage',
4207 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
4208 ' JOIN part_pkg_usage USING (pkgusagepart)'.
4209 ' JOIN cust_pkg USING (pkgnum)'.
4210 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
4211 ' JOIN cdr USING (acctid)',
4212 'select' => 'cdr_cust_pkg_usage.*',
4213 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
4214 " ( cust_pkg.pkgnum = $pkgnum OR ".
4215 " ( cust_pkg.custnum = $custnum AND ".
4216 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4217 " part_pkg_usage_class.classnum = $classnum",
4218 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
4220 if ( $order eq 'time' ) {
4221 # find CDRs that are using minutes, but have a later startdate
4223 my $startdate = $cdr->startdate;
4224 if ($startdate !~ /^\d+$/) {
4225 die "bad cdr startdate '$startdate'";
4227 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
4228 # minimize needless reshuffling
4229 $search{'order_by'} .= ', cdr.startdate DESC';
4231 # XXX may not work correctly with rate_time schedules. Could
4232 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
4234 $search{'addl_from'} .=
4235 ' JOIN rate_detail'.
4236 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
4237 if ( $order eq 'rate_high' ) {
4238 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
4239 $rate_detail->min_charge;
4240 $search{'order_by'} .= ', rate_detail.min_charge ASC';
4241 } elsif ( $order eq 'rate_low' ) {
4242 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
4243 $rate_detail->min_charge;
4244 $search{'order_by'} .= ', rate_detail.min_charge DESC';
4246 # this should really never happen
4247 die "invalid cdr-minutes_priority value '$order'\n";
4250 my @cdr_usage_recs = qsearch(\%search);
4252 while (!$error and @cdr_usage_recs and $minutes > 0) {
4253 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
4254 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
4255 my $old_cdr = $cdr_cust_pkg_usage->cdr;
4256 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
4257 $cdr_cust_pkg_usage->select_for_update;
4258 $old_cdr->select_for_update;
4259 $cust_pkg_usage->select_for_update;
4260 # in case someone else stole the usage from this CDR
4261 # while waiting for the lock...
4262 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
4263 # steal the usage allocation and flag the old CDR for reprocessing
4264 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
4265 # if the allocation is more minutes than we need, adjust it...
4266 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
4268 $cdr_cust_pkg_usage->set('minutes', $minutes);
4269 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
4270 $error = $cust_pkg_usage->replace;
4272 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
4273 $error ||= $cdr_cust_pkg_usage->replace;
4274 # deduct the stolen minutes
4275 $minutes -= $cdr_cust_pkg_usage->minutes;
4277 # after all minute-stealing is done, reset the affected CDRs
4278 foreach (values %reproc_cdrs) {
4279 $error ||= $_->set_status('');
4280 # XXX or should we just call $cdr->rate right here?
4281 # it's not like we can create a loop this way, since the min_charge
4282 # or call time has to go monotonically in one direction.
4283 # we COULD get some very deep recursions going, though...
4285 } # if $order and $minutes
4288 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
4290 $dbh->commit if $oldAutoCommit;
4291 return $orig_minutes - $minutes;
4295 =item supplemental_pkgs
4297 Returns a list of all packages supplemental to this one.
4301 sub supplemental_pkgs {
4303 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
4308 Returns the package that this one is supplemental to, if any.
4314 if ( $self->main_pkgnum ) {
4315 return FS::cust_pkg->by_key($self->main_pkgnum);
4322 =head1 CLASS METHODS
4328 Returns an SQL expression identifying recurring packages.
4332 sub recurring_sql { "
4333 '0' != ( select freq from part_pkg
4334 where cust_pkg.pkgpart = part_pkg.pkgpart )
4339 Returns an SQL expression identifying one-time packages.
4344 '0' = ( select freq from part_pkg
4345 where cust_pkg.pkgpart = part_pkg.pkgpart )
4350 Returns an SQL expression identifying ordered packages (recurring packages not
4356 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
4361 Returns an SQL expression identifying active packages.
4366 $_[0]->recurring_sql. "
4367 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4368 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4369 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4372 =item not_yet_billed_sql
4374 Returns an SQL expression identifying packages which have not yet been billed.
4378 sub not_yet_billed_sql { "
4379 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4380 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4381 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4386 Returns an SQL expression identifying inactive packages (one-time packages
4387 that are otherwise unsuspended/uncancelled).
4391 sub inactive_sql { "
4392 ". $_[0]->onetime_sql(). "
4393 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4394 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4395 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4400 Returns an SQL expression identifying on-hold packages.
4405 #$_[0]->recurring_sql(). ' AND '.
4407 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4408 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4409 AND ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4416 Returns an SQL expression identifying suspended packages.
4420 sub suspended_sql { susp_sql(@_); }
4422 #$_[0]->recurring_sql(). ' AND '.
4424 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4425 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4426 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4433 Returns an SQL exprression identifying cancelled packages.
4437 sub cancelled_sql { cancel_sql(@_); }
4439 #$_[0]->recurring_sql(). ' AND '.
4440 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
4445 Returns an SQL expression to give the package status as a string.
4451 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
4452 WHEN ( cust_pkg.susp IS NOT NULL AND cust_pkg.setup IS NULL ) THEN 'on hold'
4453 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
4454 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
4455 WHEN ".onetime_sql()." THEN 'one-time charge'
4460 =item search HASHREF
4464 Returns a qsearch hash expression to search for parameters specified in HASHREF.
4465 Valid parameters are
4473 on hold, active, inactive (or one-time charge), suspended, canceled (or cancelled)
4477 Equivalent to "status", except that "canceled"/"cancelled" will exclude
4478 packages that were changed into a new package with the same pkgpart (i.e.
4479 location or quantity changes).
4483 boolean selects custom packages
4489 pkgpart or arrayref or hashref of pkgparts
4493 arrayref of beginning and ending epoch date
4497 arrayref of beginning and ending epoch date
4501 arrayref of beginning and ending epoch date
4505 arrayref of beginning and ending epoch date
4509 arrayref of beginning and ending epoch date
4513 arrayref of beginning and ending epoch date
4517 arrayref of beginning and ending epoch date
4521 pkgnum or APKG_pkgnum
4525 a value suited to passing to FS::UI::Web::cust_header
4529 specifies the user for agent virtualization
4533 boolean; if true, returns only packages with more than 0 FCC phone lines.
4535 =item state, country
4537 Limit to packages with a service location in the specified state and country.
4538 For FCC 477 reporting, mostly.
4542 Limit to packages whose service locations are the same as the customer's
4543 default service location.
4545 =item location_nocust
4547 Limit to packages whose service locations are not the customer's default
4550 =item location_census
4552 Limit to packages whose service locations have census tracts.
4554 =item location_nocensus
4556 Limit to packages whose service locations do not have a census tract.
4558 =item location_geocode
4560 Limit to packages whose locations have geocodes.
4562 =item location_geocode
4564 Limit to packages whose locations do not have geocodes.
4568 Limit to packages associated with a svc_broadband, associated with a sector,
4569 associated with this towernum (or any of these, if it's an arrayref) (or NO
4570 towernum, if it's zero). This is an extreme niche case.
4572 =item 477part, 477rownum, date
4574 Limit to packages included in a specific row of one of the FCC 477 reports.
4575 '477part' is the section name (see L<FS::Report::FCC_477> methods), 'date'
4576 is the report as-of date (completely unrelated to the package setup/bill/
4577 other date fields), and '477rownum' is the row number of the report starting
4578 with zero. Row numbers have no inherent meaning, so this is useful only
4579 for explaining a 477 report you've already run.
4586 my ($class, $params) = @_;
4593 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
4595 "cust_main.agentnum = $1";
4602 if ( $params->{'cust_status'} =~ /^([a-z]+)$/ ) {
4603 push @where, FS::cust_main->cust_status_sql . " = '$1' ";
4607 # parse customer sales person
4610 if ( $params->{'cust_main_salesnum'} =~ /^(\d+)$/ ) {
4611 push @where, ($1 > 0) ? "cust_main.salesnum = $1"
4612 : 'cust_main.salesnum IS NULL';
4617 # parse sales person
4620 if ( $params->{'salesnum'} =~ /^(\d+)$/ ) {
4621 push @where, ($1 > 0) ? "cust_pkg.salesnum = $1"
4622 : 'cust_pkg.salesnum IS NULL';
4629 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
4631 "cust_pkg.custnum = $1";
4638 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
4640 "cust_pkg.pkgbatch = '$1'";
4647 if ( $params->{'magic'} eq 'active'
4648 || $params->{'status'} eq 'active' ) {
4650 push @where, FS::cust_pkg->active_sql();
4652 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
4653 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
4655 push @where, FS::cust_pkg->not_yet_billed_sql();
4657 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
4658 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
4660 push @where, FS::cust_pkg->inactive_sql();
4662 } elsif ( $params->{'magic'} =~ /^on[ _]hold$/
4663 || $params->{'status'} =~ /^on[ _]hold$/ ) {
4665 push @where, FS::cust_pkg->on_hold_sql();
4668 } elsif ( $params->{'magic'} eq 'suspended'
4669 || $params->{'status'} eq 'suspended' ) {
4671 push @where, FS::cust_pkg->suspended_sql();
4673 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
4674 || $params->{'status'} =~ /^cancell?ed$/ ) {
4676 push @where, FS::cust_pkg->cancelled_sql();
4680 ### special case: "magic" is used in detail links from browse/part_pkg,
4681 # where "cancelled" has the restriction "and not replaced with a package
4682 # of the same pkgpart". Be consistent with that.
4685 if ( $params->{'magic'} =~ /^cancell?ed$/ ) {
4686 my $new_pkgpart = "SELECT pkgpart FROM cust_pkg AS cust_pkg_next ".
4687 "WHERE cust_pkg_next.change_pkgnum = cust_pkg.pkgnum";
4688 # ...may not exist, if this was just canceled and not changed; in that
4689 # case give it a "new pkgpart" that never equals the old pkgpart
4690 push @where, "COALESCE(($new_pkgpart), 0) != cust_pkg.pkgpart";
4694 # parse package class
4697 if ( exists($params->{'classnum'}) ) {
4700 if ( ref($params->{'classnum'}) ) {
4702 if ( ref($params->{'classnum'}) eq 'HASH' ) {
4703 @classnum = grep $params->{'classnum'}{$_}, keys %{ $params->{'classnum'} };
4704 } elsif ( ref($params->{'classnum'}) eq 'ARRAY' ) {
4705 @classnum = @{ $params->{'classnum'} };
4707 die 'unhandled classnum ref '. $params->{'classnum'};
4711 } elsif ( $params->{'classnum'} =~ /^(\d*)$/ && $1 ne '0' ) {
4718 my @nums = grep $_, @classnum;
4719 push @c_where, 'part_pkg.classnum IN ('. join(',',@nums). ')' if @nums;
4720 my $null = scalar( grep { $_ eq '' } @classnum );
4721 push @c_where, 'part_pkg.classnum IS NULL' if $null;
4723 if ( scalar(@c_where) == 1 ) {
4724 push @where, @c_where;
4725 } elsif ( @c_where ) {
4726 push @where, ' ( '. join(' OR ', @c_where). ' ) ';
4735 # parse refnum (advertising source)
4738 if ( exists($params->{'refnum'}) ) {
4740 if (ref $params->{'refnum'}) {
4741 @refnum = @{ $params->{'refnum'} };
4743 @refnum = ( $params->{'refnum'} );
4745 my $in = join(',', grep /^\d+$/, @refnum);
4746 push @where, "refnum IN($in)" if length $in;
4750 # parse package report options
4753 my @report_option = ();
4754 if ( exists($params->{'report_option'}) ) {
4755 if ( ref($params->{'report_option'}) eq 'ARRAY' ) {
4756 @report_option = @{ $params->{'report_option'} };
4757 } elsif ( $params->{'report_option'} =~ /^([,\d]*)$/ ) {
4758 @report_option = split(',', $1);
4763 if (@report_option) {
4764 # this will result in the empty set for the dangling comma case as it should
4766 map{ "0 < ( SELECT count(*) FROM part_pkg_option
4767 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
4768 AND optionname = 'report_option_$_'
4769 AND optionvalue = '1' )"
4773 foreach my $any ( grep /^report_option_any/, keys %$params ) {
4775 my @report_option_any = ();
4776 if ( ref($params->{$any}) eq 'ARRAY' ) {
4777 @report_option_any = @{ $params->{$any} };
4778 } elsif ( $params->{$any} =~ /^([,\d]*)$/ ) {
4779 @report_option_any = split(',', $1);
4782 if (@report_option_any) {
4783 # this will result in the empty set for the dangling comma case as it should
4784 push @where, ' ( '. join(' OR ',
4785 map{ "0 < ( SELECT count(*) FROM part_pkg_option
4786 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
4787 AND optionname = 'report_option_$_'
4788 AND optionvalue = '1' )"
4789 } @report_option_any
4799 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
4805 push @where, "(part_pkg.fcc_ds0s > 0 OR pkg_class.fcc_ds0s > 0)"
4806 if $params->{fcc_line};
4812 if ( exists($params->{'censustract'}) ) {
4813 $params->{'censustract'} =~ /^([.\d]*)$/;
4814 my $censustract = "cust_location.censustract = '$1'";
4815 $censustract .= ' OR cust_location.censustract is NULL' unless $1;
4816 push @where, "( $censustract )";
4820 # parse censustract2
4822 if ( exists($params->{'censustract2'})
4823 && $params->{'censustract2'} =~ /^(\d*)$/
4827 push @where, "cust_location.censustract LIKE '$1%'";
4830 "( cust_location.censustract = '' OR cust_location.censustract IS NULL )";
4835 # parse country/state/zip
4837 for (qw(state country)) { # parsing rules are the same for these
4838 if ( exists($params->{$_})
4839 && uc($params->{$_}) =~ /^([A-Z]{2})$/ )
4841 # XXX post-2.3 only--before that, state/country may be in cust_main
4842 push @where, "cust_location.$_ = '$1'";
4845 if ( exists($params->{zip}) ) {
4846 push @where, "cust_location.zip = " . dbh->quote($params->{zip});
4852 if ( $params->{location_cust} xor $params->{location_nocust} ) {
4853 my $op = $params->{location_cust} ? '=' : '!=';
4854 push @where, "cust_location.locationnum $op cust_main.ship_locationnum";
4856 if ( $params->{location_census} xor $params->{location_nocensus} ) {
4857 my $op = $params->{location_census} ? "IS NOT NULL" : "IS NULL";
4858 push @where, "cust_location.censustract $op";
4860 if ( $params->{location_geocode} xor $params->{location_nogeocode} ) {
4861 my $op = $params->{location_geocode} ? "IS NOT NULL" : "IS NULL";
4862 push @where, "cust_location.geocode $op";
4869 if ( ref($params->{'pkgpart'}) ) {
4872 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
4873 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
4874 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
4875 @pkgpart = @{ $params->{'pkgpart'} };
4877 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
4880 @pkgpart = grep /^(\d+)$/, @pkgpart;
4882 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
4884 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
4885 push @where, "pkgpart = $1";
4894 #false laziness w/report_cust_pkg.html
4897 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
4898 'active' => { 'susp'=>1, 'cancel'=>1 },
4899 'suspended' => { 'cancel' => 1 },
4904 if( exists($params->{'active'} ) ) {
4905 # This overrides all the other date-related fields, and includes packages
4906 # that were active at some time during the interval. It excludes:
4907 # - packages that were set up after the end of the interval
4908 # - packages that were canceled before the start of the interval
4909 # - packages that were suspended before the start of the interval
4910 # and are still suspended now
4911 my($beginning, $ending) = @{$params->{'active'}};
4913 "cust_pkg.setup IS NOT NULL",
4914 "cust_pkg.setup <= $ending",
4915 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
4916 "(cust_pkg.susp IS NULL OR cust_pkg.susp >= $beginning )",
4917 "NOT (".FS::cust_pkg->onetime_sql . ")";
4920 my $exclude_change_from = 0;
4921 my $exclude_change_to = 0;
4923 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end change_date cancel )) {
4925 next unless exists($params->{$field});
4927 my($beginning, $ending) = @{$params->{$field}};
4929 next if $beginning == 0 && $ending == 4294967295;
4932 "cust_pkg.$field IS NOT NULL",
4933 "cust_pkg.$field >= $beginning",
4934 "cust_pkg.$field <= $ending";
4936 $orderby ||= "ORDER BY cust_pkg.$field";
4938 if ( $field eq 'setup' ) {
4939 $exclude_change_from = 1;
4940 } elsif ( $field eq 'cancel' ) {
4941 $exclude_change_to = 1;
4942 } elsif ( $field eq 'change_date' ) {
4943 # if we are given setup and change_date ranges, and the setup date
4944 # falls in _both_ ranges, then include the package whether it was
4946 $exclude_change_from = 0;
4950 if ($exclude_change_from) {
4951 push @where, "change_pkgnum IS NULL";
4953 if ($exclude_change_to) {
4954 # a join might be more efficient here
4955 push @where, "NOT EXISTS(
4956 SELECT 1 FROM cust_pkg AS changed_to_pkg
4957 WHERE cust_pkg.pkgnum = changed_to_pkg.change_pkgnum
4962 $orderby ||= 'ORDER BY bill';
4965 # parse magic, legacy, etc.
4968 if ( $params->{'magic'} &&
4969 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
4972 $orderby = 'ORDER BY pkgnum';
4974 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
4975 push @where, "pkgpart = $1";
4978 } elsif ( $params->{'query'} eq 'pkgnum' ) {
4980 $orderby = 'ORDER BY pkgnum';
4982 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
4984 $orderby = 'ORDER BY pkgnum';
4987 SELECT count(*) FROM pkg_svc
4988 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
4989 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
4990 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
4991 AND cust_svc.svcpart = pkg_svc.svcpart
4998 # parse the extremely weird 'towernum' param
5001 if ($params->{towernum}) {
5002 my $towernum = $params->{towernum};
5003 $towernum = [ $towernum ] if !ref($towernum);
5004 my $in = join(',', grep /^\d+$/, @$towernum);
5006 # inefficient, but this is an obscure feature
5007 eval "use FS::Report::Table";
5008 FS::Report::Table->_init_tower_pkg_cache; # probably does nothing
5009 push @where, "EXISTS(
5010 SELECT 1 FROM tower_pkg_cache
5011 WHERE tower_pkg_cache.pkgnum = cust_pkg.pkgnum
5012 AND tower_pkg_cache.towernum IN ($in)
5018 # parse the 477 report drill-down options
5021 if ($params->{'477part'} =~ /^([a-z]+)$/) {
5023 my ($date, $rownum, $agentnum);
5024 if ($params->{'date'} =~ /^(\d+)$/) {
5027 if ($params->{'477rownum'} =~ /^(\d+)$/) {
5030 if ($params->{'agentnum'} =~ /^(\d+)$/) {
5033 if ($date and defined($rownum)) {
5034 my $report = FS::Report::FCC_477->report($section,
5036 'agentnum' => $agentnum,
5039 my $pkgnums = $report->{detail}->[$rownum]
5040 or die "row $rownum is past the end of the report";
5041 # '0' so that if there are no pkgnums (empty string) it will create
5042 # a valid query that returns nothing
5043 warn "PKGNUMS:\n$pkgnums\n\n"; # XXX debug
5045 # and this overrides everything
5046 @where = ( "cust_pkg.pkgnum IN($pkgnums)" );
5047 } # else we're missing some params, ignore the whole business
5051 # setup queries, links, subs, etc. for the search
5054 # here is the agent virtualization
5055 if ($params->{CurrentUser}) {
5057 qsearchs('access_user', { username => $params->{CurrentUser} });
5060 push @where, $access_user->agentnums_sql('table'=>'cust_main');
5065 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
5068 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
5070 my $addl_from = 'LEFT JOIN part_pkg USING ( pkgpart ) '.
5071 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) '.
5072 'LEFT JOIN cust_location USING ( locationnum ) '.
5073 FS::UI::Web::join_cust_main('cust_pkg', 'cust_pkg');
5077 if ( $params->{'select_zip5'} ) {
5078 my $zip = 'cust_location.zip';
5080 $select = "DISTINCT substr($zip,1,5) as zip";
5081 $orderby = "ORDER BY substr($zip,1,5)";
5082 $count_query = "SELECT COUNT( DISTINCT substr($zip,1,5) )";
5084 $select = join(', ',
5086 ( map "part_pkg.$_", qw( pkg freq ) ),
5087 'pkg_class.classname',
5088 'cust_main.custnum AS cust_main_custnum',
5089 FS::UI::Web::cust_sql_fields(
5090 $params->{'cust_fields'}
5093 $count_query = 'SELECT COUNT(*)';
5096 $count_query .= " FROM cust_pkg $addl_from $extra_sql";
5099 'table' => 'cust_pkg',
5101 'select' => $select,
5102 'extra_sql' => $extra_sql,
5103 'order_by' => $orderby,
5104 'addl_from' => $addl_from,
5105 'count_query' => $count_query,
5112 Returns a list of two package counts. The first is a count of packages
5113 based on the supplied criteria and the second is the count of residential
5114 packages with those same criteria. Criteria are specified as in the search
5120 my ($class, $params) = @_;
5122 my $sql_query = $class->search( $params );
5124 my $count_sql = delete($sql_query->{'count_query'});
5125 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
5126 or die "couldn't parse count_sql";
5128 my $count_sth = dbh->prepare($count_sql)
5129 or die "Error preparing $count_sql: ". dbh->errstr;
5131 or die "Error executing $count_sql: ". $count_sth->errstr;
5132 my $count_arrayref = $count_sth->fetchrow_arrayref;
5134 return ( @$count_arrayref );
5138 =item tax_locationnum_sql
5140 Returns an SQL expression for the tax location for a package, based
5141 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
5145 sub tax_locationnum_sql {
5146 my $conf = FS::Conf->new;
5147 if ( $conf->exists('tax-pkg_address') ) {
5148 'cust_pkg.locationnum';
5150 elsif ( $conf->exists('tax-ship_address') ) {
5151 'cust_main.ship_locationnum';
5154 'cust_main.bill_locationnum';
5160 Returns a list: the first item is an SQL fragment identifying matching
5161 packages/customers via location (taking into account shipping and package
5162 address taxation, if enabled), and subsequent items are the parameters to
5163 substitute for the placeholders in that fragment.
5168 my($class, %opt) = @_;
5169 my $ornull = $opt{'ornull'};
5171 my $conf = new FS::Conf;
5173 # '?' placeholders in _location_sql_where
5174 my $x = $ornull ? 3 : 2;
5185 if ( $conf->exists('tax-ship_address') ) {
5188 ( ( ship_last IS NULL OR ship_last = '' )
5189 AND ". _location_sql_where('cust_main', '', $ornull ). "
5191 OR ( ship_last IS NOT NULL AND ship_last != ''
5192 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
5195 # AND payby != 'COMP'
5197 @main_param = ( @bill_param, @bill_param );
5201 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
5202 @main_param = @bill_param;
5208 if ( $conf->exists('tax-pkg_address') ) {
5210 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
5213 ( cust_pkg.locationnum IS NULL AND $main_where )
5214 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
5217 @param = ( @main_param, @bill_param );
5221 $where = $main_where;
5222 @param = @main_param;
5230 #subroutine, helper for location_sql
5231 sub _location_sql_where {
5233 my $prefix = @_ ? shift : '';
5234 my $ornull = @_ ? shift : '';
5236 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
5238 $ornull = $ornull ? ' OR ? IS NULL ' : '';
5240 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
5241 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
5242 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
5244 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
5246 # ( $table.${prefix}city = ? $or_empty_city $ornull )
5248 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
5249 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
5250 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
5251 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
5252 AND $table.${prefix}country = ?
5257 my( $self, $what ) = @_;
5259 my $what_show_zero = $what. '_show_zero';
5260 length($self->$what_show_zero())
5261 ? ($self->$what_show_zero() eq 'Y')
5262 : $self->part_pkg->$what_show_zero();
5269 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
5271 CUSTNUM is a customer (see L<FS::cust_main>)
5273 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5274 L<FS::part_pkg>) to order for this customer. Duplicates are of course
5277 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
5278 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
5279 new billing items. An error is returned if this is not possible (see
5280 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
5283 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5284 newly-created cust_pkg objects.
5286 REFNUM, if specified, will specify the FS::pkg_referral record to be created
5287 and inserted. Multiple FS::pkg_referral records can be created by
5288 setting I<refnum> to an array reference of refnums or a hash reference with
5289 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
5290 record will be created corresponding to cust_main.refnum.
5295 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
5297 my $conf = new FS::Conf;
5299 # Transactionize this whole mess
5300 local $SIG{HUP} = 'IGNORE';
5301 local $SIG{INT} = 'IGNORE';
5302 local $SIG{QUIT} = 'IGNORE';
5303 local $SIG{TERM} = 'IGNORE';
5304 local $SIG{TSTP} = 'IGNORE';
5305 local $SIG{PIPE} = 'IGNORE';
5307 my $oldAutoCommit = $FS::UID::AutoCommit;
5308 local $FS::UID::AutoCommit = 0;
5312 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
5313 # return "Customer not found: $custnum" unless $cust_main;
5315 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
5318 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5321 my $change = scalar(@old_cust_pkg) != 0;
5324 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
5326 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
5327 " to pkgpart ". $pkgparts->[0]. "\n"
5330 my $err_or_cust_pkg =
5331 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
5332 'refnum' => $refnum,
5335 unless (ref($err_or_cust_pkg)) {
5336 $dbh->rollback if $oldAutoCommit;
5337 return $err_or_cust_pkg;
5340 push @$return_cust_pkg, $err_or_cust_pkg;
5341 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5346 # Create the new packages.
5347 foreach my $pkgpart (@$pkgparts) {
5349 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
5351 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
5352 pkgpart => $pkgpart,
5356 $error = $cust_pkg->insert( 'change' => $change );
5357 push @$return_cust_pkg, $cust_pkg;
5359 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
5360 my $supp_pkg = FS::cust_pkg->new({
5361 custnum => $custnum,
5362 pkgpart => $link->dst_pkgpart,
5364 main_pkgnum => $cust_pkg->pkgnum,
5367 $error ||= $supp_pkg->insert( 'change' => $change );
5368 push @$return_cust_pkg, $supp_pkg;
5372 $dbh->rollback if $oldAutoCommit;
5377 # $return_cust_pkg now contains refs to all of the newly
5380 # Transfer services and cancel old packages.
5381 foreach my $old_pkg (@old_cust_pkg) {
5383 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
5386 foreach my $new_pkg (@$return_cust_pkg) {
5387 $error = $old_pkg->transfer($new_pkg);
5388 if ($error and $error == 0) {
5389 # $old_pkg->transfer failed.
5390 $dbh->rollback if $oldAutoCommit;
5395 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
5396 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
5397 foreach my $new_pkg (@$return_cust_pkg) {
5398 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
5399 if ($error and $error == 0) {
5400 # $old_pkg->transfer failed.
5401 $dbh->rollback if $oldAutoCommit;
5408 # Transfers were successful, but we went through all of the
5409 # new packages and still had services left on the old package.
5410 # We can't cancel the package under the circumstances, so abort.
5411 $dbh->rollback if $oldAutoCommit;
5412 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
5414 $error = $old_pkg->cancel( quiet=>1 );
5420 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5424 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
5426 A bulk change method to change packages for multiple customers.
5428 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5429 L<FS::part_pkg>) to order for each customer. Duplicates are of course
5432 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
5433 replace. The services (see L<FS::cust_svc>) are moved to the
5434 new billing items. An error is returned if this is not possible (see
5437 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5438 newly-created cust_pkg objects.
5443 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
5445 # Transactionize this whole mess
5446 local $SIG{HUP} = 'IGNORE';
5447 local $SIG{INT} = 'IGNORE';
5448 local $SIG{QUIT} = 'IGNORE';
5449 local $SIG{TERM} = 'IGNORE';
5450 local $SIG{TSTP} = 'IGNORE';
5451 local $SIG{PIPE} = 'IGNORE';
5453 my $oldAutoCommit = $FS::UID::AutoCommit;
5454 local $FS::UID::AutoCommit = 0;
5458 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5461 while(scalar(@old_cust_pkg)) {
5463 my $custnum = $old_cust_pkg[0]->custnum;
5464 my (@remove) = map { $_->pkgnum }
5465 grep { $_->custnum == $custnum } @old_cust_pkg;
5466 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
5468 my $error = order $custnum, $pkgparts, \@remove, \@return;
5470 push @errors, $error
5472 push @$return_cust_pkg, @return;
5475 if (scalar(@errors)) {
5476 $dbh->rollback if $oldAutoCommit;
5477 return join(' / ', @errors);
5480 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5484 # Used by FS::Upgrade to migrate to a new database.
5485 sub _upgrade_data { # class method
5486 my ($class, %opts) = @_;
5487 $class->_upgrade_otaker(%opts);
5489 # RT#10139, bug resulting in contract_end being set when it shouldn't
5490 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
5491 # RT#10830, bad calculation of prorate date near end of year
5492 # the date range for bill is December 2009, and we move it forward
5493 # one year if it's before the previous bill date (which it should
5495 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
5496 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
5497 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
5498 # RT6628, add order_date to cust_pkg
5499 'update cust_pkg set order_date = (select history_date from h_cust_pkg
5500 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
5501 history_action = \'insert\') where order_date is null',
5503 foreach my $sql (@statements) {
5504 my $sth = dbh->prepare($sql);
5505 $sth->execute or die $sth->errstr;
5508 # RT31194: supplemental package links that are deleted don't clean up
5510 my @pkglinknums = qsearch({
5511 'select' => 'DISTINCT cust_pkg.pkglinknum',
5512 'table' => 'cust_pkg',
5513 'addl_from' => ' LEFT JOIN part_pkg_link USING (pkglinknum) ',
5514 'extra_sql' => ' WHERE cust_pkg.pkglinknum IS NOT NULL
5515 AND part_pkg_link.pkglinknum IS NULL',
5517 foreach (@pkglinknums) {
5518 my $pkglinknum = $_->pkglinknum;
5519 warn "cleaning part_pkg_link #$pkglinknum\n";
5520 my $part_pkg_link = FS::part_pkg_link->new({pkglinknum => $pkglinknum});
5521 my $error = $part_pkg_link->remove_linked;
5522 die $error if $error;
5530 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
5532 In sub order, the @pkgparts array (passed by reference) is clobbered.
5534 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
5535 method to pass dates to the recur_prog expression, it should do so.
5537 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
5538 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
5539 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
5540 configuration values. Probably need a subroutine which decides what to do
5541 based on whether or not we've fetched the user yet, rather than a hash. See
5542 FS::UID and the TODO.
5544 Now that things are transactional should the check in the insert method be
5549 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
5550 L<FS::pkg_svc>, schema.html from the base documentation