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_flag('no_auto', [ '', 'Y' ])
671 || $self->ut_flag('waive_setup', [ '', 'Y' ])
672 || $self->ut_flag('separate_bill')
673 || $self->ut_textn('agent_pkgid')
674 || $self->ut_enum('recur_show_zero', [ '', 'Y', 'N', ])
675 || $self->ut_enum('setup_show_zero', [ '', 'Y', 'N', ])
676 || $self->ut_foreign_keyn('main_pkgnum', 'cust_pkg', 'pkgnum')
677 || $self->ut_foreign_keyn('pkglinknum', 'part_pkg_link', 'pkglinknum')
678 || $self->ut_foreign_keyn('change_to_pkgnum', 'cust_pkg', 'pkgnum')
680 return $error if $error;
682 return "A package with both start date (future start) and setup date (already started) will never bill"
683 if $self->start_date && $self->setup && ! $upgrade;
685 return "A future unsuspend date can only be set for a package with a suspend date"
686 if $self->resume and !$self->susp and !$self->adjourn;
688 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
690 if ( $self->dbdef_table->column('manual_flag') ) {
691 $self->manual_flag('') if $self->manual_flag eq ' ';
692 $self->manual_flag =~ /^([01]?)$/
693 or return "Illegal manual_flag ". $self->manual_flag;
694 $self->manual_flag($1);
702 Check the pkgpart to make sure it's allowed with the reg_code and/or
703 promo_code of the package (if present) and with the customer's agent.
704 Called from C<insert>, unless we are doing a package change that doesn't
712 # my $error = $self->ut_numbern('pkgpart'); # already done
715 if ( $self->reg_code ) {
717 unless ( grep { $self->pkgpart == $_->pkgpart }
718 map { $_->reg_code_pkg }
719 qsearchs( 'reg_code', { 'code' => $self->reg_code,
720 'agentnum' => $self->cust_main->agentnum })
722 return "Unknown registration code";
725 } elsif ( $self->promo_code ) {
728 qsearchs('part_pkg', {
729 'pkgpart' => $self->pkgpart,
730 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
732 return 'Unknown promotional code' unless $promo_part_pkg;
736 unless ( $disable_agentcheck ) {
738 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
739 return "agent ". $agent->agentnum. ':'. $agent->agent.
740 " can't purchase pkgpart ". $self->pkgpart
741 unless $agent->pkgpart_hashref->{ $self->pkgpart }
742 || $agent->agentnum == $self->part_pkg->agentnum;
745 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
746 return $error if $error;
754 =item cancel [ OPTION => VALUE ... ]
756 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
757 in this package, then cancels the package itself (sets the cancel field to
760 Available options are:
764 =item quiet - can be set true to supress email cancellation notices.
766 =item time - can be set to cancel the package based on a specific future or
767 historical date. Using time ensures that the remaining amount is calculated
768 correctly. Note however that this is an immediate cancel and just changes
769 the date. You are PROBABLY looking to expire the account instead of using
772 =item reason - can be set to a cancellation reason (see L<FS:reason>),
773 either a reasonnum of an existing reason, or passing a hashref will create
774 a new reason. The hashref should have the following keys: typenum - Reason
775 type (see L<FS::reason_type>, reason - Text of the new reason.
777 =item date - can be set to a unix style timestamp to specify when to
780 =item nobill - can be set true to skip billing if it might otherwise be done.
782 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
783 not credit it. This must be set (by change()) when changing the package
784 to a different pkgpart or location, and probably shouldn't be in any other
785 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
788 =item delay_cancel - for internal use, to allow proper handling of
789 supplemental packages when the main package is flagged to suspend
794 If there is an error, returns the error, otherwise returns false.
799 my( $self, %options ) = @_;
802 # pass all suspend/cancel actions to the main package
803 # (unless the pkglinknum has been removed, then the link is defunct and
804 # this package can be canceled on its own)
805 if ( $self->main_pkgnum and $self->pkglinknum and !$options{'from_main'} ) {
806 return $self->main_pkg->cancel(%options);
809 my $conf = new FS::Conf;
811 warn "cust_pkg::cancel called with options".
812 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
815 my $oldAutoCommit = $FS::UID::AutoCommit;
816 local $FS::UID::AutoCommit = 0;
819 my $old = $self->select_for_update;
821 if ( $old->get('cancel') || $self->get('cancel') ) {
822 dbh->rollback if $oldAutoCommit;
823 return ""; # no error
826 # XXX possibly set cancel_time to the expire date?
827 my $cancel_time = $options{'time'} || time;
828 my $date = $options{'date'} if $options{'date'}; # expire/cancel later
829 $date = '' if ($date && $date <= $cancel_time); # complain instead?
831 my $delay_cancel = $options{'delay_cancel'};
832 if ( !$date && $self->part_pkg->option('delay_cancel',1)
833 && (($self->status eq 'active') || ($self->status eq 'suspended'))
835 my $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
836 my $expsecs = 60*60*24*$expdays;
837 my $suspfor = $self->susp ? $cancel_time - $self->susp : 0;
838 $expsecs = $expsecs - $suspfor if $suspfor;
839 unless ($expsecs <= 0) { #if it's already been suspended long enough, don't re-suspend
841 $date = $cancel_time + $expsecs;
845 #race condition: usage could be ongoing until unprovisioned
846 #resolved by performing a change package instead (which unprovisions) and
848 if ( !$options{nobill} && !$date ) {
849 # && $conf->exists('bill_usage_on_cancel') ) { #calc_cancel checks this
850 my $copy = $self->new({$self->hash});
852 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
854 'time' => $cancel_time );
855 warn "Error billing during cancel, custnum ".
856 #$self->cust_main->custnum. ": $error"
861 if ( $options{'reason'} ) {
862 $error = $self->insert_reason( 'reason' => $options{'reason'},
863 'action' => $date ? 'expire' : 'cancel',
864 'date' => $date ? $date : $cancel_time,
865 'reason_otaker' => $options{'reason_otaker'},
868 dbh->rollback if $oldAutoCommit;
869 return "Error inserting cust_pkg_reason: $error";
873 my %svc_cancel_opt = ();
874 $svc_cancel_opt{'date'} = $date if $date;
875 foreach my $cust_svc (
878 sort { $a->[1] <=> $b->[1] }
879 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; }
880 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
882 my $part_svc = $cust_svc->part_svc;
883 next if ( defined($part_svc) and $part_svc->preserve );
884 my $error = $cust_svc->cancel( %svc_cancel_opt );
887 $dbh->rollback if $oldAutoCommit;
888 return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
894 # credit remaining time if appropriate
896 if ( exists($options{'unused_credit'}) ) {
897 $do_credit = $options{'unused_credit'};
900 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
903 my $error = $self->credit_remaining('cancel', $cancel_time);
905 $dbh->rollback if $oldAutoCommit;
911 my %hash = $self->hash;
913 $hash{'expire'} = $date;
915 # just to be sure these are clear
916 $hash{'adjourn'} = undef;
917 $hash{'resume'} = undef;
920 $hash{'cancel'} = $cancel_time;
922 $hash{'change_custnum'} = $options{'change_custnum'};
924 # if this is a supplemental package that's lost its part_pkg_link, and it's
925 # being canceled for real, unlink it completely
926 if ( !$date and ! $self->pkglinknum ) {
927 $hash{main_pkgnum} = '';
930 my $new = new FS::cust_pkg ( \%hash );
931 $error = $new->replace( $self, options => { $self->options } );
932 if ( $self->change_to_pkgnum ) {
933 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
934 $error ||= $change_to->cancel || $change_to->delete;
937 $dbh->rollback if $oldAutoCommit;
941 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
942 $error = $supp_pkg->cancel(%options,
944 'date' => $date, #in case it got changed by delay_cancel
945 'delay_cancel' => $delay_cancel,
948 $dbh->rollback if $oldAutoCommit;
949 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
953 if ($delay_cancel && !$options{'from_main'}) {
954 $error = $new->suspend(
956 'time' => $cancel_time
961 foreach my $usage ( $self->cust_pkg_usage ) {
962 $error = $usage->delete;
964 $dbh->rollback if $oldAutoCommit;
965 return "deleting usage pools: $error";
970 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
971 return '' if $date; #no errors
973 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
974 if ( !$options{'quiet'} &&
975 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
977 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
980 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
981 $error = $msg_template->send( 'cust_main' => $self->cust_main,
986 'from' => $conf->invoice_from_full( $self->cust_main->agentnum ),
987 'to' => \@invoicing_list,
988 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
989 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
990 'custnum' => $self->custnum,
991 'msgtype' => '', #admin?
994 #should this do something on errors?
1001 =item cancel_if_expired [ NOW_TIMESTAMP ]
1003 Cancels this package if its expire date has been reached.
1007 sub cancel_if_expired {
1009 my $time = shift || time;
1010 return '' unless $self->expire && $self->expire <= $time;
1011 my $error = $self->cancel;
1013 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
1014 $self->custnum. ": $error";
1021 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
1022 locationnum, (other fields?). Attempts to re-provision cancelled services
1023 using history information (errors at this stage are not fatal).
1025 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
1027 svc_fatal: service provisioning errors are fatal
1029 svc_errors: pass an array reference, will be filled in with any provisioning errors
1031 main_pkgnum: link the package as a supplemental package of this one. For
1037 my( $self, %options ) = @_;
1039 #in case you try do do $uncancel-date = $cust_pkg->uncacel
1040 return '' unless $self->get('cancel');
1042 if ( $self->main_pkgnum and !$options{'main_pkgnum'} ) {
1043 return $self->main_pkg->uncancel(%options);
1050 my $oldAutoCommit = $FS::UID::AutoCommit;
1051 local $FS::UID::AutoCommit = 0;
1055 # insert the new package
1058 my $cust_pkg = new FS::cust_pkg {
1059 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
1060 bill => ( $options{'bill'} || $self->get('bill') ),
1062 uncancel_pkgnum => $self->pkgnum,
1063 main_pkgnum => ($options{'main_pkgnum'} || ''),
1064 map { $_ => $self->get($_) } qw(
1065 custnum pkgpart locationnum
1067 susp adjourn resume expire start_date contract_end dundate
1068 change_date change_pkgpart change_locationnum
1069 manual_flag no_auto separate_bill quantity agent_pkgid
1070 recur_show_zero setup_show_zero
1074 my $error = $cust_pkg->insert(
1075 'change' => 1, #supresses any referral credit to a referring customer
1076 'allow_pkgpart' => 1, # allow this even if the package def is disabled
1079 $dbh->rollback if $oldAutoCommit;
1087 #find historical services within this timeframe before the package cancel
1088 # (incompatible with "time" option to cust_pkg->cancel?)
1089 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
1090 # too little? (unprovisioing export delay?)
1091 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
1092 my @h_cust_svc = $self->h_cust_svc( $end, $start );
1095 foreach my $h_cust_svc (@h_cust_svc) {
1096 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
1097 #next unless $h_svc_x; #should this happen?
1098 (my $table = $h_svc_x->table) =~ s/^h_//;
1099 require "FS/$table.pm";
1100 my $class = "FS::$table";
1101 my $svc_x = $class->new( {
1102 'pkgnum' => $cust_pkg->pkgnum,
1103 'svcpart' => $h_cust_svc->svcpart,
1104 map { $_ => $h_svc_x->get($_) } fields($table)
1108 if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
1109 $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
1112 my $svc_error = $svc_x->insert;
1114 if ( $options{svc_fatal} ) {
1115 $dbh->rollback if $oldAutoCommit;
1118 # if we've failed to insert the svc_x object, svc_Common->insert
1119 # will have removed the cust_svc already. if not, then both records
1120 # were inserted but we failed for some other reason (export, most
1121 # likely). in that case, report the error and delete the records.
1122 push @svc_errors, $svc_error;
1123 my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1125 # except if export_insert failed, export_delete probably won't be
1127 local $FS::svc_Common::noexport_hack = 1;
1128 my $cleanup_error = $svc_x->delete; # also deletes cust_svc
1129 if ( $cleanup_error ) { # and if THAT fails, then run away
1130 $dbh->rollback if $oldAutoCommit;
1131 return $cleanup_error;
1136 } #foreach $h_cust_svc
1138 #these are pretty rare, but should handle them
1139 # - dsl_device (mac addresses)
1140 # - phone_device (mac addresses)
1141 # - dsl_note (ikano notes)
1142 # - domain_record (i.e. restore DNS information w/domains)
1143 # - inventory_item(?) (inventory w/un-cancelling service?)
1144 # - nas (svc_broaband nas stuff)
1145 #this stuff is unused in the wild afaik
1146 # - mailinglistmember
1148 # - svc_domain.parent_svcnum?
1149 # - acct_snarf (ancient mail fetching config)
1150 # - cgp_rule (communigate)
1151 # - cust_svc_option (used by our Tron stuff)
1152 # - acct_rt_transaction (used by our time worked stuff)
1155 # also move over any services that didn't unprovision at cancellation
1158 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1159 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1160 my $error = $cust_svc->replace;
1162 $dbh->rollback if $oldAutoCommit;
1168 # Uncancel any supplemental packages, and make them supplemental to the
1172 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1174 $error = $supp_pkg->uncancel(%options, 'main_pkgnum' => $cust_pkg->pkgnum);
1176 $dbh->rollback if $oldAutoCommit;
1177 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1185 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1187 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1188 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1195 Cancels any pending expiration (sets the expire field to null).
1197 If there is an error, returns the error, otherwise returns false.
1202 my( $self, %options ) = @_;
1205 my $oldAutoCommit = $FS::UID::AutoCommit;
1206 local $FS::UID::AutoCommit = 0;
1209 my $old = $self->select_for_update;
1211 my $pkgnum = $old->pkgnum;
1212 if ( $old->get('cancel') || $self->get('cancel') ) {
1213 dbh->rollback if $oldAutoCommit;
1214 return "Can't unexpire cancelled package $pkgnum";
1215 # or at least it's pointless
1218 unless ( $old->get('expire') && $self->get('expire') ) {
1219 dbh->rollback if $oldAutoCommit;
1220 return ""; # no error
1223 my %hash = $self->hash;
1224 $hash{'expire'} = '';
1225 my $new = new FS::cust_pkg ( \%hash );
1226 $error = $new->replace( $self, options => { $self->options } );
1228 $dbh->rollback if $oldAutoCommit;
1232 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1238 =item suspend [ OPTION => VALUE ... ]
1240 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1241 package, then suspends the package itself (sets the susp field to now).
1243 Available options are:
1247 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1248 either a reasonnum of an existing reason, or passing a hashref will create
1249 a new reason. The hashref should have the following keys:
1250 - typenum - Reason type (see L<FS::reason_type>
1251 - reason - Text of the new reason.
1253 =item date - can be set to a unix style timestamp to specify when to
1256 =item time - can be set to override the current time, for calculation
1257 of final invoices or unused-time credits
1259 =item resume_date - can be set to a time when the package should be
1260 unsuspended. This may be more convenient than calling C<unsuspend()>
1263 =item from_main - allows a supplemental package to be suspended, rather
1264 than redirecting the method call to its main package. For internal use.
1266 =item from_cancel - used when suspending from the cancel method, forces
1267 this to skip everything besides basic suspension. For internal use.
1271 If there is an error, returns the error, otherwise returns false.
1276 my( $self, %options ) = @_;
1279 # pass all suspend/cancel actions to the main package
1280 if ( $self->main_pkgnum and !$options{'from_main'} ) {
1281 return $self->main_pkg->suspend(%options);
1284 my $oldAutoCommit = $FS::UID::AutoCommit;
1285 local $FS::UID::AutoCommit = 0;
1288 my $old = $self->select_for_update;
1290 my $pkgnum = $old->pkgnum;
1291 if ( $old->get('cancel') || $self->get('cancel') ) {
1292 dbh->rollback if $oldAutoCommit;
1293 return "Can't suspend cancelled package $pkgnum";
1296 if ( $old->get('susp') || $self->get('susp') ) {
1297 dbh->rollback if $oldAutoCommit;
1298 return ""; # no error # complain on adjourn?
1301 my $suspend_time = $options{'time'} || time;
1302 my $date = $options{date} if $options{date}; # adjourn/suspend later
1303 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1305 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1306 dbh->rollback if $oldAutoCommit;
1307 return "Package $pkgnum expires before it would be suspended.";
1310 # some false laziness with sub cancel
1311 if ( !$options{nobill} && !$date && !$options{'from_cancel'} &&
1312 $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1313 # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1314 # make the entire cust_main->bill path recognize 'suspend' and
1315 # 'cancel' separately.
1316 warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1317 my $copy = $self->new({$self->hash});
1319 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1321 'time' => $suspend_time );
1322 warn "Error billing during suspend, custnum ".
1323 #$self->cust_main->custnum. ": $error"
1328 if ( $options{'reason'} ) {
1329 $error = $self->insert_reason( 'reason' => $options{'reason'},
1330 'action' => $date ? 'adjourn' : 'suspend',
1331 'date' => $date ? $date : $suspend_time,
1332 'reason_otaker' => $options{'reason_otaker'},
1335 dbh->rollback if $oldAutoCommit;
1336 return "Error inserting cust_pkg_reason: $error";
1340 # if a reasonnum was passed, get the actual reason object so we can check
1342 # (passing a reason hashref is still allowed, but it can't be used with
1343 # the fancy behavioral options.)
1346 if ($options{'reason'} =~ /^\d+$/) {
1347 $reason = FS::reason->by_key($options{'reason'});
1350 my %hash = $self->hash;
1352 $hash{'adjourn'} = $date;
1354 $hash{'susp'} = $suspend_time;
1357 my $resume_date = $options{'resume_date'} || 0;
1358 if ( $resume_date > ($date || $suspend_time) ) {
1359 $hash{'resume'} = $resume_date;
1362 $options{options} ||= {};
1364 my $new = new FS::cust_pkg ( \%hash );
1365 $error = $new->replace( $self, options => { $self->options,
1366 %{ $options{options} },
1370 $dbh->rollback if $oldAutoCommit;
1374 unless ( $date ) { # then we are suspending now
1376 unless ($options{'from_cancel'}) {
1377 # credit remaining time if appropriate
1378 # (if required by the package def, or the suspend reason)
1379 my $unused_credit = $self->part_pkg->option('unused_credit_suspend',1)
1380 || ( defined($reason) && $reason->unused_credit );
1382 if ( $unused_credit ) {
1383 warn "crediting unused time on pkg#".$self->pkgnum."\n" if $DEBUG;
1384 my $error = $self->credit_remaining('suspend', $suspend_time);
1386 $dbh->rollback if $oldAutoCommit;
1394 foreach my $cust_svc (
1395 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1397 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1399 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1400 $dbh->rollback if $oldAutoCommit;
1401 return "Illegal svcdb value in part_svc!";
1404 require "FS/$svcdb.pm";
1406 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1408 $error = $svc->suspend;
1410 $dbh->rollback if $oldAutoCommit;
1413 my( $label, $value ) = $cust_svc->label;
1414 push @labels, "$label: $value";
1418 my $conf = new FS::Conf;
1419 if ( $conf->config('suspend_email_admin') && !$options{'from_cancel'} ) {
1421 my $error = send_email(
1422 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1423 #invoice_from ??? well as good as any
1424 'to' => $conf->config('suspend_email_admin'),
1425 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1427 "This is an automatic message from your Freeside installation\n",
1428 "informing you that the following customer package has been suspended:\n",
1430 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1431 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1432 ( map { "Service : $_\n" } @labels ),
1434 'custnum' => $self->custnum,
1435 'msgtype' => 'admin'
1439 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1447 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1448 $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1450 $dbh->rollback if $oldAutoCommit;
1451 return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1455 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1460 =item credit_remaining MODE TIME
1462 Generate a credit for this package for the time remaining in the current
1463 billing period. MODE is either "suspend" or "cancel" (determines the
1464 credit type). TIME is the time of suspension/cancellation. Both arguments
1469 # Implementation note:
1471 # If you pkgpart-change a package that has been billed, and it's set to give
1472 # credit on package change, then this method gets called and then the new
1473 # package will have no last_bill date. Therefore the customer will be credited
1474 # only once (per billing period) even if there are multiple package changes.
1476 # If you location-change a package that has been billed, this method will NOT
1477 # be called and the new package WILL have the last bill date of the old
1480 # If the new package is then canceled within the same billing cycle,
1481 # credit_remaining needs to run calc_remain on the OLD package to determine
1482 # the amount of unused time to credit.
1484 sub credit_remaining {
1485 # Add a credit for remaining service
1486 my ($self, $mode, $time) = @_;
1487 die 'credit_remaining requires suspend or cancel'
1488 unless $mode eq 'suspend' or $mode eq 'cancel';
1489 die 'no suspend/cancel time' unless $time > 0;
1491 my $conf = FS::Conf->new;
1492 my $reason_type = $conf->config($mode.'_credit_type');
1494 my $last_bill = $self->getfield('last_bill') || 0;
1495 my $next_bill = $self->getfield('bill') || 0;
1496 if ( $last_bill > 0 # the package has been billed
1497 and $next_bill > 0 # the package has a next bill date
1498 and $next_bill >= $time # which is in the future
1500 my @cust_credit_source_bill_pkg = ();
1501 my $remaining_value = 0;
1503 my $remain_pkg = $self;
1504 $remaining_value = $remain_pkg->calc_remain(
1506 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1509 # we may have to walk back past some package changes to get to the
1510 # one that actually has unused time
1511 while ( $remaining_value == 0 ) {
1512 if ( $remain_pkg->change_pkgnum ) {
1513 $remain_pkg = FS::cust_pkg->by_key($remain_pkg->change_pkgnum);
1515 # the package has really never been billed
1518 $remaining_value = $remain_pkg->calc_remain(
1520 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1524 if ( $remaining_value > 0 ) {
1525 warn "Crediting for $remaining_value on package ".$self->pkgnum."\n"
1527 my $error = $self->cust_main->credit(
1529 'Credit for unused time on '. $self->part_pkg->pkg,
1530 'reason_type' => $reason_type,
1531 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1533 return "Error crediting customer \$$remaining_value for unused time".
1534 " on ". $self->part_pkg->pkg. ": $error"
1536 } #if $remaining_value
1537 } #if $last_bill, etc.
1541 =item unsuspend [ OPTION => VALUE ... ]
1543 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1544 package, then unsuspends the package itself (clears the susp field and the
1545 adjourn field if it is in the past). If the suspend reason includes an
1546 unsuspension package, that package will be ordered.
1548 Available options are:
1554 Can be set to a date to unsuspend the package in the future (the 'resume'
1557 =item adjust_next_bill
1559 Can be set true to adjust the next bill date forward by
1560 the amount of time the account was inactive. This was set true by default
1561 in the past (from 1.4.2 and 1.5.0pre6 through 1.7.0), but now needs to be
1562 explicitly requested with this option or in the price plan.
1566 If there is an error, returns the error, otherwise returns false.
1571 my( $self, %opt ) = @_;
1574 # pass all suspend/cancel actions to the main package
1575 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1576 return $self->main_pkg->unsuspend(%opt);
1579 my $oldAutoCommit = $FS::UID::AutoCommit;
1580 local $FS::UID::AutoCommit = 0;
1583 my $old = $self->select_for_update;
1585 my $pkgnum = $old->pkgnum;
1586 if ( $old->get('cancel') || $self->get('cancel') ) {
1587 $dbh->rollback if $oldAutoCommit;
1588 return "Can't unsuspend cancelled package $pkgnum";
1591 unless ( $old->get('susp') && $self->get('susp') ) {
1592 $dbh->rollback if $oldAutoCommit;
1593 return ""; # no error # complain instead?
1596 # handle the case of setting a future unsuspend (resume) date
1597 # and do not continue to actually unsuspend the package
1598 my $date = $opt{'date'};
1599 if ( $date and $date > time ) { # return an error if $date <= time?
1601 if ( $old->get('expire') && $old->get('expire') < $date ) {
1602 $dbh->rollback if $oldAutoCommit;
1603 return "Package $pkgnum expires before it would be unsuspended.";
1606 my $new = new FS::cust_pkg { $self->hash };
1607 $new->set('resume', $date);
1608 $error = $new->replace($self, options => $self->options);
1611 $dbh->rollback if $oldAutoCommit;
1615 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1621 if (!$self->setup) {
1622 # then this package is being released from on-hold status
1623 $self->set_initial_timers;
1628 foreach my $cust_svc (
1629 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1631 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1633 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1634 $dbh->rollback if $oldAutoCommit;
1635 return "Illegal svcdb value in part_svc!";
1638 require "FS/$svcdb.pm";
1640 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1642 $error = $svc->unsuspend;
1644 $dbh->rollback if $oldAutoCommit;
1647 my( $label, $value ) = $cust_svc->label;
1648 push @labels, "$label: $value";
1653 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1654 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1656 my %hash = $self->hash;
1657 my $inactive = time - $hash{'susp'};
1659 my $conf = new FS::Conf;
1661 #adjust the next bill date forward
1662 # increment next bill date if certain conditions are met:
1663 # - it was due to be billed at some point
1664 # - either the global or local config says to do this
1665 my $adjust_bill = 0;
1668 && ( $hash{'bill'} || $hash{'setup'} )
1669 && ( $opt{'adjust_next_bill'}
1670 || $conf->exists('unsuspend-always_adjust_next_bill_date')
1671 || $self->part_pkg->option('unsuspend_adjust_bill', 1)
1678 # - the package billed during suspension
1679 # - or it was ordered on hold
1680 # - or the customer was credited for the unused time
1682 if ( $self->option('suspend_bill',1)
1683 or ( $self->part_pkg->option('suspend_bill',1)
1684 and ! $self->option('no_suspend_bill',1)
1686 or $hash{'order_date'} == $hash{'susp'}
1691 if ( $adjust_bill ) {
1692 if ( $self->part_pkg->option('unused_credit_suspend')
1693 or ( ref($reason) and $reason->unused_credit ) ) {
1694 # then the customer was credited for the unused time before suspending,
1695 # so their next bill should be immediate
1696 $hash{'bill'} = time;
1698 # add the length of time suspended to the bill date
1699 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1704 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1705 $hash{'resume'} = '' if !$hash{'adjourn'};
1706 my $new = new FS::cust_pkg ( \%hash );
1707 $error = $new->replace( $self, options => { $self->options } );
1709 $dbh->rollback if $oldAutoCommit;
1715 if ( $reason && $reason->unsuspend_pkgpart ) {
1716 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
1717 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
1719 my $start_date = $self->cust_main->next_bill_date
1720 if $reason->unsuspend_hold;
1723 $unsusp_pkg = FS::cust_pkg->new({
1724 'custnum' => $self->custnum,
1725 'pkgpart' => $reason->unsuspend_pkgpart,
1726 'start_date' => $start_date,
1727 'locationnum' => $self->locationnum,
1728 # discount? probably not...
1731 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
1735 $dbh->rollback if $oldAutoCommit;
1740 if ( $conf->config('unsuspend_email_admin') ) {
1742 my $error = send_email(
1743 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1744 #invoice_from ??? well as good as any
1745 'to' => $conf->config('unsuspend_email_admin'),
1746 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
1747 "This is an automatic message from your Freeside installation\n",
1748 "informing you that the following customer package has been unsuspended:\n",
1750 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1751 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1752 ( map { "Service : $_\n" } @labels ),
1754 "An unsuspension fee was charged: ".
1755 $unsusp_pkg->part_pkg->pkg_comment."\n"
1759 'custnum' => $self->custnum,
1760 'msgtype' => 'admin',
1764 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
1770 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1771 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
1773 $dbh->rollback if $oldAutoCommit;
1774 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1778 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1785 Cancels any pending suspension (sets the adjourn field to null).
1787 If there is an error, returns the error, otherwise returns false.
1792 my( $self, %options ) = @_;
1795 my $oldAutoCommit = $FS::UID::AutoCommit;
1796 local $FS::UID::AutoCommit = 0;
1799 my $old = $self->select_for_update;
1801 my $pkgnum = $old->pkgnum;
1802 if ( $old->get('cancel') || $self->get('cancel') ) {
1803 dbh->rollback if $oldAutoCommit;
1804 return "Can't unadjourn cancelled package $pkgnum";
1805 # or at least it's pointless
1808 if ( $old->get('susp') || $self->get('susp') ) {
1809 dbh->rollback if $oldAutoCommit;
1810 return "Can't unadjourn suspended package $pkgnum";
1811 # perhaps this is arbitrary
1814 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1815 dbh->rollback if $oldAutoCommit;
1816 return ""; # no error
1819 my %hash = $self->hash;
1820 $hash{'adjourn'} = '';
1821 $hash{'resume'} = '';
1822 my $new = new FS::cust_pkg ( \%hash );
1823 $error = $new->replace( $self, options => { $self->options } );
1825 $dbh->rollback if $oldAutoCommit;
1829 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1836 =item change HASHREF | OPTION => VALUE ...
1838 Changes this package: cancels it and creates a new one, with a different
1839 pkgpart or locationnum or both. All services are transferred to the new
1840 package (no change will be made if this is not possible).
1842 Options may be passed as a list of key/value pairs or as a hash reference.
1849 New locationnum, to change the location for this package.
1853 New FS::cust_location object, to create a new location and assign it
1858 New FS::cust_main object, to create a new customer and assign the new package
1863 New pkgpart (see L<FS::part_pkg>).
1867 New refnum (see L<FS::part_referral>).
1871 New quantity; if unspecified, the new package will have the same quantity
1876 "New" (existing) FS::cust_pkg object. The package's services and other
1877 attributes will be transferred to this package.
1881 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1882 susp, adjourn, cancel, expire, and contract_end) to the new package.
1884 =item unprotect_svcs
1886 Normally, change() will rollback and return an error if some services
1887 can't be transferred (also see the I<cust_pkg-change_svcpart> config option).
1888 If unprotect_svcs is true, this method will transfer as many services as
1889 it can and then unconditionally cancel the old package.
1893 At least one of locationnum, cust_location, pkgpart, refnum, cust_main, or
1894 cust_pkg must be specified (otherwise, what's the point?)
1896 Returns either the new FS::cust_pkg object or a scalar error.
1900 my $err_or_new_cust_pkg = $old_cust_pkg->change
1904 #some false laziness w/order
1907 my $opt = ref($_[0]) ? shift : { @_ };
1909 my $conf = new FS::Conf;
1911 # Transactionize this whole mess
1912 my $oldAutoCommit = $FS::UID::AutoCommit;
1913 local $FS::UID::AutoCommit = 0;
1922 $hash{'setup'} = $time if $self->setup;
1924 $hash{'change_date'} = $time;
1925 $hash{"change_$_"} = $self->$_()
1926 foreach qw( pkgnum pkgpart locationnum );
1928 if ( $opt->{'cust_location'} ) {
1929 $error = $opt->{'cust_location'}->find_or_insert;
1931 $dbh->rollback if $oldAutoCommit;
1932 return "creating location record: $error";
1934 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1937 if ( $opt->{'cust_pkg'} ) {
1938 # treat changing to a package with a different pkgpart as a
1939 # pkgpart change (because it is)
1940 $opt->{'pkgpart'} = $opt->{'cust_pkg'}->pkgpart;
1943 # whether to override pkgpart checking on the new package
1944 my $same_pkgpart = 1;
1945 if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
1949 my $unused_credit = 0;
1950 my $keep_dates = $opt->{'keep_dates'};
1951 # Special case. If the pkgpart is changing, and the customer is
1952 # going to be credited for remaining time, don't keep setup, bill,
1953 # or last_bill dates, and DO pass the flag to cancel() to credit
1955 if ( $opt->{'pkgpart'}
1956 and $opt->{'pkgpart'} != $self->pkgpart
1957 and $self->part_pkg->option('unused_credit_change', 1) ) {
1960 $hash{$_} = '' foreach qw(setup bill last_bill);
1963 if ( $keep_dates ) {
1964 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1965 resume start_date contract_end ) ) {
1966 $hash{$date} = $self->getfield($date);
1969 # always keep this date, regardless of anything
1970 # (the date of the package change is in a different field)
1971 $hash{'order_date'} = $self->getfield('order_date');
1973 # allow $opt->{'locationnum'} = '' to specifically set it to null
1974 # (i.e. customer default location)
1975 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
1977 # usually this doesn't matter. the two cases where it does are:
1978 # 1. unused_credit_change + pkgpart change + setup fee on the new package
1980 # 2. (more importantly) changing a package before it's billed
1981 $hash{'waive_setup'} = $self->waive_setup;
1983 my $custnum = $self->custnum;
1984 if ( $opt->{cust_main} ) {
1985 my $cust_main = $opt->{cust_main};
1986 unless ( $cust_main->custnum ) {
1987 my $error = $cust_main->insert( @{ $opt->{cust_main_insert_args}||[] } );
1989 $dbh->rollback if $oldAutoCommit;
1990 return "inserting customer record: $error";
1993 $custnum = $cust_main->custnum;
1996 $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
1999 if ( $opt->{'cust_pkg'} ) {
2000 # The target package already exists; update it to show that it was
2001 # changed from this package.
2002 $cust_pkg = $opt->{'cust_pkg'};
2004 foreach ( qw( pkgnum pkgpart locationnum ) ) {
2005 $cust_pkg->set("change_$_", $self->get($_));
2007 $cust_pkg->set('change_date', $time);
2008 $error = $cust_pkg->replace;
2011 # Create the new package.
2012 $cust_pkg = new FS::cust_pkg {
2013 custnum => $custnum,
2014 locationnum => $opt->{'locationnum'},
2015 ( map { $_ => ( $opt->{$_} || $self->$_() ) }
2016 qw( pkgpart quantity refnum salesnum )
2020 $error = $cust_pkg->insert( 'change' => 1,
2021 'allow_pkgpart' => $same_pkgpart );
2024 $dbh->rollback if $oldAutoCommit;
2025 return "inserting new package: $error";
2028 # Transfer services and cancel old package.
2030 $error = $self->transfer($cust_pkg);
2031 if ($error and $error == 0) {
2032 # $old_pkg->transfer failed.
2033 $dbh->rollback if $oldAutoCommit;
2034 return "transferring $error";
2037 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2038 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2039 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
2040 if ($error and $error == 0) {
2041 # $old_pkg->transfer failed.
2042 $dbh->rollback if $oldAutoCommit;
2043 return "converting $error";
2047 # We set unprotect_svcs when executing a "future package change". It's
2048 # not a user-interactive operation, so returning an error means the
2049 # package change will just fail. Rather than have that happen, we'll
2050 # let leftover services be deleted.
2051 if ($error > 0 and !$opt->{'unprotect_svcs'}) {
2052 # Transfers were successful, but we still had services left on the old
2053 # package. We can't change the package under this circumstances, so abort.
2054 $dbh->rollback if $oldAutoCommit;
2055 return "unable to transfer all services";
2058 #reset usage if changing pkgpart
2059 # AND usage rollover is off (otherwise adds twice, now and at package bill)
2060 if ($self->pkgpart != $cust_pkg->pkgpart) {
2061 my $part_pkg = $cust_pkg->part_pkg;
2062 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
2066 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
2069 $dbh->rollback if $oldAutoCommit;
2070 return "setting usage values: $error";
2073 # if NOT changing pkgpart, transfer any usage pools over
2074 foreach my $usage ($self->cust_pkg_usage) {
2075 $usage->set('pkgnum', $cust_pkg->pkgnum);
2076 $error = $usage->replace;
2078 $dbh->rollback if $oldAutoCommit;
2079 return "transferring usage pools: $error";
2084 # transfer usage pricing add-ons, if we're not changing pkgpart
2085 if ( $same_pkgpart ) {
2086 foreach my $old_cust_pkg_usageprice ($self->cust_pkg_usageprice) {
2087 my $new_cust_pkg_usageprice = new FS::cust_pkg_usageprice {
2088 'pkgnum' => $cust_pkg->pkgnum,
2089 'usagepricepart' => $old_cust_pkg_usageprice->usagepricepart,
2090 'quantity' => $old_cust_pkg_usageprice->quantity,
2092 $error = $new_cust_pkg_usageprice->insert;
2094 $dbh->rollback if $oldAutoCommit;
2095 return "Error transferring usage pricing add-on: $error";
2100 # transfer discounts, if we're not changing pkgpart
2101 if ( $same_pkgpart ) {
2102 foreach my $old_discount ($self->cust_pkg_discount_active) {
2103 # don't remove the old discount, we may still need to bill that package.
2104 my $new_discount = new FS::cust_pkg_discount {
2105 'pkgnum' => $cust_pkg->pkgnum,
2106 'discountnum' => $old_discount->discountnum,
2107 'months_used' => $old_discount->months_used,
2109 $error = $new_discount->insert;
2111 $dbh->rollback if $oldAutoCommit;
2112 return "transferring discounts: $error";
2117 # transfer (copy) invoice details
2118 foreach my $detail ($self->cust_pkg_detail) {
2119 my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
2120 $new_detail->set('pkgdetailnum', '');
2121 $new_detail->set('pkgnum', $cust_pkg->pkgnum);
2122 $error = $new_detail->insert;
2124 $dbh->rollback if $oldAutoCommit;
2125 return "transferring package notes: $error";
2131 if ( !$opt->{'cust_pkg'} ) {
2132 # Order any supplemental packages.
2133 my $part_pkg = $cust_pkg->part_pkg;
2134 my @old_supp_pkgs = $self->supplemental_pkgs;
2135 foreach my $link ($part_pkg->supp_part_pkg_link) {
2137 foreach (@old_supp_pkgs) {
2138 if ($_->pkgpart == $link->dst_pkgpart) {
2140 $_->pkgpart(0); # so that it can't match more than once
2144 # false laziness with FS::cust_main::Packages::order_pkg
2145 my $new = FS::cust_pkg->new({
2146 pkgpart => $link->dst_pkgpart,
2147 pkglinknum => $link->pkglinknum,
2148 custnum => $custnum,
2149 main_pkgnum => $cust_pkg->pkgnum,
2150 locationnum => $cust_pkg->locationnum,
2151 start_date => $cust_pkg->start_date,
2152 order_date => $cust_pkg->order_date,
2153 expire => $cust_pkg->expire,
2154 adjourn => $cust_pkg->adjourn,
2155 contract_end => $cust_pkg->contract_end,
2156 refnum => $cust_pkg->refnum,
2157 discountnum => $cust_pkg->discountnum,
2158 waive_setup => $cust_pkg->waive_setup,
2160 if ( $old and $opt->{'keep_dates'} ) {
2161 foreach (qw(setup bill last_bill)) {
2162 $new->set($_, $old->get($_));
2165 $error = $new->insert( allow_pkgpart => $same_pkgpart );
2168 $error ||= $old->transfer($new);
2170 if ( $error and $error > 0 ) {
2171 # no reason why this should ever fail, but still...
2172 $error = "Unable to transfer all services from supplemental package ".
2176 $dbh->rollback if $oldAutoCommit;
2179 push @new_supp_pkgs, $new;
2181 } # if !$opt->{'cust_pkg'}
2182 # because if there is one, then supplemental packages would already
2183 # have been created for it.
2185 #Good to go, cancel old package. Notify 'cancel' of whether to credit
2187 #Don't allow billing the package (preceding period packages and/or
2188 #outstanding usage) if we are keeping dates (i.e. location changing),
2189 #because the new package will be billed for the same date range.
2190 #Supplemental packages are also canceled here.
2192 # during scheduled changes, avoid canceling the package we just
2194 $self->set('change_to_pkgnum' => '');
2196 $error = $self->cancel(
2198 unused_credit => $unused_credit,
2199 nobill => $keep_dates,
2200 change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2203 $dbh->rollback if $oldAutoCommit;
2204 return "canceling old package: $error";
2207 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2209 my $error = $cust_pkg->cust_main->bill(
2210 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2213 $dbh->rollback if $oldAutoCommit;
2214 return "billing new package: $error";
2218 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2224 =item change_later OPTION => VALUE...
2226 Schedule a package change for a later date. This actually orders the new
2227 package immediately, but sets its start date for a future date, and sets
2228 the current package to expire on the same date.
2230 If the package is already scheduled for a change, this can be called with
2231 'start_date' to change the scheduled date, or with pkgpart and/or
2232 locationnum to modify the package change. To cancel the scheduled change
2233 entirely, see C<abort_change>.
2241 The date for the package change. Required, and must be in the future.
2249 The pkgpart. locationnum, and quantity of the new package, with the same
2250 meaning as in C<change>.
2258 my $opt = ref($_[0]) ? shift : { @_ };
2260 my $oldAutoCommit = $FS::UID::AutoCommit;
2261 local $FS::UID::AutoCommit = 0;
2264 my $cust_main = $self->cust_main;
2266 my $date = delete $opt->{'start_date'} or return 'start_date required';
2268 if ( $date <= time ) {
2269 $dbh->rollback if $oldAutoCommit;
2270 return "start_date $date is in the past";
2275 if ( $self->change_to_pkgnum ) {
2276 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
2277 my $new_pkgpart = $opt->{'pkgpart'}
2278 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $change_to->pkgpart;
2279 my $new_locationnum = $opt->{'locationnum'}
2280 if $opt->{'locationnum'} and $opt->{'locationnum'} != $change_to->locationnum;
2281 my $new_quantity = $opt->{'quantity'}
2282 if $opt->{'quantity'} and $opt->{'quantity'} != $change_to->quantity;
2283 if ( $new_pkgpart or $new_locationnum or $new_quantity ) {
2284 # it hasn't been billed yet, so in principle we could just edit
2285 # it in place (w/o a package change), but that's bad form.
2286 # So change the package according to the new options...
2287 my $err_or_pkg = $change_to->change(%$opt);
2288 if ( ref $err_or_pkg ) {
2289 # Then set that package up for a future start.
2290 $self->set('change_to_pkgnum', $err_or_pkg->pkgnum);
2291 $self->set('expire', $date); # in case it's different
2292 $err_or_pkg->set('start_date', $date);
2293 $err_or_pkg->set('change_date', '');
2294 $err_or_pkg->set('change_pkgnum', '');
2296 $error = $self->replace ||
2297 $err_or_pkg->replace ||
2298 $change_to->cancel ||
2301 $error = $err_or_pkg;
2303 } else { # change the start date only.
2304 $self->set('expire', $date);
2305 $change_to->set('start_date', $date);
2306 $error = $self->replace || $change_to->replace;
2309 $dbh->rollback if $oldAutoCommit;
2312 $dbh->commit if $oldAutoCommit;
2315 } # if $self->change_to_pkgnum
2317 my $new_pkgpart = $opt->{'pkgpart'}
2318 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2319 my $new_locationnum = $opt->{'locationnum'}
2320 if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2321 my $new_quantity = $opt->{'quantity'}
2322 if $opt->{'quantity'} and $opt->{'quantity'} != $self->quantity;
2324 return '' unless $new_pkgpart or $new_locationnum or $new_quantity; # wouldn't do anything
2326 # allow $opt->{'locationnum'} = '' to specifically set it to null
2327 # (i.e. customer default location)
2328 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2330 my $new = FS::cust_pkg->new( {
2331 custnum => $self->custnum,
2332 locationnum => $opt->{'locationnum'},
2333 start_date => $date,
2334 map { $_ => ( $opt->{$_} || $self->$_() ) }
2335 qw( pkgpart quantity refnum salesnum )
2337 $error = $new->insert('change' => 1,
2338 'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2340 $self->set('change_to_pkgnum', $new->pkgnum);
2341 $self->set('expire', $date);
2342 $error = $self->replace;
2345 $dbh->rollback if $oldAutoCommit;
2347 $dbh->commit if $oldAutoCommit;
2355 Cancels a future package change scheduled by C<change_later>.
2361 my $pkgnum = $self->change_to_pkgnum;
2362 my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
2365 $error = $change_to->cancel || $change_to->delete;
2366 return $error if $error;
2368 $self->set('change_to_pkgnum', '');
2369 $self->set('expire', '');
2373 =item set_quantity QUANTITY
2375 Change the package's quantity field. This is one of the few package properties
2376 that can safely be changed without canceling and reordering the package
2377 (because it doesn't affect tax eligibility). Returns an error or an
2384 $self = $self->replace_old; # just to make sure
2385 $self->quantity(shift);
2389 =item set_salesnum SALESNUM
2391 Change the package's salesnum (sales person) field. This is one of the few
2392 package properties that can safely be changed without canceling and reordering
2393 the package (because it doesn't affect tax eligibility). Returns an error or
2400 $self = $self->replace_old; # just to make sure
2401 $self->salesnum(shift);
2403 # XXX this should probably reassign any credit that's already been given
2406 =item modify_charge OPTIONS
2408 Change the properties of a one-time charge. The following properties can
2409 be changed this way:
2410 - pkg: the package description
2411 - classnum: the package class
2412 - additional: arrayref of additional invoice details to add to this package
2414 and, I<if the charge has not yet been billed>:
2415 - start_date: the date when it will be billed
2416 - amount: the setup fee to be charged
2417 - quantity: the multiplier for the setup fee
2418 - separate_bill: whether to put the charge on a separate invoice
2420 If you pass 'adjust_commission' => 1, and the classnum changes, and there are
2421 commission credits linked to this charge, they will be recalculated.
2428 my $part_pkg = $self->part_pkg;
2429 my $pkgnum = $self->pkgnum;
2432 my $oldAutoCommit = $FS::UID::AutoCommit;
2433 local $FS::UID::AutoCommit = 0;
2435 return "Can't use modify_charge except on one-time charges"
2436 unless $part_pkg->freq eq '0';
2438 if ( length($opt{'pkg'}) and $part_pkg->pkg ne $opt{'pkg'} ) {
2439 $part_pkg->set('pkg', $opt{'pkg'});
2442 my %pkg_opt = $part_pkg->options;
2443 my $pkg_opt_modified = 0;
2445 $opt{'additional'} ||= [];
2448 foreach (grep /^additional/, keys %pkg_opt) {
2449 ($i) = ($_ =~ /^additional_info(\d+)$/);
2450 $old_additional[$i] = $pkg_opt{$_} if $i;
2451 delete $pkg_opt{$_};
2454 for ( $i = 0; exists($opt{'additional'}->[$i]); $i++ ) {
2455 $pkg_opt{ "additional_info$i" } = $opt{'additional'}->[$i];
2456 if (!exists($old_additional[$i])
2457 or $old_additional[$i] ne $opt{'additional'}->[$i])
2459 $pkg_opt_modified = 1;
2462 $pkg_opt_modified = 1 if (scalar(@old_additional) - 1) != $i;
2463 $pkg_opt{'additional_count'} = $i if $i > 0;
2466 if ( exists($opt{'classnum'}) and $part_pkg->classnum ne $opt{'classnum'} )
2469 $old_classnum = $part_pkg->classnum;
2470 $part_pkg->set('classnum', $opt{'classnum'});
2473 if ( !$self->get('setup') ) {
2474 # not yet billed, so allow amount, setup_cost, quantity, start_date,
2477 if ( exists($opt{'amount'})
2478 and $part_pkg->option('setup_fee') != $opt{'amount'}
2479 and $opt{'amount'} > 0 ) {
2481 $pkg_opt{'setup_fee'} = $opt{'amount'};
2482 $pkg_opt_modified = 1;
2485 if ( exists($opt{'setup_cost'})
2486 and $part_pkg->setup_cost != $opt{'setup_cost'}
2487 and $opt{'setup_cost'} > 0 ) {
2489 $part_pkg->set('setup_cost', $opt{'setup_cost'});
2492 if ( exists($opt{'quantity'})
2493 and $opt{'quantity'} != $self->quantity
2494 and $opt{'quantity'} > 0 ) {
2496 $self->set('quantity', $opt{'quantity'});
2499 if ( exists($opt{'start_date'})
2500 and $opt{'start_date'} != $self->start_date ) {
2502 $self->set('start_date', $opt{'start_date'});
2505 if ( exists($opt{'separate_bill'})
2506 and $opt{'separate_bill'} ne $self->separate_bill ) {
2508 $self->set('separate_bill', $opt{'separate_bill'});
2512 } # else simply ignore them; the UI shouldn't allow editing the fields
2515 if ( exists($opt{'taxclass'})
2516 and $part_pkg->taxclass ne $opt{'taxclass'}) {
2518 $part_pkg->set('taxclass', $opt{'taxclass'});
2522 if ( $part_pkg->modified or $pkg_opt_modified ) {
2523 # can we safely modify the package def?
2524 # Yes, if it's not available for purchase, and this is the only instance
2526 if ( $part_pkg->disabled
2527 and FS::cust_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 1
2528 and FS::quotation_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 0
2530 $error = $part_pkg->replace( options => \%pkg_opt );
2533 $part_pkg = $part_pkg->clone;
2534 $part_pkg->set('disabled' => 'Y');
2535 $error = $part_pkg->insert( options => \%pkg_opt );
2536 # and associate this as yet-unbilled package to the new package def
2537 $self->set('pkgpart' => $part_pkg->pkgpart);
2540 $dbh->rollback if $oldAutoCommit;
2545 if ($self->modified) { # for quantity or start_date change, or if we had
2546 # to clone the existing package def
2547 my $error = $self->replace;
2548 return $error if $error;
2550 if (defined $old_classnum) {
2551 # fix invoice grouping records
2552 my $old_catname = $old_classnum
2553 ? FS::pkg_class->by_key($old_classnum)->categoryname
2555 my $new_catname = $opt{'classnum'}
2556 ? $part_pkg->pkg_class->categoryname
2558 if ( $old_catname ne $new_catname ) {
2559 foreach my $cust_bill_pkg ($self->cust_bill_pkg) {
2560 # (there should only be one...)
2561 my @display = qsearch( 'cust_bill_pkg_display', {
2562 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2563 'section' => $old_catname,
2565 foreach (@display) {
2566 $_->set('section', $new_catname);
2567 $error = $_->replace;
2569 $dbh->rollback if $oldAutoCommit;
2573 } # foreach $cust_bill_pkg
2576 if ( $opt{'adjust_commission'} ) {
2577 # fix commission credits...tricky.
2578 foreach my $cust_event ($self->cust_event) {
2579 my $part_event = $cust_event->part_event;
2580 foreach my $table (qw(sales agent)) {
2582 "FS::part_event::Action::Mixin::credit_${table}_pkg_class";
2583 my $credit = qsearchs('cust_credit', {
2584 'eventnum' => $cust_event->eventnum,
2586 if ( $part_event->isa($class) ) {
2587 # Yes, this results in current commission rates being applied
2588 # retroactively to a one-time charge. For accounting purposes
2589 # there ought to be some kind of time limit on doing this.
2590 my $amount = $part_event->_calc_credit($self);
2591 if ( $credit and $credit->amount ne $amount ) {
2592 # Void the old credit.
2593 $error = $credit->void('Package class changed');
2595 $dbh->rollback if $oldAutoCommit;
2596 return "$error (adjusting commission credit)";
2599 # redo the event action to recreate the credit.
2601 eval { $part_event->do_action( $self, $cust_event ) };
2603 $dbh->rollback if $oldAutoCommit;
2606 } # if $part_event->isa($class)
2608 } # foreach $cust_event
2609 } # if $opt{'adjust_commission'}
2610 } # if defined $old_classnum
2612 $dbh->commit if $oldAutoCommit;
2619 sub process_bulk_cust_pkg {
2622 warn Dumper($param) if $DEBUG;
2624 my $old_part_pkg = qsearchs('part_pkg',
2625 { pkgpart => $param->{'old_pkgpart'} });
2626 my $new_part_pkg = qsearchs('part_pkg',
2627 { pkgpart => $param->{'new_pkgpart'} });
2628 die "Must select a new package type\n" unless $new_part_pkg;
2629 #my $keep_dates = $param->{'keep_dates'} || 0;
2630 my $keep_dates = 1; # there is no good reason to turn this off
2632 my $oldAutoCommit = $FS::UID::AutoCommit;
2633 local $FS::UID::AutoCommit = 0;
2636 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
2639 foreach my $old_cust_pkg ( @cust_pkgs ) {
2641 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
2642 if ( $old_cust_pkg->getfield('cancel') ) {
2643 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
2644 $old_cust_pkg->pkgnum."\n"
2648 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
2650 my $error = $old_cust_pkg->change(
2651 'pkgpart' => $param->{'new_pkgpart'},
2652 'keep_dates' => $keep_dates
2654 if ( !ref($error) ) { # change returns the cust_pkg on success
2656 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
2659 $dbh->commit if $oldAutoCommit;
2665 Returns the last bill date, or if there is no last bill date, the setup date.
2666 Useful for billing metered services.
2672 return $self->setfield('last_bill', $_[0]) if @_;
2673 return $self->getfield('last_bill') if $self->getfield('last_bill');
2674 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
2675 'edate' => $self->bill, } );
2676 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
2679 =item last_cust_pkg_reason ACTION
2681 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
2682 Returns false if there is no reason or the package is not currenly ACTION'd
2683 ACTION is one of adjourn, susp, cancel, or expire.
2687 sub last_cust_pkg_reason {
2688 my ( $self, $action ) = ( shift, shift );
2689 my $date = $self->get($action);
2691 'table' => 'cust_pkg_reason',
2692 'hashref' => { 'pkgnum' => $self->pkgnum,
2693 'action' => substr(uc($action), 0, 1),
2696 'order_by' => 'ORDER BY num DESC LIMIT 1',
2700 =item last_reason ACTION
2702 Returns the most recent ACTION FS::reason associated with the package.
2703 Returns false if there is no reason or the package is not currenly ACTION'd
2704 ACTION is one of adjourn, susp, cancel, or expire.
2709 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
2710 $cust_pkg_reason->reason
2711 if $cust_pkg_reason;
2716 Returns the definition for this billing item, as an FS::part_pkg object (see
2723 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
2724 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
2725 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
2730 Returns the cancelled package this package was changed from, if any.
2736 return '' unless $self->change_pkgnum;
2737 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
2740 =item change_cust_main
2742 Returns the customter this package was detached to, if any.
2746 sub change_cust_main {
2748 return '' unless $self->change_custnum;
2749 qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
2754 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
2761 $self->part_pkg->calc_setup($self, @_);
2766 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
2773 $self->part_pkg->calc_recur($self, @_);
2778 Calls the I<base_setup> of the FS::part_pkg object associated with this billing
2785 $self->part_pkg->base_setup($self, @_);
2790 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
2797 $self->part_pkg->base_recur($self, @_);
2802 Calls the I<calc_remain> of the FS::part_pkg object associated with this
2809 $self->part_pkg->calc_remain($self, @_);
2814 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
2821 $self->part_pkg->calc_cancel($self, @_);
2826 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
2832 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
2835 =item cust_pkg_detail [ DETAILTYPE ]
2837 Returns any customer package details for this package (see
2838 L<FS::cust_pkg_detail>).
2840 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2844 sub cust_pkg_detail {
2846 my %hash = ( 'pkgnum' => $self->pkgnum );
2847 $hash{detailtype} = shift if @_;
2849 'table' => 'cust_pkg_detail',
2850 'hashref' => \%hash,
2851 'order_by' => 'ORDER BY weight, pkgdetailnum',
2855 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
2857 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
2859 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2861 If there is an error, returns the error, otherwise returns false.
2865 sub set_cust_pkg_detail {
2866 my( $self, $detailtype, @details ) = @_;
2868 my $oldAutoCommit = $FS::UID::AutoCommit;
2869 local $FS::UID::AutoCommit = 0;
2872 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
2873 my $error = $current->delete;
2875 $dbh->rollback if $oldAutoCommit;
2876 return "error removing old detail: $error";
2880 foreach my $detail ( @details ) {
2881 my $cust_pkg_detail = new FS::cust_pkg_detail {
2882 'pkgnum' => $self->pkgnum,
2883 'detailtype' => $detailtype,
2884 'detail' => $detail,
2886 my $error = $cust_pkg_detail->insert;
2888 $dbh->rollback if $oldAutoCommit;
2889 return "error adding new detail: $error";
2894 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2901 Returns the customer billing events (see L<FS::cust_event>) for this invoice.
2905 #false laziness w/cust_bill.pm
2909 'table' => 'cust_event',
2910 'addl_from' => 'JOIN part_event USING ( eventpart )',
2911 'hashref' => { 'tablenum' => $self->pkgnum },
2912 'extra_sql' => " AND eventtable = 'cust_pkg' ",
2916 =item num_cust_event
2918 Returns the number of customer billing events (see L<FS::cust_event>) for this package.
2922 #false laziness w/cust_bill.pm
2923 sub num_cust_event {
2925 my $sql = "SELECT COUNT(*) ". $self->_from_cust_event_where;
2926 $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref->[0];
2929 =item exists_cust_event
2931 Returns true if there are customer billing events (see L<FS::cust_event>) for this package. More efficient than using num_cust_event.
2935 sub exists_cust_event {
2937 my $sql = "SELECT 1 ". $self->_from_cust_event_where. " LIMIT 1";
2938 my $row = $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref;
2939 $row ? $row->[0] : '';
2942 sub _from_cust_event_where {
2944 " FROM cust_event JOIN part_event USING ( eventpart ) ".
2945 " WHERE tablenum = ? AND eventtable = 'cust_pkg' ";
2949 my( $self, $sql, @args ) = @_;
2950 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
2951 $sth->execute(@args) or die $sth->errstr. " executing $sql";
2955 =item part_pkg_currency_option OPTIONNAME
2957 Returns a two item list consisting of the currency of this customer, if any,
2958 and a value for the provided option. If the customer has a currency, the value
2959 is the option value the given name and the currency (see
2960 L<FS::part_pkg_currency>). Otherwise, if the customer has no currency, is the
2961 regular option value for the given name (see L<FS::part_pkg_option>).
2965 sub part_pkg_currency_option {
2966 my( $self, $optionname ) = @_;
2967 my $part_pkg = $self->part_pkg;
2968 if ( my $currency = $self->cust_main->currency ) {
2969 ($currency, $part_pkg->part_pkg_currency_option($currency, $optionname) );
2971 ('', $part_pkg->option($optionname) );
2975 =item cust_svc [ SVCPART ] (old, deprecated usage)
2977 =item cust_svc [ OPTION => VALUE ... ] (current usage)
2979 =item cust_svc_unsorted [ OPTION => VALUE ... ]
2981 Returns the services for this package, as FS::cust_svc objects (see
2982 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
2983 spcififed, returns only the matching services.
2985 As an optimization, use the cust_svc_unsorted version if you are not displaying
2992 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
2993 $self->_sort_cust_svc( $self->cust_svc_unsorted_arrayref(@_) );
2996 sub cust_svc_unsorted {
2998 @{ $self->cust_svc_unsorted_arrayref(@_) };
3001 sub cust_svc_unsorted_arrayref {
3004 return [] unless $self->num_cust_svc(@_);
3007 if ( @_ && $_[0] =~ /^\d+/ ) {
3008 $opt{svcpart} = shift;
3009 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3016 'table' => 'cust_svc',
3017 'hashref' => { 'pkgnum' => $self->pkgnum },
3019 if ( $opt{svcpart} ) {
3020 $search{hashref}->{svcpart} = $opt{'svcpart'};
3022 if ( $opt{'svcdb'} ) {
3023 $search{addl_from} = ' LEFT JOIN part_svc USING ( svcpart ) ';
3024 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{'svcdb'} );
3027 [ qsearch(\%search) ];
3031 =item overlimit [ SVCPART ]
3033 Returns the services for this package which have exceeded their
3034 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
3035 is specified, return only the matching services.
3041 return () unless $self->num_cust_svc(@_);
3042 grep { $_->overlimit } $self->cust_svc(@_);
3045 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3047 Returns historical services for this package created before END TIMESTAMP and
3048 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
3049 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
3050 I<pkg_svc.hidden> flag will be omitted.
3056 warn "$me _h_cust_svc called on $self\n"
3059 my ($end, $start, $mode) = @_;
3061 local($FS::Record::qsearch_qualify_columns) = 0;
3063 my @cust_svc = $self->_sort_cust_svc(
3064 [ qsearch( 'h_cust_svc',
3065 { 'pkgnum' => $self->pkgnum, },
3066 FS::h_cust_svc->sql_h_search(@_),
3070 if ( defined($mode) && $mode eq 'I' ) {
3071 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
3072 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
3078 sub _sort_cust_svc {
3079 my( $self, $arrayref ) = @_;
3082 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
3084 my %pkg_svc = map { $_->svcpart => $_ }
3085 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
3090 my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
3092 $pkg_svc ? $pkg_svc->primary_svc : '',
3093 $pkg_svc ? $pkg_svc->quantity : 0,
3100 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
3102 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
3104 Returns the number of services for this package. Available options are svcpart
3105 and svcdb. If either is spcififed, returns only the matching services.
3112 return $self->{'_num_cust_svc'}
3114 && exists($self->{'_num_cust_svc'})
3115 && $self->{'_num_cust_svc'} =~ /\d/;
3117 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
3121 if ( @_ && $_[0] =~ /^\d+/ ) {
3122 $opt{svcpart} = shift;
3123 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3129 my $select = 'SELECT COUNT(*) FROM cust_svc ';
3130 my $where = ' WHERE pkgnum = ? ';
3131 my @param = ($self->pkgnum);
3133 if ( $opt{'svcpart'} ) {
3134 $where .= ' AND svcpart = ? ';
3135 push @param, $opt{'svcpart'};
3137 if ( $opt{'svcdb'} ) {
3138 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
3139 $where .= ' AND svcdb = ? ';
3140 push @param, $opt{'svcdb'};
3143 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
3144 $sth->execute(@param) or die $sth->errstr;
3145 $sth->fetchrow_arrayref->[0];
3148 =item available_part_svc
3150 Returns a list of FS::part_svc objects representing services included in this
3151 package but not yet provisioned. Each FS::part_svc object also has an extra
3152 field, I<num_avail>, which specifies the number of available services.
3156 sub available_part_svc {
3159 my $pkg_quantity = $self->quantity || 1;
3161 grep { $_->num_avail > 0 }
3163 my $part_svc = $_->part_svc;
3164 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
3165 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
3167 # more evil encapsulation breakage
3168 if($part_svc->{'Hash'}{'num_avail'} > 0) {
3169 my @exports = $part_svc->part_export_did;
3170 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
3175 $self->part_pkg->pkg_svc;
3178 =item part_svc [ OPTION => VALUE ... ]
3180 Returns a list of FS::part_svc objects representing provisioned and available
3181 services included in this package. Each FS::part_svc object also has the
3182 following extra fields:
3196 (services) - array reference containing the provisioned services, as cust_svc objects
3200 Accepts two options:
3204 =item summarize_size
3206 If true, will omit the extra cust_pkg_svc option for objects where num_cust_svc
3207 is this size or greater.
3209 =item hide_discontinued
3211 If true, will omit looking for services that are no longer avaialble in the
3219 #label -> ($cust_svc->label)[1]
3225 my $pkg_quantity = $self->quantity || 1;
3227 #XXX some sort of sort order besides numeric by svcpart...
3228 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
3230 my $part_svc = $pkg_svc->part_svc;
3231 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3232 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
3233 $part_svc->{'Hash'}{'num_avail'} =
3234 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
3235 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3236 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
3237 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
3238 && $num_cust_svc >= $opt{summarize_size};
3239 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
3241 } $self->part_pkg->pkg_svc;
3243 unless ( $opt{hide_discontinued} ) {
3245 push @part_svc, map {
3247 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3248 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
3249 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
3250 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3251 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
3253 } $self->extra_part_svc;
3260 =item extra_part_svc
3262 Returns a list of FS::part_svc objects corresponding to services in this
3263 package which are still provisioned but not (any longer) available in the
3268 sub extra_part_svc {
3271 my $pkgnum = $self->pkgnum;
3272 #my $pkgpart = $self->pkgpart;
3275 # 'table' => 'part_svc',
3278 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
3279 # WHERE pkg_svc.svcpart = part_svc.svcpart
3280 # AND pkg_svc.pkgpart = ?
3283 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
3284 # LEFT JOIN cust_pkg USING ( pkgnum )
3285 # WHERE cust_svc.svcpart = part_svc.svcpart
3288 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
3291 #seems to benchmark slightly faster... (or did?)
3293 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
3294 my $pkgparts = join(',', @pkgparts);
3297 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
3298 #MySQL doesn't grok DISINCT ON
3299 'select' => 'DISTINCT part_svc.*',
3300 'table' => 'part_svc',
3302 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
3303 AND pkg_svc.pkgpart IN ($pkgparts)
3306 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
3307 LEFT JOIN cust_pkg USING ( pkgnum )
3310 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
3311 'extra_param' => [ [$self->pkgnum=>'int'] ],
3317 Returns a short status string for this package, currently:
3323 =item not yet billed
3325 =item one-time charge
3340 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
3342 return 'cancelled' if $self->get('cancel');
3343 return 'on hold' if $self->susp && ! $self->setup;
3344 return 'suspended' if $self->susp;
3345 return 'not yet billed' unless $self->setup;
3346 return 'one-time charge' if $freq =~ /^(0|$)/;
3350 =item ucfirst_status
3352 Returns the status with the first character capitalized.
3356 sub ucfirst_status {
3357 ucfirst(shift->status);
3362 Class method that returns the list of possible status strings for packages
3363 (see L<the status method|/status>). For example:
3365 @statuses = FS::cust_pkg->statuses();
3369 tie my %statuscolor, 'Tie::IxHash',
3370 'on hold' => 'FF00F5', #brighter purple!
3371 'not yet billed' => '009999', #teal? cyan?
3372 'one-time charge' => '0000CC', #blue #'000000',
3373 'active' => '00CC00',
3374 'suspended' => 'FF9900',
3375 'cancelled' => 'FF0000',
3379 my $self = shift; #could be class...
3380 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
3381 # # mayble split btw one-time vs. recur
3392 Returns a hex triplet color string for this package's status.
3398 $statuscolor{$self->status};
3401 =item is_status_delay_cancel
3403 Returns true if part_pkg has option delay_cancel,
3404 cust_pkg status is 'suspended' and expire is set
3405 to cancel package within the next day (or however
3406 many days are set in global config part_pkg-delay_cancel-days.
3408 This is not a real status, this only meant for hacking display
3409 values, because otherwise treating the package as suspended is
3410 really the whole point of the delay_cancel option.
3414 sub is_status_delay_cancel {
3416 if ( $self->main_pkgnum and $self->pkglinknum ) {
3417 return $self->main_pkg->is_status_delay_cancel;
3419 return 0 unless $self->part_pkg->option('delay_cancel',1);
3420 return 0 unless $self->status eq 'suspended';
3421 return 0 unless $self->expire;
3422 my $conf = new FS::Conf;
3423 my $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
3424 my $expsecs = 60*60*24*$expdays;
3425 return 0 unless $self->expire < time + $expsecs;
3431 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
3432 "pkg - comment" depending on user preference).
3438 my $label = $self->part_pkg->pkg_comment( cust_pkg=>$self, nopkgpart=>1 );
3439 $label = $self->pkgnum. ": $label"
3440 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
3444 =item pkg_label_long
3446 Returns a long label for this package, adding the primary service's label to
3451 sub pkg_label_long {
3453 my $label = $self->pkg_label;
3454 my $cust_svc = $self->primary_cust_svc;
3455 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
3461 Returns a customer-localized label for this package.
3467 $self->part_pkg->pkg_locale( $self->cust_main->locale );
3470 =item primary_cust_svc
3472 Returns a primary service (as FS::cust_svc object) if one can be identified.
3476 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
3478 sub primary_cust_svc {
3481 my @cust_svc = $self->cust_svc;
3483 return '' unless @cust_svc; #no serivces - irrelevant then
3485 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
3487 # primary service as specified in the package definition
3488 # or exactly one service definition with quantity one
3489 my $svcpart = $self->part_pkg->svcpart;
3490 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
3491 return $cust_svc[0] if scalar(@cust_svc) == 1;
3493 #couldn't identify one thing..
3499 Returns a list of lists, calling the label method for all services
3500 (see L<FS::cust_svc>) of this billing item.
3506 map { [ $_->label ] } $self->cust_svc;
3509 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3511 Like the labels method, but returns historical information on services that
3512 were active as of END_TIMESTAMP and (optionally) not cancelled before
3513 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
3514 I<pkg_svc.hidden> flag will be omitted.
3516 Returns a list of lists, calling the label method for all (historical) services
3517 (see L<FS::h_cust_svc>) of this billing item.
3523 warn "$me _h_labels called on $self\n"
3525 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
3530 Like labels, except returns a simple flat list, and shortens long
3531 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3532 identical services to one line that lists the service label and the number of
3533 individual services rather than individual items.
3538 shift->_labels_short( 'labels', @_ );
3541 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
3543 Like h_labels, except returns a simple flat list, and shortens long
3544 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3545 identical services to one line that lists the service label and the number of
3546 individual services rather than individual items.
3550 sub h_labels_short {
3551 shift->_labels_short( 'h_labels', @_ );
3555 my( $self, $method ) = ( shift, shift );
3557 warn "$me _labels_short called on $self with $method method\n"
3560 my $conf = new FS::Conf;
3561 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
3563 warn "$me _labels_short populating \%labels\n"
3567 #tie %labels, 'Tie::IxHash';
3568 push @{ $labels{$_->[0]} }, $_->[1]
3569 foreach $self->$method(@_);
3571 warn "$me _labels_short populating \@labels\n"
3575 foreach my $label ( keys %labels ) {
3577 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
3578 my $num = scalar(@values);
3579 warn "$me _labels_short $num items for $label\n"
3582 if ( $num > $max_same_services ) {
3583 warn "$me _labels_short more than $max_same_services, so summarizing\n"
3585 push @labels, "$label ($num)";
3587 if ( $conf->exists('cust_bill-consolidate_services') ) {
3588 warn "$me _labels_short consolidating services\n"
3590 # push @labels, "$label: ". join(', ', @values);
3592 my $detail = "$label: ";
3593 $detail .= shift(@values). ', '
3595 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
3597 push @labels, $detail;
3599 warn "$me _labels_short done consolidating services\n"
3602 warn "$me _labels_short adding service data\n"
3604 push @labels, map { "$label: $_" } @values;
3615 Returns the parent customer object (see L<FS::cust_main>).
3619 Returns the balance for this specific package, when using
3620 experimental package balance.
3626 $self->cust_main->balance_pkgnum( $self->pkgnum );
3629 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
3633 Returns the location object, if any (see L<FS::cust_location>).
3635 =item cust_location_or_main
3637 If this package is associated with a location, returns the locaiton (see
3638 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
3640 =item location_label [ OPTION => VALUE ... ]
3642 Returns the label of the location object (see L<FS::cust_location>).
3646 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
3648 =item tax_locationnum
3650 Returns the foreign key to a L<FS::cust_location> object for calculating
3651 tax on this package, as determined by the C<tax-pkg_address> and
3652 C<tax-ship_address> configuration flags.
3656 sub tax_locationnum {
3658 my $conf = FS::Conf->new;
3659 if ( $conf->exists('tax-pkg_address') ) {
3660 return $self->locationnum;
3662 elsif ( $conf->exists('tax-ship_address') ) {
3663 return $self->cust_main->ship_locationnum;
3666 return $self->cust_main->bill_locationnum;
3672 Returns the L<FS::cust_location> object for tax_locationnum.
3678 my $conf = FS::Conf->new;
3679 if ( $conf->exists('tax-pkg_address') and $self->locationnum ) {
3680 return FS::cust_location->by_key($self->locationnum);
3682 elsif ( $conf->exists('tax-ship_address') ) {
3683 return $self->cust_main->ship_location;
3686 return $self->cust_main->bill_location;
3690 =item seconds_since TIMESTAMP
3692 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
3693 package have been online since TIMESTAMP, according to the session monitor.
3695 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
3696 L<Time::Local> and L<Date::Parse> for conversion functions.
3701 my($self, $since) = @_;
3704 foreach my $cust_svc (
3705 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
3707 $seconds += $cust_svc->seconds_since($since);
3714 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
3716 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
3717 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
3720 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3721 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3727 sub seconds_since_sqlradacct {
3728 my($self, $start, $end) = @_;
3732 foreach my $cust_svc (
3734 my $part_svc = $_->part_svc;
3735 $part_svc->svcdb eq 'svc_acct'
3736 && scalar($part_svc->part_export_usage);
3739 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
3746 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
3748 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
3749 in this package for sessions ending between TIMESTAMP_START (inclusive) and
3753 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3754 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3759 sub attribute_since_sqlradacct {
3760 my($self, $start, $end, $attrib) = @_;
3764 foreach my $cust_svc (
3766 my $part_svc = $_->part_svc;
3767 scalar($part_svc->part_export_usage);
3770 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
3782 my( $self, $value ) = @_;
3783 if ( defined($value) ) {
3784 $self->setfield('quantity', $value);
3786 $self->getfield('quantity') || 1;
3789 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
3791 Transfers as many services as possible from this package to another package.
3793 The destination package can be specified by pkgnum by passing an FS::cust_pkg
3794 object. The destination package must already exist.
3796 Services are moved only if the destination allows services with the correct
3797 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
3798 this option with caution! No provision is made for export differences
3799 between the old and new service definitions. Probably only should be used
3800 when your exports for all service definitions of a given svcdb are identical.
3801 (attempt a transfer without it first, to move all possible svcpart-matching
3804 Any services that can't be moved remain in the original package.
3806 Returns an error, if there is one; otherwise, returns the number of services
3807 that couldn't be moved.
3812 my ($self, $dest_pkgnum, %opt) = @_;
3818 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
3819 $dest = $dest_pkgnum;
3820 $dest_pkgnum = $dest->pkgnum;
3822 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
3825 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
3827 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
3828 $target{$pkg_svc->svcpart} = $pkg_svc->quantity * ( $dest->quantity || 1 );
3831 foreach my $cust_svc ($dest->cust_svc) {
3832 $target{$cust_svc->svcpart}--;
3835 my %svcpart2svcparts = ();
3836 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3837 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
3838 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
3839 next if exists $svcpart2svcparts{$svcpart};
3840 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
3841 $svcpart2svcparts{$svcpart} = [
3843 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
3845 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
3846 'svcpart' => $_ } );
3848 $pkg_svc ? $pkg_svc->primary_svc : '',
3849 $pkg_svc ? $pkg_svc->quantity : 0,
3853 grep { $_ != $svcpart }
3855 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
3857 warn "alternates for svcpart $svcpart: ".
3858 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
3864 foreach my $cust_svc ($self->cust_svc) {
3865 my $svcnum = $cust_svc->svcnum;
3866 if($target{$cust_svc->svcpart} > 0
3867 or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
3868 $target{$cust_svc->svcpart}--;
3869 my $new = new FS::cust_svc { $cust_svc->hash };
3870 $new->pkgnum($dest_pkgnum);
3871 $error = $new->replace($cust_svc);
3872 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3874 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
3875 warn "alternates to consider: ".
3876 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
3878 my @alternate = grep {
3879 warn "considering alternate svcpart $_: ".
3880 "$target{$_} available in new package\n"
3883 } @{$svcpart2svcparts{$cust_svc->svcpart}};
3885 warn "alternate(s) found\n" if $DEBUG;
3886 my $change_svcpart = $alternate[0];
3887 $target{$change_svcpart}--;
3888 my $new = new FS::cust_svc { $cust_svc->hash };
3889 $new->svcpart($change_svcpart);
3890 $new->pkgnum($dest_pkgnum);
3891 $error = $new->replace($cust_svc);
3899 my @label = $cust_svc->label;
3900 return "$label[0] $label[1]: $error";
3906 =item grab_svcnums SVCNUM, SVCNUM ...
3908 Change the pkgnum for the provided services to this packages. If there is an
3909 error, returns the error, otherwise returns false.
3917 my $oldAutoCommit = $FS::UID::AutoCommit;
3918 local $FS::UID::AutoCommit = 0;
3921 foreach my $svcnum (@svcnum) {
3922 my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
3923 $dbh->rollback if $oldAutoCommit;
3924 return "unknown svcnum $svcnum";
3926 $cust_svc->pkgnum( $self->pkgnum );
3927 my $error = $cust_svc->replace;
3929 $dbh->rollback if $oldAutoCommit;
3934 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3941 This method is deprecated. See the I<depend_jobnum> option to the insert and
3942 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
3946 #looks like this is still used by the order_pkg and change_pkg methods in
3947 # ClientAPI/MyAccount, need to look into those before removing
3951 my $oldAutoCommit = $FS::UID::AutoCommit;
3952 local $FS::UID::AutoCommit = 0;
3955 foreach my $cust_svc ( $self->cust_svc ) {
3956 #false laziness w/svc_Common::insert
3957 my $svc_x = $cust_svc->svc_x;
3958 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
3959 my $error = $part_export->export_insert($svc_x);
3961 $dbh->rollback if $oldAutoCommit;
3967 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3972 =item export_pkg_change OLD_CUST_PKG
3974 Calls the "pkg_change" export action for all services attached to this package.
3978 sub export_pkg_change {
3979 my( $self, $old ) = ( shift, shift );
3981 my $oldAutoCommit = $FS::UID::AutoCommit;
3982 local $FS::UID::AutoCommit = 0;
3985 foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
3986 my $error = $svc_x->export('pkg_change', $self, $old);
3988 $dbh->rollback if $oldAutoCommit;
3993 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4000 Associates this package with a (suspension or cancellation) reason (see
4001 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
4004 Available options are:
4010 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.
4014 the access_user (see L<FS::access_user>) providing the reason
4022 the action (cancel, susp, adjourn, expire) associated with the reason
4026 If there is an error, returns the error, otherwise returns false.
4031 my ($self, %options) = @_;
4033 my $otaker = $options{reason_otaker} ||
4034 $FS::CurrentUser::CurrentUser->username;
4037 if ( $options{'reason'} =~ /^(\d+)$/ ) {
4041 } elsif ( ref($options{'reason'}) ) {
4043 return 'Enter a new reason (or select an existing one)'
4044 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
4046 my $reason = new FS::reason({
4047 'reason_type' => $options{'reason'}->{'typenum'},
4048 'reason' => $options{'reason'}->{'reason'},
4050 my $error = $reason->insert;
4051 return $error if $error;
4053 $reasonnum = $reason->reasonnum;
4056 return "Unparseable reason: ". $options{'reason'};
4059 my $cust_pkg_reason =
4060 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
4061 'reasonnum' => $reasonnum,
4062 'otaker' => $otaker,
4063 'action' => substr(uc($options{'action'}),0,1),
4064 'date' => $options{'date'}
4069 $cust_pkg_reason->insert;
4072 =item insert_discount
4074 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
4075 inserting a new discount on the fly (see L<FS::discount>).
4077 Available options are:
4085 If there is an error, returns the error, otherwise returns false.
4089 sub insert_discount {
4090 #my ($self, %options) = @_;
4093 my $cust_pkg_discount = new FS::cust_pkg_discount {
4094 'pkgnum' => $self->pkgnum,
4095 'discountnum' => $self->discountnum,
4097 'end_date' => '', #XXX
4098 #for the create a new discount case
4099 '_type' => $self->discountnum__type,
4100 'amount' => $self->discountnum_amount,
4101 'percent' => $self->discountnum_percent,
4102 'months' => $self->discountnum_months,
4103 'setup' => $self->discountnum_setup,
4104 #'disabled' => $self->discountnum_disabled,
4107 $cust_pkg_discount->insert;
4110 =item set_usage USAGE_VALUE_HASHREF
4112 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4113 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4114 upbytes, downbytes, and totalbytes are appropriate keys.
4116 All svc_accts which are part of this package have their values reset.
4121 my ($self, $valueref, %opt) = @_;
4123 #only svc_acct can set_usage for now
4124 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4125 my $svc_x = $cust_svc->svc_x;
4126 $svc_x->set_usage($valueref, %opt)
4127 if $svc_x->can("set_usage");
4131 =item recharge USAGE_VALUE_HASHREF
4133 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4134 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4135 upbytes, downbytes, and totalbytes are appropriate keys.
4137 All svc_accts which are part of this package have their values incremented.
4142 my ($self, $valueref) = @_;
4144 #only svc_acct can set_usage for now
4145 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4146 my $svc_x = $cust_svc->svc_x;
4147 $svc_x->recharge($valueref)
4148 if $svc_x->can("recharge");
4152 =item apply_usageprice
4156 sub apply_usageprice {
4159 my $oldAutoCommit = $FS::UID::AutoCommit;
4160 local $FS::UID::AutoCommit = 0;
4165 foreach my $cust_pkg_usageprice ( $self->cust_pkg_usageprice ) {
4166 $error ||= $cust_pkg_usageprice->apply;
4170 $dbh->rollback if $oldAutoCommit;
4171 die "error applying part_pkg_usageprice add-ons, pkgnum ". $self->pkgnum.
4174 $dbh->commit if $oldAutoCommit;
4180 =item cust_pkg_discount
4182 =item cust_pkg_discount_active
4186 sub cust_pkg_discount_active {
4188 grep { $_->status eq 'active' } $self->cust_pkg_discount;
4191 =item cust_pkg_usage
4193 Returns a list of all voice usage counters attached to this package.
4195 =item apply_usage OPTIONS
4197 Takes the following options:
4198 - cdr: a call detail record (L<FS::cdr>)
4199 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
4200 - minutes: the maximum number of minutes to be charged
4202 Finds available usage minutes for a call of this class, and subtracts
4203 up to that many minutes from the usage pool. If the usage pool is empty,
4204 and the C<cdr-minutes_priority> global config option is set, minutes may
4205 be taken from other calls as well. Either way, an allocation record will
4206 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
4207 number of minutes of usage applied to the call.
4212 my ($self, %opt) = @_;
4213 my $cdr = $opt{cdr};
4214 my $rate_detail = $opt{rate_detail};
4215 my $minutes = $opt{minutes};
4216 my $classnum = $rate_detail->classnum;
4217 my $pkgnum = $self->pkgnum;
4218 my $custnum = $self->custnum;
4220 my $oldAutoCommit = $FS::UID::AutoCommit;
4221 local $FS::UID::AutoCommit = 0;
4224 my $order = FS::Conf->new->config('cdr-minutes_priority');
4228 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
4230 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
4232 my @usage_recs = qsearch({
4233 'table' => 'cust_pkg_usage',
4234 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
4235 ' JOIN cust_pkg USING (pkgnum)'.
4236 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
4237 'select' => 'cust_pkg_usage.*',
4238 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
4239 " ( cust_pkg.custnum = $custnum AND ".
4240 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4241 $is_classnum . ' AND '.
4242 " cust_pkg_usage.minutes > 0",
4243 'order_by' => " ORDER BY priority ASC",
4246 my $orig_minutes = $minutes;
4248 while (!$error and $minutes > 0 and @usage_recs) {
4249 my $cust_pkg_usage = shift @usage_recs;
4250 $cust_pkg_usage->select_for_update;
4251 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
4252 pkgusagenum => $cust_pkg_usage->pkgusagenum,
4253 acctid => $cdr->acctid,
4254 minutes => min($cust_pkg_usage->minutes, $minutes),
4256 $cust_pkg_usage->set('minutes',
4257 $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes
4259 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
4260 $minutes -= $cdr_cust_pkg_usage->minutes;
4262 if ( $order and $minutes > 0 and !$error ) {
4263 # then try to steal minutes from another call
4265 'table' => 'cdr_cust_pkg_usage',
4266 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
4267 ' JOIN part_pkg_usage USING (pkgusagepart)'.
4268 ' JOIN cust_pkg USING (pkgnum)'.
4269 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
4270 ' JOIN cdr USING (acctid)',
4271 'select' => 'cdr_cust_pkg_usage.*',
4272 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
4273 " ( cust_pkg.pkgnum = $pkgnum OR ".
4274 " ( cust_pkg.custnum = $custnum AND ".
4275 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4276 " part_pkg_usage_class.classnum = $classnum",
4277 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
4279 if ( $order eq 'time' ) {
4280 # find CDRs that are using minutes, but have a later startdate
4282 my $startdate = $cdr->startdate;
4283 if ($startdate !~ /^\d+$/) {
4284 die "bad cdr startdate '$startdate'";
4286 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
4287 # minimize needless reshuffling
4288 $search{'order_by'} .= ', cdr.startdate DESC';
4290 # XXX may not work correctly with rate_time schedules. Could
4291 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
4293 $search{'addl_from'} .=
4294 ' JOIN rate_detail'.
4295 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
4296 if ( $order eq 'rate_high' ) {
4297 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
4298 $rate_detail->min_charge;
4299 $search{'order_by'} .= ', rate_detail.min_charge ASC';
4300 } elsif ( $order eq 'rate_low' ) {
4301 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
4302 $rate_detail->min_charge;
4303 $search{'order_by'} .= ', rate_detail.min_charge DESC';
4305 # this should really never happen
4306 die "invalid cdr-minutes_priority value '$order'\n";
4309 my @cdr_usage_recs = qsearch(\%search);
4311 while (!$error and @cdr_usage_recs and $minutes > 0) {
4312 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
4313 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
4314 my $old_cdr = $cdr_cust_pkg_usage->cdr;
4315 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
4316 $cdr_cust_pkg_usage->select_for_update;
4317 $old_cdr->select_for_update;
4318 $cust_pkg_usage->select_for_update;
4319 # in case someone else stole the usage from this CDR
4320 # while waiting for the lock...
4321 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
4322 # steal the usage allocation and flag the old CDR for reprocessing
4323 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
4324 # if the allocation is more minutes than we need, adjust it...
4325 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
4327 $cdr_cust_pkg_usage->set('minutes', $minutes);
4328 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
4329 $error = $cust_pkg_usage->replace;
4331 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
4332 $error ||= $cdr_cust_pkg_usage->replace;
4333 # deduct the stolen minutes
4334 $minutes -= $cdr_cust_pkg_usage->minutes;
4336 # after all minute-stealing is done, reset the affected CDRs
4337 foreach (values %reproc_cdrs) {
4338 $error ||= $_->set_status('');
4339 # XXX or should we just call $cdr->rate right here?
4340 # it's not like we can create a loop this way, since the min_charge
4341 # or call time has to go monotonically in one direction.
4342 # we COULD get some very deep recursions going, though...
4344 } # if $order and $minutes
4347 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
4349 $dbh->commit if $oldAutoCommit;
4350 return $orig_minutes - $minutes;
4354 =item supplemental_pkgs
4356 Returns a list of all packages supplemental to this one.
4360 sub supplemental_pkgs {
4362 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
4367 Returns the package that this one is supplemental to, if any.
4373 if ( $self->main_pkgnum ) {
4374 return FS::cust_pkg->by_key($self->main_pkgnum);
4381 =head1 CLASS METHODS
4387 Returns an SQL expression identifying recurring packages.
4391 sub recurring_sql { "
4392 '0' != ( select freq from part_pkg
4393 where cust_pkg.pkgpart = part_pkg.pkgpart )
4398 Returns an SQL expression identifying one-time packages.
4403 '0' = ( select freq from part_pkg
4404 where cust_pkg.pkgpart = part_pkg.pkgpart )
4409 Returns an SQL expression identifying ordered packages (recurring packages not
4415 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
4420 Returns an SQL expression identifying active packages.
4425 $_[0]->recurring_sql. "
4426 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4427 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4428 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4431 =item not_yet_billed_sql
4433 Returns an SQL expression identifying packages which have not yet been billed.
4437 sub not_yet_billed_sql { "
4438 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4439 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4440 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4445 Returns an SQL expression identifying inactive packages (one-time packages
4446 that are otherwise unsuspended/uncancelled).
4450 sub inactive_sql { "
4451 ". $_[0]->onetime_sql(). "
4452 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4453 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4454 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4459 Returns an SQL expression identifying on-hold packages.
4464 #$_[0]->recurring_sql(). ' AND '.
4466 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4467 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4468 AND ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4475 Returns an SQL expression identifying suspended packages.
4479 sub suspended_sql { susp_sql(@_); }
4481 #$_[0]->recurring_sql(). ' AND '.
4483 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4484 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4485 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4492 Returns an SQL exprression identifying cancelled packages.
4496 sub cancelled_sql { cancel_sql(@_); }
4498 #$_[0]->recurring_sql(). ' AND '.
4499 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
4504 Returns an SQL expression to give the package status as a string.
4510 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
4511 WHEN ( cust_pkg.susp IS NOT NULL AND cust_pkg.setup IS NULL ) THEN 'on hold'
4512 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
4513 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
4514 WHEN ".onetime_sql()." THEN 'one-time charge'
4521 Returns a list of two package counts. The first is a count of packages
4522 based on the supplied criteria and the second is the count of residential
4523 packages with those same criteria. Criteria are specified as in the search
4529 my ($class, $params) = @_;
4531 my $sql_query = $class->search( $params );
4533 my $count_sql = delete($sql_query->{'count_query'});
4534 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
4535 or die "couldn't parse count_sql";
4537 my $count_sth = dbh->prepare($count_sql)
4538 or die "Error preparing $count_sql: ". dbh->errstr;
4540 or die "Error executing $count_sql: ". $count_sth->errstr;
4541 my $count_arrayref = $count_sth->fetchrow_arrayref;
4543 return ( @$count_arrayref );
4547 =item tax_locationnum_sql
4549 Returns an SQL expression for the tax location for a package, based
4550 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
4554 sub tax_locationnum_sql {
4555 my $conf = FS::Conf->new;
4556 if ( $conf->exists('tax-pkg_address') ) {
4557 'cust_pkg.locationnum';
4559 elsif ( $conf->exists('tax-ship_address') ) {
4560 'cust_main.ship_locationnum';
4563 'cust_main.bill_locationnum';
4569 Returns a list: the first item is an SQL fragment identifying matching
4570 packages/customers via location (taking into account shipping and package
4571 address taxation, if enabled), and subsequent items are the parameters to
4572 substitute for the placeholders in that fragment.
4577 my($class, %opt) = @_;
4578 my $ornull = $opt{'ornull'};
4580 my $conf = new FS::Conf;
4582 # '?' placeholders in _location_sql_where
4583 my $x = $ornull ? 3 : 2;
4594 if ( $conf->exists('tax-ship_address') ) {
4597 ( ( ship_last IS NULL OR ship_last = '' )
4598 AND ". _location_sql_where('cust_main', '', $ornull ). "
4600 OR ( ship_last IS NOT NULL AND ship_last != ''
4601 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
4604 # AND payby != 'COMP'
4606 @main_param = ( @bill_param, @bill_param );
4610 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
4611 @main_param = @bill_param;
4617 if ( $conf->exists('tax-pkg_address') ) {
4619 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
4622 ( cust_pkg.locationnum IS NULL AND $main_where )
4623 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
4626 @param = ( @main_param, @bill_param );
4630 $where = $main_where;
4631 @param = @main_param;
4639 #subroutine, helper for location_sql
4640 sub _location_sql_where {
4642 my $prefix = @_ ? shift : '';
4643 my $ornull = @_ ? shift : '';
4645 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
4647 $ornull = $ornull ? ' OR ? IS NULL ' : '';
4649 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
4650 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
4651 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
4653 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
4655 # ( $table.${prefix}city = ? $or_empty_city $ornull )
4657 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4658 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4659 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
4660 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
4661 AND $table.${prefix}country = ?
4666 my( $self, $what ) = @_;
4668 my $what_show_zero = $what. '_show_zero';
4669 length($self->$what_show_zero())
4670 ? ($self->$what_show_zero() eq 'Y')
4671 : $self->part_pkg->$what_show_zero();
4678 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
4680 CUSTNUM is a customer (see L<FS::cust_main>)
4682 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4683 L<FS::part_pkg>) to order for this customer. Duplicates are of course
4686 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
4687 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
4688 new billing items. An error is returned if this is not possible (see
4689 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
4692 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4693 newly-created cust_pkg objects.
4695 REFNUM, if specified, will specify the FS::pkg_referral record to be created
4696 and inserted. Multiple FS::pkg_referral records can be created by
4697 setting I<refnum> to an array reference of refnums or a hash reference with
4698 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
4699 record will be created corresponding to cust_main.refnum.
4704 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
4706 my $conf = new FS::Conf;
4708 # Transactionize this whole mess
4709 my $oldAutoCommit = $FS::UID::AutoCommit;
4710 local $FS::UID::AutoCommit = 0;
4714 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
4715 # return "Customer not found: $custnum" unless $cust_main;
4717 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
4720 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4723 my $change = scalar(@old_cust_pkg) != 0;
4726 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
4728 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
4729 " to pkgpart ". $pkgparts->[0]. "\n"
4732 my $err_or_cust_pkg =
4733 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
4734 'refnum' => $refnum,
4737 unless (ref($err_or_cust_pkg)) {
4738 $dbh->rollback if $oldAutoCommit;
4739 return $err_or_cust_pkg;
4742 push @$return_cust_pkg, $err_or_cust_pkg;
4743 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4748 # Create the new packages.
4749 foreach my $pkgpart (@$pkgparts) {
4751 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
4753 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
4754 pkgpart => $pkgpart,
4758 $error = $cust_pkg->insert( 'change' => $change );
4759 push @$return_cust_pkg, $cust_pkg;
4761 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
4762 my $supp_pkg = FS::cust_pkg->new({
4763 custnum => $custnum,
4764 pkgpart => $link->dst_pkgpart,
4766 main_pkgnum => $cust_pkg->pkgnum,
4769 $error ||= $supp_pkg->insert( 'change' => $change );
4770 push @$return_cust_pkg, $supp_pkg;
4774 $dbh->rollback if $oldAutoCommit;
4779 # $return_cust_pkg now contains refs to all of the newly
4782 # Transfer services and cancel old packages.
4783 foreach my $old_pkg (@old_cust_pkg) {
4785 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
4788 foreach my $new_pkg (@$return_cust_pkg) {
4789 $error = $old_pkg->transfer($new_pkg);
4790 if ($error and $error == 0) {
4791 # $old_pkg->transfer failed.
4792 $dbh->rollback if $oldAutoCommit;
4797 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
4798 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
4799 foreach my $new_pkg (@$return_cust_pkg) {
4800 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
4801 if ($error and $error == 0) {
4802 # $old_pkg->transfer failed.
4803 $dbh->rollback if $oldAutoCommit;
4810 # Transfers were successful, but we went through all of the
4811 # new packages and still had services left on the old package.
4812 # We can't cancel the package under the circumstances, so abort.
4813 $dbh->rollback if $oldAutoCommit;
4814 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
4816 $error = $old_pkg->cancel( quiet=>1 );
4822 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4826 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
4828 A bulk change method to change packages for multiple customers.
4830 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4831 L<FS::part_pkg>) to order for each customer. Duplicates are of course
4834 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
4835 replace. The services (see L<FS::cust_svc>) are moved to the
4836 new billing items. An error is returned if this is not possible (see
4839 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4840 newly-created cust_pkg objects.
4845 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
4847 # Transactionize this whole mess
4848 my $oldAutoCommit = $FS::UID::AutoCommit;
4849 local $FS::UID::AutoCommit = 0;
4853 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4856 while(scalar(@old_cust_pkg)) {
4858 my $custnum = $old_cust_pkg[0]->custnum;
4859 my (@remove) = map { $_->pkgnum }
4860 grep { $_->custnum == $custnum } @old_cust_pkg;
4861 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
4863 my $error = order $custnum, $pkgparts, \@remove, \@return;
4865 push @errors, $error
4867 push @$return_cust_pkg, @return;
4870 if (scalar(@errors)) {
4871 $dbh->rollback if $oldAutoCommit;
4872 return join(' / ', @errors);
4875 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4879 # Used by FS::Upgrade to migrate to a new database.
4880 sub _upgrade_data { # class method
4881 my ($class, %opts) = @_;
4882 $class->_upgrade_otaker(%opts);
4884 # RT#10139, bug resulting in contract_end being set when it shouldn't
4885 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
4886 # RT#10830, bad calculation of prorate date near end of year
4887 # the date range for bill is December 2009, and we move it forward
4888 # one year if it's before the previous bill date (which it should
4890 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
4891 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
4892 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
4893 # RT6628, add order_date to cust_pkg
4894 'update cust_pkg set order_date = (select history_date from h_cust_pkg
4895 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
4896 history_action = \'insert\') where order_date is null',
4898 foreach my $sql (@statements) {
4899 my $sth = dbh->prepare($sql);
4900 $sth->execute or die $sth->errstr;
4903 # RT31194: supplemental package links that are deleted don't clean up
4905 my @pkglinknums = qsearch({
4906 'select' => 'DISTINCT cust_pkg.pkglinknum',
4907 'table' => 'cust_pkg',
4908 'addl_from' => ' LEFT JOIN part_pkg_link USING (pkglinknum) ',
4909 'extra_sql' => ' WHERE cust_pkg.pkglinknum IS NOT NULL
4910 AND part_pkg_link.pkglinknum IS NULL',
4912 foreach (@pkglinknums) {
4913 my $pkglinknum = $_->pkglinknum;
4914 warn "cleaning part_pkg_link #$pkglinknum\n";
4915 my $part_pkg_link = FS::part_pkg_link->new({pkglinknum => $pkglinknum});
4916 my $error = $part_pkg_link->remove_linked;
4917 die $error if $error;
4925 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
4927 In sub order, the @pkgparts array (passed by reference) is clobbered.
4929 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
4930 method to pass dates to the recur_prog expression, it should do so.
4932 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
4933 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
4934 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
4935 configuration values. Probably need a subroutine which decides what to do
4936 based on whether or not we've fetched the user yet, rather than a hash. See
4937 FS::UID and the TODO.
4939 Now that things are transactional should the check in the insert method be
4944 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
4945 L<FS::pkg_svc>, schema.html from the base documentation