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
9 use Carp qw(cluck croak);
10 use Scalar::Util qw( blessed );
11 use List::Util qw(min max sum);
13 use Time::Local qw( timelocal timelocal_nocheck );
15 use FS::UID qw( dbh driver_name );
16 use FS::Record qw( qsearch qsearchs fields );
22 use FS::cust_location;
24 use FS::cust_bill_pkg;
25 use FS::cust_pkg_detail;
26 use FS::cust_pkg_usage;
27 use FS::cdr_cust_pkg_usage;
32 use FS::cust_pkg_reason;
34 use FS::cust_pkg_usageprice;
35 use FS::cust_pkg_discount;
43 # temporary fix; remove this once (un)suspend admin notices are cleaned up
44 use FS::Misc qw(send_email);
46 # need to 'use' these instead of 'require' in sub { cancel, suspend, unsuspend,
48 # because they load configuration by setting FS::UID::callback (see TODO)
54 # for sending cancel emails in sub cancel
57 our ($disable_agentcheck, $DEBUG, $me, $import) = (0, 0, '[FS::cust_pkg]', 0);
59 our $upgrade = 0; #go away after setup+start dates cleaned up for old customers
61 our $cache_enabled = 0;
63 our $disable_start_on_hold = 0;
66 my( $self, $hashref ) = @_;
67 if ( $cache_enabled && $hashref->{'pkg'} && $hashref->{'plan'} ) {
68 $self->{'_pkgpart'} = FS::part_pkg->new($hashref);
74 my ( $hashref, $cache ) = @_;
75 # #if ( $hashref->{'pkgpart'} ) {
76 # if ( $hashref->{'pkg'} ) {
77 # # #@{ $self->{'_pkgnum'} } = ();
78 # # my $subcache = $cache->subcache('pkgpart', 'part_pkg');
79 # # $self->{'_pkgpart'} = $subcache;
80 # # #push @{ $self->{'_pkgnum'} },
81 # # FS::part_pkg->new_or_cached($hashref, $subcache);
82 # $self->{'_pkgpart'} = FS::part_pkg->new($hashref);
84 if ( exists $hashref->{'svcnum'} ) {
85 #@{ $self->{'_pkgnum'} } = ();
86 my $subcache = $cache->subcache('svcnum', 'cust_svc', $hashref->{pkgnum});
87 $self->{'_svcnum'} = $subcache;
88 #push @{ $self->{'_pkgnum'} },
89 FS::cust_svc->new_or_cached($hashref, $subcache) if $hashref->{svcnum};
95 FS::cust_pkg - Object methods for cust_pkg objects
101 $record = new FS::cust_pkg \%hash;
102 $record = new FS::cust_pkg { 'column' => 'value' };
104 $error = $record->insert;
106 $error = $new_record->replace($old_record);
108 $error = $record->delete;
110 $error = $record->check;
112 $error = $record->cancel;
114 $error = $record->suspend;
116 $error = $record->unsuspend;
118 $part_pkg = $record->part_pkg;
120 @labels = $record->labels;
122 $seconds = $record->seconds_since($timestamp);
124 #bulk cancel+order... perhaps slightly deprecated, only used by the bulk
125 # cancel+order in the web UI and nowhere else (edit/process/cust_pkg.cgi)
126 $error = FS::cust_pkg::order( $custnum, \@pkgparts );
127 $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );
131 An FS::cust_pkg object represents a customer billing item. FS::cust_pkg
132 inherits from FS::Record. The following fields are currently supported:
138 Primary key (assigned automatically for new billing items)
142 Customer (see L<FS::cust_main>)
146 Billing item definition (see L<FS::part_pkg>)
150 Optional link to package location (see L<FS::location>)
154 date package was ordered (also remains same on changes)
166 date (next bill date)
194 order taker (see L<FS::access_user>)
198 If not set, defaults to 1
202 Date of change from previous package
212 =item change_locationnum
220 The pkgnum of the package that this package is supplemental to, if any.
224 The package link (L<FS::part_pkg_link>) that defines this supplemental
225 package, if it is one.
227 =item change_to_pkgnum
229 The pkgnum of the package this one will be "changed to" in the future
230 (on its expiration date).
234 Note: setup, last_bill, bill, adjourn, susp, expire, cancel and change_date
235 are specified as UNIX timestamps; see L<perlfunc/"time">. Also see
236 L<Time::Local> and L<Date::Parse> for conversion functions.
244 Create a new billing item. To add the item to the database, see L<"insert">.
248 sub table { 'cust_pkg'; }
249 sub cust_linked { $_[0]->cust_main_custnum || $_[0]->custnum }
250 sub cust_unlinked_msg {
252 "WARNING: can't find cust_main.custnum ". $self->custnum.
253 ' (cust_pkg.pkgnum '. $self->pkgnum. ')';
256 =item set_initial_timers
258 If required by the package definition, sets any automatic expire, adjourn,
259 or contract_end timers to some number of months after the start date
260 (or setup date, if the package has already been setup). If the package has
261 a delayed setup fee after a period of "free days", will also set the
262 start date to the end of that period.
264 If the package has an automatic transfer rule (C<change_to_pkgnum>), then
265 this will also order the package and set its start date.
269 sub set_initial_timers {
271 my $part_pkg = $self->part_pkg;
272 my $start = $self->start_date || $self->setup || time;
274 foreach my $action ( qw(expire adjourn contract_end) ) {
275 my $months = $part_pkg->get("${action}_months");
276 if($months and !$self->get($action)) {
277 $self->set($action, $part_pkg->add_freq($start, $months) );
281 # if this package has an expire date and a change_to_pkgpart, set automatic
283 # (but don't call change_later, as that would call $self->replace, and we're
284 # probably in the middle of $self->insert right now)
285 if ( $part_pkg->expire_months and $part_pkg->change_to_pkgpart ) {
286 if ( $self->change_to_pkgnum ) {
287 # this can happen if a package is ordered on hold, scheduled for a
288 # future change _while on hold_, and then released from hold, causing
289 # the automatic transfer to schedule.
291 # what's correct behavior in that case? I think it's to disallow
292 # future-changing an on-hold package that has an automatic transfer.
293 # but if we DO get into this situation, let the manual package change
295 warn "pkgnum ".$self->pkgnum.": manual future package change blocks ".
296 "automatic transfer.\n";
298 my $change_to = FS::cust_pkg->new( {
299 start_date => $self->get('expire'),
300 pkgpart => $part_pkg->change_to_pkgpart,
301 map { $_ => $self->get($_) }
302 qw( custnum locationnum quantity refnum salesnum contract_end )
304 my $error = $change_to->insert;
306 return $error if $error;
307 $self->set('change_to_pkgnum', $change_to->pkgnum);
311 # if this package has "free days" and delayed setup fee, then
312 # set start date that many days in the future.
313 # (this should have been set in the UI, but enforce it here)
314 if ( $part_pkg->option('free_days',1)
315 && $part_pkg->option('delay_setup',1)
318 $self->start_date( $part_pkg->default_start_date );
324 =item insert [ OPTION => VALUE ... ]
326 Adds this billing item to the database ("Orders" the item). If there is an
327 error, returns the error, otherwise returns false.
329 If the additional field I<promo_code> is defined instead of I<pkgpart>, it
330 will be used to look up the package definition and agent restrictions will be
333 If the additional field I<refnum> is defined, an FS::pkg_referral record will
334 be created and inserted. Multiple FS::pkg_referral records can be created by
335 setting I<refnum> to an array reference of refnums or a hash reference with
336 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
337 record will be created corresponding to cust_main.refnum.
339 If the additional field I<cust_pkg_usageprice> is defined, it will be treated
340 as an arrayref of FS::cust_pkg_usageprice objects, which will be inserted.
341 (Note that this field cannot be set with a usual ->cust_pkg_usageprice method.
342 It can be set as part of the hash when creating the object, or with the B<set>
345 The following options are available:
351 If set true, supresses actions that should only be taken for new package
352 orders. (Currently this includes: intro periods when delay_setup is on,
353 auto-adding a 1st start date, auto-adding expiration/adjourn/contract_end dates)
357 cust_pkg_option records will be created
361 a ticket will be added to this customer with this subject
365 an optional queue name for ticket additions
369 Don't check the legality of the package definition. This should be used
370 when performing a package change that doesn't change the pkgpart (i.e.
378 my( $self, %options ) = @_;
380 my $oldAutoCommit = $FS::UID::AutoCommit;
381 local $FS::UID::AutoCommit = 0;
385 $error = $self->check_pkgpart unless $options{'allow_pkgpart'};
387 my $part_pkg = $self->part_pkg;
389 if ( ! $import && ! $options{'change'} ) {
391 # set order date to now
392 $self->order_date(time) unless ($import && $self->order_date);
394 # if the package def says to start only on the first of the month:
395 if ( $part_pkg->option('start_1st', 1) && !$self->start_date ) {
396 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime(time) )[0,1,2,3,4,5];
397 $mon += 1 unless $mday == 1;
398 until ( $mon < 12 ) { $mon -= 12; $year++; }
399 $self->start_date( timelocal_nocheck(0,0,0,1,$mon,$year) );
402 if ( $self->susp eq 'now'
403 or ( $part_pkg->start_on_hold && ! $disable_start_on_hold )
406 # if the package was ordered on hold:
408 # - don't set the start date (it will be started manually)
409 $self->set('susp', $self->order_date);
410 $self->set('start_date', '');
412 # set expire/adjourn/contract_end timers, and free days, if appropriate
413 # and automatic package transfer, which can fail, so capture the result
414 $error = $self->set_initial_timers;
416 } # else this is a package change, and shouldn't have "new package" behavior
418 $error ||= $self->SUPER::insert($options{options} ? %{$options{options}} : ());
420 $dbh->rollback if $oldAutoCommit;
424 $self->refnum($self->cust_main->refnum) unless $self->refnum;
425 $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
426 $self->process_m2m( 'link_table' => 'pkg_referral',
427 'target_table' => 'part_referral',
428 'params' => $self->refnum,
431 if ( $self->hashref->{cust_pkg_usageprice} ) {
432 for my $cust_pkg_usageprice ( @{ $self->hashref->{cust_pkg_usageprice} } ) {
433 $cust_pkg_usageprice->pkgnum( $self->pkgnum );
434 my $error = $cust_pkg_usageprice->insert;
436 $dbh->rollback if $oldAutoCommit;
442 if ( $self->setup_discountnum || $self->recur_discountnum ) {
443 my $error = $self->insert_discount();
445 $dbh->rollback if $oldAutoCommit;
450 my $conf = new FS::Conf;
452 if ($self->locationnum) {
454 map qsearch( 'part_export', {exportnum=>$_} ),
455 $conf->config('cust_location-exports'); #, $agentnum
457 foreach my $part_export ( @part_export ) {
458 my $error = $part_export->export_pkg_location($self); #, @$export_args);
460 $dbh->rollback if $oldAutoCommit;
461 return "exporting to ". $part_export->exporttype.
462 " (transaction rolled back): $error";
467 if ( ! $import && $conf->config('ticket_system') && $options{ticket_subject} ) {
469 #this init stuff is still inefficient, but at least its limited to
470 # the small number (any?) folks using ticket emailing on pkg order
473 # use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
480 use FS::TicketSystem;
481 FS::TicketSystem->init();
483 my $q = new RT::Queue($RT::SystemUser);
484 $q->Load($options{ticket_queue}) if $options{ticket_queue};
485 my $t = new RT::Ticket($RT::SystemUser);
486 my $mime = new MIME::Entity;
487 $mime->build( Type => 'text/plain', Data => $options{ticket_subject} );
488 $t->Create( $options{ticket_queue} ? (Queue => $q) : (),
489 Subject => $options{ticket_subject},
492 $t->AddLink( Type => 'MemberOf',
493 Target => 'freeside://freeside/cust_main/'. $self->custnum,
497 if (! $import && $conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
498 my $queue = new FS::queue {
499 'job' => 'FS::cust_main::queueable_print',
501 $error = $queue->insert(
502 'custnum' => $self->custnum,
503 'template' => 'welcome_letter',
507 warn "can't send welcome letter: $error";
512 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
519 This method now works but you probably shouldn't use it.
521 You don't want to delete packages, because there would then be no record
522 the customer ever purchased the package. Instead, see the cancel method and
523 hide cancelled packages.
527 # this is still used internally to abort future package changes, so it
533 # The following foreign keys to cust_pkg are not cleaned up here, and will
534 # cause package deletion to fail:
536 # cust_credit.pkgnum and commission_pkgnum (and cust_credit_void)
537 # cust_credit_bill.pkgnum
538 # cust_pay_pending.pkgnum
539 # cust_pay.pkgnum (and cust_pay_void)
540 # cust_bill_pay.pkgnum (wtf, shouldn't reference pkgnum)
541 # cust_pkg_usage.pkgnum
542 # cust_pkg.uncancel_pkgnum, change_pkgnum, main_pkgnum, and change_to_pkgnum
543 # rt_field_charge.pkgnum
545 # cust_svc is handled by canceling the package before deleting it
546 # cust_pkg_option is handled via option_Common
548 my $oldAutoCommit = $FS::UID::AutoCommit;
549 local $FS::UID::AutoCommit = 0;
552 foreach my $cust_pkg_discount ($self->cust_pkg_discount) {
553 my $error = $cust_pkg_discount->delete;
555 $dbh->rollback if $oldAutoCommit;
559 #cust_bill_pkg_discount?
561 foreach my $cust_pkg_detail ($self->cust_pkg_detail) {
562 my $error = $cust_pkg_detail->delete;
564 $dbh->rollback if $oldAutoCommit;
569 foreach my $cust_pkg_reason (
571 'table' => 'cust_pkg_reason',
572 'hashref' => { 'pkgnum' => $self->pkgnum },
576 my $error = $cust_pkg_reason->delete;
578 $dbh->rollback if $oldAutoCommit;
583 foreach my $pkg_referral ( $self->pkg_referral ) {
584 my $error = $pkg_referral->delete;
586 $dbh->rollback if $oldAutoCommit;
591 my $error = $self->SUPER::delete(@_);
593 $dbh->rollback if $oldAutoCommit;
597 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
603 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
605 Replaces the OLD_RECORD with this one in the database. If there is an error,
606 returns the error, otherwise returns false.
608 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
610 Changing pkgpart may have disasterous effects. See the order subroutine.
612 setup and bill are normally updated by calling the bill method of a customer
613 object (see L<FS::cust_main>).
615 suspend is normally updated by the suspend and unsuspend methods.
617 cancel is normally updated by the cancel method (and also the order subroutine
620 Available options are:
626 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.
630 the access_user (see L<FS::access_user>) providing the reason
634 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
643 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
648 ( ref($_[0]) eq 'HASH' )
652 #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
653 #return "Can't change otaker!" if $old->otaker ne $new->otaker;
656 #return "Can't change setup once it exists!"
657 # if $old->getfield('setup') &&
658 # $old->getfield('setup') != $new->getfield('setup');
660 #some logic for bill, susp, cancel?
662 local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
664 my $oldAutoCommit = $FS::UID::AutoCommit;
665 local $FS::UID::AutoCommit = 0;
668 foreach my $method ( qw(adjourn expire) ) { # How many reasons?
669 if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
670 my $error = $new->insert_reason(
671 'reason' => $options->{'reason'},
672 'date' => $new->$method,
674 'reason_otaker' => $options->{'reason_otaker'},
677 dbh->rollback if $oldAutoCommit;
678 return "Error inserting cust_pkg_reason: $error";
683 #save off and freeze RADIUS attributes for any associated svc_acct records
685 if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
687 #also check for specific exports?
688 # to avoid spurious modify export events
689 @svc_acct = map { $_->svc_x }
690 grep { $_->part_svc->svcdb eq 'svc_acct' }
693 $_->snapshot foreach @svc_acct;
697 my $error = $new->export_pkg_change($old)
698 || $new->SUPER::replace( $old,
700 ? $options->{options}
704 $dbh->rollback if $oldAutoCommit;
708 #for prepaid packages,
709 #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
710 foreach my $old_svc_acct ( @svc_acct ) {
711 my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
713 $new_svc_acct->replace( $old_svc_acct,
714 'depend_jobnum' => $options->{depend_jobnum},
717 $dbh->rollback if $oldAutoCommit;
722 # also run exports if removing locationnum?
723 # doesn't seem to happen, and we don't export blank locationnum on insert...
724 if ($new->locationnum and ($new->locationnum != $old->locationnum)) {
725 my $conf = new FS::Conf;
727 map qsearch( 'part_export', {exportnum=>$_} ),
728 $conf->config('cust_location-exports'); #, $agentnum
730 foreach my $part_export ( @part_export ) {
731 my $error = $part_export->export_pkg_location($new); #, @$export_args);
733 $dbh->rollback if $oldAutoCommit;
734 return "exporting to ". $part_export->exporttype.
735 " (transaction rolled back): $error";
740 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
747 Checks all fields to make sure this is a valid billing item. If there is an
748 error, returns the error, otherwise returns false. Called by the insert and
756 if ( !$self->locationnum or $self->locationnum == -1 ) {
757 $self->set('locationnum', $self->cust_main->ship_locationnum);
761 $self->ut_numbern('pkgnum')
762 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
763 || $self->ut_numbern('pkgpart')
764 || $self->ut_foreign_keyn('contactnum', 'contact', 'contactnum' )
765 || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
766 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
767 || $self->ut_numbern('quantity')
768 || $self->ut_numbern('start_date')
769 || $self->ut_numbern('setup')
770 || $self->ut_numbern('bill')
771 || $self->ut_numbern('susp')
772 || $self->ut_numbern('cancel')
773 || $self->ut_numbern('adjourn')
774 || $self->ut_numbern('resume')
775 || $self->ut_numbern('expire')
776 || $self->ut_numbern('dundate')
777 || $self->ut_flag('no_auto', [ '', 'Y' ])
778 || $self->ut_flag('waive_setup', [ '', 'Y' ])
779 || $self->ut_flag('separate_bill')
780 || $self->ut_textn('agent_pkgid')
781 || $self->ut_enum('recur_show_zero', [ '', 'Y', 'N', ])
782 || $self->ut_enum('setup_show_zero', [ '', 'Y', 'N', ])
783 || $self->ut_foreign_keyn('main_pkgnum', 'cust_pkg', 'pkgnum')
784 || $self->ut_foreign_keyn('pkglinknum', 'part_pkg_link', 'pkglinknum')
785 || $self->ut_foreign_keyn('change_to_pkgnum', 'cust_pkg', 'pkgnum')
787 return $error if $error;
789 return "A package with both start date (future start) and setup date (already started) will never bill"
790 if $self->start_date && $self->setup && ! $upgrade;
792 return "A future unsuspend date can only be set for a package with a suspend date"
793 if $self->resume and !$self->susp and !$self->adjourn;
795 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
802 Check the pkgpart to make sure it's allowed with the reg_code and/or
803 promo_code of the package (if present) and with the customer's agent.
804 Called from C<insert>, unless we are doing a package change that doesn't
812 # my $error = $self->ut_numbern('pkgpart'); # already done
815 if ( $self->reg_code ) {
817 unless ( grep { $self->pkgpart == $_->pkgpart }
818 map { $_->reg_code_pkg }
819 qsearchs( 'reg_code', { 'code' => $self->reg_code,
820 'agentnum' => $self->cust_main->agentnum })
822 return "Unknown registration code";
825 } elsif ( $self->promo_code ) {
828 qsearchs('part_pkg', {
829 'pkgpart' => $self->pkgpart,
830 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
832 return 'Unknown promotional code' unless $promo_part_pkg;
836 unless ( $disable_agentcheck ) {
838 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
839 return "agent ". $agent->agentnum. ':'. $agent->agent.
840 " can't purchase pkgpart ". $self->pkgpart
841 unless $agent->pkgpart_hashref->{ $self->pkgpart }
842 || $agent->agentnum == $self->part_pkg->agentnum;
845 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
846 return $error if $error;
854 =item cancel [ OPTION => VALUE ... ]
856 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
857 in this package, then cancels the package itself (sets the cancel field to
860 Available options are:
864 =item quiet - can be set true to supress email cancellation notices.
866 =item time - can be set to cancel the package based on a specific future or
867 historical date. Using time ensures that the remaining amount is calculated
868 correctly. Note however that this is an immediate cancel and just changes
869 the date. You are PROBABLY looking to expire the account instead of using
872 =item reason - can be set to a cancellation reason (see L<FS:reason>),
873 either a reasonnum of an existing reason, or passing a hashref will create
874 a new reason. The hashref should have the following keys: typenum - Reason
875 type (see L<FS::reason_type>, reason - Text of the new reason.
877 =item date - can be set to a unix style timestamp to specify when to
880 =item nobill - can be set true to skip billing if it might otherwise be done.
882 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
883 not credit it. This must be set (by change()) when changing the package
884 to a different pkgpart or location, and probably shouldn't be in any other
885 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
888 =item no_delay_cancel - prevents delay_cancel behavior
889 no matter what other options say, for use when changing packages (or any
890 other time you're really sure you want an immediate cancel)
894 If there is an error, returns the error, otherwise returns false.
898 #NOT DOCUMENTING - this should only be used when calling recursively
899 #=item delay_cancel - for internal use, to allow proper handling of
900 #supplemental packages when the main package is flagged to suspend
901 #before cancelling, probably shouldn't be used otherwise (set the
902 #corresponding package option instead)
905 my( $self, %options ) = @_;
908 # supplemental packages can now be separately canceled, though the UI
909 # shouldn't permit it
911 ## pass all suspend/cancel actions to the main package
912 ## (unless the pkglinknum has been removed, then the link is defunct and
913 ## this package can be canceled on its own)
914 #if ( $self->main_pkgnum and $self->pkglinknum and !$options{'from_main'} ) {
915 # return $self->main_pkg->cancel(%options);
918 my $conf = new FS::Conf;
920 warn "cust_pkg::cancel called with options".
921 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
924 my $oldAutoCommit = $FS::UID::AutoCommit;
925 local $FS::UID::AutoCommit = 0;
928 my $old = $self->select_for_update;
930 if ( $old->get('cancel') || $self->get('cancel') ) {
931 dbh->rollback if $oldAutoCommit;
932 return ""; # no error
935 # XXX possibly set cancel_time to the expire date?
936 my $cancel_time = $options{'time'} || time;
937 my $date = $options{'date'} if $options{'date'}; # expire/cancel later
938 $date = '' if ($date && $date <= $cancel_time); # complain instead?
940 my $delay_cancel = $options{'no_delay_cancel'} ? 0 : $options{'delay_cancel'};
941 if ( !$date && $self->part_pkg->option('delay_cancel',1)
942 && (($self->status eq 'active') || ($self->status eq 'suspended'))
943 && !$options{'no_delay_cancel'}
945 my $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
946 my $expsecs = 60*60*24*$expdays;
947 my $suspfor = $self->susp ? $cancel_time - $self->susp : 0;
948 $expsecs = $expsecs - $suspfor if $suspfor;
949 unless ($expsecs <= 0) { #if it's already been suspended long enough, don't re-suspend
951 $date = $cancel_time + $expsecs;
955 #race condition: usage could be ongoing until unprovisioned
956 #resolved by performing a change package instead (which unprovisions) and
958 if ( !$options{nobill} && !$date ) {
959 # && $conf->exists('bill_usage_on_cancel') ) { #calc_cancel checks this
960 my $copy = $self->new({$self->hash});
962 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
964 'time' => $cancel_time );
965 warn "Error billing during cancel, custnum ".
966 #$self->cust_main->custnum. ": $error"
971 if ( $options{'reason'} ) {
972 $error = $self->insert_reason( 'reason' => $options{'reason'},
973 'action' => $date ? 'expire' : 'cancel',
974 'date' => $date ? $date : $cancel_time,
975 'reason_otaker' => $options{'reason_otaker'},
978 dbh->rollback if $oldAutoCommit;
979 return "Error inserting cust_pkg_reason: $error";
983 my %svc_cancel_opt = ();
984 $svc_cancel_opt{'date'} = $date if $date;
985 foreach my $cust_svc (
988 sort { $a->[1] <=> $b->[1] }
989 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; }
990 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
992 my $part_svc = $cust_svc->part_svc;
993 next if ( defined($part_svc) and $part_svc->preserve );
994 my $error = $cust_svc->cancel( %svc_cancel_opt );
997 $dbh->rollback if $oldAutoCommit;
998 return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
1003 # if a reasonnum was passed, get the actual reason object so we can check
1007 if ($options{'reason'} =~ /^\d+$/) {
1008 $reason = FS::reason->by_key($options{'reason'});
1012 # credit remaining time if any of these are true:
1013 # - unused_credit => 1 was passed (this happens when canceling a package
1014 # for a package change when unused_credit_change is set)
1015 # - no unused_credit option, and there is a cancel reason, and the cancel
1016 # reason says to credit the package
1017 # - no unused_credit option, and the package definition says to credit the
1018 # package on cancellation
1020 if ( exists($options{'unused_credit'}) ) {
1021 $do_credit = $options{'unused_credit'};
1022 } elsif ( defined($reason) && $reason->unused_credit ) {
1025 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
1028 my $error = $self->credit_remaining('cancel', $cancel_time);
1030 $dbh->rollback if $oldAutoCommit;
1036 my %hash = $self->hash;
1038 $hash{'expire'} = $date;
1039 if ($delay_cancel) {
1040 # just to be sure these are clear
1041 $hash{'adjourn'} = undef;
1042 $hash{'resume'} = undef;
1045 $hash{'cancel'} = $cancel_time;
1047 $hash{'change_custnum'} = $options{'change_custnum'};
1049 # if this is a supplemental package that's lost its part_pkg_link, and it's
1050 # being canceled for real, unlink it completely
1051 if ( !$date and ! $self->pkglinknum ) {
1052 $hash{main_pkgnum} = '';
1055 # if there is a future package change scheduled, unlink from it (like
1056 # abort_change) first, then delete it.
1057 $hash{'change_to_pkgnum'} = '';
1059 # save the package state
1060 my $new = new FS::cust_pkg ( \%hash );
1061 $error = $new->replace( $self, options => { $self->options } );
1063 if ( $self->change_to_pkgnum ) {
1064 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
1065 $error ||= $change_to->cancel('no_delay_cancel' => 1) || $change_to->delete;
1068 $dbh->rollback if $oldAutoCommit;
1072 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1073 $error = $supp_pkg->cancel(%options,
1075 'date' => $date, #in case it got changed by delay_cancel
1076 'delay_cancel' => $delay_cancel,
1079 $dbh->rollback if $oldAutoCommit;
1080 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1084 if ($delay_cancel && !$options{'from_main'}) {
1085 $error = $new->suspend(
1087 'time' => $cancel_time
1092 foreach my $usage ( $self->cust_pkg_usage ) {
1093 $error = $usage->delete;
1095 $dbh->rollback if $oldAutoCommit;
1096 return "deleting usage pools: $error";
1101 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1102 return '' if $date; #no errors
1104 my $cust_main = $self->cust_main;
1106 my @invoicing_list = $cust_main->invoicing_list_emailonly;
1107 my $msgnum = $conf->config('cancel_msgnum', $cust_main->agentnum);
1108 if ( !$options{'quiet'}
1109 && $conf->config_bool('emailcancel', $cust_main->agentnum)
1114 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
1115 my $error = $msg_template->send(
1116 'cust_main' => $cust_main,
1119 #should this do something on errors?
1122 my %pkg_class = map { $_=>1 }
1123 $conf->config('cancel_msgnum-referring_cust-pkg_class');
1124 my $ref_msgnum = $conf->config('cancel_msgnum-referring_cust');
1125 if ( !$options{'quiet'}
1126 && $cust_main->referral_custnum
1127 && $pkg_class{ $self->classnum }
1131 my $msg_template = qsearchs('msg_template', { msgnum => $ref_msgnum });
1132 my $error = $msg_template->send(
1133 'cust_main' => $cust_main->referring_cust_main,
1136 #should this do something on errors?
1143 =item cancel_if_expired [ NOW_TIMESTAMP ]
1145 Cancels this package if its expire date has been reached.
1149 sub cancel_if_expired {
1151 my $time = shift || time;
1152 return '' unless $self->expire && $self->expire <= $time;
1153 my $error = $self->cancel;
1155 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
1156 $self->custnum. ": $error";
1161 =item uncancel_svc_x
1163 For cancelled cust_pkg, returns a list of new, uninserted FS::svc_X records
1164 for services that would be inserted by L</uncancel>. Returned objects also
1165 include the field _h_svc_x, which contains the service history object.
1167 Set pkgnum before inserting.
1169 Accepts the following options:
1171 only_svcnum - arrayref of svcnum, only returns objects for these svcnum
1172 (and only if they would otherwise be returned by this)
1176 sub uncancel_svc_x {
1177 my ($self, %opt) = @_;
1179 die 'uncancel_svc_x called on a non-cancelled cust_pkg' unless $self->get('cancel');
1181 #find historical services within this timeframe before the package cancel
1182 # (incompatible with "time" option to cust_pkg->cancel?)
1183 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
1184 # too little? (unprovisioing export delay?)
1185 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
1186 my @h_cust_svc = $self->h_cust_svc( $end, $start );
1189 foreach my $h_cust_svc (@h_cust_svc) {
1190 next if $opt{'only_svcnum'} && !(grep { $_ == $h_cust_svc->svcnum } @{$opt{'only_svcnum'}});
1191 # filter out services that still exist on this package (ie preserved svcs)
1192 # but keep services that have since been provisioned on another package (for informational purposes)
1193 next if qsearchs('cust_svc',{ 'svcnum' => $h_cust_svc->svcnum, 'pkgnum' => $self->pkgnum });
1194 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
1195 next unless $h_svc_x; # this probably doesn't happen, but just in case
1196 (my $table = $h_svc_x->table) =~ s/^h_//;
1197 require "FS/$table.pm";
1198 my $class = "FS::$table";
1199 my $svc_x = $class->new( {
1200 'svcpart' => $h_cust_svc->svcpart,
1201 '_h_svc_x' => $h_svc_x,
1202 map { $_ => $h_svc_x->get($_) } fields($table)
1206 if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
1207 $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
1210 #these are pretty rare, but should handle them
1211 # - dsl_device (mac addresses)
1212 # - phone_device (mac addresses)
1213 # - dsl_note (ikano notes)
1214 # - domain_record (i.e. restore DNS information w/domains)
1215 # - inventory_item(?) (inventory w/un-cancelling service?)
1216 # - nas (svc_broaband nas stuff)
1217 #this stuff is unused in the wild afaik
1218 # - mailinglistmember
1220 # - svc_domain.parent_svcnum?
1221 # - acct_snarf (ancient mail fetching config)
1222 # - cgp_rule (communigate)
1223 # - cust_svc_option (used by our Tron stuff)
1224 # - acct_rt_transaction (used by our time worked stuff)
1226 push @svc_x, $svc_x;
1231 =item uncancel_svc_summary
1233 Returns an array of hashrefs, one for each service that could
1234 potentially be reprovisioned by L</uncancel>, with the following keys:
1242 label - from history table if not currently calculable, undefined if it can't be loaded
1244 reprovisionable - 1 if test reprovision succeeded, otherwise 0
1246 num_cust_svc - number of svcs for this svcpart, only if summarizing (see below)
1248 Cannot be run from within a transaction. Performs inserts
1249 to test the results, and then rolls back the transaction.
1250 Does not perform exports, so does not catch if export would fail.
1252 Also accepts the following options:
1254 no_test_reprovision - skip the test inserts (reprovisionable field will not exist)
1256 summarize_size - if true, returns a single summary record for svcparts with at
1257 least this many svcs, will have key num_cust_svc but not uncancel_svcnum, label or reprovisionable
1261 sub uncancel_svc_summary {
1262 my ($self, %opt) = @_;
1264 die 'uncancel_svc_summary called on a non-cancelled cust_pkg' unless $self->get('cancel');
1265 die 'uncancel_svc_summary called from within a transaction' unless $FS::UID::AutoCommit;
1267 local $FS::svc_Common::noexport_hack = 1; # very important not to run exports!!!
1268 local $FS::UID::AutoCommit = 0;
1270 # sort by svcpart, to check summarize_size
1271 my $uncancel_svc_x = {};
1272 foreach my $svc_x (sort { $a->{'svcpart'} <=> $b->{'svcpart'} } $self->uncancel_svc_x) {
1273 $uncancel_svc_x->{$svc_x->svcpart} = [] unless $uncancel_svc_x->{$svc_x->svcpart};
1274 push @{$uncancel_svc_x->{$svc_x->svcpart}}, $svc_x;
1278 foreach my $svcpart (keys %$uncancel_svc_x) {
1279 my @svcpart_svc_x = @{$uncancel_svc_x->{$svcpart}};
1280 if ($opt{'summarize_size'} && (@svcpart_svc_x >= $opt{'summarize_size'})) {
1281 my $svc_x = $svcpart_svc_x[0]; #grab first one for access to $part_svc
1282 my $part_svc = $svc_x->part_svc;
1284 'svcpart' => $part_svc->svcpart,
1285 'svc' => $part_svc->svc,
1286 'num_cust_svc' => scalar(@svcpart_svc_x),
1289 foreach my $svc_x (@svcpart_svc_x) {
1290 my $part_svc = $svc_x->part_svc;
1292 'svcpart' => $part_svc->svcpart,
1293 'svc' => $part_svc->svc,
1294 'uncancel_svcnum' => $svc_x->get('_h_svc_x')->svcnum,
1296 $svc_x->pkgnum($self->pkgnum); # provisioning services on a canceled package, will be rolled back
1298 unless ($opt{'no_test_reprovision'}) {
1299 # avoid possibly fatal errors from missing linked records
1300 eval { $insert_error = $svc_x->insert };
1301 $insert_error ||= $@;
1303 if ($opt{'no_test_reprovision'} or $insert_error) {
1304 # avoid possibly fatal errors from missing linked records
1305 eval { $out->{'label'} = $svc_x->label };
1306 eval { $out->{'label'} = $svc_x->get('_h_svc_x')->label } unless defined($out->{'label'});
1307 $out->{'reprovisionable'} = 0 unless $opt{'no_test_reprovision'};
1309 $out->{'label'} = $svc_x->label;
1310 $out->{'reprovisionable'} = 1;
1323 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
1324 locationnum, (other fields?). Attempts to re-provision cancelled services
1325 using history information (errors at this stage are not fatal).
1327 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
1329 svc_fatal: service provisioning errors are fatal
1331 svc_errors: pass an array reference, will be filled in with any provisioning errors
1333 only_svcnum: arrayref, only attempt to re-provision these cancelled services
1335 main_pkgnum: link the package as a supplemental package of this one. For
1341 my( $self, %options ) = @_;
1343 #in case you try do do $uncancel-date = $cust_pkg->uncacel
1344 return '' unless $self->get('cancel');
1346 if ( $self->main_pkgnum and !$options{'main_pkgnum'} ) {
1347 return $self->main_pkg->uncancel(%options);
1354 my $oldAutoCommit = $FS::UID::AutoCommit;
1355 local $FS::UID::AutoCommit = 0;
1359 # insert the new package
1362 my $cust_pkg = new FS::cust_pkg {
1363 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
1364 bill => ( $options{'bill'} || $self->get('bill') ),
1366 uncancel_pkgnum => $self->pkgnum,
1367 main_pkgnum => ($options{'main_pkgnum'} || ''),
1368 map { $_ => $self->get($_) } qw(
1369 custnum pkgpart locationnum
1371 susp adjourn resume expire start_date contract_end dundate
1372 change_date change_pkgpart change_locationnum
1373 no_auto separate_bill quantity agent_pkgid
1374 recur_show_zero setup_show_zero
1378 my $error = $cust_pkg->insert(
1379 'change' => 1, #supresses any referral credit to a referring customer
1380 'allow_pkgpart' => 1, # allow this even if the package def is disabled
1383 $dbh->rollback if $oldAutoCommit;
1392 foreach my $svc_x ($self->uncancel_svc_x('only_svcnum' => $options{'only_svcnum'})) {
1394 $svc_x->pkgnum($cust_pkg->pkgnum);
1395 my $svc_error = $svc_x->insert;
1398 if ( $options{svc_fatal} ) {
1399 $dbh->rollback if $oldAutoCommit;
1402 # if we've failed to insert the svc_x object, svc_Common->insert
1403 # will have removed the cust_svc already. if not, then both records
1404 # were inserted but we failed for some other reason (export, most
1405 # likely). in that case, report the error and delete the records.
1406 push @svc_errors, $svc_error;
1407 my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1409 # except if export_insert failed, export_delete probably won't be
1411 local $FS::svc_Common::noexport_hack = 1;
1412 my $cleanup_error = $svc_x->delete; # also deletes cust_svc
1413 if ( $cleanup_error ) { # and if THAT fails, then run away
1414 $dbh->rollback if $oldAutoCommit;
1415 return $cleanup_error;
1420 } #foreach uncancel_svc_x
1423 # also move over any services that didn't unprovision at cancellation
1426 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1427 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1428 my $error = $cust_svc->replace;
1430 $dbh->rollback if $oldAutoCommit;
1436 # Uncancel any supplemental packages, and make them supplemental to the
1440 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1442 $error = $supp_pkg->uncancel(%options, 'main_pkgnum' => $cust_pkg->pkgnum);
1444 $dbh->rollback if $oldAutoCommit;
1445 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1453 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1455 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1456 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1463 Cancels any pending expiration (sets the expire field to null)
1464 for this package and any supplemental packages.
1466 If there is an error, returns the error, otherwise returns false.
1474 my $oldAutoCommit = $FS::UID::AutoCommit;
1475 local $FS::UID::AutoCommit = 0;
1478 my $old = $self->select_for_update;
1480 my $pkgnum = $old->pkgnum;
1481 if ( $old->get('cancel') || $self->get('cancel') ) {
1482 dbh->rollback if $oldAutoCommit;
1483 return "Can't unexpire cancelled package $pkgnum";
1484 # or at least it's pointless
1487 unless ( $old->get('expire') && $self->get('expire') ) {
1488 dbh->rollback if $oldAutoCommit;
1489 return ""; # no error
1492 my %hash = $self->hash;
1493 $hash{'expire'} = '';
1494 my $new = new FS::cust_pkg ( \%hash );
1495 $error = $new->replace( $self, options => { $self->options } );
1497 $dbh->rollback if $oldAutoCommit;
1501 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1502 $error = $supp_pkg->unexpire;
1504 $dbh->rollback if $oldAutoCommit;
1505 return "unexpiring supplemental pkg#".$supp_pkg->pkgnum.": $error";
1509 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1515 =item suspend [ OPTION => VALUE ... ]
1517 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1518 package, then suspends the package itself (sets the susp field to now).
1520 Available options are:
1524 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1525 either a reasonnum of an existing reason, or passing a hashref will create
1526 a new reason. The hashref should have the following keys:
1527 - typenum - Reason type (see L<FS::reason_type>
1528 - reason - Text of the new reason.
1530 =item date - can be set to a unix style timestamp to specify when to
1533 =item time - can be set to override the current time, for calculation
1534 of final invoices or unused-time credits
1536 =item resume_date - can be set to a time when the package should be
1537 unsuspended. This may be more convenient than calling C<unsuspend()>
1540 =item from_main - allows a supplemental package to be suspended, rather
1541 than redirecting the method call to its main package. For internal use.
1543 =item from_cancel - used when suspending from the cancel method, forces
1544 this to skip everything besides basic suspension. For internal use.
1548 If there is an error, returns the error, otherwise returns false.
1553 my( $self, %options ) = @_;
1556 # supplemental packages still can't be separately suspended, but silently
1557 # exit instead of failing or passing the action to the main package (so
1558 # that the "Suspend customer" action doesn't trip over the supplemental
1561 if ( $self->main_pkgnum and !$options{'from_main'} ) {
1565 my $oldAutoCommit = $FS::UID::AutoCommit;
1566 local $FS::UID::AutoCommit = 0;
1569 my $old = $self->select_for_update;
1571 my $pkgnum = $old->pkgnum;
1572 if ( $old->get('cancel') || $self->get('cancel') ) {
1573 dbh->rollback if $oldAutoCommit;
1574 return "Can't suspend cancelled package $pkgnum";
1577 if ( $old->get('susp') || $self->get('susp') ) {
1578 dbh->rollback if $oldAutoCommit;
1579 return ""; # no error # complain on adjourn?
1582 my $suspend_time = $options{'time'} || time;
1583 my $date = $options{date} if $options{date}; # adjourn/suspend later
1584 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1586 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1587 dbh->rollback if $oldAutoCommit;
1588 return "Package $pkgnum expires before it would be suspended.";
1591 # some false laziness with sub cancel
1592 if ( !$options{nobill} && !$date && !$options{'from_cancel'} &&
1593 $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1594 # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1595 # make the entire cust_main->bill path recognize 'suspend' and
1596 # 'cancel' separately.
1597 warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1598 my $copy = $self->new({$self->hash});
1600 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1602 'time' => $suspend_time );
1603 warn "Error billing during suspend, custnum ".
1604 #$self->cust_main->custnum. ": $error"
1609 my $cust_pkg_reason;
1610 if ( $options{'reason'} ) {
1611 $error = $self->insert_reason( 'reason' => $options{'reason'},
1612 'action' => $date ? 'adjourn' : 'suspend',
1613 'date' => $date ? $date : $suspend_time,
1614 'reason_otaker' => $options{'reason_otaker'},
1617 dbh->rollback if $oldAutoCommit;
1618 return "Error inserting cust_pkg_reason: $error";
1620 $cust_pkg_reason = qsearchs('cust_pkg_reason', {
1621 'date' => $date ? $date : $suspend_time,
1622 'action' => $date ? 'A' : 'S',
1623 'pkgnum' => $self->pkgnum,
1627 # if a reasonnum was passed, get the actual reason object so we can check
1629 # (passing a reason hashref is still allowed, but it can't be used with
1630 # the fancy behavioral options.)
1633 if ($options{'reason'} =~ /^\d+$/) {
1634 $reason = FS::reason->by_key($options{'reason'});
1637 my %hash = $self->hash;
1639 $hash{'adjourn'} = $date;
1641 $hash{'susp'} = $suspend_time;
1644 my $resume_date = $options{'resume_date'} || 0;
1645 if ( $resume_date > ($date || $suspend_time) ) {
1646 $hash{'resume'} = $resume_date;
1649 $options{options} ||= {};
1651 my $new = new FS::cust_pkg ( \%hash );
1652 $error = $new->replace( $self, options => { $self->options,
1653 %{ $options{options} },
1657 $dbh->rollback if $oldAutoCommit;
1661 unless ( $date ) { # then we are suspending now
1663 unless ($options{'from_cancel'}) {
1664 # credit remaining time if appropriate
1665 # (if required by the package def, or the suspend reason)
1666 my $unused_credit = $self->part_pkg->option('unused_credit_suspend',1)
1667 || ( defined($reason) && $reason->unused_credit );
1669 if ( $unused_credit ) {
1670 warn "crediting unused time on pkg#".$self->pkgnum."\n" if $DEBUG;
1671 my $error = $self->credit_remaining('suspend', $suspend_time);
1673 $dbh->rollback if $oldAutoCommit;
1679 my @cust_svc = qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } );
1681 #attempt ordering ala cust_svc_suspend_cascade (without infinite-looping
1682 # on the circular dep case)
1683 # (this is too simple for multi-level deps, we need to use something
1684 # to resolve the DAG properly when possible)
1686 $svcpart{$_->svcpart} = 0 foreach @cust_svc;
1687 foreach my $svcpart ( keys %svcpart ) {
1688 foreach my $part_svc_link (
1689 FS::part_svc_link->by_agentnum($self->cust_main->agentnum,
1690 src_svcpart => $svcpart,
1691 link_type => 'cust_svc_suspend_cascade'
1694 $svcpart{$part_svc_link->dst_svcpart} = max(
1695 $svcpart{$part_svc_link->dst_svcpart},
1696 $svcpart{$part_svc_link->src_svcpart} + 1
1700 @cust_svc = sort { $svcpart{ $a->svcpart } <=> $svcpart{ $b->svcpart } }
1704 foreach my $cust_svc ( @cust_svc ) {
1705 $cust_svc->suspend( 'labels_arrayref' => \@labels );
1708 # suspension fees: if there is a feepart, and it's not an unsuspend fee,
1709 # and this is not a suspend-before-cancel
1710 if ( $cust_pkg_reason ) {
1711 my $reason_obj = $cust_pkg_reason->reason;
1712 if ( $reason_obj->feepart and
1713 ! $reason_obj->fee_on_unsuspend and
1714 ! $options{'from_cancel'} ) {
1716 # register the need to charge a fee, cust_main->bill will do the rest
1717 warn "registering suspend fee: pkgnum ".$self->pkgnum.", feepart ".$reason->feepart."\n"
1719 my $cust_pkg_reason_fee = FS::cust_pkg_reason_fee->new({
1720 'pkgreasonnum' => $cust_pkg_reason->num,
1721 'pkgnum' => $self->pkgnum,
1722 'feepart' => $reason->feepart,
1723 'nextbill' => $reason->fee_hold,
1725 $error ||= $cust_pkg_reason_fee->insert;
1729 my $conf = new FS::Conf;
1730 if ( $conf->config('suspend_email_admin') && !$options{'from_cancel'} ) {
1732 my $error = send_email(
1733 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1734 #invoice_from ??? well as good as any
1735 'to' => $conf->config('suspend_email_admin'),
1736 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1738 "This is an automatic message from your Freeside installation\n",
1739 "informing you that the following customer package has been suspended:\n",
1741 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1742 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1743 ( map { "Service : $_\n" } @labels ),
1745 'custnum' => $self->custnum,
1746 'msgtype' => 'admin'
1750 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1758 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1759 $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1761 $dbh->rollback if $oldAutoCommit;
1762 return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1766 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1771 =item credit_remaining MODE TIME
1773 Generate a credit for this package for the time remaining in the current
1774 billing period. MODE is either "suspend" or "cancel" (determines the
1775 credit type). TIME is the time of suspension/cancellation. Both arguments
1780 # Implementation note:
1782 # If you pkgpart-change a package that has been billed, and it's set to give
1783 # credit on package change, then this method gets called and then the new
1784 # package will have no last_bill date. Therefore the customer will be credited
1785 # only once (per billing period) even if there are multiple package changes.
1787 # If you location-change a package that has been billed, this method will NOT
1788 # be called and the new package WILL have the last bill date of the old
1791 # If the new package is then canceled within the same billing cycle,
1792 # credit_remaining needs to run calc_remain on the OLD package to determine
1793 # the amount of unused time to credit.
1795 sub credit_remaining {
1796 # Add a credit for remaining service
1797 my ($self, $mode, $time) = @_;
1798 die 'credit_remaining requires suspend or cancel'
1799 unless $mode eq 'suspend' or $mode eq 'cancel';
1800 die 'no suspend/cancel time' unless $time > 0;
1802 my $conf = FS::Conf->new;
1803 my $reason_type = $conf->config($mode.'_credit_type');
1807 my $remain_pkg = $self;
1808 my (@billpkgnums, @amounts, @setuprecurs);
1810 # we may have to walk back past some package changes to get to the
1811 # one that actually has unused time. loop until that happens, or we
1812 # reach the first package in the chain.
1814 my $last_bill = $remain_pkg->get('last_bill') || 0;
1815 my $next_bill = $remain_pkg->get('bill') || 0;
1816 if ( $last_bill > 0 # the package has been billed
1817 and $next_bill > 0 # the package has a next bill date
1818 and $next_bill >= $time # which is in the future
1821 # Find actual charges for the period ending on or after the cancel
1823 my @charges = qsearch('cust_bill_pkg', {
1824 pkgnum => $remain_pkg->pkgnum,
1825 edate => {op => '>=', value => $time},
1826 recur => {op => '>' , value => 0},
1829 foreach my $cust_bill_pkg (@charges) {
1830 # hack to deal with the weird behavior of edate on package
1832 my $edate = $cust_bill_pkg->edate;
1833 if ( $self->recur_temporality eq 'preceding' ) {
1834 $edate = $self->add_freq($cust_bill_pkg->sdate);
1837 # this will also get any package charges that are _entirely_ after
1838 # the cancellation date (can happen with advance billing). in that
1839 # case, use the entire recurring charge:
1840 my $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
1841 my $max_credit = $amount
1842 - $cust_bill_pkg->credited('', '', setuprecur => 'recur') || 0;
1844 # but if the cancellation happens during the interval, prorate it:
1845 # (XXX obey prorate_round_day here?)
1846 if ( $cust_bill_pkg->sdate < $time ) {
1848 ($edate - $time) / ($edate - $cust_bill_pkg->sdate);
1851 # if there are existing credits, don't let the sum of credits exceed
1852 # the recurring charge
1853 $amount = $max_credit if $amount > $max_credit;
1855 $amount = sprintf('%.2f', $amount);
1857 # if no time has been used and/or there are existing line item
1858 # credits, we may end up not needing to credit anything.
1859 if ( $amount > 0 ) {
1861 push @billpkgnums, $cust_bill_pkg->billpkgnum;
1862 push @amounts, $amount;
1863 push @setuprecurs, 'recur';
1865 warn "Crediting for $amount on package ".$remain_pkg->pkgnum."\n"
1874 if ( my $changed_from_pkgnum = $remain_pkg->change_pkgnum ) {
1875 $remain_pkg = FS::cust_pkg->by_key($changed_from_pkgnum);
1877 # the package has really never been billed
1882 # keep traditional behavior here.
1884 my $reason = FS::reason->new_or_existing(
1885 reason => 'Credit for unused time on '. $self->part_pkg->pkg,
1886 type => $reason_type,
1890 return "failed to set credit reason: $@";
1893 my $error = FS::cust_credit->credit_lineitems(
1894 'billpkgnums' => \@billpkgnums,
1895 'setuprecurs' => \@setuprecurs,
1896 'amounts' => \@amounts,
1897 'custnum' => $self->custnum,
1899 'reasonnum' => $reason->reasonnum,
1907 =item unsuspend [ OPTION => VALUE ... ]
1909 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1910 package, then unsuspends the package itself (clears the susp field and the
1911 adjourn field if it is in the past). If the suspend reason includes an
1912 unsuspension package, that package will be ordered.
1914 Available options are:
1920 Can be set to a date to unsuspend the package in the future (the 'resume'
1923 =item adjust_next_bill
1925 Can be set true to adjust the next bill date forward by
1926 the amount of time the account was inactive. This was set true by default
1927 in the past (from 1.4.2 and 1.5.0pre6 through 1.7.0), but now needs to be
1928 explicitly requested with this option or in the price plan.
1932 If there is an error, returns the error, otherwise returns false.
1937 my( $self, %opt ) = @_;
1940 # pass all suspend/cancel actions to the main package
1941 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1942 return $self->main_pkg->unsuspend(%opt);
1945 my $oldAutoCommit = $FS::UID::AutoCommit;
1946 local $FS::UID::AutoCommit = 0;
1949 my $old = $self->select_for_update;
1951 my $pkgnum = $old->pkgnum;
1952 if ( $old->get('cancel') || $self->get('cancel') ) {
1953 $dbh->rollback if $oldAutoCommit;
1954 return "Can't unsuspend cancelled package $pkgnum";
1957 unless ( $old->get('susp') && $self->get('susp') ) {
1958 $dbh->rollback if $oldAutoCommit;
1959 return ""; # no error # complain instead?
1962 # handle the case of setting a future unsuspend (resume) date
1963 # and do not continue to actually unsuspend the package
1964 my $date = $opt{'date'};
1965 if ( $date and $date > time ) { # return an error if $date <= time?
1967 if ( $old->get('expire') && $old->get('expire') < $date ) {
1968 $dbh->rollback if $oldAutoCommit;
1969 return "Package $pkgnum expires before it would be unsuspended.";
1972 my $new = new FS::cust_pkg { $self->hash };
1973 $new->set('resume', $date);
1974 $error = $new->replace($self, options => $self->options);
1977 $dbh->rollback if $oldAutoCommit;
1981 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1987 if (!$self->setup) {
1988 # then this package is being released from on-hold status
1989 $error = $self->set_initial_timers;
1991 $dbh->rollback if $oldAutoCommit;
1998 foreach my $cust_svc (
1999 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
2001 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
2003 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
2004 $dbh->rollback if $oldAutoCommit;
2005 return "Illegal svcdb value in part_svc!";
2008 require "FS/$svcdb.pm";
2010 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
2012 $error = $svc->unsuspend;
2014 $dbh->rollback if $oldAutoCommit;
2017 my( $label, $value ) = $cust_svc->label;
2018 push @labels, "$label: $value";
2023 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
2024 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
2026 my %hash = $self->hash;
2027 my $inactive = time - $hash{'susp'};
2029 my $conf = new FS::Conf;
2031 #adjust the next bill date forward
2032 # increment next bill date if certain conditions are met:
2033 # - it was due to be billed at some point
2034 # - either the global or local config says to do this
2035 my $adjust_bill = 0;
2038 && ( $hash{'bill'} || $hash{'setup'} )
2039 && ( $opt{'adjust_next_bill'}
2040 || $conf->exists('unsuspend-always_adjust_next_bill_date')
2041 || $self->part_pkg->option('unsuspend_adjust_bill', 1)
2048 # - the package billed during suspension
2049 # - or it was ordered on hold
2050 # - or the customer was credited for the unused time
2052 if ( $self->option('suspend_bill',1)
2053 or ( $self->part_pkg->option('suspend_bill',1)
2054 and ! $self->option('no_suspend_bill',1)
2056 or $hash{'order_date'} == $hash{'susp'}
2061 if ( $adjust_bill ) {
2062 if ( $self->part_pkg->option('unused_credit_suspend')
2063 or ( ref($reason) and $reason->unused_credit ) ) {
2064 # then the customer was credited for the unused time before suspending,
2065 # so their next bill should be immediate
2066 $hash{'bill'} = time;
2068 # add the length of time suspended to the bill date
2069 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive;
2074 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
2075 $hash{'resume'} = '' if !$hash{'adjourn'};
2076 my $new = new FS::cust_pkg ( \%hash );
2077 $error = $new->replace( $self, options => { $self->options } );
2079 $dbh->rollback if $oldAutoCommit;
2086 if ( $reason->unsuspend_pkgpart ) {
2087 warn "Suspend reason '".$reason->reason."' uses deprecated unsuspend_pkgpart feature.\n";
2088 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
2089 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
2091 my $start_date = $self->cust_main->next_bill_date
2092 if $reason->unsuspend_hold;
2095 $unsusp_pkg = FS::cust_pkg->new({
2096 'custnum' => $self->custnum,
2097 'pkgpart' => $reason->unsuspend_pkgpart,
2098 'start_date' => $start_date,
2099 'locationnum' => $self->locationnum,
2100 # discount? probably not...
2103 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
2106 # new way, using fees
2107 if ( $reason->feepart and $reason->fee_on_unsuspend ) {
2108 # register the need to charge a fee, cust_main->bill will do the rest
2109 warn "registering unsuspend fee: pkgnum ".$self->pkgnum.", feepart ".$reason->feepart."\n"
2111 my $cust_pkg_reason_fee = FS::cust_pkg_reason_fee->new({
2112 'pkgreasonnum' => $cust_pkg_reason->num,
2113 'pkgnum' => $self->pkgnum,
2114 'feepart' => $reason->feepart,
2115 'nextbill' => $reason->fee_hold,
2117 $error ||= $cust_pkg_reason_fee->insert;
2121 $dbh->rollback if $oldAutoCommit;
2126 if ( $conf->config('unsuspend_email_admin') ) {
2128 my $error = send_email(
2129 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
2130 #invoice_from ??? well as good as any
2131 'to' => $conf->config('unsuspend_email_admin'),
2132 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
2133 "This is an automatic message from your Freeside installation\n",
2134 "informing you that the following customer package has been unsuspended:\n",
2136 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
2137 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
2138 ( map { "Service : $_\n" } @labels ),
2140 "An unsuspension fee was charged: ".
2141 $unsusp_pkg->part_pkg->pkg_comment."\n"
2145 'custnum' => $self->custnum,
2146 'msgtype' => 'admin',
2150 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
2156 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
2157 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
2159 $dbh->rollback if $oldAutoCommit;
2160 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
2164 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2171 Cancels any pending suspension (sets the adjourn field to null)
2172 for this package and any supplemental packages.
2174 If there is an error, returns the error, otherwise returns false.
2182 my $oldAutoCommit = $FS::UID::AutoCommit;
2183 local $FS::UID::AutoCommit = 0;
2186 my $old = $self->select_for_update;
2188 my $pkgnum = $old->pkgnum;
2189 if ( $old->get('cancel') || $self->get('cancel') ) {
2190 dbh->rollback if $oldAutoCommit;
2191 return "Can't unadjourn cancelled package $pkgnum";
2192 # or at least it's pointless
2195 if ( $old->get('susp') || $self->get('susp') ) {
2196 dbh->rollback if $oldAutoCommit;
2197 return "Can't unadjourn suspended package $pkgnum";
2198 # perhaps this is arbitrary
2201 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
2202 dbh->rollback if $oldAutoCommit;
2203 return ""; # no error
2206 my %hash = $self->hash;
2207 $hash{'adjourn'} = '';
2208 $hash{'resume'} = '';
2209 my $new = new FS::cust_pkg ( \%hash );
2210 $error = $new->replace( $self, options => { $self->options } );
2212 $dbh->rollback if $oldAutoCommit;
2216 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
2217 $error = $supp_pkg->unadjourn;
2219 $dbh->rollback if $oldAutoCommit;
2220 return "unadjourning supplemental pkg#".$supp_pkg->pkgnum.": $error";
2224 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2231 =item change HASHREF | OPTION => VALUE ...
2233 Changes this package: cancels it and creates a new one, with a different
2234 pkgpart or locationnum or both. All services are transferred to the new
2235 package (no change will be made if this is not possible).
2237 Options may be passed as a list of key/value pairs or as a hash reference.
2244 New locationnum, to change the location for this package.
2248 New FS::cust_location object, to create a new location and assign it
2253 New FS::cust_main object, to create a new customer and assign the new package
2258 New pkgpart (see L<FS::part_pkg>).
2262 New refnum (see L<FS::part_referral>).
2266 New quantity; if unspecified, the new package will have the same quantity
2271 "New" (existing) FS::cust_pkg object. The package's services and other
2272 attributes will be transferred to this package.
2276 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
2277 susp, adjourn, cancel, expire, and contract_end) to the new package.
2279 =item unprotect_svcs
2281 Normally, change() will rollback and return an error if some services
2282 can't be transferred (also see the I<cust_pkg-change_svcpart> config option).
2283 If unprotect_svcs is true, this method will transfer as many services as
2284 it can and then unconditionally cancel the old package.
2288 If specified, sets this value for the contract_end date on the new package
2289 (without regard for keep_dates or the usual date-preservation behavior.)
2290 Will throw an error if defined but false; the UI doesn't allow editing
2291 this unless it already exists, making removal impossible to undo.
2295 At least one of locationnum, cust_location, pkgpart, refnum, cust_main, or
2296 cust_pkg must be specified (otherwise, what's the point?)
2298 Returns either the new FS::cust_pkg object or a scalar error.
2302 my $err_or_new_cust_pkg = $old_cust_pkg->change
2306 #used by change and change_later
2307 #didn't put with documented check methods because it depends on change-specific opts
2308 #and it also possibly edits the value of opts
2312 if ( defined($opt->{'contract_end'}) ) {
2313 my $current_contract_end = $self->get('contract_end');
2314 unless ($opt->{'contract_end'}) {
2315 if ($current_contract_end) {
2316 return "Cannot remove contract end date when changing packages";
2318 #shouldn't even pass this option if there's not a current value
2319 #but can be handled gracefully if the option is empty
2320 warn "Contract end date passed unexpectedly";
2321 delete $opt->{'contract_end'};
2325 unless ($current_contract_end) {
2326 #option shouldn't be passed, throw error if it's non-empty
2327 return "Cannot add contract end date when changing packages " . $self->pkgnum;
2333 #some false laziness w/order
2336 my $opt = ref($_[0]) ? shift : { @_ };
2338 my $conf = new FS::Conf;
2340 # handle contract_end on cust_pkg same as passed option
2341 if ( $opt->{'cust_pkg'} ) {
2342 $opt->{'contract_end'} = $opt->{'cust_pkg'}->contract_end;
2343 delete $opt->{'contract_end'} unless $opt->{'contract_end'};
2346 # check contract_end, prevent adding/removing
2347 my $error = $self->_check_change($opt);
2348 return $error if $error;
2350 # Transactionize this whole mess
2351 my $oldAutoCommit = $FS::UID::AutoCommit;
2352 local $FS::UID::AutoCommit = 0;
2355 if ( $opt->{'cust_location'} ) {
2356 $error = $opt->{'cust_location'}->find_or_insert;
2358 $dbh->rollback if $oldAutoCommit;
2359 return "creating location record: $error";
2361 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
2364 # figure out if we're changing pkgpart
2365 if ( $opt->{'cust_pkg'} ) {
2366 $opt->{'pkgpart'} = $opt->{'cust_pkg'}->pkgpart;
2369 # whether to override pkgpart checking on the new package
2370 my $same_pkgpart = 1;
2371 if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
2376 # When a new discount level is specified in $opt:
2377 # If new discountnum matches old discountnum, months_used/end_date are
2378 # carried over as the discount is applied to the new cust_pkg
2381 # Unless discount-related fields have been set within $opt, change()
2382 # sets no discounts on the changed packages unless the new pkgpart is the
2383 # same as the old pkgpart. In that case, discounts from the old cust_pkg
2384 # are copied onto the new cust_pkg
2386 # Read discount fields from $opt
2387 my %new_discount = $self->_parse_new_discounts($opt);
2388 $self->set(waive_setup => $opt->{waive_setup} ? $opt->{waive_setup} : '');
2390 # Before going any further here: if the package is still in the pre-setup
2391 # state, it's safe to modify it in place. No need to charge/credit for
2392 # partial period, transfer usage pools, copy invoice details, or change any
2393 # dates. We DO need to "transfer" services (from the package to itself) to
2394 # check their validity on the new pkgpart.
2395 if ( ! $self->setup and ! $opt->{cust_pkg} and ! $opt->{cust_main} ) {
2396 foreach ( qw( locationnum pkgpart quantity refnum salesnum waive_setup ) ) {
2397 if ( length($opt->{$_}) ) {
2398 $self->set($_, $opt->{$_});
2401 # almost. if the new pkgpart specifies start/adjourn/expire timers,
2403 if ( !$same_pkgpart ) {
2404 $error ||= $self->set_initial_timers;
2406 # but if contract_end was explicitly specified, that overrides all else
2407 $self->set('contract_end', $opt->{'contract_end'})
2408 if $opt->{'contract_end'};
2410 $error ||= $self->replace;
2412 $dbh->rollback if $oldAutoCommit;
2413 return "modifying package: $error";
2416 # check/convert services (only on pkgpart change, to avoid surprises
2417 # when editing locations)
2418 # (maybe do this if changing quantity?)
2419 if ( !$same_pkgpart ) {
2421 $error = $self->transfer($self);
2423 if ( $error and $error == 0 ) {
2424 $error = "transferring $error";
2425 } elsif ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2426 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2427 $error = $self->transfer($self, 'change_svcpart'=>1 );
2428 if ($error and $error == 0) {
2429 $error = "converting $error";
2434 $error = "unable to transfer all services";
2438 $dbh->rollback if $oldAutoCommit;
2442 } # done transferring services
2444 # Set waive_setup as directed
2445 if ( !$error && exists $opt->{waive_setup} ) {
2446 $self->set(waive_setup => $opt->{waive_setup});
2447 $error = $self->replace;
2450 # Set discounts if explicitly specified in $opt
2451 if ( !$error && %new_discount ) {
2452 $error = $self->change_discount(%new_discount);
2456 $dbh->rollback if $oldAutoCommit;
2460 $dbh->commit if $oldAutoCommit;
2469 $hash{'setup'} = $time if $self->get('setup');
2471 $hash{'change_date'} = $time;
2472 $hash{"change_$_"} = $self->$_()
2473 foreach qw( pkgnum pkgpart locationnum );
2475 my $unused_credit = 0;
2476 my $keep_dates = $opt->{'keep_dates'};
2478 # Special case. If the pkgpart is changing, and the customer is going to be
2479 # credited for remaining time, don't keep setup, bill, or last_bill dates,
2480 # and DO pass the flag to cancel() to credit the customer. If the old
2481 # package had a setup date, set the new package's setup to the package
2482 # change date so that it has the same status as before.
2483 if ( $opt->{'pkgpart'}
2484 and $opt->{'pkgpart'} != $self->pkgpart
2485 and $self->part_pkg->option('unused_credit_change', 1) ) {
2488 $hash{'last_bill'} = '';
2492 if ( $keep_dates ) {
2493 foreach my $date ( qw(setup bill last_bill) ) {
2494 $hash{$date} = $self->getfield($date);
2497 # always keep the following dates
2498 foreach my $date (qw(order_date susp adjourn cancel expire resume
2499 start_date contract_end)) {
2500 $hash{$date} = $self->getfield($date);
2502 # but if contract_end was explicitly specified, that overrides all else
2503 $hash{'contract_end'} = $opt->{'contract_end'}
2504 if $opt->{'contract_end'};
2506 # allow $opt->{'locationnum'} = '' to specifically set it to null
2507 # (i.e. customer default location)
2508 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2510 # usually this doesn't matter. the two cases where it does are:
2511 # 1. unused_credit_change + pkgpart change + setup fee on the new package
2513 # 2. (more importantly) changing a package before it's billed
2514 $hash{'waive_setup'} = $self->waive_setup;
2516 # if this package is scheduled for a future package change, preserve that
2517 $hash{'change_to_pkgnum'} = $self->change_to_pkgnum;
2519 my $custnum = $self->custnum;
2520 if ( $opt->{cust_main} ) {
2521 my $cust_main = $opt->{cust_main};
2522 unless ( $cust_main->custnum ) {
2523 my $error = $cust_main->insert( @{ $opt->{cust_main_insert_args}||[] } );
2525 $dbh->rollback if $oldAutoCommit;
2526 return "inserting customer record: $error";
2529 $custnum = $cust_main->custnum;
2532 $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
2535 if ( $opt->{'cust_pkg'} ) {
2536 # The target package already exists; update it to show that it was
2537 # changed from this package.
2538 $cust_pkg = $opt->{'cust_pkg'};
2540 # follow all the above rules for date changes, etc.
2541 foreach (keys %hash) {
2542 $cust_pkg->set($_, $hash{$_});
2544 # except those that implement the future package change behavior
2545 foreach (qw(change_to_pkgnum start_date expire)) {
2546 $cust_pkg->set($_, '');
2549 $error = $cust_pkg->replace;
2552 # Create the new package.
2553 $cust_pkg = new FS::cust_pkg {
2554 custnum => $custnum,
2555 locationnum => $opt->{'locationnum'},
2556 ( map { $_ => ( $opt->{$_} || $self->$_() ) }
2557 qw( pkgpart quantity refnum salesnum )
2561 $error = $cust_pkg->insert( 'change' => 1,
2562 'allow_pkgpart' => $same_pkgpart );
2565 $dbh->rollback if $oldAutoCommit;
2566 return "inserting new package: $error";
2569 # Transfer services and cancel old package.
2570 # Enforce service limits only if this is a pkgpart change.
2571 local $FS::cust_svc::ignore_quantity;
2572 $FS::cust_svc::ignore_quantity = 1 if $same_pkgpart;
2573 $error = $self->transfer($cust_pkg);
2574 if ($error and $error == 0) {
2575 # $old_pkg->transfer failed.
2576 $dbh->rollback if $oldAutoCommit;
2577 return "transferring $error";
2580 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
2581 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
2582 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
2583 if ($error and $error == 0) {
2584 # $old_pkg->transfer failed.
2585 $dbh->rollback if $oldAutoCommit;
2586 return "converting $error";
2590 # We set unprotect_svcs when executing a "future package change". It's
2591 # not a user-interactive operation, so returning an error means the
2592 # package change will just fail. Rather than have that happen, we'll
2593 # let leftover services be deleted.
2594 if ($error > 0 and !$opt->{'unprotect_svcs'}) {
2595 # Transfers were successful, but we still had services left on the old
2596 # package. We can't change the package under this circumstances, so abort.
2597 $dbh->rollback if $oldAutoCommit;
2598 return "unable to transfer all services";
2601 #reset usage if changing pkgpart
2602 # AND usage rollover is off (otherwise adds twice, now and at package bill)
2603 if ($self->pkgpart != $cust_pkg->pkgpart) {
2604 my $part_pkg = $cust_pkg->part_pkg;
2605 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
2609 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
2612 $dbh->rollback if $oldAutoCommit;
2613 return "setting usage values: $error";
2616 # if NOT changing pkgpart, transfer any usage pools over
2617 foreach my $usage ($self->cust_pkg_usage) {
2618 $usage->set('pkgnum', $cust_pkg->pkgnum);
2619 $error = $usage->replace;
2621 $dbh->rollback if $oldAutoCommit;
2622 return "transferring usage pools: $error";
2627 # transfer usage pricing add-ons, if we're not changing pkgpart or if they were specified
2628 if ( $same_pkgpart || $opt->{'cust_pkg_usageprice'}) {
2629 my @old_cust_pkg_usageprice;
2630 if ($opt->{'cust_pkg_usageprice'}) {
2631 @old_cust_pkg_usageprice = @{ $opt->{'cust_pkg_usageprice'} };
2633 @old_cust_pkg_usageprice = $self->cust_pkg_usageprice;
2635 foreach my $old_cust_pkg_usageprice (@old_cust_pkg_usageprice) {
2636 my $new_cust_pkg_usageprice = new FS::cust_pkg_usageprice {
2637 'pkgnum' => $cust_pkg->pkgnum,
2638 'usagepricepart' => $old_cust_pkg_usageprice->usagepricepart,
2639 'quantity' => $old_cust_pkg_usageprice->quantity,
2641 $error = $new_cust_pkg_usageprice->insert;
2643 $dbh->rollback if $oldAutoCommit;
2644 return "Error transferring usage pricing add-on: $error";
2649 if (%new_discount && !$error) {
2651 # If discounts were explicitly specified in $opt
2652 $error = $cust_pkg->change_discount(%new_discount);
2654 $dbh->rollback if $oldAutoCommit;
2655 return "applying discounts: $error";
2658 } elsif ( $same_pkgpart ) {
2660 # transfer discounts, if we're not changing pkgpart
2661 foreach my $old_discount ($self->cust_pkg_discount_active) {
2662 # don't remove the old discount, we may still need to bill that package.
2663 my $new_discount = new FS::cust_pkg_discount {
2664 'pkgnum' => $cust_pkg->pkgnum,
2665 map { $_ => $old_discount->$_() }
2666 qw( discountnum months_used end_date usernum setuprecur ),
2668 $error = $new_discount->insert;
2670 $dbh->rollback if $oldAutoCommit;
2671 return "transferring discounts: $error";
2676 # transfer (copy) invoice details
2677 foreach my $detail ($self->cust_pkg_detail) {
2678 my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
2679 $new_detail->set('pkgdetailnum', '');
2680 $new_detail->set('pkgnum', $cust_pkg->pkgnum);
2681 $error = $new_detail->insert;
2683 $dbh->rollback if $oldAutoCommit;
2684 return "transferring package notes: $error";
2688 # transfer scheduled expire/adjourn reasons
2689 foreach my $action ('expire', 'adjourn') {
2690 if ( $cust_pkg->get($action) ) {
2691 my $reason = $self->last_cust_pkg_reason($action);
2693 $reason->set('pkgnum', $cust_pkg->pkgnum);
2694 $error = $reason->replace;
2696 $dbh->rollback if $oldAutoCommit;
2697 return "transferring $action reason: $error";
2705 if ( !$opt->{'cust_pkg'} ) {
2706 # Order any supplemental packages.
2707 my $part_pkg = $cust_pkg->part_pkg;
2708 my @old_supp_pkgs = $self->supplemental_pkgs;
2709 foreach my $link ($part_pkg->supp_part_pkg_link) {
2711 foreach (@old_supp_pkgs) {
2712 if ($_->pkgpart == $link->dst_pkgpart) {
2714 $_->pkgpart(0); # so that it can't match more than once
2718 # false laziness with FS::cust_main::Packages::order_pkg
2719 my $new = FS::cust_pkg->new({
2720 pkgpart => $link->dst_pkgpart,
2721 pkglinknum => $link->pkglinknum,
2722 custnum => $custnum,
2723 main_pkgnum => $cust_pkg->pkgnum,
2724 locationnum => $cust_pkg->locationnum,
2725 start_date => $cust_pkg->start_date,
2726 order_date => $cust_pkg->order_date,
2727 expire => $cust_pkg->expire,
2728 adjourn => $cust_pkg->adjourn,
2729 contract_end => $cust_pkg->contract_end,
2730 refnum => $cust_pkg->refnum,
2731 discountnum => $cust_pkg->discountnum,
2732 waive_setup => $cust_pkg->waive_setup,
2734 if ( $old and $opt->{'keep_dates'} ) {
2735 foreach (qw(setup bill last_bill)) {
2736 $new->set($_, $old->get($_));
2739 $error = $new->insert( allow_pkgpart => $same_pkgpart );
2742 $error ||= $old->transfer($new);
2744 if ( $error and $error > 0 ) {
2745 # no reason why this should ever fail, but still...
2746 $error = "Unable to transfer all services from supplemental package ".
2750 $dbh->rollback if $oldAutoCommit;
2753 push @new_supp_pkgs, $new;
2755 } # if !$opt->{'cust_pkg'}
2756 # because if there is one, then supplemental packages would already
2757 # have been created for it.
2759 #Good to go, cancel old package. Notify 'cancel' of whether to credit
2761 #Don't allow billing the package (preceding period packages and/or
2762 #outstanding usage) if we are keeping dates (i.e. location changing),
2763 #because the new package will be billed for the same date range.
2764 #Supplemental packages are also canceled here.
2766 # during scheduled changes, avoid canceling the package we just
2768 $self->set('change_to_pkgnum' => '');
2770 $error = $self->cancel(
2772 unused_credit => $unused_credit,
2773 nobill => $keep_dates,
2774 change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2775 no_delay_cancel => 1,
2778 $dbh->rollback if $oldAutoCommit;
2779 return "canceling old package: $error";
2782 # transfer rt_field_charge, if we're not changing pkgpart
2783 # after billing of old package, before billing of new package
2784 if ( $same_pkgpart ) {
2785 foreach my $rt_field_charge ($self->rt_field_charge) {
2786 $rt_field_charge->set('pkgnum', $cust_pkg->pkgnum);
2787 $error = $rt_field_charge->replace;
2789 $dbh->rollback if $oldAutoCommit;
2790 return "transferring rt_field_charge: $error";
2795 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2797 my $error = $cust_pkg->cust_main->bill(
2798 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2801 $dbh->rollback if $oldAutoCommit;
2802 return "billing new package: $error";
2806 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2812 =item change_later OPTION => VALUE...
2814 Schedule a package change for a later date. This actually orders the new
2815 package immediately, but sets its start date for a future date, and sets
2816 the current package to expire on the same date.
2818 If the package is already scheduled for a change, this can be called with
2819 'start_date' to change the scheduled date, or with pkgpart and/or
2820 locationnum to modify the package change. To cancel the scheduled change
2821 entirely, see C<abort_change>.
2829 The date for the package change. Required, and must be in the future.
2839 The pkgpart, locationnum, quantity and optional contract_end of the new
2840 package, with the same meaning as in C<change>.
2848 my $opt = ref($_[0]) ? shift : { @_ };
2850 # check contract_end, prevent adding/removing
2851 my $error = $self->_check_change($opt);
2852 return $error if $error;
2854 my $oldAutoCommit = $FS::UID::AutoCommit;
2855 local $FS::UID::AutoCommit = 0;
2858 my $cust_main = $self->cust_main;
2860 my $date = delete $opt->{'start_date'} or return 'start_date required';
2862 if ( $date <= time ) {
2863 $dbh->rollback if $oldAutoCommit;
2864 return "start_date $date is in the past";
2867 # If the user entered a new location, set it up now.
2868 if ( $opt->{'cust_location'} ) {
2869 $error = $opt->{'cust_location'}->find_or_insert;
2871 $dbh->rollback if $oldAutoCommit;
2872 return "creating location record: $error";
2874 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
2878 # Applies discounts to the newly created future_change package
2880 # If a new discount is the same as the old discount, carry over the
2881 # old discount's months_used/end_date fields too
2884 # Legacy behavior was to create the next package with no discount.
2885 # This behavior is preserved. Without the discount fields in $opt,
2886 # the new package will be created with no discounts.
2888 # parse discount information from $opt
2889 my %new_discount = $self->_parse_new_discounts($opt);
2891 if ( $self->change_to_pkgnum ) {
2892 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
2893 my $new_pkgpart = $opt->{'pkgpart'}
2894 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $change_to->pkgpart;
2895 my $new_locationnum = $opt->{'locationnum'}
2896 if $opt->{'locationnum'} and $opt->{'locationnum'} != $change_to->locationnum;
2897 my $new_quantity = $opt->{'quantity'}
2898 if $opt->{'quantity'} and $opt->{'quantity'} != $change_to->quantity;
2899 my $new_contract_end = $opt->{'contract_end'}
2900 if $opt->{'contract_end'} and $opt->{'contract_end'} != $change_to->contract_end;
2901 if ( $new_pkgpart or $new_locationnum or $new_quantity or $new_contract_end ) {
2902 # it hasn't been billed yet, so in principle we could just edit
2903 # it in place (w/o a package change), but that's bad form.
2904 # So change the package according to the new options...
2905 my $err_or_pkg = $change_to->change(%$opt);
2906 if ( ref $err_or_pkg ) {
2907 # Then set that package up for a future start.
2908 $self->set('change_to_pkgnum', $err_or_pkg->pkgnum);
2909 $self->set('expire', $date); # in case it's different
2910 $err_or_pkg->set('start_date', $date);
2911 $err_or_pkg->set('change_date', '');
2912 $err_or_pkg->set('change_pkgnum', '');
2914 $error = $self->replace ||
2915 $err_or_pkg->replace ||
2916 #because change() might've edited existing scheduled change in place
2917 (($err_or_pkg->pkgnum == $change_to->pkgnum) ? '' :
2918 $change_to->cancel('no_delay_cancel' => 1) ||
2919 $change_to->delete);
2921 $error = $err_or_pkg;
2923 } else { # change the start date only.
2924 $self->set('expire', $date);
2925 $change_to->set('start_date', $date);
2926 $error = $self->replace || $change_to->replace;
2929 if ( !$error && exists $opt->{waive_setup} ) {
2930 $change_to->set(waive_setup => $opt->{waive_setup} );
2931 $error = $change_to->insert();
2934 if ( !$error && %new_discount ) {
2935 $error = $change_to->change_discount(%new_discount);
2939 $dbh->rollback if $oldAutoCommit;
2942 $dbh->commit if $oldAutoCommit;
2945 } # if $self->change_to_pkgnum
2947 my $new_pkgpart = $opt->{'pkgpart'}
2948 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2949 my $new_locationnum = $opt->{'locationnum'}
2950 if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2951 my $new_quantity = $opt->{'quantity'}
2952 if $opt->{'quantity'} and $opt->{'quantity'} != $self->quantity;
2953 my $new_contract_end = $opt->{'contract_end'}
2954 if $opt->{'contract_end'} and $opt->{'contract_end'} != $self->contract_end;
2956 return '' unless $new_pkgpart or $new_locationnum or $new_quantity or $new_contract_end; # wouldn't do anything
2958 # allow $opt->{'locationnum'} = '' to specifically set it to null
2959 # (i.e. customer default location)
2960 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2962 my $new = FS::cust_pkg->new( {
2963 custnum => $self->custnum,
2964 locationnum => $opt->{'locationnum'},
2965 start_date => $date,
2966 map { $_ => ( $opt->{$_} || $self->$_() ) }
2967 qw( pkgpart quantity refnum salesnum contract_end )
2969 $error = $new->insert('change' => 1,
2970 'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2972 if ( !$error && %new_discount ) {
2973 $error = $new->change_discount(%new_discount);
2977 $self->set('change_to_pkgnum', $new->pkgnum);
2978 $self->set('expire', $date);
2979 $error = $self->replace;
2983 $dbh->rollback if $oldAutoCommit;
2985 $dbh->commit if $oldAutoCommit;
2991 # Helper method reads $opt hashref from change() and change_later()
2992 # Returns a hash of %new_discount suitable for passing to change_discount()
2993 sub _parse_new_discounts {
2994 my ($self, $opt) = @_;
2996 croak "Bad parameter list" unless ref $opt;
2999 map { $_->setuprecur => $_ }
3000 qsearch('cust_pkg_discount', {
3001 pkgnum => $self->pkgnum,
3006 for my $type(qw|setup recur|) {
3008 if (exists $opt->{"${type}_discountnum"}) {
3009 $new_discount{$type} = {
3010 discountnum => $opt->{"${type}_discountnum"},
3011 amount => $opt->{"${type}_discountnum_amount"},
3012 percent => $opt->{"${type}_discountnum_percent"},
3013 months => $opt->{"${type}_discountnum_months"},
3017 # Specified discountnum same as old discountnum, carry over addl fields
3019 exists $opt->{"${type}_discountnum"}
3020 && exists $old_discount{$type}
3021 && $opt->{"${type}_discountnum"} eq $old_discount{$type}->discountnum
3023 $new_discount{$type}->{months} = $old_discount{$type}->months;
3024 $new_discount{$type}->{end_date} = $old_discount{$type}->end_date;
3027 # No new discount specified, carryover old discount
3028 # If we wanted to abandon legacy behavior, and always carry old discounts
3031 # if (!exists $new_discount{$type} && $old_discount{$type}) {
3032 # $new_discount{$type} = {
3033 # discountnum => $old_discount{$type}->discountnum,
3034 # amount => $old_discount{$type}->amount,
3035 # percent => $old_discount{$type}->percent,
3036 # months => $old_discount{$type}->months,
3037 # end_date => $old_discount{$type}->end_date,
3043 warn "_parse_new_discounts(), pkgnum: ".$self->pkgnum." \n";
3044 warn "Determine \%old_discount, \%new_discount: \n";
3045 warn Dumper(\%old_discount);
3046 warn Dumper(\%new_discount);
3054 Cancels a future package change scheduled by C<change_later>.
3060 my $oldAutoCommit = $FS::UID::AutoCommit;
3061 local $FS::UID::AutoCommit = 0;
3063 my $pkgnum = $self->change_to_pkgnum;
3064 my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
3066 $self->set('change_to_pkgnum', '');
3067 $self->set('expire', '');
3068 $error = $self->replace;
3070 $error ||= $change_to->cancel || $change_to->delete;
3073 if ( $oldAutoCommit ) {
3084 =item set_quantity QUANTITY
3086 Change the package's quantity field. This is one of the few package properties
3087 that can safely be changed without canceling and reordering the package
3088 (because it doesn't affect tax eligibility). Returns an error or an
3095 $self = $self->replace_old; # just to make sure
3096 $self->quantity(shift);
3100 =item set_salesnum SALESNUM
3102 Change the package's salesnum (sales person) field. This is one of the few
3103 package properties that can safely be changed without canceling and reordering
3104 the package (because it doesn't affect tax eligibility). Returns an error or
3111 $self = $self->replace_old; # just to make sure
3112 $self->salesnum(shift);
3114 # XXX this should probably reassign any credit that's already been given
3117 =item modify_charge OPTIONS
3119 Change the properties of a one-time charge. The following properties can
3120 be changed this way:
3121 - pkg: the package description
3122 - classnum: the package class
3123 - additional: arrayref of additional invoice details to add to this package
3125 and, I<if the charge has not yet been billed>:
3126 - start_date: the date when it will be billed
3127 - amount: the setup fee to be charged
3128 - quantity: the multiplier for the setup fee
3129 - separate_bill: whether to put the charge on a separate invoice
3131 If you pass 'adjust_commission' => 1, and the classnum changes, and there are
3132 commission credits linked to this charge, they will be recalculated.
3139 my $part_pkg = $self->part_pkg;
3140 my $pkgnum = $self->pkgnum;
3143 my $oldAutoCommit = $FS::UID::AutoCommit;
3144 local $FS::UID::AutoCommit = 0;
3146 return "Can't use modify_charge except on one-time charges"
3147 unless $part_pkg->freq eq '0';
3149 if ( length($opt{'pkg'}) and $part_pkg->pkg ne $opt{'pkg'} ) {
3150 $part_pkg->set('pkg', $opt{'pkg'});
3153 my %pkg_opt = $part_pkg->options;
3154 my $pkg_opt_modified = 0;
3156 $opt{'additional'} ||= [];
3159 foreach (grep /^additional/, keys %pkg_opt) {
3160 ($i) = ($_ =~ /^additional_info(\d+)$/);
3161 $old_additional[$i] = $pkg_opt{$_} if $i;
3162 delete $pkg_opt{$_};
3165 for ( $i = 0; exists($opt{'additional'}->[$i]); $i++ ) {
3166 $pkg_opt{ "additional_info$i" } = $opt{'additional'}->[$i];
3167 if (!exists($old_additional[$i])
3168 or $old_additional[$i] ne $opt{'additional'}->[$i])
3170 $pkg_opt_modified = 1;
3173 $pkg_opt_modified = 1 if scalar(@old_additional) != $i;
3174 $pkg_opt{'additional_count'} = $i if $i > 0;
3177 if ( exists($opt{'classnum'}) and $part_pkg->classnum ne $opt{'classnum'} )
3180 $old_classnum = $part_pkg->classnum;
3181 $part_pkg->set('classnum', $opt{'classnum'});
3184 if ( !$self->get('setup') ) {
3185 # not yet billed, so allow amount, setup_cost, quantity, start_date,
3188 if ( exists($opt{'amount'})
3189 and $part_pkg->option('setup_fee') != $opt{'amount'}
3190 and $opt{'amount'} > 0 ) {
3192 $pkg_opt{'setup_fee'} = $opt{'amount'};
3193 $pkg_opt_modified = 1;
3196 if ( exists($opt{'setup_cost'})
3197 and $part_pkg->setup_cost != $opt{'setup_cost'}
3198 and $opt{'setup_cost'} > 0 ) {
3200 $part_pkg->set('setup_cost', $opt{'setup_cost'});
3203 if ( exists($opt{'quantity'})
3204 and $opt{'quantity'} != $self->quantity
3205 and $opt{'quantity'} > 0 ) {
3207 $self->set('quantity', $opt{'quantity'});
3210 if ( exists($opt{'start_date'})
3211 and $opt{'start_date'} != $self->start_date ) {
3213 $self->set('start_date', $opt{'start_date'});
3216 if ( exists($opt{'separate_bill'})
3217 and $opt{'separate_bill'} ne $self->separate_bill ) {
3219 $self->set('separate_bill', $opt{'separate_bill'});
3223 } # else simply ignore them; the UI shouldn't allow editing the fields
3226 if ( exists($opt{'taxclass'})
3227 and $part_pkg->taxclass ne $opt{'taxclass'}) {
3229 $part_pkg->set('taxclass', $opt{'taxclass'});
3233 if ( $part_pkg->modified or $pkg_opt_modified ) {
3234 # can we safely modify the package def?
3235 # Yes, if it's not available for purchase, and this is the only instance
3237 if ( $part_pkg->disabled
3238 and FS::cust_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 1
3239 and FS::quotation_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 0
3241 $error = $part_pkg->replace( options => \%pkg_opt );
3244 $part_pkg = $part_pkg->clone;
3245 $part_pkg->set('disabled' => 'Y');
3246 $error = $part_pkg->insert( options => \%pkg_opt );
3247 # and associate this as yet-unbilled package to the new package def
3248 $self->set('pkgpart' => $part_pkg->pkgpart);
3251 $dbh->rollback if $oldAutoCommit;
3256 if ($self->modified) { # for quantity or start_date change, or if we had
3257 # to clone the existing package def
3258 my $error = $self->replace;
3259 return $error if $error;
3261 if (defined $old_classnum) {
3262 # fix invoice grouping records
3263 my $old_catname = $old_classnum
3264 ? FS::pkg_class->by_key($old_classnum)->categoryname
3266 my $new_catname = $opt{'classnum'}
3267 ? $part_pkg->pkg_class->categoryname
3269 if ( $old_catname ne $new_catname ) {
3270 foreach my $cust_bill_pkg ($self->cust_bill_pkg) {
3271 # (there should only be one...)
3272 my @display = qsearch( 'cust_bill_pkg_display', {
3273 'billpkgnum' => $cust_bill_pkg->billpkgnum,
3274 'section' => $old_catname,
3276 foreach (@display) {
3277 $_->set('section', $new_catname);
3278 $error = $_->replace;
3280 $dbh->rollback if $oldAutoCommit;
3284 } # foreach $cust_bill_pkg
3287 if ( $opt{'adjust_commission'} ) {
3288 # fix commission credits...tricky.
3289 foreach my $cust_event ($self->cust_event) {
3290 my $part_event = $cust_event->part_event;
3291 foreach my $table (qw(sales agent)) {
3293 "FS::part_event::Action::Mixin::credit_${table}_pkg_class";
3294 my $credit = qsearchs('cust_credit', {
3295 'eventnum' => $cust_event->eventnum,
3297 if ( $part_event->isa($class) ) {
3298 # Yes, this results in current commission rates being applied
3299 # retroactively to a one-time charge. For accounting purposes
3300 # there ought to be some kind of time limit on doing this.
3301 my $amount = $part_event->_calc_credit($self);
3302 if ( $credit and $credit->amount ne $amount ) {
3303 # Void the old credit.
3304 $error = $credit->void('Package class changed');
3306 $dbh->rollback if $oldAutoCommit;
3307 return "$error (adjusting commission credit)";
3310 # redo the event action to recreate the credit.
3312 eval { $part_event->do_action( $self, $cust_event ) };
3314 $dbh->rollback if $oldAutoCommit;
3317 } # if $part_event->isa($class)
3319 } # foreach $cust_event
3320 } # if $opt{'adjust_commission'}
3321 } # if defined $old_classnum
3323 $dbh->commit if $oldAutoCommit;
3327 sub process_bulk_cust_pkg {
3330 warn Dumper($param) if $DEBUG;
3332 my $new_part_pkg = qsearchs('part_pkg',
3333 { pkgpart => $param->{'new_pkgpart'} });
3334 die "Must select a new package definition\n" unless $new_part_pkg;
3336 #my $keep_dates = $param->{'keep_dates'} || 0;
3337 my $keep_dates = 1; # there is no good reason to turn this off
3339 my $oldAutoCommit = $FS::UID::AutoCommit;
3340 local $FS::UID::AutoCommit = 0;
3343 my @old_pkgpart = ref($param->{'old_pkgpart'}) ? @{ $param->{'old_pkgpart'} }
3344 : $param->{'old_pkgpart'};
3346 my @cust_pkgs = qsearch({
3347 'table' => 'cust_pkg',
3348 'extra_sql' => ' WHERE pkgpart IN ('.
3349 join(',', @old_pkgpart). ')',
3353 foreach my $old_cust_pkg ( @cust_pkgs ) {
3355 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
3356 if ( $old_cust_pkg->getfield('cancel') ) {
3357 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
3358 $old_cust_pkg->pkgnum."\n"
3362 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
3364 my $error = $old_cust_pkg->change(
3365 'pkgpart' => $param->{'new_pkgpart'},
3366 'keep_dates' => $keep_dates
3368 if ( !ref($error) ) { # change returns the cust_pkg on success
3370 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
3373 $dbh->commit if $oldAutoCommit;
3379 Returns the last bill date, or if there is no last bill date, the setup date.
3380 Useful for billing metered services.
3386 return $self->setfield('last_bill', $_[0]) if @_;
3387 return $self->getfield('last_bill') if $self->getfield('last_bill');
3388 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
3389 'edate' => $self->bill, } );
3390 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
3393 =item last_cust_pkg_reason ACTION
3395 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
3396 Returns false if there is no reason or the package is not currenly ACTION'd
3397 ACTION is one of adjourn, susp, cancel, or expire.
3401 sub last_cust_pkg_reason {
3402 my ( $self, $action ) = ( shift, shift );
3403 my $date = $self->get($action);
3405 'table' => 'cust_pkg_reason',
3406 'hashref' => { 'pkgnum' => $self->pkgnum,
3407 'action' => substr(uc($action), 0, 1),
3410 'order_by' => 'ORDER BY num DESC LIMIT 1',
3414 =item last_reason ACTION
3416 Returns the most recent ACTION FS::reason associated with the package.
3417 Returns false if there is no reason or the package is not currenly ACTION'd
3418 ACTION is one of adjourn, susp, cancel, or expire.
3423 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
3424 $cust_pkg_reason->reason
3425 if $cust_pkg_reason;
3430 Returns the definition for this billing item, as an FS::part_pkg object (see
3437 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
3438 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
3439 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
3444 Returns the cancelled package this package was changed from, if any.
3450 return '' unless $self->change_pkgnum;
3451 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
3454 =item change_cust_main
3456 Returns the customter this package was detached to, if any.
3460 sub change_cust_main {
3462 return '' unless $self->change_custnum;
3463 qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
3468 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
3475 $self->part_pkg->calc_setup($self, @_);
3480 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
3487 $self->part_pkg->calc_recur($self, @_);
3492 Calls the I<base_setup> of the FS::part_pkg object associated with this billing
3499 $self->part_pkg->base_setup($self, @_);
3504 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
3511 $self->part_pkg->base_recur($self, @_);
3516 Calls the I<calc_remain> of the FS::part_pkg object associated with this
3523 $self->part_pkg->calc_remain($self, @_);
3528 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
3535 $self->part_pkg->calc_cancel($self, @_);
3540 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
3546 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
3549 =item cust_pkg_detail [ DETAILTYPE ]
3551 Returns any customer package details for this package (see
3552 L<FS::cust_pkg_detail>).
3554 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
3558 sub cust_pkg_detail {
3560 my %hash = ( 'pkgnum' => $self->pkgnum );
3561 $hash{detailtype} = shift if @_;
3563 'table' => 'cust_pkg_detail',
3564 'hashref' => \%hash,
3565 'order_by' => 'ORDER BY weight, pkgdetailnum',
3569 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
3571 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
3573 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
3575 If there is an error, returns the error, otherwise returns false.
3579 sub set_cust_pkg_detail {
3580 my( $self, $detailtype, @details ) = @_;
3582 my $oldAutoCommit = $FS::UID::AutoCommit;
3583 local $FS::UID::AutoCommit = 0;
3586 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
3587 my $error = $current->delete;
3589 $dbh->rollback if $oldAutoCommit;
3590 return "error removing old detail: $error";
3594 foreach my $detail ( @details ) {
3595 my $cust_pkg_detail = new FS::cust_pkg_detail {
3596 'pkgnum' => $self->pkgnum,
3597 'detailtype' => $detailtype,
3598 'detail' => $detail,
3600 my $error = $cust_pkg_detail->insert;
3602 $dbh->rollback if $oldAutoCommit;
3603 return "error adding new detail: $error";
3608 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3615 Returns the customer billing events (see L<FS::cust_event>) for this invoice.
3619 #false laziness w/cust_bill.pm
3623 'table' => 'cust_event',
3624 'addl_from' => 'JOIN part_event USING ( eventpart )',
3625 'hashref' => { 'tablenum' => $self->pkgnum },
3626 'extra_sql' => " AND eventtable = 'cust_pkg' ",
3630 =item num_cust_event
3632 Returns the number of customer billing events (see L<FS::cust_event>) for this package.
3636 #false laziness w/cust_bill.pm
3637 sub num_cust_event {
3639 my $sql = "SELECT COUNT(*) ". $self->_from_cust_event_where;
3640 $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref->[0];
3643 =item exists_cust_event
3645 Returns true if there are customer billing events (see L<FS::cust_event>) for this package. More efficient than using num_cust_event.
3649 sub exists_cust_event {
3651 my $sql = "SELECT 1 ". $self->_from_cust_event_where. " LIMIT 1";
3652 my $row = $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref;
3653 $row ? $row->[0] : '';
3656 sub _from_cust_event_where {
3658 " FROM cust_event JOIN part_event USING ( eventpart ) ".
3659 " WHERE tablenum = ? AND eventtable = 'cust_pkg' ";
3663 my( $self, $sql, @args ) = @_;
3664 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
3665 $sth->execute(@args) or die $sth->errstr. " executing $sql";
3669 =item part_pkg_currency_option OPTIONNAME
3671 Returns a two item list consisting of the currency of this customer, if any,
3672 and a value for the provided option. If the customer has a currency, the value
3673 is the option value the given name and the currency (see
3674 L<FS::part_pkg_currency>). Otherwise, if the customer has no currency, is the
3675 regular option value for the given name (see L<FS::part_pkg_option>).
3679 sub part_pkg_currency_option {
3680 my( $self, $optionname ) = @_;
3681 my $part_pkg = $self->part_pkg;
3682 if ( my $currency = $self->cust_main->currency ) {
3683 ($currency, $part_pkg->part_pkg_currency_option($currency, $optionname) );
3685 ('', $part_pkg->option($optionname) );
3689 =item cust_svc [ SVCPART ] (old, deprecated usage)
3691 =item cust_svc [ OPTION => VALUE ... ] (current usage)
3693 =item cust_svc_unsorted [ OPTION => VALUE ... ]
3695 Returns the services for this package, as FS::cust_svc objects (see
3696 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
3697 spcififed, returns only the matching services.
3699 As an optimization, use the cust_svc_unsorted version if you are not displaying
3706 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
3707 $self->_sort_cust_svc( $self->cust_svc_unsorted_arrayref(@_) );
3710 sub cust_svc_unsorted {
3712 @{ $self->cust_svc_unsorted_arrayref(@_) };
3715 sub cust_svc_unsorted_arrayref {
3718 return [] unless $self->num_cust_svc(@_);
3721 if ( @_ && $_[0] =~ /^\d+/ ) {
3722 $opt{svcpart} = shift;
3723 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3730 'select' => 'cust_svc.*, part_svc.*',
3731 'table' => 'cust_svc',
3732 'hashref' => { 'pkgnum' => $self->pkgnum },
3733 'addl_from' => 'LEFT JOIN part_svc USING ( svcpart )',
3735 $search{hashref}->{svcpart} = $opt{svcpart}
3737 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{svcdb} )
3740 [ qsearch(\%search) ];
3744 =item overlimit [ SVCPART ]
3746 Returns the services for this package which have exceeded their
3747 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
3748 is specified, return only the matching services.
3754 return () unless $self->num_cust_svc(@_);
3755 grep { $_->overlimit } $self->cust_svc(@_);
3758 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3760 Returns historical services for this package created before END TIMESTAMP and
3761 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
3762 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
3763 I<pkg_svc.hidden> flag will be omitted.
3769 warn "$me _h_cust_svc called on $self\n"
3772 my ($end, $start, $mode) = @_;
3774 local($FS::Record::qsearch_qualify_columns) = 0;
3776 my @cust_svc = $self->_sort_cust_svc(
3777 [ qsearch( 'h_cust_svc',
3778 { 'pkgnum' => $self->pkgnum, },
3779 FS::h_cust_svc->sql_h_search(@_),
3783 if ( defined($mode) && $mode eq 'I' ) {
3784 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
3785 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
3791 sub _sort_cust_svc {
3792 my( $self, $arrayref ) = @_;
3795 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
3797 my %pkg_svc = map { $_->svcpart => $_ }
3798 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
3803 my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
3805 $pkg_svc ? $pkg_svc->primary_svc : '',
3806 $pkg_svc ? $pkg_svc->quantity : 0,
3813 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
3815 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
3817 Returns the number of services for this package. Available options are svcpart
3818 and svcdb. If either is spcififed, returns only the matching services.
3825 return $self->{'_num_cust_svc'}
3827 && exists($self->{'_num_cust_svc'})
3828 && $self->{'_num_cust_svc'} =~ /\d/;
3830 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
3834 if ( @_ && $_[0] =~ /^\d+/ ) {
3835 $opt{svcpart} = shift;
3836 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3842 my $select = 'SELECT COUNT(*) FROM cust_svc ';
3843 my $where = ' WHERE pkgnum = ? ';
3844 my @param = ($self->pkgnum);
3846 if ( $opt{'svcpart'} ) {
3847 $where .= ' AND svcpart = ? ';
3848 push @param, $opt{'svcpart'};
3850 if ( $opt{'svcdb'} ) {
3851 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
3852 $where .= ' AND svcdb = ? ';
3853 push @param, $opt{'svcdb'};
3856 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
3857 $sth->execute(@param) or die $sth->errstr;
3858 $sth->fetchrow_arrayref->[0];
3861 =item available_part_svc
3863 Returns a list of FS::part_svc objects representing services included in this
3864 package but not yet provisioned. Each FS::part_svc object also has an extra
3865 field, I<num_avail>, which specifies the number of available services.
3867 Accepts option I<provision_hold>; if true, only returns part_svc for which the
3868 associated pkg_svc has the provision_hold flag set.
3872 sub available_part_svc {
3876 my $pkg_quantity = $self->quantity || 1;
3878 grep { $_->num_avail > 0 }
3880 my $part_svc = $_->part_svc;
3881 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
3882 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
3884 # more evil encapsulation breakage
3885 if ($part_svc->{'Hash'}{'num_avail'} > 0) {
3886 my @exports = $part_svc->part_export_did;
3887 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
3892 grep { $opt{'provision_hold'} ? $_->provision_hold : 1 }
3893 $self->part_pkg->pkg_svc;
3896 =item part_svc [ OPTION => VALUE ... ]
3898 Returns a list of FS::part_svc objects representing provisioned and available
3899 services included in this package. Each FS::part_svc object also has the
3900 following extra fields:
3914 (services) - array reference containing the provisioned services, as cust_svc objects
3918 Accepts two options:
3922 =item summarize_size
3924 If true, will omit the extra cust_pkg_svc option for objects where num_cust_svc
3925 is this size or greater.
3927 =item hide_discontinued
3929 If true, will omit looking for services that are no longer avaialble in the
3937 #label -> ($cust_svc->label)[1]
3943 my $pkg_quantity = $self->quantity || 1;
3945 #XXX some sort of sort order besides numeric by svcpart...
3946 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
3948 my $part_svc = $pkg_svc->part_svc;
3949 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3950 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
3951 $part_svc->{'Hash'}{'num_avail'} =
3952 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
3953 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3954 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
3955 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
3956 && $num_cust_svc >= $opt{summarize_size};
3957 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
3959 } $self->part_pkg->pkg_svc;
3961 unless ( $opt{hide_discontinued} ) {
3963 push @part_svc, map {
3965 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3966 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
3967 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
3968 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3969 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
3971 } $self->extra_part_svc;
3978 =item extra_part_svc
3980 Returns a list of FS::part_svc objects corresponding to services in this
3981 package which are still provisioned but not (any longer) available in the
3986 sub extra_part_svc {
3989 my $pkgnum = $self->pkgnum;
3990 #my $pkgpart = $self->pkgpart;
3993 # 'table' => 'part_svc',
3996 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
3997 # WHERE pkg_svc.svcpart = part_svc.svcpart
3998 # AND pkg_svc.pkgpart = ?
4001 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
4002 # LEFT JOIN cust_pkg USING ( pkgnum )
4003 # WHERE cust_svc.svcpart = part_svc.svcpart
4006 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
4009 #seems to benchmark slightly faster... (or did?)
4011 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
4012 my $pkgparts = join(',', @pkgparts);
4015 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
4016 #MySQL doesn't grok DISINCT ON
4017 'select' => 'DISTINCT part_svc.*',
4018 'table' => 'part_svc',
4020 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
4021 AND pkg_svc.pkgpart IN ($pkgparts)
4024 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
4025 LEFT JOIN cust_pkg USING ( pkgnum )
4028 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
4029 'extra_param' => [ [$self->pkgnum=>'int'] ],
4035 Returns a short status string for this package, currently:
4041 =item not yet billed
4043 =item one-time charge
4058 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
4060 return 'cancelled' if $self->get('cancel');
4061 return 'on hold' if $self->susp && ! $self->setup;
4062 return 'suspended' if $self->susp;
4063 return 'not yet billed' unless $self->setup;
4064 return 'one-time charge' if $freq =~ /^(0|$)/;
4068 =item ucfirst_status
4070 Returns the status with the first character capitalized.
4074 sub ucfirst_status {
4075 ucfirst(shift->status);
4080 Class method that returns the list of possible status strings for packages
4081 (see L<the status method|/status>). For example:
4083 @statuses = FS::cust_pkg->statuses();
4087 tie my %statuscolor, 'Tie::IxHash',
4088 'on hold' => 'FF00F5', #brighter purple!
4089 'not yet billed' => '009999', #teal? cyan?
4090 'one-time charge' => '0000CC', #blue #'000000',
4091 'active' => '00CC00',
4092 'suspended' => 'FF9900',
4093 'cancelled' => 'FF0000',
4097 my $self = shift; #could be class...
4098 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
4099 # # mayble split btw one-time vs. recur
4110 Returns a hex triplet color string for this package's status.
4116 $statuscolor{$self->status};
4119 =item is_status_delay_cancel
4121 Returns true if part_pkg has option delay_cancel,
4122 cust_pkg status is 'suspended' and expire is set
4123 to cancel package within the next day (or however
4124 many days are set in global config part_pkg-delay_cancel-days.
4126 Accepts option I<part_pkg-delay_cancel-days> which should be
4127 the value of the config setting, to avoid looking it up again.
4129 This is not a real status, this only meant for hacking display
4130 values, because otherwise treating the package as suspended is
4131 really the whole point of the delay_cancel option.
4135 sub is_status_delay_cancel {
4136 my ($self,%opt) = @_;
4137 if ( $self->main_pkgnum and $self->pkglinknum ) {
4138 return $self->main_pkg->is_status_delay_cancel;
4140 return 0 unless $self->part_pkg->option('delay_cancel',1);
4141 return 0 unless $self->status eq 'suspended';
4142 return 0 unless $self->expire;
4143 my $expdays = $opt{'part_pkg-delay_cancel-days'};
4145 my $conf = new FS::Conf;
4146 $expdays = $conf->config('part_pkg-delay_cancel-days') || 1;
4148 my $expsecs = 60*60*24*$expdays;
4149 return 0 unless $self->expire < time + $expsecs;
4155 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
4156 "pkg - comment" depending on user preference).
4162 my $label = $self->part_pkg->pkg_comment( cust_pkg=>$self, nopkgpart=>1 );
4163 $label = $self->pkgnum. ": $label"
4164 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
4168 =item pkg_label_long
4170 Returns a long label for this package, adding the primary service's label to
4175 sub pkg_label_long {
4177 my $label = $self->pkg_label;
4178 my $cust_svc = $self->primary_cust_svc;
4179 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
4185 Returns a customer-localized label for this package.
4191 $self->part_pkg->pkg_locale( $self->cust_main->locale );
4194 =item primary_cust_svc
4196 Returns a primary service (as FS::cust_svc object) if one can be identified.
4200 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
4202 sub primary_cust_svc {
4205 my @cust_svc = $self->cust_svc;
4207 return '' unless @cust_svc; #no serivces - irrelevant then
4209 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
4211 # primary service as specified in the package definition
4212 # or exactly one service definition with quantity one
4213 my $svcpart = $self->part_pkg->svcpart;
4214 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
4215 return $cust_svc[0] if scalar(@cust_svc) == 1;
4217 #couldn't identify one thing..
4223 Returns a list of lists, calling the label method for all services
4224 (see L<FS::cust_svc>) of this billing item.
4230 map { [ $_->label ] } $self->cust_svc;
4233 =item h_labels END_TIMESTAMP [, START_TIMESTAMP [, MODE [, LOCALE ] ] ]
4235 Like the labels method, but returns historical information on services that
4236 were active as of END_TIMESTAMP and (optionally) not cancelled before
4237 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
4238 I<pkg_svc.hidden> flag will be omitted.
4240 If LOCALE is passed, service definition names will be localized.
4242 Returns a list of lists, calling the label method for all (historical)
4243 services (see L<FS::h_cust_svc>) of this billing item.
4249 my ($end, $start, $mode, $locale) = @_;
4250 warn "$me h_labels\n"
4252 map { [ $_->label($end, $start, $locale) ] }
4253 $self->h_cust_svc($end, $start, $mode);
4258 Like labels, except returns a simple flat list, and shortens long
4259 (currently >5 or the cust_bill-max_same_services configuration value) lists of
4260 identical services to one line that lists the service label and the number of
4261 individual services rather than individual items.
4266 shift->_labels_short( 'labels' ); # 'labels' takes no further arguments
4269 =item h_labels_short END_TIMESTAMP [, START_TIMESTAMP [, MODE [, LOCALE ] ] ]
4271 Like h_labels, except returns a simple flat list, and shortens long
4272 (currently >5 or the cust_bill-max_same_services configuration value) lists
4273 of identical services to one line that lists the service label and the
4274 number of individual services rather than individual items.
4278 sub h_labels_short {
4279 shift->_labels_short( 'h_labels', @_ );
4282 # takes a method name ('labels' or 'h_labels') and all its arguments;
4283 # maybe should be "shorten($self->h_labels( ... ) )"
4286 my( $self, $method ) = ( shift, shift );
4288 warn "$me _labels_short called on $self with $method method\n"
4291 my $conf = new FS::Conf;
4292 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
4294 warn "$me _labels_short populating \%labels\n"
4298 #tie %labels, 'Tie::IxHash';
4299 push @{ $labels{$_->[0]} }, $_->[1]
4300 foreach $self->$method(@_);
4302 warn "$me _labels_short populating \@labels\n"
4306 foreach my $label ( keys %labels ) {
4308 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
4309 my $num = scalar(@values);
4310 warn "$me _labels_short $num items for $label\n"
4313 if ( $num > $max_same_services ) {
4314 warn "$me _labels_short more than $max_same_services, so summarizing\n"
4316 push @labels, "$label ($num)";
4318 if ( $conf->exists('cust_bill-consolidate_services') ) {
4319 warn "$me _labels_short consolidating services\n"
4321 # push @labels, "$label: ". join(', ', @values);
4323 my $detail = "$label: ";
4324 $detail .= shift(@values). ', '
4326 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
4328 push @labels, $detail;
4330 warn "$me _labels_short done consolidating services\n"
4333 warn "$me _labels_short adding service data\n"
4335 push @labels, map { "$label: $_" } @values;
4346 Returns the parent customer object (see L<FS::cust_main>).
4350 Returns the balance for this specific package, when using
4351 experimental package balance.
4357 $self->cust_main->balance_pkgnum( $self->pkgnum );
4360 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
4364 Returns the location object, if any (see L<FS::cust_location>).
4366 =item cust_location_or_main
4368 If this package is associated with a location, returns the locaiton (see
4369 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
4371 =item location_label [ OPTION => VALUE ... ]
4373 Returns the label of the location object (see L<FS::cust_location>).
4377 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
4379 =item tax_locationnum
4381 Returns the foreign key to a L<FS::cust_location> object for calculating
4382 tax on this package, as determined by the C<tax-pkg_address> and
4383 C<tax-ship_address> configuration flags.
4387 sub tax_locationnum {
4389 my $conf = FS::Conf->new;
4390 if ( $conf->exists('tax-pkg_address') ) {
4391 return $self->locationnum;
4393 elsif ( $conf->exists('tax-ship_address') ) {
4394 return $self->cust_main->ship_locationnum;
4397 return $self->cust_main->bill_locationnum;
4403 Returns the L<FS::cust_location> object for tax_locationnum.
4409 my $conf = FS::Conf->new;
4410 if ( $conf->exists('tax-pkg_address') and $self->locationnum ) {
4411 return FS::cust_location->by_key($self->locationnum);
4413 elsif ( $conf->exists('tax-ship_address') ) {
4414 return $self->cust_main->ship_location;
4417 return $self->cust_main->bill_location;
4421 =item seconds_since TIMESTAMP
4423 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
4424 package have been online since TIMESTAMP, according to the session monitor.
4426 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
4427 L<Time::Local> and L<Date::Parse> for conversion functions.
4432 my($self, $since) = @_;
4435 foreach my $cust_svc (
4436 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
4438 $seconds += $cust_svc->seconds_since($since);
4445 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
4447 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
4448 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
4451 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
4452 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
4458 sub seconds_since_sqlradacct {
4459 my($self, $start, $end) = @_;
4463 foreach my $cust_svc (
4465 my $part_svc = $_->part_svc;
4466 $part_svc->svcdb eq 'svc_acct'
4467 && scalar($part_svc->part_export_usage);
4470 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
4477 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
4479 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
4480 in this package for sessions ending between TIMESTAMP_START (inclusive) and
4484 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
4485 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
4490 sub attribute_since_sqlradacct {
4491 my($self, $start, $end, $attrib) = @_;
4495 foreach my $cust_svc (
4497 my $part_svc = $_->part_svc;
4498 scalar($part_svc->part_export_usage);
4501 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
4513 my( $self, $value ) = @_;
4514 if ( defined($value) ) {
4515 $self->setfield('quantity', $value);
4517 $self->getfield('quantity') || 1;
4520 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
4522 Transfers as many services as possible from this package to another package.
4524 The destination package can be specified by pkgnum by passing an FS::cust_pkg
4525 object. The destination package must already exist.
4527 Services are moved only if the destination allows services with the correct
4528 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
4529 this option with caution! No provision is made for export differences
4530 between the old and new service definitions. Probably only should be used
4531 when your exports for all service definitions of a given svcdb are identical.
4532 (attempt a transfer without it first, to move all possible svcpart-matching
4535 Any services that can't be moved remain in the original package.
4537 Returns an error, if there is one; otherwise, returns the number of services
4538 that couldn't be moved.
4543 my ($self, $dest_pkgnum, %opt) = @_;
4549 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
4550 $dest = $dest_pkgnum;
4551 $dest_pkgnum = $dest->pkgnum;
4553 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
4556 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
4558 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
4559 $target{$pkg_svc->svcpart} = $pkg_svc->quantity * ( $dest->quantity || 1 );
4562 unless ( $self->pkgnum == $dest->pkgnum ) {
4563 foreach my $cust_svc ($dest->cust_svc) {
4564 $target{$cust_svc->svcpart}--;
4568 my %svcpart2svcparts = ();
4569 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
4570 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
4571 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
4572 next if exists $svcpart2svcparts{$svcpart};
4573 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
4574 $svcpart2svcparts{$svcpart} = [
4576 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
4578 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
4579 'svcpart' => $_ } );
4581 $pkg_svc ? $pkg_svc->primary_svc : '',
4582 $pkg_svc ? $pkg_svc->quantity : 0,
4586 grep { $_ != $svcpart }
4588 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
4590 warn "alternates for svcpart $svcpart: ".
4591 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
4597 foreach my $cust_svc ($self->cust_svc) {
4598 my $svcnum = $cust_svc->svcnum;
4600 if ( $target{$cust_svc->svcpart} > 0
4601 or $FS::cust_svc::ignore_quantity # maybe should be a 'force' option
4604 $target{$cust_svc->svcpart}--;
4606 local $FS::cust_svc::ignore_quantity = 1
4607 if $self->pkgnum == $dest->pkgnum;
4609 #why run replace at all in the $self->pkgnum == $dest->pkgnum case?
4610 # we do want to trigger location and pkg_change exports, but
4611 # without pkgnum changing from an old to new package, cust_svc->replace
4612 # doesn't know how to trigger those. :/
4613 # does this mean we scrap the whole idea of "safe to modify it in place",
4614 # or do we special-case and pass the info needed to cust_svc->replace? :/
4616 my $new = new FS::cust_svc { $cust_svc->hash };
4617 $new->pkgnum($dest_pkgnum);
4618 $error = $new->replace($cust_svc);
4620 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
4623 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
4624 warn "alternates to consider: ".
4625 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
4628 my @alternate = grep {
4629 warn "considering alternate svcpart $_: ".
4630 "$target{$_} available in new package\n"
4633 } @{$svcpart2svcparts{$cust_svc->svcpart}};
4636 warn "alternate(s) found\n" if $DEBUG;
4637 my $change_svcpart = $alternate[0];
4638 $target{$change_svcpart}--;
4639 my $new = new FS::cust_svc { $cust_svc->hash };
4640 $new->svcpart($change_svcpart);
4641 $new->pkgnum($dest_pkgnum);
4642 $error = $new->replace($cust_svc);
4652 my @label = $cust_svc->label;
4653 return "$label[0] $label[1]: $error";
4660 =item grab_svcnums SVCNUM, SVCNUM ...
4662 Change the pkgnum for the provided services to this packages. If there is an
4663 error, returns the error, otherwise returns false.
4671 my $oldAutoCommit = $FS::UID::AutoCommit;
4672 local $FS::UID::AutoCommit = 0;
4675 foreach my $svcnum (@svcnum) {
4676 my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
4677 $dbh->rollback if $oldAutoCommit;
4678 return "unknown svcnum $svcnum";
4680 $cust_svc->pkgnum( $self->pkgnum );
4681 my $error = $cust_svc->replace;
4683 $dbh->rollback if $oldAutoCommit;
4688 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4695 This method is deprecated. See the I<depend_jobnum> option to the insert and
4696 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
4700 #looks like this is still used by the order_pkg and change_pkg methods in
4701 # ClientAPI/MyAccount, need to look into those before removing
4705 my $oldAutoCommit = $FS::UID::AutoCommit;
4706 local $FS::UID::AutoCommit = 0;
4709 foreach my $cust_svc ( $self->cust_svc ) {
4710 #false laziness w/svc_Common::insert
4711 my $svc_x = $cust_svc->svc_x;
4712 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
4713 my $error = $part_export->export_insert($svc_x);
4715 $dbh->rollback if $oldAutoCommit;
4721 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4726 =item export_pkg_change OLD_CUST_PKG
4728 Calls the "pkg_change" export action for all services attached to this package.
4732 sub export_pkg_change {
4733 my( $self, $old ) = ( shift, shift );
4735 my $oldAutoCommit = $FS::UID::AutoCommit;
4736 local $FS::UID::AutoCommit = 0;
4739 foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
4740 my $error = $svc_x->export('pkg_change', $self, $old);
4742 $dbh->rollback if $oldAutoCommit;
4747 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4754 Associates this package with a (suspension or cancellation) reason (see
4755 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
4758 Available options are:
4764 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.
4768 the access_user (see L<FS::access_user>) providing the reason
4776 the action (cancel, susp, adjourn, expire) associated with the reason
4780 If there is an error, returns the error, otherwise returns false.
4785 my ($self, %options) = @_;
4787 my $otaker = $options{reason_otaker} ||
4788 $FS::CurrentUser::CurrentUser->username;
4791 if ( $options{'reason'} =~ /^(\d+)$/ ) {
4795 } elsif ( ref($options{'reason'}) ) {
4797 return 'Enter a new reason (or select an existing one)'
4798 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
4800 my $reason = new FS::reason({
4801 'reason_type' => $options{'reason'}->{'typenum'},
4802 'reason' => $options{'reason'}->{'reason'},
4804 my $error = $reason->insert;
4805 return $error if $error;
4807 $reasonnum = $reason->reasonnum;
4810 return "Unparseable reason: ". $options{'reason'};
4813 my $cust_pkg_reason =
4814 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
4815 'reasonnum' => $reasonnum,
4816 'otaker' => $otaker,
4817 'action' => substr(uc($options{'action'}),0,1),
4818 'date' => $options{'date'}
4823 $cust_pkg_reason->insert;
4826 =item insert_discount
4828 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
4829 inserting a new discount on the fly (see L<FS::discount>).
4831 This will look at the cust_pkg for a pseudo-field named "setup_discountnum",
4832 and if present, will create a setup discount. If the discountnum is -1,
4833 a new discount definition will be inserted using the value in
4834 "setup_discountnum_amount" or "setup_discountnum_percent". Likewise for recur.
4836 If there is an error, returns the error, otherwise returns false.
4840 sub insert_discount {
4841 #my ($self, %options) = @_;
4844 foreach my $x (qw(setup recur)) {
4845 if ( my $discountnum = $self->get("${x}_discountnum") ) {
4846 my $cust_pkg_discount = FS::cust_pkg_discount->new( {
4847 'pkgnum' => $self->pkgnum,
4848 'discountnum' => $discountnum,
4851 'end_date' => '', #XXX
4852 #for the create a new discount case
4853 'amount' => $self->get("${x}_discountnum_amount"),
4854 'percent' => $self->get("${x}_discountnum_percent"),
4855 'months' => $self->get("${x}_discountnum_months"),
4857 if ( $x eq 'setup' ) {
4858 $cust_pkg_discount->setup('Y');
4859 $cust_pkg_discount->months('');
4861 my $error = $cust_pkg_discount->insert;
4862 return $error if $error;
4869 =item change_discount %opt
4871 Method checks if the given values represent a change in either setup or
4872 discount level. If so, the existing discounts are revoked, the new
4873 discounts are recorded.
4877 $error = change_discount(
4880 # -1: Indicates a "custom discount"
4881 # 0: Indicates to remove any discount
4882 # >0: discountnum to apply
4883 discountnum => [-1, 0, discountnum],
4885 # When discountnum is "-1" to indicate custom discount, include
4886 # the additional fields:
4887 amount => AMOUNT_DISCOUNT
4888 percent => PERCENTAGE_DISCOUNT
4898 sub change_discount {
4899 my ($self, %opt) = @_;
4900 return "change_discount() called with bad \%opt"
4904 return "change_discount() called with unknown bad key $_"
4905 unless $_ eq 'setup' || $_ eq 'recur';
4909 qsearch('cust_pkg_discount',{
4910 pkgnum => $self->pkgnum,
4915 warn "change_discount() pkgnum: ".$self->pkgnum." \n";
4916 warn "change_discount() \%opt: \n";
4922 for my $type (qw|setup recur|) {
4923 next unless ref $opt{$type};
4924 my %change = %{$opt{$type}};
4926 return "change_discount() called with bad \$opt($type)"
4927 unless $change{discountnum} =~ /^-?\d+$/;
4929 if ($change{discountnum} eq 0) {
4930 # Removing old discount
4933 push @to_be_disabled, grep {$_->setuprecur eq $type} @old_discount;
4938 $_->discountnum eq $change{discountnum}
4939 && $_->setuprecur eq $type
4942 # Duplicate, disregard this entry
4946 # Mark any discounts we're replacing
4947 push @to_be_disabled, grep{ $_->setuprecur eq $type} @old_discount;
4954 # If we still have changes queued, pass them to insert_discount()
4955 # by setting values into object fields
4956 for my $type (keys %opt) {
4957 $self->set("${type}_discountnum", $opt{$type}->{discountnum});
4959 if ($opt{$type}->{discountnum} eq '-1') {
4960 $self->set("${type}_discountnum_${_}", $opt{$type}->{$_})
4961 for qw(amount percent months);
4967 warn "change_discount() \% opt before insert \n";
4969 warn "\@to_be_disabled \n";
4970 warn Dumper \@to_be_disabled;
4973 # Roll these updates into a transaction
4974 my $oldAutoCommit = $FS::UID::AutoCommit;
4975 local $FS::UID::AutoCommit = 0;
4980 # The "waive setup fee" flag has traditionally been handled by setting
4981 # $cust_pkg->waive_setup_fee = Y. This has been appropriately, and separately
4982 # handled, and it operates on a differetnt table than cust_pkg_discount,
4983 # so the "-2 for waive setup fee" option is not being reimplemented
4984 # here. Perhaps this may change later.
4986 # When a setup discount is entered, we still need unset waive_setup
4987 if ( $opt{setup} && $opt{setup} > -2 && $self->waive_setup ) {
4988 $self->set(waive_setup => '');
4989 $error = $self->replace();
4992 # Create new discounts
4993 $error ||= $self->insert_discount();
4995 # Disabling old discounts
4996 for my $tbd (@to_be_disabled) {
4998 $tbd->set(disabled => 'Y');
4999 $error = $tbd->replace();
5004 $dbh->rollback if $oldAutoCommit;
5008 $dbh->commit if $oldAutoCommit;
5012 =item set_usage USAGE_VALUE_HASHREF
5014 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
5015 to which they should be set (see L<FS::svc_acct>). Currently seconds,
5016 upbytes, downbytes, and totalbytes are appropriate keys.
5018 All svc_accts which are part of this package have their values reset.
5023 my ($self, $valueref, %opt) = @_;
5025 #only svc_acct can set_usage for now
5026 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
5027 my $svc_x = $cust_svc->svc_x;
5028 $svc_x->set_usage($valueref, %opt)
5029 if $svc_x->can("set_usage");
5033 =item recharge USAGE_VALUE_HASHREF
5035 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
5036 to which they should be set (see L<FS::svc_acct>). Currently seconds,
5037 upbytes, downbytes, and totalbytes are appropriate keys.
5039 All svc_accts which are part of this package have their values incremented.
5044 my ($self, $valueref) = @_;
5046 #only svc_acct can set_usage for now
5047 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
5048 my $svc_x = $cust_svc->svc_x;
5049 $svc_x->recharge($valueref)
5050 if $svc_x->can("recharge");
5054 =item apply_usageprice
5058 sub apply_usageprice {
5061 my $oldAutoCommit = $FS::UID::AutoCommit;
5062 local $FS::UID::AutoCommit = 0;
5067 foreach my $cust_pkg_usageprice ( $self->cust_pkg_usageprice ) {
5068 $error ||= $cust_pkg_usageprice->apply;
5072 $dbh->rollback if $oldAutoCommit;
5073 die "error applying part_pkg_usageprice add-ons, pkgnum ". $self->pkgnum.
5076 $dbh->commit if $oldAutoCommit;
5082 =item cust_pkg_discount
5084 =item cust_pkg_discount_active
5088 sub cust_pkg_discount_active {
5090 grep { $_->status eq 'active' } $self->cust_pkg_discount;
5093 =item cust_pkg_usage
5095 Returns a list of all voice usage counters attached to this package.
5097 =item apply_usage OPTIONS
5099 Takes the following options:
5100 - cdr: a call detail record (L<FS::cdr>)
5101 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
5102 - minutes: the maximum number of minutes to be charged
5104 Finds available usage minutes for a call of this class, and subtracts
5105 up to that many minutes from the usage pool. If the usage pool is empty,
5106 and the C<cdr-minutes_priority> global config option is set, minutes may
5107 be taken from other calls as well. Either way, an allocation record will
5108 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
5109 number of minutes of usage applied to the call.
5114 my ($self, %opt) = @_;
5115 my $cdr = $opt{cdr};
5116 my $rate_detail = $opt{rate_detail};
5117 my $minutes = $opt{minutes};
5118 my $classnum = $rate_detail->classnum;
5119 my $pkgnum = $self->pkgnum;
5120 my $custnum = $self->custnum;
5122 my $oldAutoCommit = $FS::UID::AutoCommit;
5123 local $FS::UID::AutoCommit = 0;
5126 my $order = FS::Conf->new->config('cdr-minutes_priority');
5130 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
5132 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
5134 my @usage_recs = qsearch({
5135 'table' => 'cust_pkg_usage',
5136 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
5137 ' JOIN cust_pkg USING (pkgnum)'.
5138 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
5139 'select' => 'cust_pkg_usage.*',
5140 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
5141 " ( cust_pkg.custnum = $custnum AND ".
5142 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
5143 $is_classnum . ' AND '.
5144 " cust_pkg_usage.minutes > 0",
5145 'order_by' => " ORDER BY priority ASC",
5148 my $orig_minutes = $minutes;
5150 while (!$error and $minutes > 0 and @usage_recs) {
5151 my $cust_pkg_usage = shift @usage_recs;
5152 $cust_pkg_usage->select_for_update;
5153 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
5154 pkgusagenum => $cust_pkg_usage->pkgusagenum,
5155 acctid => $cdr->acctid,
5156 minutes => min($cust_pkg_usage->minutes, $minutes),
5158 $cust_pkg_usage->set('minutes',
5159 $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes
5161 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
5162 $minutes -= $cdr_cust_pkg_usage->minutes;
5164 if ( $order and $minutes > 0 and !$error ) {
5165 # then try to steal minutes from another call
5167 'table' => 'cdr_cust_pkg_usage',
5168 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
5169 ' JOIN part_pkg_usage USING (pkgusagepart)'.
5170 ' JOIN cust_pkg USING (pkgnum)'.
5171 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
5172 ' JOIN cdr USING (acctid)',
5173 'select' => 'cdr_cust_pkg_usage.*',
5174 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
5175 " ( cust_pkg.pkgnum = $pkgnum OR ".
5176 " ( cust_pkg.custnum = $custnum AND ".
5177 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
5178 " part_pkg_usage_class.classnum = $classnum",
5179 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
5181 if ( $order eq 'time' ) {
5182 # find CDRs that are using minutes, but have a later startdate
5184 my $startdate = $cdr->startdate;
5185 if ($startdate !~ /^\d+$/) {
5186 die "bad cdr startdate '$startdate'";
5188 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
5189 # minimize needless reshuffling
5190 $search{'order_by'} .= ', cdr.startdate DESC';
5192 # XXX may not work correctly with rate_time schedules. Could
5193 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
5195 $search{'addl_from'} .=
5196 ' JOIN rate_detail'.
5197 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
5198 if ( $order eq 'rate_high' ) {
5199 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
5200 $rate_detail->min_charge;
5201 $search{'order_by'} .= ', rate_detail.min_charge ASC';
5202 } elsif ( $order eq 'rate_low' ) {
5203 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
5204 $rate_detail->min_charge;
5205 $search{'order_by'} .= ', rate_detail.min_charge DESC';
5207 # this should really never happen
5208 die "invalid cdr-minutes_priority value '$order'\n";
5211 my @cdr_usage_recs = qsearch(\%search);
5213 while (!$error and @cdr_usage_recs and $minutes > 0) {
5214 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
5215 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
5216 my $old_cdr = $cdr_cust_pkg_usage->cdr;
5217 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
5218 $cdr_cust_pkg_usage->select_for_update;
5219 $old_cdr->select_for_update;
5220 $cust_pkg_usage->select_for_update;
5221 # in case someone else stole the usage from this CDR
5222 # while waiting for the lock...
5223 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
5224 # steal the usage allocation and flag the old CDR for reprocessing
5225 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
5226 # if the allocation is more minutes than we need, adjust it...
5227 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
5229 $cdr_cust_pkg_usage->set('minutes', $minutes);
5230 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
5231 $error = $cust_pkg_usage->replace;
5233 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
5234 $error ||= $cdr_cust_pkg_usage->replace;
5235 # deduct the stolen minutes
5236 $minutes -= $cdr_cust_pkg_usage->minutes;
5238 # after all minute-stealing is done, reset the affected CDRs
5239 foreach (values %reproc_cdrs) {
5240 $error ||= $_->set_status('');
5241 # XXX or should we just call $cdr->rate right here?
5242 # it's not like we can create a loop this way, since the min_charge
5243 # or call time has to go monotonically in one direction.
5244 # we COULD get some very deep recursions going, though...
5246 } # if $order and $minutes
5249 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
5251 $dbh->commit if $oldAutoCommit;
5252 return $orig_minutes - $minutes;
5256 =item supplemental_pkgs
5258 Returns a list of all packages supplemental to this one.
5262 sub supplemental_pkgs {
5264 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
5269 Returns the package that this one is supplemental to, if any.
5275 if ( $self->main_pkgnum ) {
5276 return FS::cust_pkg->by_key($self->main_pkgnum);
5283 =head1 CLASS METHODS
5289 Returns an SQL expression identifying recurring packages.
5293 sub recurring_sql { "
5294 '0' != ( select freq from part_pkg
5295 where cust_pkg.pkgpart = part_pkg.pkgpart )
5300 Returns an SQL expression identifying one-time packages.
5305 '0' = ( select freq from part_pkg
5306 where cust_pkg.pkgpart = part_pkg.pkgpart )
5311 Returns an SQL expression identifying ordered packages (recurring packages not
5317 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
5322 Returns an SQL expression identifying active packages.
5327 $_[0]->recurring_sql. "
5328 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
5329 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5330 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
5333 =item not_yet_billed_sql
5335 Returns an SQL expression identifying packages which have not yet been billed.
5339 sub not_yet_billed_sql { "
5340 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
5341 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5342 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
5347 Returns an SQL expression identifying inactive packages (one-time packages
5348 that are otherwise unsuspended/uncancelled).
5352 sub inactive_sql { "
5353 ". $_[0]->onetime_sql(). "
5354 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
5355 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5356 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
5361 Returns an SQL expression identifying on-hold packages.
5366 #$_[0]->recurring_sql(). ' AND '.
5368 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5369 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
5370 AND ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
5377 Returns an SQL expression identifying suspended packages.
5381 sub suspended_sql { susp_sql(@_); }
5383 #$_[0]->recurring_sql(). ' AND '.
5385 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5386 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
5387 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
5394 Returns an SQL exprression identifying cancelled packages.
5398 sub cancelled_sql { cancel_sql(@_); }
5400 #$_[0]->recurring_sql(). ' AND '.
5401 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
5404 =item ncancelled_recurring_sql
5406 Returns an SQL expression identifying un-cancelled, recurring packages.
5410 sub ncancelled_recurring_sql {
5411 $_[0]->recurring_sql().
5412 " AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 ) ";
5417 Returns an SQL expression to give the package status as a string.
5423 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
5424 WHEN ( cust_pkg.susp IS NOT NULL AND cust_pkg.setup IS NULL ) THEN 'on hold'
5425 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
5426 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
5427 WHEN ".onetime_sql()." THEN 'one-time charge'
5434 Returns a list of two package counts. The first is a count of packages
5435 based on the supplied criteria and the second is the count of residential
5436 packages with those same criteria. Criteria are specified as in the search
5442 my ($class, $params) = @_;
5444 my $sql_query = $class->search( $params );
5446 my $count_sql = delete($sql_query->{'count_query'});
5447 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
5448 or die "couldn't parse count_sql";
5450 my $count_sth = dbh->prepare($count_sql)
5451 or die "Error preparing $count_sql: ". dbh->errstr;
5453 or die "Error executing $count_sql: ". $count_sth->errstr;
5454 my $count_arrayref = $count_sth->fetchrow_arrayref;
5456 return ( @$count_arrayref );
5460 =item tax_locationnum_sql
5462 Returns an SQL expression for the tax location for a package, based
5463 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
5467 sub tax_locationnum_sql {
5468 my $conf = FS::Conf->new;
5469 if ( $conf->exists('tax-pkg_address') ) {
5470 'cust_pkg.locationnum';
5472 elsif ( $conf->exists('tax-ship_address') ) {
5473 'cust_main.ship_locationnum';
5476 'cust_main.bill_locationnum';
5482 Returns a list: the first item is an SQL fragment identifying matching
5483 packages/customers via location (taking into account shipping and package
5484 address taxation, if enabled), and subsequent items are the parameters to
5485 substitute for the placeholders in that fragment.
5490 my($class, %opt) = @_;
5491 my $ornull = $opt{'ornull'};
5493 my $conf = new FS::Conf;
5495 # '?' placeholders in _location_sql_where
5496 my $x = $ornull ? 3 : 2;
5507 if ( $conf->exists('tax-ship_address') ) {
5510 ( ( ship_last IS NULL OR ship_last = '' )
5511 AND ". _location_sql_where('cust_main', '', $ornull ). "
5513 OR ( ship_last IS NOT NULL AND ship_last != ''
5514 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
5517 # AND payby != 'COMP'
5519 @main_param = ( @bill_param, @bill_param );
5523 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
5524 @main_param = @bill_param;
5530 if ( $conf->exists('tax-pkg_address') ) {
5532 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
5535 ( cust_pkg.locationnum IS NULL AND $main_where )
5536 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
5539 @param = ( @main_param, @bill_param );
5543 $where = $main_where;
5544 @param = @main_param;
5552 #subroutine, helper for location_sql
5553 sub _location_sql_where {
5555 my $prefix = @_ ? shift : '';
5556 my $ornull = @_ ? shift : '';
5558 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
5560 $ornull = $ornull ? ' OR ? IS NULL ' : '';
5562 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
5563 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
5564 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
5566 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
5568 # ( $table.${prefix}city = ? $or_empty_city $ornull )
5570 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
5571 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
5572 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
5573 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
5574 AND $table.${prefix}country = ?
5579 my( $self, $what ) = @_;
5581 my $what_show_zero = $what. '_show_zero';
5582 length($self->$what_show_zero())
5583 ? ($self->$what_show_zero() eq 'Y')
5584 : $self->part_pkg->$what_show_zero();
5591 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
5593 Bulk cancel + order subroutine. Perhaps slightly deprecated, only used by the
5594 bulk cancel+order in the web UI and nowhere else (edit/process/cust_pkg.cgi)
5596 CUSTNUM is a customer (see L<FS::cust_main>)
5598 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5599 L<FS::part_pkg>) to order for this customer. Duplicates are of course
5602 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
5603 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
5604 new billing items. An error is returned if this is not possible (see
5605 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
5608 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5609 newly-created cust_pkg objects.
5611 REFNUM, if specified, will specify the FS::pkg_referral record to be created
5612 and inserted. Multiple FS::pkg_referral records can be created by
5613 setting I<refnum> to an array reference of refnums or a hash reference with
5614 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
5615 record will be created corresponding to cust_main.refnum.
5620 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
5622 my $conf = new FS::Conf;
5624 # Transactionize this whole mess
5625 my $oldAutoCommit = $FS::UID::AutoCommit;
5626 local $FS::UID::AutoCommit = 0;
5630 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
5631 # return "Customer not found: $custnum" unless $cust_main;
5633 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
5636 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5639 my $change = scalar(@old_cust_pkg) != 0;
5642 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
5644 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
5645 " to pkgpart ". $pkgparts->[0]. "\n"
5648 my $err_or_cust_pkg =
5649 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
5650 'refnum' => $refnum,
5653 unless (ref($err_or_cust_pkg)) {
5654 $dbh->rollback if $oldAutoCommit;
5655 return $err_or_cust_pkg;
5658 push @$return_cust_pkg, $err_or_cust_pkg;
5659 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5664 # Create the new packages.
5665 foreach my $pkgpart (@$pkgparts) {
5667 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
5669 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
5670 pkgpart => $pkgpart,
5674 $error = $cust_pkg->insert( 'change' => $change );
5675 push @$return_cust_pkg, $cust_pkg;
5677 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
5678 my $supp_pkg = FS::cust_pkg->new({
5679 custnum => $custnum,
5680 pkgpart => $link->dst_pkgpart,
5682 main_pkgnum => $cust_pkg->pkgnum,
5685 $error ||= $supp_pkg->insert( 'change' => $change );
5686 push @$return_cust_pkg, $supp_pkg;
5690 $dbh->rollback if $oldAutoCommit;
5695 # $return_cust_pkg now contains refs to all of the newly
5698 # Transfer services and cancel old packages.
5699 foreach my $old_pkg (@old_cust_pkg) {
5701 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
5704 foreach my $new_pkg (@$return_cust_pkg) {
5705 $error = $old_pkg->transfer($new_pkg);
5706 if ($error and $error == 0) {
5707 # $old_pkg->transfer failed.
5708 $dbh->rollback if $oldAutoCommit;
5713 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
5714 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
5715 foreach my $new_pkg (@$return_cust_pkg) {
5716 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
5717 if ($error and $error == 0) {
5718 # $old_pkg->transfer failed.
5719 $dbh->rollback if $oldAutoCommit;
5726 # Transfers were successful, but we went through all of the
5727 # new packages and still had services left on the old package.
5728 # We can't cancel the package under the circumstances, so abort.
5729 $dbh->rollback if $oldAutoCommit;
5730 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
5732 $error = $old_pkg->cancel( quiet=>1, 'no_delay_cancel'=>1 );
5738 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5742 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
5744 A bulk change method to change packages for multiple customers.
5746 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
5747 L<FS::part_pkg>) to order for each customer. Duplicates are of course
5750 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
5751 replace. The services (see L<FS::cust_svc>) are moved to the
5752 new billing items. An error is returned if this is not possible (see
5755 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
5756 newly-created cust_pkg objects.
5761 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
5763 # Transactionize this whole mess
5764 my $oldAutoCommit = $FS::UID::AutoCommit;
5765 local $FS::UID::AutoCommit = 0;
5769 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
5772 while(scalar(@old_cust_pkg)) {
5774 my $custnum = $old_cust_pkg[0]->custnum;
5775 my (@remove) = map { $_->pkgnum }
5776 grep { $_->custnum == $custnum } @old_cust_pkg;
5777 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
5779 my $error = order $custnum, $pkgparts, \@remove, \@return;
5781 push @errors, $error
5783 push @$return_cust_pkg, @return;
5786 if (scalar(@errors)) {
5787 $dbh->rollback if $oldAutoCommit;
5788 return join(' / ', @errors);
5791 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5795 =item forward_emails
5797 Returns a hash of svcnums and corresponding email addresses
5798 for svc_acct services that can be used as source or dest
5799 for svc_forward services provisioned in this package.
5801 Accepts options I<svc_forward> OR I<svcnum> for a svc_forward
5802 service; if included, will ensure the current values of the
5803 specified service are included in the list, even if for some
5804 other reason they wouldn't be. If called as a class method
5805 with a specified service, returns only these current values.
5807 Caution: does not actually check if svc_forward services are
5808 available to be provisioned on this package.
5812 sub forward_emails {
5816 #load optional service, thoroughly validated
5817 die "Use svcnum or svc_forward, not both"
5818 if $opt{'svcnum'} && $opt{'svc_forward'};
5819 my $svc_forward = $opt{'svc_forward'};
5820 $svc_forward ||= qsearchs('svc_forward',{ 'svcnum' => $opt{'svcnum'} })
5822 die "Specified service is not a forward service"
5823 if $svc_forward && (ref($svc_forward) ne 'FS::svc_forward');
5824 die "Specified service not found"
5825 if ($opt{'svcnum'} || $opt{'svc_forward'}) && !$svc_forward;
5829 ## everything below was basically copied from httemplate/edit/svc_forward.cgi
5830 ## with minimal refactoring, not sure why we can't just load all svc_accts for this custnum
5832 #add current values from specified service, if there was one
5834 foreach my $method (qw( srcsvc_acct dstsvc_acct )) {
5835 my $svc_acct = $svc_forward->$method();
5836 $email{$svc_acct->svcnum} = $svc_acct->email if $svc_acct;
5840 if (ref($self) eq 'FS::cust_pkg') {
5842 #and including the rest for this customer
5843 my($u_part_svc,@u_acct_svcparts);
5844 foreach $u_part_svc ( qsearch('part_svc',{'svcdb'=>'svc_acct'}) ) {
5845 push @u_acct_svcparts,$u_part_svc->getfield('svcpart');
5848 my $custnum = $self->getfield('custnum');
5849 foreach my $i_cust_pkg ( qsearch('cust_pkg',{'custnum'=>$custnum}) ) {
5850 my $cust_pkgnum = $i_cust_pkg->getfield('pkgnum');
5851 #now find the corresponding record(s) in cust_svc (for this pkgnum!)
5852 foreach my $acct_svcpart (@u_acct_svcparts) {
5853 foreach my $i_cust_svc (
5854 qsearch( 'cust_svc', { 'pkgnum' => $cust_pkgnum,
5855 'svcpart' => $acct_svcpart } )
5857 my $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $i_cust_svc->svcnum } );
5858 $email{$svc_acct->svcnum} = $svc_acct->email;
5867 # Used by FS::Upgrade to migrate to a new database.
5868 sub _upgrade_schema { # class method
5869 my ($class, %opts) = @_;
5872 UPDATE cust_pkg SET change_to_pkgnum = NULL
5873 WHERE change_to_pkgnum IS NOT NULL
5874 AND NOT EXISTS ( SELECT 1 FROM cust_pkg AS ctcp
5875 WHERE ctcp.pkgnum = cust_pkg.change_to_pkgnum
5879 my $sth = dbh->prepare($sql) or die dbh->errstr;
5880 $sth->execute or die $sth->errstr;
5884 # Used by FS::Upgrade to migrate to a new database.
5885 sub _upgrade_data { # class method
5886 my ($class, %opts) = @_;
5887 $class->_upgrade_otaker(%opts);
5889 # RT#10139, bug resulting in contract_end being set when it shouldn't
5890 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
5891 # RT#10830, bad calculation of prorate date near end of year
5892 # the date range for bill is December 2009, and we move it forward
5893 # one year if it's before the previous bill date (which it should
5895 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
5896 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
5897 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
5898 # RT6628, add order_date to cust_pkg
5899 'update cust_pkg set order_date = (select history_date from h_cust_pkg
5900 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
5901 history_action = \'insert\') where order_date is null',
5903 foreach my $sql (@statements) {
5904 my $sth = dbh->prepare($sql);
5905 $sth->execute or die $sth->errstr;
5908 # RT31194: supplemental package links that are deleted don't clean up
5910 my @pkglinknums = qsearch({
5911 'select' => 'DISTINCT cust_pkg.pkglinknum',
5912 'table' => 'cust_pkg',
5913 'addl_from' => ' LEFT JOIN part_pkg_link USING (pkglinknum) ',
5914 'extra_sql' => ' WHERE cust_pkg.pkglinknum IS NOT NULL
5915 AND part_pkg_link.pkglinknum IS NULL',
5917 foreach (@pkglinknums) {
5918 my $pkglinknum = $_->pkglinknum;
5919 warn "cleaning part_pkg_link #$pkglinknum\n";
5920 my $part_pkg_link = FS::part_pkg_link->new({pkglinknum => $pkglinknum});
5921 my $error = $part_pkg_link->remove_linked;
5922 die $error if $error;
5925 # RT#73607: canceling a package with billing addons sometimes changes its
5927 # Find records where the last replace_new record for the package before it
5928 # was canceled has a different pkgpart from the package itself.
5929 my @cust_pkg = qsearch({
5930 'table' => 'cust_pkg',
5931 'select' => 'cust_pkg.*, h_cust_pkg.pkgpart AS h_pkgpart',
5932 'addl_from' => ' JOIN (
5933 SELECT pkgnum, MAX(historynum) AS historynum FROM h_cust_pkg
5934 WHERE cancel IS NULL
5935 AND history_action = \'replace_new\'
5937 ) AS last_history USING (pkgnum)
5938 JOIN h_cust_pkg USING (historynum)',
5939 'extra_sql' => ' WHERE cust_pkg.cancel is not null
5940 AND cust_pkg.pkgpart != h_cust_pkg.pkgpart'
5942 foreach my $cust_pkg ( @cust_pkg ) {
5943 my $pkgnum = $cust_pkg->pkgnum;
5944 warn "fixing pkgpart on canceled pkg#$pkgnum\n";
5945 $cust_pkg->set('pkgpart', $cust_pkg->h_pkgpart);
5946 my $error = $cust_pkg->replace;
5947 die $error if $error;
5956 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
5958 In sub order, the @pkgparts array (passed by reference) is clobbered.
5960 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
5961 method to pass dates to the recur_prog expression, it should do so.
5963 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
5964 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
5965 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
5966 configuration values. Probably need a subroutine which decides what to do
5967 based on whether or not we've fetched the user yet, rather than a hash. See
5968 FS::UID and the TODO.
5970 Now that things are transactional should the check in the insert method be
5975 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
5976 L<FS::pkg_svc>, schema.html from the base documentation