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 insert [ OPTION => VALUE ... ]
248 Adds this billing item to the database ("Orders" the item). If there is an
249 error, returns the error, otherwise returns false.
251 If the additional field I<promo_code> is defined instead of I<pkgpart>, it
252 will be used to look up the package definition and agent restrictions will be
255 If the additional field I<refnum> is defined, an FS::pkg_referral record will
256 be created and inserted. Multiple FS::pkg_referral records can be created by
257 setting I<refnum> to an array reference of refnums or a hash reference with
258 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
259 record will be created corresponding to cust_main.refnum.
261 The following options are available:
267 If set true, supresses actions that should only be taken for new package
268 orders. (Currently this includes: intro periods when delay_setup is on,
269 auto-adding a 1st start date, auto-adding expiration/adjourn/contract_end dates)
273 cust_pkg_option records will be created
277 a ticket will be added to this customer with this subject
281 an optional queue name for ticket additions
285 Don't check the legality of the package definition. This should be used
286 when performing a package change that doesn't change the pkgpart (i.e.
294 my( $self, %options ) = @_;
297 $error = $self->check_pkgpart unless $options{'allow_pkgpart'};
298 return $error if $error;
300 my $part_pkg = $self->part_pkg;
302 if ( ! $options{'change'} ) {
304 # if the package def says to start only on the first of the month:
305 if ( $part_pkg->option('start_1st', 1) && !$self->start_date ) {
306 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime(time) )[0,1,2,3,4,5];
307 $mon += 1 unless $mday == 1;
308 until ( $mon < 12 ) { $mon -= 12; $year++; }
309 $self->start_date( timelocal_nocheck(0,0,0,1,$mon,$year) );
312 # set up any automatic expire/adjourn/contract_end timers
313 # based on the start date
314 foreach my $action ( qw(expire adjourn contract_end) ) {
315 my $months = $part_pkg->option("${action}_months",1);
316 if($months and !$self->$action) {
317 my $start = $self->start_date || $self->setup || time;
318 $self->$action( $part_pkg->add_freq($start, $months) );
322 # if this package has "free days" and delayed setup fee, then
323 # set start date that many days in the future.
324 # (this should have been set in the UI, but enforce it here)
325 if ( ! $options{'change'}
326 && $part_pkg->option('free_days',1)
327 && $part_pkg->option('delay_setup',1)
328 #&& ! $self->start_date
331 $self->start_date( $part_pkg->default_start_date );
336 # set order date unless this was previously a different package
337 $self->order_date(time) unless $self->change_pkgnum;
339 local $SIG{HUP} = 'IGNORE';
340 local $SIG{INT} = 'IGNORE';
341 local $SIG{QUIT} = 'IGNORE';
342 local $SIG{TERM} = 'IGNORE';
343 local $SIG{TSTP} = 'IGNORE';
344 local $SIG{PIPE} = 'IGNORE';
346 my $oldAutoCommit = $FS::UID::AutoCommit;
347 local $FS::UID::AutoCommit = 0;
350 $error = $self->SUPER::insert($options{options} ? %{$options{options}} : ());
352 $dbh->rollback if $oldAutoCommit;
356 $self->refnum($self->cust_main->refnum) unless $self->refnum;
357 $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
358 $self->process_m2m( 'link_table' => 'pkg_referral',
359 'target_table' => 'part_referral',
360 'params' => $self->refnum,
363 if ( $self->discountnum ) {
364 my $error = $self->insert_discount();
366 $dbh->rollback if $oldAutoCommit;
371 my $conf = new FS::Conf;
373 if ( $conf->config('ticket_system') && $options{ticket_subject} ) {
375 #this init stuff is still inefficient, but at least its limited to
376 # the small number (any?) folks using ticket emailing on pkg order
379 # use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
386 use FS::TicketSystem;
387 FS::TicketSystem->init();
389 my $q = new RT::Queue($RT::SystemUser);
390 $q->Load($options{ticket_queue}) if $options{ticket_queue};
391 my $t = new RT::Ticket($RT::SystemUser);
392 my $mime = new MIME::Entity;
393 $mime->build( Type => 'text/plain', Data => $options{ticket_subject} );
394 $t->Create( $options{ticket_queue} ? (Queue => $q) : (),
395 Subject => $options{ticket_subject},
398 $t->AddLink( Type => 'MemberOf',
399 Target => 'freeside://freeside/cust_main/'. $self->custnum,
403 if ($conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
404 my $queue = new FS::queue {
405 'job' => 'FS::cust_main::queueable_print',
407 $error = $queue->insert(
408 'custnum' => $self->custnum,
409 'template' => 'welcome_letter',
413 warn "can't send welcome letter: $error";
418 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
425 This method now works but you probably shouldn't use it.
427 You don't want to delete packages, because there would then be no record
428 the customer ever purchased the package. Instead, see the cancel method and
429 hide cancelled packages.
436 local $SIG{HUP} = 'IGNORE';
437 local $SIG{INT} = 'IGNORE';
438 local $SIG{QUIT} = 'IGNORE';
439 local $SIG{TERM} = 'IGNORE';
440 local $SIG{TSTP} = 'IGNORE';
441 local $SIG{PIPE} = 'IGNORE';
443 my $oldAutoCommit = $FS::UID::AutoCommit;
444 local $FS::UID::AutoCommit = 0;
447 foreach my $cust_pkg_discount ($self->cust_pkg_discount) {
448 my $error = $cust_pkg_discount->delete;
450 $dbh->rollback if $oldAutoCommit;
454 #cust_bill_pkg_discount?
456 foreach my $cust_pkg_detail ($self->cust_pkg_detail) {
457 my $error = $cust_pkg_detail->delete;
459 $dbh->rollback if $oldAutoCommit;
464 foreach my $cust_pkg_reason (
466 'table' => 'cust_pkg_reason',
467 'hashref' => { 'pkgnum' => $self->pkgnum },
471 my $error = $cust_pkg_reason->delete;
473 $dbh->rollback if $oldAutoCommit;
480 my $error = $self->SUPER::delete(@_);
482 $dbh->rollback if $oldAutoCommit;
486 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
492 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
494 Replaces the OLD_RECORD with this one in the database. If there is an error,
495 returns the error, otherwise returns false.
497 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
499 Changing pkgpart may have disasterous effects. See the order subroutine.
501 setup and bill are normally updated by calling the bill method of a customer
502 object (see L<FS::cust_main>).
504 suspend is normally updated by the suspend and unsuspend methods.
506 cancel is normally updated by the cancel method (and also the order subroutine
509 Available options are:
515 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.
519 the access_user (see L<FS::access_user>) providing the reason
523 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
532 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
537 ( ref($_[0]) eq 'HASH' )
541 #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
542 #return "Can't change otaker!" if $old->otaker ne $new->otaker;
545 #return "Can't change setup once it exists!"
546 # if $old->getfield('setup') &&
547 # $old->getfield('setup') != $new->getfield('setup');
549 #some logic for bill, susp, cancel?
551 local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
553 local $SIG{HUP} = 'IGNORE';
554 local $SIG{INT} = 'IGNORE';
555 local $SIG{QUIT} = 'IGNORE';
556 local $SIG{TERM} = 'IGNORE';
557 local $SIG{TSTP} = 'IGNORE';
558 local $SIG{PIPE} = 'IGNORE';
560 my $oldAutoCommit = $FS::UID::AutoCommit;
561 local $FS::UID::AutoCommit = 0;
564 foreach my $method ( qw(adjourn expire) ) { # How many reasons?
565 if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
566 my $error = $new->insert_reason(
567 'reason' => $options->{'reason'},
568 'date' => $new->$method,
570 'reason_otaker' => $options->{'reason_otaker'},
573 dbh->rollback if $oldAutoCommit;
574 return "Error inserting cust_pkg_reason: $error";
579 #save off and freeze RADIUS attributes for any associated svc_acct records
581 if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
583 #also check for specific exports?
584 # to avoid spurious modify export events
585 @svc_acct = map { $_->svc_x }
586 grep { $_->part_svc->svcdb eq 'svc_acct' }
589 $_->snapshot foreach @svc_acct;
593 my $error = $new->export_pkg_change($old)
594 || $new->SUPER::replace( $old,
596 ? $options->{options}
600 $dbh->rollback if $oldAutoCommit;
604 #for prepaid packages,
605 #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
606 foreach my $old_svc_acct ( @svc_acct ) {
607 my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
609 $new_svc_acct->replace( $old_svc_acct,
610 'depend_jobnum' => $options->{depend_jobnum},
613 $dbh->rollback if $oldAutoCommit;
618 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
625 Checks all fields to make sure this is a valid billing item. If there is an
626 error, returns the error, otherwise returns false. Called by the insert and
634 if ( !$self->locationnum or $self->locationnum == -1 ) {
635 $self->set('locationnum', $self->cust_main->ship_locationnum);
639 $self->ut_numbern('pkgnum')
640 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
641 || $self->ut_numbern('pkgpart')
642 || $self->ut_foreign_keyn('contactnum', 'contact', 'contactnum' )
643 || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
644 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
645 || $self->ut_numbern('quantity')
646 || $self->ut_numbern('start_date')
647 || $self->ut_numbern('setup')
648 || $self->ut_numbern('bill')
649 || $self->ut_numbern('susp')
650 || $self->ut_numbern('cancel')
651 || $self->ut_numbern('adjourn')
652 || $self->ut_numbern('resume')
653 || $self->ut_numbern('expire')
654 || $self->ut_numbern('dundate')
655 || $self->ut_enum('no_auto', [ '', 'Y' ])
656 || $self->ut_enum('waive_setup', [ '', 'Y' ])
657 || $self->ut_numbern('agent_pkgid')
658 || $self->ut_enum('recur_show_zero', [ '', 'Y', 'N', ])
659 || $self->ut_enum('setup_show_zero', [ '', 'Y', 'N', ])
660 || $self->ut_foreign_keyn('main_pkgnum', 'cust_pkg', 'pkgnum')
661 || $self->ut_foreign_keyn('pkglinknum', 'part_pkg_link', 'pkglinknum')
662 || $self->ut_foreign_keyn('change_to_pkgnum', 'cust_pkg', 'pkgnum')
664 return $error if $error;
666 return "A package with both start date (future start) and setup date (already started) will never bill"
667 if $self->start_date && $self->setup && ! $upgrade;
669 return "A future unsuspend date can only be set for a package with a suspend date"
670 if $self->resume and !$self->susp and !$self->adjourn;
672 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
674 if ( $self->dbdef_table->column('manual_flag') ) {
675 $self->manual_flag('') if $self->manual_flag eq ' ';
676 $self->manual_flag =~ /^([01]?)$/
677 or return "Illegal manual_flag ". $self->manual_flag;
678 $self->manual_flag($1);
686 Check the pkgpart to make sure it's allowed with the reg_code and/or
687 promo_code of the package (if present) and with the customer's agent.
688 Called from C<insert>, unless we are doing a package change that doesn't
696 # my $error = $self->ut_numbern('pkgpart'); # already done
699 if ( $self->reg_code ) {
701 unless ( grep { $self->pkgpart == $_->pkgpart }
702 map { $_->reg_code_pkg }
703 qsearchs( 'reg_code', { 'code' => $self->reg_code,
704 'agentnum' => $self->cust_main->agentnum })
706 return "Unknown registration code";
709 } elsif ( $self->promo_code ) {
712 qsearchs('part_pkg', {
713 'pkgpart' => $self->pkgpart,
714 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
716 return 'Unknown promotional code' unless $promo_part_pkg;
720 unless ( $disable_agentcheck ) {
722 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
723 return "agent ". $agent->agentnum. ':'. $agent->agent.
724 " can't purchase pkgpart ". $self->pkgpart
725 unless $agent->pkgpart_hashref->{ $self->pkgpart }
726 || $agent->agentnum == $self->part_pkg->agentnum;
729 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
730 return $error if $error;
738 =item cancel [ OPTION => VALUE ... ]
740 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
741 in this package, then cancels the package itself (sets the cancel field to
744 Available options are:
748 =item quiet - can be set true to supress email cancellation notices.
750 =item time - can be set to cancel the package based on a specific future or
751 historical date. Using time ensures that the remaining amount is calculated
752 correctly. Note however that this is an immediate cancel and just changes
753 the date. You are PROBABLY looking to expire the account instead of using
756 =item reason - can be set to a cancellation reason (see L<FS:reason>),
757 either a reasonnum of an existing reason, or passing a hashref will create
758 a new reason. The hashref should have the following keys: typenum - Reason
759 type (see L<FS::reason_type>, reason - Text of the new reason.
761 =item date - can be set to a unix style timestamp to specify when to
764 =item nobill - can be set true to skip billing if it might otherwise be done.
766 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
767 not credit it. This must be set (by change()) when changing the package
768 to a different pkgpart or location, and probably shouldn't be in any other
769 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
774 If there is an error, returns the error, otherwise returns false.
779 my( $self, %options ) = @_;
782 # pass all suspend/cancel actions to the main package
783 if ( $self->main_pkgnum and !$options{'from_main'} ) {
784 return $self->main_pkg->cancel(%options);
787 my $conf = new FS::Conf;
789 warn "cust_pkg::cancel called with options".
790 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
793 local $SIG{HUP} = 'IGNORE';
794 local $SIG{INT} = 'IGNORE';
795 local $SIG{QUIT} = 'IGNORE';
796 local $SIG{TERM} = 'IGNORE';
797 local $SIG{TSTP} = 'IGNORE';
798 local $SIG{PIPE} = 'IGNORE';
800 my $oldAutoCommit = $FS::UID::AutoCommit;
801 local $FS::UID::AutoCommit = 0;
804 my $old = $self->select_for_update;
806 if ( $old->get('cancel') || $self->get('cancel') ) {
807 dbh->rollback if $oldAutoCommit;
808 return ""; # no error
811 # XXX possibly set cancel_time to the expire date?
812 my $cancel_time = $options{'time'} || time;
813 my $date = $options{'date'} if $options{'date'}; # expire/cancel later
814 $date = '' if ($date && $date <= $cancel_time); # complain instead?
816 #race condition: usage could be ongoing until unprovisioned
817 #resolved by performing a change package instead (which unprovisions) and
819 if ( !$options{nobill} && !$date ) {
820 # && $conf->exists('bill_usage_on_cancel') ) { #calc_cancel checks this
821 my $copy = $self->new({$self->hash});
823 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
825 'time' => $cancel_time );
826 warn "Error billing during cancel, custnum ".
827 #$self->cust_main->custnum. ": $error"
832 if ( $options{'reason'} ) {
833 $error = $self->insert_reason( 'reason' => $options{'reason'},
834 'action' => $date ? 'expire' : 'cancel',
835 'date' => $date ? $date : $cancel_time,
836 'reason_otaker' => $options{'reason_otaker'},
839 dbh->rollback if $oldAutoCommit;
840 return "Error inserting cust_pkg_reason: $error";
844 my %svc_cancel_opt = ();
845 $svc_cancel_opt{'date'} = $date if $date;
846 foreach my $cust_svc (
849 sort { $a->[1] <=> $b->[1] }
850 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; }
851 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
853 my $part_svc = $cust_svc->part_svc;
854 next if ( defined($part_svc) and $part_svc->preserve );
855 my $error = $cust_svc->cancel( %svc_cancel_opt );
858 $dbh->rollback if $oldAutoCommit;
859 return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
865 # credit remaining time if appropriate
867 if ( exists($options{'unused_credit'}) ) {
868 $do_credit = $options{'unused_credit'};
871 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
874 my $error = $self->credit_remaining('cancel', $cancel_time);
876 $dbh->rollback if $oldAutoCommit;
883 my %hash = $self->hash;
885 $hash{'expire'} = $date;
887 $hash{'cancel'} = $cancel_time;
889 $hash{'change_custnum'} = $options{'change_custnum'};
891 my $new = new FS::cust_pkg ( \%hash );
892 $error = $new->replace( $self, options => { $self->options } );
893 if ( $self->change_to_pkgnum ) {
894 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
895 $error ||= $change_to->cancel || $change_to->delete;
898 $dbh->rollback if $oldAutoCommit;
902 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
903 $error = $supp_pkg->cancel(%options, 'from_main' => 1);
905 $dbh->rollback if $oldAutoCommit;
906 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
910 foreach my $usage ( $self->cust_pkg_usage ) {
911 $error = $usage->delete;
913 $dbh->rollback if $oldAutoCommit;
914 return "deleting usage pools: $error";
918 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
919 return '' if $date; #no errors
921 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
922 if ( !$options{'quiet'} &&
923 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
925 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
928 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
929 $error = $msg_template->send( 'cust_main' => $self->cust_main,
934 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
935 'to' => \@invoicing_list,
936 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
937 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
938 'custnum' => $self->custnum,
939 'msgtype' => '', #admin?
942 #should this do something on errors?
949 =item cancel_if_expired [ NOW_TIMESTAMP ]
951 Cancels this package if its expire date has been reached.
955 sub cancel_if_expired {
957 my $time = shift || time;
958 return '' unless $self->expire && $self->expire <= $time;
959 my $error = $self->cancel;
961 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
962 $self->custnum. ": $error";
969 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
970 locationnum, (other fields?). Attempts to re-provision cancelled services
971 using history information (errors at this stage are not fatal).
973 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
975 svc_fatal: service provisioning errors are fatal
977 svc_errors: pass an array reference, will be filled in with any provisioning errors
979 main_pkgnum: link the package as a supplemental package of this one. For
985 my( $self, %options ) = @_;
987 #in case you try do do $uncancel-date = $cust_pkg->uncacel
988 return '' unless $self->get('cancel');
990 if ( $self->main_pkgnum and !$options{'main_pkgnum'} ) {
991 return $self->main_pkg->uncancel(%options);
998 local $SIG{HUP} = 'IGNORE';
999 local $SIG{INT} = 'IGNORE';
1000 local $SIG{QUIT} = 'IGNORE';
1001 local $SIG{TERM} = 'IGNORE';
1002 local $SIG{TSTP} = 'IGNORE';
1003 local $SIG{PIPE} = 'IGNORE';
1005 my $oldAutoCommit = $FS::UID::AutoCommit;
1006 local $FS::UID::AutoCommit = 0;
1010 # insert the new package
1013 my $cust_pkg = new FS::cust_pkg {
1014 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
1015 bill => ( $options{'bill'} || $self->get('bill') ),
1017 uncancel_pkgnum => $self->pkgnum,
1018 main_pkgnum => ($options{'main_pkgnum'} || ''),
1019 map { $_ => $self->get($_) } qw(
1020 custnum pkgpart locationnum
1022 susp adjourn resume expire start_date contract_end dundate
1023 change_date change_pkgpart change_locationnum
1024 manual_flag no_auto quantity agent_pkgid recur_show_zero setup_show_zero
1028 my $error = $cust_pkg->insert(
1029 'change' => 1, #supresses any referral credit to a referring customer
1030 'allow_pkgpart' => 1, # allow this even if the package def is disabled
1033 $dbh->rollback if $oldAutoCommit;
1041 #find historical services within this timeframe before the package cancel
1042 # (incompatible with "time" option to cust_pkg->cancel?)
1043 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
1044 # too little? (unprovisioing export delay?)
1045 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
1046 my @h_cust_svc = $self->h_cust_svc( $end, $start );
1049 foreach my $h_cust_svc (@h_cust_svc) {
1050 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
1051 #next unless $h_svc_x; #should this happen?
1052 (my $table = $h_svc_x->table) =~ s/^h_//;
1053 require "FS/$table.pm";
1054 my $class = "FS::$table";
1055 my $svc_x = $class->new( {
1056 'pkgnum' => $cust_pkg->pkgnum,
1057 'svcpart' => $h_cust_svc->svcpart,
1058 map { $_ => $h_svc_x->get($_) } fields($table)
1062 if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
1063 $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
1066 my $svc_error = $svc_x->insert;
1068 if ( $options{svc_fatal} ) {
1069 $dbh->rollback if $oldAutoCommit;
1072 # if we've failed to insert the svc_x object, svc_Common->insert
1073 # will have removed the cust_svc already. if not, then both records
1074 # were inserted but we failed for some other reason (export, most
1075 # likely). in that case, report the error and delete the records.
1076 push @svc_errors, $svc_error;
1077 my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1079 # except if export_insert failed, export_delete probably won't be
1081 local $FS::svc_Common::noexport_hack = 1;
1082 my $cleanup_error = $svc_x->delete; # also deletes cust_svc
1083 if ( $cleanup_error ) { # and if THAT fails, then run away
1084 $dbh->rollback if $oldAutoCommit;
1085 return $cleanup_error;
1090 } #foreach $h_cust_svc
1092 #these are pretty rare, but should handle them
1093 # - dsl_device (mac addresses)
1094 # - phone_device (mac addresses)
1095 # - dsl_note (ikano notes)
1096 # - domain_record (i.e. restore DNS information w/domains)
1097 # - inventory_item(?) (inventory w/un-cancelling service?)
1098 # - nas (svc_broaband nas stuff)
1099 #this stuff is unused in the wild afaik
1100 # - mailinglistmember
1102 # - svc_domain.parent_svcnum?
1103 # - acct_snarf (ancient mail fetching config)
1104 # - cgp_rule (communigate)
1105 # - cust_svc_option (used by our Tron stuff)
1106 # - acct_rt_transaction (used by our time worked stuff)
1109 # also move over any services that didn't unprovision at cancellation
1112 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1113 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1114 my $error = $cust_svc->replace;
1116 $dbh->rollback if $oldAutoCommit;
1122 # Uncancel any supplemental packages, and make them supplemental to the
1126 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1128 $error = $supp_pkg->uncancel(%options, 'main_pkgnum' => $cust_pkg->pkgnum);
1130 $dbh->rollback if $oldAutoCommit;
1131 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1139 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1141 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1142 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1149 Cancels any pending expiration (sets the expire field to null).
1151 If there is an error, returns the error, otherwise returns false.
1156 my( $self, %options ) = @_;
1159 local $SIG{HUP} = 'IGNORE';
1160 local $SIG{INT} = 'IGNORE';
1161 local $SIG{QUIT} = 'IGNORE';
1162 local $SIG{TERM} = 'IGNORE';
1163 local $SIG{TSTP} = 'IGNORE';
1164 local $SIG{PIPE} = 'IGNORE';
1166 my $oldAutoCommit = $FS::UID::AutoCommit;
1167 local $FS::UID::AutoCommit = 0;
1170 my $old = $self->select_for_update;
1172 my $pkgnum = $old->pkgnum;
1173 if ( $old->get('cancel') || $self->get('cancel') ) {
1174 dbh->rollback if $oldAutoCommit;
1175 return "Can't unexpire cancelled package $pkgnum";
1176 # or at least it's pointless
1179 unless ( $old->get('expire') && $self->get('expire') ) {
1180 dbh->rollback if $oldAutoCommit;
1181 return ""; # no error
1184 my %hash = $self->hash;
1185 $hash{'expire'} = '';
1186 my $new = new FS::cust_pkg ( \%hash );
1187 $error = $new->replace( $self, options => { $self->options } );
1189 $dbh->rollback if $oldAutoCommit;
1193 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1199 =item suspend [ OPTION => VALUE ... ]
1201 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1202 package, then suspends the package itself (sets the susp field to now).
1204 Available options are:
1208 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1209 either a reasonnum of an existing reason, or passing a hashref will create
1210 a new reason. The hashref should have the following keys:
1211 - typenum - Reason type (see L<FS::reason_type>
1212 - reason - Text of the new reason.
1214 =item date - can be set to a unix style timestamp to specify when to
1217 =item time - can be set to override the current time, for calculation
1218 of final invoices or unused-time credits
1220 =item resume_date - can be set to a time when the package should be
1221 unsuspended. This may be more convenient than calling C<unsuspend()>
1224 =item from_main - allows a supplemental package to be suspended, rather
1225 than redirecting the method call to its main package. For internal use.
1229 If there is an error, returns the error, otherwise returns false.
1234 my( $self, %options ) = @_;
1237 # pass all suspend/cancel actions to the main package
1238 if ( $self->main_pkgnum and !$options{'from_main'} ) {
1239 return $self->main_pkg->suspend(%options);
1242 local $SIG{HUP} = 'IGNORE';
1243 local $SIG{INT} = 'IGNORE';
1244 local $SIG{QUIT} = 'IGNORE';
1245 local $SIG{TERM} = 'IGNORE';
1246 local $SIG{TSTP} = 'IGNORE';
1247 local $SIG{PIPE} = 'IGNORE';
1249 my $oldAutoCommit = $FS::UID::AutoCommit;
1250 local $FS::UID::AutoCommit = 0;
1253 my $old = $self->select_for_update;
1255 my $pkgnum = $old->pkgnum;
1256 if ( $old->get('cancel') || $self->get('cancel') ) {
1257 dbh->rollback if $oldAutoCommit;
1258 return "Can't suspend cancelled package $pkgnum";
1261 if ( $old->get('susp') || $self->get('susp') ) {
1262 dbh->rollback if $oldAutoCommit;
1263 return ""; # no error # complain on adjourn?
1266 my $suspend_time = $options{'time'} || time;
1267 my $date = $options{date} if $options{date}; # adjourn/suspend later
1268 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1270 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1271 dbh->rollback if $oldAutoCommit;
1272 return "Package $pkgnum expires before it would be suspended.";
1275 # some false laziness with sub cancel
1276 if ( !$options{nobill} && !$date &&
1277 $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1278 # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1279 # make the entire cust_main->bill path recognize 'suspend' and
1280 # 'cancel' separately.
1281 warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1282 my $copy = $self->new({$self->hash});
1284 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1286 'time' => $suspend_time );
1287 warn "Error billing during suspend, custnum ".
1288 #$self->cust_main->custnum. ": $error"
1293 if ( $options{'reason'} ) {
1294 $error = $self->insert_reason( 'reason' => $options{'reason'},
1295 'action' => $date ? 'adjourn' : 'suspend',
1296 'date' => $date ? $date : $suspend_time,
1297 'reason_otaker' => $options{'reason_otaker'},
1300 dbh->rollback if $oldAutoCommit;
1301 return "Error inserting cust_pkg_reason: $error";
1305 my %hash = $self->hash;
1307 $hash{'adjourn'} = $date;
1309 $hash{'susp'} = $suspend_time;
1312 my $resume_date = $options{'resume_date'} || 0;
1313 if ( $resume_date > ($date || $suspend_time) ) {
1314 $hash{'resume'} = $resume_date;
1317 $options{options} ||= {};
1319 my $new = new FS::cust_pkg ( \%hash );
1320 $error = $new->replace( $self, options => { $self->options,
1321 %{ $options{options} },
1325 $dbh->rollback if $oldAutoCommit;
1330 # credit remaining time if appropriate
1331 if ( $self->part_pkg->option('unused_credit_suspend', 1) ) {
1332 my $error = $self->credit_remaining('suspend', $suspend_time);
1334 $dbh->rollback if $oldAutoCommit;
1341 foreach my $cust_svc (
1342 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1344 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1346 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1347 $dbh->rollback if $oldAutoCommit;
1348 return "Illegal svcdb value in part_svc!";
1351 require "FS/$svcdb.pm";
1353 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1355 $error = $svc->suspend;
1357 $dbh->rollback if $oldAutoCommit;
1360 my( $label, $value ) = $cust_svc->label;
1361 push @labels, "$label: $value";
1365 my $conf = new FS::Conf;
1366 if ( $conf->config('suspend_email_admin') ) {
1368 my $error = send_email(
1369 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1370 #invoice_from ??? well as good as any
1371 'to' => $conf->config('suspend_email_admin'),
1372 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1374 "This is an automatic message from your Freeside installation\n",
1375 "informing you that the following customer package has been suspended:\n",
1377 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1378 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1379 ( map { "Service : $_\n" } @labels ),
1381 'custnum' => $self->custnum,
1382 'msgtype' => 'admin'
1386 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1394 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1395 $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1397 $dbh->rollback if $oldAutoCommit;
1398 return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1402 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1407 =item credit_remaining MODE TIME
1409 Generate a credit for this package for the time remaining in the current
1410 billing period. MODE is either "suspend" or "cancel" (determines the
1411 credit type). TIME is the time of suspension/cancellation. Both arguments
1416 sub credit_remaining {
1417 # Add a credit for remaining service
1418 my ($self, $mode, $time) = @_;
1419 die 'credit_remaining requires suspend or cancel'
1420 unless $mode eq 'suspend' or $mode eq 'cancel';
1421 die 'no suspend/cancel time' unless $time > 0;
1423 my $conf = FS::Conf->new;
1424 my $reason_type = $conf->config($mode.'_credit_type');
1426 my $last_bill = $self->getfield('last_bill') || 0;
1427 my $next_bill = $self->getfield('bill') || 0;
1428 if ( $last_bill > 0 # the package has been billed
1429 and $next_bill > 0 # the package has a next bill date
1430 and $next_bill >= $time # which is in the future
1432 my $remaining_value = $self->calc_remain('time' => $time);
1433 if ( $remaining_value > 0 ) {
1434 warn "Crediting for $remaining_value on package ".$self->pkgnum."\n"
1436 my $error = $self->cust_main->credit(
1438 'Credit for unused time on '. $self->part_pkg->pkg,
1439 'reason_type' => $reason_type,
1441 return "Error crediting customer \$$remaining_value for unused time".
1442 " on ". $self->part_pkg->pkg. ": $error"
1444 } #if $remaining_value
1445 } #if $last_bill, etc.
1449 =item unsuspend [ OPTION => VALUE ... ]
1451 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1452 package, then unsuspends the package itself (clears the susp field and the
1453 adjourn field if it is in the past). If the suspend reason includes an
1454 unsuspension package, that package will be ordered.
1456 Available options are:
1462 Can be set to a date to unsuspend the package in the future (the 'resume'
1465 =item adjust_next_bill
1467 Can be set true to adjust the next bill date forward by
1468 the amount of time the account was inactive. This was set true by default
1469 in the past (from 1.4.2 and 1.5.0pre6 through 1.7.0), but now needs to be
1470 explicitly requested with this option or in the price plan.
1474 If there is an error, returns the error, otherwise returns false.
1479 my( $self, %opt ) = @_;
1482 # pass all suspend/cancel actions to the main package
1483 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1484 return $self->main_pkg->unsuspend(%opt);
1487 local $SIG{HUP} = 'IGNORE';
1488 local $SIG{INT} = 'IGNORE';
1489 local $SIG{QUIT} = 'IGNORE';
1490 local $SIG{TERM} = 'IGNORE';
1491 local $SIG{TSTP} = 'IGNORE';
1492 local $SIG{PIPE} = 'IGNORE';
1494 my $oldAutoCommit = $FS::UID::AutoCommit;
1495 local $FS::UID::AutoCommit = 0;
1498 my $old = $self->select_for_update;
1500 my $pkgnum = $old->pkgnum;
1501 if ( $old->get('cancel') || $self->get('cancel') ) {
1502 $dbh->rollback if $oldAutoCommit;
1503 return "Can't unsuspend cancelled package $pkgnum";
1506 unless ( $old->get('susp') && $self->get('susp') ) {
1507 $dbh->rollback if $oldAutoCommit;
1508 return ""; # no error # complain instead?
1511 my $date = $opt{'date'};
1512 if ( $date and $date > time ) { # return an error if $date <= time?
1514 if ( $old->get('expire') && $old->get('expire') < $date ) {
1515 $dbh->rollback if $oldAutoCommit;
1516 return "Package $pkgnum expires before it would be unsuspended.";
1519 my $new = new FS::cust_pkg { $self->hash };
1520 $new->set('resume', $date);
1521 $error = $new->replace($self, options => $self->options);
1524 $dbh->rollback if $oldAutoCommit;
1528 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1536 foreach my $cust_svc (
1537 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1539 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1541 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1542 $dbh->rollback if $oldAutoCommit;
1543 return "Illegal svcdb value in part_svc!";
1546 require "FS/$svcdb.pm";
1548 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1550 $error = $svc->unsuspend;
1552 $dbh->rollback if $oldAutoCommit;
1555 my( $label, $value ) = $cust_svc->label;
1556 push @labels, "$label: $value";
1561 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1562 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1564 my %hash = $self->hash;
1565 my $inactive = time - $hash{'susp'};
1567 my $conf = new FS::Conf;
1569 if ( $inactive > 0 &&
1570 ( $hash{'bill'} || $hash{'setup'} ) &&
1571 ( $opt{'adjust_next_bill'} ||
1572 $conf->exists('unsuspend-always_adjust_next_bill_date') ||
1573 $self->part_pkg->option('unsuspend_adjust_bill', 1) )
1576 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1581 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1582 $hash{'resume'} = '' if !$hash{'adjourn'};
1583 my $new = new FS::cust_pkg ( \%hash );
1584 $error = $new->replace( $self, options => { $self->options } );
1586 $dbh->rollback if $oldAutoCommit;
1592 if ( $reason && $reason->unsuspend_pkgpart ) {
1593 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
1594 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
1596 my $start_date = $self->cust_main->next_bill_date
1597 if $reason->unsuspend_hold;
1600 $unsusp_pkg = FS::cust_pkg->new({
1601 'custnum' => $self->custnum,
1602 'pkgpart' => $reason->unsuspend_pkgpart,
1603 'start_date' => $start_date,
1604 'locationnum' => $self->locationnum,
1605 # discount? probably not...
1608 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
1612 $dbh->rollback if $oldAutoCommit;
1617 if ( $conf->config('unsuspend_email_admin') ) {
1619 my $error = send_email(
1620 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1621 #invoice_from ??? well as good as any
1622 'to' => $conf->config('unsuspend_email_admin'),
1623 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
1624 "This is an automatic message from your Freeside installation\n",
1625 "informing you that the following customer package has been unsuspended:\n",
1627 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1628 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1629 ( map { "Service : $_\n" } @labels ),
1631 "An unsuspension fee was charged: ".
1632 $unsusp_pkg->part_pkg->pkg_comment."\n"
1636 'custnum' => $self->custnum,
1637 'msgtype' => 'admin',
1641 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
1647 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1648 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
1650 $dbh->rollback if $oldAutoCommit;
1651 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1655 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1662 Cancels any pending suspension (sets the adjourn field to null).
1664 If there is an error, returns the error, otherwise returns false.
1669 my( $self, %options ) = @_;
1672 local $SIG{HUP} = 'IGNORE';
1673 local $SIG{INT} = 'IGNORE';
1674 local $SIG{QUIT} = 'IGNORE';
1675 local $SIG{TERM} = 'IGNORE';
1676 local $SIG{TSTP} = 'IGNORE';
1677 local $SIG{PIPE} = 'IGNORE';
1679 my $oldAutoCommit = $FS::UID::AutoCommit;
1680 local $FS::UID::AutoCommit = 0;
1683 my $old = $self->select_for_update;
1685 my $pkgnum = $old->pkgnum;
1686 if ( $old->get('cancel') || $self->get('cancel') ) {
1687 dbh->rollback if $oldAutoCommit;
1688 return "Can't unadjourn cancelled package $pkgnum";
1689 # or at least it's pointless
1692 if ( $old->get('susp') || $self->get('susp') ) {
1693 dbh->rollback if $oldAutoCommit;
1694 return "Can't unadjourn suspended package $pkgnum";
1695 # perhaps this is arbitrary
1698 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1699 dbh->rollback if $oldAutoCommit;
1700 return ""; # no error
1703 my %hash = $self->hash;
1704 $hash{'adjourn'} = '';
1705 $hash{'resume'} = '';
1706 my $new = new FS::cust_pkg ( \%hash );
1707 $error = $new->replace( $self, options => { $self->options } );
1709 $dbh->rollback if $oldAutoCommit;
1713 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1720 =item change HASHREF | OPTION => VALUE ...
1722 Changes this package: cancels it and creates a new one, with a different
1723 pkgpart or locationnum or both. All services are transferred to the new
1724 package (no change will be made if this is not possible).
1726 Options may be passed as a list of key/value pairs or as a hash reference.
1733 New locationnum, to change the location for this package.
1737 New FS::cust_location object, to create a new location and assign it
1742 New FS::cust_main object, to create a new customer and assign the new package
1747 New pkgpart (see L<FS::part_pkg>).
1751 New refnum (see L<FS::part_referral>).
1755 New quantity; if unspecified, the new package will have the same quantity
1760 "New" (existing) FS::cust_pkg object. The package's services and other
1761 attributes will be transferred to this package.
1765 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1766 susp, adjourn, cancel, expire, and contract_end) to the new package.
1768 =item unprotect_svcs
1770 Normally, change() will rollback and return an error if some services
1771 can't be transferred (also see the I<cust_pkg-change_svcpart> config option).
1772 If unprotect_svcs is true, this method will transfer as many services as
1773 it can and then unconditionally cancel the old package.
1777 At least one of locationnum, cust_location, pkgpart, refnum, cust_main, or
1778 cust_pkg must be specified (otherwise, what's the point?)
1780 Returns either the new FS::cust_pkg object or a scalar error.
1784 my $err_or_new_cust_pkg = $old_cust_pkg->change
1788 #some false laziness w/order
1791 my $opt = ref($_[0]) ? shift : { @_ };
1793 my $conf = new FS::Conf;
1795 # Transactionize this whole mess
1796 local $SIG{HUP} = 'IGNORE';
1797 local $SIG{INT} = 'IGNORE';
1798 local $SIG{QUIT} = 'IGNORE';
1799 local $SIG{TERM} = 'IGNORE';
1800 local $SIG{TSTP} = 'IGNORE';
1801 local $SIG{PIPE} = 'IGNORE';
1803 my $oldAutoCommit = $FS::UID::AutoCommit;
1804 local $FS::UID::AutoCommit = 0;
1813 $hash{'setup'} = $time if $self->setup;
1815 $hash{'change_date'} = $time;
1816 $hash{"change_$_"} = $self->$_()
1817 foreach qw( pkgnum pkgpart locationnum );
1819 if ( $opt->{'cust_location'} ) {
1820 $error = $opt->{'cust_location'}->find_or_insert;
1822 $dbh->rollback if $oldAutoCommit;
1823 return "creating location record: $error";
1825 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1828 if ( $opt->{'cust_pkg'} ) {
1829 # treat changing to a package with a different pkgpart as a
1830 # pkgpart change (because it is)
1831 $opt->{'pkgpart'} = $opt->{'cust_pkg'}->pkgpart;
1834 # whether to override pkgpart checking on the new package
1835 my $same_pkgpart = 1;
1836 if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
1840 my $unused_credit = 0;
1841 my $keep_dates = $opt->{'keep_dates'};
1842 # Special case. If the pkgpart is changing, and the customer is
1843 # going to be credited for remaining time, don't keep setup, bill,
1844 # or last_bill dates, and DO pass the flag to cancel() to credit
1846 if ( $opt->{'pkgpart'}
1847 and $opt->{'pkgpart'} != $self->pkgpart
1848 and $self->part_pkg->option('unused_credit_change', 1) ) {
1851 $hash{$_} = '' foreach qw(setup bill last_bill);
1854 if ( $keep_dates ) {
1855 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1856 resume start_date contract_end ) ) {
1857 $hash{$date} = $self->getfield($date);
1860 # always keep this date, regardless of anything
1861 # (the date of the package change is in a different field)
1862 $hash{'order_date'} = $self->getfield('order_date');
1864 # allow $opt->{'locationnum'} = '' to specifically set it to null
1865 # (i.e. customer default location)
1866 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
1868 # usually this doesn't matter. the two cases where it does are:
1869 # 1. unused_credit_change + pkgpart change + setup fee on the new package
1871 # 2. (more importantly) changing a package before it's billed
1872 $hash{'waive_setup'} = $self->waive_setup;
1874 my $custnum = $self->custnum;
1875 if ( $opt->{cust_main} ) {
1876 my $cust_main = $opt->{cust_main};
1877 unless ( $cust_main->custnum ) {
1878 my $error = $cust_main->insert( @{ $opt->{cust_main_insert_args}||[] } );
1880 $dbh->rollback if $oldAutoCommit;
1881 return "inserting customer record: $error";
1884 $custnum = $cust_main->custnum;
1887 $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
1890 if ( $opt->{'cust_pkg'} ) {
1891 # The target package already exists; update it to show that it was
1892 # changed from this package.
1893 $cust_pkg = $opt->{'cust_pkg'};
1895 foreach ( qw( pkgnum pkgpart locationnum ) ) {
1896 $cust_pkg->set("change_$_", $self->get($_));
1898 $cust_pkg->set('change_date', $time);
1899 $error = $cust_pkg->replace;
1902 # Create the new package.
1903 $cust_pkg = new FS::cust_pkg {
1904 custnum => $custnum,
1905 locationnum => $opt->{'locationnum'},
1906 ( map { $_ => ( $opt->{$_} || $self->$_() ) }
1907 qw( pkgpart quantity refnum salesnum )
1911 $error = $cust_pkg->insert( 'change' => 1,
1912 'allow_pkgpart' => $same_pkgpart );
1915 $dbh->rollback if $oldAutoCommit;
1916 return "inserting new package: $error";
1919 # Transfer services and cancel old package.
1921 $error = $self->transfer($cust_pkg);
1922 if ($error and $error == 0) {
1923 # $old_pkg->transfer failed.
1924 $dbh->rollback if $oldAutoCommit;
1925 return "transferring $error";
1928 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
1929 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
1930 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
1931 if ($error and $error == 0) {
1932 # $old_pkg->transfer failed.
1933 $dbh->rollback if $oldAutoCommit;
1934 return "converting $error";
1938 # We set unprotect_svcs when executing a "future package change". It's
1939 # not a user-interactive operation, so returning an error means the
1940 # package change will just fail. Rather than have that happen, we'll
1941 # let leftover services be deleted.
1942 if ($error > 0 and !$opt->{'unprotect_svcs'}) {
1943 # Transfers were successful, but we still had services left on the old
1944 # package. We can't change the package under this circumstances, so abort.
1945 $dbh->rollback if $oldAutoCommit;
1946 return "unable to transfer all services";
1949 #reset usage if changing pkgpart
1950 # AND usage rollover is off (otherwise adds twice, now and at package bill)
1951 if ($self->pkgpart != $cust_pkg->pkgpart) {
1952 my $part_pkg = $cust_pkg->part_pkg;
1953 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
1957 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
1960 $dbh->rollback if $oldAutoCommit;
1961 return "setting usage values: $error";
1964 # if NOT changing pkgpart, transfer any usage pools over
1965 foreach my $usage ($self->cust_pkg_usage) {
1966 $usage->set('pkgnum', $cust_pkg->pkgnum);
1967 $error = $usage->replace;
1969 $dbh->rollback if $oldAutoCommit;
1970 return "transferring usage pools: $error";
1975 # transfer discounts, if we're not changing pkgpart
1976 if ( $same_pkgpart ) {
1977 foreach my $old_discount ($self->cust_pkg_discount_active) {
1978 # don't remove the old discount, we may still need to bill that package.
1979 my $new_discount = new FS::cust_pkg_discount {
1980 'pkgnum' => $cust_pkg->pkgnum,
1981 'discountnum' => $old_discount->discountnum,
1982 'months_used' => $old_discount->months_used,
1984 $error = $new_discount->insert;
1986 $dbh->rollback if $oldAutoCommit;
1987 return "transferring discounts: $error";
1992 # transfer (copy) invoice details
1993 foreach my $detail ($self->cust_pkg_detail) {
1994 my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
1995 $new_detail->set('pkgdetailnum', '');
1996 $new_detail->set('pkgnum', $cust_pkg->pkgnum);
1997 $error = $new_detail->insert;
1999 $dbh->rollback if $oldAutoCommit;
2000 return "transferring package notes: $error";
2006 if ( !$opt->{'cust_pkg'} ) {
2007 # Order any supplemental packages.
2008 my $part_pkg = $cust_pkg->part_pkg;
2009 my @old_supp_pkgs = $self->supplemental_pkgs;
2010 foreach my $link ($part_pkg->supp_part_pkg_link) {
2012 foreach (@old_supp_pkgs) {
2013 if ($_->pkgpart == $link->dst_pkgpart) {
2015 $_->pkgpart(0); # so that it can't match more than once
2019 # false laziness with FS::cust_main::Packages::order_pkg
2020 my $new = FS::cust_pkg->new({
2021 pkgpart => $link->dst_pkgpart,
2022 pkglinknum => $link->pkglinknum,
2023 custnum => $custnum,
2024 main_pkgnum => $cust_pkg->pkgnum,
2025 locationnum => $cust_pkg->locationnum,
2026 start_date => $cust_pkg->start_date,
2027 order_date => $cust_pkg->order_date,
2028 expire => $cust_pkg->expire,
2029 adjourn => $cust_pkg->adjourn,
2030 contract_end => $cust_pkg->contract_end,
2031 refnum => $cust_pkg->refnum,
2032 discountnum => $cust_pkg->discountnum,
2033 waive_setup => $cust_pkg->waive_setup,
2035 if ( $old and $opt->{'keep_dates'} ) {
2036 foreach (qw(setup bill last_bill)) {
2037 $new->set($_, $old->get($_));
2040 $error = $new->insert( allow_pkgpart => $same_pkgpart );
2043 $error ||= $old->transfer($new);
2045 if ( $error and $error > 0 ) {
2046 # no reason why this should ever fail, but still...
2047 $error = "Unable to transfer all services from supplemental package ".
2051 $dbh->rollback if $oldAutoCommit;
2054 push @new_supp_pkgs, $new;
2056 } # if !$opt->{'cust_pkg'}
2057 # because if there is one, then supplemental packages would already
2058 # have been created for it.
2060 #Good to go, cancel old package. Notify 'cancel' of whether to credit
2062 #Don't allow billing the package (preceding period packages and/or
2063 #outstanding usage) if we are keeping dates (i.e. location changing),
2064 #because the new package will be billed for the same date range.
2065 #Supplemental packages are also canceled here.
2067 # during scheduled changes, avoid canceling the package we just
2069 $self->set('change_to_pkgnum' => '');
2071 $error = $self->cancel(
2073 unused_credit => $unused_credit,
2074 nobill => $keep_dates,
2075 change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2078 $dbh->rollback if $oldAutoCommit;
2079 return "canceling old package: $error";
2082 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2084 my $error = $cust_pkg->cust_main->bill(
2085 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2088 $dbh->rollback if $oldAutoCommit;
2089 return "billing new package: $error";
2093 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2099 =item change_later OPTION => VALUE...
2101 Schedule a package change for a later date. This actually orders the new
2102 package immediately, but sets its start date for a future date, and sets
2103 the current package to expire on the same date.
2105 If the package is already scheduled for a change, this can be called with
2106 'start_date' to change the scheduled date, or with pkgpart and/or
2107 locationnum to modify the package change. To cancel the scheduled change
2108 entirely, see C<abort_change>.
2116 The date for the package change. Required, and must be in the future.
2124 The pkgpart. locationnum, and quantity of the new package, with the same
2125 meaning as in C<change>.
2133 my $opt = ref($_[0]) ? shift : { @_ };
2135 my $oldAutoCommit = $FS::UID::AutoCommit;
2136 local $FS::UID::AutoCommit = 0;
2139 my $cust_main = $self->cust_main;
2141 my $date = delete $opt->{'start_date'} or return 'start_date required';
2143 if ( $date <= time ) {
2144 $dbh->rollback if $oldAutoCommit;
2145 return "start_date $date is in the past";
2150 if ( $self->change_to_pkgnum ) {
2151 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
2152 my $new_pkgpart = $opt->{'pkgpart'}
2153 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $change_to->pkgpart;
2154 my $new_locationnum = $opt->{'locationnum'}
2155 if $opt->{'locationnum'} and $opt->{'locationnum'} != $change_to->locationnum;
2156 my $new_quantity = $opt->{'quantity'}
2157 if $opt->{'quantity'} and $opt->{'quantity'} != $change_to->quantity;
2158 if ( $new_pkgpart or $new_locationnum or $new_quantity ) {
2159 # it hasn't been billed yet, so in principle we could just edit
2160 # it in place (w/o a package change), but that's bad form.
2161 # So change the package according to the new options...
2162 my $err_or_pkg = $change_to->change(%$opt);
2163 if ( ref $err_or_pkg ) {
2164 # Then set that package up for a future start.
2165 $self->set('change_to_pkgnum', $err_or_pkg->pkgnum);
2166 $self->set('expire', $date); # in case it's different
2167 $err_or_pkg->set('start_date', $date);
2168 $err_or_pkg->set('change_date', '');
2169 $err_or_pkg->set('change_pkgnum', '');
2171 $error = $self->replace ||
2172 $err_or_pkg->replace ||
2173 $change_to->cancel ||
2176 $error = $err_or_pkg;
2178 } else { # change the start date only.
2179 $self->set('expire', $date);
2180 $change_to->set('start_date', $date);
2181 $error = $self->replace || $change_to->replace;
2184 $dbh->rollback if $oldAutoCommit;
2187 $dbh->commit if $oldAutoCommit;
2190 } # if $self->change_to_pkgnum
2192 my $new_pkgpart = $opt->{'pkgpart'}
2193 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2194 my $new_locationnum = $opt->{'locationnum'}
2195 if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2196 my $new_quantity = $opt->{'quantity'}
2197 if $opt->{'quantity'} and $opt->{'quantity'} != $self->quantity;
2199 return '' unless $new_pkgpart or $new_locationnum or $new_quantity; # wouldn't do anything
2201 # allow $opt->{'locationnum'} = '' to specifically set it to null
2202 # (i.e. customer default location)
2203 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2205 my $new = FS::cust_pkg->new( {
2206 custnum => $self->custnum,
2207 locationnum => $opt->{'locationnum'},
2208 start_date => $date,
2209 map { $_ => ( $opt->{$_} || $self->$_() ) }
2210 qw( pkgpart quantity refnum salesnum )
2212 $error = $new->insert('change' => 1,
2213 'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2215 $self->set('change_to_pkgnum', $new->pkgnum);
2216 $self->set('expire', $date);
2217 $error = $self->replace;
2220 $dbh->rollback if $oldAutoCommit;
2222 $dbh->commit if $oldAutoCommit;
2230 Cancels a future package change scheduled by C<change_later>.
2236 my $pkgnum = $self->change_to_pkgnum;
2237 my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
2240 $error = $change_to->cancel || $change_to->delete;
2241 return $error if $error;
2243 $self->set('change_to_pkgnum', '');
2244 $self->set('expire', '');
2248 =item set_quantity QUANTITY
2250 Change the package's quantity field. This is one of the few package properties
2251 that can safely be changed without canceling and reordering the package
2252 (because it doesn't affect tax eligibility). Returns an error or an
2259 $self = $self->replace_old; # just to make sure
2260 $self->quantity(shift);
2264 =item set_salesnum SALESNUM
2266 Change the package's salesnum (sales person) field. This is one of the few
2267 package properties that can safely be changed without canceling and reordering
2268 the package (because it doesn't affect tax eligibility). Returns an error or
2275 $self = $self->replace_old; # just to make sure
2276 $self->salesnum(shift);
2278 # XXX this should probably reassign any credit that's already been given
2281 =item modify_charge OPTIONS
2283 Change the properties of a one-time charge. The following properties can
2284 be changed this way:
2285 - pkg: the package description
2286 - classnum: the package class
2287 - additional: arrayref of additional invoice details to add to this package
2289 and, I<if the charge has not yet been billed>:
2290 - start_date: the date when it will be billed
2291 - amount: the setup fee to be charged
2292 - quantity: the multiplier for the setup fee
2294 If you pass 'adjust_commission' => 1, and the classnum changes, and there are
2295 commission credits linked to this charge, they will be recalculated.
2302 my $part_pkg = $self->part_pkg;
2303 my $pkgnum = $self->pkgnum;
2306 my $oldAutoCommit = $FS::UID::AutoCommit;
2307 local $FS::UID::AutoCommit = 0;
2309 return "Can't use modify_charge except on one-time charges"
2310 unless $part_pkg->freq eq '0';
2312 if ( length($opt{'pkg'}) and $part_pkg->pkg ne $opt{'pkg'} ) {
2313 $part_pkg->set('pkg', $opt{'pkg'});
2316 my %pkg_opt = $part_pkg->options;
2317 if ( ref($opt{'additional'}) ) {
2318 delete $pkg_opt{$_} foreach grep /^additional/, keys %pkg_opt;
2320 for ( $i = 0; exists($opt{'additional'}->[$i]); $i++ ) {
2321 $pkg_opt{ "additional_info$i" } = $opt{'additional'}->[$i];
2323 $pkg_opt{'additional_count'} = $i if $i > 0;
2327 if ( exists($opt{'classnum'}) and $part_pkg->classnum ne $opt{'classnum'} )
2330 $old_classnum = $part_pkg->classnum;
2331 $part_pkg->set('classnum', $opt{'classnum'});
2334 if ( !$self->get('setup') ) {
2335 # not yet billed, so allow amount and quantity
2336 if ( exists($opt{'quantity'})
2337 and $opt{'quantity'} != $self->quantity
2338 and $opt{'quantity'} > 0 ) {
2340 $self->set('quantity', $opt{'quantity'});
2342 if ( exists($opt{'start_date'})
2343 and $opt{'start_date'} != $self->start_date ) {
2345 $self->set('start_date', $opt{'start_date'});
2347 if ($self->modified) { # for quantity or start_date change
2348 my $error = $self->replace;
2349 return $error if $error;
2352 if ( exists($opt{'amount'})
2353 and $part_pkg->option('setup_fee') != $opt{'amount'}
2354 and $opt{'amount'} > 0 ) {
2356 $pkg_opt{'setup_fee'} = $opt{'amount'};
2357 # standard for one-time charges is to set comment = (formatted) amount
2358 # update it to avoid confusion
2359 my $conf = FS::Conf->new;
2360 $part_pkg->set('comment',
2361 ($conf->config('money_char') || '$') .
2362 sprintf('%.2f', $opt{'amount'})
2365 } # else simply ignore them; the UI shouldn't allow editing the fields
2367 my $error = $part_pkg->replace( options => \%pkg_opt );
2369 $dbh->rollback if $oldAutoCommit;
2373 if (defined $old_classnum) {
2374 # fix invoice grouping records
2375 my $old_catname = $old_classnum
2376 ? FS::pkg_class->by_key($old_classnum)->categoryname
2378 my $new_catname = $opt{'classnum'}
2379 ? $part_pkg->pkg_class->categoryname
2381 if ( $old_catname ne $new_catname ) {
2382 foreach my $cust_bill_pkg ($self->cust_bill_pkg) {
2383 # (there should only be one...)
2384 my @display = qsearch( 'cust_bill_pkg_display', {
2385 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2386 'section' => $old_catname,
2388 foreach (@display) {
2389 $_->set('section', $new_catname);
2390 $error = $_->replace;
2392 $dbh->rollback if $oldAutoCommit;
2396 } # foreach $cust_bill_pkg
2399 if ( $opt{'adjust_commission'} ) {
2400 # fix commission credits...tricky.
2401 foreach my $cust_event ($self->cust_event) {
2402 my $part_event = $cust_event->part_event;
2403 foreach my $table (qw(sales agent)) {
2405 "FS::part_event::Action::Mixin::credit_${table}_pkg_class";
2406 my $credit = qsearchs('cust_credit', {
2407 'eventnum' => $cust_event->eventnum,
2409 if ( $part_event->isa($class) ) {
2410 # Yes, this results in current commission rates being applied
2411 # retroactively to a one-time charge. For accounting purposes
2412 # there ought to be some kind of time limit on doing this.
2413 my $amount = $part_event->_calc_credit($self);
2414 if ( $credit and $credit->amount ne $amount ) {
2415 # Void the old credit.
2416 $error = $credit->void('Package class changed');
2418 $dbh->rollback if $oldAutoCommit;
2419 return "$error (adjusting commission credit)";
2422 # redo the event action to recreate the credit.
2424 eval { $part_event->do_action( $self, $cust_event ) };
2426 $dbh->rollback if $oldAutoCommit;
2429 } # if $part_event->isa($class)
2431 } # foreach $cust_event
2432 } # if $opt{'adjust_commission'}
2433 } # if defined $old_classnum
2435 $dbh->commit if $oldAutoCommit;
2441 use Storable 'thaw';
2444 sub process_bulk_cust_pkg {
2446 my $param = thaw(decode_base64(shift));
2447 warn Dumper($param) if $DEBUG;
2449 my $old_part_pkg = qsearchs('part_pkg',
2450 { pkgpart => $param->{'old_pkgpart'} });
2451 my $new_part_pkg = qsearchs('part_pkg',
2452 { pkgpart => $param->{'new_pkgpart'} });
2453 die "Must select a new package type\n" unless $new_part_pkg;
2454 #my $keep_dates = $param->{'keep_dates'} || 0;
2455 my $keep_dates = 1; # there is no good reason to turn this off
2457 local $SIG{HUP} = 'IGNORE';
2458 local $SIG{INT} = 'IGNORE';
2459 local $SIG{QUIT} = 'IGNORE';
2460 local $SIG{TERM} = 'IGNORE';
2461 local $SIG{TSTP} = 'IGNORE';
2462 local $SIG{PIPE} = 'IGNORE';
2464 my $oldAutoCommit = $FS::UID::AutoCommit;
2465 local $FS::UID::AutoCommit = 0;
2468 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
2471 foreach my $old_cust_pkg ( @cust_pkgs ) {
2473 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
2474 if ( $old_cust_pkg->getfield('cancel') ) {
2475 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
2476 $old_cust_pkg->pkgnum."\n"
2480 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
2482 my $error = $old_cust_pkg->change(
2483 'pkgpart' => $param->{'new_pkgpart'},
2484 'keep_dates' => $keep_dates
2486 if ( !ref($error) ) { # change returns the cust_pkg on success
2488 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
2491 $dbh->commit if $oldAutoCommit;
2497 Returns the last bill date, or if there is no last bill date, the setup date.
2498 Useful for billing metered services.
2504 return $self->setfield('last_bill', $_[0]) if @_;
2505 return $self->getfield('last_bill') if $self->getfield('last_bill');
2506 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
2507 'edate' => $self->bill, } );
2508 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
2511 =item last_cust_pkg_reason ACTION
2513 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
2514 Returns false if there is no reason or the package is not currenly ACTION'd
2515 ACTION is one of adjourn, susp, cancel, or expire.
2519 sub last_cust_pkg_reason {
2520 my ( $self, $action ) = ( shift, shift );
2521 my $date = $self->get($action);
2523 'table' => 'cust_pkg_reason',
2524 'hashref' => { 'pkgnum' => $self->pkgnum,
2525 'action' => substr(uc($action), 0, 1),
2528 'order_by' => 'ORDER BY num DESC LIMIT 1',
2532 =item last_reason ACTION
2534 Returns the most recent ACTION FS::reason associated with the package.
2535 Returns false if there is no reason or the package is not currenly ACTION'd
2536 ACTION is one of adjourn, susp, cancel, or expire.
2541 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
2542 $cust_pkg_reason->reason
2543 if $cust_pkg_reason;
2548 Returns the definition for this billing item, as an FS::part_pkg object (see
2555 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
2556 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
2557 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
2562 Returns the cancelled package this package was changed from, if any.
2568 return '' unless $self->change_pkgnum;
2569 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
2572 =item change_cust_main
2574 Returns the customter this package was detached to, if any.
2578 sub change_cust_main {
2580 return '' unless $self->change_custnum;
2581 qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
2586 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
2593 $self->part_pkg->calc_setup($self, @_);
2598 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
2605 $self->part_pkg->calc_recur($self, @_);
2610 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
2617 $self->part_pkg->base_recur($self, @_);
2622 Calls the I<calc_remain> of the FS::part_pkg object associated with this
2629 $self->part_pkg->calc_remain($self, @_);
2634 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
2641 $self->part_pkg->calc_cancel($self, @_);
2646 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
2652 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
2655 =item cust_pkg_detail [ DETAILTYPE ]
2657 Returns any customer package details for this package (see
2658 L<FS::cust_pkg_detail>).
2660 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2664 sub cust_pkg_detail {
2666 my %hash = ( 'pkgnum' => $self->pkgnum );
2667 $hash{detailtype} = shift if @_;
2669 'table' => 'cust_pkg_detail',
2670 'hashref' => \%hash,
2671 'order_by' => 'ORDER BY weight, pkgdetailnum',
2675 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
2677 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
2679 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2681 If there is an error, returns the error, otherwise returns false.
2685 sub set_cust_pkg_detail {
2686 my( $self, $detailtype, @details ) = @_;
2688 local $SIG{HUP} = 'IGNORE';
2689 local $SIG{INT} = 'IGNORE';
2690 local $SIG{QUIT} = 'IGNORE';
2691 local $SIG{TERM} = 'IGNORE';
2692 local $SIG{TSTP} = 'IGNORE';
2693 local $SIG{PIPE} = 'IGNORE';
2695 my $oldAutoCommit = $FS::UID::AutoCommit;
2696 local $FS::UID::AutoCommit = 0;
2699 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
2700 my $error = $current->delete;
2702 $dbh->rollback if $oldAutoCommit;
2703 return "error removing old detail: $error";
2707 foreach my $detail ( @details ) {
2708 my $cust_pkg_detail = new FS::cust_pkg_detail {
2709 'pkgnum' => $self->pkgnum,
2710 'detailtype' => $detailtype,
2711 'detail' => $detail,
2713 my $error = $cust_pkg_detail->insert;
2715 $dbh->rollback if $oldAutoCommit;
2716 return "error adding new detail: $error";
2721 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2728 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
2732 #false laziness w/cust_bill.pm
2736 'table' => 'cust_event',
2737 'addl_from' => 'JOIN part_event USING ( eventpart )',
2738 'hashref' => { 'tablenum' => $self->pkgnum },
2739 'extra_sql' => " AND eventtable = 'cust_pkg' ",
2743 =item num_cust_event
2745 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
2749 #false laziness w/cust_bill.pm
2750 sub num_cust_event {
2753 "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
2754 " WHERE tablenum = ? AND eventtable = 'cust_pkg'";
2755 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
2756 $sth->execute($self->pkgnum) or die $sth->errstr. " executing $sql";
2757 $sth->fetchrow_arrayref->[0];
2760 =item cust_svc [ SVCPART ] (old, deprecated usage)
2762 =item cust_svc [ OPTION => VALUE ... ] (current usage)
2764 =item cust_svc_unsorted [ OPTION => VALUE ... ]
2766 Returns the services for this package, as FS::cust_svc objects (see
2767 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
2768 spcififed, returns only the matching services.
2770 As an optimization, use the cust_svc_unsorted version if you are not displaying
2777 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
2778 $self->_sort_cust_svc( $self->cust_svc_unsorted_arrayref(@_) );
2781 sub cust_svc_unsorted {
2783 @{ $self->cust_svc_unsorted_arrayref(@_) };
2786 sub cust_svc_unsorted_arrayref {
2789 return () unless $self->num_cust_svc(@_);
2792 if ( @_ && $_[0] =~ /^\d+/ ) {
2793 $opt{svcpart} = shift;
2794 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2801 'table' => 'cust_svc',
2802 'hashref' => { 'pkgnum' => $self->pkgnum },
2804 if ( $opt{svcpart} ) {
2805 $search{hashref}->{svcpart} = $opt{'svcpart'};
2807 if ( $opt{'svcdb'} ) {
2808 $search{addl_from} = ' LEFT JOIN part_svc USING ( svcpart ) ';
2809 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{'svcdb'} );
2812 [ qsearch(\%search) ];
2816 =item overlimit [ SVCPART ]
2818 Returns the services for this package which have exceeded their
2819 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
2820 is specified, return only the matching services.
2826 return () unless $self->num_cust_svc(@_);
2827 grep { $_->overlimit } $self->cust_svc(@_);
2830 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2832 Returns historical services for this package created before END TIMESTAMP and
2833 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
2834 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
2835 I<pkg_svc.hidden> flag will be omitted.
2841 warn "$me _h_cust_svc called on $self\n"
2844 my ($end, $start, $mode) = @_;
2845 my @cust_svc = $self->_sort_cust_svc(
2846 [ qsearch( 'h_cust_svc',
2847 { 'pkgnum' => $self->pkgnum, },
2848 FS::h_cust_svc->sql_h_search(@_),
2851 if ( defined($mode) && $mode eq 'I' ) {
2852 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
2853 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
2859 sub _sort_cust_svc {
2860 my( $self, $arrayref ) = @_;
2863 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
2865 my %pkg_svc = map { $_->svcpart => $_ }
2866 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
2871 my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
2873 $pkg_svc ? $pkg_svc->primary_svc : '',
2874 $pkg_svc ? $pkg_svc->quantity : 0,
2881 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
2883 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
2885 Returns the number of services for this package. Available options are svcpart
2886 and svcdb. If either is spcififed, returns only the matching services.
2893 return $self->{'_num_cust_svc'}
2895 && exists($self->{'_num_cust_svc'})
2896 && $self->{'_num_cust_svc'} =~ /\d/;
2898 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
2902 if ( @_ && $_[0] =~ /^\d+/ ) {
2903 $opt{svcpart} = shift;
2904 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2910 my $select = 'SELECT COUNT(*) FROM cust_svc ';
2911 my $where = ' WHERE pkgnum = ? ';
2912 my @param = ($self->pkgnum);
2914 if ( $opt{'svcpart'} ) {
2915 $where .= ' AND svcpart = ? ';
2916 push @param, $opt{'svcpart'};
2918 if ( $opt{'svcdb'} ) {
2919 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
2920 $where .= ' AND svcdb = ? ';
2921 push @param, $opt{'svcdb'};
2924 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
2925 $sth->execute(@param) or die $sth->errstr;
2926 $sth->fetchrow_arrayref->[0];
2929 =item available_part_svc
2931 Returns a list of FS::part_svc objects representing services included in this
2932 package but not yet provisioned. Each FS::part_svc object also has an extra
2933 field, I<num_avail>, which specifies the number of available services.
2937 sub available_part_svc {
2940 my $pkg_quantity = $self->quantity || 1;
2942 grep { $_->num_avail > 0 }
2944 my $part_svc = $_->part_svc;
2945 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
2946 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
2948 # more evil encapsulation breakage
2949 if($part_svc->{'Hash'}{'num_avail'} > 0) {
2950 my @exports = $part_svc->part_export_did;
2951 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
2956 $self->part_pkg->pkg_svc;
2959 =item part_svc [ OPTION => VALUE ... ]
2961 Returns a list of FS::part_svc objects representing provisioned and available
2962 services included in this package. Each FS::part_svc object also has the
2963 following extra fields:
2967 =item num_cust_svc (count)
2969 =item num_avail (quantity - count)
2971 =item cust_pkg_svc (services) - array reference containing the provisioned services, as cust_svc objects
2975 Accepts one option: summarize_size. If specified and non-zero, will omit the
2976 extra cust_pkg_svc option for objects where num_cust_svc is this size or
2982 #label -> ($cust_svc->label)[1]
2988 my $pkg_quantity = $self->quantity || 1;
2990 #XXX some sort of sort order besides numeric by svcpart...
2991 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
2993 my $part_svc = $pkg_svc->part_svc;
2994 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
2995 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
2996 $part_svc->{'Hash'}{'num_avail'} =
2997 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
2998 $part_svc->{'Hash'}{'cust_pkg_svc'} =
2999 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
3000 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
3001 && $num_cust_svc >= $opt{summarize_size};
3002 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
3004 } $self->part_pkg->pkg_svc;
3007 push @part_svc, map {
3009 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3010 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
3011 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
3012 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3013 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
3015 } $self->extra_part_svc;
3021 =item extra_part_svc
3023 Returns a list of FS::part_svc objects corresponding to services in this
3024 package which are still provisioned but not (any longer) available in the
3029 sub extra_part_svc {
3032 my $pkgnum = $self->pkgnum;
3033 #my $pkgpart = $self->pkgpart;
3036 # 'table' => 'part_svc',
3039 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
3040 # WHERE pkg_svc.svcpart = part_svc.svcpart
3041 # AND pkg_svc.pkgpart = ?
3044 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
3045 # LEFT JOIN cust_pkg USING ( pkgnum )
3046 # WHERE cust_svc.svcpart = part_svc.svcpart
3049 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
3052 #seems to benchmark slightly faster... (or did?)
3054 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
3055 my $pkgparts = join(',', @pkgparts);
3058 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
3059 #MySQL doesn't grok DISINCT ON
3060 'select' => 'DISTINCT part_svc.*',
3061 'table' => 'part_svc',
3063 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
3064 AND pkg_svc.pkgpart IN ($pkgparts)
3067 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
3068 LEFT JOIN cust_pkg USING ( pkgnum )
3071 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
3072 'extra_param' => [ [$self->pkgnum=>'int'] ],
3078 Returns a short status string for this package, currently:
3082 =item not yet billed
3084 =item one-time charge
3099 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
3101 return 'cancelled' if $self->get('cancel');
3102 return 'suspended' if $self->susp;
3103 return 'not yet billed' unless $self->setup;
3104 return 'one-time charge' if $freq =~ /^(0|$)/;
3108 =item ucfirst_status
3110 Returns the status with the first character capitalized.
3114 sub ucfirst_status {
3115 ucfirst(shift->status);
3120 Class method that returns the list of possible status strings for packages
3121 (see L<the status method|/status>). For example:
3123 @statuses = FS::cust_pkg->statuses();
3127 tie my %statuscolor, 'Tie::IxHash',
3128 'not yet billed' => '009999', #teal? cyan?
3129 'one-time charge' => '000000',
3130 'active' => '00CC00',
3131 'suspended' => 'FF9900',
3132 'cancelled' => 'FF0000',
3136 my $self = shift; #could be class...
3137 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
3138 # # mayble split btw one-time vs. recur
3144 Returns a hex triplet color string for this package's status.
3150 $statuscolor{$self->status};
3155 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
3156 "pkg - comment" depending on user preference).
3162 my $label = $self->part_pkg->pkg_comment( 'nopkgpart' => 1 );
3163 $label = $self->pkgnum. ": $label"
3164 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
3168 =item pkg_label_long
3170 Returns a long label for this package, adding the primary service's label to
3175 sub pkg_label_long {
3177 my $label = $self->pkg_label;
3178 my $cust_svc = $self->primary_cust_svc;
3179 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
3185 Returns a customer-localized label for this package.
3191 $self->part_pkg->pkg_locale( $self->cust_main->locale );
3194 =item primary_cust_svc
3196 Returns a primary service (as FS::cust_svc object) if one can be identified.
3200 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
3202 sub primary_cust_svc {
3205 my @cust_svc = $self->cust_svc;
3207 return '' unless @cust_svc; #no serivces - irrelevant then
3209 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
3211 # primary service as specified in the package definition
3212 # or exactly one service definition with quantity one
3213 my $svcpart = $self->part_pkg->svcpart;
3214 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
3215 return $cust_svc[0] if scalar(@cust_svc) == 1;
3217 #couldn't identify one thing..
3223 Returns a list of lists, calling the label method for all services
3224 (see L<FS::cust_svc>) of this billing item.
3230 map { [ $_->label ] } $self->cust_svc;
3233 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3235 Like the labels method, but returns historical information on services that
3236 were active as of END_TIMESTAMP and (optionally) not cancelled before
3237 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
3238 I<pkg_svc.hidden> flag will be omitted.
3240 Returns a list of lists, calling the label method for all (historical) services
3241 (see L<FS::h_cust_svc>) of this billing item.
3247 warn "$me _h_labels called on $self\n"
3249 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
3254 Like labels, except returns a simple flat list, and shortens long
3255 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3256 identical services to one line that lists the service label and the number of
3257 individual services rather than individual items.
3262 shift->_labels_short( 'labels', @_ );
3265 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
3267 Like h_labels, except returns a simple flat list, and shortens long
3268 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3269 identical services to one line that lists the service label and the number of
3270 individual services rather than individual items.
3274 sub h_labels_short {
3275 shift->_labels_short( 'h_labels', @_ );
3279 my( $self, $method ) = ( shift, shift );
3281 warn "$me _labels_short called on $self with $method method\n"
3284 my $conf = new FS::Conf;
3285 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
3287 warn "$me _labels_short populating \%labels\n"
3291 #tie %labels, 'Tie::IxHash';
3292 push @{ $labels{$_->[0]} }, $_->[1]
3293 foreach $self->$method(@_);
3295 warn "$me _labels_short populating \@labels\n"
3299 foreach my $label ( keys %labels ) {
3301 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
3302 my $num = scalar(@values);
3303 warn "$me _labels_short $num items for $label\n"
3306 if ( $num > $max_same_services ) {
3307 warn "$me _labels_short more than $max_same_services, so summarizing\n"
3309 push @labels, "$label ($num)";
3311 if ( $conf->exists('cust_bill-consolidate_services') ) {
3312 warn "$me _labels_short consolidating services\n"
3314 # push @labels, "$label: ". join(', ', @values);
3316 my $detail = "$label: ";
3317 $detail .= shift(@values). ', '
3319 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
3321 push @labels, $detail;
3323 warn "$me _labels_short done consolidating services\n"
3326 warn "$me _labels_short adding service data\n"
3328 push @labels, map { "$label: $_" } @values;
3339 Returns the parent customer object (see L<FS::cust_main>).
3345 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
3350 Returns the balance for this specific package, when using
3351 experimental package balance.
3357 $self->cust_main->balance_pkgnum( $self->pkgnum );
3360 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
3364 Returns the location object, if any (see L<FS::cust_location>).
3366 =item cust_location_or_main
3368 If this package is associated with a location, returns the locaiton (see
3369 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
3371 =item location_label [ OPTION => VALUE ... ]
3373 Returns the label of the location object (see L<FS::cust_location>).
3377 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
3379 =item tax_locationnum
3381 Returns the foreign key to a L<FS::cust_location> object for calculating
3382 tax on this package, as determined by the C<tax-pkg_address> and
3383 C<tax-ship_address> configuration flags.
3387 sub tax_locationnum {
3389 my $conf = FS::Conf->new;
3390 if ( $conf->exists('tax-pkg_address') ) {
3391 return $self->locationnum;
3393 elsif ( $conf->exists('tax-ship_address') ) {
3394 return $self->cust_main->ship_locationnum;
3397 return $self->cust_main->bill_locationnum;
3403 Returns the L<FS::cust_location> object for tax_locationnum.
3409 FS::cust_location->by_key( $self->tax_locationnum )
3412 =item seconds_since TIMESTAMP
3414 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
3415 package have been online since TIMESTAMP, according to the session monitor.
3417 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
3418 L<Time::Local> and L<Date::Parse> for conversion functions.
3423 my($self, $since) = @_;
3426 foreach my $cust_svc (
3427 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
3429 $seconds += $cust_svc->seconds_since($since);
3436 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
3438 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
3439 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
3442 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3443 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3449 sub seconds_since_sqlradacct {
3450 my($self, $start, $end) = @_;
3454 foreach my $cust_svc (
3456 my $part_svc = $_->part_svc;
3457 $part_svc->svcdb eq 'svc_acct'
3458 && scalar($part_svc->part_export_usage);
3461 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
3468 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
3470 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
3471 in this package for sessions ending between TIMESTAMP_START (inclusive) and
3475 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3476 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3481 sub attribute_since_sqlradacct {
3482 my($self, $start, $end, $attrib) = @_;
3486 foreach my $cust_svc (
3488 my $part_svc = $_->part_svc;
3489 scalar($part_svc->part_export_usage);
3492 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
3504 my( $self, $value ) = @_;
3505 if ( defined($value) ) {
3506 $self->setfield('quantity', $value);
3508 $self->getfield('quantity') || 1;
3511 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
3513 Transfers as many services as possible from this package to another package.
3515 The destination package can be specified by pkgnum by passing an FS::cust_pkg
3516 object. The destination package must already exist.
3518 Services are moved only if the destination allows services with the correct
3519 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
3520 this option with caution! No provision is made for export differences
3521 between the old and new service definitions. Probably only should be used
3522 when your exports for all service definitions of a given svcdb are identical.
3523 (attempt a transfer without it first, to move all possible svcpart-matching
3526 Any services that can't be moved remain in the original package.
3528 Returns an error, if there is one; otherwise, returns the number of services
3529 that couldn't be moved.
3534 my ($self, $dest_pkgnum, %opt) = @_;
3540 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
3541 $dest = $dest_pkgnum;
3542 $dest_pkgnum = $dest->pkgnum;
3544 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
3547 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
3549 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
3550 $target{$pkg_svc->svcpart} = $pkg_svc->quantity;
3553 foreach my $cust_svc ($dest->cust_svc) {
3554 $target{$cust_svc->svcpart}--;
3557 my %svcpart2svcparts = ();
3558 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3559 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
3560 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
3561 next if exists $svcpart2svcparts{$svcpart};
3562 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
3563 $svcpart2svcparts{$svcpart} = [
3565 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
3567 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
3568 'svcpart' => $_ } );
3570 $pkg_svc ? $pkg_svc->primary_svc : '',
3571 $pkg_svc ? $pkg_svc->quantity : 0,
3575 grep { $_ != $svcpart }
3577 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
3579 warn "alternates for svcpart $svcpart: ".
3580 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
3586 foreach my $cust_svc ($self->cust_svc) {
3587 my $svcnum = $cust_svc->svcnum;
3588 if($target{$cust_svc->svcpart} > 0
3589 or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
3590 $target{$cust_svc->svcpart}--;
3591 my $new = new FS::cust_svc { $cust_svc->hash };
3592 $new->pkgnum($dest_pkgnum);
3593 $error = $new->replace($cust_svc);
3594 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3596 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
3597 warn "alternates to consider: ".
3598 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
3600 my @alternate = grep {
3601 warn "considering alternate svcpart $_: ".
3602 "$target{$_} available in new package\n"
3605 } @{$svcpart2svcparts{$cust_svc->svcpart}};
3607 warn "alternate(s) found\n" if $DEBUG;
3608 my $change_svcpart = $alternate[0];
3609 $target{$change_svcpart}--;
3610 my $new = new FS::cust_svc { $cust_svc->hash };
3611 $new->svcpart($change_svcpart);
3612 $new->pkgnum($dest_pkgnum);
3613 $error = $new->replace($cust_svc);
3621 my @label = $cust_svc->label;
3622 return "service $label[1]: $error";
3628 =item grab_svcnums SVCNUM, SVCNUM ...
3630 Change the pkgnum for the provided services to this packages. If there is an
3631 error, returns the error, otherwise returns false.
3639 local $SIG{HUP} = 'IGNORE';
3640 local $SIG{INT} = 'IGNORE';
3641 local $SIG{QUIT} = 'IGNORE';
3642 local $SIG{TERM} = 'IGNORE';
3643 local $SIG{TSTP} = 'IGNORE';
3644 local $SIG{PIPE} = 'IGNORE';
3646 my $oldAutoCommit = $FS::UID::AutoCommit;
3647 local $FS::UID::AutoCommit = 0;
3650 foreach my $svcnum (@svcnum) {
3651 my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
3652 $dbh->rollback if $oldAutoCommit;
3653 return "unknown svcnum $svcnum";
3655 $cust_svc->pkgnum( $self->pkgnum );
3656 my $error = $cust_svc->replace;
3658 $dbh->rollback if $oldAutoCommit;
3663 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3670 This method is deprecated. See the I<depend_jobnum> option to the insert and
3671 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
3678 local $SIG{HUP} = 'IGNORE';
3679 local $SIG{INT} = 'IGNORE';
3680 local $SIG{QUIT} = 'IGNORE';
3681 local $SIG{TERM} = 'IGNORE';
3682 local $SIG{TSTP} = 'IGNORE';
3683 local $SIG{PIPE} = 'IGNORE';
3685 my $oldAutoCommit = $FS::UID::AutoCommit;
3686 local $FS::UID::AutoCommit = 0;
3689 foreach my $cust_svc ( $self->cust_svc ) {
3690 #false laziness w/svc_Common::insert
3691 my $svc_x = $cust_svc->svc_x;
3692 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
3693 my $error = $part_export->export_insert($svc_x);
3695 $dbh->rollback if $oldAutoCommit;
3701 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3706 =item export_pkg_change OLD_CUST_PKG
3708 Calls the "pkg_change" export action for all services attached to this package.
3712 sub export_pkg_change {
3713 my( $self, $old ) = ( shift, shift );
3715 local $SIG{HUP} = 'IGNORE';
3716 local $SIG{INT} = 'IGNORE';
3717 local $SIG{QUIT} = 'IGNORE';
3718 local $SIG{TERM} = 'IGNORE';
3719 local $SIG{TSTP} = 'IGNORE';
3720 local $SIG{PIPE} = 'IGNORE';
3722 my $oldAutoCommit = $FS::UID::AutoCommit;
3723 local $FS::UID::AutoCommit = 0;
3726 foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
3727 my $error = $svc_x->export('pkg_change', $self, $old);
3729 $dbh->rollback if $oldAutoCommit;
3734 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3741 Associates this package with a (suspension or cancellation) reason (see
3742 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
3745 Available options are:
3751 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.
3755 the access_user (see L<FS::access_user>) providing the reason
3763 the action (cancel, susp, adjourn, expire) associated with the reason
3767 If there is an error, returns the error, otherwise returns false.
3772 my ($self, %options) = @_;
3774 my $otaker = $options{reason_otaker} ||
3775 $FS::CurrentUser::CurrentUser->username;
3778 if ( $options{'reason'} =~ /^(\d+)$/ ) {
3782 } elsif ( ref($options{'reason'}) ) {
3784 return 'Enter a new reason (or select an existing one)'
3785 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
3787 my $reason = new FS::reason({
3788 'reason_type' => $options{'reason'}->{'typenum'},
3789 'reason' => $options{'reason'}->{'reason'},
3791 my $error = $reason->insert;
3792 return $error if $error;
3794 $reasonnum = $reason->reasonnum;
3797 return "Unparsable reason: ". $options{'reason'};
3800 my $cust_pkg_reason =
3801 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
3802 'reasonnum' => $reasonnum,
3803 'otaker' => $otaker,
3804 'action' => substr(uc($options{'action'}),0,1),
3805 'date' => $options{'date'}
3810 $cust_pkg_reason->insert;
3813 =item insert_discount
3815 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
3816 inserting a new discount on the fly (see L<FS::discount>).
3818 Available options are:
3826 If there is an error, returns the error, otherwise returns false.
3830 sub insert_discount {
3831 #my ($self, %options) = @_;
3834 my $cust_pkg_discount = new FS::cust_pkg_discount {
3835 'pkgnum' => $self->pkgnum,
3836 'discountnum' => $self->discountnum,
3838 'end_date' => '', #XXX
3839 #for the create a new discount case
3840 '_type' => $self->discountnum__type,
3841 'amount' => $self->discountnum_amount,
3842 'percent' => $self->discountnum_percent,
3843 'months' => $self->discountnum_months,
3844 'setup' => $self->discountnum_setup,
3845 #'disabled' => $self->discountnum_disabled,
3848 $cust_pkg_discount->insert;
3851 =item set_usage USAGE_VALUE_HASHREF
3853 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
3854 to which they should be set (see L<FS::svc_acct>). Currently seconds,
3855 upbytes, downbytes, and totalbytes are appropriate keys.
3857 All svc_accts which are part of this package have their values reset.
3862 my ($self, $valueref, %opt) = @_;
3864 #only svc_acct can set_usage for now
3865 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
3866 my $svc_x = $cust_svc->svc_x;
3867 $svc_x->set_usage($valueref, %opt)
3868 if $svc_x->can("set_usage");
3872 =item recharge USAGE_VALUE_HASHREF
3874 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
3875 to which they should be set (see L<FS::svc_acct>). Currently seconds,
3876 upbytes, downbytes, and totalbytes are appropriate keys.
3878 All svc_accts which are part of this package have their values incremented.
3883 my ($self, $valueref) = @_;
3885 #only svc_acct can set_usage for now
3886 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
3887 my $svc_x = $cust_svc->svc_x;
3888 $svc_x->recharge($valueref)
3889 if $svc_x->can("recharge");
3893 =item cust_pkg_discount
3897 sub cust_pkg_discount {
3899 qsearch('cust_pkg_discount', { 'pkgnum' => $self->pkgnum } );
3902 =item cust_pkg_discount_active
3906 sub cust_pkg_discount_active {
3908 grep { $_->status eq 'active' } $self->cust_pkg_discount;
3911 =item cust_pkg_usage
3913 Returns a list of all voice usage counters attached to this package.
3917 sub cust_pkg_usage {
3919 qsearch('cust_pkg_usage', { pkgnum => $self->pkgnum });
3922 =item apply_usage OPTIONS
3924 Takes the following options:
3925 - cdr: a call detail record (L<FS::cdr>)
3926 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
3927 - minutes: the maximum number of minutes to be charged
3929 Finds available usage minutes for a call of this class, and subtracts
3930 up to that many minutes from the usage pool. If the usage pool is empty,
3931 and the C<cdr-minutes_priority> global config option is set, minutes may
3932 be taken from other calls as well. Either way, an allocation record will
3933 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
3934 number of minutes of usage applied to the call.
3939 my ($self, %opt) = @_;
3940 my $cdr = $opt{cdr};
3941 my $rate_detail = $opt{rate_detail};
3942 my $minutes = $opt{minutes};
3943 my $classnum = $rate_detail->classnum;
3944 my $pkgnum = $self->pkgnum;
3945 my $custnum = $self->custnum;
3947 local $SIG{HUP} = 'IGNORE';
3948 local $SIG{INT} = 'IGNORE';
3949 local $SIG{QUIT} = 'IGNORE';
3950 local $SIG{TERM} = 'IGNORE';
3951 local $SIG{TSTP} = 'IGNORE';
3952 local $SIG{PIPE} = 'IGNORE';
3954 my $oldAutoCommit = $FS::UID::AutoCommit;
3955 local $FS::UID::AutoCommit = 0;
3957 my $order = FS::Conf->new->config('cdr-minutes_priority');
3961 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
3963 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
3965 my @usage_recs = qsearch({
3966 'table' => 'cust_pkg_usage',
3967 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
3968 ' JOIN cust_pkg USING (pkgnum)'.
3969 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
3970 'select' => 'cust_pkg_usage.*',
3971 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
3972 " ( cust_pkg.custnum = $custnum AND ".
3973 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
3974 $is_classnum . ' AND '.
3975 " cust_pkg_usage.minutes > 0",
3976 'order_by' => " ORDER BY priority ASC",
3979 my $orig_minutes = $minutes;
3981 while (!$error and $minutes > 0 and @usage_recs) {
3982 my $cust_pkg_usage = shift @usage_recs;
3983 $cust_pkg_usage->select_for_update;
3984 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
3985 pkgusagenum => $cust_pkg_usage->pkgusagenum,
3986 acctid => $cdr->acctid,
3987 minutes => min($cust_pkg_usage->minutes, $minutes),
3989 $cust_pkg_usage->set('minutes',
3990 sprintf('%.0f', $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes)
3992 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
3993 $minutes -= $cdr_cust_pkg_usage->minutes;
3995 if ( $order and $minutes > 0 and !$error ) {
3996 # then try to steal minutes from another call
3998 'table' => 'cdr_cust_pkg_usage',
3999 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
4000 ' JOIN part_pkg_usage USING (pkgusagepart)'.
4001 ' JOIN cust_pkg USING (pkgnum)'.
4002 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
4003 ' JOIN cdr USING (acctid)',
4004 'select' => 'cdr_cust_pkg_usage.*',
4005 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
4006 " ( cust_pkg.pkgnum = $pkgnum OR ".
4007 " ( cust_pkg.custnum = $custnum AND ".
4008 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4009 " part_pkg_usage_class.classnum = $classnum",
4010 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
4012 if ( $order eq 'time' ) {
4013 # find CDRs that are using minutes, but have a later startdate
4015 my $startdate = $cdr->startdate;
4016 if ($startdate !~ /^\d+$/) {
4017 die "bad cdr startdate '$startdate'";
4019 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
4020 # minimize needless reshuffling
4021 $search{'order_by'} .= ', cdr.startdate DESC';
4023 # XXX may not work correctly with rate_time schedules. Could
4024 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
4026 $search{'addl_from'} .=
4027 ' JOIN rate_detail'.
4028 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
4029 if ( $order eq 'rate_high' ) {
4030 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
4031 $rate_detail->min_charge;
4032 $search{'order_by'} .= ', rate_detail.min_charge ASC';
4033 } elsif ( $order eq 'rate_low' ) {
4034 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
4035 $rate_detail->min_charge;
4036 $search{'order_by'} .= ', rate_detail.min_charge DESC';
4038 # this should really never happen
4039 die "invalid cdr-minutes_priority value '$order'\n";
4042 my @cdr_usage_recs = qsearch(\%search);
4044 while (!$error and @cdr_usage_recs and $minutes > 0) {
4045 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
4046 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
4047 my $old_cdr = $cdr_cust_pkg_usage->cdr;
4048 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
4049 $cdr_cust_pkg_usage->select_for_update;
4050 $old_cdr->select_for_update;
4051 $cust_pkg_usage->select_for_update;
4052 # in case someone else stole the usage from this CDR
4053 # while waiting for the lock...
4054 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
4055 # steal the usage allocation and flag the old CDR for reprocessing
4056 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
4057 # if the allocation is more minutes than we need, adjust it...
4058 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
4060 $cdr_cust_pkg_usage->set('minutes', $minutes);
4061 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
4062 $error = $cust_pkg_usage->replace;
4064 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
4065 $error ||= $cdr_cust_pkg_usage->replace;
4066 # deduct the stolen minutes
4067 $minutes -= $cdr_cust_pkg_usage->minutes;
4069 # after all minute-stealing is done, reset the affected CDRs
4070 foreach (values %reproc_cdrs) {
4071 $error ||= $_->set_status('');
4072 # XXX or should we just call $cdr->rate right here?
4073 # it's not like we can create a loop this way, since the min_charge
4074 # or call time has to go monotonically in one direction.
4075 # we COULD get some very deep recursions going, though...
4077 } # if $order and $minutes
4080 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
4082 $dbh->commit if $oldAutoCommit;
4083 return $orig_minutes - $minutes;
4087 =item supplemental_pkgs
4089 Returns a list of all packages supplemental to this one.
4093 sub supplemental_pkgs {
4095 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
4100 Returns the package that this one is supplemental to, if any.
4106 if ( $self->main_pkgnum ) {
4107 return FS::cust_pkg->by_key($self->main_pkgnum);
4114 =head1 CLASS METHODS
4120 Returns an SQL expression identifying recurring packages.
4124 sub recurring_sql { "
4125 '0' != ( select freq from part_pkg
4126 where cust_pkg.pkgpart = part_pkg.pkgpart )
4131 Returns an SQL expression identifying one-time packages.
4136 '0' = ( select freq from part_pkg
4137 where cust_pkg.pkgpart = part_pkg.pkgpart )
4142 Returns an SQL expression identifying ordered packages (recurring packages not
4148 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
4153 Returns an SQL expression identifying active packages.
4158 $_[0]->recurring_sql. "
4159 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4160 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4161 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4164 =item not_yet_billed_sql
4166 Returns an SQL expression identifying packages which have not yet been billed.
4170 sub not_yet_billed_sql { "
4171 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4172 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4173 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4178 Returns an SQL expression identifying inactive packages (one-time packages
4179 that are otherwise unsuspended/uncancelled).
4183 sub inactive_sql { "
4184 ". $_[0]->onetime_sql(). "
4185 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4186 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4187 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4193 Returns an SQL expression identifying suspended packages.
4197 sub suspended_sql { susp_sql(@_); }
4199 #$_[0]->recurring_sql(). ' AND '.
4201 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4202 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4209 Returns an SQL exprression identifying cancelled packages.
4213 sub cancelled_sql { cancel_sql(@_); }
4215 #$_[0]->recurring_sql(). ' AND '.
4216 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
4221 Returns an SQL expression to give the package status as a string.
4227 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
4228 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
4229 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
4230 WHEN ".onetime_sql()." THEN 'one-time charge'
4235 =item search HASHREF
4239 Returns a qsearch hash expression to search for parameters specified in HASHREF.
4240 Valid parameters are
4248 active, inactive, suspended, cancel (or cancelled)
4252 active, inactive, suspended, one-time charge, inactive, cancel (or cancelled)
4256 boolean selects custom packages
4262 pkgpart or arrayref or hashref of pkgparts
4266 arrayref of beginning and ending epoch date
4270 arrayref of beginning and ending epoch date
4274 arrayref of beginning and ending epoch date
4278 arrayref of beginning and ending epoch date
4282 arrayref of beginning and ending epoch date
4286 arrayref of beginning and ending epoch date
4290 arrayref of beginning and ending epoch date
4294 pkgnum or APKG_pkgnum
4298 a value suited to passing to FS::UI::Web::cust_header
4302 specifies the user for agent virtualization
4306 boolean; if true, returns only packages with more than 0 FCC phone lines.
4308 =item state, country
4310 Limit to packages with a service location in the specified state and country.
4311 For FCC 477 reporting, mostly.
4315 Limit to packages whose service locations are the same as the customer's
4316 default service location.
4318 =item location_nocust
4320 Limit to packages whose service locations are not the customer's default
4323 =item location_census
4325 Limit to packages whose service locations have census tracts.
4327 =item location_nocensus
4329 Limit to packages whose service locations do not have a census tract.
4331 =item location_geocode
4333 Limit to packages whose locations have geocodes.
4335 =item location_geocode
4337 Limit to packages whose locations do not have geocodes.
4344 my ($class, $params) = @_;
4351 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
4353 "cust_main.agentnum = $1";
4360 if ( $params->{'cust_status'} =~ /^([a-z]+)$/ ) {
4361 push @where, FS::cust_main->cust_status_sql . " = '$1' ";
4365 # parse customer sales person
4368 if ( $params->{'cust_main_salesnum'} =~ /^(\d+)$/ ) {
4369 push @where, ($1 > 0) ? "cust_main.salesnum = $1"
4370 : 'cust_main.salesnum IS NULL';
4375 # parse sales person
4378 if ( $params->{'salesnum'} =~ /^(\d+)$/ ) {
4379 push @where, ($1 > 0) ? "cust_pkg.salesnum = $1"
4380 : 'cust_pkg.salesnum IS NULL';
4387 if ( $params->{'custnum'} =~ /^(\d+)$/ and $1 ) {
4389 "cust_pkg.custnum = $1";
4396 if ( $params->{'pkgbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
4398 "cust_pkg.pkgbatch = '$1'";
4405 if ( $params->{'magic'} eq 'active'
4406 || $params->{'status'} eq 'active' ) {
4408 push @where, FS::cust_pkg->active_sql();
4410 } elsif ( $params->{'magic'} =~ /^not[ _]yet[ _]billed$/
4411 || $params->{'status'} =~ /^not[ _]yet[ _]billed$/ ) {
4413 push @where, FS::cust_pkg->not_yet_billed_sql();
4415 } elsif ( $params->{'magic'} =~ /^(one-time charge|inactive)/
4416 || $params->{'status'} =~ /^(one-time charge|inactive)/ ) {
4418 push @where, FS::cust_pkg->inactive_sql();
4420 } elsif ( $params->{'magic'} eq 'suspended'
4421 || $params->{'status'} eq 'suspended' ) {
4423 push @where, FS::cust_pkg->suspended_sql();
4425 } elsif ( $params->{'magic'} =~ /^cancell?ed$/
4426 || $params->{'status'} =~ /^cancell?ed$/ ) {
4428 push @where, FS::cust_pkg->cancelled_sql();
4433 # parse package class
4436 if ( exists($params->{'classnum'}) ) {
4439 if ( ref($params->{'classnum'}) ) {
4441 if ( ref($params->{'classnum'}) eq 'HASH' ) {
4442 @classnum = grep $params->{'classnum'}{$_}, keys %{ $params->{'classnum'} };
4443 } elsif ( ref($params->{'classnum'}) eq 'ARRAY' ) {
4444 @classnum = @{ $params->{'classnum'} };
4446 die 'unhandled classnum ref '. $params->{'classnum'};
4450 } elsif ( $params->{'classnum'} =~ /^(\d*)$/ && $1 ne '0' ) {
4457 my @nums = grep $_, @classnum;
4458 push @c_where, 'part_pkg.classnum IN ('. join(',',@nums). ')' if @nums;
4459 my $null = scalar( grep { $_ eq '' } @classnum );
4460 push @c_where, 'part_pkg.classnum IS NULL' if $null;
4462 if ( scalar(@c_where) == 1 ) {
4463 push @where, @c_where;
4464 } elsif ( @c_where ) {
4465 push @where, ' ( '. join(' OR ', @c_where). ' ) ';
4474 # parse package report options
4477 my @report_option = ();
4478 if ( exists($params->{'report_option'}) ) {
4479 if ( ref($params->{'report_option'}) eq 'ARRAY' ) {
4480 @report_option = @{ $params->{'report_option'} };
4481 } elsif ( $params->{'report_option'} =~ /^([,\d]*)$/ ) {
4482 @report_option = split(',', $1);
4487 if (@report_option) {
4488 # this will result in the empty set for the dangling comma case as it should
4490 map{ "0 < ( SELECT count(*) FROM part_pkg_option
4491 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
4492 AND optionname = 'report_option_$_'
4493 AND optionvalue = '1' )"
4497 foreach my $any ( grep /^report_option_any/, keys %$params ) {
4499 my @report_option_any = ();
4500 if ( ref($params->{$any}) eq 'ARRAY' ) {
4501 @report_option_any = @{ $params->{$any} };
4502 } elsif ( $params->{$any} =~ /^([,\d]*)$/ ) {
4503 @report_option_any = split(',', $1);
4506 if (@report_option_any) {
4507 # this will result in the empty set for the dangling comma case as it should
4508 push @where, ' ( '. join(' OR ',
4509 map{ "0 < ( SELECT count(*) FROM part_pkg_option
4510 WHERE part_pkg_option.pkgpart = part_pkg.pkgpart
4511 AND optionname = 'report_option_$_'
4512 AND optionvalue = '1' )"
4513 } @report_option_any
4523 push @where, "part_pkg.custom = 'Y'" if $params->{custom};
4529 push @where, "(part_pkg.fcc_ds0s > 0 OR pkg_class.fcc_ds0s > 0)"
4530 if $params->{fcc_line};
4536 if ( exists($params->{'censustract'}) ) {
4537 $params->{'censustract'} =~ /^([.\d]*)$/;
4538 my $censustract = "cust_location.censustract = '$1'";
4539 $censustract .= ' OR cust_location.censustract is NULL' unless $1;
4540 push @where, "( $censustract )";
4544 # parse censustract2
4546 if ( exists($params->{'censustract2'})
4547 && $params->{'censustract2'} =~ /^(\d*)$/
4551 push @where, "cust_location.censustract LIKE '$1%'";
4554 "( cust_location.censustract = '' OR cust_location.censustract IS NULL )";
4559 # parse country/state
4561 for (qw(state country)) { # parsing rules are the same for these
4562 if ( exists($params->{$_})
4563 && uc($params->{$_}) =~ /^([A-Z]{2})$/ )
4565 # XXX post-2.3 only--before that, state/country may be in cust_main
4566 push @where, "cust_location.$_ = '$1'";
4573 if ( $params->{location_cust} xor $params->{location_nocust} ) {
4574 my $op = $params->{location_cust} ? '=' : '!=';
4575 push @where, "cust_location.locationnum $op cust_main.ship_locationnum";
4577 if ( $params->{location_census} xor $params->{location_nocensus} ) {
4578 my $op = $params->{location_census} ? "IS NOT NULL" : "IS NULL";
4579 push @where, "cust_location.censustract $op";
4581 if ( $params->{location_geocode} xor $params->{location_nogeocode} ) {
4582 my $op = $params->{location_geocode} ? "IS NOT NULL" : "IS NULL";
4583 push @where, "cust_location.geocode $op";
4590 if ( ref($params->{'pkgpart'}) ) {
4593 if ( ref($params->{'pkgpart'}) eq 'HASH' ) {
4594 @pkgpart = grep $params->{'pkgpart'}{$_}, keys %{ $params->{'pkgpart'} };
4595 } elsif ( ref($params->{'pkgpart'}) eq 'ARRAY' ) {
4596 @pkgpart = @{ $params->{'pkgpart'} };
4598 die 'unhandled pkgpart ref '. $params->{'pkgpart'};
4601 @pkgpart = grep /^(\d+)$/, @pkgpart;
4603 push @where, 'pkgpart IN ('. join(',', @pkgpart). ')' if scalar(@pkgpart);
4605 } elsif ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
4606 push @where, "pkgpart = $1";
4615 #false laziness w/report_cust_pkg.html
4618 'one-time charge' => { 'last_bill'=>1, 'bill'=>1, 'adjourn'=>1, 'susp'=>1, 'expire'=>1, 'cancel'=>1, },
4619 'active' => { 'susp'=>1, 'cancel'=>1 },
4620 'suspended' => { 'cancel' => 1 },
4625 if( exists($params->{'active'} ) ) {
4626 # This overrides all the other date-related fields, and includes packages
4627 # that were active at some time during the interval. It excludes:
4628 # - packages that were set up after the end of the interval
4629 # - packages that were canceled before the start of the interval
4630 # - packages that were suspended before the start of the interval
4631 # and are still suspended now
4632 my($beginning, $ending) = @{$params->{'active'}};
4634 "cust_pkg.setup IS NOT NULL",
4635 "cust_pkg.setup <= $ending",
4636 "(cust_pkg.cancel IS NULL OR cust_pkg.cancel >= $beginning )",
4637 "(cust_pkg.susp IS NULL OR cust_pkg.susp >= $beginning )",
4638 "NOT (".FS::cust_pkg->onetime_sql . ")";
4641 foreach my $field (qw( setup last_bill bill adjourn susp expire contract_end change_date cancel )) {
4643 next unless exists($params->{$field});
4645 my($beginning, $ending) = @{$params->{$field}};
4647 next if $beginning == 0 && $ending == 4294967295;
4650 "cust_pkg.$field IS NOT NULL",
4651 "cust_pkg.$field >= $beginning",
4652 "cust_pkg.$field <= $ending";
4654 $orderby ||= "ORDER BY cust_pkg.$field";
4659 $orderby ||= 'ORDER BY bill';
4662 # parse magic, legacy, etc.
4665 if ( $params->{'magic'} &&
4666 $params->{'magic'} =~ /^(active|inactive|suspended|cancell?ed)$/
4669 $orderby = 'ORDER BY pkgnum';
4671 if ( $params->{'pkgpart'} =~ /^(\d+)$/ ) {
4672 push @where, "pkgpart = $1";
4675 } elsif ( $params->{'query'} eq 'pkgnum' ) {
4677 $orderby = 'ORDER BY pkgnum';
4679 } elsif ( $params->{'query'} eq 'APKG_pkgnum' ) {
4681 $orderby = 'ORDER BY pkgnum';
4684 SELECT count(*) FROM pkg_svc
4685 WHERE pkg_svc.pkgpart = cust_pkg.pkgpart
4686 AND pkg_svc.quantity > ( SELECT count(*) FROM cust_svc
4687 WHERE cust_svc.pkgnum = cust_pkg.pkgnum
4688 AND cust_svc.svcpart = pkg_svc.svcpart
4695 # setup queries, links, subs, etc. for the search
4698 # here is the agent virtualization
4699 if ($params->{CurrentUser}) {
4701 qsearchs('access_user', { username => $params->{CurrentUser} });
4704 push @where, $access_user->agentnums_sql('table'=>'cust_main');
4709 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql('table'=>'cust_main');
4712 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
4714 my $addl_from = 'LEFT JOIN part_pkg USING ( pkgpart ) '.
4715 'LEFT JOIN pkg_class ON ( part_pkg.classnum = pkg_class.classnum ) '.
4716 'LEFT JOIN cust_location USING ( locationnum ) '.
4717 FS::UI::Web::join_cust_main('cust_pkg', 'cust_pkg');
4721 if ( $params->{'select_zip5'} ) {
4722 my $zip = 'cust_location.zip';
4724 $select = "DISTINCT substr($zip,1,5) as zip";
4725 $orderby = "ORDER BY substr($zip,1,5)";
4726 $count_query = "SELECT COUNT( DISTINCT substr($zip,1,5) )";
4728 $select = join(', ',
4730 ( map "part_pkg.$_", qw( pkg freq ) ),
4731 'pkg_class.classname',
4732 'cust_main.custnum AS cust_main_custnum',
4733 FS::UI::Web::cust_sql_fields(
4734 $params->{'cust_fields'}
4737 $count_query = 'SELECT COUNT(*)';
4740 $count_query .= " FROM cust_pkg $addl_from $extra_sql";
4743 'table' => 'cust_pkg',
4745 'select' => $select,
4746 'extra_sql' => $extra_sql,
4747 'order_by' => $orderby,
4748 'addl_from' => $addl_from,
4749 'count_query' => $count_query,
4756 Returns a list of two package counts. The first is a count of packages
4757 based on the supplied criteria and the second is the count of residential
4758 packages with those same criteria. Criteria are specified as in the search
4764 my ($class, $params) = @_;
4766 my $sql_query = $class->search( $params );
4768 my $count_sql = delete($sql_query->{'count_query'});
4769 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
4770 or die "couldn't parse count_sql";
4772 my $count_sth = dbh->prepare($count_sql)
4773 or die "Error preparing $count_sql: ". dbh->errstr;
4775 or die "Error executing $count_sql: ". $count_sth->errstr;
4776 my $count_arrayref = $count_sth->fetchrow_arrayref;
4778 return ( @$count_arrayref );
4782 =item tax_locationnum_sql
4784 Returns an SQL expression for the tax location for a package, based
4785 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
4789 sub tax_locationnum_sql {
4790 my $conf = FS::Conf->new;
4791 if ( $conf->exists('tax-pkg_address') ) {
4792 'cust_pkg.locationnum';
4794 elsif ( $conf->exists('tax-ship_address') ) {
4795 'cust_main.ship_locationnum';
4798 'cust_main.bill_locationnum';
4804 Returns a list: the first item is an SQL fragment identifying matching
4805 packages/customers via location (taking into account shipping and package
4806 address taxation, if enabled), and subsequent items are the parameters to
4807 substitute for the placeholders in that fragment.
4812 my($class, %opt) = @_;
4813 my $ornull = $opt{'ornull'};
4815 my $conf = new FS::Conf;
4817 # '?' placeholders in _location_sql_where
4818 my $x = $ornull ? 3 : 2;
4829 if ( $conf->exists('tax-ship_address') ) {
4832 ( ( ship_last IS NULL OR ship_last = '' )
4833 AND ". _location_sql_where('cust_main', '', $ornull ). "
4835 OR ( ship_last IS NOT NULL AND ship_last != ''
4836 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
4839 # AND payby != 'COMP'
4841 @main_param = ( @bill_param, @bill_param );
4845 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
4846 @main_param = @bill_param;
4852 if ( $conf->exists('tax-pkg_address') ) {
4854 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
4857 ( cust_pkg.locationnum IS NULL AND $main_where )
4858 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
4861 @param = ( @main_param, @bill_param );
4865 $where = $main_where;
4866 @param = @main_param;
4874 #subroutine, helper for location_sql
4875 sub _location_sql_where {
4877 my $prefix = @_ ? shift : '';
4878 my $ornull = @_ ? shift : '';
4880 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
4882 $ornull = $ornull ? ' OR ? IS NULL ' : '';
4884 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
4885 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
4886 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
4888 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
4890 # ( $table.${prefix}city = ? $or_empty_city $ornull )
4892 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4893 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4894 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
4895 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
4896 AND $table.${prefix}country = ?
4901 my( $self, $what ) = @_;
4903 my $what_show_zero = $what. '_show_zero';
4904 length($self->$what_show_zero())
4905 ? ($self->$what_show_zero() eq 'Y')
4906 : $self->part_pkg->$what_show_zero();
4913 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
4915 CUSTNUM is a customer (see L<FS::cust_main>)
4917 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4918 L<FS::part_pkg>) to order for this customer. Duplicates are of course
4921 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
4922 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
4923 new billing items. An error is returned if this is not possible (see
4924 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
4927 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4928 newly-created cust_pkg objects.
4930 REFNUM, if specified, will specify the FS::pkg_referral record to be created
4931 and inserted. Multiple FS::pkg_referral records can be created by
4932 setting I<refnum> to an array reference of refnums or a hash reference with
4933 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
4934 record will be created corresponding to cust_main.refnum.
4939 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
4941 my $conf = new FS::Conf;
4943 # Transactionize this whole mess
4944 local $SIG{HUP} = 'IGNORE';
4945 local $SIG{INT} = 'IGNORE';
4946 local $SIG{QUIT} = 'IGNORE';
4947 local $SIG{TERM} = 'IGNORE';
4948 local $SIG{TSTP} = 'IGNORE';
4949 local $SIG{PIPE} = 'IGNORE';
4951 my $oldAutoCommit = $FS::UID::AutoCommit;
4952 local $FS::UID::AutoCommit = 0;
4956 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
4957 # return "Customer not found: $custnum" unless $cust_main;
4959 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
4962 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4965 my $change = scalar(@old_cust_pkg) != 0;
4968 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
4970 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
4971 " to pkgpart ". $pkgparts->[0]. "\n"
4974 my $err_or_cust_pkg =
4975 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
4976 'refnum' => $refnum,
4979 unless (ref($err_or_cust_pkg)) {
4980 $dbh->rollback if $oldAutoCommit;
4981 return $err_or_cust_pkg;
4984 push @$return_cust_pkg, $err_or_cust_pkg;
4985 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4990 # Create the new packages.
4991 foreach my $pkgpart (@$pkgparts) {
4993 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
4995 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
4996 pkgpart => $pkgpart,
5000 $error = $cust_pkg->insert( 'change' => $change );
5001 push @$return_cust_pkg, $cust_pkg;
5003 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
5004 my $supp_pkg = FS::cust_pkg->new({
5005 custnum => $custnum,
5006 pkgpart => $link->dst_pkgpart,
5008 main_pkgnum => $cust_pkg->pkgnum,
5011 $error ||= $supp_pkg->insert( 'change' => $change );
5012 push @$return_cust_pkg, $supp_pkg;
5016 $dbh->rollback if $oldAutoCommit;
5021 # $return_cust_pkg now contains refs to all of the newly
5024 # Transfer services and cancel old packages.
5025 foreach my $old_pkg (@old_cust_pkg) {
5027 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
5030 foreach my $new_pkg (@$return_cust_pkg) {
5031 $error = $old_pkg->transfer($new_pkg);
5032 if ($error and $error == 0) {
5033 # $old_pkg->transfer failed.
5034 $dbh->rollback if $oldAutoCommit;
5039 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
5040 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
5041 foreach my $new_pkg (@$return_cust_pkg) {
5042 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
5043 if ($error and $error == 0) {
5044 # $old_pkg->transfer failed.
5045 $dbh->rollback if $oldAutoCommit;
5052 # Transfers were successful, but we went through all of the
5053 # new packages and still had services left on the old package.
5054 # We can't cancel the package under the circumstances, so abort.
5055 $dbh->rollback if $oldAutoCommit;
5056 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
5058 $error = $old_pkg->cancel( quiet=>1 );
5064 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5068 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
5070 A bulk change method to change packages for multiple customers.
5072 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5073 L<FS::part_pkg>) to order for each customer. Duplicates are of course
5076 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
5077 replace. The services (see L<FS::cust_svc>) are moved to the
5078 new billing items. An error is returned if this is not possible (see
5081 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5082 newly-created cust_pkg objects.
5087 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
5089 # Transactionize this whole mess
5090 local $SIG{HUP} = 'IGNORE';
5091 local $SIG{INT} = 'IGNORE';
5092 local $SIG{QUIT} = 'IGNORE';
5093 local $SIG{TERM} = 'IGNORE';
5094 local $SIG{TSTP} = 'IGNORE';
5095 local $SIG{PIPE} = 'IGNORE';
5097 my $oldAutoCommit = $FS::UID::AutoCommit;
5098 local $FS::UID::AutoCommit = 0;
5102 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5105 while(scalar(@old_cust_pkg)) {
5107 my $custnum = $old_cust_pkg[0]->custnum;
5108 my (@remove) = map { $_->pkgnum }
5109 grep { $_->custnum == $custnum } @old_cust_pkg;
5110 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
5112 my $error = order $custnum, $pkgparts, \@remove, \@return;
5114 push @errors, $error
5116 push @$return_cust_pkg, @return;
5119 if (scalar(@errors)) {
5120 $dbh->rollback if $oldAutoCommit;
5121 return join(' / ', @errors);
5124 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5128 # Used by FS::Upgrade to migrate to a new database.
5129 sub _upgrade_data { # class method
5130 my ($class, %opts) = @_;
5131 $class->_upgrade_otaker(%opts);
5133 # RT#10139, bug resulting in contract_end being set when it shouldn't
5134 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
5135 # RT#10830, bad calculation of prorate date near end of year
5136 # the date range for bill is December 2009, and we move it forward
5137 # one year if it's before the previous bill date (which it should
5139 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
5140 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
5141 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
5142 # RT6628, add order_date to cust_pkg
5143 'update cust_pkg set order_date = (select history_date from h_cust_pkg
5144 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
5145 history_action = \'insert\') where order_date is null',
5147 foreach my $sql (@statements) {
5148 my $sth = dbh->prepare($sql);
5149 $sth->execute or die $sth->errstr;
5157 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
5159 In sub order, the @pkgparts array (passed by reference) is clobbered.
5161 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
5162 method to pass dates to the recur_prog expression, it should do so.
5164 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
5165 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
5166 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
5167 configuration values. Probably need a subroutine which decides what to do
5168 based on whether or not we've fetched the user yet, rather than a hash. See
5169 FS::UID and the TODO.
5171 Now that things are transactional should the check in the insert method be
5176 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
5177 L<FS::pkg_svc>, schema.html from the base documentation