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->config('invoice_from_name', $self->cust_main->agentnum) ?
951 $conf->config('invoice_from_name', $self->cust_main->agentnum) . ' <' .
952 $conf->config('invoice_from', $self->cust_main->agentnum) . '>' :
953 $conf->config('invoice_from', $self->cust_main->agentnum),
954 'to' => \@invoicing_list,
955 'subject' => ( $conf->config('cancelsubject') || 'Cancellation Notice' ),
956 'body' => [ map "$_\n", $conf->config('cancelmessage') ],
957 'custnum' => $self->custnum,
958 'msgtype' => '', #admin?
961 #should this do something on errors?
968 =item cancel_if_expired [ NOW_TIMESTAMP ]
970 Cancels this package if its expire date has been reached.
974 sub cancel_if_expired {
976 my $time = shift || time;
977 return '' unless $self->expire && $self->expire <= $time;
978 my $error = $self->cancel;
980 return "Error cancelling expired pkg ". $self->pkgnum. " for custnum ".
981 $self->custnum. ": $error";
988 "Un-cancels" this package: Orders a new package with the same custnum, pkgpart,
989 locationnum, (other fields?). Attempts to re-provision cancelled services
990 using history information (errors at this stage are not fatal).
992 cust_pkg: pass a scalar reference, will be filled in with the new cust_pkg object
994 svc_fatal: service provisioning errors are fatal
996 svc_errors: pass an array reference, will be filled in with any provisioning errors
998 main_pkgnum: link the package as a supplemental package of this one. For
1004 my( $self, %options ) = @_;
1006 #in case you try do do $uncancel-date = $cust_pkg->uncacel
1007 return '' unless $self->get('cancel');
1009 if ( $self->main_pkgnum and !$options{'main_pkgnum'} ) {
1010 return $self->main_pkg->uncancel(%options);
1017 my $oldAutoCommit = $FS::UID::AutoCommit;
1018 local $FS::UID::AutoCommit = 0;
1022 # insert the new package
1025 my $cust_pkg = new FS::cust_pkg {
1026 last_bill => ( $options{'last_bill'} || $self->get('last_bill') ),
1027 bill => ( $options{'bill'} || $self->get('bill') ),
1029 uncancel_pkgnum => $self->pkgnum,
1030 main_pkgnum => ($options{'main_pkgnum'} || ''),
1031 map { $_ => $self->get($_) } qw(
1032 custnum pkgpart locationnum
1034 susp adjourn resume expire start_date contract_end dundate
1035 change_date change_pkgpart change_locationnum
1036 manual_flag no_auto quantity agent_pkgid recur_show_zero setup_show_zero
1040 my $error = $cust_pkg->insert(
1041 'change' => 1, #supresses any referral credit to a referring customer
1042 'allow_pkgpart' => 1, # allow this even if the package def is disabled
1045 $dbh->rollback if $oldAutoCommit;
1053 #find historical services within this timeframe before the package cancel
1054 # (incompatible with "time" option to cust_pkg->cancel?)
1055 my $fuzz = 2 * 60; #2 minutes? too much? (might catch separate unprovision)
1056 # too little? (unprovisioing export delay?)
1057 my($end, $start) = ( $self->get('cancel'), $self->get('cancel') - $fuzz );
1058 my @h_cust_svc = $self->h_cust_svc( $end, $start );
1061 foreach my $h_cust_svc (@h_cust_svc) {
1062 my $h_svc_x = $h_cust_svc->h_svc_x( $end, $start );
1063 #next unless $h_svc_x; #should this happen?
1064 (my $table = $h_svc_x->table) =~ s/^h_//;
1065 require "FS/$table.pm";
1066 my $class = "FS::$table";
1067 my $svc_x = $class->new( {
1068 'pkgnum' => $cust_pkg->pkgnum,
1069 'svcpart' => $h_cust_svc->svcpart,
1070 map { $_ => $h_svc_x->get($_) } fields($table)
1074 if ( $h_svc_x->isa('FS::h_svc_Radius_Mixin') ) {
1075 $svc_x->usergroup( [ $h_svc_x->h_usergroup($end, $start) ] );
1078 my $svc_error = $svc_x->insert;
1080 if ( $options{svc_fatal} ) {
1081 $dbh->rollback if $oldAutoCommit;
1084 # if we've failed to insert the svc_x object, svc_Common->insert
1085 # will have removed the cust_svc already. if not, then both records
1086 # were inserted but we failed for some other reason (export, most
1087 # likely). in that case, report the error and delete the records.
1088 push @svc_errors, $svc_error;
1089 my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $svc_x->svcnum });
1091 # except if export_insert failed, export_delete probably won't be
1093 local $FS::svc_Common::noexport_hack = 1;
1094 my $cleanup_error = $svc_x->delete; # also deletes cust_svc
1095 if ( $cleanup_error ) { # and if THAT fails, then run away
1096 $dbh->rollback if $oldAutoCommit;
1097 return $cleanup_error;
1102 } #foreach $h_cust_svc
1104 #these are pretty rare, but should handle them
1105 # - dsl_device (mac addresses)
1106 # - phone_device (mac addresses)
1107 # - dsl_note (ikano notes)
1108 # - domain_record (i.e. restore DNS information w/domains)
1109 # - inventory_item(?) (inventory w/un-cancelling service?)
1110 # - nas (svc_broaband nas stuff)
1111 #this stuff is unused in the wild afaik
1112 # - mailinglistmember
1114 # - svc_domain.parent_svcnum?
1115 # - acct_snarf (ancient mail fetching config)
1116 # - cgp_rule (communigate)
1117 # - cust_svc_option (used by our Tron stuff)
1118 # - acct_rt_transaction (used by our time worked stuff)
1121 # also move over any services that didn't unprovision at cancellation
1124 foreach my $cust_svc ( qsearch('cust_svc', { pkgnum => $self->pkgnum } ) ) {
1125 $cust_svc->pkgnum( $cust_pkg->pkgnum );
1126 my $error = $cust_svc->replace;
1128 $dbh->rollback if $oldAutoCommit;
1134 # Uncancel any supplemental packages, and make them supplemental to the
1138 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1140 $error = $supp_pkg->uncancel(%options, 'main_pkgnum' => $cust_pkg->pkgnum);
1142 $dbh->rollback if $oldAutoCommit;
1143 return "canceling supplemental pkg#".$supp_pkg->pkgnum.": $error";
1151 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1153 ${ $options{cust_pkg} } = $cust_pkg if ref($options{cust_pkg});
1154 @{ $options{svc_errors} } = @svc_errors if ref($options{svc_errors});
1161 Cancels any pending expiration (sets the expire field to null).
1163 If there is an error, returns the error, otherwise returns false.
1168 my( $self, %options ) = @_;
1171 my $oldAutoCommit = $FS::UID::AutoCommit;
1172 local $FS::UID::AutoCommit = 0;
1175 my $old = $self->select_for_update;
1177 my $pkgnum = $old->pkgnum;
1178 if ( $old->get('cancel') || $self->get('cancel') ) {
1179 dbh->rollback if $oldAutoCommit;
1180 return "Can't unexpire cancelled package $pkgnum";
1181 # or at least it's pointless
1184 unless ( $old->get('expire') && $self->get('expire') ) {
1185 dbh->rollback if $oldAutoCommit;
1186 return ""; # no error
1189 my %hash = $self->hash;
1190 $hash{'expire'} = '';
1191 my $new = new FS::cust_pkg ( \%hash );
1192 $error = $new->replace( $self, options => { $self->options } );
1194 $dbh->rollback if $oldAutoCommit;
1198 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1204 =item suspend [ OPTION => VALUE ... ]
1206 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1207 package, then suspends the package itself (sets the susp field to now).
1209 Available options are:
1213 =item reason - can be set to a cancellation reason (see L<FS:reason>),
1214 either a reasonnum of an existing reason, or passing a hashref will create
1215 a new reason. The hashref should have the following keys:
1216 - typenum - Reason type (see L<FS::reason_type>
1217 - reason - Text of the new reason.
1219 =item date - can be set to a unix style timestamp to specify when to
1222 =item time - can be set to override the current time, for calculation
1223 of final invoices or unused-time credits
1225 =item resume_date - can be set to a time when the package should be
1226 unsuspended. This may be more convenient than calling C<unsuspend()>
1229 =item from_main - allows a supplemental package to be suspended, rather
1230 than redirecting the method call to its main package. For internal use.
1234 If there is an error, returns the error, otherwise returns false.
1239 my( $self, %options ) = @_;
1242 # pass all suspend/cancel actions to the main package
1243 if ( $self->main_pkgnum and !$options{'from_main'} ) {
1244 return $self->main_pkg->suspend(%options);
1247 my $oldAutoCommit = $FS::UID::AutoCommit;
1248 local $FS::UID::AutoCommit = 0;
1251 my $old = $self->select_for_update;
1253 my $pkgnum = $old->pkgnum;
1254 if ( $old->get('cancel') || $self->get('cancel') ) {
1255 dbh->rollback if $oldAutoCommit;
1256 return "Can't suspend cancelled package $pkgnum";
1259 if ( $old->get('susp') || $self->get('susp') ) {
1260 dbh->rollback if $oldAutoCommit;
1261 return ""; # no error # complain on adjourn?
1264 my $suspend_time = $options{'time'} || time;
1265 my $date = $options{date} if $options{date}; # adjourn/suspend later
1266 $date = '' if ($date && $date <= $suspend_time); # complain instead?
1268 if ( $date && $old->get('expire') && $old->get('expire') < $date ) {
1269 dbh->rollback if $oldAutoCommit;
1270 return "Package $pkgnum expires before it would be suspended.";
1273 # some false laziness with sub cancel
1274 if ( !$options{nobill} && !$date &&
1275 $self->part_pkg->option('bill_suspend_as_cancel',1) ) {
1276 # kind of a kludge--'bill_suspend_as_cancel' to avoid having to
1277 # make the entire cust_main->bill path recognize 'suspend' and
1278 # 'cancel' separately.
1279 warn "Billing $pkgnum on suspension (at $suspend_time)\n" if $DEBUG;
1280 my $copy = $self->new({$self->hash});
1282 $copy->cust_main->bill( 'pkg_list' => [ $copy ],
1284 'time' => $suspend_time );
1285 warn "Error billing during suspend, custnum ".
1286 #$self->cust_main->custnum. ": $error"
1291 if ( $options{'reason'} ) {
1292 $error = $self->insert_reason( 'reason' => $options{'reason'},
1293 'action' => $date ? 'adjourn' : 'suspend',
1294 'date' => $date ? $date : $suspend_time,
1295 'reason_otaker' => $options{'reason_otaker'},
1298 dbh->rollback if $oldAutoCommit;
1299 return "Error inserting cust_pkg_reason: $error";
1303 # if a reasonnum was passed, get the actual reason object so we can check
1305 # (passing a reason hashref is still allowed, but it can't be used with
1306 # the fancy behavioral options.)
1309 if ($options{'reason'} =~ /^\d+$/) {
1310 $reason = FS::reason->by_key($options{'reason'});
1313 my %hash = $self->hash;
1315 $hash{'adjourn'} = $date;
1317 $hash{'susp'} = $suspend_time;
1320 my $resume_date = $options{'resume_date'} || 0;
1321 if ( $resume_date > ($date || $suspend_time) ) {
1322 $hash{'resume'} = $resume_date;
1325 $options{options} ||= {};
1327 my $new = new FS::cust_pkg ( \%hash );
1328 $error = $new->replace( $self, options => { $self->options,
1329 %{ $options{options} },
1333 $dbh->rollback if $oldAutoCommit;
1337 unless ( $date ) { # then we are suspending now
1339 # credit remaining time if appropriate
1340 # (if required by the package def, or the suspend reason)
1341 my $unused_credit = $self->part_pkg->option('unused_credit_suspend',1)
1342 || ( defined($reason) && $reason->unused_credit );
1344 if ( $unused_credit ) {
1345 warn "crediting unused time on pkg#".$self->pkgnum."\n" if $DEBUG;
1346 my $error = $self->credit_remaining('suspend', $suspend_time);
1348 $dbh->rollback if $oldAutoCommit;
1355 foreach my $cust_svc (
1356 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
1358 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1360 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1361 $dbh->rollback if $oldAutoCommit;
1362 return "Illegal svcdb value in part_svc!";
1365 require "FS/$svcdb.pm";
1367 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1369 $error = $svc->suspend;
1371 $dbh->rollback if $oldAutoCommit;
1374 my( $label, $value ) = $cust_svc->label;
1375 push @labels, "$label: $value";
1379 my $conf = new FS::Conf;
1380 if ( $conf->config('suspend_email_admin') ) {
1382 my $error = send_email(
1383 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1384 #invoice_from ??? well as good as any
1385 'to' => $conf->config('suspend_email_admin'),
1386 'subject' => 'FREESIDE NOTIFICATION: Customer package suspended',
1388 "This is an automatic message from your Freeside installation\n",
1389 "informing you that the following customer package has been suspended:\n",
1391 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1392 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1393 ( map { "Service : $_\n" } @labels ),
1395 'custnum' => $self->custnum,
1396 'msgtype' => 'admin'
1400 warn "WARNING: can't send suspension admin email (suspending anyway): ".
1408 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1409 $error = $supp_pkg->suspend(%options, 'from_main' => 1);
1411 $dbh->rollback if $oldAutoCommit;
1412 return "suspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1416 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1421 =item credit_remaining MODE TIME
1423 Generate a credit for this package for the time remaining in the current
1424 billing period. MODE is either "suspend" or "cancel" (determines the
1425 credit type). TIME is the time of suspension/cancellation. Both arguments
1430 # Implementation note:
1432 # If you pkgpart-change a package that has been billed, and it's set to give
1433 # credit on package change, then this method gets called and then the new
1434 # package will have no last_bill date. Therefore the customer will be credited
1435 # only once (per billing period) even if there are multiple package changes.
1437 # If you location-change a package that has been billed, this method will NOT
1438 # be called and the new package WILL have the last bill date of the old
1441 # If the new package is then canceled within the same billing cycle,
1442 # credit_remaining needs to run calc_remain on the OLD package to determine
1443 # the amount of unused time to credit.
1445 sub credit_remaining {
1446 # Add a credit for remaining service
1447 my ($self, $mode, $time) = @_;
1448 die 'credit_remaining requires suspend or cancel'
1449 unless $mode eq 'suspend' or $mode eq 'cancel';
1450 die 'no suspend/cancel time' unless $time > 0;
1452 my $conf = FS::Conf->new;
1453 my $reason_type = $conf->config($mode.'_credit_type');
1455 my $last_bill = $self->getfield('last_bill') || 0;
1456 my $next_bill = $self->getfield('bill') || 0;
1457 if ( $last_bill > 0 # the package has been billed
1458 and $next_bill > 0 # the package has a next bill date
1459 and $next_bill >= $time # which is in the future
1461 my @cust_credit_source_bill_pkg = ();
1462 my $remaining_value = 0;
1464 my $remain_pkg = $self;
1465 $remaining_value = $remain_pkg->calc_remain(
1467 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1470 # we may have to walk back past some package changes to get to the
1471 # one that actually has unused time
1472 while ( $remaining_value == 0 ) {
1473 if ( $remain_pkg->change_pkgnum ) {
1474 $remain_pkg = FS::cust_pkg->by_key($remain_pkg->change_pkgnum);
1476 # the package has really never been billed
1479 $remaining_value = $remain_pkg->calc_remain(
1481 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1485 if ( $remaining_value > 0 ) {
1486 warn "Crediting for $remaining_value on package ".$self->pkgnum."\n"
1488 my $error = $self->cust_main->credit(
1490 'Credit for unused time on '. $self->part_pkg->pkg,
1491 'reason_type' => $reason_type,
1492 'cust_credit_source_bill_pkg' => \@cust_credit_source_bill_pkg,
1494 return "Error crediting customer \$$remaining_value for unused time".
1495 " on ". $self->part_pkg->pkg. ": $error"
1497 } #if $remaining_value
1498 } #if $last_bill, etc.
1502 =item unsuspend [ OPTION => VALUE ... ]
1504 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
1505 package, then unsuspends the package itself (clears the susp field and the
1506 adjourn field if it is in the past). If the suspend reason includes an
1507 unsuspension package, that package will be ordered.
1509 Available options are:
1515 Can be set to a date to unsuspend the package in the future (the 'resume'
1518 =item adjust_next_bill
1520 Can be set true to adjust the next bill date forward by
1521 the amount of time the account was inactive. This was set true by default
1522 in the past (from 1.4.2 and 1.5.0pre6 through 1.7.0), but now needs to be
1523 explicitly requested with this option or in the price plan.
1527 If there is an error, returns the error, otherwise returns false.
1532 my( $self, %opt ) = @_;
1535 # pass all suspend/cancel actions to the main package
1536 if ( $self->main_pkgnum and !$opt{'from_main'} ) {
1537 return $self->main_pkg->unsuspend(%opt);
1540 my $oldAutoCommit = $FS::UID::AutoCommit;
1541 local $FS::UID::AutoCommit = 0;
1544 my $old = $self->select_for_update;
1546 my $pkgnum = $old->pkgnum;
1547 if ( $old->get('cancel') || $self->get('cancel') ) {
1548 $dbh->rollback if $oldAutoCommit;
1549 return "Can't unsuspend cancelled package $pkgnum";
1552 unless ( $old->get('susp') && $self->get('susp') ) {
1553 $dbh->rollback if $oldAutoCommit;
1554 return ""; # no error # complain instead?
1557 # handle the case of setting a future unsuspend (resume) date
1558 # and do not continue to actually unsuspend the package
1559 my $date = $opt{'date'};
1560 if ( $date and $date > time ) { # return an error if $date <= time?
1562 if ( $old->get('expire') && $old->get('expire') < $date ) {
1563 $dbh->rollback if $oldAutoCommit;
1564 return "Package $pkgnum expires before it would be unsuspended.";
1567 my $new = new FS::cust_pkg { $self->hash };
1568 $new->set('resume', $date);
1569 $error = $new->replace($self, options => $self->options);
1572 $dbh->rollback if $oldAutoCommit;
1576 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1582 if (!$self->setup) {
1583 # then this package is being released from on-hold status
1584 $self->set_initial_timers;
1589 foreach my $cust_svc (
1590 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
1592 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
1594 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
1595 $dbh->rollback if $oldAutoCommit;
1596 return "Illegal svcdb value in part_svc!";
1599 require "FS/$svcdb.pm";
1601 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
1603 $error = $svc->unsuspend;
1605 $dbh->rollback if $oldAutoCommit;
1608 my( $label, $value ) = $cust_svc->label;
1609 push @labels, "$label: $value";
1614 my $cust_pkg_reason = $self->last_cust_pkg_reason('susp');
1615 my $reason = $cust_pkg_reason ? $cust_pkg_reason->reason : '';
1617 my %hash = $self->hash;
1618 my $inactive = time - $hash{'susp'};
1620 my $conf = new FS::Conf;
1622 #adjust the next bill date forward
1623 # increment next bill date if certain conditions are met:
1624 # - it was due to be billed at some point
1625 # - either the global or local config says to do this
1626 my $adjust_bill = 0;
1629 && ( $hash{'bill'} || $hash{'setup'} )
1630 && ( $opt{'adjust_next_bill'}
1631 || $conf->exists('unsuspend-always_adjust_next_bill_date')
1632 || $self->part_pkg->option('unsuspend_adjust_bill', 1)
1639 # - the package billed during suspension
1640 # - or it was ordered on hold
1641 # - or the customer was credited for the unused time
1643 if ( $self->option('suspend_bill',1)
1644 or ( $self->part_pkg->option('suspend_bill',1)
1645 and ! $self->option('no_suspend_bill',1)
1647 or $hash{'order_date'} == $hash{'susp'}
1648 or $self->part_pkg->option('unused_credit_suspend')
1649 or ( defined($reason) and $reason->unused_credit )
1654 # then add the length of time suspended to the bill date
1655 if ( $adjust_bill ) {
1656 $hash{'bill'} = ( $hash{'bill'} || $hash{'setup'} ) + $inactive
1660 $hash{'adjourn'} = '' if $hash{'adjourn'} and $hash{'adjourn'} < time;
1661 $hash{'resume'} = '' if !$hash{'adjourn'};
1662 my $new = new FS::cust_pkg ( \%hash );
1663 $error = $new->replace( $self, options => { $self->options } );
1665 $dbh->rollback if $oldAutoCommit;
1671 if ( $reason && $reason->unsuspend_pkgpart ) {
1672 my $part_pkg = FS::part_pkg->by_key($reason->unsuspend_pkgpart)
1673 or $error = "Unsuspend package definition ".$reason->unsuspend_pkgpart.
1675 my $start_date = $self->cust_main->next_bill_date
1676 if $reason->unsuspend_hold;
1679 $unsusp_pkg = FS::cust_pkg->new({
1680 'custnum' => $self->custnum,
1681 'pkgpart' => $reason->unsuspend_pkgpart,
1682 'start_date' => $start_date,
1683 'locationnum' => $self->locationnum,
1684 # discount? probably not...
1687 $error ||= $self->cust_main->order_pkg( 'cust_pkg' => $unsusp_pkg );
1691 $dbh->rollback if $oldAutoCommit;
1696 if ( $conf->config('unsuspend_email_admin') ) {
1698 my $error = send_email(
1699 'from' => $conf->config('invoice_from', $self->cust_main->agentnum),
1700 #invoice_from ??? well as good as any
1701 'to' => $conf->config('unsuspend_email_admin'),
1702 'subject' => 'FREESIDE NOTIFICATION: Customer package unsuspended', 'body' => [
1703 "This is an automatic message from your Freeside installation\n",
1704 "informing you that the following customer package has been unsuspended:\n",
1706 'Customer: #'. $self->custnum. ' '. $self->cust_main->name. "\n",
1707 'Package : #'. $self->pkgnum. " (". $self->part_pkg->pkg_comment. ")\n",
1708 ( map { "Service : $_\n" } @labels ),
1710 "An unsuspension fee was charged: ".
1711 $unsusp_pkg->part_pkg->pkg_comment."\n"
1715 'custnum' => $self->custnum,
1716 'msgtype' => 'admin',
1720 warn "WARNING: can't send unsuspension admin email (unsuspending anyway): ".
1726 foreach my $supp_pkg ( $self->supplemental_pkgs ) {
1727 $error = $supp_pkg->unsuspend(%opt, 'from_main' => 1);
1729 $dbh->rollback if $oldAutoCommit;
1730 return "unsuspending supplemental pkg#".$supp_pkg->pkgnum.": $error";
1734 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1741 Cancels any pending suspension (sets the adjourn field to null).
1743 If there is an error, returns the error, otherwise returns false.
1748 my( $self, %options ) = @_;
1751 my $oldAutoCommit = $FS::UID::AutoCommit;
1752 local $FS::UID::AutoCommit = 0;
1755 my $old = $self->select_for_update;
1757 my $pkgnum = $old->pkgnum;
1758 if ( $old->get('cancel') || $self->get('cancel') ) {
1759 dbh->rollback if $oldAutoCommit;
1760 return "Can't unadjourn cancelled package $pkgnum";
1761 # or at least it's pointless
1764 if ( $old->get('susp') || $self->get('susp') ) {
1765 dbh->rollback if $oldAutoCommit;
1766 return "Can't unadjourn suspended package $pkgnum";
1767 # perhaps this is arbitrary
1770 unless ( $old->get('adjourn') && $self->get('adjourn') ) {
1771 dbh->rollback if $oldAutoCommit;
1772 return ""; # no error
1775 my %hash = $self->hash;
1776 $hash{'adjourn'} = '';
1777 $hash{'resume'} = '';
1778 my $new = new FS::cust_pkg ( \%hash );
1779 $error = $new->replace( $self, options => { $self->options } );
1781 $dbh->rollback if $oldAutoCommit;
1785 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1792 =item change HASHREF | OPTION => VALUE ...
1794 Changes this package: cancels it and creates a new one, with a different
1795 pkgpart or locationnum or both. All services are transferred to the new
1796 package (no change will be made if this is not possible).
1798 Options may be passed as a list of key/value pairs or as a hash reference.
1805 New locationnum, to change the location for this package.
1809 New FS::cust_location object, to create a new location and assign it
1814 New FS::cust_main object, to create a new customer and assign the new package
1819 New pkgpart (see L<FS::part_pkg>).
1823 New refnum (see L<FS::part_referral>).
1827 New quantity; if unspecified, the new package will have the same quantity
1832 "New" (existing) FS::cust_pkg object. The package's services and other
1833 attributes will be transferred to this package.
1837 Set to true to transfer billing dates (start_date, setup, last_bill, bill,
1838 susp, adjourn, cancel, expire, and contract_end) to the new package.
1840 =item unprotect_svcs
1842 Normally, change() will rollback and return an error if some services
1843 can't be transferred (also see the I<cust_pkg-change_svcpart> config option).
1844 If unprotect_svcs is true, this method will transfer as many services as
1845 it can and then unconditionally cancel the old package.
1849 At least one of locationnum, cust_location, pkgpart, refnum, cust_main, or
1850 cust_pkg must be specified (otherwise, what's the point?)
1852 Returns either the new FS::cust_pkg object or a scalar error.
1856 my $err_or_new_cust_pkg = $old_cust_pkg->change
1860 #some false laziness w/order
1863 my $opt = ref($_[0]) ? shift : { @_ };
1865 my $conf = new FS::Conf;
1867 # Transactionize this whole mess
1868 my $oldAutoCommit = $FS::UID::AutoCommit;
1869 local $FS::UID::AutoCommit = 0;
1878 $hash{'setup'} = $time if $self->setup;
1880 $hash{'change_date'} = $time;
1881 $hash{"change_$_"} = $self->$_()
1882 foreach qw( pkgnum pkgpart locationnum );
1884 if ( $opt->{'cust_location'} ) {
1885 $error = $opt->{'cust_location'}->find_or_insert;
1887 $dbh->rollback if $oldAutoCommit;
1888 return "creating location record: $error";
1890 $opt->{'locationnum'} = $opt->{'cust_location'}->locationnum;
1893 if ( $opt->{'cust_pkg'} ) {
1894 # treat changing to a package with a different pkgpart as a
1895 # pkgpart change (because it is)
1896 $opt->{'pkgpart'} = $opt->{'cust_pkg'}->pkgpart;
1899 # whether to override pkgpart checking on the new package
1900 my $same_pkgpart = 1;
1901 if ( $opt->{'pkgpart'} and ( $opt->{'pkgpart'} != $self->pkgpart ) ) {
1905 my $unused_credit = 0;
1906 my $keep_dates = $opt->{'keep_dates'};
1907 # Special case. If the pkgpart is changing, and the customer is
1908 # going to be credited for remaining time, don't keep setup, bill,
1909 # or last_bill dates, and DO pass the flag to cancel() to credit
1911 if ( $opt->{'pkgpart'}
1912 and $opt->{'pkgpart'} != $self->pkgpart
1913 and $self->part_pkg->option('unused_credit_change', 1) ) {
1916 $hash{$_} = '' foreach qw(setup bill last_bill);
1919 if ( $keep_dates ) {
1920 foreach my $date ( qw(setup bill last_bill susp adjourn cancel expire
1921 resume start_date contract_end ) ) {
1922 $hash{$date} = $self->getfield($date);
1925 # always keep this date, regardless of anything
1926 # (the date of the package change is in a different field)
1927 $hash{'order_date'} = $self->getfield('order_date');
1929 # allow $opt->{'locationnum'} = '' to specifically set it to null
1930 # (i.e. customer default location)
1931 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
1933 # usually this doesn't matter. the two cases where it does are:
1934 # 1. unused_credit_change + pkgpart change + setup fee on the new package
1936 # 2. (more importantly) changing a package before it's billed
1937 $hash{'waive_setup'} = $self->waive_setup;
1939 my $custnum = $self->custnum;
1940 if ( $opt->{cust_main} ) {
1941 my $cust_main = $opt->{cust_main};
1942 unless ( $cust_main->custnum ) {
1943 my $error = $cust_main->insert( @{ $opt->{cust_main_insert_args}||[] } );
1945 $dbh->rollback if $oldAutoCommit;
1946 return "inserting customer record: $error";
1949 $custnum = $cust_main->custnum;
1952 $hash{'contactnum'} = $opt->{'contactnum'} if $opt->{'contactnum'};
1955 if ( $opt->{'cust_pkg'} ) {
1956 # The target package already exists; update it to show that it was
1957 # changed from this package.
1958 $cust_pkg = $opt->{'cust_pkg'};
1960 foreach ( qw( pkgnum pkgpart locationnum ) ) {
1961 $cust_pkg->set("change_$_", $self->get($_));
1963 $cust_pkg->set('change_date', $time);
1964 $error = $cust_pkg->replace;
1967 # Create the new package.
1968 $cust_pkg = new FS::cust_pkg {
1969 custnum => $custnum,
1970 locationnum => $opt->{'locationnum'},
1971 ( map { $_ => ( $opt->{$_} || $self->$_() ) }
1972 qw( pkgpart quantity refnum salesnum )
1976 $error = $cust_pkg->insert( 'change' => 1,
1977 'allow_pkgpart' => $same_pkgpart );
1980 $dbh->rollback if $oldAutoCommit;
1981 return "inserting new package: $error";
1984 # Transfer services and cancel old package.
1986 $error = $self->transfer($cust_pkg);
1987 if ($error and $error == 0) {
1988 # $old_pkg->transfer failed.
1989 $dbh->rollback if $oldAutoCommit;
1990 return "transferring $error";
1993 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
1994 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
1995 $error = $self->transfer($cust_pkg, 'change_svcpart'=>1 );
1996 if ($error and $error == 0) {
1997 # $old_pkg->transfer failed.
1998 $dbh->rollback if $oldAutoCommit;
1999 return "converting $error";
2003 # We set unprotect_svcs when executing a "future package change". It's
2004 # not a user-interactive operation, so returning an error means the
2005 # package change will just fail. Rather than have that happen, we'll
2006 # let leftover services be deleted.
2007 if ($error > 0 and !$opt->{'unprotect_svcs'}) {
2008 # Transfers were successful, but we still had services left on the old
2009 # package. We can't change the package under this circumstances, so abort.
2010 $dbh->rollback if $oldAutoCommit;
2011 return "unable to transfer all services";
2014 #reset usage if changing pkgpart
2015 # AND usage rollover is off (otherwise adds twice, now and at package bill)
2016 if ($self->pkgpart != $cust_pkg->pkgpart) {
2017 my $part_pkg = $cust_pkg->part_pkg;
2018 $error = $part_pkg->reset_usage($cust_pkg, $part_pkg->is_prepaid
2022 if $part_pkg->can('reset_usage') && ! $part_pkg->option('usage_rollover',1);
2025 $dbh->rollback if $oldAutoCommit;
2026 return "setting usage values: $error";
2029 # if NOT changing pkgpart, transfer any usage pools over
2030 foreach my $usage ($self->cust_pkg_usage) {
2031 $usage->set('pkgnum', $cust_pkg->pkgnum);
2032 $error = $usage->replace;
2034 $dbh->rollback if $oldAutoCommit;
2035 return "transferring usage pools: $error";
2040 # transfer usage pricing add-ons, if we're not changing pkgpart
2041 if ( $same_pkgpart ) {
2042 foreach my $old_cust_pkg_usageprice ($self->cust_pkg_usageprice) {
2043 my $new_cust_pkg_usageprice = new FS::cust_pkg_usageprice {
2044 'pkgnum' => $cust_pkg->pkgnum,
2045 'usagepricepart' => $old_cust_pkg_usageprice->usagepricepart,
2046 'quantity' => $old_cust_pkg_usageprice->quantity,
2048 $error = $new_cust_pkg_usageprice->insert;
2050 $dbh->rollback if $oldAutoCommit;
2051 return "Error transferring usage pricing add-on: $error";
2056 # transfer discounts, if we're not changing pkgpart
2057 if ( $same_pkgpart ) {
2058 foreach my $old_discount ($self->cust_pkg_discount_active) {
2059 # don't remove the old discount, we may still need to bill that package.
2060 my $new_discount = new FS::cust_pkg_discount {
2061 'pkgnum' => $cust_pkg->pkgnum,
2062 'discountnum' => $old_discount->discountnum,
2063 'months_used' => $old_discount->months_used,
2065 $error = $new_discount->insert;
2067 $dbh->rollback if $oldAutoCommit;
2068 return "transferring discounts: $error";
2073 # transfer (copy) invoice details
2074 foreach my $detail ($self->cust_pkg_detail) {
2075 my $new_detail = FS::cust_pkg_detail->new({ $detail->hash });
2076 $new_detail->set('pkgdetailnum', '');
2077 $new_detail->set('pkgnum', $cust_pkg->pkgnum);
2078 $error = $new_detail->insert;
2080 $dbh->rollback if $oldAutoCommit;
2081 return "transferring package notes: $error";
2087 if ( !$opt->{'cust_pkg'} ) {
2088 # Order any supplemental packages.
2089 my $part_pkg = $cust_pkg->part_pkg;
2090 my @old_supp_pkgs = $self->supplemental_pkgs;
2091 foreach my $link ($part_pkg->supp_part_pkg_link) {
2093 foreach (@old_supp_pkgs) {
2094 if ($_->pkgpart == $link->dst_pkgpart) {
2096 $_->pkgpart(0); # so that it can't match more than once
2100 # false laziness with FS::cust_main::Packages::order_pkg
2101 my $new = FS::cust_pkg->new({
2102 pkgpart => $link->dst_pkgpart,
2103 pkglinknum => $link->pkglinknum,
2104 custnum => $custnum,
2105 main_pkgnum => $cust_pkg->pkgnum,
2106 locationnum => $cust_pkg->locationnum,
2107 start_date => $cust_pkg->start_date,
2108 order_date => $cust_pkg->order_date,
2109 expire => $cust_pkg->expire,
2110 adjourn => $cust_pkg->adjourn,
2111 contract_end => $cust_pkg->contract_end,
2112 refnum => $cust_pkg->refnum,
2113 discountnum => $cust_pkg->discountnum,
2114 waive_setup => $cust_pkg->waive_setup,
2116 if ( $old and $opt->{'keep_dates'} ) {
2117 foreach (qw(setup bill last_bill)) {
2118 $new->set($_, $old->get($_));
2121 $error = $new->insert( allow_pkgpart => $same_pkgpart );
2124 $error ||= $old->transfer($new);
2126 if ( $error and $error > 0 ) {
2127 # no reason why this should ever fail, but still...
2128 $error = "Unable to transfer all services from supplemental package ".
2132 $dbh->rollback if $oldAutoCommit;
2135 push @new_supp_pkgs, $new;
2137 } # if !$opt->{'cust_pkg'}
2138 # because if there is one, then supplemental packages would already
2139 # have been created for it.
2141 #Good to go, cancel old package. Notify 'cancel' of whether to credit
2143 #Don't allow billing the package (preceding period packages and/or
2144 #outstanding usage) if we are keeping dates (i.e. location changing),
2145 #because the new package will be billed for the same date range.
2146 #Supplemental packages are also canceled here.
2148 # during scheduled changes, avoid canceling the package we just
2150 $self->set('change_to_pkgnum' => '');
2152 $error = $self->cancel(
2154 unused_credit => $unused_credit,
2155 nobill => $keep_dates,
2156 change_custnum => ( $self->custnum != $custnum ? $custnum : '' ),
2159 $dbh->rollback if $oldAutoCommit;
2160 return "canceling old package: $error";
2163 if ( $conf->exists('cust_pkg-change_pkgpart-bill_now') ) {
2165 my $error = $cust_pkg->cust_main->bill(
2166 'pkg_list' => [ $cust_pkg, @new_supp_pkgs ]
2169 $dbh->rollback if $oldAutoCommit;
2170 return "billing new package: $error";
2174 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2180 =item change_later OPTION => VALUE...
2182 Schedule a package change for a later date. This actually orders the new
2183 package immediately, but sets its start date for a future date, and sets
2184 the current package to expire on the same date.
2186 If the package is already scheduled for a change, this can be called with
2187 'start_date' to change the scheduled date, or with pkgpart and/or
2188 locationnum to modify the package change. To cancel the scheduled change
2189 entirely, see C<abort_change>.
2197 The date for the package change. Required, and must be in the future.
2205 The pkgpart. locationnum, and quantity of the new package, with the same
2206 meaning as in C<change>.
2214 my $opt = ref($_[0]) ? shift : { @_ };
2216 my $oldAutoCommit = $FS::UID::AutoCommit;
2217 local $FS::UID::AutoCommit = 0;
2220 my $cust_main = $self->cust_main;
2222 my $date = delete $opt->{'start_date'} or return 'start_date required';
2224 if ( $date <= time ) {
2225 $dbh->rollback if $oldAutoCommit;
2226 return "start_date $date is in the past";
2231 if ( $self->change_to_pkgnum ) {
2232 my $change_to = FS::cust_pkg->by_key($self->change_to_pkgnum);
2233 my $new_pkgpart = $opt->{'pkgpart'}
2234 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $change_to->pkgpart;
2235 my $new_locationnum = $opt->{'locationnum'}
2236 if $opt->{'locationnum'} and $opt->{'locationnum'} != $change_to->locationnum;
2237 my $new_quantity = $opt->{'quantity'}
2238 if $opt->{'quantity'} and $opt->{'quantity'} != $change_to->quantity;
2239 if ( $new_pkgpart or $new_locationnum or $new_quantity ) {
2240 # it hasn't been billed yet, so in principle we could just edit
2241 # it in place (w/o a package change), but that's bad form.
2242 # So change the package according to the new options...
2243 my $err_or_pkg = $change_to->change(%$opt);
2244 if ( ref $err_or_pkg ) {
2245 # Then set that package up for a future start.
2246 $self->set('change_to_pkgnum', $err_or_pkg->pkgnum);
2247 $self->set('expire', $date); # in case it's different
2248 $err_or_pkg->set('start_date', $date);
2249 $err_or_pkg->set('change_date', '');
2250 $err_or_pkg->set('change_pkgnum', '');
2252 $error = $self->replace ||
2253 $err_or_pkg->replace ||
2254 $change_to->cancel ||
2257 $error = $err_or_pkg;
2259 } else { # change the start date only.
2260 $self->set('expire', $date);
2261 $change_to->set('start_date', $date);
2262 $error = $self->replace || $change_to->replace;
2265 $dbh->rollback if $oldAutoCommit;
2268 $dbh->commit if $oldAutoCommit;
2271 } # if $self->change_to_pkgnum
2273 my $new_pkgpart = $opt->{'pkgpart'}
2274 if $opt->{'pkgpart'} and $opt->{'pkgpart'} != $self->pkgpart;
2275 my $new_locationnum = $opt->{'locationnum'}
2276 if $opt->{'locationnum'} and $opt->{'locationnum'} != $self->locationnum;
2277 my $new_quantity = $opt->{'quantity'}
2278 if $opt->{'quantity'} and $opt->{'quantity'} != $self->quantity;
2280 return '' unless $new_pkgpart or $new_locationnum or $new_quantity; # wouldn't do anything
2282 # allow $opt->{'locationnum'} = '' to specifically set it to null
2283 # (i.e. customer default location)
2284 $opt->{'locationnum'} = $self->locationnum if !exists($opt->{'locationnum'});
2286 my $new = FS::cust_pkg->new( {
2287 custnum => $self->custnum,
2288 locationnum => $opt->{'locationnum'},
2289 start_date => $date,
2290 map { $_ => ( $opt->{$_} || $self->$_() ) }
2291 qw( pkgpart quantity refnum salesnum )
2293 $error = $new->insert('change' => 1,
2294 'allow_pkgpart' => ($new_pkgpart ? 0 : 1));
2296 $self->set('change_to_pkgnum', $new->pkgnum);
2297 $self->set('expire', $date);
2298 $error = $self->replace;
2301 $dbh->rollback if $oldAutoCommit;
2303 $dbh->commit if $oldAutoCommit;
2311 Cancels a future package change scheduled by C<change_later>.
2317 my $pkgnum = $self->change_to_pkgnum;
2318 my $change_to = FS::cust_pkg->by_key($pkgnum) if $pkgnum;
2321 $error = $change_to->cancel || $change_to->delete;
2322 return $error if $error;
2324 $self->set('change_to_pkgnum', '');
2325 $self->set('expire', '');
2329 =item set_quantity QUANTITY
2331 Change the package's quantity field. This is one of the few package properties
2332 that can safely be changed without canceling and reordering the package
2333 (because it doesn't affect tax eligibility). Returns an error or an
2340 $self = $self->replace_old; # just to make sure
2341 $self->quantity(shift);
2345 =item set_salesnum SALESNUM
2347 Change the package's salesnum (sales person) field. This is one of the few
2348 package properties that can safely be changed without canceling and reordering
2349 the package (because it doesn't affect tax eligibility). Returns an error or
2356 $self = $self->replace_old; # just to make sure
2357 $self->salesnum(shift);
2359 # XXX this should probably reassign any credit that's already been given
2362 =item modify_charge OPTIONS
2364 Change the properties of a one-time charge. The following properties can
2365 be changed this way:
2366 - pkg: the package description
2367 - classnum: the package class
2368 - additional: arrayref of additional invoice details to add to this package
2370 and, I<if the charge has not yet been billed>:
2371 - start_date: the date when it will be billed
2372 - amount: the setup fee to be charged
2373 - quantity: the multiplier for the setup fee
2375 If you pass 'adjust_commission' => 1, and the classnum changes, and there are
2376 commission credits linked to this charge, they will be recalculated.
2383 my $part_pkg = $self->part_pkg;
2384 my $pkgnum = $self->pkgnum;
2387 my $oldAutoCommit = $FS::UID::AutoCommit;
2388 local $FS::UID::AutoCommit = 0;
2390 return "Can't use modify_charge except on one-time charges"
2391 unless $part_pkg->freq eq '0';
2393 if ( length($opt{'pkg'}) and $part_pkg->pkg ne $opt{'pkg'} ) {
2394 $part_pkg->set('pkg', $opt{'pkg'});
2397 my %pkg_opt = $part_pkg->options;
2398 my $pkg_opt_modified = 0;
2400 $opt{'additional'} ||= [];
2403 foreach (grep /^additional/, keys %pkg_opt) {
2404 ($i) = ($_ =~ /^additional_info(\d+)$/);
2405 $old_additional[$i] = $pkg_opt{$_} if $i;
2406 delete $pkg_opt{$_};
2409 for ( $i = 0; exists($opt{'additional'}->[$i]); $i++ ) {
2410 $pkg_opt{ "additional_info$i" } = $opt{'additional'}->[$i];
2411 if (!exists($old_additional[$i])
2412 or $old_additional[$i] ne $opt{'additional'}->[$i])
2414 $pkg_opt_modified = 1;
2417 $pkg_opt_modified = 1 if (scalar(@old_additional) - 1) != $i;
2418 $pkg_opt{'additional_count'} = $i if $i > 0;
2421 if ( exists($opt{'classnum'}) and $part_pkg->classnum ne $opt{'classnum'} )
2424 $old_classnum = $part_pkg->classnum;
2425 $part_pkg->set('classnum', $opt{'classnum'});
2428 if ( !$self->get('setup') ) {
2429 # not yet billed, so allow amount, setup_cost, quantity and start_date
2431 if ( exists($opt{'amount'})
2432 and $part_pkg->option('setup_fee') != $opt{'amount'}
2433 and $opt{'amount'} > 0 ) {
2435 $pkg_opt{'setup_fee'} = $opt{'amount'};
2436 $pkg_opt_modified = 1;
2439 if ( exists($opt{'setup_cost'})
2440 and $part_pkg->setup_cost != $opt{'setup_cost'}
2441 and $opt{'setup_cost'} > 0 ) {
2443 $part_pkg->set('setup_cost', $opt{'setup_cost'});
2446 if ( exists($opt{'quantity'})
2447 and $opt{'quantity'} != $self->quantity
2448 and $opt{'quantity'} > 0 ) {
2450 $self->set('quantity', $opt{'quantity'});
2453 if ( exists($opt{'start_date'})
2454 and $opt{'start_date'} != $self->start_date ) {
2456 $self->set('start_date', $opt{'start_date'});
2460 } # else simply ignore them; the UI shouldn't allow editing the fields
2463 if ( $part_pkg->modified or $pkg_opt_modified ) {
2464 # can we safely modify the package def?
2465 # Yes, if it's not available for purchase, and this is the only instance
2467 if ( $part_pkg->disabled
2468 and FS::cust_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 1
2469 and FS::quotation_pkg->count('pkgpart = '.$part_pkg->pkgpart) == 0
2471 $error = $part_pkg->replace( options => \%pkg_opt );
2474 $part_pkg = $part_pkg->clone;
2475 $part_pkg->set('disabled' => 'Y');
2476 $error = $part_pkg->insert( options => \%pkg_opt );
2477 # and associate this as yet-unbilled package to the new package def
2478 $self->set('pkgpart' => $part_pkg->pkgpart);
2481 $dbh->rollback if $oldAutoCommit;
2486 if ($self->modified) { # for quantity or start_date change, or if we had
2487 # to clone the existing package def
2488 my $error = $self->replace;
2489 return $error if $error;
2491 if (defined $old_classnum) {
2492 # fix invoice grouping records
2493 my $old_catname = $old_classnum
2494 ? FS::pkg_class->by_key($old_classnum)->categoryname
2496 my $new_catname = $opt{'classnum'}
2497 ? $part_pkg->pkg_class->categoryname
2499 if ( $old_catname ne $new_catname ) {
2500 foreach my $cust_bill_pkg ($self->cust_bill_pkg) {
2501 # (there should only be one...)
2502 my @display = qsearch( 'cust_bill_pkg_display', {
2503 'billpkgnum' => $cust_bill_pkg->billpkgnum,
2504 'section' => $old_catname,
2506 foreach (@display) {
2507 $_->set('section', $new_catname);
2508 $error = $_->replace;
2510 $dbh->rollback if $oldAutoCommit;
2514 } # foreach $cust_bill_pkg
2517 if ( $opt{'adjust_commission'} ) {
2518 # fix commission credits...tricky.
2519 foreach my $cust_event ($self->cust_event) {
2520 my $part_event = $cust_event->part_event;
2521 foreach my $table (qw(sales agent)) {
2523 "FS::part_event::Action::Mixin::credit_${table}_pkg_class";
2524 my $credit = qsearchs('cust_credit', {
2525 'eventnum' => $cust_event->eventnum,
2527 if ( $part_event->isa($class) ) {
2528 # Yes, this results in current commission rates being applied
2529 # retroactively to a one-time charge. For accounting purposes
2530 # there ought to be some kind of time limit on doing this.
2531 my $amount = $part_event->_calc_credit($self);
2532 if ( $credit and $credit->amount ne $amount ) {
2533 # Void the old credit.
2534 $error = $credit->void('Package class changed');
2536 $dbh->rollback if $oldAutoCommit;
2537 return "$error (adjusting commission credit)";
2540 # redo the event action to recreate the credit.
2542 eval { $part_event->do_action( $self, $cust_event ) };
2544 $dbh->rollback if $oldAutoCommit;
2547 } # if $part_event->isa($class)
2549 } # foreach $cust_event
2550 } # if $opt{'adjust_commission'}
2551 } # if defined $old_classnum
2553 $dbh->commit if $oldAutoCommit;
2560 sub process_bulk_cust_pkg {
2563 warn Dumper($param) if $DEBUG;
2565 my $old_part_pkg = qsearchs('part_pkg',
2566 { pkgpart => $param->{'old_pkgpart'} });
2567 my $new_part_pkg = qsearchs('part_pkg',
2568 { pkgpart => $param->{'new_pkgpart'} });
2569 die "Must select a new package type\n" unless $new_part_pkg;
2570 #my $keep_dates = $param->{'keep_dates'} || 0;
2571 my $keep_dates = 1; # there is no good reason to turn this off
2573 my $oldAutoCommit = $FS::UID::AutoCommit;
2574 local $FS::UID::AutoCommit = 0;
2577 my @cust_pkgs = qsearch('cust_pkg', { 'pkgpart' => $param->{'old_pkgpart'} } );
2580 foreach my $old_cust_pkg ( @cust_pkgs ) {
2582 $job->update_statustext(int(100*$i/(scalar @cust_pkgs)));
2583 if ( $old_cust_pkg->getfield('cancel') ) {
2584 warn '[process_bulk_cust_pkg ] skipping canceled pkgnum '.
2585 $old_cust_pkg->pkgnum."\n"
2589 warn '[process_bulk_cust_pkg] changing pkgnum '.$old_cust_pkg->pkgnum."\n"
2591 my $error = $old_cust_pkg->change(
2592 'pkgpart' => $param->{'new_pkgpart'},
2593 'keep_dates' => $keep_dates
2595 if ( !ref($error) ) { # change returns the cust_pkg on success
2597 die "Error changing pkgnum ".$old_cust_pkg->pkgnum.": '$error'\n";
2600 $dbh->commit if $oldAutoCommit;
2606 Returns the last bill date, or if there is no last bill date, the setup date.
2607 Useful for billing metered services.
2613 return $self->setfield('last_bill', $_[0]) if @_;
2614 return $self->getfield('last_bill') if $self->getfield('last_bill');
2615 my $cust_bill_pkg = qsearchs('cust_bill_pkg', { 'pkgnum' => $self->pkgnum,
2616 'edate' => $self->bill, } );
2617 $cust_bill_pkg ? $cust_bill_pkg->sdate : $self->setup || 0;
2620 =item last_cust_pkg_reason ACTION
2622 Returns the most recent ACTION FS::cust_pkg_reason associated with the package.
2623 Returns false if there is no reason or the package is not currenly ACTION'd
2624 ACTION is one of adjourn, susp, cancel, or expire.
2628 sub last_cust_pkg_reason {
2629 my ( $self, $action ) = ( shift, shift );
2630 my $date = $self->get($action);
2632 'table' => 'cust_pkg_reason',
2633 'hashref' => { 'pkgnum' => $self->pkgnum,
2634 'action' => substr(uc($action), 0, 1),
2637 'order_by' => 'ORDER BY num DESC LIMIT 1',
2641 =item last_reason ACTION
2643 Returns the most recent ACTION FS::reason associated with the package.
2644 Returns false if there is no reason or the package is not currenly ACTION'd
2645 ACTION is one of adjourn, susp, cancel, or expire.
2650 my $cust_pkg_reason = shift->last_cust_pkg_reason(@_);
2651 $cust_pkg_reason->reason
2652 if $cust_pkg_reason;
2657 Returns the definition for this billing item, as an FS::part_pkg object (see
2664 return $self->{'_pkgpart'} if $self->{'_pkgpart'};
2665 cluck "cust_pkg->part_pkg called" if $DEBUG > 1;
2666 qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
2671 Returns the cancelled package this package was changed from, if any.
2677 return '' unless $self->change_pkgnum;
2678 qsearchs('cust_pkg', { 'pkgnum' => $self->change_pkgnum } );
2681 =item change_cust_main
2683 Returns the customter this package was detached to, if any.
2687 sub change_cust_main {
2689 return '' unless $self->change_custnum;
2690 qsearchs('cust_main', { 'custnum' => $self->change_custnum } );
2695 Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
2702 $self->part_pkg->calc_setup($self, @_);
2707 Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
2714 $self->part_pkg->calc_recur($self, @_);
2719 Calls the I<base_setup> of the FS::part_pkg object associated with this billing
2726 $self->part_pkg->base_setup($self, @_);
2731 Calls the I<base_recur> of the FS::part_pkg object associated with this billing
2738 $self->part_pkg->base_recur($self, @_);
2743 Calls the I<calc_remain> of the FS::part_pkg object associated with this
2750 $self->part_pkg->calc_remain($self, @_);
2755 Calls the I<calc_cancel> of the FS::part_pkg object associated with this
2762 $self->part_pkg->calc_cancel($self, @_);
2767 Returns any invoice line items for this package (see L<FS::cust_bill_pkg>).
2773 qsearch( 'cust_bill_pkg', { 'pkgnum' => $self->pkgnum } );
2776 =item cust_pkg_detail [ DETAILTYPE ]
2778 Returns any customer package details for this package (see
2779 L<FS::cust_pkg_detail>).
2781 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2785 sub cust_pkg_detail {
2787 my %hash = ( 'pkgnum' => $self->pkgnum );
2788 $hash{detailtype} = shift if @_;
2790 'table' => 'cust_pkg_detail',
2791 'hashref' => \%hash,
2792 'order_by' => 'ORDER BY weight, pkgdetailnum',
2796 =item set_cust_pkg_detail DETAILTYPE [ DETAIL, DETAIL, ... ]
2798 Sets customer package details for this package (see L<FS::cust_pkg_detail>).
2800 DETAILTYPE can be set to "I" for invoice details or "C" for comments.
2802 If there is an error, returns the error, otherwise returns false.
2806 sub set_cust_pkg_detail {
2807 my( $self, $detailtype, @details ) = @_;
2809 my $oldAutoCommit = $FS::UID::AutoCommit;
2810 local $FS::UID::AutoCommit = 0;
2813 foreach my $current ( $self->cust_pkg_detail($detailtype) ) {
2814 my $error = $current->delete;
2816 $dbh->rollback if $oldAutoCommit;
2817 return "error removing old detail: $error";
2821 foreach my $detail ( @details ) {
2822 my $cust_pkg_detail = new FS::cust_pkg_detail {
2823 'pkgnum' => $self->pkgnum,
2824 'detailtype' => $detailtype,
2825 'detail' => $detail,
2827 my $error = $cust_pkg_detail->insert;
2829 $dbh->rollback if $oldAutoCommit;
2830 return "error adding new detail: $error";
2835 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2842 Returns the customer billing events (see L<FS::cust_event>) for this invoice.
2846 #false laziness w/cust_bill.pm
2850 'table' => 'cust_event',
2851 'addl_from' => 'JOIN part_event USING ( eventpart )',
2852 'hashref' => { 'tablenum' => $self->pkgnum },
2853 'extra_sql' => " AND eventtable = 'cust_pkg' ",
2857 =item num_cust_event
2859 Returns the number of customer billing events (see L<FS::cust_event>) for this package.
2863 #false laziness w/cust_bill.pm
2864 sub num_cust_event {
2866 my $sql = "SELECT COUNT(*) ". $self->_from_cust_event_where;
2867 $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref->[0];
2870 =item exists_cust_event
2872 Returns true if there are customer billing events (see L<FS::cust_event>) for this package. More efficient than using num_cust_event.
2876 sub exists_cust_event {
2878 my $sql = "SELECT 1 ". $self->_from_cust_event_where. " LIMIT 1";
2879 my $row = $self->_prep_ex($sql, $self->pkgnum)->fetchrow_arrayref;
2880 $row ? $row->[0] : '';
2883 sub _from_cust_event_where {
2885 " FROM cust_event JOIN part_event USING ( eventpart ) ".
2886 " WHERE tablenum = ? AND eventtable = 'cust_pkg' ";
2890 my( $self, $sql, @args ) = @_;
2891 my $sth = dbh->prepare($sql) or die dbh->errstr. " preparing $sql";
2892 $sth->execute(@args) or die $sth->errstr. " executing $sql";
2896 =item part_pkg_currency_option OPTIONNAME
2898 Returns a two item list consisting of the currency of this customer, if any,
2899 and a value for the provided option. If the customer has a currency, the value
2900 is the option value the given name and the currency (see
2901 L<FS::part_pkg_currency>). Otherwise, if the customer has no currency, is the
2902 regular option value for the given name (see L<FS::part_pkg_option>).
2906 sub part_pkg_currency_option {
2907 my( $self, $optionname ) = @_;
2908 my $part_pkg = $self->part_pkg;
2909 if ( my $currency = $self->cust_main->currency ) {
2910 ($currency, $part_pkg->part_pkg_currency_option($currency, $optionname) );
2912 ('', $part_pkg->option($optionname) );
2916 =item cust_svc [ SVCPART ] (old, deprecated usage)
2918 =item cust_svc [ OPTION => VALUE ... ] (current usage)
2920 =item cust_svc_unsorted [ OPTION => VALUE ... ]
2922 Returns the services for this package, as FS::cust_svc objects (see
2923 L<FS::cust_svc>). Available options are svcpart and svcdb. If either is
2924 spcififed, returns only the matching services.
2926 As an optimization, use the cust_svc_unsorted version if you are not displaying
2933 cluck "cust_pkg->cust_svc called" if $DEBUG > 2;
2934 $self->_sort_cust_svc( $self->cust_svc_unsorted_arrayref(@_) );
2937 sub cust_svc_unsorted {
2939 @{ $self->cust_svc_unsorted_arrayref(@_) };
2942 sub cust_svc_unsorted_arrayref {
2945 return [] unless $self->num_cust_svc(@_);
2948 if ( @_ && $_[0] =~ /^\d+/ ) {
2949 $opt{svcpart} = shift;
2950 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
2957 'table' => 'cust_svc',
2958 'hashref' => { 'pkgnum' => $self->pkgnum },
2960 if ( $opt{svcpart} ) {
2961 $search{hashref}->{svcpart} = $opt{'svcpart'};
2963 if ( $opt{'svcdb'} ) {
2964 $search{addl_from} = ' LEFT JOIN part_svc USING ( svcpart ) ';
2965 $search{extra_sql} = ' AND svcdb = '. dbh->quote( $opt{'svcdb'} );
2968 [ qsearch(\%search) ];
2972 =item overlimit [ SVCPART ]
2974 Returns the services for this package which have exceeded their
2975 usage limit as FS::cust_svc objects (see L<FS::cust_svc>). If a svcpart
2976 is specified, return only the matching services.
2982 return () unless $self->num_cust_svc(@_);
2983 grep { $_->overlimit } $self->cust_svc(@_);
2986 =item h_cust_svc END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
2988 Returns historical services for this package created before END TIMESTAMP and
2989 (optionally) not cancelled before START_TIMESTAMP, as FS::h_cust_svc objects
2990 (see L<FS::h_cust_svc>). If MODE is 'I' (for 'invoice'), services with the
2991 I<pkg_svc.hidden> flag will be omitted.
2997 warn "$me _h_cust_svc called on $self\n"
3000 my ($end, $start, $mode) = @_;
3002 local($FS::Record::qsearch_qualify_columns) = 0;
3004 my @cust_svc = $self->_sort_cust_svc(
3005 [ qsearch( 'h_cust_svc',
3006 { 'pkgnum' => $self->pkgnum, },
3007 FS::h_cust_svc->sql_h_search(@_),
3011 if ( defined($mode) && $mode eq 'I' ) {
3012 my %hidden_svcpart = map { $_->svcpart => $_->hidden } $self->part_svc;
3013 return grep { !$hidden_svcpart{$_->svcpart} } @cust_svc;
3019 sub _sort_cust_svc {
3020 my( $self, $arrayref ) = @_;
3023 sub ($$) { my ($a, $b) = @_; $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] };
3025 my %pkg_svc = map { $_->svcpart => $_ }
3026 qsearch( 'pkg_svc', { 'pkgpart' => $self->pkgpart } );
3031 my $pkg_svc = $pkg_svc{ $_->svcpart } || '';
3033 $pkg_svc ? $pkg_svc->primary_svc : '',
3034 $pkg_svc ? $pkg_svc->quantity : 0,
3041 =item num_cust_svc [ SVCPART ] (old, deprecated usage)
3043 =item num_cust_svc [ OPTION => VALUE ... ] (current usage)
3045 Returns the number of services for this package. Available options are svcpart
3046 and svcdb. If either is spcififed, returns only the matching services.
3053 return $self->{'_num_cust_svc'}
3055 && exists($self->{'_num_cust_svc'})
3056 && $self->{'_num_cust_svc'} =~ /\d/;
3058 cluck "cust_pkg->num_cust_svc called, _num_cust_svc:".$self->{'_num_cust_svc'}
3062 if ( @_ && $_[0] =~ /^\d+/ ) {
3063 $opt{svcpart} = shift;
3064 } elsif ( @_ && ref($_[0]) eq 'HASH' ) {
3070 my $select = 'SELECT COUNT(*) FROM cust_svc ';
3071 my $where = ' WHERE pkgnum = ? ';
3072 my @param = ($self->pkgnum);
3074 if ( $opt{'svcpart'} ) {
3075 $where .= ' AND svcpart = ? ';
3076 push @param, $opt{'svcpart'};
3078 if ( $opt{'svcdb'} ) {
3079 $select .= ' LEFT JOIN part_svc USING ( svcpart ) ';
3080 $where .= ' AND svcdb = ? ';
3081 push @param, $opt{'svcdb'};
3084 my $sth = dbh->prepare("$select $where") or die dbh->errstr;
3085 $sth->execute(@param) or die $sth->errstr;
3086 $sth->fetchrow_arrayref->[0];
3089 =item available_part_svc
3091 Returns a list of FS::part_svc objects representing services included in this
3092 package but not yet provisioned. Each FS::part_svc object also has an extra
3093 field, I<num_avail>, which specifies the number of available services.
3097 sub available_part_svc {
3100 my $pkg_quantity = $self->quantity || 1;
3102 grep { $_->num_avail > 0 }
3104 my $part_svc = $_->part_svc;
3105 $part_svc->{'Hash'}{'num_avail'} = #evil encapsulation-breaking
3106 $pkg_quantity * $_->quantity - $self->num_cust_svc($_->svcpart);
3108 # more evil encapsulation breakage
3109 if($part_svc->{'Hash'}{'num_avail'} > 0) {
3110 my @exports = $part_svc->part_export_did;
3111 $part_svc->{'Hash'}{'can_get_dids'} = scalar(@exports);
3116 $self->part_pkg->pkg_svc;
3119 =item part_svc [ OPTION => VALUE ... ]
3121 Returns a list of FS::part_svc objects representing provisioned and available
3122 services included in this package. Each FS::part_svc object also has the
3123 following extra fields:
3137 (services) - array reference containing the provisioned services, as cust_svc objects
3141 Accepts two options:
3145 =item summarize_size
3147 If true, will omit the extra cust_pkg_svc option for objects where num_cust_svc
3148 is this size or greater.
3150 =item hide_discontinued
3152 If true, will omit looking for services that are no longer avaialble in the
3160 #label -> ($cust_svc->label)[1]
3166 my $pkg_quantity = $self->quantity || 1;
3168 #XXX some sort of sort order besides numeric by svcpart...
3169 my @part_svc = sort { $a->svcpart <=> $b->svcpart } map {
3171 my $part_svc = $pkg_svc->part_svc;
3172 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3173 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #more evil
3174 $part_svc->{'Hash'}{'num_avail'} =
3175 max( 0, $pkg_quantity * $pkg_svc->quantity - $num_cust_svc );
3176 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3177 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : []
3178 unless exists($opt{summarize_size}) && $opt{summarize_size} > 0
3179 && $num_cust_svc >= $opt{summarize_size};
3180 $part_svc->{'Hash'}{'hidden'} = $pkg_svc->hidden;
3182 } $self->part_pkg->pkg_svc;
3184 unless ( $opt{hide_discontinued} ) {
3186 push @part_svc, map {
3188 my $num_cust_svc = $self->num_cust_svc($part_svc->svcpart);
3189 $part_svc->{'Hash'}{'num_cust_svc'} = $num_cust_svc; #speak no evail
3190 $part_svc->{'Hash'}{'num_avail'} = 0; #0-$num_cust_svc ?
3191 $part_svc->{'Hash'}{'cust_pkg_svc'} =
3192 $num_cust_svc ? [ $self->cust_svc($part_svc->svcpart) ] : [];
3194 } $self->extra_part_svc;
3201 =item extra_part_svc
3203 Returns a list of FS::part_svc objects corresponding to services in this
3204 package which are still provisioned but not (any longer) available in the
3209 sub extra_part_svc {
3212 my $pkgnum = $self->pkgnum;
3213 #my $pkgpart = $self->pkgpart;
3216 # 'table' => 'part_svc',
3219 # "WHERE 0 = ( SELECT COUNT(*) FROM pkg_svc
3220 # WHERE pkg_svc.svcpart = part_svc.svcpart
3221 # AND pkg_svc.pkgpart = ?
3224 # AND 0 < ( SELECT COUNT(*) FROM cust_svc
3225 # LEFT JOIN cust_pkg USING ( pkgnum )
3226 # WHERE cust_svc.svcpart = part_svc.svcpart
3229 # 'extra_param' => [ [$self->pkgpart=>'int'], [$self->pkgnum=>'int'] ],
3232 #seems to benchmark slightly faster... (or did?)
3234 my @pkgparts = map $_->pkgpart, $self->part_pkg->self_and_svc_linked;
3235 my $pkgparts = join(',', @pkgparts);
3238 #'select' => 'DISTINCT ON (svcpart) part_svc.*',
3239 #MySQL doesn't grok DISINCT ON
3240 'select' => 'DISTINCT part_svc.*',
3241 'table' => 'part_svc',
3243 "LEFT JOIN pkg_svc ON ( pkg_svc.svcpart = part_svc.svcpart
3244 AND pkg_svc.pkgpart IN ($pkgparts)
3247 LEFT JOIN cust_svc ON ( cust_svc.svcpart = part_svc.svcpart )
3248 LEFT JOIN cust_pkg USING ( pkgnum )
3251 'extra_sql' => "WHERE pkgsvcnum IS NULL AND cust_pkg.pkgnum = ? ",
3252 'extra_param' => [ [$self->pkgnum=>'int'] ],
3258 Returns a short status string for this package, currently:
3264 =item not yet billed
3266 =item one-time charge
3281 my $freq = length($self->freq) ? $self->freq : $self->part_pkg->freq;
3283 return 'cancelled' if $self->get('cancel');
3284 return 'on hold' if $self->susp && ! $self->setup;
3285 return 'suspended' if $self->susp;
3286 return 'not yet billed' unless $self->setup;
3287 return 'one-time charge' if $freq =~ /^(0|$)/;
3291 =item ucfirst_status
3293 Returns the status with the first character capitalized.
3297 sub ucfirst_status {
3298 ucfirst(shift->status);
3303 Class method that returns the list of possible status strings for packages
3304 (see L<the status method|/status>). For example:
3306 @statuses = FS::cust_pkg->statuses();
3310 tie my %statuscolor, 'Tie::IxHash',
3311 'on hold' => '7E0079', #purple!
3312 'not yet billed' => '009999', #teal? cyan?
3313 'one-time charge' => '0000CC', #blue #'000000',
3314 'active' => '00CC00',
3315 'suspended' => 'FF9900',
3316 'cancelled' => 'FF0000',
3320 my $self = shift; #could be class...
3321 #grep { $_ !~ /^(not yet billed)$/ } #this is a dumb status anyway
3322 # # mayble split btw one-time vs. recur
3333 Returns a hex triplet color string for this package's status.
3339 $statuscolor{$self->status};
3344 Returns a label for this package. (Currently "pkgnum: pkg - comment" or
3345 "pkg - comment" depending on user preference).
3351 my $label = $self->part_pkg->pkg_comment( cust_pkg=>$self, nopkgpart=>1 );
3352 $label = $self->pkgnum. ": $label"
3353 if $FS::CurrentUser::CurrentUser->option('show_pkgnum');
3357 =item pkg_label_long
3359 Returns a long label for this package, adding the primary service's label to
3364 sub pkg_label_long {
3366 my $label = $self->pkg_label;
3367 my $cust_svc = $self->primary_cust_svc;
3368 $label .= ' ('. ($cust_svc->label)[1]. ')' if $cust_svc;
3374 Returns a customer-localized label for this package.
3380 $self->part_pkg->pkg_locale( $self->cust_main->locale );
3383 =item primary_cust_svc
3385 Returns a primary service (as FS::cust_svc object) if one can be identified.
3389 #for labeling purposes - might not 100% match up with part_pkg->svcpart's idea
3391 sub primary_cust_svc {
3394 my @cust_svc = $self->cust_svc;
3396 return '' unless @cust_svc; #no serivces - irrelevant then
3398 return $cust_svc[0] if scalar(@cust_svc) == 1; #always return a single service
3400 # primary service as specified in the package definition
3401 # or exactly one service definition with quantity one
3402 my $svcpart = $self->part_pkg->svcpart;
3403 @cust_svc = grep { $_->svcpart == $svcpart } @cust_svc;
3404 return $cust_svc[0] if scalar(@cust_svc) == 1;
3406 #couldn't identify one thing..
3412 Returns a list of lists, calling the label method for all services
3413 (see L<FS::cust_svc>) of this billing item.
3419 map { [ $_->label ] } $self->cust_svc;
3422 =item h_labels END_TIMESTAMP [ START_TIMESTAMP ] [ MODE ]
3424 Like the labels method, but returns historical information on services that
3425 were active as of END_TIMESTAMP and (optionally) not cancelled before
3426 START_TIMESTAMP. If MODE is 'I' (for 'invoice'), services with the
3427 I<pkg_svc.hidden> flag will be omitted.
3429 Returns a list of lists, calling the label method for all (historical) services
3430 (see L<FS::h_cust_svc>) of this billing item.
3436 warn "$me _h_labels called on $self\n"
3438 map { [ $_->label(@_) ] } $self->h_cust_svc(@_);
3443 Like labels, except returns a simple flat list, and shortens long
3444 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3445 identical services to one line that lists the service label and the number of
3446 individual services rather than individual items.
3451 shift->_labels_short( 'labels', @_ );
3454 =item h_labels_short END_TIMESTAMP [ START_TIMESTAMP ]
3456 Like h_labels, except returns a simple flat list, and shortens long
3457 (currently >5 or the cust_bill-max_same_services configuration value) lists of
3458 identical services to one line that lists the service label and the number of
3459 individual services rather than individual items.
3463 sub h_labels_short {
3464 shift->_labels_short( 'h_labels', @_ );
3468 my( $self, $method ) = ( shift, shift );
3470 warn "$me _labels_short called on $self with $method method\n"
3473 my $conf = new FS::Conf;
3474 my $max_same_services = $conf->config('cust_bill-max_same_services') || 5;
3476 warn "$me _labels_short populating \%labels\n"
3480 #tie %labels, 'Tie::IxHash';
3481 push @{ $labels{$_->[0]} }, $_->[1]
3482 foreach $self->$method(@_);
3484 warn "$me _labels_short populating \@labels\n"
3488 foreach my $label ( keys %labels ) {
3490 my @values = grep { ! $seen{$_}++ } @{ $labels{$label} };
3491 my $num = scalar(@values);
3492 warn "$me _labels_short $num items for $label\n"
3495 if ( $num > $max_same_services ) {
3496 warn "$me _labels_short more than $max_same_services, so summarizing\n"
3498 push @labels, "$label ($num)";
3500 if ( $conf->exists('cust_bill-consolidate_services') ) {
3501 warn "$me _labels_short consolidating services\n"
3503 # push @labels, "$label: ". join(', ', @values);
3505 my $detail = "$label: ";
3506 $detail .= shift(@values). ', '
3508 && ( length($detail.$values[0]) < 78 || $detail eq "$label: " );
3510 push @labels, $detail;
3512 warn "$me _labels_short done consolidating services\n"
3515 warn "$me _labels_short adding service data\n"
3517 push @labels, map { "$label: $_" } @values;
3528 Returns the parent customer object (see L<FS::cust_main>).
3532 Returns the balance for this specific package, when using
3533 experimental package balance.
3539 $self->cust_main->balance_pkgnum( $self->pkgnum );
3542 #these subs are in location_Mixin.pm now... unfortunately the POD doesn't mixin
3546 Returns the location object, if any (see L<FS::cust_location>).
3548 =item cust_location_or_main
3550 If this package is associated with a location, returns the locaiton (see
3551 L<FS::cust_location>), otherwise returns the customer (see L<FS::cust_main>).
3553 =item location_label [ OPTION => VALUE ... ]
3555 Returns the label of the location object (see L<FS::cust_location>).
3559 #end of subs in location_Mixin.pm now... unfortunately the POD doesn't mixin
3561 =item tax_locationnum
3563 Returns the foreign key to a L<FS::cust_location> object for calculating
3564 tax on this package, as determined by the C<tax-pkg_address> and
3565 C<tax-ship_address> configuration flags.
3569 sub tax_locationnum {
3571 my $conf = FS::Conf->new;
3572 if ( $conf->exists('tax-pkg_address') ) {
3573 return $self->locationnum;
3575 elsif ( $conf->exists('tax-ship_address') ) {
3576 return $self->cust_main->ship_locationnum;
3579 return $self->cust_main->bill_locationnum;
3585 Returns the L<FS::cust_location> object for tax_locationnum.
3591 my $conf = FS::Conf->new;
3592 if ( $conf->exists('tax-pkg_address') and $self->locationnum ) {
3593 return FS::cust_location->by_key($self->locationnum);
3595 elsif ( $conf->exists('tax-ship_address') ) {
3596 return $self->cust_main->ship_location;
3599 return $self->cust_main->bill_location;
3603 =item seconds_since TIMESTAMP
3605 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
3606 package have been online since TIMESTAMP, according to the session monitor.
3608 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
3609 L<Time::Local> and L<Date::Parse> for conversion functions.
3614 my($self, $since) = @_;
3617 foreach my $cust_svc (
3618 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
3620 $seconds += $cust_svc->seconds_since($since);
3627 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
3629 Returns the numbers of seconds all accounts (see L<FS::svc_acct>) in this
3630 package have been online between TIMESTAMP_START (inclusive) and TIMESTAMP_END
3633 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3634 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3640 sub seconds_since_sqlradacct {
3641 my($self, $start, $end) = @_;
3645 foreach my $cust_svc (
3647 my $part_svc = $_->part_svc;
3648 $part_svc->svcdb eq 'svc_acct'
3649 && scalar($part_svc->part_export_usage);
3652 $seconds += $cust_svc->seconds_since_sqlradacct($start, $end);
3659 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
3661 Returns the sum of the given attribute for all accounts (see L<FS::svc_acct>)
3662 in this package for sessions ending between TIMESTAMP_START (inclusive) and
3666 TIMESTAMP_START and TIMESTAMP_END are specified as UNIX timestamps; see
3667 L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for conversion
3672 sub attribute_since_sqlradacct {
3673 my($self, $start, $end, $attrib) = @_;
3677 foreach my $cust_svc (
3679 my $part_svc = $_->part_svc;
3680 scalar($part_svc->part_export_usage);
3683 $sum += $cust_svc->attribute_since_sqlradacct($start, $end, $attrib);
3695 my( $self, $value ) = @_;
3696 if ( defined($value) ) {
3697 $self->setfield('quantity', $value);
3699 $self->getfield('quantity') || 1;
3702 =item transfer DEST_PKGNUM | DEST_CUST_PKG, [ OPTION => VALUE ... ]
3704 Transfers as many services as possible from this package to another package.
3706 The destination package can be specified by pkgnum by passing an FS::cust_pkg
3707 object. The destination package must already exist.
3709 Services are moved only if the destination allows services with the correct
3710 I<svcpart> (not svcdb), unless the B<change_svcpart> option is set true. Use
3711 this option with caution! No provision is made for export differences
3712 between the old and new service definitions. Probably only should be used
3713 when your exports for all service definitions of a given svcdb are identical.
3714 (attempt a transfer without it first, to move all possible svcpart-matching
3717 Any services that can't be moved remain in the original package.
3719 Returns an error, if there is one; otherwise, returns the number of services
3720 that couldn't be moved.
3725 my ($self, $dest_pkgnum, %opt) = @_;
3731 if (ref ($dest_pkgnum) eq 'FS::cust_pkg') {
3732 $dest = $dest_pkgnum;
3733 $dest_pkgnum = $dest->pkgnum;
3735 $dest = qsearchs('cust_pkg', { pkgnum => $dest_pkgnum });
3738 return ('Package does not exist: '.$dest_pkgnum) unless $dest;
3740 foreach my $pkg_svc ( $dest->part_pkg->pkg_svc ) {
3741 $target{$pkg_svc->svcpart} = $pkg_svc->quantity * ( $dest->quantity || 1 );
3744 foreach my $cust_svc ($dest->cust_svc) {
3745 $target{$cust_svc->svcpart}--;
3748 my %svcpart2svcparts = ();
3749 if ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3750 warn "change_svcpart option received, creating alternates list\n" if $DEBUG;
3751 foreach my $svcpart ( map { $_->svcpart } $self->cust_svc ) {
3752 next if exists $svcpart2svcparts{$svcpart};
3753 my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
3754 $svcpart2svcparts{$svcpart} = [
3756 sort { $b->[1] cmp $a->[1] or $a->[2] <=> $b->[2] }
3758 my $pkg_svc = qsearchs( 'pkg_svc', { 'pkgpart' => $dest->pkgpart,
3759 'svcpart' => $_ } );
3761 $pkg_svc ? $pkg_svc->primary_svc : '',
3762 $pkg_svc ? $pkg_svc->quantity : 0,
3766 grep { $_ != $svcpart }
3768 qsearch('part_svc', { 'svcdb' => $part_svc->svcdb } )
3770 warn "alternates for svcpart $svcpart: ".
3771 join(', ', @{$svcpart2svcparts{$svcpart}}). "\n"
3777 foreach my $cust_svc ($self->cust_svc) {
3778 my $svcnum = $cust_svc->svcnum;
3779 if($target{$cust_svc->svcpart} > 0
3780 or $FS::cust_svc::ignore_quantity) { # maybe should be a 'force' option
3781 $target{$cust_svc->svcpart}--;
3782 my $new = new FS::cust_svc { $cust_svc->hash };
3783 $new->pkgnum($dest_pkgnum);
3784 $error = $new->replace($cust_svc);
3785 } elsif ( exists $opt{'change_svcpart'} && $opt{'change_svcpart'} ) {
3787 warn "looking for alternates for svcpart ". $cust_svc->svcpart. "\n";
3788 warn "alternates to consider: ".
3789 join(', ', @{$svcpart2svcparts{$cust_svc->svcpart}}). "\n";
3791 my @alternate = grep {
3792 warn "considering alternate svcpart $_: ".
3793 "$target{$_} available in new package\n"
3796 } @{$svcpart2svcparts{$cust_svc->svcpart}};
3798 warn "alternate(s) found\n" if $DEBUG;
3799 my $change_svcpart = $alternate[0];
3800 $target{$change_svcpart}--;
3801 my $new = new FS::cust_svc { $cust_svc->hash };
3802 $new->svcpart($change_svcpart);
3803 $new->pkgnum($dest_pkgnum);
3804 $error = $new->replace($cust_svc);
3812 my @label = $cust_svc->label;
3813 return "$label[0] $label[1]: $error";
3819 =item grab_svcnums SVCNUM, SVCNUM ...
3821 Change the pkgnum for the provided services to this packages. If there is an
3822 error, returns the error, otherwise returns false.
3830 my $oldAutoCommit = $FS::UID::AutoCommit;
3831 local $FS::UID::AutoCommit = 0;
3834 foreach my $svcnum (@svcnum) {
3835 my $cust_svc = qsearchs('cust_svc', { svcnum=>$svcnum } ) or do {
3836 $dbh->rollback if $oldAutoCommit;
3837 return "unknown svcnum $svcnum";
3839 $cust_svc->pkgnum( $self->pkgnum );
3840 my $error = $cust_svc->replace;
3842 $dbh->rollback if $oldAutoCommit;
3847 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3854 This method is deprecated. See the I<depend_jobnum> option to the insert and
3855 order_pkgs methods in FS::cust_main for a better way to defer provisioning.
3859 #looks like this is still used by the order_pkg and change_pkg methods in
3860 # ClientAPI/MyAccount, need to look into those before removing
3864 my $oldAutoCommit = $FS::UID::AutoCommit;
3865 local $FS::UID::AutoCommit = 0;
3868 foreach my $cust_svc ( $self->cust_svc ) {
3869 #false laziness w/svc_Common::insert
3870 my $svc_x = $cust_svc->svc_x;
3871 foreach my $part_export ( $cust_svc->part_svc->part_export ) {
3872 my $error = $part_export->export_insert($svc_x);
3874 $dbh->rollback if $oldAutoCommit;
3880 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3885 =item export_pkg_change OLD_CUST_PKG
3887 Calls the "pkg_change" export action for all services attached to this package.
3891 sub export_pkg_change {
3892 my( $self, $old ) = ( shift, shift );
3894 my $oldAutoCommit = $FS::UID::AutoCommit;
3895 local $FS::UID::AutoCommit = 0;
3898 foreach my $svc_x ( map $_->svc_x, $self->cust_svc ) {
3899 my $error = $svc_x->export('pkg_change', $self, $old);
3901 $dbh->rollback if $oldAutoCommit;
3906 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3913 Associates this package with a (suspension or cancellation) reason (see
3914 L<FS::cust_pkg_reason>, possibly inserting a new reason on the fly (see
3917 Available options are:
3923 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.
3927 the access_user (see L<FS::access_user>) providing the reason
3935 the action (cancel, susp, adjourn, expire) associated with the reason
3939 If there is an error, returns the error, otherwise returns false.
3944 my ($self, %options) = @_;
3946 my $otaker = $options{reason_otaker} ||
3947 $FS::CurrentUser::CurrentUser->username;
3950 if ( $options{'reason'} =~ /^(\d+)$/ ) {
3954 } elsif ( ref($options{'reason'}) ) {
3956 return 'Enter a new reason (or select an existing one)'
3957 unless $options{'reason'}->{'reason'} !~ /^\s*$/;
3959 my $reason = new FS::reason({
3960 'reason_type' => $options{'reason'}->{'typenum'},
3961 'reason' => $options{'reason'}->{'reason'},
3963 my $error = $reason->insert;
3964 return $error if $error;
3966 $reasonnum = $reason->reasonnum;
3969 return "Unparseable reason: ". $options{'reason'};
3972 my $cust_pkg_reason =
3973 new FS::cust_pkg_reason({ 'pkgnum' => $self->pkgnum,
3974 'reasonnum' => $reasonnum,
3975 'otaker' => $otaker,
3976 'action' => substr(uc($options{'action'}),0,1),
3977 'date' => $options{'date'}
3982 $cust_pkg_reason->insert;
3985 =item insert_discount
3987 Associates this package with a discount (see L<FS::cust_pkg_discount>, possibly
3988 inserting a new discount on the fly (see L<FS::discount>).
3990 Available options are:
3998 If there is an error, returns the error, otherwise returns false.
4002 sub insert_discount {
4003 #my ($self, %options) = @_;
4006 my $cust_pkg_discount = new FS::cust_pkg_discount {
4007 'pkgnum' => $self->pkgnum,
4008 'discountnum' => $self->discountnum,
4010 'end_date' => '', #XXX
4011 #for the create a new discount case
4012 '_type' => $self->discountnum__type,
4013 'amount' => $self->discountnum_amount,
4014 'percent' => $self->discountnum_percent,
4015 'months' => $self->discountnum_months,
4016 'setup' => $self->discountnum_setup,
4017 #'disabled' => $self->discountnum_disabled,
4020 $cust_pkg_discount->insert;
4023 =item set_usage USAGE_VALUE_HASHREF
4025 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4026 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4027 upbytes, downbytes, and totalbytes are appropriate keys.
4029 All svc_accts which are part of this package have their values reset.
4034 my ($self, $valueref, %opt) = @_;
4036 #only svc_acct can set_usage for now
4037 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4038 my $svc_x = $cust_svc->svc_x;
4039 $svc_x->set_usage($valueref, %opt)
4040 if $svc_x->can("set_usage");
4044 =item recharge USAGE_VALUE_HASHREF
4046 USAGE_VALUE_HASHREF is a hashref of svc_acct usage columns and the amounts
4047 to which they should be set (see L<FS::svc_acct>). Currently seconds,
4048 upbytes, downbytes, and totalbytes are appropriate keys.
4050 All svc_accts which are part of this package have their values incremented.
4055 my ($self, $valueref) = @_;
4057 #only svc_acct can set_usage for now
4058 foreach my $cust_svc ( $self->cust_svc( 'svcdb'=>'svc_acct' ) ) {
4059 my $svc_x = $cust_svc->svc_x;
4060 $svc_x->recharge($valueref)
4061 if $svc_x->can("recharge");
4065 =item apply_usageprice
4069 sub apply_usageprice {
4072 my $oldAutoCommit = $FS::UID::AutoCommit;
4073 local $FS::UID::AutoCommit = 0;
4078 foreach my $cust_pkg_usageprice ( $self->cust_pkg_usageprice ) {
4079 $error ||= $cust_pkg_usageprice->apply;
4083 $dbh->rollback if $oldAutoCommit;
4084 die "error applying part_pkg_usageprice add-ons, pkgnum ". $self->pkgnum.
4087 $dbh->commit if $oldAutoCommit;
4093 =item cust_pkg_discount
4095 =item cust_pkg_discount_active
4099 sub cust_pkg_discount_active {
4101 grep { $_->status eq 'active' } $self->cust_pkg_discount;
4104 =item cust_pkg_usage
4106 Returns a list of all voice usage counters attached to this package.
4108 =item apply_usage OPTIONS
4110 Takes the following options:
4111 - cdr: a call detail record (L<FS::cdr>)
4112 - rate_detail: the rate determined for this call (L<FS::rate_detail>)
4113 - minutes: the maximum number of minutes to be charged
4115 Finds available usage minutes for a call of this class, and subtracts
4116 up to that many minutes from the usage pool. If the usage pool is empty,
4117 and the C<cdr-minutes_priority> global config option is set, minutes may
4118 be taken from other calls as well. Either way, an allocation record will
4119 be created (L<FS::cdr_cust_pkg_usage>) and this method will return the
4120 number of minutes of usage applied to the call.
4125 my ($self, %opt) = @_;
4126 my $cdr = $opt{cdr};
4127 my $rate_detail = $opt{rate_detail};
4128 my $minutes = $opt{minutes};
4129 my $classnum = $rate_detail->classnum;
4130 my $pkgnum = $self->pkgnum;
4131 my $custnum = $self->custnum;
4133 my $oldAutoCommit = $FS::UID::AutoCommit;
4134 local $FS::UID::AutoCommit = 0;
4137 my $order = FS::Conf->new->config('cdr-minutes_priority');
4141 $is_classnum = ' part_pkg_usage_class.classnum = '.$classnum;
4143 $is_classnum = ' part_pkg_usage_class.classnum IS NULL';
4145 my @usage_recs = qsearch({
4146 'table' => 'cust_pkg_usage',
4147 'addl_from' => ' JOIN part_pkg_usage USING (pkgusagepart)'.
4148 ' JOIN cust_pkg USING (pkgnum)'.
4149 ' JOIN part_pkg_usage_class USING (pkgusagepart)',
4150 'select' => 'cust_pkg_usage.*',
4151 'extra_sql' => " WHERE ( cust_pkg.pkgnum = $pkgnum OR ".
4152 " ( cust_pkg.custnum = $custnum AND ".
4153 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4154 $is_classnum . ' AND '.
4155 " cust_pkg_usage.minutes > 0",
4156 'order_by' => " ORDER BY priority ASC",
4159 my $orig_minutes = $minutes;
4161 while (!$error and $minutes > 0 and @usage_recs) {
4162 my $cust_pkg_usage = shift @usage_recs;
4163 $cust_pkg_usage->select_for_update;
4164 my $cdr_cust_pkg_usage = FS::cdr_cust_pkg_usage->new({
4165 pkgusagenum => $cust_pkg_usage->pkgusagenum,
4166 acctid => $cdr->acctid,
4167 minutes => min($cust_pkg_usage->minutes, $minutes),
4169 $cust_pkg_usage->set('minutes',
4170 $cust_pkg_usage->minutes - $cdr_cust_pkg_usage->minutes
4172 $error = $cust_pkg_usage->replace || $cdr_cust_pkg_usage->insert;
4173 $minutes -= $cdr_cust_pkg_usage->minutes;
4175 if ( $order and $minutes > 0 and !$error ) {
4176 # then try to steal minutes from another call
4178 'table' => 'cdr_cust_pkg_usage',
4179 'addl_from' => ' JOIN cust_pkg_usage USING (pkgusagenum)'.
4180 ' JOIN part_pkg_usage USING (pkgusagepart)'.
4181 ' JOIN cust_pkg USING (pkgnum)'.
4182 ' JOIN part_pkg_usage_class USING (pkgusagepart)'.
4183 ' JOIN cdr USING (acctid)',
4184 'select' => 'cdr_cust_pkg_usage.*',
4185 'extra_sql' => " WHERE cdr.freesidestatus = 'rated' AND ".
4186 " ( cust_pkg.pkgnum = $pkgnum OR ".
4187 " ( cust_pkg.custnum = $custnum AND ".
4188 " part_pkg_usage.shared IS NOT NULL ) ) AND ".
4189 " part_pkg_usage_class.classnum = $classnum",
4190 'order_by' => ' ORDER BY part_pkg_usage.priority ASC',
4192 if ( $order eq 'time' ) {
4193 # find CDRs that are using minutes, but have a later startdate
4195 my $startdate = $cdr->startdate;
4196 if ($startdate !~ /^\d+$/) {
4197 die "bad cdr startdate '$startdate'";
4199 $search{'extra_sql'} .= " AND cdr.startdate > $startdate";
4200 # minimize needless reshuffling
4201 $search{'order_by'} .= ', cdr.startdate DESC';
4203 # XXX may not work correctly with rate_time schedules. Could
4204 # fix this by storing ratedetailnum in cdr_cust_pkg_usage, I
4206 $search{'addl_from'} .=
4207 ' JOIN rate_detail'.
4208 ' ON (cdr.rated_ratedetailnum = rate_detail.ratedetailnum)';
4209 if ( $order eq 'rate_high' ) {
4210 $search{'extra_sql'} .= ' AND rate_detail.min_charge < '.
4211 $rate_detail->min_charge;
4212 $search{'order_by'} .= ', rate_detail.min_charge ASC';
4213 } elsif ( $order eq 'rate_low' ) {
4214 $search{'extra_sql'} .= ' AND rate_detail.min_charge > '.
4215 $rate_detail->min_charge;
4216 $search{'order_by'} .= ', rate_detail.min_charge DESC';
4218 # this should really never happen
4219 die "invalid cdr-minutes_priority value '$order'\n";
4222 my @cdr_usage_recs = qsearch(\%search);
4224 while (!$error and @cdr_usage_recs and $minutes > 0) {
4225 my $cdr_cust_pkg_usage = shift @cdr_usage_recs;
4226 my $cust_pkg_usage = $cdr_cust_pkg_usage->cust_pkg_usage;
4227 my $old_cdr = $cdr_cust_pkg_usage->cdr;
4228 $reproc_cdrs{$old_cdr->acctid} = $old_cdr;
4229 $cdr_cust_pkg_usage->select_for_update;
4230 $old_cdr->select_for_update;
4231 $cust_pkg_usage->select_for_update;
4232 # in case someone else stole the usage from this CDR
4233 # while waiting for the lock...
4234 next if $old_cdr->acctid != $cdr_cust_pkg_usage->acctid;
4235 # steal the usage allocation and flag the old CDR for reprocessing
4236 $cdr_cust_pkg_usage->set('acctid', $cdr->acctid);
4237 # if the allocation is more minutes than we need, adjust it...
4238 my $delta = $cdr_cust_pkg_usage->minutes - $minutes;
4240 $cdr_cust_pkg_usage->set('minutes', $minutes);
4241 $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $delta);
4242 $error = $cust_pkg_usage->replace;
4244 #warn 'CDR '.$cdr->acctid . ' stealing allocation '.$cdr_cust_pkg_usage->cdrusagenum.' from CDR '.$old_cdr->acctid."\n";
4245 $error ||= $cdr_cust_pkg_usage->replace;
4246 # deduct the stolen minutes
4247 $minutes -= $cdr_cust_pkg_usage->minutes;
4249 # after all minute-stealing is done, reset the affected CDRs
4250 foreach (values %reproc_cdrs) {
4251 $error ||= $_->set_status('');
4252 # XXX or should we just call $cdr->rate right here?
4253 # it's not like we can create a loop this way, since the min_charge
4254 # or call time has to go monotonically in one direction.
4255 # we COULD get some very deep recursions going, though...
4257 } # if $order and $minutes
4260 die "error applying included minutes\npkgnum ".$self->pkgnum.", class $classnum, acctid ".$cdr->acctid."\n$error\n"
4262 $dbh->commit if $oldAutoCommit;
4263 return $orig_minutes - $minutes;
4267 =item supplemental_pkgs
4269 Returns a list of all packages supplemental to this one.
4273 sub supplemental_pkgs {
4275 qsearch('cust_pkg', { 'main_pkgnum' => $self->pkgnum });
4280 Returns the package that this one is supplemental to, if any.
4286 if ( $self->main_pkgnum ) {
4287 return FS::cust_pkg->by_key($self->main_pkgnum);
4294 =head1 CLASS METHODS
4300 Returns an SQL expression identifying recurring packages.
4304 sub recurring_sql { "
4305 '0' != ( select freq from part_pkg
4306 where cust_pkg.pkgpart = part_pkg.pkgpart )
4311 Returns an SQL expression identifying one-time packages.
4316 '0' = ( select freq from part_pkg
4317 where cust_pkg.pkgpart = part_pkg.pkgpart )
4322 Returns an SQL expression identifying ordered packages (recurring packages not
4328 $_[0]->recurring_sql. " AND ". $_[0]->not_yet_billed_sql;
4333 Returns an SQL expression identifying active packages.
4338 $_[0]->recurring_sql. "
4339 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4340 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4341 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4344 =item not_yet_billed_sql
4346 Returns an SQL expression identifying packages which have not yet been billed.
4350 sub not_yet_billed_sql { "
4351 ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4352 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4353 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4358 Returns an SQL expression identifying inactive packages (one-time packages
4359 that are otherwise unsuspended/uncancelled).
4363 sub inactive_sql { "
4364 ". $_[0]->onetime_sql(). "
4365 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4366 AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4367 AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
4372 Returns an SQL expression identifying on-hold packages.
4377 #$_[0]->recurring_sql(). ' AND '.
4379 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4380 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4381 AND ( cust_pkg.setup IS NULL OR cust_pkg.setup = 0 )
4388 Returns an SQL expression identifying suspended packages.
4392 sub suspended_sql { susp_sql(@_); }
4394 #$_[0]->recurring_sql(). ' AND '.
4396 ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4397 AND cust_pkg.susp IS NOT NULL AND cust_pkg.susp != 0
4398 AND cust_pkg.setup IS NOT NULL AND cust_pkg.setup != 0
4405 Returns an SQL exprression identifying cancelled packages.
4409 sub cancelled_sql { cancel_sql(@_); }
4411 #$_[0]->recurring_sql(). ' AND '.
4412 "cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0";
4417 Returns an SQL expression to give the package status as a string.
4423 WHEN cust_pkg.cancel IS NOT NULL THEN 'cancelled'
4424 WHEN ( cust_pkg.susp IS NOT NULL AND cust_pkg.setup IS NULL ) THEN 'on hold'
4425 WHEN cust_pkg.susp IS NOT NULL THEN 'suspended'
4426 WHEN cust_pkg.setup IS NULL THEN 'not yet billed'
4427 WHEN ".onetime_sql()." THEN 'one-time charge'
4434 Returns a list of two package counts. The first is a count of packages
4435 based on the supplied criteria and the second is the count of residential
4436 packages with those same criteria. Criteria are specified as in the search
4442 my ($class, $params) = @_;
4444 my $sql_query = $class->search( $params );
4446 my $count_sql = delete($sql_query->{'count_query'});
4447 $count_sql =~ s/ FROM/,count(CASE WHEN cust_main.company IS NULL OR cust_main.company = '' THEN 1 END) FROM/
4448 or die "couldn't parse count_sql";
4450 my $count_sth = dbh->prepare($count_sql)
4451 or die "Error preparing $count_sql: ". dbh->errstr;
4453 or die "Error executing $count_sql: ". $count_sth->errstr;
4454 my $count_arrayref = $count_sth->fetchrow_arrayref;
4456 return ( @$count_arrayref );
4460 =item tax_locationnum_sql
4462 Returns an SQL expression for the tax location for a package, based
4463 on the settings of 'tax-pkg_address' and 'tax-ship_address'.
4467 sub tax_locationnum_sql {
4468 my $conf = FS::Conf->new;
4469 if ( $conf->exists('tax-pkg_address') ) {
4470 'cust_pkg.locationnum';
4472 elsif ( $conf->exists('tax-ship_address') ) {
4473 'cust_main.ship_locationnum';
4476 'cust_main.bill_locationnum';
4482 Returns a list: the first item is an SQL fragment identifying matching
4483 packages/customers via location (taking into account shipping and package
4484 address taxation, if enabled), and subsequent items are the parameters to
4485 substitute for the placeholders in that fragment.
4490 my($class, %opt) = @_;
4491 my $ornull = $opt{'ornull'};
4493 my $conf = new FS::Conf;
4495 # '?' placeholders in _location_sql_where
4496 my $x = $ornull ? 3 : 2;
4507 if ( $conf->exists('tax-ship_address') ) {
4510 ( ( ship_last IS NULL OR ship_last = '' )
4511 AND ". _location_sql_where('cust_main', '', $ornull ). "
4513 OR ( ship_last IS NOT NULL AND ship_last != ''
4514 AND ". _location_sql_where('cust_main', 'ship_', $ornull ). "
4517 # AND payby != 'COMP'
4519 @main_param = ( @bill_param, @bill_param );
4523 $main_where = _location_sql_where('cust_main'); # AND payby != 'COMP'
4524 @main_param = @bill_param;
4530 if ( $conf->exists('tax-pkg_address') ) {
4532 my $loc_where = _location_sql_where( 'cust_location', '', $ornull );
4535 ( cust_pkg.locationnum IS NULL AND $main_where )
4536 OR ( cust_pkg.locationnum IS NOT NULL AND $loc_where )
4539 @param = ( @main_param, @bill_param );
4543 $where = $main_where;
4544 @param = @main_param;
4552 #subroutine, helper for location_sql
4553 sub _location_sql_where {
4555 my $prefix = @_ ? shift : '';
4556 my $ornull = @_ ? shift : '';
4558 # $ornull = $ornull ? " OR ( ? IS NULL AND $table.${prefix}county IS NULL ) " : '';
4560 $ornull = $ornull ? ' OR ? IS NULL ' : '';
4562 my $or_empty_city = " OR ( ? = '' AND $table.${prefix}city IS NULL )";
4563 my $or_empty_county = " OR ( ? = '' AND $table.${prefix}county IS NULL )";
4564 my $or_empty_state = " OR ( ? = '' AND $table.${prefix}state IS NULL )";
4566 my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';
4568 # ( $table.${prefix}city = ? $or_empty_city $ornull )
4570 ( $table.district = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4571 AND ( $table.${prefix}city = ? OR ? = '' OR CAST(? AS $text) IS NULL )
4572 AND ( $table.${prefix}county = ? $or_empty_county $ornull )
4573 AND ( $table.${prefix}state = ? $or_empty_state $ornull )
4574 AND $table.${prefix}country = ?
4579 my( $self, $what ) = @_;
4581 my $what_show_zero = $what. '_show_zero';
4582 length($self->$what_show_zero())
4583 ? ($self->$what_show_zero() eq 'Y')
4584 : $self->part_pkg->$what_show_zero();
4591 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF [ REFNUM ] ] ]
4593 CUSTNUM is a customer (see L<FS::cust_main>)
4595 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4596 L<FS::part_pkg>) to order for this customer. Duplicates are of course
4599 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
4600 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
4601 new billing items. An error is returned if this is not possible (see
4602 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
4605 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4606 newly-created cust_pkg objects.
4608 REFNUM, if specified, will specify the FS::pkg_referral record to be created
4609 and inserted. Multiple FS::pkg_referral records can be created by
4610 setting I<refnum> to an array reference of refnums or a hash reference with
4611 refnums as keys. If no I<refnum> is defined, a default FS::pkg_referral
4612 record will be created corresponding to cust_main.refnum.
4617 my ($custnum, $pkgparts, $remove_pkgnum, $return_cust_pkg, $refnum) = @_;
4619 my $conf = new FS::Conf;
4621 # Transactionize this whole mess
4622 my $oldAutoCommit = $FS::UID::AutoCommit;
4623 local $FS::UID::AutoCommit = 0;
4627 # my $cust_main = qsearchs('cust_main', { custnum => $custnum });
4628 # return "Customer not found: $custnum" unless $cust_main;
4630 warn "$me order: pkgnums to remove: ". join(',', @$remove_pkgnum). "\n"
4633 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4636 my $change = scalar(@old_cust_pkg) != 0;
4639 if ( scalar(@old_cust_pkg) == 1 && scalar(@$pkgparts) == 1 ) {
4641 warn "$me order: changing pkgnum ". $old_cust_pkg[0]->pkgnum.
4642 " to pkgpart ". $pkgparts->[0]. "\n"
4645 my $err_or_cust_pkg =
4646 $old_cust_pkg[0]->change( 'pkgpart' => $pkgparts->[0],
4647 'refnum' => $refnum,
4650 unless (ref($err_or_cust_pkg)) {
4651 $dbh->rollback if $oldAutoCommit;
4652 return $err_or_cust_pkg;
4655 push @$return_cust_pkg, $err_or_cust_pkg;
4656 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4661 # Create the new packages.
4662 foreach my $pkgpart (@$pkgparts) {
4664 warn "$me order: inserting pkgpart $pkgpart\n" if $DEBUG;
4666 my $cust_pkg = new FS::cust_pkg { custnum => $custnum,
4667 pkgpart => $pkgpart,
4671 $error = $cust_pkg->insert( 'change' => $change );
4672 push @$return_cust_pkg, $cust_pkg;
4674 foreach my $link ($cust_pkg->part_pkg->supp_part_pkg_link) {
4675 my $supp_pkg = FS::cust_pkg->new({
4676 custnum => $custnum,
4677 pkgpart => $link->dst_pkgpart,
4679 main_pkgnum => $cust_pkg->pkgnum,
4682 $error ||= $supp_pkg->insert( 'change' => $change );
4683 push @$return_cust_pkg, $supp_pkg;
4687 $dbh->rollback if $oldAutoCommit;
4692 # $return_cust_pkg now contains refs to all of the newly
4695 # Transfer services and cancel old packages.
4696 foreach my $old_pkg (@old_cust_pkg) {
4698 warn "$me order: transferring services from pkgnum ". $old_pkg->pkgnum. "\n"
4701 foreach my $new_pkg (@$return_cust_pkg) {
4702 $error = $old_pkg->transfer($new_pkg);
4703 if ($error and $error == 0) {
4704 # $old_pkg->transfer failed.
4705 $dbh->rollback if $oldAutoCommit;
4710 if ( $error > 0 && $conf->exists('cust_pkg-change_svcpart') ) {
4711 warn "trying transfer again with change_svcpart option\n" if $DEBUG;
4712 foreach my $new_pkg (@$return_cust_pkg) {
4713 $error = $old_pkg->transfer($new_pkg, 'change_svcpart'=>1 );
4714 if ($error and $error == 0) {
4715 # $old_pkg->transfer failed.
4716 $dbh->rollback if $oldAutoCommit;
4723 # Transfers were successful, but we went through all of the
4724 # new packages and still had services left on the old package.
4725 # We can't cancel the package under the circumstances, so abort.
4726 $dbh->rollback if $oldAutoCommit;
4727 return "Unable to transfer all services from package ".$old_pkg->pkgnum;
4729 $error = $old_pkg->cancel( quiet=>1 );
4735 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4739 =item bulk_change PKGPARTS_ARYREF, REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ]
4741 A bulk change method to change packages for multiple customers.
4743 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
4744 L<FS::part_pkg>) to order for each customer. Duplicates are of course
4747 REMOVE_PKGNUMS is an list of pkgnums specifying the billing items to
4748 replace. The services (see L<FS::cust_svc>) are moved to the
4749 new billing items. An error is returned if this is not possible (see
4752 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
4753 newly-created cust_pkg objects.
4758 my ($pkgparts, $remove_pkgnum, $return_cust_pkg) = @_;
4760 # Transactionize this whole mess
4761 my $oldAutoCommit = $FS::UID::AutoCommit;
4762 local $FS::UID::AutoCommit = 0;
4766 my @old_cust_pkg = map { qsearchs('cust_pkg', { pkgnum => $_ }) }
4769 while(scalar(@old_cust_pkg)) {
4771 my $custnum = $old_cust_pkg[0]->custnum;
4772 my (@remove) = map { $_->pkgnum }
4773 grep { $_->custnum == $custnum } @old_cust_pkg;
4774 @old_cust_pkg = grep { $_->custnum != $custnum } @old_cust_pkg;
4776 my $error = order $custnum, $pkgparts, \@remove, \@return;
4778 push @errors, $error
4780 push @$return_cust_pkg, @return;
4783 if (scalar(@errors)) {
4784 $dbh->rollback if $oldAutoCommit;
4785 return join(' / ', @errors);
4788 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4792 # Used by FS::Upgrade to migrate to a new database.
4793 sub _upgrade_data { # class method
4794 my ($class, %opts) = @_;
4795 $class->_upgrade_otaker(%opts);
4797 # RT#10139, bug resulting in contract_end being set when it shouldn't
4798 'UPDATE cust_pkg SET contract_end = NULL WHERE contract_end = -1',
4799 # RT#10830, bad calculation of prorate date near end of year
4800 # the date range for bill is December 2009, and we move it forward
4801 # one year if it's before the previous bill date (which it should
4803 'UPDATE cust_pkg SET bill = bill + (365*24*60*60) WHERE bill < last_bill
4804 AND bill > 1259654400 AND bill < 1262332800 AND (SELECT plan FROM part_pkg
4805 WHERE part_pkg.pkgpart = cust_pkg.pkgpart) = \'prorate\'',
4806 # RT6628, add order_date to cust_pkg
4807 'update cust_pkg set order_date = (select history_date from h_cust_pkg
4808 where h_cust_pkg.pkgnum = cust_pkg.pkgnum and
4809 history_action = \'insert\') where order_date is null',
4811 foreach my $sql (@statements) {
4812 my $sth = dbh->prepare($sql);
4813 $sth->execute or die $sth->errstr;
4816 # RT31194: supplemental package links that are deleted don't clean up
4818 my @pkglinknums = qsearch({
4819 'select' => 'DISTINCT cust_pkg.pkglinknum',
4820 'table' => 'cust_pkg',
4821 'addl_from' => ' LEFT JOIN part_pkg_link USING (pkglinknum) ',
4822 'extra_sql' => ' WHERE cust_pkg.pkglinknum IS NOT NULL
4823 AND part_pkg_link.pkglinknum IS NULL',
4825 foreach (@pkglinknums) {
4826 my $pkglinknum = $_->pkglinknum;
4827 warn "cleaning part_pkg_link #$pkglinknum\n";
4828 my $part_pkg_link = FS::part_pkg_link->new({pkglinknum => $pkglinknum});
4829 my $error = $part_pkg_link->remove_linked;
4830 die $error if $error;
4838 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
4840 In sub order, the @pkgparts array (passed by reference) is clobbered.
4842 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
4843 method to pass dates to the recur_prog expression, it should do so.
4845 FS::svc_acct, FS::svc_domain, FS::svc_www, FS::svc_ip and FS::svc_forward are
4846 loaded via 'use' at compile time, rather than via 'require' in sub { setup,
4847 suspend, unsuspend, cancel } because they use %FS::UID::callback to load
4848 configuration values. Probably need a subroutine which decides what to do
4849 based on whether or not we've fetched the user yet, rather than a hash. See
4850 FS::UID and the TODO.
4852 Now that things are transactional should the check in the insert method be
4857 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
4858 L<FS::pkg_svc>, schema.html from the base documentation