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 #bulk cancel+order... perhaps slightly deprecated, only used by the bulk
110 # cancel+order in the web UI and nowhere else (edit/process/cust_pkg.cgi)
111 $error = FS::cust_pkg::order( $custnum, \@pkgparts );
112 $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );
116 An FS::cust_pkg object represents a customer billing item. FS::cust_pkg
117 inherits from FS::Record. The following fields are currently supported:
123 Primary key (assigned automatically for new billing items)
127 Customer (see L<FS::cust_main>)
131 Billing item definition (see L<FS::part_pkg>)
135 Optional link to package location (see L<FS::location>)
139 date package was ordered (also remains same on changes)
151 date (next bill date)
179 order taker (see L<FS::access_user>)
183 If this field is set to 1, disables the automatic
184 unsuspension of this package when using the B<unsuspendauto> config option.
188 If not set, defaults to 1
192 Date of change from previous package
202 =item change_locationnum
210 The pkgnum of the package that this package is supplemental to, if any.
214 The package link (L<FS::part_pkg_link>) that defines this supplemental
215 package, if it is one.
217 =item change_to_pkgnum
219 The pkgnum of the package this one will be "changed to" in the future
220 (on its expiration date).
224 Note: setup, last_bill, bill, adjourn, susp, expire, cancel and change_date
225 are specified as UNIX timestamps; see L<perlfunc/"time">. Also see
226 L<Time::Local> and L<Date::Parse> for conversion functions.
234 Create a new billing item. To add the item to the database, see L<"insert">.
238 sub table { 'cust_pkg'; }
239 sub cust_linked { $_[0]->cust_main_custnum || $_[0]->custnum }
240 sub cust_unlinked_msg {
242 "WARNING: can't find cust_main.custnum ". $self->custnum.
243 ' (cust_pkg.pkgnum '. $self->pkgnum. ')';
246 =item set_initial_timers
248 If required by the package definition, sets any automatic expire, adjourn,
249 or contract_end timers to some number of months after the start date
250 (or setup date, if the package has already been setup). If the package has
251 a delayed setup fee after a period of "free days", will also set the
252 start date to the end of that period.
256 sub set_initial_timers {
258 my $part_pkg = $self->part_pkg;
259 foreach my $action ( qw(expire adjourn contract_end) ) {
260 my $months = $part_pkg->option("${action}_months",1);
261 if($months and !$self->get($action)) {
262 my $start = $self->start_date || $self->setup || time;
263 $self->set($action, $part_pkg->add_freq($start, $months) );
267 # if this package has "free days" and delayed setup fee, then
268 # set start date that many days in the future.
269 # (this should have been set in the UI, but enforce it here)
270 if ( $part_pkg->option('free_days',1)
271 && $part_pkg->option('delay_setup',1)
274 $self->start_date( $part_pkg->default_start_date );
279 =item insert [ OPTION => VALUE ... ]
281 Adds this billing item to the database ("Orders" the item). If there is an
282 error, returns the error, otherwise returns false.
284 If the additional field I<promo_code> is defined instead of I<pkgpart>, it
285 will be used to look up the package definition and agent restrictions will be
288 If the additional field I<refnum> is defined, an FS::pkg_referral record will
289 be created and inserted. Multiple FS::pkg_referral records can be created by
290 setting I<refnum> to an array reference of refnums or a hash reference with
291 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
292 record will be created corresponding to cust_main.refnum.
294 If the additional field I<cust_pkg_usageprice> is defined, it will be treated
295 as an arrayref of FS::cust_pkg_usageprice objects, which will be inserted.
296 (Note that this field cannot be set with a usual ->cust_pkg_usageprice method.
297 It can be set as part of the hash when creating the object, or with the B<set>
300 The following options are available:
306 If set true, supresses actions that should only be taken for new package
307 orders. (Currently this includes: intro periods when delay_setup is on,
308 auto-adding a 1st start date, auto-adding expiration/adjourn/contract_end dates)
312 cust_pkg_option records will be created
316 a ticket will be added to this customer with this subject
320 an optional queue name for ticket additions
324 Don't check the legality of the package definition. This should be used
325 when performing a package change that doesn't change the pkgpart (i.e.
333 my( $self, %options ) = @_;
336 $error = $self->check_pkgpart unless $options{'allow_pkgpart'};
337 return $error if $error;
339 my $part_pkg = $self->part_pkg;
341 if ( ! $import && ! $options{'change'} ) {
343 # set order date to now
344 $self->order_date(time) unless ($import && $self->order_date);
346 # if the package def says to start only on the first of the month:
347 if ( $part_pkg->option('start_1st', 1) && !$self->start_date ) {
348 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime(time) )[0,1,2,3,4,5];
349 $mon += 1 unless $mday == 1;
350 until ( $mon < 12 ) { $mon -= 12; $year++; }
351 $self->start_date( timelocal_nocheck(0,0,0,1,$mon,$year) );
354 if ($self->susp eq 'now' or $part_pkg->start_on_hold) {
355 # if the package was ordered on hold:
357 # - don't set the start date (it will be started manually)
358 $self->set('susp', $self->order_date);
359 $self->set('start_date', '');
361 # set expire/adjourn/contract_end timers, and free days, if appropriate
362 $self->set_initial_timers;
364 } # else this is a package change, and shouldn't have "new package" behavior
366 my $oldAutoCommit = $FS::UID::AutoCommit;
367 local $FS::UID::AutoCommit = 0;
370 $error = $self->SUPER::insert($options{options} ? %{$options{options}} : ());
372 $dbh->rollback if $oldAutoCommit;
376 $self->refnum($self->cust_main->refnum) unless $self->refnum;
377 $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
378 $self->process_m2m( 'link_table' => 'pkg_referral',
379 'target_table' => 'part_referral',
380 'params' => $self->refnum,
383 if ( $self->hashref->{cust_pkg_usageprice} ) {
384 for my $cust_pkg_usageprice ( @{ $self->hashref->{cust_pkg_usageprice} } ) {
385 $cust_pkg_usageprice->pkgnum( $self->pkgnum );
386 my $error = $cust_pkg_usageprice->insert;
388 $dbh->rollback if $oldAutoCommit;
394 if ( $self->discountnum ) {
395 my $error = $self->insert_discount();
397 $dbh->rollback if $oldAutoCommit;
402 my $conf = new FS::Conf;
404 if ( ! $import && $conf->config('ticket_system') && $options{ticket_subject} ) {
406 #this init stuff is still inefficient, but at least its limited to
407 # the small number (any?) folks using ticket emailing on pkg order
410 # use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
417 use FS::TicketSystem;
418 FS::TicketSystem->init();
420 my $q = new RT::Queue($RT::SystemUser);
421 $q->Load($options{ticket_queue}) if $options{ticket_queue};
422 my $t = new RT::Ticket($RT::SystemUser);
423 my $mime = new MIME::Entity;
424 $mime->build( Type => 'text/plain', Data => $options{ticket_subject} );
425 $t->Create( $options{ticket_queue} ? (Queue => $q) : (),
426 Subject => $options{ticket_subject},
429 $t->AddLink( Type => 'MemberOf',
430 Target => 'freeside://freeside/cust_main/'. $self->custnum,
434 if (! $import && $conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
435 my $queue = new FS::queue {
436 'job' => 'FS::cust_main::queueable_print',
438 $error = $queue->insert(
439 'custnum' => $self->custnum,
440 'template' => 'welcome_letter',
444 warn "can't send welcome letter: $error";
449 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
456 This method now works but you probably shouldn't use it.
458 You don't want to delete packages, because there would then be no record
459 the customer ever purchased the package. Instead, see the cancel method and
460 hide cancelled packages.
467 my $oldAutoCommit = $FS::UID::AutoCommit;
468 local $FS::UID::AutoCommit = 0;
471 foreach my $cust_pkg_discount ($self->cust_pkg_discount) {
472 my $error = $cust_pkg_discount->delete;
474 $dbh->rollback if $oldAutoCommit;
478 #cust_bill_pkg_discount?
480 foreach my $cust_pkg_detail ($self->cust_pkg_detail) {
481 my $error = $cust_pkg_detail->delete;
483 $dbh->rollback if $oldAutoCommit;
488 foreach my $cust_pkg_reason (
490 'table' => 'cust_pkg_reason',
491 'hashref' => { 'pkgnum' => $self->pkgnum },
495 my $error = $cust_pkg_reason->delete;
497 $dbh->rollback if $oldAutoCommit;
504 my $error = $self->SUPER::delete(@_);
506 $dbh->rollback if $oldAutoCommit;
510 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
516 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
518 Replaces the OLD_RECORD with this one in the database. If there is an error,
519 returns the error, otherwise returns false.
521 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
523 Changing pkgpart may have disasterous effects. See the order subroutine.
525 setup and bill are normally updated by calling the bill method of a customer
526 object (see L<FS::cust_main>).
528 suspend is normally updated by the suspend and unsuspend methods.
530 cancel is normally updated by the cancel method (and also the order subroutine
533 Available options are:
539 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.
543 the access_user (see L<FS::access_user>) providing the reason
547 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
556 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
561 ( ref($_[0]) eq 'HASH' )
565 #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
566 #return "Can't change otaker!" if $old->otaker ne $new->otaker;
569 #return "Can't change setup once it exists!"
570 # if $old->getfield('setup') &&
571 # $old->getfield('setup') != $new->getfield('setup');
573 #some logic for bill, susp, cancel?
575 local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
577 my $oldAutoCommit = $FS::UID::AutoCommit;
578 local $FS::UID::AutoCommit = 0;
581 foreach my $method ( qw(adjourn expire) ) { # How many reasons?
582 if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
583 my $error = $new->insert_reason(
584 'reason' => $options->{'reason'},
585 'date' => $new->$method,
587 'reason_otaker' => $options->{'reason_otaker'},
590 dbh->rollback if $oldAutoCommit;
591 return "Error inserting cust_pkg_reason: $error";
596 #save off and freeze RADIUS attributes for any associated svc_acct records
598 if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
600 #also check for specific exports?
601 # to avoid spurious modify export events
602 @svc_acct = map { $_->svc_x }
603 grep { $_->part_svc->svcdb eq 'svc_acct' }
606 $_->snapshot foreach @svc_acct;
610 my $error = $new->export_pkg_change($old)
611 || $new->SUPER::replace( $old,
613 ? $options->{options}
617 $dbh->rollback if $oldAutoCommit;
621 #for prepaid packages,
622 #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
623 foreach my $old_svc_acct ( @svc_acct ) {
624 my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
626 $new_svc_acct->replace( $old_svc_acct,
627 'depend_jobnum' => $options->{depend_jobnum},
630 $dbh->rollback if $oldAutoCommit;
635 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
642 Checks all fields to make sure this is a valid billing item. If there is an
643 error, returns the error, otherwise returns false. Called by the insert and
651 if ( !$self->locationnum or $self->locationnum == -1 ) {
652 $self->set('locationnum', $self->cust_main->ship_locationnum);
656 $self->ut_numbern('pkgnum')
657 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
658 || $self->ut_numbern('pkgpart')
659 || $self->ut_foreign_keyn('contactnum', 'contact', 'contactnum' )
660 || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
661 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
662 || $self->ut_numbern('quantity')
663 || $self->ut_numbern('start_date')
664 || $self->ut_numbern('setup')
665 || $self->ut_numbern('bill')
666 || $self->ut_numbern('susp')
667 || $self->ut_numbern('cancel')
668 || $self->ut_numbern('adjourn')
669 || $self->ut_numbern('resume')
670 || $self->ut_numbern('expire')
671 || $self->ut_numbern('dundate')
672 || $self->ut_flag('no_auto', [ '', 'Y' ])
673 || $self->ut_flag('waive_setup', [ '', 'Y' ])
674 || $self->ut_flag('separate_bill')
675 || $self->ut_textn('agent_pkgid')
676 || $self->ut_enum('recur_show_zero', [ '', 'Y', 'N', ])
677 || $self->ut_enum('setup_show_zero', [ '', 'Y', 'N', ])
678 || $self->ut_foreign_keyn('main_pkgnum', 'cust_pkg', 'pkgnum')
679 || $self->ut_foreign_keyn('pkglinknum', 'part_pkg_link', 'pkglinknum')
680 || $self->ut_foreign_keyn('change_to_pkgnum', 'cust_pkg', 'pkgnum')
682 return $error if $error;
684 return "A package with both start date (future start) and setup date (already started) will never bill"
685 if $self->start_date && $self->setup && ! $upgrade;
687 return "A future unsuspend date can only be set for a package with a suspend date"
688 if $self->resume and !$self->susp and !$self->adjourn;
690 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
692 if ( $self->dbdef_table->column('manual_flag') ) {
693 $self->manual_flag('') if $self->manual_flag eq ' ';
694 $self->manual_flag =~ /^([01]?)$/
695 or return "Illegal manual_flag ". $self->manual_flag;
696 $self->manual_flag($1);
704 Check the pkgpart to make sure it's allowed with the reg_code and/or
705 promo_code of the package (if present) and with the customer's agent.
706 Called from C<insert>, unless we are doing a package change that doesn't
714 # my $error = $self->ut_numbern('pkgpart'); # already done
717 if ( $self->reg_code ) {
719 unless ( grep { $self->pkgpart == $_->pkgpart }
720 map { $_->reg_code_pkg }
721 qsearchs( 'reg_code', { 'code' => $self->reg_code,
722 'agentnum' => $self->cust_main->agentnum })
724 return "Unknown registration code";
727 } elsif ( $self->promo_code ) {
730 qsearchs('part_pkg', {
731 'pkgpart' => $self->pkgpart,
732 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
734 return 'Unknown promotional code' unless $promo_part_pkg;
738 unless ( $disable_agentcheck ) {
740 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
741 return "agent ". $agent->agentnum. ':'. $agent->agent.
742 " can't purchase pkgpart ". $self->pkgpart
743 unless $agent->pkgpart_hashref->{ $self->pkgpart }
744 || $agent->agentnum == $self->part_pkg->agentnum;
747 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
748 return $error if $error;
756 =item cancel [ OPTION => VALUE ... ]
758 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
759 in this package, then cancels the package itself (sets the cancel field to
762 Available options are:
766 =item quiet - can be set true to supress email cancellation notices.
768 =item time - can be set to cancel the package based on a specific future or
769 historical date. Using time ensures that the remaining amount is calculated
770 correctly. Note however that this is an immediate cancel and just changes
771 the date. You are PROBABLY looking to expire the account instead of using
774 =item reason - can be set to a cancellation reason (see L<FS:reason>),
775 either a reasonnum of an existing reason, or passing a hashref will create
776 a new reason. The hashref should have the following keys: typenum - Reason
777 type (see L<FS::reason_type>, reason - Text of the new reason.
779 =item date - can be set to a unix style timestamp to specify when to
782 =item nobill - can be set true to skip billing if it might otherwise be done.
784 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
785 not credit it. This must be set (by change()) when changing the package
786 to a different pkgpart or location, and probably shouldn't be in any other
787 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
790 =item no_delay_cancel - prevents delay_cancel behavior
791 no matter what other options say, for use when changing packages (or any
792 other time you're really sure you want an immediate cancel)
796 If there is an error, returns the error, otherwise returns false.
800 #NOT DOCUMENTING - this should only be used when calling recursively
801 #=item delay_cancel - for internal use, to allow proper handling of
802 #supplemental packages when the main package is flagged to suspend
803 #before cancelling, probably shouldn't be used otherwise (set the
804 #corresponding package option instead)
807 my( $self, %options ) = @_;
810 # pass all suspend/cancel actions to the main package
811 # (unless the pkglinknum has been removed, then the link is defunct and
812 # this package can be canceled on its own)
813 if ( $self->main_pkgnum and $self->pkglinknum and !$options{'from_main'} ) {
814 return $self->main_pkg->cancel(%options);
817 my $conf = new FS::Conf;
819 warn "cust_pkg::cancel called with options".
820 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
823 my $oldAutoCommit = $FS::UID::AutoCommit;
824 local $FS::UID::AutoCommit = 0;
827 my $old = $self->select_for_update;
829 if ( $old->get('cancel') || $self->get('cancel') ) {
830 dbh->rollback if $oldAutoCommit;
831 return ""; # no error
834 # XXX possibly set cancel_time to the expire date?
835 my $cancel_time = $options{'time'} || time;
836 my $date = $options{'date'} if $options{'date'}; # expire/cancel later
837 $date = '' if ($date && $date <= $cancel_time); # complain instead?
839 my $delay_cancel = $options{'no_delay_cancel'} ? 0 : $options{'delay_cancel'};
840 if ( !$date && $self->part_pkg->option('delay_cancel',1)
841 && (($self->status eq 'active') || ($self->status eq 'suspended'))
842 && !$options{'no_delay_cancel'}
844 my $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
845 my $expsecs = 60*60*24*$expdays;
846 my $suspfor = $self->susp ? $cancel_time - $self->susp : 0;
847 $expsecs = $expsecs - $suspfor if $suspfor;
848 unless ($expsecs <= 0) { #if it's already been suspended long enough, don't re-suspend
850 $date = $cancel_time + $expsecs;
854 #race condition: usage could be ongoing until unprovisioned
855 #resolved by performing a change package instead (which unprovisions) and
857 if ( !$options{nobill} && !$date ) {
858 # && $conf->exists('bill_usage_on_cancel') ) { #calc_cancel checks this
859 my $copy = $self->new({$self->hash});
861 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
863 'time' => $cancel_time );
864 warn "Error billing during cancel, custnum ".
865 #$self->cust_main->custnum. ": $error"
870 if ( $options{'reason'} ) {
871 $error = $self->insert_reason( 'reason' => $options{'reason'},
872 'action' => $date ? 'expire' : 'cancel',
873 'date' => $date ? $date : $cancel_time,
874 'reason_otaker' => $options{'reason_otaker'},
877 dbh->rollback if $oldAutoCommit;
878 return "Error inserting cust_pkg_reason: $error";
882 my %svc_cancel_opt = ();
883 $svc_cancel_opt{'date'} = $date if $date;
884 foreach my $cust_svc (
887 sort { $a->[1] <=> $b->[1] }
888 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; }
889 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
891 my $part_svc = $cust_svc->part_svc;
892 next if ( defined($part_svc) and $part_svc->preserve );
893 my $error = $cust_svc->cancel( %svc_cancel_opt );
896 $dbh->rollback if $oldAutoCommit;
897 return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
903 # credit remaining time if appropriate
905 if ( exists($options{'unused_credit'}) ) {
906 $do_credit = $options{'unused_credit'};
909 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
912 my $error = $self->credit_remaining('cancel', $cancel_time);
914 $dbh->rollback if $oldAutoCommit;
920 my %hash = $self->hash;
922 $hash{'expire'} = $date;
924 # just to be sure these are clear
925 $hash{'adjourn'} = undef;
926 $hash{'resume'} = undef;
929 $hash{'cancel'} = $cancel_time;
931 $hash{'change_custnum'} = $options{'change_custnum'};
933 # if this is a supplemental package that's lost its part_pkg_link, and it's
934 # being canceled for real, unlink it completely
935 if ( !$date and ! $self->pkglinknum ) {
936 $hash{main_pkgnum} = '';
939 my $new = new FS::cust_pkg ( \%hash );
940 $error = $new->replace( $self, options => { $self->options } );
941 if ( $self->change_to_pkgnum ) {
942 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
943 $error ||= $change_to->cancel('no_delay_cancel' => 1) || $change_to->delete;
946 $dbh->rollback if $oldAutoCommit;
950 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
951 $error = $supp_pkg->cancel(%options,
953 'date' => $date, #in case it got changed by delay_cancel
954 'delay_cancel' => $delay_cancel,
957 $dbh->rollback if $oldAutoCommit;
958 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
962 if ($delay_cancel && !$options{'from_main'}) {
963 $error = $new->suspend(
965 'time' => $cancel_time
970 foreach my $usage ( $self->cust_pkg_usage ) {
971 $error = $usage->delete;
973 $dbh->rollback if $oldAutoCommit;
974 return "deleting usage pools: $error";
979 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
980 return '' if $date; #no errors
982 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
983 if ( !$options{'quiet'} &&
984 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
986 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
989 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
990 $error = $msg_template->send( 'cust_main' => $self->cust_main,
995 'from' => $conf->invoice_from_full( $self->cust_main->agentnum ),
996 'to' => \@invoicing_list,
997 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
998 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
999 'custnum' => $self->custnum,
1000 'msgtype' => '', #admin?
1003 #should this do something on errors?
1010 =item cancel_if_expired [ NOW_TIMESTAMP ]
1012 Cancels this package if its expire date has been reached.
1016 sub cancel_if_expired {
1018 my $time = shift || time;
1019 return '' unless $self->expire && $self->expire <= $time;
1020 my $error = $self->cancel;
1022 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
1023 $self->custnum. ": $error";
1030 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
1031 locationnum, (other fields?). Attempts to re-provision cancelled services
1032 using history information (errors at this stage are not fatal).
1034 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
1036 svc_fatal: service provisioning errors are fatal
1038 svc_errors: pass an array reference, will be filled in with any provisioning errors
1040 main_pkgnum: link the package as a supplemental package of this one. For
1046 my( $self, %options ) = @_;
1048 #in case you try do do $uncancel-date = $cust_pkg->uncacel
1049 return '' unless $self->get('cancel');
1051 if ( $self->main_pkgnum and !$options{'main_pkgnum'} ) {
1052 return $self->main_pkg->uncancel(%options);
1059 my $oldAutoCommit = $FS::UID::AutoCommit;
1060 local $FS::UID::AutoCommit = 0;
1064 # insert the new package
1067 my $cust_pkg = new FS::cust_pkg {
1068 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
1069 bill => ( $options{'bill'} || $self->get('bill') ),
1071 uncancel_pkgnum => $self->pkgnum,
1072 main_pkgnum => ($options{'main_pkgnum'} || ''),
1073 map { $_ => $self->get($_) } qw(
1074 custnum pkgpart locationnum
1076 susp adjourn resume expire start_date contract_end dundate
1077 change_date change_pkgpart change_locationnum
1078 manual_flag no_auto separate_bill quantity agent_pkgid
1079 recur_show_zero setup_show_zero
1083 my $error = $cust_pkg->insert(
1084 'change' => 1, #supresses any referral credit to a referring customer
1085 'allow_pkgpart' => 1, # allow this even if the package def is disabled
1088 $dbh->rollback if $oldAutoCommit;
1096 #find historical services within this timeframe before the package cancel
1097 # (incompatible with "time" option to cust_pkg->cancel?)
1098 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
1099 # too little? (unprovisioing export delay?)
1100 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
1101 my @h_cust_svc = $self->h_cust_svc( $end, $start );
1104 foreach my $h_cust_svc (@h_cust_svc) {
1105 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
1106 #next unless $h_svc_x; #should this happen?
1107 (my $table = $h_svc_x->table) =~ s/^h_//;
1108 require "FS/$table.pm";
1109 my $class = "FS::$table";
1110 my $svc_x = $class->new( {
1111 'pkgnum' => $cust_pkg->pkgnum,
1112 'svcpart' => $h_cust_svc->svcpart,
1113 map { $_ => $h_svc_x->get($_) } fields($table)
1117 if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
1118 $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
1121 my $svc_error = $svc_x->insert;
1123 if ( $options{svc_fatal} ) {
1124 $dbh->rollback if $oldAutoCommit;
1127 # if we've failed to insert the svc_x object, svc_Common->insert
1128 # will have removed the cust_svc already. if not, then both records
1129 # were inserted but we failed for some other reason (export, most
1130 # likely). in that case, report the error and delete the records.
1131 push @svc_errors, $svc_error;
1132 my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1134 # except if export_insert failed, export_delete probably won't be
1136 local $FS::svc_Common::noexport_hack = 1;
1137 my $cleanup_error = $svc_x->delete; # also deletes cust_svc
1138 if ( $cleanup_error ) { # and if THAT fails, then run away
1139 $dbh->rollback if $oldAutoCommit;
1140 return $cleanup_error;
1145 } #foreach $h_cust_svc
1147 #these are pretty rare, but should handle them
1148 # - dsl_device (mac addresses)
1149 # - phone_device (mac addresses)
1150 # - dsl_note (ikano notes)
1151 # - domain_record (i.e. restore DNS information w/domains)
1152 # - inventory_item(?) (inventory w/un-cancelling service?)
1153 # - nas (svc_broaband nas stuff)
1154 #this stuff is unused in the wild afaik
1155 # - mailinglistmember
1157 # - svc_domain.parent_svcnum?
1158 # - acct_snarf (ancient mail fetching config)
1159 # - cgp_rule (communigate)
1160 # - cust_svc_option (used by our Tron stuff)
1161 # - acct_rt_transaction (used by our time worked stuff)
1164 # also move over any services that didn't unprovision at cancellation
1167 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1168 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1169 my $error = $cust_svc->replace;
1171 $dbh->rollback if $oldAutoCommit;
1177 # Uncancel any supplemental packages, and make them supplemental to the
1181 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1183 $error = $supp_pkg->uncancel(%options, 'main_pkgnum' => $cust_pkg->pkgnum);
1185 $dbh->rollback if $oldAutoCommit;
1186 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1194 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1196 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1197 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1204 Cancels any pending expiration (sets the expire field to null).
1206 If there is an error, returns the error, otherwise returns false.
1211 my( $self, %options ) = @_;
1214 my $oldAutoCommit = $FS::UID::AutoCommit;
1215 local $FS::UID::AutoCommit = 0;
1218 my $old = $self->select_for_update;
1220 my $pkgnum = $old->pkgnum;
1221 if ( $old->get('cancel') || $self->get('cancel') ) {
1222 dbh->rollback if $oldAutoCommit;
1223 return "Can't unexpire cancelled package $pkgnum";
1224 # or at least it's pointless
1227 unless ( $old->get('expire') && $self->get('expire') ) {
1228 dbh->rollback if $oldAutoCommit;
1229 return ""; # no error
1232 my %hash = $self->hash;
1233 $hash{'expire'} = '';
1234 my $new = new FS::cust_pkg ( \%hash );
1235 $error = $new->replace( $self, options => { $self->options } );
1237 $dbh->rollback if $oldAutoCommit;
1241 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1247 =item suspend [ OPTION => VALUE ... ]
1249 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1250 package, then suspends the package itself (sets the susp field to now).
1252 Available options are:
1256 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1257 either a reasonnum of an existing reason, or passing a hashref will create
1258 a new reason. The hashref should have the following keys:
1259 - typenum - Reason type (see L<FS::reason_type>
1260 - reason - Text of the new reason.
1262 =item date - can be set to a unix style timestamp to specify when to
1265 =item time - can be set to override the current time, for calculation
1266 of final invoices or unused-time credits
1268 =item resume_date - can be set to a time when the package should be
1269 unsuspended. This may be more convenient than calling C<unsuspend()>
1272 =item from_main - allows a supplemental package to be suspended, rather
1273 than redirecting the method call to its main package. For internal use.
1275 =item from_cancel - used when suspending from the cancel method, forces
1276 this to skip everything besides basic suspension. For internal use.
1280 If there is an error, returns the error, otherwise returns false.
1285 my( $self, %options ) = @_;
1288 # pass all suspend/cancel actions to the main package
1289 if ( $self->main_pkgnum and !$options{'from_main'} ) {
1290 return $self->main_pkg->suspend(%options);
1293 my $oldAutoCommit = $FS::UID::AutoCommit;
1294 local $FS::UID::AutoCommit = 0;
1297 my $old = $self->select_for_update;
1299 my $pkgnum = $old->pkgnum;
1300 if ( $old->get('cancel') || $self->get('cancel') ) {
1301 dbh->rollback if $oldAutoCommit;
1302 return "Can't suspend cancelled package $pkgnum";
1305 if ( $old->get('susp') || $self->get('susp') ) {
1306 dbh->rollback if $oldAutoCommit;
1307 return ""; # no error # complain on adjourn?
1310 my $suspend_time = $options{'time'} || time;
1311 my $date = $options{date} if $options{date}; # adjourn/suspend later
1312 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1314 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1315 dbh->rollback if $oldAutoCommit;
1316 return "Package $pkgnum expires before it would be suspended.";
1319 # some false laziness with sub cancel
1320 if ( !$options{nobill} && !$date && !$options{'from_cancel'} &&
1321 $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1322 # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1323 # make the entire cust_main->bill path recognize 'suspend' and
1324 # 'cancel' separately.
1325 warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1326 my $copy = $self->new({$self->hash});
1328 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1330 'time' => $suspend_time );
1331 warn "Error billing during suspend, custnum ".
1332 #$self->cust_main->custnum. ": $error"
1337 my $cust_pkg_reason;
1338 if ( $options{'reason'} ) {
1339 $error = $self->insert_reason( 'reason' => $options{'reason'},
1340 'action' => $date ? 'adjourn' : 'suspend',
1341 'date' => $date ? $date : $suspend_time,
1342 'reason_otaker' => $options{'reason_otaker'},
1345 dbh->rollback if $oldAutoCommit;
1346 return "Error inserting cust_pkg_reason: $error";
1348 $cust_pkg_reason = qsearchs('cust_pkg_reason', {
1349 'date' => $date ? $date : $suspend_time,
1350 'action' => $date ? 'A' : 'S',
1351 'pkgnum' => $self->pkgnum,
1355 # if a reasonnum was passed, get the actual reason object so we can check
1357 # (passing a reason hashref is still allowed, but it can't be used with
1358 # the fancy behavioral options.)
1361 if ($options{'reason'} =~ /^\d+$/) {
1362 $reason = FS::reason->by_key($options{'reason'});
1365 my %hash = $self->hash;
1367 $hash{'adjourn'} = $date;
1369 $hash{'susp'} = $suspend_time;
1372 my $resume_date = $options{'resume_date'} || 0;
1373 if ( $resume_date > ($date || $suspend_time) ) {
1374 $hash{'resume'} = $resume_date;
1377 $options{options} ||= {};
1379 my $new = new FS::cust_pkg ( \%hash );
1380 $error = $new->replace( $self, options => { $self->options,
1381 %{ $options{options} },
1385 $dbh->rollback if $oldAutoCommit;
1389 unless ( $date ) { # then we are suspending now
1391 unless ($options{'from_cancel'}) {
1392 # credit remaining time if appropriate
1393 # (if required by the package def, or the suspend reason)
1394 my $unused_credit = $self->part_pkg->option('unused_credit_suspend',1)
1395 || ( defined($reason) && $reason->unused_credit );
1397 if ( $unused_credit ) {
1398 warn "crediting unused time on pkg#".$self->pkgnum."\n" if $DEBUG;
1399 my $error = $self->credit_remaining('suspend', $suspend_time);
1401 $dbh->rollback if $oldAutoCommit;
1409 foreach my $cust_svc (
1410 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1412 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1414 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1415 $dbh->rollback if $oldAutoCommit;
1416 return "Illegal svcdb value in part_svc!";
1419 require "FS/$svcdb.pm";
1421 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1423 $error = $svc->suspend;
1425 $dbh->rollback if $oldAutoCommit;
1428 my( $label, $value ) = $cust_svc->label;
1429 push @labels, "$label: $value";
1433 # suspension fees: if there is a feepart, and it's not an unsuspend fee,
1434 # and this is not a suspend-before-cancel
1435 if ( $cust_pkg_reason ) {
1436 my $reason_obj = $cust_pkg_reason->reason;
1437 if ( $reason_obj->feepart and
1438 ! $reason_obj->fee_on_unsuspend and
1439 ! $options{'from_cancel'} ) {
1441 # register the need to charge a fee, cust_main->bill will do the rest
1442 warn "registering suspend fee: pkgnum ".$self->pkgnum.", feepart ".$reason->feepart."\n"
1444 my $cust_pkg_reason_fee = FS::cust_pkg_reason_fee->new({
1445 'pkgreasonnum' => $cust_pkg_reason->num,
1446 'pkgnum' => $self->pkgnum,
1447 'feepart' => $reason->feepart,
1448 'nextbill' => $reason->fee_hold,
1450 $error ||= $cust_pkg_reason_fee->insert;
1454 my $conf = new FS::Conf;
1455 if ( $conf->config('suspend_email_admin') && !$options{'from_cancel'} ) {
1457 my $error = send_email(
1458 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1459 #invoice_from ??? well as good as any
1460 'to' => $conf->config('suspend_email_admin'),
1461 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1463 "This is an automatic message from your Freeside installation\n",
1464 "informing you that the following customer package has been suspended:\n",
1466 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1467 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1468 ( map { "Service : $_\n" } @labels ),
1470 'custnum' => $self->custnum,
1471 'msgtype' => 'admin'
1475 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1483 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1484 $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1486 $dbh->rollback if $oldAutoCommit;
1487 return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1491 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1496 =item credit_remaining MODE TIME
1498 Generate a credit for this package for the time remaining in the current
1499 billing period. MODE is either "suspend" or "cancel" (determines the
1500 credit type). TIME is the time of suspension/cancellation. Both arguments
1505 # Implementation note:
1507 # If you pkgpart-change a package that has been billed, and it's set to give
1508 # credit on package change, then this method gets called and then the new
1509 # package will have no last_bill date. Therefore the customer will be credited
1510 # only once (per billing period) even if there are multiple package changes.
1512 # If you location-change a package that has been billed, this method will NOT
1513 # be called and the new package WILL have the last bill date of the old
1516 # If the new package is then canceled within the same billing cycle,
1517 # credit_remaining needs to run calc_remain on the OLD package to determine
1518 # the amount of unused time to credit.
1520 sub credit_remaining {
1521 # Add a credit for remaining service
1522 my ($self, $mode, $time) = @_;
1523 die 'credit_remaining requires suspend or cancel'
1524 unless $mode eq 'suspend' or $mode eq 'cancel';
1525 die 'no suspend/cancel time' unless $time > 0;
1527 my $conf = FS::Conf->new;
1528 my $reason_type = $conf->config($mode.'_credit_type');
1530 my $last_bill = $self->getfield('last_bill') || 0;
1531 my $next_bill = $self->getfield('bill') || 0;
1532 if ( $last_bill > 0 # the package has been billed
1533 and $next_bill > 0 # the package has a next bill date
1534 and $next_bill >= $time # which is in the future
1536 my @cust_credit_source_bill_pkg = ();
1537 my $remaining_value = 0;
1539 my $remain_pkg = $self;
1540 $remaining_value = $remain_pkg->calc_remain(
1542 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1545 # we may have to walk back past some package changes to get to the
1546 # one that actually has unused time
1547 while ( $remaining_value == 0 ) {
1548 if ( $remain_pkg->change_pkgnum ) {
1549 $remain_pkg = FS::cust_pkg->by_key($remain_pkg->change_pkgnum);
1551 # the package has really never been billed
1554 $remaining_value = $remain_pkg->calc_remain(
1556 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1560 if ( $remaining_value > 0 ) {
1561 warn "Crediting for $remaining_value on package ".$self->pkgnum."\n"
1563 my $error = $self->cust_main->credit(
1565 'Credit for unused time on '. $self->part_pkg->pkg,
1566 'reason_type' => $reason_type,
1567 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1569 return "Error crediting customer \$$remaining_value for unused time".
1570 " on ". $self->part_pkg->pkg. ": $error"
1572 } #if $remaining_value
1573 } #if $last_bill, etc.
1577 =item unsuspend [ OPTION => VALUE ... ]
1579 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1580 package, then unsuspends the package itself (clears the susp field and the
1581 adjourn field if it is in the past). If the suspend reason includes an
1582 unsuspension package, that package will be ordered.
1584 Available options are:
1590 Can be set to a date to unsuspend the package in the future (the 'resume'
1593 =item adjust_next_bill
1595 Can be set true to adjust the next bill date forward by
1596 the amount of time the account was inactive. This was set true by default
1597 in the past (from 1.4.2 and 1.5.0pre6 through 1.7.0), but now needs to be
1598 explicitly requested with this option or in the price plan.
1602 If there is an error, returns the error, otherwise returns false.
1607 my( $self, %opt ) = @_;
1610 # pass all suspend/cancel actions to the main package
1611 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1612 return $self->main_pkg->unsuspend(%opt);
1615 my $oldAutoCommit = $FS::UID::AutoCommit;
1616 local $FS::UID::AutoCommit = 0;
1619 my $old = $self->select_for_update;
1621 my $pkgnum = $old->pkgnum;
1622 if ( $old->get('cancel') || $self->get('cancel') ) {
1623 $dbh->rollback if $oldAutoCommit;
1624 return "Can't unsuspend cancelled package $pkgnum";
1627 unless ( $old->get('susp') && $self->get('susp') ) {
1628 $dbh->rollback if $oldAutoCommit;
1629 return ""; # no error # complain instead?
1632 # handle the case of setting a future unsuspend (resume) date
1633 # and do not continue to actually unsuspend the package
1634 my $date = $opt{'date'};
1635 if ( $date and $date > time ) { # return an error if $date <= time?
1637 if ( $old->get('expire') && $old->get('expire') < $date ) {
1638 $dbh->rollback if $oldAutoCommit;
1639 return "Package $pkgnum expires before it would be unsuspended.";
1642 my $new = new FS::cust_pkg { $self->hash };
1643 $new->set('resume', $date);
1644 $error = $new->replace($self, options => $self->options);
1647 $dbh->rollback if $oldAutoCommit;
1651 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1657 if (!$self->setup) {
1658 # then this package is being released from on-hold status
1659 $self->set_initial_timers;
1664 foreach my $cust_svc (
1665 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1667 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1669 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1670 $dbh->rollback if $oldAutoCommit;
1671 return "Illegal svcdb value in part_svc!";
1674 require "FS/$svcdb.pm";
1676 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1678 $error = $svc->unsuspend;
1680 $dbh->rollback if $oldAutoCommit;
1683 my( $label, $value ) = $cust_svc->label;
1684 push @labels, "$label: $value";
1689 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1690 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1692 my %hash = $self->hash;
1693 my $inactive = time - $hash{'susp'};
1695 my $conf = new FS::Conf;
1697 #adjust the next bill date forward
1698 # increment next bill date if certain conditions are met:
1699 # - it was due to be billed at some point
1700 # - either the global or local config says to do this
1701 my $adjust_bill = 0;
1704 && ( $hash{'bill'} || $hash{'setup'} )
1705 && ( $opt{'adjust_next_bill'}
1706 || $conf->exists('unsuspend-always_adjust_next_bill_date')
1707 || $self->part_pkg->option('unsuspend_adjust_bill', 1)
1714 # - the package billed during suspension
1715 # - or it was ordered on hold
1716 # - or the customer was credited for the unused time
1718 if ( $self->option('suspend_bill',1)
1719 or ( $self->part_pkg->option('suspend_bill',1)
1720 and ! $self->option('no_suspend_bill',1)
1722 or $hash{'order_date'} == $hash{'susp'}
1727 if ( $adjust_bill ) {
1728 if ( $self->part_pkg->option('unused_credit_suspend')
1729 or ( ref($reason) and $reason->unused_credit ) ) {
1730 # then the customer was credited for the unused time before suspending,
1731 # so their next bill should be immediate
1732 $hash{'bill'} = time;
1734 # add the length of time suspended to the bill date
1735 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
1740 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1741 $hash{'resume'} = '' if !$hash{'adjourn'};
1742 my $new = new FS::cust_pkg ( \%hash );
1743 $error = $new->replace( $self, options => { $self->options } );
1745 $dbh->rollback if $oldAutoCommit;
1752 if ( $reason->unsuspend_pkgpart ) {
1753 warn "Suspend reason '".$reason->reason."' uses deprecated unsuspend_pkgpart feature.\n";
1754 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
1755 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
1757 my $start_date = $self->cust_main->next_bill_date
1758 if $reason->unsuspend_hold;
1761 $unsusp_pkg = FS::cust_pkg->new({
1762 'custnum' => $self->custnum,
1763 'pkgpart' => $reason->unsuspend_pkgpart,
1764 'start_date' => $start_date,
1765 'locationnum' => $self->locationnum,
1766 # discount? probably not...
1769 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
1772 # new way, using fees
1773 if ( $reason->feepart and $reason->fee_on_unsuspend ) {
1774 # register the need to charge a fee, cust_main->bill will do the rest
1775 warn "registering unsuspend fee: pkgnum ".$self->pkgnum.", feepart ".$reason->feepart."\n"
1777 my $cust_pkg_reason_fee = FS::cust_pkg_reason_fee->new({
1778 'pkgreasonnum' => $cust_pkg_reason->num,
1779 'pkgnum' => $self->pkgnum,
1780 'feepart' => $reason->feepart,
1781 'nextbill' => $reason->fee_hold,
1783 $error ||= $cust_pkg_reason_fee->insert;
1787 $dbh->rollback if $oldAutoCommit;
1792 if ( $conf->config('unsuspend_email_admin') ) {
1794 my $error = send_email(
1795 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1796 #invoice_from ??? well as good as any
1797 'to' => $conf->config('unsuspend_email_admin'),
1798 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
1799 "This is an automatic message from your Freeside installation\n",
1800 "informing you that the following customer package has been unsuspended:\n",
1802 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1803 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1804 ( map { "Service : $_\n" } @labels ),
1806 "An unsuspension fee was charged: ".
1807 $unsusp_pkg->part_pkg->pkg_comment."\n"
1811 'custnum' => $self->custnum,
1812 'msgtype' => 'admin',
1816 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
1822 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1823 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
1825 $dbh->rollback if $oldAutoCommit;
1826 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1830 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1837 Cancels any pending suspension (sets the adjourn field to null).
1839 If there is an error, returns the error, otherwise returns false.
1844 my( $self, %options ) = @_;
1847 my $oldAutoCommit = $FS::UID::AutoCommit;
1848 local $FS::UID::AutoCommit = 0;
1851 my $old = $self->select_for_update;
1853 my $pkgnum = $old->pkgnum;
1854 if ( $old->get('cancel') || $self->get('cancel') ) {
1855 dbh->rollback if $oldAutoCommit;
1856 return "Can't unadjourn cancelled package $pkgnum";
1857 # or at least it's pointless
1860 if ( $old->get('susp') || $self->get('susp') ) {
1861 dbh->rollback if $oldAutoCommit;
1862 return "Can't unadjourn suspended package $pkgnum";
1863 # perhaps this is arbitrary
1866 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1867 dbh->rollback if $oldAutoCommit;
1868 return ""; # no error
1871 my %hash = $self->hash;
1872 $hash{'adjourn'} = '';
1873 $hash{'resume'} = '';
1874 my $new = new FS::cust_pkg ( \%hash );
1875 $error = $new->replace( $self, options => { $self->options } );
1877 $dbh->rollback if $oldAutoCommit;
1881 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1888 =item change HASHREF | OPTION => VALUE ...
1890 Changes this package: cancels it and creates a new one, with a different
1891 pkgpart or locationnum or both. All services are transferred to the new
1892 package (no change will be made if this is not possible).
1894 Options may be passed as a list of key/value pairs or as a hash reference.
1901 New locationnum, to change the location for this package.
1905 New FS::cust_location object, to create a new location and assign it
1910 New FS::cust_main object, to create a new customer and assign the new package
1915 New pkgpart (see L<FS::part_pkg>).
1919 New refnum (see L<FS::part_referral>).
1923 New quantity; if unspecified, the new package will have the same quantity
1928 "New" (existing) FS::cust_pkg object. The package's services and other
1929 attributes will be transferred to this package.
1933 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1934 susp, adjourn, cancel, expire, and contract_end) to the new package.
1936 =item unprotect_svcs
1938 Normally, change() will rollback and return an error if some services
1939 can't be transferred (also see the I<cust_pkg-change_svcpart> config option).
1940 If unprotect_svcs is true, this method will transfer as many services as
1941 it can and then unconditionally cancel the old package.
1945 At least one of locationnum, cust_location, pkgpart, refnum, cust_main, or
1946 cust_pkg must be specified (otherwise, what's the point?)
1948 Returns either the new FS::cust_pkg object or a scalar error.
1952 my $err_or_new_cust_pkg = $old_cust_pkg->change
1956 #some false laziness w/order
1959 my $opt = ref($_[0]) ? shift : { @_ };
1961 my $conf = new FS::Conf;
1963 # Transactionize this whole mess
1964 my $oldAutoCommit = $FS::UID::AutoCommit;
1965 local $FS::UID::AutoCommit = 0;
1970 if ( $opt->{'cust_location'} ) {
1971 $error = $opt->{'cust_location'}->find_or_insert;
1973 $dbh->rollback if $oldAutoCommit;
1974 return "creating location record: $error";
1976 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1979 # Before going any further here: if the package is still in the pre-setup
1980 # state, it's safe to modify it in place. No need to charge/credit for
1981 # partial period, transfer services, transfer usage pools, copy invoice
1982 # details, or change any dates.
1983 if ( ! $self->setup and ! $opt->{cust_pkg} and ! $opt->{cust_main} ) {
1984 foreach ( qw( locationnum pkgpart quantity refnum salesnum ) ) {
1985 if ( length($opt->{$_}) ) {
1986 $self->set($_, $opt->{$_});
1989 # almost. if the new pkgpart specifies start/adjourn/expire timers,
1991 if ( $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart ) {
1992 $self->set_initial_timers;
1994 $error = $self->replace;
1996 $dbh->rollback if $oldAutoCommit;
1997 return "modifying package: $error";
1999 $dbh->commit if $oldAutoCommit;
2008 $hash{'setup'} = $time if $self->setup;
2010 $hash{'change_date'} = $time;
2011 $hash{"change_$_"} = $self->$_()
2012 foreach qw( pkgnum pkgpart locationnum );
2014 if ( $opt->{'cust_pkg'} ) {
2015 # treat changing to a package with a different pkgpart as a
2016 # pkgpart change (because it is)
2017 $opt->{'pkgpart'} = $opt->{'cust_pkg'}->pkgpart;
2020 # whether to override pkgpart checking on the new package
2021 my $same_pkgpart = 1;
2022 if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
2026 my $unused_credit = 0;
2027 my $keep_dates = $opt->{'keep_dates'};
2029 # Special case. If the pkgpart is changing, and the customer is
2030 # going to be credited for remaining time, don't keep setup, bill,
2031 # or last_bill dates, and DO pass the flag to cancel() to credit
2033 if ( $opt->{'pkgpart'}
2034 and $opt->{'pkgpart'} != $self->pkgpart
2035 and $self->part_pkg->option('unused_credit_change', 1) ) {
2038 $hash{$_} = '' foreach qw(setup bill last_bill);
2041 if ( $keep_dates ) {
2042 foreach my $date ( qw(setup bill last_bill) ) {
2043 $hash{$date} = $self->getfield($date);
2046 # always keep the following dates
2047 foreach my $date (qw(order_date susp adjourn cancel expire resume
2048 start_date contract_end)) {
2049 $hash{$date} = $self->getfield($date);
2052 # allow $opt->{'locationnum'} = '' to specifically set it to null
2053 # (i.e. customer default location)
2054 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2056 # usually this doesn't matter. the two cases where it does are:
2057 # 1. unused_credit_change + pkgpart change + setup fee on the new package
2059 # 2. (more importantly) changing a package before it's billed
2060 $hash{'waive_setup'} = $self->waive_setup;
2062 # if this package is scheduled for a future package change, preserve that
2063 $hash{'change_to_pkgnum'} = $self->change_to_pkgnum;
2065 my $custnum = $self->custnum;
2066 if ( $opt->{cust_main} ) {
2067 my $cust_main = $opt->{cust_main};
2068 unless ( $cust_main->custnum ) {
2069 my $error = $cust_main->insert( @{ $opt->{cust_main_insert_args}||[] } );
2071 $dbh->rollback if $oldAutoCommit;
2072 return "inserting customer record: $error";
2075 $custnum = $cust_main->custnum;
2078 $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
2081 if ( $opt->{'cust_pkg'} ) {
2082 # The target package already exists; update it to show that it was
2083 # changed from this package.
2084 $cust_pkg = $opt->{'cust_pkg'};
2086 # follow all the above rules for date changes, etc.
2087 foreach (keys %hash) {
2088 $cust_pkg->set($_, $hash{$_});
2090 # except those that implement the future package change behavior
2091 foreach (qw(change_to_pkgnum start_date expire)) {
2092 $cust_pkg->set($_, '');
2095 $error = $cust_pkg->replace;
2098 # Create the new package.
2099 $cust_pkg = new FS::cust_pkg {
2100 custnum => $custnum,
2101 locationnum => $opt->{'locationnum'},
2102 ( map { $_ => ( $opt->{$_} || $self->$_() ) }
2103 qw( pkgpart quantity refnum salesnum )
2107 $error = $cust_pkg->insert( 'change' => 1,
2108 'allow_pkgpart' => $same_pkgpart );
2111 $dbh->rollback if $oldAutoCommit;
2112 return "inserting new package: $error";
2115 # Transfer services and cancel old package.
2116 # Enforce service limits only if this is a pkgpart change.
2117 local $FS::cust_svc::ignore_quantity;
2118 $FS::cust_svc::ignore_quantity = 1 if $same_pkgpart;
2119 $error = $self->transfer($cust_pkg);
2120 if ($error and $error == 0) {
2121 # $old_pkg->transfer failed.
2122 $dbh->rollback if $oldAutoCommit;
2123 return "transferring $error";
2126 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2127 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2128 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
2129 if ($error and $error == 0) {
2130 # $old_pkg->transfer failed.
2131 $dbh->rollback if $oldAutoCommit;
2132 return "converting $error";
2136 # We set unprotect_svcs when executing a "future package change". It's
2137 # not a user-interactive operation, so returning an error means the
2138 # package change will just fail. Rather than have that happen, we'll
2139 # let leftover services be deleted.
2140 if ($error > 0 and !$opt->{'unprotect_svcs'}) {
2141 # Transfers were successful, but we still had services left on the old
2142 # package. We can't change the package under this circumstances, so abort.
2143 $dbh->rollback if $oldAutoCommit;
2144 return "unable to transfer all services";
2147 #reset usage if changing pkgpart
2148 # AND usage rollover is off (otherwise adds twice, now and at package bill)
2149 if ($self->pkgpart != $cust_pkg->pkgpart) {
2150 my $part_pkg = $cust_pkg->part_pkg;
2151 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
2155 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
2158 $dbh->rollback if $oldAutoCommit;
2159 return "setting usage values: $error";
2162 # if NOT changing pkgpart, transfer any usage pools over
2163 foreach my $usage ($self->cust_pkg_usage) {
2164 $usage->set('pkgnum', $cust_pkg->pkgnum);
2165 $error = $usage->replace;
2167 $dbh->rollback if $oldAutoCommit;
2168 return "transferring usage pools: $error";
2173 # transfer usage pricing add-ons, if we're not changing pkgpart
2174 if ( $same_pkgpart ) {
2175 foreach my $old_cust_pkg_usageprice ($self->cust_pkg_usageprice) {
2176 my $new_cust_pkg_usageprice = new FS::cust_pkg_usageprice {
2177 'pkgnum' => $cust_pkg->pkgnum,
2178 'usagepricepart' => $old_cust_pkg_usageprice->usagepricepart,
2179 'quantity' => $old_cust_pkg_usageprice->quantity,
2181 $error = $new_cust_pkg_usageprice->insert;
2183 $dbh->rollback if $oldAutoCommit;
2184 return "Error transferring usage pricing add-on: $error";
2189 # transfer discounts, if we're not changing pkgpart
2190 if ( $same_pkgpart ) {
2191 foreach my $old_discount ($self->cust_pkg_discount_active) {
2192 # don't remove the old discount, we may still need to bill that package.
2193 my $new_discount = new FS::cust_pkg_discount {
2194 'pkgnum' => $cust_pkg->pkgnum,
2195 'discountnum' => $old_discount->discountnum,
2196 'months_used' => $old_discount->months_used,
2198 $error = $new_discount->insert;
2200 $dbh->rollback if $oldAutoCommit;
2201 return "transferring discounts: $error";
2206 # transfer (copy) invoice details
2207 foreach my $detail ($self->cust_pkg_detail) {
2208 my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
2209 $new_detail->set('pkgdetailnum', '');
2210 $new_detail->set('pkgnum', $cust_pkg->pkgnum);
2211 $error = $new_detail->insert;
2213 $dbh->rollback if $oldAutoCommit;
2214 return "transferring package notes: $error";
2220 if ( !$opt->{'cust_pkg'} ) {
2221 # Order any supplemental packages.
2222 my $part_pkg = $cust_pkg->part_pkg;
2223 my @old_supp_pkgs = $self->supplemental_pkgs;
2224 foreach my $link ($part_pkg->supp_part_pkg_link) {
2226 foreach (@old_supp_pkgs) {
2227 if ($_->pkgpart == $link->dst_pkgpart) {
2229 $_->pkgpart(0); # so that it can't match more than once
2233 # false laziness with FS::cust_main::Packages::order_pkg
2234 my $new = FS::cust_pkg->new({
2235 pkgpart => $link->dst_pkgpart,
2236 pkglinknum => $link->pkglinknum,
2237 custnum => $custnum,
2238 main_pkgnum => $cust_pkg->pkgnum,
2239 locationnum => $cust_pkg->locationnum,
2240 start_date => $cust_pkg->start_date,
2241 order_date => $cust_pkg->order_date,
2242 expire => $cust_pkg->expire,
2243 adjourn => $cust_pkg->adjourn,
2244 contract_end => $cust_pkg->contract_end,
2245 refnum => $cust_pkg->refnum,
2246 discountnum => $cust_pkg->discountnum,
2247 waive_setup => $cust_pkg->waive_setup,
2249 if ( $old and $opt->{'keep_dates'} ) {
2250 foreach (qw(setup bill last_bill)) {
2251 $new->set($_, $old->get($_));
2254 $error = $new->insert( allow_pkgpart => $same_pkgpart );
2257 $error ||= $old->transfer($new);
2259 if ( $error and $error > 0 ) {
2260 # no reason why this should ever fail, but still...
2261 $error = "Unable to transfer all services from supplemental package ".
2265 $dbh->rollback if $oldAutoCommit;
2268 push @new_supp_pkgs, $new;
2270 } # if !$opt->{'cust_pkg'}
2271 # because if there is one, then supplemental packages would already
2272 # have been created for it.
2274 #Good to go, cancel old package. Notify 'cancel' of whether to credit
2276 #Don't allow billing the package (preceding period packages and/or
2277 #outstanding usage) if we are keeping dates (i.e. location changing),
2278 #because the new package will be billed for the same date range.
2279 #Supplemental packages are also canceled here.
2281 # during scheduled changes, avoid canceling the package we just
2283 $self->set('change_to_pkgnum' => '');
2285 $error = $self->cancel(
2287 unused_credit => $unused_credit,
2288 nobill => $keep_dates,
2289 change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2290 no_delay_cancel => 1,
2293 $dbh->rollback if $oldAutoCommit;
2294 return "canceling old package: $error";
2297 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2299 my $error = $cust_pkg->cust_main->bill(
2300 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2303 $dbh->rollback if $oldAutoCommit;
2304 return "billing new package: $error";
2308 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2314 =item change_later OPTION => VALUE...
2316 Schedule a package change for a later date. This actually orders the new
2317 package immediately, but sets its start date for a future date, and sets
2318 the current package to expire on the same date.
2320 If the package is already scheduled for a change, this can be called with
2321 'start_date' to change the scheduled date, or with pkgpart and/or
2322 locationnum to modify the package change. To cancel the scheduled change
2323 entirely, see C<abort_change>.
2331 The date for the package change. Required, and must be in the future.
2339 The pkgpart. locationnum, and quantity of the new package, with the same
2340 meaning as in C<change>.
2348 my $opt = ref($_[0]) ? shift : { @_ };
2350 my $oldAutoCommit = $FS::UID::AutoCommit;
2351 local $FS::UID::AutoCommit = 0;
2354 my $cust_main = $self->cust_main;
2356 my $date = delete $opt->{'start_date'} or return 'start_date required';
2358 if ( $date <= time ) {
2359 $dbh->rollback if $oldAutoCommit;
2360 return "start_date $date is in the past";
2365 if ( $self->change_to_pkgnum ) {
2366 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
2367 my $new_pkgpart = $opt->{'pkgpart'}
2368 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $change_to->pkgpart;
2369 my $new_locationnum = $opt->{'locationnum'}
2370 if $opt->{'locationnum'} and $opt->{'locationnum'} != $change_to->locationnum;
2371 my $new_quantity = $opt->{'quantity'}
2372 if $opt->{'quantity'} and $opt->{'quantity'} != $change_to->quantity;
2373 if ( $new_pkgpart or $new_locationnum or $new_quantity ) {
2374 # it hasn't been billed yet, so in principle we could just edit
2375 # it in place (w/o a package change), but that's bad form.
2376 # So change the package according to the new options...
2377 my $err_or_pkg = $change_to->change(%$opt);
2378 if ( ref $err_or_pkg ) {
2379 # Then set that package up for a future start.
2380 $self->set('change_to_pkgnum', $err_or_pkg->pkgnum);
2381 $self->set('expire', $date); # in case it's different
2382 $err_or_pkg->set('start_date', $date);
2383 $err_or_pkg->set('change_date', '');
2384 $err_or_pkg->set('change_pkgnum', '');
2386 $error = $self->replace ||
2387 $err_or_pkg->replace ||
2388 $change_to->cancel('no_delay_cancel' => 1) ||
2391 $error = $err_or_pkg;
2393 } else { # change the start date only.
2394 $self->set('expire', $date);
2395 $change_to->set('start_date', $date);
2396 $error = $self->replace || $change_to->replace;
2399 $dbh->rollback if $oldAutoCommit;
2402 $dbh->commit if $oldAutoCommit;
2405 } # if $self->change_to_pkgnum
2407 my $new_pkgpart = $opt->{'pkgpart'}
2408 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2409 my $new_locationnum = $opt->{'locationnum'}
2410 if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2411 my $new_quantity = $opt->{'quantity'}
2412 if $opt->{'quantity'} and $opt->{'quantity'} != $self->quantity;
2414 return '' unless $new_pkgpart or $new_locationnum or $new_quantity; # wouldn't do anything
2416 # allow $opt->{'locationnum'} = '' to specifically set it to null
2417 # (i.e. customer default location)
2418 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2420 my $new = FS::cust_pkg->new( {
2421 custnum => $self->custnum,
2422 locationnum => $opt->{'locationnum'},
2423 start_date => $date,
2424 map { $_ => ( $opt->{$_} || $self->$_() ) }
2425 qw( pkgpart quantity refnum salesnum )
2427 $error = $new->insert('change' => 1,
2428 'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2430 $self->set('change_to_pkgnum', $new->pkgnum);
2431 $self->set('expire', $date);
2432 $error = $self->replace;
2435 $dbh->rollback if $oldAutoCommit;
2437 $dbh->commit if $oldAutoCommit;
2445 Cancels a future package change scheduled by C<change_later>.
2451 my $pkgnum = $self->change_to_pkgnum;
2452 my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
2455 $error = $change_to->cancel || $change_to->delete;
2456 return $error if $error;
2458 $self->set('change_to_pkgnum', '');
2459 $self->set('expire', '');
2463 =item set_quantity QUANTITY
2465 Change the package's quantity field. This is one of the few package properties
2466 that can safely be changed without canceling and reordering the package
2467 (because it doesn't affect tax eligibility). Returns an error or an
2474 $self = $self->replace_old; # just to make sure
2475 $self->quantity(shift);
2479 =item set_salesnum SALESNUM
2481 Change the package's salesnum (sales person) field. This is one of the few
2482 package properties that can safely be changed without canceling and reordering
2483 the package (because it doesn't affect tax eligibility). Returns an error or
2490 $self = $self->replace_old; # just to make sure
2491 $self->salesnum(shift);
2493 # XXX this should probably reassign any credit that's already been given
2496 =item modify_charge OPTIONS
2498 Change the properties of a one-time charge. The following properties can
2499 be changed this way:
2500 - pkg: the package description
2501 - classnum: the package class
2502 - additional: arrayref of additional invoice details to add to this package
2504 and, I<if the charge has not yet been billed>:
2505 - start_date: the date when it will be billed
2506 - amount: the setup fee to be charged
2507 - quantity: the multiplier for the setup fee
2508 - separate_bill: whether to put the charge on a separate invoice
2510 If you pass 'adjust_commission' => 1, and the classnum changes, and there are
2511 commission credits linked to this charge, they will be recalculated.
2518 my $part_pkg = $self->part_pkg;
2519 my $pkgnum = $self->pkgnum;
2522 my $oldAutoCommit = $FS::UID::AutoCommit;
2523 local $FS::UID::AutoCommit = 0;
2525 return "Can't use modify_charge except on one-time charges"
2526 unless $part_pkg->freq eq '0';
2528 if ( length($opt{'pkg'}) and $part_pkg->pkg ne $opt{'pkg'} ) {
2529 $part_pkg->set('pkg', $opt{'pkg'});
2532 my %pkg_opt = $part_pkg->options;
2533 my $pkg_opt_modified = 0;
2535 $opt{'additional'} ||= [];
2538 foreach (grep /^additional/, keys %pkg_opt) {
2539 ($i) = ($_ =~ /^additional_info(\d+)$/);
2540 $old_additional[$i] = $pkg_opt{$_} if $i;
2541 delete $pkg_opt{$_};
2544 for ( $i = 0; exists($opt{'additional'}->[$i]); $i++ ) {
2545 $pkg_opt{ "additional_info$i" } = $opt{'additional'}->[$i];
2546 if (!exists($old_additional[$i])
2547 or $old_additional[$i] ne $opt{'additional'}->[$i])
2549 $pkg_opt_modified = 1;
2552 $pkg_opt_modified = 1 if (scalar(@old_additional) - 1) != $i;
2553 $pkg_opt{'additional_count'} = $i if $i > 0;
2556 if ( exists($opt{'classnum'}) and $part_pkg->classnum ne $opt{'classnum'} )
2559 $old_classnum = $part_pkg->classnum;
2560 $part_pkg->set('classnum', $opt{'classnum'});
2563 if ( !$self->get('setup') ) {
2564 # not yet billed, so allow amount, setup_cost, quantity, start_date,
2567 if ( exists($opt{'amount'})
2568 and $part_pkg->option('setup_fee') != $opt{'amount'}
2569 and $opt{'amount'} > 0 ) {
2571 $pkg_opt{'setup_fee'} = $opt{'amount'};
2572 $pkg_opt_modified = 1;
2575 if ( exists($opt{'setup_cost'})
2576 and $part_pkg->setup_cost != $opt{'setup_cost'}
2577 and $opt{'setup_cost'} > 0 ) {
2579 $part_pkg->set('setup_cost', $opt{'setup_cost'});
2582 if ( exists($opt{'quantity'})
2583 and $opt{'quantity'} != $self->quantity
2584 and $opt{'quantity'} > 0 ) {
2586 $self->set('quantity', $opt{'quantity'});
2589 if ( exists($opt{'start_date'})
2590 and $opt{'start_date'} != $self->start_date ) {
2592 $self->set('start_date', $opt{'start_date'});
2595 if ( exists($opt{'separate_bill'})
2596 and $opt{'separate_bill'} ne $self->separate_bill ) {
2598 $self->set('separate_bill', $opt{'separate_bill'});
2602 } # else simply ignore them; the UI shouldn't allow editing the fields
2605 if ( exists($opt{'taxclass'})
2606 and $part_pkg->taxclass ne $opt{'taxclass'}) {
2608 $part_pkg->set('taxclass', $opt{'taxclass'});
2612 if ( $part_pkg->modified or $pkg_opt_modified ) {
2613 # can we safely modify the package def?
2614 # Yes, if it's not available for purchase, and this is the only instance
2616 if ( $part_pkg->disabled
2617 and FS::cust_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 1
2618 and FS::quotation_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 0
2620 $error = $part_pkg->replace( options => \%pkg_opt );
2623 $part_pkg = $part_pkg->clone;
2624 $part_pkg->set('disabled' => 'Y');
2625 $error = $part_pkg->insert( options => \%pkg_opt );
2626 # and associate this as yet-unbilled package to the new package def
2627 $self->set('pkgpart' => $part_pkg->pkgpart);
2630 $dbh->rollback if $oldAutoCommit;
2635 if ($self->modified) { # for quantity or start_date change, or if we had
2636 # to clone the existing package def
2637 my $error = $self->replace;
2638 return $error if $error;
2640 if (defined $old_classnum) {
2641 # fix invoice grouping records
2642 my $old_catname = $old_classnum
2643 ? FS::pkg_class->by_key($old_classnum)->categoryname
2645 my $new_catname = $opt{'classnum'}
2646 ? $part_pkg->pkg_class->categoryname
2648 if ( $old_catname ne $new_catname ) {
2649 foreach my $cust_bill_pkg ($self->cust_bill_pkg) {
2650 # (there should only be one...)
2651 my @display = qsearch( 'cust_bill_pkg_display', {
2652 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2653 'section' => $old_catname,
2655 foreach (@display) {
2656 $_->set('section', $new_catname);
2657 $error = $_->replace;
2659 $dbh->rollback if $oldAutoCommit;
2663 } # foreach $cust_bill_pkg
2666 if ( $opt{'adjust_commission'} ) {
2667 # fix commission credits...tricky.
2668 foreach my $cust_event ($self->cust_event) {
2669 my $part_event = $cust_event->part_event;
2670 foreach my $table (qw(sales agent)) {
2672 "FS::part_event::Action::Mixin::credit_${table}_pkg_class";
2673 my $credit = qsearchs('cust_credit', {
2674 'eventnum' => $cust_event->eventnum,
2676 if ( $part_event->isa($class) ) {
2677 # Yes, this results in current commission rates being applied
2678 # retroactively to a one-time charge. For accounting purposes
2679 # there ought to be some kind of time limit on doing this.
2680 my $amount = $part_event->_calc_credit($self);
2681 if ( $credit and $credit->amount ne $amount ) {
2682 # Void the old credit.
2683 $error = $credit->void('Package class changed');
2685 $dbh->rollback if $oldAutoCommit;
2686 return "$error (adjusting commission credit)";
2689 # redo the event action to recreate the credit.
2691 eval { $part_event->do_action( $self, $cust_event ) };
2693 $dbh->rollback if $oldAutoCommit;
2696 } # if $part_event->isa($class)
2698 } # foreach $cust_event
2699 } # if $opt{'adjust_commission'}
2700 } # if defined $old_classnum
2702 $dbh->commit if $oldAutoCommit;
2709 sub process_bulk_cust_pkg {
2712 warn Dumper($param) if $DEBUG;
2714 my $old_part_pkg = qsearchs('part_pkg',
2715 { pkgpart => $param->{'old_pkgpart'} });
2716 my $new_part_pkg = qsearchs('part_pkg',
2717 { pkgpart => $param->{'new_pkgpart'} });
2718 die "Must select a new package type\n" unless $new_part_pkg;
2719 #my $keep_dates = $param->{'keep_dates'} || 0;
2720 my $keep_dates = 1; # there is no good reason to turn this off
2722 my $oldAutoCommit = $FS::UID::AutoCommit;
2723 local $FS::UID::AutoCommit = 0;
2726 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
2729 foreach my $old_cust_pkg ( @cust_pkgs ) {
2731 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
2732 if ( $old_cust_pkg->getfield('cancel') ) {
2733 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
2734 $old_cust_pkg->pkgnum."\n"
2738 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
2740 my $error = $old_cust_pkg->change(
2741 'pkgpart' => $param->{'new_pkgpart'},
2742 'keep_dates' => $keep_dates
2744 if ( !ref($error) ) { # change returns the cust_pkg on success
2746 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
2749 $dbh->commit if $oldAutoCommit;
2755 Returns the last bill date, or if there is no last bill date, the setup date.
2756 Useful for billing metered services.
2762 return $self->setfield('last_bill', $_[0]) if @_;
2763 return $self->getfield('last_bill') if $self->getfield('last_bill');
2764 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
2765 'edate' => $self->bill, } );
2766 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
2769 =item last_cust_pkg_reason ACTION
2771 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
2772 Returns false if there is no reason or the package is not currenly ACTION'd
2773 ACTION is one of adjourn, susp, cancel, or expire.
2777 sub last_cust_pkg_reason {
2778 my ( $self, $action ) = ( shift, shift );
2779 my $date = $self->get($action);
2781 'table' => 'cust_pkg_reason',
2782 'hashref' => { 'pkgnum' => $self->pkgnum,
2783 'action' => substr(uc($action), 0, 1),
2786 'order_by' => 'ORDER BY num DESC LIMIT 1',
2790 =item last_reason ACTION
2792 Returns the most recent ACTION FS::reason associated with the package.
2793 Returns false if there is no reason or the package is not currenly ACTION'd
2794 ACTION is one of adjourn, susp, cancel, or expire.
2799 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
2800 $cust_pkg_reason->reason
2801 if $cust_pkg_reason;
2806 Returns the definition for this billing item, as an FS::part_pkg object (see
2813 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
2814 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
2815 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
2820 Returns the cancelled package this package was changed from, if any.
2826 return '' unless $self->change_pkgnum;
2827 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
2830 =item change_cust_main
2832 Returns the customter this package was detached to, if any.
2836 sub change_cust_main {
2838 return '' unless $self->change_custnum;
2839 qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
2844 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
2851 $self->part_pkg->calc_setup($self, @_);
2856 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
2863 $self->part_pkg->calc_recur($self, @_);
2868 Calls the I<base_setup> of the FS::part_pkg object associated with this billing
2875 $self->part_pkg->base_setup($self, @_);
2880 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
2887 $self->part_pkg->base_recur($self, @_);
2892 Calls the I<calc_remain> of the FS::part_pkg object associated with this
2899 $self->part_pkg->calc_remain($self, @_);
2904 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
2911 $self->part_pkg->calc_cancel($self, @_);
2916 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
2922 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
2925 =item cust_pkg_detail [ DETAILTYPE ]
2927 Returns any customer package details for this package (see
2928 L<FS::cust_pkg_detail>).
2930 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2934 sub cust_pkg_detail {
2936 my %hash = ( 'pkgnum' => $self->pkgnum );
2937 $hash{detailtype} = shift if @_;
2939 'table' => 'cust_pkg_detail',
2940 'hashref' => \%hash,
2941 'order_by' => 'ORDER BY weight, pkgdetailnum',
2945 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
2947 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
2949 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2951 If there is an error, returns the error, otherwise returns false.
2955 sub set_cust_pkg_detail {
2956 my( $self, $detailtype, @details ) = @_;
2958 my $oldAutoCommit = $FS::UID::AutoCommit;
2959 local $FS::UID::AutoCommit = 0;
2962 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
2963 my $error = $current->delete;
2965 $dbh->rollback if $oldAutoCommit;
2966 return "error removing old detail: $error";
2970 foreach my $detail ( @details ) {
2971 my $cust_pkg_detail = new FS::cust_pkg_detail {
2972 'pkgnum' => $self->pkgnum,
2973 'detailtype' => $detailtype,
2974 'detail' => $detail,
2976 my $error = $cust_pkg_detail->insert;
2978 $dbh->rollback if $oldAutoCommit;
2979 return "error adding new detail: $error";
2984 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2991 Returns the customer billing events (see L<FS::cust_event>) for this invoice.
2995 #false laziness w/cust_bill.pm
2999 'table' => 'cust_event',
3000 'addl_from' => 'JOIN part_event USING ( eventpart )',
3001 'hashref' => { 'tablenum' => $self->pkgnum },
3002 'extra_sql' => " AND eventtable = 'cust_pkg' ",
3006 =item num_cust_event
3008 Returns the number of customer billing events (see L<FS::cust_event>) for this package.
3012 #false laziness w/cust_bill.pm
3013 sub num_cust_event {
3015 my $sql = "SELECT COUNT(*) ". $self->_from_cust_event_where;
3016 $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref->[0];
3019 =item exists_cust_event
3021 Returns true if there are customer billing events (see L<FS::cust_event>) for this package. More efficient than using num_cust_event.
3025 sub exists_cust_event {
3027 my $sql = "SELECT 1 ". $self->_from_cust_event_where. " LIMIT 1";
3028 my $row = $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref;
3029 $row ? $row->[0] : '';
3032 sub _from_cust_event_where {
3034 " FROM cust_event JOIN part_event USING ( eventpart ) ".
3035 " WHERE tablenum = ? AND eventtable = 'cust_pkg' ";
3039 my( $self, $sql, @args ) = @_;
3040 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
3041 $sth->execute(@args) or die $sth->errstr. " executing $sql";
3045 =item part_pkg_currency_option OPTIONNAME
3047 Returns a two item list consisting of the currency of this customer, if any,
3048 and a value for the provided option. If the customer has a currency, the value
3049 is the option value the given name and the currency (see
3050 L<FS::part_pkg_currency>). Otherwise, if the customer has no currency, is the
3051 regular option value for the given name (see L<FS::part_pkg_option>).
3055 sub part_pkg_currency_option {
3056 my( $self, $optionname ) = @_;
3057 my $part_pkg = $self->part_pkg;
3058 if ( my $currency = $self->cust_main->currency ) {
3059 ($currency, $part_pkg->part_pkg_currency_option($currency, $optionname) );
3061 ('', $part_pkg->option($optionname) );
3065 =item cust_svc [ SVCPART ] (old, deprecated usage)
3067 =item cust_svc [ OPTION => VALUE ... ] (current usage)
3069 =item cust_svc_unsorted [ OPTION => VALUE ... ]
3071 Returns the services for this package, as FS::cust_svc objects (see
3072 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
3073 spcififed, returns only the matching services.
3075 As an optimization, use the cust_svc_unsorted version if you are not displaying
3082 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
3083 $self->_sort_cust_svc( $self->cust_svc_unsorted_arrayref(@_) );
3086 sub cust_svc_unsorted {
3088 @{ $self->cust_svc_unsorted_arrayref(@_) };
3091 sub cust_svc_unsorted_arrayref {
3094 return [] unless $self->num_cust_svc(@_);
3097 if ( @_ && $_[0] =~ /^\d+/ ) {
3098 $opt{svcpart} = shift;
3099 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3106 'table' => 'cust_svc',
3107 'hashref' => { 'pkgnum' => $self->pkgnum },
3109 if ( $opt{svcpart} ) {
3110 $search{hashref}->{svcpart} = $opt{'svcpart'};
3112 if ( $opt{'svcdb'} ) {
3113 $search{addl_from} = ' LEFT JOIN part_svc USING ( svcpart ) ';
3114 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{'svcdb'} );
3117 [ qsearch(\%search) ];
3121 =item overlimit [ SVCPART ]
3123 Returns the services for this package which have exceeded their
3124 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
3125 is specified, return only the matching services.
3131 return () unless $self->num_cust_svc(@_);
3132 grep { $_->overlimit } $self->cust_svc(@_);
3135 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3137 Returns historical services for this package created before END TIMESTAMP and
3138 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
3139 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
3140 I<pkg_svc.hidden> flag will be omitted.
3146 warn "$me _h_cust_svc called on $self\n"
3149 my ($end, $start, $mode) = @_;
3151 local($FS::Record::qsearch_qualify_columns) = 0;
3153 my @cust_svc = $self->_sort_cust_svc(
3154 [ qsearch( 'h_cust_svc',
3155 { 'pkgnum' => $self->pkgnum, },
3156 FS::h_cust_svc->sql_h_search(@_),
3160 if ( defined($mode) && $mode eq 'I' ) {
3161 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
3162 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
3168 sub _sort_cust_svc {
3169 my( $self, $arrayref ) = @_;
3172 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
3174 my %pkg_svc = map { $_->svcpart => $_ }
3175 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
3180 my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
3182 $pkg_svc ? $pkg_svc->primary_svc : '',
3183 $pkg_svc ? $pkg_svc->quantity : 0,
3190 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
3192 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
3194 Returns the number of services for this package. Available options are svcpart
3195 and svcdb. If either is spcififed, returns only the matching services.
3202 return $self->{'_num_cust_svc'}
3204 && exists($self->{'_num_cust_svc'})
3205 && $self->{'_num_cust_svc'} =~ /\d/;
3207 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
3211 if ( @_ && $_[0] =~ /^\d+/ ) {
3212 $opt{svcpart} = shift;
3213 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3219 my $select = 'SELECT COUNT(*) FROM cust_svc ';
3220 my $where = ' WHERE pkgnum = ? ';
3221 my @param = ($self->pkgnum);
3223 if ( $opt{'svcpart'} ) {
3224 $where .= ' AND svcpart = ? ';
3225 push @param, $opt{'svcpart'};
3227 if ( $opt{'svcdb'} ) {
3228 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
3229 $where .= ' AND svcdb = ? ';
3230 push @param, $opt{'svcdb'};
3233 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
3234 $sth->execute(@param) or die $sth->errstr;
3235 $sth->fetchrow_arrayref->[0];
3238 =item available_part_svc
3240 Returns a list of FS::part_svc objects representing services included in this
3241 package but not yet provisioned. Each FS::part_svc object also has an extra
3242 field, I<num_avail>, which specifies the number of available services.
3246 sub available_part_svc {
3249 my $pkg_quantity = $self->quantity || 1;
3251 grep { $_->num_avail > 0 }
3253 my $part_svc = $_->part_svc;
3254 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
3255 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
3257 # more evil encapsulation breakage
3258 if($part_svc->{'Hash'}{'num_avail'} > 0) {
3259 my @exports = $part_svc->part_export_did;
3260 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
3265 $self->part_pkg->pkg_svc;
3268 =item part_svc [ OPTION => VALUE ... ]
3270 Returns a list of FS::part_svc objects representing provisioned and available
3271 services included in this package. Each FS::part_svc object also has the
3272 following extra fields:
3286 (services) - array reference containing the provisioned services, as cust_svc objects
3290 Accepts two options:
3294 =item summarize_size
3296 If true, will omit the extra cust_pkg_svc option for objects where num_cust_svc
3297 is this size or greater.
3299 =item hide_discontinued
3301 If true, will omit looking for services that are no longer avaialble in the
3309 #label -> ($cust_svc->label)[1]
3315 my $pkg_quantity = $self->quantity || 1;
3317 #XXX some sort of sort order besides numeric by svcpart...
3318 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
3320 my $part_svc = $pkg_svc->part_svc;
3321 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3322 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
3323 $part_svc->{'Hash'}{'num_avail'} =
3324 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
3325 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3326 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
3327 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
3328 && $num_cust_svc >= $opt{summarize_size};
3329 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
3331 } $self->part_pkg->pkg_svc;
3333 unless ( $opt{hide_discontinued} ) {
3335 push @part_svc, map {
3337 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3338 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
3339 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
3340 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3341 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
3343 } $self->extra_part_svc;
3350 =item extra_part_svc
3352 Returns a list of FS::part_svc objects corresponding to services in this
3353 package which are still provisioned but not (any longer) available in the
3358 sub extra_part_svc {
3361 my $pkgnum = $self->pkgnum;
3362 #my $pkgpart = $self->pkgpart;
3365 # 'table' => 'part_svc',
3368 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
3369 # WHERE pkg_svc.svcpart = part_svc.svcpart
3370 # AND pkg_svc.pkgpart = ?
3373 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
3374 # LEFT JOIN cust_pkg USING ( pkgnum )
3375 # WHERE cust_svc.svcpart = part_svc.svcpart
3378 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
3381 #seems to benchmark slightly faster... (or did?)
3383 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
3384 my $pkgparts = join(',', @pkgparts);
3387 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
3388 #MySQL doesn't grok DISINCT ON
3389 'select' => 'DISTINCT part_svc.*',
3390 'table' => 'part_svc',
3392 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
3393 AND pkg_svc.pkgpart IN ($pkgparts)
3396 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
3397 LEFT JOIN cust_pkg USING ( pkgnum )
3400 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
3401 'extra_param' => [ [$self->pkgnum=>'int'] ],
3407 Returns a short status string for this package, currently:
3413 =item not yet billed
3415 =item one-time charge
3430 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
3432 return 'cancelled' if $self->get('cancel');
3433 return 'on hold' if $self->susp && ! $self->setup;
3434 return 'suspended' if $self->susp;
3435 return 'not yet billed' unless $self->setup;
3436 return 'one-time charge' if $freq =~ /^(0|$)/;
3440 =item ucfirst_status
3442 Returns the status with the first character capitalized.
3446 sub ucfirst_status {
3447 ucfirst(shift->status);
3452 Class method that returns the list of possible status strings for packages
3453 (see L<the status method|/status>). For example:
3455 @statuses = FS::cust_pkg->statuses();
3459 tie my %statuscolor, 'Tie::IxHash',
3460 'on hold' => 'FF00F5', #brighter purple!
3461 'not yet billed' => '009999', #teal? cyan?
3462 'one-time charge' => '0000CC', #blue #'000000',
3463 'active' => '00CC00',
3464 'suspended' => 'FF9900',
3465 'cancelled' => 'FF0000',
3469 my $self = shift; #could be class...
3470 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
3471 # # mayble split btw one-time vs. recur
3482 Returns a hex triplet color string for this package's status.
3488 $statuscolor{$self->status};
3491 =item is_status_delay_cancel
3493 Returns true if part_pkg has option delay_cancel,
3494 cust_pkg status is 'suspended' and expire is set
3495 to cancel package within the next day (or however
3496 many days are set in global config part_pkg-delay_cancel-days.
3498 Accepts option I<part_pkg-delay_cancel-days> which should be
3499 the value of the config setting, to avoid looking it up again.
3501 This is not a real status, this only meant for hacking display
3502 values, because otherwise treating the package as suspended is
3503 really the whole point of the delay_cancel option.
3507 sub is_status_delay_cancel {
3508 my ($self,%opt) = @_;
3509 if ( $self->main_pkgnum and $self->pkglinknum ) {
3510 return $self->main_pkg->is_status_delay_cancel;
3512 return 0 unless $self->part_pkg->option('delay_cancel',1);
3513 return 0 unless $self->status eq 'suspended';
3514 return 0 unless $self->expire;
3515 my $expdays = $opt{'part_pkg-delay_cancel-days'};
3517 my $conf = new FS::Conf;
3518 $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
3520 my $expsecs = 60*60*24*$expdays;
3521 return 0 unless $self->expire < time + $expsecs;
3527 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
3528 "pkg - comment" depending on user preference).
3534 my $label = $self->part_pkg->pkg_comment( cust_pkg=>$self, nopkgpart=>1 );
3535 $label = $self->pkgnum. ": $label"
3536 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
3540 =item pkg_label_long
3542 Returns a long label for this package, adding the primary service's label to
3547 sub pkg_label_long {
3549 my $label = $self->pkg_label;
3550 my $cust_svc = $self->primary_cust_svc;
3551 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
3557 Returns a customer-localized label for this package.
3563 $self->part_pkg->pkg_locale( $self->cust_main->locale );
3566 =item primary_cust_svc
3568 Returns a primary service (as FS::cust_svc object) if one can be identified.
3572 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
3574 sub primary_cust_svc {
3577 my @cust_svc = $self->cust_svc;
3579 return '' unless @cust_svc; #no serivces - irrelevant then
3581 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
3583 # primary service as specified in the package definition
3584 # or exactly one service definition with quantity one
3585 my $svcpart = $self->part_pkg->svcpart;
3586 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
3587 return $cust_svc[0] if scalar(@cust_svc) == 1;
3589 #couldn't identify one thing..
3595 Returns a list of lists, calling the label method for all services
3596 (see L<FS::cust_svc>) of this billing item.
3602 map { [ $_->label ] } $self->cust_svc;
3605 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3607 Like the labels method, but returns historical information on services that
3608 were active as of END_TIMESTAMP and (optionally) not cancelled before
3609 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
3610 I<pkg_svc.hidden> flag will be omitted.
3612 Returns a list of lists, calling the label method for all (historical) services
3613 (see L<FS::h_cust_svc>) of this billing item.
3619 warn "$me _h_labels called on $self\n"
3621 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
3626 Like labels, except returns a simple flat list, and shortens long
3627 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3628 identical services to one line that lists the service label and the number of
3629 individual services rather than individual items.
3634 shift->_labels_short( 'labels', @_ );
3637 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
3639 Like h_labels, except returns a simple flat list, and shortens long
3640 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3641 identical services to one line that lists the service label and the number of
3642 individual services rather than individual items.
3646 sub h_labels_short {
3647 shift->_labels_short( 'h_labels', @_ );
3651 my( $self, $method ) = ( shift, shift );
3653 warn "$me _labels_short called on $self with $method method\n"
3656 my $conf = new FS::Conf;
3657 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
3659 warn "$me _labels_short populating \%labels\n"
3663 #tie %labels, 'Tie::IxHash';
3664 push @{ $labels{$_->[0]} }, $_->[1]
3665 foreach $self->$method(@_);
3667 warn "$me _labels_short populating \@labels\n"
3671 foreach my $label ( keys %labels ) {
3673 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
3674 my $num = scalar(@values);
3675 warn "$me _labels_short $num items for $label\n"
3678 if ( $num > $max_same_services ) {
3679 warn "$me _labels_short more than $max_same_services, so summarizing\n"
3681 push @labels, "$label ($num)";
3683 if ( $conf->exists('cust_bill-consolidate_services') ) {
3684 warn "$me _labels_short consolidating services\n"
3686 # push @labels, "$label: ". join(', ', @values);
3688 my $detail = "$label: ";
3689 $detail .= shift(@values). ', '
3691 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
3693 push @labels, $detail;
3695 warn "$me _labels_short done consolidating services\n"
3698 warn "$me _labels_short adding service data\n"
3700 push @labels, map { "$label: $_" } @values;
3711 Returns the parent customer object (see L<FS::cust_main>).
3715 Returns the balance for this specific package, when using
3716 experimental package balance.
3722 $self->cust_main->balance_pkgnum( $self->pkgnum );
3725 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
3729 Returns the location object, if any (see L<FS::cust_location>).
3731 =item cust_location_or_main
3733 If this package is associated with a location, returns the locaiton (see
3734 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
3736 =item location_label [ OPTION => VALUE ... ]
3738 Returns the label of the location object (see L<FS::cust_location>).
3742 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
3744 =item tax_locationnum
3746 Returns the foreign key to a L<FS::cust_location> object for calculating
3747 tax on this package, as determined by the C<tax-pkg_address> and
3748 C<tax-ship_address> configuration flags.
3752 sub tax_locationnum {
3754 my $conf = FS::Conf->new;
3755 if ( $conf->exists('tax-pkg_address') ) {
3756 return $self->locationnum;
3758 elsif ( $conf->exists('tax-ship_address') ) {
3759 return $self->cust_main->ship_locationnum;
3762 return $self->cust_main->bill_locationnum;
3768 Returns the L<FS::cust_location> object for tax_locationnum.
3774 my $conf = FS::Conf->new;
3775 if ( $conf->exists('tax-pkg_address') and $self->locationnum ) {
3776 return FS::cust_location->by_key($self->locationnum);
3778 elsif ( $conf->exists('tax-ship_address') ) {
3779 return $self->cust_main->ship_location;
3782 return $self->cust_main->bill_location;
3786 =item seconds_since TIMESTAMP
3788 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
3789 package have been online since TIMESTAMP, according to the session monitor.
3791 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
3792 L<Time::Local> and L<Date::Parse> for conversion functions.
3797 my($self, $since) = @_;
3800 foreach my $cust_svc (
3801 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
3803 $seconds += $cust_svc->seconds_since($since);
3810 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
3812 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
3813 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
3816 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3817 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3823 sub seconds_since_sqlradacct {
3824 my($self, $start, $end) = @_;
3828 foreach my $cust_svc (
3830 my $part_svc = $_->part_svc;
3831 $part_svc->svcdb eq 'svc_acct'
3832 && scalar($part_svc->part_export_usage);
3835 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
3842 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
3844 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
3845 in this package for sessions ending between TIMESTAMP_START (inclusive) and
3849 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3850 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3855 sub attribute_since_sqlradacct {
3856 my($self, $start, $end, $attrib) = @_;
3860 foreach my $cust_svc (
3862 my $part_svc = $_->part_svc;
3863 scalar($part_svc->part_export_usage);
3866 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
3878 my( $self, $value ) = @_;
3879 if ( defined($value) ) {
3880 $self->setfield('quantity', $value);
3882 $self->getfield('quantity') || 1;
3885 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
3887 Transfers as many services as possible from this package to another package.
3889 The destination package can be specified by pkgnum by passing an FS::cust_pkg
3890 object. The destination package must already exist.
3892 Services are moved only if the destination allows services with the correct
3893 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
3894 this option with caution! No provision is made for export differences
3895 between the old and new service definitions. Probably only should be used
3896 when your exports for all service definitions of a given svcdb are identical.
3897 (attempt a transfer without it first, to move all possible svcpart-matching
3900 Any services that can't be moved remain in the original package.
3902 Returns an error, if there is one; otherwise, returns the number of services
3903 that couldn't be moved.
3908 my ($self, $dest_pkgnum, %opt) = @_;
3914 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
3915 $dest = $dest_pkgnum;
3916 $dest_pkgnum = $dest->pkgnum;
3918 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
3921 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
3923 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
3924 $target{$pkg_svc->svcpart} = $pkg_svc->quantity * ( $dest->quantity || 1 );
3927 foreach my $cust_svc ($dest->cust_svc) {
3928 $target{$cust_svc->svcpart}--;
3931 my %svcpart2svcparts = ();
3932 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3933 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
3934 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
3935 next if exists $svcpart2svcparts{$svcpart};
3936 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
3937 $svcpart2svcparts{$svcpart} = [
3939 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
3941 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
3942 'svcpart' => $_ } );
3944 $pkg_svc ? $pkg_svc->primary_svc : '',
3945 $pkg_svc ? $pkg_svc->quantity : 0,
3949 grep { $_ != $svcpart }
3951 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
3953 warn "alternates for svcpart $svcpart: ".
3954 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
3960 foreach my $cust_svc ($self->cust_svc) {
3961 my $svcnum = $cust_svc->svcnum;
3962 if($target{$cust_svc->svcpart} > 0
3963 or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
3964 $target{$cust_svc->svcpart}--;
3965 my $new = new FS::cust_svc { $cust_svc->hash };
3966 $new->pkgnum($dest_pkgnum);
3967 $error = $new->replace($cust_svc);
3968 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3970 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
3971 warn "alternates to consider: ".
3972 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
3974 my @alternate = grep {
3975 warn "considering alternate svcpart $_: ".
3976 "$target{$_} available in new package\n"
3979 } @{$svcpart2svcparts{$cust_svc->svcpart}};
3981 warn "alternate(s) found\n" if $DEBUG;
3982 my $change_svcpart = $alternate[0];
3983 $target{$change_svcpart}--;
3984 my $new = new FS::cust_svc { $cust_svc->hash };
3985 $new->svcpart($change_svcpart);
3986 $new->pkgnum($dest_pkgnum);
3987 $error = $new->replace($cust_svc);
3995 my @label = $cust_svc->label;
3996 return "$label[0] $label[1]: $error";
4002 =item grab_svcnums SVCNUM, SVCNUM ...
4004 Change the pkgnum for the provided services to this packages. If there is an
4005 error, returns the error, otherwise returns false.
4013 my $oldAutoCommit = $FS::UID::AutoCommit;
4014 local $FS::UID::AutoCommit = 0;
4017 foreach my $svcnum (@svcnum) {
4018 my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
4019 $dbh->rollback if $oldAutoCommit;
4020 return "unknown svcnum $svcnum";
4022 $cust_svc->pkgnum( $self->pkgnum );
4023 my $error = $cust_svc->replace;
4025 $dbh->rollback if $oldAutoCommit;
4030 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4037 This method is deprecated. See the I<depend_jobnum> option to the insert and
4038 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
4042 #looks like this is still used by the order_pkg and change_pkg methods in
4043 # ClientAPI/MyAccount, need to look into those before removing
4047 my $oldAutoCommit = $FS::UID::AutoCommit;
4048 local $FS::UID::AutoCommit = 0;
4051 foreach my $cust_svc ( $self->cust_svc ) {
4052 #false laziness w/svc_Common::insert
4053 my $svc_x = $cust_svc->svc_x;
4054 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
4055 my $error = $part_export->export_insert($svc_x);
4057 $dbh->rollback if $oldAutoCommit;
4063 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4068 =item export_pkg_change OLD_CUST_PKG
4070 Calls the "pkg_change" export action for all services attached to this package.
4074 sub export_pkg_change {
4075 my( $self, $old ) = ( shift, shift );
4077 my $oldAutoCommit = $FS::UID::AutoCommit;
4078 local $FS::UID::AutoCommit = 0;
4081 foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
4082 my $error = $svc_x->export('pkg_change', $self, $old);
4084 $dbh->rollback if $oldAutoCommit;
4089 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4096 Associates this package with a (suspension or cancellation) reason (see
4097 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
4100 Available options are:
4106 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.
4110 the access_user (see L<FS::access_user>) providing the reason
4118 the action (cancel, susp, adjourn, expire) associated with the reason
4122 If there is an error, returns the error, otherwise returns false.
4127 my ($self, %options) = @_;
4129 my $otaker = $options{reason_otaker} ||
4130 $FS::CurrentUser::CurrentUser->username;
4133 if ( $options{'reason'} =~ /^(\d+)$/ ) {
4137 } elsif ( ref($options{'reason'}) ) {
4139 return 'Enter a new reason (or select an existing one)'
4140 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
4142 my $reason = new FS::reason({
4143 'reason_type' => $options{'reason'}->{'typenum'},
4144 'reason' => $options{'reason'}->{'reason'},
4146 my $error = $reason->insert;
4147 return $error if $error;
4149 $reasonnum = $reason->reasonnum;
4152 return "Unparseable reason: ". $options{'reason'};
4155 my $cust_pkg_reason =
4156 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
4157 'reasonnum' => $reasonnum,
4158 'otaker' => $otaker,
4159 'action' => substr(uc($options{'action'}),0,1),
4160 'date' => $options{'date'}
4165 $cust_pkg_reason->insert;
4168 =item insert_discount
4170 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
4171 inserting a new discount on the fly (see L<FS::discount>).
4173 Available options are:
4181 If there is an error, returns the error, otherwise returns false.
4185 sub insert_discount {
4186 #my ($self, %options) = @_;
4189 my $cust_pkg_discount = new FS::cust_pkg_discount {
4190 'pkgnum' => $self->pkgnum,
4191 'discountnum' => $self->discountnum,
4193 'end_date' => '', #XXX
4194 #for the create a new discount case
4195 '_type' => $self->discountnum__type,
4196 'amount' => $self->discountnum_amount,
4197 'percent' => $self->discountnum_percent,
4198 'months' => $self->discountnum_months,
4199 'setup' => $self->discountnum_setup,
4200 #'disabled' => $self->discountnum_disabled,
4203 $cust_pkg_discount->insert;
4206 =item set_usage USAGE_VALUE_HASHREF
4208 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4209 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4210 upbytes, downbytes, and totalbytes are appropriate keys.
4212 All svc_accts which are part of this package have their values reset.
4217 my ($self, $valueref, %opt) = @_;
4219 #only svc_acct can set_usage for now
4220 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4221 my $svc_x = $cust_svc->svc_x;
4222 $svc_x->set_usage($valueref, %opt)
4223 if $svc_x->can("set_usage");
4227 =item recharge USAGE_VALUE_HASHREF
4229 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4230 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4231 upbytes, downbytes, and totalbytes are appropriate keys.
4233 All svc_accts which are part of this package have their values incremented.
4238 my ($self, $valueref) = @_;
4240 #only svc_acct can set_usage for now
4241 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4242 my $svc_x = $cust_svc->svc_x;
4243 $svc_x->recharge($valueref)
4244 if $svc_x->can("recharge");
4248 =item apply_usageprice
4252 sub apply_usageprice {
4255 my $oldAutoCommit = $FS::UID::AutoCommit;
4256 local $FS::UID::AutoCommit = 0;
4261 foreach my $cust_pkg_usageprice ( $self->cust_pkg_usageprice ) {
4262 $error ||= $cust_pkg_usageprice->apply;
4266 $dbh->rollback if $oldAutoCommit;
4267 die "error applying part_pkg_usageprice add-ons, pkgnum ". $self->pkgnum.
4270 $dbh->commit if $oldAutoCommit;
4276 =item cust_pkg_discount
4278 =item cust_pkg_discount_active
4282 sub cust_pkg_discount_active {
4284 grep { $_->status eq 'active' } $self->cust_pkg_discount;
4287 =item cust_pkg_usage
4289 Returns a list of all voice usage counters attached to this package.
4291 =item apply_usage OPTIONS
4293 Takes the following options:
4294 - cdr: a call detail record (L<FS::cdr>)
4295 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
4296 - minutes: the maximum number of minutes to be charged
4298 Finds available usage minutes for a call of this class, and subtracts
4299 up to that many minutes from the usage pool. If the usage pool is empty,
4300 and the C<cdr-minutes_priority> global config option is set, minutes may
4301 be taken from other calls as well. Either way, an allocation record will
4302 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
4303 number of minutes of usage applied to the call.
4308 my ($self, %opt) = @_;
4309 my $cdr = $opt{cdr};
4310 my $rate_detail = $opt{rate_detail};
4311 my $minutes = $opt{minutes};
4312 my $classnum = $rate_detail->classnum;
4313 my $pkgnum = $self->pkgnum;
4314 my $custnum = $self->custnum;
4316 my $oldAutoCommit = $FS::UID::AutoCommit;
4317 local $FS::UID::AutoCommit = 0;
4320 my $order = FS::Conf->new->config('cdr-minutes_priority');
4324 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
4326 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
4328 my @usage_recs = qsearch({
4329 'table' => 'cust_pkg_usage',
4330 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
4331 ' JOIN cust_pkg USING (pkgnum)'.
4332 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
4333 'select' => 'cust_pkg_usage.*',
4334 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
4335 " ( cust_pkg.custnum = $custnum AND ".
4336 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4337 $is_classnum . ' AND '.
4338 " cust_pkg_usage.minutes > 0",
4339 'order_by' => " ORDER BY priority ASC",
4342 my $orig_minutes = $minutes;
4344 while (!$error and $minutes > 0 and @usage_recs) {
4345 my $cust_pkg_usage = shift @usage_recs;
4346 $cust_pkg_usage->select_for_update;
4347 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
4348 pkgusagenum => $cust_pkg_usage->pkgusagenum,
4349 acctid => $cdr->acctid,
4350 minutes => min($cust_pkg_usage->minutes, $minutes),
4352 $cust_pkg_usage->set('minutes',
4353 $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes
4355 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
4356 $minutes -= $cdr_cust_pkg_usage->minutes;
4358 if ( $order and $minutes > 0 and !$error ) {
4359 # then try to steal minutes from another call
4361 'table' => 'cdr_cust_pkg_usage',
4362 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
4363 ' JOIN part_pkg_usage USING (pkgusagepart)'.
4364 ' JOIN cust_pkg USING (pkgnum)'.
4365 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
4366 ' JOIN cdr USING (acctid)',
4367 'select' => 'cdr_cust_pkg_usage.*',
4368 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
4369 " ( cust_pkg.pkgnum = $pkgnum OR ".
4370 " ( cust_pkg.custnum = $custnum AND ".
4371 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4372 " part_pkg_usage_class.classnum = $classnum",
4373 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
4375 if ( $order eq 'time' ) {
4376 # find CDRs that are using minutes, but have a later startdate
4378 my $startdate = $cdr->startdate;
4379 if ($startdate !~ /^\d+$/) {
4380 die "bad cdr startdate '$startdate'";
4382 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
4383 # minimize needless reshuffling
4384 $search{'order_by'} .= ', cdr.startdate DESC';
4386 # XXX may not work correctly with rate_time schedules. Could
4387 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
4389 $search{'addl_from'} .=
4390 ' JOIN rate_detail'.
4391 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
4392 if ( $order eq 'rate_high' ) {
4393 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
4394 $rate_detail->min_charge;
4395 $search{'order_by'} .= ', rate_detail.min_charge ASC';
4396 } elsif ( $order eq 'rate_low' ) {
4397 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
4398 $rate_detail->min_charge;
4399 $search{'order_by'} .= ', rate_detail.min_charge DESC';
4401 # this should really never happen
4402 die "invalid cdr-minutes_priority value '$order'\n";
4405 my @cdr_usage_recs = qsearch(\%search);
4407 while (!$error and @cdr_usage_recs and $minutes > 0) {
4408 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
4409 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
4410 my $old_cdr = $cdr_cust_pkg_usage->cdr;
4411 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
4412 $cdr_cust_pkg_usage->select_for_update;
4413 $old_cdr->select_for_update;
4414 $cust_pkg_usage->select_for_update;
4415 # in case someone else stole the usage from this CDR
4416 # while waiting for the lock...
4417 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
4418 # steal the usage allocation and flag the old CDR for reprocessing
4419 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
4420 # if the allocation is more minutes than we need, adjust it...
4421 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
4423 $cdr_cust_pkg_usage->set('minutes', $minutes);
4424 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
4425 $error = $cust_pkg_usage->replace;
4427 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
4428 $error ||= $cdr_cust_pkg_usage->replace;
4429 # deduct the stolen minutes
4430 $minutes -= $cdr_cust_pkg_usage->minutes;
4432 # after all minute-stealing is done, reset the affected CDRs
4433 foreach (values %reproc_cdrs) {
4434 $error ||= $_->set_status('');
4435 # XXX or should we just call $cdr->rate right here?
4436 # it's not like we can create a loop this way, since the min_charge
4437 # or call time has to go monotonically in one direction.
4438 # we COULD get some very deep recursions going, though...
4440 } # if $order and $minutes
4443 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
4445 $dbh->commit if $oldAutoCommit;
4446 return $orig_minutes - $minutes;
4450 =item supplemental_pkgs
4452 Returns a list of all packages supplemental to this one.
4456 sub supplemental_pkgs {
4458 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
4463 Returns the package that this one is supplemental to, if any.
4469 if ( $self->main_pkgnum ) {
4470 return FS::cust_pkg->by_key($self->main_pkgnum);
4477 =head1 CLASS METHODS
4483 Returns an SQL expression identifying recurring packages.
4487 sub recurring_sql { "
4488 '0' != ( select freq from part_pkg
4489 where cust_pkg.pkgpart = part_pkg.pkgpart )
4494 Returns an SQL expression identifying one-time packages.
4499 '0' = ( select freq from part_pkg
4500 where cust_pkg.pkgpart = part_pkg.pkgpart )
4505 Returns an SQL expression identifying ordered packages (recurring packages not
4511 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
4516 Returns an SQL expression identifying active packages.
4521 $_[0]->recurring_sql. "
4522 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4523 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4524 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4527 =item not_yet_billed_sql
4529 Returns an SQL expression identifying packages which have not yet been billed.
4533 sub not_yet_billed_sql { "
4534 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4535 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4536 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4541 Returns an SQL expression identifying inactive packages (one-time packages
4542 that are otherwise unsuspended/uncancelled).
4546 sub inactive_sql { "
4547 ". $_[0]->onetime_sql(). "
4548 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4549 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4550 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4555 Returns an SQL expression identifying on-hold packages.
4560 #$_[0]->recurring_sql(). ' AND '.
4562 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4563 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4564 AND ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4571 Returns an SQL expression identifying suspended packages.
4575 sub suspended_sql { susp_sql(@_); }
4577 #$_[0]->recurring_sql(). ' AND '.
4579 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4580 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4581 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4588 Returns an SQL exprression identifying cancelled packages.
4592 sub cancelled_sql { cancel_sql(@_); }
4594 #$_[0]->recurring_sql(). ' AND '.
4595 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
4600 Returns an SQL expression to give the package status as a string.
4606 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
4607 WHEN ( cust_pkg.susp IS NOT NULL AND cust_pkg.setup IS NULL ) THEN 'on hold'
4608 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
4609 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
4610 WHEN ".onetime_sql()." THEN 'one-time charge'
4617 Returns a list of two package counts. The first is a count of packages
4618 based on the supplied criteria and the second is the count of residential
4619 packages with those same criteria. Criteria are specified as in the search
4625 my ($class, $params) = @_;
4627 my $sql_query = $class->search( $params );
4629 my $count_sql = delete($sql_query->{'count_query'});
4630 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
4631 or die "couldn't parse count_sql";
4633 my $count_sth = dbh->prepare($count_sql)
4634 or die "Error preparing $count_sql: ". dbh->errstr;
4636 or die "Error executing $count_sql: ". $count_sth->errstr;
4637 my $count_arrayref = $count_sth->fetchrow_arrayref;
4639 return ( @$count_arrayref );
4643 =item tax_locationnum_sql
4645 Returns an SQL expression for the tax location for a package, based
4646 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
4650 sub tax_locationnum_sql {
4651 my $conf = FS::Conf->new;
4652 if ( $conf->exists('tax-pkg_address') ) {
4653 'cust_pkg.locationnum';
4655 elsif ( $conf->exists('tax-ship_address') ) {
4656 'cust_main.ship_locationnum';
4659 'cust_main.bill_locationnum';
4665 Returns a list: the first item is an SQL fragment identifying matching
4666 packages/customers via location (taking into account shipping and package
4667 address taxation, if enabled), and subsequent items are the parameters to
4668 substitute for the placeholders in that fragment.
4673 my($class, %opt) = @_;
4674 my $ornull = $opt{'ornull'};
4676 my $conf = new FS::Conf;
4678 # '?' placeholders in _location_sql_where
4679 my $x = $ornull ? 3 : 2;
4690 if ( $conf->exists('tax-ship_address') ) {
4693 ( ( ship_last IS NULL OR ship_last = '' )
4694 AND ". _location_sql_where('cust_main', '', $ornull ). "
4696 OR ( ship_last IS NOT NULL AND ship_last != ''
4697 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
4700 # AND payby != 'COMP'
4702 @main_param = ( @bill_param, @bill_param );
4706 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
4707 @main_param = @bill_param;
4713 if ( $conf->exists('tax-pkg_address') ) {
4715 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
4718 ( cust_pkg.locationnum IS NULL AND $main_where )
4719 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
4722 @param = ( @main_param, @bill_param );
4726 $where = $main_where;
4727 @param = @main_param;
4735 #subroutine, helper for location_sql
4736 sub _location_sql_where {
4738 my $prefix = @_ ? shift : '';
4739 my $ornull = @_ ? shift : '';
4741 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
4743 $ornull = $ornull ? ' OR ? IS NULL ' : '';
4745 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
4746 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
4747 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
4749 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
4751 # ( $table.${prefix}city = ? $or_empty_city $ornull )
4753 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4754 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4755 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
4756 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
4757 AND $table.${prefix}country = ?
4762 my( $self, $what ) = @_;
4764 my $what_show_zero = $what. '_show_zero';
4765 length($self->$what_show_zero())
4766 ? ($self->$what_show_zero() eq 'Y')
4767 : $self->part_pkg->$what_show_zero();
4774 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
4776 Bulk cancel + order subroutine. Perhaps slightly deprecated, only used by the
4777 bulk cancel+order in the web UI and nowhere else (edit/process/cust_pkg.cgi)
4779 CUSTNUM is a customer (see L<FS::cust_main>)
4781 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4782 L<FS::part_pkg>) to order for this customer. Duplicates are of course
4785 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
4786 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
4787 new billing items. An error is returned if this is not possible (see
4788 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
4791 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4792 newly-created cust_pkg objects.
4794 REFNUM, if specified, will specify the FS::pkg_referral record to be created
4795 and inserted. Multiple FS::pkg_referral records can be created by
4796 setting I<refnum> to an array reference of refnums or a hash reference with
4797 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
4798 record will be created corresponding to cust_main.refnum.
4803 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
4805 my $conf = new FS::Conf;
4807 # Transactionize this whole mess
4808 my $oldAutoCommit = $FS::UID::AutoCommit;
4809 local $FS::UID::AutoCommit = 0;
4813 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
4814 # return "Customer not found: $custnum" unless $cust_main;
4816 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
4819 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4822 my $change = scalar(@old_cust_pkg) != 0;
4825 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
4827 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
4828 " to pkgpart ". $pkgparts->[0]. "\n"
4831 my $err_or_cust_pkg =
4832 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
4833 'refnum' => $refnum,
4836 unless (ref($err_or_cust_pkg)) {
4837 $dbh->rollback if $oldAutoCommit;
4838 return $err_or_cust_pkg;
4841 push @$return_cust_pkg, $err_or_cust_pkg;
4842 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4847 # Create the new packages.
4848 foreach my $pkgpart (@$pkgparts) {
4850 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
4852 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
4853 pkgpart => $pkgpart,
4857 $error = $cust_pkg->insert( 'change' => $change );
4858 push @$return_cust_pkg, $cust_pkg;
4860 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
4861 my $supp_pkg = FS::cust_pkg->new({
4862 custnum => $custnum,
4863 pkgpart => $link->dst_pkgpart,
4865 main_pkgnum => $cust_pkg->pkgnum,
4868 $error ||= $supp_pkg->insert( 'change' => $change );
4869 push @$return_cust_pkg, $supp_pkg;
4873 $dbh->rollback if $oldAutoCommit;
4878 # $return_cust_pkg now contains refs to all of the newly
4881 # Transfer services and cancel old packages.
4882 foreach my $old_pkg (@old_cust_pkg) {
4884 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
4887 foreach my $new_pkg (@$return_cust_pkg) {
4888 $error = $old_pkg->transfer($new_pkg);
4889 if ($error and $error == 0) {
4890 # $old_pkg->transfer failed.
4891 $dbh->rollback if $oldAutoCommit;
4896 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
4897 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
4898 foreach my $new_pkg (@$return_cust_pkg) {
4899 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
4900 if ($error and $error == 0) {
4901 # $old_pkg->transfer failed.
4902 $dbh->rollback if $oldAutoCommit;
4909 # Transfers were successful, but we went through all of the
4910 # new packages and still had services left on the old package.
4911 # We can't cancel the package under the circumstances, so abort.
4912 $dbh->rollback if $oldAutoCommit;
4913 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
4915 $error = $old_pkg->cancel( quiet=>1, 'no_delay_cancel'=>1 );
4921 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4925 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
4927 A bulk change method to change packages for multiple customers.
4929 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4930 L<FS::part_pkg>) to order for each customer. Duplicates are of course
4933 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
4934 replace. The services (see L<FS::cust_svc>) are moved to the
4935 new billing items. An error is returned if this is not possible (see
4938 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4939 newly-created cust_pkg objects.
4944 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
4946 # Transactionize this whole mess
4947 my $oldAutoCommit = $FS::UID::AutoCommit;
4948 local $FS::UID::AutoCommit = 0;
4952 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4955 while(scalar(@old_cust_pkg)) {
4957 my $custnum = $old_cust_pkg[0]->custnum;
4958 my (@remove) = map { $_->pkgnum }
4959 grep { $_->custnum == $custnum } @old_cust_pkg;
4960 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
4962 my $error = order $custnum, $pkgparts, \@remove, \@return;
4964 push @errors, $error
4966 push @$return_cust_pkg, @return;
4969 if (scalar(@errors)) {
4970 $dbh->rollback if $oldAutoCommit;
4971 return join(' / ', @errors);
4974 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4978 # Used by FS::Upgrade to migrate to a new database.
4979 sub _upgrade_data { # class method
4980 my ($class, %opts) = @_;
4981 $class->_upgrade_otaker(%opts);
4983 # RT#10139, bug resulting in contract_end being set when it shouldn't
4984 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
4985 # RT#10830, bad calculation of prorate date near end of year
4986 # the date range for bill is December 2009, and we move it forward
4987 # one year if it's before the previous bill date (which it should
4989 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
4990 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
4991 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
4992 # RT6628, add order_date to cust_pkg
4993 'update cust_pkg set order_date = (select history_date from h_cust_pkg
4994 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
4995 history_action = \'insert\') where order_date is null',
4997 foreach my $sql (@statements) {
4998 my $sth = dbh->prepare($sql);
4999 $sth->execute or die $sth->errstr;
5002 # RT31194: supplemental package links that are deleted don't clean up
5004 my @pkglinknums = qsearch({
5005 'select' => 'DISTINCT cust_pkg.pkglinknum',
5006 'table' => 'cust_pkg',
5007 'addl_from' => ' LEFT JOIN part_pkg_link USING (pkglinknum) ',
5008 'extra_sql' => ' WHERE cust_pkg.pkglinknum IS NOT NULL
5009 AND part_pkg_link.pkglinknum IS NULL',
5011 foreach (@pkglinknums) {
5012 my $pkglinknum = $_->pkglinknum;
5013 warn "cleaning part_pkg_link #$pkglinknum\n";
5014 my $part_pkg_link = FS::part_pkg_link->new({pkglinknum => $pkglinknum});
5015 my $error = $part_pkg_link->remove_linked;
5016 die $error if $error;
5024 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
5026 In sub order, the @pkgparts array (passed by reference) is clobbered.
5028 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
5029 method to pass dates to the recur_prog expression, it should do so.
5031 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
5032 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
5033 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
5034 configuration values. Probably need a subroutine which decides what to do
5035 based on whether or not we've fetched the user yet, rather than a hash. See
5036 FS::UID and the TODO.
5038 Now that things are transactional should the check in the insert method be
5043 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
5044 L<FS::pkg_svc>, schema.html from the base documentation