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
790 before cancelling, probably shouldn't be used otherwise (set the
791 corresponding package option instead)
793 =item no_delay_cancel - for internal use, prevents delay_cancel behavior
794 no matter what other options say, for use when changing packages (or any
795 other time you're really sure you want an unadulterated cancel)
799 If there is an error, returns the error, otherwise returns false.
804 my( $self, %options ) = @_;
807 # pass all suspend/cancel actions to the main package
808 # (unless the pkglinknum has been removed, then the link is defunct and
809 # this package can be canceled on its own)
810 if ( $self->main_pkgnum and $self->pkglinknum and !$options{'from_main'} ) {
811 return $self->main_pkg->cancel(%options);
814 my $conf = new FS::Conf;
816 warn "cust_pkg::cancel called with options".
817 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
820 my $oldAutoCommit = $FS::UID::AutoCommit;
821 local $FS::UID::AutoCommit = 0;
824 my $old = $self->select_for_update;
826 if ( $old->get('cancel') || $self->get('cancel') ) {
827 dbh->rollback if $oldAutoCommit;
828 return ""; # no error
831 # XXX possibly set cancel_time to the expire date?
832 my $cancel_time = $options{'time'} || time;
833 my $date = $options{'date'} if $options{'date'}; # expire/cancel later
834 $date = '' if ($date && $date <= $cancel_time); # complain instead?
836 my $delay_cancel = $options{'no_delay_cancel'} ? 0 : $options{'delay_cancel'};
837 if ( !$date && $self->part_pkg->option('delay_cancel',1)
838 && (($self->status eq 'active') || ($self->status eq 'suspended'))
839 && !$options{'no_delay_cancel'}
841 my $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
842 my $expsecs = 60*60*24*$expdays;
843 my $suspfor = $self->susp ? $cancel_time - $self->susp : 0;
844 $expsecs = $expsecs - $suspfor if $suspfor;
845 unless ($expsecs <= 0) { #if it's already been suspended long enough, don't re-suspend
847 $date = $cancel_time + $expsecs;
851 #race condition: usage could be ongoing until unprovisioned
852 #resolved by performing a change package instead (which unprovisions) and
854 if ( !$options{nobill} && !$date ) {
855 # && $conf->exists('bill_usage_on_cancel') ) { #calc_cancel checks this
856 my $copy = $self->new({$self->hash});
858 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
860 'time' => $cancel_time );
861 warn "Error billing during cancel, custnum ".
862 #$self->cust_main->custnum. ": $error"
867 if ( $options{'reason'} ) {
868 $error = $self->insert_reason( 'reason' => $options{'reason'},
869 'action' => $date ? 'expire' : 'cancel',
870 'date' => $date ? $date : $cancel_time,
871 'reason_otaker' => $options{'reason_otaker'},
874 dbh->rollback if $oldAutoCommit;
875 return "Error inserting cust_pkg_reason: $error";
879 my %svc_cancel_opt = ();
880 $svc_cancel_opt{'date'} = $date if $date;
881 foreach my $cust_svc (
884 sort { $a->[1] <=> $b->[1] }
885 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; }
886 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
888 my $part_svc = $cust_svc->part_svc;
889 next if ( defined($part_svc) and $part_svc->preserve );
890 my $error = $cust_svc->cancel( %svc_cancel_opt );
893 $dbh->rollback if $oldAutoCommit;
894 return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
900 # credit remaining time if appropriate
902 if ( exists($options{'unused_credit'}) ) {
903 $do_credit = $options{'unused_credit'};
906 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
909 my $error = $self->credit_remaining('cancel', $cancel_time);
911 $dbh->rollback if $oldAutoCommit;
917 my %hash = $self->hash;
919 $hash{'expire'} = $date;
921 # just to be sure these are clear
922 $hash{'adjourn'} = undef;
923 $hash{'resume'} = undef;
926 $hash{'cancel'} = $cancel_time;
928 $hash{'change_custnum'} = $options{'change_custnum'};
930 # if this is a supplemental package that's lost its part_pkg_link, and it's
931 # being canceled for real, unlink it completely
932 if ( !$date and ! $self->pkglinknum ) {
933 $hash{main_pkgnum} = '';
936 my $new = new FS::cust_pkg ( \%hash );
937 $error = $new->replace( $self, options => { $self->options } );
938 if ( $self->change_to_pkgnum ) {
939 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
940 $error ||= $change_to->cancel('no_delay_cancel' => 1) || $change_to->delete;
943 $dbh->rollback if $oldAutoCommit;
947 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
948 $error = $supp_pkg->cancel(%options,
950 'date' => $date, #in case it got changed by delay_cancel
951 'delay_cancel' => $delay_cancel,
954 $dbh->rollback if $oldAutoCommit;
955 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
959 if ($delay_cancel && !$options{'from_main'}) {
960 $error = $new->suspend(
962 'time' => $cancel_time
967 foreach my $usage ( $self->cust_pkg_usage ) {
968 $error = $usage->delete;
970 $dbh->rollback if $oldAutoCommit;
971 return "deleting usage pools: $error";
976 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
977 return '' if $date; #no errors
979 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
980 if ( !$options{'quiet'} &&
981 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
983 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
986 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
987 $error = $msg_template->send( 'cust_main' => $self->cust_main,
992 'from' => $conf->invoice_from_full( $self->cust_main->agentnum ),
993 'to' => \@invoicing_list,
994 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
995 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
996 'custnum' => $self->custnum,
997 'msgtype' => '', #admin?
1000 #should this do something on errors?
1007 =item cancel_if_expired [ NOW_TIMESTAMP ]
1009 Cancels this package if its expire date has been reached.
1013 sub cancel_if_expired {
1015 my $time = shift || time;
1016 return '' unless $self->expire && $self->expire <= $time;
1017 my $error = $self->cancel;
1019 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
1020 $self->custnum. ": $error";
1027 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
1028 locationnum, (other fields?). Attempts to re-provision cancelled services
1029 using history information (errors at this stage are not fatal).
1031 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
1033 svc_fatal: service provisioning errors are fatal
1035 svc_errors: pass an array reference, will be filled in with any provisioning errors
1037 main_pkgnum: link the package as a supplemental package of this one. For
1043 my( $self, %options ) = @_;
1045 #in case you try do do $uncancel-date = $cust_pkg->uncacel
1046 return '' unless $self->get('cancel');
1048 if ( $self->main_pkgnum and !$options{'main_pkgnum'} ) {
1049 return $self->main_pkg->uncancel(%options);
1056 my $oldAutoCommit = $FS::UID::AutoCommit;
1057 local $FS::UID::AutoCommit = 0;
1061 # insert the new package
1064 my $cust_pkg = new FS::cust_pkg {
1065 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
1066 bill => ( $options{'bill'} || $self->get('bill') ),
1068 uncancel_pkgnum => $self->pkgnum,
1069 main_pkgnum => ($options{'main_pkgnum'} || ''),
1070 map { $_ => $self->get($_) } qw(
1071 custnum pkgpart locationnum
1073 susp adjourn resume expire start_date contract_end dundate
1074 change_date change_pkgpart change_locationnum
1075 manual_flag no_auto separate_bill quantity agent_pkgid
1076 recur_show_zero setup_show_zero
1080 my $error = $cust_pkg->insert(
1081 'change' => 1, #supresses any referral credit to a referring customer
1082 'allow_pkgpart' => 1, # allow this even if the package def is disabled
1085 $dbh->rollback if $oldAutoCommit;
1093 #find historical services within this timeframe before the package cancel
1094 # (incompatible with "time" option to cust_pkg->cancel?)
1095 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
1096 # too little? (unprovisioing export delay?)
1097 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
1098 my @h_cust_svc = $self->h_cust_svc( $end, $start );
1101 foreach my $h_cust_svc (@h_cust_svc) {
1102 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
1103 #next unless $h_svc_x; #should this happen?
1104 (my $table = $h_svc_x->table) =~ s/^h_//;
1105 require "FS/$table.pm";
1106 my $class = "FS::$table";
1107 my $svc_x = $class->new( {
1108 'pkgnum' => $cust_pkg->pkgnum,
1109 'svcpart' => $h_cust_svc->svcpart,
1110 map { $_ => $h_svc_x->get($_) } fields($table)
1114 if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
1115 $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
1118 my $svc_error = $svc_x->insert;
1120 if ( $options{svc_fatal} ) {
1121 $dbh->rollback if $oldAutoCommit;
1124 # if we've failed to insert the svc_x object, svc_Common->insert
1125 # will have removed the cust_svc already. if not, then both records
1126 # were inserted but we failed for some other reason (export, most
1127 # likely). in that case, report the error and delete the records.
1128 push @svc_errors, $svc_error;
1129 my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1131 # except if export_insert failed, export_delete probably won't be
1133 local $FS::svc_Common::noexport_hack = 1;
1134 my $cleanup_error = $svc_x->delete; # also deletes cust_svc
1135 if ( $cleanup_error ) { # and if THAT fails, then run away
1136 $dbh->rollback if $oldAutoCommit;
1137 return $cleanup_error;
1142 } #foreach $h_cust_svc
1144 #these are pretty rare, but should handle them
1145 # - dsl_device (mac addresses)
1146 # - phone_device (mac addresses)
1147 # - dsl_note (ikano notes)
1148 # - domain_record (i.e. restore DNS information w/domains)
1149 # - inventory_item(?) (inventory w/un-cancelling service?)
1150 # - nas (svc_broaband nas stuff)
1151 #this stuff is unused in the wild afaik
1152 # - mailinglistmember
1154 # - svc_domain.parent_svcnum?
1155 # - acct_snarf (ancient mail fetching config)
1156 # - cgp_rule (communigate)
1157 # - cust_svc_option (used by our Tron stuff)
1158 # - acct_rt_transaction (used by our time worked stuff)
1161 # also move over any services that didn't unprovision at cancellation
1164 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1165 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1166 my $error = $cust_svc->replace;
1168 $dbh->rollback if $oldAutoCommit;
1174 # Uncancel any supplemental packages, and make them supplemental to the
1178 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1180 $error = $supp_pkg->uncancel(%options, 'main_pkgnum' => $cust_pkg->pkgnum);
1182 $dbh->rollback if $oldAutoCommit;
1183 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1191 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1193 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1194 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1201 Cancels any pending expiration (sets the expire field to null).
1203 If there is an error, returns the error, otherwise returns false.
1208 my( $self, %options ) = @_;
1211 my $oldAutoCommit = $FS::UID::AutoCommit;
1212 local $FS::UID::AutoCommit = 0;
1215 my $old = $self->select_for_update;
1217 my $pkgnum = $old->pkgnum;
1218 if ( $old->get('cancel') || $self->get('cancel') ) {
1219 dbh->rollback if $oldAutoCommit;
1220 return "Can't unexpire cancelled package $pkgnum";
1221 # or at least it's pointless
1224 unless ( $old->get('expire') && $self->get('expire') ) {
1225 dbh->rollback if $oldAutoCommit;
1226 return ""; # no error
1229 my %hash = $self->hash;
1230 $hash{'expire'} = '';
1231 my $new = new FS::cust_pkg ( \%hash );
1232 $error = $new->replace( $self, options => { $self->options } );
1234 $dbh->rollback if $oldAutoCommit;
1238 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1244 =item suspend [ OPTION => VALUE ... ]
1246 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1247 package, then suspends the package itself (sets the susp field to now).
1249 Available options are:
1253 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1254 either a reasonnum of an existing reason, or passing a hashref will create
1255 a new reason. The hashref should have the following keys:
1256 - typenum - Reason type (see L<FS::reason_type>
1257 - reason - Text of the new reason.
1259 =item date - can be set to a unix style timestamp to specify when to
1262 =item time - can be set to override the current time, for calculation
1263 of final invoices or unused-time credits
1265 =item resume_date - can be set to a time when the package should be
1266 unsuspended. This may be more convenient than calling C<unsuspend()>
1269 =item from_main - allows a supplemental package to be suspended, rather
1270 than redirecting the method call to its main package. For internal use.
1272 =item from_cancel - used when suspending from the cancel method, forces
1273 this to skip everything besides basic suspension. For internal use.
1277 If there is an error, returns the error, otherwise returns false.
1282 my( $self, %options ) = @_;
1285 # pass all suspend/cancel actions to the main package
1286 if ( $self->main_pkgnum and !$options{'from_main'} ) {
1287 return $self->main_pkg->suspend(%options);
1290 my $oldAutoCommit = $FS::UID::AutoCommit;
1291 local $FS::UID::AutoCommit = 0;
1294 my $old = $self->select_for_update;
1296 my $pkgnum = $old->pkgnum;
1297 if ( $old->get('cancel') || $self->get('cancel') ) {
1298 dbh->rollback if $oldAutoCommit;
1299 return "Can't suspend cancelled package $pkgnum";
1302 if ( $old->get('susp') || $self->get('susp') ) {
1303 dbh->rollback if $oldAutoCommit;
1304 return ""; # no error # complain on adjourn?
1307 my $suspend_time = $options{'time'} || time;
1308 my $date = $options{date} if $options{date}; # adjourn/suspend later
1309 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1311 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1312 dbh->rollback if $oldAutoCommit;
1313 return "Package $pkgnum expires before it would be suspended.";
1316 # some false laziness with sub cancel
1317 if ( !$options{nobill} && !$date && !$options{'from_cancel'} &&
1318 $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1319 # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1320 # make the entire cust_main->bill path recognize 'suspend' and
1321 # 'cancel' separately.
1322 warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1323 my $copy = $self->new({$self->hash});
1325 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1327 'time' => $suspend_time );
1328 warn "Error billing during suspend, custnum ".
1329 #$self->cust_main->custnum. ": $error"
1334 if ( $options{'reason'} ) {
1335 $error = $self->insert_reason( 'reason' => $options{'reason'},
1336 'action' => $date ? 'adjourn' : 'suspend',
1337 'date' => $date ? $date : $suspend_time,
1338 'reason_otaker' => $options{'reason_otaker'},
1341 dbh->rollback if $oldAutoCommit;
1342 return "Error inserting cust_pkg_reason: $error";
1346 # if a reasonnum was passed, get the actual reason object so we can check
1348 # (passing a reason hashref is still allowed, but it can't be used with
1349 # the fancy behavioral options.)
1352 if ($options{'reason'} =~ /^\d+$/) {
1353 $reason = FS::reason->by_key($options{'reason'});
1356 my %hash = $self->hash;
1358 $hash{'adjourn'} = $date;
1360 $hash{'susp'} = $suspend_time;
1363 my $resume_date = $options{'resume_date'} || 0;
1364 if ( $resume_date > ($date || $suspend_time) ) {
1365 $hash{'resume'} = $resume_date;
1368 $options{options} ||= {};
1370 my $new = new FS::cust_pkg ( \%hash );
1371 $error = $new->replace( $self, options => { $self->options,
1372 %{ $options{options} },
1376 $dbh->rollback if $oldAutoCommit;
1380 unless ( $date ) { # then we are suspending now
1382 unless ($options{'from_cancel'}) {
1383 # credit remaining time if appropriate
1384 # (if required by the package def, or the suspend reason)
1385 my $unused_credit = $self->part_pkg->option('unused_credit_suspend',1)
1386 || ( defined($reason) && $reason->unused_credit );
1388 if ( $unused_credit ) {
1389 warn "crediting unused time on pkg#".$self->pkgnum."\n" if $DEBUG;
1390 my $error = $self->credit_remaining('suspend', $suspend_time);
1392 $dbh->rollback if $oldAutoCommit;
1400 foreach my $cust_svc (
1401 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1403 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1405 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1406 $dbh->rollback if $oldAutoCommit;
1407 return "Illegal svcdb value in part_svc!";
1410 require "FS/$svcdb.pm";
1412 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1414 $error = $svc->suspend;
1416 $dbh->rollback if $oldAutoCommit;
1419 my( $label, $value ) = $cust_svc->label;
1420 push @labels, "$label: $value";
1424 my $conf = new FS::Conf;
1425 if ( $conf->config('suspend_email_admin') && !$options{'from_cancel'} ) {
1427 my $error = send_email(
1428 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1429 #invoice_from ??? well as good as any
1430 'to' => $conf->config('suspend_email_admin'),
1431 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1433 "This is an automatic message from your Freeside installation\n",
1434 "informing you that the following customer package has been suspended:\n",
1436 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1437 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1438 ( map { "Service : $_\n" } @labels ),
1440 'custnum' => $self->custnum,
1441 'msgtype' => 'admin'
1445 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1453 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1454 $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1456 $dbh->rollback if $oldAutoCommit;
1457 return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1461 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1466 =item credit_remaining MODE TIME
1468 Generate a credit for this package for the time remaining in the current
1469 billing period. MODE is either "suspend" or "cancel" (determines the
1470 credit type). TIME is the time of suspension/cancellation. Both arguments
1475 # Implementation note:
1477 # If you pkgpart-change a package that has been billed, and it's set to give
1478 # credit on package change, then this method gets called and then the new
1479 # package will have no last_bill date. Therefore the customer will be credited
1480 # only once (per billing period) even if there are multiple package changes.
1482 # If you location-change a package that has been billed, this method will NOT
1483 # be called and the new package WILL have the last bill date of the old
1486 # If the new package is then canceled within the same billing cycle,
1487 # credit_remaining needs to run calc_remain on the OLD package to determine
1488 # the amount of unused time to credit.
1490 sub credit_remaining {
1491 # Add a credit for remaining service
1492 my ($self, $mode, $time) = @_;
1493 die 'credit_remaining requires suspend or cancel'
1494 unless $mode eq 'suspend' or $mode eq 'cancel';
1495 die 'no suspend/cancel time' unless $time > 0;
1497 my $conf = FS::Conf->new;
1498 my $reason_type = $conf->config($mode.'_credit_type');
1500 my $last_bill = $self->getfield('last_bill') || 0;
1501 my $next_bill = $self->getfield('bill') || 0;
1502 if ( $last_bill > 0 # the package has been billed
1503 and $next_bill > 0 # the package has a next bill date
1504 and $next_bill >= $time # which is in the future
1506 my @cust_credit_source_bill_pkg = ();
1507 my $remaining_value = 0;
1509 my $remain_pkg = $self;
1510 $remaining_value = $remain_pkg->calc_remain(
1512 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1515 # we may have to walk back past some package changes to get to the
1516 # one that actually has unused time
1517 while ( $remaining_value == 0 ) {
1518 if ( $remain_pkg->change_pkgnum ) {
1519 $remain_pkg = FS::cust_pkg->by_key($remain_pkg->change_pkgnum);
1521 # the package has really never been billed
1524 $remaining_value = $remain_pkg->calc_remain(
1526 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1530 if ( $remaining_value > 0 ) {
1531 warn "Crediting for $remaining_value on package ".$self->pkgnum."\n"
1533 my $error = $self->cust_main->credit(
1535 'Credit for unused time on '. $self->part_pkg->pkg,
1536 'reason_type' => $reason_type,
1537 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1539 return "Error crediting customer \$$remaining_value for unused time".
1540 " on ". $self->part_pkg->pkg. ": $error"
1542 } #if $remaining_value
1543 } #if $last_bill, etc.
1547 =item unsuspend [ OPTION => VALUE ... ]
1549 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1550 package, then unsuspends the package itself (clears the susp field and the
1551 adjourn field if it is in the past). If the suspend reason includes an
1552 unsuspension package, that package will be ordered.
1554 Available options are:
1560 Can be set to a date to unsuspend the package in the future (the 'resume'
1563 =item adjust_next_bill
1565 Can be set true to adjust the next bill date forward by
1566 the amount of time the account was inactive. This was set true by default
1567 in the past (from 1.4.2 and 1.5.0pre6 through 1.7.0), but now needs to be
1568 explicitly requested with this option or in the price plan.
1572 If there is an error, returns the error, otherwise returns false.
1577 my( $self, %opt ) = @_;
1580 # pass all suspend/cancel actions to the main package
1581 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1582 return $self->main_pkg->unsuspend(%opt);
1585 my $oldAutoCommit = $FS::UID::AutoCommit;
1586 local $FS::UID::AutoCommit = 0;
1589 my $old = $self->select_for_update;
1591 my $pkgnum = $old->pkgnum;
1592 if ( $old->get('cancel') || $self->get('cancel') ) {
1593 $dbh->rollback if $oldAutoCommit;
1594 return "Can't unsuspend cancelled package $pkgnum";
1597 unless ( $old->get('susp') && $self->get('susp') ) {
1598 $dbh->rollback if $oldAutoCommit;
1599 return ""; # no error # complain instead?
1602 # handle the case of setting a future unsuspend (resume) date
1603 # and do not continue to actually unsuspend the package
1604 my $date = $opt{'date'};
1605 if ( $date and $date > time ) { # return an error if $date <= time?
1607 if ( $old->get('expire') && $old->get('expire') < $date ) {
1608 $dbh->rollback if $oldAutoCommit;
1609 return "Package $pkgnum expires before it would be unsuspended.";
1612 my $new = new FS::cust_pkg { $self->hash };
1613 $new->set('resume', $date);
1614 $error = $new->replace($self, options => $self->options);
1617 $dbh->rollback if $oldAutoCommit;
1621 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1627 if (!$self->setup) {
1628 # then this package is being released from on-hold status
1629 $self->set_initial_timers;
1634 foreach my $cust_svc (
1635 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1637 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1639 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1640 $dbh->rollback if $oldAutoCommit;
1641 return "Illegal svcdb value in part_svc!";
1644 require "FS/$svcdb.pm";
1646 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1648 $error = $svc->unsuspend;
1650 $dbh->rollback if $oldAutoCommit;
1653 my( $label, $value ) = $cust_svc->label;
1654 push @labels, "$label: $value";
1659 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1660 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1662 my %hash = $self->hash;
1663 my $inactive = time - $hash{'susp'};
1665 my $conf = new FS::Conf;
1667 #adjust the next bill date forward
1668 # increment next bill date if certain conditions are met:
1669 # - it was due to be billed at some point
1670 # - either the global or local config says to do this
1671 my $adjust_bill = 0;
1674 && ( $hash{'bill'} || $hash{'setup'} )
1675 && ( $opt{'adjust_next_bill'}
1676 || $conf->exists('unsuspend-always_adjust_next_bill_date')
1677 || $self->part_pkg->option('unsuspend_adjust_bill', 1)
1684 # - the package billed during suspension
1685 # - or it was ordered on hold
1686 # - or the customer was credited for the unused time
1688 if ( $self->option('suspend_bill',1)
1689 or ( $self->part_pkg->option('suspend_bill',1)
1690 and ! $self->option('no_suspend_bill',1)
1692 or $hash{'order_date'} == $hash{'susp'}
1697 if ( $adjust_bill ) {
1698 if ( $self->part_pkg->option('unused_credit_suspend')
1699 or ( ref($reason) and $reason->unused_credit ) ) {
1700 # then the customer was credited for the unused time before suspending,
1701 # so their next bill should be immediate
1702 $hash{'bill'} = time;
1704 # add the length of time suspended to the bill date
1705 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1710 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1711 $hash{'resume'} = '' if !$hash{'adjourn'};
1712 my $new = new FS::cust_pkg ( \%hash );
1713 $error = $new->replace( $self, options => { $self->options } );
1715 $dbh->rollback if $oldAutoCommit;
1721 if ( $reason && $reason->unsuspend_pkgpart ) {
1722 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
1723 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
1725 my $start_date = $self->cust_main->next_bill_date
1726 if $reason->unsuspend_hold;
1729 $unsusp_pkg = FS::cust_pkg->new({
1730 'custnum' => $self->custnum,
1731 'pkgpart' => $reason->unsuspend_pkgpart,
1732 'start_date' => $start_date,
1733 'locationnum' => $self->locationnum,
1734 # discount? probably not...
1737 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
1741 $dbh->rollback if $oldAutoCommit;
1746 if ( $conf->config('unsuspend_email_admin') ) {
1748 my $error = send_email(
1749 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1750 #invoice_from ??? well as good as any
1751 'to' => $conf->config('unsuspend_email_admin'),
1752 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
1753 "This is an automatic message from your Freeside installation\n",
1754 "informing you that the following customer package has been unsuspended:\n",
1756 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1757 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1758 ( map { "Service : $_\n" } @labels ),
1760 "An unsuspension fee was charged: ".
1761 $unsusp_pkg->part_pkg->pkg_comment."\n"
1765 'custnum' => $self->custnum,
1766 'msgtype' => 'admin',
1770 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
1776 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1777 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
1779 $dbh->rollback if $oldAutoCommit;
1780 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1784 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1791 Cancels any pending suspension (sets the adjourn field to null).
1793 If there is an error, returns the error, otherwise returns false.
1798 my( $self, %options ) = @_;
1801 my $oldAutoCommit = $FS::UID::AutoCommit;
1802 local $FS::UID::AutoCommit = 0;
1805 my $old = $self->select_for_update;
1807 my $pkgnum = $old->pkgnum;
1808 if ( $old->get('cancel') || $self->get('cancel') ) {
1809 dbh->rollback if $oldAutoCommit;
1810 return "Can't unadjourn cancelled package $pkgnum";
1811 # or at least it's pointless
1814 if ( $old->get('susp') || $self->get('susp') ) {
1815 dbh->rollback if $oldAutoCommit;
1816 return "Can't unadjourn suspended package $pkgnum";
1817 # perhaps this is arbitrary
1820 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1821 dbh->rollback if $oldAutoCommit;
1822 return ""; # no error
1825 my %hash = $self->hash;
1826 $hash{'adjourn'} = '';
1827 $hash{'resume'} = '';
1828 my $new = new FS::cust_pkg ( \%hash );
1829 $error = $new->replace( $self, options => { $self->options } );
1831 $dbh->rollback if $oldAutoCommit;
1835 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1842 =item change HASHREF | OPTION => VALUE ...
1844 Changes this package: cancels it and creates a new one, with a different
1845 pkgpart or locationnum or both. All services are transferred to the new
1846 package (no change will be made if this is not possible).
1848 Options may be passed as a list of key/value pairs or as a hash reference.
1855 New locationnum, to change the location for this package.
1859 New FS::cust_location object, to create a new location and assign it
1864 New FS::cust_main object, to create a new customer and assign the new package
1869 New pkgpart (see L<FS::part_pkg>).
1873 New refnum (see L<FS::part_referral>).
1877 New quantity; if unspecified, the new package will have the same quantity
1882 "New" (existing) FS::cust_pkg object. The package's services and other
1883 attributes will be transferred to this package.
1887 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1888 susp, adjourn, cancel, expire, and contract_end) to the new package.
1890 =item unprotect_svcs
1892 Normally, change() will rollback and return an error if some services
1893 can't be transferred (also see the I<cust_pkg-change_svcpart> config option).
1894 If unprotect_svcs is true, this method will transfer as many services as
1895 it can and then unconditionally cancel the old package.
1899 At least one of locationnum, cust_location, pkgpart, refnum, cust_main, or
1900 cust_pkg must be specified (otherwise, what's the point?)
1902 Returns either the new FS::cust_pkg object or a scalar error.
1906 my $err_or_new_cust_pkg = $old_cust_pkg->change
1910 #some false laziness w/order
1913 my $opt = ref($_[0]) ? shift : { @_ };
1915 my $conf = new FS::Conf;
1917 # Transactionize this whole mess
1918 my $oldAutoCommit = $FS::UID::AutoCommit;
1919 local $FS::UID::AutoCommit = 0;
1928 $hash{'setup'} = $time if $self->setup;
1930 $hash{'change_date'} = $time;
1931 $hash{"change_$_"} = $self->$_()
1932 foreach qw( pkgnum pkgpart locationnum );
1934 if ( $opt->{'cust_location'} ) {
1935 $error = $opt->{'cust_location'}->find_or_insert;
1937 $dbh->rollback if $oldAutoCommit;
1938 return "creating location record: $error";
1940 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1943 if ( $opt->{'cust_pkg'} ) {
1944 # treat changing to a package with a different pkgpart as a
1945 # pkgpart change (because it is)
1946 $opt->{'pkgpart'} = $opt->{'cust_pkg'}->pkgpart;
1949 # whether to override pkgpart checking on the new package
1950 my $same_pkgpart = 1;
1951 if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
1955 my $unused_credit = 0;
1956 my $keep_dates = $opt->{'keep_dates'};
1957 # Special case. If the pkgpart is changing, and the customer is
1958 # going to be credited for remaining time, don't keep setup, bill,
1959 # or last_bill dates, and DO pass the flag to cancel() to credit
1961 if ( $opt->{'pkgpart'}
1962 and $opt->{'pkgpart'} != $self->pkgpart
1963 and $self->part_pkg->option('unused_credit_change', 1) ) {
1966 $hash{$_} = '' foreach qw(setup bill last_bill);
1969 if ( $keep_dates ) {
1970 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1971 resume start_date contract_end ) ) {
1972 $hash{$date} = $self->getfield($date);
1975 # always keep this date, regardless of anything
1976 # (the date of the package change is in a different field)
1977 $hash{'order_date'} = $self->getfield('order_date');
1979 # allow $opt->{'locationnum'} = '' to specifically set it to null
1980 # (i.e. customer default location)
1981 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
1983 # usually this doesn't matter. the two cases where it does are:
1984 # 1. unused_credit_change + pkgpart change + setup fee on the new package
1986 # 2. (more importantly) changing a package before it's billed
1987 $hash{'waive_setup'} = $self->waive_setup;
1989 my $custnum = $self->custnum;
1990 if ( $opt->{cust_main} ) {
1991 my $cust_main = $opt->{cust_main};
1992 unless ( $cust_main->custnum ) {
1993 my $error = $cust_main->insert( @{ $opt->{cust_main_insert_args}||[] } );
1995 $dbh->rollback if $oldAutoCommit;
1996 return "inserting customer record: $error";
1999 $custnum = $cust_main->custnum;
2002 $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
2005 if ( $opt->{'cust_pkg'} ) {
2006 # The target package already exists; update it to show that it was
2007 # changed from this package.
2008 $cust_pkg = $opt->{'cust_pkg'};
2010 foreach ( qw( pkgnum pkgpart locationnum ) ) {
2011 $cust_pkg->set("change_$_", $self->get($_));
2013 $cust_pkg->set('change_date', $time);
2014 $error = $cust_pkg->replace;
2017 # Create the new package.
2018 $cust_pkg = new FS::cust_pkg {
2019 custnum => $custnum,
2020 locationnum => $opt->{'locationnum'},
2021 ( map { $_ => ( $opt->{$_} || $self->$_() ) }
2022 qw( pkgpart quantity refnum salesnum )
2026 $error = $cust_pkg->insert( 'change' => 1,
2027 'allow_pkgpart' => $same_pkgpart );
2030 $dbh->rollback if $oldAutoCommit;
2031 return "inserting new package: $error";
2034 # Transfer services and cancel old package.
2036 $error = $self->transfer($cust_pkg);
2037 if ($error and $error == 0) {
2038 # $old_pkg->transfer failed.
2039 $dbh->rollback if $oldAutoCommit;
2040 return "transferring $error";
2043 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2044 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2045 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
2046 if ($error and $error == 0) {
2047 # $old_pkg->transfer failed.
2048 $dbh->rollback if $oldAutoCommit;
2049 return "converting $error";
2053 # We set unprotect_svcs when executing a "future package change". It's
2054 # not a user-interactive operation, so returning an error means the
2055 # package change will just fail. Rather than have that happen, we'll
2056 # let leftover services be deleted.
2057 if ($error > 0 and !$opt->{'unprotect_svcs'}) {
2058 # Transfers were successful, but we still had services left on the old
2059 # package. We can't change the package under this circumstances, so abort.
2060 $dbh->rollback if $oldAutoCommit;
2061 return "unable to transfer all services";
2064 #reset usage if changing pkgpart
2065 # AND usage rollover is off (otherwise adds twice, now and at package bill)
2066 if ($self->pkgpart != $cust_pkg->pkgpart) {
2067 my $part_pkg = $cust_pkg->part_pkg;
2068 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
2072 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
2075 $dbh->rollback if $oldAutoCommit;
2076 return "setting usage values: $error";
2079 # if NOT changing pkgpart, transfer any usage pools over
2080 foreach my $usage ($self->cust_pkg_usage) {
2081 $usage->set('pkgnum', $cust_pkg->pkgnum);
2082 $error = $usage->replace;
2084 $dbh->rollback if $oldAutoCommit;
2085 return "transferring usage pools: $error";
2090 # transfer usage pricing add-ons, if we're not changing pkgpart
2091 if ( $same_pkgpart ) {
2092 foreach my $old_cust_pkg_usageprice ($self->cust_pkg_usageprice) {
2093 my $new_cust_pkg_usageprice = new FS::cust_pkg_usageprice {
2094 'pkgnum' => $cust_pkg->pkgnum,
2095 'usagepricepart' => $old_cust_pkg_usageprice->usagepricepart,
2096 'quantity' => $old_cust_pkg_usageprice->quantity,
2098 $error = $new_cust_pkg_usageprice->insert;
2100 $dbh->rollback if $oldAutoCommit;
2101 return "Error transferring usage pricing add-on: $error";
2106 # transfer discounts, if we're not changing pkgpart
2107 if ( $same_pkgpart ) {
2108 foreach my $old_discount ($self->cust_pkg_discount_active) {
2109 # don't remove the old discount, we may still need to bill that package.
2110 my $new_discount = new FS::cust_pkg_discount {
2111 'pkgnum' => $cust_pkg->pkgnum,
2112 'discountnum' => $old_discount->discountnum,
2113 'months_used' => $old_discount->months_used,
2115 $error = $new_discount->insert;
2117 $dbh->rollback if $oldAutoCommit;
2118 return "transferring discounts: $error";
2123 # transfer (copy) invoice details
2124 foreach my $detail ($self->cust_pkg_detail) {
2125 my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
2126 $new_detail->set('pkgdetailnum', '');
2127 $new_detail->set('pkgnum', $cust_pkg->pkgnum);
2128 $error = $new_detail->insert;
2130 $dbh->rollback if $oldAutoCommit;
2131 return "transferring package notes: $error";
2137 if ( !$opt->{'cust_pkg'} ) {
2138 # Order any supplemental packages.
2139 my $part_pkg = $cust_pkg->part_pkg;
2140 my @old_supp_pkgs = $self->supplemental_pkgs;
2141 foreach my $link ($part_pkg->supp_part_pkg_link) {
2143 foreach (@old_supp_pkgs) {
2144 if ($_->pkgpart == $link->dst_pkgpart) {
2146 $_->pkgpart(0); # so that it can't match more than once
2150 # false laziness with FS::cust_main::Packages::order_pkg
2151 my $new = FS::cust_pkg->new({
2152 pkgpart => $link->dst_pkgpart,
2153 pkglinknum => $link->pkglinknum,
2154 custnum => $custnum,
2155 main_pkgnum => $cust_pkg->pkgnum,
2156 locationnum => $cust_pkg->locationnum,
2157 start_date => $cust_pkg->start_date,
2158 order_date => $cust_pkg->order_date,
2159 expire => $cust_pkg->expire,
2160 adjourn => $cust_pkg->adjourn,
2161 contract_end => $cust_pkg->contract_end,
2162 refnum => $cust_pkg->refnum,
2163 discountnum => $cust_pkg->discountnum,
2164 waive_setup => $cust_pkg->waive_setup,
2166 if ( $old and $opt->{'keep_dates'} ) {
2167 foreach (qw(setup bill last_bill)) {
2168 $new->set($_, $old->get($_));
2171 $error = $new->insert( allow_pkgpart => $same_pkgpart );
2174 $error ||= $old->transfer($new);
2176 if ( $error and $error > 0 ) {
2177 # no reason why this should ever fail, but still...
2178 $error = "Unable to transfer all services from supplemental package ".
2182 $dbh->rollback if $oldAutoCommit;
2185 push @new_supp_pkgs, $new;
2187 } # if !$opt->{'cust_pkg'}
2188 # because if there is one, then supplemental packages would already
2189 # have been created for it.
2191 #Good to go, cancel old package. Notify 'cancel' of whether to credit
2193 #Don't allow billing the package (preceding period packages and/or
2194 #outstanding usage) if we are keeping dates (i.e. location changing),
2195 #because the new package will be billed for the same date range.
2196 #Supplemental packages are also canceled here.
2198 # during scheduled changes, avoid canceling the package we just
2200 $self->set('change_to_pkgnum' => '');
2202 $error = $self->cancel(
2204 unused_credit => $unused_credit,
2205 nobill => $keep_dates,
2206 change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2207 no_delay_cancel => 1,
2210 $dbh->rollback if $oldAutoCommit;
2211 return "canceling old package: $error";
2214 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2216 my $error = $cust_pkg->cust_main->bill(
2217 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2220 $dbh->rollback if $oldAutoCommit;
2221 return "billing new package: $error";
2225 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2231 =item change_later OPTION => VALUE...
2233 Schedule a package change for a later date. This actually orders the new
2234 package immediately, but sets its start date for a future date, and sets
2235 the current package to expire on the same date.
2237 If the package is already scheduled for a change, this can be called with
2238 'start_date' to change the scheduled date, or with pkgpart and/or
2239 locationnum to modify the package change. To cancel the scheduled change
2240 entirely, see C<abort_change>.
2248 The date for the package change. Required, and must be in the future.
2256 The pkgpart. locationnum, and quantity of the new package, with the same
2257 meaning as in C<change>.
2265 my $opt = ref($_[0]) ? shift : { @_ };
2267 my $oldAutoCommit = $FS::UID::AutoCommit;
2268 local $FS::UID::AutoCommit = 0;
2271 my $cust_main = $self->cust_main;
2273 my $date = delete $opt->{'start_date'} or return 'start_date required';
2275 if ( $date <= time ) {
2276 $dbh->rollback if $oldAutoCommit;
2277 return "start_date $date is in the past";
2282 if ( $self->change_to_pkgnum ) {
2283 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
2284 my $new_pkgpart = $opt->{'pkgpart'}
2285 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $change_to->pkgpart;
2286 my $new_locationnum = $opt->{'locationnum'}
2287 if $opt->{'locationnum'} and $opt->{'locationnum'} != $change_to->locationnum;
2288 my $new_quantity = $opt->{'quantity'}
2289 if $opt->{'quantity'} and $opt->{'quantity'} != $change_to->quantity;
2290 if ( $new_pkgpart or $new_locationnum or $new_quantity ) {
2291 # it hasn't been billed yet, so in principle we could just edit
2292 # it in place (w/o a package change), but that's bad form.
2293 # So change the package according to the new options...
2294 my $err_or_pkg = $change_to->change(%$opt);
2295 if ( ref $err_or_pkg ) {
2296 # Then set that package up for a future start.
2297 $self->set('change_to_pkgnum', $err_or_pkg->pkgnum);
2298 $self->set('expire', $date); # in case it's different
2299 $err_or_pkg->set('start_date', $date);
2300 $err_or_pkg->set('change_date', '');
2301 $err_or_pkg->set('change_pkgnum', '');
2303 $error = $self->replace ||
2304 $err_or_pkg->replace ||
2305 $change_to->cancel('no_delay_cancel' => 1) ||
2308 $error = $err_or_pkg;
2310 } else { # change the start date only.
2311 $self->set('expire', $date);
2312 $change_to->set('start_date', $date);
2313 $error = $self->replace || $change_to->replace;
2316 $dbh->rollback if $oldAutoCommit;
2319 $dbh->commit if $oldAutoCommit;
2322 } # if $self->change_to_pkgnum
2324 my $new_pkgpart = $opt->{'pkgpart'}
2325 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2326 my $new_locationnum = $opt->{'locationnum'}
2327 if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2328 my $new_quantity = $opt->{'quantity'}
2329 if $opt->{'quantity'} and $opt->{'quantity'} != $self->quantity;
2331 return '' unless $new_pkgpart or $new_locationnum or $new_quantity; # wouldn't do anything
2333 # allow $opt->{'locationnum'} = '' to specifically set it to null
2334 # (i.e. customer default location)
2335 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2337 my $new = FS::cust_pkg->new( {
2338 custnum => $self->custnum,
2339 locationnum => $opt->{'locationnum'},
2340 start_date => $date,
2341 map { $_ => ( $opt->{$_} || $self->$_() ) }
2342 qw( pkgpart quantity refnum salesnum )
2344 $error = $new->insert('change' => 1,
2345 'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2347 $self->set('change_to_pkgnum', $new->pkgnum);
2348 $self->set('expire', $date);
2349 $error = $self->replace;
2352 $dbh->rollback if $oldAutoCommit;
2354 $dbh->commit if $oldAutoCommit;
2362 Cancels a future package change scheduled by C<change_later>.
2368 my $pkgnum = $self->change_to_pkgnum;
2369 my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
2372 $error = $change_to->cancel || $change_to->delete;
2373 return $error if $error;
2375 $self->set('change_to_pkgnum', '');
2376 $self->set('expire', '');
2380 =item set_quantity QUANTITY
2382 Change the package's quantity field. This is one of the few package properties
2383 that can safely be changed without canceling and reordering the package
2384 (because it doesn't affect tax eligibility). Returns an error or an
2391 $self = $self->replace_old; # just to make sure
2392 $self->quantity(shift);
2396 =item set_salesnum SALESNUM
2398 Change the package's salesnum (sales person) field. This is one of the few
2399 package properties that can safely be changed without canceling and reordering
2400 the package (because it doesn't affect tax eligibility). Returns an error or
2407 $self = $self->replace_old; # just to make sure
2408 $self->salesnum(shift);
2410 # XXX this should probably reassign any credit that's already been given
2413 =item modify_charge OPTIONS
2415 Change the properties of a one-time charge. The following properties can
2416 be changed this way:
2417 - pkg: the package description
2418 - classnum: the package class
2419 - additional: arrayref of additional invoice details to add to this package
2421 and, I<if the charge has not yet been billed>:
2422 - start_date: the date when it will be billed
2423 - amount: the setup fee to be charged
2424 - quantity: the multiplier for the setup fee
2425 - separate_bill: whether to put the charge on a separate invoice
2427 If you pass 'adjust_commission' => 1, and the classnum changes, and there are
2428 commission credits linked to this charge, they will be recalculated.
2435 my $part_pkg = $self->part_pkg;
2436 my $pkgnum = $self->pkgnum;
2439 my $oldAutoCommit = $FS::UID::AutoCommit;
2440 local $FS::UID::AutoCommit = 0;
2442 return "Can't use modify_charge except on one-time charges"
2443 unless $part_pkg->freq eq '0';
2445 if ( length($opt{'pkg'}) and $part_pkg->pkg ne $opt{'pkg'} ) {
2446 $part_pkg->set('pkg', $opt{'pkg'});
2449 my %pkg_opt = $part_pkg->options;
2450 my $pkg_opt_modified = 0;
2452 $opt{'additional'} ||= [];
2455 foreach (grep /^additional/, keys %pkg_opt) {
2456 ($i) = ($_ =~ /^additional_info(\d+)$/);
2457 $old_additional[$i] = $pkg_opt{$_} if $i;
2458 delete $pkg_opt{$_};
2461 for ( $i = 0; exists($opt{'additional'}->[$i]); $i++ ) {
2462 $pkg_opt{ "additional_info$i" } = $opt{'additional'}->[$i];
2463 if (!exists($old_additional[$i])
2464 or $old_additional[$i] ne $opt{'additional'}->[$i])
2466 $pkg_opt_modified = 1;
2469 $pkg_opt_modified = 1 if (scalar(@old_additional) - 1) != $i;
2470 $pkg_opt{'additional_count'} = $i if $i > 0;
2473 if ( exists($opt{'classnum'}) and $part_pkg->classnum ne $opt{'classnum'} )
2476 $old_classnum = $part_pkg->classnum;
2477 $part_pkg->set('classnum', $opt{'classnum'});
2480 if ( !$self->get('setup') ) {
2481 # not yet billed, so allow amount, setup_cost, quantity, start_date,
2484 if ( exists($opt{'amount'})
2485 and $part_pkg->option('setup_fee') != $opt{'amount'}
2486 and $opt{'amount'} > 0 ) {
2488 $pkg_opt{'setup_fee'} = $opt{'amount'};
2489 $pkg_opt_modified = 1;
2492 if ( exists($opt{'setup_cost'})
2493 and $part_pkg->setup_cost != $opt{'setup_cost'}
2494 and $opt{'setup_cost'} > 0 ) {
2496 $part_pkg->set('setup_cost', $opt{'setup_cost'});
2499 if ( exists($opt{'quantity'})
2500 and $opt{'quantity'} != $self->quantity
2501 and $opt{'quantity'} > 0 ) {
2503 $self->set('quantity', $opt{'quantity'});
2506 if ( exists($opt{'start_date'})
2507 and $opt{'start_date'} != $self->start_date ) {
2509 $self->set('start_date', $opt{'start_date'});
2512 if ( exists($opt{'separate_bill'})
2513 and $opt{'separate_bill'} ne $self->separate_bill ) {
2515 $self->set('separate_bill', $opt{'separate_bill'});
2519 } # else simply ignore them; the UI shouldn't allow editing the fields
2522 if ( exists($opt{'taxclass'})
2523 and $part_pkg->taxclass ne $opt{'taxclass'}) {
2525 $part_pkg->set('taxclass', $opt{'taxclass'});
2529 if ( $part_pkg->modified or $pkg_opt_modified ) {
2530 # can we safely modify the package def?
2531 # Yes, if it's not available for purchase, and this is the only instance
2533 if ( $part_pkg->disabled
2534 and FS::cust_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 1
2535 and FS::quotation_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 0
2537 $error = $part_pkg->replace( options => \%pkg_opt );
2540 $part_pkg = $part_pkg->clone;
2541 $part_pkg->set('disabled' => 'Y');
2542 $error = $part_pkg->insert( options => \%pkg_opt );
2543 # and associate this as yet-unbilled package to the new package def
2544 $self->set('pkgpart' => $part_pkg->pkgpart);
2547 $dbh->rollback if $oldAutoCommit;
2552 if ($self->modified) { # for quantity or start_date change, or if we had
2553 # to clone the existing package def
2554 my $error = $self->replace;
2555 return $error if $error;
2557 if (defined $old_classnum) {
2558 # fix invoice grouping records
2559 my $old_catname = $old_classnum
2560 ? FS::pkg_class->by_key($old_classnum)->categoryname
2562 my $new_catname = $opt{'classnum'}
2563 ? $part_pkg->pkg_class->categoryname
2565 if ( $old_catname ne $new_catname ) {
2566 foreach my $cust_bill_pkg ($self->cust_bill_pkg) {
2567 # (there should only be one...)
2568 my @display = qsearch( 'cust_bill_pkg_display', {
2569 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2570 'section' => $old_catname,
2572 foreach (@display) {
2573 $_->set('section', $new_catname);
2574 $error = $_->replace;
2576 $dbh->rollback if $oldAutoCommit;
2580 } # foreach $cust_bill_pkg
2583 if ( $opt{'adjust_commission'} ) {
2584 # fix commission credits...tricky.
2585 foreach my $cust_event ($self->cust_event) {
2586 my $part_event = $cust_event->part_event;
2587 foreach my $table (qw(sales agent)) {
2589 "FS::part_event::Action::Mixin::credit_${table}_pkg_class";
2590 my $credit = qsearchs('cust_credit', {
2591 'eventnum' => $cust_event->eventnum,
2593 if ( $part_event->isa($class) ) {
2594 # Yes, this results in current commission rates being applied
2595 # retroactively to a one-time charge. For accounting purposes
2596 # there ought to be some kind of time limit on doing this.
2597 my $amount = $part_event->_calc_credit($self);
2598 if ( $credit and $credit->amount ne $amount ) {
2599 # Void the old credit.
2600 $error = $credit->void('Package class changed');
2602 $dbh->rollback if $oldAutoCommit;
2603 return "$error (adjusting commission credit)";
2606 # redo the event action to recreate the credit.
2608 eval { $part_event->do_action( $self, $cust_event ) };
2610 $dbh->rollback if $oldAutoCommit;
2613 } # if $part_event->isa($class)
2615 } # foreach $cust_event
2616 } # if $opt{'adjust_commission'}
2617 } # if defined $old_classnum
2619 $dbh->commit if $oldAutoCommit;
2626 sub process_bulk_cust_pkg {
2629 warn Dumper($param) if $DEBUG;
2631 my $old_part_pkg = qsearchs('part_pkg',
2632 { pkgpart => $param->{'old_pkgpart'} });
2633 my $new_part_pkg = qsearchs('part_pkg',
2634 { pkgpart => $param->{'new_pkgpart'} });
2635 die "Must select a new package type\n" unless $new_part_pkg;
2636 #my $keep_dates = $param->{'keep_dates'} || 0;
2637 my $keep_dates = 1; # there is no good reason to turn this off
2639 my $oldAutoCommit = $FS::UID::AutoCommit;
2640 local $FS::UID::AutoCommit = 0;
2643 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
2646 foreach my $old_cust_pkg ( @cust_pkgs ) {
2648 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
2649 if ( $old_cust_pkg->getfield('cancel') ) {
2650 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
2651 $old_cust_pkg->pkgnum."\n"
2655 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
2657 my $error = $old_cust_pkg->change(
2658 'pkgpart' => $param->{'new_pkgpart'},
2659 'keep_dates' => $keep_dates
2661 if ( !ref($error) ) { # change returns the cust_pkg on success
2663 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
2666 $dbh->commit if $oldAutoCommit;
2672 Returns the last bill date, or if there is no last bill date, the setup date.
2673 Useful for billing metered services.
2679 return $self->setfield('last_bill', $_[0]) if @_;
2680 return $self->getfield('last_bill') if $self->getfield('last_bill');
2681 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
2682 'edate' => $self->bill, } );
2683 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
2686 =item last_cust_pkg_reason ACTION
2688 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
2689 Returns false if there is no reason or the package is not currenly ACTION'd
2690 ACTION is one of adjourn, susp, cancel, or expire.
2694 sub last_cust_pkg_reason {
2695 my ( $self, $action ) = ( shift, shift );
2696 my $date = $self->get($action);
2698 'table' => 'cust_pkg_reason',
2699 'hashref' => { 'pkgnum' => $self->pkgnum,
2700 'action' => substr(uc($action), 0, 1),
2703 'order_by' => 'ORDER BY num DESC LIMIT 1',
2707 =item last_reason ACTION
2709 Returns the most recent ACTION FS::reason associated with the package.
2710 Returns false if there is no reason or the package is not currenly ACTION'd
2711 ACTION is one of adjourn, susp, cancel, or expire.
2716 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
2717 $cust_pkg_reason->reason
2718 if $cust_pkg_reason;
2723 Returns the definition for this billing item, as an FS::part_pkg object (see
2730 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
2731 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
2732 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
2737 Returns the cancelled package this package was changed from, if any.
2743 return '' unless $self->change_pkgnum;
2744 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
2747 =item change_cust_main
2749 Returns the customter this package was detached to, if any.
2753 sub change_cust_main {
2755 return '' unless $self->change_custnum;
2756 qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
2761 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
2768 $self->part_pkg->calc_setup($self, @_);
2773 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
2780 $self->part_pkg->calc_recur($self, @_);
2785 Calls the I<base_setup> of the FS::part_pkg object associated with this billing
2792 $self->part_pkg->base_setup($self, @_);
2797 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
2804 $self->part_pkg->base_recur($self, @_);
2809 Calls the I<calc_remain> of the FS::part_pkg object associated with this
2816 $self->part_pkg->calc_remain($self, @_);
2821 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
2828 $self->part_pkg->calc_cancel($self, @_);
2833 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
2839 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
2842 =item cust_pkg_detail [ DETAILTYPE ]
2844 Returns any customer package details for this package (see
2845 L<FS::cust_pkg_detail>).
2847 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2851 sub cust_pkg_detail {
2853 my %hash = ( 'pkgnum' => $self->pkgnum );
2854 $hash{detailtype} = shift if @_;
2856 'table' => 'cust_pkg_detail',
2857 'hashref' => \%hash,
2858 'order_by' => 'ORDER BY weight, pkgdetailnum',
2862 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
2864 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
2866 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2868 If there is an error, returns the error, otherwise returns false.
2872 sub set_cust_pkg_detail {
2873 my( $self, $detailtype, @details ) = @_;
2875 my $oldAutoCommit = $FS::UID::AutoCommit;
2876 local $FS::UID::AutoCommit = 0;
2879 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
2880 my $error = $current->delete;
2882 $dbh->rollback if $oldAutoCommit;
2883 return "error removing old detail: $error";
2887 foreach my $detail ( @details ) {
2888 my $cust_pkg_detail = new FS::cust_pkg_detail {
2889 'pkgnum' => $self->pkgnum,
2890 'detailtype' => $detailtype,
2891 'detail' => $detail,
2893 my $error = $cust_pkg_detail->insert;
2895 $dbh->rollback if $oldAutoCommit;
2896 return "error adding new detail: $error";
2901 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2908 Returns the customer billing events (see L<FS::cust_event>) for this invoice.
2912 #false laziness w/cust_bill.pm
2916 'table' => 'cust_event',
2917 'addl_from' => 'JOIN part_event USING ( eventpart )',
2918 'hashref' => { 'tablenum' => $self->pkgnum },
2919 'extra_sql' => " AND eventtable = 'cust_pkg' ",
2923 =item num_cust_event
2925 Returns the number of customer billing events (see L<FS::cust_event>) for this package.
2929 #false laziness w/cust_bill.pm
2930 sub num_cust_event {
2932 my $sql = "SELECT COUNT(*) ". $self->_from_cust_event_where;
2933 $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref->[0];
2936 =item exists_cust_event
2938 Returns true if there are customer billing events (see L<FS::cust_event>) for this package. More efficient than using num_cust_event.
2942 sub exists_cust_event {
2944 my $sql = "SELECT 1 ". $self->_from_cust_event_where. " LIMIT 1";
2945 my $row = $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref;
2946 $row ? $row->[0] : '';
2949 sub _from_cust_event_where {
2951 " FROM cust_event JOIN part_event USING ( eventpart ) ".
2952 " WHERE tablenum = ? AND eventtable = 'cust_pkg' ";
2956 my( $self, $sql, @args ) = @_;
2957 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
2958 $sth->execute(@args) or die $sth->errstr. " executing $sql";
2962 =item part_pkg_currency_option OPTIONNAME
2964 Returns a two item list consisting of the currency of this customer, if any,
2965 and a value for the provided option. If the customer has a currency, the value
2966 is the option value the given name and the currency (see
2967 L<FS::part_pkg_currency>). Otherwise, if the customer has no currency, is the
2968 regular option value for the given name (see L<FS::part_pkg_option>).
2972 sub part_pkg_currency_option {
2973 my( $self, $optionname ) = @_;
2974 my $part_pkg = $self->part_pkg;
2975 if ( my $currency = $self->cust_main->currency ) {
2976 ($currency, $part_pkg->part_pkg_currency_option($currency, $optionname) );
2978 ('', $part_pkg->option($optionname) );
2982 =item cust_svc [ SVCPART ] (old, deprecated usage)
2984 =item cust_svc [ OPTION => VALUE ... ] (current usage)
2986 =item cust_svc_unsorted [ OPTION => VALUE ... ]
2988 Returns the services for this package, as FS::cust_svc objects (see
2989 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
2990 spcififed, returns only the matching services.
2992 As an optimization, use the cust_svc_unsorted version if you are not displaying
2999 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
3000 $self->_sort_cust_svc( $self->cust_svc_unsorted_arrayref(@_) );
3003 sub cust_svc_unsorted {
3005 @{ $self->cust_svc_unsorted_arrayref(@_) };
3008 sub cust_svc_unsorted_arrayref {
3011 return [] unless $self->num_cust_svc(@_);
3014 if ( @_ && $_[0] =~ /^\d+/ ) {
3015 $opt{svcpart} = shift;
3016 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3023 'table' => 'cust_svc',
3024 'hashref' => { 'pkgnum' => $self->pkgnum },
3026 if ( $opt{svcpart} ) {
3027 $search{hashref}->{svcpart} = $opt{'svcpart'};
3029 if ( $opt{'svcdb'} ) {
3030 $search{addl_from} = ' LEFT JOIN part_svc USING ( svcpart ) ';
3031 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{'svcdb'} );
3034 [ qsearch(\%search) ];
3038 =item overlimit [ SVCPART ]
3040 Returns the services for this package which have exceeded their
3041 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
3042 is specified, return only the matching services.
3048 return () unless $self->num_cust_svc(@_);
3049 grep { $_->overlimit } $self->cust_svc(@_);
3052 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3054 Returns historical services for this package created before END TIMESTAMP and
3055 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
3056 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
3057 I<pkg_svc.hidden> flag will be omitted.
3063 warn "$me _h_cust_svc called on $self\n"
3066 my ($end, $start, $mode) = @_;
3068 local($FS::Record::qsearch_qualify_columns) = 0;
3070 my @cust_svc = $self->_sort_cust_svc(
3071 [ qsearch( 'h_cust_svc',
3072 { 'pkgnum' => $self->pkgnum, },
3073 FS::h_cust_svc->sql_h_search(@_),
3077 if ( defined($mode) && $mode eq 'I' ) {
3078 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
3079 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
3085 sub _sort_cust_svc {
3086 my( $self, $arrayref ) = @_;
3089 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
3091 my %pkg_svc = map { $_->svcpart => $_ }
3092 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
3097 my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
3099 $pkg_svc ? $pkg_svc->primary_svc : '',
3100 $pkg_svc ? $pkg_svc->quantity : 0,
3107 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
3109 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
3111 Returns the number of services for this package. Available options are svcpart
3112 and svcdb. If either is spcififed, returns only the matching services.
3119 return $self->{'_num_cust_svc'}
3121 && exists($self->{'_num_cust_svc'})
3122 && $self->{'_num_cust_svc'} =~ /\d/;
3124 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
3128 if ( @_ && $_[0] =~ /^\d+/ ) {
3129 $opt{svcpart} = shift;
3130 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3136 my $select = 'SELECT COUNT(*) FROM cust_svc ';
3137 my $where = ' WHERE pkgnum = ? ';
3138 my @param = ($self->pkgnum);
3140 if ( $opt{'svcpart'} ) {
3141 $where .= ' AND svcpart = ? ';
3142 push @param, $opt{'svcpart'};
3144 if ( $opt{'svcdb'} ) {
3145 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
3146 $where .= ' AND svcdb = ? ';
3147 push @param, $opt{'svcdb'};
3150 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
3151 $sth->execute(@param) or die $sth->errstr;
3152 $sth->fetchrow_arrayref->[0];
3155 =item available_part_svc
3157 Returns a list of FS::part_svc objects representing services included in this
3158 package but not yet provisioned. Each FS::part_svc object also has an extra
3159 field, I<num_avail>, which specifies the number of available services.
3163 sub available_part_svc {
3166 my $pkg_quantity = $self->quantity || 1;
3168 grep { $_->num_avail > 0 }
3170 my $part_svc = $_->part_svc;
3171 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
3172 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
3174 # more evil encapsulation breakage
3175 if($part_svc->{'Hash'}{'num_avail'} > 0) {
3176 my @exports = $part_svc->part_export_did;
3177 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
3182 $self->part_pkg->pkg_svc;
3185 =item part_svc [ OPTION => VALUE ... ]
3187 Returns a list of FS::part_svc objects representing provisioned and available
3188 services included in this package. Each FS::part_svc object also has the
3189 following extra fields:
3203 (services) - array reference containing the provisioned services, as cust_svc objects
3207 Accepts two options:
3211 =item summarize_size
3213 If true, will omit the extra cust_pkg_svc option for objects where num_cust_svc
3214 is this size or greater.
3216 =item hide_discontinued
3218 If true, will omit looking for services that are no longer avaialble in the
3226 #label -> ($cust_svc->label)[1]
3232 my $pkg_quantity = $self->quantity || 1;
3234 #XXX some sort of sort order besides numeric by svcpart...
3235 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
3237 my $part_svc = $pkg_svc->part_svc;
3238 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3239 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
3240 $part_svc->{'Hash'}{'num_avail'} =
3241 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
3242 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3243 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
3244 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
3245 && $num_cust_svc >= $opt{summarize_size};
3246 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
3248 } $self->part_pkg->pkg_svc;
3250 unless ( $opt{hide_discontinued} ) {
3252 push @part_svc, map {
3254 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3255 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
3256 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
3257 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3258 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
3260 } $self->extra_part_svc;
3267 =item extra_part_svc
3269 Returns a list of FS::part_svc objects corresponding to services in this
3270 package which are still provisioned but not (any longer) available in the
3275 sub extra_part_svc {
3278 my $pkgnum = $self->pkgnum;
3279 #my $pkgpart = $self->pkgpart;
3282 # 'table' => 'part_svc',
3285 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
3286 # WHERE pkg_svc.svcpart = part_svc.svcpart
3287 # AND pkg_svc.pkgpart = ?
3290 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
3291 # LEFT JOIN cust_pkg USING ( pkgnum )
3292 # WHERE cust_svc.svcpart = part_svc.svcpart
3295 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
3298 #seems to benchmark slightly faster... (or did?)
3300 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
3301 my $pkgparts = join(',', @pkgparts);
3304 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
3305 #MySQL doesn't grok DISINCT ON
3306 'select' => 'DISTINCT part_svc.*',
3307 'table' => 'part_svc',
3309 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
3310 AND pkg_svc.pkgpart IN ($pkgparts)
3313 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
3314 LEFT JOIN cust_pkg USING ( pkgnum )
3317 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
3318 'extra_param' => [ [$self->pkgnum=>'int'] ],
3324 Returns a short status string for this package, currently:
3330 =item not yet billed
3332 =item one-time charge
3347 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
3349 return 'cancelled' if $self->get('cancel');
3350 return 'on hold' if $self->susp && ! $self->setup;
3351 return 'suspended' if $self->susp;
3352 return 'not yet billed' unless $self->setup;
3353 return 'one-time charge' if $freq =~ /^(0|$)/;
3357 =item ucfirst_status
3359 Returns the status with the first character capitalized.
3363 sub ucfirst_status {
3364 ucfirst(shift->status);
3369 Class method that returns the list of possible status strings for packages
3370 (see L<the status method|/status>). For example:
3372 @statuses = FS::cust_pkg->statuses();
3376 tie my %statuscolor, 'Tie::IxHash',
3377 'on hold' => 'FF00F5', #brighter purple!
3378 'not yet billed' => '009999', #teal? cyan?
3379 'one-time charge' => '0000CC', #blue #'000000',
3380 'active' => '00CC00',
3381 'suspended' => 'FF9900',
3382 'cancelled' => 'FF0000',
3386 my $self = shift; #could be class...
3387 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
3388 # # mayble split btw one-time vs. recur
3399 Returns a hex triplet color string for this package's status.
3405 $statuscolor{$self->status};
3408 =item is_status_delay_cancel
3410 Returns true if part_pkg has option delay_cancel,
3411 cust_pkg status is 'suspended' and expire is set
3412 to cancel package within the next day (or however
3413 many days are set in global config part_pkg-delay_cancel-days.
3415 This is not a real status, this only meant for hacking display
3416 values, because otherwise treating the package as suspended is
3417 really the whole point of the delay_cancel option.
3421 sub is_status_delay_cancel {
3423 if ( $self->main_pkgnum and $self->pkglinknum ) {
3424 return $self->main_pkg->is_status_delay_cancel;
3426 return 0 unless $self->part_pkg->option('delay_cancel',1);
3427 return 0 unless $self->status eq 'suspended';
3428 return 0 unless $self->expire;
3429 my $conf = new FS::Conf;
3430 my $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
3431 my $expsecs = 60*60*24*$expdays;
3432 return 0 unless $self->expire < time + $expsecs;
3438 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
3439 "pkg - comment" depending on user preference).
3445 my $label = $self->part_pkg->pkg_comment( cust_pkg=>$self, nopkgpart=>1 );
3446 $label = $self->pkgnum. ": $label"
3447 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
3451 =item pkg_label_long
3453 Returns a long label for this package, adding the primary service's label to
3458 sub pkg_label_long {
3460 my $label = $self->pkg_label;
3461 my $cust_svc = $self->primary_cust_svc;
3462 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
3468 Returns a customer-localized label for this package.
3474 $self->part_pkg->pkg_locale( $self->cust_main->locale );
3477 =item primary_cust_svc
3479 Returns a primary service (as FS::cust_svc object) if one can be identified.
3483 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
3485 sub primary_cust_svc {
3488 my @cust_svc = $self->cust_svc;
3490 return '' unless @cust_svc; #no serivces - irrelevant then
3492 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
3494 # primary service as specified in the package definition
3495 # or exactly one service definition with quantity one
3496 my $svcpart = $self->part_pkg->svcpart;
3497 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
3498 return $cust_svc[0] if scalar(@cust_svc) == 1;
3500 #couldn't identify one thing..
3506 Returns a list of lists, calling the label method for all services
3507 (see L<FS::cust_svc>) of this billing item.
3513 map { [ $_->label ] } $self->cust_svc;
3516 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3518 Like the labels method, but returns historical information on services that
3519 were active as of END_TIMESTAMP and (optionally) not cancelled before
3520 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
3521 I<pkg_svc.hidden> flag will be omitted.
3523 Returns a list of lists, calling the label method for all (historical) services
3524 (see L<FS::h_cust_svc>) of this billing item.
3530 warn "$me _h_labels called on $self\n"
3532 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
3537 Like labels, except returns a simple flat list, and shortens long
3538 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3539 identical services to one line that lists the service label and the number of
3540 individual services rather than individual items.
3545 shift->_labels_short( 'labels', @_ );
3548 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
3550 Like h_labels, except returns a simple flat list, and shortens long
3551 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3552 identical services to one line that lists the service label and the number of
3553 individual services rather than individual items.
3557 sub h_labels_short {
3558 shift->_labels_short( 'h_labels', @_ );
3562 my( $self, $method ) = ( shift, shift );
3564 warn "$me _labels_short called on $self with $method method\n"
3567 my $conf = new FS::Conf;
3568 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
3570 warn "$me _labels_short populating \%labels\n"
3574 #tie %labels, 'Tie::IxHash';
3575 push @{ $labels{$_->[0]} }, $_->[1]
3576 foreach $self->$method(@_);
3578 warn "$me _labels_short populating \@labels\n"
3582 foreach my $label ( keys %labels ) {
3584 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
3585 my $num = scalar(@values);
3586 warn "$me _labels_short $num items for $label\n"
3589 if ( $num > $max_same_services ) {
3590 warn "$me _labels_short more than $max_same_services, so summarizing\n"
3592 push @labels, "$label ($num)";
3594 if ( $conf->exists('cust_bill-consolidate_services') ) {
3595 warn "$me _labels_short consolidating services\n"
3597 # push @labels, "$label: ". join(', ', @values);
3599 my $detail = "$label: ";
3600 $detail .= shift(@values). ', '
3602 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
3604 push @labels, $detail;
3606 warn "$me _labels_short done consolidating services\n"
3609 warn "$me _labels_short adding service data\n"
3611 push @labels, map { "$label: $_" } @values;
3622 Returns the parent customer object (see L<FS::cust_main>).
3626 Returns the balance for this specific package, when using
3627 experimental package balance.
3633 $self->cust_main->balance_pkgnum( $self->pkgnum );
3636 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
3640 Returns the location object, if any (see L<FS::cust_location>).
3642 =item cust_location_or_main
3644 If this package is associated with a location, returns the locaiton (see
3645 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
3647 =item location_label [ OPTION => VALUE ... ]
3649 Returns the label of the location object (see L<FS::cust_location>).
3653 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
3655 =item tax_locationnum
3657 Returns the foreign key to a L<FS::cust_location> object for calculating
3658 tax on this package, as determined by the C<tax-pkg_address> and
3659 C<tax-ship_address> configuration flags.
3663 sub tax_locationnum {
3665 my $conf = FS::Conf->new;
3666 if ( $conf->exists('tax-pkg_address') ) {
3667 return $self->locationnum;
3669 elsif ( $conf->exists('tax-ship_address') ) {
3670 return $self->cust_main->ship_locationnum;
3673 return $self->cust_main->bill_locationnum;
3679 Returns the L<FS::cust_location> object for tax_locationnum.
3685 my $conf = FS::Conf->new;
3686 if ( $conf->exists('tax-pkg_address') and $self->locationnum ) {
3687 return FS::cust_location->by_key($self->locationnum);
3689 elsif ( $conf->exists('tax-ship_address') ) {
3690 return $self->cust_main->ship_location;
3693 return $self->cust_main->bill_location;
3697 =item seconds_since TIMESTAMP
3699 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
3700 package have been online since TIMESTAMP, according to the session monitor.
3702 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
3703 L<Time::Local> and L<Date::Parse> for conversion functions.
3708 my($self, $since) = @_;
3711 foreach my $cust_svc (
3712 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
3714 $seconds += $cust_svc->seconds_since($since);
3721 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
3723 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
3724 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
3727 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3728 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3734 sub seconds_since_sqlradacct {
3735 my($self, $start, $end) = @_;
3739 foreach my $cust_svc (
3741 my $part_svc = $_->part_svc;
3742 $part_svc->svcdb eq 'svc_acct'
3743 && scalar($part_svc->part_export_usage);
3746 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
3753 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
3755 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
3756 in this package for sessions ending between TIMESTAMP_START (inclusive) and
3760 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3761 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3766 sub attribute_since_sqlradacct {
3767 my($self, $start, $end, $attrib) = @_;
3771 foreach my $cust_svc (
3773 my $part_svc = $_->part_svc;
3774 scalar($part_svc->part_export_usage);
3777 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
3789 my( $self, $value ) = @_;
3790 if ( defined($value) ) {
3791 $self->setfield('quantity', $value);
3793 $self->getfield('quantity') || 1;
3796 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
3798 Transfers as many services as possible from this package to another package.
3800 The destination package can be specified by pkgnum by passing an FS::cust_pkg
3801 object. The destination package must already exist.
3803 Services are moved only if the destination allows services with the correct
3804 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
3805 this option with caution! No provision is made for export differences
3806 between the old and new service definitions. Probably only should be used
3807 when your exports for all service definitions of a given svcdb are identical.
3808 (attempt a transfer without it first, to move all possible svcpart-matching
3811 Any services that can't be moved remain in the original package.
3813 Returns an error, if there is one; otherwise, returns the number of services
3814 that couldn't be moved.
3819 my ($self, $dest_pkgnum, %opt) = @_;
3825 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
3826 $dest = $dest_pkgnum;
3827 $dest_pkgnum = $dest->pkgnum;
3829 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
3832 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
3834 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
3835 $target{$pkg_svc->svcpart} = $pkg_svc->quantity * ( $dest->quantity || 1 );
3838 foreach my $cust_svc ($dest->cust_svc) {
3839 $target{$cust_svc->svcpart}--;
3842 my %svcpart2svcparts = ();
3843 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3844 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
3845 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
3846 next if exists $svcpart2svcparts{$svcpart};
3847 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
3848 $svcpart2svcparts{$svcpart} = [
3850 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
3852 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
3853 'svcpart' => $_ } );
3855 $pkg_svc ? $pkg_svc->primary_svc : '',
3856 $pkg_svc ? $pkg_svc->quantity : 0,
3860 grep { $_ != $svcpart }
3862 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
3864 warn "alternates for svcpart $svcpart: ".
3865 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
3871 foreach my $cust_svc ($self->cust_svc) {
3872 my $svcnum = $cust_svc->svcnum;
3873 if($target{$cust_svc->svcpart} > 0
3874 or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
3875 $target{$cust_svc->svcpart}--;
3876 my $new = new FS::cust_svc { $cust_svc->hash };
3877 $new->pkgnum($dest_pkgnum);
3878 $error = $new->replace($cust_svc);
3879 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3881 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
3882 warn "alternates to consider: ".
3883 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
3885 my @alternate = grep {
3886 warn "considering alternate svcpart $_: ".
3887 "$target{$_} available in new package\n"
3890 } @{$svcpart2svcparts{$cust_svc->svcpart}};
3892 warn "alternate(s) found\n" if $DEBUG;
3893 my $change_svcpart = $alternate[0];
3894 $target{$change_svcpart}--;
3895 my $new = new FS::cust_svc { $cust_svc->hash };
3896 $new->svcpart($change_svcpart);
3897 $new->pkgnum($dest_pkgnum);
3898 $error = $new->replace($cust_svc);
3906 my @label = $cust_svc->label;
3907 return "$label[0] $label[1]: $error";
3913 =item grab_svcnums SVCNUM, SVCNUM ...
3915 Change the pkgnum for the provided services to this packages. If there is an
3916 error, returns the error, otherwise returns false.
3924 my $oldAutoCommit = $FS::UID::AutoCommit;
3925 local $FS::UID::AutoCommit = 0;
3928 foreach my $svcnum (@svcnum) {
3929 my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
3930 $dbh->rollback if $oldAutoCommit;
3931 return "unknown svcnum $svcnum";
3933 $cust_svc->pkgnum( $self->pkgnum );
3934 my $error = $cust_svc->replace;
3936 $dbh->rollback if $oldAutoCommit;
3941 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3948 This method is deprecated. See the I<depend_jobnum> option to the insert and
3949 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
3953 #looks like this is still used by the order_pkg and change_pkg methods in
3954 # ClientAPI/MyAccount, need to look into those before removing
3958 my $oldAutoCommit = $FS::UID::AutoCommit;
3959 local $FS::UID::AutoCommit = 0;
3962 foreach my $cust_svc ( $self->cust_svc ) {
3963 #false laziness w/svc_Common::insert
3964 my $svc_x = $cust_svc->svc_x;
3965 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
3966 my $error = $part_export->export_insert($svc_x);
3968 $dbh->rollback if $oldAutoCommit;
3974 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3979 =item export_pkg_change OLD_CUST_PKG
3981 Calls the "pkg_change" export action for all services attached to this package.
3985 sub export_pkg_change {
3986 my( $self, $old ) = ( shift, shift );
3988 my $oldAutoCommit = $FS::UID::AutoCommit;
3989 local $FS::UID::AutoCommit = 0;
3992 foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
3993 my $error = $svc_x->export('pkg_change', $self, $old);
3995 $dbh->rollback if $oldAutoCommit;
4000 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4007 Associates this package with a (suspension or cancellation) reason (see
4008 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
4011 Available options are:
4017 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.
4021 the access_user (see L<FS::access_user>) providing the reason
4029 the action (cancel, susp, adjourn, expire) associated with the reason
4033 If there is an error, returns the error, otherwise returns false.
4038 my ($self, %options) = @_;
4040 my $otaker = $options{reason_otaker} ||
4041 $FS::CurrentUser::CurrentUser->username;
4044 if ( $options{'reason'} =~ /^(\d+)$/ ) {
4048 } elsif ( ref($options{'reason'}) ) {
4050 return 'Enter a new reason (or select an existing one)'
4051 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
4053 my $reason = new FS::reason({
4054 'reason_type' => $options{'reason'}->{'typenum'},
4055 'reason' => $options{'reason'}->{'reason'},
4057 my $error = $reason->insert;
4058 return $error if $error;
4060 $reasonnum = $reason->reasonnum;
4063 return "Unparseable reason: ". $options{'reason'};
4066 my $cust_pkg_reason =
4067 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
4068 'reasonnum' => $reasonnum,
4069 'otaker' => $otaker,
4070 'action' => substr(uc($options{'action'}),0,1),
4071 'date' => $options{'date'}
4076 $cust_pkg_reason->insert;
4079 =item insert_discount
4081 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
4082 inserting a new discount on the fly (see L<FS::discount>).
4084 Available options are:
4092 If there is an error, returns the error, otherwise returns false.
4096 sub insert_discount {
4097 #my ($self, %options) = @_;
4100 my $cust_pkg_discount = new FS::cust_pkg_discount {
4101 'pkgnum' => $self->pkgnum,
4102 'discountnum' => $self->discountnum,
4104 'end_date' => '', #XXX
4105 #for the create a new discount case
4106 '_type' => $self->discountnum__type,
4107 'amount' => $self->discountnum_amount,
4108 'percent' => $self->discountnum_percent,
4109 'months' => $self->discountnum_months,
4110 'setup' => $self->discountnum_setup,
4111 #'disabled' => $self->discountnum_disabled,
4114 $cust_pkg_discount->insert;
4117 =item set_usage USAGE_VALUE_HASHREF
4119 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4120 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4121 upbytes, downbytes, and totalbytes are appropriate keys.
4123 All svc_accts which are part of this package have their values reset.
4128 my ($self, $valueref, %opt) = @_;
4130 #only svc_acct can set_usage for now
4131 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4132 my $svc_x = $cust_svc->svc_x;
4133 $svc_x->set_usage($valueref, %opt)
4134 if $svc_x->can("set_usage");
4138 =item recharge USAGE_VALUE_HASHREF
4140 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4141 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4142 upbytes, downbytes, and totalbytes are appropriate keys.
4144 All svc_accts which are part of this package have their values incremented.
4149 my ($self, $valueref) = @_;
4151 #only svc_acct can set_usage for now
4152 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4153 my $svc_x = $cust_svc->svc_x;
4154 $svc_x->recharge($valueref)
4155 if $svc_x->can("recharge");
4159 =item apply_usageprice
4163 sub apply_usageprice {
4166 my $oldAutoCommit = $FS::UID::AutoCommit;
4167 local $FS::UID::AutoCommit = 0;
4172 foreach my $cust_pkg_usageprice ( $self->cust_pkg_usageprice ) {
4173 $error ||= $cust_pkg_usageprice->apply;
4177 $dbh->rollback if $oldAutoCommit;
4178 die "error applying part_pkg_usageprice add-ons, pkgnum ". $self->pkgnum.
4181 $dbh->commit if $oldAutoCommit;
4187 =item cust_pkg_discount
4189 =item cust_pkg_discount_active
4193 sub cust_pkg_discount_active {
4195 grep { $_->status eq 'active' } $self->cust_pkg_discount;
4198 =item cust_pkg_usage
4200 Returns a list of all voice usage counters attached to this package.
4202 =item apply_usage OPTIONS
4204 Takes the following options:
4205 - cdr: a call detail record (L<FS::cdr>)
4206 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
4207 - minutes: the maximum number of minutes to be charged
4209 Finds available usage minutes for a call of this class, and subtracts
4210 up to that many minutes from the usage pool. If the usage pool is empty,
4211 and the C<cdr-minutes_priority> global config option is set, minutes may
4212 be taken from other calls as well. Either way, an allocation record will
4213 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
4214 number of minutes of usage applied to the call.
4219 my ($self, %opt) = @_;
4220 my $cdr = $opt{cdr};
4221 my $rate_detail = $opt{rate_detail};
4222 my $minutes = $opt{minutes};
4223 my $classnum = $rate_detail->classnum;
4224 my $pkgnum = $self->pkgnum;
4225 my $custnum = $self->custnum;
4227 my $oldAutoCommit = $FS::UID::AutoCommit;
4228 local $FS::UID::AutoCommit = 0;
4231 my $order = FS::Conf->new->config('cdr-minutes_priority');
4235 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
4237 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
4239 my @usage_recs = qsearch({
4240 'table' => 'cust_pkg_usage',
4241 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
4242 ' JOIN cust_pkg USING (pkgnum)'.
4243 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
4244 'select' => 'cust_pkg_usage.*',
4245 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
4246 " ( cust_pkg.custnum = $custnum AND ".
4247 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4248 $is_classnum . ' AND '.
4249 " cust_pkg_usage.minutes > 0",
4250 'order_by' => " ORDER BY priority ASC",
4253 my $orig_minutes = $minutes;
4255 while (!$error and $minutes > 0 and @usage_recs) {
4256 my $cust_pkg_usage = shift @usage_recs;
4257 $cust_pkg_usage->select_for_update;
4258 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
4259 pkgusagenum => $cust_pkg_usage->pkgusagenum,
4260 acctid => $cdr->acctid,
4261 minutes => min($cust_pkg_usage->minutes, $minutes),
4263 $cust_pkg_usage->set('minutes',
4264 $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes
4266 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
4267 $minutes -= $cdr_cust_pkg_usage->minutes;
4269 if ( $order and $minutes > 0 and !$error ) {
4270 # then try to steal minutes from another call
4272 'table' => 'cdr_cust_pkg_usage',
4273 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
4274 ' JOIN part_pkg_usage USING (pkgusagepart)'.
4275 ' JOIN cust_pkg USING (pkgnum)'.
4276 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
4277 ' JOIN cdr USING (acctid)',
4278 'select' => 'cdr_cust_pkg_usage.*',
4279 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
4280 " ( cust_pkg.pkgnum = $pkgnum OR ".
4281 " ( cust_pkg.custnum = $custnum AND ".
4282 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4283 " part_pkg_usage_class.classnum = $classnum",
4284 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
4286 if ( $order eq 'time' ) {
4287 # find CDRs that are using minutes, but have a later startdate
4289 my $startdate = $cdr->startdate;
4290 if ($startdate !~ /^\d+$/) {
4291 die "bad cdr startdate '$startdate'";
4293 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
4294 # minimize needless reshuffling
4295 $search{'order_by'} .= ', cdr.startdate DESC';
4297 # XXX may not work correctly with rate_time schedules. Could
4298 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
4300 $search{'addl_from'} .=
4301 ' JOIN rate_detail'.
4302 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
4303 if ( $order eq 'rate_high' ) {
4304 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
4305 $rate_detail->min_charge;
4306 $search{'order_by'} .= ', rate_detail.min_charge ASC';
4307 } elsif ( $order eq 'rate_low' ) {
4308 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
4309 $rate_detail->min_charge;
4310 $search{'order_by'} .= ', rate_detail.min_charge DESC';
4312 # this should really never happen
4313 die "invalid cdr-minutes_priority value '$order'\n";
4316 my @cdr_usage_recs = qsearch(\%search);
4318 while (!$error and @cdr_usage_recs and $minutes > 0) {
4319 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
4320 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
4321 my $old_cdr = $cdr_cust_pkg_usage->cdr;
4322 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
4323 $cdr_cust_pkg_usage->select_for_update;
4324 $old_cdr->select_for_update;
4325 $cust_pkg_usage->select_for_update;
4326 # in case someone else stole the usage from this CDR
4327 # while waiting for the lock...
4328 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
4329 # steal the usage allocation and flag the old CDR for reprocessing
4330 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
4331 # if the allocation is more minutes than we need, adjust it...
4332 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
4334 $cdr_cust_pkg_usage->set('minutes', $minutes);
4335 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
4336 $error = $cust_pkg_usage->replace;
4338 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
4339 $error ||= $cdr_cust_pkg_usage->replace;
4340 # deduct the stolen minutes
4341 $minutes -= $cdr_cust_pkg_usage->minutes;
4343 # after all minute-stealing is done, reset the affected CDRs
4344 foreach (values %reproc_cdrs) {
4345 $error ||= $_->set_status('');
4346 # XXX or should we just call $cdr->rate right here?
4347 # it's not like we can create a loop this way, since the min_charge
4348 # or call time has to go monotonically in one direction.
4349 # we COULD get some very deep recursions going, though...
4351 } # if $order and $minutes
4354 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
4356 $dbh->commit if $oldAutoCommit;
4357 return $orig_minutes - $minutes;
4361 =item supplemental_pkgs
4363 Returns a list of all packages supplemental to this one.
4367 sub supplemental_pkgs {
4369 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
4374 Returns the package that this one is supplemental to, if any.
4380 if ( $self->main_pkgnum ) {
4381 return FS::cust_pkg->by_key($self->main_pkgnum);
4388 =head1 CLASS METHODS
4394 Returns an SQL expression identifying recurring packages.
4398 sub recurring_sql { "
4399 '0' != ( select freq from part_pkg
4400 where cust_pkg.pkgpart = part_pkg.pkgpart )
4405 Returns an SQL expression identifying one-time packages.
4410 '0' = ( select freq from part_pkg
4411 where cust_pkg.pkgpart = part_pkg.pkgpart )
4416 Returns an SQL expression identifying ordered packages (recurring packages not
4422 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
4427 Returns an SQL expression identifying active packages.
4432 $_[0]->recurring_sql. "
4433 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4434 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4435 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4438 =item not_yet_billed_sql
4440 Returns an SQL expression identifying packages which have not yet been billed.
4444 sub not_yet_billed_sql { "
4445 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4446 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4447 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4452 Returns an SQL expression identifying inactive packages (one-time packages
4453 that are otherwise unsuspended/uncancelled).
4457 sub inactive_sql { "
4458 ". $_[0]->onetime_sql(). "
4459 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4460 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4461 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4466 Returns an SQL expression identifying on-hold packages.
4471 #$_[0]->recurring_sql(). ' AND '.
4473 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4474 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4475 AND ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4482 Returns an SQL expression identifying suspended packages.
4486 sub suspended_sql { susp_sql(@_); }
4488 #$_[0]->recurring_sql(). ' AND '.
4490 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4491 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4492 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4499 Returns an SQL exprression identifying cancelled packages.
4503 sub cancelled_sql { cancel_sql(@_); }
4505 #$_[0]->recurring_sql(). ' AND '.
4506 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
4511 Returns an SQL expression to give the package status as a string.
4517 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
4518 WHEN ( cust_pkg.susp IS NOT NULL AND cust_pkg.setup IS NULL ) THEN 'on hold'
4519 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
4520 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
4521 WHEN ".onetime_sql()." THEN 'one-time charge'
4528 Returns a list of two package counts. The first is a count of packages
4529 based on the supplied criteria and the second is the count of residential
4530 packages with those same criteria. Criteria are specified as in the search
4536 my ($class, $params) = @_;
4538 my $sql_query = $class->search( $params );
4540 my $count_sql = delete($sql_query->{'count_query'});
4541 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
4542 or die "couldn't parse count_sql";
4544 my $count_sth = dbh->prepare($count_sql)
4545 or die "Error preparing $count_sql: ". dbh->errstr;
4547 or die "Error executing $count_sql: ". $count_sth->errstr;
4548 my $count_arrayref = $count_sth->fetchrow_arrayref;
4550 return ( @$count_arrayref );
4554 =item tax_locationnum_sql
4556 Returns an SQL expression for the tax location for a package, based
4557 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
4561 sub tax_locationnum_sql {
4562 my $conf = FS::Conf->new;
4563 if ( $conf->exists('tax-pkg_address') ) {
4564 'cust_pkg.locationnum';
4566 elsif ( $conf->exists('tax-ship_address') ) {
4567 'cust_main.ship_locationnum';
4570 'cust_main.bill_locationnum';
4576 Returns a list: the first item is an SQL fragment identifying matching
4577 packages/customers via location (taking into account shipping and package
4578 address taxation, if enabled), and subsequent items are the parameters to
4579 substitute for the placeholders in that fragment.
4584 my($class, %opt) = @_;
4585 my $ornull = $opt{'ornull'};
4587 my $conf = new FS::Conf;
4589 # '?' placeholders in _location_sql_where
4590 my $x = $ornull ? 3 : 2;
4601 if ( $conf->exists('tax-ship_address') ) {
4604 ( ( ship_last IS NULL OR ship_last = '' )
4605 AND ". _location_sql_where('cust_main', '', $ornull ). "
4607 OR ( ship_last IS NOT NULL AND ship_last != ''
4608 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
4611 # AND payby != 'COMP'
4613 @main_param = ( @bill_param, @bill_param );
4617 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
4618 @main_param = @bill_param;
4624 if ( $conf->exists('tax-pkg_address') ) {
4626 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
4629 ( cust_pkg.locationnum IS NULL AND $main_where )
4630 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
4633 @param = ( @main_param, @bill_param );
4637 $where = $main_where;
4638 @param = @main_param;
4646 #subroutine, helper for location_sql
4647 sub _location_sql_where {
4649 my $prefix = @_ ? shift : '';
4650 my $ornull = @_ ? shift : '';
4652 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
4654 $ornull = $ornull ? ' OR ? IS NULL ' : '';
4656 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
4657 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
4658 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
4660 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
4662 # ( $table.${prefix}city = ? $or_empty_city $ornull )
4664 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4665 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4666 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
4667 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
4668 AND $table.${prefix}country = ?
4673 my( $self, $what ) = @_;
4675 my $what_show_zero = $what. '_show_zero';
4676 length($self->$what_show_zero())
4677 ? ($self->$what_show_zero() eq 'Y')
4678 : $self->part_pkg->$what_show_zero();
4685 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
4687 CUSTNUM is a customer (see L<FS::cust_main>)
4689 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4690 L<FS::part_pkg>) to order for this customer. Duplicates are of course
4693 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
4694 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
4695 new billing items. An error is returned if this is not possible (see
4696 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
4699 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4700 newly-created cust_pkg objects.
4702 REFNUM, if specified, will specify the FS::pkg_referral record to be created
4703 and inserted. Multiple FS::pkg_referral records can be created by
4704 setting I<refnum> to an array reference of refnums or a hash reference with
4705 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
4706 record will be created corresponding to cust_main.refnum.
4711 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
4713 my $conf = new FS::Conf;
4715 # Transactionize this whole mess
4716 my $oldAutoCommit = $FS::UID::AutoCommit;
4717 local $FS::UID::AutoCommit = 0;
4721 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
4722 # return "Customer not found: $custnum" unless $cust_main;
4724 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
4727 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4730 my $change = scalar(@old_cust_pkg) != 0;
4733 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
4735 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
4736 " to pkgpart ". $pkgparts->[0]. "\n"
4739 my $err_or_cust_pkg =
4740 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
4741 'refnum' => $refnum,
4744 unless (ref($err_or_cust_pkg)) {
4745 $dbh->rollback if $oldAutoCommit;
4746 return $err_or_cust_pkg;
4749 push @$return_cust_pkg, $err_or_cust_pkg;
4750 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4755 # Create the new packages.
4756 foreach my $pkgpart (@$pkgparts) {
4758 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
4760 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
4761 pkgpart => $pkgpart,
4765 $error = $cust_pkg->insert( 'change' => $change );
4766 push @$return_cust_pkg, $cust_pkg;
4768 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
4769 my $supp_pkg = FS::cust_pkg->new({
4770 custnum => $custnum,
4771 pkgpart => $link->dst_pkgpart,
4773 main_pkgnum => $cust_pkg->pkgnum,
4776 $error ||= $supp_pkg->insert( 'change' => $change );
4777 push @$return_cust_pkg, $supp_pkg;
4781 $dbh->rollback if $oldAutoCommit;
4786 # $return_cust_pkg now contains refs to all of the newly
4789 # Transfer services and cancel old packages.
4790 foreach my $old_pkg (@old_cust_pkg) {
4792 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
4795 foreach my $new_pkg (@$return_cust_pkg) {
4796 $error = $old_pkg->transfer($new_pkg);
4797 if ($error and $error == 0) {
4798 # $old_pkg->transfer failed.
4799 $dbh->rollback if $oldAutoCommit;
4804 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
4805 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
4806 foreach my $new_pkg (@$return_cust_pkg) {
4807 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
4808 if ($error and $error == 0) {
4809 # $old_pkg->transfer failed.
4810 $dbh->rollback if $oldAutoCommit;
4817 # Transfers were successful, but we went through all of the
4818 # new packages and still had services left on the old package.
4819 # We can't cancel the package under the circumstances, so abort.
4820 $dbh->rollback if $oldAutoCommit;
4821 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
4823 $error = $old_pkg->cancel( quiet=>1, 'no_delay_cancel'=>1 );
4829 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4833 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
4835 A bulk change method to change packages for multiple customers.
4837 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4838 L<FS::part_pkg>) to order for each customer. Duplicates are of course
4841 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
4842 replace. The services (see L<FS::cust_svc>) are moved to the
4843 new billing items. An error is returned if this is not possible (see
4846 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4847 newly-created cust_pkg objects.
4852 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
4854 # Transactionize this whole mess
4855 my $oldAutoCommit = $FS::UID::AutoCommit;
4856 local $FS::UID::AutoCommit = 0;
4860 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4863 while(scalar(@old_cust_pkg)) {
4865 my $custnum = $old_cust_pkg[0]->custnum;
4866 my (@remove) = map { $_->pkgnum }
4867 grep { $_->custnum == $custnum } @old_cust_pkg;
4868 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
4870 my $error = order $custnum, $pkgparts, \@remove, \@return;
4872 push @errors, $error
4874 push @$return_cust_pkg, @return;
4877 if (scalar(@errors)) {
4878 $dbh->rollback if $oldAutoCommit;
4879 return join(' / ', @errors);
4882 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4886 # Used by FS::Upgrade to migrate to a new database.
4887 sub _upgrade_data { # class method
4888 my ($class, %opts) = @_;
4889 $class->_upgrade_otaker(%opts);
4891 # RT#10139, bug resulting in contract_end being set when it shouldn't
4892 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
4893 # RT#10830, bad calculation of prorate date near end of year
4894 # the date range for bill is December 2009, and we move it forward
4895 # one year if it's before the previous bill date (which it should
4897 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
4898 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
4899 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
4900 # RT6628, add order_date to cust_pkg
4901 'update cust_pkg set order_date = (select history_date from h_cust_pkg
4902 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
4903 history_action = \'insert\') where order_date is null',
4905 foreach my $sql (@statements) {
4906 my $sth = dbh->prepare($sql);
4907 $sth->execute or die $sth->errstr;
4910 # RT31194: supplemental package links that are deleted don't clean up
4912 my @pkglinknums = qsearch({
4913 'select' => 'DISTINCT cust_pkg.pkglinknum',
4914 'table' => 'cust_pkg',
4915 'addl_from' => ' LEFT JOIN part_pkg_link USING (pkglinknum) ',
4916 'extra_sql' => ' WHERE cust_pkg.pkglinknum IS NOT NULL
4917 AND part_pkg_link.pkglinknum IS NULL',
4919 foreach (@pkglinknums) {
4920 my $pkglinknum = $_->pkglinknum;
4921 warn "cleaning part_pkg_link #$pkglinknum\n";
4922 my $part_pkg_link = FS::part_pkg_link->new({pkglinknum => $pkglinknum});
4923 my $error = $part_pkg_link->remove_linked;
4924 die $error if $error;
4932 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
4934 In sub order, the @pkgparts array (passed by reference) is clobbered.
4936 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
4937 method to pass dates to the recur_prog expression, it should do so.
4939 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
4940 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
4941 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
4942 configuration values. Probably need a subroutine which decides what to do
4943 based on whether or not we've fetched the user yet, rather than a hash. See
4944 FS::UID and the TODO.
4946 Now that things are transactional should the check in the insert method be
4951 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
4952 L<FS::pkg_svc>, schema.html from the base documentation