2 use base qw( FS::cust_pkg::Search FS::cust_pkg::API
3 FS::otaker_Mixin FS::cust_main_Mixin FS::Sales_Mixin
4 FS::contact_Mixin FS::location_Mixin
5 FS::m2m_Common FS::option_Common
10 use Scalar::Util qw( blessed );
11 use List::Util qw(min max);
13 use Time::Local qw( timelocal timelocal_nocheck );
15 use FS::UID qw( dbh driver_name );
16 use FS::Misc qw( send_email );
17 use FS::Record qw( qsearch qsearchs fields );
23 use FS::cust_location;
25 use FS::cust_bill_pkg;
26 use FS::cust_pkg_detail;
27 use FS::cust_pkg_usage;
28 use FS::cdr_cust_pkg_usage;
33 use FS::cust_pkg_reason;
35 use FS::cust_pkg_usageprice;
36 use FS::cust_pkg_discount;
42 # need to 'use' these instead of 'require' in sub { cancel, suspend, unsuspend,
44 # because they load configuration by setting FS::UID::callback (see TODO)
50 # for sending cancel emails in sub cancel
53 our ($disable_agentcheck, $DEBUG, $me, $import) = (0, 0, '[FS::cust_pkg]', 0);
55 our $upgrade = 0; #go away after setup+start dates cleaned up for old customers
59 my ( $hashref, $cache ) = @_;
60 #if ( $hashref->{'pkgpart'} ) {
61 if ( $hashref->{'pkg'} ) {
62 # #@{ $self->{'_pkgnum'} } = ();
63 # my $subcache = $cache->subcache('pkgpart', 'part_pkg');
64 # $self->{'_pkgpart'} = $subcache;
65 # #push @{ $self->{'_pkgnum'} },
66 # FS::part_pkg->new_or_cached($hashref, $subcache);
67 $self->{'_pkgpart'} = FS::part_pkg->new($hashref);
69 if ( exists $hashref->{'svcnum'} ) {
70 #@{ $self->{'_pkgnum'} } = ();
71 my $subcache = $cache->subcache('svcnum', 'cust_svc', $hashref->{pkgnum});
72 $self->{'_svcnum'} = $subcache;
73 #push @{ $self->{'_pkgnum'} },
74 FS::cust_svc->new_or_cached($hashref, $subcache) if $hashref->{svcnum};
80 FS::cust_pkg - Object methods for cust_pkg objects
86 $record = new FS::cust_pkg \%hash;
87 $record = new FS::cust_pkg { 'column' => 'value' };
89 $error = $record->insert;
91 $error = $new_record->replace($old_record);
93 $error = $record->delete;
95 $error = $record->check;
97 $error = $record->cancel;
99 $error = $record->suspend;
101 $error = $record->unsuspend;
103 $part_pkg = $record->part_pkg;
105 @labels = $record->labels;
107 $seconds = $record->seconds_since($timestamp);
109 $error = FS::cust_pkg::order( $custnum, \@pkgparts );
110 $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );
114 An FS::cust_pkg object represents a customer billing item. FS::cust_pkg
115 inherits from FS::Record. The following fields are currently supported:
121 Primary key (assigned automatically for new billing items)
125 Customer (see L<FS::cust_main>)
129 Billing item definition (see L<FS::part_pkg>)
133 Optional link to package location (see L<FS::location>)
137 date package was ordered (also remains same on changes)
149 date (next bill date)
177 order taker (see L<FS::access_user>)
181 If this field is set to 1, disables the automatic
182 unsuspension of this package when using the B<unsuspendauto> config option.
186 If not set, defaults to 1
190 Date of change from previous package
200 =item change_locationnum
208 The pkgnum of the package that this package is supplemental to, if any.
212 The package link (L<FS::part_pkg_link>) that defines this supplemental
213 package, if it is one.
215 =item change_to_pkgnum
217 The pkgnum of the package this one will be "changed to" in the future
218 (on its expiration date).
222 Note: setup, last_bill, bill, adjourn, susp, expire, cancel and change_date
223 are specified as UNIX timestamps; see L<perlfunc/"time">. Also see
224 L<Time::Local> and L<Date::Parse> for conversion functions.
232 Create a new billing item. To add the item to the database, see L<"insert">.
236 sub table { 'cust_pkg'; }
237 sub cust_linked { $_[0]->cust_main_custnum || $_[0]->custnum }
238 sub cust_unlinked_msg {
240 "WARNING: can't find cust_main.custnum ". $self->custnum.
241 ' (cust_pkg.pkgnum '. $self->pkgnum. ')';
244 =item set_initial_timers
246 If required by the package definition, sets any automatic expire, adjourn,
247 or contract_end timers to some number of months after the start date
248 (or setup date, if the package has already been setup). If the package has
249 a delayed setup fee after a period of "free days", will also set the
250 start date to the end of that period.
254 sub set_initial_timers {
256 my $part_pkg = $self->part_pkg;
257 foreach my $action ( qw(expire adjourn contract_end) ) {
258 my $months = $part_pkg->option("${action}_months",1);
259 if($months and !$self->get($action)) {
260 my $start = $self->start_date || $self->setup || time;
261 $self->set($action, $part_pkg->add_freq($start, $months) );
265 # if this package has "free days" and delayed setup fee, then
266 # set start date that many days in the future.
267 # (this should have been set in the UI, but enforce it here)
268 if ( $part_pkg->option('free_days',1)
269 && $part_pkg->option('delay_setup',1)
272 $self->start_date( $part_pkg->default_start_date );
277 =item insert [ OPTION => VALUE ... ]
279 Adds this billing item to the database ("Orders" the item). If there is an
280 error, returns the error, otherwise returns false.
282 If the additional field I<promo_code> is defined instead of I<pkgpart>, it
283 will be used to look up the package definition and agent restrictions will be
286 If the additional field I<refnum> is defined, an FS::pkg_referral record will
287 be created and inserted. Multiple FS::pkg_referral records can be created by
288 setting I<refnum> to an array reference of refnums or a hash reference with
289 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
290 record will be created corresponding to cust_main.refnum.
292 If the additional field I<cust_pkg_usageprice> is defined, it will be treated
293 as an arrayref of FS::cust_pkg_usageprice objects, which will be inserted.
294 (Note that this field cannot be set with a usual ->cust_pkg_usageprice method.
295 It can be set as part of the hash when creating the object, or with the B<set>
298 The following options are available:
304 If set true, supresses actions that should only be taken for new package
305 orders. (Currently this includes: intro periods when delay_setup is on,
306 auto-adding a 1st start date, auto-adding expiration/adjourn/contract_end dates)
310 cust_pkg_option records will be created
314 a ticket will be added to this customer with this subject
318 an optional queue name for ticket additions
322 Don't check the legality of the package definition. This should be used
323 when performing a package change that doesn't change the pkgpart (i.e.
331 my( $self, %options ) = @_;
334 $error = $self->check_pkgpart unless $options{'allow_pkgpart'};
335 return $error if $error;
337 my $part_pkg = $self->part_pkg;
339 if ( ! $import && ! $options{'change'} ) {
341 # set order date to now
342 $self->order_date(time) unless ($import && $self->order_date);
344 # if the package def says to start only on the first of the month:
345 if ( $part_pkg->option('start_1st', 1) && !$self->start_date ) {
346 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime(time) )[0,1,2,3,4,5];
347 $mon += 1 unless $mday == 1;
348 until ( $mon < 12 ) { $mon -= 12; $year++; }
349 $self->start_date( timelocal_nocheck(0,0,0,1,$mon,$year) );
352 if ($self->susp eq 'now' or $part_pkg->start_on_hold) {
353 # if the package was ordered on hold:
355 # - don't set the start date (it will be started manually)
356 $self->set('susp', $self->order_date);
357 $self->set('start_date', '');
359 # set expire/adjourn/contract_end timers, and free days, if appropriate
360 $self->set_initial_timers;
362 } # else this is a package change, and shouldn't have "new package" behavior
364 my $oldAutoCommit = $FS::UID::AutoCommit;
365 local $FS::UID::AutoCommit = 0;
368 $error = $self->SUPER::insert($options{options} ? %{$options{options}} : ());
370 $dbh->rollback if $oldAutoCommit;
374 $self->refnum($self->cust_main->refnum) unless $self->refnum;
375 $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
376 $self->process_m2m( 'link_table' => 'pkg_referral',
377 'target_table' => 'part_referral',
378 'params' => $self->refnum,
381 if ( $self->hashref->{cust_pkg_usageprice} ) {
382 for my $cust_pkg_usageprice ( @{ $self->hashref->{cust_pkg_usageprice} } ) {
383 $cust_pkg_usageprice->pkgnum( $self->pkgnum );
384 my $error = $cust_pkg_usageprice->insert;
386 $dbh->rollback if $oldAutoCommit;
392 if ( $self->discountnum ) {
393 my $error = $self->insert_discount();
395 $dbh->rollback if $oldAutoCommit;
400 my $conf = new FS::Conf;
402 if ( ! $import && $conf->config('ticket_system') && $options{ticket_subject} ) {
404 #this init stuff is still inefficient, but at least its limited to
405 # the small number (any?) folks using ticket emailing on pkg order
408 # use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
415 use FS::TicketSystem;
416 FS::TicketSystem->init();
418 my $q = new RT::Queue($RT::SystemUser);
419 $q->Load($options{ticket_queue}) if $options{ticket_queue};
420 my $t = new RT::Ticket($RT::SystemUser);
421 my $mime = new MIME::Entity;
422 $mime->build( Type => 'text/plain', Data => $options{ticket_subject} );
423 $t->Create( $options{ticket_queue} ? (Queue => $q) : (),
424 Subject => $options{ticket_subject},
427 $t->AddLink( Type => 'MemberOf',
428 Target => 'freeside://freeside/cust_main/'. $self->custnum,
432 if (! $import && $conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
433 my $queue = new FS::queue {
434 'job' => 'FS::cust_main::queueable_print',
436 $error = $queue->insert(
437 'custnum' => $self->custnum,
438 'template' => 'welcome_letter',
442 warn "can't send welcome letter: $error";
447 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
454 This method now works but you probably shouldn't use it.
456 You don't want to delete packages, because there would then be no record
457 the customer ever purchased the package. Instead, see the cancel method and
458 hide cancelled packages.
465 my $oldAutoCommit = $FS::UID::AutoCommit;
466 local $FS::UID::AutoCommit = 0;
469 foreach my $cust_pkg_discount ($self->cust_pkg_discount) {
470 my $error = $cust_pkg_discount->delete;
472 $dbh->rollback if $oldAutoCommit;
476 #cust_bill_pkg_discount?
478 foreach my $cust_pkg_detail ($self->cust_pkg_detail) {
479 my $error = $cust_pkg_detail->delete;
481 $dbh->rollback if $oldAutoCommit;
486 foreach my $cust_pkg_reason (
488 'table' => 'cust_pkg_reason',
489 'hashref' => { 'pkgnum' => $self->pkgnum },
493 my $error = $cust_pkg_reason->delete;
495 $dbh->rollback if $oldAutoCommit;
502 my $error = $self->SUPER::delete(@_);
504 $dbh->rollback if $oldAutoCommit;
508 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
514 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
516 Replaces the OLD_RECORD with this one in the database. If there is an error,
517 returns the error, otherwise returns false.
519 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
521 Changing pkgpart may have disasterous effects. See the order subroutine.
523 setup and bill are normally updated by calling the bill method of a customer
524 object (see L<FS::cust_main>).
526 suspend is normally updated by the suspend and unsuspend methods.
528 cancel is normally updated by the cancel method (and also the order subroutine
531 Available options are:
537 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.
541 the access_user (see L<FS::access_user>) providing the reason
545 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
554 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
559 ( ref($_[0]) eq 'HASH' )
563 #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
564 #return "Can't change otaker!" if $old->otaker ne $new->otaker;
567 #return "Can't change setup once it exists!"
568 # if $old->getfield('setup') &&
569 # $old->getfield('setup') != $new->getfield('setup');
571 #some logic for bill, susp, cancel?
573 local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
575 my $oldAutoCommit = $FS::UID::AutoCommit;
576 local $FS::UID::AutoCommit = 0;
579 foreach my $method ( qw(adjourn expire) ) { # How many reasons?
580 if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
581 my $error = $new->insert_reason(
582 'reason' => $options->{'reason'},
583 'date' => $new->$method,
585 'reason_otaker' => $options->{'reason_otaker'},
588 dbh->rollback if $oldAutoCommit;
589 return "Error inserting cust_pkg_reason: $error";
594 #save off and freeze RADIUS attributes for any associated svc_acct records
596 if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
598 #also check for specific exports?
599 # to avoid spurious modify export events
600 @svc_acct = map { $_->svc_x }
601 grep { $_->part_svc->svcdb eq 'svc_acct' }
604 $_->snapshot foreach @svc_acct;
608 my $error = $new->export_pkg_change($old)
609 || $new->SUPER::replace( $old,
611 ? $options->{options}
615 $dbh->rollback if $oldAutoCommit;
619 #for prepaid packages,
620 #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
621 foreach my $old_svc_acct ( @svc_acct ) {
622 my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
624 $new_svc_acct->replace( $old_svc_acct,
625 'depend_jobnum' => $options->{depend_jobnum},
628 $dbh->rollback if $oldAutoCommit;
633 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
640 Checks all fields to make sure this is a valid billing item. If there is an
641 error, returns the error, otherwise returns false. Called by the insert and
649 if ( !$self->locationnum or $self->locationnum == -1 ) {
650 $self->set('locationnum', $self->cust_main->ship_locationnum);
654 $self->ut_numbern('pkgnum')
655 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
656 || $self->ut_numbern('pkgpart')
657 || $self->ut_foreign_keyn('contactnum', 'contact', 'contactnum' )
658 || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
659 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
660 || $self->ut_numbern('quantity')
661 || $self->ut_numbern('start_date')
662 || $self->ut_numbern('setup')
663 || $self->ut_numbern('bill')
664 || $self->ut_numbern('susp')
665 || $self->ut_numbern('cancel')
666 || $self->ut_numbern('adjourn')
667 || $self->ut_numbern('resume')
668 || $self->ut_numbern('expire')
669 || $self->ut_numbern('dundate')
670 || $self->ut_enum('no_auto', [ '', 'Y' ])
671 || $self->ut_enum('waive_setup', [ '', 'Y' ])
672 || $self->ut_textn('agent_pkgid')
673 || $self->ut_enum('recur_show_zero', [ '', 'Y', 'N', ])
674 || $self->ut_enum('setup_show_zero', [ '', 'Y', 'N', ])
675 || $self->ut_foreign_keyn('main_pkgnum', 'cust_pkg', 'pkgnum')
676 || $self->ut_foreign_keyn('pkglinknum', 'part_pkg_link', 'pkglinknum')
677 || $self->ut_foreign_keyn('change_to_pkgnum', 'cust_pkg', 'pkgnum')
679 return $error if $error;
681 return "A package with both start date (future start) and setup date (already started) will never bill"
682 if $self->start_date && $self->setup && ! $upgrade;
684 return "A future unsuspend date can only be set for a package with a suspend date"
685 if $self->resume and !$self->susp and !$self->adjourn;
687 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
689 if ( $self->dbdef_table->column('manual_flag') ) {
690 $self->manual_flag('') if $self->manual_flag eq ' ';
691 $self->manual_flag =~ /^([01]?)$/
692 or return "Illegal manual_flag ". $self->manual_flag;
693 $self->manual_flag($1);
701 Check the pkgpart to make sure it's allowed with the reg_code and/or
702 promo_code of the package (if present) and with the customer's agent.
703 Called from C<insert>, unless we are doing a package change that doesn't
711 # my $error = $self->ut_numbern('pkgpart'); # already done
714 if ( $self->reg_code ) {
716 unless ( grep { $self->pkgpart == $_->pkgpart }
717 map { $_->reg_code_pkg }
718 qsearchs( 'reg_code', { 'code' => $self->reg_code,
719 'agentnum' => $self->cust_main->agentnum })
721 return "Unknown registration code";
724 } elsif ( $self->promo_code ) {
727 qsearchs('part_pkg', {
728 'pkgpart' => $self->pkgpart,
729 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
731 return 'Unknown promotional code' unless $promo_part_pkg;
735 unless ( $disable_agentcheck ) {
737 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
738 return "agent ". $agent->agentnum. ':'. $agent->agent.
739 " can't purchase pkgpart ". $self->pkgpart
740 unless $agent->pkgpart_hashref->{ $self->pkgpart }
741 || $agent->agentnum == $self->part_pkg->agentnum;
744 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
745 return $error if $error;
753 =item cancel [ OPTION => VALUE ... ]
755 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
756 in this package, then cancels the package itself (sets the cancel field to
759 Available options are:
763 =item quiet - can be set true to supress email cancellation notices.
765 =item time - can be set to cancel the package based on a specific future or
766 historical date. Using time ensures that the remaining amount is calculated
767 correctly. Note however that this is an immediate cancel and just changes
768 the date. You are PROBABLY looking to expire the account instead of using
771 =item reason - can be set to a cancellation reason (see L<FS:reason>),
772 either a reasonnum of an existing reason, or passing a hashref will create
773 a new reason. The hashref should have the following keys: typenum - Reason
774 type (see L<FS::reason_type>, reason - Text of the new reason.
776 =item date - can be set to a unix style timestamp to specify when to
779 =item nobill - can be set true to skip billing if it might otherwise be done.
781 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
782 not credit it. This must be set (by change()) when changing the package
783 to a different pkgpart or location, and probably shouldn't be in any other
784 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
789 If there is an error, returns the error, otherwise returns false.
794 my( $self, %options ) = @_;
797 # pass all suspend/cancel actions to the main package
798 # (unless the pkglinknum has been removed, then the link is defunct and
799 # this package can be canceled on its own)
800 if ( $self->main_pkgnum and $self->pkglinknum and !$options{'from_main'} ) {
801 return $self->main_pkg->cancel(%options);
804 my $conf = new FS::Conf;
806 warn "cust_pkg::cancel called with options".
807 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
810 my $oldAutoCommit = $FS::UID::AutoCommit;
811 local $FS::UID::AutoCommit = 0;
814 my $old = $self->select_for_update;
816 if ( $old->get('cancel') || $self->get('cancel') ) {
817 dbh->rollback if $oldAutoCommit;
818 return ""; # no error
821 # XXX possibly set cancel_time to the expire date?
822 my $cancel_time = $options{'time'} || time;
823 my $date = $options{'date'} if $options{'date'}; # expire/cancel later
824 $date = '' if ($date && $date <= $cancel_time); # complain instead?
826 my $delay_cancel = undef;
827 if ( !$date && $self->part_pkg->option('delay_cancel',1)
828 && (($self->status eq 'active') || ($self->status eq 'suspended'))
830 my $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
831 my $expsecs = 60*60*24*$expdays;
832 my $suspfor = $self->susp ? $cancel_time - $self->susp : 0;
833 $expsecs = $expsecs - $suspfor if $suspfor;
834 unless ($expsecs <= 0) { #if it's already been suspended long enough, don't re-suspend
836 $date = $cancel_time + $expsecs;
840 #race condition: usage could be ongoing until unprovisioned
841 #resolved by performing a change package instead (which unprovisions) and
843 if ( !$options{nobill} && !$date ) {
844 # && $conf->exists('bill_usage_on_cancel') ) { #calc_cancel checks this
845 my $copy = $self->new({$self->hash});
847 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
849 'time' => $cancel_time );
850 warn "Error billing during cancel, custnum ".
851 #$self->cust_main->custnum. ": $error"
856 if ( $options{'reason'} ) {
857 $error = $self->insert_reason( 'reason' => $options{'reason'},
858 'action' => $date ? 'expire' : 'cancel',
859 'date' => $date ? $date : $cancel_time,
860 'reason_otaker' => $options{'reason_otaker'},
863 dbh->rollback if $oldAutoCommit;
864 return "Error inserting cust_pkg_reason: $error";
868 my %svc_cancel_opt = ();
869 $svc_cancel_opt{'date'} = $date if $date;
870 foreach my $cust_svc (
873 sort { $a->[1] <=> $b->[1] }
874 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; }
875 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
877 my $part_svc = $cust_svc->part_svc;
878 next if ( defined($part_svc) and $part_svc->preserve );
879 my $error = $cust_svc->cancel( %svc_cancel_opt );
882 $dbh->rollback if $oldAutoCommit;
883 return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
889 # credit remaining time if appropriate
891 if ( exists($options{'unused_credit'}) ) {
892 $do_credit = $options{'unused_credit'};
895 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
898 my $error = $self->credit_remaining('cancel', $cancel_time);
900 $dbh->rollback if $oldAutoCommit;
906 my %hash = $self->hash;
908 $hash{'expire'} = $date;
910 $hash{'susp'} = $cancel_time unless $self->susp;
911 $hash{'adjourn'} = undef;
912 $hash{'resume'} = undef;
915 $hash{'cancel'} = $cancel_time;
917 $hash{'change_custnum'} = $options{'change_custnum'};
919 # if this is a supplemental package that's lost its part_pkg_link, and it's
920 # being canceled for real, unlink it completely
921 if ( !$date and ! $self->pkglinknum ) {
922 $hash{main_pkgnum} = '';
925 my $new = new FS::cust_pkg ( \%hash );
926 $error = $new->replace( $self, options => { $self->options } );
927 if ( $self->change_to_pkgnum ) {
928 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
929 $error ||= $change_to->cancel || $change_to->delete;
932 $dbh->rollback if $oldAutoCommit;
936 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
938 $error = $supp_pkg->suspend(
941 'time' => $cancel_time
944 $error = $supp_pkg->cancel(%options, 'from_main' => 1);
947 $dbh->rollback if $oldAutoCommit;
948 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
953 foreach my $usage ( $self->cust_pkg_usage ) {
954 $error = $usage->delete;
956 $dbh->rollback if $oldAutoCommit;
957 return "deleting usage pools: $error";
962 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
963 return '' if $date; #no errors
965 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
966 if ( !$options{'quiet'} &&
967 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
969 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
972 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
973 $error = $msg_template->send( 'cust_main' => $self->cust_main,
978 'from' => $conf->invoice_from_full( $self->cust_main->agentnum ),
979 'to' => \@invoicing_list,
980 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
981 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
982 'custnum' => $self->custnum,
983 'msgtype' => '', #admin?
986 #should this do something on errors?
993 =item cancel_if_expired [ NOW_TIMESTAMP ]
995 Cancels this package if its expire date has been reached.
999 sub cancel_if_expired {
1001 my $time = shift || time;
1002 return '' unless $self->expire && $self->expire <= $time;
1003 my $error = $self->cancel;
1005 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
1006 $self->custnum. ": $error";
1013 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
1014 locationnum, (other fields?). Attempts to re-provision cancelled services
1015 using history information (errors at this stage are not fatal).
1017 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
1019 svc_fatal: service provisioning errors are fatal
1021 svc_errors: pass an array reference, will be filled in with any provisioning errors
1023 main_pkgnum: link the package as a supplemental package of this one. For
1029 my( $self, %options ) = @_;
1031 #in case you try do do $uncancel-date = $cust_pkg->uncacel
1032 return '' unless $self->get('cancel');
1034 if ( $self->main_pkgnum and !$options{'main_pkgnum'} ) {
1035 return $self->main_pkg->uncancel(%options);
1042 my $oldAutoCommit = $FS::UID::AutoCommit;
1043 local $FS::UID::AutoCommit = 0;
1047 # insert the new package
1050 my $cust_pkg = new FS::cust_pkg {
1051 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
1052 bill => ( $options{'bill'} || $self->get('bill') ),
1054 uncancel_pkgnum => $self->pkgnum,
1055 main_pkgnum => ($options{'main_pkgnum'} || ''),
1056 map { $_ => $self->get($_) } qw(
1057 custnum pkgpart locationnum
1059 susp adjourn resume expire start_date contract_end dundate
1060 change_date change_pkgpart change_locationnum
1061 manual_flag no_auto quantity agent_pkgid recur_show_zero setup_show_zero
1065 my $error = $cust_pkg->insert(
1066 'change' => 1, #supresses any referral credit to a referring customer
1067 'allow_pkgpart' => 1, # allow this even if the package def is disabled
1070 $dbh->rollback if $oldAutoCommit;
1078 #find historical services within this timeframe before the package cancel
1079 # (incompatible with "time" option to cust_pkg->cancel?)
1080 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
1081 # too little? (unprovisioing export delay?)
1082 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
1083 my @h_cust_svc = $self->h_cust_svc( $end, $start );
1086 foreach my $h_cust_svc (@h_cust_svc) {
1087 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
1088 #next unless $h_svc_x; #should this happen?
1089 (my $table = $h_svc_x->table) =~ s/^h_//;
1090 require "FS/$table.pm";
1091 my $class = "FS::$table";
1092 my $svc_x = $class->new( {
1093 'pkgnum' => $cust_pkg->pkgnum,
1094 'svcpart' => $h_cust_svc->svcpart,
1095 map { $_ => $h_svc_x->get($_) } fields($table)
1099 if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
1100 $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
1103 my $svc_error = $svc_x->insert;
1105 if ( $options{svc_fatal} ) {
1106 $dbh->rollback if $oldAutoCommit;
1109 # if we've failed to insert the svc_x object, svc_Common->insert
1110 # will have removed the cust_svc already. if not, then both records
1111 # were inserted but we failed for some other reason (export, most
1112 # likely). in that case, report the error and delete the records.
1113 push @svc_errors, $svc_error;
1114 my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1116 # except if export_insert failed, export_delete probably won't be
1118 local $FS::svc_Common::noexport_hack = 1;
1119 my $cleanup_error = $svc_x->delete; # also deletes cust_svc
1120 if ( $cleanup_error ) { # and if THAT fails, then run away
1121 $dbh->rollback if $oldAutoCommit;
1122 return $cleanup_error;
1127 } #foreach $h_cust_svc
1129 #these are pretty rare, but should handle them
1130 # - dsl_device (mac addresses)
1131 # - phone_device (mac addresses)
1132 # - dsl_note (ikano notes)
1133 # - domain_record (i.e. restore DNS information w/domains)
1134 # - inventory_item(?) (inventory w/un-cancelling service?)
1135 # - nas (svc_broaband nas stuff)
1136 #this stuff is unused in the wild afaik
1137 # - mailinglistmember
1139 # - svc_domain.parent_svcnum?
1140 # - acct_snarf (ancient mail fetching config)
1141 # - cgp_rule (communigate)
1142 # - cust_svc_option (used by our Tron stuff)
1143 # - acct_rt_transaction (used by our time worked stuff)
1146 # also move over any services that didn't unprovision at cancellation
1149 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1150 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1151 my $error = $cust_svc->replace;
1153 $dbh->rollback if $oldAutoCommit;
1159 # Uncancel any supplemental packages, and make them supplemental to the
1163 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1165 $error = $supp_pkg->uncancel(%options, 'main_pkgnum' => $cust_pkg->pkgnum);
1167 $dbh->rollback if $oldAutoCommit;
1168 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1176 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1178 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1179 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1186 Cancels any pending expiration (sets the expire field to null).
1188 If there is an error, returns the error, otherwise returns false.
1193 my( $self, %options ) = @_;
1196 my $oldAutoCommit = $FS::UID::AutoCommit;
1197 local $FS::UID::AutoCommit = 0;
1200 my $old = $self->select_for_update;
1202 my $pkgnum = $old->pkgnum;
1203 if ( $old->get('cancel') || $self->get('cancel') ) {
1204 dbh->rollback if $oldAutoCommit;
1205 return "Can't unexpire cancelled package $pkgnum";
1206 # or at least it's pointless
1209 unless ( $old->get('expire') && $self->get('expire') ) {
1210 dbh->rollback if $oldAutoCommit;
1211 return ""; # no error
1214 my %hash = $self->hash;
1215 $hash{'expire'} = '';
1216 my $new = new FS::cust_pkg ( \%hash );
1217 $error = $new->replace( $self, options => { $self->options } );
1219 $dbh->rollback if $oldAutoCommit;
1223 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1229 =item suspend [ OPTION => VALUE ... ]
1231 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1232 package, then suspends the package itself (sets the susp field to now).
1234 Available options are:
1238 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1239 either a reasonnum of an existing reason, or passing a hashref will create
1240 a new reason. The hashref should have the following keys:
1241 - typenum - Reason type (see L<FS::reason_type>
1242 - reason - Text of the new reason.
1244 =item date - can be set to a unix style timestamp to specify when to
1247 =item time - can be set to override the current time, for calculation
1248 of final invoices or unused-time credits
1250 =item resume_date - can be set to a time when the package should be
1251 unsuspended. This may be more convenient than calling C<unsuspend()>
1254 =item from_main - allows a supplemental package to be suspended, rather
1255 than redirecting the method call to its main package. For internal use.
1257 =item from_cancel - used when suspending from the cancel method, forces
1258 this to skip everything besides basic suspension. For internal use.
1262 If there is an error, returns the error, otherwise returns false.
1267 my( $self, %options ) = @_;
1270 # pass all suspend/cancel actions to the main package
1271 if ( $self->main_pkgnum and !$options{'from_main'} ) {
1272 return $self->main_pkg->suspend(%options);
1275 my $oldAutoCommit = $FS::UID::AutoCommit;
1276 local $FS::UID::AutoCommit = 0;
1279 my $old = $self->select_for_update;
1281 my $pkgnum = $old->pkgnum;
1282 if ( $old->get('cancel') || $self->get('cancel') ) {
1283 dbh->rollback if $oldAutoCommit;
1284 return "Can't suspend cancelled package $pkgnum";
1287 if ( $old->get('susp') || $self->get('susp') ) {
1288 dbh->rollback if $oldAutoCommit;
1289 return ""; # no error # complain on adjourn?
1292 my $suspend_time = $options{'time'} || time;
1293 my $date = $options{date} if $options{date}; # adjourn/suspend later
1294 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1296 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1297 dbh->rollback if $oldAutoCommit;
1298 return "Package $pkgnum expires before it would be suspended.";
1301 # some false laziness with sub cancel
1302 if ( !$options{nobill} && !$date && !$options{'from_cancel'} &&
1303 $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1304 # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1305 # make the entire cust_main->bill path recognize 'suspend' and
1306 # 'cancel' separately.
1307 warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1308 my $copy = $self->new({$self->hash});
1310 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1312 'time' => $suspend_time );
1313 warn "Error billing during suspend, custnum ".
1314 #$self->cust_main->custnum. ": $error"
1319 if ( $options{'reason'} ) {
1320 $error = $self->insert_reason( 'reason' => $options{'reason'},
1321 'action' => $date ? 'adjourn' : 'suspend',
1322 'date' => $date ? $date : $suspend_time,
1323 'reason_otaker' => $options{'reason_otaker'},
1326 dbh->rollback if $oldAutoCommit;
1327 return "Error inserting cust_pkg_reason: $error";
1331 # if a reasonnum was passed, get the actual reason object so we can check
1333 # (passing a reason hashref is still allowed, but it can't be used with
1334 # the fancy behavioral options.)
1337 if ($options{'reason'} =~ /^\d+$/) {
1338 $reason = FS::reason->by_key($options{'reason'});
1341 my %hash = $self->hash;
1343 $hash{'adjourn'} = $date;
1345 $hash{'susp'} = $suspend_time;
1348 my $resume_date = $options{'resume_date'} || 0;
1349 if ( $resume_date > ($date || $suspend_time) ) {
1350 $hash{'resume'} = $resume_date;
1353 $options{options} ||= {};
1355 my $new = new FS::cust_pkg ( \%hash );
1356 $error = $new->replace( $self, options => { $self->options,
1357 %{ $options{options} },
1361 $dbh->rollback if $oldAutoCommit;
1365 unless ( $date ) { # then we are suspending now
1367 unless ($options{'from_cancel'}) {
1368 # credit remaining time if appropriate
1369 # (if required by the package def, or the suspend reason)
1370 my $unused_credit = $self->part_pkg->option('unused_credit_suspend',1)
1371 || ( defined($reason) && $reason->unused_credit );
1373 if ( $unused_credit ) {
1374 warn "crediting unused time on pkg#".$self->pkgnum."\n" if $DEBUG;
1375 my $error = $self->credit_remaining('suspend', $suspend_time);
1377 $dbh->rollback if $oldAutoCommit;
1385 foreach my $cust_svc (
1386 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1388 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1390 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1391 $dbh->rollback if $oldAutoCommit;
1392 return "Illegal svcdb value in part_svc!";
1395 require "FS/$svcdb.pm";
1397 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1399 $error = $svc->suspend;
1401 $dbh->rollback if $oldAutoCommit;
1404 my( $label, $value ) = $cust_svc->label;
1405 push @labels, "$label: $value";
1409 my $conf = new FS::Conf;
1410 if ( $conf->config('suspend_email_admin') && !$options{'from_cancel'} ) {
1412 my $error = send_email(
1413 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1414 #invoice_from ??? well as good as any
1415 'to' => $conf->config('suspend_email_admin'),
1416 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1418 "This is an automatic message from your Freeside installation\n",
1419 "informing you that the following customer package has been suspended:\n",
1421 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1422 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1423 ( map { "Service : $_\n" } @labels ),
1425 'custnum' => $self->custnum,
1426 'msgtype' => 'admin'
1430 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1438 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1439 $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1441 $dbh->rollback if $oldAutoCommit;
1442 return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1446 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1451 =item credit_remaining MODE TIME
1453 Generate a credit for this package for the time remaining in the current
1454 billing period. MODE is either "suspend" or "cancel" (determines the
1455 credit type). TIME is the time of suspension/cancellation. Both arguments
1460 # Implementation note:
1462 # If you pkgpart-change a package that has been billed, and it's set to give
1463 # credit on package change, then this method gets called and then the new
1464 # package will have no last_bill date. Therefore the customer will be credited
1465 # only once (per billing period) even if there are multiple package changes.
1467 # If you location-change a package that has been billed, this method will NOT
1468 # be called and the new package WILL have the last bill date of the old
1471 # If the new package is then canceled within the same billing cycle,
1472 # credit_remaining needs to run calc_remain on the OLD package to determine
1473 # the amount of unused time to credit.
1475 sub credit_remaining {
1476 # Add a credit for remaining service
1477 my ($self, $mode, $time) = @_;
1478 die 'credit_remaining requires suspend or cancel'
1479 unless $mode eq 'suspend' or $mode eq 'cancel';
1480 die 'no suspend/cancel time' unless $time > 0;
1482 my $conf = FS::Conf->new;
1483 my $reason_type = $conf->config($mode.'_credit_type');
1485 my $last_bill = $self->getfield('last_bill') || 0;
1486 my $next_bill = $self->getfield('bill') || 0;
1487 if ( $last_bill > 0 # the package has been billed
1488 and $next_bill > 0 # the package has a next bill date
1489 and $next_bill >= $time # which is in the future
1491 my @cust_credit_source_bill_pkg = ();
1492 my $remaining_value = 0;
1494 my $remain_pkg = $self;
1495 $remaining_value = $remain_pkg->calc_remain(
1497 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1500 # we may have to walk back past some package changes to get to the
1501 # one that actually has unused time
1502 while ( $remaining_value == 0 ) {
1503 if ( $remain_pkg->change_pkgnum ) {
1504 $remain_pkg = FS::cust_pkg->by_key($remain_pkg->change_pkgnum);
1506 # the package has really never been billed
1509 $remaining_value = $remain_pkg->calc_remain(
1511 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1515 if ( $remaining_value > 0 ) {
1516 warn "Crediting for $remaining_value on package ".$self->pkgnum."\n"
1518 my $error = $self->cust_main->credit(
1520 'Credit for unused time on '. $self->part_pkg->pkg,
1521 'reason_type' => $reason_type,
1522 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1524 return "Error crediting customer \$$remaining_value for unused time".
1525 " on ". $self->part_pkg->pkg. ": $error"
1527 } #if $remaining_value
1528 } #if $last_bill, etc.
1532 =item unsuspend [ OPTION => VALUE ... ]
1534 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1535 package, then unsuspends the package itself (clears the susp field and the
1536 adjourn field if it is in the past). If the suspend reason includes an
1537 unsuspension package, that package will be ordered.
1539 Available options are:
1545 Can be set to a date to unsuspend the package in the future (the 'resume'
1548 =item adjust_next_bill
1550 Can be set true to adjust the next bill date forward by
1551 the amount of time the account was inactive. This was set true by default
1552 in the past (from 1.4.2 and 1.5.0pre6 through 1.7.0), but now needs to be
1553 explicitly requested with this option or in the price plan.
1557 If there is an error, returns the error, otherwise returns false.
1562 my( $self, %opt ) = @_;
1565 # pass all suspend/cancel actions to the main package
1566 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1567 return $self->main_pkg->unsuspend(%opt);
1570 my $oldAutoCommit = $FS::UID::AutoCommit;
1571 local $FS::UID::AutoCommit = 0;
1574 my $old = $self->select_for_update;
1576 my $pkgnum = $old->pkgnum;
1577 if ( $old->get('cancel') || $self->get('cancel') ) {
1578 $dbh->rollback if $oldAutoCommit;
1579 return "Can't unsuspend cancelled package $pkgnum";
1582 unless ( $old->get('susp') && $self->get('susp') ) {
1583 $dbh->rollback if $oldAutoCommit;
1584 return ""; # no error # complain instead?
1587 # handle the case of setting a future unsuspend (resume) date
1588 # and do not continue to actually unsuspend the package
1589 my $date = $opt{'date'};
1590 if ( $date and $date > time ) { # return an error if $date <= time?
1592 if ( $old->get('expire') && $old->get('expire') < $date ) {
1593 $dbh->rollback if $oldAutoCommit;
1594 return "Package $pkgnum expires before it would be unsuspended.";
1597 my $new = new FS::cust_pkg { $self->hash };
1598 $new->set('resume', $date);
1599 $error = $new->replace($self, options => $self->options);
1602 $dbh->rollback if $oldAutoCommit;
1606 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1612 if (!$self->setup) {
1613 # then this package is being released from on-hold status
1614 $self->set_initial_timers;
1619 foreach my $cust_svc (
1620 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1622 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1624 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1625 $dbh->rollback if $oldAutoCommit;
1626 return "Illegal svcdb value in part_svc!";
1629 require "FS/$svcdb.pm";
1631 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1633 $error = $svc->unsuspend;
1635 $dbh->rollback if $oldAutoCommit;
1638 my( $label, $value ) = $cust_svc->label;
1639 push @labels, "$label: $value";
1644 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1645 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1647 my %hash = $self->hash;
1648 my $inactive = time - $hash{'susp'};
1650 my $conf = new FS::Conf;
1652 #adjust the next bill date forward
1653 # increment next bill date if certain conditions are met:
1654 # - it was due to be billed at some point
1655 # - either the global or local config says to do this
1656 my $adjust_bill = 0;
1659 && ( $hash{'bill'} || $hash{'setup'} )
1660 && ( $opt{'adjust_next_bill'}
1661 || $conf->exists('unsuspend-always_adjust_next_bill_date')
1662 || $self->part_pkg->option('unsuspend_adjust_bill', 1)
1669 # - the package billed during suspension
1670 # - or it was ordered on hold
1671 # - or the customer was credited for the unused time
1673 if ( $self->option('suspend_bill',1)
1674 or ( $self->part_pkg->option('suspend_bill',1)
1675 and ! $self->option('no_suspend_bill',1)
1677 or $hash{'order_date'} == $hash{'susp'}
1678 or $self->part_pkg->option('unused_credit_suspend')
1679 or ( ref($reason) and $reason->unused_credit )
1684 # then add the length of time suspended to the bill date
1685 if ( $adjust_bill ) {
1686 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive
1690 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1691 $hash{'resume'} = '' if !$hash{'adjourn'};
1692 my $new = new FS::cust_pkg ( \%hash );
1693 $error = $new->replace( $self, options => { $self->options } );
1695 $dbh->rollback if $oldAutoCommit;
1701 if ( $reason && $reason->unsuspend_pkgpart ) {
1702 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
1703 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
1705 my $start_date = $self->cust_main->next_bill_date
1706 if $reason->unsuspend_hold;
1709 $unsusp_pkg = FS::cust_pkg->new({
1710 'custnum' => $self->custnum,
1711 'pkgpart' => $reason->unsuspend_pkgpart,
1712 'start_date' => $start_date,
1713 'locationnum' => $self->locationnum,
1714 # discount? probably not...
1717 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
1721 $dbh->rollback if $oldAutoCommit;
1726 if ( $conf->config('unsuspend_email_admin') ) {
1728 my $error = send_email(
1729 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1730 #invoice_from ??? well as good as any
1731 'to' => $conf->config('unsuspend_email_admin'),
1732 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
1733 "This is an automatic message from your Freeside installation\n",
1734 "informing you that the following customer package has been unsuspended:\n",
1736 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1737 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1738 ( map { "Service : $_\n" } @labels ),
1740 "An unsuspension fee was charged: ".
1741 $unsusp_pkg->part_pkg->pkg_comment."\n"
1745 'custnum' => $self->custnum,
1746 'msgtype' => 'admin',
1750 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
1756 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1757 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
1759 $dbh->rollback if $oldAutoCommit;
1760 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1764 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1771 Cancels any pending suspension (sets the adjourn field to null).
1773 If there is an error, returns the error, otherwise returns false.
1778 my( $self, %options ) = @_;
1781 my $oldAutoCommit = $FS::UID::AutoCommit;
1782 local $FS::UID::AutoCommit = 0;
1785 my $old = $self->select_for_update;
1787 my $pkgnum = $old->pkgnum;
1788 if ( $old->get('cancel') || $self->get('cancel') ) {
1789 dbh->rollback if $oldAutoCommit;
1790 return "Can't unadjourn cancelled package $pkgnum";
1791 # or at least it's pointless
1794 if ( $old->get('susp') || $self->get('susp') ) {
1795 dbh->rollback if $oldAutoCommit;
1796 return "Can't unadjourn suspended package $pkgnum";
1797 # perhaps this is arbitrary
1800 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1801 dbh->rollback if $oldAutoCommit;
1802 return ""; # no error
1805 my %hash = $self->hash;
1806 $hash{'adjourn'} = '';
1807 $hash{'resume'} = '';
1808 my $new = new FS::cust_pkg ( \%hash );
1809 $error = $new->replace( $self, options => { $self->options } );
1811 $dbh->rollback if $oldAutoCommit;
1815 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1822 =item change HASHREF | OPTION => VALUE ...
1824 Changes this package: cancels it and creates a new one, with a different
1825 pkgpart or locationnum or both. All services are transferred to the new
1826 package (no change will be made if this is not possible).
1828 Options may be passed as a list of key/value pairs or as a hash reference.
1835 New locationnum, to change the location for this package.
1839 New FS::cust_location object, to create a new location and assign it
1844 New FS::cust_main object, to create a new customer and assign the new package
1849 New pkgpart (see L<FS::part_pkg>).
1853 New refnum (see L<FS::part_referral>).
1857 New quantity; if unspecified, the new package will have the same quantity
1862 "New" (existing) FS::cust_pkg object. The package's services and other
1863 attributes will be transferred to this package.
1867 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1868 susp, adjourn, cancel, expire, and contract_end) to the new package.
1870 =item unprotect_svcs
1872 Normally, change() will rollback and return an error if some services
1873 can't be transferred (also see the I<cust_pkg-change_svcpart> config option).
1874 If unprotect_svcs is true, this method will transfer as many services as
1875 it can and then unconditionally cancel the old package.
1879 At least one of locationnum, cust_location, pkgpart, refnum, cust_main, or
1880 cust_pkg must be specified (otherwise, what's the point?)
1882 Returns either the new FS::cust_pkg object or a scalar error.
1886 my $err_or_new_cust_pkg = $old_cust_pkg->change
1890 #some false laziness w/order
1893 my $opt = ref($_[0]) ? shift : { @_ };
1895 my $conf = new FS::Conf;
1897 # Transactionize this whole mess
1898 my $oldAutoCommit = $FS::UID::AutoCommit;
1899 local $FS::UID::AutoCommit = 0;
1908 $hash{'setup'} = $time if $self->setup;
1910 $hash{'change_date'} = $time;
1911 $hash{"change_$_"} = $self->$_()
1912 foreach qw( pkgnum pkgpart locationnum );
1914 if ( $opt->{'cust_location'} ) {
1915 $error = $opt->{'cust_location'}->find_or_insert;
1917 $dbh->rollback if $oldAutoCommit;
1918 return "creating location record: $error";
1920 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1923 if ( $opt->{'cust_pkg'} ) {
1924 # treat changing to a package with a different pkgpart as a
1925 # pkgpart change (because it is)
1926 $opt->{'pkgpart'} = $opt->{'cust_pkg'}->pkgpart;
1929 # whether to override pkgpart checking on the new package
1930 my $same_pkgpart = 1;
1931 if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
1935 my $unused_credit = 0;
1936 my $keep_dates = $opt->{'keep_dates'};
1937 # Special case. If the pkgpart is changing, and the customer is
1938 # going to be credited for remaining time, don't keep setup, bill,
1939 # or last_bill dates, and DO pass the flag to cancel() to credit
1941 if ( $opt->{'pkgpart'}
1942 and $opt->{'pkgpart'} != $self->pkgpart
1943 and $self->part_pkg->option('unused_credit_change', 1) ) {
1946 $hash{$_} = '' foreach qw(setup bill last_bill);
1949 if ( $keep_dates ) {
1950 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1951 resume start_date contract_end ) ) {
1952 $hash{$date} = $self->getfield($date);
1955 # always keep this date, regardless of anything
1956 # (the date of the package change is in a different field)
1957 $hash{'order_date'} = $self->getfield('order_date');
1959 # allow $opt->{'locationnum'} = '' to specifically set it to null
1960 # (i.e. customer default location)
1961 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
1963 # usually this doesn't matter. the two cases where it does are:
1964 # 1. unused_credit_change + pkgpart change + setup fee on the new package
1966 # 2. (more importantly) changing a package before it's billed
1967 $hash{'waive_setup'} = $self->waive_setup;
1969 my $custnum = $self->custnum;
1970 if ( $opt->{cust_main} ) {
1971 my $cust_main = $opt->{cust_main};
1972 unless ( $cust_main->custnum ) {
1973 my $error = $cust_main->insert( @{ $opt->{cust_main_insert_args}||[] } );
1975 $dbh->rollback if $oldAutoCommit;
1976 return "inserting customer record: $error";
1979 $custnum = $cust_main->custnum;
1982 $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
1985 if ( $opt->{'cust_pkg'} ) {
1986 # The target package already exists; update it to show that it was
1987 # changed from this package.
1988 $cust_pkg = $opt->{'cust_pkg'};
1990 foreach ( qw( pkgnum pkgpart locationnum ) ) {
1991 $cust_pkg->set("change_$_", $self->get($_));
1993 $cust_pkg->set('change_date', $time);
1994 $error = $cust_pkg->replace;
1997 # Create the new package.
1998 $cust_pkg = new FS::cust_pkg {
1999 custnum => $custnum,
2000 locationnum => $opt->{'locationnum'},
2001 ( map { $_ => ( $opt->{$_} || $self->$_() ) }
2002 qw( pkgpart quantity refnum salesnum )
2006 $error = $cust_pkg->insert( 'change' => 1,
2007 'allow_pkgpart' => $same_pkgpart );
2010 $dbh->rollback if $oldAutoCommit;
2011 return "inserting new package: $error";
2014 # Transfer services and cancel old package.
2016 $error = $self->transfer($cust_pkg);
2017 if ($error and $error == 0) {
2018 # $old_pkg->transfer failed.
2019 $dbh->rollback if $oldAutoCommit;
2020 return "transferring $error";
2023 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2024 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2025 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
2026 if ($error and $error == 0) {
2027 # $old_pkg->transfer failed.
2028 $dbh->rollback if $oldAutoCommit;
2029 return "converting $error";
2033 # We set unprotect_svcs when executing a "future package change". It's
2034 # not a user-interactive operation, so returning an error means the
2035 # package change will just fail. Rather than have that happen, we'll
2036 # let leftover services be deleted.
2037 if ($error > 0 and !$opt->{'unprotect_svcs'}) {
2038 # Transfers were successful, but we still had services left on the old
2039 # package. We can't change the package under this circumstances, so abort.
2040 $dbh->rollback if $oldAutoCommit;
2041 return "unable to transfer all services";
2044 #reset usage if changing pkgpart
2045 # AND usage rollover is off (otherwise adds twice, now and at package bill)
2046 if ($self->pkgpart != $cust_pkg->pkgpart) {
2047 my $part_pkg = $cust_pkg->part_pkg;
2048 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
2052 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
2055 $dbh->rollback if $oldAutoCommit;
2056 return "setting usage values: $error";
2059 # if NOT changing pkgpart, transfer any usage pools over
2060 foreach my $usage ($self->cust_pkg_usage) {
2061 $usage->set('pkgnum', $cust_pkg->pkgnum);
2062 $error = $usage->replace;
2064 $dbh->rollback if $oldAutoCommit;
2065 return "transferring usage pools: $error";
2070 # transfer usage pricing add-ons, if we're not changing pkgpart
2071 if ( $same_pkgpart ) {
2072 foreach my $old_cust_pkg_usageprice ($self->cust_pkg_usageprice) {
2073 my $new_cust_pkg_usageprice = new FS::cust_pkg_usageprice {
2074 'pkgnum' => $cust_pkg->pkgnum,
2075 'usagepricepart' => $old_cust_pkg_usageprice->usagepricepart,
2076 'quantity' => $old_cust_pkg_usageprice->quantity,
2078 $error = $new_cust_pkg_usageprice->insert;
2080 $dbh->rollback if $oldAutoCommit;
2081 return "Error transferring usage pricing add-on: $error";
2086 # transfer discounts, if we're not changing pkgpart
2087 if ( $same_pkgpart ) {
2088 foreach my $old_discount ($self->cust_pkg_discount_active) {
2089 # don't remove the old discount, we may still need to bill that package.
2090 my $new_discount = new FS::cust_pkg_discount {
2091 'pkgnum' => $cust_pkg->pkgnum,
2092 'discountnum' => $old_discount->discountnum,
2093 'months_used' => $old_discount->months_used,
2095 $error = $new_discount->insert;
2097 $dbh->rollback if $oldAutoCommit;
2098 return "transferring discounts: $error";
2103 # transfer (copy) invoice details
2104 foreach my $detail ($self->cust_pkg_detail) {
2105 my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
2106 $new_detail->set('pkgdetailnum', '');
2107 $new_detail->set('pkgnum', $cust_pkg->pkgnum);
2108 $error = $new_detail->insert;
2110 $dbh->rollback if $oldAutoCommit;
2111 return "transferring package notes: $error";
2117 if ( !$opt->{'cust_pkg'} ) {
2118 # Order any supplemental packages.
2119 my $part_pkg = $cust_pkg->part_pkg;
2120 my @old_supp_pkgs = $self->supplemental_pkgs;
2121 foreach my $link ($part_pkg->supp_part_pkg_link) {
2123 foreach (@old_supp_pkgs) {
2124 if ($_->pkgpart == $link->dst_pkgpart) {
2126 $_->pkgpart(0); # so that it can't match more than once
2130 # false laziness with FS::cust_main::Packages::order_pkg
2131 my $new = FS::cust_pkg->new({
2132 pkgpart => $link->dst_pkgpart,
2133 pkglinknum => $link->pkglinknum,
2134 custnum => $custnum,
2135 main_pkgnum => $cust_pkg->pkgnum,
2136 locationnum => $cust_pkg->locationnum,
2137 start_date => $cust_pkg->start_date,
2138 order_date => $cust_pkg->order_date,
2139 expire => $cust_pkg->expire,
2140 adjourn => $cust_pkg->adjourn,
2141 contract_end => $cust_pkg->contract_end,
2142 refnum => $cust_pkg->refnum,
2143 discountnum => $cust_pkg->discountnum,
2144 waive_setup => $cust_pkg->waive_setup,
2146 if ( $old and $opt->{'keep_dates'} ) {
2147 foreach (qw(setup bill last_bill)) {
2148 $new->set($_, $old->get($_));
2151 $error = $new->insert( allow_pkgpart => $same_pkgpart );
2154 $error ||= $old->transfer($new);
2156 if ( $error and $error > 0 ) {
2157 # no reason why this should ever fail, but still...
2158 $error = "Unable to transfer all services from supplemental package ".
2162 $dbh->rollback if $oldAutoCommit;
2165 push @new_supp_pkgs, $new;
2167 } # if !$opt->{'cust_pkg'}
2168 # because if there is one, then supplemental packages would already
2169 # have been created for it.
2171 #Good to go, cancel old package. Notify 'cancel' of whether to credit
2173 #Don't allow billing the package (preceding period packages and/or
2174 #outstanding usage) if we are keeping dates (i.e. location changing),
2175 #because the new package will be billed for the same date range.
2176 #Supplemental packages are also canceled here.
2178 # during scheduled changes, avoid canceling the package we just
2180 $self->set('change_to_pkgnum' => '');
2182 $error = $self->cancel(
2184 unused_credit => $unused_credit,
2185 nobill => $keep_dates,
2186 change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2189 $dbh->rollback if $oldAutoCommit;
2190 return "canceling old package: $error";
2193 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2195 my $error = $cust_pkg->cust_main->bill(
2196 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2199 $dbh->rollback if $oldAutoCommit;
2200 return "billing new package: $error";
2204 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2210 =item change_later OPTION => VALUE...
2212 Schedule a package change for a later date. This actually orders the new
2213 package immediately, but sets its start date for a future date, and sets
2214 the current package to expire on the same date.
2216 If the package is already scheduled for a change, this can be called with
2217 'start_date' to change the scheduled date, or with pkgpart and/or
2218 locationnum to modify the package change. To cancel the scheduled change
2219 entirely, see C<abort_change>.
2227 The date for the package change. Required, and must be in the future.
2235 The pkgpart. locationnum, and quantity of the new package, with the same
2236 meaning as in C<change>.
2244 my $opt = ref($_[0]) ? shift : { @_ };
2246 my $oldAutoCommit = $FS::UID::AutoCommit;
2247 local $FS::UID::AutoCommit = 0;
2250 my $cust_main = $self->cust_main;
2252 my $date = delete $opt->{'start_date'} or return 'start_date required';
2254 if ( $date <= time ) {
2255 $dbh->rollback if $oldAutoCommit;
2256 return "start_date $date is in the past";
2261 if ( $self->change_to_pkgnum ) {
2262 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
2263 my $new_pkgpart = $opt->{'pkgpart'}
2264 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $change_to->pkgpart;
2265 my $new_locationnum = $opt->{'locationnum'}
2266 if $opt->{'locationnum'} and $opt->{'locationnum'} != $change_to->locationnum;
2267 my $new_quantity = $opt->{'quantity'}
2268 if $opt->{'quantity'} and $opt->{'quantity'} != $change_to->quantity;
2269 if ( $new_pkgpart or $new_locationnum or $new_quantity ) {
2270 # it hasn't been billed yet, so in principle we could just edit
2271 # it in place (w/o a package change), but that's bad form.
2272 # So change the package according to the new options...
2273 my $err_or_pkg = $change_to->change(%$opt);
2274 if ( ref $err_or_pkg ) {
2275 # Then set that package up for a future start.
2276 $self->set('change_to_pkgnum', $err_or_pkg->pkgnum);
2277 $self->set('expire', $date); # in case it's different
2278 $err_or_pkg->set('start_date', $date);
2279 $err_or_pkg->set('change_date', '');
2280 $err_or_pkg->set('change_pkgnum', '');
2282 $error = $self->replace ||
2283 $err_or_pkg->replace ||
2284 $change_to->cancel ||
2287 $error = $err_or_pkg;
2289 } else { # change the start date only.
2290 $self->set('expire', $date);
2291 $change_to->set('start_date', $date);
2292 $error = $self->replace || $change_to->replace;
2295 $dbh->rollback if $oldAutoCommit;
2298 $dbh->commit if $oldAutoCommit;
2301 } # if $self->change_to_pkgnum
2303 my $new_pkgpart = $opt->{'pkgpart'}
2304 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2305 my $new_locationnum = $opt->{'locationnum'}
2306 if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2307 my $new_quantity = $opt->{'quantity'}
2308 if $opt->{'quantity'} and $opt->{'quantity'} != $self->quantity;
2310 return '' unless $new_pkgpart or $new_locationnum or $new_quantity; # wouldn't do anything
2312 # allow $opt->{'locationnum'} = '' to specifically set it to null
2313 # (i.e. customer default location)
2314 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2316 my $new = FS::cust_pkg->new( {
2317 custnum => $self->custnum,
2318 locationnum => $opt->{'locationnum'},
2319 start_date => $date,
2320 map { $_ => ( $opt->{$_} || $self->$_() ) }
2321 qw( pkgpart quantity refnum salesnum )
2323 $error = $new->insert('change' => 1,
2324 'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2326 $self->set('change_to_pkgnum', $new->pkgnum);
2327 $self->set('expire', $date);
2328 $error = $self->replace;
2331 $dbh->rollback if $oldAutoCommit;
2333 $dbh->commit if $oldAutoCommit;
2341 Cancels a future package change scheduled by C<change_later>.
2347 my $pkgnum = $self->change_to_pkgnum;
2348 my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
2351 $error = $change_to->cancel || $change_to->delete;
2352 return $error if $error;
2354 $self->set('change_to_pkgnum', '');
2355 $self->set('expire', '');
2359 =item set_quantity QUANTITY
2361 Change the package's quantity field. This is one of the few package properties
2362 that can safely be changed without canceling and reordering the package
2363 (because it doesn't affect tax eligibility). Returns an error or an
2370 $self = $self->replace_old; # just to make sure
2371 $self->quantity(shift);
2375 =item set_salesnum SALESNUM
2377 Change the package's salesnum (sales person) field. This is one of the few
2378 package properties that can safely be changed without canceling and reordering
2379 the package (because it doesn't affect tax eligibility). Returns an error or
2386 $self = $self->replace_old; # just to make sure
2387 $self->salesnum(shift);
2389 # XXX this should probably reassign any credit that's already been given
2392 =item modify_charge OPTIONS
2394 Change the properties of a one-time charge. The following properties can
2395 be changed this way:
2396 - pkg: the package description
2397 - classnum: the package class
2398 - additional: arrayref of additional invoice details to add to this package
2400 and, I<if the charge has not yet been billed>:
2401 - start_date: the date when it will be billed
2402 - amount: the setup fee to be charged
2403 - quantity: the multiplier for the setup fee
2405 If you pass 'adjust_commission' => 1, and the classnum changes, and there are
2406 commission credits linked to this charge, they will be recalculated.
2413 my $part_pkg = $self->part_pkg;
2414 my $pkgnum = $self->pkgnum;
2417 my $oldAutoCommit = $FS::UID::AutoCommit;
2418 local $FS::UID::AutoCommit = 0;
2420 return "Can't use modify_charge except on one-time charges"
2421 unless $part_pkg->freq eq '0';
2423 if ( length($opt{'pkg'}) and $part_pkg->pkg ne $opt{'pkg'} ) {
2424 $part_pkg->set('pkg', $opt{'pkg'});
2427 my %pkg_opt = $part_pkg->options;
2428 my $pkg_opt_modified = 0;
2430 $opt{'additional'} ||= [];
2433 foreach (grep /^additional/, keys %pkg_opt) {
2434 ($i) = ($_ =~ /^additional_info(\d+)$/);
2435 $old_additional[$i] = $pkg_opt{$_} if $i;
2436 delete $pkg_opt{$_};
2439 for ( $i = 0; exists($opt{'additional'}->[$i]); $i++ ) {
2440 $pkg_opt{ "additional_info$i" } = $opt{'additional'}->[$i];
2441 if (!exists($old_additional[$i])
2442 or $old_additional[$i] ne $opt{'additional'}->[$i])
2444 $pkg_opt_modified = 1;
2447 $pkg_opt_modified = 1 if (scalar(@old_additional) - 1) != $i;
2448 $pkg_opt{'additional_count'} = $i if $i > 0;
2451 if ( exists($opt{'classnum'}) and $part_pkg->classnum ne $opt{'classnum'} )
2454 $old_classnum = $part_pkg->classnum;
2455 $part_pkg->set('classnum', $opt{'classnum'});
2458 if ( !$self->get('setup') ) {
2459 # not yet billed, so allow amount, setup_cost, quantity and start_date
2461 if ( exists($opt{'amount'})
2462 and $part_pkg->option('setup_fee') != $opt{'amount'}
2463 and $opt{'amount'} > 0 ) {
2465 $pkg_opt{'setup_fee'} = $opt{'amount'};
2466 $pkg_opt_modified = 1;
2469 if ( exists($opt{'setup_cost'})
2470 and $part_pkg->setup_cost != $opt{'setup_cost'}
2471 and $opt{'setup_cost'} > 0 ) {
2473 $part_pkg->set('setup_cost', $opt{'setup_cost'});
2476 if ( exists($opt{'quantity'})
2477 and $opt{'quantity'} != $self->quantity
2478 and $opt{'quantity'} > 0 ) {
2480 $self->set('quantity', $opt{'quantity'});
2483 if ( exists($opt{'start_date'})
2484 and $opt{'start_date'} != $self->start_date ) {
2486 $self->set('start_date', $opt{'start_date'});
2490 } # else simply ignore them; the UI shouldn't allow editing the fields
2493 if ( exists($opt{'taxclass'})
2494 and $part_pkg->taxclass ne $opt{'taxclass'}) {
2496 $part_pkg->set('taxclass', $opt{'taxclass'});
2500 if ( $part_pkg->modified or $pkg_opt_modified ) {
2501 # can we safely modify the package def?
2502 # Yes, if it's not available for purchase, and this is the only instance
2504 if ( $part_pkg->disabled
2505 and FS::cust_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 1
2506 and FS::quotation_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 0
2508 $error = $part_pkg->replace( options => \%pkg_opt );
2511 $part_pkg = $part_pkg->clone;
2512 $part_pkg->set('disabled' => 'Y');
2513 $error = $part_pkg->insert( options => \%pkg_opt );
2514 # and associate this as yet-unbilled package to the new package def
2515 $self->set('pkgpart' => $part_pkg->pkgpart);
2518 $dbh->rollback if $oldAutoCommit;
2523 if ($self->modified) { # for quantity or start_date change, or if we had
2524 # to clone the existing package def
2525 my $error = $self->replace;
2526 return $error if $error;
2528 if (defined $old_classnum) {
2529 # fix invoice grouping records
2530 my $old_catname = $old_classnum
2531 ? FS::pkg_class->by_key($old_classnum)->categoryname
2533 my $new_catname = $opt{'classnum'}
2534 ? $part_pkg->pkg_class->categoryname
2536 if ( $old_catname ne $new_catname ) {
2537 foreach my $cust_bill_pkg ($self->cust_bill_pkg) {
2538 # (there should only be one...)
2539 my @display = qsearch( 'cust_bill_pkg_display', {
2540 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2541 'section' => $old_catname,
2543 foreach (@display) {
2544 $_->set('section', $new_catname);
2545 $error = $_->replace;
2547 $dbh->rollback if $oldAutoCommit;
2551 } # foreach $cust_bill_pkg
2554 if ( $opt{'adjust_commission'} ) {
2555 # fix commission credits...tricky.
2556 foreach my $cust_event ($self->cust_event) {
2557 my $part_event = $cust_event->part_event;
2558 foreach my $table (qw(sales agent)) {
2560 "FS::part_event::Action::Mixin::credit_${table}_pkg_class";
2561 my $credit = qsearchs('cust_credit', {
2562 'eventnum' => $cust_event->eventnum,
2564 if ( $part_event->isa($class) ) {
2565 # Yes, this results in current commission rates being applied
2566 # retroactively to a one-time charge. For accounting purposes
2567 # there ought to be some kind of time limit on doing this.
2568 my $amount = $part_event->_calc_credit($self);
2569 if ( $credit and $credit->amount ne $amount ) {
2570 # Void the old credit.
2571 $error = $credit->void('Package class changed');
2573 $dbh->rollback if $oldAutoCommit;
2574 return "$error (adjusting commission credit)";
2577 # redo the event action to recreate the credit.
2579 eval { $part_event->do_action( $self, $cust_event ) };
2581 $dbh->rollback if $oldAutoCommit;
2584 } # if $part_event->isa($class)
2586 } # foreach $cust_event
2587 } # if $opt{'adjust_commission'}
2588 } # if defined $old_classnum
2590 $dbh->commit if $oldAutoCommit;
2597 sub process_bulk_cust_pkg {
2600 warn Dumper($param) if $DEBUG;
2602 my $old_part_pkg = qsearchs('part_pkg',
2603 { pkgpart => $param->{'old_pkgpart'} });
2604 my $new_part_pkg = qsearchs('part_pkg',
2605 { pkgpart => $param->{'new_pkgpart'} });
2606 die "Must select a new package type\n" unless $new_part_pkg;
2607 #my $keep_dates = $param->{'keep_dates'} || 0;
2608 my $keep_dates = 1; # there is no good reason to turn this off
2610 my $oldAutoCommit = $FS::UID::AutoCommit;
2611 local $FS::UID::AutoCommit = 0;
2614 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
2617 foreach my $old_cust_pkg ( @cust_pkgs ) {
2619 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
2620 if ( $old_cust_pkg->getfield('cancel') ) {
2621 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
2622 $old_cust_pkg->pkgnum."\n"
2626 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
2628 my $error = $old_cust_pkg->change(
2629 'pkgpart' => $param->{'new_pkgpart'},
2630 'keep_dates' => $keep_dates
2632 if ( !ref($error) ) { # change returns the cust_pkg on success
2634 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
2637 $dbh->commit if $oldAutoCommit;
2643 Returns the last bill date, or if there is no last bill date, the setup date.
2644 Useful for billing metered services.
2650 return $self->setfield('last_bill', $_[0]) if @_;
2651 return $self->getfield('last_bill') if $self->getfield('last_bill');
2652 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
2653 'edate' => $self->bill, } );
2654 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
2657 =item last_cust_pkg_reason ACTION
2659 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
2660 Returns false if there is no reason or the package is not currenly ACTION'd
2661 ACTION is one of adjourn, susp, cancel, or expire.
2665 sub last_cust_pkg_reason {
2666 my ( $self, $action ) = ( shift, shift );
2667 my $date = $self->get($action);
2669 'table' => 'cust_pkg_reason',
2670 'hashref' => { 'pkgnum' => $self->pkgnum,
2671 'action' => substr(uc($action), 0, 1),
2674 'order_by' => 'ORDER BY num DESC LIMIT 1',
2678 =item last_reason ACTION
2680 Returns the most recent ACTION FS::reason associated with the package.
2681 Returns false if there is no reason or the package is not currenly ACTION'd
2682 ACTION is one of adjourn, susp, cancel, or expire.
2687 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
2688 $cust_pkg_reason->reason
2689 if $cust_pkg_reason;
2694 Returns the definition for this billing item, as an FS::part_pkg object (see
2701 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
2702 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
2703 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
2708 Returns the cancelled package this package was changed from, if any.
2714 return '' unless $self->change_pkgnum;
2715 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
2718 =item change_cust_main
2720 Returns the customter this package was detached to, if any.
2724 sub change_cust_main {
2726 return '' unless $self->change_custnum;
2727 qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
2732 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
2739 $self->part_pkg->calc_setup($self, @_);
2744 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
2751 $self->part_pkg->calc_recur($self, @_);
2756 Calls the I<base_setup> of the FS::part_pkg object associated with this billing
2763 $self->part_pkg->base_setup($self, @_);
2768 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
2775 $self->part_pkg->base_recur($self, @_);
2780 Calls the I<calc_remain> of the FS::part_pkg object associated with this
2787 $self->part_pkg->calc_remain($self, @_);
2792 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
2799 $self->part_pkg->calc_cancel($self, @_);
2804 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
2810 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
2813 =item cust_pkg_detail [ DETAILTYPE ]
2815 Returns any customer package details for this package (see
2816 L<FS::cust_pkg_detail>).
2818 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2822 sub cust_pkg_detail {
2824 my %hash = ( 'pkgnum' => $self->pkgnum );
2825 $hash{detailtype} = shift if @_;
2827 'table' => 'cust_pkg_detail',
2828 'hashref' => \%hash,
2829 'order_by' => 'ORDER BY weight, pkgdetailnum',
2833 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
2835 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
2837 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2839 If there is an error, returns the error, otherwise returns false.
2843 sub set_cust_pkg_detail {
2844 my( $self, $detailtype, @details ) = @_;
2846 my $oldAutoCommit = $FS::UID::AutoCommit;
2847 local $FS::UID::AutoCommit = 0;
2850 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
2851 my $error = $current->delete;
2853 $dbh->rollback if $oldAutoCommit;
2854 return "error removing old detail: $error";
2858 foreach my $detail ( @details ) {
2859 my $cust_pkg_detail = new FS::cust_pkg_detail {
2860 'pkgnum' => $self->pkgnum,
2861 'detailtype' => $detailtype,
2862 'detail' => $detail,
2864 my $error = $cust_pkg_detail->insert;
2866 $dbh->rollback if $oldAutoCommit;
2867 return "error adding new detail: $error";
2872 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2879 Returns the customer billing events (see L<FS::cust_event>) for this invoice.
2883 #false laziness w/cust_bill.pm
2887 'table' => 'cust_event',
2888 'addl_from' => 'JOIN part_event USING ( eventpart )',
2889 'hashref' => { 'tablenum' => $self->pkgnum },
2890 'extra_sql' => " AND eventtable = 'cust_pkg' ",
2894 =item num_cust_event
2896 Returns the number of customer billing events (see L<FS::cust_event>) for this package.
2900 #false laziness w/cust_bill.pm
2901 sub num_cust_event {
2903 my $sql = "SELECT COUNT(*) ". $self->_from_cust_event_where;
2904 $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref->[0];
2907 =item exists_cust_event
2909 Returns true if there are customer billing events (see L<FS::cust_event>) for this package. More efficient than using num_cust_event.
2913 sub exists_cust_event {
2915 my $sql = "SELECT 1 ". $self->_from_cust_event_where. " LIMIT 1";
2916 my $row = $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref;
2917 $row ? $row->[0] : '';
2920 sub _from_cust_event_where {
2922 " FROM cust_event JOIN part_event USING ( eventpart ) ".
2923 " WHERE tablenum = ? AND eventtable = 'cust_pkg' ";
2927 my( $self, $sql, @args ) = @_;
2928 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
2929 $sth->execute(@args) or die $sth->errstr. " executing $sql";
2933 =item part_pkg_currency_option OPTIONNAME
2935 Returns a two item list consisting of the currency of this customer, if any,
2936 and a value for the provided option. If the customer has a currency, the value
2937 is the option value the given name and the currency (see
2938 L<FS::part_pkg_currency>). Otherwise, if the customer has no currency, is the
2939 regular option value for the given name (see L<FS::part_pkg_option>).
2943 sub part_pkg_currency_option {
2944 my( $self, $optionname ) = @_;
2945 my $part_pkg = $self->part_pkg;
2946 if ( my $currency = $self->cust_main->currency ) {
2947 ($currency, $part_pkg->part_pkg_currency_option($currency, $optionname) );
2949 ('', $part_pkg->option($optionname) );
2953 =item cust_svc [ SVCPART ] (old, deprecated usage)
2955 =item cust_svc [ OPTION => VALUE ... ] (current usage)
2957 =item cust_svc_unsorted [ OPTION => VALUE ... ]
2959 Returns the services for this package, as FS::cust_svc objects (see
2960 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
2961 spcififed, returns only the matching services.
2963 As an optimization, use the cust_svc_unsorted version if you are not displaying
2970 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
2971 $self->_sort_cust_svc( $self->cust_svc_unsorted_arrayref(@_) );
2974 sub cust_svc_unsorted {
2976 @{ $self->cust_svc_unsorted_arrayref(@_) };
2979 sub cust_svc_unsorted_arrayref {
2982 return [] unless $self->num_cust_svc(@_);
2985 if ( @_ && $_[0] =~ /^\d+/ ) {
2986 $opt{svcpart} = shift;
2987 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2994 'table' => 'cust_svc',
2995 'hashref' => { 'pkgnum' => $self->pkgnum },
2997 if ( $opt{svcpart} ) {
2998 $search{hashref}->{svcpart} = $opt{'svcpart'};
3000 if ( $opt{'svcdb'} ) {
3001 $search{addl_from} = ' LEFT JOIN part_svc USING ( svcpart ) ';
3002 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{'svcdb'} );
3005 [ qsearch(\%search) ];
3009 =item overlimit [ SVCPART ]
3011 Returns the services for this package which have exceeded their
3012 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
3013 is specified, return only the matching services.
3019 return () unless $self->num_cust_svc(@_);
3020 grep { $_->overlimit } $self->cust_svc(@_);
3023 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3025 Returns historical services for this package created before END TIMESTAMP and
3026 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
3027 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
3028 I<pkg_svc.hidden> flag will be omitted.
3034 warn "$me _h_cust_svc called on $self\n"
3037 my ($end, $start, $mode) = @_;
3039 local($FS::Record::qsearch_qualify_columns) = 0;
3041 my @cust_svc = $self->_sort_cust_svc(
3042 [ qsearch( 'h_cust_svc',
3043 { 'pkgnum' => $self->pkgnum, },
3044 FS::h_cust_svc->sql_h_search(@_),
3048 if ( defined($mode) && $mode eq 'I' ) {
3049 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
3050 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
3056 sub _sort_cust_svc {
3057 my( $self, $arrayref ) = @_;
3060 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
3062 my %pkg_svc = map { $_->svcpart => $_ }
3063 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
3068 my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
3070 $pkg_svc ? $pkg_svc->primary_svc : '',
3071 $pkg_svc ? $pkg_svc->quantity : 0,
3078 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
3080 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
3082 Returns the number of services for this package. Available options are svcpart
3083 and svcdb. If either is spcififed, returns only the matching services.
3090 return $self->{'_num_cust_svc'}
3092 && exists($self->{'_num_cust_svc'})
3093 && $self->{'_num_cust_svc'} =~ /\d/;
3095 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
3099 if ( @_ && $_[0] =~ /^\d+/ ) {
3100 $opt{svcpart} = shift;
3101 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3107 my $select = 'SELECT COUNT(*) FROM cust_svc ';
3108 my $where = ' WHERE pkgnum = ? ';
3109 my @param = ($self->pkgnum);
3111 if ( $opt{'svcpart'} ) {
3112 $where .= ' AND svcpart = ? ';
3113 push @param, $opt{'svcpart'};
3115 if ( $opt{'svcdb'} ) {
3116 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
3117 $where .= ' AND svcdb = ? ';
3118 push @param, $opt{'svcdb'};
3121 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
3122 $sth->execute(@param) or die $sth->errstr;
3123 $sth->fetchrow_arrayref->[0];
3126 =item available_part_svc
3128 Returns a list of FS::part_svc objects representing services included in this
3129 package but not yet provisioned. Each FS::part_svc object also has an extra
3130 field, I<num_avail>, which specifies the number of available services.
3134 sub available_part_svc {
3137 my $pkg_quantity = $self->quantity || 1;
3139 grep { $_->num_avail > 0 }
3141 my $part_svc = $_->part_svc;
3142 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
3143 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
3145 # more evil encapsulation breakage
3146 if($part_svc->{'Hash'}{'num_avail'} > 0) {
3147 my @exports = $part_svc->part_export_did;
3148 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
3153 $self->part_pkg->pkg_svc;
3156 =item part_svc [ OPTION => VALUE ... ]
3158 Returns a list of FS::part_svc objects representing provisioned and available
3159 services included in this package. Each FS::part_svc object also has the
3160 following extra fields:
3174 (services) - array reference containing the provisioned services, as cust_svc objects
3178 Accepts two options:
3182 =item summarize_size
3184 If true, will omit the extra cust_pkg_svc option for objects where num_cust_svc
3185 is this size or greater.
3187 =item hide_discontinued
3189 If true, will omit looking for services that are no longer avaialble in the
3197 #label -> ($cust_svc->label)[1]
3203 my $pkg_quantity = $self->quantity || 1;
3205 #XXX some sort of sort order besides numeric by svcpart...
3206 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
3208 my $part_svc = $pkg_svc->part_svc;
3209 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3210 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
3211 $part_svc->{'Hash'}{'num_avail'} =
3212 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
3213 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3214 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
3215 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
3216 && $num_cust_svc >= $opt{summarize_size};
3217 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
3219 } $self->part_pkg->pkg_svc;
3221 unless ( $opt{hide_discontinued} ) {
3223 push @part_svc, map {
3225 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3226 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
3227 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
3228 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3229 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
3231 } $self->extra_part_svc;
3238 =item extra_part_svc
3240 Returns a list of FS::part_svc objects corresponding to services in this
3241 package which are still provisioned but not (any longer) available in the
3246 sub extra_part_svc {
3249 my $pkgnum = $self->pkgnum;
3250 #my $pkgpart = $self->pkgpart;
3253 # 'table' => 'part_svc',
3256 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
3257 # WHERE pkg_svc.svcpart = part_svc.svcpart
3258 # AND pkg_svc.pkgpart = ?
3261 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
3262 # LEFT JOIN cust_pkg USING ( pkgnum )
3263 # WHERE cust_svc.svcpart = part_svc.svcpart
3266 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
3269 #seems to benchmark slightly faster... (or did?)
3271 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
3272 my $pkgparts = join(',', @pkgparts);
3275 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
3276 #MySQL doesn't grok DISINCT ON
3277 'select' => 'DISTINCT part_svc.*',
3278 'table' => 'part_svc',
3280 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
3281 AND pkg_svc.pkgpart IN ($pkgparts)
3284 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
3285 LEFT JOIN cust_pkg USING ( pkgnum )
3288 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
3289 'extra_param' => [ [$self->pkgnum=>'int'] ],
3295 Returns a short status string for this package, currently:
3301 =item not yet billed
3303 =item one-time charge
3318 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
3320 return 'cancelled' if $self->get('cancel');
3321 return 'on hold' if $self->susp && ! $self->setup;
3322 return 'suspended' if $self->susp;
3323 return 'not yet billed' unless $self->setup;
3324 return 'one-time charge' if $freq =~ /^(0|$)/;
3328 =item ucfirst_status
3330 Returns the status with the first character capitalized.
3334 sub ucfirst_status {
3335 ucfirst(shift->status);
3340 Class method that returns the list of possible status strings for packages
3341 (see L<the status method|/status>). For example:
3343 @statuses = FS::cust_pkg->statuses();
3347 tie my %statuscolor, 'Tie::IxHash',
3348 'on hold' => 'FF00F5', #brighter purple!
3349 'not yet billed' => '009999', #teal? cyan?
3350 'one-time charge' => '0000CC', #blue #'000000',
3351 'active' => '00CC00',
3352 'suspended' => 'FF9900',
3353 'cancelled' => 'FF0000',
3357 my $self = shift; #could be class...
3358 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
3359 # # mayble split btw one-time vs. recur
3370 Returns a hex triplet color string for this package's status.
3376 $statuscolor{$self->status};
3379 =item is_status_delay_cancel
3381 Returns true if part_pkg has option delay_cancel,
3382 cust_pkg status is 'suspended' and expire is set
3383 to cancel package within the next day (or however
3384 many days are set in global config part_pkg-delay_cancel-days.
3386 This is not a real status, this only meant for hacking display
3387 values, because otherwise treating the package as suspended is
3388 really the whole point of the delay_cancel option.
3392 sub is_status_delay_cancel {
3394 return 0 unless $self->part_pkg->option('delay_cancel',1);
3395 return 0 unless $self->status eq 'suspended';
3396 return 0 unless $self->expire;
3397 my $conf = new FS::Conf;
3398 my $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
3399 my $expsecs = 60*60*24*$expdays;
3400 return 0 unless $self->expire < time + $expsecs;
3406 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
3407 "pkg - comment" depending on user preference).
3413 my $label = $self->part_pkg->pkg_comment( cust_pkg=>$self, nopkgpart=>1 );
3414 $label = $self->pkgnum. ": $label"
3415 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
3419 =item pkg_label_long
3421 Returns a long label for this package, adding the primary service's label to
3426 sub pkg_label_long {
3428 my $label = $self->pkg_label;
3429 my $cust_svc = $self->primary_cust_svc;
3430 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
3436 Returns a customer-localized label for this package.
3442 $self->part_pkg->pkg_locale( $self->cust_main->locale );
3445 =item primary_cust_svc
3447 Returns a primary service (as FS::cust_svc object) if one can be identified.
3451 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
3453 sub primary_cust_svc {
3456 my @cust_svc = $self->cust_svc;
3458 return '' unless @cust_svc; #no serivces - irrelevant then
3460 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
3462 # primary service as specified in the package definition
3463 # or exactly one service definition with quantity one
3464 my $svcpart = $self->part_pkg->svcpart;
3465 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
3466 return $cust_svc[0] if scalar(@cust_svc) == 1;
3468 #couldn't identify one thing..
3474 Returns a list of lists, calling the label method for all services
3475 (see L<FS::cust_svc>) of this billing item.
3481 map { [ $_->label ] } $self->cust_svc;
3484 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3486 Like the labels method, but returns historical information on services that
3487 were active as of END_TIMESTAMP and (optionally) not cancelled before
3488 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
3489 I<pkg_svc.hidden> flag will be omitted.
3491 Returns a list of lists, calling the label method for all (historical) services
3492 (see L<FS::h_cust_svc>) of this billing item.
3498 warn "$me _h_labels called on $self\n"
3500 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
3505 Like labels, except returns a simple flat list, and shortens long
3506 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3507 identical services to one line that lists the service label and the number of
3508 individual services rather than individual items.
3513 shift->_labels_short( 'labels', @_ );
3516 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
3518 Like h_labels, except returns a simple flat list, and shortens long
3519 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3520 identical services to one line that lists the service label and the number of
3521 individual services rather than individual items.
3525 sub h_labels_short {
3526 shift->_labels_short( 'h_labels', @_ );
3530 my( $self, $method ) = ( shift, shift );
3532 warn "$me _labels_short called on $self with $method method\n"
3535 my $conf = new FS::Conf;
3536 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
3538 warn "$me _labels_short populating \%labels\n"
3542 #tie %labels, 'Tie::IxHash';
3543 push @{ $labels{$_->[0]} }, $_->[1]
3544 foreach $self->$method(@_);
3546 warn "$me _labels_short populating \@labels\n"
3550 foreach my $label ( keys %labels ) {
3552 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
3553 my $num = scalar(@values);
3554 warn "$me _labels_short $num items for $label\n"
3557 if ( $num > $max_same_services ) {
3558 warn "$me _labels_short more than $max_same_services, so summarizing\n"
3560 push @labels, "$label ($num)";
3562 if ( $conf->exists('cust_bill-consolidate_services') ) {
3563 warn "$me _labels_short consolidating services\n"
3565 # push @labels, "$label: ". join(', ', @values);
3567 my $detail = "$label: ";
3568 $detail .= shift(@values). ', '
3570 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
3572 push @labels, $detail;
3574 warn "$me _labels_short done consolidating services\n"
3577 warn "$me _labels_short adding service data\n"
3579 push @labels, map { "$label: $_" } @values;
3590 Returns the parent customer object (see L<FS::cust_main>).
3594 Returns the balance for this specific package, when using
3595 experimental package balance.
3601 $self->cust_main->balance_pkgnum( $self->pkgnum );
3604 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
3608 Returns the location object, if any (see L<FS::cust_location>).
3610 =item cust_location_or_main
3612 If this package is associated with a location, returns the locaiton (see
3613 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
3615 =item location_label [ OPTION => VALUE ... ]
3617 Returns the label of the location object (see L<FS::cust_location>).
3621 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
3623 =item tax_locationnum
3625 Returns the foreign key to a L<FS::cust_location> object for calculating
3626 tax on this package, as determined by the C<tax-pkg_address> and
3627 C<tax-ship_address> configuration flags.
3631 sub tax_locationnum {
3633 my $conf = FS::Conf->new;
3634 if ( $conf->exists('tax-pkg_address') ) {
3635 return $self->locationnum;
3637 elsif ( $conf->exists('tax-ship_address') ) {
3638 return $self->cust_main->ship_locationnum;
3641 return $self->cust_main->bill_locationnum;
3647 Returns the L<FS::cust_location> object for tax_locationnum.
3653 my $conf = FS::Conf->new;
3654 if ( $conf->exists('tax-pkg_address') and $self->locationnum ) {
3655 return FS::cust_location->by_key($self->locationnum);
3657 elsif ( $conf->exists('tax-ship_address') ) {
3658 return $self->cust_main->ship_location;
3661 return $self->cust_main->bill_location;
3665 =item seconds_since TIMESTAMP
3667 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
3668 package have been online since TIMESTAMP, according to the session monitor.
3670 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
3671 L<Time::Local> and L<Date::Parse> for conversion functions.
3676 my($self, $since) = @_;
3679 foreach my $cust_svc (
3680 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
3682 $seconds += $cust_svc->seconds_since($since);
3689 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
3691 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
3692 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
3695 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3696 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3702 sub seconds_since_sqlradacct {
3703 my($self, $start, $end) = @_;
3707 foreach my $cust_svc (
3709 my $part_svc = $_->part_svc;
3710 $part_svc->svcdb eq 'svc_acct'
3711 && scalar($part_svc->part_export_usage);
3714 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
3721 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
3723 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
3724 in this package for sessions ending between TIMESTAMP_START (inclusive) and
3728 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3729 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3734 sub attribute_since_sqlradacct {
3735 my($self, $start, $end, $attrib) = @_;
3739 foreach my $cust_svc (
3741 my $part_svc = $_->part_svc;
3742 scalar($part_svc->part_export_usage);
3745 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
3757 my( $self, $value ) = @_;
3758 if ( defined($value) ) {
3759 $self->setfield('quantity', $value);
3761 $self->getfield('quantity') || 1;
3764 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
3766 Transfers as many services as possible from this package to another package.
3768 The destination package can be specified by pkgnum by passing an FS::cust_pkg
3769 object. The destination package must already exist.
3771 Services are moved only if the destination allows services with the correct
3772 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
3773 this option with caution! No provision is made for export differences
3774 between the old and new service definitions. Probably only should be used
3775 when your exports for all service definitions of a given svcdb are identical.
3776 (attempt a transfer without it first, to move all possible svcpart-matching
3779 Any services that can't be moved remain in the original package.
3781 Returns an error, if there is one; otherwise, returns the number of services
3782 that couldn't be moved.
3787 my ($self, $dest_pkgnum, %opt) = @_;
3793 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
3794 $dest = $dest_pkgnum;
3795 $dest_pkgnum = $dest->pkgnum;
3797 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
3800 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
3802 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
3803 $target{$pkg_svc->svcpart} = $pkg_svc->quantity * ( $dest->quantity || 1 );
3806 foreach my $cust_svc ($dest->cust_svc) {
3807 $target{$cust_svc->svcpart}--;
3810 my %svcpart2svcparts = ();
3811 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3812 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
3813 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
3814 next if exists $svcpart2svcparts{$svcpart};
3815 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
3816 $svcpart2svcparts{$svcpart} = [
3818 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
3820 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
3821 'svcpart' => $_ } );
3823 $pkg_svc ? $pkg_svc->primary_svc : '',
3824 $pkg_svc ? $pkg_svc->quantity : 0,
3828 grep { $_ != $svcpart }
3830 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
3832 warn "alternates for svcpart $svcpart: ".
3833 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
3839 foreach my $cust_svc ($self->cust_svc) {
3840 my $svcnum = $cust_svc->svcnum;
3841 if($target{$cust_svc->svcpart} > 0
3842 or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
3843 $target{$cust_svc->svcpart}--;
3844 my $new = new FS::cust_svc { $cust_svc->hash };
3845 $new->pkgnum($dest_pkgnum);
3846 $error = $new->replace($cust_svc);
3847 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3849 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
3850 warn "alternates to consider: ".
3851 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
3853 my @alternate = grep {
3854 warn "considering alternate svcpart $_: ".
3855 "$target{$_} available in new package\n"
3858 } @{$svcpart2svcparts{$cust_svc->svcpart}};
3860 warn "alternate(s) found\n" if $DEBUG;
3861 my $change_svcpart = $alternate[0];
3862 $target{$change_svcpart}--;
3863 my $new = new FS::cust_svc { $cust_svc->hash };
3864 $new->svcpart($change_svcpart);
3865 $new->pkgnum($dest_pkgnum);
3866 $error = $new->replace($cust_svc);
3874 my @label = $cust_svc->label;
3875 return "$label[0] $label[1]: $error";
3881 =item grab_svcnums SVCNUM, SVCNUM ...
3883 Change the pkgnum for the provided services to this packages. If there is an
3884 error, returns the error, otherwise returns false.
3892 my $oldAutoCommit = $FS::UID::AutoCommit;
3893 local $FS::UID::AutoCommit = 0;
3896 foreach my $svcnum (@svcnum) {
3897 my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
3898 $dbh->rollback if $oldAutoCommit;
3899 return "unknown svcnum $svcnum";
3901 $cust_svc->pkgnum( $self->pkgnum );
3902 my $error = $cust_svc->replace;
3904 $dbh->rollback if $oldAutoCommit;
3909 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3916 This method is deprecated. See the I<depend_jobnum> option to the insert and
3917 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
3921 #looks like this is still used by the order_pkg and change_pkg methods in
3922 # ClientAPI/MyAccount, need to look into those before removing
3926 my $oldAutoCommit = $FS::UID::AutoCommit;
3927 local $FS::UID::AutoCommit = 0;
3930 foreach my $cust_svc ( $self->cust_svc ) {
3931 #false laziness w/svc_Common::insert
3932 my $svc_x = $cust_svc->svc_x;
3933 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
3934 my $error = $part_export->export_insert($svc_x);
3936 $dbh->rollback if $oldAutoCommit;
3942 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3947 =item export_pkg_change OLD_CUST_PKG
3949 Calls the "pkg_change" export action for all services attached to this package.
3953 sub export_pkg_change {
3954 my( $self, $old ) = ( shift, shift );
3956 my $oldAutoCommit = $FS::UID::AutoCommit;
3957 local $FS::UID::AutoCommit = 0;
3960 foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
3961 my $error = $svc_x->export('pkg_change', $self, $old);
3963 $dbh->rollback if $oldAutoCommit;
3968 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3975 Associates this package with a (suspension or cancellation) reason (see
3976 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
3979 Available options are:
3985 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.
3989 the access_user (see L<FS::access_user>) providing the reason
3997 the action (cancel, susp, adjourn, expire) associated with the reason
4001 If there is an error, returns the error, otherwise returns false.
4006 my ($self, %options) = @_;
4008 my $otaker = $options{reason_otaker} ||
4009 $FS::CurrentUser::CurrentUser->username;
4012 if ( $options{'reason'} =~ /^(\d+)$/ ) {
4016 } elsif ( ref($options{'reason'}) ) {
4018 return 'Enter a new reason (or select an existing one)'
4019 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
4021 my $reason = new FS::reason({
4022 'reason_type' => $options{'reason'}->{'typenum'},
4023 'reason' => $options{'reason'}->{'reason'},
4025 my $error = $reason->insert;
4026 return $error if $error;
4028 $reasonnum = $reason->reasonnum;
4031 return "Unparseable reason: ". $options{'reason'};
4034 my $cust_pkg_reason =
4035 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
4036 'reasonnum' => $reasonnum,
4037 'otaker' => $otaker,
4038 'action' => substr(uc($options{'action'}),0,1),
4039 'date' => $options{'date'}
4044 $cust_pkg_reason->insert;
4047 =item insert_discount
4049 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
4050 inserting a new discount on the fly (see L<FS::discount>).
4052 Available options are:
4060 If there is an error, returns the error, otherwise returns false.
4064 sub insert_discount {
4065 #my ($self, %options) = @_;
4068 my $cust_pkg_discount = new FS::cust_pkg_discount {
4069 'pkgnum' => $self->pkgnum,
4070 'discountnum' => $self->discountnum,
4072 'end_date' => '', #XXX
4073 #for the create a new discount case
4074 '_type' => $self->discountnum__type,
4075 'amount' => $self->discountnum_amount,
4076 'percent' => $self->discountnum_percent,
4077 'months' => $self->discountnum_months,
4078 'setup' => $self->discountnum_setup,
4079 #'disabled' => $self->discountnum_disabled,
4082 $cust_pkg_discount->insert;
4085 =item set_usage USAGE_VALUE_HASHREF
4087 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4088 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4089 upbytes, downbytes, and totalbytes are appropriate keys.
4091 All svc_accts which are part of this package have their values reset.
4096 my ($self, $valueref, %opt) = @_;
4098 #only svc_acct can set_usage for now
4099 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4100 my $svc_x = $cust_svc->svc_x;
4101 $svc_x->set_usage($valueref, %opt)
4102 if $svc_x->can("set_usage");
4106 =item recharge USAGE_VALUE_HASHREF
4108 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4109 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4110 upbytes, downbytes, and totalbytes are appropriate keys.
4112 All svc_accts which are part of this package have their values incremented.
4117 my ($self, $valueref) = @_;
4119 #only svc_acct can set_usage for now
4120 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4121 my $svc_x = $cust_svc->svc_x;
4122 $svc_x->recharge($valueref)
4123 if $svc_x->can("recharge");
4127 =item apply_usageprice
4131 sub apply_usageprice {
4134 my $oldAutoCommit = $FS::UID::AutoCommit;
4135 local $FS::UID::AutoCommit = 0;
4140 foreach my $cust_pkg_usageprice ( $self->cust_pkg_usageprice ) {
4141 $error ||= $cust_pkg_usageprice->apply;
4145 $dbh->rollback if $oldAutoCommit;
4146 die "error applying part_pkg_usageprice add-ons, pkgnum ". $self->pkgnum.
4149 $dbh->commit if $oldAutoCommit;
4155 =item cust_pkg_discount
4157 =item cust_pkg_discount_active
4161 sub cust_pkg_discount_active {
4163 grep { $_->status eq 'active' } $self->cust_pkg_discount;
4166 =item cust_pkg_usage
4168 Returns a list of all voice usage counters attached to this package.
4170 =item apply_usage OPTIONS
4172 Takes the following options:
4173 - cdr: a call detail record (L<FS::cdr>)
4174 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
4175 - minutes: the maximum number of minutes to be charged
4177 Finds available usage minutes for a call of this class, and subtracts
4178 up to that many minutes from the usage pool. If the usage pool is empty,
4179 and the C<cdr-minutes_priority> global config option is set, minutes may
4180 be taken from other calls as well. Either way, an allocation record will
4181 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
4182 number of minutes of usage applied to the call.
4187 my ($self, %opt) = @_;
4188 my $cdr = $opt{cdr};
4189 my $rate_detail = $opt{rate_detail};
4190 my $minutes = $opt{minutes};
4191 my $classnum = $rate_detail->classnum;
4192 my $pkgnum = $self->pkgnum;
4193 my $custnum = $self->custnum;
4195 my $oldAutoCommit = $FS::UID::AutoCommit;
4196 local $FS::UID::AutoCommit = 0;
4199 my $order = FS::Conf->new->config('cdr-minutes_priority');
4203 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
4205 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
4207 my @usage_recs = qsearch({
4208 'table' => 'cust_pkg_usage',
4209 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
4210 ' JOIN cust_pkg USING (pkgnum)'.
4211 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
4212 'select' => 'cust_pkg_usage.*',
4213 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
4214 " ( cust_pkg.custnum = $custnum AND ".
4215 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4216 $is_classnum . ' AND '.
4217 " cust_pkg_usage.minutes > 0",
4218 'order_by' => " ORDER BY priority ASC",
4221 my $orig_minutes = $minutes;
4223 while (!$error and $minutes > 0 and @usage_recs) {
4224 my $cust_pkg_usage = shift @usage_recs;
4225 $cust_pkg_usage->select_for_update;
4226 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
4227 pkgusagenum => $cust_pkg_usage->pkgusagenum,
4228 acctid => $cdr->acctid,
4229 minutes => min($cust_pkg_usage->minutes, $minutes),
4231 $cust_pkg_usage->set('minutes',
4232 $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes
4234 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
4235 $minutes -= $cdr_cust_pkg_usage->minutes;
4237 if ( $order and $minutes > 0 and !$error ) {
4238 # then try to steal minutes from another call
4240 'table' => 'cdr_cust_pkg_usage',
4241 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
4242 ' JOIN part_pkg_usage USING (pkgusagepart)'.
4243 ' JOIN cust_pkg USING (pkgnum)'.
4244 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
4245 ' JOIN cdr USING (acctid)',
4246 'select' => 'cdr_cust_pkg_usage.*',
4247 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
4248 " ( cust_pkg.pkgnum = $pkgnum OR ".
4249 " ( cust_pkg.custnum = $custnum AND ".
4250 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4251 " part_pkg_usage_class.classnum = $classnum",
4252 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
4254 if ( $order eq 'time' ) {
4255 # find CDRs that are using minutes, but have a later startdate
4257 my $startdate = $cdr->startdate;
4258 if ($startdate !~ /^\d+$/) {
4259 die "bad cdr startdate '$startdate'";
4261 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
4262 # minimize needless reshuffling
4263 $search{'order_by'} .= ', cdr.startdate DESC';
4265 # XXX may not work correctly with rate_time schedules. Could
4266 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
4268 $search{'addl_from'} .=
4269 ' JOIN rate_detail'.
4270 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
4271 if ( $order eq 'rate_high' ) {
4272 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
4273 $rate_detail->min_charge;
4274 $search{'order_by'} .= ', rate_detail.min_charge ASC';
4275 } elsif ( $order eq 'rate_low' ) {
4276 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
4277 $rate_detail->min_charge;
4278 $search{'order_by'} .= ', rate_detail.min_charge DESC';
4280 # this should really never happen
4281 die "invalid cdr-minutes_priority value '$order'\n";
4284 my @cdr_usage_recs = qsearch(\%search);
4286 while (!$error and @cdr_usage_recs and $minutes > 0) {
4287 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
4288 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
4289 my $old_cdr = $cdr_cust_pkg_usage->cdr;
4290 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
4291 $cdr_cust_pkg_usage->select_for_update;
4292 $old_cdr->select_for_update;
4293 $cust_pkg_usage->select_for_update;
4294 # in case someone else stole the usage from this CDR
4295 # while waiting for the lock...
4296 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
4297 # steal the usage allocation and flag the old CDR for reprocessing
4298 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
4299 # if the allocation is more minutes than we need, adjust it...
4300 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
4302 $cdr_cust_pkg_usage->set('minutes', $minutes);
4303 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
4304 $error = $cust_pkg_usage->replace;
4306 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
4307 $error ||= $cdr_cust_pkg_usage->replace;
4308 # deduct the stolen minutes
4309 $minutes -= $cdr_cust_pkg_usage->minutes;
4311 # after all minute-stealing is done, reset the affected CDRs
4312 foreach (values %reproc_cdrs) {
4313 $error ||= $_->set_status('');
4314 # XXX or should we just call $cdr->rate right here?
4315 # it's not like we can create a loop this way, since the min_charge
4316 # or call time has to go monotonically in one direction.
4317 # we COULD get some very deep recursions going, though...
4319 } # if $order and $minutes
4322 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
4324 $dbh->commit if $oldAutoCommit;
4325 return $orig_minutes - $minutes;
4329 =item supplemental_pkgs
4331 Returns a list of all packages supplemental to this one.
4335 sub supplemental_pkgs {
4337 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
4342 Returns the package that this one is supplemental to, if any.
4348 if ( $self->main_pkgnum ) {
4349 return FS::cust_pkg->by_key($self->main_pkgnum);
4356 =head1 CLASS METHODS
4362 Returns an SQL expression identifying recurring packages.
4366 sub recurring_sql { "
4367 '0' != ( select freq from part_pkg
4368 where cust_pkg.pkgpart = part_pkg.pkgpart )
4373 Returns an SQL expression identifying one-time packages.
4378 '0' = ( select freq from part_pkg
4379 where cust_pkg.pkgpart = part_pkg.pkgpart )
4384 Returns an SQL expression identifying ordered packages (recurring packages not
4390 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
4395 Returns an SQL expression identifying active packages.
4400 $_[0]->recurring_sql. "
4401 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4402 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4403 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4406 =item not_yet_billed_sql
4408 Returns an SQL expression identifying packages which have not yet been billed.
4412 sub not_yet_billed_sql { "
4413 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4414 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4415 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4420 Returns an SQL expression identifying inactive packages (one-time packages
4421 that are otherwise unsuspended/uncancelled).
4425 sub inactive_sql { "
4426 ". $_[0]->onetime_sql(). "
4427 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4428 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4429 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4434 Returns an SQL expression identifying on-hold packages.
4439 #$_[0]->recurring_sql(). ' AND '.
4441 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4442 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4443 AND ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4450 Returns an SQL expression identifying suspended packages.
4454 sub suspended_sql { susp_sql(@_); }
4456 #$_[0]->recurring_sql(). ' AND '.
4458 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4459 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4460 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4467 Returns an SQL exprression identifying cancelled packages.
4471 sub cancelled_sql { cancel_sql(@_); }
4473 #$_[0]->recurring_sql(). ' AND '.
4474 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
4479 Returns an SQL expression to give the package status as a string.
4485 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
4486 WHEN ( cust_pkg.susp IS NOT NULL AND cust_pkg.setup IS NULL ) THEN 'on hold'
4487 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
4488 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
4489 WHEN ".onetime_sql()." THEN 'one-time charge'
4496 Returns a list of two package counts. The first is a count of packages
4497 based on the supplied criteria and the second is the count of residential
4498 packages with those same criteria. Criteria are specified as in the search
4504 my ($class, $params) = @_;
4506 my $sql_query = $class->search( $params );
4508 my $count_sql = delete($sql_query->{'count_query'});
4509 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
4510 or die "couldn't parse count_sql";
4512 my $count_sth = dbh->prepare($count_sql)
4513 or die "Error preparing $count_sql: ". dbh->errstr;
4515 or die "Error executing $count_sql: ". $count_sth->errstr;
4516 my $count_arrayref = $count_sth->fetchrow_arrayref;
4518 return ( @$count_arrayref );
4522 =item tax_locationnum_sql
4524 Returns an SQL expression for the tax location for a package, based
4525 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
4529 sub tax_locationnum_sql {
4530 my $conf = FS::Conf->new;
4531 if ( $conf->exists('tax-pkg_address') ) {
4532 'cust_pkg.locationnum';
4534 elsif ( $conf->exists('tax-ship_address') ) {
4535 'cust_main.ship_locationnum';
4538 'cust_main.bill_locationnum';
4544 Returns a list: the first item is an SQL fragment identifying matching
4545 packages/customers via location (taking into account shipping and package
4546 address taxation, if enabled), and subsequent items are the parameters to
4547 substitute for the placeholders in that fragment.
4552 my($class, %opt) = @_;
4553 my $ornull = $opt{'ornull'};
4555 my $conf = new FS::Conf;
4557 # '?' placeholders in _location_sql_where
4558 my $x = $ornull ? 3 : 2;
4569 if ( $conf->exists('tax-ship_address') ) {
4572 ( ( ship_last IS NULL OR ship_last = '' )
4573 AND ". _location_sql_where('cust_main', '', $ornull ). "
4575 OR ( ship_last IS NOT NULL AND ship_last != ''
4576 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
4579 # AND payby != 'COMP'
4581 @main_param = ( @bill_param, @bill_param );
4585 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
4586 @main_param = @bill_param;
4592 if ( $conf->exists('tax-pkg_address') ) {
4594 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
4597 ( cust_pkg.locationnum IS NULL AND $main_where )
4598 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
4601 @param = ( @main_param, @bill_param );
4605 $where = $main_where;
4606 @param = @main_param;
4614 #subroutine, helper for location_sql
4615 sub _location_sql_where {
4617 my $prefix = @_ ? shift : '';
4618 my $ornull = @_ ? shift : '';
4620 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
4622 $ornull = $ornull ? ' OR ? IS NULL ' : '';
4624 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
4625 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
4626 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
4628 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
4630 # ( $table.${prefix}city = ? $or_empty_city $ornull )
4632 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4633 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4634 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
4635 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
4636 AND $table.${prefix}country = ?
4641 my( $self, $what ) = @_;
4643 my $what_show_zero = $what. '_show_zero';
4644 length($self->$what_show_zero())
4645 ? ($self->$what_show_zero() eq 'Y')
4646 : $self->part_pkg->$what_show_zero();
4653 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
4655 CUSTNUM is a customer (see L<FS::cust_main>)
4657 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4658 L<FS::part_pkg>) to order for this customer. Duplicates are of course
4661 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
4662 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
4663 new billing items. An error is returned if this is not possible (see
4664 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
4667 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4668 newly-created cust_pkg objects.
4670 REFNUM, if specified, will specify the FS::pkg_referral record to be created
4671 and inserted. Multiple FS::pkg_referral records can be created by
4672 setting I<refnum> to an array reference of refnums or a hash reference with
4673 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
4674 record will be created corresponding to cust_main.refnum.
4679 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
4681 my $conf = new FS::Conf;
4683 # Transactionize this whole mess
4684 my $oldAutoCommit = $FS::UID::AutoCommit;
4685 local $FS::UID::AutoCommit = 0;
4689 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
4690 # return "Customer not found: $custnum" unless $cust_main;
4692 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
4695 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4698 my $change = scalar(@old_cust_pkg) != 0;
4701 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
4703 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
4704 " to pkgpart ". $pkgparts->[0]. "\n"
4707 my $err_or_cust_pkg =
4708 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
4709 'refnum' => $refnum,
4712 unless (ref($err_or_cust_pkg)) {
4713 $dbh->rollback if $oldAutoCommit;
4714 return $err_or_cust_pkg;
4717 push @$return_cust_pkg, $err_or_cust_pkg;
4718 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4723 # Create the new packages.
4724 foreach my $pkgpart (@$pkgparts) {
4726 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
4728 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
4729 pkgpart => $pkgpart,
4733 $error = $cust_pkg->insert( 'change' => $change );
4734 push @$return_cust_pkg, $cust_pkg;
4736 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
4737 my $supp_pkg = FS::cust_pkg->new({
4738 custnum => $custnum,
4739 pkgpart => $link->dst_pkgpart,
4741 main_pkgnum => $cust_pkg->pkgnum,
4744 $error ||= $supp_pkg->insert( 'change' => $change );
4745 push @$return_cust_pkg, $supp_pkg;
4749 $dbh->rollback if $oldAutoCommit;
4754 # $return_cust_pkg now contains refs to all of the newly
4757 # Transfer services and cancel old packages.
4758 foreach my $old_pkg (@old_cust_pkg) {
4760 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
4763 foreach my $new_pkg (@$return_cust_pkg) {
4764 $error = $old_pkg->transfer($new_pkg);
4765 if ($error and $error == 0) {
4766 # $old_pkg->transfer failed.
4767 $dbh->rollback if $oldAutoCommit;
4772 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
4773 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
4774 foreach my $new_pkg (@$return_cust_pkg) {
4775 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
4776 if ($error and $error == 0) {
4777 # $old_pkg->transfer failed.
4778 $dbh->rollback if $oldAutoCommit;
4785 # Transfers were successful, but we went through all of the
4786 # new packages and still had services left on the old package.
4787 # We can't cancel the package under the circumstances, so abort.
4788 $dbh->rollback if $oldAutoCommit;
4789 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
4791 $error = $old_pkg->cancel( quiet=>1 );
4797 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4801 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
4803 A bulk change method to change packages for multiple customers.
4805 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4806 L<FS::part_pkg>) to order for each customer. Duplicates are of course
4809 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
4810 replace. The services (see L<FS::cust_svc>) are moved to the
4811 new billing items. An error is returned if this is not possible (see
4814 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4815 newly-created cust_pkg objects.
4820 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
4822 # Transactionize this whole mess
4823 my $oldAutoCommit = $FS::UID::AutoCommit;
4824 local $FS::UID::AutoCommit = 0;
4828 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4831 while(scalar(@old_cust_pkg)) {
4833 my $custnum = $old_cust_pkg[0]->custnum;
4834 my (@remove) = map { $_->pkgnum }
4835 grep { $_->custnum == $custnum } @old_cust_pkg;
4836 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
4838 my $error = order $custnum, $pkgparts, \@remove, \@return;
4840 push @errors, $error
4842 push @$return_cust_pkg, @return;
4845 if (scalar(@errors)) {
4846 $dbh->rollback if $oldAutoCommit;
4847 return join(' / ', @errors);
4850 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4854 # Used by FS::Upgrade to migrate to a new database.
4855 sub _upgrade_data { # class method
4856 my ($class, %opts) = @_;
4857 $class->_upgrade_otaker(%opts);
4859 # RT#10139, bug resulting in contract_end being set when it shouldn't
4860 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
4861 # RT#10830, bad calculation of prorate date near end of year
4862 # the date range for bill is December 2009, and we move it forward
4863 # one year if it's before the previous bill date (which it should
4865 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
4866 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
4867 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
4868 # RT6628, add order_date to cust_pkg
4869 'update cust_pkg set order_date = (select history_date from h_cust_pkg
4870 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
4871 history_action = \'insert\') where order_date is null',
4873 foreach my $sql (@statements) {
4874 my $sth = dbh->prepare($sql);
4875 $sth->execute or die $sth->errstr;
4878 # RT31194: supplemental package links that are deleted don't clean up
4880 my @pkglinknums = qsearch({
4881 'select' => 'DISTINCT cust_pkg.pkglinknum',
4882 'table' => 'cust_pkg',
4883 'addl_from' => ' LEFT JOIN part_pkg_link USING (pkglinknum) ',
4884 'extra_sql' => ' WHERE cust_pkg.pkglinknum IS NOT NULL
4885 AND part_pkg_link.pkglinknum IS NULL',
4887 foreach (@pkglinknums) {
4888 my $pkglinknum = $_->pkglinknum;
4889 warn "cleaning part_pkg_link #$pkglinknum\n";
4890 my $part_pkg_link = FS::part_pkg_link->new({pkglinknum => $pkglinknum});
4891 my $error = $part_pkg_link->remove_linked;
4892 die $error if $error;
4900 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
4902 In sub order, the @pkgparts array (passed by reference) is clobbered.
4904 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
4905 method to pass dates to the recur_prog expression, it should do so.
4907 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
4908 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
4909 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
4910 configuration values. Probably need a subroutine which decides what to do
4911 based on whether or not we've fetched the user yet, rather than a hash. See
4912 FS::UID and the TODO.
4914 Now that things are transactional should the check in the insert method be
4919 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
4920 L<FS::pkg_svc>, schema.html from the base documentation