2 use base qw( FS::cust_pkg::Search FS::cust_pkg::API
3 FS::otaker_Mixin FS::cust_main_Mixin FS::Sales_Mixin
4 FS::contact_Mixin FS::location_Mixin
5 FS::m2m_Common FS::option_Common
10 use Scalar::Util qw( blessed );
11 use List::Util qw(min max);
13 use Time::Local qw( timelocal timelocal_nocheck );
15 use FS::UID qw( dbh driver_name );
16 use FS::Misc qw( send_email );
17 use FS::Record qw( qsearch qsearchs fields );
23 use FS::cust_location;
25 use FS::cust_bill_pkg;
26 use FS::cust_pkg_detail;
27 use FS::cust_pkg_usage;
28 use FS::cdr_cust_pkg_usage;
33 use FS::cust_pkg_reason;
35 use FS::cust_pkg_usageprice;
36 use FS::cust_pkg_discount;
42 # need to 'use' these instead of 'require' in sub { cancel, suspend, unsuspend,
44 # because they load configuration by setting FS::UID::callback (see TODO)
50 # for sending cancel emails in sub cancel
53 our ($disable_agentcheck, $DEBUG, $me, $import) = (0, 0, '[FS::cust_pkg]', 0);
55 our $upgrade = 0; #go away after setup+start dates cleaned up for old customers
59 my ( $hashref, $cache ) = @_;
60 #if ( $hashref->{'pkgpart'} ) {
61 if ( $hashref->{'pkg'} ) {
62 # #@{ $self->{'_pkgnum'} } = ();
63 # my $subcache = $cache->subcache('pkgpart', 'part_pkg');
64 # $self->{'_pkgpart'} = $subcache;
65 # #push @{ $self->{'_pkgnum'} },
66 # FS::part_pkg->new_or_cached($hashref, $subcache);
67 $self->{'_pkgpart'} = FS::part_pkg->new($hashref);
69 if ( exists $hashref->{'svcnum'} ) {
70 #@{ $self->{'_pkgnum'} } = ();
71 my $subcache = $cache->subcache('svcnum', 'cust_svc', $hashref->{pkgnum});
72 $self->{'_svcnum'} = $subcache;
73 #push @{ $self->{'_pkgnum'} },
74 FS::cust_svc->new_or_cached($hashref, $subcache) if $hashref->{svcnum};
80 FS::cust_pkg - Object methods for cust_pkg objects
86 $record = new FS::cust_pkg \%hash;
87 $record = new FS::cust_pkg { 'column' => 'value' };
89 $error = $record->insert;
91 $error = $new_record->replace($old_record);
93 $error = $record->delete;
95 $error = $record->check;
97 $error = $record->cancel;
99 $error = $record->suspend;
101 $error = $record->unsuspend;
103 $part_pkg = $record->part_pkg;
105 @labels = $record->labels;
107 $seconds = $record->seconds_since($timestamp);
109 $error = FS::cust_pkg::order( $custnum, \@pkgparts );
110 $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );
114 An FS::cust_pkg object represents a customer billing item. FS::cust_pkg
115 inherits from FS::Record. The following fields are currently supported:
121 Primary key (assigned automatically for new billing items)
125 Customer (see L<FS::cust_main>)
129 Billing item definition (see L<FS::part_pkg>)
133 Optional link to package location (see L<FS::location>)
137 date package was ordered (also remains same on changes)
149 date (next bill date)
177 order taker (see L<FS::access_user>)
181 If this field is set to 1, disables the automatic
182 unsuspension of this package when using the B<unsuspendauto> config option.
186 If not set, defaults to 1
190 Date of change from previous package
200 =item change_locationnum
208 The pkgnum of the package that this package is supplemental to, if any.
212 The package link (L<FS::part_pkg_link>) that defines this supplemental
213 package, if it is one.
215 =item change_to_pkgnum
217 The pkgnum of the package this one will be "changed to" in the future
218 (on its expiration date).
222 Note: setup, last_bill, bill, adjourn, susp, expire, cancel and change_date
223 are specified as UNIX timestamps; see L<perlfunc/"time">. Also see
224 L<Time::Local> and L<Date::Parse> for conversion functions.
232 Create a new billing item. To add the item to the database, see L<"insert">.
236 sub table { 'cust_pkg'; }
237 sub cust_linked { $_[0]->cust_main_custnum || $_[0]->custnum }
238 sub cust_unlinked_msg {
240 "WARNING: can't find cust_main.custnum ". $self->custnum.
241 ' (cust_pkg.pkgnum '. $self->pkgnum. ')';
244 =item set_initial_timers
246 If required by the package definition, sets any automatic expire, adjourn,
247 or contract_end timers to some number of months after the start date
248 (or setup date, if the package has already been setup). If the package has
249 a delayed setup fee after a period of "free days", will also set the
250 start date to the end of that period.
254 sub set_initial_timers {
256 my $part_pkg = $self->part_pkg;
257 foreach my $action ( qw(expire adjourn contract_end) ) {
258 my $months = $part_pkg->option("${action}_months",1);
259 if($months and !$self->get($action)) {
260 my $start = $self->start_date || $self->setup || time;
261 $self->set($action, $part_pkg->add_freq($start, $months) );
265 # if this package has "free days" and delayed setup fee, then
266 # set start date that many days in the future.
267 # (this should have been set in the UI, but enforce it here)
268 if ( $part_pkg->option('free_days',1)
269 && $part_pkg->option('delay_setup',1)
272 $self->start_date( $part_pkg->default_start_date );
277 =item insert [ OPTION => VALUE ... ]
279 Adds this billing item to the database ("Orders" the item). If there is an
280 error, returns the error, otherwise returns false.
282 If the additional field I<promo_code> is defined instead of I<pkgpart>, it
283 will be used to look up the package definition and agent restrictions will be
286 If the additional field I<refnum> is defined, an FS::pkg_referral record will
287 be created and inserted. Multiple FS::pkg_referral records can be created by
288 setting I<refnum> to an array reference of refnums or a hash reference with
289 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
290 record will be created corresponding to cust_main.refnum.
292 If the additional field I<cust_pkg_usageprice> is defined, it will be treated
293 as an arrayref of FS::cust_pkg_usageprice objects, which will be inserted.
294 (Note that this field cannot be set with a usual ->cust_pkg_usageprice method.
295 It can be set as part of the hash when creating the object, or with the B<set>
298 The following options are available:
304 If set true, supresses actions that should only be taken for new package
305 orders. (Currently this includes: intro periods when delay_setup is on,
306 auto-adding a 1st start date, auto-adding expiration/adjourn/contract_end dates)
310 cust_pkg_option records will be created
314 a ticket will be added to this customer with this subject
318 an optional queue name for ticket additions
322 Don't check the legality of the package definition. This should be used
323 when performing a package change that doesn't change the pkgpart (i.e.
331 my( $self, %options ) = @_;
334 $error = $self->check_pkgpart unless $options{'allow_pkgpart'};
335 return $error if $error;
337 my $part_pkg = $self->part_pkg;
339 if ( ! $import && ! $options{'change'} ) {
341 # set order date to now
342 $self->order_date(time) unless ($import && $self->order_date);
344 # if the package def says to start only on the first of the month:
345 if ( $part_pkg->option('start_1st', 1) && !$self->start_date ) {
346 my ($sec,$min,$hour,$mday,$mon,$year) = (localtime(time) )[0,1,2,3,4,5];
347 $mon += 1 unless $mday == 1;
348 until ( $mon < 12 ) { $mon -= 12; $year++; }
349 $self->start_date( timelocal_nocheck(0,0,0,1,$mon,$year) );
352 if ($self->susp eq 'now' or $part_pkg->start_on_hold) {
353 # if the package was ordered on hold:
355 # - don't set the start date (it will be started manually)
356 $self->set('susp', $self->order_date);
357 $self->set('start_date', '');
359 # set expire/adjourn/contract_end timers, and free days, if appropriate
360 $self->set_initial_timers;
362 } # else this is a package change, and shouldn't have "new package" behavior
364 my $oldAutoCommit = $FS::UID::AutoCommit;
365 local $FS::UID::AutoCommit = 0;
368 $error = $self->SUPER::insert($options{options} ? %{$options{options}} : ());
370 $dbh->rollback if $oldAutoCommit;
374 $self->refnum($self->cust_main->refnum) unless $self->refnum;
375 $self->refnum( [ $self->refnum ] ) unless ref($self->refnum);
376 $self->process_m2m( 'link_table' => 'pkg_referral',
377 'target_table' => 'part_referral',
378 'params' => $self->refnum,
381 if ( $self->hashref->{cust_pkg_usageprice} ) {
382 for my $cust_pkg_usageprice ( @{ $self->hashref->{cust_pkg_usageprice} } ) {
383 $cust_pkg_usageprice->pkgnum( $self->pkgnum );
384 my $error = $cust_pkg_usageprice->insert;
386 $dbh->rollback if $oldAutoCommit;
392 if ( $self->discountnum ) {
393 my $error = $self->insert_discount();
395 $dbh->rollback if $oldAutoCommit;
400 my $conf = new FS::Conf;
402 if ( ! $import && $conf->config('ticket_system') && $options{ticket_subject} ) {
404 #this init stuff is still inefficient, but at least its limited to
405 # the small number (any?) folks using ticket emailing on pkg order
408 # use lib ( "/opt/rt3/local/lib", "/opt/rt3/lib" );
415 use FS::TicketSystem;
416 FS::TicketSystem->init();
418 my $q = new RT::Queue($RT::SystemUser);
419 $q->Load($options{ticket_queue}) if $options{ticket_queue};
420 my $t = new RT::Ticket($RT::SystemUser);
421 my $mime = new MIME::Entity;
422 $mime->build( Type => 'text/plain', Data => $options{ticket_subject} );
423 $t->Create( $options{ticket_queue} ? (Queue => $q) : (),
424 Subject => $options{ticket_subject},
427 $t->AddLink( Type => 'MemberOf',
428 Target => 'freeside://freeside/cust_main/'. $self->custnum,
432 if (! $import && $conf->config('welcome_letter') && $self->cust_main->num_pkgs == 1) {
433 my $queue = new FS::queue {
434 'job' => 'FS::cust_main::queueable_print',
436 $error = $queue->insert(
437 'custnum' => $self->custnum,
438 'template' => 'welcome_letter',
442 warn "can't send welcome letter: $error";
447 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
454 This method now works but you probably shouldn't use it.
456 You don't want to delete packages, because there would then be no record
457 the customer ever purchased the package. Instead, see the cancel method and
458 hide cancelled packages.
465 my $oldAutoCommit = $FS::UID::AutoCommit;
466 local $FS::UID::AutoCommit = 0;
469 foreach my $cust_pkg_discount ($self->cust_pkg_discount) {
470 my $error = $cust_pkg_discount->delete;
472 $dbh->rollback if $oldAutoCommit;
476 #cust_bill_pkg_discount?
478 foreach my $cust_pkg_detail ($self->cust_pkg_detail) {
479 my $error = $cust_pkg_detail->delete;
481 $dbh->rollback if $oldAutoCommit;
486 foreach my $cust_pkg_reason (
488 'table' => 'cust_pkg_reason',
489 'hashref' => { 'pkgnum' => $self->pkgnum },
493 my $error = $cust_pkg_reason->delete;
495 $dbh->rollback if $oldAutoCommit;
502 my $error = $self->SUPER::delete(@_);
504 $dbh->rollback if $oldAutoCommit;
508 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
514 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ... ]
516 Replaces the OLD_RECORD with this one in the database. If there is an error,
517 returns the error, otherwise returns false.
519 Currently, custnum, setup, bill, adjourn, susp, expire, and cancel may be changed.
521 Changing pkgpart may have disasterous effects. See the order subroutine.
523 setup and bill are normally updated by calling the bill method of a customer
524 object (see L<FS::cust_main>).
526 suspend is normally updated by the suspend and unsuspend methods.
528 cancel is normally updated by the cancel method (and also the order subroutine
531 Available options are:
537 can be set to a cancellation reason (see L<FS:reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason. The hashref should have the following keys: typenum - Reason type (see L<FS::reason_type>, reason - Text of the new reason.
541 the access_user (see L<FS::access_user>) providing the reason
545 hashref of keys and values - cust_pkg_option records will be created, updated or removed as appopriate
554 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
559 ( ref($_[0]) eq 'HASH' )
563 #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
564 #return "Can't change otaker!" if $old->otaker ne $new->otaker;
567 #return "Can't change setup once it exists!"
568 # if $old->getfield('setup') &&
569 # $old->getfield('setup') != $new->getfield('setup');
571 #some logic for bill, susp, cancel?
573 local($disable_agentcheck) = 1 if $old->pkgpart == $new->pkgpart;
575 my $oldAutoCommit = $FS::UID::AutoCommit;
576 local $FS::UID::AutoCommit = 0;
579 foreach my $method ( qw(adjourn expire) ) { # How many reasons?
580 if ($options->{'reason'} && $new->$method && $old->$method ne $new->$method) {
581 my $error = $new->insert_reason(
582 'reason' => $options->{'reason'},
583 'date' => $new->$method,
585 'reason_otaker' => $options->{'reason_otaker'},
588 dbh->rollback if $oldAutoCommit;
589 return "Error inserting cust_pkg_reason: $error";
594 #save off and freeze RADIUS attributes for any associated svc_acct records
596 if ( $old->part_pkg->is_prepaid || $new->part_pkg->is_prepaid ) {
598 #also check for specific exports?
599 # to avoid spurious modify export events
600 @svc_acct = map { $_->svc_x }
601 grep { $_->part_svc->svcdb eq 'svc_acct' }
604 $_->snapshot foreach @svc_acct;
608 my $error = $new->export_pkg_change($old)
609 || $new->SUPER::replace( $old,
611 ? $options->{options}
615 $dbh->rollback if $oldAutoCommit;
619 #for prepaid packages,
620 #trigger export of new RADIUS Expiration attribute when cust_pkg.bill changes
621 foreach my $old_svc_acct ( @svc_acct ) {
622 my $new_svc_acct = new FS::svc_acct { $old_svc_acct->hash };
624 $new_svc_acct->replace( $old_svc_acct,
625 'depend_jobnum' => $options->{depend_jobnum},
628 $dbh->rollback if $oldAutoCommit;
633 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
640 Checks all fields to make sure this is a valid billing item. If there is an
641 error, returns the error, otherwise returns false. Called by the insert and
649 if ( !$self->locationnum or $self->locationnum == -1 ) {
650 $self->set('locationnum', $self->cust_main->ship_locationnum);
654 $self->ut_numbern('pkgnum')
655 || $self->ut_foreign_key('custnum', 'cust_main', 'custnum')
656 || $self->ut_numbern('pkgpart')
657 || $self->ut_foreign_keyn('contactnum', 'contact', 'contactnum' )
658 || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
659 || $self->ut_foreign_keyn('salesnum', 'sales', 'salesnum')
660 || $self->ut_numbern('quantity')
661 || $self->ut_numbern('start_date')
662 || $self->ut_numbern('setup')
663 || $self->ut_numbern('bill')
664 || $self->ut_numbern('susp')
665 || $self->ut_numbern('cancel')
666 || $self->ut_numbern('adjourn')
667 || $self->ut_numbern('resume')
668 || $self->ut_numbern('expire')
669 || $self->ut_numbern('dundate')
670 || $self->ut_enum('no_auto', [ '', 'Y' ])
671 || $self->ut_enum('waive_setup', [ '', 'Y' ])
672 || $self->ut_textn('agent_pkgid')
673 || $self->ut_enum('recur_show_zero', [ '', 'Y', 'N', ])
674 || $self->ut_enum('setup_show_zero', [ '', 'Y', 'N', ])
675 || $self->ut_foreign_keyn('main_pkgnum', 'cust_pkg', 'pkgnum')
676 || $self->ut_foreign_keyn('pkglinknum', 'part_pkg_link', 'pkglinknum')
677 || $self->ut_foreign_keyn('change_to_pkgnum', 'cust_pkg', 'pkgnum')
679 return $error if $error;
681 return "A package with both start date (future start) and setup date (already started) will never bill"
682 if $self->start_date && $self->setup && ! $upgrade;
684 return "A future unsuspend date can only be set for a package with a suspend date"
685 if $self->resume and !$self->susp and !$self->adjourn;
687 $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
689 if ( $self->dbdef_table->column('manual_flag') ) {
690 $self->manual_flag('') if $self->manual_flag eq ' ';
691 $self->manual_flag =~ /^([01]?)$/
692 or return "Illegal manual_flag ". $self->manual_flag;
693 $self->manual_flag($1);
701 Check the pkgpart to make sure it's allowed with the reg_code and/or
702 promo_code of the package (if present) and with the customer's agent.
703 Called from C<insert>, unless we are doing a package change that doesn't
711 # my $error = $self->ut_numbern('pkgpart'); # already done
714 if ( $self->reg_code ) {
716 unless ( grep { $self->pkgpart == $_->pkgpart }
717 map { $_->reg_code_pkg }
718 qsearchs( 'reg_code', { 'code' => $self->reg_code,
719 'agentnum' => $self->cust_main->agentnum })
721 return "Unknown registration code";
724 } elsif ( $self->promo_code ) {
727 qsearchs('part_pkg', {
728 'pkgpart' => $self->pkgpart,
729 'promo_code' => { op=>'ILIKE', value=>$self->promo_code },
731 return 'Unknown promotional code' unless $promo_part_pkg;
735 unless ( $disable_agentcheck ) {
737 qsearchs( 'agent', { 'agentnum' => $self->cust_main->agentnum } );
738 return "agent ". $agent->agentnum. ':'. $agent->agent.
739 " can't purchase pkgpart ". $self->pkgpart
740 unless $agent->pkgpart_hashref->{ $self->pkgpart }
741 || $agent->agentnum == $self->part_pkg->agentnum;
744 $error = $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart' );
745 return $error if $error;
753 =item cancel [ OPTION => VALUE ... ]
755 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
756 in this package, then cancels the package itself (sets the cancel field to
759 Available options are:
763 =item quiet - can be set true to supress email cancellation notices.
765 =item time - can be set to cancel the package based on a specific future or
766 historical date. Using time ensures that the remaining amount is calculated
767 correctly. Note however that this is an immediate cancel and just changes
768 the date. You are PROBABLY looking to expire the account instead of using
771 =item reason - can be set to a cancellation reason (see L<FS:reason>),
772 either a reasonnum of an existing reason, or passing a hashref will create
773 a new reason. The hashref should have the following keys: typenum - Reason
774 type (see L<FS::reason_type>, reason - Text of the new reason.
776 =item date - can be set to a unix style timestamp to specify when to
779 =item nobill - can be set true to skip billing if it might otherwise be done.
781 =item unused_credit - can be set to 1 to credit the remaining time, or 0 to
782 not credit it. This must be set (by change()) when changing the package
783 to a different pkgpart or location, and probably shouldn't be in any other
784 case. If it's not set, the 'unused_credit_cancel' part_pkg option will
789 If there is an error, returns the error, otherwise returns false.
794 my( $self, %options ) = @_;
797 # pass all suspend/cancel actions to the main package
798 # (unless the pkglinknum has been removed, then the link is defunct and
799 # this package can be canceled on its own)
800 if ( $self->main_pkgnum and $self->pkglinknum and !$options{'from_main'} ) {
801 return $self->main_pkg->cancel(%options);
804 my $conf = new FS::Conf;
806 warn "cust_pkg::cancel called with options".
807 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
810 my $oldAutoCommit = $FS::UID::AutoCommit;
811 local $FS::UID::AutoCommit = 0;
814 my $old = $self->select_for_update;
816 if ( $old->get('cancel') || $self->get('cancel') ) {
817 dbh->rollback if $oldAutoCommit;
818 return ""; # no error
821 # XXX possibly set cancel_time to the expire date?
822 my $cancel_time = $options{'time'} || time;
823 my $date = $options{'date'} if $options{'date'}; # expire/cancel later
824 $date = '' if ($date && $date <= $cancel_time); # complain instead?
826 #race condition: usage could be ongoing until unprovisioned
827 #resolved by performing a change package instead (which unprovisions) and
829 if ( !$options{nobill} && !$date ) {
830 # && $conf->exists('bill_usage_on_cancel') ) { #calc_cancel checks this
831 my $copy = $self->new({$self->hash});
833 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
835 'time' => $cancel_time );
836 warn "Error billing during cancel, custnum ".
837 #$self->cust_main->custnum. ": $error"
842 if ( $options{'reason'} ) {
843 $error = $self->insert_reason( 'reason' => $options{'reason'},
844 'action' => $date ? 'expire' : 'cancel',
845 'date' => $date ? $date : $cancel_time,
846 'reason_otaker' => $options{'reason_otaker'},
849 dbh->rollback if $oldAutoCommit;
850 return "Error inserting cust_pkg_reason: $error";
854 my %svc_cancel_opt = ();
855 $svc_cancel_opt{'date'} = $date if $date;
856 foreach my $cust_svc (
859 sort { $a->[1] <=> $b->[1] }
860 map { [ $_, $_->svc_x ? $_->svc_x->table_info->{'cancel_weight'} : -1 ]; }
861 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
863 my $part_svc = $cust_svc->part_svc;
864 next if ( defined($part_svc) and $part_svc->preserve );
865 my $error = $cust_svc->cancel( %svc_cancel_opt );
868 $dbh->rollback if $oldAutoCommit;
869 return 'Error '. ($svc_cancel_opt{'date'} ? 'expiring' : 'canceling' ).
875 # credit remaining time if appropriate
877 if ( exists($options{'unused_credit'}) ) {
878 $do_credit = $options{'unused_credit'};
881 $do_credit = $self->part_pkg->option('unused_credit_cancel', 1);
884 my $error = $self->credit_remaining('cancel', $cancel_time);
886 $dbh->rollback if $oldAutoCommit;
893 my %hash = $self->hash;
895 $hash{'expire'} = $date;
897 $hash{'cancel'} = $cancel_time;
899 $hash{'change_custnum'} = $options{'change_custnum'};
901 # if this is a supplemental package that's lost its part_pkg_link, and it's
902 # being canceled for real, unlink it completely
903 if ( !$date and ! $self->pkglinknum ) {
904 $hash{main_pkgnum} = '';
907 my $new = new FS::cust_pkg ( \%hash );
908 $error = $new->replace( $self, options => { $self->options } );
909 if ( $self->change_to_pkgnum ) {
910 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
911 $error ||= $change_to->cancel || $change_to->delete;
914 $dbh->rollback if $oldAutoCommit;
918 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
919 $error = $supp_pkg->cancel(%options, 'from_main' => 1);
921 $dbh->rollback if $oldAutoCommit;
922 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
926 foreach my $usage ( $self->cust_pkg_usage ) {
927 $error = $usage->delete;
929 $dbh->rollback if $oldAutoCommit;
930 return "deleting usage pools: $error";
934 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
935 return '' if $date; #no errors
937 my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } $self->cust_main->invoicing_list;
938 if ( !$options{'quiet'} &&
939 $conf->exists('emailcancel', $self->cust_main->agentnum) &&
941 my $msgnum = $conf->config('cancel_msgnum', $self->cust_main->agentnum);
944 my $msg_template = qsearchs('msg_template', { msgnum => $msgnum });
945 $error = $msg_template->send( 'cust_main' => $self->cust_main,
950 'from' => $conf->invoice_from_full( $self->cust_main->agentnum ),
951 'to' => \@invoicing_list,
952 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
953 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
954 'custnum' => $self->custnum,
955 'msgtype' => '', #admin?
958 #should this do something on errors?
965 =item cancel_if_expired [ NOW_TIMESTAMP ]
967 Cancels this package if its expire date has been reached.
971 sub cancel_if_expired {
973 my $time = shift || time;
974 return '' unless $self->expire && $self->expire <= $time;
975 my $error = $self->cancel;
977 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
978 $self->custnum. ": $error";
985 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
986 locationnum, (other fields?). Attempts to re-provision cancelled services
987 using history information (errors at this stage are not fatal).
989 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
991 svc_fatal: service provisioning errors are fatal
993 svc_errors: pass an array reference, will be filled in with any provisioning errors
995 main_pkgnum: link the package as a supplemental package of this one. For
1001 my( $self, %options ) = @_;
1003 #in case you try do do $uncancel-date = $cust_pkg->uncacel
1004 return '' unless $self->get('cancel');
1006 if ( $self->main_pkgnum and !$options{'main_pkgnum'} ) {
1007 return $self->main_pkg->uncancel(%options);
1014 my $oldAutoCommit = $FS::UID::AutoCommit;
1015 local $FS::UID::AutoCommit = 0;
1019 # insert the new package
1022 my $cust_pkg = new FS::cust_pkg {
1023 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
1024 bill => ( $options{'bill'} || $self->get('bill') ),
1026 uncancel_pkgnum => $self->pkgnum,
1027 main_pkgnum => ($options{'main_pkgnum'} || ''),
1028 map { $_ => $self->get($_) } qw(
1029 custnum pkgpart locationnum
1031 susp adjourn resume expire start_date contract_end dundate
1032 change_date change_pkgpart change_locationnum
1033 manual_flag no_auto quantity agent_pkgid recur_show_zero setup_show_zero
1037 my $error = $cust_pkg->insert(
1038 'change' => 1, #supresses any referral credit to a referring customer
1039 'allow_pkgpart' => 1, # allow this even if the package def is disabled
1042 $dbh->rollback if $oldAutoCommit;
1050 #find historical services within this timeframe before the package cancel
1051 # (incompatible with "time" option to cust_pkg->cancel?)
1052 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
1053 # too little? (unprovisioing export delay?)
1054 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
1055 my @h_cust_svc = $self->h_cust_svc( $end, $start );
1058 foreach my $h_cust_svc (@h_cust_svc) {
1059 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
1060 #next unless $h_svc_x; #should this happen?
1061 (my $table = $h_svc_x->table) =~ s/^h_//;
1062 require "FS/$table.pm";
1063 my $class = "FS::$table";
1064 my $svc_x = $class->new( {
1065 'pkgnum' => $cust_pkg->pkgnum,
1066 'svcpart' => $h_cust_svc->svcpart,
1067 map { $_ => $h_svc_x->get($_) } fields($table)
1071 if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
1072 $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
1075 my $svc_error = $svc_x->insert;
1077 if ( $options{svc_fatal} ) {
1078 $dbh->rollback if $oldAutoCommit;
1081 # if we've failed to insert the svc_x object, svc_Common->insert
1082 # will have removed the cust_svc already. if not, then both records
1083 # were inserted but we failed for some other reason (export, most
1084 # likely). in that case, report the error and delete the records.
1085 push @svc_errors, $svc_error;
1086 my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1088 # except if export_insert failed, export_delete probably won't be
1090 local $FS::svc_Common::noexport_hack = 1;
1091 my $cleanup_error = $svc_x->delete; # also deletes cust_svc
1092 if ( $cleanup_error ) { # and if THAT fails, then run away
1093 $dbh->rollback if $oldAutoCommit;
1094 return $cleanup_error;
1099 } #foreach $h_cust_svc
1101 #these are pretty rare, but should handle them
1102 # - dsl_device (mac addresses)
1103 # - phone_device (mac addresses)
1104 # - dsl_note (ikano notes)
1105 # - domain_record (i.e. restore DNS information w/domains)
1106 # - inventory_item(?) (inventory w/un-cancelling service?)
1107 # - nas (svc_broaband nas stuff)
1108 #this stuff is unused in the wild afaik
1109 # - mailinglistmember
1111 # - svc_domain.parent_svcnum?
1112 # - acct_snarf (ancient mail fetching config)
1113 # - cgp_rule (communigate)
1114 # - cust_svc_option (used by our Tron stuff)
1115 # - acct_rt_transaction (used by our time worked stuff)
1118 # also move over any services that didn't unprovision at cancellation
1121 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1122 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1123 my $error = $cust_svc->replace;
1125 $dbh->rollback if $oldAutoCommit;
1131 # Uncancel any supplemental packages, and make them supplemental to the
1135 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1137 $error = $supp_pkg->uncancel(%options, 'main_pkgnum' => $cust_pkg->pkgnum);
1139 $dbh->rollback if $oldAutoCommit;
1140 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1148 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1150 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1151 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1158 Cancels any pending expiration (sets the expire field to null).
1160 If there is an error, returns the error, otherwise returns false.
1165 my( $self, %options ) = @_;
1168 my $oldAutoCommit = $FS::UID::AutoCommit;
1169 local $FS::UID::AutoCommit = 0;
1172 my $old = $self->select_for_update;
1174 my $pkgnum = $old->pkgnum;
1175 if ( $old->get('cancel') || $self->get('cancel') ) {
1176 dbh->rollback if $oldAutoCommit;
1177 return "Can't unexpire cancelled package $pkgnum";
1178 # or at least it's pointless
1181 unless ( $old->get('expire') && $self->get('expire') ) {
1182 dbh->rollback if $oldAutoCommit;
1183 return ""; # no error
1186 my %hash = $self->hash;
1187 $hash{'expire'} = '';
1188 my $new = new FS::cust_pkg ( \%hash );
1189 $error = $new->replace( $self, options => { $self->options } );
1191 $dbh->rollback if $oldAutoCommit;
1195 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1201 =item suspend [ OPTION => VALUE ... ]
1203 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1204 package, then suspends the package itself (sets the susp field to now).
1206 Available options are:
1210 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1211 either a reasonnum of an existing reason, or passing a hashref will create
1212 a new reason. The hashref should have the following keys:
1213 - typenum - Reason type (see L<FS::reason_type>
1214 - reason - Text of the new reason.
1216 =item date - can be set to a unix style timestamp to specify when to
1219 =item time - can be set to override the current time, for calculation
1220 of final invoices or unused-time credits
1222 =item resume_date - can be set to a time when the package should be
1223 unsuspended. This may be more convenient than calling C<unsuspend()>
1226 =item from_main - allows a supplemental package to be suspended, rather
1227 than redirecting the method call to its main package. For internal use.
1231 If there is an error, returns the error, otherwise returns false.
1236 my( $self, %options ) = @_;
1239 # pass all suspend/cancel actions to the main package
1240 if ( $self->main_pkgnum and !$options{'from_main'} ) {
1241 return $self->main_pkg->suspend(%options);
1244 my $oldAutoCommit = $FS::UID::AutoCommit;
1245 local $FS::UID::AutoCommit = 0;
1248 my $old = $self->select_for_update;
1250 my $pkgnum = $old->pkgnum;
1251 if ( $old->get('cancel') || $self->get('cancel') ) {
1252 dbh->rollback if $oldAutoCommit;
1253 return "Can't suspend cancelled package $pkgnum";
1256 if ( $old->get('susp') || $self->get('susp') ) {
1257 dbh->rollback if $oldAutoCommit;
1258 return ""; # no error # complain on adjourn?
1261 my $suspend_time = $options{'time'} || time;
1262 my $date = $options{date} if $options{date}; # adjourn/suspend later
1263 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1265 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1266 dbh->rollback if $oldAutoCommit;
1267 return "Package $pkgnum expires before it would be suspended.";
1270 # some false laziness with sub cancel
1271 if ( !$options{nobill} && !$date &&
1272 $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1273 # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1274 # make the entire cust_main->bill path recognize 'suspend' and
1275 # 'cancel' separately.
1276 warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1277 my $copy = $self->new({$self->hash});
1279 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1281 'time' => $suspend_time );
1282 warn "Error billing during suspend, custnum ".
1283 #$self->cust_main->custnum. ": $error"
1288 if ( $options{'reason'} ) {
1289 $error = $self->insert_reason( 'reason' => $options{'reason'},
1290 'action' => $date ? 'adjourn' : 'suspend',
1291 'date' => $date ? $date : $suspend_time,
1292 'reason_otaker' => $options{'reason_otaker'},
1295 dbh->rollback if $oldAutoCommit;
1296 return "Error inserting cust_pkg_reason: $error";
1300 # if a reasonnum was passed, get the actual reason object so we can check
1302 # (passing a reason hashref is still allowed, but it can't be used with
1303 # the fancy behavioral options.)
1306 if ($options{'reason'} =~ /^\d+$/) {
1307 $reason = FS::reason->by_key($options{'reason'});
1310 my %hash = $self->hash;
1312 $hash{'adjourn'} = $date;
1314 $hash{'susp'} = $suspend_time;
1317 my $resume_date = $options{'resume_date'} || 0;
1318 if ( $resume_date > ($date || $suspend_time) ) {
1319 $hash{'resume'} = $resume_date;
1322 $options{options} ||= {};
1324 my $new = new FS::cust_pkg ( \%hash );
1325 $error = $new->replace( $self, options => { $self->options,
1326 %{ $options{options} },
1330 $dbh->rollback if $oldAutoCommit;
1334 unless ( $date ) { # then we are suspending now
1336 # credit remaining time if appropriate
1337 # (if required by the package def, or the suspend reason)
1338 my $unused_credit = $self->part_pkg->option('unused_credit_suspend',1)
1339 || ( defined($reason) && $reason->unused_credit );
1341 if ( $unused_credit ) {
1342 warn "crediting unused time on pkg#".$self->pkgnum."\n" if $DEBUG;
1343 my $error = $self->credit_remaining('suspend', $suspend_time);
1345 $dbh->rollback if $oldAutoCommit;
1352 foreach my $cust_svc (
1353 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1355 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1357 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1358 $dbh->rollback if $oldAutoCommit;
1359 return "Illegal svcdb value in part_svc!";
1362 require "FS/$svcdb.pm";
1364 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1366 $error = $svc->suspend;
1368 $dbh->rollback if $oldAutoCommit;
1371 my( $label, $value ) = $cust_svc->label;
1372 push @labels, "$label: $value";
1376 my $conf = new FS::Conf;
1377 if ( $conf->config('suspend_email_admin') ) {
1379 my $error = send_email(
1380 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1381 #invoice_from ??? well as good as any
1382 'to' => $conf->config('suspend_email_admin'),
1383 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1385 "This is an automatic message from your Freeside installation\n",
1386 "informing you that the following customer package has been suspended:\n",
1388 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1389 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1390 ( map { "Service : $_\n" } @labels ),
1392 'custnum' => $self->custnum,
1393 'msgtype' => 'admin'
1397 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1405 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1406 $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1408 $dbh->rollback if $oldAutoCommit;
1409 return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1413 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1418 =item credit_remaining MODE TIME
1420 Generate a credit for this package for the time remaining in the current
1421 billing period. MODE is either "suspend" or "cancel" (determines the
1422 credit type). TIME is the time of suspension/cancellation. Both arguments
1427 # Implementation note:
1429 # If you pkgpart-change a package that has been billed, and it's set to give
1430 # credit on package change, then this method gets called and then the new
1431 # package will have no last_bill date. Therefore the customer will be credited
1432 # only once (per billing period) even if there are multiple package changes.
1434 # If you location-change a package that has been billed, this method will NOT
1435 # be called and the new package WILL have the last bill date of the old
1438 # If the new package is then canceled within the same billing cycle,
1439 # credit_remaining needs to run calc_remain on the OLD package to determine
1440 # the amount of unused time to credit.
1442 sub credit_remaining {
1443 # Add a credit for remaining service
1444 my ($self, $mode, $time) = @_;
1445 die 'credit_remaining requires suspend or cancel'
1446 unless $mode eq 'suspend' or $mode eq 'cancel';
1447 die 'no suspend/cancel time' unless $time > 0;
1449 my $conf = FS::Conf->new;
1450 my $reason_type = $conf->config($mode.'_credit_type');
1452 my $last_bill = $self->getfield('last_bill') || 0;
1453 my $next_bill = $self->getfield('bill') || 0;
1454 if ( $last_bill > 0 # the package has been billed
1455 and $next_bill > 0 # the package has a next bill date
1456 and $next_bill >= $time # which is in the future
1458 my @cust_credit_source_bill_pkg = ();
1459 my $remaining_value = 0;
1461 my $remain_pkg = $self;
1462 $remaining_value = $remain_pkg->calc_remain(
1464 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1467 # we may have to walk back past some package changes to get to the
1468 # one that actually has unused time
1469 while ( $remaining_value == 0 ) {
1470 if ( $remain_pkg->change_pkgnum ) {
1471 $remain_pkg = FS::cust_pkg->by_key($remain_pkg->change_pkgnum);
1473 # the package has really never been billed
1476 $remaining_value = $remain_pkg->calc_remain(
1478 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1482 if ( $remaining_value > 0 ) {
1483 warn "Crediting for $remaining_value on package ".$self->pkgnum."\n"
1485 my $error = $self->cust_main->credit(
1487 'Credit for unused time on '. $self->part_pkg->pkg,
1488 'reason_type' => $reason_type,
1489 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1491 return "Error crediting customer \$$remaining_value for unused time".
1492 " on ". $self->part_pkg->pkg. ": $error"
1494 } #if $remaining_value
1495 } #if $last_bill, etc.
1499 =item unsuspend [ OPTION => VALUE ... ]
1501 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1502 package, then unsuspends the package itself (clears the susp field and the
1503 adjourn field if it is in the past). If the suspend reason includes an
1504 unsuspension package, that package will be ordered.
1506 Available options are:
1512 Can be set to a date to unsuspend the package in the future (the 'resume'
1515 =item adjust_next_bill
1517 Can be set true to adjust the next bill date forward by
1518 the amount of time the account was inactive. This was set true by default
1519 in the past (from 1.4.2 and 1.5.0pre6 through 1.7.0), but now needs to be
1520 explicitly requested with this option or in the price plan.
1524 If there is an error, returns the error, otherwise returns false.
1529 my( $self, %opt ) = @_;
1532 # pass all suspend/cancel actions to the main package
1533 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1534 return $self->main_pkg->unsuspend(%opt);
1537 my $oldAutoCommit = $FS::UID::AutoCommit;
1538 local $FS::UID::AutoCommit = 0;
1541 my $old = $self->select_for_update;
1543 my $pkgnum = $old->pkgnum;
1544 if ( $old->get('cancel') || $self->get('cancel') ) {
1545 $dbh->rollback if $oldAutoCommit;
1546 return "Can't unsuspend cancelled package $pkgnum";
1549 unless ( $old->get('susp') && $self->get('susp') ) {
1550 $dbh->rollback if $oldAutoCommit;
1551 return ""; # no error # complain instead?
1554 # handle the case of setting a future unsuspend (resume) date
1555 # and do not continue to actually unsuspend the package
1556 my $date = $opt{'date'};
1557 if ( $date and $date > time ) { # return an error if $date <= time?
1559 if ( $old->get('expire') && $old->get('expire') < $date ) {
1560 $dbh->rollback if $oldAutoCommit;
1561 return "Package $pkgnum expires before it would be unsuspended.";
1564 my $new = new FS::cust_pkg { $self->hash };
1565 $new->set('resume', $date);
1566 $error = $new->replace($self, options => $self->options);
1569 $dbh->rollback if $oldAutoCommit;
1573 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1579 if (!$self->setup) {
1580 # then this package is being released from on-hold status
1581 $self->set_initial_timers;
1586 foreach my $cust_svc (
1587 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1589 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1591 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1592 $dbh->rollback if $oldAutoCommit;
1593 return "Illegal svcdb value in part_svc!";
1596 require "FS/$svcdb.pm";
1598 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1600 $error = $svc->unsuspend;
1602 $dbh->rollback if $oldAutoCommit;
1605 my( $label, $value ) = $cust_svc->label;
1606 push @labels, "$label: $value";
1611 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1612 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1614 my %hash = $self->hash;
1615 my $inactive = time - $hash{'susp'};
1617 my $conf = new FS::Conf;
1619 #adjust the next bill date forward
1620 # increment next bill date if certain conditions are met:
1621 # - it was due to be billed at some point
1622 # - either the global or local config says to do this
1623 my $adjust_bill = 0;
1626 && ( $hash{'bill'} || $hash{'setup'} )
1627 && ( $opt{'adjust_next_bill'}
1628 || $conf->exists('unsuspend-always_adjust_next_bill_date')
1629 || $self->part_pkg->option('unsuspend_adjust_bill', 1)
1636 # - the package billed during suspension
1637 # - or it was ordered on hold
1638 # - or the customer was credited for the unused time
1640 if ( $self->option('suspend_bill',1)
1641 or ( $self->part_pkg->option('suspend_bill',1)
1642 and ! $self->option('no_suspend_bill',1)
1644 or $hash{'order_date'} == $hash{'susp'}
1645 or $self->part_pkg->option('unused_credit_suspend')
1646 or ( defined($reason) and $reason->unused_credit )
1651 # then add the length of time suspended to the bill date
1652 if ( $adjust_bill ) {
1653 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive
1657 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1658 $hash{'resume'} = '' if !$hash{'adjourn'};
1659 my $new = new FS::cust_pkg ( \%hash );
1660 $error = $new->replace( $self, options => { $self->options } );
1662 $dbh->rollback if $oldAutoCommit;
1668 if ( $reason && $reason->unsuspend_pkgpart ) {
1669 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
1670 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
1672 my $start_date = $self->cust_main->next_bill_date
1673 if $reason->unsuspend_hold;
1676 $unsusp_pkg = FS::cust_pkg->new({
1677 'custnum' => $self->custnum,
1678 'pkgpart' => $reason->unsuspend_pkgpart,
1679 'start_date' => $start_date,
1680 'locationnum' => $self->locationnum,
1681 # discount? probably not...
1684 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
1688 $dbh->rollback if $oldAutoCommit;
1693 if ( $conf->config('unsuspend_email_admin') ) {
1695 my $error = send_email(
1696 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1697 #invoice_from ??? well as good as any
1698 'to' => $conf->config('unsuspend_email_admin'),
1699 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
1700 "This is an automatic message from your Freeside installation\n",
1701 "informing you that the following customer package has been unsuspended:\n",
1703 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1704 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1705 ( map { "Service : $_\n" } @labels ),
1707 "An unsuspension fee was charged: ".
1708 $unsusp_pkg->part_pkg->pkg_comment."\n"
1712 'custnum' => $self->custnum,
1713 'msgtype' => 'admin',
1717 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
1723 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1724 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
1726 $dbh->rollback if $oldAutoCommit;
1727 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1731 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1738 Cancels any pending suspension (sets the adjourn field to null).
1740 If there is an error, returns the error, otherwise returns false.
1745 my( $self, %options ) = @_;
1748 my $oldAutoCommit = $FS::UID::AutoCommit;
1749 local $FS::UID::AutoCommit = 0;
1752 my $old = $self->select_for_update;
1754 my $pkgnum = $old->pkgnum;
1755 if ( $old->get('cancel') || $self->get('cancel') ) {
1756 dbh->rollback if $oldAutoCommit;
1757 return "Can't unadjourn cancelled package $pkgnum";
1758 # or at least it's pointless
1761 if ( $old->get('susp') || $self->get('susp') ) {
1762 dbh->rollback if $oldAutoCommit;
1763 return "Can't unadjourn suspended package $pkgnum";
1764 # perhaps this is arbitrary
1767 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1768 dbh->rollback if $oldAutoCommit;
1769 return ""; # no error
1772 my %hash = $self->hash;
1773 $hash{'adjourn'} = '';
1774 $hash{'resume'} = '';
1775 my $new = new FS::cust_pkg ( \%hash );
1776 $error = $new->replace( $self, options => { $self->options } );
1778 $dbh->rollback if $oldAutoCommit;
1782 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1789 =item change HASHREF | OPTION => VALUE ...
1791 Changes this package: cancels it and creates a new one, with a different
1792 pkgpart or locationnum or both. All services are transferred to the new
1793 package (no change will be made if this is not possible).
1795 Options may be passed as a list of key/value pairs or as a hash reference.
1802 New locationnum, to change the location for this package.
1806 New FS::cust_location object, to create a new location and assign it
1811 New FS::cust_main object, to create a new customer and assign the new package
1816 New pkgpart (see L<FS::part_pkg>).
1820 New refnum (see L<FS::part_referral>).
1824 New quantity; if unspecified, the new package will have the same quantity
1829 "New" (existing) FS::cust_pkg object. The package's services and other
1830 attributes will be transferred to this package.
1834 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1835 susp, adjourn, cancel, expire, and contract_end) to the new package.
1837 =item unprotect_svcs
1839 Normally, change() will rollback and return an error if some services
1840 can't be transferred (also see the I<cust_pkg-change_svcpart> config option).
1841 If unprotect_svcs is true, this method will transfer as many services as
1842 it can and then unconditionally cancel the old package.
1846 At least one of locationnum, cust_location, pkgpart, refnum, cust_main, or
1847 cust_pkg must be specified (otherwise, what's the point?)
1849 Returns either the new FS::cust_pkg object or a scalar error.
1853 my $err_or_new_cust_pkg = $old_cust_pkg->change
1857 #some false laziness w/order
1860 my $opt = ref($_[0]) ? shift : { @_ };
1862 my $conf = new FS::Conf;
1864 # Transactionize this whole mess
1865 my $oldAutoCommit = $FS::UID::AutoCommit;
1866 local $FS::UID::AutoCommit = 0;
1875 $hash{'setup'} = $time if $self->setup;
1877 $hash{'change_date'} = $time;
1878 $hash{"change_$_"} = $self->$_()
1879 foreach qw( pkgnum pkgpart locationnum );
1881 if ( $opt->{'cust_location'} ) {
1882 $error = $opt->{'cust_location'}->find_or_insert;
1884 $dbh->rollback if $oldAutoCommit;
1885 return "creating location record: $error";
1887 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1890 if ( $opt->{'cust_pkg'} ) {
1891 # treat changing to a package with a different pkgpart as a
1892 # pkgpart change (because it is)
1893 $opt->{'pkgpart'} = $opt->{'cust_pkg'}->pkgpart;
1896 # whether to override pkgpart checking on the new package
1897 my $same_pkgpart = 1;
1898 if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
1902 my $unused_credit = 0;
1903 my $keep_dates = $opt->{'keep_dates'};
1904 # Special case. If the pkgpart is changing, and the customer is
1905 # going to be credited for remaining time, don't keep setup, bill,
1906 # or last_bill dates, and DO pass the flag to cancel() to credit
1908 if ( $opt->{'pkgpart'}
1909 and $opt->{'pkgpart'} != $self->pkgpart
1910 and $self->part_pkg->option('unused_credit_change', 1) ) {
1913 $hash{$_} = '' foreach qw(setup bill last_bill);
1916 if ( $keep_dates ) {
1917 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1918 resume start_date contract_end ) ) {
1919 $hash{$date} = $self->getfield($date);
1922 # always keep this date, regardless of anything
1923 # (the date of the package change is in a different field)
1924 $hash{'order_date'} = $self->getfield('order_date');
1926 # allow $opt->{'locationnum'} = '' to specifically set it to null
1927 # (i.e. customer default location)
1928 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
1930 # usually this doesn't matter. the two cases where it does are:
1931 # 1. unused_credit_change + pkgpart change + setup fee on the new package
1933 # 2. (more importantly) changing a package before it's billed
1934 $hash{'waive_setup'} = $self->waive_setup;
1936 my $custnum = $self->custnum;
1937 if ( $opt->{cust_main} ) {
1938 my $cust_main = $opt->{cust_main};
1939 unless ( $cust_main->custnum ) {
1940 my $error = $cust_main->insert( @{ $opt->{cust_main_insert_args}||[] } );
1942 $dbh->rollback if $oldAutoCommit;
1943 return "inserting customer record: $error";
1946 $custnum = $cust_main->custnum;
1949 $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
1952 if ( $opt->{'cust_pkg'} ) {
1953 # The target package already exists; update it to show that it was
1954 # changed from this package.
1955 $cust_pkg = $opt->{'cust_pkg'};
1957 foreach ( qw( pkgnum pkgpart locationnum ) ) {
1958 $cust_pkg->set("change_$_", $self->get($_));
1960 $cust_pkg->set('change_date', $time);
1961 $error = $cust_pkg->replace;
1964 # Create the new package.
1965 $cust_pkg = new FS::cust_pkg {
1966 custnum => $custnum,
1967 locationnum => $opt->{'locationnum'},
1968 ( map { $_ => ( $opt->{$_} || $self->$_() ) }
1969 qw( pkgpart quantity refnum salesnum )
1973 $error = $cust_pkg->insert( 'change' => 1,
1974 'allow_pkgpart' => $same_pkgpart );
1977 $dbh->rollback if $oldAutoCommit;
1978 return "inserting new package: $error";
1981 # Transfer services and cancel old package.
1983 $error = $self->transfer($cust_pkg);
1984 if ($error and $error == 0) {
1985 # $old_pkg->transfer failed.
1986 $dbh->rollback if $oldAutoCommit;
1987 return "transferring $error";
1990 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
1991 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
1992 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
1993 if ($error and $error == 0) {
1994 # $old_pkg->transfer failed.
1995 $dbh->rollback if $oldAutoCommit;
1996 return "converting $error";
2000 # We set unprotect_svcs when executing a "future package change". It's
2001 # not a user-interactive operation, so returning an error means the
2002 # package change will just fail. Rather than have that happen, we'll
2003 # let leftover services be deleted.
2004 if ($error > 0 and !$opt->{'unprotect_svcs'}) {
2005 # Transfers were successful, but we still had services left on the old
2006 # package. We can't change the package under this circumstances, so abort.
2007 $dbh->rollback if $oldAutoCommit;
2008 return "unable to transfer all services";
2011 #reset usage if changing pkgpart
2012 # AND usage rollover is off (otherwise adds twice, now and at package bill)
2013 if ($self->pkgpart != $cust_pkg->pkgpart) {
2014 my $part_pkg = $cust_pkg->part_pkg;
2015 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
2019 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
2022 $dbh->rollback if $oldAutoCommit;
2023 return "setting usage values: $error";
2026 # if NOT changing pkgpart, transfer any usage pools over
2027 foreach my $usage ($self->cust_pkg_usage) {
2028 $usage->set('pkgnum', $cust_pkg->pkgnum);
2029 $error = $usage->replace;
2031 $dbh->rollback if $oldAutoCommit;
2032 return "transferring usage pools: $error";
2037 # transfer usage pricing add-ons, if we're not changing pkgpart
2038 if ( $same_pkgpart ) {
2039 foreach my $old_cust_pkg_usageprice ($self->cust_pkg_usageprice) {
2040 my $new_cust_pkg_usageprice = new FS::cust_pkg_usageprice {
2041 'pkgnum' => $cust_pkg->pkgnum,
2042 'usagepricepart' => $old_cust_pkg_usageprice->usagepricepart,
2043 'quantity' => $old_cust_pkg_usageprice->quantity,
2045 $error = $new_cust_pkg_usageprice->insert;
2047 $dbh->rollback if $oldAutoCommit;
2048 return "Error transferring usage pricing add-on: $error";
2053 # transfer discounts, if we're not changing pkgpart
2054 if ( $same_pkgpart ) {
2055 foreach my $old_discount ($self->cust_pkg_discount_active) {
2056 # don't remove the old discount, we may still need to bill that package.
2057 my $new_discount = new FS::cust_pkg_discount {
2058 'pkgnum' => $cust_pkg->pkgnum,
2059 'discountnum' => $old_discount->discountnum,
2060 'months_used' => $old_discount->months_used,
2062 $error = $new_discount->insert;
2064 $dbh->rollback if $oldAutoCommit;
2065 return "transferring discounts: $error";
2070 # transfer (copy) invoice details
2071 foreach my $detail ($self->cust_pkg_detail) {
2072 my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
2073 $new_detail->set('pkgdetailnum', '');
2074 $new_detail->set('pkgnum', $cust_pkg->pkgnum);
2075 $error = $new_detail->insert;
2077 $dbh->rollback if $oldAutoCommit;
2078 return "transferring package notes: $error";
2084 if ( !$opt->{'cust_pkg'} ) {
2085 # Order any supplemental packages.
2086 my $part_pkg = $cust_pkg->part_pkg;
2087 my @old_supp_pkgs = $self->supplemental_pkgs;
2088 foreach my $link ($part_pkg->supp_part_pkg_link) {
2090 foreach (@old_supp_pkgs) {
2091 if ($_->pkgpart == $link->dst_pkgpart) {
2093 $_->pkgpart(0); # so that it can't match more than once
2097 # false laziness with FS::cust_main::Packages::order_pkg
2098 my $new = FS::cust_pkg->new({
2099 pkgpart => $link->dst_pkgpart,
2100 pkglinknum => $link->pkglinknum,
2101 custnum => $custnum,
2102 main_pkgnum => $cust_pkg->pkgnum,
2103 locationnum => $cust_pkg->locationnum,
2104 start_date => $cust_pkg->start_date,
2105 order_date => $cust_pkg->order_date,
2106 expire => $cust_pkg->expire,
2107 adjourn => $cust_pkg->adjourn,
2108 contract_end => $cust_pkg->contract_end,
2109 refnum => $cust_pkg->refnum,
2110 discountnum => $cust_pkg->discountnum,
2111 waive_setup => $cust_pkg->waive_setup,
2113 if ( $old and $opt->{'keep_dates'} ) {
2114 foreach (qw(setup bill last_bill)) {
2115 $new->set($_, $old->get($_));
2118 $error = $new->insert( allow_pkgpart => $same_pkgpart );
2121 $error ||= $old->transfer($new);
2123 if ( $error and $error > 0 ) {
2124 # no reason why this should ever fail, but still...
2125 $error = "Unable to transfer all services from supplemental package ".
2129 $dbh->rollback if $oldAutoCommit;
2132 push @new_supp_pkgs, $new;
2134 } # if !$opt->{'cust_pkg'}
2135 # because if there is one, then supplemental packages would already
2136 # have been created for it.
2138 #Good to go, cancel old package. Notify 'cancel' of whether to credit
2140 #Don't allow billing the package (preceding period packages and/or
2141 #outstanding usage) if we are keeping dates (i.e. location changing),
2142 #because the new package will be billed for the same date range.
2143 #Supplemental packages are also canceled here.
2145 # during scheduled changes, avoid canceling the package we just
2147 $self->set('change_to_pkgnum' => '');
2149 $error = $self->cancel(
2151 unused_credit => $unused_credit,
2152 nobill => $keep_dates,
2153 change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2156 $dbh->rollback if $oldAutoCommit;
2157 return "canceling old package: $error";
2160 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2162 my $error = $cust_pkg->cust_main->bill(
2163 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2166 $dbh->rollback if $oldAutoCommit;
2167 return "billing new package: $error";
2171 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2177 =item change_later OPTION => VALUE...
2179 Schedule a package change for a later date. This actually orders the new
2180 package immediately, but sets its start date for a future date, and sets
2181 the current package to expire on the same date.
2183 If the package is already scheduled for a change, this can be called with
2184 'start_date' to change the scheduled date, or with pkgpart and/or
2185 locationnum to modify the package change. To cancel the scheduled change
2186 entirely, see C<abort_change>.
2194 The date for the package change. Required, and must be in the future.
2202 The pkgpart. locationnum, and quantity of the new package, with the same
2203 meaning as in C<change>.
2211 my $opt = ref($_[0]) ? shift : { @_ };
2213 my $oldAutoCommit = $FS::UID::AutoCommit;
2214 local $FS::UID::AutoCommit = 0;
2217 my $cust_main = $self->cust_main;
2219 my $date = delete $opt->{'start_date'} or return 'start_date required';
2221 if ( $date <= time ) {
2222 $dbh->rollback if $oldAutoCommit;
2223 return "start_date $date is in the past";
2228 if ( $self->change_to_pkgnum ) {
2229 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
2230 my $new_pkgpart = $opt->{'pkgpart'}
2231 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $change_to->pkgpart;
2232 my $new_locationnum = $opt->{'locationnum'}
2233 if $opt->{'locationnum'} and $opt->{'locationnum'} != $change_to->locationnum;
2234 my $new_quantity = $opt->{'quantity'}
2235 if $opt->{'quantity'} and $opt->{'quantity'} != $change_to->quantity;
2236 if ( $new_pkgpart or $new_locationnum or $new_quantity ) {
2237 # it hasn't been billed yet, so in principle we could just edit
2238 # it in place (w/o a package change), but that's bad form.
2239 # So change the package according to the new options...
2240 my $err_or_pkg = $change_to->change(%$opt);
2241 if ( ref $err_or_pkg ) {
2242 # Then set that package up for a future start.
2243 $self->set('change_to_pkgnum', $err_or_pkg->pkgnum);
2244 $self->set('expire', $date); # in case it's different
2245 $err_or_pkg->set('start_date', $date);
2246 $err_or_pkg->set('change_date', '');
2247 $err_or_pkg->set('change_pkgnum', '');
2249 $error = $self->replace ||
2250 $err_or_pkg->replace ||
2251 $change_to->cancel ||
2254 $error = $err_or_pkg;
2256 } else { # change the start date only.
2257 $self->set('expire', $date);
2258 $change_to->set('start_date', $date);
2259 $error = $self->replace || $change_to->replace;
2262 $dbh->rollback if $oldAutoCommit;
2265 $dbh->commit if $oldAutoCommit;
2268 } # if $self->change_to_pkgnum
2270 my $new_pkgpart = $opt->{'pkgpart'}
2271 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2272 my $new_locationnum = $opt->{'locationnum'}
2273 if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2274 my $new_quantity = $opt->{'quantity'}
2275 if $opt->{'quantity'} and $opt->{'quantity'} != $self->quantity;
2277 return '' unless $new_pkgpart or $new_locationnum or $new_quantity; # wouldn't do anything
2279 # allow $opt->{'locationnum'} = '' to specifically set it to null
2280 # (i.e. customer default location)
2281 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2283 my $new = FS::cust_pkg->new( {
2284 custnum => $self->custnum,
2285 locationnum => $opt->{'locationnum'},
2286 start_date => $date,
2287 map { $_ => ( $opt->{$_} || $self->$_() ) }
2288 qw( pkgpart quantity refnum salesnum )
2290 $error = $new->insert('change' => 1,
2291 'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2293 $self->set('change_to_pkgnum', $new->pkgnum);
2294 $self->set('expire', $date);
2295 $error = $self->replace;
2298 $dbh->rollback if $oldAutoCommit;
2300 $dbh->commit if $oldAutoCommit;
2308 Cancels a future package change scheduled by C<change_later>.
2314 my $pkgnum = $self->change_to_pkgnum;
2315 my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
2318 $error = $change_to->cancel || $change_to->delete;
2319 return $error if $error;
2321 $self->set('change_to_pkgnum', '');
2322 $self->set('expire', '');
2326 =item set_quantity QUANTITY
2328 Change the package's quantity field. This is one of the few package properties
2329 that can safely be changed without canceling and reordering the package
2330 (because it doesn't affect tax eligibility). Returns an error or an
2337 $self = $self->replace_old; # just to make sure
2338 $self->quantity(shift);
2342 =item set_salesnum SALESNUM
2344 Change the package's salesnum (sales person) field. This is one of the few
2345 package properties that can safely be changed without canceling and reordering
2346 the package (because it doesn't affect tax eligibility). Returns an error or
2353 $self = $self->replace_old; # just to make sure
2354 $self->salesnum(shift);
2356 # XXX this should probably reassign any credit that's already been given
2359 =item modify_charge OPTIONS
2361 Change the properties of a one-time charge. The following properties can
2362 be changed this way:
2363 - pkg: the package description
2364 - classnum: the package class
2365 - additional: arrayref of additional invoice details to add to this package
2367 and, I<if the charge has not yet been billed>:
2368 - start_date: the date when it will be billed
2369 - amount: the setup fee to be charged
2370 - quantity: the multiplier for the setup fee
2372 If you pass 'adjust_commission' => 1, and the classnum changes, and there are
2373 commission credits linked to this charge, they will be recalculated.
2380 my $part_pkg = $self->part_pkg;
2381 my $pkgnum = $self->pkgnum;
2384 my $oldAutoCommit = $FS::UID::AutoCommit;
2385 local $FS::UID::AutoCommit = 0;
2387 return "Can't use modify_charge except on one-time charges"
2388 unless $part_pkg->freq eq '0';
2390 if ( length($opt{'pkg'}) and $part_pkg->pkg ne $opt{'pkg'} ) {
2391 $part_pkg->set('pkg', $opt{'pkg'});
2394 my %pkg_opt = $part_pkg->options;
2395 my $pkg_opt_modified = 0;
2397 $opt{'additional'} ||= [];
2400 foreach (grep /^additional/, keys %pkg_opt) {
2401 ($i) = ($_ =~ /^additional_info(\d+)$/);
2402 $old_additional[$i] = $pkg_opt{$_} if $i;
2403 delete $pkg_opt{$_};
2406 for ( $i = 0; exists($opt{'additional'}->[$i]); $i++ ) {
2407 $pkg_opt{ "additional_info$i" } = $opt{'additional'}->[$i];
2408 if (!exists($old_additional[$i])
2409 or $old_additional[$i] ne $opt{'additional'}->[$i])
2411 $pkg_opt_modified = 1;
2414 $pkg_opt_modified = 1 if (scalar(@old_additional) - 1) != $i;
2415 $pkg_opt{'additional_count'} = $i if $i > 0;
2418 if ( exists($opt{'classnum'}) and $part_pkg->classnum ne $opt{'classnum'} )
2421 $old_classnum = $part_pkg->classnum;
2422 $part_pkg->set('classnum', $opt{'classnum'});
2425 if ( !$self->get('setup') ) {
2426 # not yet billed, so allow amount, setup_cost, quantity and start_date
2428 if ( exists($opt{'amount'})
2429 and $part_pkg->option('setup_fee') != $opt{'amount'}
2430 and $opt{'amount'} > 0 ) {
2432 $pkg_opt{'setup_fee'} = $opt{'amount'};
2433 $pkg_opt_modified = 1;
2436 if ( exists($opt{'setup_cost'})
2437 and $part_pkg->setup_cost != $opt{'setup_cost'}
2438 and $opt{'setup_cost'} > 0 ) {
2440 $part_pkg->set('setup_cost', $opt{'setup_cost'});
2443 if ( exists($opt{'quantity'})
2444 and $opt{'quantity'} != $self->quantity
2445 and $opt{'quantity'} > 0 ) {
2447 $self->set('quantity', $opt{'quantity'});
2450 if ( exists($opt{'start_date'})
2451 and $opt{'start_date'} != $self->start_date ) {
2453 $self->set('start_date', $opt{'start_date'});
2457 } # else simply ignore them; the UI shouldn't allow editing the fields
2460 if ( exists($opt{'taxclass'})
2461 and $part_pkg->taxclass ne $opt{'taxclass'}) {
2463 $part_pkg->set('taxclass', $opt{'taxclass'});
2467 if ( $part_pkg->modified or $pkg_opt_modified ) {
2468 # can we safely modify the package def?
2469 # Yes, if it's not available for purchase, and this is the only instance
2471 if ( $part_pkg->disabled
2472 and FS::cust_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 1
2473 and FS::quotation_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 0
2475 $error = $part_pkg->replace( options => \%pkg_opt );
2478 $part_pkg = $part_pkg->clone;
2479 $part_pkg->set('disabled' => 'Y');
2480 $error = $part_pkg->insert( options => \%pkg_opt );
2481 # and associate this as yet-unbilled package to the new package def
2482 $self->set('pkgpart' => $part_pkg->pkgpart);
2485 $dbh->rollback if $oldAutoCommit;
2490 if ($self->modified) { # for quantity or start_date change, or if we had
2491 # to clone the existing package def
2492 my $error = $self->replace;
2493 return $error if $error;
2495 if (defined $old_classnum) {
2496 # fix invoice grouping records
2497 my $old_catname = $old_classnum
2498 ? FS::pkg_class->by_key($old_classnum)->categoryname
2500 my $new_catname = $opt{'classnum'}
2501 ? $part_pkg->pkg_class->categoryname
2503 if ( $old_catname ne $new_catname ) {
2504 foreach my $cust_bill_pkg ($self->cust_bill_pkg) {
2505 # (there should only be one...)
2506 my @display = qsearch( 'cust_bill_pkg_display', {
2507 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2508 'section' => $old_catname,
2510 foreach (@display) {
2511 $_->set('section', $new_catname);
2512 $error = $_->replace;
2514 $dbh->rollback if $oldAutoCommit;
2518 } # foreach $cust_bill_pkg
2521 if ( $opt{'adjust_commission'} ) {
2522 # fix commission credits...tricky.
2523 foreach my $cust_event ($self->cust_event) {
2524 my $part_event = $cust_event->part_event;
2525 foreach my $table (qw(sales agent)) {
2527 "FS::part_event::Action::Mixin::credit_${table}_pkg_class";
2528 my $credit = qsearchs('cust_credit', {
2529 'eventnum' => $cust_event->eventnum,
2531 if ( $part_event->isa($class) ) {
2532 # Yes, this results in current commission rates being applied
2533 # retroactively to a one-time charge. For accounting purposes
2534 # there ought to be some kind of time limit on doing this.
2535 my $amount = $part_event->_calc_credit($self);
2536 if ( $credit and $credit->amount ne $amount ) {
2537 # Void the old credit.
2538 $error = $credit->void('Package class changed');
2540 $dbh->rollback if $oldAutoCommit;
2541 return "$error (adjusting commission credit)";
2544 # redo the event action to recreate the credit.
2546 eval { $part_event->do_action( $self, $cust_event ) };
2548 $dbh->rollback if $oldAutoCommit;
2551 } # if $part_event->isa($class)
2553 } # foreach $cust_event
2554 } # if $opt{'adjust_commission'}
2555 } # if defined $old_classnum
2557 $dbh->commit if $oldAutoCommit;
2564 sub process_bulk_cust_pkg {
2567 warn Dumper($param) if $DEBUG;
2569 my $old_part_pkg = qsearchs('part_pkg',
2570 { pkgpart => $param->{'old_pkgpart'} });
2571 my $new_part_pkg = qsearchs('part_pkg',
2572 { pkgpart => $param->{'new_pkgpart'} });
2573 die "Must select a new package type\n" unless $new_part_pkg;
2574 #my $keep_dates = $param->{'keep_dates'} || 0;
2575 my $keep_dates = 1; # there is no good reason to turn this off
2577 my $oldAutoCommit = $FS::UID::AutoCommit;
2578 local $FS::UID::AutoCommit = 0;
2581 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
2584 foreach my $old_cust_pkg ( @cust_pkgs ) {
2586 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
2587 if ( $old_cust_pkg->getfield('cancel') ) {
2588 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
2589 $old_cust_pkg->pkgnum."\n"
2593 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
2595 my $error = $old_cust_pkg->change(
2596 'pkgpart' => $param->{'new_pkgpart'},
2597 'keep_dates' => $keep_dates
2599 if ( !ref($error) ) { # change returns the cust_pkg on success
2601 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
2604 $dbh->commit if $oldAutoCommit;
2610 Returns the last bill date, or if there is no last bill date, the setup date.
2611 Useful for billing metered services.
2617 return $self->setfield('last_bill', $_[0]) if @_;
2618 return $self->getfield('last_bill') if $self->getfield('last_bill');
2619 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
2620 'edate' => $self->bill, } );
2621 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
2624 =item last_cust_pkg_reason ACTION
2626 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
2627 Returns false if there is no reason or the package is not currenly ACTION'd
2628 ACTION is one of adjourn, susp, cancel, or expire.
2632 sub last_cust_pkg_reason {
2633 my ( $self, $action ) = ( shift, shift );
2634 my $date = $self->get($action);
2636 'table' => 'cust_pkg_reason',
2637 'hashref' => { 'pkgnum' => $self->pkgnum,
2638 'action' => substr(uc($action), 0, 1),
2641 'order_by' => 'ORDER BY num DESC LIMIT 1',
2645 =item last_reason ACTION
2647 Returns the most recent ACTION FS::reason associated with the package.
2648 Returns false if there is no reason or the package is not currenly ACTION'd
2649 ACTION is one of adjourn, susp, cancel, or expire.
2654 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
2655 $cust_pkg_reason->reason
2656 if $cust_pkg_reason;
2661 Returns the definition for this billing item, as an FS::part_pkg object (see
2668 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
2669 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
2670 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
2675 Returns the cancelled package this package was changed from, if any.
2681 return '' unless $self->change_pkgnum;
2682 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
2685 =item change_cust_main
2687 Returns the customter this package was detached to, if any.
2691 sub change_cust_main {
2693 return '' unless $self->change_custnum;
2694 qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
2699 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
2706 $self->part_pkg->calc_setup($self, @_);
2711 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
2718 $self->part_pkg->calc_recur($self, @_);
2723 Calls the I<base_setup> of the FS::part_pkg object associated with this billing
2730 $self->part_pkg->base_setup($self, @_);
2735 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
2742 $self->part_pkg->base_recur($self, @_);
2747 Calls the I<calc_remain> of the FS::part_pkg object associated with this
2754 $self->part_pkg->calc_remain($self, @_);
2759 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
2766 $self->part_pkg->calc_cancel($self, @_);
2771 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
2777 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
2780 =item cust_pkg_detail [ DETAILTYPE ]
2782 Returns any customer package details for this package (see
2783 L<FS::cust_pkg_detail>).
2785 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2789 sub cust_pkg_detail {
2791 my %hash = ( 'pkgnum' => $self->pkgnum );
2792 $hash{detailtype} = shift if @_;
2794 'table' => 'cust_pkg_detail',
2795 'hashref' => \%hash,
2796 'order_by' => 'ORDER BY weight, pkgdetailnum',
2800 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
2802 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
2804 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2806 If there is an error, returns the error, otherwise returns false.
2810 sub set_cust_pkg_detail {
2811 my( $self, $detailtype, @details ) = @_;
2813 my $oldAutoCommit = $FS::UID::AutoCommit;
2814 local $FS::UID::AutoCommit = 0;
2817 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
2818 my $error = $current->delete;
2820 $dbh->rollback if $oldAutoCommit;
2821 return "error removing old detail: $error";
2825 foreach my $detail ( @details ) {
2826 my $cust_pkg_detail = new FS::cust_pkg_detail {
2827 'pkgnum' => $self->pkgnum,
2828 'detailtype' => $detailtype,
2829 'detail' => $detail,
2831 my $error = $cust_pkg_detail->insert;
2833 $dbh->rollback if $oldAutoCommit;
2834 return "error adding new detail: $error";
2839 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2846 Returns the customer billing events (see L<FS::cust_event>) for this invoice.
2850 #false laziness w/cust_bill.pm
2854 'table' => 'cust_event',
2855 'addl_from' => 'JOIN part_event USING ( eventpart )',
2856 'hashref' => { 'tablenum' => $self->pkgnum },
2857 'extra_sql' => " AND eventtable = 'cust_pkg' ",
2861 =item num_cust_event
2863 Returns the number of customer billing events (see L<FS::cust_event>) for this package.
2867 #false laziness w/cust_bill.pm
2868 sub num_cust_event {
2870 my $sql = "SELECT COUNT(*) ". $self->_from_cust_event_where;
2871 $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref->[0];
2874 =item exists_cust_event
2876 Returns true if there are customer billing events (see L<FS::cust_event>) for this package. More efficient than using num_cust_event.
2880 sub exists_cust_event {
2882 my $sql = "SELECT 1 ". $self->_from_cust_event_where. " LIMIT 1";
2883 my $row = $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref;
2884 $row ? $row->[0] : '';
2887 sub _from_cust_event_where {
2889 " FROM cust_event JOIN part_event USING ( eventpart ) ".
2890 " WHERE tablenum = ? AND eventtable = 'cust_pkg' ";
2894 my( $self, $sql, @args ) = @_;
2895 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
2896 $sth->execute(@args) or die $sth->errstr. " executing $sql";
2900 =item part_pkg_currency_option OPTIONNAME
2902 Returns a two item list consisting of the currency of this customer, if any,
2903 and a value for the provided option. If the customer has a currency, the value
2904 is the option value the given name and the currency (see
2905 L<FS::part_pkg_currency>). Otherwise, if the customer has no currency, is the
2906 regular option value for the given name (see L<FS::part_pkg_option>).
2910 sub part_pkg_currency_option {
2911 my( $self, $optionname ) = @_;
2912 my $part_pkg = $self->part_pkg;
2913 if ( my $currency = $self->cust_main->currency ) {
2914 ($currency, $part_pkg->part_pkg_currency_option($currency, $optionname) );
2916 ('', $part_pkg->option($optionname) );
2920 =item cust_svc [ SVCPART ] (old, deprecated usage)
2922 =item cust_svc [ OPTION => VALUE ... ] (current usage)
2924 =item cust_svc_unsorted [ OPTION => VALUE ... ]
2926 Returns the services for this package, as FS::cust_svc objects (see
2927 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
2928 spcififed, returns only the matching services.
2930 As an optimization, use the cust_svc_unsorted version if you are not displaying
2937 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
2938 $self->_sort_cust_svc( $self->cust_svc_unsorted_arrayref(@_) );
2941 sub cust_svc_unsorted {
2943 @{ $self->cust_svc_unsorted_arrayref(@_) };
2946 sub cust_svc_unsorted_arrayref {
2949 return [] unless $self->num_cust_svc(@_);
2952 if ( @_ && $_[0] =~ /^\d+/ ) {
2953 $opt{svcpart} = shift;
2954 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2961 'table' => 'cust_svc',
2962 'hashref' => { 'pkgnum' => $self->pkgnum },
2964 if ( $opt{svcpart} ) {
2965 $search{hashref}->{svcpart} = $opt{'svcpart'};
2967 if ( $opt{'svcdb'} ) {
2968 $search{addl_from} = ' LEFT JOIN part_svc USING ( svcpart ) ';
2969 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{'svcdb'} );
2972 [ qsearch(\%search) ];
2976 =item overlimit [ SVCPART ]
2978 Returns the services for this package which have exceeded their
2979 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
2980 is specified, return only the matching services.
2986 return () unless $self->num_cust_svc(@_);
2987 grep { $_->overlimit } $self->cust_svc(@_);
2990 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2992 Returns historical services for this package created before END TIMESTAMP and
2993 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
2994 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
2995 I<pkg_svc.hidden> flag will be omitted.
3001 warn "$me _h_cust_svc called on $self\n"
3004 my ($end, $start, $mode) = @_;
3006 local($FS::Record::qsearch_qualify_columns) = 0;
3008 my @cust_svc = $self->_sort_cust_svc(
3009 [ qsearch( 'h_cust_svc',
3010 { 'pkgnum' => $self->pkgnum, },
3011 FS::h_cust_svc->sql_h_search(@_),
3015 if ( defined($mode) && $mode eq 'I' ) {
3016 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
3017 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
3023 sub _sort_cust_svc {
3024 my( $self, $arrayref ) = @_;
3027 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
3029 my %pkg_svc = map { $_->svcpart => $_ }
3030 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
3035 my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
3037 $pkg_svc ? $pkg_svc->primary_svc : '',
3038 $pkg_svc ? $pkg_svc->quantity : 0,
3045 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
3047 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
3049 Returns the number of services for this package. Available options are svcpart
3050 and svcdb. If either is spcififed, returns only the matching services.
3057 return $self->{'_num_cust_svc'}
3059 && exists($self->{'_num_cust_svc'})
3060 && $self->{'_num_cust_svc'} =~ /\d/;
3062 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
3066 if ( @_ && $_[0] =~ /^\d+/ ) {
3067 $opt{svcpart} = shift;
3068 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3074 my $select = 'SELECT COUNT(*) FROM cust_svc ';
3075 my $where = ' WHERE pkgnum = ? ';
3076 my @param = ($self->pkgnum);
3078 if ( $opt{'svcpart'} ) {
3079 $where .= ' AND svcpart = ? ';
3080 push @param, $opt{'svcpart'};
3082 if ( $opt{'svcdb'} ) {
3083 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
3084 $where .= ' AND svcdb = ? ';
3085 push @param, $opt{'svcdb'};
3088 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
3089 $sth->execute(@param) or die $sth->errstr;
3090 $sth->fetchrow_arrayref->[0];
3093 =item available_part_svc
3095 Returns a list of FS::part_svc objects representing services included in this
3096 package but not yet provisioned. Each FS::part_svc object also has an extra
3097 field, I<num_avail>, which specifies the number of available services.
3101 sub available_part_svc {
3104 my $pkg_quantity = $self->quantity || 1;
3106 grep { $_->num_avail > 0 }
3108 my $part_svc = $_->part_svc;
3109 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
3110 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
3112 # more evil encapsulation breakage
3113 if($part_svc->{'Hash'}{'num_avail'} > 0) {
3114 my @exports = $part_svc->part_export_did;
3115 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
3120 $self->part_pkg->pkg_svc;
3123 =item part_svc [ OPTION => VALUE ... ]
3125 Returns a list of FS::part_svc objects representing provisioned and available
3126 services included in this package. Each FS::part_svc object also has the
3127 following extra fields:
3141 (services) - array reference containing the provisioned services, as cust_svc objects
3145 Accepts two options:
3149 =item summarize_size
3151 If true, will omit the extra cust_pkg_svc option for objects where num_cust_svc
3152 is this size or greater.
3154 =item hide_discontinued
3156 If true, will omit looking for services that are no longer avaialble in the
3164 #label -> ($cust_svc->label)[1]
3170 my $pkg_quantity = $self->quantity || 1;
3172 #XXX some sort of sort order besides numeric by svcpart...
3173 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
3175 my $part_svc = $pkg_svc->part_svc;
3176 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3177 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
3178 $part_svc->{'Hash'}{'num_avail'} =
3179 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
3180 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3181 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
3182 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
3183 && $num_cust_svc >= $opt{summarize_size};
3184 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
3186 } $self->part_pkg->pkg_svc;
3188 unless ( $opt{hide_discontinued} ) {
3190 push @part_svc, map {
3192 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3193 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
3194 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
3195 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3196 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
3198 } $self->extra_part_svc;
3205 =item extra_part_svc
3207 Returns a list of FS::part_svc objects corresponding to services in this
3208 package which are still provisioned but not (any longer) available in the
3213 sub extra_part_svc {
3216 my $pkgnum = $self->pkgnum;
3217 #my $pkgpart = $self->pkgpart;
3220 # 'table' => 'part_svc',
3223 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
3224 # WHERE pkg_svc.svcpart = part_svc.svcpart
3225 # AND pkg_svc.pkgpart = ?
3228 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
3229 # LEFT JOIN cust_pkg USING ( pkgnum )
3230 # WHERE cust_svc.svcpart = part_svc.svcpart
3233 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
3236 #seems to benchmark slightly faster... (or did?)
3238 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
3239 my $pkgparts = join(',', @pkgparts);
3242 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
3243 #MySQL doesn't grok DISINCT ON
3244 'select' => 'DISTINCT part_svc.*',
3245 'table' => 'part_svc',
3247 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
3248 AND pkg_svc.pkgpart IN ($pkgparts)
3251 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
3252 LEFT JOIN cust_pkg USING ( pkgnum )
3255 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
3256 'extra_param' => [ [$self->pkgnum=>'int'] ],
3262 Returns a short status string for this package, currently:
3268 =item not yet billed
3270 =item one-time charge
3285 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
3287 return 'cancelled' if $self->get('cancel');
3288 return 'on hold' if $self->susp && ! $self->setup;
3289 return 'suspended' if $self->susp;
3290 return 'not yet billed' unless $self->setup;
3291 return 'one-time charge' if $freq =~ /^(0|$)/;
3295 =item ucfirst_status
3297 Returns the status with the first character capitalized.
3301 sub ucfirst_status {
3302 ucfirst(shift->status);
3307 Class method that returns the list of possible status strings for packages
3308 (see L<the status method|/status>). For example:
3310 @statuses = FS::cust_pkg->statuses();
3314 tie my %statuscolor, 'Tie::IxHash',
3315 'on hold' => '7E0079', #purple!
3316 'not yet billed' => '009999', #teal? cyan?
3317 'one-time charge' => '0000CC', #blue #'000000',
3318 'active' => '00CC00',
3319 'suspended' => 'FF9900',
3320 'cancelled' => 'FF0000',
3324 my $self = shift; #could be class...
3325 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
3326 # # mayble split btw one-time vs. recur
3337 Returns a hex triplet color string for this package's status.
3343 $statuscolor{$self->status};
3348 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
3349 "pkg - comment" depending on user preference).
3355 my $label = $self->part_pkg->pkg_comment( cust_pkg=>$self, nopkgpart=>1 );
3356 $label = $self->pkgnum. ": $label"
3357 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
3361 =item pkg_label_long
3363 Returns a long label for this package, adding the primary service's label to
3368 sub pkg_label_long {
3370 my $label = $self->pkg_label;
3371 my $cust_svc = $self->primary_cust_svc;
3372 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
3378 Returns a customer-localized label for this package.
3384 $self->part_pkg->pkg_locale( $self->cust_main->locale );
3387 =item primary_cust_svc
3389 Returns a primary service (as FS::cust_svc object) if one can be identified.
3393 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
3395 sub primary_cust_svc {
3398 my @cust_svc = $self->cust_svc;
3400 return '' unless @cust_svc; #no serivces - irrelevant then
3402 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
3404 # primary service as specified in the package definition
3405 # or exactly one service definition with quantity one
3406 my $svcpart = $self->part_pkg->svcpart;
3407 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
3408 return $cust_svc[0] if scalar(@cust_svc) == 1;
3410 #couldn't identify one thing..
3416 Returns a list of lists, calling the label method for all services
3417 (see L<FS::cust_svc>) of this billing item.
3423 map { [ $_->label ] } $self->cust_svc;
3426 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3428 Like the labels method, but returns historical information on services that
3429 were active as of END_TIMESTAMP and (optionally) not cancelled before
3430 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
3431 I<pkg_svc.hidden> flag will be omitted.
3433 Returns a list of lists, calling the label method for all (historical) services
3434 (see L<FS::h_cust_svc>) of this billing item.
3440 warn "$me _h_labels called on $self\n"
3442 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
3447 Like labels, except returns a simple flat list, and shortens long
3448 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3449 identical services to one line that lists the service label and the number of
3450 individual services rather than individual items.
3455 shift->_labels_short( 'labels', @_ );
3458 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
3460 Like h_labels, except returns a simple flat list, and shortens long
3461 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3462 identical services to one line that lists the service label and the number of
3463 individual services rather than individual items.
3467 sub h_labels_short {
3468 shift->_labels_short( 'h_labels', @_ );
3472 my( $self, $method ) = ( shift, shift );
3474 warn "$me _labels_short called on $self with $method method\n"
3477 my $conf = new FS::Conf;
3478 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
3480 warn "$me _labels_short populating \%labels\n"
3484 #tie %labels, 'Tie::IxHash';
3485 push @{ $labels{$_->[0]} }, $_->[1]
3486 foreach $self->$method(@_);
3488 warn "$me _labels_short populating \@labels\n"
3492 foreach my $label ( keys %labels ) {
3494 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
3495 my $num = scalar(@values);
3496 warn "$me _labels_short $num items for $label\n"
3499 if ( $num > $max_same_services ) {
3500 warn "$me _labels_short more than $max_same_services, so summarizing\n"
3502 push @labels, "$label ($num)";
3504 if ( $conf->exists('cust_bill-consolidate_services') ) {
3505 warn "$me _labels_short consolidating services\n"
3507 # push @labels, "$label: ". join(', ', @values);
3509 my $detail = "$label: ";
3510 $detail .= shift(@values). ', '
3512 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
3514 push @labels, $detail;
3516 warn "$me _labels_short done consolidating services\n"
3519 warn "$me _labels_short adding service data\n"
3521 push @labels, map { "$label: $_" } @values;
3532 Returns the parent customer object (see L<FS::cust_main>).
3536 Returns the balance for this specific package, when using
3537 experimental package balance.
3543 $self->cust_main->balance_pkgnum( $self->pkgnum );
3546 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
3550 Returns the location object, if any (see L<FS::cust_location>).
3552 =item cust_location_or_main
3554 If this package is associated with a location, returns the locaiton (see
3555 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
3557 =item location_label [ OPTION => VALUE ... ]
3559 Returns the label of the location object (see L<FS::cust_location>).
3563 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
3565 =item tax_locationnum
3567 Returns the foreign key to a L<FS::cust_location> object for calculating
3568 tax on this package, as determined by the C<tax-pkg_address> and
3569 C<tax-ship_address> configuration flags.
3573 sub tax_locationnum {
3575 my $conf = FS::Conf->new;
3576 if ( $conf->exists('tax-pkg_address') ) {
3577 return $self->locationnum;
3579 elsif ( $conf->exists('tax-ship_address') ) {
3580 return $self->cust_main->ship_locationnum;
3583 return $self->cust_main->bill_locationnum;
3589 Returns the L<FS::cust_location> object for tax_locationnum.
3595 my $conf = FS::Conf->new;
3596 if ( $conf->exists('tax-pkg_address') and $self->locationnum ) {
3597 return FS::cust_location->by_key($self->locationnum);
3599 elsif ( $conf->exists('tax-ship_address') ) {
3600 return $self->cust_main->ship_location;
3603 return $self->cust_main->bill_location;
3607 =item seconds_since TIMESTAMP
3609 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
3610 package have been online since TIMESTAMP, according to the session monitor.
3612 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
3613 L<Time::Local> and L<Date::Parse> for conversion functions.
3618 my($self, $since) = @_;
3621 foreach my $cust_svc (
3622 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
3624 $seconds += $cust_svc->seconds_since($since);
3631 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
3633 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
3634 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
3637 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3638 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3644 sub seconds_since_sqlradacct {
3645 my($self, $start, $end) = @_;
3649 foreach my $cust_svc (
3651 my $part_svc = $_->part_svc;
3652 $part_svc->svcdb eq 'svc_acct'
3653 && scalar($part_svc->part_export_usage);
3656 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
3663 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
3665 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
3666 in this package for sessions ending between TIMESTAMP_START (inclusive) and
3670 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3671 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3676 sub attribute_since_sqlradacct {
3677 my($self, $start, $end, $attrib) = @_;
3681 foreach my $cust_svc (
3683 my $part_svc = $_->part_svc;
3684 scalar($part_svc->part_export_usage);
3687 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
3699 my( $self, $value ) = @_;
3700 if ( defined($value) ) {
3701 $self->setfield('quantity', $value);
3703 $self->getfield('quantity') || 1;
3706 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
3708 Transfers as many services as possible from this package to another package.
3710 The destination package can be specified by pkgnum by passing an FS::cust_pkg
3711 object. The destination package must already exist.
3713 Services are moved only if the destination allows services with the correct
3714 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
3715 this option with caution! No provision is made for export differences
3716 between the old and new service definitions. Probably only should be used
3717 when your exports for all service definitions of a given svcdb are identical.
3718 (attempt a transfer without it first, to move all possible svcpart-matching
3721 Any services that can't be moved remain in the original package.
3723 Returns an error, if there is one; otherwise, returns the number of services
3724 that couldn't be moved.
3729 my ($self, $dest_pkgnum, %opt) = @_;
3735 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
3736 $dest = $dest_pkgnum;
3737 $dest_pkgnum = $dest->pkgnum;
3739 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
3742 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
3744 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
3745 $target{$pkg_svc->svcpart} = $pkg_svc->quantity * ( $dest->quantity || 1 );
3748 foreach my $cust_svc ($dest->cust_svc) {
3749 $target{$cust_svc->svcpart}--;
3752 my %svcpart2svcparts = ();
3753 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3754 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
3755 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
3756 next if exists $svcpart2svcparts{$svcpart};
3757 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
3758 $svcpart2svcparts{$svcpart} = [
3760 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
3762 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
3763 'svcpart' => $_ } );
3765 $pkg_svc ? $pkg_svc->primary_svc : '',
3766 $pkg_svc ? $pkg_svc->quantity : 0,
3770 grep { $_ != $svcpart }
3772 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
3774 warn "alternates for svcpart $svcpart: ".
3775 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
3781 foreach my $cust_svc ($self->cust_svc) {
3782 my $svcnum = $cust_svc->svcnum;
3783 if($target{$cust_svc->svcpart} > 0
3784 or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
3785 $target{$cust_svc->svcpart}--;
3786 my $new = new FS::cust_svc { $cust_svc->hash };
3787 $new->pkgnum($dest_pkgnum);
3788 $error = $new->replace($cust_svc);
3789 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3791 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
3792 warn "alternates to consider: ".
3793 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
3795 my @alternate = grep {
3796 warn "considering alternate svcpart $_: ".
3797 "$target{$_} available in new package\n"
3800 } @{$svcpart2svcparts{$cust_svc->svcpart}};
3802 warn "alternate(s) found\n" if $DEBUG;
3803 my $change_svcpart = $alternate[0];
3804 $target{$change_svcpart}--;
3805 my $new = new FS::cust_svc { $cust_svc->hash };
3806 $new->svcpart($change_svcpart);
3807 $new->pkgnum($dest_pkgnum);
3808 $error = $new->replace($cust_svc);
3816 my @label = $cust_svc->label;
3817 return "$label[0] $label[1]: $error";
3823 =item grab_svcnums SVCNUM, SVCNUM ...
3825 Change the pkgnum for the provided services to this packages. If there is an
3826 error, returns the error, otherwise returns false.
3834 my $oldAutoCommit = $FS::UID::AutoCommit;
3835 local $FS::UID::AutoCommit = 0;
3838 foreach my $svcnum (@svcnum) {
3839 my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
3840 $dbh->rollback if $oldAutoCommit;
3841 return "unknown svcnum $svcnum";
3843 $cust_svc->pkgnum( $self->pkgnum );
3844 my $error = $cust_svc->replace;
3846 $dbh->rollback if $oldAutoCommit;
3851 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3858 This method is deprecated. See the I<depend_jobnum> option to the insert and
3859 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
3863 #looks like this is still used by the order_pkg and change_pkg methods in
3864 # ClientAPI/MyAccount, need to look into those before removing
3868 my $oldAutoCommit = $FS::UID::AutoCommit;
3869 local $FS::UID::AutoCommit = 0;
3872 foreach my $cust_svc ( $self->cust_svc ) {
3873 #false laziness w/svc_Common::insert
3874 my $svc_x = $cust_svc->svc_x;
3875 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
3876 my $error = $part_export->export_insert($svc_x);
3878 $dbh->rollback if $oldAutoCommit;
3884 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3889 =item export_pkg_change OLD_CUST_PKG
3891 Calls the "pkg_change" export action for all services attached to this package.
3895 sub export_pkg_change {
3896 my( $self, $old ) = ( shift, shift );
3898 my $oldAutoCommit = $FS::UID::AutoCommit;
3899 local $FS::UID::AutoCommit = 0;
3902 foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
3903 my $error = $svc_x->export('pkg_change', $self, $old);
3905 $dbh->rollback if $oldAutoCommit;
3910 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3917 Associates this package with a (suspension or cancellation) reason (see
3918 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
3921 Available options are:
3927 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.
3931 the access_user (see L<FS::access_user>) providing the reason
3939 the action (cancel, susp, adjourn, expire) associated with the reason
3943 If there is an error, returns the error, otherwise returns false.
3948 my ($self, %options) = @_;
3950 my $otaker = $options{reason_otaker} ||
3951 $FS::CurrentUser::CurrentUser->username;
3954 if ( $options{'reason'} =~ /^(\d+)$/ ) {
3958 } elsif ( ref($options{'reason'}) ) {
3960 return 'Enter a new reason (or select an existing one)'
3961 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
3963 my $reason = new FS::reason({
3964 'reason_type' => $options{'reason'}->{'typenum'},
3965 'reason' => $options{'reason'}->{'reason'},
3967 my $error = $reason->insert;
3968 return $error if $error;
3970 $reasonnum = $reason->reasonnum;
3973 return "Unparseable reason: ". $options{'reason'};
3976 my $cust_pkg_reason =
3977 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
3978 'reasonnum' => $reasonnum,
3979 'otaker' => $otaker,
3980 'action' => substr(uc($options{'action'}),0,1),
3981 'date' => $options{'date'}
3986 $cust_pkg_reason->insert;
3989 =item insert_discount
3991 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
3992 inserting a new discount on the fly (see L<FS::discount>).
3994 Available options are:
4002 If there is an error, returns the error, otherwise returns false.
4006 sub insert_discount {
4007 #my ($self, %options) = @_;
4010 my $cust_pkg_discount = new FS::cust_pkg_discount {
4011 'pkgnum' => $self->pkgnum,
4012 'discountnum' => $self->discountnum,
4014 'end_date' => '', #XXX
4015 #for the create a new discount case
4016 '_type' => $self->discountnum__type,
4017 'amount' => $self->discountnum_amount,
4018 'percent' => $self->discountnum_percent,
4019 'months' => $self->discountnum_months,
4020 'setup' => $self->discountnum_setup,
4021 #'disabled' => $self->discountnum_disabled,
4024 $cust_pkg_discount->insert;
4027 =item set_usage USAGE_VALUE_HASHREF
4029 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4030 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4031 upbytes, downbytes, and totalbytes are appropriate keys.
4033 All svc_accts which are part of this package have their values reset.
4038 my ($self, $valueref, %opt) = @_;
4040 #only svc_acct can set_usage for now
4041 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4042 my $svc_x = $cust_svc->svc_x;
4043 $svc_x->set_usage($valueref, %opt)
4044 if $svc_x->can("set_usage");
4048 =item recharge USAGE_VALUE_HASHREF
4050 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4051 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4052 upbytes, downbytes, and totalbytes are appropriate keys.
4054 All svc_accts which are part of this package have their values incremented.
4059 my ($self, $valueref) = @_;
4061 #only svc_acct can set_usage for now
4062 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4063 my $svc_x = $cust_svc->svc_x;
4064 $svc_x->recharge($valueref)
4065 if $svc_x->can("recharge");
4069 =item apply_usageprice
4073 sub apply_usageprice {
4076 my $oldAutoCommit = $FS::UID::AutoCommit;
4077 local $FS::UID::AutoCommit = 0;
4082 foreach my $cust_pkg_usageprice ( $self->cust_pkg_usageprice ) {
4083 $error ||= $cust_pkg_usageprice->apply;
4087 $dbh->rollback if $oldAutoCommit;
4088 die "error applying part_pkg_usageprice add-ons, pkgnum ". $self->pkgnum.
4091 $dbh->commit if $oldAutoCommit;
4097 =item cust_pkg_discount
4099 =item cust_pkg_discount_active
4103 sub cust_pkg_discount_active {
4105 grep { $_->status eq 'active' } $self->cust_pkg_discount;
4108 =item cust_pkg_usage
4110 Returns a list of all voice usage counters attached to this package.
4112 =item apply_usage OPTIONS
4114 Takes the following options:
4115 - cdr: a call detail record (L<FS::cdr>)
4116 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
4117 - minutes: the maximum number of minutes to be charged
4119 Finds available usage minutes for a call of this class, and subtracts
4120 up to that many minutes from the usage pool. If the usage pool is empty,
4121 and the C<cdr-minutes_priority> global config option is set, minutes may
4122 be taken from other calls as well. Either way, an allocation record will
4123 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
4124 number of minutes of usage applied to the call.
4129 my ($self, %opt) = @_;
4130 my $cdr = $opt{cdr};
4131 my $rate_detail = $opt{rate_detail};
4132 my $minutes = $opt{minutes};
4133 my $classnum = $rate_detail->classnum;
4134 my $pkgnum = $self->pkgnum;
4135 my $custnum = $self->custnum;
4137 my $oldAutoCommit = $FS::UID::AutoCommit;
4138 local $FS::UID::AutoCommit = 0;
4141 my $order = FS::Conf->new->config('cdr-minutes_priority');
4145 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
4147 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
4149 my @usage_recs = qsearch({
4150 'table' => 'cust_pkg_usage',
4151 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
4152 ' JOIN cust_pkg USING (pkgnum)'.
4153 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
4154 'select' => 'cust_pkg_usage.*',
4155 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
4156 " ( cust_pkg.custnum = $custnum AND ".
4157 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4158 $is_classnum . ' AND '.
4159 " cust_pkg_usage.minutes > 0",
4160 'order_by' => " ORDER BY priority ASC",
4163 my $orig_minutes = $minutes;
4165 while (!$error and $minutes > 0 and @usage_recs) {
4166 my $cust_pkg_usage = shift @usage_recs;
4167 $cust_pkg_usage->select_for_update;
4168 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
4169 pkgusagenum => $cust_pkg_usage->pkgusagenum,
4170 acctid => $cdr->acctid,
4171 minutes => min($cust_pkg_usage->minutes, $minutes),
4173 $cust_pkg_usage->set('minutes',
4174 $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes
4176 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
4177 $minutes -= $cdr_cust_pkg_usage->minutes;
4179 if ( $order and $minutes > 0 and !$error ) {
4180 # then try to steal minutes from another call
4182 'table' => 'cdr_cust_pkg_usage',
4183 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
4184 ' JOIN part_pkg_usage USING (pkgusagepart)'.
4185 ' JOIN cust_pkg USING (pkgnum)'.
4186 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
4187 ' JOIN cdr USING (acctid)',
4188 'select' => 'cdr_cust_pkg_usage.*',
4189 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
4190 " ( cust_pkg.pkgnum = $pkgnum OR ".
4191 " ( cust_pkg.custnum = $custnum AND ".
4192 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4193 " part_pkg_usage_class.classnum = $classnum",
4194 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
4196 if ( $order eq 'time' ) {
4197 # find CDRs that are using minutes, but have a later startdate
4199 my $startdate = $cdr->startdate;
4200 if ($startdate !~ /^\d+$/) {
4201 die "bad cdr startdate '$startdate'";
4203 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
4204 # minimize needless reshuffling
4205 $search{'order_by'} .= ', cdr.startdate DESC';
4207 # XXX may not work correctly with rate_time schedules. Could
4208 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
4210 $search{'addl_from'} .=
4211 ' JOIN rate_detail'.
4212 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
4213 if ( $order eq 'rate_high' ) {
4214 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
4215 $rate_detail->min_charge;
4216 $search{'order_by'} .= ', rate_detail.min_charge ASC';
4217 } elsif ( $order eq 'rate_low' ) {
4218 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
4219 $rate_detail->min_charge;
4220 $search{'order_by'} .= ', rate_detail.min_charge DESC';
4222 # this should really never happen
4223 die "invalid cdr-minutes_priority value '$order'\n";
4226 my @cdr_usage_recs = qsearch(\%search);
4228 while (!$error and @cdr_usage_recs and $minutes > 0) {
4229 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
4230 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
4231 my $old_cdr = $cdr_cust_pkg_usage->cdr;
4232 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
4233 $cdr_cust_pkg_usage->select_for_update;
4234 $old_cdr->select_for_update;
4235 $cust_pkg_usage->select_for_update;
4236 # in case someone else stole the usage from this CDR
4237 # while waiting for the lock...
4238 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
4239 # steal the usage allocation and flag the old CDR for reprocessing
4240 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
4241 # if the allocation is more minutes than we need, adjust it...
4242 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
4244 $cdr_cust_pkg_usage->set('minutes', $minutes);
4245 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
4246 $error = $cust_pkg_usage->replace;
4248 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
4249 $error ||= $cdr_cust_pkg_usage->replace;
4250 # deduct the stolen minutes
4251 $minutes -= $cdr_cust_pkg_usage->minutes;
4253 # after all minute-stealing is done, reset the affected CDRs
4254 foreach (values %reproc_cdrs) {
4255 $error ||= $_->set_status('');
4256 # XXX or should we just call $cdr->rate right here?
4257 # it's not like we can create a loop this way, since the min_charge
4258 # or call time has to go monotonically in one direction.
4259 # we COULD get some very deep recursions going, though...
4261 } # if $order and $minutes
4264 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
4266 $dbh->commit if $oldAutoCommit;
4267 return $orig_minutes - $minutes;
4271 =item supplemental_pkgs
4273 Returns a list of all packages supplemental to this one.
4277 sub supplemental_pkgs {
4279 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
4284 Returns the package that this one is supplemental to, if any.
4290 if ( $self->main_pkgnum ) {
4291 return FS::cust_pkg->by_key($self->main_pkgnum);
4298 =head1 CLASS METHODS
4304 Returns an SQL expression identifying recurring packages.
4308 sub recurring_sql { "
4309 '0' != ( select freq from part_pkg
4310 where cust_pkg.pkgpart = part_pkg.pkgpart )
4315 Returns an SQL expression identifying one-time packages.
4320 '0' = ( select freq from part_pkg
4321 where cust_pkg.pkgpart = part_pkg.pkgpart )
4326 Returns an SQL expression identifying ordered packages (recurring packages not
4332 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
4337 Returns an SQL expression identifying active packages.
4342 $_[0]->recurring_sql. "
4343 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4344 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4345 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4348 =item not_yet_billed_sql
4350 Returns an SQL expression identifying packages which have not yet been billed.
4354 sub not_yet_billed_sql { "
4355 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4356 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4357 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4362 Returns an SQL expression identifying inactive packages (one-time packages
4363 that are otherwise unsuspended/uncancelled).
4367 sub inactive_sql { "
4368 ". $_[0]->onetime_sql(). "
4369 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4370 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4371 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4376 Returns an SQL expression identifying on-hold packages.
4381 #$_[0]->recurring_sql(). ' AND '.
4383 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4384 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4385 AND ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4392 Returns an SQL expression identifying suspended packages.
4396 sub suspended_sql { susp_sql(@_); }
4398 #$_[0]->recurring_sql(). ' AND '.
4400 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4401 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4402 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4409 Returns an SQL exprression identifying cancelled packages.
4413 sub cancelled_sql { cancel_sql(@_); }
4415 #$_[0]->recurring_sql(). ' AND '.
4416 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
4421 Returns an SQL expression to give the package status as a string.
4427 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
4428 WHEN ( cust_pkg.susp IS NOT NULL AND cust_pkg.setup IS NULL ) THEN 'on hold'
4429 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
4430 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
4431 WHEN ".onetime_sql()." THEN 'one-time charge'
4438 Returns a list of two package counts. The first is a count of packages
4439 based on the supplied criteria and the second is the count of residential
4440 packages with those same criteria. Criteria are specified as in the search
4446 my ($class, $params) = @_;
4448 my $sql_query = $class->search( $params );
4450 my $count_sql = delete($sql_query->{'count_query'});
4451 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
4452 or die "couldn't parse count_sql";
4454 my $count_sth = dbh->prepare($count_sql)
4455 or die "Error preparing $count_sql: ". dbh->errstr;
4457 or die "Error executing $count_sql: ". $count_sth->errstr;
4458 my $count_arrayref = $count_sth->fetchrow_arrayref;
4460 return ( @$count_arrayref );
4464 =item tax_locationnum_sql
4466 Returns an SQL expression for the tax location for a package, based
4467 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
4471 sub tax_locationnum_sql {
4472 my $conf = FS::Conf->new;
4473 if ( $conf->exists('tax-pkg_address') ) {
4474 'cust_pkg.locationnum';
4476 elsif ( $conf->exists('tax-ship_address') ) {
4477 'cust_main.ship_locationnum';
4480 'cust_main.bill_locationnum';
4486 Returns a list: the first item is an SQL fragment identifying matching
4487 packages/customers via location (taking into account shipping and package
4488 address taxation, if enabled), and subsequent items are the parameters to
4489 substitute for the placeholders in that fragment.
4494 my($class, %opt) = @_;
4495 my $ornull = $opt{'ornull'};
4497 my $conf = new FS::Conf;
4499 # '?' placeholders in _location_sql_where
4500 my $x = $ornull ? 3 : 2;
4511 if ( $conf->exists('tax-ship_address') ) {
4514 ( ( ship_last IS NULL OR ship_last = '' )
4515 AND ". _location_sql_where('cust_main', '', $ornull ). "
4517 OR ( ship_last IS NOT NULL AND ship_last != ''
4518 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
4521 # AND payby != 'COMP'
4523 @main_param = ( @bill_param, @bill_param );
4527 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
4528 @main_param = @bill_param;
4534 if ( $conf->exists('tax-pkg_address') ) {
4536 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
4539 ( cust_pkg.locationnum IS NULL AND $main_where )
4540 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
4543 @param = ( @main_param, @bill_param );
4547 $where = $main_where;
4548 @param = @main_param;
4556 #subroutine, helper for location_sql
4557 sub _location_sql_where {
4559 my $prefix = @_ ? shift : '';
4560 my $ornull = @_ ? shift : '';
4562 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
4564 $ornull = $ornull ? ' OR ? IS NULL ' : '';
4566 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
4567 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
4568 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
4570 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
4572 # ( $table.${prefix}city = ? $or_empty_city $ornull )
4574 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4575 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4576 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
4577 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
4578 AND $table.${prefix}country = ?
4583 my( $self, $what ) = @_;
4585 my $what_show_zero = $what. '_show_zero';
4586 length($self->$what_show_zero())
4587 ? ($self->$what_show_zero() eq 'Y')
4588 : $self->part_pkg->$what_show_zero();
4595 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
4597 CUSTNUM is a customer (see L<FS::cust_main>)
4599 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4600 L<FS::part_pkg>) to order for this customer. Duplicates are of course
4603 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
4604 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
4605 new billing items. An error is returned if this is not possible (see
4606 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
4609 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4610 newly-created cust_pkg objects.
4612 REFNUM, if specified, will specify the FS::pkg_referral record to be created
4613 and inserted. Multiple FS::pkg_referral records can be created by
4614 setting I<refnum> to an array reference of refnums or a hash reference with
4615 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
4616 record will be created corresponding to cust_main.refnum.
4621 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
4623 my $conf = new FS::Conf;
4625 # Transactionize this whole mess
4626 my $oldAutoCommit = $FS::UID::AutoCommit;
4627 local $FS::UID::AutoCommit = 0;
4631 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
4632 # return "Customer not found: $custnum" unless $cust_main;
4634 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
4637 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4640 my $change = scalar(@old_cust_pkg) != 0;
4643 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
4645 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
4646 " to pkgpart ". $pkgparts->[0]. "\n"
4649 my $err_or_cust_pkg =
4650 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
4651 'refnum' => $refnum,
4654 unless (ref($err_or_cust_pkg)) {
4655 $dbh->rollback if $oldAutoCommit;
4656 return $err_or_cust_pkg;
4659 push @$return_cust_pkg, $err_or_cust_pkg;
4660 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4665 # Create the new packages.
4666 foreach my $pkgpart (@$pkgparts) {
4668 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
4670 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
4671 pkgpart => $pkgpart,
4675 $error = $cust_pkg->insert( 'change' => $change );
4676 push @$return_cust_pkg, $cust_pkg;
4678 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
4679 my $supp_pkg = FS::cust_pkg->new({
4680 custnum => $custnum,
4681 pkgpart => $link->dst_pkgpart,
4683 main_pkgnum => $cust_pkg->pkgnum,
4686 $error ||= $supp_pkg->insert( 'change' => $change );
4687 push @$return_cust_pkg, $supp_pkg;
4691 $dbh->rollback if $oldAutoCommit;
4696 # $return_cust_pkg now contains refs to all of the newly
4699 # Transfer services and cancel old packages.
4700 foreach my $old_pkg (@old_cust_pkg) {
4702 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
4705 foreach my $new_pkg (@$return_cust_pkg) {
4706 $error = $old_pkg->transfer($new_pkg);
4707 if ($error and $error == 0) {
4708 # $old_pkg->transfer failed.
4709 $dbh->rollback if $oldAutoCommit;
4714 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
4715 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
4716 foreach my $new_pkg (@$return_cust_pkg) {
4717 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
4718 if ($error and $error == 0) {
4719 # $old_pkg->transfer failed.
4720 $dbh->rollback if $oldAutoCommit;
4727 # Transfers were successful, but we went through all of the
4728 # new packages and still had services left on the old package.
4729 # We can't cancel the package under the circumstances, so abort.
4730 $dbh->rollback if $oldAutoCommit;
4731 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
4733 $error = $old_pkg->cancel( quiet=>1 );
4739 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4743 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
4745 A bulk change method to change packages for multiple customers.
4747 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4748 L<FS::part_pkg>) to order for each customer. Duplicates are of course
4751 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
4752 replace. The services (see L<FS::cust_svc>) are moved to the
4753 new billing items. An error is returned if this is not possible (see
4756 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4757 newly-created cust_pkg objects.
4762 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
4764 # Transactionize this whole mess
4765 my $oldAutoCommit = $FS::UID::AutoCommit;
4766 local $FS::UID::AutoCommit = 0;
4770 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4773 while(scalar(@old_cust_pkg)) {
4775 my $custnum = $old_cust_pkg[0]->custnum;
4776 my (@remove) = map { $_->pkgnum }
4777 grep { $_->custnum == $custnum } @old_cust_pkg;
4778 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
4780 my $error = order $custnum, $pkgparts, \@remove, \@return;
4782 push @errors, $error
4784 push @$return_cust_pkg, @return;
4787 if (scalar(@errors)) {
4788 $dbh->rollback if $oldAutoCommit;
4789 return join(' / ', @errors);
4792 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4796 # Used by FS::Upgrade to migrate to a new database.
4797 sub _upgrade_data { # class method
4798 my ($class, %opts) = @_;
4799 $class->_upgrade_otaker(%opts);
4801 # RT#10139, bug resulting in contract_end being set when it shouldn't
4802 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
4803 # RT#10830, bad calculation of prorate date near end of year
4804 # the date range for bill is December 2009, and we move it forward
4805 # one year if it's before the previous bill date (which it should
4807 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
4808 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
4809 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
4810 # RT6628, add order_date to cust_pkg
4811 'update cust_pkg set order_date = (select history_date from h_cust_pkg
4812 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
4813 history_action = \'insert\') where order_date is null',
4815 foreach my $sql (@statements) {
4816 my $sth = dbh->prepare($sql);
4817 $sth->execute or die $sth->errstr;
4820 # RT31194: supplemental package links that are deleted don't clean up
4822 my @pkglinknums = qsearch({
4823 'select' => 'DISTINCT cust_pkg.pkglinknum',
4824 'table' => 'cust_pkg',
4825 'addl_from' => ' LEFT JOIN part_pkg_link USING (pkglinknum) ',
4826 'extra_sql' => ' WHERE cust_pkg.pkglinknum IS NOT NULL
4827 AND part_pkg_link.pkglinknum IS NULL',
4829 foreach (@pkglinknums) {
4830 my $pkglinknum = $_->pkglinknum;
4831 warn "cleaning part_pkg_link #$pkglinknum\n";
4832 my $part_pkg_link = FS::part_pkg_link->new({pkglinknum => $pkglinknum});
4833 my $error = $part_pkg_link->remove_linked;
4834 die $error if $error;
4842 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
4844 In sub order, the @pkgparts array (passed by reference) is clobbered.
4846 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
4847 method to pass dates to the recur_prog expression, it should do so.
4849 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
4850 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
4851 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
4852 configuration values. Probably need a subroutine which decides what to do
4853 based on whether or not we've fetched the user yet, rather than a hash. See
4854 FS::UID and the TODO.
4856 Now that things are transactional should the check in the insert method be
4861 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
4862 L<FS::pkg_svc>, schema.html from the base documentation