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 no_delay_cancel - prevents delay_cancel behavior
789 no matter what other options say, for use when changing packages (or any
790 other time you're really sure you want an immediate cancel)
794 If there is an error, returns the error, otherwise returns false.
798 #NOT DOCUMENTING - this should only be used when calling recursively
799 #=item delay_cancel - for internal use, to allow proper handling of
800 #supplemental packages when the main package is flagged to suspend
801 #before cancelling, probably shouldn't be used otherwise (set the
802 #corresponding package option instead)
805 my( $self, %options ) = @_;
808 # pass all suspend/cancel actions to the main package
809 # (unless the pkglinknum has been removed, then the link is defunct and
810 # this package can be canceled on its own)
811 if ( $self->main_pkgnum and $self->pkglinknum and !$options{'from_main'} ) {
812 return $self->main_pkg->cancel(%options);
815 my $conf = new FS::Conf;
817 warn "cust_pkg::cancel called with options".
818 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
821 my $oldAutoCommit = $FS::UID::AutoCommit;
822 local $FS::UID::AutoCommit = 0;
825 my $old = $self->select_for_update;
827 if ( $old->get('cancel') || $self->get('cancel') ) {
828 dbh->rollback if $oldAutoCommit;
829 return ""; # no error
832 # XXX possibly set cancel_time to the expire date?
833 my $cancel_time = $options{'time'} || time;
834 my $date = $options{'date'} if $options{'date'}; # expire/cancel later
835 $date = '' if ($date && $date <= $cancel_time); # complain instead?
837 my $delay_cancel = $options{'no_delay_cancel'} ? 0 : $options{'delay_cancel'};
838 if ( !$date && $self->part_pkg->option('delay_cancel',1)
839 && (($self->status eq 'active') || ($self->status eq 'suspended'))
840 && !$options{'no_delay_cancel'}
842 my $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
843 my $expsecs = 60*60*24*$expdays;
844 my $suspfor = $self->susp ? $cancel_time - $self->susp : 0;
845 $expsecs = $expsecs - $suspfor if $suspfor;
846 unless ($expsecs <= 0) { #if it's already been suspended long enough, don't re-suspend
848 $date = $cancel_time + $expsecs;
852 #race condition: usage could be ongoing until unprovisioned
853 #resolved by performing a change package instead (which unprovisions) and
855 if ( !$options{nobill} && !$date ) {
856 # && $conf->exists('bill_usage_on_cancel') ) { #calc_cancel checks this
857 my $copy = $self->new({$self->hash});
859 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
861 'time' => $cancel_time );
862 warn "Error billing during cancel, custnum ".
863 #$self->cust_main->custnum. ": $error"
868 if ( $options{'reason'} ) {
869 $error = $self->insert_reason( 'reason' => $options{'reason'},
870 'action' => $date ? 'expire' : 'cancel',
871 'date' => $date ? $date : $cancel_time,
872 'reason_otaker' => $options{'reason_otaker'},
875 dbh->rollback if $oldAutoCommit;
876 return "Error inserting cust_pkg_reason: $error";
880 my %svc_cancel_opt = ();
881 $svc_cancel_opt{'date'} = $date if $date;
882 foreach my $cust_svc (
885 sort { $a->[1] <=> $b->[1] }
886 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; }
887 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
889 my $part_svc = $cust_svc->part_svc;
890 next if ( defined($part_svc) and $part_svc->preserve );
891 my $error = $cust_svc->cancel( %svc_cancel_opt );
894 $dbh->rollback if $oldAutoCommit;
895 return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
901 # credit remaining time if appropriate
903 if ( exists($options{'unused_credit'}) ) {
904 $do_credit = $options{'unused_credit'};
907 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
910 my $error = $self->credit_remaining('cancel', $cancel_time);
912 $dbh->rollback if $oldAutoCommit;
918 my %hash = $self->hash;
920 $hash{'expire'} = $date;
922 # just to be sure these are clear
923 $hash{'adjourn'} = undef;
924 $hash{'resume'} = undef;
927 $hash{'cancel'} = $cancel_time;
929 $hash{'change_custnum'} = $options{'change_custnum'};
931 # if this is a supplemental package that's lost its part_pkg_link, and it's
932 # being canceled for real, unlink it completely
933 if ( !$date and ! $self->pkglinknum ) {
934 $hash{main_pkgnum} = '';
937 my $new = new FS::cust_pkg ( \%hash );
938 $error = $new->replace( $self, options => { $self->options } );
939 if ( $self->change_to_pkgnum ) {
940 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
941 $error ||= $change_to->cancel('no_delay_cancel' => 1) || $change_to->delete;
944 $dbh->rollback if $oldAutoCommit;
948 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
949 $error = $supp_pkg->cancel(%options,
951 'date' => $date, #in case it got changed by delay_cancel
952 'delay_cancel' => $delay_cancel,
955 $dbh->rollback if $oldAutoCommit;
956 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
960 if ($delay_cancel && !$options{'from_main'}) {
961 $error = $new->suspend(
963 'time' => $cancel_time
968 foreach my $usage ( $self->cust_pkg_usage ) {
969 $error = $usage->delete;
971 $dbh->rollback if $oldAutoCommit;
972 return "deleting usage pools: $error";
977 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
978 return '' if $date; #no errors
980 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
981 if ( !$options{'quiet'} &&
982 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
984 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
987 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
988 $error = $msg_template->send( 'cust_main' => $self->cust_main,
993 'from' => $conf->invoice_from_full( $self->cust_main->agentnum ),
994 'to' => \@invoicing_list,
995 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
996 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
997 'custnum' => $self->custnum,
998 'msgtype' => '', #admin?
1001 #should this do something on errors?
1008 =item cancel_if_expired [ NOW_TIMESTAMP ]
1010 Cancels this package if its expire date has been reached.
1014 sub cancel_if_expired {
1016 my $time = shift || time;
1017 return '' unless $self->expire && $self->expire <= $time;
1018 my $error = $self->cancel;
1020 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
1021 $self->custnum. ": $error";
1028 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
1029 locationnum, (other fields?). Attempts to re-provision cancelled services
1030 using history information (errors at this stage are not fatal).
1032 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
1034 svc_fatal: service provisioning errors are fatal
1036 svc_errors: pass an array reference, will be filled in with any provisioning errors
1038 main_pkgnum: link the package as a supplemental package of this one. For
1044 my( $self, %options ) = @_;
1046 #in case you try do do $uncancel-date = $cust_pkg->uncacel
1047 return '' unless $self->get('cancel');
1049 if ( $self->main_pkgnum and !$options{'main_pkgnum'} ) {
1050 return $self->main_pkg->uncancel(%options);
1057 my $oldAutoCommit = $FS::UID::AutoCommit;
1058 local $FS::UID::AutoCommit = 0;
1062 # insert the new package
1065 my $cust_pkg = new FS::cust_pkg {
1066 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
1067 bill => ( $options{'bill'} || $self->get('bill') ),
1069 uncancel_pkgnum => $self->pkgnum,
1070 main_pkgnum => ($options{'main_pkgnum'} || ''),
1071 map { $_ => $self->get($_) } qw(
1072 custnum pkgpart locationnum
1074 susp adjourn resume expire start_date contract_end dundate
1075 change_date change_pkgpart change_locationnum
1076 manual_flag no_auto separate_bill quantity agent_pkgid
1077 recur_show_zero setup_show_zero
1081 my $error = $cust_pkg->insert(
1082 'change' => 1, #supresses any referral credit to a referring customer
1083 'allow_pkgpart' => 1, # allow this even if the package def is disabled
1086 $dbh->rollback if $oldAutoCommit;
1094 #find historical services within this timeframe before the package cancel
1095 # (incompatible with "time" option to cust_pkg->cancel?)
1096 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
1097 # too little? (unprovisioing export delay?)
1098 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
1099 my @h_cust_svc = $self->h_cust_svc( $end, $start );
1102 foreach my $h_cust_svc (@h_cust_svc) {
1103 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
1104 #next unless $h_svc_x; #should this happen?
1105 (my $table = $h_svc_x->table) =~ s/^h_//;
1106 require "FS/$table.pm";
1107 my $class = "FS::$table";
1108 my $svc_x = $class->new( {
1109 'pkgnum' => $cust_pkg->pkgnum,
1110 'svcpart' => $h_cust_svc->svcpart,
1111 map { $_ => $h_svc_x->get($_) } fields($table)
1115 if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
1116 $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
1119 my $svc_error = $svc_x->insert;
1121 if ( $options{svc_fatal} ) {
1122 $dbh->rollback if $oldAutoCommit;
1125 # if we've failed to insert the svc_x object, svc_Common->insert
1126 # will have removed the cust_svc already. if not, then both records
1127 # were inserted but we failed for some other reason (export, most
1128 # likely). in that case, report the error and delete the records.
1129 push @svc_errors, $svc_error;
1130 my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1132 # except if export_insert failed, export_delete probably won't be
1134 local $FS::svc_Common::noexport_hack = 1;
1135 my $cleanup_error = $svc_x->delete; # also deletes cust_svc
1136 if ( $cleanup_error ) { # and if THAT fails, then run away
1137 $dbh->rollback if $oldAutoCommit;
1138 return $cleanup_error;
1143 } #foreach $h_cust_svc
1145 #these are pretty rare, but should handle them
1146 # - dsl_device (mac addresses)
1147 # - phone_device (mac addresses)
1148 # - dsl_note (ikano notes)
1149 # - domain_record (i.e. restore DNS information w/domains)
1150 # - inventory_item(?) (inventory w/un-cancelling service?)
1151 # - nas (svc_broaband nas stuff)
1152 #this stuff is unused in the wild afaik
1153 # - mailinglistmember
1155 # - svc_domain.parent_svcnum?
1156 # - acct_snarf (ancient mail fetching config)
1157 # - cgp_rule (communigate)
1158 # - cust_svc_option (used by our Tron stuff)
1159 # - acct_rt_transaction (used by our time worked stuff)
1162 # also move over any services that didn't unprovision at cancellation
1165 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1166 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1167 my $error = $cust_svc->replace;
1169 $dbh->rollback if $oldAutoCommit;
1175 # Uncancel any supplemental packages, and make them supplemental to the
1179 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1181 $error = $supp_pkg->uncancel(%options, 'main_pkgnum' => $cust_pkg->pkgnum);
1183 $dbh->rollback if $oldAutoCommit;
1184 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1192 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1194 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1195 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1202 Cancels any pending expiration (sets the expire field to null).
1204 If there is an error, returns the error, otherwise returns false.
1209 my( $self, %options ) = @_;
1212 my $oldAutoCommit = $FS::UID::AutoCommit;
1213 local $FS::UID::AutoCommit = 0;
1216 my $old = $self->select_for_update;
1218 my $pkgnum = $old->pkgnum;
1219 if ( $old->get('cancel') || $self->get('cancel') ) {
1220 dbh->rollback if $oldAutoCommit;
1221 return "Can't unexpire cancelled package $pkgnum";
1222 # or at least it's pointless
1225 unless ( $old->get('expire') && $self->get('expire') ) {
1226 dbh->rollback if $oldAutoCommit;
1227 return ""; # no error
1230 my %hash = $self->hash;
1231 $hash{'expire'} = '';
1232 my $new = new FS::cust_pkg ( \%hash );
1233 $error = $new->replace( $self, options => { $self->options } );
1235 $dbh->rollback if $oldAutoCommit;
1239 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1245 =item suspend [ OPTION => VALUE ... ]
1247 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1248 package, then suspends the package itself (sets the susp field to now).
1250 Available options are:
1254 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1255 either a reasonnum of an existing reason, or passing a hashref will create
1256 a new reason. The hashref should have the following keys:
1257 - typenum - Reason type (see L<FS::reason_type>
1258 - reason - Text of the new reason.
1260 =item date - can be set to a unix style timestamp to specify when to
1263 =item time - can be set to override the current time, for calculation
1264 of final invoices or unused-time credits
1266 =item resume_date - can be set to a time when the package should be
1267 unsuspended. This may be more convenient than calling C<unsuspend()>
1270 =item from_main - allows a supplemental package to be suspended, rather
1271 than redirecting the method call to its main package. For internal use.
1273 =item from_cancel - used when suspending from the cancel method, forces
1274 this to skip everything besides basic suspension. For internal use.
1278 If there is an error, returns the error, otherwise returns false.
1283 my( $self, %options ) = @_;
1286 # pass all suspend/cancel actions to the main package
1287 if ( $self->main_pkgnum and !$options{'from_main'} ) {
1288 return $self->main_pkg->suspend(%options);
1291 my $oldAutoCommit = $FS::UID::AutoCommit;
1292 local $FS::UID::AutoCommit = 0;
1295 my $old = $self->select_for_update;
1297 my $pkgnum = $old->pkgnum;
1298 if ( $old->get('cancel') || $self->get('cancel') ) {
1299 dbh->rollback if $oldAutoCommit;
1300 return "Can't suspend cancelled package $pkgnum";
1303 if ( $old->get('susp') || $self->get('susp') ) {
1304 dbh->rollback if $oldAutoCommit;
1305 return ""; # no error # complain on adjourn?
1308 my $suspend_time = $options{'time'} || time;
1309 my $date = $options{date} if $options{date}; # adjourn/suspend later
1310 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1312 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1313 dbh->rollback if $oldAutoCommit;
1314 return "Package $pkgnum expires before it would be suspended.";
1317 # some false laziness with sub cancel
1318 if ( !$options{nobill} && !$date && !$options{'from_cancel'} &&
1319 $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1320 # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1321 # make the entire cust_main->bill path recognize 'suspend' and
1322 # 'cancel' separately.
1323 warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1324 my $copy = $self->new({$self->hash});
1326 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1328 'time' => $suspend_time );
1329 warn "Error billing during suspend, custnum ".
1330 #$self->cust_main->custnum. ": $error"
1335 if ( $options{'reason'} ) {
1336 $error = $self->insert_reason( 'reason' => $options{'reason'},
1337 'action' => $date ? 'adjourn' : 'suspend',
1338 'date' => $date ? $date : $suspend_time,
1339 'reason_otaker' => $options{'reason_otaker'},
1342 dbh->rollback if $oldAutoCommit;
1343 return "Error inserting cust_pkg_reason: $error";
1347 # if a reasonnum was passed, get the actual reason object so we can check
1349 # (passing a reason hashref is still allowed, but it can't be used with
1350 # the fancy behavioral options.)
1353 if ($options{'reason'} =~ /^\d+$/) {
1354 $reason = FS::reason->by_key($options{'reason'});
1357 my %hash = $self->hash;
1359 $hash{'adjourn'} = $date;
1361 $hash{'susp'} = $suspend_time;
1364 my $resume_date = $options{'resume_date'} || 0;
1365 if ( $resume_date > ($date || $suspend_time) ) {
1366 $hash{'resume'} = $resume_date;
1369 $options{options} ||= {};
1371 my $new = new FS::cust_pkg ( \%hash );
1372 $error = $new->replace( $self, options => { $self->options,
1373 %{ $options{options} },
1377 $dbh->rollback if $oldAutoCommit;
1381 unless ( $date ) { # then we are suspending now
1383 unless ($options{'from_cancel'}) {
1384 # credit remaining time if appropriate
1385 # (if required by the package def, or the suspend reason)
1386 my $unused_credit = $self->part_pkg->option('unused_credit_suspend',1)
1387 || ( defined($reason) && $reason->unused_credit );
1389 if ( $unused_credit ) {
1390 warn "crediting unused time on pkg#".$self->pkgnum."\n" if $DEBUG;
1391 my $error = $self->credit_remaining('suspend', $suspend_time);
1393 $dbh->rollback if $oldAutoCommit;
1401 foreach my $cust_svc (
1402 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1404 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1406 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1407 $dbh->rollback if $oldAutoCommit;
1408 return "Illegal svcdb value in part_svc!";
1411 require "FS/$svcdb.pm";
1413 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1415 $error = $svc->suspend;
1417 $dbh->rollback if $oldAutoCommit;
1420 my( $label, $value ) = $cust_svc->label;
1421 push @labels, "$label: $value";
1425 my $conf = new FS::Conf;
1426 if ( $conf->config('suspend_email_admin') && !$options{'from_cancel'} ) {
1428 my $error = send_email(
1429 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1430 #invoice_from ??? well as good as any
1431 'to' => $conf->config('suspend_email_admin'),
1432 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1434 "This is an automatic message from your Freeside installation\n",
1435 "informing you that the following customer package has been suspended:\n",
1437 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1438 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1439 ( map { "Service : $_\n" } @labels ),
1441 'custnum' => $self->custnum,
1442 'msgtype' => 'admin'
1446 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1454 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1455 $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1457 $dbh->rollback if $oldAutoCommit;
1458 return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1462 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1467 =item credit_remaining MODE TIME
1469 Generate a credit for this package for the time remaining in the current
1470 billing period. MODE is either "suspend" or "cancel" (determines the
1471 credit type). TIME is the time of suspension/cancellation. Both arguments
1476 # Implementation note:
1478 # If you pkgpart-change a package that has been billed, and it's set to give
1479 # credit on package change, then this method gets called and then the new
1480 # package will have no last_bill date. Therefore the customer will be credited
1481 # only once (per billing period) even if there are multiple package changes.
1483 # If you location-change a package that has been billed, this method will NOT
1484 # be called and the new package WILL have the last bill date of the old
1487 # If the new package is then canceled within the same billing cycle,
1488 # credit_remaining needs to run calc_remain on the OLD package to determine
1489 # the amount of unused time to credit.
1491 sub credit_remaining {
1492 # Add a credit for remaining service
1493 my ($self, $mode, $time) = @_;
1494 die 'credit_remaining requires suspend or cancel'
1495 unless $mode eq 'suspend' or $mode eq 'cancel';
1496 die 'no suspend/cancel time' unless $time > 0;
1498 my $conf = FS::Conf->new;
1499 my $reason_type = $conf->config($mode.'_credit_type');
1501 my $last_bill = $self->getfield('last_bill') || 0;
1502 my $next_bill = $self->getfield('bill') || 0;
1503 if ( $last_bill > 0 # the package has been billed
1504 and $next_bill > 0 # the package has a next bill date
1505 and $next_bill >= $time # which is in the future
1507 my @cust_credit_source_bill_pkg = ();
1508 my $remaining_value = 0;
1510 my $remain_pkg = $self;
1511 $remaining_value = $remain_pkg->calc_remain(
1513 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1516 # we may have to walk back past some package changes to get to the
1517 # one that actually has unused time
1518 while ( $remaining_value == 0 ) {
1519 if ( $remain_pkg->change_pkgnum ) {
1520 $remain_pkg = FS::cust_pkg->by_key($remain_pkg->change_pkgnum);
1522 # the package has really never been billed
1525 $remaining_value = $remain_pkg->calc_remain(
1527 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1531 if ( $remaining_value > 0 ) {
1532 warn "Crediting for $remaining_value on package ".$self->pkgnum."\n"
1534 my $error = $self->cust_main->credit(
1536 'Credit for unused time on '. $self->part_pkg->pkg,
1537 'reason_type' => $reason_type,
1538 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1540 return "Error crediting customer \$$remaining_value for unused time".
1541 " on ". $self->part_pkg->pkg. ": $error"
1543 } #if $remaining_value
1544 } #if $last_bill, etc.
1548 =item unsuspend [ OPTION => VALUE ... ]
1550 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1551 package, then unsuspends the package itself (clears the susp field and the
1552 adjourn field if it is in the past). If the suspend reason includes an
1553 unsuspension package, that package will be ordered.
1555 Available options are:
1561 Can be set to a date to unsuspend the package in the future (the 'resume'
1564 =item adjust_next_bill
1566 Can be set true to adjust the next bill date forward by
1567 the amount of time the account was inactive. This was set true by default
1568 in the past (from 1.4.2 and 1.5.0pre6 through 1.7.0), but now needs to be
1569 explicitly requested with this option or in the price plan.
1573 If there is an error, returns the error, otherwise returns false.
1578 my( $self, %opt ) = @_;
1581 # pass all suspend/cancel actions to the main package
1582 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1583 return $self->main_pkg->unsuspend(%opt);
1586 my $oldAutoCommit = $FS::UID::AutoCommit;
1587 local $FS::UID::AutoCommit = 0;
1590 my $old = $self->select_for_update;
1592 my $pkgnum = $old->pkgnum;
1593 if ( $old->get('cancel') || $self->get('cancel') ) {
1594 $dbh->rollback if $oldAutoCommit;
1595 return "Can't unsuspend cancelled package $pkgnum";
1598 unless ( $old->get('susp') && $self->get('susp') ) {
1599 $dbh->rollback if $oldAutoCommit;
1600 return ""; # no error # complain instead?
1603 # handle the case of setting a future unsuspend (resume) date
1604 # and do not continue to actually unsuspend the package
1605 my $date = $opt{'date'};
1606 if ( $date and $date > time ) { # return an error if $date <= time?
1608 if ( $old->get('expire') && $old->get('expire') < $date ) {
1609 $dbh->rollback if $oldAutoCommit;
1610 return "Package $pkgnum expires before it would be unsuspended.";
1613 my $new = new FS::cust_pkg { $self->hash };
1614 $new->set('resume', $date);
1615 $error = $new->replace($self, options => $self->options);
1618 $dbh->rollback if $oldAutoCommit;
1622 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1628 if (!$self->setup) {
1629 # then this package is being released from on-hold status
1630 $self->set_initial_timers;
1635 foreach my $cust_svc (
1636 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1638 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1640 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1641 $dbh->rollback if $oldAutoCommit;
1642 return "Illegal svcdb value in part_svc!";
1645 require "FS/$svcdb.pm";
1647 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1649 $error = $svc->unsuspend;
1651 $dbh->rollback if $oldAutoCommit;
1654 my( $label, $value ) = $cust_svc->label;
1655 push @labels, "$label: $value";
1660 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1661 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1663 my %hash = $self->hash;
1664 my $inactive = time - $hash{'susp'};
1666 my $conf = new FS::Conf;
1668 #adjust the next bill date forward
1669 # increment next bill date if certain conditions are met:
1670 # - it was due to be billed at some point
1671 # - either the global or local config says to do this
1672 my $adjust_bill = 0;
1675 && ( $hash{'bill'} || $hash{'setup'} )
1676 && ( $opt{'adjust_next_bill'}
1677 || $conf->exists('unsuspend-always_adjust_next_bill_date')
1678 || $self->part_pkg->option('unsuspend_adjust_bill', 1)
1685 # - the package billed during suspension
1686 # - or it was ordered on hold
1687 # - or the customer was credited for the unused time
1689 if ( $self->option('suspend_bill',1)
1690 or ( $self->part_pkg->option('suspend_bill',1)
1691 and ! $self->option('no_suspend_bill',1)
1693 or $hash{'order_date'} == $hash{'susp'}
1698 if ( $adjust_bill ) {
1699 if ( $self->part_pkg->option('unused_credit_suspend')
1700 or ( ref($reason) and $reason->unused_credit ) ) {
1701 # then the customer was credited for the unused time before suspending,
1702 # so their next bill should be immediate
1703 $hash{'bill'} = time;
1705 # add the length of time suspended to the bill date
1706 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1711 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1712 $hash{'resume'} = '' if !$hash{'adjourn'};
1713 my $new = new FS::cust_pkg ( \%hash );
1714 $error = $new->replace( $self, options => { $self->options } );
1716 $dbh->rollback if $oldAutoCommit;
1722 if ( $reason && $reason->unsuspend_pkgpart ) {
1723 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
1724 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
1726 my $start_date = $self->cust_main->next_bill_date
1727 if $reason->unsuspend_hold;
1730 $unsusp_pkg = FS::cust_pkg->new({
1731 'custnum' => $self->custnum,
1732 'pkgpart' => $reason->unsuspend_pkgpart,
1733 'start_date' => $start_date,
1734 'locationnum' => $self->locationnum,
1735 # discount? probably not...
1738 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
1742 $dbh->rollback if $oldAutoCommit;
1747 if ( $conf->config('unsuspend_email_admin') ) {
1749 my $error = send_email(
1750 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1751 #invoice_from ??? well as good as any
1752 'to' => $conf->config('unsuspend_email_admin'),
1753 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
1754 "This is an automatic message from your Freeside installation\n",
1755 "informing you that the following customer package has been unsuspended:\n",
1757 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1758 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1759 ( map { "Service : $_\n" } @labels ),
1761 "An unsuspension fee was charged: ".
1762 $unsusp_pkg->part_pkg->pkg_comment."\n"
1766 'custnum' => $self->custnum,
1767 'msgtype' => 'admin',
1771 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
1777 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1778 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
1780 $dbh->rollback if $oldAutoCommit;
1781 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1785 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1792 Cancels any pending suspension (sets the adjourn field to null).
1794 If there is an error, returns the error, otherwise returns false.
1799 my( $self, %options ) = @_;
1802 my $oldAutoCommit = $FS::UID::AutoCommit;
1803 local $FS::UID::AutoCommit = 0;
1806 my $old = $self->select_for_update;
1808 my $pkgnum = $old->pkgnum;
1809 if ( $old->get('cancel') || $self->get('cancel') ) {
1810 dbh->rollback if $oldAutoCommit;
1811 return "Can't unadjourn cancelled package $pkgnum";
1812 # or at least it's pointless
1815 if ( $old->get('susp') || $self->get('susp') ) {
1816 dbh->rollback if $oldAutoCommit;
1817 return "Can't unadjourn suspended package $pkgnum";
1818 # perhaps this is arbitrary
1821 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1822 dbh->rollback if $oldAutoCommit;
1823 return ""; # no error
1826 my %hash = $self->hash;
1827 $hash{'adjourn'} = '';
1828 $hash{'resume'} = '';
1829 my $new = new FS::cust_pkg ( \%hash );
1830 $error = $new->replace( $self, options => { $self->options } );
1832 $dbh->rollback if $oldAutoCommit;
1836 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1843 =item change HASHREF | OPTION => VALUE ...
1845 Changes this package: cancels it and creates a new one, with a different
1846 pkgpart or locationnum or both. All services are transferred to the new
1847 package (no change will be made if this is not possible).
1849 Options may be passed as a list of key/value pairs or as a hash reference.
1856 New locationnum, to change the location for this package.
1860 New FS::cust_location object, to create a new location and assign it
1865 New FS::cust_main object, to create a new customer and assign the new package
1870 New pkgpart (see L<FS::part_pkg>).
1874 New refnum (see L<FS::part_referral>).
1878 New quantity; if unspecified, the new package will have the same quantity
1883 "New" (existing) FS::cust_pkg object. The package's services and other
1884 attributes will be transferred to this package.
1888 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1889 susp, adjourn, cancel, expire, and contract_end) to the new package.
1891 =item unprotect_svcs
1893 Normally, change() will rollback and return an error if some services
1894 can't be transferred (also see the I<cust_pkg-change_svcpart> config option).
1895 If unprotect_svcs is true, this method will transfer as many services as
1896 it can and then unconditionally cancel the old package.
1900 At least one of locationnum, cust_location, pkgpart, refnum, cust_main, or
1901 cust_pkg must be specified (otherwise, what's the point?)
1903 Returns either the new FS::cust_pkg object or a scalar error.
1907 my $err_or_new_cust_pkg = $old_cust_pkg->change
1911 #some false laziness w/order
1914 my $opt = ref($_[0]) ? shift : { @_ };
1916 my $conf = new FS::Conf;
1918 # Transactionize this whole mess
1919 my $oldAutoCommit = $FS::UID::AutoCommit;
1920 local $FS::UID::AutoCommit = 0;
1929 $hash{'setup'} = $time if $self->setup;
1931 $hash{'change_date'} = $time;
1932 $hash{"change_$_"} = $self->$_()
1933 foreach qw( pkgnum pkgpart locationnum );
1935 if ( $opt->{'cust_location'} ) {
1936 $error = $opt->{'cust_location'}->find_or_insert;
1938 $dbh->rollback if $oldAutoCommit;
1939 return "creating location record: $error";
1941 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1944 if ( $opt->{'cust_pkg'} ) {
1945 # treat changing to a package with a different pkgpart as a
1946 # pkgpart change (because it is)
1947 $opt->{'pkgpart'} = $opt->{'cust_pkg'}->pkgpart;
1950 # whether to override pkgpart checking on the new package
1951 my $same_pkgpart = 1;
1952 if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
1956 my $unused_credit = 0;
1957 my $keep_dates = $opt->{'keep_dates'};
1958 # Special case. If the pkgpart is changing, and the customer is
1959 # going to be credited for remaining time, don't keep setup, bill,
1960 # or last_bill dates, and DO pass the flag to cancel() to credit
1962 if ( $opt->{'pkgpart'}
1963 and $opt->{'pkgpart'} != $self->pkgpart
1964 and $self->part_pkg->option('unused_credit_change', 1) ) {
1967 $hash{$_} = '' foreach qw(setup bill last_bill);
1970 if ( $keep_dates ) {
1971 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1972 resume start_date contract_end ) ) {
1973 $hash{$date} = $self->getfield($date);
1976 # always keep this date, regardless of anything
1977 # (the date of the package change is in a different field)
1978 $hash{'order_date'} = $self->getfield('order_date');
1980 # allow $opt->{'locationnum'} = '' to specifically set it to null
1981 # (i.e. customer default location)
1982 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
1984 # usually this doesn't matter. the two cases where it does are:
1985 # 1. unused_credit_change + pkgpart change + setup fee on the new package
1987 # 2. (more importantly) changing a package before it's billed
1988 $hash{'waive_setup'} = $self->waive_setup;
1990 my $custnum = $self->custnum;
1991 if ( $opt->{cust_main} ) {
1992 my $cust_main = $opt->{cust_main};
1993 unless ( $cust_main->custnum ) {
1994 my $error = $cust_main->insert( @{ $opt->{cust_main_insert_args}||[] } );
1996 $dbh->rollback if $oldAutoCommit;
1997 return "inserting customer record: $error";
2000 $custnum = $cust_main->custnum;
2003 $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
2006 if ( $opt->{'cust_pkg'} ) {
2007 # The target package already exists; update it to show that it was
2008 # changed from this package.
2009 $cust_pkg = $opt->{'cust_pkg'};
2011 foreach ( qw( pkgnum pkgpart locationnum ) ) {
2012 $cust_pkg->set("change_$_", $self->get($_));
2014 $cust_pkg->set('change_date', $time);
2015 $error = $cust_pkg->replace;
2018 # Create the new package.
2019 $cust_pkg = new FS::cust_pkg {
2020 custnum => $custnum,
2021 locationnum => $opt->{'locationnum'},
2022 ( map { $_ => ( $opt->{$_} || $self->$_() ) }
2023 qw( pkgpart quantity refnum salesnum )
2027 $error = $cust_pkg->insert( 'change' => 1,
2028 'allow_pkgpart' => $same_pkgpart );
2031 $dbh->rollback if $oldAutoCommit;
2032 return "inserting new package: $error";
2035 # Transfer services and cancel old package.
2037 $error = $self->transfer($cust_pkg);
2038 if ($error and $error == 0) {
2039 # $old_pkg->transfer failed.
2040 $dbh->rollback if $oldAutoCommit;
2041 return "transferring $error";
2044 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2045 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2046 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
2047 if ($error and $error == 0) {
2048 # $old_pkg->transfer failed.
2049 $dbh->rollback if $oldAutoCommit;
2050 return "converting $error";
2054 # We set unprotect_svcs when executing a "future package change". It's
2055 # not a user-interactive operation, so returning an error means the
2056 # package change will just fail. Rather than have that happen, we'll
2057 # let leftover services be deleted.
2058 if ($error > 0 and !$opt->{'unprotect_svcs'}) {
2059 # Transfers were successful, but we still had services left on the old
2060 # package. We can't change the package under this circumstances, so abort.
2061 $dbh->rollback if $oldAutoCommit;
2062 return "unable to transfer all services";
2065 #reset usage if changing pkgpart
2066 # AND usage rollover is off (otherwise adds twice, now and at package bill)
2067 if ($self->pkgpart != $cust_pkg->pkgpart) {
2068 my $part_pkg = $cust_pkg->part_pkg;
2069 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
2073 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
2076 $dbh->rollback if $oldAutoCommit;
2077 return "setting usage values: $error";
2080 # if NOT changing pkgpart, transfer any usage pools over
2081 foreach my $usage ($self->cust_pkg_usage) {
2082 $usage->set('pkgnum', $cust_pkg->pkgnum);
2083 $error = $usage->replace;
2085 $dbh->rollback if $oldAutoCommit;
2086 return "transferring usage pools: $error";
2091 # transfer usage pricing add-ons, if we're not changing pkgpart
2092 if ( $same_pkgpart ) {
2093 foreach my $old_cust_pkg_usageprice ($self->cust_pkg_usageprice) {
2094 my $new_cust_pkg_usageprice = new FS::cust_pkg_usageprice {
2095 'pkgnum' => $cust_pkg->pkgnum,
2096 'usagepricepart' => $old_cust_pkg_usageprice->usagepricepart,
2097 'quantity' => $old_cust_pkg_usageprice->quantity,
2099 $error = $new_cust_pkg_usageprice->insert;
2101 $dbh->rollback if $oldAutoCommit;
2102 return "Error transferring usage pricing add-on: $error";
2107 # transfer discounts, if we're not changing pkgpart
2108 if ( $same_pkgpart ) {
2109 foreach my $old_discount ($self->cust_pkg_discount_active) {
2110 # don't remove the old discount, we may still need to bill that package.
2111 my $new_discount = new FS::cust_pkg_discount {
2112 'pkgnum' => $cust_pkg->pkgnum,
2113 'discountnum' => $old_discount->discountnum,
2114 'months_used' => $old_discount->months_used,
2116 $error = $new_discount->insert;
2118 $dbh->rollback if $oldAutoCommit;
2119 return "transferring discounts: $error";
2124 # transfer (copy) invoice details
2125 foreach my $detail ($self->cust_pkg_detail) {
2126 my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
2127 $new_detail->set('pkgdetailnum', '');
2128 $new_detail->set('pkgnum', $cust_pkg->pkgnum);
2129 $error = $new_detail->insert;
2131 $dbh->rollback if $oldAutoCommit;
2132 return "transferring package notes: $error";
2138 if ( !$opt->{'cust_pkg'} ) {
2139 # Order any supplemental packages.
2140 my $part_pkg = $cust_pkg->part_pkg;
2141 my @old_supp_pkgs = $self->supplemental_pkgs;
2142 foreach my $link ($part_pkg->supp_part_pkg_link) {
2144 foreach (@old_supp_pkgs) {
2145 if ($_->pkgpart == $link->dst_pkgpart) {
2147 $_->pkgpart(0); # so that it can't match more than once
2151 # false laziness with FS::cust_main::Packages::order_pkg
2152 my $new = FS::cust_pkg->new({
2153 pkgpart => $link->dst_pkgpart,
2154 pkglinknum => $link->pkglinknum,
2155 custnum => $custnum,
2156 main_pkgnum => $cust_pkg->pkgnum,
2157 locationnum => $cust_pkg->locationnum,
2158 start_date => $cust_pkg->start_date,
2159 order_date => $cust_pkg->order_date,
2160 expire => $cust_pkg->expire,
2161 adjourn => $cust_pkg->adjourn,
2162 contract_end => $cust_pkg->contract_end,
2163 refnum => $cust_pkg->refnum,
2164 discountnum => $cust_pkg->discountnum,
2165 waive_setup => $cust_pkg->waive_setup,
2167 if ( $old and $opt->{'keep_dates'} ) {
2168 foreach (qw(setup bill last_bill)) {
2169 $new->set($_, $old->get($_));
2172 $error = $new->insert( allow_pkgpart => $same_pkgpart );
2175 $error ||= $old->transfer($new);
2177 if ( $error and $error > 0 ) {
2178 # no reason why this should ever fail, but still...
2179 $error = "Unable to transfer all services from supplemental package ".
2183 $dbh->rollback if $oldAutoCommit;
2186 push @new_supp_pkgs, $new;
2188 } # if !$opt->{'cust_pkg'}
2189 # because if there is one, then supplemental packages would already
2190 # have been created for it.
2192 #Good to go, cancel old package. Notify 'cancel' of whether to credit
2194 #Don't allow billing the package (preceding period packages and/or
2195 #outstanding usage) if we are keeping dates (i.e. location changing),
2196 #because the new package will be billed for the same date range.
2197 #Supplemental packages are also canceled here.
2199 # during scheduled changes, avoid canceling the package we just
2201 $self->set('change_to_pkgnum' => '');
2203 $error = $self->cancel(
2205 unused_credit => $unused_credit,
2206 nobill => $keep_dates,
2207 change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2208 no_delay_cancel => 1,
2211 $dbh->rollback if $oldAutoCommit;
2212 return "canceling old package: $error";
2215 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2217 my $error = $cust_pkg->cust_main->bill(
2218 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2221 $dbh->rollback if $oldAutoCommit;
2222 return "billing new package: $error";
2226 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2232 =item change_later OPTION => VALUE...
2234 Schedule a package change for a later date. This actually orders the new
2235 package immediately, but sets its start date for a future date, and sets
2236 the current package to expire on the same date.
2238 If the package is already scheduled for a change, this can be called with
2239 'start_date' to change the scheduled date, or with pkgpart and/or
2240 locationnum to modify the package change. To cancel the scheduled change
2241 entirely, see C<abort_change>.
2249 The date for the package change. Required, and must be in the future.
2257 The pkgpart. locationnum, and quantity of the new package, with the same
2258 meaning as in C<change>.
2266 my $opt = ref($_[0]) ? shift : { @_ };
2268 my $oldAutoCommit = $FS::UID::AutoCommit;
2269 local $FS::UID::AutoCommit = 0;
2272 my $cust_main = $self->cust_main;
2274 my $date = delete $opt->{'start_date'} or return 'start_date required';
2276 if ( $date <= time ) {
2277 $dbh->rollback if $oldAutoCommit;
2278 return "start_date $date is in the past";
2283 if ( $self->change_to_pkgnum ) {
2284 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
2285 my $new_pkgpart = $opt->{'pkgpart'}
2286 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $change_to->pkgpart;
2287 my $new_locationnum = $opt->{'locationnum'}
2288 if $opt->{'locationnum'} and $opt->{'locationnum'} != $change_to->locationnum;
2289 my $new_quantity = $opt->{'quantity'}
2290 if $opt->{'quantity'} and $opt->{'quantity'} != $change_to->quantity;
2291 if ( $new_pkgpart or $new_locationnum or $new_quantity ) {
2292 # it hasn't been billed yet, so in principle we could just edit
2293 # it in place (w/o a package change), but that's bad form.
2294 # So change the package according to the new options...
2295 my $err_or_pkg = $change_to->change(%$opt);
2296 if ( ref $err_or_pkg ) {
2297 # Then set that package up for a future start.
2298 $self->set('change_to_pkgnum', $err_or_pkg->pkgnum);
2299 $self->set('expire', $date); # in case it's different
2300 $err_or_pkg->set('start_date', $date);
2301 $err_or_pkg->set('change_date', '');
2302 $err_or_pkg->set('change_pkgnum', '');
2304 $error = $self->replace ||
2305 $err_or_pkg->replace ||
2306 $change_to->cancel('no_delay_cancel' => 1) ||
2309 $error = $err_or_pkg;
2311 } else { # change the start date only.
2312 $self->set('expire', $date);
2313 $change_to->set('start_date', $date);
2314 $error = $self->replace || $change_to->replace;
2317 $dbh->rollback if $oldAutoCommit;
2320 $dbh->commit if $oldAutoCommit;
2323 } # if $self->change_to_pkgnum
2325 my $new_pkgpart = $opt->{'pkgpart'}
2326 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2327 my $new_locationnum = $opt->{'locationnum'}
2328 if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2329 my $new_quantity = $opt->{'quantity'}
2330 if $opt->{'quantity'} and $opt->{'quantity'} != $self->quantity;
2332 return '' unless $new_pkgpart or $new_locationnum or $new_quantity; # wouldn't do anything
2334 # allow $opt->{'locationnum'} = '' to specifically set it to null
2335 # (i.e. customer default location)
2336 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2338 my $new = FS::cust_pkg->new( {
2339 custnum => $self->custnum,
2340 locationnum => $opt->{'locationnum'},
2341 start_date => $date,
2342 map { $_ => ( $opt->{$_} || $self->$_() ) }
2343 qw( pkgpart quantity refnum salesnum )
2345 $error = $new->insert('change' => 1,
2346 'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2348 $self->set('change_to_pkgnum', $new->pkgnum);
2349 $self->set('expire', $date);
2350 $error = $self->replace;
2353 $dbh->rollback if $oldAutoCommit;
2355 $dbh->commit if $oldAutoCommit;
2363 Cancels a future package change scheduled by C<change_later>.
2369 my $pkgnum = $self->change_to_pkgnum;
2370 my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
2373 $error = $change_to->cancel || $change_to->delete;
2374 return $error if $error;
2376 $self->set('change_to_pkgnum', '');
2377 $self->set('expire', '');
2381 =item set_quantity QUANTITY
2383 Change the package's quantity field. This is one of the few package properties
2384 that can safely be changed without canceling and reordering the package
2385 (because it doesn't affect tax eligibility). Returns an error or an
2392 $self = $self->replace_old; # just to make sure
2393 $self->quantity(shift);
2397 =item set_salesnum SALESNUM
2399 Change the package's salesnum (sales person) field. This is one of the few
2400 package properties that can safely be changed without canceling and reordering
2401 the package (because it doesn't affect tax eligibility). Returns an error or
2408 $self = $self->replace_old; # just to make sure
2409 $self->salesnum(shift);
2411 # XXX this should probably reassign any credit that's already been given
2414 =item modify_charge OPTIONS
2416 Change the properties of a one-time charge. The following properties can
2417 be changed this way:
2418 - pkg: the package description
2419 - classnum: the package class
2420 - additional: arrayref of additional invoice details to add to this package
2422 and, I<if the charge has not yet been billed>:
2423 - start_date: the date when it will be billed
2424 - amount: the setup fee to be charged
2425 - quantity: the multiplier for the setup fee
2426 - separate_bill: whether to put the charge on a separate invoice
2428 If you pass 'adjust_commission' => 1, and the classnum changes, and there are
2429 commission credits linked to this charge, they will be recalculated.
2436 my $part_pkg = $self->part_pkg;
2437 my $pkgnum = $self->pkgnum;
2440 my $oldAutoCommit = $FS::UID::AutoCommit;
2441 local $FS::UID::AutoCommit = 0;
2443 return "Can't use modify_charge except on one-time charges"
2444 unless $part_pkg->freq eq '0';
2446 if ( length($opt{'pkg'}) and $part_pkg->pkg ne $opt{'pkg'} ) {
2447 $part_pkg->set('pkg', $opt{'pkg'});
2450 my %pkg_opt = $part_pkg->options;
2451 my $pkg_opt_modified = 0;
2453 $opt{'additional'} ||= [];
2456 foreach (grep /^additional/, keys %pkg_opt) {
2457 ($i) = ($_ =~ /^additional_info(\d+)$/);
2458 $old_additional[$i] = $pkg_opt{$_} if $i;
2459 delete $pkg_opt{$_};
2462 for ( $i = 0; exists($opt{'additional'}->[$i]); $i++ ) {
2463 $pkg_opt{ "additional_info$i" } = $opt{'additional'}->[$i];
2464 if (!exists($old_additional[$i])
2465 or $old_additional[$i] ne $opt{'additional'}->[$i])
2467 $pkg_opt_modified = 1;
2470 $pkg_opt_modified = 1 if (scalar(@old_additional) - 1) != $i;
2471 $pkg_opt{'additional_count'} = $i if $i > 0;
2474 if ( exists($opt{'classnum'}) and $part_pkg->classnum ne $opt{'classnum'} )
2477 $old_classnum = $part_pkg->classnum;
2478 $part_pkg->set('classnum', $opt{'classnum'});
2481 if ( !$self->get('setup') ) {
2482 # not yet billed, so allow amount, setup_cost, quantity, start_date,
2485 if ( exists($opt{'amount'})
2486 and $part_pkg->option('setup_fee') != $opt{'amount'}
2487 and $opt{'amount'} > 0 ) {
2489 $pkg_opt{'setup_fee'} = $opt{'amount'};
2490 $pkg_opt_modified = 1;
2493 if ( exists($opt{'setup_cost'})
2494 and $part_pkg->setup_cost != $opt{'setup_cost'}
2495 and $opt{'setup_cost'} > 0 ) {
2497 $part_pkg->set('setup_cost', $opt{'setup_cost'});
2500 if ( exists($opt{'quantity'})
2501 and $opt{'quantity'} != $self->quantity
2502 and $opt{'quantity'} > 0 ) {
2504 $self->set('quantity', $opt{'quantity'});
2507 if ( exists($opt{'start_date'})
2508 and $opt{'start_date'} != $self->start_date ) {
2510 $self->set('start_date', $opt{'start_date'});
2513 if ( exists($opt{'separate_bill'})
2514 and $opt{'separate_bill'} ne $self->separate_bill ) {
2516 $self->set('separate_bill', $opt{'separate_bill'});
2520 } # else simply ignore them; the UI shouldn't allow editing the fields
2523 if ( exists($opt{'taxclass'})
2524 and $part_pkg->taxclass ne $opt{'taxclass'}) {
2526 $part_pkg->set('taxclass', $opt{'taxclass'});
2530 if ( $part_pkg->modified or $pkg_opt_modified ) {
2531 # can we safely modify the package def?
2532 # Yes, if it's not available for purchase, and this is the only instance
2534 if ( $part_pkg->disabled
2535 and FS::cust_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 1
2536 and FS::quotation_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 0
2538 $error = $part_pkg->replace( options => \%pkg_opt );
2541 $part_pkg = $part_pkg->clone;
2542 $part_pkg->set('disabled' => 'Y');
2543 $error = $part_pkg->insert( options => \%pkg_opt );
2544 # and associate this as yet-unbilled package to the new package def
2545 $self->set('pkgpart' => $part_pkg->pkgpart);
2548 $dbh->rollback if $oldAutoCommit;
2553 if ($self->modified) { # for quantity or start_date change, or if we had
2554 # to clone the existing package def
2555 my $error = $self->replace;
2556 return $error if $error;
2558 if (defined $old_classnum) {
2559 # fix invoice grouping records
2560 my $old_catname = $old_classnum
2561 ? FS::pkg_class->by_key($old_classnum)->categoryname
2563 my $new_catname = $opt{'classnum'}
2564 ? $part_pkg->pkg_class->categoryname
2566 if ( $old_catname ne $new_catname ) {
2567 foreach my $cust_bill_pkg ($self->cust_bill_pkg) {
2568 # (there should only be one...)
2569 my @display = qsearch( 'cust_bill_pkg_display', {
2570 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2571 'section' => $old_catname,
2573 foreach (@display) {
2574 $_->set('section', $new_catname);
2575 $error = $_->replace;
2577 $dbh->rollback if $oldAutoCommit;
2581 } # foreach $cust_bill_pkg
2584 if ( $opt{'adjust_commission'} ) {
2585 # fix commission credits...tricky.
2586 foreach my $cust_event ($self->cust_event) {
2587 my $part_event = $cust_event->part_event;
2588 foreach my $table (qw(sales agent)) {
2590 "FS::part_event::Action::Mixin::credit_${table}_pkg_class";
2591 my $credit = qsearchs('cust_credit', {
2592 'eventnum' => $cust_event->eventnum,
2594 if ( $part_event->isa($class) ) {
2595 # Yes, this results in current commission rates being applied
2596 # retroactively to a one-time charge. For accounting purposes
2597 # there ought to be some kind of time limit on doing this.
2598 my $amount = $part_event->_calc_credit($self);
2599 if ( $credit and $credit->amount ne $amount ) {
2600 # Void the old credit.
2601 $error = $credit->void('Package class changed');
2603 $dbh->rollback if $oldAutoCommit;
2604 return "$error (adjusting commission credit)";
2607 # redo the event action to recreate the credit.
2609 eval { $part_event->do_action( $self, $cust_event ) };
2611 $dbh->rollback if $oldAutoCommit;
2614 } # if $part_event->isa($class)
2616 } # foreach $cust_event
2617 } # if $opt{'adjust_commission'}
2618 } # if defined $old_classnum
2620 $dbh->commit if $oldAutoCommit;
2627 sub process_bulk_cust_pkg {
2630 warn Dumper($param) if $DEBUG;
2632 my $old_part_pkg = qsearchs('part_pkg',
2633 { pkgpart => $param->{'old_pkgpart'} });
2634 my $new_part_pkg = qsearchs('part_pkg',
2635 { pkgpart => $param->{'new_pkgpart'} });
2636 die "Must select a new package type\n" unless $new_part_pkg;
2637 #my $keep_dates = $param->{'keep_dates'} || 0;
2638 my $keep_dates = 1; # there is no good reason to turn this off
2640 my $oldAutoCommit = $FS::UID::AutoCommit;
2641 local $FS::UID::AutoCommit = 0;
2644 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
2647 foreach my $old_cust_pkg ( @cust_pkgs ) {
2649 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
2650 if ( $old_cust_pkg->getfield('cancel') ) {
2651 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
2652 $old_cust_pkg->pkgnum."\n"
2656 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
2658 my $error = $old_cust_pkg->change(
2659 'pkgpart' => $param->{'new_pkgpart'},
2660 'keep_dates' => $keep_dates
2662 if ( !ref($error) ) { # change returns the cust_pkg on success
2664 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
2667 $dbh->commit if $oldAutoCommit;
2673 Returns the last bill date, or if there is no last bill date, the setup date.
2674 Useful for billing metered services.
2680 return $self->setfield('last_bill', $_[0]) if @_;
2681 return $self->getfield('last_bill') if $self->getfield('last_bill');
2682 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
2683 'edate' => $self->bill, } );
2684 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
2687 =item last_cust_pkg_reason ACTION
2689 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
2690 Returns false if there is no reason or the package is not currenly ACTION'd
2691 ACTION is one of adjourn, susp, cancel, or expire.
2695 sub last_cust_pkg_reason {
2696 my ( $self, $action ) = ( shift, shift );
2697 my $date = $self->get($action);
2699 'table' => 'cust_pkg_reason',
2700 'hashref' => { 'pkgnum' => $self->pkgnum,
2701 'action' => substr(uc($action), 0, 1),
2704 'order_by' => 'ORDER BY num DESC LIMIT 1',
2708 =item last_reason ACTION
2710 Returns the most recent ACTION FS::reason associated with the package.
2711 Returns false if there is no reason or the package is not currenly ACTION'd
2712 ACTION is one of adjourn, susp, cancel, or expire.
2717 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
2718 $cust_pkg_reason->reason
2719 if $cust_pkg_reason;
2724 Returns the definition for this billing item, as an FS::part_pkg object (see
2731 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
2732 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
2733 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
2738 Returns the cancelled package this package was changed from, if any.
2744 return '' unless $self->change_pkgnum;
2745 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
2748 =item change_cust_main
2750 Returns the customter this package was detached to, if any.
2754 sub change_cust_main {
2756 return '' unless $self->change_custnum;
2757 qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
2762 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
2769 $self->part_pkg->calc_setup($self, @_);
2774 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
2781 $self->part_pkg->calc_recur($self, @_);
2786 Calls the I<base_setup> of the FS::part_pkg object associated with this billing
2793 $self->part_pkg->base_setup($self, @_);
2798 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
2805 $self->part_pkg->base_recur($self, @_);
2810 Calls the I<calc_remain> of the FS::part_pkg object associated with this
2817 $self->part_pkg->calc_remain($self, @_);
2822 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
2829 $self->part_pkg->calc_cancel($self, @_);
2834 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
2840 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
2843 =item cust_pkg_detail [ DETAILTYPE ]
2845 Returns any customer package details for this package (see
2846 L<FS::cust_pkg_detail>).
2848 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2852 sub cust_pkg_detail {
2854 my %hash = ( 'pkgnum' => $self->pkgnum );
2855 $hash{detailtype} = shift if @_;
2857 'table' => 'cust_pkg_detail',
2858 'hashref' => \%hash,
2859 'order_by' => 'ORDER BY weight, pkgdetailnum',
2863 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
2865 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
2867 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2869 If there is an error, returns the error, otherwise returns false.
2873 sub set_cust_pkg_detail {
2874 my( $self, $detailtype, @details ) = @_;
2876 my $oldAutoCommit = $FS::UID::AutoCommit;
2877 local $FS::UID::AutoCommit = 0;
2880 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
2881 my $error = $current->delete;
2883 $dbh->rollback if $oldAutoCommit;
2884 return "error removing old detail: $error";
2888 foreach my $detail ( @details ) {
2889 my $cust_pkg_detail = new FS::cust_pkg_detail {
2890 'pkgnum' => $self->pkgnum,
2891 'detailtype' => $detailtype,
2892 'detail' => $detail,
2894 my $error = $cust_pkg_detail->insert;
2896 $dbh->rollback if $oldAutoCommit;
2897 return "error adding new detail: $error";
2902 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2909 Returns the customer billing events (see L<FS::cust_event>) for this invoice.
2913 #false laziness w/cust_bill.pm
2917 'table' => 'cust_event',
2918 'addl_from' => 'JOIN part_event USING ( eventpart )',
2919 'hashref' => { 'tablenum' => $self->pkgnum },
2920 'extra_sql' => " AND eventtable = 'cust_pkg' ",
2924 =item num_cust_event
2926 Returns the number of customer billing events (see L<FS::cust_event>) for this package.
2930 #false laziness w/cust_bill.pm
2931 sub num_cust_event {
2933 my $sql = "SELECT COUNT(*) ". $self->_from_cust_event_where;
2934 $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref->[0];
2937 =item exists_cust_event
2939 Returns true if there are customer billing events (see L<FS::cust_event>) for this package. More efficient than using num_cust_event.
2943 sub exists_cust_event {
2945 my $sql = "SELECT 1 ". $self->_from_cust_event_where. " LIMIT 1";
2946 my $row = $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref;
2947 $row ? $row->[0] : '';
2950 sub _from_cust_event_where {
2952 " FROM cust_event JOIN part_event USING ( eventpart ) ".
2953 " WHERE tablenum = ? AND eventtable = 'cust_pkg' ";
2957 my( $self, $sql, @args ) = @_;
2958 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
2959 $sth->execute(@args) or die $sth->errstr. " executing $sql";
2963 =item part_pkg_currency_option OPTIONNAME
2965 Returns a two item list consisting of the currency of this customer, if any,
2966 and a value for the provided option. If the customer has a currency, the value
2967 is the option value the given name and the currency (see
2968 L<FS::part_pkg_currency>). Otherwise, if the customer has no currency, is the
2969 regular option value for the given name (see L<FS::part_pkg_option>).
2973 sub part_pkg_currency_option {
2974 my( $self, $optionname ) = @_;
2975 my $part_pkg = $self->part_pkg;
2976 if ( my $currency = $self->cust_main->currency ) {
2977 ($currency, $part_pkg->part_pkg_currency_option($currency, $optionname) );
2979 ('', $part_pkg->option($optionname) );
2983 =item cust_svc [ SVCPART ] (old, deprecated usage)
2985 =item cust_svc [ OPTION => VALUE ... ] (current usage)
2987 =item cust_svc_unsorted [ OPTION => VALUE ... ]
2989 Returns the services for this package, as FS::cust_svc objects (see
2990 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
2991 spcififed, returns only the matching services.
2993 As an optimization, use the cust_svc_unsorted version if you are not displaying
3000 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
3001 $self->_sort_cust_svc( $self->cust_svc_unsorted_arrayref(@_) );
3004 sub cust_svc_unsorted {
3006 @{ $self->cust_svc_unsorted_arrayref(@_) };
3009 sub cust_svc_unsorted_arrayref {
3012 return [] unless $self->num_cust_svc(@_);
3015 if ( @_ && $_[0] =~ /^\d+/ ) {
3016 $opt{svcpart} = shift;
3017 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3024 'table' => 'cust_svc',
3025 'hashref' => { 'pkgnum' => $self->pkgnum },
3027 if ( $opt{svcpart} ) {
3028 $search{hashref}->{svcpart} = $opt{'svcpart'};
3030 if ( $opt{'svcdb'} ) {
3031 $search{addl_from} = ' LEFT JOIN part_svc USING ( svcpart ) ';
3032 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{'svcdb'} );
3035 [ qsearch(\%search) ];
3039 =item overlimit [ SVCPART ]
3041 Returns the services for this package which have exceeded their
3042 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
3043 is specified, return only the matching services.
3049 return () unless $self->num_cust_svc(@_);
3050 grep { $_->overlimit } $self->cust_svc(@_);
3053 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3055 Returns historical services for this package created before END TIMESTAMP and
3056 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
3057 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
3058 I<pkg_svc.hidden> flag will be omitted.
3064 warn "$me _h_cust_svc called on $self\n"
3067 my ($end, $start, $mode) = @_;
3069 local($FS::Record::qsearch_qualify_columns) = 0;
3071 my @cust_svc = $self->_sort_cust_svc(
3072 [ qsearch( 'h_cust_svc',
3073 { 'pkgnum' => $self->pkgnum, },
3074 FS::h_cust_svc->sql_h_search(@_),
3078 if ( defined($mode) && $mode eq 'I' ) {
3079 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
3080 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
3086 sub _sort_cust_svc {
3087 my( $self, $arrayref ) = @_;
3090 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
3092 my %pkg_svc = map { $_->svcpart => $_ }
3093 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
3098 my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
3100 $pkg_svc ? $pkg_svc->primary_svc : '',
3101 $pkg_svc ? $pkg_svc->quantity : 0,
3108 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
3110 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
3112 Returns the number of services for this package. Available options are svcpart
3113 and svcdb. If either is spcififed, returns only the matching services.
3120 return $self->{'_num_cust_svc'}
3122 && exists($self->{'_num_cust_svc'})
3123 && $self->{'_num_cust_svc'} =~ /\d/;
3125 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
3129 if ( @_ && $_[0] =~ /^\d+/ ) {
3130 $opt{svcpart} = shift;
3131 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3137 my $select = 'SELECT COUNT(*) FROM cust_svc ';
3138 my $where = ' WHERE pkgnum = ? ';
3139 my @param = ($self->pkgnum);
3141 if ( $opt{'svcpart'} ) {
3142 $where .= ' AND svcpart = ? ';
3143 push @param, $opt{'svcpart'};
3145 if ( $opt{'svcdb'} ) {
3146 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
3147 $where .= ' AND svcdb = ? ';
3148 push @param, $opt{'svcdb'};
3151 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
3152 $sth->execute(@param) or die $sth->errstr;
3153 $sth->fetchrow_arrayref->[0];
3156 =item available_part_svc
3158 Returns a list of FS::part_svc objects representing services included in this
3159 package but not yet provisioned. Each FS::part_svc object also has an extra
3160 field, I<num_avail>, which specifies the number of available services.
3164 sub available_part_svc {
3167 my $pkg_quantity = $self->quantity || 1;
3169 grep { $_->num_avail > 0 }
3171 my $part_svc = $_->part_svc;
3172 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
3173 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
3175 # more evil encapsulation breakage
3176 if($part_svc->{'Hash'}{'num_avail'} > 0) {
3177 my @exports = $part_svc->part_export_did;
3178 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
3183 $self->part_pkg->pkg_svc;
3186 =item part_svc [ OPTION => VALUE ... ]
3188 Returns a list of FS::part_svc objects representing provisioned and available
3189 services included in this package. Each FS::part_svc object also has the
3190 following extra fields:
3204 (services) - array reference containing the provisioned services, as cust_svc objects
3208 Accepts two options:
3212 =item summarize_size
3214 If true, will omit the extra cust_pkg_svc option for objects where num_cust_svc
3215 is this size or greater.
3217 =item hide_discontinued
3219 If true, will omit looking for services that are no longer avaialble in the
3227 #label -> ($cust_svc->label)[1]
3233 my $pkg_quantity = $self->quantity || 1;
3235 #XXX some sort of sort order besides numeric by svcpart...
3236 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
3238 my $part_svc = $pkg_svc->part_svc;
3239 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3240 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
3241 $part_svc->{'Hash'}{'num_avail'} =
3242 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
3243 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3244 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
3245 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
3246 && $num_cust_svc >= $opt{summarize_size};
3247 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
3249 } $self->part_pkg->pkg_svc;
3251 unless ( $opt{hide_discontinued} ) {
3253 push @part_svc, map {
3255 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3256 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
3257 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
3258 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3259 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
3261 } $self->extra_part_svc;
3268 =item extra_part_svc
3270 Returns a list of FS::part_svc objects corresponding to services in this
3271 package which are still provisioned but not (any longer) available in the
3276 sub extra_part_svc {
3279 my $pkgnum = $self->pkgnum;
3280 #my $pkgpart = $self->pkgpart;
3283 # 'table' => 'part_svc',
3286 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
3287 # WHERE pkg_svc.svcpart = part_svc.svcpart
3288 # AND pkg_svc.pkgpart = ?
3291 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
3292 # LEFT JOIN cust_pkg USING ( pkgnum )
3293 # WHERE cust_svc.svcpart = part_svc.svcpart
3296 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
3299 #seems to benchmark slightly faster... (or did?)
3301 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
3302 my $pkgparts = join(',', @pkgparts);
3305 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
3306 #MySQL doesn't grok DISINCT ON
3307 'select' => 'DISTINCT part_svc.*',
3308 'table' => 'part_svc',
3310 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
3311 AND pkg_svc.pkgpart IN ($pkgparts)
3314 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
3315 LEFT JOIN cust_pkg USING ( pkgnum )
3318 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
3319 'extra_param' => [ [$self->pkgnum=>'int'] ],
3325 Returns a short status string for this package, currently:
3331 =item not yet billed
3333 =item one-time charge
3348 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
3350 return 'cancelled' if $self->get('cancel');
3351 return 'on hold' if $self->susp && ! $self->setup;
3352 return 'suspended' if $self->susp;
3353 return 'not yet billed' unless $self->setup;
3354 return 'one-time charge' if $freq =~ /^(0|$)/;
3358 =item ucfirst_status
3360 Returns the status with the first character capitalized.
3364 sub ucfirst_status {
3365 ucfirst(shift->status);
3370 Class method that returns the list of possible status strings for packages
3371 (see L<the status method|/status>). For example:
3373 @statuses = FS::cust_pkg->statuses();
3377 tie my %statuscolor, 'Tie::IxHash',
3378 'on hold' => 'FF00F5', #brighter purple!
3379 'not yet billed' => '009999', #teal? cyan?
3380 'one-time charge' => '0000CC', #blue #'000000',
3381 'active' => '00CC00',
3382 'suspended' => 'FF9900',
3383 'cancelled' => 'FF0000',
3387 my $self = shift; #could be class...
3388 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
3389 # # mayble split btw one-time vs. recur
3400 Returns a hex triplet color string for this package's status.
3406 $statuscolor{$self->status};
3409 =item is_status_delay_cancel
3411 Returns true if part_pkg has option delay_cancel,
3412 cust_pkg status is 'suspended' and expire is set
3413 to cancel package within the next day (or however
3414 many days are set in global config part_pkg-delay_cancel-days.
3416 This is not a real status, this only meant for hacking display
3417 values, because otherwise treating the package as suspended is
3418 really the whole point of the delay_cancel option.
3422 sub is_status_delay_cancel {
3424 if ( $self->main_pkgnum and $self->pkglinknum ) {
3425 return $self->main_pkg->is_status_delay_cancel;
3427 return 0 unless $self->part_pkg->option('delay_cancel',1);
3428 return 0 unless $self->status eq 'suspended';
3429 return 0 unless $self->expire;
3430 my $conf = new FS::Conf;
3431 my $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
3432 my $expsecs = 60*60*24*$expdays;
3433 return 0 unless $self->expire < time + $expsecs;
3439 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
3440 "pkg - comment" depending on user preference).
3446 my $label = $self->part_pkg->pkg_comment( cust_pkg=>$self, nopkgpart=>1 );
3447 $label = $self->pkgnum. ": $label"
3448 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
3452 =item pkg_label_long
3454 Returns a long label for this package, adding the primary service's label to
3459 sub pkg_label_long {
3461 my $label = $self->pkg_label;
3462 my $cust_svc = $self->primary_cust_svc;
3463 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
3469 Returns a customer-localized label for this package.
3475 $self->part_pkg->pkg_locale( $self->cust_main->locale );
3478 =item primary_cust_svc
3480 Returns a primary service (as FS::cust_svc object) if one can be identified.
3484 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
3486 sub primary_cust_svc {
3489 my @cust_svc = $self->cust_svc;
3491 return '' unless @cust_svc; #no serivces - irrelevant then
3493 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
3495 # primary service as specified in the package definition
3496 # or exactly one service definition with quantity one
3497 my $svcpart = $self->part_pkg->svcpart;
3498 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
3499 return $cust_svc[0] if scalar(@cust_svc) == 1;
3501 #couldn't identify one thing..
3507 Returns a list of lists, calling the label method for all services
3508 (see L<FS::cust_svc>) of this billing item.
3514 map { [ $_->label ] } $self->cust_svc;
3517 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3519 Like the labels method, but returns historical information on services that
3520 were active as of END_TIMESTAMP and (optionally) not cancelled before
3521 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
3522 I<pkg_svc.hidden> flag will be omitted.
3524 Returns a list of lists, calling the label method for all (historical) services
3525 (see L<FS::h_cust_svc>) of this billing item.
3531 warn "$me _h_labels called on $self\n"
3533 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
3538 Like labels, except returns a simple flat list, and shortens long
3539 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3540 identical services to one line that lists the service label and the number of
3541 individual services rather than individual items.
3546 shift->_labels_short( 'labels', @_ );
3549 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
3551 Like h_labels, except returns a simple flat list, and shortens long
3552 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3553 identical services to one line that lists the service label and the number of
3554 individual services rather than individual items.
3558 sub h_labels_short {
3559 shift->_labels_short( 'h_labels', @_ );
3563 my( $self, $method ) = ( shift, shift );
3565 warn "$me _labels_short called on $self with $method method\n"
3568 my $conf = new FS::Conf;
3569 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
3571 warn "$me _labels_short populating \%labels\n"
3575 #tie %labels, 'Tie::IxHash';
3576 push @{ $labels{$_->[0]} }, $_->[1]
3577 foreach $self->$method(@_);
3579 warn "$me _labels_short populating \@labels\n"
3583 foreach my $label ( keys %labels ) {
3585 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
3586 my $num = scalar(@values);
3587 warn "$me _labels_short $num items for $label\n"
3590 if ( $num > $max_same_services ) {
3591 warn "$me _labels_short more than $max_same_services, so summarizing\n"
3593 push @labels, "$label ($num)";
3595 if ( $conf->exists('cust_bill-consolidate_services') ) {
3596 warn "$me _labels_short consolidating services\n"
3598 # push @labels, "$label: ". join(', ', @values);
3600 my $detail = "$label: ";
3601 $detail .= shift(@values). ', '
3603 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
3605 push @labels, $detail;
3607 warn "$me _labels_short done consolidating services\n"
3610 warn "$me _labels_short adding service data\n"
3612 push @labels, map { "$label: $_" } @values;
3623 Returns the parent customer object (see L<FS::cust_main>).
3627 Returns the balance for this specific package, when using
3628 experimental package balance.
3634 $self->cust_main->balance_pkgnum( $self->pkgnum );
3637 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
3641 Returns the location object, if any (see L<FS::cust_location>).
3643 =item cust_location_or_main
3645 If this package is associated with a location, returns the locaiton (see
3646 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
3648 =item location_label [ OPTION => VALUE ... ]
3650 Returns the label of the location object (see L<FS::cust_location>).
3654 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
3656 =item tax_locationnum
3658 Returns the foreign key to a L<FS::cust_location> object for calculating
3659 tax on this package, as determined by the C<tax-pkg_address> and
3660 C<tax-ship_address> configuration flags.
3664 sub tax_locationnum {
3666 my $conf = FS::Conf->new;
3667 if ( $conf->exists('tax-pkg_address') ) {
3668 return $self->locationnum;
3670 elsif ( $conf->exists('tax-ship_address') ) {
3671 return $self->cust_main->ship_locationnum;
3674 return $self->cust_main->bill_locationnum;
3680 Returns the L<FS::cust_location> object for tax_locationnum.
3686 my $conf = FS::Conf->new;
3687 if ( $conf->exists('tax-pkg_address') and $self->locationnum ) {
3688 return FS::cust_location->by_key($self->locationnum);
3690 elsif ( $conf->exists('tax-ship_address') ) {
3691 return $self->cust_main->ship_location;
3694 return $self->cust_main->bill_location;
3698 =item seconds_since TIMESTAMP
3700 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
3701 package have been online since TIMESTAMP, according to the session monitor.
3703 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
3704 L<Time::Local> and L<Date::Parse> for conversion functions.
3709 my($self, $since) = @_;
3712 foreach my $cust_svc (
3713 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
3715 $seconds += $cust_svc->seconds_since($since);
3722 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
3724 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
3725 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
3728 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3729 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3735 sub seconds_since_sqlradacct {
3736 my($self, $start, $end) = @_;
3740 foreach my $cust_svc (
3742 my $part_svc = $_->part_svc;
3743 $part_svc->svcdb eq 'svc_acct'
3744 && scalar($part_svc->part_export_usage);
3747 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
3754 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
3756 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
3757 in this package for sessions ending between TIMESTAMP_START (inclusive) and
3761 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3762 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3767 sub attribute_since_sqlradacct {
3768 my($self, $start, $end, $attrib) = @_;
3772 foreach my $cust_svc (
3774 my $part_svc = $_->part_svc;
3775 scalar($part_svc->part_export_usage);
3778 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
3790 my( $self, $value ) = @_;
3791 if ( defined($value) ) {
3792 $self->setfield('quantity', $value);
3794 $self->getfield('quantity') || 1;
3797 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
3799 Transfers as many services as possible from this package to another package.
3801 The destination package can be specified by pkgnum by passing an FS::cust_pkg
3802 object. The destination package must already exist.
3804 Services are moved only if the destination allows services with the correct
3805 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
3806 this option with caution! No provision is made for export differences
3807 between the old and new service definitions. Probably only should be used
3808 when your exports for all service definitions of a given svcdb are identical.
3809 (attempt a transfer without it first, to move all possible svcpart-matching
3812 Any services that can't be moved remain in the original package.
3814 Returns an error, if there is one; otherwise, returns the number of services
3815 that couldn't be moved.
3820 my ($self, $dest_pkgnum, %opt) = @_;
3826 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
3827 $dest = $dest_pkgnum;
3828 $dest_pkgnum = $dest->pkgnum;
3830 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
3833 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
3835 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
3836 $target{$pkg_svc->svcpart} = $pkg_svc->quantity * ( $dest->quantity || 1 );
3839 foreach my $cust_svc ($dest->cust_svc) {
3840 $target{$cust_svc->svcpart}--;
3843 my %svcpart2svcparts = ();
3844 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3845 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
3846 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
3847 next if exists $svcpart2svcparts{$svcpart};
3848 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
3849 $svcpart2svcparts{$svcpart} = [
3851 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
3853 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
3854 'svcpart' => $_ } );
3856 $pkg_svc ? $pkg_svc->primary_svc : '',
3857 $pkg_svc ? $pkg_svc->quantity : 0,
3861 grep { $_ != $svcpart }
3863 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
3865 warn "alternates for svcpart $svcpart: ".
3866 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
3872 foreach my $cust_svc ($self->cust_svc) {
3873 my $svcnum = $cust_svc->svcnum;
3874 if($target{$cust_svc->svcpart} > 0
3875 or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
3876 $target{$cust_svc->svcpart}--;
3877 my $new = new FS::cust_svc { $cust_svc->hash };
3878 $new->pkgnum($dest_pkgnum);
3879 $error = $new->replace($cust_svc);
3880 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3882 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
3883 warn "alternates to consider: ".
3884 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
3886 my @alternate = grep {
3887 warn "considering alternate svcpart $_: ".
3888 "$target{$_} available in new package\n"
3891 } @{$svcpart2svcparts{$cust_svc->svcpart}};
3893 warn "alternate(s) found\n" if $DEBUG;
3894 my $change_svcpart = $alternate[0];
3895 $target{$change_svcpart}--;
3896 my $new = new FS::cust_svc { $cust_svc->hash };
3897 $new->svcpart($change_svcpart);
3898 $new->pkgnum($dest_pkgnum);
3899 $error = $new->replace($cust_svc);
3907 my @label = $cust_svc->label;
3908 return "$label[0] $label[1]: $error";
3914 =item grab_svcnums SVCNUM, SVCNUM ...
3916 Change the pkgnum for the provided services to this packages. If there is an
3917 error, returns the error, otherwise returns false.
3925 my $oldAutoCommit = $FS::UID::AutoCommit;
3926 local $FS::UID::AutoCommit = 0;
3929 foreach my $svcnum (@svcnum) {
3930 my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
3931 $dbh->rollback if $oldAutoCommit;
3932 return "unknown svcnum $svcnum";
3934 $cust_svc->pkgnum( $self->pkgnum );
3935 my $error = $cust_svc->replace;
3937 $dbh->rollback if $oldAutoCommit;
3942 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3949 This method is deprecated. See the I<depend_jobnum> option to the insert and
3950 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
3954 #looks like this is still used by the order_pkg and change_pkg methods in
3955 # ClientAPI/MyAccount, need to look into those before removing
3959 my $oldAutoCommit = $FS::UID::AutoCommit;
3960 local $FS::UID::AutoCommit = 0;
3963 foreach my $cust_svc ( $self->cust_svc ) {
3964 #false laziness w/svc_Common::insert
3965 my $svc_x = $cust_svc->svc_x;
3966 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
3967 my $error = $part_export->export_insert($svc_x);
3969 $dbh->rollback if $oldAutoCommit;
3975 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3980 =item export_pkg_change OLD_CUST_PKG
3982 Calls the "pkg_change" export action for all services attached to this package.
3986 sub export_pkg_change {
3987 my( $self, $old ) = ( shift, shift );
3989 my $oldAutoCommit = $FS::UID::AutoCommit;
3990 local $FS::UID::AutoCommit = 0;
3993 foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
3994 my $error = $svc_x->export('pkg_change', $self, $old);
3996 $dbh->rollback if $oldAutoCommit;
4001 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4008 Associates this package with a (suspension or cancellation) reason (see
4009 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
4012 Available options are:
4018 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.
4022 the access_user (see L<FS::access_user>) providing the reason
4030 the action (cancel, susp, adjourn, expire) associated with the reason
4034 If there is an error, returns the error, otherwise returns false.
4039 my ($self, %options) = @_;
4041 my $otaker = $options{reason_otaker} ||
4042 $FS::CurrentUser::CurrentUser->username;
4045 if ( $options{'reason'} =~ /^(\d+)$/ ) {
4049 } elsif ( ref($options{'reason'}) ) {
4051 return 'Enter a new reason (or select an existing one)'
4052 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
4054 my $reason = new FS::reason({
4055 'reason_type' => $options{'reason'}->{'typenum'},
4056 'reason' => $options{'reason'}->{'reason'},
4058 my $error = $reason->insert;
4059 return $error if $error;
4061 $reasonnum = $reason->reasonnum;
4064 return "Unparseable reason: ". $options{'reason'};
4067 my $cust_pkg_reason =
4068 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
4069 'reasonnum' => $reasonnum,
4070 'otaker' => $otaker,
4071 'action' => substr(uc($options{'action'}),0,1),
4072 'date' => $options{'date'}
4077 $cust_pkg_reason->insert;
4080 =item insert_discount
4082 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
4083 inserting a new discount on the fly (see L<FS::discount>).
4085 Available options are:
4093 If there is an error, returns the error, otherwise returns false.
4097 sub insert_discount {
4098 #my ($self, %options) = @_;
4101 my $cust_pkg_discount = new FS::cust_pkg_discount {
4102 'pkgnum' => $self->pkgnum,
4103 'discountnum' => $self->discountnum,
4105 'end_date' => '', #XXX
4106 #for the create a new discount case
4107 '_type' => $self->discountnum__type,
4108 'amount' => $self->discountnum_amount,
4109 'percent' => $self->discountnum_percent,
4110 'months' => $self->discountnum_months,
4111 'setup' => $self->discountnum_setup,
4112 #'disabled' => $self->discountnum_disabled,
4115 $cust_pkg_discount->insert;
4118 =item set_usage USAGE_VALUE_HASHREF
4120 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4121 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4122 upbytes, downbytes, and totalbytes are appropriate keys.
4124 All svc_accts which are part of this package have their values reset.
4129 my ($self, $valueref, %opt) = @_;
4131 #only svc_acct can set_usage for now
4132 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4133 my $svc_x = $cust_svc->svc_x;
4134 $svc_x->set_usage($valueref, %opt)
4135 if $svc_x->can("set_usage");
4139 =item recharge USAGE_VALUE_HASHREF
4141 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4142 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4143 upbytes, downbytes, and totalbytes are appropriate keys.
4145 All svc_accts which are part of this package have their values incremented.
4150 my ($self, $valueref) = @_;
4152 #only svc_acct can set_usage for now
4153 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4154 my $svc_x = $cust_svc->svc_x;
4155 $svc_x->recharge($valueref)
4156 if $svc_x->can("recharge");
4160 =item apply_usageprice
4164 sub apply_usageprice {
4167 my $oldAutoCommit = $FS::UID::AutoCommit;
4168 local $FS::UID::AutoCommit = 0;
4173 foreach my $cust_pkg_usageprice ( $self->cust_pkg_usageprice ) {
4174 $error ||= $cust_pkg_usageprice->apply;
4178 $dbh->rollback if $oldAutoCommit;
4179 die "error applying part_pkg_usageprice add-ons, pkgnum ". $self->pkgnum.
4182 $dbh->commit if $oldAutoCommit;
4188 =item cust_pkg_discount
4190 =item cust_pkg_discount_active
4194 sub cust_pkg_discount_active {
4196 grep { $_->status eq 'active' } $self->cust_pkg_discount;
4199 =item cust_pkg_usage
4201 Returns a list of all voice usage counters attached to this package.
4203 =item apply_usage OPTIONS
4205 Takes the following options:
4206 - cdr: a call detail record (L<FS::cdr>)
4207 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
4208 - minutes: the maximum number of minutes to be charged
4210 Finds available usage minutes for a call of this class, and subtracts
4211 up to that many minutes from the usage pool. If the usage pool is empty,
4212 and the C<cdr-minutes_priority> global config option is set, minutes may
4213 be taken from other calls as well. Either way, an allocation record will
4214 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
4215 number of minutes of usage applied to the call.
4220 my ($self, %opt) = @_;
4221 my $cdr = $opt{cdr};
4222 my $rate_detail = $opt{rate_detail};
4223 my $minutes = $opt{minutes};
4224 my $classnum = $rate_detail->classnum;
4225 my $pkgnum = $self->pkgnum;
4226 my $custnum = $self->custnum;
4228 my $oldAutoCommit = $FS::UID::AutoCommit;
4229 local $FS::UID::AutoCommit = 0;
4232 my $order = FS::Conf->new->config('cdr-minutes_priority');
4236 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
4238 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
4240 my @usage_recs = qsearch({
4241 'table' => 'cust_pkg_usage',
4242 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
4243 ' JOIN cust_pkg USING (pkgnum)'.
4244 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
4245 'select' => 'cust_pkg_usage.*',
4246 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
4247 " ( cust_pkg.custnum = $custnum AND ".
4248 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4249 $is_classnum . ' AND '.
4250 " cust_pkg_usage.minutes > 0",
4251 'order_by' => " ORDER BY priority ASC",
4254 my $orig_minutes = $minutes;
4256 while (!$error and $minutes > 0 and @usage_recs) {
4257 my $cust_pkg_usage = shift @usage_recs;
4258 $cust_pkg_usage->select_for_update;
4259 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
4260 pkgusagenum => $cust_pkg_usage->pkgusagenum,
4261 acctid => $cdr->acctid,
4262 minutes => min($cust_pkg_usage->minutes, $minutes),
4264 $cust_pkg_usage->set('minutes',
4265 $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes
4267 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
4268 $minutes -= $cdr_cust_pkg_usage->minutes;
4270 if ( $order and $minutes > 0 and !$error ) {
4271 # then try to steal minutes from another call
4273 'table' => 'cdr_cust_pkg_usage',
4274 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
4275 ' JOIN part_pkg_usage USING (pkgusagepart)'.
4276 ' JOIN cust_pkg USING (pkgnum)'.
4277 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
4278 ' JOIN cdr USING (acctid)',
4279 'select' => 'cdr_cust_pkg_usage.*',
4280 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
4281 " ( cust_pkg.pkgnum = $pkgnum OR ".
4282 " ( cust_pkg.custnum = $custnum AND ".
4283 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4284 " part_pkg_usage_class.classnum = $classnum",
4285 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
4287 if ( $order eq 'time' ) {
4288 # find CDRs that are using minutes, but have a later startdate
4290 my $startdate = $cdr->startdate;
4291 if ($startdate !~ /^\d+$/) {
4292 die "bad cdr startdate '$startdate'";
4294 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
4295 # minimize needless reshuffling
4296 $search{'order_by'} .= ', cdr.startdate DESC';
4298 # XXX may not work correctly with rate_time schedules. Could
4299 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
4301 $search{'addl_from'} .=
4302 ' JOIN rate_detail'.
4303 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
4304 if ( $order eq 'rate_high' ) {
4305 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
4306 $rate_detail->min_charge;
4307 $search{'order_by'} .= ', rate_detail.min_charge ASC';
4308 } elsif ( $order eq 'rate_low' ) {
4309 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
4310 $rate_detail->min_charge;
4311 $search{'order_by'} .= ', rate_detail.min_charge DESC';
4313 # this should really never happen
4314 die "invalid cdr-minutes_priority value '$order'\n";
4317 my @cdr_usage_recs = qsearch(\%search);
4319 while (!$error and @cdr_usage_recs and $minutes > 0) {
4320 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
4321 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
4322 my $old_cdr = $cdr_cust_pkg_usage->cdr;
4323 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
4324 $cdr_cust_pkg_usage->select_for_update;
4325 $old_cdr->select_for_update;
4326 $cust_pkg_usage->select_for_update;
4327 # in case someone else stole the usage from this CDR
4328 # while waiting for the lock...
4329 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
4330 # steal the usage allocation and flag the old CDR for reprocessing
4331 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
4332 # if the allocation is more minutes than we need, adjust it...
4333 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
4335 $cdr_cust_pkg_usage->set('minutes', $minutes);
4336 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
4337 $error = $cust_pkg_usage->replace;
4339 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
4340 $error ||= $cdr_cust_pkg_usage->replace;
4341 # deduct the stolen minutes
4342 $minutes -= $cdr_cust_pkg_usage->minutes;
4344 # after all minute-stealing is done, reset the affected CDRs
4345 foreach (values %reproc_cdrs) {
4346 $error ||= $_->set_status('');
4347 # XXX or should we just call $cdr->rate right here?
4348 # it's not like we can create a loop this way, since the min_charge
4349 # or call time has to go monotonically in one direction.
4350 # we COULD get some very deep recursions going, though...
4352 } # if $order and $minutes
4355 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
4357 $dbh->commit if $oldAutoCommit;
4358 return $orig_minutes - $minutes;
4362 =item supplemental_pkgs
4364 Returns a list of all packages supplemental to this one.
4368 sub supplemental_pkgs {
4370 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
4375 Returns the package that this one is supplemental to, if any.
4381 if ( $self->main_pkgnum ) {
4382 return FS::cust_pkg->by_key($self->main_pkgnum);
4389 =head1 CLASS METHODS
4395 Returns an SQL expression identifying recurring packages.
4399 sub recurring_sql { "
4400 '0' != ( select freq from part_pkg
4401 where cust_pkg.pkgpart = part_pkg.pkgpart )
4406 Returns an SQL expression identifying one-time packages.
4411 '0' = ( select freq from part_pkg
4412 where cust_pkg.pkgpart = part_pkg.pkgpart )
4417 Returns an SQL expression identifying ordered packages (recurring packages not
4423 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
4428 Returns an SQL expression identifying active packages.
4433 $_[0]->recurring_sql. "
4434 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4435 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4436 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4439 =item not_yet_billed_sql
4441 Returns an SQL expression identifying packages which have not yet been billed.
4445 sub not_yet_billed_sql { "
4446 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4447 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4448 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4453 Returns an SQL expression identifying inactive packages (one-time packages
4454 that are otherwise unsuspended/uncancelled).
4458 sub inactive_sql { "
4459 ". $_[0]->onetime_sql(). "
4460 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4461 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4462 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4467 Returns an SQL expression identifying on-hold packages.
4472 #$_[0]->recurring_sql(). ' AND '.
4474 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4475 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4476 AND ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4483 Returns an SQL expression identifying suspended packages.
4487 sub suspended_sql { susp_sql(@_); }
4489 #$_[0]->recurring_sql(). ' AND '.
4491 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4492 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4493 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4500 Returns an SQL exprression identifying cancelled packages.
4504 sub cancelled_sql { cancel_sql(@_); }
4506 #$_[0]->recurring_sql(). ' AND '.
4507 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
4512 Returns an SQL expression to give the package status as a string.
4518 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
4519 WHEN ( cust_pkg.susp IS NOT NULL AND cust_pkg.setup IS NULL ) THEN 'on hold'
4520 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
4521 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
4522 WHEN ".onetime_sql()." THEN 'one-time charge'
4529 Returns a list of two package counts. The first is a count of packages
4530 based on the supplied criteria and the second is the count of residential
4531 packages with those same criteria. Criteria are specified as in the search
4537 my ($class, $params) = @_;
4539 my $sql_query = $class->search( $params );
4541 my $count_sql = delete($sql_query->{'count_query'});
4542 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
4543 or die "couldn't parse count_sql";
4545 my $count_sth = dbh->prepare($count_sql)
4546 or die "Error preparing $count_sql: ". dbh->errstr;
4548 or die "Error executing $count_sql: ". $count_sth->errstr;
4549 my $count_arrayref = $count_sth->fetchrow_arrayref;
4551 return ( @$count_arrayref );
4555 =item tax_locationnum_sql
4557 Returns an SQL expression for the tax location for a package, based
4558 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
4562 sub tax_locationnum_sql {
4563 my $conf = FS::Conf->new;
4564 if ( $conf->exists('tax-pkg_address') ) {
4565 'cust_pkg.locationnum';
4567 elsif ( $conf->exists('tax-ship_address') ) {
4568 'cust_main.ship_locationnum';
4571 'cust_main.bill_locationnum';
4577 Returns a list: the first item is an SQL fragment identifying matching
4578 packages/customers via location (taking into account shipping and package
4579 address taxation, if enabled), and subsequent items are the parameters to
4580 substitute for the placeholders in that fragment.
4585 my($class, %opt) = @_;
4586 my $ornull = $opt{'ornull'};
4588 my $conf = new FS::Conf;
4590 # '?' placeholders in _location_sql_where
4591 my $x = $ornull ? 3 : 2;
4602 if ( $conf->exists('tax-ship_address') ) {
4605 ( ( ship_last IS NULL OR ship_last = '' )
4606 AND ". _location_sql_where('cust_main', '', $ornull ). "
4608 OR ( ship_last IS NOT NULL AND ship_last != ''
4609 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
4612 # AND payby != 'COMP'
4614 @main_param = ( @bill_param, @bill_param );
4618 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
4619 @main_param = @bill_param;
4625 if ( $conf->exists('tax-pkg_address') ) {
4627 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
4630 ( cust_pkg.locationnum IS NULL AND $main_where )
4631 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
4634 @param = ( @main_param, @bill_param );
4638 $where = $main_where;
4639 @param = @main_param;
4647 #subroutine, helper for location_sql
4648 sub _location_sql_where {
4650 my $prefix = @_ ? shift : '';
4651 my $ornull = @_ ? shift : '';
4653 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
4655 $ornull = $ornull ? ' OR ? IS NULL ' : '';
4657 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
4658 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
4659 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
4661 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
4663 # ( $table.${prefix}city = ? $or_empty_city $ornull )
4665 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4666 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4667 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
4668 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
4669 AND $table.${prefix}country = ?
4674 my( $self, $what ) = @_;
4676 my $what_show_zero = $what. '_show_zero';
4677 length($self->$what_show_zero())
4678 ? ($self->$what_show_zero() eq 'Y')
4679 : $self->part_pkg->$what_show_zero();
4686 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
4688 CUSTNUM is a customer (see L<FS::cust_main>)
4690 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4691 L<FS::part_pkg>) to order for this customer. Duplicates are of course
4694 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
4695 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
4696 new billing items. An error is returned if this is not possible (see
4697 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
4700 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4701 newly-created cust_pkg objects.
4703 REFNUM, if specified, will specify the FS::pkg_referral record to be created
4704 and inserted. Multiple FS::pkg_referral records can be created by
4705 setting I<refnum> to an array reference of refnums or a hash reference with
4706 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
4707 record will be created corresponding to cust_main.refnum.
4712 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
4714 my $conf = new FS::Conf;
4716 # Transactionize this whole mess
4717 my $oldAutoCommit = $FS::UID::AutoCommit;
4718 local $FS::UID::AutoCommit = 0;
4722 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
4723 # return "Customer not found: $custnum" unless $cust_main;
4725 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
4728 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4731 my $change = scalar(@old_cust_pkg) != 0;
4734 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
4736 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
4737 " to pkgpart ". $pkgparts->[0]. "\n"
4740 my $err_or_cust_pkg =
4741 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
4742 'refnum' => $refnum,
4745 unless (ref($err_or_cust_pkg)) {
4746 $dbh->rollback if $oldAutoCommit;
4747 return $err_or_cust_pkg;
4750 push @$return_cust_pkg, $err_or_cust_pkg;
4751 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4756 # Create the new packages.
4757 foreach my $pkgpart (@$pkgparts) {
4759 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
4761 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
4762 pkgpart => $pkgpart,
4766 $error = $cust_pkg->insert( 'change' => $change );
4767 push @$return_cust_pkg, $cust_pkg;
4769 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
4770 my $supp_pkg = FS::cust_pkg->new({
4771 custnum => $custnum,
4772 pkgpart => $link->dst_pkgpart,
4774 main_pkgnum => $cust_pkg->pkgnum,
4777 $error ||= $supp_pkg->insert( 'change' => $change );
4778 push @$return_cust_pkg, $supp_pkg;
4782 $dbh->rollback if $oldAutoCommit;
4787 # $return_cust_pkg now contains refs to all of the newly
4790 # Transfer services and cancel old packages.
4791 foreach my $old_pkg (@old_cust_pkg) {
4793 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
4796 foreach my $new_pkg (@$return_cust_pkg) {
4797 $error = $old_pkg->transfer($new_pkg);
4798 if ($error and $error == 0) {
4799 # $old_pkg->transfer failed.
4800 $dbh->rollback if $oldAutoCommit;
4805 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
4806 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
4807 foreach my $new_pkg (@$return_cust_pkg) {
4808 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
4809 if ($error and $error == 0) {
4810 # $old_pkg->transfer failed.
4811 $dbh->rollback if $oldAutoCommit;
4818 # Transfers were successful, but we went through all of the
4819 # new packages and still had services left on the old package.
4820 # We can't cancel the package under the circumstances, so abort.
4821 $dbh->rollback if $oldAutoCommit;
4822 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
4824 $error = $old_pkg->cancel( quiet=>1, 'no_delay_cancel'=>1 );
4830 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4834 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
4836 A bulk change method to change packages for multiple customers.
4838 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4839 L<FS::part_pkg>) to order for each customer. Duplicates are of course
4842 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
4843 replace. The services (see L<FS::cust_svc>) are moved to the
4844 new billing items. An error is returned if this is not possible (see
4847 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4848 newly-created cust_pkg objects.
4853 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
4855 # Transactionize this whole mess
4856 my $oldAutoCommit = $FS::UID::AutoCommit;
4857 local $FS::UID::AutoCommit = 0;
4861 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4864 while(scalar(@old_cust_pkg)) {
4866 my $custnum = $old_cust_pkg[0]->custnum;
4867 my (@remove) = map { $_->pkgnum }
4868 grep { $_->custnum == $custnum } @old_cust_pkg;
4869 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
4871 my $error = order $custnum, $pkgparts, \@remove, \@return;
4873 push @errors, $error
4875 push @$return_cust_pkg, @return;
4878 if (scalar(@errors)) {
4879 $dbh->rollback if $oldAutoCommit;
4880 return join(' / ', @errors);
4883 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4887 # Used by FS::Upgrade to migrate to a new database.
4888 sub _upgrade_data { # class method
4889 my ($class, %opts) = @_;
4890 $class->_upgrade_otaker(%opts);
4892 # RT#10139, bug resulting in contract_end being set when it shouldn't
4893 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
4894 # RT#10830, bad calculation of prorate date near end of year
4895 # the date range for bill is December 2009, and we move it forward
4896 # one year if it's before the previous bill date (which it should
4898 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
4899 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
4900 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
4901 # RT6628, add order_date to cust_pkg
4902 'update cust_pkg set order_date = (select history_date from h_cust_pkg
4903 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
4904 history_action = \'insert\') where order_date is null',
4906 foreach my $sql (@statements) {
4907 my $sth = dbh->prepare($sql);
4908 $sth->execute or die $sth->errstr;
4911 # RT31194: supplemental package links that are deleted don't clean up
4913 my @pkglinknums = qsearch({
4914 'select' => 'DISTINCT cust_pkg.pkglinknum',
4915 'table' => 'cust_pkg',
4916 'addl_from' => ' LEFT JOIN part_pkg_link USING (pkglinknum) ',
4917 'extra_sql' => ' WHERE cust_pkg.pkglinknum IS NOT NULL
4918 AND part_pkg_link.pkglinknum IS NULL',
4920 foreach (@pkglinknums) {
4921 my $pkglinknum = $_->pkglinknum;
4922 warn "cleaning part_pkg_link #$pkglinknum\n";
4923 my $part_pkg_link = FS::part_pkg_link->new({pkglinknum => $pkglinknum});
4924 my $error = $part_pkg_link->remove_linked;
4925 die $error if $error;
4933 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
4935 In sub order, the @pkgparts array (passed by reference) is clobbered.
4937 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
4938 method to pass dates to the recur_prog expression, it should do so.
4940 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
4941 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
4942 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
4943 configuration values. Probably need a subroutine which decides what to do
4944 based on whether or not we've fetched the user yet, rather than a hash. See
4945 FS::UID and the TODO.
4947 Now that things are transactional should the check in the insert method be
4952 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
4953 L<FS::pkg_svc>, schema.html from the base documentation